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