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 intepreter if no JIT is available for this platform.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  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"
  30 #include <iostream>
  31 #include <cerrno>
  32 using namespace llvm;
  33
  34 namespace {
  35   cl::opt<std::string>
  36   InputFile(cl::desc("<input bitcode>"), cl::Positional, cl::init("-"));
  37
  38   cl::list<std::string>
  39   InputArgv(cl::ConsumeAfter, cl::desc("<program arguments>..."));
  40
  41   cl::opt<bool> ForceInterpreter("force-interpreter",
  42                                  cl::desc("Force interpretation: disable JIT"),
  43                                  cl::init(false));
  44
  45   cl::opt<bool> Fast("fast",
  46                      cl::desc("Generate code quickly, "
  47                               "potentially sacrificing code quality"),
  48                      cl::init(false));
  49
  50   cl::opt<std::string>
  51   TargetTriple("mtriple", cl::desc("Override target triple for module"));
  52
  53   cl::opt<std::string>
  54   EntryFunc("entry-function",
  55             cl::desc("Specify the entry function (default = 'main') "
  56                      "of the executable"),
  57             cl::value_desc("function"),
  58             cl::init("main"));
  59
  60   cl::opt<std::string>
  61   FakeArgv0("fake-argv0",
  62             cl::desc("Override the 'argv[0]' value passed into the executing"
  63                      " program"), cl::value_desc("executable"));
  64
  65   cl::opt<bool>
  66   DisableCoreFiles("disable-core-files", cl::Hidden,
  67                    cl::desc("Disable emission of core files if possible"));
  68
  69   cl::opt<bool>
  70   NoLazyCompilation("disable-lazy-compilation",
  71                   cl::desc("Disable JIT lazy compilation"),
  72                   cl::init(false));
  73 }
  74
  75 static ExecutionEngine *EE = 0;
  76
  77 static void do_shutdown() {
  78   delete EE;
  79   llvm_shutdown();
  80 }
  81
  82 //===----------------------------------------------------------------------===//
  83 // main Driver function
  84 //
  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();
  90
  91   // If the user doesn't want core files, disable them.
  92   if (DisableCoreFiles)
  93     sys::Process::PreventCoreFiles();
  94
  95   // Load the bitcode...
  96   std::string ErrorMsg;
  97   ModuleProvider *MP = NULL;
  98   if (MemoryBuffer *Buffer = MemoryBuffer::getFileOrSTDIN(InputFile,&ErrorMsg)) {
  99     MP = getBitcodeModuleProvider(Buffer, &ErrorMsg);
 100     if (!MP) delete Buffer;
 101   }
 102
 103   if (!MP) {
 104     std::cerr << argv[0] << ": error loading program '" << InputFile << "': "
 105               << ErrorMsg << "\n";
 106     exit(1);
 107   }
 108
 109   // Get the module as the MP could go away once EE takes over.
 110   Module *Mod = NoLazyCompilation
 111     ? MP->materializeModule(&ErrorMsg) : MP->getModule();
 112   if (!Mod) {
 113     std::cerr << argv[0] << ": bitcode didn't read correctly.\n";
 114     std::cerr << "Reason: " << ErrorMsg << "\n";
 115     exit(1);
 116   }
 117
 118   // If we are supposed to override the target triple, do so now.
 119   if (!TargetTriple.empty())
 120     Mod->setTargetTriple(TargetTriple);
 121
 122   EE = ExecutionEngine::create(MP, ForceInterpreter, &ErrorMsg, Fast);
 123   if (!EE && !ErrorMsg.empty()) {
 124     std::cerr << argv[0] << ":error creating EE: " << ErrorMsg << "\n";
 125     exit(1);
 126   }
 127
 128   if (NoLazyCompilation)
 129     EE->DisableLazyCompilation();
 130
 131   // If the user specifically requested an argv[0] to pass into the program,
 132   // do it now.
 133   if (!FakeArgv0.empty()) {
 134     InputFile = FakeArgv0;
 135   } else {
 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);
 140   }
 141
 142   // Add the module's name to the start of the vector of arguments to main().
 143   InputArgv.insert(InputArgv.begin(), InputFile);
 144
 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.
 149   //
 150   Function *EntryFn = Mod->getFunction(EntryFunc);
 151   if (!EntryFn) {
 152     std::cerr << '\'' << EntryFunc << "\' function not found in module.\n";
 153     return -1;
 154   }
 155
 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);
 160
 161   // Reset errno to zero on entry to main.
 162   errno = 0;
 163
 164   // Run static constructors.
 165   EE->runStaticConstructorsDestructors(false);
 166
 167   if (NoLazyCompilation) {
 168     for (Module::iterator I = Mod->begin(), E = Mod->end(); I != E; ++I) {
 169       Function *Fn = &*I;
 170       if (Fn != EntryFn && !Fn->isDeclaration())
 171         EE->getPointerToFunction(Fn);
 172     }
 173   }
 174
 175   // Run main.
 176   int Result = EE->runFunctionAsMain(EntryFn, InputArgv, envp);
 177
 178   // Run static destructors.
 179   EE->runStaticConstructorsDestructors(true);
 180
 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";
 190     abort();
 191   } else {
 192     std::cerr << "ERROR: exit defined with wrong prototype!\n";
 193     abort();
 194   }
 195 }