1 /* $NetBSD: job.c,v 1.227 2020/08/30 19:56:02 rillig Exp $ */
4 * Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
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. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * Copyright (c) 1988, 1989 by Adam de Boor
37 * Copyright (c) 1989 by Berkeley Softworks
38 * All rights reserved.
40 * This code is derived from software contributed to Berkeley by
43 * Redistribution and use in source and binary forms, with or without
44 * modification, are permitted provided that the following conditions
46 * 1. Redistributions of source code must retain the above copyright
47 * notice, this list of conditions and the following disclaimer.
48 * 2. Redistributions in binary form must reproduce the above copyright
49 * notice, this list of conditions and the following disclaimer in the
50 * documentation and/or other materials provided with the distribution.
51 * 3. All advertising materials mentioning features or use of this software
52 * must display the following acknowledgement:
53 * This product includes software developed by the University of
54 * California, Berkeley and its contributors.
55 * 4. Neither the name of the University nor the names of its contributors
56 * may be used to endorse or promote products derived from this software
57 * without specific prior written permission.
59 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
60 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
61 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
62 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
63 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
64 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
65 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
66 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
67 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
68 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
73 static char rcsid[] = "$NetBSD: job.c,v 1.227 2020/08/30 19:56:02 rillig Exp $";
75 #include <sys/cdefs.h>
78 static char sccsid[] = "@(#)job.c 8.2 (Berkeley) 3/19/94";
80 __RCSID("$NetBSD: job.c,v 1.227 2020/08/30 19:56:02 rillig Exp $");
87 * handle the creation etc. of our child processes.
90 * Job_Make Start the creation of the given target.
92 * Job_CatchChildren Check for and handle the termination of any
93 * children. This must be called reasonably
94 * frequently to keep the whole make going at
95 * a decent clip, since job table entries aren't
96 * removed until their process is caught this way.
98 * Job_CatchOutput Print any output our children have produced.
99 * Should also be called fairly frequently to
100 * keep the user informed of what's going on.
101 * If no output is waiting, it will block for
102 * a time given by the SEL_* constants, below,
103 * or until output is ready.
105 * Job_Init Called to initialize this module. in addition,
106 * any commands attached to the .BEGIN target
107 * are executed before this function returns.
108 * Hence, the makefile must have been parsed
109 * before this function is called.
111 * Job_End Cleanup any memory used.
113 * Job_ParseShell Given the line following a .SHELL target, parse
114 * the line as a shell specification. Returns
115 * FALSE if the spec was incorrect.
117 * Job_Finish Perform any final processing which needs doing.
118 * This includes the execution of any commands
119 * which have been/were attached to the .END
120 * target. It should only be called when the
121 * job table is empty.
123 * Job_AbortAll Abort all currently running jobs. It doesn't
124 * handle output or do anything for the jobs,
125 * just kills them. It should only be called in
126 * an emergency, as it were.
128 * Job_CheckCommands Verify that the commands for a target are
129 * ok. Provide them if necessary and possible.
131 * Job_Touch Update a target without really updating it.
133 * Job_Wait Wait for all currently-running jobs to finish.
139 #include <sys/types.h>
140 #include <sys/stat.h>
141 #include <sys/file.h>
142 #include <sys/time.h>
146 #if !defined(USE_SELECT) && defined(HAVE_POLL_H)
149 #ifndef USE_SELECT /* no poll.h */
152 #if defined(HAVE_SYS_SELECT_H)
153 # include <sys/select.h>
158 #if defined(HAVE_SYS_SOCKET_H)
159 # include <sys/socket.h>
165 #include "pathnames.h"
167 # define STATIC static
170 * FreeBSD: traditionally .MAKE is not required to
171 * pass jobs queue to sub-makes.
172 * Use .MAKE.ALWAYS_PASS_JOB_QUEUE=no to disable.
174 #define MAKE_ALWAYS_PASS_JOB_QUEUE ".MAKE.ALWAYS_PASS_JOB_QUEUE"
175 static int Always_pass_job_queue = TRUE;
177 * FreeBSD: aborting entire parallel make isn't always
178 * desired. When doing tinderbox for example, failure of
179 * one architecture should not stop all.
180 * We still want to bail on interrupt though.
182 #define MAKE_JOB_ERROR_TOKEN "MAKE_JOB_ERROR_TOKEN"
183 static int Job_error_token = TRUE;
186 * error handling variables
188 static int errors = 0; /* number of errors reported */
189 static int aborting = 0; /* why is the make aborting? */
190 #define ABORT_ERROR 1 /* Because of an error */
191 #define ABORT_INTERRUPT 2 /* Because it was interrupted */
192 #define ABORT_WAIT 3 /* Waiting for jobs to finish */
193 #define JOB_TOKENS "+EI+" /* Token to requeue for each abort state */
196 * this tracks the number of tokens currently "out" to build jobs.
198 int jobTokensRunning = 0;
201 * XXX: Avoid SunOS bug... FILENO() is fp->_file, and file
202 * is a char! So when we go above 127 we turn negative!
204 #define FILENO(a) ((unsigned) fileno(a))
207 * post-make command processing. The node postCommands is really just the
208 * .END target but we keep it around to avoid having to search for it
211 static GNode *postCommands = NULL;
212 /* node containing commands to execute when
213 * everything else is done */
214 static int numCommands; /* The number of commands actually printed
215 * for a target. Should this number be
216 * 0, no shell will be executed. */
219 * Return values from JobStart.
221 #define JOB_RUNNING 0 /* Job is running */
222 #define JOB_ERROR 1 /* Error in starting the job */
223 #define JOB_FINISHED 2 /* The job is already finished */
226 * Descriptions for various shells.
228 * The build environment may set DEFSHELL_INDEX to one of
229 * DEFSHELL_INDEX_SH, DEFSHELL_INDEX_KSH, or DEFSHELL_INDEX_CSH, to
230 * select one of the prefedined shells as the default shell.
232 * Alternatively, the build environment may set DEFSHELL_CUSTOM to the
233 * name or the full path of a sh-compatible shell, which will be used as
236 * ".SHELL" lines in Makefiles can choose the default shell from the
237 # set defined here, or add additional shells.
240 #ifdef DEFSHELL_CUSTOM
241 #define DEFSHELL_INDEX_CUSTOM 0
242 #define DEFSHELL_INDEX_SH 1
243 #define DEFSHELL_INDEX_KSH 2
244 #define DEFSHELL_INDEX_CSH 3
245 #else /* !DEFSHELL_CUSTOM */
246 #define DEFSHELL_INDEX_SH 0
247 #define DEFSHELL_INDEX_KSH 1
248 #define DEFSHELL_INDEX_CSH 2
249 #endif /* !DEFSHELL_CUSTOM */
251 #ifndef DEFSHELL_INDEX
252 #define DEFSHELL_INDEX 0 /* DEFSHELL_INDEX_CUSTOM or DEFSHELL_INDEX_SH */
253 #endif /* !DEFSHELL_INDEX */
255 static Shell shells[] = {
256 #ifdef DEFSHELL_CUSTOM
258 * An sh-compatible shell with a non-standard name.
260 * Keep this in sync with the "sh" description below, but avoid
261 * non-portable features that might not be supplied by all
262 * sh-compatible shells.
266 FALSE, "", "", "", 0,
267 FALSE, "echo \"%s\"\n", "%s\n", "{ %s \n} || exit $?\n", "'\n'", '#',
271 #endif /* DEFSHELL_CUSTOM */
273 * SH description. Echo control is also possible and, under
274 * sun UNIX anyway, one can even control error checking.
278 FALSE, "", "", "", 0,
279 FALSE, "echo \"%s\"\n", "%s\n", "{ %s \n} || exit $?\n", "'\n'", '#',
280 #if defined(MAKE_NATIVE) && defined(__NetBSD__)
292 TRUE, "set +v", "set -v", "set +v", 6,
293 FALSE, "echo \"%s\"\n", "%s\n", "{ %s \n} || exit $?\n", "'\n'", '#',
298 * CSH description. The csh can do echo control by playing
299 * with the setting of the 'echo' shell variable. Sadly,
300 * however, it is unable to do error control nicely.
304 TRUE, "unset verbose", "set verbose", "unset verbose", 10,
305 FALSE, "echo \"%s\"\n", "csh -c \"%s || exit 0\"\n", "", "'\\\n'", '#',
313 FALSE, NULL, NULL, NULL, 0,
314 FALSE, NULL, NULL, NULL, NULL, 0,
318 static Shell *commandShell = &shells[DEFSHELL_INDEX]; /* this is the shell to
320 * commands in the Makefile.
322 * Job_ParseShell function */
323 const char *shellPath = NULL, /* full pathname of
324 * executable image */
325 *shellName = NULL; /* last component of shell */
326 char *shellErrFlag = NULL;
327 static char *shellArgv = NULL; /* Custom shell args */
330 STATIC Job *job_table; /* The structures that describe them */
331 STATIC Job *job_table_end; /* job_table + maxJobs */
332 static int wantToken; /* we want a token */
333 static int lurking_children = 0;
334 static int make_suspended = 0; /* non-zero if we've seen a SIGTSTP (etc) */
337 * Set of descriptors of pipes connected to
338 * the output channels of children
340 static struct pollfd *fds = NULL;
341 static Job **jobfds = NULL;
343 static void watchfd(Job *);
344 static void clearfd(Job *);
345 static int readyfd(Job *);
347 STATIC GNode *lastNode; /* The node for which output was most recently
349 static char *targPrefix = NULL; /* What we print at the start of TARG_FMT */
350 static Job tokenWaitJob; /* token wait pseudo-job */
352 static Job childExitJob; /* child exit pseudo-job */
353 #define CHILD_EXIT "."
354 #define DO_JOB_RESUME "R"
356 static const int npseudojobs = 2; /* number of pseudo-jobs */
358 #define TARG_FMT "%s %s ---\n" /* Default format */
359 #define MESSAGE(fp, gn) \
360 if (maxJobs != 1 && targPrefix && *targPrefix) \
361 (void)fprintf(fp, TARG_FMT, targPrefix, gn->name)
363 static sigset_t caught_signals; /* Set of signals we handle */
365 static void JobChildSig(int);
366 static void JobContinueSig(int);
367 static Job *JobFindPid(int, int, Boolean);
368 static int JobPrintCommand(void *, void *);
369 static int JobSaveCommand(void *, void *);
370 static void JobClose(Job *);
371 static void JobExec(Job *, char **);
372 static void JobMakeArgv(Job *, char **);
373 static int JobStart(GNode *, int);
374 static char *JobOutput(Job *, char *, char *, int);
375 static void JobDoOutput(Job *, Boolean);
376 static Shell *JobMatchShell(const char *);
377 static void JobInterrupt(int, int) MAKE_ATTR_DEAD;
378 static void JobRestartJobs(void);
379 static void JobTokenAdd(void);
380 static void JobSigLock(sigset_t *);
381 static void JobSigUnlock(sigset_t *);
382 static void JobSigReset(void);
387 #if defined(USE_FILEMON) && !defined(USE_FILEMON_DEV)
395 job_table_dump(const char *where)
399 fprintf(debug_file, "job table @ %s\n", where);
400 for (job = job_table; job < job_table_end; job++) {
401 fprintf(debug_file, "job %d, status %d, flags %d, pid %d\n",
402 (int)(job - job_table), job->job_state, job->flags, job->pid);
407 * Delete the target of a failed, interrupted, or otherwise
408 * unsuccessful job unless inhibited by .PRECIOUS.
411 JobDeleteTarget(GNode *gn)
413 if ((gn->type & (OP_JOIN|OP_PHONY)) == 0 && !Targ_Precious(gn)) {
414 char *file = (gn->path == NULL ? gn->name : gn->path);
415 if (!noExecute && eunlink(file) != -1) {
416 Error("*** %s removed", file);
422 * JobSigLock/JobSigUnlock
424 * Signal lock routines to get exclusive access. Currently used to
425 * protect `jobs' and `stoppedJobs' list manipulations.
427 static void JobSigLock(sigset_t *omaskp)
429 if (sigprocmask(SIG_BLOCK, &caught_signals, omaskp) != 0) {
430 Punt("JobSigLock: sigprocmask: %s", strerror(errno));
435 static void JobSigUnlock(sigset_t *omaskp)
437 (void)sigprocmask(SIG_SETMASK, omaskp, NULL);
441 JobCreatePipe(Job *job, int minfd)
445 if (pipe(job->jobPipe) == -1)
446 Punt("Cannot create pipe: %s", strerror(errno));
448 for (i = 0; i < 2; i++) {
449 /* Avoid using low numbered fds */
450 fd = fcntl(job->jobPipe[i], F_DUPFD, minfd);
452 close(job->jobPipe[i]);
453 job->jobPipe[i] = fd;
457 /* Set close-on-exec flag for both */
458 if (fcntl(job->jobPipe[0], F_SETFD, FD_CLOEXEC) == -1)
459 Punt("Cannot set close-on-exec: %s", strerror(errno));
460 if (fcntl(job->jobPipe[1], F_SETFD, FD_CLOEXEC) == -1)
461 Punt("Cannot set close-on-exec: %s", strerror(errno));
464 * We mark the input side of the pipe non-blocking; we poll(2) the
465 * pipe when we're waiting for a job token, but we might lose the
466 * race for the token when a new one becomes available, so the read
467 * from the pipe should not block.
469 flags = fcntl(job->jobPipe[0], F_GETFL, 0);
471 Punt("Cannot get flags: %s", strerror(errno));
473 if (fcntl(job->jobPipe[0], F_SETFL, flags) == -1)
474 Punt("Cannot set flags: %s", strerror(errno));
478 *-----------------------------------------------------------------------
480 * Pass a signal to a job
483 * signop Signal to send it
486 * None, except the job may bite it.
488 *-----------------------------------------------------------------------
491 JobCondPassSig(int signo)
496 (void)fprintf(debug_file, "JobCondPassSig(%d) called.\n", signo);
499 for (job = job_table; job < job_table_end; job++) {
500 if (job->job_state != JOB_ST_RUNNING)
503 (void)fprintf(debug_file,
504 "JobCondPassSig passing signal %d to child %d.\n",
507 KILLPG(job->pid, signo);
512 *-----------------------------------------------------------------------
517 * signo The signal number we've received
523 * Sends a token on the child exit pipe to wake us up from
526 *-----------------------------------------------------------------------
529 JobChildSig(int signo MAKE_ATTR_UNUSED)
531 while (write(childExitJob.outPipe, CHILD_EXIT, 1) == -1 && errno == EAGAIN)
537 *-----------------------------------------------------------------------
539 * Resume all stopped jobs.
542 * signo The signal number we've received
548 * Jobs start running again.
550 *-----------------------------------------------------------------------
553 JobContinueSig(int signo MAKE_ATTR_UNUSED)
556 * Defer sending to SIGCONT to our stopped children until we return
557 * from the signal handler.
559 while (write(childExitJob.outPipe, DO_JOB_RESUME, 1) == -1 &&
565 *-----------------------------------------------------------------------
567 * Pass a signal on to all jobs, then resend to ourselves.
570 * signo The signal number we've received
576 * We die by the same signal.
578 *-----------------------------------------------------------------------
580 MAKE_ATTR_DEAD static void
581 JobPassSig_int(int signo)
583 /* Run .INTERRUPT target then exit */
584 JobInterrupt(TRUE, signo);
587 MAKE_ATTR_DEAD static void
588 JobPassSig_term(int signo)
590 /* Dont run .INTERRUPT target then exit */
591 JobInterrupt(FALSE, signo);
595 JobPassSig_suspend(int signo)
597 sigset_t nmask, omask;
598 struct sigaction act;
600 /* Suppress job started/continued messages */
603 /* Pass the signal onto every job */
604 JobCondPassSig(signo);
607 * Send ourselves the signal now we've given the message to everyone else.
608 * Note we block everything else possible while we're getting the signal.
609 * This ensures that all our jobs get continued when we wake up before
610 * we take any other signal.
613 sigdelset(&nmask, signo);
614 (void)sigprocmask(SIG_SETMASK, &nmask, &omask);
616 act.sa_handler = SIG_DFL;
617 sigemptyset(&act.sa_mask);
619 (void)sigaction(signo, &act, NULL);
622 (void)fprintf(debug_file,
623 "JobPassSig passing signal %d to self.\n", signo);
626 (void)kill(getpid(), signo);
629 * We've been continued.
631 * A whole host of signals continue to happen!
632 * SIGCHLD for any processes that actually suspended themselves.
633 * SIGCHLD for any processes that exited while we were alseep.
634 * The SIGCONT that actually caused us to wakeup.
636 * Since we defer passing the SIGCONT on to our children until
637 * the main processing loop, we can be sure that all the SIGCHLD
638 * events will have happened by then - and that the waitpid() will
639 * collect the child 'suspended' events.
640 * For correct sequencing we just need to ensure we process the
641 * waitpid() before passign on the SIGCONT.
643 * In any case nothing else is needed here.
646 /* Restore handler and signal mask */
647 act.sa_handler = JobPassSig_suspend;
648 (void)sigaction(signo, &act, NULL);
649 (void)sigprocmask(SIG_SETMASK, &omask, NULL);
653 *-----------------------------------------------------------------------
655 * Compare the pid of the job with the given pid and return 0 if they
656 * are equal. This function is called from Job_CatchChildren
657 * to find the job descriptor of the finished job.
661 * pid process id desired
664 * Job with matching pid
668 *-----------------------------------------------------------------------
671 JobFindPid(int pid, int status, Boolean isJobs)
675 for (job = job_table; job < job_table_end; job++) {
676 if ((job->job_state == status) && job->pid == pid)
679 if (DEBUG(JOB) && isJobs)
680 job_table_dump("no pid");
685 *-----------------------------------------------------------------------
687 * Put out another command for the given job. If the command starts
688 * with an @ or a - we process it specially. In the former case,
689 * so long as the -s and -n flags weren't given to make, we stick
690 * a shell-specific echoOff command in the script. In the latter,
691 * we ignore errors for the entire job, unless the shell has error
693 * If the command is just "..." we take all future commands for this
694 * job to be commands to be executed once the entire graph has been
695 * made and return non-zero to signal that the end of the commands
696 * was reached. These commands are later attached to the postCommands
697 * node and executed by Job_End when all things are done.
698 * This function is called from JobStart via Lst_ForEach.
701 * cmdp command string to print
702 * jobp job for which to print it
705 * Always 0, unless the command was "..."
708 * If the command begins with a '-' and the shell has no error control,
709 * the JOB_IGNERR flag is set in the job descriptor.
710 * If the command is "..." and we're not ignoring such things,
711 * tailCmds is set to the successor node of the cmd.
712 * numCommands is incremented if the command is actually printed.
713 *-----------------------------------------------------------------------
716 JobPrintCommand(void *cmdp, void *jobp)
718 Boolean noSpecials; /* true if we shouldn't worry about
719 * inserting special commands into
720 * the input stream. */
721 Boolean shutUp = FALSE; /* true if we put a no echo command
722 * into the command file */
723 Boolean errOff = FALSE; /* true if we turned error checking
724 * off before printing the command
725 * and need to turn it back on */
726 const char *cmdTemplate; /* Template to use when printing the
728 char *cmdStart; /* Start of expanded command */
729 char *escCmd = NULL; /* Command with quotes/backticks escaped */
730 char *cmd = (char *)cmdp;
731 Job *job = (Job *)jobp;
733 noSpecials = NoExecute(job->node);
735 if (strcmp(cmd, "...") == 0) {
736 job->node->type |= OP_SAVE_CMDS;
737 if ((job->flags & JOB_IGNDOTS) == 0) {
738 LstNode dotsNode = Lst_FindDatum(job->node->commands, cmd);
739 job->tailCmds = dotsNode != NULL ? LstNode_Next(dotsNode) : NULL;
745 #define DBPRINTF(fmt, arg) if (DEBUG(JOB)) { \
746 (void)fprintf(debug_file, fmt, arg); \
748 (void)fprintf(job->cmdFILE, fmt, arg); \
749 (void)fflush(job->cmdFILE);
753 cmdStart = cmd = Var_Subst(cmd, job->node, VARE_WANTRES);
755 cmdTemplate = "%s\n";
758 * Check for leading @' and -'s to control echoing and error checking.
760 while (*cmd == '@' || *cmd == '-' || (*cmd == '+')) {
763 shutUp = DEBUG(LOUD) ? FALSE : TRUE;
771 * We're not actually executing anything...
772 * but this one needs to be - use compat mode just for it.
774 CompatRunCommand(cmdp, job->node);
783 while (isspace((unsigned char) *cmd))
787 * If the shell doesn't have error control the alternate echo'ing will
788 * be done (to avoid showing additional error checking code)
789 * and this will need the characters '$ ` \ "' escaped
792 if (!commandShell->hasErrCtl) {
795 /* Worst that could happen is every char needs escaping. */
796 escCmd = bmake_malloc((strlen(cmd) * 2) + 1);
797 for (i = 0, j = 0; cmd[i] != '\0'; i++, j++) {
798 if (cmd[i] == '$' || cmd[i] == '`' || cmd[i] == '\\' ||
807 if (!(job->flags & JOB_SILENT) && !noSpecials &&
808 commandShell->hasEchoCtl) {
809 DBPRINTF("%s\n", commandShell->echoOff);
811 if (commandShell->hasErrCtl)
818 if (commandShell->hasErrCtl) {
820 * we don't want the error-control commands showing
821 * up either, so we turn off echoing while executing
822 * them. We could put another field in the shell
823 * structure to tell JobDoOutput to look for this
824 * string too, but why make it any more complex than
827 if (!(job->flags & JOB_SILENT) && !shutUp &&
828 commandShell->hasEchoCtl) {
829 DBPRINTF("%s\n", commandShell->echoOff);
830 DBPRINTF("%s\n", commandShell->ignErr);
831 DBPRINTF("%s\n", commandShell->echoOn);
833 DBPRINTF("%s\n", commandShell->ignErr);
835 } else if (commandShell->ignErr &&
836 (*commandShell->ignErr != '\0'))
839 * The shell has no error control, so we need to be
840 * weird to get it to ignore any errors from the command.
841 * If echoing is turned on, we turn it off and use the
842 * errCheck template to echo the command. Leave echoing
843 * off so the user doesn't see the weirdness we go through
844 * to ignore errors. Set cmdTemplate to use the weirdness
845 * instead of the simple "%s\n" template.
847 job->flags |= JOB_IGNERR;
848 if (!(job->flags & JOB_SILENT) && !shutUp) {
849 if (commandShell->hasEchoCtl) {
850 DBPRINTF("%s\n", commandShell->echoOff);
852 DBPRINTF(commandShell->errCheck, escCmd);
856 DBPRINTF(commandShell->errCheck, escCmd);
859 cmdTemplate = commandShell->ignErr;
861 * The error ignoration (hee hee) is already taken care
862 * of by the ignErr template, so pretend error checking
875 * If errors are being checked and the shell doesn't have error control
876 * but does supply an errOut template, then setup commands to run
880 if (!commandShell->hasErrCtl && commandShell->errOut &&
881 (*commandShell->errOut != '\0')) {
882 if (!(job->flags & JOB_SILENT) && !shutUp) {
883 if (commandShell->hasEchoCtl) {
884 DBPRINTF("%s\n", commandShell->echoOff);
886 DBPRINTF(commandShell->errCheck, escCmd);
889 /* If it's a comment line or blank, treat as an ignored error */
890 if ((escCmd[0] == commandShell->commentChar) ||
892 cmdTemplate = commandShell->ignErr;
894 cmdTemplate = commandShell->errOut;
899 if (DEBUG(SHELL) && strcmp(shellName, "sh") == 0 &&
900 (job->flags & JOB_TRACED) == 0) {
901 DBPRINTF("set -%s\n", "x");
902 job->flags |= JOB_TRACED;
905 DBPRINTF(cmdTemplate, cmd);
910 * If echoing is already off, there's no point in issuing the
911 * echoOff command. Otherwise we issue it and pretend it was on
912 * for the whole command...
914 if (!shutUp && !(job->flags & JOB_SILENT) && commandShell->hasEchoCtl){
915 DBPRINTF("%s\n", commandShell->echoOff);
918 DBPRINTF("%s\n", commandShell->errCheck);
920 if (shutUp && commandShell->hasEchoCtl) {
921 DBPRINTF("%s\n", commandShell->echoOn);
927 *-----------------------------------------------------------------------
929 * Save a command to be executed when everything else is done.
930 * Callback function for JobFinish...
936 * The command is tacked onto the end of postCommands' commands list.
938 *-----------------------------------------------------------------------
941 JobSaveCommand(void *cmd, void *gn)
943 cmd = Var_Subst((char *)cmd, (GNode *)gn, VARE_WANTRES);
944 Lst_Append(postCommands->commands, cmd);
950 *-----------------------------------------------------------------------
952 * Called to close both input and output pipes when a job is finished.
958 * The file descriptors associated with the job are closed.
960 *-----------------------------------------------------------------------
966 (void)close(job->outPipe);
969 JobDoOutput(job, TRUE);
970 (void)close(job->inPipe);
975 *-----------------------------------------------------------------------
977 * Do final processing for the given job including updating
978 * parents and starting new jobs as available/necessary. Note
979 * that we pay no attention to the JOB_IGNERR flag here.
980 * This is because when we're called because of a noexecute flag
981 * or something, jstat.w_status is 0 and when called from
982 * Job_CatchChildren, the status is zeroed if it s/b ignored.
986 * status sub-why job went away
992 * Final commands for the job are placed on postCommands.
994 * If we got an error and are aborting (aborting == ABORT_ERROR) and
995 * the job list is now empty, we are done for the day.
996 * If we recognized an error (errors !=0), we set the aborting flag
997 * to ABORT_ERROR so no more jobs will be started.
998 *-----------------------------------------------------------------------
1002 JobFinish (Job *job, WAIT_T status)
1004 Boolean done, return_job_token;
1007 fprintf(debug_file, "Jobfinish: %d [%s], status %d\n",
1008 job->pid, job->node->name, status);
1011 if ((WIFEXITED(status) &&
1012 (((WEXITSTATUS(status) != 0) && !(job->flags & JOB_IGNERR)))) ||
1013 WIFSIGNALED(status))
1016 * If it exited non-zero and either we're doing things our
1017 * way or we're not ignoring errors, the job is finished.
1018 * Similarly, if the shell died because of a signal
1019 * the job is also finished. In these
1020 * cases, finish out the job's output before printing the exit
1024 if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
1025 (void)fclose(job->cmdFILE);
1026 job->cmdFILE = NULL;
1029 } else if (WIFEXITED(status)) {
1031 * Deal with ignored errors in -B mode. We need to print a message
1032 * telling of the ignored error as well as setting status.w_status
1033 * to 0 so the next command gets run. To do this, we set done to be
1034 * TRUE if in -B mode and the job exited non-zero.
1036 done = WEXITSTATUS(status) != 0;
1038 * Old comment said: "Note we don't
1039 * want to close down any of the streams until we know we're at the
1041 * But we do. Otherwise when are we going to print the rest of the
1047 * No need to close things down or anything.
1053 if (WIFEXITED(status)) {
1055 (void)fprintf(debug_file, "Process %d [%s] exited.\n",
1056 job->pid, job->node->name);
1058 if (WEXITSTATUS(status) != 0) {
1059 if (job->node != lastNode) {
1060 MESSAGE(stdout, job->node);
1061 lastNode = job->node;
1065 meta_job_error(job, job->node, job->flags, WEXITSTATUS(status));
1068 if (!dieQuietly(job->node, -1))
1069 (void)printf("*** [%s] Error code %d%s\n",
1071 WEXITSTATUS(status),
1072 (job->flags & JOB_IGNERR) ? " (ignored)" : "");
1073 if (job->flags & JOB_IGNERR) {
1074 WAIT_STATUS(status) = 0;
1076 if (deleteOnError) {
1077 JobDeleteTarget(job->node);
1079 PrintOnError(job->node, NULL);
1081 } else if (DEBUG(JOB)) {
1082 if (job->node != lastNode) {
1083 MESSAGE(stdout, job->node);
1084 lastNode = job->node;
1086 (void)printf("*** [%s] Completed successfully\n",
1090 if (job->node != lastNode) {
1091 MESSAGE(stdout, job->node);
1092 lastNode = job->node;
1094 (void)printf("*** [%s] Signal %d\n",
1095 job->node->name, WTERMSIG(status));
1096 if (deleteOnError) {
1097 JobDeleteTarget(job->node);
1100 (void)fflush(stdout);
1107 if ((x = meta_job_finish(job)) != 0 && status == 0) {
1113 return_job_token = FALSE;
1115 Trace_Log(JOBEND, job);
1116 if (!(job->flags & JOB_SPECIAL)) {
1117 if ((WAIT_STATUS(status) != 0) ||
1118 (aborting == ABORT_ERROR) ||
1119 (aborting == ABORT_INTERRUPT))
1120 return_job_token = TRUE;
1123 if ((aborting != ABORT_ERROR) && (aborting != ABORT_INTERRUPT) &&
1124 (WAIT_STATUS(status) == 0)) {
1126 * As long as we aren't aborting and the job didn't return a non-zero
1127 * status that we shouldn't ignore, we call Make_Update to update
1128 * the parents. In addition, any saved commands for the node are placed
1129 * on the .END target.
1131 if (job->tailCmds != NULL) {
1132 Lst_ForEachFrom(job->node->commands, job->tailCmds,
1136 job->node->made = MADE;
1137 if (!(job->flags & JOB_SPECIAL))
1138 return_job_token = TRUE;
1139 Make_Update(job->node);
1140 job->job_state = JOB_ST_FREE;
1141 } else if (WAIT_STATUS(status)) {
1143 job->job_state = JOB_ST_FREE;
1147 * Set aborting if any error.
1149 if (errors && !keepgoing && (aborting != ABORT_INTERRUPT)) {
1151 * If we found any errors in this batch of children and the -k flag
1152 * wasn't given, we set the aborting flag so no more jobs get
1155 aborting = ABORT_ERROR;
1158 if (return_job_token)
1161 if (aborting == ABORT_ERROR && jobTokensRunning == 0) {
1163 * If we are aborting and the job table is now empty, we finish.
1170 *-----------------------------------------------------------------------
1172 * Touch the given target. Called by JobStart when the -t flag was
1176 * gn the node of the file to touch
1177 * silent TRUE if should not print message
1183 * The data modification of the file is changed. In addition, if the
1184 * file did not exist, it is created.
1185 *-----------------------------------------------------------------------
1188 Job_Touch(GNode *gn, Boolean silent)
1190 int streamID; /* ID of stream opened to do the touch */
1191 struct utimbuf times; /* Times for utime() call */
1193 if (gn->type & (OP_JOIN|OP_USE|OP_USEBEFORE|OP_EXEC|OP_OPTIONAL|
1194 OP_SPECIAL|OP_PHONY)) {
1196 * .JOIN, .USE, .ZEROTIME and .OPTIONAL targets are "virtual" targets
1197 * and, as such, shouldn't really be created.
1202 if (!silent || NoExecute(gn)) {
1203 (void)fprintf(stdout, "touch %s\n", gn->name);
1204 (void)fflush(stdout);
1207 if (NoExecute(gn)) {
1211 if (gn->type & OP_ARCHV) {
1213 } else if (gn->type & OP_LIB) {
1216 char *file = gn->path ? gn->path : gn->name;
1218 times.actime = times.modtime = now;
1219 if (utime(file, ×) < 0){
1220 streamID = open(file, O_RDWR | O_CREAT, 0666);
1222 if (streamID >= 0) {
1226 * Read and write a byte to the file to change the
1227 * modification time, then close the file.
1229 if (read(streamID, &c, 1) == 1) {
1230 (void)lseek(streamID, (off_t)0, SEEK_SET);
1231 while (write(streamID, &c, 1) == -1 && errno == EAGAIN)
1235 (void)close(streamID);
1237 (void)fprintf(stdout, "*** couldn't touch %s: %s",
1238 file, strerror(errno));
1239 (void)fflush(stdout);
1246 *-----------------------------------------------------------------------
1247 * Job_CheckCommands --
1248 * Make sure the given node has all the commands it needs.
1251 * gn The target whose commands need verifying
1252 * abortProc Function to abort with message
1255 * TRUE if the commands list is/was ok.
1258 * The node will have commands from the .DEFAULT rule added to it
1260 *-----------------------------------------------------------------------
1263 Job_CheckCommands(GNode *gn, void (*abortProc)(const char *, ...))
1265 if (OP_NOP(gn->type) && Lst_IsEmpty(gn->commands) &&
1266 ((gn->type & OP_LIB) == 0 || Lst_IsEmpty(gn->children))) {
1268 * No commands. Look for .DEFAULT rule from which we might infer
1271 if ((DEFAULT != NULL) && !Lst_IsEmpty(DEFAULT->commands) &&
1272 (gn->type & OP_SPECIAL) == 0) {
1275 * Make only looks for a .DEFAULT if the node was never the
1276 * target of an operator, so that's what we do too. If
1277 * a .DEFAULT was given, we substitute its commands for gn's
1278 * commands and set the IMPSRC variable to be the target's name
1279 * The DEFAULT node acts like a transformation rule, in that
1280 * gn also inherits any attributes or sources attached to
1283 Make_HandleUse(DEFAULT, gn);
1284 Var_Set(IMPSRC, Var_Value(TARGET, gn, &p1), gn);
1286 } else if (Dir_MTime(gn, 0) == 0 && (gn->type & OP_SPECIAL) == 0) {
1288 * The node wasn't the target of an operator we have no .DEFAULT
1289 * rule to go on and the target doesn't already exist. There's
1290 * nothing more we can do for this branch. If the -k flag wasn't
1291 * given, we stop in our tracks, otherwise we just don't update
1292 * this node's parents so they never get examined.
1294 static const char msg[] = ": don't know how to make";
1296 if (gn->flags & FROM_DEPEND) {
1297 if (!Job_RunTarget(".STALE", gn->fname))
1298 fprintf(stdout, "%s: %s, %d: ignoring stale %s for %s\n",
1299 progname, gn->fname, gn->lineno, makeDependfile,
1304 if (gn->type & OP_OPTIONAL) {
1305 (void)fprintf(stdout, "%s%s %s (ignored)\n", progname,
1307 (void)fflush(stdout);
1308 } else if (keepgoing) {
1309 (void)fprintf(stdout, "%s%s %s (continuing)\n", progname,
1311 (void)fflush(stdout);
1314 (*abortProc)("%s%s %s. Stop", progname, msg, gn->name);
1323 *-----------------------------------------------------------------------
1325 * Execute the shell for the given job. Called from JobStart
1328 * job Job to execute
1334 * A shell is executed, outputs is altered and the Job structure added
1337 *-----------------------------------------------------------------------
1340 JobExec(Job *job, char **argv)
1342 int cpid; /* ID of new child */
1345 job->flags &= ~JOB_TRACED;
1350 (void)fprintf(debug_file, "Running %s %sly\n", job->node->name, "local");
1351 (void)fprintf(debug_file, "\tCommand: ");
1352 for (i = 0; argv[i] != NULL; i++) {
1353 (void)fprintf(debug_file, "%s ", argv[i]);
1355 (void)fprintf(debug_file, "\n");
1359 * Some jobs produce no output and it's disconcerting to have
1360 * no feedback of their running (since they produce no output, the
1361 * banner with their name in it never appears). This is an attempt to
1362 * provide that feedback, even if nothing follows it.
1364 if ((lastNode != job->node) && !(job->flags & JOB_SILENT)) {
1365 MESSAGE(stdout, job->node);
1366 lastNode = job->node;
1369 /* No interruptions until this job is on the `jobs' list */
1372 /* Pre-emptively mark job running, pid still zero though */
1373 job->job_state = JOB_ST_RUNNING;
1377 Punt("Cannot vfork: %s", strerror(errno));
1385 meta_job_child(job);
1389 * Reset all signal handlers; this is necessary because we also
1390 * need to unblock signals before we exec(2).
1394 /* Now unblock signals */
1395 sigemptyset(&tmask);
1396 JobSigUnlock(&tmask);
1399 * Must duplicate the input stream down to the child's input and
1400 * reset it to the beginning (again). Since the stream was marked
1401 * close-on-exec, we must clear that bit in the new input.
1403 if (dup2(FILENO(job->cmdFILE), 0) == -1) {
1404 execError("dup2", "job->cmdFILE");
1407 if (fcntl(0, F_SETFD, 0) == -1) {
1408 execError("fcntl clear close-on-exec", "stdin");
1411 if (lseek(0, (off_t)0, SEEK_SET) == -1) {
1412 execError("lseek to 0", "stdin");
1416 if (Always_pass_job_queue ||
1417 (job->node->type & (OP_MAKE | OP_SUBMAKE))) {
1419 * Pass job token pipe to submakes.
1421 if (fcntl(tokenWaitJob.inPipe, F_SETFD, 0) == -1) {
1422 execError("clear close-on-exec", "tokenWaitJob.inPipe");
1425 if (fcntl(tokenWaitJob.outPipe, F_SETFD, 0) == -1) {
1426 execError("clear close-on-exec", "tokenWaitJob.outPipe");
1432 * Set up the child's output to be routed through the pipe
1433 * we've created for it.
1435 if (dup2(job->outPipe, 1) == -1) {
1436 execError("dup2", "job->outPipe");
1440 * The output channels are marked close on exec. This bit was
1441 * duplicated by the dup2(on some systems), so we have to clear
1442 * it before routing the shell's error output to the same place as
1443 * its standard output.
1445 if (fcntl(1, F_SETFD, 0) == -1) {
1446 execError("clear close-on-exec", "stdout");
1449 if (dup2(1, 2) == -1) {
1450 execError("dup2", "1, 2");
1455 * We want to switch the child into a different process family so
1456 * we can kill it and all its descendants in one fell swoop,
1457 * by killing its process family, but not commit suicide.
1459 #if defined(HAVE_SETPGID)
1460 (void)setpgid(0, getpid());
1462 #if defined(HAVE_SETSID)
1463 /* XXX: dsl - I'm sure this should be setpgrp()... */
1466 (void)setpgrp(0, getpid());
1472 (void)execv(shellPath, argv);
1473 execError("exec", shellPath);
1477 /* Parent, continuing after the child exec */
1480 Trace_Log(JOBSTART, job);
1484 meta_job_parent(job, cpid);
1489 * Set the current position in the buffer to the beginning
1490 * and mark another stream to watch in the outputs mask
1496 if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
1497 (void)fclose(job->cmdFILE);
1498 job->cmdFILE = NULL;
1502 * Now the job is actually running, add it to the table.
1505 fprintf(debug_file, "JobExec(%s): pid %d added to jobs table\n",
1506 job->node->name, job->pid);
1507 job_table_dump("job started");
1509 JobSigUnlock(&mask);
1513 *-----------------------------------------------------------------------
1515 * Create the argv needed to execute the shell for a given job.
1522 *-----------------------------------------------------------------------
1525 JobMakeArgv(Job *job, char **argv)
1528 static char args[10]; /* For merged arguments */
1530 argv[0] = UNCONST(shellName);
1533 if ((commandShell->exit && (*commandShell->exit != '-')) ||
1534 (commandShell->echo && (*commandShell->echo != '-')))
1537 * At least one of the flags doesn't have a minus before it, so
1538 * merge them together. Have to do this because the *(&(@*#*&#$#
1539 * Bourne shell thinks its second argument is a file to source.
1540 * Grrrr. Note the ten-character limitation on the combined arguments.
1542 (void)snprintf(args, sizeof(args), "-%s%s",
1543 ((job->flags & JOB_IGNERR) ? "" :
1544 (commandShell->exit ? commandShell->exit : "")),
1545 ((job->flags & JOB_SILENT) ? "" :
1546 (commandShell->echo ? commandShell->echo : "")));
1553 if (!(job->flags & JOB_IGNERR) && commandShell->exit) {
1554 argv[argc] = UNCONST(commandShell->exit);
1557 if (!(job->flags & JOB_SILENT) && commandShell->echo) {
1558 argv[argc] = UNCONST(commandShell->echo);
1566 *-----------------------------------------------------------------------
1568 * Start a target-creation process going for the target described
1569 * by the graph node gn.
1572 * gn target to create
1573 * flags flags for the job to override normal ones.
1574 * e.g. JOB_SPECIAL or JOB_IGNDOTS
1575 * previous The previous Job structure for this node, if any.
1578 * JOB_ERROR if there was an error in the commands, JOB_FINISHED
1579 * if there isn't actually anything left to do for the job and
1580 * JOB_RUNNING if the job has been started.
1583 * A new Job node is created and added to the list of running
1584 * jobs. PMake is forked and a child shell created.
1586 * NB: I'm fairly sure that this code is never called with JOB_SPECIAL set
1587 * JOB_IGNDOTS is never set (dsl)
1588 * Also the return value is ignored by everyone.
1589 *-----------------------------------------------------------------------
1592 JobStart(GNode *gn, int flags)
1594 Job *job; /* new job descriptor */
1595 char *argv[10]; /* Argument vector to shell */
1596 Boolean cmdsOK; /* true if the nodes commands were all right */
1597 Boolean noExec; /* Set true if we decide not to run the job */
1598 int tfd; /* File descriptor to the temp file */
1600 for (job = job_table; job < job_table_end; job++) {
1601 if (job->job_state == JOB_ST_FREE)
1604 if (job >= job_table_end)
1605 Punt("JobStart no job slots vacant");
1607 memset(job, 0, sizeof *job);
1608 job->job_state = JOB_ST_SETUP;
1609 if (gn->type & OP_SPECIAL)
1610 flags |= JOB_SPECIAL;
1613 job->tailCmds = NULL;
1616 * Set the initial value of the flags for this job based on the global
1617 * ones and the node's attributes... Any flags supplied by the caller
1618 * are also added to the field.
1621 if (Targ_Ignore(gn)) {
1622 job->flags |= JOB_IGNERR;
1624 if (Targ_Silent(gn)) {
1625 job->flags |= JOB_SILENT;
1627 job->flags |= flags;
1630 * Check the commands now so any attributes from .DEFAULT have a chance
1631 * to migrate to the node
1633 cmdsOK = Job_CheckCommands(gn, Error);
1635 job->inPollfd = NULL;
1637 * If the -n flag wasn't given, we open up OUR (not the child's)
1638 * temporary file to stuff commands in it. The thing is rd/wr so we don't
1639 * need to reopen it to feed it to the shell. If the -n flag *was* given,
1640 * we just set the file to be stdout. Cute, huh?
1642 if (((gn->type & OP_MAKE) && !(noRecursiveExecute)) ||
1643 (!noExecute && !touchFlag)) {
1645 * tfile is the name of a file into which all shell commands are
1646 * put. It is removed before the child shell is executed, unless
1647 * DEBUG(SCRIPT) is set.
1652 * We're serious here, but if the commands were bogus, we're
1656 PrintOnError(gn, NULL); /* provide some clue */
1661 tfd = mkTempFile(TMPPAT, &tfile);
1663 (void)eunlink(tfile);
1664 JobSigUnlock(&mask);
1666 job->cmdFILE = fdopen(tfd, "w+");
1667 if (job->cmdFILE == NULL) {
1668 Punt("Could not fdopen %s", tfile);
1670 (void)fcntl(FILENO(job->cmdFILE), F_SETFD, FD_CLOEXEC);
1672 * Send the commands to the command file, flush all its buffers then
1673 * rewind and remove the thing.
1679 meta_job_start(job, gn);
1680 if (Targ_Silent(gn)) { /* might have changed */
1681 job->flags |= JOB_SILENT;
1686 * We can do all the commands at once. hooray for sanity
1689 Lst_ForEach(gn->commands, JobPrintCommand, job);
1692 * If we didn't print out any commands to the shell script,
1693 * there's not much point in executing the shell, is there?
1695 if (numCommands == 0) {
1700 } else if (NoExecute(gn)) {
1702 * Not executing anything -- just print all the commands to stdout
1703 * in one fell swoop. This will still set up job->tailCmds correctly.
1705 if (lastNode != gn) {
1706 MESSAGE(stdout, gn);
1709 job->cmdFILE = stdout;
1711 * Only print the commands if they're ok, but don't die if they're
1712 * not -- just let the user know they're bad and keep going. It
1713 * doesn't do any harm in this case and may do some good.
1716 Lst_ForEach(gn->commands, JobPrintCommand, job);
1719 * Don't execute the shell, thank you.
1724 * Just touch the target and note that no shell should be executed.
1725 * Set cmdFILE to stdout to make life easier. Check the commands, too,
1726 * but don't die if they're no good -- it does no harm to keep working
1729 job->cmdFILE = stdout;
1730 Job_Touch(gn, job->flags&JOB_SILENT);
1733 /* Just in case it isn't already... */
1734 (void)fflush(job->cmdFILE);
1737 * If we're not supposed to execute a shell, don't.
1740 if (!(job->flags & JOB_SPECIAL))
1743 * Unlink and close the command file if we opened one
1745 if (job->cmdFILE != stdout) {
1746 if (job->cmdFILE != NULL) {
1747 (void)fclose(job->cmdFILE);
1748 job->cmdFILE = NULL;
1753 * We only want to work our way up the graph if we aren't here because
1754 * the commands for the job were no good.
1756 if (cmdsOK && aborting == 0) {
1757 if (job->tailCmds != NULL) {
1758 Lst_ForEachFrom(job->node->commands, job->tailCmds,
1762 job->node->made = MADE;
1763 Make_Update(job->node);
1765 job->job_state = JOB_ST_FREE;
1766 return cmdsOK ? JOB_FINISHED : JOB_ERROR;
1770 * Set up the control arguments to the shell. This is based on the flags
1771 * set earlier for this job.
1773 JobMakeArgv(job, argv);
1775 /* Create the pipe by which we'll get the shell's output. */
1776 JobCreatePipe(job, 3);
1783 JobOutput(Job *job, char *cp, char *endp, int msg)
1787 if (commandShell->noPrint) {
1788 ecp = Str_FindSubstring(cp, commandShell->noPrint);
1789 while (ecp != NULL) {
1792 if (!beSilent && msg && job->node != lastNode) {
1793 MESSAGE(stdout, job->node);
1794 lastNode = job->node;
1797 * The only way there wouldn't be a newline after
1798 * this line is if it were the last in the buffer.
1799 * however, since the non-printable comes after it,
1800 * there must be a newline, so we don't print one.
1802 (void)fprintf(stdout, "%s", cp);
1803 (void)fflush(stdout);
1805 cp = ecp + commandShell->noPLen;
1808 * Still more to print, look again after skipping
1809 * the whitespace following the non-printable
1813 while (*cp == ' ' || *cp == '\t' || *cp == '\n') {
1816 ecp = Str_FindSubstring(cp, commandShell->noPrint);
1826 *-----------------------------------------------------------------------
1828 * This function is called at different times depending on
1829 * whether the user has specified that output is to be collected
1830 * via pipes or temporary files. In the former case, we are called
1831 * whenever there is something to read on the pipe. We collect more
1832 * output from the given job and store it in the job's outBuf. If
1833 * this makes up a line, we print it tagged by the job's identifier,
1835 * If output has been collected in a temporary file, we open the
1836 * file and read it line by line, transfering it to our own
1837 * output channel until the file is empty. At which point we
1838 * remove the temporary file.
1839 * In both cases, however, we keep our figurative eye out for the
1840 * 'noPrint' line for the shell from which the output came. If
1841 * we recognize a line, we don't print it. If the command is not
1842 * alone on the line (the character after it is not \0 or \n), we
1843 * do print whatever follows it.
1846 * job the job whose output needs printing
1847 * finish TRUE if this is the last time we'll be called
1854 * curPos may be shifted as may the contents of outBuf.
1855 *-----------------------------------------------------------------------
1858 JobDoOutput(Job *job, Boolean finish)
1860 Boolean gotNL = FALSE; /* true if got a newline */
1861 Boolean fbuf; /* true if our buffer filled up */
1862 int nr; /* number of bytes read */
1863 int i; /* auxiliary index into outBuf */
1864 int max; /* limit for i (end of current data) */
1865 int nRead; /* (Temporary) number of bytes read */
1868 * Read as many bytes as will fit in the buffer.
1874 nRead = read(job->inPipe, &job->outBuf[job->curPos],
1875 JOB_BUFSIZE - job->curPos);
1877 if (errno == EAGAIN)
1880 perror("JobDoOutput(piperead)");
1888 * If we hit the end-of-file (the job is dead), we must flush its
1889 * remaining output, so pretend we read a newline if there's any
1890 * output remaining in the buffer.
1891 * Also clear the 'finish' flag so we stop looping.
1893 if ((nr == 0) && (job->curPos != 0)) {
1894 job->outBuf[job->curPos] = '\n';
1897 } else if (nr == 0) {
1902 * Look for the last newline in the bytes we just got. If there is
1903 * one, break out of the loop with 'i' as its index and gotNL set
1906 max = job->curPos + nr;
1907 for (i = job->curPos + nr - 1; i >= job->curPos; i--) {
1908 if (job->outBuf[i] == '\n') {
1911 } else if (job->outBuf[i] == '\0') {
1915 job->outBuf[i] = ' ';
1921 if (job->curPos == JOB_BUFSIZE) {
1923 * If we've run out of buffer space, we have no choice
1924 * but to print the stuff. sigh.
1930 if (gotNL || fbuf) {
1932 * Need to send the output to the screen. Null terminate it
1933 * first, overwriting the newline character if there was one.
1934 * So long as the line isn't one we should filter (according
1935 * to the shell description), we print the line, preceded
1936 * by a target banner if this target isn't the same as the
1937 * one for which we last printed something.
1938 * The rest of the data in the buffer are then shifted down
1939 * to the start of the buffer and curPos is set accordingly.
1941 job->outBuf[i] = '\0';
1942 if (i >= job->curPos) {
1945 cp = JobOutput(job, job->outBuf, &job->outBuf[i], FALSE);
1948 * There's still more in that thar buffer. This time, though,
1949 * we know there's no newline at the end, so we add one of
1950 * our own free will.
1953 if (!beSilent && job->node != lastNode) {
1954 MESSAGE(stdout, job->node);
1955 lastNode = job->node;
1959 meta_job_output(job, cp, gotNL ? "\n" : "");
1962 (void)fprintf(stdout, "%s%s", cp, gotNL ? "\n" : "");
1963 (void)fflush(stdout);
1967 * max is the last offset still in the buffer. Move any remaining
1968 * characters to the start of the buffer and update the end marker
1972 (void)memmove(job->outBuf, &job->outBuf[i + 1], max - (i + 1));
1973 job->curPos = max - (i + 1);
1981 * If the finish flag is true, we must loop until we hit
1982 * end-of-file on the pipe. This is guaranteed to happen
1983 * eventually since the other end of the pipe is now closed
1984 * (we closed it explicitly and the child has exited). When
1985 * we do get an EOF, finish will be set FALSE and we'll fall
1997 * Unfortunately it is too complicated to run .BEGIN, .END,
1998 * and .INTERRUPT job in the parallel job module. This has
1999 * the nice side effect that it avoids a lot of other problems.
2001 Lst lst = Lst_Init();
2002 Lst_Append(lst, targ);
2003 (void)Make_Run(lst);
2004 Lst_Destroy(lst, NULL);
2005 JobStart(targ, JOB_SPECIAL);
2006 while (jobTokensRunning) {
2010 Compat_Make(targ, targ);
2011 if (targ->made == ERROR) {
2012 PrintOnError(targ, "\n\nStop.");
2019 *-----------------------------------------------------------------------
2020 * Job_CatchChildren --
2021 * Handle the exit of a child. Called from Make_Make.
2024 * block TRUE if should block on the wait
2030 * The job descriptor is removed from the list of children.
2033 * We do waits, blocking or not, according to the wisdom of our
2034 * caller, until there are no more children to report. For each
2035 * job, call JobFinish to finish things off.
2037 *-----------------------------------------------------------------------
2041 Job_CatchChildren(void)
2043 int pid; /* pid of dead child */
2044 WAIT_T status; /* Exit/termination status */
2047 * Don't even bother if we know there's no one around.
2049 if (jobTokensRunning == 0)
2052 while ((pid = waitpid((pid_t) -1, &status, WNOHANG | WUNTRACED)) > 0) {
2054 (void)fprintf(debug_file, "Process %d exited/stopped status %x.\n", pid,
2055 WAIT_STATUS(status));
2057 JobReapChild(pid, status, TRUE);
2062 * It is possible that wait[pid]() was called from elsewhere,
2063 * this lets us reap jobs regardless.
2066 JobReapChild(pid_t pid, WAIT_T status, Boolean isJobs)
2068 Job *job; /* job descriptor for dead child */
2071 * Don't even bother if we know there's no one around.
2073 if (jobTokensRunning == 0)
2076 job = JobFindPid(pid, JOB_ST_RUNNING, isJobs);
2079 if (!lurking_children)
2080 Error("Child (%d) status %x not in table?", pid, status);
2082 return; /* not ours */
2084 if (WIFSTOPPED(status)) {
2086 (void)fprintf(debug_file, "Process %d (%s) stopped.\n",
2087 job->pid, job->node->name);
2089 if (!make_suspended) {
2090 switch (WSTOPSIG(status)) {
2092 (void)printf("*** [%s] Suspended\n", job->node->name);
2095 (void)printf("*** [%s] Stopped\n", job->node->name);
2098 (void)printf("*** [%s] Stopped -- signal %d\n",
2099 job->node->name, WSTOPSIG(status));
2101 job->job_suspended = 1;
2103 (void)fflush(stdout);
2107 job->job_state = JOB_ST_FINISHED;
2108 job->exit_status = WAIT_STATUS(status);
2110 JobFinish(job, status);
2114 *-----------------------------------------------------------------------
2115 * Job_CatchOutput --
2116 * Catch the output from our children, if we're using
2117 * pipes do so. Otherwise just block time until we get a
2118 * signal(most likely a SIGCHLD) since there's no point in
2119 * just spinning when there's nothing to do and the reaping
2120 * of a child can wait for a while.
2126 * Output is read from pipes if we're piping.
2127 * -----------------------------------------------------------------------
2130 Job_CatchOutput(void)
2136 (void)fflush(stdout);
2138 /* The first fd in the list is the job token pipe */
2140 nready = poll(fds + 1 - wantToken, nfds - 1 + wantToken, POLL_MSEC);
2141 } while (nready < 0 && errno == EINTR);
2144 Punt("poll: %s", strerror(errno));
2146 if (nready > 0 && readyfd(&childExitJob)) {
2149 count = read(childExitJob.inPipe, &token, 1);
2152 Punt("unexpected eof on token pipe");
2154 Punt("token pipe read: %s", strerror(errno));
2156 if (token == DO_JOB_RESUME[0])
2157 /* Complete relay requested from our SIGCONT handler */
2166 Job_CatchChildren();
2170 for (i = npseudojobs*nfds_per_job(); i < nfds; i++) {
2171 if (!fds[i].revents)
2174 if (job->job_state == JOB_ST_RUNNING)
2175 JobDoOutput(job, FALSE);
2176 #if defined(USE_FILEMON) && !defined(USE_FILEMON_DEV)
2178 * With meta mode, we may have activity on the job's filemon
2179 * descriptor too, which at the moment is any pollfd other than
2182 if (useMeta && job->inPollfd != &fds[i]) {
2183 if (meta_job_event(job) <= 0) {
2184 fds[i].events = 0; /* never mind */
2194 *-----------------------------------------------------------------------
2196 * Start the creation of a target. Basically a front-end for
2197 * JobStart used by the Make module.
2203 * Another job is started.
2205 *-----------------------------------------------------------------------
2210 (void)JobStart(gn, 0);
2216 if (shellPath == NULL) {
2218 * We are using the default shell, which may be an absolute
2219 * path if DEFSHELL_CUSTOM is defined.
2221 shellName = commandShell->name;
2222 #ifdef DEFSHELL_CUSTOM
2223 if (*shellName == '/') {
2224 shellPath = shellName;
2225 shellName = strrchr(shellPath, '/');
2229 shellPath = str_concat3(_PATH_DEFSHELLDIR, "/", shellName);
2231 Var_Set_with_flags(".SHELL", shellPath, VAR_CMD, VAR_SET_READONLY);
2232 if (commandShell->exit == NULL) {
2233 commandShell->exit = "";
2235 if (commandShell->echo == NULL) {
2236 commandShell->echo = "";
2238 if (commandShell->hasErrCtl && *commandShell->exit) {
2240 strcmp(commandShell->exit, &shellErrFlag[1]) != 0) {
2242 shellErrFlag = NULL;
2244 if (!shellErrFlag) {
2245 int n = strlen(commandShell->exit) + 2;
2247 shellErrFlag = bmake_malloc(n);
2249 snprintf(shellErrFlag, n, "-%s", commandShell->exit);
2252 } else if (shellErrFlag) {
2254 shellErrFlag = NULL;
2259 * Returns the string literal that is used in the current command shell
2260 * to produce a newline character.
2263 Shell_GetNewline(void)
2265 return commandShell->newline;
2273 } else if (!Var_Exists(MAKE_JOB_PREFIX, VAR_GLOBAL)) {
2274 Var_Set(MAKE_JOB_PREFIX, "---", VAR_GLOBAL);
2277 targPrefix = Var_Subst("${" MAKE_JOB_PREFIX "}",
2278 VAR_GLOBAL, VARE_WANTRES);
2281 /* Initialize the process module. */
2286 /* Allocate space for all the job info */
2287 job_table = bmake_malloc(maxJobs * sizeof *job_table);
2288 memset(job_table, 0, maxJobs * sizeof *job_table);
2289 job_table_end = job_table + maxJobs;
2297 Always_pass_job_queue = getBoolean(MAKE_ALWAYS_PASS_JOB_QUEUE,
2298 Always_pass_job_queue);
2300 Job_error_token = getBoolean(MAKE_JOB_ERROR_TOKEN, Job_error_token);
2304 * There is a non-zero chance that we already have children.
2305 * eg after 'make -f- <<EOF'
2306 * Since their termination causes a 'Child (pid) not in table' message,
2307 * Collect the status of any that are already dead, and suppress the
2308 * error message if there are any undead ones.
2312 rval = waitpid((pid_t) -1, &status, WNOHANG);
2316 lurking_children = 1;
2322 JobCreatePipe(&childExitJob, 3);
2324 /* Preallocate enough for the maximum number of jobs. */
2325 fds = bmake_malloc(sizeof(*fds) *
2326 (npseudojobs + maxJobs) * nfds_per_job());
2327 jobfds = bmake_malloc(sizeof(*jobfds) *
2328 (npseudojobs + maxJobs) * nfds_per_job());
2330 /* These are permanent entries and take slots 0 and 1 */
2331 watchfd(&tokenWaitJob);
2332 watchfd(&childExitJob);
2334 sigemptyset(&caught_signals);
2336 * Install a SIGCHLD handler.
2338 (void)bmake_signal(SIGCHLD, JobChildSig);
2339 sigaddset(&caught_signals, SIGCHLD);
2341 #define ADDSIG(s,h) \
2342 if (bmake_signal(s, SIG_IGN) != SIG_IGN) { \
2343 sigaddset(&caught_signals, s); \
2344 (void)bmake_signal(s, h); \
2348 * Catch the four signals that POSIX specifies if they aren't ignored.
2349 * JobPassSig will take care of calling JobInterrupt if appropriate.
2351 ADDSIG(SIGINT, JobPassSig_int)
2352 ADDSIG(SIGHUP, JobPassSig_term)
2353 ADDSIG(SIGTERM, JobPassSig_term)
2354 ADDSIG(SIGQUIT, JobPassSig_term)
2357 * There are additional signals that need to be caught and passed if
2358 * either the export system wants to be told directly of signals or if
2359 * we're giving each job its own process group (since then it won't get
2360 * signals from the terminal driver as we own the terminal)
2362 ADDSIG(SIGTSTP, JobPassSig_suspend)
2363 ADDSIG(SIGTTOU, JobPassSig_suspend)
2364 ADDSIG(SIGTTIN, JobPassSig_suspend)
2365 ADDSIG(SIGWINCH, JobCondPassSig)
2366 ADDSIG(SIGCONT, JobContinueSig)
2369 (void)Job_RunTarget(".BEGIN", NULL);
2370 postCommands = Targ_FindNode(".END", TARG_CREATE);
2373 static void JobSigReset(void)
2376 if (sigismember(&caught_signals, s)) { \
2377 (void)bmake_signal(s, SIG_DFL); \
2390 (void)bmake_signal(SIGCHLD, SIG_DFL);
2393 /* Find a shell in 'shells' given its name, or return NULL. */
2395 JobMatchShell(const char *name)
2399 for (sh = shells; sh->name != NULL; sh++) {
2400 if (strcmp(name, sh->name) == 0)
2407 *-----------------------------------------------------------------------
2409 * Parse a shell specification and set up commandShell, shellPath
2410 * and shellName appropriately.
2413 * line The shell spec
2416 * FALSE if the specification was incorrect.
2419 * commandShell points to a Shell structure (either predefined or
2420 * created from the shell spec), shellPath is the full path of the
2421 * shell described by commandShell, while shellName is just the
2422 * final component of shellPath.
2425 * A shell specification consists of a .SHELL target, with dependency
2426 * operator, followed by a series of blank-separated words. Double
2427 * quotes can be used to use blanks in words. A backslash escapes
2428 * anything (most notably a double-quote and a space) and
2429 * provides the functionality it does in C. Each word consists of
2430 * keyword and value separated by an equal sign. There should be no
2431 * unnecessary spaces in the word. The keywords are as follows:
2432 * name Name of shell.
2433 * path Location of shell.
2434 * quiet Command to turn off echoing.
2435 * echo Command to turn echoing on
2436 * filter Result of turning off echoing that shouldn't be
2438 * echoFlag Flag to turn echoing on at the start
2439 * errFlag Flag to turn error checking on at the start
2440 * hasErrCtl True if shell has error checking control
2441 * newline String literal to represent a newline char
2442 * check Command to turn on error checking if hasErrCtl
2443 * is TRUE or template of command to echo a command
2444 * for which error checking is off if hasErrCtl is
2446 * ignore Command to turn off error checking if hasErrCtl
2447 * is TRUE or template of command to execute a
2448 * command so as to ignore any errors it returns if
2449 * hasErrCtl is FALSE.
2451 *-----------------------------------------------------------------------
2454 Job_ParseShell(char *line)
2462 Boolean fullSpec = FALSE;
2465 while (isspace((unsigned char)*line)) {
2471 memset(&newShell, 0, sizeof(newShell));
2474 * Parse the specification by keyword
2476 wordsList = Str_Words(line, TRUE);
2477 words = wordsList.words;
2478 argc = wordsList.len;
2479 path = wordsList.freeIt;
2480 if (words == NULL) {
2481 Error("Unterminated quoted string [%s]", line);
2486 for (path = NULL, argv = words; argc != 0; argc--, argv++) {
2487 if (strncmp(*argv, "path=", 5) == 0) {
2489 } else if (strncmp(*argv, "name=", 5) == 0) {
2490 newShell.name = &argv[0][5];
2492 if (strncmp(*argv, "quiet=", 6) == 0) {
2493 newShell.echoOff = &argv[0][6];
2494 } else if (strncmp(*argv, "echo=", 5) == 0) {
2495 newShell.echoOn = &argv[0][5];
2496 } else if (strncmp(*argv, "filter=", 7) == 0) {
2497 newShell.noPrint = &argv[0][7];
2498 newShell.noPLen = strlen(newShell.noPrint);
2499 } else if (strncmp(*argv, "echoFlag=", 9) == 0) {
2500 newShell.echo = &argv[0][9];
2501 } else if (strncmp(*argv, "errFlag=", 8) == 0) {
2502 newShell.exit = &argv[0][8];
2503 } else if (strncmp(*argv, "hasErrCtl=", 10) == 0) {
2504 char c = argv[0][10];
2505 newShell.hasErrCtl = !((c != 'Y') && (c != 'y') &&
2506 (c != 'T') && (c != 't'));
2507 } else if (strncmp(*argv, "newline=", 8) == 0) {
2508 newShell.newline = &argv[0][8];
2509 } else if (strncmp(*argv, "check=", 6) == 0) {
2510 newShell.errCheck = &argv[0][6];
2511 } else if (strncmp(*argv, "ignore=", 7) == 0) {
2512 newShell.ignErr = &argv[0][7];
2513 } else if (strncmp(*argv, "errout=", 7) == 0) {
2514 newShell.errOut = &argv[0][7];
2515 } else if (strncmp(*argv, "comment=", 8) == 0) {
2516 newShell.commentChar = argv[0][8];
2518 Parse_Error(PARSE_FATAL, "Unknown keyword \"%s\"",
2529 * If no path was given, the user wants one of the pre-defined shells,
2530 * yes? So we find the one s/he wants with the help of JobMatchShell
2531 * and set things up the right way. shellPath will be set up by
2534 if (newShell.name == NULL) {
2535 Parse_Error(PARSE_FATAL, "Neither path nor name specified");
2539 if ((sh = JobMatchShell(newShell.name)) == NULL) {
2540 Parse_Error(PARSE_WARNING, "%s: No matching shell",
2546 shellName = newShell.name;
2548 /* Shell_Init has already been called! Do it again. */
2549 free(UNCONST(shellPath));
2556 * The user provided a path. If s/he gave nothing else (fullSpec is
2557 * FALSE), try and find a matching shell in the ones we know of.
2558 * Else we just take the specification at its word and copy it
2559 * to a new location. In either case, we need to record the
2560 * path the user gave for the shell.
2563 path = strrchr(path, '/');
2565 path = UNCONST(shellPath);
2569 if (newShell.name != NULL) {
2570 shellName = newShell.name;
2575 if ((sh = JobMatchShell(shellName)) == NULL) {
2576 Parse_Error(PARSE_WARNING, "%s: No matching shell",
2583 commandShell = bmake_malloc(sizeof(Shell));
2584 *commandShell = newShell;
2586 /* this will take care of shellErrFlag */
2590 if (commandShell->echoOn && commandShell->echoOff) {
2591 commandShell->hasEchoCtl = TRUE;
2594 if (!commandShell->hasErrCtl) {
2595 if (commandShell->errCheck == NULL) {
2596 commandShell->errCheck = "";
2598 if (commandShell->ignErr == NULL) {
2599 commandShell->ignErr = "%s\n";
2604 * Do not free up the words themselves, since they might be in use by the
2605 * shell specification.
2612 *-----------------------------------------------------------------------
2614 * Handle the receipt of an interrupt.
2617 * runINTERRUPT Non-zero if commands for the .INTERRUPT target
2618 * should be executed
2619 * signo signal received
2625 * All children are killed. Another job will be started if the
2626 * .INTERRUPT target was given.
2627 *-----------------------------------------------------------------------
2630 JobInterrupt(int runINTERRUPT, int signo)
2632 Job *job; /* job descriptor in that element */
2633 GNode *interrupt; /* the node describing the .INTERRUPT target */
2637 aborting = ABORT_INTERRUPT;
2641 for (job = job_table; job < job_table_end; job++) {
2642 if (job->job_state != JOB_ST_RUNNING)
2647 JobDeleteTarget(gn);
2650 (void)fprintf(debug_file,
2651 "JobInterrupt passing signal %d to child %d.\n",
2654 KILLPG(job->pid, signo);
2658 JobSigUnlock(&mask);
2660 if (runINTERRUPT && !touchFlag) {
2661 interrupt = Targ_FindNode(".INTERRUPT", TARG_NOCREATE);
2662 if (interrupt != NULL) {
2663 ignoreErrors = FALSE;
2667 Trace_Log(MAKEINTR, 0);
2672 *-----------------------------------------------------------------------
2674 * Do final processing such as the running of the commands
2675 * attached to the .END target.
2678 * Number of errors reported.
2682 *-----------------------------------------------------------------------
2687 if (postCommands != NULL &&
2688 (!Lst_IsEmpty(postCommands->commands) ||
2689 !Lst_IsEmpty(postCommands->children))) {
2691 Error("Errors reported so .END ignored");
2693 JobRun(postCommands);
2700 *-----------------------------------------------------------------------
2702 * Cleanup any memory used by the jobs module
2709 *-----------------------------------------------------------------------
2720 *-----------------------------------------------------------------------
2722 * Waits for all running jobs to finish and returns. Sets 'aborting'
2723 * to ABORT_WAIT to prevent other jobs from starting.
2729 * Currently running jobs finish.
2731 *-----------------------------------------------------------------------
2736 aborting = ABORT_WAIT;
2737 while (jobTokensRunning != 0) {
2744 *-----------------------------------------------------------------------
2746 * Abort all currently running jobs without handling output or anything.
2747 * This function is to be called only in the event of a major
2748 * error. Most definitely NOT to be called from JobInterrupt.
2754 * All children are killed, not just the firstborn
2755 *-----------------------------------------------------------------------
2760 Job *job; /* the job descriptor in that element */
2763 aborting = ABORT_ERROR;
2765 if (jobTokensRunning) {
2766 for (job = job_table; job < job_table_end; job++) {
2767 if (job->job_state != JOB_ST_RUNNING)
2770 * kill the child process with increasingly drastic signals to make
2771 * darn sure it's dead.
2773 KILLPG(job->pid, SIGINT);
2774 KILLPG(job->pid, SIGKILL);
2779 * Catch as many children as want to report in at first, then give up
2781 while (waitpid((pid_t) -1, &foo, WNOHANG) > 0)
2786 *-----------------------------------------------------------------------
2788 * Tries to restart stopped jobs if there are slots available.
2789 * Called in process context in response to a SIGCONT.
2797 *-----------------------------------------------------------------------
2800 JobRestartJobs(void)
2804 for (job = job_table; job < job_table_end; job++) {
2805 if (job->job_state == JOB_ST_RUNNING &&
2806 (make_suspended || job->job_suspended)) {
2808 (void)fprintf(debug_file, "Restarting stopped job pid %d.\n",
2811 if (job->job_suspended) {
2812 (void)printf("*** [%s] Continued\n", job->node->name);
2813 (void)fflush(stdout);
2815 job->job_suspended = 0;
2816 if (KILLPG(job->pid, SIGCONT) != 0 && DEBUG(JOB)) {
2817 fprintf(debug_file, "Failed to send SIGCONT to %d\n", job->pid);
2820 if (job->job_state == JOB_ST_FINISHED)
2821 /* Job exit deferred after calling waitpid() in a signal handler */
2822 JobFinish(job, job->exit_status);
2830 if (job->inPollfd != NULL)
2831 Punt("Watching watched job");
2833 fds[nfds].fd = job->inPipe;
2834 fds[nfds].events = POLLIN;
2836 job->inPollfd = &fds[nfds];
2838 #if defined(USE_FILEMON) && !defined(USE_FILEMON_DEV)
2840 fds[nfds].fd = meta_job_fd(job);
2841 fds[nfds].events = fds[nfds].fd == -1 ? 0 : POLLIN;
2852 if (job->inPollfd == NULL)
2853 Punt("Unwatching unwatched job");
2854 i = job->inPollfd - fds;
2856 #if defined(USE_FILEMON) && !defined(USE_FILEMON_DEV)
2859 * Sanity check: there should be two fds per job, so the job's
2860 * pollfd number should be even.
2862 assert(nfds_per_job() == 2);
2864 Punt("odd-numbered fd with meta");
2869 * Move last job in table into hole made by dead job.
2873 jobfds[i] = jobfds[nfds];
2874 jobfds[i]->inPollfd = &fds[i];
2875 #if defined(USE_FILEMON) && !defined(USE_FILEMON_DEV)
2877 fds[i + 1] = fds[nfds + 1];
2878 jobfds[i + 1] = jobfds[nfds + 1];
2882 job->inPollfd = NULL;
2888 if (job->inPollfd == NULL)
2889 Punt("Polling unwatched job");
2890 return (job->inPollfd->revents & POLLIN) != 0;
2894 *-----------------------------------------------------------------------
2896 * Put a token into the job pipe so that some make process can start
2900 * Allows more build jobs to be spawned somewhere.
2902 *-----------------------------------------------------------------------
2908 char tok = JOB_TOKENS[aborting], tok1;
2910 if (!Job_error_token && aborting == ABORT_ERROR) {
2911 if (jobTokensRunning == 0)
2913 tok = '+'; /* no error token */
2916 /* If we are depositing an error token flush everything else */
2917 while (tok != '+' && read(tokenWaitJob.inPipe, &tok1, 1) == 1)
2921 fprintf(debug_file, "(%d) aborting %d, deposit token %c\n",
2922 getpid(), aborting, tok);
2923 while (write(tokenWaitJob.outPipe, &tok, 1) == -1 && errno == EAGAIN)
2928 *-----------------------------------------------------------------------
2929 * Job_ServerStartTokenAdd --
2930 * Prep the job token pipe in the root make process.
2932 *-----------------------------------------------------------------------
2936 Job_ServerStart(int max_tokens, int jp_0, int jp_1)
2941 if (jp_0 >= 0 && jp_1 >= 0) {
2942 /* Pipe passed in from parent */
2943 tokenWaitJob.inPipe = jp_0;
2944 tokenWaitJob.outPipe = jp_1;
2945 (void)fcntl(jp_0, F_SETFD, FD_CLOEXEC);
2946 (void)fcntl(jp_1, F_SETFD, FD_CLOEXEC);
2950 JobCreatePipe(&tokenWaitJob, 15);
2952 snprintf(jobarg, sizeof(jobarg), "%d,%d",
2953 tokenWaitJob.inPipe, tokenWaitJob.outPipe);
2955 Var_Append(MAKEFLAGS, "-J", VAR_GLOBAL);
2956 Var_Append(MAKEFLAGS, jobarg, VAR_GLOBAL);
2959 * Preload the job pipe with one token per job, save the one
2960 * "extra" token for the primary job.
2962 * XXX should clip maxJobs against PIPE_BUF -- if max_tokens is
2963 * larger than the write buffer size of the pipe, we will
2966 for (i = 1; i < max_tokens; i++)
2971 *-----------------------------------------------------------------------
2972 * Job_TokenReturn --
2973 * Return a withdrawn token to the pool.
2975 *-----------------------------------------------------------------------
2979 Job_TokenReturn(void)
2982 if (jobTokensRunning < 0)
2983 Punt("token botch");
2984 if (jobTokensRunning || JOB_TOKENS[aborting] != '+')
2989 *-----------------------------------------------------------------------
2990 * Job_TokenWithdraw --
2991 * Attempt to withdraw a token from the pool.
2994 * Returns TRUE if a token was withdrawn, and FALSE if the pool
2995 * is currently empty.
2998 * If pool is empty, set wantToken so that we wake up
2999 * when a token is released.
3001 *-----------------------------------------------------------------------
3006 Job_TokenWithdraw(void)
3013 fprintf(debug_file, "Job_TokenWithdraw(%d): aborting %d, running %d\n",
3014 getpid(), aborting, jobTokensRunning);
3016 if (aborting || (jobTokensRunning >= maxJobs))
3019 count = read(tokenWaitJob.inPipe, &tok, 1);
3021 Fatal("eof on job pipe!");
3022 if (count < 0 && jobTokensRunning != 0) {
3023 if (errno != EAGAIN) {
3024 Fatal("job pipe read: %s", strerror(errno));
3027 fprintf(debug_file, "(%d) blocked for token\n", getpid());
3031 if (count == 1 && tok != '+') {
3032 /* make being abvorted - remove any other job tokens */
3034 fprintf(debug_file, "(%d) aborted by token %c\n", getpid(), tok);
3035 while (read(tokenWaitJob.inPipe, &tok1, 1) == 1)
3037 /* And put the stopper back */
3038 while (write(tokenWaitJob.outPipe, &tok, 1) == -1 && errno == EAGAIN)
3040 if (dieQuietly(NULL, 1))
3042 Fatal("A failure has been detected in another branch of the parallel make");
3045 if (count == 1 && jobTokensRunning == 0)
3046 /* We didn't want the token really */
3047 while (write(tokenWaitJob.outPipe, &tok, 1) == -1 && errno == EAGAIN)
3052 fprintf(debug_file, "(%d) withdrew token\n", getpid());
3057 *-----------------------------------------------------------------------
3059 * Run the named target if found. If a filename is specified, then
3060 * set that to the sources.
3066 * exits if the target fails.
3068 *-----------------------------------------------------------------------
3071 Job_RunTarget(const char *target, const char *fname) {
3072 GNode *gn = Targ_FindNode(target, TARG_NOCREATE);
3078 Var_Set(ALLSRC, fname, gn);
3081 if (gn->made == ERROR) {
3082 PrintOnError(gn, "\n\nStop.");
3090 emul_poll(struct pollfd *fd, int nfd, int timeout)
3093 int i, maxfd, nselect, npoll;
3094 struct timeval tv, *tvp;
3101 for (i = 0; i < nfd; i++) {
3104 if (fd[i].events & POLLIN)
3105 FD_SET(fd[i].fd, &rfds);
3107 if (fd[i].events & POLLOUT)
3108 FD_SET(fd[i].fd, &wfds);
3110 if (fd[i].fd > maxfd)
3114 if (maxfd >= FD_SETSIZE) {
3115 Punt("Ran out of fd_set slots; "
3116 "recompile with a larger FD_SETSIZE.");
3122 usecs = timeout * 1000;
3123 tv.tv_sec = usecs / 1000000;
3124 tv.tv_usec = usecs % 1000000;
3128 nselect = select(maxfd + 1, &rfds, &wfds, 0, tvp);
3134 for (i = 0; i < nfd; i++) {
3135 if (FD_ISSET(fd[i].fd, &rfds))
3136 fd[i].revents |= POLLIN;
3138 if (FD_ISSET(fd[i].fd, &wfds))
3139 fd[i].revents |= POLLOUT;
3147 #endif /* USE_SELECT */