Move the space in overview output for commands out of each of the
[oota-llvm.git] / tools / llc / llc.cpp
index 49371afd54b4a348ab8503284fa40ab05d4347b5..7b55c8092cf125f20808827d1c9eb558de8b9bf0 100644 (file)
 //===-- llc.cpp - Implement the LLVM Native Code Generator ----------------===//
 //
-// This is the llc 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 code generator driver. It provides a convenient
+// command-line interface for generating native assembly-language code
+// or C code, given LLVM bitcode.
 //
 //===----------------------------------------------------------------------===//
 
-#include "llvm/Bytecode/Reader.h"
-#include "llvm/Target/TargetMachineImpls.h"
+#include "llvm/Bitcode/ReaderWriter.h"
+#include "llvm/CodeGen/FileWriters.h"
+#include "llvm/CodeGen/LinkAllCodegenComponents.h"
+#include "llvm/Target/SubtargetFeature.h"
+#include "llvm/Target/TargetData.h"
 #include "llvm/Target/TargetMachine.h"
+#include "llvm/Target/TargetMachineRegistry.h"
 #include "llvm/Transforms/Scalar.h"
 #include "llvm/Module.h"
+#include "llvm/ModuleProvider.h"
 #include "llvm/PassManager.h"
 #include "llvm/Pass.h"
-#include "Support/CommandLine.h"
-#include "Support/Signals.h"
-#include <memory>
+#include "llvm/Support/CommandLine.h"
+#include "llvm/Support/ManagedStatic.h"
+#include "llvm/Support/MemoryBuffer.h"
+#include "llvm/Support/PluginLoader.h"
+#include "llvm/Support/FileUtilities.h"
+#include "llvm/Analysis/Verifier.h"
+#include "llvm/System/Signals.h"
+#include "llvm/Config/config.h"
+#include "llvm/LinkAllVMCore.h"
 #include <fstream>
+#include <iostream>
+#include <memory>
+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("-"));
+InputFilename(cl::Positional, cl::desc("<input bitcode>"), 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 };
+static cl::opt<bool> Fast("fast", 
+      cl::desc("Generate code quickly, potentially sacrificing code quality"));
+
+static cl::opt<std::string>
+TargetTriple("mtriple", cl::desc("Override target triple for module"));
+
+static cl::opt<const TargetMachineRegistry::Entry*, false, TargetNameParser>
+MArch("march", cl::desc("Architecture to generate code for:"));
+
+static cl::opt<std::string>
+MCPU("mcpu", 
+  cl::desc("Target a specific cpu type (-mcpu=help for details)"),
+  cl::value_desc("cpu-name"),
+  cl::init(""));
 
-static cl::opt<ArchName>
-Arch("march", cl::desc("Architecture to generate assembly for:"), cl::Prefix,
-     cl::values(clEnumVal(x86, "  IA-32 (Pentium and above)"),
-               clEnumValN(Sparc, "sparc", "  SPARC V9"),
-               0),
-     cl::init(noarch));
+static cl::list<std::string>
+MAttrs("mattr", 
+  cl::CommaSeparated,
+  cl::desc("Target specific attributes (-mattr=help for details)"),
+  cl::value_desc("a1,+a2,-a3,..."));
 
-// GetFileNameRoot - Helper function to get the basename of a filename...
+cl::opt<TargetMachine::CodeGenFileType>
+FileType("filetype", cl::init(TargetMachine::AssemblyFile),
+  cl::desc("Choose a file type (not all types are supported by all targets):"),
+  cl::values(
+       clEnumValN(TargetMachine::AssemblyFile,    "asm",
+                  "  Emit an assembly ('.s') file"),
+       clEnumValN(TargetMachine::ObjectFile,    "obj",
+                  "  Emit a native object ('.o') file [experimental]"),
+       clEnumValN(TargetMachine::DynamicLibrary, "dynlib",
+                  "  Emit a native dynamic library ('.so') file"
+                  " [experimental]"),
+       clEnumValEnd));
+
+cl::opt<bool> NoVerify("disable-verify", cl::Hidden,
+                       cl::desc("Do not verify input module"));
+
+
+// GetFileNameRoot - Helper function to get the basename of a filename.
 static inline std::string
-GetFileNameRoot(const std::string &InputFilename)
-{
+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') {
+  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;
@@ -52,119 +104,199 @@ GetFileNameRoot(const std::string &InputFilename)
   return outputFilename;
 }
 
