2 Copyright (C) 2011-2020 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"
31 #include "bfd_stdint.h"
34 static enum riscv_priv_spec_class default_priv_spec
= PRIV_SPEC_CLASS_NONE
;
36 struct riscv_private_data
40 bfd_vma hi_addr
[OP_MASK_RD
+ 1];
43 static const char * const *riscv_gpr_names
;
44 static const char * const *riscv_fpr_names
;
47 static int no_aliases
; /* If set disassemble as most general inst. */
50 set_default_riscv_dis_options (void)
52 riscv_gpr_names
= riscv_gpr_names_abi
;
53 riscv_fpr_names
= riscv_fpr_names_abi
;
58 parse_riscv_dis_option_without_args (const char *option
)
60 if (strcmp (option
, "no-aliases") == 0)
62 else if (strcmp (option
, "numeric") == 0)
64 riscv_gpr_names
= riscv_gpr_names_numeric
;
65 riscv_fpr_names
= riscv_fpr_names_numeric
;
73 parse_riscv_dis_option (const char *option
)
77 if (parse_riscv_dis_option_without_args (option
))
80 equal
= strchr (option
, '=');
83 /* The option without '=' should be defined above. */
84 opcodes_error_handler (_("unrecognized disassembler option: %s"), option
);
88 || *(equal
+ 1) == '\0')
90 /* Invalid options with '=', no option name before '=',
91 and no value after '='. */
92 opcodes_error_handler (_("unrecognized disassembler option with '=': %s"),
99 if (strcmp (option
, "priv-spec") == 0)
101 if (!riscv_get_priv_spec_class (value
, &default_priv_spec
))
102 opcodes_error_handler (_("unknown privilege spec set by %s=%s"),
107 /* xgettext:c-format */
108 opcodes_error_handler (_("unrecognized disassembler option: %s"), option
);
113 parse_riscv_dis_options (const char *opts_in
)
115 char *opts
= xstrdup (opts_in
), *opt
= opts
, *opt_end
= opts
;
117 set_default_riscv_dis_options ();
119 for ( ; opt_end
!= NULL
; opt
= opt_end
+ 1)
121 if ((opt_end
= strchr (opt
, ',')) != NULL
)
123 parse_riscv_dis_option (opt
);
129 /* Print one argument from an array. */
132 arg_print (struct disassemble_info
*info
, unsigned long val
,
133 const char* const* array
, size_t size
)
135 const char *s
= val
>= size
|| array
[val
] == NULL
? "unknown" : array
[val
];
136 (*info
->fprintf_func
) (info
->stream
, "%s", s
);
140 maybe_print_address (struct riscv_private_data
*pd
, int base_reg
, int offset
)
142 if (pd
->hi_addr
[base_reg
] != (bfd_vma
)-1)
144 pd
->print_addr
= (base_reg
!= 0 ? pd
->hi_addr
[base_reg
] : 0) + offset
;
145 pd
->hi_addr
[base_reg
] = -1;
147 else if (base_reg
== X_GP
&& pd
->gp
!= (bfd_vma
)-1)
148 pd
->print_addr
= pd
->gp
+ offset
;
149 else if (base_reg
== X_TP
|| base_reg
== 0)
150 pd
->print_addr
= offset
;
153 /* Print insn arguments for 32/64-bit code. */
156 print_insn_args (const char *d
, insn_t l
, bfd_vma pc
, disassemble_info
*info
)
158 struct riscv_private_data
*pd
= info
->private_data
;
159 int rs1
= (l
>> OP_SH_RS1
) & OP_MASK_RS1
;
160 int rd
= (l
>> OP_SH_RD
) & OP_MASK_RD
;
161 fprintf_ftype print
= info
->fprintf_func
;
164 print (info
->stream
, "\t");
166 for (; *d
!= '\0'; d
++)
173 case 's': /* RS1 x8-x15 */
174 case 'w': /* RS1 x8-x15 */
175 print (info
->stream
, "%s",
176 riscv_gpr_names
[EXTRACT_OPERAND (CRS1S
, l
) + 8]);
178 case 't': /* RS2 x8-x15 */
179 case 'x': /* RS2 x8-x15 */
180 print (info
->stream
, "%s",
181 riscv_gpr_names
[EXTRACT_OPERAND (CRS2S
, l
) + 8]);
183 case 'U': /* RS1, constrained to equal RD */
184 print (info
->stream
, "%s", riscv_gpr_names
[rd
]);
186 case 'c': /* RS1, constrained to equal sp */
187 print (info
->stream
, "%s", riscv_gpr_names
[X_SP
]);
190 print (info
->stream
, "%s",
191 riscv_gpr_names
[EXTRACT_OPERAND (CRS2
, l
)]);
194 print (info
->stream
, "%d", (int)EXTRACT_RVC_SIMM3 (l
));
198 print (info
->stream
, "%d", (int)EXTRACT_RVC_IMM (l
));
201 print (info
->stream
, "%d", (int)EXTRACT_RVC_LW_IMM (l
));
204 print (info
->stream
, "%d", (int)EXTRACT_RVC_LD_IMM (l
));
207 print (info
->stream
, "%d", (int)EXTRACT_RVC_LWSP_IMM (l
));
210 print (info
->stream
, "%d", (int)EXTRACT_RVC_LDSP_IMM (l
));
213 print (info
->stream
, "%d", (int)EXTRACT_RVC_ADDI4SPN_IMM (l
));
216 print (info
->stream
, "%d", (int)EXTRACT_RVC_ADDI16SP_IMM (l
));
219 print (info
->stream
, "%d", (int)EXTRACT_RVC_SWSP_IMM (l
));
222 print (info
->stream
, "%d", (int)EXTRACT_RVC_SDSP_IMM (l
));
225 info
->target
= EXTRACT_RVC_B_IMM (l
) + pc
;
226 (*info
->print_address_func
) (info
->target
, info
);
229 info
->target
= EXTRACT_RVC_J_IMM (l
) + pc
;
230 (*info
->print_address_func
) (info
->target
, info
);
233 print (info
->stream
, "0x%x",
234 (int)(EXTRACT_RVC_IMM (l
) & (RISCV_BIGIMM_REACH
-1)));
237 print (info
->stream
, "0x%x", (int)EXTRACT_RVC_IMM (l
) & 0x3f);
240 print (info
->stream
, "0x%x", (int)EXTRACT_RVC_IMM (l
) & 0x1f);
242 case 'T': /* floating-point RS2 */
243 print (info
->stream
, "%s",
244 riscv_fpr_names
[EXTRACT_OPERAND (CRS2
, l
)]);
246 case 'D': /* floating-point RS2 x8-x15 */
247 print (info
->stream
, "%s",
248 riscv_fpr_names
[EXTRACT_OPERAND (CRS2S
, l
) + 8]);
258 print (info
->stream
, "%c", *d
);
262 /* Only print constant 0 if it is the last argument */
264 print (info
->stream
, "0");
269 if ((l
& MASK_JALR
) == MATCH_JALR
)
270 maybe_print_address (pd
, rs1
, 0);
271 print (info
->stream
, "%s", riscv_gpr_names
[rs1
]);
275 print (info
->stream
, "%s",
276 riscv_gpr_names
[EXTRACT_OPERAND (RS2
, l
)]);
280 print (info
->stream
, "0x%x",
281 (unsigned)EXTRACT_UTYPE_IMM (l
) >> RISCV_IMM_BITS
);
285 arg_print (info
, EXTRACT_OPERAND (RM
, l
),
286 riscv_rm
, ARRAY_SIZE (riscv_rm
));
290 arg_print (info
, EXTRACT_OPERAND (PRED
, l
),
291 riscv_pred_succ
, ARRAY_SIZE (riscv_pred_succ
));
295 arg_print (info
, EXTRACT_OPERAND (SUCC
, l
),
296 riscv_pred_succ
, ARRAY_SIZE (riscv_pred_succ
));
300 maybe_print_address (pd
, rs1
, EXTRACT_ITYPE_IMM (l
));
303 if (((l
& MASK_ADDI
) == MATCH_ADDI
&& rs1
!= 0)
304 || (l
& MASK_JALR
) == MATCH_JALR
)
305 maybe_print_address (pd
, rs1
, EXTRACT_ITYPE_IMM (l
));
306 print (info
->stream
, "%d", (int)EXTRACT_ITYPE_IMM (l
));
310 maybe_print_address (pd
, rs1
, EXTRACT_STYPE_IMM (l
));
311 print (info
->stream
, "%d", (int)EXTRACT_STYPE_IMM (l
));
315 info
->target
= EXTRACT_UJTYPE_IMM (l
) + pc
;
316 (*info
->print_address_func
) (info
->target
, info
);
320 info
->target
= EXTRACT_SBTYPE_IMM (l
) + pc
;
321 (*info
->print_address_func
) (info
->target
, info
);
325 if ((l
& MASK_AUIPC
) == MATCH_AUIPC
)
326 pd
->hi_addr
[rd
] = pc
+ EXTRACT_UTYPE_IMM (l
);
327 else if ((l
& MASK_LUI
) == MATCH_LUI
)
328 pd
->hi_addr
[rd
] = EXTRACT_UTYPE_IMM (l
);
329 else if ((l
& MASK_C_LUI
) == MATCH_C_LUI
)
330 pd
->hi_addr
[rd
] = EXTRACT_RVC_LUI_IMM (l
);
331 print (info
->stream
, "%s", riscv_gpr_names
[rd
]);
335 print (info
->stream
, "%s", riscv_gpr_names
[0]);
339 print (info
->stream
, "0x%x", (int)EXTRACT_OPERAND (SHAMT
, l
));
343 print (info
->stream
, "0x%x", (int)EXTRACT_OPERAND (SHAMTW
, l
));
348 print (info
->stream
, "%s", riscv_fpr_names
[rs1
]);
352 print (info
->stream
, "%s", riscv_fpr_names
[EXTRACT_OPERAND (RS2
, l
)]);
356 print (info
->stream
, "%s", riscv_fpr_names
[rd
]);
360 print (info
->stream
, "%s", riscv_fpr_names
[EXTRACT_OPERAND (RS3
, l
)]);
365 static const char *riscv_csr_hash
[4096]; /* Total 2^12 CSR. */
366 static bfd_boolean init_csr
= FALSE
;
367 unsigned int csr
= EXTRACT_OPERAND (CSR
, l
);
372 for (i
= 0; i
< 4096; i
++)
373 riscv_csr_hash
[i
] = NULL
;
375 /* Set to the newest privilege version. */
376 if (default_priv_spec
== PRIV_SPEC_CLASS_NONE
)
377 default_priv_spec
= PRIV_SPEC_CLASS_DRAFT
- 1;
379 #define DECLARE_CSR(name, num, class, define_version, abort_version) \
380 if (default_priv_spec >= define_version \
381 && default_priv_spec < abort_version) \
382 riscv_csr_hash[num] = #name;
383 #define DECLARE_CSR_ALIAS(name, num, class, define_version, abort_version) \
384 DECLARE_CSR (name, num, class, define_version, abort_version)
385 #include "opcode/riscv-opc.h"
389 if (riscv_csr_hash
[csr
] != NULL
)
390 print (info
->stream
, "%s", riscv_csr_hash
[csr
]);
392 print (info
->stream
, "0x%x", csr
);
397 print (info
->stream
, "%d", rs1
);
401 /* xgettext:c-format */
402 print (info
->stream
, _("# internal error, undefined modifier (%c)"),
409 /* Print the RISC-V instruction at address MEMADDR in debugged memory,
410 on using INFO. Returns length of the instruction, in bytes.
411 BIGENDIAN must be 1 if this is big-endian code, 0 if
412 this is little-endian code. */
415 riscv_disassemble_insn (bfd_vma memaddr
, insn_t word
, disassemble_info
*info
)
417 const struct riscv_opcode
*op
;
418 static bfd_boolean init
= 0;
419 static const struct riscv_opcode
*riscv_hash
[OP_MASK_OP
+ 1];
420 struct riscv_private_data
*pd
;
423 #define OP_HASH_IDX(i) ((i) & (riscv_insn_length (i) == 2 ? 0x3 : OP_MASK_OP))
425 /* Build a hash table to shorten the search time. */
428 for (op
= riscv_opcodes
; op
->name
; op
++)
429 if (!riscv_hash
[OP_HASH_IDX (op
->match
)])
430 riscv_hash
[OP_HASH_IDX (op
->match
)] = op
;
435 if (info
->private_data
== NULL
)
439 pd
= info
->private_data
= xcalloc (1, sizeof (struct riscv_private_data
));
442 for (i
= 0; i
< (int)ARRAY_SIZE (pd
->hi_addr
); i
++)
445 for (i
= 0; i
< info
->symtab_size
; i
++)
446 if (strcmp (bfd_asymbol_name (info
->symtab
[i
]), RISCV_GP_SYMBOL
) == 0)
447 pd
->gp
= bfd_asymbol_value (info
->symtab
[i
]);
450 pd
= info
->private_data
;
452 insnlen
= riscv_insn_length (word
);
454 /* RISC-V instructions are always little-endian. */
455 info
->endian_code
= BFD_ENDIAN_LITTLE
;
457 info
->bytes_per_chunk
= insnlen
% 4 == 0 ? 4 : 2;
458 info
->bytes_per_line
= 8;
459 /* We don't support constant pools, so this must be code. */
460 info
->display_endian
= info
->endian_code
;
461 info
->insn_info_valid
= 1;
462 info
->branch_delay_insns
= 0;
464 info
->insn_type
= dis_nonbranch
;
468 op
= riscv_hash
[OP_HASH_IDX (word
)];
473 /* If XLEN is not known, get its value from the ELF class. */
474 if (info
->mach
== bfd_mach_riscv64
)
476 else if (info
->mach
== bfd_mach_riscv32
)
478 else if (info
->section
!= NULL
)
480 Elf_Internal_Ehdr
*ehdr
= elf_elfheader (info
->section
->owner
);
481 xlen
= ehdr
->e_ident
[EI_CLASS
] == ELFCLASS64
? 64 : 32;
484 for (; op
->name
; op
++)
486 /* Does the opcode match? */
487 if (! (op
->match_func
) (op
, word
))
489 /* Is this a pseudo-instruction and may we print it as such? */
490 if (no_aliases
&& (op
->pinfo
& INSN_ALIAS
))
492 /* Is this instruction restricted to a certain value of XLEN? */
493 if ((op
->xlen_requirement
!= 0) && (op
->xlen_requirement
!= xlen
))
497 (*info
->fprintf_func
) (info
->stream
, "%s", op
->name
);
498 print_insn_args (op
->args
, word
, memaddr
, info
);
500 /* Try to disassemble multi-instruction addressing sequences. */
501 if (pd
->print_addr
!= (bfd_vma
)-1)
503 info
->target
= pd
->print_addr
;
504 (*info
->fprintf_func
) (info
->stream
, " # ");
505 (*info
->print_address_func
) (info
->target
, info
);
509 /* Finish filling out insn_info fields. */
510 switch (op
->pinfo
& INSN_TYPE
)
513 info
->insn_type
= dis_branch
;
515 case INSN_CONDBRANCH
:
516 info
->insn_type
= dis_condbranch
;
519 info
->insn_type
= dis_jsr
;
522 info
->insn_type
= dis_dref
;
528 if (op
->pinfo
& INSN_DATA_SIZE
)
530 int size
= ((op
->pinfo
& INSN_DATA_SIZE
)
531 >> INSN_DATA_SIZE_SHIFT
);
532 info
->data_size
= 1 << (size
- 1);
539 /* We did not find a match, so just print the instruction bits. */
540 info
->insn_type
= dis_noninsn
;
541 (*info
->fprintf_func
) (info
->stream
, "0x%llx", (unsigned long long)word
);
546 print_insn_riscv (bfd_vma memaddr
, struct disassemble_info
*info
)
553 if (info
->disassembler_options
!= NULL
)
555 parse_riscv_dis_options (info
->disassembler_options
);
556 /* Avoid repeatedly parsing the options. */
557 info
->disassembler_options
= NULL
;
559 else if (riscv_gpr_names
== NULL
)
560 set_default_riscv_dis_options ();
562 /* Instructions are a sequence of 2-byte packets in little-endian order. */
563 for (n
= 0; n
< sizeof (insn
) && n
< riscv_insn_length (insn
); n
+= 2)
565 status
= (*info
->read_memory_func
) (memaddr
+ n
, packet
, 2, info
);
568 /* Don't fail just because we fell off the end. */
571 (*info
->memory_error_func
) (status
, memaddr
, info
);
575 insn
|= ((insn_t
) bfd_getl16 (packet
)) << (8 * n
);
578 return riscv_disassemble_insn (memaddr
, insn
, info
);
581 /* Prevent use of the fake labels that are generated as part of the DWARF
582 and for relaxable relocations in the assembler. */
585 riscv_symbol_is_valid (asymbol
* sym
,
586 struct disassemble_info
* info ATTRIBUTE_UNUSED
)
593 name
= bfd_asymbol_name (sym
);
595 return (strcmp (name
, RISCV_FAKE_LABEL_NAME
) != 0);
599 print_riscv_disassembler_options (FILE *stream
)
601 fprintf (stream
, _("\n\
602 The following RISC-V-specific disassembler options are supported for use\n\
603 with the -M switch (multiple options should be separated by commas):\n"));
605 fprintf (stream
, _("\n\
606 numeric Print numeric register names, rather than ABI names.\n"));
608 fprintf (stream
, _("\n\
609 no-aliases Disassemble only into canonical instructions, rather\n\
610 than into pseudoinstructions.\n"));
612 fprintf (stream
, _("\n\
613 priv-spec=PRIV Print the CSR according to the chosen privilege spec\n\
614 (1.9, 1.9.1, 1.10, 1.11).\n"));
616 fprintf (stream
, _("\n"));