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