mandoc: update to 1.14.1
[unleashed.git] / bin / bmake / job.c
blob199d77df33e400da84bf36f2f04d4c33e3f37ef9
1 /* $NetBSD: job.c,v 1.188 2016/08/26 23:28:39 dholland 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.188 2016/08/26 23:28:39 dholland 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.188 2016/08/26 23:28:39 dholland 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 #if !defined(USE_SELECT) && defined(HAVE_POLL_H)
148 #include <poll.h>
149 #else
150 #ifndef USE_SELECT /* no poll.h */
151 # define USE_SELECT
152 #endif
153 #if defined(HAVE_SYS_SELECT_H)
154 # include <sys/select.h>
155 #endif
156 #endif
157 #include <signal.h>
158 #include <stdio.h>
159 #include <string.h>
160 #include <utime.h>
161 #if defined(HAVE_SYS_SOCKET_H)
162 # include <sys/socket.h>
163 #endif
165 #include "make.h"
166 #include "hash.h"
167 #include "dir.h"
168 #include "job.h"
169 #include "pathnames.h"
170 #include "trace.h"
171 # define STATIC static
174 * error handling variables
176 static int errors = 0; /* number of errors reported */
177 static int aborting = 0; /* why is the make aborting? */
178 #define ABORT_ERROR 1 /* Because of an error */
179 #define ABORT_INTERRUPT 2 /* Because it was interrupted */
180 #define ABORT_WAIT 3 /* Waiting for jobs to finish */
181 #define JOB_TOKENS "+EI+" /* Token to requeue for each abort state */
184 * this tracks the number of tokens currently "out" to build jobs.
186 int jobTokensRunning = 0;
187 int not_parallel = 0; /* set if .NOT_PARALLEL */
190 * XXX: Avoid SunOS bug... FILENO() is fp->_file, and file
191 * is a char! So when we go above 127 we turn negative!
193 #define FILENO(a) ((unsigned) fileno(a))
196 * post-make command processing. The node postCommands is really just the
197 * .END target but we keep it around to avoid having to search for it
198 * all the time.
200 static GNode *postCommands = NULL;
201 /* node containing commands to execute when
202 * everything else is done */
203 static int numCommands; /* The number of commands actually printed
204 * for a target. Should this number be
205 * 0, no shell will be executed. */
208 * Return values from JobStart.
210 #define JOB_RUNNING 0 /* Job is running */
211 #define JOB_ERROR 1 /* Error in starting the job */
212 #define JOB_FINISHED 2 /* The job is already finished */
215 * Descriptions for various shells.
217 * The build environment may set DEFSHELL_INDEX to one of
218 * DEFSHELL_INDEX_SH, DEFSHELL_INDEX_KSH, or DEFSHELL_INDEX_CSH, to
219 * select one of the prefedined shells as the default shell.
221 * Alternatively, the build environment may set DEFSHELL_CUSTOM to the
222 * name or the full path of a sh-compatible shell, which will be used as
223 * the default shell.
225 * ".SHELL" lines in Makefiles can choose the default shell from the
226 # set defined here, or add additional shells.
229 #ifdef DEFSHELL_CUSTOM
230 #define DEFSHELL_INDEX_CUSTOM 0
231 #define DEFSHELL_INDEX_SH 1
232 #define DEFSHELL_INDEX_KSH 2
233 #define DEFSHELL_INDEX_CSH 3
234 #else /* !DEFSHELL_CUSTOM */
235 #define DEFSHELL_INDEX_SH 0
236 #define DEFSHELL_INDEX_KSH 1
237 #define DEFSHELL_INDEX_CSH 2
238 #endif /* !DEFSHELL_CUSTOM */
240 #ifndef DEFSHELL_INDEX
241 #define DEFSHELL_INDEX 0 /* DEFSHELL_INDEX_CUSTOM or DEFSHELL_INDEX_SH */
242 #endif /* !DEFSHELL_INDEX */
244 static Shell shells[] = {
245 #ifdef DEFSHELL_CUSTOM
247 * An sh-compatible shell with a non-standard name.
249 * Keep this in sync with the "sh" description below, but avoid
250 * non-portable features that might not be supplied by all
251 * sh-compatible shells.
254 DEFSHELL_CUSTOM,
255 FALSE, "", "", "", 0,
256 FALSE, "echo \"%s\"\n", "%s\n", "{ %s \n} || exit $?\n", "'\n'", '#',
260 #endif /* DEFSHELL_CUSTOM */
262 * SH description. Echo control is also possible and, under
263 * sun UNIX anyway, one can even control error checking.
266 "sh",
267 FALSE, "", "", "", 0,
268 FALSE, "echo \"%s\"\n", "%s\n", "{ %s \n} || exit $?\n", "'\n'", '#',
269 #if defined(MAKE_NATIVE) && defined(__NetBSD__)
270 "q",
271 #else
273 #endif
277 * KSH description.
280 "ksh",
281 TRUE, "set +v", "set -v", "set +v", 6,
282 FALSE, "echo \"%s\"\n", "%s\n", "{ %s \n} || exit $?\n", "'\n'", '#',
283 "v",
287 * CSH description. The csh can do echo control by playing
288 * with the setting of the 'echo' shell variable. Sadly,
289 * however, it is unable to do error control nicely.
292 "csh",
293 TRUE, "unset verbose", "set verbose", "unset verbose", 10,
294 FALSE, "echo \"%s\"\n", "csh -c \"%s || exit 0\"\n", "", "'\\\n'", '#',
295 "v", "e",
298 * UNKNOWN.
301 NULL,
302 FALSE, NULL, NULL, NULL, 0,
303 FALSE, NULL, NULL, NULL, NULL, 0,
304 NULL, NULL,
307 static Shell *commandShell = &shells[DEFSHELL_INDEX]; /* this is the shell to
308 * which we pass all
309 * commands in the Makefile.
310 * It is set by the
311 * Job_ParseShell function */
312 const char *shellPath = NULL, /* full pathname of
313 * executable image */
314 *shellName = NULL; /* last component of shell */
315 char *shellErrFlag = NULL;
316 static const char *shellArgv = NULL; /* Custom shell args */
319 STATIC Job *job_table; /* The structures that describe them */
320 STATIC Job *job_table_end; /* job_table + maxJobs */
321 static int wantToken; /* we want a token */
322 static int lurking_children = 0;
323 static int make_suspended = 0; /* non-zero if we've seen a SIGTSTP (etc) */
326 * Set of descriptors of pipes connected to
327 * the output channels of children
329 static struct pollfd *fds = NULL;
330 static Job **jobfds = NULL;
331 static int nfds = 0;
332 static void watchfd(Job *);
333 static void clearfd(Job *);
334 static int readyfd(Job *);
336 STATIC GNode *lastNode; /* The node for which output was most recently
337 * produced. */
338 static char *targPrefix = NULL; /* What we print at the start of TARG_FMT */
339 static Job tokenWaitJob; /* token wait pseudo-job */
341 static Job childExitJob; /* child exit pseudo-job */
342 #define CHILD_EXIT "."
343 #define DO_JOB_RESUME "R"
345 #define TARG_FMT "%s %s ---\n" /* Default format */
346 #define MESSAGE(fp, gn) \
347 if (maxJobs != 1 && targPrefix && *targPrefix) \
348 (void)fprintf(fp, TARG_FMT, targPrefix, gn->name)
350 static sigset_t caught_signals; /* Set of signals we handle */
351 #if defined(SYSV)
352 #define KILLPG(pid, sig) kill(-(pid), (sig))
353 #else
354 #define KILLPG(pid, sig) killpg((pid), (sig))
355 #endif
357 static void JobChildSig(int);
358 static void JobContinueSig(int);
359 static Job *JobFindPid(int, int, Boolean);
360 static int JobPrintCommand(void *, void *);
361 static int JobSaveCommand(void *, void *);
362 static void JobClose(Job *);
363 static void JobExec(Job *, char **);
364 static void JobMakeArgv(Job *, char **);
365 static int JobStart(GNode *, int);
366 static char *JobOutput(Job *, char *, char *, int);
367 static void JobDoOutput(Job *, Boolean);
368 static Shell *JobMatchShell(const char *);
369 static void JobInterrupt(int, int) MAKE_ATTR_DEAD;
370 static void JobRestartJobs(void);
371 static void JobTokenAdd(void);
372 static void JobSigLock(sigset_t *);
373 static void JobSigUnlock(sigset_t *);
374 static void JobSigReset(void);
376 const char *malloc_options="A";
378 static void
379 job_table_dump(const char *where)
381 Job *job;
383 fprintf(debug_file, "job table @ %s\n", where);
384 for (job = job_table; job < job_table_end; job++) {
385 fprintf(debug_file, "job %d, status %d, flags %d, pid %d\n",
386 (int)(job - job_table), job->job_state, job->flags, job->pid);
391 * Delete the target of a failed, interrupted, or otherwise
392 * unsuccessful job unless inhibited by .PRECIOUS.
394 static void
395 JobDeleteTarget(GNode *gn)
397 if ((gn->type & (OP_JOIN|OP_PHONY)) == 0 && !Targ_Precious(gn)) {
398 char *file = (gn->path == NULL ? gn->name : gn->path);
399 if (!noExecute && eunlink(file) != -1) {
400 Error("*** %s removed", file);
406 * JobSigLock/JobSigUnlock
408 * Signal lock routines to get exclusive access. Currently used to
409 * protect `jobs' and `stoppedJobs' list manipulations.
411 static void JobSigLock(sigset_t *omaskp)
413 if (sigprocmask(SIG_BLOCK, &caught_signals, omaskp) != 0) {
414 Punt("JobSigLock: sigprocmask: %s", strerror(errno));
415 sigemptyset(omaskp);
419 static void JobSigUnlock(sigset_t *omaskp)
421 (void)sigprocmask(SIG_SETMASK, omaskp, NULL);
424 static void
425 JobCreatePipe(Job *job, int minfd)
427 int i, fd;
429 if (pipe(job->jobPipe) == -1)
430 Punt("Cannot create pipe: %s", strerror(errno));
432 for (i = 0; i < 2; i++) {
433 /* Avoid using low numbered fds */
434 fd = fcntl(job->jobPipe[i], F_DUPFD, minfd);
435 if (fd != -1) {
436 close(job->jobPipe[i]);
437 job->jobPipe[i] = fd;
441 /* Set close-on-exec flag for both */
442 (void)fcntl(job->jobPipe[0], F_SETFD, FD_CLOEXEC);
443 (void)fcntl(job->jobPipe[1], F_SETFD, FD_CLOEXEC);
446 * We mark the input side of the pipe non-blocking; we poll(2) the
447 * pipe when we're waiting for a job token, but we might lose the
448 * race for the token when a new one becomes available, so the read
449 * from the pipe should not block.
451 fcntl(job->jobPipe[0], F_SETFL,
452 fcntl(job->jobPipe[0], F_GETFL, 0) | O_NONBLOCK);
456 *-----------------------------------------------------------------------
457 * JobCondPassSig --
458 * Pass a signal to a job
460 * Input:
461 * signop Signal to send it
463 * Side Effects:
464 * None, except the job may bite it.
466 *-----------------------------------------------------------------------
468 static void
469 JobCondPassSig(int signo)
471 Job *job;
473 if (DEBUG(JOB)) {
474 (void)fprintf(debug_file, "JobCondPassSig(%d) called.\n", signo);
477 for (job = job_table; job < job_table_end; job++) {
478 if (job->job_state != JOB_ST_RUNNING)
479 continue;
480 if (DEBUG(JOB)) {
481 (void)fprintf(debug_file,
482 "JobCondPassSig passing signal %d to child %d.\n",
483 signo, job->pid);
485 KILLPG(job->pid, signo);
490 *-----------------------------------------------------------------------
491 * JobChldSig --
492 * SIGCHLD handler.
494 * Input:
495 * signo The signal number we've received
497 * Results:
498 * None.
500 * Side Effects:
501 * Sends a token on the child exit pipe to wake us up from
502 * select()/poll().
504 *-----------------------------------------------------------------------
506 static void
507 JobChildSig(int signo MAKE_ATTR_UNUSED)
509 while (write(childExitJob.outPipe, CHILD_EXIT, 1) == -1 && errno == EAGAIN)
510 continue;
515 *-----------------------------------------------------------------------
516 * JobContinueSig --
517 * Resume all stopped jobs.
519 * Input:
520 * signo The signal number we've received
522 * Results:
523 * None.
525 * Side Effects:
526 * Jobs start running again.
528 *-----------------------------------------------------------------------
530 static void
531 JobContinueSig(int signo MAKE_ATTR_UNUSED)
534 * Defer sending to SIGCONT to our stopped children until we return
535 * from the signal handler.
537 while (write(childExitJob.outPipe, DO_JOB_RESUME, 1) == -1 &&
538 errno == EAGAIN)
539 continue;
543 *-----------------------------------------------------------------------
544 * JobPassSig --
545 * Pass a signal on to all jobs, then resend to ourselves.
547 * Input:
548 * signo The signal number we've received
550 * Results:
551 * None.
553 * Side Effects:
554 * We die by the same signal.
556 *-----------------------------------------------------------------------
558 MAKE_ATTR_DEAD static void
559 JobPassSig_int(int signo)
561 /* Run .INTERRUPT target then exit */
562 JobInterrupt(TRUE, signo);
565 MAKE_ATTR_DEAD static void
566 JobPassSig_term(int signo)
568 /* Dont run .INTERRUPT target then exit */
569 JobInterrupt(FALSE, signo);
572 static void
573 JobPassSig_suspend(int signo)
575 sigset_t nmask, omask;
576 struct sigaction act;
578 /* Suppress job started/continued messages */
579 make_suspended = 1;
581 /* Pass the signal onto every job */
582 JobCondPassSig(signo);
585 * Send ourselves the signal now we've given the message to everyone else.
586 * Note we block everything else possible while we're getting the signal.
587 * This ensures that all our jobs get continued when we wake up before
588 * we take any other signal.
590 sigfillset(&nmask);
591 sigdelset(&nmask, signo);
592 (void)sigprocmask(SIG_SETMASK, &nmask, &omask);
594 act.sa_handler = SIG_DFL;
595 sigemptyset(&act.sa_mask);
596 act.sa_flags = 0;
597 (void)sigaction(signo, &act, NULL);
599 if (DEBUG(JOB)) {
600 (void)fprintf(debug_file,
601 "JobPassSig passing signal %d to self.\n", signo);
604 (void)kill(getpid(), signo);
607 * We've been continued.
609 * A whole host of signals continue to happen!
610 * SIGCHLD for any processes that actually suspended themselves.
611 * SIGCHLD for any processes that exited while we were alseep.
612 * The SIGCONT that actually caused us to wakeup.
614 * Since we defer passing the SIGCONT on to our children until
615 * the main processing loop, we can be sure that all the SIGCHLD
616 * events will have happened by then - and that the waitpid() will
617 * collect the child 'suspended' events.
618 * For correct sequencing we just need to ensure we process the
619 * waitpid() before passign on the SIGCONT.
621 * In any case nothing else is needed here.
624 /* Restore handler and signal mask */
625 act.sa_handler = JobPassSig_suspend;
626 (void)sigaction(signo, &act, NULL);
627 (void)sigprocmask(SIG_SETMASK, &omask, NULL);
631 *-----------------------------------------------------------------------
632 * JobFindPid --
633 * Compare the pid of the job with the given pid and return 0 if they
634 * are equal. This function is called from Job_CatchChildren
635 * to find the job descriptor of the finished job.
637 * Input:
638 * job job to examine
639 * pid process id desired
641 * Results:
642 * Job with matching pid
644 * Side Effects:
645 * None
646 *-----------------------------------------------------------------------
648 static Job *
649 JobFindPid(int pid, int status, Boolean isJobs)
651 Job *job;
653 for (job = job_table; job < job_table_end; job++) {
654 if ((job->job_state == status) && job->pid == pid)
655 return job;
657 if (DEBUG(JOB) && isJobs)
658 job_table_dump("no pid");
659 return NULL;
663 *-----------------------------------------------------------------------
664 * JobPrintCommand --
665 * Put out another command for the given job. If the command starts
666 * with an @ or a - we process it specially. In the former case,
667 * so long as the -s and -n flags weren't given to make, we stick
668 * a shell-specific echoOff command in the script. In the latter,
669 * we ignore errors for the entire job, unless the shell has error
670 * control.
671 * If the command is just "..." we take all future commands for this
672 * job to be commands to be executed once the entire graph has been
673 * made and return non-zero to signal that the end of the commands
674 * was reached. These commands are later attached to the postCommands
675 * node and executed by Job_End when all things are done.
676 * This function is called from JobStart via Lst_ForEach.
678 * Input:
679 * cmdp command string to print
680 * jobp job for which to print it
682 * Results:
683 * Always 0, unless the command was "..."
685 * Side Effects:
686 * If the command begins with a '-' and the shell has no error control,
687 * the JOB_IGNERR flag is set in the job descriptor.
688 * If the command is "..." and we're not ignoring such things,
689 * tailCmds is set to the successor node of the cmd.
690 * numCommands is incremented if the command is actually printed.
691 *-----------------------------------------------------------------------
693 static int
694 JobPrintCommand(void *cmdp, void *jobp)
696 Boolean noSpecials; /* true if we shouldn't worry about
697 * inserting special commands into
698 * the input stream. */
699 Boolean shutUp = FALSE; /* true if we put a no echo command
700 * into the command file */
701 Boolean errOff = FALSE; /* true if we turned error checking
702 * off before printing the command
703 * and need to turn it back on */
704 const char *cmdTemplate; /* Template to use when printing the
705 * command */
706 char *cmdStart; /* Start of expanded command */
707 char *escCmd = NULL; /* Command with quotes/backticks escaped */
708 char *cmd = (char *)cmdp;
709 Job *job = (Job *)jobp;
710 int i, j;
712 noSpecials = NoExecute(job->node);
714 if (strcmp(cmd, "...") == 0) {
715 job->node->type |= OP_SAVE_CMDS;
716 if ((job->flags & JOB_IGNDOTS) == 0) {
717 job->tailCmds = Lst_Succ(Lst_Member(job->node->commands,
718 cmd));
719 return 1;
721 return 0;
724 #define DBPRINTF(fmt, arg) if (DEBUG(JOB)) { \
725 (void)fprintf(debug_file, fmt, arg); \
727 (void)fprintf(job->cmdFILE, fmt, arg); \
728 (void)fflush(job->cmdFILE);
730 numCommands += 1;
732 cmdStart = cmd = Var_Subst(NULL, cmd, job->node, VARF_WANTRES);
734 cmdTemplate = "%s\n";
737 * Check for leading @' and -'s to control echoing and error checking.
739 while (*cmd == '@' || *cmd == '-' || (*cmd == '+')) {
740 switch (*cmd) {
741 case '@':
742 shutUp = DEBUG(LOUD) ? FALSE : TRUE;
743 break;
744 case '-':
745 errOff = TRUE;
746 break;
747 case '+':
748 if (noSpecials) {
750 * We're not actually executing anything...
751 * but this one needs to be - use compat mode just for it.
753 CompatRunCommand(cmdp, job->node);
754 return 0;
756 break;
758 cmd++;
761 while (isspace((unsigned char) *cmd))
762 cmd++;
765 * If the shell doesn't have error control the alternate echo'ing will
766 * be done (to avoid showing additional error checking code)
767 * and this will need the characters '$ ` \ "' escaped
770 if (!commandShell->hasErrCtl) {
771 /* Worst that could happen is every char needs escaping. */
772 escCmd = bmake_malloc((strlen(cmd) * 2) + 1);
773 for (i = 0, j= 0; cmd[i] != '\0'; i++, j++) {
774 if (cmd[i] == '$' || cmd[i] == '`' || cmd[i] == '\\' ||
775 cmd[i] == '"')
776 escCmd[j++] = '\\';
777 escCmd[j] = cmd[i];
779 escCmd[j] = 0;
782 if (shutUp) {
783 if (!(job->flags & JOB_SILENT) && !noSpecials &&
784 commandShell->hasEchoCtl) {
785 DBPRINTF("%s\n", commandShell->echoOff);
786 } else {
787 if (commandShell->hasErrCtl)
788 shutUp = FALSE;
792 if (errOff) {
793 if (!noSpecials) {
794 if (commandShell->hasErrCtl) {
796 * we don't want the error-control commands showing
797 * up either, so we turn off echoing while executing
798 * them. We could put another field in the shell
799 * structure to tell JobDoOutput to look for this
800 * string too, but why make it any more complex than
801 * it already is?
803 if (!(job->flags & JOB_SILENT) && !shutUp &&
804 commandShell->hasEchoCtl) {
805 DBPRINTF("%s\n", commandShell->echoOff);
806 DBPRINTF("%s\n", commandShell->ignErr);
807 DBPRINTF("%s\n", commandShell->echoOn);
808 } else {
809 DBPRINTF("%s\n", commandShell->ignErr);
811 } else if (commandShell->ignErr &&
812 (*commandShell->ignErr != '\0'))
815 * The shell has no error control, so we need to be
816 * weird to get it to ignore any errors from the command.
817 * If echoing is turned on, we turn it off and use the
818 * errCheck template to echo the command. Leave echoing
819 * off so the user doesn't see the weirdness we go through
820 * to ignore errors. Set cmdTemplate to use the weirdness
821 * instead of the simple "%s\n" template.
823 job->flags |= JOB_IGNERR;
824 if (!(job->flags & JOB_SILENT) && !shutUp) {
825 if (commandShell->hasEchoCtl) {
826 DBPRINTF("%s\n", commandShell->echoOff);
828 DBPRINTF(commandShell->errCheck, escCmd);
829 shutUp = TRUE;
830 } else {
831 if (!shutUp) {
832 DBPRINTF(commandShell->errCheck, escCmd);
835 cmdTemplate = commandShell->ignErr;
837 * The error ignoration (hee hee) is already taken care
838 * of by the ignErr template, so pretend error checking
839 * is still on.
841 errOff = FALSE;
842 } else {
843 errOff = FALSE;
845 } else {
846 errOff = FALSE;
848 } else {
851 * If errors are being checked and the shell doesn't have error control
852 * but does supply an errOut template, then setup commands to run
853 * through it.
856 if (!commandShell->hasErrCtl && commandShell->errOut &&
857 (*commandShell->errOut != '\0')) {
858 if (!(job->flags & JOB_SILENT) && !shutUp) {
859 if (commandShell->hasEchoCtl) {
860 DBPRINTF("%s\n", commandShell->echoOff);
862 DBPRINTF(commandShell->errCheck, escCmd);
863 shutUp = TRUE;
865 /* If it's a comment line or blank, treat as an ignored error */
866 if ((escCmd[0] == commandShell->commentChar) ||
867 (escCmd[0] == 0))
868 cmdTemplate = commandShell->ignErr;
869 else
870 cmdTemplate = commandShell->errOut;
871 errOff = FALSE;
875 if (DEBUG(SHELL) && strcmp(shellName, "sh") == 0 &&
876 (job->flags & JOB_TRACED) == 0) {
877 DBPRINTF("set -%s\n", "x");
878 job->flags |= JOB_TRACED;
881 DBPRINTF(cmdTemplate, cmd);
882 free(cmdStart);
883 free(escCmd);
884 if (errOff) {
886 * If echoing is already off, there's no point in issuing the
887 * echoOff command. Otherwise we issue it and pretend it was on
888 * for the whole command...
890 if (!shutUp && !(job->flags & JOB_SILENT) && commandShell->hasEchoCtl){
891 DBPRINTF("%s\n", commandShell->echoOff);
892 shutUp = TRUE;
894 DBPRINTF("%s\n", commandShell->errCheck);
896 if (shutUp && commandShell->hasEchoCtl) {
897 DBPRINTF("%s\n", commandShell->echoOn);
899 return 0;
903 *-----------------------------------------------------------------------
904 * JobSaveCommand --
905 * Save a command to be executed when everything else is done.
906 * Callback function for JobFinish...
908 * Results:
909 * Always returns 0
911 * Side Effects:
912 * The command is tacked onto the end of postCommands's commands list.
914 *-----------------------------------------------------------------------
916 static int
917 JobSaveCommand(void *cmd, void *gn)
919 cmd = Var_Subst(NULL, (char *)cmd, (GNode *)gn, VARF_WANTRES);
920 (void)Lst_AtEnd(postCommands->commands, cmd);
921 return(0);
926 *-----------------------------------------------------------------------
927 * JobClose --
928 * Called to close both input and output pipes when a job is finished.
930 * Results:
931 * Nada
933 * Side Effects:
934 * The file descriptors associated with the job are closed.
936 *-----------------------------------------------------------------------
938 static void
939 JobClose(Job *job)
941 clearfd(job);
942 (void)close(job->outPipe);
943 job->outPipe = -1;
945 JobDoOutput(job, TRUE);
946 (void)close(job->inPipe);
947 job->inPipe = -1;
951 *-----------------------------------------------------------------------
952 * JobFinish --
953 * Do final processing for the given job including updating
954 * parents and starting new jobs as available/necessary. Note
955 * that we pay no attention to the JOB_IGNERR flag here.
956 * This is because when we're called because of a noexecute flag
957 * or something, jstat.w_status is 0 and when called from
958 * Job_CatchChildren, the status is zeroed if it s/b ignored.
960 * Input:
961 * job job to finish
962 * status sub-why job went away
964 * Results:
965 * None
967 * Side Effects:
968 * Final commands for the job are placed on postCommands.
970 * If we got an error and are aborting (aborting == ABORT_ERROR) and
971 * the job list is now empty, we are done for the day.
972 * If we recognized an error (errors !=0), we set the aborting flag
973 * to ABORT_ERROR so no more jobs will be started.
974 *-----------------------------------------------------------------------
976 /*ARGSUSED*/
977 static void
978 JobFinish (Job *job, WAIT_T status)
980 Boolean done, return_job_token;
982 if (DEBUG(JOB)) {
983 fprintf(debug_file, "Jobfinish: %d [%s], status %d\n",
984 job->pid, job->node->name, status);
987 if ((WIFEXITED(status) &&
988 (((WEXITSTATUS(status) != 0) && !(job->flags & JOB_IGNERR)))) ||
989 WIFSIGNALED(status))
992 * If it exited non-zero and either we're doing things our
993 * way or we're not ignoring errors, the job is finished.
994 * Similarly, if the shell died because of a signal
995 * the job is also finished. In these
996 * cases, finish out the job's output before printing the exit
997 * status...
999 JobClose(job);
1000 if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
1001 (void)fclose(job->cmdFILE);
1002 job->cmdFILE = NULL;
1004 done = TRUE;
1005 } else if (WIFEXITED(status)) {
1007 * Deal with ignored errors in -B mode. We need to print a message
1008 * telling of the ignored error as well as setting status.w_status
1009 * to 0 so the next command gets run. To do this, we set done to be
1010 * TRUE if in -B mode and the job exited non-zero.
1012 done = WEXITSTATUS(status) != 0;
1014 * Old comment said: "Note we don't
1015 * want to close down any of the streams until we know we're at the
1016 * end."
1017 * But we do. Otherwise when are we going to print the rest of the
1018 * stuff?
1020 JobClose(job);
1021 } else {
1023 * No need to close things down or anything.
1025 done = FALSE;
1028 if (done) {
1029 if (WIFEXITED(status)) {
1030 if (DEBUG(JOB)) {
1031 (void)fprintf(debug_file, "Process %d [%s] exited.\n",
1032 job->pid, job->node->name);
1034 if (WEXITSTATUS(status) != 0) {
1035 if (job->node != lastNode) {
1036 MESSAGE(stdout, job->node);
1037 lastNode = job->node;
1039 #ifdef USE_META
1040 if (useMeta) {
1041 meta_job_error(job, job->node, job->flags, WEXITSTATUS(status));
1043 #endif
1044 (void)printf("*** [%s] Error code %d%s\n",
1045 job->node->name,
1046 WEXITSTATUS(status),
1047 (job->flags & JOB_IGNERR) ? " (ignored)" : "");
1048 if (job->flags & JOB_IGNERR) {
1049 WAIT_STATUS(status) = 0;
1050 } else {
1051 if (deleteOnError) {
1052 JobDeleteTarget(job->node);
1054 PrintOnError(job->node, NULL);
1056 } else if (DEBUG(JOB)) {
1057 if (job->node != lastNode) {
1058 MESSAGE(stdout, job->node);
1059 lastNode = job->node;
1061 (void)printf("*** [%s] Completed successfully\n",
1062 job->node->name);
1064 } else {
1065 if (job->node != lastNode) {
1066 MESSAGE(stdout, job->node);
1067 lastNode = job->node;
1069 (void)printf("*** [%s] Signal %d\n",
1070 job->node->name, WTERMSIG(status));
1071 if (deleteOnError) {
1072 JobDeleteTarget(job->node);
1075 (void)fflush(stdout);
1078 #ifdef USE_META
1079 if (useMeta) {
1080 int x;
1082 if ((x = meta_job_finish(job)) != 0 && status == 0) {
1083 status = x;
1086 #endif
1088 return_job_token = FALSE;
1090 Trace_Log(JOBEND, job);
1091 if (!(job->flags & JOB_SPECIAL)) {
1092 if ((WAIT_STATUS(status) != 0) ||
1093 (aborting == ABORT_ERROR) ||
1094 (aborting == ABORT_INTERRUPT))
1095 return_job_token = TRUE;
1098 if ((aborting != ABORT_ERROR) && (aborting != ABORT_INTERRUPT) &&
1099 (WAIT_STATUS(status) == 0)) {
1101 * As long as we aren't aborting and the job didn't return a non-zero
1102 * status that we shouldn't ignore, we call Make_Update to update
1103 * the parents. In addition, any saved commands for the node are placed
1104 * on the .END target.
1106 if (job->tailCmds != NULL) {
1107 Lst_ForEachFrom(job->node->commands, job->tailCmds,
1108 JobSaveCommand,
1109 job->node);
1111 job->node->made = MADE;
1112 if (!(job->flags & JOB_SPECIAL))
1113 return_job_token = TRUE;
1114 Make_Update(job->node);
1115 job->job_state = JOB_ST_FREE;
1116 } else if (WAIT_STATUS(status)) {
1117 errors += 1;
1118 job->job_state = JOB_ST_FREE;
1122 * Set aborting if any error.
1124 if (errors && !keepgoing && (aborting != ABORT_INTERRUPT)) {
1126 * If we found any errors in this batch of children and the -k flag
1127 * wasn't given, we set the aborting flag so no more jobs get
1128 * started.
1130 aborting = ABORT_ERROR;
1133 if (return_job_token)
1134 Job_TokenReturn();
1136 if (aborting == ABORT_ERROR && jobTokensRunning == 0) {
1138 * If we are aborting and the job table is now empty, we finish.
1140 Finish(errors);
1145 *-----------------------------------------------------------------------
1146 * Job_Touch --
1147 * Touch the given target. Called by JobStart when the -t flag was
1148 * given
1150 * Input:
1151 * gn the node of the file to touch
1152 * silent TRUE if should not print message
1154 * Results:
1155 * None
1157 * Side Effects:
1158 * The data modification of the file is changed. In addition, if the
1159 * file did not exist, it is created.
1160 *-----------------------------------------------------------------------
1162 void
1163 Job_Touch(GNode *gn, Boolean silent)
1165 int streamID; /* ID of stream opened to do the touch */
1166 struct utimbuf times; /* Times for utime() call */
1168 if (gn->type & (OP_JOIN|OP_USE|OP_USEBEFORE|OP_EXEC|OP_OPTIONAL|
1169 OP_SPECIAL|OP_PHONY)) {
1171 * .JOIN, .USE, .ZEROTIME and .OPTIONAL targets are "virtual" targets
1172 * and, as such, shouldn't really be created.
1174 return;
1177 if (!silent || NoExecute(gn)) {
1178 (void)fprintf(stdout, "touch %s\n", gn->name);
1179 (void)fflush(stdout);
1182 if (NoExecute(gn)) {
1183 return;
1186 if (gn->type & OP_ARCHV) {
1187 Arch_Touch(gn);
1188 } else if (gn->type & OP_LIB) {
1189 Arch_TouchLib(gn);
1190 } else {
1191 char *file = gn->path ? gn->path : gn->name;
1193 times.actime = times.modtime = now;
1194 if (utime(file, &times) < 0){
1195 streamID = open(file, O_RDWR | O_CREAT, 0666);
1197 if (streamID >= 0) {
1198 char c;
1201 * Read and write a byte to the file to change the
1202 * modification time, then close the file.
1204 if (read(streamID, &c, 1) == 1) {
1205 (void)lseek(streamID, (off_t)0, SEEK_SET);
1206 while (write(streamID, &c, 1) == -1 && errno == EAGAIN)
1207 continue;
1210 (void)close(streamID);
1211 } else {
1212 (void)fprintf(stdout, "*** couldn't touch %s: %s",
1213 file, strerror(errno));
1214 (void)fflush(stdout);
1221 *-----------------------------------------------------------------------
1222 * Job_CheckCommands --
1223 * Make sure the given node has all the commands it needs.
1225 * Input:
1226 * gn The target whose commands need verifying
1227 * abortProc Function to abort with message
1229 * Results:
1230 * TRUE if the commands list is/was ok.
1232 * Side Effects:
1233 * The node will have commands from the .DEFAULT rule added to it
1234 * if it needs them.
1235 *-----------------------------------------------------------------------
1237 Boolean
1238 Job_CheckCommands(GNode *gn, void (*abortProc)(const char *, ...))
1240 if (OP_NOP(gn->type) && Lst_IsEmpty(gn->commands) &&
1241 ((gn->type & OP_LIB) == 0 || Lst_IsEmpty(gn->children))) {
1243 * No commands. Look for .DEFAULT rule from which we might infer
1244 * commands
1246 if ((DEFAULT != NULL) && !Lst_IsEmpty(DEFAULT->commands) &&
1247 (gn->type & OP_SPECIAL) == 0) {
1248 char *p1;
1250 * Make only looks for a .DEFAULT if the node was never the
1251 * target of an operator, so that's what we do too. If
1252 * a .DEFAULT was given, we substitute its commands for gn's
1253 * commands and set the IMPSRC variable to be the target's name
1254 * The DEFAULT node acts like a transformation rule, in that
1255 * gn also inherits any attributes or sources attached to
1256 * .DEFAULT itself.
1258 Make_HandleUse(DEFAULT, gn);
1259 Var_Set(IMPSRC, Var_Value(TARGET, gn, &p1), gn, 0);
1260 free(p1);
1261 } else if (Dir_MTime(gn, 0) == 0 && (gn->type & OP_SPECIAL) == 0) {
1263 * The node wasn't the target of an operator we have no .DEFAULT
1264 * rule to go on and the target doesn't already exist. There's
1265 * nothing more we can do for this branch. If the -k flag wasn't
1266 * given, we stop in our tracks, otherwise we just don't update
1267 * this node's parents so they never get examined.
1269 static const char msg[] = ": don't know how to make";
1271 if (gn->flags & FROM_DEPEND) {
1272 if (!Job_RunTarget(".STALE", gn->fname))
1273 fprintf(stdout, "%s: %s, %d: ignoring stale %s for %s\n",
1274 progname, gn->fname, gn->lineno, makeDependfile,
1275 gn->name);
1276 return TRUE;
1279 if (gn->type & OP_OPTIONAL) {
1280 (void)fprintf(stdout, "%s%s %s (ignored)\n", progname,
1281 msg, gn->name);
1282 (void)fflush(stdout);
1283 } else if (keepgoing) {
1284 (void)fprintf(stdout, "%s%s %s (continuing)\n", progname,
1285 msg, gn->name);
1286 (void)fflush(stdout);
1287 return FALSE;
1288 } else {
1289 (*abortProc)("%s%s %s. Stop", progname, msg, gn->name);
1290 return FALSE;
1294 return TRUE;
1298 *-----------------------------------------------------------------------
1299 * JobExec --
1300 * Execute the shell for the given job. Called from JobStart
1302 * Input:
1303 * job Job to execute
1305 * Results:
1306 * None.
1308 * Side Effects:
1309 * A shell is executed, outputs is altered and the Job structure added
1310 * to the job table.
1312 *-----------------------------------------------------------------------
1314 static void
1315 JobExec(Job *job, char **argv)
1317 int cpid; /* ID of new child */
1318 sigset_t mask;
1320 job->flags &= ~JOB_TRACED;
1322 if (DEBUG(JOB)) {
1323 int i;
1325 (void)fprintf(debug_file, "Running %s %sly\n", job->node->name, "local");
1326 (void)fprintf(debug_file, "\tCommand: ");
1327 for (i = 0; argv[i] != NULL; i++) {
1328 (void)fprintf(debug_file, "%s ", argv[i]);
1330 (void)fprintf(debug_file, "\n");
1334 * Some jobs produce no output and it's disconcerting to have
1335 * no feedback of their running (since they produce no output, the
1336 * banner with their name in it never appears). This is an attempt to
1337 * provide that feedback, even if nothing follows it.
1339 if ((lastNode != job->node) && !(job->flags & JOB_SILENT)) {
1340 MESSAGE(stdout, job->node);
1341 lastNode = job->node;
1344 /* No interruptions until this job is on the `jobs' list */
1345 JobSigLock(&mask);
1347 /* Pre-emptively mark job running, pid still zero though */
1348 job->job_state = JOB_ST_RUNNING;
1350 cpid = vFork();
1351 if (cpid == -1)
1352 Punt("Cannot vfork: %s", strerror(errno));
1354 if (cpid == 0) {
1355 /* Child */
1356 sigset_t tmask;
1358 #ifdef USE_META
1359 if (useMeta) {
1360 meta_job_child(job);
1362 #endif
1364 * Reset all signal handlers; this is necessary because we also
1365 * need to unblock signals before we exec(2).
1367 JobSigReset();
1369 /* Now unblock signals */
1370 sigemptyset(&tmask);
1371 JobSigUnlock(&tmask);
1374 * Must duplicate the input stream down to the child's input and
1375 * reset it to the beginning (again). Since the stream was marked
1376 * close-on-exec, we must clear that bit in the new input.
1378 if (dup2(FILENO(job->cmdFILE), 0) == -1) {
1379 execError("dup2", "job->cmdFILE");
1380 _exit(1);
1382 (void)fcntl(0, F_SETFD, 0);
1383 (void)lseek(0, (off_t)0, SEEK_SET);
1385 if (job->node->type & (OP_MAKE | OP_SUBMAKE)) {
1387 * Pass job token pipe to submakes.
1389 fcntl(tokenWaitJob.inPipe, F_SETFD, 0);
1390 fcntl(tokenWaitJob.outPipe, F_SETFD, 0);
1394 * Set up the child's output to be routed through the pipe
1395 * we've created for it.
1397 if (dup2(job->outPipe, 1) == -1) {
1398 execError("dup2", "job->outPipe");
1399 _exit(1);
1402 * The output channels are marked close on exec. This bit was
1403 * duplicated by the dup2(on some systems), so we have to clear
1404 * it before routing the shell's error output to the same place as
1405 * its standard output.
1407 (void)fcntl(1, F_SETFD, 0);
1408 if (dup2(1, 2) == -1) {
1409 execError("dup2", "1, 2");
1410 _exit(1);
1414 * We want to switch the child into a different process family so
1415 * we can kill it and all its descendants in one fell swoop,
1416 * by killing its process family, but not commit suicide.
1418 #if defined(HAVE_SETPGID)
1419 (void)setpgid(0, getpid());
1420 #else
1421 #if defined(HAVE_SETSID)
1422 /* XXX: dsl - I'm sure this should be setpgrp()... */
1423 (void)setsid();
1424 #else
1425 (void)setpgrp(0, getpid());
1426 #endif
1427 #endif
1429 Var_ExportVars();
1431 (void)execv(shellPath, argv);
1432 execError("exec", shellPath);
1433 _exit(1);
1436 /* Parent, continuing after the child exec */
1437 job->pid = cpid;
1439 Trace_Log(JOBSTART, job);
1442 * Set the current position in the buffer to the beginning
1443 * and mark another stream to watch in the outputs mask
1445 job->curPos = 0;
1447 watchfd(job);
1449 if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
1450 (void)fclose(job->cmdFILE);
1451 job->cmdFILE = NULL;
1455 * Now the job is actually running, add it to the table.
1457 if (DEBUG(JOB)) {
1458 fprintf(debug_file, "JobExec(%s): pid %d added to jobs table\n",
1459 job->node->name, job->pid);
1460 job_table_dump("job started");
1462 JobSigUnlock(&mask);
1466 *-----------------------------------------------------------------------
1467 * JobMakeArgv --
1468 * Create the argv needed to execute the shell for a given job.
1471 * Results:
1473 * Side Effects:
1475 *-----------------------------------------------------------------------
1477 static void
1478 JobMakeArgv(Job *job, char **argv)
1480 int argc;
1481 static char args[10]; /* For merged arguments */
1483 argv[0] = UNCONST(shellName);
1484 argc = 1;
1486 if ((commandShell->exit && (*commandShell->exit != '-')) ||
1487 (commandShell->echo && (*commandShell->echo != '-')))
1490 * At least one of the flags doesn't have a minus before it, so
1491 * merge them together. Have to do this because the *(&(@*#*&#$#
1492 * Bourne shell thinks its second argument is a file to source.
1493 * Grrrr. Note the ten-character limitation on the combined arguments.
1495 (void)snprintf(args, sizeof(args), "-%s%s",
1496 ((job->flags & JOB_IGNERR) ? "" :
1497 (commandShell->exit ? commandShell->exit : "")),
1498 ((job->flags & JOB_SILENT) ? "" :
1499 (commandShell->echo ? commandShell->echo : "")));
1501 if (args[1]) {
1502 argv[argc] = args;
1503 argc++;
1505 } else {
1506 if (!(job->flags & JOB_IGNERR) && commandShell->exit) {
1507 argv[argc] = UNCONST(commandShell->exit);
1508 argc++;
1510 if (!(job->flags & JOB_SILENT) && commandShell->echo) {
1511 argv[argc] = UNCONST(commandShell->echo);
1512 argc++;
1515 argv[argc] = NULL;
1519 *-----------------------------------------------------------------------
1520 * JobStart --
1521 * Start a target-creation process going for the target described
1522 * by the graph node gn.
1524 * Input:
1525 * gn target to create
1526 * flags flags for the job to override normal ones.
1527 * e.g. JOB_SPECIAL or JOB_IGNDOTS
1528 * previous The previous Job structure for this node, if any.
1530 * Results:
1531 * JOB_ERROR if there was an error in the commands, JOB_FINISHED
1532 * if there isn't actually anything left to do for the job and
1533 * JOB_RUNNING if the job has been started.
1535 * Side Effects:
1536 * A new Job node is created and added to the list of running
1537 * jobs. PMake is forked and a child shell created.
1539 * NB: I'm fairly sure that this code is never called with JOB_SPECIAL set
1540 * JOB_IGNDOTS is never set (dsl)
1541 * Also the return value is ignored by everyone.
1542 *-----------------------------------------------------------------------
1544 static int
1545 JobStart(GNode *gn, int flags)
1547 Job *job; /* new job descriptor */
1548 char *argv[10]; /* Argument vector to shell */
1549 Boolean cmdsOK; /* true if the nodes commands were all right */
1550 Boolean noExec; /* Set true if we decide not to run the job */
1551 int tfd; /* File descriptor to the temp file */
1553 for (job = job_table; job < job_table_end; job++) {
1554 if (job->job_state == JOB_ST_FREE)
1555 break;
1557 if (job >= job_table_end)
1558 Punt("JobStart no job slots vacant");
1560 memset(job, 0, sizeof *job);
1561 job->job_state = JOB_ST_SETUP;
1562 if (gn->type & OP_SPECIAL)
1563 flags |= JOB_SPECIAL;
1565 job->node = gn;
1566 job->tailCmds = NULL;
1569 * Set the initial value of the flags for this job based on the global
1570 * ones and the node's attributes... Any flags supplied by the caller
1571 * are also added to the field.
1573 job->flags = 0;
1574 if (Targ_Ignore(gn)) {
1575 job->flags |= JOB_IGNERR;
1577 if (Targ_Silent(gn)) {
1578 job->flags |= JOB_SILENT;
1580 job->flags |= flags;
1583 * Check the commands now so any attributes from .DEFAULT have a chance
1584 * to migrate to the node
1586 cmdsOK = Job_CheckCommands(gn, Error);
1588 job->inPollfd = NULL;
1590 * If the -n flag wasn't given, we open up OUR (not the child's)
1591 * temporary file to stuff commands in it. The thing is rd/wr so we don't
1592 * need to reopen it to feed it to the shell. If the -n flag *was* given,
1593 * we just set the file to be stdout. Cute, huh?
1595 if (((gn->type & OP_MAKE) && !(noRecursiveExecute)) ||
1596 (!noExecute && !touchFlag)) {
1598 * tfile is the name of a file into which all shell commands are
1599 * put. It is removed before the child shell is executed, unless
1600 * DEBUG(SCRIPT) is set.
1602 char *tfile;
1603 sigset_t mask;
1605 * We're serious here, but if the commands were bogus, we're
1606 * also dead...
1608 if (!cmdsOK) {
1609 PrintOnError(gn, NULL); /* provide some clue */
1610 DieHorribly();
1613 JobSigLock(&mask);
1614 tfd = mkTempFile(TMPPAT, &tfile);
1615 if (!DEBUG(SCRIPT))
1616 (void)eunlink(tfile);
1617 JobSigUnlock(&mask);
1619 job->cmdFILE = fdopen(tfd, "w+");
1620 if (job->cmdFILE == NULL) {
1621 Punt("Could not fdopen %s", tfile);
1623 (void)fcntl(FILENO(job->cmdFILE), F_SETFD, FD_CLOEXEC);
1625 * Send the commands to the command file, flush all its buffers then
1626 * rewind and remove the thing.
1628 noExec = FALSE;
1630 #ifdef USE_META
1631 if (useMeta) {
1632 meta_job_start(job, gn);
1633 if (Targ_Silent(gn)) { /* might have changed */
1634 job->flags |= JOB_SILENT;
1637 #endif
1639 * We can do all the commands at once. hooray for sanity
1641 numCommands = 0;
1642 Lst_ForEach(gn->commands, JobPrintCommand, job);
1645 * If we didn't print out any commands to the shell script,
1646 * there's not much point in executing the shell, is there?
1648 if (numCommands == 0) {
1649 noExec = TRUE;
1652 free(tfile);
1653 } else if (NoExecute(gn)) {
1655 * Not executing anything -- just print all the commands to stdout
1656 * in one fell swoop. This will still set up job->tailCmds correctly.
1658 if (lastNode != gn) {
1659 MESSAGE(stdout, gn);
1660 lastNode = gn;
1662 job->cmdFILE = stdout;
1664 * Only print the commands if they're ok, but don't die if they're
1665 * not -- just let the user know they're bad and keep going. It
1666 * doesn't do any harm in this case and may do some good.
1668 if (cmdsOK) {
1669 Lst_ForEach(gn->commands, JobPrintCommand, job);
1672 * Don't execute the shell, thank you.
1674 noExec = TRUE;
1675 } else {
1677 * Just touch the target and note that no shell should be executed.
1678 * Set cmdFILE to stdout to make life easier. Check the commands, too,
1679 * but don't die if they're no good -- it does no harm to keep working
1680 * up the graph.
1682 job->cmdFILE = stdout;
1683 Job_Touch(gn, job->flags&JOB_SILENT);
1684 noExec = TRUE;
1686 /* Just in case it isn't already... */
1687 (void)fflush(job->cmdFILE);
1690 * If we're not supposed to execute a shell, don't.
1692 if (noExec) {
1693 if (!(job->flags & JOB_SPECIAL))
1694 Job_TokenReturn();
1696 * Unlink and close the command file if we opened one
1698 if (job->cmdFILE != stdout) {
1699 if (job->cmdFILE != NULL) {
1700 (void)fclose(job->cmdFILE);
1701 job->cmdFILE = NULL;
1706 * We only want to work our way up the graph if we aren't here because
1707 * the commands for the job were no good.
1709 if (cmdsOK && aborting == 0) {
1710 if (job->tailCmds != NULL) {
1711 Lst_ForEachFrom(job->node->commands, job->tailCmds,
1712 JobSaveCommand,
1713 job->node);
1715 job->node->made = MADE;
1716 Make_Update(job->node);
1718 job->job_state = JOB_ST_FREE;
1719 return cmdsOK ? JOB_FINISHED : JOB_ERROR;
1723 * Set up the control arguments to the shell. This is based on the flags
1724 * set earlier for this job.
1726 JobMakeArgv(job, argv);
1728 /* Create the pipe by which we'll get the shell's output. */
1729 JobCreatePipe(job, 3);
1731 JobExec(job, argv);
1732 return(JOB_RUNNING);
1735 static char *
1736 JobOutput(Job *job, char *cp, char *endp, int msg)
1738 char *ecp;
1740 if (commandShell->noPrint) {
1741 ecp = Str_FindSubstring(cp, commandShell->noPrint);
1742 while (ecp != NULL) {
1743 if (cp != ecp) {
1744 *ecp = '\0';
1745 if (!beSilent && msg && job->node != lastNode) {
1746 MESSAGE(stdout, job->node);
1747 lastNode = job->node;
1750 * The only way there wouldn't be a newline after
1751 * this line is if it were the last in the buffer.
1752 * however, since the non-printable comes after it,
1753 * there must be a newline, so we don't print one.
1755 (void)fprintf(stdout, "%s", cp);
1756 (void)fflush(stdout);
1758 cp = ecp + commandShell->noPLen;
1759 if (cp != endp) {
1761 * Still more to print, look again after skipping
1762 * the whitespace following the non-printable
1763 * command....
1765 cp++;
1766 while (*cp == ' ' || *cp == '\t' || *cp == '\n') {
1767 cp++;
1769 ecp = Str_FindSubstring(cp, commandShell->noPrint);
1770 } else {
1771 return cp;
1775 return cp;
1779 *-----------------------------------------------------------------------
1780 * JobDoOutput --
1781 * This function is called at different times depending on
1782 * whether the user has specified that output is to be collected
1783 * via pipes or temporary files. In the former case, we are called
1784 * whenever there is something to read on the pipe. We collect more
1785 * output from the given job and store it in the job's outBuf. If
1786 * this makes up a line, we print it tagged by the job's identifier,
1787 * as necessary.
1788 * If output has been collected in a temporary file, we open the
1789 * file and read it line by line, transfering it to our own
1790 * output channel until the file is empty. At which point we
1791 * remove the temporary file.
1792 * In both cases, however, we keep our figurative eye out for the
1793 * 'noPrint' line for the shell from which the output came. If
1794 * we recognize a line, we don't print it. If the command is not
1795 * alone on the line (the character after it is not \0 or \n), we
1796 * do print whatever follows it.
1798 * Input:
1799 * job the job whose output needs printing
1800 * finish TRUE if this is the last time we'll be called
1801 * for this job
1803 * Results:
1804 * None
1806 * Side Effects:
1807 * curPos may be shifted as may the contents of outBuf.
1808 *-----------------------------------------------------------------------
1810 STATIC void
1811 JobDoOutput(Job *job, Boolean finish)
1813 Boolean gotNL = FALSE; /* true if got a newline */
1814 Boolean fbuf; /* true if our buffer filled up */
1815 int nr; /* number of bytes read */
1816 int i; /* auxiliary index into outBuf */
1817 int max; /* limit for i (end of current data) */
1818 int nRead; /* (Temporary) number of bytes read */
1821 * Read as many bytes as will fit in the buffer.
1823 end_loop:
1824 gotNL = FALSE;
1825 fbuf = FALSE;
1827 nRead = read(job->inPipe, &job->outBuf[job->curPos],
1828 JOB_BUFSIZE - job->curPos);
1829 if (nRead < 0) {
1830 if (errno == EAGAIN)
1831 return;
1832 if (DEBUG(JOB)) {
1833 perror("JobDoOutput(piperead)");
1835 nr = 0;
1836 } else {
1837 nr = nRead;
1841 * If we hit the end-of-file (the job is dead), we must flush its
1842 * remaining output, so pretend we read a newline if there's any
1843 * output remaining in the buffer.
1844 * Also clear the 'finish' flag so we stop looping.
1846 if ((nr == 0) && (job->curPos != 0)) {
1847 job->outBuf[job->curPos] = '\n';
1848 nr = 1;
1849 finish = FALSE;
1850 } else if (nr == 0) {
1851 finish = FALSE;
1855 * Look for the last newline in the bytes we just got. If there is
1856 * one, break out of the loop with 'i' as its index and gotNL set
1857 * TRUE.
1859 max = job->curPos + nr;
1860 for (i = job->curPos + nr - 1; i >= job->curPos; i--) {
1861 if (job->outBuf[i] == '\n') {
1862 gotNL = TRUE;
1863 break;
1864 } else if (job->outBuf[i] == '\0') {
1866 * Why?
1868 job->outBuf[i] = ' ';
1872 if (!gotNL) {
1873 job->curPos += nr;
1874 if (job->curPos == JOB_BUFSIZE) {
1876 * If we've run out of buffer space, we have no choice
1877 * but to print the stuff. sigh.
1879 fbuf = TRUE;
1880 i = job->curPos;
1883 if (gotNL || fbuf) {
1885 * Need to send the output to the screen. Null terminate it
1886 * first, overwriting the newline character if there was one.
1887 * So long as the line isn't one we should filter (according
1888 * to the shell description), we print the line, preceded
1889 * by a target banner if this target isn't the same as the
1890 * one for which we last printed something.
1891 * The rest of the data in the buffer are then shifted down
1892 * to the start of the buffer and curPos is set accordingly.
1894 job->outBuf[i] = '\0';
1895 if (i >= job->curPos) {
1896 char *cp;
1898 cp = JobOutput(job, job->outBuf, &job->outBuf[i], FALSE);
1901 * There's still more in that thar buffer. This time, though,
1902 * we know there's no newline at the end, so we add one of
1903 * our own free will.
1905 if (*cp != '\0') {
1906 if (!beSilent && job->node != lastNode) {
1907 MESSAGE(stdout, job->node);
1908 lastNode = job->node;
1910 #ifdef USE_META
1911 if (useMeta) {
1912 meta_job_output(job, cp, gotNL ? "\n" : "");
1914 #endif
1915 (void)fprintf(stdout, "%s%s", cp, gotNL ? "\n" : "");
1916 (void)fflush(stdout);
1920 * max is the last offset still in the buffer. Move any remaining
1921 * characters to the start of the buffer and update the end marker
1922 * curPos.
1924 if (i < max) {
1925 (void)memmove(job->outBuf, &job->outBuf[i + 1], max - (i + 1));
1926 job->curPos = max - (i + 1);
1927 } else {
1928 assert(i == max);
1929 job->curPos = 0;
1932 if (finish) {
1934 * If the finish flag is true, we must loop until we hit
1935 * end-of-file on the pipe. This is guaranteed to happen
1936 * eventually since the other end of the pipe is now closed
1937 * (we closed it explicitly and the child has exited). When
1938 * we do get an EOF, finish will be set FALSE and we'll fall
1939 * through and out.
1941 goto end_loop;
1945 static void
1946 JobRun(GNode *targ)
1948 #ifdef notyet
1950 * Unfortunately it is too complicated to run .BEGIN, .END,
1951 * and .INTERRUPT job in the parallel job module. This has
1952 * the nice side effect that it avoids a lot of other problems.
1954 Lst lst = Lst_Init(FALSE);
1955 Lst_AtEnd(lst, targ);
1956 (void)Make_Run(lst);
1957 Lst_Destroy(lst, NULL);
1958 JobStart(targ, JOB_SPECIAL);
1959 while (jobTokensRunning) {
1960 Job_CatchOutput();
1962 #else
1963 Compat_Make(targ, targ);
1964 if (targ->made == ERROR) {
1965 PrintOnError(targ, "\n\nStop.");
1966 exit(1);
1968 #endif
1972 *-----------------------------------------------------------------------
1973 * Job_CatchChildren --
1974 * Handle the exit of a child. Called from Make_Make.
1976 * Input:
1977 * block TRUE if should block on the wait
1979 * Results:
1980 * none.
1982 * Side Effects:
1983 * The job descriptor is removed from the list of children.
1985 * Notes:
1986 * We do waits, blocking or not, according to the wisdom of our
1987 * caller, until there are no more children to report. For each
1988 * job, call JobFinish to finish things off.
1990 *-----------------------------------------------------------------------
1993 void
1994 Job_CatchChildren(void)
1996 int pid; /* pid of dead child */
1997 WAIT_T status; /* Exit/termination status */
2000 * Don't even bother if we know there's no one around.
2002 if (jobTokensRunning == 0)
2003 return;
2005 while ((pid = waitpid((pid_t) -1, &status, WNOHANG | WUNTRACED)) > 0) {
2006 if (DEBUG(JOB)) {
2007 (void)fprintf(debug_file, "Process %d exited/stopped status %x.\n", pid,
2008 WAIT_STATUS(status));
2010 JobReapChild(pid, status, TRUE);
2015 * It is possible that wait[pid]() was called from elsewhere,
2016 * this lets us reap jobs regardless.
2018 void
2019 JobReapChild(pid_t pid, WAIT_T status, Boolean isJobs)
2021 Job *job; /* job descriptor for dead child */
2024 * Don't even bother if we know there's no one around.
2026 if (jobTokensRunning == 0)
2027 return;
2029 job = JobFindPid(pid, JOB_ST_RUNNING, isJobs);
2030 if (job == NULL) {
2031 if (isJobs) {
2032 if (!lurking_children)
2033 Error("Child (%d) status %x not in table?", pid, status);
2035 return; /* not ours */
2037 if (WIFSTOPPED(status)) {
2038 if (DEBUG(JOB)) {
2039 (void)fprintf(debug_file, "Process %d (%s) stopped.\n",
2040 job->pid, job->node->name);
2042 if (!make_suspended) {
2043 switch (WSTOPSIG(status)) {
2044 case SIGTSTP:
2045 (void)printf("*** [%s] Suspended\n", job->node->name);
2046 break;
2047 case SIGSTOP:
2048 (void)printf("*** [%s] Stopped\n", job->node->name);
2049 break;
2050 default:
2051 (void)printf("*** [%s] Stopped -- signal %d\n",
2052 job->node->name, WSTOPSIG(status));
2054 job->job_suspended = 1;
2056 (void)fflush(stdout);
2057 return;
2060 job->job_state = JOB_ST_FINISHED;
2061 job->exit_status = WAIT_STATUS(status);
2063 JobFinish(job, status);
2067 *-----------------------------------------------------------------------
2068 * Job_CatchOutput --
2069 * Catch the output from our children, if we're using
2070 * pipes do so. Otherwise just block time until we get a
2071 * signal(most likely a SIGCHLD) since there's no point in
2072 * just spinning when there's nothing to do and the reaping
2073 * of a child can wait for a while.
2075 * Results:
2076 * None
2078 * Side Effects:
2079 * Output is read from pipes if we're piping.
2080 * -----------------------------------------------------------------------
2082 void
2083 Job_CatchOutput(void)
2085 int nready;
2086 Job *job;
2087 int i;
2089 (void)fflush(stdout);
2091 /* The first fd in the list is the job token pipe */
2092 do {
2093 nready = poll(fds + 1 - wantToken, nfds - 1 + wantToken, POLL_MSEC);
2094 } while (nready < 0 && errno == EINTR);
2096 if (nready < 0)
2097 Punt("poll: %s", strerror(errno));
2099 if (nready > 0 && readyfd(&childExitJob)) {
2100 char token = 0;
2101 ssize_t count;
2102 count = read(childExitJob.inPipe, &token, 1);
2103 switch (count) {
2104 case 0:
2105 Punt("unexpected eof on token pipe");
2106 case -1:
2107 Punt("token pipe read: %s", strerror(errno));
2108 case 1:
2109 if (token == DO_JOB_RESUME[0])
2110 /* Complete relay requested from our SIGCONT handler */
2111 JobRestartJobs();
2112 break;
2113 default:
2114 abort();
2116 --nready;
2119 Job_CatchChildren();
2120 if (nready == 0)
2121 return;
2123 for (i = 2; i < nfds; i++) {
2124 if (!fds[i].revents)
2125 continue;
2126 job = jobfds[i];
2127 if (job->job_state == JOB_ST_RUNNING)
2128 JobDoOutput(job, FALSE);
2129 if (--nready == 0)
2130 return;
2135 *-----------------------------------------------------------------------
2136 * Job_Make --
2137 * Start the creation of a target. Basically a front-end for
2138 * JobStart used by the Make module.
2140 * Results:
2141 * None.
2143 * Side Effects:
2144 * Another job is started.
2146 *-----------------------------------------------------------------------
2148 void
2149 Job_Make(GNode *gn)
2151 (void)JobStart(gn, 0);
2154 void
2155 Shell_Init(void)
2157 if (shellPath == NULL) {
2159 * We are using the default shell, which may be an absolute
2160 * path if DEFSHELL_CUSTOM is defined.
2162 shellName = commandShell->name;
2163 #ifdef DEFSHELL_CUSTOM
2164 if (*shellName == '/') {
2165 shellPath = shellName;
2166 shellName = strrchr(shellPath, '/');
2167 shellName++;
2168 } else
2169 #endif
2170 shellPath = str_concat(_PATH_DEFSHELLDIR, shellName, STR_ADDSLASH);
2172 if (commandShell->exit == NULL) {
2173 commandShell->exit = "";
2175 if (commandShell->echo == NULL) {
2176 commandShell->echo = "";
2178 if (commandShell->hasErrCtl && *commandShell->exit) {
2179 if (shellErrFlag &&
2180 strcmp(commandShell->exit, &shellErrFlag[1]) != 0) {
2181 free(shellErrFlag);
2182 shellErrFlag = NULL;
2184 if (!shellErrFlag) {
2185 int n = strlen(commandShell->exit) + 2;
2187 shellErrFlag = bmake_malloc(n);
2188 if (shellErrFlag) {
2189 snprintf(shellErrFlag, n, "-%s", commandShell->exit);
2192 } else if (shellErrFlag) {
2193 free(shellErrFlag);
2194 shellErrFlag = NULL;
2199 * Returns the string literal that is used in the current command shell
2200 * to produce a newline character.
2202 const char *
2203 Shell_GetNewline(void)
2206 return commandShell->newline;
2209 void
2210 Job_SetPrefix(void)
2213 if (targPrefix) {
2214 free(targPrefix);
2215 } else if (!Var_Exists(MAKE_JOB_PREFIX, VAR_GLOBAL)) {
2216 Var_Set(MAKE_JOB_PREFIX, "---", VAR_GLOBAL, 0);
2219 targPrefix = Var_Subst(NULL, "${" MAKE_JOB_PREFIX "}",
2220 VAR_GLOBAL, VARF_WANTRES);
2224 *-----------------------------------------------------------------------
2225 * Job_Init --
2226 * Initialize the process module
2228 * Input:
2230 * Results:
2231 * none
2233 * Side Effects:
2234 * lists and counters are initialized
2235 *-----------------------------------------------------------------------
2237 void
2238 Job_Init(void)
2240 Job_SetPrefix();
2241 /* Allocate space for all the job info */
2242 job_table = bmake_malloc(maxJobs * sizeof *job_table);
2243 memset(job_table, 0, maxJobs * sizeof *job_table);
2244 job_table_end = job_table + maxJobs;
2245 wantToken = 0;
2247 aborting = 0;
2248 errors = 0;
2250 lastNode = NULL;
2253 * There is a non-zero chance that we already have children.
2254 * eg after 'make -f- <<EOF'
2255 * Since their termination causes a 'Child (pid) not in table' message,
2256 * Collect the status of any that are already dead, and suppress the
2257 * error message if there are any undead ones.
2259 for (;;) {
2260 int rval, status;
2261 rval = waitpid((pid_t) -1, &status, WNOHANG);
2262 if (rval > 0)
2263 continue;
2264 if (rval == 0)
2265 lurking_children = 1;
2266 break;
2269 Shell_Init();
2271 JobCreatePipe(&childExitJob, 3);
2273 /* We can only need to wait for tokens, children and output from each job */
2274 fds = bmake_malloc(sizeof (*fds) * (2 + maxJobs));
2275 jobfds = bmake_malloc(sizeof (*jobfds) * (2 + maxJobs));
2277 /* These are permanent entries and take slots 0 and 1 */
2278 watchfd(&tokenWaitJob);
2279 watchfd(&childExitJob);
2281 sigemptyset(&caught_signals);
2283 * Install a SIGCHLD handler.
2285 (void)bmake_signal(SIGCHLD, JobChildSig);
2286 sigaddset(&caught_signals, SIGCHLD);
2288 #define ADDSIG(s,h) \
2289 if (bmake_signal(s, SIG_IGN) != SIG_IGN) { \
2290 sigaddset(&caught_signals, s); \
2291 (void)bmake_signal(s, h); \
2295 * Catch the four signals that POSIX specifies if they aren't ignored.
2296 * JobPassSig will take care of calling JobInterrupt if appropriate.
2298 ADDSIG(SIGINT, JobPassSig_int)
2299 ADDSIG(SIGHUP, JobPassSig_term)
2300 ADDSIG(SIGTERM, JobPassSig_term)
2301 ADDSIG(SIGQUIT, JobPassSig_term)
2304 * There are additional signals that need to be caught and passed if
2305 * either the export system wants to be told directly of signals or if
2306 * we're giving each job its own process group (since then it won't get
2307 * signals from the terminal driver as we own the terminal)
2309 ADDSIG(SIGTSTP, JobPassSig_suspend)
2310 ADDSIG(SIGTTOU, JobPassSig_suspend)
2311 ADDSIG(SIGTTIN, JobPassSig_suspend)
2312 ADDSIG(SIGWINCH, JobCondPassSig)
2313 ADDSIG(SIGCONT, JobContinueSig)
2314 #undef ADDSIG
2316 (void)Job_RunTarget(".BEGIN", NULL);
2317 postCommands = Targ_FindNode(".END", TARG_CREATE);
2320 static void JobSigReset(void)
2322 #define DELSIG(s) \
2323 if (sigismember(&caught_signals, s)) { \
2324 (void)bmake_signal(s, SIG_DFL); \
2327 DELSIG(SIGINT)
2328 DELSIG(SIGHUP)
2329 DELSIG(SIGQUIT)
2330 DELSIG(SIGTERM)
2331 DELSIG(SIGTSTP)
2332 DELSIG(SIGTTOU)
2333 DELSIG(SIGTTIN)
2334 DELSIG(SIGWINCH)
2335 DELSIG(SIGCONT)
2336 #undef DELSIG
2337 (void)bmake_signal(SIGCHLD, SIG_DFL);
2341 *-----------------------------------------------------------------------
2342 * JobMatchShell --
2343 * Find a shell in 'shells' given its name.
2345 * Results:
2346 * A pointer to the Shell structure.
2348 * Side Effects:
2349 * None.
2351 *-----------------------------------------------------------------------
2353 static Shell *
2354 JobMatchShell(const char *name)
2356 Shell *sh;
2358 for (sh = shells; sh->name != NULL; sh++) {
2359 if (strcmp(name, sh->name) == 0)
2360 return (sh);
2362 return NULL;
2366 *-----------------------------------------------------------------------
2367 * Job_ParseShell --
2368 * Parse a shell specification and set up commandShell, shellPath
2369 * and shellName appropriately.
2371 * Input:
2372 * line The shell spec
2374 * Results:
2375 * FAILURE if the specification was incorrect.
2377 * Side Effects:
2378 * commandShell points to a Shell structure (either predefined or
2379 * created from the shell spec), shellPath is the full path of the
2380 * shell described by commandShell, while shellName is just the
2381 * final component of shellPath.
2383 * Notes:
2384 * A shell specification consists of a .SHELL target, with dependency
2385 * operator, followed by a series of blank-separated words. Double
2386 * quotes can be used to use blanks in words. A backslash escapes
2387 * anything (most notably a double-quote and a space) and
2388 * provides the functionality it does in C. Each word consists of
2389 * keyword and value separated by an equal sign. There should be no
2390 * unnecessary spaces in the word. The keywords are as follows:
2391 * name Name of shell.
2392 * path Location of shell.
2393 * quiet Command to turn off echoing.
2394 * echo Command to turn echoing on
2395 * filter Result of turning off echoing that shouldn't be
2396 * printed.
2397 * echoFlag Flag to turn echoing on at the start
2398 * errFlag Flag to turn error checking on at the start
2399 * hasErrCtl True if shell has error checking control
2400 * newline String literal to represent a newline char
2401 * check Command to turn on error checking if hasErrCtl
2402 * is TRUE or template of command to echo a command
2403 * for which error checking is off if hasErrCtl is
2404 * FALSE.
2405 * ignore Command to turn off error checking if hasErrCtl
2406 * is TRUE or template of command to execute a
2407 * command so as to ignore any errors it returns if
2408 * hasErrCtl is FALSE.
2410 *-----------------------------------------------------------------------
2412 ReturnStatus
2413 Job_ParseShell(char *line)
2415 char **words;
2416 char **argv;
2417 int argc;
2418 char *path;
2419 Shell newShell;
2420 Boolean fullSpec = FALSE;
2421 Shell *sh;
2423 while (isspace((unsigned char)*line)) {
2424 line++;
2427 free(UNCONST(shellArgv));
2429 memset(&newShell, 0, sizeof(newShell));
2432 * Parse the specification by keyword
2434 words = brk_string(line, &argc, TRUE, &path);
2435 if (words == NULL) {
2436 Error("Unterminated quoted string [%s]", line);
2437 return FAILURE;
2439 shellArgv = path;
2441 for (path = NULL, argv = words; argc != 0; argc--, argv++) {
2442 if (strncmp(*argv, "path=", 5) == 0) {
2443 path = &argv[0][5];
2444 } else if (strncmp(*argv, "name=", 5) == 0) {
2445 newShell.name = &argv[0][5];
2446 } else {
2447 if (strncmp(*argv, "quiet=", 6) == 0) {
2448 newShell.echoOff = &argv[0][6];
2449 } else if (strncmp(*argv, "echo=", 5) == 0) {
2450 newShell.echoOn = &argv[0][5];
2451 } else if (strncmp(*argv, "filter=", 7) == 0) {
2452 newShell.noPrint = &argv[0][7];
2453 newShell.noPLen = strlen(newShell.noPrint);
2454 } else if (strncmp(*argv, "echoFlag=", 9) == 0) {
2455 newShell.echo = &argv[0][9];
2456 } else if (strncmp(*argv, "errFlag=", 8) == 0) {
2457 newShell.exit = &argv[0][8];
2458 } else if (strncmp(*argv, "hasErrCtl=", 10) == 0) {
2459 char c = argv[0][10];
2460 newShell.hasErrCtl = !((c != 'Y') && (c != 'y') &&
2461 (c != 'T') && (c != 't'));
2462 } else if (strncmp(*argv, "newline=", 8) == 0) {
2463 newShell.newline = &argv[0][8];
2464 } else if (strncmp(*argv, "check=", 6) == 0) {
2465 newShell.errCheck = &argv[0][6];
2466 } else if (strncmp(*argv, "ignore=", 7) == 0) {
2467 newShell.ignErr = &argv[0][7];
2468 } else if (strncmp(*argv, "errout=", 7) == 0) {
2469 newShell.errOut = &argv[0][7];
2470 } else if (strncmp(*argv, "comment=", 8) == 0) {
2471 newShell.commentChar = argv[0][8];
2472 } else {
2473 Parse_Error(PARSE_FATAL, "Unknown keyword \"%s\"",
2474 *argv);
2475 free(words);
2476 return(FAILURE);
2478 fullSpec = TRUE;
2482 if (path == NULL) {
2484 * If no path was given, the user wants one of the pre-defined shells,
2485 * yes? So we find the one s/he wants with the help of JobMatchShell
2486 * and set things up the right way. shellPath will be set up by
2487 * Shell_Init.
2489 if (newShell.name == NULL) {
2490 Parse_Error(PARSE_FATAL, "Neither path nor name specified");
2491 free(words);
2492 return(FAILURE);
2493 } else {
2494 if ((sh = JobMatchShell(newShell.name)) == NULL) {
2495 Parse_Error(PARSE_WARNING, "%s: No matching shell",
2496 newShell.name);
2497 free(words);
2498 return(FAILURE);
2500 commandShell = sh;
2501 shellName = newShell.name;
2502 if (shellPath) {
2503 /* Shell_Init has already been called! Do it again. */
2504 free(UNCONST(shellPath));
2505 shellPath = NULL;
2506 Shell_Init();
2509 } else {
2511 * The user provided a path. If s/he gave nothing else (fullSpec is
2512 * FALSE), try and find a matching shell in the ones we know of.
2513 * Else we just take the specification at its word and copy it
2514 * to a new location. In either case, we need to record the
2515 * path the user gave for the shell.
2517 shellPath = path;
2518 path = strrchr(path, '/');
2519 if (path == NULL) {
2520 path = UNCONST(shellPath);
2521 } else {
2522 path += 1;
2524 if (newShell.name != NULL) {
2525 shellName = newShell.name;
2526 } else {
2527 shellName = path;
2529 if (!fullSpec) {
2530 if ((sh = JobMatchShell(shellName)) == NULL) {
2531 Parse_Error(PARSE_WARNING, "%s: No matching shell",
2532 shellName);
2533 free(words);
2534 return(FAILURE);
2536 commandShell = sh;
2537 } else {
2538 commandShell = bmake_malloc(sizeof(Shell));
2539 *commandShell = newShell;
2541 /* this will take care of shellErrFlag */
2542 Shell_Init();
2545 if (commandShell->echoOn && commandShell->echoOff) {
2546 commandShell->hasEchoCtl = TRUE;
2549 if (!commandShell->hasErrCtl) {
2550 if (commandShell->errCheck == NULL) {
2551 commandShell->errCheck = "";
2553 if (commandShell->ignErr == NULL) {
2554 commandShell->ignErr = "%s\n";
2559 * Do not free up the words themselves, since they might be in use by the
2560 * shell specification.
2562 free(words);
2563 return SUCCESS;
2567 *-----------------------------------------------------------------------
2568 * JobInterrupt --
2569 * Handle the receipt of an interrupt.
2571 * Input:
2572 * runINTERRUPT Non-zero if commands for the .INTERRUPT target
2573 * should be executed
2574 * signo signal received
2576 * Results:
2577 * None
2579 * Side Effects:
2580 * All children are killed. Another job will be started if the
2581 * .INTERRUPT target was given.
2582 *-----------------------------------------------------------------------
2584 static void
2585 JobInterrupt(int runINTERRUPT, int signo)
2587 Job *job; /* job descriptor in that element */
2588 GNode *interrupt; /* the node describing the .INTERRUPT target */
2589 sigset_t mask;
2590 GNode *gn;
2592 aborting = ABORT_INTERRUPT;
2594 JobSigLock(&mask);
2596 for (job = job_table; job < job_table_end; job++) {
2597 if (job->job_state != JOB_ST_RUNNING)
2598 continue;
2600 gn = job->node;
2602 JobDeleteTarget(gn);
2603 if (job->pid) {
2604 if (DEBUG(JOB)) {
2605 (void)fprintf(debug_file,
2606 "JobInterrupt passing signal %d to child %d.\n",
2607 signo, job->pid);
2609 KILLPG(job->pid, signo);
2613 JobSigUnlock(&mask);
2615 if (runINTERRUPT && !touchFlag) {
2616 interrupt = Targ_FindNode(".INTERRUPT", TARG_NOCREATE);
2617 if (interrupt != NULL) {
2618 ignoreErrors = FALSE;
2619 JobRun(interrupt);
2622 Trace_Log(MAKEINTR, 0);
2623 exit(signo);
2627 *-----------------------------------------------------------------------
2628 * Job_Finish --
2629 * Do final processing such as the running of the commands
2630 * attached to the .END target.
2632 * Results:
2633 * Number of errors reported.
2635 * Side Effects:
2636 * None.
2637 *-----------------------------------------------------------------------
2640 Job_Finish(void)
2642 if (postCommands != NULL &&
2643 (!Lst_IsEmpty(postCommands->commands) ||
2644 !Lst_IsEmpty(postCommands->children))) {
2645 if (errors) {
2646 Error("Errors reported so .END ignored");
2647 } else {
2648 JobRun(postCommands);
2651 return(errors);
2655 *-----------------------------------------------------------------------
2656 * Job_End --
2657 * Cleanup any memory used by the jobs module
2659 * Results:
2660 * None.
2662 * Side Effects:
2663 * Memory is freed
2664 *-----------------------------------------------------------------------
2666 void
2667 Job_End(void)
2669 #ifdef CLEANUP
2670 free(shellArgv);
2671 #endif
2675 *-----------------------------------------------------------------------
2676 * Job_Wait --
2677 * Waits for all running jobs to finish and returns. Sets 'aborting'
2678 * to ABORT_WAIT to prevent other jobs from starting.
2680 * Results:
2681 * None.
2683 * Side Effects:
2684 * Currently running jobs finish.
2686 *-----------------------------------------------------------------------
2688 void
2689 Job_Wait(void)
2691 aborting = ABORT_WAIT;
2692 while (jobTokensRunning != 0) {
2693 Job_CatchOutput();
2695 aborting = 0;
2699 *-----------------------------------------------------------------------
2700 * Job_AbortAll --
2701 * Abort all currently running jobs without handling output or anything.
2702 * This function is to be called only in the event of a major
2703 * error. Most definitely NOT to be called from JobInterrupt.
2705 * Results:
2706 * None
2708 * Side Effects:
2709 * All children are killed, not just the firstborn
2710 *-----------------------------------------------------------------------
2712 void
2713 Job_AbortAll(void)
2715 Job *job; /* the job descriptor in that element */
2716 WAIT_T foo;
2718 aborting = ABORT_ERROR;
2720 if (jobTokensRunning) {
2721 for (job = job_table; job < job_table_end; job++) {
2722 if (job->job_state != JOB_ST_RUNNING)
2723 continue;
2725 * kill the child process with increasingly drastic signals to make
2726 * darn sure it's dead.
2728 KILLPG(job->pid, SIGINT);
2729 KILLPG(job->pid, SIGKILL);
2734 * Catch as many children as want to report in at first, then give up
2736 while (waitpid((pid_t) -1, &foo, WNOHANG) > 0)
2737 continue;
2742 *-----------------------------------------------------------------------
2743 * JobRestartJobs --
2744 * Tries to restart stopped jobs if there are slots available.
2745 * Called in process context in response to a SIGCONT.
2747 * Results:
2748 * None.
2750 * Side Effects:
2751 * Resumes jobs.
2753 *-----------------------------------------------------------------------
2755 static void
2756 JobRestartJobs(void)
2758 Job *job;
2760 for (job = job_table; job < job_table_end; job++) {
2761 if (job->job_state == JOB_ST_RUNNING &&
2762 (make_suspended || job->job_suspended)) {
2763 if (DEBUG(JOB)) {
2764 (void)fprintf(debug_file, "Restarting stopped job pid %d.\n",
2765 job->pid);
2767 if (job->job_suspended) {
2768 (void)printf("*** [%s] Continued\n", job->node->name);
2769 (void)fflush(stdout);
2771 job->job_suspended = 0;
2772 if (KILLPG(job->pid, SIGCONT) != 0 && DEBUG(JOB)) {
2773 fprintf(debug_file, "Failed to send SIGCONT to %d\n", job->pid);
2776 if (job->job_state == JOB_ST_FINISHED)
2777 /* Job exit deferred after calling waitpid() in a signal handler */
2778 JobFinish(job, job->exit_status);
2780 make_suspended = 0;
2783 static void
2784 watchfd(Job *job)
2786 if (job->inPollfd != NULL)
2787 Punt("Watching watched job");
2789 fds[nfds].fd = job->inPipe;
2790 fds[nfds].events = POLLIN;
2791 jobfds[nfds] = job;
2792 job->inPollfd = &fds[nfds];
2793 nfds++;
2796 static void
2797 clearfd(Job *job)
2799 int i;
2800 if (job->inPollfd == NULL)
2801 Punt("Unwatching unwatched job");
2802 i = job->inPollfd - fds;
2803 nfds--;
2805 * Move last job in table into hole made by dead job.
2807 if (nfds != i) {
2808 fds[i] = fds[nfds];
2809 jobfds[i] = jobfds[nfds];
2810 jobfds[i]->inPollfd = &fds[i];
2812 job->inPollfd = NULL;
2815 static int
2816 readyfd(Job *job)
2818 if (job->inPollfd == NULL)
2819 Punt("Polling unwatched job");
2820 return (job->inPollfd->revents & POLLIN) != 0;
2824 *-----------------------------------------------------------------------
2825 * JobTokenAdd --
2826 * Put a token into the job pipe so that some make process can start
2827 * another job.
2829 * Side Effects:
2830 * Allows more build jobs to be spawned somewhere.
2832 *-----------------------------------------------------------------------
2835 static void
2836 JobTokenAdd(void)
2838 char tok = JOB_TOKENS[aborting], tok1;
2840 /* If we are depositing an error token flush everything else */
2841 while (tok != '+' && read(tokenWaitJob.inPipe, &tok1, 1) == 1)
2842 continue;
2844 if (DEBUG(JOB))
2845 fprintf(debug_file, "(%d) aborting %d, deposit token %c\n",
2846 getpid(), aborting, JOB_TOKENS[aborting]);
2847 while (write(tokenWaitJob.outPipe, &tok, 1) == -1 && errno == EAGAIN)
2848 continue;
2852 *-----------------------------------------------------------------------
2853 * Job_ServerStartTokenAdd --
2854 * Prep the job token pipe in the root make process.
2856 *-----------------------------------------------------------------------
2859 void
2860 Job_ServerStart(int max_tokens, int jp_0, int jp_1)
2862 int i;
2863 char jobarg[64];
2865 if (jp_0 >= 0 && jp_1 >= 0) {
2866 /* Pipe passed in from parent */
2867 tokenWaitJob.inPipe = jp_0;
2868 tokenWaitJob.outPipe = jp_1;
2869 (void)fcntl(jp_0, F_SETFD, FD_CLOEXEC);
2870 (void)fcntl(jp_1, F_SETFD, FD_CLOEXEC);
2871 return;
2874 JobCreatePipe(&tokenWaitJob, 15);
2876 snprintf(jobarg, sizeof(jobarg), "%d,%d",
2877 tokenWaitJob.inPipe, tokenWaitJob.outPipe);
2879 Var_Append(MAKEFLAGS, "-J", VAR_GLOBAL);
2880 Var_Append(MAKEFLAGS, jobarg, VAR_GLOBAL);
2883 * Preload the job pipe with one token per job, save the one
2884 * "extra" token for the primary job.
2886 * XXX should clip maxJobs against PIPE_BUF -- if max_tokens is
2887 * larger than the write buffer size of the pipe, we will
2888 * deadlock here.
2890 for (i = 1; i < max_tokens; i++)
2891 JobTokenAdd();
2895 *-----------------------------------------------------------------------
2896 * Job_TokenReturn --
2897 * Return a withdrawn token to the pool.
2899 *-----------------------------------------------------------------------
2902 void
2903 Job_TokenReturn(void)
2905 jobTokensRunning--;
2906 if (jobTokensRunning < 0)
2907 Punt("token botch");
2908 if (jobTokensRunning || JOB_TOKENS[aborting] != '+')
2909 JobTokenAdd();
2913 *-----------------------------------------------------------------------
2914 * Job_TokenWithdraw --
2915 * Attempt to withdraw a token from the pool.
2917 * Results:
2918 * Returns TRUE if a token was withdrawn, and FALSE if the pool
2919 * is currently empty.
2921 * Side Effects:
2922 * If pool is empty, set wantToken so that we wake up
2923 * when a token is released.
2925 *-----------------------------------------------------------------------
2929 Boolean
2930 Job_TokenWithdraw(void)
2932 char tok, tok1;
2933 int count;
2935 wantToken = 0;
2936 if (DEBUG(JOB))
2937 fprintf(debug_file, "Job_TokenWithdraw(%d): aborting %d, running %d\n",
2938 getpid(), aborting, jobTokensRunning);
2940 if (aborting || (jobTokensRunning >= maxJobs))
2941 return FALSE;
2943 count = read(tokenWaitJob.inPipe, &tok, 1);
2944 if (count == 0)
2945 Fatal("eof on job pipe!");
2946 if (count < 0 && jobTokensRunning != 0) {
2947 if (errno != EAGAIN) {
2948 Fatal("job pipe read: %s", strerror(errno));
2950 if (DEBUG(JOB))
2951 fprintf(debug_file, "(%d) blocked for token\n", getpid());
2952 wantToken = 1;
2953 return FALSE;
2956 if (count == 1 && tok != '+') {
2957 /* make being abvorted - remove any other job tokens */
2958 if (DEBUG(JOB))
2959 fprintf(debug_file, "(%d) aborted by token %c\n", getpid(), tok);
2960 while (read(tokenWaitJob.inPipe, &tok1, 1) == 1)
2961 continue;
2962 /* And put the stopper back */
2963 while (write(tokenWaitJob.outPipe, &tok, 1) == -1 && errno == EAGAIN)
2964 continue;
2965 Fatal("A failure has been detected in another branch of the parallel make");
2968 if (count == 1 && jobTokensRunning == 0)
2969 /* We didn't want the token really */
2970 while (write(tokenWaitJob.outPipe, &tok, 1) == -1 && errno == EAGAIN)
2971 continue;
2973 jobTokensRunning++;
2974 if (DEBUG(JOB))
2975 fprintf(debug_file, "(%d) withdrew token\n", getpid());
2976 return TRUE;
2980 *-----------------------------------------------------------------------
2981 * Job_RunTarget --
2982 * Run the named target if found. If a filename is specified, then
2983 * set that to the sources.
2985 * Results:
2986 * None
2988 * Side Effects:
2989 * exits if the target fails.
2991 *-----------------------------------------------------------------------
2993 Boolean
2994 Job_RunTarget(const char *target, const char *fname) {
2995 GNode *gn = Targ_FindNode(target, TARG_NOCREATE);
2997 if (gn == NULL)
2998 return FALSE;
3000 if (fname)
3001 Var_Set(ALLSRC, fname, gn, 0);
3003 JobRun(gn);
3004 if (gn->made == ERROR) {
3005 PrintOnError(gn, "\n\nStop.");
3006 exit(1);
3008 return TRUE;
3011 #ifdef USE_SELECT
3013 emul_poll(struct pollfd *fd, int nfd, int timeout)
3015 fd_set rfds, wfds;
3016 int i, maxfd, nselect, npoll;
3017 struct timeval tv, *tvp;
3018 long usecs;
3020 FD_ZERO(&rfds);
3021 FD_ZERO(&wfds);
3023 maxfd = -1;
3024 for (i = 0; i < nfd; i++) {
3025 fd[i].revents = 0;
3027 if (fd[i].events & POLLIN)
3028 FD_SET(fd[i].fd, &rfds);
3030 if (fd[i].events & POLLOUT)
3031 FD_SET(fd[i].fd, &wfds);
3033 if (fd[i].fd > maxfd)
3034 maxfd = fd[i].fd;
3037 if (maxfd >= FD_SETSIZE) {
3038 Punt("Ran out of fd_set slots; "
3039 "recompile with a larger FD_SETSIZE.");
3042 if (timeout < 0) {
3043 tvp = NULL;
3044 } else {
3045 usecs = timeout * 1000;
3046 tv.tv_sec = usecs / 1000000;
3047 tv.tv_usec = usecs % 1000000;
3048 tvp = &tv;
3051 nselect = select(maxfd + 1, &rfds, &wfds, 0, tvp);
3053 if (nselect <= 0)
3054 return nselect;
3056 npoll = 0;
3057 for (i = 0; i < nfd; i++) {
3058 if (FD_ISSET(fd[i].fd, &rfds))
3059 fd[i].revents |= POLLIN;
3061 if (FD_ISSET(fd[i].fd, &wfds))
3062 fd[i].revents |= POLLOUT;
3064 if (fd[i].revents)
3065 npoll++;
3068 return npoll;
3070 #endif /* USE_SELECT */