add a note
[oota-llvm.git] / tools / llc / llc.cpp
index 785f0a624ca4670d8f93ec31ff25f232ac05648c..357eedd0b68e433540e5915902e951496d39b5c6 100644 (file)
-//===-- llc.cpp - Implement the LLVM Compiler -----------------------------===//
+//===-- llc.cpp - Implement the LLVM Native Code Generator ----------------===//
 //
-// This is the llc compiler driver.
+//                     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 bytecode.
 //
 //===----------------------------------------------------------------------===//
 
 #include "llvm/Bytecode/Reader.h"
-#include "llvm/Target/Sparc.h"
+#include "llvm/Target/SubtargetFeature.h"
 #include "llvm/Target/TargetMachine.h"
-#include "llvm/Transforms/Instrumentation/TraceValues.h"
-#include "llvm/Transforms/ChangeAllocations.h"
+#include "llvm/Target/TargetMachineRegistry.h"
 #include "llvm/Transforms/Scalar.h"
-#include "llvm/Transforms/Utils/Linker.h"
-#include "llvm/Assembly/PrintModulePass.h"
-#include "llvm/Bytecode/WriteBytecodePass.h"
-#include "llvm/Transforms/ConstantMerge.h"
 #include "llvm/Module.h"
-#include "llvm/Function.h"
 #include "llvm/PassManager.h"
-#include "Support/CommandLine.h"
-#include "Support/Signals.h"
-#include <memory>
+#include "llvm/Pass.h"
+#include "llvm/Support/CommandLine.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 <fstream>
-using std::string;
-using std::cerr;
+#include <iostream>
+#include <memory>
+
+using namespace llvm;
 
-static cl::opt<string>
+// 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<string>
+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"));
 
-static cl::opt<bool>
-DumpAsm("d", cl::desc("Print bytecode before native code generation"),
-        cl::Hidden);
-
-static cl::opt<string>
-TraceLibPath("tracelibpath", cl::desc("Path to libinstr for trace code"),
-             cl::value_desc("directory"), cl::Hidden);
-
-enum TraceLevel {
-  TraceOff, TraceFunctions, TraceBasicBlocks
-};
-
-static cl::opt<TraceLevel>
-TraceValues("trace", cl::desc("Trace values through functions or basic blocks"),
-            cl::values(
-  clEnumValN(TraceOff        , "off",        "Disable trace code"),
-  clEnumValN(TraceFunctions  , "function",   "Trace each function"),
-  clEnumValN(TraceBasicBlocks, "basicblock", "Trace each basic block"),
-                       0));
-
-// GetFileNameRoot - Helper function to get the basename of a filename...
-static inline string GetFileNameRoot(const string &InputFilename) {
-  string IFN = InputFilename;
-  string outputFilename;
+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::list<std::string>
+MAttrs("mattr", 
+  cl::CommaSeparated,
+  cl::desc("Target specific attributes (-mattr=help for details)"),
+  cl::value_desc("a1,+a2,-a3,..."));
+
+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"),
+       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) {
+  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;
   }
   return outputFilename;
 }
 
-static void insertTraceCodeFor(Module &M) {
-  PassManager Passes;
-
-  // Insert trace code in all functions in the module
-  switch (TraceValues) {
-  case TraceBasicBlocks:
-    Passes.add(createTraceValuesPassForBasicBlocks());
-    break;
-  case TraceFunctions:
-    Passes.add(createTraceValuesPassForFunction());
-    break;
-  default:
-    assert(0 && "Bad value for TraceValues!");
-    abort();
-  }
-  
-  // Eliminate duplication in constant pool
-  Passes.add(createConstantMergePass());
-
-  // Run passes to insert and clean up trace code...
-  Passes.run(M);
-
-  std::string ErrorMessage;
-
-  // Load the module that contains the runtime helper routines neccesary for
-  // pointer hashing and stuff...  link this module into the program if possible
-  //
-  Module *TraceModule = ParseBytecodeFile(TraceLibPath+"libinstr.bc");
-
-  // Ok, the TraceLibPath didn't contain a valid module.  Try to load the module
-  // from the current LLVM-GCC install directory.  This is kindof a hack, but
-  // allows people to not HAVE to have built the library.
-  //
-  if (TraceModule == 0)
-    TraceModule = ParseBytecodeFile("/home/vadve/lattner/cvs/gcc_install/lib/"
-                                    "gcc-lib/llvm/3.1/libinstr.bc");
-
-  // If we still didn't get it, cancel trying to link it in...
-  if (TraceModule == 0) {
-    cerr << "Warning, could not load trace routines to link into program!\n";
-  } else {
-
-    // Link in the trace routines... if the link fails, don't panic, because the
-    // compile should still succeed, just the native linker will probably fail.
-    //
-    std::auto_ptr<Module> TraceRoutines(TraceModule);
-    if (LinkModules(&M, TraceRoutines.get(), &ErrorMessage))
-      cerr << "Warning: Error linking in trace routines: "
-           << ErrorMessage << "\n";
-  }
-
-
-  // Write out the module with tracing code just before code generation
-  if (InputFilename != "-") {
-    string TraceFilename = GetFileNameRoot(InputFilename) + ".trace.bc";
-
-    std::ofstream Out(TraceFilename.c_str());
-    if (!Out.good()) {
-      cerr << "Error opening '" << TraceFilename
-           << "'!: Skipping output of trace code as bytecode\n";
-    } else {
-      cerr << "Emitting trace code to '" << TraceFilename
-           << "' for comparison...\n";
-      WriteBytecodeToFile(&M, Out);
-    }
-  }
-
-}
-  
-
-//===---------------------------------------------------------------------===//
-// Function main()
-// 
-// Entry point for the llc compiler.
-//===---------------------------------------------------------------------===//
 
