1//===-- LiveRangeEdit.cpp - Basic tools for editing a register live range -===//
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// The LiveRangeEdit class represents changes done to a virtual register when it
10// is spilled or split.
11//===----------------------------------------------------------------------===//
12
13#include "llvm/CodeGen/LiveRangeEdit.h"
14#include "llvm/ADT/Statistic.h"
15#include "llvm/CodeGen/CalcSpillWeights.h"
16#include "llvm/CodeGen/LiveIntervals.h"
17#include "llvm/CodeGen/MachineRegisterInfo.h"
18#include "llvm/CodeGen/TargetInstrInfo.h"
19#include "llvm/CodeGen/VirtRegMap.h"
20#include "llvm/Support/Debug.h"
21#include "llvm/Support/raw_ostream.h"
22
23using namespace llvm;
24
25#define DEBUG_TYPE "regalloc"
26
27STATISTIC(NumDCEDeleted, "Number of instructions deleted by DCE");
28STATISTIC(NumDCEFoldedLoads, "Number of single use loads folded after DCE");
29STATISTIC(NumFracRanges, "Number of live ranges fractured by DCE");
30STATISTIC(NumReMaterialization, "Number of instructions rematerialized");
31
32void LiveRangeEdit::Delegate::anchor() { }
33
34LiveInterval &LiveRangeEdit::createEmptyIntervalFrom(Register OldReg,
35 bool createSubRanges) {
36 Register VReg = MRI.cloneVirtualRegister(VReg: OldReg);
37 if (VRM)
38 VRM->setIsSplitFromReg(virtReg: VReg, SReg: VRM->getOriginal(VirtReg: OldReg));
39
40 LiveInterval &LI = LIS.createEmptyInterval(Reg: VReg);
41 if (Parent && !Parent->isSpillable())
42 LI.markNotSpillable();
43 if (createSubRanges) {
44 // Create empty subranges if the OldReg's interval has them. Do not create
45 // the main range here---it will be constructed later after the subranges
46 // have been finalized.
47 LiveInterval &OldLI = LIS.getInterval(Reg: OldReg);
48 VNInfo::Allocator &Alloc = LIS.getVNInfoAllocator();
49 for (LiveInterval::SubRange &S : OldLI.subranges())
50 LI.createSubRange(Allocator&: Alloc, LaneMask: S.LaneMask);
51 }
52 return LI;
53}
54
55Register LiveRangeEdit::createFrom(Register OldReg) {
56 Register VReg = MRI.cloneVirtualRegister(VReg: OldReg);
57 if (VRM) {
58 VRM->setIsSplitFromReg(virtReg: VReg, SReg: VRM->getOriginal(VirtReg: OldReg));
59 }
60 // FIXME: Getting the interval here actually computes it.
61 // In theory, this may not be what we want, but in practice
62 // the createEmptyIntervalFrom API is used when this is not
63 // the case. Generally speaking we just want to annotate the
64 // LiveInterval when it gets created but we cannot do that at
65 // the moment.
66 if (Parent && !Parent->isSpillable())
67 LIS.getInterval(Reg: VReg).markNotSpillable();
68 return VReg;
69}
70
71bool LiveRangeEdit::canRematerializeAt(Remat &RM, SlotIndex UseIdx) {
72 assert(RM.OrigMI && "No defining instruction for remattable value");
73
74 if (!TII.isReMaterializable(MI: *RM.OrigMI))
75 return false;
76
77 // Verify that all used registers are available with the same values.
78 if (!VirtRegAuxInfo::allUsesAvailableAt(MI: RM.OrigMI, UseIdx, LIS, MRI, TII))
79 return false;
80
81 return true;
82}
83
84SlotIndex LiveRangeEdit::rematerializeAt(
85 MachineBasicBlock &MBB, MachineBasicBlock::iterator MI, Register DestReg,
86 const Remat &RM, const TargetRegisterInfo &tri, bool Late, unsigned SubIdx,
87 MachineInstr *ReplaceIndexMI, LaneBitmask UsedLanes) {
88 assert(RM.OrigMI && "Invalid remat");
89 TII.reMaterialize(MBB, MI, DestReg, SubIdx, Orig: *RM.OrigMI, UsedLanes);
90 // DestReg of the cloned instruction cannot be Dead. Set isDead of DestReg
91 // to false anyway in case the isDead flag of RM.OrigMI's dest register
92 // is true.
93 (*--MI).clearRegisterDeads(Reg: DestReg);
94 Rematted.insert(Ptr: RM.ParentVNI);
95 ++NumReMaterialization;
96
97 bool EarlyClobber = MI->getOperand(i: 0).isEarlyClobber();
98 if (ReplaceIndexMI)
99 return LIS.ReplaceMachineInstrInMaps(MI&: *ReplaceIndexMI, NewMI&: *MI)
100 .getRegSlot(EC: EarlyClobber);
101 return LIS.getSlotIndexes()->insertMachineInstrInMaps(MI&: *MI, Late).getRegSlot(
102 EC: EarlyClobber);
103}
104
105void LiveRangeEdit::eraseVirtReg(Register Reg) {
106 if (TheDelegate && TheDelegate->LRE_CanEraseVirtReg(Reg))
107 LIS.removeInterval(Reg);
108}
109
110bool LiveRangeEdit::foldAsLoad(LiveInterval *LI,
111 SmallVectorImpl<MachineInstr*> &Dead) {
112 MachineInstr *DefMI = nullptr, *UseMI = nullptr;
113
114 // Check that there is a single def and a single use.
115 for (MachineOperand &MO : MRI.reg_nodbg_operands(Reg: LI->reg())) {
116 MachineInstr *MI = MO.getParent();
117 if (MO.isDef()) {
118 if (DefMI && DefMI != MI)
119 return false;
120 if (!MI->canFoldAsLoad())
121 return false;
122 DefMI = MI;
123 } else if (!MO.isUndef()) {
124 if (UseMI && UseMI != MI)
125 return false;
126 // FIXME: Targets don't know how to fold subreg uses.
127 if (MO.getSubReg())
128 return false;
129 UseMI = MI;
130 }
131 }
132 if (!DefMI || !UseMI)
133 return false;
134
135 // Since we're moving the DefMI load, make sure we're not extending any live
136 // ranges.
137 if (!VirtRegAuxInfo::allUsesAvailableAt(
138 MI: DefMI, UseIdx: LIS.getInstructionIndex(Instr: *UseMI), LIS, MRI, TII))
139 return false;
140
141 // We also need to make sure it is safe to move the load.
142 // Assume there are stores between DefMI and UseMI.
143 bool SawStore = true;
144 if (!DefMI->isSafeToMove(SawStore))
145 return false;
146
147 LLVM_DEBUG(dbgs() << "Try to fold single def: " << *DefMI
148 << " into single use: " << *UseMI);
149
150 SmallVector<unsigned, 8> Ops;
151 if (UseMI->readsWritesVirtualRegister(Reg: LI->reg(), Ops: &Ops).second)
152 return false;
153
154 MachineInstr *CopyMI = nullptr;
155 MachineInstr *FoldMI =
156 TII.foldMemoryOperand(MI&: *UseMI, Ops, LoadMI&: *DefMI, CopyMI, LIS: &LIS, VRM);
157 if (!FoldMI)
158 return false;
159 LLVM_DEBUG(dbgs() << " folded: " << *FoldMI);
160 SlotIndex FoldIdx = LIS.ReplaceMachineInstrInMaps(MI&: *UseMI, NewMI&: *FoldMI);
161 // Update the call info.
162 if (UseMI->shouldUpdateAdditionalCallInfo())
163 UseMI->getMF()->moveAdditionalCallInfo(Old: UseMI, New: FoldMI);
164 UseMI->eraseFromParent();
165 DefMI->addRegisterDead(Reg: LI->reg(), RegInfo: nullptr);
166 Dead.push_back(Elt: DefMI);
167 ++NumDCEFoldedLoads;
168 if (CopyMI) {
169 SlotIndex CopyIdx = LIS.InsertMachineInstrInMaps(MI&: *CopyMI).getRegSlot();
170 Register CopyDstReg = CopyMI->getOperand(i: 0).getReg();
171 LiveInterval &CopyDstLI = LIS.getInterval(Reg: CopyDstReg);
172
173 // The addSegment below extends CopyDstLI. If this vreg is already
174 // assigned in the LiveRegMatrix, the matrix becomes inconsistent.
175 // Notify the delegate so it can unassign and re-enqueue the vreg.
176 if (TheDelegate && CopyDstReg.isVirtual() && VRM &&
177 VRM->hasPhys(virtReg: CopyDstReg))
178 TheDelegate->LRE_WillShrinkVirtReg(CopyDstReg);
179
180 VNInfo *VNI = CopyDstLI.getNextValue(Def: CopyIdx, VNInfoAllocator&: LIS.getVNInfoAllocator());
181 CopyDstLI.addSegment(
182 S: LiveRange::Segment(CopyIdx, FoldIdx.getRegSlot(), VNI));
183
184 Register R = CopyMI->getOperand(i: 1).getReg();
185 if (R.isVirtual()) {
186 LiveInterval &SrcLI = LIS.getInterval(Reg: R);
187 LIS.shrinkToUses(li: &SrcLI);
188 } else {
189 assert(MRI.isReserved(R) && "Unexpected PhysReg in source operand!");
190 }
191 }
192 return true;
193}
194
195bool LiveRangeEdit::useIsKill(const LiveInterval &LI,
196 const MachineOperand &MO) const {
197 const MachineInstr &MI = *MO.getParent();
198 SlotIndex Idx = LIS.getInstructionIndex(Instr: MI).getRegSlot();
199 if (LI.Query(Idx).isKill())
200 return true;
201 const TargetRegisterInfo &TRI = *MRI.getTargetRegisterInfo();
202 unsigned SubReg = MO.getSubReg();
203 LaneBitmask LaneMask = TRI.getSubRegIndexLaneMask(SubIdx: SubReg);
204 for (const LiveInterval::SubRange &S : LI.subranges()) {
205 if ((S.LaneMask & LaneMask).any() && S.Query(Idx).isKill())
206 return true;
207 }
208 return false;
209}
210
211/// Find all live intervals that need to shrink, then remove the instruction.
212void LiveRangeEdit::eliminateDeadDef(MachineInstr *MI, ToShrinkSet &ToShrink) {
213 assert(MI->allDefsAreDead() && "Def isn't really dead");
214 SlotIndex Idx = LIS.getInstructionIndex(Instr: *MI).getRegSlot();
215
216 // Never delete a bundled instruction.
217 if (MI->isBundled()) {
218 // TODO: Handle deleting copy bundles
219 LLVM_DEBUG(dbgs() << "Won't delete dead bundled inst: " << Idx << '\t'
220 << *MI);
221 return;
222 }
223
224 // Never delete inline asm.
225 if (MI->isInlineAsm()) {
226 LLVM_DEBUG(dbgs() << "Won't delete: " << Idx << '\t' << *MI);
227 return;
228 }
229
230 // Use the same criteria as DeadMachineInstructionElim.
231 bool SawStore = false;
232 if (!MI->isSafeToMove(SawStore)) {
233 LLVM_DEBUG(dbgs() << "Can't delete: " << Idx << '\t' << *MI);
234 return;
235 }
236
237 LLVM_DEBUG(dbgs() << "Deleting dead def " << Idx << '\t' << *MI);
238
239 // Collect virtual registers to be erased after MI is gone.
240 SmallVector<Register, 8> RegsToErase;
241 bool ReadsPhysRegs = false;
242 bool isOrigDef = false;
243 Register Dest;
244 unsigned DestSubReg;
245 // Only optimize rematerialize case when the instruction has one def, since
246 // otherwise we could leave some dead defs in the code. This case is
247 // extremely rare.
248 if (VRM && MI->getOperand(i: 0).isReg() && MI->getOperand(i: 0).isDef() &&
249 MI->getDesc().getNumDefs() == 1) {
250 Dest = MI->getOperand(i: 0).getReg();
251 DestSubReg = MI->getOperand(i: 0).getSubReg();
252 Register Original = VRM->getOriginal(VirtReg: Dest);
253 LiveInterval &OrigLI = LIS.getInterval(Reg: Original);
254 VNInfo *OrigVNI = OrigLI.getVNInfoAt(Idx);
255 // The original live-range may have been shrunk to
256 // an empty live-range. It happens when it is dead, but
257 // we still keep it around to be able to rematerialize
258 // other values that depend on it.
259 if (OrigVNI)
260 isOrigDef = SlotIndex::isSameInstr(A: OrigVNI->def, B: Idx);
261 }
262
263 bool HasLiveVRegUses = false;
264
265 // Check for live intervals that may shrink
266 for (const MachineOperand &MO : MI->operands()) {
267 if (!MO.isReg())
268 continue;
269 Register Reg = MO.getReg();
270 if (!Reg.isVirtual()) {
271 // Check if MI reads any unreserved physregs.
272 if (Reg && MO.readsReg() && !MRI.isReserved(PhysReg: Reg))
273 ReadsPhysRegs = true;
274 else if (MO.isDef())
275 LIS.removePhysRegDefAt(Reg: Reg.asMCReg(), Pos: Idx);
276 continue;
277 }
278 LiveInterval &LI = LIS.getInterval(Reg);
279
280 // Shrink read registers, unless it is likely to be expensive and
281 // unlikely to change anything. We typically don't want to shrink the
282 // PIC base register that has lots of uses everywhere.
283 // Always shrink COPY uses that probably come from live range splitting.
284 if ((MI->readsVirtualRegister(Reg) &&
285 (MO.isDef() || TII.isCopyInstr(MI: *MI))) ||
286 (MO.readsReg() && (MRI.hasOneNonDBGUse(RegNo: Reg) || useIsKill(LI, MO))))
287 ToShrink.insert(X: &LI);
288 else if (MO.readsReg())
289 HasLiveVRegUses = true;
290
291 // Remove defined value.
292 if (MO.isDef()) {
293 if (TheDelegate && LI.getVNInfoAt(Idx) != nullptr)
294 TheDelegate->LRE_WillShrinkVirtReg(LI.reg());
295 LIS.removeVRegDefAt(LI, Pos: Idx);
296 if (LI.empty())
297 RegsToErase.push_back(Elt: Reg);
298 }
299 }
300
301 // If the dest of MI is an original reg and MI is reMaterializable,
302 // don't delete the inst. Replace the dest with a new reg, and keep
303 // the inst for remat of other siblings. The inst is saved in
304 // LiveRangeEdit::DeadRemats and will be deleted after all the
305 // allocations of the func are done. Note that if we keep the
306 // instruction with the original operands, that handles the physreg
307 // operand case (described just below) as well.
308 // However, immediately delete instructions which have unshrunk virtual
309 // register uses. That may provoke RA to split an interval at the KILL
310 // and later result in an invalid live segment end.
311 if (isOrigDef && DeadRemats && !HasLiveVRegUses &&
312 TII.isReMaterializable(MI: *MI)) {
313 LiveInterval &NewLI = createEmptyIntervalFrom(OldReg: Dest, createSubRanges: false);
314 VNInfo::Allocator &Alloc = LIS.getVNInfoAllocator();
315 VNInfo *VNI = NewLI.getNextValue(Def: Idx, VNInfoAllocator&: Alloc);
316 NewLI.addSegment(S: LiveInterval::Segment(Idx, Idx.getDeadSlot(), VNI));
317
318 if (DestSubReg) {
319 const TargetRegisterInfo *TRI = MRI.getTargetRegisterInfo();
320 auto *SR =
321 NewLI.createSubRange(Allocator&: Alloc, LaneMask: TRI->getSubRegIndexLaneMask(SubIdx: DestSubReg));
322 SR->addSegment(S: LiveInterval::Segment(Idx, Idx.getDeadSlot(),
323 SR->getNextValue(Def: Idx, VNInfoAllocator&: Alloc)));
324 }
325
326 pop_back();
327 DeadRemats->insert(Ptr: MI);
328 const TargetRegisterInfo &TRI = *MRI.getTargetRegisterInfo();
329 MI->substituteRegister(FromReg: Dest, ToReg: NewLI.reg(), SubIdx: 0, RegInfo: TRI);
330 assert(MI->registerDefIsDead(NewLI.reg(), &TRI));
331 }
332 // Currently, we don't support DCE of physreg live ranges. If MI reads
333 // any unreserved physregs, don't erase the instruction, but turn it into
334 // a KILL instead. This way, the physreg live ranges don't end up
335 // dangling.
336 // FIXME: It would be better to have something like shrinkToUses() for
337 // physregs. That could potentially enable more DCE and it would free up
338 // the physreg. It would not happen often, though.
339 else if (ReadsPhysRegs) {
340 MI->setDesc(TII.get(Opcode: TargetOpcode::KILL));
341 // Remove all operands that aren't physregs.
342 for (unsigned i = MI->getNumOperands(); i; --i) {
343 const MachineOperand &MO = MI->getOperand(i: i-1);
344 if (MO.isReg() && MO.getReg().isPhysical())
345 continue;
346 MI->removeOperand(OpNo: i-1);
347 }
348 MI->dropMemRefs(MF&: *MI->getMF());
349 LLVM_DEBUG(dbgs() << "Converted physregs to:\t" << *MI);
350 } else {
351 if (TheDelegate)
352 TheDelegate->LRE_WillEraseInstruction(MI);
353 LIS.RemoveMachineInstrFromMaps(MI&: *MI);
354 MI->eraseFromParent();
355 ++NumDCEDeleted;
356 }
357
358 // Erase any virtregs that are now empty and unused. There may be <undef>
359 // uses around. Keep the empty live range in that case.
360 for (Register Reg : RegsToErase) {
361 if (LIS.hasInterval(Reg) && MRI.reg_nodbg_empty(RegNo: Reg)) {
362 ToShrink.remove(X: &LIS.getInterval(Reg));
363 eraseVirtReg(Reg);
364 }
365 }
366}
367
368void LiveRangeEdit::eliminateDeadDefs(SmallVectorImpl<MachineInstr *> &Dead,
369 ArrayRef<Register> RegsBeingSpilled) {
370 ToShrinkSet ToShrink;
371
372 for (;;) {
373 // Erase all dead defs.
374 while (!Dead.empty())
375 eliminateDeadDef(MI: Dead.pop_back_val(), ToShrink);
376
377 if (ToShrink.empty())
378 break;
379
380 // Shrink just one live interval. Then delete new dead defs.
381 LiveInterval *LI = ToShrink.pop_back_val();
382 if (foldAsLoad(LI, Dead))
383 continue;
384 Register VReg = LI->reg();
385 if (TheDelegate)
386 TheDelegate->LRE_WillShrinkVirtReg(VReg);
387 if (!LIS.shrinkToUses(li: LI, dead: &Dead))
388 continue;
389
390 // Don't create new intervals for a register being spilled.
391 // The new intervals would have to be spilled anyway so its not worth it.
392 // Also they currently aren't spilled so creating them and not spilling
393 // them results in incorrect code.
394 if (llvm::is_contained(Range&: RegsBeingSpilled, Element: VReg))
395 continue;
396
397 // LI may have been separated, create new intervals.
398 LI->RenumberValues();
399 SmallVector<LiveInterval*, 8> SplitLIs;
400 LIS.splitSeparateComponents(LI&: *LI, SplitLIs);
401 if (!SplitLIs.empty())
402 ++NumFracRanges;
403
404 Register Original = VRM ? VRM->getOriginal(VirtReg: VReg) : Register();
405 for (const LiveInterval *SplitLI : SplitLIs) {
406 // If LI is an original interval that hasn't been split yet, make the new
407 // intervals their own originals instead of referring to LI. The original
408 // interval must contain all the split products, and LI doesn't.
409 if (Original != VReg && Original != 0)
410 VRM->setIsSplitFromReg(virtReg: SplitLI->reg(), SReg: Original);
411 if (TheDelegate)
412 TheDelegate->LRE_DidCloneVirtReg(New: SplitLI->reg(), Old: VReg);
413 }
414 }
415}
416
417// Keep track of new virtual registers created via
418// MachineRegisterInfo::createVirtualRegister.
419void
420LiveRangeEdit::MRI_NoteNewVirtualRegister(Register VReg) {
421 if (VRM)
422 VRM->grow();
423
424 NewRegs.push_back(Elt: VReg);
425}
426
427void LiveRangeEdit::calculateRegClassAndHint(MachineFunction &MF,
428 VirtRegAuxInfo &VRAI) {
429 for (unsigned I = 0, Size = size(); I < Size; ++I) {
430 LiveInterval &LI = LIS.getInterval(Reg: get(idx: I));
431 if (MRI.recomputeRegClass(Reg: LI.reg()))
432 LLVM_DEBUG({
433 const TargetRegisterInfo *TRI = MF.getSubtarget().getRegisterInfo();
434 dbgs() << "Inflated " << printReg(LI.reg()) << " to "
435 << TRI->getRegClassName(MRI.getRegClass(LI.reg())) << '\n';
436 });
437 VRAI.calculateSpillWeightAndHint(LI);
438 }
439}
440