2 * Copyright (c) 1988, 1989, 1990, 1993
3 * The Regents of the University of California. All rights reserved.
4 * Copyright (c) 1989 by Berkeley Softworks
7 * This code is derived from software contributed to Berkeley by
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the University of
21 * California, Berkeley and its contributors.
22 * 4. Neither the name of the University nor the names of its contributors
23 * may be used to endorse or promote products derived from this software
24 * without specific prior written permission.
26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 * @(#)make.c 8.1 (Berkeley) 6/6/93
41 #include <sys/cdefs.h>
42 __FBSDID("$FreeBSD$");
46 * The functions which perform the examination of targets and
47 * their suitability for creation
50 * Make_Run Initialize things for the module and recreate
51 * whatever needs recreating. Returns TRUE if
52 * work was (or would have been) done and FALSE
55 * Make_Update Update all parents of a given child. Performs
56 * various bookkeeping chores like the updating
57 * of the cmtime field of the parent, filling
58 * of the IMPSRC context variable, etc. It will
59 * place the parent on the toBeMade queue if it should be.
61 * Make_TimeStamp Function to set the parent's cmtime field
62 * based on a child's modification time.
64 * Make_DoAllVar Set up the various local variables for a
65 * target, including the .ALLSRC variable, making
66 * sure that any variable that needs to exist
67 * at the very least has the empty value.
69 * Make_OODate Determine if a target is out-of-date.
71 * Make_HandleUse See if a child is a .USE node for a parent
72 * and perform the .USE actions if so.
90 /* The current fringe of the graph. These are nodes which await examination
91 * by MakeOODate. It is added to by Make_Update and subtracted from by
93 static Lst toBeMade = Lst_Initializer(toBeMade);
96 * Number of nodes to be processed. If this is non-zero when Job_Empty()
97 * returns TRUE, there's a cycle in the graph.
101 static Boolean MakeStartJobs(void);
105 * Set the cmtime field of a parent node based on the mtime stamp in its
106 * child. Called from MakeOODate via LST_FOREACH.
112 * The cmtime of the parent node will be changed if the mtime
113 * field of the child is greater than it.
116 Make_TimeStamp(GNode *pgn, GNode *cgn)
119 if (cgn->mtime > pgn->cmtime) {
120 pgn->cmtime = cgn->mtime;
127 * See if a given node is out of date with respect to its sources.
128 * Used by Make_Run when deciding which nodes to place on the
129 * toBeMade queue initially and by Make_Update to screen out USE and
130 * EXEC nodes. In the latter case, however, any other sort of node
131 * must be considered out-of-date since at least one of its children
132 * will have been recreated.
135 * TRUE if the node is out of date. FALSE otherwise.
138 * The mtime field of the node and the cmtime field of its parents
139 * will/may be changed.
142 Make_OODate(GNode *gn)
148 * Certain types of targets needn't even be sought as their datedness
149 * doesn't depend on their modification time...
151 if ((gn->type & (OP_JOIN | OP_USE | OP_EXEC)) == 0) {
153 if (gn->mtime != 0) {
154 DEBUGF(MAKE, ("modified %s...",
155 Targ_FmtTime(gn->mtime)));
157 DEBUGF(MAKE, ("non-existent..."));
162 * A target is remade in one of the following circumstances:
163 * its modification time is smaller than that of its youngest child
164 * and it would actually be run (has commands or type OP_NOP)
165 * it's the object of a force operator
166 * it has no children, was on the lhs of an operator and doesn't
169 * Libraries are only considered out-of-date if the archive module says
172 * These weird rules are brought to you by Backward-Compatibility and
173 * the strange people who wrote 'Make'.
175 if (gn->type & OP_USE) {
177 * If the node is a USE node it is *never* out of date
180 DEBUGF(MAKE, (".USE node..."));
183 } else if (gn->type & OP_LIB) {
184 DEBUGF(MAKE, ("library..."));
187 * always out of date if no children and :: target
189 oodate = Arch_LibOODate(gn) ||
190 ((gn->cmtime == 0) && (gn->type & OP_DOUBLEDEP));
192 } else if (gn->type & OP_JOIN) {
194 * A target with the .JOIN attribute is only considered
195 * out-of-date if any of its children was out-of-date.
197 DEBUGF(MAKE, (".JOIN node..."));
198 oodate = gn->childMade;
200 } else if (gn->type & (OP_FORCE|OP_EXEC|OP_PHONY)) {
202 * A node which is the object of the force (!) operator or
203 * which has the .EXEC attribute is always considered
206 if (gn->type & OP_FORCE) {
207 DEBUGF(MAKE, ("! operator..."));
208 } else if (gn->type & OP_PHONY) {
209 DEBUGF(MAKE, (".PHONY node..."));
211 DEBUGF(MAKE, (".EXEC node..."));
215 } else if ((gn->mtime < gn->cmtime) ||
216 ((gn->cmtime == 0) &&
217 ((gn->mtime==0) || (gn->type & OP_DOUBLEDEP)))) {
219 * A node whose modification time is less than that of its
220 * youngest child or that has no children (cmtime == 0) and
221 * either doesn't exist (mtime == 0) or was the object of a
222 * :: operator is out-of-date. Why? Because that's the way
225 if (gn->mtime < gn->cmtime) {
226 DEBUGF(MAKE, ("modified before source..."));
227 } else if (gn->mtime == 0) {
228 DEBUGF(MAKE, ("non-existent and no sources..."));
230 DEBUGF(MAKE, (":: operator and no sources..."));
237 * If the target isn't out-of-date, the parents need to know its
238 * modification time. Note that targets that appear to be out-of-date
239 * but aren't, because they have no commands and aren't of type OP_NOP,
240 * have their mtime stay below their children's mtime to keep parents
241 * from thinking they're out-of-date.
244 LST_FOREACH(ln, &gn->parents)
245 if (Make_TimeStamp(Lst_Datum(ln), gn))
254 * Function called by Make_Run and SuffApplyTransform on the downward
255 * pass to handle .USE and transformation nodes. A callback function
256 * for LST_FOREACH, it implements the .USE and transformation
257 * functionality by copying the node's commands, type flags
258 * and children to the parent node. Should be called before the
259 * children are enqueued to be looked at.
261 * A .USE node is much like an explicit transformation rule, except
262 * its commands are always added to the target node, even if the
263 * target already has commands.
269 * Children and commands may be added to the parent and the parent's
270 * type may be changed.
272 *-----------------------------------------------------------------------
275 Make_HandleUse(GNode *cgn, GNode *pgn)
277 GNode *gn; /* A child of the .USE node */
278 LstNode *ln; /* An element in the children list */
280 if (cgn->type & (OP_USE | OP_TRANSFORM)) {
281 if ((cgn->type & OP_USE) || Lst_IsEmpty(&pgn->commands)) {
283 * .USE or transformation and target has no commands --
284 * append the child's commands to the parent.
286 Lst_Concat(&pgn->commands, &cgn->commands, LST_CONCNEW);
289 for (ln = Lst_First(&cgn->children); ln != NULL;
293 if (Lst_Member(&pgn->children, gn) == NULL) {
294 Lst_AtEnd(&pgn->children, gn);
295 Lst_AtEnd(&gn->parents, pgn);
300 pgn->type |= cgn->type & ~(OP_OPMASK | OP_USE | OP_TRANSFORM);
303 * This child node is now "made", so we decrement the count of
304 * unmade children in the parent... We also remove the child
305 * from the parent's list to accurately reflect the number of
306 * decent children the parent has. This is used by Make_Run to
307 * decide whether to queue the parent or examine its children...
309 if (cgn->type & OP_USE) {
318 * Perform update on the parents of a node. Used by JobFinish once
319 * a node has been dealt with and by MakeStartJobs if it finds an
326 * The unmade field of pgn is decremented and pgn may be placed on
327 * the toBeMade queue if this field becomes 0.
329 * If the child was made, the parent's childMade field will be set true
330 * and its cmtime set to now.
332 * If the child wasn't made, the cmtime field of the parent will be
333 * altered if the child's mtime is big enough.
335 * Finally, if the child is the implied source for the parent, the
336 * parent's IMPSRC variable is set appropriately.
339 Make_Update(GNode *cgn)
341 GNode *pgn; /* the parent node */
342 const char *cname; /* the child's name */
343 LstNode *ln; /* Element in parents and iParents lists */
346 cname = Var_Value(TARGET, cgn);
349 * If the child was actually made, see what its modification time is
350 * now -- some rules won't actually update the file. If the file still
351 * doesn't exist, make its mtime now.
353 if (cgn->made != UPTODATE) {
356 * We can't re-stat the thing, but we can at least take care
357 * of rules where a target depends on a source that actually
358 * creates the target, but only if it has changed, e.g.
366 * cmp -s y.tab.h parse.h || mv y.tab.h parse.h
368 * In this case, if the definitions produced by yacc haven't
369 * changed from before, parse.h won't have been updated and
370 * cgn->mtime will reflect the current modification time for
371 * parse.h. This is something of a kludge, I admit, but it's a
373 * XXX: People like to use a rule like
377 * To force things that depend on FRC to be made, so we have to
378 * check for gn->children being empty as well...
380 if (!Lst_IsEmpty(&cgn->commands) ||
381 Lst_IsEmpty(&cgn->children)) {
386 * This is what Make does and it's actually a good thing, as it
389 * cmp -s y.tab.h parse.h || cp y.tab.h parse.h
391 * to function as intended. Unfortunately, thanks to the
392 * stateless nature of NFS (by which I mean the loose coupling
393 * of two clients using the same file from a common server),
394 * there are times when the modification time of a file created
395 * on a remote machine will not be modified before the local
396 * stat() implied by the Dir_MTime occurs, thus leading us to
397 * believe that the file is unchanged, wreaking havoc with
398 * files that depend on this one.
400 * I have decided it is better to make too much than to make too
401 * little, so this stuff is commented out unless you're sure
406 * Christos, 4/9/92: If we are saving commands pretend that
407 * the target is made now. Otherwise archives with ... rules
410 if (noExecute || (cgn->type & OP_SAVE_CMDS) ||
411 Dir_MTime(cgn) == 0) {
414 DEBUGF(MAKE, ("update time: %s\n", Targ_FmtTime(cgn->mtime)));
418 for (ln = Lst_First(&cgn->parents); ln != NULL; ln = Lst_Succ(ln)) {
423 if (!(cgn->type & (OP_EXEC | OP_USE))) {
424 if (cgn->made == MADE) {
425 pgn->childMade = TRUE;
426 if (pgn->cmtime < cgn->mtime) {
427 pgn->cmtime = cgn->mtime;
430 Make_TimeStamp(pgn, cgn);
433 if (pgn->unmade == 0) {
435 * Queue the node up -- any unmade predecessors
436 * will be dealt with in MakeStartJobs.
438 Lst_EnQueue(&toBeMade, pgn);
439 } else if (pgn->unmade < 0) {
440 Error("Graph cycles through %s", pgn->name);
446 * Deal with successor nodes. If any is marked for making and has an
447 * unmade count of 0, has not been made and isn't in the examination
448 * queue, it means we need to place it in the queue as it restrained
451 for (ln = Lst_First(&cgn->successors); ln != NULL; ln = Lst_Succ(ln)) {
452 GNode *succ = Lst_Datum(ln);
454 if (succ->make && succ->unmade == 0 && succ->made == UNMADE &&
455 Lst_Member(&toBeMade, succ) == NULL) {
456 Lst_EnQueue(&toBeMade, succ);
461 * Set the .PREFIX and .IMPSRC variables for all the implied parents
464 cpref = Var_Value(PREFIX, cgn);
465 for (ln = Lst_First(&cgn->iParents); ln != NULL; ln = Lst_Succ(ln)) {
468 Var_Set(IMPSRC, cname, pgn);
469 Var_Set(PREFIX, cpref, pgn);
476 * Set up the ALLSRC and OODATE variables. Sad to say, it must be
477 * done separately, rather than while traversing the graph. This is
478 * because Make defined OODATE to contain all sources whose modification
479 * times were later than that of the target, *not* those sources that
480 * were out-of-date. Since in both compatibility and native modes,
481 * the modification time of the parent isn't found until the child
482 * has been dealt with, we have to wait until now to fill in the
483 * variable. As for ALLSRC, the ordering is important and not
484 * guaranteed when in native mode, so it must be set here, too.
487 * The ALLSRC and OODATE variables of the given node is filled in.
488 * If the node is a .JOIN node, its TARGET variable will be set to
489 * match its ALLSRC variable.
492 Make_DoAllVar(GNode *gn)
498 LST_FOREACH(ln, &gn->children) {
500 * Add the child's name to the ALLSRC and OODATE variables of
501 * the given node. The child is added only if it has not been
502 * given the .EXEC, .USE or .INVISIBLE attributes. .EXEC and
503 * .USE children are very rarely going to be files, so...
505 * A child is added to the OODATE variable if its modification
506 * time is later than that of its parent, as defined by Make,
507 * except if the parent is a .JOIN node. In that case, it is
508 * only added to the OODATE variable if it was actually made
509 * (since .JOIN nodes don't have modification times, the
510 * comparison is rather unfair...).
514 if ((cgn->type & (OP_EXEC | OP_USE | OP_INVISIBLE)) == 0) {
515 if (OP_NOP(cgn->type)) {
517 * this node is only source; use the specific
520 child = cgn->path ? cgn->path : cgn->name;
522 child = Var_Value(TARGET, cgn);
523 Var_Append(ALLSRC, child, gn);
524 if (gn->type & OP_JOIN) {
525 if (cgn->made == MADE) {
526 Var_Append(OODATE, child, gn);
528 } else if (gn->mtime < cgn->mtime ||
529 (cgn->mtime >= now && cgn->made == MADE)) {
531 * It goes in the OODATE variable if the parent
532 * is younger than the child or if the child has
533 * been modified more recently than the start of
534 * the make. This is to keep pmake from getting
535 * confused if something else updates the parent
536 * after the make starts (shouldn't happen, I
537 * know, but sometimes it does). In such a case,
538 * if we've updated the kid, the parent is
539 * likely to have a modification time later than
540 * that of the kid and anything that relies on
541 * the OODATE variable will be hosed.
543 * XXX: This will cause all made children to
544 * go in the OODATE variable, even if they're
545 * not touched, if RECHECK isn't defined, since
546 * cgn->mtime is set to now in Make_Update.
547 * According to some people, this is good...
549 Var_Append(OODATE, child, gn);
554 if (!Var_Exists (OODATE, gn)) {
555 Var_Set(OODATE, "", gn);
557 if (!Var_Exists (ALLSRC, gn)) {
558 Var_Set(ALLSRC, "", gn);
561 if (gn->type & OP_JOIN) {
562 Var_Set(TARGET, Var_Value(ALLSRC, gn), gn);
568 * Start as many jobs as possible.
571 * If the query flag was given to pmake, no job will be started,
572 * but as soon as an out-of-date target is found, this function
573 * returns TRUE. At all other times, this function returns FALSE.
576 * Nodes are removed from the toBeMade queue and job table slots
584 while (!Lst_IsEmpty(&toBeMade) && !Job_Full()) {
585 gn = Lst_DeQueue(&toBeMade);
586 DEBUGF(MAKE, ("Examining %s...", gn->name));
589 * Make sure any and all predecessors that are going to be made,
592 if (!Lst_IsEmpty(&gn->preds)) {
595 for (ln = Lst_First(&gn->preds); ln != NULL;
597 GNode *pgn = Lst_Datum(ln);
599 if (pgn->make && pgn->made == UNMADE) {
600 DEBUGF(MAKE, ("predecessor %s not made "
601 "yet.\n", pgn->name));
606 * If ln isn't NULL, there's a predecessor as yet
607 * unmade, so we just drop this node on the floor.
608 * When the node in question has been made, it will
609 * notice this node as being ready to make but as yet
610 * unmade and will place the node on the queue.
618 if (Make_OODate(gn)) {
619 DEBUGF(MAKE, ("out-of-date\n"));
626 DEBUGF(MAKE, ("up-to-date\n"));
628 if (gn->type & OP_JOIN) {
630 * Even for an up-to-date .JOIN node, we need
631 * it to have its context variables so
632 * references to it get the correct value for
633 * .TARGET when building up the context
634 * variables of its parent(s)...
647 * Print the status of a top-level node, viz. it being up-to-date
648 * already or not created due to an error in a lower level.
649 * Callback function for Make_Run via LST_FOREACH. If gn->unmade is
650 * nonzero and that is meant to imply a cycle in the graph, then
654 * A message may be printed.
657 MakePrintStatus(GNode *gn, Boolean cycle)
661 if (gn->made == UPTODATE) {
662 printf("`%s' is up to date.\n", gn->name);
664 } else if (gn->unmade != 0) {
667 * If printing cycles and came to one that has unmade
668 * children, print out the cycle by recursing on its
669 * children. Note a cycle like:
673 * will cause this to erroneously complain about a
674 * being in the cycle, but this is a good approximation.
676 if (gn->made == CYCLE) {
677 Error("Graph cycles through `%s'", gn->name);
679 LST_FOREACH(ln, &gn->children)
680 MakePrintStatus(Lst_Datum(ln), TRUE);
682 } else if (gn->made != ENDCYCLE) {
684 LST_FOREACH(ln, &gn->children)
685 MakePrintStatus(Lst_Datum(ln), TRUE);
688 printf("`%s' not remade because of errors.\n",
696 * Initialize the nodes to remake and the list of nodes which are
697 * ready to be made by doing a breadth-first traversal of the graph
698 * starting from the nodes in the given list. Once this traversal
699 * is finished, all the 'leaves' of the graph are in the toBeMade
701 * Using this queue and the Job module, work back up the graph,
702 * calling on MakeStartJobs to keep the job table as full as
706 * TRUE if work was done. FALSE otherwise.
709 * The make field of all nodes involved in the creation of the given
710 * targets is set to 1. The toBeMade list is set to contain all the
711 * 'leaves' of these subgraphs.
716 GNode *gn; /* a temporary pointer */
718 Lst examine; /* List of targets to examine */
719 int errors; /* Number of errors the Job module reports */
723 Lst_Duplicate(&examine, targs, NOCOPY);
727 * Make an initial downward pass over the graph, marking nodes to be
728 * made as we go down. We call Suff_FindDeps to find where a node is and
729 * to get some children for it if it has none and also has no commands.
730 * If the node is a leaf, we stick it on the toBeMade queue to
731 * be looked at in a minute, otherwise we add its children to our queue
732 * and go on about our business.
734 while (!Lst_IsEmpty(&examine)) {
735 gn = Lst_DeQueue(&examine);
742 * Apply any .USE rules before looking for implicit
743 * dependencies to make sure everything has commands
746 LST_FOREACH(ln, &gn->children)
747 if (Make_HandleUse(Lst_Datum(ln), gn))
752 if (gn->unmade != 0) {
753 LST_FOREACH(ln, &gn->children) {
755 if (!cgn->make && !(cgn->type & OP_USE))
756 Lst_EnQueue(&examine, cgn);
759 Lst_EnQueue(&toBeMade, gn);
766 * We wouldn't do any work unless we could start some jobs in
767 * the next loop... (we won't actually start any, of course,
768 * this is just to see if any of the targets was out of date)
770 return (MakeStartJobs());
774 * Initialization. At the moment, no jobs are running and
775 * until some get started, nothing will happen since the
776 * remaining upward traversal of the graph is performed by the
777 * routines in job.c upon the finishing of a job. So we fill
778 * the Job table as much as we can before going into our loop.
784 * Main Loop: The idea here is that the ending of jobs will take
785 * care of the maintenance of data structures and the waiting for output
786 * will cause us to be idle most of the time while our children run as
787 * much as possible. Because the job table is kept as full as possible,
788 * the only time when it will be empty is when all the jobs which need
789 * running have been run, so that is the end condition of this loop.
790 * Note that the Job module will exit if there were any errors unless
791 * the keepgoing flag was given.
793 while (!Job_Empty()) {
794 Job_CatchOutput(!Lst_IsEmpty(&toBeMade));
795 Job_CatchChildren(!usePipes);
799 errors = Job_Finish();
802 * Print the final status of each target. E.g. if it wasn't made
803 * because some inferior reported an error.
805 errors = ((errors == 0) && (numNodes != 0));
806 LST_FOREACH(ln, targs)
807 MakePrintStatus(Lst_Datum(ln), errors);