Fix typo: intepreter->interpreter.
[oota-llvm.git] / tools / lli / lli.cpp
index ebe618a90eba2f898e1e717eb7813ea37b503f75..a01b0d69341ad6414fb21ec8aff837c8f2d6db7e 100644 (file)
 //===- lli.cpp - LLVM Interpreter / Dynamic compiler ----------------------===//
 //
-// This utility provides a way to execute LLVM bytecode without static
-// compilation.  This consists of a very simple and slow (but portable)
-// interpreter, along with capability for system specific dynamic compilers.  At
-// runtime, the fastest (stable) execution engine is selected to run the
-// program.  This means the JIT compiler for the current platform if it's
-// available.
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+// This utility provides a simple wrapper around the LLVM Execution Engines,
+// which allow the direct execution of LLVM programs through a Just-In-Time
+// compiler, or through an interpreter if no JIT is available for this platform.
 //
 //===----------------------------------------------------------------------===//
 
-#include "Support/CommandLine.h"
-#include "Support/Debug.h"
-#include "llvm/ExecutionEngine/ExecutionEngine.h"
-#include "llvm/ExecutionEngine/GenericValue.h"
-#include "llvm/Bytecode/Reader.h"
+#include "llvm/LLVMContext.h"
 #include "llvm/Module.h"
-#include "llvm/Target/TargetMachineImpls.h"
-#include "llvm/DerivedTypes.h"
-#include "llvm/Target/TargetData.h"
+#include "llvm/ModuleProvider.h"
+#include "llvm/Type.h"
+#include "llvm/Bitcode/ReaderWriter.h"
+#include "llvm/CodeGen/LinkAllCodegenComponents.h"
+#include "llvm/ExecutionEngine/GenericValue.h"
+#include "llvm/ExecutionEngine/Interpreter.h"
+#include "llvm/ExecutionEngine/JIT.h"
+#include "llvm/ExecutionEngine/JITEventListener.h"
+#include "llvm/Support/CommandLine.h"
+#include "llvm/Support/ManagedStatic.h"
+#include "llvm/Support/MemoryBuffer.h"
+#include "llvm/Support/PluginLoader.h"
+#include "llvm/Support/PrettyStackTrace.h"
+#include "llvm/System/Process.h"
+#include "llvm/System/Signals.h"
+#include "llvm/Target/TargetSelect.h"
+#include <iostream>
+#include <cerrno>
+using namespace llvm;
 
 namespace {
   cl::opt<std::string>
-  InputFile(cl::desc("<input bytecode>"), cl::Positional, cl::init("-"));
+  InputFile(cl::desc("<input bitcode>"), cl::Positional, cl::init("-"));
 
   cl::list<std::string>
   InputArgv(cl::ConsumeAfter, cl::desc("<program arguments>..."));
 
-  cl::opt<std::string>
-  MainFunction ("f", cl::desc("Function to execute"), cl::init("main"),
-               cl::value_desc("function name"));
-
-  cl::opt<bool> TraceMode("trace", cl::desc("Enable Tracing"));
-
   cl::opt<bool> ForceInterpreter("force-interpreter",
-                                cl::desc("Force interpretation: disable JIT"),
-                                cl::init(false));
-}
+                                 cl::desc("Force interpretation: disable JIT"),
+                                 cl::init(false));
+
+  // Determine optimization level.
+  cl::opt<char>
+  OptLevel("O",
+           cl::desc("Optimization level. [-O0, -O1, -O2, or -O3] "
+                    "(default = '-O2')"),
+           cl::Prefix,
+           cl::ZeroOrMore,
+           cl::init(' '));
 
-static std::vector<std::string> makeStringVector (const char **envp) {
-  std::vector<std::string> rv;
-  for (unsigned i = 0; envp[i]; ++i)
-    rv.push_back (envp[i]);
-  return rv;
-}
+  cl::opt<std::string>
+  TargetTriple("mtriple", cl::desc("Override target triple for module"));
 
