1 /* OS ABI variant handling for GDB.
2 Copyright 2001, 2002, 2003 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
23 #include "gdb_assert.h"
24 #include "gdb_string.h"
31 /* This table matches the indices assigned to enum gdb_osabi. Keep
33 static const char * const gdb_osabi_names
[] =
63 gdbarch_osabi_name (enum gdb_osabi osabi
)
65 if (osabi
>= GDB_OSABI_UNKNOWN
&& osabi
< GDB_OSABI_INVALID
)
66 return gdb_osabi_names
[osabi
];
68 return gdb_osabi_names
[GDB_OSABI_INVALID
];
71 /* Handler for a given architecture/OS ABI pair. There should be only
72 one handler for a given OS ABI each architecture family. */
73 struct gdb_osabi_handler
75 struct gdb_osabi_handler
*next
;
76 const struct bfd_arch_info
*arch_info
;
78 void (*init_osabi
)(struct gdbarch_info
, struct gdbarch
*);
81 static struct gdb_osabi_handler
*gdb_osabi_handler_list
;
84 gdbarch_register_osabi (enum bfd_architecture arch
, unsigned long machine
,
86 void (*init_osabi
)(struct gdbarch_info
,
89 struct gdb_osabi_handler
**handler_p
;
90 const struct bfd_arch_info
*arch_info
= bfd_lookup_arch (arch
, machine
);
92 /* Registering an OS ABI handler for "unknown" is not allowed. */
93 if (osabi
== GDB_OSABI_UNKNOWN
)
97 "gdbarch_register_osabi: An attempt to register a handler for "
98 "OS ABI \"%s\" for architecture %s was made. The handler will "
100 gdbarch_osabi_name (osabi
),
101 bfd_printable_arch_mach (arch
, machine
));
105 gdb_assert (arch_info
);
107 for (handler_p
= &gdb_osabi_handler_list
; *handler_p
!= NULL
;
108 handler_p
= &(*handler_p
)->next
)
110 if ((*handler_p
)->arch_info
== arch_info
111 && (*handler_p
)->osabi
== osabi
)
115 "gdbarch_register_osabi: A handler for OS ABI \"%s\" "
116 "has already been registered for architecture %s",
117 gdbarch_osabi_name (osabi
),
118 arch_info
->printable_name
);
119 /* If user wants to continue, override previous definition. */
120 (*handler_p
)->init_osabi
= init_osabi
;
126 = (struct gdb_osabi_handler
*) xmalloc (sizeof (struct gdb_osabi_handler
));
127 (*handler_p
)->next
= NULL
;
128 (*handler_p
)->arch_info
= arch_info
;
129 (*handler_p
)->osabi
= osabi
;
130 (*handler_p
)->init_osabi
= init_osabi
;
134 /* Sniffer to find the OS ABI for a given file's architecture and flavour.
135 It is legal to have multiple sniffers for each arch/flavour pair, to
136 disambiguate one OS's a.out from another, for example. The first sniffer
137 to return something other than GDB_OSABI_UNKNOWN wins, so a sniffer should
138 be careful to claim a file only if it knows for sure what it is. */
139 struct gdb_osabi_sniffer
141 struct gdb_osabi_sniffer
*next
;
142 enum bfd_architecture arch
; /* bfd_arch_unknown == wildcard */
143 enum bfd_flavour flavour
;
144 enum gdb_osabi (*sniffer
)(bfd
*);
147 static struct gdb_osabi_sniffer
*gdb_osabi_sniffer_list
;
150 gdbarch_register_osabi_sniffer (enum bfd_architecture arch
,
151 enum bfd_flavour flavour
,
152 enum gdb_osabi (*sniffer_fn
)(bfd
*))
154 struct gdb_osabi_sniffer
*sniffer
;
157 (struct gdb_osabi_sniffer
*) xmalloc (sizeof (struct gdb_osabi_sniffer
));
158 sniffer
->arch
= arch
;
159 sniffer
->flavour
= flavour
;
160 sniffer
->sniffer
= sniffer_fn
;
162 sniffer
->next
= gdb_osabi_sniffer_list
;
163 gdb_osabi_sniffer_list
= sniffer
;
168 gdbarch_lookup_osabi (bfd
*abfd
)
170 struct gdb_osabi_sniffer
*sniffer
;
171 enum gdb_osabi osabi
, match
;
175 return GDB_OSABI_UNINITIALIZED
;
177 match
= GDB_OSABI_UNKNOWN
;
180 for (sniffer
= gdb_osabi_sniffer_list
; sniffer
!= NULL
;
181 sniffer
= sniffer
->next
)
183 if ((sniffer
->arch
== bfd_arch_unknown
/* wildcard */
184 || sniffer
->arch
== bfd_get_arch (abfd
))
185 && sniffer
->flavour
== bfd_get_flavour (abfd
))
187 osabi
= (*sniffer
->sniffer
) (abfd
);
188 if (osabi
< GDB_OSABI_UNKNOWN
|| osabi
>= GDB_OSABI_INVALID
)
192 "gdbarch_lookup_osabi: invalid OS ABI (%d) from sniffer "
193 "for architecture %s flavour %d",
195 bfd_printable_arch_mach (bfd_get_arch (abfd
), 0),
196 (int) bfd_get_flavour (abfd
));
198 else if (osabi
!= GDB_OSABI_UNKNOWN
)
200 /* A specific sniffer always overrides a generic sniffer.
201 Croak on multiple match if the two matches are of the
202 same class. If the user wishes to continue, we'll use
204 if (match
!= GDB_OSABI_UNKNOWN
)
206 if ((match_specific
&& sniffer
->arch
!= bfd_arch_unknown
)
207 || (!match_specific
&& sniffer
->arch
== bfd_arch_unknown
))
211 "gdbarch_lookup_osabi: multiple %sspecific OS ABI "
212 "match for architecture %s flavour %d: first "
213 "match \"%s\", second match \"%s\"",
214 match_specific
? "" : "non-",
215 bfd_printable_arch_mach (bfd_get_arch (abfd
), 0),
216 (int) bfd_get_flavour (abfd
),
217 gdbarch_osabi_name (match
),
218 gdbarch_osabi_name (osabi
));
220 else if (sniffer
->arch
!= bfd_arch_unknown
)
229 if (sniffer
->arch
!= bfd_arch_unknown
)
240 gdbarch_init_osabi (struct gdbarch_info info
, struct gdbarch
*gdbarch
)
242 const struct bfd_arch_info
*arch_info
= gdbarch_bfd_arch_info (gdbarch
);
243 const struct bfd_arch_info
*compatible
;
244 struct gdb_osabi_handler
*handler
;
246 if (info
.osabi
== GDB_OSABI_UNKNOWN
)
248 /* Don't complain about an unknown OSABI. Assume the user knows
249 what they are doing. */
253 for (handler
= gdb_osabi_handler_list
; handler
!= NULL
;
254 handler
= handler
->next
)
256 if (handler
->osabi
!= info
.osabi
)
259 /* Check whether the machine type and architecture of the
260 handler are compatible with the desired machine type and
263 NOTE: kettenis/20021027: There may be more than one machine
264 type that is compatible with the desired machine type. Right
265 now we simply return the first match, which is fine for now.
266 However, we might want to do something smarter in the future. */
267 compatible
= arch_info
->compatible (arch_info
, handler
->arch_info
);
268 if (compatible
== handler
->arch_info
)
270 (*handler
->init_osabi
) (info
, gdbarch
);
275 /* We assume that if GDB_MULTI_ARCH is less than GDB_MULTI_ARCH_TM
276 that an ABI variant can be supported by overriding definitions in
278 if (GDB_MULTI_ARCH
> GDB_MULTI_ARCH_PARTIAL
)
281 "A handler for the OS ABI \"%s\" is not built into this "
282 "configuration of GDB. "
283 "Attempting to continue with the default %s settings",
284 gdbarch_osabi_name (info
.osabi
),
285 bfd_printable_arch_mach (arch_info
->arch
, arch_info
->mach
));
289 /* Generic sniffer for ELF flavoured files. */
292 generic_elf_osabi_sniff_abi_tag_sections (bfd
*abfd
, asection
*sect
, void *obj
)
294 enum gdb_osabi
*os_ident_ptr
= obj
;
296 unsigned int sectsize
;
298 name
= bfd_get_section_name (abfd
, sect
);
299 sectsize
= bfd_section_size (abfd
, sect
);
301 /* .note.ABI-tag notes, used by GNU/Linux and FreeBSD. */
302 if (strcmp (name
, ".note.ABI-tag") == 0 && sectsize
> 0)
304 unsigned int name_length
, data_length
, note_type
;
307 /* If the section is larger than this, it's probably not what we are
312 note
= alloca (sectsize
);
314 bfd_get_section_contents (abfd
, sect
, note
,
315 (file_ptr
) 0, (bfd_size_type
) sectsize
);
317 name_length
= bfd_h_get_32 (abfd
, note
);
318 data_length
= bfd_h_get_32 (abfd
, note
+ 4);
319 note_type
= bfd_h_get_32 (abfd
, note
+ 8);
321 if (name_length
== 4 && data_length
== 16 && note_type
== NT_GNU_ABI_TAG
322 && strcmp (note
+ 12, "GNU") == 0)
324 int os_number
= bfd_h_get_32 (abfd
, note
+ 16);
328 case GNU_ABI_TAG_LINUX
:
329 *os_ident_ptr
= GDB_OSABI_LINUX
;
332 case GNU_ABI_TAG_HURD
:
333 *os_ident_ptr
= GDB_OSABI_HURD
;
336 case GNU_ABI_TAG_SOLARIS
:
337 *os_ident_ptr
= GDB_OSABI_SOLARIS
;
343 "generic_elf_osabi_sniff_abi_tag_sections: unknown OS number %d",
348 else if (name_length
== 8 && data_length
== 4
349 && note_type
== NT_FREEBSD_ABI_TAG
350 && strcmp (note
+ 12, "FreeBSD") == 0)
352 /* XXX Should we check the version here? Probably not
354 *os_ident_ptr
= GDB_OSABI_FREEBSD_ELF
;
359 /* .note.netbsd.ident notes, used by NetBSD. */
360 if (strcmp (name
, ".note.netbsd.ident") == 0 && sectsize
> 0)
362 unsigned int name_length
, data_length
, note_type
;
365 /* If the section is larger than this, it's probably not what we are
370 note
= alloca (sectsize
);
372 bfd_get_section_contents (abfd
, sect
, note
,
373 (file_ptr
) 0, (bfd_size_type
) sectsize
);
375 name_length
= bfd_h_get_32 (abfd
, note
);
376 data_length
= bfd_h_get_32 (abfd
, note
+ 4);
377 note_type
= bfd_h_get_32 (abfd
, note
+ 8);
379 if (name_length
== 7 && data_length
== 4 && note_type
== NT_NETBSD_IDENT
380 && strcmp (note
+ 12, "NetBSD") == 0)
382 /* XXX Should we check the version here? Probably not
384 *os_ident_ptr
= GDB_OSABI_NETBSD_ELF
;
390 static enum gdb_osabi
391 generic_elf_osabi_sniffer (bfd
*abfd
)
393 unsigned int elfosabi
;
394 enum gdb_osabi osabi
= GDB_OSABI_UNKNOWN
;
396 elfosabi
= elf_elfheader (abfd
)->e_ident
[EI_OSABI
];
401 /* When elfosabi is ELFOSABI_NONE (0), then the ELF structures in the
402 file are conforming to the base specification for that machine
403 (there are no OS-specific extensions). In order to determine the
404 real OS in use we must look for OS notes that have been added. */
405 bfd_map_over_sections (abfd
,
406 generic_elf_osabi_sniff_abi_tag_sections
,
410 case ELFOSABI_FREEBSD
:
411 osabi
= GDB_OSABI_FREEBSD_ELF
;
414 case ELFOSABI_NETBSD
:
415 osabi
= GDB_OSABI_NETBSD_ELF
;
419 osabi
= GDB_OSABI_LINUX
;
423 osabi
= GDB_OSABI_HURD
;
426 case ELFOSABI_SOLARIS
:
427 osabi
= GDB_OSABI_SOLARIS
;
431 osabi
= GDB_OSABI_HPUX_ELF
;
435 if (osabi
== GDB_OSABI_UNKNOWN
)
437 /* The FreeBSD folks have been naughty; they stored the string
438 "FreeBSD" in the padding of the e_ident field of the ELF
439 header to "brand" their ELF binaries in FreeBSD 3.x. */
440 if (strcmp (&elf_elfheader (abfd
)->e_ident
[8], "FreeBSD") == 0)
441 osabi
= GDB_OSABI_FREEBSD_ELF
;
449 _initialize_gdb_osabi (void)
451 if (strcmp (gdb_osabi_names
[GDB_OSABI_INVALID
], "<invalid>") != 0)
454 "_initialize_gdb_osabi: gdb_osabi_names[] is inconsistent");
456 /* Register a generic sniffer for ELF flavoured files. */
457 gdbarch_register_osabi_sniffer (bfd_arch_unknown
,
458 bfd_target_elf_flavour
,
459 generic_elf_osabi_sniffer
);