lib/CodeGen/SlotIndexes.cpp

   1 //===-- SlotIndexes.cpp - Slot Indexes Pass  ------------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #define DEBUG_TYPE "slotindexes"
  11
  12 #include "llvm/CodeGen/SlotIndexes.h"
  13 #include "llvm/ADT/Statistic.h"
  14 #include "llvm/CodeGen/MachineFunction.h"
  15 #include "llvm/Support/Debug.h"
  16 #include "llvm/Support/raw_ostream.h"
  17 #include "llvm/Target/TargetInstrInfo.h"
  18
  19 using namespace llvm;
  20
  21 char SlotIndexes::ID = 0;
  22 INITIALIZE_PASS(SlotIndexes, "slotindexes",
  23                 "Slot index numbering", false, false)
  24
  25 STATISTIC(NumRenumPasses, "Number of slot index renumber passes");
  26
  27 void SlotIndexes::getAnalysisUsage(AnalysisUsage &au) const {
  28   au.setPreservesAll();
  29   MachineFunctionPass::getAnalysisUsage(au);
  30 }
  31
  32 void SlotIndexes::releaseMemory() {
  33   mi2iMap.clear();
  34   mbb2IdxMap.clear();
  35   idx2MBBMap.clear();
  36   clearList();
  37 }
  38
  39 bool SlotIndexes::runOnMachineFunction(MachineFunction &fn) {
  40
  41   // Compute numbering as follows:
  42   // Grab an iterator to the start of the index list.
  43   // Iterate over all MBBs, and within each MBB all MIs, keeping the MI
  44   // iterator in lock-step (though skipping it over indexes which have
  45   // null pointers in the instruction field).
  46   // At each iteration assert that the instruction pointed to in the index
  47   // is the same one pointed to by the MI iterator. This
  48
  49   // FIXME: This can be simplified. The mi2iMap_, Idx2MBBMap, etc. should
  50   // only need to be set up once after the first numbering is computed.
  51
  52   mf = &fn;
  53   initList();
  54
  55   // Check that the list contains only the sentinal.
  56   assert(indexListHead->getNext() == 0 &&
  57          "Index list non-empty at initial numbering?");
  58   assert(idx2MBBMap.empty() &&
  59          "Index -> MBB mapping non-empty at initial numbering?");
  60   assert(mbb2IdxMap.empty() &&
  61          "MBB -> Index mapping non-empty at initial numbering?");
  62   assert(mi2iMap.empty() &&
  63          "MachineInstr -> Index mapping non-empty at initial numbering?");
  64
  65   functionSize = 0;
  66   unsigned index = 0;
  67
  68   push_back(createEntry(0, index));
  69
  70   // Iterate over the function.
  71   for (MachineFunction::iterator mbbItr = mf->begin(), mbbEnd = mf->end();
  72        mbbItr != mbbEnd; ++mbbItr) {
  73     MachineBasicBlock *mbb = &*mbbItr;
  74
  75     // Insert an index for the MBB start.
  76     SlotIndex blockStartIndex(back(), SlotIndex::LOAD);
  77
  78     for (MachineBasicBlock::iterator miItr = mbb->begin(), miEnd = mbb->end();
  79          miItr != miEnd; ++miItr) {
  80       MachineInstr *mi = miItr;
  81       if (mi->isDebugValue())
  82         continue;
  83
  84       // Insert a store index for the instr.
  85       push_back(createEntry(mi, index += SlotIndex::InstrDist));
  86
  87       // Save this base index in the maps.
  88       mi2iMap.insert(std::make_pair(mi, SlotIndex(back(), SlotIndex::LOAD)));
  89
  90       ++functionSize;
  91     }
  92
  93     // We insert one blank instructions between basic blocks.
  94     push_back(createEntry(0, index += SlotIndex::InstrDist));
  95
  96     SlotIndex blockEndIndex(back(), SlotIndex::LOAD);
  97     mbb2IdxMap.insert(
  98       std::make_pair(mbb, std::make_pair(blockStartIndex, blockEndIndex)));
  99
 100     idx2MBBMap.push_back(IdxMBBPair(blockStartIndex, mbb));
 101   }
 102
 103   // Sort the Idx2MBBMap
 104   std::sort(idx2MBBMap.begin(), idx2MBBMap.end(), Idx2MBBCompare());
 105
 106   DEBUG(dump());
 107
 108   // And we're done!
 109   return false;
 110 }
 111
 112 void SlotIndexes::renumberIndexes() {
 113   // Renumber updates the index of every element of the index list.
 114   DEBUG(dbgs() << "\n*** Renumbering SlotIndexes ***\n");
 115   ++NumRenumPasses;
 116
 117   unsigned index = 0;
 118
 119   for (IndexListEntry *curEntry = front(); curEntry != getTail();
 120        curEntry = curEntry->getNext()) {
 121     curEntry->setIndex(index);
 122     index += SlotIndex::InstrDist;
 123   }
 124 }
 125
 126 void SlotIndexes::dump() const {
 127   for (const IndexListEntry *itr = front(); itr != getTail();
 128        itr = itr->getNext()) {
 129     dbgs() << itr->getIndex() << " ";
 130
 131     if (itr->getInstr() != 0) {
 132       dbgs() << *itr->getInstr();
 133     } else {
 134       dbgs() << "\n";
 135     }
 136   }
 137
 138   for (MBB2IdxMap::const_iterator itr = mbb2IdxMap.begin();
 139        itr != mbb2IdxMap.end(); ++itr) {
 140     dbgs() << "MBB " << itr->first->getNumber() << " (" << itr->first << ") - ["
 141            << itr->second.first << ", " << itr->second.second << "]\n";
 142   }
 143 }
 144
 145 // Print a SlotIndex to a raw_ostream.
 146 void SlotIndex::print(raw_ostream &os) const {
 147   if (isValid())
 148     os << entry().getIndex() << "LudS"[getSlot()];
 149   else
 150     os << "invalid";
 151 }
 152
 153 // Dump a SlotIndex to stderr.
 154 void SlotIndex::dump() const {
 155   print(dbgs());
 156   dbgs() << "\n";
 157 }
 158