xref: /llvm-project/llvm/lib/Target/RISCV/GISel/RISCVInstructionSelector.cpp (revision 76748119bfd52ff6647740a06e29e3584e22ee16)
1 //===-- RISCVInstructionSelector.cpp -----------------------------*- C++ -*-==//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 /// \file
9 /// This file implements the targeting of the InstructionSelector class for
10 /// RISC-V.
11 /// \todo This should be generated by TableGen.
12 //===----------------------------------------------------------------------===//
13 
14 #include "MCTargetDesc/RISCVMatInt.h"
15 #include "RISCVRegisterBankInfo.h"
16 #include "RISCVSubtarget.h"
17 #include "RISCVTargetMachine.h"
18 #include "llvm/CodeGen/GlobalISel/GIMatchTableExecutorImpl.h"
19 #include "llvm/CodeGen/GlobalISel/GISelKnownBits.h"
20 #include "llvm/CodeGen/GlobalISel/GenericMachineInstrs.h"
21 #include "llvm/CodeGen/GlobalISel/InstructionSelector.h"
22 #include "llvm/CodeGen/GlobalISel/MIPatternMatch.h"
23 #include "llvm/CodeGen/GlobalISel/MachineIRBuilder.h"
24 #include "llvm/CodeGen/MachineJumpTableInfo.h"
25 #include "llvm/IR/IntrinsicsRISCV.h"
26 #include "llvm/Support/Debug.h"
27 
28 #define DEBUG_TYPE "riscv-isel"
29 
30 using namespace llvm;
31 using namespace MIPatternMatch;
32 
33 #define GET_GLOBALISEL_PREDICATE_BITSET
34 #include "RISCVGenGlobalISel.inc"
35 #undef GET_GLOBALISEL_PREDICATE_BITSET
36 
37 namespace {
38 
39 class RISCVInstructionSelector : public InstructionSelector {
40 public:
41   RISCVInstructionSelector(const RISCVTargetMachine &TM,
42                            const RISCVSubtarget &STI,
43                            const RISCVRegisterBankInfo &RBI);
44 
45   bool select(MachineInstr &MI) override;
46   static const char *getName() { return DEBUG_TYPE; }
47 
48 private:
49   const TargetRegisterClass *
50   getRegClassForTypeOnBank(LLT Ty, const RegisterBank &RB) const;
51 
52   bool isRegInGprb(Register Reg, MachineRegisterInfo &MRI) const;
53   bool isRegInFprb(Register Reg, MachineRegisterInfo &MRI) const;
54 
55   // tblgen-erated 'select' implementation, used as the initial selector for
56   // the patterns that don't require complex C++.
57   bool selectImpl(MachineInstr &I, CodeGenCoverage &CoverageInfo) const;
58 
59   // A lowering phase that runs before any selection attempts.
60   // Returns true if the instruction was modified.
61   void preISelLower(MachineInstr &MI, MachineIRBuilder &MIB,
62                     MachineRegisterInfo &MRI);
63 
64   bool replacePtrWithInt(MachineOperand &Op, MachineIRBuilder &MIB,
65                          MachineRegisterInfo &MRI);
66 
67   // Custom selection methods
68   bool selectCopy(MachineInstr &MI, MachineRegisterInfo &MRI) const;
69   bool selectImplicitDef(MachineInstr &MI, MachineIRBuilder &MIB,
70                          MachineRegisterInfo &MRI) const;
71   bool materializeImm(Register Reg, int64_t Imm, MachineIRBuilder &MIB) const;
72   bool selectAddr(MachineInstr &MI, MachineIRBuilder &MIB,
73                   MachineRegisterInfo &MRI, bool IsLocal = true,
74                   bool IsExternWeak = false) const;
75   bool selectSExtInreg(MachineInstr &MI, MachineIRBuilder &MIB) const;
76   bool selectSelect(MachineInstr &MI, MachineIRBuilder &MIB,
77                     MachineRegisterInfo &MRI) const;
78   bool selectFPCompare(MachineInstr &MI, MachineIRBuilder &MIB,
79                        MachineRegisterInfo &MRI) const;
80   void emitFence(AtomicOrdering FenceOrdering, SyncScope::ID FenceSSID,
81                  MachineIRBuilder &MIB) const;
82   bool selectMergeValues(MachineInstr &MI, MachineIRBuilder &MIB,
83                          MachineRegisterInfo &MRI) const;
84   bool selectUnmergeValues(MachineInstr &MI, MachineIRBuilder &MIB,
85                            MachineRegisterInfo &MRI) const;
86 
87   ComplexRendererFns selectShiftMask(MachineOperand &Root) const;
88   ComplexRendererFns selectAddrRegImm(MachineOperand &Root) const;
89 
90   ComplexRendererFns selectSHXADDOp(MachineOperand &Root, unsigned ShAmt) const;
91   template <unsigned ShAmt>
92   ComplexRendererFns selectSHXADDOp(MachineOperand &Root) const {
93     return selectSHXADDOp(Root, ShAmt);
94   }
95 
96   ComplexRendererFns selectSHXADD_UWOp(MachineOperand &Root,
97                                        unsigned ShAmt) const;
98   template <unsigned ShAmt>
99   ComplexRendererFns selectSHXADD_UWOp(MachineOperand &Root) const {
100     return selectSHXADD_UWOp(Root, ShAmt);
101   }
102 
103   // Custom renderers for tablegen
104   void renderNegImm(MachineInstrBuilder &MIB, const MachineInstr &MI,
105                     int OpIdx) const;
106   void renderImmSubFromXLen(MachineInstrBuilder &MIB, const MachineInstr &MI,
107                             int OpIdx) const;
108   void renderImmSubFrom32(MachineInstrBuilder &MIB, const MachineInstr &MI,
109                           int OpIdx) const;
110   void renderImmPlus1(MachineInstrBuilder &MIB, const MachineInstr &MI,
111                       int OpIdx) const;
112   void renderImm(MachineInstrBuilder &MIB, const MachineInstr &MI,
113                  int OpIdx) const;
114 
115   void renderTrailingZeros(MachineInstrBuilder &MIB, const MachineInstr &MI,
116                            int OpIdx) const;
117 
118   const RISCVSubtarget &STI;
119   const RISCVInstrInfo &TII;
120   const RISCVRegisterInfo &TRI;
121   const RISCVRegisterBankInfo &RBI;
122   const RISCVTargetMachine &TM;
123 
124   // FIXME: This is necessary because DAGISel uses "Subtarget->" and GlobalISel
125   // uses "STI." in the code generated by TableGen. We need to unify the name of
126   // Subtarget variable.
127   const RISCVSubtarget *Subtarget = &STI;
128 
129 #define GET_GLOBALISEL_PREDICATES_DECL
130 #include "RISCVGenGlobalISel.inc"
131 #undef GET_GLOBALISEL_PREDICATES_DECL
132 
133 #define GET_GLOBALISEL_TEMPORARIES_DECL
134 #include "RISCVGenGlobalISel.inc"
135 #undef GET_GLOBALISEL_TEMPORARIES_DECL
136 };
137 
138 } // end anonymous namespace
139 
140 #define GET_GLOBALISEL_IMPL
141 #include "RISCVGenGlobalISel.inc"
142 #undef GET_GLOBALISEL_IMPL
143 
144 RISCVInstructionSelector::RISCVInstructionSelector(
145     const RISCVTargetMachine &TM, const RISCVSubtarget &STI,
146     const RISCVRegisterBankInfo &RBI)
147     : STI(STI), TII(*STI.getInstrInfo()), TRI(*STI.getRegisterInfo()), RBI(RBI),
148       TM(TM),
149 
150 #define GET_GLOBALISEL_PREDICATES_INIT
151 #include "RISCVGenGlobalISel.inc"
152 #undef GET_GLOBALISEL_PREDICATES_INIT
153 #define GET_GLOBALISEL_TEMPORARIES_INIT
154 #include "RISCVGenGlobalISel.inc"
155 #undef GET_GLOBALISEL_TEMPORARIES_INIT
156 {
157 }
158 
159 InstructionSelector::ComplexRendererFns
160 RISCVInstructionSelector::selectShiftMask(MachineOperand &Root) const {
161   if (!Root.isReg())
162     return std::nullopt;
163 
164   using namespace llvm::MIPatternMatch;
165   MachineRegisterInfo &MRI = MF->getRegInfo();
166 
167   Register RootReg = Root.getReg();
168   Register ShAmtReg = RootReg;
169   const LLT ShiftLLT = MRI.getType(RootReg);
170   unsigned ShiftWidth = ShiftLLT.getSizeInBits();
171   assert(isPowerOf2_32(ShiftWidth) && "Unexpected max shift amount!");
172   // Peek through zext.
173   Register ZExtSrcReg;
174   if (mi_match(ShAmtReg, MRI, m_GZExt(m_Reg(ZExtSrcReg)))) {
175     ShAmtReg = ZExtSrcReg;
176   }
177 
178   APInt AndMask;
179   Register AndSrcReg;
180   // Try to combine the following pattern (applicable to other shift
181   // instructions as well as 32-bit ones):
182   //
183   //   %4:gprb(s64) = G_AND %3, %2
184   //   %5:gprb(s64) = G_LSHR %1, %4(s64)
185   //
186   // According to RISC-V's ISA manual, SLL, SRL, and SRA ignore other bits than
187   // the lowest log2(XLEN) bits of register rs2. As for the above pattern, if
188   // the lowest log2(XLEN) bits of register rd and rs2 of G_AND are the same,
189   // then it can be eliminated. Given register rs1 or rs2 holding a constant
190   // (the and mask), there are two cases G_AND can be erased:
191   //
192   // 1. the lowest log2(XLEN) bits of the and mask are all set
193   // 2. the bits of the register being masked are already unset (zero set)
194   if (mi_match(ShAmtReg, MRI, m_GAnd(m_Reg(AndSrcReg), m_ICst(AndMask)))) {
195     APInt ShMask(AndMask.getBitWidth(), ShiftWidth - 1);
196     if (ShMask.isSubsetOf(AndMask)) {
197       ShAmtReg = AndSrcReg;
198     } else {
199       // SimplifyDemandedBits may have optimized the mask so try restoring any
200       // bits that are known zero.
201       KnownBits Known = KB->getKnownBits(AndSrcReg);
202       if (ShMask.isSubsetOf(AndMask | Known.Zero))
203         ShAmtReg = AndSrcReg;
204     }
205   }
206 
207   APInt Imm;
208   Register Reg;
209   if (mi_match(ShAmtReg, MRI, m_GAdd(m_Reg(Reg), m_ICst(Imm)))) {
210     if (Imm != 0 && Imm.urem(ShiftWidth) == 0)
211       // If we are shifting by X+N where N == 0 mod Size, then just shift by X
212       // to avoid the ADD.
213       ShAmtReg = Reg;
214   } else if (mi_match(ShAmtReg, MRI, m_GSub(m_ICst(Imm), m_Reg(Reg)))) {
215     if (Imm != 0 && Imm.urem(ShiftWidth) == 0) {
216       // If we are shifting by N-X where N == 0 mod Size, then just shift by -X
217       // to generate a NEG instead of a SUB of a constant.
218       ShAmtReg = MRI.createVirtualRegister(&RISCV::GPRRegClass);
219       unsigned NegOpc = Subtarget->is64Bit() ? RISCV::SUBW : RISCV::SUB;
220       return {{[=](MachineInstrBuilder &MIB) {
221         MachineIRBuilder(*MIB.getInstr())
222             .buildInstr(NegOpc, {ShAmtReg}, {Register(RISCV::X0), Reg});
223         MIB.addReg(ShAmtReg);
224       }}};
225     }
226     if (Imm.urem(ShiftWidth) == ShiftWidth - 1) {
227       // If we are shifting by N-X where N == -1 mod Size, then just shift by ~X
228       // to generate a NOT instead of a SUB of a constant.
229       ShAmtReg = MRI.createVirtualRegister(&RISCV::GPRRegClass);
230       return {{[=](MachineInstrBuilder &MIB) {
231         MachineIRBuilder(*MIB.getInstr())
232             .buildInstr(RISCV::XORI, {ShAmtReg}, {Reg})
233             .addImm(-1);
234         MIB.addReg(ShAmtReg);
235       }}};
236     }
237   }
238 
239   return {{[=](MachineInstrBuilder &MIB) { MIB.addReg(ShAmtReg); }}};
240 }
241 
242 InstructionSelector::ComplexRendererFns
243 RISCVInstructionSelector::selectSHXADDOp(MachineOperand &Root,
244                                          unsigned ShAmt) const {
245   using namespace llvm::MIPatternMatch;
246   MachineFunction &MF = *Root.getParent()->getParent()->getParent();
247   MachineRegisterInfo &MRI = MF.getRegInfo();
248 
249   if (!Root.isReg())
250     return std::nullopt;
251   Register RootReg = Root.getReg();
252 
253   const unsigned XLen = STI.getXLen();
254   APInt Mask, C2;
255   Register RegY;
256   std::optional<bool> LeftShift;
257   // (and (shl y, c2), mask)
258   if (mi_match(RootReg, MRI,
259                m_GAnd(m_GShl(m_Reg(RegY), m_ICst(C2)), m_ICst(Mask))))
260     LeftShift = true;
261   // (and (lshr y, c2), mask)
262   else if (mi_match(RootReg, MRI,
263                     m_GAnd(m_GLShr(m_Reg(RegY), m_ICst(C2)), m_ICst(Mask))))
264     LeftShift = false;
265 
266   if (LeftShift.has_value()) {
267     if (*LeftShift)
268       Mask &= maskTrailingZeros<uint64_t>(C2.getLimitedValue());
269     else
270       Mask &= maskTrailingOnes<uint64_t>(XLen - C2.getLimitedValue());
271 
272     if (Mask.isShiftedMask()) {
273       unsigned Leading = XLen - Mask.getActiveBits();
274       unsigned Trailing = Mask.countr_zero();
275       // Given (and (shl y, c2), mask) in which mask has no leading zeros and
276       // c3 trailing zeros. We can use an SRLI by c3 - c2 followed by a SHXADD.
277       if (*LeftShift && Leading == 0 && C2.ult(Trailing) && Trailing == ShAmt) {
278         Register DstReg = MRI.createVirtualRegister(&RISCV::GPRRegClass);
279         return {{[=](MachineInstrBuilder &MIB) {
280           MachineIRBuilder(*MIB.getInstr())
281               .buildInstr(RISCV::SRLI, {DstReg}, {RegY})
282               .addImm(Trailing - C2.getLimitedValue());
283           MIB.addReg(DstReg);
284         }}};
285       }
286 
287       // Given (and (lshr y, c2), mask) in which mask has c2 leading zeros and
288       // c3 trailing zeros. We can use an SRLI by c2 + c3 followed by a SHXADD.
289       if (!*LeftShift && Leading == C2 && Trailing == ShAmt) {
290         Register DstReg = MRI.createVirtualRegister(&RISCV::GPRRegClass);
291         return {{[=](MachineInstrBuilder &MIB) {
292           MachineIRBuilder(*MIB.getInstr())
293               .buildInstr(RISCV::SRLI, {DstReg}, {RegY})
294               .addImm(Leading + Trailing);
295           MIB.addReg(DstReg);
296         }}};
297       }
298     }
299   }
300 
301   LeftShift.reset();
302 
303   // (shl (and y, mask), c2)
304   if (mi_match(RootReg, MRI,
305                m_GShl(m_OneNonDBGUse(m_GAnd(m_Reg(RegY), m_ICst(Mask))),
306                       m_ICst(C2))))
307     LeftShift = true;
308   // (lshr (and y, mask), c2)
309   else if (mi_match(RootReg, MRI,
310                     m_GLShr(m_OneNonDBGUse(m_GAnd(m_Reg(RegY), m_ICst(Mask))),
311                             m_ICst(C2))))
312     LeftShift = false;
313 
314   if (LeftShift.has_value() && Mask.isShiftedMask()) {
315     unsigned Leading = XLen - Mask.getActiveBits();
316     unsigned Trailing = Mask.countr_zero();
317 
318     // Given (shl (and y, mask), c2) in which mask has 32 leading zeros and
319     // c3 trailing zeros. If c1 + c3 == ShAmt, we can emit SRLIW + SHXADD.
320     bool Cond = *LeftShift && Leading == 32 && Trailing > 0 &&
321                 (Trailing + C2.getLimitedValue()) == ShAmt;
322     if (!Cond)
323       // Given (lshr (and y, mask), c2) in which mask has 32 leading zeros and
324       // c3 trailing zeros. If c3 - c1 == ShAmt, we can emit SRLIW + SHXADD.
325       Cond = !*LeftShift && Leading == 32 && C2.ult(Trailing) &&
326              (Trailing - C2.getLimitedValue()) == ShAmt;
327 
328     if (Cond) {
329       Register DstReg = MRI.createVirtualRegister(&RISCV::GPRRegClass);
330       return {{[=](MachineInstrBuilder &MIB) {
331         MachineIRBuilder(*MIB.getInstr())
332             .buildInstr(RISCV::SRLIW, {DstReg}, {RegY})
333             .addImm(Trailing);
334         MIB.addReg(DstReg);
335       }}};
336     }
337   }
338 
339   return std::nullopt;
340 }
341 
342 InstructionSelector::ComplexRendererFns
343 RISCVInstructionSelector::selectSHXADD_UWOp(MachineOperand &Root,
344                                             unsigned ShAmt) const {
345   using namespace llvm::MIPatternMatch;
346   MachineFunction &MF = *Root.getParent()->getParent()->getParent();
347   MachineRegisterInfo &MRI = MF.getRegInfo();
348 
349   if (!Root.isReg())
350     return std::nullopt;
351   Register RootReg = Root.getReg();
352 
353   // Given (and (shl x, c2), mask) in which mask is a shifted mask with
354   // 32 - ShAmt leading zeros and c2 trailing zeros. We can use SLLI by
355   // c2 - ShAmt followed by SHXADD_UW with ShAmt for x amount.
356   APInt Mask, C2;
357   Register RegX;
358   if (mi_match(
359           RootReg, MRI,
360           m_OneNonDBGUse(m_GAnd(m_OneNonDBGUse(m_GShl(m_Reg(RegX), m_ICst(C2))),
361                                 m_ICst(Mask))))) {
362     Mask &= maskTrailingZeros<uint64_t>(C2.getLimitedValue());
363 
364     if (Mask.isShiftedMask()) {
365       unsigned Leading = Mask.countl_zero();
366       unsigned Trailing = Mask.countr_zero();
367       if (Leading == 32 - ShAmt && C2 == Trailing && Trailing > ShAmt) {
368         Register DstReg = MRI.createVirtualRegister(&RISCV::GPRRegClass);
369         return {{[=](MachineInstrBuilder &MIB) {
370           MachineIRBuilder(*MIB.getInstr())
371               .buildInstr(RISCV::SLLI, {DstReg}, {RegX})
372               .addImm(C2.getLimitedValue() - ShAmt);
373           MIB.addReg(DstReg);
374         }}};
375       }
376     }
377   }
378 
379   return std::nullopt;
380 }
381 
382 InstructionSelector::ComplexRendererFns
383 RISCVInstructionSelector::selectAddrRegImm(MachineOperand &Root) const {
384   MachineFunction &MF = *Root.getParent()->getParent()->getParent();
385   MachineRegisterInfo &MRI = MF.getRegInfo();
386 
387   if (!Root.isReg())
388     return std::nullopt;
389 
390   MachineInstr *RootDef = MRI.getVRegDef(Root.getReg());
391   if (RootDef->getOpcode() == TargetOpcode::G_FRAME_INDEX) {
392     return {{
393         [=](MachineInstrBuilder &MIB) { MIB.add(RootDef->getOperand(1)); },
394         [=](MachineInstrBuilder &MIB) { MIB.addImm(0); },
395     }};
396   }
397 
398   if (isBaseWithConstantOffset(Root, MRI)) {
399     MachineOperand &LHS = RootDef->getOperand(1);
400     MachineOperand &RHS = RootDef->getOperand(2);
401     MachineInstr *LHSDef = MRI.getVRegDef(LHS.getReg());
402     MachineInstr *RHSDef = MRI.getVRegDef(RHS.getReg());
403 
404     int64_t RHSC = RHSDef->getOperand(1).getCImm()->getSExtValue();
405     if (isInt<12>(RHSC)) {
406       if (LHSDef->getOpcode() == TargetOpcode::G_FRAME_INDEX)
407         return {{
408             [=](MachineInstrBuilder &MIB) { MIB.add(LHSDef->getOperand(1)); },
409             [=](MachineInstrBuilder &MIB) { MIB.addImm(RHSC); },
410         }};
411 
412       return {{[=](MachineInstrBuilder &MIB) { MIB.add(LHS); },
413                [=](MachineInstrBuilder &MIB) { MIB.addImm(RHSC); }}};
414     }
415   }
416 
417   // TODO: Need to get the immediate from a G_PTR_ADD. Should this be done in
418   // the combiner?
419   return {{[=](MachineInstrBuilder &MIB) { MIB.addReg(Root.getReg()); },
420            [=](MachineInstrBuilder &MIB) { MIB.addImm(0); }}};
421 }
422 
423 /// Returns the RISCVCC::CondCode that corresponds to the CmpInst::Predicate CC.
424 /// CC Must be an ICMP Predicate.
425 static RISCVCC::CondCode getRISCVCCFromICmp(CmpInst::Predicate CC) {
426   switch (CC) {
427   default:
428     llvm_unreachable("Expected ICMP CmpInst::Predicate.");
429   case CmpInst::Predicate::ICMP_EQ:
430     return RISCVCC::COND_EQ;
431   case CmpInst::Predicate::ICMP_NE:
432     return RISCVCC::COND_NE;
433   case CmpInst::Predicate::ICMP_ULT:
434     return RISCVCC::COND_LTU;
435   case CmpInst::Predicate::ICMP_SLT:
436     return RISCVCC::COND_LT;
437   case CmpInst::Predicate::ICMP_UGE:
438     return RISCVCC::COND_GEU;
439   case CmpInst::Predicate::ICMP_SGE:
440     return RISCVCC::COND_GE;
441   }
442 }
443 
444 static void getOperandsForBranch(Register CondReg, MachineRegisterInfo &MRI,
445                                  RISCVCC::CondCode &CC, Register &LHS,
446                                  Register &RHS) {
447   // Try to fold an ICmp. If that fails, use a NE compare with X0.
448   CmpInst::Predicate Pred = CmpInst::BAD_ICMP_PREDICATE;
449   if (!mi_match(CondReg, MRI, m_GICmp(m_Pred(Pred), m_Reg(LHS), m_Reg(RHS)))) {
450     LHS = CondReg;
451     RHS = RISCV::X0;
452     CC = RISCVCC::COND_NE;
453     return;
454   }
455 
456   // We found an ICmp, do some canonicalizations.
457 
458   // Adjust comparisons to use comparison with 0 if possible.
459   if (auto Constant = getIConstantVRegSExtVal(RHS, MRI)) {
460     switch (Pred) {
461     case CmpInst::Predicate::ICMP_SGT:
462       // Convert X > -1 to X >= 0
463       if (*Constant == -1) {
464         CC = RISCVCC::COND_GE;
465         RHS = RISCV::X0;
466         return;
467       }
468       break;
469     case CmpInst::Predicate::ICMP_SLT:
470       // Convert X < 1 to 0 >= X
471       if (*Constant == 1) {
472         CC = RISCVCC::COND_GE;
473         RHS = LHS;
474         LHS = RISCV::X0;
475         return;
476       }
477       break;
478     default:
479       break;
480     }
481   }
482 
483   switch (Pred) {
484   default:
485     llvm_unreachable("Expected ICMP CmpInst::Predicate.");
486   case CmpInst::Predicate::ICMP_EQ:
487   case CmpInst::Predicate::ICMP_NE:
488   case CmpInst::Predicate::ICMP_ULT:
489   case CmpInst::Predicate::ICMP_SLT:
490   case CmpInst::Predicate::ICMP_UGE:
491   case CmpInst::Predicate::ICMP_SGE:
492     // These CCs are supported directly by RISC-V branches.
493     break;
494   case CmpInst::Predicate::ICMP_SGT:
495   case CmpInst::Predicate::ICMP_SLE:
496   case CmpInst::Predicate::ICMP_UGT:
497   case CmpInst::Predicate::ICMP_ULE:
498     // These CCs are not supported directly by RISC-V branches, but changing the
499     // direction of the CC and swapping LHS and RHS are.
500     Pred = CmpInst::getSwappedPredicate(Pred);
501     std::swap(LHS, RHS);
502     break;
503   }
504 
505   CC = getRISCVCCFromICmp(Pred);
506   return;
507 }
508 
509 bool RISCVInstructionSelector::select(MachineInstr &MI) {
510   MachineBasicBlock &MBB = *MI.getParent();
511   MachineFunction &MF = *MBB.getParent();
512   MachineRegisterInfo &MRI = MF.getRegInfo();
513   MachineIRBuilder MIB(MI);
514 
515   preISelLower(MI, MIB, MRI);
516   const unsigned Opc = MI.getOpcode();
517 
518   if (!MI.isPreISelOpcode() || Opc == TargetOpcode::G_PHI) {
519     if (Opc == TargetOpcode::PHI || Opc == TargetOpcode::G_PHI) {
520       const Register DefReg = MI.getOperand(0).getReg();
521       const LLT DefTy = MRI.getType(DefReg);
522 
523       const RegClassOrRegBank &RegClassOrBank =
524           MRI.getRegClassOrRegBank(DefReg);
525 
526       const TargetRegisterClass *DefRC =
527           RegClassOrBank.dyn_cast<const TargetRegisterClass *>();
528       if (!DefRC) {
529         if (!DefTy.isValid()) {
530           LLVM_DEBUG(dbgs() << "PHI operand has no type, not a gvreg?\n");
531           return false;
532         }
533 
534         const RegisterBank &RB = *RegClassOrBank.get<const RegisterBank *>();
535         DefRC = getRegClassForTypeOnBank(DefTy, RB);
536         if (!DefRC) {
537           LLVM_DEBUG(dbgs() << "PHI operand has unexpected size/bank\n");
538           return false;
539         }
540       }
541 
542       MI.setDesc(TII.get(TargetOpcode::PHI));
543       return RBI.constrainGenericRegister(DefReg, *DefRC, MRI);
544     }
545 
546     // Certain non-generic instructions also need some special handling.
547     if (MI.isCopy())
548       return selectCopy(MI, MRI);
549 
550     return true;
551   }
552 
553   if (selectImpl(MI, *CoverageInfo))
554     return true;
555 
556   switch (Opc) {
557   case TargetOpcode::G_ANYEXT:
558   case TargetOpcode::G_PTRTOINT:
559   case TargetOpcode::G_INTTOPTR:
560   case TargetOpcode::G_TRUNC:
561   case TargetOpcode::G_FREEZE:
562     return selectCopy(MI, MRI);
563   case TargetOpcode::G_CONSTANT: {
564     Register DstReg = MI.getOperand(0).getReg();
565     int64_t Imm = MI.getOperand(1).getCImm()->getSExtValue();
566 
567     if (!materializeImm(DstReg, Imm, MIB))
568       return false;
569 
570     MI.eraseFromParent();
571     return true;
572   }
573   case TargetOpcode::G_FCONSTANT: {
574     // TODO: Use constant pool for complext constants.
575     // TODO: Optimize +0.0 to use fcvt.d.w for s64 on rv32.
576     Register DstReg = MI.getOperand(0).getReg();
577     const APFloat &FPimm = MI.getOperand(1).getFPImm()->getValueAPF();
578     APInt Imm = FPimm.bitcastToAPInt();
579     unsigned Size = MRI.getType(DstReg).getSizeInBits();
580     if (Size == 32 || (Size == 64 && Subtarget->is64Bit())) {
581       Register GPRReg = MRI.createVirtualRegister(&RISCV::GPRRegClass);
582       if (!materializeImm(GPRReg, Imm.getSExtValue(), MIB))
583         return false;
584 
585       unsigned Opcode = Size == 64 ? RISCV::FMV_D_X : RISCV::FMV_W_X;
586       auto FMV = MIB.buildInstr(Opcode, {DstReg}, {GPRReg});
587       if (!FMV.constrainAllUses(TII, TRI, RBI))
588         return false;
589     } else {
590       assert(Size == 64 && !Subtarget->is64Bit() &&
591              "Unexpected size or subtarget");
592       // Split into two pieces and build through the stack.
593       Register GPRRegHigh = MRI.createVirtualRegister(&RISCV::GPRRegClass);
594       Register GPRRegLow = MRI.createVirtualRegister(&RISCV::GPRRegClass);
595       if (!materializeImm(GPRRegHigh, Imm.extractBits(32, 32).getSExtValue(),
596                           MIB))
597         return false;
598       if (!materializeImm(GPRRegLow, Imm.trunc(32).getSExtValue(), MIB))
599         return false;
600       MachineInstrBuilder PairF64 = MIB.buildInstr(
601           RISCV::BuildPairF64Pseudo, {DstReg}, {GPRRegLow, GPRRegHigh});
602       if (!PairF64.constrainAllUses(TII, TRI, RBI))
603         return false;
604     }
605 
606     MI.eraseFromParent();
607     return true;
608   }
609   case TargetOpcode::G_GLOBAL_VALUE: {
610     auto *GV = MI.getOperand(1).getGlobal();
611     if (GV->isThreadLocal()) {
612       // TODO: implement this case.
613       return false;
614     }
615 
616     return selectAddr(MI, MIB, MRI, GV->isDSOLocal(),
617                       GV->hasExternalWeakLinkage());
618   }
619   case TargetOpcode::G_JUMP_TABLE:
620   case TargetOpcode::G_CONSTANT_POOL:
621     return selectAddr(MI, MIB, MRI);
622   case TargetOpcode::G_BRCOND: {
623     Register LHS, RHS;
624     RISCVCC::CondCode CC;
625     getOperandsForBranch(MI.getOperand(0).getReg(), MRI, CC, LHS, RHS);
626 
627     auto Bcc = MIB.buildInstr(RISCVCC::getBrCond(CC), {}, {LHS, RHS})
628                    .addMBB(MI.getOperand(1).getMBB());
629     MI.eraseFromParent();
630     return constrainSelectedInstRegOperands(*Bcc, TII, TRI, RBI);
631   }
632   case TargetOpcode::G_BRJT: {
633     // FIXME: Move to legalization?
634     const MachineJumpTableInfo *MJTI = MF.getJumpTableInfo();
635     unsigned EntrySize = MJTI->getEntrySize(MF.getDataLayout());
636     assert((EntrySize == 4 || (Subtarget->is64Bit() && EntrySize == 8)) &&
637            "Unsupported jump-table entry size");
638     assert(
639         (MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32 ||
640          MJTI->getEntryKind() == MachineJumpTableInfo::EK_Custom32 ||
641          MJTI->getEntryKind() == MachineJumpTableInfo::EK_BlockAddress) &&
642         "Unexpected jump-table entry kind");
643 
644     auto SLL =
645         MIB.buildInstr(RISCV::SLLI, {&RISCV::GPRRegClass}, {MI.getOperand(2)})
646             .addImm(Log2_32(EntrySize));
647     if (!SLL.constrainAllUses(TII, TRI, RBI))
648       return false;
649 
650     // TODO: Use SHXADD. Moving to legalization would fix this automatically.
651     auto ADD = MIB.buildInstr(RISCV::ADD, {&RISCV::GPRRegClass},
652                               {MI.getOperand(0), SLL.getReg(0)});
653     if (!ADD.constrainAllUses(TII, TRI, RBI))
654       return false;
655 
656     unsigned LdOpc = EntrySize == 8 ? RISCV::LD : RISCV::LW;
657     auto Dest =
658         MIB.buildInstr(LdOpc, {&RISCV::GPRRegClass}, {ADD.getReg(0)})
659             .addImm(0)
660             .addMemOperand(MF.getMachineMemOperand(
661                 MachinePointerInfo::getJumpTable(MF), MachineMemOperand::MOLoad,
662                 EntrySize, Align(MJTI->getEntryAlignment(MF.getDataLayout()))));
663     if (!Dest.constrainAllUses(TII, TRI, RBI))
664       return false;
665 
666     // If the Kind is EK_LabelDifference32, the table stores an offset from
667     // the location of the table. Add the table address to get an absolute
668     // address.
669     if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32) {
670       Dest = MIB.buildInstr(RISCV::ADD, {&RISCV::GPRRegClass},
671                             {Dest.getReg(0), MI.getOperand(0)});
672       if (!Dest.constrainAllUses(TII, TRI, RBI))
673         return false;
674     }
675 
676     auto Branch =
677         MIB.buildInstr(RISCV::PseudoBRIND, {}, {Dest.getReg(0)}).addImm(0);
678     if (!Branch.constrainAllUses(TII, TRI, RBI))
679       return false;
680 
681     MI.eraseFromParent();
682     return true;
683   }
684   case TargetOpcode::G_BRINDIRECT:
685     MI.setDesc(TII.get(RISCV::PseudoBRIND));
686     MI.addOperand(MachineOperand::CreateImm(0));
687     return constrainSelectedInstRegOperands(MI, TII, TRI, RBI);
688   case TargetOpcode::G_SEXT_INREG:
689     return selectSExtInreg(MI, MIB);
690   case TargetOpcode::G_FRAME_INDEX: {
691     // TODO: We may want to replace this code with the SelectionDAG patterns,
692     // which fail to get imported because it uses FrameAddrRegImm, which is a
693     // ComplexPattern
694     MI.setDesc(TII.get(RISCV::ADDI));
695     MI.addOperand(MachineOperand::CreateImm(0));
696     return constrainSelectedInstRegOperands(MI, TII, TRI, RBI);
697   }
698   case TargetOpcode::G_SELECT:
699     return selectSelect(MI, MIB, MRI);
700   case TargetOpcode::G_FCMP:
701     return selectFPCompare(MI, MIB, MRI);
702   case TargetOpcode::G_FENCE: {
703     AtomicOrdering FenceOrdering =
704         static_cast<AtomicOrdering>(MI.getOperand(0).getImm());
705     SyncScope::ID FenceSSID =
706         static_cast<SyncScope::ID>(MI.getOperand(1).getImm());
707     emitFence(FenceOrdering, FenceSSID, MIB);
708     MI.eraseFromParent();
709     return true;
710   }
711   case TargetOpcode::G_IMPLICIT_DEF:
712     return selectImplicitDef(MI, MIB, MRI);
713   case TargetOpcode::G_MERGE_VALUES:
714     return selectMergeValues(MI, MIB, MRI);
715   case TargetOpcode::G_UNMERGE_VALUES:
716     return selectUnmergeValues(MI, MIB, MRI);
717   default:
718     return false;
719   }
720 }
721 
722 bool RISCVInstructionSelector::selectMergeValues(
723     MachineInstr &MI, MachineIRBuilder &MIB, MachineRegisterInfo &MRI) const {
724   assert(MI.getOpcode() == TargetOpcode::G_MERGE_VALUES);
725 
726   // Build a F64 Pair from operands
727   if (MI.getNumOperands() != 3)
728     return false;
729   Register Dst = MI.getOperand(0).getReg();
730   Register Lo = MI.getOperand(1).getReg();
731   Register Hi = MI.getOperand(2).getReg();
732   if (!isRegInFprb(Dst, MRI) || !isRegInGprb(Lo, MRI) || !isRegInGprb(Hi, MRI))
733     return false;
734   MI.setDesc(TII.get(RISCV::BuildPairF64Pseudo));
735   return constrainSelectedInstRegOperands(MI, TII, TRI, RBI);
736 }
737 
738 bool RISCVInstructionSelector::selectUnmergeValues(
739     MachineInstr &MI, MachineIRBuilder &MIB, MachineRegisterInfo &MRI) const {
740   assert(MI.getOpcode() == TargetOpcode::G_UNMERGE_VALUES);
741 
742   // Split F64 Src into two s32 parts
743   if (MI.getNumOperands() != 3)
744     return false;
745   Register Src = MI.getOperand(2).getReg();
746   Register Lo = MI.getOperand(0).getReg();
747   Register Hi = MI.getOperand(1).getReg();
748   if (!isRegInFprb(Src, MRI) || !isRegInGprb(Lo, MRI) || !isRegInGprb(Hi, MRI))
749     return false;
750   MI.setDesc(TII.get(RISCV::SplitF64Pseudo));
751   return constrainSelectedInstRegOperands(MI, TII, TRI, RBI);
752 }
753 
754 bool RISCVInstructionSelector::replacePtrWithInt(MachineOperand &Op,
755                                                  MachineIRBuilder &MIB,
756                                                  MachineRegisterInfo &MRI) {
757   Register PtrReg = Op.getReg();
758   assert(MRI.getType(PtrReg).isPointer() && "Operand is not a pointer!");
759 
760   const LLT sXLen = LLT::scalar(STI.getXLen());
761   auto PtrToInt = MIB.buildPtrToInt(sXLen, PtrReg);
762   MRI.setRegBank(PtrToInt.getReg(0), RBI.getRegBank(RISCV::GPRBRegBankID));
763   Op.setReg(PtrToInt.getReg(0));
764   return select(*PtrToInt);
765 }
766 
767 void RISCVInstructionSelector::preISelLower(MachineInstr &MI,
768                                             MachineIRBuilder &MIB,
769                                             MachineRegisterInfo &MRI) {
770   switch (MI.getOpcode()) {
771   case TargetOpcode::G_PTR_ADD: {
772     Register DstReg = MI.getOperand(0).getReg();
773     const LLT sXLen = LLT::scalar(STI.getXLen());
774 
775     replacePtrWithInt(MI.getOperand(1), MIB, MRI);
776     MI.setDesc(TII.get(TargetOpcode::G_ADD));
777     MRI.setType(DstReg, sXLen);
778     break;
779   }
780   case TargetOpcode::G_PTRMASK: {
781     Register DstReg = MI.getOperand(0).getReg();
782     const LLT sXLen = LLT::scalar(STI.getXLen());
783     replacePtrWithInt(MI.getOperand(1), MIB, MRI);
784     MI.setDesc(TII.get(TargetOpcode::G_AND));
785     MRI.setType(DstReg, sXLen);
786   }
787   }
788 }
789 
790 void RISCVInstructionSelector::renderNegImm(MachineInstrBuilder &MIB,
791                                             const MachineInstr &MI,
792                                             int OpIdx) const {
793   assert(MI.getOpcode() == TargetOpcode::G_CONSTANT && OpIdx == -1 &&
794          "Expected G_CONSTANT");
795   int64_t CstVal = MI.getOperand(1).getCImm()->getSExtValue();
796   MIB.addImm(-CstVal);
797 }
798 
799 void RISCVInstructionSelector::renderImmSubFromXLen(MachineInstrBuilder &MIB,
800                                                     const MachineInstr &MI,
801                                                     int OpIdx) const {
802   assert(MI.getOpcode() == TargetOpcode::G_CONSTANT && OpIdx == -1 &&
803          "Expected G_CONSTANT");
804   uint64_t CstVal = MI.getOperand(1).getCImm()->getZExtValue();
805   MIB.addImm(STI.getXLen() - CstVal);
806 }
807 
808 void RISCVInstructionSelector::renderImmSubFrom32(MachineInstrBuilder &MIB,
809                                                   const MachineInstr &MI,
810                                                   int OpIdx) const {
811   assert(MI.getOpcode() == TargetOpcode::G_CONSTANT && OpIdx == -1 &&
812          "Expected G_CONSTANT");
813   uint64_t CstVal = MI.getOperand(1).getCImm()->getZExtValue();
814   MIB.addImm(32 - CstVal);
815 }
816 
817 void RISCVInstructionSelector::renderImmPlus1(MachineInstrBuilder &MIB,
818                                               const MachineInstr &MI,
819                                               int OpIdx) const {
820   assert(MI.getOpcode() == TargetOpcode::G_CONSTANT && OpIdx == -1 &&
821          "Expected G_CONSTANT");
822   int64_t CstVal = MI.getOperand(1).getCImm()->getSExtValue();
823   MIB.addImm(CstVal + 1);
824 }
825 
826 void RISCVInstructionSelector::renderImm(MachineInstrBuilder &MIB,
827                                          const MachineInstr &MI,
828                                          int OpIdx) const {
829   assert(MI.getOpcode() == TargetOpcode::G_CONSTANT && OpIdx == -1 &&
830          "Expected G_CONSTANT");
831   int64_t CstVal = MI.getOperand(1).getCImm()->getSExtValue();
832   MIB.addImm(CstVal);
833 }
834 
835 void RISCVInstructionSelector::renderTrailingZeros(MachineInstrBuilder &MIB,
836                                                    const MachineInstr &MI,
837                                                    int OpIdx) const {
838   assert(MI.getOpcode() == TargetOpcode::G_CONSTANT && OpIdx == -1 &&
839          "Expected G_CONSTANT");
840   uint64_t C = MI.getOperand(1).getCImm()->getZExtValue();
841   MIB.addImm(llvm::countr_zero(C));
842 }
843 
844 const TargetRegisterClass *RISCVInstructionSelector::getRegClassForTypeOnBank(
845     LLT Ty, const RegisterBank &RB) const {
846   if (RB.getID() == RISCV::GPRBRegBankID) {
847     if (Ty.getSizeInBits() <= 32 || (STI.is64Bit() && Ty.getSizeInBits() == 64))
848       return &RISCV::GPRRegClass;
849   }
850 
851   if (RB.getID() == RISCV::FPRBRegBankID) {
852     if (Ty.getSizeInBits() == 32)
853       return &RISCV::FPR32RegClass;
854     if (Ty.getSizeInBits() == 64)
855       return &RISCV::FPR64RegClass;
856   }
857 
858   if (RB.getID() == RISCV::VRBRegBankID) {
859     if (Ty.getSizeInBits().getKnownMinValue() <= 64)
860       return &RISCV::VRRegClass;
861 
862     if (Ty.getSizeInBits().getKnownMinValue() == 128)
863       return &RISCV::VRM2RegClass;
864 
865     if (Ty.getSizeInBits().getKnownMinValue() == 256)
866       return &RISCV::VRM4RegClass;
867 
868     if (Ty.getSizeInBits().getKnownMinValue() == 512)
869       return &RISCV::VRM8RegClass;
870   }
871 
872   return nullptr;
873 }
874 
875 bool RISCVInstructionSelector::isRegInGprb(Register Reg,
876                                            MachineRegisterInfo &MRI) const {
877   return RBI.getRegBank(Reg, MRI, TRI)->getID() == RISCV::GPRBRegBankID;
878 }
879 
880 bool RISCVInstructionSelector::isRegInFprb(Register Reg,
881                                            MachineRegisterInfo &MRI) const {
882   return RBI.getRegBank(Reg, MRI, TRI)->getID() == RISCV::FPRBRegBankID;
883 }
884 
885 bool RISCVInstructionSelector::selectCopy(MachineInstr &MI,
886                                           MachineRegisterInfo &MRI) const {
887   Register DstReg = MI.getOperand(0).getReg();
888 
889   if (DstReg.isPhysical())
890     return true;
891 
892   const TargetRegisterClass *DstRC = getRegClassForTypeOnBank(
893       MRI.getType(DstReg), *RBI.getRegBank(DstReg, MRI, TRI));
894   assert(DstRC &&
895          "Register class not available for LLT, register bank combination");
896 
897   // No need to constrain SrcReg. It will get constrained when
898   // we hit another of its uses or its defs.
899   // Copies do not have constraints.
900   if (!RBI.constrainGenericRegister(DstReg, *DstRC, MRI)) {
901     LLVM_DEBUG(dbgs() << "Failed to constrain " << TII.getName(MI.getOpcode())
902                       << " operand\n");
903     return false;
904   }
905 
906   MI.setDesc(TII.get(RISCV::COPY));
907   return true;
908 }
909 
910 bool RISCVInstructionSelector::selectImplicitDef(
911     MachineInstr &MI, MachineIRBuilder &MIB, MachineRegisterInfo &MRI) const {
912   assert(MI.getOpcode() == TargetOpcode::G_IMPLICIT_DEF);
913 
914   const Register DstReg = MI.getOperand(0).getReg();
915   const TargetRegisterClass *DstRC = getRegClassForTypeOnBank(
916       MRI.getType(DstReg), *RBI.getRegBank(DstReg, MRI, TRI));
917 
918   assert(DstRC &&
919          "Register class not available for LLT, register bank combination");
920 
921   if (!RBI.constrainGenericRegister(DstReg, *DstRC, MRI)) {
922     LLVM_DEBUG(dbgs() << "Failed to constrain " << TII.getName(MI.getOpcode())
923                       << " operand\n");
924   }
925   MI.setDesc(TII.get(TargetOpcode::IMPLICIT_DEF));
926   return true;
927 }
928 
929 bool RISCVInstructionSelector::materializeImm(Register DstReg, int64_t Imm,
930                                               MachineIRBuilder &MIB) const {
931   MachineRegisterInfo &MRI = *MIB.getMRI();
932 
933   if (Imm == 0) {
934     MIB.buildCopy(DstReg, Register(RISCV::X0));
935     RBI.constrainGenericRegister(DstReg, RISCV::GPRRegClass, MRI);
936     return true;
937   }
938 
939   RISCVMatInt::InstSeq Seq = RISCVMatInt::generateInstSeq(Imm, *Subtarget);
940   unsigned NumInsts = Seq.size();
941   Register SrcReg = RISCV::X0;
942 
943   for (unsigned i = 0; i < NumInsts; i++) {
944     Register TmpReg = i < NumInsts - 1
945                           ? MRI.createVirtualRegister(&RISCV::GPRRegClass)
946                           : DstReg;
947     const RISCVMatInt::Inst &I = Seq[i];
948     MachineInstr *Result;
949 
950     switch (I.getOpndKind()) {
951     case RISCVMatInt::Imm:
952       // clang-format off
953       Result = MIB.buildInstr(I.getOpcode(), {TmpReg}, {})
954                    .addImm(I.getImm());
955       // clang-format on
956       break;
957     case RISCVMatInt::RegX0:
958       Result = MIB.buildInstr(I.getOpcode(), {TmpReg},
959                               {SrcReg, Register(RISCV::X0)});
960       break;
961     case RISCVMatInt::RegReg:
962       Result = MIB.buildInstr(I.getOpcode(), {TmpReg}, {SrcReg, SrcReg});
963       break;
964     case RISCVMatInt::RegImm:
965       Result =
966           MIB.buildInstr(I.getOpcode(), {TmpReg}, {SrcReg}).addImm(I.getImm());
967       break;
968     }
969 
970     if (!constrainSelectedInstRegOperands(*Result, TII, TRI, RBI))
971       return false;
972 
973     SrcReg = TmpReg;
974   }
975 
976   return true;
977 }
978 
979 bool RISCVInstructionSelector::selectAddr(MachineInstr &MI,
980                                           MachineIRBuilder &MIB,
981                                           MachineRegisterInfo &MRI,
982                                           bool IsLocal,
983                                           bool IsExternWeak) const {
984   assert((MI.getOpcode() == TargetOpcode::G_GLOBAL_VALUE ||
985           MI.getOpcode() == TargetOpcode::G_JUMP_TABLE ||
986           MI.getOpcode() == TargetOpcode::G_CONSTANT_POOL) &&
987          "Unexpected opcode");
988 
989   const MachineOperand &DispMO = MI.getOperand(1);
990 
991   Register DefReg = MI.getOperand(0).getReg();
992   const LLT DefTy = MRI.getType(DefReg);
993 
994   // When HWASAN is used and tagging of global variables is enabled
995   // they should be accessed via the GOT, since the tagged address of a global
996   // is incompatible with existing code models. This also applies to non-pic
997   // mode.
998   if (TM.isPositionIndependent() || Subtarget->allowTaggedGlobals()) {
999     if (IsLocal && !Subtarget->allowTaggedGlobals()) {
1000       // Use PC-relative addressing to access the symbol. This generates the
1001       // pattern (PseudoLLA sym), which expands to (addi (auipc %pcrel_hi(sym))
1002       // %pcrel_lo(auipc)).
1003       MI.setDesc(TII.get(RISCV::PseudoLLA));
1004       return constrainSelectedInstRegOperands(MI, TII, TRI, RBI);
1005     }
1006 
1007     // Use PC-relative addressing to access the GOT for this symbol, then
1008     // load the address from the GOT. This generates the pattern (PseudoLGA
1009     // sym), which expands to (ld (addi (auipc %got_pcrel_hi(sym))
1010     // %pcrel_lo(auipc))).
1011     MachineFunction &MF = *MI.getParent()->getParent();
1012     MachineMemOperand *MemOp = MF.getMachineMemOperand(
1013         MachinePointerInfo::getGOT(MF),
1014         MachineMemOperand::MOLoad | MachineMemOperand::MODereferenceable |
1015             MachineMemOperand::MOInvariant,
1016         DefTy, Align(DefTy.getSizeInBits() / 8));
1017 
1018     auto Result = MIB.buildInstr(RISCV::PseudoLGA, {DefReg}, {})
1019                       .addDisp(DispMO, 0)
1020                       .addMemOperand(MemOp);
1021 
1022     if (!constrainSelectedInstRegOperands(*Result, TII, TRI, RBI))
1023       return false;
1024 
1025     MI.eraseFromParent();
1026     return true;
1027   }
1028 
1029   switch (TM.getCodeModel()) {
1030   default: {
1031     reportGISelFailure(const_cast<MachineFunction &>(*MF), *TPC, *MORE,
1032                        getName(), "Unsupported code model for lowering", MI);
1033     return false;
1034   }
1035   case CodeModel::Small: {
1036     // Must lie within a single 2 GiB address range and must lie between
1037     // absolute addresses -2 GiB and +2 GiB. This generates the pattern (addi
1038     // (lui %hi(sym)) %lo(sym)).
1039     Register AddrHiDest = MRI.createVirtualRegister(&RISCV::GPRRegClass);
1040     MachineInstr *AddrHi = MIB.buildInstr(RISCV::LUI, {AddrHiDest}, {})
1041                                .addDisp(DispMO, 0, RISCVII::MO_HI);
1042 
1043     if (!constrainSelectedInstRegOperands(*AddrHi, TII, TRI, RBI))
1044       return false;
1045 
1046     auto Result = MIB.buildInstr(RISCV::ADDI, {DefReg}, {AddrHiDest})
1047                       .addDisp(DispMO, 0, RISCVII::MO_LO);
1048 
1049     if (!constrainSelectedInstRegOperands(*Result, TII, TRI, RBI))
1050       return false;
1051 
1052     MI.eraseFromParent();
1053     return true;
1054   }
1055   case CodeModel::Medium:
1056     // Emit LGA/LLA instead of the sequence it expands to because the pcrel_lo
1057     // relocation needs to reference a label that points to the auipc
1058     // instruction itself, not the global. This cannot be done inside the
1059     // instruction selector.
1060     if (IsExternWeak) {
1061       // An extern weak symbol may be undefined, i.e. have value 0, which may
1062       // not be within 2GiB of PC, so use GOT-indirect addressing to access the
1063       // symbol. This generates the pattern (PseudoLGA sym), which expands to
1064       // (ld (addi (auipc %got_pcrel_hi(sym)) %pcrel_lo(auipc))).
1065       MachineFunction &MF = *MI.getParent()->getParent();
1066       MachineMemOperand *MemOp = MF.getMachineMemOperand(
1067           MachinePointerInfo::getGOT(MF),
1068           MachineMemOperand::MOLoad | MachineMemOperand::MODereferenceable |
1069               MachineMemOperand::MOInvariant,
1070           DefTy, Align(DefTy.getSizeInBits() / 8));
1071 
1072       auto Result = MIB.buildInstr(RISCV::PseudoLGA, {DefReg}, {})
1073                         .addDisp(DispMO, 0)
1074                         .addMemOperand(MemOp);
1075 
1076       if (!constrainSelectedInstRegOperands(*Result, TII, TRI, RBI))
1077         return false;
1078 
1079       MI.eraseFromParent();
1080       return true;
1081     }
1082 
1083     // Generate a sequence for accessing addresses within any 2GiB range
1084     // within the address space. This generates the pattern (PseudoLLA sym),
1085     // which expands to (addi (auipc %pcrel_hi(sym)) %pcrel_lo(auipc)).
1086     MI.setDesc(TII.get(RISCV::PseudoLLA));
1087     return constrainSelectedInstRegOperands(MI, TII, TRI, RBI);
1088   }
1089 
1090   return false;
1091 }
1092 
1093 bool RISCVInstructionSelector::selectSExtInreg(MachineInstr &MI,
1094                                                MachineIRBuilder &MIB) const {
1095   if (!STI.isRV64())
1096     return false;
1097 
1098   const MachineOperand &Size = MI.getOperand(2);
1099   // Only Size == 32 (i.e. shift by 32 bits) is acceptable at this point.
1100   if (!Size.isImm() || Size.getImm() != 32)
1101     return false;
1102 
1103   const MachineOperand &Src = MI.getOperand(1);
1104   const MachineOperand &Dst = MI.getOperand(0);
1105   // addiw rd, rs, 0 (i.e. sext.w rd, rs)
1106   MachineInstr *NewMI =
1107       MIB.buildInstr(RISCV::ADDIW, {Dst.getReg()}, {Src.getReg()}).addImm(0U);
1108 
1109   if (!constrainSelectedInstRegOperands(*NewMI, TII, TRI, RBI))
1110     return false;
1111 
1112   MI.eraseFromParent();
1113   return true;
1114 }
1115 
1116 bool RISCVInstructionSelector::selectSelect(MachineInstr &MI,
1117                                             MachineIRBuilder &MIB,
1118                                             MachineRegisterInfo &MRI) const {
1119   auto &SelectMI = cast<GSelect>(MI);
1120 
1121   Register LHS, RHS;
1122   RISCVCC::CondCode CC;
1123   getOperandsForBranch(SelectMI.getCondReg(), MRI, CC, LHS, RHS);
1124 
1125   Register DstReg = SelectMI.getReg(0);
1126 
1127   unsigned Opc = RISCV::Select_GPR_Using_CC_GPR;
1128   if (RBI.getRegBank(DstReg, MRI, TRI)->getID() == RISCV::FPRBRegBankID) {
1129     unsigned Size = MRI.getType(DstReg).getSizeInBits();
1130     Opc = Size == 32 ? RISCV::Select_FPR32_Using_CC_GPR
1131                      : RISCV::Select_FPR64_Using_CC_GPR;
1132   }
1133 
1134   MachineInstr *Result = MIB.buildInstr(Opc)
1135                              .addDef(DstReg)
1136                              .addReg(LHS)
1137                              .addReg(RHS)
1138                              .addImm(CC)
1139                              .addReg(SelectMI.getTrueReg())
1140                              .addReg(SelectMI.getFalseReg());
1141   MI.eraseFromParent();
1142   return constrainSelectedInstRegOperands(*Result, TII, TRI, RBI);
1143 }
1144 
1145 // Convert an FCMP predicate to one of the supported F or D instructions.
1146 static unsigned getFCmpOpcode(CmpInst::Predicate Pred, unsigned Size) {
1147   assert((Size == 32 || Size == 64) && "Unsupported size");
1148   switch (Pred) {
1149   default:
1150     llvm_unreachable("Unsupported predicate");
1151   case CmpInst::FCMP_OLT:
1152     return Size == 32 ? RISCV::FLT_S : RISCV::FLT_D;
1153   case CmpInst::FCMP_OLE:
1154     return Size == 32 ? RISCV::FLE_S : RISCV::FLE_D;
1155   case CmpInst::FCMP_OEQ:
1156     return Size == 32 ? RISCV::FEQ_S : RISCV::FEQ_D;
1157   }
1158 }
1159 
1160 // Try legalizing an FCMP by swapping or inverting the predicate to one that
1161 // is supported.
1162 static bool legalizeFCmpPredicate(Register &LHS, Register &RHS,
1163                                   CmpInst::Predicate &Pred, bool &NeedInvert) {
1164   auto isLegalFCmpPredicate = [](CmpInst::Predicate Pred) {
1165     return Pred == CmpInst::FCMP_OLT || Pred == CmpInst::FCMP_OLE ||
1166            Pred == CmpInst::FCMP_OEQ;
1167   };
1168 
1169   assert(!isLegalFCmpPredicate(Pred) && "Predicate already legal?");
1170 
1171   CmpInst::Predicate InvPred = CmpInst::getSwappedPredicate(Pred);
1172   if (isLegalFCmpPredicate(InvPred)) {
1173     Pred = InvPred;
1174     std::swap(LHS, RHS);
1175     return true;
1176   }
1177 
1178   InvPred = CmpInst::getInversePredicate(Pred);
1179   NeedInvert = true;
1180   if (isLegalFCmpPredicate(InvPred)) {
1181     Pred = InvPred;
1182     return true;
1183   }
1184   InvPred = CmpInst::getSwappedPredicate(InvPred);
1185   if (isLegalFCmpPredicate(InvPred)) {
1186     Pred = InvPred;
1187     std::swap(LHS, RHS);
1188     return true;
1189   }
1190 
1191   return false;
1192 }
1193 
1194 // Emit a sequence of instructions to compare LHS and RHS using Pred. Return
1195 // the result in DstReg.
1196 // FIXME: Maybe we should expand this earlier.
1197 bool RISCVInstructionSelector::selectFPCompare(MachineInstr &MI,
1198                                                MachineIRBuilder &MIB,
1199                                                MachineRegisterInfo &MRI) const {
1200   auto &CmpMI = cast<GFCmp>(MI);
1201   CmpInst::Predicate Pred = CmpMI.getCond();
1202 
1203   Register DstReg = CmpMI.getReg(0);
1204   Register LHS = CmpMI.getLHSReg();
1205   Register RHS = CmpMI.getRHSReg();
1206 
1207   unsigned Size = MRI.getType(LHS).getSizeInBits();
1208   assert((Size == 32 || Size == 64) && "Unexpected size");
1209 
1210   Register TmpReg = DstReg;
1211 
1212   bool NeedInvert = false;
1213   // First try swapping operands or inverting.
1214   if (legalizeFCmpPredicate(LHS, RHS, Pred, NeedInvert)) {
1215     if (NeedInvert)
1216       TmpReg = MRI.createVirtualRegister(&RISCV::GPRRegClass);
1217     auto Cmp = MIB.buildInstr(getFCmpOpcode(Pred, Size), {TmpReg}, {LHS, RHS});
1218     if (!Cmp.constrainAllUses(TII, TRI, RBI))
1219       return false;
1220   } else if (Pred == CmpInst::FCMP_ONE || Pred == CmpInst::FCMP_UEQ) {
1221     // fcmp one LHS, RHS => (OR (FLT LHS, RHS), (FLT RHS, LHS))
1222     NeedInvert = Pred == CmpInst::FCMP_UEQ;
1223     auto Cmp1 = MIB.buildInstr(getFCmpOpcode(CmpInst::FCMP_OLT, Size),
1224                                {&RISCV::GPRRegClass}, {LHS, RHS});
1225     if (!Cmp1.constrainAllUses(TII, TRI, RBI))
1226       return false;
1227     auto Cmp2 = MIB.buildInstr(getFCmpOpcode(CmpInst::FCMP_OLT, Size),
1228                                {&RISCV::GPRRegClass}, {RHS, LHS});
1229     if (!Cmp2.constrainAllUses(TII, TRI, RBI))
1230       return false;
1231     if (NeedInvert)
1232       TmpReg = MRI.createVirtualRegister(&RISCV::GPRRegClass);
1233     auto Or =
1234         MIB.buildInstr(RISCV::OR, {TmpReg}, {Cmp1.getReg(0), Cmp2.getReg(0)});
1235     if (!Or.constrainAllUses(TII, TRI, RBI))
1236       return false;
1237   } else if (Pred == CmpInst::FCMP_ORD || Pred == CmpInst::FCMP_UNO) {
1238     // fcmp ord LHS, RHS => (AND (FEQ LHS, LHS), (FEQ RHS, RHS))
1239     // FIXME: If LHS and RHS are the same we can use a single FEQ.
1240     NeedInvert = Pred == CmpInst::FCMP_UNO;
1241     auto Cmp1 = MIB.buildInstr(getFCmpOpcode(CmpInst::FCMP_OEQ, Size),
1242                                {&RISCV::GPRRegClass}, {LHS, LHS});
1243     if (!Cmp1.constrainAllUses(TII, TRI, RBI))
1244       return false;
1245     auto Cmp2 = MIB.buildInstr(getFCmpOpcode(CmpInst::FCMP_OEQ, Size),
1246                                {&RISCV::GPRRegClass}, {RHS, RHS});
1247     if (!Cmp2.constrainAllUses(TII, TRI, RBI))
1248       return false;
1249     if (NeedInvert)
1250       TmpReg = MRI.createVirtualRegister(&RISCV::GPRRegClass);
1251     auto And =
1252         MIB.buildInstr(RISCV::AND, {TmpReg}, {Cmp1.getReg(0), Cmp2.getReg(0)});
1253     if (!And.constrainAllUses(TII, TRI, RBI))
1254       return false;
1255   } else
1256     llvm_unreachable("Unhandled predicate");
1257 
1258   // Emit an XORI to invert the result if needed.
1259   if (NeedInvert) {
1260     auto Xor = MIB.buildInstr(RISCV::XORI, {DstReg}, {TmpReg}).addImm(1);
1261     if (!Xor.constrainAllUses(TII, TRI, RBI))
1262       return false;
1263   }
1264 
1265   MI.eraseFromParent();
1266   return true;
1267 }
1268 
1269 void RISCVInstructionSelector::emitFence(AtomicOrdering FenceOrdering,
1270                                          SyncScope::ID FenceSSID,
1271                                          MachineIRBuilder &MIB) const {
1272   if (STI.hasStdExtZtso()) {
1273     // The only fence that needs an instruction is a sequentially-consistent
1274     // cross-thread fence.
1275     if (FenceOrdering == AtomicOrdering::SequentiallyConsistent &&
1276         FenceSSID == SyncScope::System) {
1277       // fence rw, rw
1278       MIB.buildInstr(RISCV::FENCE, {}, {})
1279           .addImm(RISCVFenceField::R | RISCVFenceField::W)
1280           .addImm(RISCVFenceField::R | RISCVFenceField::W);
1281       return;
1282     }
1283 
1284     // MEMBARRIER is a compiler barrier; it codegens to a no-op.
1285     MIB.buildInstr(TargetOpcode::MEMBARRIER, {}, {});
1286     return;
1287   }
1288 
1289   // singlethread fences only synchronize with signal handlers on the same
1290   // thread and thus only need to preserve instruction order, not actually
1291   // enforce memory ordering.
1292   if (FenceSSID == SyncScope::SingleThread) {
1293     MIB.buildInstr(TargetOpcode::MEMBARRIER, {}, {});
1294     return;
1295   }
1296 
1297   // Refer to Table A.6 in the version 2.3 draft of the RISC-V Instruction Set
1298   // Manual: Volume I.
1299   unsigned Pred, Succ;
1300   switch (FenceOrdering) {
1301   default:
1302     llvm_unreachable("Unexpected ordering");
1303   case AtomicOrdering::AcquireRelease:
1304     // fence acq_rel -> fence.tso
1305     MIB.buildInstr(RISCV::FENCE_TSO, {}, {});
1306     return;
1307   case AtomicOrdering::Acquire:
1308     // fence acquire -> fence r, rw
1309     Pred = RISCVFenceField::R;
1310     Succ = RISCVFenceField::R | RISCVFenceField::W;
1311     break;
1312   case AtomicOrdering::Release:
1313     // fence release -> fence rw, w
1314     Pred = RISCVFenceField::R | RISCVFenceField::W;
1315     Succ = RISCVFenceField::W;
1316     break;
1317   case AtomicOrdering::SequentiallyConsistent:
1318     // fence seq_cst -> fence rw, rw
1319     Pred = RISCVFenceField::R | RISCVFenceField::W;
1320     Succ = RISCVFenceField::R | RISCVFenceField::W;
1321     break;
1322   }
1323   MIB.buildInstr(RISCV::FENCE, {}, {}).addImm(Pred).addImm(Succ);
1324 }
1325 
1326 namespace llvm {
1327 InstructionSelector *
1328 createRISCVInstructionSelector(const RISCVTargetMachine &TM,
1329                                RISCVSubtarget &Subtarget,
1330                                RISCVRegisterBankInfo &RBI) {
1331   return new RISCVInstructionSelector(TM, Subtarget, RBI);
1332 }
1333 } // end namespace llvm
1334