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 intepreter if no JIT is available for this platform.
14 //===----------------------------------------------------------------------===//
16 #include "llvm/LLVMContext.h"
17 #include "llvm/Module.h"
18 #include "llvm/ModuleProvider.h"
19 #include "llvm/Type.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/Support/CommandLine.h"
27 #include "llvm/Support/ManagedStatic.h"
28 #include "llvm/Support/MemoryBuffer.h"
29 #include "llvm/Support/PluginLoader.h"
30 #include "llvm/Support/PrettyStackTrace.h"
31 #include "llvm/System/Process.h"
32 #include "llvm/System/Signals.h"
33 #include "llvm/Target/TargetSelect.h"
40 InputFile(cl::desc("<input bitcode>"), cl::Positional, cl::init("-"));
43 InputArgv(cl::ConsumeAfter, cl::desc("<program arguments>..."));
45 cl::opt<bool> ForceInterpreter("force-interpreter",
46 cl::desc("Force interpretation: disable JIT"),
49 // Determine optimization level.
52 cl::desc("Optimization level. [-O0, -O1, -O2, or -O3] "
59 TargetTriple("mtriple", cl::desc("Override target triple for module"));
62 EntryFunc("entry-function",
63 cl::desc("Specify the entry function (default = 'main') "
65 cl::value_desc("function"),
69 FakeArgv0("fake-argv0",
70 cl::desc("Override the 'argv[0]' value passed into the executing"
71 " program"), cl::value_desc("executable"));
74 DisableCoreFiles("disable-core-files", cl::Hidden,
75 cl::desc("Disable emission of core files if possible"));
78 NoLazyCompilation("disable-lazy-compilation",
79 cl::desc("Disable JIT lazy compilation"),
83 static ExecutionEngine *EE = 0;
85 static void do_shutdown() {
90 //===----------------------------------------------------------------------===//
91 // main Driver function
93 int main(int argc, char **argv, char * const *envp) {
94 sys::PrintStackTraceOnErrorSignal();
95 PrettyStackTraceProgram X(argc, argv);
98 atexit(do_shutdown); // Call llvm_shutdown() on exit.
99 cl::ParseCommandLineOptions(argc, argv,
100 "llvm interpreter & dynamic compiler\n");
102 // If the user doesn't want core files, disable them.
103 if (DisableCoreFiles)
104 sys::Process::PreventCoreFiles();
106 // Load the bitcode...
107 std::string ErrorMsg;
108 ModuleProvider *MP = NULL;
109 if (MemoryBuffer *Buffer = MemoryBuffer::getFileOrSTDIN(InputFile,&ErrorMsg)){
110 MP = getBitcodeModuleProvider(Buffer, Context, &ErrorMsg);
111 if (!MP) delete Buffer;
115 std::cerr << argv[0] << ": error loading program '" << InputFile << "': "
120 // Get the module as the MP could go away once EE takes over.
121 Module *Mod = NoLazyCompilation
122 ? MP->materializeModule(&ErrorMsg) : MP->getModule();
124 std::cerr << argv[0] << ": bitcode didn't read correctly.\n";
125 std::cerr << "Reason: " << ErrorMsg << "\n";
129 // If we are supposed to override the target triple, do so now.
130 if (!TargetTriple.empty())
131 Mod->setTargetTriple(TargetTriple);
133 CodeGenOpt::Level OLvl = CodeGenOpt::Default;
136 std::cerr << argv[0] << ": invalid optimization level.\n";
139 case '0': OLvl = CodeGenOpt::None; break;
141 case '2': OLvl = CodeGenOpt::Default; break;
142 case '3': OLvl = CodeGenOpt::Aggressive; break;
145 // If we have a native target, initialize it to ensure it is linked in and
146 // usable by the JIT.
147 InitializeNativeTarget();
149 EE = ExecutionEngine::create(MP, ForceInterpreter, &ErrorMsg, OLvl);
150 if (!EE && !ErrorMsg.empty()) {
151 std::cerr << argv[0] << ":error creating EE: " << ErrorMsg << "\n";
155 EE->RegisterJITEventListener(createMacOSJITEventListener());
157 if (NoLazyCompilation)
158 EE->DisableLazyCompilation();
160 // If the user specifically requested an argv[0] to pass into the program,
162 if (!FakeArgv0.empty()) {
163 InputFile = FakeArgv0;
165 // Otherwise, if there is a .bc suffix on the executable strip it off, it
166 // might confuse the program.
167 if (InputFile.rfind(".bc") == InputFile.length() - 3)
168 InputFile.erase(InputFile.length() - 3);
171 // Add the module's name to the start of the vector of arguments to main().
172 InputArgv.insert(InputArgv.begin(), InputFile);
174 // Call the main function from M as if its signature were:
175 // int main (int argc, char **argv, const char **envp)
176 // using the contents of Args to determine argc & argv, and the contents of
177 // EnvVars to determine envp.
179 Function *EntryFn = Mod->getFunction(EntryFunc);
181 std::cerr << '\'' << EntryFunc << "\' function not found in module.\n";
185 // If the program doesn't explicitly call exit, we will need the Exit
186 // function later on to make an explicit call, so get the function now.
187 Constant *Exit = Mod->getOrInsertFunction("exit", Type::VoidTy,
188 Type::Int32Ty, NULL);
190 // Reset errno to zero on entry to main.
193 // Run static constructors.
194 EE->runStaticConstructorsDestructors(false);
196 if (NoLazyCompilation) {
197 for (Module::iterator I = Mod->begin(), E = Mod->end(); I != E; ++I) {
199 if (Fn != EntryFn && !Fn->isDeclaration())
200 EE->getPointerToFunction(Fn);
205 int Result = EE->runFunctionAsMain(EntryFn, InputArgv, envp);
207 // Run static destructors.
208 EE->runStaticConstructorsDestructors(true);
210 // If the program didn't call exit explicitly, we should call it now.
211 // This ensures that any atexit handlers get called correctly.
212 if (Function *ExitF = dyn_cast<Function>(Exit)) {
213 std::vector<GenericValue> Args;
214 GenericValue ResultGV;
215 ResultGV.IntVal = APInt(32, Result);
216 Args.push_back(ResultGV);
217 EE->runFunction(ExitF, Args);
218 std::cerr << "ERROR: exit(" << Result << ") returned!\n";
221 std::cerr << "ERROR: exit defined with wrong prototype!\n";