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/Bytecode/Reader.h"
  21 #include "llvm/CodeGen/LinkAllCodegenComponents.h"
  22 #include "llvm/ExecutionEngine/JIT.h"
  23 #include "llvm/ExecutionEngine/Interpreter.h"
  24 #include "llvm/ExecutionEngine/GenericValue.h"
  25 #include "llvm/Support/CommandLine.h"
  26 #include "llvm/Support/Compressor.h"
  27 #include "llvm/Support/ManagedStatic.h"
  28 #include "llvm/Support/MemoryBuffer.h"
  29 #include "llvm/Support/PluginLoader.h"
  30 #include "llvm/System/Process.h"
  31 #include "llvm/System/Signals.h"
  32 #include <iostream>
  33 #include <cerrno>
  34 using namespace llvm;
  35
  36 namespace {
  37   cl::opt<bool> Bitcode("bitcode");
  38
  39   cl::opt<std::string>
  40   InputFile(cl::desc("<input bytecode>"), 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   cl::opt<std::string>
  49   TargetTriple("mtriple", cl::desc("Override target triple for module"));
  50
  51   cl::opt<std::string>
  52   FakeArgv0("fake-argv0",
  53             cl::desc("Override the 'argv[0]' value passed into the executing"
  54                      " program"), cl::value_desc("executable"));
  55
  56   cl::opt<bool>
  57   DisableCoreFiles("disable-core-files", cl::Hidden,
  58                    cl::desc("Disable emission of core files if possible"));
  59 }
  60
  61 static ExecutionEngine *EE = 0;
  62
  63 static void do_shutdown() {
  64   delete EE;
  65   llvm_shutdown();
  66 }
  67
  68 //===----------------------------------------------------------------------===//
  69 // main Driver function
  70 //
  71 int main(int argc, char **argv, char * const *envp) {
  72   atexit(do_shutdown);  // Call llvm_shutdown() on exit.
  73   cl::ParseCommandLineOptions(argc, argv,
  74                               " llvm interpreter & dynamic compiler\n");
  75   sys::PrintStackTraceOnErrorSignal();
  76
  77   // If the user doesn't want core files, disable them.
  78   if (DisableCoreFiles)
  79     sys::Process::PreventCoreFiles();
  80
  81   // Load the bytecode...
  82   std::string ErrorMsg;
  83   ModuleProvider *MP = 0;
  84   if (Bitcode) {
  85     MemoryBuffer *Buffer = MemoryBuffer::getFileOrSTDIN(&InputFile[0],
  86                                                         InputFile.size());
  87     if (Buffer == 0)
  88       ErrorMsg = "Error reading file '" + InputFile + "'";
  89     else {
  90       MP = getBitcodeModuleProvider(Buffer, &ErrorMsg);
  91       if (!MP) delete Buffer;
  92     }
  93   } else {
  94     MP = getBytecodeModuleProvider(InputFile,
  95                                    Compressor::decompressToNewBuffer,
  96                                    &ErrorMsg);
  97   }
  98
  99   if (!MP) {
 100     std::cerr << argv[0] << ": error loading program '" << InputFile << "': "
 101               << ErrorMsg << "\n";
 102     exit(1);
 103   }
 104
 105   // Get the module as the MP could go away once EE takes over.
 106   Module *Mod = MP->getModule();
 107
 108   // If we are supposed to override the target triple, do so now.
 109   if (!TargetTriple.empty())
 110     Mod->setTargetTriple(TargetTriple);
 111
 112   EE = ExecutionEngine::create(MP, ForceInterpreter, &ErrorMsg);
 113   if (!EE && !ErrorMsg.empty()) {
 114     std::cerr << argv[0] << ":error creating EE: " << ErrorMsg << "\n";
 115     exit(1);
 116   }
 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 *Fn = Mod->getFunction("main");
 138   if (!Fn) {
 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   // Run main.
 155   int Result = EE->runFunctionAsMain(Fn, InputArgv, envp);
 156
 157   // Run static destructors.
 158   EE->runStaticConstructorsDestructors(true);
 159
 160   // If the program didn't call exit explicitly, we should call it now.
 161   // This ensures that any atexit handlers get called correctly.
 162   if (Function *ExitF = dyn_cast<Function>(Exit)) {
 163     std::vector<GenericValue> Args;
 164     GenericValue ResultGV;
 165     ResultGV.IntVal = APInt(32, Result);
 166     Args.push_back(ResultGV);
 167     EE->runFunction(ExitF, Args);
 168     std::cerr << "ERROR: exit(" << Result << ") returned!\n";
 169     abort();
 170   } else {
 171     std::cerr << "ERROR: exit defined with wrong prototype!\n";
 172     abort();
 173   }
 174 }