Coverage Report

Created: 2026-04-29 06:06

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/capstonenext/arch/RISCV/RISCVDisassembler.c
Line
Count
Source
1
/* Capstone Disassembly Engine, http://www.capstone-engine.org */
2
/* By Nguyen Anh Quynh <aquynh@gmail.com>, 2013-2022, */
3
/*    Rot127 <unisono@quyllur.org> 2022-2023 */
4
/* Automatically translated source file from LLVM. */
5
6
/* LLVM-commit: <commit> */
7
/* LLVM-tag: <tag> */
8
9
/* Only small edits allowed. */
10
/* For multiple similar edits, please create a Patch for the translator. */
11
12
/* Capstone's C++ file translator: */
13
/* https://github.com/capstone-engine/capstone/tree/next/suite/auto-sync */
14
15
//===-- RISCVDisassembler.cpp - Disassembler for RISC-V -------------------===//
16
//
17
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
18
// See https://llvm.org/LICENSE.txt for license information.
19
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
20
//
21
//===----------------------------------------------------------------------===//
22
//
23
// This file implements the RISCVDisassembler class.
24
//
25
//===----------------------------------------------------------------------===//
26
27
#include <stdio.h>
28
#include <string.h>
29
#include <stdlib.h>
30
#include <capstone/platform.h>
31
32
#include "../../MCInst.h"
33
#include "../../MathExtras.h"
34
#include "../../MCInstPrinter.h"
35
#include "../../MCDisassembler.h"
36
#include "../../MCFixedLenDisassembler.h"
37
#include "../../cs_priv.h"
38
#include "../../utils.h"
39
#include "RISCVDisassemblerExtension.h"
40
#include "RISCVBaseInfo.h"
41
#include "RISCVMapping.h"
42
43
#define GET_SUBTARGETINFO_ENUM
44
#include "RISCVGenSubtargetInfo.inc"
45
46
#define GET_REGINFO_ENUM
47
#include "RISCVGenRegisterInfo.inc"
48
49
#define GET_INSTRINFO_ENUM
50
#define GET_INSTRINFO_MC_DESC
51
#include "RISCVGenInstrInfo.inc"
52
53
5.79k
#define CONCAT(a, b) CONCAT_(a, b)
54
5.79k
#define CONCAT_(a, b) a##_##b
55
56
#define DEBUG_TYPE "riscv-disassembler"
57
58
DecodeStatus RISCV_getInstruction(MCInst *Instr, uint16_t *Size,
59
          const uint8_t *Bytes, size_t BytesLen,
60
          uint64_t Address, SStream *CStream);
61
void addSPOperands(MCInst *MI);
62
;
63
// end anonymous namespace
64
65
static DecodeStatus DecodeGPRRegisterClass(MCInst *Inst, uint32_t RegNo,
66
             uint64_t Address,
67
             const void *Decoder)
68
51.9k
{
69
51.9k
  bool IsRVE = RISCV_getFeatureBits(Inst->csh->mode, RISCV_FeatureRVE);
70
71
51.9k
  if (RegNo >= 32 || (IsRVE && RegNo >= 16))
72
0
    return MCDisassembler_Fail;
73
74
51.9k
  MCRegister Reg = RISCV_X0 + RegNo;
75
51.9k
  MCOperand_CreateReg0(Inst, (Reg));
76
51.9k
  return MCDisassembler_Success;
77
51.9k
}
78
79
static DecodeStatus DecodeGPRX1X5RegisterClass(MCInst *Inst, uint32_t RegNo,
80
                 uint64_t Address,
81
                 const void *Decoder)
82
0
{
83
0
  MCRegister Reg = RISCV_X0 + RegNo;
84
0
  if (Reg != RISCV_X1 && Reg != RISCV_X5)
85
0
    return MCDisassembler_Fail;
86
87
0
  MCOperand_CreateReg0(Inst, (Reg));
88
0
  return MCDisassembler_Success;
89
0
}
90
91
static DecodeStatus DecodeFPR16RegisterClass(MCInst *Inst, uint32_t RegNo,
92
               uint64_t Address,
93
               const void *Decoder)
94
9.80k
{
95
9.80k
  if (RegNo >= 32)
96
0
    return MCDisassembler_Fail;
97
98
9.80k
  MCRegister Reg = RISCV_F0_H + RegNo;
99
9.80k
  MCOperand_CreateReg0(Inst, (Reg));
100
9.80k
  return MCDisassembler_Success;
101
9.80k
}
102
103
static DecodeStatus DecodeFPR32RegisterClass(MCInst *Inst, uint32_t RegNo,
104
               uint64_t Address,
105
               const void *Decoder)
106
19.0k
{
107
19.0k
  if (RegNo >= 32)
108
0
    return MCDisassembler_Fail;
109
110
19.0k
  MCRegister Reg = RISCV_F0_F + RegNo;
111
19.0k
  MCOperand_CreateReg0(Inst, (Reg));
112
19.0k
  return MCDisassembler_Success;
113
19.0k
}
114
115
static DecodeStatus DecodeFPR32CRegisterClass(MCInst *Inst, uint32_t RegNo,
116
                uint64_t Address,
117
                const void *Decoder)
118
0
{
119
0
  if (RegNo >= 8) {
120
0
    return MCDisassembler_Fail;
121
0
  }
122
0
  MCRegister Reg = RISCV_F8_F + RegNo;
123
0
  MCOperand_CreateReg0(Inst, (Reg));
124
0
  return MCDisassembler_Success;
125
0
}
126
127
static DecodeStatus DecodeFPR64RegisterClass(MCInst *Inst, uint32_t RegNo,
128
               uint64_t Address,
129
               const void *Decoder)
130
16.3k
{
131
16.3k
  if (RegNo >= 32)
132
0
    return MCDisassembler_Fail;
133
134
16.3k
  MCRegister Reg = RISCV_F0_D + RegNo;
135
16.3k
  MCOperand_CreateReg0(Inst, (Reg));
136
16.3k
  return MCDisassembler_Success;
137
16.3k
}
138
139
static DecodeStatus DecodeFPR64CRegisterClass(MCInst *Inst, uint32_t RegNo,
140
                uint64_t Address,
141
                const void *Decoder)
