add a note
[oota-llvm.git] / tools / llc / llc.cpp
index b769cb5cfd48988f10e9661bf72a83af273a8c57..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/Optimizations/Normalize.h"
-#include "llvm/Target/Sparc.h"
+#include "llvm/Target/SubtargetFeature.h"
 #include "llvm/Target/TargetMachine.h"
-#include "llvm/Transforms/Instrumentation/TraceValues.h"
-#include "llvm/Support/CommandLine.h"
+#include "llvm/Target/TargetMachineRegistry.h"
+#include "llvm/Transforms/Scalar.h"
 #include "llvm/Module.h"
-#include "llvm/Method.h"
-#include <memory>
-#include <string>
+#include "llvm/PassManager.h"
+#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>
+#include <iostream>
+#include <memory>
 
-cl::String InputFilename ("", "Input filename", cl::NoFlags, "-");
-cl::String OutputFilename("o", "Output filename", cl::NoFlags, "");
-cl::Flag   Force         ("f", "Overwrite output files", cl::NoFlags, false);
-cl::Flag   DumpAsm       ("d", "Print bytecode before native code generation", cl::Hidden,false);
-cl::Flag   DoNotEmitAssembly("noasm", "Do not emit assembly code", cl::Hidden, false);
-cl::Flag   TraceBBValues ("trace",
-                          "Trace values at basic block and method exits",
-                          cl::NoFlags, false);
-cl::Flag   TraceMethodValues("tracem", "Trace values only at method exits",
-                             cl::NoFlags, false);
-
-#include "llvm/Assembly/Writer.h"   // For DumpAsm
-
-//-------------------------- Internal Functions ------------------------------//
-
-
-/////
-// TODO: Remove to external file.... When Chris gets back he'll do it
-/////
-#include "llvm/DerivedTypes.h"
-#include "llvm/iMemory.h"
-#include "llvm/iOther.h"
-#include "llvm/SymbolTable.h"
-
-
-Method *MallocMeth = 0, *FreeMeth = 0;
+using namespace llvm;
 
