1 /* Disassembler interface for targets using CGEN. -*- C -*-
2 CGEN: Cpu tools GENerator
4 THIS FILE IS MACHINE GENERATED WITH CGEN.
5 - the resultant file is machine generated, cgen-dis.in isn't
7 Copyright (C) 1996-2017 Free Software Foundation, Inc.
9 This file is part of libopcodes.
11 This library is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 3, or (at your option)
16 It is distributed in the hope that it will be useful, but WITHOUT
17 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
18 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
19 License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program; if not, write to the Free Software Foundation, Inc.,
23 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA. */
25 /* ??? Eventually more and more of this stuff can go to cpu-independent files.
34 #include "libiberty.h"
39 /* Default text to print if an instruction isn't recognized. */
40 #define UNKNOWN_INSN_MSG _("*unknown*")
42 static void print_normal
43 (CGEN_CPU_DESC, void *, long, unsigned int, bfd_vma, int);
44 static void print_address
45 (CGEN_CPU_DESC, void *, bfd_vma, unsigned int, bfd_vma, int) ATTRIBUTE_UNUSED;
46 static void print_keyword
47 (CGEN_CPU_DESC, void *, CGEN_KEYWORD *, long, unsigned int) ATTRIBUTE_UNUSED;
48 static void print_insn_normal
49 (CGEN_CPU_DESC, void *, const CGEN_INSN *, CGEN_FIELDS *, bfd_vma, int);
51 (CGEN_CPU_DESC, bfd_vma, disassemble_info *, bfd_byte *, unsigned);
52 static int default_print_insn
53 (CGEN_CPU_DESC, bfd_vma, disassemble_info *) ATTRIBUTE_UNUSED;
55 (CGEN_CPU_DESC, bfd_vma, disassemble_info *, bfd_byte *, int, CGEN_EXTRACT_INFO *,
58 /* -- disassembler routines inserted here. */
61 static void print_dollarhex (CGEN_CPU_DESC, PTR, long, unsigned, bfd_vma, int);
62 static void print_pcrel (CGEN_CPU_DESC, PTR, long, unsigned, bfd_vma, int);
65 print_dollarhex (CGEN_CPU_DESC cd ATTRIBUTE_UNUSED,
68 unsigned int attrs ATTRIBUTE_UNUSED,
69 bfd_vma pc ATTRIBUTE_UNUSED,
70 int length ATTRIBUTE_UNUSED)
72 disassemble_info *info = (disassemble_info *) dis_info;
74 info->fprintf_func (info->stream, "$%lx", value & 0xffffffff);
77 print_normal (cd, dis_info, value, attrs, pc, length);
81 print_pcrel (CGEN_CPU_DESC cd ATTRIBUTE_UNUSED,
84 unsigned int attrs ATTRIBUTE_UNUSED,
85 bfd_vma pc ATTRIBUTE_UNUSED,
86 int length ATTRIBUTE_UNUSED)
88 print_address (cd, dis_info, value + pc, attrs, pc, length);
93 void mt_cgen_print_operand
94 (CGEN_CPU_DESC, int, PTR, CGEN_FIELDS *, void const *, bfd_vma, int);
96 /* Main entry point for printing operands.
97 XINFO is a `void *' and not a `disassemble_info *' to not put a requirement
98 of dis-asm.h on cgen.h.
100 This function is basically just a big switch statement. Earlier versions
101 used tables to look up the function to use, but
102 - if the table contains both assembler and disassembler functions then
103 the disassembler contains much of the assembler and vice-versa,
104 - there's a lot of inlining possibilities as things grow,
105 - using a switch statement avoids the function call overhead.
107 This function could be moved into `print_insn_normal', but keeping it
108 separate makes clear the interface between `print_insn_normal' and each of
112 mt_cgen_print_operand (CGEN_CPU_DESC cd,
116 void const *attrs ATTRIBUTE_UNUSED,
120 disassemble_info *info = (disassemble_info *) xinfo;
124 case MT_OPERAND_A23 :
125 print_dollarhex (cd, info, fields->f_a23, 0, pc, length);
127 case MT_OPERAND_BALL :
128 print_dollarhex (cd, info, fields->f_ball, 0, pc, length);
130 case MT_OPERAND_BALL2 :
131 print_dollarhex (cd, info, fields->f_ball2, 0, pc, length);
133 case MT_OPERAND_BANKADDR :
134 print_dollarhex (cd, info, fields->f_bankaddr, 0, pc, length);
136 case MT_OPERAND_BRC :
137 print_dollarhex (cd, info, fields->f_brc, 0, pc, length);
139 case MT_OPERAND_BRC2 :
140 print_dollarhex (cd, info, fields->f_brc2, 0, pc, length);
142 case MT_OPERAND_CB1INCR :
143 print_dollarhex (cd, info, fields->f_cb1incr, 0|(1<<CGEN_OPERAND_SIGNED), pc, length);
145 case MT_OPERAND_CB1SEL :
146 print_dollarhex (cd, info, fields->f_cb1sel, 0, pc, length);
148 case MT_OPERAND_CB2INCR :
149 print_dollarhex (cd, info, fields->f_cb2incr, 0|(1<<CGEN_OPERAND_SIGNED), pc, length);
151 case MT_OPERAND_CB2SEL :
152 print_dollarhex (cd, info, fields->f_cb2sel, 0, pc, length);
154 case MT_OPERAND_CBRB :
155 print_dollarhex (cd, info, fields->f_cbrb, 0, pc, length);
157 case MT_OPERAND_CBS :
158 print_dollarhex (cd, info, fields->f_cbs, 0, pc, length);
160 case MT_OPERAND_CBX :
161 print_dollarhex (cd, info, fields->f_cbx, 0, pc, length);
163 case MT_OPERAND_CCB :
164 print_dollarhex (cd, info, fields->f_ccb, 0, pc, length);
166 case MT_OPERAND_CDB :
167 print_dollarhex (cd, info, fields->f_cdb, 0, pc, length);
169 case MT_OPERAND_CELL :
170 print_dollarhex (cd, info, fields->f_cell, 0, pc, length);
172 case MT_OPERAND_COLNUM :
173 print_dollarhex (cd, info, fields->f_colnum, 0, pc, length);
175 case MT_OPERAND_CONTNUM :
176 print_dollarhex (cd, info, fields->f_contnum, 0, pc, length);
179 print_dollarhex (cd, info, fields->f_cr, 0, pc, length);
181 case MT_OPERAND_CTXDISP :
182 print_dollarhex (cd, info, fields->f_ctxdisp, 0, pc, length);
184 case MT_OPERAND_DUP :
185 print_dollarhex (cd, info, fields->f_dup, 0, pc, length);
187 case MT_OPERAND_FBDISP :
188 print_dollarhex (cd, info, fields->f_fbdisp, 0, pc, length);
190 case MT_OPERAND_FBINCR :
191 print_dollarhex (cd, info, fields->f_fbincr, 0, pc, length);
193 case MT_OPERAND_FRDR :
194 print_keyword (cd, info, & mt_cgen_opval_h_spr, fields->f_dr, 0|(1<<CGEN_OPERAND_ABS_ADDR));
196 case MT_OPERAND_FRDRRR :
197 print_keyword (cd, info, & mt_cgen_opval_h_spr, fields->f_drrr, 0|(1<<CGEN_OPERAND_ABS_ADDR));
199 case MT_OPERAND_FRSR1 :
200 print_keyword (cd, info, & mt_cgen_opval_h_spr, fields->f_sr1, 0|(1<<CGEN_OPERAND_ABS_ADDR));
202 case MT_OPERAND_FRSR2 :
203 print_keyword (cd, info, & mt_cgen_opval_h_spr, fields->f_sr2, 0|(1<<CGEN_OPERAND_ABS_ADDR));
206 print_dollarhex (cd, info, fields->f_id, 0, pc, length);
208 case MT_OPERAND_IMM16 :
209 print_dollarhex (cd, info, fields->f_imm16s, 0|(1<<CGEN_OPERAND_SIGNED), pc, length);
211 case MT_OPERAND_IMM16L :
212 print_dollarhex (cd, info, fields->f_imm16l, 0, pc, length);
214 case MT_OPERAND_IMM16O :
215 print_pcrel (cd, info, fields->f_imm16s, 0|(1<<CGEN_OPERAND_PCREL_ADDR), pc, length);
217 case MT_OPERAND_IMM16Z :
218 print_dollarhex (cd, info, fields->f_imm16u, 0, pc, length);
220 case MT_OPERAND_INCAMT :
221 print_dollarhex (cd, info, fields->f_incamt, 0, pc, length);
223 case MT_OPERAND_INCR :
224 print_dollarhex (cd, info, fields->f_incr, 0, pc, length);
226 case MT_OPERAND_LENGTH :
227 print_dollarhex (cd, info, fields->f_length, 0, pc, length);
229 case MT_OPERAND_LOOPSIZE :
230 print_pcrel (cd, info, fields->f_loopo, 0|(1<<CGEN_OPERAND_PCREL_ADDR), pc, length);
232 case MT_OPERAND_MASK :
233 print_dollarhex (cd, info, fields->f_mask, 0, pc, length);
235 case MT_OPERAND_MASK1 :
236 print_dollarhex (cd, info, fields->f_mask1, 0, pc, length);
238 case MT_OPERAND_MODE :
239 print_dollarhex (cd, info, fields->f_mode, 0, pc, length);
241 case MT_OPERAND_PERM :
242 print_dollarhex (cd, info, fields->f_perm, 0, pc, length);
244 case MT_OPERAND_RBBC :
245 print_dollarhex (cd, info, fields->f_rbbc, 0, pc, length);
248 print_dollarhex (cd, info, fields->f_rc, 0, pc, length);
250 case MT_OPERAND_RC1 :
251 print_dollarhex (cd, info, fields->f_rc1, 0, pc, length);
253 case MT_OPERAND_RC2 :
254 print_dollarhex (cd, info, fields->f_rc2, 0, pc, length);
256 case MT_OPERAND_RC3 :
257 print_dollarhex (cd, info, fields->f_rc3, 0, pc, length);
259 case MT_OPERAND_RCNUM :
260 print_dollarhex (cd, info, fields->f_rcnum, 0, pc, length);
262 case MT_OPERAND_RDA :
263 print_dollarhex (cd, info, fields->f_rda, 0, pc, length);
265 case MT_OPERAND_ROWNUM :
266 print_dollarhex (cd, info, fields->f_rownum, 0, pc, length);
268 case MT_OPERAND_ROWNUM1 :
269 print_dollarhex (cd, info, fields->f_rownum1, 0, pc, length);
271 case MT_OPERAND_ROWNUM2 :
272 print_dollarhex (cd, info, fields->f_rownum2, 0, pc, length);
274 case MT_OPERAND_SIZE :
275 print_dollarhex (cd, info, fields->f_size, 0, pc, length);
277 case MT_OPERAND_TYPE :
278 print_dollarhex (cd, info, fields->f_type, 0, pc, length);
281 print_dollarhex (cd, info, fields->f_wr, 0, pc, length);
283 case MT_OPERAND_XMODE :
284 print_dollarhex (cd, info, fields->f_xmode, 0, pc, length);
288 /* xgettext:c-format */
289 fprintf (stderr, _("Unrecognized field %d while printing insn.\n"),
295 cgen_print_fn * const mt_cgen_print_handlers[] =
302 mt_cgen_init_dis (CGEN_CPU_DESC cd)
304 mt_cgen_init_opcode_table (cd);
305 mt_cgen_init_ibld_table (cd);
306 cd->print_handlers = & mt_cgen_print_handlers[0];
307 cd->print_operand = mt_cgen_print_operand;
311 /* Default print handler. */
314 print_normal (CGEN_CPU_DESC cd ATTRIBUTE_UNUSED,
318 bfd_vma pc ATTRIBUTE_UNUSED,
319 int length ATTRIBUTE_UNUSED)
321 disassemble_info *info = (disassemble_info *) dis_info;
323 /* Print the operand as directed by the attributes. */
324 if (CGEN_BOOL_ATTR (attrs, CGEN_OPERAND_SEM_ONLY))
325 ; /* nothing to do */
326 else if (CGEN_BOOL_ATTR (attrs, CGEN_OPERAND_SIGNED))
327 (*info->fprintf_func) (info->stream, "%ld", value);
329 (*info->fprintf_func) (info->stream, "0x%lx", value);
332 /* Default address handler. */
335 print_address (CGEN_CPU_DESC cd ATTRIBUTE_UNUSED,
339 bfd_vma pc ATTRIBUTE_UNUSED,
340 int length ATTRIBUTE_UNUSED)
342 disassemble_info *info = (disassemble_info *) dis_info;
344 /* Print the operand as directed by the attributes. */
345 if (CGEN_BOOL_ATTR (attrs, CGEN_OPERAND_SEM_ONLY))
346 ; /* Nothing to do. */
347 else if (CGEN_BOOL_ATTR (attrs, CGEN_OPERAND_PCREL_ADDR))
348 (*info->print_address_func) (value, info);
349 else if (CGEN_BOOL_ATTR (attrs, CGEN_OPERAND_ABS_ADDR))
350 (*info->print_address_func) (value, info);
351 else if (CGEN_BOOL_ATTR (attrs, CGEN_OPERAND_SIGNED))
352 (*info->fprintf_func) (info->stream, "%ld", (long) value);
354 (*info->fprintf_func) (info->stream, "0x%lx", (long) value);
357 /* Keyword print handler. */
360 print_keyword (CGEN_CPU_DESC cd ATTRIBUTE_UNUSED,
362 CGEN_KEYWORD *keyword_table,
364 unsigned int attrs ATTRIBUTE_UNUSED)
366 disassemble_info *info = (disassemble_info *) dis_info;
367 const CGEN_KEYWORD_ENTRY *ke;
369 ke = cgen_keyword_lookup_value (keyword_table, value);
371 (*info->fprintf_func) (info->stream, "%s", ke->name);
373 (*info->fprintf_func) (info->stream, "???");
376 /* Default insn printer.
378 DIS_INFO is defined as `void *' so the disassembler needn't know anything
379 about disassemble_info. */
382 print_insn_normal (CGEN_CPU_DESC cd,
384 const CGEN_INSN *insn,
389 const CGEN_SYNTAX *syntax = CGEN_INSN_SYNTAX (insn);
390 disassemble_info *info = (disassemble_info *) dis_info;
391 const CGEN_SYNTAX_CHAR_TYPE *syn;
393 CGEN_INIT_PRINT (cd);
395 for (syn = CGEN_SYNTAX_STRING (syntax); *syn; ++syn)
397 if (CGEN_SYNTAX_MNEMONIC_P (*syn))
399 (*info->fprintf_func) (info->stream, "%s", CGEN_INSN_MNEMONIC (insn));
402 if (CGEN_SYNTAX_CHAR_P (*syn))
404 (*info->fprintf_func) (info->stream, "%c", CGEN_SYNTAX_CHAR (*syn));
408 /* We have an operand. */
409 mt_cgen_print_operand (cd, CGEN_SYNTAX_FIELD (*syn), info,
410 fields, CGEN_INSN_ATTRS (insn), pc, length);
414 /* Subroutine of print_insn. Reads an insn into the given buffers and updates
416 Returns 0 if all is well, non-zero otherwise. */
419 read_insn (CGEN_CPU_DESC cd ATTRIBUTE_UNUSED,
421 disassemble_info *info,
424 CGEN_EXTRACT_INFO *ex_info,
425 unsigned long *insn_value)
427 int status = (*info->read_memory_func) (pc, buf, buflen, info);
431 (*info->memory_error_func) (status, pc, info);
435 ex_info->dis_info = info;
436 ex_info->valid = (1 << buflen) - 1;
437 ex_info->insn_bytes = buf;
439 *insn_value = bfd_get_bits (buf, buflen * 8, info->endian == BFD_ENDIAN_BIG);
443 /* Utility to print an insn.
444 BUF is the base part of the insn, target byte order, BUFLEN bytes long.
445 The result is the size of the insn in bytes or zero for an unknown insn
446 or -1 if an error occurs fetching data (memory_error_func will have
450 print_insn (CGEN_CPU_DESC cd,
452 disassemble_info *info,
456 CGEN_INSN_INT insn_value;
457 const CGEN_INSN_LIST *insn_list;
458 CGEN_EXTRACT_INFO ex_info;
461 /* Extract base part of instruction, just in case CGEN_DIS_* uses it. */
462 basesize = cd->base_insn_bitsize < buflen * 8 ?
463 cd->base_insn_bitsize : buflen * 8;
464 insn_value = cgen_get_insn_value (cd, buf, basesize);
467 /* Fill in ex_info fields like read_insn would. Don't actually call
468 read_insn, since the incoming buffer is already read (and possibly
469 modified a la m32r). */
470 ex_info.valid = (1 << buflen) - 1;
471 ex_info.dis_info = info;
472 ex_info.insn_bytes = buf;
474 /* The instructions are stored in hash lists.
475 Pick the first one and keep trying until we find the right one. */
477 insn_list = CGEN_DIS_LOOKUP_INSN (cd, (char *) buf, insn_value);
478 while (insn_list != NULL)
480 const CGEN_INSN *insn = insn_list->insn;
483 unsigned long insn_value_cropped;
485 #ifdef CGEN_VALIDATE_INSN_SUPPORTED
486 /* Not needed as insn shouldn't be in hash lists if not supported. */
487 /* Supported by this cpu? */
488 if (! mt_cgen_insn_supported (cd, insn))
490 insn_list = CGEN_DIS_NEXT_INSN (insn_list);
495 /* Basic bit mask must be correct. */
496 /* ??? May wish to allow target to defer this check until the extract
499 /* Base size may exceed this instruction's size. Extract the
500 relevant part from the buffer. */
501 if ((unsigned) (CGEN_INSN_BITSIZE (insn) / 8) < buflen &&
502 (unsigned) (CGEN_INSN_BITSIZE (insn) / 8) <= sizeof (unsigned long))
503 insn_value_cropped = bfd_get_bits (buf, CGEN_INSN_BITSIZE (insn),
504 info->endian == BFD_ENDIAN_BIG);
506 insn_value_cropped = insn_value;
508 if ((insn_value_cropped & CGEN_INSN_BASE_MASK (insn))
509 == CGEN_INSN_BASE_VALUE (insn))
511 /* Printing is handled in two passes. The first pass parses the
512 machine insn and extracts the fields. The second pass prints
515 /* Make sure the entire insn is loaded into insn_value, if it
517 if (((unsigned) CGEN_INSN_BITSIZE (insn) > cd->base_insn_bitsize) &&
518 (unsigned) (CGEN_INSN_BITSIZE (insn) / 8) <= sizeof (unsigned long))
520 unsigned long full_insn_value;
521 int rc = read_insn (cd, pc, info, buf,
522 CGEN_INSN_BITSIZE (insn) / 8,
523 & ex_info, & full_insn_value);
526 length = CGEN_EXTRACT_FN (cd, insn)
527 (cd, insn, &ex_info, full_insn_value, &fields, pc);
530 length = CGEN_EXTRACT_FN (cd, insn)
531 (cd, insn, &ex_info, insn_value_cropped, &fields, pc);
533 /* Length < 0 -> error. */
538 CGEN_PRINT_FN (cd, insn) (cd, info, insn, &fields, pc, length);
539 /* Length is in bits, result is in bytes. */
544 insn_list = CGEN_DIS_NEXT_INSN (insn_list);
550 /* Default value for CGEN_PRINT_INSN.
551 The result is the size of the insn in bytes or zero for an unknown insn
552 or -1 if an error occured fetching bytes. */
554 #ifndef CGEN_PRINT_INSN
555 #define CGEN_PRINT_INSN default_print_insn
559 default_print_insn (CGEN_CPU_DESC cd, bfd_vma pc, disassemble_info *info)
561 bfd_byte buf[CGEN_MAX_INSN_SIZE];
565 /* Attempt to read the base part of the insn. */
566 buflen = cd->base_insn_bitsize / 8;
567 status = (*info->read_memory_func) (pc, buf, buflen, info);
569 /* Try again with the minimum part, if min < base. */
570 if (status != 0 && (cd->min_insn_bitsize < cd->base_insn_bitsize))
572 buflen = cd->min_insn_bitsize / 8;
573 status = (*info->read_memory_func) (pc, buf, buflen, info);
578 (*info->memory_error_func) (status, pc, info);
582 return print_insn (cd, pc, info, buf, buflen);
586 Print one instruction from PC on INFO->STREAM.
587 Return the size of the instruction (in bytes). */
589 typedef struct cpu_desc_list
591 struct cpu_desc_list *next;
599 print_insn_mt (bfd_vma pc, disassemble_info *info)
601 static cpu_desc_list *cd_list = 0;
602 cpu_desc_list *cl = 0;
603 static CGEN_CPU_DESC cd = 0;
604 static CGEN_BITSET *prev_isa;
605 static int prev_mach;
606 static int prev_endian;
610 int endian = (info->endian == BFD_ENDIAN_BIG
612 : CGEN_ENDIAN_LITTLE);
613 enum bfd_architecture arch;
615 /* ??? gdb will set mach but leave the architecture as "unknown" */
616 #ifndef CGEN_BFD_ARCH
617 #define CGEN_BFD_ARCH bfd_arch_mt
620 if (arch == bfd_arch_unknown)
621 arch = CGEN_BFD_ARCH;
623 /* There's no standard way to compute the machine or isa number
624 so we leave it to the target. */
625 #ifdef CGEN_COMPUTE_MACH
626 mach = CGEN_COMPUTE_MACH (info);
631 #ifdef CGEN_COMPUTE_ISA
633 static CGEN_BITSET *permanent_isa;
636 permanent_isa = cgen_bitset_create (MAX_ISAS);
638 cgen_bitset_clear (isa);
639 cgen_bitset_add (isa, CGEN_COMPUTE_ISA (info));
642 isa = info->insn_sets;
645 /* If we've switched cpu's, try to find a handle we've used before */
647 && (cgen_bitset_compare (isa, prev_isa) != 0
649 || endian != prev_endian))
652 for (cl = cd_list; cl; cl = cl->next)
654 if (cgen_bitset_compare (cl->isa, isa) == 0 &&
656 cl->endian == endian)
665 /* If we haven't initialized yet, initialize the opcode table. */
668 const bfd_arch_info_type *arch_type = bfd_lookup_arch (arch, mach);
669 const char *mach_name;
673 mach_name = arch_type->printable_name;
675 prev_isa = cgen_bitset_copy (isa);
677 prev_endian = endian;
678 cd = mt_cgen_cpu_open (CGEN_CPU_OPEN_ISAS, prev_isa,
679 CGEN_CPU_OPEN_BFDMACH, mach_name,
680 CGEN_CPU_OPEN_ENDIAN, prev_endian,
685 /* Save this away for future reference. */
686 cl = xmalloc (sizeof (struct cpu_desc_list));
694 mt_cgen_init_dis (cd);
697 /* We try to have as much common code as possible.
698 But at this point some targets need to take over. */
699 /* ??? Some targets may need a hook elsewhere. Try to avoid this,
700 but if not possible try to move this hook elsewhere rather than
702 length = CGEN_PRINT_INSN (cd, pc, info);
708 (*info->fprintf_func) (info->stream, UNKNOWN_INSN_MSG);
709 return cd->default_insn_bitsize / 8;