Add GNU Free Documentation License
[binutils.git] / opcodes / m32r-dis.c
blob9b0397f3b7cb5f2147cb0c57b6ca40ced20217b5
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, 1997, 1998, 1999 Free Software Foundation, Inc.
9 This file is part of the GNU Binutils and GDB, the GNU debugger.
11 This program 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 2, or (at your option)
14 any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public 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 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
25 /* ??? Eventually more and more of this stuff can go to cpu-independent files.
26 Keep that in mind. */
28 #include "sysdep.h"
29 #include <stdio.h>
30 #include "ansidecl.h"
31 #include "dis-asm.h"
32 #include "bfd.h"
33 #include "symcat.h"
34 #include "m32r-desc.h"
35 #include "m32r-opc.h"
36 #include "opintl.h"
38 /* Default text to print if an instruction isn't recognized. */
39 #define UNKNOWN_INSN_MSG _("*unknown*")
41 static void print_normal
42 PARAMS ((CGEN_CPU_DESC, PTR, long, unsigned int, bfd_vma, int));
43 static void print_address
44 PARAMS ((CGEN_CPU_DESC, PTR, bfd_vma, unsigned int, bfd_vma, int));
45 static void print_keyword
46 PARAMS ((CGEN_CPU_DESC, PTR, CGEN_KEYWORD *, long, unsigned int));
47 static void print_insn_normal
48 PARAMS ((CGEN_CPU_DESC, PTR, const CGEN_INSN *, CGEN_FIELDS *,
49 bfd_vma, int));
50 static int print_insn PARAMS ((CGEN_CPU_DESC, bfd_vma,
51 disassemble_info *, char *, int));
52 static int default_print_insn
53 PARAMS ((CGEN_CPU_DESC, bfd_vma, disassemble_info *));
55 /* -- disassembler routines inserted here */
57 /* -- dis.c */
59 /* Immediate values are prefixed with '#'. */
61 #define CGEN_PRINT_NORMAL(cd, info, value, attrs, pc, length) \
62 do { \
63 if (CGEN_BOOL_ATTR ((attrs), CGEN_OPERAND_HASH_PREFIX)) \
64 (*info->fprintf_func) (info->stream, "#"); \
65 } while (0)
67 /* Handle '#' prefixes as operands. */
69 static void
70 print_hash (cd, dis_info, value, attrs, pc, length)
71 CGEN_CPU_DESC cd;
72 PTR dis_info;
73 long value;
74 unsigned int attrs;
75 bfd_vma pc;
76 int length;
78 disassemble_info *info = (disassemble_info *) dis_info;
79 (*info->fprintf_func) (info->stream, "#");
82 #undef CGEN_PRINT_INSN
83 #define CGEN_PRINT_INSN my_print_insn
85 static int
86 my_print_insn (cd, pc, info)
87 CGEN_CPU_DESC cd;
88 bfd_vma pc;
89 disassemble_info *info;
91 char buffer[CGEN_MAX_INSN_SIZE];
92 char *buf = buffer;
93 int status;
94 int buflen = (pc & 3) == 0 ? 4 : 2;
96 /* Read the base part of the insn. */
98 status = (*info->read_memory_func) (pc, buf, buflen, info);
99 if (status != 0)
101 (*info->memory_error_func) (status, pc, info);
102 return -1;
105 /* 32 bit insn? */
106 if ((pc & 3) == 0 && (buf[0] & 0x80) != 0)
107 return print_insn (cd, pc, info, buf, buflen);
109 /* Print the first insn. */
110 if ((pc & 3) == 0)
112 if (print_insn (cd, pc, info, buf, 2) == 0)
113 (*info->fprintf_func) (info->stream, UNKNOWN_INSN_MSG);
114 buf += 2;
117 if (buf[0] & 0x80)
119 /* Parallel. */
120 (*info->fprintf_func) (info->stream, " || ");
121 buf[0] &= 0x7f;
123 else
124 (*info->fprintf_func) (info->stream, " -> ");
126 /* The "& 3" is to pass a consistent address.
127 Parallel insns arguably both begin on the word boundary.
128 Also, branch insns are calculated relative to the word boundary. */
129 if (print_insn (cd, pc & ~ (bfd_vma) 3, info, buf, 2) == 0)
130 (*info->fprintf_func) (info->stream, UNKNOWN_INSN_MSG);
132 return (pc & 3) ? 2 : 4;
135 /* -- */
137 /* Main entry point for printing operands.
138 XINFO is a `void *' and not a `disassemble_info *' to not put a requirement
139 of dis-asm.h on cgen.h.
141 This function is basically just a big switch statement. Earlier versions
142 used tables to look up the function to use, but
143 - if the table contains both assembler and disassembler functions then
144 the disassembler contains much of the assembler and vice-versa,
145 - there's a lot of inlining possibilities as things grow,
146 - using a switch statement avoids the function call overhead.
148 This function could be moved into `print_insn_normal', but keeping it
149 separate makes clear the interface between `print_insn_normal' and each of
150 the handlers.
153 void
154 m32r_cgen_print_operand (cd, opindex, xinfo, fields, attrs, pc, length)
155 CGEN_CPU_DESC cd;
156 int opindex;
157 PTR xinfo;
158 CGEN_FIELDS *fields;
159 void const *attrs;
160 bfd_vma pc;
161 int length;
163 disassemble_info *info = (disassemble_info *) xinfo;
165 switch (opindex)
167 case M32R_OPERAND_ACC :
168 print_keyword (cd, info, & m32r_cgen_opval_h_accums, fields->f_acc, 0);
169 break;
170 case M32R_OPERAND_ACCD :
171 print_keyword (cd, info, & m32r_cgen_opval_h_accums, fields->f_accd, 0);
172 break;
173 case M32R_OPERAND_ACCS :
174 print_keyword (cd, info, & m32r_cgen_opval_h_accums, fields->f_accs, 0);
175 break;
176 case M32R_OPERAND_DCR :
177 print_keyword (cd, info, & m32r_cgen_opval_cr_names, fields->f_r1, 0);
178 break;
179 case M32R_OPERAND_DISP16 :
180 print_address (cd, info, fields->f_disp16, 0|(1<<CGEN_OPERAND_RELOC)|(1<<CGEN_OPERAND_PCREL_ADDR), pc, length);
181 break;
182 case M32R_OPERAND_DISP24 :
183 print_address (cd, info, fields->f_disp24, 0|(1<<CGEN_OPERAND_RELAX)|(1<<CGEN_OPERAND_RELOC)|(1<<CGEN_OPERAND_PCREL_ADDR), pc, length);
184 break;
185 case M32R_OPERAND_DISP8 :
186 print_address (cd, info, fields->f_disp8, 0|(1<<CGEN_OPERAND_RELAX)|(1<<CGEN_OPERAND_RELOC)|(1<<CGEN_OPERAND_PCREL_ADDR), pc, length);
187 break;
188 case M32R_OPERAND_DR :
189 print_keyword (cd, info, & m32r_cgen_opval_gr_names, fields->f_r1, 0);
190 break;
191 case M32R_OPERAND_HASH :
192 print_hash (cd, info, 0, 0|(1<<CGEN_OPERAND_SIGNED), pc, length);
193 break;
194 case M32R_OPERAND_HI16 :
195 print_normal (cd, info, fields->f_hi16, 0|(1<<CGEN_OPERAND_SIGN_OPT), pc, length);
196 break;
197 case M32R_OPERAND_IMM1 :
198 print_normal (cd, info, fields->f_imm1, 0|(1<<CGEN_OPERAND_HASH_PREFIX), pc, length);
199 break;
200 case M32R_OPERAND_SCR :
201 print_keyword (cd, info, & m32r_cgen_opval_cr_names, fields->f_r2, 0);
202 break;
203 case M32R_OPERAND_SIMM16 :
204 print_normal (cd, info, fields->f_simm16, 0|(1<<CGEN_OPERAND_SIGNED)|(1<<CGEN_OPERAND_HASH_PREFIX), pc, length);
205 break;
206 case M32R_OPERAND_SIMM8 :
207 print_normal (cd, info, fields->f_simm8, 0|(1<<CGEN_OPERAND_SIGNED)|(1<<CGEN_OPERAND_HASH_PREFIX), pc, length);
208 break;
209 case M32R_OPERAND_SLO16 :
210 print_normal (cd, info, fields->f_simm16, 0|(1<<CGEN_OPERAND_SIGNED), pc, length);
211 break;
212 case M32R_OPERAND_SR :
213 print_keyword (cd, info, & m32r_cgen_opval_gr_names, fields->f_r2, 0);
214 break;
215 case M32R_OPERAND_SRC1 :
216 print_keyword (cd, info, & m32r_cgen_opval_gr_names, fields->f_r1, 0);
217 break;
218 case M32R_OPERAND_SRC2 :
219 print_keyword (cd, info, & m32r_cgen_opval_gr_names, fields->f_r2, 0);
220 break;
221 case M32R_OPERAND_UIMM16 :
222 print_normal (cd, info, fields->f_uimm16, 0|(1<<CGEN_OPERAND_HASH_PREFIX), pc, length);
223 break;
224 case M32R_OPERAND_UIMM24 :
225 print_address (cd, info, fields->f_uimm24, 0|(1<<CGEN_OPERAND_HASH_PREFIX)|(1<<CGEN_OPERAND_RELOC)|(1<<CGEN_OPERAND_ABS_ADDR), pc, length);
226 break;
227 case M32R_OPERAND_UIMM4 :
228 print_normal (cd, info, fields->f_uimm4, 0|(1<<CGEN_OPERAND_HASH_PREFIX), pc, length);
229 break;
230 case M32R_OPERAND_UIMM5 :
231 print_normal (cd, info, fields->f_uimm5, 0|(1<<CGEN_OPERAND_HASH_PREFIX), pc, length);
232 break;
233 case M32R_OPERAND_ULO16 :
234 print_normal (cd, info, fields->f_uimm16, 0, pc, length);
235 break;
237 default :
238 /* xgettext:c-format */
239 fprintf (stderr, _("Unrecognized field %d while printing insn.\n"),
240 opindex);
241 abort ();
245 cgen_print_fn * const m32r_cgen_print_handlers[] =
247 print_insn_normal,
251 void
252 m32r_cgen_init_dis (cd)
253 CGEN_CPU_DESC cd;
255 m32r_cgen_init_opcode_table (cd);
256 m32r_cgen_init_ibld_table (cd);
257 cd->print_handlers = & m32r_cgen_print_handlers[0];
258 cd->print_operand = m32r_cgen_print_operand;
262 /* Default print handler. */
264 static void
265 print_normal (cd, dis_info, value, attrs, pc, length)
266 #ifdef CGEN_PRINT_NORMAL
267 CGEN_CPU_DESC cd;
268 #else
269 CGEN_CPU_DESC cd ATTRIBUTE_UNUSED;
270 #endif
271 PTR dis_info;
272 long value;
273 unsigned int attrs;
274 #ifdef CGEN_PRINT_NORMAL
275 bfd_vma pc;
276 int length;
277 #else
278 bfd_vma pc ATTRIBUTE_UNUSED;
279 int length ATTRIBUTE_UNUSED;
280 #endif
282 disassemble_info *info = (disassemble_info *) dis_info;
284 #ifdef CGEN_PRINT_NORMAL
285 CGEN_PRINT_NORMAL (cd, info, value, attrs, pc, length);
286 #endif
288 /* Print the operand as directed by the attributes. */
289 if (CGEN_BOOL_ATTR (attrs, CGEN_OPERAND_SEM_ONLY))
290 ; /* nothing to do */
291 else if (CGEN_BOOL_ATTR (attrs, CGEN_OPERAND_SIGNED))
292 (*info->fprintf_func) (info->stream, "%ld", value);
293 else
294 (*info->fprintf_func) (info->stream, "0x%lx", value);
297 /* Default address handler. */
299 static void
300 print_address (cd, dis_info, value, attrs, pc, length)
301 #ifdef CGEN_PRINT_NORMAL
302 CGEN_CPU_DESC cd;
303 #else
304 CGEN_CPU_DESC cd ATTRIBUTE_UNUSED;
305 #endif
306 PTR dis_info;
307 bfd_vma value;
308 unsigned int attrs;
309 #ifdef CGEN_PRINT_NORMAL
310 bfd_vma pc;
311 int length;
312 #else
313 bfd_vma pc ATTRIBUTE_UNUSED;
314 int length ATTRIBUTE_UNUSED;
315 #endif
317 disassemble_info *info = (disassemble_info *) dis_info;
319 #ifdef CGEN_PRINT_ADDRESS
320 CGEN_PRINT_ADDRESS (cd, info, value, attrs, pc, length);
321 #endif
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_PCREL_ADDR))
327 (*info->print_address_func) (value, info);
328 else if (CGEN_BOOL_ATTR (attrs, CGEN_OPERAND_ABS_ADDR))
329 (*info->print_address_func) (value, info);
330 else if (CGEN_BOOL_ATTR (attrs, CGEN_OPERAND_SIGNED))
331 (*info->fprintf_func) (info->stream, "%ld", (long) value);
332 else
333 (*info->fprintf_func) (info->stream, "0x%lx", (long) value);
336 /* Keyword print handler. */
338 static void
339 print_keyword (cd, dis_info, keyword_table, value, attrs)
340 CGEN_CPU_DESC cd ATTRIBUTE_UNUSED;
341 PTR dis_info;
342 CGEN_KEYWORD *keyword_table;
343 long value;
344 unsigned int attrs ATTRIBUTE_UNUSED;
346 disassemble_info *info = (disassemble_info *) dis_info;
347 const CGEN_KEYWORD_ENTRY *ke;
349 ke = cgen_keyword_lookup_value (keyword_table, value);
350 if (ke != NULL)
351 (*info->fprintf_func) (info->stream, "%s", ke->name);
352 else
353 (*info->fprintf_func) (info->stream, "???");
356 /* Default insn printer.
358 DIS_INFO is defined as `PTR' so the disassembler needn't know anything
359 about disassemble_info. */
361 static void
362 print_insn_normal (cd, dis_info, insn, fields, pc, length)
363 CGEN_CPU_DESC cd;
364 PTR dis_info;
365 const CGEN_INSN *insn;
366 CGEN_FIELDS *fields;
367 bfd_vma pc;
368 int length;
370 const CGEN_SYNTAX *syntax = CGEN_INSN_SYNTAX (insn);
371 disassemble_info *info = (disassemble_info *) dis_info;
372 const unsigned char *syn;
374 CGEN_INIT_PRINT (cd);
376 for (syn = CGEN_SYNTAX_STRING (syntax); *syn; ++syn)
378 if (CGEN_SYNTAX_MNEMONIC_P (*syn))
380 (*info->fprintf_func) (info->stream, "%s", CGEN_INSN_MNEMONIC (insn));
381 continue;
383 if (CGEN_SYNTAX_CHAR_P (*syn))
385 (*info->fprintf_func) (info->stream, "%c", CGEN_SYNTAX_CHAR (*syn));
386 continue;
389 /* We have an operand. */
390 m32r_cgen_print_operand (cd, CGEN_SYNTAX_FIELD (*syn), info,
391 fields, CGEN_INSN_ATTRS (insn), pc, length);
395 /* Subroutine of print_insn. Reads an insn into the given buffers and updates
396 the extract info.
397 Returns 0 if all is well, non-zero otherwise. */
398 static int
399 read_insn (cd, pc, info, buf, buflen, ex_info, insn_value)
400 CGEN_CPU_DESC cd;
401 bfd_vma pc;
402 disassemble_info *info;
403 char *buf;
404 int buflen;
405 CGEN_EXTRACT_INFO *ex_info;
406 unsigned long *insn_value;
408 int status = (*info->read_memory_func) (pc, buf, buflen, info);
409 if (status != 0)
411 (*info->memory_error_func) (status, pc, info);
412 return -1;
415 ex_info->dis_info = info;
416 ex_info->valid = (1 << buflen) - 1;
417 ex_info->insn_bytes = buf;
419 switch (buflen)
421 case 1:
422 *insn_value = buf[0];
423 break;
424 case 2:
425 *insn_value = info->endian == BFD_ENDIAN_BIG ? bfd_getb16 (buf) : bfd_getl16 (buf);
426 break;
427 case 4:
428 *insn_value = info->endian == BFD_ENDIAN_BIG ? bfd_getb32 (buf) : bfd_getl32 (buf);
429 break;
430 default:
431 abort ();
434 return 0;
437 /* Utility to print an insn.
438 BUF is the base part of the insn, target byte order, BUFLEN bytes long.
439 The result is the size of the insn in bytes or zero for an unknown insn
440 or -1 if an error occurs fetching data (memory_error_func will have
441 been called). */
443 static int
444 print_insn (cd, pc, info, buf, buflen)
445 CGEN_CPU_DESC cd;
446 bfd_vma pc;
447 disassemble_info *info;
448 char *buf;
449 int buflen;
451 unsigned long insn_value;
452 const CGEN_INSN_LIST *insn_list;
453 CGEN_EXTRACT_INFO ex_info;
455 int rc = read_insn (cd, pc, info, buf, buflen, & ex_info, & insn_value);
456 if (rc != 0)
457 return rc;
459 /* The instructions are stored in hash lists.
460 Pick the first one and keep trying until we find the right one. */
462 insn_list = CGEN_DIS_LOOKUP_INSN (cd, buf, insn_value);
463 while (insn_list != NULL)
465 const CGEN_INSN *insn = insn_list->insn;
466 CGEN_FIELDS fields;
467 int length;
469 #ifdef CGEN_VALIDATE_INSN_SUPPORTED
470 /* not needed as insn shouldn't be in hash lists if not supported */
471 /* Supported by this cpu? */
472 if (! m32r_cgen_insn_supported (cd, insn))
474 insn_list = CGEN_DIS_NEXT_INSN (insn_list);
475 continue;
477 #endif
479 /* Basic bit mask must be correct. */
480 /* ??? May wish to allow target to defer this check until the extract
481 handler. */
482 if ((insn_value & CGEN_INSN_BASE_MASK (insn))
483 == CGEN_INSN_BASE_VALUE (insn))
485 /* Printing is handled in two passes. The first pass parses the
486 machine insn and extracts the fields. The second pass prints
487 them. */
489 #if CGEN_INT_INSN_P
490 /* Make sure the entire insn is loaded into insn_value. */
491 if (CGEN_INSN_BITSIZE (insn) > cd->base_insn_bitsize)
493 unsigned long full_insn_value;
494 int rc = read_insn (cd, pc, info, buf,
495 CGEN_INSN_BITSIZE (insn) / 8,
496 & ex_info, & full_insn_value);
497 if (rc != 0)
498 return rc;
499 length = CGEN_EXTRACT_FN (cd, insn)
500 (cd, insn, &ex_info, full_insn_value, &fields, pc);
502 else
503 #endif
505 length = CGEN_EXTRACT_FN (cd, insn)
506 (cd, insn, &ex_info, insn_value, &fields, pc);
507 /* length < 0 -> error */
508 if (length < 0)
509 return length;
510 if (length > 0)
512 CGEN_PRINT_FN (cd, insn) (cd, info, insn, &fields, pc, length);
513 /* length is in bits, result is in bytes */
514 return length / 8;
518 insn_list = CGEN_DIS_NEXT_INSN (insn_list);
521 return 0;
524 /* Default value for CGEN_PRINT_INSN.
525 The result is the size of the insn in bytes or zero for an unknown insn
526 or -1 if an error occured fetching bytes. */
528 #ifndef CGEN_PRINT_INSN
529 #define CGEN_PRINT_INSN default_print_insn
530 #endif
532 static int
533 default_print_insn (cd, pc, info)
534 CGEN_CPU_DESC cd;
535 bfd_vma pc;
536 disassemble_info *info;
538 char buf[CGEN_MAX_INSN_SIZE];
539 int status;
541 /* Read the base part of the insn. */
543 status = (*info->read_memory_func) (pc, buf, cd->base_insn_bitsize / 8, info);
544 if (status != 0)
546 (*info->memory_error_func) (status, pc, info);
547 return -1;
550 return print_insn (cd, pc, info, buf, cd->base_insn_bitsize / 8);
553 /* Main entry point.
554 Print one instruction from PC on INFO->STREAM.
555 Return the size of the instruction (in bytes). */
558 print_insn_m32r (pc, info)
559 bfd_vma pc;
560 disassemble_info *info;
562 static CGEN_CPU_DESC cd = 0;
563 static int prev_isa;
564 static int prev_mach;
565 static int prev_endian;
566 int length;
567 int isa,mach;
568 int endian = (info->endian == BFD_ENDIAN_BIG
569 ? CGEN_ENDIAN_BIG
570 : CGEN_ENDIAN_LITTLE);
571 enum bfd_architecture arch;
573 /* ??? gdb will set mach but leave the architecture as "unknown" */
574 #ifndef CGEN_BFD_ARCH
575 #define CGEN_BFD_ARCH bfd_arch_m32r
576 #endif
577 arch = info->arch;
578 if (arch == bfd_arch_unknown)
579 arch = CGEN_BFD_ARCH;
581 /* There's no standard way to compute the isa number (e.g. for arm thumb)
582 so we leave it to the target. */
583 #ifdef CGEN_COMPUTE_ISA
584 isa = CGEN_COMPUTE_ISA (info);
585 #else
586 isa = 0;
587 #endif
589 mach = info->mach;
591 /* If we've switched cpu's, close the current table and open a new one. */
592 if (cd
593 && (isa != prev_isa
594 || mach != prev_mach
595 || endian != prev_endian))
597 m32r_cgen_cpu_close (cd);
598 cd = 0;
601 /* If we haven't initialized yet, initialize the opcode table. */
602 if (! cd)
604 const bfd_arch_info_type *arch_type = bfd_lookup_arch (arch, mach);
605 const char *mach_name;
607 if (!arch_type)
608 abort ();
609 mach_name = arch_type->printable_name;
611 prev_isa = isa;
612 prev_mach = mach;
613 prev_endian = endian;
614 cd = m32r_cgen_cpu_open (CGEN_CPU_OPEN_ISAS, prev_isa,
615 CGEN_CPU_OPEN_BFDMACH, mach_name,
616 CGEN_CPU_OPEN_ENDIAN, prev_endian,
617 CGEN_CPU_OPEN_END);
618 if (!cd)
619 abort ();
620 m32r_cgen_init_dis (cd);
623 /* We try to have as much common code as possible.
624 But at this point some targets need to take over. */
625 /* ??? Some targets may need a hook elsewhere. Try to avoid this,
626 but if not possible try to move this hook elsewhere rather than
627 have two hooks. */
628 length = CGEN_PRINT_INSN (cd, pc, info);
629 if (length > 0)
630 return length;
631 if (length < 0)
632 return -1;
634 (*info->fprintf_func) (info->stream, UNKNOWN_INSN_MSG);
635 return cd->default_insn_bitsize / 8;