142
0
{
143
0
  if (RegNo >= 8) {
144
0
    return MCDisassembler_Fail;
145
0
  }
146
0
  MCRegister Reg = RISCV_F8_D + RegNo;
147
0
  MCOperand_CreateReg0(Inst, (Reg));
148
0
  return MCDisassembler_Success;
149
0
}
150
151
static DecodeStatus DecodeGPRNoX0RegisterClass(MCInst *Inst, uint32_t RegNo,
152
                 uint64_t Address,
153
                 const void *Decoder)
154
16.3k
{
155
16.3k
  if (RegNo == 0) {
156
10
    return MCDisassembler_Fail;
157
10
  }
158
159
16.3k
  return DecodeGPRRegisterClass(Inst, RegNo, Address, Decoder);
160
16.3k
}
161
162
static DecodeStatus DecodeGPRNoX0X2RegisterClass(MCInst *Inst, uint64_t RegNo,
163
             uint32_t Address,
164
             const void *Decoder)
165
1.62k
{
166
1.62k
  if (RegNo == 2) {
167
0
    return MCDisassembler_Fail;
168
0
  }
169
170
1.62k
  return DecodeGPRNoX0RegisterClass(Inst, RegNo, Address, Decoder);
171
1.62k
}
172
173
static DecodeStatus DecodeGPRCRegisterClass(MCInst *Inst, uint32_t RegNo,
174
              uint64_t Address,
175
              const void *Decoder)
176
26.6k
{
177
26.6k
  if (RegNo >= 8)
178
0
    return MCDisassembler_Fail;
179
180
26.6k
  MCRegister Reg = RISCV_X8 + RegNo;
181
26.6k
  MCOperand_CreateReg0(Inst, (Reg));
182
26.6k
  return MCDisassembler_Success;
183
26.6k
}
184
185
static DecodeStatus DecodeGPRPairRegisterClass(MCInst *Inst, uint32_t RegNo,
186
                 uint64_t Address,
187
                 const void *Decoder)
188
412
{
189
412
  if (RegNo >= 32 || RegNo & 1)
190
2
    return MCDisassembler_Fail;
191
192
410
  MCRegister Reg = RISCV_X0 + RegNo;
193
410
  MCOperand_CreateReg0(Inst, (Reg));
194
410
  return MCDisassembler_Success;
195
412
}
196
197
static DecodeStatus DecodeSR07RegisterClass(MCInst *Inst, uint64_t RegNo,
198
              uint64_t Address,
199
              const void *Decoder)
200
0
{
201
0
  if (RegNo >= 8)
202
0
    return MCDisassembler_Fail;
203
204
0
  MCRegister Reg = (RegNo < 2) ? (RegNo + RISCV_X8) :
205
0
               (RegNo - 2 + RISCV_X18);
206
0
  MCOperand_CreateReg0(Inst, (Reg));
207
0
  return MCDisassembler_Success;
208
0
}
209
210
static DecodeStatus DecodeVRRegisterClass(MCInst *Inst, uint32_t RegNo,
211
            uint64_t Address, const void *Decoder)
212
11.9k
{
213
11.9k
  if (RegNo >= 32)
214
0
    return MCDisassembler_Fail;
215
216
11.9k
  MCRegister Reg = RISCV_V0 + RegNo;
217
11.9k
  MCOperand_CreateReg0(Inst, (Reg));
218
11.9k
  return MCDisassembler_Success;
219
11.9k
}
220
221
static DecodeStatus DecodeVRM2RegisterClass(MCInst *Inst, uint32_t RegNo,
222
              uint64_t Address,
223
              const void *Decoder)
224
44
{
225
44
  if (RegNo >= 32 || RegNo % 2)
226
3
    return MCDisassembler_Fail;
227
228
41
  MCRegister Reg = MCRegisterInfo_getMatchingSuperReg(
229
41
    Inst->MRI, RISCV_V0 + RegNo, RISCV_sub_vrm1_0,
230
41
    MCRegisterInfo_getRegClass(Inst->MRI, RISCV_VRM2RegClassID));
231
232
41
  MCOperand_CreateReg0(Inst, (Reg));
233
41
  return MCDisassembler_Success;
234
44
}
235
236
static DecodeStatus DecodeVRM4RegisterClass(MCInst *Inst, uint32_t RegNo,
237
              uint64_t Address,
238
              const void *Decoder)
239
65
{
240
65
  if (RegNo >= 32 || RegNo % 4)
241
3
    return MCDisassembler_Fail;
242
243
62
  MCRegister Reg = MCRegisterInfo_getMatchingSuperReg(
244
62
    Inst->MRI, RISCV_V0 + RegNo, RISCV_sub_vrm1_0,
245
62
    MCRegisterInfo_getRegClass(Inst->MRI, RISCV_VRM4RegClassID));
246
247
62
  MCOperand_CreateReg0(Inst, (Reg));
248
62
  return MCDisassembler_Success;
249
65
}
250
251
static DecodeStatus DecodeVRM8RegisterClass(MCInst *Inst, uint32_t RegNo,
252
              uint64_t Address,
253
              const void *Decoder)
254
79
{
255
79
  if (RegNo >= 32 || RegNo % 8)
256
4
    return MCDisassembler_Fail;
257
258
75
  MCRegister Reg = MCRegisterInfo_getMatchingSuperReg(
259
75
    Inst->MRI, RISCV_V0 + RegNo, RISCV_sub_vrm1_0,
260
75
    MCRegisterInfo_getRegClass(Inst->MRI, RISCV_VRM8RegClassID));
261
262
75
  MCOperand_CreateReg0(Inst, (Reg));
263
75
  return MCDisassembler_Success;
264
79
}
265
266
static DecodeStatus decodeVMaskReg(MCInst *Inst, uint64_t RegNo,
267
           uint64_t Address, const void *Decoder)
268
4.43k
{
269
4.43k
  if (RegNo > 2) {
270
0
    return MCDisassembler_Fail;
271
0
  }
272
4.43k
  MCRegister Reg = (RegNo == 0) ? RISCV_V0 : RISCV_NoRegister;
273
274
4.43k
  MCOperand_CreateReg0(Inst, (Reg));
275
4.43k
  return MCDisassembler_Success;
276
4.43k
}
277
278
#define DEFINE_decodeUImmOperand(N) \
279
  static DecodeStatus CONCAT(decodeUImmOperand, \
280
           N)(MCInst * Inst, uint32_t Imm, \
281
              int64_t Address, const void *Decoder) \
