Add the Object Code Emitter class. Original patch by Aaron Gray, I did some
[oota-llvm.git] / tools / llc / llc.cpp
index 62b4a3a490678bdc7a78825719e7515b6e0dbe4e..42d158cf5ec6dae4601769d135e0fce31a43a85d 100644 (file)
 //===-- 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 file 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 bytecode.
+// 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/CodeGen/LinkAllAsmWriterComponents.h"
+#include "llvm/CodeGen/ObjectCodeEmitter.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/LLVMContext.h"
 #include "llvm/Module.h"
+#include "llvm/ModuleProvider.h"
 #include "llvm/PassManager.h"
 #include "llvm/Pass.h"
-#include "Support/CommandLine.h"
+#include "llvm/Support/CommandLine.h"
+#include "llvm/Support/FileUtilities.h"
+#include "llvm/Support/ManagedStatic.h"
+#include "llvm/Support/MemoryBuffer.h"
+#include "llvm/Support/PluginLoader.h"
+#include "llvm/Support/PrettyStackTrace.h"
+#include "llvm/Support/RegistryParser.h"
+#include "llvm/Support/raw_ostream.h"
+#include "llvm/Analysis/Verifier.h"
 #include "llvm/System/Signals.h"
+#include "llvm/Config/config.h"
+#include "llvm/LinkAllVMCore.h"
+#include "llvm/Target/TargetSelect.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, SparcV9, PowerPC, CBackend };
+// Determine optimization level.
+static cl::opt<char>
+OptLevel("O",
+         cl::desc("Optimization level. [-O0, -O1, -O2, or -O3] "
+                  "(default = '-O2')"),
+         cl::Prefix,
+         cl::ZeroOrMore,
+         cl::init(' '));
+
+static cl::opt<std::string>
+TargetTriple("mtriple", cl::desc("Override target triple for module"));
+
+static cl::opt<const TargetMachineRegistry::entry*, false,
+               RegistryParser<TargetMachine> >
+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::list<std::string>
+MAttrs("mattr",
+  cl::CommaSeparated,
+  cl::desc("Target specific attributes (-mattr=help for details)"),
+  cl::value_desc("a1,+a2,-a3,..."));
 
-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(SparcV9,  "sparcv9", "  SPARC V9"),
-                clEnumValN(PowerPC,  "powerpc", "  PowerPC (experimental)"),
-                clEnumValN(CBackend, "c",       "  C backend"),
-               0),
-     cl::init(noarch));
+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));
 
-// GetFileNameRoot - Helper function to get the basename of a filename...
+cl::opt<bool> NoVerify("disable-verify", cl::Hidden,
+                       cl::desc("Do not verify input module"));
+
+
+static cl::opt<bool>
+DisableRedZone("disable-red-zone",
+  cl::desc("Do not emit code that uses the red zone."),
+  cl::init(false));
+
+static cl::opt<bool>
+NoImplicitFloats("no-implicit-float",
+  cl::desc("Don't generate implicit floating point instructions (x86-only)"),
+  cl::init(false));
+
+// 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();
@@ -67,149 +128,244 @@ GetFileNameRoot(const std::string &InputFilename)
   return outputFilename;
 }
 
