Change bookmark allocation

[binutils-gdb.git] / bfd / format.c

diff --git a/bfd/format.c b/bfd/format.c
index f0d1e668c77d49406b3933b66327fccaa67742c1..489ffcffd530d0c86aaf515378fee40f2009e4b7 100644 (file)
--- a/bfd/format.c
+++ b/bfd/format.c
@@ -1,5 +1,5 @@
 /* Generic BFD support for file formats.
 /* Generic BFD support for file formats.

-   Copyright (C) 1990-2014 Free Software Foundation, Inc.
+   Copyright (C) 1990-2022 Free Software Foundation, Inc.

    Written by Cygnus Support.
 
    This file is part of BFD, the Binary File Descriptor library.
    Written by Cygnus Support.
 
    This file is part of BFD, the Binary File Descriptor library.


@@ -55,7 +55,7 @@ FUNCTION
        bfd_check_format
 
 SYNOPSIS
        bfd_check_format
 
 SYNOPSIS

-       bfd_boolean bfd_check_format (bfd *abfd, bfd_format format);
+       bool bfd_check_format (bfd *abfd, bfd_format format);

 
 DESCRIPTION
        Verify if the file attached to the BFD @var{abfd} is compatible
 
 DESCRIPTION
        Verify if the file attached to the BFD @var{abfd} is compatible


@@ -88,7 +88,7 @@ DESCRIPTION
        more than one backend recognised the file format.
 */
 
        more than one backend recognised the file format.
 */
 

