1 /* DO NOT EDIT! -*- buffer-read-only: t -*- vi:set ro: */
2 /* Disassembler interface for targets using CGEN. -*- C -*-
3 CGEN: Cpu tools GENerator
5 THIS FILE IS MACHINE GENERATED WITH CGEN.
6 - the resultant file is machine generated, cgen-dis.in isn't
8 Copyright (C) 1996-2019 Free Software Foundation, Inc.
10 This file is part of libopcodes.
12 This library is free software; you can redistribute it and/or modify
13 it under the terms of the GNU General Public License as published by
14 the Free Software Foundation; either version 3, or (at your option)
17 It is distributed in the hope that it will be useful, but WITHOUT
18 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
19 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
20 License for more details.
22 You should have received a copy of the GNU General Public License
23 along with this program; if not, write to the Free Software Foundation, Inc.,
24 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA. */
26 /* ??? Eventually more and more of this stuff can go to cpu-independent files.
32 #include "disassemble.h"
35 #include "libiberty.h"
40 /* Default text to print if an instruction isn't recognized. */
41 #define UNKNOWN_INSN_MSG _("*unknown*")
43 static void print_normal
44 (CGEN_CPU_DESC, void *, long, unsigned int, bfd_vma, int);
45 static void print_address
46 (CGEN_CPU_DESC, void *, bfd_vma, unsigned int, bfd_vma, int) ATTRIBUTE_UNUSED;
47 static void print_keyword
48 (CGEN_CPU_DESC, void *, CGEN_KEYWORD *, long, unsigned int) ATTRIBUTE_UNUSED;
49 static void print_insn_normal
50 (CGEN_CPU_DESC, void *, const CGEN_INSN *, CGEN_FIELDS *, bfd_vma, int);
52 (CGEN_CPU_DESC, bfd_vma, disassemble_info *, bfd_byte *, unsigned);
53 static int default_print_insn
54 (CGEN_CPU_DESC, bfd_vma, disassemble_info *) ATTRIBUTE_UNUSED;
56 (CGEN_CPU_DESC, bfd_vma, disassemble_info *, bfd_byte *, int, CGEN_EXTRACT_INFO *,
59 /* -- disassembler routines inserted here. */
63 /* We need to customize the disassembler a bit:
64 - Use 8 bytes per line by default.
67 #define CGEN_PRINT_INSN bpf_print_insn
70 bpf_print_insn (CGEN_CPU_DESC cd, bfd_vma pc, disassemble_info *info)
72 bfd_byte buf[CGEN_MAX_INSN_SIZE];
76 info->bytes_per_chunk = 1;
77 info->bytes_per_line = 8;
79 /* Attempt to read the base part of the insn. */
80 buflen = cd->base_insn_bitsize / 8;
81 status = (*info->read_memory_func) (pc, buf, buflen, info);
83 /* Try again with the minimum part, if min < base. */
84 if (status != 0 && (cd->min_insn_bitsize < cd->base_insn_bitsize))
86 buflen = cd->min_insn_bitsize / 8;
87 status = (*info->read_memory_func) (pc, buf, buflen, info);
92 (*info->memory_error_func) (status, pc, info);
96 return print_insn (cd, pc, info, buf, buflen);
99 /* Signed immediates should be printed in hexadecimal. */
102 print_immediate (CGEN_CPU_DESC cd ATTRIBUTE_UNUSED,
105 unsigned int attrs ATTRIBUTE_UNUSED,
106 bfd_vma pc ATTRIBUTE_UNUSED,
107 int length ATTRIBUTE_UNUSED)
109 disassemble_info *info = (disassemble_info *) dis_info;
112 (*info->fprintf_func) (info->stream, "%" PRId64, value);
114 (*info->fprintf_func) (info->stream, "%#" PRIx64, value);
116 /* This is to avoid -Wunused-function for print_normal. */
118 print_normal (cd, dis_info, value, attrs, pc, length);
121 /* Endianness bit sizes should be printed in decimal. */
124 print_endsize (CGEN_CPU_DESC cd ATTRIBUTE_UNUSED,
127 unsigned int attrs ATTRIBUTE_UNUSED,
128 bfd_vma pc ATTRIBUTE_UNUSED,
129 int length ATTRIBUTE_UNUSED)
131 disassemble_info *info = (disassemble_info *) dis_info;
132 (*info->fprintf_func) (info->stream, "%lu", value);
138 void bpf_cgen_print_operand
139 (CGEN_CPU_DESC, int, PTR, CGEN_FIELDS *, void const *, bfd_vma, int);
141 /* Main entry point for printing operands.
142 XINFO is a `void *' and not a `disassemble_info *' to not put a requirement
143 of dis-asm.h on cgen.h.
145 This function is basically just a big switch statement. Earlier versions
146 used tables to look up the function to use, but
147 - if the table contains both assembler and disassembler functions then
148 the disassembler contains much of the assembler and vice-versa,
149 - there's a lot of inlining possibilities as things grow,
150 - using a switch statement avoids the function call overhead.
152 This function could be moved into `print_insn_normal', but keeping it
153 separate makes clear the interface between `print_insn_normal' and each of
157 bpf_cgen_print_operand (CGEN_CPU_DESC cd,
161 void const *attrs ATTRIBUTE_UNUSED,
165 disassemble_info *info = (disassemble_info *) xinfo;
169 case BPF_OPERAND_DISP16 :
170 print_normal (cd, info, fields->f_offset16, 0|(1<<CGEN_OPERAND_SIGNED)|(1<<CGEN_OPERAND_PCREL_ADDR), pc, length);
172 case BPF_OPERAND_DISP32 :
173 print_normal (cd, info, fields->f_imm32, 0|(1<<CGEN_OPERAND_SIGNED)|(1<<CGEN_OPERAND_PCREL_ADDR), pc, length);
175 case BPF_OPERAND_DSTBE :
176 print_keyword (cd, info, & bpf_cgen_opval_h_gpr, fields->f_dstbe, 0);
178 case BPF_OPERAND_DSTLE :
179 print_keyword (cd, info, & bpf_cgen_opval_h_gpr, fields->f_dstle, 0);
181 case BPF_OPERAND_ENDSIZE :
182 print_endsize (cd, info, fields->f_imm32, 0, pc, length);
184 case BPF_OPERAND_IMM32 :
185 print_immediate (cd, info, fields->f_imm32, 0|(1<<CGEN_OPERAND_SIGNED), pc, length);
187 case BPF_OPERAND_IMM64 :
188 print_immediate (cd, info, fields->f_imm64, 0|(1<<CGEN_OPERAND_SIGNED)|(1<<CGEN_OPERAND_VIRTUAL), pc, length);
190 case BPF_OPERAND_OFFSET16 :
191 print_immediate (cd, info, fields->f_offset16, 0|(1<<CGEN_OPERAND_SIGNED), pc, length);
193 case BPF_OPERAND_SRCBE :
194 print_keyword (cd, info, & bpf_cgen_opval_h_gpr, fields->f_srcbe, 0);
196 case BPF_OPERAND_SRCLE :
197 print_keyword (cd, info, & bpf_cgen_opval_h_gpr, fields->f_srcle, 0);
201 /* xgettext:c-format */
202 opcodes_error_handler
203 (_("internal error: unrecognized field %d while printing insn"),
209 cgen_print_fn * const bpf_cgen_print_handlers[] =
216 bpf_cgen_init_dis (CGEN_CPU_DESC cd)
218 bpf_cgen_init_opcode_table (cd);
219 bpf_cgen_init_ibld_table (cd);
220 cd->print_handlers = & bpf_cgen_print_handlers[0];
221 cd->print_operand = bpf_cgen_print_operand;
225 /* Default print handler. */
228 print_normal (CGEN_CPU_DESC cd ATTRIBUTE_UNUSED,
232 bfd_vma pc ATTRIBUTE_UNUSED,
233 int length ATTRIBUTE_UNUSED)
235 disassemble_info *info = (disassemble_info *) dis_info;
237 /* Print the operand as directed by the attributes. */
238 if (CGEN_BOOL_ATTR (attrs, CGEN_OPERAND_SEM_ONLY))
239 ; /* nothing to do */
240 else if (CGEN_BOOL_ATTR (attrs, CGEN_OPERAND_SIGNED))
241 (*info->fprintf_func) (info->stream, "%ld", value);
243 (*info->fprintf_func) (info->stream, "0x%lx", value);
246 /* Default address handler. */
249 print_address (CGEN_CPU_DESC cd ATTRIBUTE_UNUSED,
253 bfd_vma pc ATTRIBUTE_UNUSED,
254 int length ATTRIBUTE_UNUSED)
256 disassemble_info *info = (disassemble_info *) dis_info;
258 /* Print the operand as directed by the attributes. */
259 if (CGEN_BOOL_ATTR (attrs, CGEN_OPERAND_SEM_ONLY))
260 ; /* Nothing to do. */
261 else if (CGEN_BOOL_ATTR (attrs, CGEN_OPERAND_PCREL_ADDR))
262 (*info->print_address_func) (value, info);
263 else if (CGEN_BOOL_ATTR (attrs, CGEN_OPERAND_ABS_ADDR))
264 (*info->print_address_func) (value, info);
265 else if (CGEN_BOOL_ATTR (attrs, CGEN_OPERAND_SIGNED))
266 (*info->fprintf_func) (info->stream, "%ld", (long) value);
268 (*info->fprintf_func) (info->stream, "0x%lx", (long) value);
271 /* Keyword print handler. */
274 print_keyword (CGEN_CPU_DESC cd ATTRIBUTE_UNUSED,
276 CGEN_KEYWORD *keyword_table,
278 unsigned int attrs ATTRIBUTE_UNUSED)
280 disassemble_info *info = (disassemble_info *) dis_info;
281 const CGEN_KEYWORD_ENTRY *ke;
283 ke = cgen_keyword_lookup_value (keyword_table, value);
285 (*info->fprintf_func) (info->stream, "%s", ke->name);
287 (*info->fprintf_func) (info->stream, "???");
290 /* Default insn printer.
292 DIS_INFO is defined as `void *' so the disassembler needn't know anything
293 about disassemble_info. */
296 print_insn_normal (CGEN_CPU_DESC cd,
298 const CGEN_INSN *insn,
303 const CGEN_SYNTAX *syntax = CGEN_INSN_SYNTAX (insn);
304 disassemble_info *info = (disassemble_info *) dis_info;
305 const CGEN_SYNTAX_CHAR_TYPE *syn;
307 CGEN_INIT_PRINT (cd);
309 for (syn = CGEN_SYNTAX_STRING (syntax); *syn; ++syn)
311 if (CGEN_SYNTAX_MNEMONIC_P (*syn))
313 (*info->fprintf_func) (info->stream, "%s", CGEN_INSN_MNEMONIC (insn));
316 if (CGEN_SYNTAX_CHAR_P (*syn))
318 (*info->fprintf_func) (info->stream, "%c", CGEN_SYNTAX_CHAR (*syn));
322 /* We have an operand. */
323 bpf_cgen_print_operand (cd, CGEN_SYNTAX_FIELD (*syn), info,
324 fields, CGEN_INSN_ATTRS (insn), pc, length);
328 /* Subroutine of print_insn. Reads an insn into the given buffers and updates
330 Returns 0 if all is well, non-zero otherwise. */
333 read_insn (CGEN_CPU_DESC cd ATTRIBUTE_UNUSED,
335 disassemble_info *info,
338 CGEN_EXTRACT_INFO *ex_info,
339 unsigned long *insn_value)
341 int status = (*info->read_memory_func) (pc, buf, buflen, info);
345 (*info->memory_error_func) (status, pc, info);
349 ex_info->dis_info = info;
350 ex_info->valid = (1 << buflen) - 1;
351 ex_info->insn_bytes = buf;
353 *insn_value = bfd_get_bits (buf, buflen * 8, info->endian == BFD_ENDIAN_BIG);
357 /* Utility to print an insn.
358 BUF is the base part of the insn, target byte order, BUFLEN bytes long.
359 The result is the size of the insn in bytes or zero for an unknown insn
360 or -1 if an error occurs fetching data (memory_error_func will have
364 print_insn (CGEN_CPU_DESC cd,
366 disassemble_info *info,
370 CGEN_INSN_INT insn_value;
371 const CGEN_INSN_LIST *insn_list;
372 CGEN_EXTRACT_INFO ex_info;
375 /* Extract base part of instruction, just in case CGEN_DIS_* uses it. */
376 basesize = cd->base_insn_bitsize < buflen * 8 ?
377 cd->base_insn_bitsize : buflen * 8;
378 insn_value = cgen_get_insn_value (cd, buf, basesize);
381 /* Fill in ex_info fields like read_insn would. Don't actually call
382 read_insn, since the incoming buffer is already read (and possibly
383 modified a la m32r). */
384 ex_info.valid = (1 << buflen) - 1;
385 ex_info.dis_info = info;
386 ex_info.insn_bytes = buf;
388 /* The instructions are stored in hash lists.
389 Pick the first one and keep trying until we find the right one. */
391 insn_list = CGEN_DIS_LOOKUP_INSN (cd, (char *) buf, insn_value);
392 while (insn_list != NULL)
394 const CGEN_INSN *insn = insn_list->insn;
397 unsigned long insn_value_cropped;
399 #ifdef CGEN_VALIDATE_INSN_SUPPORTED
400 /* Not needed as insn shouldn't be in hash lists if not supported. */
401 /* Supported by this cpu? */
402 if (! bpf_cgen_insn_supported (cd, insn))
404 insn_list = CGEN_DIS_NEXT_INSN (insn_list);
409 /* Basic bit mask must be correct. */
410 /* ??? May wish to allow target to defer this check until the extract
413 /* Base size may exceed this instruction's size. Extract the
414 relevant part from the buffer. */
415 if ((unsigned) (CGEN_INSN_BITSIZE (insn) / 8) < buflen &&
416 (unsigned) (CGEN_INSN_BITSIZE (insn) / 8) <= sizeof (unsigned long))
417 insn_value_cropped = bfd_get_bits (buf, CGEN_INSN_BITSIZE (insn),
418 info->endian == BFD_ENDIAN_BIG);
420 insn_value_cropped = insn_value;
422 if ((insn_value_cropped & CGEN_INSN_BASE_MASK (insn))
423 == CGEN_INSN_BASE_VALUE (insn))
425 /* Printing is handled in two passes. The first pass parses the
426 machine insn and extracts the fields. The second pass prints
429 /* Make sure the entire insn is loaded into insn_value, if it
431 if (((unsigned) CGEN_INSN_BITSIZE (insn) > cd->base_insn_bitsize) &&
432 (unsigned) (CGEN_INSN_BITSIZE (insn) / 8) <= sizeof (unsigned long))
434 unsigned long full_insn_value;
435 int rc = read_insn (cd, pc, info, buf,
436 CGEN_INSN_BITSIZE (insn) / 8,
437 & ex_info, & full_insn_value);
440 length = CGEN_EXTRACT_FN (cd, insn)
441 (cd, insn, &ex_info, full_insn_value, &fields, pc);
444 length = CGEN_EXTRACT_FN (cd, insn)
445 (cd, insn, &ex_info, insn_value_cropped, &fields, pc);
447 /* Length < 0 -> error. */
452 CGEN_PRINT_FN (cd, insn) (cd, info, insn, &fields, pc, length);
453 /* Length is in bits, result is in bytes. */
458 insn_list = CGEN_DIS_NEXT_INSN (insn_list);
464 /* Default value for CGEN_PRINT_INSN.
465 The result is the size of the insn in bytes or zero for an unknown insn
466 or -1 if an error occured fetching bytes. */
468 #ifndef CGEN_PRINT_INSN
469 #define CGEN_PRINT_INSN default_print_insn
473 default_print_insn (CGEN_CPU_DESC cd, bfd_vma pc, disassemble_info *info)
475 bfd_byte buf[CGEN_MAX_INSN_SIZE];
479 /* Attempt to read the base part of the insn. */
480 buflen = cd->base_insn_bitsize / 8;
481 status = (*info->read_memory_func) (pc, buf, buflen, info);
483 /* Try again with the minimum part, if min < base. */
484 if (status != 0 && (cd->min_insn_bitsize < cd->base_insn_bitsize))
486 buflen = cd->min_insn_bitsize / 8;
487 status = (*info->read_memory_func) (pc, buf, buflen, info);
492 (*info->memory_error_func) (status, pc, info);
496 return print_insn (cd, pc, info, buf, buflen);
500 Print one instruction from PC on INFO->STREAM.
501 Return the size of the instruction (in bytes). */
503 typedef struct cpu_desc_list
505 struct cpu_desc_list *next;
513 print_insn_bpf (bfd_vma pc, disassemble_info *info)
515 static cpu_desc_list *cd_list = 0;
516 cpu_desc_list *cl = 0;
517 static CGEN_CPU_DESC cd = 0;
518 static CGEN_BITSET *prev_isa;
519 static int prev_mach;
520 static int prev_endian;
524 int endian = (info->endian == BFD_ENDIAN_BIG
526 : CGEN_ENDIAN_LITTLE);
527 enum bfd_architecture arch;
529 /* ??? gdb will set mach but leave the architecture as "unknown" */
530 #ifndef CGEN_BFD_ARCH
531 #define CGEN_BFD_ARCH bfd_arch_bpf
534 if (arch == bfd_arch_unknown)
535 arch = CGEN_BFD_ARCH;
537 /* There's no standard way to compute the machine or isa number
538 so we leave it to the target. */
539 #ifdef CGEN_COMPUTE_MACH
540 mach = CGEN_COMPUTE_MACH (info);
545 #ifdef CGEN_COMPUTE_ISA
547 static CGEN_BITSET *permanent_isa;
550 permanent_isa = cgen_bitset_create (MAX_ISAS);
552 cgen_bitset_clear (isa);
553 cgen_bitset_add (isa, CGEN_COMPUTE_ISA (info));
556 isa = info->insn_sets;
559 /* If we've switched cpu's, try to find a handle we've used before */
561 && (cgen_bitset_compare (isa, prev_isa) != 0
563 || endian != prev_endian))
566 for (cl = cd_list; cl; cl = cl->next)
568 if (cgen_bitset_compare (cl->isa, isa) == 0 &&
570 cl->endian == endian)
579 /* If we haven't initialized yet, initialize the opcode table. */
582 const bfd_arch_info_type *arch_type = bfd_lookup_arch (arch, mach);
583 const char *mach_name;
587 mach_name = arch_type->printable_name;
589 prev_isa = cgen_bitset_copy (isa);
591 prev_endian = endian;
592 cd = bpf_cgen_cpu_open (CGEN_CPU_OPEN_ISAS, prev_isa,
593 CGEN_CPU_OPEN_BFDMACH, mach_name,
594 CGEN_CPU_OPEN_ENDIAN, prev_endian,
599 /* Save this away for future reference. */
600 cl = xmalloc (sizeof (struct cpu_desc_list));
608 bpf_cgen_init_dis (cd);
611 /* We try to have as much common code as possible.
612 But at this point some targets need to take over. */
613 /* ??? Some targets may need a hook elsewhere. Try to avoid this,
614 but if not possible try to move this hook elsewhere rather than
616 length = CGEN_PRINT_INSN (cd, pc, info);
622 (*info->fprintf_func) (info->stream, UNKNOWN_INSN_MSG);
623 return cd->default_insn_bitsize / 8;