Remove building with NOCRYPTO option
[minix.git] / usr.bin / make / meta.c
blob5b2a7257f9e649b7f2b481f82b3cd42fda885800
1 /* $NetBSD: meta.c,v 1.39 2015/10/10 03:58:59 sjg Exp $ */
3 /*
4 * Implement 'meta' mode.
5 * Adapted from John Birrell's patches to FreeBSD make.
6 * --sjg
7 */
8 /*
9 * Copyright (c) 2009-2010, Juniper Networks, Inc.
10 * Portions Copyright (c) 2009, John Birrell.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 #if defined(USE_META)
35 #ifdef HAVE_CONFIG_H
36 # include "config.h"
37 #endif
38 #include <sys/stat.h>
39 #include <sys/ioctl.h>
40 #include <fcntl.h>
41 #include <libgen.h>
42 #include <errno.h>
43 #if !defined(HAVE_CONFIG_H) || defined(HAVE_ERR_H)
44 #include <err.h>
45 #endif
47 #include "make.h"
48 #include "job.h"
50 #ifdef HAVE_FILEMON_H
51 # include <filemon.h>
52 #endif
53 #if !defined(USE_FILEMON) && defined(FILEMON_SET_FD)
54 # define USE_FILEMON
55 #endif
57 static BuildMon Mybm; /* for compat */
58 static Lst metaBailiwick; /* our scope of control */
59 static Lst metaIgnorePaths; /* paths we deliberately ignore */
61 #ifndef MAKE_META_IGNORE_PATHS
62 #define MAKE_META_IGNORE_PATHS ".MAKE.META.IGNORE_PATHS"
63 #endif
65 Boolean useMeta = FALSE;
66 static Boolean useFilemon = FALSE;
67 static Boolean writeMeta = FALSE;
68 static Boolean metaEnv = FALSE; /* don't save env unless asked */
69 static Boolean metaVerbose = FALSE;
70 static Boolean metaIgnoreCMDs = FALSE; /* ignore CMDs in .meta files */
71 static Boolean metaCurdirOk = FALSE; /* write .meta in .CURDIR Ok? */
72 static Boolean metaSilent = FALSE; /* if we have a .meta be SILENT */
74 extern Boolean forceJobs;
75 extern Boolean comatMake;
76 extern char **environ;
78 #define MAKE_META_PREFIX ".MAKE.META.PREFIX"
80 #ifndef N2U
81 # define N2U(n, u) (((n) + ((u) - 1)) / (u))
82 #endif
83 #ifndef ROUNDUP
84 # define ROUNDUP(n, u) (N2U((n), (u)) * (u))
85 #endif
87 #if !defined(HAVE_STRSEP)
88 # define strsep(s, d) stresep((s), (d), 0)
89 #endif
92 * Filemon is a kernel module which snoops certain syscalls.
94 * C chdir
95 * E exec
96 * F [v]fork
97 * L [sym]link
98 * M rename
99 * R read
100 * W write
101 * S stat
103 * See meta_oodate below - we mainly care about 'E' and 'R'.
105 * We can still use meta mode without filemon, but
106 * the benefits are more limited.
108 #ifdef USE_FILEMON
109 # ifndef _PATH_FILEMON
110 # define _PATH_FILEMON "/dev/filemon"
111 # endif
114 * Open the filemon device.
116 static void
117 filemon_open(BuildMon *pbm)
119 int retry;
121 pbm->mon_fd = pbm->filemon_fd = -1;
122 if (!useFilemon)
123 return;
125 for (retry = 5; retry >= 0; retry--) {
126 if ((pbm->filemon_fd = open(_PATH_FILEMON, O_RDWR)) >= 0)
127 break;
130 if (pbm->filemon_fd < 0) {
131 useFilemon = FALSE;
132 warn("Could not open %s", _PATH_FILEMON);
133 return;
137 * We use a file outside of '.'
138 * to avoid a FreeBSD kernel bug where unlink invalidates
139 * cwd causing getcwd to do a lot more work.
140 * We only care about the descriptor.
142 pbm->mon_fd = mkTempFile("filemon.XXXXXX", NULL);
143 if (ioctl(pbm->filemon_fd, FILEMON_SET_FD, &pbm->mon_fd) < 0) {
144 err(1, "Could not set filemon file descriptor!");
146 /* we don't need these once we exec */
147 (void)fcntl(pbm->mon_fd, F_SETFD, 1);
148 (void)fcntl(pbm->filemon_fd, F_SETFD, 1);
152 * Read the build monitor output file and write records to the target's
153 * metadata file.
155 static void
156 filemon_read(FILE *mfp, int fd)
158 char buf[BUFSIZ];
159 int n;
161 /* Check if we're not writing to a meta data file.*/
162 if (mfp == NULL) {
163 if (fd >= 0)
164 close(fd); /* not interested */
165 return;
167 /* rewind */
168 (void)lseek(fd, (off_t)0, SEEK_SET);
170 fprintf(mfp, "\n-- filemon acquired metadata --\n");
172 while ((n = read(fd, buf, sizeof(buf))) > 0) {
173 fwrite(buf, 1, n, mfp);
175 fflush(mfp);
176 close(fd);
178 #endif
181 * when realpath() fails,
182 * we use this, to clean up ./ and ../
184 static void
185 eat_dots(char *buf, size_t bufsz, int dots)
187 char *cp;
188 char *cp2;
189 const char *eat;
190 size_t eatlen;
192 switch (dots) {
193 case 1:
194 eat = "/./";
195 eatlen = 2;
196 break;
197 case 2:
198 eat = "/../";
199 eatlen = 3;
200 break;
201 default:
202 return;
205 do {
206 cp = strstr(buf, eat);
207 if (cp) {
208 cp2 = cp + eatlen;
209 if (dots == 2 && cp > buf) {
210 do {
211 cp--;
212 } while (cp > buf && *cp != '/');
214 if (*cp == '/') {
215 strlcpy(cp, cp2, bufsz - (cp - buf));
216 } else {
217 return; /* can't happen? */
220 } while (cp);
223 static char *
224 meta_name(struct GNode *gn, char *mname, size_t mnamelen,
225 const char *dname,
226 const char *tname)
228 char buf[MAXPATHLEN];
229 char cwd[MAXPATHLEN];
230 char *rp;
231 char *cp;
232 char *tp;
233 char *p[4]; /* >= number of possible uses */
234 int i;
236 i = 0;
237 if (!dname)
238 dname = Var_Value(".OBJDIR", gn, &p[i++]);
239 if (!tname)
240 tname = Var_Value(TARGET, gn, &p[i++]);
242 if (realpath(dname, cwd))
243 dname = cwd;
246 * Weed out relative paths from the target file name.
247 * We have to be careful though since if target is a
248 * symlink, the result will be unstable.
249 * So we use realpath() just to get the dirname, and leave the
250 * basename as given to us.
252 if ((cp = strrchr(tname, '/'))) {
253 if (realpath(tname, buf)) {
254 if ((rp = strrchr(buf, '/'))) {
255 rp++;
256 cp++;
257 if (strcmp(cp, rp) != 0)
258 strlcpy(rp, cp, sizeof(buf) - (rp - buf));
260 tname = buf;
261 } else {
263 * We likely have a directory which is about to be made.
264 * We pretend realpath() succeeded, to have a chance
265 * of generating the same meta file name that we will
266 * next time through.
268 if (tname[0] == '/') {
269 strlcpy(buf, tname, sizeof(buf));
270 } else {
271 snprintf(buf, sizeof(buf), "%s/%s", cwd, tname);
273 eat_dots(buf, sizeof(buf), 1); /* ./ */
274 eat_dots(buf, sizeof(buf), 2); /* ../ */
275 tname = buf;
278 /* on some systems dirname may modify its arg */
279 tp = bmake_strdup(tname);
280 if (strcmp(dname, dirname(tp)) == 0)
281 snprintf(mname, mnamelen, "%s.meta", tname);
282 else {
283 snprintf(mname, mnamelen, "%s/%s.meta", dname, tname);
286 * Replace path separators in the file name after the
287 * current object directory path.
289 cp = mname + strlen(dname) + 1;
291 while (*cp != '\0') {
292 if (*cp == '/')
293 *cp = '_';
294 cp++;
297 free(tp);
298 for (i--; i >= 0; i--) {
299 if (p[i])
300 free(p[i]);
302 return (mname);
306 * Return true if running ${.MAKE}
307 * Bypassed if target is flagged .MAKE
309 static int
310 is_submake(void *cmdp, void *gnp)
312 static char *p_make = NULL;
313 static int p_len;
314 char *cmd = cmdp;
315 GNode *gn = gnp;
316 char *mp = NULL;
317 char *cp;
318 char *cp2;
319 int rc = 0; /* keep looking */
321 if (!p_make) {
322 p_make = Var_Value(".MAKE", gn, &cp);
323 p_len = strlen(p_make);
325 cp = strchr(cmd, '$');
326 if ((cp)) {
327 mp = Var_Subst(NULL, cmd, gn, FALSE);
328 cmd = mp;
330 cp2 = strstr(cmd, p_make);
331 if ((cp2)) {
332 switch (cp2[p_len]) {
333 case '\0':
334 case ' ':
335 case '\t':
336 case '\n':
337 rc = 1;
338 break;
340 if (cp2 > cmd && rc > 0) {
341 switch (cp2[-1]) {
342 case ' ':
343 case '\t':
344 case '\n':
345 break;
346 default:
347 rc = 0; /* no match */
348 break;
352 if (mp)
353 free(mp);
354 return (rc);
357 typedef struct meta_file_s {
358 FILE *fp;
359 GNode *gn;
360 } meta_file_t;
362 static int
363 printCMD(void *cmdp, void *mfpp)
365 meta_file_t *mfp = mfpp;
366 char *cmd = cmdp;
367 char *cp = NULL;
369 if (strchr(cmd, '$')) {
370 cmd = cp = Var_Subst(NULL, cmd, mfp->gn, FALSE);
372 fprintf(mfp->fp, "CMD %s\n", cmd);
373 if (cp)
374 free(cp);
375 return 0;
379 * Certain node types never get a .meta file
381 #define SKIP_META_TYPE(_type) do { \
382 if ((gn->type & __CONCAT(OP_, _type))) { \
383 if (DEBUG(META)) { \
384 fprintf(debug_file, "Skipping meta for %s: .%s\n", \
385 gn->name, __STRING(_type)); \
387 return (NULL); \
389 } while (0)
391 static FILE *
392 meta_create(BuildMon *pbm, GNode *gn)
394 meta_file_t mf;
395 char buf[MAXPATHLEN];
396 char objdir[MAXPATHLEN];
397 char **ptr;
398 const char *dname;
399 const char *tname;
400 char *fname;
401 const char *cp;
402 char *p[4]; /* >= possible uses */
403 int i;
404 struct stat fs;
407 /* This may be a phony node which we don't want meta data for... */
408 /* Skip .meta for .BEGIN, .END, .ERROR etc as well. */
409 /* Or it may be explicitly flagged as .NOMETA */
410 SKIP_META_TYPE(NOMETA);
411 /* Unless it is explicitly flagged as .META */
412 if (!(gn->type & OP_META)) {
413 SKIP_META_TYPE(PHONY);
414 SKIP_META_TYPE(SPECIAL);
415 SKIP_META_TYPE(MAKE);
418 mf.fp = NULL;
420 i = 0;
422 dname = Var_Value(".OBJDIR", gn, &p[i++]);
423 tname = Var_Value(TARGET, gn, &p[i++]);
425 /* The object directory may not exist. Check it.. */
426 if (stat(dname, &fs) != 0) {
427 if (DEBUG(META))
428 fprintf(debug_file, "Skipping meta for %s: no .OBJDIR\n",
429 gn->name);
430 goto out;
432 /* Check if there are no commands to execute. */
433 if (Lst_IsEmpty(gn->commands)) {
434 if (DEBUG(META))
435 fprintf(debug_file, "Skipping meta for %s: no commands\n",
436 gn->name);
437 goto out;
440 /* make sure these are canonical */
441 if (realpath(dname, objdir))
442 dname = objdir;
444 /* If we aren't in the object directory, don't create a meta file. */
445 if (!metaCurdirOk && strcmp(curdir, dname) == 0) {
446 if (DEBUG(META))
447 fprintf(debug_file, "Skipping meta for %s: .OBJDIR == .CURDIR\n",
448 gn->name);
449 goto out;
451 if (!(gn->type & OP_META)) {
452 /* We do not generate .meta files for sub-makes */
453 if (Lst_ForEach(gn->commands, is_submake, gn)) {
454 if (DEBUG(META))
455 fprintf(debug_file, "Skipping meta for %s: .MAKE\n",
456 gn->name);
457 goto out;
461 if (metaVerbose) {
462 char *mp;
464 /* Describe the target we are building */
465 mp = Var_Subst(NULL, "${" MAKE_META_PREFIX "}", gn, 0);
466 if (*mp)
467 fprintf(stdout, "%s\n", mp);
468 free(mp);
470 /* Get the basename of the target */
471 if ((cp = strrchr(tname, '/')) == NULL) {
472 cp = tname;
473 } else {
474 cp++;
477 fflush(stdout);
479 if (strcmp(cp, makeDependfile) == 0)
480 goto out;
482 if (!writeMeta)
483 /* Don't create meta data. */
484 goto out;
486 fname = meta_name(gn, pbm->meta_fname, sizeof(pbm->meta_fname),
487 dname, tname);
489 #ifdef DEBUG_META_MODE
490 if (DEBUG(META))
491 fprintf(debug_file, "meta_create: %s\n", fname);
492 #endif
494 if ((mf.fp = fopen(fname, "w")) == NULL)
495 err(1, "Could not open meta file '%s'", fname);
497 fprintf(mf.fp, "# Meta data file %s\n", fname);
499 mf.gn = gn;
501 Lst_ForEach(gn->commands, printCMD, &mf);
503 fprintf(mf.fp, "CWD %s\n", getcwd(buf, sizeof(buf)));
504 fprintf(mf.fp, "TARGET %s\n", tname);
506 if (metaEnv) {
507 for (ptr = environ; *ptr != NULL; ptr++)
508 fprintf(mf.fp, "ENV %s\n", *ptr);
511 fprintf(mf.fp, "-- command output --\n");
512 fflush(mf.fp);
514 Var_Append(".MAKE.META.FILES", fname, VAR_GLOBAL);
515 Var_Append(".MAKE.META.CREATED", fname, VAR_GLOBAL);
517 gn->type |= OP_META; /* in case anyone wants to know */
518 if (metaSilent) {
519 gn->type |= OP_SILENT;
521 out:
522 for (i--; i >= 0; i--) {
523 if (p[i])
524 free(p[i]);
527 return (mf.fp);
530 static Boolean
531 boolValue(char *s)
533 switch(*s) {
534 case '0':
535 case 'N':
536 case 'n':
537 case 'F':
538 case 'f':
539 return FALSE;
541 return TRUE;
545 * Initialization we need before reading makefiles.
547 void
548 meta_init(void)
550 #ifdef USE_FILEMON
551 /* this allows makefiles to test if we have filemon support */
552 Var_Set(".MAKE.PATH_FILEMON", _PATH_FILEMON, VAR_GLOBAL, 0);
553 #endif
558 * Initialization we need after reading makefiles.
560 void
561 meta_mode_init(const char *make_mode)
563 static int once = 0;
564 char *cp;
566 useMeta = TRUE;
567 useFilemon = TRUE;
568 writeMeta = TRUE;
570 if (make_mode) {
571 if (strstr(make_mode, "env"))
572 metaEnv = TRUE;
573 if (strstr(make_mode, "verb"))
574 metaVerbose = TRUE;
575 if (strstr(make_mode, "read"))
576 writeMeta = FALSE;
577 if (strstr(make_mode, "nofilemon"))
578 useFilemon = FALSE;
579 if ((cp = strstr(make_mode, "curdirok="))) {
580 metaCurdirOk = boolValue(&cp[9]);
582 if ((cp = strstr(make_mode, "silent="))) {
583 metaSilent = boolValue(&cp[7]);
585 if (strstr(make_mode, "ignore-cmd"))
586 metaIgnoreCMDs = TRUE;
587 /* for backwards compatability */
588 Var_Set(".MAKE.META_CREATED", "${.MAKE.META.CREATED}", VAR_GLOBAL, 0);
589 Var_Set(".MAKE.META_FILES", "${.MAKE.META.FILES}", VAR_GLOBAL, 0);
591 if (metaVerbose && !Var_Exists(MAKE_META_PREFIX, VAR_GLOBAL)) {
593 * The default value for MAKE_META_PREFIX
594 * prints the absolute path of the target.
595 * This works be cause :H will generate '.' if there is no /
596 * and :tA will resolve that to cwd.
598 Var_Set(MAKE_META_PREFIX, "Building ${.TARGET:H:tA}/${.TARGET:T}", VAR_GLOBAL, 0);
600 if (once)
601 return;
602 once = 1;
603 memset(&Mybm, 0, sizeof(Mybm));
605 * We consider ourselves master of all within ${.MAKE.META.BAILIWICK}
607 metaBailiwick = Lst_Init(FALSE);
608 cp = Var_Subst(NULL, "${.MAKE.META.BAILIWICK:O:u:tA}", VAR_GLOBAL, 0);
609 if (cp) {
610 str2Lst_Append(metaBailiwick, cp, NULL);
613 * We ignore any paths that start with ${.MAKE.META.IGNORE_PATHS}
615 metaIgnorePaths = Lst_Init(FALSE);
616 Var_Append(MAKE_META_IGNORE_PATHS,
617 "/dev /etc /proc /tmp /var/run /var/tmp ${TMPDIR}", VAR_GLOBAL);
618 cp = Var_Subst(NULL,
619 "${" MAKE_META_IGNORE_PATHS ":O:u:tA}", VAR_GLOBAL, 0);
620 if (cp) {
621 str2Lst_Append(metaIgnorePaths, cp, NULL);
626 * In each case below we allow for job==NULL
628 void
629 meta_job_start(Job *job, GNode *gn)
631 BuildMon *pbm;
633 if (job != NULL) {
634 pbm = &job->bm;
635 } else {
636 pbm = &Mybm;
638 pbm->mfp = meta_create(pbm, gn);
639 #ifdef USE_FILEMON_ONCE
640 /* compat mode we open the filemon dev once per command */
641 if (job == NULL)
642 return;
643 #endif
644 #ifdef USE_FILEMON
645 if (pbm->mfp != NULL && useFilemon) {
646 filemon_open(pbm);
647 } else {
648 pbm->mon_fd = pbm->filemon_fd = -1;
650 #endif
654 * The child calls this before doing anything.
655 * It does not disturb our state.
657 void
658 meta_job_child(Job *job)
660 #ifdef USE_FILEMON
661 BuildMon *pbm;
663 if (job != NULL) {
664 pbm = &job->bm;
665 } else {
666 pbm = &Mybm;
668 if (pbm->mfp != NULL) {
669 close(fileno(pbm->mfp));
670 if (useFilemon) {
671 pid_t pid;
673 pid = getpid();
674 if (ioctl(pbm->filemon_fd, FILEMON_SET_PID, &pid) < 0) {
675 err(1, "Could not set filemon pid!");
679 #endif
682 void
683 meta_job_error(Job *job, GNode *gn, int flags, int status)
685 char cwd[MAXPATHLEN];
686 BuildMon *pbm;
688 if (job != NULL) {
689 pbm = &job->bm;
690 } else {
691 if (!gn)
692 gn = job->node;
693 pbm = &Mybm;
695 if (pbm->mfp != NULL) {
696 fprintf(pbm->mfp, "*** Error code %d%s\n",
697 status,
698 (flags & JOB_IGNERR) ?
699 "(ignored)" : "");
701 if (gn) {
702 Var_Set(".ERROR_TARGET", gn->path ? gn->path : gn->name, VAR_GLOBAL, 0);
704 getcwd(cwd, sizeof(cwd));
705 Var_Set(".ERROR_CWD", cwd, VAR_GLOBAL, 0);
706 if (pbm && pbm->meta_fname[0]) {
707 Var_Set(".ERROR_META_FILE", pbm->meta_fname, VAR_GLOBAL, 0);
709 meta_job_finish(job);
712 void
713 meta_job_output(Job *job, char *cp, const char *nl)
715 BuildMon *pbm;
717 if (job != NULL) {
718 pbm = &job->bm;
719 } else {
720 pbm = &Mybm;
722 if (pbm->mfp != NULL) {
723 if (metaVerbose) {
724 static char *meta_prefix = NULL;
725 static int meta_prefix_len;
727 if (!meta_prefix) {
728 char *cp2;
730 meta_prefix = Var_Subst(NULL, "${" MAKE_META_PREFIX "}", VAR_GLOBAL, 0);
731 if ((cp2 = strchr(meta_prefix, '$')))
732 meta_prefix_len = cp2 - meta_prefix;
733 else
734 meta_prefix_len = strlen(meta_prefix);
736 if (strncmp(cp, meta_prefix, meta_prefix_len) == 0) {
737 cp = strchr(cp+1, '\n');
738 if (!cp++)
739 return;
742 fprintf(pbm->mfp, "%s%s", cp, nl);
746 void
747 meta_cmd_finish(void *pbmp)
749 #ifdef USE_FILEMON
750 BuildMon *pbm = pbmp;
752 if (!pbm)
753 pbm = &Mybm;
755 if (pbm->filemon_fd >= 0) {
756 close(pbm->filemon_fd);
757 filemon_read(pbm->mfp, pbm->mon_fd);
758 pbm->filemon_fd = pbm->mon_fd = -1;
760 #endif
763 void
764 meta_job_finish(Job *job)
766 BuildMon *pbm;
768 if (job != NULL) {
769 pbm = &job->bm;
770 } else {
771 pbm = &Mybm;
773 if (pbm->mfp != NULL) {
774 meta_cmd_finish(pbm);
775 fclose(pbm->mfp);
776 pbm->mfp = NULL;
777 pbm->meta_fname[0] = '\0';
782 * Fetch a full line from fp - growing bufp if needed
783 * Return length in bufp.
785 static int
786 fgetLine(char **bufp, size_t *szp, int o, FILE *fp)
788 char *buf = *bufp;
789 size_t bufsz = *szp;
790 struct stat fs;
791 int x;
793 if (fgets(&buf[o], bufsz - o, fp) != NULL) {
794 check_newline:
795 x = o + strlen(&buf[o]);
796 if (buf[x - 1] == '\n')
797 return x;
799 * We need to grow the buffer.
800 * The meta file can give us a clue.
802 if (fstat(fileno(fp), &fs) == 0) {
803 size_t newsz;
804 char *p;
806 newsz = ROUNDUP((fs.st_size / 2), BUFSIZ);
807 if (newsz <= bufsz)
808 newsz = ROUNDUP(fs.st_size, BUFSIZ);
809 if (DEBUG(META))
810 fprintf(debug_file, "growing buffer %zu -> %zu\n",
811 bufsz, newsz);
812 p = bmake_realloc(buf, newsz);
813 if (p) {
814 *bufp = buf = p;
815 *szp = bufsz = newsz;
816 /* fetch the rest */
817 if (!fgets(&buf[x], bufsz - x, fp))
818 return x; /* truncated! */
819 goto check_newline;
823 return 0;
826 static int
827 prefix_match(void *p, void *q)
829 const char *prefix = p;
830 const char *path = q;
831 size_t n = strlen(prefix);
833 return (0 == strncmp(path, prefix, n));
836 static int
837 string_match(const void *p, const void *q)
839 const char *p1 = p;
840 const char *p2 = q;
842 return strcmp(p1, p2);
847 * When running with 'meta' functionality, a target can be out-of-date
848 * if any of the references in its meta data file is more recent.
849 * We have to track the latestdir on a per-process basis.
851 #define LCWD_VNAME_FMT ".meta.%d.lcwd"
852 #define LDIR_VNAME_FMT ".meta.%d.ldir"
855 * It is possible that a .meta file is corrupted,
856 * if we detect this we want to reproduce it.
857 * Setting oodate TRUE will have that effect.
859 #define CHECK_VALID_META(p) if (!(p && *p)) { \
860 warnx("%s: %d: malformed", fname, lineno); \
861 oodate = TRUE; \
862 continue; \
865 #define DEQUOTE(p) if (*p == '\'') { \
866 char *ep; \
867 p++; \
868 if ((ep = strchr(p, '\''))) \
869 *ep = '\0'; \
872 Boolean
873 meta_oodate(GNode *gn, Boolean oodate)
875 static char *tmpdir = NULL;
876 static char cwd[MAXPATHLEN];
877 char lcwd_vname[64];
878 char ldir_vname[64];
879 char lcwd[MAXPATHLEN];
880 char latestdir[MAXPATHLEN];
881 char fname[MAXPATHLEN];
882 char fname1[MAXPATHLEN];
883 char fname2[MAXPATHLEN];
884 char fname3[MAXPATHLEN];
885 char *p;
886 char *cp;
887 char *link_src;
888 char *move_target;
889 static size_t cwdlen = 0;
890 static size_t tmplen = 0;
891 FILE *fp;
892 Boolean needOODATE = FALSE;
893 Lst missingFiles;
895 if (oodate)
896 return oodate; /* we're done */
898 missingFiles = Lst_Init(FALSE);
901 * We need to check if the target is out-of-date. This includes
902 * checking if the expanded command has changed. This in turn
903 * requires that all variables are set in the same way that they
904 * would be if the target needs to be re-built.
906 Make_DoAllVar(gn);
908 meta_name(gn, fname, sizeof(fname), NULL, NULL);
910 #ifdef DEBUG_META_MODE
911 if (DEBUG(META))
912 fprintf(debug_file, "meta_oodate: %s\n", fname);
913 #endif
915 if ((fp = fopen(fname, "r")) != NULL) {
916 static char *buf = NULL;
917 static size_t bufsz;
918 int lineno = 0;
919 int lastpid = 0;
920 int pid;
921 int f = 0;
922 int x;
923 LstNode ln;
924 struct stat fs;
926 if (!buf) {
927 bufsz = 8 * BUFSIZ;
928 buf = bmake_malloc(bufsz);
931 if (!cwdlen) {
932 if (getcwd(cwd, sizeof(cwd)) == NULL)
933 err(1, "Could not get current working directory");
934 cwdlen = strlen(cwd);
936 strlcpy(lcwd, cwd, sizeof(lcwd));
937 strlcpy(latestdir, cwd, sizeof(latestdir));
939 if (!tmpdir) {
940 tmpdir = getTmpdir();
941 tmplen = strlen(tmpdir);
944 /* we want to track all the .meta we read */
945 Var_Append(".MAKE.META.FILES", fname, VAR_GLOBAL);
947 ln = Lst_First(gn->commands);
948 while (!oodate && (x = fgetLine(&buf, &bufsz, 0, fp)) > 0) {
949 lineno++;
950 if (buf[x - 1] == '\n')
951 buf[x - 1] = '\0';
952 else {
953 warnx("%s: %d: line truncated at %u", fname, lineno, x);
954 oodate = TRUE;
955 break;
957 link_src = NULL;
958 move_target = NULL;
959 /* Find the start of the build monitor section. */
960 if (!f) {
961 if (strncmp(buf, "-- filemon", 10) == 0) {
962 f = 1;
963 continue;
965 if (strncmp(buf, "# buildmon", 10) == 0) {
966 f = 1;
967 continue;
971 /* Delimit the record type. */
972 p = buf;
973 #ifdef DEBUG_META_MODE
974 if (DEBUG(META))
975 fprintf(debug_file, "%s: %d: %s\n", fname, lineno, buf);
976 #endif
977 strsep(&p, " ");
978 if (f) {
980 * We are in the 'filemon' output section.
981 * Each record from filemon follows the general form:
983 * <key> <pid> <data>
985 * Where:
986 * <key> is a single letter, denoting the syscall.
987 * <pid> is the process that made the syscall.
988 * <data> is the arguments (of interest).
990 switch(buf[0]) {
991 case '#': /* comment */
992 case 'V': /* version */
993 break;
994 default:
996 * We need to track pathnames per-process.
998 * Each process run by make, starts off in the 'CWD'
999 * recorded in the .meta file, if it chdirs ('C')
1000 * elsewhere we need to track that - but only for
1001 * that process. If it forks ('F'), we initialize
1002 * the child to have the same cwd as its parent.
1004 * We also need to track the 'latestdir' of
1005 * interest. This is usually the same as cwd, but
1006 * not if a process is reading directories.
1008 * Each time we spot a different process ('pid')
1009 * we save the current value of 'latestdir' in a
1010 * variable qualified by 'lastpid', and
1011 * re-initialize 'latestdir' to any pre-saved
1012 * value for the current 'pid' and 'CWD' if none.
1014 CHECK_VALID_META(p);
1015 pid = atoi(p);
1016 if (pid > 0 && pid != lastpid) {
1017 char *ldir;
1018 char *tp;
1020 if (lastpid > 0) {
1021 /* We need to remember these. */
1022 Var_Set(lcwd_vname, lcwd, VAR_GLOBAL, 0);
1023 Var_Set(ldir_vname, latestdir, VAR_GLOBAL, 0);
1025 snprintf(lcwd_vname, sizeof(lcwd_vname), LCWD_VNAME_FMT, pid);
1026 snprintf(ldir_vname, sizeof(ldir_vname), LDIR_VNAME_FMT, pid);
1027 lastpid = pid;
1028 ldir = Var_Value(ldir_vname, VAR_GLOBAL, &tp);
1029 if (ldir) {
1030 strlcpy(latestdir, ldir, sizeof(latestdir));
1031 if (tp)
1032 free(tp);
1034 ldir = Var_Value(lcwd_vname, VAR_GLOBAL, &tp);
1035 if (ldir) {
1036 strlcpy(lcwd, ldir, sizeof(lcwd));
1037 if (tp)
1038 free(tp);
1041 /* Skip past the pid. */
1042 if (strsep(&p, " ") == NULL)
1043 continue;
1044 #ifdef DEBUG_META_MODE
1045 if (DEBUG(META))
1046 fprintf(debug_file, "%s: %d: %d: %c: cwd=%s lcwd=%s ldir=%s\n",
1047 fname, lineno,
1048 pid, buf[0], cwd, lcwd, latestdir);
1049 #endif
1050 break;
1053 CHECK_VALID_META(p);
1055 /* Process according to record type. */
1056 switch (buf[0]) {
1057 case 'X': /* eXit */
1058 Var_Delete(lcwd_vname, VAR_GLOBAL);
1059 Var_Delete(ldir_vname, VAR_GLOBAL);
1060 lastpid = 0; /* no need to save ldir_vname */
1061 break;
1063 case 'F': /* [v]Fork */
1065 char cldir[64];
1066 int child;
1068 child = atoi(p);
1069 if (child > 0) {
1070 snprintf(cldir, sizeof(cldir), LCWD_VNAME_FMT, child);
1071 Var_Set(cldir, lcwd, VAR_GLOBAL, 0);
1072 snprintf(cldir, sizeof(cldir), LDIR_VNAME_FMT, child);
1073 Var_Set(cldir, latestdir, VAR_GLOBAL, 0);
1074 #ifdef DEBUG_META_MODE
1075 if (DEBUG(META))
1076 fprintf(debug_file, "%s: %d: %d: cwd=%s lcwd=%s ldir=%s\n",
1077 fname, lineno,
1078 child, cwd, lcwd, latestdir);
1079 #endif
1082 break;
1084 case 'C': /* Chdir */
1085 /* Update lcwd and latest directory. */
1086 strlcpy(latestdir, p, sizeof(latestdir));
1087 strlcpy(lcwd, p, sizeof(lcwd));
1088 Var_Set(lcwd_vname, lcwd, VAR_GLOBAL, 0);
1089 Var_Set(ldir_vname, lcwd, VAR_GLOBAL, 0);
1090 #ifdef DEBUG_META_MODE
1091 if (DEBUG(META))
1092 fprintf(debug_file, "%s: %d: cwd=%s ldir=%s\n", fname, lineno, cwd, lcwd);
1093 #endif
1094 break;
1096 case 'M': /* renaMe */
1098 * For 'M'oves we want to check
1099 * the src as for 'R'ead
1100 * and the target as for 'W'rite.
1102 cp = p; /* save this for a second */
1103 /* now get target */
1104 if (strsep(&p, " ") == NULL)
1105 continue;
1106 CHECK_VALID_META(p);
1107 move_target = p;
1108 p = cp;
1109 /* 'L' and 'M' put single quotes around the args */
1110 DEQUOTE(p);
1111 DEQUOTE(move_target);
1112 /* FALLTHROUGH */
1113 case 'D': /* unlink */
1114 if (*p == '/' && !Lst_IsEmpty(missingFiles)) {
1115 /* remove p from the missingFiles list if present */
1116 if ((ln = Lst_Find(missingFiles, p, string_match)) != NULL) {
1117 char *tp = Lst_Datum(ln);
1118 Lst_Remove(missingFiles, ln);
1119 free(tp);
1120 ln = NULL; /* we're done with it */
1123 if (buf[0] == 'M') {
1124 /* the target of the mv is a file 'W'ritten */
1125 #ifdef DEBUG_META_MODE
1126 if (DEBUG(META))
1127 fprintf(debug_file, "meta_oodate: M %s -> %s\n",
1128 p, move_target);
1129 #endif
1130 p = move_target;
1131 goto check_write;
1133 break;
1134 case 'L': /* Link */
1136 * For 'L'inks check
1137 * the src as for 'R'ead
1138 * and the target as for 'W'rite.
1140 link_src = p;
1141 /* now get target */
1142 if (strsep(&p, " ") == NULL)
1143 continue;
1144 CHECK_VALID_META(p);
1145 /* 'L' and 'M' put single quotes around the args */
1146 DEQUOTE(p);
1147 DEQUOTE(link_src);
1148 #ifdef DEBUG_META_MODE
1149 if (DEBUG(META))
1150 fprintf(debug_file, "meta_oodate: L %s -> %s\n",
1151 link_src, p);
1152 #endif
1153 /* FALLTHROUGH */
1154 case 'W': /* Write */
1155 check_write:
1157 * If a file we generated within our bailiwick
1158 * but outside of .OBJDIR is missing,
1159 * we need to do it again.
1161 /* ignore non-absolute paths */
1162 if (*p != '/')
1163 break;
1165 if (Lst_IsEmpty(metaBailiwick))
1166 break;
1168 /* ignore cwd - normal dependencies handle those */
1169 if (strncmp(p, cwd, cwdlen) == 0)
1170 break;
1172 if (!Lst_ForEach(metaBailiwick, prefix_match, p))
1173 break;
1175 /* tmpdir might be within */
1176 if (tmplen > 0 && strncmp(p, tmpdir, tmplen) == 0)
1177 break;
1179 /* ignore anything containing the string "tmp" */
1180 if ((strstr("tmp", p)))
1181 break;
1183 if (stat(p, &fs) < 0) {
1184 Lst_AtEnd(missingFiles, bmake_strdup(p));
1186 break;
1187 check_link_src:
1188 p = link_src;
1189 link_src = NULL;
1190 #ifdef DEBUG_META_MODE
1191 if (DEBUG(META))
1192 fprintf(debug_file, "meta_oodate: L src %s\n", p);
1193 #endif
1194 /* FALLTHROUGH */
1195 case 'R': /* Read */
1196 case 'E': /* Exec */
1198 * Check for runtime files that can't
1199 * be part of the dependencies because
1200 * they are _expected_ to change.
1202 if (*p == '/' &&
1203 Lst_ForEach(metaIgnorePaths, prefix_match, p)) {
1204 #ifdef DEBUG_META_MODE
1205 if (DEBUG(META))
1206 fprintf(debug_file, "meta_oodate: ignoring: %s\n",
1208 #endif
1209 break;
1213 * The rest of the record is the file name.
1214 * Check if it's not an absolute path.
1217 char *sdirs[4];
1218 char **sdp;
1219 int sdx = 0;
1220 int found = 0;
1222 if (*p == '/') {
1223 sdirs[sdx++] = p; /* done */
1224 } else {
1225 if (strcmp(".", p) == 0)
1226 continue; /* no point */
1228 /* Check vs latestdir */
1229 snprintf(fname1, sizeof(fname1), "%s/%s", latestdir, p);
1230 sdirs[sdx++] = fname1;
1232 if (strcmp(latestdir, lcwd) != 0) {
1233 /* Check vs lcwd */
1234 snprintf(fname2, sizeof(fname2), "%s/%s", lcwd, p);
1235 sdirs[sdx++] = fname2;
1237 if (strcmp(lcwd, cwd) != 0) {
1238 /* Check vs cwd */
1239 snprintf(fname3, sizeof(fname3), "%s/%s", cwd, p);
1240 sdirs[sdx++] = fname3;
1243 sdirs[sdx++] = NULL;
1245 for (sdp = sdirs; *sdp && !found; sdp++) {
1246 #ifdef DEBUG_META_MODE
1247 if (DEBUG(META))
1248 fprintf(debug_file, "%s: %d: looking for: %s\n", fname, lineno, *sdp);
1249 #endif
1250 if (stat(*sdp, &fs) == 0) {
1251 found = 1;
1252 p = *sdp;
1255 if (found) {
1256 #ifdef DEBUG_META_MODE
1257 if (DEBUG(META))
1258 fprintf(debug_file, "%s: %d: found: %s\n", fname, lineno, p);
1259 #endif
1260 if (!S_ISDIR(fs.st_mode) &&
1261 fs.st_mtime > gn->mtime) {
1262 if (DEBUG(META))
1263 fprintf(debug_file, "%s: %d: file '%s' is newer than the target...\n", fname, lineno, p);
1264 oodate = TRUE;
1265 } else if (S_ISDIR(fs.st_mode)) {
1266 /* Update the latest directory. */
1267 realpath(p, latestdir);
1269 } else if (errno == ENOENT && *p == '/' &&
1270 strncmp(p, cwd, cwdlen) != 0) {
1272 * A referenced file outside of CWD is missing.
1273 * We cannot catch every eventuality here...
1275 if (DEBUG(META))
1276 fprintf(debug_file, "%s: %d: file '%s' may have moved?...\n", fname, lineno, p);
1277 oodate = TRUE;
1280 if (buf[0] == 'E') {
1281 /* previous latestdir is no longer relevant */
1282 strlcpy(latestdir, lcwd, sizeof(latestdir));
1284 break;
1285 default:
1286 break;
1288 if (!oodate && buf[0] == 'L' && link_src != NULL)
1289 goto check_link_src;
1290 } else if (strcmp(buf, "CMD") == 0) {
1292 * Compare the current command with the one in the
1293 * meta data file.
1295 if (ln == NULL) {
1296 if (DEBUG(META))
1297 fprintf(debug_file, "%s: %d: there were more build commands in the meta data file than there are now...\n", fname, lineno);
1298 oodate = TRUE;
1299 } else {
1300 char *cmd = (char *)Lst_Datum(ln);
1301 Boolean hasOODATE = FALSE;
1303 if (strstr(cmd, "$?"))
1304 hasOODATE = TRUE;
1305 else if ((cp = strstr(cmd, ".OODATE"))) {
1306 /* check for $[{(].OODATE[:)}] */
1307 if (cp > cmd + 2 && cp[-2] == '$')
1308 hasOODATE = TRUE;
1310 if (hasOODATE) {
1311 needOODATE = TRUE;
1312 if (DEBUG(META))
1313 fprintf(debug_file, "%s: %d: cannot compare command using .OODATE\n", fname, lineno);
1315 cmd = Var_Subst(NULL, cmd, gn, TRUE);
1317 if ((cp = strchr(cmd, '\n'))) {
1318 int n;
1321 * This command contains newlines, we need to
1322 * fetch more from the .meta file before we
1323 * attempt a comparison.
1325 /* first put the newline back at buf[x - 1] */
1326 buf[x - 1] = '\n';
1327 do {
1328 /* now fetch the next line */
1329 if ((n = fgetLine(&buf, &bufsz, x, fp)) <= 0)
1330 break;
1331 x = n;
1332 lineno++;
1333 if (buf[x - 1] != '\n') {
1334 warnx("%s: %d: line truncated at %u", fname, lineno, x);
1335 break;
1337 cp = strchr(++cp, '\n');
1338 } while (cp);
1339 if (buf[x - 1] == '\n')
1340 buf[x - 1] = '\0';
1342 if (!hasOODATE &&
1343 !(gn->type & OP_NOMETA_CMP) &&
1344 strcmp(p, cmd) != 0) {
1345 if (DEBUG(META))
1346 fprintf(debug_file, "%s: %d: a build command has changed\n%s\nvs\n%s\n", fname, lineno, p, cmd);
1347 if (!metaIgnoreCMDs)
1348 oodate = TRUE;
1350 free(cmd);
1351 ln = Lst_Succ(ln);
1353 } else if (strcmp(buf, "CWD") == 0) {
1355 * Check if there are extra commands now
1356 * that weren't in the meta data file.
1358 if (!oodate && ln != NULL) {
1359 if (DEBUG(META))
1360 fprintf(debug_file, "%s: %d: there are extra build commands now that weren't in the meta data file\n", fname, lineno);
1361 oodate = TRUE;
1363 if (strcmp(p, cwd) != 0) {
1364 if (DEBUG(META))
1365 fprintf(debug_file, "%s: %d: the current working directory has changed from '%s' to '%s'\n", fname, lineno, p, curdir);
1366 oodate = TRUE;
1371 fclose(fp);
1372 if (!Lst_IsEmpty(missingFiles)) {
1373 if (DEBUG(META))
1374 fprintf(debug_file, "%s: missing files: %s...\n",
1375 fname, (char *)Lst_Datum(Lst_First(missingFiles)));
1376 oodate = TRUE;
1377 Lst_Destroy(missingFiles, (FreeProc *)free);
1379 } else {
1380 if ((gn->type & OP_META)) {
1381 if (DEBUG(META))
1382 fprintf(debug_file, "%s: required but missing\n", fname);
1383 oodate = TRUE;
1386 if (oodate && needOODATE) {
1388 * Target uses .OODATE which is empty; or we wouldn't be here.
1389 * We have decided it is oodate, so .OODATE needs to be set.
1390 * All we can sanely do is set it to .ALLSRC.
1392 Var_Delete(OODATE, gn);
1393 Var_Set(OODATE, Var_Value(ALLSRC, gn, &cp), gn, 0);
1394 if (cp)
1395 free(cp);
1397 return oodate;
1400 /* support for compat mode */
1402 static int childPipe[2];
1404 void
1405 meta_compat_start(void)
1407 #ifdef USE_FILEMON_ONCE
1409 * We need to re-open filemon for each cmd.
1411 BuildMon *pbm = &Mybm;
1413 if (pbm->mfp != NULL && useFilemon) {
1414 filemon_open(pbm);
1415 } else {
1416 pbm->mon_fd = pbm->filemon_fd = -1;
1418 #endif
1419 if (pipe(childPipe) < 0)
1420 Punt("Cannot create pipe: %s", strerror(errno));
1421 /* Set close-on-exec flag for both */
1422 (void)fcntl(childPipe[0], F_SETFD, 1);
1423 (void)fcntl(childPipe[1], F_SETFD, 1);
1426 void
1427 meta_compat_child(void)
1429 meta_job_child(NULL);
1430 if (dup2(childPipe[1], 1) < 0 ||
1431 dup2(1, 2) < 0) {
1432 execError("dup2", "pipe");
1433 _exit(1);
1437 void
1438 meta_compat_parent(void)
1440 FILE *fp;
1441 char buf[BUFSIZ];
1443 close(childPipe[1]); /* child side */
1444 fp = fdopen(childPipe[0], "r");
1445 while (fgets(buf, sizeof(buf), fp)) {
1446 meta_job_output(NULL, buf, "");
1447 printf("%s", buf);
1449 fclose(fp);
1452 #endif /* USE_META */