-// InsertMallocFreeDecls - Insert an external declaration for malloc and an
-// external declaration for free for use by the ReplaceMallocFree function.
+// 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 void InsertMallocFreeDecls(Module *M) {
-  const MethodType *MallocType = 
-    MethodType::get(PointerType::get(Type::UByteTy),
-                    vector<const Type*>(1, Type::UIntTy), false);
-
-  SymbolTable *SymTab = M->getSymbolTableSure();
-  
-  // Check for a definition of malloc
-  if (Value *V = SymTab->lookup(PointerType::get(MallocType), "malloc")) {
-    MallocMeth = cast<Method>(V);      // Yup, got it
-  } else {                             // Nope, add one
-    M->getMethodList().push_back(MallocMeth = new Method(MallocType, "malloc"));
-  }
-
-  const MethodType *FreeType = 
-    MethodType::get(Type::VoidTy,
-                    vector<const Type*>(1, PointerType::get(Type::UByteTy)),
-                   false);
-
-  // Check for a definition of free
-  if (Value *V = SymTab->lookup(PointerType::get(FreeType), "free")) {
-    FreeMeth = cast<Method>(V);      // Yup, got it
-  } else {                             // Nope, add one
-    M->getMethodList().push_back(FreeMeth = new Method(FreeType, "free"));
-  }
-}
-
-
-static void ReplaceMallocFree(Method *M, const TargetData &DataLayout) {
-  assert(MallocMeth && FreeMeth && M && "Must call InsertMallocFreeDecls!");
-
-  // Loop over all of the instructions, looking for malloc or free instructions
-  for (Method::iterator BBI = M->begin(), BBE = M->end(); BBI != BBE; ++BBI) {
-    BasicBlock *BB = *BBI;
-    for (unsigned i = 0; i < BB->size(); ++i) {
-      BasicBlock::InstListType &BBIL = BB->getInstList();
-      if (MallocInst *MI = dyn_cast<MallocInst>(*(BBIL.begin()+i))) {
-        BBIL.remove(BBIL.begin()+i);   // remove the malloc instr...
-        
-        const Type *AllocTy = cast<PointerType>(MI->getType())->getValueType();
-
-        // If the user is allocating an unsized array with a dynamic size arg,
-        // start by getting the size of one element.
-        //
-        if (const ArrayType *ATy = dyn_cast<ArrayType>(AllocTy)) 
-          if (ATy->isUnsized()) AllocTy = ATy->getElementType();
-
-        // Get the number of bytes to be allocated for one element of the
-        // requested type...
-        unsigned Size = DataLayout.getTypeSize(AllocTy);
-
-        // malloc(type) becomes sbyte *malloc(constint)
-        Value *MallocArg = ConstPoolUInt::get(Type::UIntTy, Size);
-        if (MI->getNumOperands() && Size == 1) {
-          MallocArg = MI->getOperand(0);         // Operand * 1 = Operand
-        } else if (MI->getNumOperands()) {
-          // Multiply it by the array size if neccesary...
-          MallocArg = BinaryOperator::create(Instruction::Mul,MI->getOperand(0),
-                                             MallocArg);
-          BBIL.insert(BBIL.begin()+i++, cast<Instruction>(MallocArg));
-        }
-
-        // Create the call to Malloc...
-        CallInst *MCall = new CallInst(MallocMeth,
-                                       vector<Value*>(1, MallocArg));
-        BBIL.insert(BBIL.begin()+i, MCall);
-
-        // Create a cast instruction to convert to the right type...
-        CastInst *MCast = new CastInst(MCall, MI->getType());
-        BBIL.insert(BBIL.begin()+i+1, MCast);
-
-        // Replace all uses of the old malloc inst with the cast inst
-        MI->replaceAllUsesWith(MCast);
-        delete MI;                          // Delete the malloc inst
-      } else if (FreeInst *FI = dyn_cast<FreeInst>(*(BBIL.begin()+i))) {
-        BBIL.remove(BB->getInstList().begin()+i);
-
-        // Cast the argument to free into a ubyte*...
-        CastInst *MCast = new CastInst(FI->getOperand(0), 
-                                       PointerType::get(Type::UByteTy));
-        BBIL.insert(BBIL.begin()+i, MCast);
-
-        // Insert a call to the free function...
-        CallInst *FCall = new CallInst(FreeMeth,
-                                       vector<Value*>(1, MCast));
-        BBIL.insert(BBIL.begin()+i+1, FCall);
-
-        // Delete the old free instruction
-        delete FI;
-      }
-    }
-  }
-}
-
-
-// END TODO: Remove to external file....
-
-static void NormalizeMethod(Method *M) {
-  NormalizePhiConstantArgs(M);
-}
-
-inline string
-GetFileNameRoot(const string& InputFilename)
-{
-  string IFN = InputFilename;
-  string outputFilename;
+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"));
+
+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;   // Append a .s to it
+    outputFilename = IFN;
   }
   return outputFilename;
 }
 
-inline string
-GetTraceAssemblyFileName(const string& inFilename)
-{
-  assert(inFilename != "-" && "files on stdin not supported with tracing");
-  string traceFileName = GetFileNameRoot(inFilename);
-  traceFileName += ".trace.ll"; 
-  return traceFileName;
-}
-
-//===---------------------------------------------------------------------===//
-// Function PreprocessModule()
-// 
-// Normalization to simplify later passes.
-//===---------------------------------------------------------------------===//
 
