doc/ChangeLog:
[deliverable/binutils-gdb.git] / gdb / osabi.c
index 47d08a2ebce3e5ee192320f14c3157181d92cbb6..04236fc2de4e56c76d1d762c338e60f39fe26938 100644 (file)
@@ -1,22 +1,22 @@
 /* OS ABI variant handling for GDB.
-   Copyright 2001, 2002 Free Software Foundation, Inc.
+
+   Copyright (C) 2001, 2002, 2003, 2004, 2007, 2008
+   Free Software Foundation, Inc.
 
    This file is part of GDB.
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2 of the License, or
+   the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
 
-   This program is distributed in the hope that it will be useful,  
+   This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
-  
+
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 59 Temple Place - Suite 330,
-   Boston, MA 02111-1307, USA.  */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
 
 #include "defs.h"
 
 #include "gdb_string.h"
 
 #include "osabi.h"
+#include "arch-utils.h"
+#include "gdbcmd.h"
+#include "command.h"
 
 #include "elf-bfd.h"
 
+#ifndef GDB_OSABI_DEFAULT
+#define GDB_OSABI_DEFAULT GDB_OSABI_UNKNOWN
+#endif
+
+/* State for the "set osabi" command.  */
+static enum { osabi_auto, osabi_default, osabi_user } user_osabi_state;
+static enum gdb_osabi user_selected_osabi;
+static const char *gdb_osabi_available_names[GDB_OSABI_INVALID + 3] = {
+  "auto",
+  "default",
+  "none",
+  NULL
+};
+static const char *set_osabi_string;
 
 /* This table matches the indices assigned to enum gdb_osabi.  Keep
    them in sync.  */
 static const char * const gdb_osabi_names[] =
 {
-  "<unknown>",
+  "none",
 
   "SVR4",
   "GNU/Hurd",
@@ -43,18 +60,18 @@ static const char * const gdb_osabi_names[] =
   "FreeBSD ELF",
   "NetBSD a.out",
   "NetBSD ELF",
+  "OpenBSD ELF",
   "Windows CE",
   "DJGPP",
-  "NetWare",
   "Irix",
-  "LynxOS",
   "Interix",
   "HP/UX ELF",
   "HP/UX SOM",
 
-  "ARM EABI v1",
-  "ARM EABI v2",
-  "ARM APCS",
+  "QNX Neutrino",
+
+  "Cygwin",
+  "AIX",
 
   "<invalid>"
 };
