1 /* BFD library support routines for architectures.
2 Copyright (C) 1990, 91, 92, 93, 94, 95, 96, 97, 98, 1999, 2000
3 Free Software Foundation, Inc.
4 Hacked by John Gilmore and Steve Chamberlain of Cygnus Support.
6 This file is part of BFD, the Binary File Descriptor library.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
32 BFD keeps one atom in a BFD describing the
33 architecture of the data attached to the BFD: a pointer to a
34 <<bfd_arch_info_type>>.
36 Pointers to structures can be requested independently of a BFD
37 so that an architecture's information can be interrogated
38 without access to an open BFD.
40 The architecture information is provided by each architecture package.
41 The set of default architectures is selected by the macro
42 <<SELECT_ARCHITECTURES>>. This is normally set up in the
43 @file{config/@var{target}.mt} file of your choice. If the name is not
44 defined, then all the architectures supported are included.
46 When BFD starts up, all the architectures are called with an
47 initialize method. It is up to the architecture back end to
48 insert as many items into the list of architectures as it wants to;
49 generally this would be one for each machine and one for the
50 default case (an item with a machine field of 0).
52 BFD's idea of an architecture is implemented in @file{archures.c}.
61 This enum gives the object file's CPU architecture, in a
62 global sense---i.e., what processor family does it belong to?
63 Another field indicates which processor within
64 the family is in use. The machine gives a number which
65 distinguishes different versions of the architecture,
66 containing, for example, 2 and 3 for Intel i960 KA and i960 KB,
67 and 68020 and 68030 for Motorola 68020 and 68030.
69 .enum bfd_architecture
71 . bfd_arch_unknown, {* File arch not known *}
72 . bfd_arch_obscure, {* Arch known, not one of these *}
73 . bfd_arch_m68k, {* Motorola 68xxx *}
74 .#define bfd_mach_m68000 1
75 .#define bfd_mach_m68008 2
76 .#define bfd_mach_m68010 3
77 .#define bfd_mach_m68020 4
78 .#define bfd_mach_m68030 5
79 .#define bfd_mach_m68040 6
80 .#define bfd_mach_m68060 7
81 .#define bfd_mach_cpu32 8
82 . bfd_arch_vax, {* DEC Vax *}
83 . bfd_arch_i960, {* Intel 960 *}
84 . {* The order of the following is important.
85 . lower number indicates a machine type that
86 . only accepts a subset of the instructions
87 . available to machines with higher numbers.
88 . The exception is the "ca", which is
89 . incompatible with all other machines except
92 .#define bfd_mach_i960_core 1
93 .#define bfd_mach_i960_ka_sa 2
94 .#define bfd_mach_i960_kb_sb 3
95 .#define bfd_mach_i960_mc 4
96 .#define bfd_mach_i960_xa 5
97 .#define bfd_mach_i960_ca 6
98 .#define bfd_mach_i960_jx 7
99 .#define bfd_mach_i960_hx 8
101 . bfd_arch_a29k, {* AMD 29000 *}
102 . bfd_arch_sparc, {* SPARC *}
103 .#define bfd_mach_sparc 1
104 .{* The difference between v8plus and v9 is that v9 is a true 64 bit env. *}
105 .#define bfd_mach_sparc_sparclet 2
106 .#define bfd_mach_sparc_sparclite 3
107 .#define bfd_mach_sparc_v8plus 4
108 .#define bfd_mach_sparc_v8plusa 5 {* with ultrasparc add'ns *}
109 .#define bfd_mach_sparc_sparclite_le 6
110 .#define bfd_mach_sparc_v9 7
111 .#define bfd_mach_sparc_v9a 8 {* with ultrasparc add'ns *}
112 .{* Nonzero if MACH has the v9 instruction set. *}
113 .#define bfd_mach_sparc_v9_p(mach) \
114 . ((mach) >= bfd_mach_sparc_v8plus && (mach) <= bfd_mach_sparc_v9a)
115 . bfd_arch_mips, {* MIPS Rxxxx *}
116 .#define bfd_mach_mips3000 3000
117 .#define bfd_mach_mips3900 3900
118 .#define bfd_mach_mips4000 4000
119 .#define bfd_mach_mips4010 4010
120 .#define bfd_mach_mips4100 4100
121 .#define bfd_mach_mips4111 4111
122 .#define bfd_mach_mips4300 4300
123 .#define bfd_mach_mips4400 4400
124 .#define bfd_mach_mips4600 4600
125 .#define bfd_mach_mips4650 4650
126 .#define bfd_mach_mips5000 5000
127 .#define bfd_mach_mips6000 6000
128 .#define bfd_mach_mips8000 8000
129 .#define bfd_mach_mips10000 10000
130 .#define bfd_mach_mips16 16
131 . bfd_arch_i386, {* Intel 386 *}
132 .#define bfd_mach_i386_i386 0
133 .#define bfd_mach_i386_i8086 1
134 .#define bfd_mach_i386_i386_intel_syntax 2
135 . bfd_arch_we32k, {* AT&T WE32xxx *}
136 . bfd_arch_tahoe, {* CCI/Harris Tahoe *}
137 . bfd_arch_i860, {* Intel 860 *}
138 . bfd_arch_i370, {* IBM 360/370 Mainframes *}
139 . bfd_arch_romp, {* IBM ROMP PC/RT *}
140 . bfd_arch_alliant, {* Alliant *}
141 . bfd_arch_convex, {* Convex *}
142 . bfd_arch_m88k, {* Motorola 88xxx *}
143 . bfd_arch_pyramid, {* Pyramid Technology *}
144 . bfd_arch_h8300, {* Hitachi H8/300 *}
145 .#define bfd_mach_h8300 1
146 .#define bfd_mach_h8300h 2
147 .#define bfd_mach_h8300s 3
148 . bfd_arch_powerpc, {* PowerPC *}
149 . bfd_arch_rs6000, {* IBM RS/6000 *}
150 . bfd_arch_hppa, {* HP PA RISC *}
151 . bfd_arch_d10v, {* Mitsubishi D10V *}
152 .#define bfd_mach_d10v 0
153 .#define bfd_mach_d10v_ts2 2
154 .#define bfd_mach_d10v_ts3 3
155 . bfd_arch_d30v, {* Mitsubishi D30V *}
156 . bfd_arch_z8k, {* Zilog Z8000 *}
157 .#define bfd_mach_z8001 1
158 .#define bfd_mach_z8002 2
159 . bfd_arch_h8500, {* Hitachi H8/500 *}
160 . bfd_arch_sh, {* Hitachi SH *}
161 .#define bfd_mach_sh 0
162 .#define bfd_mach_sh2 0x20
163 .#define bfd_mach_sh_dsp 0x2d
164 .#define bfd_mach_sh3 0x30
165 .#define bfd_mach_sh3_dsp 0x3d
166 .#define bfd_mach_sh3e 0x3e
167 .#define bfd_mach_sh4 0x40
168 . bfd_arch_alpha, {* Dec Alpha *}
169 .#define bfd_mach_alpha_ev4 0x10
170 .#define bfd_mach_alpha_ev5 0x20
171 .#define bfd_mach_alpha_ev6 0x30
172 . bfd_arch_arm, {* Advanced Risc Machines ARM *}
173 .#define bfd_mach_arm_2 1
174 .#define bfd_mach_arm_2a 2
175 .#define bfd_mach_arm_3 3
176 .#define bfd_mach_arm_3M 4
177 .#define bfd_mach_arm_4 5
178 .#define bfd_mach_arm_4T 6
179 .#define bfd_mach_arm_5 7
180 .#define bfd_mach_arm_5T 8
181 . bfd_arch_ns32k, {* National Semiconductors ns32000 *}
182 . bfd_arch_w65, {* WDC 65816 *}
183 . bfd_arch_tic30, {* Texas Instruments TMS320C30 *}
184 . bfd_arch_tic80, {* TI TMS320c80 (MVP) *}
185 . bfd_arch_v850, {* NEC V850 *}
186 .#define bfd_mach_v850 0
187 .#define bfd_mach_v850e 'E'
188 .#define bfd_mach_v850ea 'A'
189 . bfd_arch_arc, {* Argonaut RISC Core *}
190 .#define bfd_mach_arc_base 0
191 . bfd_arch_m32r, {* Mitsubishi M32R/D *}
192 .#define bfd_mach_m32r 0 {* backwards compatibility *}
193 .#define bfd_mach_m32rx 'x'
194 . bfd_arch_mn10200, {* Matsushita MN10200 *}
195 . bfd_arch_mn10300, {* Matsushita MN10300 *}
196 .#define bfd_mach_mn10300 300
197 .#define bfd_mach_am33 330
199 .#define bfd_mach_fr30 0x46523330
202 . bfd_arch_avr, {* Atmel AVR microcontrollers *}
203 .#define bfd_mach_avr1 1
204 .#define bfd_mach_avr2 2
205 .#define bfd_mach_avr3 3
206 .#define bfd_mach_avr4 4
219 This structure contains information on architectures for use
223 .typedef struct bfd_arch_info
226 . int bits_per_address;
228 . enum bfd_architecture arch;
229 . unsigned long mach;
230 . const char *arch_name;
231 . const char *printable_name;
232 . unsigned int section_align_power;
233 . {* true if this is the default machine for the architecture *}
234 . boolean the_default;
235 . const struct bfd_arch_info * (*compatible)
236 . PARAMS ((const struct bfd_arch_info *a,
237 . const struct bfd_arch_info *b));
239 . boolean (*scan) PARAMS ((const struct bfd_arch_info *, const char *));
241 . const struct bfd_arch_info *next;
242 .} bfd_arch_info_type;
245 extern const bfd_arch_info_type bfd_a29k_arch;
246 extern const bfd_arch_info_type bfd_alpha_arch;
247 extern const bfd_arch_info_type bfd_arc_arch;
248 extern const bfd_arch_info_type bfd_arm_arch;
249 extern const bfd_arch_info_type bfd_d10v_arch;
250 extern const bfd_arch_info_type bfd_d30v_arch;
251 extern const bfd_arch_info_type bfd_h8300_arch;
252 extern const bfd_arch_info_type bfd_h8500_arch;
253 extern const bfd_arch_info_type bfd_hppa_arch;
254 extern const bfd_arch_info_type bfd_i370_arch;
255 extern const bfd_arch_info_type bfd_i386_arch;
256 extern const bfd_arch_info_type bfd_i860_arch;
257 extern const bfd_arch_info_type bfd_i960_arch;
258 extern const bfd_arch_info_type bfd_m32r_arch;
259 extern const bfd_arch_info_type bfd_m68k_arch;
260 extern const bfd_arch_info_type bfd_m88k_arch;
261 extern const bfd_arch_info_type bfd_mips_arch;
262 extern const bfd_arch_info_type bfd_mn10200_arch;
263 extern const bfd_arch_info_type bfd_mn10300_arch;
264 extern const bfd_arch_info_type bfd_powerpc_arch;
265 extern const bfd_arch_info_type bfd_rs6000_arch;
266 extern const bfd_arch_info_type bfd_pj_arch;
267 extern const bfd_arch_info_type bfd_sh_arch;
268 extern const bfd_arch_info_type bfd_sparc_arch;
269 extern const bfd_arch_info_type bfd_tic30_arch;
270 extern const bfd_arch_info_type bfd_tic80_arch;
271 extern const bfd_arch_info_type bfd_vax_arch;
272 extern const bfd_arch_info_type bfd_we32k_arch;
273 extern const bfd_arch_info_type bfd_z8k_arch;
274 extern const bfd_arch_info_type bfd_ns32k_arch;
275 extern const bfd_arch_info_type bfd_w65_arch;
276 extern const bfd_arch_info_type bfd_v850_arch;
277 extern const bfd_arch_info_type bfd_fr30_arch;
278 extern const bfd_arch_info_type bfd_mcore_arch;
279 extern const bfd_arch_info_type bfd_avr_arch;
281 static const bfd_arch_info_type * const bfd_archures_list[] =
283 #ifdef SELECT_ARCHITECTURES
284 SELECT_ARCHITECTURES,
329 const char *bfd_printable_name(bfd *abfd);
332 Return a printable string representing the architecture and machine
333 from the pointer to the architecture info structure.
338 bfd_printable_name (abfd)
341 return abfd->arch_info->printable_name;
351 const bfd_arch_info_type *bfd_scan_arch(const char *string);
354 Figure out if BFD supports any cpu which could be described with
355 the name @var{string}. Return a pointer to an <<arch_info>>
356 structure if a machine is found, otherwise NULL.
360 const bfd_arch_info_type *
361 bfd_scan_arch (string)
364 const bfd_arch_info_type * const *app, *ap;
366 /* Look through all the installed architectures */
367 for (app = bfd_archures_list; *app != NULL; app++)
369 for (ap = *app; ap != NULL; ap = ap->next)
371 if (ap->scan (ap, string))
386 const char **bfd_arch_list(void);
389 Return a freshly malloced NULL-terminated vector of the names
390 of all the valid BFD architectures. Do not modify the names.
398 const char **name_ptr;
399 const char **name_list;
400 const bfd_arch_info_type * const *app;
402 /* Determine the number of architectures */
404 for (app = bfd_archures_list; *app != NULL; app++)
406 const bfd_arch_info_type *ap;
407 for (ap = *app; ap != NULL; ap = ap->next)
413 name_list = (CONST char **)
414 bfd_malloc ((vec_length + 1) * sizeof (char **));
415 if (name_list == NULL)
418 /* Point the list at each of the names */
419 name_ptr = name_list;
420 for (app = bfd_archures_list; *app != NULL; app++)
422 const bfd_arch_info_type *ap;
423 for (ap = *app; ap != NULL; ap = ap->next)
425 *name_ptr = ap->printable_name;
438 bfd_arch_get_compatible
441 const bfd_arch_info_type *bfd_arch_get_compatible(
446 Determine whether two BFDs'
447 architectures and machine types are compatible. Calculates
448 the lowest common denominator between the two architectures
449 and machine types implied by the BFDs and returns a pointer to
450 an <<arch_info>> structure describing the compatible machine.
453 const bfd_arch_info_type *
454 bfd_arch_get_compatible (abfd, bbfd)
458 /* If either architecture is unknown, then all we can do is assume
459 the user knows what he's doing. */
460 if (abfd->arch_info->arch == bfd_arch_unknown)
461 return bbfd->arch_info;
462 if (bbfd->arch_info->arch == bfd_arch_unknown)
463 return abfd->arch_info;
465 /* Otherwise architecture-specific code has to decide. */
466 return abfd->arch_info->compatible (abfd->arch_info, bbfd->arch_info);
472 bfd_default_arch_struct
475 The <<bfd_default_arch_struct>> is an item of
476 <<bfd_arch_info_type>> which has been initialized to a fairly
477 generic state. A BFD starts life by pointing to this
478 structure, until the correct back end has determined the real
479 architecture of the file.
481 .extern const bfd_arch_info_type bfd_default_arch_struct;
485 const bfd_arch_info_type bfd_default_arch_struct =
487 32,32,8,bfd_arch_unknown,0,"unknown","unknown",2,true,
488 bfd_default_compatible,
498 void bfd_set_arch_info(bfd *abfd, const bfd_arch_info_type *arg);
501 Set the architecture info of @var{abfd} to @var{arg}.
505 bfd_set_arch_info (abfd, arg)
507 const bfd_arch_info_type *arg;
509 abfd->arch_info = arg;
514 bfd_default_set_arch_mach
517 boolean bfd_default_set_arch_mach(bfd *abfd,
518 enum bfd_architecture arch,
522 Set the architecture and machine type in BFD @var{abfd}
523 to @var{arch} and @var{mach}. Find the correct
524 pointer to a structure and insert it into the <<arch_info>>
529 bfd_default_set_arch_mach (abfd, arch, mach)
531 enum bfd_architecture arch;
534 const bfd_arch_info_type * const *app, *ap;
536 for (app = bfd_archures_list; *app != NULL; app++)
538 for (ap = *app; ap != NULL; ap = ap->next)
542 || (mach == 0 && ap->the_default)))
544 abfd->arch_info = ap;
550 abfd->arch_info = &bfd_default_arch_struct;
551 bfd_set_error (bfd_error_bad_value);
561 enum bfd_architecture bfd_get_arch(bfd *abfd);
564 Return the enumerated type which describes the BFD @var{abfd}'s
569 enum bfd_architecture
573 return abfd->arch_info->arch;
581 unsigned long bfd_get_mach(bfd *abfd);
584 Return the long type which describes the BFD @var{abfd}'s
592 return abfd->arch_info->mach;
597 bfd_arch_bits_per_byte
600 unsigned int bfd_arch_bits_per_byte(bfd *abfd);
603 Return the number of bits in one of the BFD @var{abfd}'s
604 architecture's bytes.
609 bfd_arch_bits_per_byte (abfd)
612 return abfd->arch_info->bits_per_byte;
617 bfd_arch_bits_per_address
620 unsigned int bfd_arch_bits_per_address(bfd *abfd);
623 Return the number of bits in one of the BFD @var{abfd}'s
624 architecture's addresses.
628 bfd_arch_bits_per_address (abfd)
631 return abfd->arch_info->bits_per_address;
637 bfd_default_compatible
640 const bfd_arch_info_type *bfd_default_compatible
641 (const bfd_arch_info_type *a,
642 const bfd_arch_info_type *b);
645 The default function for testing for compatibility.
648 const bfd_arch_info_type *
649 bfd_default_compatible (a,b)
650 const bfd_arch_info_type *a;
651 const bfd_arch_info_type *b;
653 if (a->arch != b->arch)
656 if (a->mach > b->mach)
659 if (b->mach > a->mach)
671 boolean bfd_default_scan(const struct bfd_arch_info *info, const char *string);
674 The default function for working out whether this is an
675 architecture hit and a machine hit.
679 bfd_default_scan (info, string)
680 const struct bfd_arch_info *info;
685 unsigned long number;
686 enum bfd_architecture arch;
687 const char *printable_name_colon;
689 /* Exact match of the architecture name (ARCH_NAME) and also the
690 default architecture? */
691 if (strcasecmp (string, info->arch_name) == 0
692 && info->the_default)
695 /* Exact match of the machine name (PRINTABLE_NAME)? */
696 if (strcasecmp (string, info->printable_name) == 0)
699 /* Given that printable_name contains no colon, attempt to match:
700 ARCH_NAME [ ":" ] PRINTABLE_NAME? */
701 printable_name_colon = strchr (info->printable_name, ':');
702 if (printable_name_colon == NULL)
704 int strlen_arch_name = strlen (info->arch_name);
705 if (strncasecmp (string, info->arch_name, strlen_arch_name) == 0)
707 if (string[strlen_arch_name] == ':')
709 if (strcasecmp (string + strlen_arch_name + 1,
710 info->printable_name) == 0)
715 if (strcasecmp (string + strlen_arch_name,
716 info->printable_name) == 0)
722 /* Given that PRINTABLE_NAME has the form: <arch> ":" <mach>;
723 Attempt to match: <arch> <mach>? */
724 if (printable_name_colon != NULL)
726 int colon_index = printable_name_colon - info->printable_name;
727 if (strncasecmp (string, info->printable_name, colon_index) == 0
728 && strcasecmp (string + colon_index,
729 info->printable_name + colon_index + 1) == 0)
733 /* Given that PRINTABLE_NAME has the form: <arch> ":" <mach>; Do not
734 attempt to match just <mach>, it could be ambigious. This test
735 is left until later. */
737 /* NOTE: The below is retained for compatibility only. Please do not
740 /* See how much of the supplied string matches with the
741 architecture, eg the string m68k:68020 would match the 68k entry
742 up to the :, then we get left with the machine number */
744 for (ptr_src = string, ptr_tst = info->arch_name;
745 *ptr_src && *ptr_tst;
746 ptr_src++, ptr_tst++)
748 if (*ptr_src != *ptr_tst) break;
751 /* Chewed up as much of the architecture as will match, skip any
758 /* nothing more, then only keep this one if it is the default
759 machine for this architecture */
760 return info->the_default;
764 while (isdigit ((unsigned char) *ptr_src))
766 number = number * 10 + *ptr_src - '0';
770 /* NOTE: The below is retained for compatibility only.
771 PLEASE DO NOT ADD TO THIS CODE. */
775 /* FIXME: These are needed to parse IEEE objects. */
777 arch = bfd_arch_m68k;
778 number = bfd_mach_m68000;
781 arch = bfd_arch_m68k;
782 number = bfd_mach_m68010;
785 arch = bfd_arch_m68k;
786 number = bfd_mach_m68020;
789 arch = bfd_arch_m68k;
790 number = bfd_mach_m68030;
793 arch = bfd_arch_m68k;
794 number = bfd_mach_m68040;
797 arch = bfd_arch_m68k;
798 number = bfd_mach_m68060;
801 arch = bfd_arch_m68k;
802 number = bfd_mach_cpu32;
806 arch = bfd_arch_we32k;
810 arch = bfd_arch_mips;
811 number = bfd_mach_mips3000;
815 arch = bfd_arch_mips;
816 number = bfd_mach_mips4000;
820 arch = bfd_arch_rs6000;
825 number = bfd_mach_sh_dsp;
830 number = bfd_mach_sh3;
835 number = bfd_mach_sh3_dsp;
840 number = bfd_mach_sh4;
847 if (arch != info->arch)
850 if (number != info->mach)
862 const bfd_arch_info_type * bfd_get_arch_info(bfd *abfd);
865 Return the architecture info struct in @var{abfd}.
868 const bfd_arch_info_type *
869 bfd_get_arch_info (abfd)
872 return abfd->arch_info;
881 const bfd_arch_info_type *bfd_lookup_arch
882 (enum bfd_architecture
884 unsigned long machine);
887 Look for the architecure info structure which matches the
888 arguments @var{arch} and @var{machine}. A machine of 0 matches the
889 machine/architecture structure which marks itself as the
893 const bfd_arch_info_type *
894 bfd_lookup_arch (arch, machine)
895 enum bfd_architecture arch;
896 unsigned long machine;
898 const bfd_arch_info_type * const *app, *ap;
900 for (app = bfd_archures_list; *app != NULL; app++)
902 for (ap = *app; ap != NULL; ap = ap->next)
905 && (ap->mach == machine
906 || (machine == 0 && ap->the_default)))
917 bfd_printable_arch_mach
920 const char *bfd_printable_arch_mach
921 (enum bfd_architecture arch, unsigned long machine);
924 Return a printable string representing the architecture and
927 This routine is depreciated.
931 bfd_printable_arch_mach (arch, machine)
932 enum bfd_architecture arch;
933 unsigned long machine;
935 const bfd_arch_info_type * ap = bfd_lookup_arch (arch, machine);
938 return ap->printable_name;
947 unsigned int bfd_octets_per_byte(bfd *abfd);
950 Return the number of octets (8-bit quantities) per target byte
951 (minimum addressable unit). In most cases, this will be one, but some
952 DSP targets have 16, 32, or even 48 bits per byte.
957 bfd_octets_per_byte (abfd)
960 return bfd_arch_mach_octets_per_byte (bfd_get_arch (abfd),
961 bfd_get_mach (abfd));
966 bfd_arch_mach_octets_per_byte
969 unsigned int bfd_arch_mach_octets_per_byte(enum bfd_architecture arch,
970 unsigned long machine);
973 See bfd_octets_per_byte.
975 This routine is provided for those cases where a bfd * is not
980 bfd_arch_mach_octets_per_byte (arch, mach)
981 enum bfd_architecture arch;
984 const bfd_arch_info_type * ap = bfd_lookup_arch (arch, mach);
987 return ap->bits_per_byte / 8;