Disable emitting LLVM-to-MI maps, by default.
[oota-llvm.git] / lib / Target / SparcV9 / SparcV9TargetMachine.cpp
index e8835ae975ea7fac57e23586cf209fe1e879aabc..71e323918060f2db97cc7f16ee06a61e7ee909b6 100644 (file)
-// $Id$
-//***************************************************************************
-// File:
-//     Sparc.cpp
-// 
-// Purpose:
-//     
-// History:
-//     7/15/01  -  Vikram Adve  -  Created
-//**************************************************************************/
+//===-- Sparc.cpp - General implementation file for the Sparc Target ------===//
+//
+// This file contains the code for the Sparc Target that does not fit in any of
+// the other files in this directory.
+//
+//===----------------------------------------------------------------------===//
 
-#include "llvm/Target/Sparc.h"
 #include "SparcInternals.h"
-#include "llvm/Method.h"
-#include "llvm/CodeGen/InstrScheduling.h"
+#include "llvm/Target/TargetMachineImpls.h"
+#include "llvm/Function.h"
+#include "llvm/PassManager.h"
+#include "llvm/Transforms/Scalar.h"
+#include "llvm/CodeGen/MachineFunction.h"
+#include "llvm/CodeGen/MachineFunctionInfo.h"
+#include "llvm/CodeGen/PreSelection.h"
+#include "llvm/CodeGen/StackSlots.h"
+#include "llvm/CodeGen/PeepholeOpts.h"
 #include "llvm/CodeGen/InstrSelection.h"
+#include "llvm/CodeGen/InstrScheduling.h"
+#include "llvm/CodeGen/RegisterAllocation.h"
+#include "llvm/CodeGen/MachineCodeForInstruction.h"
+#include "llvm/Reoptimizer/Mapping/MappingInfo.h" 
+#include "Support/CommandLine.h"
+#include "llvm/Assembly/PrintModulePass.h"
 
-#include "llvm/Analysis/LiveVar/MethodLiveVarInfo.h"
-#include "llvm/CodeGen/PhyRegAlloc.h"
-
+static const unsigned ImplicitRegUseList[] = { 0 }; /* not used yet */
 // Build the MachineInstruction Description Array...
-const MachineInstrDescriptor SparcMachineInstrDesc[] = {
+const TargetInstrDescriptor SparcMachineInstrDesc[] = {
 #define I(ENUM, OPCODESTRING, NUMOPERANDS, RESULTPOS, MAXIMM, IMMSE, \
           NUMDELAYSLOTS, LATENCY, SCHEDCLASS, INSTFLAGS)             \
   { OPCODESTRING, NUMOPERANDS, RESULTPOS, MAXIMM, IMMSE,             \
-          NUMDELAYSLOTS, LATENCY, SCHEDCLASS, INSTFLAGS },
+          NUMDELAYSLOTS, LATENCY, SCHEDCLASS, INSTFLAGS, 0,          \
+          ImplicitRegUseList, ImplicitRegUseList },
 #include "SparcInstr.def"
 };
 
-//----------------------------------------------------------------------------
-// allocateSparcTargetMachine - Allocate and return a subclass of TargetMachine
-// that implements the Sparc backend. (the llvm/CodeGen/Sparc.h interface)
-//----------------------------------------------------------------------------
-//
+//---------------------------------------------------------------------------
+// Command line options to control choice of code generation passes.
+//---------------------------------------------------------------------------
 
-TargetMachine *allocateSparcTargetMachine() { return new UltraSparc(); }
+static cl::opt<bool> DisablePreOpt("disable-preopt",
+              cl::desc("Disable optimizations prior to instruction selection"));
 
+static cl::opt<bool> DisableSched("disable-sched",
+                                  cl::desc("Disable local scheduling pass"));
 
-//----------------------------------------------------------------------------
-// Entry point for register allocation for a module
-//----------------------------------------------------------------------------
+static cl::opt<bool> DisablePeephole("disable-peephole",
+                                cl::desc("Disable peephole optimization pass"));
 
