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