 @@ -1,14 +1,14 @@
-/*	$NetBSD: arch.c,v 1.101 2020/08/28 04:48:56 rillig Exp $	*/
+/*	$NetBSD: arch.c,v 1.102 2020/08/28 18:34:45 rillig Exp $	*/
 /*
  * Copyright (c) 1988, 1989, 1990, 1993
  *	The Regents of the University of California.  All rights reserved.
+ *
  * This code is derived from software contributed to Berkeley by
  * Adam de Boor.
+ *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
 @@ -59,34 +59,34 @@
  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  */
 #ifndef MAKE_NATIVE
-static char rcsid[] = "$NetBSD: arch.c,v 1.101 2020/08/28 04:48:56 rillig Exp $";
+static char rcsid[] = "$NetBSD: arch.c,v 1.102 2020/08/28 18:34:45 rillig Exp $";
 #else
 #include <sys/cdefs.h>
 #ifndef lint
 #if 0
 static char sccsid[] = "@(#)arch.c	8.2 (Berkeley) 1/2/94";
 #else
-__RCSID("$NetBSD: arch.c,v 1.101 2020/08/28 04:48:56 rillig Exp $");
+__RCSID("$NetBSD: arch.c,v 1.102 2020/08/28 18:34:45 rillig Exp $");
 #endif
 #endif /* not lint */
 #endif
 /*-
  * arch.c --
  *	Functions to manipulate libraries, archives and their members.
+ *
  *	Once again, cacheing/hashing comes into play in the manipulation
  * of archives. The first time an archive is referenced, all of its members'
  * headers are read and hashed and the archive closed again. All hashed
  * archives are kept on a list which is searched each time an archive member
  * is referenced.
 @@ -155,93 +155,72 @@ __RCSID("$NetBSD: arch.c,v 1.101 2020/08
 #endif
 static Lst	  archives;   /* Lst of archives we've already examined */
 typedef struct Arch {
     char	  *name;      /* Name of archive */
     Hash_Table	  members;    /* All the members of the archive described
 			       * by <name, struct ar_hdr *> key/value pairs */
     char	  *fnametab;  /* Extended name table strings */
     size_t	  fnamesize;  /* Size of the string table */
 } Arch;
 static int ArchFindArchive(const void *, const void *);
 #ifdef CLEANUP
 static void ArchFree(void *);
 #endif
 static struct ar_hdr *ArchStatMember(const char *, const char *, Boolean);
 static FILE *ArchFindMember(const char *, const char *,
 			    struct ar_hdr *, const char *);
 #if defined(__svr4__) || defined(__SVR4) || defined(__ELF__)
 #define SVR4ARCHIVES
 static int ArchSVR4Entry(Arch *, char *, size_t, FILE *);
 #endif
 #ifdef CLEANUP
 /*-
  *-----------------------------------------------------------------------
  * ArchFree --
  *	Free memory used by an archive
  * Results:
  *	None.
  * Side Effects:
  *	None.
  *-----------------------------------------------------------------------
  */
 static void
 ArchFree(void *ap)
+{
     Arch *a = (Arch *)ap;
     Hash_Search	  search;
     Hash_Entry	  *entry;
     /* Free memory from hash entries */
     for (entry = Hash_EnumFirst(&a->members, &search);
 	 entry != NULL;
 	 entry = Hash_EnumNext(&search))
 	free(Hash_GetValue(entry));
     free(a->name);
     free(a->fnametab);
     Hash_DeleteTable(&a->members);
     free(a);
+}
 #endif
 /*-
  *-----------------------------------------------------------------------
  * Arch_ParseArchive --
  *	Parse the archive specification in the given line and find/create
  *	the nodes for the specified archive members, placing their nodes
  *	on the given list.
+ *
  * Input:
  *	linePtr		Pointer to start of specification
  *	nodeLst		Lst on which to place the nodes
  *	ctxt		Context in which to expand variables
+ *
  * Results:
  *	TRUE if it was a valid specification. The linePtr is updated
  *	to point to the first non-space after the archive spec. The
  *	nodes for the members are placed on the given list.
  * Side Effects:
  *	Some nodes may be created. The given list is extended.
  *-----------------------------------------------------------------------
  */
 Boolean
 Arch_ParseArchive(char **linePtr, Lst nodeLst, GNode *ctxt)
