gdb/osabi.h

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