-void AllocateRegisters(Method *M, TargetMachine &TM)
-{
-  if ( (M)->isExternal() )     // don't process prototypes
-    return;
-    
-  if( DEBUG_RA ) {
-    cout << endl << "******************** Method "<< (M)->getName();
-    cout <<        " ********************" <<endl;
-  }
-    
-  MethodLiveVarInfo LVI(M );   // Analyze live varaibles
-  LVI.analyze();
-  
-    
-  PhyRegAlloc PRA(M, TM , &LVI); // allocate registers
-  PRA.allocateRegisters();
-    
+static cl::opt<bool> EmitMappingInfo("emitmaps",
+             cl::desc("Emit LLVM-to-MachineCode mapping info to assembly"));
 
-  if( DEBUG_RA )  cout << endl << "Register allocation complete!" << endl;
+static cl::opt<bool> DisableStrip("disable-strip",
+            cl::desc("Do not strip the LLVM bytecode included in executable"));
 
-}
+static cl::opt<bool> DumpInput("dump-input",
+                      cl::desc("Print bytecode before native code generation"),
+                      cl::Hidden);
 
+//----------------------------------------------------------------------------
+// allocateSparcTargetMachine - Allocate and return a subclass of TargetMachine
+// that implements the Sparc backend. (the llvm/CodeGen/Sparc.h interface)
+//----------------------------------------------------------------------------
 
+TargetMachine *allocateSparcTargetMachine(unsigned Configuration) {
+  return new UltraSparc();
+}
 
 //---------------------------------------------------------------------------
-// class UltraSparcInstrInfo 
+// class UltraSparcFrameInfo 
 // 
-// Purpose:
-//   Information about individual instructions.
-//   Most information is stored in the SparcMachineInstrDesc array above.
-//   Other information is computed on demand, and most such functions
-//   default to member functions in base class MachineInstrInfo. 
+//   Interface to stack frame layout info for the UltraSPARC.
+//   Starting offsets for each area of the stack frame are aligned at
+//   a multiple of getStackFrameSizeAlignment().
 //---------------------------------------------------------------------------
 
-/*ctor*/
-UltraSparcInstrInfo::UltraSparcInstrInfo()
-  : MachineInstrInfo(SparcMachineInstrDesc,
-                    /*descSize = */ NUM_TOTAL_OPCODES,
-                    /*numRealOpCodes = */ NUM_REAL_OPCODES)
+int
+UltraSparcFrameInfo::getFirstAutomaticVarOffset(MachineFunction& ,
+                                                bool& pos) const
 {
+  pos = false;                          // static stack area grows downwards
+  return StaticAreaOffsetFromFP;
 }
 
-
-//---------------------------------------------------------------------------
-// class UltraSparcSchedInfo 
-// 
-// Purpose:
-//   Scheduling information for the UltraSPARC.
-//   Primarily just initializes machine-dependent parameters in
-//   class MachineSchedInfo.
-//---------------------------------------------------------------------------
-
-/*ctor*/
-UltraSparcSchedInfo::UltraSparcSchedInfo(const MachineInstrInfo* mii)
-  : MachineSchedInfo((unsigned int) SPARC_NUM_SCHED_CLASSES,
-                    mii,
-                    SparcRUsageDesc,
-                    SparcInstrUsageDeltas,
-                    SparcInstrIssueDeltas,
-                    sizeof(SparcInstrUsageDeltas)/sizeof(InstrRUsageDelta),
-                    sizeof(SparcInstrIssueDeltas)/sizeof(InstrIssueDelta))
+int
+UltraSparcFrameInfo::getRegSpillAreaOffset(MachineFunction& mcInfo,
+                                           bool& pos) const
 {
-  maxNumIssueTotal = 4;
-  longestIssueConflict = 0;            // computed from issuesGaps[]
+  // ensure no more auto vars are added
+  mcInfo.getInfo()->freezeAutomaticVarsArea();
   
-  branchMispredictPenalty = 4;         // 4 for SPARC IIi
-  branchTargetUnknownPenalty = 2;      // 2 for SPARC IIi
-  l1DCacheMissPenalty = 8;             // 7 or 9 for SPARC IIi
-  l1ICacheMissPenalty = 8;             // ? for SPARC IIi
-  
-  inOrderLoads = true;                 // true for SPARC IIi
-  inOrderIssue = true;                 // true for SPARC IIi
-  inOrderExec  = false;                        // false for most architectures
-  inOrderRetire= true;                 // true for most architectures
-  
-  // must be called after above parameters are initialized.
-  this->initializeResources();
+  pos = false;                          // static stack area grows downwards
+  unsigned autoVarsSize = mcInfo.getInfo()->getAutomaticVarsSize();
+  return StaticAreaOffsetFromFP - autoVarsSize; 
 }
 
