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