GDB: S12Z: Add assertion
[external/binutils.git] / gdb / osabi.h
1 /* OS ABI variant handling for GDB.
2    Copyright (C) 2001-2018 Free Software Foundation, Inc.
3    
4    This file is part of GDB.
5
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 3 of the License, or
9    (at your option) any later version.
10
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.
15
16    You should have received a copy of the GNU General Public License
17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
18
19 #ifndef OSABI_H
20 #define OSABI_H
21
22 /* Register an OS ABI sniffer.  Each arch/flavour may have more than
23    one sniffer.  This is used to e.g. differentiate one OS's a.out from
24    another.  The first sniffer to return something other than
25    GDB_OSABI_UNKNOWN wins, so a sniffer should be careful to claim a file
26    only if it knows for sure what it is.  */
27 void gdbarch_register_osabi_sniffer (enum bfd_architecture,
28                                      enum bfd_flavour,
29                                      enum gdb_osabi (*)(bfd *));
30
31 /* Register a handler for an OS ABI variant for a given architecture
32    and machine type.  There should be only one handler for a given OS
33    ABI for each architecture and machine type combination.  */
34 void gdbarch_register_osabi (enum bfd_architecture, unsigned long,
35                              enum gdb_osabi,
36                              void (*)(struct gdbarch_info,
37                                       struct gdbarch *));
38
39 /* Lookup the OS ABI corresponding to the specified BFD.  */
40 enum gdb_osabi gdbarch_lookup_osabi (bfd *);
41
42 /* Lookup the OS ABI corresponding to the specified target description
43    string.  */
44 enum gdb_osabi osabi_from_tdesc_string (const char *text);
45
46 /* Initialize the gdbarch for the specified OS ABI variant.  */
47 void gdbarch_init_osabi (struct gdbarch_info, struct gdbarch *);
48
49 /* Return the name of the specified OS ABI.  */
50 const char *gdbarch_osabi_name (enum gdb_osabi);
51
52 /* Return a regular expression that matches the OS part of a GNU
53    configury triplet for the given OSABI.  */
54 const char *osabi_triplet_regexp (enum gdb_osabi osabi);
55
56 /* Helper routine for ELF file sniffers.  This looks at ABI tag note
57    sections to determine the OS ABI from the note.  It should be called
58    via bfd_map_over_sections.  */
59 void generic_elf_osabi_sniff_abi_tag_sections (bfd *, asection *, void *);
60
61 #endif /* OSABI_H */