blob: 4b72f6a84ca1c88b38227699933f42de9ee04ba2 [file] [log] [blame]
Eugene Zelenko94348112017-09-29 21:55:49 +00001//===- TwoAddressInstructionPass.cpp - Two-Address instruction pass -------===//
Alkis Evlogimenos71499de2003-12-18 13:06:04 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Alkis Evlogimenos71499de2003-12-18 13:06:04 +00007//
8//===----------------------------------------------------------------------===//
9//
Alkis Evlogimenos50c047d2004-01-04 23:09:24 +000010// This file implements the TwoAddress instruction pass which is used
11// by most register allocators. Two-Address instructions are rewritten
12// from:
13//
14// A = B op C
15//
16// to:
17//
18// A = B
Alkis Evlogimenos14be6402004-02-04 22:17:40 +000019// A op= C
Alkis Evlogimenos71499de2003-12-18 13:06:04 +000020//
Alkis Evlogimenos14be6402004-02-04 22:17:40 +000021// Note that if a register allocator chooses to use this pass, that it
22// has to be capable of handling the non-SSA nature of these rewritten
23// virtual registers.
24//
25// It is also worth noting that the duplicate operand of the two
26// address instruction is removed.
Chris Lattnerbd91c1c2004-01-31 21:07:15 +000027//
Alkis Evlogimenos71499de2003-12-18 13:06:04 +000028//===----------------------------------------------------------------------===//
29
Chandler Carruthd04a8d42012-12-03 16:50:05 +000030#include "llvm/ADT/DenseMap.h"
Eugene Zelenko94348112017-09-29 21:55:49 +000031#include "llvm/ADT/SmallPtrSet.h"
32#include "llvm/ADT/SmallSet.h"
Michael Kupersteinf1860b72016-08-11 17:38:33 +000033#include "llvm/ADT/SmallVector.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000034#include "llvm/ADT/Statistic.h"
Eugene Zelenko94348112017-09-29 21:55:49 +000035#include "llvm/ADT/iterator_range.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000036#include "llvm/Analysis/AliasAnalysis.h"
Eugene Zelenko94348112017-09-29 21:55:49 +000037#include "llvm/CodeGen/LiveInterval.h"
Matthias Braunfa621d22017-12-13 02:51:04 +000038#include "llvm/CodeGen/LiveIntervals.h"
Alkis Evlogimenos71499de2003-12-18 13:06:04 +000039#include "llvm/CodeGen/LiveVariables.h"
Eugene Zelenko94348112017-09-29 21:55:49 +000040#include "llvm/CodeGen/MachineBasicBlock.h"
41#include "llvm/CodeGen/MachineFunction.h"
Alkis Evlogimenos71499de2003-12-18 13:06:04 +000042#include "llvm/CodeGen/MachineFunctionPass.h"
43#include "llvm/CodeGen/MachineInstr.h"
Bob Wilson852a7e32010-06-15 05:56:31 +000044#include "llvm/CodeGen/MachineInstrBuilder.h"
Eugene Zelenko94348112017-09-29 21:55:49 +000045#include "llvm/CodeGen/MachineOperand.h"
Chris Lattner84bc5422007-12-31 04:13:23 +000046#include "llvm/CodeGen/MachineRegisterInfo.h"
Mehdi Aminif6071e12016-04-18 09:17:29 +000047#include "llvm/CodeGen/Passes.h"
Eugene Zelenko94348112017-09-29 21:55:49 +000048#include "llvm/CodeGen/SlotIndexes.h"
David Blaikie48319232017-11-08 01:01:31 +000049#include "llvm/CodeGen/TargetInstrInfo.h"
David Blaikiee3a9b4c2017-11-17 01:07:10 +000050#include "llvm/CodeGen/TargetOpcodes.h"
51#include "llvm/CodeGen/TargetRegisterInfo.h"
52#include "llvm/CodeGen/TargetSubtargetInfo.h"
Eugene Zelenko94348112017-09-29 21:55:49 +000053#include "llvm/MC/MCInstrDesc.h"
Evan Cheng2a4410d2011-11-14 19:48:55 +000054#include "llvm/MC/MCInstrItineraries.h"
Eugene Zelenko94348112017-09-29 21:55:49 +000055#include "llvm/Pass.h"
56#include "llvm/Support/CodeGen.h"
Andrew Tricke2326ad2013-04-24 15:54:39 +000057#include "llvm/Support/CommandLine.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000058#include "llvm/Support/Debug.h"
59#include "llvm/Support/ErrorHandling.h"
Benjamin Kramer1bfcd1f2015-03-23 19:32:43 +000060#include "llvm/Support/raw_ostream.h"
Alkis Evlogimenos71499de2003-12-18 13:06:04 +000061#include "llvm/Target/TargetMachine.h"
Eugene Zelenko94348112017-09-29 21:55:49 +000062#include <cassert>
63#include <iterator>
64#include <utility>
Eugene Zelenko380d47d2016-02-02 18:20:45 +000065
Alkis Evlogimenos71499de2003-12-18 13:06:04 +000066using namespace llvm;
67
Matthias Braun94c49042017-05-25 21:26:32 +000068#define DEBUG_TYPE "twoaddressinstruction"
Chandler Carruth8677f2f2014-04-22 02:02:50 +000069
Chris Lattnercd3245a2006-12-19 22:41:21 +000070STATISTIC(NumTwoAddressInstrs, "Number of two-address instructions");
71STATISTIC(NumCommuted , "Number of instructions commuted to coalesce");
Evan Chengd498c8f2009-01-25 03:53:59 +000072STATISTIC(NumAggrCommuted , "Number of instructions aggressively commuted");
Chris Lattnercd3245a2006-12-19 22:41:21 +000073STATISTIC(NumConvertedTo3Addr, "Number of instructions promoted to 3-address");
Evan Cheng875357d2008-03-13 06:37:55 +000074STATISTIC(Num3AddrSunk, "Number of 3-address instructions sunk");
Evan Cheng2a4410d2011-11-14 19:48:55 +000075STATISTIC(NumReSchedUps, "Number of instructions re-scheduled up");
76STATISTIC(NumReSchedDowns, "Number of instructions re-scheduled down");
Evan Cheng875357d2008-03-13 06:37:55 +000077
Andrew Tricke2326ad2013-04-24 15:54:39 +000078// Temporary flag to disable rescheduling.
79static cl::opt<bool>
80EnableRescheduling("twoaddr-reschedule",
Evan Chengd4201b62013-05-02 02:07:32 +000081 cl::desc("Coalesce copies by rescheduling (default=true)"),
82 cl::init(true), cl::Hidden);
Andrew Tricke2326ad2013-04-24 15:54:39 +000083
Taewook Oh2ce547e2017-06-29 23:11:24 +000084// Limit the number of dataflow edges to traverse when evaluating the benefit
85// of commuting operands.
86static cl::opt<unsigned> MaxDataFlowEdge(
87 "dataflow-edge-limit", cl::Hidden, cl::init(3),
88 cl::desc("Maximum number of dataflow edges to traverse when evaluating "
89 "the benefit of commuting operands"));
90
Evan Cheng875357d2008-03-13 06:37:55 +000091namespace {
Eugene Zelenko94348112017-09-29 21:55:49 +000092
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +000093class TwoAddressInstructionPass : public MachineFunctionPass {
94 MachineFunction *MF;
95 const TargetInstrInfo *TII;
96 const TargetRegisterInfo *TRI;
97 const InstrItineraryData *InstrItins;
98 MachineRegisterInfo *MRI;
99 LiveVariables *LV;
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +0000100 LiveIntervals *LIS;
101 AliasAnalysis *AA;
102 CodeGenOpt::Level OptLevel;
Evan Cheng875357d2008-03-13 06:37:55 +0000103
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +0000104 // The current basic block being processed.
105 MachineBasicBlock *MBB;
106
Sanjay Patel936f2da2015-12-01 19:32:35 +0000107 // Keep track the distance of a MI from the start of the current basic block.
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +0000108 DenseMap<MachineInstr*, unsigned> DistanceMap;
Evan Cheng870b8072009-03-01 02:03:43 +0000109
Jakob Stoklund Olesen002ef572012-10-26 22:06:00 +0000110 // Set of already processed instructions in the current block.
111 SmallPtrSet<MachineInstr*, 8> Processed;
112
Jonas Paulsson62f11d92017-12-04 10:03:14 +0000113 // Set of instructions converted to three-address by target and then sunk
114 // down current basic block.
115 SmallPtrSet<MachineInstr*, 8> SunkInstrs;
116
Sanjay Patel936f2da2015-12-01 19:32:35 +0000117 // A map from virtual registers to physical registers which are likely targets
118 // to be coalesced to due to copies from physical registers to virtual
119 // registers. e.g. v1024 = move r0.
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +0000120 DenseMap<unsigned, unsigned> SrcRegMap;
Evan Cheng870b8072009-03-01 02:03:43 +0000121
Sanjay Patel936f2da2015-12-01 19:32:35 +0000122 // A map from virtual registers to physical registers which are likely targets
123 // to be coalesced to due to copies to physical registers from virtual
124 // registers. e.g. r1 = move v1024.
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +0000125 DenseMap<unsigned, unsigned> DstRegMap;
Evan Cheng870b8072009-03-01 02:03:43 +0000126
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +0000127 bool sink3AddrInstruction(MachineInstr *MI, unsigned Reg,
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +0000128 MachineBasicBlock::iterator OldPos);
Evan Cheng7543e582008-06-18 07:49:14 +0000129
Eric Christopher63295d82015-03-03 22:03:03 +0000130 bool isRevCopyChain(unsigned FromReg, unsigned ToReg, int Maxlen);
131
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +0000132 bool noUseAfterLastDef(unsigned Reg, unsigned Dist, unsigned &LastDef);
Evan Chengd498c8f2009-01-25 03:53:59 +0000133
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +0000134 bool isProfitableToCommute(unsigned regA, unsigned regB, unsigned regC,
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +0000135 MachineInstr *MI, unsigned Dist);
Evan Chengd498c8f2009-01-25 03:53:59 +0000136
Craig Topper661e8f42016-09-11 22:10:42 +0000137 bool commuteInstruction(MachineInstr *MI, unsigned DstIdx,
Andrew Kayloraac3c942015-09-28 20:33:22 +0000138 unsigned RegBIdx, unsigned RegCIdx, unsigned Dist);
Evan Cheng870b8072009-03-01 02:03:43 +0000139
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +0000140 bool isProfitableToConv3Addr(unsigned RegA, unsigned RegB);
Evan Chenge6f350d2009-03-30 21:34:07 +0000141
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +0000142 bool convertInstTo3Addr(MachineBasicBlock::iterator &mi,
143 MachineBasicBlock::iterator &nmi,
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +0000144 unsigned RegA, unsigned RegB, unsigned Dist);
Evan Chenge6f350d2009-03-30 21:34:07 +0000145
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +0000146 bool isDefTooClose(unsigned Reg, unsigned Dist, MachineInstr *MI);
Evan Cheng2a4410d2011-11-14 19:48:55 +0000147
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +0000148 bool rescheduleMIBelowKill(MachineBasicBlock::iterator &mi,
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +0000149 MachineBasicBlock::iterator &nmi,
150 unsigned Reg);
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +0000151 bool rescheduleKillAboveMI(MachineBasicBlock::iterator &mi,
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +0000152 MachineBasicBlock::iterator &nmi,
153 unsigned Reg);
154
155 bool tryInstructionTransform(MachineBasicBlock::iterator &mi,
Evan Cheng2a4410d2011-11-14 19:48:55 +0000156 MachineBasicBlock::iterator &nmi,
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +0000157 unsigned SrcIdx, unsigned DstIdx,
Cameron Zwarichc5a63492013-02-24 00:27:26 +0000158 unsigned Dist, bool shouldOnlyCommute);
Evan Cheng2a4410d2011-11-14 19:48:55 +0000159
Andrew Kayloraac3c942015-09-28 20:33:22 +0000160 bool tryInstructionCommute(MachineInstr *MI,
161 unsigned DstOpIdx,
162 unsigned BaseOpIdx,
163 bool BaseOpKilled,
164 unsigned Dist);
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +0000165 void scanUses(unsigned DstReg);
Evan Chengf06e6c22011-03-02 01:08:17 +0000166
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +0000167 void processCopy(MachineInstr *MI);
Bob Wilsoncc80df92009-09-03 20:58:42 +0000168
Eugene Zelenko94348112017-09-29 21:55:49 +0000169 using TiedPairList = SmallVector<std::pair<unsigned, unsigned>, 4>;
170 using TiedOperandMap = SmallDenseMap<unsigned, TiedPairList>;
171
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +0000172 bool collectTiedOperands(MachineInstr *MI, TiedOperandMap&);
173 void processTiedPairs(MachineInstr *MI, TiedPairList&, unsigned &Dist);
Jakob Stoklund Olesen8c3dccd2012-12-01 01:06:44 +0000174 void eliminateRegSequence(MachineBasicBlock::iterator&);
Jakob Stoklund Olesen6ac80662012-08-03 23:25:45 +0000175
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +0000176public:
177 static char ID; // Pass identification, replacement for typeid
Eugene Zelenko94348112017-09-29 21:55:49 +0000178
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +0000179 TwoAddressInstructionPass() : MachineFunctionPass(ID) {
180 initializeTwoAddressInstructionPassPass(*PassRegistry::getPassRegistry());
181 }
Evan Chengc6dcce32010-05-17 23:24:12 +0000182
Craig Topper9f998de2014-03-07 09:26:03 +0000183 void getAnalysisUsage(AnalysisUsage &AU) const override {
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +0000184 AU.setPreservesCFG();
Ahmed Bougachabf31cb72017-05-10 00:56:00 +0000185 AU.addUsedIfAvailable<AAResultsWrapperPass>();
Matthias Braun66bbcee2016-04-28 23:42:51 +0000186 AU.addUsedIfAvailable<LiveVariables>();
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +0000187 AU.addPreserved<LiveVariables>();
188 AU.addPreserved<SlotIndexes>();
189 AU.addPreserved<LiveIntervals>();
190 AU.addPreservedID(MachineLoopInfoID);
191 AU.addPreservedID(MachineDominatorsID);
192 MachineFunctionPass::getAnalysisUsage(AU);
193 }
Devang Patel794fd752007-05-01 21:15:47 +0000194
Sanjay Patel936f2da2015-12-01 19:32:35 +0000195 /// Pass entry point.
Craig Topper9f998de2014-03-07 09:26:03 +0000196 bool runOnMachineFunction(MachineFunction&) override;
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +0000197};
Eugene Zelenko94348112017-09-29 21:55:49 +0000198
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +0000199} // end anonymous namespace
Alkis Evlogimenos71499de2003-12-18 13:06:04 +0000200
Dan Gohman844731a2008-05-13 00:00:25 +0000201char TwoAddressInstructionPass::ID = 0;
Eugene Zelenko94348112017-09-29 21:55:49 +0000202
203char &llvm::TwoAddressInstructionPassID = TwoAddressInstructionPass::ID;
204
Matthias Braun94c49042017-05-25 21:26:32 +0000205INITIALIZE_PASS_BEGIN(TwoAddressInstructionPass, DEBUG_TYPE,
Owen Anderson2ab36d32010-10-12 19:48:12 +0000206 "Two-Address instruction pass", false, false)
Chandler Carruth91468332015-09-09 17:55:00 +0000207INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass)
Matthias Braun94c49042017-05-25 21:26:32 +0000208INITIALIZE_PASS_END(TwoAddressInstructionPass, DEBUG_TYPE,
Owen Andersonce665bd2010-10-07 22:25:06 +0000209 "Two-Address instruction pass", false, false)
Dan Gohman844731a2008-05-13 00:00:25 +0000210
Cameron Zwarich4c579422013-02-23 04:49:20 +0000211static bool isPlainlyKilled(MachineInstr *MI, unsigned Reg, LiveIntervals *LIS);
212
Sanjay Patel936f2da2015-12-01 19:32:35 +0000213/// A two-address instruction has been converted to a three-address instruction
214/// to avoid clobbering a register. Try to sink it past the instruction that
215/// would kill the above mentioned register to reduce register pressure.
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +0000216bool TwoAddressInstructionPass::
217sink3AddrInstruction(MachineInstr *MI, unsigned SavedReg,
218 MachineBasicBlock::iterator OldPos) {
Eli Friedmanbde81d52011-09-23 22:41:57 +0000219 // FIXME: Shouldn't we be trying to do this before we three-addressify the
220 // instruction? After this transformation is done, we no longer need
221 // the instruction to be in three-address form.
222
Evan Cheng875357d2008-03-13 06:37:55 +0000223 // Check if it's safe to move this instruction.
224 bool SeenStore = true; // Be conservative.
Matthias Braundfc41db2015-05-19 21:22:20 +0000225 if (!MI->isSafeToMove(AA, SeenStore))
Evan Cheng875357d2008-03-13 06:37:55 +0000226 return false;
227
228 unsigned DefReg = 0;
229 SmallSet<unsigned, 4> UseRegs;
Bill Wendling637980e2008-05-10 00:12:52 +0000230
Craig Topper96d2d442015-10-08 06:06:42 +0000231 for (const MachineOperand &MO : MI->operands()) {
Dan Gohmand735b802008-10-03 15:45:36 +0000232 if (!MO.isReg())
Evan Cheng875357d2008-03-13 06:37:55 +0000233 continue;
234 unsigned MOReg = MO.getReg();
235 if (!MOReg)
236 continue;
237 if (MO.isUse() && MOReg != SavedReg)
238 UseRegs.insert(MO.getReg());
239 if (!MO.isDef())
240 continue;
241 if (MO.isImplicit())
242 // Don't try to move it if it implicitly defines a register.
243 return false;
244 if (DefReg)
245 // For now, don't move any instructions that define multiple registers.
246 return false;
247 DefReg = MO.getReg();
248 }
249
250 // Find the instruction that kills SavedReg.
Craig Topper4ba84432014-04-14 00:51:57 +0000251 MachineInstr *KillMI = nullptr;
Cameron Zwarich4c579422013-02-23 04:49:20 +0000252 if (LIS) {
253 LiveInterval &LI = LIS->getInterval(SavedReg);
254 assert(LI.end() != LI.begin() &&
255 "Reg should not have empty live interval.");
256
257 SlotIndex MBBEndIdx = LIS->getMBBEndIdx(MBB).getPrevSlot();
258 LiveInterval::const_iterator I = LI.find(MBBEndIdx);
259 if (I != LI.end() && I->start < MBBEndIdx)
260 return false;
261
262 --I;
263 KillMI = LIS->getInstructionFromIndex(I->end);
264 }
265 if (!KillMI) {
Craig Topper96d2d442015-10-08 06:06:42 +0000266 for (MachineOperand &UseMO : MRI->use_nodbg_operands(SavedReg)) {
Cameron Zwarich4c579422013-02-23 04:49:20 +0000267 if (!UseMO.isKill())
268 continue;
269 KillMI = UseMO.getParent();
270 break;
271 }
Evan Cheng875357d2008-03-13 06:37:55 +0000272 }
Bill Wendling637980e2008-05-10 00:12:52 +0000273
Eli Friedmanbde81d52011-09-23 22:41:57 +0000274 // If we find the instruction that kills SavedReg, and it is in an
275 // appropriate location, we can try to sink the current instruction
276 // past it.
277 if (!KillMI || KillMI->getParent() != MBB || KillMI == MI ||
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +0000278 MachineBasicBlock::iterator(KillMI) == OldPos || KillMI->isTerminator())
Evan Cheng875357d2008-03-13 06:37:55 +0000279 return false;
280
Bill Wendling637980e2008-05-10 00:12:52 +0000281 // If any of the definitions are used by another instruction between the
282 // position and the kill use, then it's not safe to sink it.
Andrew Trick8247e0d2012-02-03 05:12:30 +0000283 //
Bill Wendling637980e2008-05-10 00:12:52 +0000284 // FIXME: This can be sped up if there is an easy way to query whether an
Evan Cheng7543e582008-06-18 07:49:14 +0000285 // instruction is before or after another instruction. Then we can use
Bill Wendling637980e2008-05-10 00:12:52 +0000286 // MachineRegisterInfo def / use instead.
Craig Topper4ba84432014-04-14 00:51:57 +0000287 MachineOperand *KillMO = nullptr;
Evan Cheng875357d2008-03-13 06:37:55 +0000288 MachineBasicBlock::iterator KillPos = KillMI;
289 ++KillPos;
Bill Wendling637980e2008-05-10 00:12:52 +0000290
Evan Cheng7543e582008-06-18 07:49:14 +0000291 unsigned NumVisited = 0;
Eugene Zelenko94348112017-09-29 21:55:49 +0000292 for (MachineInstr &OtherMI : make_range(std::next(OldPos), KillPos)) {
Shiva Chen24abe712018-05-09 02:42:00 +0000293 // Debug instructions cannot be counted against the limit.
294 if (OtherMI.isDebugInstr())
Dale Johannesen3bfef032010-02-11 18:22:31 +0000295 continue;
Evan Cheng7543e582008-06-18 07:49:14 +0000296 if (NumVisited > 30) // FIXME: Arbitrary limit to reduce compile time cost.
297 return false;
298 ++NumVisited;
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +0000299 for (unsigned i = 0, e = OtherMI.getNumOperands(); i != e; ++i) {
300 MachineOperand &MO = OtherMI.getOperand(i);
Dan Gohmand735b802008-10-03 15:45:36 +0000301 if (!MO.isReg())
Evan Cheng875357d2008-03-13 06:37:55 +0000302 continue;
303 unsigned MOReg = MO.getReg();
304 if (!MOReg)
305 continue;
306 if (DefReg == MOReg)
307 return false;
Bill Wendling637980e2008-05-10 00:12:52 +0000308
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +0000309 if (MO.isKill() || (LIS && isPlainlyKilled(&OtherMI, MOReg, LIS))) {
310 if (&OtherMI == KillMI && MOReg == SavedReg)
Evan Cheng7543e582008-06-18 07:49:14 +0000311 // Save the operand that kills the register. We want to unset the kill
312 // marker if we can sink MI past it.
Evan Cheng875357d2008-03-13 06:37:55 +0000313 KillMO = &MO;
314 else if (UseRegs.count(MOReg))
315 // One of the uses is killed before the destination.
316 return false;
317 }
318 }
319 }
Jakob Stoklund Olesen988069e2012-08-09 22:08:26 +0000320 assert(KillMO && "Didn't find kill");
Evan Cheng875357d2008-03-13 06:37:55 +0000321
Cameron Zwarich4c579422013-02-23 04:49:20 +0000322 if (!LIS) {
323 // Update kill and LV information.
324 KillMO->setIsKill(false);
325 KillMO = MI->findRegisterUseOperand(SavedReg, false, TRI);
326 KillMO->setIsKill(true);
Andrew Trick8247e0d2012-02-03 05:12:30 +0000327
Cameron Zwarich4c579422013-02-23 04:49:20 +0000328 if (LV)
Duncan P. N. Exon Smith4383a512016-07-01 01:51:32 +0000329 LV->replaceKillInstruction(SavedReg, *KillMI, *MI);
Cameron Zwarich4c579422013-02-23 04:49:20 +0000330 }
Evan Cheng875357d2008-03-13 06:37:55 +0000331
332 // Move instruction to its destination.
333 MBB->remove(MI);
334 MBB->insert(KillPos, MI);
335
Jakob Stoklund Olesen5bfdedf2012-08-03 22:58:34 +0000336 if (LIS)
Duncan P. N. Exon Smith5144d352016-02-27 20:14:29 +0000337 LIS->handleMove(*MI);
Jakob Stoklund Olesen5bfdedf2012-08-03 22:58:34 +0000338
Evan Cheng875357d2008-03-13 06:37:55 +0000339 ++Num3AddrSunk;
340 return true;
341}
342
Sanjay Patel936f2da2015-12-01 19:32:35 +0000343/// Return the MachineInstr* if it is the single def of the Reg in current BB.
Eric Christopher63295d82015-03-03 22:03:03 +0000344static MachineInstr *getSingleDef(unsigned Reg, MachineBasicBlock *BB,
345 const MachineRegisterInfo *MRI) {
346 MachineInstr *Ret = nullptr;
347 for (MachineInstr &DefMI : MRI->def_instructions(Reg)) {
348 if (DefMI.getParent() != BB || DefMI.isDebugValue())
349 continue;
350 if (!Ret)
351 Ret = &DefMI;
352 else if (Ret != &DefMI)
353 return nullptr;
354 }
355 return Ret;
356}
357
358/// Check if there is a reversed copy chain from FromReg to ToReg:
359/// %Tmp1 = copy %Tmp2;
360/// %FromReg = copy %Tmp1;
361/// %ToReg = add %FromReg ...
362/// %Tmp2 = copy %ToReg;
363/// MaxLen specifies the maximum length of the copy chain the func
364/// can walk through.
365bool TwoAddressInstructionPass::isRevCopyChain(unsigned FromReg, unsigned ToReg,
366 int Maxlen) {
367 unsigned TmpReg = FromReg;
368 for (int i = 0; i < Maxlen; i++) {
369 MachineInstr *Def = getSingleDef(TmpReg, MBB, MRI);
370 if (!Def || !Def->isCopy())
371 return false;
372
373 TmpReg = Def->getOperand(1).getReg();
374
375 if (TmpReg == ToReg)
376 return true;
377 }
378 return false;
379}
380
Sanjay Patel936f2da2015-12-01 19:32:35 +0000381/// Return true if there are no intervening uses between the last instruction
382/// in the MBB that defines the specified register and the two-address
383/// instruction which is being processed. It also returns the last def location
384/// by reference.
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +0000385bool TwoAddressInstructionPass::noUseAfterLastDef(unsigned Reg, unsigned Dist,
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +0000386 unsigned &LastDef) {
Evan Chengd498c8f2009-01-25 03:53:59 +0000387 LastDef = 0;
388 unsigned LastUse = Dist;
Owen Anderson92fca732014-03-17 19:36:09 +0000389 for (MachineOperand &MO : MRI->reg_operands(Reg)) {
Evan Chengd498c8f2009-01-25 03:53:59 +0000390 MachineInstr *MI = MO.getParent();
Chris Lattner518bb532010-02-09 19:54:29 +0000391 if (MI->getParent() != MBB || MI->isDebugValue())
Dale Johannesend94998f2010-02-09 02:01:46 +0000392 continue;
Evan Chengd498c8f2009-01-25 03:53:59 +0000393 DenseMap<MachineInstr*, unsigned>::iterator DI = DistanceMap.find(MI);
394 if (DI == DistanceMap.end())
395 continue;
396 if (MO.isUse() && DI->second < LastUse)
397 LastUse = DI->second;
398 if (MO.isDef() && DI->second > LastDef)
399 LastDef = DI->second;
400 }
401
402 return !(LastUse > LastDef && LastUse < Dist);
403}
404
Sanjay Patel936f2da2015-12-01 19:32:35 +0000405/// Return true if the specified MI is a copy instruction or an extract_subreg
406/// instruction. It also returns the source and destination registers and
407/// whether they are physical registers by reference.
Evan Cheng870b8072009-03-01 02:03:43 +0000408static bool isCopyToReg(MachineInstr &MI, const TargetInstrInfo *TII,
409 unsigned &SrcReg, unsigned &DstReg,
410 bool &IsSrcPhys, bool &IsDstPhys) {
411 SrcReg = 0;
412 DstReg = 0;
Jakob Stoklund Olesen04c528a2010-07-16 04:45:42 +0000413 if (MI.isCopy()) {
414 DstReg = MI.getOperand(0).getReg();
415 SrcReg = MI.getOperand(1).getReg();
416 } else if (MI.isInsertSubreg() || MI.isSubregToReg()) {
417 DstReg = MI.getOperand(0).getReg();
418 SrcReg = MI.getOperand(2).getReg();
419 } else
420 return false;
Evan Cheng870b8072009-03-01 02:03:43 +0000421
Jakob Stoklund Olesen04c528a2010-07-16 04:45:42 +0000422 IsSrcPhys = TargetRegisterInfo::isPhysicalRegister(SrcReg);
423 IsDstPhys = TargetRegisterInfo::isPhysicalRegister(DstReg);
424 return true;
Evan Cheng870b8072009-03-01 02:03:43 +0000425}
426
Sanjay Patel936f2da2015-12-01 19:32:35 +0000427/// Test if the given register value, which is used by the
428/// given instruction, is killed by the given instruction.
Cameron Zwarich3a9805f2013-02-21 07:02:28 +0000429static bool isPlainlyKilled(MachineInstr *MI, unsigned Reg,
430 LiveIntervals *LIS) {
431 if (LIS && TargetRegisterInfo::isVirtualRegister(Reg) &&
Duncan P. N. Exon Smith42e18352016-02-27 06:40:41 +0000432 !LIS->isNotInMIMap(*MI)) {
Cameron Zwarich3a9805f2013-02-21 07:02:28 +0000433 // FIXME: Sometimes tryInstructionTransform() will add instructions and
434 // test whether they can be folded before keeping them. In this case it
435 // sets a kill before recursively calling tryInstructionTransform() again.
436 // If there is no interval available, we assume that this instruction is
437 // one of those. A kill flag is manually inserted on the operand so the
438 // check below will handle it.
439 LiveInterval &LI = LIS->getInterval(Reg);
440 // This is to match the kill flag version where undefs don't have kill
441 // flags.
442 if (!LI.hasAtLeastOneValue())
443 return false;
444
Duncan P. N. Exon Smith42e18352016-02-27 06:40:41 +0000445 SlotIndex useIdx = LIS->getInstructionIndex(*MI);
Cameron Zwarich3a9805f2013-02-21 07:02:28 +0000446 LiveInterval::const_iterator I = LI.find(useIdx);
447 assert(I != LI.end() && "Reg must be live-in to use.");
Cameron Zwarichb4bd0222013-02-23 04:49:22 +0000448 return !I->end.isBlock() && SlotIndex::isSameInstr(I->end, useIdx);
Cameron Zwarich3a9805f2013-02-21 07:02:28 +0000449 }
450
451 return MI->killsRegister(Reg);
452}
453
Sanjay Patel936f2da2015-12-01 19:32:35 +0000454/// Test if the given register value, which is used by the given
Dan Gohman97121ba2009-04-08 00:15:30 +0000455/// instruction, is killed by the given instruction. This looks through
456/// coalescable copies to see if the original value is potentially not killed.
457///
458/// For example, in this code:
459///
460/// %reg1034 = copy %reg1024
Francis Visoiu Mistrihfd11bc02017-12-07 10:40:31 +0000461/// %reg1035 = copy killed %reg1025
462/// %reg1036 = add killed %reg1034, killed %reg1035
Dan Gohman97121ba2009-04-08 00:15:30 +0000463///
464/// %reg1034 is not considered to be killed, since it is copied from a
465/// register which is not killed. Treating it as not killed lets the
466/// normal heuristics commute the (two-address) add, which lets
467/// coalescing eliminate the extra copy.
468///
Cameron Zwaricha931a122013-02-21 22:58:42 +0000469/// If allowFalsePositives is true then likely kills are treated as kills even
470/// if it can't be proven that they are kills.
Dan Gohman97121ba2009-04-08 00:15:30 +0000471static bool isKilled(MachineInstr &MI, unsigned Reg,
472 const MachineRegisterInfo *MRI,
Cameron Zwarich214df422013-02-21 04:33:02 +0000473 const TargetInstrInfo *TII,
Cameron Zwaricha931a122013-02-21 22:58:42 +0000474 LiveIntervals *LIS,
475 bool allowFalsePositives) {
Dan Gohman97121ba2009-04-08 00:15:30 +0000476 MachineInstr *DefMI = &MI;
Eugene Zelenko94348112017-09-29 21:55:49 +0000477 while (true) {
Cameron Zwaricha931a122013-02-21 22:58:42 +0000478 // All uses of physical registers are likely to be kills.
479 if (TargetRegisterInfo::isPhysicalRegister(Reg) &&
480 (allowFalsePositives || MRI->hasOneUse(Reg)))
481 return true;
Cameron Zwarich3a9805f2013-02-21 07:02:28 +0000482 if (!isPlainlyKilled(DefMI, Reg, LIS))
Dan Gohman97121ba2009-04-08 00:15:30 +0000483 return false;
484 if (TargetRegisterInfo::isPhysicalRegister(Reg))
485 return true;
486 MachineRegisterInfo::def_iterator Begin = MRI->def_begin(Reg);
487 // If there are multiple defs, we can't do a simple analysis, so just
488 // go with what the kill flag says.
Benjamin Kramerd628f192014-03-02 12:27:27 +0000489 if (std::next(Begin) != MRI->def_end())
Dan Gohman97121ba2009-04-08 00:15:30 +0000490 return true;
Owen Andersonbf630222014-03-13 23:12:04 +0000491 DefMI = Begin->getParent();
Dan Gohman97121ba2009-04-08 00:15:30 +0000492 bool IsSrcPhys, IsDstPhys;
493 unsigned SrcReg, DstReg;
494 // If the def is something other than a copy, then it isn't going to
495 // be coalesced, so follow the kill flag.
496 if (!isCopyToReg(*DefMI, TII, SrcReg, DstReg, IsSrcPhys, IsDstPhys))
497 return true;
498 Reg = SrcReg;
499 }
500}
501
Sanjay Patel936f2da2015-12-01 19:32:35 +0000502/// Return true if the specified MI uses the specified register as a two-address
503/// use. If so, return the destination register by reference.
Evan Cheng870b8072009-03-01 02:03:43 +0000504static bool isTwoAddrUse(MachineInstr &MI, unsigned Reg, unsigned &DstReg) {
Evan Chengd4201b62013-05-02 02:07:32 +0000505 for (unsigned i = 0, NumOps = MI.getNumOperands(); i != NumOps; ++i) {
Evan Cheng870b8072009-03-01 02:03:43 +0000506 const MachineOperand &MO = MI.getOperand(i);
507 if (!MO.isReg() || !MO.isUse() || MO.getReg() != Reg)
508 continue;
Evan Chenga24752f2009-03-19 20:30:06 +0000509 unsigned ti;
510 if (MI.isRegTiedToDefOperand(i, &ti)) {
Evan Cheng870b8072009-03-01 02:03:43 +0000511 DstReg = MI.getOperand(ti).getReg();
512 return true;
513 }
514 }
515 return false;
516}
517
Sanjay Patel936f2da2015-12-01 19:32:35 +0000518/// Given a register, if has a single in-basic block use, return the use
519/// instruction if it's a copy or a two-address use.
Evan Cheng870b8072009-03-01 02:03:43 +0000520static
521MachineInstr *findOnlyInterestingUse(unsigned Reg, MachineBasicBlock *MBB,
522 MachineRegisterInfo *MRI,
523 const TargetInstrInfo *TII,
Evan Cheng87d696a2009-04-14 00:32:25 +0000524 bool &IsCopy,
Evan Cheng870b8072009-03-01 02:03:43 +0000525 unsigned &DstReg, bool &IsDstPhys) {
Evan Cheng1423c702010-03-03 21:18:38 +0000526 if (!MRI->hasOneNonDBGUse(Reg))
527 // None or more than one use.
Craig Topper4ba84432014-04-14 00:51:57 +0000528 return nullptr;
Owen Andersonbf630222014-03-13 23:12:04 +0000529 MachineInstr &UseMI = *MRI->use_instr_nodbg_begin(Reg);
Evan Cheng870b8072009-03-01 02:03:43 +0000530 if (UseMI.getParent() != MBB)
Craig Topper4ba84432014-04-14 00:51:57 +0000531 return nullptr;
Evan Cheng870b8072009-03-01 02:03:43 +0000532 unsigned SrcReg;
533 bool IsSrcPhys;
Evan Cheng87d696a2009-04-14 00:32:25 +0000534 if (isCopyToReg(UseMI, TII, SrcReg, DstReg, IsSrcPhys, IsDstPhys)) {
535 IsCopy = true;
Evan Cheng870b8072009-03-01 02:03:43 +0000536 return &UseMI;
Evan Cheng87d696a2009-04-14 00:32:25 +0000537 }
Evan Cheng870b8072009-03-01 02:03:43 +0000538 IsDstPhys = false;
Evan Cheng87d696a2009-04-14 00:32:25 +0000539 if (isTwoAddrUse(UseMI, Reg, DstReg)) {
540 IsDstPhys = TargetRegisterInfo::isPhysicalRegister(DstReg);
Evan Cheng870b8072009-03-01 02:03:43 +0000541 return &UseMI;
Evan Cheng87d696a2009-04-14 00:32:25 +0000542 }
Craig Topper4ba84432014-04-14 00:51:57 +0000543 return nullptr;
Evan Cheng870b8072009-03-01 02:03:43 +0000544}
545
Sanjay Patel936f2da2015-12-01 19:32:35 +0000546/// Return the physical register the specified virtual register might be mapped
547/// to.
Evan Cheng870b8072009-03-01 02:03:43 +0000548static unsigned
549getMappedReg(unsigned Reg, DenseMap<unsigned, unsigned> &RegMap) {
550 while (TargetRegisterInfo::isVirtualRegister(Reg)) {
551 DenseMap<unsigned, unsigned>::iterator SI = RegMap.find(Reg);
552 if (SI == RegMap.end())
553 return 0;
554 Reg = SI->second;
555 }
556 if (TargetRegisterInfo::isPhysicalRegister(Reg))
557 return Reg;
558 return 0;
559}
560
Sanjay Patel936f2da2015-12-01 19:32:35 +0000561/// Return true if the two registers are equal or aliased.
Evan Cheng870b8072009-03-01 02:03:43 +0000562static bool
563regsAreCompatible(unsigned RegA, unsigned RegB, const TargetRegisterInfo *TRI) {
564 if (RegA == RegB)
565 return true;
566 if (!RegA || !RegB)
567 return false;
568 return TRI->regsOverlap(RegA, RegB);
569}
570
Michael Kupersteinf1860b72016-08-11 17:38:33 +0000571// Returns true if Reg is equal or aliased to at least one register in Set.
572static bool regOverlapsSet(const SmallVectorImpl<unsigned> &Set, unsigned Reg,
573 const TargetRegisterInfo *TRI) {
574 for (unsigned R : Set)
575 if (TRI->regsOverlap(R, Reg))
576 return true;
577
578 return false;
579}
580
Sanjay Patel936f2da2015-12-01 19:32:35 +0000581/// Return true if it's potentially profitable to commute the two-address
582/// instruction that's being processed.
Evan Chengd498c8f2009-01-25 03:53:59 +0000583bool
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +0000584TwoAddressInstructionPass::
585isProfitableToCommute(unsigned regA, unsigned regB, unsigned regC,
586 MachineInstr *MI, unsigned Dist) {
Evan Chengc3aa7c52011-11-16 18:44:48 +0000587 if (OptLevel == CodeGenOpt::None)
588 return false;
589
Evan Chengd498c8f2009-01-25 03:53:59 +0000590 // Determine if it's profitable to commute this two address instruction. In
591 // general, we want no uses between this instruction and the definition of
592 // the two-address register.
593 // e.g.
Francis Visoiu Mistrihfd11bc02017-12-07 10:40:31 +0000594 // %reg1028 = EXTRACT_SUBREG killed %reg1027, 1
Matthias Braundd8cebd2018-10-08 23:47:35 +0000595 // %reg1029 = COPY %reg1028
Francis Visoiu Mistrihfd11bc02017-12-07 10:40:31 +0000596 // %reg1029 = SHR8ri %reg1029, 7, implicit dead %eflags
Matthias Braundd8cebd2018-10-08 23:47:35 +0000597 // insert => %reg1030 = COPY %reg1028
Francis Visoiu Mistrihfd11bc02017-12-07 10:40:31 +0000598 // %reg1030 = ADD8rr killed %reg1028, killed %reg1029, implicit dead %eflags
Matthias Braundd8cebd2018-10-08 23:47:35 +0000599 // In this case, it might not be possible to coalesce the second COPY
Evan Chengd498c8f2009-01-25 03:53:59 +0000600 // instruction if the first one is coalesced. So it would be profitable to
601 // commute it:
Francis Visoiu Mistrihfd11bc02017-12-07 10:40:31 +0000602 // %reg1028 = EXTRACT_SUBREG killed %reg1027, 1
Matthias Braundd8cebd2018-10-08 23:47:35 +0000603 // %reg1029 = COPY %reg1028
Francis Visoiu Mistrihfd11bc02017-12-07 10:40:31 +0000604 // %reg1029 = SHR8ri %reg1029, 7, implicit dead %eflags
Matthias Braundd8cebd2018-10-08 23:47:35 +0000605 // insert => %reg1030 = COPY %reg1029
Francis Visoiu Mistrihfd11bc02017-12-07 10:40:31 +0000606 // %reg1030 = ADD8rr killed %reg1029, killed %reg1028, implicit dead %eflags
Evan Chengd498c8f2009-01-25 03:53:59 +0000607
Cameron Zwarich17cec5a2013-02-21 07:02:30 +0000608 if (!isPlainlyKilled(MI, regC, LIS))
Evan Chengd498c8f2009-01-25 03:53:59 +0000609 return false;
610
611 // Ok, we have something like:
Francis Visoiu Mistrihfd11bc02017-12-07 10:40:31 +0000612 // %reg1030 = ADD8rr killed %reg1028, killed %reg1029, implicit dead %eflags
Evan Chengd498c8f2009-01-25 03:53:59 +0000613 // let's see if it's worth commuting it.
614
Evan Cheng870b8072009-03-01 02:03:43 +0000615 // Look for situations like this:
Francis Visoiu Mistrihfd11bc02017-12-07 10:40:31 +0000616 // %reg1024 = MOV r1
617 // %reg1025 = MOV r0
618 // %reg1026 = ADD %reg1024, %reg1025
Evan Cheng870b8072009-03-01 02:03:43 +0000619 // r0 = MOV %reg1026
620 // Commute the ADD to hopefully eliminate an otherwise unavoidable copy.
Evan Chengd99d68b2012-05-03 01:45:13 +0000621 unsigned ToRegA = getMappedReg(regA, DstRegMap);
622 if (ToRegA) {
623 unsigned FromRegB = getMappedReg(regB, SrcRegMap);
624 unsigned FromRegC = getMappedReg(regC, SrcRegMap);
Craig Topper04a45942014-11-05 06:43:02 +0000625 bool CompB = FromRegB && regsAreCompatible(FromRegB, ToRegA, TRI);
626 bool CompC = FromRegC && regsAreCompatible(FromRegC, ToRegA, TRI);
627
628 // Compute if any of the following are true:
629 // -RegB is not tied to a register and RegC is compatible with RegA.
630 // -RegB is tied to the wrong physical register, but RegC is.
631 // -RegB is tied to the wrong physical register, and RegC isn't tied.
632 if ((!FromRegB && CompC) || (FromRegB && !CompB && (!FromRegC || CompC)))
633 return true;
634 // Don't compute if any of the following are true:
635 // -RegC is not tied to a register and RegB is compatible with RegA.
636 // -RegC is tied to the wrong physical register, but RegB is.
637 // -RegC is tied to the wrong physical register, and RegB isn't tied.
638 if ((!FromRegC && CompB) || (FromRegC && !CompC && (!FromRegB || CompB)))
639 return false;
Evan Chengd99d68b2012-05-03 01:45:13 +0000640 }
Evan Cheng870b8072009-03-01 02:03:43 +0000641
Evan Chengd498c8f2009-01-25 03:53:59 +0000642 // If there is a use of regC between its last def (could be livein) and this
643 // instruction, then bail.
644 unsigned LastDefC = 0;
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +0000645 if (!noUseAfterLastDef(regC, Dist, LastDefC))
Evan Chengd498c8f2009-01-25 03:53:59 +0000646 return false;
647
648 // If there is a use of regB between its last def (could be livein) and this
649 // instruction, then go ahead and make this transformation.
650 unsigned LastDefB = 0;
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +0000651 if (!noUseAfterLastDef(regB, Dist, LastDefB))
Evan Chengd498c8f2009-01-25 03:53:59 +0000652 return true;
653
Eric Christopher63295d82015-03-03 22:03:03 +0000654 // Look for situation like this:
655 // %reg101 = MOV %reg100
656 // %reg102 = ...
657 // %reg103 = ADD %reg102, %reg101
658 // ... = %reg103 ...
659 // %reg100 = MOV %reg103
660 // If there is a reversed copy chain from reg101 to reg103, commute the ADD
661 // to eliminate an otherwise unavoidable copy.
662 // FIXME:
663 // We can extend the logic further: If an pair of operands in an insn has
664 // been merged, the insn could be regarded as a virtual copy, and the virtual
665 // copy could also be used to construct a copy chain.
666 // To more generally minimize register copies, ideally the logic of two addr
667 // instruction pass should be integrated with register allocation pass where
668 // interference graph is available.
Taewook Oh2ce547e2017-06-29 23:11:24 +0000669 if (isRevCopyChain(regC, regA, MaxDataFlowEdge))
Eric Christopher63295d82015-03-03 22:03:03 +0000670 return true;
671
Taewook Oh2ce547e2017-06-29 23:11:24 +0000672 if (isRevCopyChain(regB, regA, MaxDataFlowEdge))
Eric Christopher63295d82015-03-03 22:03:03 +0000673 return false;
674
Evan Chengd498c8f2009-01-25 03:53:59 +0000675 // Since there are no intervening uses for both registers, then commute
676 // if the def of regC is closer. Its live interval is shorter.
677 return LastDefB && LastDefC && LastDefC > LastDefB;
678}
679
Sanjay Patel936f2da2015-12-01 19:32:35 +0000680/// Commute a two-address instruction and update the basic block, distance map,
681/// and live variables if needed. Return true if it is successful.
Andrew Kayloraac3c942015-09-28 20:33:22 +0000682bool TwoAddressInstructionPass::commuteInstruction(MachineInstr *MI,
Craig Topper661e8f42016-09-11 22:10:42 +0000683 unsigned DstIdx,
Andrew Kayloraac3c942015-09-28 20:33:22 +0000684 unsigned RegBIdx,
685 unsigned RegCIdx,
686 unsigned Dist) {
687 unsigned RegC = MI->getOperand(RegCIdx).getReg();
Nicola Zaghen0818e782018-05-14 12:53:11 +0000688 LLVM_DEBUG(dbgs() << "2addr: COMMUTING : " << *MI);
Duncan P. N. Exon Smith567409d2016-06-30 00:01:54 +0000689 MachineInstr *NewMI = TII->commuteInstruction(*MI, false, RegBIdx, RegCIdx);
Evan Cheng81913712009-01-23 23:27:33 +0000690
Craig Topper4ba84432014-04-14 00:51:57 +0000691 if (NewMI == nullptr) {
Nicola Zaghen0818e782018-05-14 12:53:11 +0000692 LLVM_DEBUG(dbgs() << "2addr: COMMUTING FAILED!\n");
Evan Cheng81913712009-01-23 23:27:33 +0000693 return false;
694 }
695
Nicola Zaghen0818e782018-05-14 12:53:11 +0000696 LLVM_DEBUG(dbgs() << "2addr: COMMUTED TO: " << *NewMI);
Cameron Zwarich1ea93c72013-02-23 23:13:28 +0000697 assert(NewMI == MI &&
698 "TargetInstrInfo::commuteInstruction() should not return a new "
699 "instruction unless it was requested.");
Evan Cheng870b8072009-03-01 02:03:43 +0000700
701 // Update source register map.
702 unsigned FromRegC = getMappedReg(RegC, SrcRegMap);
703 if (FromRegC) {
Craig Topper661e8f42016-09-11 22:10:42 +0000704 unsigned RegA = MI->getOperand(DstIdx).getReg();
Evan Cheng870b8072009-03-01 02:03:43 +0000705 SrcRegMap[RegA] = FromRegC;
706 }
707
Evan Cheng81913712009-01-23 23:27:33 +0000708 return true;
709}
710
Sanjay Patel936f2da2015-12-01 19:32:35 +0000711/// Return true if it is profitable to convert the given 2-address instruction
712/// to a 3-address one.
Evan Chenge6f350d2009-03-30 21:34:07 +0000713bool
Evan Chengf06e6c22011-03-02 01:08:17 +0000714TwoAddressInstructionPass::isProfitableToConv3Addr(unsigned RegA,unsigned RegB){
Evan Chenge6f350d2009-03-30 21:34:07 +0000715 // Look for situations like this:
Francis Visoiu Mistrihfd11bc02017-12-07 10:40:31 +0000716 // %reg1024 = MOV r1
717 // %reg1025 = MOV r0
718 // %reg1026 = ADD %reg1024, %reg1025
Evan Chenge6f350d2009-03-30 21:34:07 +0000719 // r2 = MOV %reg1026
720 // Turn ADD into a 3-address instruction to avoid a copy.
Evan Chengf06e6c22011-03-02 01:08:17 +0000721 unsigned FromRegB = getMappedReg(RegB, SrcRegMap);
722 if (!FromRegB)
723 return false;
Evan Chenge6f350d2009-03-30 21:34:07 +0000724 unsigned ToRegA = getMappedReg(RegA, DstRegMap);
Evan Chengf06e6c22011-03-02 01:08:17 +0000725 return (ToRegA && !regsAreCompatible(FromRegB, ToRegA, TRI));
Evan Chenge6f350d2009-03-30 21:34:07 +0000726}
727
Sanjay Patel936f2da2015-12-01 19:32:35 +0000728/// Convert the specified two-address instruction into a three address one.
729/// Return true if this transformation was successful.
Evan Chenge6f350d2009-03-30 21:34:07 +0000730bool
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +0000731TwoAddressInstructionPass::convertInstTo3Addr(MachineBasicBlock::iterator &mi,
Evan Chenge6f350d2009-03-30 21:34:07 +0000732 MachineBasicBlock::iterator &nmi,
Evan Cheng4d96c632011-02-10 02:20:55 +0000733 unsigned RegA, unsigned RegB,
734 unsigned Dist) {
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +0000735 // FIXME: Why does convertToThreeAddress() need an iterator reference?
Duncan P. N. Exon Smithac4d7b62015-10-09 22:56:24 +0000736 MachineFunction::iterator MFI = MBB->getIterator();
Duncan P. N. Exon Smith567409d2016-06-30 00:01:54 +0000737 MachineInstr *NewMI = TII->convertToThreeAddress(MFI, *mi, LV);
Duncan P. N. Exon Smithac4d7b62015-10-09 22:56:24 +0000738 assert(MBB->getIterator() == MFI &&
739 "convertToThreeAddress changed iterator reference");
Jakob Stoklund Olesen96e6da42012-10-26 23:05:13 +0000740 if (!NewMI)
741 return false;
Evan Chenge6f350d2009-03-30 21:34:07 +0000742
Nicola Zaghen0818e782018-05-14 12:53:11 +0000743 LLVM_DEBUG(dbgs() << "2addr: CONVERTING 2-ADDR: " << *mi);
744 LLVM_DEBUG(dbgs() << "2addr: TO 3-ADDR: " << *NewMI);
Jakob Stoklund Olesen96e6da42012-10-26 23:05:13 +0000745 bool Sunk = false;
Jakob Stoklund Olesen5bfdedf2012-08-03 22:58:34 +0000746
Cameron Zwarich61892882013-02-20 22:10:02 +0000747 if (LIS)
Duncan P. N. Exon Smith42e18352016-02-27 06:40:41 +0000748 LIS->ReplaceMachineInstrInMaps(*mi, *NewMI);
Evan Chenge6f350d2009-03-30 21:34:07 +0000749
Jakob Stoklund Olesen96e6da42012-10-26 23:05:13 +0000750 if (NewMI->findRegisterUseOperand(RegB, false, TRI))
751 // FIXME: Temporary workaround. If the new instruction doesn't
752 // uses RegB, convertToThreeAddress must have created more
753 // then one instruction.
754 Sunk = sink3AddrInstruction(NewMI, RegB, mi);
Evan Chenge6f350d2009-03-30 21:34:07 +0000755
Jakob Stoklund Olesen96e6da42012-10-26 23:05:13 +0000756 MBB->erase(mi); // Nuke the old inst.
Evan Cheng4d96c632011-02-10 02:20:55 +0000757
Jakob Stoklund Olesen96e6da42012-10-26 23:05:13 +0000758 if (!Sunk) {
759 DistanceMap.insert(std::make_pair(NewMI, Dist));
760 mi = NewMI;
Benjamin Kramerd628f192014-03-02 12:27:27 +0000761 nmi = std::next(mi);
Evan Chenge6f350d2009-03-30 21:34:07 +0000762 }
Jonas Paulsson62f11d92017-12-04 10:03:14 +0000763 else
764 SunkInstrs.insert(NewMI);
Evan Chenge6f350d2009-03-30 21:34:07 +0000765
Jakob Stoklund Olesen96e6da42012-10-26 23:05:13 +0000766 // Update source and destination register maps.
767 SrcRegMap.erase(RegA);
768 DstRegMap.erase(RegB);
769 return true;
Evan Chenge6f350d2009-03-30 21:34:07 +0000770}
771
Sanjay Patel936f2da2015-12-01 19:32:35 +0000772/// Scan forward recursively for only uses, update maps if the use is a copy or
773/// a two-address instruction.
Evan Chengf06e6c22011-03-02 01:08:17 +0000774void
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +0000775TwoAddressInstructionPass::scanUses(unsigned DstReg) {
Evan Chengf06e6c22011-03-02 01:08:17 +0000776 SmallVector<unsigned, 4> VirtRegPairs;
777 bool IsDstPhys;
778 bool IsCopy = false;
779 unsigned NewReg = 0;
780 unsigned Reg = DstReg;
781 while (MachineInstr *UseMI = findOnlyInterestingUse(Reg, MBB, MRI, TII,IsCopy,
782 NewReg, IsDstPhys)) {
David Blaikie5401ba72014-11-19 07:49:26 +0000783 if (IsCopy && !Processed.insert(UseMI).second)
Evan Chengf06e6c22011-03-02 01:08:17 +0000784 break;
785
786 DenseMap<MachineInstr*, unsigned>::iterator DI = DistanceMap.find(UseMI);
787 if (DI != DistanceMap.end())
788 // Earlier in the same MBB.Reached via a back edge.
789 break;
790
791 if (IsDstPhys) {
792 VirtRegPairs.push_back(NewReg);
793 break;
794 }
795 bool isNew = SrcRegMap.insert(std::make_pair(NewReg, Reg)).second;
796 if (!isNew)
797 assert(SrcRegMap[NewReg] == Reg && "Can't map to two src registers!");
798 VirtRegPairs.push_back(NewReg);
799 Reg = NewReg;
800 }
801
802 if (!VirtRegPairs.empty()) {
803 unsigned ToReg = VirtRegPairs.back();
804 VirtRegPairs.pop_back();
805 while (!VirtRegPairs.empty()) {
806 unsigned FromReg = VirtRegPairs.back();
807 VirtRegPairs.pop_back();
808 bool isNew = DstRegMap.insert(std::make_pair(FromReg, ToReg)).second;
809 if (!isNew)
810 assert(DstRegMap[FromReg] == ToReg &&"Can't map to two dst registers!");
811 ToReg = FromReg;
812 }
813 bool isNew = DstRegMap.insert(std::make_pair(DstReg, ToReg)).second;
814 if (!isNew)
815 assert(DstRegMap[DstReg] == ToReg && "Can't map to two dst registers!");
816 }
817}
818
Sanjay Patel936f2da2015-12-01 19:32:35 +0000819/// If the specified instruction is not yet processed, process it if it's a
820/// copy. For a copy instruction, we find the physical registers the
Evan Cheng870b8072009-03-01 02:03:43 +0000821/// source and destination registers might be mapped to. These are kept in
822/// point-to maps used to determine future optimizations. e.g.
823/// v1024 = mov r0
824/// v1025 = mov r1
825/// v1026 = add v1024, v1025
826/// r1 = mov r1026
827/// If 'add' is a two-address instruction, v1024, v1026 are both potentially
828/// coalesced to r0 (from the input side). v1025 is mapped to r1. v1026 is
829/// potentially joined with r1 on the output side. It's worthwhile to commute
830/// 'add' to eliminate a copy.
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +0000831void TwoAddressInstructionPass::processCopy(MachineInstr *MI) {
Evan Cheng870b8072009-03-01 02:03:43 +0000832 if (Processed.count(MI))
833 return;
834
835 bool IsSrcPhys, IsDstPhys;
836 unsigned SrcReg, DstReg;
837 if (!isCopyToReg(*MI, TII, SrcReg, DstReg, IsSrcPhys, IsDstPhys))
838 return;
839
840 if (IsDstPhys && !IsSrcPhys)
841 DstRegMap.insert(std::make_pair(SrcReg, DstReg));
842 else if (!IsDstPhys && IsSrcPhys) {
Evan Cheng3005ed62009-04-13 20:04:24 +0000843 bool isNew = SrcRegMap.insert(std::make_pair(DstReg, SrcReg)).second;
844 if (!isNew)
845 assert(SrcRegMap[DstReg] == SrcReg &&
846 "Can't map to two src physical registers!");
Evan Cheng870b8072009-03-01 02:03:43 +0000847
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +0000848 scanUses(DstReg);
Evan Cheng870b8072009-03-01 02:03:43 +0000849 }
850
851 Processed.insert(MI);
852}
853
Sanjay Patel936f2da2015-12-01 19:32:35 +0000854/// If there is one more local instruction that reads 'Reg' and it kills 'Reg,
855/// consider moving the instruction below the kill instruction in order to
856/// eliminate the need for the copy.
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +0000857bool TwoAddressInstructionPass::
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +0000858rescheduleMIBelowKill(MachineBasicBlock::iterator &mi,
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +0000859 MachineBasicBlock::iterator &nmi,
860 unsigned Reg) {
Cameron Zwarich80885e52013-02-23 04:49:13 +0000861 // Bail immediately if we don't have LV or LIS available. We use them to find
862 // kills efficiently.
863 if (!LV && !LIS)
Chandler Carruth7d532c82012-07-15 03:29:46 +0000864 return false;
865
Evan Cheng2a4410d2011-11-14 19:48:55 +0000866 MachineInstr *MI = &*mi;
Andrew Trick8247e0d2012-02-03 05:12:30 +0000867 DenseMap<MachineInstr*, unsigned>::iterator DI = DistanceMap.find(MI);
Evan Cheng2a4410d2011-11-14 19:48:55 +0000868 if (DI == DistanceMap.end())
869 // Must be created from unfolded load. Don't waste time trying this.
870 return false;
871
Craig Topper4ba84432014-04-14 00:51:57 +0000872 MachineInstr *KillMI = nullptr;
Cameron Zwarich80885e52013-02-23 04:49:13 +0000873 if (LIS) {
874 LiveInterval &LI = LIS->getInterval(Reg);
875 assert(LI.end() != LI.begin() &&
876 "Reg should not have empty live interval.");
877
878 SlotIndex MBBEndIdx = LIS->getMBBEndIdx(MBB).getPrevSlot();
879 LiveInterval::const_iterator I = LI.find(MBBEndIdx);
880 if (I != LI.end() && I->start < MBBEndIdx)
881 return false;
882
883 --I;
884 KillMI = LIS->getInstructionFromIndex(I->end);
885 } else {
886 KillMI = LV->getVarInfo(Reg).findKill(MBB);
887 }
Chandler Carruth7d532c82012-07-15 03:29:46 +0000888 if (!KillMI || MI == KillMI || KillMI->isCopy() || KillMI->isCopyLike())
Evan Cheng2a4410d2011-11-14 19:48:55 +0000889 // Don't mess with copies, they may be coalesced later.
890 return false;
891
Evan Cheng5a96b3d2011-12-07 07:15:52 +0000892 if (KillMI->hasUnmodeledSideEffects() || KillMI->isCall() ||
893 KillMI->isBranch() || KillMI->isTerminator())
Evan Cheng2a4410d2011-11-14 19:48:55 +0000894 // Don't move pass calls, etc.
895 return false;
896
897 unsigned DstReg;
898 if (isTwoAddrUse(*KillMI, Reg, DstReg))
899 return false;
900
Evan Chengf1784182011-11-15 06:26:51 +0000901 bool SeenStore = true;
Matthias Braundfc41db2015-05-19 21:22:20 +0000902 if (!MI->isSafeToMove(AA, SeenStore))
Evan Cheng2a4410d2011-11-14 19:48:55 +0000903 return false;
904
Duncan P. N. Exon Smith567409d2016-06-30 00:01:54 +0000905 if (TII->getInstrLatency(InstrItins, *MI) > 1)
Evan Cheng2a4410d2011-11-14 19:48:55 +0000906 // FIXME: Needs more sophisticated heuristics.
907 return false;
908
Michael Kupersteinf1860b72016-08-11 17:38:33 +0000909 SmallVector<unsigned, 2> Uses;
910 SmallVector<unsigned, 2> Kills;
911 SmallVector<unsigned, 2> Defs;
Sanjay Patel116b08e2015-12-01 19:57:43 +0000912 for (const MachineOperand &MO : MI->operands()) {
Evan Cheng2a4410d2011-11-14 19:48:55 +0000913 if (!MO.isReg())
914 continue;
915 unsigned MOReg = MO.getReg();
916 if (!MOReg)
917 continue;
918 if (MO.isDef())
Michael Kupersteinf1860b72016-08-11 17:38:33 +0000919 Defs.push_back(MOReg);
Evan Cheng9bad88a2011-11-16 03:47:42 +0000920 else {
Michael Kupersteinf1860b72016-08-11 17:38:33 +0000921 Uses.push_back(MOReg);
Cameron Zwarich80885e52013-02-23 04:49:13 +0000922 if (MOReg != Reg && (MO.isKill() ||
923 (LIS && isPlainlyKilled(MI, MOReg, LIS))))
Michael Kupersteinf1860b72016-08-11 17:38:33 +0000924 Kills.push_back(MOReg);
Evan Cheng9bad88a2011-11-16 03:47:42 +0000925 }
Evan Cheng2a4410d2011-11-14 19:48:55 +0000926 }
927
928 // Move the copies connected to MI down as well.
Cameron Zwarich80885e52013-02-23 04:49:13 +0000929 MachineBasicBlock::iterator Begin = MI;
Benjamin Kramerd628f192014-03-02 12:27:27 +0000930 MachineBasicBlock::iterator AfterMI = std::next(Begin);
Cameron Zwarich80885e52013-02-23 04:49:13 +0000931 MachineBasicBlock::iterator End = AfterMI;
Markus Lavin3e86d1d2019-01-03 08:36:06 +0000932 while (End != MBB->end()) {
933 End = skipDebugInstructionsForward(End, MBB->end());
934 if (End->isCopy() && regOverlapsSet(Defs, End->getOperand(1).getReg(), TRI))
935 Defs.push_back(End->getOperand(0).getReg());
936 else
937 break;
Cameron Zwarich80885e52013-02-23 04:49:13 +0000938 ++End;
Evan Cheng2a4410d2011-11-14 19:48:55 +0000939 }
940
Craig Toppere8a94822017-02-04 01:58:10 +0000941 // Check if the reschedule will not break dependencies.
Evan Cheng2a4410d2011-11-14 19:48:55 +0000942 unsigned NumVisited = 0;
943 MachineBasicBlock::iterator KillPos = KillMI;
944 ++KillPos;
Eugene Zelenko94348112017-09-29 21:55:49 +0000945 for (MachineInstr &OtherMI : make_range(End, KillPos)) {
Shiva Chen24abe712018-05-09 02:42:00 +0000946 // Debug instructions cannot be counted against the limit.
947 if (OtherMI.isDebugInstr())
Evan Cheng2a4410d2011-11-14 19:48:55 +0000948 continue;
949 if (NumVisited > 10) // FIXME: Arbitrary limit to reduce compile time cost.
950 return false;
951 ++NumVisited;
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +0000952 if (OtherMI.hasUnmodeledSideEffects() || OtherMI.isCall() ||
953 OtherMI.isBranch() || OtherMI.isTerminator())
Evan Cheng2a4410d2011-11-14 19:48:55 +0000954 // Don't move pass calls, etc.
955 return false;
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +0000956 for (const MachineOperand &MO : OtherMI.operands()) {
Evan Cheng2a4410d2011-11-14 19:48:55 +0000957 if (!MO.isReg())
958 continue;
959 unsigned MOReg = MO.getReg();
960 if (!MOReg)
961 continue;
962 if (MO.isDef()) {
Michael Kupersteinf1860b72016-08-11 17:38:33 +0000963 if (regOverlapsSet(Uses, MOReg, TRI))
Evan Cheng2a4410d2011-11-14 19:48:55 +0000964 // Physical register use would be clobbered.
965 return false;
Michael Kupersteinf1860b72016-08-11 17:38:33 +0000966 if (!MO.isDead() && regOverlapsSet(Defs, MOReg, TRI))
Evan Cheng2a4410d2011-11-14 19:48:55 +0000967 // May clobber a physical register def.
968 // FIXME: This may be too conservative. It's ok if the instruction
969 // is sunken completely below the use.
970 return false;
971 } else {
Michael Kupersteinf1860b72016-08-11 17:38:33 +0000972 if (regOverlapsSet(Defs, MOReg, TRI))
Evan Cheng2a4410d2011-11-14 19:48:55 +0000973 return false;
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +0000974 bool isKill =
975 MO.isKill() || (LIS && isPlainlyKilled(&OtherMI, MOReg, LIS));
Michael Kupersteinf1860b72016-08-11 17:38:33 +0000976 if (MOReg != Reg && ((isKill && regOverlapsSet(Uses, MOReg, TRI)) ||
977 regOverlapsSet(Kills, MOReg, TRI)))
Evan Cheng2a4410d2011-11-14 19:48:55 +0000978 // Don't want to extend other live ranges and update kills.
979 return false;
Cameron Zwarich80885e52013-02-23 04:49:13 +0000980 if (MOReg == Reg && !isKill)
Chandler Carruth7d532c82012-07-15 03:29:46 +0000981 // We can't schedule across a use of the register in question.
982 return false;
983 // Ensure that if this is register in question, its the kill we expect.
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +0000984 assert((MOReg != Reg || &OtherMI == KillMI) &&
Chandler Carruth7d532c82012-07-15 03:29:46 +0000985 "Found multiple kills of a register in a basic block");
Evan Cheng2a4410d2011-11-14 19:48:55 +0000986 }
987 }
988 }
989
990 // Move debug info as well.
Shiva Chen24abe712018-05-09 02:42:00 +0000991 while (Begin != MBB->begin() && std::prev(Begin)->isDebugInstr())
Cameron Zwarich80885e52013-02-23 04:49:13 +0000992 --Begin;
993
994 nmi = End;
995 MachineBasicBlock::iterator InsertPos = KillPos;
996 if (LIS) {
997 // We have to move the copies first so that the MBB is still well-formed
998 // when calling handleMove().
999 for (MachineBasicBlock::iterator MBBI = AfterMI; MBBI != End;) {
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +00001000 auto CopyMI = MBBI++;
Cameron Zwarich80885e52013-02-23 04:49:13 +00001001 MBB->splice(InsertPos, MBB, CopyMI);
Duncan P. N. Exon Smith5144d352016-02-27 20:14:29 +00001002 LIS->handleMove(*CopyMI);
Cameron Zwarich80885e52013-02-23 04:49:13 +00001003 InsertPos = CopyMI;
1004 }
Benjamin Kramerd628f192014-03-02 12:27:27 +00001005 End = std::next(MachineBasicBlock::iterator(MI));
Cameron Zwarich80885e52013-02-23 04:49:13 +00001006 }
Evan Cheng2a4410d2011-11-14 19:48:55 +00001007
1008 // Copies following MI may have been moved as well.
Cameron Zwarich80885e52013-02-23 04:49:13 +00001009 MBB->splice(InsertPos, MBB, Begin, End);
Evan Cheng2a4410d2011-11-14 19:48:55 +00001010 DistanceMap.erase(DI);
1011
Chandler Carruth7d532c82012-07-15 03:29:46 +00001012 // Update live variables
Cameron Zwarich80885e52013-02-23 04:49:13 +00001013 if (LIS) {
Duncan P. N. Exon Smith5144d352016-02-27 20:14:29 +00001014 LIS->handleMove(*MI);
Cameron Zwarich80885e52013-02-23 04:49:13 +00001015 } else {
Duncan P. N. Exon Smith4383a512016-07-01 01:51:32 +00001016 LV->removeVirtualRegisterKilled(Reg, *KillMI);
1017 LV->addVirtualRegisterKilled(Reg, *MI);
Cameron Zwarich80885e52013-02-23 04:49:13 +00001018 }
Evan Cheng2a4410d2011-11-14 19:48:55 +00001019
Nicola Zaghen0818e782018-05-14 12:53:11 +00001020 LLVM_DEBUG(dbgs() << "\trescheduled below kill: " << *KillMI);
Evan Cheng2a4410d2011-11-14 19:48:55 +00001021 return true;
1022}
1023
Sanjay Patel936f2da2015-12-01 19:32:35 +00001024/// Return true if the re-scheduling will put the given instruction too close
1025/// to the defs of its register dependencies.
Evan Cheng2a4410d2011-11-14 19:48:55 +00001026bool TwoAddressInstructionPass::isDefTooClose(unsigned Reg, unsigned Dist,
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +00001027 MachineInstr *MI) {
Owen Anderson92fca732014-03-17 19:36:09 +00001028 for (MachineInstr &DefMI : MRI->def_instructions(Reg)) {
1029 if (DefMI.getParent() != MBB || DefMI.isCopy() || DefMI.isCopyLike())
Evan Cheng2a4410d2011-11-14 19:48:55 +00001030 continue;
Owen Anderson92fca732014-03-17 19:36:09 +00001031 if (&DefMI == MI)
Evan Cheng2a4410d2011-11-14 19:48:55 +00001032 return true; // MI is defining something KillMI uses
Owen Anderson92fca732014-03-17 19:36:09 +00001033 DenseMap<MachineInstr*, unsigned>::iterator DDI = DistanceMap.find(&DefMI);
Evan Cheng2a4410d2011-11-14 19:48:55 +00001034 if (DDI == DistanceMap.end())
1035 return true; // Below MI
1036 unsigned DefDist = DDI->second;
1037 assert(Dist > DefDist && "Visited def already?");
Duncan P. N. Exon Smith567409d2016-06-30 00:01:54 +00001038 if (TII->getInstrLatency(InstrItins, DefMI) > (Dist - DefDist))
Evan Cheng2a4410d2011-11-14 19:48:55 +00001039 return true;
1040 }
1041 return false;
1042}
1043
Sanjay Patel936f2da2015-12-01 19:32:35 +00001044/// If there is one more local instruction that reads 'Reg' and it kills 'Reg,
1045/// consider moving the kill instruction above the current two-address
1046/// instruction in order to eliminate the need for the copy.
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +00001047bool TwoAddressInstructionPass::
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +00001048rescheduleKillAboveMI(MachineBasicBlock::iterator &mi,
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +00001049 MachineBasicBlock::iterator &nmi,
1050 unsigned Reg) {
Cameron Zwarich80885e52013-02-23 04:49:13 +00001051 // Bail immediately if we don't have LV or LIS available. We use them to find
1052 // kills efficiently.
1053 if (!LV && !LIS)
Chandler Carruth7d532c82012-07-15 03:29:46 +00001054 return false;
1055
Evan Cheng2a4410d2011-11-14 19:48:55 +00001056 MachineInstr *MI = &*mi;
1057 DenseMap<MachineInstr*, unsigned>::iterator DI = DistanceMap.find(MI);
1058 if (DI == DistanceMap.end())
1059 // Must be created from unfolded load. Don't waste time trying this.
1060 return false;
1061
Craig Topper4ba84432014-04-14 00:51:57 +00001062 MachineInstr *KillMI = nullptr;
Cameron Zwarich80885e52013-02-23 04:49:13 +00001063 if (LIS) {
1064 LiveInterval &LI = LIS->getInterval(Reg);
1065 assert(LI.end() != LI.begin() &&
1066 "Reg should not have empty live interval.");
1067
1068 SlotIndex MBBEndIdx = LIS->getMBBEndIdx(MBB).getPrevSlot();
1069 LiveInterval::const_iterator I = LI.find(MBBEndIdx);
1070 if (I != LI.end() && I->start < MBBEndIdx)
1071 return false;
1072
1073 --I;
1074 KillMI = LIS->getInstructionFromIndex(I->end);
1075 } else {
1076 KillMI = LV->getVarInfo(Reg).findKill(MBB);
1077 }
Chandler Carruth7d532c82012-07-15 03:29:46 +00001078 if (!KillMI || MI == KillMI || KillMI->isCopy() || KillMI->isCopyLike())
Evan Cheng2a4410d2011-11-14 19:48:55 +00001079 // Don't mess with copies, they may be coalesced later.
1080 return false;
1081
1082 unsigned DstReg;
1083 if (isTwoAddrUse(*KillMI, Reg, DstReg))
1084 return false;
1085
Evan Chengf1784182011-11-15 06:26:51 +00001086 bool SeenStore = true;
Matthias Braundfc41db2015-05-19 21:22:20 +00001087 if (!KillMI->isSafeToMove(AA, SeenStore))
Evan Cheng2a4410d2011-11-14 19:48:55 +00001088 return false;
1089
1090 SmallSet<unsigned, 2> Uses;
1091 SmallSet<unsigned, 2> Kills;
1092 SmallSet<unsigned, 2> Defs;
1093 SmallSet<unsigned, 2> LiveDefs;
Sanjay Patel116b08e2015-12-01 19:57:43 +00001094 for (const MachineOperand &MO : KillMI->operands()) {
Evan Cheng2a4410d2011-11-14 19:48:55 +00001095 if (!MO.isReg())
1096 continue;
1097 unsigned MOReg = MO.getReg();
1098 if (MO.isUse()) {
1099 if (!MOReg)
1100 continue;
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +00001101 if (isDefTooClose(MOReg, DI->second, MI))
Evan Cheng2a4410d2011-11-14 19:48:55 +00001102 return false;
Cameron Zwarich80885e52013-02-23 04:49:13 +00001103 bool isKill = MO.isKill() || (LIS && isPlainlyKilled(KillMI, MOReg, LIS));
1104 if (MOReg == Reg && !isKill)
Chandler Carruth7d532c82012-07-15 03:29:46 +00001105 return false;
Evan Cheng2a4410d2011-11-14 19:48:55 +00001106 Uses.insert(MOReg);
Cameron Zwarich80885e52013-02-23 04:49:13 +00001107 if (isKill && MOReg != Reg)
Evan Cheng2a4410d2011-11-14 19:48:55 +00001108 Kills.insert(MOReg);
1109 } else if (TargetRegisterInfo::isPhysicalRegister(MOReg)) {
1110 Defs.insert(MOReg);
1111 if (!MO.isDead())
1112 LiveDefs.insert(MOReg);
1113 }
1114 }
1115
1116 // Check if the reschedule will not break depedencies.
1117 unsigned NumVisited = 0;
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +00001118 for (MachineInstr &OtherMI :
Eugene Zelenko94348112017-09-29 21:55:49 +00001119 make_range(mi, MachineBasicBlock::iterator(KillMI))) {
Shiva Chen24abe712018-05-09 02:42:00 +00001120 // Debug instructions cannot be counted against the limit.
1121 if (OtherMI.isDebugInstr())
Evan Cheng2a4410d2011-11-14 19:48:55 +00001122 continue;
1123 if (NumVisited > 10) // FIXME: Arbitrary limit to reduce compile time cost.
1124 return false;
1125 ++NumVisited;
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +00001126 if (OtherMI.hasUnmodeledSideEffects() || OtherMI.isCall() ||
1127 OtherMI.isBranch() || OtherMI.isTerminator())
Evan Cheng2a4410d2011-11-14 19:48:55 +00001128 // Don't move pass calls, etc.
1129 return false;
Evan Chengae7db7a2011-11-16 03:05:12 +00001130 SmallVector<unsigned, 2> OtherDefs;
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +00001131 for (const MachineOperand &MO : OtherMI.operands()) {
Evan Cheng2a4410d2011-11-14 19:48:55 +00001132 if (!MO.isReg())
1133 continue;
1134 unsigned MOReg = MO.getReg();
1135 if (!MOReg)
1136 continue;
1137 if (MO.isUse()) {
1138 if (Defs.count(MOReg))
1139 // Moving KillMI can clobber the physical register if the def has
1140 // not been seen.
1141 return false;
1142 if (Kills.count(MOReg))
1143 // Don't want to extend other live ranges and update kills.
1144 return false;
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +00001145 if (&OtherMI != MI && MOReg == Reg &&
1146 !(MO.isKill() || (LIS && isPlainlyKilled(&OtherMI, MOReg, LIS))))
Chandler Carruth7d532c82012-07-15 03:29:46 +00001147 // We can't schedule across a use of the register in question.
1148 return false;
Evan Cheng2a4410d2011-11-14 19:48:55 +00001149 } else {
Evan Chengae7db7a2011-11-16 03:05:12 +00001150 OtherDefs.push_back(MOReg);
Evan Cheng2a4410d2011-11-14 19:48:55 +00001151 }
1152 }
Evan Chengae7db7a2011-11-16 03:05:12 +00001153
1154 for (unsigned i = 0, e = OtherDefs.size(); i != e; ++i) {
1155 unsigned MOReg = OtherDefs[i];
1156 if (Uses.count(MOReg))
1157 return false;
1158 if (TargetRegisterInfo::isPhysicalRegister(MOReg) &&
1159 LiveDefs.count(MOReg))
1160 return false;
1161 // Physical register def is seen.
1162 Defs.erase(MOReg);
1163 }
Evan Cheng2a4410d2011-11-14 19:48:55 +00001164 }
1165
1166 // Move the old kill above MI, don't forget to move debug info as well.
1167 MachineBasicBlock::iterator InsertPos = mi;
Shiva Chen24abe712018-05-09 02:42:00 +00001168 while (InsertPos != MBB->begin() && std::prev(InsertPos)->isDebugInstr())
Evan Cheng8aee7d82011-11-14 21:11:15 +00001169 --InsertPos;
Evan Cheng2a4410d2011-11-14 19:48:55 +00001170 MachineBasicBlock::iterator From = KillMI;
Benjamin Kramerd628f192014-03-02 12:27:27 +00001171 MachineBasicBlock::iterator To = std::next(From);
Shiva Chen24abe712018-05-09 02:42:00 +00001172 while (std::prev(From)->isDebugInstr())
Evan Cheng2a4410d2011-11-14 19:48:55 +00001173 --From;
1174 MBB->splice(InsertPos, MBB, From, To);
1175
Benjamin Kramerd628f192014-03-02 12:27:27 +00001176 nmi = std::prev(InsertPos); // Backtrack so we process the moved instr.
Evan Cheng2a4410d2011-11-14 19:48:55 +00001177 DistanceMap.erase(DI);
1178
Chandler Carruth7d532c82012-07-15 03:29:46 +00001179 // Update live variables
Cameron Zwarich80885e52013-02-23 04:49:13 +00001180 if (LIS) {
Duncan P. N. Exon Smith5144d352016-02-27 20:14:29 +00001181 LIS->handleMove(*KillMI);
Cameron Zwarich80885e52013-02-23 04:49:13 +00001182 } else {
Duncan P. N. Exon Smith4383a512016-07-01 01:51:32 +00001183 LV->removeVirtualRegisterKilled(Reg, *KillMI);
1184 LV->addVirtualRegisterKilled(Reg, *MI);
Cameron Zwarich80885e52013-02-23 04:49:13 +00001185 }
Chandler Carruth7d532c82012-07-15 03:29:46 +00001186
Nicola Zaghen0818e782018-05-14 12:53:11 +00001187 LLVM_DEBUG(dbgs() << "\trescheduled kill: " << *KillMI);
Evan Cheng2a4410d2011-11-14 19:48:55 +00001188 return true;
1189}
1190
Andrew Kayloraac3c942015-09-28 20:33:22 +00001191/// Tries to commute the operand 'BaseOpIdx' and some other operand in the
1192/// given machine instruction to improve opportunities for coalescing and
1193/// elimination of a register to register copy.
1194///
1195/// 'DstOpIdx' specifies the index of MI def operand.
1196/// 'BaseOpKilled' specifies if the register associated with 'BaseOpIdx'
1197/// operand is killed by the given instruction.
1198/// The 'Dist' arguments provides the distance of MI from the start of the
1199/// current basic block and it is used to determine if it is profitable
1200/// to commute operands in the instruction.
1201///
1202/// Returns true if the transformation happened. Otherwise, returns false.
1203bool TwoAddressInstructionPass::tryInstructionCommute(MachineInstr *MI,
1204 unsigned DstOpIdx,
1205 unsigned BaseOpIdx,
1206 bool BaseOpKilled,
1207 unsigned Dist) {
Craig Topper2628aff2016-09-11 06:00:15 +00001208 if (!MI->isCommutable())
1209 return false;
1210
Craig Topper2fb0fe62018-03-09 23:36:58 +00001211 bool MadeChange = false;
Andrew Kayloraac3c942015-09-28 20:33:22 +00001212 unsigned DstOpReg = MI->getOperand(DstOpIdx).getReg();
1213 unsigned BaseOpReg = MI->getOperand(BaseOpIdx).getReg();
1214 unsigned OpsNum = MI->getDesc().getNumOperands();
1215 unsigned OtherOpIdx = MI->getDesc().getNumDefs();
1216 for (; OtherOpIdx < OpsNum; OtherOpIdx++) {
1217 // The call of findCommutedOpIndices below only checks if BaseOpIdx
Sanjay Patelbedc55e2015-12-01 19:19:18 +00001218 // and OtherOpIdx are commutable, it does not really search for
Andrew Kayloraac3c942015-09-28 20:33:22 +00001219 // other commutable operands and does not change the values of passed
1220 // variables.
Craig Topper2628aff2016-09-11 06:00:15 +00001221 if (OtherOpIdx == BaseOpIdx || !MI->getOperand(OtherOpIdx).isReg() ||
Duncan P. N. Exon Smith567409d2016-06-30 00:01:54 +00001222 !TII->findCommutedOpIndices(*MI, BaseOpIdx, OtherOpIdx))
Andrew Kayloraac3c942015-09-28 20:33:22 +00001223 continue;
1224
1225 unsigned OtherOpReg = MI->getOperand(OtherOpIdx).getReg();
1226 bool AggressiveCommute = false;
1227
1228 // If OtherOp dies but BaseOp does not, swap the OtherOp and BaseOp
1229 // operands. This makes the live ranges of DstOp and OtherOp joinable.
Craig Topper2fb0fe62018-03-09 23:36:58 +00001230 bool OtherOpKilled = isKilled(*MI, OtherOpReg, MRI, TII, LIS, false);
1231 bool DoCommute = !BaseOpKilled && OtherOpKilled;
Andrew Kayloraac3c942015-09-28 20:33:22 +00001232
1233 if (!DoCommute &&
1234 isProfitableToCommute(DstOpReg, BaseOpReg, OtherOpReg, MI, Dist)) {
1235 DoCommute = true;
1236 AggressiveCommute = true;
1237 }
1238
1239 // If it's profitable to commute, try to do so.
Craig Topper661e8f42016-09-11 22:10:42 +00001240 if (DoCommute && commuteInstruction(MI, DstOpIdx, BaseOpIdx, OtherOpIdx,
1241 Dist)) {
Craig Topper2fb0fe62018-03-09 23:36:58 +00001242 MadeChange = true;
Andrew Kayloraac3c942015-09-28 20:33:22 +00001243 ++NumCommuted;
Craig Topper2fb0fe62018-03-09 23:36:58 +00001244 if (AggressiveCommute) {
Andrew Kayloraac3c942015-09-28 20:33:22 +00001245 ++NumAggrCommuted;
Craig Topper2fb0fe62018-03-09 23:36:58 +00001246 // There might be more than two commutable operands, update BaseOp and
1247 // continue scanning.
1248 BaseOpReg = OtherOpReg;
1249 BaseOpKilled = OtherOpKilled;
1250 continue;
1251 }
1252 // If this was a commute based on kill, we won't do better continuing.
1253 return MadeChange;
Andrew Kayloraac3c942015-09-28 20:33:22 +00001254 }
1255 }
Craig Topper2fb0fe62018-03-09 23:36:58 +00001256 return MadeChange;
Andrew Kayloraac3c942015-09-28 20:33:22 +00001257}
1258
Sanjay Patel936f2da2015-12-01 19:32:35 +00001259/// For the case where an instruction has a single pair of tied register
1260/// operands, attempt some transformations that may either eliminate the tied
1261/// operands or improve the opportunities for coalescing away the register copy.
1262/// Returns true if no copy needs to be inserted to untie mi's operands
1263/// (either because they were untied, or because mi was rescheduled, and will
1264/// be visited again later). If the shouldOnlyCommute flag is true, only
1265/// instruction commutation is attempted.
Bob Wilsoncc80df92009-09-03 20:58:42 +00001266bool TwoAddressInstructionPass::
Jakob Stoklund Olesen6db89362012-10-26 21:12:49 +00001267tryInstructionTransform(MachineBasicBlock::iterator &mi,
Bob Wilsoncc80df92009-09-03 20:58:42 +00001268 MachineBasicBlock::iterator &nmi,
Cameron Zwarichc5a63492013-02-24 00:27:26 +00001269 unsigned SrcIdx, unsigned DstIdx,
1270 unsigned Dist, bool shouldOnlyCommute) {
Evan Chengc3aa7c52011-11-16 18:44:48 +00001271 if (OptLevel == CodeGenOpt::None)
1272 return false;
1273
Evan Cheng2a4410d2011-11-14 19:48:55 +00001274 MachineInstr &MI = *mi;
Evan Cheng2a4410d2011-11-14 19:48:55 +00001275 unsigned regA = MI.getOperand(DstIdx).getReg();
1276 unsigned regB = MI.getOperand(SrcIdx).getReg();
Bob Wilsoncc80df92009-09-03 20:58:42 +00001277
1278 assert(TargetRegisterInfo::isVirtualRegister(regB) &&
1279 "cannot make instruction into two-address form");
Cameron Zwaricha931a122013-02-21 22:58:42 +00001280 bool regBKilled = isKilled(MI, regB, MRI, TII, LIS, true);
Bob Wilsoncc80df92009-09-03 20:58:42 +00001281
Evan Chengd99d68b2012-05-03 01:45:13 +00001282 if (TargetRegisterInfo::isVirtualRegister(regA))
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +00001283 scanUses(regA);
Evan Chengd99d68b2012-05-03 01:45:13 +00001284
Andrew Kayloraac3c942015-09-28 20:33:22 +00001285 bool Commuted = tryInstructionCommute(&MI, DstIdx, SrcIdx, regBKilled, Dist);
Bob Wilsoncc80df92009-09-03 20:58:42 +00001286
Quentin Colombeta1a323c2015-07-01 23:12:13 +00001287 // If the instruction is convertible to 3 Addr, instead
1288 // of returning try 3 Addr transformation aggresively and
1289 // use this variable to check later. Because it might be better.
1290 // For example, we can just use `leal (%rsi,%rdi), %eax` and `ret`
1291 // instead of the following code.
NAKAMURA Takumi6902c8d2015-09-22 11:14:12 +00001292 // addl %esi, %edi
1293 // movl %edi, %eax
Quentin Colombeta1a323c2015-07-01 23:12:13 +00001294 // ret
Andrew Kayloraac3c942015-09-28 20:33:22 +00001295 if (Commuted && !MI.isConvertibleTo3Addr())
1296 return false;
Bob Wilsoncc80df92009-09-03 20:58:42 +00001297
Cameron Zwarichc5a63492013-02-24 00:27:26 +00001298 if (shouldOnlyCommute)
1299 return false;
1300
Evan Cheng2a4410d2011-11-14 19:48:55 +00001301 // If there is one more use of regB later in the same MBB, consider
1302 // re-schedule this MI below it.
Quentin Colombet4bde0fa2015-07-06 20:12:54 +00001303 if (!Commuted && EnableRescheduling && rescheduleMIBelowKill(mi, nmi, regB)) {
Evan Cheng2a4410d2011-11-14 19:48:55 +00001304 ++NumReSchedDowns;
Lang Hamesf31ceaf2012-04-09 20:17:30 +00001305 return true;
Evan Cheng2a4410d2011-11-14 19:48:55 +00001306 }
1307
Craig Topper49c8f752015-10-06 05:39:59 +00001308 // If we commuted, regB may have changed so we should re-sample it to avoid
1309 // confusing the three address conversion below.
1310 if (Commuted) {
1311 regB = MI.getOperand(SrcIdx).getReg();
1312 regBKilled = isKilled(MI, regB, MRI, TII, LIS, true);
1313 }
1314
Evan Cheng5a96b3d2011-12-07 07:15:52 +00001315 if (MI.isConvertibleTo3Addr()) {
Bob Wilsoncc80df92009-09-03 20:58:42 +00001316 // This instruction is potentially convertible to a true
1317 // three-address instruction. Check if it is profitable.
Evan Chengf06e6c22011-03-02 01:08:17 +00001318 if (!regBKilled || isProfitableToConv3Addr(regA, regB)) {
Bob Wilsoncc80df92009-09-03 20:58:42 +00001319 // Try to convert it.
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +00001320 if (convertInstTo3Addr(mi, nmi, regA, regB, Dist)) {
Bob Wilsoncc80df92009-09-03 20:58:42 +00001321 ++NumConvertedTo3Addr;
1322 return true; // Done with this instruction.
1323 }
1324 }
1325 }
Dan Gohman584fedf2010-06-21 22:17:20 +00001326
Quentin Colombeta1a323c2015-07-01 23:12:13 +00001327 // Return if it is commuted but 3 addr conversion is failed.
Quentin Colombet4bde0fa2015-07-06 20:12:54 +00001328 if (Commuted)
Quentin Colombeta1a323c2015-07-01 23:12:13 +00001329 return false;
1330
Evan Cheng2a4410d2011-11-14 19:48:55 +00001331 // If there is one more use of regB later in the same MBB, consider
1332 // re-schedule it before this MI if it's legal.
Andrew Tricke2326ad2013-04-24 15:54:39 +00001333 if (EnableRescheduling && rescheduleKillAboveMI(mi, nmi, regB)) {
Evan Cheng2a4410d2011-11-14 19:48:55 +00001334 ++NumReSchedUps;
Lang Hamesf31ceaf2012-04-09 20:17:30 +00001335 return true;
Evan Cheng2a4410d2011-11-14 19:48:55 +00001336 }
1337
Dan Gohman584fedf2010-06-21 22:17:20 +00001338 // If this is an instruction with a load folded into it, try unfolding
1339 // the load, e.g. avoid this:
1340 // movq %rdx, %rcx
1341 // addq (%rax), %rcx
1342 // in favor of this:
1343 // movq (%rax), %rcx
1344 // addq %rdx, %rcx
1345 // because it's preferable to schedule a load than a register copy.
Evan Cheng5a96b3d2011-12-07 07:15:52 +00001346 if (MI.mayLoad() && !regBKilled) {
Dan Gohman584fedf2010-06-21 22:17:20 +00001347 // Determine if a load can be unfolded.
1348 unsigned LoadRegIndex;
1349 unsigned NewOpc =
Evan Cheng2a4410d2011-11-14 19:48:55 +00001350 TII->getOpcodeAfterMemoryUnfold(MI.getOpcode(),
Dan Gohman584fedf2010-06-21 22:17:20 +00001351 /*UnfoldLoad=*/true,
1352 /*UnfoldStore=*/false,
1353 &LoadRegIndex);
1354 if (NewOpc != 0) {
Evan Chenge837dea2011-06-28 19:10:37 +00001355 const MCInstrDesc &UnfoldMCID = TII->get(NewOpc);
1356 if (UnfoldMCID.getNumDefs() == 1) {
Dan Gohman584fedf2010-06-21 22:17:20 +00001357 // Unfold the load.
Nicola Zaghen0818e782018-05-14 12:53:11 +00001358 LLVM_DEBUG(dbgs() << "2addr: UNFOLDING: " << MI);
Dan Gohman584fedf2010-06-21 22:17:20 +00001359 const TargetRegisterClass *RC =
Andrew Trickf12f6df2012-05-03 01:14:37 +00001360 TRI->getAllocatableClass(
Jakob Stoklund Olesen6ac80662012-08-03 23:25:45 +00001361 TII->getRegClass(UnfoldMCID, LoadRegIndex, TRI, *MF));
Dan Gohman584fedf2010-06-21 22:17:20 +00001362 unsigned Reg = MRI->createVirtualRegister(RC);
1363 SmallVector<MachineInstr *, 2> NewMIs;
Duncan P. N. Exon Smith567409d2016-06-30 00:01:54 +00001364 if (!TII->unfoldMemoryOperand(*MF, MI, Reg,
1365 /*UnfoldLoad=*/true,
1366 /*UnfoldStore=*/false, NewMIs)) {
Nicola Zaghen0818e782018-05-14 12:53:11 +00001367 LLVM_DEBUG(dbgs() << "2addr: ABANDONING UNFOLD\n");
Evan Cheng98ec91e2010-07-02 20:36:18 +00001368 return false;
1369 }
Dan Gohman584fedf2010-06-21 22:17:20 +00001370 assert(NewMIs.size() == 2 &&
1371 "Unfolded a load into multiple instructions!");
1372 // The load was previously folded, so this is the only use.
1373 NewMIs[1]->addRegisterKilled(Reg, TRI);
1374
1375 // Tentatively insert the instructions into the block so that they
1376 // look "normal" to the transformation logic.
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +00001377 MBB->insert(mi, NewMIs[0]);
1378 MBB->insert(mi, NewMIs[1]);
Dan Gohman584fedf2010-06-21 22:17:20 +00001379
Nicola Zaghen0818e782018-05-14 12:53:11 +00001380 LLVM_DEBUG(dbgs() << "2addr: NEW LOAD: " << *NewMIs[0]
1381 << "2addr: NEW INST: " << *NewMIs[1]);
Dan Gohman584fedf2010-06-21 22:17:20 +00001382
1383 // Transform the instruction, now that it no longer has a load.
1384 unsigned NewDstIdx = NewMIs[1]->findRegisterDefOperandIdx(regA);
1385 unsigned NewSrcIdx = NewMIs[1]->findRegisterUseOperandIdx(regB);
1386 MachineBasicBlock::iterator NewMI = NewMIs[1];
Cameron Zwaricheb1b7252013-02-24 00:27:29 +00001387 bool TransformResult =
Cameron Zwarichc5a63492013-02-24 00:27:26 +00001388 tryInstructionTransform(NewMI, mi, NewSrcIdx, NewDstIdx, Dist, true);
Cameron Zwarichcc6137e2013-02-24 01:26:05 +00001389 (void)TransformResult;
Cameron Zwaricheb1b7252013-02-24 00:27:29 +00001390 assert(!TransformResult &&
1391 "tryInstructionTransform() should return false.");
1392 if (NewMIs[1]->getOperand(NewSrcIdx).isKill()) {
Dan Gohman584fedf2010-06-21 22:17:20 +00001393 // Success, or at least we made an improvement. Keep the unfolded
1394 // instructions and discard the original.
1395 if (LV) {
Evan Cheng2a4410d2011-11-14 19:48:55 +00001396 for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
1397 MachineOperand &MO = MI.getOperand(i);
Andrew Trick8247e0d2012-02-03 05:12:30 +00001398 if (MO.isReg() &&
Dan Gohman7aa7bc72010-06-22 00:32:04 +00001399 TargetRegisterInfo::isVirtualRegister(MO.getReg())) {
1400 if (MO.isUse()) {
Dan Gohmancc1ca982010-06-22 02:07:21 +00001401 if (MO.isKill()) {
1402 if (NewMIs[0]->killsRegister(MO.getReg()))
Duncan P. N. Exon Smith4383a512016-07-01 01:51:32 +00001403 LV->replaceKillInstruction(MO.getReg(), MI, *NewMIs[0]);
Dan Gohmancc1ca982010-06-22 02:07:21 +00001404 else {
1405 assert(NewMIs[1]->killsRegister(MO.getReg()) &&
1406 "Kill missing after load unfold!");
Duncan P. N. Exon Smith4383a512016-07-01 01:51:32 +00001407 LV->replaceKillInstruction(MO.getReg(), MI, *NewMIs[1]);
Dan Gohmancc1ca982010-06-22 02:07:21 +00001408 }
1409 }
Duncan P. N. Exon Smith4383a512016-07-01 01:51:32 +00001410 } else if (LV->removeVirtualRegisterDead(MO.getReg(), MI)) {
Dan Gohmancc1ca982010-06-22 02:07:21 +00001411 if (NewMIs[1]->registerDefIsDead(MO.getReg()))
Duncan P. N. Exon Smith4383a512016-07-01 01:51:32 +00001412 LV->addVirtualRegisterDead(MO.getReg(), *NewMIs[1]);
Dan Gohmancc1ca982010-06-22 02:07:21 +00001413 else {
1414 assert(NewMIs[0]->registerDefIsDead(MO.getReg()) &&
1415 "Dead flag missing after load unfold!");
Duncan P. N. Exon Smith4383a512016-07-01 01:51:32 +00001416 LV->addVirtualRegisterDead(MO.getReg(), *NewMIs[0]);
Dan Gohmancc1ca982010-06-22 02:07:21 +00001417 }
1418 }
Dan Gohman7aa7bc72010-06-22 00:32:04 +00001419 }
Dan Gohman584fedf2010-06-21 22:17:20 +00001420 }
Duncan P. N. Exon Smith4383a512016-07-01 01:51:32 +00001421 LV->addVirtualRegisterKilled(Reg, *NewMIs[1]);
Dan Gohman584fedf2010-06-21 22:17:20 +00001422 }
Cameron Zwarich9030fc22013-02-20 06:46:48 +00001423
Cameron Zwarich9030fc22013-02-20 06:46:48 +00001424 SmallVector<unsigned, 4> OrigRegs;
1425 if (LIS) {
Craig Topper96d2d442015-10-08 06:06:42 +00001426 for (const MachineOperand &MO : MI.operands()) {
1427 if (MO.isReg())
1428 OrigRegs.push_back(MO.getReg());
Cameron Zwarich9030fc22013-02-20 06:46:48 +00001429 }
1430 }
1431
Evan Cheng2a4410d2011-11-14 19:48:55 +00001432 MI.eraseFromParent();
Cameron Zwarich9030fc22013-02-20 06:46:48 +00001433
1434 // Update LiveIntervals.
Cameron Zwarichc5b61352013-02-20 22:10:00 +00001435 if (LIS) {
1436 MachineBasicBlock::iterator Begin(NewMIs[0]);
1437 MachineBasicBlock::iterator End(NewMIs[1]);
Cameron Zwarich9030fc22013-02-20 06:46:48 +00001438 LIS->repairIntervalsInRange(MBB, Begin, End, OrigRegs);
Cameron Zwarichc5b61352013-02-20 22:10:00 +00001439 }
Cameron Zwarich9030fc22013-02-20 06:46:48 +00001440
Dan Gohman584fedf2010-06-21 22:17:20 +00001441 mi = NewMIs[1];
Dan Gohman584fedf2010-06-21 22:17:20 +00001442 } else {
1443 // Transforming didn't eliminate the tie and didn't lead to an
1444 // improvement. Clean up the unfolded instructions and keep the
1445 // original.
Nicola Zaghen0818e782018-05-14 12:53:11 +00001446 LLVM_DEBUG(dbgs() << "2addr: ABANDONING UNFOLD\n");
Dan Gohman584fedf2010-06-21 22:17:20 +00001447 NewMIs[0]->eraseFromParent();
1448 NewMIs[1]->eraseFromParent();
1449 }
1450 }
1451 }
1452 }
1453
Bob Wilsoncc80df92009-09-03 20:58:42 +00001454 return false;
1455}
1456
Jakob Stoklund Olesen6ac80662012-08-03 23:25:45 +00001457// Collect tied operands of MI that need to be handled.
1458// Rewrite trivial cases immediately.
1459// Return true if any tied operands where found, including the trivial ones.
1460bool TwoAddressInstructionPass::
1461collectTiedOperands(MachineInstr *MI, TiedOperandMap &TiedOperands) {
1462 const MCInstrDesc &MCID = MI->getDesc();
1463 bool AnyOps = false;
Jakob Stoklund Olesenf363ebd2012-09-04 22:59:30 +00001464 unsigned NumOps = MI->getNumOperands();
Jakob Stoklund Olesen6ac80662012-08-03 23:25:45 +00001465
1466 for (unsigned SrcIdx = 0; SrcIdx < NumOps; ++SrcIdx) {
1467 unsigned DstIdx = 0;
1468 if (!MI->isRegTiedToDefOperand(SrcIdx, &DstIdx))
1469 continue;
1470 AnyOps = true;
Jakob Stoklund Olesen8c5c0732012-08-07 22:47:06 +00001471 MachineOperand &SrcMO = MI->getOperand(SrcIdx);
1472 MachineOperand &DstMO = MI->getOperand(DstIdx);
1473 unsigned SrcReg = SrcMO.getReg();
1474 unsigned DstReg = DstMO.getReg();
1475 // Tied constraint already satisfied?
1476 if (SrcReg == DstReg)
1477 continue;
Jakob Stoklund Olesen6ac80662012-08-03 23:25:45 +00001478
Jakob Stoklund Olesen8c5c0732012-08-07 22:47:06 +00001479 assert(SrcReg && SrcMO.isUse() && "two address instruction invalid");
Jakob Stoklund Olesen6ac80662012-08-03 23:25:45 +00001480
Francis Visoiu Mistrihfd11bc02017-12-07 10:40:31 +00001481 // Deal with undef uses immediately - simply rewrite the src operand.
Andrew Trickc4c5a1d2013-12-17 04:50:45 +00001482 if (SrcMO.isUndef() && !DstMO.getSubReg()) {
Jakob Stoklund Olesen6ac80662012-08-03 23:25:45 +00001483 // Constrain the DstReg register class if required.
1484 if (TargetRegisterInfo::isVirtualRegister(DstReg))
1485 if (const TargetRegisterClass *RC = TII->getRegClass(MCID, SrcIdx,
1486 TRI, *MF))
1487 MRI->constrainRegClass(DstReg, RC);
Jakob Stoklund Olesen8c5c0732012-08-07 22:47:06 +00001488 SrcMO.setReg(DstReg);
Andrew Trickc4c5a1d2013-12-17 04:50:45 +00001489 SrcMO.setSubReg(0);
Nicola Zaghen0818e782018-05-14 12:53:11 +00001490 LLVM_DEBUG(dbgs() << "\t\trewrite undef:\t" << *MI);
Jakob Stoklund Olesen6ac80662012-08-03 23:25:45 +00001491 continue;
1492 }
Jakob Stoklund Olesen8c5c0732012-08-07 22:47:06 +00001493 TiedOperands[SrcReg].push_back(std::make_pair(SrcIdx, DstIdx));
Jakob Stoklund Olesen6ac80662012-08-03 23:25:45 +00001494 }
1495 return AnyOps;
1496}
1497
Jakob Stoklund Olesenae52fad2012-08-03 23:57:58 +00001498// Process a list of tied MI operands that all use the same source register.
1499// The tied pairs are of the form (SrcIdx, DstIdx).
1500void
1501TwoAddressInstructionPass::processTiedPairs(MachineInstr *MI,
1502 TiedPairList &TiedPairs,
1503 unsigned &Dist) {
1504 bool IsEarlyClobber = false;
Cameron Zwarich6cf93d72013-02-20 06:46:46 +00001505 for (unsigned tpi = 0, tpe = TiedPairs.size(); tpi != tpe; ++tpi) {
1506 const MachineOperand &DstMO = MI->getOperand(TiedPairs[tpi].second);
1507 IsEarlyClobber |= DstMO.isEarlyClobber();
1508 }
1509
Jakob Stoklund Olesenae52fad2012-08-03 23:57:58 +00001510 bool RemovedKillFlag = false;
1511 bool AllUsesCopied = true;
1512 unsigned LastCopiedReg = 0;
Cameron Zwarich9030fc22013-02-20 06:46:48 +00001513 SlotIndex LastCopyIdx;
Jakob Stoklund Olesenae52fad2012-08-03 23:57:58 +00001514 unsigned RegB = 0;
Andrew Trickc4c5a1d2013-12-17 04:50:45 +00001515 unsigned SubRegB = 0;
Jakob Stoklund Olesenae52fad2012-08-03 23:57:58 +00001516 for (unsigned tpi = 0, tpe = TiedPairs.size(); tpi != tpe; ++tpi) {
1517 unsigned SrcIdx = TiedPairs[tpi].first;
1518 unsigned DstIdx = TiedPairs[tpi].second;
1519
1520 const MachineOperand &DstMO = MI->getOperand(DstIdx);
1521 unsigned RegA = DstMO.getReg();
Jakob Stoklund Olesenae52fad2012-08-03 23:57:58 +00001522
1523 // Grab RegB from the instruction because it may have changed if the
1524 // instruction was commuted.
1525 RegB = MI->getOperand(SrcIdx).getReg();
Andrew Trickc4c5a1d2013-12-17 04:50:45 +00001526 SubRegB = MI->getOperand(SrcIdx).getSubReg();
Jakob Stoklund Olesenae52fad2012-08-03 23:57:58 +00001527
1528 if (RegA == RegB) {
1529 // The register is tied to multiple destinations (or else we would
1530 // not have continued this far), but this use of the register
1531 // already matches the tied destination. Leave it.
1532 AllUsesCopied = false;
1533 continue;
1534 }
1535 LastCopiedReg = RegA;
1536
1537 assert(TargetRegisterInfo::isVirtualRegister(RegB) &&
1538 "cannot make instruction into two-address form");
1539
1540#ifndef NDEBUG
1541 // First, verify that we don't have a use of "a" in the instruction
1542 // (a = b + a for example) because our transformation will not
1543 // work. This should never occur because we are in SSA form.
1544 for (unsigned i = 0; i != MI->getNumOperands(); ++i)
1545 assert(i == DstIdx ||
1546 !MI->getOperand(i).isReg() ||
1547 MI->getOperand(i).getReg() != RegA);
1548#endif
1549
1550 // Emit a copy.
Andrew Trickc4c5a1d2013-12-17 04:50:45 +00001551 MachineInstrBuilder MIB = BuildMI(*MI->getParent(), MI, MI->getDebugLoc(),
1552 TII->get(TargetOpcode::COPY), RegA);
1553 // If this operand is folding a truncation, the truncation now moves to the
1554 // copy so that the register classes remain valid for the operands.
1555 MIB.addReg(RegB, 0, SubRegB);
1556 const TargetRegisterClass *RC = MRI->getRegClass(RegB);
1557 if (SubRegB) {
1558 if (TargetRegisterInfo::isVirtualRegister(RegA)) {
1559 assert(TRI->getMatchingSuperRegClass(RC, MRI->getRegClass(RegA),
1560 SubRegB) &&
1561 "tied subregister must be a truncation");
1562 // The superreg class will not be used to constrain the subreg class.
Craig Topper4ba84432014-04-14 00:51:57 +00001563 RC = nullptr;
Andrew Trickc4c5a1d2013-12-17 04:50:45 +00001564 }
1565 else {
1566 assert(TRI->getMatchingSuperReg(RegA, SubRegB, MRI->getRegClass(RegB))
1567 && "tied subregister must be a truncation");
1568 }
1569 }
Jakob Stoklund Olesenae52fad2012-08-03 23:57:58 +00001570
1571 // Update DistanceMap.
1572 MachineBasicBlock::iterator PrevMI = MI;
1573 --PrevMI;
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +00001574 DistanceMap.insert(std::make_pair(&*PrevMI, Dist));
Jakob Stoklund Olesenae52fad2012-08-03 23:57:58 +00001575 DistanceMap[MI] = ++Dist;
1576
Cameron Zwarich9030fc22013-02-20 06:46:48 +00001577 if (LIS) {
Duncan P. N. Exon Smith42e18352016-02-27 06:40:41 +00001578 LastCopyIdx = LIS->InsertMachineInstrInMaps(*PrevMI).getRegSlot();
Cameron Zwarich9030fc22013-02-20 06:46:48 +00001579
1580 if (TargetRegisterInfo::isVirtualRegister(RegA)) {
1581 LiveInterval &LI = LIS->getInterval(RegA);
1582 VNInfo *VNI = LI.getNextValue(LastCopyIdx, LIS->getVNInfoAllocator());
1583 SlotIndex endIdx =
Duncan P. N. Exon Smith42e18352016-02-27 06:40:41 +00001584 LIS->getInstructionIndex(*MI).getRegSlot(IsEarlyClobber);
Matthias Braun331de112013-10-10 21:28:43 +00001585 LI.addSegment(LiveInterval::Segment(LastCopyIdx, endIdx, VNI));
Cameron Zwarich9030fc22013-02-20 06:46:48 +00001586 }
1587 }
Jakob Stoklund Olesenae52fad2012-08-03 23:57:58 +00001588
Nicola Zaghen0818e782018-05-14 12:53:11 +00001589 LLVM_DEBUG(dbgs() << "\t\tprepend:\t" << *MIB);
Jakob Stoklund Olesenae52fad2012-08-03 23:57:58 +00001590
1591 MachineOperand &MO = MI->getOperand(SrcIdx);
1592 assert(MO.isReg() && MO.getReg() == RegB && MO.isUse() &&
1593 "inconsistent operand info for 2-reg pass");
1594 if (MO.isKill()) {
1595 MO.setIsKill(false);
1596 RemovedKillFlag = true;
1597 }
1598
1599 // Make sure regA is a legal regclass for the SrcIdx operand.
1600 if (TargetRegisterInfo::isVirtualRegister(RegA) &&
1601 TargetRegisterInfo::isVirtualRegister(RegB))
Andrew Trickc4c5a1d2013-12-17 04:50:45 +00001602 MRI->constrainRegClass(RegA, RC);
Jakob Stoklund Olesenae52fad2012-08-03 23:57:58 +00001603 MO.setReg(RegA);
Andrew Trickc4c5a1d2013-12-17 04:50:45 +00001604 // The getMatchingSuper asserts guarantee that the register class projected
1605 // by SubRegB is compatible with RegA with no subregister. So regardless of
1606 // whether the dest oper writes a subreg, the source oper should not.
1607 MO.setSubReg(0);
Jakob Stoklund Olesenae52fad2012-08-03 23:57:58 +00001608
1609 // Propagate SrcRegMap.
1610 SrcRegMap[RegA] = RegB;
1611 }
1612
Jakob Stoklund Olesenae52fad2012-08-03 23:57:58 +00001613 if (AllUsesCopied) {
Bjorn Petterssonffc5ec82018-10-15 08:36:03 +00001614 bool ReplacedAllUntiedUses = true;
Jakob Stoklund Olesenae52fad2012-08-03 23:57:58 +00001615 if (!IsEarlyClobber) {
1616 // Replace other (un-tied) uses of regB with LastCopiedReg.
Sanjay Patel116b08e2015-12-01 19:57:43 +00001617 for (MachineOperand &MO : MI->operands()) {
Bjorn Petterssonffc5ec82018-10-15 08:36:03 +00001618 if (MO.isReg() && MO.getReg() == RegB && MO.isUse()) {
1619 if (MO.getSubReg() == SubRegB) {
1620 if (MO.isKill()) {
1621 MO.setIsKill(false);
1622 RemovedKillFlag = true;
1623 }
1624 MO.setReg(LastCopiedReg);
1625 MO.setSubReg(0);
1626 } else {
1627 ReplacedAllUntiedUses = false;
Jakob Stoklund Olesenae52fad2012-08-03 23:57:58 +00001628 }
Jakob Stoklund Olesenae52fad2012-08-03 23:57:58 +00001629 }
1630 }
1631 }
1632
1633 // Update live variables for regB.
Bjorn Petterssonffc5ec82018-10-15 08:36:03 +00001634 if (RemovedKillFlag && ReplacedAllUntiedUses &&
1635 LV && LV->getVarInfo(RegB).removeKill(*MI)) {
Jakob Stoklund Olesenae52fad2012-08-03 23:57:58 +00001636 MachineBasicBlock::iterator PrevMI = MI;
1637 --PrevMI;
Duncan P. N. Exon Smith4383a512016-07-01 01:51:32 +00001638 LV->addVirtualRegisterKilled(RegB, *PrevMI);
Jakob Stoklund Olesenae52fad2012-08-03 23:57:58 +00001639 }
1640
Cameron Zwarich9030fc22013-02-20 06:46:48 +00001641 // Update LiveIntervals.
1642 if (LIS) {
1643 LiveInterval &LI = LIS->getInterval(RegB);
Duncan P. N. Exon Smith42e18352016-02-27 06:40:41 +00001644 SlotIndex MIIdx = LIS->getInstructionIndex(*MI);
Cameron Zwarich9030fc22013-02-20 06:46:48 +00001645 LiveInterval::const_iterator I = LI.find(MIIdx);
1646 assert(I != LI.end() && "RegB must be live-in to use.");
1647
1648 SlotIndex UseIdx = MIIdx.getRegSlot(IsEarlyClobber);
1649 if (I->end == UseIdx)
Matthias Braun331de112013-10-10 21:28:43 +00001650 LI.removeSegment(LastCopyIdx, UseIdx);
Cameron Zwarich9030fc22013-02-20 06:46:48 +00001651 }
Jakob Stoklund Olesenae52fad2012-08-03 23:57:58 +00001652 } else if (RemovedKillFlag) {
1653 // Some tied uses of regB matched their destination registers, so
1654 // regB is still used in this instruction, but a kill flag was
1655 // removed from a different tied use of regB, so now we need to add
1656 // a kill flag to one of the remaining uses of regB.
Sanjay Patel116b08e2015-12-01 19:57:43 +00001657 for (MachineOperand &MO : MI->operands()) {
Jakob Stoklund Olesenae52fad2012-08-03 23:57:58 +00001658 if (MO.isReg() && MO.getReg() == RegB && MO.isUse()) {
1659 MO.setIsKill(true);
1660 break;
1661 }
1662 }
1663 }
Jakob Stoklund Olesenae52fad2012-08-03 23:57:58 +00001664}
1665
Sanjay Patel936f2da2015-12-01 19:32:35 +00001666/// Reduce two-address instructions to two operands.
Jakob Stoklund Olesen6ac80662012-08-03 23:25:45 +00001667bool TwoAddressInstructionPass::runOnMachineFunction(MachineFunction &Func) {
1668 MF = &Func;
1669 const TargetMachine &TM = MF->getTarget();
1670 MRI = &MF->getRegInfo();
Eric Christopherad5a8572015-01-27 08:48:42 +00001671 TII = MF->getSubtarget().getInstrInfo();
1672 TRI = MF->getSubtarget().getRegisterInfo();
1673 InstrItins = MF->getSubtarget().getInstrItineraryData();
Duncan Sands1465d612009-01-28 13:14:17 +00001674 LV = getAnalysisIfAvailable<LiveVariables>();
Jakob Stoklund Olesen5bfdedf2012-08-03 22:58:34 +00001675 LIS = getAnalysisIfAvailable<LiveIntervals>();
Ahmed Bougachabf31cb72017-05-10 00:56:00 +00001676 if (auto *AAPass = getAnalysisIfAvailable<AAResultsWrapperPass>())
1677 AA = &AAPass->getAAResults();
1678 else
1679 AA = nullptr;
Evan Chengc3aa7c52011-11-16 18:44:48 +00001680 OptLevel = TM.getOptLevel();
Matthias Braunc67785b2017-12-05 00:56:14 +00001681 // Disable optimizations if requested. We cannot skip the whole pass as some
1682 // fixups are necessary for correctness.
Matthias Braund3181392017-12-15 22:22:58 +00001683 if (skipFunction(Func.getFunction()))
Matthias Braunc67785b2017-12-05 00:56:14 +00001684 OptLevel = CodeGenOpt::None;
Alkis Evlogimenos71499de2003-12-18 13:06:04 +00001685
Misha Brukman75fa4e42004-07-22 15:26:23 +00001686 bool MadeChange = false;
Alkis Evlogimenos71499de2003-12-18 13:06:04 +00001687
Nicola Zaghen0818e782018-05-14 12:53:11 +00001688 LLVM_DEBUG(dbgs() << "********** REWRITING TWO-ADDR INSTRS **********\n");
1689 LLVM_DEBUG(dbgs() << "********** Function: " << MF->getName() << '\n');
Alkis Evlogimenos3a9986f2004-02-18 00:35:06 +00001690
Jakob Stoklund Olesen73e7dce2011-07-29 22:51:22 +00001691 // This pass takes the function out of SSA form.
1692 MRI->leaveSSA();
1693
Jakob Stoklund Olesen6ac80662012-08-03 23:25:45 +00001694 TiedOperandMap TiedOperands;
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +00001695 for (MachineFunction::iterator MBBI = MF->begin(), MBBE = MF->end();
1696 MBBI != MBBE; ++MBBI) {
Duncan P. N. Exon Smithac4d7b62015-10-09 22:56:24 +00001697 MBB = &*MBBI;
Evan Cheng7543e582008-06-18 07:49:14 +00001698 unsigned Dist = 0;
1699 DistanceMap.clear();
Evan Cheng870b8072009-03-01 02:03:43 +00001700 SrcRegMap.clear();
1701 DstRegMap.clear();
1702 Processed.clear();
Jonas Paulsson62f11d92017-12-04 10:03:14 +00001703 SunkInstrs.clear();
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +00001704 for (MachineBasicBlock::iterator mi = MBB->begin(), me = MBB->end();
Evan Cheng7a963fa2008-03-27 01:27:25 +00001705 mi != me; ) {
Benjamin Kramerd628f192014-03-02 12:27:27 +00001706 MachineBasicBlock::iterator nmi = std::next(mi);
Jonas Paulsson62f11d92017-12-04 10:03:14 +00001707 // Don't revisit an instruction previously converted by target. It may
1708 // contain undef register operands (%noreg), which are not handled.
Shiva Chen24abe712018-05-09 02:42:00 +00001709 if (mi->isDebugInstr() || SunkInstrs.count(&*mi)) {
Dale Johannesenb8ff9342010-02-10 21:47:48 +00001710 mi = nmi;
1711 continue;
1712 }
Evan Chengf1250ee2010-03-23 20:36:12 +00001713
Jakob Stoklund Olesen8c3dccd2012-12-01 01:06:44 +00001714 // Expand REG_SEQUENCE instructions. This will position mi at the first
1715 // expanded instruction.
Evan Cheng3d720fb2010-05-05 18:45:40 +00001716 if (mi->isRegSequence())
Jakob Stoklund Olesen8c3dccd2012-12-01 01:06:44 +00001717 eliminateRegSequence(mi);
Evan Cheng3d720fb2010-05-05 18:45:40 +00001718
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +00001719 DistanceMap.insert(std::make_pair(&*mi, ++Dist));
Evan Cheng870b8072009-03-01 02:03:43 +00001720
Jakob Stoklund Olesen0de4fd22012-10-26 23:05:10 +00001721 processCopy(&*mi);
Evan Cheng870b8072009-03-01 02:03:43 +00001722
Bob Wilsoncc80df92009-09-03 20:58:42 +00001723 // First scan through all the tied register uses in this instruction
1724 // and record a list of pairs of tied operands for each register.
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +00001725 if (!collectTiedOperands(&*mi, TiedOperands)) {
Jakob Stoklund Olesen6ac80662012-08-03 23:25:45 +00001726 mi = nmi;
1727 continue;
Bob Wilsoncc80df92009-09-03 20:58:42 +00001728 }
Alkis Evlogimenos71499de2003-12-18 13:06:04 +00001729
Jakob Stoklund Olesen6ac80662012-08-03 23:25:45 +00001730 ++NumTwoAddressInstrs;
Jakob Stoklund Olesenae52fad2012-08-03 23:57:58 +00001731 MadeChange = true;
Nicola Zaghen0818e782018-05-14 12:53:11 +00001732 LLVM_DEBUG(dbgs() << '\t' << *mi);
Jakob Stoklund Olesen6ac80662012-08-03 23:25:45 +00001733
Chandler Carruth32d75be2012-07-18 18:58:22 +00001734 // If the instruction has a single pair of tied operands, try some
1735 // transformations that may either eliminate the tied operands or
1736 // improve the opportunities for coalescing away the register copy.
1737 if (TiedOperands.size() == 1) {
Eugene Zelenko94348112017-09-29 21:55:49 +00001738 SmallVectorImpl<std::pair<unsigned, unsigned>> &TiedPairs
Chandler Carruth32d75be2012-07-18 18:58:22 +00001739 = TiedOperands.begin()->second;
1740 if (TiedPairs.size() == 1) {
1741 unsigned SrcIdx = TiedPairs[0].first;
1742 unsigned DstIdx = TiedPairs[0].second;
1743 unsigned SrcReg = mi->getOperand(SrcIdx).getReg();
1744 unsigned DstReg = mi->getOperand(DstIdx).getReg();
1745 if (SrcReg != DstReg &&
Cameron Zwarichc5a63492013-02-24 00:27:26 +00001746 tryInstructionTransform(mi, nmi, SrcIdx, DstIdx, Dist, false)) {
NAKAMURA Takumi6902c8d2015-09-22 11:14:12 +00001747 // The tied operands have been eliminated or shifted further down
1748 // the block to ease elimination. Continue processing with 'nmi'.
Chandler Carruth32d75be2012-07-18 18:58:22 +00001749 TiedOperands.clear();
1750 mi = nmi;
1751 continue;
1752 }
1753 }
1754 }
1755
Bob Wilsoncc80df92009-09-03 20:58:42 +00001756 // Now iterate over the information collected above.
Craig Topper96d2d442015-10-08 06:06:42 +00001757 for (auto &TO : TiedOperands) {
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +00001758 processTiedPairs(&*mi, TO.second, Dist);
Nicola Zaghen0818e782018-05-14 12:53:11 +00001759 LLVM_DEBUG(dbgs() << "\t\trewrite to:\t" << *mi);
Jakob Stoklund Olesen351c8812012-06-25 03:27:12 +00001760 }
Bill Wendling637980e2008-05-10 00:12:52 +00001761
Jakob Stoklund Olesen351c8812012-06-25 03:27:12 +00001762 // Rewrite INSERT_SUBREG as COPY now that we no longer need SSA form.
1763 if (mi->isInsertSubreg()) {
1764 // From %reg = INSERT_SUBREG %reg, %subreg, subidx
1765 // To %reg:subidx = COPY %subreg
1766 unsigned SubIdx = mi->getOperand(3).getImm();
1767 mi->RemoveOperand(3);
1768 assert(mi->getOperand(0).getSubReg() == 0 && "Unexpected subreg idx");
1769 mi->getOperand(0).setSubReg(SubIdx);
1770 mi->getOperand(0).setIsUndef(mi->getOperand(1).isUndef());
1771 mi->RemoveOperand(1);
1772 mi->setDesc(TII->get(TargetOpcode::COPY));
Nicola Zaghen0818e782018-05-14 12:53:11 +00001773 LLVM_DEBUG(dbgs() << "\t\tconvert to:\t" << *mi);
Jakob Stoklund Olesened2185e2010-07-06 23:26:25 +00001774 }
1775
Bob Wilsoncc80df92009-09-03 20:58:42 +00001776 // Clear TiedOperands here instead of at the top of the loop
1777 // since most instructions do not have tied operands.
1778 TiedOperands.clear();
Evan Cheng7a963fa2008-03-27 01:27:25 +00001779 mi = nmi;
Misha Brukman75fa4e42004-07-22 15:26:23 +00001780 }
1781 }
1782
Cameron Zwarich767e0432013-02-20 06:46:34 +00001783 if (LIS)
1784 MF->verify(this, "After two-address instruction pass");
1785
Misha Brukman75fa4e42004-07-22 15:26:23 +00001786 return MadeChange;
Alkis Evlogimenos71499de2003-12-18 13:06:04 +00001787}
Evan Cheng3d720fb2010-05-05 18:45:40 +00001788
Jakob Stoklund Olesen8c3dccd2012-12-01 01:06:44 +00001789/// Eliminate a REG_SEQUENCE instruction as part of the de-ssa process.
Evan Cheng3d720fb2010-05-05 18:45:40 +00001790///
Jakob Stoklund Olesen8c3dccd2012-12-01 01:06:44 +00001791/// The instruction is turned into a sequence of sub-register copies:
1792///
1793/// %dst = REG_SEQUENCE %v1, ssub0, %v2, ssub1
1794///
1795/// Becomes:
1796///
Francis Visoiu Mistrihfd11bc02017-12-07 10:40:31 +00001797/// undef %dst:ssub0 = COPY %v1
1798/// %dst:ssub1 = COPY %v2
Jakob Stoklund Olesen8c3dccd2012-12-01 01:06:44 +00001799void TwoAddressInstructionPass::
1800eliminateRegSequence(MachineBasicBlock::iterator &MBBI) {
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +00001801 MachineInstr &MI = *MBBI;
1802 unsigned DstReg = MI.getOperand(0).getReg();
1803 if (MI.getOperand(0).getSubReg() ||
Jakob Stoklund Olesen8c3dccd2012-12-01 01:06:44 +00001804 TargetRegisterInfo::isPhysicalRegister(DstReg) ||
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +00001805 !(MI.getNumOperands() & 1)) {
Nicola Zaghen0818e782018-05-14 12:53:11 +00001806 LLVM_DEBUG(dbgs() << "Illegal REG_SEQUENCE instruction:" << MI);
Craig Topper4ba84432014-04-14 00:51:57 +00001807 llvm_unreachable(nullptr);
Evan Cheng3d720fb2010-05-05 18:45:40 +00001808 }
1809
Cameron Zwarich9030fc22013-02-20 06:46:48 +00001810 SmallVector<unsigned, 4> OrigRegs;
1811 if (LIS) {
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +00001812 OrigRegs.push_back(MI.getOperand(0).getReg());
1813 for (unsigned i = 1, e = MI.getNumOperands(); i < e; i += 2)
1814 OrigRegs.push_back(MI.getOperand(i).getReg());
Cameron Zwarich9030fc22013-02-20 06:46:48 +00001815 }
1816
Jakob Stoklund Olesen8c3dccd2012-12-01 01:06:44 +00001817 bool DefEmitted = false;
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +00001818 for (unsigned i = 1, e = MI.getNumOperands(); i < e; i += 2) {
1819 MachineOperand &UseMO = MI.getOperand(i);
Jakob Stoklund Olesen8c3dccd2012-12-01 01:06:44 +00001820 unsigned SrcReg = UseMO.getReg();
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +00001821 unsigned SubIdx = MI.getOperand(i+1).getImm();
Francis Visoiu Mistrihfd11bc02017-12-07 10:40:31 +00001822 // Nothing needs to be inserted for undef operands.
Jakob Stoklund Olesen8c3dccd2012-12-01 01:06:44 +00001823 if (UseMO.isUndef())
1824 continue;
1825
1826 // Defer any kill flag to the last operand using SrcReg. Otherwise, we
1827 // might insert a COPY that uses SrcReg after is was killed.
1828 bool isKill = UseMO.isKill();
1829 if (isKill)
1830 for (unsigned j = i + 2; j < e; j += 2)
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +00001831 if (MI.getOperand(j).getReg() == SrcReg) {
1832 MI.getOperand(j).setIsKill();
Jakob Stoklund Olesen8c3dccd2012-12-01 01:06:44 +00001833 UseMO.setIsKill(false);
1834 isKill = false;
1835 break;
1836 }
1837
1838 // Insert the sub-register copy.
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +00001839 MachineInstr *CopyMI = BuildMI(*MI.getParent(), MI, MI.getDebugLoc(),
Jakob Stoklund Olesen8c3dccd2012-12-01 01:06:44 +00001840 TII->get(TargetOpcode::COPY))
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +00001841 .addReg(DstReg, RegState::Define, SubIdx)
Diana Picus8a478102017-01-13 09:58:52 +00001842 .add(UseMO);
Jakob Stoklund Olesen8c3dccd2012-12-01 01:06:44 +00001843
Francis Visoiu Mistrihfd11bc02017-12-07 10:40:31 +00001844 // The first def needs an undef flag because there is no live register
Jakob Stoklund Olesen8c3dccd2012-12-01 01:06:44 +00001845 // before it.
1846 if (!DefEmitted) {
1847 CopyMI->getOperand(0).setIsUndef(true);
1848 // Return an iterator pointing to the first inserted instr.
1849 MBBI = CopyMI;
1850 }
1851 DefEmitted = true;
1852
1853 // Update LiveVariables' kill info.
1854 if (LV && isKill && !TargetRegisterInfo::isPhysicalRegister(SrcReg))
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +00001855 LV->replaceKillInstruction(SrcReg, MI, *CopyMI);
Jakob Stoklund Olesen8c3dccd2012-12-01 01:06:44 +00001856
Nicola Zaghen0818e782018-05-14 12:53:11 +00001857 LLVM_DEBUG(dbgs() << "Inserted: " << *CopyMI);
Jakob Stoklund Olesen8c3dccd2012-12-01 01:06:44 +00001858 }
1859
David Blaikiefdf45172013-02-20 07:39:20 +00001860 MachineBasicBlock::iterator EndMBBI =
Benjamin Kramerd628f192014-03-02 12:27:27 +00001861 std::next(MachineBasicBlock::iterator(MI));
Cameron Zwarich9030fc22013-02-20 06:46:48 +00001862
Jakob Stoklund Olesen8c3dccd2012-12-01 01:06:44 +00001863 if (!DefEmitted) {
Nicola Zaghen0818e782018-05-14 12:53:11 +00001864 LLVM_DEBUG(dbgs() << "Turned: " << MI << " into an IMPLICIT_DEF");
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +00001865 MI.setDesc(TII->get(TargetOpcode::IMPLICIT_DEF));
1866 for (int j = MI.getNumOperands() - 1, ee = 0; j > ee; --j)
1867 MI.RemoveOperand(j);
Jakob Stoklund Olesen8c3dccd2012-12-01 01:06:44 +00001868 } else {
Nicola Zaghen0818e782018-05-14 12:53:11 +00001869 LLVM_DEBUG(dbgs() << "Eliminated: " << MI);
Duncan P. N. Exon Smithccb7a2f2016-07-08 17:43:08 +00001870 MI.eraseFromParent();
Jakob Stoklund Olesen8c3dccd2012-12-01 01:06:44 +00001871 }
Cameron Zwarich9030fc22013-02-20 06:46:48 +00001872
1873 // Udpate LiveIntervals.
Cameron Zwarichc5b61352013-02-20 22:10:00 +00001874 if (LIS)
Cameron Zwarich9030fc22013-02-20 06:46:48 +00001875 LIS->repairIntervalsInRange(MBB, MBBI, EndMBBI, OrigRegs);
Evan Cheng3d720fb2010-05-05 18:45:40 +00001876}