Re: Move bfd_init to bfd.c

[Alan Modra <amodra@gmail.com>]

On Tue, Jan 10, 2023 at 10:47:25AM +0100, Jan Beulich wrote:
> On 10.01.2023 00:18, Alan Modra via Binutils wrote:
> > init.c contains just one function that doesn't do much.  Move it to
> > bfd.c and give it something to do, initialising static state.  So far
> > the only initialisation is for bfd.c static variables.
> > 
> > The idea behind reinitialising state is to see whether some set of
> > flaky oss-fuzz crashes go away.  oss-fuzz stresses binutils in ways
> > that can't occur in reality, feeding multiple testcases into the
> > internals of binutils.  So one testcase may affect the result of the
> > next testcase.
> > 
> > 	* init.c: Delete file.  Move bfd_init to..
> > 	* bfd.c (bfd_init): ..here.  Init static variables.
> > 	* Makefile.am (BFD32_LIBS): Remove init.lo.
> > 	(BFD32_LIBS_CFILES, BFD_H_FILES): Remove init.c.
> > 	* doc/local.mk: Remove mention of init.texi and init.c.
> 
> If I'm not mistaken this should also have touched bfd.texi to remove
> the inclusion of init.texi?

Yes, I just found the bad news from the buildbot.

Commit b1c95bc4dd73 resulted in
...bfd.texi:246: @include: could not find init.texi
which went unnoticed due to not building in a clean directory.

This fixes the problem by moving bfd_init earlier, giving it a
doc node, and stitching the nodes back together.

	* bfd.c (bfd_init): Move earlier.  Give it a doc inode.
	Adjust other inodes to suit.
	* doc/bfd.texi: Don't include init.texi.  Adjust nodes to suit.
	* bfd-in2.h: Regenerate.

diff --git a/bfd/bfd-in2.h b/bfd/bfd-in2.h
index bb2b30200dc..b6e417f26ec 100644
--- a/bfd/bfd-in2.h
+++ b/bfd/bfd-in2.h
@@ -7105,6 +7105,11 @@ typedef void (*bfd_assert_handler_type) (const char *bfd_formatmsg,
 
 bfd_assert_handler_type bfd_set_assert_handler (bfd_assert_handler_type);
 
+unsigned int bfd_init (void);
+
+/* Value returned by bfd_init.  */
+#define BFD_INIT_MAGIC (sizeof (struct bfd_section))
+
 long bfd_get_reloc_upper_bound (bfd *abfd, asection *sect);
 
 long bfd_canonicalize_reloc
@@ -7256,11 +7261,6 @@ bfd_vma bfd_emul_get_commonpagesize (const char *);
 
 char *bfd_demangle (bfd *, const char *, int);
 
-unsigned int bfd_init (void);
-
-/* Value returned by bfd_init.  */
-#define BFD_INIT_MAGIC (sizeof (struct bfd_section))
-
 /* Extracted from archive.c.  */
 symindex bfd_get_next_mapent
    (bfd *abfd, symindex previous, carsym **sym);
diff --git a/bfd/bfd.c b/bfd/bfd.c
index 1d1c4498938..c59e31d99e2 100644
--- a/bfd/bfd.c
+++ b/bfd/bfd.c
@@ -643,7 +643,7 @@ CODE_FRAGMENT
 \f
 /*
 INODE
-Error reporting, Miscellaneous, typedef bfd, BFD front end
+Error reporting, Initialization, typedef bfd, BFD front end
 
 SECTION
 	Error reporting
@@ -1628,10 +1628,44 @@ bfd_set_assert_handler (bfd_assert_handler_type pnew)
   _bfd_assert_handler = pnew;
   return pold;
 }
+
+/*
+INODE
+Initialization, Miscellaneous, Error reporting, BFD front end
+
+FUNCTION
+	bfd_init
+
+SYNOPSIS
+	unsigned int bfd_init (void);
+
+DESCRIPTION
+	This routine must be called before any other BFD function to
+	initialize magical internal data structures.
+	Returns a magic number, which may be used to check
+	that the bfd library is configured as expected by users.
+
+.{* Value returned by bfd_init.  *}
+.#define BFD_INIT_MAGIC (sizeof (struct bfd_section))
+.
+*/
+
+unsigned int
+bfd_init (void)
+{
+  bfd_error = bfd_error_no_error;
+  input_bfd = NULL;
+  input_error = bfd_error_no_error;
+  _bfd_error_program_name = NULL;
+  _bfd_error_internal = error_handler_fprintf;
+  _bfd_assert_handler = _bfd_default_assert_handler;
+
+  return BFD_INIT_MAGIC;
+}
 \f
 /*
 INODE
-Miscellaneous, Memory Usage, Error reporting, BFD front end
+Miscellaneous, Memory Usage, Initialization, BFD front end
 
 SECTION
 	Miscellaneous
@@ -2605,34 +2639,3 @@ _bfd_get_link_info (bfd *abfd)
 
   return elf_link_info (abfd);
 }
-
-/*
-FUNCTION
-	bfd_init
-
-SYNOPSIS
-	unsigned int bfd_init (void);
-
-DESCRIPTION
-	This routine must be called before any other BFD function to
-	initialize magical internal data structures.
-	Returns a magic number, which may be used to check
-	that the bfd library is configured as expected by users.
-
-.{* Value returned by bfd_init.  *}
-.#define BFD_INIT_MAGIC (sizeof (struct bfd_section))
-.
-*/
-
-unsigned int
-bfd_init (void)
-{
-  bfd_error = bfd_error_no_error;
-  input_bfd = NULL;
-  input_error = bfd_error_no_error;
-  _bfd_error_program_name = NULL;
-  _bfd_error_internal = error_handler_fprintf;
-  _bfd_assert_handler = _bfd_default_assert_handler;
-
-  return BFD_INIT_MAGIC;
-}
diff --git a/bfd/doc/bfd.texi b/bfd/doc/bfd.texi
index 7374e37f8cf..f348710845f 100644
--- a/bfd/doc/bfd.texi
+++ b/bfd/doc/bfd.texi
@@ -198,9 +198,9 @@ IEEE-695.
 @menu
 * typedef bfd::
 * Error reporting::
+* Initialization::
 * Miscellaneous::
 * Memory Usage::
-* Initialization::
 * Sections::
 * Symbols::
 * Archives::
@@ -219,7 +219,7 @@ IEEE-695.
 @include bfdt.texi
 @include bfdio.texi
 
-@node Memory Usage, Initialization, Miscellaneous, BFD front end
+@node Memory Usage, Sections, Miscellaneous, BFD front end
 @section Memory Usage
 BFD keeps all of its internal structures in obstacks. There is one obstack
 per open BFD file, into which the current state is stored. When a BFD is
@@ -242,10 +242,7 @@ select the greediest open BFD, close it to reclaim the memory, perform
 some operation and reopen the BFD again, to get a fresh copy of the data
 structures.
 
-@node Initialization, Sections, Memory Usage, BFD front end
-@include  init.texi
-
-@node Sections, Symbols, Initialization, BFD front end
+@node Sections, Symbols, Memory Usage, BFD front end
 @include  section.texi
 
 @node Symbols, Archives, Sections, BFD front end


-- 
Alan Modra
Australia Development Lab, IBM