[RISCV] Add CSRs defined in the recently ratified Smstateen extension

[asb]

Summary

The "RISC-V State Enable Extension" was ratified at the end of at the
end of last year though hasn't yet been integrated in the main
specification documents (see
https://wiki.riscv.org/display/TECH/Recently+Ratified+Extensions).

This commit adds the CSRs defined by this extension in
https://github.com/riscv/riscv-state-enable/releases/download/v0.6.3/Smstateen.pdf.

Note I've defined the CSRs together in a single foreach loop. This is easiest to read when compared to the Smstateen spec. If/when these CSRs are merged into the tables in the privileged spec, we may want to loop back to match however they are grouped there.

[craig.topper]

llvm/lib/Target/RISCV/RISCVSystemOperands.td

365

Is mstateen here twice?

[asb]

Address review comment.

[craig.topper]

LGTM

llvm/lib/Target/RISCV/RISCVSystemOperands.td

 //===----------------------------------------------------------------------===//
 def : SysReg<"vstart", 0x008>;
 def : SysReg<"vxsat", 0x009>;
 def : SysReg<"vxrm", 0x00A>;
 def : SysReg<"vcsr", 0x00F>;
 def : SysReg<"vl", 0xC20>;
 def : SysReg<"vtype", 0xC21>;
 def SysRegVLENB: SysReg<"vlenb", 0xC22>;
+
+//===----------------------------------------------------------------------===//
+// State Enable Extension (Smstateen)
+//===----------------------------------------------------------------------===//
+
+// sstateen0-sstateen3 at 0x10C-0x10F, mstateen0-mstateen3 at 0x30C-0x30F,
+// mstateen0h-mstateen3h at 0x31C-0x31F, hstateen0-hstateen3 at 0x60C-0x60F,
+// and hstateen0h-hstateen3h at 0x61C-0x61F.
+foreach i = 0...3 in {
+  def : SysReg<"sstateen"#i, !add(0x10C, i)>;
+  def : SysReg<"mstateen"#i, !add(0x30C, i)>;
+  let isRV32Only = 1 in
+  def : SysReg<"mstateen"#i#"h", !add(0x31C, i)>;
+  def : SysReg<"hstateen"#i, !add(0x60C, i)>;
+  let isRV32Only = 1 in
+  def : SysReg<"hstateen"#i#"h", !add(0x61C, i)>;
+}

llvm/test/MC/RISCV/hypervisor-csr-names.s

 # uimm12
 # CHECK-INST: csrrs t2, vsatp, zero
 # CHECK-ENC: encoding: [0xf3,0x23,0x00,0x28]
 # CHECK-INST-ALIAS: csrr t2, vsatp
 # name
 csrrs t1, vsatp, zero
 # uimm12
 csrrs t2, 0x280, zero
+
+#########################################
+# State Enable Extension (Smstateen)
+#########################################
+
+# hstateen0
+# name
+# CHECK-INST: csrrs t1, hstateen0, zero
+# CHECK-ENC: encoding: [0x73,0x23,0xc0,0x60]
+# CHECK-INST-ALIAS: csrr t1, hstateen0
+# uimm12
+# CHECK-INST: csrrs t2, hstateen0, zero
+# CHECK-ENC: encoding: [0xf3,0x23,0xc0,0x60]
+# CHECK-INST-ALIAS: csrr t2, hstateen0
+# name
+csrrs t1, hstateen0, zero
+# uimm12
+csrrs t2, 0x60C, zero
+
+# hstateen1
+# name
+# CHECK-INST: csrrs t1, hstateen1, zero
+# CHECK-ENC: encoding: [0x73,0x23,0xd0,0x60]
+# CHECK-INST-ALIAS: csrr t1, hstateen1
+# uimm12
+# CHECK-INST: csrrs t2, hstateen1, zero
+# CHECK-ENC: encoding: [0xf3,0x23,0xd0,0x60]
+# CHECK-INST-ALIAS: csrr t2, hstateen1
+# name
+csrrs t1, hstateen1, zero
+# uimm12
+csrrs t2, 0x60D, zero
+
+# hstateen2
+# name
+# CHECK-INST: csrrs t1, hstateen2, zero
+# CHECK-ENC: encoding: [0x73,0x23,0xe0,0x60]
+# CHECK-INST-ALIAS: csrr t1, hstateen2
+# uimm12
+# CHECK-INST: csrrs t2, hstateen2, zero
+# CHECK-ENC: encoding: [0xf3,0x23,0xe0,0x60]
+# CHECK-INST-ALIAS: csrr t2, hstateen2
+# name
+csrrs t1, hstateen2, zero
+# uimm12
+csrrs t2, 0x60E, zero
+
+# hstateen3
+# name
+# CHECK-INST: csrrs t1, hstateen3, zero
+# CHECK-ENC: encoding: [0x73,0x23,0xf0,0x60]
+# CHECK-INST-ALIAS: csrr t1, hstateen3
+# uimm12
+# CHECK-INST: csrrs t2, hstateen3, zero
+# CHECK-ENC: encoding: [0xf3,0x23,0xf0,0x60]
+# CHECK-INST-ALIAS: csrr t2, hstateen3
+# name
+csrrs t1, hstateen3, zero
+# uimm12
+csrrs t2, 0x60F, zero

llvm/test/MC/RISCV/machine-csr-names.s

 # uimm12
 # CHECK-INST: csrrs t2, mhpmevent31, zero
 # CHECK-ENC:  encoding: [0xf3,0x23,0xf0,0x33]
 # CHECK-INST-ALIAS: csrr t2, mhpmevent31
 # name
 csrrs t1, mhpmevent31, zero
 # uimm12
 csrrs t2, 0x33F, zero
+
+#########################################
+# State Enable Extension (Smstateen)
+#########################################
+
+# mstateen0
+# name
+# CHECK-INST: csrrs t1, mstateen0, zero
+# CHECK-ENC: encoding: [0x73,0x23,0xc0,0x30]
+# CHECK-INST-ALIAS: csrr t1, mstateen0
+# uimm12
+# CHECK-INST: csrrs t2, mstateen0, zero
+# CHECK-ENC: encoding: [0xf3,0x23,0xc0,0x30]
+# CHECK-INST-ALIAS: csrr t2, mstateen0
+# name
+csrrs t1, mstateen0, zero
+# uimm12
+csrrs t2, 0x30C, zero
+
+# mstateen1
+# name
+# CHECK-INST: csrrs t1, mstateen1, zero
+# CHECK-ENC: encoding: [0x73,0x23,0xd0,0x30]
+# CHECK-INST-ALIAS: csrr t1, mstateen1
+# uimm12
+# CHECK-INST: csrrs t2, mstateen1, zero
+# CHECK-ENC: encoding: [0xf3,0x23,0xd0,0x30]
+# CHECK-INST-ALIAS: csrr t2, mstateen1
+# name
+csrrs t1, mstateen1, zero
+# uimm12
+csrrs t2, 0x30D, zero
+
+# mstateen2
+# name
+# CHECK-INST: csrrs t1, mstateen2, zero
+# CHECK-ENC: encoding: [0x73,0x23,0xe0,0x30]
+# CHECK-INST-ALIAS: csrr t1, mstateen2
+# uimm12
+# CHECK-INST: csrrs t2, mstateen2, zero
+# CHECK-ENC: encoding: [0xf3,0x23,0xe0,0x30]
+# CHECK-INST-ALIAS: csrr t2, mstateen2
+# name
+csrrs t1, mstateen2, zero
+# uimm12
+csrrs t2, 0x30E, zero
+
+# mstateen3
+# name
+# CHECK-INST: csrrs t1, mstateen3, zero
+# CHECK-ENC: encoding: [0x73,0x23,0xf0,0x30]
+# CHECK-INST-ALIAS: csrr t1, mstateen3
+# uimm12
+# CHECK-INST: csrrs t2, mstateen3, zero
+# CHECK-ENC: encoding: [0xf3,0x23,0xf0,0x30]
+# CHECK-INST-ALIAS: csrr t2, mstateen3
+# name
+csrrs t1, mstateen3, zero
+# uimm12
+csrrs t2, 0x30F, zero

llvm/test/MC/RISCV/rv32-hypervisor-csr-names.s

 # uimm12
 # CHECK-INST: csrrs t2, htimedeltah, zero
 # CHECK-ENC: encoding: [0xf3,0x23,0x50,0x61]
 # CHECK-INST-ALIAS: csrr t2, htimedeltah
 # name
 csrrs t1, htimedeltah, zero
 # uimm12
 csrrs t2, 0x615, zero
+
+#########################################
+# State Enable Extension (Smstateen)
+#########################################
+
+# hstateen0h
+# name
+# CHECK-INST: csrrs t1, hstateen0h, zero
+# CHECK-ENC: encoding: [0x73,0x23,0xc0,0x61]
+# CHECK-INST-ALIAS: csrr t1, hstateen0h
+# uimm12
+# CHECK-INST: csrrs t2, hstateen0h, zero
+# CHECK-ENC: encoding: [0xf3,0x23,0xc0,0x61]
+# CHECK-INST-ALIAS: csrr t2, hstateen0h
+# name
+csrrs t1, hstateen0h, zero
+# uimm12
+csrrs t2, 0x61C, zero
+
+# hstateen1h
+# name
+# CHECK-INST: csrrs t1, hstateen1h, zero
+# CHECK-ENC: encoding: [0x73,0x23,0xd0,0x61]
+# CHECK-INST-ALIAS: csrr t1, hstateen1h
+# uimm12
+# CHECK-INST: csrrs t2, hstateen1h, zero
+# CHECK-ENC: encoding: [0xf3,0x23,0xd0,0x61]
+# CHECK-INST-ALIAS: csrr t2, hstateen1h
+# name
+csrrs t1, hstateen1h, zero
+# uimm12
+csrrs t2, 0x61D, zero
+
+# hstateen2h
+# name
+# CHECK-INST: csrrs t1, hstateen2h, zero
+# CHECK-ENC: encoding: [0x73,0x23,0xe0,0x61]
+# CHECK-INST-ALIAS: csrr t1, hstateen2h
+# uimm12
+# CHECK-INST: csrrs t2, hstateen2h, zero
+# CHECK-ENC: encoding: [0xf3,0x23,0xe0,0x61]
+# CHECK-INST-ALIAS: csrr t2, hstateen2h
+# name
+csrrs t1, hstateen2h, zero
+# uimm12
+csrrs t2, 0x61E, zero
+
+# hstateen3h
+# name
+# CHECK-INST: csrrs t1, hstateen3h, zero
+# CHECK-ENC: encoding: [0x73,0x23,0xf0,0x61]
+# CHECK-INST-ALIAS: csrr t1, hstateen3h
+# uimm12
+# CHECK-INST: csrrs t2, hstateen3h, zero
+# CHECK-ENC: encoding: [0xf3,0x23,0xf0,0x61]
+# CHECK-INST-ALIAS: csrr t2, hstateen3h
+# name
+csrrs t1, hstateen3h, zero
+# uimm12
+csrrs t2, 0x61F, zero

llvm/test/MC/RISCV/rv32-machine-csr-names.s

 # uimm12
 # CHECK-INST: csrrs t2, mhpmevent31h, zero
 # CHECK-ENC:  encoding: [0xf3,0x23,0xf0,0x73]
 # CHECK-INST-ALIAS: csrr t2, mhpmevent31h
 # name
 csrrs t1, mhpmevent31h, zero
 # uimm12
 csrrs t2, 0x73F, zero
+
+#########################################
+# State Enable Extension (Smstateen)
+#########################################
+
+# mstateen0h
+# name
+# CHECK-INST: csrrs t1, mstateen0h, zero
+# CHECK-ENC: encoding: [0x73,0x23,0xc0,0x31]
+# CHECK-INST-ALIAS: csrr t1, mstateen0h
+# uimm12
+# CHECK-INST: csrrs t2, mstateen0h, zero
+# CHECK-ENC: encoding: [0xf3,0x23,0xc0,0x31]
+# CHECK-INST-ALIAS: csrr t2, mstateen0h
+# name
+csrrs t1, mstateen0h, zero
+# uimm12
+csrrs t2, 0x31C, zero
+
+# mstateen1h
+# name
+# CHECK-INST: csrrs t1, mstateen1h, zero
+# CHECK-ENC: encoding: [0x73,0x23,0xd0,0x31]
+# CHECK-INST-ALIAS: csrr t1, mstateen1h
+# uimm12
+# CHECK-INST: csrrs t2, mstateen1h, zero
+# CHECK-ENC: encoding: [0xf3,0x23,0xd0,0x31]
+# CHECK-INST-ALIAS: csrr t2, mstateen1h
+# name
+csrrs t1, mstateen1h, zero
+# uimm12
+csrrs t2, 0x31D, zero
+
+# mstateen2h
+# name
+# CHECK-INST: csrrs t1, mstateen2h, zero
+# CHECK-ENC: encoding: [0x73,0x23,0xe0,0x31]
+# CHECK-INST-ALIAS: csrr t1, mstateen2h
+# uimm12
+# CHECK-INST: csrrs t2, mstateen2h, zero
+# CHECK-ENC: encoding: [0xf3,0x23,0xe0,0x31]
+# CHECK-INST-ALIAS: csrr t2, mstateen2h
+# name
+csrrs t1, mstateen2h, zero
+# uimm12
+csrrs t2, 0x31E, zero
+
+# mstateen3h
+# name
+# CHECK-INST: csrrs t1, mstateen3h, zero
+# CHECK-ENC: encoding: [0x73,0x23,0xf0,0x31]
+# CHECK-INST-ALIAS: csrr t1, mstateen3h
+# uimm12
+# CHECK-INST: csrrs t2, mstateen3h, zero
+# CHECK-ENC: encoding: [0xf3,0x23,0xf0,0x31]
+# CHECK-INST-ALIAS: csrr t2, mstateen3h
+# name
+csrrs t1, mstateen3h, zero
+# uimm12
+csrrs t2, 0x31F, zero

llvm/test/MC/RISCV/rv32-only-csr-names.s

 csrrs t1, mhpmevent24h, zero # CHECK-NEED-RV32: :[[@LINE]]:11: error: system register use requires an option to be enabled
 csrrs t1, mhpmevent25h, zero # CHECK-NEED-RV32: :[[@LINE]]:11: error: system register use requires an option to be enabled
 csrrs t1, mhpmevent26h, zero # CHECK-NEED-RV32: :[[@LINE]]:11: error: system register use requires an option to be enabled
 csrrs t1, mhpmevent27h, zero # CHECK-NEED-RV32: :[[@LINE]]:11: error: system register use requires an option to be enabled
 csrrs t1, mhpmevent28h, zero # CHECK-NEED-RV32: :[[@LINE]]:11: error: system register use requires an option to be enabled
 csrrs t1, mhpmevent29h, zero # CHECK-NEED-RV32: :[[@LINE]]:11: error: system register use requires an option to be enabled
 csrrs t1, mhpmevent30h, zero # CHECK-NEED-RV32: :[[@LINE]]:11: error: system register use requires an option to be enabled
 csrrs t1, mhpmevent31h, zero # CHECK-NEED-RV32: :[[@LINE]]:11: error: system register use requires an option to be enabled
+
+csrrs t1, mstateen0h, zero # CHECK-NEED-RV32: :[[@LINE]]:11: error: system register use requires an option to be enabled
+csrrs t1, mstateen1h, zero # CHECK-NEED-RV32: :[[@LINE]]:11: error: system register use requires an option to be enabled
+csrrs t1, mstateen3h, zero # CHECK-NEED-RV32: :[[@LINE]]:11: error: system register use requires an option to be enabled
+csrrs t1, mstateen3h, zero # CHECK-NEED-RV32: :[[@LINE]]:11: error: system register use requires an option to be enabled
+
+csrrs t1, hstateen0h, zero # CHECK-NEED-RV32: :[[@LINE]]:11: error: system register use requires an option to be enabled
+csrrs t1, hstateen1h, zero # CHECK-NEED-RV32: :[[@LINE]]:11: error: system register use requires an option to be enabled
+csrrs t1, hstateen3h, zero # CHECK-NEED-RV32: :[[@LINE]]:11: error: system register use requires an option to be enabled
+csrrs t1, hstateen3h, zero # CHECK-NEED-RV32: :[[@LINE]]:11: error: system register use requires an option to be enabled

llvm/test/MC/RISCV/supervisor-csr-names.s

 # uimm12
 # CHECK-INST: csrrs t2, scountovf, zero
 # CHECK-ENC: encoding: [0xf3,0x23,0x00,0xda]
 # CHECK-INST-ALIAS: csrr t2, scountovf
 # name
 csrrs t1, scountovf, zero
 # uimm12
 csrrs t2, 0xDA0, zero
+
+#########################################
+# State Enable Extension (Smstateen)
+#########################################
+
+# sstateen0
+# name
+# CHECK-INST: csrrs t1, sstateen0, zero
+# CHECK-ENC: encoding: [0x73,0x23,0xc0,0x10]
+# CHECK-INST-ALIAS: csrr t1, sstateen0
+# uimm12
+# CHECK-INST: csrrs t2, sstateen0, zero
+# CHECK-ENC: encoding: [0xf3,0x23,0xc0,0x10]
+# CHECK-INST-ALIAS: csrr t2, sstateen0
+# name
+csrrs t1, sstateen0, zero
+# uimm12
+csrrs t2, 0x10C, zero
+
+# sstateen1
+# name
+# CHECK-INST: csrrs t1, sstateen1, zero
+# CHECK-ENC: encoding: [0x73,0x23,0xd0,0x10]
+# CHECK-INST-ALIAS: csrr t1, sstateen1
+# uimm12
+# CHECK-INST: csrrs t2, sstateen1, zero
+# CHECK-ENC: encoding: [0xf3,0x23,0xd0,0x10]
+# CHECK-INST-ALIAS: csrr t2, sstateen1
+# name
+csrrs t1, sstateen1, zero
+# uimm12
+csrrs t2, 0x10D, zero
+
+# sstateen2
+# name
+# CHECK-INST: csrrs t1, sstateen2, zero
+# CHECK-ENC: encoding: [0x73,0x23,0xe0,0x10]
+# CHECK-INST-ALIAS: csrr t1, sstateen2
+# uimm12
+# CHECK-INST: csrrs t2, sstateen2, zero
+# CHECK-ENC: encoding: [0xf3,0x23,0xe0,0x10]
+# CHECK-INST-ALIAS: csrr t2, sstateen2
+# name
+csrrs t1, sstateen2, zero
+# uimm12
+csrrs t2, 0x10E, zero
+
+# sstateen3
+# name
+# CHECK-INST: csrrs t1, sstateen3, zero
+# CHECK-ENC: encoding: [0x73,0x23,0xf0,0x10]
+# CHECK-INST-ALIAS: csrr t1, sstateen3
+# uimm12
+# CHECK-INST: csrrs t2, sstateen3, zero
+# CHECK-ENC: encoding: [0xf3,0x23,0xf0,0x10]
+# CHECK-INST-ALIAS: csrr t2, sstateen3
+# name
+csrrs t1, sstateen3, zero
+# uimm12
+csrrs t2, 0x10F, zero