include/llvm/CodeGen/SlotIndexes.h

   1 //===- llvm/CodeGen/SlotIndexes.h - Slot indexes representation -*- C++ -*-===//
   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 // This file implements SlotIndex and related classes. The purpose of SlotIndex
  11 // is to describe a position at which a register can become live, or cease to
  12 // be live.
  13 //
  14 // SlotIndex is mostly a proxy for entries of the SlotIndexList, a class which
  15 // is held is LiveIntervals and provides the real numbering. This allows
  16 // LiveIntervals to perform largely transparent renumbering.
  17 //===----------------------------------------------------------------------===//
  18
  19 #ifndef LLVM_CODEGEN_SLOTINDEXES_H
  20 #define LLVM_CODEGEN_SLOTINDEXES_H
  21
  22 #include "llvm/CodeGen/MachineBasicBlock.h"
  23 #include "llvm/CodeGen/MachineFunction.h"
  24 #include "llvm/CodeGen/MachineFunctionPass.h"
  25 #include "llvm/ADT/PointerIntPair.h"
  26 #include "llvm/ADT/SmallVector.h"
  27 #include "llvm/ADT/DenseMap.h"
  28 #include "llvm/Support/Allocator.h"
  29
  30 namespace llvm {
  31
  32   /// This class represents an entry in the slot index list held in the
  33   /// SlotIndexes pass. It should not be used directly. See the
  34   /// SlotIndex & SlotIndexes classes for the public interface to this
  35   /// information.
  36   class IndexListEntry {
  37     IndexListEntry *next, *prev;
  38     MachineInstr *mi;
  39     unsigned index;
  40
  41   public:
  42
  43     IndexListEntry(MachineInstr *mi, unsigned index) : mi(mi), index(index) {}
  44
  45     MachineInstr* getInstr() const { return mi; }
  46     void setInstr(MachineInstr *mi) {
  47       this->mi = mi;
  48     }
  49
  50     unsigned getIndex() const { return index; }
  51     void setIndex(unsigned index) {
  52       this->index = index;
  53     }
  54
  55     IndexListEntry* getNext() { return next; }
  56     const IndexListEntry* getNext() const { return next; }
  57     void setNext(IndexListEntry *next) {
  58       this->next = next;
  59     }
  60
  61     IndexListEntry* getPrev() { return prev; }
  62     const IndexListEntry* getPrev() const { return prev; }
  63     void setPrev(IndexListEntry *prev) {
  64       this->prev = prev;
  65     }
  66   };
  67
  68   // Specialize PointerLikeTypeTraits for IndexListEntry.
  69   template <>
  70   class PointerLikeTypeTraits<IndexListEntry*> {
  71   public:
  72     static inline void* getAsVoidPointer(IndexListEntry *p) {
  73       return p;
  74     }
  75     static inline IndexListEntry* getFromVoidPointer(void *p) {
  76       return static_cast<IndexListEntry*>(p);
  77     }
  78     enum { NumLowBitsAvailable = 3 };
  79   };
  80
  81   /// SlotIndex - An opaque wrapper around machine indexes.
  82   class SlotIndex {
  83     friend class SlotIndexes;
  84     friend struct DenseMapInfo<SlotIndex>;
  85
  86     enum Slot {
  87       /// Basic block boundary.  Used for live ranges entering and leaving a
  88       /// block without being live in the layout neighbor.  Also used as the
  89       /// def slot of PHI-defs.
  90       Slot_Block,
  91
  92       /// Early-clobber register use/def slot.  A live range defined at
  93       /// Slot_EarlyCLobber interferes with normal live ranges killed at
  94       /// Slot_Register.  Also used as the kill slot for live ranges tied to an
  95       /// early-clobber def.
  96       Slot_EarlyClobber,
  97
  98       /// Normal register use/def slot.  Normal instructions kill and define
  99       /// register live ranges at this slot.
 100       Slot_Register,
 101
 102       /// Dead def kill point.  Kill slot for a live range that is defined by
 103       /// the same instruction (Slot_Register or Slot_EarlyClobber), but isn't
 104       /// used anywhere.
 105       Slot_Dead,
 106
 107       Slot_Count
 108     };
 109
 110     PointerIntPair<IndexListEntry*, 2, unsigned> lie;
 111
 112     SlotIndex(IndexListEntry *entry, unsigned slot)
 113       : lie(entry, slot) {}
 114
 115     IndexListEntry& entry() const {
 116       assert(isValid() && "Attempt to compare reserved index.");
 117       return *lie.getPointer();
 118     }
 119
 120     int getIndex() const {
 121       return entry().getIndex() | getSlot();
 122     }
 123
 124     /// Returns the slot for this SlotIndex.
 125     Slot getSlot() const {
 126       return static_cast<Slot>(lie.getInt());
 127     }
 128
 129     static inline unsigned getHashValue(const SlotIndex &v) {
 130       void *ptrVal = v.lie.getOpaqueValue();
 131       return (unsigned((intptr_t)ptrVal)) ^ (unsigned((intptr_t)ptrVal) >> 9);
 132     }
 133
 134   public:
 135     enum {
 136       /// The default distance between instructions as returned by distance().
 137       /// This may vary as instructions are inserted and removed.
 138       InstrDist = 4 * Slot_Count
 139     };
 140
 141     static inline SlotIndex getEmptyKey() {
 142       return SlotIndex(0, 1);
 143     }
 144
 145     static inline SlotIndex getTombstoneKey() {
 146       return SlotIndex(0, 2);
 147     }
 148
 149     /// Construct an invalid index.
 150     SlotIndex() : lie(0, 0) {}
 151
 152     // Construct a new slot index from the given one, and set the slot.
 153     SlotIndex(const SlotIndex &li, Slot s)
 154       : lie(&li.entry(), unsigned(s)) {
 155       assert(lie.getPointer() != 0 &&
 156              "Attempt to construct index with 0 pointer.");
 157     }
 158
 159     /// Returns true if this is a valid index. Invalid indicies do
 160     /// not point into an index table, and cannot be compared.
 161     bool isValid() const {
 162       return lie.getPointer();
 163     }
 164
 165     /// Return true for a valid index.
 166     operator bool() const { return isValid(); }
 167
 168     /// Print this index to the given raw_ostream.
 169     void print(raw_ostream &os) const;
 170
 171     /// Dump this index to stderr.
 172     void dump() const;
 173
 174     /// Compare two SlotIndex objects for equality.
 175     bool operator==(SlotIndex other) const {
 176       return lie == other.lie;
 177     }
 178     /// Compare two SlotIndex objects for inequality.
 179     bool operator!=(SlotIndex other) const {
 180       return lie != other.lie;
 181     }
 182
 183     /// Compare two SlotIndex objects. Return true if the first index
 184     /// is strictly lower than the second.
 185     bool operator<(SlotIndex other) const {
 186       return getIndex() < other.getIndex();
 187     }
 188     /// Compare two SlotIndex objects. Return true if the first index
 189     /// is lower than, or equal to, the second.
 190     bool operator<=(SlotIndex other) const {
 191       return getIndex() <= other.getIndex();
 192     }
 193
 194     /// Compare two SlotIndex objects. Return true if the first index
 195     /// is greater than the second.
 196     bool operator>(SlotIndex other) const {
 197       return getIndex() > other.getIndex();
 198     }
 199
 200     /// Compare two SlotIndex objects. Return true if the first index
 201     /// is greater than, or equal to, the second.
 202     bool operator>=(SlotIndex other) const {
 203       return getIndex() >= other.getIndex();
 204     }
 205
 206     /// isSameInstr - Return true if A and B refer to the same instruction.
 207     static bool isSameInstr(SlotIndex A, SlotIndex B) {
 208       return A.lie.getPointer() == B.lie.getPointer();
 209     }
 210
 211     /// isEarlierInstr - Return true if A refers to an instruction earlier than
 212     /// B. This is equivalent to A < B && !isSameInstr(A, B).
 213     static bool isEarlierInstr(SlotIndex A, SlotIndex B) {
 214       return A.entry().getIndex() < B.entry().getIndex();
 215     }
 216
 217     /// Return the distance from this index to the given one.
 218     int distance(SlotIndex other) const {
 219       return other.getIndex() - getIndex();
 220     }
 221
 222     /// isBlock - Returns true if this is a block boundary slot.
 223     bool isBlock() const { return getSlot() == Slot_Block; }
 224
 225     /// isEarlyClobber - Returns true if this is an early-clobber slot.
 226     bool isEarlyClobber() const { return getSlot() == Slot_EarlyClobber; }
 227
 228     /// isRegister - Returns true if this is a normal register use/def slot.
 229     /// Note that early-clobber slots may also be used for uses and defs.
 230     bool isRegister() const { return getSlot() == Slot_Register; }
 231
 232     /// isDead - Returns true if this is a dead def kill slot.
 233     bool isDead() const { return getSlot() == Slot_Dead; }
 234
 235     /// Returns the base index for associated with this index. The base index
 236     /// is the one associated with the Slot_Block slot for the instruction
 237     /// pointed to by this index.
 238     SlotIndex getBaseIndex() const {
 239       return SlotIndex(&entry(), Slot_Block);
 240     }
 241
 242     /// Returns the boundary index for associated with this index. The boundary
 243     /// index is the one associated with the Slot_Block slot for the instruction
 244     /// pointed to by this index.
 245     SlotIndex getBoundaryIndex() const {
 246       return SlotIndex(&entry(), Slot_Dead);
 247     }
 248
 249     /// Returns the register use/def slot in the current instruction for a
 250     /// normal or early-clobber def.
 251     SlotIndex getRegSlot(bool EC = false) const {
 252       return SlotIndex(&entry(), EC ? Slot_EarlyClobber : Slot_Register);
 253     }
 254
 255     /// Returns the dead def kill slot for the current instruction.
 256     SlotIndex getDeadSlot() const {
 257       return SlotIndex(&entry(), Slot_Dead);
 258     }
 259
 260     /// Returns the next slot in the index list. This could be either the
 261     /// next slot for the instruction pointed to by this index or, if this
 262     /// index is a STORE, the first slot for the next instruction.
 263     /// WARNING: This method is considerably more expensive than the methods
 264     /// that return specific slots (getUseIndex(), etc). If you can - please
 265     /// use one of those methods.
 266     SlotIndex getNextSlot() const {
 267       Slot s = getSlot();
 268       if (s == Slot_Dead) {
 269         return SlotIndex(entry().getNext(), Slot_Block);
 270       }
 271       return SlotIndex(&entry(), s + 1);
 272     }
 273
 274     /// Returns the next index. This is the index corresponding to the this
 275     /// index's slot, but for the next instruction.
 276     SlotIndex getNextIndex() const {
 277       return SlotIndex(entry().getNext(), getSlot());
 278     }
 279
 280     /// Returns the previous slot in the index list. This could be either the
 281     /// previous slot for the instruction pointed to by this index or, if this
 282     /// index is a Slot_Block, the last slot for the previous instruction.
 283     /// WARNING: This method is considerably more expensive than the methods
 284     /// that return specific slots (getUseIndex(), etc). If you can - please
 285     /// use one of those methods.
 286     SlotIndex getPrevSlot() const {
 287       Slot s = getSlot();
 288       if (s == Slot_Block) {
 289         return SlotIndex(entry().getPrev(), Slot_Dead);
 290       }
 291       return SlotIndex(&entry(), s - 1);
 292     }
 293
 294     /// Returns the previous index. This is the index corresponding to this
 295     /// index's slot, but for the previous instruction.
 296     SlotIndex getPrevIndex() const {
 297       return SlotIndex(entry().getPrev(), getSlot());
 298     }
 299
 300   };
 301
 302   /// DenseMapInfo specialization for SlotIndex.
 303   template <>
 304   struct DenseMapInfo<SlotIndex> {
 305     static inline SlotIndex getEmptyKey() {
 306       return SlotIndex::getEmptyKey();
 307     }
 308     static inline SlotIndex getTombstoneKey() {
 309       return SlotIndex::getTombstoneKey();
 310     }
 311     static inline unsigned getHashValue(const SlotIndex &v) {
 312       return SlotIndex::getHashValue(v);
 313     }
 314     static inline bool isEqual(const SlotIndex &LHS, const SlotIndex &RHS) {
 315       return (LHS == RHS);
 316     }
 317   };
 318
 319   template <> struct isPodLike<SlotIndex> { static const bool value = true; };
 320
 321
 322   inline raw_ostream& operator<<(raw_ostream &os, SlotIndex li) {
 323     li.print(os);
 324     return os;
 325   }
 326
 327   typedef std::pair<SlotIndex, MachineBasicBlock*> IdxMBBPair;
 328
 329   inline bool operator<(SlotIndex V, const IdxMBBPair &IM) {
 330     return V < IM.first;
 331   }
 332
 333   inline bool operator<(const IdxMBBPair &IM, SlotIndex V) {
 334     return IM.first < V;
 335   }
 336
 337   struct Idx2MBBCompare {
 338     bool operator()(const IdxMBBPair &LHS, const IdxMBBPair &RHS) const {
 339       return LHS.first < RHS.first;
 340     }
 341   };
 342
 343   /// SlotIndexes pass.
 344   ///
 345   /// This pass assigns indexes to each instruction.
 346   class SlotIndexes : public MachineFunctionPass {
 347   private:
 348
 349     MachineFunction *mf;
 350     IndexListEntry *indexListHead;
 351     unsigned functionSize;
 352
 353     typedef DenseMap<const MachineInstr*, SlotIndex> Mi2IndexMap;
 354     Mi2IndexMap mi2iMap;
 355
 356     /// MBBRanges - Map MBB number to (start, stop) indexes.
 357     SmallVector<std::pair<SlotIndex, SlotIndex>, 8> MBBRanges;
 358
 359     /// Idx2MBBMap - Sorted list of pairs of index of first instruction
 360     /// and MBB id.
 361     SmallVector<IdxMBBPair, 8> idx2MBBMap;
 362
 363     // IndexListEntry allocator.
 364     BumpPtrAllocator ileAllocator;
 365
 366     IndexListEntry* createEntry(MachineInstr *mi, unsigned index) {
 367       IndexListEntry *entry =
 368         static_cast<IndexListEntry*>(
 369           ileAllocator.Allocate(sizeof(IndexListEntry),
 370           alignOf<IndexListEntry>()));
 371
 372       new (entry) IndexListEntry(mi, index);
 373
 374       return entry;
 375     }
 376
 377     void initList() {
 378       assert(indexListHead == 0 && "Zero entry non-null at initialisation.");
 379       indexListHead = createEntry(0, ~0U);
 380       indexListHead->setNext(0);
 381       indexListHead->setPrev(indexListHead);
 382     }
 383
 384     void clearList() {
 385       indexListHead = 0;
 386       ileAllocator.Reset();
 387     }
 388
 389     IndexListEntry* getTail() {
 390       assert(indexListHead != 0 && "Call to getTail on uninitialized list.");
 391       return indexListHead->getPrev();
 392     }
 393
 394     const IndexListEntry* getTail() const {
 395       assert(indexListHead != 0 && "Call to getTail on uninitialized list.");
 396       return indexListHead->getPrev();
 397     }
 398
 399     // Returns true if the index list is empty.
 400     bool empty() const { return (indexListHead == getTail()); }
 401
 402     IndexListEntry* front() {
 403       assert(!empty() && "front() called on empty index list.");
 404       return indexListHead;
 405     }
 406
 407     const IndexListEntry* front() const {
 408       assert(!empty() && "front() called on empty index list.");
 409       return indexListHead;
 410     }
 411
 412     IndexListEntry* back() {
 413       assert(!empty() && "back() called on empty index list.");
 414       return getTail()->getPrev();
 415     }
 416
 417     const IndexListEntry* back() const {
 418       assert(!empty() && "back() called on empty index list.");
 419       return getTail()->getPrev();
 420     }
 421
 422     /// Insert a new entry before itr.
 423     void insert(IndexListEntry *itr, IndexListEntry *val) {
 424       assert(itr != 0 && "itr should not be null.");
 425       IndexListEntry *prev = itr->getPrev();
 426       val->setNext(itr);
 427       val->setPrev(prev);
 428
 429       if (itr != indexListHead) {
 430         prev->setNext(val);
 431       }
 432       else {
 433         indexListHead = val;
 434       }
 435       itr->setPrev(val);
 436     }
 437
 438     /// Push a new entry on to the end of the list.
 439     void push_back(IndexListEntry *val) {
 440       insert(getTail(), val);
 441     }
 442
 443     /// Renumber locally after inserting newEntry.
 444     void renumberIndexes(IndexListEntry *newEntry);
 445
 446   public:
 447     static char ID;
 448
 449     SlotIndexes() : MachineFunctionPass(ID), indexListHead(0) {
 450       initializeSlotIndexesPass(*PassRegistry::getPassRegistry());
 451     }
 452
 453     virtual void getAnalysisUsage(AnalysisUsage &au) const;
 454     virtual void releaseMemory();
 455
 456     virtual bool runOnMachineFunction(MachineFunction &fn);
 457
 458     /// Dump the indexes.
 459     void dump() const;
 460
 461     /// Renumber the index list, providing space for new instructions.
 462     void renumberIndexes();
 463
 464     /// Returns the zero index for this analysis.
 465     SlotIndex getZeroIndex() {
 466       assert(front()->getIndex() == 0 && "First index is not 0?");
 467       return SlotIndex(front(), 0);
 468     }
 469
 470     /// Returns the base index of the last slot in this analysis.
 471     SlotIndex getLastIndex() {
 472       return SlotIndex(back(), 0);
 473     }
 474
 475     /// Returns the distance between the highest and lowest indexes allocated
 476     /// so far.
 477     unsigned getIndexesLength() const {
 478       assert(front()->getIndex() == 0 &&
 479              "Initial index isn't zero?");
 480
 481       return back()->getIndex();
 482     }
 483
 484     /// Returns the number of instructions in the function.
 485     unsigned getFunctionSize() const {
 486       return functionSize;
 487     }
 488
 489     /// Returns true if the given machine instr is mapped to an index,
 490     /// otherwise returns false.
 491     bool hasIndex(const MachineInstr *instr) const {
 492       return mi2iMap.count(instr);
 493     }
 494
 495     /// Returns the base index for the given instruction.
 496     SlotIndex getInstructionIndex(const MachineInstr *instr) const {
 497       Mi2IndexMap::const_iterator itr = mi2iMap.find(instr);
 498       assert(itr != mi2iMap.end() && "Instruction not found in maps.");
 499       return itr->second;
 500     }
 501
 502     /// Returns the instruction for the given index, or null if the given
 503     /// index has no instruction associated with it.
 504     MachineInstr* getInstructionFromIndex(SlotIndex index) const {
 505       return index.isValid() ? index.entry().getInstr() : 0;
 506     }
 507
 508     /// Returns the next non-null index.
 509     SlotIndex getNextNonNullIndex(SlotIndex index) {
 510       SlotIndex nextNonNull = index.getNextIndex();
 511
 512       while (&nextNonNull.entry() != getTail() &&
 513              getInstructionFromIndex(nextNonNull) == 0) {
 514         nextNonNull = nextNonNull.getNextIndex();
 515       }
 516
 517       return nextNonNull;
 518     }
 519
 520     /// getIndexBefore - Returns the index of the last indexed instruction
 521     /// before MI, or the the start index of its basic block.
 522     /// MI is not required to have an index.
 523     SlotIndex getIndexBefore(const MachineInstr *MI) const {
 524       const MachineBasicBlock *MBB = MI->getParent();
 525       assert(MBB && "MI must be inserted inna basic block");
 526       MachineBasicBlock::const_iterator I = MI, B = MBB->begin();
 527       for (;;) {
 528         if (I == B)
 529           return getMBBStartIdx(MBB);
 530         --I;
 531         Mi2IndexMap::const_iterator MapItr = mi2iMap.find(I);
 532         if (MapItr != mi2iMap.end())
 533           return MapItr->second;
 534       }
 535     }
 536
 537     /// getIndexAfter - Returns the index of the first indexed instruction
 538     /// after MI, or the end index of its basic block.
 539     /// MI is not required to have an index.
 540     SlotIndex getIndexAfter(const MachineInstr *MI) const {
 541       const MachineBasicBlock *MBB = MI->getParent();
 542       assert(MBB && "MI must be inserted inna basic block");
 543       MachineBasicBlock::const_iterator I = MI, E = MBB->end();
 544       for (;;) {
 545         ++I;
 546         if (I == E)
 547           return getMBBEndIdx(MBB);
 548         Mi2IndexMap::const_iterator MapItr = mi2iMap.find(I);
 549         if (MapItr != mi2iMap.end())
 550           return MapItr->second;
 551       }
 552     }
 553
 554     /// Return the (start,end) range of the given basic block number.
 555     const std::pair<SlotIndex, SlotIndex> &
 556     getMBBRange(unsigned Num) const {
 557       return MBBRanges[Num];
 558     }
 559
 560     /// Return the (start,end) range of the given basic block.
 561     const std::pair<SlotIndex, SlotIndex> &
 562     getMBBRange(const MachineBasicBlock *MBB) const {
 563       return getMBBRange(MBB->getNumber());
 564     }
 565
 566     /// Returns the first index in the given basic block number.
 567     SlotIndex getMBBStartIdx(unsigned Num) const {
 568       return getMBBRange(Num).first;
 569     }
 570
 571     /// Returns the first index in the given basic block.
 572     SlotIndex getMBBStartIdx(const MachineBasicBlock *mbb) const {
 573       return getMBBRange(mbb).first;
 574     }
 575
 576     /// Returns the last index in the given basic block number.
 577     SlotIndex getMBBEndIdx(unsigned Num) const {
 578       return getMBBRange(Num).second;
 579     }
 580
 581     /// Returns the last index in the given basic block.
 582     SlotIndex getMBBEndIdx(const MachineBasicBlock *mbb) const {
 583       return getMBBRange(mbb).second;
 584     }
 585
 586     /// Returns the basic block which the given index falls in.
 587     MachineBasicBlock* getMBBFromIndex(SlotIndex index) const {
 588       if (MachineInstr *MI = getInstructionFromIndex(index))
 589         return MI->getParent();
 590       SmallVectorImpl<IdxMBBPair>::const_iterator I =
 591         std::lower_bound(idx2MBBMap.begin(), idx2MBBMap.end(), index);
 592       // Take the pair containing the index
 593       SmallVectorImpl<IdxMBBPair>::const_iterator J =
 594         ((I != idx2MBBMap.end() && I->first > index) ||
 595          (I == idx2MBBMap.end() && idx2MBBMap.size()>0)) ? (I-1): I;
 596
 597       assert(J != idx2MBBMap.end() && J->first <= index &&
 598              index < getMBBEndIdx(J->second) &&
 599              "index does not correspond to an MBB");
 600       return J->second;
 601     }
 602
 603     bool findLiveInMBBs(SlotIndex start, SlotIndex end,
 604                         SmallVectorImpl<MachineBasicBlock*> &mbbs) const {
 605       SmallVectorImpl<IdxMBBPair>::const_iterator itr =
 606         std::lower_bound(idx2MBBMap.begin(), idx2MBBMap.end(), start);
 607       bool resVal = false;
 608
 609       while (itr != idx2MBBMap.end()) {
 610         if (itr->first >= end)
 611           break;
 612         mbbs.push_back(itr->second);
 613         resVal = true;
 614         ++itr;
 615       }
 616       return resVal;
 617     }
 618
 619     /// Returns the MBB covering the given range, or null if the range covers
 620     /// more than one basic block.
 621     MachineBasicBlock* getMBBCoveringRange(SlotIndex start, SlotIndex end) const {
 622
 623       assert(start < end && "Backwards ranges not allowed.");
 624
 625       SmallVectorImpl<IdxMBBPair>::const_iterator itr =
 626         std::lower_bound(idx2MBBMap.begin(), idx2MBBMap.end(), start);
 627
 628       if (itr == idx2MBBMap.end()) {
 629         itr = prior(itr);
 630         return itr->second;
 631       }
 632
 633       // Check that we don't cross the boundary into this block.
 634       if (itr->first < end)
 635         return 0;
 636
 637       itr = prior(itr);
 638
 639       if (itr->first <= start)
 640         return itr->second;
 641
 642       return 0;
 643     }
 644
 645     /// Insert the given machine instruction into the mapping. Returns the
 646     /// assigned index.
 647     /// If Late is set and there are null indexes between mi's neighboring
 648     /// instructions, create the new index after the null indexes instead of
 649     /// before them.
 650     SlotIndex insertMachineInstrInMaps(MachineInstr *mi, bool Late = false) {
 651       assert(mi2iMap.find(mi) == mi2iMap.end() && "Instr already indexed.");
 652       // Numbering DBG_VALUE instructions could cause code generation to be
 653       // affected by debug information.
 654       assert(!mi->isDebugValue() && "Cannot number DBG_VALUE instructions.");
 655
 656       assert(mi->getParent() != 0 && "Instr must be added to function.");
 657
 658       // Get the entries where mi should be inserted.
 659       IndexListEntry *prevEntry, *nextEntry;
 660       if (Late) {
 661         // Insert mi's index immediately before the following instruction.
 662         nextEntry = &getIndexAfter(mi).entry();
 663         prevEntry = nextEntry->getPrev();
 664       } else {
 665         // Insert mi's index immediately after the preceeding instruction.
 666         prevEntry = &getIndexBefore(mi).entry();
 667         nextEntry = prevEntry->getNext();
 668       }
 669
 670       // Get a number for the new instr, or 0 if there's no room currently.
 671       // In the latter case we'll force a renumber later.
 672       unsigned dist = ((nextEntry->getIndex() - prevEntry->getIndex())/2) & ~3u;
 673       unsigned newNumber = prevEntry->getIndex() + dist;
 674
 675       // Insert a new list entry for mi.
 676       IndexListEntry *newEntry = createEntry(mi, newNumber);
 677       insert(nextEntry, newEntry);
 678
 679       // Renumber locally if we need to.
 680       if (dist == 0)
 681         renumberIndexes(newEntry);
 682
 683       SlotIndex newIndex(newEntry, SlotIndex::Slot_Block);
 684       mi2iMap.insert(std::make_pair(mi, newIndex));
 685       return newIndex;
 686     }
 687
 688     /// Remove the given machine instruction from the mapping.
 689     void removeMachineInstrFromMaps(MachineInstr *mi) {
 690       // remove index -> MachineInstr and
 691       // MachineInstr -> index mappings
 692       Mi2IndexMap::iterator mi2iItr = mi2iMap.find(mi);
 693       if (mi2iItr != mi2iMap.end()) {
 694         IndexListEntry *miEntry(&mi2iItr->second.entry());
 695         assert(miEntry->getInstr() == mi && "Instruction indexes broken.");
 696         // FIXME: Eventually we want to actually delete these indexes.
 697         miEntry->setInstr(0);
 698         mi2iMap.erase(mi2iItr);
 699       }
 700     }
 701
 702     /// ReplaceMachineInstrInMaps - Replacing a machine instr with a new one in
 703     /// maps used by register allocator.
 704     void replaceMachineInstrInMaps(MachineInstr *mi, MachineInstr *newMI) {
 705       Mi2IndexMap::iterator mi2iItr = mi2iMap.find(mi);
 706       if (mi2iItr == mi2iMap.end())
 707         return;
 708       SlotIndex replaceBaseIndex = mi2iItr->second;
 709       IndexListEntry *miEntry(&replaceBaseIndex.entry());
 710       assert(miEntry->getInstr() == mi &&
 711              "Mismatched instruction in index tables.");
 712       miEntry->setInstr(newMI);
 713       mi2iMap.erase(mi2iItr);
 714       mi2iMap.insert(std::make_pair(newMI, replaceBaseIndex));
 715     }
 716
 717     /// Add the given MachineBasicBlock into the maps.
 718     void insertMBBInMaps(MachineBasicBlock *mbb) {
 719       MachineFunction::iterator nextMBB =
 720         llvm::next(MachineFunction::iterator(mbb));
 721       IndexListEntry *startEntry = createEntry(0, 0);
 722       IndexListEntry *stopEntry = createEntry(0, 0);
 723       IndexListEntry *nextEntry = 0;
 724
 725       if (nextMBB == mbb->getParent()->end()) {
 726         nextEntry = getTail();
 727       } else {
 728         nextEntry = &getMBBStartIdx(nextMBB).entry();
 729       }
 730
 731       insert(nextEntry, startEntry);
 732       insert(nextEntry, stopEntry);
 733
 734       SlotIndex startIdx(startEntry, SlotIndex::Slot_Block);
 735       SlotIndex endIdx(nextEntry, SlotIndex::Slot_Block);
 736
 737       assert(unsigned(mbb->getNumber()) == MBBRanges.size() &&
 738              "Blocks must be added in order");
 739       MBBRanges.push_back(std::make_pair(startIdx, endIdx));
 740
 741       idx2MBBMap.push_back(IdxMBBPair(startIdx, mbb));
 742
 743       renumberIndexes();
 744       std::sort(idx2MBBMap.begin(), idx2MBBMap.end(), Idx2MBBCompare());
 745     }
 746
 747   };
 748
 749
 750   // Specialize IntervalMapInfo for half-open slot index intervals.
 751   template <typename> struct IntervalMapInfo;
 752   template <> struct IntervalMapInfo<SlotIndex> {
 753     static inline bool startLess(const SlotIndex &x, const SlotIndex &a) {
 754       return x < a;
 755     }
 756     static inline bool stopLess(const SlotIndex &b, const SlotIndex &x) {
 757       return b <= x;
 758     }
 759     static inline bool adjacent(const SlotIndex &a, const SlotIndex &b) {
 760       return a == b;
 761     }
 762   };
 763
 764 }
 765
 766 #endif // LLVM_CODEGEN_LIVEINDEX_H