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