+static raw_ostream *GetOutputStream(const char *ProgName) {
+  if (OutputFilename != "") {
+    if (OutputFilename == "-")
+      return &outs();
+
+    // 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));
+
+    std::string error;
+    raw_ostream *Out = new raw_fd_ostream(OutputFilename.c_str(), true, error);
+    if (!error.empty()) {
+      std::cerr << error << '\n';
+      delete Out;
+      return 0;
+    }
+
+    return Out;
+  }
+
+  if (InputFilename == "-") {
+    OutputFilename = "-";
+    return &outs();
+  }
+
+  OutputFilename = GetFileNameRoot(InputFilename);
+
+  bool Binary = false;
+  switch (FileType) {
+  case TargetMachine::AssemblyFile:
+    if (MArch->Name[0] == 'c') {
+      if (MArch->Name[1] == 0)
+        OutputFilename += ".cbe.c";
+      else if (MArch->Name[1] == 'p' && MArch->Name[2] == 'p')
+        OutputFilename += ".cpp";
+      else
+        OutputFilename += ".s";
+    } else
+      OutputFilename += ".s";
+    break;
+  case TargetMachine::ObjectFile:
+    OutputFilename += ".o";
+    Binary = true;
+    break;
+  case TargetMachine::DynamicLibrary:
+    OutputFilename += LTDL_SHLIB_EXT;
+    Binary = true;
+    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::string error;
+  raw_ostream *Out = new raw_fd_ostream(OutputFilename.c_str(), Binary, error);
+  if (!error.empty()) {
+    std::cerr << error << '\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");
-  PrintStackTraceOnErrorSignal();
+  sys::PrintStackTraceOnErrorSignal();
+  PrettyStackTraceProgram X(argc, argv);
+  LLVMContext Context;
+  llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
+  cl::ParseCommandLineOptions(argc, argv, "llvm system compiler\n");
 
+  InitializeAllTargets();
+  InitializeAllAsmPrinters();
+  
   // 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(), Context, &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.
-  TargetMachine* (*TargetMachineAllocator)(const Module&,
-                                           IntrinsicLowering *) = 0;
-  switch (Arch) {
-  case CBackend:
-    TargetMachineAllocator = allocateCTargetMachine;
-    break;
-  case X86:
-    TargetMachineAllocator = allocateX86TargetMachine;
-    break;
-  case SparcV9:
-    TargetMachineAllocator = allocateSparcV9TargetMachine;
-    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 = allocateSparcV9TargetMachine;
-    } 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 = allocateSparcV9TargetMachine;
-#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";
+  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;
-#endif
-    } 
-    break;
+    }
+  }
+
+  // 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(mod, 0));
+
+  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;
+  // Figure out where we are going to send the output...
+  raw_ostream *Out = GetOutputStream(argv[0]);
+  if (Out == 0) return 1;
 
-  Passes.add(new TargetData("llc", TD.isLittleEndian(), TD.getPointerSize(),
-                            TD.getPointerAlignment(), TD.getDoubleAlignment()));
+  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;
+  }
 
-  // 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());
+  // 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());
 
-      // Make sure that the Out file gets unlinked from the disk if we get a
-      // SIGINT
-      RemoveFileOnSignal(OutputFilename);
-    } else {
-      Out = &std::cout;
+    // Ask the target to add backend passes as necessary.
+    if (Target.addPassesToEmitWholeFile(PM, *Out, FileType, OLvl)) {
+      std::cerr << argv[0] << ": target does not support generation of this"
+                << " file type!\n";
+      if (Out != &outs()) 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); 
+    // Build up all of the passes that we want to do to the module.
+    ExistingModuleProvider Provider(M.release());
+    FunctionPassManager Passes(&Provider);
+    Passes.add(new TargetData(*Target.getTargetData()));
 
-      if (Arch != CBackend)
-        OutputFilename += ".s";
-      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);
+#ifndef NDEBUG
+    if (!NoVerify)
+      Passes.add(createVerifierPass());
+#endif
+
+    // Ask the target to add backend passes as necessary.
+    ObjectCodeEmitter *OCE = 0;
+
+    // Override default to generate verbose assembly.
+    Target.setAsmVerbosityDefault(true);
+
+    switch (Target.addPassesToEmitFile(Passes, *Out, FileType, OLvl)) {
+    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 != &outs()) 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:
+      OCE = AddMachOWriter(Passes, *Out, Target);
+      break;
+    case FileModel::ElfFile:
+      OCE = 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, OCE, OLvl)) {
+      std::cerr << argv[0] << ": target does not support generation of this"
+                << " file type!\n";
+      if (Out != &outs()) 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()) {
+        if (DisableRedZone)
+          I->addFnAttr(Attribute::NoRedZone);
+        if (NoImplicitFloats)
+          I->addFnAttr(Attribute::NoImplicitFloat);
+        Passes.run(*I);
+      }
+
+    Passes.doFinalization();
   }
 
   // Delete the ostream if it's not a stdout stream
-  if (Out != &std::cout) delete Out;
+  if (Out != &outs()) delete Out;
 
   return 0;
 }