-void
-UltraSparcSchedInfo::initializeResources()
+int
+UltraSparcFrameInfo::getTmpAreaOffset(MachineFunction& mcInfo,
+                                      bool& pos) const
 {
-  // Compute MachineSchedInfo::instrRUsages and MachineSchedInfo::issueGaps
-  MachineSchedInfo::initializeResources();
+  MachineFunctionInfo *MFI = mcInfo.getInfo();
+  MFI->freezeAutomaticVarsArea();     // ensure no more auto vars are added
+  MFI->freezeSpillsArea();            // ensure no more spill slots are added
   
-  // Machine-dependent fixups go here.  None for now.
+  pos = false;                          // static stack area grows downwards
+  unsigned autoVarsSize = MFI->getAutomaticVarsSize();
+  unsigned spillAreaSize = MFI->getRegSpillsSize();
+  int offset = autoVarsSize + spillAreaSize;
+  return StaticAreaOffsetFromFP - offset;
 }
 
-
-
+int
+UltraSparcFrameInfo::getDynamicAreaOffset(MachineFunction& mcInfo,
+                                          bool& pos) const
+{
+  // Dynamic stack area grows downwards starting at top of opt-args area.
+  // The opt-args, required-args, and register-save areas are empty except
+  // during calls and traps, so they are shifted downwards on each
+  // dynamic-size alloca.
+  pos = false;
+  unsigned optArgsSize = mcInfo.getInfo()->getMaxOptionalArgsSize();
+  if (int extra = optArgsSize % getStackFrameSizeAlignment())
+    optArgsSize += (getStackFrameSizeAlignment() - extra);
+  int offset = optArgsSize + FirstOptionalOutgoingArgOffsetFromSP;
+  assert((offset - OFFSET) % getStackFrameSizeAlignment() == 0);
+  return offset;
+}
 
 //---------------------------------------------------------------------------
 // class UltraSparcMachine 
@@ -139,46 +133,130 @@ UltraSparcSchedInfo::initializeResources()
 //   Primary interface to machine description for the UltraSPARC.
 //   Primarily just initializes machine-dependent parameters in
 //   class TargetMachine, and creates machine-dependent subclasses
-//   for classes such as MachineInstrInfo. 
+//   for classes such as TargetInstrInfo. 
 // 
 //---------------------------------------------------------------------------
 
 UltraSparc::UltraSparc()
