ispfw.4: Remove extra .Pp
[dragonfly.git] / contrib / bmake / arch.c
blob1b5bab7da3e070adf957246a07f79c8827e4d24e
1 /* $NetBSD: arch.c,v 1.69 2016/04/06 09:57:00 gson Exp $ */
3 /*
4 * Copyright (c) 1988, 1989, 1990, 1993
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
8 * Adam de Boor.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
36 * Copyright (c) 1989 by Berkeley Softworks
37 * All rights reserved.
39 * This code is derived from software contributed to Berkeley by
40 * Adam de Boor.
42 * Redistribution and use in source and binary forms, with or without
43 * modification, are permitted provided that the following conditions
44 * are met:
45 * 1. Redistributions of source code must retain the above copyright
46 * notice, this list of conditions and the following disclaimer.
47 * 2. Redistributions in binary form must reproduce the above copyright
48 * notice, this list of conditions and the following disclaimer in the
49 * documentation and/or other materials provided with the distribution.
50 * 3. All advertising materials mentioning features or use of this software
51 * must display the following acknowledgement:
52 * This product includes software developed by the University of
53 * California, Berkeley and its contributors.
54 * 4. Neither the name of the University nor the names of its contributors
55 * may be used to endorse or promote products derived from this software
56 * without specific prior written permission.
58 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
59 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
60 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
61 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
62 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
63 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
64 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
65 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
66 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
67 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
68 * SUCH DAMAGE.
71 #ifndef MAKE_NATIVE
72 static char rcsid[] = "$NetBSD: arch.c,v 1.69 2016/04/06 09:57:00 gson Exp $";
73 #else
74 #include <sys/cdefs.h>
75 #ifndef lint
76 #if 0
77 static char sccsid[] = "@(#)arch.c 8.2 (Berkeley) 1/2/94";
78 #else
79 __RCSID("$NetBSD: arch.c,v 1.69 2016/04/06 09:57:00 gson Exp $");
80 #endif
81 #endif /* not lint */
82 #endif
84 /*-
85 * arch.c --
86 * Functions to manipulate libraries, archives and their members.
88 * Once again, cacheing/hashing comes into play in the manipulation
89 * of archives. The first time an archive is referenced, all of its members'
90 * headers are read and hashed and the archive closed again. All hashed
91 * archives are kept on a list which is searched each time an archive member
92 * is referenced.
94 * The interface to this module is:
95 * Arch_ParseArchive Given an archive specification, return a list
96 * of GNode's, one for each member in the spec.
97 * FAILURE is returned if the specification is
98 * invalid for some reason.
100 * Arch_Touch Alter the modification time of the archive
101 * member described by the given node to be
102 * the current time.
104 * Arch_TouchLib Update the modification time of the library
105 * described by the given node. This is special
106 * because it also updates the modification time
107 * of the library's table of contents.
109 * Arch_MTime Find the modification time of a member of
110 * an archive *in the archive*. The time is also
111 * placed in the member's GNode. Returns the
112 * modification time.
114 * Arch_MemTime Find the modification time of a member of
115 * an archive. Called when the member doesn't
116 * already exist. Looks in the archive for the
117 * modification time. Returns the modification
118 * time.
120 * Arch_FindLib Search for a library along a path. The
121 * library name in the GNode should be in
122 * -l<name> format.
124 * Arch_LibOODate Special function to decide if a library node
125 * is out-of-date.
127 * Arch_Init Initialize this module.
129 * Arch_End Cleanup this module.
132 #ifdef HAVE_CONFIG_H
133 # include "config.h"
134 #endif
135 #include <sys/types.h>
136 #include <sys/stat.h>
137 #include <sys/time.h>
138 #include <sys/param.h>
139 #ifdef HAVE_AR_H
140 #include <ar.h>
141 #else
142 struct ar_hdr {
143 char ar_name[16]; /* name */
144 char ar_date[12]; /* modification time */
145 char ar_uid[6]; /* user id */
146 char ar_gid[6]; /* group id */
147 char ar_mode[8]; /* octal file permissions */
148 char ar_size[10]; /* size in bytes */
149 #ifndef ARFMAG
150 #define ARFMAG "`\n"
151 #endif
152 char ar_fmag[2]; /* consistency check */
154 #endif
155 #if defined(HAVE_RANLIB_H) && !(defined(__ELF__) || defined(NO_RANLIB))
156 #include <ranlib.h>
157 #endif
158 #include <stdio.h>
159 #include <stdlib.h>
160 #ifdef HAVE_UTIME_H
161 #include <utime.h>
162 #endif
164 #include "make.h"
165 #include "hash.h"
166 #include "dir.h"
168 #ifdef TARGET_MACHINE
169 #undef MAKE_MACHINE
170 #define MAKE_MACHINE TARGET_MACHINE
171 #endif
172 #ifdef TARGET_MACHINE_ARCH
173 #undef MAKE_MACHINE_ARCH
174 #define MAKE_MACHINE_ARCH TARGET_MACHINE_ARCH
175 #endif
177 static Lst archives; /* Lst of archives we've already examined */
179 typedef struct Arch {
180 char *name; /* Name of archive */
181 Hash_Table members; /* All the members of the archive described
182 * by <name, struct ar_hdr *> key/value pairs */
183 char *fnametab; /* Extended name table strings */
184 size_t fnamesize; /* Size of the string table */
185 } Arch;
187 static int ArchFindArchive(const void *, const void *);
188 #ifdef CLEANUP
189 static void ArchFree(void *);
190 #endif
191 static struct ar_hdr *ArchStatMember(char *, char *, Boolean);
192 static FILE *ArchFindMember(char *, char *, struct ar_hdr *, const char *);
193 #if defined(__svr4__) || defined(__SVR4) || defined(__ELF__)
194 #define SVR4ARCHIVES
195 static int ArchSVR4Entry(Arch *, char *, size_t, FILE *);
196 #endif
199 #if defined(_AIX)
200 # define AR_NAME _ar_name.ar_name
201 # define AR_FMAG _ar_name.ar_fmag
202 # define SARMAG SAIAMAG
203 # define ARMAG AIAMAG
204 # define ARFMAG AIAFMAG
205 #endif
206 #ifndef AR_NAME
207 # define AR_NAME ar_name
208 #endif
209 #ifndef AR_DATE
210 # define AR_DATE ar_date
211 #endif
212 #ifndef AR_SIZE
213 # define AR_SIZE ar_size
214 #endif
215 #ifndef AR_FMAG
216 # define AR_FMAG ar_fmag
217 #endif
218 #ifndef ARMAG
219 # define ARMAG "!<arch>\n"
220 #endif
221 #ifndef SARMAG
222 # define SARMAG 8
223 #endif
225 #define AR_MAX_NAME_LEN (sizeof(arh.AR_NAME)-1)
227 #ifdef CLEANUP
229 *-----------------------------------------------------------------------
230 * ArchFree --
231 * Free memory used by an archive
233 * Results:
234 * None.
236 * Side Effects:
237 * None.
239 *-----------------------------------------------------------------------
241 static void
242 ArchFree(void *ap)
244 Arch *a = (Arch *)ap;
245 Hash_Search search;
246 Hash_Entry *entry;
248 /* Free memory from hash entries */
249 for (entry = Hash_EnumFirst(&a->members, &search);
250 entry != NULL;
251 entry = Hash_EnumNext(&search))
252 free(Hash_GetValue(entry));
254 free(a->name);
255 free(a->fnametab);
256 Hash_DeleteTable(&a->members);
257 free(a);
259 #endif
263 *-----------------------------------------------------------------------
264 * Arch_ParseArchive --
265 * Parse the archive specification in the given line and find/create
266 * the nodes for the specified archive members, placing their nodes
267 * on the given list.
269 * Input:
270 * linePtr Pointer to start of specification
271 * nodeLst Lst on which to place the nodes
272 * ctxt Context in which to expand variables
274 * Results:
275 * SUCCESS if it was a valid specification. The linePtr is updated
276 * to point to the first non-space after the archive spec. The
277 * nodes for the members are placed on the given list.
279 * Side Effects:
280 * Some nodes may be created. The given list is extended.
282 *-----------------------------------------------------------------------
284 ReturnStatus
285 Arch_ParseArchive(char **linePtr, Lst nodeLst, GNode *ctxt)
287 char *cp; /* Pointer into line */
288 GNode *gn; /* New node */
289 char *libName; /* Library-part of specification */
290 char *memName; /* Member-part of specification */
291 char *nameBuf; /* temporary place for node name */
292 char saveChar; /* Ending delimiter of member-name */
293 Boolean subLibName; /* TRUE if libName should have/had
294 * variable substitution performed on it */
296 libName = *linePtr;
298 subLibName = FALSE;
300 for (cp = libName; *cp != '(' && *cp != '\0'; cp++) {
301 if (*cp == '$') {
303 * Variable spec, so call the Var module to parse the puppy
304 * so we can safely advance beyond it...
306 int length;
307 void *freeIt;
308 char *result;
310 result = Var_Parse(cp, ctxt, VARF_UNDEFERR|VARF_WANTRES,
311 &length, &freeIt);
312 free(freeIt);
314 if (result == var_Error) {
315 return(FAILURE);
316 } else {
317 subLibName = TRUE;
320 cp += length-1;
324 *cp++ = '\0';
325 if (subLibName) {
326 libName = Var_Subst(NULL, libName, ctxt, VARF_UNDEFERR|VARF_WANTRES);
330 for (;;) {
332 * First skip to the start of the member's name, mark that
333 * place and skip to the end of it (either white-space or
334 * a close paren).
336 Boolean doSubst = FALSE; /* TRUE if need to substitute in memName */
338 while (*cp != '\0' && *cp != ')' && isspace ((unsigned char)*cp)) {
339 cp++;
341 memName = cp;
342 while (*cp != '\0' && *cp != ')' && !isspace ((unsigned char)*cp)) {
343 if (*cp == '$') {
345 * Variable spec, so call the Var module to parse the puppy
346 * so we can safely advance beyond it...
348 int length;
349 void *freeIt;
350 char *result;
352 result = Var_Parse(cp, ctxt, VARF_UNDEFERR|VARF_WANTRES,
353 &length, &freeIt);
354 free(freeIt);
356 if (result == var_Error) {
357 return(FAILURE);
358 } else {
359 doSubst = TRUE;
362 cp += length;
363 } else {
364 cp++;
369 * If the specification ends without a closing parenthesis,
370 * chances are there's something wrong (like a missing backslash),
371 * so it's better to return failure than allow such things to happen
373 if (*cp == '\0') {
374 printf("No closing parenthesis in archive specification\n");
375 return (FAILURE);
379 * If we didn't move anywhere, we must be done
381 if (cp == memName) {
382 break;
385 saveChar = *cp;
386 *cp = '\0';
389 * XXX: This should be taken care of intelligently by
390 * SuffExpandChildren, both for the archive and the member portions.
393 * If member contains variables, try and substitute for them.
394 * This will slow down archive specs with dynamic sources, of course,
395 * since we'll be (non-)substituting them three times, but them's
396 * the breaks -- we need to do this since SuffExpandChildren calls
397 * us, otherwise we could assume the thing would be taken care of
398 * later.
400 if (doSubst) {
401 char *buf;
402 char *sacrifice;
403 char *oldMemName = memName;
404 size_t sz;
406 memName = Var_Subst(NULL, memName, ctxt,
407 VARF_UNDEFERR|VARF_WANTRES);
410 * Now form an archive spec and recurse to deal with nested
411 * variables and multi-word variable values.... The results
412 * are just placed at the end of the nodeLst we're returning.
414 sz = strlen(memName)+strlen(libName)+3;
415 buf = sacrifice = bmake_malloc(sz);
417 snprintf(buf, sz, "%s(%s)", libName, memName);
419 if (strchr(memName, '$') && strcmp(memName, oldMemName) == 0) {
421 * Must contain dynamic sources, so we can't deal with it now.
422 * Just create an ARCHV node for the thing and let
423 * SuffExpandChildren handle it...
425 gn = Targ_FindNode(buf, TARG_CREATE);
427 if (gn == NULL) {
428 free(buf);
429 return(FAILURE);
430 } else {
431 gn->type |= OP_ARCHV;
432 (void)Lst_AtEnd(nodeLst, gn);
434 } else if (Arch_ParseArchive(&sacrifice, nodeLst, ctxt)!=SUCCESS) {
436 * Error in nested call -- free buffer and return FAILURE
437 * ourselves.
439 free(buf);
440 return(FAILURE);
443 * Free buffer and continue with our work.
445 free(buf);
446 } else if (Dir_HasWildcards(memName)) {
447 Lst members = Lst_Init(FALSE);
448 char *member;
449 size_t sz = MAXPATHLEN, nsz;
450 nameBuf = bmake_malloc(sz);
452 Dir_Expand(memName, dirSearchPath, members);
453 while (!Lst_IsEmpty(members)) {
454 member = (char *)Lst_DeQueue(members);
455 nsz = strlen(libName) + strlen(member) + 3;
456 if (sz > nsz)
457 nameBuf = bmake_realloc(nameBuf, sz = nsz * 2);
459 snprintf(nameBuf, sz, "%s(%s)", libName, member);
460 free(member);
461 gn = Targ_FindNode(nameBuf, TARG_CREATE);
462 if (gn == NULL) {
463 free(nameBuf);
464 return (FAILURE);
465 } else {
467 * We've found the node, but have to make sure the rest of
468 * the world knows it's an archive member, without having
469 * to constantly check for parentheses, so we type the
470 * thing with the OP_ARCHV bit before we place it on the
471 * end of the provided list.
473 gn->type |= OP_ARCHV;
474 (void)Lst_AtEnd(nodeLst, gn);
477 Lst_Destroy(members, NULL);
478 free(nameBuf);
479 } else {
480 size_t sz = strlen(libName) + strlen(memName) + 3;
481 nameBuf = bmake_malloc(sz);
482 snprintf(nameBuf, sz, "%s(%s)", libName, memName);
483 gn = Targ_FindNode(nameBuf, TARG_CREATE);
484 free(nameBuf);
485 if (gn == NULL) {
486 return (FAILURE);
487 } else {
489 * We've found the node, but have to make sure the rest of the
490 * world knows it's an archive member, without having to
491 * constantly check for parentheses, so we type the thing with
492 * the OP_ARCHV bit before we place it on the end of the
493 * provided list.
495 gn->type |= OP_ARCHV;
496 (void)Lst_AtEnd(nodeLst, gn);
499 if (doSubst) {
500 free(memName);
503 *cp = saveChar;
507 * If substituted libName, free it now, since we need it no longer.
509 if (subLibName) {
510 free(libName);
514 * We promised the pointer would be set up at the next non-space, so
515 * we must advance cp there before setting *linePtr... (note that on
516 * entrance to the loop, cp is guaranteed to point at a ')')
518 do {
519 cp++;
520 } while (*cp != '\0' && isspace ((unsigned char)*cp));
522 *linePtr = cp;
523 return (SUCCESS);
527 *-----------------------------------------------------------------------
528 * ArchFindArchive --
529 * See if the given archive is the one we are looking for. Called
530 * From ArchStatMember and ArchFindMember via Lst_Find.
532 * Input:
533 * ar Current list element
534 * archName Name we want
536 * Results:
537 * 0 if it is, non-zero if it isn't.
539 * Side Effects:
540 * None.
542 *-----------------------------------------------------------------------
544 static int
545 ArchFindArchive(const void *ar, const void *archName)
547 return (strcmp(archName, ((const Arch *)ar)->name));
551 *-----------------------------------------------------------------------
552 * ArchStatMember --
553 * Locate a member of an archive, given the path of the archive and
554 * the path of the desired member.
556 * Input:
557 * archive Path to the archive
558 * member Name of member. If it is a path, only the last
559 * component is used.
560 * hash TRUE if archive should be hashed if not already so.
562 * Results:
563 * A pointer to the current struct ar_hdr structure for the member. Note
564 * That no position is returned, so this is not useful for touching
565 * archive members. This is mostly because we have no assurances that
566 * The archive will remain constant after we read all the headers, so
567 * there's not much point in remembering the position...
569 * Side Effects:
571 *-----------------------------------------------------------------------
573 static struct ar_hdr *
574 ArchStatMember(char *archive, char *member, Boolean hash)
576 FILE * arch; /* Stream to archive */
577 int size; /* Size of archive member */
578 char *cp; /* Useful character pointer */
579 char magic[SARMAG];
580 LstNode ln; /* Lst member containing archive descriptor */
581 Arch *ar; /* Archive descriptor */
582 Hash_Entry *he; /* Entry containing member's description */
583 struct ar_hdr arh; /* archive-member header for reading archive */
584 char memName[MAXPATHLEN+1];
585 /* Current member name while hashing. */
588 * Because of space constraints and similar things, files are archived
589 * using their final path components, not the entire thing, so we need
590 * to point 'member' to the final component, if there is one, to make
591 * the comparisons easier...
593 cp = strrchr(member, '/');
594 if (cp != NULL) {
595 member = cp + 1;
598 ln = Lst_Find(archives, archive, ArchFindArchive);
599 if (ln != NULL) {
600 ar = (Arch *)Lst_Datum(ln);
602 he = Hash_FindEntry(&ar->members, member);
604 if (he != NULL) {
605 return ((struct ar_hdr *)Hash_GetValue(he));
606 } else {
607 /* Try truncated name */
608 char copy[AR_MAX_NAME_LEN+1];
609 size_t len = strlen(member);
611 if (len > AR_MAX_NAME_LEN) {
612 len = AR_MAX_NAME_LEN;
613 strncpy(copy, member, AR_MAX_NAME_LEN);
614 copy[AR_MAX_NAME_LEN] = '\0';
616 if ((he = Hash_FindEntry(&ar->members, copy)) != NULL)
617 return ((struct ar_hdr *)Hash_GetValue(he));
618 return NULL;
622 if (!hash) {
624 * Caller doesn't want the thing hashed, just use ArchFindMember
625 * to read the header for the member out and close down the stream
626 * again. Since the archive is not to be hashed, we assume there's
627 * no need to allocate extra room for the header we're returning,
628 * so just declare it static.
630 static struct ar_hdr sarh;
632 arch = ArchFindMember(archive, member, &sarh, "r");
634 if (arch == NULL) {
635 return NULL;
636 } else {
637 fclose(arch);
638 return (&sarh);
643 * We don't have this archive on the list yet, so we want to find out
644 * everything that's in it and cache it so we can get at it quickly.
646 arch = fopen(archive, "r");
647 if (arch == NULL) {
648 return NULL;
652 * We use the ARMAG string to make sure this is an archive we
653 * can handle...
655 if ((fread(magic, SARMAG, 1, arch) != 1) ||
656 (strncmp(magic, ARMAG, SARMAG) != 0)) {
657 fclose(arch);
658 return NULL;
661 ar = bmake_malloc(sizeof(Arch));
662 ar->name = bmake_strdup(archive);
663 ar->fnametab = NULL;
664 ar->fnamesize = 0;
665 Hash_InitTable(&ar->members, -1);
666 memName[AR_MAX_NAME_LEN] = '\0';
668 while (fread((char *)&arh, sizeof(struct ar_hdr), 1, arch) == 1) {
669 if (strncmp( arh.AR_FMAG, ARFMAG, sizeof(arh.AR_FMAG)) != 0) {
671 * The header is bogus, so the archive is bad
672 * and there's no way we can recover...
674 goto badarch;
675 } else {
677 * We need to advance the stream's pointer to the start of the
678 * next header. Files are padded with newlines to an even-byte
679 * boundary, so we need to extract the size of the file from the
680 * 'size' field of the header and round it up during the seek.
682 arh.AR_SIZE[sizeof(arh.AR_SIZE)-1] = '\0';
683 size = (int)strtol(arh.AR_SIZE, NULL, 10);
685 (void)strncpy(memName, arh.AR_NAME, sizeof(arh.AR_NAME));
686 for (cp = &memName[AR_MAX_NAME_LEN]; *cp == ' '; cp--) {
687 continue;
689 cp[1] = '\0';
691 #ifdef SVR4ARCHIVES
693 * svr4 names are slash terminated. Also svr4 extended AR format.
695 if (memName[0] == '/') {
697 * svr4 magic mode; handle it
699 switch (ArchSVR4Entry(ar, memName, size, arch)) {
700 case -1: /* Invalid data */
701 goto badarch;
702 case 0: /* List of files entry */
703 continue;
704 default: /* Got the entry */
705 break;
708 else {
709 if (cp[0] == '/')
710 cp[0] = '\0';
712 #endif
714 #ifdef AR_EFMT1
716 * BSD 4.4 extended AR format: #1/<namelen>, with name as the
717 * first <namelen> bytes of the file
719 if (strncmp(memName, AR_EFMT1, sizeof(AR_EFMT1) - 1) == 0 &&
720 isdigit((unsigned char)memName[sizeof(AR_EFMT1) - 1])) {
722 unsigned int elen = atoi(&memName[sizeof(AR_EFMT1)-1]);
724 if (elen > MAXPATHLEN)
725 goto badarch;
726 if (fread(memName, elen, 1, arch) != 1)
727 goto badarch;
728 memName[elen] = '\0';
729 fseek(arch, -elen, SEEK_CUR);
730 if (DEBUG(ARCH) || DEBUG(MAKE)) {
731 fprintf(debug_file, "ArchStat: Extended format entry for %s\n", memName);
734 #endif
736 he = Hash_CreateEntry(&ar->members, memName, NULL);
737 Hash_SetValue(he, bmake_malloc(sizeof(struct ar_hdr)));
738 memcpy(Hash_GetValue(he), &arh, sizeof(struct ar_hdr));
740 fseek(arch, (size + 1) & ~1, SEEK_CUR);
743 fclose(arch);
745 (void)Lst_AtEnd(archives, ar);
748 * Now that the archive has been read and cached, we can look into
749 * the hash table to find the desired member's header.
751 he = Hash_FindEntry(&ar->members, member);
753 if (he != NULL) {
754 return ((struct ar_hdr *)Hash_GetValue(he));
755 } else {
756 return NULL;
759 badarch:
760 fclose(arch);
761 Hash_DeleteTable(&ar->members);
762 free(ar->fnametab);
763 free(ar);
764 return NULL;
767 #ifdef SVR4ARCHIVES
769 *-----------------------------------------------------------------------
770 * ArchSVR4Entry --
771 * Parse an SVR4 style entry that begins with a slash.
772 * If it is "//", then load the table of filenames
773 * If it is "/<offset>", then try to substitute the long file name
774 * from offset of a table previously read.
776 * Results:
777 * -1: Bad data in archive
778 * 0: A table was loaded from the file
779 * 1: Name was successfully substituted from table
780 * 2: Name was not successfully substituted from table
782 * Side Effects:
783 * If a table is read, the file pointer is moved to the next archive
784 * member
786 *-----------------------------------------------------------------------
788 static int
789 ArchSVR4Entry(Arch *ar, char *name, size_t size, FILE *arch)
791 #define ARLONGNAMES1 "//"
792 #define ARLONGNAMES2 "/ARFILENAMES"
793 size_t entry;
794 char *ptr, *eptr;
796 if (strncmp(name, ARLONGNAMES1, sizeof(ARLONGNAMES1) - 1) == 0 ||
797 strncmp(name, ARLONGNAMES2, sizeof(ARLONGNAMES2) - 1) == 0) {
799 if (ar->fnametab != NULL) {
800 if (DEBUG(ARCH)) {
801 fprintf(debug_file, "Attempted to redefine an SVR4 name table\n");
803 return -1;
807 * This is a table of archive names, so we build one for
808 * ourselves
810 ar->fnametab = bmake_malloc(size);
811 ar->fnamesize = size;
813 if (fread(ar->fnametab, size, 1, arch) != 1) {
814 if (DEBUG(ARCH)) {
815 fprintf(debug_file, "Reading an SVR4 name table failed\n");
817 return -1;
819 eptr = ar->fnametab + size;
820 for (entry = 0, ptr = ar->fnametab; ptr < eptr; ptr++)
821 switch (*ptr) {
822 case '/':
823 entry++;
824 *ptr = '\0';
825 break;
827 case '\n':
828 break;
830 default:
831 break;
833 if (DEBUG(ARCH)) {
834 fprintf(debug_file, "Found svr4 archive name table with %lu entries\n",
835 (unsigned long)entry);
837 return 0;
840 if (name[1] == ' ' || name[1] == '\0')
841 return 2;
843 entry = (size_t)strtol(&name[1], &eptr, 0);
844 if ((*eptr != ' ' && *eptr != '\0') || eptr == &name[1]) {
845 if (DEBUG(ARCH)) {
846 fprintf(debug_file, "Could not parse SVR4 name %s\n", name);
848 return 2;
850 if (entry >= ar->fnamesize) {
851 if (DEBUG(ARCH)) {
852 fprintf(debug_file, "SVR4 entry offset %s is greater than %lu\n",
853 name, (unsigned long)ar->fnamesize);
855 return 2;
858 if (DEBUG(ARCH)) {
859 fprintf(debug_file, "Replaced %s with %s\n", name, &ar->fnametab[entry]);
862 (void)strncpy(name, &ar->fnametab[entry], MAXPATHLEN);
863 name[MAXPATHLEN] = '\0';
864 return 1;
866 #endif
870 *-----------------------------------------------------------------------
871 * ArchFindMember --
872 * Locate a member of an archive, given the path of the archive and
873 * the path of the desired member. If the archive is to be modified,
874 * the mode should be "r+", if not, it should be "r".
876 * Input:
877 * archive Path to the archive
878 * member Name of member. If it is a path, only the last
879 * component is used.
880 * arhPtr Pointer to header structure to be filled in
881 * mode The mode for opening the stream
883 * Results:
884 * An FILE *, opened for reading and writing, positioned at the
885 * start of the member's struct ar_hdr, or NULL if the member was
886 * nonexistent. The current struct ar_hdr for member.
888 * Side Effects:
889 * The passed struct ar_hdr structure is filled in.
891 *-----------------------------------------------------------------------
893 static FILE *
894 ArchFindMember(char *archive, char *member, struct ar_hdr *arhPtr,
895 const char *mode)
897 FILE * arch; /* Stream to archive */
898 int size; /* Size of archive member */
899 char *cp; /* Useful character pointer */
900 char magic[SARMAG];
901 size_t len, tlen;
903 arch = fopen(archive, mode);
904 if (arch == NULL) {
905 return NULL;
909 * We use the ARMAG string to make sure this is an archive we
910 * can handle...
912 if ((fread(magic, SARMAG, 1, arch) != 1) ||
913 (strncmp(magic, ARMAG, SARMAG) != 0)) {
914 fclose(arch);
915 return NULL;
919 * Because of space constraints and similar things, files are archived
920 * using their final path components, not the entire thing, so we need
921 * to point 'member' to the final component, if there is one, to make
922 * the comparisons easier...
924 cp = strrchr(member, '/');
925 if (cp != NULL) {
926 member = cp + 1;
928 len = tlen = strlen(member);
929 if (len > sizeof(arhPtr->AR_NAME)) {
930 tlen = sizeof(arhPtr->AR_NAME);
933 while (fread((char *)arhPtr, sizeof(struct ar_hdr), 1, arch) == 1) {
934 if (strncmp(arhPtr->AR_FMAG, ARFMAG, sizeof(arhPtr->AR_FMAG) ) != 0) {
936 * The header is bogus, so the archive is bad
937 * and there's no way we can recover...
939 fclose(arch);
940 return NULL;
941 } else if (strncmp(member, arhPtr->AR_NAME, tlen) == 0) {
943 * If the member's name doesn't take up the entire 'name' field,
944 * we have to be careful of matching prefixes. Names are space-
945 * padded to the right, so if the character in 'name' at the end
946 * of the matched string is anything but a space, this isn't the
947 * member we sought.
949 if (tlen != sizeof(arhPtr->AR_NAME) && arhPtr->AR_NAME[tlen] != ' '){
950 goto skip;
951 } else {
953 * To make life easier, we reposition the file at the start
954 * of the header we just read before we return the stream.
955 * In a more general situation, it might be better to leave
956 * the file at the actual member, rather than its header, but
957 * not here...
959 fseek(arch, -sizeof(struct ar_hdr), SEEK_CUR);
960 return (arch);
962 } else
963 #ifdef AR_EFMT1
965 * BSD 4.4 extended AR format: #1/<namelen>, with name as the
966 * first <namelen> bytes of the file
968 if (strncmp(arhPtr->AR_NAME, AR_EFMT1,
969 sizeof(AR_EFMT1) - 1) == 0 &&
970 isdigit((unsigned char)arhPtr->AR_NAME[sizeof(AR_EFMT1) - 1])) {
972 unsigned int elen = atoi(&arhPtr->AR_NAME[sizeof(AR_EFMT1)-1]);
973 char ename[MAXPATHLEN + 1];
975 if (elen > MAXPATHLEN) {
976 fclose(arch);
977 return NULL;
979 if (fread(ename, elen, 1, arch) != 1) {
980 fclose(arch);
981 return NULL;
983 ename[elen] = '\0';
984 if (DEBUG(ARCH) || DEBUG(MAKE)) {
985 fprintf(debug_file, "ArchFind: Extended format entry for %s\n", ename);
987 if (strncmp(ename, member, len) == 0) {
988 /* Found as extended name */
989 fseek(arch, -sizeof(struct ar_hdr) - elen, SEEK_CUR);
990 return (arch);
992 fseek(arch, -elen, SEEK_CUR);
993 goto skip;
994 } else
995 #endif
997 skip:
999 * This isn't the member we're after, so we need to advance the
1000 * stream's pointer to the start of the next header. Files are
1001 * padded with newlines to an even-byte boundary, so we need to
1002 * extract the size of the file from the 'size' field of the
1003 * header and round it up during the seek.
1005 arhPtr->ar_size[sizeof(arhPtr->AR_SIZE)-1] = '\0';
1006 size = (int)strtol(arhPtr->AR_SIZE, NULL, 10);
1007 fseek(arch, (size + 1) & ~1, SEEK_CUR);
1012 * We've looked everywhere, but the member is not to be found. Close the
1013 * archive and return NULL -- an error.
1015 fclose(arch);
1016 return NULL;
1020 *-----------------------------------------------------------------------
1021 * Arch_Touch --
1022 * Touch a member of an archive.
1024 * Input:
1025 * gn Node of member to touch
1027 * Results:
1028 * The 'time' field of the member's header is updated.
1030 * Side Effects:
1031 * The modification time of the entire archive is also changed.
1032 * For a library, this could necessitate the re-ranlib'ing of the
1033 * whole thing.
1035 *-----------------------------------------------------------------------
1037 void
1038 Arch_Touch(GNode *gn)
1040 FILE * arch; /* Stream open to archive, positioned properly */
1041 struct ar_hdr arh; /* Current header describing member */
1042 char *p1, *p2;
1044 arch = ArchFindMember(Var_Value(ARCHIVE, gn, &p1),
1045 Var_Value(MEMBER, gn, &p2),
1046 &arh, "r+");
1048 free(p1);
1049 free(p2);
1051 snprintf(arh.AR_DATE, sizeof(arh.AR_DATE), "%-12ld", (long) now);
1053 if (arch != NULL) {
1054 (void)fwrite((char *)&arh, sizeof(struct ar_hdr), 1, arch);
1055 fclose(arch);
1060 *-----------------------------------------------------------------------
1061 * Arch_TouchLib --
1062 * Given a node which represents a library, touch the thing, making
1063 * sure that the table of contents also is touched.
1065 * Input:
1066 * gn The node of the library to touch
1068 * Results:
1069 * None.
1071 * Side Effects:
1072 * Both the modification time of the library and of the RANLIBMAG
1073 * member are set to 'now'.
1075 *-----------------------------------------------------------------------
1077 void
1078 #if !defined(RANLIBMAG)
1079 Arch_TouchLib(GNode *gn MAKE_ATTR_UNUSED)
1080 #else
1081 Arch_TouchLib(GNode *gn)
1082 #endif
1084 #ifdef RANLIBMAG
1085 FILE * arch; /* Stream open to archive */
1086 struct ar_hdr arh; /* Header describing table of contents */
1087 struct utimbuf times; /* Times for utime() call */
1089 arch = ArchFindMember(gn->path, UNCONST(RANLIBMAG), &arh, "r+");
1090 snprintf(arh.AR_DATE, sizeof(arh.AR_DATE), "%-12ld", (long) now);
1092 if (arch != NULL) {
1093 (void)fwrite((char *)&arh, sizeof(struct ar_hdr), 1, arch);
1094 fclose(arch);
1096 times.actime = times.modtime = now;
1097 utime(gn->path, &times);
1099 #endif
1103 *-----------------------------------------------------------------------
1104 * Arch_MTime --
1105 * Return the modification time of a member of an archive.
1107 * Input:
1108 * gn Node describing archive member
1110 * Results:
1111 * The modification time(seconds).
1113 * Side Effects:
1114 * The mtime field of the given node is filled in with the value
1115 * returned by the function.
1117 *-----------------------------------------------------------------------
1119 time_t
1120 Arch_MTime(GNode *gn)
1122 struct ar_hdr *arhPtr; /* Header of desired member */
1123 time_t modTime; /* Modification time as an integer */
1124 char *p1, *p2;
1126 arhPtr = ArchStatMember(Var_Value(ARCHIVE, gn, &p1),
1127 Var_Value(MEMBER, gn, &p2),
1128 TRUE);
1130 free(p1);
1131 free(p2);
1133 if (arhPtr != NULL) {
1134 modTime = (time_t)strtol(arhPtr->AR_DATE, NULL, 10);
1135 } else {
1136 modTime = 0;
1139 gn->mtime = modTime;
1140 return (modTime);
1144 *-----------------------------------------------------------------------
1145 * Arch_MemMTime --
1146 * Given a non-existent archive member's node, get its modification
1147 * time from its archived form, if it exists.
1149 * Results:
1150 * The modification time.
1152 * Side Effects:
1153 * The mtime field is filled in.
1155 *-----------------------------------------------------------------------
1157 time_t
1158 Arch_MemMTime(GNode *gn)
1160 LstNode ln;
1161 GNode *pgn;
1162 char *nameStart,
1163 *nameEnd;
1165 if (Lst_Open(gn->parents) != SUCCESS) {
1166 gn->mtime = 0;
1167 return (0);
1169 while ((ln = Lst_Next(gn->parents)) != NULL) {
1170 pgn = (GNode *)Lst_Datum(ln);
1172 if (pgn->type & OP_ARCHV) {
1174 * If the parent is an archive specification and is being made
1175 * and its member's name matches the name of the node we were
1176 * given, record the modification time of the parent in the
1177 * child. We keep searching its parents in case some other
1178 * parent requires this child to exist...
1180 nameStart = strchr(pgn->name, '(') + 1;
1181 nameEnd = strchr(nameStart, ')');
1183 if ((pgn->flags & REMAKE) &&
1184 strncmp(nameStart, gn->name, nameEnd - nameStart) == 0) {
1185 gn->mtime = Arch_MTime(pgn);
1187 } else if (pgn->flags & REMAKE) {
1189 * Something which isn't a library depends on the existence of
1190 * this target, so it needs to exist.
1192 gn->mtime = 0;
1193 break;
1197 Lst_Close(gn->parents);
1199 return (gn->mtime);
1203 *-----------------------------------------------------------------------
1204 * Arch_FindLib --
1205 * Search for a library along the given search path.
1207 * Input:
1208 * gn Node of library to find
1209 * path Search path
1211 * Results:
1212 * None.
1214 * Side Effects:
1215 * The node's 'path' field is set to the found path (including the
1216 * actual file name, not -l...). If the system can handle the -L
1217 * flag when linking (or we cannot find the library), we assume that
1218 * the user has placed the .LIBRARIES variable in the final linking
1219 * command (or the linker will know where to find it) and set the
1220 * TARGET variable for this node to be the node's name. Otherwise,
1221 * we set the TARGET variable to be the full path of the library,
1222 * as returned by Dir_FindFile.
1224 *-----------------------------------------------------------------------
1226 void
1227 Arch_FindLib(GNode *gn, Lst path)
1229 char *libName; /* file name for archive */
1230 size_t sz = strlen(gn->name) + 6 - 2;
1232 libName = bmake_malloc(sz);
1233 snprintf(libName, sz, "lib%s.a", &gn->name[2]);
1235 gn->path = Dir_FindFile(libName, path);
1237 free(libName);
1239 #ifdef LIBRARIES
1240 Var_Set(TARGET, gn->name, gn, 0);
1241 #else
1242 Var_Set(TARGET, gn->path == NULL ? gn->name : gn->path, gn, 0);
1243 #endif /* LIBRARIES */
1247 *-----------------------------------------------------------------------
1248 * Arch_LibOODate --
1249 * Decide if a node with the OP_LIB attribute is out-of-date. Called
1250 * from Make_OODate to make its life easier.
1252 * There are several ways for a library to be out-of-date that are
1253 * not available to ordinary files. In addition, there are ways
1254 * that are open to regular files that are not available to
1255 * libraries. A library that is only used as a source is never
1256 * considered out-of-date by itself. This does not preclude the
1257 * library's modification time from making its parent be out-of-date.
1258 * A library will be considered out-of-date for any of these reasons,
1259 * given that it is a target on a dependency line somewhere:
1260 * Its modification time is less than that of one of its
1261 * sources (gn->mtime < gn->cmgn->mtime).
1262 * Its modification time is greater than the time at which the
1263 * make began (i.e. it's been modified in the course
1264 * of the make, probably by archiving).
1265 * The modification time of one of its sources is greater than
1266 * the one of its RANLIBMAG member (i.e. its table of contents
1267 * is out-of-date). We don't compare of the archive time
1268 * vs. TOC time because they can be too close. In my
1269 * opinion we should not bother with the TOC at all since
1270 * this is used by 'ar' rules that affect the data contents
1271 * of the archive, not by ranlib rules, which affect the
1272 * TOC.
1274 * Input:
1275 * gn The library's graph node
1277 * Results:
1278 * TRUE if the library is out-of-date. FALSE otherwise.
1280 * Side Effects:
1281 * The library will be hashed if it hasn't been already.
1283 *-----------------------------------------------------------------------
1285 Boolean
1286 Arch_LibOODate(GNode *gn)
1288 Boolean oodate;
1290 if (gn->type & OP_PHONY) {
1291 oodate = TRUE;
1292 } else if (OP_NOP(gn->type) && Lst_IsEmpty(gn->children)) {
1293 oodate = FALSE;
1294 } else if ((!Lst_IsEmpty(gn->children) && gn->cmgn == NULL) ||
1295 (gn->mtime > now) ||
1296 (gn->cmgn != NULL && gn->mtime < gn->cmgn->mtime)) {
1297 oodate = TRUE;
1298 } else {
1299 #ifdef RANLIBMAG
1300 struct ar_hdr *arhPtr; /* Header for __.SYMDEF */
1301 int modTimeTOC; /* The table-of-contents's mod time */
1303 arhPtr = ArchStatMember(gn->path, UNCONST(RANLIBMAG), FALSE);
1305 if (arhPtr != NULL) {
1306 modTimeTOC = (int)strtol(arhPtr->AR_DATE, NULL, 10);
1308 if (DEBUG(ARCH) || DEBUG(MAKE)) {
1309 fprintf(debug_file, "%s modified %s...", RANLIBMAG, Targ_FmtTime(modTimeTOC));
1311 oodate = (gn->cmgn == NULL || gn->cmgn->mtime > modTimeTOC);
1312 } else {
1314 * A library w/o a table of contents is out-of-date
1316 if (DEBUG(ARCH) || DEBUG(MAKE)) {
1317 fprintf(debug_file, "No t.o.c....");
1319 oodate = TRUE;
1321 #else
1322 oodate = FALSE;
1323 #endif
1325 return (oodate);
1329 *-----------------------------------------------------------------------
1330 * Arch_Init --
1331 * Initialize things for this module.
1333 * Results:
1334 * None.
1336 * Side Effects:
1337 * The 'archives' list is initialized.
1339 *-----------------------------------------------------------------------
1341 void
1342 Arch_Init(void)
1344 archives = Lst_Init(FALSE);
1350 *-----------------------------------------------------------------------
1351 * Arch_End --
1352 * Cleanup things for this module.
1354 * Results:
1355 * None.
1357 * Side Effects:
1358 * The 'archives' list is freed
1360 *-----------------------------------------------------------------------
1362 void
1363 Arch_End(void)
1365 #ifdef CLEANUP
1366 Lst_Destroy(archives, ArchFree);
1367 #endif
1371 *-----------------------------------------------------------------------
1372 * Arch_IsLib --
1373 * Check if the node is a library
1375 * Results:
1376 * True or False.
1378 * Side Effects:
1379 * None.
1381 *-----------------------------------------------------------------------
1384 Arch_IsLib(GNode *gn)
1386 static const char armag[] = "!<arch>\n";
1387 char buf[sizeof(armag)-1];
1388 int fd;
1390 if ((fd = open(gn->path, O_RDONLY)) == -1)
1391 return FALSE;
1393 if (read(fd, buf, sizeof(buf)) != sizeof(buf)) {
1394 (void)close(fd);
1395 return FALSE;
1398 (void)close(fd);
1400 return memcmp(buf, armag, sizeof(buf)) == 0;