-static void *CreateArgv(ExecutionEngine *EE,
-                       const std::vector<std::string> &InputArgv) {
-  if (EE->getTargetData().getPointerSize() == 8) {   // 64 bit target?
-    PointerTy *Result = new PointerTy[InputArgv.size()+1];
-    DEBUG(std::cerr << "ARGV = " << (void*)Result << "\n");
-
-    for (unsigned i = 0; i < InputArgv.size(); ++i) {
-      unsigned Size = InputArgv[i].size()+1;
-      char *Dest = new char[Size];
-      DEBUG(std::cerr << "ARGV[" << i << "] = " << (void*)Dest << "\n");
-      
-      std::copy(InputArgv[i].begin(), InputArgv[i].end(), Dest);
-      Dest[Size-1] = 0;
-      
-      // Endian safe: Result[i] = (PointerTy)Dest;
-      EE->StoreValueToMemory(PTOGV(Dest), (GenericValue*)(Result+i),
-                            Type::LongTy);
-    }
-    Result[InputArgv.size()] = 0;
-    return Result;
-  } else {                                      // 32 bit target?
-    int *Result = new int[InputArgv.size()+1];
-    DEBUG(std::cerr << "ARGV = " << (void*)Result << "\n");
-
-    for (unsigned i = 0; i < InputArgv.size(); ++i) {
-      unsigned Size = InputArgv[i].size()+1;
-      char *Dest = new char[Size];
-      DEBUG(std::cerr << "ARGV[" << i << "] = " << (void*)Dest << "\n");
-      
-      std::copy(InputArgv[i].begin(), InputArgv[i].end(), Dest);
-      Dest[Size-1] = 0;
-      
-      // Endian safe: Result[i] = (PointerTy)Dest;
-      EE->StoreValueToMemory(PTOGV(Dest), (GenericValue*)(Result+i),
-                            Type::IntTy);
-    }
-    Result[InputArgv.size()] = 0;  // null terminate it
-    return Result;
-  }
+  cl::opt<std::string>
+  EntryFunc("entry-function",
+            cl::desc("Specify the entry function (default = 'main') "
+                     "of the executable"),
+            cl::value_desc("function"),
+            cl::init("main"));
+  
+  cl::opt<std::string>
+  FakeArgv0("fake-argv0",
+            cl::desc("Override the 'argv[0]' value passed into the executing"
+                     " program"), cl::value_desc("executable"));
+  
+  cl::opt<bool>
+  DisableCoreFiles("disable-core-files", cl::Hidden,
+                   cl::desc("Disable emission of core files if possible"));
+
+  cl::opt<bool>
+  NoLazyCompilation("disable-lazy-compilation",
+                  cl::desc("Disable JIT lazy compilation"),
+                  cl::init(false));
 }
 