282
25.0k
  { \
283
25.0k
    CS_ASSERT(isUIntN(N, Imm) && "Invalid immediate"); \
284
25.0k
    MCOperand_CreateImm0(Inst, (Imm)); \
285
25.0k
    return MCDisassembler_Success; \
286
25.0k
  }
RISCVDisassembler.c:decodeUImmOperand_8
Line
Count
Source
282
4.27k
  { \
283
4.27k
    CS_ASSERT(isUIntN(N, Imm) && "Invalid immediate"); \
284
4.27k
    MCOperand_CreateImm0(Inst, (Imm)); \
285
4.27k
    return MCDisassembler_Success; \
286
4.27k
  }
RISCVDisassembler.c:decodeUImmOperand_9
Line
Count
Source
282
1.71k
  { \
283
1.71k
    CS_ASSERT(isUIntN(N, Imm) && "Invalid immediate"); \
284
1.71k
    MCOperand_CreateImm0(Inst, (Imm)); \
285
1.71k
    return MCDisassembler_Success; \
286
1.71k
  }
RISCVDisassembler.c:decodeUImmOperand_7
Line
Count
Source
282
3.88k
  { \
283
3.88k
    CS_ASSERT(isUIntN(N, Imm) && "Invalid immediate"); \
284
3.88k
    MCOperand_CreateImm0(Inst, (Imm)); \
285
3.88k
    return MCDisassembler_Success; \
286
3.88k
  }
RISCVDisassembler.c:decodeUImmOperand_2
Line
Count
Source
282
2.47k
  { \
283
2.47k
    CS_ASSERT(isUIntN(N, Imm) && "Invalid immediate"); \
284
2.47k
    MCOperand_CreateImm0(Inst, (Imm)); \
285
2.47k
    return MCDisassembler_Success; \
286
2.47k
  }
RISCVDisassembler.c:decodeUImmOperand_4
Line
Count
Source
282
1.12k
  { \
283
1.12k
    CS_ASSERT(isUIntN(N, Imm) && "Invalid immediate"); \
284
1.12k
    MCOperand_CreateImm0(Inst, (Imm)); \
285
1.12k
    return MCDisassembler_Success; \
286
1.12k
  }
RISCVDisassembler.c:decodeUImmOperand_20
Line
Count
Source
282
645
  { \
283
645
    CS_ASSERT(isUIntN(N, Imm) && "Invalid immediate"); \
284
645
    MCOperand_CreateImm0(Inst, (Imm)); \
285
645
    return MCDisassembler_Success; \
286
645
  }
RISCVDisassembler.c:decodeUImmOperand_5
Line
Count
Source
282
3.49k
  { \
283
3.49k
    CS_ASSERT(isUIntN(N, Imm) && "Invalid immediate"); \
284
3.49k
    MCOperand_CreateImm0(Inst, (Imm)); \
285
3.49k
    return MCDisassembler_Success; \
286
3.49k
  }
RISCVDisassembler.c:decodeUImmOperand_6
Line
Count
Source
282
1.22k
  { \
283
1.22k
    CS_ASSERT(isUIntN(N, Imm) && "Invalid immediate"); \
284
1.22k
    MCOperand_CreateImm0(Inst, (Imm)); \
285
1.22k
    return MCDisassembler_Success; \
286
1.22k
  }
RISCVDisassembler.c:decodeUImmOperand_11
Line
Count
Source
282
1.71k
  { \
283
1.71k
    CS_ASSERT(isUIntN(N, Imm) && "Invalid immediate"); \
284
1.71k
    MCOperand_CreateImm0(Inst, (Imm)); \
285
1.71k
    return MCDisassembler_Success; \
286
1.71k
  }
RISCVDisassembler.c:decodeUImmOperand_10
Line
Count
Source
282
2.64k
  { \
283
2.64k
    CS_ASSERT(isUIntN(N, Imm) && "Invalid immediate"); \
284
2.64k
    MCOperand_CreateImm0(Inst, (Imm)); \
285
2.64k
    return MCDisassembler_Success; \
286
2.64k
  }
RISCVDisassembler.c:decodeUImmOperand_12
Line
Count
Source
282
1.81k
  { \
283
1.81k
    CS_ASSERT(isUIntN(N, Imm) && "Invalid immediate"); \
284
1.81k
    MCOperand_CreateImm0(Inst, (Imm)); \
285
1.81k
    return MCDisassembler_Success; \
286
1.81k
  }
RISCVDisassembler.c:decodeUImmOperand_3
Line
Count
Source
282
75
  { \
283
75
    CS_ASSERT(isUIntN(N, Imm) && "Invalid immediate"); \
284
75
    MCOperand_CreateImm0(Inst, (Imm)); \
285
75
    return MCDisassembler_Success; \
286
75
  }
Unexecuted instantiation: RISCVDisassembler.c:decodeUImmOperand_1
287
DEFINE_decodeUImmOperand(6);
288
DEFINE_decodeUImmOperand(2);
289
DEFINE_decodeUImmOperand(8);
290
DEFINE_decodeUImmOperand(9);
291
DEFINE_decodeUImmOperand(7);
292
DEFINE_decodeUImmOperand(4);
293
DEFINE_decodeUImmOperand(20);
294
DEFINE_decodeUImmOperand(5);
295
DEFINE_decodeUImmOperand(11);
296
DEFINE_decodeUImmOperand(10);
297
DEFINE_decodeUImmOperand(12);
298
DEFINE_decodeUImmOperand(3);
299
DEFINE_decodeUImmOperand(1);
300
301
#define DEFINE_decodeUImmNonZeroOperand(N) \
302
  static DecodeStatus CONCAT(decodeUImmNonZeroOperand, \
303
           N)(MCInst * Inst, uint32_t Imm, \
304
              int64_t Address, const void *Decoder) \
305
2.26k
  { \
306
2.26k
    if (Imm == 0) \
307
2.26k
      return MCDisassembler_Fail; \
308
2.26k
    return CONCAT(decodeUImmOperand, N)(Inst, Imm, Address, \
309
2.25k
                Decoder); \
310
2.26k
  }
