add bitcode reading support, remove eh stuff
[oota-llvm.git] / tools / lli / lli.cpp
index 87fe461ce0d744a4fea39729595868f5102149ce..e3809538a57323e0ad3eda497586360c04260908 100644 (file)
 //===- lli.cpp - LLVM Interpreter / Dynamic compiler ----------------------===//
-// 
+//
 //                     The LLVM Compiler Infrastructure
 //
 // This file was developed by the LLVM research group and is distributed under
 // the University of Illinois Open Source License. See LICENSE.TXT for details.
-// 
+//
 //===----------------------------------------------------------------------===//
 //
-// 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.
+// 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 intepreter if no JIT is available for this platform.
 //
 //===----------------------------------------------------------------------===//
 
-#include "llvm/DerivedTypes.h"
 #include "llvm/Module.h"
 #include "llvm/ModuleProvider.h"
+#include "llvm/Type.h"
+#include "llvm/Bitcode/ReaderWriter.h"
 #include "llvm/Bytecode/Reader.h"
-#include "llvm/ExecutionEngine/ExecutionEngine.h"
+#include "llvm/CodeGen/LinkAllCodegenComponents.h"
+#include "llvm/ExecutionEngine/JIT.h"
+#include "llvm/ExecutionEngine/Interpreter.h"
 #include "llvm/ExecutionEngine/GenericValue.h"
-#include "llvm/Target/TargetMachineImpls.h"
-#include "llvm/Target/TargetData.h"
-#include "Support/CommandLine.h"
-#include "Support/Debug.h"
-#include "Support/SystemUtils.h"
+#include "llvm/Support/CommandLine.h"
+#include "llvm/Support/Compressor.h"
+#include "llvm/Support/ManagedStatic.h"
+#include "llvm/Support/MemoryBuffer.h"
+#include "llvm/Support/PluginLoader.h"
+#include "llvm/System/Process.h"
+#include "llvm/System/Signals.h"
+#include <iostream>
+#include <cerrno>
+using namespace llvm;
 
 namespace {
+  cl::opt<bool> Bitcode("bitcode");
+
   cl::opt<std::string>
   InputFile(cl::desc("<input bytecode>"), 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> ForceInterpreter("force-interpreter",
                                  cl::desc("Force interpretation: disable JIT"),
                                  cl::init(false));
-
+  cl::opt<std::string>
+  TargetTriple("mtriple", cl::desc("Override target triple for module"));
+  
   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"));
 }
 
-static std::vector<std::string> makeStringVector(char * const *envp) {
-  std::vector<std::string> rv;
-  for (unsigned i = 0; envp[i]; ++i)
-    rv.push_back(envp[i]);
-  return rv;
-}
+static ExecutionEngine *EE = 0;
 
-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;
-  }
-}
-
-/// 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, ModuleProvider *MP,
-               const std::string &FnName,
-               const std::vector<std::string> &Args,
-               const std::vector<std::string> &EnvVars) {
-  Function *Fn = MP->getModule()->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 void do_shutdown() {
+  delete EE;
+  llvm_shutdown();
 }
 
 //===----------------------------------------------------------------------===//
 // main Driver function
 //
 int main(int argc, char **argv, char * const *envp) {
+  atexit(do_shutdown);  // Call llvm_shutdown() on exit.
   cl::ParseCommandLineOptions(argc, argv,
                               " llvm interpreter & dynamic compiler\n");
+  sys::PrintStackTraceOnErrorSignal();
 
+  // If the user doesn't want core files, disable them.
+  if (DisableCoreFiles)
+    sys::Process::PreventCoreFiles();
+  
   // Load the bytecode...
   std::string ErrorMsg;
   ModuleProvider *MP = 0;
-  try {
-    MP = getBytecodeModuleProvider(InputFile);
-  } catch (std::string &err) {
-    std::cerr << "Error parsing '" << InputFile << "': " << err << "\n";
+  if (Bitcode) {
+    MemoryBuffer *Buffer = MemoryBuffer::getFileOrSTDIN(&InputFile[0],
+                                                        InputFile.size());
+    if (Buffer == 0)
+      ErrorMsg = "Error reading file '" + InputFile + "'";
+    else {
+      MP = getBitcodeModuleProvider(Buffer, &ErrorMsg);
+      if (!MP) delete Buffer;
+    }
+  } else {
+    MP = getBytecodeModuleProvider(InputFile, 
+                                   Compressor::decompressToNewBuffer,
+                                   &ErrorMsg);
+  }
+  
+  if (!MP) {
+    std::cerr << argv[0] << ": error loading program '" << InputFile << "': "
+              << ErrorMsg << "\n";
     exit(1);
   }
 
-  ExecutionEngine *EE =
-    ExecutionEngine::create(MP, ForceInterpreter);
-  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 = MP->getModule();
+
+  // If we are supposed to override the target triple, do so now.
+  if (!TargetTriple.empty())
+    Mod->setTargetTriple(TargetTriple);
+  
+  EE = ExecutionEngine::create(MP, ForceInterpreter, &ErrorMsg);
+  if (!EE && !ErrorMsg.empty()) {
+    std::cerr << argv[0] << ":error creating EE: " << ErrorMsg << "\n";
+    exit(1);
+  }
 
-  // If the user specifically requested an argv[0] to pass into the program, do
-  // it now.
+  // If the user specifically requested an argv[0] to pass into the program,
+  // do it now.
   if (!FakeArgv0.empty()) {
     InputFile = FakeArgv0;
   } else {
@@ -157,11 +129,46 @@ int main(int argc, char **argv, char * const *envp) {
   // 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, MP, 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 *Fn = Mod->getFunction("main");
+  if (!Fn) {
+    std::cerr << "'main' function not found in module.\n";
+    return -1;
+  }
 
-  // Now that we are done executing the program, shut down the execution engine
-  delete EE;
-  return ExitCode;
+  // 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);
+  
+  // Run main.
+  int Result = EE->runFunctionAsMain(Fn, 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();
+  }
 }