+// main - Entry point for the llc compiler.
+//
 int main(int argc, char **argv) {
-  cl::ParseCommandLineOptions(argc, argv, " llvm system compiler\n");
-  
-  // Allocate a target... in the future this will be controllable on the
-  // command line.
-  std::auto_ptr<TargetMachine> target(allocateSparcTargetMachine());
-  assert(target.get() && "Could not allocate target machine!");
-
-  TargetMachine &Target = *target.get();
-  
-  // Load the module to be compiled...
-  std::auto_ptr<Module> M(ParseBytecodeFile(InputFilename));
-  if (M.get() == 0) {
-    cerr << "bytecode didn't read correctly.\n";
-    return 1;
-  }
-
-  if (TraceValues != TraceOff)    // If tracing enabled...
-    insertTraceCodeFor(*M.get()); // Hack up module before using passmanager...
-
-  // Build up all of the passes that we want to do to the module...
-  PassManager Passes;
-
-  // Decompose multi-dimensional refs into a sequence of 1D refs
-  Passes.add(createDecomposeMultiDimRefsPass());
-  
-  // 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.add(createLowerAllocationsPass(Target.DataLayout));
-  
-  // If LLVM dumping after transformations is requested, add it to the pipeline
-  if (DumpAsm)
-    Passes.add(new PrintFunctionPass("Code after xformations: \n", &cerr));
-
-  // Strip all of the symbols from the bytecode so that it will be smaller...
-  Passes.add(createSymbolStrippingPass());
-
-  // Figure out where we are going to send the output...
-  std::ostream *Out = 0;
-  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!
-      cerr << "Error opening '" << OutputFilename << "': File exists!\n"
-           << "Use -f command line argument to force output\n";
+  try {
+    cl::ParseCommandLineOptions(argc, argv, " llvm system compiler\n");
+    sys::PrintStackTraceOnErrorSignal();
+
+    // Load the module to be compiled...
+    std::auto_ptr<Module> M(ParseBytecodeFile(InputFilename));
+    if (M.get() == 0) {
+      std::cerr << argv[0] << ": bytecode didn't read correctly.\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 {
-    if (InputFilename == "-") {
-      OutputFilename = "-";
-      Out = &std::cout;
-    } else {
-      string OutputFilename = GetFileNameRoot(InputFilename); 
-      OutputFilename += ".s";
-
-      if (!Force && std::ifstream(OutputFilename.c_str())) {
-        // If force is not specified, make sure not to overwrite a file!
-        cerr << "Error opening '" << OutputFilename << "': File exists!\n"
-             << "Use -f command line argument to force output\n";
+    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.
+    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;
       }
+    }
 
-      Out = new std::ofstream(OutputFilename.c_str());
-      if (!Out->good()) {
-        cerr << "Error opening " << OutputFilename << "!\n";
-        delete Out;
-        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(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(TD));
+
+#ifndef NDEBUG
+    if(!NoVerify)
+      Passes.add(createVerifierPass());
+#endif
+
+    // 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 unlinked from the disk if we get a
+        // SIGINT
+        sys::RemoveFileOnSignal(sys::Path(OutputFilename));
+      } else {
+        Out = &std::cout;
+      }
+    } else {
+      if (InputFilename == "-") {
+        OutputFilename = "-";
+        Out = &std::cout;
+      } else {
+        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 << 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
+        sys::RemoveFileOnSignal(sys::Path(OutputFilename));
       }
-      // Make sure that the Out file gets unlink'd from the disk if we get a
-      // SIGINT
-      RemoveFileOnSignal(OutputFilename);
     }
-  }
-  
-  Target.addPassesToEmitAssembly(Passes, *Out);
-  
-  // Run our queue of passes all at once now, efficiently.
-  Passes.run(*M.get());
+    
+    // Ask the target to add backend passes as necessary.
+    if (Target.addPassesToEmitFile(Passes, *Out, FileType, Fast)) {
+      std::cerr << argv[0] << ": target '" << Target.getName()
+                << "' 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;
+    } else {
+      // Run our queue of passes all at once now, efficiently.
+      Passes.run(*M.get());
+    }
 
-  if (Out != &std::cout) delete Out;
+    // Delete the ostream if it's not a stdout stream
+    if (Out != &std::cout) delete Out;
 
-  return 0;
+    return 0;
+  } catch (const std::string& msg) {
+    std::cerr << argv[0] << ": " << msg << "\n";
+  } catch (...) {
+    std::cerr << argv[0] << ": Unexpected unknown exception occurred.\n";
+  }
+  return 1;
 }