1 /* riscv.h. RISC-V opcode list for GDB, the GNU debugger.
2 Copyright (C) 2011-2019 Free Software Foundation, Inc.
3 Contributed by Andrew Waterman
5 This file is part of GDB, GAS, and the GNU binutils.
7 GDB, GAS, and the GNU binutils are free software; you can redistribute
8 them and/or modify them under the terms of the GNU General Public
9 License as published by the Free Software Foundation; either version
10 3, or (at your option) any later version.
12 GDB, GAS, and the GNU binutils are distributed in the hope that they
13 will be useful, but WITHOUT ANY WARRANTY; without even the implied
14 warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
15 the GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; see the file COPYING3. If not,
19 see <http://www.gnu.org/licenses/>. */
24 #include "riscv-opc.h"
28 typedef uint64_t insn_t
;
30 static inline unsigned int riscv_insn_length (insn_t insn
)
32 if ((insn
& 0x3) != 0x3) /* RVC. */
34 if ((insn
& 0x1f) != 0x1f) /* Base ISA and extensions in 32-bit space. */
36 if ((insn
& 0x3f) == 0x1f) /* 48-bit extensions. */
38 if ((insn
& 0x7f) == 0x3f) /* 64-bit extensions. */
40 /* Longer instructions not supported at the moment. */
44 static const char * const riscv_rm
[8] =
46 "rne", "rtz", "rdn", "rup", "rmm", 0, 0, "dyn"
49 static const char * const riscv_pred_succ
[16] =
51 0, "w", "r", "rw", "o", "ow", "or", "orw",
52 "i", "iw", "ir", "irw", "io", "iow", "ior", "iorw"
55 #define RVC_JUMP_BITS 11
56 #define RVC_JUMP_REACH ((1ULL << RVC_JUMP_BITS) * RISCV_JUMP_ALIGN)
58 #define RVC_BRANCH_BITS 8
59 #define RVC_BRANCH_REACH ((1ULL << RVC_BRANCH_BITS) * RISCV_BRANCH_ALIGN)
61 #define RV_X(x, s, n) (((x) >> (s)) & ((1 << (n)) - 1))
62 #define RV_IMM_SIGN(x) (-(((x) >> 31) & 1))
64 #define EXTRACT_ITYPE_IMM(x) \
65 (RV_X(x, 20, 12) | (RV_IMM_SIGN(x) << 12))
66 #define EXTRACT_STYPE_IMM(x) \
67 (RV_X(x, 7, 5) | (RV_X(x, 25, 7) << 5) | (RV_IMM_SIGN(x) << 12))
68 #define EXTRACT_SBTYPE_IMM(x) \
69 ((RV_X(x, 8, 4) << 1) | (RV_X(x, 25, 6) << 5) | (RV_X(x, 7, 1) << 11) | (RV_IMM_SIGN(x) << 12))
70 #define EXTRACT_UTYPE_IMM(x) \
71 ((RV_X(x, 12, 20) << 12) | (RV_IMM_SIGN(x) << 32))
72 #define EXTRACT_UJTYPE_IMM(x) \
73 ((RV_X(x, 21, 10) << 1) | (RV_X(x, 20, 1) << 11) | (RV_X(x, 12, 8) << 12) | (RV_IMM_SIGN(x) << 20))
74 #define EXTRACT_RVC_IMM(x) \
75 (RV_X(x, 2, 5) | (-RV_X(x, 12, 1) << 5))
76 #define EXTRACT_RVC_LUI_IMM(x) \
77 (EXTRACT_RVC_IMM (x) << RISCV_IMM_BITS)
78 #define EXTRACT_RVC_SIMM3(x) \
79 (RV_X(x, 10, 2) | (-RV_X(x, 12, 1) << 2))
80 #define EXTRACT_RVC_UIMM8(x) \
82 #define EXTRACT_RVC_ADDI4SPN_IMM(x) \
83 ((RV_X(x, 6, 1) << 2) | (RV_X(x, 5, 1) << 3) | (RV_X(x, 11, 2) << 4) | (RV_X(x, 7, 4) << 6))
84 #define EXTRACT_RVC_ADDI16SP_IMM(x) \
85 ((RV_X(x, 6, 1) << 4) | (RV_X(x, 2, 1) << 5) | (RV_X(x, 5, 1) << 6) | (RV_X(x, 3, 2) << 7) | (-RV_X(x, 12, 1) << 9))
86 #define EXTRACT_RVC_LW_IMM(x) \
87 ((RV_X(x, 6, 1) << 2) | (RV_X(x, 10, 3) << 3) | (RV_X(x, 5, 1) << 6))
88 #define EXTRACT_RVC_LD_IMM(x) \
89 ((RV_X(x, 10, 3) << 3) | (RV_X(x, 5, 2) << 6))
90 #define EXTRACT_RVC_LWSP_IMM(x) \
91 ((RV_X(x, 4, 3) << 2) | (RV_X(x, 12, 1) << 5) | (RV_X(x, 2, 2) << 6))
92 #define EXTRACT_RVC_LDSP_IMM(x) \
93 ((RV_X(x, 5, 2) << 3) | (RV_X(x, 12, 1) << 5) | (RV_X(x, 2, 3) << 6))
94 #define EXTRACT_RVC_SWSP_IMM(x) \
95 ((RV_X(x, 9, 4) << 2) | (RV_X(x, 7, 2) << 6))
96 #define EXTRACT_RVC_SDSP_IMM(x) \
97 ((RV_X(x, 10, 3) << 3) | (RV_X(x, 7, 3) << 6))
98 #define EXTRACT_RVC_B_IMM(x) \
99 ((RV_X(x, 3, 2) << 1) | (RV_X(x, 10, 2) << 3) | (RV_X(x, 2, 1) << 5) | (RV_X(x, 5, 2) << 6) | (-RV_X(x, 12, 1) << 8))
100 #define EXTRACT_RVC_J_IMM(x) \
101 ((RV_X(x, 3, 3) << 1) | (RV_X(x, 11, 1) << 4) | (RV_X(x, 2, 1) << 5) | (RV_X(x, 7, 1) << 6) | (RV_X(x, 6, 1) << 7) | (RV_X(x, 9, 2) << 8) | (RV_X(x, 8, 1) << 10) | (-RV_X(x, 12, 1) << 11))
103 #define ENCODE_ITYPE_IMM(x) \
104 (RV_X(x, 0, 12) << 20)
105 #define ENCODE_STYPE_IMM(x) \
106 ((RV_X(x, 0, 5) << 7) | (RV_X(x, 5, 7) << 25))
107 #define ENCODE_SBTYPE_IMM(x) \
108 ((RV_X(x, 1, 4) << 8) | (RV_X(x, 5, 6) << 25) | (RV_X(x, 11, 1) << 7) | (RV_X(x, 12, 1) << 31))
109 #define ENCODE_UTYPE_IMM(x) \
110 (RV_X(x, 12, 20) << 12)
111 #define ENCODE_UJTYPE_IMM(x) \
112 ((RV_X(x, 1, 10) << 21) | (RV_X(x, 11, 1) << 20) | (RV_X(x, 12, 8) << 12) | (RV_X(x, 20, 1) << 31))
113 #define ENCODE_RVC_IMM(x) \
114 ((RV_X(x, 0, 5) << 2) | (RV_X(x, 5, 1) << 12))
115 #define ENCODE_RVC_LUI_IMM(x) \
116 ENCODE_RVC_IMM ((x) >> RISCV_IMM_BITS)
117 #define ENCODE_RVC_SIMM3(x) \
118 (RV_X(x, 0, 3) << 10)
119 #define ENCODE_RVC_UIMM8(x) \
121 #define ENCODE_RVC_ADDI4SPN_IMM(x) \
122 ((RV_X(x, 2, 1) << 6) | (RV_X(x, 3, 1) << 5) | (RV_X(x, 4, 2) << 11) | (RV_X(x, 6, 4) << 7))
123 #define ENCODE_RVC_ADDI16SP_IMM(x) \
124 ((RV_X(x, 4, 1) << 6) | (RV_X(x, 5, 1) << 2) | (RV_X(x, 6, 1) << 5) | (RV_X(x, 7, 2) << 3) | (RV_X(x, 9, 1) << 12))
125 #define ENCODE_RVC_LW_IMM(x) \
126 ((RV_X(x, 2, 1) << 6) | (RV_X(x, 3, 3) << 10) | (RV_X(x, 6, 1) << 5))
127 #define ENCODE_RVC_LD_IMM(x) \
128 ((RV_X(x, 3, 3) << 10) | (RV_X(x, 6, 2) << 5))
129 #define ENCODE_RVC_LWSP_IMM(x) \
130 ((RV_X(x, 2, 3) << 4) | (RV_X(x, 5, 1) << 12) | (RV_X(x, 6, 2) << 2))
131 #define ENCODE_RVC_LDSP_IMM(x) \
132 ((RV_X(x, 3, 2) << 5) | (RV_X(x, 5, 1) << 12) | (RV_X(x, 6, 3) << 2))
133 #define ENCODE_RVC_SWSP_IMM(x) \
134 ((RV_X(x, 2, 4) << 9) | (RV_X(x, 6, 2) << 7))
135 #define ENCODE_RVC_SDSP_IMM(x) \
136 ((RV_X(x, 3, 3) << 10) | (RV_X(x, 6, 3) << 7))
137 #define ENCODE_RVC_B_IMM(x) \
138 ((RV_X(x, 1, 2) << 3) | (RV_X(x, 3, 2) << 10) | (RV_X(x, 5, 1) << 2) | (RV_X(x, 6, 2) << 5) | (RV_X(x, 8, 1) << 12))
139 #define ENCODE_RVC_J_IMM(x) \
140 ((RV_X(x, 1, 3) << 3) | (RV_X(x, 4, 1) << 11) | (RV_X(x, 5, 1) << 2) | (RV_X(x, 6, 1) << 7) | (RV_X(x, 7, 1) << 6) | (RV_X(x, 8, 2) << 9) | (RV_X(x, 10, 1) << 8) | (RV_X(x, 11, 1) << 12))
142 #define VALID_ITYPE_IMM(x) (EXTRACT_ITYPE_IMM(ENCODE_ITYPE_IMM(x)) == (x))
143 #define VALID_STYPE_IMM(x) (EXTRACT_STYPE_IMM(ENCODE_STYPE_IMM(x)) == (x))
144 #define VALID_SBTYPE_IMM(x) (EXTRACT_SBTYPE_IMM(ENCODE_SBTYPE_IMM(x)) == (x))
145 #define VALID_UTYPE_IMM(x) (EXTRACT_UTYPE_IMM(ENCODE_UTYPE_IMM(x)) == (x))
146 #define VALID_UJTYPE_IMM(x) (EXTRACT_UJTYPE_IMM(ENCODE_UJTYPE_IMM(x)) == (x))
147 #define VALID_RVC_IMM(x) (EXTRACT_RVC_IMM(ENCODE_RVC_IMM(x)) == (x))
148 #define VALID_RVC_LUI_IMM(x) (ENCODE_RVC_LUI_IMM(x) != 0 && EXTRACT_RVC_LUI_IMM(ENCODE_RVC_LUI_IMM(x)) == (x))
149 #define VALID_RVC_SIMM3(x) (EXTRACT_RVC_SIMM3(ENCODE_RVC_SIMM3(x)) == (x))
150 #define VALID_RVC_UIMM8(x) (EXTRACT_RVC_UIMM8(ENCODE_RVC_UIMM8(x)) == (x))
151 #define VALID_RVC_ADDI4SPN_IMM(x) (EXTRACT_RVC_ADDI4SPN_IMM(ENCODE_RVC_ADDI4SPN_IMM(x)) == (x))
152 #define VALID_RVC_ADDI16SP_IMM(x) (EXTRACT_RVC_ADDI16SP_IMM(ENCODE_RVC_ADDI16SP_IMM(x)) == (x))
153 #define VALID_RVC_LW_IMM(x) (EXTRACT_RVC_LW_IMM(ENCODE_RVC_LW_IMM(x)) == (x))
154 #define VALID_RVC_LD_IMM(x) (EXTRACT_RVC_LD_IMM(ENCODE_RVC_LD_IMM(x)) == (x))
155 #define VALID_RVC_LWSP_IMM(x) (EXTRACT_RVC_LWSP_IMM(ENCODE_RVC_LWSP_IMM(x)) == (x))
156 #define VALID_RVC_LDSP_IMM(x) (EXTRACT_RVC_LDSP_IMM(ENCODE_RVC_LDSP_IMM(x)) == (x))
157 #define VALID_RVC_SWSP_IMM(x) (EXTRACT_RVC_SWSP_IMM(ENCODE_RVC_SWSP_IMM(x)) == (x))
158 #define VALID_RVC_SDSP_IMM(x) (EXTRACT_RVC_SDSP_IMM(ENCODE_RVC_SDSP_IMM(x)) == (x))
159 #define VALID_RVC_B_IMM(x) (EXTRACT_RVC_B_IMM(ENCODE_RVC_B_IMM(x)) == (x))
160 #define VALID_RVC_J_IMM(x) (EXTRACT_RVC_J_IMM(ENCODE_RVC_J_IMM(x)) == (x))
162 #define RISCV_RTYPE(insn, rd, rs1, rs2) \
163 ((MATCH_ ## insn) | ((rd) << OP_SH_RD) | ((rs1) << OP_SH_RS1) | ((rs2) << OP_SH_RS2))
164 #define RISCV_ITYPE(insn, rd, rs1, imm) \
165 ((MATCH_ ## insn) | ((rd) << OP_SH_RD) | ((rs1) << OP_SH_RS1) | ENCODE_ITYPE_IMM(imm))
166 #define RISCV_STYPE(insn, rs1, rs2, imm) \
167 ((MATCH_ ## insn) | ((rs1) << OP_SH_RS1) | ((rs2) << OP_SH_RS2) | ENCODE_STYPE_IMM(imm))
168 #define RISCV_SBTYPE(insn, rs1, rs2, target) \
169 ((MATCH_ ## insn) | ((rs1) << OP_SH_RS1) | ((rs2) << OP_SH_RS2) | ENCODE_SBTYPE_IMM(target))
170 #define RISCV_UTYPE(insn, rd, bigimm) \
171 ((MATCH_ ## insn) | ((rd) << OP_SH_RD) | ENCODE_UTYPE_IMM(bigimm))
172 #define RISCV_UJTYPE(insn, rd, target) \
173 ((MATCH_ ## insn) | ((rd) << OP_SH_RD) | ENCODE_UJTYPE_IMM(target))
175 #define RISCV_NOP RISCV_ITYPE(ADDI, 0, 0, 0)
176 #define RVC_NOP MATCH_C_ADDI
178 #define RISCV_CONST_HIGH_PART(VALUE) \
179 (((VALUE) + (RISCV_IMM_REACH/2)) & ~(RISCV_IMM_REACH-1))
180 #define RISCV_CONST_LOW_PART(VALUE) ((VALUE) - RISCV_CONST_HIGH_PART (VALUE))
181 #define RISCV_PCREL_HIGH_PART(VALUE, PC) RISCV_CONST_HIGH_PART((VALUE) - (PC))
182 #define RISCV_PCREL_LOW_PART(VALUE, PC) RISCV_CONST_LOW_PART((VALUE) - (PC))
184 #define RISCV_JUMP_BITS RISCV_BIGIMM_BITS
185 #define RISCV_JUMP_ALIGN_BITS 1
186 #define RISCV_JUMP_ALIGN (1 << RISCV_JUMP_ALIGN_BITS)
187 #define RISCV_JUMP_REACH ((1ULL << RISCV_JUMP_BITS) * RISCV_JUMP_ALIGN)
189 #define RISCV_IMM_BITS 12
190 #define RISCV_BIGIMM_BITS (32 - RISCV_IMM_BITS)
191 #define RISCV_IMM_REACH (1LL << RISCV_IMM_BITS)
192 #define RISCV_BIGIMM_REACH (1LL << RISCV_BIGIMM_BITS)
193 #define RISCV_RVC_IMM_REACH (1LL << 6)
194 #define RISCV_BRANCH_BITS RISCV_IMM_BITS
195 #define RISCV_BRANCH_ALIGN_BITS RISCV_JUMP_ALIGN_BITS
196 #define RISCV_BRANCH_ALIGN (1 << RISCV_BRANCH_ALIGN_BITS)
197 #define RISCV_BRANCH_REACH (RISCV_IMM_REACH * RISCV_BRANCH_ALIGN)
201 #define OP_MASK_OP 0x7f
203 #define OP_MASK_RS2 0x1f
205 #define OP_MASK_RS1 0x1f
207 #define OP_MASK_RS3 0x1f
209 #define OP_MASK_RD 0x1f
211 #define OP_MASK_SHAMT 0x3f
212 #define OP_SH_SHAMT 20
213 #define OP_MASK_SHAMTW 0x1f
214 #define OP_SH_SHAMTW 20
215 #define OP_MASK_RM 0x7
217 #define OP_MASK_PRED 0xf
218 #define OP_SH_PRED 24
219 #define OP_MASK_SUCC 0xf
220 #define OP_SH_SUCC 20
221 #define OP_MASK_AQ 0x1
223 #define OP_MASK_RL 0x1
226 #define OP_MASK_CUSTOM_IMM 0x7f
227 #define OP_SH_CUSTOM_IMM 25
228 #define OP_MASK_CSR 0xfff
231 #define OP_MASK_FUNCT3 0x7
232 #define OP_SH_FUNCT3 12
233 #define OP_MASK_FUNCT7 0x7f
234 #define OP_SH_FUNCT7 25
235 #define OP_MASK_FUNCT2 0x3
236 #define OP_SH_FUNCT2 25
240 #define OP_MASK_OP2 0x3
243 #define OP_MASK_CRS2 0x1f
245 #define OP_MASK_CRS1S 0x7
246 #define OP_SH_CRS1S 7
247 #define OP_MASK_CRS2S 0x7
248 #define OP_SH_CRS2S 2
250 #define OP_MASK_CFUNCT6 0x3f
251 #define OP_SH_CFUNCT6 10
252 #define OP_MASK_CFUNCT4 0xf
253 #define OP_SH_CFUNCT4 12
254 #define OP_MASK_CFUNCT3 0x7
255 #define OP_SH_CFUNCT3 13
256 #define OP_MASK_CFUNCT2 0x3
257 #define OP_SH_CFUNCT2 5
259 /* ABI names for selected x-registers. */
273 /* These fake label defines are use by both the assembler, and
274 libopcodes. The assembler uses this when it needs to generate a fake
275 label, and libopcodes uses it to hide the fake labels in its output. */
276 #define RISCV_FAKE_LABEL_NAME ".L0 "
277 #define RISCV_FAKE_LABEL_CHAR ' '
279 /* Replace bits MASK << SHIFT of STRUCT with the equivalent bits in
280 VALUE << SHIFT. VALUE is evaluated exactly once. */
281 #define INSERT_BITS(STRUCT, VALUE, MASK, SHIFT) \
282 (STRUCT) = (((STRUCT) & ~((insn_t)(MASK) << (SHIFT))) \
283 | ((insn_t)((VALUE) & (MASK)) << (SHIFT)))
285 /* Extract bits MASK << SHIFT from STRUCT and shift them right
287 #define EXTRACT_BITS(STRUCT, MASK, SHIFT) \
288 (((STRUCT) >> (SHIFT)) & (MASK))
290 /* Extract the operand given by FIELD from integer INSN. */
291 #define EXTRACT_OPERAND(FIELD, INSN) \
292 EXTRACT_BITS ((INSN), OP_MASK_##FIELD, OP_SH_##FIELD)
294 /* The maximal number of subset can be required. */
295 #define MAX_SUBSET_NUM 4
297 /* All RISC-V instructions belong to at least one of these classes. */
299 enum riscv_insn_class
314 /* This structure holds information for a particular instruction. */
318 /* The name of the instruction. */
320 /* The requirement of xlen for the instruction, 0 if no requirement. */
321 unsigned xlen_requirement
;
322 /* Class to which this instruction belongs. Used to decide whether or
323 not this instruction is legal in the current -march context. */
324 enum riscv_insn_class insn_class
;
325 /* A string describing the arguments for this instruction. */
327 /* The basic opcode for the instruction. When assembling, this
328 opcode is modified by the arguments to produce the actual opcode
329 that is used. If pinfo is INSN_MACRO, then this is 0. */
331 /* If pinfo is not INSN_MACRO, then this is a bit mask for the
332 relevant portions of the opcode when disassembling. If the
333 actual opcode anded with the match field equals the opcode field,
334 then we have found the correct instruction. If pinfo is
335 INSN_MACRO, then this field is the macro identifier. */
337 /* A function to determine if a word corresponds to this instruction.
338 Usually, this computes ((word & mask) == match). */
339 int (*match_func
) (const struct riscv_opcode
*op
, insn_t word
);
340 /* For a macro, this is INSN_MACRO. Otherwise, it is a collection
341 of bits describing the instruction, notably any relevant hazard
346 /* Instruction is a simple alias (e.g. "mv" for "addi"). */
347 #define INSN_ALIAS 0x00000001
349 /* These are for setting insn_info fields.
351 Nonbranch is the default. Noninsn is used only if there is no match.
352 There are no condjsr or dref2 instructions. So that leaves condbranch,
353 branch, jsr, and dref that we need to handle here, encoded in 3 bits. */
354 #define INSN_TYPE 0x0000000e
356 /* Instruction is an unconditional branch. */
357 #define INSN_BRANCH 0x00000002
358 /* Instruction is a conditional branch. */
359 #define INSN_CONDBRANCH 0x00000004
360 /* Instruction is a jump to subroutine. */
361 #define INSN_JSR 0x00000006
362 /* Instruction is a data reference. */
363 #define INSN_DREF 0x00000008
365 /* We have 5 data reference sizes, which we can encode in 3 bits. */
366 #define INSN_DATA_SIZE 0x00000070
367 #define INSN_DATA_SIZE_SHIFT 4
368 #define INSN_1_BYTE 0x00000010
369 #define INSN_2_BYTE 0x00000020
370 #define INSN_4_BYTE 0x00000030
371 #define INSN_8_BYTE 0x00000040
372 #define INSN_16_BYTE 0x00000050
374 /* Instruction is actually a macro. It should be ignored by the
375 disassembler, and requires special treatment by the assembler. */
376 #define INSN_MACRO 0xffffffff
378 /* This is a list of macro expanded instructions.
380 _I appended means immediate
381 _A appended means address
382 _AB appended means address with base register
383 _D appended means 64 bit floating point constant
384 _S appended means 32 bit floating point constant. */
416 extern const char * const riscv_gpr_names_numeric
[NGPR
];
417 extern const char * const riscv_gpr_names_abi
[NGPR
];
418 extern const char * const riscv_fpr_names_numeric
[NFPR
];
419 extern const char * const riscv_fpr_names_abi
[NFPR
];
421 extern const struct riscv_opcode riscv_opcodes
[];
422 extern const struct riscv_opcode riscv_insn_types
[];
424 #endif /* _RISCV_H_ */