bfd/archures.c

   1 /* BFD library support routines for architectures.
   2    Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
   3    2000, 2001, 2002
   4    Free Software Foundation, Inc.
   5    Hacked by John Gilmore and Steve Chamberlain of Cygnus Support.
   6
   7 This file is part of BFD, the Binary File Descriptor library.
   8
   9 This program 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 2 of the License, or
  12 (at your option) any later version.
  13
  14 This program is distributed in the hope that it will be useful,
  15 but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 GNU General Public License for more details.
  18
  19 You should have received a copy of the GNU General Public License
  20 along with this program; if not, write to the Free Software
  21 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  22
  23 #include "bfd.h"
  24 #include "sysdep.h"
  25 #include "libbfd.h"
  26 #include "safe-ctype.h"
  27
  28 /*
  29
  30 SECTION
  31         Architectures
  32
  33         BFD keeps one atom in a BFD describing the
  34         architecture of the data attached to the BFD: a pointer to a
  35         <<bfd_arch_info_type>>.
  36
  37         Pointers to structures can be requested independently of a BFD
  38         so that an architecture's information can be interrogated
  39         without access to an open BFD.
  40
  41         The architecture information is provided by each architecture package.
  42         The set of default architectures is selected by the macro
  43         <<SELECT_ARCHITECTURES>>.  This is normally set up in the
  44         @file{config/@var{target}.mt} file of your choice.  If the name is not
  45         defined, then all the architectures supported are included.
  46
  47         When BFD starts up, all the architectures are called with an
  48         initialize method.  It is up to the architecture back end to
  49         insert as many items into the list of architectures as it wants to;
  50         generally this would be one for each machine and one for the
  51         default case (an item with a machine field of 0).
  52
  53         BFD's idea of an architecture is implemented in @file{archures.c}.
  54 */
  55
  56 /*
  57
  58 SUBSECTION
  59         bfd_architecture
  60
  61 DESCRIPTION
  62         This enum gives the object file's CPU architecture, in a
  63         global sense---i.e., what processor family does it belong to?
  64         Another field indicates which processor within
  65         the family is in use.  The machine gives a number which
  66         distinguishes different versions of the architecture,
  67         containing, for example, 2 and 3 for Intel i960 KA and i960 KB,
  68         and 68020 and 68030 for Motorola 68020 and 68030.
  69
  70 .enum bfd_architecture
  71 .{
  72 .  bfd_arch_unknown,   {* File arch not known.  *}
  73 .  bfd_arch_obscure,   {* Arch known, not one of these.  *}
  74 .  bfd_arch_m68k,      {* Motorola 68xxx *}
  75 .#define bfd_mach_m68000 1
  76 .#define bfd_mach_m68008 2
  77 .#define bfd_mach_m68010 3
  78 .#define bfd_mach_m68020 4
  79 .#define bfd_mach_m68030 5
  80 .#define bfd_mach_m68040 6
  81 .#define bfd_mach_m68060 7
  82 .#define bfd_mach_cpu32  8
  83 .#define bfd_mach_mcf5200  9
  84 .#define bfd_mach_mcf5206e 10
  85 .#define bfd_mach_mcf5307  11
  86 .#define bfd_mach_mcf5407  12
  87 .  bfd_arch_vax,       {* DEC Vax *}
  88 .  bfd_arch_i960,      {* Intel 960 *}
  89 .    {* The order of the following is important.
  90 .       lower number indicates a machine type that
  91 .       only accepts a subset of the instructions
  92 .       available to machines with higher numbers.
  93 .       The exception is the "ca", which is
  94 .       incompatible with all other machines except
  95 .       "core".  *}
  96 .
  97 .#define bfd_mach_i960_core      1
  98 .#define bfd_mach_i960_ka_sa     2
  99 .#define bfd_mach_i960_kb_sb     3
 100 .#define bfd_mach_i960_mc        4
 101 .#define bfd_mach_i960_xa        5
 102 .#define bfd_mach_i960_ca        6
 103 .#define bfd_mach_i960_jx        7
 104 .#define bfd_mach_i960_hx        8
 105 .
 106 .  bfd_arch_or32,      {* OpenRISC 32 *}
 107 .
 108 .  bfd_arch_a29k,      {* AMD 29000 *}
 109 .  bfd_arch_sparc,     {* SPARC *}
 110 .#define bfd_mach_sparc                 1
 111 .{* The difference between v8plus and v9 is that v9 is a true 64 bit env.  *}
 112 .#define bfd_mach_sparc_sparclet        2
 113 .#define bfd_mach_sparc_sparclite       3
 114 .#define bfd_mach_sparc_v8plus          4
 115 .#define bfd_mach_sparc_v8plusa         5 {* with ultrasparc add'ns.  *}
 116 .#define bfd_mach_sparc_sparclite_le    6
 117 .#define bfd_mach_sparc_v9              7
 118 .#define bfd_mach_sparc_v9a             8 {* with ultrasparc add'ns.  *}
 119 .#define bfd_mach_sparc_v8plusb         9 {* with cheetah add'ns.  *}
 120 .#define bfd_mach_sparc_v9b             10 {* with cheetah add'ns.  *}
 121 .{* Nonzero if MACH has the v9 instruction set.  *}
 122 .#define bfd_mach_sparc_v9_p(mach) \
 123 .  ((mach) >= bfd_mach_sparc_v8plus && (mach) <= bfd_mach_sparc_v9b \
 124 .   && (mach) != bfd_mach_sparc_sparclite_le)
 125 .  bfd_arch_mips,      {* MIPS Rxxxx *}
 126 .#define bfd_mach_mips3000              3000
 127 .#define bfd_mach_mips3900              3900
 128 .#define bfd_mach_mips4000              4000
 129 .#define bfd_mach_mips4010              4010
 130 .#define bfd_mach_mips4100              4100
 131 .#define bfd_mach_mips4111              4111
 132 .#define bfd_mach_mips4300              4300
 133 .#define bfd_mach_mips4400              4400
 134 .#define bfd_mach_mips4600              4600
 135 .#define bfd_mach_mips4650              4650
 136 .#define bfd_mach_mips5000              5000
 137 .#define bfd_mach_mips6000              6000
 138 .#define bfd_mach_mips8000              8000
 139 .#define bfd_mach_mips10000             10000
 140 .#define bfd_mach_mips12000             12000
 141 .#define bfd_mach_mips16                16
 142 .#define bfd_mach_mips5                 5
 143 .#define bfd_mach_mips_sb1              12310201 {* octal 'SB', 01 *}
 144 .#define bfd_mach_mipsisa32             32
 145 .#define bfd_mach_mipsisa64             64
 146 .  bfd_arch_i386,      {* Intel 386 *}
 147 .#define bfd_mach_i386_i386 0
 148 .#define bfd_mach_i386_i8086 1
 149 .#define bfd_mach_i386_i386_intel_syntax 2
 150 .#define bfd_mach_x86_64 3
 151 .#define bfd_mach_x86_64_intel_syntax 4
 152 .  bfd_arch_we32k,     {* AT&T WE32xxx *}
 153 .  bfd_arch_tahoe,     {* CCI/Harris Tahoe *}
 154 .  bfd_arch_i860,      {* Intel 860 *}
 155 .  bfd_arch_i370,      {* IBM 360/370 Mainframes *}
 156 .  bfd_arch_romp,      {* IBM ROMP PC/RT *}
 157 .  bfd_arch_alliant,   {* Alliant *}
 158 .  bfd_arch_convex,    {* Convex *}
 159 .  bfd_arch_m88k,      {* Motorola 88xxx *}
 160 .  bfd_arch_pyramid,   {* Pyramid Technology *}
 161 .  bfd_arch_h8300,     {* Hitachi H8/300 *}
 162 .#define bfd_mach_h8300   1
 163 .#define bfd_mach_h8300h  2
 164 .#define bfd_mach_h8300s  3
 165 .  bfd_arch_pdp11,     {* DEC PDP-11 *}
 166 .  bfd_arch_powerpc,   {* PowerPC *}
 167 .#define bfd_mach_ppc           0
 168 .#define bfd_mach_ppc64         1
 169 .#define bfd_mach_ppc_403       403
 170 .#define bfd_mach_ppc_403gc     4030
 171 .#define bfd_mach_ppc_505       505
 172 .#define bfd_mach_ppc_601       601
 173 .#define bfd_mach_ppc_602       602
 174 .#define bfd_mach_ppc_603       603
 175 .#define bfd_mach_ppc_ec603e    6031
 176 .#define bfd_mach_ppc_604       604
 177 .#define bfd_mach_ppc_620       620
 178 .#define bfd_mach_ppc_630       630
 179 .#define bfd_mach_ppc_750       750
 180 .#define bfd_mach_ppc_860       860
 181 .#define bfd_mach_ppc_a35       35
 182 .#define bfd_mach_ppc_rs64ii    642
 183 .#define bfd_mach_ppc_rs64iii   643
 184 .#define bfd_mach_ppc_7400      7400
 185 .  bfd_arch_rs6000,    {* IBM RS/6000 *}
 186 .#define bfd_mach_rs6k          0
 187 .#define bfd_mach_rs6k_rs1      6001
 188 .#define bfd_mach_rs6k_rsc      6003
 189 .#define bfd_mach_rs6k_rs2      6002
 190 .  bfd_arch_hppa,      {* HP PA RISC *}
 191 .  bfd_arch_d10v,      {* Mitsubishi D10V *}
 192 .#define bfd_mach_d10v          0
 193 .#define bfd_mach_d10v_ts2      2
 194 .#define bfd_mach_d10v_ts3      3
 195 .  bfd_arch_d30v,      {* Mitsubishi D30V *}
 196 .  bfd_arch_dlx,       {* DLX *}
 197 .  bfd_arch_m68hc11,   {* Motorola 68HC11 *}
 198 .  bfd_arch_m68hc12,   {* Motorola 68HC12 *}
 199 .  bfd_arch_z8k,       {* Zilog Z8000 *}
 200 .#define bfd_mach_z8001         1
 201 .#define bfd_mach_z8002         2
 202 .  bfd_arch_h8500,     {* Hitachi H8/500 *}
 203 .  bfd_arch_sh,        {* Hitachi SH *}
 204 .#define bfd_mach_sh            0
 205 .#define bfd_mach_sh2        0x20
 206 .#define bfd_mach_sh_dsp     0x2d
 207 .#define bfd_mach_sh3        0x30
 208 .#define bfd_mach_sh3_dsp    0x3d
 209 .#define bfd_mach_sh3e       0x3e
 210 .#define bfd_mach_sh4        0x40
 211 .#define bfd_mach_sh5        0x50
 212 .  bfd_arch_alpha,     {* Dec Alpha *}
 213 .#define bfd_mach_alpha_ev4  0x10
 214 .#define bfd_mach_alpha_ev5  0x20
 215 .#define bfd_mach_alpha_ev6  0x30
 216 .  bfd_arch_arm,       {* Advanced Risc Machines ARM.  *}
 217 .#define bfd_mach_arm_2         1
 218 .#define bfd_mach_arm_2a        2
 219 .#define bfd_mach_arm_3         3
 220 .#define bfd_mach_arm_3M        4
 221 .#define bfd_mach_arm_4         5
 222 .#define bfd_mach_arm_4T        6
 223 .#define bfd_mach_arm_5         7
 224 .#define bfd_mach_arm_5T        8
 225 .#define bfd_mach_arm_5TE       9
 226 .#define bfd_mach_arm_XScale    10
 227 .  bfd_arch_ns32k,     {* National Semiconductors ns32000 *}
 228 .  bfd_arch_w65,       {* WDC 65816 *}
 229 .  bfd_arch_tic30,     {* Texas Instruments TMS320C30 *}
 230 .  bfd_arch_tic54x,    {* Texas Instruments TMS320C54X *}
 231 .  bfd_arch_tic80,     {* TI TMS320c80 (MVP) *}
 232 .  bfd_arch_v850,      {* NEC V850 *}
 233 .#define bfd_mach_v850          0
 234 .#define bfd_mach_v850e         'E'
 235 .#define bfd_mach_v850ea        'A'
 236 .  bfd_arch_arc,       {* ARC Cores *}
 237 .#define bfd_mach_arc_5         0
 238 .#define bfd_mach_arc_6         1
 239 .#define bfd_mach_arc_7         2
 240 .#define bfd_mach_arc_8         3
 241 .  bfd_arch_m32r,      {* Mitsubishi M32R/D *}
 242 .#define bfd_mach_m32r          0 {* For backwards compatibility.  *}
 243 .#define bfd_mach_m32rx         'x'
 244 .  bfd_arch_mn10200,   {* Matsushita MN10200 *}
 245 .  bfd_arch_mn10300,   {* Matsushita MN10300 *}
 246 .#define bfd_mach_mn10300               300
 247 .#define bfd_mach_am33          330
 248 .  bfd_arch_fr30,
 249 .#define bfd_mach_fr30          0x46523330
 250 .  bfd_arch_frv,
 251 .#define bfd_mach_frv           0
 252 .#define bfd_mach_frvsimple     1
 253 .#define bfd_mach_fr300         300
 254 .#define bfd_mach_fr400         400
 255 .#define bfd_mach_frvtomcat     499     {* fr500 prototype *}
 256 .#define bfd_mach_fr500         500
 257 .  bfd_arch_mcore,
 258 .  bfd_arch_ia64,      {* HP/Intel ia64 *}
 259 .#define bfd_mach_ia64_elf64    0
 260 .#define bfd_mach_ia64_elf32    1
 261 .  bfd_arch_ip2k,      {* Ubicom IP2K microcontrollers. *}
 262 .#define bfd_mach_ip2022        0
 263 .#define bfd_mach_ip2022ext     1
 264 .  bfd_arch_pj,
 265 .  bfd_arch_avr,       {* Atmel AVR microcontrollers.  *}
 266 .#define bfd_mach_avr1          1
 267 .#define bfd_mach_avr2          2
 268 .#define bfd_mach_avr3          3
 269 .#define bfd_mach_avr4          4
 270 .#define bfd_mach_avr5          5
 271 .  bfd_arch_cris,      {* Axis CRIS *}
 272 .  bfd_arch_s390,      {* IBM s390 *}
 273 .#define bfd_mach_s390_31       0
 274 .#define bfd_mach_s390_64       1
 275 .  bfd_arch_openrisc,  {* OpenRISC *}
 276 .  bfd_arch_mmix,      {* Donald Knuth's educational processor.  *}
 277 .  bfd_arch_xstormy16,
 278 .#define bfd_mach_xstormy16     0
 279 .  bfd_arch_last
 280 .  };
 281 */
 282
 283 /*
 284 SUBSECTION
 285         bfd_arch_info
 286
 287 DESCRIPTION
 288         This structure contains information on architectures for use
 289         within BFD.
 290
 291 .
 292 .typedef struct bfd_arch_info
 293 .{
 294 .  int bits_per_word;
 295 .  int bits_per_address;
 296 .  int bits_per_byte;
 297 .  enum bfd_architecture arch;
 298 .  unsigned long mach;
 299 .  const char *arch_name;
 300 .  const char *printable_name;
 301 .  unsigned int section_align_power;
 302 .  {* True if this is the default machine for the architecture.
 303 .     The default arch should be the first entry for an arch so that
 304 .     all the entries for that arch can be accessed via <<next>>.  *}
 305 .  boolean the_default;
 306 .  const struct bfd_arch_info * (*compatible)
 307 .       PARAMS ((const struct bfd_arch_info *a,
 308 .                const struct bfd_arch_info *b));
 309 .
 310 .  boolean (*scan) PARAMS ((const struct bfd_arch_info *, const char *));
 311 .
 312 .  const struct bfd_arch_info *next;
 313 .}
 314 .bfd_arch_info_type;
 315 .
 316 */
 317
 318 extern const bfd_arch_info_type bfd_a29k_arch;
 319 extern const bfd_arch_info_type bfd_alpha_arch;
 320 extern const bfd_arch_info_type bfd_arc_arch;
 321 extern const bfd_arch_info_type bfd_arm_arch;
 322 extern const bfd_arch_info_type bfd_avr_arch;
 323 extern const bfd_arch_info_type bfd_cris_arch;
 324 extern const bfd_arch_info_type bfd_d10v_arch;
 325 extern const bfd_arch_info_type bfd_d30v_arch;
 326 extern const bfd_arch_info_type bfd_dlx_arch;
 327 extern const bfd_arch_info_type bfd_fr30_arch;
 328 extern const bfd_arch_info_type bfd_frv_arch;
 329 extern const bfd_arch_info_type bfd_h8300_arch;
 330 extern const bfd_arch_info_type bfd_h8500_arch;
 331 extern const bfd_arch_info_type bfd_hppa_arch;
 332 extern const bfd_arch_info_type bfd_i370_arch;
 333 extern const bfd_arch_info_type bfd_i386_arch;
 334 extern const bfd_arch_info_type bfd_i860_arch;
 335 extern const bfd_arch_info_type bfd_i960_arch;
 336 extern const bfd_arch_info_type bfd_ia64_arch;
 337 extern const bfd_arch_info_type bfd_ip2k_arch;
 338 extern const bfd_arch_info_type bfd_m32r_arch;
 339 extern const bfd_arch_info_type bfd_m68hc11_arch;
 340 extern const bfd_arch_info_type bfd_m68hc12_arch;
 341 extern const bfd_arch_info_type bfd_m68k_arch;
 342 extern const bfd_arch_info_type bfd_m88k_arch;
 343 extern const bfd_arch_info_type bfd_mcore_arch;
 344 extern const bfd_arch_info_type bfd_mips_arch;
 345 extern const bfd_arch_info_type bfd_mmix_arch;
 346 extern const bfd_arch_info_type bfd_mn10200_arch;
 347 extern const bfd_arch_info_type bfd_mn10300_arch;
 348 extern const bfd_arch_info_type bfd_ns32k_arch;
 349 extern const bfd_arch_info_type bfd_openrisc_arch;
 350 extern const bfd_arch_info_type bfd_or32_arch;
 351 extern const bfd_arch_info_type bfd_pdp11_arch;
 352 extern const bfd_arch_info_type bfd_pj_arch;
 353 extern const bfd_arch_info_type bfd_powerpc_archs[];
 354 #define bfd_powerpc_arch bfd_powerpc_archs[0]
 355 extern const bfd_arch_info_type bfd_rs6000_arch;
 356 extern const bfd_arch_info_type bfd_s390_arch;
 357 extern const bfd_arch_info_type bfd_sh_arch;
 358 extern const bfd_arch_info_type bfd_sparc_arch;
 359 extern const bfd_arch_info_type bfd_tic30_arch;
 360 extern const bfd_arch_info_type bfd_tic54x_arch;
 361 extern const bfd_arch_info_type bfd_tic80_arch;
 362 extern const bfd_arch_info_type bfd_v850_arch;
 363 extern const bfd_arch_info_type bfd_vax_arch;
 364 extern const bfd_arch_info_type bfd_we32k_arch;
 365 extern const bfd_arch_info_type bfd_w65_arch;
 366 extern const bfd_arch_info_type bfd_xstormy16_arch;
 367 extern const bfd_arch_info_type bfd_z8k_arch;
 368
 369 static const bfd_arch_info_type * const bfd_archures_list[] =
 370   {
 371 #ifdef SELECT_ARCHITECTURES
 372     SELECT_ARCHITECTURES,
 373 #else
 374     &bfd_a29k_arch,
 375     &bfd_alpha_arch,
 376     &bfd_arc_arch,
 377     &bfd_arm_arch,
 378     &bfd_avr_arch,
 379     &bfd_cris_arch,
 380     &bfd_d10v_arch,
 381     &bfd_d30v_arch,
 382     &bfd_dlx_arch,
 383     &bfd_fr30_arch,
 384     &bfd_frv_arch,
 385     &bfd_h8300_arch,
 386     &bfd_h8500_arch,
 387     &bfd_hppa_arch,
 388     &bfd_i370_arch,
 389     &bfd_i386_arch,
 390     &bfd_i860_arch,
 391     &bfd_i960_arch,
 392     &bfd_ia64_arch,
 393     &bfd_ip2k_arch,
 394     &bfd_m32r_arch,
 395     &bfd_m68hc11_arch,
 396     &bfd_m68hc12_arch,
 397     &bfd_m68k_arch,
 398     &bfd_m88k_arch,
 399     &bfd_mcore_arch,
 400     &bfd_mips_arch,
 401     &bfd_mmix_arch,
 402     &bfd_mn10200_arch,
 403     &bfd_mn10300_arch,
 404     &bfd_ns32k_arch,
 405     &bfd_openrisc_arch,
 406     &bfd_or32_arch,
 407     &bfd_pdp11_arch,
 408     &bfd_powerpc_arch,
 409     &bfd_rs6000_arch,
 410     &bfd_s390_arch,
 411     &bfd_sh_arch,
 412     &bfd_sparc_arch,
 413     &bfd_tic30_arch,
 414     &bfd_tic54x_arch,
 415     &bfd_tic80_arch,
 416     &bfd_v850_arch,
 417     &bfd_vax_arch,
 418     &bfd_w65_arch,
 419     &bfd_we32k_arch,
 420     &bfd_xstormy16_arch,
 421     &bfd_z8k_arch,
 422 #endif
 423   0
 424 };
 425
 426 /*
 427 FUNCTION
 428         bfd_printable_name
 429
 430 SYNOPSIS
 431         const char *bfd_printable_name(bfd *abfd);
 432
 433 DESCRIPTION
 434         Return a printable string representing the architecture and machine
 435         from the pointer to the architecture info structure.
 436
 437 */
 438
 439 const char *
 440 bfd_printable_name (abfd)
 441      bfd *abfd;
 442 {
 443   return abfd->arch_info->printable_name;
 444 }
 445
 446 /*
 447 FUNCTION
 448         bfd_scan_arch
 449
 450 SYNOPSIS
 451         const bfd_arch_info_type *bfd_scan_arch(const char *string);
 452
 453 DESCRIPTION
 454         Figure out if BFD supports any cpu which could be described with
 455         the name @var{string}.  Return a pointer to an <<arch_info>>
 456         structure if a machine is found, otherwise NULL.
 457 */
 458
 459 const bfd_arch_info_type *
 460 bfd_scan_arch (string)
 461      const char *string;
 462 {
 463   const bfd_arch_info_type * const *app, *ap;
 464
 465   /* Look through all the installed architectures.  */
 466   for (app = bfd_archures_list; *app != NULL; app++)
 467     {
 468       for (ap = *app; ap != NULL; ap = ap->next)
 469         {
 470           if (ap->scan (ap, string))
 471             return ap;
 472         }
 473     }
 474
 475   return NULL;
 476 }
 477
 478 /*
 479 FUNCTION
 480         bfd_arch_list
 481
 482 SYNOPSIS
 483         const char **bfd_arch_list(void);
 484
 485 DESCRIPTION
 486         Return a freshly malloced NULL-terminated vector of the names
 487         of all the valid BFD architectures.  Do not modify the names.
 488 */
 489
 490 const char **
 491 bfd_arch_list ()
 492 {
 493   int vec_length = 0;
 494   const char **name_ptr;
 495   const char **name_list;
 496   const bfd_arch_info_type * const *app;
 497   bfd_size_type amt;
 498
 499   /* Determine the number of architectures.  */
 500   vec_length = 0;
 501   for (app = bfd_archures_list; *app != NULL; app++)
 502     {
 503       const bfd_arch_info_type *ap;
 504       for (ap = *app; ap != NULL; ap = ap->next)
 505         {
 506           vec_length++;
 507         }
 508     }
 509
 510   amt = (vec_length + 1) * sizeof (char **);
 511   name_list = (const char **) bfd_malloc (amt);
 512   if (name_list == NULL)
 513     return NULL;
 514
 515   /* Point the list at each of the names.  */
 516   name_ptr = name_list;
 517   for (app = bfd_archures_list; *app != NULL; app++)
 518     {
 519       const bfd_arch_info_type *ap;
 520       for (ap = *app; ap != NULL; ap = ap->next)
 521         {
 522           *name_ptr = ap->printable_name;
 523           name_ptr++;
 524         }
 525     }
 526   *name_ptr = NULL;
 527
 528   return name_list;
 529 }
 530
 531 /*
 532 FUNCTION
 533         bfd_arch_get_compatible
 534
 535 SYNOPSIS
 536         const bfd_arch_info_type *bfd_arch_get_compatible(
 537                 const bfd *abfd,
 538                 const bfd *bbfd);
 539
 540 DESCRIPTION
 541         Determine whether two BFDs'
 542         architectures and machine types are compatible.  Calculates
 543         the lowest common denominator between the two architectures
 544         and machine types implied by the BFDs and returns a pointer to
 545         an <<arch_info>> structure describing the compatible machine.
 546 */
 547
 548 const bfd_arch_info_type *
 549 bfd_arch_get_compatible (abfd, bbfd)
 550      const bfd *abfd;
 551      const bfd *bbfd;
 552 {
 553   /* If either architecture is unknown, then all we can do is assume
 554      the user knows what he's doing.  */
 555   if (abfd->arch_info->arch == bfd_arch_unknown)
 556     return bbfd->arch_info;
 557   if (bbfd->arch_info->arch == bfd_arch_unknown)
 558     return abfd->arch_info;
 559
 560   /* Otherwise architecture-specific code has to decide.  */
 561   return abfd->arch_info->compatible (abfd->arch_info, bbfd->arch_info);
 562 }
 563
 564 /*
 565 INTERNAL_DEFINITION
 566         bfd_default_arch_struct
 567
 568 DESCRIPTION
 569         The <<bfd_default_arch_struct>> is an item of
 570         <<bfd_arch_info_type>> which has been initialized to a fairly
 571         generic state.  A BFD starts life by pointing to this
 572         structure, until the correct back end has determined the real
 573         architecture of the file.
 574
 575 .extern const bfd_arch_info_type bfd_default_arch_struct;
 576 */
 577
 578 const bfd_arch_info_type bfd_default_arch_struct = {
 579   32, 32, 8, bfd_arch_unknown, 0, "unknown", "unknown", 2, true,
 580   bfd_default_compatible,
 581   bfd_default_scan,
 582   0,
 583 };
 584
 585 /*
 586 FUNCTION
 587         bfd_set_arch_info
 588
 589 SYNOPSIS
 590         void bfd_set_arch_info(bfd *abfd, const bfd_arch_info_type *arg);
 591
 592 DESCRIPTION
 593         Set the architecture info of @var{abfd} to @var{arg}.
 594 */
 595
 596 void
 597 bfd_set_arch_info (abfd, arg)
 598      bfd *abfd;
 599      const bfd_arch_info_type *arg;
 600 {
 601   abfd->arch_info = arg;
 602 }
 603
 604 /*
 605 INTERNAL_FUNCTION
 606         bfd_default_set_arch_mach
 607
 608 SYNOPSIS
 609         boolean bfd_default_set_arch_mach(bfd *abfd,
 610                 enum bfd_architecture arch,
 611                 unsigned long mach);
 612
 613 DESCRIPTION
 614         Set the architecture and machine type in BFD @var{abfd}
 615         to @var{arch} and @var{mach}.  Find the correct
 616         pointer to a structure and insert it into the <<arch_info>>
 617         pointer.
 618 */
 619
 620 boolean
 621 bfd_default_set_arch_mach (abfd, arch, mach)
 622      bfd *abfd;
 623      enum bfd_architecture arch;
 624      unsigned long mach;
 625 {
 626   abfd->arch_info = bfd_lookup_arch (arch, mach);
 627   if (abfd->arch_info != NULL)
 628     return true;
 629
 630   abfd->arch_info = &bfd_default_arch_struct;
 631   bfd_set_error (bfd_error_bad_value);
 632   return false;
 633 }
 634
 635 /*
 636 FUNCTION
 637         bfd_get_arch
 638
 639 SYNOPSIS
 640         enum bfd_architecture bfd_get_arch(bfd *abfd);
 641
 642 DESCRIPTION
 643         Return the enumerated type which describes the BFD @var{abfd}'s
 644         architecture.
 645 */
 646
 647 enum bfd_architecture
 648 bfd_get_arch (abfd)
 649      bfd *abfd;
 650 {
 651   return abfd->arch_info->arch;
 652 }
 653
 654 /*
 655 FUNCTION
 656         bfd_get_mach
 657
 658 SYNOPSIS
 659         unsigned long bfd_get_mach(bfd *abfd);
 660
 661 DESCRIPTION
 662         Return the long type which describes the BFD @var{abfd}'s
 663         machine.
 664 */
 665
 666 unsigned long
 667 bfd_get_mach (abfd)
 668      bfd *abfd;
 669 {
 670   return abfd->arch_info->mach;
 671 }
 672
 673 /*
 674 FUNCTION
 675         bfd_arch_bits_per_byte
 676
 677 SYNOPSIS
 678         unsigned int bfd_arch_bits_per_byte(bfd *abfd);
 679
 680 DESCRIPTION
 681         Return the number of bits in one of the BFD @var{abfd}'s
 682         architecture's bytes.
 683 */
 684
 685 unsigned int
 686 bfd_arch_bits_per_byte (abfd)
 687      bfd *abfd;
 688 {
 689   return abfd->arch_info->bits_per_byte;
 690 }
 691
 692 /*
 693 FUNCTION
 694         bfd_arch_bits_per_address
 695
 696 SYNOPSIS
 697         unsigned int bfd_arch_bits_per_address(bfd *abfd);
 698
 699 DESCRIPTION
 700         Return the number of bits in one of the BFD @var{abfd}'s
 701         architecture's addresses.
 702 */
 703
 704 unsigned int
 705 bfd_arch_bits_per_address (abfd)
 706      bfd *abfd;
 707 {
 708   return abfd->arch_info->bits_per_address;
 709 }
 710
 711 /*
 712 INTERNAL_FUNCTION
 713         bfd_default_compatible
 714
 715 SYNOPSIS
 716         const bfd_arch_info_type *bfd_default_compatible
 717         (const bfd_arch_info_type *a,
 718         const bfd_arch_info_type *b);
 719
 720 DESCRIPTION
 721         The default function for testing for compatibility.
 722 */
 723
 724 const bfd_arch_info_type *
 725 bfd_default_compatible (a, b)
 726      const bfd_arch_info_type *a;
 727      const bfd_arch_info_type *b;
 728 {
 729   if (a->arch != b->arch)
 730     return NULL;
 731
 732   if (a->bits_per_word != b->bits_per_word)
 733     return NULL;
 734
 735   if (a->mach > b->mach)
 736     return a;
 737
 738   if (b->mach > a->mach)
 739     return b;
 740
 741   return a;
 742 }
 743
 744 /*
 745 INTERNAL_FUNCTION
 746         bfd_default_scan
 747
 748 SYNOPSIS
 749         boolean bfd_default_scan(const struct bfd_arch_info *info, const char *string);
 750
 751 DESCRIPTION
 752         The default function for working out whether this is an
 753         architecture hit and a machine hit.
 754 */
 755
 756 boolean
 757 bfd_default_scan (info, string)
 758      const bfd_arch_info_type *info;
 759      const char *string;
 760 {
 761   const char *ptr_src;
 762   const char *ptr_tst;
 763   unsigned long number;
 764   enum bfd_architecture arch;
 765   const char *printable_name_colon;
 766
 767   /* Exact match of the architecture name (ARCH_NAME) and also the
 768      default architecture?  */
 769   if (strcasecmp (string, info->arch_name) == 0
 770       && info->the_default)
 771     return true;
 772
 773   /* Exact match of the machine name (PRINTABLE_NAME)?  */
 774   if (strcasecmp (string, info->printable_name) == 0)
 775     return true;
 776
 777   /* Given that printable_name contains no colon, attempt to match:
 778      ARCH_NAME [ ":" ] PRINTABLE_NAME?  */
 779   printable_name_colon = strchr (info->printable_name, ':');
 780   if (printable_name_colon == NULL)
 781     {
 782       size_t strlen_arch_name = strlen (info->arch_name);
 783       if (strncasecmp (string, info->arch_name, strlen_arch_name) == 0)
 784         {
 785           if (string[strlen_arch_name] == ':')
 786             {
 787               if (strcasecmp (string + strlen_arch_name + 1,
 788                               info->printable_name) == 0)
 789                 return true;
 790             }
 791           else
 792             {
 793               if (strcasecmp (string + strlen_arch_name,
 794                               info->printable_name) == 0)
 795                 return true;
 796             }
 797         }
 798     }
 799
 800   /* Given that PRINTABLE_NAME has the form: <arch> ":" <mach>;
 801      Attempt to match: <arch> <mach>?  */
 802   if (printable_name_colon != NULL)
 803     {
 804       size_t colon_index = printable_name_colon - info->printable_name;
 805       if (strncasecmp (string, info->printable_name, colon_index) == 0
 806           && strcasecmp (string + colon_index,
 807                          info->printable_name + colon_index + 1) == 0)
 808         return true;
 809     }
 810
 811   /* Given that PRINTABLE_NAME has the form: <arch> ":" <mach>; Do not
 812      attempt to match just <mach>, it could be ambigious.  This test
 813      is left until later.  */
 814
 815   /* NOTE: The below is retained for compatibility only.  Please do
 816      not add to this code.  */
 817
 818   /* See how much of the supplied string matches with the
 819      architecture, eg the string m68k:68020 would match the 68k entry
 820      up to the :, then we get left with the machine number.  */
 821
 822   for (ptr_src = string, ptr_tst = info->arch_name;
 823        *ptr_src && *ptr_tst;
 824        ptr_src++, ptr_tst++)
 825     {
 826       if (*ptr_src != *ptr_tst)
 827         break;
 828     }
 829
 830   /* Chewed up as much of the architecture as will match, skip any
 831      colons.  */
 832   if (*ptr_src == ':')
 833     ptr_src++;
 834
 835   if (*ptr_src == 0)
 836     {
 837       /* Nothing more, then only keep this one if it is the default
 838          machine for this architecture.  */
 839       return info->the_default;
 840     }
 841
 842   number = 0;
 843   while (ISDIGIT (*ptr_src))
 844     {
 845       number = number * 10 + *ptr_src - '0';
 846       ptr_src++;
 847     }
 848
 849   /* NOTE: The below is retained for compatibility only.
 850      PLEASE DO NOT ADD TO THIS CODE.  */
 851
 852   switch (number)
 853     {
 854       /* FIXME: These are needed to parse IEEE objects.  */
 855       /* The following seven case's are here only for compatibility with
 856          older binutils (at least IEEE objects from binutils 2.9.1 require
 857          them).  */
 858     case bfd_mach_m68000:
 859     case bfd_mach_m68010:
 860     case bfd_mach_m68020:
 861     case bfd_mach_m68030:
 862     case bfd_mach_m68040:
 863     case bfd_mach_m68060:
 864     case bfd_mach_cpu32:
 865       arch = bfd_arch_m68k;
 866       break;
 867     case 68000:
 868       arch = bfd_arch_m68k;
 869       number = bfd_mach_m68000;
 870       break;
 871     case 68010:
 872       arch = bfd_arch_m68k;
 873       number = bfd_mach_m68010;
 874       break;
 875     case 68020:
 876       arch = bfd_arch_m68k;
 877       number = bfd_mach_m68020;
 878       break;
 879     case 68030:
 880       arch = bfd_arch_m68k;
 881       number = bfd_mach_m68030;
 882       break;
 883     case 68040:
 884       arch = bfd_arch_m68k;
 885       number = bfd_mach_m68040;
 886       break;
 887     case 68060:
 888       arch = bfd_arch_m68k;
 889       number = bfd_mach_m68060;
 890       break;
 891     case 68332:
 892       arch = bfd_arch_m68k;
 893       number = bfd_mach_cpu32;
 894       break;
 895     case 5200:
 896       arch = bfd_arch_m68k;
 897       number = bfd_mach_mcf5200;
 898       break;
 899     case 5206:
 900       arch = bfd_arch_m68k;
 901       number = bfd_mach_mcf5206e;
 902       break;
 903     case 5307:
 904       arch = bfd_arch_m68k;
 905       number = bfd_mach_mcf5307;
 906       break;
 907     case 5407:
 908       arch = bfd_arch_m68k;
 909       number = bfd_mach_mcf5407;
 910       break;
 911
 912     case 32000:
 913       arch = bfd_arch_we32k;
 914       break;
 915
 916     case 3000:
 917       arch = bfd_arch_mips;
 918       number = bfd_mach_mips3000;
 919       break;
 920
 921     case 4000:
 922       arch = bfd_arch_mips;
 923       number = bfd_mach_mips4000;
 924       break;
 925
 926     case 6000:
 927       arch = bfd_arch_rs6000;
 928       break;
 929
 930     case 7410:
 931       arch = bfd_arch_sh;
 932       number = bfd_mach_sh_dsp;
 933       break;
 934
 935     case 7708:
 936       arch = bfd_arch_sh;
 937       number = bfd_mach_sh3;
 938       break;
 939
 940     case 7729:
 941       arch = bfd_arch_sh;
 942       number = bfd_mach_sh3_dsp;
 943       break;
 944
 945     case 7750:
 946       arch = bfd_arch_sh;
 947       number = bfd_mach_sh4;
 948       break;
 949
 950     default:
 951       return false;
 952     }
 953
 954   if (arch != info->arch)
 955     return false;
 956
 957   if (number != info->mach)
 958     return false;
 959
 960   return true;
 961 }
 962
 963 /*
 964 FUNCTION
 965         bfd_get_arch_info
 966
 967 SYNOPSIS
 968         const bfd_arch_info_type * bfd_get_arch_info(bfd *abfd);
 969
 970 DESCRIPTION
 971         Return the architecture info struct in @var{abfd}.
 972 */
 973
 974 const bfd_arch_info_type *
 975 bfd_get_arch_info (abfd)
 976      bfd *abfd;
 977 {
 978   return abfd->arch_info;
 979 }
 980
 981 /*
 982 FUNCTION
 983         bfd_lookup_arch
 984
 985 SYNOPSIS
 986         const bfd_arch_info_type *bfd_lookup_arch
 987                 (enum bfd_architecture
 988                 arch,
 989                 unsigned long machine);
 990
 991 DESCRIPTION
 992         Look for the architecure info structure which matches the
 993         arguments @var{arch} and @var{machine}. A machine of 0 matches the
 994         machine/architecture structure which marks itself as the
 995         default.
 996 */
 997
 998 const bfd_arch_info_type *
 999 bfd_lookup_arch (arch, machine)
