Chris Lattner | fe11a97 | 2002-12-23 23:59:41 +0000 | [diff] [blame] | 1 | //===- lli.cpp - LLVM Interpreter / Dynamic compiler ----------------------===// |
Misha Brukman | 3da94ae | 2005-04-22 00:00:37 +0000 | [diff] [blame] | 2 | // |
John Criswell | 7c0e022 | 2003-10-20 17:47:21 +0000 | [diff] [blame] | 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
Chris Lattner | 21c62da | 2007-12-29 20:44:31 +0000 | [diff] [blame] | 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
Misha Brukman | 3da94ae | 2005-04-22 00:00:37 +0000 | [diff] [blame] | 7 | // |
John Criswell | 7c0e022 | 2003-10-20 17:47:21 +0000 | [diff] [blame] | 8 | //===----------------------------------------------------------------------===// |
Chris Lattner | 92101ac | 2001-08-23 17:05:04 +0000 | [diff] [blame] | 9 | // |
Chris Lattner | 7efea1d | 2003-12-26 05:07:35 +0000 | [diff] [blame] | 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. |
Chris Lattner | 92101ac | 2001-08-23 17:05:04 +0000 | [diff] [blame] | 13 | // |
| 14 | //===----------------------------------------------------------------------===// |
| 15 | |
Chris Lattner | fd13129 | 2003-09-05 20:08:15 +0000 | [diff] [blame] | 16 | #include "llvm/Module.h" |
Misha Brukman | c4fb6fd | 2003-10-14 21:39:53 +0000 | [diff] [blame] | 17 | #include "llvm/ModuleProvider.h" |
Chris Lattner | 269a428 | 2003-12-26 06:49:53 +0000 | [diff] [blame] | 18 | #include "llvm/Type.h" |
Chris Lattner | c1e6d68 | 2007-05-06 04:58:26 +0000 | [diff] [blame] | 19 | #include "llvm/Bitcode/ReaderWriter.h" |
Chris Lattner | d3a680a | 2006-08-01 22:34:35 +0000 | [diff] [blame] | 20 | #include "llvm/CodeGen/LinkAllCodegenComponents.h" |
Brian Gaeke | d1cab3e | 2003-09-05 19:42:34 +0000 | [diff] [blame] | 21 | #include "llvm/ExecutionEngine/GenericValue.h" |
Jeffrey Yasskin | df5a7da | 2009-06-25 02:04:04 +0000 | [diff] [blame^] | 22 | #include "llvm/ExecutionEngine/Interpreter.h" |
| 23 | #include "llvm/ExecutionEngine/JIT.h" |
| 24 | #include "llvm/ExecutionEngine/JITEventListener.h" |
Reid Spencer | 551ccae | 2004-09-01 22:55:40 +0000 | [diff] [blame] | 25 | #include "llvm/Support/CommandLine.h" |
Chris Lattner | c30598b | 2006-12-06 01:18:01 +0000 | [diff] [blame] | 26 | #include "llvm/Support/ManagedStatic.h" |
Chris Lattner | c1e6d68 | 2007-05-06 04:58:26 +0000 | [diff] [blame] | 27 | #include "llvm/Support/MemoryBuffer.h" |
Reid Spencer | 551ccae | 2004-09-01 22:55:40 +0000 | [diff] [blame] | 28 | #include "llvm/Support/PluginLoader.h" |
Chris Lattner | cc14d25 | 2009-03-06 05:34:10 +0000 | [diff] [blame] | 29 | #include "llvm/Support/PrettyStackTrace.h" |
Chris Lattner | 43f249a | 2006-09-14 06:17:09 +0000 | [diff] [blame] | 30 | #include "llvm/System/Process.h" |
Chris Lattner | bed85ff | 2004-05-27 05:41:36 +0000 | [diff] [blame] | 31 | #include "llvm/System/Signals.h" |
Chris Lattner | 2deb58f | 2009-06-17 16:42:19 +0000 | [diff] [blame] | 32 | #include "llvm/Target/TargetSelect.h" |
Reid Spencer | 86f42bd | 2004-07-04 12:20:55 +0000 | [diff] [blame] | 33 | #include <iostream> |
Chris Lattner | 0204032 | 2007-04-27 17:02:33 +0000 | [diff] [blame] | 34 | #include <cerrno> |
Brian Gaeke | d0fde30 | 2003-11-11 22:41:34 +0000 | [diff] [blame] | 35 | using namespace llvm; |
| 36 | |
Chris Lattner | fe11a97 | 2002-12-23 23:59:41 +0000 | [diff] [blame] | 37 | namespace { |
| 38 | cl::opt<std::string> |
Gabor Greif | a99be51 | 2007-07-05 17:07:56 +0000 | [diff] [blame] | 39 | InputFile(cl::desc("<input bitcode>"), cl::Positional, cl::init("-")); |
Chris Lattner | 5ff62e9 | 2002-07-22 02:10:13 +0000 | [diff] [blame] | 40 | |
Chris Lattner | fe11a97 | 2002-12-23 23:59:41 +0000 | [diff] [blame] | 41 | cl::list<std::string> |
| 42 | InputArgv(cl::ConsumeAfter, cl::desc("<program arguments>...")); |
Chris Lattner | 5ff62e9 | 2002-07-22 02:10:13 +0000 | [diff] [blame] | 43 | |
Chris Lattner | fe11a97 | 2002-12-23 23:59:41 +0000 | [diff] [blame] | 44 | cl::opt<bool> ForceInterpreter("force-interpreter", |
Misha Brukman | 3d8a54d | 2003-09-25 18:10:34 +0000 | [diff] [blame] | 45 | cl::desc("Force interpretation: disable JIT"), |
| 46 | cl::init(false)); |
Evan Cheng | e1a4eda | 2008-08-08 08:12:06 +0000 | [diff] [blame] | 47 | |
Evan Cheng | 712e80e | 2009-05-04 23:05:19 +0000 | [diff] [blame] | 48 | // Determine optimization level. |
| 49 | cl::opt<char> |
| 50 | OptLevel("O", |
| 51 | cl::desc("Optimization level. [-O0, -O1, -O2, or -O3] " |
| 52 | "(default = '-O2')"), |
| 53 | cl::Prefix, |
| 54 | cl::ZeroOrMore, |
| 55 | cl::init(' ')); |
Evan Cheng | e1a4eda | 2008-08-08 08:12:06 +0000 | [diff] [blame] | 56 | |
Chris Lattner | 3015e60 | 2005-12-16 05:00:21 +0000 | [diff] [blame] | 57 | cl::opt<std::string> |
Chris Lattner | 60844d4 | 2005-12-16 05:19:18 +0000 | [diff] [blame] | 58 | TargetTriple("mtriple", cl::desc("Override target triple for module")); |
Evan Cheng | ec740e3 | 2008-11-05 23:21:52 +0000 | [diff] [blame] | 59 | |
| 60 | cl::opt<std::string> |
| 61 | EntryFunc("entry-function", |
| 62 | cl::desc("Specify the entry function (default = 'main') " |
| 63 | "of the executable"), |
| 64 | cl::value_desc("function"), |
| 65 | cl::init("main")); |
Chris Lattner | 3015e60 | 2005-12-16 05:00:21 +0000 | [diff] [blame] | 66 | |
Chris Lattner | e69671d | 2003-10-28 22:51:44 +0000 | [diff] [blame] | 67 | cl::opt<std::string> |
| 68 | FakeArgv0("fake-argv0", |
| 69 | cl::desc("Override the 'argv[0]' value passed into the executing" |
| 70 | " program"), cl::value_desc("executable")); |
Chris Lattner | 43f249a | 2006-09-14 06:17:09 +0000 | [diff] [blame] | 71 | |
| 72 | cl::opt<bool> |
| 73 | DisableCoreFiles("disable-core-files", cl::Hidden, |
| 74 | cl::desc("Disable emission of core files if possible")); |
Evan Cheng | c290a5b | 2008-04-22 06:51:41 +0000 | [diff] [blame] | 75 | |
| 76 | cl::opt<bool> |
Evan Cheng | 03dace8 | 2008-05-21 18:20:21 +0000 | [diff] [blame] | 77 | NoLazyCompilation("disable-lazy-compilation", |
Evan Cheng | c290a5b | 2008-04-22 06:51:41 +0000 | [diff] [blame] | 78 | cl::desc("Disable JIT lazy compilation"), |
| 79 | cl::init(false)); |
Chris Lattner | fe11a97 | 2002-12-23 23:59:41 +0000 | [diff] [blame] | 80 | } |
Chris Lattner | 43e3f7c | 2001-10-27 08:43:52 +0000 | [diff] [blame] | 81 | |
Reid Spencer | f70d677 | 2007-03-03 18:21:44 +0000 | [diff] [blame] | 82 | static ExecutionEngine *EE = 0; |
| 83 | |
| 84 | static void do_shutdown() { |
| 85 | delete EE; |
| 86 | llvm_shutdown(); |
| 87 | } |
| 88 | |
Chris Lattner | 92101ac | 2001-08-23 17:05:04 +0000 | [diff] [blame] | 89 | //===----------------------------------------------------------------------===// |
Chris Lattner | 92101ac | 2001-08-23 17:05:04 +0000 | [diff] [blame] | 90 | // main Driver function |
| 91 | // |
Misha Brukman | c4fb6fd | 2003-10-14 21:39:53 +0000 | [diff] [blame] | 92 | int main(int argc, char **argv, char * const *envp) { |
Chris Lattner | cc14d25 | 2009-03-06 05:34:10 +0000 | [diff] [blame] | 93 | sys::PrintStackTraceOnErrorSignal(); |
| 94 | PrettyStackTraceProgram X(argc, argv); |
| 95 | |
Reid Spencer | f70d677 | 2007-03-03 18:21:44 +0000 | [diff] [blame] | 96 | atexit(do_shutdown); // Call llvm_shutdown() on exit. |
Chris Lattner | c1e6d68 | 2007-05-06 04:58:26 +0000 | [diff] [blame] | 97 | cl::ParseCommandLineOptions(argc, argv, |
Dan Gohman | 82a13c9 | 2007-10-08 15:45:12 +0000 | [diff] [blame] | 98 | "llvm interpreter & dynamic compiler\n"); |
Reid Spencer | 1ef8bda | 2004-12-30 05:36:08 +0000 | [diff] [blame] | 99 | |
Chris Lattner | c1e6d68 | 2007-05-06 04:58:26 +0000 | [diff] [blame] | 100 | // If the user doesn't want core files, disable them. |
| 101 | if (DisableCoreFiles) |
| 102 | sys::Process::PreventCoreFiles(); |
| 103 | |
Gabor Greif | a99be51 | 2007-07-05 17:07:56 +0000 | [diff] [blame] | 104 | // Load the bitcode... |
Chris Lattner | c1e6d68 | 2007-05-06 04:58:26 +0000 | [diff] [blame] | 105 | std::string ErrorMsg; |
Evan Cheng | c290a5b | 2008-04-22 06:51:41 +0000 | [diff] [blame] | 106 | ModuleProvider *MP = NULL; |
| 107 | if (MemoryBuffer *Buffer = MemoryBuffer::getFileOrSTDIN(InputFile,&ErrorMsg)) { |
Chris Lattner | 744879e | 2007-05-06 09:32:02 +0000 | [diff] [blame] | 108 | MP = getBitcodeModuleProvider(Buffer, &ErrorMsg); |
| 109 | if (!MP) delete Buffer; |
Chris Lattner | 92101ac | 2001-08-23 17:05:04 +0000 | [diff] [blame] | 110 | } |
Chris Lattner | c1e6d68 | 2007-05-06 04:58:26 +0000 | [diff] [blame] | 111 | |
| 112 | if (!MP) { |
| 113 | std::cerr << argv[0] << ": error loading program '" << InputFile << "': " |
| 114 | << ErrorMsg << "\n"; |
| 115 | exit(1); |
| 116 | } |
| 117 | |
| 118 | // Get the module as the MP could go away once EE takes over. |
Evan Cheng | c290a5b | 2008-04-22 06:51:41 +0000 | [diff] [blame] | 119 | Module *Mod = NoLazyCompilation |
| 120 | ? MP->materializeModule(&ErrorMsg) : MP->getModule(); |
| 121 | if (!Mod) { |
| 122 | std::cerr << argv[0] << ": bitcode didn't read correctly.\n"; |
| 123 | std::cerr << "Reason: " << ErrorMsg << "\n"; |
| 124 | exit(1); |
| 125 | } |
Chris Lattner | c1e6d68 | 2007-05-06 04:58:26 +0000 | [diff] [blame] | 126 | |
| 127 | // If we are supposed to override the target triple, do so now. |
| 128 | if (!TargetTriple.empty()) |
| 129 | Mod->setTargetTriple(TargetTriple); |
Evan Cheng | c290a5b | 2008-04-22 06:51:41 +0000 | [diff] [blame] | 130 | |
Evan Cheng | 712e80e | 2009-05-04 23:05:19 +0000 | [diff] [blame] | 131 | CodeGenOpt::Level OLvl = CodeGenOpt::Default; |
| 132 | switch (OptLevel) { |
| 133 | default: |
| 134 | std::cerr << argv[0] << ": invalid optimization level.\n"; |
| 135 | return 1; |
| 136 | case ' ': break; |
| 137 | case '0': OLvl = CodeGenOpt::None; break; |
| 138 | case '1': |
| 139 | case '2': OLvl = CodeGenOpt::Default; break; |
| 140 | case '3': OLvl = CodeGenOpt::Aggressive; break; |
| 141 | } |
Chris Lattner | c447ff6 | 2009-06-17 02:15:40 +0000 | [diff] [blame] | 142 | |
Chris Lattner | 2deb58f | 2009-06-17 16:42:19 +0000 | [diff] [blame] | 143 | // If we have a native target, initialize it to ensure it is linked in and |
| 144 | // usable by the JIT. |
| 145 | InitializeNativeTarget(); |
Evan Cheng | 712e80e | 2009-05-04 23:05:19 +0000 | [diff] [blame] | 146 | |
| 147 | EE = ExecutionEngine::create(MP, ForceInterpreter, &ErrorMsg, OLvl); |
Chris Lattner | c1e6d68 | 2007-05-06 04:58:26 +0000 | [diff] [blame] | 148 | if (!EE && !ErrorMsg.empty()) { |
| 149 | std::cerr << argv[0] << ":error creating EE: " << ErrorMsg << "\n"; |
| 150 | exit(1); |
| 151 | } |
| 152 | |
Jeffrey Yasskin | df5a7da | 2009-06-25 02:04:04 +0000 | [diff] [blame^] | 153 | EE->RegisterJITEventListener(createMacOSJITEventListener()); |
| 154 | |
Evan Cheng | c290a5b | 2008-04-22 06:51:41 +0000 | [diff] [blame] | 155 | if (NoLazyCompilation) |
| 156 | EE->DisableLazyCompilation(); |
| 157 | |
Chris Lattner | c1e6d68 | 2007-05-06 04:58:26 +0000 | [diff] [blame] | 158 | // If the user specifically requested an argv[0] to pass into the program, |
| 159 | // do it now. |
| 160 | if (!FakeArgv0.empty()) { |
| 161 | InputFile = FakeArgv0; |
| 162 | } else { |
| 163 | // Otherwise, if there is a .bc suffix on the executable strip it off, it |
| 164 | // might confuse the program. |
| 165 | if (InputFile.rfind(".bc") == InputFile.length() - 3) |
| 166 | InputFile.erase(InputFile.length() - 3); |
| 167 | } |
| 168 | |
| 169 | // Add the module's name to the start of the vector of arguments to main(). |
| 170 | InputArgv.insert(InputArgv.begin(), InputFile); |
| 171 | |
| 172 | // Call the main function from M as if its signature were: |
| 173 | // int main (int argc, char **argv, const char **envp) |
| 174 | // using the contents of Args to determine argc & argv, and the contents of |
| 175 | // EnvVars to determine envp. |
| 176 | // |
Evan Cheng | ec740e3 | 2008-11-05 23:21:52 +0000 | [diff] [blame] | 177 | Function *EntryFn = Mod->getFunction(EntryFunc); |
| 178 | if (!EntryFn) { |
| 179 | std::cerr << '\'' << EntryFunc << "\' function not found in module.\n"; |
Chris Lattner | c1e6d68 | 2007-05-06 04:58:26 +0000 | [diff] [blame] | 180 | return -1; |
| 181 | } |
| 182 | |
| 183 | // If the program doesn't explicitly call exit, we will need the Exit |
| 184 | // function later on to make an explicit call, so get the function now. |
| 185 | Constant *Exit = Mod->getOrInsertFunction("exit", Type::VoidTy, |
| 186 | Type::Int32Ty, NULL); |
| 187 | |
| 188 | // Reset errno to zero on entry to main. |
| 189 | errno = 0; |
| 190 | |
| 191 | // Run static constructors. |
| 192 | EE->runStaticConstructorsDestructors(false); |
Evan Cheng | c290a5b | 2008-04-22 06:51:41 +0000 | [diff] [blame] | 193 | |
| 194 | if (NoLazyCompilation) { |
| 195 | for (Module::iterator I = Mod->begin(), E = Mod->end(); I != E; ++I) { |
| 196 | Function *Fn = &*I; |
Evan Cheng | ec740e3 | 2008-11-05 23:21:52 +0000 | [diff] [blame] | 197 | if (Fn != EntryFn && !Fn->isDeclaration()) |
Evan Cheng | c290a5b | 2008-04-22 06:51:41 +0000 | [diff] [blame] | 198 | EE->getPointerToFunction(Fn); |
| 199 | } |
| 200 | } |
| 201 | |
Chris Lattner | c1e6d68 | 2007-05-06 04:58:26 +0000 | [diff] [blame] | 202 | // Run main. |
Evan Cheng | ec740e3 | 2008-11-05 23:21:52 +0000 | [diff] [blame] | 203 | int Result = EE->runFunctionAsMain(EntryFn, InputArgv, envp); |
Chris Lattner | c1e6d68 | 2007-05-06 04:58:26 +0000 | [diff] [blame] | 204 | |
| 205 | // Run static destructors. |
| 206 | EE->runStaticConstructorsDestructors(true); |
| 207 | |
| 208 | // If the program didn't call exit explicitly, we should call it now. |
| 209 | // This ensures that any atexit handlers get called correctly. |
| 210 | if (Function *ExitF = dyn_cast<Function>(Exit)) { |
| 211 | std::vector<GenericValue> Args; |
| 212 | GenericValue ResultGV; |
| 213 | ResultGV.IntVal = APInt(32, Result); |
| 214 | Args.push_back(ResultGV); |
| 215 | EE->runFunction(ExitF, Args); |
| 216 | std::cerr << "ERROR: exit(" << Result << ") returned!\n"; |
| 217 | abort(); |
| 218 | } else { |
| 219 | std::cerr << "ERROR: exit defined with wrong prototype!\n"; |
| 220 | abort(); |
| 221 | } |
Chris Lattner | 92101ac | 2001-08-23 17:05:04 +0000 | [diff] [blame] | 222 | } |