Make ToolExecutionError inherit std::exception and implement its
[oota-llvm.git] / tools / llc / llc.cpp
index ff492aa59116835a86543e6870e5ac8ec9f58748..959bdbe36cbec178841434e50e51f5070177db30 100644 (file)
@@ -1,43 +1,63 @@
-//===-- llc.cpp - Implement the LLVM Compiler -----------------------------===//
+//===-- llc.cpp - Implement the LLVM Native Code Generator ----------------===//
+// 
+//                     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 is the llc compiler driver.
+// This is the llc code generator.
 //
 //===----------------------------------------------------------------------===//
 
 #include "llvm/Bytecode/Reader.h"
-#include "llvm/Target/Sparc.h"
+#include "llvm/Target/TargetMachineImpls.h"
 #include "llvm/Target/TargetMachine.h"
-#include "llvm/Transforms/Instrumentation/TraceValues.h"
-#include "llvm/Transforms/LowerAllocations.h"
-#include "llvm/Transforms/HoistPHIConstants.h"
-#include "llvm/Assembly/PrintModulePass.h"
-#include "llvm/Bytecode/WriteBytecodePass.h"
-#include "llvm/Transforms/ConstantMerge.h"
-#include "llvm/Support/CommandLine.h"
+#include "llvm/Transforms/Scalar.h"
 #include "llvm/Module.h"
-#include "llvm/Method.h"
+#include "llvm/PassManager.h"
+#include "llvm/Pass.h"
+#include "Support/CommandLine.h"
+#include "Support/Signals.h"
 #include <memory>
-#include <string>
 #include <fstream>
 
-cl::String InputFilename ("", "Input filename", cl::NoFlags, "-");
-cl::String OutputFilename("o", "Output filename", cl::NoFlags, "");
-cl::Flag   Force         ("f", "Overwrite output files");
-cl::Flag   DumpAsm       ("d", "Print bytecode before native code generation",
-                          cl::Hidden);
-cl::Flag   DoNotEmitAssembly("noasm", "Do not emit assembly code", cl::Hidden);
-cl::Flag   TraceBBValues ("trace",
-                          "Trace values at basic block and method exits");
-cl::Flag   TraceMethodValues("tracem", "Trace values only at method exits");
+using namespace llvm;
+
+// General options for llc.  Other pass-specific options are specified
+// within the corresponding llc passes, and target-specific options
+// and back-end code generation options are specified with the target machine.
+// 
+static cl::opt<std::string>
+InputFilename(cl::Positional, cl::desc("<input bytecode>"), cl::init("-"));
+
+static cl::opt<std::string>
+OutputFilename("o", cl::desc("Output filename"), cl::value_desc("filename"));
 
+static cl::opt<bool> Force("f", cl::desc("Overwrite output files"));
+
+enum ArchName { noarch, X86, Sparc, PowerPC, CBackend };
+
+static cl::opt<ArchName>
+Arch("march", cl::desc("Architecture to generate assembly for:"), cl::Prefix,
+     cl::values(clEnumValN(X86,      "x86",     "  IA-32 (Pentium and above)"),
+                clEnumValN(Sparc,    "sparc",   "  SPARC V9"),
+                clEnumValN(PowerPC,  "powerpc", "  PowerPC"),
+                clEnumValN(CBackend, "c",       "  C backend"),
+               0),
+     cl::init(noarch));
 
 // GetFileNameRoot - Helper function to get the basename of a filename...