311
DEFINE_decodeUImmNonZeroOperand(10);
312
313
#define DEFINE_decodeSImmOperand(N) \
314
  static DecodeStatus CONCAT(decodeSImmOperand, \
315
           N)(MCInst * Inst, uint32_t Imm, \
316
              int64_t Address, const void *Decoder) \
317
9.45k
  { \
318
9.45k
    CS_ASSERT(isUIntN(N, Imm) && "Invalid immediate"); \
319
9.45k
\
320
9.45k
    MCOperand_CreateImm0(Inst, (SignExtend64((Imm), N))); \
321
9.45k
    return MCDisassembler_Success; \
322
9.45k
  }
RISCVDisassembler.c:decodeSImmOperand_6
Line
Count
Source
317
4.36k
  { \
318
4.36k
    CS_ASSERT(isUIntN(N, Imm) && "Invalid immediate"); \
319
4.36k
\
320
4.36k
    MCOperand_CreateImm0(Inst, (SignExtend64((Imm), N))); \
321
4.36k
    return MCDisassembler_Success; \
322
4.36k
  }
RISCVDisassembler.c:decodeSImmOperand_10
Line
Count
Source
317
909
  { \
318
909
    CS_ASSERT(isUIntN(N, Imm) && "Invalid immediate"); \
319
909
\
320
909
    MCOperand_CreateImm0(Inst, (SignExtend64((Imm), N))); \
321
909
    return MCDisassembler_Success; \
322
909
  }
RISCVDisassembler.c:decodeSImmOperand_12
Line
Count
Source
317
3.43k
  { \
318
3.43k
    CS_ASSERT(isUIntN(N, Imm) && "Invalid immediate"); \
319
3.43k
\
320
3.43k
    MCOperand_CreateImm0(Inst, (SignExtend64((Imm), N))); \
321
3.43k
    return MCDisassembler_Success; \
322
3.43k
  }
RISCVDisassembler.c:decodeSImmOperand_5
Line
Count
Source
317
749
  { \
318
749
    CS_ASSERT(isUIntN(N, Imm) && "Invalid immediate"); \
319
749
\
320
749
    MCOperand_CreateImm0(Inst, (SignExtend64((Imm), N))); \
321
749
    return MCDisassembler_Success; \
322
749
  }
323
DEFINE_decodeSImmOperand(6);
324
DEFINE_decodeSImmOperand(12);
325
DEFINE_decodeSImmOperand(5);
326
DEFINE_decodeSImmOperand(10);
327
328
#define DEFINE_decodeSImmNonZeroOperand(N) \
329
  static DecodeStatus CONCAT(decodeSImmNonZeroOperand, \
330
           N)(MCInst * Inst, uint32_t Imm, \
331
              int64_t Address, const void *Decoder) \
332
2.46k
  { \
333
2.46k
    if (Imm == 0) \
334
2.46k
      return MCDisassembler_Fail; \
335
2.46k
    return CONCAT(decodeSImmOperand, N)(Inst, Imm, Address, \
336
2.46k
                Decoder); \
337
2.46k
  }
RISCVDisassembler.c:decodeSImmNonZeroOperand_6
Line
Count
Source
332
1.55k
  { \
333
1.55k
    if (Imm == 0) \
334
1.55k
      return MCDisassembler_Fail; \
335
1.55k
    return CONCAT(decodeSImmOperand, N)(Inst, Imm, Address, \
336
1.55k
                Decoder); \
337
1.55k
  }
RISCVDisassembler.c:decodeSImmNonZeroOperand_10
Line
Count
Source
332
910
  { \
333
910
    if (Imm == 0) \
334
910
      return MCDisassembler_Fail; \
335
910
    return CONCAT(decodeSImmOperand, N)(Inst, Imm, Address, \
336
909
                Decoder); \
337
910
  }
338
DEFINE_decodeSImmNonZeroOperand(6);
339
DEFINE_decodeSImmNonZeroOperand(10);
340
341
#define DEFINE_decodeSImmOperandAndLsl1(N) \
342
  static DecodeStatus CONCAT(decodeSImmOperandAndLsl1, \
343
           N)(MCInst * Inst, uint32_t Imm, \
344
              int64_t Address, const void *Decoder) \
345
5.43k
  { \
346
5.43k
    CS_ASSERT(isUIntN(N, Imm) && "Invalid immediate"); \
347
5.43k
\
348
5.43k
    MCOperand_CreateImm0(Inst, (SignExtend64((Imm << 1), N))); \
349
5.43k
    return MCDisassembler_Success; \
350
5.43k
  }
RISCVDisassembler.c:decodeSImmOperandAndLsl1_12
Line
Count
Source
345
1.55k
  { \
346
1.55k
    CS_ASSERT(isUIntN(N, Imm) && "Invalid immediate"); \
347
1.55k
\
348
1.55k
    MCOperand_CreateImm0(Inst, (SignExtend64((Imm << 1), N))); \
349
1.55k
    return MCDisassembler_Success; \
350
1.55k
  }
RISCVDisassembler.c:decodeSImmOperandAndLsl1_9
Line
Count
Source
345
2.03k
  { \
346
2.03k
    CS_ASSERT(isUIntN(N, Imm) && "Invalid immediate"); \
347
2.03k
\
348
2.03k
    MCOperand_CreateImm0(Inst, (SignExtend64((Imm << 1), N))); \
349
2.03k
    return MCDisassembler_Success; \
350
2.03k
  }
RISCVDisassembler.c:decodeSImmOperandAndLsl1_13
Line
Count
Source
345
955
  { \
346
955
    CS_ASSERT(isUIntN(N, Imm) && "Invalid immediate"); \
347
955
\
348
955
    MCOperand_CreateImm0(Inst, (SignExtend64((Imm << 1), N))); \
349
955
    return MCDisassembler_Success; \
350
955
  }
RISCVDisassembler.c:decodeSImmOperandAndLsl1_21
Line
Count
Source
345
892
  { \
346
892
    CS_ASSERT(isUIntN(N, Imm) && "Invalid immediate"); \
347
892
\
348
892
    MCOperand_CreateImm0(Inst, (SignExtend64((Imm << 1), N))); \
349
892
    return MCDisassembler_Success; \
350
892
  }
