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_ppc_403       403
 169 .#define bfd_mach_ppc_403gc     4030
 170 .#define bfd_mach_ppc_505       505
 171 .#define bfd_mach_ppc_601       601
 172 .#define bfd_mach_ppc_602       602
 173 .#define bfd_mach_ppc_603       603
 174 .#define bfd_mach_ppc_ec603e    6031
 175 .#define bfd_mach_ppc_604       604
 176 .#define bfd_mach_ppc_620       620
 177 .#define bfd_mach_ppc_630       630
 178 .#define bfd_mach_ppc_750       750
 179 .#define bfd_mach_ppc_860       860
 180 .#define bfd_mach_ppc_a35       35
 181 .#define bfd_mach_ppc_rs64ii    642
 182 .#define bfd_mach_ppc_rs64iii   643
 183 .#define bfd_mach_ppc_7400      7400
 184 .  bfd_arch_rs6000,    {* IBM RS/6000 *}
 185 .#define bfd_mach_rs6k          0
 186 .#define bfd_mach_rs6k_rs1      6001
 187 .#define bfd_mach_rs6k_rsc      6003
 188 .#define bfd_mach_rs6k_rs2      6002
 189 .  bfd_arch_hppa,      {* HP PA RISC *}
 190 .  bfd_arch_d10v,      {* Mitsubishi D10V *}
 191 .#define bfd_mach_d10v          0
 192 .#define bfd_mach_d10v_ts2      2
 193 .#define bfd_mach_d10v_ts3      3
 194 .  bfd_arch_d30v,      {* Mitsubishi D30V *}
 195 .  bfd_arch_m68hc11,   {* Motorola 68HC11 *}
 196 .  bfd_arch_m68hc12,   {* Motorola 68HC12 *}
 197 .  bfd_arch_z8k,       {* Zilog Z8000 *}
 198 .#define bfd_mach_z8001         1
 199 .#define bfd_mach_z8002         2
 200 .  bfd_arch_h8500,     {* Hitachi H8/500 *}
 201 .  bfd_arch_sh,        {* Hitachi SH *}
 202 .#define bfd_mach_sh            0
 203 .#define bfd_mach_sh2        0x20
 204 .#define bfd_mach_sh_dsp     0x2d
 205 .#define bfd_mach_sh3        0x30
 206 .#define bfd_mach_sh3_dsp    0x3d
 207 .#define bfd_mach_sh3e       0x3e
 208 .#define bfd_mach_sh4        0x40
 209 .  bfd_arch_alpha,     {* Dec Alpha *}
 210 .#define bfd_mach_alpha_ev4  0x10
 211 .#define bfd_mach_alpha_ev5  0x20
 212 .#define bfd_mach_alpha_ev6  0x30
 213 .  bfd_arch_arm,       {* Advanced Risc Machines ARM.  *}
 214 .#define bfd_mach_arm_2         1
 215 .#define bfd_mach_arm_2a        2
 216 .#define bfd_mach_arm_3         3
 217 .#define bfd_mach_arm_3M        4
 218 .#define bfd_mach_arm_4         5
 219 .#define bfd_mach_arm_4T        6
 220 .#define bfd_mach_arm_5         7
 221 .#define bfd_mach_arm_5T        8
 222 .#define bfd_mach_arm_5TE       9
 223 .#define bfd_mach_arm_XScale    10
 224 .  bfd_arch_ns32k,     {* National Semiconductors ns32000 *}
 225 .  bfd_arch_w65,       {* WDC 65816 *}
 226 .  bfd_arch_tic30,     {* Texas Instruments TMS320C30 *}
 227 .  bfd_arch_tic54x,    {* Texas Instruments TMS320C54X *}
 228 .  bfd_arch_tic80,     {* TI TMS320c80 (MVP) *}
 229 .  bfd_arch_v850,      {* NEC V850 *}
 230 .#define bfd_mach_v850          0
 231 .#define bfd_mach_v850e         'E'
 232 .#define bfd_mach_v850ea        'A'
 233 .  bfd_arch_arc,       {* ARC Cores *}
 234 .#define bfd_mach_arc_5         0
 235 .#define bfd_mach_arc_6         1
 236 .#define bfd_mach_arc_7         2
 237 .#define bfd_mach_arc_8         3
 238 .  bfd_arch_m32r,      {* Mitsubishi M32R/D *}
 239 .#define bfd_mach_m32r          0 {* For backwards compatibility.  *}
 240 .#define bfd_mach_m32rx         'x'
 241 .  bfd_arch_mn10200,   {* Matsushita MN10200 *}
 242 .  bfd_arch_mn10300,   {* Matsushita MN10300 *}
 243 .#define bfd_mach_mn10300               300
 244 .#define bfd_mach_am33          330
 245 .  bfd_arch_fr30,
 246 .#define bfd_mach_fr30          0x46523330
 247 .  bfd_arch_mcore,
 248 .  bfd_arch_ia64,      {* HP/Intel ia64 *}
 249 .#define bfd_mach_ia64_elf64    0
 250 .#define bfd_mach_ia64_elf32    1
 251 .  bfd_arch_pj,
 252 .  bfd_arch_avr,       {* Atmel AVR microcontrollers.  *}
 253 .#define bfd_mach_avr1          1
 254 .#define bfd_mach_avr2          2
 255 .#define bfd_mach_avr3          3
 256 .#define bfd_mach_avr4          4
 257 .#define bfd_mach_avr5          5
 258 .  bfd_arch_cris,      {* Axis CRIS *}
 259 .  bfd_arch_s390,      {* IBM s390 *}
 260 .#define bfd_mach_s390_esa      0
 261 .#define bfd_mach_s390_esame    1
 262 .  bfd_arch_openrisc,  {* OpenRISC *}
 263 .  bfd_arch_mmix,      {* Donald Knuth's educational processor.  *}
 264 .  bfd_arch_xstormy16,
 265 .#define bfd_mach_xstormy16     0
 266 .  bfd_arch_last
 267 .  };
 268 */
 269
 270 /*
 271 SUBSECTION
 272         bfd_arch_info
 273
 274 DESCRIPTION
 275         This structure contains information on architectures for use
 276         within BFD.
 277
 278 .
 279 .typedef struct bfd_arch_info
 280 .{
 281 .  int bits_per_word;
 282 .  int bits_per_address;
 283 .  int bits_per_byte;
 284 .  enum bfd_architecture arch;
 285 .  unsigned long mach;
 286 .  const char *arch_name;
 287 .  const char *printable_name;
 288 .  unsigned int section_align_power;
 289 .  {* True if this is the default machine for the architecture.  *}
 290 .  boolean the_default;
 291 .  const struct bfd_arch_info * (*compatible)
 292 .       PARAMS ((const struct bfd_arch_info *a,
 293 .                const struct bfd_arch_info *b));
 294 .
 295 .  boolean (*scan) PARAMS ((const struct bfd_arch_info *, const char *));
 296 .
 297 .  const struct bfd_arch_info *next;
 298 .}
 299 .bfd_arch_info_type;
 300 .
 301 */
 302
 303 extern const bfd_arch_info_type bfd_a29k_arch;
 304 extern const bfd_arch_info_type bfd_alpha_arch;
 305 extern const bfd_arch_info_type bfd_arc_arch;
 306 extern const bfd_arch_info_type bfd_arm_arch;
 307 extern const bfd_arch_info_type bfd_avr_arch;
 308 extern const bfd_arch_info_type bfd_cris_arch;
 309 extern const bfd_arch_info_type bfd_d10v_arch;
 310 extern const bfd_arch_info_type bfd_d30v_arch;
 311 extern const bfd_arch_info_type bfd_fr30_arch;
 312 extern const bfd_arch_info_type bfd_h8300_arch;
 313 extern const bfd_arch_info_type bfd_h8500_arch;
 314 extern const bfd_arch_info_type bfd_hppa_arch;
 315 extern const bfd_arch_info_type bfd_i370_arch;
 316 extern const bfd_arch_info_type bfd_i386_arch;
 317 extern const bfd_arch_info_type bfd_i860_arch;
 318 extern const bfd_arch_info_type bfd_i960_arch;
 319 extern const bfd_arch_info_type bfd_ia64_arch;
 320 extern const bfd_arch_info_type bfd_m32r_arch;
 321 extern const bfd_arch_info_type bfd_m68hc11_arch;
 322 extern const bfd_arch_info_type bfd_m68hc12_arch;
 323 extern const bfd_arch_info_type bfd_m68k_arch;
 324 extern const bfd_arch_info_type bfd_m88k_arch;
 325 extern const bfd_arch_info_type bfd_mcore_arch;
 326 extern const bfd_arch_info_type bfd_mips_arch;
 327 extern const bfd_arch_info_type bfd_mmix_arch;
 328 extern const bfd_arch_info_type bfd_mn10200_arch;
 329 extern const bfd_arch_info_type bfd_mn10300_arch;
 330 extern const bfd_arch_info_type bfd_ns32k_arch;
 331 extern const bfd_arch_info_type bfd_openrisc_arch;
 332 extern const bfd_arch_info_type bfd_or32_arch;
 333 extern const bfd_arch_info_type bfd_pdp11_arch;
 334 extern const bfd_arch_info_type bfd_pj_arch;
 335 extern const bfd_arch_info_type bfd_powerpc_arch;
 336 extern const bfd_arch_info_type bfd_rs6000_arch;
 337 extern const bfd_arch_info_type bfd_s390_arch;
 338 extern const bfd_arch_info_type bfd_sh_arch;
 339 extern const bfd_arch_info_type bfd_sparc_arch;
 340 extern const bfd_arch_info_type bfd_tic30_arch;
 341 extern const bfd_arch_info_type bfd_tic54x_arch;
 342 extern const bfd_arch_info_type bfd_tic80_arch;
 343 extern const bfd_arch_info_type bfd_v850_arch;
 344 extern const bfd_arch_info_type bfd_vax_arch;
 345 extern const bfd_arch_info_type bfd_we32k_arch;
 346 extern const bfd_arch_info_type bfd_w65_arch;
 347 extern const bfd_arch_info_type bfd_xstormy16_arch;
 348 extern const bfd_arch_info_type bfd_z8k_arch;
 349
 350 static const bfd_arch_info_type * const bfd_archures_list[] =
 351   {
 352 #ifdef SELECT_ARCHITECTURES
 353     SELECT_ARCHITECTURES,
 354 #else
 355     &bfd_a29k_arch,
 356     &bfd_alpha_arch,
 357     &bfd_arc_arch,
 358     &bfd_arm_arch,
 359     &bfd_avr_arch,
 360     &bfd_cris_arch,
 361     &bfd_d10v_arch,
 362     &bfd_d30v_arch,
 363     &bfd_fr30_arch,
 364     &bfd_h8300_arch,
 365     &bfd_h8500_arch,
 366     &bfd_hppa_arch,
 367     &bfd_i370_arch,
 368     &bfd_i386_arch,
 369     &bfd_i860_arch,
 370     &bfd_i960_arch,
 371     &bfd_ia64_arch,
 372     &bfd_m32r_arch,
 373     &bfd_m68hc11_arch,
 374     &bfd_m68hc12_arch,
 375     &bfd_m68k_arch,
 376     &bfd_m88k_arch,
 377     &bfd_mcore_arch,
 378     &bfd_mips_arch,
 379     &bfd_mmix_arch,
 380     &bfd_mn10200_arch,
 381     &bfd_mn10300_arch,
 382     &bfd_ns32k_arch,
 383     &bfd_openrisc_arch,
 384     &bfd_or32_arch,
 385     &bfd_pdp11_arch,
 386     &bfd_powerpc_arch,
 387     &bfd_rs6000_arch,
 388     &bfd_s390_arch,
 389     &bfd_sh_arch,
 390     &bfd_sparc_arch,
 391     &bfd_tic30_arch,
 392     &bfd_tic54x_arch,
 393     &bfd_tic80_arch,
 394     &bfd_v850_arch,
 395     &bfd_vax_arch,
 396     &bfd_w65_arch,
 397     &bfd_we32k_arch,
 398     &bfd_xstormy16_arch,
 399     &bfd_z8k_arch,
 400 #endif
 401   0
 402 };
 403
 404 /*
 405 FUNCTION
 406         bfd_printable_name
 407
 408 SYNOPSIS
 409         const char *bfd_printable_name(bfd *abfd);
 410
 411 DESCRIPTION
 412         Return a printable string representing the architecture and machine
 413         from the pointer to the architecture info structure.
 414
 415 */
 416
 417 const char *
 418 bfd_printable_name (abfd)
 419      bfd *abfd;
 420 {
 421   return abfd->arch_info->printable_name;
 422 }
 423
 424 /*
 425 FUNCTION
 426         bfd_scan_arch
 427
 428 SYNOPSIS
 429         const bfd_arch_info_type *bfd_scan_arch(const char *string);
 430
 431 DESCRIPTION
 432         Figure out if BFD supports any cpu which could be described with
 433         the name @var{string}.  Return a pointer to an <<arch_info>>
 434         structure if a machine is found, otherwise NULL.
 435 */
 436
 437 const bfd_arch_info_type *
 438 bfd_scan_arch (string)
 439      const char *string;
 440 {
 441   const bfd_arch_info_type * const *app, *ap;
 442
 443   /* Look through all the installed architectures.  */
 444   for (app = bfd_archures_list; *app != NULL; app++)
 445     {
 446       for (ap = *app; ap != NULL; ap = ap->next)
 447         {
 448           if (ap->scan (ap, string))
 449             return ap;
 450         }
 451     }
 452
 453   return NULL;
 454 }
 455
 456 /*
 457 FUNCTION
 458         bfd_arch_list
 459
 460 SYNOPSIS
 461         const char **bfd_arch_list(void);
 462
 463 DESCRIPTION
 464         Return a freshly malloced NULL-terminated vector of the names
 465         of all the valid BFD architectures.  Do not modify the names.
 466 */
 467
 468 const char **
 469 bfd_arch_list ()
 470 {
 471   int vec_length = 0;
 472   const char **name_ptr;
 473   const char **name_list;
 474   const bfd_arch_info_type * const *app;
 475   bfd_size_type amt;
 476
 477   /* Determine the number of architectures.  */
 478   vec_length = 0;
 479   for (app = bfd_archures_list; *app != NULL; app++)
 480     {
 481       const bfd_arch_info_type *ap;
 482       for (ap = *app; ap != NULL; ap = ap->next)
 483         {
 484           vec_length++;
 485         }
 486     }
 487
 488   amt = (vec_length + 1) * sizeof (char **);
 489   name_list = (const char **) bfd_malloc (amt);
 490   if (name_list == NULL)
 491     return NULL;
 492
 493   /* Point the list at each of the names.  */
 494   name_ptr = name_list;
 495   for (app = bfd_archures_list; *app != NULL; app++)
 496     {
 497       const bfd_arch_info_type *ap;
 498       for (ap = *app; ap != NULL; ap = ap->next)
 499         {
 500           *name_ptr = ap->printable_name;
 501           name_ptr++;
 502         }
 503     }
 504   *name_ptr = NULL;
 505
 506   return name_list;
 507 }
 508
 509 /*
 510 FUNCTION
 511         bfd_arch_get_compatible
 512
 513 SYNOPSIS
 514         const bfd_arch_info_type *bfd_arch_get_compatible(
 515                 const bfd *abfd,
 516                 const bfd *bbfd);
 517
 518 DESCRIPTION
 519         Determine whether two BFDs'
 520         architectures and machine types are compatible.  Calculates
 521         the lowest common denominator between the two architectures
 522         and machine types implied by the BFDs and returns a pointer to
 523         an <<arch_info>> structure describing the compatible machine.
 524 */
 525
 526 const bfd_arch_info_type *
 527 bfd_arch_get_compatible (abfd, bbfd)
 528      const bfd *abfd;
 529      const bfd *bbfd;
 530 {
 531   /* If either architecture is unknown, then all we can do is assume
 532      the user knows what he's doing.  */
 533   if (abfd->arch_info->arch == bfd_arch_unknown)
 534     return bbfd->arch_info;
 535   if (bbfd->arch_info->arch == bfd_arch_unknown)
 536     return abfd->arch_info;
 537
 538   /* Otherwise architecture-specific code has to decide.  */
 539   return abfd->arch_info->compatible (abfd->arch_info, bbfd->arch_info);
 540 }
 541
 542 /*
 543 INTERNAL_DEFINITION
 544         bfd_default_arch_struct
 545
 546 DESCRIPTION
 547         The <<bfd_default_arch_struct>> is an item of
 548         <<bfd_arch_info_type>> which has been initialized to a fairly
 549         generic state.  A BFD starts life by pointing to this
 550         structure, until the correct back end has determined the real
 551         architecture of the file.
 552
 553 .extern const bfd_arch_info_type bfd_default_arch_struct;
 554 */
 555
 556 const bfd_arch_info_type bfd_default_arch_struct = {
 557   32, 32, 8, bfd_arch_unknown, 0, "unknown", "unknown", 2, true,
 558   bfd_default_compatible,
 559   bfd_default_scan,
 560   0,
 561 };
 562
 563 /*
 564 FUNCTION
 565         bfd_set_arch_info
 566
 567 SYNOPSIS
 568         void bfd_set_arch_info(bfd *abfd, const bfd_arch_info_type *arg);
 569
 570 DESCRIPTION
 571         Set the architecture info of @var{abfd} to @var{arg}.
 572 */
 573
 574 void
 575 bfd_set_arch_info (abfd, arg)
 576      bfd *abfd;
 577      const bfd_arch_info_type *arg;
 578 {
 579   abfd->arch_info = arg;
 580 }
 581
 582 /*
 583 INTERNAL_FUNCTION
 584         bfd_default_set_arch_mach
 585
 586 SYNOPSIS
 587         boolean bfd_default_set_arch_mach(bfd *abfd,
 588                 enum bfd_architecture arch,
 589                 unsigned long mach);
 590
 591 DESCRIPTION
 592         Set the architecture and machine type in BFD @var{abfd}
 593         to @var{arch} and @var{mach}.  Find the correct
 594         pointer to a structure and insert it into the <<arch_info>>
 595         pointer.
 596 */
 597
 598 boolean
 599 bfd_default_set_arch_mach (abfd, arch, mach)
 600      bfd *abfd;
 601      enum bfd_architecture arch;
 602      unsigned long mach;
 603 {
 604   const bfd_arch_info_type * const *app, *ap;
 605
 606   for (app = bfd_archures_list; *app != NULL; app++)
 607     {
 608       for (ap = *app; ap != NULL; ap = ap->next)
 609         {
 610           if (ap->arch == arch
 611               && (ap->mach == mach
 612                   || (mach == 0 && ap->the_default)))
 613             {
 614               abfd->arch_info = ap;
 615               return true;
 616             }
 617         }
 618     }
 619
 620   abfd->arch_info = &bfd_default_arch_struct;
 621   bfd_set_error (bfd_error_bad_value);
 622   return false;
 623 }
 624
 625 /*
 626 FUNCTION
 627         bfd_get_arch
 628
 629 SYNOPSIS
 630         enum bfd_architecture bfd_get_arch(bfd *abfd);
 631
 632 DESCRIPTION
 633         Return the enumerated type which describes the BFD @var{abfd}'s
 634         architecture.
 635 */
 636
 637 enum bfd_architecture
 638 bfd_get_arch (abfd)
 639      bfd *abfd;
 640 {
 641   return abfd->arch_info->arch;
 642 }
 643
 644 /*
 645 FUNCTION
 646         bfd_get_mach
 647
 648 SYNOPSIS
 649         unsigned long bfd_get_mach(bfd *abfd);
 650
 651 DESCRIPTION
 652         Return the long type which describes the BFD @var{abfd}'s
 653         machine.
 654 */
 655
 656 unsigned long
 657 bfd_get_mach (abfd)
 658      bfd *abfd;
 659 {
 660   return abfd->arch_info->mach;
 661 }
 662
 663 /*
 664 FUNCTION
 665         bfd_arch_bits_per_byte
 666
 667 SYNOPSIS
 668         unsigned int bfd_arch_bits_per_byte(bfd *abfd);
 669
 670 DESCRIPTION
 671         Return the number of bits in one of the BFD @var{abfd}'s
 672         architecture's bytes.
 673 */
 674
 675 unsigned int
 676 bfd_arch_bits_per_byte (abfd)
 677      bfd *abfd;
 678 {
 679   return abfd->arch_info->bits_per_byte;
 680 }
 681
 682 /*
 683 FUNCTION
 684         bfd_arch_bits_per_address
 685
 686 SYNOPSIS
 687         unsigned int bfd_arch_bits_per_address(bfd *abfd);
 688
 689 DESCRIPTION
 690         Return the number of bits in one of the BFD @var{abfd}'s
 691         architecture's addresses.
 692 */
 693
 694 unsigned int
 695 bfd_arch_bits_per_address (abfd)
 696      bfd *abfd;
 697 {
 698   return abfd->arch_info->bits_per_address;
 699 }
 700
 701 /*
 702 INTERNAL_FUNCTION
 703         bfd_default_compatible
 704
 705 SYNOPSIS
 706         const bfd_arch_info_type *bfd_default_compatible
 707         (const bfd_arch_info_type *a,
 708         const bfd_arch_info_type *b);
 709
 710 DESCRIPTION
 711         The default function for testing for compatibility.
 712 */
 713
 714 const bfd_arch_info_type *
 715 bfd_default_compatible (a, b)
 716      const bfd_arch_info_type *a;
 717      const bfd_arch_info_type *b;
 718 {
 719   if (a->arch != b->arch)
 720     return NULL;
 721
 722   if (a->mach > b->mach)
 723     return a;
 724
 725   if (b->mach > a->mach)
 726     return b;
 727
 728   return a;
 729 }
 730
 731 /*
 732 INTERNAL_FUNCTION
 733         bfd_default_scan
 734
 735 SYNOPSIS
 736         boolean bfd_default_scan(const struct bfd_arch_info *info, const char *string);
 737
 738 DESCRIPTION
 739         The default function for working out whether this is an
 740         architecture hit and a machine hit.
 741 */
 742
 743 boolean
 744 bfd_default_scan (info, string)
 745      const bfd_arch_info_type *info;
 746      const char *string;
 747 {
 748   const char *ptr_src;
 749   const char *ptr_tst;
 750   unsigned long number;
 751   enum bfd_architecture arch;
 752   const char *printable_name_colon;
 753
 754   /* Exact match of the architecture name (ARCH_NAME) and also the
 755      default architecture?  */
 756   if (strcasecmp (string, info->arch_name) == 0
 757       && info->the_default)
 758     return true;
 759
 760   /* Exact match of the machine name (PRINTABLE_NAME)?  */
 761   if (strcasecmp (string, info->printable_name) == 0)
 762     return true;
 763
 764   /* Given that printable_name contains no colon, attempt to match:
 765      ARCH_NAME [ ":" ] PRINTABLE_NAME?  */
 766   printable_name_colon = strchr (info->printable_name, ':');
 767   if (printable_name_colon == NULL)
 768     {
 769       size_t strlen_arch_name = strlen (info->arch_name);
 770       if (strncasecmp (string, info->arch_name, strlen_arch_name) == 0)
 771         {
 772           if (string[strlen_arch_name] == ':')
 773             {
 774               if (strcasecmp (string + strlen_arch_name + 1,
 775                               info->printable_name) == 0)
 776                 return true;
 777             }
 778           else
 779             {
 780               if (strcasecmp (string + strlen_arch_name,
 781                               info->printable_name) == 0)
 782                 return true;
 783             }
 784         }
 785     }
 786
 787   /* Given that PRINTABLE_NAME has the form: <arch> ":" <mach>;
 788      Attempt to match: <arch> <mach>?  */
 789   if (printable_name_colon != NULL)
 790     {
 791       size_t colon_index = printable_name_colon - info->printable_name;
 792       if (strncasecmp (string, info->printable_name, colon_index) == 0
 793           && strcasecmp (string + colon_index,
 794                          info->printable_name + colon_index + 1) == 0)
 795         return true;
 796     }
 797
 798   /* Given that PRINTABLE_NAME has the form: <arch> ":" <mach>; Do not
 799      attempt to match just <mach>, it could be ambigious.  This test
 800      is left until later.  */
 801
 802   /* NOTE: The below is retained for compatibility only.  Please do
 803      not add to this code.  */
 804
 805   /* See how much of the supplied string matches with the
 806      architecture, eg the string m68k:68020 would match the 68k entry
 807      up to the :, then we get left with the machine number.  */
 808
 809   for (ptr_src = string, ptr_tst = info->arch_name;
 810        *ptr_src && *ptr_tst;
 811        ptr_src++, ptr_tst++)
 812     {
 813       if (*ptr_src != *ptr_tst)
 814         break;
 815     }
 816
 817   /* Chewed up as much of the architecture as will match, skip any
 818      colons.  */
 819   if (*ptr_src == ':')
 820     ptr_src++;
 821
 822   if (*ptr_src == 0)
 823     {
 824       /* Nothing more, then only keep this one if it is the default
 825          machine for this architecture.  */
 826       return info->the_default;
 827     }
 828
 829   number = 0;
 830   while (ISDIGIT (*ptr_src))
 831     {
 832       number = number * 10 + *ptr_src - '0';
 833       ptr_src++;
 834     }
 835
 836   /* NOTE: The below is retained for compatibility only.
 837      PLEASE DO NOT ADD TO THIS CODE.  */
 838
 839   switch (number)
 840     {
 841       /* FIXME: These are needed to parse IEEE objects.  */
 842       /* The following seven case's are here only for compatibility with
 843          older binutils (at least IEEE objects from binutils 2.9.1 require
 844          them).  */
 845     case bfd_mach_m68000:
 846     case bfd_mach_m68010:
 847     case bfd_mach_m68020:
 848     case bfd_mach_m68030:
 849     case bfd_mach_m68040:
 850     case bfd_mach_m68060:
 851     case bfd_mach_cpu32:
 852       arch = bfd_arch_m68k;
 853       break;
 854     case 68000:
 855       arch = bfd_arch_m68k;
 856       number = bfd_mach_m68000;
 857       break;
 858     case 68010:
 859       arch = bfd_arch_m68k;
 860       number = bfd_mach_m68010;
 861       break;
 862     case 68020:
 863       arch = bfd_arch_m68k;
 864       number = bfd_mach_m68020;
 865       break;
 866     case 68030:
 867       arch = bfd_arch_m68k;
 868       number = bfd_mach_m68030;
 869       break;
 870     case 68040:
 871       arch = bfd_arch_m68k;
 872       number = bfd_mach_m68040;
 873       break;
 874     case 68060:
 875       arch = bfd_arch_m68k;
 876       number = bfd_mach_m68060;
 877       break;
 878     case 68332:
 879       arch = bfd_arch_m68k;
 880       number = bfd_mach_cpu32;
 881       break;
 882     case 5200:
 883       arch = bfd_arch_m68k;
 884       number = bfd_mach_mcf5200;
 885       break;
 886     case 5206:
 887       arch = bfd_arch_m68k;
 888       number = bfd_mach_mcf5206e;
 889       break;
 890     case 5307:
 891       arch = bfd_arch_m68k;
 892       number = bfd_mach_mcf5307;
 893       break;
 894     case 5407:
 895       arch = bfd_arch_m68k;
 896       number = bfd_mach_mcf5407;
 897       break;
 898
 899     case 32000:
 900       arch = bfd_arch_we32k;
 901       break;
 902
 903     case 3000:
 904       arch = bfd_arch_mips;
 905       number = bfd_mach_mips3000;
 906       break;
 907
 908     case 4000:
 909       arch = bfd_arch_mips;
 910       number = bfd_mach_mips4000;
 911       break;
 912
 913     case 6000:
 914       arch = bfd_arch_rs6000;
 915       break;
 916
 917     case 7410:
 918       arch = bfd_arch_sh;
 919       number = bfd_mach_sh_dsp;
 920       break;
 921
 922     case 7708:
 923       arch = bfd_arch_sh;
 924       number = bfd_mach_sh3;
 925       break;
 926
 927     case 7729:
 928       arch = bfd_arch_sh;
 929       number = bfd_mach_sh3_dsp;
 930       break;
 931
 932     case 7750:
 933       arch = bfd_arch_sh;
 934       number = bfd_mach_sh4;
 935       break;
 936
 937     default:
 938       return false;
 939     }
 940
 941   if (arch != info->arch)
 942     return false;
 943
 944   if (number != info->mach)
 945     return false;
 946
 947   return true;
 948 }
 949
 950 /*
 951 FUNCTION
 952         bfd_get_arch_info
 953
 954 SYNOPSIS
 955         const bfd_arch_info_type * bfd_get_arch_info(bfd *abfd);
 956
 957 DESCRIPTION
 958         Return the architecture info struct in @var{abfd}.
 959 */
 960
 961 const bfd_arch_info_type *
 962 bfd_get_arch_info (abfd)
 963      bfd *abfd;
 964 {
 965   return abfd->arch_info;
 966 }
 967
 968 /*
 969 FUNCTION
 970         bfd_lookup_arch
 971
 972 SYNOPSIS
 973         const bfd_arch_info_type *bfd_lookup_arch
 974                 (enum bfd_architecture
 975                 arch,
 976                 unsigned long machine);
 977
 978 DESCRIPTION
 979         Look for the architecure info structure which matches the
 980         arguments @var{arch} and @var{machine}. A machine of 0 matches the
 981         machine/architecture structure which marks itself as the
 982         default.
 983 */
 984
 985 const bfd_arch_info_type *
 986 bfd_lookup_arch (arch, machine)
 987      enum bfd_architecture arch;
 988      unsigned long machine;
 989 {
 990   const bfd_arch_info_type * const *app, *ap;
 991
 992   for (app = bfd_archures_list; *app != NULL; app++)
 993     {
 994       for (ap = *app; ap != NULL; ap = ap->next)
 995         {
 996           if (ap->arch == arch
 997               && (ap->mach == machine
 998                   || (machine == 0 && ap->the_default)))
 999             return ap;
1000         }
1001     }
1002
1003   return NULL;
1004 }
1005
1006 /*
1007 FUNCTION
1008         bfd_printable_arch_mach
1009
1010 SYNOPSIS
1011         const char *bfd_printable_arch_mach
1012                 (enum bfd_architecture arch, unsigned long machine);
1013
1014 DESCRIPTION
1015         Return a printable string representing the architecture and
1016         machine type.
1017
1018         This routine is depreciated.
1019 */
1020
1021 const char *
1022 bfd_printable_arch_mach (arch, machine)
1023      enum bfd_architecture arch;
1024      unsigned long machine;
1025 {
1026   const bfd_arch_info_type *ap = bfd_lookup_arch (arch, machine);
1027
1028   if (ap)
1029     return ap->printable_name;
1030   return "UNKNOWN!";
1031 }
1032
1033 /*
1034 FUNCTION
1035         bfd_octets_per_byte
1036
1037 SYNOPSIS
1038         unsigned int bfd_octets_per_byte(bfd *abfd);
1039
1040 DESCRIPTION
1041         Return the number of octets (8-bit quantities) per target byte
1042         (minimum addressable unit).  In most cases, this will be one, but some
1043         DSP targets have 16, 32, or even 48 bits per byte.
1044 */
1045
1046 unsigned int
1047 bfd_octets_per_byte (abfd)
1048      bfd *abfd;
1049 {
1050   return bfd_arch_mach_octets_per_byte (bfd_get_arch (abfd),
1051                                         bfd_get_mach (abfd));
1052 }
1053
1054 /*
1055 FUNCTION
1056         bfd_arch_mach_octets_per_byte
1057
1058 SYNOPSIS
1059         unsigned int bfd_arch_mach_octets_per_byte(enum bfd_architecture arch,
1060                                                    unsigned long machine);
1061
1062 DESCRIPTION
1063         See bfd_octets_per_byte.
1064
1065         This routine is provided for those cases where a bfd * is not
1066         available
1067 */
1068
1069 unsigned int
1070 bfd_arch_mach_octets_per_byte (arch, mach)
1071      enum bfd_architecture arch;
1072      unsigned long mach;
1073 {
1074   const bfd_arch_info_type *ap = bfd_lookup_arch (arch, mach);
1075
1076   if (ap)
1077     return ap->bits_per_byte / 8;
1078   return 1;
1079 }