1 /* OS ABI variant handling for GDB.
3 Copyright (C) 2001-2017 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
23 #include "arch-utils.h"
29 #ifndef GDB_OSABI_DEFAULT
30 #define GDB_OSABI_DEFAULT GDB_OSABI_UNKNOWN
33 /* State for the "set osabi" command. */
34 static enum { osabi_auto, osabi_default, osabi_user } user_osabi_state;
35 static enum gdb_osabi user_selected_osabi;
36 static const char *gdb_osabi_available_names[GDB_OSABI_INVALID + 3] = {
42 static const char *set_osabi_string;
44 /* Names associated with each osabi. */
48 /* The "pretty" name. */
52 /* The triplet regexp, or NULL if not known. */
57 /* This table matches the indices assigned to enum gdb_osabi. Keep
59 static const struct osabi_names gdb_osabi_names[] =
66 { "GNU/Linux", "linux(-gnu)?" },
70 { "WindowsCE", NULL },
72 { "QNX-Neutrino", NULL },
79 { "LynxOS178", NULL },
87 gdbarch_osabi_name (enum gdb_osabi osabi)
89 if (osabi >= GDB_OSABI_UNKNOWN && osabi < GDB_OSABI_INVALID)
90 return gdb_osabi_names[osabi].pretty;
92 return gdb_osabi_names[GDB_OSABI_INVALID].pretty;
98 osabi_triplet_regexp (enum gdb_osabi osabi)
100 if (osabi >= GDB_OSABI_UNKNOWN && osabi < GDB_OSABI_INVALID)
101 return gdb_osabi_names[osabi].regexp;
103 return gdb_osabi_names[GDB_OSABI_INVALID].regexp;
106 /* Lookup the OS ABI corresponding to the specified target description
110 osabi_from_tdesc_string (const char *name)
114 for (i = 0; i < ARRAY_SIZE (gdb_osabi_names); i++)
115 if (strcmp (name, gdb_osabi_names[i].pretty) == 0)
117 /* See note above: the name table matches the indices assigned
118 to enum gdb_osabi. */
119 enum gdb_osabi osabi = (enum gdb_osabi) i;
121 if (osabi == GDB_OSABI_INVALID)
122 return GDB_OSABI_UNKNOWN;
127 return GDB_OSABI_UNKNOWN;
130 /* Handler for a given architecture/OS ABI pair. There should be only
131 one handler for a given OS ABI each architecture family. */
132 struct gdb_osabi_handler
134 struct gdb_osabi_handler *next;
135 const struct bfd_arch_info *arch_info;
136 enum gdb_osabi osabi;
137 void (*init_osabi)(struct gdbarch_info, struct gdbarch *);
140 static struct gdb_osabi_handler *gdb_osabi_handler_list;
143 gdbarch_register_osabi (enum bfd_architecture arch, unsigned long machine,
144 enum gdb_osabi osabi,
145 void (*init_osabi)(struct gdbarch_info,
148 struct gdb_osabi_handler **handler_p;
149 const struct bfd_arch_info *arch_info = bfd_lookup_arch (arch, machine);
150 const char **name_ptr;
152 /* Registering an OS ABI handler for "unknown" is not allowed. */
153 if (osabi == GDB_OSABI_UNKNOWN)
157 _("gdbarch_register_osabi: An attempt to register a handler for "
158 "OS ABI \"%s\" for architecture %s was made. The handler will "
159 "not be registered"),
160 gdbarch_osabi_name (osabi),
161 bfd_printable_arch_mach (arch, machine));
165 gdb_assert (arch_info);
167 for (handler_p = &gdb_osabi_handler_list; *handler_p != NULL;
168 handler_p = &(*handler_p)->next)
170 if ((*handler_p)->arch_info == arch_info
171 && (*handler_p)->osabi == osabi)
175 _("gdbarch_register_osabi: A handler for OS ABI \"%s\" "
176 "has already been registered for architecture %s"),
177 gdbarch_osabi_name (osabi),
178 arch_info->printable_name);
179 /* If user wants to continue, override previous definition. */
180 (*handler_p)->init_osabi = init_osabi;
185 (*handler_p) = XNEW (struct gdb_osabi_handler);
186 (*handler_p)->next = NULL;
187 (*handler_p)->arch_info = arch_info;
188 (*handler_p)->osabi = osabi;
189 (*handler_p)->init_osabi = init_osabi;
191 /* Add this OS ABI to the list of enum values for "set osabi", if it isn't
193 for (name_ptr = gdb_osabi_available_names; *name_ptr; name_ptr ++)
195 if (*name_ptr == gdbarch_osabi_name (osabi))
198 *name_ptr++ = gdbarch_osabi_name (osabi);
203 /* Sniffer to find the OS ABI for a given file's architecture and flavour.
204 It is legal to have multiple sniffers for each arch/flavour pair, to
205 disambiguate one OS's a.out from another, for example. The first sniffer
206 to return something other than GDB_OSABI_UNKNOWN wins, so a sniffer should
207 be careful to claim a file only if it knows for sure what it is. */
208 struct gdb_osabi_sniffer
210 struct gdb_osabi_sniffer *next;
211 enum bfd_architecture arch; /* bfd_arch_unknown == wildcard */
212 enum bfd_flavour flavour;
213 enum gdb_osabi (*sniffer)(bfd *);
216 static struct gdb_osabi_sniffer *gdb_osabi_sniffer_list;
219 gdbarch_register_osabi_sniffer (enum bfd_architecture arch,
220 enum bfd_flavour flavour,
221 enum gdb_osabi (*sniffer_fn)(bfd *))
223 struct gdb_osabi_sniffer *sniffer;
225 sniffer = XNEW (struct gdb_osabi_sniffer);
226 sniffer->arch = arch;
227 sniffer->flavour = flavour;
228 sniffer->sniffer = sniffer_fn;
230 sniffer->next = gdb_osabi_sniffer_list;
231 gdb_osabi_sniffer_list = sniffer;
236 gdbarch_lookup_osabi (bfd *abfd)
238 struct gdb_osabi_sniffer *sniffer;
239 enum gdb_osabi osabi, match;
242 /* If we aren't in "auto" mode, return the specified OS ABI. */
243 if (user_osabi_state == osabi_user)
244 return user_selected_osabi;
246 /* If we don't have a binary, just return unknown. The caller may
247 have other sources the OSABI can be extracted from, e.g., the
248 target description. */
250 return GDB_OSABI_UNKNOWN;
252 match = GDB_OSABI_UNKNOWN;
255 for (sniffer = gdb_osabi_sniffer_list; sniffer != NULL;
256 sniffer = sniffer->next)
258 if ((sniffer->arch == bfd_arch_unknown /* wildcard */
259 || sniffer->arch == bfd_get_arch (abfd))
260 && sniffer->flavour == bfd_get_flavour (abfd))
262 osabi = (*sniffer->sniffer) (abfd);
263 if (osabi < GDB_OSABI_UNKNOWN || osabi >= GDB_OSABI_INVALID)
267 _("gdbarch_lookup_osabi: invalid OS ABI (%d) from sniffer "
268 "for architecture %s flavour %d"),
270 bfd_printable_arch_mach (bfd_get_arch (abfd), 0),
271 (int) bfd_get_flavour (abfd));
273 else if (osabi != GDB_OSABI_UNKNOWN)
275 /* A specific sniffer always overrides a generic sniffer.
276 Croak on multiple match if the two matches are of the
277 same class. If the user wishes to continue, we'll use
279 if (match != GDB_OSABI_UNKNOWN)
281 if ((match_specific && sniffer->arch != bfd_arch_unknown)
282 || (!match_specific && sniffer->arch == bfd_arch_unknown))
286 _("gdbarch_lookup_osabi: multiple %sspecific OS ABI "
287 "match for architecture %s flavour %d: first "
288 "match \"%s\", second match \"%s\""),
289 match_specific ? "" : "non-",
290 bfd_printable_arch_mach (bfd_get_arch (abfd), 0),
291 (int) bfd_get_flavour (abfd),
292 gdbarch_osabi_name (match),
293 gdbarch_osabi_name (osabi));
295 else if (sniffer->arch != bfd_arch_unknown)
304 if (sniffer->arch != bfd_arch_unknown)
315 /* Return non-zero if architecture A can run code written for
318 can_run_code_for (const struct bfd_arch_info *a, const struct bfd_arch_info *b)
320 /* BFD's 'A->compatible (A, B)' functions return zero if A and B are
321 incompatible. But if they are compatible, it returns the 'more
322 featureful' of the two arches. That is, if A can run code
323 written for B, but B can't run code written for A, then it'll
326 struct bfd_arch_info objects are singletons: that is, there's
327 supposed to be exactly one instance for a given machine. So you
328 can tell whether two are equivalent by comparing pointers. */
329 return (a == b || a->compatible (a, b) == a);
334 gdbarch_init_osabi (struct gdbarch_info info, struct gdbarch *gdbarch)
336 struct gdb_osabi_handler *handler;
338 if (info.osabi == GDB_OSABI_UNKNOWN)
340 /* Don't complain about an unknown OSABI. Assume the user knows
341 what they are doing. */
345 for (handler = gdb_osabi_handler_list; handler != NULL;
346 handler = handler->next)
348 if (handler->osabi != info.osabi)
351 /* If the architecture described by ARCH_INFO can run code for
352 the architcture we registered the handler for, then the
353 handler is applicable. Note, though, that if the handler is
354 for an architecture that is a superset of ARCH_INFO, we can't
355 use that --- it would be perfectly correct for it to install
356 gdbarch methods that refer to registers / instructions /
357 other facilities ARCH_INFO doesn't have.
359 NOTE: kettenis/20021027: There may be more than one machine
360 type that is compatible with the desired machine type. Right
361 now we simply return the first match, which is fine for now.
362 However, we might want to do something smarter in the future. */
363 /* NOTE: cagney/2003-10-23: The code for "a can_run_code_for b"
364 is implemented using BFD's compatible method (a->compatible
365 (b) == a -- the lowest common denominator between a and b is
366 a). That method's definition of compatible may not be as you
367 expect. For instance the test "amd64 can run code for i386"
368 (or more generally "64-bit ISA can run code for the 32-bit
369 ISA"). BFD doesn't normally consider 32-bit and 64-bit
370 "compatible" so it doesn't succeed. */
371 if (can_run_code_for (info.bfd_arch_info, handler->arch_info))
373 (*handler->init_osabi) (info, gdbarch);
379 ("A handler for the OS ABI \"%s\" is not built into this configuration\n"
380 "of GDB. Attempting to continue with the default %s settings.\n",
381 gdbarch_osabi_name (info.osabi),
382 info.bfd_arch_info->printable_name);
385 /* Limit on the amount of data to be read. */
386 #define MAX_NOTESZ 128
388 /* Return non-zero if NOTE matches NAME, DESCSZ and TYPE. If
389 *SECTSIZE is non-zero, then this reads that many bytes from
390 the start of the section and clears *SECTSIZE. */
393 check_note (bfd *abfd, asection *sect, char *note, unsigned int *sectsize,
394 const char *name, unsigned long descsz, unsigned long type)
396 unsigned long notesz;
400 if (!bfd_get_section_contents (abfd, sect, note, 0, *sectsize))
405 /* Calculate the size of this note. */
406 notesz = strlen (name) + 1;
407 notesz = ((notesz + 3) & ~3);
409 notesz = ((notesz + 3) & ~3);
411 /* If this assertion triggers, increase MAX_NOTESZ. */
412 gdb_assert (notesz <= MAX_NOTESZ);
414 /* Check whether SECT is big enough to comtain the complete note. */
415 if (notesz > bfd_section_size (abfd, sect))
418 /* Check the note name. */
419 if (bfd_h_get_32 (abfd, note) != (strlen (name) + 1)
420 || strcmp (note + 12, name) != 0)
423 /* Check the descriptor size. */
424 if (bfd_h_get_32 (abfd, note + 4) != descsz)
427 /* Check the note type. */
428 if (bfd_h_get_32 (abfd, note + 8) != type)
434 /* Generic sniffer for ELF flavoured files. */
437 generic_elf_osabi_sniff_abi_tag_sections (bfd *abfd, asection *sect, void *obj)
439 enum gdb_osabi *osabi = (enum gdb_osabi *) obj;
441 unsigned int sectsize;
444 name = bfd_get_section_name (abfd, sect);
445 sectsize = bfd_section_size (abfd, sect);
447 /* Limit the amount of data to read. */
448 if (sectsize > MAX_NOTESZ)
449 sectsize = MAX_NOTESZ;
451 /* We lazily read the section data here. Since we use
452 BFD_DECOMPRESS, we can't use bfd_get_section_contents on a
453 compressed section. But, since note sections are not compressed,
454 deferring the reading until we recognize the section avoids any
456 note = (char *) alloca (sectsize);
458 /* .note.ABI-tag notes, used by GNU/Linux and FreeBSD. */
459 if (strcmp (name, ".note.ABI-tag") == 0)
462 if (check_note (abfd, sect, note, §size, "GNU", 16, NT_GNU_ABI_TAG))
464 unsigned int abi_tag = bfd_h_get_32 (abfd, note + 16);
468 case GNU_ABI_TAG_LINUX:
469 *osabi = GDB_OSABI_LINUX;
472 case GNU_ABI_TAG_HURD:
473 *osabi = GDB_OSABI_HURD;
476 case GNU_ABI_TAG_SOLARIS:
477 *osabi = GDB_OSABI_SOLARIS;
480 case GNU_ABI_TAG_FREEBSD:
481 *osabi = GDB_OSABI_FREEBSD;
484 case GNU_ABI_TAG_NETBSD:
485 *osabi = GDB_OSABI_NETBSD;
489 warning (_("GNU ABI tag value %u unrecognized."), abi_tag);
496 if (check_note (abfd, sect, note, §size, "FreeBSD", 4,
499 /* There is no need to check the version yet. */
500 *osabi = GDB_OSABI_FREEBSD;
507 /* .note.netbsd.ident notes, used by NetBSD. */
508 if (strcmp (name, ".note.netbsd.ident") == 0
509 && check_note (abfd, sect, note, §size, "NetBSD", 4, NT_NETBSD_IDENT))
511 /* There is no need to check the version yet. */
512 *osabi = GDB_OSABI_NETBSD;
516 /* .note.openbsd.ident notes, used by OpenBSD. */
517 if (strcmp (name, ".note.openbsd.ident") == 0
518 && check_note (abfd, sect, note, §size, "OpenBSD", 4,
521 /* There is no need to check the version yet. */
522 *osabi = GDB_OSABI_OPENBSD;
526 /* .note.netbsdcore.procinfo notes, used by NetBSD. */
527 if (strcmp (name, ".note.netbsdcore.procinfo") == 0)
529 *osabi = GDB_OSABI_NETBSD;
534 static enum gdb_osabi
535 generic_elf_osabi_sniffer (bfd *abfd)
537 unsigned int elfosabi;
538 enum gdb_osabi osabi = GDB_OSABI_UNKNOWN;
540 elfosabi = elf_elfheader (abfd)->e_ident[EI_OSABI];
547 /* When the EI_OSABI field in the ELF header is ELFOSABI_NONE
548 (0), then the ELF structures in the file are conforming to
549 the base specification for that machine (there are no
550 OS-specific extensions). In order to determine the real OS
551 in use, we must look for OS-specific notes.
553 The same applies for ELFOSABI_GNU: this can mean GNU/Hurd,
554 GNU/Linux, and possibly more. */
556 /* And likewise ELFOSABI_HPUX. For some reason the default
557 value for the EI_OSABI field is ELFOSABI_HPUX for all PA-RISC
558 targets (with the exception of GNU/Linux). */
559 bfd_map_over_sections (abfd,
560 generic_elf_osabi_sniff_abi_tag_sections,
564 case ELFOSABI_FREEBSD:
565 osabi = GDB_OSABI_FREEBSD;
568 case ELFOSABI_NETBSD:
569 osabi = GDB_OSABI_NETBSD;
572 case ELFOSABI_SOLARIS:
573 osabi = GDB_OSABI_SOLARIS;
576 case ELFOSABI_OPENVMS:
577 osabi = GDB_OSABI_OPENVMS;
581 if (osabi == GDB_OSABI_UNKNOWN)
583 /* The FreeBSD folks have been naughty; they stored the string
584 "FreeBSD" in the padding of the e_ident field of the ELF
585 header to "brand" their ELF binaries in FreeBSD 3.x. */
586 if (memcmp (&elf_elfheader (abfd)->e_ident[8],
587 "FreeBSD", sizeof ("FreeBSD")) == 0)
588 osabi = GDB_OSABI_FREEBSD;
595 set_osabi (char *args, int from_tty, struct cmd_list_element *c)
597 struct gdbarch_info info;
599 if (strcmp (set_osabi_string, "auto") == 0)
600 user_osabi_state = osabi_auto;
601 else if (strcmp (set_osabi_string, "default") == 0)
603 user_selected_osabi = GDB_OSABI_DEFAULT;
604 user_osabi_state = osabi_user;
606 else if (strcmp (set_osabi_string, "none") == 0)
608 user_selected_osabi = GDB_OSABI_UNKNOWN;
609 user_osabi_state = osabi_user;
615 for (i = 1; i < GDB_OSABI_INVALID; i++)
617 enum gdb_osabi osabi = (enum gdb_osabi) i;
619 if (strcmp (set_osabi_string, gdbarch_osabi_name (osabi)) == 0)
621 user_selected_osabi = osabi;
622 user_osabi_state = osabi_user;
626 if (i == GDB_OSABI_INVALID)
627 internal_error (__FILE__, __LINE__,
628 _("Invalid OS ABI \"%s\" passed to command handler."),
632 /* NOTE: At some point (true multiple architectures) we'll need to be more
634 gdbarch_info_init (&info);
635 if (! gdbarch_update_p (info))
636 internal_error (__FILE__, __LINE__, _("Updating OS ABI failed."));
640 show_osabi (struct ui_file *file, int from_tty, struct cmd_list_element *c,
643 if (user_osabi_state == osabi_auto)
644 fprintf_filtered (file,
645 _("The current OS ABI is \"auto\" "
646 "(currently \"%s\").\n"),
647 gdbarch_osabi_name (gdbarch_osabi (get_current_arch ())));
649 fprintf_filtered (file, _("The current OS ABI is \"%s\".\n"),
650 gdbarch_osabi_name (user_selected_osabi));
652 if (GDB_OSABI_DEFAULT != GDB_OSABI_UNKNOWN)
653 fprintf_filtered (file, _("The default OS ABI is \"%s\".\n"),
654 gdbarch_osabi_name (GDB_OSABI_DEFAULT));
657 extern initialize_file_ftype _initialize_gdb_osabi; /* -Wmissing-prototype */
660 _initialize_gdb_osabi (void)
662 if (strcmp (gdb_osabi_names[GDB_OSABI_INVALID].pretty, "<invalid>") != 0)
665 _("_initialize_gdb_osabi: gdb_osabi_names[] is inconsistent"));
667 /* Register a generic sniffer for ELF flavoured files. */
668 gdbarch_register_osabi_sniffer (bfd_arch_unknown,
669 bfd_target_elf_flavour,
670 generic_elf_osabi_sniffer);
672 /* Register the "set osabi" command. */
673 add_setshow_enum_cmd ("osabi", class_support, gdb_osabi_available_names,
675 _("Set OS ABI of target."),
676 _("Show OS ABI of target."),
677 NULL, set_osabi, show_osabi,
678 &setlist, &showlist);
679 user_osabi_state = osabi_auto;