351
DEFINE_decodeSImmOperandAndLsl1(12);
352
DEFINE_decodeSImmOperandAndLsl1(9);
353
DEFINE_decodeSImmOperandAndLsl1(13);
354
DEFINE_decodeSImmOperandAndLsl1(21);
355
356
static DecodeStatus decodeCLUIImmOperand(MCInst *Inst, uint32_t Imm,
357
           int64_t Address, const void *Decoder)
358
1.62k
{
359
1.62k
  CS_ASSERT(isUIntN(6, Imm) && "Invalid immediate");
360
1.62k
  if (Imm > 31) {
361
897
    Imm = (SignExtend64((Imm), 6) & 0xfffff);
362
897
  }
363
1.62k
  MCOperand_CreateImm0(Inst, (Imm));
364
1.62k
  return MCDisassembler_Success;
365
1.62k
}
366
367
static DecodeStatus decodeFRMArg(MCInst *Inst, uint32_t Imm, int64_t Address,
368
         const void *Decoder)
369
16.3k
{
370
16.3k
  CS_ASSERT(isUIntN(3, Imm) && "Invalid immediate");
371
16.3k
  if (!RISCVFPRndMode_isValidRoundingMode(Imm))
372
30
    return MCDisassembler_Fail;
373
374
16.3k
  MCOperand_CreateImm0(Inst, (Imm));
375
16.3k
  return MCDisassembler_Success;
376
16.3k
}
377
378
static DecodeStatus decodeRVCInstrRdRs1ImmZero(MCInst *Inst, uint32_t Insn,
379
                 uint64_t Address,
380
                 const void *Decoder);
381
382
static DecodeStatus decodeRVCInstrRdSImm(MCInst *Inst, uint32_t Insn,
383
           uint64_t Address, const void *Decoder);
384
385
static DecodeStatus decodeRVCInstrRdRs1UImm(MCInst *Inst, uint32_t Insn,
386
              uint64_t Address,
387
              const void *Decoder);
388
389
static DecodeStatus decodeRVCInstrRdRs2(MCInst *Inst, uint32_t Insn,
390
          uint64_t Address, const void *Decoder);
391
392
static DecodeStatus decodeRVCInstrRdRs1Rs2(MCInst *Inst, uint32_t Insn,
393
             uint64_t Address,
394
             const void *Decoder);
395
396
static DecodeStatus decodeXTHeadMemPair(MCInst *Inst, uint32_t Insn,
397
          uint64_t Address, const void *Decoder);
398
399
static DecodeStatus decodeZcmpRlist(MCInst *Inst, unsigned Imm,
400
            uint64_t Address, const void *Decoder);
401
402
static DecodeStatus decodeRegReg(MCInst *Inst, uint32_t Insn, uint64_t Address,
403
         const void *Decoder);
404
405
static DecodeStatus decodeZcmpSpimm(MCInst *Inst, unsigned Imm,
406
            uint64_t Address, const void *Decoder);
407
408
static DecodeStatus decodeCSSPushPopchk(MCInst *Inst, uint32_t Insn,
409
          uint64_t Address, const void *Decoder);
410
411
static DecodeStatus decodeUImmLog2XLenOperand(MCInst *Inst, uint32_t Imm,
412
                int64_t Address,
413
                const void *Decoder)
414
2.14k
{
415
2.14k
  CS_ASSERT(isUIntN(6, Imm) && "Invalid immediate");
416
417
2.14k
  if (!RISCV_getFeatureBits(Inst->csh->mode, RISCV_Feature64Bit) &&
418
568
      !isUIntN(5, Imm))
419
11
    return MCDisassembler_Fail;
420
421
2.13k
  MCOperand_CreateImm0(Inst, (Imm));
422
2.13k
  return MCDisassembler_Success;
423
2.14k
}
424
425
static DecodeStatus decodeUImmLog2XLenNonZeroOperand(MCInst *Inst, uint32_t Imm,
426
                 int64_t Address,
427
                 const void *Decoder)
428
2.00k
{
429
2.00k
  if (Imm == 0)
430
0
    return MCDisassembler_Fail;
431
2.00k
  return decodeUImmLog2XLenOperand(Inst, Imm, Address, Decoder);
432
2.00k
}
433
434
#include "RISCVGenDisassemblerTables.inc"
435
436
static DecodeStatus decodeRVCInstrRdRs1ImmZero(MCInst *Inst, uint32_t Insn,
437
                 uint64_t Address,
438
                 const void *Decoder)
439
587
{
440
587
  uint32_t Rd = fieldFromInstruction_4(Insn, 7, 5);
441
587
  DecodeStatus Result =
442
587
    DecodeGPRNoX0RegisterClass(Inst, Rd, Address, Decoder);
443
587
  (void)Result;
444
587
  CS_ASSERT(Result == MCDisassembler_Success && "Invalid register");
445
587
  MCInst_addOperand2(Inst, (MCInst_getOperand(Inst, (0))));
446
587
  MCOperand_CreateImm0(Inst, (0));
447
587
  return MCDisassembler_Success;
448
587
}
449
450
static DecodeStatus decodeCSSPushPopchk(MCInst *Inst, uint32_t Insn,
451
          uint64_t Address, const void *Decoder)
452
0
{
453
0
  uint32_t Rs1 = fieldFromInstruction_4(Insn, 7, 5);
454
0
  DecodeStatus Result =
455
0
    DecodeGPRX1X5RegisterClass(Inst, Rs1, Address, Decoder);
456
0
  (void)Result;
457
0
  CS_ASSERT(Result == MCDisassembler_Success && "Invalid register");
458
0
  return MCDisassembler_Success;
459
0
}
460
461
static DecodeStatus decodeRVCInstrRdSImm(MCInst *Inst, uint32_t Insn,
462
           uint64_t Address, const void *Decoder)
463
144
{
464
144
  MCOperand_CreateReg0(Inst, (RISCV_X0));
465
144
  uint32_t SImm6 = fieldFromInstruction_4(Insn, 12, 1) << 5 |
466
144
       fieldFromInstruction_4(Insn, 2, 5);
467
144
  DecodeStatus Result =
468
144
    CONCAT(decodeSImmOperand, 6)(Inst, SImm6, Address, Decoder);
469
144
  (void)Result;
470
144
  CS_ASSERT(Result == MCDisassembler_Success && "Invalid immediate");
471
144
  return MCDisassembler_Success;
472
144
}
473
474
static DecodeStatus decodeRVCInstrRdRs1UImm(MCInst *Inst, uint32_t Insn,
475
              uint64_t Address,
476
              const void *Decoder)
