1 /* OS ABI variant handling for GDB.
3 Copyright (C) 2001-2018 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[] =
67 { "GNU/Linux", "linux(-gnu[^-]*)?" },
71 { "WindowsCE", NULL },
73 { "QNX-Neutrino", NULL },
80 { "LynxOS178", NULL },
88 gdbarch_osabi_name (enum gdb_osabi osabi)
90 if (osabi >= GDB_OSABI_UNKNOWN && osabi < GDB_OSABI_INVALID)
91 return gdb_osabi_names[osabi].pretty;
93 return gdb_osabi_names[GDB_OSABI_INVALID].pretty;
99 osabi_triplet_regexp (enum gdb_osabi osabi)
101 if (osabi >= GDB_OSABI_UNKNOWN && osabi < GDB_OSABI_INVALID)
102 return gdb_osabi_names[osabi].regexp;
104 return gdb_osabi_names[GDB_OSABI_INVALID].regexp;
107 /* Lookup the OS ABI corresponding to the specified target description
111 osabi_from_tdesc_string (const char *name)
115 for (i = 0; i < ARRAY_SIZE (gdb_osabi_names); i++)
116 if (strcmp (name, gdb_osabi_names[i].pretty) == 0)
118 /* See note above: the name table matches the indices assigned
119 to enum gdb_osabi. */
120 enum gdb_osabi osabi = (enum gdb_osabi) i;
122 if (osabi == GDB_OSABI_INVALID)
123 return GDB_OSABI_UNKNOWN;
128 return GDB_OSABI_UNKNOWN;
131 /* Handler for a given architecture/OS ABI pair. There should be only
132 one handler for a given OS ABI each architecture family. */
133 struct gdb_osabi_handler
135 struct gdb_osabi_handler *next;
136 const struct bfd_arch_info *arch_info;
137 enum gdb_osabi osabi;
138 void (*init_osabi)(struct gdbarch_info, struct gdbarch *);
141 static struct gdb_osabi_handler *gdb_osabi_handler_list;
144 gdbarch_register_osabi (enum bfd_architecture arch, unsigned long machine,
145 enum gdb_osabi osabi,
146 void (*init_osabi)(struct gdbarch_info,
149 struct gdb_osabi_handler **handler_p;
150 const struct bfd_arch_info *arch_info = bfd_lookup_arch (arch, machine);
151 const char **name_ptr;
153 /* Registering an OS ABI handler for "unknown" is not allowed. */
154 if (osabi == GDB_OSABI_UNKNOWN)
158 _("gdbarch_register_osabi: An attempt to register a handler for "
159 "OS ABI \"%s\" for architecture %s was made. The handler will "
160 "not be registered"),
161 gdbarch_osabi_name (osabi),
162 bfd_printable_arch_mach (arch, machine));
166 gdb_assert (arch_info);
168 for (handler_p = &gdb_osabi_handler_list; *handler_p != NULL;
169 handler_p = &(*handler_p)->next)
171 if ((*handler_p)->arch_info == arch_info
172 && (*handler_p)->osabi == osabi)
176 _("gdbarch_register_osabi: A handler for OS ABI \"%s\" "
177 "has already been registered for architecture %s"),
178 gdbarch_osabi_name (osabi),
179 arch_info->printable_name);
180 /* If user wants to continue, override previous definition. */
181 (*handler_p)->init_osabi = init_osabi;
186 (*handler_p) = XNEW (struct gdb_osabi_handler);
187 (*handler_p)->next = NULL;
188 (*handler_p)->arch_info = arch_info;
189 (*handler_p)->osabi = osabi;
190 (*handler_p)->init_osabi = init_osabi;
192 /* Add this OS ABI to the list of enum values for "set osabi", if it isn't
194 for (name_ptr = gdb_osabi_available_names; *name_ptr; name_ptr ++)
196 if (*name_ptr == gdbarch_osabi_name (osabi))
199 *name_ptr++ = gdbarch_osabi_name (osabi);
204 /* Sniffer to find the OS ABI for a given file's architecture and flavour.
205 It is legal to have multiple sniffers for each arch/flavour pair, to
206 disambiguate one OS's a.out from another, for example. The first sniffer
207 to return something other than GDB_OSABI_UNKNOWN wins, so a sniffer should
208 be careful to claim a file only if it knows for sure what it is. */
209 struct gdb_osabi_sniffer
211 struct gdb_osabi_sniffer *next;
212 enum bfd_architecture arch; /* bfd_arch_unknown == wildcard */
213 enum bfd_flavour flavour;
214 enum gdb_osabi (*sniffer)(bfd *);
217 static struct gdb_osabi_sniffer *gdb_osabi_sniffer_list;
220 gdbarch_register_osabi_sniffer (enum bfd_architecture arch,
221 enum bfd_flavour flavour,
222 enum gdb_osabi (*sniffer_fn)(bfd *))
224 struct gdb_osabi_sniffer *sniffer;
226 sniffer = XNEW (struct gdb_osabi_sniffer);
227 sniffer->arch = arch;
228 sniffer->flavour = flavour;
229 sniffer->sniffer = sniffer_fn;
231 sniffer->next = gdb_osabi_sniffer_list;
232 gdb_osabi_sniffer_list = sniffer;
237 gdbarch_lookup_osabi (bfd *abfd)
239 struct gdb_osabi_sniffer *sniffer;
240 enum gdb_osabi osabi, match;
243 /* If we aren't in "auto" mode, return the specified OS ABI. */
244 if (user_osabi_state == osabi_user)
245 return user_selected_osabi;
247 /* If we don't have a binary, just return unknown. The caller may
248 have other sources the OSABI can be extracted from, e.g., the
249 target description. */
251 return GDB_OSABI_UNKNOWN;
253 match = GDB_OSABI_UNKNOWN;
256 for (sniffer = gdb_osabi_sniffer_list; sniffer != NULL;
257 sniffer = sniffer->next)
259 if ((sniffer->arch == bfd_arch_unknown /* wildcard */
260 || sniffer->arch == bfd_get_arch (abfd))
261 && sniffer->flavour == bfd_get_flavour (abfd))
263 osabi = (*sniffer->sniffer) (abfd);
264 if (osabi < GDB_OSABI_UNKNOWN || osabi >= GDB_OSABI_INVALID)
268 _("gdbarch_lookup_osabi: invalid OS ABI (%d) from sniffer "
269 "for architecture %s flavour %d"),
271 bfd_printable_arch_mach (bfd_get_arch (abfd), 0),
272 (int) bfd_get_flavour (abfd));
274 else if (osabi != GDB_OSABI_UNKNOWN)
276 /* A specific sniffer always overrides a generic sniffer.
277 Croak on multiple match if the two matches are of the
278 same class. If the user wishes to continue, we'll use
280 if (match != GDB_OSABI_UNKNOWN)
282 if ((match_specific && sniffer->arch != bfd_arch_unknown)
283 || (!match_specific && sniffer->arch == bfd_arch_unknown))
287 _("gdbarch_lookup_osabi: multiple %sspecific OS ABI "
288 "match for architecture %s flavour %d: first "
289 "match \"%s\", second match \"%s\""),
290 match_specific ? "" : "non-",
291 bfd_printable_arch_mach (bfd_get_arch (abfd), 0),
292 (int) bfd_get_flavour (abfd),
293 gdbarch_osabi_name (match),
294 gdbarch_osabi_name (osabi));
296 else if (sniffer->arch != bfd_arch_unknown)
305 if (sniffer->arch != bfd_arch_unknown)
316 /* Return non-zero if architecture A can run code written for
319 can_run_code_for (const struct bfd_arch_info *a, const struct bfd_arch_info *b)
321 /* BFD's 'A->compatible (A, B)' functions return zero if A and B are
322 incompatible. But if they are compatible, it returns the 'more
323 featureful' of the two arches. That is, if A can run code
324 written for B, but B can't run code written for A, then it'll
327 struct bfd_arch_info objects are singletons: that is, there's
328 supposed to be exactly one instance for a given machine. So you
329 can tell whether two are equivalent by comparing pointers. */
330 return (a == b || a->compatible (a, b) == a);
335 gdbarch_init_osabi (struct gdbarch_info info, struct gdbarch *gdbarch)
337 struct gdb_osabi_handler *handler;
339 gdb_assert (info.osabi != GDB_OSABI_UNKNOWN);
341 for (handler = gdb_osabi_handler_list; handler != NULL;
342 handler = handler->next)
344 if (handler->osabi != info.osabi)
347 /* If the architecture described by ARCH_INFO can run code for
348 the architcture we registered the handler for, then the
349 handler is applicable. Note, though, that if the handler is
350 for an architecture that is a superset of ARCH_INFO, we can't
351 use that --- it would be perfectly correct for it to install
352 gdbarch methods that refer to registers / instructions /
353 other facilities ARCH_INFO doesn't have.
355 NOTE: kettenis/20021027: There may be more than one machine
356 type that is compatible with the desired machine type. Right
357 now we simply return the first match, which is fine for now.
358 However, we might want to do something smarter in the future. */
359 /* NOTE: cagney/2003-10-23: The code for "a can_run_code_for b"
360 is implemented using BFD's compatible method (a->compatible
361 (b) == a -- the lowest common denominator between a and b is
362 a). That method's definition of compatible may not be as you
363 expect. For instance the test "amd64 can run code for i386"
364 (or more generally "64-bit ISA can run code for the 32-bit
365 ISA"). BFD doesn't normally consider 32-bit and 64-bit
366 "compatible" so it doesn't succeed. */
367 if (can_run_code_for (info.bfd_arch_info, handler->arch_info))
369 (*handler->init_osabi) (info, gdbarch);
374 if (info.osabi == GDB_OSABI_NONE)
376 /* Don't complain about no OSABI. Assume the user knows
377 what they are doing. */
382 ("A handler for the OS ABI \"%s\" is not built into this configuration\n"
383 "of GDB. Attempting to continue with the default %s settings.\n",
384 gdbarch_osabi_name (info.osabi),
385 info.bfd_arch_info->printable_name);
388 /* Limit on the amount of data to be read. */
389 #define MAX_NOTESZ 128
391 /* Return non-zero if NOTE matches NAME, DESCSZ and TYPE. If
392 *SECTSIZE is non-zero, then this reads that many bytes from
393 the start of the section and clears *SECTSIZE. */
396 check_note (bfd *abfd, asection *sect, char *note, unsigned int *sectsize,
397 const char *name, unsigned long descsz, unsigned long type)
399 unsigned long notesz;
403 if (!bfd_get_section_contents (abfd, sect, note, 0, *sectsize))
408 /* Calculate the size of this note. */
409 notesz = strlen (name) + 1;
410 notesz = ((notesz + 3) & ~3);
412 notesz = ((notesz + 3) & ~3);
414 /* If this assertion triggers, increase MAX_NOTESZ. */
415 gdb_assert (notesz <= MAX_NOTESZ);
417 /* Check whether SECT is big enough to comtain the complete note. */
418 if (notesz > bfd_section_size (abfd, sect))
421 /* Check the note name. */
422 if (bfd_h_get_32 (abfd, note) != (strlen (name) + 1)
423 || strcmp (note + 12, name) != 0)
426 /* Check the descriptor size. */
427 if (bfd_h_get_32 (abfd, note + 4) != descsz)
430 /* Check the note type. */
431 if (bfd_h_get_32 (abfd, note + 8) != type)
437 /* Generic sniffer for ELF flavoured files. */
440 generic_elf_osabi_sniff_abi_tag_sections (bfd *abfd, asection *sect, void *obj)
442 enum gdb_osabi *osabi = (enum gdb_osabi *) obj;
444 unsigned int sectsize;
447 name = bfd_get_section_name (abfd, sect);
448 sectsize = bfd_section_size (abfd, sect);
450 /* Limit the amount of data to read. */
451 if (sectsize > MAX_NOTESZ)
452 sectsize = MAX_NOTESZ;
454 /* We lazily read the section data here. Since we use
455 BFD_DECOMPRESS, we can't use bfd_get_section_contents on a
456 compressed section. But, since note sections are not compressed,
457 deferring the reading until we recognize the section avoids any
459 note = (char *) alloca (sectsize);
461 /* .note.ABI-tag notes, used by GNU/Linux and FreeBSD. */
462 if (strcmp (name, ".note.ABI-tag") == 0)
465 if (check_note (abfd, sect, note, §size, "GNU", 16, NT_GNU_ABI_TAG))
467 unsigned int abi_tag = bfd_h_get_32 (abfd, note + 16);
471 case GNU_ABI_TAG_LINUX:
472 *osabi = GDB_OSABI_LINUX;
475 case GNU_ABI_TAG_HURD:
476 *osabi = GDB_OSABI_HURD;
479 case GNU_ABI_TAG_SOLARIS:
480 *osabi = GDB_OSABI_SOLARIS;
483 case GNU_ABI_TAG_FREEBSD:
484 *osabi = GDB_OSABI_FREEBSD;
487 case GNU_ABI_TAG_NETBSD:
488 *osabi = GDB_OSABI_NETBSD;
492 warning (_("GNU ABI tag value %u unrecognized."), abi_tag);
499 if (check_note (abfd, sect, note, §size, "FreeBSD", 4,
502 /* There is no need to check the version yet. */
503 *osabi = GDB_OSABI_FREEBSD;
510 /* .note.netbsd.ident notes, used by NetBSD. */
511 if (strcmp (name, ".note.netbsd.ident") == 0
512 && check_note (abfd, sect, note, §size, "NetBSD", 4, NT_NETBSD_IDENT))
514 /* There is no need to check the version yet. */
515 *osabi = GDB_OSABI_NETBSD;
519 /* .note.openbsd.ident notes, used by OpenBSD. */
520 if (strcmp (name, ".note.openbsd.ident") == 0
521 && check_note (abfd, sect, note, §size, "OpenBSD", 4,
524 /* There is no need to check the version yet. */
525 *osabi = GDB_OSABI_OPENBSD;
529 /* .note.netbsdcore.procinfo notes, used by NetBSD. */
530 if (strcmp (name, ".note.netbsdcore.procinfo") == 0)
532 *osabi = GDB_OSABI_NETBSD;
537 static enum gdb_osabi
538 generic_elf_osabi_sniffer (bfd *abfd)
540 unsigned int elfosabi;
541 enum gdb_osabi osabi = GDB_OSABI_UNKNOWN;
543 elfosabi = elf_elfheader (abfd)->e_ident[EI_OSABI];
550 /* When the EI_OSABI field in the ELF header is ELFOSABI_NONE
551 (0), then the ELF structures in the file are conforming to
552 the base specification for that machine (there are no
553 OS-specific extensions). In order to determine the real OS
554 in use, we must look for OS-specific notes.
556 The same applies for ELFOSABI_GNU: this can mean GNU/Hurd,
557 GNU/Linux, and possibly more. */
559 /* And likewise ELFOSABI_HPUX. For some reason the default
560 value for the EI_OSABI field is ELFOSABI_HPUX for all PA-RISC
561 targets (with the exception of GNU/Linux). */
562 bfd_map_over_sections (abfd,
563 generic_elf_osabi_sniff_abi_tag_sections,
567 case ELFOSABI_FREEBSD:
568 osabi = GDB_OSABI_FREEBSD;
571 case ELFOSABI_NETBSD:
572 osabi = GDB_OSABI_NETBSD;
575 case ELFOSABI_SOLARIS:
576 osabi = GDB_OSABI_SOLARIS;
579 case ELFOSABI_OPENVMS:
580 osabi = GDB_OSABI_OPENVMS;
584 if (osabi == GDB_OSABI_UNKNOWN)
586 /* The FreeBSD folks have been naughty; they stored the string
587 "FreeBSD" in the padding of the e_ident field of the ELF
588 header to "brand" their ELF binaries in FreeBSD 3.x. */
589 if (memcmp (&elf_elfheader (abfd)->e_ident[8],
590 "FreeBSD", sizeof ("FreeBSD")) == 0)
591 osabi = GDB_OSABI_FREEBSD;
598 set_osabi (const char *args, int from_tty, struct cmd_list_element *c)
600 struct gdbarch_info info;
602 if (strcmp (set_osabi_string, "auto") == 0)
603 user_osabi_state = osabi_auto;
604 else if (strcmp (set_osabi_string, "default") == 0)
606 user_selected_osabi = GDB_OSABI_DEFAULT;
607 user_osabi_state = osabi_user;
613 for (i = 1; i < GDB_OSABI_INVALID; i++)
615 enum gdb_osabi osabi = (enum gdb_osabi) i;
617 if (strcmp (set_osabi_string, gdbarch_osabi_name (osabi)) == 0)
619 user_selected_osabi = osabi;
620 user_osabi_state = osabi_user;
624 if (i == GDB_OSABI_INVALID)
625 internal_error (__FILE__, __LINE__,
626 _("Invalid OS ABI \"%s\" passed to command handler."),
630 /* NOTE: At some point (true multiple architectures) we'll need to be more
632 gdbarch_info_init (&info);
633 if (! gdbarch_update_p (info))
634 internal_error (__FILE__, __LINE__, _("Updating OS ABI failed."));
638 show_osabi (struct ui_file *file, int from_tty, struct cmd_list_element *c,
641 if (user_osabi_state == osabi_auto)
642 fprintf_filtered (file,
643 _("The current OS ABI is \"auto\" "
644 "(currently \"%s\").\n"),
645 gdbarch_osabi_name (gdbarch_osabi (get_current_arch ())));
647 fprintf_filtered (file, _("The current OS ABI is \"%s\".\n"),
648 gdbarch_osabi_name (user_selected_osabi));
650 if (GDB_OSABI_DEFAULT != GDB_OSABI_UNKNOWN)
651 fprintf_filtered (file, _("The default OS ABI is \"%s\".\n"),
652 gdbarch_osabi_name (GDB_OSABI_DEFAULT));
656 _initialize_gdb_osabi (void)
658 if (strcmp (gdb_osabi_names[GDB_OSABI_INVALID].pretty, "<invalid>") != 0)
661 _("_initialize_gdb_osabi: gdb_osabi_names[] is inconsistent"));
663 /* Register a generic sniffer for ELF flavoured files. */
664 gdbarch_register_osabi_sniffer (bfd_arch_unknown,
665 bfd_target_elf_flavour,
666 generic_elf_osabi_sniffer);
668 /* Register the "set osabi" command. */
669 add_setshow_enum_cmd ("osabi", class_support, gdb_osabi_available_names,
671 _("Set OS ABI of target."),
672 _("Show OS ABI of target."),
673 NULL, set_osabi, show_osabi,
674 &setlist, &showlist);
675 user_osabi_state = osabi_auto;