1 /* OS ABI variant handling for GDB.
3 Copyright (C) 2001-2013 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 "gdb_assert.h"
23 #include "gdb_string.h"
26 #include "arch-utils.h"
32 #ifndef GDB_OSABI_DEFAULT
33 #define GDB_OSABI_DEFAULT GDB_OSABI_UNKNOWN
36 /* State for the "set osabi" command. */
37 static enum { osabi_auto
, osabi_default
, osabi_user
} user_osabi_state
;
38 static enum gdb_osabi user_selected_osabi
;
39 static const char *gdb_osabi_available_names
[GDB_OSABI_INVALID
+ 3] = {
45 static const char *set_osabi_string
;
47 /* This table matches the indices assigned to enum gdb_osabi. Keep
49 static const char * const gdb_osabi_names
[] =
83 gdbarch_osabi_name (enum gdb_osabi osabi
)
85 if (osabi
>= GDB_OSABI_UNKNOWN
&& osabi
< GDB_OSABI_INVALID
)
86 return gdb_osabi_names
[osabi
];
88 return gdb_osabi_names
[GDB_OSABI_INVALID
];
91 /* Lookup the OS ABI corresponding to the specified target description
95 osabi_from_tdesc_string (const char *name
)
99 for (i
= 0; i
< ARRAY_SIZE (gdb_osabi_names
); i
++)
100 if (strcmp (name
, gdb_osabi_names
[i
]) == 0)
102 /* See note above: the name table matches the indices assigned
103 to enum gdb_osabi. */
104 enum gdb_osabi osabi
= (enum gdb_osabi
) i
;
106 if (osabi
== GDB_OSABI_INVALID
)
107 return GDB_OSABI_UNKNOWN
;
112 return GDB_OSABI_UNKNOWN
;
115 /* Handler for a given architecture/OS ABI pair. There should be only
116 one handler for a given OS ABI each architecture family. */
117 struct gdb_osabi_handler
119 struct gdb_osabi_handler
*next
;
120 const struct bfd_arch_info
*arch_info
;
121 enum gdb_osabi osabi
;
122 void (*init_osabi
)(struct gdbarch_info
, struct gdbarch
*);
125 static struct gdb_osabi_handler
*gdb_osabi_handler_list
;
128 gdbarch_register_osabi (enum bfd_architecture arch
, unsigned long machine
,
129 enum gdb_osabi osabi
,
130 void (*init_osabi
)(struct gdbarch_info
,
133 struct gdb_osabi_handler
**handler_p
;
134 const struct bfd_arch_info
*arch_info
= bfd_lookup_arch (arch
, machine
);
135 const char **name_ptr
;
137 /* Registering an OS ABI handler for "unknown" is not allowed. */
138 if (osabi
== GDB_OSABI_UNKNOWN
)
142 _("gdbarch_register_osabi: An attempt to register a handler for "
143 "OS ABI \"%s\" for architecture %s was made. The handler will "
144 "not be registered"),
145 gdbarch_osabi_name (osabi
),
146 bfd_printable_arch_mach (arch
, machine
));
150 gdb_assert (arch_info
);
152 for (handler_p
= &gdb_osabi_handler_list
; *handler_p
!= NULL
;
153 handler_p
= &(*handler_p
)->next
)
155 if ((*handler_p
)->arch_info
== arch_info
156 && (*handler_p
)->osabi
== osabi
)
160 _("gdbarch_register_osabi: A handler for OS ABI \"%s\" "
161 "has already been registered for architecture %s"),
162 gdbarch_osabi_name (osabi
),
163 arch_info
->printable_name
);
164 /* If user wants to continue, override previous definition. */
165 (*handler_p
)->init_osabi
= init_osabi
;
171 = (struct gdb_osabi_handler
*) xmalloc (sizeof (struct gdb_osabi_handler
));
172 (*handler_p
)->next
= NULL
;
173 (*handler_p
)->arch_info
= arch_info
;
174 (*handler_p
)->osabi
= osabi
;
175 (*handler_p
)->init_osabi
= init_osabi
;
177 /* Add this OS ABI to the list of enum values for "set osabi", if it isn't
179 for (name_ptr
= gdb_osabi_available_names
; *name_ptr
; name_ptr
++)
181 if (*name_ptr
== gdbarch_osabi_name (osabi
))
184 *name_ptr
++ = gdbarch_osabi_name (osabi
);
189 /* Sniffer to find the OS ABI for a given file's architecture and flavour.
190 It is legal to have multiple sniffers for each arch/flavour pair, to
191 disambiguate one OS's a.out from another, for example. The first sniffer
192 to return something other than GDB_OSABI_UNKNOWN wins, so a sniffer should
193 be careful to claim a file only if it knows for sure what it is. */
194 struct gdb_osabi_sniffer
196 struct gdb_osabi_sniffer
*next
;
197 enum bfd_architecture arch
; /* bfd_arch_unknown == wildcard */
198 enum bfd_flavour flavour
;
199 enum gdb_osabi (*sniffer
)(bfd
*);
202 static struct gdb_osabi_sniffer
*gdb_osabi_sniffer_list
;
205 gdbarch_register_osabi_sniffer (enum bfd_architecture arch
,
206 enum bfd_flavour flavour
,
207 enum gdb_osabi (*sniffer_fn
)(bfd
*))
209 struct gdb_osabi_sniffer
*sniffer
;
212 (struct gdb_osabi_sniffer
*) xmalloc (sizeof (struct gdb_osabi_sniffer
));
213 sniffer
->arch
= arch
;
214 sniffer
->flavour
= flavour
;
215 sniffer
->sniffer
= sniffer_fn
;
217 sniffer
->next
= gdb_osabi_sniffer_list
;
218 gdb_osabi_sniffer_list
= sniffer
;
223 gdbarch_lookup_osabi (bfd
*abfd
)
225 struct gdb_osabi_sniffer
*sniffer
;
226 enum gdb_osabi osabi
, match
;
229 /* If we aren't in "auto" mode, return the specified OS ABI. */
230 if (user_osabi_state
== osabi_user
)
231 return user_selected_osabi
;
233 /* If we don't have a binary, just return unknown. The caller may
234 have other sources the OSABI can be extracted from, e.g., the
235 target description. */
237 return GDB_OSABI_UNKNOWN
;
239 match
= GDB_OSABI_UNKNOWN
;
242 for (sniffer
= gdb_osabi_sniffer_list
; sniffer
!= NULL
;
243 sniffer
= sniffer
->next
)
245 if ((sniffer
->arch
== bfd_arch_unknown
/* wildcard */
246 || sniffer
->arch
== bfd_get_arch (abfd
))
247 && sniffer
->flavour
== bfd_get_flavour (abfd
))
249 osabi
= (*sniffer
->sniffer
) (abfd
);
250 if (osabi
< GDB_OSABI_UNKNOWN
|| osabi
>= GDB_OSABI_INVALID
)
254 _("gdbarch_lookup_osabi: invalid OS ABI (%d) from sniffer "
255 "for architecture %s flavour %d"),
257 bfd_printable_arch_mach (bfd_get_arch (abfd
), 0),
258 (int) bfd_get_flavour (abfd
));
260 else if (osabi
!= GDB_OSABI_UNKNOWN
)
262 /* A specific sniffer always overrides a generic sniffer.
263 Croak on multiple match if the two matches are of the
264 same class. If the user wishes to continue, we'll use
266 if (match
!= GDB_OSABI_UNKNOWN
)
268 if ((match_specific
&& sniffer
->arch
!= bfd_arch_unknown
)
269 || (!match_specific
&& sniffer
->arch
== bfd_arch_unknown
))
273 _("gdbarch_lookup_osabi: multiple %sspecific OS ABI "
274 "match for architecture %s flavour %d: first "
275 "match \"%s\", second match \"%s\""),
276 match_specific
? "" : "non-",
277 bfd_printable_arch_mach (bfd_get_arch (abfd
), 0),
278 (int) bfd_get_flavour (abfd
),
279 gdbarch_osabi_name (match
),
280 gdbarch_osabi_name (osabi
));
282 else if (sniffer
->arch
!= bfd_arch_unknown
)
291 if (sniffer
->arch
!= bfd_arch_unknown
)
302 /* Return non-zero if architecture A can run code written for
305 can_run_code_for (const struct bfd_arch_info
*a
, const struct bfd_arch_info
*b
)
307 /* BFD's 'A->compatible (A, B)' functions return zero if A and B are
308 incompatible. But if they are compatible, it returns the 'more
309 featureful' of the two arches. That is, if A can run code
310 written for B, but B can't run code written for A, then it'll
313 struct bfd_arch_info objects are singletons: that is, there's
314 supposed to be exactly one instance for a given machine. So you
315 can tell whether two are equivalent by comparing pointers. */
316 return (a
== b
|| a
->compatible (a
, b
) == a
);
321 gdbarch_init_osabi (struct gdbarch_info info
, struct gdbarch
*gdbarch
)
323 struct gdb_osabi_handler
*handler
;
325 if (info
.osabi
== GDB_OSABI_UNKNOWN
)
327 /* Don't complain about an unknown OSABI. Assume the user knows
328 what they are doing. */
332 for (handler
= gdb_osabi_handler_list
; handler
!= NULL
;
333 handler
= handler
->next
)
335 if (handler
->osabi
!= info
.osabi
)
338 /* If the architecture described by ARCH_INFO can run code for
339 the architcture we registered the handler for, then the
340 handler is applicable. Note, though, that if the handler is
341 for an architecture that is a superset of ARCH_INFO, we can't
342 use that --- it would be perfectly correct for it to install
343 gdbarch methods that refer to registers / instructions /
344 other facilities ARCH_INFO doesn't have.
346 NOTE: kettenis/20021027: There may be more than one machine
347 type that is compatible with the desired machine type. Right
348 now we simply return the first match, which is fine for now.
349 However, we might want to do something smarter in the future. */
350 /* NOTE: cagney/2003-10-23: The code for "a can_run_code_for b"
351 is implemented using BFD's compatible method (a->compatible
352 (b) == a -- the lowest common denominator between a and b is
353 a). That method's definition of compatible may not be as you
354 expect. For instance the test "amd64 can run code for i386"
355 (or more generally "64-bit ISA can run code for the 32-bit
356 ISA"). BFD doesn't normally consider 32-bit and 64-bit
357 "compatible" so it doesn't succeed. */
358 if (can_run_code_for (info
.bfd_arch_info
, handler
->arch_info
))
360 (*handler
->init_osabi
) (info
, gdbarch
);
366 ("A handler for the OS ABI \"%s\" is not built into this configuration\n"
367 "of GDB. Attempting to continue with the default %s settings.\n",
368 gdbarch_osabi_name (info
.osabi
),
369 info
.bfd_arch_info
->printable_name
);
372 /* Limit on the amount of data to be read. */
373 #define MAX_NOTESZ 128
375 /* Return non-zero if NOTE matches NAME, DESCSZ and TYPE. If
376 *SECTSIZE is non-zero, then this reads that many bytes from
377 the start of the section and clears *SECTSIZE. */
380 check_note (bfd
*abfd
, asection
*sect
, char *note
, unsigned int *sectsize
,
381 const char *name
, unsigned long descsz
, unsigned long type
)
383 unsigned long notesz
;
387 if (!bfd_get_section_contents (abfd
, sect
, note
, 0, *sectsize
))
392 /* Calculate the size of this note. */
393 notesz
= strlen (name
) + 1;
394 notesz
= ((notesz
+ 3) & ~3);
396 notesz
= ((notesz
+ 3) & ~3);
398 /* If this assertion triggers, increase MAX_NOTESZ. */
399 gdb_assert (notesz
<= MAX_NOTESZ
);
401 /* Check whether SECT is big enough to comtain the complete note. */
402 if (notesz
> bfd_section_size (abfd
, sect
))
405 /* Check the note name. */
406 if (bfd_h_get_32 (abfd
, note
) != (strlen (name
) + 1)
407 || strcmp (note
+ 12, name
) != 0)
410 /* Check the descriptor size. */
411 if (bfd_h_get_32 (abfd
, note
+ 4) != descsz
)
414 /* Check the note type. */
415 if (bfd_h_get_32 (abfd
, note
+ 8) != type
)
421 /* Generic sniffer for ELF flavoured files. */
424 generic_elf_osabi_sniff_abi_tag_sections (bfd
*abfd
, asection
*sect
, void *obj
)
426 enum gdb_osabi
*osabi
= obj
;
428 unsigned int sectsize
;
431 name
= bfd_get_section_name (abfd
, sect
);
432 sectsize
= bfd_section_size (abfd
, sect
);
434 /* Limit the amount of data to read. */
435 if (sectsize
> MAX_NOTESZ
)
436 sectsize
= MAX_NOTESZ
;
438 /* We lazily read the section data here. Since we use
439 BFD_DECOMPRESS, we can't use bfd_get_section_contents on a
440 compressed section. But, since note sections are not compressed,
441 deferring the reading until we recognize the section avoids any
443 note
= alloca (sectsize
);
445 /* .note.ABI-tag notes, used by GNU/Linux and FreeBSD. */
446 if (strcmp (name
, ".note.ABI-tag") == 0)
449 if (check_note (abfd
, sect
, note
, §size
, "GNU", 16, NT_GNU_ABI_TAG
))
451 unsigned int abi_tag
= bfd_h_get_32 (abfd
, note
+ 16);
455 case GNU_ABI_TAG_LINUX
:
456 *osabi
= GDB_OSABI_LINUX
;
459 case GNU_ABI_TAG_HURD
:
460 *osabi
= GDB_OSABI_HURD
;
463 case GNU_ABI_TAG_SOLARIS
:
464 *osabi
= GDB_OSABI_SOLARIS
;
467 case GNU_ABI_TAG_FREEBSD
:
468 *osabi
= GDB_OSABI_FREEBSD_ELF
;
471 case GNU_ABI_TAG_NETBSD
:
472 *osabi
= GDB_OSABI_NETBSD_ELF
;
476 internal_error (__FILE__
, __LINE__
,
477 _("generic_elf_osabi_sniff_abi_tag_sections: "
478 "unknown OS number %d"),
485 if (check_note (abfd
, sect
, note
, §size
, "FreeBSD", 4,
488 /* There is no need to check the version yet. */
489 *osabi
= GDB_OSABI_FREEBSD_ELF
;
496 /* .note.netbsd.ident notes, used by NetBSD. */
497 if (strcmp (name
, ".note.netbsd.ident") == 0
498 && check_note (abfd
, sect
, note
, §size
, "NetBSD", 4, NT_NETBSD_IDENT
))
500 /* There is no need to check the version yet. */
501 *osabi
= GDB_OSABI_NETBSD_ELF
;
505 /* .note.openbsd.ident notes, used by OpenBSD. */
506 if (strcmp (name
, ".note.openbsd.ident") == 0
507 && check_note (abfd
, sect
, note
, §size
, "OpenBSD", 4,
510 /* There is no need to check the version yet. */
511 *osabi
= GDB_OSABI_OPENBSD_ELF
;
515 /* .note.netbsdcore.procinfo notes, used by NetBSD. */
516 if (strcmp (name
, ".note.netbsdcore.procinfo") == 0)
518 *osabi
= GDB_OSABI_NETBSD_ELF
;
523 static enum gdb_osabi
524 generic_elf_osabi_sniffer (bfd
*abfd
)
526 unsigned int elfosabi
;
527 enum gdb_osabi osabi
= GDB_OSABI_UNKNOWN
;
529 elfosabi
= elf_elfheader (abfd
)->e_ident
[EI_OSABI
];
535 /* When the EI_OSABI field in the ELF header is ELFOSABI_NONE
536 (0), then the ELF structures in the file are conforming to
537 the base specification for that machine (there are no
538 OS-specific extensions). In order to determine the real OS
539 in use, we must look for OS-specific notes.
541 The same applies for ELFOSABI_GNU: this can mean GNU/Hurd,
542 GNU/Linux, and possibly more. */
543 bfd_map_over_sections (abfd
,
544 generic_elf_osabi_sniff_abi_tag_sections
,
548 case ELFOSABI_FREEBSD
:
549 osabi
= GDB_OSABI_FREEBSD_ELF
;
552 case ELFOSABI_NETBSD
:
553 osabi
= GDB_OSABI_NETBSD_ELF
;
556 case ELFOSABI_SOLARIS
:
557 osabi
= GDB_OSABI_SOLARIS
;
561 /* For some reason the default value for the EI_OSABI field is
562 ELFOSABI_HPUX for all PA-RISC targets (with the exception of
563 GNU/Linux). We use HP-UX ELF as the default, but let any
564 OS-specific notes override this. */
565 osabi
= GDB_OSABI_HPUX_ELF
;
566 bfd_map_over_sections (abfd
,
567 generic_elf_osabi_sniff_abi_tag_sections
,
571 case ELFOSABI_OPENVMS
:
572 osabi
= GDB_OSABI_OPENVMS
;
576 if (osabi
== GDB_OSABI_UNKNOWN
)
578 /* The FreeBSD folks have been naughty; they stored the string
579 "FreeBSD" in the padding of the e_ident field of the ELF
580 header to "brand" their ELF binaries in FreeBSD 3.x. */
581 if (memcmp (&elf_elfheader (abfd
)->e_ident
[8],
582 "FreeBSD", sizeof ("FreeBSD")) == 0)
583 osabi
= GDB_OSABI_FREEBSD_ELF
;
590 set_osabi (char *args
, int from_tty
, struct cmd_list_element
*c
)
592 struct gdbarch_info info
;
594 if (strcmp (set_osabi_string
, "auto") == 0)
595 user_osabi_state
= osabi_auto
;
596 else if (strcmp (set_osabi_string
, "default") == 0)
598 user_selected_osabi
= GDB_OSABI_DEFAULT
;
599 user_osabi_state
= osabi_user
;
601 else if (strcmp (set_osabi_string
, "none") == 0)
603 user_selected_osabi
= GDB_OSABI_UNKNOWN
;
604 user_osabi_state
= osabi_user
;
610 for (i
= 1; i
< GDB_OSABI_INVALID
; i
++)
611 if (strcmp (set_osabi_string
, gdbarch_osabi_name (i
)) == 0)
613 user_selected_osabi
= i
;
614 user_osabi_state
= osabi_user
;
617 if (i
== GDB_OSABI_INVALID
)
618 internal_error (__FILE__
, __LINE__
,
619 _("Invalid OS ABI \"%s\" passed to command handler."),
623 /* NOTE: At some point (true multiple architectures) we'll need to be more
625 gdbarch_info_init (&info
);
626 if (! gdbarch_update_p (info
))
627 internal_error (__FILE__
, __LINE__
, _("Updating OS ABI failed."));
631 show_osabi (struct ui_file
*file
, int from_tty
, struct cmd_list_element
*c
,
634 if (user_osabi_state
== osabi_auto
)
635 fprintf_filtered (file
,
636 _("The current OS ABI is \"auto\" "
637 "(currently \"%s\").\n"),
638 gdbarch_osabi_name (gdbarch_osabi (get_current_arch ())));
640 fprintf_filtered (file
, _("The current OS ABI is \"%s\".\n"),
641 gdbarch_osabi_name (user_selected_osabi
));
643 if (GDB_OSABI_DEFAULT
!= GDB_OSABI_UNKNOWN
)
644 fprintf_filtered (file
, _("The default OS ABI is \"%s\".\n"),
645 gdbarch_osabi_name (GDB_OSABI_DEFAULT
));
648 extern initialize_file_ftype _initialize_gdb_osabi
; /* -Wmissing-prototype */
651 _initialize_gdb_osabi (void)
653 if (strcmp (gdb_osabi_names
[GDB_OSABI_INVALID
], "<invalid>") != 0)
656 _("_initialize_gdb_osabi: gdb_osabi_names[] is inconsistent"));
658 /* Register a generic sniffer for ELF flavoured files. */
659 gdbarch_register_osabi_sniffer (bfd_arch_unknown
,
660 bfd_target_elf_flavour
,
661 generic_elf_osabi_sniffer
);
663 /* Register the "set osabi" command. */
664 add_setshow_enum_cmd ("osabi", class_support
, gdb_osabi_available_names
,
666 _("Set OS ABI of target."),
667 _("Show OS ABI of target."),
668 NULL
, set_osabi
, show_osabi
,
669 &setlist
, &showlist
);
670 user_osabi_state
= osabi_auto
;