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/Support/PrettyStackTrace.h"
  29 #include "llvm/System/Process.h"
  30 #include "llvm/System/Signals.h"
  31 #include <iostream>
  32 #include <cerrno>
  33 using namespace llvm;
  34
  35 namespace {
  36   cl::opt<std::string>
  37   InputFile(cl::desc("<input bitcode>"), cl::Positional, cl::init("-"));
  38
  39   cl::list<std::string>
  40   InputArgv(cl::ConsumeAfter, cl::desc("<program arguments>..."));
  41
  42   cl::opt<bool> ForceInterpreter("force-interpreter",
  43                                  cl::desc("Force interpretation: disable JIT"),
  44                                  cl::init(false));
  45
  46   cl::opt<bool> Fast("fast",
  47                      cl::desc("Generate code quickly, "
  48                               "potentially sacrificing code quality"),
  49                      cl::init(false));
  50
  51   cl::opt<std::string>
  52   TargetTriple("mtriple", cl::desc("Override target triple for module"));
  53
  54   cl::opt<std::string>
  55   EntryFunc("entry-function",
  56             cl::desc("Specify the entry function (default = 'main') "
  57                      "of the executable"),
  58             cl::value_desc("function"),
  59             cl::init("main"));
  60
  61   cl::opt<std::string>
  62   FakeArgv0("fake-argv0",
  63             cl::desc("Override the 'argv[0]' value passed into the executing"
  64                      " program"), cl::value_desc("executable"));
  65
  66   cl::opt<bool>
  67   DisableCoreFiles("disable-core-files", cl::Hidden,
  68                    cl::desc("Disable emission of core files if possible"));
  69
  70   cl::opt<bool>
  71   NoLazyCompilation("disable-lazy-compilation",
  72                   cl::desc("Disable JIT lazy compilation"),
  73                   cl::init(false));
  74 }
  75
  76 static ExecutionEngine *EE = 0;
  77
  78 static void do_shutdown() {
  79   delete EE;
  80   llvm_shutdown();
  81 }
  82
  83 //===----------------------------------------------------------------------===//
  84 // main Driver function
  85 //
  86 int main(int argc, char **argv, char * const *envp) {
  87   sys::PrintStackTraceOnErrorSignal();
  88   PrettyStackTraceProgram X(argc, argv);
  89
  90   atexit(do_shutdown);  // Call llvm_shutdown() on exit.
  91   cl::ParseCommandLineOptions(argc, argv,
  92                               "llvm interpreter & dynamic compiler\n");
  93
  94   // If the user doesn't want core files, disable them.
  95   if (DisableCoreFiles)
  96     sys::Process::PreventCoreFiles();
  97
  98   // Load the bitcode...
  99   std::string ErrorMsg;
 100   ModuleProvider *MP = NULL;
 101   if (MemoryBuffer *Buffer = MemoryBuffer::getFileOrSTDIN(InputFile,&ErrorMsg)) {
 102     MP = getBitcodeModuleProvider(Buffer, &ErrorMsg);
 103     if (!MP) delete Buffer;
 104   }
 105
 106   if (!MP) {
 107     std::cerr << argv[0] << ": error loading program '" << InputFile << "': "
 108               << ErrorMsg << "\n";
 109     exit(1);
 110   }
 111
 112   // Get the module as the MP could go away once EE takes over.
 113   Module *Mod = NoLazyCompilation
 114     ? MP->materializeModule(&ErrorMsg) : MP->getModule();
 115   if (!Mod) {
 116     std::cerr << argv[0] << ": bitcode didn't read correctly.\n";
 117     std::cerr << "Reason: " << ErrorMsg << "\n";
 118     exit(1);
 119   }
 120
 121   // If we are supposed to override the target triple, do so now.
 122   if (!TargetTriple.empty())
 123     Mod->setTargetTriple(TargetTriple);
 124
 125   EE = ExecutionEngine::create(MP, ForceInterpreter, &ErrorMsg, Fast);
 126   if (!EE && !ErrorMsg.empty()) {
 127     std::cerr << argv[0] << ":error creating EE: " << ErrorMsg << "\n";
 128     exit(1);
 129   }
 130
 131   if (NoLazyCompilation)
 132     EE->DisableLazyCompilation();
 133
 134   // If the user specifically requested an argv[0] to pass into the program,
 135   // do it now.
 136   if (!FakeArgv0.empty()) {
 137     InputFile = FakeArgv0;
 138   } else {
 139     // Otherwise, if there is a .bc suffix on the executable strip it off, it
 140     // might confuse the program.
 141     if (InputFile.rfind(".bc") == InputFile.length() - 3)
 142       InputFile.erase(InputFile.length() - 3);
 143   }
 144
 145   // Add the module's name to the start of the vector of arguments to main().
 146   InputArgv.insert(InputArgv.begin(), InputFile);
 147
 148   // Call the main function from M as if its signature were:
 149   //   int main (int argc, char **argv, const char **envp)
 150   // using the contents of Args to determine argc & argv, and the contents of
 151   // EnvVars to determine envp.
 152   //
 153   Function *EntryFn = Mod->getFunction(EntryFunc);
 154   if (!EntryFn) {
 155     std::cerr << '\'' << EntryFunc << "\' function not found in module.\n";
 156     return -1;
 157   }
 158
 159   // If the program doesn't explicitly call exit, we will need the Exit
 160   // function later on to make an explicit call, so get the function now.
 161   Constant *Exit = Mod->getOrInsertFunction("exit", Type::VoidTy,
 162                                                         Type::Int32Ty, NULL);
 163
 164   // Reset errno to zero on entry to main.
 165   errno = 0;
 166
 167   // Run static constructors.
 168   EE->runStaticConstructorsDestructors(false);
 169
 170   if (NoLazyCompilation) {
 171     for (Module::iterator I = Mod->begin(), E = Mod->end(); I != E; ++I) {
 172       Function *Fn = &*I;
 173       if (Fn != EntryFn && !Fn->isDeclaration())
 174         EE->getPointerToFunction(Fn);
 175     }
 176   }
 177
 178   // Run main.
 179   int Result = EE->runFunctionAsMain(EntryFn, InputArgv, envp);
 180
 181   // Run static destructors.
 182   EE->runStaticConstructorsDestructors(true);
 183
 184   // If the program didn't call exit explicitly, we should call it now.
 185   // This ensures that any atexit handlers get called correctly.
 186   if (Function *ExitF = dyn_cast<Function>(Exit)) {
 187     std::vector<GenericValue> Args;
 188     GenericValue ResultGV;
 189     ResultGV.IntVal = APInt(32, Result);
 190     Args.push_back(ResultGV);
 191     EE->runFunction(ExitF, Args);
 192     std::cerr << "ERROR: exit(" << Result << ") returned!\n";
 193     abort();
 194   } else {
 195     std::cerr << "ERROR: exit defined with wrong prototype!\n";
 196     abort();
 197   }
 198 }