-bfd_boolean
+bool

 bfd_check_format (bfd *abfd, bfd_format format)
 {
   return bfd_check_format_matches (abfd, format, NULL);
 bfd_check_format (bfd *abfd, bfd_format format)
 {
   return bfd_check_format_matches (abfd, format, NULL);


@@ -103,7 +103,10 @@ struct bfd_preserve
   struct bfd_section *sections;
   struct bfd_section *section_last;
   unsigned int section_count;
   struct bfd_section *sections;
   struct bfd_section *section_last;
   unsigned int section_count;

+  unsigned int section_id;

   struct bfd_hash_table section_htab;
   struct bfd_hash_table section_htab;

+  const struct bfd_build_id *build_id;
+  bfd_cleanup cleanup;

 };
 
 /* When testing an object for compatibility with a particular target
 };
 
 /* When testing an object for compatibility with a particular target


@@ -115,8 +118,9 @@ struct bfd_preserve
    subset of the bfd state works in practice.  This function stores
    the subset.  */
 
    subset of the bfd state works in practice.  This function stores
    the subset.  */
 

-static bfd_boolean
-bfd_preserve_save (bfd *abfd, struct bfd_preserve *preserve)
+static bool
+bfd_preserve_save (bfd *abfd, struct bfd_preserve *preserve,
+                  bfd_cleanup cleanup)

 {
   preserve->tdata = abfd->tdata.any;
   preserve->arch_info = abfd->arch_info;
 {
   preserve->tdata = abfd->tdata.any;
   preserve->arch_info = abfd->arch_info;


@@ -124,10 +128,13 @@ bfd_preserve_save (bfd *abfd, struct bfd_preserve *preserve)
   preserve->sections = abfd->sections;
   preserve->section_last = abfd->section_last;
   preserve->section_count = abfd->section_count;
   preserve->sections = abfd->sections;
   preserve->section_last = abfd->section_last;
   preserve->section_count = abfd->section_count;

+  preserve->section_id = _bfd_section_id;

   preserve->section_htab = abfd->section_htab;
   preserve->marker = bfd_alloc (abfd, 1);
   preserve->section_htab = abfd->section_htab;
   preserve->marker = bfd_alloc (abfd, 1);

+  preserve->build_id = abfd->build_id;
+  preserve->cleanup = cleanup;

   if (preserve->marker == NULL)
   if (preserve->marker == NULL)

-    return FALSE;
+    return false;

 
   return bfd_hash_table_init (&abfd->section_htab, bfd_section_hash_newfunc,
                              sizeof (struct section_hash_entry));
 
   return bfd_hash_table_init (&abfd->section_htab, bfd_section_hash_newfunc,
                              sizeof (struct section_hash_entry));


@@ -136,17 +143,21 @@ bfd_preserve_save (bfd *abfd, struct bfd_preserve *preserve)
 /* Clear out a subset of BFD state.  */
 
 static void
 /* Clear out a subset of BFD state.  */
 
 static void

-bfd_reinit (bfd *abfd)
+bfd_reinit (bfd *abfd, unsigned int section_id, bfd_cleanup cleanup)

 {
 {

+  _bfd_section_id = section_id;
+  if (cleanup)
+    cleanup (abfd);

   abfd->tdata.any = NULL;
   abfd->arch_info = &bfd_default_arch_struct;
   abfd->flags &= BFD_FLAGS_SAVED;
   abfd->tdata.any = NULL;
   abfd->arch_info = &bfd_default_arch_struct;
   abfd->flags &= BFD_FLAGS_SAVED;

+  abfd->build_id = NULL;

   bfd_section_list_clear (abfd);
 }
 
 /* Restores bfd state saved by bfd_preserve_save.  */
 
   bfd_section_list_clear (abfd);
 }
 
 /* Restores bfd state saved by bfd_preserve_save.  */
 

-static void
+static bfd_cleanup

 bfd_preserve_restore (bfd *abfd, struct bfd_preserve *preserve)
 {
   bfd_hash_table_free (&abfd->section_htab);
 bfd_preserve_restore (bfd *abfd, struct bfd_preserve *preserve)
 {
   bfd_hash_table_free (&abfd->section_htab);


@@ -158,11 +169,14 @@ bfd_preserve_restore (bfd *abfd, struct bfd_preserve *preserve)
   abfd->sections = preserve->sections;
   abfd->section_last = preserve->section_last;
   abfd->section_count = preserve->section_count;
   abfd->sections = preserve->sections;
   abfd->section_last = preserve->section_last;
   abfd->section_count = preserve->section_count;

+  _bfd_section_id = preserve->section_id;
+  abfd->build_id = preserve->build_id;

 
   /* bfd_release frees all memory more recently bfd_alloc'd than
      its arg, as well as its arg.  */
   bfd_release (abfd, preserve->marker);
   preserve->marker = NULL;
 
   /* bfd_release frees all memory more recently bfd_alloc'd than
      its arg, as well as its arg.  */
   bfd_release (abfd, preserve->marker);
   preserve->marker = NULL;

+  return preserve->cleanup;

 }
 
 /* Called when the bfd state saved by bfd_preserve_save is no longer
 }
 
 /* Called when the bfd state saved by bfd_preserve_save is no longer


@@ -171,6 +185,15 @@ bfd_preserve_restore (bfd *abfd, struct bfd_preserve *preserve)
 static void
 bfd_preserve_finish (bfd *abfd ATTRIBUTE_UNUSED, struct bfd_preserve *preserve)
 {
 static void
 bfd_preserve_finish (bfd *abfd ATTRIBUTE_UNUSED, struct bfd_preserve *preserve)
 {

+  if (preserve->cleanup)
+    {
+      /* Run the cleanup, assuming that all it will need is the
+        tdata at the time the cleanup was returned.  */
+      void *tdata = abfd->tdata.any;
+      abfd->tdata.any = preserve->tdata;
+      preserve->cleanup (abfd);
+      abfd->tdata.any = tdata;
+    }

   /* It would be nice to be able to free more memory here, eg. old
      tdata, but that's not possible since these blocks are sitting
      inside bfd_alloc'd memory.  The section hash is on a separate
   /* It would be nice to be able to free more memory here, eg. old
      tdata, but that's not possible since these blocks are sitting
      inside bfd_alloc'd memory.  The section hash is on a separate


@@ -184,7 +207,7 @@ FUNCTION
        bfd_check_format_matches
 
 SYNOPSIS
        bfd_check_format_matches
 
 SYNOPSIS

-       bfd_boolean bfd_check_format_matches
+       bool bfd_check_format_matches

          (bfd *abfd, bfd_format format, char ***matching);
 
 DESCRIPTION
          (bfd *abfd, bfd_format format, char ***matching);
 
 DESCRIPTION


@@ -199,16 +222,21 @@ DESCRIPTION
        should free it.
 */
 
        should free it.
 */
 

-bfd_boolean
+bool

 bfd_check_format_matches (bfd *abfd, bfd_format format, char ***matching)
 {
   extern const bfd_target binary_vec;
 bfd_check_format_matches (bfd *abfd, bfd_format format, char ***matching)
 {
   extern const bfd_target binary_vec;

+#if BFD_SUPPORTS_PLUGINS
+  extern const bfd_target plugin_vec;
+#endif

   const bfd_target * const *target;
   const bfd_target **matching_vector = NULL;
   const bfd_target *save_targ, *right_targ, *ar_right_targ, *match_targ;
   int match_count, best_count, best_match;
   int ar_match_index;
   const bfd_target * const *target;
   const bfd_target **matching_vector = NULL;
   const bfd_target *save_targ, *right_targ, *ar_right_targ, *match_targ;
   int match_count, best_count, best_match;
   int ar_match_index;

-  struct bfd_preserve preserve;
+  unsigned int initial_section_id = _bfd_section_id;
+  struct bfd_preserve preserve, preserve_match;
+  bfd_cleanup cleanup = NULL;

 
   if (matching != NULL)
     *matching = NULL;
 
   if (matching != NULL)
     *matching = NULL;


@@ -217,7 +245,7 @@ bfd_check_format_matches (bfd *abfd, bfd_format format, char ***matching)
       || (unsigned int) abfd->format >= (unsigned int) bfd_type_end)
     {
       bfd_set_error (bfd_error_invalid_operation);
       || (unsigned int) abfd->format >= (unsigned int) bfd_type_end)
     {
       bfd_set_error (bfd_error_invalid_operation);

-      return FALSE;
+      return false;

     }
 
   if (abfd->format != bfd_unknown)
     }
 
   if (abfd->format != bfd_unknown)


@@ -225,18 +253,21 @@ bfd_check_format_matches (bfd *abfd, bfd_format format, char ***matching)
 
   if (matching != NULL || *bfd_associated_vector != NULL)
     {
 
   if (matching != NULL || *bfd_associated_vector != NULL)
     {

-      bfd_size_type amt;
+      size_t amt;

 
       amt = sizeof (*matching_vector) * 2 * _bfd_target_vector_entries;
       matching_vector = (const bfd_target **) bfd_malloc (amt);
       if (!matching_vector)
 
       amt = sizeof (*matching_vector) * 2 * _bfd_target_vector_entries;
       matching_vector = (const bfd_target **) bfd_malloc (amt);
       if (!matching_vector)

-       return FALSE;
+       return false;

     }
 
   /* Presume the answer is yes.  */
   abfd->format = format;
   save_targ = abfd->xvec;
     }
 
   /* Presume the answer is yes.  */
   abfd->format = format;
   save_targ = abfd->xvec;

-  preserve.marker = NULL;
+
+  preserve_match.marker = NULL;
+  if (!bfd_preserve_save (abfd, &preserve, NULL))
+    goto err_ret;

 
   /* If the target type was explicitly specified, just check that target.  */
   if (!abfd->target_defaulted)
 
   /* If the target type was explicitly specified, just check that target.  */
   if (!abfd->target_defaulted)


@@ -244,9 +275,9 @@ bfd_check_format_matches (bfd *abfd, bfd_format format, char ***matching)
       if (bfd_seek (abfd, (file_ptr) 0, SEEK_SET) != 0)        /* rewind! */
        goto err_ret;
 
       if (bfd_seek (abfd, (file_ptr) 0, SEEK_SET) != 0)        /* rewind! */
        goto err_ret;
 

-      right_targ = BFD_SEND_FMT (abfd, _bfd_check_format, (abfd));
+      cleanup = BFD_SEND_FMT (abfd, _bfd_check_format, (abfd));

 
 

-      if (right_targ)
+      if (cleanup)

        goto ok_ret;
 
       /* For a long time the code has dropped through to check all
        goto ok_ret;
 
       /* For a long time the code has dropped through to check all


@@ -277,18 +308,32 @@ bfd_check_format_matches (bfd *abfd, bfd_format format, char ***matching)
 
   for (target = bfd_target_vector; *target != NULL; target++)
     {
 
   for (target = bfd_target_vector; *target != NULL; target++)
     {

-      const bfd_target *temp;
+      void **high_water;

 
 

-      /* Don't check the default target twice.  */
+      /* The binary target matches anything, so don't return it when
+        searching.  Don't match the plugin target if we have another
+        alternative since we want to properly set the input format
+        before allowing a plugin to claim the file.  Also, don't
+        check the default target twice.  */

       if (*target == &binary_vec
       if (*target == &binary_vec

-         || (!abfd->target_defaulted && *target == save_targ)
-         || (*target)->match_priority > best_match)
+#if BFD_SUPPORTS_PLUGINS
+         || (match_count != 0 && *target == &plugin_vec)
+#endif
+         || (!abfd->target_defaulted && *target == save_targ))

        continue;
 
       /* If we already tried a match, the bfd is modified and may
         have sections attached, which will confuse the next
         _bfd_check_format call.  */
        continue;
 
       /* If we already tried a match, the bfd is modified and may
         have sections attached, which will confuse the next
         _bfd_check_format call.  */

-      bfd_reinit (abfd);
+      bfd_reinit (abfd, initial_section_id, cleanup);
+      /* Free bfd_alloc memory too.  If we have matched and preserved
+        a target then the high water mark is that much higher.  */
+      if (preserve_match.marker)
+       high_water = &preserve_match.marker;
+      else
+       high_water = &preserve.marker;
+      bfd_release (abfd, *high_water);
+      *high_water = bfd_alloc (abfd, 1);

 
       /* Change BFD's target temporarily.  */
       abfd->xvec = *target;
 
       /* Change BFD's target temporarily.  */
       abfd->xvec = *target;


@@ -296,42 +341,44 @@ bfd_check_format_matches (bfd *abfd, bfd_format format, char ***matching)
       if (bfd_seek (abfd, (file_ptr) 0, SEEK_SET) != 0)
        goto err_ret;
 
       if (bfd_seek (abfd, (file_ptr) 0, SEEK_SET) != 0)
        goto err_ret;
 

-      /* If _bfd_check_format neglects to set bfd_error, assume
-        bfd_error_wrong_format.  We didn't used to even pay any
-        attention to bfd_error, so I suspect that some
-        _bfd_check_format might have this problem.  */
-      bfd_set_error (bfd_error_wrong_format);
-
-      temp = BFD_SEND_FMT (abfd, _bfd_check_format, (abfd));
-      if (temp)
+      cleanup = BFD_SEND_FMT (abfd, _bfd_check_format, (abfd));
+      if (cleanup)

        {
        {

-         match_targ = temp;
-         if (preserve.marker != NULL)
-           bfd_preserve_finish (abfd, &preserve);
+         int match_priority = abfd->xvec->match_priority;
+#if BFD_SUPPORTS_PLUGINS
+         /* If this object can be handled by a plugin, give that the
+            lowest priority; objects both handled by a plugin and
+            with an underlying object format will be claimed
+            separately by the plugin.  */
+         if (*target == &plugin_vec)
+           match_priority = (*target)->match_priority;
+#endif

 
          if (abfd->format != bfd_archive
              || (bfd_has_map (abfd)
                  && bfd_get_error () != bfd_error_wrong_object_format))
            {
 
          if (abfd->format != bfd_archive
              || (bfd_has_map (abfd)
                  && bfd_get_error () != bfd_error_wrong_object_format))
            {

-             /* This format checks out as ok!  */
-             right_targ = temp;
-

              /* If this is the default target, accept it, even if
                 other targets might match.  People who want those
                 other targets have to set the GNUTARGET variable.  */
              /* If this is the default target, accept it, even if
                 other targets might match.  People who want those
                 other targets have to set the GNUTARGET variable.  */

-             if (temp == bfd_default_vector[0])
+             if (abfd->xvec == bfd_default_vector[0])

                goto ok_ret;
 
              if (matching_vector)
                goto ok_ret;
 
              if (matching_vector)

-               matching_vector[match_count] = temp;
+               matching_vector[match_count] = abfd->xvec;

              match_count++;
 
              match_count++;
 

-             if (temp->match_priority < best_match)
+             if (match_priority < best_match)

                {
                {

-                 best_match = temp->match_priority;
+                 best_match = match_priority;

                  best_count = 0;
                }
                  best_count = 0;
                }

-             best_count++;
+             if (match_priority <= best_match)
+               {
+                 /* This format checks out as ok!  */
+                 right_targ = abfd->xvec;
+                 best_count++;
+               }

            }
          else
            {
            }
          else
            {


@@ -345,11 +392,14 @@ bfd_check_format_matches (bfd *abfd, bfd_format format, char ***matching)
              ar_match_index++;
            }
 
              ar_match_index++;
            }
 

-         if (!bfd_preserve_save (abfd, &preserve))
-           goto err_ret;
+         if (preserve_match.marker == NULL)
+           {
+             match_targ = abfd->xvec;
+             if (!bfd_preserve_save (abfd, &preserve_match, cleanup))
+               goto err_ret;
+             cleanup = NULL;
+           }

        }
        }

-      else if (bfd_get_error () != bfd_error_wrong_format)
-       goto err_ret;

     }
 
   if (best_count == 1)
     }
 
   if (best_count == 1)


@@ -419,22 +469,27 @@ bfd_check_format_matches (bfd *abfd, bfd_format format, char ***matching)
      really shouldn't iterate on live bfd's.  Note that saving the
      whole bfd and restoring it would be even worse; the first thing
      you notice is that the cached bfd file position gets out of sync.  */
      really shouldn't iterate on live bfd's.  Note that saving the
      whole bfd and restoring it would be even worse; the first thing
      you notice is that the cached bfd file position gets out of sync.  */

-  if (preserve.marker != NULL)
-    bfd_preserve_restore (abfd, &preserve);
+  if (preserve_match.marker != NULL)
+    cleanup = bfd_preserve_restore (abfd, &preserve_match);

 
   if (match_count == 1)
     {
       abfd->xvec = right_targ;
       /* If we come out of the loop knowing that the last target that
         matched is the one we want, then ABFD should still be in a usable
 
   if (match_count == 1)
     {
       abfd->xvec = right_targ;
       /* If we come out of the loop knowing that the last target that
         matched is the one we want, then ABFD should still be in a usable

-        state (except possibly for XVEC).  */
+        state (except possibly for XVEC).  This is not just an
+        optimisation.  In the case of plugins a match against the
+        plugin target can result in the bfd being changed such that
+        it no longer matches the plugin target, nor will it match
+        RIGHT_TARG again.  */

       if (match_targ != right_targ)
        {
       if (match_targ != right_targ)
        {

-         bfd_reinit (abfd);
+         bfd_reinit (abfd, initial_section_id, cleanup);
+         bfd_release (abfd, preserve.marker);

          if (bfd_seek (abfd, (file_ptr) 0, SEEK_SET) != 0)
            goto err_ret;
          if (bfd_seek (abfd, (file_ptr) 0, SEEK_SET) != 0)
            goto err_ret;

-         match_targ = BFD_SEND_FMT (abfd, _bfd_check_format, (abfd));
-         BFD_ASSERT (match_targ != NULL);
+         cleanup = BFD_SEND_FMT (abfd, _bfd_check_format, (abfd));
+         BFD_ASSERT (cleanup != NULL);

        }
 
     ok_ret:
        }
 
     ok_ret:


@@ -444,13 +499,15 @@ bfd_check_format_matches (bfd *abfd, bfd_format format, char ***matching)
         We can not set this flag until after checking the format,
         because it will interfere with creation of BFD sections.  */
       if (abfd->direction == both_direction)
         We can not set this flag until after checking the format,
         because it will interfere with creation of BFD sections.  */
       if (abfd->direction == both_direction)

-       abfd->output_has_begun = TRUE;
+       abfd->output_has_begun = true;

 
 

-      if (matching_vector)
-       free (matching_vector);
+      free (matching_vector);
+      if (preserve_match.marker != NULL)
+       bfd_preserve_finish (abfd, &preserve_match);
+      bfd_preserve_finish (abfd, &preserve);

 
       /* File position has moved, BTW.  */
 
       /* File position has moved, BTW.  */

-      return TRUE;
+      return true;

     }
 
   if (match_count == 0)
     }
 
   if (match_count == 0)


