LLVM 20.0.0git
RISCVBaseInfo.h
Go to the documentation of this file.
1//===-- RISCVBaseInfo.h - Top level definitions for RISC-V MC ---*- 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//
9// This file contains small standalone enum definitions for the RISC-V target
10// useful for the compiler back-end and the MC libraries.
11//
12//===----------------------------------------------------------------------===//
13#ifndef LLVM_LIB_TARGET_RISCV_MCTARGETDESC_RISCVBASEINFO_H
14#define LLVM_LIB_TARGET_RISCV_MCTARGETDESC_RISCVBASEINFO_H
15
17#include "llvm/ADT/APFloat.h"
18#include "llvm/ADT/APInt.h"
19#include "llvm/ADT/StringRef.h"
21#include "llvm/MC/MCInstrDesc.h"
25
26namespace llvm {
27
28// RISCVII - This namespace holds all of the target specific flags that
29// instruction info tracks. All definitions must match RISCVInstrFormats.td.
30namespace RISCVII {
31enum {
55
58
64
67
68 // Force a tail agnostic policy even this instruction has a tied destination.
71
72 // Is this a _TIED vector pseudo instruction. For these instructions we
73 // shouldn't skip the tied operand when converting to MC instructions.
76
77 // Does this instruction have a SEW operand. It will be the last explicit
78 // operand unless there is a vector policy operand. Used by RVV Pseudos.
81
82 // Does this instruction have a VL operand. It will be the second to last
83 // explicit operand unless there is a vector policy operand. Used by RVV
84 // Pseudos.
87
88 // Does this instruction have a vector policy operand. It will be the last
89 // explicit operand. Used by RVV Pseudos.
92
93 // Is this instruction a vector widening reduction instruction. Used by RVV
94 // Pseudos.
97
98 // Does this instruction care about mask policy. If it is not, the mask policy
99 // could be either agnostic or undisturbed. For example, unmasked, store, and
100 // reduction operations result would not be affected by mask policy, so
101 // compiler has free to select either one.
104
105 // Indicates that the result can be considered sign extended from bit 31. Some
106 // instructions with this flag aren't W instructions, but are either sign
107 // extended from a smaller size, always outputs a small integer, or put zeros
108 // in bits 63:31. Used by the SExtWRemoval pass.
111
114
117
118 // Indicates whether these instructions can partially overlap between source
119 // registers and destination registers according to the vector spec.
120 // 0 -> not a vector pseudo
121 // 1 -> default value for vector pseudos. not widening or narrowing.
122 // 2 -> narrowing case
123 // 3 -> widening case
126
129
132
133 // Indicates the EEW of a vector instruction's destination operand.
134 // 0 -> 1
135 // 1 -> SEW
136 // 2 -> SEW * 2
137 // 3 -> SEW * 4
140};
141
142// Helper functions to read TSFlags.
143/// \returns the format of the instruction.
144static inline unsigned getFormat(uint64_t TSFlags) {
145 return (TSFlags & InstFormatMask) >> InstFormatShift;
146}
147/// \returns the LMUL for the instruction.
148static inline VLMUL getLMul(uint64_t TSFlags) {
149 return static_cast<VLMUL>((TSFlags & VLMulMask) >> VLMulShift);
150}
151/// \returns true if tail agnostic is enforced for the instruction.
152static inline bool doesForceTailAgnostic(uint64_t TSFlags) {
153 return TSFlags & ForceTailAgnosticMask;
154}
155/// \returns true if this a _TIED pseudo.
156static inline bool isTiedPseudo(uint64_t TSFlags) {
157 return TSFlags & IsTiedPseudoMask;
158}
159/// \returns true if there is a SEW operand for the instruction.
160static inline bool hasSEWOp(uint64_t TSFlags) {
161 return TSFlags & HasSEWOpMask;
162}
163/// \returns true if there is a VL operand for the instruction.
164static inline bool hasVLOp(uint64_t TSFlags) {
165 return TSFlags & HasVLOpMask;
166}
167/// \returns true if there is a vector policy operand for this instruction.
168static inline bool hasVecPolicyOp(uint64_t TSFlags) {
169 return TSFlags & HasVecPolicyOpMask;
170}
171/// \returns true if it is a vector widening reduction instruction.
172static inline bool isRVVWideningReduction(uint64_t TSFlags) {
173 return TSFlags & IsRVVWideningReductionMask;
174}
175/// \returns true if mask policy is valid for the instruction.
176static inline bool usesMaskPolicy(uint64_t TSFlags) {
177 return TSFlags & UsesMaskPolicyMask;
178}
179
180/// \returns true if there is a rounding mode operand for this instruction
181static inline bool hasRoundModeOp(uint64_t TSFlags) {
182 return TSFlags & HasRoundModeOpMask;
183}
184
185/// \returns true if this instruction uses vxrm
186static inline bool usesVXRM(uint64_t TSFlags) { return TSFlags & UsesVXRMMask; }
187
188/// \returns true if the elements in the body are affected by VL,
189/// e.g. vslide1down.vx/vredsum.vs/viota.m
190static inline bool elementsDependOnVL(uint64_t TSFlags) {
191 return TSFlags & ElementsDependOnVLMask;
192}
193
194/// \returns true if the elements in the body are affected by the mask,
195/// e.g. vredsum.vs/viota.m
196static inline bool elementsDependOnMask(uint64_t TSFlags) {
197 return TSFlags & ElementsDependOnMaskMask;
198}
199
200static inline unsigned getVLOpNum(const MCInstrDesc &Desc) {
201 const uint64_t TSFlags = Desc.TSFlags;
202 // This method is only called if we expect to have a VL operand, and all
203 // instructions with VL also have SEW.
204 assert(hasSEWOp(TSFlags) && hasVLOp(TSFlags));
205 unsigned Offset = 2;
206 if (hasVecPolicyOp(TSFlags))
207 Offset = 3;
208 return Desc.getNumOperands() - Offset;
209}
210
211static inline unsigned getTailExpandUseRegNo(const FeatureBitset &FeatureBits) {
212 // For Zicfilp, PseudoTAIL should be expanded to a software guarded branch.
213 // It means to use t2(x7) as rs1 of JALR to expand PseudoTAIL.
214 return FeatureBits[RISCV::FeatureStdExtZicfilp] ? RISCV::X7 : RISCV::X6;
215}
216
217static inline unsigned getSEWOpNum(const MCInstrDesc &Desc) {
218 const uint64_t TSFlags = Desc.TSFlags;
219 assert(hasSEWOp(TSFlags));
220 unsigned Offset = 1;
221 if (hasVecPolicyOp(TSFlags))
222 Offset = 2;
223 return Desc.getNumOperands() - Offset;
224}
225
226static inline unsigned getVecPolicyOpNum(const MCInstrDesc &Desc) {
227 assert(hasVecPolicyOp(Desc.TSFlags));
228 return Desc.getNumOperands() - 1;
229}
230
231/// \returns the index to the rounding mode immediate value if any, otherwise
232/// returns -1.
233static inline int getFRMOpNum(const MCInstrDesc &Desc) {
234 const uint64_t TSFlags = Desc.TSFlags;
235 if (!hasRoundModeOp(TSFlags) || usesVXRM(TSFlags))
236 return -1;
237
238 // The operand order
239 // --------------------------------------
240 // | n-1 (if any) | n-2 | n-3 | n-4 |
241 // | policy | sew | vl | frm |
242 // --------------------------------------
243 return getVLOpNum(Desc) - 1;
244}
245
246/// \returns the index to the rounding mode immediate value if any, otherwise
247/// returns -1.
248static inline int getVXRMOpNum(const MCInstrDesc &Desc) {
249 const uint64_t TSFlags = Desc.TSFlags;
250 if (!hasRoundModeOp(TSFlags) || !usesVXRM(TSFlags))
251 return -1;
252 // The operand order
253 // --------------------------------------
254 // | n-1 (if any) | n-2 | n-3 | n-4 |
255 // | policy | sew | vl | vxrm |
256 // --------------------------------------
257 return getVLOpNum(Desc) - 1;
258}
259
260// Is the first def operand tied to the first use operand. This is true for
261// vector pseudo instructions that have a merge operand for tail/mask
262// undisturbed. It's also true for vector FMA instructions where one of the
263// operands is also the destination register.
264static inline bool isFirstDefTiedToFirstUse(const MCInstrDesc &Desc) {
265 return Desc.getNumDefs() < Desc.getNumOperands() &&
266 Desc.getOperandConstraint(Desc.getNumDefs(), MCOI::TIED_TO) == 0;
267}
268
269// RISC-V Specific Machine Operand Flags
270enum {
273 MO_LO = 3,
274 MO_HI = 4,
287
288 // Used to differentiate between target-specific "direct" flags and "bitmask"
289 // flags. A machine operand can only have one "direct" flag, but can have
290 // multiple "bitmask" flags.
293} // namespace RISCVII
294
295namespace RISCVOp {
296enum OperandType : unsigned {
343 // Operand is a 3-bit rounding mode, '111' indicates FRM register.
344 // Represents 'frm' argument passing to floating-point operations.
346 // Operand is a 3-bit rounding mode where only RTZ is valid.
348 // Condition code used by select and short forward branch pseudos.
350 // Vector policy operand.
352 // Vector SEW operand. Stores in log2(SEW).
354 // Special SEW for mask only instructions. Always 0.
356 // Vector rounding mode for VXRM or FRM.
359 // Operand is either a register or uimm5, this is used by V extension pseudo
360 // instructions to represent a value that be passed as AVL to either vsetvli
361 // or vsetivli.
363};
364} // namespace RISCVOp
365
366// Describes the predecessor/successor bits used in the FENCE instruction.
367namespace RISCVFenceField {
369 I = 8,
370 O = 4,
371 R = 2,
372 W = 1
374}
375
376// Describes the supported floating point rounding mode encodings.
377namespace RISCVFPRndMode {
379 RNE = 0,
380 RTZ = 1,
381 RDN = 2,
382 RUP = 3,
383 RMM = 4,
384 DYN = 7,
385 Invalid
387
389 switch (RndMode) {
390 default:
391 llvm_unreachable("Unknown floating point rounding mode");
393 return "rne";
395 return "rtz";
397 return "rdn";
399 return "rup";
401 return "rmm";
403 return "dyn";
404 }
405}
406
416}
417
418inline static bool isValidRoundingMode(unsigned Mode) {
419 switch (Mode) {
420 default:
421 return false;
428 return true;
429 }
430}
431} // namespace RISCVFPRndMode
432
433namespace RISCVVXRndMode {
435 RNU = 0,
436 RNE = 1,
437 RDN = 2,
438 ROD = 3,
439};
440} // namespace RISCVVXRndMode
441
442//===----------------------------------------------------------------------===//
443// Floating-point Immediates
444//
445
446namespace RISCVLoadFPImm {
447float getFPImm(unsigned Imm);
448
449/// getLoadFPImm - Return a 5-bit binary encoding of the floating-point
450/// immediate value. If the value cannot be represented as a 5-bit binary
451/// encoding, then return -1.
452int getLoadFPImm(APFloat FPImm);
453} // namespace RISCVLoadFPImm
454
455namespace RISCVSysReg {
456struct SysReg {
457 const char Name[32];
458 unsigned Encoding;
459 // FIXME: add these additional fields when needed.
460 // Privilege Access: Read, Write, Read-Only.
461 // unsigned ReadWrite;
462 // Privilege Mode: User, System or Machine.
463 // unsigned Mode;
464 // Check field name.
465 // unsigned Extra;
466 // Register number without the privilege bits.
467 // unsigned Number;
472
473 bool haveRequiredFeatures(const FeatureBitset &ActiveFeatures) const {
474 // Not in 32-bit mode.
475 if (IsRV32Only && ActiveFeatures[RISCV::Feature64Bit])
476 return false;
477 // No required feature associated with the system register.
479 return true;
480 return (FeaturesRequired & ActiveFeatures) == FeaturesRequired;
481 }
482};
483
484#define GET_SysRegEncodings_DECL
485#define GET_SysRegsList_DECL
486#include "RISCVGenSearchableTables.inc"
487} // end namespace RISCVSysReg
488
489namespace RISCVInsnOpcode {
491 const char *Name;
492 unsigned Value;
493};
494
495#define GET_RISCVOpcodesList_DECL
496#include "RISCVGenSearchableTables.inc"
497} // end namespace RISCVInsnOpcode
498
499namespace RISCVABI {
500
501enum ABI {
512
513// Returns the target ABI, or else a StringError if the requested ABIName is
514// not supported for the given TT and FeatureBits combination.
515ABI computeTargetABI(const Triple &TT, const FeatureBitset &FeatureBits,
516 StringRef ABIName);
517
518ABI getTargetABI(StringRef ABIName);
519
520// Returns the register used to hold the stack pointer after realignment.
522
523// Returns the register holding shadow call stack pointer.
525
526} // namespace RISCVABI
527
528namespace RISCVFeatures {
529
530// Validates if the given combination of features are valid for the target
531// triple. Exits with report_fatal_error if not.
532void validate(const Triple &TT, const FeatureBitset &FeatureBits);
533
535parseFeatureBits(bool IsRV64, const FeatureBitset &FeatureBits);
536
537} // namespace RISCVFeatures
538
539namespace RISCVRVC {
540bool compress(MCInst &OutInst, const MCInst &MI, const MCSubtargetInfo &STI);
541bool uncompress(MCInst &OutInst, const MCInst &MI, const MCSubtargetInfo &STI);
542} // namespace RISCVRVC
543
544namespace RISCVZC {
546 RA = 4,
557 // note - to include s10, s11 must also be included
560};
561
562inline unsigned encodeRlist(MCRegister EndReg, bool IsRV32E = false) {
563 assert((!IsRV32E || EndReg <= RISCV::X9) && "Invalid Rlist for RV32E");
564 switch (EndReg) {
565 case RISCV::X1:
566 return RLISTENCODE::RA;
567 case RISCV::X8:
568 return RLISTENCODE::RA_S0;
569 case RISCV::X9:
571 case RISCV::X18:
573 case RISCV::X19:
575 case RISCV::X20:
577 case RISCV::X21:
579 case RISCV::X22:
581 case RISCV::X23:
583 case RISCV::X24:
585 case RISCV::X25:
587 case RISCV::X26:
589 case RISCV::X27:
591 default:
592 llvm_unreachable("Undefined input.");
593 }
594}
595
596inline static unsigned getStackAdjBase(unsigned RlistVal, bool IsRV64) {
598 "{ra, s0-s10} is not supported, s11 must be included.");
599 if (!IsRV64) {
600 switch (RlistVal) {
601 case RLISTENCODE::RA:
605 return 16;
610 return 32;
614 return 48;
616 return 64;
617 }
618 } else {
619 switch (RlistVal) {
620 case RLISTENCODE::RA:
622 return 16;
625 return 32;
628 return 48;
631 return 64;
634 return 80;
636 return 96;
638 return 112;
639 }
640 }
641 llvm_unreachable("Unexpected RlistVal");
642}
643
644inline static bool getSpimm(unsigned RlistVal, unsigned &SpimmVal,
645 int64_t StackAdjustment, bool IsRV64) {
646 if (RlistVal == RLISTENCODE::INVALID_RLIST)
647 return false;
648 unsigned StackAdjBase = getStackAdjBase(RlistVal, IsRV64);
649 StackAdjustment -= StackAdjBase;
650 if (StackAdjustment % 16 != 0)
651 return false;
652 SpimmVal = StackAdjustment / 16;
653 if (SpimmVal > 3)
654 return false;
655 return true;
656}
657
658void printRlist(unsigned SlistEncode, raw_ostream &OS);
659} // namespace RISCVZC
660
661} // namespace llvm
662
663#endif
This file declares a class to represent arbitrary precision floating point values and provide a varie...
This file implements a class to represent arbitrary precision integral constant values and operations...
IRTranslator LLVM IR MI
static cl::opt< RegAllocEvictionAdvisorAnalysis::AdvisorMode > Mode("regalloc-enable-advisor", cl::Hidden, cl::init(RegAllocEvictionAdvisorAnalysis::AdvisorMode::Default), cl::desc("Enable regalloc advisor mode"), cl::values(clEnumValN(RegAllocEvictionAdvisorAnalysis::AdvisorMode::Default, "default", "Default"), clEnumValN(RegAllocEvictionAdvisorAnalysis::AdvisorMode::Release, "release", "precompiled"), clEnumValN(RegAllocEvictionAdvisorAnalysis::AdvisorMode::Development, "development", "for training")))
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
raw_pwrite_stream & OS
This file implements the StringSwitch template, which mimics a switch() statement whose cases are str...
Tagged union holding either a T or a Error.
Definition: Error.h:481
Container class for subtarget features.
Instances of this class represent a single low-level machine instruction.
Definition: MCInst.h:185
Describe properties that are true of each instruction in the target description file.
Definition: MCInstrDesc.h:198
Wrapper class representing physical registers. Should be passed by value.
Definition: MCRegister.h:33
Generic base class for all target subtargets.
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:51
A switch()-like statement whose cases are string literals.
Definition: StringSwitch.h:44
StringSwitch & Case(StringLiteral S, T Value)
Definition: StringSwitch.h:69
R Default(T Value)
Definition: StringSwitch.h:182
Triple - Helper class for working with autoconf configuration names.
Definition: Triple.h:44
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:52
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
@ OPERAND_FIRST_TARGET
Definition: MCInstrDesc.h:78
ABI getTargetABI(StringRef ABIName)
ABI computeTargetABI(const Triple &TT, const FeatureBitset &FeatureBits, StringRef ABIName)
MCRegister getBPReg()
MCRegister getSCSPReg()
static bool isValidRoundingMode(unsigned Mode)
static RoundingMode stringToRoundingMode(StringRef Str)
static StringRef roundingModeToString(RoundingMode RndMode)
void validate(const Triple &TT, const FeatureBitset &FeatureBits)
llvm::Expected< std::unique_ptr< RISCVISAInfo > > parseFeatureBits(bool IsRV64, const FeatureBitset &FeatureBits)
static unsigned getVecPolicyOpNum(const MCInstrDesc &Desc)
static bool usesMaskPolicy(uint64_t TSFlags)
static bool hasRoundModeOp(uint64_t TSFlags)
static bool isTiedPseudo(uint64_t TSFlags)
static unsigned getVLOpNum(const MCInstrDesc &Desc)
static bool doesForceTailAgnostic(uint64_t TSFlags)
static unsigned getFormat(uint64_t TSFlags)
static VLMUL getLMul(uint64_t TSFlags)
static bool hasVLOp(uint64_t TSFlags)
static bool elementsDependOnMask(uint64_t TSFlags)
@ TargetOverlapConstraintTypeMask
@ TargetOverlapConstraintTypeShift
@ IsRVVWideningReductionShift
Definition: RISCVBaseInfo.h:95
@ IsRVVWideningReductionMask
Definition: RISCVBaseInfo.h:96
static int getFRMOpNum(const MCInstrDesc &Desc)
static int getVXRMOpNum(const MCInstrDesc &Desc)
static bool hasVecPolicyOp(uint64_t TSFlags)
static bool usesVXRM(uint64_t TSFlags)
static unsigned getTailExpandUseRegNo(const FeatureBitset &FeatureBits)
static bool isRVVWideningReduction(uint64_t TSFlags)
static unsigned getSEWOpNum(const MCInstrDesc &Desc)
static bool elementsDependOnVL(uint64_t TSFlags)
static bool hasSEWOp(uint64_t TSFlags)
static bool isFirstDefTiedToFirstUse(const MCInstrDesc &Desc)
int getLoadFPImm(APFloat FPImm)
getLoadFPImm - Return a 5-bit binary encoding of the floating-point immediate value.
float getFPImm(unsigned Imm)
@ OPERAND_UIMMLOG2XLEN_NONZERO
@ OPERAND_UIMM10_LSB00_NONZERO
@ OPERAND_SIMM10_LSB0000_NONZERO
bool uncompress(MCInst &OutInst, const MCInst &MI, const MCSubtargetInfo &STI)
bool compress(MCInst &OutInst, const MCInst &MI, const MCSubtargetInfo &STI)
static unsigned getStackAdjBase(unsigned RlistVal, bool IsRV64)
unsigned encodeRlist(MCRegister EndReg, bool IsRV32E=false)
void printRlist(unsigned SlistEncode, raw_ostream &OS)
static bool getSpimm(unsigned RlistVal, unsigned &SpimmVal, int64_t StackAdjustment, bool IsRV64)
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
@ Offset
Definition: DWP.cpp:480
Description of the encoding of one expression Op.
FeatureBitset FeaturesRequired
bool haveRequiredFeatures(const FeatureBitset &ActiveFeatures) const