1 /* OS ABI variant handling for GDB.
3 Copyright (C) 2001-2024 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/>. */
22 #include "arch-utils.h"
23 #include "cli/cli-cmds.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
},
89 gdbarch_osabi_name (enum gdb_osabi osabi
)
91 if (osabi
>= GDB_OSABI_UNKNOWN
&& osabi
< GDB_OSABI_INVALID
)
92 return gdb_osabi_names
[osabi
].pretty
;
94 return gdb_osabi_names
[GDB_OSABI_INVALID
].pretty
;
100 osabi_triplet_regexp (enum gdb_osabi osabi
)
102 if (osabi
>= GDB_OSABI_UNKNOWN
&& osabi
< GDB_OSABI_INVALID
)
103 return gdb_osabi_names
[osabi
].regexp
;
105 return gdb_osabi_names
[GDB_OSABI_INVALID
].regexp
;
108 /* Lookup the OS ABI corresponding to the specified target description
112 osabi_from_tdesc_string (const char *name
)
116 for (i
= 0; i
< ARRAY_SIZE (gdb_osabi_names
); i
++)
117 if (strcmp (name
, gdb_osabi_names
[i
].pretty
) == 0)
119 /* See note above: the name table matches the indices assigned
120 to enum gdb_osabi. */
121 enum gdb_osabi osabi
= (enum gdb_osabi
) i
;
123 if (osabi
== GDB_OSABI_INVALID
)
124 return GDB_OSABI_UNKNOWN
;
129 return GDB_OSABI_UNKNOWN
;
132 /* Handler for a given architecture/OS ABI pair. There should be only
133 one handler for a given OS ABI each architecture family. */
134 struct gdb_osabi_handler
136 struct gdb_osabi_handler
*next
;
137 const struct bfd_arch_info
*arch_info
;
138 enum gdb_osabi osabi
;
139 void (*init_osabi
)(struct gdbarch_info
, struct gdbarch
*);
142 static struct gdb_osabi_handler
*gdb_osabi_handler_list
;
145 gdbarch_register_osabi (enum bfd_architecture arch
, unsigned long machine
,
146 enum gdb_osabi osabi
,
147 void (*init_osabi
)(struct gdbarch_info
,
150 struct gdb_osabi_handler
**handler_p
;
151 const struct bfd_arch_info
*arch_info
= bfd_lookup_arch (arch
, machine
);
152 const char **name_ptr
;
154 /* Registering an OS ABI handler for "unknown" is not allowed. */
155 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
)
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
)
266 (_("gdbarch_lookup_osabi: invalid OS ABI (%d) from sniffer "
267 "for architecture %s flavour %d"),
269 bfd_printable_arch_mach (bfd_get_arch (abfd
), 0),
270 (int) bfd_get_flavour (abfd
));
272 else if (osabi
!= GDB_OSABI_UNKNOWN
)
274 /* A specific sniffer always overrides a generic sniffer.
275 Croak on multiple match if the two matches are of the
276 same class. If the user wishes to continue, we'll use
278 if (match
!= GDB_OSABI_UNKNOWN
)
280 if ((match_specific
&& sniffer
->arch
!= bfd_arch_unknown
)
281 || (!match_specific
&& sniffer
->arch
== bfd_arch_unknown
))
284 (_("gdbarch_lookup_osabi: multiple %sspecific OS ABI "
285 "match for architecture %s flavour %d: first "
286 "match \"%s\", second match \"%s\""),
287 match_specific
? "" : "non-",
288 bfd_printable_arch_mach (bfd_get_arch (abfd
), 0),
289 (int) bfd_get_flavour (abfd
),
290 gdbarch_osabi_name (match
),
291 gdbarch_osabi_name (osabi
));
293 else if (sniffer
->arch
!= bfd_arch_unknown
)
302 if (sniffer
->arch
!= bfd_arch_unknown
)
313 /* Return non-zero if architecture A can run code written for
316 can_run_code_for (const struct bfd_arch_info
*a
, const struct bfd_arch_info
*b
)
318 /* BFD's 'A->compatible (A, B)' functions return zero if A and B are
319 incompatible. But if they are compatible, it returns the 'more
320 featureful' of the two arches. That is, if A can run code
321 written for B, but B can't run code written for A, then it'll
324 struct bfd_arch_info objects are singletons: that is, there's
325 supposed to be exactly one instance for a given machine. So you
326 can tell whether two are equivalent by comparing pointers. */
327 return (a
== b
|| a
->compatible (a
, b
) == a
);
330 /* Return OS ABI handler for INFO. */
332 static struct gdb_osabi_handler
*
333 gdbarch_osabi_handler (struct gdbarch_info info
)
335 struct gdb_osabi_handler
*handler
;
337 gdb_assert (info
.osabi
!= GDB_OSABI_UNKNOWN
);
339 for (handler
= gdb_osabi_handler_list
; handler
!= NULL
;
340 handler
= handler
->next
)
342 if (handler
->osabi
!= info
.osabi
)
345 /* If the architecture described by ARCH_INFO can run code for
346 the architecture we registered the handler for, then the
347 handler is applicable. Note, though, that if the handler is
348 for an architecture that is a superset of ARCH_INFO, we can't
349 use that --- it would be perfectly correct for it to install
350 gdbarch methods that refer to registers / instructions /
351 other facilities ARCH_INFO doesn't have.
353 NOTE: kettenis/20021027: There may be more than one machine
354 type that is compatible with the desired machine type. Right
355 now we simply return the first match, which is fine for now.
356 However, we might want to do something smarter in the future. */
357 /* NOTE: cagney/2003-10-23: The code for "a can_run_code_for b"
358 is implemented using BFD's compatible method (a->compatible
359 (b) == a -- the lowest common denominator between a and b is
360 a). That method's definition of compatible may not be as you
361 expect. For instance the test "amd64 can run code for i386"
362 (or more generally "64-bit ISA can run code for the 32-bit
363 ISA"). BFD doesn't normally consider 32-bit and 64-bit
364 "compatible" so it doesn't succeed. */
365 if (can_run_code_for (info
.bfd_arch_info
, handler
->arch_info
))
375 has_gdb_osabi_handler (struct gdbarch_info info
)
377 return gdbarch_osabi_handler (info
) != nullptr;
381 gdbarch_init_osabi (struct gdbarch_info info
, struct gdbarch
*gdbarch
)
383 struct gdb_osabi_handler
*handler
;
385 gdb_assert (info
.osabi
!= GDB_OSABI_UNKNOWN
);
386 handler
= gdbarch_osabi_handler (info
);
388 if (handler
!= nullptr)
390 (*handler
->init_osabi
) (info
, gdbarch
);
394 if (info
.osabi
== GDB_OSABI_NONE
)
396 /* Don't complain about no OSABI. Assume the user knows
397 what they are doing. */
402 ("A handler for the OS ABI \"%s\" is not built into this configuration\n"
403 "of GDB. Attempting to continue with the default %s settings.\n",
404 gdbarch_osabi_name (info
.osabi
),
405 info
.bfd_arch_info
->printable_name
);
408 /* Limit on the amount of data to be read. */
409 #define MAX_NOTESZ 128
411 /* Return non-zero if NOTE matches NAME, DESCSZ and TYPE. If
412 *SECTSIZE is non-zero, then this reads that many bytes from
413 the start of the section and clears *SECTSIZE. */
416 check_note (bfd
*abfd
, asection
*sect
, char *note
, unsigned int *sectsize
,
417 const char *name
, unsigned long descsz
, unsigned long type
)
419 unsigned long notesz
;
423 if (!bfd_get_section_contents (abfd
, sect
, note
, 0, *sectsize
))
428 /* Calculate the size of this note. */
429 notesz
= strlen (name
) + 1;
430 notesz
= ((notesz
+ 3) & ~3);
432 notesz
= ((notesz
+ 3) & ~3);
434 /* If this assertion triggers, increase MAX_NOTESZ. */
435 gdb_assert (notesz
<= MAX_NOTESZ
);
437 /* Check whether SECT is big enough to contain the complete note. */
438 if (notesz
> bfd_section_size (sect
))
441 /* Check the note name. */
442 if (bfd_h_get_32 (abfd
, note
) != (strlen (name
) + 1)
443 || strcmp (note
+ 12, name
) != 0)
446 /* Check the descriptor size. */
447 if (bfd_h_get_32 (abfd
, note
+ 4) != descsz
)
450 /* Check the note type. */
451 if (bfd_h_get_32 (abfd
, note
+ 8) != type
)
457 /* Generic sniffer for ELF flavoured files. */
460 generic_elf_osabi_sniff_abi_tag_sections (bfd
*abfd
, asection
*sect
,
461 enum gdb_osabi
*osabi
)
464 unsigned int sectsize
;
466 name
= bfd_section_name (sect
);
467 sectsize
= bfd_section_size (sect
);
469 /* Limit the amount of data to read. */
470 if (sectsize
> MAX_NOTESZ
)
471 sectsize
= MAX_NOTESZ
;
473 /* We lazily read the section data here. Since we use
474 BFD_DECOMPRESS, we can't use bfd_get_section_contents on a
475 compressed section. But, since note sections are not compressed,
476 deferring the reading until we recognize the section avoids any
478 char note
[MAX_NOTESZ
];
480 /* .note.ABI-tag notes, used by GNU/Linux and FreeBSD. */
481 if (strcmp (name
, ".note.ABI-tag") == 0)
484 if (check_note (abfd
, sect
, note
, §size
, "GNU", 16, NT_GNU_ABI_TAG
))
486 unsigned int abi_tag
= bfd_h_get_32 (abfd
, note
+ 16);
490 case GNU_ABI_TAG_LINUX
:
491 *osabi
= GDB_OSABI_LINUX
;
494 case GNU_ABI_TAG_HURD
:
495 *osabi
= GDB_OSABI_HURD
;
498 case GNU_ABI_TAG_SOLARIS
:
499 *osabi
= GDB_OSABI_SOLARIS
;
502 case GNU_ABI_TAG_FREEBSD
:
503 *osabi
= GDB_OSABI_FREEBSD
;
506 case GNU_ABI_TAG_NETBSD
:
507 *osabi
= GDB_OSABI_NETBSD
;
511 warning (_("GNU ABI tag value %u unrecognized."), abi_tag
);
518 if (check_note (abfd
, sect
, note
, §size
, "FreeBSD", 4,
521 /* There is no need to check the version yet. */
522 *osabi
= GDB_OSABI_FREEBSD
;
529 /* .note.netbsd.ident notes, used by NetBSD. */
530 if (strcmp (name
, ".note.netbsd.ident") == 0
531 && check_note (abfd
, sect
, note
, §size
, "NetBSD", 4, NT_NETBSD_IDENT
))
533 /* There is no need to check the version yet. */
534 *osabi
= GDB_OSABI_NETBSD
;
538 /* .note.openbsd.ident notes, used by OpenBSD. */
539 if (strcmp (name
, ".note.openbsd.ident") == 0
540 && check_note (abfd
, sect
, note
, §size
, "OpenBSD", 4,
543 /* There is no need to check the version yet. */
544 *osabi
= GDB_OSABI_OPENBSD
;
548 /* .note.netbsdcore.procinfo notes, used by NetBSD. */
549 if (strcmp (name
, ".note.netbsdcore.procinfo") == 0)
551 *osabi
= GDB_OSABI_NETBSD
;
556 static enum gdb_osabi
557 generic_elf_osabi_sniffer (bfd
*abfd
)
559 unsigned int elfosabi
;
560 enum gdb_osabi osabi
= GDB_OSABI_UNKNOWN
;
562 elfosabi
= elf_elfheader (abfd
)->e_ident
[EI_OSABI
];
569 /* When the EI_OSABI field in the ELF header is ELFOSABI_NONE
570 (0), then the ELF structures in the file are conforming to
571 the base specification for that machine (there are no
572 OS-specific extensions). In order to determine the real OS
573 in use, we must look for OS-specific notes.
575 The same applies for ELFOSABI_GNU: this can mean GNU/Hurd,
576 GNU/Linux, and possibly more. */
578 /* And likewise ELFOSABI_HPUX. For some reason the default
579 value for the EI_OSABI field is ELFOSABI_HPUX for all PA-RISC
580 targets (with the exception of GNU/Linux). */
581 for (asection
*sect
: gdb_bfd_sections (abfd
))
582 generic_elf_osabi_sniff_abi_tag_sections (abfd
, sect
, &osabi
);
585 case ELFOSABI_FREEBSD
:
586 osabi
= GDB_OSABI_FREEBSD
;
589 case ELFOSABI_NETBSD
:
590 osabi
= GDB_OSABI_NETBSD
;
593 case ELFOSABI_SOLARIS
:
594 osabi
= GDB_OSABI_SOLARIS
;
597 case ELFOSABI_OPENVMS
:
598 osabi
= GDB_OSABI_OPENVMS
;
602 if (osabi
== GDB_OSABI_UNKNOWN
)
604 /* The FreeBSD folks have been naughty; they stored the string
605 "FreeBSD" in the padding of the e_ident field of the ELF
606 header to "brand" their ELF binaries in FreeBSD 3.x. */
607 if (memcmp (&elf_elfheader (abfd
)->e_ident
[8],
608 "FreeBSD", sizeof ("FreeBSD")) == 0)
609 osabi
= GDB_OSABI_FREEBSD
;
616 set_osabi (const char *args
, int from_tty
, struct cmd_list_element
*c
)
618 if (strcmp (set_osabi_string
, "auto") == 0)
619 user_osabi_state
= osabi_auto
;
620 else if (strcmp (set_osabi_string
, "default") == 0)
622 user_selected_osabi
= GDB_OSABI_DEFAULT
;
623 user_osabi_state
= osabi_user
;
629 for (i
= 1; i
< GDB_OSABI_INVALID
; i
++)
631 enum gdb_osabi osabi
= (enum gdb_osabi
) i
;
633 if (strcmp (set_osabi_string
, gdbarch_osabi_name (osabi
)) == 0)
635 user_selected_osabi
= osabi
;
636 user_osabi_state
= osabi_user
;
640 if (i
== GDB_OSABI_INVALID
)
641 internal_error (_("Invalid OS ABI \"%s\" passed to command handler."),
645 /* NOTE: At some point (true multiple architectures) we'll need to be more
648 if (! gdbarch_update_p (info
))
649 internal_error (_("Updating OS ABI failed."));
653 show_osabi (struct ui_file
*file
, int from_tty
, struct cmd_list_element
*c
,
656 if (user_osabi_state
== osabi_auto
)
658 _("The current OS ABI is \"auto\" "
659 "(currently \"%s\").\n"),
660 gdbarch_osabi_name (gdbarch_osabi (get_current_arch ())));
662 gdb_printf (file
, _("The current OS ABI is \"%s\".\n"),
663 gdbarch_osabi_name (user_selected_osabi
));
665 if (GDB_OSABI_DEFAULT
!= GDB_OSABI_UNKNOWN
)
666 gdb_printf (file
, _("The default OS ABI is \"%s\".\n"),
667 gdbarch_osabi_name (GDB_OSABI_DEFAULT
));
670 void _initialize_gdb_osabi ();
672 _initialize_gdb_osabi ()
674 if (strcmp (gdb_osabi_names
[GDB_OSABI_INVALID
].pretty
, "<invalid>") != 0)
676 (_("_initialize_gdb_osabi: gdb_osabi_names[] is inconsistent"));
678 /* Register a generic sniffer for ELF flavoured files. */
679 gdbarch_register_osabi_sniffer (bfd_arch_unknown
,
680 bfd_target_elf_flavour
,
681 generic_elf_osabi_sniffer
);
683 /* Register the "set osabi" command. */
684 user_osabi_state
= osabi_auto
;
685 set_osabi_string
= gdb_osabi_available_names
[0];
686 gdb_assert (strcmp (set_osabi_string
, "auto") == 0);
687 add_setshow_enum_cmd ("osabi", class_support
, gdb_osabi_available_names
,
689 _("Set OS ABI of target."),
690 _("Show OS ABI of target."),
691 NULL
, set_osabi
, show_osabi
,
692 &setlist
, &showlist
);