Update files for OpenSSH-6.7p1 import.
[dragonfly.git] / contrib / bmake / job.c
blobe1323914a633a1e1264fdd334e160217a982a3ac
1 /* $NetBSD: job.c,v 1.176 2013/08/04 16:48:15 sjg Exp $ */
3 /*
4 * Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
5 * All rights reserved.
7 * This code is derived from software contributed to Berkeley by
8 * Adam de Boor.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
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
32 * SUCH DAMAGE.
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
41 * Adam de Boor.
43 * Redistribution and use in source and binary forms, with or without
44 * modification, are permitted provided that the following conditions
45 * are met:
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
69 * SUCH DAMAGE.
72 #ifndef MAKE_NATIVE
73 static char rcsid[] = "$NetBSD: job.c,v 1.176 2013/08/04 16:48:15 sjg Exp $";
74 #else
75 #include <sys/cdefs.h>
76 #ifndef lint
77 #if 0
78 static char sccsid[] = "@(#)job.c 8.2 (Berkeley) 3/19/94";
79 #else
80 __RCSID("$NetBSD: job.c,v 1.176 2013/08/04 16:48:15 sjg Exp $");
81 #endif
82 #endif /* not lint */
83 #endif
85 /*-
86 * job.c --
87 * handle the creation etc. of our child processes.
89 * Interface:
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 intialize 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 * FAILURE 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.
136 #ifdef HAVE_CONFIG_H
137 # include "config.h"
138 #endif
139 #include <sys/types.h>
140 #include <sys/stat.h>
141 #include <sys/file.h>
142 #include <sys/time.h>
143 #include "wait.h"
145 #include <assert.h>
146 #include <errno.h>
147 #include <fcntl.h>
148 #if !defined(USE_SELECT) && defined(HAVE_POLL_H)
149 #include <poll.h>
150 #else
151 #ifndef USE_SELECT /* no poll.h */
152 # define USE_SELECT
153 #endif
154 #if defined(HAVE_SYS_SELECT_H)
155 # include <sys/select.h>
156 #endif
157 #endif
158 #include <signal.h>
159 #include <stdio.h>
160 #include <string.h>
161 #include <utime.h>
162 #if defined(HAVE_SYS_SOCKET_H)
163 # include <sys/socket.h>
164 #endif
166 #include "make.h"
167 #include "hash.h"
168 #include "dir.h"
169 #include "job.h"
170 #include "pathnames.h"
171 #include "trace.h"
172 # define STATIC static
175 * error handling variables
177 static int errors = 0; /* number of errors reported */
178 static int aborting = 0; /* why is the make aborting? */
179 #define ABORT_ERROR 1 /* Because of an error */
180 #define ABORT_INTERRUPT 2 /* Because it was interrupted */
181 #define ABORT_WAIT 3 /* Waiting for jobs to finish */
182 #define JOB_TOKENS "+EI+" /* Token to requeue for each abort state */
185 * this tracks the number of tokens currently "out" to build jobs.
187 int jobTokensRunning = 0;
188 int not_parallel = 0; /* set if .NOT_PARALLEL */
191 * XXX: Avoid SunOS bug... FILENO() is fp->_file, and file
192 * is a char! So when we go above 127 we turn negative!
194 #define FILENO(a) ((unsigned) fileno(a))
197 * post-make command processing. The node postCommands is really just the
198 * .END target but we keep it around to avoid having to search for it
199 * all the time.
201 static GNode *postCommands = NULL;
202 /* node containing commands to execute when
203 * everything else is done */
204 static int numCommands; /* The number of commands actually printed
205 * for a target. Should this number be
206 * 0, no shell will be executed. */
209 * Return values from JobStart.
211 #define JOB_RUNNING 0 /* Job is running */
212 #define JOB_ERROR 1 /* Error in starting the job */
213 #define JOB_FINISHED 2 /* The job is already finished */
216 * Descriptions for various shells.
218 * The build environment may set DEFSHELL_INDEX to one of
219 * DEFSHELL_INDEX_SH, DEFSHELL_INDEX_KSH, or DEFSHELL_INDEX_CSH, to
220 * select one of the prefedined shells as the default shell.
222 * Alternatively, the build environment may set DEFSHELL_CUSTOM to the
223 * name or the full path of a sh-compatible shell, which will be used as
224 * the default shell.
226 * ".SHELL" lines in Makefiles can choose the default shell from the
227 # set defined here, or add additional shells.
230 #ifdef DEFSHELL_CUSTOM
231 #define DEFSHELL_INDEX_CUSTOM 0
232 #define DEFSHELL_INDEX_SH 1
233 #define DEFSHELL_INDEX_KSH 2
234 #define DEFSHELL_INDEX_CSH 3
235 #else /* !DEFSHELL_CUSTOM */
236 #define DEFSHELL_INDEX_SH 0
237 #define DEFSHELL_INDEX_KSH 1
238 #define DEFSHELL_INDEX_CSH 2
239 #endif /* !DEFSHELL_CUSTOM */
241 #ifndef DEFSHELL_INDEX
242 #define DEFSHELL_INDEX 0 /* DEFSHELL_INDEX_CUSTOM or DEFSHELL_INDEX_SH */
243 #endif /* !DEFSHELL_INDEX */
245 static Shell shells[] = {
246 #ifdef DEFSHELL_CUSTOM
248 * An sh-compatible shell with a non-standard name.
250 * Keep this in sync with the "sh" description below, but avoid
251 * non-portable features that might not be supplied by all
252 * sh-compatible shells.
255 DEFSHELL_CUSTOM,
256 FALSE, "", "", "", 0,
257 FALSE, "echo \"%s\"\n", "%s\n", "{ %s \n} || exit $?\n", "'\n'", '#',
261 #endif /* DEFSHELL_CUSTOM */
263 * SH description. Echo control is also possible and, under
264 * sun UNIX anyway, one can even control error checking.
267 "sh",
268 FALSE, "", "", "", 0,
269 FALSE, "echo \"%s\"\n", "%s\n", "{ %s \n} || exit $?\n", "'\n'", '#',
270 #if defined(MAKE_NATIVE) && defined(__NetBSD__)
271 "q",
272 #else
274 #endif
278 * KSH description.
281 "ksh",
282 TRUE, "set +v", "set -v", "set +v", 6,
283 FALSE, "echo \"%s\"\n", "%s\n", "{ %s \n} || exit $?\n", "'\n'", '#',
284 "v",
288 * CSH description. The csh can do echo control by playing
289 * with the setting of the 'echo' shell variable. Sadly,
290 * however, it is unable to do error control nicely.
293 "csh",
294 TRUE, "unset verbose", "set verbose", "unset verbose", 10,
295 FALSE, "echo \"%s\"\n", "csh -c \"%s || exit 0\"\n", "", "'\\\n'", '#',
296 "v", "e",
299 * UNKNOWN.
302 NULL,
303 FALSE, NULL, NULL, NULL, 0,
304 FALSE, NULL, NULL, NULL, NULL, 0,
305 NULL, NULL,
308 static Shell *commandShell = &shells[DEFSHELL_INDEX]; /* this is the shell to
309 * which we pass all
310 * commands in the Makefile.
311 * It is set by the
312 * Job_ParseShell function */
313 const char *shellPath = NULL, /* full pathname of
314 * executable image */
315 *shellName = NULL; /* last component of shell */
316 char *shellErrFlag = NULL;
317 static const char *shellArgv = NULL; /* Custom shell args */
320 STATIC Job *job_table; /* The structures that describe them */
321 STATIC Job *job_table_end; /* job_table + maxJobs */
322 static int wantToken; /* we want a token */
323 static int lurking_children = 0;
324 static int make_suspended = 0; /* non-zero if we've seen a SIGTSTP (etc) */
327 * Set of descriptors of pipes connected to
328 * the output channels of children
330 static struct pollfd *fds = NULL;
331 static Job **jobfds = NULL;
332 static int nfds = 0;
333 static void watchfd(Job *);
334 static void clearfd(Job *);
335 static int readyfd(Job *);
337 STATIC GNode *lastNode; /* The node for which output was most recently
338 * produced. */
339 static char *targPrefix = NULL; /* What we print at the start of TARG_FMT */
340 static Job tokenWaitJob; /* token wait pseudo-job */
342 static Job childExitJob; /* child exit pseudo-job */
343 #define CHILD_EXIT "."
344 #define DO_JOB_RESUME "R"
346 #define TARG_FMT "%s %s ---\n" /* Default format */
347 #define MESSAGE(fp, gn) \
348 if (maxJobs != 1 && targPrefix && *targPrefix) \
349 (void)fprintf(fp, TARG_FMT, targPrefix, gn->name)
351 static sigset_t caught_signals; /* Set of signals we handle */
352 #if defined(SYSV)
353 #define KILLPG(pid, sig) kill(-(pid), (sig))
354 #else
355 #define KILLPG(pid, sig) killpg((pid), (sig))
356 #endif
358 static void JobChildSig(int);
359 static void JobContinueSig(int);
360 static Job *JobFindPid(int, int, Boolean);
361 static int JobPrintCommand(void *, void *);
362 static int JobSaveCommand(void *, void *);
363 static void JobClose(Job *);
364 static void JobExec(Job *, char **);
365 static void JobMakeArgv(Job *, char **);
366 static int JobStart(GNode *, int);
367 static char *JobOutput(Job *, char *, char *, int);
368 static void JobDoOutput(Job *, Boolean);
369 static Shell *JobMatchShell(const char *);
370 static void JobInterrupt(int, int) MAKE_ATTR_DEAD;
371 static void JobRestartJobs(void);
372 static void JobTokenAdd(void);
373 static void JobSigLock(sigset_t *);
374 static void JobSigUnlock(sigset_t *);
375 static void JobSigReset(void);
377 const char *malloc_options="A";
379 static void
380 job_table_dump(const char *where)
382 Job *job;
384 fprintf(debug_file, "job table @ %s\n", where);
385 for (job = job_table; job < job_table_end; job++) {
386 fprintf(debug_file, "job %d, status %d, flags %d, pid %d\n",
387 (int)(job - job_table), job->job_state, job->flags, job->pid);
392 * JobSigLock/JobSigUnlock
394 * Signal lock routines to get exclusive access. Currently used to
395 * protect `jobs' and `stoppedJobs' list manipulations.
397 static void JobSigLock(sigset_t *omaskp)
399 if (sigprocmask(SIG_BLOCK, &caught_signals, omaskp) != 0) {
400 Punt("JobSigLock: sigprocmask: %s", strerror(errno));
401 sigemptyset(omaskp);
405 static void JobSigUnlock(sigset_t *omaskp)
407 (void)sigprocmask(SIG_SETMASK, omaskp, NULL);
410 static void
411 JobCreatePipe(Job *job, int minfd)
413 int i, fd;
415 if (pipe(job->jobPipe) == -1)
416 Punt("Cannot create pipe: %s", strerror(errno));
418 for (i = 0; i < 2; i++) {
419 /* Avoid using low numbered fds */
420 fd = fcntl(job->jobPipe[i], F_DUPFD, minfd);
421 if (fd != -1) {
422 close(job->jobPipe[i]);
423 job->jobPipe[i] = fd;
427 /* Set close-on-exec flag for both */
428 (void)fcntl(job->jobPipe[0], F_SETFD, 1);
429 (void)fcntl(job->jobPipe[1], F_SETFD, 1);
432 * We mark the input side of the pipe non-blocking; we poll(2) the
433 * pipe when we're waiting for a job token, but we might lose the
434 * race for the token when a new one becomes available, so the read
435 * from the pipe should not block.
437 fcntl(job->jobPipe[0], F_SETFL,
438 fcntl(job->jobPipe[0], F_GETFL, 0) | O_NONBLOCK);
442 *-----------------------------------------------------------------------
443 * JobCondPassSig --
444 * Pass a signal to a job
446 * Input:
447 * signop Signal to send it
449 * Side Effects:
450 * None, except the job may bite it.
452 *-----------------------------------------------------------------------
454 static void
455 JobCondPassSig(int signo)
457 Job *job;
459 if (DEBUG(JOB)) {
460 (void)fprintf(debug_file, "JobCondPassSig(%d) called.\n", signo);
463 for (job = job_table; job < job_table_end; job++) {
464 if (job->job_state != JOB_ST_RUNNING)
465 continue;
466 if (DEBUG(JOB)) {
467 (void)fprintf(debug_file,
468 "JobCondPassSig passing signal %d to child %d.\n",
469 signo, job->pid);
471 KILLPG(job->pid, signo);
476 *-----------------------------------------------------------------------
477 * JobChldSig --
478 * SIGCHLD handler.
480 * Input:
481 * signo The signal number we've received
483 * Results:
484 * None.
486 * Side Effects:
487 * Sends a token on the child exit pipe to wake us up from
488 * select()/poll().
490 *-----------------------------------------------------------------------
492 static void
493 JobChildSig(int signo MAKE_ATTR_UNUSED)
495 while (write(childExitJob.outPipe, CHILD_EXIT, 1) == -1 && errno == EAGAIN)
496 continue;
501 *-----------------------------------------------------------------------
502 * JobContinueSig --
503 * Resume all stopped jobs.
505 * Input:
506 * signo The signal number we've received
508 * Results:
509 * None.
511 * Side Effects:
512 * Jobs start running again.
514 *-----------------------------------------------------------------------
516 static void
517 JobContinueSig(int signo MAKE_ATTR_UNUSED)
520 * Defer sending to SIGCONT to our stopped children until we return
521 * from the signal handler.
523 while (write(childExitJob.outPipe, DO_JOB_RESUME, 1) == -1 &&
524 errno == EAGAIN)
525 continue;
529 *-----------------------------------------------------------------------
530 * JobPassSig --
531 * Pass a signal on to all jobs, then resend to ourselves.
533 * Input:
534 * signo The signal number we've received
536 * Results:
537 * None.
539 * Side Effects:
540 * We die by the same signal.
542 *-----------------------------------------------------------------------
544 MAKE_ATTR_DEAD static void
545 JobPassSig_int(int signo)
547 /* Run .INTERRUPT target then exit */
548 JobInterrupt(TRUE, signo);
551 MAKE_ATTR_DEAD static void
552 JobPassSig_term(int signo)
554 /* Dont run .INTERRUPT target then exit */
555 JobInterrupt(FALSE, signo);
558 static void
559 JobPassSig_suspend(int signo)
561 sigset_t nmask, omask;
562 struct sigaction act;
564 /* Suppress job started/continued messages */
565 make_suspended = 1;
567 /* Pass the signal onto every job */
568 JobCondPassSig(signo);
571 * Send ourselves the signal now we've given the message to everyone else.
572 * Note we block everything else possible while we're getting the signal.
573 * This ensures that all our jobs get continued when we wake up before
574 * we take any other signal.
576 sigfillset(&nmask);
577 sigdelset(&nmask, signo);
578 (void)sigprocmask(SIG_SETMASK, &nmask, &omask);
580 act.sa_handler = SIG_DFL;
581 sigemptyset(&act.sa_mask);
582 act.sa_flags = 0;
583 (void)sigaction(signo, &act, NULL);
585 if (DEBUG(JOB)) {
586 (void)fprintf(debug_file,
587 "JobPassSig passing signal %d to self.\n", signo);
590 (void)kill(getpid(), signo);
593 * We've been continued.
595 * A whole host of signals continue to happen!
596 * SIGCHLD for any processes that actually suspended themselves.
597 * SIGCHLD for any processes that exited while we were alseep.
598 * The SIGCONT that actually caused us to wakeup.
600 * Since we defer passing the SIGCONT on to our children until
601 * the main processing loop, we can be sure that all the SIGCHLD
602 * events will have happened by then - and that the waitpid() will
603 * collect the child 'suspended' events.
604 * For correct sequencing we just need to ensure we process the
605 * waitpid() before passign on the SIGCONT.
607 * In any case nothing else is needed here.
610 /* Restore handler and signal mask */
611 act.sa_handler = JobPassSig_suspend;
612 (void)sigaction(signo, &act, NULL);
613 (void)sigprocmask(SIG_SETMASK, &omask, NULL);
617 *-----------------------------------------------------------------------
618 * JobFindPid --
619 * Compare the pid of the job with the given pid and return 0 if they
620 * are equal. This function is called from Job_CatchChildren
621 * to find the job descriptor of the finished job.
623 * Input:
624 * job job to examine
625 * pid process id desired
627 * Results:
628 * Job with matching pid
630 * Side Effects:
631 * None
632 *-----------------------------------------------------------------------
634 static Job *
635 JobFindPid(int pid, int status, Boolean isJobs)
637 Job *job;
639 for (job = job_table; job < job_table_end; job++) {
640 if ((job->job_state == status) && job->pid == pid)
641 return job;
643 if (DEBUG(JOB) && isJobs)
644 job_table_dump("no pid");
645 return NULL;
649 *-----------------------------------------------------------------------
650 * JobPrintCommand --
651 * Put out another command for the given job. If the command starts
652 * with an @ or a - we process it specially. In the former case,
653 * so long as the -s and -n flags weren't given to make, we stick
654 * a shell-specific echoOff command in the script. In the latter,
655 * we ignore errors for the entire job, unless the shell has error
656 * control.
657 * If the command is just "..." we take all future commands for this
658 * job to be commands to be executed once the entire graph has been
659 * made and return non-zero to signal that the end of the commands
660 * was reached. These commands are later attached to the postCommands
661 * node and executed by Job_End when all things are done.
662 * This function is called from JobStart via Lst_ForEach.
664 * Input:
665 * cmdp command string to print
666 * jobp job for which to print it
668 * Results:
669 * Always 0, unless the command was "..."
671 * Side Effects:
672 * If the command begins with a '-' and the shell has no error control,
673 * the JOB_IGNERR flag is set in the job descriptor.
674 * If the command is "..." and we're not ignoring such things,
675 * tailCmds is set to the successor node of the cmd.
676 * numCommands is incremented if the command is actually printed.
677 *-----------------------------------------------------------------------
679 static int
680 JobPrintCommand(void *cmdp, void *jobp)
682 Boolean noSpecials; /* true if we shouldn't worry about
683 * inserting special commands into
684 * the input stream. */
685 Boolean shutUp = FALSE; /* true if we put a no echo command
686 * into the command file */
687 Boolean errOff = FALSE; /* true if we turned error checking
688 * off before printing the command
689 * and need to turn it back on */
690 const char *cmdTemplate; /* Template to use when printing the
691 * command */
692 char *cmdStart; /* Start of expanded command */
693 char *escCmd = NULL; /* Command with quotes/backticks escaped */
694 char *cmd = (char *)cmdp;
695 Job *job = (Job *)jobp;
696 int i, j;
698 noSpecials = NoExecute(job->node);
700 if (strcmp(cmd, "...") == 0) {
701 job->node->type |= OP_SAVE_CMDS;
702 if ((job->flags & JOB_IGNDOTS) == 0) {
703 job->tailCmds = Lst_Succ(Lst_Member(job->node->commands,
704 cmd));
705 return 1;
707 return 0;
710 #define DBPRINTF(fmt, arg) if (DEBUG(JOB)) { \
711 (void)fprintf(debug_file, fmt, arg); \
713 (void)fprintf(job->cmdFILE, fmt, arg); \
714 (void)fflush(job->cmdFILE);
716 numCommands += 1;
718 cmdStart = cmd = Var_Subst(NULL, cmd, job->node, FALSE);
720 cmdTemplate = "%s\n";
723 * Check for leading @' and -'s to control echoing and error checking.
725 while (*cmd == '@' || *cmd == '-' || (*cmd == '+')) {
726 switch (*cmd) {
727 case '@':
728 shutUp = DEBUG(LOUD) ? FALSE : TRUE;
729 break;
730 case '-':
731 job->flags |= JOB_IGNERR;
732 errOff = TRUE;
733 break;
734 case '+':
735 if (noSpecials) {
737 * We're not actually executing anything...
738 * but this one needs to be - use compat mode just for it.
740 CompatRunCommand(cmdp, job->node);
741 return 0;
743 break;
745 cmd++;
748 while (isspace((unsigned char) *cmd))
749 cmd++;
752 * If the shell doesn't have error control the alternate echo'ing will
753 * be done (to avoid showing additional error checking code)
754 * and this will need the characters '$ ` \ "' escaped
757 if (!commandShell->hasErrCtl) {
758 /* Worst that could happen is every char needs escaping. */
759 escCmd = bmake_malloc((strlen(cmd) * 2) + 1);
760 for (i = 0, j= 0; cmd[i] != '\0'; i++, j++) {
761 if (cmd[i] == '$' || cmd[i] == '`' || cmd[i] == '\\' ||
762 cmd[i] == '"')
763 escCmd[j++] = '\\';
764 escCmd[j] = cmd[i];
766 escCmd[j] = 0;
769 if (shutUp) {
770 if (!(job->flags & JOB_SILENT) && !noSpecials &&
771 commandShell->hasEchoCtl) {
772 DBPRINTF("%s\n", commandShell->echoOff);
773 } else {
774 if (commandShell->hasErrCtl)
775 shutUp = FALSE;
779 if (errOff) {
780 if (!noSpecials) {
781 if (commandShell->hasErrCtl) {
783 * we don't want the error-control commands showing
784 * up either, so we turn off echoing while executing
785 * them. We could put another field in the shell
786 * structure to tell JobDoOutput to look for this
787 * string too, but why make it any more complex than
788 * it already is?
790 if (!(job->flags & JOB_SILENT) && !shutUp &&
791 commandShell->hasEchoCtl) {
792 DBPRINTF("%s\n", commandShell->echoOff);
793 DBPRINTF("%s\n", commandShell->ignErr);
794 DBPRINTF("%s\n", commandShell->echoOn);
795 } else {
796 DBPRINTF("%s\n", commandShell->ignErr);
798 } else if (commandShell->ignErr &&
799 (*commandShell->ignErr != '\0'))
802 * The shell has no error control, so we need to be
803 * weird to get it to ignore any errors from the command.
804 * If echoing is turned on, we turn it off and use the
805 * errCheck template to echo the command. Leave echoing
806 * off so the user doesn't see the weirdness we go through
807 * to ignore errors. Set cmdTemplate to use the weirdness
808 * instead of the simple "%s\n" template.
810 if (!(job->flags & JOB_SILENT) && !shutUp) {
811 if (commandShell->hasEchoCtl) {
812 DBPRINTF("%s\n", commandShell->echoOff);
814 DBPRINTF(commandShell->errCheck, escCmd);
815 shutUp = TRUE;
816 } else {
817 if (!shutUp) {
818 DBPRINTF(commandShell->errCheck, escCmd);
821 cmdTemplate = commandShell->ignErr;
823 * The error ignoration (hee hee) is already taken care
824 * of by the ignErr template, so pretend error checking
825 * is still on.
827 errOff = FALSE;
828 } else {
829 errOff = FALSE;
831 } else {
832 errOff = FALSE;
834 } else {
837 * If errors are being checked and the shell doesn't have error control
838 * but does supply an errOut template, then setup commands to run
839 * through it.
842 if (!commandShell->hasErrCtl && commandShell->errOut &&
843 (*commandShell->errOut != '\0')) {
844 if (!(job->flags & JOB_SILENT) && !shutUp) {
845 if (commandShell->hasEchoCtl) {
846 DBPRINTF("%s\n", commandShell->echoOff);
848 DBPRINTF(commandShell->errCheck, escCmd);
849 shutUp = TRUE;
851 /* If it's a comment line or blank, treat as an ignored error */
852 if ((escCmd[0] == commandShell->commentChar) ||
853 (escCmd[0] == 0))
854 cmdTemplate = commandShell->ignErr;
855 else
856 cmdTemplate = commandShell->errOut;
857 errOff = FALSE;
861 if (DEBUG(SHELL) && strcmp(shellName, "sh") == 0 &&
862 (job->flags & JOB_TRACED) == 0) {
863 DBPRINTF("set -%s\n", "x");
864 job->flags |= JOB_TRACED;
867 DBPRINTF(cmdTemplate, cmd);
868 free(cmdStart);
869 if (escCmd)
870 free(escCmd);
871 if (errOff) {
873 * If echoing is already off, there's no point in issuing the
874 * echoOff command. Otherwise we issue it and pretend it was on
875 * for the whole command...
877 if (!shutUp && !(job->flags & JOB_SILENT) && commandShell->hasEchoCtl){
878 DBPRINTF("%s\n", commandShell->echoOff);
879 shutUp = TRUE;
881 DBPRINTF("%s\n", commandShell->errCheck);
883 if (shutUp && commandShell->hasEchoCtl) {
884 DBPRINTF("%s\n", commandShell->echoOn);
886 return 0;
890 *-----------------------------------------------------------------------
891 * JobSaveCommand --
892 * Save a command to be executed when everything else is done.
893 * Callback function for JobFinish...
895 * Results:
896 * Always returns 0
898 * Side Effects:
899 * The command is tacked onto the end of postCommands's commands list.
901 *-----------------------------------------------------------------------
903 static int
904 JobSaveCommand(void *cmd, void *gn)
906 cmd = Var_Subst(NULL, (char *)cmd, (GNode *)gn, FALSE);
907 (void)Lst_AtEnd(postCommands->commands, cmd);
908 return(0);
913 *-----------------------------------------------------------------------
914 * JobClose --
915 * Called to close both input and output pipes when a job is finished.
917 * Results:
918 * Nada
920 * Side Effects:
921 * The file descriptors associated with the job are closed.
923 *-----------------------------------------------------------------------
925 static void
926 JobClose(Job *job)
928 clearfd(job);
929 (void)close(job->outPipe);
930 job->outPipe = -1;
932 JobDoOutput(job, TRUE);
933 (void)close(job->inPipe);
934 job->inPipe = -1;
938 *-----------------------------------------------------------------------
939 * JobFinish --
940 * Do final processing for the given job including updating
941 * parents and starting new jobs as available/necessary. Note
942 * that we pay no attention to the JOB_IGNERR flag here.
943 * This is because when we're called because of a noexecute flag
944 * or something, jstat.w_status is 0 and when called from
945 * Job_CatchChildren, the status is zeroed if it s/b ignored.
947 * Input:
948 * job job to finish
949 * status sub-why job went away
951 * Results:
952 * None
954 * Side Effects:
955 * Final commands for the job are placed on postCommands.
957 * If we got an error and are aborting (aborting == ABORT_ERROR) and
958 * the job list is now empty, we are done for the day.
959 * If we recognized an error (errors !=0), we set the aborting flag
960 * to ABORT_ERROR so no more jobs will be started.
961 *-----------------------------------------------------------------------
963 /*ARGSUSED*/
964 static void
965 JobFinish (Job *job, WAIT_T status)
967 Boolean done, return_job_token;
969 if (DEBUG(JOB)) {
970 fprintf(debug_file, "Jobfinish: %d [%s], status %d\n",
971 job->pid, job->node->name, status);
974 if ((WIFEXITED(status) &&
975 (((WEXITSTATUS(status) != 0) && !(job->flags & JOB_IGNERR)))) ||
976 WIFSIGNALED(status))
979 * If it exited non-zero and either we're doing things our
980 * way or we're not ignoring errors, the job is finished.
981 * Similarly, if the shell died because of a signal
982 * the job is also finished. In these
983 * cases, finish out the job's output before printing the exit
984 * status...
986 JobClose(job);
987 if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
988 (void)fclose(job->cmdFILE);
989 job->cmdFILE = NULL;
991 done = TRUE;
992 } else if (WIFEXITED(status)) {
994 * Deal with ignored errors in -B mode. We need to print a message
995 * telling of the ignored error as well as setting status.w_status
996 * to 0 so the next command gets run. To do this, we set done to be
997 * TRUE if in -B mode and the job exited non-zero.
999 done = WEXITSTATUS(status) != 0;
1001 * Old comment said: "Note we don't
1002 * want to close down any of the streams until we know we're at the
1003 * end."
1004 * But we do. Otherwise when are we going to print the rest of the
1005 * stuff?
1007 JobClose(job);
1008 } else {
1010 * No need to close things down or anything.
1012 done = FALSE;
1015 if (done) {
1016 if (WIFEXITED(status)) {
1017 if (DEBUG(JOB)) {
1018 (void)fprintf(debug_file, "Process %d [%s] exited.\n",
1019 job->pid, job->node->name);
1021 if (WEXITSTATUS(status) != 0) {
1022 if (job->node != lastNode) {
1023 MESSAGE(stdout, job->node);
1024 lastNode = job->node;
1026 #ifdef USE_META
1027 if (useMeta) {
1028 meta_job_error(job, job->node, job->flags, WEXITSTATUS(status));
1030 #endif
1031 (void)printf("*** [%s] Error code %d%s\n",
1032 job->node->name,
1033 WEXITSTATUS(status),
1034 (job->flags & JOB_IGNERR) ? " (ignored)" : "");
1035 if (job->flags & JOB_IGNERR) {
1036 WAIT_STATUS(status) = 0;
1037 } else {
1038 PrintOnError(job->node, NULL);
1040 } else if (DEBUG(JOB)) {
1041 if (job->node != lastNode) {
1042 MESSAGE(stdout, job->node);
1043 lastNode = job->node;
1045 (void)printf("*** [%s] Completed successfully\n",
1046 job->node->name);
1048 } else {
1049 if (job->node != lastNode) {
1050 MESSAGE(stdout, job->node);
1051 lastNode = job->node;
1053 (void)printf("*** [%s] Signal %d\n",
1054 job->node->name, WTERMSIG(status));
1056 (void)fflush(stdout);
1059 #ifdef USE_META
1060 if (useMeta) {
1061 meta_job_finish(job);
1063 #endif
1065 return_job_token = FALSE;
1067 Trace_Log(JOBEND, job);
1068 if (!(job->flags & JOB_SPECIAL)) {
1069 if ((WAIT_STATUS(status) != 0) ||
1070 (aborting == ABORT_ERROR) ||
1071 (aborting == ABORT_INTERRUPT))
1072 return_job_token = TRUE;
1075 if ((aborting != ABORT_ERROR) && (aborting != ABORT_INTERRUPT) &&
1076 (WAIT_STATUS(status) == 0)) {
1078 * As long as we aren't aborting and the job didn't return a non-zero
1079 * status that we shouldn't ignore, we call Make_Update to update
1080 * the parents. In addition, any saved commands for the node are placed
1081 * on the .END target.
1083 if (job->tailCmds != NULL) {
1084 Lst_ForEachFrom(job->node->commands, job->tailCmds,
1085 JobSaveCommand,
1086 job->node);
1088 job->node->made = MADE;
1089 if (!(job->flags & JOB_SPECIAL))
1090 return_job_token = TRUE;
1091 Make_Update(job->node);
1092 job->job_state = JOB_ST_FREE;
1093 } else if (WAIT_STATUS(status)) {
1094 errors += 1;
1095 job->job_state = JOB_ST_FREE;
1099 * Set aborting if any error.
1101 if (errors && !keepgoing && (aborting != ABORT_INTERRUPT)) {
1103 * If we found any errors in this batch of children and the -k flag
1104 * wasn't given, we set the aborting flag so no more jobs get
1105 * started.
1107 aborting = ABORT_ERROR;
1110 if (return_job_token)
1111 Job_TokenReturn();
1113 if (aborting == ABORT_ERROR && jobTokensRunning == 0) {
1115 * If we are aborting and the job table is now empty, we finish.
1117 Finish(errors);
1122 *-----------------------------------------------------------------------
1123 * Job_Touch --
1124 * Touch the given target. Called by JobStart when the -t flag was
1125 * given
1127 * Input:
1128 * gn the node of the file to touch
1129 * silent TRUE if should not print message
1131 * Results:
1132 * None
1134 * Side Effects:
1135 * The data modification of the file is changed. In addition, if the
1136 * file did not exist, it is created.
1137 *-----------------------------------------------------------------------
1139 void
1140 Job_Touch(GNode *gn, Boolean silent)
1142 int streamID; /* ID of stream opened to do the touch */
1143 struct utimbuf times; /* Times for utime() call */
1145 if (gn->type & (OP_JOIN|OP_USE|OP_USEBEFORE|OP_EXEC|OP_OPTIONAL|
1146 OP_SPECIAL|OP_PHONY)) {
1148 * .JOIN, .USE, .ZEROTIME and .OPTIONAL targets are "virtual" targets
1149 * and, as such, shouldn't really be created.
1151 return;
1154 if (!silent || NoExecute(gn)) {
1155 (void)fprintf(stdout, "touch %s\n", gn->name);
1156 (void)fflush(stdout);
1159 if (NoExecute(gn)) {
1160 return;
1163 if (gn->type & OP_ARCHV) {
1164 Arch_Touch(gn);
1165 } else if (gn->type & OP_LIB) {
1166 Arch_TouchLib(gn);
1167 } else {
1168 char *file = gn->path ? gn->path : gn->name;
1170 times.actime = times.modtime = now;
1171 if (utime(file, &times) < 0){
1172 streamID = open(file, O_RDWR | O_CREAT, 0666);
1174 if (streamID >= 0) {
1175 char c;
1178 * Read and write a byte to the file to change the
1179 * modification time, then close the file.
1181 if (read(streamID, &c, 1) == 1) {
1182 (void)lseek(streamID, (off_t)0, SEEK_SET);
1183 while (write(streamID, &c, 1) == -1 && errno == EAGAIN)
1184 continue;
1187 (void)close(streamID);
1188 } else {
1189 (void)fprintf(stdout, "*** couldn't touch %s: %s",
1190 file, strerror(errno));
1191 (void)fflush(stdout);
1198 *-----------------------------------------------------------------------
1199 * Job_CheckCommands --
1200 * Make sure the given node has all the commands it needs.
1202 * Input:
1203 * gn The target whose commands need verifying
1204 * abortProc Function to abort with message
1206 * Results:
1207 * TRUE if the commands list is/was ok.
1209 * Side Effects:
1210 * The node will have commands from the .DEFAULT rule added to it
1211 * if it needs them.
1212 *-----------------------------------------------------------------------
1214 Boolean
1215 Job_CheckCommands(GNode *gn, void (*abortProc)(const char *, ...))
1217 if (OP_NOP(gn->type) && Lst_IsEmpty(gn->commands) &&
1218 ((gn->type & OP_LIB) == 0 || Lst_IsEmpty(gn->children))) {
1220 * No commands. Look for .DEFAULT rule from which we might infer
1221 * commands
1223 if ((DEFAULT != NULL) && !Lst_IsEmpty(DEFAULT->commands) &&
1224 (gn->type & OP_SPECIAL) == 0) {
1225 char *p1;
1227 * Make only looks for a .DEFAULT if the node was never the
1228 * target of an operator, so that's what we do too. If
1229 * a .DEFAULT was given, we substitute its commands for gn's
1230 * commands and set the IMPSRC variable to be the target's name
1231 * The DEFAULT node acts like a transformation rule, in that
1232 * gn also inherits any attributes or sources attached to
1233 * .DEFAULT itself.
1235 Make_HandleUse(DEFAULT, gn);
1236 Var_Set(IMPSRC, Var_Value(TARGET, gn, &p1), gn, 0);
1237 if (p1)
1238 free(p1);
1239 } else if (Dir_MTime(gn, 0) == 0 && (gn->type & OP_SPECIAL) == 0) {
1241 * The node wasn't the target of an operator we have no .DEFAULT
1242 * rule to go on and the target doesn't already exist. There's
1243 * nothing more we can do for this branch. If the -k flag wasn't
1244 * given, we stop in our tracks, otherwise we just don't update
1245 * this node's parents so they never get examined.
1247 static const char msg[] = ": don't know how to make";
1249 if (gn->flags & FROM_DEPEND) {
1250 if (!Job_RunTarget(".STALE", gn->fname))
1251 fprintf(stdout, "%s: %s, %d: ignoring stale %s for %s\n",
1252 progname, gn->fname, gn->lineno, makeDependfile,
1253 gn->name);
1254 return TRUE;
1257 if (gn->type & OP_OPTIONAL) {
1258 (void)fprintf(stdout, "%s%s %s (ignored)\n", progname,
1259 msg, gn->name);
1260 (void)fflush(stdout);
1261 } else if (keepgoing) {
1262 (void)fprintf(stdout, "%s%s %s (continuing)\n", progname,
1263 msg, gn->name);
1264 (void)fflush(stdout);
1265 return FALSE;
1266 } else {
1267 (*abortProc)("%s%s %s. Stop", progname, msg, gn->name);
1268 return FALSE;
1272 return TRUE;
1276 *-----------------------------------------------------------------------
1277 * JobExec --
1278 * Execute the shell for the given job. Called from JobStart
1280 * Input:
1281 * job Job to execute
1283 * Results:
1284 * None.
1286 * Side Effects:
1287 * A shell is executed, outputs is altered and the Job structure added
1288 * to the job table.
1290 *-----------------------------------------------------------------------
1292 static void
1293 JobExec(Job *job, char **argv)
1295 int cpid; /* ID of new child */
1296 sigset_t mask;
1298 job->flags &= ~JOB_TRACED;
1300 if (DEBUG(JOB)) {
1301 int i;
1303 (void)fprintf(debug_file, "Running %s %sly\n", job->node->name, "local");
1304 (void)fprintf(debug_file, "\tCommand: ");
1305 for (i = 0; argv[i] != NULL; i++) {
1306 (void)fprintf(debug_file, "%s ", argv[i]);
1308 (void)fprintf(debug_file, "\n");
1312 * Some jobs produce no output and it's disconcerting to have
1313 * no feedback of their running (since they produce no output, the
1314 * banner with their name in it never appears). This is an attempt to
1315 * provide that feedback, even if nothing follows it.
1317 if ((lastNode != job->node) && !(job->flags & JOB_SILENT)) {
1318 MESSAGE(stdout, job->node);
1319 lastNode = job->node;
1322 /* No interruptions until this job is on the `jobs' list */
1323 JobSigLock(&mask);
1325 /* Pre-emptively mark job running, pid still zero though */
1326 job->job_state = JOB_ST_RUNNING;
1328 cpid = vFork();
1329 if (cpid == -1)
1330 Punt("Cannot vfork: %s", strerror(errno));
1332 if (cpid == 0) {
1333 /* Child */
1334 sigset_t tmask;
1336 #ifdef USE_META
1337 if (useMeta) {
1338 meta_job_child(job);
1340 #endif
1342 * Reset all signal handlers; this is necessary because we also
1343 * need to unblock signals before we exec(2).
1345 JobSigReset();
1347 /* Now unblock signals */
1348 sigemptyset(&tmask);
1349 JobSigUnlock(&tmask);
1352 * Must duplicate the input stream down to the child's input and
1353 * reset it to the beginning (again). Since the stream was marked
1354 * close-on-exec, we must clear that bit in the new input.
1356 if (dup2(FILENO(job->cmdFILE), 0) == -1) {
1357 execError("dup2", "job->cmdFILE");
1358 _exit(1);
1360 (void)fcntl(0, F_SETFD, 0);
1361 (void)lseek(0, (off_t)0, SEEK_SET);
1364 * Always pass job token pipe to submakes. OP_MAKE simply doesn't
1365 * catch all situations and can lead to a massive multiplication of
1366 * jobs.
1368 /*if (job->node->type & OP_MAKE)*/ {
1369 fcntl(tokenWaitJob.inPipe, F_SETFD, 0);
1370 fcntl(tokenWaitJob.outPipe, F_SETFD, 0);
1374 * Set up the child's output to be routed through the pipe
1375 * we've created for it.
1377 if (dup2(job->outPipe, 1) == -1) {
1378 execError("dup2", "job->outPipe");
1379 _exit(1);
1382 * The output channels are marked close on exec. This bit was
1383 * duplicated by the dup2(on some systems), so we have to clear
1384 * it before routing the shell's error output to the same place as
1385 * its standard output.
1387 (void)fcntl(1, F_SETFD, 0);
1388 if (dup2(1, 2) == -1) {
1389 execError("dup2", "1, 2");
1390 _exit(1);
1394 * We want to switch the child into a different process family so
1395 * we can kill it and all its descendants in one fell swoop,
1396 * by killing its process family, but not commit suicide.
1398 #if defined(HAVE_SETPGID)
1399 (void)setpgid(0, getpid());
1400 #else
1401 #if defined(HAVE_SETSID)
1402 /* XXX: dsl - I'm sure this should be setpgrp()... */
1403 (void)setsid();
1404 #else
1405 (void)setpgrp(0, getpid());
1406 #endif
1407 #endif
1409 Var_ExportVars();
1411 (void)execv(shellPath, argv);
1412 execError("exec", shellPath);
1413 _exit(1);
1416 /* Parent, continuing after the child exec */
1417 job->pid = cpid;
1419 Trace_Log(JOBSTART, job);
1422 * Set the current position in the buffer to the beginning
1423 * and mark another stream to watch in the outputs mask
1425 job->curPos = 0;
1427 watchfd(job);
1429 if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
1430 (void)fclose(job->cmdFILE);
1431 job->cmdFILE = NULL;
1435 * Now the job is actually running, add it to the table.
1437 if (DEBUG(JOB)) {
1438 fprintf(debug_file, "JobExec(%s): pid %d added to jobs table\n",
1439 job->node->name, job->pid);
1440 job_table_dump("job started");
1442 JobSigUnlock(&mask);
1446 *-----------------------------------------------------------------------
1447 * JobMakeArgv --
1448 * Create the argv needed to execute the shell for a given job.
1451 * Results:
1453 * Side Effects:
1455 *-----------------------------------------------------------------------
1457 static void
1458 JobMakeArgv(Job *job, char **argv)
1460 int argc;
1461 static char args[10]; /* For merged arguments */
1463 argv[0] = UNCONST(shellName);
1464 argc = 1;
1466 if ((commandShell->exit && (*commandShell->exit != '-')) ||
1467 (commandShell->echo && (*commandShell->echo != '-')))
1470 * At least one of the flags doesn't have a minus before it, so
1471 * merge them together. Have to do this because the *(&(@*#*&#$#
1472 * Bourne shell thinks its second argument is a file to source.
1473 * Grrrr. Note the ten-character limitation on the combined arguments.
1475 (void)snprintf(args, sizeof(args), "-%s%s",
1476 ((job->flags & JOB_IGNERR) ? "" :
1477 (commandShell->exit ? commandShell->exit : "")),
1478 ((job->flags & JOB_SILENT) ? "" :
1479 (commandShell->echo ? commandShell->echo : "")));
1481 if (args[1]) {
1482 argv[argc] = args;
1483 argc++;
1485 } else {
1486 if (!(job->flags & JOB_IGNERR) && commandShell->exit) {
1487 argv[argc] = UNCONST(commandShell->exit);
1488 argc++;
1490 if (!(job->flags & JOB_SILENT) && commandShell->echo) {
1491 argv[argc] = UNCONST(commandShell->echo);
1492 argc++;
1495 argv[argc] = NULL;
1499 *-----------------------------------------------------------------------
1500 * JobStart --
1501 * Start a target-creation process going for the target described
1502 * by the graph node gn.
1504 * Input:
1505 * gn target to create
1506 * flags flags for the job to override normal ones.
1507 * e.g. JOB_SPECIAL or JOB_IGNDOTS
1508 * previous The previous Job structure for this node, if any.
1510 * Results:
1511 * JOB_ERROR if there was an error in the commands, JOB_FINISHED
1512 * if there isn't actually anything left to do for the job and
1513 * JOB_RUNNING if the job has been started.
1515 * Side Effects:
1516 * A new Job node is created and added to the list of running
1517 * jobs. PMake is forked and a child shell created.
1519 * NB: I'm fairly sure that this code is never called with JOB_SPECIAL set
1520 * JOB_IGNDOTS is never set (dsl)
1521 * Also the return value is ignored by everyone.
1522 *-----------------------------------------------------------------------
1524 static int
1525 JobStart(GNode *gn, int flags)
1527 Job *job; /* new job descriptor */
1528 char *argv[10]; /* Argument vector to shell */
1529 Boolean cmdsOK; /* true if the nodes commands were all right */
1530 Boolean noExec; /* Set true if we decide not to run the job */
1531 int tfd; /* File descriptor to the temp file */
1533 for (job = job_table; job < job_table_end; job++) {
1534 if (job->job_state == JOB_ST_FREE)
1535 break;
1537 if (job >= job_table_end)
1538 Punt("JobStart no job slots vacant");
1540 memset(job, 0, sizeof *job);
1541 job->job_state = JOB_ST_SETUP;
1542 if (gn->type & OP_SPECIAL)
1543 flags |= JOB_SPECIAL;
1545 job->node = gn;
1546 job->tailCmds = NULL;
1549 * Set the initial value of the flags for this job based on the global
1550 * ones and the node's attributes... Any flags supplied by the caller
1551 * are also added to the field.
1553 job->flags = 0;
1554 if (Targ_Ignore(gn)) {
1555 job->flags |= JOB_IGNERR;
1557 if (Targ_Silent(gn)) {
1558 job->flags |= JOB_SILENT;
1560 job->flags |= flags;
1563 * Check the commands now so any attributes from .DEFAULT have a chance
1564 * to migrate to the node
1566 cmdsOK = Job_CheckCommands(gn, Error);
1568 job->inPollfd = NULL;
1570 * If the -n flag wasn't given, we open up OUR (not the child's)
1571 * temporary file to stuff commands in it. The thing is rd/wr so we don't
1572 * need to reopen it to feed it to the shell. If the -n flag *was* given,
1573 * we just set the file to be stdout. Cute, huh?
1575 if (((gn->type & OP_MAKE) && !(noRecursiveExecute)) ||
1576 (!noExecute && !touchFlag)) {
1578 * tfile is the name of a file into which all shell commands are
1579 * put. It is removed before the child shell is executed, unless
1580 * DEBUG(SCRIPT) is set.
1582 char *tfile;
1583 sigset_t mask;
1585 * We're serious here, but if the commands were bogus, we're
1586 * also dead...
1588 if (!cmdsOK) {
1589 PrintOnError(gn, NULL); /* provide some clue */
1590 DieHorribly();
1593 JobSigLock(&mask);
1594 tfd = mkTempFile(TMPPAT, &tfile);
1595 if (!DEBUG(SCRIPT))
1596 (void)eunlink(tfile);
1597 JobSigUnlock(&mask);
1599 job->cmdFILE = fdopen(tfd, "w+");
1600 if (job->cmdFILE == NULL) {
1601 Punt("Could not fdopen %s", tfile);
1603 (void)fcntl(FILENO(job->cmdFILE), F_SETFD, 1);
1605 * Send the commands to the command file, flush all its buffers then
1606 * rewind and remove the thing.
1608 noExec = FALSE;
1610 #ifdef USE_META
1611 if (useMeta) {
1612 meta_job_start(job, gn);
1613 if (Targ_Silent(gn)) { /* might have changed */
1614 job->flags |= JOB_SILENT;
1617 #endif
1619 * We can do all the commands at once. hooray for sanity
1621 numCommands = 0;
1622 Lst_ForEach(gn->commands, JobPrintCommand, job);
1625 * If we didn't print out any commands to the shell script,
1626 * there's not much point in executing the shell, is there?
1628 if (numCommands == 0) {
1629 noExec = TRUE;
1632 free(tfile);
1633 } else if (NoExecute(gn)) {
1635 * Not executing anything -- just print all the commands to stdout
1636 * in one fell swoop. This will still set up job->tailCmds correctly.
1638 if (lastNode != gn) {
1639 MESSAGE(stdout, gn);
1640 lastNode = gn;
1642 job->cmdFILE = stdout;
1644 * Only print the commands if they're ok, but don't die if they're
1645 * not -- just let the user know they're bad and keep going. It
1646 * doesn't do any harm in this case and may do some good.
1648 if (cmdsOK) {
1649 Lst_ForEach(gn->commands, JobPrintCommand, job);
1652 * Don't execute the shell, thank you.
1654 noExec = TRUE;
1655 } else {
1657 * Just touch the target and note that no shell should be executed.
1658 * Set cmdFILE to stdout to make life easier. Check the commands, too,
1659 * but don't die if they're no good -- it does no harm to keep working
1660 * up the graph.
1662 job->cmdFILE = stdout;
1663 Job_Touch(gn, job->flags&JOB_SILENT);
1664 noExec = TRUE;
1666 /* Just in case it isn't already... */
1667 (void)fflush(job->cmdFILE);
1670 * If we're not supposed to execute a shell, don't.
1672 if (noExec) {
1673 if (!(job->flags & JOB_SPECIAL))
1674 Job_TokenReturn();
1676 * Unlink and close the command file if we opened one
1678 if (job->cmdFILE != stdout) {
1679 if (job->cmdFILE != NULL) {
1680 (void)fclose(job->cmdFILE);
1681 job->cmdFILE = NULL;
1686 * We only want to work our way up the graph if we aren't here because
1687 * the commands for the job were no good.
1689 if (cmdsOK && aborting == 0) {
1690 if (job->tailCmds != NULL) {
1691 Lst_ForEachFrom(job->node->commands, job->tailCmds,
1692 JobSaveCommand,
1693 job->node);
1695 job->node->made = MADE;
1696 Make_Update(job->node);
1698 job->job_state = JOB_ST_FREE;
1699 return cmdsOK ? JOB_FINISHED : JOB_ERROR;
1703 * Set up the control arguments to the shell. This is based on the flags
1704 * set earlier for this job.
1706 JobMakeArgv(job, argv);
1708 /* Create the pipe by which we'll get the shell's output. */
1709 JobCreatePipe(job, 3);
1711 JobExec(job, argv);
1712 return(JOB_RUNNING);
1715 static char *
1716 JobOutput(Job *job, char *cp, char *endp, int msg)
1718 char *ecp;
1720 if (commandShell->noPrint) {
1721 ecp = Str_FindSubstring(cp, commandShell->noPrint);
1722 while (ecp != NULL) {
1723 if (cp != ecp) {
1724 *ecp = '\0';
1725 if (!beSilent && msg && job->node != lastNode) {
1726 MESSAGE(stdout, job->node);
1727 lastNode = job->node;
1730 * The only way there wouldn't be a newline after
1731 * this line is if it were the last in the buffer.
1732 * however, since the non-printable comes after it,
1733 * there must be a newline, so we don't print one.
1735 (void)fprintf(stdout, "%s", cp);
1736 (void)fflush(stdout);
1738 cp = ecp + commandShell->noPLen;
1739 if (cp != endp) {
1741 * Still more to print, look again after skipping
1742 * the whitespace following the non-printable
1743 * command....
1745 cp++;
1746 while (*cp == ' ' || *cp == '\t' || *cp == '\n') {
1747 cp++;
1749 ecp = Str_FindSubstring(cp, commandShell->noPrint);
1750 } else {
1751 return cp;
1755 return cp;
1759 *-----------------------------------------------------------------------
1760 * JobDoOutput --
1761 * This function is called at different times depending on
1762 * whether the user has specified that output is to be collected
1763 * via pipes or temporary files. In the former case, we are called
1764 * whenever there is something to read on the pipe. We collect more
1765 * output from the given job and store it in the job's outBuf. If
1766 * this makes up a line, we print it tagged by the job's identifier,
1767 * as necessary.
1768 * If output has been collected in a temporary file, we open the
1769 * file and read it line by line, transfering it to our own
1770 * output channel until the file is empty. At which point we
1771 * remove the temporary file.
1772 * In both cases, however, we keep our figurative eye out for the
1773 * 'noPrint' line for the shell from which the output came. If
1774 * we recognize a line, we don't print it. If the command is not
1775 * alone on the line (the character after it is not \0 or \n), we
1776 * do print whatever follows it.
1778 * Input:
1779 * job the job whose output needs printing
1780 * finish TRUE if this is the last time we'll be called
1781 * for this job
1783 * Results:
1784 * None
1786 * Side Effects:
1787 * curPos may be shifted as may the contents of outBuf.
1788 *-----------------------------------------------------------------------
1790 STATIC void
1791 JobDoOutput(Job *job, Boolean finish)
1793 Boolean gotNL = FALSE; /* true if got a newline */
1794 Boolean fbuf; /* true if our buffer filled up */
1795 int nr; /* number of bytes read */
1796 int i; /* auxiliary index into outBuf */
1797 int max; /* limit for i (end of current data) */
1798 int nRead; /* (Temporary) number of bytes read */
1801 * Read as many bytes as will fit in the buffer.
1803 end_loop:
1804 gotNL = FALSE;
1805 fbuf = FALSE;
1807 nRead = read(job->inPipe, &job->outBuf[job->curPos],
1808 JOB_BUFSIZE - job->curPos);
1809 if (nRead < 0) {
1810 if (errno == EAGAIN)
1811 return;
1812 if (DEBUG(JOB)) {
1813 perror("JobDoOutput(piperead)");
1815 nr = 0;
1816 } else {
1817 nr = nRead;
1821 * If we hit the end-of-file (the job is dead), we must flush its
1822 * remaining output, so pretend we read a newline if there's any
1823 * output remaining in the buffer.
1824 * Also clear the 'finish' flag so we stop looping.
1826 if ((nr == 0) && (job->curPos != 0)) {
1827 job->outBuf[job->curPos] = '\n';
1828 nr = 1;
1829 finish = FALSE;
1830 } else if (nr == 0) {
1831 finish = FALSE;
1835 * Look for the last newline in the bytes we just got. If there is
1836 * one, break out of the loop with 'i' as its index and gotNL set
1837 * TRUE.
1839 max = job->curPos + nr;
1840 for (i = job->curPos + nr - 1; i >= job->curPos; i--) {
1841 if (job->outBuf[i] == '\n') {
1842 gotNL = TRUE;
1843 break;
1844 } else if (job->outBuf[i] == '\0') {
1846 * Why?
1848 job->outBuf[i] = ' ';
1852 if (!gotNL) {
1853 job->curPos += nr;
1854 if (job->curPos == JOB_BUFSIZE) {
1856 * If we've run out of buffer space, we have no choice
1857 * but to print the stuff. sigh.
1859 fbuf = TRUE;
1860 i = job->curPos;
1863 if (gotNL || fbuf) {
1865 * Need to send the output to the screen. Null terminate it
1866 * first, overwriting the newline character if there was one.
1867 * So long as the line isn't one we should filter (according
1868 * to the shell description), we print the line, preceded
1869 * by a target banner if this target isn't the same as the
1870 * one for which we last printed something.
1871 * The rest of the data in the buffer are then shifted down
1872 * to the start of the buffer and curPos is set accordingly.
1874 job->outBuf[i] = '\0';
1875 if (i >= job->curPos) {
1876 char *cp;
1878 cp = JobOutput(job, job->outBuf, &job->outBuf[i], FALSE);
1881 * There's still more in that thar buffer. This time, though,
1882 * we know there's no newline at the end, so we add one of
1883 * our own free will.
1885 if (*cp != '\0') {
1886 if (!beSilent && job->node != lastNode) {
1887 MESSAGE(stdout, job->node);
1888 lastNode = job->node;
1890 #ifdef USE_META
1891 if (useMeta) {
1892 meta_job_output(job, cp, gotNL ? "\n" : "");
1894 #endif
1895 (void)fprintf(stdout, "%s%s", cp, gotNL ? "\n" : "");
1896 (void)fflush(stdout);
1899 if (i < max - 1) {
1900 /* shift the remaining characters down */
1901 (void)memcpy(job->outBuf, &job->outBuf[i + 1], max - (i + 1));
1902 job->curPos = max - (i + 1);
1904 } else {
1906 * We have written everything out, so we just start over
1907 * from the start of the buffer. No copying. No nothing.
1909 job->curPos = 0;
1912 if (finish) {
1914 * If the finish flag is true, we must loop until we hit
1915 * end-of-file on the pipe. This is guaranteed to happen
1916 * eventually since the other end of the pipe is now closed
1917 * (we closed it explicitly and the child has exited). When
1918 * we do get an EOF, finish will be set FALSE and we'll fall
1919 * through and out.
1921 goto end_loop;
1925 static void
1926 JobRun(GNode *targ)
1928 #ifdef notyet
1930 * Unfortunately it is too complicated to run .BEGIN, .END,
1931 * and .INTERRUPT job in the parallel job module. This has
1932 * the nice side effect that it avoids a lot of other problems.
1934 Lst lst = Lst_Init(FALSE);
1935 Lst_AtEnd(lst, targ);
1936 (void)Make_Run(lst);
1937 Lst_Destroy(lst, NULL);
1938 JobStart(targ, JOB_SPECIAL);
1939 while (jobTokensRunning) {
1940 Job_CatchOutput();
1942 #else
1943 Compat_Make(targ, targ);
1944 if (targ->made == ERROR) {
1945 PrintOnError(targ, "\n\nStop.");
1946 exit(1);
1948 #endif
1952 *-----------------------------------------------------------------------
1953 * Job_CatchChildren --
1954 * Handle the exit of a child. Called from Make_Make.
1956 * Input:
1957 * block TRUE if should block on the wait
1959 * Results:
1960 * none.
1962 * Side Effects:
1963 * The job descriptor is removed from the list of children.
1965 * Notes:
1966 * We do waits, blocking or not, according to the wisdom of our
1967 * caller, until there are no more children to report. For each
1968 * job, call JobFinish to finish things off.
1970 *-----------------------------------------------------------------------
1973 void
1974 Job_CatchChildren(void)
1976 int pid; /* pid of dead child */
1977 WAIT_T status; /* Exit/termination status */
1980 * Don't even bother if we know there's no one around.
1982 if (jobTokensRunning == 0)
1983 return;
1985 while ((pid = waitpid((pid_t) -1, &status, WNOHANG | WUNTRACED)) > 0) {
1986 if (DEBUG(JOB)) {
1987 (void)fprintf(debug_file, "Process %d exited/stopped status %x.\n", pid,
1988 WAIT_STATUS(status));
1990 JobReapChild(pid, status, TRUE);
1995 * It is possible that wait[pid]() was called from elsewhere,
1996 * this lets us reap jobs regardless.
1998 void
1999 JobReapChild(pid_t pid, WAIT_T status, Boolean isJobs)
2001 Job *job; /* job descriptor for dead child */
2004 * Don't even bother if we know there's no one around.
2006 if (jobTokensRunning == 0)
2007 return;
2009 job = JobFindPid(pid, JOB_ST_RUNNING, isJobs);
2010 if (job == NULL) {
2011 if (isJobs) {
2012 if (!lurking_children)
2013 Error("Child (%d) status %x not in table?", pid, status);
2015 return; /* not ours */
2017 if (WIFSTOPPED(status)) {
2018 if (DEBUG(JOB)) {
2019 (void)fprintf(debug_file, "Process %d (%s) stopped.\n",
2020 job->pid, job->node->name);
2022 if (!make_suspended) {
2023 switch (WSTOPSIG(status)) {
2024 case SIGTSTP:
2025 (void)printf("*** [%s] Suspended\n", job->node->name);
2026 break;
2027 case SIGSTOP:
2028 (void)printf("*** [%s] Stopped\n", job->node->name);
2029 break;
2030 default:
2031 (void)printf("*** [%s] Stopped -- signal %d\n",
2032 job->node->name, WSTOPSIG(status));
2034 job->job_suspended = 1;
2036 (void)fflush(stdout);
2037 return;
2040 job->job_state = JOB_ST_FINISHED;
2041 job->exit_status = WAIT_STATUS(status);
2043 JobFinish(job, status);
2047 *-----------------------------------------------------------------------
2048 * Job_CatchOutput --
2049 * Catch the output from our children, if we're using
2050 * pipes do so. Otherwise just block time until we get a
2051 * signal(most likely a SIGCHLD) since there's no point in
2052 * just spinning when there's nothing to do and the reaping
2053 * of a child can wait for a while.
2055 * Results:
2056 * None
2058 * Side Effects:
2059 * Output is read from pipes if we're piping.
2060 * -----------------------------------------------------------------------
2062 void
2063 Job_CatchOutput(void)
2065 int nready;
2066 Job *job;
2067 int i;
2069 (void)fflush(stdout);
2071 /* The first fd in the list is the job token pipe */
2072 do {
2073 nready = poll(fds + 1 - wantToken, nfds - 1 + wantToken, POLL_MSEC);
2074 } while (nready < 0 && errno == EINTR);
2076 if (nready < 0)
2077 Punt("poll: %s", strerror(errno));
2079 if (nready > 0 && readyfd(&childExitJob)) {
2080 char token = 0;
2081 ssize_t count;
2082 count = read(childExitJob.inPipe, &token, 1);
2083 switch (count) {
2084 case 0:
2085 Punt("unexpected eof on token pipe");
2086 case -1:
2087 Punt("token pipe read: %s", strerror(errno));
2088 case 1:
2089 if (token == DO_JOB_RESUME[0])
2090 /* Complete relay requested from our SIGCONT handler */
2091 JobRestartJobs();
2092 break;
2093 default:
2094 abort();
2096 --nready;
2099 Job_CatchChildren();
2100 if (nready == 0)
2101 return;
2103 for (i = 2; i < nfds; i++) {
2104 if (!fds[i].revents)
2105 continue;
2106 job = jobfds[i];
2107 if (job->job_state == JOB_ST_RUNNING)
2108 JobDoOutput(job, FALSE);
2109 if (--nready == 0)
2110 return;
2115 *-----------------------------------------------------------------------
2116 * Job_Make --
2117 * Start the creation of a target. Basically a front-end for
2118 * JobStart used by the Make module.
2120 * Results:
2121 * None.
2123 * Side Effects:
2124 * Another job is started.
2126 *-----------------------------------------------------------------------
2128 void
2129 Job_Make(GNode *gn)
2131 (void)JobStart(gn, 0);
2134 void
2135 Shell_Init(void)
2137 if (shellPath == NULL) {
2139 * We are using the default shell, which may be an absolute
2140 * path if DEFSHELL_CUSTOM is defined.
2142 shellName = commandShell->name;
2143 #ifdef DEFSHELL_CUSTOM
2144 if (*shellName == '/') {
2145 shellPath = shellName;
2146 shellName = strrchr(shellPath, '/');
2147 shellName++;
2148 } else
2149 #endif
2150 shellPath = str_concat(_PATH_DEFSHELLDIR, shellName, STR_ADDSLASH);
2152 if (commandShell->exit == NULL) {
2153 commandShell->exit = "";
2155 if (commandShell->echo == NULL) {
2156 commandShell->echo = "";
2158 if (commandShell->hasErrCtl && *commandShell->exit) {
2159 if (shellErrFlag &&
2160 strcmp(commandShell->exit, &shellErrFlag[1]) != 0) {
2161 free(shellErrFlag);
2162 shellErrFlag = NULL;
2164 if (!shellErrFlag) {
2165 int n = strlen(commandShell->exit) + 2;
2167 shellErrFlag = bmake_malloc(n);
2168 if (shellErrFlag) {
2169 snprintf(shellErrFlag, n, "-%s", commandShell->exit);
2172 } else if (shellErrFlag) {
2173 free(shellErrFlag);
2174 shellErrFlag = NULL;
2179 * Returns the string literal that is used in the current command shell
2180 * to produce a newline character.
2182 const char *
2183 Shell_GetNewline(void)
2186 return commandShell->newline;
2189 void
2190 Job_SetPrefix(void)
2193 if (targPrefix) {
2194 free(targPrefix);
2195 } else if (!Var_Exists(MAKE_JOB_PREFIX, VAR_GLOBAL)) {
2196 Var_Set(MAKE_JOB_PREFIX, "---", VAR_GLOBAL, 0);
2199 targPrefix = Var_Subst(NULL, "${" MAKE_JOB_PREFIX "}", VAR_GLOBAL, 0);
2203 *-----------------------------------------------------------------------
2204 * Job_Init --
2205 * Initialize the process module
2207 * Input:
2209 * Results:
2210 * none
2212 * Side Effects:
2213 * lists and counters are initialized
2214 *-----------------------------------------------------------------------
2216 void
2217 Job_Init(void)
2219 Job_SetPrefix();
2220 /* Allocate space for all the job info */
2221 job_table = bmake_malloc(maxJobs * sizeof *job_table);
2222 memset(job_table, 0, maxJobs * sizeof *job_table);
2223 job_table_end = job_table + maxJobs;
2224 wantToken = 0;
2226 aborting = 0;
2227 errors = 0;
2229 lastNode = NULL;
2232 * There is a non-zero chance that we already have children.
2233 * eg after 'make -f- <<EOF'
2234 * Since their termination causes a 'Child (pid) not in table' message,
2235 * Collect the status of any that are already dead, and suppress the
2236 * error message if there are any undead ones.
2238 for (;;) {
2239 int rval, status;
2240 rval = waitpid((pid_t) -1, &status, WNOHANG);
2241 if (rval > 0)
2242 continue;
2243 if (rval == 0)
2244 lurking_children = 1;
2245 break;
2248 Shell_Init();
2250 JobCreatePipe(&childExitJob, 3);
2252 /* We can only need to wait for tokens, children and output from each job */
2253 fds = bmake_malloc(sizeof (*fds) * (2 + maxJobs));
2254 jobfds = bmake_malloc(sizeof (*jobfds) * (2 + maxJobs));
2256 /* These are permanent entries and take slots 0 and 1 */
2257 watchfd(&tokenWaitJob);
2258 watchfd(&childExitJob);
2260 sigemptyset(&caught_signals);
2262 * Install a SIGCHLD handler.
2264 (void)bmake_signal(SIGCHLD, JobChildSig);
2265 sigaddset(&caught_signals, SIGCHLD);
2267 #define ADDSIG(s,h) \
2268 if (bmake_signal(s, SIG_IGN) != SIG_IGN) { \
2269 sigaddset(&caught_signals, s); \
2270 (void)bmake_signal(s, h); \
2274 * Catch the four signals that POSIX specifies if they aren't ignored.
2275 * JobPassSig will take care of calling JobInterrupt if appropriate.
2277 ADDSIG(SIGINT, JobPassSig_int)
2278 ADDSIG(SIGHUP, JobPassSig_term)
2279 ADDSIG(SIGTERM, JobPassSig_term)
2280 ADDSIG(SIGQUIT, JobPassSig_term)
2283 * There are additional signals that need to be caught and passed if
2284 * either the export system wants to be told directly of signals or if
2285 * we're giving each job its own process group (since then it won't get
2286 * signals from the terminal driver as we own the terminal)
2288 ADDSIG(SIGTSTP, JobPassSig_suspend)
2289 ADDSIG(SIGTTOU, JobPassSig_suspend)
2290 ADDSIG(SIGTTIN, JobPassSig_suspend)
2291 ADDSIG(SIGWINCH, JobCondPassSig)
2292 ADDSIG(SIGCONT, JobContinueSig)
2293 #undef ADDSIG
2295 (void)Job_RunTarget(".BEGIN", NULL);
2296 postCommands = Targ_FindNode(".END", TARG_CREATE);
2299 static void JobSigReset(void)
2301 #define DELSIG(s) \
2302 if (sigismember(&caught_signals, s)) { \
2303 (void)bmake_signal(s, SIG_DFL); \
2306 DELSIG(SIGINT)
2307 DELSIG(SIGHUP)
2308 DELSIG(SIGQUIT)
2309 DELSIG(SIGTERM)
2310 DELSIG(SIGTSTP)
2311 DELSIG(SIGTTOU)
2312 DELSIG(SIGTTIN)
2313 DELSIG(SIGWINCH)
2314 DELSIG(SIGCONT)
2315 #undef DELSIG
2316 (void)bmake_signal(SIGCHLD, SIG_DFL);
2320 *-----------------------------------------------------------------------
2321 * JobMatchShell --
2322 * Find a shell in 'shells' given its name.
2324 * Results:
2325 * A pointer to the Shell structure.
2327 * Side Effects:
2328 * None.
2330 *-----------------------------------------------------------------------
2332 static Shell *
2333 JobMatchShell(const char *name)
2335 Shell *sh;
2337 for (sh = shells; sh->name != NULL; sh++) {
2338 if (strcmp(name, sh->name) == 0)
2339 return (sh);
2341 return NULL;
2345 *-----------------------------------------------------------------------
2346 * Job_ParseShell --
2347 * Parse a shell specification and set up commandShell, shellPath
2348 * and shellName appropriately.
2350 * Input:
2351 * line The shell spec
2353 * Results:
2354 * FAILURE if the specification was incorrect.
2356 * Side Effects:
2357 * commandShell points to a Shell structure (either predefined or
2358 * created from the shell spec), shellPath is the full path of the
2359 * shell described by commandShell, while shellName is just the
2360 * final component of shellPath.
2362 * Notes:
2363 * A shell specification consists of a .SHELL target, with dependency
2364 * operator, followed by a series of blank-separated words. Double
2365 * quotes can be used to use blanks in words. A backslash escapes
2366 * anything (most notably a double-quote and a space) and
2367 * provides the functionality it does in C. Each word consists of
2368 * keyword and value separated by an equal sign. There should be no
2369 * unnecessary spaces in the word. The keywords are as follows:
2370 * name Name of shell.
2371 * path Location of shell.
2372 * quiet Command to turn off echoing.
2373 * echo Command to turn echoing on
2374 * filter Result of turning off echoing that shouldn't be
2375 * printed.
2376 * echoFlag Flag to turn echoing on at the start
2377 * errFlag Flag to turn error checking on at the start
2378 * hasErrCtl True if shell has error checking control
2379 * newline String literal to represent a newline char
2380 * check Command to turn on error checking if hasErrCtl
2381 * is TRUE or template of command to echo a command
2382 * for which error checking is off if hasErrCtl is
2383 * FALSE.
2384 * ignore Command to turn off error checking if hasErrCtl
2385 * is TRUE or template of command to execute a
2386 * command so as to ignore any errors it returns if
2387 * hasErrCtl is FALSE.
2389 *-----------------------------------------------------------------------
2391 ReturnStatus
2392 Job_ParseShell(char *line)
2394 char **words;
2395 char **argv;
2396 int argc;
2397 char *path;
2398 Shell newShell;
2399 Boolean fullSpec = FALSE;
2400 Shell *sh;
2402 while (isspace((unsigned char)*line)) {
2403 line++;
2406 if (shellArgv)
2407 free(UNCONST(shellArgv));
2409 memset(&newShell, 0, sizeof(newShell));
2412 * Parse the specification by keyword
2414 words = brk_string(line, &argc, TRUE, &path);
2415 if (words == NULL) {
2416 Error("Unterminated quoted string [%s]", line);
2417 return FAILURE;
2419 shellArgv = path;
2421 for (path = NULL, argv = words; argc != 0; argc--, argv++) {
2422 if (strncmp(*argv, "path=", 5) == 0) {
2423 path = &argv[0][5];
2424 } else if (strncmp(*argv, "name=", 5) == 0) {
2425 newShell.name = &argv[0][5];
2426 } else {
2427 if (strncmp(*argv, "quiet=", 6) == 0) {
2428 newShell.echoOff = &argv[0][6];
2429 } else if (strncmp(*argv, "echo=", 5) == 0) {
2430 newShell.echoOn = &argv[0][5];
2431 } else if (strncmp(*argv, "filter=", 7) == 0) {
2432 newShell.noPrint = &argv[0][7];
2433 newShell.noPLen = strlen(newShell.noPrint);
2434 } else if (strncmp(*argv, "echoFlag=", 9) == 0) {
2435 newShell.echo = &argv[0][9];
2436 } else if (strncmp(*argv, "errFlag=", 8) == 0) {
2437 newShell.exit = &argv[0][8];
2438 } else if (strncmp(*argv, "hasErrCtl=", 10) == 0) {
2439 char c = argv[0][10];
2440 newShell.hasErrCtl = !((c != 'Y') && (c != 'y') &&
2441 (c != 'T') && (c != 't'));
2442 } else if (strncmp(*argv, "newline=", 8) == 0) {
2443 newShell.newline = &argv[0][8];
2444 } else if (strncmp(*argv, "check=", 6) == 0) {
2445 newShell.errCheck = &argv[0][6];
2446 } else if (strncmp(*argv, "ignore=", 7) == 0) {
2447 newShell.ignErr = &argv[0][7];
2448 } else if (strncmp(*argv, "errout=", 7) == 0) {
2449 newShell.errOut = &argv[0][7];
2450 } else if (strncmp(*argv, "comment=", 8) == 0) {
2451 newShell.commentChar = argv[0][8];
2452 } else {
2453 Parse_Error(PARSE_FATAL, "Unknown keyword \"%s\"",
2454 *argv);
2455 free(words);
2456 return(FAILURE);
2458 fullSpec = TRUE;
2462 if (path == NULL) {
2464 * If no path was given, the user wants one of the pre-defined shells,
2465 * yes? So we find the one s/he wants with the help of JobMatchShell
2466 * and set things up the right way. shellPath will be set up by
2467 * Shell_Init.
2469 if (newShell.name == NULL) {
2470 Parse_Error(PARSE_FATAL, "Neither path nor name specified");
2471 free(words);
2472 return(FAILURE);
2473 } else {
2474 if ((sh = JobMatchShell(newShell.name)) == NULL) {
2475 Parse_Error(PARSE_WARNING, "%s: No matching shell",
2476 newShell.name);
2477 free(words);
2478 return(FAILURE);
2480 commandShell = sh;
2481 shellName = newShell.name;
2482 if (shellPath) {
2483 /* Shell_Init has already been called! Do it again. */
2484 free(UNCONST(shellPath));
2485 shellPath = NULL;
2486 Shell_Init();
2489 } else {
2491 * The user provided a path. If s/he gave nothing else (fullSpec is
2492 * FALSE), try and find a matching shell in the ones we know of.
2493 * Else we just take the specification at its word and copy it
2494 * to a new location. In either case, we need to record the
2495 * path the user gave for the shell.
2497 shellPath = path;
2498 path = strrchr(path, '/');
2499 if (path == NULL) {
2500 path = UNCONST(shellPath);
2501 } else {
2502 path += 1;
2504 if (newShell.name != NULL) {
2505 shellName = newShell.name;
2506 } else {
2507 shellName = path;
2509 if (!fullSpec) {
2510 if ((sh = JobMatchShell(shellName)) == NULL) {
2511 Parse_Error(PARSE_WARNING, "%s: No matching shell",
2512 shellName);
2513 free(words);
2514 return(FAILURE);
2516 commandShell = sh;
2517 } else {
2518 commandShell = bmake_malloc(sizeof(Shell));
2519 *commandShell = newShell;
2521 /* this will take care of shellErrFlag */
2522 Shell_Init();
2525 if (commandShell->echoOn && commandShell->echoOff) {
2526 commandShell->hasEchoCtl = TRUE;
2529 if (!commandShell->hasErrCtl) {
2530 if (commandShell->errCheck == NULL) {
2531 commandShell->errCheck = "";
2533 if (commandShell->ignErr == NULL) {
2534 commandShell->ignErr = "%s\n";
2539 * Do not free up the words themselves, since they might be in use by the
2540 * shell specification.
2542 free(words);
2543 return SUCCESS;
2547 *-----------------------------------------------------------------------
2548 * JobInterrupt --
2549 * Handle the receipt of an interrupt.
2551 * Input:
2552 * runINTERRUPT Non-zero if commands for the .INTERRUPT target
2553 * should be executed
2554 * signo signal received
2556 * Results:
2557 * None
2559 * Side Effects:
2560 * All children are killed. Another job will be started if the
2561 * .INTERRUPT target was given.
2562 *-----------------------------------------------------------------------
2564 static void
2565 JobInterrupt(int runINTERRUPT, int signo)
2567 Job *job; /* job descriptor in that element */
2568 GNode *interrupt; /* the node describing the .INTERRUPT target */
2569 sigset_t mask;
2570 GNode *gn;
2572 aborting = ABORT_INTERRUPT;
2574 JobSigLock(&mask);
2576 for (job = job_table; job < job_table_end; job++) {
2577 if (job->job_state != JOB_ST_RUNNING)
2578 continue;
2580 gn = job->node;
2582 if ((gn->type & (OP_JOIN|OP_PHONY)) == 0 && !Targ_Precious(gn)) {
2583 char *file = (gn->path == NULL ? gn->name : gn->path);
2584 if (!noExecute && eunlink(file) != -1) {
2585 Error("*** %s removed", file);
2588 if (job->pid) {
2589 if (DEBUG(JOB)) {
2590 (void)fprintf(debug_file,
2591 "JobInterrupt passing signal %d to child %d.\n",
2592 signo, job->pid);
2594 KILLPG(job->pid, signo);
2598 JobSigUnlock(&mask);
2600 if (runINTERRUPT && !touchFlag) {
2601 interrupt = Targ_FindNode(".INTERRUPT", TARG_NOCREATE);
2602 if (interrupt != NULL) {
2603 ignoreErrors = FALSE;
2604 JobRun(interrupt);
2607 Trace_Log(MAKEINTR, 0);
2608 exit(signo);
2612 *-----------------------------------------------------------------------
2613 * Job_Finish --
2614 * Do final processing such as the running of the commands
2615 * attached to the .END target.
2617 * Results:
2618 * Number of errors reported.
2620 * Side Effects:
2621 * None.
2622 *-----------------------------------------------------------------------
2625 Job_Finish(void)
2627 if (postCommands != NULL &&
2628 (!Lst_IsEmpty(postCommands->commands) ||
2629 !Lst_IsEmpty(postCommands->children))) {
2630 if (errors) {
2631 Error("Errors reported so .END ignored");
2632 } else {
2633 JobRun(postCommands);
2636 return(errors);
2640 *-----------------------------------------------------------------------
2641 * Job_End --
2642 * Cleanup any memory used by the jobs module
2644 * Results:
2645 * None.
2647 * Side Effects:
2648 * Memory is freed
2649 *-----------------------------------------------------------------------
2651 void
2652 Job_End(void)
2654 #ifdef CLEANUP
2655 if (shellArgv)
2656 free(shellArgv);
2657 #endif
2661 *-----------------------------------------------------------------------
2662 * Job_Wait --
2663 * Waits for all running jobs to finish and returns. Sets 'aborting'
2664 * to ABORT_WAIT to prevent other jobs from starting.
2666 * Results:
2667 * None.
2669 * Side Effects:
2670 * Currently running jobs finish.
2672 *-----------------------------------------------------------------------
2674 void
2675 Job_Wait(void)
2677 aborting = ABORT_WAIT;
2678 while (jobTokensRunning != 0) {
2679 Job_CatchOutput();
2681 aborting = 0;
2685 *-----------------------------------------------------------------------
2686 * Job_AbortAll --
2687 * Abort all currently running jobs without handling output or anything.
2688 * This function is to be called only in the event of a major
2689 * error. Most definitely NOT to be called from JobInterrupt.
2691 * Results:
2692 * None
2694 * Side Effects:
2695 * All children are killed, not just the firstborn
2696 *-----------------------------------------------------------------------
2698 void
2699 Job_AbortAll(void)
2701 Job *job; /* the job descriptor in that element */
2702 WAIT_T foo;
2704 aborting = ABORT_ERROR;
2706 if (jobTokensRunning) {
2707 for (job = job_table; job < job_table_end; job++) {
2708 if (job->job_state != JOB_ST_RUNNING)
2709 continue;
2711 * kill the child process with increasingly drastic signals to make
2712 * darn sure it's dead.
2714 KILLPG(job->pid, SIGINT);
2715 KILLPG(job->pid, SIGKILL);
2720 * Catch as many children as want to report in at first, then give up
2722 while (waitpid((pid_t) -1, &foo, WNOHANG) > 0)
2723 continue;
2728 *-----------------------------------------------------------------------
2729 * JobRestartJobs --
2730 * Tries to restart stopped jobs if there are slots available.
2731 * Called in process context in response to a SIGCONT.
2733 * Results:
2734 * None.
2736 * Side Effects:
2737 * Resumes jobs.
2739 *-----------------------------------------------------------------------
2741 static void
2742 JobRestartJobs(void)
2744 Job *job;
2746 for (job = job_table; job < job_table_end; job++) {
2747 if (job->job_state == JOB_ST_RUNNING &&
2748 (make_suspended || job->job_suspended)) {
2749 if (DEBUG(JOB)) {
2750 (void)fprintf(debug_file, "Restarting stopped job pid %d.\n",
2751 job->pid);
2753 if (job->job_suspended) {
2754 (void)printf("*** [%s] Continued\n", job->node->name);
2755 (void)fflush(stdout);
2757 job->job_suspended = 0;
2758 if (KILLPG(job->pid, SIGCONT) != 0 && DEBUG(JOB)) {
2759 fprintf(debug_file, "Failed to send SIGCONT to %d\n", job->pid);
2762 if (job->job_state == JOB_ST_FINISHED)
2763 /* Job exit deferred after calling waitpid() in a signal handler */
2764 JobFinish(job, job->exit_status);
2766 make_suspended = 0;
2769 static void
2770 watchfd(Job *job)
2772 if (job->inPollfd != NULL)
2773 Punt("Watching watched job");
2775 fds[nfds].fd = job->inPipe;
2776 fds[nfds].events = POLLIN;
2777 jobfds[nfds] = job;
2778 job->inPollfd = &fds[nfds];
2779 nfds++;
2782 static void
2783 clearfd(Job *job)
2785 int i;
2786 if (job->inPollfd == NULL)
2787 Punt("Unwatching unwatched job");
2788 i = job->inPollfd - fds;
2789 nfds--;
2791 * Move last job in table into hole made by dead job.
2793 if (nfds != i) {
2794 fds[i] = fds[nfds];
2795 jobfds[i] = jobfds[nfds];
2796 jobfds[i]->inPollfd = &fds[i];
2798 job->inPollfd = NULL;
2801 static int
2802 readyfd(Job *job)
2804 if (job->inPollfd == NULL)
2805 Punt("Polling unwatched job");
2806 return (job->inPollfd->revents & POLLIN) != 0;
2810 *-----------------------------------------------------------------------
2811 * JobTokenAdd --
2812 * Put a token into the job pipe so that some make process can start
2813 * another job.
2815 * Side Effects:
2816 * Allows more build jobs to be spawned somewhere.
2818 *-----------------------------------------------------------------------
2821 static void
2822 JobTokenAdd(void)
2824 char tok = JOB_TOKENS[aborting], tok1;
2826 /* If we are depositing an error token flush everything else */
2827 while (tok != '+' && read(tokenWaitJob.inPipe, &tok1, 1) == 1)
2828 continue;
2830 if (DEBUG(JOB))
2831 fprintf(debug_file, "(%d) aborting %d, deposit token %c\n",
2832 getpid(), aborting, JOB_TOKENS[aborting]);
2833 while (write(tokenWaitJob.outPipe, &tok, 1) == -1 && errno == EAGAIN)
2834 continue;
2838 *-----------------------------------------------------------------------
2839 * Job_ServerStartTokenAdd --
2840 * Prep the job token pipe in the root make process.
2842 *-----------------------------------------------------------------------
2845 void
2846 Job_ServerStart(int max_tokens, int jp_0, int jp_1)
2848 int i;
2849 char jobarg[64];
2851 if (jp_0 >= 0 && jp_1 >= 0) {
2852 /* Pipe passed in from parent */
2853 tokenWaitJob.inPipe = jp_0;
2854 tokenWaitJob.outPipe = jp_1;
2855 (void)fcntl(jp_0, F_SETFD, 1);
2856 (void)fcntl(jp_1, F_SETFD, 1);
2857 return;
2860 JobCreatePipe(&tokenWaitJob, 15);
2862 snprintf(jobarg, sizeof(jobarg), "%d,%d",
2863 tokenWaitJob.inPipe, tokenWaitJob.outPipe);
2865 Var_Append(MAKEFLAGS, "-J", VAR_GLOBAL);
2866 Var_Append(MAKEFLAGS, jobarg, VAR_GLOBAL);
2869 * Preload the job pipe with one token per job, save the one
2870 * "extra" token for the primary job.
2872 * XXX should clip maxJobs against PIPE_BUF -- if max_tokens is
2873 * larger than the write buffer size of the pipe, we will
2874 * deadlock here.
2876 for (i = 1; i < max_tokens; i++)
2877 JobTokenAdd();
2881 *-----------------------------------------------------------------------
2882 * Job_TokenReturn --
2883 * Return a withdrawn token to the pool.
2885 *-----------------------------------------------------------------------
2888 void
2889 Job_TokenReturn(void)
2891 jobTokensRunning--;
2892 if (jobTokensRunning < 0)
2893 Punt("token botch");
2894 if (jobTokensRunning || JOB_TOKENS[aborting] != '+')
2895 JobTokenAdd();
2899 *-----------------------------------------------------------------------
2900 * Job_TokenWithdraw --
2901 * Attempt to withdraw a token from the pool.
2903 * Results:
2904 * Returns TRUE if a token was withdrawn, and FALSE if the pool
2905 * is currently empty.
2907 * Side Effects:
2908 * If pool is empty, set wantToken so that we wake up
2909 * when a token is released.
2911 *-----------------------------------------------------------------------
2915 Boolean
2916 Job_TokenWithdraw(void)
2918 char tok, tok1;
2919 int count;
2921 wantToken = 0;
2922 if (DEBUG(JOB))
2923 fprintf(debug_file, "Job_TokenWithdraw(%d): aborting %d, running %d\n",
2924 getpid(), aborting, jobTokensRunning);
2926 if (aborting || (jobTokensRunning >= maxJobs))
2927 return FALSE;
2929 count = read(tokenWaitJob.inPipe, &tok, 1);
2930 if (count == 0)
2931 Fatal("eof on job pipe!");
2932 if (count < 0 && jobTokensRunning != 0) {
2933 if (errno != EAGAIN) {
2934 Fatal("job pipe read: %s", strerror(errno));
2936 if (DEBUG(JOB))
2937 fprintf(debug_file, "(%d) blocked for token\n", getpid());
2938 wantToken = 1;
2939 return FALSE;
2942 if (count == 1 && tok != '+') {
2943 /* make being abvorted - remove any other job tokens */
2944 if (DEBUG(JOB))
2945 fprintf(debug_file, "(%d) aborted by token %c\n", getpid(), tok);
2946 while (read(tokenWaitJob.inPipe, &tok1, 1) == 1)
2947 continue;
2948 /* And put the stopper back */
2949 while (write(tokenWaitJob.outPipe, &tok, 1) == -1 && errno == EAGAIN)
2950 continue;
2951 Fatal("A failure has been detected in another branch of the parallel make");
2954 if (count == 1 && jobTokensRunning == 0)
2955 /* We didn't want the token really */
2956 while (write(tokenWaitJob.outPipe, &tok, 1) == -1 && errno == EAGAIN)
2957 continue;
2959 jobTokensRunning++;
2960 if (DEBUG(JOB))
2961 fprintf(debug_file, "(%d) withdrew token\n", getpid());
2962 return TRUE;
2966 *-----------------------------------------------------------------------
2967 * Job_RunTarget --
2968 * Run the named target if found. If a filename is specified, then
2969 * set that to the sources.
2971 * Results:
2972 * None
2974 * Side Effects:
2975 * exits if the target fails.
2977 *-----------------------------------------------------------------------
2979 Boolean
2980 Job_RunTarget(const char *target, const char *fname) {
2981 GNode *gn = Targ_FindNode(target, TARG_NOCREATE);
2983 if (gn == NULL)
2984 return FALSE;
2986 if (fname)
2987 Var_Set(ALLSRC, fname, gn, 0);
2989 JobRun(gn);
2990 if (gn->made == ERROR) {
2991 PrintOnError(gn, "\n\nStop.");
2992 exit(1);
2994 return TRUE;
2997 #ifdef USE_SELECT
2999 emul_poll(struct pollfd *fd, int nfd, int timeout)
3001 fd_set rfds, wfds;
3002 int i, maxfd, nselect, npoll;
3003 struct timeval tv, *tvp;
3004 long usecs;
3006 FD_ZERO(&rfds);
3007 FD_ZERO(&wfds);
3009 maxfd = -1;
3010 for (i = 0; i < nfd; i++) {
3011 fd[i].revents = 0;
3013 if (fd[i].events & POLLIN)
3014 FD_SET(fd[i].fd, &rfds);
3016 if (fd[i].events & POLLOUT)
3017 FD_SET(fd[i].fd, &wfds);
3019 if (fd[i].fd > maxfd)
3020 maxfd = fd[i].fd;
3023 if (maxfd >= FD_SETSIZE) {
3024 Punt("Ran out of fd_set slots; "
3025 "recompile with a larger FD_SETSIZE.");
3028 if (timeout < 0) {
3029 tvp = NULL;
3030 } else {
3031 usecs = timeout * 1000;
3032 tv.tv_sec = usecs / 1000000;
3033 tv.tv_usec = usecs % 1000000;
3034 tvp = &tv;
3037 nselect = select(maxfd + 1, &rfds, &wfds, 0, tvp);
3039 if (nselect <= 0)
3040 return nselect;
3042 npoll = 0;
3043 for (i = 0; i < nfd; i++) {
3044 if (FD_ISSET(fd[i].fd, &rfds))
3045 fd[i].revents |= POLLIN;
3047 if (FD_ISSET(fd[i].fd, &wfds))
3048 fd[i].revents |= POLLOUT;
3050 if (fd[i].revents)
3051 npoll++;
3054 return npoll;
3056 #endif /* USE_SELECT */