VM: make mapping types explicit
[minix.git] / usr.bin / make / job.c
blob1e8eefb14705593046a9355f64eb79f30c6e0e15
1 /* $NetBSD: job.c,v 1.161 2012/04/07 18:29:08 christos 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.161 2012/04/07 18:29:08 christos 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.161 2012/04/07 18:29:08 christos 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 #include <sys/types.h>
137 #include <sys/stat.h>
138 #include <sys/file.h>
139 #include <sys/time.h>
140 #include <sys/wait.h>
142 #include <errno.h>
143 #include <fcntl.h>
144 #ifndef USE_SELECT
145 #include <poll.h>
146 #endif
147 #include <signal.h>
148 #include <stdio.h>
149 #include <string.h>
150 #include <utime.h>
152 #include "make.h"
153 #include "hash.h"
154 #include "dir.h"
155 #include "job.h"
156 #include "pathnames.h"
157 #include "trace.h"
158 # define STATIC static
161 * error handling variables
163 static int errors = 0; /* number of errors reported */
164 static int aborting = 0; /* why is the make aborting? */
165 #define ABORT_ERROR 1 /* Because of an error */
166 #define ABORT_INTERRUPT 2 /* Because it was interrupted */
167 #define ABORT_WAIT 3 /* Waiting for jobs to finish */
168 #define JOB_TOKENS "+EI+" /* Token to requeue for each abort state */
171 * this tracks the number of tokens currently "out" to build jobs.
173 int jobTokensRunning = 0;
174 int not_parallel = 0; /* set if .NOT_PARALLEL */
177 * XXX: Avoid SunOS bug... FILENO() is fp->_file, and file
178 * is a char! So when we go above 127 we turn negative!
180 #define FILENO(a) ((unsigned) fileno(a))
183 * post-make command processing. The node postCommands is really just the
184 * .END target but we keep it around to avoid having to search for it
185 * all the time.
187 static GNode *postCommands = NULL;
188 /* node containing commands to execute when
189 * everything else is done */
190 static int numCommands; /* The number of commands actually printed
191 * for a target. Should this number be
192 * 0, no shell will be executed. */
195 * Return values from JobStart.
197 #define JOB_RUNNING 0 /* Job is running */
198 #define JOB_ERROR 1 /* Error in starting the job */
199 #define JOB_FINISHED 2 /* The job is already finished */
202 * Descriptions for various shells.
204 * The build environment may set DEFSHELL_INDEX to one of
205 * DEFSHELL_INDEX_SH, DEFSHELL_INDEX_KSH, or DEFSHELL_INDEX_CSH, to
206 * select one of the prefedined shells as the default shell.
208 * Alternatively, the build environment may set DEFSHELL_CUSTOM to the
209 * name or the full path of a sh-compatible shell, which will be used as
210 * the default shell.
212 * ".SHELL" lines in Makefiles can choose the default shell from the
213 # set defined here, or add additional shells.
216 #ifdef DEFSHELL_CUSTOM
217 #define DEFSHELL_INDEX_CUSTOM 0
218 #define DEFSHELL_INDEX_SH 1
219 #define DEFSHELL_INDEX_KSH 2
220 #define DEFSHELL_INDEX_CSH 3
221 #else /* !DEFSHELL_CUSTOM */
222 #define DEFSHELL_INDEX_SH 0
223 #define DEFSHELL_INDEX_KSH 1
224 #define DEFSHELL_INDEX_CSH 2
225 #endif /* !DEFSHELL_CUSTOM */
227 #ifndef DEFSHELL_INDEX
228 #define DEFSHELL_INDEX 0 /* DEFSHELL_INDEX_CUSTOM or DEFSHELL_INDEX_SH */
229 #endif /* !DEFSHELL_INDEX */
231 static Shell shells[] = {
232 #ifdef DEFSHELL_CUSTOM
234 * An sh-compatible shell with a non-standard name.
236 * Keep this in sync with the "sh" description below, but avoid
237 * non-portable features that might not be supplied by all
238 * sh-compatible shells.
241 DEFSHELL_CUSTOM,
242 FALSE, "", "", "", 0,
243 FALSE, "echo \"%s\"\n", "%s\n", "{ %s \n} || exit $?\n", "'\n'", '#',
247 #endif /* DEFSHELL_CUSTOM */
249 * SH description. Echo control is also possible and, under
250 * sun UNIX anyway, one can even control error checking.
253 "sh",
254 FALSE, "", "", "", 0,
255 FALSE, "echo \"%s\"\n", "%s\n", "{ %s \n} || exit $?\n", "'\n'", '#',
256 #if defined(MAKE_NATIVE) && defined(__NetBSD__)
257 "q",
258 #else
260 #endif
264 * KSH description.
267 "ksh",
268 TRUE, "set +v", "set -v", "set +v", 6,
269 FALSE, "echo \"%s\"\n", "%s\n", "{ %s \n} || exit $?\n", "'\n'", '#',
270 "v",
274 * CSH description. The csh can do echo control by playing
275 * with the setting of the 'echo' shell variable. Sadly,
276 * however, it is unable to do error control nicely.
279 "csh",
280 TRUE, "unset verbose", "set verbose", "unset verbose", 10,
281 FALSE, "echo \"%s\"\n", "csh -c \"%s || exit 0\"\n", "", "'\\\n'", '#',
282 "v", "e",
285 * UNKNOWN.
288 NULL,
289 FALSE, NULL, NULL, NULL, 0,
290 FALSE, NULL, NULL, NULL, NULL, 0,
291 NULL, NULL,
294 static Shell *commandShell = &shells[DEFSHELL_INDEX]; /* this is the shell to
295 * which we pass all
296 * commands in the Makefile.
297 * It is set by the
298 * Job_ParseShell function */
299 const char *shellPath = NULL, /* full pathname of
300 * executable image */
301 *shellName = NULL; /* last component of shell */
302 static const char *shellArgv = NULL; /* Custom shell args */
305 STATIC Job *job_table; /* The structures that describe them */
306 STATIC Job *job_table_end; /* job_table + maxJobs */
307 static int wantToken; /* we want a token */
308 static int lurking_children = 0;
309 static int make_suspended = 0; /* non-zero if we've seen a SIGTSTP (etc) */
312 * Set of descriptors of pipes connected to
313 * the output channels of children
315 static struct pollfd *fds = NULL;
316 static Job **jobfds = NULL;
317 static int nfds = 0;
318 static void watchfd(Job *);
319 static void clearfd(Job *);
320 static int readyfd(Job *);
322 STATIC GNode *lastNode; /* The node for which output was most recently
323 * produced. */
324 static char *targPrefix = NULL; /* What we print at the start of TARG_FMT */
325 static Job tokenWaitJob; /* token wait pseudo-job */
327 static Job childExitJob; /* child exit pseudo-job */
328 #define CHILD_EXIT "."
329 #define DO_JOB_RESUME "R"
331 #define TARG_FMT "%s %s ---\n" /* Default format */
332 #define MESSAGE(fp, gn) \
333 if (maxJobs != 1) \
334 (void)fprintf(fp, TARG_FMT, targPrefix, gn->name)
336 static sigset_t caught_signals; /* Set of signals we handle */
337 #if defined(SYSV)
338 #define KILLPG(pid, sig) kill(-(pid), (sig))
339 #else
340 #define KILLPG(pid, sig) killpg((pid), (sig))
341 #endif
343 static void JobChildSig(int);
344 static void JobContinueSig(int);
345 static Job *JobFindPid(int, int, Boolean);
346 static int JobPrintCommand(void *, void *);
347 static int JobSaveCommand(void *, void *);
348 static void JobClose(Job *);
349 static void JobExec(Job *, char **);
350 static void JobMakeArgv(Job *, char **);
351 static int JobStart(GNode *, int);
352 static char *JobOutput(Job *, char *, char *, int);
353 static void JobDoOutput(Job *, Boolean);
354 static Shell *JobMatchShell(const char *);
355 static void JobInterrupt(int, int) __dead;
356 static void JobRestartJobs(void);
357 static void JobTokenAdd(void);
358 static void JobSigLock(sigset_t *);
359 static void JobSigUnlock(sigset_t *);
360 static void JobSigReset(void);
362 const char *malloc_options="A";
364 static void
365 job_table_dump(const char *where)
367 Job *job;
369 fprintf(debug_file, "job table @ %s\n", where);
370 for (job = job_table; job < job_table_end; job++) {
371 fprintf(debug_file, "job %d, status %d, flags %d, pid %d\n",
372 (int)(job - job_table), job->job_state, job->flags, job->pid);
377 * JobSigLock/JobSigUnlock
379 * Signal lock routines to get exclusive access. Currently used to
380 * protect `jobs' and `stoppedJobs' list manipulations.
382 static void JobSigLock(sigset_t *omaskp)
384 if (sigprocmask(SIG_BLOCK, &caught_signals, omaskp) != 0) {
385 Punt("JobSigLock: sigprocmask: %s", strerror(errno));
386 sigemptyset(omaskp);
390 static void JobSigUnlock(sigset_t *omaskp)
392 (void)sigprocmask(SIG_SETMASK, omaskp, NULL);
395 static void
396 JobCreatePipe(Job *job, int minfd)
398 int i, fd;
400 if (pipe(job->jobPipe) == -1)
401 Punt("Cannot create pipe: %s", strerror(errno));
403 /* Set close-on-exec flag for both */
404 (void)fcntl(job->jobPipe[0], F_SETFD, 1);
405 (void)fcntl(job->jobPipe[1], F_SETFD, 1);
408 * We mark the input side of the pipe non-blocking; we poll(2) the
409 * pipe when we're waiting for a job token, but we might lose the
410 * race for the token when a new one becomes available, so the read
411 * from the pipe should not block.
413 fcntl(job->jobPipe[0], F_SETFL,
414 fcntl(job->jobPipe[0], F_GETFL, 0) | O_NONBLOCK);
416 for (i = 0; i < 2; i++) {
417 /* Avoid using low numbered fds */
418 fd = fcntl(job->jobPipe[i], F_DUPFD, minfd);
419 if (fd != -1) {
420 close(job->jobPipe[i]);
421 job->jobPipe[i] = fd;
427 *-----------------------------------------------------------------------
428 * JobCondPassSig --
429 * Pass a signal to a job
431 * Input:
432 * signop Signal to send it
434 * Side Effects:
435 * None, except the job may bite it.
437 *-----------------------------------------------------------------------
439 static void
440 JobCondPassSig(int signo)
442 Job *job;
444 if (DEBUG(JOB)) {
445 (void)fprintf(debug_file, "JobCondPassSig(%d) called.\n", signo);
448 for (job = job_table; job < job_table_end; job++) {
449 if (job->job_state != JOB_ST_RUNNING)
450 continue;
451 if (DEBUG(JOB)) {
452 (void)fprintf(debug_file,
453 "JobCondPassSig passing signal %d to child %d.\n",
454 signo, job->pid);
456 KILLPG(job->pid, signo);
461 *-----------------------------------------------------------------------
462 * JobChldSig --
463 * SIGCHLD handler.
465 * Input:
466 * signo The signal number we've received
468 * Results:
469 * None.
471 * Side Effects:
472 * Sends a token on the child exit pipe to wake us up from
473 * select()/poll().
475 *-----------------------------------------------------------------------
477 static void
478 JobChildSig(int signo __unused)
480 write(childExitJob.outPipe, CHILD_EXIT, 1);
485 *-----------------------------------------------------------------------
486 * JobContinueSig --
487 * Resume all stopped jobs.
489 * Input:
490 * signo The signal number we've received
492 * Results:
493 * None.
495 * Side Effects:
496 * Jobs start running again.
498 *-----------------------------------------------------------------------
500 static void
501 JobContinueSig(int signo __unused)
504 * Defer sending to SIGCONT to our stopped children until we return
505 * from the signal handler.
507 write(childExitJob.outPipe, DO_JOB_RESUME, 1);
511 *-----------------------------------------------------------------------
512 * JobPassSig --
513 * Pass a signal on to all jobs, then resend to ourselves.
515 * Input:
516 * signo The signal number we've received
518 * Results:
519 * None.
521 * Side Effects:
522 * We die by the same signal.
524 *-----------------------------------------------------------------------
526 __dead static void
527 JobPassSig_int(int signo)
529 /* Run .INTERRUPT target then exit */
530 JobInterrupt(TRUE, signo);
533 __dead static void
534 JobPassSig_term(int signo)
536 /* Dont run .INTERRUPT target then exit */
537 JobInterrupt(FALSE, signo);
540 static void
541 JobPassSig_suspend(int signo)
543 sigset_t nmask, omask;
544 struct sigaction act;
546 /* Suppress job started/continued messages */
547 make_suspended = 1;
549 /* Pass the signal onto every job */
550 JobCondPassSig(signo);
553 * Send ourselves the signal now we've given the message to everyone else.
554 * Note we block everything else possible while we're getting the signal.
555 * This ensures that all our jobs get continued when we wake up before
556 * we take any other signal.
558 sigfillset(&nmask);
559 sigdelset(&nmask, signo);
560 (void)sigprocmask(SIG_SETMASK, &nmask, &omask);
562 act.sa_handler = SIG_DFL;
563 sigemptyset(&act.sa_mask);
564 act.sa_flags = 0;
565 (void)sigaction(signo, &act, NULL);
567 if (DEBUG(JOB)) {
568 (void)fprintf(debug_file,
569 "JobPassSig passing signal %d to self.\n", signo);
572 (void)kill(getpid(), signo);
575 * We've been continued.
577 * A whole host of signals continue to happen!
578 * SIGCHLD for any processes that actually suspended themselves.
579 * SIGCHLD for any processes that exited while we were alseep.
580 * The SIGCONT that actually caused us to wakeup.
582 * Since we defer passing the SIGCONT on to our children until
583 * the main processing loop, we can be sure that all the SIGCHLD
584 * events will have happened by then - and that the waitpid() will
585 * collect the child 'suspended' events.
586 * For correct sequencing we just need to ensure we process the
587 * waitpid() before passign on the SIGCONT.
589 * In any case nothing else is needed here.
592 /* Restore handler and signal mask */
593 act.sa_handler = JobPassSig_suspend;
594 (void)sigaction(signo, &act, NULL);
595 (void)sigprocmask(SIG_SETMASK, &omask, NULL);
599 *-----------------------------------------------------------------------
600 * JobFindPid --
601 * Compare the pid of the job with the given pid and return 0 if they
602 * are equal. This function is called from Job_CatchChildren
603 * to find the job descriptor of the finished job.
605 * Input:
606 * job job to examine
607 * pid process id desired
609 * Results:
610 * Job with matching pid
612 * Side Effects:
613 * None
614 *-----------------------------------------------------------------------
616 static Job *
617 JobFindPid(int pid, int status, Boolean isJobs)
619 Job *job;
621 for (job = job_table; job < job_table_end; job++) {
622 if ((job->job_state == status) && job->pid == pid)
623 return job;
625 if (DEBUG(JOB) && isJobs)
626 job_table_dump("no pid");
627 return NULL;
631 *-----------------------------------------------------------------------
632 * JobPrintCommand --
633 * Put out another command for the given job. If the command starts
634 * with an @ or a - we process it specially. In the former case,
635 * so long as the -s and -n flags weren't given to make, we stick
636 * a shell-specific echoOff command in the script. In the latter,
637 * we ignore errors for the entire job, unless the shell has error
638 * control.
639 * If the command is just "..." we take all future commands for this
640 * job to be commands to be executed once the entire graph has been
641 * made and return non-zero to signal that the end of the commands
642 * was reached. These commands are later attached to the postCommands
643 * node and executed by Job_End when all things are done.
644 * This function is called from JobStart via Lst_ForEach.
646 * Input:
647 * cmdp command string to print
648 * jobp job for which to print it
650 * Results:
651 * Always 0, unless the command was "..."
653 * Side Effects:
654 * If the command begins with a '-' and the shell has no error control,
655 * the JOB_IGNERR flag is set in the job descriptor.
656 * If the command is "..." and we're not ignoring such things,
657 * tailCmds is set to the successor node of the cmd.
658 * numCommands is incremented if the command is actually printed.
659 *-----------------------------------------------------------------------
661 static int
662 JobPrintCommand(void *cmdp, void *jobp)
664 Boolean noSpecials; /* true if we shouldn't worry about
665 * inserting special commands into
666 * the input stream. */
667 Boolean shutUp = FALSE; /* true if we put a no echo command
668 * into the command file */
669 Boolean errOff = FALSE; /* true if we turned error checking
670 * off before printing the command
671 * and need to turn it back on */
672 const char *cmdTemplate; /* Template to use when printing the
673 * command */
674 char *cmdStart; /* Start of expanded command */
675 char *escCmd = NULL; /* Command with quotes/backticks escaped */
676 char *cmd = (char *)cmdp;
677 Job *job = (Job *)jobp;
678 char *cp, *tmp;
679 int i, j;
681 noSpecials = NoExecute(job->node);
683 if (strcmp(cmd, "...") == 0) {
684 job->node->type |= OP_SAVE_CMDS;
685 if ((job->flags & JOB_IGNDOTS) == 0) {
686 job->tailCmds = Lst_Succ(Lst_Member(job->node->commands,
687 cmd));
688 return 1;
690 return 0;
693 #define DBPRINTF(fmt, arg) if (DEBUG(JOB)) { \
694 (void)fprintf(debug_file, fmt, arg); \
696 (void)fprintf(job->cmdFILE, fmt, arg); \
697 (void)fflush(job->cmdFILE);
699 numCommands += 1;
701 cmdStart = cmd = Var_Subst(NULL, cmd, job->node, FALSE);
703 cmdTemplate = "%s\n";
706 * Check for leading @' and -'s to control echoing and error checking.
708 while (*cmd == '@' || *cmd == '-' || (*cmd == '+')) {
709 switch (*cmd) {
710 case '@':
711 shutUp = DEBUG(LOUD) ? FALSE : TRUE;
712 break;
713 case '-':
714 job->flags |= JOB_IGNERR;
715 errOff = TRUE;
716 break;
717 case '+':
718 if (noSpecials) {
720 * We're not actually executing anything...
721 * but this one needs to be - use compat mode just for it.
723 CompatRunCommand(cmdp, job->node);
724 return 0;
726 break;
728 cmd++;
731 while (isspace((unsigned char) *cmd))
732 cmd++;
735 * If the shell doesn't have error control the alternate echo'ing will
736 * be done (to avoid showing additional error checking code)
737 * and this will need the characters '$ ` \ "' escaped
740 if (!commandShell->hasErrCtl) {
741 /* Worst that could happen is every char needs escaping. */
742 escCmd = bmake_malloc((strlen(cmd) * 2) + 1);
743 for (i = 0, j= 0; cmd[i] != '\0'; i++, j++) {
744 if (cmd[i] == '$' || cmd[i] == '`' || cmd[i] == '\\' ||
745 cmd[i] == '"')
746 escCmd[j++] = '\\';
747 escCmd[j] = cmd[i];
749 escCmd[j] = 0;
752 if (shutUp) {
753 if (!(job->flags & JOB_SILENT) && !noSpecials &&
754 commandShell->hasEchoCtl) {
755 DBPRINTF("%s\n", commandShell->echoOff);
756 } else {
757 if (commandShell->hasErrCtl)
758 shutUp = FALSE;
762 if (errOff) {
763 if (!noSpecials) {
764 if (commandShell->hasErrCtl) {
766 * we don't want the error-control commands showing
767 * up either, so we turn off echoing while executing
768 * them. We could put another field in the shell
769 * structure to tell JobDoOutput to look for this
770 * string too, but why make it any more complex than
771 * it already is?
773 if (!(job->flags & JOB_SILENT) && !shutUp &&
774 commandShell->hasEchoCtl) {
775 DBPRINTF("%s\n", commandShell->echoOff);
776 DBPRINTF("%s\n", commandShell->ignErr);
777 DBPRINTF("%s\n", commandShell->echoOn);
778 } else {
779 DBPRINTF("%s\n", commandShell->ignErr);
781 } else if (commandShell->ignErr &&
782 (*commandShell->ignErr != '\0'))
785 * The shell has no error control, so we need to be
786 * weird to get it to ignore any errors from the command.
787 * If echoing is turned on, we turn it off and use the
788 * errCheck template to echo the command. Leave echoing
789 * off so the user doesn't see the weirdness we go through
790 * to ignore errors. Set cmdTemplate to use the weirdness
791 * instead of the simple "%s\n" template.
793 if (!(job->flags & JOB_SILENT) && !shutUp) {
794 if (commandShell->hasEchoCtl) {
795 DBPRINTF("%s\n", commandShell->echoOff);
797 DBPRINTF(commandShell->errCheck, escCmd);
798 shutUp = TRUE;
799 } else {
800 if (!shutUp) {
801 DBPRINTF(commandShell->errCheck, escCmd);
804 cmdTemplate = commandShell->ignErr;
806 * The error ignoration (hee hee) is already taken care
807 * of by the ignErr template, so pretend error checking
808 * is still on.
810 errOff = FALSE;
811 } else {
812 errOff = FALSE;
814 } else {
815 errOff = FALSE;
817 } else {
820 * If errors are being checked and the shell doesn't have error control
821 * but does supply an errOut template, then setup commands to run
822 * through it.
825 if (!commandShell->hasErrCtl && commandShell->errOut &&
826 (*commandShell->errOut != '\0')) {
827 if (!(job->flags & JOB_SILENT) && !shutUp) {
828 if (commandShell->hasEchoCtl) {
829 DBPRINTF("%s\n", commandShell->echoOff);
831 DBPRINTF(commandShell->errCheck, escCmd);
832 shutUp = TRUE;
834 /* If it's a comment line or blank, treat as an ignored error */
835 if ((escCmd[0] == commandShell->commentChar) ||
836 (escCmd[0] == 0))
837 cmdTemplate = commandShell->ignErr;
838 else
839 cmdTemplate = commandShell->errOut;
840 errOff = FALSE;
844 if (DEBUG(SHELL) && strcmp(shellName, "sh") == 0 &&
845 (job->flags & JOB_TRACED) == 0) {
846 DBPRINTF("set -%s\n", "x");
847 job->flags |= JOB_TRACED;
850 if ((cp = Check_Cwd_Cmd(cmd)) != NULL) {
851 DBPRINTF("test -d %s && ", cp);
852 DBPRINTF("cd %s\n", cp);
855 DBPRINTF(cmdTemplate, cmd);
856 free(cmdStart);
857 if (escCmd)
858 free(escCmd);
859 if (errOff) {
861 * If echoing is already off, there's no point in issuing the
862 * echoOff command. Otherwise we issue it and pretend it was on
863 * for the whole command...
865 if (!shutUp && !(job->flags & JOB_SILENT) && commandShell->hasEchoCtl){
866 DBPRINTF("%s\n", commandShell->echoOff);
867 shutUp = TRUE;
869 DBPRINTF("%s\n", commandShell->errCheck);
871 if (shutUp && commandShell->hasEchoCtl) {
872 DBPRINTF("%s\n", commandShell->echoOn);
874 if (cp != NULL) {
875 DBPRINTF("test -d %s && ", cp);
876 DBPRINTF("cd %s\n", Var_Value(".OBJDIR", VAR_GLOBAL, &tmp));
878 return 0;
882 *-----------------------------------------------------------------------
883 * JobSaveCommand --
884 * Save a command to be executed when everything else is done.
885 * Callback function for JobFinish...
887 * Results:
888 * Always returns 0
890 * Side Effects:
891 * The command is tacked onto the end of postCommands's commands list.
893 *-----------------------------------------------------------------------
895 static int
896 JobSaveCommand(void *cmd, void *gn)
898 cmd = Var_Subst(NULL, (char *)cmd, (GNode *)gn, FALSE);
899 (void)Lst_AtEnd(postCommands->commands, cmd);
900 return(0);
905 *-----------------------------------------------------------------------
906 * JobClose --
907 * Called to close both input and output pipes when a job is finished.
909 * Results:
910 * Nada
912 * Side Effects:
913 * The file descriptors associated with the job are closed.
915 *-----------------------------------------------------------------------
917 static void
918 JobClose(Job *job)
920 clearfd(job);
921 (void)close(job->outPipe);
922 job->outPipe = -1;
924 JobDoOutput(job, TRUE);
925 (void)close(job->inPipe);
926 job->inPipe = -1;
930 *-----------------------------------------------------------------------
931 * JobFinish --
932 * Do final processing for the given job including updating
933 * parents and starting new jobs as available/necessary. Note
934 * that we pay no attention to the JOB_IGNERR flag here.
935 * This is because when we're called because of a noexecute flag
936 * or something, jstat.w_status is 0 and when called from
937 * Job_CatchChildren, the status is zeroed if it s/b ignored.
939 * Input:
940 * job job to finish
941 * status sub-why job went away
943 * Results:
944 * None
946 * Side Effects:
947 * Final commands for the job are placed on postCommands.
949 * If we got an error and are aborting (aborting == ABORT_ERROR) and
950 * the job list is now empty, we are done for the day.
951 * If we recognized an error (errors !=0), we set the aborting flag
952 * to ABORT_ERROR so no more jobs will be started.
953 *-----------------------------------------------------------------------
955 /*ARGSUSED*/
956 static void
957 JobFinish(Job *job, int status)
959 Boolean done, return_job_token;
961 if (DEBUG(JOB)) {
962 fprintf(debug_file, "Jobfinish: %d [%s], status %d\n",
963 job->pid, job->node->name, status);
966 if ((WIFEXITED(status) &&
967 (((WEXITSTATUS(status) != 0) && !(job->flags & JOB_IGNERR)))) ||
968 WIFSIGNALED(status))
971 * If it exited non-zero and either we're doing things our
972 * way or we're not ignoring errors, the job is finished.
973 * Similarly, if the shell died because of a signal
974 * the job is also finished. In these
975 * cases, finish out the job's output before printing the exit
976 * status...
978 JobClose(job);
979 if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
980 (void)fclose(job->cmdFILE);
981 job->cmdFILE = NULL;
983 done = TRUE;
984 } else if (WIFEXITED(status)) {
986 * Deal with ignored errors in -B mode. We need to print a message
987 * telling of the ignored error as well as setting status.w_status
988 * to 0 so the next command gets run. To do this, we set done to be
989 * TRUE if in -B mode and the job exited non-zero.
991 done = WEXITSTATUS(status) != 0;
993 * Old comment said: "Note we don't
994 * want to close down any of the streams until we know we're at the
995 * end."
996 * But we do. Otherwise when are we going to print the rest of the
997 * stuff?
999 JobClose(job);
1000 } else {
1002 * No need to close things down or anything.
1004 done = FALSE;
1007 if (done) {
1008 if (WIFEXITED(status)) {
1009 if (DEBUG(JOB)) {
1010 (void)fprintf(debug_file, "Process %d [%s] exited.\n",
1011 job->pid, job->node->name);
1013 if (WEXITSTATUS(status) != 0) {
1014 if (job->node != lastNode) {
1015 MESSAGE(stdout, job->node);
1016 lastNode = job->node;
1018 #ifdef USE_META
1019 if (useMeta) {
1020 meta_job_error(job, job->node, job->flags, WEXITSTATUS(status));
1022 #endif
1023 (void)printf("*** [%s] Error code %d%s\n",
1024 job->node->name,
1025 WEXITSTATUS(status),
1026 (job->flags & JOB_IGNERR) ? " (ignored)" : "");
1027 if (job->flags & JOB_IGNERR) {
1028 status = 0;
1029 } else {
1030 PrintOnError(job->node, NULL);
1032 } else if (DEBUG(JOB)) {
1033 if (job->node != lastNode) {
1034 MESSAGE(stdout, job->node);
1035 lastNode = job->node;
1037 (void)printf("*** [%s] Completed successfully\n",
1038 job->node->name);
1040 } else {
1041 if (job->node != lastNode) {
1042 MESSAGE(stdout, job->node);
1043 lastNode = job->node;
1045 (void)printf("*** [%s] Signal %d\n",
1046 job->node->name, WTERMSIG(status));
1048 (void)fflush(stdout);
1051 #ifdef USE_META
1052 if (useMeta) {
1053 meta_job_finish(job);
1055 #endif
1057 return_job_token = FALSE;
1059 Trace_Log(JOBEND, job);
1060 if (!(job->flags & JOB_SPECIAL)) {
1061 if ((status != 0) ||
1062 (aborting == ABORT_ERROR) ||
1063 (aborting == ABORT_INTERRUPT))
1064 return_job_token = TRUE;
1067 if ((aborting != ABORT_ERROR) && (aborting != ABORT_INTERRUPT) && (status == 0)) {
1069 * As long as we aren't aborting and the job didn't return a non-zero
1070 * status that we shouldn't ignore, we call Make_Update to update
1071 * the parents. In addition, any saved commands for the node are placed
1072 * on the .END target.
1074 if (job->tailCmds != NULL) {
1075 Lst_ForEachFrom(job->node->commands, job->tailCmds,
1076 JobSaveCommand,
1077 job->node);
1079 job->node->made = MADE;
1080 if (!(job->flags & JOB_SPECIAL))
1081 return_job_token = TRUE;
1082 Make_Update(job->node);
1083 job->job_state = JOB_ST_FREE;
1084 } else if (status != 0) {
1085 errors += 1;
1086 job->job_state = JOB_ST_FREE;
1090 * Set aborting if any error.
1092 if (errors && !keepgoing && (aborting != ABORT_INTERRUPT)) {
1094 * If we found any errors in this batch of children and the -k flag
1095 * wasn't given, we set the aborting flag so no more jobs get
1096 * started.
1098 aborting = ABORT_ERROR;
1101 if (return_job_token)
1102 Job_TokenReturn();
1104 if (aborting == ABORT_ERROR && jobTokensRunning == 0) {
1106 * If we are aborting and the job table is now empty, we finish.
1108 Finish(errors);
1113 *-----------------------------------------------------------------------
1114 * Job_Touch --
1115 * Touch the given target. Called by JobStart when the -t flag was
1116 * given
1118 * Input:
1119 * gn the node of the file to touch
1120 * silent TRUE if should not print message
1122 * Results:
1123 * None
1125 * Side Effects:
1126 * The data modification of the file is changed. In addition, if the
1127 * file did not exist, it is created.
1128 *-----------------------------------------------------------------------
1130 void
1131 Job_Touch(GNode *gn, Boolean silent)
1133 int streamID; /* ID of stream opened to do the touch */
1134 struct utimbuf times; /* Times for utime() call */
1136 if (gn->type & (OP_JOIN|OP_USE|OP_USEBEFORE|OP_EXEC|OP_OPTIONAL|
1137 OP_SPECIAL|OP_PHONY)) {
1139 * .JOIN, .USE, .ZEROTIME and .OPTIONAL targets are "virtual" targets
1140 * and, as such, shouldn't really be created.
1142 return;
1145 if (!silent || NoExecute(gn)) {
1146 (void)fprintf(stdout, "touch %s\n", gn->name);
1147 (void)fflush(stdout);
1150 if (NoExecute(gn)) {
1151 return;
1154 if (gn->type & OP_ARCHV) {
1155 Arch_Touch(gn);
1156 } else if (gn->type & OP_LIB) {
1157 Arch_TouchLib(gn);
1158 } else {
1159 char *file = gn->path ? gn->path : gn->name;
1161 times.actime = times.modtime = now;
1162 if (utime(file, &times) < 0){
1163 streamID = open(file, O_RDWR | O_CREAT, 0666);
1165 if (streamID >= 0) {
1166 char c;
1169 * Read and write a byte to the file to change the
1170 * modification time, then close the file.
1172 if (read(streamID, &c, 1) == 1) {
1173 (void)lseek(streamID, (off_t)0, SEEK_SET);
1174 (void)write(streamID, &c, 1);
1177 (void)close(streamID);
1178 } else {
1179 (void)fprintf(stdout, "*** couldn't touch %s: %s",
1180 file, strerror(errno));
1181 (void)fflush(stdout);
1188 *-----------------------------------------------------------------------
1189 * Job_CheckCommands --
1190 * Make sure the given node has all the commands it needs.
1192 * Input:
1193 * gn The target whose commands need verifying
1194 * abortProc Function to abort with message
1196 * Results:
1197 * TRUE if the commands list is/was ok.
1199 * Side Effects:
1200 * The node will have commands from the .DEFAULT rule added to it
1201 * if it needs them.
1202 *-----------------------------------------------------------------------
1204 Boolean
1205 Job_CheckCommands(GNode *gn, void (*abortProc)(const char *, ...))
1207 if (OP_NOP(gn->type) && Lst_IsEmpty(gn->commands) &&
1208 ((gn->type & OP_LIB) == 0 || Lst_IsEmpty(gn->children))) {
1210 * No commands. Look for .DEFAULT rule from which we might infer
1211 * commands
1213 if ((DEFAULT != NULL) && !Lst_IsEmpty(DEFAULT->commands) &&
1214 (gn->type & OP_SPECIAL) == 0) {
1215 char *p1;
1217 * Make only looks for a .DEFAULT if the node was never the
1218 * target of an operator, so that's what we do too. If
1219 * a .DEFAULT was given, we substitute its commands for gn's
1220 * commands and set the IMPSRC variable to be the target's name
1221 * The DEFAULT node acts like a transformation rule, in that
1222 * gn also inherits any attributes or sources attached to
1223 * .DEFAULT itself.
1225 Make_HandleUse(DEFAULT, gn);
1226 Var_Set(IMPSRC, Var_Value(TARGET, gn, &p1), gn, 0);
1227 if (p1)
1228 free(p1);
1229 } else if (Dir_MTime(gn, 0) == 0 && (gn->type & OP_SPECIAL) == 0) {
1231 * The node wasn't the target of an operator we have no .DEFAULT
1232 * rule to go on and the target doesn't already exist. There's
1233 * nothing more we can do for this branch. If the -k flag wasn't
1234 * given, we stop in our tracks, otherwise we just don't update
1235 * this node's parents so they never get examined.
1237 static const char msg[] = ": don't know how to make";
1239 if (gn->flags & FROM_DEPEND) {
1240 fprintf(stdout, "%s: ignoring stale %s for %s\n",
1241 progname, makeDependfile, gn->name);
1242 return TRUE;
1245 if (gn->type & OP_OPTIONAL) {
1246 (void)fprintf(stdout, "%s%s %s (ignored)\n", progname,
1247 msg, gn->name);
1248 (void)fflush(stdout);
1249 } else if (keepgoing) {
1250 (void)fprintf(stdout, "%s%s %s (continuing)\n", progname,
1251 msg, gn->name);
1252 (void)fflush(stdout);
1253 return FALSE;
1254 } else {
1255 (*abortProc)("%s%s %s. Stop", progname, msg, gn->name);
1256 return FALSE;
1260 return TRUE;
1264 *-----------------------------------------------------------------------
1265 * JobExec --
1266 * Execute the shell for the given job. Called from JobStart
1268 * Input:
1269 * job Job to execute
1271 * Results:
1272 * None.
1274 * Side Effects:
1275 * A shell is executed, outputs is altered and the Job structure added
1276 * to the job table.
1278 *-----------------------------------------------------------------------
1280 static void
1281 JobExec(Job *job, char **argv)
1283 int cpid; /* ID of new child */
1284 sigset_t mask;
1286 job->flags &= ~JOB_TRACED;
1288 if (DEBUG(JOB)) {
1289 int i;
1291 (void)fprintf(debug_file, "Running %s %sly\n", job->node->name, "local");
1292 (void)fprintf(debug_file, "\tCommand: ");
1293 for (i = 0; argv[i] != NULL; i++) {
1294 (void)fprintf(debug_file, "%s ", argv[i]);
1296 (void)fprintf(debug_file, "\n");
1300 * Some jobs produce no output and it's disconcerting to have
1301 * no feedback of their running (since they produce no output, the
1302 * banner with their name in it never appears). This is an attempt to
1303 * provide that feedback, even if nothing follows it.
1305 if ((lastNode != job->node) && !(job->flags & JOB_SILENT)) {
1306 MESSAGE(stdout, job->node);
1307 lastNode = job->node;
1310 /* No interruptions until this job is on the `jobs' list */
1311 JobSigLock(&mask);
1313 /* Pre-emptively mark job running, pid still zero though */
1314 job->job_state = JOB_ST_RUNNING;
1316 cpid = vFork();
1317 if (cpid == -1)
1318 Punt("Cannot vfork: %s", strerror(errno));
1320 if (cpid == 0) {
1321 /* Child */
1322 sigset_t tmask;
1324 #ifdef USE_META
1325 if (useMeta) {
1326 meta_job_child(job);
1328 #endif
1330 * Reset all signal handlers; this is necessary because we also
1331 * need to unblock signals before we exec(2).
1333 JobSigReset();
1335 /* Now unblock signals */
1336 sigemptyset(&tmask);
1337 JobSigUnlock(&tmask);
1340 * Must duplicate the input stream down to the child's input and
1341 * reset it to the beginning (again). Since the stream was marked
1342 * close-on-exec, we must clear that bit in the new input.
1344 if (dup2(FILENO(job->cmdFILE), 0) == -1) {
1345 execError("dup2", "job->cmdFILE");
1346 _exit(1);
1348 (void)fcntl(0, F_SETFD, 0);
1349 (void)lseek(0, (off_t)0, SEEK_SET);
1351 if (job->node->type & OP_MAKE) {
1353 * Pass job token pipe to submakes.
1355 fcntl(tokenWaitJob.inPipe, F_SETFD, 0);
1356 fcntl(tokenWaitJob.outPipe, F_SETFD, 0);
1360 * Set up the child's output to be routed through the pipe
1361 * we've created for it.
1363 if (dup2(job->outPipe, 1) == -1) {
1364 execError("dup2", "job->outPipe");
1365 _exit(1);
1368 * The output channels are marked close on exec. This bit was
1369 * duplicated by the dup2(on some systems), so we have to clear
1370 * it before routing the shell's error output to the same place as
1371 * its standard output.
1373 (void)fcntl(1, F_SETFD, 0);
1374 if (dup2(1, 2) == -1) {
1375 execError("dup2", "1, 2");
1376 _exit(1);
1380 * We want to switch the child into a different process family so
1381 * we can kill it and all its descendants in one fell swoop,
1382 * by killing its process family, but not commit suicide.
1384 #if defined(SYSV) || defined(__minix)
1385 /* XXX: dsl - I'm sure this should be setpgrp()... */
1386 (void)setsid();
1387 #else
1388 (void)setpgid(0, getpid());
1389 #endif
1391 Var_ExportVars();
1393 (void)execv(shellPath, argv);
1394 execError("exec", shellPath);
1395 _exit(1);
1398 /* Parent, continuing after the child exec */
1399 job->pid = cpid;
1401 Trace_Log(JOBSTART, job);
1404 * Set the current position in the buffer to the beginning
1405 * and mark another stream to watch in the outputs mask
1407 job->curPos = 0;
1409 watchfd(job);
1411 if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
1412 (void)fclose(job->cmdFILE);
1413 job->cmdFILE = NULL;
1417 * Now the job is actually running, add it to the table.
1419 if (DEBUG(JOB)) {
1420 fprintf(debug_file, "JobExec(%s): pid %d added to jobs table\n",
1421 job->node->name, job->pid);
1422 job_table_dump("job started");
1424 JobSigUnlock(&mask);
1428 *-----------------------------------------------------------------------
1429 * JobMakeArgv --
1430 * Create the argv needed to execute the shell for a given job.
1433 * Results:
1435 * Side Effects:
1437 *-----------------------------------------------------------------------
1439 static void
1440 JobMakeArgv(Job *job, char **argv)
1442 int argc;
1443 static char args[10]; /* For merged arguments */
1445 argv[0] = UNCONST(shellName);
1446 argc = 1;
1448 if ((commandShell->exit && (*commandShell->exit != '-')) ||
1449 (commandShell->echo && (*commandShell->echo != '-')))
1452 * At least one of the flags doesn't have a minus before it, so
1453 * merge them together. Have to do this because the *(&(@*#*&#$#
1454 * Bourne shell thinks its second argument is a file to source.
1455 * Grrrr. Note the ten-character limitation on the combined arguments.
1457 (void)snprintf(args, sizeof(args), "-%s%s",
1458 ((job->flags & JOB_IGNERR) ? "" :
1459 (commandShell->exit ? commandShell->exit : "")),
1460 ((job->flags & JOB_SILENT) ? "" :
1461 (commandShell->echo ? commandShell->echo : "")));
1463 if (args[1]) {
1464 argv[argc] = args;
1465 argc++;
1467 } else {
1468 if (!(job->flags & JOB_IGNERR) && commandShell->exit) {
1469 argv[argc] = UNCONST(commandShell->exit);
1470 argc++;
1472 if (!(job->flags & JOB_SILENT) && commandShell->echo) {
1473 argv[argc] = UNCONST(commandShell->echo);
1474 argc++;
1477 argv[argc] = NULL;
1481 *-----------------------------------------------------------------------
1482 * JobStart --
1483 * Start a target-creation process going for the target described
1484 * by the graph node gn.
1486 * Input:
1487 * gn target to create
1488 * flags flags for the job to override normal ones.
1489 * e.g. JOB_SPECIAL or JOB_IGNDOTS
1490 * previous The previous Job structure for this node, if any.
1492 * Results:
1493 * JOB_ERROR if there was an error in the commands, JOB_FINISHED
1494 * if there isn't actually anything left to do for the job and
1495 * JOB_RUNNING if the job has been started.
1497 * Side Effects:
1498 * A new Job node is created and added to the list of running
1499 * jobs. PMake is forked and a child shell created.
1501 * NB: I'm fairly sure that this code is never called with JOB_SPECIAL set
1502 * JOB_IGNDOTS is never set (dsl)
1503 * Also the return value is ignored by everyone.
1504 *-----------------------------------------------------------------------
1506 static int
1507 JobStart(GNode *gn, int flags)
1509 Job *job; /* new job descriptor */
1510 char *argv[10]; /* Argument vector to shell */
1511 Boolean cmdsOK; /* true if the nodes commands were all right */
1512 Boolean noExec; /* Set true if we decide not to run the job */
1513 int tfd; /* File descriptor to the temp file */
1515 for (job = job_table; job < job_table_end; job++) {
1516 if (job->job_state == JOB_ST_FREE)
1517 break;
1519 if (job >= job_table_end)
1520 Punt("JobStart no job slots vacant");
1522 memset(job, 0, sizeof *job);
1523 job->job_state = JOB_ST_SETUP;
1524 if (gn->type & OP_SPECIAL)
1525 flags |= JOB_SPECIAL;
1527 job->node = gn;
1528 job->tailCmds = NULL;
1531 * Set the initial value of the flags for this job based on the global
1532 * ones and the node's attributes... Any flags supplied by the caller
1533 * are also added to the field.
1535 job->flags = 0;
1536 if (Targ_Ignore(gn)) {
1537 job->flags |= JOB_IGNERR;
1539 if (Targ_Silent(gn)) {
1540 job->flags |= JOB_SILENT;
1542 job->flags |= flags;
1545 * Check the commands now so any attributes from .DEFAULT have a chance
1546 * to migrate to the node
1548 cmdsOK = Job_CheckCommands(gn, Error);
1550 job->inPollfd = NULL;
1552 * If the -n flag wasn't given, we open up OUR (not the child's)
1553 * temporary file to stuff commands in it. The thing is rd/wr so we don't
1554 * need to reopen it to feed it to the shell. If the -n flag *was* given,
1555 * we just set the file to be stdout. Cute, huh?
1557 if (((gn->type & OP_MAKE) && !(noRecursiveExecute)) ||
1558 (!noExecute && !touchFlag)) {
1560 * tfile is the name of a file into which all shell commands are
1561 * put. It is removed before the child shell is executed, unless
1562 * DEBUG(SCRIPT) is set.
1564 char *tfile;
1565 sigset_t mask;
1567 * We're serious here, but if the commands were bogus, we're
1568 * also dead...
1570 if (!cmdsOK) {
1571 PrintOnError(gn, NULL); /* provide some clue */
1572 DieHorribly();
1575 JobSigLock(&mask);
1576 tfd = mkTempFile(TMPPAT, &tfile);
1577 if (!DEBUG(SCRIPT))
1578 (void)eunlink(tfile);
1579 JobSigUnlock(&mask);
1581 job->cmdFILE = fdopen(tfd, "w+");
1582 if (job->cmdFILE == NULL) {
1583 Punt("Could not fdopen %s", tfile);
1585 (void)fcntl(FILENO(job->cmdFILE), F_SETFD, 1);
1587 * Send the commands to the command file, flush all its buffers then
1588 * rewind and remove the thing.
1590 noExec = FALSE;
1592 #ifdef USE_META
1593 if (useMeta) {
1594 meta_job_start(job, gn);
1595 if (Targ_Silent(gn)) { /* might have changed */
1596 job->flags |= JOB_SILENT;
1599 #endif
1601 * We can do all the commands at once. hooray for sanity
1603 numCommands = 0;
1604 Lst_ForEach(gn->commands, JobPrintCommand, job);
1607 * If we didn't print out any commands to the shell script,
1608 * there's not much point in executing the shell, is there?
1610 if (numCommands == 0) {
1611 noExec = TRUE;
1614 free(tfile);
1615 } else if (NoExecute(gn)) {
1617 * Not executing anything -- just print all the commands to stdout
1618 * in one fell swoop. This will still set up job->tailCmds correctly.
1620 if (lastNode != gn) {
1621 MESSAGE(stdout, gn);
1622 lastNode = gn;
1624 job->cmdFILE = stdout;
1626 * Only print the commands if they're ok, but don't die if they're
1627 * not -- just let the user know they're bad and keep going. It
1628 * doesn't do any harm in this case and may do some good.
1630 if (cmdsOK) {
1631 Lst_ForEach(gn->commands, JobPrintCommand, job);
1634 * Don't execute the shell, thank you.
1636 noExec = TRUE;
1637 } else {
1639 * Just touch the target and note that no shell should be executed.
1640 * Set cmdFILE to stdout to make life easier. Check the commands, too,
1641 * but don't die if they're no good -- it does no harm to keep working
1642 * up the graph.
1644 job->cmdFILE = stdout;
1645 Job_Touch(gn, job->flags&JOB_SILENT);
1646 noExec = TRUE;
1648 /* Just in case it isn't already... */
1649 (void)fflush(job->cmdFILE);
1652 * If we're not supposed to execute a shell, don't.
1654 if (noExec) {
1655 if (!(job->flags & JOB_SPECIAL))
1656 Job_TokenReturn();
1658 * Unlink and close the command file if we opened one
1660 if (job->cmdFILE != stdout) {
1661 if (job->cmdFILE != NULL) {
1662 (void)fclose(job->cmdFILE);
1663 job->cmdFILE = NULL;
1668 * We only want to work our way up the graph if we aren't here because
1669 * the commands for the job were no good.
1671 if (cmdsOK && aborting == 0) {
1672 if (job->tailCmds != NULL) {
1673 Lst_ForEachFrom(job->node->commands, job->tailCmds,
1674 JobSaveCommand,
1675 job->node);
1677 job->node->made = MADE;
1678 Make_Update(job->node);
1680 job->job_state = JOB_ST_FREE;
1681 return cmdsOK ? JOB_FINISHED : JOB_ERROR;
1685 * Set up the control arguments to the shell. This is based on the flags
1686 * set earlier for this job.
1688 JobMakeArgv(job, argv);
1690 /* Create the pipe by which we'll get the shell's output. */
1691 JobCreatePipe(job, 3);
1693 JobExec(job, argv);
1694 return(JOB_RUNNING);
1697 static char *
1698 JobOutput(Job *job, char *cp, char *endp, int msg)
1700 char *ecp;
1702 if (commandShell->noPrint) {
1703 ecp = Str_FindSubstring(cp, commandShell->noPrint);
1704 while (ecp != NULL) {
1705 if (cp != ecp) {
1706 *ecp = '\0';
1707 if (!beSilent && msg && job->node != lastNode) {
1708 MESSAGE(stdout, job->node);
1709 lastNode = job->node;
1712 * The only way there wouldn't be a newline after
1713 * this line is if it were the last in the buffer.
1714 * however, since the non-printable comes after it,
1715 * there must be a newline, so we don't print one.
1717 (void)fprintf(stdout, "%s", cp);
1718 (void)fflush(stdout);
1720 cp = ecp + commandShell->noPLen;
1721 if (cp != endp) {
1723 * Still more to print, look again after skipping
1724 * the whitespace following the non-printable
1725 * command....
1727 cp++;
1728 while (*cp == ' ' || *cp == '\t' || *cp == '\n') {
1729 cp++;
1731 ecp = Str_FindSubstring(cp, commandShell->noPrint);
1732 } else {
1733 return cp;
1737 return cp;
1741 *-----------------------------------------------------------------------
1742 * JobDoOutput --
1743 * This function is called at different times depending on
1744 * whether the user has specified that output is to be collected
1745 * via pipes or temporary files. In the former case, we are called
1746 * whenever there is something to read on the pipe. We collect more
1747 * output from the given job and store it in the job's outBuf. If
1748 * this makes up a line, we print it tagged by the job's identifier,
1749 * as necessary.
1750 * If output has been collected in a temporary file, we open the
1751 * file and read it line by line, transfering it to our own
1752 * output channel until the file is empty. At which point we
1753 * remove the temporary file.
1754 * In both cases, however, we keep our figurative eye out for the
1755 * 'noPrint' line for the shell from which the output came. If
1756 * we recognize a line, we don't print it. If the command is not
1757 * alone on the line (the character after it is not \0 or \n), we
1758 * do print whatever follows it.
1760 * Input:
1761 * job the job whose output needs printing
1762 * finish TRUE if this is the last time we'll be called
1763 * for this job
1765 * Results:
1766 * None
1768 * Side Effects:
1769 * curPos may be shifted as may the contents of outBuf.
1770 *-----------------------------------------------------------------------
1772 STATIC void
1773 JobDoOutput(Job *job, Boolean finish)
1775 Boolean gotNL = FALSE; /* true if got a newline */
1776 Boolean fbuf; /* true if our buffer filled up */
1777 int nr; /* number of bytes read */
1778 int i; /* auxiliary index into outBuf */
1779 int max; /* limit for i (end of current data) */
1780 int nRead; /* (Temporary) number of bytes read */
1783 * Read as many bytes as will fit in the buffer.
1785 end_loop:
1786 gotNL = FALSE;
1787 fbuf = FALSE;
1789 nRead = read(job->inPipe, &job->outBuf[job->curPos],
1790 JOB_BUFSIZE - job->curPos);
1791 if (nRead < 0) {
1792 if (errno == EAGAIN)
1793 return;
1794 if (DEBUG(JOB)) {
1795 perror("JobDoOutput(piperead)");
1797 nr = 0;
1798 } else {
1799 nr = nRead;
1803 * If we hit the end-of-file (the job is dead), we must flush its
1804 * remaining output, so pretend we read a newline if there's any
1805 * output remaining in the buffer.
1806 * Also clear the 'finish' flag so we stop looping.
1808 if ((nr == 0) && (job->curPos != 0)) {
1809 job->outBuf[job->curPos] = '\n';
1810 nr = 1;
1811 finish = FALSE;
1812 } else if (nr == 0) {
1813 finish = FALSE;
1817 * Look for the last newline in the bytes we just got. If there is
1818 * one, break out of the loop with 'i' as its index and gotNL set
1819 * TRUE.
1821 max = job->curPos + nr;
1822 for (i = job->curPos + nr - 1; i >= job->curPos; i--) {
1823 if (job->outBuf[i] == '\n') {
1824 gotNL = TRUE;
1825 break;
1826 } else if (job->outBuf[i] == '\0') {
1828 * Why?
1830 job->outBuf[i] = ' ';
1834 if (!gotNL) {
1835 job->curPos += nr;
1836 if (job->curPos == JOB_BUFSIZE) {
1838 * If we've run out of buffer space, we have no choice
1839 * but to print the stuff. sigh.
1841 fbuf = TRUE;
1842 i = job->curPos;
1845 if (gotNL || fbuf) {
1847 * Need to send the output to the screen. Null terminate it
1848 * first, overwriting the newline character if there was one.
1849 * So long as the line isn't one we should filter (according
1850 * to the shell description), we print the line, preceded
1851 * by a target banner if this target isn't the same as the
1852 * one for which we last printed something.
1853 * The rest of the data in the buffer are then shifted down
1854 * to the start of the buffer and curPos is set accordingly.
1856 job->outBuf[i] = '\0';
1857 if (i >= job->curPos) {
1858 char *cp;
1860 cp = JobOutput(job, job->outBuf, &job->outBuf[i], FALSE);
1863 * There's still more in that thar buffer. This time, though,
1864 * we know there's no newline at the end, so we add one of
1865 * our own free will.
1867 if (*cp != '\0') {
1868 if (!beSilent && job->node != lastNode) {
1869 MESSAGE(stdout, job->node);
1870 lastNode = job->node;
1872 #ifdef USE_META
1873 if (useMeta) {
1874 meta_job_output(job, cp, gotNL ? "\n" : "");
1876 #endif
1877 (void)fprintf(stdout, "%s%s", cp, gotNL ? "\n" : "");
1878 (void)fflush(stdout);
1881 if (i < max - 1) {
1882 /* shift the remaining characters down */
1883 (void)memcpy(job->outBuf, &job->outBuf[i + 1], max - (i + 1));
1884 job->curPos = max - (i + 1);
1886 } else {
1888 * We have written everything out, so we just start over
1889 * from the start of the buffer. No copying. No nothing.
1891 job->curPos = 0;
1894 if (finish) {
1896 * If the finish flag is true, we must loop until we hit
1897 * end-of-file on the pipe. This is guaranteed to happen
1898 * eventually since the other end of the pipe is now closed
1899 * (we closed it explicitly and the child has exited). When
1900 * we do get an EOF, finish will be set FALSE and we'll fall
1901 * through and out.
1903 goto end_loop;
1907 static void
1908 JobRun(GNode *targ)
1910 #ifdef notyet
1912 * Unfortunately it is too complicated to run .BEGIN, .END,
1913 * and .INTERRUPT job in the parallel job module. This has
1914 * the nice side effect that it avoids a lot of other problems.
1916 Lst lst = Lst_Init(FALSE);
1917 Lst_AtEnd(lst, targ);
1918 (void)Make_Run(lst);
1919 Lst_Destroy(lst, NULL);
1920 JobStart(targ, JOB_SPECIAL);
1921 while (jobTokensRunning) {
1922 Job_CatchOutput();
1924 #else
1925 Compat_Make(targ, targ);
1926 if (targ->made == ERROR) {
1927 PrintOnError(targ, "\n\nStop.");
1928 exit(1);
1930 #endif
1934 *-----------------------------------------------------------------------
1935 * Job_CatchChildren --
1936 * Handle the exit of a child. Called from Make_Make.
1938 * Input:
1939 * block TRUE if should block on the wait
1941 * Results:
1942 * none.
1944 * Side Effects:
1945 * The job descriptor is removed from the list of children.
1947 * Notes:
1948 * We do waits, blocking or not, according to the wisdom of our
1949 * caller, until there are no more children to report. For each
1950 * job, call JobFinish to finish things off.
1952 *-----------------------------------------------------------------------
1955 void
1956 Job_CatchChildren(void)
1958 int pid; /* pid of dead child */
1959 int status; /* Exit/termination status */
1962 * Don't even bother if we know there's no one around.
1964 if (jobTokensRunning == 0)
1965 return;
1967 while ((pid = waitpid((pid_t) -1, &status, WNOHANG | WUNTRACED)) > 0) {
1968 if (DEBUG(JOB)) {
1969 (void)fprintf(debug_file, "Process %d exited/stopped status %x.\n", pid,
1970 status);
1972 JobReapChild(pid, status, TRUE);
1977 * It is possible that wait[pid]() was called from elsewhere,
1978 * this lets us reap jobs regardless.
1980 void
1981 JobReapChild(pid_t pid, int status, Boolean isJobs)
1983 Job *job; /* job descriptor for dead child */
1986 * Don't even bother if we know there's no one around.
1988 if (jobTokensRunning == 0)
1989 return;
1991 job = JobFindPid(pid, JOB_ST_RUNNING, isJobs);
1992 if (job == NULL) {
1993 if (isJobs) {
1994 if (!lurking_children)
1995 Error("Child (%d) status %x not in table?", pid, status);
1997 return; /* not ours */
1999 if (WIFSTOPPED(status)) {
2000 if (DEBUG(JOB)) {
2001 (void)fprintf(debug_file, "Process %d (%s) stopped.\n",
2002 job->pid, job->node->name);
2004 if (!make_suspended) {
2005 switch (WSTOPSIG(status)) {
2006 case SIGTSTP:
2007 (void)printf("*** [%s] Suspended\n", job->node->name);
2008 break;
2009 case SIGSTOP:
2010 (void)printf("*** [%s] Stopped\n", job->node->name);
2011 break;
2012 default:
2013 (void)printf("*** [%s] Stopped -- signal %d\n",
2014 job->node->name, WSTOPSIG(status));
2016 job->job_suspended = 1;
2018 (void)fflush(stdout);
2019 return;
2022 job->job_state = JOB_ST_FINISHED;
2023 job->exit_status = status;
2025 JobFinish(job, status);
2029 *-----------------------------------------------------------------------
2030 * Job_CatchOutput --
2031 * Catch the output from our children, if we're using
2032 * pipes do so. Otherwise just block time until we get a
2033 * signal(most likely a SIGCHLD) since there's no point in
2034 * just spinning when there's nothing to do and the reaping
2035 * of a child can wait for a while.
2037 * Results:
2038 * None
2040 * Side Effects:
2041 * Output is read from pipes if we're piping.
2042 * -----------------------------------------------------------------------
2044 void
2045 Job_CatchOutput(void)
2047 int nready;
2048 Job *job;
2049 int i;
2051 (void)fflush(stdout);
2053 /* The first fd in the list is the job token pipe */
2054 nready = poll(fds + 1 - wantToken, nfds - 1 + wantToken, POLL_MSEC);
2056 if (nready < 0 || readyfd(&childExitJob)) {
2057 char token = 0;
2058 nready -= 1;
2059 (void)read(childExitJob.inPipe, &token, 1);
2060 if (token == DO_JOB_RESUME[0])
2061 /* Complete relay requested from our SIGCONT handler */
2062 JobRestartJobs();
2063 Job_CatchChildren();
2066 if (nready <= 0)
2067 return;
2069 if (wantToken && readyfd(&tokenWaitJob))
2070 nready--;
2072 for (i = 2; i < nfds; i++) {
2073 if (!fds[i].revents)
2074 continue;
2075 job = jobfds[i];
2076 if (job->job_state != JOB_ST_RUNNING)
2077 continue;
2078 JobDoOutput(job, FALSE);
2083 *-----------------------------------------------------------------------
2084 * Job_Make --
2085 * Start the creation of a target. Basically a front-end for
2086 * JobStart used by the Make module.
2088 * Results:
2089 * None.
2091 * Side Effects:
2092 * Another job is started.
2094 *-----------------------------------------------------------------------
2096 void
2097 Job_Make(GNode *gn)
2099 (void)JobStart(gn, 0);
2102 void
2103 Shell_Init(void)
2105 if (shellPath == NULL) {
2107 * We are using the default shell, which may be an absolute
2108 * path if DEFSHELL_CUSTOM is defined.
2110 shellName = commandShell->name;
2111 #ifdef DEFSHELL_CUSTOM
2112 if (*shellName == '/') {
2113 shellPath = shellName;
2114 shellName = strrchr(shellPath, '/');
2115 shellName++;
2116 } else
2117 #endif
2118 shellPath = str_concat(_PATH_DEFSHELLDIR, shellName, STR_ADDSLASH);
2120 if (commandShell->exit == NULL) {
2121 commandShell->exit = "";
2123 if (commandShell->echo == NULL) {
2124 commandShell->echo = "";
2129 * Returns the string literal that is used in the current command shell
2130 * to produce a newline character.
2132 const char *
2133 Shell_GetNewline(void)
2136 return commandShell->newline;
2139 void
2140 Job_SetPrefix(void)
2143 if (targPrefix) {
2144 free(targPrefix);
2145 } else if (!Var_Exists(MAKE_JOB_PREFIX, VAR_GLOBAL)) {
2146 Var_Set(MAKE_JOB_PREFIX, "---", VAR_GLOBAL, 0);
2149 targPrefix = Var_Subst(NULL, "${" MAKE_JOB_PREFIX "}", VAR_GLOBAL, 0);
2153 *-----------------------------------------------------------------------
2154 * Job_Init --
2155 * Initialize the process module
2157 * Input:
2159 * Results:
2160 * none
2162 * Side Effects:
2163 * lists and counters are initialized
2164 *-----------------------------------------------------------------------
2166 void
2167 Job_Init(void)
2169 GNode *begin; /* node for commands to do at the very start */
2171 /* Allocate space for all the job info */
2172 job_table = bmake_malloc(maxJobs * sizeof *job_table);
2173 memset(job_table, 0, maxJobs * sizeof *job_table);
2174 job_table_end = job_table + maxJobs;
2175 wantToken = 0;
2177 aborting = 0;
2178 errors = 0;
2180 lastNode = NULL;
2183 * There is a non-zero chance that we already have children.
2184 * eg after 'make -f- <<EOF'
2185 * Since their termination causes a 'Child (pid) not in table' message,
2186 * Collect the status of any that are already dead, and suppress the
2187 * error message if there are any undead ones.
2189 for (;;) {
2190 int rval, status;
2191 rval = waitpid((pid_t) -1, &status, WNOHANG);
2192 if (rval > 0)
2193 continue;
2194 if (rval == 0)
2195 lurking_children = 1;
2196 break;
2199 Shell_Init();
2201 JobCreatePipe(&childExitJob, 3);
2203 /* We can only need to wait for tokens, children and output from each job */
2204 fds = bmake_malloc(sizeof (*fds) * (2 + maxJobs));
2205 jobfds = bmake_malloc(sizeof (*jobfds) * (2 + maxJobs));
2207 /* These are permanent entries and take slots 0 and 1 */
2208 watchfd(&tokenWaitJob);
2209 watchfd(&childExitJob);
2211 sigemptyset(&caught_signals);
2213 * Install a SIGCHLD handler.
2215 (void)bmake_signal(SIGCHLD, JobChildSig);
2216 sigaddset(&caught_signals, SIGCHLD);
2218 #define ADDSIG(s,h) \
2219 if (bmake_signal(s, SIG_IGN) != SIG_IGN) { \
2220 sigaddset(&caught_signals, s); \
2221 (void)bmake_signal(s, h); \
2225 * Catch the four signals that POSIX specifies if they aren't ignored.
2226 * JobPassSig will take care of calling JobInterrupt if appropriate.
2228 ADDSIG(SIGINT, JobPassSig_int)
2229 ADDSIG(SIGHUP, JobPassSig_term)
2230 ADDSIG(SIGTERM, JobPassSig_term)
2231 ADDSIG(SIGQUIT, JobPassSig_term)
2234 * There are additional signals that need to be caught and passed if
2235 * either the export system wants to be told directly of signals or if
2236 * we're giving each job its own process group (since then it won't get
2237 * signals from the terminal driver as we own the terminal)
2239 ADDSIG(SIGTSTP, JobPassSig_suspend)
2240 ADDSIG(SIGTTOU, JobPassSig_suspend)
2241 ADDSIG(SIGTTIN, JobPassSig_suspend)
2242 ADDSIG(SIGWINCH, JobCondPassSig)
2243 ADDSIG(SIGCONT, JobContinueSig)
2244 #undef ADDSIG
2246 begin = Targ_FindNode(".BEGIN", TARG_NOCREATE);
2248 if (begin != NULL) {
2249 JobRun(begin);
2250 if (begin->made == ERROR) {
2251 PrintOnError(begin, "\n\nStop.");
2252 exit(1);
2255 postCommands = Targ_FindNode(".END", TARG_CREATE);
2258 static void JobSigReset(void)
2260 #define DELSIG(s) \
2261 if (sigismember(&caught_signals, s)) { \
2262 (void)bmake_signal(s, SIG_DFL); \
2265 DELSIG(SIGINT)
2266 DELSIG(SIGHUP)
2267 DELSIG(SIGQUIT)
2268 DELSIG(SIGTERM)
2269 DELSIG(SIGTSTP)
2270 DELSIG(SIGTTOU)
2271 DELSIG(SIGTTIN)
2272 DELSIG(SIGWINCH)
2273 DELSIG(SIGCONT)
2274 #undef DELSIG
2275 (void)bmake_signal(SIGCHLD, SIG_DFL);
2279 *-----------------------------------------------------------------------
2280 * JobMatchShell --
2281 * Find a shell in 'shells' given its name.
2283 * Results:
2284 * A pointer to the Shell structure.
2286 * Side Effects:
2287 * None.
2289 *-----------------------------------------------------------------------
2291 static Shell *
2292 JobMatchShell(const char *name)
2294 Shell *sh;
2296 for (sh = shells; sh->name != NULL; sh++) {
2297 if (strcmp(name, sh->name) == 0)
2298 return (sh);
2300 return NULL;
2304 *-----------------------------------------------------------------------
2305 * Job_ParseShell --
2306 * Parse a shell specification and set up commandShell, shellPath
2307 * and shellName appropriately.
2309 * Input:
2310 * line The shell spec
2312 * Results:
2313 * FAILURE if the specification was incorrect.
2315 * Side Effects:
2316 * commandShell points to a Shell structure (either predefined or
2317 * created from the shell spec), shellPath is the full path of the
2318 * shell described by commandShell, while shellName is just the
2319 * final component of shellPath.
2321 * Notes:
2322 * A shell specification consists of a .SHELL target, with dependency
2323 * operator, followed by a series of blank-separated words. Double
2324 * quotes can be used to use blanks in words. A backslash escapes
2325 * anything (most notably a double-quote and a space) and
2326 * provides the functionality it does in C. Each word consists of
2327 * keyword and value separated by an equal sign. There should be no
2328 * unnecessary spaces in the word. The keywords are as follows:
2329 * name Name of shell.
2330 * path Location of shell.
2331 * quiet Command to turn off echoing.
2332 * echo Command to turn echoing on
2333 * filter Result of turning off echoing that shouldn't be
2334 * printed.
2335 * echoFlag Flag to turn echoing on at the start
2336 * errFlag Flag to turn error checking on at the start
2337 * hasErrCtl True if shell has error checking control
2338 * newline String literal to represent a newline char
2339 * check Command to turn on error checking if hasErrCtl
2340 * is TRUE or template of command to echo a command
2341 * for which error checking is off if hasErrCtl is
2342 * FALSE.
2343 * ignore Command to turn off error checking if hasErrCtl
2344 * is TRUE or template of command to execute a
2345 * command so as to ignore any errors it returns if
2346 * hasErrCtl is FALSE.
2348 *-----------------------------------------------------------------------
2350 ReturnStatus
2351 Job_ParseShell(char *line)
2353 char **words;
2354 char **argv;
2355 int argc;
2356 char *path;
2357 Shell newShell;
2358 Boolean fullSpec = FALSE;
2359 Shell *sh;
2361 while (isspace((unsigned char)*line)) {
2362 line++;
2365 if (shellArgv)
2366 free(UNCONST(shellArgv));
2368 memset(&newShell, 0, sizeof(newShell));
2371 * Parse the specification by keyword
2373 words = brk_string(line, &argc, TRUE, &path);
2374 if (words == NULL) {
2375 Error("Unterminated quoted string [%s]", line);
2376 return FAILURE;
2378 shellArgv = path;
2380 for (path = NULL, argv = words; argc != 0; argc--, argv++) {
2381 if (strncmp(*argv, "path=", 5) == 0) {
2382 path = &argv[0][5];
2383 } else if (strncmp(*argv, "name=", 5) == 0) {
2384 newShell.name = &argv[0][5];
2385 } else {
2386 if (strncmp(*argv, "quiet=", 6) == 0) {
2387 newShell.echoOff = &argv[0][6];
2388 } else if (strncmp(*argv, "echo=", 5) == 0) {
2389 newShell.echoOn = &argv[0][5];
2390 } else if (strncmp(*argv, "filter=", 7) == 0) {
2391 newShell.noPrint = &argv[0][7];
2392 newShell.noPLen = strlen(newShell.noPrint);
2393 } else if (strncmp(*argv, "echoFlag=", 9) == 0) {
2394 newShell.echo = &argv[0][9];
2395 } else if (strncmp(*argv, "errFlag=", 8) == 0) {
2396 newShell.exit = &argv[0][8];
2397 } else if (strncmp(*argv, "hasErrCtl=", 10) == 0) {
2398 char c = argv[0][10];
2399 newShell.hasErrCtl = !((c != 'Y') && (c != 'y') &&
2400 (c != 'T') && (c != 't'));
2401 } else if (strncmp(*argv, "newline=", 8) == 0) {
2402 newShell.newline = &argv[0][8];
2403 } else if (strncmp(*argv, "check=", 6) == 0) {
2404 newShell.errCheck = &argv[0][6];
2405 } else if (strncmp(*argv, "ignore=", 7) == 0) {
2406 newShell.ignErr = &argv[0][7];
2407 } else if (strncmp(*argv, "errout=", 7) == 0) {
2408 newShell.errOut = &argv[0][7];
2409 } else if (strncmp(*argv, "comment=", 8) == 0) {
2410 newShell.commentChar = argv[0][8];
2411 } else {
2412 Parse_Error(PARSE_FATAL, "Unknown keyword \"%s\"",
2413 *argv);
2414 free(words);
2415 return(FAILURE);
2417 fullSpec = TRUE;
2421 if (path == NULL) {
2423 * If no path was given, the user wants one of the pre-defined shells,
2424 * yes? So we find the one s/he wants with the help of JobMatchShell
2425 * and set things up the right way. shellPath will be set up by
2426 * Job_Init.
2428 if (newShell.name == NULL) {
2429 Parse_Error(PARSE_FATAL, "Neither path nor name specified");
2430 free(words);
2431 return(FAILURE);
2432 } else {
2433 if ((sh = JobMatchShell(newShell.name)) == NULL) {
2434 Parse_Error(PARSE_WARNING, "%s: No matching shell",
2435 newShell.name);
2436 free(words);
2437 return(FAILURE);
2439 commandShell = sh;
2440 shellName = newShell.name;
2442 } else {
2444 * The user provided a path. If s/he gave nothing else (fullSpec is
2445 * FALSE), try and find a matching shell in the ones we know of.
2446 * Else we just take the specification at its word and copy it
2447 * to a new location. In either case, we need to record the
2448 * path the user gave for the shell.
2450 shellPath = path;
2451 path = strrchr(path, '/');
2452 if (path == NULL) {
2453 path = UNCONST(shellPath);
2454 } else {
2455 path += 1;
2457 if (newShell.name != NULL) {
2458 shellName = newShell.name;
2459 } else {
2460 shellName = path;
2462 if (!fullSpec) {
2463 if ((sh = JobMatchShell(shellName)) == NULL) {
2464 Parse_Error(PARSE_WARNING, "%s: No matching shell",
2465 shellName);
2466 free(words);
2467 return(FAILURE);
2469 commandShell = sh;
2470 } else {
2471 commandShell = bmake_malloc(sizeof(Shell));
2472 *commandShell = newShell;
2476 if (commandShell->echoOn && commandShell->echoOff) {
2477 commandShell->hasEchoCtl = TRUE;
2480 if (!commandShell->hasErrCtl) {
2481 if (commandShell->errCheck == NULL) {
2482 commandShell->errCheck = "";
2484 if (commandShell->ignErr == NULL) {
2485 commandShell->ignErr = "%s\n";
2490 * Do not free up the words themselves, since they might be in use by the
2491 * shell specification.
2493 free(words);
2494 return SUCCESS;
2498 *-----------------------------------------------------------------------
2499 * JobInterrupt --
2500 * Handle the receipt of an interrupt.
2502 * Input:
2503 * runINTERRUPT Non-zero if commands for the .INTERRUPT target
2504 * should be executed
2505 * signo signal received
2507 * Results:
2508 * None
2510 * Side Effects:
2511 * All children are killed. Another job will be started if the
2512 * .INTERRUPT target was given.
2513 *-----------------------------------------------------------------------
2515 static void
2516 JobInterrupt(int runINTERRUPT, int signo)
2518 Job *job; /* job descriptor in that element */
2519 GNode *interrupt; /* the node describing the .INTERRUPT target */
2520 sigset_t mask;
2521 GNode *gn;
2523 aborting = ABORT_INTERRUPT;
2525 JobSigLock(&mask);
2527 for (job = job_table; job < job_table_end; job++) {
2528 if (job->job_state != JOB_ST_RUNNING)
2529 continue;
2531 gn = job->node;
2533 if ((gn->type & (OP_JOIN|OP_PHONY)) == 0 && !Targ_Precious(gn)) {
2534 char *file = (gn->path == NULL ? gn->name : gn->path);
2535 if (!noExecute && eunlink(file) != -1) {
2536 Error("*** %s removed", file);
2539 if (job->pid) {
2540 if (DEBUG(JOB)) {
2541 (void)fprintf(debug_file,
2542 "JobInterrupt passing signal %d to child %d.\n",
2543 signo, job->pid);
2545 KILLPG(job->pid, signo);
2549 JobSigUnlock(&mask);
2551 if (runINTERRUPT && !touchFlag) {
2552 interrupt = Targ_FindNode(".INTERRUPT", TARG_NOCREATE);
2553 if (interrupt != NULL) {
2554 ignoreErrors = FALSE;
2555 JobRun(interrupt);
2558 Trace_Log(MAKEINTR, 0);
2559 exit(signo);
2563 *-----------------------------------------------------------------------
2564 * Job_Finish --
2565 * Do final processing such as the running of the commands
2566 * attached to the .END target.
2568 * Results:
2569 * Number of errors reported.
2571 * Side Effects:
2572 * None.
2573 *-----------------------------------------------------------------------
2576 Job_Finish(void)
2578 if (postCommands != NULL &&
2579 (!Lst_IsEmpty(postCommands->commands) ||
2580 !Lst_IsEmpty(postCommands->children))) {
2581 if (errors) {
2582 Error("Errors reported so .END ignored");
2583 } else {
2584 JobRun(postCommands);
2587 return(errors);
2591 *-----------------------------------------------------------------------
2592 * Job_End --
2593 * Cleanup any memory used by the jobs module
2595 * Results:
2596 * None.
2598 * Side Effects:
2599 * Memory is freed
2600 *-----------------------------------------------------------------------
2602 void
2603 Job_End(void)
2605 #ifdef CLEANUP
2606 if (shellArgv)
2607 free(shellArgv);
2608 #endif
2612 *-----------------------------------------------------------------------
2613 * Job_Wait --
2614 * Waits for all running jobs to finish and returns. Sets 'aborting'
2615 * to ABORT_WAIT to prevent other jobs from starting.
2617 * Results:
2618 * None.
2620 * Side Effects:
2621 * Currently running jobs finish.
2623 *-----------------------------------------------------------------------
2625 void
2626 Job_Wait(void)
2628 aborting = ABORT_WAIT;
2629 while (jobTokensRunning != 0) {
2630 Job_CatchOutput();
2632 aborting = 0;
2636 *-----------------------------------------------------------------------
2637 * Job_AbortAll --
2638 * Abort all currently running jobs without handling output or anything.
2639 * This function is to be called only in the event of a major
2640 * error. Most definitely NOT to be called from JobInterrupt.
2642 * Results:
2643 * None
2645 * Side Effects:
2646 * All children are killed, not just the firstborn
2647 *-----------------------------------------------------------------------
2649 void
2650 Job_AbortAll(void)
2652 Job *job; /* the job descriptor in that element */
2653 int foo;
2655 aborting = ABORT_ERROR;
2657 if (jobTokensRunning) {
2658 for (job = job_table; job < job_table_end; job++) {
2659 if (job->job_state != JOB_ST_RUNNING)
2660 continue;
2662 * kill the child process with increasingly drastic signals to make
2663 * darn sure it's dead.
2665 KILLPG(job->pid, SIGINT);
2666 KILLPG(job->pid, SIGKILL);
2671 * Catch as many children as want to report in at first, then give up
2673 while (waitpid((pid_t) -1, &foo, WNOHANG) > 0)
2674 continue;
2679 *-----------------------------------------------------------------------
2680 * JobRestartJobs --
2681 * Tries to restart stopped jobs if there are slots available.
2682 * Called in process context in response to a SIGCONT.
2684 * Results:
2685 * None.
2687 * Side Effects:
2688 * Resumes jobs.
2690 *-----------------------------------------------------------------------
2692 static void
2693 JobRestartJobs(void)
2695 Job *job;
2697 for (job = job_table; job < job_table_end; job++) {
2698 if (job->job_state == JOB_ST_RUNNING &&
2699 (make_suspended || job->job_suspended)) {
2700 if (DEBUG(JOB)) {
2701 (void)fprintf(debug_file, "Restarting stopped job pid %d.\n",
2702 job->pid);
2704 if (job->job_suspended) {
2705 (void)printf("*** [%s] Continued\n", job->node->name);
2706 (void)fflush(stdout);
2708 job->job_suspended = 0;
2709 if (KILLPG(job->pid, SIGCONT) != 0 && DEBUG(JOB)) {
2710 fprintf(debug_file, "Failed to send SIGCONT to %d\n", job->pid);
2713 if (job->job_state == JOB_ST_FINISHED)
2714 /* Job exit deferred after calling waitpid() in a signal handler */
2715 JobFinish(job, job->exit_status);
2717 make_suspended = 0;
2720 static void
2721 watchfd(Job *job)
2723 if (job->inPollfd != NULL)
2724 Punt("Watching watched job");
2726 fds[nfds].fd = job->inPipe;
2727 fds[nfds].events = POLLIN;
2728 jobfds[nfds] = job;
2729 job->inPollfd = &fds[nfds];
2730 nfds++;
2733 static void
2734 clearfd(Job *job)
2736 int i;
2737 if (job->inPollfd == NULL)
2738 Punt("Unwatching unwatched job");
2739 i = job->inPollfd - fds;
2740 nfds--;
2742 * Move last job in table into hole made by dead job.
2744 if (nfds != i) {
2745 fds[i] = fds[nfds];
2746 jobfds[i] = jobfds[nfds];
2747 jobfds[i]->inPollfd = &fds[i];
2749 job->inPollfd = NULL;
2752 static int
2753 readyfd(Job *job)
2755 if (job->inPollfd == NULL)
2756 Punt("Polling unwatched job");
2757 return (job->inPollfd->revents & POLLIN) != 0;
2761 *-----------------------------------------------------------------------
2762 * JobTokenAdd --
2763 * Put a token into the job pipe so that some make process can start
2764 * another job.
2766 * Side Effects:
2767 * Allows more build jobs to be spawned somewhere.
2769 *-----------------------------------------------------------------------
2772 static void
2773 JobTokenAdd(void)
2775 char tok = JOB_TOKENS[aborting], tok1;
2777 /* If we are depositing an error token flush everything else */
2778 while (tok != '+' && read(tokenWaitJob.inPipe, &tok1, 1) == 1)
2779 continue;
2781 if (DEBUG(JOB))
2782 fprintf(debug_file, "(%d) aborting %d, deposit token %c\n",
2783 getpid(), aborting, JOB_TOKENS[aborting]);
2784 write(tokenWaitJob.outPipe, &tok, 1);
2788 *-----------------------------------------------------------------------
2789 * Job_ServerStartTokenAdd --
2790 * Prep the job token pipe in the root make process.
2792 *-----------------------------------------------------------------------
2795 void
2796 Job_ServerStart(int max_tokens, int jp_0, int jp_1)
2798 int i;
2799 char jobarg[64];
2801 if (jp_0 >= 0 && jp_1 >= 0) {
2802 /* Pipe passed in from parent */
2803 tokenWaitJob.inPipe = jp_0;
2804 tokenWaitJob.outPipe = jp_1;
2805 return;
2808 JobCreatePipe(&tokenWaitJob, 15);
2810 snprintf(jobarg, sizeof(jobarg), "%d,%d",
2811 tokenWaitJob.inPipe, tokenWaitJob.outPipe);
2813 Var_Append(MAKEFLAGS, "-J", VAR_GLOBAL);
2814 Var_Append(MAKEFLAGS, jobarg, VAR_GLOBAL);
2817 * Preload the job pipe with one token per job, save the one
2818 * "extra" token for the primary job.
2820 * XXX should clip maxJobs against PIPE_BUF -- if max_tokens is
2821 * larger than the write buffer size of the pipe, we will
2822 * deadlock here.
2824 for (i = 1; i < max_tokens; i++)
2825 JobTokenAdd();
2829 *-----------------------------------------------------------------------
2830 * Job_TokenReturn --
2831 * Return a withdrawn token to the pool.
2833 *-----------------------------------------------------------------------
2836 void
2837 Job_TokenReturn(void)
2839 jobTokensRunning--;
2840 if (jobTokensRunning < 0)
2841 Punt("token botch");
2842 if (jobTokensRunning || JOB_TOKENS[aborting] != '+')
2843 JobTokenAdd();
2847 *-----------------------------------------------------------------------
2848 * Job_TokenWithdraw --
2849 * Attempt to withdraw a token from the pool.
2851 * Results:
2852 * Returns TRUE if a token was withdrawn, and FALSE if the pool
2853 * is currently empty.
2855 * Side Effects:
2856 * If pool is empty, set wantToken so that we wake up
2857 * when a token is released.
2859 *-----------------------------------------------------------------------
2863 Boolean
2864 Job_TokenWithdraw(void)
2866 char tok, tok1;
2867 int count;
2869 wantToken = 0;
2870 if (DEBUG(JOB))
2871 fprintf(debug_file, "Job_TokenWithdraw(%d): aborting %d, running %d\n",
2872 getpid(), aborting, jobTokensRunning);
2874 if (aborting || (jobTokensRunning >= maxJobs))
2875 return FALSE;
2877 count = read(tokenWaitJob.inPipe, &tok, 1);
2878 if (count == 0)
2879 Fatal("eof on job pipe!");
2880 if (count < 0 && jobTokensRunning != 0) {
2881 if (errno != EAGAIN) {
2882 Fatal("job pipe read: %s", strerror(errno));
2884 if (DEBUG(JOB))
2885 fprintf(debug_file, "(%d) blocked for token\n", getpid());
2886 wantToken = 1;
2887 return FALSE;
2890 if (count == 1 && tok != '+') {
2891 /* make being abvorted - remove any other job tokens */
2892 if (DEBUG(JOB))
2893 fprintf(debug_file, "(%d) aborted by token %c\n", getpid(), tok);
2894 while (read(tokenWaitJob.inPipe, &tok1, 1) == 1)
2895 continue;
2896 /* And put the stopper back */
2897 write(tokenWaitJob.outPipe, &tok, 1);
2898 Fatal("A failure has been detected in another branch of the parallel make");
2901 if (count == 1 && jobTokensRunning == 0)
2902 /* We didn't want the token really */
2903 write(tokenWaitJob.outPipe, &tok, 1);
2905 jobTokensRunning++;
2906 if (DEBUG(JOB))
2907 fprintf(debug_file, "(%d) withdrew token\n", getpid());
2908 return TRUE;
2911 #ifdef USE_SELECT
2913 emul_poll(struct pollfd *fd, int nfd, int timeout)
2915 fd_set rfds, wfds;
2916 int i, maxfd, nselect, npoll;
2917 struct timeval tv, *tvp;
2918 long usecs;
2920 FD_ZERO(&rfds);
2921 FD_ZERO(&wfds);
2923 maxfd = -1;
2924 for (i = 0; i < nfd; i++) {
2925 fd[i].revents = 0;
2927 if (fd[i].events & POLLIN)
2928 FD_SET(fd[i].fd, &rfds);
2930 if (fd[i].events & POLLOUT)
2931 FD_SET(fd[i].fd, &wfds);
2933 if (fd[i].fd > maxfd)
2934 maxfd = fd[i].fd;
2937 if (maxfd >= FD_SETSIZE) {
2938 Punt("Ran out of fd_set slots; "
2939 "recompile with a larger FD_SETSIZE.");
2942 if (timeout < 0) {
2943 tvp = NULL;
2944 } else {
2945 usecs = timeout * 1000;
2946 tv.tv_sec = usecs / 1000000;
2947 tv.tv_usec = usecs % 1000000;
2948 tvp = &tv;
2951 nselect = select(maxfd + 1, &rfds, &wfds, 0, tvp);
2953 if (nselect <= 0)
2954 return nselect;
2956 npoll = 0;
2957 for (i = 0; i < nfd; i++) {
2958 if (FD_ISSET(fd[i].fd, &rfds))
2959 fd[i].revents |= POLLIN;
2961 if (FD_ISSET(fd[i].fd, &wfds))
2962 fd[i].revents |= POLLOUT;
2964 if (fd[i].revents)
2965 npoll++;
2968 return npoll;
2970 #endif /* USE_SELECT */