477
929
{
478
929
  MCOperand_CreateReg0(Inst, (RISCV_X0));
479
929
  MCInst_addOperand2(Inst, (MCInst_getOperand(Inst, (0))));
480
929
  uint32_t UImm6 = fieldFromInstruction_4(Insn, 12, 1) << 5 |
481
929
       fieldFromInstruction_4(Insn, 2, 5);
482
929
  DecodeStatus Result =
483
929
    CONCAT(decodeUImmOperand, 6)(Inst, UImm6, Address, Decoder);
484
929
  (void)Result;
485
929
  CS_ASSERT(Result == MCDisassembler_Success && "Invalid immediate");
486
929
  return MCDisassembler_Success;
487
929
}
488
489
static DecodeStatus decodeRVCInstrRdRs2(MCInst *Inst, uint32_t Insn,
490
          uint64_t Address, const void *Decoder)
491
31
{
492
31
  uint32_t Rd = fieldFromInstruction_4(Insn, 7, 5);
493
31
  uint32_t Rs2 = fieldFromInstruction_4(Insn, 2, 5);
494
31
  DecodeGPRRegisterClass(Inst, Rd, Address, Decoder);
495
31
  DecodeGPRRegisterClass(Inst, Rs2, Address, Decoder);
496
31
  return MCDisassembler_Success;
497
31
}
498
499
static DecodeStatus decodeRVCInstrRdRs1Rs2(MCInst *Inst, uint32_t Insn,
500
             uint64_t Address,
501
             const void *Decoder)
502
80
{
503
80
  uint32_t Rd = fieldFromInstruction_4(Insn, 7, 5);
504
80
  uint32_t Rs2 = fieldFromInstruction_4(Insn, 2, 5);
505
80
  DecodeGPRRegisterClass(Inst, Rd, Address, Decoder);
506
80
  MCInst_addOperand2(Inst, (MCInst_getOperand(Inst, (0))));
507
80
  DecodeGPRRegisterClass(Inst, Rs2, Address, Decoder);
508
80
  return MCDisassembler_Success;
509
80
}
510
511
static DecodeStatus decodeXTHeadMemPair(MCInst *Inst, uint32_t Insn,
512
          uint64_t Address, const void *Decoder)
513
0
{
514
0
  uint32_t Rd1 = fieldFromInstruction_4(Insn, 7, 5);
515
0
  uint32_t Rs1 = fieldFromInstruction_4(Insn, 15, 5);
516
0
  uint32_t Rd2 = fieldFromInstruction_4(Insn, 20, 5);
517
0
  uint32_t UImm2 = fieldFromInstruction_4(Insn, 25, 2);
518
0
  DecodeGPRRegisterClass(Inst, Rd1, Address, Decoder);
519
0
  DecodeGPRRegisterClass(Inst, Rd2, Address, Decoder);
520
0
  DecodeGPRRegisterClass(Inst, Rs1, Address, Decoder);
521
0
  DecodeStatus Result =
522
0
    CONCAT(decodeUImmOperand, 2)(Inst, UImm2, Address, Decoder);
523
0
  (void)Result;
524
0
  CS_ASSERT(Result == MCDisassembler_Success && "Invalid immediate");
525
526
  // Disassemble the final operand which is implicit.
527
0
  unsigned Opcode = MCInst_getOpcode(Inst);
528
0
  bool IsWordOp = (Opcode == RISCV_TH_LWD || Opcode == RISCV_TH_LWUD ||
529
0
       Opcode == RISCV_TH_SWD);
530
0
  if (IsWordOp)
531
0
    MCOperand_CreateImm0(Inst, (3));
532
0
  else
533
0
    MCOperand_CreateImm0(Inst, (4));
534
535
0
  return MCDisassembler_Success;
536
0
}
537
538
static DecodeStatus decodeZcmpRlist(MCInst *Inst, unsigned Imm,
539
            uint64_t Address, const void *Decoder)
540
0
{
541
0
  if (Imm <= 3)
542
0
    return MCDisassembler_Fail;
543
0
  MCOperand_CreateImm0(Inst, (Imm));
544
0
  return MCDisassembler_Success;
545
0
}
546
547
static DecodeStatus decodeRegReg(MCInst *Inst, uint32_t Insn, uint64_t Address,
548
         const void *Decoder)
549
766
{
550
766
  uint32_t Rs1 = fieldFromInstruction_4(Insn, 0, 5);
551
766
  uint32_t Rs2 = fieldFromInstruction_4(Insn, 5, 5);
552
766
  DecodeGPRRegisterClass(Inst, Rs1, Address, Decoder);
553
766
  DecodeGPRRegisterClass(Inst, Rs2, Address, Decoder);
554
766
  return MCDisassembler_Success;
555
766
}
556
557
static DecodeStatus decodeZcmpSpimm(MCInst *Inst, unsigned Imm,
558
            uint64_t Address, const void *Decoder)
559
0
{
560
0
  MCOperand_CreateImm0(Inst, (Imm));
561
0
  return MCDisassembler_Success;
562
0
}
563
564
// Add implied SP operand for C.*SP compressed instructions. The SP operand
565
// isn't explicitly encoded in the instruction.
566
void addSPOperands(MCInst *MI)
567
34.8k
{
568
34.8k
  const MCInstrDesc *MCID = MCInstrDesc_get(MCInst_getOpcode(MI),
569
34.8k
              RISCVDescs.Insts,
570
34.8k
              ARR_SIZE(RISCVDescs.Insts));
571
34.8k
  MCOperand SPReg;
572
34.8k
  SPReg.MachineOperandType = kRegister;
573
34.8k
  SPReg.Kind = kRegister;
574
34.8k
  SPReg.RegVal = RISCV_X2;
575
119k
  for (unsigned i = 0; i < MCID->NumOperands; i++)
576
84.3k
    if (MCID->OpInfo[i].RegClass == RISCV_SPRegClassID)
577
7.97k
      MCInst_insert0(MI, i, &SPReg);
578
34.8k
}
579
580
DecodeStatus RISCV_getInstruction(MCInst *MI, uint16_t *Size,
581
          const uint8_t *Bytes, size_t BytesLen,
582
          uint64_t Address, SStream *CS)