-static inline string GetFileNameRoot(const string &InputFilename) {
-  string IFN = InputFilename;
-  string outputFilename;
+static inline std::string
+GetFileNameRoot(const std::string &InputFilename)
+{
+  std::string IFN = InputFilename;
+  std::string outputFilename;
   int Len = IFN.length();
-  if (IFN[Len-3] == '.' && IFN[Len-2] == 'b' && IFN[Len-1] == 'c') {
-    outputFilename = string(IFN.begin(), IFN.end()-3); // s/.bc/.s/
+  if ((Len > 2) &&
+      IFN[Len-3] == '.' && IFN[Len-2] == 'b' && IFN[Len-1] == 'c') {
+    outputFilename = std::string(IFN.begin(), IFN.end()-3); // s/.bc/.s/
   } else {
     outputFilename = IFN;
   }
@@ -45,153 +65,147 @@ static inline string GetFileNameRoot(const string &InputFilename) {
 }
 
 
-//===---------------------------------------------------------------------===//
-// GenerateCodeForTarget Pass
-// 
-// Native code generation for a specified target.
-//===---------------------------------------------------------------------===//
-
-class GenerateCodeForTarget : public Pass {
-  TargetMachine &Target;
-public:
-  inline GenerateCodeForTarget(TargetMachine &T) : Target(T) {}
-
-  // doPerMethodWork - This method does the actual work of generating code for
-  // the specified method.
-  //
-  bool doPerMethodWork(Method *M) {
-    if (!M->isExternal() && Target.compileMethod(M)) {
-      cerr << "Error compiling " << InputFilename << "!\n";
-      return true;
-    }
-    
-    return false;
-  }
-};
-
-
-//===---------------------------------------------------------------------===//
-// EmitAssembly Pass
-// 
-// Write assembly code to specified output stream
-//===---------------------------------------------------------------------===//
-
-class EmitAssembly : public Pass {
-  const TargetMachine &Target;   // Target to compile for
-  ostream *Out;                  // Stream to print on
-  bool DeleteStream;             // Delete stream in dtor?
-public:
-  inline EmitAssembly(const TargetMachine &T, ostream *O, bool D)
-    : Target(T), Out(O), DeleteStream(D) {}
-
-
-  virtual bool doPassFinalization(Module *M) {
-    Target.emitAssembly(M, *Out);
-
-    if (DeleteStream) delete Out;
-    return false;
-  }
-};
-
-
-//===---------------------------------------------------------------------===//
-// Function main()
-// 
-// Entry point for the llc compiler.
-//===---------------------------------------------------------------------===//
-
+// main - Entry point for the llc compiler.
+//
 int main(int argc, char **argv) {
-  int retCode = 0;
   cl::ParseCommandLineOptions(argc, argv, " llvm system compiler\n");
   
-  // Allocate a target... in the future this will be controllable on the
-  // command line.
-  auto_ptr<TargetMachine> target(allocateSparcTargetMachine());
-  assert(target.get() && "Could not allocate target machine!");
-
-  TargetMachine &Target = *target.get();
-  
   // Load the module to be compiled...
-  auto_ptr<Module> M(ParseBytecodeFile(InputFilename));
+  std::auto_ptr<Module> M(ParseBytecodeFile(InputFilename));
   if (M.get() == 0) {
-    cerr << "bytecode didn't read correctly.\n";
+    std::cerr << argv[0] << ": bytecode didn't read correctly.\n";
     return 1;
   }
+  Module &mod = *M.get();
+
+  // Allocate target machine.  First, check whether the user has
+  // explicitly specified an architecture to compile for.
+  TargetMachine* (*TargetMachineAllocator)(const Module&,
+                                           IntrinsicLowering *) = 0;
+  switch (Arch) {
+  case CBackend:
+    TargetMachineAllocator = allocateCTargetMachine;
+    break;
+  case X86:
+    TargetMachineAllocator = allocateX86TargetMachine;
+    break;
+  case Sparc:
+    TargetMachineAllocator = allocateSparcTargetMachine;
+    break;
+  case PowerPC:
+    TargetMachineAllocator = allocatePowerPCTargetMachine;
+    break;
+  default:
+    // Decide what the default target machine should be, by looking at
+    // the module. This heuristic (ILP32, LE -> IA32; LP64, BE ->
+    // SPARCV9) is kind of gross, but it will work until we have more
+    // sophisticated target information to work from.
+    if (mod.getEndianness()  == Module::LittleEndian &&
+        mod.getPointerSize() == Module::Pointer32) { 
+      TargetMachineAllocator = allocateX86TargetMachine;
+    } else if (mod.getEndianness() == Module::BigEndian &&
+        mod.getPointerSize() == Module::Pointer32) { 
+      TargetMachineAllocator = allocatePowerPCTargetMachine;
+    } else if (mod.getEndianness()  == Module::BigEndian &&
+               mod.getPointerSize() == Module::Pointer64) { 
+      TargetMachineAllocator = allocateSparcTargetMachine;
+    } else {
+      // If the module is target independent, favor a target which matches the
+      // current build system.
+#if defined(i386) || defined(__i386__) || defined(__x86__)
+      TargetMachineAllocator = allocateX86TargetMachine;
+#elif defined(sparc) || defined(__sparc__) || defined(__sparcv9)
+      TargetMachineAllocator = allocateSparcTargetMachine;
+#elif defined(__POWERPC__) || defined(__ppc__) || defined(__APPLE__)
+      TargetMachineAllocator = allocatePowerPCTargetMachine;
+#else
+      std::cerr << argv[0] << ": module does not specify a target to use.  "
+                << "You must use the -march option.  If no native target is "
+                << "available, use -march=c to emit C code.\n";
+      return 1;
+#endif
+    } 
+    break;
+  }
+  std::auto_ptr<TargetMachine> target(TargetMachineAllocator(mod, 0));
+  assert(target.get() && "Could not allocate target machine!");
+  TargetMachine &Target = *target.get();
+  const TargetData &TD = Target.getTargetData();
 
   // Build up all of the passes that we want to do to the module...
-  vector<Pass*> Passes;
-
-  // Hoist constants out of PHI nodes into predecessor BB's
-  Passes.push_back(new HoistPHIConstants());
-
-  if (TraceBBValues || TraceMethodValues) {   // If tracing enabled...
-    // Insert trace code in all methods in the module
-    Passes.push_back(new InsertTraceCode(TraceBBValues, 
-                                         TraceBBValues ||TraceMethodValues));
+  PassManager Passes;
+
+  Passes.add(new TargetData("llc", TD.isLittleEndian(), TD.getPointerSize(),
+                            TD.getPointerAlignment(), TD.getDoubleAlignment()));
+
+  // Figure out where we are going to send the output...
+  std::ostream *Out = 0;
+  if (OutputFilename != "") {
+    if (OutputFilename != "-") {
+      // Specified an output filename?
+      if (!Force && std::ifstream(OutputFilename.c_str())) {
+       // If force is not specified, make sure not to overwrite a file!
+       std::cerr << argv[0] << ": error opening '" << OutputFilename
+                 << "': file exists!\n"
+                 << "Use -f command line argument to force output\n";
+       return 1;
+      }
+      Out = new std::ofstream(OutputFilename.c_str());
 
-    // Eliminate duplication in constant pool
-    Passes.push_back(new DynamicConstantMerge());
-      
-    // Then write out the module with tracing code before code generation 
-    assert(InputFilename != "-" &&
-           "files on stdin not supported with tracing");
-    string traceFileName = GetFileNameRoot(InputFilename) + ".trace.bc";
-    ostream *os = new ofstream(traceFileName.c_str(), 
-                               (Force ? 0 : ios::noreplace)|ios::out);
-    if (!os->good()) {
-      cerr << "Error opening " << traceFileName
-           << "! SKIPPING OUTPUT OF TRACE CODE\n";
-      delete os;
-      return 1;
+      // Make sure that the Out file gets unlinked from the disk if we get a
+      // SIGINT
+      RemoveFileOnSignal(OutputFilename);
+    } else {
+      Out = &std::cout;
     }
-    
-    Passes.push_back(new WriteBytecodePass(os, true));
-  }
-  
-  // Replace malloc and free instructions with library calls.
-  // Do this after tracing until lli implements these lib calls.
-  // For now, it will emulate malloc and free internally.
-  Passes.push_back(new LowerAllocations(Target.DataLayout));
-  
-  // If LLVM dumping after transformations is requested, add it to the pipeline
-  if (DumpAsm)
-    Passes.push_back(new PrintModulePass("Code after xformations: \n",&cerr));
-
-  // Generate Target code...
-  Passes.push_back(new GenerateCodeForTarget(Target));
-
-  if (!DoNotEmitAssembly) {                // If asm output is enabled...
-    // Figure out where we are going to send the output...
-    ostream *Out = 0;
-    if (OutputFilename != "") {   // Specified an output filename?
-      Out = new ofstream(OutputFilename.c_str(), 
-                         (Force ? 0 : ios::noreplace)|ios::out);
+  } else {
+    if (InputFilename == "-") {
+      OutputFilename = "-";
+      Out = &std::cout;
     } else {
-      if (InputFilename == "-") {
-        OutputFilename = "-";
-        Out = &cout;
-      } else {
-        string OutputFilename = GetFileNameRoot(InputFilename); 
+      OutputFilename = GetFileNameRoot(InputFilename); 
+
+      if (Arch != CBackend)
         OutputFilename += ".s";
-        Out = new ofstream(OutputFilename.c_str(), 
-                           (Force ? 0 : ios::noreplace)|ios::out);
-        if (!Out->good()) {
-          cerr << "Error opening " << OutputFilename << "!\n";
-          delete Out;
-          return 1;
-        }
+      else
+        OutputFilename += ".cbe.c";
+      
+      if (!Force && std::ifstream(OutputFilename.c_str())) {
+        // If force is not specified, make sure not to overwrite a file!
+        std::cerr << argv[0] << ": error opening '" << OutputFilename
+                  << "': file exists!\n"
+                  << "Use -f command line argument to force output\n";
+        return 1;
       }
+      
+      Out = new std::ofstream(OutputFilename.c_str());
+      if (!Out->good()) {
+        std::cerr << argv[0] << ": error opening " << OutputFilename << "!\n";
+        delete Out;
+        return 1;
+      }
+      
+      // Make sure that the Out file gets unlinked from the disk if we get a
+      // SIGINT
+      RemoveFileOnSignal(OutputFilename);
     }
-    
-    // Output assembly language to the .s file
-    Passes.push_back(new EmitAssembly(Target, Out, Out != &cout));
   }
-  
-  // Run our queue of passes all at once now, efficiently.  This form of
-  // runAllPasses frees the Pass objects after runAllPasses completes.
-  Pass::runAllPassesAndFree(M.get(), Passes);
 
-  return retCode;
-}
+  // Ask the target to add backend passes as necessary
+  if (Target.addPassesToEmitAssembly(Passes, *Out)) {
+    std::cerr << argv[0] << ": target '" << Target.getName()
+              << "' does not support static compilation!\n";
+    if (Out != &std::cout) delete Out;
+    // And the Out file is empty and useless, so remove it now.
+    std::remove(OutputFilename.c_str());
+    return 1;
+  } else {
+    // Run our queue of passes all at once now, efficiently.
+    Passes.run(*M.get());
+  }
 
+  // Delete the ostream if it's not a stdout stream
+  if (Out != &std::cout) delete Out;
 
+  return 0;
+}