+static std::ostream *GetOutputStream(const char *ProgName) {
+  if (OutputFilename != "") {
+    if (OutputFilename == "-")
+      return &std::cout;
+
+    // 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 << ProgName << ": error opening '" << OutputFilename
+                << "': file exists!\n"
+                << "Use -f command line argument to force output\n";
+      return 0;
+    }
+    // Make sure that the Out file gets unlinked from the disk if we get a
+    // SIGINT
+    sys::RemoveFileOnSignal(sys::Path(OutputFilename));
+
+    return new std::ofstream(OutputFilename.c_str());
+  }
+  
+  if (InputFilename == "-") {
+    OutputFilename = "-";
+    return &std::cout;
+  }
+
+  OutputFilename = GetFileNameRoot(InputFilename);
+    
+  switch (FileType) {
+  case TargetMachine::AssemblyFile:
+    if (MArch->Name[0] != 'c' || MArch->Name[1] != 0)  // not CBE
+      OutputFilename += ".s";
+    else
+      OutputFilename += ".cbe.c";
+    break;
+  case TargetMachine::ObjectFile:
+    OutputFilename += ".o";
+    break;
+  case TargetMachine::DynamicLibrary:
+    OutputFilename += LTDL_SHLIB_EXT;
+    break;
+  }
+  
+  if (!Force && std::ifstream(OutputFilename.c_str())) {
+    // If force is not specified, make sure not to overwrite a file!
+    std::cerr << ProgName << ": error opening '" << OutputFilename
+                          << "': file exists!\n"
+                          << "Use -f command line argument to force output\n";
+    return 0;
+  }
+  
+  // Make sure that the Out file gets unlinked from the disk if we get a
+  // SIGINT
+  sys::RemoveFileOnSignal(sys::Path(OutputFilename));
+  
+  std::ostream *Out = new std::ofstream(OutputFilename.c_str());
+  if (!Out->good()) {
+    std::cerr << ProgName << ": error opening " << OutputFilename << "!\n";
+    delete Out;
+    return 0;
+  }
+  
+  return Out;
+}
 
 // main - Entry point for the llc compiler.
 //
 int main(int argc, char **argv) {
-  cl::ParseCommandLineOptions(argc, argv, " llvm system compiler\n");
-  
+  llvm_shutdown_obj X;  // Call llvm_shutdown() on exit.
+  cl::ParseCommandLineOptions(argc, argv, "llvm system compiler\n");
+  sys::PrintStackTraceOnErrorSignal();
+
   // Load the module to be compiled...
-  std::auto_ptr<Module> M(ParseBytecodeFile(InputFilename));
+  std::string ErrorMessage;
+  std::auto_ptr<Module> M;
+  
+  std::auto_ptr<MemoryBuffer> Buffer(
+                   MemoryBuffer::getFileOrSTDIN(InputFilename, &ErrorMessage));
+  if (Buffer.get())
+    M.reset(ParseBitcodeFile(Buffer.get(), &ErrorMessage));
   if (M.get() == 0) {
-    std::cerr << argv[0] << ": bytecode didn't read correctly.\n";
+    std::cerr << argv[0] << ": bitcode didn't read correctly.\n";
+    std::cerr << "Reason: " << ErrorMessage << "\n";
     return 1;
   }
   Module &mod = *M.get();
-
+  
+  // If we are supposed to override the target triple, do so now.
+  if (!TargetTriple.empty())
+    mod.setTargetTriple(TargetTriple);
+  
   // Allocate target machine.  First, check whether the user has
   // explicitly specified an architecture to compile for.
-  unsigned Config = (mod.isLittleEndian()   ? TM::LittleEndian : TM::BigEndian)|
-                    (mod.has32BitPointers() ? TM::PtrSize32    : TM::PtrSize64);
-  TargetMachine* (*TargetMachineAllocator)(unsigned) = 0;
-  switch (Arch) {
-  case x86:
-    TargetMachineAllocator = allocateX86TargetMachine;
-    break;
-  case Sparc:
-    TargetMachineAllocator = allocateSparcTargetMachine;
-    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.isLittleEndian() && mod.has32BitPointers()) { 
-      TargetMachineAllocator = allocateX86TargetMachine;
-    } else if (mod.isBigEndian() && mod.has64BitPointers()) {
-      TargetMachineAllocator = allocateSparcTargetMachine;
-    } else {
-      assert(0 && "You must specify -march; I could not guess the default");
-    } 
-    break;
+  if (MArch == 0) {
+    std::string Err;
+    MArch = TargetMachineRegistry::getClosestStaticTargetForModule(mod, Err);
+    if (MArch == 0) {
+      std::cerr << argv[0] << ": error auto-selecting target for module '"
+                << Err << "'.  Please use the -march option to explicitly "
+                << "pick a target.\n";
+      return 1;
+    }
+  }
+
+  // Package up features to be passed to target/subtarget
+  std::string FeaturesStr;
+  if (MCPU.size() || MAttrs.size()) {
+    SubtargetFeatures Features;
+    Features.setCPU(MCPU);
+    for (unsigned i = 0; i != MAttrs.size(); ++i)
+      Features.AddFeature(MAttrs[i]);
+    FeaturesStr = Features.getString();
   }
-  std::auto_ptr<TargetMachine> target((*TargetMachineAllocator)(Config));
+  
+  std::auto_ptr<TargetMachine> target(MArch->CtorFn(mod, FeaturesStr));
   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...
-  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());
-
-      // Make sure that the Out file gets unlink'd from the disk if we get a
-      // SIGINT
-      RemoveFileOnSignal(OutputFilename);
-    } else {
-      Out = &std::cout;
+  std::ostream *Out = GetOutputStream(argv[0]);
+  if (Out == 0) return 1;
+  
+  // If this target requires addPassesToEmitWholeFile, do it now.  This is
+  // used by strange things like the C backend.
+  if (Target.WantsWholeFile()) {
+    PassManager PM;
+    PM.add(new TargetData(*Target.getTargetData()));
+    if (!NoVerify)
+      PM.add(createVerifierPass());
+    
+    // Ask the target to add backend passes as necessary.
+    if (Target.addPassesToEmitWholeFile(PM, *Out, FileType, Fast)) {
+      std::cerr << argv[0] << ": target does not support generation of this"
+                << " file type!\n";
+      if (Out != &std::cout) delete Out;
+      // And the Out file is empty and useless, so remove it now.
+      sys::Path(OutputFilename).eraseFromDisk();
+      return 1;
     }
+    PM.run(mod);
   } else {
-    if (InputFilename == "-") {
-      OutputFilename = "-";
-      Out = &std::cout;
-    } else {
-      OutputFilename = GetFileNameRoot(InputFilename); 
-      OutputFilename += ".s";
-      
-      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 unlink'd from the disk if we get a
-      // SIGINT
-      RemoveFileOnSignal(OutputFilename);
+    // Build up all of the passes that we want to do to the module.
+    FunctionPassManager Passes(new ExistingModuleProvider(M.get()));
+    Passes.add(new TargetData(*Target.getTargetData()));
+    
+#ifndef NDEBUG
+    if (!NoVerify)
+      Passes.add(createVerifierPass());
+#endif
+  
+    // Ask the target to add backend passes as necessary.
+    MachineCodeEmitter *MCE = 0;
+
+    switch (Target.addPassesToEmitFile(Passes, *Out, FileType, Fast)) {
+    default:
+      assert(0 && "Invalid file model!");
+      return 1;
+    case FileModel::Error:
+      std::cerr << argv[0] << ": target does not support generation of this"
+                << " file type!\n";
+      if (Out != &std::cout) delete Out;
+      // And the Out file is empty and useless, so remove it now.
+      sys::Path(OutputFilename).eraseFromDisk();
+      return 1;
+    case FileModel::AsmFile:
+      break;
+    case FileModel::MachOFile:
+      MCE = AddMachOWriter(Passes, *Out, Target);
+      break;
+    case FileModel::ElfFile:
+      MCE = AddELFWriter(Passes, *Out, Target);
+      break;
     }
-  }
 
-  // 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 {
+    if (Target.addPassesToEmitFileFinish(Passes, MCE, Fast)) {
+      std::cerr << argv[0] << ": target does not support generation of this"
+                << " file type!\n";
+      if (Out != &std::cout) delete Out;
+      // And the Out file is empty and useless, so remove it now.
+      sys::Path(OutputFilename).eraseFromDisk();
+      return 1;
+    }
+  
+    Passes.doInitialization();
+  
     // Run our queue of passes all at once now, efficiently.
-    Passes.run(*M.get());
+    // TODO: this could lazily stream functions out of the module.
+    for (Module::iterator I = mod.begin(), E = mod.end(); I != E; ++I)
+      if (!I->isDeclaration())
+        Passes.run(*I);
+    
+    Passes.doFinalization();
   }
-
+    
   // Delete the ostream if it's not a stdout stream
   if (Out != &std::cout) delete Out;