opcodes/disassemble.c

   1 /* Select disassembly routine for specified architecture.
   2    Copyright (C) 1994-2019 Free Software Foundation, Inc.
   3
   4    This file is part of the GNU opcodes library.
   5
   6    This library is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software
  18    Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
  19    MA 02110-1301, USA.  */
  20
  21 #include "sysdep.h"
  22 #include "disassemble.h"
  23 #include "safe-ctype.h"
  24 #include <assert.h>
  25
  26 #ifdef ARCH_all
  27 #define ARCH_aarch64
  28 #define ARCH_alpha
  29 #define ARCH_arc
  30 #define ARCH_arm
  31 #define ARCH_avr
  32 #define ARCH_bfin
  33 #define ARCH_cr16
  34 #define ARCH_cris
  35 #define ARCH_crx
  36 #define ARCH_csky
  37 #define ARCH_d10v
  38 #define ARCH_d30v
  39 #define ARCH_dlx
  40 #define ARCH_epiphany
  41 #define ARCH_fr30
  42 #define ARCH_frv
  43 #define ARCH_ft32
  44 #define ARCH_h8300
  45 #define ARCH_hppa
  46 #define ARCH_i386
  47 #define ARCH_ia64
  48 #define ARCH_ip2k
  49 #define ARCH_iq2000
  50 #define ARCH_lm32
  51 #define ARCH_m32c
  52 #define ARCH_m32r
  53 #define ARCH_m68hc11
  54 #define ARCH_m68hc12
  55 #define ARCH_m68k
  56 #define ARCH_mcore
  57 #define ARCH_mep
  58 #define ARCH_metag
  59 #define ARCH_microblaze
  60 #define ARCH_mips
  61 #define ARCH_mmix
  62 #define ARCH_mn10200
  63 #define ARCH_mn10300
  64 #define ARCH_moxie
  65 #define ARCH_mt
  66 #define ARCH_msp430
  67 #define ARCH_nds32
  68 #define ARCH_nfp
  69 #define ARCH_nios2
  70 #define ARCH_ns32k
  71 #define ARCH_or1k
  72 #define ARCH_pdp11
  73 #define ARCH_pj
  74 #define ARCH_powerpc
  75 #define ARCH_pru
  76 #define ARCH_riscv
  77 #define ARCH_rs6000
  78 #define ARCH_rl78
  79 #define ARCH_rx
  80 #define ARCH_s12z
  81 #define ARCH_s390
  82 #define ARCH_score
  83 #define ARCH_sh
  84 #define ARCH_sparc
  85 #define ARCH_spu
  86 #define ARCH_tic30
  87 #define ARCH_tic4x
  88 #define ARCH_tic54x
  89 #define ARCH_tic6x
  90 #define ARCH_tic80
  91 #define ARCH_tilegx
  92 #define ARCH_tilepro
  93 #define ARCH_v850
  94 #define ARCH_vax
  95 #define ARCH_visium
  96 #define ARCH_wasm32
  97 #define ARCH_xstormy16
  98 #define ARCH_xc16x
  99 #define ARCH_xgate
 100 #define ARCH_xtensa
 101 #define ARCH_z80
 102 #define ARCH_z8k
 103 #endif
 104
 105 #ifdef ARCH_m32c
 106 #include "m32c-desc.h"
 107 #endif
 108
 109 disassembler_ftype
 110 disassembler (enum bfd_architecture a,
 111               bfd_boolean big ATTRIBUTE_UNUSED,
 112               unsigned long mach ATTRIBUTE_UNUSED,
 113               bfd *abfd ATTRIBUTE_UNUSED)
 114 {
 115   disassembler_ftype disassemble;
 116
 117   switch (a)
 118     {
 119       /* If you add a case to this table, also add it to the
 120          ARCH_all definition right above this function.  */
 121 #ifdef ARCH_aarch64
 122     case bfd_arch_aarch64:
 123       disassemble = print_insn_aarch64;
 124       break;
 125 #endif
 126 #ifdef ARCH_alpha
 127     case bfd_arch_alpha:
 128       disassemble = print_insn_alpha;
 129       break;
 130 #endif
 131 #ifdef ARCH_arc
 132     case bfd_arch_arc:
 133       disassemble = arc_get_disassembler (abfd);
 134       break;
 135 #endif
 136 #ifdef ARCH_arm
 137     case bfd_arch_arm:
 138       if (big)
 139         disassemble = print_insn_big_arm;
 140       else
 141         disassemble = print_insn_little_arm;
 142       break;
 143 #endif
 144 #ifdef ARCH_avr
 145     case bfd_arch_avr:
 146       disassemble = print_insn_avr;
 147       break;
 148 #endif
 149 #ifdef ARCH_bfin
 150     case bfd_arch_bfin:
 151       disassemble = print_insn_bfin;
 152       break;
 153 #endif
 154 #ifdef ARCH_cr16
 155     case bfd_arch_cr16:
 156       disassemble = print_insn_cr16;
 157       break;
 158 #endif
 159 #ifdef ARCH_cris
 160     case bfd_arch_cris:
 161       disassemble = cris_get_disassembler (abfd);
 162       break;
 163 #endif
 164 #ifdef ARCH_crx
 165     case bfd_arch_crx:
 166       disassemble = print_insn_crx;
 167       break;
 168 #endif
 169 #ifdef ARCH_csky
 170     case bfd_arch_csky:
 171       disassemble = csky_get_disassembler (abfd);
 172       break;
 173 #endif
 174
 175 #ifdef ARCH_d10v
 176     case bfd_arch_d10v:
 177       disassemble = print_insn_d10v;
 178       break;
 179 #endif
 180 #ifdef ARCH_d30v
 181     case bfd_arch_d30v:
 182       disassemble = print_insn_d30v;
 183       break;
 184 #endif
 185 #ifdef ARCH_dlx
 186     case bfd_arch_dlx:
 187       /* As far as I know we only handle big-endian DLX objects.  */
 188       disassemble = print_insn_dlx;
 189       break;
 190 #endif
 191 #ifdef ARCH_h8300
 192     case bfd_arch_h8300:
 193       if (mach == bfd_mach_h8300h || mach == bfd_mach_h8300hn)
 194         disassemble = print_insn_h8300h;
 195       else if (mach == bfd_mach_h8300s
 196                || mach == bfd_mach_h8300sn
 197                || mach == bfd_mach_h8300sx
 198                || mach == bfd_mach_h8300sxn)
 199         disassemble = print_insn_h8300s;
 200       else
 201         disassemble = print_insn_h8300;
 202       break;
 203 #endif
 204 #ifdef ARCH_hppa
 205     case bfd_arch_hppa:
 206       disassemble = print_insn_hppa;
 207       break;
 208 #endif
 209 #ifdef ARCH_i386
 210     case bfd_arch_i386:
 211     case bfd_arch_iamcu:
 212     case bfd_arch_l1om:
 213     case bfd_arch_k1om:
 214       disassemble = print_insn_i386;
 215       break;
 216 #endif
 217 #ifdef ARCH_ia64
 218     case bfd_arch_ia64:
 219       disassemble = print_insn_ia64;
 220       break;
 221 #endif
 222 #ifdef ARCH_ip2k
 223     case bfd_arch_ip2k:
 224       disassemble = print_insn_ip2k;
 225       break;
 226 #endif
 227 #ifdef ARCH_epiphany
 228     case bfd_arch_epiphany:
 229       disassemble = print_insn_epiphany;
 230       break;
 231 #endif
 232 #ifdef ARCH_fr30
 233     case bfd_arch_fr30:
 234       disassemble = print_insn_fr30;
 235       break;
 236 #endif
 237 #ifdef ARCH_lm32
 238     case bfd_arch_lm32:
 239       disassemble = print_insn_lm32;
 240       break;
 241 #endif
 242 #ifdef ARCH_m32r
 243     case bfd_arch_m32r:
 244       disassemble = print_insn_m32r;
 245       break;
 246 #endif
 247 #if defined(ARCH_m68hc11) || defined(ARCH_m68hc12) \
 248     || defined(ARCH_9s12x) || defined(ARCH_m9s12xg)
 249     case bfd_arch_m68hc11:
 250       disassemble = print_insn_m68hc11;
 251       break;
 252     case bfd_arch_m68hc12:
 253       disassemble = print_insn_m68hc12;
 254       break;
 255     case bfd_arch_m9s12x:
 256       disassemble = print_insn_m9s12x;
 257       break;
 258     case bfd_arch_m9s12xg:
 259       disassemble = print_insn_m9s12xg;
 260       break;
 261 #endif
 262 #if defined(ARCH_s12z)
 263     case bfd_arch_s12z:
 264       disassemble = print_insn_s12z;
 265       break;
 266 #endif
 267 #ifdef ARCH_m68k
 268     case bfd_arch_m68k:
 269       disassemble = print_insn_m68k;
 270       break;
 271 #endif
 272 #ifdef ARCH_mt
 273     case bfd_arch_mt:
 274       disassemble = print_insn_mt;
 275       break;
 276 #endif
 277 #ifdef ARCH_microblaze
 278     case bfd_arch_microblaze:
 279       disassemble = print_insn_microblaze;
 280       break;
 281 #endif
 282 #ifdef ARCH_msp430
 283     case bfd_arch_msp430:
 284       disassemble = print_insn_msp430;
 285       break;
 286 #endif
 287 #ifdef ARCH_nds32
 288     case bfd_arch_nds32:
 289       disassemble = print_insn_nds32;
 290       break;
 291 #endif
 292 #ifdef ARCH_nfp
 293     case bfd_arch_nfp:
 294       disassemble = print_insn_nfp;
 295       break;
 296 #endif
 297 #ifdef ARCH_ns32k
 298     case bfd_arch_ns32k:
 299       disassemble = print_insn_ns32k;
 300       break;
 301 #endif
 302 #ifdef ARCH_mcore
 303     case bfd_arch_mcore:
 304       disassemble = print_insn_mcore;
 305       break;
 306 #endif
 307 #ifdef ARCH_mep
 308     case bfd_arch_mep:
 309       disassemble = print_insn_mep;
 310       break;
 311 #endif
 312 #ifdef ARCH_metag
 313     case bfd_arch_metag:
 314       disassemble = print_insn_metag;
 315       break;
 316 #endif
 317 #ifdef ARCH_mips
 318     case bfd_arch_mips:
 319       if (big)
 320         disassemble = print_insn_big_mips;
 321       else
 322         disassemble = print_insn_little_mips;
 323       break;
 324 #endif
 325 #ifdef ARCH_mmix
 326     case bfd_arch_mmix:
 327       disassemble = print_insn_mmix;
 328       break;
 329 #endif
 330 #ifdef ARCH_mn10200
 331     case bfd_arch_mn10200:
 332       disassemble = print_insn_mn10200;
 333       break;
 334 #endif
 335 #ifdef ARCH_mn10300
 336     case bfd_arch_mn10300:
 337       disassemble = print_insn_mn10300;
 338       break;
 339 #endif
 340 #ifdef ARCH_nios2
 341     case bfd_arch_nios2:
 342       if (big)
 343         disassemble = print_insn_big_nios2;
 344       else
 345         disassemble = print_insn_little_nios2;
 346       break;
 347 #endif
 348 #ifdef ARCH_or1k
 349     case bfd_arch_or1k:
 350       disassemble = print_insn_or1k;
 351       break;
 352 #endif
 353 #ifdef ARCH_pdp11
 354     case bfd_arch_pdp11:
 355       disassemble = print_insn_pdp11;
 356       break;
 357 #endif
 358 #ifdef ARCH_pj
 359     case bfd_arch_pj:
 360       disassemble = print_insn_pj;
 361       break;
 362 #endif
 363 #ifdef ARCH_powerpc
 364     case bfd_arch_powerpc:
 365 #endif
 366 #ifdef ARCH_rs6000
 367     case bfd_arch_rs6000:
 368 #endif
 369 #if defined ARCH_powerpc || defined ARCH_rs6000
 370       if (big)
 371         disassemble = print_insn_big_powerpc;
 372       else
 373         disassemble = print_insn_little_powerpc;
 374       break;
 375 #endif
 376 #ifdef ARCH_pru
 377     case bfd_arch_pru:
 378       disassemble = print_insn_pru;
 379       break;
 380 #endif
 381 #ifdef ARCH_riscv
 382     case bfd_arch_riscv:
 383       disassemble = print_insn_riscv;
 384       break;
 385 #endif
 386 #ifdef ARCH_rl78
 387     case bfd_arch_rl78:
 388       disassemble = rl78_get_disassembler (abfd);
 389       break;
 390 #endif
 391 #ifdef ARCH_rx
 392     case bfd_arch_rx:
 393       disassemble = print_insn_rx;
 394       break;
 395 #endif
 396 #ifdef ARCH_s390
 397     case bfd_arch_s390:
 398       disassemble = print_insn_s390;
 399       break;
 400 #endif
 401 #ifdef ARCH_score
 402     case bfd_arch_score:
 403       if (big)
 404         disassemble = print_insn_big_score;
 405       else
 406         disassemble = print_insn_little_score;
 407      break;
 408 #endif
 409 #ifdef ARCH_sh
 410     case bfd_arch_sh:
 411       disassemble = print_insn_sh;
 412       break;
 413 #endif
 414 #ifdef ARCH_sparc
 415     case bfd_arch_sparc:
 416       disassemble = print_insn_sparc;
 417       break;
 418 #endif
 419 #ifdef ARCH_spu
 420     case bfd_arch_spu:
 421       disassemble = print_insn_spu;
 422       break;
 423 #endif
 424 #ifdef ARCH_tic30
 425     case bfd_arch_tic30:
 426       disassemble = print_insn_tic30;
 427       break;
 428 #endif
 429 #ifdef ARCH_tic4x
 430     case bfd_arch_tic4x:
 431       disassemble = print_insn_tic4x;
 432       break;
 433 #endif
 434 #ifdef ARCH_tic54x
 435     case bfd_arch_tic54x:
 436       disassemble = print_insn_tic54x;
 437       break;
 438 #endif
 439 #ifdef ARCH_tic6x
 440     case bfd_arch_tic6x:
 441       disassemble = print_insn_tic6x;
 442       break;
 443 #endif
 444 #ifdef ARCH_tic80
 445     case bfd_arch_tic80:
 446       disassemble = print_insn_tic80;
 447       break;
 448 #endif
 449 #ifdef ARCH_ft32
 450     case bfd_arch_ft32:
 451       disassemble = print_insn_ft32;
 452       break;
 453 #endif
 454 #ifdef ARCH_v850
 455     case bfd_arch_v850:
 456     case bfd_arch_v850_rh850:
 457       disassemble = print_insn_v850;
 458       break;
 459 #endif
 460 #ifdef ARCH_wasm32
 461     case bfd_arch_wasm32:
 462       disassemble = print_insn_wasm32;
 463       break;
 464 #endif
 465 #ifdef ARCH_xgate
 466     case bfd_arch_xgate:
 467       disassemble = print_insn_xgate;
 468       break;
 469 #endif
 470 #ifdef ARCH_xstormy16
 471     case bfd_arch_xstormy16:
 472       disassemble = print_insn_xstormy16;
 473       break;
 474 #endif
 475 #ifdef ARCH_xc16x
 476     case bfd_arch_xc16x:
 477       disassemble = print_insn_xc16x;
 478       break;
 479 #endif
 480 #ifdef ARCH_xtensa
 481     case bfd_arch_xtensa:
 482       disassemble = print_insn_xtensa;
 483       break;
 484 #endif
 485 #ifdef ARCH_z80
 486     case bfd_arch_z80:
 487       disassemble = print_insn_z80;
 488       break;
 489 #endif
 490 #ifdef ARCH_z8k
 491     case bfd_arch_z8k:
 492       if (mach == bfd_mach_z8001)
 493         disassemble = print_insn_z8001;
 494       else
 495         disassemble = print_insn_z8002;
 496       break;
 497 #endif
 498 #ifdef ARCH_vax
 499     case bfd_arch_vax:
 500       disassemble = print_insn_vax;
 501       break;
 502 #endif
 503 #ifdef ARCH_visium
 504      case bfd_arch_visium:
 505        disassemble = print_insn_visium;
 506        break;
 507 #endif
 508 #ifdef ARCH_frv
 509     case bfd_arch_frv:
 510       disassemble = print_insn_frv;
 511       break;
 512 #endif
 513 #ifdef ARCH_moxie
 514     case bfd_arch_moxie:
 515       disassemble = print_insn_moxie;
 516       break;
 517 #endif
 518 #ifdef ARCH_iq2000
 519     case bfd_arch_iq2000:
 520       disassemble = print_insn_iq2000;
 521       break;
 522 #endif
 523 #ifdef ARCH_m32c
 524     case bfd_arch_m32c:
 525       disassemble = print_insn_m32c;
 526       break;
 527 #endif
 528 #ifdef ARCH_tilegx
 529     case bfd_arch_tilegx:
 530       disassemble = print_insn_tilegx;
 531       break;
 532 #endif
 533 #ifdef ARCH_tilepro
 534     case bfd_arch_tilepro:
 535       disassemble = print_insn_tilepro;
 536       break;
 537 #endif
 538     default:
 539       return 0;
 540     }
 541   return disassemble;
 542 }
 543
 544 void
 545 disassembler_usage (FILE *stream ATTRIBUTE_UNUSED)
 546 {
 547 #ifdef ARCH_aarch64
 548   print_aarch64_disassembler_options (stream);
 549 #endif
 550 #ifdef ARCH_arc
 551   print_arc_disassembler_options (stream);
 552 #endif
 553 #ifdef ARCH_arm
 554   print_arm_disassembler_options (stream);
 555 #endif
 556 #ifdef ARCH_mips
 557   print_mips_disassembler_options (stream);
 558 #endif
 559 #ifdef ARCH_nfp
 560   print_nfp_disassembler_options (stream);
 561 #endif
 562 #ifdef ARCH_powerpc
 563   print_ppc_disassembler_options (stream);
 564 #endif
 565 #ifdef ARCH_riscv
 566   print_riscv_disassembler_options (stream);
 567 #endif
 568 #ifdef ARCH_i386
 569   print_i386_disassembler_options (stream);
 570 #endif
 571 #ifdef ARCH_s390
 572   print_s390_disassembler_options (stream);
 573 #endif
 574 #ifdef ARCH_wasm32
 575   print_wasm32_disassembler_options (stream);
 576 #endif
 577
 578   return;
 579 }
 580
 581 void
 582 disassemble_init_for_target (struct disassemble_info * info)
 583 {
 584   if (info == NULL)
 585     return;
 586
 587   switch (info->arch)
 588     {
 589 #ifdef ARCH_aarch64
 590     case bfd_arch_aarch64:
 591       info->symbol_is_valid = aarch64_symbol_is_valid;
 592       info->disassembler_needs_relocs = TRUE;
 593       break;
 594 #endif
 595 #ifdef ARCH_arm
 596     case bfd_arch_arm:
 597       info->symbol_is_valid = arm_symbol_is_valid;
 598       info->disassembler_needs_relocs = TRUE;
 599       break;
 600 #endif
 601 #ifdef ARCH_csky
 602     case bfd_arch_csky:
 603       info->symbol_is_valid = csky_symbol_is_valid;
 604       info->disassembler_needs_relocs = TRUE;
 605       break;
 606 #endif
 607
 608 #ifdef ARCH_ia64
 609     case bfd_arch_ia64:
 610       info->skip_zeroes = 16;
 611       break;
 612 #endif
 613 #ifdef ARCH_tic4x
 614     case bfd_arch_tic4x:
 615       info->skip_zeroes = 32;
 616       break;
 617 #endif
 618 #ifdef ARCH_mep
 619     case bfd_arch_mep:
 620       info->skip_zeroes = 256;
 621       info->skip_zeroes_at_end = 0;
 622       break;
 623 #endif
 624 #ifdef ARCH_metag
 625     case bfd_arch_metag:
 626       info->disassembler_needs_relocs = TRUE;
 627       break;
 628 #endif
 629 #ifdef ARCH_m32c
 630     case bfd_arch_m32c:
 631       /* This processor in fact is little endian.  The value set here
 632          reflects the way opcodes are written in the cgen description.  */
 633       info->endian = BFD_ENDIAN_BIG;
 634       if (! info->insn_sets)
 635         {
 636           info->insn_sets = cgen_bitset_create (ISA_MAX);
 637           if (info->mach == bfd_mach_m16c)
 638             cgen_bitset_set (info->insn_sets, ISA_M16C);
 639           else
 640             cgen_bitset_set (info->insn_sets, ISA_M32C);
 641         }
 642       break;
 643 #endif
 644 #ifdef ARCH_pru
 645     case bfd_arch_pru:
 646       info->disassembler_needs_relocs = TRUE;
 647       break;
 648 #endif
 649 #ifdef ARCH_powerpc
 650     case bfd_arch_powerpc:
 651 #endif
 652 #ifdef ARCH_rs6000
 653     case bfd_arch_rs6000:
 654 #endif
 655 #if defined (ARCH_powerpc) || defined (ARCH_rs6000)
 656       disassemble_init_powerpc (info);
 657       break;
 658 #endif
 659 #ifdef ARCH_riscv
 660     case bfd_arch_riscv:
 661       info->symbol_is_valid = riscv_symbol_is_valid;
 662       break;
 663 #endif
 664 #ifdef ARCH_wasm32
 665     case bfd_arch_wasm32:
 666       disassemble_init_wasm32 (info);
 667       break;
 668 #endif
 669 #ifdef ARCH_s390
 670     case bfd_arch_s390:
 671       disassemble_init_s390 (info);
 672       break;
 673 #endif
 674 #ifdef ARCH_nds32
 675     case bfd_arch_nds32:
 676       disassemble_init_nds32 (info);
 677       break;
 678  #endif
 679     default:
 680       break;
 681     }
 682 }
 683
 684 /* Remove whitespace and consecutive commas from OPTIONS.  */
 685
 686 char *
 687 remove_whitespace_and_extra_commas (char *options)
 688 {
 689   char *str;
 690   size_t i, len;
 691
 692   if (options == NULL)
 693     return NULL;
 694
 695   /* Strip off all trailing whitespace and commas.  */
 696   for (len = strlen (options); len > 0; len--)
 697     {
 698       if (!ISSPACE (options[len - 1]) && options[len - 1] != ',')
 699         break;
 700       options[len - 1] = '\0';
 701     }
 702
 703   /* Convert all remaining whitespace to commas.  */
 704   for (i = 0; options[i] != '\0'; i++)
 705     if (ISSPACE (options[i]))
 706       options[i] = ',';
 707
 708   /* Remove consecutive commas.  */
 709   for (str = options; *str != '\0'; str++)
 710     if (*str == ',' && (*(str + 1) == ',' || str == options))
 711       {
 712         char *next = str + 1;
 713         while (*next == ',')
 714           next++;
 715         len = strlen (next);
 716         if (str != options)
 717           str++;
 718         memmove (str, next, len);
 719         next[len - (size_t)(next - str)] = '\0';
 720       }
 721   return (strlen (options) != 0) ? options : NULL;
 722 }
 723
 724 /* Like STRCMP, but treat ',' the same as '\0' so that we match
 725    strings like "foobar" against "foobar,xxyyzz,...".  */
 726
 727 int
 728 disassembler_options_cmp (const char *s1, const char *s2)
 729 {
 730   unsigned char c1, c2;
 731
 732   do
 733     {
 734       c1 = (unsigned char) *s1++;
 735       if (c1 == ',')
 736         c1 = '\0';
 737       c2 = (unsigned char) *s2++;
 738       if (c2 == ',')
 739         c2 = '\0';
 740       if (c1 == '\0')
 741         return c1 - c2;
 742     }
 743   while (c1 == c2);
 744
 745   return c1 - c2;
 746 }