1 /* $NetBSD: job.c,v 1.420 2021/02/05 22:15:44 sjg 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
74 * handle the creation etc. of our child processes.
77 * Job_Init Called to initialize this module. In addition,
78 * the .BEGIN target is made including all of its
79 * dependencies before this function returns.
80 * Hence, the makefiles must have been parsed
81 * before this function is called.
83 * Job_End Clean up any memory used.
85 * Job_Make Start the creation of the given target.
88 * Check for and handle the termination of any
89 * children. This must be called reasonably
90 * frequently to keep the whole make going at
91 * a decent clip, since job table entries aren't
92 * removed until their process is caught this way.
95 * Print any output our children have produced.
96 * Should also be called fairly frequently to
97 * keep the user informed of what's going on.
98 * If no output is waiting, it will block for
99 * a time given by the SEL_* constants, below,
100 * or until output is ready.
102 * Job_ParseShell Given a special dependency line with target '.SHELL',
103 * define the shell that is used for the creation
104 * commands in jobs mode.
106 * Job_Finish Perform any final processing which needs doing.
107 * This includes the execution of any commands
108 * which have been/were attached to the .END
109 * target. It should only be called when the
110 * job table is empty.
112 * Job_AbortAll Abort all currently running jobs. Do not handle
113 * output or do anything for the jobs, just kill them.
114 * Should only be called in an emergency.
117 * Verify that the commands for a target are
118 * ok. Provide them if necessary and possible.
120 * Job_Touch Update a target without really updating it.
122 * Job_Wait Wait for all currently-running jobs to finish.
128 #include <sys/types.h>
129 #include <sys/stat.h>
130 #include <sys/file.h>
131 #include <sys/time.h>
135 #if !defined(USE_SELECT) && defined(HAVE_POLL_H)
138 #ifndef USE_SELECT /* no poll.h */
141 #if defined(HAVE_SYS_SELECT_H)
142 # include <sys/select.h>
147 #if defined(HAVE_SYS_SOCKET_H)
148 # include <sys/socket.h>
154 #include "pathnames.h"
157 /* "@(#)job.c 8.2 (Berkeley) 3/19/94" */
158 MAKE_RCSID("$NetBSD: job.c,v 1.420 2021/02/05 22:15:44 sjg Exp $");
161 * A shell defines how the commands are run. All commands for a target are
162 * written into a single file, which is then given to the shell to execute
163 * the commands from it. The commands are written to the file using a few
164 * templates for echo control and error control.
166 * The name of the shell is the basename for the predefined shells, such as
167 * "sh", "csh", "bash". For custom shells, it is the full pathname, and its
168 * basename is used to select the type of shell; the longest match wins.
169 * So /usr/pkg/bin/bash has type sh, /usr/local/bin/tcsh has type csh.
171 * The echoing of command lines is controlled using hasEchoCtl, echoOff,
172 * echoOn, noPrint and noPrintLen. When echoOff is executed by the shell, it
173 * still outputs something, but this something is not interesting, therefore
174 * it is filtered out using noPrint and noPrintLen.
176 * The error checking for individual commands is controlled using hasErrCtl,
177 * errOn, errOff and runChkTmpl.
179 * In case a shell doesn't have error control, echoTmpl is a printf template
180 * for echoing the command, should echoing be on; runIgnTmpl is another
181 * printf template for executing the command while ignoring the return
182 * status. Finally runChkTmpl is a printf template for running the command and
183 * causing the shell to exit on error. If any of these strings are empty when
184 * hasErrCtl is FALSE, the command will be executed anyway as is, and if it
185 * causes an error, so be it. Any templates set up to echo the command will
186 * escape any '$ ` \ "' characters in the command string to avoid unwanted
187 * shell code injection, the escaped command is safe to use in double quotes.
189 * The command-line flags "echo" and "exit" also control the behavior. The
190 * "echo" flag causes the shell to start echoing commands right away. The
191 * "exit" flag causes the shell to exit when an error is detected in one of
194 typedef struct Shell {
197 * The name of the shell. For Bourne and C shells, this is used only
198 * to find the shell description when used as the single source of a
199 * .SHELL target. For user-defined shells, this is the full path of
204 Boolean hasEchoCtl; /* whether both echoOff and echoOn are there */
205 const char *echoOff; /* command to turn echoing off */
206 const char *echoOn; /* command to turn echoing back on */
207 const char *noPrint; /* text to skip when printing output from the
208 * shell. This is usually the same as echoOff */
209 size_t noPrintLen; /* length of noPrint command */
211 Boolean hasErrCtl; /* whether error checking can be controlled
212 * for individual commands */
213 const char *errOn; /* command to turn on error checking */
214 const char *errOff; /* command to turn off error checking */
216 const char *echoTmpl; /* template to echo a command */
217 const char *runIgnTmpl; /* template to run a command
218 * without error checking */
219 const char *runChkTmpl; /* template to run a command
220 * with error checking */
222 /* string literal that results in a newline character when it appears
223 * outside of any 'quote' or "quote" characters */
225 char commentChar; /* character used by shell for comment lines */
227 const char *echoFlag; /* shell flag to echo commands */
228 const char *errFlag; /* shell flag to exit on error */
231 typedef struct CommandFlags {
232 /* Whether to echo the command before or instead of running it. */
235 /* Run the command even in -n or -N mode. */
239 * true if we turned error checking off before printing the command
240 * and need to turn it back on
246 * Write shell commands to a file.
248 * TODO: keep track of whether commands are echoed.
249 * TODO: keep track of whether error checking is active.
251 typedef struct ShellWriter {
254 /* we've sent 'set -x' */
260 * FreeBSD: traditionally .MAKE is not required to
261 * pass jobs queue to sub-makes.
262 * Use .MAKE.ALWAYS_PASS_JOB_QUEUE=no to disable.
264 #define MAKE_ALWAYS_PASS_JOB_QUEUE ".MAKE.ALWAYS_PASS_JOB_QUEUE"
265 static int Always_pass_job_queue = TRUE;
267 * FreeBSD: aborting entire parallel make isn't always
268 * desired. When doing tinderbox for example, failure of
269 * one architecture should not stop all.
270 * We still want to bail on interrupt though.
272 #define MAKE_JOB_ERROR_TOKEN "MAKE_JOB_ERROR_TOKEN"
273 static int Job_error_token = TRUE;
276 * error handling variables
278 static int job_errors = 0; /* number of errors reported */
279 typedef enum AbortReason { /* why is the make aborting? */
281 ABORT_ERROR, /* Because of an error */
282 ABORT_INTERRUPT, /* Because it was interrupted */
283 ABORT_WAIT /* Waiting for jobs to finish */
284 /* XXX: "WAIT" is not a _reason_ for aborting, it's rather a status. */
286 static AbortReason aborting = ABORT_NONE;
287 #define JOB_TOKENS "+EI+" /* Token to requeue for each abort state */
290 * this tracks the number of tokens currently "out" to build jobs.
292 int jobTokensRunning = 0;
294 typedef enum JobStartResult {
295 JOB_RUNNING, /* Job is running */
296 JOB_ERROR, /* Error in starting the job */
297 JOB_FINISHED /* The job is already finished */
301 * Descriptions for various shells.
303 * The build environment may set DEFSHELL_INDEX to one of
304 * DEFSHELL_INDEX_SH, DEFSHELL_INDEX_KSH, or DEFSHELL_INDEX_CSH, to
305 * select one of the predefined shells as the default shell.
307 * Alternatively, the build environment may set DEFSHELL_CUSTOM to the
308 * name or the full path of a sh-compatible shell, which will be used as
311 * ".SHELL" lines in Makefiles can choose the default shell from the
312 * set defined here, or add additional shells.
315 #ifdef DEFSHELL_CUSTOM
316 #define DEFSHELL_INDEX_CUSTOM 0
317 #define DEFSHELL_INDEX_SH 1
318 #define DEFSHELL_INDEX_KSH 2
319 #define DEFSHELL_INDEX_CSH 3
320 #else /* !DEFSHELL_CUSTOM */
321 #define DEFSHELL_INDEX_SH 0
322 #define DEFSHELL_INDEX_KSH 1
323 #define DEFSHELL_INDEX_CSH 2
324 #endif /* !DEFSHELL_CUSTOM */
326 #ifndef DEFSHELL_INDEX
327 #define DEFSHELL_INDEX 0 /* DEFSHELL_INDEX_CUSTOM or DEFSHELL_INDEX_SH */
328 #endif /* !DEFSHELL_INDEX */
330 static Shell shells[] = {
331 #ifdef DEFSHELL_CUSTOM
333 * An sh-compatible shell with a non-standard name.
335 * Keep this in sync with the "sh" description below, but avoid
336 * non-portable features that might not be supplied by all
337 * sh-compatible shells.
340 DEFSHELL_CUSTOM, /* .name */
341 FALSE, /* .hasEchoCtl */
346 FALSE, /* .hasErrCtl */
349 "echo \"%s\"\n", /* .echoTmpl */
350 "%s\n", /* .runIgnTmpl */
351 "{ %s \n} || exit $?\n", /* .runChkTmpl */
352 "'\n'", /* .newline */
353 '#', /* .commentChar */
357 #endif /* DEFSHELL_CUSTOM */
359 * SH description. Echo control is also possible and, under
360 * sun UNIX anyway, one can even control error checking.
364 FALSE, /* .hasEchoCtl */
369 FALSE, /* .hasErrCtl */
372 "echo \"%s\"\n", /* .echoTmpl */
373 "%s\n", /* .runIgnTmpl */
374 "{ %s \n} || exit $?\n", /* .runChkTmpl */
375 "'\n'", /* .newline */
376 '#', /* .commentChar*/
377 #if defined(MAKE_NATIVE) && defined(__NetBSD__)
378 /* XXX: -q is not really echoFlag, it's more like noEchoInSysFlag. */
390 TRUE, /* .hasEchoCtl */
391 "set +v", /* .echoOff */
392 "set -v", /* .echoOn */
393 "set +v", /* .noPrint */
395 FALSE, /* .hasErrCtl */
398 "echo \"%s\"\n", /* .echoTmpl */
399 "%s\n", /* .runIgnTmpl */
400 "{ %s \n} || exit $?\n", /* .runChkTmpl */
401 "'\n'", /* .newline */
402 '#', /* .commentChar */
407 * CSH description. The csh can do echo control by playing
408 * with the setting of the 'echo' shell variable. Sadly,
409 * however, it is unable to do error control nicely.
413 TRUE, /* .hasEchoCtl */
414 "unset verbose", /* .echoOff */
415 "set verbose", /* .echoOn */
416 "unset verbose", /* .noPrint */
417 13, /* .noPrintLen */
418 FALSE, /* .hasErrCtl */
421 "echo \"%s\"\n", /* .echoTmpl */
422 "csh -c \"%s || exit 0\"\n", /* .runIgnTmpl */
423 "", /* .runChkTmpl */
424 "'\\\n'", /* .newline */
425 '#', /* .commentChar */
432 * This is the shell to which we pass all commands in the Makefile.
433 * It is set by the Job_ParseShell function.
435 static Shell *shell = &shells[DEFSHELL_INDEX];
436 const char *shellPath = NULL; /* full pathname of executable image */
437 const char *shellName = NULL; /* last component of shellPath */
438 char *shellErrFlag = NULL;
439 static char *shell_freeIt = NULL; /* Allocated memory for custom .SHELL */
442 static Job *job_table; /* The structures that describe them */
443 static Job *job_table_end; /* job_table + maxJobs */
444 static unsigned int wantToken; /* we want a token */
445 static Boolean lurking_children = FALSE;
446 static Boolean make_suspended = FALSE; /* Whether we've seen a SIGTSTP (etc) */
449 * Set of descriptors of pipes connected to
450 * the output channels of children
452 static struct pollfd *fds = NULL;
453 static Job **jobByFdIndex = NULL;
454 static nfds_t fdsLen = 0;
455 static void watchfd(Job *);
456 static void clearfd(Job *);
457 static Boolean readyfd(Job *);
459 static char *targPrefix = NULL; /* To identify a job change in the output. */
460 static Job tokenWaitJob; /* token wait pseudo-job */
462 static Job childExitJob; /* child exit pseudo-job */
463 #define CHILD_EXIT "."
464 #define DO_JOB_RESUME "R"
467 npseudojobs = 2 /* number of pseudo-jobs */
470 static sigset_t caught_signals; /* Set of signals we handle */
471 static volatile sig_atomic_t caught_sigchld;
473 static void JobDoOutput(Job *, Boolean);
474 static void JobInterrupt(Boolean, int) MAKE_ATTR_DEAD;
475 static void JobRestartJobs(void);
476 static void JobSigReset(void);
479 SwitchOutputTo(GNode *gn)
481 /* The node for which output was most recently produced. */
482 static GNode *lastNode = NULL;
488 if (opts.maxJobs != 1 && targPrefix != NULL && targPrefix[0] != '\0')
489 (void)fprintf(stdout, "%s %s ---\n", targPrefix, gn->name);
495 #if defined(USE_FILEMON) && !defined(USE_FILEMON_DEV)
503 Job_FlagsToString(const Job *job, char *buf, size_t bufsize)
505 snprintf(buf, bufsize, "%c%c%c",
506 job->ignerr ? 'i' : '-',
507 !job->echo ? 's' : '-',
508 job->special ? 'S' : '-');
512 job_table_dump(const char *where)
517 debug_printf("job table @ %s\n", where);
518 for (job = job_table; job < job_table_end; job++) {
519 Job_FlagsToString(job, flags, sizeof flags);
520 debug_printf("job %d, status %d, flags %s, pid %d\n",
521 (int)(job - job_table), job->status, flags, job->pid);
526 * Delete the target of a failed, interrupted, or otherwise
527 * unsuccessful job unless inhibited by .PRECIOUS.
530 JobDeleteTarget(GNode *gn)
534 if (gn->type & OP_JOIN)
536 if (gn->type & OP_PHONY)
538 if (Targ_Precious(gn))
543 file = GNode_Path(gn);
544 if (eunlink(file) != -1)
545 Error("*** %s removed", file);
549 * JobSigLock/JobSigUnlock
551 * Signal lock routines to get exclusive access. Currently used to
552 * protect `jobs' and `stoppedJobs' list manipulations.
555 JobSigLock(sigset_t *omaskp)
557 if (sigprocmask(SIG_BLOCK, &caught_signals, omaskp) != 0) {
558 Punt("JobSigLock: sigprocmask: %s", strerror(errno));
564 JobSigUnlock(sigset_t *omaskp)
566 (void)sigprocmask(SIG_SETMASK, omaskp, NULL);
570 JobCreatePipe(Job *job, int minfd)
575 if (pipe(pipe_fds) == -1)
576 Punt("Cannot create pipe: %s", strerror(errno));
578 for (i = 0; i < 2; i++) {
579 /* Avoid using low numbered fds */
580 fd = fcntl(pipe_fds[i], F_DUPFD, minfd);
587 job->inPipe = pipe_fds[0];
588 job->outPipe = pipe_fds[1];
590 /* Set close-on-exec flag for both */
591 if (fcntl(job->inPipe, F_SETFD, FD_CLOEXEC) == -1)
592 Punt("Cannot set close-on-exec: %s", strerror(errno));
593 if (fcntl(job->outPipe, F_SETFD, FD_CLOEXEC) == -1)
594 Punt("Cannot set close-on-exec: %s", strerror(errno));
597 * We mark the input side of the pipe non-blocking; we poll(2) the
598 * pipe when we're waiting for a job token, but we might lose the
599 * race for the token when a new one becomes available, so the read
600 * from the pipe should not block.
602 flags = fcntl(job->inPipe, F_GETFL, 0);
604 Punt("Cannot get flags: %s", strerror(errno));
606 if (fcntl(job->inPipe, F_SETFL, flags) == -1)
607 Punt("Cannot set flags: %s", strerror(errno));
610 /* Pass the signal to each running job. */
612 JobCondPassSig(int signo)
616 DEBUG1(JOB, "JobCondPassSig(%d) called.\n", signo);
618 for (job = job_table; job < job_table_end; job++) {
619 if (job->status != JOB_ST_RUNNING)
621 DEBUG2(JOB, "JobCondPassSig passing signal %d to child %d.\n",
623 KILLPG(job->pid, signo);
630 * Sends a token on the child exit pipe to wake us up from select()/poll().
634 JobChildSig(int signo MAKE_ATTR_UNUSED)
637 while (write(childExitJob.outPipe, CHILD_EXIT, 1) == -1 &&
643 /* Resume all stopped jobs. */
646 JobContinueSig(int signo MAKE_ATTR_UNUSED)
649 * Defer sending SIGCONT to our stopped children until we return
650 * from the signal handler.
652 while (write(childExitJob.outPipe, DO_JOB_RESUME, 1) == -1 &&
658 * Pass a signal on to all jobs, then resend to ourselves.
659 * We die by the same signal.
661 MAKE_ATTR_DEAD static void
662 JobPassSig_int(int signo)
664 /* Run .INTERRUPT target then exit */
665 JobInterrupt(TRUE, signo);
669 * Pass a signal on to all jobs, then resend to ourselves.
670 * We die by the same signal.
672 MAKE_ATTR_DEAD static void
673 JobPassSig_term(int signo)
675 /* Dont run .INTERRUPT target then exit */
676 JobInterrupt(FALSE, signo);
680 JobPassSig_suspend(int signo)
682 sigset_t nmask, omask;
683 struct sigaction act;
685 /* Suppress job started/continued messages */
686 make_suspended = TRUE;
688 /* Pass the signal onto every job */
689 JobCondPassSig(signo);
692 * Send ourselves the signal now we've given the message to everyone
693 * else. Note we block everything else possible while we're getting
694 * the signal. This ensures that all our jobs get continued when we
695 * wake up before we take any other signal.
698 sigdelset(&nmask, signo);
699 (void)sigprocmask(SIG_SETMASK, &nmask, &omask);
701 act.sa_handler = SIG_DFL;
702 sigemptyset(&act.sa_mask);
704 (void)sigaction(signo, &act, NULL);
706 DEBUG1(JOB, "JobPassSig passing signal %d to self.\n", signo);
708 (void)kill(getpid(), signo);
711 * We've been continued.
713 * A whole host of signals continue to happen!
714 * SIGCHLD for any processes that actually suspended themselves.
715 * SIGCHLD for any processes that exited while we were alseep.
716 * The SIGCONT that actually caused us to wakeup.
718 * Since we defer passing the SIGCONT on to our children until
719 * the main processing loop, we can be sure that all the SIGCHLD
720 * events will have happened by then - and that the waitpid() will
721 * collect the child 'suspended' events.
722 * For correct sequencing we just need to ensure we process the
723 * waitpid() before passing on the SIGCONT.
725 * In any case nothing else is needed here.
728 /* Restore handler and signal mask */
729 act.sa_handler = JobPassSig_suspend;
730 (void)sigaction(signo, &act, NULL);
731 (void)sigprocmask(SIG_SETMASK, &omask, NULL);
735 JobFindPid(int pid, JobStatus status, Boolean isJobs)
739 for (job = job_table; job < job_table_end; job++) {
740 if (job->status == status && job->pid == pid)
743 if (DEBUG(JOB) && isJobs)
744 job_table_dump("no pid");
748 /* Parse leading '@', '-' and '+', which control the exact execution mode. */
750 ParseCommandFlags(char **pp, CommandFlags *out_cmdFlags)
753 out_cmdFlags->echo = TRUE;
754 out_cmdFlags->ignerr = FALSE;
755 out_cmdFlags->always = FALSE;
759 out_cmdFlags->echo = DEBUG(LOUD);
761 out_cmdFlags->ignerr = TRUE;
763 out_cmdFlags->always = TRUE;
769 pp_skip_whitespace(&p);
774 /* Escape a string for a double-quoted string literal in sh, csh and ksh. */
776 EscapeShellDblQuot(const char *cmd)
780 /* Worst that could happen is every char needs escaping. */
781 char *esc = bmake_malloc(strlen(cmd) * 2 + 1);
782 for (i = 0, j = 0; cmd[i] != '\0'; i++, j++) {
783 if (cmd[i] == '$' || cmd[i] == '`' || cmd[i] == '\\' ||
794 ShellWriter_PrintFmt(ShellWriter *wr, const char *fmt, const char *arg)
796 DEBUG1(JOB, fmt, arg);
798 (void)fprintf(wr->f, fmt, arg);
799 /* XXX: Is flushing needed in any case, or only if f == stdout? */
804 ShellWriter_Println(ShellWriter *wr, const char *line)
806 ShellWriter_PrintFmt(wr, "%s\n", line);
810 ShellWriter_EchoOff(ShellWriter *wr)
812 if (shell->hasEchoCtl)
813 ShellWriter_Println(wr, shell->echoOff);
817 ShellWriter_EchoCmd(ShellWriter *wr, const char *escCmd)
819 ShellWriter_PrintFmt(wr, shell->echoTmpl, escCmd);
823 ShellWriter_EchoOn(ShellWriter *wr)
825 if (shell->hasEchoCtl)
826 ShellWriter_Println(wr, shell->echoOn);
830 ShellWriter_TraceOn(ShellWriter *wr)
833 ShellWriter_Println(wr, "set -x");
839 ShellWriter_ErrOff(ShellWriter *wr, Boolean echo)
842 ShellWriter_EchoOff(wr);
843 ShellWriter_Println(wr, shell->errOff);
845 ShellWriter_EchoOn(wr);
849 ShellWriter_ErrOn(ShellWriter *wr, Boolean echo)
852 ShellWriter_EchoOff(wr);
853 ShellWriter_Println(wr, shell->errOn);
855 ShellWriter_EchoOn(wr);
859 * The shell has no built-in error control, so emulate error control by
860 * enclosing each shell command in a template like "{ %s \n } || exit $?"
861 * (configurable per shell).
864 JobPrintSpecialsEchoCtl(Job *job, ShellWriter *wr, CommandFlags *inout_cmdFlags,
865 const char *escCmd, const char **inout_cmdTemplate)
867 /* XXX: Why is the job modified at this point? */
870 if (job->echo && inout_cmdFlags->echo) {
871 ShellWriter_EchoOff(wr);
872 ShellWriter_EchoCmd(wr, escCmd);
875 * Leave echoing off so the user doesn't see the commands
876 * for toggling the error checking.
878 inout_cmdFlags->echo = FALSE;
880 if (inout_cmdFlags->echo)
881 ShellWriter_EchoCmd(wr, escCmd);
883 *inout_cmdTemplate = shell->runIgnTmpl;
886 * The template runIgnTmpl already takes care of ignoring errors,
887 * so pretend error checking is still on.
888 * XXX: What effects does this have, and why is it necessary?
890 inout_cmdFlags->ignerr = FALSE;
894 JobPrintSpecials(Job *job, ShellWriter *wr, const char *escCmd, Boolean run,
895 CommandFlags *inout_cmdFlags, const char **inout_cmdTemplate)
899 * If there is no command to run, there is no need to switch
900 * error checking off and on again for nothing.
902 inout_cmdFlags->ignerr = FALSE;
903 } else if (shell->hasErrCtl)
904 ShellWriter_ErrOff(wr, job->echo && inout_cmdFlags->echo);
905 else if (shell->runIgnTmpl != NULL && shell->runIgnTmpl[0] != '\0') {
906 JobPrintSpecialsEchoCtl(job, wr, inout_cmdFlags, escCmd,
909 inout_cmdFlags->ignerr = FALSE;
913 * Put out another command for the given job.
915 * If the command starts with '@' and neither the -s nor the -n flag was
916 * given to make, we stick a shell-specific echoOff command in the script.
918 * If the command starts with '-' and the shell has no error control (none
919 * of the predefined shells has that), we ignore errors for the entire job.
920 * XXX: Why ignore errors for the entire job?
921 * XXX: Even ignore errors for the commands before this command?
923 * If the command is just "...", all further commands of this job are skipped
924 * for now. They are attached to the .END node and will be run by Job_Finish
925 * after all other targets have been made.
928 JobPrintCommand(Job *job, ShellWriter *wr, StringListNode *ln, const char *ucmd)
932 CommandFlags cmdFlags;
933 /* Template for printing a command to the shell file */
934 const char *cmdTemplate;
935 char *xcmd; /* The expanded command */
937 char *escCmd; /* xcmd escaped to be used in double quotes */
939 run = GNode_ShouldExecute(job->node);
941 Var_Subst(ucmd, job->node, VARE_WANTRES, &xcmd);
942 /* TODO: handle errors */
945 cmdTemplate = "%s\n";
947 ParseCommandFlags(&xcmd, &cmdFlags);
949 /* The '+' command flag overrides the -n or -N options. */
950 if (cmdFlags.always && !run) {
952 * We're not actually executing anything...
953 * but this one needs to be - use compat mode just for it.
955 Compat_RunCommand(ucmd, job->node, ln);
961 * If the shell doesn't have error control, the alternate echoing
962 * will be done (to avoid showing additional error checking code)
963 * and this needs some characters escaped.
965 escCmd = shell->hasErrCtl ? NULL : EscapeShellDblQuot(xcmd);
967 if (!cmdFlags.echo) {
968 if (job->echo && run && shell->hasEchoCtl) {
969 ShellWriter_EchoOff(wr);
971 if (shell->hasErrCtl)
972 cmdFlags.echo = TRUE;
976 if (cmdFlags.ignerr) {
977 JobPrintSpecials(job, wr, escCmd, run, &cmdFlags, &cmdTemplate);
981 * If errors are being checked and the shell doesn't have
982 * error control but does supply an runChkTmpl template, then
983 * set up commands to run through it.
986 if (!shell->hasErrCtl && shell->runChkTmpl != NULL &&
987 shell->runChkTmpl[0] != '\0') {
988 if (job->echo && cmdFlags.echo) {
989 ShellWriter_EchoOff(wr);
990 ShellWriter_EchoCmd(wr, escCmd);
991 cmdFlags.echo = FALSE;
994 * If it's a comment line or blank, avoid the possible
995 * syntax error generated by "{\n} || exit $?".
997 cmdTemplate = escCmd[0] == shell->commentChar ||
1000 : shell->runChkTmpl;
1001 cmdFlags.ignerr = FALSE;
1005 if (DEBUG(SHELL) && strcmp(shellName, "sh") == 0)
1006 ShellWriter_TraceOn(wr);
1008 ShellWriter_PrintFmt(wr, cmdTemplate, xcmd);
1012 if (cmdFlags.ignerr)
1013 ShellWriter_ErrOn(wr, cmdFlags.echo && job->echo);
1016 ShellWriter_EchoOn(wr);
1020 * Print all commands to the shell file that is later executed.
1022 * The special command "..." stops printing and saves the remaining commands
1023 * to be executed later, when the target '.END' is made.
1025 * Return whether at least one command was written to the shell file.
1028 JobPrintCommands(Job *job)
1031 Boolean seen = FALSE;
1032 ShellWriter wr = { job->cmdFILE, FALSE };
1034 for (ln = job->node->commands.first; ln != NULL; ln = ln->next) {
1035 const char *cmd = ln->datum;
1037 if (strcmp(cmd, "...") == 0) {
1038 job->node->type |= OP_SAVE_CMDS;
1039 job->tailCmds = ln->next;
1043 JobPrintCommand(job, &wr, ln, ln->datum);
1051 * Save the delayed commands (those after '...'), to be executed later in
1052 * the '.END' node, when everything else is done.
1055 JobSaveCommands(Job *job)
1059 for (ln = job->tailCmds; ln != NULL; ln = ln->next) {
1060 const char *cmd = ln->datum;
1063 * XXX: This Var_Subst is only intended to expand the dynamic
1064 * variables such as .TARGET, .IMPSRC. It is not intended to
1065 * expand the other variables as well; see deptgt-end.mk.
1067 (void)Var_Subst(cmd, job->node, VARE_WANTRES, &expanded_cmd);
1068 /* TODO: handle errors */
1069 Lst_Append(&Targ_GetEndNode()->commands, expanded_cmd);
1074 /* Called to close both input and output pipes when a job is finished. */
1076 JobClosePipes(Job *job)
1079 (void)close(job->outPipe);
1082 JobDoOutput(job, TRUE);
1083 (void)close(job->inPipe);
1088 JobFinishDoneExitedError(Job *job, WAIT_T *inout_status)
1090 SwitchOutputTo(job->node);
1093 meta_job_error(job, job->node,
1094 job->ignerr, WEXITSTATUS(*inout_status));
1097 if (!shouldDieQuietly(job->node, -1)) {
1098 (void)printf("*** [%s] Error code %d%s\n",
1099 job->node->name, WEXITSTATUS(*inout_status),
1100 job->ignerr ? " (ignored)" : "");
1104 WAIT_STATUS(*inout_status) = 0;
1107 JobDeleteTarget(job->node);
1108 PrintOnError(job->node, NULL);
1113 JobFinishDoneExited(Job *job, WAIT_T *inout_status)
1115 DEBUG2(JOB, "Process %d [%s] exited.\n", job->pid, job->node->name);
1117 if (WEXITSTATUS(*inout_status) != 0)
1118 JobFinishDoneExitedError(job, inout_status);
1119 else if (DEBUG(JOB)) {
1120 SwitchOutputTo(job->node);
1121 (void)printf("*** [%s] Completed successfully\n",
1127 JobFinishDoneSignaled(Job *job, WAIT_T status)
1129 SwitchOutputTo(job->node);
1130 (void)printf("*** [%s] Signal %d\n", job->node->name, WTERMSIG(status));
1132 JobDeleteTarget(job->node);
1136 JobFinishDone(Job *job, WAIT_T *inout_status)
1138 if (WIFEXITED(*inout_status))
1139 JobFinishDoneExited(job, inout_status);
1141 JobFinishDoneSignaled(job, *inout_status);
1143 (void)fflush(stdout);
1147 * Do final processing for the given job including updating parent nodes and
1148 * starting new jobs as available/necessary.
1150 * Deferred commands for the job are placed on the .END node.
1152 * If there was a serious error (job_errors != 0; not an ignored one), no more
1153 * jobs will be started.
1157 * status sub-why job went away
1160 JobFinish (Job *job, WAIT_T status)
1162 Boolean done, return_job_token;
1164 DEBUG3(JOB, "JobFinish: %d [%s], status %d\n",
1165 job->pid, job->node->name, status);
1167 if ((WIFEXITED(status) &&
1168 ((WEXITSTATUS(status) != 0 && !job->ignerr))) ||
1169 WIFSIGNALED(status)) {
1170 /* Finished because of an error. */
1173 if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
1174 (void)fclose(job->cmdFILE);
1175 job->cmdFILE = NULL;
1179 } else if (WIFEXITED(status)) {
1181 * Deal with ignored errors in -B mode. We need to print a
1182 * message telling of the ignored error as well as to run
1185 done = WEXITSTATUS(status) != 0;
1190 /* No need to close things down or anything. */
1195 JobFinishDone(job, &status);
1199 int meta_status = meta_job_finish(job);
1200 if (meta_status != 0 && status == 0)
1201 status = meta_status;
1205 return_job_token = FALSE;
1207 Trace_Log(JOBEND, job);
1208 if (!job->special) {
1209 if (WAIT_STATUS(status) != 0 ||
1210 (aborting == ABORT_ERROR) || aborting == ABORT_INTERRUPT)
1211 return_job_token = TRUE;
1214 if (aborting != ABORT_ERROR && aborting != ABORT_INTERRUPT &&
1215 (WAIT_STATUS(status) == 0)) {
1217 * As long as we aren't aborting and the job didn't return a
1218 * non-zero status that we shouldn't ignore, we call
1219 * Make_Update to update the parents.
1221 JobSaveCommands(job);
1222 job->node->made = MADE;
1224 return_job_token = TRUE;
1225 Make_Update(job->node);
1226 job->status = JOB_ST_FREE;
1227 } else if (status != 0) {
1229 job->status = JOB_ST_FREE;
1232 if (job_errors > 0 && !opts.keepgoing && aborting != ABORT_INTERRUPT) {
1233 /* Prevent more jobs from getting started. */
1234 aborting = ABORT_ERROR;
1237 if (return_job_token)
1240 if (aborting == ABORT_ERROR && jobTokensRunning == 0)
1245 TouchRegular(GNode *gn)
1247 const char *file = GNode_Path(gn);
1248 struct utimbuf times = { now, now };
1252 if (utime(file, ×) >= 0)
1255 fd = open(file, O_RDWR | O_CREAT, 0666);
1257 (void)fprintf(stderr, "*** couldn't touch %s: %s\n",
1258 file, strerror(errno));
1259 (void)fflush(stderr);
1260 return; /* XXX: What about propagating the error? */
1263 /* Last resort: update the file's time stamps in the traditional way.
1264 * XXX: This doesn't work for empty files, which are sometimes used
1265 * as marker files. */
1266 if (read(fd, &c, 1) == 1) {
1267 (void)lseek(fd, 0, SEEK_SET);
1268 while (write(fd, &c, 1) == -1 && errno == EAGAIN)
1271 (void)close(fd); /* XXX: What about propagating the error? */
1275 * Touch the given target. Called by JobStart when the -t flag was given.
1277 * The modification date of the file is changed.
1278 * If the file did not exist, it is created.
1281 Job_Touch(GNode *gn, Boolean echo)
1284 (OP_JOIN | OP_USE | OP_USEBEFORE | OP_EXEC | OP_OPTIONAL |
1285 OP_SPECIAL | OP_PHONY)) {
1287 * These are "virtual" targets and should not really be
1293 if (echo || !GNode_ShouldExecute(gn)) {
1294 (void)fprintf(stdout, "touch %s\n", gn->name);
1295 (void)fflush(stdout);
1298 if (!GNode_ShouldExecute(gn))
1301 if (gn->type & OP_ARCHV)
1303 else if (gn->type & OP_LIB)
1310 * Make sure the given node has all the commands it needs.
1312 * The node will have commands from the .DEFAULT rule added to it if it
1316 * gn The target whose commands need verifying
1317 * abortProc Function to abort with message
1320 * TRUE if the commands list is/was ok.
1323 Job_CheckCommands(GNode *gn, void (*abortProc)(const char *, ...))
1325 if (GNode_IsTarget(gn))
1327 if (!Lst_IsEmpty(&gn->commands))
1329 if ((gn->type & OP_LIB) && !Lst_IsEmpty(&gn->children))
1333 * No commands. Look for .DEFAULT rule from which we might infer
1336 if (defaultNode != NULL && !Lst_IsEmpty(&defaultNode->commands) &&
1337 !(gn->type & OP_SPECIAL)) {
1339 * The traditional Make only looks for a .DEFAULT if the node
1340 * was never the target of an operator, so that's what we do
1343 * The .DEFAULT node acts like a transformation rule, in that
1344 * gn also inherits any attributes or sources attached to
1347 Make_HandleUse(defaultNode, gn);
1348 Var_Set(gn, IMPSRC, GNode_VarTarget(gn));
1352 Dir_UpdateMTime(gn, FALSE);
1353 if (gn->mtime != 0 || (gn->type & OP_SPECIAL))
1357 * The node wasn't the target of an operator. We have no .DEFAULT
1358 * rule to go on and the target doesn't already exist. There's
1359 * nothing more we can do for this branch. If the -k flag wasn't
1360 * given, we stop in our tracks, otherwise we just don't update
1361 * this node's parents so they never get examined.
1364 if (gn->flags & FROM_DEPEND) {
1365 if (!Job_RunTarget(".STALE", gn->fname))
1367 "%s: %s, %d: ignoring stale %s for %s\n",
1368 progname, gn->fname, gn->lineno, makeDependfile,
1373 if (gn->type & OP_OPTIONAL) {
1374 (void)fprintf(stdout, "%s: don't know how to make %s (%s)\n",
1375 progname, gn->name, "ignored");
1376 (void)fflush(stdout);
1380 if (opts.keepgoing) {
1381 (void)fprintf(stdout, "%s: don't know how to make %s (%s)\n",
1382 progname, gn->name, "continuing");
1383 (void)fflush(stdout);
1387 abortProc("%s: don't know how to make %s. Stop", progname, gn->name);
1392 * Execute the shell for the given job.
1394 * See Job_CatchOutput for handling the output of the shell.
1397 JobExec(Job *job, char **argv)
1399 int cpid; /* ID of new child */
1405 debug_printf("Running %s\n", job->node->name);
1406 debug_printf("\tCommand: ");
1407 for (i = 0; argv[i] != NULL; i++) {
1408 debug_printf("%s ", argv[i]);
1414 * Some jobs produce no output and it's disconcerting to have
1415 * no feedback of their running (since they produce no output, the
1416 * banner with their name in it never appears). This is an attempt to
1417 * provide that feedback, even if nothing follows it.
1420 SwitchOutputTo(job->node);
1422 /* No interruptions until this job is on the `jobs' list */
1425 /* Pre-emptively mark job running, pid still zero though */
1426 job->status = JOB_ST_RUNNING;
1432 Punt("Cannot vfork: %s", strerror(errno));
1440 meta_job_child(job);
1444 * Reset all signal handlers; this is necessary because we
1445 * also need to unblock signals before we exec(2).
1449 /* Now unblock signals */
1450 sigemptyset(&tmask);
1451 JobSigUnlock(&tmask);
1454 * Must duplicate the input stream down to the child's input
1455 * and reset it to the beginning (again). Since the stream
1456 * was marked close-on-exec, we must clear that bit in the
1459 if (dup2(fileno(job->cmdFILE), 0) == -1)
1460 execDie("dup2", "job->cmdFILE");
1461 if (fcntl(0, F_SETFD, 0) == -1)
1462 execDie("fcntl clear close-on-exec", "stdin");
1463 if (lseek(0, 0, SEEK_SET) == -1)
1464 execDie("lseek to 0", "stdin");
1466 if (Always_pass_job_queue ||
1467 (job->node->type & (OP_MAKE | OP_SUBMAKE))) {
1469 * Pass job token pipe to submakes.
1471 if (fcntl(tokenWaitJob.inPipe, F_SETFD, 0) == -1)
1472 execDie("clear close-on-exec",
1473 "tokenWaitJob.inPipe");
1474 if (fcntl(tokenWaitJob.outPipe, F_SETFD, 0) == -1)
1475 execDie("clear close-on-exec",
1476 "tokenWaitJob.outPipe");
1480 * Set up the child's output to be routed through the pipe
1481 * we've created for it.
1483 if (dup2(job->outPipe, 1) == -1)
1484 execDie("dup2", "job->outPipe");
1487 * The output channels are marked close on exec. This bit
1488 * was duplicated by the dup2(on some systems), so we have
1489 * to clear it before routing the shell's error output to
1490 * the same place as its standard output.
1492 if (fcntl(1, F_SETFD, 0) == -1)
1493 execDie("clear close-on-exec", "stdout");
1494 if (dup2(1, 2) == -1)
1495 execDie("dup2", "1, 2");
1498 * We want to switch the child into a different process
1499 * family so we can kill it and all its descendants in
1500 * one fell swoop, by killing its process family, but not
1503 #if defined(HAVE_SETPGID)
1504 (void)setpgid(0, getpid());
1506 # if defined(HAVE_SETSID)
1507 /* XXX: dsl - I'm sure this should be setpgrp()... */
1510 (void)setpgrp(0, getpid());
1514 (void)execv(shellPath, argv);
1515 execDie("exec", shellPath);
1518 /* Parent, continuing after the child exec */
1521 Trace_Log(JOBSTART, job);
1525 meta_job_parent(job, cpid);
1530 * Set the current position in the buffer to the beginning
1531 * and mark another stream to watch in the outputs mask
1537 if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
1538 (void)fclose(job->cmdFILE);
1539 job->cmdFILE = NULL;
1542 /* Now that the job is actually running, add it to the table. */
1544 debug_printf("JobExec(%s): pid %d added to jobs table\n",
1545 job->node->name, job->pid);
1546 job_table_dump("job started");
1548 JobSigUnlock(&mask);
1551 /* Create the argv needed to execute the shell for a given job. */
1553 JobMakeArgv(Job *job, char **argv)
1556 static char args[10]; /* For merged arguments */
1558 argv[0] = UNCONST(shellName);
1561 if ((shell->errFlag != NULL && shell->errFlag[0] != '-') ||
1562 (shell->echoFlag != NULL && shell->echoFlag[0] != '-')) {
1564 * At least one of the flags doesn't have a minus before it,
1565 * so merge them together. Have to do this because the Bourne
1566 * shell thinks its second argument is a file to source.
1567 * Grrrr. Note the ten-character limitation on the combined
1570 * TODO: Research until when the above comments were
1571 * practically relevant.
1573 (void)snprintf(args, sizeof args, "-%s%s",
1575 (shell->errFlag != NULL ? shell->errFlag : "")),
1577 (shell->echoFlag != NULL ? shell->echoFlag : "")));
1579 if (args[1] != '\0') {
1584 if (!job->ignerr && shell->errFlag != NULL) {
1585 argv[argc] = UNCONST(shell->errFlag);
1588 if (job->echo && shell->echoFlag != NULL) {
1589 argv[argc] = UNCONST(shell->echoFlag);
1597 JobWriteShellCommands(Job *job, GNode *gn, Boolean cmdsOK, Boolean *out_run)
1600 * tfile is the name of a file into which all shell commands
1601 * are put. It is removed before the child shell is executed,
1602 * unless DEBUG(SCRIPT) is set.
1604 char tfile[MAXPATHLEN];
1605 int tfd; /* File descriptor to the temp file */
1608 * We're serious here, but if the commands were bogus, we're
1612 PrintOnError(gn, NULL); /* provide some clue */
1616 tfd = Job_TempFile(TMPPAT, tfile, sizeof tfile);
1618 job->cmdFILE = fdopen(tfd, "w+");
1619 if (job->cmdFILE == NULL)
1620 Punt("Could not fdopen %s", tfile);
1622 (void)fcntl(fileno(job->cmdFILE), F_SETFD, FD_CLOEXEC);
1626 meta_job_start(job, gn);
1627 if (gn->type & OP_SILENT) /* might have changed */
1632 *out_run = JobPrintCommands(job);
1636 * Start a target-creation process going for the target described by the
1640 * gn target to create
1641 * flags flags for the job to override normal ones.
1642 * previous The previous Job structure for this node, if any.
1645 * JOB_ERROR if there was an error in the commands, JOB_FINISHED
1646 * if there isn't actually anything left to do for the job and
1647 * JOB_RUNNING if the job has been started.
1650 * A new Job node is created and added to the list of running
1651 * jobs. PMake is forked and a child shell created.
1653 * NB: The return value is ignored by everyone.
1655 static JobStartResult
1656 JobStart(GNode *gn, Boolean special)
1658 Job *job; /* new job descriptor */
1659 char *argv[10]; /* Argument vector to shell */
1660 Boolean cmdsOK; /* true if the nodes commands were all right */
1663 for (job = job_table; job < job_table_end; job++) {
1664 if (job->status == JOB_ST_FREE)
1667 if (job >= job_table_end)
1668 Punt("JobStart no job slots vacant");
1670 memset(job, 0, sizeof *job);
1672 job->tailCmds = NULL;
1673 job->status = JOB_ST_SET_UP;
1675 job->special = special || gn->type & OP_SPECIAL;
1676 job->ignerr = opts.ignoreErrors || gn->type & OP_IGNORE;
1677 job->echo = !(opts.beSilent || gn->type & OP_SILENT);
1680 * Check the commands now so any attributes from .DEFAULT have a
1681 * chance to migrate to the node.
1683 cmdsOK = Job_CheckCommands(gn, Error);
1685 job->inPollfd = NULL;
1687 if (Lst_IsEmpty(&gn->commands)) {
1688 job->cmdFILE = stdout;
1690 } else if (((gn->type & OP_MAKE) && !opts.noRecursiveExecute) ||
1691 (!opts.noExecute && !opts.touchFlag)) {
1693 * The above condition looks very similar to
1694 * GNode_ShouldExecute but is subtly different. It prevents
1695 * that .MAKE targets are touched since these are usually
1699 JobWriteShellCommands(job, gn, cmdsOK, &run);
1700 (void)fflush(job->cmdFILE);
1701 } else if (!GNode_ShouldExecute(gn)) {
1703 * Just print all the commands to stdout in one fell swoop.
1704 * This still sets up job->tailCmds correctly.
1707 job->cmdFILE = stdout;
1709 JobPrintCommands(job);
1711 (void)fflush(job->cmdFILE);
1713 Job_Touch(gn, job->echo);
1717 /* If we're not supposed to execute a shell, don't. */
1721 /* Unlink and close the command file if we opened one */
1722 if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
1723 (void)fclose(job->cmdFILE);
1724 job->cmdFILE = NULL;
1728 * We only want to work our way up the graph if we aren't
1729 * here because the commands for the job were no good.
1731 if (cmdsOK && aborting == ABORT_NONE) {
1732 JobSaveCommands(job);
1733 job->node->made = MADE;
1734 Make_Update(job->node);
1736 job->status = JOB_ST_FREE;
1737 return cmdsOK ? JOB_FINISHED : JOB_ERROR;
1741 * Set up the control arguments to the shell. This is based on the
1742 * flags set earlier for this job.
1744 JobMakeArgv(job, argv);
1746 /* Create the pipe by which we'll get the shell's output. */
1747 JobCreatePipe(job, 3);
1754 * Print the output of the shell command, skipping the noPrint text of the
1755 * shell, if any. The default shell does not have noPrint though, which means
1756 * that in all practical cases, handling the output is left to the caller.
1759 JobOutput(char *cp, char *endp) /* XXX: should all be const */
1761 char *ecp; /* XXX: should be const */
1763 if (shell->noPrint == NULL || shell->noPrint[0] == '\0')
1767 * XXX: What happens if shell->noPrint occurs on the boundary of
1768 * the buffer? To work correctly in all cases, this should rather
1769 * be a proper stream filter instead of doing string matching on
1770 * selected chunks of the output.
1772 while ((ecp = strstr(cp, shell->noPrint)) != NULL) {
1774 *ecp = '\0'; /* XXX: avoid writing to the buffer */
1776 * The only way there wouldn't be a newline after
1777 * this line is if it were the last in the buffer.
1778 * however, since the noPrint output comes after it,
1779 * there must be a newline, so we don't print one.
1781 /* XXX: What about null bytes in the output? */
1782 (void)fprintf(stdout, "%s", cp);
1783 (void)fflush(stdout);
1785 cp = ecp + shell->noPrintLen;
1788 cp++; /* skip over the (XXX: assumed) newline */
1789 pp_skip_whitespace(&cp);
1795 * This function is called whenever there is something to read on the pipe.
1796 * We collect more output from the given job and store it in the job's
1797 * outBuf. If this makes up a line, we print it tagged by the job's
1798 * identifier, as necessary.
1800 * In the output of the shell, the 'noPrint' lines are removed. If the
1801 * command is not alone on the line (the character after it is not \0 or
1802 * \n), we do print whatever follows it.
1805 * job the job whose output needs printing
1806 * finish TRUE if this is the last time we'll be called
1810 JobDoOutput(Job *job, Boolean finish)
1812 Boolean gotNL; /* true if got a newline */
1813 Boolean fbuf; /* true if our buffer filled up */
1814 size_t nr; /* number of bytes read */
1815 size_t i; /* auxiliary index into outBuf */
1816 size_t max; /* limit for i (end of current data) */
1817 ssize_t nRead; /* (Temporary) number of bytes read */
1819 /* Read as many bytes as will fit in the buffer. */
1824 nRead = read(job->inPipe, &job->outBuf[job->curPos],
1825 JOB_BUFSIZE - job->curPos);
1827 if (errno == EAGAIN)
1830 perror("JobDoOutput(piperead)");
1838 * If we hit the end-of-file (the job is dead), we must flush its
1839 * remaining output, so pretend we read a newline if there's any
1840 * output remaining in the buffer.
1841 * Also clear the 'finish' flag so we stop looping.
1843 if (nr == 0 && job->curPos != 0) {
1844 job->outBuf[job->curPos] = '\n';
1847 } else if (nr == 0) {
1852 * Look for the last newline in the bytes we just got. If there is
1853 * one, break out of the loop with 'i' as its index and gotNL set
1856 max = job->curPos + nr;
1857 for (i = job->curPos + nr - 1;
1858 i >= job->curPos && i != (size_t)-1; i--) {
1859 if (job->outBuf[i] == '\n') {
1862 } else if (job->outBuf[i] == '\0') {
1866 job->outBuf[i] = ' ';
1872 if (job->curPos == JOB_BUFSIZE) {
1874 * If we've run out of buffer space, we have no choice
1875 * but to print the stuff. sigh.
1881 if (gotNL || fbuf) {
1883 * Need to send the output to the screen. Null terminate it
1884 * first, overwriting the newline character if there was one.
1885 * So long as the line isn't one we should filter (according
1886 * to the shell description), we print the line, preceded
1887 * by a target banner if this target isn't the same as the
1888 * one for which we last printed something.
1889 * The rest of the data in the buffer are then shifted down
1890 * to the start of the buffer and curPos is set accordingly.
1892 job->outBuf[i] = '\0';
1893 if (i >= job->curPos) {
1896 cp = JobOutput(job->outBuf, &job->outBuf[i]);
1899 * There's still more in that thar buffer. This time,
1900 * though, we know there's no newline at the end, so
1901 * we add one of our own free will.
1905 SwitchOutputTo(job->node);
1908 meta_job_output(job, cp,
1912 (void)fprintf(stdout, "%s%s", cp,
1914 (void)fflush(stdout);
1918 * max is the last offset still in the buffer. Move any
1919 * remaining characters to the start of the buffer and
1920 * update the end marker curPos.
1923 (void)memmove(job->outBuf, &job->outBuf[i + 1],
1925 job->curPos = max - (i + 1);
1933 * If the finish flag is true, we must loop until we hit
1934 * end-of-file on the pipe. This is guaranteed to happen
1935 * eventually since the other end of the pipe is now closed
1936 * (we closed it explicitly and the child has exited). When
1937 * we do get an EOF, finish will be set FALSE and we'll fall
1949 * Unfortunately it is too complicated to run .BEGIN, .END, and
1950 * .INTERRUPT job in the parallel job module. As of 2020-09-25,
1951 * unit-tests/deptgt-end-jobs.mk hangs in an endless loop.
1953 * Running these jobs in compat mode also guarantees that these
1954 * jobs do not overlap with other unrelated jobs.
1956 GNodeList lst = LST_INIT;
1957 Lst_Append(&lst, targ);
1958 (void)Make_Run(&lst);
1960 JobStart(targ, TRUE);
1961 while (jobTokensRunning != 0) {
1965 Compat_Make(targ, targ);
1966 /* XXX: Replace with GNode_IsError(gn) */
1967 if (targ->made == ERROR) {
1968 PrintOnError(targ, "\n\nStop.");
1975 * Handle the exit of a child. Called from Make_Make.
1977 * The job descriptor is removed from the list of children.
1980 * We do waits, blocking or not, according to the wisdom of our
1981 * caller, until there are no more children to report. For each
1982 * job, call JobFinish to finish things off.
1985 Job_CatchChildren(void)
1987 int pid; /* pid of dead child */
1988 WAIT_T status; /* Exit/termination status */
1990 /* Don't even bother if we know there's no one around. */
1991 if (jobTokensRunning == 0)
1994 /* Have we received SIGCHLD since last call? */
1995 if (caught_sigchld == 0)
1999 while ((pid = waitpid((pid_t)-1, &status, WNOHANG | WUNTRACED)) > 0) {
2000 DEBUG2(JOB, "Process %d exited/stopped status %x.\n",
2001 pid, WAIT_STATUS(status));
2002 JobReapChild(pid, status, TRUE);
2007 * It is possible that wait[pid]() was called from elsewhere,
2008 * this lets us reap jobs regardless.
2011 JobReapChild(pid_t pid, WAIT_T status, Boolean isJobs)
2013 Job *job; /* job descriptor for dead child */
2015 /* Don't even bother if we know there's no one around. */
2016 if (jobTokensRunning == 0)
2019 job = JobFindPid(pid, JOB_ST_RUNNING, isJobs);
2022 if (!lurking_children)
2023 Error("Child (%d) status %x not in table?",
2026 return; /* not ours */
2028 if (WIFSTOPPED(status)) {
2029 DEBUG2(JOB, "Process %d (%s) stopped.\n",
2030 job->pid, job->node->name);
2031 if (!make_suspended) {
2032 switch (WSTOPSIG(status)) {
2034 (void)printf("*** [%s] Suspended\n",
2038 (void)printf("*** [%s] Stopped\n",
2042 (void)printf("*** [%s] Stopped -- signal %d\n",
2043 job->node->name, WSTOPSIG(status));
2045 job->suspended = TRUE;
2047 (void)fflush(stdout);
2051 job->status = JOB_ST_FINISHED;
2052 job->exit_status = WAIT_STATUS(status);
2054 JobFinish(job, status);
2058 * Catch the output from our children, if we're using pipes do so. Otherwise
2059 * just block time until we get a signal(most likely a SIGCHLD) since there's
2060 * no point in just spinning when there's nothing to do and the reaping of a
2061 * child can wait for a while.
2064 Job_CatchOutput(void)
2070 (void)fflush(stdout);
2072 /* The first fd in the list is the job token pipe */
2074 nready = poll(fds + 1 - wantToken, fdsLen - 1 + wantToken,
2076 } while (nready < 0 && errno == EINTR);
2079 Punt("poll: %s", strerror(errno));
2081 if (nready > 0 && readyfd(&childExitJob)) {
2084 count = read(childExitJob.inPipe, &token, 1);
2086 if (token == DO_JOB_RESUME[0])
2088 * Complete relay requested from our SIGCONT
2092 } else if (count == 0)
2093 Punt("unexpected eof on token pipe");
2095 Punt("token pipe read: %s", strerror(errno));
2099 Job_CatchChildren();
2103 for (i = npseudojobs * nfds_per_job(); i < fdsLen; i++) {
2104 if (fds[i].revents == 0)
2106 job = jobByFdIndex[i];
2107 if (job->status == JOB_ST_RUNNING)
2108 JobDoOutput(job, FALSE);
2109 #if defined(USE_FILEMON) && !defined(USE_FILEMON_DEV)
2111 * With meta mode, we may have activity on the job's filemon
2112 * descriptor too, which at the moment is any pollfd other
2113 * than job->inPollfd.
2115 if (useMeta && job->inPollfd != &fds[i]) {
2116 if (meta_job_event(job) <= 0) {
2117 fds[i].events = 0; /* never mind */
2127 * Start the creation of a target. Basically a front-end for JobStart used by
2133 (void)JobStart(gn, FALSE);
2137 InitShellNameAndPath(void)
2139 shellName = shell->name;
2141 #ifdef DEFSHELL_CUSTOM
2142 if (shellName[0] == '/') {
2143 shellPath = shellName;
2144 shellName = str_basename(shellPath);
2149 shellPath = str_concat3(_PATH_DEFSHELLDIR, "/", shellName);
2155 if (shellPath == NULL)
2156 InitShellNameAndPath();
2158 Var_SetWithFlags(SCOPE_CMDLINE, ".SHELL", shellPath, VAR_SET_READONLY);
2159 if (shell->errFlag == NULL)
2160 shell->errFlag = "";
2161 if (shell->echoFlag == NULL)
2162 shell->echoFlag = "";
2163 if (shell->hasErrCtl && shell->errFlag[0] != '\0') {
2164 if (shellErrFlag != NULL &&
2165 strcmp(shell->errFlag, &shellErrFlag[1]) != 0) {
2167 shellErrFlag = NULL;
2169 if (shellErrFlag == NULL) {
2170 size_t n = strlen(shell->errFlag) + 2;
2172 shellErrFlag = bmake_malloc(n);
2173 if (shellErrFlag != NULL)
2174 snprintf(shellErrFlag, n, "-%s",
2177 } else if (shellErrFlag != NULL) {
2179 shellErrFlag = NULL;
2184 * Return the string literal that is used in the current command shell
2185 * to produce a newline character.
2188 Shell_GetNewline(void)
2190 return shell->newline;
2196 if (targPrefix != NULL) {
2198 } else if (!Var_Exists(SCOPE_GLOBAL, MAKE_JOB_PREFIX)) {
2199 Global_Set(MAKE_JOB_PREFIX, "---");
2202 (void)Var_Subst("${" MAKE_JOB_PREFIX "}",
2203 SCOPE_GLOBAL, VARE_WANTRES, &targPrefix);
2204 /* TODO: handle errors */
2208 AddSig(int sig, SignalProc handler)
2210 if (bmake_signal(sig, SIG_IGN) != SIG_IGN) {
2211 sigaddset(&caught_signals, sig);
2212 (void)bmake_signal(sig, handler);
2216 /* Initialize the process module. */
2221 /* Allocate space for all the job info */
2222 job_table = bmake_malloc((size_t)opts.maxJobs * sizeof *job_table);
2223 memset(job_table, 0, (size_t)opts.maxJobs * sizeof *job_table);
2224 job_table_end = job_table + opts.maxJobs;
2228 aborting = ABORT_NONE;
2231 Always_pass_job_queue = GetBooleanVar(MAKE_ALWAYS_PASS_JOB_QUEUE,
2232 Always_pass_job_queue);
2234 Job_error_token = GetBooleanVar(MAKE_JOB_ERROR_TOKEN, Job_error_token);
2237 * There is a non-zero chance that we already have children.
2238 * eg after 'make -f- <<EOF'
2239 * Since their termination causes a 'Child (pid) not in table'
2240 * message, Collect the status of any that are already dead, and
2241 * suppress the error message if there are any undead ones.
2247 rval = waitpid((pid_t)-1, &status, WNOHANG);
2251 lurking_children = TRUE;
2257 JobCreatePipe(&childExitJob, 3);
2260 /* Preallocate enough for the maximum number of jobs. */
2261 size_t nfds = (npseudojobs + (size_t)opts.maxJobs) *
2263 fds = bmake_malloc(sizeof *fds * nfds);
2264 jobByFdIndex = bmake_malloc(sizeof *jobByFdIndex * nfds);
2267 /* These are permanent entries and take slots 0 and 1 */
2268 watchfd(&tokenWaitJob);
2269 watchfd(&childExitJob);
2271 sigemptyset(&caught_signals);
2273 * Install a SIGCHLD handler.
2275 (void)bmake_signal(SIGCHLD, JobChildSig);
2276 sigaddset(&caught_signals, SIGCHLD);
2279 * Catch the four signals that POSIX specifies if they aren't ignored.
2280 * JobPassSig will take care of calling JobInterrupt if appropriate.
2282 AddSig(SIGINT, JobPassSig_int);
2283 AddSig(SIGHUP, JobPassSig_term);
2284 AddSig(SIGTERM, JobPassSig_term);
2285 AddSig(SIGQUIT, JobPassSig_term);
2288 * There are additional signals that need to be caught and passed if
2289 * either the export system wants to be told directly of signals or if
2290 * we're giving each job its own process group (since then it won't get
2291 * signals from the terminal driver as we own the terminal)
2293 AddSig(SIGTSTP, JobPassSig_suspend);
2294 AddSig(SIGTTOU, JobPassSig_suspend);
2295 AddSig(SIGTTIN, JobPassSig_suspend);
2296 AddSig(SIGWINCH, JobCondPassSig);
2297 AddSig(SIGCONT, JobContinueSig);
2299 (void)Job_RunTarget(".BEGIN", NULL);
2300 /* Create the .END node now, even though no code in the unit tests
2301 * depends on it. See also Targ_GetEndNode in Compat_Run. */
2302 (void)Targ_GetEndNode();
2308 if (sigismember(&caught_signals, sig) != 0)
2309 (void)bmake_signal(sig, SIG_DFL);
2324 (void)bmake_signal(SIGCHLD, SIG_DFL);
2327 /* Find a shell in 'shells' given its name, or return NULL. */
2329 FindShellByName(const char *name)
2332 const Shell *shellsEnd = sh + sizeof shells / sizeof shells[0];
2334 for (sh = shells; sh < shellsEnd; sh++) {
2335 if (strcmp(name, sh->name) == 0)
2342 * Parse a shell specification and set up 'shell', shellPath and
2343 * shellName appropriately.
2346 * line The shell spec
2349 * FALSE if the specification was incorrect.
2352 * 'shell' points to a Shell structure (either predefined or
2353 * created from the shell spec), shellPath is the full path of the
2354 * shell described by 'shell', while shellName is just the
2355 * final component of shellPath.
2358 * A shell specification consists of a .SHELL target, with dependency
2359 * operator, followed by a series of blank-separated words. Double
2360 * quotes can be used to use blanks in words. A backslash escapes
2361 * anything (most notably a double-quote and a space) and
2362 * provides the functionality it does in C. Each word consists of
2363 * keyword and value separated by an equal sign. There should be no
2364 * unnecessary spaces in the word. The keywords are as follows:
2365 * name Name of shell.
2366 * path Location of shell.
2367 * quiet Command to turn off echoing.
2368 * echo Command to turn echoing on
2369 * filter Result of turning off echoing that shouldn't be
2371 * echoFlag Flag to turn echoing on at the start
2372 * errFlag Flag to turn error checking on at the start
2373 * hasErrCtl True if shell has error checking control
2374 * newline String literal to represent a newline char
2375 * check Command to turn on error checking if hasErrCtl
2376 * is TRUE or template of command to echo a command
2377 * for which error checking is off if hasErrCtl is
2379 * ignore Command to turn off error checking if hasErrCtl
2380 * is TRUE or template of command to execute a
2381 * command so as to ignore any errors it returns if
2382 * hasErrCtl is FALSE.
2385 Job_ParseShell(char *line)
2393 Boolean fullSpec = FALSE;
2396 /* XXX: don't use line as an iterator variable */
2397 pp_skip_whitespace(&line);
2401 memset(&newShell, 0, sizeof newShell);
2404 * Parse the specification by keyword
2406 wordsList = Str_Words(line, TRUE);
2407 words = wordsList.words;
2408 argc = wordsList.len;
2409 path = wordsList.freeIt;
2410 if (words == NULL) {
2411 Error("Unterminated quoted string [%s]", line);
2414 shell_freeIt = path;
2416 for (path = NULL, argv = words; argc != 0; argc--, argv++) {
2418 if (strncmp(arg, "path=", 5) == 0) {
2420 } else if (strncmp(arg, "name=", 5) == 0) {
2421 newShell.name = arg + 5;
2423 if (strncmp(arg, "quiet=", 6) == 0) {
2424 newShell.echoOff = arg + 6;
2425 } else if (strncmp(arg, "echo=", 5) == 0) {
2426 newShell.echoOn = arg + 5;
2427 } else if (strncmp(arg, "filter=", 7) == 0) {
2428 newShell.noPrint = arg + 7;
2429 newShell.noPrintLen = strlen(newShell.noPrint);
2430 } else if (strncmp(arg, "echoFlag=", 9) == 0) {
2431 newShell.echoFlag = arg + 9;
2432 } else if (strncmp(arg, "errFlag=", 8) == 0) {
2433 newShell.errFlag = arg + 8;
2434 } else if (strncmp(arg, "hasErrCtl=", 10) == 0) {
2436 newShell.hasErrCtl = c == 'Y' || c == 'y' ||
2437 c == 'T' || c == 't';
2438 } else if (strncmp(arg, "newline=", 8) == 0) {
2439 newShell.newline = arg + 8;
2440 } else if (strncmp(arg, "check=", 6) == 0) {
2441 /* Before 2020-12-10, these two variables
2442 * had been a single variable. */
2443 newShell.errOn = arg + 6;
2444 newShell.echoTmpl = arg + 6;
2445 } else if (strncmp(arg, "ignore=", 7) == 0) {
2446 /* Before 2020-12-10, these two variables
2447 * had been a single variable. */
2448 newShell.errOff = arg + 7;
2449 newShell.runIgnTmpl = arg + 7;
2450 } else if (strncmp(arg, "errout=", 7) == 0) {
2451 newShell.runChkTmpl = arg + 7;
2452 } else if (strncmp(arg, "comment=", 8) == 0) {
2453 newShell.commentChar = arg[8];
2455 Parse_Error(PARSE_FATAL,
2456 "Unknown keyword \"%s\"", arg);
2466 * If no path was given, the user wants one of the
2467 * pre-defined shells, yes? So we find the one s/he wants
2468 * with the help of FindShellByName and set things up the
2469 * right way. shellPath will be set up by Shell_Init.
2471 if (newShell.name == NULL) {
2472 Parse_Error(PARSE_FATAL,
2473 "Neither path nor name specified");
2477 if ((sh = FindShellByName(newShell.name)) == NULL) {
2478 Parse_Error(PARSE_WARNING,
2479 "%s: No matching shell", newShell.name);
2484 shellName = newShell.name;
2485 if (shellPath != NULL) {
2487 * Shell_Init has already been called!
2490 free(UNCONST(shellPath));
2497 * The user provided a path. If s/he gave nothing else
2498 * (fullSpec is FALSE), try and find a matching shell in the
2499 * ones we know of. Else we just take the specification at
2500 * its word and copy it to a new location. In either case,
2501 * we need to record the path the user gave for the shell.
2504 path = strrchr(path, '/');
2506 path = UNCONST(shellPath);
2510 if (newShell.name != NULL) {
2511 shellName = newShell.name;
2516 if ((sh = FindShellByName(shellName)) == NULL) {
2517 Parse_Error(PARSE_WARNING,
2518 "%s: No matching shell", shellName);
2524 shell = bmake_malloc(sizeof *shell);
2527 /* this will take care of shellErrFlag */
2531 if (shell->echoOn != NULL && shell->echoOff != NULL)
2532 shell->hasEchoCtl = TRUE;
2534 if (!shell->hasErrCtl) {
2535 if (shell->echoTmpl == NULL)
2536 shell->echoTmpl = "";
2537 if (shell->runIgnTmpl == NULL)
2538 shell->runIgnTmpl = "%s\n";
2542 * Do not free up the words themselves, since they might be in use
2543 * by the shell specification.
2550 * Handle the receipt of an interrupt.
2552 * All children are killed. Another job will be started if the .INTERRUPT
2553 * target is defined.
2556 * runINTERRUPT Non-zero if commands for the .INTERRUPT target
2557 * should be executed
2558 * signo signal received
2561 JobInterrupt(Boolean runINTERRUPT, int signo)
2563 Job *job; /* job descriptor in that element */
2564 GNode *interrupt; /* the node describing the .INTERRUPT target */
2568 aborting = ABORT_INTERRUPT;
2572 for (job = job_table; job < job_table_end; job++) {
2573 if (job->status != JOB_ST_RUNNING)
2578 JobDeleteTarget(gn);
2579 if (job->pid != 0) {
2581 "JobInterrupt passing signal %d to child %d.\n",
2583 KILLPG(job->pid, signo);
2587 JobSigUnlock(&mask);
2589 if (runINTERRUPT && !opts.touchFlag) {
2590 interrupt = Targ_FindNode(".INTERRUPT");
2591 if (interrupt != NULL) {
2592 opts.ignoreErrors = FALSE;
2596 Trace_Log(MAKEINTR, NULL);
2597 exit(signo); /* XXX: why signo? */
2601 * Do the final processing, i.e. run the commands attached to the .END target.
2603 * Return the number of errors reported.
2608 GNode *endNode = Targ_GetEndNode();
2609 if (!Lst_IsEmpty(&endNode->commands) ||
2610 !Lst_IsEmpty(&endNode->children)) {
2611 if (job_errors != 0) {
2612 Error("Errors reported so .END ignored");
2620 /* Clean up any memory used by the jobs module. */
2630 * Waits for all running jobs to finish and returns.
2631 * Sets 'aborting' to ABORT_WAIT to prevent other jobs from starting.
2636 aborting = ABORT_WAIT;
2637 while (jobTokensRunning != 0) {
2640 aborting = ABORT_NONE;
2644 * Abort all currently running jobs without handling output or anything.
2645 * This function is to be called only in the event of a major error.
2646 * Most definitely NOT to be called from JobInterrupt.
2648 * All children are killed, not just the firstborn.
2653 Job *job; /* the job descriptor in that element */
2656 aborting = ABORT_ERROR;
2658 if (jobTokensRunning != 0) {
2659 for (job = job_table; job < job_table_end; job++) {
2660 if (job->status != JOB_ST_RUNNING)
2663 * kill the child process with increasingly drastic
2664 * signals to make darn sure it's dead.
2666 KILLPG(job->pid, SIGINT);
2667 KILLPG(job->pid, SIGKILL);
2672 * Catch as many children as want to report in at first, then give up
2674 while (waitpid((pid_t)-1, &foo, WNOHANG) > 0)
2679 * Tries to restart stopped jobs if there are slots available.
2680 * Called in process context in response to a SIGCONT.
2683 JobRestartJobs(void)
2687 for (job = job_table; job < job_table_end; job++) {
2688 if (job->status == JOB_ST_RUNNING &&
2689 (make_suspended || job->suspended)) {
2690 DEBUG1(JOB, "Restarting stopped job pid %d.\n",
2692 if (job->suspended) {
2693 (void)printf("*** [%s] Continued\n",
2695 (void)fflush(stdout);
2697 job->suspended = FALSE;
2698 if (KILLPG(job->pid, SIGCONT) != 0 && DEBUG(JOB)) {
2699 debug_printf("Failed to send SIGCONT to %d\n",
2703 if (job->status == JOB_ST_FINISHED) {
2705 * Job exit deferred after calling waitpid() in a
2708 JobFinish(job, job->exit_status);
2711 make_suspended = FALSE;
2717 if (job->inPollfd != NULL)
2718 Punt("Watching watched job");
2720 fds[fdsLen].fd = job->inPipe;
2721 fds[fdsLen].events = POLLIN;
2722 jobByFdIndex[fdsLen] = job;
2723 job->inPollfd = &fds[fdsLen];
2725 #if defined(USE_FILEMON) && !defined(USE_FILEMON_DEV)
2727 fds[fdsLen].fd = meta_job_fd(job);
2728 fds[fdsLen].events = fds[fdsLen].fd == -1 ? 0 : POLLIN;
2729 jobByFdIndex[fdsLen] = job;
2739 if (job->inPollfd == NULL)
2740 Punt("Unwatching unwatched job");
2741 i = (size_t)(job->inPollfd - fds);
2743 #if defined(USE_FILEMON) && !defined(USE_FILEMON_DEV)
2746 * Sanity check: there should be two fds per job, so the job's
2747 * pollfd number should be even.
2749 assert(nfds_per_job() == 2);
2751 Punt("odd-numbered fd with meta");
2756 * Move last job in table into hole made by dead job.
2759 fds[i] = fds[fdsLen];
2760 jobByFdIndex[i] = jobByFdIndex[fdsLen];
2761 jobByFdIndex[i]->inPollfd = &fds[i];
2762 #if defined(USE_FILEMON) && !defined(USE_FILEMON_DEV)
2764 fds[i + 1] = fds[fdsLen + 1];
2765 jobByFdIndex[i + 1] = jobByFdIndex[fdsLen + 1];
2769 job->inPollfd = NULL;
2775 if (job->inPollfd == NULL)
2776 Punt("Polling unwatched job");
2777 return (job->inPollfd->revents & POLLIN) != 0;
2781 * Put a token (back) into the job pipe.
2782 * This allows a make process to start a build job.
2787 char tok = JOB_TOKENS[aborting], tok1;
2789 if (!Job_error_token && aborting == ABORT_ERROR) {
2790 if (jobTokensRunning == 0)
2792 tok = '+'; /* no error token */
2795 /* If we are depositing an error token flush everything else */
2796 while (tok != '+' && read(tokenWaitJob.inPipe, &tok1, 1) == 1)
2799 DEBUG3(JOB, "(%d) aborting %d, deposit token %c\n",
2800 getpid(), aborting, tok);
2801 while (write(tokenWaitJob.outPipe, &tok, 1) == -1 && errno == EAGAIN)
2805 /* Get a temp file */
2807 Job_TempFile(const char *pattern, char *tfile, size_t tfile_sz)
2813 fd = mkTempFile(pattern, tfile, tfile_sz);
2814 if (tfile != NULL && !DEBUG(SCRIPT))
2816 JobSigUnlock(&mask);
2821 /* Prep the job token pipe in the root make process. */
2823 Job_ServerStart(int max_tokens, int jp_0, int jp_1)
2828 if (jp_0 >= 0 && jp_1 >= 0) {
2829 /* Pipe passed in from parent */
2830 tokenWaitJob.inPipe = jp_0;
2831 tokenWaitJob.outPipe = jp_1;
2832 (void)fcntl(jp_0, F_SETFD, FD_CLOEXEC);
2833 (void)fcntl(jp_1, F_SETFD, FD_CLOEXEC);
2837 JobCreatePipe(&tokenWaitJob, 15);
2839 snprintf(jobarg, sizeof jobarg, "%d,%d",
2840 tokenWaitJob.inPipe, tokenWaitJob.outPipe);
2842 Global_Append(MAKEFLAGS, "-J");
2843 Global_Append(MAKEFLAGS, jobarg);
2846 * Preload the job pipe with one token per job, save the one
2847 * "extra" token for the primary job.
2849 * XXX should clip maxJobs against PIPE_BUF -- if max_tokens is
2850 * larger than the write buffer size of the pipe, we will
2853 for (i = 1; i < max_tokens; i++)
2857 /* Return a withdrawn token to the pool. */
2859 Job_TokenReturn(void)
2862 if (jobTokensRunning < 0)
2863 Punt("token botch");
2864 if (jobTokensRunning != 0 || JOB_TOKENS[aborting] != '+')
2869 * Attempt to withdraw a token from the pool.
2871 * If pool is empty, set wantToken so that we wake up when a token is
2874 * Returns TRUE if a token was withdrawn, and FALSE if the pool is currently
2878 Job_TokenWithdraw(void)
2884 DEBUG3(JOB, "Job_TokenWithdraw(%d): aborting %d, running %d\n",
2885 getpid(), aborting, jobTokensRunning);
2887 if (aborting != ABORT_NONE || (jobTokensRunning >= opts.maxJobs))
2890 count = read(tokenWaitJob.inPipe, &tok, 1);
2892 Fatal("eof on job pipe!");
2893 if (count < 0 && jobTokensRunning != 0) {
2894 if (errno != EAGAIN) {
2895 Fatal("job pipe read: %s", strerror(errno));
2897 DEBUG1(JOB, "(%d) blocked for token\n", getpid());
2902 if (count == 1 && tok != '+') {
2903 /* make being aborted - remove any other job tokens */
2904 DEBUG2(JOB, "(%d) aborted by token %c\n", getpid(), tok);
2905 while (read(tokenWaitJob.inPipe, &tok1, 1) == 1)
2907 /* And put the stopper back */
2908 while (write(tokenWaitJob.outPipe, &tok, 1) == -1 &&
2911 if (shouldDieQuietly(NULL, 1))
2912 exit(6); /* we aborted */
2913 Fatal("A failure has been detected "
2914 "in another branch of the parallel make");
2917 if (count == 1 && jobTokensRunning == 0)
2918 /* We didn't want the token really */
2919 while (write(tokenWaitJob.outPipe, &tok, 1) == -1 &&
2924 DEBUG1(JOB, "(%d) withdrew token\n", getpid());
2929 * Run the named target if found. If a filename is specified, then set that
2932 * Exits if the target fails.
2935 Job_RunTarget(const char *target, const char *fname)
2937 GNode *gn = Targ_FindNode(target);
2942 Var_Set(gn, ALLSRC, fname);
2945 /* XXX: Replace with GNode_IsError(gn) */
2946 if (gn->made == ERROR) {
2947 PrintOnError(gn, "\n\nStop.");
2955 emul_poll(struct pollfd *fd, int nfd, int timeout)
2958 int i, maxfd, nselect, npoll;
2959 struct timeval tv, *tvp;
2966 for (i = 0; i < nfd; i++) {
2969 if (fd[i].events & POLLIN)
2970 FD_SET(fd[i].fd, &rfds);
2972 if (fd[i].events & POLLOUT)
2973 FD_SET(fd[i].fd, &wfds);
2975 if (fd[i].fd > maxfd)
2979 if (maxfd >= FD_SETSIZE) {
2980 Punt("Ran out of fd_set slots; "
2981 "recompile with a larger FD_SETSIZE.");
2987 usecs = timeout * 1000;
2988 tv.tv_sec = usecs / 1000000;
2989 tv.tv_usec = usecs % 1000000;
2993 nselect = select(maxfd + 1, &rfds, &wfds, NULL, tvp);
2999 for (i = 0; i < nfd; i++) {
3000 if (FD_ISSET(fd[i].fd, &rfds))
3001 fd[i].revents |= POLLIN;
3003 if (FD_ISSET(fd[i].fd, &wfds))
3004 fd[i].revents |= POLLOUT;
3012 #endif /* USE_SELECT */