1 //===-- SlotIndexes.cpp - Slot Indexes Pass ------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #define DEBUG_TYPE "slotindexes"
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"
21 char SlotIndexes::ID = 0;
22 INITIALIZE_PASS(SlotIndexes, "slotindexes",
23 "Slot index numbering", false, false)
25 STATISTIC(NumLocalRenum, "Number of local renumberings");
26 STATISTIC(NumGlobalRenum, "Number of global renumberings");
28 void SlotIndexes::getAnalysisUsage(AnalysisUsage &au) const {
30 MachineFunctionPass::getAnalysisUsage(au);
33 void SlotIndexes::releaseMemory() {
40 bool SlotIndexes::runOnMachineFunction(MachineFunction &fn) {
42 // Compute numbering as follows:
43 // Grab an iterator to the start of the index list.
44 // Iterate over all MBBs, and within each MBB all MIs, keeping the MI
45 // iterator in lock-step (though skipping it over indexes which have
46 // null pointers in the instruction field).
47 // At each iteration assert that the instruction pointed to in the index
48 // is the same one pointed to by the MI iterator. This
50 // FIXME: This can be simplified. The mi2iMap_, Idx2MBBMap, etc. should
51 // only need to be set up once after the first numbering is computed.
56 // Check that the list contains only the sentinal.
57 assert(indexListHead->getNext() == 0 &&
58 "Index list non-empty at initial numbering?");
59 assert(idx2MBBMap.empty() &&
60 "Index -> MBB mapping non-empty at initial numbering?");
61 assert(MBBRanges.empty() &&
62 "MBB -> Index mapping non-empty at initial numbering?");
63 assert(mi2iMap.empty() &&
64 "MachineInstr -> Index mapping non-empty at initial numbering?");
68 MBBRanges.resize(mf->getNumBlockIDs());
69 idx2MBBMap.reserve(mf->size());
71 push_back(createEntry(0, index));
73 // Iterate over the function.
74 for (MachineFunction::iterator mbbItr = mf->begin(), mbbEnd = mf->end();
75 mbbItr != mbbEnd; ++mbbItr) {
76 MachineBasicBlock *mbb = &*mbbItr;
78 // Insert an index for the MBB start.
79 SlotIndex blockStartIndex(back(), SlotIndex::Slot_Block);
81 for (MachineBasicBlock::iterator miItr = mbb->begin(), miEnd = mbb->end();
82 miItr != miEnd; ++miItr) {
83 MachineInstr *mi = miItr;
84 if (mi->isDebugValue())
87 // Insert a store index for the instr.
88 push_back(createEntry(mi, index += SlotIndex::InstrDist));
90 // Save this base index in the maps.
91 mi2iMap.insert(std::make_pair(mi, SlotIndex(back(),
92 SlotIndex::Slot_Block)));
97 // We insert one blank instructions between basic blocks.
98 push_back(createEntry(0, index += SlotIndex::InstrDist));
100 MBBRanges[mbb->getNumber()].first = blockStartIndex;
101 MBBRanges[mbb->getNumber()].second = SlotIndex(back(),
102 SlotIndex::Slot_Block);
103 idx2MBBMap.push_back(IdxMBBPair(blockStartIndex, mbb));
106 // Sort the Idx2MBBMap
107 std::sort(idx2MBBMap.begin(), idx2MBBMap.end(), Idx2MBBCompare());
115 void SlotIndexes::renumberIndexes() {
116 // Renumber updates the index of every element of the index list.
117 DEBUG(dbgs() << "\n*** Renumbering SlotIndexes ***\n");
122 for (IndexListEntry *curEntry = front(); curEntry != getTail();
123 curEntry = curEntry->getNext()) {
124 curEntry->setIndex(index);
125 index += SlotIndex::InstrDist;
129 // Renumber indexes locally after curEntry was inserted, but failed to get a new
131 void SlotIndexes::renumberIndexes(IndexListEntry *curEntry) {
132 // Number indexes with half the default spacing so we can catch up quickly.
133 const unsigned Space = SlotIndex::InstrDist/2;
134 assert((Space & 3) == 0 && "InstrDist must be a multiple of 2*NUM");
136 IndexListEntry *start = curEntry->getPrev();
137 unsigned index = start->getIndex();
138 IndexListEntry *tail = getTail();
140 curEntry->setIndex(index += Space);
141 curEntry = curEntry->getNext();
142 // If the next index is bigger, we have caught up.
143 } while (curEntry != tail && curEntry->getIndex() <= index);
145 DEBUG(dbgs() << "\n*** Renumbered SlotIndexes " << start->getIndex() << '-'
146 << index << " ***\n");
151 void SlotIndexes::dump() const {
152 for (const IndexListEntry *itr = front(); itr != getTail();
153 itr = itr->getNext()) {
154 dbgs() << itr->getIndex() << " ";
156 if (itr->getInstr() != 0) {
157 dbgs() << *itr->getInstr();
163 for (unsigned i = 0, e = MBBRanges.size(); i != e; ++i)
164 dbgs() << "BB#" << i << "\t[" << MBBRanges[i].first << ';'
165 << MBBRanges[i].second << ")\n";
168 // Print a SlotIndex to a raw_ostream.
169 void SlotIndex::print(raw_ostream &os) const {
171 os << entry().getIndex() << "Berd"[getSlot()];
176 // Dump a SlotIndex to stderr.
177 void SlotIndex::dump() const {