1 /* OS ABI variant handling for GDB.
2    Copyright (C) 2001-2021 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 /* * List of known OS ABIs.  If you change this, make sure to update the
23    table in osabi.c.  */
24 enum gdb_osabi
25 {
26   GDB_OSABI_UNKNOWN = 0,	/* keep this zero */
27   GDB_OSABI_NONE,
28 
29   GDB_OSABI_SVR4,
30   GDB_OSABI_HURD,
31   GDB_OSABI_SOLARIS,
32   GDB_OSABI_LINUX,
33   GDB_OSABI_FREEBSD,
34   GDB_OSABI_DRAGONFLY,
35   GDB_OSABI_NETBSD,
36   GDB_OSABI_OPENBSD,
37   GDB_OSABI_WINCE,
38   GDB_OSABI_GO32,
39   GDB_OSABI_QNXNTO,
40   GDB_OSABI_CYGWIN,
41   GDB_OSABI_WINDOWS,
42   GDB_OSABI_AIX,
43   GDB_OSABI_DICOS,
44   GDB_OSABI_DARWIN,
45   GDB_OSABI_OPENVMS,
46   GDB_OSABI_LYNXOS178,
47   GDB_OSABI_NEWLIB,
48   GDB_OSABI_SDE,
49   GDB_OSABI_PIKEOS,
50 
51   GDB_OSABI_INVALID		/* keep this last */
52 };
53 
54 /* Register an OS ABI sniffer.  Each arch/flavour may have more than
55    one sniffer.  This is used to e.g. differentiate one OS's a.out from
56    another.  The first sniffer to return something other than
57    GDB_OSABI_UNKNOWN wins, so a sniffer should be careful to claim a file
58    only if it knows for sure what it is.  */
59 void gdbarch_register_osabi_sniffer (enum bfd_architecture,
60 				     enum bfd_flavour,
61 				     enum gdb_osabi (*)(bfd *));
62 
63 /* Register a handler for an OS ABI variant for a given architecture
64    and machine type.  There should be only one handler for a given OS
65    ABI for each architecture and machine type combination.  */
66 void gdbarch_register_osabi (enum bfd_architecture, unsigned long,
67 			     enum gdb_osabi,
68 			     void (*)(struct gdbarch_info,
69 				      struct gdbarch *));
70 
71 /* Lookup the OS ABI corresponding to the specified BFD.  */
72 enum gdb_osabi gdbarch_lookup_osabi (bfd *);
73 
74 /* Lookup the OS ABI corresponding to the specified target description
75    string.  */
76 enum gdb_osabi osabi_from_tdesc_string (const char *text);
77 
78 /* Initialize the gdbarch for the specified OS ABI variant.  */
79 void gdbarch_init_osabi (struct gdbarch_info, struct gdbarch *);
80 
81 /* Return the name of the specified OS ABI.  */
82 const char *gdbarch_osabi_name (enum gdb_osabi);
83 
84 /* Return a regular expression that matches the OS part of a GNU
85    configury triplet for the given OSABI.  */
86 const char *osabi_triplet_regexp (enum gdb_osabi osabi);
87 
88 /* Helper routine for ELF file sniffers.  This looks at ABI tag note
89    sections to determine the OS ABI from the note.  */
90 void generic_elf_osabi_sniff_abi_tag_sections (bfd *, asection *,
91 					       enum gdb_osabi *);
92 
93 #endif /* OSABI_H */
94