583
63.1k
{
584
  // TODO: This will need modification when supporting instruction set
585
  // extensions with instructions > 32-bits (up to 176 bits wide).
586
63.1k
  uint32_t Insn;
587
63.1k
  DecodeStatus Result;
588
589
63.1k
#define TRY_TO_DECODE_WITH_ADDITIONAL_OPERATION( \
590
63.1k
  width, FEATURE_CHECKS, DECODER_TABLE, DESC, ADDITIONAL_OPERATION) \
591
925k
  do { \
592
1.00M
    if (FEATURE_CHECKS) { \
593
272k
      Result = decodeInstruction_##width( \
594
272k
        DECODER_TABLE, MI, Insn, Address, NULL); \
595
272k
      if (Result != MCDisassembler_Fail) { \
596
62.0k
        ADDITIONAL_OPERATION; \
597
62.0k
        return Result; \
598
62.0k
      } \
599
272k
    } \
600
925k
  } while (false)
601
63.1k
#define TRY_TO_DECODE_AND_ADD_SP(width, FEATURE_CHECKS, DECODER_TABLE, DESC) \
602
69.1k
  TRY_TO_DECODE_WITH_ADDITIONAL_OPERATION( \
603
69.1k
    width, FEATURE_CHECKS, DECODER_TABLE, DESC, addSPOperands(MI))
604
63.1k
#define TRY_TO_DECODE(width, FEATURE_CHECKS, DECODER_TABLE, DESC) \
605
855k
  TRY_TO_DECODE_WITH_ADDITIONAL_OPERATION( \
606
855k
    width, FEATURE_CHECKS, DECODER_TABLE, DESC, (void)NULL)
607
63.1k
#define TRY_TO_DECODE_FEATURE(width, FEATURE, DECODER_TABLE, DESC) \
608
776k
  TRY_TO_DECODE(width, RISCV_getFeatureBits(MI->csh->mode, FEATURE), \
609
776k
          DECODER_TABLE, DESC)
610
611
  // It's a 32 bit instruction if bit 0 and 1 are 1.
