[InstCombine] Signed saturation tests. NFC
[llvm-complete.git] / lib / Target / RISCV / RISCVInstrInfo.td
blobdb2ecc49d14e400fa02ae52af8c44ab6ecd3ac91
1 //===-- RISCVInstrInfo.td - Target Description for RISCV ---*- tablegen -*-===//
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 // This file describes the RISC-V instructions in TableGen format.
11 //===----------------------------------------------------------------------===//
13 //===----------------------------------------------------------------------===//
14 // RISC-V specific DAG Nodes.
15 //===----------------------------------------------------------------------===//
17 // Target-independent type requirements, but with target-specific formats.
18 def SDT_CallSeqStart : SDCallSeqStart<[SDTCisVT<0, i32>,
19                                        SDTCisVT<1, i32>]>;
20 def SDT_CallSeqEnd   : SDCallSeqEnd<[SDTCisVT<0, i32>,
21                                      SDTCisVT<1, i32>]>;
23 // Target-dependent type requirements.
24 def SDT_RISCVCall     : SDTypeProfile<0, -1, [SDTCisVT<0, XLenVT>]>;
25 def SDT_RISCVSelectCC : SDTypeProfile<1, 5, [SDTCisSameAs<1, 2>,
26                                              SDTCisSameAs<0, 4>,
27                                              SDTCisSameAs<4, 5>]>;
29 // Target-independent nodes, but with target-specific formats.
30 def callseq_start : SDNode<"ISD::CALLSEQ_START", SDT_CallSeqStart,
31                            [SDNPHasChain, SDNPOutGlue]>;
32 def callseq_end   : SDNode<"ISD::CALLSEQ_END", SDT_CallSeqEnd,
33                            [SDNPHasChain, SDNPOptInGlue, SDNPOutGlue]>;
35 // Target-dependent nodes.
36 def riscv_call      : SDNode<"RISCVISD::CALL", SDT_RISCVCall,
37                              [SDNPHasChain, SDNPOptInGlue, SDNPOutGlue,
38                               SDNPVariadic]>;
39 def riscv_ret_flag  : SDNode<"RISCVISD::RET_FLAG", SDTNone,
40                              [SDNPHasChain, SDNPOptInGlue, SDNPVariadic]>;
41 def riscv_uret_flag : SDNode<"RISCVISD::URET_FLAG", SDTNone,
42                              [SDNPHasChain, SDNPOptInGlue]>;
43 def riscv_sret_flag : SDNode<"RISCVISD::SRET_FLAG", SDTNone,
44                              [SDNPHasChain, SDNPOptInGlue]>;
45 def riscv_mret_flag : SDNode<"RISCVISD::MRET_FLAG", SDTNone,
46                              [SDNPHasChain, SDNPOptInGlue]>;
47 def riscv_selectcc  : SDNode<"RISCVISD::SELECT_CC", SDT_RISCVSelectCC,
48                              [SDNPInGlue]>;
49 def riscv_tail      : SDNode<"RISCVISD::TAIL", SDT_RISCVCall,
50                              [SDNPHasChain, SDNPOptInGlue, SDNPOutGlue,
51                               SDNPVariadic]>;
52 def riscv_sllw      : SDNode<"RISCVISD::SLLW", SDTIntShiftOp>;
53 def riscv_sraw      : SDNode<"RISCVISD::SRAW", SDTIntShiftOp>;
54 def riscv_srlw      : SDNode<"RISCVISD::SRLW", SDTIntShiftOp>;
56 //===----------------------------------------------------------------------===//
57 // Operand and SDNode transformation definitions.
58 //===----------------------------------------------------------------------===//
60 class ImmXLenAsmOperand<string prefix, string suffix = ""> : AsmOperandClass {
61   let Name = prefix # "ImmXLen" # suffix;
62   let RenderMethod = "addImmOperands";
63   let DiagnosticType = !strconcat("Invalid", Name);
66 class ImmAsmOperand<string prefix, int width, string suffix> : AsmOperandClass {
67   let Name = prefix # "Imm" # width # suffix;
68   let RenderMethod = "addImmOperands";
69   let DiagnosticType = !strconcat("Invalid", Name);
72 def ImmZeroAsmOperand : AsmOperandClass {
73   let Name = "ImmZero";
74   let RenderMethod = "addImmOperands";
75   let DiagnosticType = !strconcat("Invalid", Name);
78 class SImmAsmOperand<int width, string suffix = "">
79     : ImmAsmOperand<"S", width, suffix> {
82 class UImmAsmOperand<int width, string suffix = "">
83     : ImmAsmOperand<"U", width, suffix> {
86 def FenceArg : AsmOperandClass {
87   let Name = "FenceArg";
88   let RenderMethod = "addFenceArgOperands";
89   let DiagnosticType = "InvalidFenceArg";
92 def fencearg : Operand<XLenVT> {
93   let ParserMatchClass = FenceArg;
94   let PrintMethod = "printFenceArg";
95   let DecoderMethod = "decodeUImmOperand<4>";
96   let OperandType = "OPERAND_UIMM4";
97   let OperandNamespace = "RISCVOp";
100 def UImmLog2XLenAsmOperand : AsmOperandClass {
101   let Name = "UImmLog2XLen";
102   let RenderMethod = "addImmOperands";
103   let DiagnosticType = "InvalidUImmLog2XLen";
106 def uimmlog2xlen : Operand<XLenVT>, ImmLeaf<XLenVT, [{
107   if (Subtarget->is64Bit())
108     return isUInt<6>(Imm);
109   return isUInt<5>(Imm);
110 }]> {
111   let ParserMatchClass = UImmLog2XLenAsmOperand;
112   // TODO: should ensure invalid shamt is rejected when decoding.
113   let DecoderMethod = "decodeUImmOperand<6>";
114   let MCOperandPredicate = [{
115     int64_t Imm;
116     if (!MCOp.evaluateAsConstantImm(Imm))
117       return false;
118     if (STI.getTargetTriple().isArch64Bit())
119       return  isUInt<6>(Imm);
120     return isUInt<5>(Imm);
121   }];
122   let OperandType = "OPERAND_UIMMLOG2XLEN";
123   let OperandNamespace = "RISCVOp";
126 def uimm5 : Operand<XLenVT>, ImmLeaf<XLenVT, [{return isUInt<5>(Imm);}]> {
127   let ParserMatchClass = UImmAsmOperand<5>;
128   let DecoderMethod = "decodeUImmOperand<5>";
129   let OperandType = "OPERAND_UIMM5";
130   let OperandNamespace = "RISCVOp";
133 def simm12 : Operand<XLenVT>, ImmLeaf<XLenVT, [{return isInt<12>(Imm);}]> {
134   let ParserMatchClass = SImmAsmOperand<12>;
135   let EncoderMethod = "getImmOpValue";
136   let DecoderMethod = "decodeSImmOperand<12>";
137   let MCOperandPredicate = [{
138     int64_t Imm;
139     if (MCOp.evaluateAsConstantImm(Imm))
140       return isInt<12>(Imm);
141     return MCOp.isBareSymbolRef();
142   }];
143   let OperandType = "OPERAND_SIMM12";
144   let OperandNamespace = "RISCVOp";
147 // A 13-bit signed immediate where the least significant bit is zero.
148 def simm13_lsb0 : Operand<OtherVT> {
149   let ParserMatchClass = SImmAsmOperand<13, "Lsb0">;
150   let EncoderMethod = "getImmOpValueAsr1";
151   let DecoderMethod = "decodeSImmOperandAndLsl1<13>";
152   let MCOperandPredicate = [{
153     int64_t Imm;
154     if (MCOp.evaluateAsConstantImm(Imm))
155       return isShiftedInt<12, 1>(Imm);
156     return MCOp.isBareSymbolRef();
157   }];
158   let OperandType = "OPERAND_SIMM13_LSB0";
159   let OperandNamespace = "RISCVOp";
162 class UImm20Operand : Operand<XLenVT> {
163   let EncoderMethod = "getImmOpValue";
164   let DecoderMethod = "decodeUImmOperand<20>";
165   let MCOperandPredicate = [{
166     int64_t Imm;
167     if (MCOp.evaluateAsConstantImm(Imm))
168       return isUInt<20>(Imm);
169     return MCOp.isBareSymbolRef();
170   }];
171   let OperandType = "OPERAND_UIMM20";
172   let OperandNamespace = "RISCVOp";
175 def uimm20_lui : UImm20Operand {
176   let ParserMatchClass = UImmAsmOperand<20, "LUI">;
178 def uimm20_auipc : UImm20Operand {
179   let ParserMatchClass = UImmAsmOperand<20, "AUIPC">;
182 def Simm21Lsb0JALAsmOperand : SImmAsmOperand<21, "Lsb0JAL"> {
183   let ParserMethod = "parseJALOffset";
186 // A 21-bit signed immediate where the least significant bit is zero.
187 def simm21_lsb0_jal : Operand<OtherVT> {
188   let ParserMatchClass = Simm21Lsb0JALAsmOperand;
189   let EncoderMethod = "getImmOpValueAsr1";
190   let DecoderMethod = "decodeSImmOperandAndLsl1<21>";
191   let MCOperandPredicate = [{
192     int64_t Imm;
193     if (MCOp.evaluateAsConstantImm(Imm))
194       return isShiftedInt<20, 1>(Imm);
195     return MCOp.isBareSymbolRef();
196   }];
197   let OperandType = "OPERAND_SIMM21_LSB0";
198   let OperandNamespace = "RISCVOp";
201 def BareSymbol : AsmOperandClass {
202   let Name = "BareSymbol";
203   let RenderMethod = "addImmOperands";
204   let DiagnosticType = "InvalidBareSymbol";
205   let ParserMethod = "parseBareSymbol";
208 // A bare symbol.
209 def bare_symbol : Operand<XLenVT> {
210   let ParserMatchClass = BareSymbol;
213 def CallSymbol : AsmOperandClass {
214   let Name = "CallSymbol";
215   let RenderMethod = "addImmOperands";
216   let DiagnosticType = "InvalidCallSymbol";
217   let ParserMethod = "parseCallSymbol";
220 // A bare symbol used in call/tail only.
221 def call_symbol : Operand<XLenVT> {
222   let ParserMatchClass = CallSymbol;
225 def TPRelAddSymbol : AsmOperandClass {
226   let Name = "TPRelAddSymbol";
227   let RenderMethod = "addImmOperands";
228   let DiagnosticType = "InvalidTPRelAddSymbol";
229   let ParserMethod = "parseOperandWithModifier";
232 // A bare symbol with the %tprel_add variant.
233 def tprel_add_symbol : Operand<XLenVT> {
234   let ParserMatchClass = TPRelAddSymbol;
237 def CSRSystemRegister : AsmOperandClass {
238   let Name = "CSRSystemRegister";
239   let ParserMethod = "parseCSRSystemRegister";
240   let DiagnosticType = "InvalidCSRSystemRegister";
243 def csr_sysreg : Operand<XLenVT> {
244   let ParserMatchClass = CSRSystemRegister;
245   let PrintMethod = "printCSRSystemRegister";
246   let DecoderMethod = "decodeUImmOperand<12>";
247   let OperandType = "OPERAND_UIMM12";
248   let OperandNamespace = "RISCVOp";
251 // A parameterized register class alternative to i32imm/i64imm from Target.td.
252 def ixlenimm : Operand<XLenVT>;
254 def ixlenimm_li : Operand<XLenVT> {
255   let ParserMatchClass = ImmXLenAsmOperand<"", "LI">;
258 // Standalone (codegen-only) immleaf patterns.
259 def simm32     : ImmLeaf<XLenVT, [{return isInt<32>(Imm);}]>;
260 def simm32hi20 : ImmLeaf<XLenVT, [{return isShiftedInt<20, 12>(Imm);}]>;
261 // A mask value that won't affect significant shift bits.
262 def immbottomxlenset : ImmLeaf<XLenVT, [{
263   if (Subtarget->is64Bit())
264     return countTrailingOnes<uint64_t>(Imm) >= 6;
265   return countTrailingOnes<uint64_t>(Imm) >= 5;
266 }]>;
268 // Addressing modes.
269 // Necessary because a frameindex can't be matched directly in a pattern.
270 def AddrFI : ComplexPattern<iPTR, 1, "SelectAddrFI", [frameindex], []>;
272 // Extract least significant 12 bits from an immediate value and sign extend
273 // them.
274 def LO12Sext : SDNodeXForm<imm, [{
275   return CurDAG->getTargetConstant(SignExtend64<12>(N->getZExtValue()),
276                                    SDLoc(N), N->getValueType(0));
277 }]>;
279 // Extract the most significant 20 bits from an immediate value. Add 1 if bit
280 // 11 is 1, to compensate for the low 12 bits in the matching immediate addi
281 // or ld/st being negative.
282 def HI20 : SDNodeXForm<imm, [{
283   return CurDAG->getTargetConstant(((N->getZExtValue()+0x800) >> 12) & 0xfffff,
284                                    SDLoc(N), N->getValueType(0));
285 }]>;
287 //===----------------------------------------------------------------------===//
288 // Instruction Formats
289 //===----------------------------------------------------------------------===//
291 include "RISCVInstrFormats.td"
293 //===----------------------------------------------------------------------===//
294 // Instruction Class Templates
295 //===----------------------------------------------------------------------===//
297 let hasSideEffects = 0, mayLoad = 0, mayStore = 0 in
298 class BranchCC_rri<bits<3> funct3, string opcodestr>
299     : RVInstB<funct3, OPC_BRANCH, (outs),
300               (ins GPR:$rs1, GPR:$rs2, simm13_lsb0:$imm12),
301               opcodestr, "$rs1, $rs2, $imm12"> {
302   let isBranch = 1;
303   let isTerminator = 1;
306 let hasSideEffects = 0, mayLoad = 1, mayStore = 0 in
307 class Load_ri<bits<3> funct3, string opcodestr>
308     : RVInstI<funct3, OPC_LOAD, (outs GPR:$rd), (ins GPR:$rs1, simm12:$imm12),
309               opcodestr, "$rd, ${imm12}(${rs1})">;
311 // Operands for stores are in the order srcreg, base, offset rather than
312 // reflecting the order these fields are specified in the instruction
313 // encoding.
314 let hasSideEffects = 0, mayLoad = 0, mayStore = 1 in
315 class Store_rri<bits<3> funct3, string opcodestr>
316     : RVInstS<funct3, OPC_STORE, (outs),
317               (ins GPR:$rs2, GPR:$rs1, simm12:$imm12),
318               opcodestr, "$rs2, ${imm12}(${rs1})">;
320 let hasSideEffects = 0, mayLoad = 0, mayStore = 0 in
321 class ALU_ri<bits<3> funct3, string opcodestr>
322     : RVInstI<funct3, OPC_OP_IMM, (outs GPR:$rd), (ins GPR:$rs1, simm12:$imm12),
323               opcodestr, "$rd, $rs1, $imm12">;
325 let hasSideEffects = 0, mayLoad = 0, mayStore = 0 in
326 class Shift_ri<bit arithshift, bits<3> funct3, string opcodestr>
327     : RVInstIShift<arithshift, funct3, OPC_OP_IMM, (outs GPR:$rd),
328                    (ins GPR:$rs1, uimmlog2xlen:$shamt), opcodestr,
329                    "$rd, $rs1, $shamt">;
331 let hasSideEffects = 0, mayLoad = 0, mayStore = 0 in
332 class ALU_rr<bits<7> funct7, bits<3> funct3, string opcodestr>
333     : RVInstR<funct7, funct3, OPC_OP, (outs GPR:$rd), (ins GPR:$rs1, GPR:$rs2),
334               opcodestr, "$rd, $rs1, $rs2">;
336 let hasSideEffects = 1, mayLoad = 0, mayStore = 0 in
337 class CSR_ir<bits<3> funct3, string opcodestr>
338     : RVInstI<funct3, OPC_SYSTEM, (outs GPR:$rd), (ins csr_sysreg:$imm12, GPR:$rs1),
339               opcodestr, "$rd, $imm12, $rs1">;
341 let hasSideEffects = 1, mayLoad = 0, mayStore = 0 in
342 class CSR_ii<bits<3> funct3, string opcodestr>
343     : RVInstI<funct3, OPC_SYSTEM, (outs GPR:$rd),
344               (ins csr_sysreg:$imm12, uimm5:$rs1),
345               opcodestr, "$rd, $imm12, $rs1">;
347 let hasSideEffects = 0, mayLoad = 0, mayStore = 0 in
348 class ShiftW_ri<bit arithshift, bits<3> funct3, string opcodestr>
349     : RVInstIShiftW<arithshift, funct3, OPC_OP_IMM_32, (outs GPR:$rd),
350                     (ins GPR:$rs1, uimm5:$shamt), opcodestr,
351                     "$rd, $rs1, $shamt">;
353 let hasSideEffects = 0, mayLoad = 0, mayStore = 0 in
354 class ALUW_rr<bits<7> funct7, bits<3> funct3, string opcodestr>
355     : RVInstR<funct7, funct3, OPC_OP_32, (outs GPR:$rd),
356               (ins GPR:$rs1, GPR:$rs2), opcodestr, "$rd, $rs1, $rs2">;
358 let hasSideEffects = 1, mayLoad = 0, mayStore = 0 in
359 class Priv<string opcodestr, bits<7> funct7>
360     : RVInstR<funct7, 0b000, OPC_SYSTEM, (outs), (ins GPR:$rs1, GPR:$rs2),
361               opcodestr, "">;
363 //===----------------------------------------------------------------------===//
364 // Instructions
365 //===----------------------------------------------------------------------===//
367 let hasSideEffects = 0, mayLoad = 0, mayStore = 0 in {
368 let isReMaterializable = 1, isAsCheapAsAMove = 1 in
369 def LUI : RVInstU<OPC_LUI, (outs GPR:$rd), (ins uimm20_lui:$imm20),
370                   "lui", "$rd, $imm20">;
372 def AUIPC : RVInstU<OPC_AUIPC, (outs GPR:$rd), (ins uimm20_auipc:$imm20),
373                     "auipc", "$rd, $imm20">;
375 let isCall = 1 in
376 def JAL : RVInstJ<OPC_JAL, (outs GPR:$rd), (ins simm21_lsb0_jal:$imm20),
377                   "jal", "$rd, $imm20">;
379 let isCall = 1 in
380 def JALR : RVInstI<0b000, OPC_JALR, (outs GPR:$rd),
381                    (ins GPR:$rs1, simm12:$imm12),
382                    "jalr", "$rd, ${imm12}(${rs1})">;
383 } // hasSideEffects = 0, mayLoad = 0, mayStore = 0
385 def BEQ  : BranchCC_rri<0b000, "beq">;
386 def BNE  : BranchCC_rri<0b001, "bne">;
387 def BLT  : BranchCC_rri<0b100, "blt">;
388 def BGE  : BranchCC_rri<0b101, "bge">;
389 def BLTU : BranchCC_rri<0b110, "bltu">;
390 def BGEU : BranchCC_rri<0b111, "bgeu">;
392 def LB  : Load_ri<0b000, "lb">;
393 def LH  : Load_ri<0b001, "lh">;
394 def LW  : Load_ri<0b010, "lw">;
395 def LBU : Load_ri<0b100, "lbu">;
396 def LHU : Load_ri<0b101, "lhu">;
398 def SB : Store_rri<0b000, "sb">;
399 def SH : Store_rri<0b001, "sh">;
400 def SW : Store_rri<0b010, "sw">;
402 // ADDI isn't always rematerializable, but isReMaterializable will be used as
403 // a hint which is verified in isReallyTriviallyReMaterializable.
404 let isReMaterializable = 1, isAsCheapAsAMove = 1 in
405 def ADDI  : ALU_ri<0b000, "addi">;
407 def SLTI  : ALU_ri<0b010, "slti">;
408 def SLTIU : ALU_ri<0b011, "sltiu">;
410 let isReMaterializable = 1, isAsCheapAsAMove = 1 in {
411 def XORI  : ALU_ri<0b100, "xori">;
412 def ORI   : ALU_ri<0b110, "ori">;
415 def ANDI  : ALU_ri<0b111, "andi">;
417 def SLLI : Shift_ri<0, 0b001, "slli">;
418 def SRLI : Shift_ri<0, 0b101, "srli">;
419 def SRAI : Shift_ri<1, 0b101, "srai">;
421 def ADD  : ALU_rr<0b0000000, 0b000, "add">;
422 def SUB  : ALU_rr<0b0100000, 0b000, "sub">;
423 def SLL  : ALU_rr<0b0000000, 0b001, "sll">;
424 def SLT  : ALU_rr<0b0000000, 0b010, "slt">;
425 def SLTU : ALU_rr<0b0000000, 0b011, "sltu">;
426 def XOR  : ALU_rr<0b0000000, 0b100, "xor">;
427 def SRL  : ALU_rr<0b0000000, 0b101, "srl">;
428 def SRA  : ALU_rr<0b0100000, 0b101, "sra">;
429 def OR   : ALU_rr<0b0000000, 0b110, "or">;
430 def AND  : ALU_rr<0b0000000, 0b111, "and">;
432 let hasSideEffects = 1, mayLoad = 0, mayStore = 0 in {
433 def FENCE : RVInstI<0b000, OPC_MISC_MEM, (outs),
434                     (ins fencearg:$pred, fencearg:$succ),
435                     "fence", "$pred, $succ"> {
436   bits<4> pred;
437   bits<4> succ;
439   let rs1 = 0;
440   let rd = 0;
441   let imm12 = {0b0000,pred,succ};
444 def FENCE_TSO : RVInstI<0b000, OPC_MISC_MEM, (outs), (ins), "fence.tso", ""> {
445   let rs1 = 0;
446   let rd = 0;
447   let imm12 = {0b1000,0b0011,0b0011};
450 def FENCE_I : RVInstI<0b001, OPC_MISC_MEM, (outs), (ins), "fence.i", ""> {
451   let rs1 = 0;
452   let rd = 0;
453   let imm12 = 0;
456 def ECALL : RVInstI<0b000, OPC_SYSTEM, (outs), (ins), "ecall", ""> {
457   let rs1 = 0;
458   let rd = 0;
459   let imm12 = 0;
462 def EBREAK : RVInstI<0b000, OPC_SYSTEM, (outs), (ins), "ebreak", ""> {
463   let rs1 = 0;
464   let rd = 0;
465   let imm12 = 1;
468 // This is a de facto standard (as set by GNU binutils) 32-bit unimplemented
469 // instruction (i.e., it should always trap, if your implementation has invalid
470 // instruction traps).
471 def UNIMP : RVInstI<0b001, OPC_SYSTEM, (outs), (ins), "unimp", ""> {
472   let rs1 = 0;
473   let rd = 0;
474   let imm12 = 0b110000000000;
476 } // hasSideEffects = 1, mayLoad = 0, mayStore = 0
478 def CSRRW : CSR_ir<0b001, "csrrw">;
479 def CSRRS : CSR_ir<0b010, "csrrs">;
480 def CSRRC : CSR_ir<0b011, "csrrc">;
482 def CSRRWI : CSR_ii<0b101, "csrrwi">;
483 def CSRRSI : CSR_ii<0b110, "csrrsi">;
484 def CSRRCI : CSR_ii<0b111, "csrrci">;
486 /// RV64I instructions
488 let Predicates = [IsRV64] in {
489 def LWU   : Load_ri<0b110, "lwu">;
490 def LD    : Load_ri<0b011, "ld">;
491 def SD    : Store_rri<0b011, "sd">;
493 let hasSideEffects = 0, mayLoad = 0, mayStore = 0 in
494 def ADDIW : RVInstI<0b000, OPC_OP_IMM_32, (outs GPR:$rd),
495                     (ins GPR:$rs1, simm12:$imm12),
496                     "addiw", "$rd, $rs1, $imm12">;
498 def SLLIW : ShiftW_ri<0, 0b001, "slliw">;
499 def SRLIW : ShiftW_ri<0, 0b101, "srliw">;
500 def SRAIW : ShiftW_ri<1, 0b101, "sraiw">;
502 def ADDW  : ALUW_rr<0b0000000, 0b000, "addw">;
503 def SUBW  : ALUW_rr<0b0100000, 0b000, "subw">;
504 def SLLW  : ALUW_rr<0b0000000, 0b001, "sllw">;
505 def SRLW  : ALUW_rr<0b0000000, 0b101, "srlw">;
506 def SRAW  : ALUW_rr<0b0100000, 0b101, "sraw">;
507 } // Predicates = [IsRV64]
509 //===----------------------------------------------------------------------===//
510 // Privileged instructions
511 //===----------------------------------------------------------------------===//
513 let isBarrier = 1, isReturn = 1, isTerminator = 1 in {
514 def URET : Priv<"uret", 0b0000000> {
515   let rd = 0;
516   let rs1 = 0;
517   let rs2 = 0b00010;
520 def SRET : Priv<"sret", 0b0001000> {
521   let rd = 0;
522   let rs1 = 0;
523   let rs2 = 0b00010;
526 def MRET : Priv<"mret", 0b0011000> {
527   let rd = 0;
528   let rs1 = 0;
529   let rs2 = 0b00010;
531 } // isBarrier = 1, isReturn = 1, isTerminator = 1
533 def WFI : Priv<"wfi", 0b0001000> {
534   let rd = 0;
535   let rs1 = 0;
536   let rs2 = 0b00101;
539 let hasSideEffects = 1, mayLoad = 0, mayStore = 0 in
540 def SFENCE_VMA : RVInstR<0b0001001, 0b000, OPC_SYSTEM, (outs),
541                          (ins GPR:$rs1, GPR:$rs2),
542                          "sfence.vma", "$rs1, $rs2"> {
543   let rd = 0;
546 //===----------------------------------------------------------------------===//
547 // Assembler Pseudo Instructions (User-Level ISA, Version 2.2, Chapter 20)
548 //===----------------------------------------------------------------------===//
550 def : InstAlias<"nop",           (ADDI      X0,      X0,       0)>;
552 // Note that the size is 32 because up to 8 32-bit instructions are needed to
553 // generate an arbitrary 64-bit immediate. However, the size does not really
554 // matter since PseudoLI is currently only used in the AsmParser where it gets
555 // expanded to real instructions immediately.
556 let hasSideEffects = 0, mayLoad = 0, mayStore = 0, Size = 32,
557     isCodeGenOnly = 0, isAsmParserOnly = 1 in
558 def PseudoLI : Pseudo<(outs GPR:$rd), (ins ixlenimm_li:$imm), [],
559                       "li", "$rd, $imm">;
561 def PseudoLB  : PseudoLoad<"lb">;
562 def PseudoLBU : PseudoLoad<"lbu">;
563 def PseudoLH  : PseudoLoad<"lh">;
564 def PseudoLHU : PseudoLoad<"lhu">;
565 def PseudoLW  : PseudoLoad<"lw">;
567 def PseudoSB  : PseudoStore<"sb">;
568 def PseudoSH  : PseudoStore<"sh">;
569 def PseudoSW  : PseudoStore<"sw">;
571 let Predicates = [IsRV64] in {
572 def PseudoLWU : PseudoLoad<"lwu">;
573 def PseudoLD  : PseudoLoad<"ld">;
574 def PseudoSD  : PseudoStore<"sd">;
575 } // Predicates = [IsRV64]
577 def : InstAlias<"mv $rd, $rs",   (ADDI GPR:$rd, GPR:$rs,       0)>;
578 def : InstAlias<"not $rd, $rs",  (XORI GPR:$rd, GPR:$rs,      -1)>;
579 def : InstAlias<"neg $rd, $rs",  (SUB  GPR:$rd,      X0, GPR:$rs)>;
581 let Predicates = [IsRV64] in {
582 def : InstAlias<"negw $rd, $rs",   (SUBW  GPR:$rd,      X0, GPR:$rs)>;
583 def : InstAlias<"sext.w $rd, $rs", (ADDIW GPR:$rd, GPR:$rs,       0)>;
584 } // Predicates = [IsRV64]
586 def : InstAlias<"seqz $rd, $rs", (SLTIU GPR:$rd, GPR:$rs,       1)>;
587 def : InstAlias<"snez $rd, $rs", (SLTU  GPR:$rd,      X0, GPR:$rs)>;
588 def : InstAlias<"sltz $rd, $rs", (SLT   GPR:$rd, GPR:$rs,      X0)>;
589 def : InstAlias<"sgtz $rd, $rs", (SLT   GPR:$rd,      X0, GPR:$rs)>;
591 // sgt/sgtu are recognised by the GNU assembler but the canonical slt/sltu
592 // form will always be printed. Therefore, set a zero weight.
593 def : InstAlias<"sgt $rd, $rs, $rt", (SLT GPR:$rd, GPR:$rt, GPR:$rs), 0>;
594 def : InstAlias<"sgtu $rd, $rs, $rt", (SLTU GPR:$rd, GPR:$rt, GPR:$rs), 0>;
596 def : InstAlias<"beqz $rs, $offset",
597                 (BEQ GPR:$rs,      X0, simm13_lsb0:$offset)>;
598 def : InstAlias<"bnez $rs, $offset",
599                 (BNE GPR:$rs,      X0, simm13_lsb0:$offset)>;
600 def : InstAlias<"blez $rs, $offset",
601                 (BGE      X0, GPR:$rs, simm13_lsb0:$offset)>;
602 def : InstAlias<"bgez $rs, $offset",
603                 (BGE GPR:$rs,      X0, simm13_lsb0:$offset)>;
604 def : InstAlias<"bltz $rs, $offset",
605                 (BLT GPR:$rs,      X0, simm13_lsb0:$offset)>;
606 def : InstAlias<"bgtz $rs, $offset",
607                 (BLT      X0, GPR:$rs, simm13_lsb0:$offset)>;
609 // Always output the canonical mnemonic for the pseudo branch instructions.
610 // The GNU tools emit the canonical mnemonic for the branch pseudo instructions
611 // as well (e.g. "bgt" will be recognised by the assembler but never printed by
612 // objdump). Match this behaviour by setting a zero weight.
613 def : InstAlias<"bgt $rs, $rt, $offset",
614                 (BLT  GPR:$rt, GPR:$rs, simm13_lsb0:$offset), 0>;
615 def : InstAlias<"ble $rs, $rt, $offset",
616                 (BGE  GPR:$rt, GPR:$rs, simm13_lsb0:$offset), 0>;
617 def : InstAlias<"bgtu $rs, $rt, $offset",
618                 (BLTU GPR:$rt, GPR:$rs, simm13_lsb0:$offset), 0>;
619 def : InstAlias<"bleu $rs, $rt, $offset",
620                 (BGEU GPR:$rt, GPR:$rs, simm13_lsb0:$offset), 0>;
622 def : InstAlias<"j $offset",   (JAL X0, simm21_lsb0_jal:$offset)>;
623 def : InstAlias<"jal $offset", (JAL X1, simm21_lsb0_jal:$offset)>;
625 // Non-zero offset aliases of "jalr" are the lowest weight, followed by the
626 // two-register form, then the one-register forms and finally "ret".
627 def : InstAlias<"jr $rs",                (JALR      X0, GPR:$rs, 0), 3>;
628 def : InstAlias<"jr ${offset}(${rs})",   (JALR      X0, GPR:$rs, simm12:$offset)>;
629 def : InstAlias<"jalr $rs",              (JALR      X1, GPR:$rs, 0), 3>;
630 def : InstAlias<"jalr ${offset}(${rs})", (JALR      X1, GPR:$rs, simm12:$offset)>;
631 def : InstAlias<"jalr $rd, $rs",         (JALR GPR:$rd, GPR:$rs, 0), 2>;
632 def : InstAlias<"ret",                   (JALR      X0,      X1, 0), 4>;
634 // Non-canonical forms for jump targets also accepted by the assembler.
635 def : InstAlias<"jr $rs, $offset",        (JALR      X0, GPR:$rs, simm12:$offset), 0>;
636 def : InstAlias<"jalr $rs, $offset",      (JALR      X1, GPR:$rs, simm12:$offset), 0>;
637 def : InstAlias<"jalr $rd, $rs, $offset", (JALR GPR:$rd, GPR:$rs, simm12:$offset), 0>;
639 // TODO call
640 // TODO tail
642 def : InstAlias<"fence", (FENCE 0xF, 0xF)>; // 0xF == iorw
644 def : InstAlias<"rdinstret $rd", (CSRRS GPR:$rd, INSTRET.Encoding, X0)>;
645 def : InstAlias<"rdcycle $rd",   (CSRRS GPR:$rd, CYCLE.Encoding, X0)>;
646 def : InstAlias<"rdtime $rd",    (CSRRS GPR:$rd, TIME.Encoding, X0)>;
648 let Predicates = [IsRV32] in {
649 def : InstAlias<"rdinstreth $rd", (CSRRS GPR:$rd, INSTRETH.Encoding, X0)>;
650 def : InstAlias<"rdcycleh $rd",   (CSRRS GPR:$rd, CYCLEH.Encoding, X0)>;
651 def : InstAlias<"rdtimeh $rd",    (CSRRS GPR:$rd, TIMEH.Encoding, X0)>;
652 } // Predicates = [IsRV32]
654 def : InstAlias<"csrr $rd, $csr", (CSRRS GPR:$rd, csr_sysreg:$csr,      X0)>;
655 def : InstAlias<"csrw $csr, $rs", (CSRRW      X0, csr_sysreg:$csr, GPR:$rs)>;
656 def : InstAlias<"csrs $csr, $rs", (CSRRS      X0, csr_sysreg:$csr, GPR:$rs)>;
657 def : InstAlias<"csrc $csr, $rs", (CSRRC      X0, csr_sysreg:$csr, GPR:$rs)>;
659 def : InstAlias<"csrwi $csr, $imm", (CSRRWI X0, csr_sysreg:$csr, uimm5:$imm)>;
660 def : InstAlias<"csrsi $csr, $imm", (CSRRSI X0, csr_sysreg:$csr, uimm5:$imm)>;
661 def : InstAlias<"csrci $csr, $imm", (CSRRCI X0, csr_sysreg:$csr, uimm5:$imm)>;
663 let EmitPriority = 0 in {
664 def : InstAlias<"csrw $csr, $imm", (CSRRWI X0, csr_sysreg:$csr, uimm5:$imm)>;
665 def : InstAlias<"csrs $csr, $imm", (CSRRSI X0, csr_sysreg:$csr, uimm5:$imm)>;
666 def : InstAlias<"csrc $csr, $imm", (CSRRCI X0, csr_sysreg:$csr, uimm5:$imm)>;
668 def : InstAlias<"csrrw $rd, $csr, $imm", (CSRRWI GPR:$rd, csr_sysreg:$csr, uimm5:$imm)>;
669 def : InstAlias<"csrrs $rd, $csr, $imm", (CSRRSI GPR:$rd, csr_sysreg:$csr, uimm5:$imm)>;
670 def : InstAlias<"csrrc $rd, $csr, $imm", (CSRRCI GPR:$rd, csr_sysreg:$csr, uimm5:$imm)>;
673 def : InstAlias<"sfence.vma",     (SFENCE_VMA      X0, X0)>;
674 def : InstAlias<"sfence.vma $rs", (SFENCE_VMA GPR:$rs, X0)>;
676 let EmitPriority = 0 in {
677 def : InstAlias<"lb $rd, (${rs1})",
678                 (LB  GPR:$rd, GPR:$rs1, 0)>;
679 def : InstAlias<"lh $rd, (${rs1})",
680                 (LH  GPR:$rd, GPR:$rs1, 0)>;
681 def : InstAlias<"lw $rd, (${rs1})",
682                 (LW  GPR:$rd, GPR:$rs1, 0)>;
683 def : InstAlias<"lbu $rd, (${rs1})",
684                 (LBU  GPR:$rd, GPR:$rs1, 0)>;
685 def : InstAlias<"lhu $rd, (${rs1})",
686                 (LHU  GPR:$rd, GPR:$rs1, 0)>;
688 def : InstAlias<"sb $rs2, (${rs1})",
689                 (SB  GPR:$rs2, GPR:$rs1, 0)>;
690 def : InstAlias<"sh $rs2, (${rs1})",
691                 (SH  GPR:$rs2, GPR:$rs1, 0)>;
692 def : InstAlias<"sw $rs2, (${rs1})",
693                 (SW  GPR:$rs2, GPR:$rs1, 0)>;
695 def : InstAlias<"add $rd, $rs1, $imm12",
696                 (ADDI  GPR:$rd, GPR:$rs1, simm12:$imm12)>;
697 def : InstAlias<"and $rd, $rs1, $imm12",
698                 (ANDI  GPR:$rd, GPR:$rs1, simm12:$imm12)>;
699 def : InstAlias<"xor $rd, $rs1, $imm12",
700                 (XORI  GPR:$rd, GPR:$rs1, simm12:$imm12)>;
701 def : InstAlias<"or $rd, $rs1, $imm12",
702                 (ORI  GPR:$rd, GPR:$rs1, simm12:$imm12)>;
703 def : InstAlias<"sll $rd, $rs1, $shamt",
704                 (SLLI  GPR:$rd, GPR:$rs1, uimmlog2xlen:$shamt)>;
705 def : InstAlias<"srl $rd, $rs1, $shamt",
706                 (SRLI  GPR:$rd, GPR:$rs1, uimmlog2xlen:$shamt)>;
707 def : InstAlias<"sra $rd, $rs1, $shamt",
708                 (SRAI  GPR:$rd, GPR:$rs1, uimmlog2xlen:$shamt)>;
709 let Predicates = [IsRV64] in {
710 def : InstAlias<"lwu $rd, (${rs1})",
711                 (LWU  GPR:$rd, GPR:$rs1, 0)>;
712 def : InstAlias<"ld $rd, (${rs1})",
713                 (LD  GPR:$rd, GPR:$rs1, 0)>;
714 def : InstAlias<"sd $rs2, (${rs1})",
715                 (SD  GPR:$rs2, GPR:$rs1, 0)>;
717 def : InstAlias<"addw $rd, $rs1, $imm12",
718                 (ADDIW  GPR:$rd, GPR:$rs1, simm12:$imm12)>;
719 def : InstAlias<"sllw $rd, $rs1, $shamt",
720                 (SLLIW  GPR:$rd, GPR:$rs1, uimm5:$shamt)>;
721 def : InstAlias<"srlw $rd, $rs1, $shamt",
722                 (SRLIW  GPR:$rd, GPR:$rs1, uimm5:$shamt)>;
723 def : InstAlias<"sraw $rd, $rs1, $shamt",
724                 (SRAIW  GPR:$rd, GPR:$rs1, uimm5:$shamt)>;
725 } // Predicates = [IsRV64]
726 def : InstAlias<"slt $rd, $rs1, $imm12",
727                 (SLTI  GPR:$rd, GPR:$rs1, simm12:$imm12)>;
728 def : InstAlias<"sltu $rd, $rs1, $imm12",
729                 (SLTIU  GPR:$rd, GPR:$rs1, simm12:$imm12)>;
732 def : MnemonicAlias<"move", "mv">;
734 // The SCALL and SBREAK instructions wererenamed to ECALL and EBREAK in
735 // version 2.1 of the user-level ISA. Like the GNU toolchain, we still accept
736 // the old name for backwards compatibility.
737 def : MnemonicAlias<"scall", "ecall">;
738 def : MnemonicAlias<"sbreak", "ebreak">;
740 //===----------------------------------------------------------------------===//
741 // Pseudo-instructions and codegen patterns
743 // Naming convention: For 'generic' pattern classes, we use the naming
744 // convention PatTy1Ty2. For pattern classes which offer a more complex
745 // expension, prefix the class name, e.g. BccPat.
746 //===----------------------------------------------------------------------===//
748 /// Generic pattern classes
750 class PatGprGpr<SDPatternOperator OpNode, RVInst Inst>
751     : Pat<(OpNode GPR:$rs1, GPR:$rs2), (Inst GPR:$rs1, GPR:$rs2)>;
752 class PatGprSimm12<SDPatternOperator OpNode, RVInstI Inst>
753     : Pat<(OpNode GPR:$rs1, simm12:$imm12), (Inst GPR:$rs1, simm12:$imm12)>;
754 class PatGprUimmLog2XLen<SDPatternOperator OpNode, RVInstIShift Inst>
755     : Pat<(OpNode GPR:$rs1, uimmlog2xlen:$shamt),
756           (Inst GPR:$rs1, uimmlog2xlen:$shamt)>;
758 /// Predicates
760 def IsOrAdd: PatFrag<(ops node:$A, node:$B), (or node:$A, node:$B), [{
761   return isOrEquivalentToAdd(N);
762 }]>;
763 def assertsexti32 : PatFrag<(ops node:$src), (assertsext node:$src), [{
764   return cast<VTSDNode>(N->getOperand(1))->getVT() == MVT::i32;
765 }]>;
766 def sexti32 : PatFrags<(ops node:$src),
767                        [(sext_inreg node:$src, i32),
768                         (assertsexti32 node:$src)]>;
769 def assertzexti32 : PatFrag<(ops node:$src), (assertzext node:$src), [{
770   return cast<VTSDNode>(N->getOperand(1))->getVT() == MVT::i32;
771 }]>;
772 def zexti32 : PatFrags<(ops node:$src),
773                        [(and node:$src, 0xffffffff),
774                         (assertzexti32 node:$src)]>;
776 /// Immediates
778 def : Pat<(simm12:$imm), (ADDI X0, simm12:$imm)>;
779 def : Pat<(simm32hi20:$imm), (LUI (HI20 imm:$imm))>;
780 def : Pat<(simm32:$imm), (ADDI (LUI (HI20 imm:$imm)), (LO12Sext imm:$imm))>,
781       Requires<[IsRV32]>;
783 /// Simple arithmetic operations
785 def : PatGprGpr<add, ADD>;
786 def : PatGprSimm12<add, ADDI>;
787 def : PatGprGpr<sub, SUB>;
788 def : PatGprGpr<or, OR>;
789 def : PatGprSimm12<or, ORI>;
790 def : PatGprGpr<and, AND>;
791 def : PatGprSimm12<and, ANDI>;
792 def : PatGprGpr<xor, XOR>;
793 def : PatGprSimm12<xor, XORI>;
794 def : PatGprUimmLog2XLen<shl, SLLI>;
795 def : PatGprUimmLog2XLen<srl, SRLI>;
796 def : PatGprUimmLog2XLen<sra, SRAI>;
798 // Match both a plain shift and one where the shift amount is masked (this is
799 // typically introduced when the legalizer promotes the shift amount and
800 // zero-extends it). For RISC-V, the mask is unnecessary as shifts in the base
801 // ISA only read the least significant 5 bits (RV32I) or 6 bits (RV64I).
802 class shiftop<SDPatternOperator operator>
803     : PatFrags<(ops node:$val, node:$count),
804                [(operator node:$val, node:$count),
805                 (operator node:$val, (and node:$count, immbottomxlenset))]>;
807 def : PatGprGpr<shiftop<shl>, SLL>;
808 def : PatGprGpr<shiftop<srl>, SRL>;
809 def : PatGprGpr<shiftop<sra>, SRA>;
811 // This is a special case of the ADD instruction used to facilitate the use of a
812 // fourth operand to emit a relocation on a symbol relating to this instruction.
813 // The relocation does not affect any bits of the instruction itself but is used
814 // as a hint to the linker.
815 let hasSideEffects = 0, mayLoad = 0, mayStore = 0, isCodeGenOnly = 0 in
816 def PseudoAddTPRel : Pseudo<(outs GPR:$rd),
817                             (ins GPR:$rs1, GPR:$rs2, tprel_add_symbol:$src), [],
818                             "add", "$rd, $rs1, $rs2, $src">;
820 /// FrameIndex calculations
822 def : Pat<(add (i32 AddrFI:$Rs), simm12:$imm12),
823           (ADDI (i32 AddrFI:$Rs), simm12:$imm12)>;
824 def : Pat<(IsOrAdd (i32 AddrFI:$Rs), simm12:$imm12),
825           (ADDI (i32 AddrFI:$Rs), simm12:$imm12)>;
827 /// Setcc
829 def : PatGprGpr<setlt, SLT>;
830 def : PatGprSimm12<setlt, SLTI>;
831 def : PatGprGpr<setult, SLTU>;
832 def : PatGprSimm12<setult, SLTIU>;
834 // Define pattern expansions for setcc operations that aren't directly
835 // handled by a RISC-V instruction.
836 def : Pat<(seteq GPR:$rs1, 0), (SLTIU GPR:$rs1, 1)>;
837 def : Pat<(seteq GPR:$rs1, GPR:$rs2), (SLTIU (XOR GPR:$rs1, GPR:$rs2), 1)>;
838 def : Pat<(seteq GPR:$rs1, simm12:$imm12),
839           (SLTIU (XORI GPR:$rs1, simm12:$imm12), 1)>;
840 def : Pat<(setne GPR:$rs1, 0), (SLTU X0, GPR:$rs1)>;
841 def : Pat<(setne GPR:$rs1, GPR:$rs2), (SLTU X0, (XOR GPR:$rs1, GPR:$rs2))>;
842 def : Pat<(setne GPR:$rs1, simm12:$imm12),
843           (SLTU X0, (XORI GPR:$rs1, simm12:$imm12))>;
844 def : Pat<(setugt GPR:$rs1, GPR:$rs2), (SLTU GPR:$rs2, GPR:$rs1)>;
845 def : Pat<(setuge GPR:$rs1, GPR:$rs2), (XORI (SLTU GPR:$rs1, GPR:$rs2), 1)>;
846 def : Pat<(setule GPR:$rs1, GPR:$rs2), (XORI (SLTU GPR:$rs2, GPR:$rs1), 1)>;
847 def : Pat<(setgt GPR:$rs1, GPR:$rs2), (SLT GPR:$rs2, GPR:$rs1)>;
848 def : Pat<(setge GPR:$rs1, GPR:$rs2), (XORI (SLT GPR:$rs1, GPR:$rs2), 1)>;
849 def : Pat<(setle GPR:$rs1, GPR:$rs2), (XORI (SLT GPR:$rs2, GPR:$rs1), 1)>;
851 let usesCustomInserter = 1 in
852 class SelectCC_rrirr<RegisterClass valty, RegisterClass cmpty>
853     : Pseudo<(outs valty:$dst),
854              (ins cmpty:$lhs, cmpty:$rhs, ixlenimm:$imm,
855               valty:$truev, valty:$falsev),
856              [(set valty:$dst, (riscv_selectcc cmpty:$lhs, cmpty:$rhs,
857               (XLenVT imm:$imm), valty:$truev, valty:$falsev))]>;
859 def Select_GPR_Using_CC_GPR : SelectCC_rrirr<GPR, GPR>;
861 /// Branches and jumps
863 // Match `(brcond (CondOp ..), ..)` and lower to the appropriate RISC-V branch
864 // instruction.
865 class BccPat<PatFrag CondOp, RVInstB Inst>
866     : Pat<(brcond (XLenVT (CondOp GPR:$rs1, GPR:$rs2)), bb:$imm12),
867           (Inst GPR:$rs1, GPR:$rs2, simm13_lsb0:$imm12)>;
869 def : BccPat<seteq, BEQ>;
870 def : BccPat<setne, BNE>;
871 def : BccPat<setlt, BLT>;
872 def : BccPat<setge, BGE>;
873 def : BccPat<setult, BLTU>;
874 def : BccPat<setuge, BGEU>;
876 class BccSwapPat<PatFrag CondOp, RVInst InstBcc>
877     : Pat<(brcond (XLenVT (CondOp GPR:$rs1, GPR:$rs2)), bb:$imm12),
878           (InstBcc GPR:$rs2, GPR:$rs1, bb:$imm12)>;
880 // Condition codes that don't have matching RISC-V branch instructions, but
881 // are trivially supported by swapping the two input operands
882 def : BccSwapPat<setgt, BLT>;
883 def : BccSwapPat<setle, BGE>;
884 def : BccSwapPat<setugt, BLTU>;
885 def : BccSwapPat<setule, BGEU>;
887 // An extra pattern is needed for a brcond without a setcc (i.e. where the
888 // condition was calculated elsewhere).
889 def : Pat<(brcond GPR:$cond, bb:$imm12), (BNE GPR:$cond, X0, bb:$imm12)>;
891 let isBarrier = 1, isBranch = 1, isTerminator = 1 in
892 def PseudoBR : Pseudo<(outs), (ins simm21_lsb0_jal:$imm20), [(br bb:$imm20)]>,
893                PseudoInstExpansion<(JAL X0, simm21_lsb0_jal:$imm20)>;
895 let isCall = 1, Defs=[X1] in
896 let isBarrier = 1, isBranch = 1, isIndirectBranch = 1, isTerminator = 1 in
897 def PseudoBRIND : Pseudo<(outs), (ins GPR:$rs1, simm12:$imm12), []>,
898                   PseudoInstExpansion<(JALR X0, GPR:$rs1, simm12:$imm12)>;
900 def : Pat<(brind GPR:$rs1), (PseudoBRIND GPR:$rs1, 0)>;
901 def : Pat<(brind (add GPR:$rs1, simm12:$imm12)),
902           (PseudoBRIND GPR:$rs1, simm12:$imm12)>;
904 // PsuedoCALLReg is a generic pseudo instruction for calls which will eventually
905 // expand to auipc and jalr while encoding, with any given register used as the
906 // destination.
907 // Define AsmString to print "call" when compile with -S flag.
908 // Define isCodeGenOnly = 0 to support parsing assembly "call" instruction.
909 let isCall = 1, isBarrier = 1, isCodeGenOnly = 0, hasSideEffects = 0,
910     mayStore = 0, mayLoad = 0 in
911 def PseudoCALLReg : Pseudo<(outs GPR:$rd), (ins call_symbol:$func), []> {
912   let AsmString = "call\t$rd, $func";
915 // PseudoCALL is a pseudo instruction which will eventually expand to auipc
916 // and jalr while encoding. This is desirable, as an auipc+jalr pair with
917 // R_RISCV_CALL and R_RISCV_RELAX relocations can be be relaxed by the linker
918 // if the offset fits in a signed 21-bit immediate.
919 // Define AsmString to print "call" when compile with -S flag.
920 // Define isCodeGenOnly = 0 to support parsing assembly "call" instruction.
921 let isCall = 1, Defs = [X1], isCodeGenOnly = 0 in
922 def PseudoCALL : Pseudo<(outs), (ins call_symbol:$func), []> {
923   let AsmString = "call\t$func";
926 def : Pat<(riscv_call tglobaladdr:$func), (PseudoCALL tglobaladdr:$func)>;
927 def : Pat<(riscv_call texternalsym:$func), (PseudoCALL texternalsym:$func)>;
929 def : Pat<(riscv_uret_flag), (URET X0, X0)>;
930 def : Pat<(riscv_sret_flag), (SRET X0, X0)>;
931 def : Pat<(riscv_mret_flag), (MRET X0, X0)>;
933 let isCall = 1, Defs = [X1] in
934 def PseudoCALLIndirect : Pseudo<(outs), (ins GPR:$rs1),
935                                 [(riscv_call GPR:$rs1)]>,
936                          PseudoInstExpansion<(JALR X1, GPR:$rs1, 0)>;
938 let isBarrier = 1, isReturn = 1, isTerminator = 1 in
939 def PseudoRET : Pseudo<(outs), (ins), [(riscv_ret_flag)]>,
940                 PseudoInstExpansion<(JALR X0, X1, 0)>;
942 // PseudoTAIL is a pseudo instruction similar to PseudoCALL and will eventually
943 // expand to auipc and jalr while encoding.
944 // Define AsmString to print "tail" when compile with -S flag.
945 let isCall = 1, isTerminator = 1, isReturn = 1, isBarrier = 1, Uses = [X2],
946     isCodeGenOnly = 0 in
947 def PseudoTAIL : Pseudo<(outs), (ins call_symbol:$dst), []> {
948   let AsmString = "tail\t$dst";
951 let isCall = 1, isTerminator = 1, isReturn = 1, isBarrier = 1, Uses = [X2] in
952 def PseudoTAILIndirect : Pseudo<(outs), (ins GPRTC:$rs1),
953                                 [(riscv_tail GPRTC:$rs1)]>,
954                          PseudoInstExpansion<(JALR X0, GPR:$rs1, 0)>;
956 def : Pat<(riscv_tail (iPTR tglobaladdr:$dst)),
957           (PseudoTAIL texternalsym:$dst)>;
958 def : Pat<(riscv_tail (iPTR texternalsym:$dst)),
959           (PseudoTAIL texternalsym:$dst)>;
961 let hasSideEffects = 0, mayLoad = 0, mayStore = 0, isCodeGenOnly = 0,
962     isAsmParserOnly = 1 in
963 def PseudoLLA : Pseudo<(outs GPR:$dst), (ins bare_symbol:$src), [],
964                        "lla", "$dst, $src">;
966 let hasSideEffects = 0, mayLoad = 1, mayStore = 0, isCodeGenOnly = 0,
967     isAsmParserOnly = 1 in
968 def PseudoLA : Pseudo<(outs GPR:$dst), (ins bare_symbol:$src), [],
969                       "la", "$dst, $src">;
971 let hasSideEffects = 0, mayLoad = 1, mayStore = 0, isCodeGenOnly = 0,
972     isAsmParserOnly = 1 in
973 def PseudoLA_TLS_IE : Pseudo<(outs GPR:$dst), (ins bare_symbol:$src), [],
974                              "la.tls.ie", "$dst, $src">;
976 let hasSideEffects = 0, mayLoad = 1, mayStore = 0, isCodeGenOnly = 0,
977     isAsmParserOnly = 1 in
978 def PseudoLA_TLS_GD : Pseudo<(outs GPR:$dst), (ins bare_symbol:$src), [],
979                              "la.tls.gd", "$dst, $src">;
981 /// Loads
983 multiclass LdPat<PatFrag LoadOp, RVInst Inst> {
984   def : Pat<(LoadOp GPR:$rs1), (Inst GPR:$rs1, 0)>;
985   def : Pat<(LoadOp AddrFI:$rs1), (Inst AddrFI:$rs1, 0)>;
986   def : Pat<(LoadOp (add GPR:$rs1, simm12:$imm12)),
987             (Inst GPR:$rs1, simm12:$imm12)>;
988   def : Pat<(LoadOp (add AddrFI:$rs1, simm12:$imm12)),
989             (Inst AddrFI:$rs1, simm12:$imm12)>;
990   def : Pat<(LoadOp (IsOrAdd AddrFI:$rs1, simm12:$imm12)),
991             (Inst AddrFI:$rs1, simm12:$imm12)>;
994 defm : LdPat<sextloadi8, LB>;
995 defm : LdPat<extloadi8, LB>;
996 defm : LdPat<sextloadi16, LH>;
997 defm : LdPat<extloadi16, LH>;
998 defm : LdPat<load, LW>, Requires<[IsRV32]>;
999 defm : LdPat<zextloadi8, LBU>;
1000 defm : LdPat<zextloadi16, LHU>;
1002 /// Stores
1004 multiclass StPat<PatFrag StoreOp, RVInst Inst, RegisterClass StTy> {
1005   def : Pat<(StoreOp StTy:$rs2, GPR:$rs1), (Inst StTy:$rs2, GPR:$rs1, 0)>;
1006   def : Pat<(StoreOp StTy:$rs2, AddrFI:$rs1), (Inst StTy:$rs2, AddrFI:$rs1, 0)>;
1007   def : Pat<(StoreOp StTy:$rs2, (add GPR:$rs1, simm12:$imm12)),
1008             (Inst StTy:$rs2, GPR:$rs1, simm12:$imm12)>;
1009   def : Pat<(StoreOp StTy:$rs2, (add AddrFI:$rs1, simm12:$imm12)),
1010             (Inst StTy:$rs2, AddrFI:$rs1, simm12:$imm12)>;
1011   def : Pat<(StoreOp StTy:$rs2, (IsOrAdd AddrFI:$rs1, simm12:$imm12)),
1012             (Inst StTy:$rs2, AddrFI:$rs1, simm12:$imm12)>;
1015 defm : StPat<truncstorei8, SB, GPR>;
1016 defm : StPat<truncstorei16, SH, GPR>;
1017 defm : StPat<store, SW, GPR>, Requires<[IsRV32]>;
1019 /// Fences
1021 // Refer to Table A.6 in the version 2.3 draft of the RISC-V Instruction Set
1022 // Manual: Volume I.
1024 // fence acquire -> fence r, rw
1025 def : Pat<(atomic_fence (XLenVT 4), (imm)), (FENCE 0b10, 0b11)>;
1026 // fence release -> fence rw, w
1027 def : Pat<(atomic_fence (XLenVT 5), (imm)), (FENCE 0b11, 0b1)>;
1028 // fence acq_rel -> fence.tso
1029 def : Pat<(atomic_fence (XLenVT 6), (imm)), (FENCE_TSO)>;
1030 // fence seq_cst -> fence rw, rw
1031 def : Pat<(atomic_fence (XLenVT 7), (imm)), (FENCE 0b11, 0b11)>;
1033 // Lowering for atomic load and store is defined in RISCVInstrInfoA.td.
1034 // Although these are lowered to fence+load/store instructions defined in the
1035 // base RV32I/RV64I ISA, this lowering is only used when the A extension is
1036 // present. This is necessary as it isn't valid to mix __atomic_* libcalls
1037 // with inline atomic operations for the same object.
1039 /// Other pseudo-instructions
1041 // Pessimistically assume the stack pointer will be clobbered
1042 let Defs = [X2], Uses = [X2] in {
1043 def ADJCALLSTACKDOWN : Pseudo<(outs), (ins i32imm:$amt1, i32imm:$amt2),
1044                               [(callseq_start timm:$amt1, timm:$amt2)]>;
1045 def ADJCALLSTACKUP   : Pseudo<(outs), (ins i32imm:$amt1, i32imm:$amt2),
1046                               [(callseq_end timm:$amt1, timm:$amt2)]>;
1047 } // Defs = [X2], Uses = [X2]
1049 /// RV64 patterns
1051 let Predicates = [IsRV64] in {
1053 /// sext and zext
1055 def : Pat<(sext_inreg GPR:$rs1, i32), (ADDIW GPR:$rs1, 0)>;
1056 def : Pat<(and GPR:$rs1, 0xffffffff), (SRLI (SLLI GPR:$rs1, 32), 32)>;
1058 /// ALU operations
1060 def : Pat<(sext_inreg (add GPR:$rs1, GPR:$rs2), i32),
1061           (ADDW GPR:$rs1, GPR:$rs2)>;
1062 def : Pat<(sext_inreg (add GPR:$rs1, simm12:$imm12), i32),
1063           (ADDIW GPR:$rs1, simm12:$imm12)>;
1064 def : Pat<(sext_inreg (sub GPR:$rs1, GPR:$rs2), i32),
1065           (SUBW GPR:$rs1, GPR:$rs2)>;
1066 def : Pat<(sext_inreg (shl GPR:$rs1, uimm5:$shamt), i32),
1067           (SLLIW GPR:$rs1, uimm5:$shamt)>;
1068 // (srl (zexti32 ...), uimm5:$shamt) is matched with custom code due to the
1069 // need to undo manipulation of the mask value performed by DAGCombine.
1070 def : Pat<(sra (sext_inreg GPR:$rs1, i32), uimm5:$shamt),
1071           (SRAIW GPR:$rs1, uimm5:$shamt)>;
1073 def : PatGprGpr<riscv_sllw, SLLW>;
1074 def : PatGprGpr<riscv_srlw, SRLW>;
1075 def : PatGprGpr<riscv_sraw, SRAW>;
1077 /// Loads
1079 defm : LdPat<sextloadi32, LW>;
1080 defm : LdPat<extloadi32, LW>;
1081 defm : LdPat<zextloadi32, LWU>;
1082 defm : LdPat<load, LD>;
1084 /// Stores
1086 defm : StPat<truncstorei32, SW, GPR>;
1087 defm : StPat<store, SD, GPR>;
1088 } // Predicates = [IsRV64]
1090 /// readcyclecounter
1091 // On RV64, we can directly read the 64-bit "cycle" CSR.
1092 let Predicates = [IsRV64] in
1093 def : Pat<(readcyclecounter), (CSRRS CYCLE.Encoding, X0)>;
1094 // On RV32, ReadCycleWide will be expanded to the suggested loop reading both
1095 // halves of the 64-bit "cycle" CSR.
1096 let Predicates = [IsRV32], usesCustomInserter = 1, hasSideEffects = 0,
1097 mayLoad = 0, mayStore = 0, hasNoSchedulingInfo = 1 in
1098 def ReadCycleWide : Pseudo<(outs GPR:$lo, GPR:$hi), (ins), [], "", "">;
1100 //===----------------------------------------------------------------------===//
1101 // Standard extensions
1102 //===----------------------------------------------------------------------===//
1104 include "RISCVInstrInfoM.td"
1105 include "RISCVInstrInfoA.td"
1106 include "RISCVInstrInfoF.td"
1107 include "RISCVInstrInfoD.td"
1108 include "RISCVInstrInfoC.td"