@@ -458,13 +515,15 @@ bfd_check_format_matches (bfd *abfd, bfd_format format, char ***matching)
     err_unrecog:
       bfd_set_error (bfd_error_file_not_recognized);
     err_ret:
     err_unrecog:
       bfd_set_error (bfd_error_file_not_recognized);
     err_ret:

+      if (cleanup)
+       cleanup (abfd);

       abfd->xvec = save_targ;
       abfd->format = bfd_unknown;
       abfd->xvec = save_targ;
       abfd->format = bfd_unknown;

-      if (matching_vector)
-       free (matching_vector);
-      if (preserve.marker != NULL)
-       bfd_preserve_restore (abfd, &preserve);
-      return FALSE;
+      free (matching_vector);
+      if (preserve_match.marker != NULL)
+       bfd_preserve_finish (abfd, &preserve_match);
+      bfd_preserve_restore (abfd, &preserve);
+      return false;

     }
 
   /* Restore original target type and format.  */
     }
 
   /* Restore original target type and format.  */


@@ -484,7 +543,14 @@ bfd_check_format_matches (bfd *abfd, bfd_format format, char ***matching)
          *(const char **) &matching_vector[match_count] = name;
        }
     }
          *(const char **) &matching_vector[match_count] = name;
        }
     }

-  return FALSE;
+  else
+    free (matching_vector);
+  if (cleanup)
+    cleanup (abfd);
+  if (preserve_match.marker != NULL)
+    bfd_preserve_finish (abfd, &preserve_match);
+  bfd_preserve_restore (abfd, &preserve);
+  return false;

 }
 
 /*
 }
 
 /*


@@ -492,7 +558,7 @@ FUNCTION
        bfd_set_format
 
 SYNOPSIS
        bfd_set_format
 
 SYNOPSIS

-       bfd_boolean bfd_set_format (bfd *abfd, bfd_format format);
+       bool bfd_set_format (bfd *abfd, bfd_format format);

 
 DESCRIPTION
        This function sets the file format of the BFD @var{abfd} to the
 
 DESCRIPTION
        This function sets the file format of the BFD @var{abfd} to the


@@ -501,14 +567,14 @@ DESCRIPTION
        is not open for writing, then an error occurs.
 */
 
        is not open for writing, then an error occurs.
 */
 

-bfd_boolean
+bool

 bfd_set_format (bfd *abfd, bfd_format format)
 {
   if (bfd_read_p (abfd)
       || (unsigned int) abfd->format >= (unsigned int) bfd_type_end)
     {
       bfd_set_error (bfd_error_invalid_operation);
 bfd_set_format (bfd *abfd, bfd_format format)
 {
   if (bfd_read_p (abfd)
       || (unsigned int) abfd->format >= (unsigned int) bfd_type_end)
     {
       bfd_set_error (bfd_error_invalid_operation);

-      return FALSE;
+      return false;

     }
 
   if (abfd->format != bfd_unknown)
     }
 
   if (abfd->format != bfd_unknown)


@@ -520,10 +586,10 @@ bfd_set_format (bfd *abfd, bfd_format format)
   if (!BFD_SEND_FMT (abfd, _bfd_set_format, (abfd)))
     {
       abfd->format = bfd_unknown;
   if (!BFD_SEND_FMT (abfd, _bfd_set_format, (abfd)))
     {
       abfd->format = bfd_unknown;

-      return FALSE;
+      return false;

     }
 
     }
 

-  return TRUE;
+  return true;

 }
 
 /*
 }
 
 /*