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/Bitcode/ReaderWriter.h"
20 #include "llvm/CodeGen/LinkAllCodegenComponents.h"
21 #include "llvm/ExecutionEngine/GenericValue.h"
22 #include "llvm/ExecutionEngine/Interpreter.h"
23 #include "llvm/ExecutionEngine/JIT.h"
24 #include "llvm/ExecutionEngine/JITEventListener.h"
25 #include "llvm/Support/CommandLine.h"
26 #include "llvm/Support/ManagedStatic.h"
27 #include "llvm/Support/MemoryBuffer.h"
28 #include "llvm/Support/PluginLoader.h"
29 #include "llvm/Support/PrettyStackTrace.h"
30 #include "llvm/Support/raw_ostream.h"
31 #include "llvm/System/Process.h"
32 #include "llvm/System/Signals.h"
33 #include "llvm/Target/TargetSelect.h"
39 InputFile(cl::desc("<input bitcode>"), cl::Positional, cl::init("-"));
42 InputArgv(cl::ConsumeAfter, cl::desc("<program arguments>..."));
44 cl::opt<bool> ForceInterpreter("force-interpreter",
45 cl::desc("Force interpretation: disable JIT"),
48 // Determine optimization level.
51 cl::desc("Optimization level. [-O0, -O1, -O2, or -O3] "
58 TargetTriple("mtriple", cl::desc("Override target triple for module"));
61 EntryFunc("entry-function",
62 cl::desc("Specify the entry function (default = 'main') "
64 cl::value_desc("function"),
68 FakeArgv0("fake-argv0",
69 cl::desc("Override the 'argv[0]' value passed into the executing"
70 " program"), cl::value_desc("executable"));
73 DisableCoreFiles("disable-core-files", cl::Hidden,
74 cl::desc("Disable emission of core files if possible"));
77 NoLazyCompilation("disable-lazy-compilation",
78 cl::desc("Disable JIT lazy compilation"),
82 static ExecutionEngine *EE = 0;
84 static void do_shutdown() {
89 //===----------------------------------------------------------------------===//
90 // main Driver function
92 int main(int argc, char **argv, char * const *envp) {
93 sys::PrintStackTraceOnErrorSignal();
94 PrettyStackTraceProgram X(argc, argv);
96 LLVMContext &Context = getGlobalContext();
97 atexit(do_shutdown); // Call llvm_shutdown() on exit.
99 // If we have a native target, initialize it to ensure it is linked in and
100 // usable by the JIT.
101 InitializeNativeTarget();
103 cl::ParseCommandLineOptions(argc, argv,
104 "llvm interpreter & dynamic compiler\n");
106 // If the user doesn't want core files, disable them.
107 if (DisableCoreFiles)
108 sys::Process::PreventCoreFiles();
110 // Load the bitcode...
111 std::string ErrorMsg;
113 if (MemoryBuffer *Buffer = MemoryBuffer::getFileOrSTDIN(InputFile,&ErrorMsg)){
114 Mod = getLazyBitcodeModule(Buffer, Context, &ErrorMsg);
115 if (!Mod) delete Buffer;
119 errs() << argv[0] << ": error loading program '" << InputFile << "': "
124 // If not jitting lazily, load the whole bitcode file eagerly too.
125 if (NoLazyCompilation) {
126 if (Mod->MaterializeAllPermanently(&ErrorMsg)) {
127 errs() << argv[0] << ": bitcode didn't read correctly.\n";
128 errs() << "Reason: " << ErrorMsg << "\n";
133 EngineBuilder builder(Mod);
134 builder.setErrorStr(&ErrorMsg);
135 builder.setEngineKind(ForceInterpreter
136 ? EngineKind::Interpreter
139 // If we are supposed to override the target triple, do so now.
140 if (!TargetTriple.empty())
141 Mod->setTargetTriple(TargetTriple);
143 CodeGenOpt::Level OLvl = CodeGenOpt::Default;
146 errs() << argv[0] << ": invalid optimization level.\n";
149 case '0': OLvl = CodeGenOpt::None; break;
150 case '1': OLvl = CodeGenOpt::Less; break;
151 case '2': OLvl = CodeGenOpt::Default; break;
152 case '3': OLvl = CodeGenOpt::Aggressive; break;
154 builder.setOptLevel(OLvl);
156 EE = builder.create();
158 if (!ErrorMsg.empty())
159 errs() << argv[0] << ": error creating EE: " << ErrorMsg << "\n";
161 errs() << argv[0] << ": unknown error creating EE!\n";
165 EE->RegisterJITEventListener(createOProfileJITEventListener());
167 EE->DisableLazyCompilation(NoLazyCompilation);
169 // If the user specifically requested an argv[0] to pass into the program,
171 if (!FakeArgv0.empty()) {
172 InputFile = FakeArgv0;
174 // Otherwise, if there is a .bc suffix on the executable strip it off, it
175 // might confuse the program.
176 if (InputFile.rfind(".bc") == InputFile.length() - 3)
177 InputFile.erase(InputFile.length() - 3);
180 // Add the module's name to the start of the vector of arguments to main().
181 InputArgv.insert(InputArgv.begin(), InputFile);
183 // Call the main function from M as if its signature were:
184 // int main (int argc, char **argv, const char **envp)
185 // using the contents of Args to determine argc & argv, and the contents of
186 // EnvVars to determine envp.
188 Function *EntryFn = Mod->getFunction(EntryFunc);
190 errs() << '\'' << EntryFunc << "\' function not found in module.\n";
194 // If the program doesn't explicitly call exit, we will need the Exit
195 // function later on to make an explicit call, so get the function now.
196 Constant *Exit = Mod->getOrInsertFunction("exit", Type::getVoidTy(Context),
197 Type::getInt32Ty(Context),
200 // Reset errno to zero on entry to main.
203 // Run static constructors.
204 EE->runStaticConstructorsDestructors(false);
206 if (NoLazyCompilation) {
207 for (Module::iterator I = Mod->begin(), E = Mod->end(); I != E; ++I) {
209 if (Fn != EntryFn && !Fn->isDeclaration())
210 EE->getPointerToFunction(Fn);
215 int Result = EE->runFunctionAsMain(EntryFn, InputArgv, envp);
217 // Run static destructors.
218 EE->runStaticConstructorsDestructors(true);
220 // If the program didn't call exit explicitly, we should call it now.
221 // This ensures that any atexit handlers get called correctly.
222 if (Function *ExitF = dyn_cast<Function>(Exit)) {
223 std::vector<GenericValue> Args;
224 GenericValue ResultGV;
225 ResultGV.IntVal = APInt(32, Result);
226 Args.push_back(ResultGV);
227 EE->runFunction(ExitF, Args);
228 errs() << "ERROR: exit(" << Result << ") returned!\n";
231 errs() << "ERROR: exit defined with wrong prototype!\n";