+{
     char	    *cp;	    /* Pointer into line */
     GNode	    *gn;     	    /* New node */
     char	    *libName;  	    /* Library-part of specification */
     char	    *memName;  	    /* Member-part of specification */
     char	    saveChar;  	    /* Ending delimiter of member-name */
     Boolean 	    subLibName;	    /* TRUE if libName should have/had
 				     * variable substitution performed on it */
 @@ -478,59 +457,52 @@ Arch_ParseArchive(char **linePtr, Lst no
 /*-
  *-----------------------------------------------------------------------
  * ArchFindArchive --
  *	See if the given archive is the one we are looking for. Called
  *	From ArchStatMember and ArchFindMember via Lst_Find.
+ *
  * Input:
  *	ar		Current list element
  *	archName	Name we want
+ *
  * Results:
  *	0 if it is, non-zero if it isn't.
  * Side Effects:
  *	None.
  *-----------------------------------------------------------------------
  */
 static int
 ArchFindArchive(const void *ar, const void *archName)
+{
     return strcmp(archName, ((const Arch *)ar)->name);
+}
 /*-
  *-----------------------------------------------------------------------
  * ArchStatMember --
  *	Locate a member of an archive, given the path of the archive and
  *	the path of the desired member.
+ *
  * Input:
  *	archive		Path to the archive
  *	member		Name of member. If it is a path, only the last
  *			component is used.
  *	hash		TRUE if archive should be hashed if not already so.
+ *
  * Results:
  *	A pointer to the current struct ar_hdr structure for the member. Note
  *	That no position is returned, so this is not useful for touching
  *	archive members. This is mostly because we have no assurances that
  *	The archive will remain constant after we read all the headers, so
  *	there's not much point in remembering the position...
  * Side Effects:
  *-----------------------------------------------------------------------
  */
 static struct ar_hdr *
 ArchStatMember(const char *archive, const char *member, Boolean hash)
+{
 #define AR_MAX_NAME_LEN	    (sizeof(arh.ar_name)-1)
     FILE *	  arch;	      /* Stream to archive */
     size_t	  size;       /* Size of archive member */
     char	  magic[SARMAG];
     LstNode	  ln;	      /* Lst member containing archive descriptor */
     Arch	  *ar;	      /* Archive descriptor */
     Hash_Entry	  *he;	      /* Entry containing member's description */
     struct ar_hdr arh;        /* archive-member header for reading archive */
 @@ -719,37 +691,34 @@ badarch:
     free(ar->fnametab);
     free(ar);
     return NULL;
+}
 #ifdef SVR4ARCHIVES
 /*-
  *-----------------------------------------------------------------------
  * ArchSVR4Entry --
  *	Parse an SVR4 style entry that begins with a slash.
  *	If it is "//", then load the table of filenames
  *	If it is "/<offset>", then try to substitute the long file name
  *	from offset of a table previously read.
  *	If a table is read, the file pointer is moved to the next archive
  *	member.
+ *
  * Results:
  *	-1: Bad data in archive
  *	 0: A table was loaded from the file
  *	 1: Name was successfully substituted from table
  *	 2: Name was not successfully substituted from table
  * Side Effects:
  *	If a table is read, the file pointer is moved to the next archive
  *	member
  *-----------------------------------------------------------------------
  */
 static int
 ArchSVR4Entry(Arch *ar, char *name, size_t size, FILE *arch)
+{
 #define ARLONGNAMES1 "//"
 #define ARLONGNAMES2 "/ARFILENAMES"
     size_t entry;
     char *ptr, *eptr;
     if (strncmp(name, ARLONGNAMES1, sizeof(ARLONGNAMES1) - 1) == 0 ||
 	strncmp(name, ARLONGNAMES2, sizeof(ARLONGNAMES2) - 1) == 0) {
 @@ -818,42 +787,39 @@ ArchSVR4Entry(Arch *ar, char *name, size
     snprintf(name, MAXPATHLEN + 1, "%s", &ar->fnametab[entry]);
     return 1;
+}
 #endif
 /*-
  *-----------------------------------------------------------------------
  * ArchFindMember --
  *	Locate a member of an archive, given the path of the archive and
  *	the path of the desired member. If the archive is to be modified,
  *	the mode should be "r+", if not, it should be "r".
  *	The passed struct ar_hdr structure is filled in.
+ *
  * Input:
  *	archive		Path to the archive
  *	member		Name of member. If it is a path, only the last
  *			component is used.
  *	arhPtr		Pointer to header structure to be filled in
  *	mode		The mode for opening the stream
+ *
  * Results:
  *	An FILE *, opened for reading and writing, positioned at the
  *	start of the member's struct ar_hdr, or NULL if the member was
  *	nonexistent. The current struct ar_hdr for member.
  * Side Effects:
  *	The passed struct ar_hdr structure is filled in.
  *-----------------------------------------------------------------------
  */
 static FILE *
 ArchFindMember(const char *archive, const char *member, struct ar_hdr *arhPtr,
     const char *mode)
+{
     FILE *	  arch;	      /* Stream to archive */
     int		  size;       /* Size of archive member */
     char	  magic[SARMAG];
     size_t	  len, tlen;
     const char *  base;
     arch = fopen(archive, mode);
 @@ -979,158 +945,123 @@ skip:
     /*
      * We've looked everywhere, but the member is not to be found. Close the
      * archive and return NULL -- an error.
      */
     fclose(arch);
     return NULL;
+}
 /*-
  *-----------------------------------------------------------------------
  * Arch_Touch --
  *	Touch a member of an archive.
  *	The modification time of the entire archive is also changed.
  *	For a library, this could necessitate the re-ranlib'ing of the
  *	whole thing.
+ *
  * Input:
  *	gn		Node of member to touch
+ *
  * Results:
  *	The 'time' field of the member's header is updated.
  * Side Effects:
  *	The modification time of the entire archive is also changed.
  *	For a library, this could necessitate the re-ranlib'ing of the
  *	whole thing.
  *-----------------------------------------------------------------------
  */
 void
 Arch_Touch(GNode *gn)
+{
     FILE *	  arch;	  /* Stream open to archive, positioned properly */
     struct ar_hdr arh;	  /* Current header describing member */
     char *p1, *p2;
     arch = ArchFindMember(Var_Value(ARCHIVE, gn, &p1),
 			  Var_Value(MEMBER, gn, &p2),
 			  &arh, "r+");
     bmake_free(p1);
     bmake_free(p2);
     snprintf(arh.ar_date, sizeof(arh.ar_date), "%-12ld", (long) now);
     if (arch != NULL) {
 	(void)fwrite((char *)&arh, sizeof(struct ar_hdr), 1, arch);
 	fclose(arch);
+    }
+}
-/*-
+/* Given a node which represents a library, touch the thing, making sure that
- *-----------------------------------------------------------------------
+ * the table of contents also is touched.
  * Arch_TouchLib --
- *	Given a node which represents a library, touch the thing, making
+ * Both the modification time of the library and of the RANLIBMAG member are
- *	sure that the table of contents also is touched.
+ * set to 'now'.
+ *
  * Input:
  *	gn		The node of the library to touch
  * Results:
  *	None.
  * Side Effects:
  *	Both the modification time of the library and of the RANLIBMAG
  *	member are set to 'now'.
  *-----------------------------------------------------------------------
  */
 void
 Arch_TouchLib(GNode *gn)
+{
 #ifdef RANLIBMAG
     FILE *	    arch;	/* Stream open to archive */
     struct ar_hdr   arh;      	/* Header describing table of contents */
     struct utimbuf  times;	/* Times for utime() call */
     arch = ArchFindMember(gn->path, RANLIBMAG, &arh, "r+");
     snprintf(arh.ar_date, sizeof(arh.ar_date), "%-12ld", (long) now);
     if (arch != NULL) {
 	(void)fwrite((char *)&arh, sizeof(struct ar_hdr), 1, arch);
 	fclose(arch);
 	times.actime = times.modtime = now;
 	utime(gn->path, &times);
+    }
 #else
     (void)gn;
 #endif
+}
-/*-
+/* Return the modification time of a member of an archive. The mtime field
- *-----------------------------------------------------------------------
+ * of the given node is filled in with the value returned by the function.
  * Arch_MTime --
  *	Return the modification time of a member of an archive.
+ *
  * Input:
  *	gn		Node describing archive member
  * Results:
  *	The modification time(seconds).
  * Side Effects:
  *	The mtime field of the given node is filled in with the value
  *	returned by the function.
  *-----------------------------------------------------------------------
  */
 time_t
 Arch_MTime(GNode *gn)
+{
     struct ar_hdr *arhPtr;    /* Header of desired member */
     time_t	  modTime;    /* Modification time as an integer */
     char *p1, *p2;
     arhPtr = ArchStatMember(Var_Value(ARCHIVE, gn, &p1),
 			     Var_Value(MEMBER, gn, &p2),
 			     TRUE);
     bmake_free(p1);
     bmake_free(p2);
     if (arhPtr != NULL) {
 	modTime = (time_t)strtol(arhPtr->ar_date, NULL, 10);
     } else {
 	modTime = 0;
+    }
     gn->mtime = modTime;
     return modTime;
+}
-/*-
+/* Given a non-existent archive member's node, get its modification time from
- *-----------------------------------------------------------------------
+ * its archived form, if it exists. gn->mtime is filled in as well. */
  * Arch_MemMTime --
  *	Given a non-existent archive member's node, get its modification
  *	time from its archived form, if it exists.
  * Results:
  *	The modification time.
  * Side Effects:
  *	The mtime field is filled in.
  *-----------------------------------------------------------------------
  */
 time_t
 Arch_MemMTime(GNode *gn)
+{
     LstNode 	  ln;
     GNode   	  *pgn;
     Lst_Open(gn->parents);
     while ((ln = Lst_Next(gn->parents)) != NULL) {
 	pgn = Lst_Datum(ln);
 	if (pgn->type & OP_ARCHV) {
 	    /*
 	     * If the parent is an archive specification and is being made
 @@ -1152,108 +1083,93 @@ Arch_MemMTime(GNode *gn)
 	     * Something which isn't a library depends on the existence of
 	     * this target, so it needs to exist.
 	     */
 	    gn->mtime = 0;
 	    break;
+	}
+    }
     Lst_Close(gn->parents);
     return gn->mtime;
+}
-/*-
+/* Search for a library along the given search path.
  *-----------------------------------------------------------------------
- * Arch_FindLib --
+ * The node's 'path' field is set to the found path (including the
- *	Search for a library along the given search path.
+ * actual file name, not -l...). If the system can handle the -L
  * flag when linking (or we cannot find the library), we assume that
  * the user has placed the .LIBS variable in the final linking
  * command (or the linker will know where to find it) and set the
  * TARGET variable for this node to be the node's name. Otherwise,
  * we set the TARGET variable to be the full path of the library,
  * as returned by Dir_FindFile.
+ *
  * Input:
  *	gn		Node of library to find
  *	path		Search path
  * Results:
  *	None.
  * Side Effects:
  *	The node's 'path' field is set to the found path (including the
  *	actual file name, not -l...). If the system can handle the -L
  *	flag when linking (or we cannot find the library), we assume that
  *	the user has placed the .LIBRARIES variable in the final linking
  *	command (or the linker will know where to find it) and set the
  *	TARGET variable for this node to be the node's name. Otherwise,
  *	we set the TARGET variable to be the full path of the library,
  *	as returned by Dir_FindFile.
  *-----------------------------------------------------------------------
  */
 void
 Arch_FindLib(GNode *gn, Lst path)
+{
     char	    *libName;   /* file name for archive */
     size_t	     sz = strlen(gn->name) + 6 - 2;
     libName = bmake_malloc(sz);
     snprintf(libName, sz, "lib%s.a", &gn->name[2]);
     gn->path = Dir_FindFile(libName, path);
     free(libName);
 #ifdef LIBRARIES
     Var_Set(TARGET, gn->name, gn);
 #else
     Var_Set(TARGET, gn->path == NULL ? gn->name : gn->path, gn);
 #endif /* LIBRARIES */
+}
-/*-
+/* Decide if a node with the OP_LIB attribute is out-of-date. Called from
- *-----------------------------------------------------------------------
+ * Make_OODate to make its life easier.
- * Arch_LibOODate --
+ * The library will be hashed if it hasn't been already.
  *	Decide if a node with the OP_LIB attribute is out-of-date. Called
- *	from Make_OODate to make its life easier.
+ * There are several ways for a library to be out-of-date that are
  * not available to ordinary files. In addition, there are ways
- *	There are several ways for a library to be out-of-date that are
+ * that are open to regular files that are not available to
- *	not available to ordinary files. In addition, there are ways
+ * libraries. A library that is only used as a source is never
- *	that are open to regular files that are not available to
+ * considered out-of-date by itself. This does not preclude the
- *	libraries. A library that is only used as a source is never
+ * library's modification time from making its parent be out-of-date.
- *	considered out-of-date by itself. This does not preclude the
+ * A library will be considered out-of-date for any of these reasons,
- *	library's modification time from making its parent be out-of-date.
+ * given that it is a target on a dependency line somewhere:
  *	A library will be considered out-of-date for any of these reasons,
- *	given that it is a target on a dependency line somewhere:
+ *	Its modification time is less than that of one of its sources
- *	    Its modification time is less than that of one of its
+ *	(gn->mtime < gn->cmgn->mtime).
  *	    	  sources (gn->mtime < gn->cmgn->mtime).
- *	    Its modification time is greater than the time at which the
+ *	Its modification time is greater than the time at which the make
- *	    	  make began (i.e. it's been modified in the course
+ *	began (i.e. it's been modified in the course of the make, probably
- *	    	  of the make, probably by archiving).
+ *	by archiving).
  *	    The modification time of one of its sources is greater than
- *		  the one of its RANLIBMAG member (i.e. its table of contents
+ *	The modification time of one of its sources is greater than the one
- *	    	  is out-of-date). We don't compare of the archive time
+ *	of its RANLIBMAG member (i.e. its table of contents is out-of-date).
- *		  vs. TOC time because they can be too close. In my
+ *	We don't compare of the archive time vs. TOC time because they can be
- *		  opinion we should not bother with the TOC at all since
+ *	too close. In my opinion we should not bother with the TOC at all
- *		  this is used by 'ar' rules that affect the data contents
+ *	since this is used by 'ar' rules that affect the data contents of the
- *		  of the archive, not by ranlib rules, which affect the
+ *	archive, not by ranlib rules, which affect the TOC.
  *		  TOC.
+ *
  * Input:
  *	gn		The library's graph node
+ *
  * Results:
  *	TRUE if the library is out-of-date. FALSE otherwise.
  * Side Effects:
  *	The library will be hashed if it hasn't been already.
  *-----------------------------------------------------------------------
  */
 Boolean
 Arch_LibOODate(GNode *gn)
+{
     Boolean 	  oodate;
     if (gn->type & OP_PHONY) {
 	oodate = TRUE;
     } else if (OP_NOP(gn->type) && Lst_IsEmpty(gn->children)) {
 	oodate = FALSE;
     } else if ((!Lst_IsEmpty(gn->children) && gn->cmgn == NULL) ||
 	       (gn->mtime > now) ||
 	       (gn->cmgn != NULL && gn->mtime < gn->cmgn->mtime)) {
 @@ -1294,45 +1210,32 @@ Arch_Init(void)
+{
     archives = Lst_Init();
+}
 /* Clean up things for this module. */
 void
 Arch_End(void)
+{
 #ifdef CLEANUP
     Lst_Destroy(archives, ArchFree);
 #endif
+}
-/*-
+Boolean
  *-----------------------------------------------------------------------
  * Arch_IsLib --
  *	Check if the node is a library
  * Results:
  *	True or False.
  * Side Effects:
  *	None.
  *-----------------------------------------------------------------------
  */
 int
 Arch_IsLib(GNode *gn)
+{
     static const char armag[] = "!<arch>\n";
-    char buf[sizeof(armag)-1];
+    char buf[sizeof armag - 1];
     int fd;
     if ((fd = open(gn->path, O_RDONLY)) == -1)
 	return FALSE;
-    if (read(fd, buf, sizeof(buf)) != sizeof(buf)) {
+    if (read(fd, buf, sizeof buf) != sizeof buf) {
 	(void)close(fd);
 	return FALSE;
+    }
     (void)close(fd);
-    return memcmp(buf, armag, sizeof(buf)) == 0;
+    return memcmp(buf, armag, sizeof buf) == 0;
+}