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/Module.h"
17 #include "llvm/ModuleProvider.h"
18 #include "llvm/Type.h"
19 #include "llvm/Bitcode/ReaderWriter.h"
20 #include "llvm/CodeGen/LinkAllCodegenComponents.h"
21 #include "llvm/ExecutionEngine/JIT.h"
22 #include "llvm/ExecutionEngine/Interpreter.h"
23 #include "llvm/ExecutionEngine/GenericValue.h"
24 #include "llvm/Support/CommandLine.h"
25 #include "llvm/Support/ManagedStatic.h"
26 #include "llvm/Support/MemoryBuffer.h"
27 #include "llvm/Support/PluginLoader.h"
28 #include "llvm/System/Process.h"
29 #include "llvm/System/Signals.h"
36 InputFile(cl::desc("<input bitcode>"), cl::Positional, cl::init("-"));
39 InputArgv(cl::ConsumeAfter, cl::desc("<program arguments>..."));
41 cl::opt<bool> ForceInterpreter("force-interpreter",
42 cl::desc("Force interpretation: disable JIT"),
45 cl::opt<bool> Fast("fast",
46 cl::desc("Generate code quickly, "
47 "potentially sacrificing code quality"),
51 TargetTriple("mtriple", cl::desc("Override target triple for module"));
54 EntryFunc("entry-function",
55 cl::desc("Specify the entry function (default = 'main') "
57 cl::value_desc("function"),
61 FakeArgv0("fake-argv0",
62 cl::desc("Override the 'argv[0]' value passed into the executing"
63 " program"), cl::value_desc("executable"));
66 DisableCoreFiles("disable-core-files", cl::Hidden,
67 cl::desc("Disable emission of core files if possible"));
70 NoLazyCompilation("disable-lazy-compilation",
71 cl::desc("Disable JIT lazy compilation"),
75 static ExecutionEngine *EE = 0;
77 static void do_shutdown() {
82 //===----------------------------------------------------------------------===//
83 // main Driver function
85 int main(int argc, char **argv, char * const *envp) {
86 atexit(do_shutdown); // Call llvm_shutdown() on exit.
87 cl::ParseCommandLineOptions(argc, argv,
88 "llvm interpreter & dynamic compiler\n");
89 sys::PrintStackTraceOnErrorSignal();
91 // If the user doesn't want core files, disable them.
93 sys::Process::PreventCoreFiles();
95 // Load the bitcode...
97 ModuleProvider *MP = NULL;
98 if (MemoryBuffer *Buffer = MemoryBuffer::getFileOrSTDIN(InputFile,&ErrorMsg)) {
99 MP = getBitcodeModuleProvider(Buffer, &ErrorMsg);
100 if (!MP) delete Buffer;
104 std::cerr << argv[0] << ": error loading program '" << InputFile << "': "
109 // Get the module as the MP could go away once EE takes over.
110 Module *Mod = NoLazyCompilation
111 ? MP->materializeModule(&ErrorMsg) : MP->getModule();
113 std::cerr << argv[0] << ": bitcode didn't read correctly.\n";
114 std::cerr << "Reason: " << ErrorMsg << "\n";
118 // If we are supposed to override the target triple, do so now.
119 if (!TargetTriple.empty())
120 Mod->setTargetTriple(TargetTriple);
122 EE = ExecutionEngine::create(MP, ForceInterpreter, &ErrorMsg, Fast);
123 if (!EE && !ErrorMsg.empty()) {
124 std::cerr << argv[0] << ":error creating EE: " << ErrorMsg << "\n";
128 if (NoLazyCompilation)
129 EE->DisableLazyCompilation();
131 // If the user specifically requested an argv[0] to pass into the program,
133 if (!FakeArgv0.empty()) {
134 InputFile = FakeArgv0;
136 // Otherwise, if there is a .bc suffix on the executable strip it off, it
137 // might confuse the program.
138 if (InputFile.rfind(".bc") == InputFile.length() - 3)
139 InputFile.erase(InputFile.length() - 3);
142 // Add the module's name to the start of the vector of arguments to main().
143 InputArgv.insert(InputArgv.begin(), InputFile);
145 // Call the main function from M as if its signature were:
146 // int main (int argc, char **argv, const char **envp)
147 // using the contents of Args to determine argc & argv, and the contents of
148 // EnvVars to determine envp.
150 Function *EntryFn = Mod->getFunction(EntryFunc);
152 std::cerr << '\'' << EntryFunc << "\' function not found in module.\n";
156 // If the program doesn't explicitly call exit, we will need the Exit
157 // function later on to make an explicit call, so get the function now.
158 Constant *Exit = Mod->getOrInsertFunction("exit", Type::VoidTy,
159 Type::Int32Ty, NULL);
161 // Reset errno to zero on entry to main.
164 // Run static constructors.
165 EE->runStaticConstructorsDestructors(false);
167 if (NoLazyCompilation) {
168 for (Module::iterator I = Mod->begin(), E = Mod->end(); I != E; ++I) {
170 if (Fn != EntryFn && !Fn->isDeclaration())
171 EE->getPointerToFunction(Fn);
176 int Result = EE->runFunctionAsMain(EntryFn, InputArgv, envp);
178 // Run static destructors.
179 EE->runStaticConstructorsDestructors(true);
181 // If the program didn't call exit explicitly, we should call it now.
182 // This ensures that any atexit handlers get called correctly.
183 if (Function *ExitF = dyn_cast<Function>(Exit)) {
184 std::vector<GenericValue> Args;
185 GenericValue ResultGV;
186 ResultGV.IntVal = APInt(32, Result);
187 Args.push_back(ResultGV);
188 EE->runFunction(ExitF, Args);
189 std::cerr << "ERROR: exit(" << Result << ") returned!\n";
192 std::cerr << "ERROR: exit defined with wrong prototype!\n";