Eliminate duplicate or unneccesary #include's
[oota-llvm.git] / tools / llc / llc.cpp
index c8dc8ab08da6cf6d1fec49800e58b181bb00b23d..6f6ab2ade66a0baaa0e606eabd4083ed3e8153a0 100644 (file)
 //===----------------------------------------------------------------------===//
 
 #include "llvm/Bytecode/Reader.h"
-#include "llvm/Optimizations/Normalize.h"
 #include "llvm/Target/Sparc.h"
 #include "llvm/Target/TargetMachine.h"
-#include "llvm/Support/CommandLine.h"
+#include "llvm/Transforms/Instrumentation/TraceValues.h"
+#include "llvm/Transforms/ChangeAllocations.h"
+#include "llvm/Transforms/HoistPHIConstants.h"
+#include "llvm/Transforms/Scalar/DecomposeMultiDimRefs.h"
+#include "llvm/Assembly/PrintModulePass.h"
+#include "llvm/Bytecode/WriteBytecodePass.h"
+#include "llvm/Transforms/ConstantMerge.h"
 #include "llvm/Module.h"
-#include "llvm/Method.h"
+#include "llvm/Function.h"
+#include "llvm/PassManager.h"
+#include "Support/CommandLine.h"
+#include "Support/Signals.h"
 #include <memory>
 #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::NoFlags, false);
-cl::Flag   DumpAsm       ("d", "Print assembly as compiled", cl::Hidden, 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;
-
-// InsertMallocFreeDecls - Insert an external declaration for malloc and an
-// external declaration for free for use by the ReplaceMallocFree function.
-//
-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;
-      }
-    }
+using std::string;
+
+static cl::String InputFilename ("", "Input filename", cl::NoFlags, "-");
+static cl::String OutputFilename("o", "Output filename", cl::NoFlags, "");
+static cl::Flag   Force         ("f", "Overwrite output files");
+static cl::Flag   DumpAsm       ("d", "Print bytecode before native code generation", cl::Hidden);
+
+enum TraceLevel {
+  TraceOff, TraceFunctions, TraceBasicBlocks
+};
+
+static cl::Enum<enum TraceLevel> TraceValues("trace", cl::NoFlags,
+  "Trace values through functions or basic blocks",
+  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;
+  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/
+  } else {
+    outputFilename = IFN;
   }
-}
-
-
-// END TODO: Remove to external file....
-
-static void NormalizeMethod(Method *M) {
-  NormalizePhiConstantArgs(M);
+  return outputFilename;
 }
 
 
@@ -147,71 +60,124 @@ static void NormalizeMethod(Method *M) {
 //===---------------------------------------------------------------------===//
 
 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());
+  std::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";
     return 1;
   }
 
-  InsertMallocFreeDecls(M.get());
+  // Build up all of the passes that we want to do to the module...
+  PassManager Passes;
 
-  // Loop over all of the methods in the module, compiling them.
-  for (Module::const_iterator MI = M->begin(), ME = M->end(); MI != ME; ++MI) {
-    Method *Meth = *MI;
-    
-    NormalizeMethod(Meth);
-    ReplaceMallocFree(Meth, Target->DataLayout);
-    
-    if (DumpAsm)
-      cerr << "Method after xformations: \n" << Meth;
+  // Hoist constants out of PHI nodes into predecessor BB's
+  Passes.add(createHoistPHIConstantsPass());
 
-    if (Target->compileMethod(Meth)) {
-      cerr << "Error compiling " << InputFilename << "!\n";
+  if (TraceValues != TraceOff) {   // If tracing enabled...
+    // Insert trace code in all functions in the module
+    if (TraceValues == TraceBasicBlocks)
+      Passes.add(createTraceValuesPassForBasicBlocks());
+    else if (TraceValues == TraceFunctions)
+      Passes.add(createTraceValuesPassForFunction());
+    else
+      assert(0 && "Bad value for TraceValues!");
+
+    // Eliminate duplication in constant pool
+    Passes.add(createDynamicConstantMergePass());
+  }
+  
+  // Decompose multi-dimensional refs into a sequence of 1D refs
+  Passes.add(createDecomposeMultiDimRefsPass());
+  
+  // Write out the module with tracing code just before code generation
+  if (TraceValues != TraceOff) {   // If tracing enabled...
+    assert(InputFilename != "-" &&
+           "files on stdin not supported with tracing");
+    string traceFileName = GetFileNameRoot(InputFilename) + ".trace.bc";
+
+    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";
+      return 1;
+    }
+    
+    std::ostream *os = new std::ofstream(traceFileName.c_str());
+    if (!os->good()) {
+      cerr << "Error opening " << traceFileName
+           << "! SKIPPING OUTPUT OF TRACE CODE\n";
+      delete os;
       return 1;
     }
+    
+    Passes.add(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.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));
+
   // Figure out where we are going to send the output...
-  ostream *Out = 0;
+  std::ostream *Out = 0;
   if (OutputFilename != "") {   // Specified an output filename?
-    Out = new ofstream(OutputFilename.c_str(), 
-                       (Force ? 0 : ios::noreplace)|ios::out);
+    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";
+      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 = &cout;
+      Out = &std::cout;
     } else {
-      string IFN = InputFilename;
-      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/
-      } else {
-        OutputFilename = IFN;   // Append a .s to it
-      }
+      string OutputFilename = GetFileNameRoot(InputFilename); 
       OutputFilename += ".s";
-      Out = new ofstream(OutputFilename.c_str(), 
-                         (Force ? 0 : ios::noreplace)|ios::out);
+
+      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";
+        return 1;
+      }
+
+      Out = new std::ofstream(OutputFilename.c_str());
       if (!Out->good()) {
         cerr << "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);
     }
   }
+  
+  Target.addPassesToEmitAssembly(Passes, *Out);
+  
+  // Run our queue of passes all at once now, efficiently.
+  Passes.run(M.get());
 
-  // Emit the output...
-  Target->emitAssembly(M.get(), *Out);
+  if (Out != &std::cout) delete Out;
 
-  if (Out != &cout) delete Out;
   return 0;
 }
-
-