1000      enum bfd_architecture arch;
1001      unsigned long machine;
1002 {
1003   const bfd_arch_info_type * const *app, *ap;
1004
1005   for (app = bfd_archures_list; *app != NULL; app++)
1006     {
1007       for (ap = *app; ap != NULL; ap = ap->next)
1008         {
1009           if (ap->arch == arch
1010               && (ap->mach == machine
1011                   || (machine == 0 && ap->the_default)))
1012             return ap;
1013         }
1014     }
1015
1016   return NULL;
1017 }
1018
1019 /*
1020 FUNCTION
1021         bfd_printable_arch_mach
1022
1023 SYNOPSIS
1024         const char *bfd_printable_arch_mach
1025                 (enum bfd_architecture arch, unsigned long machine);
1026
1027 DESCRIPTION
1028         Return a printable string representing the architecture and
1029         machine type.
1030
1031         This routine is depreciated.
1032 */
1033
1034 const char *
1035 bfd_printable_arch_mach (arch, machine)
1036      enum bfd_architecture arch;
1037      unsigned long machine;
1038 {
1039   const bfd_arch_info_type *ap = bfd_lookup_arch (arch, machine);
1040
1041   if (ap)
1042     return ap->printable_name;
1043   return "UNKNOWN!";
1044 }
1045
1046 /*
1047 FUNCTION
1048         bfd_octets_per_byte
1049
1050 SYNOPSIS
1051         unsigned int bfd_octets_per_byte(bfd *abfd);
1052
1053 DESCRIPTION
1054         Return the number of octets (8-bit quantities) per target byte
1055         (minimum addressable unit).  In most cases, this will be one, but some
1056         DSP targets have 16, 32, or even 48 bits per byte.
1057 */
1058
1059 unsigned int
1060 bfd_octets_per_byte (abfd)
1061      bfd *abfd;
1062 {
1063   return bfd_arch_mach_octets_per_byte (bfd_get_arch (abfd),
1064                                         bfd_get_mach (abfd));
1065 }
1066
1067 /*
1068 FUNCTION
1069         bfd_arch_mach_octets_per_byte
1070
1071 SYNOPSIS
1072         unsigned int bfd_arch_mach_octets_per_byte(enum bfd_architecture arch,
1073                                                    unsigned long machine);
1074
1075 DESCRIPTION
1076         See bfd_octets_per_byte.
1077
1078         This routine is provided for those cases where a bfd * is not
1079         available
1080 */
1081
1082 unsigned int
1083 bfd_arch_mach_octets_per_byte (arch, mach)
1084      enum bfd_architecture arch;
1085      unsigned long mach;
1086 {
1087   const bfd_arch_info_type *ap = bfd_lookup_arch (arch, mach);
1088
1089   if (ap)
1090     return ap->bits_per_byte / 8;
1091   return 1;
1092 }