-  : TargetMachine("UltraSparc-Native"),
-    instrInfo(),
-    schedInfo(&instrInfo),
-    regInfo( this )
-{
-  optSizeForSubWordData = 4;
-  minMemOpWordSize = 8; 
-  maxAtomicMemOpWordSize = 8;
+  : TargetMachine("UltraSparc-Native", false),
+    schedInfo(*this),
+    regInfo(*this),
+    frameInfo(*this),
+    cacheInfo(*this),
+    optInfo(*this) {
 }
 
 
+// addPassesToEmitAssembly - This method controls the entire code generation
+// process for the ultra sparc.
+//
+bool UltraSparc::addPassesToEmitAssembly(PassManager &PM, std::ostream &Out)
+{
+  // The following 3 passes used to be inserted specially by llc.
+  // Replace malloc and free instructions with library calls.
+  PM.add(createLowerAllocationsPass());
+  
+  // Strip all of the symbols from the bytecode so that it will be smaller...
+  if (!DisableStrip)
+    PM.add(createSymbolStrippingPass());
 
+  // FIXME: implement the switch instruction in the instruction selector.
+  PM.add(createLowerSwitchPass());
+  
+  // decompose multi-dimensional array references into single-dim refs
+  PM.add(createDecomposeMultiDimRefsPass());
+  
+  // Construct and initialize the MachineFunction object for this fn.
+  PM.add(createMachineCodeConstructionPass(*this));
+
+  //Insert empty stackslots in the stack frame of each function
+  //so %fp+offset-8 and %fp+offset-16 are empty slots now!
+  PM.add(createStackSlotsPass(*this));
+
+  if (!DisablePreOpt) {
+    // Specialize LLVM code for this target machine
+    PM.add(createPreSelectionPass(*this));
+    // Run basic dataflow optimizations on LLVM code
+    PM.add(createReassociatePass());
+    PM.add(createLICMPass());
+    PM.add(createGCSEPass());
+  }
+  
+  // If LLVM dumping after transformations is requested, add it to the pipeline
+  if (DumpInput)
+    PM.add(new PrintFunctionPass("Input code to instsr. selection:\n",
+                                 &std::cerr));
 
+  PM.add(createInstructionSelectionPass(*this));
 
-bool UltraSparc::compileMethod(Method *M) {
+  if (!DisableSched)
+    PM.add(createInstructionSchedulingWithSSAPass(*this));
 
-  if (SelectInstructionsForMethod(M, *this))
-    {
-      cerr << "Instruction selection failed for method " << M->getName()
-          << "\n\n";
-      return true;
-    }
-  
-  if (ScheduleInstructionsWithSSA(M, *this))
-    {
-      cerr << "Instruction scheduling before allocation failed for method "
-          << M->getName() << "\n\n";
-      return true;
-    }
-  
-  AllocateRegisters(M, *this);    // allocate registers
+  PM.add(getRegisterAllocator(*this));
 
+  PM.add(getPrologEpilogInsertionPass());
+
+  if (!DisablePeephole)
+    PM.add(createPeepholeOptsPass(*this));
+
+  if (EmitMappingInfo)
+    PM.add(getMappingInfoCollector(Out));  
+
+  // Output assembly language to the .s file.  Assembly emission is split into
+  // two parts: Function output and Global value output.  This is because
+  // function output is pipelined with all of the rest of code generation stuff,
+  // allowing machine code representations for functions to be free'd after the
+  // function has been emitted.
+  //
+  PM.add(getFunctionAsmPrinterPass(Out));
+  PM.add(createMachineCodeDestructionPass()); // Free stuff no longer needed
+
+  // Emit Module level assembly after all of the functions have been processed.
+  PM.add(getModuleAsmPrinterPass(Out));
+
+  // Emit bytecode to the assembly file into its special section next
+  if (EmitMappingInfo) {
+    PM.add(getEmitBytecodeToAsmPass(Out));
+    PM.add(getFunctionInfo(Out)); 
+  }
 
   return false;
 }
 
+// addPassesToJITCompile - This method controls the JIT method of code
+// generation for the UltraSparc.
+//
+bool UltraSparc::addPassesToJITCompile(PassManager &PM) {
+  const TargetData &TD = getTargetData();
+
+  PM.add(new TargetData("lli", TD.isLittleEndian(), TD.getPointerSize(),
+                        TD.getPointerAlignment(), TD.getDoubleAlignment()));
 
+  // 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.
+  PM.add(createLowerAllocationsPass());
 
+  // FIXME: implement the switch instruction in the instruction selector.
+  PM.add(createLowerSwitchPass());
+
+  // decompose multi-dimensional array references into single-dim refs
+  PM.add(createDecomposeMultiDimRefsPass());
+  
+  // Construct and initialize the MachineFunction object for this fn.
+  PM.add(createMachineCodeConstructionPass(*this));
+
+  PM.add(createInstructionSelectionPass(*this));
+
+  // new pass: convert Value* in MachineOperand to an unsigned register
+  // this brings it in line with what the X86 JIT's RegisterAllocator expects
+  //PM.add(createAddRegNumToValuesPass());
+
+  PM.add(getRegisterAllocator(*this));
+  PM.add(getPrologEpilogInsertionPass());
+
+  if (!DisablePeephole)
+    PM.add(createPeepholeOptsPass(*this));
+
+  return false; // success!
+}