-int
-PreprocessModule(Module* module)
-{
-  InsertMallocFreeDecls(module);
-  
-  for (Module::const_iterator MI=module->begin(); MI != module->end(); ++MI)
-    if (! (*MI)->isExternal())
-      NormalizeMethod(*MI);
-  
-  return 0;
-}
-
-
-//===---------------------------------------------------------------------===//
-// Function OptimizeModule()
-// 
-// Module optimization.
-//===---------------------------------------------------------------------===//
-
-int
-OptimizeModule(Module* module)
-{
-  return 0;
-}
-
-
-//===---------------------------------------------------------------------===//
-// Function GenerateCodeForModule()
-// 
-// Native code generation for a specified target.
-//===---------------------------------------------------------------------===//
-
-int
-GenerateCodeForModule(Module* module, TargetMachine* target)
-{
-  // Since any transformation pass may introduce external function decls
-  // into the method list, find current methods first and then walk only those.
-  // 
-  vector<Method*> initialMethods(module->begin(), module->end());
-  
-  
-  // Replace malloc and free instructions with library calls
-  // 
-  for (unsigned i=0, N = initialMethods.size(); i < N; i++)
-    if (! initialMethods[i]->isExternal())
-      ReplaceMallocFree(initialMethods[i], target->DataLayout);
-  
-  
-  // Insert trace code to assist debugging
-  // 
-  if (TraceBBValues || TraceMethodValues)
-    {
-      // Insert trace code in all methods in the module
-      for (unsigned i=0, N = initialMethods.size(); i < N; i++)
-        if (! initialMethods[i]->isExternal())
-          InsertCodeToTraceValues(initialMethods[i], TraceBBValues,
-                                  TraceBBValues || TraceMethodValues);
-      
-      // Then write the module with tracing code out in assembly form
-      string traceFileName = GetTraceAssemblyFileName(InputFilename);
-      ofstream* ofs = new ofstream(traceFileName.c_str(), 
-                                   (Force ? 0 : ios::noreplace)|ios::out);
-      if (!ofs->good()) {
-        cerr << "Error opening " << traceFileName << "!\n";
-        delete ofs;
+// main - Entry point for the llc compiler.
+//
+int main(int argc, char **argv) {
+  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;
+    }
+    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;
       }
-      WriteToAssembly(module, *ofs);
-      delete ofs;
     }
-  
-  
-  // Generate native target code for all methods
-  // 
-  for (unsigned i=0, N = initialMethods.size(); i < N; i++)
-    if (! initialMethods[i]->isExternal())
-      {
-        if (DumpAsm)
-          cerr << "Method after xformations: \n" << initialMethods[i];
-        
-        if (target->compileMethod(initialMethods[i])) {
-          cerr << "Error compiling " << InputFilename << "!\n";
+
+    // 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;
       }
-  
-  return 0;
-}
+    } 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;
+        }
 
-//===---------------------------------------------------------------------===//
-// Function EmitAssemblyForModule()
-// 
-// Write assembly code to specified output file; <ModuleName>.s by default.
-//===---------------------------------------------------------------------===//
+        Out = new std::ofstream(OutputFilename.c_str());
+        if (!Out->good()) {
+          std::cerr << argv[0] << ": error opening " << OutputFilename << "!\n";
+          delete Out;
+          return 1;
+        }
 
-int
-EmitAssemblyForModule(Module* module, TargetMachine* target)
-{
-  // 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 = &cout;
-    } else {
-      string OutputFilename = GetFileNameRoot(InputFilename); 
-      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;
+        // Make sure that the Out file gets unlinked from the disk if we get a
+        // SIGINT
+        sys::RemoveFileOnSignal(sys::Path(OutputFilename));
       }
     }
-  }
-
-  // Emit the output...
-  target->emitAssembly(module, *Out);
-
-  if (Out != &cout) delete Out;
-
-  return 0;
-}
-
+    
+    // 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());
+    }
 
-//===---------------------------------------------------------------------===//
-// Function main()
-// 
-// Entry point for the llc compiler.
-//===---------------------------------------------------------------------===//
+    // Delete the ostream if it's not a stdout stream
+    if (Out != &std::cout) delete Out;
 
-int
-main(int argc, char **argv)
-{
-  // Parse command line options...
-  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());
-  
-  // Load the module to be compiled...
-  auto_ptr<Module> M(ParseBytecodeFile(InputFilename));
-  if (M.get() == 0) {
-    cerr << "bytecode didn't read correctly.\n";
-    return 1;
+    return 0;
+  } catch (const std::string& msg) {
+    std::cerr << argv[0] << ": " << msg << "\n";
+  } catch (...) {
+    std::cerr << argv[0] << ": Unexpected unknown exception occurred.\n";
   }
-  
-  int failed = PreprocessModule(M.get());
-  
-  if (!failed)
-    failed = OptimizeModule(M.get());
-  
-  if (!failed)
-    failed = GenerateCodeForModule(M.get(), target.get());
-  
-  if (!failed && ! DoNotEmitAssembly)
-    failed = EmitAssemblyForModule(M.get(), target.get());
-  
-  return failed;
+  return 1;
 }
-