tools/lli/lli.cpp

   1 //===- lli.cpp - LLVM Interpreter / Dynamic compiler ----------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source 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 bytecode>"), 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
  57 static ExecutionEngine *EE = 0;
  58
  59 static void do_shutdown() {
  60   delete EE;
  61   llvm_shutdown();
  62 }
  63
  64 //===----------------------------------------------------------------------===//
  65 // main Driver function
  66 //
  67 int main(int argc, char **argv, char * const *envp) {
  68   atexit(do_shutdown);  // Call llvm_shutdown() on exit.
  69   cl::ParseCommandLineOptions(argc, argv,
  70                               " llvm interpreter & dynamic compiler\n");
  71   sys::PrintStackTraceOnErrorSignal();
  72
  73   // If the user doesn't want core files, disable them.
  74   if (DisableCoreFiles)
  75     sys::Process::PreventCoreFiles();
  76
  77   // Load the bytecode...
  78   std::string ErrorMsg;
  79   ModuleProvider *MP = 0;
  80   MemoryBuffer *Buffer = MemoryBuffer::getFileOrSTDIN(&InputFile[0],
  81                                                       InputFile.size());
  82   if (Buffer == 0)
  83     ErrorMsg = "Error reading file '" + InputFile + "'";
  84   else {
  85     MP = getBitcodeModuleProvider(Buffer, &ErrorMsg);
  86     if (!MP) delete Buffer;
  87   }
  88
  89   if (!MP) {
  90     std::cerr << argv[0] << ": error loading program '" << InputFile << "': "
  91               << ErrorMsg << "\n";
  92     exit(1);
  93   }
  94
  95   // Get the module as the MP could go away once EE takes over.
  96   Module *Mod = MP->getModule();
  97
  98   // If we are supposed to override the target triple, do so now.
  99   if (!TargetTriple.empty())
 100     Mod->setTargetTriple(TargetTriple);
 101
 102   EE = ExecutionEngine::create(MP, ForceInterpreter, &ErrorMsg);
 103   if (!EE && !ErrorMsg.empty()) {
 104     std::cerr << argv[0] << ":error creating EE: " << ErrorMsg << "\n";
 105     exit(1);
 106   }
 107
 108   // If the user specifically requested an argv[0] to pass into the program,
 109   // do it now.
 110   if (!FakeArgv0.empty()) {
 111     InputFile = FakeArgv0;
 112   } else {
 113     // Otherwise, if there is a .bc suffix on the executable strip it off, it
 114     // might confuse the program.
 115     if (InputFile.rfind(".bc") == InputFile.length() - 3)
 116       InputFile.erase(InputFile.length() - 3);
 117   }
 118
 119   // Add the module's name to the start of the vector of arguments to main().
 120   InputArgv.insert(InputArgv.begin(), InputFile);
 121
 122   // Call the main function from M as if its signature were:
 123   //   int main (int argc, char **argv, const char **envp)
 124   // using the contents of Args to determine argc & argv, and the contents of
 125   // EnvVars to determine envp.
 126   //
 127   Function *Fn = Mod->getFunction("main");
 128   if (!Fn) {
 129     std::cerr << "'main' function not found in module.\n";
 130     return -1;
 131   }
 132
 133   // If the program doesn't explicitly call exit, we will need the Exit
 134   // function later on to make an explicit call, so get the function now.
 135   Constant *Exit = Mod->getOrInsertFunction("exit", Type::VoidTy,
 136                                                         Type::Int32Ty, NULL);
 137
 138   // Reset errno to zero on entry to main.
 139   errno = 0;
 140
 141   // Run static constructors.
 142   EE->runStaticConstructorsDestructors(false);
 143
 144   // Run main.
 145   int Result = EE->runFunctionAsMain(Fn, InputArgv, envp);
 146
 147   // Run static destructors.
 148   EE->runStaticConstructorsDestructors(true);
 149
 150   // If the program didn't call exit explicitly, we should call it now.
 151   // This ensures that any atexit handlers get called correctly.
 152   if (Function *ExitF = dyn_cast<Function>(Exit)) {
 153     std::vector<GenericValue> Args;
 154     GenericValue ResultGV;
 155     ResultGV.IntVal = APInt(32, Result);
 156     Args.push_back(ResultGV);
 157     EE->runFunction(ExitF, Args);
 158     std::cerr << "ERROR: exit(" << Result << ") returned!\n";
 159     abort();
 160   } else {
 161     std::cerr << "ERROR: exit defined with wrong prototype!\n";
 162     abort();
 163   }
 164 }