]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blame - opcodes/riscv-dis.c
RISC-V: Minimal support of scalar crypto extension.
[thirdparty/binutils-gdb.git] / opcodes / riscv-dis.c
CommitLineData
e23eba97 1/* RISC-V disassembler
250d07de 2 Copyright (C) 2011-2021 Free Software Foundation, Inc.
e23eba97
NC
3
4 Contributed by Andrew Waterman (andrew@sifive.com).
5 Based on MIPS target.
6
7 This file is part of the GNU opcodes library.
8
9 This library is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3, or (at your option)
12 any later version.
13
14 It is distributed in the hope that it will be useful, but WITHOUT
15 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
16 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
17 License for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with this program; see the file COPYING3. If not,
21 see <http://www.gnu.org/licenses/>. */
22
23#include "sysdep.h"
88c1242d 24#include "disassemble.h"
e23eba97
NC
25#include "libiberty.h"
26#include "opcode/riscv.h"
27#include "opintl.h"
28#include "elf-bfd.h"
29#include "elf/riscv.h"
f786c359 30#include "elfxx-riscv.h"
e23eba97 31
3dfb1b6d 32#include <stdint.h>
e23eba97
NC
33#include <ctype.h>
34
f786c359 35static enum riscv_spec_class default_isa_spec = ISA_SPEC_CLASS_DRAFT - 1;
3d73d29e 36static enum riscv_spec_class default_priv_spec = PRIV_SPEC_CLASS_NONE;
8f595e9b 37
f786c359
NC
38unsigned xlen = 0;
39
40static riscv_subset_list_t riscv_subsets;
41static riscv_parse_subset_t riscv_rps_dis =
42{
43 &riscv_subsets, /* subset_list. */
44 opcodes_error_handler,/* error_handler. */
45 &xlen, /* xlen. */
46 &default_isa_spec, /* isa_spec. */
47 false, /* check_unknown_prefixed_ext. */
48};
49
e23eba97
NC
50struct riscv_private_data
51{
52 bfd_vma gp;
53 bfd_vma print_addr;
54 bfd_vma hi_addr[OP_MASK_RD + 1];
55};
56
9b9b1092
NC
57/* Used for mapping symbols. */
58static int last_map_symbol = -1;
59static bfd_vma last_stop_offset = 0;
60enum riscv_seg_mstate last_map_state;
61
e23eba97
NC
62static const char * const *riscv_gpr_names;
63static const char * const *riscv_fpr_names;
64
dcd709e0
NC
65/* If set, disassemble as most general instruction. */
66static int no_aliases;
e23eba97
NC
67
68static void
69set_default_riscv_dis_options (void)
70{
71 riscv_gpr_names = riscv_gpr_names_abi;
72 riscv_fpr_names = riscv_fpr_names_abi;
73 no_aliases = 0;
74}
75
78933a4a 76static bool
8f595e9b 77parse_riscv_dis_option_without_args (const char *option)
e23eba97
NC
78{
79 if (strcmp (option, "no-aliases") == 0)
80 no_aliases = 1;
81 else if (strcmp (option, "numeric") == 0)
82 {
83 riscv_gpr_names = riscv_gpr_names_numeric;
84 riscv_fpr_names = riscv_fpr_names_numeric;
85 }
8f595e9b 86 else
78933a4a
AM
87 return false;
88 return true;
8f595e9b
NC
89}
90
91static void
92parse_riscv_dis_option (const char *option)
93{
94 char *equal, *value;
95
96 if (parse_riscv_dis_option_without_args (option))
97 return;
98
99 equal = strchr (option, '=');
100 if (equal == NULL)
101 {
102 /* The option without '=' should be defined above. */
103 opcodes_error_handler (_("unrecognized disassembler option: %s"), option);
104 return;
105 }
106 if (equal == option
107 || *(equal + 1) == '\0')
108 {
109 /* Invalid options with '=', no option name before '=',
110 and no value after '='. */
111 opcodes_error_handler (_("unrecognized disassembler option with '=': %s"),
112 option);
113 return;
114 }
115
116 *equal = '\0';
117 value = equal + 1;
118 if (strcmp (option, "priv-spec") == 0)
119 {
3d73d29e
NC
120 enum riscv_spec_class priv_spec = PRIV_SPEC_CLASS_NONE;
121 const char *name = NULL;
122
123 RISCV_GET_PRIV_SPEC_CLASS (value, priv_spec);
124 if (priv_spec == PRIV_SPEC_CLASS_NONE)
b800637e 125 opcodes_error_handler (_("unknown privileged spec set by %s=%s"),
8152e040
NC
126 option, value);
127 else if (default_priv_spec == PRIV_SPEC_CLASS_NONE)
128 default_priv_spec = priv_spec;
129 else if (default_priv_spec != priv_spec)
3d73d29e
NC
130 {
131 RISCV_GET_PRIV_SPEC_NAME (name, default_priv_spec);
132 opcodes_error_handler (_("mis-matched privilege spec set by %s=%s, "
133 "the elf privilege attribute is %s"),
134 option, value, name);
135 }
8f595e9b 136 }
e23eba97
NC
137 else
138 {
a6743a54
AM
139 /* xgettext:c-format */
140 opcodes_error_handler (_("unrecognized disassembler option: %s"), option);
e23eba97
NC
141 }
142}
143
144static void
145parse_riscv_dis_options (const char *opts_in)
146{
147 char *opts = xstrdup (opts_in), *opt = opts, *opt_end = opts;
148
149 set_default_riscv_dis_options ();
150
151 for ( ; opt_end != NULL; opt = opt_end + 1)
152 {
153 if ((opt_end = strchr (opt, ',')) != NULL)
154 *opt_end = 0;
155 parse_riscv_dis_option (opt);
156 }
157
158 free (opts);
159}
160
161/* Print one argument from an array. */
162
163static void
164arg_print (struct disassemble_info *info, unsigned long val,
165 const char* const* array, size_t size)
166{
167 const char *s = val >= size || array[val] == NULL ? "unknown" : array[val];
168 (*info->fprintf_func) (info->stream, "%s", s);
169}
170
171static void
c7dee848
JW
172maybe_print_address (struct riscv_private_data *pd, int base_reg, int offset,
173 int wide)
e23eba97
NC
174{
175 if (pd->hi_addr[base_reg] != (bfd_vma)-1)
176 {
35fd2b2b 177 pd->print_addr = (base_reg != 0 ? pd->hi_addr[base_reg] : 0) + offset;
e23eba97
NC
178 pd->hi_addr[base_reg] = -1;
179 }
180 else if (base_reg == X_GP && pd->gp != (bfd_vma)-1)
181 pd->print_addr = pd->gp + offset;
182 else if (base_reg == X_TP || base_reg == 0)
183 pd->print_addr = offset;
c7dee848
JW
184
185 /* Sign-extend a 32-bit value to a 64-bit value. */
186 if (wide)
187 pd->print_addr = (bfd_vma)(int32_t) pd->print_addr;
e23eba97
NC
188}
189
190/* Print insn arguments for 32/64-bit code. */
191
192static void
437e2ff1 193print_insn_args (const char *oparg, insn_t l, bfd_vma pc, disassemble_info *info)
e23eba97
NC
194{
195 struct riscv_private_data *pd = info->private_data;
196 int rs1 = (l >> OP_SH_RS1) & OP_MASK_RS1;
197 int rd = (l >> OP_SH_RD) & OP_MASK_RD;
198 fprintf_ftype print = info->fprintf_func;
437e2ff1 199 const char *opargStart;
e23eba97 200
437e2ff1 201 if (*oparg != '\0')
e23eba97
NC
202 print (info->stream, "\t");
203
437e2ff1 204 for (; *oparg != '\0'; oparg++)
e23eba97 205 {
437e2ff1
NC
206 opargStart = oparg;
207 switch (*oparg)
e23eba97
NC
208 {
209 case 'C': /* RVC */
437e2ff1 210 switch (*++oparg)
e23eba97 211 {
dcd709e0
NC
212 case 's': /* RS1 x8-x15. */
213 case 'w': /* RS1 x8-x15. */
e23eba97
NC
214 print (info->stream, "%s",
215 riscv_gpr_names[EXTRACT_OPERAND (CRS1S, l) + 8]);
216 break;
dcd709e0
NC
217 case 't': /* RS2 x8-x15. */
218 case 'x': /* RS2 x8-x15. */
e23eba97
NC
219 print (info->stream, "%s",
220 riscv_gpr_names[EXTRACT_OPERAND (CRS2S, l) + 8]);
221 break;
dcd709e0 222 case 'U': /* RS1, constrained to equal RD. */
e23eba97
NC
223 print (info->stream, "%s", riscv_gpr_names[rd]);
224 break;
dcd709e0 225 case 'c': /* RS1, constrained to equal sp. */
e23eba97
NC
226 print (info->stream, "%s", riscv_gpr_names[X_SP]);
227 break;
228 case 'V': /* RS2 */
229 print (info->stream, "%s",
230 riscv_gpr_names[EXTRACT_OPERAND (CRS2, l)]);
231 break;
f91d48de 232 case 'o':
e23eba97 233 case 'j':
c7dee848
JW
234 if (((l & MASK_C_ADDI) == MATCH_C_ADDI) && rd != 0)
235 maybe_print_address (pd, rd, EXTRACT_CITYPE_IMM (l), 0);
236 if (info->mach == bfd_mach_riscv64
237 && ((l & MASK_C_ADDIW) == MATCH_C_ADDIW) && rd != 0)
238 maybe_print_address (pd, rd, EXTRACT_CITYPE_IMM (l), 1);
5a9f5403 239 print (info->stream, "%d", (int)EXTRACT_CITYPE_IMM (l));
e23eba97
NC
240 break;
241 case 'k':
5a9f5403 242 print (info->stream, "%d", (int)EXTRACT_CLTYPE_LW_IMM (l));
e23eba97
NC
243 break;
244 case 'l':
5a9f5403 245 print (info->stream, "%d", (int)EXTRACT_CLTYPE_LD_IMM (l));
e23eba97
NC
246 break;
247 case 'm':
5a9f5403 248 print (info->stream, "%d", (int)EXTRACT_CITYPE_LWSP_IMM (l));
e23eba97
NC
249 break;
250 case 'n':
5a9f5403 251 print (info->stream, "%d", (int)EXTRACT_CITYPE_LDSP_IMM (l));
e23eba97
NC
252 break;
253 case 'K':
5a9f5403 254 print (info->stream, "%d", (int)EXTRACT_CIWTYPE_ADDI4SPN_IMM (l));
e23eba97
NC
255 break;
256 case 'L':
5a9f5403 257 print (info->stream, "%d", (int)EXTRACT_CITYPE_ADDI16SP_IMM (l));
e23eba97
NC
258 break;
259 case 'M':
5a9f5403 260 print (info->stream, "%d", (int)EXTRACT_CSSTYPE_SWSP_IMM (l));
e23eba97
NC
261 break;
262 case 'N':
5a9f5403 263 print (info->stream, "%d", (int)EXTRACT_CSSTYPE_SDSP_IMM (l));
e23eba97
NC
264 break;
265 case 'p':
5a9f5403 266 info->target = EXTRACT_CBTYPE_IMM (l) + pc;
e23eba97
NC
267 (*info->print_address_func) (info->target, info);
268 break;
269 case 'a':
5a9f5403 270 info->target = EXTRACT_CJTYPE_IMM (l) + pc;
e23eba97
NC
271 (*info->print_address_func) (info->target, info);
272 break;
273 case 'u':
274 print (info->stream, "0x%x",
5a9f5403 275 (int)(EXTRACT_CITYPE_IMM (l) & (RISCV_BIGIMM_REACH-1)));
e23eba97
NC
276 break;
277 case '>':
5a9f5403 278 print (info->stream, "0x%x", (int)EXTRACT_CITYPE_IMM (l) & 0x3f);
e23eba97
NC
279 break;
280 case '<':
5a9f5403 281 print (info->stream, "0x%x", (int)EXTRACT_CITYPE_IMM (l) & 0x1f);
e23eba97 282 break;
dcd709e0 283 case 'T': /* Floating-point RS2. */
e23eba97
NC
284 print (info->stream, "%s",
285 riscv_fpr_names[EXTRACT_OPERAND (CRS2, l)]);
286 break;
dcd709e0 287 case 'D': /* Floating-point RS2 x8-x15. */
e23eba97
NC
288 print (info->stream, "%s",
289 riscv_fpr_names[EXTRACT_OPERAND (CRS2S, l) + 8]);
290 break;
291 }
292 break;
293
294 case ',':
295 case '(':
296 case ')':
297 case '[':
298 case ']':
437e2ff1 299 print (info->stream, "%c", *oparg);
e23eba97
NC
300 break;
301
302 case '0':
dcd709e0 303 /* Only print constant 0 if it is the last argument. */
437e2ff1 304 if (!oparg[1])
e23eba97
NC
305 print (info->stream, "0");
306 break;
307
308 case 'b':
309 case 's':
35eeb78f 310 if ((l & MASK_JALR) == MATCH_JALR)
c7dee848 311 maybe_print_address (pd, rs1, 0, 0);
e23eba97
NC
312 print (info->stream, "%s", riscv_gpr_names[rs1]);
313 break;
314
315 case 't':
316 print (info->stream, "%s",
317 riscv_gpr_names[EXTRACT_OPERAND (RS2, l)]);
318 break;
319
320 case 'u':
321 print (info->stream, "0x%x",
322 (unsigned)EXTRACT_UTYPE_IMM (l) >> RISCV_IMM_BITS);
323 break;
324
325 case 'm':
326 arg_print (info, EXTRACT_OPERAND (RM, l),
327 riscv_rm, ARRAY_SIZE (riscv_rm));
328 break;
329
330 case 'P':
331 arg_print (info, EXTRACT_OPERAND (PRED, l),
332 riscv_pred_succ, ARRAY_SIZE (riscv_pred_succ));
333 break;
334
335 case 'Q':
336 arg_print (info, EXTRACT_OPERAND (SUCC, l),
337 riscv_pred_succ, ARRAY_SIZE (riscv_pred_succ));
338 break;
339
340 case 'o':
c7dee848 341 maybe_print_address (pd, rs1, EXTRACT_ITYPE_IMM (l), 0);
b52d3cfc 342 /* Fall through. */
e23eba97
NC
343 case 'j':
344 if (((l & MASK_ADDI) == MATCH_ADDI && rs1 != 0)
345 || (l & MASK_JALR) == MATCH_JALR)
c7dee848
JW
346 maybe_print_address (pd, rs1, EXTRACT_ITYPE_IMM (l), 0);
347 if (info->mach == bfd_mach_riscv64
348 && ((l & MASK_ADDIW) == MATCH_ADDIW) && rs1 != 0)
349 maybe_print_address (pd, rs1, EXTRACT_ITYPE_IMM (l), 1);
e23eba97
NC
350 print (info->stream, "%d", (int)EXTRACT_ITYPE_IMM (l));
351 break;
352
353 case 'q':
c7dee848 354 maybe_print_address (pd, rs1, EXTRACT_STYPE_IMM (l), 0);
e23eba97
NC
355 print (info->stream, "%d", (int)EXTRACT_STYPE_IMM (l));
356 break;
357
358 case 'a':
5a9f5403 359 info->target = EXTRACT_JTYPE_IMM (l) + pc;
e23eba97
NC
360 (*info->print_address_func) (info->target, info);
361 break;
362
363 case 'p':
5a9f5403 364 info->target = EXTRACT_BTYPE_IMM (l) + pc;
e23eba97
NC
365 (*info->print_address_func) (info->target, info);
366 break;
367
368 case 'd':
369 if ((l & MASK_AUIPC) == MATCH_AUIPC)
370 pd->hi_addr[rd] = pc + EXTRACT_UTYPE_IMM (l);
371 else if ((l & MASK_LUI) == MATCH_LUI)
372 pd->hi_addr[rd] = EXTRACT_UTYPE_IMM (l);
373 else if ((l & MASK_C_LUI) == MATCH_C_LUI)
5a9f5403 374 pd->hi_addr[rd] = EXTRACT_CITYPE_LUI_IMM (l);
e23eba97
NC
375 print (info->stream, "%s", riscv_gpr_names[rd]);
376 break;
377
378 case 'z':
379 print (info->stream, "%s", riscv_gpr_names[0]);
380 break;
381
382 case '>':
383 print (info->stream, "0x%x", (int)EXTRACT_OPERAND (SHAMT, l));
384 break;
385
386 case '<':
387 print (info->stream, "0x%x", (int)EXTRACT_OPERAND (SHAMTW, l));
388 break;
389
390 case 'S':
391 case 'U':
392 print (info->stream, "%s", riscv_fpr_names[rs1]);
393 break;
394
395 case 'T':
396 print (info->stream, "%s", riscv_fpr_names[EXTRACT_OPERAND (RS2, l)]);
397 break;
398
399 case 'D':
400 print (info->stream, "%s", riscv_fpr_names[rd]);
401 break;
402
403 case 'R':
404 print (info->stream, "%s", riscv_fpr_names[EXTRACT_OPERAND (RS3, l)]);
405 break;
406
407 case 'E':
408 {
dcd709e0 409 static const char *riscv_csr_hash[4096]; /* Total 2^12 CSRs. */
78933a4a 410 static bool init_csr = false;
e23eba97 411 unsigned int csr = EXTRACT_OPERAND (CSR, l);
8f595e9b
NC
412
413 if (!init_csr)
e23eba97 414 {
8f595e9b
NC
415 unsigned int i;
416 for (i = 0; i < 4096; i++)
417 riscv_csr_hash[i] = NULL;
418
dcd709e0 419 /* Set to the newest privileged version. */
8f595e9b
NC
420 if (default_priv_spec == PRIV_SPEC_CLASS_NONE)
421 default_priv_spec = PRIV_SPEC_CLASS_DRAFT - 1;
422
08ccfccf
NC
423#define DECLARE_CSR(name, num, class, define_version, abort_version) \
424 if (riscv_csr_hash[num] == NULL \
425 && ((define_version == PRIV_SPEC_CLASS_NONE \
426 && abort_version == PRIV_SPEC_CLASS_NONE) \
427 || (default_priv_spec >= define_version \
428 && default_priv_spec < abort_version))) \
8f595e9b
NC
429 riscv_csr_hash[num] = #name;
430#define DECLARE_CSR_ALIAS(name, num, class, define_version, abort_version) \
431 DECLARE_CSR (name, num, class, define_version, abort_version)
e23eba97
NC
432#include "opcode/riscv-opc.h"
433#undef DECLARE_CSR
434 }
8f595e9b
NC
435
436 if (riscv_csr_hash[csr] != NULL)
437 print (info->stream, "%s", riscv_csr_hash[csr]);
e23eba97
NC
438 else
439 print (info->stream, "0x%x", csr);
440 break;
441 }
442
443 case 'Z':
444 print (info->stream, "%d", rs1);
445 break;
446
447 default:
448 /* xgettext:c-format */
449 print (info->stream, _("# internal error, undefined modifier (%c)"),
437e2ff1 450 *opargStart);
e23eba97
NC
451 return;
452 }
453 }
454}
455
456/* Print the RISC-V instruction at address MEMADDR in debugged memory,
457 on using INFO. Returns length of the instruction, in bytes.
458 BIGENDIAN must be 1 if this is big-endian code, 0 if
459 this is little-endian code. */
460
461static int
462riscv_disassemble_insn (bfd_vma memaddr, insn_t word, disassemble_info *info)
463{
464 const struct riscv_opcode *op;
78933a4a 465 static bool init = 0;
e23eba97
NC
466 static const struct riscv_opcode *riscv_hash[OP_MASK_OP + 1];
467 struct riscv_private_data *pd;
468 int insnlen;
469
470#define OP_HASH_IDX(i) ((i) & (riscv_insn_length (i) == 2 ? 0x3 : OP_MASK_OP))
471
472 /* Build a hash table to shorten the search time. */
473 if (! init)
474 {
475 for (op = riscv_opcodes; op->name; op++)
476 if (!riscv_hash[OP_HASH_IDX (op->match)])
477 riscv_hash[OP_HASH_IDX (op->match)] = op;
478
479 init = 1;
480 }
481
482 if (info->private_data == NULL)
483 {
484 int i;
485
486 pd = info->private_data = xcalloc (1, sizeof (struct riscv_private_data));
487 pd->gp = -1;
488 pd->print_addr = -1;
489 for (i = 0; i < (int)ARRAY_SIZE (pd->hi_addr); i++)
490 pd->hi_addr[i] = -1;
491
492 for (i = 0; i < info->symtab_size; i++)
b5292032 493 if (strcmp (bfd_asymbol_name (info->symtab[i]), RISCV_GP_SYMBOL) == 0)
e23eba97
NC
494 pd->gp = bfd_asymbol_value (info->symtab[i]);
495 }
496 else
497 pd = info->private_data;
498
499 insnlen = riscv_insn_length (word);
500
d7560e2d
JW
501 /* RISC-V instructions are always little-endian. */
502 info->endian_code = BFD_ENDIAN_LITTLE;
503
e23eba97
NC
504 info->bytes_per_chunk = insnlen % 4 == 0 ? 4 : 2;
505 info->bytes_per_line = 8;
d7560e2d
JW
506 /* We don't support constant pools, so this must be code. */
507 info->display_endian = info->endian_code;
e23eba97
NC
508 info->insn_info_valid = 1;
509 info->branch_delay_insns = 0;
510 info->data_size = 0;
511 info->insn_type = dis_nonbranch;
512 info->target = 0;
513 info->target2 = 0;
514
515 op = riscv_hash[OP_HASH_IDX (word)];
516 if (op != NULL)
517 {
2922d21d
AW
518 /* If XLEN is not known, get its value from the ELF class. */
519 if (info->mach == bfd_mach_riscv64)
520 xlen = 64;
521 else if (info->mach == bfd_mach_riscv32)
522 xlen = 32;
523 else if (info->section != NULL)
e23eba97
NC
524 {
525 Elf_Internal_Ehdr *ehdr = elf_elfheader (info->section->owner);
526 xlen = ehdr->e_ident[EI_CLASS] == ELFCLASS64 ? 64 : 32;
527 }
528
529 for (; op->name; op++)
530 {
531 /* Does the opcode match? */
532 if (! (op->match_func) (op, word))
533 continue;
534 /* Is this a pseudo-instruction and may we print it as such? */
535 if (no_aliases && (op->pinfo & INSN_ALIAS))
536 continue;
537 /* Is this instruction restricted to a certain value of XLEN? */
43135d3b 538 if ((op->xlen_requirement != 0) && (op->xlen_requirement != xlen))
e23eba97
NC
539 continue;
540
f786c359
NC
541 if (!riscv_multi_subset_supports (&riscv_rps_dis, op->insn_class))
542 continue;
543
e23eba97
NC
544 /* It's a match. */
545 (*info->fprintf_func) (info->stream, "%s", op->name);
546 print_insn_args (op->args, word, memaddr, info);
547
548 /* Try to disassemble multi-instruction addressing sequences. */
549 if (pd->print_addr != (bfd_vma)-1)
550 {
551 info->target = pd->print_addr;
552 (*info->fprintf_func) (info->stream, " # ");
553 (*info->print_address_func) (info->target, info);
554 pd->print_addr = -1;
555 }
556
eb41b248
JW
557 /* Finish filling out insn_info fields. */
558 switch (op->pinfo & INSN_TYPE)
559 {
560 case INSN_BRANCH:
561 info->insn_type = dis_branch;
562 break;
563 case INSN_CONDBRANCH:
564 info->insn_type = dis_condbranch;
565 break;
566 case INSN_JSR:
567 info->insn_type = dis_jsr;
568 break;
569 case INSN_DREF:
570 info->insn_type = dis_dref;
571 break;
572 default:
573 break;
574 }
575
576 if (op->pinfo & INSN_DATA_SIZE)
577 {
578 int size = ((op->pinfo & INSN_DATA_SIZE)
579 >> INSN_DATA_SIZE_SHIFT);
580 info->data_size = 1 << (size - 1);
581 }
582
e23eba97
NC
583 return insnlen;
584 }
585 }
586
587 /* We did not find a match, so just print the instruction bits. */
588 info->insn_type = dis_noninsn;
6a7f5766
AB
589 switch (insnlen)
590 {
591 case 2:
592 case 4:
593 case 8:
594 (*info->fprintf_func) (info->stream, ".%dbyte\t0x%llx",
595 insnlen, (unsigned long long) word);
596 break;
597 default:
598 {
599 int i;
600 (*info->fprintf_func) (info->stream, ".byte\t");
601 for (i = 0; i < insnlen; ++i)
602 {
603 if (i > 0)
604 (*info->fprintf_func) (info->stream, ", ");
605 (*info->fprintf_func) (info->stream, "0x%02x",
606 (unsigned int) (word & 0xff));
607 word >>= 8;
608 }
609 }
610 break;
611 }
e23eba97
NC
612 return insnlen;
613}
614
9b9b1092
NC
615/* Return true if we find the suitable mapping symbol,
616 and also update the STATE. Otherwise, return false. */
617
618static bool
619riscv_get_map_state (int n,
620 enum riscv_seg_mstate *state,
621 struct disassemble_info *info)
622{
623 const char *name;
624
625 /* If the symbol is in a different section, ignore it. */
626 if (info->section != NULL
627 && info->section != info->symtab[n]->section)
628 return false;
629
630 name = bfd_asymbol_name(info->symtab[n]);
631 if (strcmp (name, "$x") == 0)
632 *state = MAP_INSN;
633 else if (strcmp (name, "$d") == 0)
634 *state = MAP_DATA;
635 else
636 return false;
637
638 return true;
639}
640
641/* Check the sorted symbol table (sorted by the symbol value), find the
642 suitable mapping symbols. */
643
644static enum riscv_seg_mstate
645riscv_search_mapping_symbol (bfd_vma memaddr,
646 struct disassemble_info *info)
647{
648 enum riscv_seg_mstate mstate;
649 bool from_last_map_symbol;
650 bool found = false;
651 int symbol = -1;
652 int n;
653
654 /* Decide whether to print the data or instruction by default, in case
655 we can not find the corresponding mapping symbols. */
656 mstate = MAP_DATA;
657 if ((info->section
658 && info->section->flags & SEC_CODE)
659 || !info->section)
660 mstate = MAP_INSN;
661
662 if (info->symtab_size == 0
663 || bfd_asymbol_flavour (*info->symtab) != bfd_target_elf_flavour)
664 return mstate;
665
666 /* Reset the last_map_symbol if we start to dump a new section. */
667 if (memaddr <= 0)
668 last_map_symbol = -1;
669
670 /* If the last stop offset is different from the current one, then
671 don't use the last_map_symbol to search. We usually reset the
672 info->stop_offset when handling a new section. */
673 from_last_map_symbol = (last_map_symbol >= 0
674 && info->stop_offset == last_stop_offset);
675
676 /* Start scanning at the start of the function, or wherever
677 we finished last time. */
678 n = info->symtab_pos + 1;
679 if (from_last_map_symbol && n >= last_map_symbol)
680 n = last_map_symbol;
681
682 /* Find the suitable mapping symbol to dump. */
683 for (; n < info->symtab_size; n++)
684 {
685 bfd_vma addr = bfd_asymbol_value (info->symtab[n]);
686 /* We have searched all possible symbols in the range. */
687 if (addr > memaddr)
688 break;
689 if (riscv_get_map_state (n, &mstate, info))
690 {
691 symbol = n;
692 found = true;
693 /* Do not stop searching, in case there are some mapping
694 symbols have the same value, but have different names.
695 Use the last one. */
696 }
697 }
698
699 /* We can not find the suitable mapping symbol above. Therefore, we
700 look forwards and try to find it again, but don't go pass the start
701 of the section. Otherwise a data section without mapping symbols
702 can pick up a text mapping symbol of a preceeding section. */
703 if (!found)
704 {
705 n = info->symtab_pos;
706 if (from_last_map_symbol && n >= last_map_symbol)
707 n = last_map_symbol;
708
709 for (; n >= 0; n--)
710 {
711 bfd_vma addr = bfd_asymbol_value (info->symtab[n]);
712 /* We have searched all possible symbols in the range. */
713 if (addr < (info->section ? info->section->vma : 0))
714 break;
715 /* Stop searching once we find the closed mapping symbol. */
716 if (riscv_get_map_state (n, &mstate, info))
717 {
718 symbol = n;
719 found = true;
720 break;
721 }
722 }
723 }
724
725 /* Save the information for next use. */
726 last_map_symbol = symbol;
727 last_stop_offset = info->stop_offset;
728
729 return mstate;
730}
731
732/* Decide which data size we should print. */
733
734static bfd_vma
735riscv_data_length (bfd_vma memaddr,
736 disassemble_info *info)
737{
738 bfd_vma length;
739 bool found = false;
740
741 length = 4;
742 if (info->symtab_size != 0
743 && bfd_asymbol_flavour (*info->symtab) == bfd_target_elf_flavour
744 && last_map_symbol >= 0)
745 {
746 int n;
747 enum riscv_seg_mstate m = MAP_NONE;
748 for (n = last_map_symbol + 1; n < info->symtab_size; n++)
749 {
750 bfd_vma addr = bfd_asymbol_value (info->symtab[n]);
751 if (addr > memaddr
752 && riscv_get_map_state (n, &m, info))
753 {
754 if (addr - memaddr < length)
755 length = addr - memaddr;
756 found = true;
757 break;
758 }
759 }
760 }
761 if (!found)
762 {
763 /* Do not set the length which exceeds the section size. */
764 bfd_vma offset = info->section->vma + info->section->size;
765 offset -= memaddr;
766 length = (offset < length) ? offset : length;
767 }
768 length = length == 3 ? 2 : length;
769 return length;
770}
771
772/* Dump the data contents. */
773
774static int
775riscv_disassemble_data (bfd_vma memaddr ATTRIBUTE_UNUSED,
776 insn_t data,
777 disassemble_info *info)
778{
779 info->display_endian = info->endian;
780
781 switch (info->bytes_per_chunk)
782 {
783 case 1:
784 info->bytes_per_line = 6;
785 (*info->fprintf_func) (info->stream, ".byte\t0x%02llx",
786 (unsigned long long) data);
787 break;
788 case 2:
789 info->bytes_per_line = 8;
790 (*info->fprintf_func) (info->stream, ".short\t0x%04llx",
791 (unsigned long long) data);
792 break;
793 case 4:
794 info->bytes_per_line = 8;
795 (*info->fprintf_func) (info->stream, ".word\t0x%08llx",
796 (unsigned long long) data);
797 break;
798 case 8:
799 info->bytes_per_line = 8;
800 (*info->fprintf_func) (info->stream, ".dword\t0x%016llx",
801 (unsigned long long) data);
802 break;
803 default:
804 abort ();
805 }
806 return info->bytes_per_chunk;
807}
808
e23eba97
NC
809int
810print_insn_riscv (bfd_vma memaddr, struct disassemble_info *info)
811{
9b9b1092 812 bfd_byte packet[8];
e23eba97 813 insn_t insn = 0;
9b9b1092 814 bfd_vma dump_size;
e23eba97 815 int status;
9b9b1092
NC
816 enum riscv_seg_mstate mstate;
817 int (*riscv_disassembler) (bfd_vma, insn_t, struct disassemble_info *);
e23eba97
NC
818
819 if (info->disassembler_options != NULL)
820 {
821 parse_riscv_dis_options (info->disassembler_options);
822 /* Avoid repeatedly parsing the options. */
823 info->disassembler_options = NULL;
824 }
825 else if (riscv_gpr_names == NULL)
826 set_default_riscv_dis_options ();
827
9b9b1092
NC
828 mstate = riscv_search_mapping_symbol (memaddr, info);
829 /* Save the last mapping state. */
830 last_map_state = mstate;
831
832 /* Set the size to dump. */
833 if (mstate == MAP_DATA
834 && (info->flags & DISASSEMBLE_DATA) == 0)
835 {
836 dump_size = riscv_data_length (memaddr, info);
837 info->bytes_per_chunk = dump_size;
838 riscv_disassembler = riscv_disassemble_data;
839 }
840 else
e23eba97 841 {
9b9b1092
NC
842 /* Get the first 2-bytes to check the lenghth of instruction. */
843 status = (*info->read_memory_func) (memaddr, packet, 2, info);
e23eba97
NC
844 if (status != 0)
845 {
e23eba97 846 (*info->memory_error_func) (status, memaddr, info);
685bb4e8 847 return status;
e23eba97 848 }
9b9b1092
NC
849 insn = (insn_t) bfd_getl16 (packet);
850 dump_size = riscv_insn_length (insn);
851 riscv_disassembler = riscv_disassemble_insn;
852 }
e23eba97 853
9b9b1092
NC
854 /* Fetch the instruction to dump. */
855 status = (*info->read_memory_func) (memaddr, packet, dump_size, info);
856 if (status != 0)
857 {
858 (*info->memory_error_func) (status, memaddr, info);
685bb4e8 859 return status;
e23eba97 860 }
9b9b1092 861 insn = (insn_t) bfd_get_bits (packet, dump_size * 8, false);
e23eba97 862
9b9b1092 863 return (*riscv_disassembler) (memaddr, insn, info);
e23eba97
NC
864}
865
8152e040
NC
866disassembler_ftype
867riscv_get_disassembler (bfd *abfd)
868{
f786c359
NC
869 const char *default_arch = "rv64gc";
870
8152e040
NC
871 if (abfd)
872 {
113bb761
JN
873 const struct elf_backend_data *ebd = get_elf_backend_data (abfd);
874 if (ebd)
f786c359 875 {
113bb761
JN
876 const char *sec_name = ebd->obj_attrs_section;
877 if (bfd_get_section_by_name (abfd, sec_name) != NULL)
878 {
879 obj_attribute *attr = elf_known_obj_attributes_proc (abfd);
880 unsigned int Tag_a = Tag_RISCV_priv_spec;
881 unsigned int Tag_b = Tag_RISCV_priv_spec_minor;
882 unsigned int Tag_c = Tag_RISCV_priv_spec_revision;
883 riscv_get_priv_spec_class_from_numbers (attr[Tag_a].i,
884 attr[Tag_b].i,
885 attr[Tag_c].i,
886 &default_priv_spec);
f786c359 887 default_arch = attr[Tag_RISCV_arch].s;
113bb761 888 }
f786c359 889 }
8152e040 890 }
f786c359
NC
891
892 riscv_release_subset_list (&riscv_subsets);
893 riscv_parse_subset (&riscv_rps_dis, default_arch);
894 return print_insn_riscv;
8152e040
NC
895}
896
884b49e3
AB
897/* Prevent use of the fake labels that are generated as part of the DWARF
898 and for relaxable relocations in the assembler. */
899
78933a4a 900bool
884b49e3
AB
901riscv_symbol_is_valid (asymbol * sym,
902 struct disassemble_info * info ATTRIBUTE_UNUSED)
903{
904 const char * name;
905
906 if (sym == NULL)
78933a4a 907 return false;
884b49e3
AB
908
909 name = bfd_asymbol_name (sym);
910
9b9b1092
NC
911 return (strcmp (name, RISCV_FAKE_LABEL_NAME) != 0
912 && !riscv_elf_is_mapping_symbols (name));
884b49e3
AB
913}
914
e23eba97
NC
915void
916print_riscv_disassembler_options (FILE *stream)
917{
918 fprintf (stream, _("\n\
919The following RISC-V-specific disassembler options are supported for use\n\
920with the -M switch (multiple options should be separated by commas):\n"));
921
922 fprintf (stream, _("\n\
8f595e9b
NC
923 numeric Print numeric register names, rather than ABI names.\n"));
924
925 fprintf (stream, _("\n\
926 no-aliases Disassemble only into canonical instructions, rather\n\
927 than into pseudoinstructions.\n"));
e23eba97
NC
928
929 fprintf (stream, _("\n\
8f595e9b
NC
930 priv-spec=PRIV Print the CSR according to the chosen privilege spec\n\
931 (1.9, 1.9.1, 1.10, 1.11).\n"));
e23eba97
NC
932
933 fprintf (stream, _("\n"));
934}