@@ -88,15 +105,16 @@ gdbarch_register_osabi (enum bfd_architecture arch, unsigned long machine,
 {
   struct gdb_osabi_handler **handler_p;
   const struct bfd_arch_info *arch_info = bfd_lookup_arch (arch, machine);
+  const char **name_ptr;
 
   /* Registering an OS ABI handler for "unknown" is not allowed.  */
   if (osabi == GDB_OSABI_UNKNOWN)
     {
       internal_error
        (__FILE__, __LINE__,
-        "gdbarch_register_osabi: An attempt to register a handler for "
+        _("gdbarch_register_osabi: An attempt to register a handler for "
          "OS ABI \"%s\" for architecture %s was made.  The handler will "
-        "not be registered",
+        "not be registered"),
         gdbarch_osabi_name (osabi),
         bfd_printable_arch_mach (arch, machine));
       return;
@@ -112,8 +130,8 @@ gdbarch_register_osabi (enum bfd_architecture arch, unsigned long machine,
        {
          internal_error
            (__FILE__, __LINE__,
-            "gdbarch_register_osabi: A handler for OS ABI \"%s\" "
-            "has already been registered for architecture %s",
+            _("gdbarch_register_osabi: A handler for OS ABI \"%s\" "
+            "has already been registered for architecture %s"),
             gdbarch_osabi_name (osabi),
             arch_info->printable_name);
          /* If user wants to continue, override previous definition.  */
@@ -128,6 +146,16 @@ gdbarch_register_osabi (enum bfd_architecture arch, unsigned long machine,
   (*handler_p)->arch_info = arch_info;
   (*handler_p)->osabi = osabi;
   (*handler_p)->init_osabi = init_osabi;
+
+  /* Add this OS ABI to the list of enum values for "set osabi", if it isn't
+     already there.  */
+  for (name_ptr = gdb_osabi_available_names; *name_ptr; name_ptr ++)
+    {
+      if (*name_ptr == gdbarch_osabi_name (osabi))
+       return;
+    }
+  *name_ptr++ = gdbarch_osabi_name (osabi);
+  *name_ptr = NULL;
 }
 \f
 
@@ -171,6 +199,15 @@ gdbarch_lookup_osabi (bfd *abfd)
   enum gdb_osabi osabi, match;
   int match_specific;
 
+  /* If we aren't in "auto" mode, return the specified OS ABI.  */
+  if (user_osabi_state == osabi_user)
+    return user_selected_osabi;
+
+  /* If we don't have a binary, return the default OS ABI (if set) or
+     unknown (otherwise).  */
+  if (abfd == NULL) 
+    return GDB_OSABI_DEFAULT;
+
   match = GDB_OSABI_UNKNOWN;
   match_specific = 0;
 
@@ -186,8 +223,8 @@ gdbarch_lookup_osabi (bfd *abfd)
            {
              internal_error
                (__FILE__, __LINE__,
-                "gdbarch_lookup_osabi: invalid OS ABI (%d) from sniffer "
-                "for architecture %s flavour %d",
+                _("gdbarch_lookup_osabi: invalid OS ABI (%d) from sniffer "
+                "for architecture %s flavour %d"),
                 (int) osabi,
                 bfd_printable_arch_mach (bfd_get_arch (abfd), 0),
                 (int) bfd_get_flavour (abfd));
@@ -205,9 +242,9 @@ gdbarch_lookup_osabi (bfd *abfd)
                    {
                      internal_error
                        (__FILE__, __LINE__,
-                        "gdbarch_lookup_osabi: multiple %sspecific OS ABI "
+                        _("gdbarch_lookup_osabi: multiple %sspecific OS ABI "
                         "match for architecture %s flavour %d: first "
-                        "match \"%s\", second match \"%s\"",
+                        "match \"%s\", second match \"%s\""),
                         match_specific ? "" : "non-",
                         bfd_printable_arch_mach (bfd_get_arch (abfd), 0),
                         (int) bfd_get_flavour (abfd),
@@ -230,18 +267,39 @@ gdbarch_lookup_osabi (bfd *abfd)
        }
     }
 
-  return match;
+  /* If we didn't find a match, but a default was specified at configure
+     time, return the default.  */
+  if (GDB_OSABI_DEFAULT != GDB_OSABI_UNKNOWN && match == GDB_OSABI_UNKNOWN)
+    return GDB_OSABI_DEFAULT;
+  else
+    return match;
 }
 
+
+/* Return non-zero if architecture A can run code written for
+   architecture B.  */
+static int
+can_run_code_for (const struct bfd_arch_info *a, const struct bfd_arch_info *b)
+{
+  /* BFD's 'A->compatible (A, B)' functions return zero if A and B are
+     incompatible.  But if they are compatible, it returns the 'more
+     featureful' of the two arches.  That is, if A can run code
+     written for B, but B can't run code written for A, then it'll
+     return A.
+
+     struct bfd_arch_info objects are singletons: that is, there's
+     supposed to be exactly one instance for a given machine.  So you
+     can tell whether two are equivalent by comparing pointers.  */
+  return (a == b || a->compatible (a, b) == a);
+}
+
+
 void
-gdbarch_init_osabi (struct gdbarch_info info, struct gdbarch *gdbarch,
-                    enum gdb_osabi osabi)
+gdbarch_init_osabi (struct gdbarch_info info, struct gdbarch *gdbarch)
 {
-  const struct bfd_arch_info *arch_info = gdbarch_bfd_arch_info (gdbarch);
-  const struct bfd_arch_info *compatible;
   struct gdb_osabi_handler *handler;
 
-  if (osabi == GDB_OSABI_UNKNOWN)
+  if (info.osabi == GDB_OSABI_UNKNOWN)
     {
       /* Don't complain about an unknown OSABI.  Assume the user knows
          what they are doing.  */
@@ -251,136 +309,174 @@ gdbarch_init_osabi (struct gdbarch_info info, struct gdbarch *gdbarch,
   for (handler = gdb_osabi_handler_list; handler != NULL;
        handler = handler->next)
     {
-      if (handler->osabi != osabi)
+      if (handler->osabi != info.osabi)
        continue;
 
-      /* Check whether the machine type and architecture of the
-         handler are compatible with the desired machine type and
-         architecture.
+      /* If the architecture described by ARCH_INFO can run code for
+         the architcture we registered the handler for, then the
+         handler is applicable.  Note, though, that if the handler is
+         for an architecture that is a superset of ARCH_INFO, we can't
+         use that --- it would be perfectly correct for it to install
+         gdbarch methods that refer to registers / instructions /
+         other facilities ARCH_INFO doesn't have.
 
-        NOTE: kettenis/20021027: There may be more than one machine
+         NOTE: kettenis/20021027: There may be more than one machine
         type that is compatible with the desired machine type.  Right
         now we simply return the first match, which is fine for now.
         However, we might want to do something smarter in the future.  */
-      compatible = arch_info->compatible (arch_info, handler->arch_info);
-      if (compatible == handler->arch_info)
+      /* NOTE: cagney/2003-10-23: The code for "a can_run_code_for b"
+         is implemented using BFD's compatible method (a->compatible
+         (b) == a -- the lowest common denominator between a and b is
+         a).  That method's definition of compatible may not be as you
+         expect.  For instance the test "amd64 can run code for i386"
+         (or more generally "64-bit ISA can run code for the 32-bit
+         ISA").  BFD doesn't normally consider 32-bit and 64-bit
+         "compatible" so it doesn't succeed.  */
+      if (can_run_code_for (info.bfd_arch_info, handler->arch_info))
        {
          (*handler->init_osabi) (info, gdbarch);
          return;
        }
     }
 
-  /* We assume that if GDB_MULTI_ARCH is less than GDB_MULTI_ARCH_TM
-     that an ABI variant can be supported by overriding definitions in
-     the tm-file.  */
-  if (GDB_MULTI_ARCH > GDB_MULTI_ARCH_PARTIAL)
-    fprintf_filtered
-      (gdb_stderr,
-       "A handler for the OS ABI \"%s\" is not built into this "
-       "configuration of GDB.  "
-       "Attempting to continue with the default %s settings",
-       gdbarch_osabi_name (osabi),
-       bfd_printable_arch_mach (arch_info->arch, arch_info->mach));
+  warning
+    ("A handler for the OS ABI \"%s\" is not built into this configuration\n"
+     "of GDB.  Attempting to continue with the default %s settings.\n",
+     gdbarch_osabi_name (info.osabi),
+     info.bfd_arch_info->printable_name);
 }
 \f
+/* Limit on the amount of data to be read.  */
+#define MAX_NOTESZ     128
+
+/* Return non-zero if NOTE matches NAME, DESCSZ and TYPE.  */
+
+static int
+check_note (bfd *abfd, asection *sect, const char *note,
+           const char *name, unsigned long descsz, unsigned long type)
+{
+  unsigned long notesz;
+
+  /* Calculate the size of this note.  */
+  notesz = strlen (name) + 1;
+  notesz = ((notesz + 3) & ~3);
+  notesz += descsz;
+  notesz = ((notesz + 3) & ~3);
+
+  /* If this assertion triggers, increase MAX_NOTESZ.  */
+  gdb_assert (notesz <= MAX_NOTESZ);
+
+  /* Check whether SECT is big enough to comtain the complete note.  */
+  if (notesz > bfd_section_size (abfd, sect))
+    return 0;
+
+  /* Check the note name.  */
+  if (bfd_h_get_32 (abfd, note) != (strlen (name) + 1)
+      || strcmp (note + 12, name) != 0)
+    return 0;
+
+  /* Check the descriptor size.  */
+  if (bfd_h_get_32 (abfd, note + 4) != descsz)
+    return 0;
+
+  /* Check the note type.  */
+  if (bfd_h_get_32 (abfd, note + 8) != type)
+    return 0;
+
+  return 1;
+}
 
 /* Generic sniffer for ELF flavoured files.  */
 
 void
 generic_elf_osabi_sniff_abi_tag_sections (bfd *abfd, asection *sect, void *obj)
 {
-  enum gdb_osabi *os_ident_ptr = obj;
+  enum gdb_osabi *osabi = obj;
   const char *name;
   unsigned int sectsize;
+  char *note;
 
   name = bfd_get_section_name (abfd, sect);
   sectsize = bfd_section_size (abfd, sect);
 
-  /* .note.ABI-tag notes, used by GNU/Linux and FreeBSD.  */
-  if (strcmp (name, ".note.ABI-tag") == 0 && sectsize > 0)
-    {
-      unsigned int name_length, data_length, note_type;
-      char *note;
-
-      /* If the section is larger than this, it's probably not what we are
-        looking for.  */
-      if (sectsize > 128)
-       sectsize = 128;
-
-      note = alloca (sectsize);
-
-      bfd_get_section_contents (abfd, sect, note,
-                               (file_ptr) 0, (bfd_size_type) sectsize);
+  /* Limit the amount of data to read.  */
+  if (sectsize > MAX_NOTESZ)
+    sectsize = MAX_NOTESZ;
 
-      name_length = bfd_h_get_32 (abfd, note);
-      data_length = bfd_h_get_32 (abfd, note + 4);
-      note_type   = bfd_h_get_32 (abfd, note + 8);
+  note = alloca (sectsize);
+  bfd_get_section_contents (abfd, sect, note, 0, sectsize);
 
-      if (name_length == 4 && data_length == 16 && note_type == NT_GNU_ABI_TAG
-         && strcmp (note + 12, "GNU") == 0)
+  /* .note.ABI-tag notes, used by GNU/Linux and FreeBSD.  */
+  if (strcmp (name, ".note.ABI-tag") == 0)
+    {
+      /* GNU.  */
+      if (check_note (abfd, sect, note, "GNU", 16, NT_GNU_ABI_TAG))
        {
-         int os_number = bfd_h_get_32 (abfd, note + 16);
+         unsigned int abi_tag = bfd_h_get_32 (abfd, note + 16);
 
-         switch (os_number)
+         switch (abi_tag)
            {
            case GNU_ABI_TAG_LINUX:
-             *os_ident_ptr = GDB_OSABI_LINUX;
+             *osabi = GDB_OSABI_LINUX;
              break;
 
            case GNU_ABI_TAG_HURD:
-             *os_ident_ptr = GDB_OSABI_HURD;
+             *osabi = GDB_OSABI_HURD;
              break;
 
            case GNU_ABI_TAG_SOLARIS:
-             *os_ident_ptr = GDB_OSABI_SOLARIS;
+             *osabi = GDB_OSABI_SOLARIS;
+             break;
+
+           case GNU_ABI_TAG_FREEBSD:
+             *osabi = GDB_OSABI_FREEBSD_ELF;
+             break;
+
+           case GNU_ABI_TAG_NETBSD:
+             *osabi = GDB_OSABI_NETBSD_ELF;
              break;
 
            default:
-             internal_error
-               (__FILE__, __LINE__,
-                "generic_elf_osabi_sniff_abi_tag_sections: unknown OS number %d",
-                os_number);
+             internal_error (__FILE__, __LINE__, _("\
+generic_elf_osabi_sniff_abi_tag_sections: unknown OS number %d"),
+                             abi_tag);
            }
          return;
        }
-      else if (name_length == 8 && data_length == 4
-              && note_type == NT_FREEBSD_ABI_TAG
-              && strcmp (note + 12, "FreeBSD") == 0)
+
+      /* FreeBSD.  */
+      if (check_note (abfd, sect, note, "FreeBSD", 4, NT_FREEBSD_ABI_TAG))
        {
-         /* XXX Should we check the version here?  Probably not
-            necessary yet.  */
-         *os_ident_ptr = GDB_OSABI_FREEBSD_ELF;
+         /* There is no need to check the version yet.  */
+         *osabi = GDB_OSABI_FREEBSD_ELF;
+         return;
        }
+
       return;
     }
-
+      
   /* .note.netbsd.ident notes, used by NetBSD.  */
-  if (strcmp (name, ".note.netbsd.ident") == 0 && sectsize > 0)
+  if (strcmp (name, ".note.netbsd.ident") == 0
+      && check_note (abfd, sect, note, "NetBSD", 4, NT_NETBSD_IDENT))
     {
-      unsigned int name_length, data_length, note_type;
-      char *note;
-
-      /* If the section is larger than this, it's probably not what we are
-        looking for.  */
-      if (sectsize > 128) 
-       sectsize = 128;
-
-      note = alloca (sectsize);
+      /* There is no need to check the version yet.  */
+      *osabi = GDB_OSABI_NETBSD_ELF;
+      return;
+    }
 
-      bfd_get_section_contents (abfd, sect, note,
-                               (file_ptr) 0, (bfd_size_type) sectsize);
-      
-      name_length = bfd_h_get_32 (abfd, note);
-      data_length = bfd_h_get_32 (abfd, note + 4);
-      note_type   = bfd_h_get_32 (abfd, note + 8);
+  /* .note.openbsd.ident notes, used by OpenBSD.  */
+  if (strcmp (name, ".note.openbsd.ident") == 0
+      && check_note (abfd, sect, note, "OpenBSD", 4, NT_OPENBSD_IDENT))
+    {
+      /* There is no need to check the version yet.  */
+      *osabi = GDB_OSABI_OPENBSD_ELF;
+      return;
+    }
 
-      if (name_length == 7 && data_length == 4 && note_type == NT_NETBSD_IDENT
-         && strcmp (note + 12, "NetBSD") == 0)
-       {
-         /* XXX Should we check the version here?  Probably not
-            necessary yet.  */
-         *os_ident_ptr = GDB_OSABI_NETBSD_ELF;
-       }
+  /* .note.netbsdcore.procinfo notes, used by NetBSD.  */
+  if (strcmp (name, ".note.netbsdcore.procinfo") == 0)
+    {
+      *osabi = GDB_OSABI_NETBSD_ELF;
       return;
     }
 }
@@ -396,10 +492,11 @@ generic_elf_osabi_sniffer (bfd *abfd)
   switch (elfosabi)
     {
     case ELFOSABI_NONE:
-      /* When elfosabi is ELFOSABI_NONE (0), then the ELF structures in the
-         file are conforming to the base specification for that machine
-        (there are no OS-specific extensions).  In order to determine the
-        real OS in use we must look for OS notes that have been added.  */
+      /* When the EI_OSABI field in the ELF header is ELFOSABI_NONE
+         (0), then the ELF structures in the file are conforming to
+         the base specification for that machine (there are no
+         OS-specific extensions).  In order to determine the real OS
+         in use we must look for OS-specific notes.  */
       bfd_map_over_sections (abfd,
                             generic_elf_osabi_sniff_abi_tag_sections,
                             &osabi);
@@ -426,7 +523,14 @@ generic_elf_osabi_sniffer (bfd *abfd)
       break;
 
     case ELFOSABI_HPUX:
+      /* For some reason the default value for the EI_OSABI field is
+         ELFOSABI_HPUX for all PA-RISC targets (with the exception of
+         GNU/Linux).  We use HP-UX ELF as the default, but let any
+         OS-specific notes override this.  */
       osabi = GDB_OSABI_HPUX_ELF;
+      bfd_map_over_sections (abfd,
+                            generic_elf_osabi_sniff_abi_tag_sections,
+                            &osabi);
       break;
     }
 
@@ -435,24 +539,95 @@ generic_elf_osabi_sniffer (bfd *abfd)
       /* The FreeBSD folks have been naughty; they stored the string
          "FreeBSD" in the padding of the e_ident field of the ELF
          header to "brand" their ELF binaries in FreeBSD 3.x.  */
-      if (strcmp (&elf_elfheader (abfd)->e_ident[8], "FreeBSD") == 0)
+      if (memcmp (&elf_elfheader (abfd)->e_ident[8],
+                 "FreeBSD", sizeof ("FreeBSD")) == 0)
        osabi = GDB_OSABI_FREEBSD_ELF;
     }
 
   return osabi;
 }
 \f
+static void
+set_osabi (char *args, int from_tty, struct cmd_list_element *c)
+{
+  struct gdbarch_info info;
+
+  if (strcmp (set_osabi_string, "auto") == 0)
+    user_osabi_state = osabi_auto;
+  else if (strcmp (set_osabi_string, "default") == 0)
+    {
+      user_selected_osabi = GDB_OSABI_DEFAULT;
+      user_osabi_state = osabi_user;
+    }
+  else if (strcmp (set_osabi_string, "none") == 0)
+    {
+      user_selected_osabi = GDB_OSABI_UNKNOWN;
+      user_osabi_state = osabi_user;
+    }
+  else
+    {
+      int i;
+      for (i = 1; i < GDB_OSABI_INVALID; i++)
+       if (strcmp (set_osabi_string, gdbarch_osabi_name (i)) == 0)
+         {
+           user_selected_osabi = i;
+           user_osabi_state = osabi_user;
+           break;
+         }
+      if (i == GDB_OSABI_INVALID)
+       internal_error (__FILE__, __LINE__,
+                       _("Invalid OS ABI \"%s\" passed to command handler."),
+                       set_osabi_string);
+    }
+
+  /* NOTE: At some point (true multiple architectures) we'll need to be more
+     graceful here.  */
+  gdbarch_info_init (&info);
+  if (! gdbarch_update_p (info))
+    internal_error (__FILE__, __LINE__, _("Updating OS ABI failed."));
+}
+
+static void
+show_osabi (struct ui_file *file, int from_tty, struct cmd_list_element *c,
+           const char *value)
+{
+  if (user_osabi_state == osabi_auto)
+    fprintf_filtered (file,
+                     _("The current OS ABI is \"auto\" (currently \"%s\").\n"),
+                     gdbarch_osabi_name (gdbarch_osabi (current_gdbarch)));
+  else
+    fprintf_filtered (file, _("The current OS ABI is \"%s\".\n"),
+                     gdbarch_osabi_name (user_selected_osabi));
+
+  if (GDB_OSABI_DEFAULT != GDB_OSABI_UNKNOWN)
+    fprintf_filtered (file, _("The default OS ABI is \"%s\".\n"),
+                     gdbarch_osabi_name (GDB_OSABI_DEFAULT));
+}
+\f
+extern initialize_file_ftype _initialize_gdb_osabi; /* -Wmissing-prototype */
 
 void
 _initialize_gdb_osabi (void)
 {
+  struct cmd_list_element *c;
+
   if (strcmp (gdb_osabi_names[GDB_OSABI_INVALID], "<invalid>") != 0)
     internal_error
       (__FILE__, __LINE__,
-       "_initialize_gdb_osabi: gdb_osabi_names[] is inconsistent");
+       _("_initialize_gdb_osabi: gdb_osabi_names[] is inconsistent"));
 
   /* Register a generic sniffer for ELF flavoured files.  */
   gdbarch_register_osabi_sniffer (bfd_arch_unknown,
                                  bfd_target_elf_flavour,
                                  generic_elf_osabi_sniffer);
+
+  /* Register the "set osabi" command.  */
+  add_setshow_enum_cmd ("osabi", class_support, gdb_osabi_available_names,
+                       &set_osabi_string, _("\
+Set OS ABI of target."), _("\
+Show OS ABI of target."), NULL,
+                       set_osabi,
+                       show_osabi,
+                       &setlist, &showlist);
+  user_osabi_state = osabi_auto;
 }
This page took 0.031185 seconds and 4 git commands to generate.