1 //===-- PeepholeOptimizer.cpp - Peephole Optimizations --------------------===//
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 // Perform peephole optimizations on the machine code:
12 // - Optimize Extensions
14 // Optimization of sign / zero extension instructions. It may be extended to
15 // handle other instructions with similar properties.
17 // On some targets, some instructions, e.g. X86 sign / zero extension, may
18 // leave the source value in the lower part of the result. This optimization
19 // will replace some uses of the pre-extension value with uses of the
20 // sub-register of the results.
22 // - Optimize Comparisons
24 // Optimization of comparison instructions. For instance, in this code:
30 // If the "sub" instruction all ready sets (or could be modified to set) the
31 // same flag that the "cmp" instruction sets and that "bz" uses, then we can
32 // eliminate the "cmp" instruction.
34 // Another instance, in this code:
36 // sub r1, r3 | sub r1, imm
37 // cmp r3, r1 or cmp r1, r3 | cmp r1, imm
40 // If the branch instruction can use flag from "sub", then we can replace
41 // "sub" with "subs" and eliminate the "cmp" instruction.
45 // Loads that can be folded into a later instruction. A load is foldable
46 // if it loads to virtual registers and the virtual register defined has
49 // - Optimize Copies and Bitcast (more generally, target specific copies):
51 // Rewrite copies and bitcasts to avoid cross register bank copies
53 // E.g., Consider the following example, where capital and lower
54 // letters denote different register file:
55 // b = copy A <-- cross-bank copy
56 // C = copy b <-- cross-bank copy
58 // b = copy A <-- cross-bank copy
59 // C = copy A <-- same-bank copy
62 // b = bitcast A <-- cross-bank copy
63 // C = bitcast b <-- cross-bank copy
65 // b = bitcast A <-- cross-bank copy
66 // C = copy A <-- same-bank copy
67 //===----------------------------------------------------------------------===//
69 #include "llvm/CodeGen/Passes.h"
70 #include "llvm/ADT/DenseMap.h"
71 #include "llvm/ADT/SmallPtrSet.h"
72 #include "llvm/ADT/SmallSet.h"
73 #include "llvm/ADT/Statistic.h"
74 #include "llvm/CodeGen/MachineDominators.h"
75 #include "llvm/CodeGen/MachineInstrBuilder.h"
76 #include "llvm/CodeGen/MachineRegisterInfo.h"
77 #include "llvm/Support/CommandLine.h"
78 #include "llvm/Support/Debug.h"
79 #include "llvm/Support/raw_ostream.h"
80 #include "llvm/Target/TargetInstrInfo.h"
81 #include "llvm/Target/TargetRegisterInfo.h"
82 #include "llvm/Target/TargetSubtargetInfo.h"
86 #define DEBUG_TYPE "peephole-opt"
88 // Optimize Extensions
90 Aggressive("aggressive-ext-opt", cl::Hidden,
91 cl::desc("Aggressive extension optimization"));
94 DisablePeephole("disable-peephole", cl::Hidden, cl::init(false),
95 cl::desc("Disable the peephole optimizer"));
98 DisableAdvCopyOpt("disable-adv-copy-opt", cl::Hidden, cl::init(false),
99 cl::desc("Disable advanced copy optimization"));
101 // Limit the number of PHI instructions to process
102 // in PeepholeOptimizer::getNextSource.
103 static cl::opt<unsigned> RewritePHILimit(
104 "rewrite-phi-limit", cl::Hidden, cl::init(10),
105 cl::desc("Limit the length of PHI chains to lookup"));
107 STATISTIC(NumReuse, "Number of extension results reused");
108 STATISTIC(NumCmps, "Number of compares eliminated");
109 STATISTIC(NumImmFold, "Number of move immediate folded");
110 STATISTIC(NumLoadFold, "Number of loads folded");
111 STATISTIC(NumSelects, "Number of selects optimized");
112 STATISTIC(NumUncoalescableCopies, "Number of uncoalescable copies optimized");
113 STATISTIC(NumRewrittenCopies, "Number of copies rewritten");
116 class ValueTrackerResult;
118 class PeepholeOptimizer : public MachineFunctionPass {
119 const TargetInstrInfo *TII;
120 const TargetRegisterInfo *TRI;
121 MachineRegisterInfo *MRI;
122 MachineDominatorTree *DT; // Machine dominator tree
125 static char ID; // Pass identification
126 PeepholeOptimizer() : MachineFunctionPass(ID) {
127 initializePeepholeOptimizerPass(*PassRegistry::getPassRegistry());
130 bool runOnMachineFunction(MachineFunction &MF) override;
132 void getAnalysisUsage(AnalysisUsage &AU) const override {
133 AU.setPreservesCFG();
134 MachineFunctionPass::getAnalysisUsage(AU);
136 AU.addRequired<MachineDominatorTree>();
137 AU.addPreserved<MachineDominatorTree>();
141 /// \brief Track Def -> Use info used for rewriting copies.
142 typedef SmallDenseMap<TargetInstrInfo::RegSubRegPair, ValueTrackerResult>
146 bool optimizeCmpInstr(MachineInstr *MI, MachineBasicBlock *MBB);
147 bool optimizeExtInstr(MachineInstr *MI, MachineBasicBlock *MBB,
148 SmallPtrSetImpl<MachineInstr*> &LocalMIs);
149 bool optimizeSelect(MachineInstr *MI,
150 SmallPtrSetImpl<MachineInstr *> &LocalMIs);
151 bool optimizeCondBranch(MachineInstr *MI);
152 bool optimizeCopyOrBitcast(MachineInstr *MI);
153 bool optimizeCoalescableCopy(MachineInstr *MI);
154 bool optimizeUncoalescableCopy(MachineInstr *MI,
155 SmallPtrSetImpl<MachineInstr *> &LocalMIs);
156 bool findNextSource(unsigned Reg, unsigned SubReg,
157 RewriteMapTy &RewriteMap);
158 bool isMoveImmediate(MachineInstr *MI,
159 SmallSet<unsigned, 4> &ImmDefRegs,
160 DenseMap<unsigned, MachineInstr*> &ImmDefMIs);
161 bool foldImmediate(MachineInstr *MI, MachineBasicBlock *MBB,
162 SmallSet<unsigned, 4> &ImmDefRegs,
163 DenseMap<unsigned, MachineInstr*> &ImmDefMIs);
164 bool isLoadFoldable(MachineInstr *MI,
165 SmallSet<unsigned, 16> &FoldAsLoadDefCandidates);
167 /// \brief Check whether \p MI is understood by the register coalescer
168 /// but may require some rewriting.
169 bool isCoalescableCopy(const MachineInstr &MI) {
170 // SubregToRegs are not interesting, because they are already register
171 // coalescer friendly.
172 return MI.isCopy() || (!DisableAdvCopyOpt &&
173 (MI.isRegSequence() || MI.isInsertSubreg() ||
174 MI.isExtractSubreg()));
177 /// \brief Check whether \p MI is a copy like instruction that is
178 /// not recognized by the register coalescer.
179 bool isUncoalescableCopy(const MachineInstr &MI) {
180 return MI.isBitcast() ||
181 (!DisableAdvCopyOpt &&
182 (MI.isRegSequenceLike() || MI.isInsertSubregLike() ||
183 MI.isExtractSubregLike()));
187 /// \brief Helper class to hold a reply for ValueTracker queries. Contains the
188 /// returned sources for a given search and the instructions where the sources
189 /// were tracked from.
190 class ValueTrackerResult {
192 /// Track all sources found by one ValueTracker query.
193 SmallVector<TargetInstrInfo::RegSubRegPair, 2> RegSrcs;
195 /// Instruction using the sources in 'RegSrcs'.
196 const MachineInstr *Inst;
199 ValueTrackerResult() : Inst(nullptr) {}
200 ValueTrackerResult(unsigned Reg, unsigned SubReg) : Inst(nullptr) {
201 addSource(Reg, SubReg);
204 bool isValid() const { return getNumSources() > 0; }
206 void setInst(const MachineInstr *I) { Inst = I; }
207 const MachineInstr *getInst() const { return Inst; }
214 void addSource(unsigned SrcReg, unsigned SrcSubReg) {
215 RegSrcs.push_back(TargetInstrInfo::RegSubRegPair(SrcReg, SrcSubReg));
218 void setSource(int Idx, unsigned SrcReg, unsigned SrcSubReg) {
219 assert(Idx < getNumSources() && "Reg pair source out of index");
220 RegSrcs[Idx] = TargetInstrInfo::RegSubRegPair(SrcReg, SrcSubReg);
223 int getNumSources() const { return RegSrcs.size(); }
225 unsigned getSrcReg(int Idx) const {
226 assert(Idx < getNumSources() && "Reg source out of index");
227 return RegSrcs[Idx].Reg;
230 unsigned getSrcSubReg(int Idx) const {
231 assert(Idx < getNumSources() && "SubReg source out of index");
232 return RegSrcs[Idx].SubReg;
235 bool operator==(const ValueTrackerResult &Other) {
236 if (Other.getInst() != getInst())
239 if (Other.getNumSources() != getNumSources())
242 for (int i = 0, e = Other.getNumSources(); i != e; ++i)
243 if (Other.getSrcReg(i) != getSrcReg(i) ||
244 Other.getSrcSubReg(i) != getSrcSubReg(i))
250 /// \brief Helper class to track the possible sources of a value defined by
251 /// a (chain of) copy related instructions.
252 /// Given a definition (instruction and definition index), this class
253 /// follows the use-def chain to find successive suitable sources.
254 /// The given source can be used to rewrite the definition into
257 /// For instance, let us consider the following snippet:
259 /// v2 = INSERT_SUBREG v1, v0, sub0
260 /// def = COPY v2.sub0
262 /// Using a ValueTracker for def = COPY v2.sub0 will give the following
263 /// suitable sources:
265 /// Then, def can be rewritten into def = COPY v0.
268 /// The current point into the use-def chain.
269 const MachineInstr *Def;
270 /// The index of the definition in Def.
272 /// The sub register index of the definition.
274 /// The register where the value can be found.
276 /// Specifiy whether or not the value tracking looks through
277 /// complex instructions. When this is false, the value tracker
278 /// bails on everything that is not a copy or a bitcast.
280 /// Note: This could have been implemented as a specialized version of
281 /// the ValueTracker class but that would have complicated the code of
282 /// the users of this class.
283 bool UseAdvancedTracking;
284 /// MachineRegisterInfo used to perform tracking.
285 const MachineRegisterInfo &MRI;
286 /// Optional TargetInstrInfo used to perform some complex
288 const TargetInstrInfo *TII;
290 /// \brief Dispatcher to the right underlying implementation of
292 ValueTrackerResult getNextSourceImpl();
293 /// \brief Specialized version of getNextSource for Copy instructions.
294 ValueTrackerResult getNextSourceFromCopy();
295 /// \brief Specialized version of getNextSource for Bitcast instructions.
296 ValueTrackerResult getNextSourceFromBitcast();
297 /// \brief Specialized version of getNextSource for RegSequence
299 ValueTrackerResult getNextSourceFromRegSequence();
300 /// \brief Specialized version of getNextSource for InsertSubreg
302 ValueTrackerResult getNextSourceFromInsertSubreg();
303 /// \brief Specialized version of getNextSource for ExtractSubreg
305 ValueTrackerResult getNextSourceFromExtractSubreg();
306 /// \brief Specialized version of getNextSource for SubregToReg
308 ValueTrackerResult getNextSourceFromSubregToReg();
309 /// \brief Specialized version of getNextSource for PHI instructions.
310 ValueTrackerResult getNextSourceFromPHI();
313 /// \brief Create a ValueTracker instance for the value defined by \p Reg.
314 /// \p DefSubReg represents the sub register index the value tracker will
315 /// track. It does not need to match the sub register index used in the
316 /// definition of \p Reg.
317 /// \p UseAdvancedTracking specifies whether or not the value tracker looks
318 /// through complex instructions. By default (false), it handles only copy
319 /// and bitcast instructions.
320 /// If \p Reg is a physical register, a value tracker constructed with
321 /// this constructor will not find any alternative source.
322 /// Indeed, when \p Reg is a physical register that constructor does not
323 /// know which definition of \p Reg it should track.
324 /// Use the next constructor to track a physical register.
325 ValueTracker(unsigned Reg, unsigned DefSubReg,
326 const MachineRegisterInfo &MRI,
327 bool UseAdvancedTracking = false,
328 const TargetInstrInfo *TII = nullptr)
329 : Def(nullptr), DefIdx(0), DefSubReg(DefSubReg), Reg(Reg),
330 UseAdvancedTracking(UseAdvancedTracking), MRI(MRI), TII(TII) {
331 if (!TargetRegisterInfo::isPhysicalRegister(Reg)) {
332 Def = MRI.getVRegDef(Reg);
333 DefIdx = MRI.def_begin(Reg).getOperandNo();
337 /// \brief Create a ValueTracker instance for the value defined by
338 /// the pair \p MI, \p DefIdx.
339 /// Unlike the other constructor, the value tracker produced by this one
340 /// may be able to find a new source when the definition is a physical
342 /// This could be useful to rewrite target specific instructions into
343 /// generic copy instructions.
344 ValueTracker(const MachineInstr &MI, unsigned DefIdx, unsigned DefSubReg,
345 const MachineRegisterInfo &MRI,
346 bool UseAdvancedTracking = false,
347 const TargetInstrInfo *TII = nullptr)
348 : Def(&MI), DefIdx(DefIdx), DefSubReg(DefSubReg),
349 UseAdvancedTracking(UseAdvancedTracking), MRI(MRI), TII(TII) {
350 assert(DefIdx < Def->getDesc().getNumDefs() &&
351 Def->getOperand(DefIdx).isReg() && "Invalid definition");
352 Reg = Def->getOperand(DefIdx).getReg();
355 /// \brief Following the use-def chain, get the next available source
356 /// for the tracked value.
357 /// \return A ValueTrackerResult containing the a set of registers
358 /// and sub registers with tracked values. A ValueTrackerResult with
359 /// an empty set of registers means no source was found.
360 ValueTrackerResult getNextSource();
362 /// \brief Get the last register where the initial value can be found.
363 /// Initially this is the register of the definition.
364 /// Then, after each successful call to getNextSource, this is the
365 /// register of the last source.
366 unsigned getReg() const { return Reg; }
370 char PeepholeOptimizer::ID = 0;
371 char &llvm::PeepholeOptimizerID = PeepholeOptimizer::ID;
372 INITIALIZE_PASS_BEGIN(PeepholeOptimizer, "peephole-opts",
373 "Peephole Optimizations", false, false)
374 INITIALIZE_PASS_DEPENDENCY(MachineDominatorTree)
375 INITIALIZE_PASS_END(PeepholeOptimizer, "peephole-opts",
376 "Peephole Optimizations", false, false)
378 /// optimizeExtInstr - If instruction is a copy-like instruction, i.e. it reads
379 /// a single register and writes a single register and it does not modify the
380 /// source, and if the source value is preserved as a sub-register of the
381 /// result, then replace all reachable uses of the source with the subreg of the
384 /// Do not generate an EXTRACT that is used only in a debug use, as this changes
385 /// the code. Since this code does not currently share EXTRACTs, just ignore all
387 bool PeepholeOptimizer::
388 optimizeExtInstr(MachineInstr *MI, MachineBasicBlock *MBB,
389 SmallPtrSetImpl<MachineInstr*> &LocalMIs) {
390 unsigned SrcReg, DstReg, SubIdx;
391 if (!TII->isCoalescableExtInstr(*MI, SrcReg, DstReg, SubIdx))
394 if (TargetRegisterInfo::isPhysicalRegister(DstReg) ||
395 TargetRegisterInfo::isPhysicalRegister(SrcReg))
398 if (MRI->hasOneNonDBGUse(SrcReg))
402 // Ensure DstReg can get a register class that actually supports
403 // sub-registers. Don't change the class until we commit.
404 const TargetRegisterClass *DstRC = MRI->getRegClass(DstReg);
405 DstRC = TRI->getSubClassWithSubReg(DstRC, SubIdx);
409 // The ext instr may be operating on a sub-register of SrcReg as well.
410 // PPC::EXTSW is a 32 -> 64-bit sign extension, but it reads a 64-bit
412 // If UseSrcSubIdx is Set, SubIdx also applies to SrcReg, and only uses of
413 // SrcReg:SubIdx should be replaced.
415 TRI->getSubClassWithSubReg(MRI->getRegClass(SrcReg), SubIdx) != nullptr;
417 // The source has other uses. See if we can replace the other uses with use of
418 // the result of the extension.
419 SmallPtrSet<MachineBasicBlock*, 4> ReachedBBs;
420 for (MachineInstr &UI : MRI->use_nodbg_instructions(DstReg))
421 ReachedBBs.insert(UI.getParent());
423 // Uses that are in the same BB of uses of the result of the instruction.
424 SmallVector<MachineOperand*, 8> Uses;
426 // Uses that the result of the instruction can reach.
427 SmallVector<MachineOperand*, 8> ExtendedUses;
429 bool ExtendLife = true;
430 for (MachineOperand &UseMO : MRI->use_nodbg_operands(SrcReg)) {
431 MachineInstr *UseMI = UseMO.getParent();
435 if (UseMI->isPHI()) {
440 // Only accept uses of SrcReg:SubIdx.
441 if (UseSrcSubIdx && UseMO.getSubReg() != SubIdx)
444 // It's an error to translate this:
446 // %reg1025 = <sext> %reg1024
448 // %reg1026 = SUBREG_TO_REG 0, %reg1024, 4
452 // %reg1025 = <sext> %reg1024
454 // %reg1027 = COPY %reg1025:4
455 // %reg1026 = SUBREG_TO_REG 0, %reg1027, 4
457 // The problem here is that SUBREG_TO_REG is there to assert that an
458 // implicit zext occurs. It doesn't insert a zext instruction. If we allow
459 // the COPY here, it will give us the value after the <sext>, not the
460 // original value of %reg1024 before <sext>.
461 if (UseMI->getOpcode() == TargetOpcode::SUBREG_TO_REG)
464 MachineBasicBlock *UseMBB = UseMI->getParent();
466 // Local uses that come after the extension.
467 if (!LocalMIs.count(UseMI))
468 Uses.push_back(&UseMO);
469 } else if (ReachedBBs.count(UseMBB)) {
470 // Non-local uses where the result of the extension is used. Always
471 // replace these unless it's a PHI.
472 Uses.push_back(&UseMO);
473 } else if (Aggressive && DT->dominates(MBB, UseMBB)) {
474 // We may want to extend the live range of the extension result in order
475 // to replace these uses.
476 ExtendedUses.push_back(&UseMO);
478 // Both will be live out of the def MBB anyway. Don't extend live range of
479 // the extension result.
485 if (ExtendLife && !ExtendedUses.empty())
486 // Extend the liveness of the extension result.
487 Uses.append(ExtendedUses.begin(), ExtendedUses.end());
489 // Now replace all uses.
490 bool Changed = false;
492 SmallPtrSet<MachineBasicBlock*, 4> PHIBBs;
494 // Look for PHI uses of the extended result, we don't want to extend the
495 // liveness of a PHI input. It breaks all kinds of assumptions down
496 // stream. A PHI use is expected to be the kill of its source values.
497 for (MachineInstr &UI : MRI->use_nodbg_instructions(DstReg))
499 PHIBBs.insert(UI.getParent());
501 const TargetRegisterClass *RC = MRI->getRegClass(SrcReg);
502 for (unsigned i = 0, e = Uses.size(); i != e; ++i) {
503 MachineOperand *UseMO = Uses[i];
504 MachineInstr *UseMI = UseMO->getParent();
505 MachineBasicBlock *UseMBB = UseMI->getParent();
506 if (PHIBBs.count(UseMBB))
509 // About to add uses of DstReg, clear DstReg's kill flags.
511 MRI->clearKillFlags(DstReg);
512 MRI->constrainRegClass(DstReg, DstRC);
515 unsigned NewVR = MRI->createVirtualRegister(RC);
516 MachineInstr *Copy = BuildMI(*UseMBB, UseMI, UseMI->getDebugLoc(),
517 TII->get(TargetOpcode::COPY), NewVR)
518 .addReg(DstReg, 0, SubIdx);
519 // SubIdx applies to both SrcReg and DstReg when UseSrcSubIdx is set.
521 Copy->getOperand(0).setSubReg(SubIdx);
522 Copy->getOperand(0).setIsUndef();
524 UseMO->setReg(NewVR);
533 /// optimizeCmpInstr - If the instruction is a compare and the previous
534 /// instruction it's comparing against all ready sets (or could be modified to
535 /// set) the same flag as the compare, then we can remove the comparison and use
536 /// the flag from the previous instruction.
537 bool PeepholeOptimizer::optimizeCmpInstr(MachineInstr *MI,
538 MachineBasicBlock *MBB) {
539 // If this instruction is a comparison against zero and isn't comparing a
540 // physical register, we can try to optimize it.
541 unsigned SrcReg, SrcReg2;
542 int CmpMask, CmpValue;
543 if (!TII->analyzeCompare(MI, SrcReg, SrcReg2, CmpMask, CmpValue) ||
544 TargetRegisterInfo::isPhysicalRegister(SrcReg) ||
545 (SrcReg2 != 0 && TargetRegisterInfo::isPhysicalRegister(SrcReg2)))
548 // Attempt to optimize the comparison instruction.
549 if (TII->optimizeCompareInstr(MI, SrcReg, SrcReg2, CmpMask, CmpValue, MRI)) {
557 /// Optimize a select instruction.
558 bool PeepholeOptimizer::optimizeSelect(MachineInstr *MI,
559 SmallPtrSetImpl<MachineInstr *> &LocalMIs) {
561 unsigned FalseOp = 0;
562 bool Optimizable = false;
563 SmallVector<MachineOperand, 4> Cond;
564 if (TII->analyzeSelect(MI, Cond, TrueOp, FalseOp, Optimizable))
568 if (!TII->optimizeSelect(MI, LocalMIs))
570 MI->eraseFromParent();
575 /// \brief Check if a simpler conditional branch can be
577 bool PeepholeOptimizer::optimizeCondBranch(MachineInstr *MI) {
578 return TII->optimizeCondBranch(MI);
581 /// \brief Check if the registers defined by the pair (RegisterClass, SubReg)
582 /// share the same register file.
583 static bool shareSameRegisterFile(const TargetRegisterInfo &TRI,
584 const TargetRegisterClass *DefRC,
586 const TargetRegisterClass *SrcRC,
587 unsigned SrcSubReg) {
588 // Same register class.
592 // Both operands are sub registers. Check if they share a register class.
593 unsigned SrcIdx, DefIdx;
594 if (SrcSubReg && DefSubReg)
595 return TRI.getCommonSuperRegClass(SrcRC, SrcSubReg, DefRC, DefSubReg,
596 SrcIdx, DefIdx) != nullptr;
597 // At most one of the register is a sub register, make it Src to avoid
598 // duplicating the test.
600 std::swap(DefSubReg, SrcSubReg);
601 std::swap(DefRC, SrcRC);
604 // One of the register is a sub register, check if we can get a superclass.
606 return TRI.getMatchingSuperRegClass(SrcRC, DefRC, SrcSubReg) != nullptr;
608 return TRI.getCommonSubClass(DefRC, SrcRC) != nullptr;
611 /// \brief Try to find the next source that share the same register file
612 /// for the value defined by \p Reg and \p SubReg.
613 /// When true is returned, the \p RewriteMap can be used by the client to
614 /// retrieve all Def -> Use along the way up to the next source. Any found
615 /// Use that is not itself a key for another entry, is the next source to
616 /// use. During the search for the next source, multiple sources can be found
617 /// given multiple incoming sources of a PHI instruction. In this case, we
618 /// look in each PHI source for the next source; all found next sources must
619 /// share the same register file as \p Reg and \p SubReg. The client should
620 /// then be capable to rewrite all intermediate PHIs to get the next source.
621 /// \return False if no alternative sources are available. True otherwise.
622 bool PeepholeOptimizer::findNextSource(unsigned Reg, unsigned SubReg,
623 RewriteMapTy &RewriteMap) {
624 // Do not try to find a new source for a physical register.
625 // So far we do not have any motivating example for doing that.
626 // Thus, instead of maintaining untested code, we will revisit that if
627 // that changes at some point.
628 if (TargetRegisterInfo::isPhysicalRegister(Reg))
630 const TargetRegisterClass *DefRC = MRI->getRegClass(Reg);
632 SmallVector<TargetInstrInfo::RegSubRegPair, 4> SrcToLook;
633 TargetInstrInfo::RegSubRegPair CurSrcPair(Reg, SubReg);
634 SrcToLook.push_back(CurSrcPair);
635 bool ShouldRewrite = false;
637 unsigned PHILimit = RewritePHILimit;
638 while (!SrcToLook.empty() && PHILimit) {
639 TargetInstrInfo::RegSubRegPair Pair = SrcToLook.pop_back_val();
640 // As explained above, do not handle physical registers
641 if (TargetRegisterInfo::isPhysicalRegister(Pair.Reg))
645 ValueTracker ValTracker(CurSrcPair.Reg, CurSrcPair.SubReg, *MRI,
646 !DisableAdvCopyOpt, TII);
647 ValueTrackerResult Res;
650 // Follow the chain of copies until we reach the top of the use-def chain
651 // or find a more suitable source.
652 Res = ValTracker.getNextSource();
656 // Insert the Def -> Use entry for the recently found source.
657 ValueTrackerResult CurSrcRes = RewriteMap.lookup(CurSrcPair);
658 if (CurSrcRes.isValid()) {
659 assert(CurSrcRes == Res && "ValueTrackerResult found must match");
660 // An existent entry with multiple sources is a PHI cycle we must avoid.
661 // Otherwise it's an entry with a valid next source we already found.
662 if (CurSrcRes.getNumSources() > 1) {
663 DEBUG(dbgs() << "findNextSource: found PHI cycle, aborting...\n");
668 RewriteMap.insert(std::make_pair(CurSrcPair, Res));
670 // ValueTrackerResult usually have one source unless it's the result from
671 // a PHI instruction. Add the found PHI edges to be looked up further.
672 unsigned NumSrcs = Res.getNumSources();
675 for (unsigned i = 0; i < NumSrcs; ++i)
676 SrcToLook.push_back(TargetInstrInfo::RegSubRegPair(
677 Res.getSrcReg(i), Res.getSrcSubReg(i)));
681 CurSrcPair.Reg = Res.getSrcReg(0);
682 CurSrcPair.SubReg = Res.getSrcSubReg(0);
683 // Do not extend the live-ranges of physical registers as they add
684 // constraints to the register allocator. Moreover, if we want to extend
685 // the live-range of a physical register, unlike SSA virtual register,
686 // we will have to check that they aren't redefine before the related use.
687 if (TargetRegisterInfo::isPhysicalRegister(CurSrcPair.Reg))
690 const TargetRegisterClass *SrcRC = MRI->getRegClass(CurSrcPair.Reg);
692 // If this source does not incur a cross register bank copy, use it.
693 ShouldRewrite = shareSameRegisterFile(*TRI, DefRC, SubReg, SrcRC,
695 } while (!ShouldRewrite);
697 // Continue looking for new sources...
702 DEBUG(dbgs() << "findNextSource: PHI limit reached\n");
706 // Do not continue searching for a new source if the there's at least
707 // one use-def which cannot be rewritten.
712 // If we did not find a more suitable source, there is nothing to optimize.
713 if (CurSrcPair.Reg == Reg)
719 /// \brief Insert a PHI instruction with incoming edges \p SrcRegs that are
720 /// guaranteed to have the same register class. This is necessary whenever we
721 /// successfully traverse a PHI instruction and find suitable sources coming
722 /// from its edges. By inserting a new PHI, we provide a rewritten PHI def
723 /// suitable to be used in a new COPY instruction.
725 insertPHI(MachineRegisterInfo *MRI, const TargetInstrInfo *TII,
726 const SmallVectorImpl<TargetInstrInfo::RegSubRegPair> &SrcRegs,
727 MachineInstr *OrigPHI) {
728 assert(!SrcRegs.empty() && "No sources to create a PHI instruction?");
730 const TargetRegisterClass *NewRC = MRI->getRegClass(SrcRegs[0].Reg);
731 unsigned NewVR = MRI->createVirtualRegister(NewRC);
732 MachineBasicBlock *MBB = OrigPHI->getParent();
733 MachineInstrBuilder MIB = BuildMI(*MBB, OrigPHI, OrigPHI->getDebugLoc(),
734 TII->get(TargetOpcode::PHI), NewVR);
736 unsigned MBBOpIdx = 2;
737 for (auto RegPair : SrcRegs) {
738 MIB.addReg(RegPair.Reg, 0, RegPair.SubReg);
739 MIB.addMBB(OrigPHI->getOperand(MBBOpIdx).getMBB());
740 // Since we're extended the lifetime of RegPair.Reg, clear the
741 // kill flags to account for that and make RegPair.Reg reaches
743 MRI->clearKillFlags(RegPair.Reg);
751 /// \brief Helper class to rewrite the arguments of a copy-like instruction.
754 /// The copy-like instruction.
755 MachineInstr &CopyLike;
756 /// The index of the source being rewritten.
757 unsigned CurrentSrcIdx;
760 CopyRewriter(MachineInstr &MI) : CopyLike(MI), CurrentSrcIdx(0) {}
762 virtual ~CopyRewriter() {}
764 /// \brief Get the next rewritable source (SrcReg, SrcSubReg) and
765 /// the related value that it affects (TrackReg, TrackSubReg).
766 /// A source is considered rewritable if its register class and the
767 /// register class of the related TrackReg may not be register
768 /// coalescer friendly. In other words, given a copy-like instruction
769 /// not all the arguments may be returned at rewritable source, since
770 /// some arguments are none to be register coalescer friendly.
772 /// Each call of this method moves the current source to the next
773 /// rewritable source.
774 /// For instance, let CopyLike be the instruction to rewrite.
775 /// CopyLike has one definition and one source:
776 /// dst.dstSubIdx = CopyLike src.srcSubIdx.
778 /// The first call will give the first rewritable source, i.e.,
779 /// the only source this instruction has:
780 /// (SrcReg, SrcSubReg) = (src, srcSubIdx).
781 /// This source defines the whole definition, i.e.,
782 /// (TrackReg, TrackSubReg) = (dst, dstSubIdx).
784 /// The second and subsequent calls will return false, has there is only one
785 /// rewritable source.
787 /// \return True if a rewritable source has been found, false otherwise.
788 /// The output arguments are valid if and only if true is returned.
789 virtual bool getNextRewritableSource(unsigned &SrcReg, unsigned &SrcSubReg,
791 unsigned &TrackSubReg) {
792 // If CurrentSrcIdx == 1, this means this function has already been
793 // called once. CopyLike has one defintiion and one argument, thus,
794 // there is nothing else to rewrite.
795 if (!CopyLike.isCopy() || CurrentSrcIdx == 1)
797 // This is the first call to getNextRewritableSource.
798 // Move the CurrentSrcIdx to remember that we made that call.
800 // The rewritable source is the argument.
801 const MachineOperand &MOSrc = CopyLike.getOperand(1);
802 SrcReg = MOSrc.getReg();
803 SrcSubReg = MOSrc.getSubReg();
804 // What we track are the alternative sources of the definition.
805 const MachineOperand &MODef = CopyLike.getOperand(0);
806 TrackReg = MODef.getReg();
807 TrackSubReg = MODef.getSubReg();
811 /// \brief Rewrite the current source with \p NewReg and \p NewSubReg
813 /// \return True if the rewriting was possible, false otherwise.
814 virtual bool RewriteCurrentSource(unsigned NewReg, unsigned NewSubReg) {
815 if (!CopyLike.isCopy() || CurrentSrcIdx != 1)
817 DEBUG(dbgs() << "-- RewriteCurrentSource\n");
818 DEBUG(dbgs() << " Replacing: " << CopyLike);
819 MachineOperand &MOSrc = CopyLike.getOperand(CurrentSrcIdx);
820 MOSrc.setReg(NewReg);
821 MOSrc.setSubReg(NewSubReg);
822 DEBUG(dbgs() << " With: " << CopyLike);
826 /// \brief Given a \p Def.Reg and Def.SubReg pair, use \p RewriteMap to find
827 /// the new source to use for rewrite. If \p HandleMultipleSources is true and
828 /// multiple sources for a given \p Def are found along the way, we found a
829 /// PHI instructions that needs to be rewritten.
830 /// TODO: HandleMultipleSources should be removed once we test PHI handling
831 /// with coalescable copies.
832 TargetInstrInfo::RegSubRegPair
833 getNewSource(MachineRegisterInfo *MRI, const TargetInstrInfo *TII,
834 TargetInstrInfo::RegSubRegPair Def,
835 PeepholeOptimizer::RewriteMapTy &RewriteMap,
836 bool HandleMultipleSources = true) {
838 TargetInstrInfo::RegSubRegPair LookupSrc(Def.Reg, Def.SubReg);
840 ValueTrackerResult Res = RewriteMap.lookup(LookupSrc);
841 // If there are no entries on the map, LookupSrc is the new source.
845 // There's only one source for this definition, keep searching...
846 unsigned NumSrcs = Res.getNumSources();
848 LookupSrc.Reg = Res.getSrcReg(0);
849 LookupSrc.SubReg = Res.getSrcSubReg(0);
853 // TODO: remove once multiple srcs w/ coaslescable copies are supported.
854 if (!HandleMultipleSources)
857 // Multiple sources, recurse into each source to find a new source
858 // for it. Then, rewrite the PHI accordingly to its new edges.
859 SmallVector<TargetInstrInfo::RegSubRegPair, 4> NewPHISrcs;
860 for (unsigned i = 0; i < NumSrcs; ++i) {
861 TargetInstrInfo::RegSubRegPair PHISrc(Res.getSrcReg(i),
862 Res.getSrcSubReg(i));
863 NewPHISrcs.push_back(
864 getNewSource(MRI, TII, PHISrc, RewriteMap, HandleMultipleSources));
867 // Build the new PHI node and return its def register as the new source.
868 MachineInstr *OrigPHI = const_cast<MachineInstr *>(Res.getInst());
869 MachineInstr *NewPHI = insertPHI(MRI, TII, NewPHISrcs, OrigPHI);
870 DEBUG(dbgs() << "-- getNewSource\n");
871 DEBUG(dbgs() << " Replacing: " << *OrigPHI);
872 DEBUG(dbgs() << " With: " << *NewPHI);
873 const MachineOperand &MODef = NewPHI->getOperand(0);
874 return TargetInstrInfo::RegSubRegPair(MODef.getReg(), MODef.getSubReg());
878 return TargetInstrInfo::RegSubRegPair(0, 0);
881 /// \brief Rewrite the source found through \p Def, by using the \p RewriteMap
882 /// and create a new COPY instruction. More info about RewriteMap in
883 /// PeepholeOptimizer::findNextSource. Right now this is only used to handle
884 /// Uncoalescable copies, since they are copy like instructions that aren't
885 /// recognized by the register allocator.
886 virtual MachineInstr *
887 RewriteSource(TargetInstrInfo::RegSubRegPair Def,
888 PeepholeOptimizer::RewriteMapTy &RewriteMap) {
893 /// \brief Helper class to rewrite uncoalescable copy like instructions
894 /// into new COPY (coalescable friendly) instructions.
895 class UncoalescableRewriter : public CopyRewriter {
897 const TargetInstrInfo &TII;
898 MachineRegisterInfo &MRI;
899 /// The number of defs in the bitcast
903 UncoalescableRewriter(MachineInstr &MI, const TargetInstrInfo &TII,
904 MachineRegisterInfo &MRI)
905 : CopyRewriter(MI), TII(TII), MRI(MRI) {
906 NumDefs = MI.getDesc().getNumDefs();
909 /// \brief Get the next rewritable def source (TrackReg, TrackSubReg)
910 /// All such sources need to be considered rewritable in order to
911 /// rewrite a uncoalescable copy-like instruction. This method return
912 /// each definition that must be checked if rewritable.
914 bool getNextRewritableSource(unsigned &SrcReg, unsigned &SrcSubReg,
916 unsigned &TrackSubReg) override {
917 // Find the next non-dead definition and continue from there.
918 if (CurrentSrcIdx == NumDefs)
921 while (CopyLike.getOperand(CurrentSrcIdx).isDead()) {
923 if (CurrentSrcIdx == NumDefs)
927 // What we track are the alternative sources of the definition.
928 const MachineOperand &MODef = CopyLike.getOperand(CurrentSrcIdx);
929 TrackReg = MODef.getReg();
930 TrackSubReg = MODef.getSubReg();
936 /// \brief Rewrite the source found through \p Def, by using the \p RewriteMap
937 /// and create a new COPY instruction. More info about RewriteMap in
938 /// PeepholeOptimizer::findNextSource. Right now this is only used to handle
939 /// Uncoalescable copies, since they are copy like instructions that aren't
940 /// recognized by the register allocator.
942 RewriteSource(TargetInstrInfo::RegSubRegPair Def,
943 PeepholeOptimizer::RewriteMapTy &RewriteMap) override {
944 assert(!TargetRegisterInfo::isPhysicalRegister(Def.Reg) &&
945 "We do not rewrite physical registers");
947 // Find the new source to use in the COPY rewrite.
948 TargetInstrInfo::RegSubRegPair NewSrc =
949 getNewSource(&MRI, &TII, Def, RewriteMap);
952 const TargetRegisterClass *DefRC = MRI.getRegClass(Def.Reg);
953 unsigned NewVR = MRI.createVirtualRegister(DefRC);
955 MachineInstr *NewCopy =
956 BuildMI(*CopyLike.getParent(), &CopyLike, CopyLike.getDebugLoc(),
957 TII.get(TargetOpcode::COPY), NewVR)
958 .addReg(NewSrc.Reg, 0, NewSrc.SubReg);
960 NewCopy->getOperand(0).setSubReg(Def.SubReg);
962 NewCopy->getOperand(0).setIsUndef();
964 DEBUG(dbgs() << "-- RewriteSource\n");
965 DEBUG(dbgs() << " Replacing: " << CopyLike);
966 DEBUG(dbgs() << " With: " << *NewCopy);
967 MRI.replaceRegWith(Def.Reg, NewVR);
968 MRI.clearKillFlags(NewVR);
970 // We extended the lifetime of NewSrc.Reg, clear the kill flags to
972 MRI.clearKillFlags(NewSrc.Reg);
978 /// \brief Specialized rewriter for INSERT_SUBREG instruction.
979 class InsertSubregRewriter : public CopyRewriter {
981 InsertSubregRewriter(MachineInstr &MI) : CopyRewriter(MI) {
982 assert(MI.isInsertSubreg() && "Invalid instruction");
985 /// \brief See CopyRewriter::getNextRewritableSource.
986 /// Here CopyLike has the following form:
987 /// dst = INSERT_SUBREG Src1, Src2.src2SubIdx, subIdx.
988 /// Src1 has the same register class has dst, hence, there is
989 /// nothing to rewrite.
990 /// Src2.src2SubIdx, may not be register coalescer friendly.
991 /// Therefore, the first call to this method returns:
992 /// (SrcReg, SrcSubReg) = (Src2, src2SubIdx).
993 /// (TrackReg, TrackSubReg) = (dst, subIdx).
995 /// Subsequence calls will return false.
996 bool getNextRewritableSource(unsigned &SrcReg, unsigned &SrcSubReg,
998 unsigned &TrackSubReg) override {
999 // If we already get the only source we can rewrite, return false.
1000 if (CurrentSrcIdx == 2)
1002 // We are looking at v2 = INSERT_SUBREG v0, v1, sub0.
1004 const MachineOperand &MOInsertedReg = CopyLike.getOperand(2);
1005 SrcReg = MOInsertedReg.getReg();
1006 SrcSubReg = MOInsertedReg.getSubReg();
1007 const MachineOperand &MODef = CopyLike.getOperand(0);
1009 // We want to track something that is compatible with the
1010 // partial definition.
1011 TrackReg = MODef.getReg();
1012 if (MODef.getSubReg())
1013 // Bails if we have to compose sub-register indices.
1015 TrackSubReg = (unsigned)CopyLike.getOperand(3).getImm();
1018 bool RewriteCurrentSource(unsigned NewReg, unsigned NewSubReg) override {
1019 if (CurrentSrcIdx != 2)
1021 // We are rewriting the inserted reg.
1022 MachineOperand &MO = CopyLike.getOperand(CurrentSrcIdx);
1024 MO.setSubReg(NewSubReg);
1029 /// \brief Specialized rewriter for EXTRACT_SUBREG instruction.
1030 class ExtractSubregRewriter : public CopyRewriter {
1031 const TargetInstrInfo &TII;
1034 ExtractSubregRewriter(MachineInstr &MI, const TargetInstrInfo &TII)
1035 : CopyRewriter(MI), TII(TII) {
1036 assert(MI.isExtractSubreg() && "Invalid instruction");
1039 /// \brief See CopyRewriter::getNextRewritableSource.
1040 /// Here CopyLike has the following form:
1041 /// dst.dstSubIdx = EXTRACT_SUBREG Src, subIdx.
1042 /// There is only one rewritable source: Src.subIdx,
1043 /// which defines dst.dstSubIdx.
1044 bool getNextRewritableSource(unsigned &SrcReg, unsigned &SrcSubReg,
1046 unsigned &TrackSubReg) override {
1047 // If we already get the only source we can rewrite, return false.
1048 if (CurrentSrcIdx == 1)
1050 // We are looking at v1 = EXTRACT_SUBREG v0, sub0.
1052 const MachineOperand &MOExtractedReg = CopyLike.getOperand(1);
1053 SrcReg = MOExtractedReg.getReg();
1054 // If we have to compose sub-register indices, bails out.
1055 if (MOExtractedReg.getSubReg())
1058 SrcSubReg = CopyLike.getOperand(2).getImm();
1060 // We want to track something that is compatible with the definition.
1061 const MachineOperand &MODef = CopyLike.getOperand(0);
1062 TrackReg = MODef.getReg();
1063 TrackSubReg = MODef.getSubReg();
1067 bool RewriteCurrentSource(unsigned NewReg, unsigned NewSubReg) override {
1068 // The only source we can rewrite is the input register.
1069 if (CurrentSrcIdx != 1)
1072 CopyLike.getOperand(CurrentSrcIdx).setReg(NewReg);
1074 // If we find a source that does not require to extract something,
1075 // rewrite the operation with a copy.
1077 // Move the current index to an invalid position.
1078 // We do not want another call to this method to be able
1079 // to do any change.
1081 // Rewrite the operation as a COPY.
1082 // Get rid of the sub-register index.
1083 CopyLike.RemoveOperand(2);
1084 // Morph the operation into a COPY.
1085 CopyLike.setDesc(TII.get(TargetOpcode::COPY));
1088 CopyLike.getOperand(CurrentSrcIdx + 1).setImm(NewSubReg);
1093 /// \brief Specialized rewriter for REG_SEQUENCE instruction.
1094 class RegSequenceRewriter : public CopyRewriter {
1096 RegSequenceRewriter(MachineInstr &MI) : CopyRewriter(MI) {
1097 assert(MI.isRegSequence() && "Invalid instruction");
1100 /// \brief See CopyRewriter::getNextRewritableSource.
1101 /// Here CopyLike has the following form:
1102 /// dst = REG_SEQUENCE Src1.src1SubIdx, subIdx1, Src2.src2SubIdx, subIdx2.
1103 /// Each call will return a different source, walking all the available
1106 /// The first call returns:
1107 /// (SrcReg, SrcSubReg) = (Src1, src1SubIdx).
1108 /// (TrackReg, TrackSubReg) = (dst, subIdx1).
1110 /// The second call returns:
1111 /// (SrcReg, SrcSubReg) = (Src2, src2SubIdx).
1112 /// (TrackReg, TrackSubReg) = (dst, subIdx2).
1114 /// And so on, until all the sources have been traversed, then
1115 /// it returns false.
1116 bool getNextRewritableSource(unsigned &SrcReg, unsigned &SrcSubReg,
1118 unsigned &TrackSubReg) override {
1119 // We are looking at v0 = REG_SEQUENCE v1, sub1, v2, sub2, etc.
1121 // If this is the first call, move to the first argument.
1122 if (CurrentSrcIdx == 0) {
1125 // Otherwise, move to the next argument and check that it is valid.
1127 if (CurrentSrcIdx >= CopyLike.getNumOperands())
1130 const MachineOperand &MOInsertedReg = CopyLike.getOperand(CurrentSrcIdx);
1131 SrcReg = MOInsertedReg.getReg();
1132 // If we have to compose sub-register indices, bails out.
1133 if ((SrcSubReg = MOInsertedReg.getSubReg()))
1136 // We want to track something that is compatible with the related
1137 // partial definition.
1138 TrackSubReg = CopyLike.getOperand(CurrentSrcIdx + 1).getImm();
1140 const MachineOperand &MODef = CopyLike.getOperand(0);
1141 TrackReg = MODef.getReg();
1142 // If we have to compose sub-registers, bails.
1143 return MODef.getSubReg() == 0;
1146 bool RewriteCurrentSource(unsigned NewReg, unsigned NewSubReg) override {
1147 // We cannot rewrite out of bound operands.
1148 // Moreover, rewritable sources are at odd positions.
1149 if ((CurrentSrcIdx & 1) != 1 || CurrentSrcIdx > CopyLike.getNumOperands())
1152 MachineOperand &MO = CopyLike.getOperand(CurrentSrcIdx);
1154 MO.setSubReg(NewSubReg);
1160 /// \brief Get the appropriated CopyRewriter for \p MI.
1161 /// \return A pointer to a dynamically allocated CopyRewriter or nullptr
1162 /// if no rewriter works for \p MI.
1163 static CopyRewriter *getCopyRewriter(MachineInstr &MI,
1164 const TargetInstrInfo &TII,
1165 MachineRegisterInfo &MRI) {
1166 // Handle uncoalescable copy-like instructions.
1167 if (MI.isBitcast() || (MI.isRegSequenceLike() || MI.isInsertSubregLike() ||
1168 MI.isExtractSubregLike()))
1169 return new UncoalescableRewriter(MI, TII, MRI);
1171 switch (MI.getOpcode()) {
1174 case TargetOpcode::COPY:
1175 return new CopyRewriter(MI);
1176 case TargetOpcode::INSERT_SUBREG:
1177 return new InsertSubregRewriter(MI);
1178 case TargetOpcode::EXTRACT_SUBREG:
1179 return new ExtractSubregRewriter(MI, TII);
1180 case TargetOpcode::REG_SEQUENCE:
1181 return new RegSequenceRewriter(MI);
1183 llvm_unreachable(nullptr);
1186 /// \brief Optimize generic copy instructions to avoid cross
1187 /// register bank copy. The optimization looks through a chain of
1188 /// copies and tries to find a source that has a compatible register
1190 /// Two register classes are considered to be compatible if they share
1191 /// the same register bank.
1192 /// New copies issued by this optimization are register allocator
1193 /// friendly. This optimization does not remove any copy as it may
1194 /// overconstraint the register allocator, but replaces some operands
1196 /// \pre isCoalescableCopy(*MI) is true.
1197 /// \return True, when \p MI has been rewritten. False otherwise.
1198 bool PeepholeOptimizer::optimizeCoalescableCopy(MachineInstr *MI) {
1199 assert(MI && isCoalescableCopy(*MI) && "Invalid argument");
1200 assert(MI->getDesc().getNumDefs() == 1 &&
1201 "Coalescer can understand multiple defs?!");
1202 const MachineOperand &MODef = MI->getOperand(0);
1203 // Do not rewrite physical definitions.
1204 if (TargetRegisterInfo::isPhysicalRegister(MODef.getReg()))
1207 bool Changed = false;
1208 // Get the right rewriter for the current copy.
1209 std::unique_ptr<CopyRewriter> CpyRewriter(getCopyRewriter(*MI, *TII, *MRI));
1210 // If none exists, bails out.
1213 // Rewrite each rewritable source.
1214 unsigned SrcReg, SrcSubReg, TrackReg, TrackSubReg;
1215 while (CpyRewriter->getNextRewritableSource(SrcReg, SrcSubReg, TrackReg,
1217 // Keep track of PHI nodes and its incoming edges when looking for sources.
1218 RewriteMapTy RewriteMap;
1219 // Try to find a more suitable source. If we failed to do so, or get the
1220 // actual source, move to the next source.
1221 if (!findNextSource(TrackReg, TrackSubReg, RewriteMap))
1224 // Get the new source to rewrite. TODO: Only enable handling of multiple
1225 // sources (PHIs) once we have a motivating example and testcases for it.
1226 TargetInstrInfo::RegSubRegPair TrackPair(TrackReg, TrackSubReg);
1227 TargetInstrInfo::RegSubRegPair NewSrc = CpyRewriter->getNewSource(
1228 MRI, TII, TrackPair, RewriteMap, false /* multiple sources */);
1229 if (SrcReg == NewSrc.Reg || NewSrc.Reg == 0)
1233 if (CpyRewriter->RewriteCurrentSource(NewSrc.Reg, NewSrc.SubReg)) {
1234 // We may have extended the live-range of NewSrc, account for that.
1235 MRI->clearKillFlags(NewSrc.Reg);
1239 // TODO: We could have a clean-up method to tidy the instruction.
1240 // E.g., v0 = INSERT_SUBREG v1, v1.sub0, sub0
1242 // Currently we haven't seen motivating example for that and we
1243 // want to avoid untested code.
1244 NumRewrittenCopies += Changed;
1248 /// \brief Optimize copy-like instructions to create
1249 /// register coalescer friendly instruction.
1250 /// The optimization tries to kill-off the \p MI by looking
1251 /// through a chain of copies to find a source that has a compatible
1253 /// If such a source is found, it replace \p MI by a generic COPY
1255 /// \pre isUncoalescableCopy(*MI) is true.
1256 /// \return True, when \p MI has been optimized. In that case, \p MI has
1257 /// been removed from its parent.
1258 /// All COPY instructions created, are inserted in \p LocalMIs.
1259 bool PeepholeOptimizer::optimizeUncoalescableCopy(
1260 MachineInstr *MI, SmallPtrSetImpl<MachineInstr *> &LocalMIs) {
1261 assert(MI && isUncoalescableCopy(*MI) && "Invalid argument");
1263 // Check if we can rewrite all the values defined by this instruction.
1264 SmallVector<TargetInstrInfo::RegSubRegPair, 4> RewritePairs;
1265 // Get the right rewriter for the current copy.
1266 std::unique_ptr<CopyRewriter> CpyRewriter(getCopyRewriter(*MI, *TII, *MRI));
1267 // If none exists, bails out.
1271 // Rewrite each rewritable source by generating new COPYs. This works
1272 // differently from optimizeCoalescableCopy since it first makes sure that all
1273 // definitions can be rewritten.
1274 RewriteMapTy RewriteMap;
1275 unsigned Reg, SubReg, CopyDefReg, CopyDefSubReg;
1276 while (CpyRewriter->getNextRewritableSource(Reg, SubReg, CopyDefReg,
1278 // If a physical register is here, this is probably for a good reason.
1279 // Do not rewrite that.
1280 if (TargetRegisterInfo::isPhysicalRegister(CopyDefReg))
1283 // If we do not know how to rewrite this definition, there is no point
1284 // in trying to kill this instruction.
1285 TargetInstrInfo::RegSubRegPair Def(CopyDefReg, CopyDefSubReg);
1286 if (!findNextSource(Def.Reg, Def.SubReg, RewriteMap))
1289 RewritePairs.push_back(Def);
1292 // The change is possible for all defs, do it.
1293 for (const auto &Def : RewritePairs) {
1294 // Rewrite the "copy" in a way the register coalescer understands.
1295 MachineInstr *NewCopy = CpyRewriter->RewriteSource(Def, RewriteMap);
1296 assert(NewCopy && "Should be able to always generate a new copy");
1297 LocalMIs.insert(NewCopy);
1301 MI->eraseFromParent();
1302 ++NumUncoalescableCopies;
1306 /// isLoadFoldable - Check whether MI is a candidate for folding into a later
1307 /// instruction. We only fold loads to virtual registers and the virtual
1308 /// register defined has a single use.
1309 bool PeepholeOptimizer::isLoadFoldable(
1311 SmallSet<unsigned, 16> &FoldAsLoadDefCandidates) {
1312 if (!MI->canFoldAsLoad() || !MI->mayLoad())
1314 const MCInstrDesc &MCID = MI->getDesc();
1315 if (MCID.getNumDefs() != 1)
1318 unsigned Reg = MI->getOperand(0).getReg();
1319 // To reduce compilation time, we check MRI->hasOneNonDBGUse when inserting
1320 // loads. It should be checked when processing uses of the load, since
1321 // uses can be removed during peephole.
1322 if (!MI->getOperand(0).getSubReg() &&
1323 TargetRegisterInfo::isVirtualRegister(Reg) &&
1324 MRI->hasOneNonDBGUse(Reg)) {
1325 FoldAsLoadDefCandidates.insert(Reg);
1331 bool PeepholeOptimizer::isMoveImmediate(MachineInstr *MI,
1332 SmallSet<unsigned, 4> &ImmDefRegs,
1333 DenseMap<unsigned, MachineInstr*> &ImmDefMIs) {
1334 const MCInstrDesc &MCID = MI->getDesc();
1335 if (!MI->isMoveImmediate())
1337 if (MCID.getNumDefs() != 1)
1339 unsigned Reg = MI->getOperand(0).getReg();
1340 if (TargetRegisterInfo::isVirtualRegister(Reg)) {
1341 ImmDefMIs.insert(std::make_pair(Reg, MI));
1342 ImmDefRegs.insert(Reg);
1349 /// foldImmediate - Try folding register operands that are defined by move
1350 /// immediate instructions, i.e. a trivial constant folding optimization, if
1351 /// and only if the def and use are in the same BB.
1352 bool PeepholeOptimizer::foldImmediate(MachineInstr *MI, MachineBasicBlock *MBB,
1353 SmallSet<unsigned, 4> &ImmDefRegs,
1354 DenseMap<unsigned, MachineInstr*> &ImmDefMIs) {
1355 for (unsigned i = 0, e = MI->getDesc().getNumOperands(); i != e; ++i) {
1356 MachineOperand &MO = MI->getOperand(i);
1357 if (!MO.isReg() || MO.isDef())
1359 unsigned Reg = MO.getReg();
1360 if (!TargetRegisterInfo::isVirtualRegister(Reg))
1362 if (ImmDefRegs.count(Reg) == 0)
1364 DenseMap<unsigned, MachineInstr*>::iterator II = ImmDefMIs.find(Reg);
1365 assert(II != ImmDefMIs.end());
1366 if (TII->FoldImmediate(MI, II->second, Reg, MRI)) {
1374 bool PeepholeOptimizer::runOnMachineFunction(MachineFunction &MF) {
1375 if (skipOptnoneFunction(*MF.getFunction()))
1378 DEBUG(dbgs() << "********** PEEPHOLE OPTIMIZER **********\n");
1379 DEBUG(dbgs() << "********** Function: " << MF.getName() << '\n');
1381 if (DisablePeephole)
1384 TII = MF.getSubtarget().getInstrInfo();
1385 TRI = MF.getSubtarget().getRegisterInfo();
1386 MRI = &MF.getRegInfo();
1387 DT = Aggressive ? &getAnalysis<MachineDominatorTree>() : nullptr;
1389 bool Changed = false;
1391 for (MachineFunction::iterator I = MF.begin(), E = MF.end(); I != E; ++I) {
1392 MachineBasicBlock *MBB = &*I;
1394 bool SeenMoveImm = false;
1396 // During this forward scan, at some point it needs to answer the question
1397 // "given a pointer to an MI in the current BB, is it located before or
1398 // after the current instruction".
1399 // To perform this, the following set keeps track of the MIs already seen
1400 // during the scan, if a MI is not in the set, it is assumed to be located
1401 // after. Newly created MIs have to be inserted in the set as well.
1402 SmallPtrSet<MachineInstr*, 16> LocalMIs;
1403 SmallSet<unsigned, 4> ImmDefRegs;
1404 DenseMap<unsigned, MachineInstr*> ImmDefMIs;
1405 SmallSet<unsigned, 16> FoldAsLoadDefCandidates;
1407 for (MachineBasicBlock::iterator
1408 MII = I->begin(), MIE = I->end(); MII != MIE; ) {
1409 MachineInstr *MI = &*MII;
1410 // We may be erasing MI below, increment MII now.
1412 LocalMIs.insert(MI);
1414 // Skip debug values. They should not affect this peephole optimization.
1415 if (MI->isDebugValue())
1418 // If there exists an instruction which belongs to the following
1419 // categories, we will discard the load candidates.
1420 if (MI->isPosition() || MI->isPHI() || MI->isImplicitDef() ||
1421 MI->isKill() || MI->isInlineAsm() ||
1422 MI->hasUnmodeledSideEffects()) {
1423 FoldAsLoadDefCandidates.clear();
1426 if (MI->mayStore() || MI->isCall())
1427 FoldAsLoadDefCandidates.clear();
1429 if ((isUncoalescableCopy(*MI) &&
1430 optimizeUncoalescableCopy(MI, LocalMIs)) ||
1431 (MI->isCompare() && optimizeCmpInstr(MI, MBB)) ||
1432 (MI->isSelect() && optimizeSelect(MI, LocalMIs))) {
1439 if (MI->isConditionalBranch() && optimizeCondBranch(MI)) {
1444 if (isCoalescableCopy(*MI) && optimizeCoalescableCopy(MI)) {
1445 // MI is just rewritten.
1450 if (isMoveImmediate(MI, ImmDefRegs, ImmDefMIs)) {
1453 Changed |= optimizeExtInstr(MI, MBB, LocalMIs);
1454 // optimizeExtInstr might have created new instructions after MI
1455 // and before the already incremented MII. Adjust MII so that the
1456 // next iteration sees the new instructions.
1460 Changed |= foldImmediate(MI, MBB, ImmDefRegs, ImmDefMIs);
1463 // Check whether MI is a load candidate for folding into a later
1464 // instruction. If MI is not a candidate, check whether we can fold an
1465 // earlier load into MI.
1466 if (!isLoadFoldable(MI, FoldAsLoadDefCandidates) &&
1467 !FoldAsLoadDefCandidates.empty()) {
1468 const MCInstrDesc &MIDesc = MI->getDesc();
1469 for (unsigned i = MIDesc.getNumDefs(); i != MIDesc.getNumOperands();
1471 const MachineOperand &MOp = MI->getOperand(i);
1474 unsigned FoldAsLoadDefReg = MOp.getReg();
1475 if (FoldAsLoadDefCandidates.count(FoldAsLoadDefReg)) {
1476 // We need to fold load after optimizeCmpInstr, since
1477 // optimizeCmpInstr can enable folding by converting SUB to CMP.
1478 // Save FoldAsLoadDefReg because optimizeLoadInstr() resets it and
1479 // we need it for markUsesInDebugValueAsUndef().
1480 unsigned FoldedReg = FoldAsLoadDefReg;
1481 MachineInstr *DefMI = nullptr;
1482 MachineInstr *FoldMI = TII->optimizeLoadInstr(MI, MRI,
1486 // Update LocalMIs since we replaced MI with FoldMI and deleted
1488 DEBUG(dbgs() << "Replacing: " << *MI);
1489 DEBUG(dbgs() << " With: " << *FoldMI);
1491 LocalMIs.erase(DefMI);
1492 LocalMIs.insert(FoldMI);
1493 MI->eraseFromParent();
1494 DefMI->eraseFromParent();
1495 MRI->markUsesInDebugValueAsUndef(FoldedReg);
1496 FoldAsLoadDefCandidates.erase(FoldedReg);
1498 // MI is replaced with FoldMI.
1511 ValueTrackerResult ValueTracker::getNextSourceFromCopy() {
1512 assert(Def->isCopy() && "Invalid definition");
1513 // Copy instruction are supposed to be: Def = Src.
1514 // If someone breaks this assumption, bad things will happen everywhere.
1515 assert(Def->getNumOperands() == 2 && "Invalid number of operands");
1517 if (Def->getOperand(DefIdx).getSubReg() != DefSubReg)
1518 // If we look for a different subreg, it means we want a subreg of src.
1519 // Bails as we do not support composing subreg yet.
1520 return ValueTrackerResult();
1521 // Otherwise, we want the whole source.
1522 const MachineOperand &Src = Def->getOperand(1);
1523 return ValueTrackerResult(Src.getReg(), Src.getSubReg());
1526 ValueTrackerResult ValueTracker::getNextSourceFromBitcast() {
1527 assert(Def->isBitcast() && "Invalid definition");
1529 // Bail if there are effects that a plain copy will not expose.
1530 if (Def->hasUnmodeledSideEffects())
1531 return ValueTrackerResult();
1533 // Bitcasts with more than one def are not supported.
1534 if (Def->getDesc().getNumDefs() != 1)
1535 return ValueTrackerResult();
1536 if (Def->getOperand(DefIdx).getSubReg() != DefSubReg)
1537 // If we look for a different subreg, it means we want a subreg of the src.
1538 // Bails as we do not support composing subreg yet.
1539 return ValueTrackerResult();
1541 unsigned SrcIdx = Def->getNumOperands();
1542 for (unsigned OpIdx = DefIdx + 1, EndOpIdx = SrcIdx; OpIdx != EndOpIdx;
1544 const MachineOperand &MO = Def->getOperand(OpIdx);
1545 if (!MO.isReg() || !MO.getReg())
1547 assert(!MO.isDef() && "We should have skipped all the definitions by now");
1548 if (SrcIdx != EndOpIdx)
1549 // Multiple sources?
1550 return ValueTrackerResult();
1553 const MachineOperand &Src = Def->getOperand(SrcIdx);
1554 return ValueTrackerResult(Src.getReg(), Src.getSubReg());
1557 ValueTrackerResult ValueTracker::getNextSourceFromRegSequence() {
1558 assert((Def->isRegSequence() || Def->isRegSequenceLike()) &&
1559 "Invalid definition");
1561 if (Def->getOperand(DefIdx).getSubReg())
1562 // If we are composing subreg, bails out.
1563 // The case we are checking is Def.<subreg> = REG_SEQUENCE.
1564 // This should almost never happen as the SSA property is tracked at
1565 // the register level (as opposed to the subreg level).
1569 // is a valid SSA representation for Def.sub0 and Def.sub1, but not for
1570 // Def. Thus, it must not be generated.
1571 // However, some code could theoretically generates a single
1572 // Def.sub0 (i.e, not defining the other subregs) and we would
1574 // If we can ascertain (or force) that this never happens, we could
1575 // turn that into an assertion.
1576 return ValueTrackerResult();
1579 // We could handle the REG_SEQUENCE here, but we do not want to
1580 // duplicate the code from the generic TII.
1581 return ValueTrackerResult();
1583 SmallVector<TargetInstrInfo::RegSubRegPairAndIdx, 8> RegSeqInputRegs;
1584 if (!TII->getRegSequenceInputs(*Def, DefIdx, RegSeqInputRegs))
1585 return ValueTrackerResult();
1587 // We are looking at:
1588 // Def = REG_SEQUENCE v0, sub0, v1, sub1, ...
1589 // Check if one of the operand defines the subreg we are interested in.
1590 for (auto &RegSeqInput : RegSeqInputRegs) {
1591 if (RegSeqInput.SubIdx == DefSubReg) {
1592 if (RegSeqInput.SubReg)
1593 // Bails if we have to compose sub registers.
1594 return ValueTrackerResult();
1596 return ValueTrackerResult(RegSeqInput.Reg, RegSeqInput.SubReg);
1600 // If the subreg we are tracking is super-defined by another subreg,
1601 // we could follow this value. However, this would require to compose
1602 // the subreg and we do not do that for now.
1603 return ValueTrackerResult();
1606 ValueTrackerResult ValueTracker::getNextSourceFromInsertSubreg() {
1607 assert((Def->isInsertSubreg() || Def->isInsertSubregLike()) &&
1608 "Invalid definition");
1610 if (Def->getOperand(DefIdx).getSubReg())
1611 // If we are composing subreg, bails out.
1612 // Same remark as getNextSourceFromRegSequence.
1613 // I.e., this may be turned into an assert.
1614 return ValueTrackerResult();
1617 // We could handle the REG_SEQUENCE here, but we do not want to
1618 // duplicate the code from the generic TII.
1619 return ValueTrackerResult();
1621 TargetInstrInfo::RegSubRegPair BaseReg;
1622 TargetInstrInfo::RegSubRegPairAndIdx InsertedReg;
1623 if (!TII->getInsertSubregInputs(*Def, DefIdx, BaseReg, InsertedReg))
1624 return ValueTrackerResult();
1626 // We are looking at:
1627 // Def = INSERT_SUBREG v0, v1, sub1
1628 // There are two cases:
1629 // 1. DefSubReg == sub1, get v1.
1630 // 2. DefSubReg != sub1, the value may be available through v0.
1632 // #1 Check if the inserted register matches the required sub index.
1633 if (InsertedReg.SubIdx == DefSubReg) {
1634 return ValueTrackerResult(InsertedReg.Reg, InsertedReg.SubReg);
1636 // #2 Otherwise, if the sub register we are looking for is not partial
1637 // defined by the inserted element, we can look through the main
1639 const MachineOperand &MODef = Def->getOperand(DefIdx);
1640 // If the result register (Def) and the base register (v0) do not
1641 // have the same register class or if we have to compose
1642 // subregisters, bails out.
1643 if (MRI.getRegClass(MODef.getReg()) != MRI.getRegClass(BaseReg.Reg) ||
1645 return ValueTrackerResult();
1647 // Get the TRI and check if the inserted sub-register overlaps with the
1648 // sub-register we are tracking.
1649 const TargetRegisterInfo *TRI = MRI.getTargetRegisterInfo();
1651 (TRI->getSubRegIndexLaneMask(DefSubReg) &
1652 TRI->getSubRegIndexLaneMask(InsertedReg.SubIdx)) != 0)
1653 return ValueTrackerResult();
1654 // At this point, the value is available in v0 via the same subreg
1656 return ValueTrackerResult(BaseReg.Reg, DefSubReg);
1659 ValueTrackerResult ValueTracker::getNextSourceFromExtractSubreg() {
1660 assert((Def->isExtractSubreg() ||
1661 Def->isExtractSubregLike()) && "Invalid definition");
1662 // We are looking at:
1663 // Def = EXTRACT_SUBREG v0, sub0
1665 // Bails if we have to compose sub registers.
1666 // Indeed, if DefSubReg != 0, we would have to compose it with sub0.
1668 return ValueTrackerResult();
1671 // We could handle the EXTRACT_SUBREG here, but we do not want to
1672 // duplicate the code from the generic TII.
1673 return ValueTrackerResult();
1675 TargetInstrInfo::RegSubRegPairAndIdx ExtractSubregInputReg;
1676 if (!TII->getExtractSubregInputs(*Def, DefIdx, ExtractSubregInputReg))
1677 return ValueTrackerResult();
1679 // Bails if we have to compose sub registers.
1680 // Likewise, if v0.subreg != 0, we would have to compose v0.subreg with sub0.
1681 if (ExtractSubregInputReg.SubReg)
1682 return ValueTrackerResult();
1683 // Otherwise, the value is available in the v0.sub0.
1684 return ValueTrackerResult(ExtractSubregInputReg.Reg, ExtractSubregInputReg.SubIdx);
1687 ValueTrackerResult ValueTracker::getNextSourceFromSubregToReg() {
1688 assert(Def->isSubregToReg() && "Invalid definition");
1689 // We are looking at:
1690 // Def = SUBREG_TO_REG Imm, v0, sub0
1692 // Bails if we have to compose sub registers.
1693 // If DefSubReg != sub0, we would have to check that all the bits
1694 // we track are included in sub0 and if yes, we would have to
1695 // determine the right subreg in v0.
1696 if (DefSubReg != Def->getOperand(3).getImm())
1697 return ValueTrackerResult();
1698 // Bails if we have to compose sub registers.
1699 // Likewise, if v0.subreg != 0, we would have to compose it with sub0.
1700 if (Def->getOperand(2).getSubReg())
1701 return ValueTrackerResult();
1703 return ValueTrackerResult(Def->getOperand(2).getReg(),
1704 Def->getOperand(3).getImm());
1707 /// \brief Explore each PHI incoming operand and return its sources
1708 ValueTrackerResult ValueTracker::getNextSourceFromPHI() {
1709 assert(Def->isPHI() && "Invalid definition");
1710 ValueTrackerResult Res;
1712 // If we look for a different subreg, bails as we do not
1713 // support composing subreg yet.
1714 if (Def->getOperand(0).getSubReg() != DefSubReg)
1715 return ValueTrackerResult();
1717 // Return all register sources for PHI instructions.
1718 for (unsigned i = 1, e = Def->getNumOperands(); i < e; i += 2) {
1719 auto &MO = Def->getOperand(i);
1720 assert(MO.isReg() && "Invalid PHI instruction");
1721 Res.addSource(MO.getReg(), MO.getSubReg());
1727 ValueTrackerResult ValueTracker::getNextSourceImpl() {
1728 assert(Def && "This method needs a valid definition");
1731 (DefIdx < Def->getDesc().getNumDefs() || Def->getDesc().isVariadic()) &&
1732 Def->getOperand(DefIdx).isDef() && "Invalid DefIdx");
1734 return getNextSourceFromCopy();
1735 if (Def->isBitcast())
1736 return getNextSourceFromBitcast();
1737 // All the remaining cases involve "complex" instructions.
1738 // Bails if we did not ask for the advanced tracking.
1739 if (!UseAdvancedTracking)
1740 return ValueTrackerResult();
1741 if (Def->isRegSequence() || Def->isRegSequenceLike())
1742 return getNextSourceFromRegSequence();
1743 if (Def->isInsertSubreg() || Def->isInsertSubregLike())
1744 return getNextSourceFromInsertSubreg();
1745 if (Def->isExtractSubreg() || Def->isExtractSubregLike())
1746 return getNextSourceFromExtractSubreg();
1747 if (Def->isSubregToReg())
1748 return getNextSourceFromSubregToReg();
1750 return getNextSourceFromPHI();
1751 return ValueTrackerResult();
1754 ValueTrackerResult ValueTracker::getNextSource() {
1755 // If we reach a point where we cannot move up in the use-def chain,
1756 // there is nothing we can get.
1758 return ValueTrackerResult();
1760 ValueTrackerResult Res = getNextSourceImpl();
1761 if (Res.isValid()) {
1762 // Update definition, definition index, and subregister for the
1763 // next call of getNextSource.
1764 // Update the current register.
1765 bool OneRegSrc = Res.getNumSources() == 1;
1767 Reg = Res.getSrcReg(0);
1768 // Update the result before moving up in the use-def chain
1769 // with the instruction containing the last found sources.
1772 // If we can still move up in the use-def chain, move to the next
1774 if (!TargetRegisterInfo::isPhysicalRegister(Reg) && OneRegSrc) {
1775 Def = MRI.getVRegDef(Reg);
1776 DefIdx = MRI.def_begin(Reg).getOperandNo();
1777 DefSubReg = Res.getSrcSubReg(0);
1781 // If we end up here, this means we will not be able to find another source
1782 // for the next iteration. Make sure any new call to getNextSource bails out
1783 // early by cutting the use-def chain.