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/Support/PrettyStackTrace.h"
29 #include "llvm/System/Process.h"
30 #include "llvm/System/Signals.h"
37 InputFile(cl::desc("<input bitcode>"), cl::Positional, cl::init("-"));
40 InputArgv(cl::ConsumeAfter, cl::desc("<program arguments>..."));
42 cl::opt<bool> ForceInterpreter("force-interpreter",
43 cl::desc("Force interpretation: disable JIT"),
46 cl::opt<bool> Fast("fast",
47 cl::desc("Generate code quickly, "
48 "potentially sacrificing code quality"),
52 TargetTriple("mtriple", cl::desc("Override target triple for module"));
55 EntryFunc("entry-function",
56 cl::desc("Specify the entry function (default = 'main') "
58 cl::value_desc("function"),
62 FakeArgv0("fake-argv0",
63 cl::desc("Override the 'argv[0]' value passed into the executing"
64 " program"), cl::value_desc("executable"));
67 DisableCoreFiles("disable-core-files", cl::Hidden,
68 cl::desc("Disable emission of core files if possible"));
71 NoLazyCompilation("disable-lazy-compilation",
72 cl::desc("Disable JIT lazy compilation"),
76 static ExecutionEngine *EE = 0;
78 static void do_shutdown() {
83 //===----------------------------------------------------------------------===//
84 // main Driver function
86 int main(int argc, char **argv, char * const *envp) {
87 sys::PrintStackTraceOnErrorSignal();
88 PrettyStackTraceProgram X(argc, argv);
90 atexit(do_shutdown); // Call llvm_shutdown() on exit.
91 cl::ParseCommandLineOptions(argc, argv,
92 "llvm interpreter & dynamic compiler\n");
94 // If the user doesn't want core files, disable them.
96 sys::Process::PreventCoreFiles();
98 // Load the bitcode...
100 ModuleProvider *MP = NULL;
101 if (MemoryBuffer *Buffer = MemoryBuffer::getFileOrSTDIN(InputFile,&ErrorMsg)) {
102 MP = getBitcodeModuleProvider(Buffer, &ErrorMsg);
103 if (!MP) delete Buffer;
107 std::cerr << argv[0] << ": error loading program '" << InputFile << "': "
112 // Get the module as the MP could go away once EE takes over.
113 Module *Mod = NoLazyCompilation
114 ? MP->materializeModule(&ErrorMsg) : MP->getModule();
116 std::cerr << argv[0] << ": bitcode didn't read correctly.\n";
117 std::cerr << "Reason: " << ErrorMsg << "\n";
121 // If we are supposed to override the target triple, do so now.
122 if (!TargetTriple.empty())
123 Mod->setTargetTriple(TargetTriple);
125 EE = ExecutionEngine::create(MP, ForceInterpreter, &ErrorMsg,
127 CodeGenOpt::None : CodeGenOpt::Aggressive);
128 if (!EE && !ErrorMsg.empty()) {
129 std::cerr << argv[0] << ":error creating EE: " << ErrorMsg << "\n";
133 if (NoLazyCompilation)
134 EE->DisableLazyCompilation();
136 // If the user specifically requested an argv[0] to pass into the program,
138 if (!FakeArgv0.empty()) {
139 InputFile = FakeArgv0;
141 // Otherwise, if there is a .bc suffix on the executable strip it off, it
142 // might confuse the program.
143 if (InputFile.rfind(".bc") == InputFile.length() - 3)
144 InputFile.erase(InputFile.length() - 3);
147 // Add the module's name to the start of the vector of arguments to main().
148 InputArgv.insert(InputArgv.begin(), InputFile);
150 // Call the main function from M as if its signature were:
151 // int main (int argc, char **argv, const char **envp)
152 // using the contents of Args to determine argc & argv, and the contents of
153 // EnvVars to determine envp.
155 Function *EntryFn = Mod->getFunction(EntryFunc);
157 std::cerr << '\'' << EntryFunc << "\' function not found in module.\n";
161 // If the program doesn't explicitly call exit, we will need the Exit
162 // function later on to make an explicit call, so get the function now.
163 Constant *Exit = Mod->getOrInsertFunction("exit", Type::VoidTy,
164 Type::Int32Ty, NULL);
166 // Reset errno to zero on entry to main.
169 // Run static constructors.
170 EE->runStaticConstructorsDestructors(false);
172 if (NoLazyCompilation) {
173 for (Module::iterator I = Mod->begin(), E = Mod->end(); I != E; ++I) {
175 if (Fn != EntryFn && !Fn->isDeclaration())
176 EE->getPointerToFunction(Fn);
181 int Result = EE->runFunctionAsMain(EntryFn, InputArgv, envp);
183 // Run static destructors.
184 EE->runStaticConstructorsDestructors(true);
186 // If the program didn't call exit explicitly, we should call it now.
187 // This ensures that any atexit handlers get called correctly.
188 if (Function *ExitF = dyn_cast<Function>(Exit)) {
189 std::vector<GenericValue> Args;
190 GenericValue ResultGV;
191 ResultGV.IntVal = APInt(32, Result);
192 Args.push_back(ResultGV);
193 EE->runFunction(ExitF, Args);
194 std::cerr << "ERROR: exit(" << Result << ") returned!\n";
197 std::cerr << "ERROR: exit defined with wrong prototype!\n";