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