1 /* $NetBSD: meta.c,v 1.144 2020/11/15 12:02:44 rillig Exp $ */
4 * Implement 'meta' mode.
5 * Adapted from John Birrell's patches to FreeBSD make.
9 * Copyright (c) 2009-2016, 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
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.
41 #elif !defined(HAVE_DIRNAME)
42 char * dirname(char *);
45 #if !defined(HAVE_CONFIG_H) || defined(HAVE_ERR_H)
54 #include "filemon/filemon.h"
57 static BuildMon Mybm; /* for compat */
58 static StringList *metaBailiwick; /* our scope of control */
59 static char *metaBailiwickStr; /* string storage for the list */
60 static StringList *metaIgnorePaths; /* paths we deliberately ignore */
61 static char *metaIgnorePathsStr; /* string storage for the list */
63 #ifndef MAKE_META_IGNORE_PATHS
64 #define MAKE_META_IGNORE_PATHS ".MAKE.META.IGNORE_PATHS"
66 #ifndef MAKE_META_IGNORE_PATTERNS
67 #define MAKE_META_IGNORE_PATTERNS ".MAKE.META.IGNORE_PATTERNS"
69 #ifndef MAKE_META_IGNORE_FILTER
70 #define MAKE_META_IGNORE_FILTER ".MAKE.META.IGNORE_FILTER"
73 Boolean useMeta = FALSE;
74 static Boolean useFilemon = FALSE;
75 static Boolean writeMeta = FALSE;
76 static Boolean metaMissing = FALSE; /* oodate if missing */
77 static Boolean filemonMissing = FALSE; /* oodate if missing */
78 static Boolean metaEnv = FALSE; /* don't save env unless asked */
79 static Boolean metaVerbose = FALSE;
80 static Boolean metaIgnoreCMDs = FALSE; /* ignore CMDs in .meta files */
81 static Boolean metaIgnorePatterns = FALSE; /* do we need to do pattern matches */
82 static Boolean metaIgnoreFilter = FALSE; /* do we have more complex filtering? */
83 static Boolean metaCurdirOk = FALSE; /* write .meta in .CURDIR Ok? */
84 static Boolean metaSilent = FALSE; /* if we have a .meta be SILENT */
86 extern Boolean forceJobs;
87 extern char **environ;
89 #define MAKE_META_PREFIX ".MAKE.META.PREFIX"
92 # define N2U(n, u) (((n) + ((u) - 1)) / (u))
95 # define ROUNDUP(n, u) (N2U((n), (u)) * (u))
98 #if !defined(HAVE_STRSEP)
99 # define strsep(s, d) stresep((s), (d), '\0')
103 * Filemon is a kernel module which snoops certain syscalls.
114 * See meta_oodate below - we mainly care about 'E' and 'R'.
116 * We can still use meta mode without filemon, but
117 * the benefits are more limited.
122 * Open the filemon device.
125 meta_open_filemon(BuildMon *pbm)
131 if (!useFilemon || !pbm->mfp)
134 pbm->filemon = filemon_open();
135 if (pbm->filemon == NULL) {
137 warn("Could not open filemon %s", filemon_path());
142 * We use a file outside of '.'
143 * to avoid a FreeBSD kernel bug where unlink invalidates
144 * cwd causing getcwd to do a lot more work.
145 * We only care about the descriptor.
147 pbm->mon_fd = mkTempFile("filemon.XXXXXX", NULL);
148 if ((dupfd = dup(pbm->mon_fd)) == -1) {
149 err(1, "Could not dup filemon output!");
151 (void)fcntl(dupfd, F_SETFD, FD_CLOEXEC);
152 if (filemon_setfd(pbm->filemon, dupfd) == -1) {
153 err(1, "Could not set filemon file descriptor!");
155 /* we don't need these once we exec */
156 (void)fcntl(pbm->mon_fd, F_SETFD, FD_CLOEXEC);
160 * Read the build monitor output file and write records to the target's
164 filemon_read(FILE *mfp, int fd)
169 /* Check if we're not writing to a meta data file.*/
172 close(fd); /* not interested */
176 if (lseek(fd, (off_t)0, SEEK_SET) < 0) {
178 warn("Could not rewind filemon");
184 fprintf(mfp, "\n-- filemon acquired metadata --\n");
186 while ((n = read(fd, buf, sizeof buf)) > 0) {
187 if ((ssize_t)fwrite(buf, 1, (size_t)n, mfp) < n)
199 * when realpath() fails,
200 * we use this, to clean up ./ and ../
203 eat_dots(char *buf, size_t bufsz, int dots)
224 cp = strstr(buf, eat);
227 if (dots == 2 && cp > buf) {
230 } while (cp > buf && *cp != '/');
233 strlcpy(cp, cp2, bufsz - (size_t)(cp - buf));
235 return; /* can't happen? */
242 meta_name(char *mname, size_t mnamelen,
247 char buf[MAXPATHLEN];
255 * Weed out relative paths from the target file name.
256 * We have to be careful though since if target is a
257 * symlink, the result will be unstable.
258 * So we use realpath() just to get the dirname, and leave the
259 * basename as given to us.
261 if ((cp = strrchr(tname, '/'))) {
262 if (cached_realpath(tname, buf)) {
263 if ((rp = strrchr(buf, '/'))) {
266 if (strcmp(cp, rp) != 0)
267 strlcpy(rp, cp, sizeof buf - (size_t)(rp - buf));
272 * We likely have a directory which is about to be made.
273 * We pretend realpath() succeeded, to have a chance
274 * of generating the same meta file name that we will
277 if (tname[0] == '/') {
278 strlcpy(buf, tname, sizeof buf);
280 snprintf(buf, sizeof buf, "%s/%s", cwd, tname);
282 eat_dots(buf, sizeof buf, 1); /* ./ */
283 eat_dots(buf, sizeof buf, 2); /* ../ */
287 /* on some systems dirname may modify its arg */
288 tp = bmake_strdup(tname);
290 if (strcmp(dname, dtp) == 0)
291 snprintf(mname, mnamelen, "%s.meta", tname);
293 ldname = strlen(dname);
294 if (strncmp(dname, dtp, ldname) == 0 && dtp[ldname] == '/')
295 snprintf(mname, mnamelen, "%s/%s.meta", dname, &tname[ldname+1]);
297 snprintf(mname, mnamelen, "%s/%s.meta", dname, tname);
300 * Replace path separators in the file name after the
301 * current object directory path.
303 cp = mname + strlen(dname) + 1;
305 while (*cp != '\0') {
316 * Return true if running ${.MAKE}
317 * Bypassed if target is flagged .MAKE
320 is_submake(void *cmdp, void *gnp)
322 static const char *p_make = NULL;
329 int rc = 0; /* keep looking */
331 if (p_make == NULL) {
333 p_make = Var_Value(".MAKE", gn, &dontFreeIt);
334 p_len = strlen(p_make);
336 cp = strchr(cmd, '$');
338 (void)Var_Subst(cmd, gn, VARE_WANTRES, &mp);
339 /* TODO: handle errors */
342 cp2 = strstr(cmd, p_make);
344 switch (cp2[p_len]) {
352 if (cp2 > cmd && rc > 0) {
359 rc = 0; /* no match */
368 typedef struct meta_file_s {
374 printCMD(const char *cmd, meta_file_t *mfp)
376 char *cmd_freeIt = NULL;
378 if (strchr(cmd, '$')) {
379 (void)Var_Subst(cmd, mfp->gn, VARE_WANTRES, &cmd_freeIt);
380 /* TODO: handle errors */
383 fprintf(mfp->fp, "CMD %s\n", cmd);
388 printCMDs(GNode *gn, meta_file_t *mf)
392 for (ln = gn->commands->first; ln != NULL; ln = ln->next)
393 printCMD(ln->datum, mf);
397 * Certain node types never get a .meta file
399 #define SKIP_META_TYPE(_type) do { \
400 if ((gn->type & __CONCAT(OP_, _type))) { \
402 debug_printf("Skipping meta for %s: .%s\n", \
403 gn->name, __STRING(_type)); \
411 * Do we need/want a .meta file ?
414 meta_needed(GNode *gn, const char *dname,
415 char *objdir, int verbose)
417 struct cached_stat cst;
420 verbose = DEBUG(META);
422 /* This may be a phony node which we don't want meta data for... */
423 /* Skip .meta for .BEGIN, .END, .ERROR etc as well. */
424 /* Or it may be explicitly flagged as .NOMETA */
425 SKIP_META_TYPE(NOMETA);
426 /* Unless it is explicitly flagged as .META */
427 if (!(gn->type & OP_META)) {
428 SKIP_META_TYPE(PHONY);
429 SKIP_META_TYPE(SPECIAL);
430 SKIP_META_TYPE(MAKE);
433 /* Check if there are no commands to execute. */
434 if (Lst_IsEmpty(gn->commands)) {
436 debug_printf("Skipping meta for %s: no commands\n", gn->name);
439 if ((gn->type & (OP_META|OP_SUBMAKE)) == OP_SUBMAKE) {
440 /* OP_SUBMAKE is a bit too aggressive */
441 if (Lst_ForEachUntil(gn->commands, is_submake, gn)) {
442 DEBUG1(META, "Skipping meta for %s: .SUBMAKE\n", gn->name);
447 /* The object directory may not exist. Check it.. */
448 if (cached_stat(dname, &cst) != 0) {
450 debug_printf("Skipping meta for %s: no .OBJDIR\n", gn->name);
454 /* make sure these are canonical */
455 if (cached_realpath(dname, objdir))
458 /* If we aren't in the object directory, don't create a meta file. */
459 if (!metaCurdirOk && strcmp(curdir, dname) == 0) {
461 debug_printf("Skipping meta for %s: .OBJDIR == .CURDIR\n",
470 meta_create(BuildMon *pbm, GNode *gn)
473 char buf[MAXPATHLEN];
474 char objdir[MAXPATHLEN];
484 dname = Var_Value(".OBJDIR", gn, &objdir_freeIt);
485 tname = GNode_VarTarget(gn);
487 /* if this succeeds objdir is realpath of dname */
488 if (!meta_needed(gn, dname, objdir, TRUE))
495 /* Describe the target we are building */
496 (void)Var_Subst("${" MAKE_META_PREFIX "}", gn, VARE_WANTRES, &mp);
497 /* TODO: handle errors */
499 fprintf(stdout, "%s\n", mp);
502 /* Get the basename of the target */
503 if ((cp = strrchr(tname, '/')) == NULL) {
512 /* Don't create meta data. */
515 fname = meta_name(pbm->meta_fname, sizeof pbm->meta_fname,
516 dname, tname, objdir);
518 #ifdef DEBUG_META_MODE
519 DEBUG1(META, "meta_create: %s\n", fname);
522 if ((mf.fp = fopen(fname, "w")) == NULL)
523 err(1, "Could not open meta file '%s'", fname);
525 fprintf(mf.fp, "# Meta data file %s\n", fname);
531 fprintf(mf.fp, "CWD %s\n", getcwd(buf, sizeof buf));
532 fprintf(mf.fp, "TARGET %s\n", tname);
533 cp = GNode_VarOodate(gn);
535 fprintf(mf.fp, "OODATE %s\n", cp);
538 for (ptr = environ; *ptr != NULL; ptr++)
539 fprintf(mf.fp, "ENV %s\n", *ptr);
542 fprintf(mf.fp, "-- command output --\n");
545 Var_Append(".MAKE.META.FILES", fname, VAR_GLOBAL);
546 Var_Append(".MAKE.META.CREATED", fname, VAR_GLOBAL);
548 gn->type |= OP_META; /* in case anyone wants to know */
550 gn->type |= OP_SILENT;
553 bmake_free(objdir_freeIt);
573 * Initialization we need before reading makefiles.
579 /* this allows makefiles to test if we have filemon support */
580 Var_Set(".MAKE.PATH_FILEMON", filemon_path(), VAR_GLOBAL);
585 #define get_mode_bf(bf, token) \
586 if ((cp = strstr(make_mode, token))) \
587 bf = boolValue(cp + sizeof (token) - 1)
590 * Initialization we need after reading makefiles.
593 meta_mode_init(const char *make_mode)
604 if (strstr(make_mode, "env"))
606 if (strstr(make_mode, "verb"))
608 if (strstr(make_mode, "read"))
610 if (strstr(make_mode, "nofilemon"))
612 if (strstr(make_mode, "ignore-cmd"))
613 metaIgnoreCMDs = TRUE;
615 get_mode_bf(filemonMissing, "missing-filemon=");
616 get_mode_bf(metaCurdirOk, "curdirok=");
617 get_mode_bf(metaMissing, "missing-meta=");
618 get_mode_bf(metaSilent, "silent=");
620 if (metaVerbose && !Var_Exists(MAKE_META_PREFIX, VAR_GLOBAL)) {
622 * The default value for MAKE_META_PREFIX
623 * prints the absolute path of the target.
624 * This works be cause :H will generate '.' if there is no /
625 * and :tA will resolve that to cwd.
627 Var_Set(MAKE_META_PREFIX, "Building ${.TARGET:H:tA}/${.TARGET:T}", VAR_GLOBAL);
632 memset(&Mybm, 0, sizeof Mybm);
634 * We consider ourselves master of all within ${.MAKE.META.BAILIWICK}
636 metaBailiwick = Lst_New();
637 (void)Var_Subst("${.MAKE.META.BAILIWICK:O:u:tA}",
638 VAR_GLOBAL, VARE_WANTRES, &metaBailiwickStr);
639 /* TODO: handle errors */
640 str2Lst_Append(metaBailiwick, metaBailiwickStr);
642 * We ignore any paths that start with ${.MAKE.META.IGNORE_PATHS}
644 metaIgnorePaths = Lst_New();
645 Var_Append(MAKE_META_IGNORE_PATHS,
646 "/dev /etc /proc /tmp /var/run /var/tmp ${TMPDIR}", VAR_GLOBAL);
647 (void)Var_Subst("${" MAKE_META_IGNORE_PATHS ":O:u:tA}",
648 VAR_GLOBAL, VARE_WANTRES, &metaIgnorePathsStr);
649 /* TODO: handle errors */
650 str2Lst_Append(metaIgnorePaths, metaIgnorePathsStr);
653 * We ignore any paths that match ${.MAKE.META.IGNORE_PATTERNS}
656 if (Var_Value(MAKE_META_IGNORE_PATTERNS, VAR_GLOBAL, &freeIt)) {
657 metaIgnorePatterns = TRUE;
661 if (Var_Value(MAKE_META_IGNORE_FILTER, VAR_GLOBAL, &freeIt)) {
662 metaIgnoreFilter = TRUE;
668 * In each case below we allow for job==NULL
671 meta_job_start(Job *job, GNode *gn)
680 pbm->mfp = meta_create(pbm, gn);
681 #ifdef USE_FILEMON_ONCE
682 /* compat mode we open the filemon dev once per command */
687 if (pbm->mfp != NULL && useFilemon) {
688 meta_open_filemon(pbm);
697 * The child calls this before doing anything.
698 * It does not disturb our state.
701 meta_job_child(Job *job)
711 if (pbm->mfp != NULL) {
712 close(fileno(pbm->mfp));
713 if (useFilemon && pbm->filemon) {
717 if (filemon_setpid_child(pbm->filemon, pid) == -1) {
718 err(1, "Could not set filemon pid!");
726 meta_job_parent(Job *job, pid_t pid)
728 #if defined(USE_FILEMON) && !defined(USE_FILEMON_DEV)
736 if (useFilemon && pbm->filemon) {
737 filemon_setpid_parent(pbm->filemon, pid);
743 meta_job_fd(Job *job)
745 #if defined(USE_FILEMON) && !defined(USE_FILEMON_DEV)
753 if (useFilemon && pbm->filemon) {
754 return filemon_readfd(pbm->filemon);
761 meta_job_event(Job *job)
763 #if defined(USE_FILEMON) && !defined(USE_FILEMON_DEV)
771 if (useFilemon && pbm->filemon) {
772 return filemon_process(pbm->filemon);
779 meta_job_error(Job *job, GNode *gn, int flags, int status)
781 char cwd[MAXPATHLEN];
791 if (pbm->mfp != NULL) {
792 fprintf(pbm->mfp, "\n*** Error code %d%s\n",
794 (flags & JOB_IGNERR) ?
798 Var_Set(".ERROR_TARGET", GNode_Path(gn), VAR_GLOBAL);
800 getcwd(cwd, sizeof cwd);
801 Var_Set(".ERROR_CWD", cwd, VAR_GLOBAL);
802 if (pbm->meta_fname[0] != '\0') {
803 Var_Set(".ERROR_META_FILE", pbm->meta_fname, VAR_GLOBAL);
805 meta_job_finish(job);
809 meta_job_output(Job *job, char *cp, const char *nl)
818 if (pbm->mfp != NULL) {
820 static char *meta_prefix = NULL;
821 static size_t meta_prefix_len;
823 if (meta_prefix == NULL) {
826 (void)Var_Subst("${" MAKE_META_PREFIX "}",
827 VAR_GLOBAL, VARE_WANTRES, &meta_prefix);
828 /* TODO: handle errors */
829 if ((cp2 = strchr(meta_prefix, '$')))
830 meta_prefix_len = (size_t)(cp2 - meta_prefix);
832 meta_prefix_len = strlen(meta_prefix);
834 if (strncmp(cp, meta_prefix, meta_prefix_len) == 0) {
835 cp = strchr(cp+1, '\n');
840 fprintf(pbm->mfp, "%s%s", cp, nl);
845 meta_cmd_finish(void *pbmp)
848 BuildMon *pbm = pbmp;
858 while (filemon_process(pbm->filemon) > 0)
860 if (filemon_close(pbm->filemon) == -1)
862 x = filemon_read(pbm->mfp, pbm->mon_fd);
863 if (error == 0 && x != 0)
871 fprintf(pbm->mfp, "\n"); /* ensure end with newline */
876 meta_job_finish(Job *job)
887 if (pbm->mfp != NULL) {
888 error = meta_cmd_finish(pbm);
889 x = fclose(pbm->mfp);
890 if (error == 0 && x != 0)
893 pbm->meta_fname[0] = '\0';
901 if (metaBailiwick != NULL)
902 Lst_Free(metaBailiwick);
903 free(metaBailiwickStr);
904 if (metaIgnorePaths != NULL)
905 Lst_Free(metaIgnorePaths);
906 free(metaIgnorePathsStr);
910 * Fetch a full line from fp - growing bufp if needed
911 * Return length in bufp.
914 fgetLine(char **bufp, size_t *szp, int o, FILE *fp)
921 if (fgets(&buf[o], (int)bufsz - o, fp) != NULL) {
923 x = o + (int)strlen(&buf[o]);
924 if (buf[x - 1] == '\n')
927 * We need to grow the buffer.
928 * The meta file can give us a clue.
930 if (fstat(fileno(fp), &fs) == 0) {
934 newsz = ROUNDUP(((size_t)fs.st_size / 2), BUFSIZ);
936 newsz = ROUNDUP((size_t)fs.st_size, BUFSIZ);
938 return x; /* truncated */
939 DEBUG2(META, "growing buffer %zu -> %zu\n", bufsz, newsz);
940 p = bmake_realloc(buf, newsz);
943 *szp = bufsz = newsz;
945 if (fgets(&buf[x], (int)bufsz - x, fp) == NULL)
946 return x; /* truncated! */
954 /* Lst_ForEachUntil wants 1 to stop search */
956 prefix_match(void *p, void *q)
958 const char *prefix = p;
959 const char *path = q;
960 size_t n = strlen(prefix);
962 return strncmp(path, prefix, n) == 0;
965 /* See if the path equals prefix or starts with "prefix/". */
967 path_starts_with(const char *path, const char *prefix)
969 size_t n = strlen(prefix);
971 if (strncmp(path, prefix, n) != 0)
973 return path[n] == '\0' || path[n] == '/';
977 meta_ignore(GNode *gn, const char *p)
979 char fname[MAXPATHLEN];
985 cached_realpath(p, fname); /* clean it up */
986 if (Lst_ForEachUntil(metaIgnorePaths, prefix_match, fname)) {
987 #ifdef DEBUG_META_MODE
988 DEBUG1(META, "meta_oodate: ignoring path: %s\n", p);
994 if (metaIgnorePatterns) {
998 Var_Set(".p.", p, gn);
999 expr = "${" MAKE_META_IGNORE_PATTERNS ":@m@${.p.:M$m}@}";
1000 (void)Var_Subst(expr, gn, VARE_WANTRES, &pm);
1001 /* TODO: handle errors */
1003 #ifdef DEBUG_META_MODE
1004 DEBUG1(META, "meta_oodate: ignoring pattern: %s\n", p);
1012 if (metaIgnoreFilter) {
1015 /* skip if filter result is empty */
1016 snprintf(fname, sizeof fname,
1017 "${%s:L:${%s:ts:}}",
1018 p, MAKE_META_IGNORE_FILTER);
1019 (void)Var_Subst(fname, gn, VARE_WANTRES, &fm);
1020 /* TODO: handle errors */
1022 #ifdef DEBUG_META_MODE
1023 DEBUG1(META, "meta_oodate: ignoring filtered: %s\n", p);
1034 * When running with 'meta' functionality, a target can be out-of-date
1035 * if any of the references in its meta data file is more recent.
1036 * We have to track the latestdir on a per-process basis.
1038 #define LCWD_VNAME_FMT ".meta.%d.lcwd"
1039 #define LDIR_VNAME_FMT ".meta.%d.ldir"
1042 * It is possible that a .meta file is corrupted,
1043 * if we detect this we want to reproduce it.
1044 * Setting oodate TRUE will have that effect.
1046 #define CHECK_VALID_META(p) if (!(p && *p)) { \
1047 warnx("%s: %d: malformed", fname, lineno); \
1052 #define DEQUOTE(p) if (*p == '\'') { \
1055 if ((ep = strchr(p, '\''))) \
1060 append_if_new(StringList *list, const char *str)
1064 for (ln = list->first; ln != NULL; ln = ln->next)
1065 if (strcmp(ln->datum, str) == 0)
1067 Lst_Append(list, bmake_strdup(str));
1071 meta_oodate(GNode *gn, Boolean oodate)
1073 static char *tmpdir = NULL;
1074 static char cwd[MAXPATHLEN];
1075 char lcwd_vname[64];
1076 char ldir_vname[64];
1077 char lcwd[MAXPATHLEN];
1078 char latestdir[MAXPATHLEN];
1079 char fname[MAXPATHLEN];
1080 char fname1[MAXPATHLEN];
1081 char fname2[MAXPATHLEN];
1082 char fname3[MAXPATHLEN];
1089 static size_t cwdlen = 0;
1090 static size_t tmplen = 0;
1092 Boolean needOODATE = FALSE;
1093 StringList *missingFiles;
1094 Boolean have_filemon = FALSE;
1095 void *objdir_freeIt;
1098 return oodate; /* we're done */
1100 dname = Var_Value(".OBJDIR", gn, &objdir_freeIt);
1101 tname = GNode_VarTarget(gn);
1103 /* if this succeeds fname3 is realpath of dname */
1104 if (!meta_needed(gn, dname, fname3, FALSE))
1108 missingFiles = Lst_New();
1111 * We need to check if the target is out-of-date. This includes
1112 * checking if the expanded command has changed. This in turn
1113 * requires that all variables are set in the same way that they
1114 * would be if the target needs to be re-built.
1118 meta_name(fname, sizeof fname, dname, tname, dname);
1120 #ifdef DEBUG_META_MODE
1121 DEBUG1(META, "meta_oodate: %s\n", fname);
1124 if ((fp = fopen(fname, "r")) != NULL) {
1125 static char *buf = NULL;
1126 static size_t bufsz;
1131 StringListNode *cmdNode;
1132 struct cached_stat cst;
1136 buf = bmake_malloc(bufsz);
1140 if (getcwd(cwd, sizeof cwd) == NULL)
1141 err(1, "Could not get current working directory");
1142 cwdlen = strlen(cwd);
1144 strlcpy(lcwd, cwd, sizeof lcwd);
1145 strlcpy(latestdir, cwd, sizeof latestdir);
1147 if (tmpdir == NULL) {
1148 tmpdir = getTmpdir();
1149 tmplen = strlen(tmpdir);
1152 /* we want to track all the .meta we read */
1153 Var_Append(".MAKE.META.FILES", fname, VAR_GLOBAL);
1155 cmdNode = gn->commands->first;
1156 while (!oodate && (x = fgetLine(&buf, &bufsz, 0, fp)) > 0) {
1158 if (buf[x - 1] == '\n')
1161 warnx("%s: %d: line truncated at %u", fname, lineno, x);
1167 /* Find the start of the build monitor section. */
1168 if (!have_filemon) {
1169 if (strncmp(buf, "-- filemon", 10) == 0) {
1170 have_filemon = TRUE;
1173 if (strncmp(buf, "# buildmon", 10) == 0) {
1174 have_filemon = TRUE;
1179 /* Delimit the record type. */
1181 #ifdef DEBUG_META_MODE
1182 DEBUG3(META, "%s: %d: %s\n", fname, lineno, buf);
1187 * We are in the 'filemon' output section.
1188 * Each record from filemon follows the general form:
1190 * <key> <pid> <data>
1193 * <key> is a single letter, denoting the syscall.
1194 * <pid> is the process that made the syscall.
1195 * <data> is the arguments (of interest).
1198 case '#': /* comment */
1199 case 'V': /* version */
1203 * We need to track pathnames per-process.
1205 * Each process run by make, starts off in the 'CWD'
1206 * recorded in the .meta file, if it chdirs ('C')
1207 * elsewhere we need to track that - but only for
1208 * that process. If it forks ('F'), we initialize
1209 * the child to have the same cwd as its parent.
1211 * We also need to track the 'latestdir' of
1212 * interest. This is usually the same as cwd, but
1213 * not if a process is reading directories.
1215 * Each time we spot a different process ('pid')
1216 * we save the current value of 'latestdir' in a
1217 * variable qualified by 'lastpid', and
1218 * re-initialize 'latestdir' to any pre-saved
1219 * value for the current 'pid' and 'CWD' if none.
1221 CHECK_VALID_META(p);
1223 if (pid > 0 && pid != lastpid) {
1228 /* We need to remember these. */
1229 Var_Set(lcwd_vname, lcwd, VAR_GLOBAL);
1230 Var_Set(ldir_vname, latestdir, VAR_GLOBAL);
1232 snprintf(lcwd_vname, sizeof lcwd_vname, LCWD_VNAME_FMT, pid);
1233 snprintf(ldir_vname, sizeof ldir_vname, LDIR_VNAME_FMT, pid);
1235 ldir = Var_Value(ldir_vname, VAR_GLOBAL, &tp);
1237 strlcpy(latestdir, ldir, sizeof latestdir);
1240 ldir = Var_Value(lcwd_vname, VAR_GLOBAL, &tp);
1242 strlcpy(lcwd, ldir, sizeof lcwd);
1246 /* Skip past the pid. */
1247 if (strsep(&p, " ") == NULL)
1249 #ifdef DEBUG_META_MODE
1251 debug_printf("%s: %d: %d: %c: cwd=%s lcwd=%s ldir=%s\n",
1253 pid, buf[0], cwd, lcwd, latestdir);
1258 CHECK_VALID_META(p);
1260 /* Process according to record type. */
1262 case 'X': /* eXit */
1263 Var_Delete(lcwd_vname, VAR_GLOBAL);
1264 Var_Delete(ldir_vname, VAR_GLOBAL);
1265 lastpid = 0; /* no need to save ldir_vname */
1268 case 'F': /* [v]Fork */
1275 snprintf(cldir, sizeof cldir, LCWD_VNAME_FMT, child);
1276 Var_Set(cldir, lcwd, VAR_GLOBAL);
1277 snprintf(cldir, sizeof cldir, LDIR_VNAME_FMT, child);
1278 Var_Set(cldir, latestdir, VAR_GLOBAL);
1279 #ifdef DEBUG_META_MODE
1282 "%s: %d: %d: cwd=%s lcwd=%s ldir=%s\n",
1284 child, cwd, lcwd, latestdir);
1290 case 'C': /* Chdir */
1291 /* Update lcwd and latest directory. */
1292 strlcpy(latestdir, p, sizeof latestdir);
1293 strlcpy(lcwd, p, sizeof lcwd);
1294 Var_Set(lcwd_vname, lcwd, VAR_GLOBAL);
1295 Var_Set(ldir_vname, lcwd, VAR_GLOBAL);
1296 #ifdef DEBUG_META_MODE
1297 DEBUG4(META, "%s: %d: cwd=%s ldir=%s\n",
1298 fname, lineno, cwd, lcwd);
1302 case 'M': /* renaMe */
1304 * For 'M'oves we want to check
1305 * the src as for 'R'ead
1306 * and the target as for 'W'rite.
1308 cp = p; /* save this for a second */
1309 /* now get target */
1310 if (strsep(&p, " ") == NULL)
1312 CHECK_VALID_META(p);
1315 /* 'L' and 'M' put single quotes around the args */
1317 DEQUOTE(move_target);
1319 case 'D': /* unlink */
1321 /* remove any missingFiles entries that match p */
1322 StringListNode *ln = missingFiles->first;
1323 while (ln != NULL) {
1324 StringListNode *next = ln->next;
1325 if (path_starts_with(ln->datum, p)) {
1327 Lst_Remove(missingFiles, ln);
1332 if (buf[0] == 'M') {
1333 /* the target of the mv is a file 'W'ritten */
1334 #ifdef DEBUG_META_MODE
1335 DEBUG2(META, "meta_oodate: M %s -> %s\n",
1342 case 'L': /* Link */
1345 * the src as for 'R'ead
1346 * and the target as for 'W'rite.
1349 /* now get target */
1350 if (strsep(&p, " ") == NULL)
1352 CHECK_VALID_META(p);
1353 /* 'L' and 'M' put single quotes around the args */
1356 #ifdef DEBUG_META_MODE
1357 DEBUG2(META, "meta_oodate: L %s -> %s\n", link_src, p);
1360 case 'W': /* Write */
1363 * If a file we generated within our bailiwick
1364 * but outside of .OBJDIR is missing,
1365 * we need to do it again.
1367 /* ignore non-absolute paths */
1371 if (Lst_IsEmpty(metaBailiwick))
1374 /* ignore cwd - normal dependencies handle those */
1375 if (strncmp(p, cwd, cwdlen) == 0)
1378 if (!Lst_ForEachUntil(metaBailiwick, prefix_match, p))
1381 /* tmpdir might be within */
1382 if (tmplen > 0 && strncmp(p, tmpdir, tmplen) == 0)
1385 /* ignore anything containing the string "tmp" */
1386 /* XXX: The arguments to strstr must be swapped. */
1387 if ((strstr("tmp", p)))
1390 if ((link_src != NULL && cached_lstat(p, &cst) < 0) ||
1391 (link_src == NULL && cached_stat(p, &cst) < 0)) {
1392 if (!meta_ignore(gn, p))
1393 append_if_new(missingFiles, p);
1399 #ifdef DEBUG_META_MODE
1400 DEBUG1(META, "meta_oodate: L src %s\n", p);
1403 case 'R': /* Read */
1404 case 'E': /* Exec */
1406 * Check for runtime files that can't
1407 * be part of the dependencies because
1408 * they are _expected_ to change.
1410 if (meta_ignore(gn, p))
1414 * The rest of the record is the file name.
1415 * Check if it's not an absolute path.
1424 sdirs[sdx++] = p; /* done */
1426 if (strcmp(".", p) == 0)
1427 continue; /* no point */
1429 /* Check vs latestdir */
1430 snprintf(fname1, sizeof fname1, "%s/%s", latestdir, p);
1431 sdirs[sdx++] = fname1;
1433 if (strcmp(latestdir, lcwd) != 0) {
1435 snprintf(fname2, sizeof fname2, "%s/%s", lcwd, p);
1436 sdirs[sdx++] = fname2;
1438 if (strcmp(lcwd, cwd) != 0) {
1440 snprintf(fname3, sizeof fname3, "%s/%s", cwd, p);
1441 sdirs[sdx++] = fname3;
1444 sdirs[sdx++] = NULL;
1446 for (sdp = sdirs; *sdp && !found; sdp++) {
1447 #ifdef DEBUG_META_MODE
1448 DEBUG3(META, "%s: %d: looking for: %s\n",
1449 fname, lineno, *sdp);
1451 if (cached_stat(*sdp, &cst) == 0) {
1457 #ifdef DEBUG_META_MODE
1458 DEBUG3(META, "%s: %d: found: %s\n",
1461 if (!S_ISDIR(cst.cst_mode) &&
1462 cst.cst_mtime > gn->mtime) {
1463 DEBUG3(META, "%s: %d: file '%s' is newer than the target...\n",
1466 } else if (S_ISDIR(cst.cst_mode)) {
1467 /* Update the latest directory. */
1468 cached_realpath(p, latestdir);
1470 } else if (errno == ENOENT && *p == '/' &&
1471 strncmp(p, cwd, cwdlen) != 0) {
1473 * A referenced file outside of CWD is missing.
1474 * We cannot catch every eventuality here...
1476 append_if_new(missingFiles, p);
1479 if (buf[0] == 'E') {
1480 /* previous latestdir is no longer relevant */
1481 strlcpy(latestdir, lcwd, sizeof latestdir);
1487 if (!oodate && buf[0] == 'L' && link_src != NULL)
1488 goto check_link_src;
1489 } else if (strcmp(buf, "CMD") == 0) {
1491 * Compare the current command with the one in the
1494 if (cmdNode == NULL) {
1495 DEBUG2(META, "%s: %d: there were more build commands in the meta data file than there are now...\n",
1499 char *cmd = cmdNode->datum;
1500 Boolean hasOODATE = FALSE;
1502 if (strstr(cmd, "$?"))
1504 else if ((cp = strstr(cmd, ".OODATE"))) {
1505 /* check for $[{(].OODATE[:)}] */
1506 if (cp > cmd + 2 && cp[-2] == '$')
1511 DEBUG2(META, "%s: %d: cannot compare command using .OODATE\n",
1514 (void)Var_Subst(cmd, gn, VARE_WANTRES|VARE_UNDEFERR, &cmd);
1515 /* TODO: handle errors */
1517 if ((cp = strchr(cmd, '\n'))) {
1521 * This command contains newlines, we need to
1522 * fetch more from the .meta file before we
1523 * attempt a comparison.
1525 /* first put the newline back at buf[x - 1] */
1528 /* now fetch the next line */
1529 if ((n = fgetLine(&buf, &bufsz, x, fp)) <= 0)
1533 if (buf[x - 1] != '\n') {
1534 warnx("%s: %d: line truncated at %u", fname, lineno, x);
1537 cp = strchr(++cp, '\n');
1539 if (buf[x - 1] == '\n')
1544 !(gn->type & OP_NOMETA_CMP) &&
1545 (strcmp(p, cmd) != 0)) {
1546 DEBUG4(META, "%s: %d: a build command has changed\n%s\nvs\n%s\n",
1547 fname, lineno, p, cmd);
1548 if (!metaIgnoreCMDs)
1552 cmdNode = cmdNode->next;
1554 } else if (strcmp(buf, "CWD") == 0) {
1556 * Check if there are extra commands now
1557 * that weren't in the meta data file.
1559 if (!oodate && cmdNode != NULL) {
1560 DEBUG2(META, "%s: %d: there are extra build commands now that weren't in the meta data file\n",
1564 CHECK_VALID_META(p);
1565 if (strcmp(p, cwd) != 0) {
1566 DEBUG4(META, "%s: %d: the current working directory has changed from '%s' to '%s'\n",
1567 fname, lineno, p, curdir);
1574 if (!Lst_IsEmpty(missingFiles)) {
1575 DEBUG2(META, "%s: missing files: %s...\n",
1576 fname, (char *)missingFiles->first->datum);
1579 if (!oodate && !have_filemon && filemonMissing) {
1580 DEBUG1(META, "%s: missing filemon data\n", fname);
1584 if (writeMeta && (metaMissing || (gn->type & OP_META))) {
1587 /* if target is in .CURDIR we do not need a meta file */
1588 if (gn->path && (cp = strrchr(gn->path, '/')) && cp > gn->path) {
1589 if (strncmp(curdir, gn->path, (size_t)(cp - gn->path)) != 0) {
1590 cp = NULL; /* not in .CURDIR */
1594 DEBUG1(META, "%s: required but missing\n", fname);
1596 needOODATE = TRUE; /* assume the worst */
1601 Lst_Destroy(missingFiles, free);
1603 if (oodate && needOODATE) {
1605 * Target uses .OODATE which is empty; or we wouldn't be here.
1606 * We have decided it is oodate, so .OODATE needs to be set.
1607 * All we can sanely do is set it to .ALLSRC.
1609 Var_Delete(OODATE, gn);
1610 Var_Set(OODATE, GNode_VarAllsrc(gn), gn);
1614 bmake_free(objdir_freeIt);
1618 /* support for compat mode */
1620 static int childPipe[2];
1623 meta_compat_start(void)
1625 #ifdef USE_FILEMON_ONCE
1627 * We need to re-open filemon for each cmd.
1629 BuildMon *pbm = &Mybm;
1631 if (pbm->mfp != NULL && useFilemon) {
1632 meta_open_filemon(pbm);
1635 pbm->filemon = NULL;
1638 if (pipe(childPipe) < 0)
1639 Punt("Cannot create pipe: %s", strerror(errno));
1640 /* Set close-on-exec flag for both */
1641 (void)fcntl(childPipe[0], F_SETFD, FD_CLOEXEC);
1642 (void)fcntl(childPipe[1], F_SETFD, FD_CLOEXEC);
1646 meta_compat_child(void)
1648 meta_job_child(NULL);
1649 if (dup2(childPipe[1], 1) < 0 || dup2(1, 2) < 0)
1650 execDie("dup2", "pipe");
1654 meta_compat_parent(pid_t child)
1656 int outfd, metafd, maxfd, nfds;
1660 meta_job_parent(NULL, child);
1661 close(childPipe[1]); /* child side */
1662 outfd = childPipe[0];
1664 metafd = Mybm.filemon ? filemon_readfd(Mybm.filemon) : -1;
1674 while (outfd != -1 || metafd != -1) {
1677 FD_SET(outfd, &readfds);
1680 FD_SET(metafd, &readfds);
1682 nfds = select(maxfd + 1, &readfds, NULL, NULL, NULL);
1689 if (outfd != -1 && FD_ISSET(outfd, &readfds)) do {
1690 /* XXX this is not line-buffered */
1691 ssize_t nread = read(outfd, buf, sizeof buf - 1);
1699 fwrite(buf, 1, (size_t)nread, stdout);
1702 meta_job_output(NULL, buf, "");
1704 if (metafd != -1 && FD_ISSET(metafd, &readfds)) {
1705 if (meta_job_event(NULL) <= 0)
1711 #endif /* USE_META */