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 interpreter if no JIT is available for this platform.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #include "llvm/LLVMContext.h"
  17 #include "llvm/Module.h"
  18 #include "llvm/Type.h"
  19 #include "llvm/Bitcode/ReaderWriter.h"
  20 #include "llvm/CodeGen/LinkAllCodegenComponents.h"
  21 #include "llvm/ExecutionEngine/GenericValue.h"
  22 #include "llvm/ExecutionEngine/Interpreter.h"
  23 #include "llvm/ExecutionEngine/JIT.h"
  24 #include "llvm/ExecutionEngine/JITEventListener.h"
  25 #include "llvm/Support/CommandLine.h"
  26 #include "llvm/Support/ManagedStatic.h"
  27 #include "llvm/Support/MemoryBuffer.h"
  28 #include "llvm/Support/PluginLoader.h"
  29 #include "llvm/Support/PrettyStackTrace.h"
  30 #include "llvm/Support/raw_ostream.h"
  31 #include "llvm/System/Process.h"
  32 #include "llvm/System/Signals.h"
  33 #include "llvm/Target/TargetSelect.h"
  34 #include <cerrno>
  35 using namespace llvm;
  36
  37 namespace {
  38   cl::opt<std::string>
  39   InputFile(cl::desc("<input bitcode>"), cl::Positional, cl::init("-"));
  40
  41   cl::list<std::string>
  42   InputArgv(cl::ConsumeAfter, cl::desc("<program arguments>..."));
  43
  44   cl::opt<bool> ForceInterpreter("force-interpreter",
  45                                  cl::desc("Force interpretation: disable JIT"),
  46                                  cl::init(false));
  47
  48   // Determine optimization level.
  49   cl::opt<char>
  50   OptLevel("O",
  51            cl::desc("Optimization level. [-O0, -O1, -O2, or -O3] "
  52                     "(default = '-O2')"),
  53            cl::Prefix,
  54            cl::ZeroOrMore,
  55            cl::init(' '));
  56
  57   cl::opt<std::string>
  58   TargetTriple("mtriple", cl::desc("Override target triple for module"));
  59
  60   cl::opt<std::string>
  61   MArch("march",
  62         cl::desc("Architecture to generate assembly for (see --version)"));
  63
  64   cl::opt<std::string>
  65   MCPU("mcpu",
  66        cl::desc("Target a specific cpu type (-mcpu=help for details)"),
  67        cl::value_desc("cpu-name"),
  68        cl::init(""));
  69
  70   cl::list<std::string>
  71   MAttrs("mattr",
  72          cl::CommaSeparated,
  73          cl::desc("Target specific attributes (-mattr=help for details)"),
  74          cl::value_desc("a1,+a2,-a3,..."));
  75
  76   cl::opt<std::string>
  77   EntryFunc("entry-function",
  78             cl::desc("Specify the entry function (default = 'main') "
  79                      "of the executable"),
  80             cl::value_desc("function"),
  81             cl::init("main"));
  82
  83   cl::opt<std::string>
  84   FakeArgv0("fake-argv0",
  85             cl::desc("Override the 'argv[0]' value passed into the executing"
  86                      " program"), cl::value_desc("executable"));
  87
  88   cl::opt<bool>
  89   DisableCoreFiles("disable-core-files", cl::Hidden,
  90                    cl::desc("Disable emission of core files if possible"));
  91
  92   cl::opt<bool>
  93   NoLazyCompilation("disable-lazy-compilation",
  94                   cl::desc("Disable JIT lazy compilation"),
  95                   cl::init(false));
  96 }
  97
  98 static ExecutionEngine *EE = 0;
  99
 100 static void do_shutdown() {
 101   delete EE;
 102   llvm_shutdown();
 103 }
 104
 105 //===----------------------------------------------------------------------===//
 106 // main Driver function
 107 //
 108 int main(int argc, char **argv, char * const *envp) {
 109   sys::PrintStackTraceOnErrorSignal();
 110   PrettyStackTraceProgram X(argc, argv);
 111
 112   LLVMContext &Context = getGlobalContext();
 113   atexit(do_shutdown);  // Call llvm_shutdown() on exit.
 114
 115   // If we have a native target, initialize it to ensure it is linked in and
 116   // usable by the JIT.
 117   InitializeNativeTarget();
 118
 119   cl::ParseCommandLineOptions(argc, argv,
 120                               "llvm interpreter & dynamic compiler\n");
 121
 122   // If the user doesn't want core files, disable them.
 123   if (DisableCoreFiles)
 124     sys::Process::PreventCoreFiles();
 125
 126   // Load the bitcode...
 127   std::string ErrorMsg;
 128   Module *Mod = NULL;
 129   if (MemoryBuffer *Buffer = MemoryBuffer::getFileOrSTDIN(InputFile,&ErrorMsg)){
 130     Mod = getLazyBitcodeModule(Buffer, Context, &ErrorMsg);
 131     if (!Mod) delete Buffer;
 132   }
 133
 134   if (!Mod) {
 135     errs() << argv[0] << ": error loading program '" << InputFile << "': "
 136            << ErrorMsg << "\n";
 137     exit(1);
 138   }
 139
 140   // If not jitting lazily, load the whole bitcode file eagerly too.
 141   if (NoLazyCompilation) {
 142     if (Mod->MaterializeAllPermanently(&ErrorMsg)) {
 143       errs() << argv[0] << ": bitcode didn't read correctly.\n";
 144       errs() << "Reason: " << ErrorMsg << "\n";
 145       exit(1);
 146     }
 147   }
 148
 149   EngineBuilder builder(Mod);
 150   builder.setMArch(MArch);
 151   builder.setMCPU(MCPU);
 152   builder.setMAttrs(MAttrs);
 153   builder.setErrorStr(&ErrorMsg);
 154   builder.setEngineKind(ForceInterpreter
 155                         ? EngineKind::Interpreter
 156                         : EngineKind::JIT);
 157
 158   // If we are supposed to override the target triple, do so now.
 159   if (!TargetTriple.empty())
 160     Mod->setTargetTriple(TargetTriple);
 161
 162   CodeGenOpt::Level OLvl = CodeGenOpt::Default;
 163   switch (OptLevel) {
 164   default:
 165     errs() << argv[0] << ": invalid optimization level.\n";
 166     return 1;
 167   case ' ': break;
 168   case '0': OLvl = CodeGenOpt::None; break;
 169   case '1': OLvl = CodeGenOpt::Less; break;
 170   case '2': OLvl = CodeGenOpt::Default; break;
 171   case '3': OLvl = CodeGenOpt::Aggressive; break;
 172   }
 173   builder.setOptLevel(OLvl);
 174
 175   EE = builder.create();
 176   if (!EE) {
 177     if (!ErrorMsg.empty())
 178       errs() << argv[0] << ": error creating EE: " << ErrorMsg << "\n";
 179     else
 180       errs() << argv[0] << ": unknown error creating EE!\n";
 181     exit(1);
 182   }
 183
 184   EE->RegisterJITEventListener(createOProfileJITEventListener());
 185
 186   EE->DisableLazyCompilation(NoLazyCompilation);
 187
 188   // If the user specifically requested an argv[0] to pass into the program,
 189   // do it now.
 190   if (!FakeArgv0.empty()) {
 191     InputFile = FakeArgv0;
 192   } else {
 193     // Otherwise, if there is a .bc suffix on the executable strip it off, it
 194     // might confuse the program.
 195     if (InputFile.rfind(".bc") == InputFile.length() - 3)
 196       InputFile.erase(InputFile.length() - 3);
 197   }
 198
 199   // Add the module's name to the start of the vector of arguments to main().
 200   InputArgv.insert(InputArgv.begin(), InputFile);
 201
 202   // Call the main function from M as if its signature were:
 203   //   int main (int argc, char **argv, const char **envp)
 204   // using the contents of Args to determine argc & argv, and the contents of
 205   // EnvVars to determine envp.
 206   //
 207   Function *EntryFn = Mod->getFunction(EntryFunc);
 208   if (!EntryFn) {
 209     errs() << '\'' << EntryFunc << "\' function not found in module.\n";
 210     return -1;
 211   }
 212
 213   // If the program doesn't explicitly call exit, we will need the Exit
 214   // function later on to make an explicit call, so get the function now.
 215   Constant *Exit = Mod->getOrInsertFunction("exit", Type::getVoidTy(Context),
 216                                                     Type::getInt32Ty(Context),
 217                                                     NULL);
 218
 219   // Reset errno to zero on entry to main.
 220   errno = 0;
 221
 222   // Run static constructors.
 223   EE->runStaticConstructorsDestructors(false);
 224
 225   if (NoLazyCompilation) {
 226     for (Module::iterator I = Mod->begin(), E = Mod->end(); I != E; ++I) {
 227       Function *Fn = &*I;
 228       if (Fn != EntryFn && !Fn->isDeclaration())
 229         EE->getPointerToFunction(Fn);
 230     }
 231   }
 232
 233   // Run main.
 234   int Result = EE->runFunctionAsMain(EntryFn, InputArgv, envp);
 235
 236   // Run static destructors.
 237   EE->runStaticConstructorsDestructors(true);
 238
 239   // If the program didn't call exit explicitly, we should call it now.
 240   // This ensures that any atexit handlers get called correctly.
 241   if (Function *ExitF = dyn_cast<Function>(Exit)) {
 242     std::vector<GenericValue> Args;
 243     GenericValue ResultGV;
 244     ResultGV.IntVal = APInt(32, Result);
 245     Args.push_back(ResultGV);
 246     EE->runFunction(ExitF, Args);
 247     errs() << "ERROR: exit(" << Result << ") returned!\n";
 248     abort();
 249   } else {
 250     errs() << "ERROR: exit defined with wrong prototype!\n";
 251     abort();
 252   }
 253 }