]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - contrib/bmake/job.c
Merge ACPICA 20130418.
[FreeBSD/FreeBSD.git] / contrib / bmake / job.c
1 /*      $NetBSD: job.c,v 1.172 2013/03/05 22:01:43 christos Exp $       */
2
3 /*
4  * Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Adam de Boor.
9  *
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.
21  *
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.
33  */
34
35 /*
36  * Copyright (c) 1988, 1989 by Adam de Boor
37  * Copyright (c) 1989 by Berkeley Softworks
38  * All rights reserved.
39  *
40  * This code is derived from software contributed to Berkeley by
41  * Adam de Boor.
42  *
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.
58  *
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.
70  */
71
72 #ifndef MAKE_NATIVE
73 static char rcsid[] = "$NetBSD: job.c,v 1.172 2013/03/05 22:01:43 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.172 2013/03/05 22:01:43 christos Exp $");
81 #endif
82 #endif /* not lint */
83 #endif
84
85 /*-
86  * job.c --
87  *      handle the creation etc. of our child processes.
88  *
89  * Interface:
90  *      Job_Make                Start the creation of the given target.
91  *
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.
97  *
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.
104  *
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.
110  *
111  *      Job_End                 Cleanup any memory used.
112  *
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.
116  *
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.
122  *
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.
127  *
128  *      Job_CheckCommands       Verify that the commands for a target are
129  *                              ok. Provide them if necessary and possible.
130  *
131  *      Job_Touch               Update a target without really updating it.
132  *
133  *      Job_Wait                Wait for all currently-running jobs to finish.
134  */
135
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"
144
145 #include <assert.h>
146 #include <errno.h>
147 #include <fcntl.h>
148 #if !defined(USE_SELECT) && defined(HAVE_POLL_H)
149 #include <poll.h>
150 #else
151 #ifndef USE_SELECT                      /* no poll.h */
152 # define USE_SELECT
153 #endif
154 #if defined(HAVE_SYS_SELECT_H)
155 # include <sys/select.h>
156 #endif
157 #endif
158 #include <signal.h>
159 #include <stdio.h>
160 #include <string.h>
161 #include <utime.h>
162 #if defined(HAVE_SYS_SOCKET_H)
163 # include <sys/socket.h>
164 #endif
165
166 #include "make.h"
167 #include "hash.h"
168 #include "dir.h"
169 #include "job.h"
170 #include "pathnames.h"
171 #include "trace.h"
172 # define STATIC static
173
174 /*
175  * error handling variables
176  */
177 static int      errors = 0;         /* number of errors reported */
178 static int      aborting = 0;       /* why is the make aborting? */
179 #define ABORT_ERROR     1           /* Because of an error */
180 #define ABORT_INTERRUPT 2           /* Because it was interrupted */
181 #define ABORT_WAIT      3           /* Waiting for jobs to finish */
182 #define JOB_TOKENS      "+EI+"      /* Token to requeue for each abort state */
183
184 /*
185  * this tracks the number of tokens currently "out" to build jobs.
186  */
187 int jobTokensRunning = 0;
188 int not_parallel = 0;               /* set if .NOT_PARALLEL */
189
190 /*
191  * XXX: Avoid SunOS bug... FILENO() is fp->_file, and file
192  * is a char! So when we go above 127 we turn negative!
193  */
194 #define FILENO(a) ((unsigned) fileno(a))
195
196 /*
197  * post-make command processing. The node postCommands is really just the
198  * .END target but we keep it around to avoid having to search for it
199  * all the time.
200  */
201 static GNode      *postCommands = NULL;
202                                     /* node containing commands to execute when
203                                      * everything else is done */
204 static int        numCommands;      /* The number of commands actually printed
205                                      * for a target. Should this number be
206                                      * 0, no shell will be executed. */
207
208 /*
209  * Return values from JobStart.
210  */
211 #define JOB_RUNNING     0       /* Job is running */
212 #define JOB_ERROR       1       /* Error in starting the job */
213 #define JOB_FINISHED    2       /* The job is already finished */
214
215 /*
216  * Descriptions for various shells.
217  *
218  * The build environment may set DEFSHELL_INDEX to one of
219  * DEFSHELL_INDEX_SH, DEFSHELL_INDEX_KSH, or DEFSHELL_INDEX_CSH, to
220  * select one of the prefedined shells as the default shell.
221  *
222  * Alternatively, the build environment may set DEFSHELL_CUSTOM to the
223  * name or the full path of a sh-compatible shell, which will be used as
224  * the default shell.
225  *
226  * ".SHELL" lines in Makefiles can choose the default shell from the
227  # set defined here, or add additional shells.
228  */
229
230 #ifdef DEFSHELL_CUSTOM
231 #define DEFSHELL_INDEX_CUSTOM 0
232 #define DEFSHELL_INDEX_SH     1
233 #define DEFSHELL_INDEX_KSH    2
234 #define DEFSHELL_INDEX_CSH    3
235 #else /* !DEFSHELL_CUSTOM */
236 #define DEFSHELL_INDEX_SH     0
237 #define DEFSHELL_INDEX_KSH    1
238 #define DEFSHELL_INDEX_CSH    2
239 #endif /* !DEFSHELL_CUSTOM */
240
241 #ifndef DEFSHELL_INDEX
242 #define DEFSHELL_INDEX 0        /* DEFSHELL_INDEX_CUSTOM or DEFSHELL_INDEX_SH */
243 #endif /* !DEFSHELL_INDEX */
244
245 static Shell    shells[] = {
246 #ifdef DEFSHELL_CUSTOM
247     /*
248      * An sh-compatible shell with a non-standard name.
249      *
250      * Keep this in sync with the "sh" description below, but avoid
251      * non-portable features that might not be supplied by all
252      * sh-compatible shells.
253      */
254 {
255     DEFSHELL_CUSTOM,
256     FALSE, "", "", "", 0,
257     FALSE, "echo \"%s\"\n", "%s\n", "{ %s \n} || exit $?\n", "'\n'", '#',
258     "",
259     "",
260 },
261 #endif /* DEFSHELL_CUSTOM */
262     /*
263      * SH description. Echo control is also possible and, under
264      * sun UNIX anyway, one can even control error checking.
265      */
266 {
267     "sh",
268     FALSE, "", "", "", 0,
269     FALSE, "echo \"%s\"\n", "%s\n", "{ %s \n} || exit $?\n", "'\n'", '#',
270 #if defined(MAKE_NATIVE) && defined(__NetBSD__)
271     "q",
272 #else
273     "",
274 #endif
275     "",
276 },
277     /*
278      * KSH description. 
279      */
280 {
281     "ksh",
282     TRUE, "set +v", "set -v", "set +v", 6,
283     FALSE, "echo \"%s\"\n", "%s\n", "{ %s \n} || exit $?\n", "'\n'", '#',
284     "v",
285     "",
286 },
287     /*
288      * CSH description. The csh can do echo control by playing
289      * with the setting of the 'echo' shell variable. Sadly,
290      * however, it is unable to do error control nicely.
291      */
292 {
293     "csh",
294     TRUE, "unset verbose", "set verbose", "unset verbose", 10,
295     FALSE, "echo \"%s\"\n", "csh -c \"%s || exit 0\"\n", "", "'\\\n'", '#',
296     "v", "e",
297 },
298     /*
299      * UNKNOWN.
300      */
301 {
302     NULL,
303     FALSE, NULL, NULL, NULL, 0,
304     FALSE, NULL, NULL, NULL, NULL, 0,
305     NULL, NULL,
306 }
307 };
308 static Shell *commandShell = &shells[DEFSHELL_INDEX]; /* this is the shell to
309                                                    * which we pass all
310                                                    * commands in the Makefile.
311                                                    * It is set by the
312                                                    * Job_ParseShell function */
313 const char *shellPath = NULL,                     /* full pathname of
314                                                    * executable image */
315            *shellName = NULL;                     /* last component of shell */
316 static const char *shellArgv = NULL;              /* Custom shell args */
317
318
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) */
324
325 /*
326  * Set of descriptors of pipes connected to
327  * the output channels of children
328  */
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 *);
335
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 */
340
341 static Job childExitJob;        /* child exit pseudo-job */
342 #define CHILD_EXIT      "."
343 #define DO_JOB_RESUME   "R"
344
345 #define TARG_FMT  "%s %s ---\n" /* Default format */
346 #define MESSAGE(fp, gn) \
347         if (maxJobs != 1) \
348             (void)fprintf(fp, TARG_FMT, targPrefix, gn->name)
349
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
356
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);
375
376 const char *malloc_options="A";
377
378 static void
379 job_table_dump(const char *where)
380 {
381     Job *job;
382
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);
387     }
388 }
389
390 /*
391  * JobSigLock/JobSigUnlock
392  *
393  * Signal lock routines to get exclusive access. Currently used to
394  * protect `jobs' and `stoppedJobs' list manipulations.
395  */
396 static void JobSigLock(sigset_t *omaskp)
397 {
398         if (sigprocmask(SIG_BLOCK, &caught_signals, omaskp) != 0) {
399                 Punt("JobSigLock: sigprocmask: %s", strerror(errno));
400                 sigemptyset(omaskp);
401         }
402 }
403
404 static void JobSigUnlock(sigset_t *omaskp)
405 {
406         (void)sigprocmask(SIG_SETMASK, omaskp, NULL);
407 }
408
409 static void
410 JobCreatePipe(Job *job, int minfd)
411 {
412     int i, fd;
413
414     if (pipe(job->jobPipe) == -1)
415         Punt("Cannot create pipe: %s", strerror(errno));
416
417     /* Set close-on-exec flag for both */
418     (void)fcntl(job->jobPipe[0], F_SETFD, 1);
419     (void)fcntl(job->jobPipe[1], F_SETFD, 1);
420
421     /*
422      * We mark the input side of the pipe non-blocking; we poll(2) the
423      * pipe when we're waiting for a job token, but we might lose the
424      * race for the token when a new one becomes available, so the read 
425      * from the pipe should not block.
426      */
427     fcntl(job->jobPipe[0], F_SETFL, 
428         fcntl(job->jobPipe[0], F_GETFL, 0) | O_NONBLOCK);
429
430     for (i = 0; i < 2; i++) {
431        /* Avoid using low numbered fds */
432        fd = fcntl(job->jobPipe[i], F_DUPFD, minfd);
433        if (fd != -1) {
434            close(job->jobPipe[i]);
435            job->jobPipe[i] = fd;
436        }
437     }
438 }
439
440 /*-
441  *-----------------------------------------------------------------------
442  * JobCondPassSig --
443  *      Pass a signal to a job
444  *
445  * Input:
446  *      signop          Signal to send it
447  *
448  * Side Effects:
449  *      None, except the job may bite it.
450  *
451  *-----------------------------------------------------------------------
452  */
453 static void
454 JobCondPassSig(int signo)
455 {
456     Job *job;
457
458     if (DEBUG(JOB)) {
459         (void)fprintf(debug_file, "JobCondPassSig(%d) called.\n", signo);
460     }
461
462     for (job = job_table; job < job_table_end; job++) {
463         if (job->job_state != JOB_ST_RUNNING)
464             continue;
465         if (DEBUG(JOB)) {
466             (void)fprintf(debug_file,
467                            "JobCondPassSig passing signal %d to child %d.\n",
468                            signo, job->pid);
469         }
470         KILLPG(job->pid, signo);
471     }
472 }
473
474 /*-
475  *-----------------------------------------------------------------------
476  * JobChldSig --
477  *      SIGCHLD handler.
478  *
479  * Input:
480  *      signo           The signal number we've received
481  *
482  * Results:
483  *      None.
484  *
485  * Side Effects:
486  *      Sends a token on the child exit pipe to wake us up from
487  *      select()/poll().
488  *
489  *-----------------------------------------------------------------------
490  */
491 static void
492 JobChildSig(int signo MAKE_ATTR_UNUSED)
493 {
494     while (write(childExitJob.outPipe, CHILD_EXIT, 1) == -1 && errno == EAGAIN)
495         continue;
496 }
497
498
499 /*-
500  *-----------------------------------------------------------------------
501  * JobContinueSig --
502  *      Resume all stopped jobs.
503  *
504  * Input:
505  *      signo           The signal number we've received
506  *
507  * Results:
508  *      None.
509  *
510  * Side Effects:
511  *      Jobs start running again.
512  *
513  *-----------------------------------------------------------------------
514  */
515 static void
516 JobContinueSig(int signo MAKE_ATTR_UNUSED)
517 {
518     /*
519      * Defer sending to SIGCONT to our stopped children until we return
520      * from the signal handler.
521      */
522     while (write(childExitJob.outPipe, DO_JOB_RESUME, 1) == -1 &&
523         errno == EAGAIN)
524         continue;
525 }
526
527 /*-
528  *-----------------------------------------------------------------------
529  * JobPassSig --
530  *      Pass a signal on to all jobs, then resend to ourselves.
531  *
532  * Input:
533  *      signo           The signal number we've received
534  *
535  * Results:
536  *      None.
537  *
538  * Side Effects:
539  *      We die by the same signal.
540  *
541  *-----------------------------------------------------------------------
542  */
543 MAKE_ATTR_DEAD static void
544 JobPassSig_int(int signo)
545 {
546     /* Run .INTERRUPT target then exit */
547     JobInterrupt(TRUE, signo);
548 }
549
550 MAKE_ATTR_DEAD static void
551 JobPassSig_term(int signo)
552 {
553     /* Dont run .INTERRUPT target then exit */
554     JobInterrupt(FALSE, signo);
555 }
556
557 static void
558 JobPassSig_suspend(int signo)
559 {
560     sigset_t nmask, omask;
561     struct sigaction act;
562
563     /* Suppress job started/continued messages */
564     make_suspended = 1;
565
566     /* Pass the signal onto every job */
567     JobCondPassSig(signo);
568
569     /*
570      * Send ourselves the signal now we've given the message to everyone else.
571      * Note we block everything else possible while we're getting the signal.
572      * This ensures that all our jobs get continued when we wake up before
573      * we take any other signal.
574      */
575     sigfillset(&nmask);
576     sigdelset(&nmask, signo);
577     (void)sigprocmask(SIG_SETMASK, &nmask, &omask);
578
579     act.sa_handler = SIG_DFL;
580     sigemptyset(&act.sa_mask);
581     act.sa_flags = 0;
582     (void)sigaction(signo, &act, NULL);
583
584     if (DEBUG(JOB)) {
585         (void)fprintf(debug_file,
586                        "JobPassSig passing signal %d to self.\n", signo);
587     }
588
589     (void)kill(getpid(), signo);
590
591     /*
592      * We've been continued.
593      *
594      * A whole host of signals continue to happen!
595      * SIGCHLD for any processes that actually suspended themselves.
596      * SIGCHLD for any processes that exited while we were alseep.
597      * The SIGCONT that actually caused us to wakeup.
598      *
599      * Since we defer passing the SIGCONT on to our children until
600      * the main processing loop, we can be sure that all the SIGCHLD
601      * events will have happened by then - and that the waitpid() will
602      * collect the child 'suspended' events.
603      * For correct sequencing we just need to ensure we process the
604      * waitpid() before passign on the SIGCONT.
605      *
606      * In any case nothing else is needed here.
607      */
608
609     /* Restore handler and signal mask */
610     act.sa_handler = JobPassSig_suspend;
611     (void)sigaction(signo, &act, NULL);
612     (void)sigprocmask(SIG_SETMASK, &omask, NULL);
613 }
614
615 /*-
616  *-----------------------------------------------------------------------
617  * JobFindPid  --
618  *      Compare the pid of the job with the given pid and return 0 if they
619  *      are equal. This function is called from Job_CatchChildren
620  *      to find the job descriptor of the finished job.
621  *
622  * Input:
623  *      job             job to examine
624  *      pid             process id desired
625  *
626  * Results:
627  *      Job with matching pid
628  *
629  * Side Effects:
630  *      None
631  *-----------------------------------------------------------------------
632  */
633 static Job *
634 JobFindPid(int pid, int status, Boolean isJobs)
635 {
636     Job *job;
637
638     for (job = job_table; job < job_table_end; job++) {
639         if ((job->job_state == status) && job->pid == pid)
640             return job;
641     }
642     if (DEBUG(JOB) && isJobs)
643         job_table_dump("no pid");
644     return NULL;
645 }
646
647 /*-
648  *-----------------------------------------------------------------------
649  * JobPrintCommand  --
650  *      Put out another command for the given job. If the command starts
651  *      with an @ or a - we process it specially. In the former case,
652  *      so long as the -s and -n flags weren't given to make, we stick
653  *      a shell-specific echoOff command in the script. In the latter,
654  *      we ignore errors for the entire job, unless the shell has error
655  *      control.
656  *      If the command is just "..." we take all future commands for this
657  *      job to be commands to be executed once the entire graph has been
658  *      made and return non-zero to signal that the end of the commands
659  *      was reached. These commands are later attached to the postCommands
660  *      node and executed by Job_End when all things are done.
661  *      This function is called from JobStart via Lst_ForEach.
662  *
663  * Input:
664  *      cmdp            command string to print
665  *      jobp            job for which to print it
666  *
667  * Results:
668  *      Always 0, unless the command was "..."
669  *
670  * Side Effects:
671  *      If the command begins with a '-' and the shell has no error control,
672  *      the JOB_IGNERR flag is set in the job descriptor.
673  *      If the command is "..." and we're not ignoring such things,
674  *      tailCmds is set to the successor node of the cmd.
675  *      numCommands is incremented if the command is actually printed.
676  *-----------------------------------------------------------------------
677  */
678 static int
679 JobPrintCommand(void *cmdp, void *jobp)
680 {
681     Boolean       noSpecials;       /* true if we shouldn't worry about
682                                      * inserting special commands into
683                                      * the input stream. */
684     Boolean       shutUp = FALSE;   /* true if we put a no echo command
685                                      * into the command file */
686     Boolean       errOff = FALSE;   /* true if we turned error checking
687                                      * off before printing the command
688                                      * and need to turn it back on */
689     const char    *cmdTemplate;     /* Template to use when printing the
690                                      * command */
691     char          *cmdStart;        /* Start of expanded command */
692     char          *escCmd = NULL;    /* Command with quotes/backticks escaped */
693     char          *cmd = (char *)cmdp;
694     Job           *job = (Job *)jobp;
695     int           i, j;
696
697     noSpecials = NoExecute(job->node);
698
699     if (strcmp(cmd, "...") == 0) {
700         job->node->type |= OP_SAVE_CMDS;
701         if ((job->flags & JOB_IGNDOTS) == 0) {
702             job->tailCmds = Lst_Succ(Lst_Member(job->node->commands,
703                                                 cmd));
704             return 1;
705         }
706         return 0;
707     }
708
709 #define DBPRINTF(fmt, arg) if (DEBUG(JOB)) {    \
710         (void)fprintf(debug_file, fmt, arg);    \
711     }                                           \
712    (void)fprintf(job->cmdFILE, fmt, arg);       \
713    (void)fflush(job->cmdFILE);
714
715     numCommands += 1;
716
717     cmdStart = cmd = Var_Subst(NULL, cmd, job->node, FALSE);
718
719     cmdTemplate = "%s\n";
720
721     /*
722      * Check for leading @' and -'s to control echoing and error checking.
723      */
724     while (*cmd == '@' || *cmd == '-' || (*cmd == '+')) {
725         switch (*cmd) {
726         case '@':
727             shutUp = DEBUG(LOUD) ? FALSE : TRUE;
728             break;
729         case '-':
730             job->flags |= JOB_IGNERR;
731             errOff = TRUE;
732             break;
733         case '+':
734             if (noSpecials) {
735                 /*
736                  * We're not actually executing anything...
737                  * but this one needs to be - use compat mode just for it.
738                  */
739                 CompatRunCommand(cmdp, job->node);
740                 return 0;
741             }
742             break;
743         }
744         cmd++;
745     }
746
747     while (isspace((unsigned char) *cmd))
748         cmd++;
749
750     /*
751      * If the shell doesn't have error control the alternate echo'ing will
752      * be done (to avoid showing additional error checking code) 
753      * and this will need the characters '$ ` \ "' escaped
754      */
755
756     if (!commandShell->hasErrCtl) {
757         /* Worst that could happen is every char needs escaping. */
758         escCmd = bmake_malloc((strlen(cmd) * 2) + 1);
759         for (i = 0, j= 0; cmd[i] != '\0'; i++, j++) {
760                 if (cmd[i] == '$' || cmd[i] == '`' || cmd[i] == '\\' || 
761                         cmd[i] == '"')
762                         escCmd[j++] = '\\';
763                 escCmd[j] = cmd[i];     
764         }
765         escCmd[j] = 0;
766     }
767
768     if (shutUp) {
769         if (!(job->flags & JOB_SILENT) && !noSpecials &&
770             commandShell->hasEchoCtl) {
771                 DBPRINTF("%s\n", commandShell->echoOff);
772         } else {
773             if (commandShell->hasErrCtl)
774                 shutUp = FALSE;
775         }
776     }
777
778     if (errOff) {
779         if (!noSpecials) {
780             if (commandShell->hasErrCtl) {
781                 /*
782                  * we don't want the error-control commands showing
783                  * up either, so we turn off echoing while executing
784                  * them. We could put another field in the shell
785                  * structure to tell JobDoOutput to look for this
786                  * string too, but why make it any more complex than
787                  * it already is?
788                  */
789                 if (!(job->flags & JOB_SILENT) && !shutUp &&
790                     commandShell->hasEchoCtl) {
791                         DBPRINTF("%s\n", commandShell->echoOff);
792                         DBPRINTF("%s\n", commandShell->ignErr);
793                         DBPRINTF("%s\n", commandShell->echoOn);
794                 } else {
795                         DBPRINTF("%s\n", commandShell->ignErr);
796                 }
797             } else if (commandShell->ignErr &&
798                       (*commandShell->ignErr != '\0'))
799             {
800                 /*
801                  * The shell has no error control, so we need to be
802                  * weird to get it to ignore any errors from the command.
803                  * If echoing is turned on, we turn it off and use the
804                  * errCheck template to echo the command. Leave echoing
805                  * off so the user doesn't see the weirdness we go through
806                  * to ignore errors. Set cmdTemplate to use the weirdness
807                  * instead of the simple "%s\n" template.
808                  */
809                 if (!(job->flags & JOB_SILENT) && !shutUp) {
810                         if (commandShell->hasEchoCtl) {
811                                 DBPRINTF("%s\n", commandShell->echoOff);
812                         }
813                         DBPRINTF(commandShell->errCheck, escCmd);
814                         shutUp = TRUE;
815                 } else {
816                         if (!shutUp) {
817                                 DBPRINTF(commandShell->errCheck, escCmd);
818                         }
819                 }
820                 cmdTemplate = commandShell->ignErr;
821                 /*
822                  * The error ignoration (hee hee) is already taken care
823                  * of by the ignErr template, so pretend error checking
824                  * is still on.
825                  */
826                 errOff = FALSE;
827             } else {
828                 errOff = FALSE;
829             }
830         } else {
831             errOff = FALSE;
832         }
833     } else {
834
835         /* 
836          * If errors are being checked and the shell doesn't have error control
837          * but does supply an errOut template, then setup commands to run
838          * through it.
839          */
840
841         if (!commandShell->hasErrCtl && commandShell->errOut && 
842             (*commandShell->errOut != '\0')) {
843                 if (!(job->flags & JOB_SILENT) && !shutUp) {
844                         if (commandShell->hasEchoCtl) {
845                                 DBPRINTF("%s\n", commandShell->echoOff);
846                         }
847                         DBPRINTF(commandShell->errCheck, escCmd);
848                         shutUp = TRUE;
849                 }
850                 /* If it's a comment line or blank, treat as an ignored error */
851                 if ((escCmd[0] == commandShell->commentChar) ||
852                     (escCmd[0] == 0))
853                         cmdTemplate = commandShell->ignErr;
854                 else
855                         cmdTemplate = commandShell->errOut;
856                 errOff = FALSE;
857         }
858     }
859
860     if (DEBUG(SHELL) && strcmp(shellName, "sh") == 0 &&
861         (job->flags & JOB_TRACED) == 0) {
862             DBPRINTF("set -%s\n", "x");
863             job->flags |= JOB_TRACED;
864     }
865     
866     DBPRINTF(cmdTemplate, cmd);
867     free(cmdStart);
868     if (escCmd)
869         free(escCmd);
870     if (errOff) {
871         /*
872          * If echoing is already off, there's no point in issuing the
873          * echoOff command. Otherwise we issue it and pretend it was on
874          * for the whole command...
875          */
876         if (!shutUp && !(job->flags & JOB_SILENT) && commandShell->hasEchoCtl){
877             DBPRINTF("%s\n", commandShell->echoOff);
878             shutUp = TRUE;
879         }
880         DBPRINTF("%s\n", commandShell->errCheck);
881     }
882     if (shutUp && commandShell->hasEchoCtl) {
883         DBPRINTF("%s\n", commandShell->echoOn);
884     }
885     return 0;
886 }
887
888 /*-
889  *-----------------------------------------------------------------------
890  * JobSaveCommand --
891  *      Save a command to be executed when everything else is done.
892  *      Callback function for JobFinish...
893  *
894  * Results:
895  *      Always returns 0
896  *
897  * Side Effects:
898  *      The command is tacked onto the end of postCommands's commands list.
899  *
900  *-----------------------------------------------------------------------
901  */
902 static int
903 JobSaveCommand(void *cmd, void *gn)
904 {
905     cmd = Var_Subst(NULL, (char *)cmd, (GNode *)gn, FALSE);
906     (void)Lst_AtEnd(postCommands->commands, cmd);
907     return(0);
908 }
909
910
911 /*-
912  *-----------------------------------------------------------------------
913  * JobClose --
914  *      Called to close both input and output pipes when a job is finished.
915  *
916  * Results:
917  *      Nada
918  *
919  * Side Effects:
920  *      The file descriptors associated with the job are closed.
921  *
922  *-----------------------------------------------------------------------
923  */
924 static void
925 JobClose(Job *job)
926 {
927     clearfd(job);
928     (void)close(job->outPipe);
929     job->outPipe = -1;
930
931     JobDoOutput(job, TRUE);
932     (void)close(job->inPipe);
933     job->inPipe = -1;
934 }
935
936 /*-
937  *-----------------------------------------------------------------------
938  * JobFinish  --
939  *      Do final processing for the given job including updating
940  *      parents and starting new jobs as available/necessary. Note
941  *      that we pay no attention to the JOB_IGNERR flag here.
942  *      This is because when we're called because of a noexecute flag
943  *      or something, jstat.w_status is 0 and when called from
944  *      Job_CatchChildren, the status is zeroed if it s/b ignored.
945  *
946  * Input:
947  *      job             job to finish
948  *      status          sub-why job went away
949  *
950  * Results:
951  *      None
952  *
953  * Side Effects:
954  *      Final commands for the job are placed on postCommands.
955  *
956  *      If we got an error and are aborting (aborting == ABORT_ERROR) and
957  *      the job list is now empty, we are done for the day.
958  *      If we recognized an error (errors !=0), we set the aborting flag
959  *      to ABORT_ERROR so no more jobs will be started.
960  *-----------------------------------------------------------------------
961  */
962 /*ARGSUSED*/
963 static void
964 JobFinish (Job *job, WAIT_T status)
965 {
966     Boolean      done, return_job_token;
967
968     if (DEBUG(JOB)) {
969         fprintf(debug_file, "Jobfinish: %d [%s], status %d\n",
970                                 job->pid, job->node->name, status);
971     }
972
973     if ((WIFEXITED(status) &&
974          (((WEXITSTATUS(status) != 0) && !(job->flags & JOB_IGNERR)))) ||
975         WIFSIGNALED(status))
976     {
977         /*
978          * If it exited non-zero and either we're doing things our
979          * way or we're not ignoring errors, the job is finished.
980          * Similarly, if the shell died because of a signal
981          * the job is also finished. In these
982          * cases, finish out the job's output before printing the exit
983          * status...
984          */
985         JobClose(job);
986         if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
987            (void)fclose(job->cmdFILE);
988            job->cmdFILE = NULL;
989         }
990         done = TRUE;
991     } else if (WIFEXITED(status)) {
992         /*
993          * Deal with ignored errors in -B mode. We need to print a message
994          * telling of the ignored error as well as setting status.w_status
995          * to 0 so the next command gets run. To do this, we set done to be
996          * TRUE if in -B mode and the job exited non-zero.
997          */
998         done = WEXITSTATUS(status) != 0;
999         /*
1000          * Old comment said: "Note we don't
1001          * want to close down any of the streams until we know we're at the
1002          * end."
1003          * But we do. Otherwise when are we going to print the rest of the
1004          * stuff?
1005          */
1006         JobClose(job);
1007     } else {
1008         /*
1009          * No need to close things down or anything.
1010          */
1011         done = FALSE;
1012     }
1013
1014     if (done) {
1015         if (WIFEXITED(status)) {
1016             if (DEBUG(JOB)) {
1017                 (void)fprintf(debug_file, "Process %d [%s] exited.\n",
1018                                 job->pid, job->node->name);
1019             }
1020             if (WEXITSTATUS(status) != 0) {
1021                 if (job->node != lastNode) {
1022                     MESSAGE(stdout, job->node);
1023                     lastNode = job->node;
1024                 }
1025 #ifdef USE_META
1026                 if (useMeta) {
1027                     meta_job_error(job, job->node, job->flags, WEXITSTATUS(status));
1028                 }
1029 #endif
1030                 (void)printf("*** [%s] Error code %d%s\n",
1031                                 job->node->name,
1032                                WEXITSTATUS(status),
1033                                (job->flags & JOB_IGNERR) ? " (ignored)" : "");
1034                 if (job->flags & JOB_IGNERR) {
1035                     WAIT_STATUS(status) = 0;
1036                 } else {
1037                     PrintOnError(job->node, NULL);
1038                 }
1039             } else if (DEBUG(JOB)) {
1040                 if (job->node != lastNode) {
1041                     MESSAGE(stdout, job->node);
1042                     lastNode = job->node;
1043                 }
1044                 (void)printf("*** [%s] Completed successfully\n",
1045                                 job->node->name);
1046             }
1047         } else {
1048             if (job->node != lastNode) {
1049                 MESSAGE(stdout, job->node);
1050                 lastNode = job->node;
1051             }
1052             (void)printf("*** [%s] Signal %d\n",
1053                         job->node->name, WTERMSIG(status));
1054         }
1055         (void)fflush(stdout);
1056     }
1057
1058 #ifdef USE_META
1059     if (useMeta) {
1060         meta_job_finish(job);
1061     }
1062 #endif
1063     
1064     return_job_token = FALSE;
1065
1066     Trace_Log(JOBEND, job);
1067     if (!(job->flags & JOB_SPECIAL)) {
1068         if ((WAIT_STATUS(status) != 0) ||
1069                 (aborting == ABORT_ERROR) ||
1070                 (aborting == ABORT_INTERRUPT))
1071             return_job_token = TRUE;
1072     }
1073
1074     if ((aborting != ABORT_ERROR) && (aborting != ABORT_INTERRUPT) &&
1075         (WAIT_STATUS(status) == 0)) {
1076         /*
1077          * As long as we aren't aborting and the job didn't return a non-zero
1078          * status that we shouldn't ignore, we call Make_Update to update
1079          * the parents. In addition, any saved commands for the node are placed
1080          * on the .END target.
1081          */
1082         if (job->tailCmds != NULL) {
1083             Lst_ForEachFrom(job->node->commands, job->tailCmds,
1084                              JobSaveCommand,
1085                             job->node);
1086         }
1087         job->node->made = MADE;
1088         if (!(job->flags & JOB_SPECIAL))
1089             return_job_token = TRUE;
1090         Make_Update(job->node);
1091         job->job_state = JOB_ST_FREE;
1092     } else if (WAIT_STATUS(status)) {
1093         errors += 1;
1094         job->job_state = JOB_ST_FREE;
1095     }
1096
1097     /*
1098      * Set aborting if any error.
1099      */
1100     if (errors && !keepgoing && (aborting != ABORT_INTERRUPT)) {
1101         /*
1102          * If we found any errors in this batch of children and the -k flag
1103          * wasn't given, we set the aborting flag so no more jobs get
1104          * started.
1105          */
1106         aborting = ABORT_ERROR;
1107     }
1108
1109     if (return_job_token)
1110         Job_TokenReturn();
1111
1112     if (aborting == ABORT_ERROR && jobTokensRunning == 0) {
1113         /*
1114          * If we are aborting and the job table is now empty, we finish.
1115          */
1116         Finish(errors);
1117     }
1118 }
1119
1120 /*-
1121  *-----------------------------------------------------------------------
1122  * Job_Touch --
1123  *      Touch the given target. Called by JobStart when the -t flag was
1124  *      given
1125  *
1126  * Input:
1127  *      gn              the node of the file to touch
1128  *      silent          TRUE if should not print message
1129  *
1130  * Results:
1131  *      None
1132  *
1133  * Side Effects:
1134  *      The data modification of the file is changed. In addition, if the
1135  *      file did not exist, it is created.
1136  *-----------------------------------------------------------------------
1137  */
1138 void
1139 Job_Touch(GNode *gn, Boolean silent)
1140 {
1141     int           streamID;     /* ID of stream opened to do the touch */
1142     struct utimbuf times;       /* Times for utime() call */
1143
1144     if (gn->type & (OP_JOIN|OP_USE|OP_USEBEFORE|OP_EXEC|OP_OPTIONAL|
1145         OP_SPECIAL|OP_PHONY)) {
1146         /*
1147          * .JOIN, .USE, .ZEROTIME and .OPTIONAL targets are "virtual" targets
1148          * and, as such, shouldn't really be created.
1149          */
1150         return;
1151     }
1152
1153     if (!silent || NoExecute(gn)) {
1154         (void)fprintf(stdout, "touch %s\n", gn->name);
1155         (void)fflush(stdout);
1156     }
1157
1158     if (NoExecute(gn)) {
1159         return;
1160     }
1161
1162     if (gn->type & OP_ARCHV) {
1163         Arch_Touch(gn);
1164     } else if (gn->type & OP_LIB) {
1165         Arch_TouchLib(gn);
1166     } else {
1167         char    *file = gn->path ? gn->path : gn->name;
1168
1169         times.actime = times.modtime = now;
1170         if (utime(file, &times) < 0){
1171             streamID = open(file, O_RDWR | O_CREAT, 0666);
1172
1173             if (streamID >= 0) {
1174                 char    c;
1175
1176                 /*
1177                  * Read and write a byte to the file to change the
1178                  * modification time, then close the file.
1179                  */
1180                 if (read(streamID, &c, 1) == 1) {
1181                     (void)lseek(streamID, (off_t)0, SEEK_SET);
1182                     while (write(streamID, &c, 1) == -1 && errno == EAGAIN)
1183                         continue;
1184                 }
1185
1186                 (void)close(streamID);
1187             } else {
1188                 (void)fprintf(stdout, "*** couldn't touch %s: %s",
1189                                file, strerror(errno));
1190                 (void)fflush(stdout);
1191             }
1192         }
1193     }
1194 }
1195
1196 /*-
1197  *-----------------------------------------------------------------------
1198  * Job_CheckCommands --
1199  *      Make sure the given node has all the commands it needs.
1200  *
1201  * Input:
1202  *      gn              The target whose commands need verifying
1203  *      abortProc       Function to abort with message
1204  *
1205  * Results:
1206  *      TRUE if the commands list is/was ok.
1207  *
1208  * Side Effects:
1209  *      The node will have commands from the .DEFAULT rule added to it
1210  *      if it needs them.
1211  *-----------------------------------------------------------------------
1212  */
1213 Boolean
1214 Job_CheckCommands(GNode *gn, void (*abortProc)(const char *, ...))
1215 {
1216     if (OP_NOP(gn->type) && Lst_IsEmpty(gn->commands) &&
1217         ((gn->type & OP_LIB) == 0 || Lst_IsEmpty(gn->children))) {
1218         /*
1219          * No commands. Look for .DEFAULT rule from which we might infer
1220          * commands
1221          */
1222         if ((DEFAULT != NULL) && !Lst_IsEmpty(DEFAULT->commands) &&
1223                 (gn->type & OP_SPECIAL) == 0) {
1224             char *p1;
1225             /*
1226              * Make only looks for a .DEFAULT if the node was never the
1227              * target of an operator, so that's what we do too. If
1228              * a .DEFAULT was given, we substitute its commands for gn's
1229              * commands and set the IMPSRC variable to be the target's name
1230              * The DEFAULT node acts like a transformation rule, in that
1231              * gn also inherits any attributes or sources attached to
1232              * .DEFAULT itself.
1233              */
1234             Make_HandleUse(DEFAULT, gn);
1235             Var_Set(IMPSRC, Var_Value(TARGET, gn, &p1), gn, 0);
1236             if (p1)
1237                 free(p1);
1238         } else if (Dir_MTime(gn, 0) == 0 && (gn->type & OP_SPECIAL) == 0) {
1239             /*
1240              * The node wasn't the target of an operator we have no .DEFAULT
1241              * rule to go on and the target doesn't already exist. There's
1242              * nothing more we can do for this branch. If the -k flag wasn't
1243              * given, we stop in our tracks, otherwise we just don't update
1244              * this node's parents so they never get examined.
1245              */
1246             static const char msg[] = ": don't know how to make";
1247
1248             if (gn->flags & FROM_DEPEND) {
1249                 if (!Job_RunTarget(".STALE", gn->fname))
1250                     fprintf(stdout, "%s: %s, %d: ignoring stale %s for %s\n",
1251                         progname, gn->fname, gn->lineno, makeDependfile,
1252                         gn->name);
1253                 return TRUE;
1254             }
1255
1256             if (gn->type & OP_OPTIONAL) {
1257                 (void)fprintf(stdout, "%s%s %s (ignored)\n", progname,
1258                     msg, gn->name);
1259                 (void)fflush(stdout);
1260             } else if (keepgoing) {
1261                 (void)fprintf(stdout, "%s%s %s (continuing)\n", progname,
1262                     msg, gn->name);
1263                 (void)fflush(stdout);
1264                 return FALSE;
1265             } else {
1266                 (*abortProc)("%s%s %s. Stop", progname, msg, gn->name);
1267                 return FALSE;
1268             }
1269         }
1270     }
1271     return TRUE;
1272 }
1273
1274 /*-
1275  *-----------------------------------------------------------------------
1276  * JobExec --
1277  *      Execute the shell for the given job. Called from JobStart
1278  *
1279  * Input:
1280  *      job             Job to execute
1281  *
1282  * Results:
1283  *      None.
1284  *
1285  * Side Effects:
1286  *      A shell is executed, outputs is altered and the Job structure added
1287  *      to the job table.
1288  *
1289  *-----------------------------------------------------------------------
1290  */
1291 static void
1292 JobExec(Job *job, char **argv)
1293 {
1294     int           cpid;         /* ID of new child */
1295     sigset_t      mask;
1296
1297     job->flags &= ~JOB_TRACED;
1298
1299     if (DEBUG(JOB)) {
1300         int       i;
1301
1302         (void)fprintf(debug_file, "Running %s %sly\n", job->node->name, "local");
1303         (void)fprintf(debug_file, "\tCommand: ");
1304         for (i = 0; argv[i] != NULL; i++) {
1305             (void)fprintf(debug_file, "%s ", argv[i]);
1306         }
1307         (void)fprintf(debug_file, "\n");
1308     }
1309
1310     /*
1311      * Some jobs produce no output and it's disconcerting to have
1312      * no feedback of their running (since they produce no output, the
1313      * banner with their name in it never appears). This is an attempt to
1314      * provide that feedback, even if nothing follows it.
1315      */
1316     if ((lastNode != job->node) && !(job->flags & JOB_SILENT)) {
1317         MESSAGE(stdout, job->node);
1318         lastNode = job->node;
1319     }
1320
1321     /* No interruptions until this job is on the `jobs' list */
1322     JobSigLock(&mask);
1323
1324     /* Pre-emptively mark job running, pid still zero though */
1325     job->job_state = JOB_ST_RUNNING;
1326
1327     cpid = vFork();
1328     if (cpid == -1)
1329         Punt("Cannot vfork: %s", strerror(errno));
1330
1331     if (cpid == 0) {
1332         /* Child */
1333         sigset_t tmask;
1334
1335 #ifdef USE_META
1336         if (useMeta) {
1337             meta_job_child(job);
1338         }
1339 #endif
1340         /*
1341          * Reset all signal handlers; this is necessary because we also
1342          * need to unblock signals before we exec(2).
1343          */
1344         JobSigReset();
1345
1346         /* Now unblock signals */
1347         sigemptyset(&tmask);
1348         JobSigUnlock(&tmask);
1349
1350         /*
1351          * Must duplicate the input stream down to the child's input and
1352          * reset it to the beginning (again). Since the stream was marked
1353          * close-on-exec, we must clear that bit in the new input.
1354          */
1355         if (dup2(FILENO(job->cmdFILE), 0) == -1) {
1356             execError("dup2", "job->cmdFILE");
1357             _exit(1);
1358         }
1359         (void)fcntl(0, F_SETFD, 0);
1360         (void)lseek(0, (off_t)0, SEEK_SET);
1361
1362         if (job->node->type & OP_MAKE) {
1363                 /*
1364                  * Pass job token pipe to submakes.
1365                  */
1366                 fcntl(tokenWaitJob.inPipe, F_SETFD, 0);
1367                 fcntl(tokenWaitJob.outPipe, F_SETFD, 0);                
1368         }
1369         
1370         /*
1371          * Set up the child's output to be routed through the pipe
1372          * we've created for it.
1373          */
1374         if (dup2(job->outPipe, 1) == -1) {
1375             execError("dup2", "job->outPipe");
1376             _exit(1);
1377         }
1378         /*
1379          * The output channels are marked close on exec. This bit was
1380          * duplicated by the dup2(on some systems), so we have to clear
1381          * it before routing the shell's error output to the same place as
1382          * its standard output.
1383          */
1384         (void)fcntl(1, F_SETFD, 0);
1385         if (dup2(1, 2) == -1) {
1386             execError("dup2", "1, 2");
1387             _exit(1);
1388         }
1389
1390         /*
1391          * We want to switch the child into a different process family so
1392          * we can kill it and all its descendants in one fell swoop,
1393          * by killing its process family, but not commit suicide.
1394          */
1395 #if defined(HAVE_SETPGID)
1396         (void)setpgid(0, getpid());
1397 #else
1398 #if defined(HAVE_SETSID)
1399         /* XXX: dsl - I'm sure this should be setpgrp()... */
1400         (void)setsid();
1401 #else
1402         (void)setpgrp(0, getpid());
1403 #endif
1404 #endif
1405
1406         Var_ExportVars();
1407
1408         (void)execv(shellPath, argv);
1409         execError("exec", shellPath);
1410         _exit(1);
1411     }
1412
1413     /* Parent, continuing after the child exec */
1414     job->pid = cpid;
1415
1416     Trace_Log(JOBSTART, job);
1417
1418     /*
1419      * Set the current position in the buffer to the beginning
1420      * and mark another stream to watch in the outputs mask
1421      */
1422     job->curPos = 0;
1423
1424     watchfd(job);
1425
1426     if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
1427         (void)fclose(job->cmdFILE);
1428         job->cmdFILE = NULL;
1429     }
1430
1431     /*
1432      * Now the job is actually running, add it to the table.
1433      */
1434     if (DEBUG(JOB)) {
1435         fprintf(debug_file, "JobExec(%s): pid %d added to jobs table\n",
1436                 job->node->name, job->pid);
1437         job_table_dump("job started");
1438     }
1439     JobSigUnlock(&mask);
1440 }
1441
1442 /*-
1443  *-----------------------------------------------------------------------
1444  * JobMakeArgv --
1445  *      Create the argv needed to execute the shell for a given job.
1446  *
1447  *
1448  * Results:
1449  *
1450  * Side Effects:
1451  *
1452  *-----------------------------------------------------------------------
1453  */
1454 static void
1455 JobMakeArgv(Job *job, char **argv)
1456 {
1457     int           argc;
1458     static char args[10];       /* For merged arguments */
1459
1460     argv[0] = UNCONST(shellName);
1461     argc = 1;
1462
1463     if ((commandShell->exit && (*commandShell->exit != '-')) ||
1464         (commandShell->echo && (*commandShell->echo != '-')))
1465     {
1466         /*
1467          * At least one of the flags doesn't have a minus before it, so
1468          * merge them together. Have to do this because the *(&(@*#*&#$#
1469          * Bourne shell thinks its second argument is a file to source.
1470          * Grrrr. Note the ten-character limitation on the combined arguments.
1471          */
1472         (void)snprintf(args, sizeof(args), "-%s%s",
1473                       ((job->flags & JOB_IGNERR) ? "" :
1474                        (commandShell->exit ? commandShell->exit : "")),
1475                       ((job->flags & JOB_SILENT) ? "" :
1476                        (commandShell->echo ? commandShell->echo : "")));
1477
1478         if (args[1]) {
1479             argv[argc] = args;
1480             argc++;
1481         }
1482     } else {
1483         if (!(job->flags & JOB_IGNERR) && commandShell->exit) {
1484             argv[argc] = UNCONST(commandShell->exit);
1485             argc++;
1486         }
1487         if (!(job->flags & JOB_SILENT) && commandShell->echo) {
1488             argv[argc] = UNCONST(commandShell->echo);
1489             argc++;
1490         }
1491     }
1492     argv[argc] = NULL;
1493 }
1494
1495 /*-
1496  *-----------------------------------------------------------------------
1497  * JobStart  --
1498  *      Start a target-creation process going for the target described
1499  *      by the graph node gn.
1500  *
1501  * Input:
1502  *      gn              target to create
1503  *      flags           flags for the job to override normal ones.
1504  *                      e.g. JOB_SPECIAL or JOB_IGNDOTS
1505  *      previous        The previous Job structure for this node, if any.
1506  *
1507  * Results:
1508  *      JOB_ERROR if there was an error in the commands, JOB_FINISHED
1509  *      if there isn't actually anything left to do for the job and
1510  *      JOB_RUNNING if the job has been started.
1511  *
1512  * Side Effects:
1513  *      A new Job node is created and added to the list of running
1514  *      jobs. PMake is forked and a child shell created.
1515  *
1516  * NB: I'm fairly sure that this code is never called with JOB_SPECIAL set
1517  *     JOB_IGNDOTS is never set (dsl)
1518  *     Also the return value is ignored by everyone.
1519  *-----------------------------------------------------------------------
1520  */
1521 static int
1522 JobStart(GNode *gn, int flags)
1523 {
1524     Job           *job;       /* new job descriptor */
1525     char          *argv[10];  /* Argument vector to shell */
1526     Boolean       cmdsOK;     /* true if the nodes commands were all right */
1527     Boolean       noExec;     /* Set true if we decide not to run the job */
1528     int           tfd;        /* File descriptor to the temp file */
1529
1530     for (job = job_table; job < job_table_end; job++) {
1531         if (job->job_state == JOB_ST_FREE)
1532             break;
1533     }
1534     if (job >= job_table_end)
1535         Punt("JobStart no job slots vacant");
1536
1537     memset(job, 0, sizeof *job);
1538     job->job_state = JOB_ST_SETUP;
1539     if (gn->type & OP_SPECIAL)
1540         flags |= JOB_SPECIAL;
1541
1542     job->node = gn;
1543     job->tailCmds = NULL;
1544
1545     /*
1546      * Set the initial value of the flags for this job based on the global
1547      * ones and the node's attributes... Any flags supplied by the caller
1548      * are also added to the field.
1549      */
1550     job->flags = 0;
1551     if (Targ_Ignore(gn)) {
1552         job->flags |= JOB_IGNERR;
1553     }
1554     if (Targ_Silent(gn)) {
1555         job->flags |= JOB_SILENT;
1556     }
1557     job->flags |= flags;
1558
1559     /*
1560      * Check the commands now so any attributes from .DEFAULT have a chance
1561      * to migrate to the node
1562      */
1563     cmdsOK = Job_CheckCommands(gn, Error);
1564
1565     job->inPollfd = NULL;
1566     /*
1567      * If the -n flag wasn't given, we open up OUR (not the child's)
1568      * temporary file to stuff commands in it. The thing is rd/wr so we don't
1569      * need to reopen it to feed it to the shell. If the -n flag *was* given,
1570      * we just set the file to be stdout. Cute, huh?
1571      */
1572     if (((gn->type & OP_MAKE) && !(noRecursiveExecute)) ||
1573             (!noExecute && !touchFlag)) {
1574         /*
1575          * tfile is the name of a file into which all shell commands are
1576          * put. It is removed before the child shell is executed, unless
1577          * DEBUG(SCRIPT) is set.
1578          */
1579         char *tfile;
1580         sigset_t mask;
1581         /*
1582          * We're serious here, but if the commands were bogus, we're
1583          * also dead...
1584          */
1585         if (!cmdsOK) {
1586             PrintOnError(gn, NULL);     /* provide some clue */
1587             DieHorribly();
1588         }
1589
1590         JobSigLock(&mask);
1591         tfd = mkTempFile(TMPPAT, &tfile);
1592         if (!DEBUG(SCRIPT))
1593                 (void)eunlink(tfile);
1594         JobSigUnlock(&mask);
1595
1596         job->cmdFILE = fdopen(tfd, "w+");
1597         if (job->cmdFILE == NULL) {
1598             Punt("Could not fdopen %s", tfile);
1599         }
1600         (void)fcntl(FILENO(job->cmdFILE), F_SETFD, 1);
1601         /*
1602          * Send the commands to the command file, flush all its buffers then
1603          * rewind and remove the thing.
1604          */
1605         noExec = FALSE;
1606
1607 #ifdef USE_META
1608         if (useMeta) {
1609             meta_job_start(job, gn);
1610             if (Targ_Silent(gn)) {      /* might have changed */
1611                 job->flags |= JOB_SILENT;
1612             }
1613         }
1614 #endif
1615         /*
1616          * We can do all the commands at once. hooray for sanity
1617          */
1618         numCommands = 0;
1619         Lst_ForEach(gn->commands, JobPrintCommand, job);
1620
1621         /*
1622          * If we didn't print out any commands to the shell script,
1623          * there's not much point in executing the shell, is there?
1624          */
1625         if (numCommands == 0) {
1626             noExec = TRUE;
1627         }
1628
1629         free(tfile);
1630     } else if (NoExecute(gn)) {
1631         /*
1632          * Not executing anything -- just print all the commands to stdout
1633          * in one fell swoop. This will still set up job->tailCmds correctly.
1634          */
1635         if (lastNode != gn) {
1636             MESSAGE(stdout, gn);
1637             lastNode = gn;
1638         }
1639         job->cmdFILE = stdout;
1640         /*
1641          * Only print the commands if they're ok, but don't die if they're
1642          * not -- just let the user know they're bad and keep going. It
1643          * doesn't do any harm in this case and may do some good.
1644          */
1645         if (cmdsOK) {
1646             Lst_ForEach(gn->commands, JobPrintCommand, job);
1647         }
1648         /*
1649          * Don't execute the shell, thank you.
1650          */
1651         noExec = TRUE;
1652     } else {
1653         /*
1654          * Just touch the target and note that no shell should be executed.
1655          * Set cmdFILE to stdout to make life easier. Check the commands, too,
1656          * but don't die if they're no good -- it does no harm to keep working
1657          * up the graph.
1658          */
1659         job->cmdFILE = stdout;
1660         Job_Touch(gn, job->flags&JOB_SILENT);
1661         noExec = TRUE;
1662     }
1663     /* Just in case it isn't already... */
1664     (void)fflush(job->cmdFILE);
1665
1666     /*
1667      * If we're not supposed to execute a shell, don't.
1668      */
1669     if (noExec) {
1670         if (!(job->flags & JOB_SPECIAL))
1671             Job_TokenReturn();
1672         /*
1673          * Unlink and close the command file if we opened one
1674          */
1675         if (job->cmdFILE != stdout) {
1676             if (job->cmdFILE != NULL) {
1677                 (void)fclose(job->cmdFILE);
1678                 job->cmdFILE = NULL;
1679             }
1680         }
1681
1682         /*
1683          * We only want to work our way up the graph if we aren't here because
1684          * the commands for the job were no good.
1685          */
1686         if (cmdsOK && aborting == 0) {
1687             if (job->tailCmds != NULL) {
1688                 Lst_ForEachFrom(job->node->commands, job->tailCmds,
1689                                 JobSaveCommand,
1690                                job->node);
1691             }
1692             job->node->made = MADE;
1693             Make_Update(job->node);
1694         }
1695         job->job_state = JOB_ST_FREE;
1696         return cmdsOK ? JOB_FINISHED : JOB_ERROR;
1697     }
1698
1699     /*
1700      * Set up the control arguments to the shell. This is based on the flags
1701      * set earlier for this job.
1702      */
1703     JobMakeArgv(job, argv);
1704
1705     /* Create the pipe by which we'll get the shell's output.  */
1706     JobCreatePipe(job, 3);
1707
1708     JobExec(job, argv);
1709     return(JOB_RUNNING);
1710 }
1711
1712 static char *
1713 JobOutput(Job *job, char *cp, char *endp, int msg)
1714 {
1715     char *ecp;
1716
1717     if (commandShell->noPrint) {
1718         ecp = Str_FindSubstring(cp, commandShell->noPrint);
1719         while (ecp != NULL) {
1720             if (cp != ecp) {
1721                 *ecp = '\0';
1722                 if (!beSilent && msg && job->node != lastNode) {
1723                     MESSAGE(stdout, job->node);
1724                     lastNode = job->node;
1725                 }
1726                 /*
1727                  * The only way there wouldn't be a newline after
1728                  * this line is if it were the last in the buffer.
1729                  * however, since the non-printable comes after it,
1730                  * there must be a newline, so we don't print one.
1731                  */
1732                 (void)fprintf(stdout, "%s", cp);
1733                 (void)fflush(stdout);
1734             }
1735             cp = ecp + commandShell->noPLen;
1736             if (cp != endp) {
1737                 /*
1738                  * Still more to print, look again after skipping
1739                  * the whitespace following the non-printable
1740                  * command....
1741                  */
1742                 cp++;
1743                 while (*cp == ' ' || *cp == '\t' || *cp == '\n') {
1744                     cp++;
1745                 }
1746                 ecp = Str_FindSubstring(cp, commandShell->noPrint);
1747             } else {
1748                 return cp;
1749             }
1750         }
1751     }
1752     return cp;
1753 }
1754
1755 /*-
1756  *-----------------------------------------------------------------------
1757  * JobDoOutput  --
1758  *      This function is called at different times depending on
1759  *      whether the user has specified that output is to be collected
1760  *      via pipes or temporary files. In the former case, we are called
1761  *      whenever there is something to read on the pipe. We collect more
1762  *      output from the given job and store it in the job's outBuf. If
1763  *      this makes up a line, we print it tagged by the job's identifier,
1764  *      as necessary.
1765  *      If output has been collected in a temporary file, we open the
1766  *      file and read it line by line, transfering it to our own
1767  *      output channel until the file is empty. At which point we
1768  *      remove the temporary file.
1769  *      In both cases, however, we keep our figurative eye out for the
1770  *      'noPrint' line for the shell from which the output came. If
1771  *      we recognize a line, we don't print it. If the command is not
1772  *      alone on the line (the character after it is not \0 or \n), we
1773  *      do print whatever follows it.
1774  *
1775  * Input:
1776  *      job             the job whose output needs printing
1777  *      finish          TRUE if this is the last time we'll be called
1778  *                      for this job
1779  *
1780  * Results:
1781  *      None
1782  *
1783  * Side Effects:
1784  *      curPos may be shifted as may the contents of outBuf.
1785  *-----------------------------------------------------------------------
1786  */
1787 STATIC void
1788 JobDoOutput(Job *job, Boolean finish)
1789 {
1790     Boolean       gotNL = FALSE;  /* true if got a newline */
1791     Boolean       fbuf;           /* true if our buffer filled up */
1792     int           nr;             /* number of bytes read */
1793     int           i;              /* auxiliary index into outBuf */
1794     int           max;            /* limit for i (end of current data) */
1795     int           nRead;          /* (Temporary) number of bytes read */
1796
1797     /*
1798      * Read as many bytes as will fit in the buffer.
1799      */
1800 end_loop:
1801     gotNL = FALSE;
1802     fbuf = FALSE;
1803
1804     nRead = read(job->inPipe, &job->outBuf[job->curPos],
1805                      JOB_BUFSIZE - job->curPos);
1806     if (nRead < 0) {
1807         if (errno == EAGAIN)
1808             return;
1809         if (DEBUG(JOB)) {
1810             perror("JobDoOutput(piperead)");
1811         }
1812         nr = 0;
1813     } else {
1814         nr = nRead;
1815     }
1816
1817     /*
1818      * If we hit the end-of-file (the job is dead), we must flush its
1819      * remaining output, so pretend we read a newline if there's any
1820      * output remaining in the buffer.
1821      * Also clear the 'finish' flag so we stop looping.
1822      */
1823     if ((nr == 0) && (job->curPos != 0)) {
1824         job->outBuf[job->curPos] = '\n';
1825         nr = 1;
1826         finish = FALSE;
1827     } else if (nr == 0) {
1828         finish = FALSE;
1829     }
1830
1831     /*
1832      * Look for the last newline in the bytes we just got. If there is
1833      * one, break out of the loop with 'i' as its index and gotNL set
1834      * TRUE.
1835      */
1836     max = job->curPos + nr;
1837     for (i = job->curPos + nr - 1; i >= job->curPos; i--) {
1838         if (job->outBuf[i] == '\n') {
1839             gotNL = TRUE;
1840             break;
1841         } else if (job->outBuf[i] == '\0') {
1842             /*
1843              * Why?
1844              */
1845             job->outBuf[i] = ' ';
1846         }
1847     }
1848
1849     if (!gotNL) {
1850         job->curPos += nr;
1851         if (job->curPos == JOB_BUFSIZE) {
1852             /*
1853              * If we've run out of buffer space, we have no choice
1854              * but to print the stuff. sigh.
1855              */
1856             fbuf = TRUE;
1857             i = job->curPos;
1858         }
1859     }
1860     if (gotNL || fbuf) {
1861         /*
1862          * Need to send the output to the screen. Null terminate it
1863          * first, overwriting the newline character if there was one.
1864          * So long as the line isn't one we should filter (according
1865          * to the shell description), we print the line, preceded
1866          * by a target banner if this target isn't the same as the
1867          * one for which we last printed something.
1868          * The rest of the data in the buffer are then shifted down
1869          * to the start of the buffer and curPos is set accordingly.
1870          */
1871         job->outBuf[i] = '\0';
1872         if (i >= job->curPos) {
1873             char *cp;
1874
1875             cp = JobOutput(job, job->outBuf, &job->outBuf[i], FALSE);
1876
1877             /*
1878              * There's still more in that thar buffer. This time, though,
1879              * we know there's no newline at the end, so we add one of
1880              * our own free will.
1881              */
1882             if (*cp != '\0') {
1883                 if (!beSilent && job->node != lastNode) {
1884                     MESSAGE(stdout, job->node);
1885                     lastNode = job->node;
1886                 }
1887 #ifdef USE_META
1888                 if (useMeta) {
1889                     meta_job_output(job, cp, gotNL ? "\n" : "");
1890                 }
1891 #endif
1892                 (void)fprintf(stdout, "%s%s", cp, gotNL ? "\n" : "");
1893                 (void)fflush(stdout);
1894             }
1895         }
1896         if (i < max - 1) {
1897             /* shift the remaining characters down */
1898             (void)memcpy(job->outBuf, &job->outBuf[i + 1], max - (i + 1));
1899             job->curPos = max - (i + 1);
1900
1901         } else {
1902             /*
1903              * We have written everything out, so we just start over
1904              * from the start of the buffer. No copying. No nothing.
1905              */
1906             job->curPos = 0;
1907         }
1908     }
1909     if (finish) {
1910         /*
1911          * If the finish flag is true, we must loop until we hit
1912          * end-of-file on the pipe. This is guaranteed to happen
1913          * eventually since the other end of the pipe is now closed
1914          * (we closed it explicitly and the child has exited). When
1915          * we do get an EOF, finish will be set FALSE and we'll fall
1916          * through and out.
1917          */
1918         goto end_loop;
1919     }
1920 }
1921
1922 static void
1923 JobRun(GNode *targ)
1924 {
1925 #ifdef notyet
1926     /*
1927      * Unfortunately it is too complicated to run .BEGIN, .END,
1928      * and .INTERRUPT job in the parallel job module. This has
1929      * the nice side effect that it avoids a lot of other problems.
1930      */
1931     Lst lst = Lst_Init(FALSE);
1932     Lst_AtEnd(lst, targ);
1933     (void)Make_Run(lst);
1934     Lst_Destroy(lst, NULL);
1935     JobStart(targ, JOB_SPECIAL);
1936     while (jobTokensRunning) {
1937         Job_CatchOutput();
1938     }
1939 #else
1940     Compat_Make(targ, targ);
1941     if (targ->made == ERROR) {
1942         PrintOnError(targ, "\n\nStop.");
1943         exit(1);
1944     }
1945 #endif
1946 }
1947
1948 /*-
1949  *-----------------------------------------------------------------------
1950  * Job_CatchChildren --
1951  *      Handle the exit of a child. Called from Make_Make.
1952  *
1953  * Input:
1954  *      block           TRUE if should block on the wait
1955  *
1956  * Results:
1957  *      none.
1958  *
1959  * Side Effects:
1960  *      The job descriptor is removed from the list of children.
1961  *
1962  * Notes:
1963  *      We do waits, blocking or not, according to the wisdom of our
1964  *      caller, until there are no more children to report. For each
1965  *      job, call JobFinish to finish things off.
1966  *
1967  *-----------------------------------------------------------------------
1968  */
1969
1970 void
1971 Job_CatchChildren(void)
1972 {
1973     int           pid;          /* pid of dead child */
1974     WAIT_T        status;       /* Exit/termination status */
1975
1976     /*
1977      * Don't even bother if we know there's no one around.
1978      */
1979     if (jobTokensRunning == 0)
1980         return;
1981
1982     while ((pid = waitpid((pid_t) -1, &status, WNOHANG | WUNTRACED)) > 0) {
1983         if (DEBUG(JOB)) {
1984             (void)fprintf(debug_file, "Process %d exited/stopped status %x.\n", pid,
1985               WAIT_STATUS(status));
1986         }
1987         JobReapChild(pid, status, TRUE);
1988     }
1989 }
1990
1991 /*
1992  * It is possible that wait[pid]() was called from elsewhere,
1993  * this lets us reap jobs regardless.
1994  */
1995 void
1996 JobReapChild(pid_t pid, WAIT_T status, Boolean isJobs)
1997 {
1998     Job           *job;         /* job descriptor for dead child */
1999
2000     /*
2001      * Don't even bother if we know there's no one around.
2002      */
2003     if (jobTokensRunning == 0)
2004         return;
2005
2006     job = JobFindPid(pid, JOB_ST_RUNNING, isJobs);
2007     if (job == NULL) {
2008         if (isJobs) {
2009             if (!lurking_children)
2010                 Error("Child (%d) status %x not in table?", pid, status);
2011         }
2012         return;                         /* not ours */
2013     }
2014     if (WIFSTOPPED(status)) {
2015         if (DEBUG(JOB)) {
2016             (void)fprintf(debug_file, "Process %d (%s) stopped.\n",
2017                           job->pid, job->node->name);
2018         }
2019         if (!make_suspended) {
2020             switch (WSTOPSIG(status)) {
2021             case SIGTSTP:
2022                 (void)printf("*** [%s] Suspended\n", job->node->name);
2023                 break;
2024             case SIGSTOP:
2025                 (void)printf("*** [%s] Stopped\n", job->node->name);
2026                 break;
2027             default:
2028                 (void)printf("*** [%s] Stopped -- signal %d\n",
2029                              job->node->name, WSTOPSIG(status));
2030             }
2031             job->job_suspended = 1;
2032         }
2033         (void)fflush(stdout);
2034         return;
2035     }
2036
2037     job->job_state = JOB_ST_FINISHED;
2038     job->exit_status = WAIT_STATUS(status);
2039
2040     JobFinish(job, status);
2041 }
2042
2043 /*-
2044  *-----------------------------------------------------------------------
2045  * Job_CatchOutput --
2046  *      Catch the output from our children, if we're using
2047  *      pipes do so. Otherwise just block time until we get a
2048  *      signal(most likely a SIGCHLD) since there's no point in
2049  *      just spinning when there's nothing to do and the reaping
2050  *      of a child can wait for a while.
2051  *
2052  * Results:
2053  *      None
2054  *
2055  * Side Effects:
2056  *      Output is read from pipes if we're piping.
2057  * -----------------------------------------------------------------------
2058  */
2059 void
2060 Job_CatchOutput(void)
2061 {
2062     int nready;
2063     Job *job;
2064     int i;
2065
2066     (void)fflush(stdout);
2067
2068     /* The first fd in the list is the job token pipe */
2069     do {
2070         nready = poll(fds + 1 - wantToken, nfds - 1 + wantToken, POLL_MSEC);
2071     } while (nready < 0 && errno == EINTR);
2072
2073     if (nready < 0)
2074         Punt("poll: %s", strerror(errno));
2075
2076     if (nready > 0 && readyfd(&childExitJob)) {
2077         char token = 0;
2078         ssize_t count;
2079         count = read(childExitJob.inPipe, &token, 1);
2080         switch (count) {
2081         case 0:
2082             Punt("unexpected eof on token pipe");
2083         case -1:
2084             Punt("token pipe read: %s", strerror(errno));
2085         case 1:
2086             if (token == DO_JOB_RESUME[0])
2087                 /* Complete relay requested from our SIGCONT handler */
2088                 JobRestartJobs();
2089             break;
2090         default:
2091             abort();
2092         }
2093         --nready;
2094     }
2095
2096     Job_CatchChildren();
2097     if (nready == 0)
2098             return;
2099
2100     for (i = 2; i < nfds; i++) {
2101         if (!fds[i].revents)
2102             continue;
2103         job = jobfds[i];
2104         if (job->job_state == JOB_ST_RUNNING)
2105             JobDoOutput(job, FALSE);
2106         if (--nready == 0)
2107                 return;
2108     }
2109 }
2110
2111 /*-
2112  *-----------------------------------------------------------------------
2113  * Job_Make --
2114  *      Start the creation of a target. Basically a front-end for
2115  *      JobStart used by the Make module.
2116  *
2117  * Results:
2118  *      None.
2119  *
2120  * Side Effects:
2121  *      Another job is started.
2122  *
2123  *-----------------------------------------------------------------------
2124  */
2125 void
2126 Job_Make(GNode *gn)
2127 {
2128     (void)JobStart(gn, 0);
2129 }
2130
2131 void
2132 Shell_Init(void)
2133 {
2134     if (shellPath == NULL) {
2135         /*
2136          * We are using the default shell, which may be an absolute
2137          * path if DEFSHELL_CUSTOM is defined.
2138          */
2139         shellName = commandShell->name;
2140 #ifdef DEFSHELL_CUSTOM
2141         if (*shellName == '/') {
2142             shellPath = shellName;
2143             shellName = strrchr(shellPath, '/');
2144             shellName++;
2145         } else
2146 #endif
2147         shellPath = str_concat(_PATH_DEFSHELLDIR, shellName, STR_ADDSLASH);
2148     }
2149     if (commandShell->exit == NULL) {
2150         commandShell->exit = "";
2151     }
2152     if (commandShell->echo == NULL) {
2153         commandShell->echo = "";
2154     }
2155 }
2156
2157 /*-
2158  * Returns the string literal that is used in the current command shell
2159  * to produce a newline character.
2160  */
2161 const char *
2162 Shell_GetNewline(void)
2163 {
2164
2165     return commandShell->newline;
2166 }
2167
2168 void
2169 Job_SetPrefix(void)
2170 {
2171     
2172     if (targPrefix) {
2173         free(targPrefix);
2174     } else if (!Var_Exists(MAKE_JOB_PREFIX, VAR_GLOBAL)) {
2175         Var_Set(MAKE_JOB_PREFIX, "---", VAR_GLOBAL, 0);
2176     }
2177
2178     targPrefix = Var_Subst(NULL, "${" MAKE_JOB_PREFIX "}", VAR_GLOBAL, 0);
2179 }
2180
2181 /*-
2182  *-----------------------------------------------------------------------
2183  * Job_Init --
2184  *      Initialize the process module
2185  *
2186  * Input:
2187  *
2188  * Results:
2189  *      none
2190  *
2191  * Side Effects:
2192  *      lists and counters are initialized
2193  *-----------------------------------------------------------------------
2194  */
2195 void
2196 Job_Init(void)
2197 {
2198     /* Allocate space for all the job info */
2199     job_table = bmake_malloc(maxJobs * sizeof *job_table);
2200     memset(job_table, 0, maxJobs * sizeof *job_table);
2201     job_table_end = job_table + maxJobs;
2202     wantToken = 0;
2203
2204     aborting =    0;
2205     errors =      0;
2206
2207     lastNode =    NULL;
2208
2209     /*
2210      * There is a non-zero chance that we already have children.
2211      * eg after 'make -f- <<EOF'
2212      * Since their termination causes a 'Child (pid) not in table' message,
2213      * Collect the status of any that are already dead, and suppress the
2214      * error message if there are any undead ones.
2215      */
2216     for (;;) {
2217         int rval, status;
2218         rval = waitpid((pid_t) -1, &status, WNOHANG);
2219         if (rval > 0)
2220             continue;
2221         if (rval == 0)
2222             lurking_children = 1;
2223         break;
2224     }
2225
2226     Shell_Init();
2227
2228     JobCreatePipe(&childExitJob, 3);
2229
2230     /* We can only need to wait for tokens, children and output from each job */
2231     fds = bmake_malloc(sizeof (*fds) * (2 + maxJobs));
2232     jobfds = bmake_malloc(sizeof (*jobfds) * (2 + maxJobs));
2233
2234     /* These are permanent entries and take slots 0 and 1 */
2235     watchfd(&tokenWaitJob);
2236     watchfd(&childExitJob);
2237
2238     sigemptyset(&caught_signals);
2239     /*
2240      * Install a SIGCHLD handler.
2241      */
2242     (void)bmake_signal(SIGCHLD, JobChildSig);
2243     sigaddset(&caught_signals, SIGCHLD);
2244
2245 #define ADDSIG(s,h)                             \
2246     if (bmake_signal(s, SIG_IGN) != SIG_IGN) {  \
2247         sigaddset(&caught_signals, s);          \
2248         (void)bmake_signal(s, h);                       \
2249     }
2250
2251     /*
2252      * Catch the four signals that POSIX specifies if they aren't ignored.
2253      * JobPassSig will take care of calling JobInterrupt if appropriate.
2254      */
2255     ADDSIG(SIGINT, JobPassSig_int)
2256     ADDSIG(SIGHUP, JobPassSig_term)
2257     ADDSIG(SIGTERM, JobPassSig_term)
2258     ADDSIG(SIGQUIT, JobPassSig_term)
2259
2260     /*
2261      * There are additional signals that need to be caught and passed if
2262      * either the export system wants to be told directly of signals or if
2263      * we're giving each job its own process group (since then it won't get
2264      * signals from the terminal driver as we own the terminal)
2265      */
2266     ADDSIG(SIGTSTP, JobPassSig_suspend)
2267     ADDSIG(SIGTTOU, JobPassSig_suspend)
2268     ADDSIG(SIGTTIN, JobPassSig_suspend)
2269     ADDSIG(SIGWINCH, JobCondPassSig)
2270     ADDSIG(SIGCONT, JobContinueSig)
2271 #undef ADDSIG
2272
2273     (void)Job_RunTarget(".BEGIN", NULL);
2274     postCommands = Targ_FindNode(".END", TARG_CREATE);
2275 }
2276
2277 static void JobSigReset(void)
2278 {
2279 #define DELSIG(s)                                       \
2280     if (sigismember(&caught_signals, s)) {              \
2281         (void)bmake_signal(s, SIG_DFL);                 \
2282     }
2283
2284     DELSIG(SIGINT)
2285     DELSIG(SIGHUP)
2286     DELSIG(SIGQUIT)
2287     DELSIG(SIGTERM)
2288     DELSIG(SIGTSTP)
2289     DELSIG(SIGTTOU)
2290     DELSIG(SIGTTIN)
2291     DELSIG(SIGWINCH)
2292     DELSIG(SIGCONT)
2293 #undef DELSIG
2294     (void)bmake_signal(SIGCHLD, SIG_DFL);
2295 }
2296
2297 /*-
2298  *-----------------------------------------------------------------------
2299  * JobMatchShell --
2300  *      Find a shell in 'shells' given its name.
2301  *
2302  * Results:
2303  *      A pointer to the Shell structure.
2304  *
2305  * Side Effects:
2306  *      None.
2307  *
2308  *-----------------------------------------------------------------------
2309  */
2310 static Shell *
2311 JobMatchShell(const char *name)
2312 {
2313     Shell       *sh;
2314
2315     for (sh = shells; sh->name != NULL; sh++) {
2316         if (strcmp(name, sh->name) == 0)
2317                 return (sh);
2318     }
2319     return NULL;
2320 }
2321
2322 /*-
2323  *-----------------------------------------------------------------------
2324  * Job_ParseShell --
2325  *      Parse a shell specification and set up commandShell, shellPath
2326  *      and shellName appropriately.
2327  *
2328  * Input:
2329  *      line            The shell spec
2330  *
2331  * Results:
2332  *      FAILURE if the specification was incorrect.
2333  *
2334  * Side Effects:
2335  *      commandShell points to a Shell structure (either predefined or
2336  *      created from the shell spec), shellPath is the full path of the
2337  *      shell described by commandShell, while shellName is just the
2338  *      final component of shellPath.
2339  *
2340  * Notes:
2341  *      A shell specification consists of a .SHELL target, with dependency
2342  *      operator, followed by a series of blank-separated words. Double
2343  *      quotes can be used to use blanks in words. A backslash escapes
2344  *      anything (most notably a double-quote and a space) and
2345  *      provides the functionality it does in C. Each word consists of
2346  *      keyword and value separated by an equal sign. There should be no
2347  *      unnecessary spaces in the word. The keywords are as follows:
2348  *          name            Name of shell.
2349  *          path            Location of shell.
2350  *          quiet           Command to turn off echoing.
2351  *          echo            Command to turn echoing on
2352  *          filter          Result of turning off echoing that shouldn't be
2353  *                          printed.
2354  *          echoFlag        Flag to turn echoing on at the start
2355  *          errFlag         Flag to turn error checking on at the start
2356  *          hasErrCtl       True if shell has error checking control
2357  *          newline         String literal to represent a newline char
2358  *          check           Command to turn on error checking if hasErrCtl
2359  *                          is TRUE or template of command to echo a command
2360  *                          for which error checking is off if hasErrCtl is
2361  *                          FALSE.
2362  *          ignore          Command to turn off error checking if hasErrCtl
2363  *                          is TRUE or template of command to execute a
2364  *                          command so as to ignore any errors it returns if
2365  *                          hasErrCtl is FALSE.
2366  *
2367  *-----------------------------------------------------------------------
2368  */
2369 ReturnStatus
2370 Job_ParseShell(char *line)
2371 {
2372     char        **words;
2373     char        **argv;
2374     int         argc;
2375     char        *path;
2376     Shell       newShell;
2377     Boolean     fullSpec = FALSE;
2378     Shell       *sh;
2379
2380     while (isspace((unsigned char)*line)) {
2381         line++;
2382     }
2383
2384     if (shellArgv)
2385         free(UNCONST(shellArgv));
2386
2387     memset(&newShell, 0, sizeof(newShell));
2388
2389     /*
2390      * Parse the specification by keyword
2391      */
2392     words = brk_string(line, &argc, TRUE, &path);
2393     if (words == NULL) {
2394         Error("Unterminated quoted string [%s]", line);
2395         return FAILURE;
2396     }
2397     shellArgv = path;
2398
2399     for (path = NULL, argv = words; argc != 0; argc--, argv++) {
2400             if (strncmp(*argv, "path=", 5) == 0) {
2401                 path = &argv[0][5];
2402             } else if (strncmp(*argv, "name=", 5) == 0) {
2403                 newShell.name = &argv[0][5];
2404             } else {
2405                 if (strncmp(*argv, "quiet=", 6) == 0) {
2406                     newShell.echoOff = &argv[0][6];
2407                 } else if (strncmp(*argv, "echo=", 5) == 0) {
2408                     newShell.echoOn = &argv[0][5];
2409                 } else if (strncmp(*argv, "filter=", 7) == 0) {
2410                     newShell.noPrint = &argv[0][7];
2411                     newShell.noPLen = strlen(newShell.noPrint);
2412                 } else if (strncmp(*argv, "echoFlag=", 9) == 0) {
2413                     newShell.echo = &argv[0][9];
2414                 } else if (strncmp(*argv, "errFlag=", 8) == 0) {
2415                     newShell.exit = &argv[0][8];
2416                 } else if (strncmp(*argv, "hasErrCtl=", 10) == 0) {
2417                     char c = argv[0][10];
2418                     newShell.hasErrCtl = !((c != 'Y') && (c != 'y') &&
2419                                            (c != 'T') && (c != 't'));
2420                 } else if (strncmp(*argv, "newline=", 8) == 0) {
2421                     newShell.newline = &argv[0][8];
2422                 } else if (strncmp(*argv, "check=", 6) == 0) {
2423                     newShell.errCheck = &argv[0][6];
2424                 } else if (strncmp(*argv, "ignore=", 7) == 0) {
2425                     newShell.ignErr = &argv[0][7];
2426                 } else if (strncmp(*argv, "errout=", 7) == 0) {
2427                     newShell.errOut = &argv[0][7];
2428                 } else if (strncmp(*argv, "comment=", 8) == 0) {
2429                     newShell.commentChar = argv[0][8];
2430                 } else {
2431                     Parse_Error(PARSE_FATAL, "Unknown keyword \"%s\"",
2432                                 *argv);
2433                     free(words);
2434                     return(FAILURE);
2435                 }
2436                 fullSpec = TRUE;
2437             }
2438     }
2439
2440     if (path == NULL) {
2441         /*
2442          * If no path was given, the user wants one of the pre-defined shells,
2443          * yes? So we find the one s/he wants with the help of JobMatchShell
2444          * and set things up the right way. shellPath will be set up by
2445          * Shell_Init.
2446          */
2447         if (newShell.name == NULL) {
2448             Parse_Error(PARSE_FATAL, "Neither path nor name specified");
2449             free(words);
2450             return(FAILURE);
2451         } else {
2452             if ((sh = JobMatchShell(newShell.name)) == NULL) {
2453                     Parse_Error(PARSE_WARNING, "%s: No matching shell",
2454                                 newShell.name);
2455                     free(words);
2456                     return(FAILURE);
2457             }
2458             commandShell = sh;
2459             shellName = newShell.name;
2460             if (shellPath) {
2461                 /* Shell_Init has already been called!  Do it again. */
2462                 free(UNCONST(shellPath));
2463                 shellPath = NULL;
2464                 Shell_Init();
2465             }
2466         }
2467     } else {
2468         /*
2469          * The user provided a path. If s/he gave nothing else (fullSpec is
2470          * FALSE), try and find a matching shell in the ones we know of.
2471          * Else we just take the specification at its word and copy it
2472          * to a new location. In either case, we need to record the
2473          * path the user gave for the shell.
2474          */
2475         shellPath = path;
2476         path = strrchr(path, '/');
2477         if (path == NULL) {
2478             path = UNCONST(shellPath);
2479         } else {
2480             path += 1;
2481         }
2482         if (newShell.name != NULL) {
2483             shellName = newShell.name;
2484         } else {
2485             shellName = path;
2486         }
2487         if (!fullSpec) {
2488             if ((sh = JobMatchShell(shellName)) == NULL) {
2489                     Parse_Error(PARSE_WARNING, "%s: No matching shell",
2490                                 shellName);
2491                     free(words);
2492                     return(FAILURE);
2493             }
2494             commandShell = sh;
2495         } else {
2496             commandShell = bmake_malloc(sizeof(Shell));
2497             *commandShell = newShell;
2498         }
2499     }
2500
2501     if (commandShell->echoOn && commandShell->echoOff) {
2502         commandShell->hasEchoCtl = TRUE;
2503     }
2504
2505     if (!commandShell->hasErrCtl) {
2506         if (commandShell->errCheck == NULL) {
2507             commandShell->errCheck = "";
2508         }
2509         if (commandShell->ignErr == NULL) {
2510             commandShell->ignErr = "%s\n";
2511         }
2512     }
2513
2514     /*
2515      * Do not free up the words themselves, since they might be in use by the
2516      * shell specification.
2517      */
2518     free(words);
2519     return SUCCESS;
2520 }
2521
2522 /*-
2523  *-----------------------------------------------------------------------
2524  * JobInterrupt --
2525  *      Handle the receipt of an interrupt.
2526  *
2527  * Input:
2528  *      runINTERRUPT    Non-zero if commands for the .INTERRUPT target
2529  *                      should be executed
2530  *      signo           signal received
2531  *
2532  * Results:
2533  *      None
2534  *
2535  * Side Effects:
2536  *      All children are killed. Another job will be started if the
2537  *      .INTERRUPT target was given.
2538  *-----------------------------------------------------------------------
2539  */
2540 static void
2541 JobInterrupt(int runINTERRUPT, int signo)
2542 {
2543     Job         *job;           /* job descriptor in that element */
2544     GNode       *interrupt;     /* the node describing the .INTERRUPT target */
2545     sigset_t    mask;
2546     GNode       *gn;
2547
2548     aborting = ABORT_INTERRUPT;
2549
2550     JobSigLock(&mask);
2551
2552     for (job = job_table; job < job_table_end; job++) {
2553         if (job->job_state != JOB_ST_RUNNING)
2554             continue;
2555
2556         gn = job->node;
2557
2558         if ((gn->type & (OP_JOIN|OP_PHONY)) == 0 && !Targ_Precious(gn)) {
2559             char *file = (gn->path == NULL ? gn->name : gn->path);
2560             if (!noExecute && eunlink(file) != -1) {
2561                 Error("*** %s removed", file);
2562             }
2563         }
2564         if (job->pid) {
2565             if (DEBUG(JOB)) {
2566                 (void)fprintf(debug_file,
2567                            "JobInterrupt passing signal %d to child %d.\n",
2568                            signo, job->pid);
2569             }
2570             KILLPG(job->pid, signo);
2571         }
2572     }
2573
2574     JobSigUnlock(&mask);
2575
2576     if (runINTERRUPT && !touchFlag) {
2577         interrupt = Targ_FindNode(".INTERRUPT", TARG_NOCREATE);
2578         if (interrupt != NULL) {
2579             ignoreErrors = FALSE;
2580             JobRun(interrupt);
2581         }
2582     }
2583     Trace_Log(MAKEINTR, 0);
2584     exit(signo);
2585 }
2586
2587 /*
2588  *-----------------------------------------------------------------------
2589  * Job_Finish --
2590  *      Do final processing such as the running of the commands
2591  *      attached to the .END target.
2592  *
2593  * Results:
2594  *      Number of errors reported.
2595  *
2596  * Side Effects:
2597  *      None.
2598  *-----------------------------------------------------------------------
2599  */
2600 int
2601 Job_Finish(void)
2602 {
2603     if (postCommands != NULL &&
2604         (!Lst_IsEmpty(postCommands->commands) ||
2605          !Lst_IsEmpty(postCommands->children))) {
2606         if (errors) {
2607             Error("Errors reported so .END ignored");
2608         } else {
2609             JobRun(postCommands);
2610         }
2611     }
2612     return(errors);
2613 }
2614
2615 /*-
2616  *-----------------------------------------------------------------------
2617  * Job_End --
2618  *      Cleanup any memory used by the jobs module
2619  *
2620  * Results:
2621  *      None.
2622  *
2623  * Side Effects:
2624  *      Memory is freed
2625  *-----------------------------------------------------------------------
2626  */
2627 void
2628 Job_End(void)
2629 {
2630 #ifdef CLEANUP
2631     if (shellArgv)
2632         free(shellArgv);
2633 #endif
2634 }
2635
2636 /*-
2637  *-----------------------------------------------------------------------
2638  * Job_Wait --
2639  *      Waits for all running jobs to finish and returns. Sets 'aborting'
2640  *      to ABORT_WAIT to prevent other jobs from starting.
2641  *
2642  * Results:
2643  *      None.
2644  *
2645  * Side Effects:
2646  *      Currently running jobs finish.
2647  *
2648  *-----------------------------------------------------------------------
2649  */
2650 void
2651 Job_Wait(void)
2652 {
2653     aborting = ABORT_WAIT;
2654     while (jobTokensRunning != 0) {
2655         Job_CatchOutput();
2656     }
2657     aborting = 0;
2658 }
2659
2660 /*-
2661  *-----------------------------------------------------------------------
2662  * Job_AbortAll --
2663  *      Abort all currently running jobs without handling output or anything.
2664  *      This function is to be called only in the event of a major
2665  *      error. Most definitely NOT to be called from JobInterrupt.
2666  *
2667  * Results:
2668  *      None
2669  *
2670  * Side Effects:
2671  *      All children are killed, not just the firstborn
2672  *-----------------------------------------------------------------------
2673  */
2674 void
2675 Job_AbortAll(void)
2676 {
2677     Job         *job;   /* the job descriptor in that element */
2678     WAIT_T      foo;
2679
2680     aborting = ABORT_ERROR;
2681
2682     if (jobTokensRunning) {
2683         for (job = job_table; job < job_table_end; job++) {
2684             if (job->job_state != JOB_ST_RUNNING)
2685                 continue;
2686             /*
2687              * kill the child process with increasingly drastic signals to make
2688              * darn sure it's dead.
2689              */
2690             KILLPG(job->pid, SIGINT);
2691             KILLPG(job->pid, SIGKILL);
2692         }
2693     }
2694
2695     /*
2696      * Catch as many children as want to report in at first, then give up
2697      */
2698     while (waitpid((pid_t) -1, &foo, WNOHANG) > 0)
2699         continue;
2700 }
2701
2702 \f
2703 /*-
2704  *-----------------------------------------------------------------------
2705  * JobRestartJobs --
2706  *      Tries to restart stopped jobs if there are slots available.
2707  *      Called in process context in response to a SIGCONT.
2708  *
2709  * Results:
2710  *      None.
2711  *
2712  * Side Effects:
2713  *      Resumes jobs.
2714  *
2715  *-----------------------------------------------------------------------
2716  */
2717 static void
2718 JobRestartJobs(void)
2719 {
2720     Job *job;
2721
2722     for (job = job_table; job < job_table_end; job++) {
2723         if (job->job_state == JOB_ST_RUNNING &&
2724                 (make_suspended || job->job_suspended)) {
2725             if (DEBUG(JOB)) {
2726                 (void)fprintf(debug_file, "Restarting stopped job pid %d.\n",
2727                         job->pid);
2728             }
2729             if (job->job_suspended) {
2730                     (void)printf("*** [%s] Continued\n", job->node->name);
2731                     (void)fflush(stdout);
2732             }
2733             job->job_suspended = 0;
2734             if (KILLPG(job->pid, SIGCONT) != 0 && DEBUG(JOB)) {
2735                 fprintf(debug_file, "Failed to send SIGCONT to %d\n", job->pid);
2736             }
2737         }
2738         if (job->job_state == JOB_ST_FINISHED)
2739             /* Job exit deferred after calling waitpid() in a signal handler */
2740             JobFinish(job, job->exit_status);
2741     }
2742     make_suspended = 0;
2743 }
2744
2745 static void
2746 watchfd(Job *job)
2747 {
2748     if (job->inPollfd != NULL)
2749         Punt("Watching watched job");
2750
2751     fds[nfds].fd = job->inPipe;
2752     fds[nfds].events = POLLIN;
2753     jobfds[nfds] = job;
2754     job->inPollfd = &fds[nfds];
2755     nfds++;
2756 }
2757
2758 static void
2759 clearfd(Job *job)
2760 {
2761     int i;
2762     if (job->inPollfd == NULL)
2763         Punt("Unwatching unwatched job");
2764     i = job->inPollfd - fds;
2765     nfds--;
2766     /*
2767      * Move last job in table into hole made by dead job.
2768      */
2769     if (nfds != i) {
2770         fds[i] = fds[nfds];
2771         jobfds[i] = jobfds[nfds];
2772         jobfds[i]->inPollfd = &fds[i];
2773     }
2774     job->inPollfd = NULL;
2775 }
2776
2777 static int
2778 readyfd(Job *job)
2779 {
2780     if (job->inPollfd == NULL)
2781         Punt("Polling unwatched job");
2782     return (job->inPollfd->revents & POLLIN) != 0;
2783 }
2784
2785 /*-
2786  *-----------------------------------------------------------------------
2787  * JobTokenAdd --
2788  *      Put a token into the job pipe so that some make process can start
2789  *      another job.
2790  *
2791  * Side Effects:
2792  *      Allows more build jobs to be spawned somewhere.
2793  *
2794  *-----------------------------------------------------------------------
2795  */
2796
2797 static void
2798 JobTokenAdd(void)
2799 {
2800     char tok = JOB_TOKENS[aborting], tok1;
2801
2802     /* If we are depositing an error token flush everything else */
2803     while (tok != '+' && read(tokenWaitJob.inPipe, &tok1, 1) == 1)
2804         continue;
2805
2806     if (DEBUG(JOB))
2807         fprintf(debug_file, "(%d) aborting %d, deposit token %c\n",
2808             getpid(), aborting, JOB_TOKENS[aborting]);
2809     while (write(tokenWaitJob.outPipe, &tok, 1) == -1 && errno == EAGAIN)
2810         continue;
2811 }
2812
2813 /*-
2814  *-----------------------------------------------------------------------
2815  * Job_ServerStartTokenAdd --
2816  *      Prep the job token pipe in the root make process.
2817  *
2818  *-----------------------------------------------------------------------
2819  */
2820
2821 void
2822 Job_ServerStart(int max_tokens, int jp_0, int jp_1)
2823 {
2824     int i;
2825     char jobarg[64];
2826     
2827     if (jp_0 >= 0 && jp_1 >= 0) {
2828         /* Pipe passed in from parent */
2829         tokenWaitJob.inPipe = jp_0;
2830         tokenWaitJob.outPipe = jp_1;
2831         return;
2832     }
2833
2834     JobCreatePipe(&tokenWaitJob, 15);
2835
2836     snprintf(jobarg, sizeof(jobarg), "%d,%d",
2837             tokenWaitJob.inPipe, tokenWaitJob.outPipe);
2838
2839     Var_Append(MAKEFLAGS, "-J", VAR_GLOBAL);
2840     Var_Append(MAKEFLAGS, jobarg, VAR_GLOBAL);                  
2841
2842     /*
2843      * Preload the job pipe with one token per job, save the one
2844      * "extra" token for the primary job.
2845      * 
2846      * XXX should clip maxJobs against PIPE_BUF -- if max_tokens is
2847      * larger than the write buffer size of the pipe, we will
2848      * deadlock here.
2849      */
2850     for (i = 1; i < max_tokens; i++)
2851         JobTokenAdd();
2852 }
2853
2854 /*-
2855  *-----------------------------------------------------------------------
2856  * Job_TokenReturn --
2857  *      Return a withdrawn token to the pool.
2858  *
2859  *-----------------------------------------------------------------------
2860  */
2861
2862 void
2863 Job_TokenReturn(void)
2864 {
2865     jobTokensRunning--;
2866     if (jobTokensRunning < 0)
2867         Punt("token botch");
2868     if (jobTokensRunning || JOB_TOKENS[aborting] != '+')
2869         JobTokenAdd();
2870 }
2871
2872 /*-
2873  *-----------------------------------------------------------------------
2874  * Job_TokenWithdraw --
2875  *      Attempt to withdraw a token from the pool.
2876  *
2877  * Results:
2878  *      Returns TRUE if a token was withdrawn, and FALSE if the pool
2879  *      is currently empty.
2880  *
2881  * Side Effects:
2882  *      If pool is empty, set wantToken so that we wake up
2883  *      when a token is released.
2884  *
2885  *-----------------------------------------------------------------------
2886  */
2887
2888
2889 Boolean
2890 Job_TokenWithdraw(void)
2891 {
2892     char tok, tok1;
2893     int count;
2894
2895     wantToken = 0;
2896     if (DEBUG(JOB))
2897         fprintf(debug_file, "Job_TokenWithdraw(%d): aborting %d, running %d\n",
2898                 getpid(), aborting, jobTokensRunning);
2899
2900     if (aborting || (jobTokensRunning >= maxJobs))
2901         return FALSE;
2902
2903     count = read(tokenWaitJob.inPipe, &tok, 1);
2904     if (count == 0)
2905         Fatal("eof on job pipe!");
2906     if (count < 0 && jobTokensRunning != 0) {
2907         if (errno != EAGAIN) {
2908             Fatal("job pipe read: %s", strerror(errno));
2909         }
2910         if (DEBUG(JOB))
2911             fprintf(debug_file, "(%d) blocked for token\n", getpid());
2912         wantToken = 1;
2913         return FALSE;
2914     }
2915
2916     if (count == 1 && tok != '+') {
2917         /* make being abvorted - remove any other job tokens */
2918         if (DEBUG(JOB))
2919             fprintf(debug_file, "(%d) aborted by token %c\n", getpid(), tok);
2920         while (read(tokenWaitJob.inPipe, &tok1, 1) == 1)
2921             continue;
2922         /* And put the stopper back */
2923         while (write(tokenWaitJob.outPipe, &tok, 1) == -1 && errno == EAGAIN)
2924             continue;
2925         Fatal("A failure has been detected in another branch of the parallel make");
2926     }
2927
2928     if (count == 1 && jobTokensRunning == 0)
2929         /* We didn't want the token really */
2930         while (write(tokenWaitJob.outPipe, &tok, 1) == -1 && errno == EAGAIN)
2931             continue;
2932
2933     jobTokensRunning++;
2934     if (DEBUG(JOB))
2935         fprintf(debug_file, "(%d) withdrew token\n", getpid());
2936     return TRUE;
2937 }
2938
2939 /*-
2940  *-----------------------------------------------------------------------
2941  * Job_RunTarget --
2942  *      Run the named target if found. If a filename is specified, then
2943  *      set that to the sources.
2944  *
2945  * Results:
2946  *      None
2947  *
2948  * Side Effects:
2949  *      exits if the target fails.
2950  *
2951  *-----------------------------------------------------------------------
2952  */
2953 Boolean
2954 Job_RunTarget(const char *target, const char *fname) {
2955     GNode *gn = Targ_FindNode(target, TARG_NOCREATE);
2956
2957     if (gn == NULL)
2958         return FALSE;
2959
2960     if (fname)
2961         Var_Set(ALLSRC, fname, gn, 0);
2962
2963     JobRun(gn);
2964     if (gn->made == ERROR) {
2965         PrintOnError(gn, "\n\nStop.");
2966         exit(1);
2967     }
2968     return TRUE;
2969 }
2970
2971 #ifdef USE_SELECT
2972 int
2973 emul_poll(struct pollfd *fd, int nfd, int timeout)
2974 {
2975     fd_set rfds, wfds;
2976     int i, maxfd, nselect, npoll;
2977     struct timeval tv, *tvp;
2978     long usecs;
2979
2980     FD_ZERO(&rfds);
2981     FD_ZERO(&wfds);
2982
2983     maxfd = -1;
2984     for (i = 0; i < nfd; i++) {
2985         fd[i].revents = 0;
2986
2987         if (fd[i].events & POLLIN)
2988             FD_SET(fd[i].fd, &rfds);
2989
2990         if (fd[i].events & POLLOUT)
2991             FD_SET(fd[i].fd, &wfds);
2992
2993         if (fd[i].fd > maxfd)
2994             maxfd = fd[i].fd;
2995     }
2996     
2997     if (maxfd >= FD_SETSIZE) {
2998         Punt("Ran out of fd_set slots; " 
2999              "recompile with a larger FD_SETSIZE.");
3000     }
3001
3002     if (timeout < 0) {
3003         tvp = NULL;
3004     } else {
3005         usecs = timeout * 1000;
3006         tv.tv_sec = usecs / 1000000;
3007         tv.tv_usec = usecs % 1000000;
3008         tvp = &tv;
3009     }
3010
3011     nselect = select(maxfd + 1, &rfds, &wfds, 0, tvp);
3012
3013     if (nselect <= 0)
3014         return nselect;
3015
3016     npoll = 0;
3017     for (i = 0; i < nfd; i++) {
3018         if (FD_ISSET(fd[i].fd, &rfds))
3019             fd[i].revents |= POLLIN;
3020
3021         if (FD_ISSET(fd[i].fd, &wfds))
3022             fd[i].revents |= POLLOUT;
3023
3024         if (fd[i].revents)
3025             npoll++;
3026     }
3027
3028     return npoll;
3029 }
3030 #endif /* USE_SELECT */