1 /* $NetBSD: arch.c,v 1.213 2023/02/14 21:08:00 rillig Exp $ */
2
3 /*
4 * Copyright (c) 1988, 1989, 1990, 1993
5 * The Regents of the University of California. All rights reserved.
6 *
7 * This code is derived from software contributed to Berkeley by
8 * Adam de Boor.
9 *
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.
21 *
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.
33 */
34
35 /*
36 * Copyright (c) 1989 by Berkeley Softworks
37 * All rights reserved.
38 *
39 * This code is derived from software contributed to Berkeley by
40 * Adam de Boor.
41 *
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.
57 *
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.
69 */
70
71 /*
72 * Manipulate libraries, archives and their members.
73 *
74 * The first time an archive is referenced, all of its members' headers are
75 * read and cached and the archive closed again. All cached archives are kept
76 * on a list which is searched each time an archive member is referenced.
77 *
78 * The interface to this module is:
79 *
80 * Arch_Init Initialize this module.
81 *
82 * Arch_End Clean up this module.
83 *
84 * Arch_ParseArchive
85 * Parse an archive specification such as
86 * "archive.a(member1 member2)".
87 *
88 * Arch_Touch Alter the modification time of the archive
89 * member described by the given node to be
90 * the time when make was started.
91 *
92 * Arch_TouchLib Update the modification time of the library
93 * described by the given node. This is special
94 * because it also updates the modification time
95 * of the library's table of contents.
96 *
97 * Arch_UpdateMTime
98 * Find the modification time of a member of
99 * an archive *in the archive* and place it in the
100 * member's GNode.
101 *
102 * Arch_UpdateMemberMTime
103 * Find the modification time of a member of
104 * an archive. Called when the member doesn't
105 * already exist. Looks in the archive for the
106 * modification time. Returns the modification
107 * time.
108 *
109 * Arch_FindLib Search for a library along a path. The
110 * library name in the GNode should be in
111 * -l<name> format.
112 *
113 * Arch_LibOODate Decide if a library node is out-of-date.
114 */
115
116 #ifdef HAVE_CONFIG_H
117 # include "config.h"
118 #endif
119 #include <sys/types.h>
120 #include <sys/stat.h>
121 #include <sys/time.h>
122 #include <sys/param.h>
123 #ifdef HAVE_AR_H
124 #include <ar.h>
125 #else
126 struct ar_hdr {
127 char ar_name[16]; /* name */
128 char ar_date[12]; /* modification time */
129 char ar_uid[6]; /* user id */
130 char ar_gid[6]; /* group id */
131 char ar_mode[8]; /* octal file permissions */
132 char ar_size[10]; /* size in bytes */
133 #ifndef ARFMAG
134 #define ARFMAG "`\n"
135 #endif
136 char ar_fmag[2]; /* consistency check */
137 };
138 #endif
139 #if defined(HAVE_RANLIB_H) && !(defined(__ELF__) || defined(NO_RANLIB))
140 #include <ranlib.h>
141 #endif
142 #ifdef HAVE_UTIME_H
143 #include <utime.h>
144 #endif
145
146 #include "make.h"
147 #include "dir.h"
148
149 /* "@(#)arch.c 8.2 (Berkeley) 1/2/94" */
150 MAKE_RCSID("$NetBSD: arch.c,v 1.213 2023/02/14 21:08:00 rillig Exp $");
151
152 typedef struct List ArchList;
153 typedef struct ListNode ArchListNode;
154
155 static ArchList archives; /* The archives we've already examined */
156
157 typedef struct Arch {
158 char *name; /* Name of archive */
159 HashTable members; /* All the members of the archive described
160 * by <name, struct ar_hdr *> key/value pairs */
161 char *fnametab; /* Extended name table strings */
162 size_t fnamesize; /* Size of the string table */
163 } Arch;
164
165 static FILE *ArchFindMember(const char *, const char *,
166 struct ar_hdr *, const char *);
167 #if defined(__svr4__) || defined(__SVR4) || defined(__ELF__)
168 #define SVR4ARCHIVES
169 static int ArchSVR4Entry(Arch *, char *, size_t, FILE *);
170 #endif
171
172
173 #if defined(_AIX)
174 # define AR_NAME _ar_name.ar_name
175 # define AR_FMAG _ar_name.ar_fmag
176 # define SARMAG SAIAMAG
177 # define ARMAG AIAMAG
178 # define ARFMAG AIAFMAG
179 #endif
180 #ifndef AR_NAME
181 # define AR_NAME ar_name
182 #endif
183 #ifndef AR_DATE
184 # define AR_DATE ar_date
185 #endif
186 #ifndef AR_SIZE
187 # define AR_SIZE ar_size
188 #endif
189 #ifndef AR_FMAG
190 # define AR_FMAG ar_fmag
191 #endif
192 #ifndef ARMAG
193 # define ARMAG "!<arch>\n"
194 #endif
195 #ifndef SARMAG
196 # define SARMAG 8
197 #endif
198
199
200 #ifdef CLEANUP
201 static void
ArchFree(void * ap)202 ArchFree(void *ap)
203 {
204 Arch *a = ap;
205 HashIter hi;
206
207 /* Free memory from hash entries */
208 HashIter_Init(&hi, &a->members);
209 while (HashIter_Next(&hi) != NULL)
210 free(hi.entry->value);
211
212 free(a->name);
213 free(a->fnametab);
214 HashTable_Done(&a->members);
215 free(a);
216 }
217 #endif
218
219 /* Return "archive(member)". */
220 static char *
FullName(const char * archive,const char * member)221 FullName(const char *archive, const char *member)
222 {
223 size_t len1 = strlen(archive);
224 size_t len3 = strlen(member);
225 char *result = bmake_malloc(len1 + 1 + len3 + 1 + 1);
226 memcpy(result, archive, len1);
227 memcpy(result + len1, "(", 1);
228 memcpy(result + len1 + 1, member, len3);
229 memcpy(result + len1 + 1 + len3, ")", 1 + 1);
230 return result;
231 }
232
233 /*
234 * Parse an archive specification such as "archive.a(member1 member2.${EXT})",
235 * adding nodes for the expanded members to gns. Nodes are created as
236 * necessary.
237 *
238 * Input:
239 * pp The start of the specification.
240 * gns The list on which to place the nodes.
241 * scope The scope in which to expand variables.
242 *
243 * Output:
244 * return True if it was a valid specification.
245 * *pp Points to the first non-space after the archive spec.
246 */
247 bool
Arch_ParseArchive(char ** pp,GNodeList * gns,GNode * scope)248 Arch_ParseArchive(char **pp, GNodeList *gns, GNode *scope)
249 {
250 char *spec; /* For modifying some bytes of *pp */
251 const char *cp; /* Pointer into line */
252 GNode *gn; /* New node */
253 FStr lib; /* Library-part of specification */
254 FStr mem; /* Member-part of specification */
255 char saveChar; /* Ending delimiter of member-name */
256 bool expandLib; /* Whether the parsed lib contains variable
257 * expressions that need to be expanded */
258
259 spec = *pp;
260 lib = FStr_InitRefer(spec);
261 expandLib = false;
262
263 for (cp = lib.str; *cp != '(' && *cp != '\0';) {
264 if (*cp == '$') {
265 /* Expand nested variable expressions. */
266 /* XXX: This code can probably be shortened. */
267 const char *nested_p = cp;
268 FStr result;
269 bool isError;
270
271 /* XXX: is expanded twice: once here and once below */
272 result = Var_Parse(&nested_p, scope, VARE_UNDEFERR);
273 /* TODO: handle errors */
274 isError = result.str == var_Error;
275 FStr_Done(&result);
276 if (isError)
277 return false;
278
279 expandLib = true;
280 cp += nested_p - cp;
281 } else
282 cp++;
283 }
284
285 spec[cp++ - spec] = '\0';
286 if (expandLib)
287 Var_Expand(&lib, scope, VARE_UNDEFERR);
288
289 for (;;) {
290 /*
291 * First skip to the start of the member's name, mark that
292 * place and skip to the end of it (either white-space or
293 * a close paren).
294 */
295 bool doSubst = false;
296
297 cpp_skip_whitespace(&cp);
298
299 mem = FStr_InitRefer(cp);
300 while (*cp != '\0' && *cp != ')' && !ch_isspace(*cp)) {
301 if (*cp == '$') {
302 /* Expand nested variable expressions. */
303 /*
304 * XXX: This code can probably be shortened.
305 */
306 FStr result;
307 bool isError;
308 const char *nested_p = cp;
309
310 result = Var_Parse(&nested_p, scope,
311 VARE_UNDEFERR);
312 /* TODO: handle errors */
313 isError = result.str == var_Error;
314 FStr_Done(&result);
315
316 if (isError)
317 return false;
318
319 doSubst = true;
320 cp += nested_p - cp;
321 } else {
322 cp++;
323 }
324 }
325
326 /*
327 * If the specification ends without a closing parenthesis,
328 * chances are there's something wrong (like a missing
329 * backslash), so it's better to return failure than allow
330 * such things to happen
331 */
332 if (*cp == '\0') {
333 Parse_Error(PARSE_FATAL,
334 "No closing parenthesis "
335 "in archive specification");
336 return false;
337 }
338
339 /*
340 * If we didn't move anywhere, we must be done
341 */
342 if (cp == mem.str)
343 break;
344
345 saveChar = *cp;
346 spec[cp - spec] = '\0';
347
348 /*
349 * XXX: This should be taken care of intelligently by
350 * SuffExpandChildren, both for the archive and the member
351 * portions.
352 */
353 /*
354 * If member contains variables, try and substitute for them.
355 * This slows down archive specs with dynamic sources, since
356 * they are (non-)substituted three times, but we need to do
357 * this since SuffExpandChildren calls us, otherwise we could
358 * assume the substitutions would be taken care of later.
359 */
360 if (doSubst) {
361 char *fullName;
362 char *p;
363 const char *unexpandedMem = mem.str;
364
365 Var_Expand(&mem, scope, VARE_UNDEFERR);
366
367 /*
368 * Now form an archive spec and recurse to deal with
369 * nested variables and multi-word variable values.
370 */
371 fullName = FullName(lib.str, mem.str);
372 p = fullName;
373
374 if (strcmp(mem.str, unexpandedMem) == 0) {
375 /*
376 * Must contain dynamic sources, so we can't
377 * deal with it now. Just create an ARCHV node
378 * for the thing and let SuffExpandChildren
379 * handle it.
380 */
381 gn = Targ_GetNode(fullName);
382 gn->type |= OP_ARCHV;
383 Lst_Append(gns, gn);
384
385 } else if (!Arch_ParseArchive(&p, gns, scope)) {
386 /* Error in nested call. */
387 free(fullName);
388 /* XXX: does unexpandedMemName leak? */
389 return false;
390 }
391 free(fullName);
392 /* XXX: does unexpandedMemName leak? */
393
394 } else if (Dir_HasWildcards(mem.str)) {
395 StringList members = LST_INIT;
396 SearchPath_Expand(&dirSearchPath, mem.str, &members);
397
398 while (!Lst_IsEmpty(&members)) {
399 char *member = Lst_Dequeue(&members);
400 char *fullname = FullName(lib.str, member);
401 free(member);
402
403 gn = Targ_GetNode(fullname);
404 free(fullname);
405
406 gn->type |= OP_ARCHV;
407 Lst_Append(gns, gn);
408 }
409 Lst_Done(&members);
410
411 } else {
412 char *fullname = FullName(lib.str, mem.str);
413 gn = Targ_GetNode(fullname);
414 free(fullname);
415
416 /*
417 * We've found the node, but have to make sure the
418 * rest of the world knows it's an archive member,
419 * without having to constantly check for parentheses,
420 * so we type the thing with the OP_ARCHV bit before
421 * we place it on the end of the provided list.
422 */
423 gn->type |= OP_ARCHV;
424 Lst_Append(gns, gn);
425 }
426 FStr_Done(&mem);
427
428 spec[cp - spec] = saveChar;
429 }
430
431 FStr_Done(&lib);
432
433 cp++; /* skip the ')' */
434 /* We promised that pp would be set up at the next non-space. */
435 cpp_skip_whitespace(&cp);
436 *pp += cp - *pp;
437 return true;
438 }
439
440 /*
441 * Locate a member of an archive, given the path of the archive and the path
442 * of the desired member.
443 *
444 * Input:
445 * archive Path to the archive
446 * member Name of member; only its basename is used.
447 * addToCache True if archive should be cached if not already so.
448 *
449 * Results:
450 * The ar_hdr for the member, or NULL.
451 *
452 * See ArchFindMember for an almost identical copy of this code.
453 */
454 static struct ar_hdr *
ArchStatMember(const char * archive,const char * member,bool addToCache)455 ArchStatMember(const char *archive, const char *member, bool addToCache)
456 {
457 #define AR_MAX_NAME_LEN (sizeof arh.ar_name - 1)
458 FILE *arch;
459 size_t size; /* Size of archive member */
460 char magic[SARMAG];
461 ArchListNode *ln;
462 Arch *ar; /* Archive descriptor */
463 struct ar_hdr arh; /* archive-member header for reading archive */
464 char memName[MAXPATHLEN + 1];
465 /* Current member name while hashing. */
466
467 /*
468 * Because of space constraints and similar things, files are archived
469 * using their basename, not the entire path.
470 */
471 member = str_basename(member);
472
473 for (ln = archives.first; ln != NULL; ln = ln->next) {
474 const Arch *a = ln->datum;
475 if (strcmp(a->name, archive) == 0)
476 break;
477 }
478
479 if (ln != NULL) {
480 struct ar_hdr *hdr;
481
482 ar = ln->datum;
483 hdr = HashTable_FindValue(&ar->members, member);
484 if (hdr != NULL)
485 return hdr;
486
487 {
488 /* Try truncated name */
489 char copy[AR_MAX_NAME_LEN + 1];
490 size_t len = strlen(member);
491
492 if (len > AR_MAX_NAME_LEN) {
493 snprintf(copy, sizeof copy, "%s", member);
494 hdr = HashTable_FindValue(&ar->members, copy);
495 }
496 return hdr;
497 }
498 }
499
500 if (!addToCache) {
501 /*
502 * Caller doesn't want the thing cached, just use
503 * ArchFindMember to read the header for the member out and
504 * close down the stream again. Since the archive is not to be
505 * cached, we assume there's no need to allocate extra room
506 * for the header we're returning, so just declare it static.
507 */
508 static struct ar_hdr sarh;
509
510 arch = ArchFindMember(archive, member, &sarh, "r");
511 if (arch == NULL)
512 return NULL;
513
514 fclose(arch);
515 return &sarh;
516 }
517
518 /*
519 * We don't have this archive on the list yet, so we want to find out
520 * everything that's in it and cache it so we can get at it quickly.
521 */
522 arch = fopen(archive, "r");
523 if (arch == NULL)
524 return NULL;
525
526 /*
527 * We use the ARMAG string to make sure this is an archive we
528 * can handle...
529 */
530 if (fread(magic, SARMAG, 1, arch) != 1 ||
531 strncmp(magic, ARMAG, SARMAG) != 0) {
532 (void)fclose(arch);
533 return NULL;
534 }
535
536 ar = bmake_malloc(sizeof *ar);
537 ar->name = bmake_strdup(archive);
538 ar->fnametab = NULL;
539 ar->fnamesize = 0;
540 HashTable_Init(&ar->members);
541 memName[AR_MAX_NAME_LEN] = '\0';
542
543 while (fread(&arh, sizeof arh, 1, arch) == 1) {
544 char *nameend;
545
546 /* If the header is bogus, there's no way we can recover. */
547 if (strncmp(arh.AR_FMAG, ARFMAG, sizeof arh.AR_FMAG) != 0)
548 goto badarch;
549
550 /*
551 * We need to advance the stream's pointer to the start of the
552 * next header. Files are padded with newlines to an even-byte
553 * boundary, so we need to extract the size of the file from
554 * the 'size' field of the header and round it up during the
555 * seek.
556 */
557 arh.AR_SIZE[sizeof arh.AR_SIZE - 1] = '\0';
558 size = (size_t)strtol(arh.AR_SIZE, NULL, 10);
559
560 memcpy(memName, arh.AR_NAME, sizeof arh.AR_NAME);
561 nameend = memName + AR_MAX_NAME_LEN;
562 while (nameend > memName && *nameend == ' ')
563 nameend--;
564 nameend[1] = '\0';
565
566 #ifdef SVR4ARCHIVES
567 /*
568 * svr4 names are slash-terminated.
569 * Also svr4 extended the AR format.
570 */
571 if (memName[0] == '/') {
572 /* svr4 magic mode; handle it */
573 switch (ArchSVR4Entry(ar, memName, size, arch)) {
574 case -1: /* Invalid data */
575 goto badarch;
576 case 0: /* List of files entry */
577 continue;
578 default: /* Got the entry */
579 break;
580 }
581 } else {
582 if (nameend[0] == '/')
583 nameend[0] = '\0';
584 }
585 #endif
586
587 #ifdef AR_EFMT1
588 /*
589 * BSD 4.4 extended AR format: #1/<namelen>, with name as the
590 * first <namelen> bytes of the file
591 */
592 if (strncmp(memName, AR_EFMT1, sizeof AR_EFMT1 - 1) == 0 &&
593 ch_isdigit(memName[sizeof AR_EFMT1 - 1])) {
594
595 size_t elen = (size_t)atoi(
596 memName + sizeof AR_EFMT1 - 1);
597
598 if (elen > MAXPATHLEN)
599 goto badarch;
600 if (fread(memName, elen, 1, arch) != 1)
601 goto badarch;
602 memName[elen] = '\0';
603 if (fseek(arch, -(long)elen, SEEK_CUR) != 0)
604 goto badarch;
605 if (DEBUG(ARCH) || DEBUG(MAKE))
606 debug_printf(
607 "ArchStatMember: "
608 "Extended format entry for %s\n",
609 memName);
610 }
611 #endif
612
613 {
614 struct ar_hdr *cached_hdr = bmake_malloc(
615 sizeof *cached_hdr);
616 memcpy(cached_hdr, &arh, sizeof arh);
617 HashTable_Set(&ar->members, memName, cached_hdr);
618 }
619
620 if (fseek(arch, ((long)size + 1) & ~1, SEEK_CUR) != 0)
621 goto badarch;
622 }
623
624 fclose(arch);
625
626 Lst_Append(&archives, ar);
627
628 /*
629 * Now that the archive has been read and cached, we can look into
630 * the addToCache table to find the desired member's header.
631 */
632 return HashTable_FindValue(&ar->members, member);
633
634 badarch:
635 fclose(arch);
636 HashTable_Done(&ar->members);
637 free(ar->fnametab);
638 free(ar);
639 return NULL;
640 }
641
642 #ifdef SVR4ARCHIVES
643 /*
644 * Parse an SVR4 style entry that begins with a slash.
645 * If it is "//", then load the table of filenames.
646 * If it is "/<offset>", then try to substitute the long file name
647 * from offset of a table previously read.
648 * If a table is read, the file pointer is moved to the next archive member.
649 *
650 * Results:
651 * -1: Bad data in archive
652 * 0: A table was loaded from the file
653 * 1: Name was successfully substituted from table
654 * 2: Name was not successfully substituted from table
655 */
656 static int
ArchSVR4Entry(Arch * ar,char * inout_name,size_t size,FILE * arch)657 ArchSVR4Entry(Arch *ar, char *inout_name, size_t size, FILE *arch)
658 {
659 #define ARLONGNAMES1 "//"
660 #define ARLONGNAMES2 "/ARFILENAMES"
661 size_t entry;
662 char *ptr, *eptr;
663
664 if (strncmp(inout_name, ARLONGNAMES1, sizeof ARLONGNAMES1 - 1) == 0 ||
665 strncmp(inout_name, ARLONGNAMES2, sizeof ARLONGNAMES2 - 1) == 0) {
666
667 if (ar->fnametab != NULL) {
668 DEBUG0(ARCH,
669 "Attempted to redefine an SVR4 name table\n");
670 return -1;
671 }
672
673 /*
674 * This is a table of archive names, so we build one for
675 * ourselves
676 */
677 ar->fnametab = bmake_malloc(size);
678 ar->fnamesize = size;
679
680 if (fread(ar->fnametab, size, 1, arch) != 1) {
681 DEBUG0(ARCH, "Reading an SVR4 name table failed\n");
682 return -1;
683 }
684 eptr = ar->fnametab + size;
685 for (entry = 0, ptr = ar->fnametab; ptr < eptr; ptr++)
686 if (*ptr == '/') {
687 entry++;
688 *ptr = '\0';
689 }
690 DEBUG1(ARCH,
691 "Found svr4 archive name table with %lu entries\n",
692 (unsigned long)entry);
693 return 0;
694 }
695
696 if (inout_name[1] == ' ' || inout_name[1] == '\0')
697 return 2;
698
699 entry = (size_t)strtol(&inout_name[1], &eptr, 0);
700 if ((*eptr != ' ' && *eptr != '\0') || eptr == &inout_name[1]) {
701 DEBUG1(ARCH, "Could not parse SVR4 name %s\n", inout_name);
702 return 2;
703 }
704 if (entry >= ar->fnamesize) {
705 DEBUG2(ARCH, "SVR4 entry offset %s is greater than %lu\n",
706 inout_name, (unsigned long)ar->fnamesize);
707 return 2;
708 }
709
710 DEBUG2(ARCH, "Replaced %s with %s\n", inout_name, &ar->fnametab[entry]);
711
712 snprintf(inout_name, MAXPATHLEN + 1, "%s", &ar->fnametab[entry]);
713 return 1;
714 }
715 #endif
716
717
718 static bool
ArchiveMember_HasName(const struct ar_hdr * hdr,const char * name,size_t namelen)719 ArchiveMember_HasName(const struct ar_hdr *hdr,
720 const char *name, size_t namelen)
721 {
722 const size_t ar_name_len = sizeof hdr->AR_NAME;
723 const char *ar_name = hdr->AR_NAME;
724
725 if (strncmp(ar_name, name, namelen) != 0)
726 return false;
727
728 if (namelen >= ar_name_len)
729 return namelen == ar_name_len;
730
731 /* hdr->AR_NAME is space-padded to the right. */
732 if (ar_name[namelen] == ' ')
733 return true;
734
735 /*
736 * In archives created by GNU binutils 2.27, the member names end
737 * with a slash.
738 */
739 if (ar_name[namelen] == '/' &&
740 (namelen == ar_name_len || ar_name[namelen + 1] == ' '))
741 return true;
742
743 return false;
744 }
745
746 /*
747 * Locate a member of an archive, given the path of the archive and the path
748 * of the desired member.
749 *
750 * Input:
751 * archive Path to the archive
752 * member Name of member. If it is a path, only the last
753 * component is used.
754 * out_arh Archive header to be filled in
755 * mode "r" for read-only access, "r+" for read-write access
756 *
757 * Output:
758 * return The archive file, positioned at the start of the
759 * member's struct ar_hdr, or NULL if the member doesn't
760 * exist.
761 * *out_arh The current struct ar_hdr for member.
762 *
763 * See ArchStatMember for an almost identical copy of this code.
764 */
765 static FILE *
ArchFindMember(const char * archive,const char * member,struct ar_hdr * out_arh,const char * mode)766 ArchFindMember(const char *archive, const char *member, struct ar_hdr *out_arh,
767 const char *mode)
768 {
769 FILE *arch; /* Stream to archive */
770 int size; /* Size of archive member */
771 char magic[SARMAG];
772 size_t len;
773
774 arch = fopen(archive, mode);
775 if (arch == NULL)
776 return NULL;
777
778 /*
779 * We use the ARMAG string to make sure this is an archive we
780 * can handle...
781 */
782 if (fread(magic, SARMAG, 1, arch) != 1 ||
783 strncmp(magic, ARMAG, SARMAG) != 0) {
784 fclose(arch);
785 return NULL;
786 }
787
788 /*
789 * Because of space constraints and similar things, files are archived
790 * using their basename, not the entire path.
791 */
792 member = str_basename(member);
793
794 len = strlen(member);
795
796 while (fread(out_arh, sizeof *out_arh, 1, arch) == 1) {
797
798 if (strncmp(out_arh->AR_FMAG, ARFMAG,
799 sizeof out_arh->AR_FMAG) != 0) {
800 /*
801 * The header is bogus, so the archive is bad
802 * and there's no way we can recover...
803 */
804 fclose(arch);
805 return NULL;
806 }
807
808 DEBUG5(ARCH, "Reading archive %s member %.*s mtime %.*s\n",
809 archive,
810 (int)sizeof out_arh->AR_NAME, out_arh->AR_NAME,
811 (int)sizeof out_arh->ar_date, out_arh->ar_date);
812
813 if (ArchiveMember_HasName(out_arh, member, len)) {
814 /*
815 * To make life easier for callers that want to update
816 * the archive, we reposition the file at the start of
817 * the header we just read before we return the
818 * stream. In a more general situation, it might be
819 * better to leave the file at the actual member,
820 * rather than its header, but not here.
821 */
822 if (fseek(arch, -(long)sizeof *out_arh, SEEK_CUR) !=
823 0) {
824 fclose(arch);
825 return NULL;
826 }
827 return arch;
828 }
829
830 #ifdef AR_EFMT1
831 /*
832 * BSD 4.4 extended AR format: #1/<namelen>, with name as the
833 * first <namelen> bytes of the file
834 */
835 if (strncmp(out_arh->AR_NAME, AR_EFMT1, sizeof AR_EFMT1 - 1) ==
836 0 &&
837 (ch_isdigit(out_arh->AR_NAME[sizeof AR_EFMT1 - 1]))) {
838 size_t elen = (size_t)atoi(
839 &out_arh->AR_NAME[sizeof AR_EFMT1 - 1]);
840 char ename[MAXPATHLEN + 1];
841
842 if (elen > MAXPATHLEN) {
843 fclose(arch);
844 return NULL;
845 }
846 if (fread(ename, elen, 1, arch) != 1) {
847 fclose(arch);
848 return NULL;
849 }
850 ename[elen] = '\0';
851 if (DEBUG(ARCH) || DEBUG(MAKE))
852 debug_printf(
853 "ArchFindMember: "
854 "Extended format entry for %s\n",
855 ename);
856 if (strncmp(ename, member, len) == 0) {
857 /* Found as extended name */
858 if (fseek(arch,
859 -(long)(sizeof(struct ar_hdr) - elen),
860 SEEK_CUR) != 0) {
861 fclose(arch);
862 return NULL;
863 }
864 return arch;
865 }
866 if (fseek(arch, -(long)elen, SEEK_CUR) != 0) {
867 fclose(arch);
868 return NULL;
869 }
870 }
871 #endif
872
873 /*
874 * This isn't the member we're after, so we need to advance the
875 * stream's pointer to the start of the next header. Files are
876 * padded with newlines to an even-byte boundary, so we need to
877 * extract the size of the file from the 'size' field of the
878 * header and round it up during the seek.
879 */
880 out_arh->AR_SIZE[sizeof out_arh->AR_SIZE - 1] = '\0';
881 size = (int)strtol(out_arh->AR_SIZE, NULL, 10);
882 if (fseek(arch, (size + 1) & ~1L, SEEK_CUR) != 0) {
883 fclose(arch);
884 return NULL;
885 }
886 }
887
888 fclose(arch);
889 return NULL;
890 }
891
892 /*
893 * Touch a member of an archive, on disk.
894 * The GNode's modification time is left as-is.
895 *
896 * The st_mtime of the entire archive is also changed.
897 * For a library, it may be required to run ranlib after this.
898 *
899 * Input:
900 * gn Node of member to touch
901 *
902 * Results:
903 * The 'time' field of the member's header is updated.
904 */
905 void
Arch_Touch(GNode * gn)906 Arch_Touch(GNode *gn)
907 {
908 FILE *f;
909 struct ar_hdr arh;
910
911 f = ArchFindMember(GNode_VarArchive(gn), GNode_VarMember(gn), &arh,
912 "r+");
913 if (f == NULL)
914 return;
915
916 snprintf(arh.ar_date, sizeof arh.ar_date, "%-ld", (unsigned long)now);
917 (void)fwrite(&arh, sizeof arh, 1, f);
918 fclose(f); /* TODO: handle errors */
919 }
920
921 /*
922 * Given a node which represents a library, touch the thing, making sure that
923 * the table of contents is also touched.
924 *
925 * Both the modification time of the library and of the RANLIBMAG member are
926 * set to 'now'.
927 */
928 /*ARGSUSED*/
929 void
Arch_TouchLib(GNode * gn MAKE_ATTR_UNUSED)930 Arch_TouchLib(GNode *gn MAKE_ATTR_UNUSED)
931 {
932 #ifdef RANLIBMAG
933 FILE *f;
934 struct ar_hdr arh; /* Header describing table of contents */
935 struct utimbuf times;
936
937 f = ArchFindMember(gn->path, RANLIBMAG, &arh, "r+");
938 if (f == NULL)
939 return;
940
941 snprintf(arh.ar_date, sizeof arh.ar_date, "%-ld", (unsigned long)now);
942 (void)fwrite(&arh, sizeof arh, 1, f);
943 fclose(f); /* TODO: handle errors */
944
945 times.actime = times.modtime = now;
946 utime(gn->path, ×); /* TODO: handle errors */
947 #endif
948 }
949
950 /*
951 * Update the mtime of the GNode with the mtime from the archive member on
952 * disk (or in the cache).
953 */
954 void
Arch_UpdateMTime(GNode * gn)955 Arch_UpdateMTime(GNode *gn)
956 {
957 struct ar_hdr *arh;
958
959 arh = ArchStatMember(GNode_VarArchive(gn), GNode_VarMember(gn), true);
960 if (arh != NULL)
961 gn->mtime = (time_t)strtol(arh->ar_date, NULL, 10);
962 else
963 gn->mtime = 0;
964 }
965
966 /*
967 * Given a nonexistent archive member's node, update gn->mtime from its
968 * archived form, if it exists.
969 */
970 void
Arch_UpdateMemberMTime(GNode * gn)971 Arch_UpdateMemberMTime(GNode *gn)
972 {
973 GNodeListNode *ln;
974
975 for (ln = gn->parents.first; ln != NULL; ln = ln->next) {
976 GNode *pgn = ln->datum;
977
978 if (pgn->type & OP_ARCHV) {
979 /*
980 * If the parent is an archive specification and is
981 * being made and its member's name matches the name
982 * of the node we were given, record the modification
983 * time of the parent in the child. We keep searching
984 * its parents in case some other parent requires this
985 * child to exist.
986 */
987 const char *nameStart = strchr(pgn->name, '(') + 1;
988 const char *nameEnd = strchr(nameStart, ')');
989 size_t nameLen = (size_t)(nameEnd - nameStart);
990
991 if (pgn->flags.remake &&
992 strncmp(nameStart, gn->name, nameLen) == 0) {
993 Arch_UpdateMTime(pgn);
994 gn->mtime = pgn->mtime;
995 }
996 } else if (pgn->flags.remake) {
997 /*
998 * Something which isn't a library depends on the
999 * existence of this target, so it needs to exist.
1000 */
1001 gn->mtime = 0;
1002 break;
1003 }
1004 }
1005 }
1006
1007 /*
1008 * Search for a library along the given search path.
1009 *
1010 * The node's 'path' field is set to the found path (including the
1011 * actual file name, not -l...). If the system can handle the -L
1012 * flag when linking (or we cannot find the library), we assume that
1013 * the user has placed the .LIBS variable in the final linking
1014 * command (or the linker will know where to find it) and set the
1015 * TARGET variable for this node to be the node's name. Otherwise,
1016 * we set the TARGET variable to be the full path of the library,
1017 * as returned by Dir_FindFile.
1018 *
1019 * Input:
1020 * gn Node of library to find
1021 */
1022 void
Arch_FindLib(GNode * gn,SearchPath * path)1023 Arch_FindLib(GNode *gn, SearchPath *path)
1024 {
1025 char *libName = str_concat3("lib", gn->name + 2, ".a");
1026 gn->path = Dir_FindFile(libName, path);
1027 free(libName);
1028
1029 #ifdef LIBRARIES
1030 Var_Set(gn, TARGET, gn->name);
1031 #else
1032 Var_Set(gn, TARGET, GNode_Path(gn));
1033 #endif
1034 }
1035
1036 /* ARGSUSED */
1037 static bool
RanlibOODate(const GNode * gn MAKE_ATTR_UNUSED)1038 RanlibOODate(const GNode *gn MAKE_ATTR_UNUSED)
1039 {
1040 #ifdef RANLIBMAG
1041 struct ar_hdr *arh; /* Header for __.SYMDEF */
1042 int tocModTime; /* The table-of-contents' mod time */
1043
1044 arh = ArchStatMember(gn->path, RANLIBMAG, false);
1045
1046 if (arh == NULL) {
1047 /* A library without a table of contents is out-of-date. */
1048 if (DEBUG(ARCH) || DEBUG(MAKE))
1049 debug_printf("no toc...");
1050 return true;
1051 }
1052
1053 tocModTime = (int)strtol(arh->ar_date, NULL, 10);
1054
1055 if (DEBUG(ARCH) || DEBUG(MAKE))
1056 debug_printf("%s modified %s...",
1057 RANLIBMAG, Targ_FmtTime(tocModTime));
1058 return gn->youngestChild == NULL ||
1059 gn->youngestChild->mtime > tocModTime;
1060 #else
1061 return false;
1062 #endif
1063 }
1064
1065 /*
1066 * Decide if a node with the OP_LIB attribute is out-of-date. Called from
1067 * GNode_IsOODate to make its life easier.
1068 * The library is cached if it hasn't been already.
1069 *
1070 * There are several ways for a library to be out-of-date that are
1071 * not available to ordinary files. In addition, there are ways
1072 * that are open to regular files that are not available to
1073 * libraries.
1074 *
1075 * A library that is only used as a source is never
1076 * considered out-of-date by itself. This does not preclude the
1077 * library's modification time from making its parent be out-of-date.
1078 * A library will be considered out-of-date for any of these reasons,
1079 * given that it is a target on a dependency line somewhere:
1080 *
1081 * Its modification time is less than that of one of its sources
1082 * (gn->mtime < gn->youngestChild->mtime).
1083 *
1084 * Its modification time is greater than the time at which the make
1085 * began (i.e. it's been modified in the course of the make, probably
1086 * by archiving).
1087 *
1088 * The modification time of one of its sources is greater than the one
1089 * of its RANLIBMAG member (i.e. its table of contents is out-of-date).
1090 * We don't compare the archive time vs. TOC time because they can be
1091 * too close. In my opinion we should not bother with the TOC at all
1092 * since this is used by 'ar' rules that affect the data contents of the
1093 * archive, not by ranlib rules, which affect the TOC.
1094 */
1095 bool
Arch_LibOODate(GNode * gn)1096 Arch_LibOODate(GNode *gn)
1097 {
1098
1099 if (gn->type & OP_PHONY) {
1100 return true;
1101 } else if (!GNode_IsTarget(gn) && Lst_IsEmpty(&gn->children)) {
1102 return false;
1103 } else if ((!Lst_IsEmpty(&gn->children) && gn->youngestChild == NULL) ||
1104 (gn->mtime > now) ||
1105 (gn->youngestChild != NULL &&
1106 gn->mtime < gn->youngestChild->mtime)) {
1107 return true;
1108 } else {
1109 return RanlibOODate(gn);
1110 }
1111 }
1112
1113 /* Initialize the archives module. */
1114 void
Arch_Init(void)1115 Arch_Init(void)
1116 {
1117 Lst_Init(&archives);
1118 }
1119
1120 /* Clean up the archives module. */
1121 void
Arch_End(void)1122 Arch_End(void)
1123 {
1124 #ifdef CLEANUP
1125 Lst_DoneCall(&archives, ArchFree);
1126 #endif
1127 }
1128
1129 bool
Arch_IsLib(GNode * gn)1130 Arch_IsLib(GNode *gn)
1131 {
1132 static const char armag[] = "!<arch>\n";
1133 char buf[sizeof armag - 1];
1134 int fd;
1135
1136 if ((fd = open(gn->path, O_RDONLY)) == -1)
1137 return false;
1138
1139 if (read(fd, buf, sizeof buf) != sizeof buf) {
1140 (void)close(fd);
1141 return false;
1142 }
1143
1144 (void)close(fd);
1145
1146 return memcmp(buf, armag, sizeof buf) == 0;
1147 }
1148