2 Copyright (C) 2011-2017 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/>. */
25 #include "libiberty.h"
26 #include "opcode/riscv.h"
29 #include "elf/riscv.h"
34 struct riscv_private_data
38 bfd_vma hi_addr
[OP_MASK_RD
+ 1];
41 static const char * const *riscv_gpr_names
;
42 static const char * const *riscv_fpr_names
;
45 static int no_aliases
; /* If set disassemble as most general inst. */
48 set_default_riscv_dis_options (void)
50 riscv_gpr_names
= riscv_gpr_names_abi
;
51 riscv_fpr_names
= riscv_fpr_names_abi
;
56 parse_riscv_dis_option (const char *option
)
58 if (strcmp (option
, "no-aliases") == 0)
60 else if (strcmp (option
, "numeric") == 0)
62 riscv_gpr_names
= riscv_gpr_names_numeric
;
63 riscv_fpr_names
= riscv_fpr_names_numeric
;
68 fprintf (stderr
, _("Unrecognized disassembler option: %s\n"), option
);
73 parse_riscv_dis_options (const char *opts_in
)
75 char *opts
= xstrdup (opts_in
), *opt
= opts
, *opt_end
= opts
;
77 set_default_riscv_dis_options ();
79 for ( ; opt_end
!= NULL
; opt
= opt_end
+ 1)
81 if ((opt_end
= strchr (opt
, ',')) != NULL
)
83 parse_riscv_dis_option (opt
);
89 /* Print one argument from an array. */
92 arg_print (struct disassemble_info
*info
, unsigned long val
,
93 const char* const* array
, size_t size
)
95 const char *s
= val
>= size
|| array
[val
] == NULL
? "unknown" : array
[val
];
96 (*info
->fprintf_func
) (info
->stream
, "%s", s
);
100 maybe_print_address (struct riscv_private_data
*pd
, int base_reg
, int offset
)
102 if (pd
->hi_addr
[base_reg
] != (bfd_vma
)-1)
104 pd
->print_addr
= pd
->hi_addr
[base_reg
] + offset
;
105 pd
->hi_addr
[base_reg
] = -1;
107 else if (base_reg
== X_GP
&& pd
->gp
!= (bfd_vma
)-1)
108 pd
->print_addr
= pd
->gp
+ offset
;
109 else if (base_reg
== X_TP
|| base_reg
== 0)
110 pd
->print_addr
= offset
;
113 /* Print insn arguments for 32/64-bit code. */
116 print_insn_args (const char *d
, insn_t l
, bfd_vma pc
, disassemble_info
*info
)
118 struct riscv_private_data
*pd
= info
->private_data
;
119 int rs1
= (l
>> OP_SH_RS1
) & OP_MASK_RS1
;
120 int rd
= (l
>> OP_SH_RD
) & OP_MASK_RD
;
121 fprintf_ftype print
= info
->fprintf_func
;
124 print (info
->stream
, "\t");
126 for (; *d
!= '\0'; d
++)
133 case 's': /* RS1 x8-x15 */
134 case 'w': /* RS1 x8-x15 */
135 print (info
->stream
, "%s",
136 riscv_gpr_names
[EXTRACT_OPERAND (CRS1S
, l
) + 8]);
138 case 't': /* RS2 x8-x15 */
139 case 'x': /* RS2 x8-x15 */
140 print (info
->stream
, "%s",
141 riscv_gpr_names
[EXTRACT_OPERAND (CRS2S
, l
) + 8]);
143 case 'U': /* RS1, constrained to equal RD */
144 print (info
->stream
, "%s", riscv_gpr_names
[rd
]);
146 case 'c': /* RS1, constrained to equal sp */
147 print (info
->stream
, "%s", riscv_gpr_names
[X_SP
]);
150 print (info
->stream
, "%s",
151 riscv_gpr_names
[EXTRACT_OPERAND (CRS2
, l
)]);
154 print (info
->stream
, "%d", (int)EXTRACT_RVC_SIMM3 (l
));
157 print (info
->stream
, "%d", (int)EXTRACT_RVC_IMM (l
));
160 print (info
->stream
, "%d", (int)EXTRACT_RVC_LW_IMM (l
));
163 print (info
->stream
, "%d", (int)EXTRACT_RVC_LD_IMM (l
));
166 print (info
->stream
, "%d", (int)EXTRACT_RVC_LWSP_IMM (l
));
169 print (info
->stream
, "%d", (int)EXTRACT_RVC_LDSP_IMM (l
));
172 print (info
->stream
, "%d", (int)EXTRACT_RVC_ADDI4SPN_IMM (l
));
175 print (info
->stream
, "%d", (int)EXTRACT_RVC_ADDI16SP_IMM (l
));
178 print (info
->stream
, "%d", (int)EXTRACT_RVC_SWSP_IMM (l
));
181 print (info
->stream
, "%d", (int)EXTRACT_RVC_SDSP_IMM (l
));
184 info
->target
= EXTRACT_RVC_B_IMM (l
) + pc
;
185 (*info
->print_address_func
) (info
->target
, info
);
188 info
->target
= EXTRACT_RVC_J_IMM (l
) + pc
;
189 (*info
->print_address_func
) (info
->target
, info
);
192 print (info
->stream
, "0x%x",
193 (int)(EXTRACT_RVC_IMM (l
) & (RISCV_BIGIMM_REACH
-1)));
196 print (info
->stream
, "0x%x", (int)EXTRACT_RVC_IMM (l
) & 0x3f);
199 print (info
->stream
, "0x%x", (int)EXTRACT_RVC_IMM (l
) & 0x1f);
201 case 'T': /* floating-point RS2 */
202 print (info
->stream
, "%s",
203 riscv_fpr_names
[EXTRACT_OPERAND (CRS2
, l
)]);
205 case 'D': /* floating-point RS2 x8-x15 */
206 print (info
->stream
, "%s",
207 riscv_fpr_names
[EXTRACT_OPERAND (CRS2S
, l
) + 8]);
217 print (info
->stream
, "%c", *d
);
221 /* Only print constant 0 if it is the last argument */
223 print (info
->stream
, "0");
228 print (info
->stream
, "%s", riscv_gpr_names
[rs1
]);
232 print (info
->stream
, "%s",
233 riscv_gpr_names
[EXTRACT_OPERAND (RS2
, l
)]);
237 print (info
->stream
, "0x%x",
238 (unsigned)EXTRACT_UTYPE_IMM (l
) >> RISCV_IMM_BITS
);
242 arg_print (info
, EXTRACT_OPERAND (RM
, l
),
243 riscv_rm
, ARRAY_SIZE (riscv_rm
));
247 arg_print (info
, EXTRACT_OPERAND (PRED
, l
),
248 riscv_pred_succ
, ARRAY_SIZE (riscv_pred_succ
));
252 arg_print (info
, EXTRACT_OPERAND (SUCC
, l
),
253 riscv_pred_succ
, ARRAY_SIZE (riscv_pred_succ
));
257 maybe_print_address (pd
, rs1
, EXTRACT_ITYPE_IMM (l
));
260 if (((l
& MASK_ADDI
) == MATCH_ADDI
&& rs1
!= 0)
261 || (l
& MASK_JALR
) == MATCH_JALR
)
262 maybe_print_address (pd
, rs1
, EXTRACT_ITYPE_IMM (l
));
263 print (info
->stream
, "%d", (int)EXTRACT_ITYPE_IMM (l
));
267 maybe_print_address (pd
, rs1
, EXTRACT_STYPE_IMM (l
));
268 print (info
->stream
, "%d", (int)EXTRACT_STYPE_IMM (l
));
272 info
->target
= EXTRACT_UJTYPE_IMM (l
) + pc
;
273 (*info
->print_address_func
) (info
->target
, info
);
277 info
->target
= EXTRACT_SBTYPE_IMM (l
) + pc
;
278 (*info
->print_address_func
) (info
->target
, info
);
282 if ((l
& MASK_AUIPC
) == MATCH_AUIPC
)
283 pd
->hi_addr
[rd
] = pc
+ EXTRACT_UTYPE_IMM (l
);
284 else if ((l
& MASK_LUI
) == MATCH_LUI
)
285 pd
->hi_addr
[rd
] = EXTRACT_UTYPE_IMM (l
);
286 else if ((l
& MASK_C_LUI
) == MATCH_C_LUI
)
287 pd
->hi_addr
[rd
] = EXTRACT_RVC_LUI_IMM (l
);
288 print (info
->stream
, "%s", riscv_gpr_names
[rd
]);
292 print (info
->stream
, "%s", riscv_gpr_names
[0]);
296 print (info
->stream
, "0x%x", (int)EXTRACT_OPERAND (SHAMT
, l
));
300 print (info
->stream
, "0x%x", (int)EXTRACT_OPERAND (SHAMTW
, l
));
305 print (info
->stream
, "%s", riscv_fpr_names
[rs1
]);
309 print (info
->stream
, "%s", riscv_fpr_names
[EXTRACT_OPERAND (RS2
, l
)]);
313 print (info
->stream
, "%s", riscv_fpr_names
[rd
]);
317 print (info
->stream
, "%s", riscv_fpr_names
[EXTRACT_OPERAND (RS3
, l
)]);
322 const char* csr_name
= NULL
;
323 unsigned int csr
= EXTRACT_OPERAND (CSR
, l
);
326 #define DECLARE_CSR(name, num) case num: csr_name = #name; break;
327 #include "opcode/riscv-opc.h"
331 print (info
->stream
, "%s", csr_name
);
333 print (info
->stream
, "0x%x", csr
);
338 print (info
->stream
, "%d", rs1
);
342 /* xgettext:c-format */
343 print (info
->stream
, _("# internal error, undefined modifier (%c)"),
350 /* Print the RISC-V instruction at address MEMADDR in debugged memory,
351 on using INFO. Returns length of the instruction, in bytes.
352 BIGENDIAN must be 1 if this is big-endian code, 0 if
353 this is little-endian code. */
356 riscv_disassemble_insn (bfd_vma memaddr
, insn_t word
, disassemble_info
*info
)
358 const struct riscv_opcode
*op
;
359 static bfd_boolean init
= 0;
360 static const struct riscv_opcode
*riscv_hash
[OP_MASK_OP
+ 1];
361 struct riscv_private_data
*pd
;
364 #define OP_HASH_IDX(i) ((i) & (riscv_insn_length (i) == 2 ? 0x3 : OP_MASK_OP))
366 /* Build a hash table to shorten the search time. */
369 for (op
= riscv_opcodes
; op
->name
; op
++)
370 if (!riscv_hash
[OP_HASH_IDX (op
->match
)])
371 riscv_hash
[OP_HASH_IDX (op
->match
)] = op
;
376 if (info
->private_data
== NULL
)
380 pd
= info
->private_data
= xcalloc (1, sizeof (struct riscv_private_data
));
383 for (i
= 0; i
< (int)ARRAY_SIZE (pd
->hi_addr
); i
++)
386 for (i
= 0; i
< info
->symtab_size
; i
++)
387 if (strcmp (bfd_asymbol_name (info
->symtab
[i
]), RISCV_GP_SYMBOL
) == 0)
388 pd
->gp
= bfd_asymbol_value (info
->symtab
[i
]);
391 pd
= info
->private_data
;
393 insnlen
= riscv_insn_length (word
);
395 info
->bytes_per_chunk
= insnlen
% 4 == 0 ? 4 : 2;
396 info
->bytes_per_line
= 8;
397 info
->display_endian
= info
->endian
;
398 info
->insn_info_valid
= 1;
399 info
->branch_delay_insns
= 0;
401 info
->insn_type
= dis_nonbranch
;
405 op
= riscv_hash
[OP_HASH_IDX (word
)];
410 /* If XLEN is not known, get its value from the ELF class. */
411 if (info
->mach
== bfd_mach_riscv64
)
413 else if (info
->mach
== bfd_mach_riscv32
)
415 else if (info
->section
!= NULL
)
417 Elf_Internal_Ehdr
*ehdr
= elf_elfheader (info
->section
->owner
);
418 xlen
= ehdr
->e_ident
[EI_CLASS
] == ELFCLASS64
? 64 : 32;
421 for (; op
->name
; op
++)
423 /* Does the opcode match? */
424 if (! (op
->match_func
) (op
, word
))
426 /* Is this a pseudo-instruction and may we print it as such? */
427 if (no_aliases
&& (op
->pinfo
& INSN_ALIAS
))
429 /* Is this instruction restricted to a certain value of XLEN? */
430 if (isdigit (op
->subset
[0]) && atoi (op
->subset
) != xlen
)
434 (*info
->fprintf_func
) (info
->stream
, "%s", op
->name
);
435 print_insn_args (op
->args
, word
, memaddr
, info
);
437 /* Try to disassemble multi-instruction addressing sequences. */
438 if (pd
->print_addr
!= (bfd_vma
)-1)
440 info
->target
= pd
->print_addr
;
441 (*info
->fprintf_func
) (info
->stream
, " # ");
442 (*info
->print_address_func
) (info
->target
, info
);
450 /* We did not find a match, so just print the instruction bits. */
451 info
->insn_type
= dis_noninsn
;
452 (*info
->fprintf_func
) (info
->stream
, "0x%llx", (unsigned long long)word
);
457 print_insn_riscv (bfd_vma memaddr
, struct disassemble_info
*info
)
464 if (info
->disassembler_options
!= NULL
)
466 parse_riscv_dis_options (info
->disassembler_options
);
467 /* Avoid repeatedly parsing the options. */
468 info
->disassembler_options
= NULL
;
470 else if (riscv_gpr_names
== NULL
)
471 set_default_riscv_dis_options ();
473 /* Instructions are a sequence of 2-byte packets in little-endian order. */
474 for (n
= 0; n
< sizeof (insn
) && n
< riscv_insn_length (insn
); n
+= 2)
476 status
= (*info
->read_memory_func
) (memaddr
+ n
, packet
, 2, info
);
479 /* Don't fail just because we fell off the end. */
482 (*info
->memory_error_func
) (status
, memaddr
, info
);
486 insn
|= ((insn_t
) bfd_getl16 (packet
)) << (8 * n
);
489 return riscv_disassemble_insn (memaddr
, insn
, info
);
493 print_riscv_disassembler_options (FILE *stream
)
495 fprintf (stream
, _("\n\
496 The following RISC-V-specific disassembler options are supported for use\n\
497 with the -M switch (multiple options should be separated by commas):\n"));
499 fprintf (stream
, _("\n\
500 numeric Print numeric reigster names, rather than ABI names.\n"));
502 fprintf (stream
, _("\n\
503 no-aliases Disassemble only into canonical instructions, rather\n\
504 than into pseudoinstructions.\n"));
506 fprintf (stream
, _("\n"));