1//===- HexagonGenMux.cpp --------------------------------------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9// During instruction selection, MUX instructions are generated for
10// conditional assignments. Since such assignments often present an
11// opportunity to predicate instructions, HexagonExpandCondsets
12// expands MUXes into pairs of conditional transfers, and then proceeds
13// with predication of the producers/consumers of the registers involved.
14// This happens after exiting from the SSA form, but before the machine
15// instruction scheduler. After the scheduler and after the register
16// allocation there can be cases of pairs of conditional transfers
17// resulting from a MUX where neither of them was further predicated. If
18// these transfers are now placed far enough from the instruction defining
19// the predicate register, they cannot use the .new form. In such cases it
20// is better to collapse them back to a single MUX instruction.
21
22#include "Hexagon.h"
23#include "HexagonInstrInfo.h"
24#include "HexagonRegisterInfo.h"
25#include "HexagonSubtarget.h"
26#include "llvm/ADT/BitVector.h"
27#include "llvm/ADT/DenseMap.h"
28#include "llvm/ADT/SmallVector.h"
29#include "llvm/ADT/StringRef.h"
30#include "llvm/CodeGen/LiveRegUnits.h"
31#include "llvm/CodeGen/MachineBasicBlock.h"
32#include "llvm/CodeGen/MachineFunction.h"
33#include "llvm/CodeGen/MachineFunctionPass.h"
34#include "llvm/CodeGen/MachineInstr.h"
35#include "llvm/CodeGen/MachineInstrBuilder.h"
36#include "llvm/CodeGen/MachineOperand.h"
37#include "llvm/IR/DebugLoc.h"
38#include "llvm/MC/MCInstrDesc.h"
39#include "llvm/Pass.h"
40#include "llvm/Support/CommandLine.h"
41#include "llvm/Support/MathExtras.h"
42#include <algorithm>
43#include <cassert>
44#include <iterator>
45#include <limits>
46
47#define DEBUG_TYPE "hexmux"
48
49using namespace llvm;
50
51// Initialize this to 0 to always prefer generating mux by default.
52static cl::opt<unsigned> MinPredDist("hexagon-gen-mux-threshold", cl::Hidden,
53 cl::init(Val: 0), cl::desc("Minimum distance between predicate definition and "
54 "farther of the two predicated uses"));
55
56namespace {
57
58 class HexagonGenMux : public MachineFunctionPass {
59 public:
60 static char ID;
61
62 HexagonGenMux() : MachineFunctionPass(ID) {}
63
64 StringRef getPassName() const override {
65 return "Hexagon generate mux instructions";
66 }
67
68 void getAnalysisUsage(AnalysisUsage &AU) const override {
69 MachineFunctionPass::getAnalysisUsage(AU);
70 }
71
72 bool runOnMachineFunction(MachineFunction &MF) override;
73
74 MachineFunctionProperties getRequiredProperties() const override {
75 return MachineFunctionProperties().setNoVRegs();
76 }
77
78 private:
79 const HexagonInstrInfo *HII = nullptr;
80 const HexagonRegisterInfo *HRI = nullptr;
81
82 struct CondsetInfo {
83 unsigned PredR = 0;
84 unsigned TrueX = std::numeric_limits<unsigned>::max();
85 unsigned FalseX = std::numeric_limits<unsigned>::max();
86
87 CondsetInfo() = default;
88 };
89
90 struct DefUseInfo {
91 BitVector Defs, Uses;
92
93 DefUseInfo() = default;
94 DefUseInfo(const BitVector &D, const BitVector &U) : Defs(D), Uses(U) {}
95 };
96
97 struct MuxInfo {
98 MachineBasicBlock::iterator At;
99 unsigned DefR, PredR;
100 MachineOperand *SrcT, *SrcF;
101 MachineInstr *Def1, *Def2;
102
103 MuxInfo(MachineBasicBlock::iterator It, unsigned DR, unsigned PR,
104 MachineOperand *TOp, MachineOperand *FOp, MachineInstr &D1,
105 MachineInstr &D2)
106 : At(It), DefR(DR), PredR(PR), SrcT(TOp), SrcF(FOp), Def1(&D1),
107 Def2(&D2) {}
108 };
109
110 using InstrIndexMap = DenseMap<MachineInstr *, unsigned>;
111 using DefUseInfoMap = DenseMap<unsigned, DefUseInfo>;
112 using MuxInfoList = SmallVector<MuxInfo, 4>;
113
114 bool isRegPair(unsigned Reg) const {
115 return Hexagon::DoubleRegsRegClass.contains(Reg);
116 }
117
118 void getSubRegs(unsigned Reg, BitVector &SRs) const;
119 void expandReg(unsigned Reg, BitVector &Set) const;
120 void getDefsUses(const MachineInstr *MI, BitVector &Defs,
121 BitVector &Uses) const;
122 void buildMaps(MachineBasicBlock &B, InstrIndexMap &I2X,
123 DefUseInfoMap &DUM);
124 bool isCondTransfer(unsigned Opc) const;
125 unsigned getMuxOpcode(const MachineOperand &Src1,
126 const MachineOperand &Src2) const;
127 bool genMuxInBlock(MachineBasicBlock &B);
128 };
129
130} // end anonymous namespace
131
132char HexagonGenMux::ID = 0;
133
134INITIALIZE_PASS(HexagonGenMux, "hexagon-gen-mux",
135 "Hexagon generate mux instructions", false, false)
136
137void HexagonGenMux::getSubRegs(unsigned Reg, BitVector &SRs) const {
138 for (MCPhysReg I : HRI->subregs(Reg))
139 SRs[I] = true;
140}
141
142void HexagonGenMux::expandReg(unsigned Reg, BitVector &Set) const {
143 if (isRegPair(Reg))
144 getSubRegs(Reg, SRs&: Set);
145 else
146 Set[Reg] = true;
147}
148
149void HexagonGenMux::getDefsUses(const MachineInstr *MI, BitVector &Defs,
150 BitVector &Uses) const {
151 // First, get the implicit defs and uses for this instruction.
152 unsigned Opc = MI->getOpcode();
153 const MCInstrDesc &D = HII->get(Opcode: Opc);
154 for (MCPhysReg R : D.implicit_defs())
155 expandReg(Reg: R, Set&: Defs);
156 for (MCPhysReg R : D.implicit_uses())
157 expandReg(Reg: R, Set&: Uses);
158
159 // Look over all operands, and collect explicit defs and uses.
160 for (const MachineOperand &MO : MI->operands()) {
161 if (!MO.isReg() || MO.isImplicit())
162 continue;
163 Register R = MO.getReg();
164 BitVector &Set = MO.isDef() ? Defs : Uses;
165 expandReg(Reg: R, Set);
166 }
167}
168
169void HexagonGenMux::buildMaps(MachineBasicBlock &B, InstrIndexMap &I2X,
170 DefUseInfoMap &DUM) {
171 unsigned Index = 0;
172 unsigned NR = HRI->getNumRegs();
173 BitVector Defs(NR), Uses(NR);
174
175 for (MachineInstr &MI : B) {
176 I2X.insert(KV: std::make_pair(x: &MI, y&: Index));
177 Defs.reset();
178 Uses.reset();
179 if (!MI.isDebugInstr())
180 getDefsUses(MI: &MI, Defs, Uses);
181 DUM.insert(KV: std::make_pair(x&: Index, y: DefUseInfo(Defs, Uses)));
182 Index++;
183 }
184}
185
186bool HexagonGenMux::isCondTransfer(unsigned Opc) const {
187 switch (Opc) {
188 case Hexagon::A2_tfrt:
189 case Hexagon::A2_tfrf:
190 case Hexagon::C2_cmoveit:
191 case Hexagon::C2_cmoveif:
192 return true;
193 }
194 return false;
195}
196
197unsigned HexagonGenMux::getMuxOpcode(const MachineOperand &Src1,
198 const MachineOperand &Src2) const {
199 bool IsReg1 = Src1.isReg(), IsReg2 = Src2.isReg();
200 if (IsReg1)
201 return IsReg2 ? Hexagon::C2_mux : Hexagon::C2_muxir;
202 if (IsReg2)
203 return Hexagon::C2_muxri;
204
205 // Neither is a register. The first source is extendable, but the second
206 // is not (s8).
207 if (Src2.isImm() && isInt<8>(x: Src2.getImm()))
208 return Hexagon::C2_muxii;
209
210 return 0;
211}
212
213bool HexagonGenMux::genMuxInBlock(MachineBasicBlock &B) {
214 bool Changed = false;
215 InstrIndexMap I2X;
216 DefUseInfoMap DUM;
217 buildMaps(B, I2X, DUM);
218
219 using CondsetMap = DenseMap<unsigned, CondsetInfo>;
220
221 CondsetMap CM;
222 MuxInfoList ML;
223
224 for (MachineInstr &MI : llvm::make_early_inc_range(Range&: B)) {
225 unsigned Opc = MI.getOpcode();
226 if (!isCondTransfer(Opc))
227 continue;
228 Register DR = MI.getOperand(i: 0).getReg();
229 if (isRegPair(Reg: DR))
230 continue;
231 MachineOperand &PredOp = MI.getOperand(i: 1);
232 if (PredOp.isUndef())
233 continue;
234
235 Register PR = PredOp.getReg();
236 unsigned Idx = I2X.lookup(Val: &MI);
237 CondsetMap::iterator F = CM.find(Val: DR);
238 bool IfTrue = HII->isPredicatedTrue(Opcode: Opc);
239
240 // If there is no record of a conditional transfer for this register,
241 // or the predicate register differs, create a new record for it.
242 if (F != CM.end() && F->second.PredR != PR) {
243 CM.erase(I: F);
244 F = CM.end();
245 }
246 if (F == CM.end()) {
247 F = CM.try_emplace(Key: DR).first;
248 F->second.PredR = PR;
249 }
250 CondsetInfo &CI = F->second;
251 if (IfTrue)
252 CI.TrueX = Idx;
253 else
254 CI.FalseX = Idx;
255 if (CI.TrueX == std::numeric_limits<unsigned>::max() ||
256 CI.FalseX == std::numeric_limits<unsigned>::max())
257 continue;
258
259 // There is now a complete definition of DR, i.e. we have the predicate
260 // register, the definition if-true, and definition if-false.
261
262 // First, check if the definitions are far enough from the definition
263 // of the predicate register.
264 unsigned MinX = std::min(a: CI.TrueX, b: CI.FalseX);
265 unsigned MaxX = std::max(a: CI.TrueX, b: CI.FalseX);
266 // Specifically, check if the predicate definition is within a prescribed
267 // distance from the farther of the two predicated instructions.
268 unsigned SearchX = (MaxX >= MinPredDist) ? MaxX-MinPredDist : 0;
269 bool NearDef = false;
270 for (unsigned X = SearchX; X < MaxX; ++X) {
271 const DefUseInfo &DU = DUM.lookup(Val: X);
272 if (!DU.Defs[PR])
273 continue;
274 NearDef = true;
275 break;
276 }
277 if (NearDef)
278 continue;
279
280 // The predicate register is not defined in the last few instructions.
281 // Check if the conversion to MUX is possible (either "up", i.e. at the
282 // place of the earlier partial definition, or "down", where the later
283 // definition is located). Examine all defs and uses between these two
284 // definitions.
285 // SR1, SR2 - source registers from the first and the second definition.
286 MachineBasicBlock::iterator It1 = B.begin(), It2 = B.begin();
287 std::advance(i&: It1, n: MinX);
288 std::advance(i&: It2, n: MaxX);
289 MachineInstr &Def1 = *It1, &Def2 = *It2;
290 MachineOperand *Src1 = &Def1.getOperand(i: 2), *Src2 = &Def2.getOperand(i: 2);
291 Register SR1 = Src1->isReg() ? Src1->getReg() : Register();
292 Register SR2 = Src2->isReg() ? Src2->getReg() : Register();
293 bool Failure = false, CanUp = true, CanDown = true;
294 for (unsigned X = MinX+1; X < MaxX; X++) {
295 const DefUseInfo &DU = DUM.lookup(Val: X);
296 if (DU.Defs[PR] || DU.Defs[DR] || DU.Uses[DR]) {
297 Failure = true;
298 break;
299 }
300 if (CanDown && DU.Defs[SR1])
301 CanDown = false;
302 if (CanUp && DU.Defs[SR2])
303 CanUp = false;
304 }
305 if (Failure || (!CanUp && !CanDown))
306 continue;
307
308 MachineOperand *SrcT = (MinX == CI.TrueX) ? Src1 : Src2;
309 MachineOperand *SrcF = (MinX == CI.FalseX) ? Src1 : Src2;
310 // Prefer "down", since this will move the MUX farther away from the
311 // predicate definition.
312 MachineBasicBlock::iterator At = CanDown ? Def2 : Def1;
313 ML.push_back(Elt: MuxInfo(At, DR, PR, SrcT, SrcF, Def1, Def2));
314 }
315
316 for (MuxInfo &MX : ML) {
317 unsigned MxOpc = getMuxOpcode(Src1: *MX.SrcT, Src2: *MX.SrcF);
318 if (!MxOpc)
319 continue;
320 // Basic correctness check: since we are deleting instructions, validate the
321 // iterators. There is a possibility that one of Def1 or Def2 is translated
322 // to "mux" and being considered for other "mux" instructions.
323 if (!MX.At->getParent() || !MX.Def1->getParent() || !MX.Def2->getParent())
324 continue;
325
326 MachineBasicBlock &B = *MX.At->getParent();
327 const DebugLoc &DL = B.findDebugLoc(MBBI: MX.At);
328 // Only when the mux takes Def2's place do values in the gap precede it.
329 // Call before the mux is created.
330 if (&*MX.At == MX.Def2)
331 HII->moveDependentDebugValues(First&: *MX.Def1, Second&: *MX.Def2);
332 auto NewMux = BuildMI(BB&: B, I: MX.At, MIMD: DL, MCID: HII->get(Opcode: MxOpc), DestReg: MX.DefR)
333 .addReg(RegNo: MX.PredR)
334 .add(MO: *MX.SrcT)
335 .add(MO: *MX.SrcF);
336 NewMux->clearKillInfo();
337 B.remove(I: MX.Def1);
338 B.remove(I: MX.Def2);
339 Changed = true;
340 }
341
342 // Fix up kill flags.
343
344 LiveRegUnits LPR(*HRI);
345 LPR.addLiveOuts(MBB: B);
346 for (MachineInstr &I : llvm::reverse(C&: B)) {
347 if (I.isDebugInstr())
348 continue;
349 // This isn't 100% accurate, but it's safe.
350 // It won't detect (as a kill) a case like this
351 // r0 = add r0, 1 <-- r0 should be "killed"
352 // ... = r0
353 for (MachineOperand &Op : I.operands()) {
354 if (!Op.isReg() || !Op.isUse())
355 continue;
356 assert(Op.getSubReg() == 0 && "Should have physical registers only");
357 bool Live = !LPR.available(Reg: Op.getReg());
358 Op.setIsKill(!Live);
359 }
360 LPR.stepBackward(MI: I);
361 }
362
363 return Changed;
364}
365
366bool HexagonGenMux::runOnMachineFunction(MachineFunction &MF) {
367 if (skipFunction(F: MF.getFunction()))
368 return false;
369 HII = MF.getSubtarget<HexagonSubtarget>().getInstrInfo();
370 HRI = MF.getSubtarget<HexagonSubtarget>().getRegisterInfo();
371 bool Changed = false;
372 for (auto &I : MF)
373 Changed |= genMuxInBlock(B&: I);
374 return Changed;
375}
376
377FunctionPass *llvm::createHexagonGenMux() {
378 return new HexagonGenMux();
379}
380