1//===- llvm/CodeGen/SlotIndexes.h - Slot indexes representation -*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file implements SlotIndex and related classes. The purpose of SlotIndex
10// is to describe a position at which a register can become live, or cease to
11// be live.
12//
13// SlotIndex is mostly a proxy for entries of the SlotIndexList, a class which
14// is held is LiveIntervals and provides the real numbering. This allows
15// LiveIntervals to perform largely transparent renumbering.
16//===----------------------------------------------------------------------===//
17
18#ifndef LLVM_CODEGEN_SLOTINDEXES_H
19#define LLVM_CODEGEN_SLOTINDEXES_H
20
21#include "llvm/ADT/DenseMap.h"
22#include "llvm/ADT/IntervalMap.h"
23#include "llvm/ADT/PointerIntPair.h"
24#include "llvm/ADT/SmallVector.h"
25#include "llvm/ADT/simple_ilist.h"
26#include "llvm/CodeGen/MachineBasicBlock.h"
27#include "llvm/CodeGen/MachineFunction.h"
28#include "llvm/CodeGen/MachineFunctionPass.h"
29#include "llvm/CodeGen/MachineInstr.h"
30#include "llvm/CodeGen/MachineInstrBundle.h"
31#include "llvm/CodeGen/MachinePassManager.h"
32#include "llvm/Support/Allocator.h"
33#include "llvm/Support/Compiler.h"
34#include <algorithm>
35#include <cassert>
36#include <iterator>
37#include <utility>
38
39namespace llvm {
40
41class raw_ostream;
42
43 /// This class represents an entry in the slot index list held in the
44 /// SlotIndexes pass. It should not be used directly. See the
45 /// SlotIndex & SlotIndexes classes for the public interface to this
46 /// information.
47 class IndexListEntry : public ilist_node<IndexListEntry> {
48 MachineInstr *mi;
49 unsigned index;
50
51 public:
52 IndexListEntry(MachineInstr *mi, unsigned index) : mi(mi), index(index) {}
53
54 MachineInstr* getInstr() const { return mi; }
55 void setInstr(MachineInstr *mi) {
56 this->mi = mi;
57 }
58
59 unsigned getIndex() const { return index; }
60 void setIndex(unsigned index) {
61 this->index = index;
62 }
63 };
64
65 /// SlotIndex - An opaque wrapper around machine indexes.
66 class SlotIndex {
67 friend class SlotIndexes;
68
69 enum Slot {
70 /// Basic block boundary. Used for live ranges entering and leaving a
71 /// block without being live in the layout neighbor. Also used as the
72 /// def slot of PHI-defs.
73 Slot_Block,
74
75 /// Early-clobber register use/def slot. A live range defined at
76 /// Slot_EarlyClobber interferes with normal live ranges killed at
77 /// Slot_Register. Also used as the kill slot for live ranges tied to an
78 /// early-clobber def.
79 Slot_EarlyClobber,
80
81 /// Normal register use/def slot. Normal instructions kill and define
82 /// register live ranges at this slot.
83 Slot_Register,
84
85 /// Dead def kill point. Kill slot for a live range that is defined by
86 /// the same instruction (Slot_Register or Slot_EarlyClobber), but isn't
87 /// used anywhere.
88 Slot_Dead,
89
90 Slot_Count
91 };
92
93 PointerIntPair<IndexListEntry*, 2, unsigned> lie;
94
95 SlotIndex(IndexListEntry *entry, unsigned slot) : lie(entry, slot) {}
96
97 IndexListEntry* listEntry() const {
98 assert(isValid() && "Attempt to compare reserved index.");
99 return lie.getPointer();
100 }
101
102 unsigned getIndex() const {
103 return listEntry()->getIndex() | getSlot();
104 }
105
106 /// Returns the slot for this SlotIndex.
107 Slot getSlot() const {
108 return static_cast<Slot>(lie.getInt());
109 }
110
111 public:
112 enum {
113 /// The default distance between instructions as returned by distance().
114 /// This may vary as instructions are inserted and removed.
115 InstrDist = 4 * Slot_Count
116 };
117
118 /// Construct an invalid index.
119 SlotIndex() = default;
120
121 // Construct a new slot index from the given one, and set the slot.
122 SlotIndex(const SlotIndex &li, Slot s) : lie(li.listEntry(), unsigned(s)) {
123 assert(isValid() && "Attempt to construct index with 0 pointer.");
124 }
125
126 /// Returns true if this is a valid index. Invalid indices do
127 /// not point into an index table, and cannot be compared.
128 bool isValid() const {
129 return lie.getPointer();
130 }
131
132 /// Return true for a valid index.
133 explicit operator bool() const { return isValid(); }
134
135 /// Print this index to the given raw_ostream.
136 LLVM_ABI void print(raw_ostream &os) const;
137
138 /// Dump this index to stderr.
139 LLVM_ABI void dump() const;
140
141 /// Compare two SlotIndex objects for equality.
142 bool operator==(SlotIndex other) const {
143 return lie == other.lie;
144 }
145 /// Compare two SlotIndex objects for inequality.
146 bool operator!=(SlotIndex other) const {
147 return lie != other.lie;
148 }
149
150 /// Compare two SlotIndex objects. Return true if the first index
151 /// is strictly lower than the second.
152 bool operator<(SlotIndex other) const {
153 return getIndex() < other.getIndex();
154 }
155 /// Compare two SlotIndex objects. Return true if the first index
156 /// is lower than, or equal to, the second.
157 bool operator<=(SlotIndex other) const {
158 return getIndex() <= other.getIndex();
159 }
160
161 /// Compare two SlotIndex objects. Return true if the first index
162 /// is greater than the second.
163 bool operator>(SlotIndex other) const {
164 return getIndex() > other.getIndex();
165 }
166
167 /// Compare two SlotIndex objects. Return true if the first index
168 /// is greater than, or equal to, the second.
169 bool operator>=(SlotIndex other) const {
170 return getIndex() >= other.getIndex();
171 }
172
173 /// isSameInstr - Return true if A and B refer to the same instruction.
174 static bool isSameInstr(SlotIndex A, SlotIndex B) {
175 return A.listEntry() == B.listEntry();
176 }
177
178 /// isEarlierInstr - Return true if A refers to an instruction earlier than
179 /// B. This is equivalent to A < B && !isSameInstr(A, B).
180 static bool isEarlierInstr(SlotIndex A, SlotIndex B) {
181 return A.listEntry()->getIndex() < B.listEntry()->getIndex();
182 }
183
184 /// Return true if A refers to the same instruction as B or an earlier one.
185 /// This is equivalent to !isEarlierInstr(B, A).
186 static bool isEarlierEqualInstr(SlotIndex A, SlotIndex B) {
187 return !isEarlierInstr(A: B, B: A);
188 }
189
190 /// Return the distance from this index to the given one.
191 int distance(SlotIndex other) const {
192 return other.getIndex() - getIndex();
193 }
194
195 /// Return the scaled distance from this index to the given one, where all
196 /// slots on the same instruction have zero distance, assuming that the slot
197 /// indices are packed as densely as possible. There are normally gaps
198 /// between instructions, so this assumption often doesn't hold. This
199 /// results in this function often returning a value greater than the actual
200 /// instruction distance.
201 int getApproxInstrDistance(SlotIndex other) const {
202 return (other.listEntry()->getIndex() - listEntry()->getIndex())
203 / Slot_Count;
204 }
205
206 /// isBlock - Returns true if this is a block boundary slot.
207 bool isBlock() const { return getSlot() == Slot_Block; }
208
209 /// isEarlyClobber - Returns true if this is an early-clobber slot.
210 bool isEarlyClobber() const { return getSlot() == Slot_EarlyClobber; }
211
212 /// isRegister - Returns true if this is a normal register use/def slot.
213 /// Note that early-clobber slots may also be used for uses and defs.
214 bool isRegister() const { return getSlot() == Slot_Register; }
215
216 /// isDead - Returns true if this is a dead def kill slot.
217 bool isDead() const { return getSlot() == Slot_Dead; }
218
219 /// Returns the base index for associated with this index. The base index
220 /// is the one associated with the Slot_Block slot for the instruction
221 /// pointed to by this index.
222 SlotIndex getBaseIndex() const {
223 return SlotIndex(listEntry(), Slot_Block);
224 }
225
226 /// Returns the boundary index for associated with this index. The boundary
227 /// index is the one associated with the Slot_Block slot for the instruction
228 /// pointed to by this index.
229 SlotIndex getBoundaryIndex() const {
230 return SlotIndex(listEntry(), Slot_Dead);
231 }
232
233 /// Returns the register use/def slot in the current instruction for a
234 /// normal or early-clobber def.
235 SlotIndex getRegSlot(bool EC = false) const {
236 return SlotIndex(listEntry(), EC ? Slot_EarlyClobber : Slot_Register);
237 }
238
239 /// Returns the dead def kill slot for the current instruction.
240 SlotIndex getDeadSlot() const {
241 return SlotIndex(listEntry(), Slot_Dead);
242 }
243
244 /// Returns the next slot in the index list. This could be either the
245 /// next slot for the instruction pointed to by this index or, if this
246 /// index is a STORE, the first slot for the next instruction.
247 /// WARNING: This method is considerably more expensive than the methods
248 /// that return specific slots (getUseIndex(), etc). If you can - please
249 /// use one of those methods.
250 SlotIndex getNextSlot() const {
251 Slot s = getSlot();
252 if (s == Slot_Dead) {
253 return SlotIndex(&*++listEntry()->getIterator(), Slot_Block);
254 }
255 return SlotIndex(listEntry(), s + 1);
256 }
257
258 /// Returns the next index. This is the index corresponding to the this
259 /// index's slot, but for the next instruction.
260 SlotIndex getNextIndex() const {
261 return SlotIndex(&*++listEntry()->getIterator(), getSlot());
262 }
263
264 /// Returns the previous slot in the index list. This could be either the
265 /// previous slot for the instruction pointed to by this index or, if this
266 /// index is a Slot_Block, the last slot for the previous instruction.
267 /// WARNING: This method is considerably more expensive than the methods
268 /// that return specific slots (getUseIndex(), etc). If you can - please
269 /// use one of those methods.
270 SlotIndex getPrevSlot() const {
271 Slot s = getSlot();
272 if (s == Slot_Block) {
273 return SlotIndex(&*--listEntry()->getIterator(), Slot_Dead);
274 }
275 return SlotIndex(listEntry(), s - 1);
276 }
277
278 /// Returns the previous index. This is the index corresponding to this
279 /// index's slot, but for the previous instruction.
280 SlotIndex getPrevIndex() const {
281 return SlotIndex(&*--listEntry()->getIterator(), getSlot());
282 }
283 };
284
285 inline raw_ostream& operator<<(raw_ostream &os, SlotIndex li) {
286 li.print(os);
287 return os;
288 }
289
290 using IdxMBBPair = std::pair<SlotIndex, MachineBasicBlock *>;
291
292 /// SlotIndexes pass.
293 ///
294 /// This pass assigns indexes to each instruction.
295 class SlotIndexes {
296 friend class SlotIndexesWrapperPass;
297
298 private:
299 // IndexListEntry allocator.
300 BumpPtrAllocator ileAllocator;
301
302 using IndexList = simple_ilist<IndexListEntry>;
303 IndexList indexList;
304
305 MachineFunction *mf = nullptr;
306
307 using Mi2IndexMap = DenseMap<const MachineInstr *, SlotIndex>;
308 Mi2IndexMap mi2iMap;
309
310 /// MBBRanges - Map analysis block number to (start, stop) indexes.
311 SmallVector<std::pair<SlotIndex, SlotIndex>, 8> MBBRanges;
312
313 /// Idx2MBBMap - Sorted list of pairs of index of first instruction
314 /// and MBB id.
315 SmallVector<IdxMBBPair, 8> idx2MBBMap;
316
317 // For legacy pass manager.
318 SlotIndexes() = default;
319
320 LLVM_ABI void clear();
321
322 LLVM_ABI void analyze(MachineFunction &MF);
323
324 IndexListEntry* createEntry(MachineInstr *mi, unsigned index) {
325 IndexListEntry *entry =
326 static_cast<IndexListEntry *>(ileAllocator.Allocate(
327 Size: sizeof(IndexListEntry), Alignment: alignof(IndexListEntry)));
328
329 new (entry) IndexListEntry(mi, index);
330
331 return entry;
332 }
333
334 /// Renumber locally after inserting curItr.
335 LLVM_ABI void renumberIndexes(IndexList::iterator curItr);
336
337 public:
338 SlotIndexes(SlotIndexes &&) = default;
339
340 SlotIndexes(MachineFunction &MF) { analyze(MF); }
341
342 LLVM_ABI ~SlotIndexes();
343
344 void reanalyze(MachineFunction &MF) {
345 clear();
346 analyze(MF);
347 }
348
349 LLVM_ABI void print(raw_ostream &OS) const;
350
351 /// Dump the indexes.
352 LLVM_ABI void dump() const;
353
354 /// Repair indexes after adding and removing instructions.
355 LLVM_ABI void repairIndexesInRange(MachineBasicBlock *MBB,
356 MachineBasicBlock::iterator Begin,
357 MachineBasicBlock::iterator End);
358
359 /// Returns the zero index for this analysis.
360 SlotIndex getZeroIndex() {
361 assert(indexList.front().getIndex() == 0 && "First index is not 0?");
362 return SlotIndex(&indexList.front(), 0);
363 }
364
365 /// Returns the base index of the last slot in this analysis.
366 SlotIndex getLastIndex() {
367 return SlotIndex(&indexList.back(), 0);
368 }
369
370 /// Returns true if the given machine instr is mapped to an index,
371 /// otherwise returns false.
372 bool hasIndex(const MachineInstr &instr) const {
373 return mi2iMap.count(Val: &instr);
374 }
375
376 /// Returns the base index for the given instruction.
377 SlotIndex getInstructionIndex(const MachineInstr &MI,
378 bool IgnoreBundle = false) const {
379 // Instructions inside a bundle have the same number as the bundle itself.
380 auto BundleStart = getBundleStart(I: MI.getIterator());
381 auto BundleEnd = getBundleEnd(I: MI.getIterator());
382 // Use the first non-debug instruction in the bundle to get SlotIndex.
383 const MachineInstr &BundleNonDebug =
384 IgnoreBundle ? MI
385 : *skipDebugInstructionsForward(It: BundleStart, End: BundleEnd);
386 assert(!BundleNonDebug.isDebugInstr() &&
387 "Could not use a debug instruction to query mi2iMap.");
388 Mi2IndexMap::const_iterator itr = mi2iMap.find(Val: &BundleNonDebug);
389 assert(itr != mi2iMap.end() && "Instruction not found in maps.");
390 return itr->second;
391 }
392
393 /// Returns the instruction for the given index, or null if the given
394 /// index has no instruction associated with it.
395 MachineInstr* getInstructionFromIndex(SlotIndex index) const {
396 return index.listEntry()->getInstr();
397 }
398
399 /// Returns true if \p Idx refers to an entry created to mark a basic block
400 /// boundary. Such entries never have an instruction attached.
401 LLVM_ABI bool isBlockBoundaryIndex(SlotIndex Idx) const;
402
403 /// Returns true if \p Idx refers to an instruction that has been erased.
404 bool isStaleIndex(SlotIndex Idx) const {
405 return !getInstructionFromIndex(index: Idx) && !isBlockBoundaryIndex(Idx);
406 }
407
408 /// Returns the register slot of the closest instruction preceding a stale
409 /// \p Idx, or the start index of its basic block if there is none. Returns
410 /// \p Idx unchanged if it is not stale.
411 LLVM_ABI SlotIndex canonicalizeIndex(SlotIndex Idx) const;
412
413 /// Returns the next non-null index, if one exists.
414 /// Otherwise returns getLastIndex().
415 SlotIndex getNextNonNullIndex(SlotIndex Index) {
416 IndexList::iterator I = Index.listEntry()->getIterator();
417 IndexList::iterator E = indexList.end();
418 while (++I != E)
419 if (I->getInstr())
420 return SlotIndex(&*I, Index.getSlot());
421 // We reached the end of the function.
422 return getLastIndex();
423 }
424
425 /// getIndexBefore - Returns the index of the last indexed instruction
426 /// before MI, or the start index of its basic block.
427 /// MI is not required to have an index.
428 SlotIndex getIndexBefore(const MachineInstr &MI) const {
429 const MachineBasicBlock *MBB = MI.getParent();
430 assert(MBB && "MI must be inserted in a basic block");
431 MachineBasicBlock::const_iterator I = MI, B = MBB->begin();
432 while (true) {
433 if (I == B)
434 return getMBBStartIdx(mbb: MBB);
435 --I;
436 if (I->isDebugInstr())
437 continue;
438 Mi2IndexMap::const_iterator MapItr = mi2iMap.find(Val: &*I);
439 if (MapItr != mi2iMap.end())
440 return MapItr->second;
441 }
442 }
443
444 /// getIndexAfter - Returns the index of the first indexed instruction
445 /// after MI, or the end index of its basic block.
446 /// MI is not required to have an index.
447 SlotIndex getIndexAfter(const MachineInstr &MI) const {
448 const MachineBasicBlock *MBB = MI.getParent();
449 assert(MBB && "MI must be inserted in a basic block");
450 MachineBasicBlock::const_iterator I = MI, E = MBB->end();
451 while (true) {
452 ++I;
453 if (I == E)
454 return getMBBEndIdx(mbb: MBB);
455 if (I->isDebugInstr())
456 continue;
457 Mi2IndexMap::const_iterator MapItr = mi2iMap.find(Val: &*I);
458 if (MapItr != mi2iMap.end())
459 return MapItr->second;
460 }
461 }
462
463 /// Return the (start,end) range of the given basic block.
464 const std::pair<SlotIndex, SlotIndex> &
465 getMBBRange(const MachineBasicBlock *MBB) const {
466 return MBBRanges[MBB->getAnalysisNumber()];
467 }
468
469 /// Returns the first index in the given basic block.
470 SlotIndex getMBBStartIdx(const MachineBasicBlock *mbb) const {
471 return getMBBRange(MBB: mbb).first;
472 }
473
474 /// Returns the index past the last valid index in the given basic block.
475 SlotIndex getMBBEndIdx(const MachineBasicBlock *mbb) const {
476 return getMBBRange(MBB: mbb).second;
477 }
478
479 /// Returns the last valid index in the given basic block.
480 /// This index corresponds to the dead slot of the last non-debug
481 /// instruction and can be used to find live-out ranges of the block. Note
482 /// that getMBBEndIdx returns the start index of the next block, which is
483 /// also used as the start index for segments with phi-def values. If the
484 /// basic block doesn't contain any non-debug instructions, this returns
485 /// the same as getMBBStartIdx.getDeadSlot().
486 SlotIndex getMBBLastIdx(const MachineBasicBlock *MBB) const {
487 return getMBBEndIdx(mbb: MBB).getPrevSlot();
488 }
489
490 /// Iterator over the idx2MBBMap (sorted pairs of slot index of basic block
491 /// begin and basic block)
492 using MBBIndexIterator = SmallVectorImpl<IdxMBBPair>::const_iterator;
493
494 /// Get an iterator pointing to the first IdxMBBPair with SlotIndex greater
495 /// than or equal to \p Idx. If \p Start is provided, only search the range
496 /// from \p Start to the end of the function.
497 MBBIndexIterator getMBBLowerBound(MBBIndexIterator Start,
498 SlotIndex Idx) const {
499 return std::lower_bound(
500 first: Start, last: MBBIndexEnd(), val: Idx,
501 comp: [](const IdxMBBPair &IM, SlotIndex Idx) { return IM.first < Idx; });
502 }
503 MBBIndexIterator getMBBLowerBound(SlotIndex Idx) const {
504 return getMBBLowerBound(Start: MBBIndexBegin(), Idx);
505 }
506
507 /// Get an iterator pointing to the first IdxMBBPair with SlotIndex greater
508 /// than \p Idx.
509 MBBIndexIterator getMBBUpperBound(SlotIndex Idx) const {
510 return std::upper_bound(
511 first: MBBIndexBegin(), last: MBBIndexEnd(), val: Idx,
512 comp: [](SlotIndex Idx, const IdxMBBPair &IM) { return Idx < IM.first; });
513 }
514
515 /// Returns an iterator for the begin of the idx2MBBMap.
516 MBBIndexIterator MBBIndexBegin() const {
517 return idx2MBBMap.begin();
518 }
519
520 /// Return an iterator for the end of the idx2MBBMap.
521 MBBIndexIterator MBBIndexEnd() const {
522 return idx2MBBMap.end();
523 }
524
525 /// Returns the basic block which the given index falls in.
526 MachineBasicBlock* getMBBFromIndex(SlotIndex index) const {
527 if (MachineInstr *MI = getInstructionFromIndex(index))
528 return MI->getParent();
529
530 MBBIndexIterator I = std::prev(x: getMBBUpperBound(Idx: index));
531 assert(I != MBBIndexEnd() && I->first <= index &&
532 index < getMBBEndIdx(I->second) &&
533 "index does not correspond to an MBB");
534 return I->second;
535 }
536
537 /// Insert the given machine instruction into the mapping. Returns the
538 /// assigned index.
539 /// If Late is set and there are null indexes between mi's neighboring
540 /// instructions, create the new index after the null indexes instead of
541 /// before them.
542 SlotIndex insertMachineInstrInMaps(MachineInstr &MI, bool Late = false) {
543 assert(!MI.isInsideBundle() &&
544 "Instructions inside bundles should use bundle start's slot.");
545 assert(!mi2iMap.contains(&MI) && "Instr already indexed.");
546 // Numbering debug instructions could cause code generation to be
547 // affected by debug information.
548 assert(!MI.isDebugInstr() && "Cannot number debug instructions.");
549
550 assert(MI.getParent() != nullptr && "Instr must be added to function.");
551
552 // Get the entries where MI should be inserted.
553 IndexList::iterator prevItr, nextItr;
554 if (Late) {
555 // Insert MI's index immediately before the following instruction.
556 nextItr = getIndexAfter(MI).listEntry()->getIterator();
557 prevItr = std::prev(x: nextItr);
558 } else {
559 // Insert MI's index immediately after the preceding instruction.
560 prevItr = getIndexBefore(MI).listEntry()->getIterator();
561 nextItr = std::next(x: prevItr);
562 }
563
564 // Get a number for the new instr, or 0 if there's no room currently.
565 // In the latter case we'll force a renumber later.
566 unsigned dist = ((nextItr->getIndex() - prevItr->getIndex())/2) & ~3u;
567 unsigned newNumber = prevItr->getIndex() + dist;
568
569 // Insert a new list entry for MI.
570 IndexList::iterator newItr =
571 indexList.insert(I: nextItr, Node&: *createEntry(mi: &MI, index: newNumber));
572
573 // Renumber locally if we need to.
574 if (dist == 0)
575 renumberIndexes(curItr: newItr);
576
577 SlotIndex newIndex(&*newItr, SlotIndex::Slot_Block);
578 mi2iMap.insert(KV: std::make_pair(x: &MI, y&: newIndex));
579 return newIndex;
580 }
581
582 /// Removes machine instruction (bundle) \p MI from the mapping.
583 /// This should be called before MachineInstr::eraseFromParent() is used to
584 /// remove a whole bundle or an unbundled instruction.
585 /// If \p AllowBundled is set then this can be used on a bundled
586 /// instruction; however, this exists to support handleMoveIntoBundle,
587 /// and in general removeSingleMachineInstrFromMaps should be used instead.
588 LLVM_ABI void removeMachineInstrFromMaps(MachineInstr &MI,
589 bool AllowBundled = false);
590
591 /// Removes a single machine instruction \p MI from the mapping.
592 /// This should be called before MachineInstr::eraseFromBundle() is used to
593 /// remove a single instruction (out of a bundle).
594 LLVM_ABI void removeSingleMachineInstrFromMaps(MachineInstr &MI);
595
596 /// ReplaceMachineInstrInMaps - Replacing a machine instr with a new one in
597 /// maps used by register allocator. \returns the index where the new
598 /// instruction was inserted.
599 SlotIndex replaceMachineInstrInMaps(MachineInstr &MI, MachineInstr &NewMI) {
600 Mi2IndexMap::iterator mi2iItr = mi2iMap.find(Val: &MI);
601 if (mi2iItr == mi2iMap.end())
602 return SlotIndex();
603 SlotIndex replaceBaseIndex = mi2iItr->second;
604 IndexListEntry *miEntry(replaceBaseIndex.listEntry());
605 assert(miEntry->getInstr() == &MI &&
606 "Mismatched instruction in index tables.");
607 miEntry->setInstr(&NewMI);
608 mi2iMap.erase(I: mi2iItr);
609 mi2iMap.insert(KV: std::make_pair(x: &NewMI, y&: replaceBaseIndex));
610 return replaceBaseIndex;
611 }
612
613 /// Add the given MachineBasicBlock into the maps.
614 /// If it contains any instructions then they must already be in the maps.
615 /// This is used after a block has been split by moving some suffix of its
616 /// instructions into a newly created block.
617 void insertMBBInMaps(MachineBasicBlock *mbb) {
618 assert(mbb != &mbb->getParent()->front() &&
619 "Can't insert a new block at the beginning of a function.");
620 auto prevMBB = std::prev(x: MachineFunction::iterator(mbb));
621
622 // Create a new entry to be used for the start of mbb and the end of
623 // prevMBB.
624 IndexListEntry *startEntry = createEntry(mi: nullptr, index: 0);
625 IndexListEntry *endEntry = getMBBEndIdx(mbb: &*prevMBB).listEntry();
626 IndexListEntry *insEntry =
627 mbb->empty() ? endEntry
628 : getInstructionIndex(MI: mbb->front()).listEntry();
629 IndexList::iterator newItr =
630 indexList.insert(I: insEntry->getIterator(), Node&: *startEntry);
631
632 SlotIndex startIdx(startEntry, SlotIndex::Slot_Block);
633 SlotIndex endIdx(endEntry, SlotIndex::Slot_Block);
634
635 MBBRanges[prevMBB->getAnalysisNumber()].second = startIdx;
636
637 assert(unsigned(mbb->getAnalysisNumber()) == MBBRanges.size() &&
638 "Blocks must be added in order");
639 MBBRanges.push_back(Elt: std::make_pair(x&: startIdx, y&: endIdx));
640
641 renumberIndexes(curItr: newItr);
642 auto InsertPt =
643 llvm::partition_point(Range&: idx2MBBMap, P: [=](const IdxMBBPair &IM) {
644 return IM.first < startIdx;
645 });
646 idx2MBBMap.insert(I: InsertPt, Elt: IdxMBBPair(startIdx, mbb));
647 }
648
649 /// Inverse of insertMBBInMaps: merge \p MBB's slot range into its layout
650 /// predecessor and drop it from the maps. Call before erasing \p MBB and
651 /// after its instructions have been removed from the maps.
652 LLVM_ABI void removeMBBFromMaps(MachineBasicBlock &MBB);
653
654 /// Renumber all indexes using the default instruction distance.
655 LLVM_ABI void packIndexes();
656 };
657
658 // Specialize IntervalMapInfo for half-open slot index intervals.
659 template <>
660 struct IntervalMapInfo<SlotIndex> : IntervalMapHalfOpenInfo<SlotIndex> {
661 };
662
663 class SlotIndexesAnalysis : public AnalysisInfoMixin<SlotIndexesAnalysis> {
664 friend AnalysisInfoMixin<SlotIndexesAnalysis>;
665 LLVM_ABI static AnalysisKey Key;
666
667 public:
668 using Result = SlotIndexes;
669 LLVM_ABI Result run(MachineFunction &MF, MachineFunctionAnalysisManager &);
670 };
671
672 class SlotIndexesPrinterPass
673 : public RequiredPassInfoMixin<SlotIndexesPrinterPass> {
674 raw_ostream &OS;
675
676 public:
677 explicit SlotIndexesPrinterPass(raw_ostream &OS) : OS(OS) {}
678 LLVM_ABI PreservedAnalyses run(MachineFunction &MF,
679 MachineFunctionAnalysisManager &MFAM);
680 };
681
682 class LLVM_ABI SlotIndexesWrapperPass : public MachineFunctionPass {
683 SlotIndexes SI;
684
685 public:
686 static char ID;
687
688 SlotIndexesWrapperPass();
689
690 void getAnalysisUsage(AnalysisUsage &au) const override;
691 void releaseMemory() override { SI.clear(); }
692
693 bool runOnMachineFunction(MachineFunction &fn) override {
694 SI.analyze(MF&: fn);
695 return false;
696 }
697
698 SlotIndexes &getSI() { return SI; }
699 };
700
701} // end namespace llvm
702
703#endif // LLVM_CODEGEN_SLOTINDEXES_H
704