blob: a01b0d69341ad6414fb21ec8aff837c8f2d6db7e [file] [log] [blame]
Chris Lattnerfe11a972002-12-23 23:59:41 +00001//===- lli.cpp - LLVM Interpreter / Dynamic compiler ----------------------===//
Misha Brukman3da94ae2005-04-22 00:00:37 +00002//
John Criswell7c0e0222003-10-20 17:47:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner21c62da2007-12-29 20:44:31 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukman3da94ae2005-04-22 00:00:37 +00007//
John Criswell7c0e0222003-10-20 17:47:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner92101ac2001-08-23 17:05:04 +00009//
Chris Lattner7efea1d2003-12-26 05:07:35 +000010// 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
Torok Edwindb9c0282009-07-03 12:11:32 +000012// compiler, or through an interpreter if no JIT is available for this platform.
Chris Lattner92101ac2001-08-23 17:05:04 +000013//
14//===----------------------------------------------------------------------===//
15
Owen Anderson8b477ed2009-07-01 16:58:40 +000016#include "llvm/LLVMContext.h"
Chris Lattnerfd131292003-09-05 20:08:15 +000017#include "llvm/Module.h"
Misha Brukmanc4fb6fd2003-10-14 21:39:53 +000018#include "llvm/ModuleProvider.h"
Chris Lattner269a4282003-12-26 06:49:53 +000019#include "llvm/Type.h"
Chris Lattnerc1e6d682007-05-06 04:58:26 +000020#include "llvm/Bitcode/ReaderWriter.h"
Chris Lattnerd3a680a2006-08-01 22:34:35 +000021#include "llvm/CodeGen/LinkAllCodegenComponents.h"
Brian Gaeked1cab3e2003-09-05 19:42:34 +000022#include "llvm/ExecutionEngine/GenericValue.h"
Jeffrey Yasskindf5a7da2009-06-25 02:04:04 +000023#include "llvm/ExecutionEngine/Interpreter.h"
24#include "llvm/ExecutionEngine/JIT.h"
25#include "llvm/ExecutionEngine/JITEventListener.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000026#include "llvm/Support/CommandLine.h"
Chris Lattnerc30598b2006-12-06 01:18:01 +000027#include "llvm/Support/ManagedStatic.h"
Chris Lattnerc1e6d682007-05-06 04:58:26 +000028#include "llvm/Support/MemoryBuffer.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000029#include "llvm/Support/PluginLoader.h"
Chris Lattnercc14d252009-03-06 05:34:10 +000030#include "llvm/Support/PrettyStackTrace.h"
Chris Lattner43f249a2006-09-14 06:17:09 +000031#include "llvm/System/Process.h"
Chris Lattnerbed85ff2004-05-27 05:41:36 +000032#include "llvm/System/Signals.h"
Chris Lattner2deb58f2009-06-17 16:42:19 +000033#include "llvm/Target/TargetSelect.h"
Reid Spencer86f42bd2004-07-04 12:20:55 +000034#include <iostream>
Chris Lattner02040322007-04-27 17:02:33 +000035#include <cerrno>
Brian Gaeked0fde302003-11-11 22:41:34 +000036using namespace llvm;
37
Chris Lattnerfe11a972002-12-23 23:59:41 +000038namespace {
39 cl::opt<std::string>
Gabor Greifa99be512007-07-05 17:07:56 +000040 InputFile(cl::desc("<input bitcode>"), cl::Positional, cl::init("-"));
Chris Lattner5ff62e92002-07-22 02:10:13 +000041
Chris Lattnerfe11a972002-12-23 23:59:41 +000042 cl::list<std::string>
43 InputArgv(cl::ConsumeAfter, cl::desc("<program arguments>..."));
Chris Lattner5ff62e92002-07-22 02:10:13 +000044
Chris Lattnerfe11a972002-12-23 23:59:41 +000045 cl::opt<bool> ForceInterpreter("force-interpreter",
Misha Brukman3d8a54d2003-09-25 18:10:34 +000046 cl::desc("Force interpretation: disable JIT"),
47 cl::init(false));
Evan Chenge1a4eda2008-08-08 08:12:06 +000048
Evan Cheng712e80e2009-05-04 23:05:19 +000049 // Determine optimization level.
50 cl::opt<char>
51 OptLevel("O",
52 cl::desc("Optimization level. [-O0, -O1, -O2, or -O3] "
53 "(default = '-O2')"),
54 cl::Prefix,
55 cl::ZeroOrMore,
56 cl::init(' '));
Evan Chenge1a4eda2008-08-08 08:12:06 +000057
Chris Lattner3015e602005-12-16 05:00:21 +000058 cl::opt<std::string>
Chris Lattner60844d42005-12-16 05:19:18 +000059 TargetTriple("mtriple", cl::desc("Override target triple for module"));
Evan Chengec740e32008-11-05 23:21:52 +000060
61 cl::opt<std::string>
62 EntryFunc("entry-function",
63 cl::desc("Specify the entry function (default = 'main') "
64 "of the executable"),
65 cl::value_desc("function"),
66 cl::init("main"));
Chris Lattner3015e602005-12-16 05:00:21 +000067
Chris Lattnere69671d2003-10-28 22:51:44 +000068 cl::opt<std::string>
69 FakeArgv0("fake-argv0",
70 cl::desc("Override the 'argv[0]' value passed into the executing"
71 " program"), cl::value_desc("executable"));
Chris Lattner43f249a2006-09-14 06:17:09 +000072
73 cl::opt<bool>
74 DisableCoreFiles("disable-core-files", cl::Hidden,
75 cl::desc("Disable emission of core files if possible"));
Evan Chengc290a5b2008-04-22 06:51:41 +000076
77 cl::opt<bool>
Evan Cheng03dace82008-05-21 18:20:21 +000078 NoLazyCompilation("disable-lazy-compilation",
Evan Chengc290a5b2008-04-22 06:51:41 +000079 cl::desc("Disable JIT lazy compilation"),
80 cl::init(false));
Chris Lattnerfe11a972002-12-23 23:59:41 +000081}
Chris Lattner43e3f7c2001-10-27 08:43:52 +000082
Reid Spencerf70d6772007-03-03 18:21:44 +000083static ExecutionEngine *EE = 0;
84
85static void do_shutdown() {
86 delete EE;
87 llvm_shutdown();
88}
89
Chris Lattner92101ac2001-08-23 17:05:04 +000090//===----------------------------------------------------------------------===//
Chris Lattner92101ac2001-08-23 17:05:04 +000091// main Driver function
92//
Misha Brukmanc4fb6fd2003-10-14 21:39:53 +000093int main(int argc, char **argv, char * const *envp) {
Chris Lattnercc14d252009-03-06 05:34:10 +000094 sys::PrintStackTraceOnErrorSignal();
95 PrettyStackTraceProgram X(argc, argv);
96
Owen Anderson8b477ed2009-07-01 16:58:40 +000097 LLVMContext Context;
Reid Spencerf70d6772007-03-03 18:21:44 +000098 atexit(do_shutdown); // Call llvm_shutdown() on exit.
Chris Lattnerc1e6d682007-05-06 04:58:26 +000099 cl::ParseCommandLineOptions(argc, argv,
Dan Gohman82a13c92007-10-08 15:45:12 +0000100 "llvm interpreter & dynamic compiler\n");
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000101
Chris Lattnerc1e6d682007-05-06 04:58:26 +0000102 // If the user doesn't want core files, disable them.
103 if (DisableCoreFiles)
104 sys::Process::PreventCoreFiles();
105
Gabor Greifa99be512007-07-05 17:07:56 +0000106 // Load the bitcode...
Chris Lattnerc1e6d682007-05-06 04:58:26 +0000107 std::string ErrorMsg;
Evan Chengc290a5b2008-04-22 06:51:41 +0000108 ModuleProvider *MP = NULL;
Owen Anderson8b477ed2009-07-01 16:58:40 +0000109 if (MemoryBuffer *Buffer = MemoryBuffer::getFileOrSTDIN(InputFile,&ErrorMsg)){
Owen Anderson31895e72009-07-01 21:22:36 +0000110 MP = getBitcodeModuleProvider(Buffer, Context, &ErrorMsg);
Chris Lattner744879e2007-05-06 09:32:02 +0000111 if (!MP) delete Buffer;
Chris Lattner92101ac2001-08-23 17:05:04 +0000112 }
Chris Lattnerc1e6d682007-05-06 04:58:26 +0000113
114 if (!MP) {
115 std::cerr << argv[0] << ": error loading program '" << InputFile << "': "
116 << ErrorMsg << "\n";
117 exit(1);
118 }
119
120 // Get the module as the MP could go away once EE takes over.
Evan Chengc290a5b2008-04-22 06:51:41 +0000121 Module *Mod = NoLazyCompilation
122 ? MP->materializeModule(&ErrorMsg) : MP->getModule();
123 if (!Mod) {
124 std::cerr << argv[0] << ": bitcode didn't read correctly.\n";
125 std::cerr << "Reason: " << ErrorMsg << "\n";
126 exit(1);
127 }
Chris Lattnerc1e6d682007-05-06 04:58:26 +0000128
129 // If we are supposed to override the target triple, do so now.
130 if (!TargetTriple.empty())
131 Mod->setTargetTriple(TargetTriple);
Evan Chengc290a5b2008-04-22 06:51:41 +0000132
Evan Cheng712e80e2009-05-04 23:05:19 +0000133 CodeGenOpt::Level OLvl = CodeGenOpt::Default;
134 switch (OptLevel) {
135 default:
136 std::cerr << argv[0] << ": invalid optimization level.\n";
137 return 1;
138 case ' ': break;
139 case '0': OLvl = CodeGenOpt::None; break;
140 case '1':
141 case '2': OLvl = CodeGenOpt::Default; break;
142 case '3': OLvl = CodeGenOpt::Aggressive; break;
143 }
Chris Lattnerc447ff62009-06-17 02:15:40 +0000144
Chris Lattner2deb58f2009-06-17 16:42:19 +0000145 // If we have a native target, initialize it to ensure it is linked in and
146 // usable by the JIT.
147 InitializeNativeTarget();
Evan Cheng712e80e2009-05-04 23:05:19 +0000148
149 EE = ExecutionEngine::create(MP, ForceInterpreter, &ErrorMsg, OLvl);
Chris Lattnerc1e6d682007-05-06 04:58:26 +0000150 if (!EE && !ErrorMsg.empty()) {
151 std::cerr << argv[0] << ":error creating EE: " << ErrorMsg << "\n";
152 exit(1);
153 }
154
Jeffrey Yasskindf5a7da2009-06-25 02:04:04 +0000155 EE->RegisterJITEventListener(createMacOSJITEventListener());
156
Evan Chengc290a5b2008-04-22 06:51:41 +0000157 if (NoLazyCompilation)
158 EE->DisableLazyCompilation();
159
Chris Lattnerc1e6d682007-05-06 04:58:26 +0000160 // If the user specifically requested an argv[0] to pass into the program,
161 // do it now.
162 if (!FakeArgv0.empty()) {
163 InputFile = FakeArgv0;
164 } else {
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);
169 }
170
171 // Add the module's name to the start of the vector of arguments to main().
172 InputArgv.insert(InputArgv.begin(), InputFile);
173
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.
178 //
Evan Chengec740e32008-11-05 23:21:52 +0000179 Function *EntryFn = Mod->getFunction(EntryFunc);
180 if (!EntryFn) {
181 std::cerr << '\'' << EntryFunc << "\' function not found in module.\n";
Chris Lattnerc1e6d682007-05-06 04:58:26 +0000182 return -1;
183 }
184
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);
189
190 // Reset errno to zero on entry to main.
191 errno = 0;
192
193 // Run static constructors.
194 EE->runStaticConstructorsDestructors(false);
Evan Chengc290a5b2008-04-22 06:51:41 +0000195
196 if (NoLazyCompilation) {
197 for (Module::iterator I = Mod->begin(), E = Mod->end(); I != E; ++I) {
198 Function *Fn = &*I;
Evan Chengec740e32008-11-05 23:21:52 +0000199 if (Fn != EntryFn && !Fn->isDeclaration())
Evan Chengc290a5b2008-04-22 06:51:41 +0000200 EE->getPointerToFunction(Fn);
201 }
202 }
203
Chris Lattnerc1e6d682007-05-06 04:58:26 +0000204 // Run main.
Evan Chengec740e32008-11-05 23:21:52 +0000205 int Result = EE->runFunctionAsMain(EntryFn, InputArgv, envp);
Chris Lattnerc1e6d682007-05-06 04:58:26 +0000206
207 // Run static destructors.
208 EE->runStaticConstructorsDestructors(true);
209
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";
219 abort();
220 } else {
221 std::cerr << "ERROR: exit defined with wrong prototype!\n";
222 abort();
223 }
Chris Lattner92101ac2001-08-23 17:05:04 +0000224}