-/// callAsMain - Call the function named FnName from M as if its
-/// signature were int main (int argc, char **argv, const char
-/// **envp), using the contents of Args to determine argc & argv, and
-/// the contents of EnvVars to determine envp.  Returns the result
-/// from calling FnName, or -1 and prints an error msg. if the named
-/// function cannot be found.
-///
-int callAsMain (ExecutionEngine *EE, Module *M, const std::string &FnName,
-                const std::vector<std::string> &Args,
-                const std::vector<std::string> &EnvVars) {
-  Function *Fn = M->getNamedFunction (FnName);
-  if (!Fn) {
-    std::cerr << "Function '" << FnName << "' not found in module.\n";
-    return -1;
-  }
-  std::vector<GenericValue> GVArgs;
-  GenericValue GVArgc;
-  GVArgc.IntVal = Args.size ();
-  GVArgs.push_back (GVArgc); // Arg #0 = argc.
-  GVArgs.push_back (PTOGV (CreateArgv (EE, Args))); // Arg #1 = argv.
-  GVArgs.push_back (PTOGV (CreateArgv (EE, EnvVars))); // Arg #2 = envp.
-  return EE->run (Fn, GVArgs).IntVal;
+static ExecutionEngine *EE = 0;
+
+static void do_shutdown() {
+  delete EE;
+  llvm_shutdown();
 }
 
 //===----------------------------------------------------------------------===//
 // main Driver function
 //
-int main(int argc, char **argv, const char **envp) {
+int main(int argc, char **argv, char * const *envp) {
+  sys::PrintStackTraceOnErrorSignal();
+  PrettyStackTraceProgram X(argc, argv);
+  
+  LLVMContext Context;
+  atexit(do_shutdown);  // Call llvm_shutdown() on exit.
   cl::ParseCommandLineOptions(argc, argv,
-                             llvm interpreter & dynamic compiler\n");
+                              "llvm interpreter & dynamic compiler\n");
 
-  // Load the bytecode...
+  // If the user doesn't want core files, disable them.
+  if (DisableCoreFiles)
+    sys::Process::PreventCoreFiles();
+  
+  // Load the bitcode...
   std::string ErrorMsg;
-  Module *M = ParseBytecodeFile(InputFile, &ErrorMsg);
-  if (M == 0) {
-    std::cout << "Error parsing '" << InputFile << "': "
+  ModuleProvider *MP = NULL;
+  if (MemoryBuffer *Buffer = MemoryBuffer::getFileOrSTDIN(InputFile,&ErrorMsg)){
+    MP = getBitcodeModuleProvider(Buffer, Context, &ErrorMsg);
+    if (!MP) delete Buffer;
+  }
+  
+  if (!MP) {
+    std::cerr << argv[0] << ": error loading program '" << InputFile << "': "
               << ErrorMsg << "\n";
     exit(1);
   }
 
-  ExecutionEngine *EE =
-    ExecutionEngine::create (M, ForceInterpreter, TraceMode);
-  assert (EE && "Couldn't create an ExecutionEngine, not even an interpreter?");
+  // Get the module as the MP could go away once EE takes over.
+  Module *Mod = NoLazyCompilation
+    ? MP->materializeModule(&ErrorMsg) : MP->getModule();
+  if (!Mod) {
+    std::cerr << argv[0] << ": bitcode didn't read correctly.\n";
+    std::cerr << "Reason: " << ErrorMsg << "\n";
+    exit(1);
+  }
 
-  // Add the module's name to the start of the vector of arguments to main().
-  // But delete .bc first, since programs (and users) might not expect to
-  // see it.
-  const std::string ByteCodeFileSuffix (".bc");
-  if (InputFile.rfind (ByteCodeFileSuffix) ==
-      InputFile.length () - ByteCodeFileSuffix.length ()) {
-    InputFile.erase (InputFile.length () - ByteCodeFileSuffix.length ());
+  // If we are supposed to override the target triple, do so now.
+  if (!TargetTriple.empty())
+    Mod->setTargetTriple(TargetTriple);
+
+  CodeGenOpt::Level OLvl = CodeGenOpt::Default;
+  switch (OptLevel) {
+  default:
+    std::cerr << argv[0] << ": invalid optimization level.\n";
+    return 1;
+  case ' ': break;
+  case '0': OLvl = CodeGenOpt::None; break;
+  case '1':
+  case '2': OLvl = CodeGenOpt::Default; break;
+  case '3': OLvl = CodeGenOpt::Aggressive; break;
+  }
+  
+  // If we have a native target, initialize it to ensure it is linked in and
+  // usable by the JIT.
+  InitializeNativeTarget();
+
+  EE = ExecutionEngine::create(MP, ForceInterpreter, &ErrorMsg, OLvl);
+  if (!EE && !ErrorMsg.empty()) {
+    std::cerr << argv[0] << ":error creating EE: " << ErrorMsg << "\n";
+    exit(1);
+  }
+
+  EE->RegisterJITEventListener(createMacOSJITEventListener());
+
+  if (NoLazyCompilation)
+    EE->DisableLazyCompilation();
+
+  // If the user specifically requested an argv[0] to pass into the program,
+  // do it now.
+  if (!FakeArgv0.empty()) {
+    InputFile = FakeArgv0;
+  } else {
+    // Otherwise, if there is a .bc suffix on the executable strip it off, it
+    // might confuse the program.
+    if (InputFile.rfind(".bc") == InputFile.length() - 3)
+      InputFile.erase(InputFile.length() - 3);
   }
+
+  // Add the module's name to the start of the vector of arguments to main().
   InputArgv.insert(InputArgv.begin(), InputFile);
 
-  // Run the main function!
-  int ExitCode = callAsMain (EE, M, MainFunction, InputArgv,
-                            makeStringVector (envp)); 
+  // Call the main function from M as if its signature were:
+  //   int main (int argc, char **argv, const char **envp)
+  // using the contents of Args to determine argc & argv, and the contents of
+  // EnvVars to determine envp.
+  //
+  Function *EntryFn = Mod->getFunction(EntryFunc);
+  if (!EntryFn) {
+    std::cerr << '\'' << EntryFunc << "\' function not found in module.\n";
+    return -1;
+  }
+
+  // If the program doesn't explicitly call exit, we will need the Exit 
+  // function later on to make an explicit call, so get the function now. 
+  Constant *Exit = Mod->getOrInsertFunction("exit", Type::VoidTy,
+                                                        Type::Int32Ty, NULL);
+  
+  // Reset errno to zero on entry to main.
+  errno = 0;
+  // Run static constructors.
+  EE->runStaticConstructorsDestructors(false);
+
+  if (NoLazyCompilation) {
+    for (Module::iterator I = Mod->begin(), E = Mod->end(); I != E; ++I) {
+      Function *Fn = &*I;
+      if (Fn != EntryFn && !Fn->isDeclaration())
+        EE->getPointerToFunction(Fn);
+    }
+  }
 
-  // Now that we are done executing the program, shut down the execution engine
-  delete EE;
-  return ExitCode;
+  // Run main.
+  int Result = EE->runFunctionAsMain(EntryFn, InputArgv, envp);
+
+  // Run static destructors.
+  EE->runStaticConstructorsDestructors(true);
+  
+  // If the program didn't call exit explicitly, we should call it now. 
+  // This ensures that any atexit handlers get called correctly.
+  if (Function *ExitF = dyn_cast<Function>(Exit)) {
+    std::vector<GenericValue> Args;
+    GenericValue ResultGV;
+    ResultGV.IntVal = APInt(32, Result);
+    Args.push_back(ResultGV);
+    EE->runFunction(ExitF, Args);
+    std::cerr << "ERROR: exit(" << Result << ") returned!\n";
+    abort();
+  } else {
+    std::cerr << "ERROR: exit defined with wrong prototype!\n";
+    abort();
+  }
 }