612
63.1k
  if ((Bytes[0] & 0x3) == 0x3) {
613
27.7k
    if (BytesLen < 4) {
614
238
      *Size = 0;
615
238
      return MCDisassembler_Fail;
616
238
    }
617
27.5k
    *Size = 4;
618
619
27.5k
    Insn = readBytes32(MI, Bytes);
620
621
27.5k
    TRY_TO_DECODE(4,
622
27.5k
            RISCV_getFeatureBits(MI->csh->mode,
623
27.5k
               RISCV_FeatureStdExtZdinx) &&
624
27.5k
              !RISCV_getFeatureBits(MI->csh->mode,
625
27.5k
                  RISCV_Feature64Bit),
626
27.5k
            DecoderTableRV32Zdinx32,
627
27.5k
            "RV32Zdinx table (Double in Integer and rv32)");
628
27.5k
    TRY_TO_DECODE(4,
629
27.4k
            RISCV_getFeatureBits(MI->csh->mode,
630
27.4k
               RISCV_FeatureStdExtZacas) &&
631
27.4k
              !RISCV_getFeatureBits(MI->csh->mode,
632
27.4k
                  RISCV_Feature64Bit),
633
27.4k
            DecoderTableRV32Zacas32,
634
27.4k
            "RV32Zacas table (Compare-And-Swap and rv32)");
635
27.4k
    TRY_TO_DECODE_FEATURE(4, RISCV_FeatureStdExtZfinx,
636
27.4k
              DecoderTableRVZfinx32,
637
27.4k
              "RVZfinx table (Float in Integer)");
638
27.4k
    TRY_TO_DECODE_FEATURE(4, RISCV_FeatureVendorXVentanaCondOps,
639
27.3k
              DecoderTableXVentana32,
640
27.3k
              "Ventana custom opcode table");
641
27.3k
    TRY_TO_DECODE_FEATURE(4, RISCV_FeatureVendorXTHeadBa,
642
27.3k
              DecoderTableXTHeadBa32,
643
27.3k
              "XTHeadBa custom opcode table");
644
27.3k
    TRY_TO_DECODE_FEATURE(4, RISCV_FeatureVendorXTHeadBb,
645
27.3k
              DecoderTableXTHeadBb32,
646
27.3k
              "XTHeadBb custom opcode table");
647
27.3k
    TRY_TO_DECODE_FEATURE(4, RISCV_FeatureVendorXTHeadBs,
648
27.3k
              DecoderTableXTHeadBs32,
649
27.3k
              "XTHeadBs custom opcode table");
650
27.3k
    TRY_TO_DECODE_FEATURE(4, RISCV_FeatureVendorXTHeadCondMov,
651
27.3k
              DecoderTableXTHeadCondMov32,
652
27.3k
              "XTHeadCondMov custom opcode table");
653
27.3k
    TRY_TO_DECODE_FEATURE(4, RISCV_FeatureVendorXTHeadCmo,
654
27.3k
              DecoderTableXTHeadCmo32,
655
27.3k
              "XTHeadCmo custom opcode table");
656
27.3k
    TRY_TO_DECODE_FEATURE(4, RISCV_FeatureVendorXTHeadFMemIdx,
657
27.3k
              DecoderTableXTHeadFMemIdx32,
658
27.3k
              "XTHeadFMemIdx custom opcode table");
659
27.3k
    TRY_TO_DECODE_FEATURE(4, RISCV_FeatureVendorXTHeadMac,
660
27.3k
              DecoderTableXTHeadMac32,
661
27.3k
              "XTHeadMac custom opcode table");
662
27.3k
    TRY_TO_DECODE_FEATURE(4, RISCV_FeatureVendorXTHeadMemIdx,
663
27.3k
              DecoderTableXTHeadMemIdx32,
664
27.3k
              "XTHeadMemIdx custom opcode table");
665
27.3k
    TRY_TO_DECODE_FEATURE(4, RISCV_FeatureVendorXTHeadMemPair,
666
27.3k
              DecoderTableXTHeadMemPair32,
667
27.3k
              "XTHeadMemPair custom opcode table");
668
27.3k
    TRY_TO_DECODE_FEATURE(4, RISCV_FeatureVendorXTHeadSync,
669
27.3k
              DecoderTableXTHeadSync32,
670
27.3k
              "XTHeadSync custom opcode table");
671
27.3k
    TRY_TO_DECODE_FEATURE(4, RISCV_FeatureVendorXTHeadVdot,
672
27.3k
              DecoderTableXTHeadVdot32,
673
27.3k
              "XTHeadVdot custom opcode table");
674
27.3k
    TRY_TO_DECODE_FEATURE(4, RISCV_FeatureVendorXSfvcp,
675
27.3k
              DecoderTableXSfvcp32,
676
27.3k
              "SiFive VCIX custom opcode table");
677
27.3k
    TRY_TO_DECODE_FEATURE(
678
27.3k
      4, RISCV_FeatureVendorXSfvqmaccdod,
679
27.3k
      DecoderTableXSfvqmaccdod32,
680
27.3k
      "SiFive Matrix Multiplication (2x8 and 8x2) Instruction opcode table");
681
27.3k
    TRY_TO_DECODE_FEATURE(
682
27.3k
      4, RISCV_FeatureVendorXSfvqmaccqoq,
683
27.3k
      DecoderTableXSfvqmaccqoq32,
684
27.3k
      "SiFive Matrix Multiplication (4x8 and 8x4) Instruction opcode table");
685
27.3k
    TRY_TO_DECODE_FEATURE(
686
27.3k
      4, RISCV_FeatureVendorXSfvfwmaccqqq,
687
27.3k
      DecoderTableXSfvfwmaccqqq32,
688
27.3k
      "SiFive Matrix Multiplication Instruction opcode table");
689
27.3k
    TRY_TO_DECODE_FEATURE(
690
27.3k
      4, RISCV_FeatureVendorXSfvfnrclipxfqf,
691
27.3k
      DecoderTableXSfvfnrclipxfqf32,
692
27.3k
      "SiFive FP32-to-int8 Ranged Clip Instructions opcode table");
693
27.3k
    TRY_TO_DECODE_FEATURE(
694
27.0k
      4, RISCV_FeatureVendorXCVbitmanip,
695
27.0k
      DecoderTableXCVbitmanip32,
696
27.0k
      "CORE-V Bit Manipulation custom opcode table");
697
27.0k
    TRY_TO_DECODE_FEATURE(4, RISCV_FeatureVendorXCVelw,
698
27.0k
              DecoderTableXCVelw32,
699
27.0k
              "CORE-V Event load custom opcode table");
700
27.0k
    TRY_TO_DECODE_FEATURE(4, RISCV_FeatureVendorXCVmac,
701
26.2k
              DecoderTableXCVmac32,
702
26.2k
              "CORE-V MAC custom opcode table");
703
26.2k
    TRY_TO_DECODE_FEATURE(4, RISCV_FeatureVendorXCVmem,
704
24.8k
              DecoderTableXCVmem32,
705
24.8k
              "CORE-V MEM custom opcode table");
706
24.8k
    TRY_TO_DECODE_FEATURE(4, RISCV_FeatureVendorXCValu,
707
24.6k
              DecoderTableXCValu32,
708
24.6k
              "CORE-V ALU custom opcode table");
709
24.6k
    TRY_TO_DECODE_FEATURE(
710
24.2k
      4, RISCV_FeatureVendorXCVsimd, DecoderTableXCVsimd32,
711
24.2k
      "CORE-V SIMD extensions custom opcode table");
712
24.2k
    TRY_TO_DECODE_FEATURE(
713
24.2k
      4, RISCV_FeatureVendorXCVbi, DecoderTableXCVbi32,
714
24.2k
      "CORE-V Immediate Branching custom opcode table");
715
24.2k
    TRY_TO_DECODE(4, true, DecoderTable32, "RISCV32 table");
716
717
333
    return MCDisassembler_Fail;
718
24.2k
  }
719
720
35.3k
  if (BytesLen < 2) {
721
230
    *Size = 0;
722
230
    return MCDisassembler_Fail;
723
230
  }
724
35.1k
  *Size = 2;
725
726
35.1k
  Insn = readBytes16(MI, Bytes);
727
35.1k
  TRY_TO_DECODE_AND_ADD_SP(
728
34.0k
    2, !RISCV_getFeatureBits(MI->csh->mode, RISCV_Feature64Bit),
729
34.0k
    DecoderTableRISCV32Only_16,
730
34.0k
    "RISCV32Only_16 table (16-bit Instruction)");
731
34.0k
  TRY_TO_DECODE_FEATURE(2, RISCV_FeatureStdExtZicfiss,
732
34.0k
            DecoderTableZicfiss16,
733
34.0k
            "RVZicfiss table (Shadow Stack)");
734
34.0k
  TRY_TO_DECODE_FEATURE(2, RISCV_FeatureStdExtZcmt, DecoderTableRVZcmt16,
735
34.0k
            "Zcmt table (16-bit Table Jump Instructions)");
736
34.0k
  TRY_TO_DECODE_FEATURE(
737
34.0k
    2, RISCV_FeatureStdExtZcmp, DecoderTableRVZcmp16,
738
34.0k
    "Zcmp table (16-bit Push/Pop & Double Move Instructions)");
739
34.0k
  TRY_TO_DECODE_AND_ADD_SP(2, true, DecoderTable16,
740
266
         "RISCV_C table (16-bit Instruction)");
741
742
266
  return MCDisassembler_Fail;
743
34.0k
}
744
745
bool RISCV_LLVM_getInstruction(csh handle, const uint8_t *Bytes, size_t ByteLen,
746
             MCInst *MI, uint16_t *Size, uint64_t Address,
747
             void *Info)
748
63.1k
{
749
63.1k
  RISCV_init_cs_detail(MI);
750
63.1k
  MI->MRI = (MCRegisterInfo *)Info;
751
  return RISCV_getInstruction(MI, Size, Bytes, ByteLen, Address, NULL) !=
752
63.1k
         MCDisassembler_Fail;
753
63.1k
}