1 //===- lli.cpp - LLVM Interpreter / Dynamic compiler ----------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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.
14 //===----------------------------------------------------------------------===//
16 #include "llvm/LLVMContext.h"
17 #include "llvm/Module.h"
18 #include "llvm/Type.h"
19 #include "llvm/ADT/Triple.h"
20 #include "llvm/Bitcode/ReaderWriter.h"
21 #include "llvm/CodeGen/LinkAllCodegenComponents.h"
22 #include "llvm/ExecutionEngine/GenericValue.h"
23 #include "llvm/ExecutionEngine/Interpreter.h"
24 #include "llvm/ExecutionEngine/JIT.h"
25 #include "llvm/ExecutionEngine/JITEventListener.h"
26 #include "llvm/ExecutionEngine/JITMemoryManager.h"
27 #include "llvm/ExecutionEngine/MCJIT.h"
28 #include "llvm/Support/CommandLine.h"
29 #include "llvm/Support/IRReader.h"
30 #include "llvm/Support/ManagedStatic.h"
31 #include "llvm/Support/MemoryBuffer.h"
32 #include "llvm/Support/PluginLoader.h"
33 #include "llvm/Support/PrettyStackTrace.h"
34 #include "llvm/Support/raw_ostream.h"
35 #include "llvm/Support/Process.h"
36 #include "llvm/Support/Signals.h"
37 #include "llvm/Support/TargetSelect.h"
41 #include <cygwin/version.h>
42 #if defined(CYGWIN_VERSION_DLL_MAJOR) && CYGWIN_VERSION_DLL_MAJOR<1007
43 #define DO_NOTHING_ATEXIT 1
51 InputFile(cl::desc("<input bitcode>"), cl::Positional, cl::init("-"));
54 InputArgv(cl::ConsumeAfter, cl::desc("<program arguments>..."));
56 cl::opt<bool> ForceInterpreter("force-interpreter",
57 cl::desc("Force interpretation: disable JIT"),
60 cl::opt<bool> UseMCJIT(
61 "use-mcjit", cl::desc("Enable use of the MC-based JIT (if available)"),
64 // Determine optimization level.
67 cl::desc("Optimization level. [-O0, -O1, -O2, or -O3] "
74 TargetTriple("mtriple", cl::desc("Override target triple for module"));
78 cl::desc("Architecture to generate assembly for (see --version)"));
82 cl::desc("Target a specific cpu type (-mcpu=help for details)"),
83 cl::value_desc("cpu-name"),
89 cl::desc("Target specific attributes (-mattr=help for details)"),
90 cl::value_desc("a1,+a2,-a3,..."));
93 EntryFunc("entry-function",
94 cl::desc("Specify the entry function (default = 'main') "
96 cl::value_desc("function"),
100 FakeArgv0("fake-argv0",
101 cl::desc("Override the 'argv[0]' value passed into the executing"
102 " program"), cl::value_desc("executable"));
105 DisableCoreFiles("disable-core-files", cl::Hidden,
106 cl::desc("Disable emission of core files if possible"));
109 NoLazyCompilation("disable-lazy-compilation",
110 cl::desc("Disable JIT lazy compilation"),
113 cl::opt<Reloc::Model>
114 RelocModel("relocation-model",
115 cl::desc("Choose relocation model"),
116 cl::init(Reloc::Default),
118 clEnumValN(Reloc::Default, "default",
119 "Target default relocation model"),
120 clEnumValN(Reloc::Static, "static",
121 "Non-relocatable code"),
122 clEnumValN(Reloc::PIC_, "pic",
123 "Fully relocatable, position independent code"),
124 clEnumValN(Reloc::DynamicNoPIC, "dynamic-no-pic",
125 "Relocatable external references, non-relocatable code"),
128 cl::opt<llvm::CodeModel::Model>
129 CMModel("code-model",
130 cl::desc("Choose code model"),
131 cl::init(CodeModel::JITDefault),
132 cl::values(clEnumValN(CodeModel::JITDefault, "default",
133 "Target default JIT code model"),
134 clEnumValN(CodeModel::Small, "small",
136 clEnumValN(CodeModel::Kernel, "kernel",
137 "Kernel code model"),
138 clEnumValN(CodeModel::Medium, "medium",
139 "Medium code model"),
140 clEnumValN(CodeModel::Large, "large",
145 EnableJITExceptionHandling("jit-enable-eh",
146 cl::desc("Emit exception handling information"),
150 // In debug builds, make this default to true.
152 #define EMIT_DEBUG false
154 #define EMIT_DEBUG true
156 EmitJitDebugInfo("jit-emit-debug",
157 cl::desc("Emit debug information to debugger"),
158 cl::init(EMIT_DEBUG));
162 EmitJitDebugInfoToDisk("jit-emit-debug-to-disk",
164 cl::desc("Emit debug info objfiles to disk"),
168 static ExecutionEngine *EE = 0;
170 static void do_shutdown() {
171 // Cygwin-1.5 invokes DLL's dtors before atexit handler.
172 #ifndef DO_NOTHING_ATEXIT
178 //===----------------------------------------------------------------------===//
179 // main Driver function
181 int main(int argc, char **argv, char * const *envp) {
182 sys::PrintStackTraceOnErrorSignal();
183 PrettyStackTraceProgram X(argc, argv);
185 LLVMContext &Context = getGlobalContext();
186 atexit(do_shutdown); // Call llvm_shutdown() on exit.
188 // If we have a native target, initialize it to ensure it is linked in and
189 // usable by the JIT.
190 InitializeNativeTarget();
191 InitializeNativeTargetAsmPrinter();
193 cl::ParseCommandLineOptions(argc, argv,
194 "llvm interpreter & dynamic compiler\n");
196 // If the user doesn't want core files, disable them.
197 if (DisableCoreFiles)
198 sys::Process::PreventCoreFiles();
200 // Load the bitcode...
202 Module *Mod = ParseIRFile(InputFile, Err, Context);
204 Err.print(argv[0], errs());
208 // If not jitting lazily, load the whole bitcode file eagerly too.
209 std::string ErrorMsg;
210 if (NoLazyCompilation) {
211 if (Mod->MaterializeAllPermanently(&ErrorMsg)) {
212 errs() << argv[0] << ": bitcode didn't read correctly.\n";
213 errs() << "Reason: " << ErrorMsg << "\n";
218 EngineBuilder builder(Mod);
219 builder.setMArch(MArch);
220 builder.setMCPU(MCPU);
221 builder.setMAttrs(MAttrs);
222 builder.setRelocationModel(RelocModel);
223 builder.setCodeModel(CMModel);
224 builder.setErrorStr(&ErrorMsg);
225 builder.setJITMemoryManager(ForceInterpreter ? 0 :
226 JITMemoryManager::CreateDefaultMemManager());
227 builder.setEngineKind(ForceInterpreter
228 ? EngineKind::Interpreter
231 // If we are supposed to override the target triple, do so now.
232 if (!TargetTriple.empty())
233 Mod->setTargetTriple(Triple::normalize(TargetTriple));
235 // Enable MCJIT if desired.
236 if (UseMCJIT && !ForceInterpreter) {
237 builder.setUseMCJIT(true);
240 CodeGenOpt::Level OLvl = CodeGenOpt::Default;
243 errs() << argv[0] << ": invalid optimization level.\n";
246 case '0': OLvl = CodeGenOpt::None; break;
247 case '1': OLvl = CodeGenOpt::Less; break;
248 case '2': OLvl = CodeGenOpt::Default; break;
249 case '3': OLvl = CodeGenOpt::Aggressive; break;
251 builder.setOptLevel(OLvl);
253 TargetOptions Options;
254 Options.JITExceptionHandling = EnableJITExceptionHandling;
255 Options.JITEmitDebugInfo = EmitJitDebugInfo;
256 Options.JITEmitDebugInfoToDisk = EmitJitDebugInfoToDisk;
257 builder.setTargetOptions(Options);
259 EE = builder.create();
261 if (!ErrorMsg.empty())
262 errs() << argv[0] << ": error creating EE: " << ErrorMsg << "\n";
264 errs() << argv[0] << ": unknown error creating EE!\n";
268 // The following functions have no effect if their respective profiling
269 // support wasn't enabled in the build configuration.
270 EE->RegisterJITEventListener(
271 JITEventListener::createOProfileJITEventListener());
272 EE->RegisterJITEventListener(
273 JITEventListener::createIntelJITEventListener());
275 EE->DisableLazyCompilation(NoLazyCompilation);
277 // If the user specifically requested an argv[0] to pass into the program,
279 if (!FakeArgv0.empty()) {
280 InputFile = FakeArgv0;
282 // Otherwise, if there is a .bc suffix on the executable strip it off, it
283 // might confuse the program.
284 if (StringRef(InputFile).endswith(".bc"))
285 InputFile.erase(InputFile.length() - 3);
288 // Add the module's name to the start of the vector of arguments to main().
289 InputArgv.insert(InputArgv.begin(), InputFile);
291 // Call the main function from M as if its signature were:
292 // int main (int argc, char **argv, const char **envp)
293 // using the contents of Args to determine argc & argv, and the contents of
294 // EnvVars to determine envp.
296 Function *EntryFn = Mod->getFunction(EntryFunc);
298 errs() << '\'' << EntryFunc << "\' function not found in module.\n";
302 // If the program doesn't explicitly call exit, we will need the Exit
303 // function later on to make an explicit call, so get the function now.
304 Constant *Exit = Mod->getOrInsertFunction("exit", Type::getVoidTy(Context),
305 Type::getInt32Ty(Context),
308 // Reset errno to zero on entry to main.
311 // Run static constructors.
312 EE->runStaticConstructorsDestructors(false);
314 if (NoLazyCompilation) {
315 for (Module::iterator I = Mod->begin(), E = Mod->end(); I != E; ++I) {
317 if (Fn != EntryFn && !Fn->isDeclaration())
318 EE->getPointerToFunction(Fn);
323 int Result = EE->runFunctionAsMain(EntryFn, InputArgv, envp);
325 // Run static destructors.
326 EE->runStaticConstructorsDestructors(true);
328 // If the program didn't call exit explicitly, we should call it now.
329 // This ensures that any atexit handlers get called correctly.
330 if (Function *ExitF = dyn_cast<Function>(Exit)) {
331 std::vector<GenericValue> Args;
332 GenericValue ResultGV;
333 ResultGV.IntVal = APInt(32, Result);
334 Args.push_back(ResultGV);
335 EE->runFunction(ExitF, Args);
336 errs() << "ERROR: exit(" << Result << ") returned!\n";
339 errs() << "ERROR: exit defined with wrong prototype!\n";