Imported Upstream version 7.8
[platform/upstream/gdb.git] / bfd / doc / archures.texi
1 @section Architectures
2 BFD keeps one atom in a BFD describing the
3 architecture of the data attached to the BFD: a pointer to a
4 @code{bfd_arch_info_type}.
5
6 Pointers to structures can be requested independently of a BFD
7 so that an architecture's information can be interrogated
8 without access to an open BFD.
9
10 The architecture information is provided by each architecture package.
11 The set of default architectures is selected by the macro
12 @code{SELECT_ARCHITECTURES}.  This is normally set up in the
13 @file{config/@var{target}.mt} file of your choice.  If the name is not
14 defined, then all the architectures supported are included.
15
16 When BFD starts up, all the architectures are called with an
17 initialize method.  It is up to the architecture back end to
18 insert as many items into the list of architectures as it wants to;
19 generally this would be one for each machine and one for the
20 default case (an item with a machine field of 0).
21
22 BFD's idea of an architecture is implemented in @file{archures.c}.
23
24 @subsection bfd_architecture
25
26
27 @strong{Description}@*
28 This enum gives the object file's CPU architecture, in a
29 global sense---i.e., what processor family does it belong to?
30 Another field indicates which processor within
31 the family is in use.  The machine gives a number which
32 distinguishes different versions of the architecture,
33 containing, for example, 2 and 3 for Intel i960 KA and i960 KB,
34 and 68020 and 68030 for Motorola 68020 and 68030.
35 @example
36 enum bfd_architecture
37 @{
38   bfd_arch_unknown,   /* File arch not known.  */
39   bfd_arch_obscure,   /* Arch known, not one of these.  */
40   bfd_arch_m68k,      /* Motorola 68xxx */
41 #define bfd_mach_m68000 1
42 #define bfd_mach_m68008 2
43 #define bfd_mach_m68010 3
44 #define bfd_mach_m68020 4
45 #define bfd_mach_m68030 5
46 #define bfd_mach_m68040 6
47 #define bfd_mach_m68060 7
48 #define bfd_mach_cpu32  8
49 #define bfd_mach_fido   9
50 #define bfd_mach_mcf_isa_a_nodiv 10
51 #define bfd_mach_mcf_isa_a 11
52 #define bfd_mach_mcf_isa_a_mac 12
53 #define bfd_mach_mcf_isa_a_emac 13
54 #define bfd_mach_mcf_isa_aplus 14
55 #define bfd_mach_mcf_isa_aplus_mac 15
56 #define bfd_mach_mcf_isa_aplus_emac 16
57 #define bfd_mach_mcf_isa_b_nousp 17
58 #define bfd_mach_mcf_isa_b_nousp_mac 18
59 #define bfd_mach_mcf_isa_b_nousp_emac 19
60 #define bfd_mach_mcf_isa_b 20
61 #define bfd_mach_mcf_isa_b_mac 21
62 #define bfd_mach_mcf_isa_b_emac 22
63 #define bfd_mach_mcf_isa_b_float 23
64 #define bfd_mach_mcf_isa_b_float_mac 24
65 #define bfd_mach_mcf_isa_b_float_emac 25
66 #define bfd_mach_mcf_isa_c 26
67 #define bfd_mach_mcf_isa_c_mac 27
68 #define bfd_mach_mcf_isa_c_emac 28
69 #define bfd_mach_mcf_isa_c_nodiv 29
70 #define bfd_mach_mcf_isa_c_nodiv_mac 30
71 #define bfd_mach_mcf_isa_c_nodiv_emac 31
72   bfd_arch_vax,       /* DEC Vax */
73   bfd_arch_i960,      /* Intel 960 */
74     /* The order of the following is important.
75        lower number indicates a machine type that
76        only accepts a subset of the instructions
77        available to machines with higher numbers.
78        The exception is the "ca", which is
79        incompatible with all other machines except
80        "core".  */
81
82 #define bfd_mach_i960_core      1
83 #define bfd_mach_i960_ka_sa     2
84 #define bfd_mach_i960_kb_sb     3
85 #define bfd_mach_i960_mc        4
86 #define bfd_mach_i960_xa        5
87 #define bfd_mach_i960_ca        6
88 #define bfd_mach_i960_jx        7
89 #define bfd_mach_i960_hx        8
90
91   bfd_arch_or1k,      /* OpenRISC 1000 */
92 #define bfd_mach_or1k           1
93 #define bfd_mach_or1knd         2
94
95   bfd_arch_sparc,     /* SPARC */
96 #define bfd_mach_sparc                 1
97 /* The difference between v8plus and v9 is that v9 is a true 64 bit env.  */
98 #define bfd_mach_sparc_sparclet        2
99 #define bfd_mach_sparc_sparclite       3
100 #define bfd_mach_sparc_v8plus          4
101 #define bfd_mach_sparc_v8plusa         5 /* with ultrasparc add'ns.  */
102 #define bfd_mach_sparc_sparclite_le    6
103 #define bfd_mach_sparc_v9              7
104 #define bfd_mach_sparc_v9a             8 /* with ultrasparc add'ns.  */
105 #define bfd_mach_sparc_v8plusb         9 /* with cheetah add'ns.  */
106 #define bfd_mach_sparc_v9b             10 /* with cheetah add'ns.  */
107 /* Nonzero if MACH has the v9 instruction set.  */
108 #define bfd_mach_sparc_v9_p(mach) \
109   ((mach) >= bfd_mach_sparc_v8plus && (mach) <= bfd_mach_sparc_v9b \
110    && (mach) != bfd_mach_sparc_sparclite_le)
111 /* Nonzero if MACH is a 64 bit sparc architecture.  */
112 #define bfd_mach_sparc_64bit_p(mach) \
113   ((mach) >= bfd_mach_sparc_v9 && (mach) != bfd_mach_sparc_v8plusb)
114   bfd_arch_spu,       /* PowerPC SPU */
115 #define bfd_mach_spu           256
116   bfd_arch_mips,      /* MIPS Rxxxx */
117 #define bfd_mach_mips3000              3000
118 #define bfd_mach_mips3900              3900
119 #define bfd_mach_mips4000              4000
120 #define bfd_mach_mips4010              4010
121 #define bfd_mach_mips4100              4100
122 #define bfd_mach_mips4111              4111
123 #define bfd_mach_mips4120              4120
124 #define bfd_mach_mips4300              4300
125 #define bfd_mach_mips4400              4400
126 #define bfd_mach_mips4600              4600
127 #define bfd_mach_mips4650              4650
128 #define bfd_mach_mips5000              5000
129 #define bfd_mach_mips5400              5400
130 #define bfd_mach_mips5500              5500
131 #define bfd_mach_mips5900              5900
132 #define bfd_mach_mips6000              6000
133 #define bfd_mach_mips7000              7000
134 #define bfd_mach_mips8000              8000
135 #define bfd_mach_mips9000              9000
136 #define bfd_mach_mips10000             10000
137 #define bfd_mach_mips12000             12000
138 #define bfd_mach_mips14000             14000
139 #define bfd_mach_mips16000             16000
140 #define bfd_mach_mips16                16
141 #define bfd_mach_mips5                 5
142 #define bfd_mach_mips_loongson_2e      3001
143 #define bfd_mach_mips_loongson_2f      3002
144 #define bfd_mach_mips_loongson_3a      3003
145 #define bfd_mach_mips_sb1              12310201 /* octal 'SB', 01 */
146 #define bfd_mach_mips_octeon           6501
147 #define bfd_mach_mips_octeonp          6601
148 #define bfd_mach_mips_octeon2          6502
149 #define bfd_mach_mips_xlr              887682   /* decimal 'XLR'  */
150 #define bfd_mach_mipsisa32             32
151 #define bfd_mach_mipsisa32r2           33
152 #define bfd_mach_mipsisa32r3           34
153 #define bfd_mach_mipsisa32r5           36
154 #define bfd_mach_mipsisa64             64
155 #define bfd_mach_mipsisa64r2           65
156 #define bfd_mach_mipsisa64r3           66
157 #define bfd_mach_mipsisa64r5           68
158 #define bfd_mach_mips_micromips        96
159   bfd_arch_i386,      /* Intel 386 */
160 #define bfd_mach_i386_intel_syntax     (1 << 0)
161 #define bfd_mach_i386_i8086            (1 << 1)
162 #define bfd_mach_i386_i386             (1 << 2)
163 #define bfd_mach_x86_64                (1 << 3)
164 #define bfd_mach_x64_32                (1 << 4)
165 #define bfd_mach_i386_i386_intel_syntax (bfd_mach_i386_i386 | bfd_mach_i386_intel_syntax)
166 #define bfd_mach_x86_64_intel_syntax   (bfd_mach_x86_64 | bfd_mach_i386_intel_syntax)
167 #define bfd_mach_x64_32_intel_syntax   (bfd_mach_x64_32 | bfd_mach_i386_intel_syntax)
168   bfd_arch_l1om,   /* Intel L1OM */
169 #define bfd_mach_l1om                  (1 << 5)
170 #define bfd_mach_l1om_intel_syntax     (bfd_mach_l1om | bfd_mach_i386_intel_syntax)
171   bfd_arch_k1om,   /* Intel K1OM */
172 #define bfd_mach_k1om                  (1 << 6)
173 #define bfd_mach_k1om_intel_syntax     (bfd_mach_k1om | bfd_mach_i386_intel_syntax)
174 #define bfd_mach_i386_nacl             (1 << 7)
175 #define bfd_mach_i386_i386_nacl        (bfd_mach_i386_i386 | bfd_mach_i386_nacl)
176 #define bfd_mach_x86_64_nacl           (bfd_mach_x86_64 | bfd_mach_i386_nacl)
177 #define bfd_mach_x64_32_nacl           (bfd_mach_x64_32 | bfd_mach_i386_nacl)
178   bfd_arch_we32k,     /* AT&T WE32xxx */
179   bfd_arch_tahoe,     /* CCI/Harris Tahoe */
180   bfd_arch_i860,      /* Intel 860 */
181   bfd_arch_i370,      /* IBM 360/370 Mainframes */
182   bfd_arch_romp,      /* IBM ROMP PC/RT */
183   bfd_arch_convex,    /* Convex */
184   bfd_arch_m88k,      /* Motorola 88xxx */
185   bfd_arch_m98k,      /* Motorola 98xxx */
186   bfd_arch_pyramid,   /* Pyramid Technology */
187   bfd_arch_h8300,     /* Renesas H8/300 (formerly Hitachi H8/300) */
188 #define bfd_mach_h8300    1
189 #define bfd_mach_h8300h   2
190 #define bfd_mach_h8300s   3
191 #define bfd_mach_h8300hn  4
192 #define bfd_mach_h8300sn  5
193 #define bfd_mach_h8300sx  6
194 #define bfd_mach_h8300sxn 7
195   bfd_arch_pdp11,     /* DEC PDP-11 */
196   bfd_arch_plugin,
197   bfd_arch_powerpc,   /* PowerPC */
198 #define bfd_mach_ppc           32
199 #define bfd_mach_ppc64         64
200 #define bfd_mach_ppc_403       403
201 #define bfd_mach_ppc_403gc     4030
202 #define bfd_mach_ppc_405       405
203 #define bfd_mach_ppc_505       505
204 #define bfd_mach_ppc_601       601
205 #define bfd_mach_ppc_602       602
206 #define bfd_mach_ppc_603       603
207 #define bfd_mach_ppc_ec603e    6031
208 #define bfd_mach_ppc_604       604
209 #define bfd_mach_ppc_620       620
210 #define bfd_mach_ppc_630       630
211 #define bfd_mach_ppc_750       750
212 #define bfd_mach_ppc_860       860
213 #define bfd_mach_ppc_a35       35
214 #define bfd_mach_ppc_rs64ii    642
215 #define bfd_mach_ppc_rs64iii   643
216 #define bfd_mach_ppc_7400      7400
217 #define bfd_mach_ppc_e500      500
218 #define bfd_mach_ppc_e500mc    5001
219 #define bfd_mach_ppc_e500mc64  5005
220 #define bfd_mach_ppc_e5500     5006
221 #define bfd_mach_ppc_e6500     5007
222 #define bfd_mach_ppc_titan     83
223 #define bfd_mach_ppc_vle       84
224   bfd_arch_rs6000,    /* IBM RS/6000 */
225 #define bfd_mach_rs6k          6000
226 #define bfd_mach_rs6k_rs1      6001
227 #define bfd_mach_rs6k_rsc      6003
228 #define bfd_mach_rs6k_rs2      6002
229   bfd_arch_hppa,      /* HP PA RISC */
230 #define bfd_mach_hppa10        10
231 #define bfd_mach_hppa11        11
232 #define bfd_mach_hppa20        20
233 #define bfd_mach_hppa20w       25
234   bfd_arch_d10v,      /* Mitsubishi D10V */
235 #define bfd_mach_d10v          1
236 #define bfd_mach_d10v_ts2      2
237 #define bfd_mach_d10v_ts3      3
238   bfd_arch_d30v,      /* Mitsubishi D30V */
239   bfd_arch_dlx,       /* DLX */
240   bfd_arch_m68hc11,   /* Motorola 68HC11 */
241   bfd_arch_m68hc12,   /* Motorola 68HC12 */
242 #define bfd_mach_m6812_default 0
243 #define bfd_mach_m6812         1
244 #define bfd_mach_m6812s        2
245   bfd_arch_m9s12x,   /* Freescale S12X */
246   bfd_arch_m9s12xg,  /* Freescale XGATE */
247   bfd_arch_z8k,       /* Zilog Z8000 */
248 #define bfd_mach_z8001         1
249 #define bfd_mach_z8002         2
250   bfd_arch_h8500,     /* Renesas H8/500 (formerly Hitachi H8/500) */
251   bfd_arch_sh,        /* Renesas / SuperH SH (formerly Hitachi SH) */
252 #define bfd_mach_sh            1
253 #define bfd_mach_sh2        0x20
254 #define bfd_mach_sh_dsp     0x2d
255 #define bfd_mach_sh2a       0x2a
256 #define bfd_mach_sh2a_nofpu 0x2b
257 #define bfd_mach_sh2a_nofpu_or_sh4_nommu_nofpu 0x2a1
258 #define bfd_mach_sh2a_nofpu_or_sh3_nommu 0x2a2
259 #define bfd_mach_sh2a_or_sh4  0x2a3
260 #define bfd_mach_sh2a_or_sh3e 0x2a4
261 #define bfd_mach_sh2e       0x2e
262 #define bfd_mach_sh3        0x30
263 #define bfd_mach_sh3_nommu  0x31
264 #define bfd_mach_sh3_dsp    0x3d
265 #define bfd_mach_sh3e       0x3e
266 #define bfd_mach_sh4        0x40
267 #define bfd_mach_sh4_nofpu  0x41
268 #define bfd_mach_sh4_nommu_nofpu  0x42
269 #define bfd_mach_sh4a       0x4a
270 #define bfd_mach_sh4a_nofpu 0x4b
271 #define bfd_mach_sh4al_dsp  0x4d
272 #define bfd_mach_sh5        0x50
273   bfd_arch_alpha,     /* Dec Alpha */
274 #define bfd_mach_alpha_ev4  0x10
275 #define bfd_mach_alpha_ev5  0x20
276 #define bfd_mach_alpha_ev6  0x30
277   bfd_arch_arm,       /* Advanced Risc Machines ARM.  */
278 #define bfd_mach_arm_unknown   0
279 #define bfd_mach_arm_2         1
280 #define bfd_mach_arm_2a        2
281 #define bfd_mach_arm_3         3
282 #define bfd_mach_arm_3M        4
283 #define bfd_mach_arm_4         5
284 #define bfd_mach_arm_4T        6
285 #define bfd_mach_arm_5         7
286 #define bfd_mach_arm_5T        8
287 #define bfd_mach_arm_5TE       9
288 #define bfd_mach_arm_XScale    10
289 #define bfd_mach_arm_ep9312    11
290 #define bfd_mach_arm_iWMMXt    12
291 #define bfd_mach_arm_iWMMXt2   13
292   bfd_arch_nds32,     /* Andes NDS32 */
293 #define bfd_mach_n1            1
294 #define bfd_mach_n1h           2
295 #define bfd_mach_n1h_v2        3
296 #define bfd_mach_n1h_v3        4
297 #define bfd_mach_n1h_v3m       5
298   bfd_arch_ns32k,     /* National Semiconductors ns32000 */
299   bfd_arch_w65,       /* WDC 65816 */
300   bfd_arch_tic30,     /* Texas Instruments TMS320C30 */
301   bfd_arch_tic4x,     /* Texas Instruments TMS320C3X/4X */
302 #define bfd_mach_tic3x         30
303 #define bfd_mach_tic4x         40
304   bfd_arch_tic54x,    /* Texas Instruments TMS320C54X */
305   bfd_arch_tic6x,     /* Texas Instruments TMS320C6X */
306   bfd_arch_tic80,     /* TI TMS320c80 (MVP) */
307   bfd_arch_v850,      /* NEC V850 */
308   bfd_arch_v850_rh850,/* NEC V850 (using RH850 ABI) */
309 #define bfd_mach_v850          1
310 #define bfd_mach_v850e         'E'
311 #define bfd_mach_v850e1        '1'
312 #define bfd_mach_v850e2        0x4532
313 #define bfd_mach_v850e2v3      0x45325633
314 #define bfd_mach_v850e3v5      0x45335635 /* ('E'|'3'|'V'|'5') */
315   bfd_arch_arc,       /* ARC Cores */
316 #define bfd_mach_arc_5         5
317 #define bfd_mach_arc_6         6
318 #define bfd_mach_arc_7         7
319 #define bfd_mach_arc_8         8
320  bfd_arch_m32c,     /* Renesas M16C/M32C.  */
321 #define bfd_mach_m16c        0x75
322 #define bfd_mach_m32c        0x78
323   bfd_arch_m32r,      /* Renesas M32R (formerly Mitsubishi M32R/D) */
324 #define bfd_mach_m32r          1 /* For backwards compatibility.  */
325 #define bfd_mach_m32rx         'x'
326 #define bfd_mach_m32r2         '2'
327   bfd_arch_mn10200,   /* Matsushita MN10200 */
328   bfd_arch_mn10300,   /* Matsushita MN10300 */
329 #define bfd_mach_mn10300               300
330 #define bfd_mach_am33          330
331 #define bfd_mach_am33_2        332
332   bfd_arch_fr30,
333 #define bfd_mach_fr30          0x46523330
334   bfd_arch_frv,
335 #define bfd_mach_frv           1
336 #define bfd_mach_frvsimple     2
337 #define bfd_mach_fr300         300
338 #define bfd_mach_fr400         400
339 #define bfd_mach_fr450         450
340 #define bfd_mach_frvtomcat     499     /* fr500 prototype */
341 #define bfd_mach_fr500         500
342 #define bfd_mach_fr550         550
343   bfd_arch_moxie,       /* The moxie processor */
344 #define bfd_mach_moxie         1
345   bfd_arch_mcore,
346   bfd_arch_mep,
347 #define bfd_mach_mep           1
348 #define bfd_mach_mep_h1        0x6831
349 #define bfd_mach_mep_c5        0x6335
350   bfd_arch_metag,
351 #define bfd_mach_metag         1
352   bfd_arch_ia64,      /* HP/Intel ia64 */
353 #define bfd_mach_ia64_elf64    64
354 #define bfd_mach_ia64_elf32    32
355   bfd_arch_ip2k,      /* Ubicom IP2K microcontrollers. */
356 #define bfd_mach_ip2022        1
357 #define bfd_mach_ip2022ext     2
358  bfd_arch_iq2000,     /* Vitesse IQ2000.  */
359 #define bfd_mach_iq2000        1
360 #define bfd_mach_iq10          2
361   bfd_arch_epiphany,   /* Adapteva EPIPHANY */
362 #define bfd_mach_epiphany16    1
363 #define bfd_mach_epiphany32    2
364   bfd_arch_mt,
365 #define bfd_mach_ms1           1
366 #define bfd_mach_mrisc2        2
367 #define bfd_mach_ms2           3
368   bfd_arch_pj,
369   bfd_arch_avr,       /* Atmel AVR microcontrollers.  */
370 #define bfd_mach_avr1          1
371 #define bfd_mach_avr2          2
372 #define bfd_mach_avr25         25
373 #define bfd_mach_avr3          3
374 #define bfd_mach_avr31         31
375 #define bfd_mach_avr35         35
376 #define bfd_mach_avr4          4
377 #define bfd_mach_avr5          5
378 #define bfd_mach_avr51         51
379 #define bfd_mach_avr6          6
380 #define bfd_mach_avrxmega1 101
381 #define bfd_mach_avrxmega2 102
382 #define bfd_mach_avrxmega3 103
383 #define bfd_mach_avrxmega4 104
384 #define bfd_mach_avrxmega5 105
385 #define bfd_mach_avrxmega6 106
386 #define bfd_mach_avrxmega7 107
387   bfd_arch_bfin,        /* ADI Blackfin */
388 #define bfd_mach_bfin          1
389   bfd_arch_cr16,       /* National Semiconductor CompactRISC (ie CR16). */
390 #define bfd_mach_cr16          1
391   bfd_arch_cr16c,       /* National Semiconductor CompactRISC. */
392 #define bfd_mach_cr16c         1
393   bfd_arch_crx,       /*  National Semiconductor CRX.  */
394 #define bfd_mach_crx           1
395   bfd_arch_cris,      /* Axis CRIS */
396 #define bfd_mach_cris_v0_v10   255
397 #define bfd_mach_cris_v32      32
398 #define bfd_mach_cris_v10_v32  1032
399   bfd_arch_rl78,
400 #define bfd_mach_rl78  0x75
401   bfd_arch_rx,        /* Renesas RX.  */
402 #define bfd_mach_rx            0x75
403   bfd_arch_s390,      /* IBM s390 */
404 #define bfd_mach_s390_31       31
405 #define bfd_mach_s390_64       64
406   bfd_arch_score,     /* Sunplus score */
407 #define bfd_mach_score3         3
408 #define bfd_mach_score7         7
409   bfd_arch_mmix,      /* Donald Knuth's educational processor.  */
410   bfd_arch_xstormy16,
411 #define bfd_mach_xstormy16     1
412   bfd_arch_msp430,    /* Texas Instruments MSP430 architecture.  */
413 #define bfd_mach_msp11          11
414 #define bfd_mach_msp110         110
415 #define bfd_mach_msp12          12
416 #define bfd_mach_msp13          13
417 #define bfd_mach_msp14          14
418 #define bfd_mach_msp15          15
419 #define bfd_mach_msp16          16
420 #define bfd_mach_msp20          20
421 #define bfd_mach_msp21          21
422 #define bfd_mach_msp22          22
423 #define bfd_mach_msp23          23
424 #define bfd_mach_msp24          24
425 #define bfd_mach_msp26          26
426 #define bfd_mach_msp31          31
427 #define bfd_mach_msp32          32
428 #define bfd_mach_msp33          33
429 #define bfd_mach_msp41          41
430 #define bfd_mach_msp42          42
431 #define bfd_mach_msp43          43
432 #define bfd_mach_msp44          44
433 #define bfd_mach_msp430x        45
434 #define bfd_mach_msp46          46
435 #define bfd_mach_msp47          47
436 #define bfd_mach_msp54          54
437   bfd_arch_xc16x,     /* Infineon's XC16X Series.               */
438 #define bfd_mach_xc16x         1
439 #define bfd_mach_xc16xl        2
440 #define bfd_mach_xc16xs        3
441   bfd_arch_xgate,   /* Freescale XGATE */
442 #define bfd_mach_xgate         1
443   bfd_arch_xtensa,    /* Tensilica's Xtensa cores.  */
444 #define bfd_mach_xtensa        1
445   bfd_arch_z80,
446 #define bfd_mach_z80strict      1 /* No undocumented opcodes.  */
447 #define bfd_mach_z80            3 /* With ixl, ixh, iyl, and iyh.  */
448 #define bfd_mach_z80full        7 /* All undocumented instructions.  */
449 #define bfd_mach_r800           11 /* R800: successor with multiplication.  */
450   bfd_arch_lm32,      /* Lattice Mico32 */
451 #define bfd_mach_lm32      1
452   bfd_arch_microblaze,/* Xilinx MicroBlaze. */
453   bfd_arch_tilepro,   /* Tilera TILEPro */
454   bfd_arch_tilegx, /* Tilera TILE-Gx */
455 #define bfd_mach_tilepro   1
456 #define bfd_mach_tilegx    1
457 #define bfd_mach_tilegx32  2
458   bfd_arch_aarch64,   /* AArch64  */
459 #define bfd_mach_aarch64 0
460 #define bfd_mach_aarch64_ilp32 32
461   bfd_arch_nios2,
462 #define bfd_mach_nios2 0
463   bfd_arch_last
464   @};
465 @end example
466
467 @subsection bfd_arch_info
468
469
470 @strong{Description}@*
471 This structure contains information on architectures for use
472 within BFD.
473 @example
474
475 typedef struct bfd_arch_info
476 @{
477   int bits_per_word;
478   int bits_per_address;
479   int bits_per_byte;
480   enum bfd_architecture arch;
481   unsigned long mach;
482   const char *arch_name;
483   const char *printable_name;
484   unsigned int section_align_power;
485   /* TRUE if this is the default machine for the architecture.
486      The default arch should be the first entry for an arch so that
487      all the entries for that arch can be accessed via @code{next}.  */
488   bfd_boolean the_default;
489   const struct bfd_arch_info * (*compatible)
490     (const struct bfd_arch_info *a, const struct bfd_arch_info *b);
491
492   bfd_boolean (*scan) (const struct bfd_arch_info *, const char *);
493
494   /* Allocate via bfd_malloc and return a fill buffer of size COUNT.  If
495      IS_BIGENDIAN is TRUE, the order of bytes is big endian.  If CODE is
496      TRUE, the buffer contains code.  */
497   void *(*fill) (bfd_size_type count, bfd_boolean is_bigendian,
498                  bfd_boolean code);
499
500   const struct bfd_arch_info *next;
501 @}
502 bfd_arch_info_type;
503
504 @end example
505
506 @findex bfd_printable_name
507 @subsubsection @code{bfd_printable_name}
508 @strong{Synopsis}
509 @example
510 const char *bfd_printable_name (bfd *abfd);
511 @end example
512 @strong{Description}@*
513 Return a printable string representing the architecture and machine
514 from the pointer to the architecture info structure.
515
516 @findex bfd_scan_arch
517 @subsubsection @code{bfd_scan_arch}
518 @strong{Synopsis}
519 @example
520 const bfd_arch_info_type *bfd_scan_arch (const char *string);
521 @end example
522 @strong{Description}@*
523 Figure out if BFD supports any cpu which could be described with
524 the name @var{string}.  Return a pointer to an @code{arch_info}
525 structure if a machine is found, otherwise NULL.
526
527 @findex bfd_arch_list
528 @subsubsection @code{bfd_arch_list}
529 @strong{Synopsis}
530 @example
531 const char **bfd_arch_list (void);
532 @end example
533 @strong{Description}@*
534 Return a freshly malloced NULL-terminated vector of the names
535 of all the valid BFD architectures.  Do not modify the names.
536
537 @findex bfd_arch_get_compatible
538 @subsubsection @code{bfd_arch_get_compatible}
539 @strong{Synopsis}
540 @example
541 const bfd_arch_info_type *bfd_arch_get_compatible
542    (const bfd *abfd, const bfd *bbfd, bfd_boolean accept_unknowns);
543 @end example
544 @strong{Description}@*
545 Determine whether two BFDs' architectures and machine types
546 are compatible.  Calculates the lowest common denominator
547 between the two architectures and machine types implied by
548 the BFDs and returns a pointer to an @code{arch_info} structure
549 describing the compatible machine.
550
551 @findex bfd_default_arch_struct
552 @subsubsection @code{bfd_default_arch_struct}
553 @strong{Description}@*
554 The @code{bfd_default_arch_struct} is an item of
555 @code{bfd_arch_info_type} which has been initialized to a fairly
556 generic state.  A BFD starts life by pointing to this
557 structure, until the correct back end has determined the real
558 architecture of the file.
559 @example
560 extern const bfd_arch_info_type bfd_default_arch_struct;
561 @end example
562
563 @findex bfd_set_arch_info
564 @subsubsection @code{bfd_set_arch_info}
565 @strong{Synopsis}
566 @example
567 void bfd_set_arch_info (bfd *abfd, const bfd_arch_info_type *arg);
568 @end example
569 @strong{Description}@*
570 Set the architecture info of @var{abfd} to @var{arg}.
571
572 @findex bfd_default_set_arch_mach
573 @subsubsection @code{bfd_default_set_arch_mach}
574 @strong{Synopsis}
575 @example
576 bfd_boolean bfd_default_set_arch_mach
577    (bfd *abfd, enum bfd_architecture arch, unsigned long mach);
578 @end example
579 @strong{Description}@*
580 Set the architecture and machine type in BFD @var{abfd}
581 to @var{arch} and @var{mach}.  Find the correct
582 pointer to a structure and insert it into the @code{arch_info}
583 pointer.
584
585 @findex bfd_get_arch
586 @subsubsection @code{bfd_get_arch}
587 @strong{Synopsis}
588 @example
589 enum bfd_architecture bfd_get_arch (bfd *abfd);
590 @end example
591 @strong{Description}@*
592 Return the enumerated type which describes the BFD @var{abfd}'s
593 architecture.
594
595 @findex bfd_get_mach
596 @subsubsection @code{bfd_get_mach}
597 @strong{Synopsis}
598 @example
599 unsigned long bfd_get_mach (bfd *abfd);
600 @end example
601 @strong{Description}@*
602 Return the long type which describes the BFD @var{abfd}'s
603 machine.
604
605 @findex bfd_arch_bits_per_byte
606 @subsubsection @code{bfd_arch_bits_per_byte}
607 @strong{Synopsis}
608 @example
609 unsigned int bfd_arch_bits_per_byte (bfd *abfd);
610 @end example
611 @strong{Description}@*
612 Return the number of bits in one of the BFD @var{abfd}'s
613 architecture's bytes.
614
615 @findex bfd_arch_bits_per_address
616 @subsubsection @code{bfd_arch_bits_per_address}
617 @strong{Synopsis}
618 @example
619 unsigned int bfd_arch_bits_per_address (bfd *abfd);
620 @end example
621 @strong{Description}@*
622 Return the number of bits in one of the BFD @var{abfd}'s
623 architecture's addresses.
624
625 @findex bfd_default_compatible
626 @subsubsection @code{bfd_default_compatible}
627 @strong{Synopsis}
628 @example
629 const bfd_arch_info_type *bfd_default_compatible
630    (const bfd_arch_info_type *a, const bfd_arch_info_type *b);
631 @end example
632 @strong{Description}@*
633 The default function for testing for compatibility.
634
635 @findex bfd_default_scan
636 @subsubsection @code{bfd_default_scan}
637 @strong{Synopsis}
638 @example
639 bfd_boolean bfd_default_scan
640    (const struct bfd_arch_info *info, const char *string);
641 @end example
642 @strong{Description}@*
643 The default function for working out whether this is an
644 architecture hit and a machine hit.
645
646 @findex bfd_get_arch_info
647 @subsubsection @code{bfd_get_arch_info}
648 @strong{Synopsis}
649 @example
650 const bfd_arch_info_type *bfd_get_arch_info (bfd *abfd);
651 @end example
652 @strong{Description}@*
653 Return the architecture info struct in @var{abfd}.
654
655 @findex bfd_lookup_arch
656 @subsubsection @code{bfd_lookup_arch}
657 @strong{Synopsis}
658 @example
659 const bfd_arch_info_type *bfd_lookup_arch
660    (enum bfd_architecture arch, unsigned long machine);
661 @end example
662 @strong{Description}@*
663 Look for the architecture info structure which matches the
664 arguments @var{arch} and @var{machine}. A machine of 0 matches the
665 machine/architecture structure which marks itself as the
666 default.
667
668 @findex bfd_printable_arch_mach
669 @subsubsection @code{bfd_printable_arch_mach}
670 @strong{Synopsis}
671 @example
672 const char *bfd_printable_arch_mach
673    (enum bfd_architecture arch, unsigned long machine);
674 @end example
675 @strong{Description}@*
676 Return a printable string representing the architecture and
677 machine type.
678
679 This routine is depreciated.
680
681 @findex bfd_octets_per_byte
682 @subsubsection @code{bfd_octets_per_byte}
683 @strong{Synopsis}
684 @example
685 unsigned int bfd_octets_per_byte (bfd *abfd);
686 @end example
687 @strong{Description}@*
688 Return the number of octets (8-bit quantities) per target byte
689 (minimum addressable unit).  In most cases, this will be one, but some
690 DSP targets have 16, 32, or even 48 bits per byte.
691
692 @findex bfd_arch_mach_octets_per_byte
693 @subsubsection @code{bfd_arch_mach_octets_per_byte}
694 @strong{Synopsis}
695 @example
696 unsigned int bfd_arch_mach_octets_per_byte
697    (enum bfd_architecture arch, unsigned long machine);
698 @end example
699 @strong{Description}@*
700 See bfd_octets_per_byte.
701
702 This routine is provided for those cases where a bfd * is not
703 available
704
705 @findex bfd_arch_default_fill
706 @subsubsection @code{bfd_arch_default_fill}
707 @strong{Synopsis}
708 @example
709 void *bfd_arch_default_fill (bfd_size_type count,
710     bfd_boolean is_bigendian,
711     bfd_boolean code);
712 @end example
713 @strong{Description}@*
714 Allocate via bfd_malloc and return a fill buffer of size COUNT.
715 If IS_BIGENDIAN is TRUE, the order of bytes is big endian.  If
716 CODE is TRUE, the buffer contains code.
717