2 * Copyright (c) 1988, 1989, 1990, 1993
3 * The Regents of the University of California. All rights reserved.
4 * Copyright (c) 1988, 1989 by Adam de Boor
5 * Copyright (c) 1989 by Berkeley Softworks
8 * This code is derived from software contributed to Berkeley by
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the University of
22 * California, Berkeley and its contributors.
23 * 4. Neither the name of the University nor the names of its contributors
24 * may be used to endorse or promote products derived from this software
25 * without specific prior written permission.
27 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39 * @(#)job.c 8.2 (Berkeley) 3/19/94
40 * $FreeBSD: src/usr.bin/make/job.c,v 1.75 2005/02/10 14:32:14 harti Exp $
41 * $DragonFly: src/usr.bin/make/job.c,v 1.44 2005/02/28 12:00:10 okumoto Exp $
50 * handle the creation etc. of our child processes.
53 * Job_Make Start the creation of the given target.
55 * Job_CatchChildren Check for and handle the termination of any
56 * children. This must be called reasonably
57 * frequently to keep the whole make going at
58 * a decent clip, since job table entries aren't
59 * removed until their process is caught this way.
60 * Its single argument is TRUE if the function
61 * should block waiting for a child to terminate.
63 * Job_CatchOutput Print any output our children have produced.
64 * Should also be called fairly frequently to
65 * keep the user informed of what's going on.
66 * If no output is waiting, it will block for
67 * a time given by the SEL_* constants, below,
68 * or until output is ready.
70 * Job_Init Called to intialize this module. in addition,
71 * any commands attached to the .BEGIN target
72 * are executed before this function returns.
73 * Hence, the makefile must have been parsed
74 * before this function is called.
76 * Job_Full Return TRUE if the job table is filled.
78 * Job_Empty Return TRUE if the job table is completely
81 * Job_ParseShell Given the line following a .SHELL target, parse
82 * the line as a shell specification. Returns
83 * FAILURE if the spec was incorrect.
85 * Job_Finish Perform any final processing which needs doing.
86 * This includes the execution of any commands
87 * which have been/were attached to the .END
88 * target. It should only be called when the
91 * Job_AbortAll Abort all currently running jobs. It doesn't
92 * handle output or do anything for the jobs,
93 * just kills them. It should only be called in
94 * an emergency, as it were.
96 * Job_CheckCommands Verify that the commands for a target are
97 * ok. Provide them if necessary and possible.
99 * Job_Touch Update a target without really updating it.
101 * Job_Wait Wait for all currently-running jobs to finish.
104 #include <sys/types.h>
105 #include <sys/select.h>
106 #include <sys/stat.h>
108 #include <sys/event.h>
110 #include <sys/wait.h>
129 #include "pathnames.h"
135 #define STATIC static
138 * error handling variables
140 static int errors = 0; /* number of errors reported */
141 static int aborting = 0; /* why is the make aborting? */
142 #define ABORT_ERROR 1 /* Because of an error */
143 #define ABORT_INTERRUPT 2 /* Because it was interrupted */
144 #define ABORT_WAIT 3 /* Waiting for jobs to finish */
147 * XXX: Avoid SunOS bug... FILENO() is fp->_file, and file
148 * is a char! So when we go above 127 we turn negative!
150 #define FILENO(a) ((unsigned)fileno(a))
153 * post-make command processing. The node postCommands is really just the
154 * .END target but we keep it around to avoid having to search for it
157 static GNode *postCommands; /* node containing commands to execute when
158 * everything else is done */
159 static int numCommands; /* The number of commands actually printed
160 * for a target. Should this number be
161 * 0, no shell will be executed. */
164 * Return values from JobStart.
166 #define JOB_RUNNING 0 /* Job is running */
167 #define JOB_ERROR 1 /* Error in starting the job */
168 #define JOB_FINISHED 2 /* The job is already finished */
169 #define JOB_STOPPED 3 /* The job is stopped */
172 * tfile is used to build temp file names to store shell commands to
175 static char tfile[sizeof(TMPPAT)];
178 * Descriptions for various shells.
180 static const DEF_SHELL_STRUCT(CShell, const) shells[] = {
182 * CSH description. The csh can do echo control by playing
183 * with the setting of the 'echo' shell variable. Sadly,
184 * however, it is unable to do error control nicely.
188 TRUE, "unset verbose", "set verbose", "unset verbose", 13,
189 FALSE, "echo \"%s\"\n", "csh -c \"%s || exit 0\"",
193 * SH description. Echo control is also possible and, under
194 * sun UNIX anyway, one can even control error checking.
198 TRUE, "set -", "set -v", "set -", 5,
199 TRUE, "set -e", "set +e",
200 #ifdef OLDBOURNESHELL
201 FALSE, "echo \"%s\"\n", "sh -c '%s || exit 0'\n",
206 * KSH description. The Korn shell has a superset of
207 * the Bourne shell's functionality.
211 TRUE, "set -", "set -v", "set -", 5,
212 TRUE, "set -e", "set +e",
216 static Shell *commandShell = NULL; /* this is the shell to which we pass
217 * all commands in the Makefile. It is
218 * set by the Job_ParseShell function */
219 char *shellPath = NULL, /* full pathname of executable image */
220 *shellName = NULL; /* last component of shell */
223 int maxJobs; /* The most children we can run at once */
224 STATIC int nJobs; /* The number of children currently running */
226 /* The structures that describe them */
227 STATIC Lst jobs = Lst_Initializer(jobs);
229 STATIC Boolean jobFull; /* Flag to tell when the job table is full. It
230 * is set TRUE when (1) the total number of
231 * running jobs equals the maximum allowed */
233 static int kqfd; /* File descriptor obtained by kqueue() */
235 static fd_set outputs; /* Set of descriptors of pipes connected to
236 * the output channels of children */
239 STATIC GNode *lastNode; /* The node for which output was most recently
241 STATIC const char *targFmt; /* Format string to use to head output from a
242 * job when it's not the most-recent job heard
245 #define TARG_FMT "--- %s ---\n" /* Default format */
246 #define MESSAGE(fp, gn) \
247 fprintf(fp, targFmt, gn->name);
250 * When JobStart attempts to run a job but isn't allowed to
251 * or when Job_CatchChildren detects a job that has
252 * been stopped somehow, the job is placed on the stoppedJobs queue to be run
253 * when the next job finishes.
255 * Lst of Job structures describing jobs that were stopped due to
256 * concurrency limits or externally
258 STATIC Lst stoppedJobs = Lst_Initializer(stoppedJobs);
260 STATIC int fifoFd; /* Fd of our job fifo */
261 STATIC char fifoName[] = "/tmp/make_fifo_XXXXXXXXX";
262 STATIC int fifoMaster;
264 static sig_atomic_t interrupted;
267 #if defined(USE_PGRP) && defined(SYSV)
268 # define KILL(pid, sig) killpg(-(pid), (sig))
270 # if defined(USE_PGRP)
271 # define KILL(pid, sig) killpg((pid), (sig))
273 # define KILL(pid, sig) kill((pid), (sig))
278 * Grmpf... There is no way to set bits of the wait structure
279 * anymore with the stupid W*() macros. I liked the union wait
280 * stuff much more. So, we devise our own macros... This is
281 * really ugly, use dramamine sparingly. You have been warned.
283 #define W_SETMASKED(st, val, fun) \
286 int mask = fun(sh); \
288 for (sh = 0; ((mask >> sh) & 1) == 0; sh++) \
290 *(st) = (*(st) & ~mask) | ((val) << sh); \
293 #define W_SETTERMSIG(st, val) W_SETMASKED(st, val, WTERMSIG)
294 #define W_SETEXITSTATUS(st, val) W_SETMASKED(st, val, WEXITSTATUS)
297 static int JobCondPassSig(void *, void *);
298 static void JobPassSig(int);
299 static int JobPrintCommand(void *, void *);
300 static int JobSaveCommand(void *, void *);
301 static void JobClose(Job *);
302 static void JobFinish(Job *, int *);
303 static void JobExec(Job *, char **);
304 static void JobMakeArgv(Job *, char **);
305 static void JobRestart(Job *);
306 static int JobStart(GNode *, int, Job *);
307 static char *JobOutput(Job *, char *, char *, int);
308 static void JobDoOutput(Job *, Boolean);
309 static Shell *JobMatchShell(const char *);
310 static void JobInterrupt(int, int);
311 static void JobRestartJobs(void);
316 * Got a signal. Set global variables and hope that someone will
320 JobCatchSig(int signo)
327 *-----------------------------------------------------------------------
329 * Pass a signal to a job if USE_PGRP is defined.
335 * None, except the job may bite it.
337 *-----------------------------------------------------------------------
340 JobCondPassSig(void *jobp, void *signop)
343 int signo = *(int *)signop;
345 DEBUGF(JOB, ("JobCondPassSig passing signal %d to child %d.\n",
347 KILL(job->pid, signo);
352 *-----------------------------------------------------------------------
354 * Pass a signal on to all local jobs if
355 * USE_PGRP is defined, then die ourselves.
361 * We die by the same signal.
363 *-----------------------------------------------------------------------
366 JobPassSig(int signo)
368 sigset_t nmask, omask;
369 struct sigaction act;
372 sigaddset(&nmask, signo);
373 sigprocmask(SIG_SETMASK, &nmask, &omask);
375 DEBUGF(JOB, ("JobPassSig(%d) called.\n", signo));
376 Lst_ForEach(&jobs, JobCondPassSig, &signo);
379 * Deal with proper cleanup based on the signal received. We only run
380 * the .INTERRUPT target if the signal was in fact an interrupt. The other
381 * three termination signals are more of a "get out *now*" command.
383 if (signo == SIGINT) {
384 JobInterrupt(TRUE, signo);
385 } else if ((signo == SIGHUP) || (signo == SIGTERM) || (signo == SIGQUIT)) {
386 JobInterrupt(FALSE, signo);
390 * Leave gracefully if SIGQUIT, rather than core dumping.
392 if (signo == SIGQUIT) {
397 * Send ourselves the signal now we've given the message to everyone else.
398 * Note we block everything else possible while we're getting the signal.
399 * This ensures that all our jobs get continued when we wake up before
400 * we take any other signal.
401 * XXX this comment seems wrong.
403 act.sa_handler = SIG_DFL;
404 sigemptyset(&act.sa_mask);
406 sigaction(signo, &act, NULL);
408 DEBUGF(JOB, ("JobPassSig passing signal to self, mask = %x.\n",
409 ~0 & ~(1 << (signo - 1))));
410 signal(signo, SIG_DFL);
412 KILL(getpid(), signo);
415 Lst_ForEach(&jobs, JobCondPassSig, &signo);
417 sigprocmask(SIG_SETMASK, &omask, NULL);
418 sigprocmask(SIG_SETMASK, &omask, NULL);
419 act.sa_handler = JobPassSig;
420 sigaction(signo, &act, NULL);
424 *-----------------------------------------------------------------------
426 * Compare the pid of the job with the given pid and return 0 if they
427 * are equal. This function is called from Job_CatchChildren via
428 * Lst_Find to find the job descriptor of the finished job.
431 * 0 if the pid's match
435 *-----------------------------------------------------------------------
438 JobCmpPid(const void *job, const void *pid)
441 return (*(const int *)pid - ((const Job *)job)->pid);
445 *-----------------------------------------------------------------------
447 * Put out another command for the given job. If the command starts
448 * with an @ or a - we process it specially. In the former case,
449 * so long as the -s and -n flags weren't given to make, we stick
450 * a shell-specific echoOff command in the script. In the latter,
451 * we ignore errors for the entire job, unless the shell has error
453 * If the command is just "..." we take all future commands for this
454 * job to be commands to be executed once the entire graph has been
455 * made and return non-zero to signal that the end of the commands
456 * was reached. These commands are later attached to the postCommands
457 * node and executed by Job_Finish when all things are done.
458 * This function is called from JobStart via Lst_ForEach.
461 * Always 0, unless the command was "..."
464 * If the command begins with a '-' and the shell has no error control,
465 * the JOB_IGNERR flag is set in the job descriptor.
466 * If the command is "..." and we're not ignoring such things,
467 * tailCmds is set to the successor node of the cmd.
468 * numCommands is incremented if the command is actually printed.
469 *-----------------------------------------------------------------------
472 JobPrintCommand(void *cmdp, void *jobp)
474 Boolean noSpecials; /* true if we shouldn't worry about
475 * inserting special commands into
476 * the input stream. */
477 Boolean shutUp = FALSE; /* true if we put a no echo command
478 * into the command file */
479 Boolean errOff = FALSE; /* true if we turned error checking
480 * off before printing the command
481 * and need to turn it back on */
482 const char *cmdTemplate; /* Template to use when printing the
484 char *cmdStart; /* Start of expanded command */
485 LstNode *cmdNode; /* Node for replacing the command */
490 noSpecials = (noExecute && !(job->node->type & OP_MAKE));
492 if (strcmp(cmd, "...") == 0) {
493 job->node->type |= OP_SAVE_CMDS;
494 if ((job->flags & JOB_IGNDOTS) == 0) {
495 job->tailCmds = Lst_Succ(Lst_Member(&job->node->commands, cmd));
501 #define DBPRINTF(fmt, arg) \
502 DEBUGF(JOB, (fmt, arg)); \
503 fprintf(job->cmdFILE, fmt, arg); \
504 fflush(job->cmdFILE);
509 * For debugging, we replace each command with the result of expanding
510 * the variables in the command.
512 cmdNode = Lst_Member(&job->node->commands, cmd);
514 buf = Var_Subst(NULL, cmd, job->node, FALSE);
515 cmd = Buf_GetAll(buf, NULL);
516 Buf_Destroy(buf, FALSE);
519 Lst_Replace(cmdNode, cmdStart);
521 cmdTemplate = "%s\n";
524 * Check for leading @', -' or +'s to control echoing, error checking,
525 * and execution on -n.
527 while (*cmd == '@' || *cmd == '-' || *cmd == '+') {
531 shutUp = DEBUG(LOUD) ? FALSE : TRUE;
541 * We're not actually exececuting anything...
542 * but this one needs to be - use compat mode just for it.
544 Compat_RunCommand(cmdp, job->node);
552 while (isspace((unsigned char)*cmd))
556 if (!(job->flags & JOB_SILENT) && !noSpecials &&
557 commandShell->hasEchoCtl) {
558 DBPRINTF("%s\n", commandShell->echoOff);
565 if ( !(job->flags & JOB_IGNERR) && !noSpecials) {
566 if (commandShell->hasErrCtl) {
568 * we don't want the error-control commands showing
569 * up either, so we turn off echoing while executing
570 * them. We could put another field in the shell
571 * structure to tell JobDoOutput to look for this
572 * string too, but why make it any more complex than
575 if (!(job->flags & JOB_SILENT) && !shutUp &&
576 commandShell->hasEchoCtl) {
577 DBPRINTF("%s\n", commandShell->echoOff);
578 DBPRINTF("%s\n", commandShell->ignErr);
579 DBPRINTF("%s\n", commandShell->echoOn);
581 DBPRINTF("%s\n", commandShell->ignErr);
583 } else if (commandShell->ignErr &&
584 (*commandShell->ignErr != '\0'))
587 * The shell has no error control, so we need to be
588 * weird to get it to ignore any errors from the command.
589 * If echoing is turned on, we turn it off and use the
590 * errCheck template to echo the command. Leave echoing
591 * off so the user doesn't see the weirdness we go through
592 * to ignore errors. Set cmdTemplate to use the weirdness
593 * instead of the simple "%s\n" template.
595 if (!(job->flags & JOB_SILENT) && !shutUp &&
596 commandShell->hasEchoCtl) {
597 DBPRINTF("%s\n", commandShell->echoOff);
598 DBPRINTF(commandShell->errCheck, cmd);
601 cmdTemplate = commandShell->ignErr;
603 * The error ignoration (hee hee) is already taken care
604 * of by the ignErr template, so pretend error checking
616 DBPRINTF(cmdTemplate, cmd);
620 * If echoing is already off, there's no point in issuing the
621 * echoOff command. Otherwise we issue it and pretend it was on
622 * for the whole command...
624 if (!shutUp && !(job->flags & JOB_SILENT) && commandShell->hasEchoCtl) {
625 DBPRINTF("%s\n", commandShell->echoOff);
628 DBPRINTF("%s\n", commandShell->errCheck);
631 DBPRINTF("%s\n", commandShell->echoOn);
637 *-----------------------------------------------------------------------
639 * Save a command to be executed when everything else is done.
640 * Callback function for JobFinish...
646 * The command is tacked onto the end of postCommands's commands list.
648 *-----------------------------------------------------------------------
651 JobSaveCommand(void *cmd, void *gn)
656 buf = Var_Subst(NULL, cmd, gn, FALSE);
657 str = Buf_GetAll(buf, NULL);
658 Buf_Destroy(buf, FALSE);
660 Lst_AtEnd(&postCommands->commands, str);
666 *-----------------------------------------------------------------------
668 * Called to close both input and output pipes when a job is finished.
674 * The file descriptors associated with the job are closed.
676 *-----------------------------------------------------------------------
683 #if !defined(USE_KQUEUE)
684 FD_CLR(job->inPipe, &outputs);
686 if (job->outPipe != job->inPipe) {
689 JobDoOutput(job, TRUE);
693 JobDoOutput(job, TRUE);
698 *-----------------------------------------------------------------------
700 * Do final processing for the given job including updating
701 * parents and starting new jobs as available/necessary. Note
702 * that we pay no attention to the JOB_IGNERR flag here.
703 * This is because when we're called because of a noexecute flag
704 * or something, jstat.w_status is 0 and when called from
705 * Job_CatchChildren, the status is zeroed if it s/b ignored.
711 * Some nodes may be put on the toBeMade queue.
712 * Final commands for the job are placed on postCommands.
714 * If we got an error and are aborting (aborting == ABORT_ERROR) and
715 * the job list is now empty, we are done for the day.
716 * If we recognized an error (errors !=0), we set the aborting flag
717 * to ABORT_ERROR so no more jobs will be started.
718 *-----------------------------------------------------------------------
722 JobFinish(Job *job, int *status)
726 if ((WIFEXITED(*status) &&
727 (((WEXITSTATUS(*status) != 0) && !(job->flags & JOB_IGNERR)))) ||
728 (WIFSIGNALED(*status) && (WTERMSIG(*status) != SIGCONT)))
731 * If it exited non-zero and either we're doing things our
732 * way or we're not ignoring errors, the job is finished.
733 * Similarly, if the shell died because of a signal
734 * the job is also finished. In these
735 * cases, finish out the job's output before printing the exit
739 if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
740 fclose(job->cmdFILE);
743 } else if (WIFEXITED(*status)) {
745 * Deal with ignored errors in -B mode. We need to print a message
746 * telling of the ignored error as well as setting status.w_status
747 * to 0 so the next command gets run. To do this, we set done to be
748 * TRUE if in -B mode and the job exited non-zero.
750 done = WEXITSTATUS(*status) != 0;
752 * Old comment said: "Note we don't
753 * want to close down any of the streams until we know we're at the
755 * But we do. Otherwise when are we going to print the rest of the
761 * No need to close things down or anything.
767 WIFSTOPPED(*status) ||
768 (WIFSIGNALED(*status) && (WTERMSIG(*status) == SIGCONT)) ||
773 if (compatMake && !usePipes && (job->flags & JOB_IGNERR)) {
775 * If output is going to a file and this job is ignoring
776 * errors, arrange to have the exit status sent to the
777 * output file as well.
779 out = fdopen(job->outFd, "w");
781 Punt("Cannot fdopen");
786 if (WIFEXITED(*status)) {
787 DEBUGF(JOB, ("Process %d exited.\n", job->pid));
788 if (WEXITSTATUS(*status) != 0) {
789 if (usePipes && job->node != lastNode) {
790 MESSAGE(out, job->node);
791 lastNode = job->node;
793 fprintf(out, "*** Error code %d%s\n",
794 WEXITSTATUS(*status),
795 (job->flags & JOB_IGNERR) ? "(ignored)" : "");
797 if (job->flags & JOB_IGNERR) {
800 } else if (DEBUG(JOB)) {
801 if (usePipes && job->node != lastNode) {
802 MESSAGE(out, job->node);
803 lastNode = job->node;
805 fprintf(out, "*** Completed successfully\n");
807 } else if (WIFSTOPPED(*status)) {
808 DEBUGF(JOB, ("Process %d stopped.\n", job->pid));
809 if (usePipes && job->node != lastNode) {
810 MESSAGE(out, job->node);
811 lastNode = job->node;
813 fprintf(out, "*** Stopped -- signal %d\n",
815 job->flags |= JOB_RESUME;
816 Lst_AtEnd(&stoppedJobs, job);
819 } else if (WTERMSIG(*status) == SIGCONT) {
821 * If the beastie has continued, shift the Job from the stopped
822 * list to the running one (or re-stop it if concurrency is
823 * exceeded) and go and get another child.
825 if (job->flags & (JOB_RESUME|JOB_RESTART)) {
826 if (usePipes && job->node != lastNode) {
827 MESSAGE(out, job->node);
828 lastNode = job->node;
830 fprintf(out, "*** Continued\n");
832 if (!(job->flags & JOB_CONTINUING)) {
833 DEBUGF(JOB, ("Warning: process %d was not continuing.\n", job->pid));
836 * We don't really want to restart a job from scratch just
837 * because it continued, especially not without killing the
838 * continuing process! That's why this is ifdef'ed out.
844 job->flags &= ~JOB_CONTINUING;
845 Lst_AtEnd(&jobs, job);
847 DEBUGF(JOB, ("Process %d is continuing locally.\n", job->pid));
848 if (nJobs == maxJobs) {
850 DEBUGF(JOB, ("Job queue is full.\n"));
855 if (usePipes && job->node != lastNode) {
856 MESSAGE(out, job->node);
857 lastNode = job->node;
859 fprintf(out, "*** Signal %d\n", WTERMSIG(*status));
866 * Now handle the -B-mode stuff. If the beast still isn't finished,
867 * try and restart the job on the next command. If JobStart says it's
868 * ok, it's ok. If there's an error, this puppy is done.
870 if (compatMake && WIFEXITED(*status) &&
871 Lst_Succ(job->node->compat_command) != NULL) {
872 switch (JobStart(job->node, job->flags & JOB_IGNDOTS, job)) {
878 W_SETEXITSTATUS(status, 1);
882 * If we got back a JOB_FINISHED code, JobStart has already
883 * called Make_Update and freed the job descriptor. We set
884 * done to false here to avoid fake cycles and double frees.
885 * JobStart needs to do the update so we can proceed up the
886 * graph when given the -n flag..
899 (aborting != ABORT_ERROR) &&
900 (aborting != ABORT_INTERRUPT) &&
904 * As long as we aren't aborting and the job didn't return a non-zero
905 * status that we shouldn't ignore, we call Make_Update to update
906 * the parents. In addition, any saved commands for the node are placed
907 * on the .END target.
909 if (job->tailCmds != NULL) {
910 Lst_ForEachFrom(&job->node->commands, job->tailCmds,
911 JobSaveCommand, job->node);
913 job->node->made = MADE;
914 Make_Update(job->node);
916 } else if (*status != 0) {
924 * Set aborting if any error.
926 if (errors && !keepgoing && (aborting != ABORT_INTERRUPT)) {
928 * If we found any errors in this batch of children and the -k flag
929 * wasn't given, we set the aborting flag so no more jobs get
932 aborting = ABORT_ERROR;
935 if ((aborting == ABORT_ERROR) && Job_Empty())
937 * If we are aborting and the job table is now empty, we finish.
943 *-----------------------------------------------------------------------
945 * Touch the given target. Called by JobStart when the -t flag was
946 * given. Prints messages unless told to be silent.
952 * The data modification of the file is changed. In addition, if the
953 * file did not exist, it is created.
954 *-----------------------------------------------------------------------
957 Job_Touch(GNode *gn, Boolean silent)
959 int streamID; /* ID of stream opened to do the touch */
960 struct utimbuf times; /* Times for utime() call */
962 if (gn->type & (OP_JOIN | OP_USE | OP_EXEC | OP_OPTIONAL)) {
964 * .JOIN, .USE, .ZEROTIME and .OPTIONAL targets are "virtual" targets
965 * and, as such, shouldn't really be created.
971 fprintf(stdout, "touch %s\n", gn->name);
979 if (gn->type & OP_ARCHV) {
981 } else if (gn->type & OP_LIB) {
984 char *file = gn->path ? gn->path : gn->name;
986 times.actime = times.modtime = now;
987 if (utime(file, ×) < 0){
988 streamID = open(file, O_RDWR | O_CREAT, 0666);
994 * Read and write a byte to the file to change the
995 * modification time, then close the file.
997 if (read(streamID, &c, 1) == 1) {
998 lseek(streamID, (off_t)0, SEEK_SET);
999 write(streamID, &c, 1);
1004 fprintf(stdout, "*** couldn't touch %s: %s",
1005 file, strerror(errno));
1013 *-----------------------------------------------------------------------
1014 * Job_CheckCommands --
1015 * Make sure the given node has all the commands it needs.
1018 * TRUE if the commands list is/was ok.
1021 * The node will have commands from the .DEFAULT rule added to it
1023 *-----------------------------------------------------------------------
1026 Job_CheckCommands(GNode *gn, void (*abortProc)(const char *, ...))
1029 if (OP_NOP(gn->type) && Lst_IsEmpty(&gn->commands) &&
1030 (gn->type & OP_LIB) == 0) {
1032 * No commands. Look for .DEFAULT rule from which we might infer
1035 if ((DEFAULT != NULL) && !Lst_IsEmpty(&DEFAULT->commands)) {
1038 * Make only looks for a .DEFAULT if the node was never the
1039 * target of an operator, so that's what we do too. If
1040 * a .DEFAULT was given, we substitute its commands for gn's
1041 * commands and set the IMPSRC variable to be the target's name
1042 * The DEFAULT node acts like a transformation rule, in that
1043 * gn also inherits any attributes or sources attached to
1046 Make_HandleUse(DEFAULT, gn);
1047 Var_Set(IMPSRC, Var_Value(TARGET, gn, &p1), gn);
1049 } else if (Dir_MTime(gn) == 0) {
1051 * The node wasn't the target of an operator we have no .DEFAULT
1052 * rule to go on and the target doesn't already exist. There's
1053 * nothing more we can do for this branch. If the -k flag wasn't
1054 * given, we stop in our tracks, otherwise we just don't update
1055 * this node's parents so they never get examined.
1057 static const char msg[] = "make: don't know how to make";
1059 if (gn->type & OP_OPTIONAL) {
1060 fprintf(stdout, "%s %s(ignored)\n", msg, gn->name);
1062 } else if (keepgoing) {
1063 fprintf(stdout, "%s %s(continuing)\n", msg, gn->name);
1068 if (strcmp(gn->name,"love") == 0)
1069 (*abortProc)("Not war.");
1072 (*abortProc)("%s %s. Stop", msg, gn->name);
1081 *-----------------------------------------------------------------------
1083 * Execute the shell for the given job. Called from JobStart and
1090 * A shell is executed, outputs is altered and the Job structure added
1093 *-----------------------------------------------------------------------
1096 JobExec(Job *job, char **argv)
1098 int cpid; /* ID of new child */
1103 DEBUGF(JOB, ("Running %s\n", job->node->name));
1104 DEBUGF(JOB, ("\tCommand: "));
1105 for (i = 0; argv[i] != NULL; i++) {
1106 DEBUGF(JOB, ("%s ", argv[i]));
1108 DEBUGF(JOB, ("\n"));
1112 * Some jobs produce no output and it's disconcerting to have
1113 * no feedback of their running (since they produce no output, the
1114 * banner with their name in it never appears). This is an attempt to
1115 * provide that feedback, even if nothing follows it.
1117 if ((lastNode != job->node) && (job->flags & JOB_FIRST) &&
1118 !(job->flags & JOB_SILENT)) {
1119 MESSAGE(stdout, job->node);
1120 lastNode = job->node;
1123 if ((cpid = vfork()) == -1) {
1124 Punt("Cannot fork");
1125 } else if (cpid == 0) {
1130 * Must duplicate the input stream down to the child's input and
1131 * reset it to the beginning (again). Since the stream was marked
1132 * close-on-exec, we must clear that bit in the new input.
1134 if (dup2(FILENO(job->cmdFILE), 0) == -1)
1135 Punt("Cannot dup2: %s", strerror(errno));
1136 fcntl(0, F_SETFD, 0);
1137 lseek(0, (off_t)0, SEEK_SET);
1141 * Set up the child's output to be routed through the pipe
1142 * we've created for it.
1144 if (dup2(job->outPipe, 1) == -1)
1145 Punt("Cannot dup2: %s", strerror(errno));
1148 * We're capturing output in a file, so we duplicate the
1149 * descriptor to the temporary file into the standard
1152 if (dup2(job->outFd, 1) == -1)
1153 Punt("Cannot dup2: %s", strerror(errno));
1156 * The output channels are marked close on exec. This bit was
1157 * duplicated by the dup2 (on some systems), so we have to clear
1158 * it before routing the shell's error output to the same place as
1159 * its standard output.
1161 fcntl(1, F_SETFD, 0);
1162 if (dup2(1, 2) == -1)
1163 Punt("Cannot dup2: %s", strerror(errno));
1167 * We want to switch the child into a different process family so
1168 * we can kill it and all its descendants in one fell swoop,
1169 * by killing its process family, but not commit suicide.
1174 setpgid(0, getpid());
1176 #endif /* USE_PGRP */
1178 execv(shellPath, argv);
1180 write(STDERR_FILENO, "Could not execute shell\n",
1181 sizeof("Could not execute shell"));
1186 if (usePipes && (job->flags & JOB_FIRST) ) {
1188 * The first time a job is run for a node, we set the current
1189 * position in the buffer to the beginning and mark another
1190 * stream to watch in the outputs mask
1193 struct kevent kev[2];
1197 #if defined(USE_KQUEUE)
1198 EV_SET(&kev[0], job->inPipe, EVFILT_READ, EV_ADD, 0, 0, job);
1199 EV_SET(&kev[1], job->pid, EVFILT_PROC, EV_ADD | EV_ONESHOT,
1200 NOTE_EXIT, 0, NULL);
1201 if (kevent(kqfd, kev, 2, NULL, 0, NULL) != 0) {
1202 /* kevent() will fail if the job is already finished */
1203 if (errno != EINTR && errno != EBADF && errno != ESRCH)
1204 Punt("kevent: %s", strerror(errno));
1207 FD_SET(job->inPipe, &outputs);
1208 #endif /* USE_KQUEUE */
1211 if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
1212 fclose(job->cmdFILE);
1213 job->cmdFILE = NULL;
1218 * Now the job is actually running, add it to the table.
1221 Lst_AtEnd(&jobs, job);
1222 if (nJobs == maxJobs) {
1228 *-----------------------------------------------------------------------
1230 * Create the argv needed to execute the shell for a given job.
1237 *-----------------------------------------------------------------------
1240 JobMakeArgv(Job *job, char **argv)
1243 static char args[10]; /* For merged arguments */
1245 argv[0] = shellName;
1248 if ((commandShell->exit && (*commandShell->exit != '-')) ||
1249 (commandShell->echo && (*commandShell->echo != '-')))
1252 * At least one of the flags doesn't have a minus before it, so
1253 * merge them together. Have to do this because the *(&(@*#*&#$#
1254 * Bourne shell thinks its second argument is a file to source.
1255 * Grrrr. Note the ten-character limitation on the combined arguments.
1257 sprintf(args, "-%s%s",
1258 ((job->flags & JOB_IGNERR) ? "" :
1259 (commandShell->exit ? commandShell->exit : "")),
1260 ((job->flags & JOB_SILENT) ? "" :
1261 (commandShell->echo ? commandShell->echo : "")));
1268 if (!(job->flags & JOB_IGNERR) && commandShell->exit) {
1269 argv[argc] = commandShell->exit;
1272 if (!(job->flags & JOB_SILENT) && commandShell->echo) {
1273 argv[argc] = commandShell->echo;
1281 *-----------------------------------------------------------------------
1283 * Restart a job that stopped for some reason.
1289 * jobFull will be set if the job couldn't be run.
1291 *-----------------------------------------------------------------------
1294 JobRestart(Job *job)
1297 if (job->flags & JOB_RESTART) {
1299 * Set up the control arguments to the shell. This is based on the
1300 * flags set earlier for this job. If the JOB_IGNERR flag is clear,
1301 * the 'exit' flag of the commandShell is used to cause it to exit
1302 * upon receiving an error. If the JOB_SILENT flag is clear, the
1303 * 'echo' flag of the commandShell is used to get it to start echoing
1304 * as soon as it starts processing commands.
1308 JobMakeArgv(job, argv);
1310 DEBUGF(JOB, ("Restarting %s...", job->node->name));
1311 if (((nJobs >= maxJobs) && !(job->flags & JOB_SPECIAL))) {
1313 * Can't be exported and not allowed to run locally -- put it
1314 * back on the hold queue and mark the table full
1316 DEBUGF(JOB, ("holding\n"));
1317 Lst_AtFront(&stoppedJobs, (void *)job);
1319 DEBUGF(JOB, ("Job queue is full.\n"));
1323 * Job may be run locally.
1325 DEBUGF(JOB, ("running locally\n"));
1330 * The job has stopped and needs to be restarted. Why it stopped,
1333 DEBUGF(JOB, ("Resuming %s...", job->node->name));
1334 if (((nJobs < maxJobs) ||
1335 ((job->flags & JOB_SPECIAL) &&
1340 * If we haven't reached the concurrency limit already (or the
1341 * job must be run and maxJobs is 0), it's ok to resume it.
1346 error = (KILL(job->pid, SIGCONT) != 0);
1350 * Make sure the user knows we've continued the beast and
1351 * actually put the thing in the job table.
1353 job->flags |= JOB_CONTINUING;
1355 W_SETTERMSIG(&status, SIGCONT);
1356 JobFinish(job, &status);
1358 job->flags &= ~(JOB_RESUME|JOB_CONTINUING);
1359 DEBUGF(JOB, ("done\n"));
1361 Error("couldn't resume %s: %s",
1362 job->node->name, strerror(errno));
1364 W_SETEXITSTATUS(&status, 1);
1365 JobFinish(job, &status);
1369 * Job cannot be restarted. Mark the table as full and
1370 * place the job back on the list of stopped jobs.
1372 DEBUGF(JOB, ("table full\n"));
1373 Lst_AtFront(&stoppedJobs, (void *)job);
1375 DEBUGF(JOB, ("Job queue is full.\n"));
1381 *-----------------------------------------------------------------------
1383 * Start a target-creation process going for the target described
1384 * by the graph node gn.
1387 * JOB_ERROR if there was an error in the commands, JOB_FINISHED
1388 * if there isn't actually anything left to do for the job and
1389 * JOB_RUNNING if the job has been started.
1392 * A new Job node is created and added to the list of running
1393 * jobs. PMake is forked and a child shell created.
1394 *-----------------------------------------------------------------------
1397 JobStart(GNode *gn, int flags, Job *previous)
1399 Job *job; /* new job descriptor */
1400 char *argv[4]; /* Argument vector to shell */
1401 Boolean cmdsOK; /* true if the nodes commands were all right */
1402 Boolean noExec; /* Set true if we decide not to run the job */
1403 int tfd; /* File descriptor for temp file */
1406 JobPassSig(interrupted);
1409 if (previous != NULL) {
1410 previous->flags &= ~(JOB_FIRST|JOB_IGNERR|JOB_SILENT);
1413 job = emalloc(sizeof(Job));
1418 job->tailCmds = NULL;
1421 * Set the initial value of the flags for this job based on the global
1422 * ones and the node's attributes... Any flags supplied by the caller
1423 * are also added to the field.
1426 if (Targ_Ignore(gn)) {
1427 job->flags |= JOB_IGNERR;
1429 if (Targ_Silent(gn)) {
1430 job->flags |= JOB_SILENT;
1432 job->flags |= flags;
1435 * Check the commands now so any attributes from .DEFAULT have a chance
1436 * to migrate to the node
1438 if (!compatMake && job->flags & JOB_FIRST) {
1439 cmdsOK = Job_CheckCommands(gn, Error);
1445 * If the -n flag wasn't given, we open up OUR (not the child's)
1446 * temporary file to stuff commands in it. The thing is rd/wr so we don't
1447 * need to reopen it to feed it to the shell. If the -n flag *was* given,
1448 * we just set the file to be stdout. Cute, huh?
1450 if ((gn->type & OP_MAKE) || (!noExecute && !touchFlag)) {
1452 * We're serious here, but if the commands were bogus, we're
1459 strcpy(tfile, TMPPAT);
1460 if ((tfd = mkstemp(tfile)) == -1)
1461 Punt("Cannot create temp file: %s", strerror(errno));
1462 job->cmdFILE = fdopen(tfd, "w+");
1464 if (job->cmdFILE == NULL) {
1466 Punt("Could not open %s", tfile);
1468 fcntl(FILENO(job->cmdFILE), F_SETFD, 1);
1470 * Send the commands to the command file, flush all its buffers then
1471 * rewind and remove the thing.
1476 * used to be backwards; replace when start doing multiple commands
1481 * Be compatible: If this is the first time for this node,
1482 * verify its commands are ok and open the commands list for
1483 * sequential access by later invocations of JobStart.
1484 * Once that is done, we take the next command off the list
1485 * and print it to the command file. If the command was an
1486 * ellipsis, note that there's nothing more to execute.
1488 if (job->flags & JOB_FIRST)
1489 gn->compat_command = Lst_First(&gn->commands);
1491 gn->compat_command = Lst_Succ(gn->compat_command);
1493 if (gn->compat_command == NULL ||
1494 JobPrintCommand(Lst_Datum(gn->compat_command), job))
1497 if (noExec && !(job->flags & JOB_FIRST)) {
1499 * If we're not going to execute anything, the job
1500 * is done and we need to close down the various
1501 * file descriptors we've opened for output, then
1502 * call JobDoOutput to catch the final characters or
1503 * send the file to the screen... Note that the i/o streams
1504 * are only open if this isn't the first job.
1505 * Note also that this could not be done in
1506 * Job_CatchChildren b/c it wasn't clear if there were
1507 * more commands to execute or not...
1513 * We can do all the commands at once. hooray for sanity
1516 Lst_ForEach(&gn->commands, JobPrintCommand, job);
1519 * If we didn't print out any commands to the shell script,
1520 * there's not much point in executing the shell, is there?
1522 if (numCommands == 0) {
1526 } else if (noExecute) {
1528 * Not executing anything -- just print all the commands to stdout
1529 * in one fell swoop. This will still set up job->tailCmds correctly.
1531 if (lastNode != gn) {
1532 MESSAGE(stdout, gn);
1535 job->cmdFILE = stdout;
1537 * Only print the commands if they're ok, but don't die if they're
1538 * not -- just let the user know they're bad and keep going. It
1539 * doesn't do any harm in this case and may do some good.
1542 Lst_ForEach(&gn->commands, JobPrintCommand, job);
1545 * Don't execute the shell, thank you.
1550 * Just touch the target and note that no shell should be executed.
1551 * Set cmdFILE to stdout to make life easier. Check the commands, too,
1552 * but don't die if they're no good -- it does no harm to keep working
1555 job->cmdFILE = stdout;
1556 Job_Touch(gn, job->flags & JOB_SILENT);
1561 * If we're not supposed to execute a shell, don't.
1565 * Unlink and close the command file if we opened one
1567 if (job->cmdFILE != stdout) {
1568 if (job->cmdFILE != NULL)
1569 fclose(job->cmdFILE);
1575 * We only want to work our way up the graph if we aren't here because
1576 * the commands for the job were no good.
1579 if (aborting == 0) {
1580 if (job->tailCmds != NULL) {
1581 Lst_ForEachFrom(&job->node->commands, job->tailCmds,
1582 JobSaveCommand, job->node);
1584 job->node->made = MADE;
1585 Make_Update(job->node);
1588 return(JOB_FINISHED);
1594 fflush(job->cmdFILE);
1598 * Set up the control arguments to the shell. This is based on the flags
1599 * set earlier for this job.
1601 JobMakeArgv(job, argv);
1604 * If we're using pipes to catch output, create the pipe by which we'll
1605 * get the shell's output. If we're using files, print out that we're
1606 * starting a job and then set up its temporary-file name.
1608 if (!compatMake || (job->flags & JOB_FIRST)) {
1613 Punt("Cannot create pipe: %s", strerror(errno));
1614 job->inPipe = fd[0];
1615 job->outPipe = fd[1];
1616 fcntl(job->inPipe, F_SETFD, 1);
1617 fcntl(job->outPipe, F_SETFD, 1);
1619 fprintf(stdout, "Remaking `%s'\n", gn->name);
1621 strcpy(job->outFile, TMPPAT);
1622 if ((job->outFd = mkstemp(job->outFile)) == -1)
1623 Punt("cannot create temp file: %s", strerror(errno));
1624 fcntl(job->outFd, F_SETFD, 1);
1628 if ((nJobs >= maxJobs) && !(job->flags & JOB_SPECIAL) && (maxJobs != 0)) {
1630 * We've hit the limit of concurrency, so put the job on hold until
1631 * some other job finishes. Note that the special jobs (.BEGIN,
1632 * .INTERRUPT and .END) may be run even when the limit has been reached
1633 * (e.g. when maxJobs == 0).
1637 DEBUGF(JOB, ("Can only run job locally.\n"));
1638 job->flags |= JOB_RESTART;
1639 Lst_AtEnd(&stoppedJobs, job);
1641 if (nJobs >= maxJobs) {
1643 * If we're running this job locally as a special case (see above),
1644 * at least say the table is full.
1647 DEBUGF(JOB, ("Local job queue is full.\n"));
1651 return (JOB_RUNNING);
1655 JobOutput(Job *job, char *cp, char *endp, int msg)
1659 if (commandShell->noPrint) {
1660 ecp = strstr(cp, commandShell->noPrint);
1661 while (ecp != NULL) {
1664 if (msg && job->node != lastNode) {
1665 MESSAGE(stdout, job->node);
1666 lastNode = job->node;
1669 * The only way there wouldn't be a newline after
1670 * this line is if it were the last in the buffer.
1671 * however, since the non-printable comes after it,
1672 * there must be a newline, so we don't print one.
1674 fprintf(stdout, "%s", cp);
1677 cp = ecp + commandShell->noPLen;
1680 * Still more to print, look again after skipping
1681 * the whitespace following the non-printable
1685 while (*cp == ' ' || *cp == '\t' || *cp == '\n') {
1688 ecp = strstr(cp, commandShell->noPrint);
1698 *-----------------------------------------------------------------------
1700 * This function is called at different times depending on
1701 * whether the user has specified that output is to be collected
1702 * via pipes or temporary files. In the former case, we are called
1703 * whenever there is something to read on the pipe. We collect more
1704 * output from the given job and store it in the job's outBuf. If
1705 * this makes up a line, we print it tagged by the job's identifier,
1707 * If output has been collected in a temporary file, we open the
1708 * file and read it line by line, transfering it to our own
1709 * output channel until the file is empty. At which point we
1710 * remove the temporary file.
1711 * In both cases, however, we keep our figurative eye out for the
1712 * 'noPrint' line for the shell from which the output came. If
1713 * we recognize a line, we don't print it. If the command is not
1714 * alone on the line (the character after it is not \0 or \n), we
1715 * do print whatever follows it.
1721 * curPos may be shifted as may the contents of outBuf.
1722 *-----------------------------------------------------------------------
1725 JobDoOutput(Job *job, Boolean finish)
1727 Boolean gotNL = FALSE; /* true if got a newline */
1728 Boolean fbuf; /* true if our buffer filled up */
1729 int nr; /* number of bytes read */
1730 int i; /* auxiliary index into outBuf */
1731 int max; /* limit for i (end of current data) */
1732 int nRead; /* (Temporary) number of bytes read */
1734 FILE *oFILE; /* Stream pointer to shell's output file */
1739 * Read as many bytes as will fit in the buffer.
1745 nRead = read(job->inPipe, &job->outBuf[job->curPos],
1746 JOB_BUFSIZE - job->curPos);
1748 * Check for interrupt here too, because the above read may block
1749 * when the child process is stopped. In this case the interrupt
1750 * will unblock it (we don't use SA_RESTART).
1753 JobPassSig(interrupted);
1756 DEBUGF(JOB, ("JobDoOutput(piperead)"));
1763 * If we hit the end-of-file (the job is dead), we must flush its
1764 * remaining output, so pretend we read a newline if there's any
1765 * output remaining in the buffer.
1766 * Also clear the 'finish' flag so we stop looping.
1768 if ((nr == 0) && (job->curPos != 0)) {
1769 job->outBuf[job->curPos] = '\n';
1772 } else if (nr == 0) {
1777 * Look for the last newline in the bytes we just got. If there is
1778 * one, break out of the loop with 'i' as its index and gotNL set
1781 max = job->curPos + nr;
1782 for (i = job->curPos + nr - 1; i >= job->curPos; i--) {
1783 if (job->outBuf[i] == '\n') {
1786 } else if (job->outBuf[i] == '\0') {
1790 job->outBuf[i] = ' ';
1796 if (job->curPos == JOB_BUFSIZE) {
1798 * If we've run out of buffer space, we have no choice
1799 * but to print the stuff. sigh.
1805 if (gotNL || fbuf) {
1807 * Need to send the output to the screen. Null terminate it
1808 * first, overwriting the newline character if there was one.
1809 * So long as the line isn't one we should filter (according
1810 * to the shell description), we print the line, preceded
1811 * by a target banner if this target isn't the same as the
1812 * one for which we last printed something.
1813 * The rest of the data in the buffer are then shifted down
1814 * to the start of the buffer and curPos is set accordingly.
1816 job->outBuf[i] = '\0';
1817 if (i >= job->curPos) {
1820 cp = JobOutput(job, job->outBuf, &job->outBuf[i], FALSE);
1823 * There's still more in that thar buffer. This time, though,
1824 * we know there's no newline at the end, so we add one of
1825 * our own free will.
1828 if (job->node != lastNode) {
1829 MESSAGE(stdout, job->node);
1830 lastNode = job->node;
1832 fprintf(stdout, "%s%s", cp, gotNL ? "\n" : "");
1837 /* shift the remaining characters down */
1838 memcpy(job->outBuf, &job->outBuf[i + 1], max - (i + 1));
1839 job->curPos = max - (i + 1);
1843 * We have written everything out, so we just start over
1844 * from the start of the buffer. No copying. No nothing.
1851 * If the finish flag is true, we must loop until we hit
1852 * end-of-file on the pipe. This is guaranteed to happen
1853 * eventually since the other end of the pipe is now closed
1854 * (we closed it explicitly and the child has exited). When
1855 * we do get an EOF, finish will be set FALSE and we'll fall
1862 * We've been called to retrieve the output of the job from the
1863 * temporary file where it's been squirreled away. This consists of
1864 * opening the file, reading the output line by line, being sure not
1865 * to print the noPrint line for the shell we used, then close and
1866 * remove the temporary file. Very simple.
1868 * Change to read in blocks and do FindSubString type things as for
1869 * pipes? That would allow for "@echo -n..."
1871 oFILE = fopen(job->outFile, "r");
1872 if (oFILE != NULL) {
1873 fprintf(stdout, "Results of making %s:\n", job->node->name);
1875 while (fgets(inLine, sizeof(inLine), oFILE) != NULL) {
1876 char *cp, *endp, *oendp;
1879 oendp = endp = inLine + strlen(inLine);
1880 if (endp[-1] == '\n') {
1883 cp = JobOutput(job, inLine, endp, FALSE);
1886 * There's still more in that thar buffer. This time, though,
1887 * we know there's no newline at the end, so we add one of
1888 * our own free will.
1890 fprintf(stdout, "%s", cp);
1892 if (endp != oendp) {
1893 fprintf(stdout, "\n");
1898 eunlink(job->outFile);
1904 *-----------------------------------------------------------------------
1905 * Job_CatchChildren --
1906 * Handle the exit of a child. Called from Make_Make.
1912 * The job descriptor is removed from the list of children.
1915 * We do waits, blocking or not, according to the wisdom of our
1916 * caller, until there are no more children to report. For each
1917 * job, call JobFinish to finish things off. This will take care of
1918 * putting jobs on the stoppedJobs queue.
1920 *-----------------------------------------------------------------------
1923 Job_CatchChildren(Boolean block)
1925 int pid; /* pid of dead child */
1926 Job *job; /* job descriptor for dead child */
1927 LstNode *jnode; /* list element for finding job */
1928 int status; /* Exit/termination status */
1931 * Don't even bother if we know there's no one around.
1938 pid = waitpid((pid_t)-1, &status, (block ? 0 : WNOHANG) | WUNTRACED);
1941 DEBUGF(JOB, ("Process %d exited or stopped.\n", pid));
1943 jnode = Lst_Find(&jobs, &pid, JobCmpPid);
1945 if (jnode == NULL) {
1946 if (WIFSIGNALED(status) && (WTERMSIG(status) == SIGCONT)) {
1947 jnode = Lst_Find(&stoppedJobs, &pid, JobCmpPid);
1948 if (jnode == NULL) {
1949 Error("Resumed child (%d) not in table", pid);
1952 job = Lst_Datum(jnode);
1953 Lst_Remove(&stoppedJobs, jnode);
1955 Error("Child (%d) not in table?", pid);
1959 job = Lst_Datum(jnode);
1960 Lst_Remove(&jobs, jnode);
1962 if (fifoFd >= 0 && maxJobs > 1) {
1963 write(fifoFd, "+", 1);
1965 if (nJobs >= maxJobs)
1970 DEBUGF(JOB, ("Job queue is no longer full.\n"));
1975 JobFinish(job, &status);
1978 JobPassSig(interrupted);
1982 *-----------------------------------------------------------------------
1983 * Job_CatchOutput --
1984 * Catch the output from our children, if we're using
1985 * pipes do so. Otherwise just block time until we get a
1986 * signal(most likely a SIGCHLD) since there's no point in
1987 * just spinning when there's nothing to do and the reaping
1988 * of a child can wait for a while.
1994 * Output is read from pipes if we're piping.
1995 * -----------------------------------------------------------------------
1999 Job_CatchOutput(int flag __unused)
2001 Job_CatchOutput(int flag)
2007 struct kevent kev[KEV_SIZE];
2010 struct timeval timeout;
2020 if ((nfds = kevent(kqfd, NULL, 0, kev, KEV_SIZE, NULL)) == -1) {
2022 Punt("kevent: %s", strerror(errno));
2024 JobPassSig(interrupted);
2026 for (i = 0; i < nfds; i++) {
2027 if (kev[i].flags & EV_ERROR) {
2028 warnc(kev[i].data, "kevent");
2031 switch (kev[i].filter) {
2033 JobDoOutput(kev[i].udata, FALSE);
2036 /* Just wake up and let Job_CatchChildren() collect the
2037 * terminated job. */
2044 timeout.tv_sec = SEL_SEC;
2045 timeout.tv_usec = SEL_USEC;
2046 if (flag && jobFull && fifoFd >= 0)
2047 FD_SET(fifoFd, &readfds);
2049 nfds = select(FD_SETSIZE, &readfds, (fd_set *)NULL,
2050 (fd_set *)NULL, &timeout);
2053 JobPassSig(interrupted);
2056 if (fifoFd >= 0 && FD_ISSET(fifoFd, &readfds)) {
2060 for (ln = Lst_First(&jobs); nfds != 0 && ln != NULL; ln = Lst_Succ(ln)){
2061 job = Lst_Datum(ln);
2062 if (FD_ISSET(job->inPipe, &readfds)) {
2063 JobDoOutput(job, FALSE);
2067 #endif /* !USE_KQUEUE */
2072 *-----------------------------------------------------------------------
2074 * Start the creation of a target. Basically a front-end for
2075 * JobStart used by the Make module.
2081 * Another job is started.
2083 *-----------------------------------------------------------------------
2089 JobStart(gn, 0, NULL);
2095 * Make a new copy of the shell structure including a copy of the strings
2096 * in it. This also defaults some fields in case they are NULL.
2098 * The function returns a pointer to the new shell structure otherwise.
2101 JobCopyShell(const Shell *osh)
2105 nsh = emalloc(sizeof(*nsh));
2106 nsh->name = estrdup(osh->name);
2108 if (osh->echoOff != NULL)
2109 nsh->echoOff = estrdup(osh->echoOff);
2111 nsh->echoOff = NULL;
2112 if (osh->echoOn != NULL)
2113 nsh->echoOn = estrdup(osh->echoOn);
2116 nsh->hasEchoCtl = osh->hasEchoCtl;
2118 if (osh->noPrint != NULL)
2119 nsh->noPrint = estrdup(osh->noPrint);
2121 nsh->noPrint = NULL;
2122 nsh->noPLen = osh->noPLen;
2124 nsh->hasErrCtl = osh->hasErrCtl;
2125 if (osh->errCheck == NULL)
2126 nsh->errCheck = estrdup("");
2128 nsh->errCheck = estrdup(osh->errCheck);
2129 if (osh->ignErr == NULL)
2130 nsh->ignErr = estrdup("%s");
2132 nsh->ignErr = estrdup(osh->ignErr);
2134 if (osh->echo == NULL)
2135 nsh->echo = estrdup("");
2137 nsh->echo = estrdup(osh->echo);
2139 if (osh->exit == NULL)
2140 nsh->exit = estrdup("");
2142 nsh->exit = estrdup(osh->exit);
2150 * Free a shell structure and all associated strings.
2153 JobFreeShell(Shell *sh)
2173 if (commandShell == NULL)
2174 commandShell = JobMatchShell(shells[DEFSHELL].name);
2176 if (shellPath == NULL) {
2178 * The user didn't specify a shell to use, so we are using the
2179 * default one... Both the absolute path and the last component
2180 * must be set. The last component is taken from the 'name' field
2181 * of the default shell description pointed-to by commandShell.
2182 * All default shells are located in _PATH_DEFSHELLDIR.
2184 shellName = commandShell->name;
2185 shellPath = str_concat(_PATH_DEFSHELLDIR, shellName, STR_ADDSLASH);
2190 *-----------------------------------------------------------------------
2192 * Initialize the process module, given a maximum number of jobs.
2198 * lists and counters are initialized
2199 *-----------------------------------------------------------------------
2202 Job_Init(int maxproc)
2204 GNode *begin; /* node for commands to do at the very start */
2206 struct sigaction sa;
2209 env = getenv("MAKE_JOBS_FIFO");
2211 if (env == NULL && maxproc > 1) {
2213 * We did not find the environment variable so we are the leader.
2214 * Create the fifo, open it, write one char per allowed job into
2218 if (!mkfifo(fifoName, 0600)) {
2219 fifoFd = open(fifoName, O_RDWR | O_NONBLOCK, 0);
2222 fcntl(fifoFd, F_SETFL, O_NONBLOCK);
2224 setenv("MAKE_JOBS_FIFO", env, 1);
2225 while (maxproc-- > 0) {
2226 write(fifoFd, "+", 1);
2228 /* The master make does not get a magic token */
2236 } else if (env != NULL) {
2238 * We had the environment variable so we are a slave.
2239 * Open fifo and give ourselves a magic token which represents
2240 * the token our parent make has grabbed to start his make process.
2241 * Otherwise the sub-makes would gobble up tokens and the proper
2242 * number of tokens to specify to -j would depend on the depth of
2243 * the tree and the order of execution.
2245 fifoFd = open(env, O_RDWR, 0);
2247 fcntl(fifoFd, F_SETFL, O_NONBLOCK);
2264 if ((maxJobs == 1 && fifoFd < 0) || beVerbose == 0) {
2266 * If only one job can run at a time, there's no need for a banner,
2277 * Catch the four signals that POSIX specifies if they aren't ignored.
2278 * JobCatchSignal will just set global variables and hope someone
2279 * else is going to handle the interrupt.
2281 sa.sa_handler = JobCatchSig;
2282 sigemptyset(&sa.sa_mask);
2285 if (signal(SIGINT, SIG_IGN) != SIG_IGN) {
2286 sigaction(SIGINT, &sa, NULL);
2288 if (signal(SIGHUP, SIG_IGN) != SIG_IGN) {
2289 sigaction(SIGHUP, &sa, NULL);
2291 if (signal(SIGQUIT, SIG_IGN) != SIG_IGN) {
2292 sigaction(SIGQUIT, &sa, NULL);
2294 if (signal(SIGTERM, SIG_IGN) != SIG_IGN) {
2295 sigaction(SIGTERM, &sa, NULL);
2298 * There are additional signals that need to be caught and passed if
2299 * either the export system wants to be told directly of signals or if
2300 * we're giving each job its own process group (since then it won't get
2301 * signals from the terminal driver as we own the terminal)
2303 #if defined(USE_PGRP)
2304 if (signal(SIGTSTP, SIG_IGN) != SIG_IGN) {
2305 sigaction(SIGTSTP, &sa, NULL);
2307 if (signal(SIGTTOU, SIG_IGN) != SIG_IGN) {
2308 sigaction(SIGTTOU, &sa, NULL);
2310 if (signal(SIGTTIN, SIG_IGN) != SIG_IGN) {
2311 sigaction(SIGTTIN, &sa, NULL);
2313 if (signal(SIGWINCH, SIG_IGN) != SIG_IGN) {
2314 sigaction(SIGWINCH, &sa, NULL);
2319 if ((kqfd = kqueue()) == -1) {
2320 Punt("kqueue: %s", strerror(errno));
2324 begin = Targ_FindNode(".BEGIN", TARG_NOCREATE);
2326 if (begin != NULL) {
2327 JobStart(begin, JOB_SPECIAL, (Job *)NULL);
2330 Job_CatchChildren(!usePipes);
2333 postCommands = Targ_FindNode(".END", TARG_CREATE);
2337 *-----------------------------------------------------------------------
2339 * See if the job table is full. It is considered full if it is OR
2340 * if we are in the process of aborting OR if we have
2341 * reached/exceeded our local quota. This prevents any more jobs
2345 * TRUE if the job table is full, FALSE otherwise
2348 *-----------------------------------------------------------------------
2358 if (fifoFd >= 0 && jobFull) {
2359 i = read(fifoFd, &c, 1);
2369 *-----------------------------------------------------------------------
2371 * See if the job table is empty. Because the local concurrency may
2372 * be set to 0, it is possible for the job table to become empty,
2373 * while the list of stoppedJobs remains non-empty. In such a case,
2374 * we want to restart as many jobs as we can.
2377 * TRUE if it is. FALSE if it ain't.
2382 * -----------------------------------------------------------------------
2388 if (!Lst_IsEmpty(&stoppedJobs) && !aborting) {
2390 * The job table is obviously not full if it has no jobs in
2391 * it...Try and restart the stopped jobs.
2405 *-----------------------------------------------------------------------
2407 * Find a matching shell in 'shells' given its final component.
2410 * A pointer to a freshly allocated Shell structure with a copy
2411 * of the static structure or NULL if no shell with the given name
2417 *-----------------------------------------------------------------------
2420 JobMatchShell(const char *name)
2422 const struct CShell *sh; /* Pointer into shells table */
2425 for (sh = shells; sh < shells + __arysize(shells); sh++)
2426 if (strcmp(sh->name, name) == 0)
2429 if (sh == shells + __arysize(shells))
2433 nsh = emalloc(sizeof(*nsh));
2435 nsh->name = estrdup(sh->name);
2436 nsh->echoOff = estrdup(sh->echoOff);
2437 nsh->echoOn = estrdup(sh->echoOn);
2438 nsh->hasEchoCtl = sh->hasEchoCtl;
2439 nsh->noPrint = estrdup(sh->noPrint);
2440 nsh->noPLen = sh->noPLen;
2441 nsh->hasErrCtl = sh->hasErrCtl;
2442 nsh->errCheck = estrdup(sh->errCheck);
2443 nsh->ignErr = estrdup(sh->ignErr);
2444 nsh->echo = estrdup(sh->echo);
2445 nsh->exit = estrdup(sh->exit);
2451 *-----------------------------------------------------------------------
2453 * Parse a shell specification and set up commandShell, shellPath
2454 * and shellName appropriately.
2457 * FAILURE if the specification was incorrect.
2460 * commandShell points to a Shell structure (either predefined or
2461 * created from the shell spec), shellPath is the full path of the
2462 * shell described by commandShell, while shellName is just the
2463 * final component of shellPath.
2466 * A shell specification consists of a .SHELL target, with dependency
2467 * operator, followed by a series of blank-separated words. Double
2468 * quotes can be used to use blanks in words. A backslash escapes
2469 * anything (most notably a double-quote and a space) and
2470 * provides the functionality it does in C. Each word consists of
2471 * keyword and value separated by an equal sign. There should be no
2472 * unnecessary spaces in the word. The keywords are as follows:
2473 * name Name of shell.
2474 * path Location of shell. Overrides "name" if given
2475 * quiet Command to turn off echoing.
2476 * echo Command to turn echoing on
2477 * filter Result of turning off echoing that shouldn't be
2479 * echoFlag Flag to turn echoing on at the start
2480 * errFlag Flag to turn error checking on at the start
2481 * hasErrCtl True if shell has error checking control
2482 * check Command to turn on error checking if hasErrCtl
2483 * is TRUE or template of command to echo a command
2484 * for which error checking is off if hasErrCtl is
2486 * ignore Command to turn off error checking if hasErrCtl
2487 * is TRUE or template of command to execute a
2488 * command so as to ignore any errors it returns if
2489 * hasErrCtl is FALSE.
2491 *-----------------------------------------------------------------------
2494 Job_ParseShell(char *line)
2503 Boolean fullSpec = FALSE;
2505 while (isspace((unsigned char)*line)) {
2508 words = brk_string(line, &wordCount, TRUE);
2510 memset(&newShell, 0, sizeof(newShell));
2513 * Parse the specification by keyword
2515 for (path = NULL, argc = wordCount - 1, argv = words + 1;
2518 if (strncmp(*argv, "path=", 5) == 0) {
2520 } else if (strncmp(*argv, "name=", 5) == 0) {
2521 newShell.name = &argv[0][5];
2523 if (strncmp(*argv, "quiet=", 6) == 0) {
2524 newShell.echoOff = &argv[0][6];
2525 } else if (strncmp(*argv, "echo=", 5) == 0) {
2526 newShell.echoOn = &argv[0][5];
2527 } else if (strncmp(*argv, "filter=", 7) == 0) {
2528 newShell.noPrint = &argv[0][7];
2529 newShell.noPLen = strlen(newShell.noPrint);
2530 } else if (strncmp(*argv, "echoFlag=", 9) == 0) {
2531 newShell.echo = &argv[0][9];
2532 } else if (strncmp(*argv, "errFlag=", 8) == 0) {
2533 newShell.exit = &argv[0][8];
2534 } else if (strncmp(*argv, "hasErrCtl=", 10) == 0) {
2535 char c = argv[0][10];
2536 newShell.hasErrCtl = !((c != 'Y') && (c != 'y') &&
2537 (c != 'T') && (c != 't'));
2538 } else if (strncmp(*argv, "check=", 6) == 0) {
2539 newShell.errCheck = &argv[0][6];
2540 } else if (strncmp(*argv, "ignore=", 7) == 0) {
2541 newShell.ignErr = &argv[0][7];
2543 Parse_Error(PARSE_FATAL, "Unknown keyword \"%s\"",
2552 * Some checks (could be more)
2555 if ((newShell.echoOn != NULL) ^ (newShell.echoOff != NULL))
2556 Parse_Error(PARSE_FATAL, "Shell must have either both echoOff and "
2557 "echoOn or none of them");
2559 if (newShell.echoOn != NULL && newShell.echoOff)
2560 newShell.hasEchoCtl = TRUE;
2565 * If no path was given, the user wants one of the pre-defined shells,
2566 * yes? So we find the one s/he wants with the help of JobMatchShell
2567 * and set things up the right way. shellPath will be set up by
2570 if (newShell.name == NULL) {
2571 Parse_Error(PARSE_FATAL, "Neither path nor name specified");
2574 if ((sh = JobMatchShell(newShell.name)) == NULL) {
2575 Parse_Error(PARSE_FATAL, "%s: no matching shell", newShell.name);
2581 * The user provided a path. If s/he gave nothing else (fullSpec is
2582 * FALSE), try and find a matching shell in the ones we know of.
2583 * Else we just take the specification at its word and copy it
2584 * to a new location. In either case, we need to record the
2585 * path the user gave for the shell.
2588 shellPath = estrdup(path);
2589 if (newShell.name == NULL) {
2590 /* get the base name as the name */
2591 path = strrchr(path, '/');
2597 newShell.name = path;
2601 if ((sh = JobMatchShell(newShell.name)) == NULL) {
2602 Parse_Error(PARSE_FATAL, "%s: no matching shell",
2607 sh = JobCopyShell(&newShell);
2611 /* set the new shell */
2612 JobFreeShell(commandShell);
2615 shellName = commandShell->name;
2621 *-----------------------------------------------------------------------
2623 * Handle the receipt of an interrupt.
2629 * All children are killed. Another job will be started if the
2630 * .INTERRUPT target was given.
2631 *-----------------------------------------------------------------------
2634 JobInterrupt(int runINTERRUPT, int signo)
2636 LstNode *ln; /* element in job table */
2637 Job *job; /* job descriptor in that element */
2638 GNode *interrupt; /* the node describing the .INTERRUPT target */
2640 aborting = ABORT_INTERRUPT;
2642 for (ln = Lst_First(&jobs); ln != NULL; ln = Lst_Succ(ln)) {
2643 job = Lst_Datum(ln);
2645 if (!Targ_Precious(job->node)) {
2646 char *file = (job->node->path == NULL ?
2649 if (!noExecute && eunlink(file) != -1) {
2650 Error("*** %s removed", file);
2654 DEBUGF(JOB, ("JobInterrupt passing signal to child %d.\n",
2656 KILL(job->pid, signo);
2660 if (runINTERRUPT && !touchFlag) {
2661 /* clear the interrupted flag because we would get an
2662 * infinite loop otherwise */
2665 interrupt = Targ_FindNode(".INTERRUPT", TARG_NOCREATE);
2666 if (interrupt != NULL) {
2667 ignoreErrors = FALSE;
2669 JobStart(interrupt, JOB_IGNDOTS, (Job *)NULL);
2672 Job_CatchChildren(!usePipes);
2679 *-----------------------------------------------------------------------
2681 * Do final processing such as the running of the commands
2682 * attached to the .END target.
2685 * Number of errors reported.
2686 *-----------------------------------------------------------------------
2692 if (postCommands != NULL && !Lst_IsEmpty(&postCommands->commands)) {
2694 Error("Errors reported so .END ignored");
2696 JobStart(postCommands, JOB_SPECIAL | JOB_IGNDOTS, NULL);
2700 Job_CatchChildren(!usePipes);
2714 *-----------------------------------------------------------------------
2716 * Waits for all running jobs to finish and returns. Sets 'aborting'
2717 * to ABORT_WAIT to prevent other jobs from starting.
2723 * Currently running jobs finish.
2725 *-----------------------------------------------------------------------
2731 aborting = ABORT_WAIT;
2732 while (nJobs != 0) {
2734 Job_CatchChildren(!usePipes);
2740 *-----------------------------------------------------------------------
2742 * Abort all currently running jobs without handling output or anything.
2743 * This function is to be called only in the event of a major
2744 * error. Most definitely NOT to be called from JobInterrupt.
2750 * All children are killed, not just the firstborn
2751 *-----------------------------------------------------------------------
2756 LstNode *ln; /* element in job table */
2757 Job *job; /* the job descriptor in that element */
2760 aborting = ABORT_ERROR;
2763 for (ln = Lst_First(&jobs); ln != NULL; ln = Lst_Succ(ln)) {
2764 job = Lst_Datum(ln);
2767 * kill the child process with increasingly drastic signals to make
2768 * darn sure it's dead.
2770 KILL(job->pid, SIGINT);
2771 KILL(job->pid, SIGKILL);
2776 * Catch as many children as want to report in at first, then give up
2778 while (waitpid((pid_t)-1, &foo, WNOHANG) > 0)
2783 *-----------------------------------------------------------------------
2785 * Tries to restart stopped jobs if there are slots available.
2786 * Note that this tries to restart them regardless of pending errors.
2787 * It's not good to leave stopped jobs lying around!
2793 * Resumes(and possibly migrates) jobs.
2795 *-----------------------------------------------------------------------
2798 JobRestartJobs(void)
2800 while (!jobFull && !Lst_IsEmpty(&stoppedJobs)) {
2801 DEBUGF(JOB, ("Job queue is not full. Restarting a stopped job.\n"));
2802 JobRestart(Lst_DeQueue(&stoppedJobs));