2 Copyright (C) 2011-2023 Free Software Foundation, Inc.
4 Contributed by Andrew Waterman (andrew@sifive.com).
7 This file is part of the GNU opcodes library.
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)
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.
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/>. */
24 #include "disassemble.h"
25 #include "libiberty.h"
26 #include "opcode/riscv.h"
29 #include "elf/riscv.h"
30 #include "elfxx-riscv.h"
35 /* Current XLEN for the disassembler. */
36 static unsigned xlen
= 0;
38 /* Default ISA specification version (constant as of now). */
39 static enum riscv_spec_class default_isa_spec
= ISA_SPEC_CLASS_DRAFT
- 1;
41 /* Default privileged specification
42 (as specified by the ELF attributes or the `priv-spec' option). */
43 static enum riscv_spec_class default_priv_spec
= PRIV_SPEC_CLASS_NONE
;
45 static riscv_subset_list_t riscv_subsets
;
46 static riscv_parse_subset_t riscv_rps_dis
=
48 &riscv_subsets
, /* subset_list. */
49 opcodes_error_handler
,/* error_handler. */
51 &default_isa_spec
, /* isa_spec. */
52 false, /* check_unknown_prefixed_ext. */
55 struct riscv_private_data
59 bfd_vma hi_addr
[OP_MASK_RD
+ 1];
64 /* Used for mapping symbols. */
65 static int last_map_symbol
= -1;
66 static bfd_vma last_stop_offset
= 0;
67 static bfd_vma last_map_symbol_boundary
= 0;
68 static enum riscv_seg_mstate last_map_state
= MAP_NONE
;
69 static asection
*last_map_section
= NULL
;
71 /* Register names as used by the disassembler. */
72 static const char * const *riscv_gpr_names
;
73 static const char * const *riscv_fpr_names
;
75 /* If set, disassemble as most general instruction. */
76 static bool no_aliases
= false;
79 /* Set default RISC-V disassembler options. */
82 set_default_riscv_dis_options (void)
84 riscv_gpr_names
= riscv_gpr_names_abi
;
85 riscv_fpr_names
= riscv_fpr_names_abi
;
89 /* Parse RISC-V disassembler option (without arguments). */
92 parse_riscv_dis_option_without_args (const char *option
)
94 if (strcmp (option
, "no-aliases") == 0)
96 else if (strcmp (option
, "numeric") == 0)
98 riscv_gpr_names
= riscv_gpr_names_numeric
;
99 riscv_fpr_names
= riscv_fpr_names_numeric
;
106 /* Parse RISC-V disassembler option (possibly with arguments). */
109 parse_riscv_dis_option (const char *option
)
113 if (parse_riscv_dis_option_without_args (option
))
116 equal
= strchr (option
, '=');
119 /* The option without '=' should be defined above. */
120 opcodes_error_handler (_("unrecognized disassembler option: %s"), option
);
124 || *(equal
+ 1) == '\0')
126 /* Invalid options with '=', no option name before '=',
127 and no value after '='. */
128 opcodes_error_handler (_("unrecognized disassembler option with '=': %s"),
135 if (strcmp (option
, "priv-spec") == 0)
137 enum riscv_spec_class priv_spec
= PRIV_SPEC_CLASS_NONE
;
138 const char *name
= NULL
;
140 RISCV_GET_PRIV_SPEC_CLASS (value
, priv_spec
);
141 if (priv_spec
== PRIV_SPEC_CLASS_NONE
)
142 opcodes_error_handler (_("unknown privileged spec set by %s=%s"),
144 else if (default_priv_spec
== PRIV_SPEC_CLASS_NONE
)
145 default_priv_spec
= priv_spec
;
146 else if (default_priv_spec
!= priv_spec
)
148 RISCV_GET_PRIV_SPEC_NAME (name
, default_priv_spec
);
149 opcodes_error_handler (_("mis-matched privilege spec set by %s=%s, "
150 "the elf privilege attribute is %s"),
151 option
, value
, name
);
156 /* xgettext:c-format */
157 opcodes_error_handler (_("unrecognized disassembler option: %s"), option
);
161 /* Parse RISC-V disassembler options. */
164 parse_riscv_dis_options (const char *opts_in
)
166 char *opts
= xstrdup (opts_in
), *opt
= opts
, *opt_end
= opts
;
168 set_default_riscv_dis_options ();
170 for ( ; opt_end
!= NULL
; opt
= opt_end
+ 1)
172 if ((opt_end
= strchr (opt
, ',')) != NULL
)
174 parse_riscv_dis_option (opt
);
180 /* Print one argument from an array. */
183 arg_print (struct disassemble_info
*info
, unsigned long val
,
184 const char* const* array
, size_t size
)
186 const char *s
= val
>= size
|| array
[val
] == NULL
? "unknown" : array
[val
];
187 (*info
->fprintf_styled_func
) (info
->stream
, dis_style_text
, "%s", s
);
190 /* If we need to print an address, set its value and state. */
193 maybe_print_address (struct riscv_private_data
*pd
, int base_reg
, int offset
,
196 if (pd
->hi_addr
[base_reg
] != (bfd_vma
)-1)
198 pd
->print_addr
= (base_reg
!= 0 ? pd
->hi_addr
[base_reg
] : 0) + offset
;
199 pd
->hi_addr
[base_reg
] = -1;
201 else if (base_reg
== X_GP
&& pd
->has_gp
)
202 pd
->print_addr
= pd
->gp
+ offset
;
203 else if (base_reg
== X_TP
|| base_reg
== 0)
204 pd
->print_addr
= offset
;
206 return; /* Don't print the address. */
207 pd
->to_print_addr
= true;
209 /* Sign-extend a 32-bit value to a 64-bit value. */
211 pd
->print_addr
= (bfd_vma
)(int32_t) pd
->print_addr
;
213 /* Fit into a 32-bit value on RV32. */
215 pd
->print_addr
= (bfd_vma
)(uint32_t)pd
->print_addr
;
218 /* Print insn arguments for 32/64-bit code. */
221 print_insn_args (const char *oparg
, insn_t l
, bfd_vma pc
, disassemble_info
*info
)
223 struct riscv_private_data
*pd
= info
->private_data
;
224 int rs1
= (l
>> OP_SH_RS1
) & OP_MASK_RS1
;
225 int rd
= (l
>> OP_SH_RD
) & OP_MASK_RD
;
226 fprintf_styled_ftype print
= info
->fprintf_styled_func
;
227 const char *opargStart
;
230 print (info
->stream
, dis_style_text
, "\t");
232 for (; *oparg
!= '\0'; oparg
++)
240 case 's': /* RS1 x8-x15. */
241 case 'w': /* RS1 x8-x15. */
242 print (info
->stream
, dis_style_register
, "%s",
243 riscv_gpr_names
[EXTRACT_OPERAND (CRS1S
, l
) + 8]);
245 case 't': /* RS2 x8-x15. */
246 case 'x': /* RS2 x8-x15. */
247 print (info
->stream
, dis_style_register
, "%s",
248 riscv_gpr_names
[EXTRACT_OPERAND (CRS2S
, l
) + 8]);
250 case 'U': /* RS1, constrained to equal RD. */
251 print (info
->stream
, dis_style_register
,
252 "%s", riscv_gpr_names
[rd
]);
254 case 'c': /* RS1, constrained to equal sp. */
255 print (info
->stream
, dis_style_register
, "%s",
256 riscv_gpr_names
[X_SP
]);
259 print (info
->stream
, dis_style_register
, "%s",
260 riscv_gpr_names
[EXTRACT_OPERAND (CRS2
, l
)]);
264 if (((l
& MASK_C_ADDI
) == MATCH_C_ADDI
) && rd
!= 0)
265 maybe_print_address (pd
, rd
, EXTRACT_CITYPE_IMM (l
), 0);
266 if (info
->mach
== bfd_mach_riscv64
267 && ((l
& MASK_C_ADDIW
) == MATCH_C_ADDIW
) && rd
!= 0)
268 maybe_print_address (pd
, rd
, EXTRACT_CITYPE_IMM (l
), 1);
269 print (info
->stream
, dis_style_immediate
, "%d",
270 (int)EXTRACT_CITYPE_IMM (l
));
273 print (info
->stream
, dis_style_address_offset
, "%d",
274 (int)EXTRACT_CLTYPE_LW_IMM (l
));
277 print (info
->stream
, dis_style_address_offset
, "%d",
278 (int)EXTRACT_CLTYPE_LD_IMM (l
));
281 print (info
->stream
, dis_style_address_offset
, "%d",
282 (int)EXTRACT_CITYPE_LWSP_IMM (l
));
285 print (info
->stream
, dis_style_address_offset
, "%d",
286 (int)EXTRACT_CITYPE_LDSP_IMM (l
));
289 print (info
->stream
, dis_style_immediate
, "%d",
290 (int)EXTRACT_CIWTYPE_ADDI4SPN_IMM (l
));
293 print (info
->stream
, dis_style_immediate
, "%d",
294 (int)EXTRACT_CITYPE_ADDI16SP_IMM (l
));
297 print (info
->stream
, dis_style_address_offset
, "%d",
298 (int)EXTRACT_CSSTYPE_SWSP_IMM (l
));
301 print (info
->stream
, dis_style_address_offset
, "%d",
302 (int)EXTRACT_CSSTYPE_SDSP_IMM (l
));
305 info
->target
= EXTRACT_CBTYPE_IMM (l
) + pc
;
306 (*info
->print_address_func
) (info
->target
, info
);
309 info
->target
= EXTRACT_CJTYPE_IMM (l
) + pc
;
310 (*info
->print_address_func
) (info
->target
, info
);
313 print (info
->stream
, dis_style_immediate
, "0x%x",
314 (unsigned)(EXTRACT_CITYPE_IMM (l
) & (RISCV_BIGIMM_REACH
-1)));
317 print (info
->stream
, dis_style_immediate
, "0x%x",
318 (unsigned)EXTRACT_CITYPE_IMM (l
) & 0x3f);
321 print (info
->stream
, dis_style_immediate
, "0x%x",
322 (unsigned)EXTRACT_CITYPE_IMM (l
) & 0x1f);
324 case 'T': /* Floating-point RS2. */
325 print (info
->stream
, dis_style_register
, "%s",
326 riscv_fpr_names
[EXTRACT_OPERAND (CRS2
, l
)]);
328 case 'D': /* Floating-point RS2 x8-x15. */
329 print (info
->stream
, dis_style_register
, "%s",
330 riscv_fpr_names
[EXTRACT_OPERAND (CRS2S
, l
) + 8]);
340 print (info
->stream
, dis_style_register
, "%s",
341 riscv_vecr_names_numeric
[EXTRACT_OPERAND (VD
, l
)]);
344 if (!EXTRACT_OPERAND (VWD
, l
))
345 print (info
->stream
, dis_style_register
, "%s",
348 print (info
->stream
, dis_style_register
, "%s",
349 riscv_vecr_names_numeric
[EXTRACT_OPERAND (VD
, l
)]);
352 print (info
->stream
, dis_style_register
, "%s",
353 riscv_vecr_names_numeric
[EXTRACT_OPERAND (VS1
, l
)]);
356 case 'u': /* VS1 == VS2 already verified at this point. */
357 case 'v': /* VD == VS1 == VS2 already verified at this point. */
358 print (info
->stream
, dis_style_register
, "%s",
359 riscv_vecr_names_numeric
[EXTRACT_OPERAND (VS2
, l
)]);
362 print (info
->stream
, dis_style_register
, "%s",
363 riscv_vecr_names_numeric
[0]);
368 int imm
= (*oparg
== 'b') ? EXTRACT_RVV_VB_IMM (l
)
369 : EXTRACT_RVV_VC_IMM (l
);
370 unsigned int imm_vlmul
= EXTRACT_OPERAND (VLMUL
, imm
);
371 unsigned int imm_vsew
= EXTRACT_OPERAND (VSEW
, imm
);
372 unsigned int imm_vta
= EXTRACT_OPERAND (VTA
, imm
);
373 unsigned int imm_vma
= EXTRACT_OPERAND (VMA
, imm
);
374 unsigned int imm_vtype_res
= (imm
>> 8);
376 if (imm_vsew
< ARRAY_SIZE (riscv_vsew
)
377 && imm_vlmul
< ARRAY_SIZE (riscv_vlmul
)
378 && imm_vta
< ARRAY_SIZE (riscv_vta
)
379 && imm_vma
< ARRAY_SIZE (riscv_vma
)
381 && riscv_vsew
[imm_vsew
] != NULL
382 && riscv_vlmul
[imm_vlmul
] != NULL
)
383 print (info
->stream
, dis_style_text
, "%s,%s,%s,%s",
384 riscv_vsew
[imm_vsew
],
385 riscv_vlmul
[imm_vlmul
], riscv_vta
[imm_vta
],
388 print (info
->stream
, dis_style_immediate
, "%d", imm
);
392 print (info
->stream
, dis_style_immediate
, "%d",
393 (int)EXTRACT_RVV_VI_IMM (l
));
396 print (info
->stream
, dis_style_immediate
, "%d",
397 (int)EXTRACT_RVV_VI_UIMM (l
));
400 print (info
->stream
, dis_style_immediate
, "%d",
401 (int)EXTRACT_RVV_OFFSET (l
));
404 print (info
->stream
, dis_style_immediate
, "%d",
405 (int)EXTRACT_RVV_VI_UIMM6 (l
));
408 if (!EXTRACT_OPERAND (VMASK
, l
))
410 print (info
->stream
, dis_style_text
, ",");
411 print (info
->stream
, dis_style_register
, "%s",
412 riscv_vecm_names_numeric
[0]);
423 print (info
->stream
, dis_style_text
, "%c", *oparg
);
427 /* Only print constant 0 if it is the last argument. */
429 print (info
->stream
, dis_style_immediate
, "0");
433 if ((l
& MASK_JALR
) == MATCH_JALR
)
434 maybe_print_address (pd
, rs1
, EXTRACT_ITYPE_IMM (l
), 0);
435 print (info
->stream
, dis_style_register
, "%s", riscv_gpr_names
[rs1
]);
439 print (info
->stream
, dis_style_register
, "%s",
440 riscv_gpr_names
[EXTRACT_OPERAND (RS2
, l
)]);
444 print (info
->stream
, dis_style_immediate
, "0x%x",
445 (unsigned)EXTRACT_UTYPE_IMM (l
) >> RISCV_IMM_BITS
);
449 arg_print (info
, EXTRACT_OPERAND (RM
, l
),
450 riscv_rm
, ARRAY_SIZE (riscv_rm
));
454 arg_print (info
, EXTRACT_OPERAND (PRED
, l
),
455 riscv_pred_succ
, ARRAY_SIZE (riscv_pred_succ
));
459 arg_print (info
, EXTRACT_OPERAND (SUCC
, l
),
460 riscv_pred_succ
, ARRAY_SIZE (riscv_pred_succ
));
464 maybe_print_address (pd
, rs1
, EXTRACT_ITYPE_IMM (l
), 0);
467 if (((l
& MASK_ADDI
) == MATCH_ADDI
&& rs1
!= 0)
468 || (l
& MASK_JALR
) == MATCH_JALR
)
469 maybe_print_address (pd
, rs1
, EXTRACT_ITYPE_IMM (l
), 0);
470 if (info
->mach
== bfd_mach_riscv64
471 && ((l
& MASK_ADDIW
) == MATCH_ADDIW
) && rs1
!= 0)
472 maybe_print_address (pd
, rs1
, EXTRACT_ITYPE_IMM (l
), 1);
473 print (info
->stream
, dis_style_immediate
, "%d",
474 (int)EXTRACT_ITYPE_IMM (l
));
478 maybe_print_address (pd
, rs1
, EXTRACT_STYPE_IMM (l
), 0);
479 print (info
->stream
, dis_style_address_offset
, "%d",
480 (int)EXTRACT_STYPE_IMM (l
));
484 info
->target
= EXTRACT_JTYPE_IMM (l
) + pc
;
485 (*info
->print_address_func
) (info
->target
, info
);
489 info
->target
= EXTRACT_BTYPE_IMM (l
) + pc
;
490 (*info
->print_address_func
) (info
->target
, info
);
494 if ((l
& MASK_AUIPC
) == MATCH_AUIPC
)
495 pd
->hi_addr
[rd
] = pc
+ EXTRACT_UTYPE_IMM (l
);
496 else if ((l
& MASK_LUI
) == MATCH_LUI
)
497 pd
->hi_addr
[rd
] = EXTRACT_UTYPE_IMM (l
);
498 else if ((l
& MASK_C_LUI
) == MATCH_C_LUI
)
499 pd
->hi_addr
[rd
] = EXTRACT_CITYPE_LUI_IMM (l
);
500 print (info
->stream
, dis_style_register
, "%s", riscv_gpr_names
[rd
]);
504 print (info
->stream
, dis_style_immediate
, "0x%x",
505 (unsigned)EXTRACT_OPERAND (BS
, l
));
509 print (info
->stream
, dis_style_register
, "%s", riscv_gpr_names
[0]);
513 print (info
->stream
, dis_style_immediate
, "0x%x",
514 (unsigned)EXTRACT_OPERAND (SHAMT
, l
));
518 print (info
->stream
, dis_style_immediate
, "0x%x",
519 (unsigned)EXTRACT_OPERAND (SHAMTW
, l
));
524 print (info
->stream
, dis_style_register
, "%s", riscv_fpr_names
[rs1
]);
528 print (info
->stream
, dis_style_register
, "%s",
529 riscv_fpr_names
[EXTRACT_OPERAND (RS2
, l
)]);
533 print (info
->stream
, dis_style_register
, "%s", riscv_fpr_names
[rd
]);
537 print (info
->stream
, dis_style_register
, "%s",
538 riscv_fpr_names
[EXTRACT_OPERAND (RS3
, l
)]);
543 static const char *riscv_csr_hash
[4096]; /* Total 2^12 CSRs. */
544 static bool init_csr
= false;
545 unsigned int csr
= EXTRACT_OPERAND (CSR
, l
);
550 for (i
= 0; i
< 4096; i
++)
551 riscv_csr_hash
[i
] = NULL
;
553 /* Set to the newest privileged version. */
554 if (default_priv_spec
== PRIV_SPEC_CLASS_NONE
)
555 default_priv_spec
= PRIV_SPEC_CLASS_DRAFT
- 1;
557 #define DECLARE_CSR(name, num, class, define_version, abort_version) \
558 if (riscv_csr_hash[num] == NULL \
559 && ((define_version == PRIV_SPEC_CLASS_NONE \
560 && abort_version == PRIV_SPEC_CLASS_NONE) \
561 || (default_priv_spec >= define_version \
562 && default_priv_spec < abort_version))) \
563 riscv_csr_hash[num] = #name;
564 #define DECLARE_CSR_ALIAS(name, num, class, define_version, abort_version) \
565 DECLARE_CSR (name, num, class, define_version, abort_version)
566 #include "opcode/riscv-opc.h"
570 if (riscv_csr_hash
[csr
] != NULL
)
571 print (info
->stream
, dis_style_register
, "%s",
572 riscv_csr_hash
[csr
]);
574 print (info
->stream
, dis_style_immediate
, "0x%x", csr
);
579 print (info
->stream
, dis_style_immediate
, "0x%x",
580 (unsigned) EXTRACT_OPERAND (RNUM
, l
));
584 print (info
->stream
, dis_style_immediate
, "%d", rs1
);
587 case 'W': /* Various operands. */
595 print (info
->stream
, dis_style_address_offset
, "%d",
596 (int) EXTRACT_STYPE_IMM (l
));
599 goto undefined_modifier
;
606 if (riscv_fli_symval
[rs1
])
607 print (info
->stream
, dis_style_text
, "%s",
608 riscv_fli_symval
[rs1
]);
610 print (info
->stream
, dis_style_immediate
, "%a",
611 riscv_fli_numval
[rs1
]);
614 goto undefined_modifier
;
617 case 'c': /* Zcb extension 16 bits length instruction fields. */
621 print (info
->stream
, dis_style_immediate
, "%d",
622 (int)EXTRACT_ZCB_BYTE_UIMM (l
));
625 print (info
->stream
, dis_style_immediate
, "%d",
626 (int)EXTRACT_ZCB_HALFWORD_UIMM (l
));
632 goto undefined_modifier
;
637 case 'X': /* Integer immediate. */
645 case 'l': /* Literal. */
647 while (*oparg
&& *oparg
!= ',')
649 print (info
->stream
, dis_style_immediate
, "%c", *oparg
);
654 case 's': /* 'XsN@S' ... N-bit signed immediate at bit S. */
657 case 'u': /* 'XuN@S' ... N-bit unsigned immediate at bit S. */
661 n
= strtol (oparg
+ 1, (char **)&oparg
, 10);
663 goto undefined_modifier
;
664 s
= strtol (oparg
+ 1, (char **)&oparg
, 10);
668 print (info
->stream
, dis_style_immediate
, "%lu",
669 (unsigned long)EXTRACT_U_IMM (n
, s
, l
));
671 print (info
->stream
, dis_style_immediate
, "%li",
672 (signed long)EXTRACT_S_IMM (n
, s
, l
));
675 goto undefined_modifier
;
682 /* xgettext:c-format */
683 print (info
->stream
, dis_style_text
,
684 _("# internal error, undefined modifier (%c)"),
691 /* Print the RISC-V instruction at address MEMADDR in debugged memory,
692 on using INFO. Returns length of the instruction, in bytes.
693 BIGENDIAN must be 1 if this is big-endian code, 0 if
694 this is little-endian code. */
697 riscv_disassemble_insn (bfd_vma memaddr
,
699 const bfd_byte
*packet
,
700 disassemble_info
*info
)
702 const struct riscv_opcode
*op
;
703 static bool init
= false;
704 static const struct riscv_opcode
*riscv_hash
[OP_MASK_OP
+ 1];
705 struct riscv_private_data
*pd
= info
->private_data
;
709 #define OP_HASH_IDX(i) ((i) & (riscv_insn_length (i) == 2 ? 0x3 : OP_MASK_OP))
711 /* Build a hash table to shorten the search time. */
714 for (op
= riscv_opcodes
; op
->name
; op
++)
715 if (!riscv_hash
[OP_HASH_IDX (op
->match
)])
716 riscv_hash
[OP_HASH_IDX (op
->match
)] = op
;
721 insnlen
= riscv_insn_length (word
);
723 /* RISC-V instructions are always little-endian. */
724 info
->endian_code
= BFD_ENDIAN_LITTLE
;
726 info
->bytes_per_chunk
= insnlen
% 4 == 0 ? 4 : 2;
727 info
->bytes_per_line
= 8;
728 /* We don't support constant pools, so this must be code. */
729 info
->display_endian
= info
->endian_code
;
730 info
->insn_info_valid
= 1;
731 info
->branch_delay_insns
= 0;
733 info
->insn_type
= dis_nonbranch
;
737 op
= riscv_hash
[OP_HASH_IDX (word
)];
740 /* If XLEN is not known, get its value from the ELF class. */
741 if (info
->mach
== bfd_mach_riscv64
)
743 else if (info
->mach
== bfd_mach_riscv32
)
745 else if (info
->section
!= NULL
)
747 Elf_Internal_Ehdr
*ehdr
= elf_elfheader (info
->section
->owner
);
748 xlen
= ehdr
->e_ident
[EI_CLASS
] == ELFCLASS64
? 64 : 32;
751 /* If arch has the Zfinx extension, replace FPR with GPR. */
752 if (riscv_subset_supports (&riscv_rps_dis
, "zfinx"))
753 riscv_fpr_names
= riscv_gpr_names
;
755 riscv_fpr_names
= riscv_gpr_names
== riscv_gpr_names_abi
?
756 riscv_fpr_names_abi
: riscv_fpr_names_numeric
;
758 for (; op
->name
; op
++)
760 /* Does the opcode match? */
761 if (! (op
->match_func
) (op
, word
))
763 /* Is this a pseudo-instruction and may we print it as such? */
764 if (no_aliases
&& (op
->pinfo
& INSN_ALIAS
))
766 /* Is this instruction restricted to a certain value of XLEN? */
767 if ((op
->xlen_requirement
!= 0) && (op
->xlen_requirement
!= xlen
))
769 /* Is this instruction supported by the current architecture? */
770 if (!riscv_multi_subset_supports (&riscv_rps_dis
, op
->insn_class
))
774 (*info
->fprintf_styled_func
) (info
->stream
, dis_style_mnemonic
,
776 print_insn_args (op
->args
, word
, memaddr
, info
);
778 /* Try to disassemble multi-instruction addressing sequences. */
779 if (pd
->to_print_addr
)
781 info
->target
= pd
->print_addr
;
782 (*info
->fprintf_styled_func
)
783 (info
->stream
, dis_style_comment_start
, " # ");
784 (*info
->print_address_func
) (info
->target
, info
);
785 pd
->to_print_addr
= false;
788 /* Finish filling out insn_info fields. */
789 switch (op
->pinfo
& INSN_TYPE
)
792 info
->insn_type
= dis_branch
;
794 case INSN_CONDBRANCH
:
795 info
->insn_type
= dis_condbranch
;
798 info
->insn_type
= dis_jsr
;
801 info
->insn_type
= dis_dref
;
807 if (op
->pinfo
& INSN_DATA_SIZE
)
809 int size
= ((op
->pinfo
& INSN_DATA_SIZE
)
810 >> INSN_DATA_SIZE_SHIFT
);
811 info
->data_size
= 1 << (size
- 1);
818 /* We did not find a match, so just print the instruction bits in
819 the shape of an assembler .insn directive. */
820 info
->insn_type
= dis_noninsn
;
821 (*info
->fprintf_styled_func
)
822 (info
->stream
, dis_style_assembler_directive
, ".insn");
823 (*info
->fprintf_styled_func
) (info
->stream
, dis_style_text
, "\t");
824 (*info
->fprintf_styled_func
) (info
->stream
, dis_style_immediate
,
826 (*info
->fprintf_styled_func
) (info
->stream
, dis_style_text
, ", ");
827 (*info
->fprintf_styled_func
) (info
->stream
, dis_style_immediate
, "0x");
828 for (i
= insnlen
, printed
= false; i
>= 2; )
831 word
= bfd_get_bits (packet
+ i
, 16, false);
832 if (!word
&& !printed
)
835 (*info
->fprintf_styled_func
) (info
->stream
, dis_style_immediate
,
836 "%04x", (unsigned int) word
);
843 /* Return true if we find the suitable mapping symbol,
844 and also update the STATE. Otherwise, return false. */
847 riscv_get_map_state (int n
,
848 enum riscv_seg_mstate
*state
,
849 struct disassemble_info
*info
)
853 /* If the symbol is in a different section, ignore it. */
854 if (info
->section
!= NULL
855 && info
->section
!= info
->symtab
[n
]->section
)
858 name
= bfd_asymbol_name(info
->symtab
[n
]);
859 if (strcmp (name
, "$x") == 0)
861 else if (strcmp (name
, "$d") == 0)
863 else if (strncmp (name
, "$xrv", 4) == 0)
866 riscv_release_subset_list (&riscv_subsets
);
867 riscv_parse_subset (&riscv_rps_dis
, name
+ 2);
875 /* Check the sorted symbol table (sorted by the symbol value), find the
876 suitable mapping symbols. */
878 static enum riscv_seg_mstate
879 riscv_search_mapping_symbol (bfd_vma memaddr
,
880 struct disassemble_info
*info
)
882 enum riscv_seg_mstate mstate
;
883 bool from_last_map_symbol
;
888 /* Return the last map state if the address is still within the range of the
889 last mapping symbol. */
890 if (last_map_section
== info
->section
891 && (memaddr
< last_map_symbol_boundary
))
892 return last_map_state
;
894 last_map_section
= info
->section
;
896 /* Decide whether to print the data or instruction by default, in case
897 we can not find the corresponding mapping symbols. */
900 && info
->section
->flags
& SEC_CODE
)
904 if (info
->symtab_size
== 0
905 || bfd_asymbol_flavour (*info
->symtab
) != bfd_target_elf_flavour
)
908 /* Reset the last_map_symbol if we start to dump a new section. */
910 last_map_symbol
= -1;
912 /* If the last stop offset is different from the current one, then
913 don't use the last_map_symbol to search. We usually reset the
914 info->stop_offset when handling a new section. */
915 from_last_map_symbol
= (last_map_symbol
>= 0
916 && info
->stop_offset
== last_stop_offset
);
918 /* Start scanning at the start of the function, or wherever
919 we finished last time. */
920 n
= info
->symtab_pos
+ 1;
921 if (from_last_map_symbol
&& n
>= last_map_symbol
)
924 /* Find the suitable mapping symbol to dump. */
925 for (; n
< info
->symtab_size
; n
++)
927 bfd_vma addr
= bfd_asymbol_value (info
->symtab
[n
]);
928 /* We have searched all possible symbols in the range. */
931 if (riscv_get_map_state (n
, &mstate
, info
))
935 /* Do not stop searching, in case there are some mapping
936 symbols have the same value, but have different names.
941 /* We can not find the suitable mapping symbol above. Therefore, we
942 look forwards and try to find it again, but don't go past the start
943 of the section. Otherwise a data section without mapping symbols
944 can pick up a text mapping symbol of a preceeding section. */
947 n
= info
->symtab_pos
;
948 if (from_last_map_symbol
&& n
>= last_map_symbol
)
953 bfd_vma addr
= bfd_asymbol_value (info
->symtab
[n
]);
954 /* We have searched all possible symbols in the range. */
955 if (addr
< (info
->section
? info
->section
->vma
: 0))
957 /* Stop searching once we find the closed mapping symbol. */
958 if (riscv_get_map_state (n
, &mstate
, info
))
969 /* Find the next mapping symbol to determine the boundary of this mapping
972 bool found_next
= false;
973 /* Try to found next mapping symbol. */
974 for (n
= symbol
+ 1; n
< info
->symtab_size
; n
++)
976 if (info
->symtab
[symbol
]->section
!= info
->symtab
[n
]->section
)
979 bfd_vma addr
= bfd_asymbol_value (info
->symtab
[n
]);
980 const char *sym_name
= bfd_asymbol_name(info
->symtab
[n
]);
981 if (sym_name
[0] == '$' && (sym_name
[1] == 'x' || sym_name
[1] == 'd'))
983 /* The next mapping symbol has been found, and it represents the
984 boundary of this mapping symbol. */
986 last_map_symbol_boundary
= addr
;
991 /* No further mapping symbol has been found, indicating that the boundary
992 of the current mapping symbol is the end of this section. */
994 last_map_symbol_boundary
= info
->section
->vma
+ info
->section
->size
;
997 /* Save the information for next use. */
998 last_map_symbol
= symbol
;
999 last_stop_offset
= info
->stop_offset
;
1004 /* Decide which data size we should print. */
1007 riscv_data_length (bfd_vma memaddr
,
1008 disassemble_info
*info
)
1014 if (info
->symtab_size
!= 0
1015 && bfd_asymbol_flavour (*info
->symtab
) == bfd_target_elf_flavour
1016 && last_map_symbol
>= 0)
1019 enum riscv_seg_mstate m
= MAP_NONE
;
1020 for (n
= last_map_symbol
+ 1; n
< info
->symtab_size
; n
++)
1022 bfd_vma addr
= bfd_asymbol_value (info
->symtab
[n
]);
1024 && riscv_get_map_state (n
, &m
, info
))
1026 if (addr
- memaddr
< length
)
1027 length
= addr
- memaddr
;
1035 /* Do not set the length which exceeds the section size. */
1036 bfd_vma offset
= info
->section
->vma
+ info
->section
->size
;
1038 length
= (offset
< length
) ? offset
: length
;
1040 length
= length
== 3 ? 2 : length
;
1044 /* Dump the data contents. */
1047 riscv_disassemble_data (bfd_vma memaddr ATTRIBUTE_UNUSED
,
1049 const bfd_byte
*packet ATTRIBUTE_UNUSED
,
1050 disassemble_info
*info
)
1052 info
->display_endian
= info
->endian
;
1054 switch (info
->bytes_per_chunk
)
1057 info
->bytes_per_line
= 6;
1058 (*info
->fprintf_styled_func
)
1059 (info
->stream
, dis_style_assembler_directive
, ".byte");
1060 (*info
->fprintf_styled_func
) (info
->stream
, dis_style_text
, "\t");
1061 (*info
->fprintf_styled_func
) (info
->stream
, dis_style_immediate
,
1062 "0x%02x", (unsigned)data
);
1065 info
->bytes_per_line
= 8;
1066 (*info
->fprintf_styled_func
)
1067 (info
->stream
, dis_style_assembler_directive
, ".short");
1068 (*info
->fprintf_styled_func
) (info
->stream
, dis_style_text
, "\t");
1069 (*info
->fprintf_styled_func
)
1070 (info
->stream
, dis_style_immediate
, "0x%04x", (unsigned) data
);
1073 info
->bytes_per_line
= 8;
1074 (*info
->fprintf_styled_func
)
1075 (info
->stream
, dis_style_assembler_directive
, ".word");
1076 (*info
->fprintf_styled_func
) (info
->stream
, dis_style_text
, "\t");
1077 (*info
->fprintf_styled_func
)
1078 (info
->stream
, dis_style_immediate
, "0x%08lx",
1079 (unsigned long) data
);
1082 info
->bytes_per_line
= 8;
1083 (*info
->fprintf_styled_func
)
1084 (info
->stream
, dis_style_assembler_directive
, ".dword");
1085 (*info
->fprintf_styled_func
) (info
->stream
, dis_style_text
, "\t");
1086 (*info
->fprintf_styled_func
)
1087 (info
->stream
, dis_style_immediate
, "0x%016llx",
1088 (unsigned long long) data
);
1093 return info
->bytes_per_chunk
;
1097 riscv_init_disasm_info (struct disassemble_info
*info
)
1101 struct riscv_private_data
*pd
=
1102 xcalloc (1, sizeof (struct riscv_private_data
));
1105 for (i
= 0; i
< (int) ARRAY_SIZE (pd
->hi_addr
); i
++)
1106 pd
->hi_addr
[i
] = -1;
1107 pd
->to_print_addr
= false;
1110 for (i
= 0; i
< info
->symtab_size
; i
++)
1112 asymbol
*sym
= info
->symtab
[i
];
1113 if (strcmp (bfd_asymbol_name (sym
), RISCV_GP_SYMBOL
) == 0)
1115 pd
->gp
= bfd_asymbol_value (sym
);
1120 info
->private_data
= pd
;
1125 print_insn_riscv (bfd_vma memaddr
, struct disassemble_info
*info
)
1127 bfd_byte packet
[RISCV_MAX_INSN_LEN
];
1131 enum riscv_seg_mstate mstate
;
1132 int (*riscv_disassembler
) (bfd_vma
, insn_t
, const bfd_byte
*,
1133 struct disassemble_info
*);
1135 if (info
->disassembler_options
!= NULL
)
1137 parse_riscv_dis_options (info
->disassembler_options
);
1138 /* Avoid repeatedly parsing the options. */
1139 info
->disassembler_options
= NULL
;
1141 else if (riscv_gpr_names
== NULL
)
1142 set_default_riscv_dis_options ();
1144 if (info
->private_data
== NULL
&& !riscv_init_disasm_info (info
))
1147 mstate
= riscv_search_mapping_symbol (memaddr
, info
);
1148 /* Save the last mapping state. */
1149 last_map_state
= mstate
;
1151 /* Set the size to dump. */
1152 if (mstate
== MAP_DATA
1153 && (info
->flags
& DISASSEMBLE_DATA
) == 0)
1155 dump_size
= riscv_data_length (memaddr
, info
);
1156 info
->bytes_per_chunk
= dump_size
;
1157 riscv_disassembler
= riscv_disassemble_data
;
1161 /* Get the first 2-bytes to check the lenghth of instruction. */
1162 status
= (*info
->read_memory_func
) (memaddr
, packet
, 2, info
);
1165 (*info
->memory_error_func
) (status
, memaddr
, info
);
1168 insn
= (insn_t
) bfd_getl16 (packet
);
1169 dump_size
= riscv_insn_length (insn
);
1170 riscv_disassembler
= riscv_disassemble_insn
;
1173 /* Fetch the instruction to dump. */
1174 status
= (*info
->read_memory_func
) (memaddr
, packet
, dump_size
, info
);
1177 (*info
->memory_error_func
) (status
, memaddr
, info
);
1180 insn
= (insn_t
) bfd_get_bits (packet
, dump_size
* 8, false);
1182 return (*riscv_disassembler
) (memaddr
, insn
, packet
, info
);
1186 riscv_get_disassembler (bfd
*abfd
)
1188 const char *default_arch
= "rv64gc";
1190 if (abfd
&& bfd_get_flavour (abfd
) == bfd_target_elf_flavour
)
1192 const char *sec_name
= get_elf_backend_data (abfd
)->obj_attrs_section
;
1193 if (bfd_get_section_by_name (abfd
, sec_name
) != NULL
)
1195 obj_attribute
*attr
= elf_known_obj_attributes_proc (abfd
);
1196 unsigned int Tag_a
= Tag_RISCV_priv_spec
;
1197 unsigned int Tag_b
= Tag_RISCV_priv_spec_minor
;
1198 unsigned int Tag_c
= Tag_RISCV_priv_spec_revision
;
1199 riscv_get_priv_spec_class_from_numbers (attr
[Tag_a
].i
,
1202 &default_priv_spec
);
1203 default_arch
= attr
[Tag_RISCV_arch
].s
;
1207 riscv_release_subset_list (&riscv_subsets
);
1208 riscv_parse_subset (&riscv_rps_dis
, default_arch
);
1209 return print_insn_riscv
;
1212 /* Prevent use of the fake labels that are generated as part of the DWARF
1213 and for relaxable relocations in the assembler. */
1216 riscv_symbol_is_valid (asymbol
* sym
,
1217 struct disassemble_info
* info ATTRIBUTE_UNUSED
)
1224 name
= bfd_asymbol_name (sym
);
1226 return (strcmp (name
, RISCV_FAKE_LABEL_NAME
) != 0
1227 && !riscv_elf_is_mapping_symbols (name
));
1231 /* Indices into option argument vector for options accepting an argument.
1232 Use RISCV_OPTION_ARG_NONE for options accepting no argument. */
1236 RISCV_OPTION_ARG_NONE
= -1,
1237 RISCV_OPTION_ARG_PRIV_SPEC
,
1239 RISCV_OPTION_ARG_COUNT
1240 } riscv_option_arg_t
;
1242 /* Valid RISCV disassembler options. */
1247 const char *description
;
1248 riscv_option_arg_t arg
;
1252 N_("Print numeric register names, rather than ABI names."),
1253 RISCV_OPTION_ARG_NONE
},
1255 N_("Disassemble only into canonical instructions."),
1256 RISCV_OPTION_ARG_NONE
},
1258 N_("Print the CSR according to the chosen privilege spec."),
1259 RISCV_OPTION_ARG_PRIV_SPEC
}
1262 /* Build the structure representing valid RISCV disassembler options.
1263 This is done dynamically for maintenance ease purpose; a static
1264 initializer would be unreadable. */
1266 const disasm_options_and_args_t
*
1267 disassembler_options_riscv (void)
1269 static disasm_options_and_args_t
*opts_and_args
;
1271 if (opts_and_args
== NULL
)
1273 size_t num_options
= ARRAY_SIZE (riscv_options
);
1274 size_t num_args
= RISCV_OPTION_ARG_COUNT
;
1275 disasm_option_arg_t
*args
;
1276 disasm_options_t
*opts
;
1277 size_t i
, priv_spec_count
;
1279 args
= XNEWVEC (disasm_option_arg_t
, num_args
+ 1);
1281 args
[RISCV_OPTION_ARG_PRIV_SPEC
].name
= "SPEC";
1282 priv_spec_count
= PRIV_SPEC_CLASS_DRAFT
- PRIV_SPEC_CLASS_NONE
- 1;
1283 args
[RISCV_OPTION_ARG_PRIV_SPEC
].values
1284 = XNEWVEC (const char *, priv_spec_count
+ 1);
1285 for (i
= 0; i
< priv_spec_count
; i
++)
1286 args
[RISCV_OPTION_ARG_PRIV_SPEC
].values
[i
]
1287 = riscv_priv_specs
[i
].name
;
1288 /* The array we return must be NULL terminated. */
1289 args
[RISCV_OPTION_ARG_PRIV_SPEC
].values
[i
] = NULL
;
1291 /* The array we return must be NULL terminated. */
1292 args
[num_args
].name
= NULL
;
1293 args
[num_args
].values
= NULL
;
1295 opts_and_args
= XNEW (disasm_options_and_args_t
);
1296 opts_and_args
->args
= args
;
1298 opts
= &opts_and_args
->options
;
1299 opts
->name
= XNEWVEC (const char *, num_options
+ 1);
1300 opts
->description
= XNEWVEC (const char *, num_options
+ 1);
1301 opts
->arg
= XNEWVEC (const disasm_option_arg_t
*, num_options
+ 1);
1302 for (i
= 0; i
< num_options
; i
++)
1304 opts
->name
[i
] = riscv_options
[i
].name
;
1305 opts
->description
[i
] = _(riscv_options
[i
].description
);
1306 if (riscv_options
[i
].arg
!= RISCV_OPTION_ARG_NONE
)
1307 opts
->arg
[i
] = &args
[riscv_options
[i
].arg
];
1309 opts
->arg
[i
] = NULL
;
1311 /* The array we return must be NULL terminated. */
1312 opts
->name
[i
] = NULL
;
1313 opts
->description
[i
] = NULL
;
1314 opts
->arg
[i
] = NULL
;
1317 return opts_and_args
;
1321 print_riscv_disassembler_options (FILE *stream
)
1323 const disasm_options_and_args_t
*opts_and_args
;
1324 const disasm_option_arg_t
*args
;
1325 const disasm_options_t
*opts
;
1330 opts_and_args
= disassembler_options_riscv ();
1331 opts
= &opts_and_args
->options
;
1332 args
= opts_and_args
->args
;
1334 fprintf (stream
, _("\n\
1335 The following RISC-V specific disassembler options are supported for use\n\
1336 with the -M switch (multiple options should be separated by commas):\n"));
1337 fprintf (stream
, "\n");
1339 /* Compute the length of the longest option name. */
1340 for (i
= 0; opts
->name
[i
] != NULL
; i
++)
1342 size_t len
= strlen (opts
->name
[i
]);
1344 if (opts
->arg
[i
] != NULL
)
1345 len
+= strlen (opts
->arg
[i
]->name
);
1350 for (i
= 0, max_len
++; opts
->name
[i
] != NULL
; i
++)
1352 fprintf (stream
, " %s", opts
->name
[i
]);
1353 if (opts
->arg
[i
] != NULL
)
1354 fprintf (stream
, "%s", opts
->arg
[i
]->name
);
1355 if (opts
->description
[i
] != NULL
)
1357 size_t len
= strlen (opts
->name
[i
]);
1359 if (opts
->arg
!= NULL
&& opts
->arg
[i
] != NULL
)
1360 len
+= strlen (opts
->arg
[i
]->name
);
1361 fprintf (stream
, "%*c %s", (int) (max_len
- len
), ' ',
1362 opts
->description
[i
]);
1364 fprintf (stream
, "\n");
1367 for (i
= 0; args
[i
].name
!= NULL
; i
++)
1369 if (args
[i
].values
== NULL
)
1371 fprintf (stream
, _("\n\
1372 For the options above, the following values are supported for \"%s\":\n "),
1374 for (j
= 0; args
[i
].values
[j
] != NULL
; j
++)
1375 fprintf (stream
, " %s", args
[i
].values
[j
]);
1376 fprintf (stream
, _("\n"));
1379 fprintf (stream
, _("\n"));
1382 void disassemble_free_riscv (struct disassemble_info
*info ATTRIBUTE_UNUSED
)
1384 riscv_release_subset_list (&riscv_subsets
);