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