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/ADT/Triple.h"
  20 #include "llvm/Bitcode/ReaderWriter.h"
  21 #include "llvm/CodeGen/LinkAllCodegenComponents.h"
  22 #include "llvm/ExecutionEngine/GenericValue.h"
  23 #include "llvm/ExecutionEngine/Interpreter.h"
  24 #include "llvm/ExecutionEngine/JIT.h"
  25 #include "llvm/ExecutionEngine/JITEventListener.h"
  26 #include "llvm/ExecutionEngine/JITMemoryManager.h"
  27 #include "llvm/ExecutionEngine/MCJIT.h"
  28 #include "llvm/Support/CommandLine.h"
  29 #include "llvm/Support/IRReader.h"
  30 #include "llvm/Support/ManagedStatic.h"
  31 #include "llvm/Support/MemoryBuffer.h"
  32 #include "llvm/Support/PluginLoader.h"
  33 #include "llvm/Support/PrettyStackTrace.h"
  34 #include "llvm/Support/raw_ostream.h"
  35 #include "llvm/Support/Process.h"
  36 #include "llvm/Support/Signals.h"
  37 #include "llvm/Support/TargetSelect.h"
  38 #include <cerrno>
  39
  40 #ifdef __CYGWIN__
  41 #include <cygwin/version.h>
  42 #if defined(CYGWIN_VERSION_DLL_MAJOR) && CYGWIN_VERSION_DLL_MAJOR<1007
  43 #define DO_NOTHING_ATEXIT 1
  44 #endif
  45 #endif
  46
  47 using namespace llvm;
  48
  49 namespace {
  50   cl::opt<std::string>
  51   InputFile(cl::desc("<input bitcode>"), cl::Positional, cl::init("-"));
  52
  53   cl::list<std::string>
  54   InputArgv(cl::ConsumeAfter, cl::desc("<program arguments>..."));
  55
  56   cl::opt<bool> ForceInterpreter("force-interpreter",
  57                                  cl::desc("Force interpretation: disable JIT"),
  58                                  cl::init(false));
  59
  60   cl::opt<bool> UseMCJIT(
  61     "use-mcjit", cl::desc("Enable use of the MC-based JIT (if available)"),
  62     cl::init(false));
  63
  64   // Determine optimization level.
  65   cl::opt<char>
  66   OptLevel("O",
  67            cl::desc("Optimization level. [-O0, -O1, -O2, or -O3] "
  68                     "(default = '-O2')"),
  69            cl::Prefix,
  70            cl::ZeroOrMore,
  71            cl::init(' '));
  72
  73   cl::opt<std::string>
  74   TargetTriple("mtriple", cl::desc("Override target triple for module"));
  75
  76   cl::opt<std::string>
  77   MArch("march",
  78         cl::desc("Architecture to generate assembly for (see --version)"));
  79
  80   cl::opt<std::string>
  81   MCPU("mcpu",
  82        cl::desc("Target a specific cpu type (-mcpu=help for details)"),
  83        cl::value_desc("cpu-name"),
  84        cl::init(""));
  85
  86   cl::list<std::string>
  87   MAttrs("mattr",
  88          cl::CommaSeparated,
  89          cl::desc("Target specific attributes (-mattr=help for details)"),
  90          cl::value_desc("a1,+a2,-a3,..."));
  91
  92   cl::opt<std::string>
  93   EntryFunc("entry-function",
  94             cl::desc("Specify the entry function (default = 'main') "
  95                      "of the executable"),
  96             cl::value_desc("function"),
  97             cl::init("main"));
  98
  99   cl::opt<std::string>
 100   FakeArgv0("fake-argv0",
 101             cl::desc("Override the 'argv[0]' value passed into the executing"
 102                      " program"), cl::value_desc("executable"));
 103
 104   cl::opt<bool>
 105   DisableCoreFiles("disable-core-files", cl::Hidden,
 106                    cl::desc("Disable emission of core files if possible"));
 107
 108   cl::opt<bool>
 109   NoLazyCompilation("disable-lazy-compilation",
 110                   cl::desc("Disable JIT lazy compilation"),
 111                   cl::init(false));
 112
 113   cl::opt<Reloc::Model>
 114   RelocModel("relocation-model",
 115              cl::desc("Choose relocation model"),
 116              cl::init(Reloc::Default),
 117              cl::values(
 118             clEnumValN(Reloc::Default, "default",
 119                        "Target default relocation model"),
 120             clEnumValN(Reloc::Static, "static",
 121                        "Non-relocatable code"),
 122             clEnumValN(Reloc::PIC_, "pic",
 123                        "Fully relocatable, position independent code"),
 124             clEnumValN(Reloc::DynamicNoPIC, "dynamic-no-pic",
 125                        "Relocatable external references, non-relocatable code"),
 126             clEnumValEnd));
 127
 128   cl::opt<llvm::CodeModel::Model>
 129   CMModel("code-model",
 130           cl::desc("Choose code model"),
 131           cl::init(CodeModel::JITDefault),
 132           cl::values(clEnumValN(CodeModel::JITDefault, "default",
 133                                 "Target default JIT code model"),
 134                      clEnumValN(CodeModel::Small, "small",
 135                                 "Small code model"),
 136                      clEnumValN(CodeModel::Kernel, "kernel",
 137                                 "Kernel code model"),
 138                      clEnumValN(CodeModel::Medium, "medium",
 139                                 "Medium code model"),
 140                      clEnumValN(CodeModel::Large, "large",
 141                                 "Large code model"),
 142                      clEnumValEnd));
 143
 144 }
 145
 146 static ExecutionEngine *EE = 0;
 147
 148 static void do_shutdown() {
 149   // Cygwin-1.5 invokes DLL's dtors before atexit handler.
 150 #ifndef DO_NOTHING_ATEXIT
 151   delete EE;
 152   llvm_shutdown();
 153 #endif
 154 }
 155
 156 //===----------------------------------------------------------------------===//
 157 // main Driver function
 158 //
 159 int main(int argc, char **argv, char * const *envp) {
 160   sys::PrintStackTraceOnErrorSignal();
 161   PrettyStackTraceProgram X(argc, argv);
 162
 163   LLVMContext &Context = getGlobalContext();
 164   atexit(do_shutdown);  // Call llvm_shutdown() on exit.
 165
 166   // If we have a native target, initialize it to ensure it is linked in and
 167   // usable by the JIT.
 168   InitializeNativeTarget();
 169   InitializeNativeTargetAsmPrinter();
 170
 171   cl::ParseCommandLineOptions(argc, argv,
 172                               "llvm interpreter & dynamic compiler\n");
 173
 174   // If the user doesn't want core files, disable them.
 175   if (DisableCoreFiles)
 176     sys::Process::PreventCoreFiles();
 177
 178   // Load the bitcode...
 179   SMDiagnostic Err;
 180   Module *Mod = ParseIRFile(InputFile, Err, Context);
 181   if (!Mod) {
 182     Err.print(argv[0], errs());
 183     return 1;
 184   }
 185
 186   // If not jitting lazily, load the whole bitcode file eagerly too.
 187   std::string ErrorMsg;
 188   if (NoLazyCompilation) {
 189     if (Mod->MaterializeAllPermanently(&ErrorMsg)) {
 190       errs() << argv[0] << ": bitcode didn't read correctly.\n";
 191       errs() << "Reason: " << ErrorMsg << "\n";
 192       exit(1);
 193     }
 194   }
 195
 196   JITMemoryManager *JMM = JITMemoryManager::CreateDefaultMemManager();
 197
 198   EngineBuilder builder(Mod);
 199   builder.setMArch(MArch);
 200   builder.setMCPU(MCPU);
 201   builder.setMAttrs(MAttrs);
 202   builder.setRelocationModel(RelocModel);
 203   builder.setCodeModel(CMModel);
 204   builder.setErrorStr(&ErrorMsg);
 205   builder.setJITMemoryManager(JMM);
 206   builder.setEngineKind(ForceInterpreter
 207                         ? EngineKind::Interpreter
 208                         : EngineKind::JIT);
 209
 210   // If we are supposed to override the target triple, do so now.
 211   if (!TargetTriple.empty())
 212     Mod->setTargetTriple(Triple::normalize(TargetTriple));
 213
 214   // Enable MCJIT, if desired.
 215   if (UseMCJIT)
 216     builder.setUseMCJIT(true);
 217
 218   CodeGenOpt::Level OLvl = CodeGenOpt::Default;
 219   switch (OptLevel) {
 220   default:
 221     errs() << argv[0] << ": invalid optimization level.\n";
 222     return 1;
 223   case ' ': break;
 224   case '0': OLvl = CodeGenOpt::None; break;
 225   case '1': OLvl = CodeGenOpt::Less; break;
 226   case '2': OLvl = CodeGenOpt::Default; break;
 227   case '3': OLvl = CodeGenOpt::Aggressive; break;
 228   }
 229   builder.setOptLevel(OLvl);
 230
 231   EE = builder.create();
 232   if (!EE) {
 233     if (!ErrorMsg.empty())
 234       errs() << argv[0] << ": error creating EE: " << ErrorMsg << "\n";
 235     else
 236       errs() << argv[0] << ": unknown error creating EE!\n";
 237     exit(1);
 238   }
 239
 240   EE->RegisterJITEventListener(createOProfileJITEventListener());
 241
 242   EE->DisableLazyCompilation(NoLazyCompilation);
 243
 244   // If the user specifically requested an argv[0] to pass into the program,
 245   // do it now.
 246   if (!FakeArgv0.empty()) {
 247     InputFile = FakeArgv0;
 248   } else {
 249     // Otherwise, if there is a .bc suffix on the executable strip it off, it
 250     // might confuse the program.
 251     if (StringRef(InputFile).endswith(".bc"))
 252       InputFile.erase(InputFile.length() - 3);
 253   }
 254
 255   // Add the module's name to the start of the vector of arguments to main().
 256   InputArgv.insert(InputArgv.begin(), InputFile);
 257
 258   // Call the main function from M as if its signature were:
 259   //   int main (int argc, char **argv, const char **envp)
 260   // using the contents of Args to determine argc & argv, and the contents of
 261   // EnvVars to determine envp.
 262   //
 263   Function *EntryFn = Mod->getFunction(EntryFunc);
 264   if (!EntryFn) {
 265     errs() << '\'' << EntryFunc << "\' function not found in module.\n";
 266     return -1;
 267   }
 268
 269   // If the program doesn't explicitly call exit, we will need the Exit
 270   // function later on to make an explicit call, so get the function now.
 271   Constant *Exit = Mod->getOrInsertFunction("exit", Type::getVoidTy(Context),
 272                                                     Type::getInt32Ty(Context),
 273                                                     NULL);
 274
 275   // Reset errno to zero on entry to main.
 276   errno = 0;
 277
 278   // Run static constructors.
 279   EE->runStaticConstructorsDestructors(false);
 280
 281   if (NoLazyCompilation) {
 282     for (Module::iterator I = Mod->begin(), E = Mod->end(); I != E; ++I) {
 283       Function *Fn = &*I;
 284       if (Fn != EntryFn && !Fn->isDeclaration())
 285         EE->getPointerToFunction(Fn);
 286     }
 287   }
 288
 289   // Run main.
 290   int Result = EE->runFunctionAsMain(EntryFn, InputArgv, envp);
 291
 292   // Run static destructors.
 293   EE->runStaticConstructorsDestructors(true);
 294
 295   // If the program didn't call exit explicitly, we should call it now.
 296   // This ensures that any atexit handlers get called correctly.
 297   if (Function *ExitF = dyn_cast<Function>(Exit)) {
 298     std::vector<GenericValue> Args;
 299     GenericValue ResultGV;
 300     ResultGV.IntVal = APInt(32, Result);
 301     Args.push_back(ResultGV);
 302     EE->runFunction(ExitF, Args);
 303     errs() << "ERROR: exit(" << Result << ") returned!\n";
 304     abort();
 305   } else {
 306     errs() << "ERROR: exit defined with wrong prototype!\n";
 307     abort();
 308   }
 309 }