tools/lli/lli.cpp

   1 //===- lli.cpp - LLVM Interpreter / Dynamic compiler ----------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  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 interpreter if no JIT is available for this platform.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  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"
  34 #include <iostream>
  35 #include <cerrno>
  36 using namespace llvm;
  37
  38 namespace {
  39   cl::opt<std::string>
  40   InputFile(cl::desc("<input bitcode>"), cl::Positional, cl::init("-"));
  41
  42   cl::list<std::string>
  43   InputArgv(cl::ConsumeAfter, cl::desc("<program arguments>..."));
  44
  45   cl::opt<bool> ForceInterpreter("force-interpreter",
  46                                  cl::desc("Force interpretation: disable JIT"),
  47                                  cl::init(false));
  48
  49   // 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(' '));
  57
  58   cl::opt<std::string>
  59   TargetTriple("mtriple", cl::desc("Override target triple for module"));
  60
  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"));
  67
  68   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"));
  72
  73   cl::opt<bool>
  74   DisableCoreFiles("disable-core-files", cl::Hidden,
  75                    cl::desc("Disable emission of core files if possible"));
  76
  77   cl::opt<bool>
  78   NoLazyCompilation("disable-lazy-compilation",
  79                   cl::desc("Disable JIT lazy compilation"),
  80                   cl::init(false));
  81 }
  82
  83 static ExecutionEngine *EE = 0;
  84
  85 static void do_shutdown() {
  86   delete EE;
  87   llvm_shutdown();
  88 }
  89
  90 //===----------------------------------------------------------------------===//
  91 // main Driver function
  92 //
  93 int main(int argc, char **argv, char * const *envp) {
  94   sys::PrintStackTraceOnErrorSignal();
  95   PrettyStackTraceProgram X(argc, argv);
  96
  97   LLVMContext &Context = getGlobalContext();
  98   atexit(do_shutdown);  // Call llvm_shutdown() on exit.
  99
 100   // If we have a native target, initialize it to ensure it is linked in and
 101   // usable by the JIT.
 102   InitializeNativeTarget();
 103
 104   cl::ParseCommandLineOptions(argc, argv,
 105                               "llvm interpreter & dynamic compiler\n");
 106
 107   // If the user doesn't want core files, disable them.
 108   if (DisableCoreFiles)
 109     sys::Process::PreventCoreFiles();
 110
 111   // Load the bitcode...
 112   std::string ErrorMsg;
 113   ModuleProvider *MP = NULL;
 114   if (MemoryBuffer *Buffer = MemoryBuffer::getFileOrSTDIN(InputFile,&ErrorMsg)){
 115     MP = getBitcodeModuleProvider(Buffer, Context, &ErrorMsg);
 116     if (!MP) delete Buffer;
 117   }
 118
 119   if (!MP) {
 120     errs() << argv[0] << ": error loading program '" << InputFile << "': "
 121            << ErrorMsg << "\n";
 122     exit(1);
 123   }
 124
 125   // Get the module as the MP could go away once EE takes over.
 126   Module *Mod = NoLazyCompilation
 127     ? MP->materializeModule(&ErrorMsg) : MP->getModule();
 128   if (!Mod) {
 129     errs() << argv[0] << ": bitcode didn't read correctly.\n";
 130     errs() << "Reason: " << ErrorMsg << "\n";
 131     exit(1);
 132   }
 133
 134   EngineBuilder builder(MP);
 135   builder.setErrorStr(&ErrorMsg);
 136   builder.setEngineKind(ForceInterpreter
 137                         ? EngineKind::Interpreter
 138                         : EngineKind::JIT);
 139   // FIXME: Don't allocate GVs with code once the JIT because smarter about
 140   // memory management.
 141   builder.setAllocateGVsWithCode(true);
 142
 143   // If we are supposed to override the target triple, do so now.
 144   if (!TargetTriple.empty())
 145     Mod->setTargetTriple(TargetTriple);
 146
 147   CodeGenOpt::Level OLvl = CodeGenOpt::Default;
 148   switch (OptLevel) {
 149   default:
 150     errs() << argv[0] << ": invalid optimization level.\n";
 151     return 1;
 152   case ' ': break;
 153   case '0': OLvl = CodeGenOpt::None; break;
 154   case '1':
 155   case '2': OLvl = CodeGenOpt::Default; break;
 156   case '3': OLvl = CodeGenOpt::Aggressive; break;
 157   }
 158   builder.setOptLevel(OLvl);
 159
 160   EE = builder.create();
 161   if (!EE) {
 162     if (!ErrorMsg.empty())
 163       errs() << argv[0] << ": error creating EE: " << ErrorMsg << "\n";
 164     else
 165       errs() << argv[0] << ": unknown error creating EE!\n";
 166     exit(1);
 167   }
 168
 169   EE->RegisterJITEventListener(createMacOSJITEventListener());
 170   EE->RegisterJITEventListener(createOProfileJITEventListener());
 171
 172   if (NoLazyCompilation)
 173     EE->DisableLazyCompilation();
 174
 175   // If the user specifically requested an argv[0] to pass into the program,
 176   // do it now.
 177   if (!FakeArgv0.empty()) {
 178     InputFile = FakeArgv0;
 179   } else {
 180     // Otherwise, if there is a .bc suffix on the executable strip it off, it
 181     // might confuse the program.
 182     if (InputFile.rfind(".bc") == InputFile.length() - 3)
 183       InputFile.erase(InputFile.length() - 3);
 184   }
 185
 186   // Add the module's name to the start of the vector of arguments to main().
 187   InputArgv.insert(InputArgv.begin(), InputFile);
 188
 189   // Call the main function from M as if its signature were:
 190   //   int main (int argc, char **argv, const char **envp)
 191   // using the contents of Args to determine argc & argv, and the contents of
 192   // EnvVars to determine envp.
 193   //
 194   Function *EntryFn = Mod->getFunction(EntryFunc);
 195   if (!EntryFn) {
 196     errs() << '\'' << EntryFunc << "\' function not found in module.\n";
 197     return -1;
 198   }
 199
 200   // If the program doesn't explicitly call exit, we will need the Exit
 201   // function later on to make an explicit call, so get the function now.
 202   Constant *Exit = Mod->getOrInsertFunction("exit", Type::VoidTy,
 203                                                         Type::Int32Ty, NULL);
 204
 205   // Reset errno to zero on entry to main.
 206   errno = 0;
 207
 208   // Run static constructors.
 209   EE->runStaticConstructorsDestructors(false);
 210
 211   if (NoLazyCompilation) {
 212     for (Module::iterator I = Mod->begin(), E = Mod->end(); I != E; ++I) {
 213       Function *Fn = &*I;
 214       if (Fn != EntryFn && !Fn->isDeclaration())
 215         EE->getPointerToFunction(Fn);
 216     }
 217   }
 218
 219   // Run main.
 220   int Result = EE->runFunctionAsMain(EntryFn, InputArgv, envp);
 221
 222   // Run static destructors.
 223   EE->runStaticConstructorsDestructors(true);
 224
 225   // If the program didn't call exit explicitly, we should call it now.
 226   // This ensures that any atexit handlers get called correctly.
 227   if (Function *ExitF = dyn_cast<Function>(Exit)) {
 228     std::vector<GenericValue> Args;
 229     GenericValue ResultGV;
 230     ResultGV.IntVal = APInt(32, Result);
 231     Args.push_back(ResultGV);
 232     EE->runFunction(ExitF, Args);
 233     errs() << "ERROR: exit(" << Result << ") returned!\n";
 234     abort();
 235   } else {
 236     errs() << "ERROR: exit defined with wrong prototype!\n";
 237     abort();
 238   }
 239 }