xref: /netbsd-src/usr.bin/make/job.c (revision 404fbe5fb94ca1e054339640cabb2801ce52dd30)
1 /*	$NetBSD: job.c,v 1.143 2008/12/19 22:03:41 christos Exp $	*/
2 
3 /*
4  * Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Adam de Boor.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  */
34 
35 /*
36  * Copyright (c) 1988, 1989 by Adam de Boor
37  * Copyright (c) 1989 by Berkeley Softworks
38  * All rights reserved.
39  *
40  * This code is derived from software contributed to Berkeley by
41  * Adam de Boor.
42  *
43  * Redistribution and use in source and binary forms, with or without
44  * modification, are permitted provided that the following conditions
45  * are met:
46  * 1. Redistributions of source code must retain the above copyright
47  *    notice, this list of conditions and the following disclaimer.
48  * 2. Redistributions in binary form must reproduce the above copyright
49  *    notice, this list of conditions and the following disclaimer in the
50  *    documentation and/or other materials provided with the distribution.
51  * 3. All advertising materials mentioning features or use of this software
52  *    must display the following acknowledgement:
53  *	This product includes software developed by the University of
54  *	California, Berkeley and its contributors.
55  * 4. Neither the name of the University nor the names of its contributors
56  *    may be used to endorse or promote products derived from this software
57  *    without specific prior written permission.
58  *
59  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
60  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
61  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
62  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
63  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
64  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
65  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
66  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
67  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
68  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
69  * SUCH DAMAGE.
70  */
71 
72 #ifndef MAKE_NATIVE
73 static char rcsid[] = "$NetBSD: job.c,v 1.143 2008/12/19 22:03:41 christos Exp $";
74 #else
75 #include <sys/cdefs.h>
76 #ifndef lint
77 #if 0
78 static char sccsid[] = "@(#)job.c	8.2 (Berkeley) 3/19/94";
79 #else
80 __RCSID("$NetBSD: job.c,v 1.143 2008/12/19 22:03:41 christos Exp $");
81 #endif
82 #endif /* not lint */
83 #endif
84 
85 /*-
86  * job.c --
87  *	handle the creation etc. of our child processes.
88  *
89  * Interface:
90  *	Job_Make  	    	Start the creation of the given target.
91  *
92  *	Job_CatchChildren   	Check for and handle the termination of any
93  *	    	  	    	children. This must be called reasonably
94  *	    	  	    	frequently to keep the whole make going at
95  *	    	  	    	a decent clip, since job table entries aren't
96  *	    	  	    	removed until their process is caught this way.
97  *
98  *	Job_CatchOutput	    	Print any output our children have produced.
99  *	    	  	    	Should also be called fairly frequently to
100  *	    	  	    	keep the user informed of what's going on.
101  *	    	  	    	If no output is waiting, it will block for
102  *	    	  	    	a time given by the SEL_* constants, below,
103  *	    	  	    	or until output is ready.
104  *
105  *	Job_Init  	    	Called to intialize this module. in addition,
106  *	    	  	    	any commands attached to the .BEGIN target
107  *	    	  	    	are executed before this function returns.
108  *	    	  	    	Hence, the makefile must have been parsed
109  *	    	  	    	before this function is called.
110  *
111  *	Job_End  	    	Cleanup any memory used.
112  *
113  *	Job_ParseShell	    	Given the line following a .SHELL target, parse
114  *	    	  	    	the line as a shell specification. Returns
115  *	    	  	    	FAILURE if the spec was incorrect.
116  *
117  *	Job_Finish	    	Perform any final processing which needs doing.
118  *	    	  	    	This includes the execution of any commands
119  *	    	  	    	which have been/were attached to the .END
120  *	    	  	    	target. It should only be called when the
121  *	    	  	    	job table is empty.
122  *
123  *	Job_AbortAll	    	Abort all currently running jobs. It doesn't
124  *	    	  	    	handle output or do anything for the jobs,
125  *	    	  	    	just kills them. It should only be called in
126  *	    	  	    	an emergency, as it were.
127  *
128  *	Job_CheckCommands   	Verify that the commands for a target are
129  *	    	  	    	ok. Provide them if necessary and possible.
130  *
131  *	Job_Touch 	    	Update a target without really updating it.
132  *
133  *	Job_Wait  	    	Wait for all currently-running jobs to finish.
134  */
135 
136 #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);
348 static int JobPrintCommand(ClientData, ClientData);
349 static int JobSaveCommand(ClientData, ClientData);
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)
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))
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(ClientData cmdp, ClientData 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 	    errOff = TRUE;
717 	    break;
718 	case '+':
719 	    if (noSpecials) {
720 		/*
721 		 * We're not actually executing anything...
722 		 * but this one needs to be - use compat mode just for it.
723 		 */
724 		CompatRunCommand(cmdp, job->node);
725 		return 0;
726 	    }
727 	    break;
728 	}
729 	cmd++;
730     }
731 
732     while (isspace((unsigned char) *cmd))
733 	cmd++;
734 
735     /*
736      * If the shell doesn't have error control the alternate echo'ing will
737      * be done (to avoid showing additional error checking code)
738      * and this will need the characters '$ ` \ "' escaped
739      */
740 
741     if (!commandShell->hasErrCtl) {
742 	/* Worst that could happen is every char needs escaping. */
743 	escCmd = bmake_malloc((strlen(cmd) * 2) + 1);
744 	for (i = 0, j= 0; cmd[i] != '\0'; i++, j++) {
745 		if (cmd[i] == '$' || cmd[i] == '`' || cmd[i] == '\\' ||
746 			cmd[i] == '"')
747 			escCmd[j++] = '\\';
748 		escCmd[j] = cmd[i];
749 	}
750 	escCmd[j] = 0;
751     }
752 
753     if (shutUp) {
754 	if (!(job->flags & JOB_SILENT) && !noSpecials &&
755 	    commandShell->hasEchoCtl) {
756 		DBPRINTF("%s\n", commandShell->echoOff);
757 	} else {
758 	    if (commandShell->hasErrCtl)
759 		shutUp = FALSE;
760 	}
761     }
762 
763     if (errOff) {
764 	if ( !(job->flags & JOB_IGNERR) && !noSpecials) {
765 	    if (commandShell->hasErrCtl) {
766 		/*
767 		 * we don't want the error-control commands showing
768 		 * up either, so we turn off echoing while executing
769 		 * them. We could put another field in the shell
770 		 * structure to tell JobDoOutput to look for this
771 		 * string too, but why make it any more complex than
772 		 * it already is?
773 		 */
774 		if (!(job->flags & JOB_SILENT) && !shutUp &&
775 		    commandShell->hasEchoCtl) {
776 			DBPRINTF("%s\n", commandShell->echoOff);
777 			DBPRINTF("%s\n", commandShell->ignErr);
778 			DBPRINTF("%s\n", commandShell->echoOn);
779 		} else {
780 			DBPRINTF("%s\n", commandShell->ignErr);
781 		}
782 	    } else if (commandShell->ignErr &&
783 		      (*commandShell->ignErr != '\0'))
784 	    {
785 		/*
786 		 * The shell has no error control, so we need to be
787 		 * weird to get it to ignore any errors from the command.
788 		 * If echoing is turned on, we turn it off and use the
789 		 * errCheck template to echo the command. Leave echoing
790 		 * off so the user doesn't see the weirdness we go through
791 		 * to ignore errors. Set cmdTemplate to use the weirdness
792 		 * instead of the simple "%s\n" template.
793 		 */
794 		if (!(job->flags & JOB_SILENT) && !shutUp) {
795 			if (commandShell->hasEchoCtl) {
796 				DBPRINTF("%s\n", commandShell->echoOff);
797 			}
798 			DBPRINTF(commandShell->errCheck, escCmd);
799 			shutUp = TRUE;
800 		} else {
801 			if (!shutUp) {
802 				DBPRINTF(commandShell->errCheck, escCmd);
803 			}
804 		}
805 		cmdTemplate = commandShell->ignErr;
806 		/*
807 		 * The error ignoration (hee hee) is already taken care
808 		 * of by the ignErr template, so pretend error checking
809 		 * is still on.
810 		 */
811 		errOff = FALSE;
812 	    } else {
813 		errOff = FALSE;
814 	    }
815 	} else {
816 	    errOff = FALSE;
817 	}
818     } else {
819 
820 	/*
821 	 * If errors are being checked and the shell doesn't have error control
822 	 * but does supply an errOut template, then setup commands to run
823 	 * through it.
824 	 */
825 
826 	if (!commandShell->hasErrCtl && commandShell->errOut &&
827 	    (*commandShell->errOut != '\0')) {
828 		if (!(job->flags & JOB_SILENT) && !shutUp) {
829 			if (commandShell->hasEchoCtl) {
830 				DBPRINTF("%s\n", commandShell->echoOff);
831 			}
832 			DBPRINTF(commandShell->errCheck, escCmd);
833 			shutUp = TRUE;
834 		}
835 		/* If it's a comment line or blank, treat as an ignored error */
836 		if ((escCmd[0] == commandShell->commentChar) ||
837 		    (escCmd[0] == 0))
838 			cmdTemplate = commandShell->ignErr;
839 		else
840 			cmdTemplate = commandShell->errOut;
841 		errOff = FALSE;
842 	}
843     }
844 
845     if (DEBUG(SHELL) && strcmp(shellName, "sh") == 0 &&
846 	(job->flags & JOB_TRACED) == 0) {
847 	    DBPRINTF("set -%s\n", "x");
848 	    job->flags |= JOB_TRACED;
849     }
850 
851     if ((cp = Check_Cwd_Cmd(cmd)) != NULL) {
852 	    DBPRINTF("test -d %s && ", cp);
853 	    DBPRINTF("cd %s\n", cp);
854     }
855 
856     DBPRINTF(cmdTemplate, cmd);
857     free(cmdStart);
858     if (escCmd)
859         free(escCmd);
860     if (errOff) {
861 	/*
862 	 * If echoing is already off, there's no point in issuing the
863 	 * echoOff command. Otherwise we issue it and pretend it was on
864 	 * for the whole command...
865 	 */
866 	if (!shutUp && !(job->flags & JOB_SILENT) && commandShell->hasEchoCtl){
867 	    DBPRINTF("%s\n", commandShell->echoOff);
868 	    shutUp = TRUE;
869 	}
870 	DBPRINTF("%s\n", commandShell->errCheck);
871     }
872     if (shutUp && commandShell->hasEchoCtl) {
873 	DBPRINTF("%s\n", commandShell->echoOn);
874     }
875     if (cp != NULL) {
876 	    DBPRINTF("test -d %s && ", cp);
877 	    DBPRINTF("cd %s\n", Var_Value(".OBJDIR", VAR_GLOBAL, &tmp));
878     }
879     return 0;
880 }
881 
882 /*-
883  *-----------------------------------------------------------------------
884  * JobSaveCommand --
885  *	Save a command to be executed when everything else is done.
886  *	Callback function for JobFinish...
887  *
888  * Results:
889  *	Always returns 0
890  *
891  * Side Effects:
892  *	The command is tacked onto the end of postCommands's commands list.
893  *
894  *-----------------------------------------------------------------------
895  */
896 static int
897 JobSaveCommand(ClientData cmd, ClientData gn)
898 {
899     cmd = Var_Subst(NULL, (char *)cmd, (GNode *)gn, FALSE);
900     (void)Lst_AtEnd(postCommands->commands, cmd);
901     return(0);
902 }
903 
904 
905 /*-
906  *-----------------------------------------------------------------------
907  * JobClose --
908  *	Called to close both input and output pipes when a job is finished.
909  *
910  * Results:
911  *	Nada
912  *
913  * Side Effects:
914  *	The file descriptors associated with the job are closed.
915  *
916  *-----------------------------------------------------------------------
917  */
918 static void
919 JobClose(Job *job)
920 {
921     clearfd(job);
922     (void)close(job->outPipe);
923     job->outPipe = -1;
924 
925     JobDoOutput(job, TRUE);
926     (void)close(job->inPipe);
927     job->inPipe = -1;
928 }
929 
930 /*-
931  *-----------------------------------------------------------------------
932  * JobFinish  --
933  *	Do final processing for the given job including updating
934  *	parents and starting new jobs as available/necessary. Note
935  *	that we pay no attention to the JOB_IGNERR flag here.
936  *	This is because when we're called because of a noexecute flag
937  *	or something, jstat.w_status is 0 and when called from
938  *	Job_CatchChildren, the status is zeroed if it s/b ignored.
939  *
940  * Input:
941  *	job		job to finish
942  *	status		sub-why job went away
943  *
944  * Results:
945  *	None
946  *
947  * Side Effects:
948  *	Final commands for the job are placed on postCommands.
949  *
950  *	If we got an error and are aborting (aborting == ABORT_ERROR) and
951  *	the job list is now empty, we are done for the day.
952  *	If we recognized an error (errors !=0), we set the aborting flag
953  *	to ABORT_ERROR so no more jobs will be started.
954  *-----------------------------------------------------------------------
955  */
956 /*ARGSUSED*/
957 static void
958 JobFinish(Job *job, int status)
959 {
960     Boolean 	 done, return_job_token;
961 
962     if (DEBUG(JOB)) {
963 	fprintf(debug_file, "Jobfinish: %d [%s], status %d\n",
964 				job->pid, job->node->name, status);
965     }
966 
967     if ((WIFEXITED(status) &&
968 	 (((WEXITSTATUS(status) != 0) && !(job->flags & JOB_IGNERR)))) ||
969 	WIFSIGNALED(status))
970     {
971 	/*
972 	 * If it exited non-zero and either we're doing things our
973 	 * way or we're not ignoring errors, the job is finished.
974 	 * Similarly, if the shell died because of a signal
975 	 * the job is also finished. In these
976 	 * cases, finish out the job's output before printing the exit
977 	 * status...
978 	 */
979 	JobClose(job);
980 	if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
981 	   (void)fclose(job->cmdFILE);
982 	   job->cmdFILE = NULL;
983 	}
984 	done = TRUE;
985     } else if (WIFEXITED(status)) {
986 	/*
987 	 * Deal with ignored errors in -B mode. We need to print a message
988 	 * telling of the ignored error as well as setting status.w_status
989 	 * to 0 so the next command gets run. To do this, we set done to be
990 	 * TRUE if in -B mode and the job exited non-zero.
991 	 */
992 	done = WEXITSTATUS(status) != 0;
993 	/*
994 	 * Old comment said: "Note we don't
995 	 * want to close down any of the streams until we know we're at the
996 	 * end."
997 	 * But we do. Otherwise when are we going to print the rest of the
998 	 * stuff?
999 	 */
1000 	JobClose(job);
1001     } else {
1002 	/*
1003 	 * No need to close things down or anything.
1004 	 */
1005 	done = FALSE;
1006     }
1007 
1008     if (done) {
1009 	if (WIFEXITED(status)) {
1010 	    if (DEBUG(JOB)) {
1011 		(void)fprintf(debug_file, "Process %d [%s] exited.\n",
1012 				job->pid, job->node->name);
1013 	    }
1014 	    if (WEXITSTATUS(status) != 0) {
1015 		if (job->node != lastNode) {
1016 		    MESSAGE(stdout, job->node);
1017 		    lastNode = job->node;
1018 		}
1019 		(void)printf("*** [%s] Error code %d%s\n",
1020 				job->node->name,
1021 			       WEXITSTATUS(status),
1022 			       (job->flags & JOB_IGNERR) ? "(ignored)" : "");
1023 		if (job->flags & JOB_IGNERR)
1024 		    status = 0;
1025 	    } else if (DEBUG(JOB)) {
1026 		if (job->node != lastNode) {
1027 		    MESSAGE(stdout, job->node);
1028 		    lastNode = job->node;
1029 		}
1030 		(void)printf("*** [%s] Completed successfully\n",
1031 				job->node->name);
1032 	    }
1033 	} else {
1034 	    if (job->node != lastNode) {
1035 		MESSAGE(stdout, job->node);
1036 		lastNode = job->node;
1037 	    }
1038 	    (void)printf("*** [%s] Signal %d\n",
1039 			job->node->name, WTERMSIG(status));
1040 	}
1041 	(void)fflush(stdout);
1042     }
1043 
1044     return_job_token = FALSE;
1045 
1046     Trace_Log(JOBEND, job);
1047     if (!(job->flags & JOB_SPECIAL)) {
1048 	if ((status != 0) ||
1049 		(aborting == ABORT_ERROR) ||
1050 		(aborting == ABORT_INTERRUPT))
1051 	    return_job_token = TRUE;
1052     }
1053 
1054     if ((aborting != ABORT_ERROR) && (aborting != ABORT_INTERRUPT) && (status == 0)) {
1055 	/*
1056 	 * As long as we aren't aborting and the job didn't return a non-zero
1057 	 * status that we shouldn't ignore, we call Make_Update to update
1058 	 * the parents. In addition, any saved commands for the node are placed
1059 	 * on the .END target.
1060 	 */
1061 	if (job->tailCmds != NULL) {
1062 	    Lst_ForEachFrom(job->node->commands, job->tailCmds,
1063 			     JobSaveCommand,
1064 			    job->node);
1065 	}
1066 	job->node->made = MADE;
1067 	if (!(job->flags & JOB_SPECIAL))
1068 	    return_job_token = TRUE;
1069 	Make_Update(job->node);
1070 	job->job_state = JOB_ST_FREE;
1071     } else if (status != 0) {
1072 	errors += 1;
1073 	job->job_state = JOB_ST_FREE;
1074     }
1075 
1076     /*
1077      * Set aborting if any error.
1078      */
1079     if (errors && !keepgoing && (aborting != ABORT_INTERRUPT)) {
1080 	/*
1081 	 * If we found any errors in this batch of children and the -k flag
1082 	 * wasn't given, we set the aborting flag so no more jobs get
1083 	 * started.
1084 	 */
1085 	aborting = ABORT_ERROR;
1086     }
1087 
1088     if (return_job_token)
1089 	Job_TokenReturn();
1090 
1091     if (aborting == ABORT_ERROR && jobTokensRunning == 0) {
1092 	/*
1093 	 * If we are aborting and the job table is now empty, we finish.
1094 	 */
1095 	Finish(errors);
1096     }
1097 }
1098 
1099 /*-
1100  *-----------------------------------------------------------------------
1101  * Job_Touch --
1102  *	Touch the given target. Called by JobStart when the -t flag was
1103  *	given
1104  *
1105  * Input:
1106  *	gn		the node of the file to touch
1107  *	silent		TRUE if should not print message
1108  *
1109  * Results:
1110  *	None
1111  *
1112  * Side Effects:
1113  *	The data modification of the file is changed. In addition, if the
1114  *	file did not exist, it is created.
1115  *-----------------------------------------------------------------------
1116  */
1117 void
1118 Job_Touch(GNode *gn, Boolean silent)
1119 {
1120     int		  streamID;   	/* ID of stream opened to do the touch */
1121     struct utimbuf times;	/* Times for utime() call */
1122 
1123     if (gn->type & (OP_JOIN|OP_USE|OP_USEBEFORE|OP_EXEC|OP_OPTIONAL|OP_PHONY)) {
1124 	/*
1125 	 * .JOIN, .USE, .ZEROTIME and .OPTIONAL targets are "virtual" targets
1126 	 * and, as such, shouldn't really be created.
1127 	 */
1128 	return;
1129     }
1130 
1131     if (!silent || NoExecute(gn)) {
1132 	(void)fprintf(stdout, "touch %s\n", gn->name);
1133 	(void)fflush(stdout);
1134     }
1135 
1136     if (NoExecute(gn)) {
1137 	return;
1138     }
1139 
1140     if (gn->type & OP_ARCHV) {
1141 	Arch_Touch(gn);
1142     } else if (gn->type & OP_LIB) {
1143 	Arch_TouchLib(gn);
1144     } else {
1145 	char	*file = gn->path ? gn->path : gn->name;
1146 
1147 	times.actime = times.modtime = now;
1148 	if (utime(file, &times) < 0){
1149 	    streamID = open(file, O_RDWR | O_CREAT, 0666);
1150 
1151 	    if (streamID >= 0) {
1152 		char	c;
1153 
1154 		/*
1155 		 * Read and write a byte to the file to change the
1156 		 * modification time, then close the file.
1157 		 */
1158 		if (read(streamID, &c, 1) == 1) {
1159 		    (void)lseek(streamID, (off_t)0, SEEK_SET);
1160 		    (void)write(streamID, &c, 1);
1161 		}
1162 
1163 		(void)close(streamID);
1164 	    } else {
1165 		(void)fprintf(stdout, "*** couldn't touch %s: %s",
1166 			       file, strerror(errno));
1167 		(void)fflush(stdout);
1168 	    }
1169 	}
1170     }
1171 }
1172 
1173 /*-
1174  *-----------------------------------------------------------------------
1175  * Job_CheckCommands --
1176  *	Make sure the given node has all the commands it needs.
1177  *
1178  * Input:
1179  *	gn		The target whose commands need verifying
1180  *	abortProc	Function to abort with message
1181  *
1182  * Results:
1183  *	TRUE if the commands list is/was ok.
1184  *
1185  * Side Effects:
1186  *	The node will have commands from the .DEFAULT rule added to it
1187  *	if it needs them.
1188  *-----------------------------------------------------------------------
1189  */
1190 Boolean
1191 Job_CheckCommands(GNode *gn, void (*abortProc)(const char *, ...))
1192 {
1193     if (OP_NOP(gn->type) && Lst_IsEmpty(gn->commands) &&
1194 	((gn->type & OP_LIB) == 0 || Lst_IsEmpty(gn->children))) {
1195 	/*
1196 	 * No commands. Look for .DEFAULT rule from which we might infer
1197 	 * commands
1198 	 */
1199 	if ((DEFAULT != NULL) && !Lst_IsEmpty(DEFAULT->commands) &&
1200 		(gn->type & OP_SPECIAL) == 0) {
1201 	    char *p1;
1202 	    /*
1203 	     * Make only looks for a .DEFAULT if the node was never the
1204 	     * target of an operator, so that's what we do too. If
1205 	     * a .DEFAULT was given, we substitute its commands for gn's
1206 	     * commands and set the IMPSRC variable to be the target's name
1207 	     * The DEFAULT node acts like a transformation rule, in that
1208 	     * gn also inherits any attributes or sources attached to
1209 	     * .DEFAULT itself.
1210 	     */
1211 	    Make_HandleUse(DEFAULT, gn);
1212 	    Var_Set(IMPSRC, Var_Value(TARGET, gn, &p1), gn, 0);
1213 	    if (p1)
1214 		free(p1);
1215 	} else if (Dir_MTime(gn) == 0 && (gn->type & OP_SPECIAL) == 0) {
1216 	    /*
1217 	     * The node wasn't the target of an operator we have no .DEFAULT
1218 	     * rule to go on and the target doesn't already exist. There's
1219 	     * nothing more we can do for this branch. If the -k flag wasn't
1220 	     * given, we stop in our tracks, otherwise we just don't update
1221 	     * this node's parents so they never get examined.
1222 	     */
1223 	    static const char msg[] = ": don't know how to make";
1224 
1225 	    if (gn->flags & FROM_DEPEND) {
1226 		fprintf(stdout, "%s: ignoring stale .depend for %s\n",
1227 			progname, gn->name);
1228 		return TRUE;
1229 	    }
1230 
1231 	    if (gn->type & OP_OPTIONAL) {
1232 		(void)fprintf(stdout, "%s%s %s(ignored)\n", progname,
1233 		    msg, gn->name);
1234 		(void)fflush(stdout);
1235 	    } else if (keepgoing) {
1236 		(void)fprintf(stdout, "%s%s %s(continuing)\n", progname,
1237 		    msg, gn->name);
1238 		(void)fflush(stdout);
1239   		return FALSE;
1240 	    } else {
1241 		(*abortProc)("%s%s %s. Stop", progname, msg, gn->name);
1242 		return FALSE;
1243 	    }
1244 	}
1245     }
1246     return TRUE;
1247 }
1248 
1249 /*-
1250  *-----------------------------------------------------------------------
1251  * JobExec --
1252  *	Execute the shell for the given job. Called from JobStart
1253  *
1254  * Input:
1255  *	job		Job to execute
1256  *
1257  * Results:
1258  *	None.
1259  *
1260  * Side Effects:
1261  *	A shell is executed, outputs is altered and the Job structure added
1262  *	to the job table.
1263  *
1264  *-----------------------------------------------------------------------
1265  */
1266 static void
1267 JobExec(Job *job, char **argv)
1268 {
1269     int	    	  cpid;	    	/* ID of new child */
1270     sigset_t	  mask;
1271 
1272     job->flags &= ~JOB_TRACED;
1273 
1274     if (DEBUG(JOB)) {
1275 	int 	  i;
1276 
1277 	(void)fprintf(debug_file, "Running %s %sly\n", job->node->name, "local");
1278 	(void)fprintf(debug_file, "\tCommand: ");
1279 	for (i = 0; argv[i] != NULL; i++) {
1280 	    (void)fprintf(debug_file, "%s ", argv[i]);
1281 	}
1282  	(void)fprintf(debug_file, "\n");
1283     }
1284 
1285     /*
1286      * Some jobs produce no output and it's disconcerting to have
1287      * no feedback of their running (since they produce no output, the
1288      * banner with their name in it never appears). This is an attempt to
1289      * provide that feedback, even if nothing follows it.
1290      */
1291     if ((lastNode != job->node) && !(job->flags & JOB_SILENT)) {
1292 	MESSAGE(stdout, job->node);
1293 	lastNode = job->node;
1294     }
1295 
1296     /* No interruptions until this job is on the `jobs' list */
1297     JobSigLock(&mask);
1298 
1299     /* Pre-emptively mark job running, pid still zero though */
1300     job->job_state = JOB_ST_RUNNING;
1301 
1302     cpid = vfork();
1303     if (cpid == -1)
1304 	Punt("Cannot vfork: %s", strerror(errno));
1305 
1306     if (cpid == 0) {
1307 	/* Child */
1308 
1309 	/*
1310 	 * Reset all signal handlers; this is necessary because we also
1311 	 * need to unblock signals before we exec(2).
1312 	 */
1313 	JobSigReset();
1314 
1315 	/* Now unblock signals */
1316 	sigemptyset(&mask);
1317 	JobSigUnlock(&mask);
1318 
1319 	/*
1320 	 * Must duplicate the input stream down to the child's input and
1321 	 * reset it to the beginning (again). Since the stream was marked
1322 	 * close-on-exec, we must clear that bit in the new input.
1323 	 */
1324 	if (dup2(FILENO(job->cmdFILE), 0) == -1) {
1325 	    execError("dup2", "job->cmdFILE");
1326 	    _exit(1);
1327 	}
1328 	(void)fcntl(0, F_SETFD, 0);
1329 	(void)lseek(0, (off_t)0, SEEK_SET);
1330 
1331 	if (job->node->type & OP_MAKE) {
1332 		/*
1333 		 * Pass job token pipe to submakes.
1334 		 */
1335 		fcntl(tokenWaitJob.inPipe, F_SETFD, 0);
1336 		fcntl(tokenWaitJob.outPipe, F_SETFD, 0);
1337 	}
1338 
1339 	/*
1340 	 * Set up the child's output to be routed through the pipe
1341 	 * we've created for it.
1342 	 */
1343 	if (dup2(job->outPipe, 1) == -1) {
1344 	    execError("dup2", "job->outPipe");
1345 	    _exit(1);
1346 	}
1347 	/*
1348 	 * The output channels are marked close on exec. This bit was
1349 	 * duplicated by the dup2(on some systems), so we have to clear
1350 	 * it before routing the shell's error output to the same place as
1351 	 * its standard output.
1352 	 */
1353 	(void)fcntl(1, F_SETFD, 0);
1354 	if (dup2(1, 2) == -1) {
1355 	    execError("dup2", "1, 2");
1356 	    _exit(1);
1357 	}
1358 
1359 	/*
1360 	 * We want to switch the child into a different process family so
1361 	 * we can kill it and all its descendants in one fell swoop,
1362 	 * by killing its process family, but not commit suicide.
1363 	 */
1364 #if defined(SYSV)
1365 	/* XXX: dsl - I'm sure this should be setpgrp()... */
1366 	(void)setsid();
1367 #else
1368 	(void)setpgid(0, getpid());
1369 #endif
1370 
1371 	Var_ExportVars();
1372 
1373 	(void)execv(shellPath, argv);
1374 	execError("exec", shellPath);
1375 	_exit(1);
1376     }
1377 
1378     /* Parent, continuing after the child exec */
1379     job->pid = cpid;
1380 
1381     Trace_Log(JOBSTART, job);
1382 
1383     /*
1384      * Set the current position in the buffer to the beginning
1385      * and mark another stream to watch in the outputs mask
1386      */
1387     job->curPos = 0;
1388 
1389     watchfd(job);
1390 
1391     if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
1392 	(void)fclose(job->cmdFILE);
1393 	job->cmdFILE = NULL;
1394     }
1395 
1396     /*
1397      * Now the job is actually running, add it to the table.
1398      */
1399     if (DEBUG(JOB)) {
1400 	fprintf(debug_file, "JobExec(%s): pid %d added to jobs table\n",
1401 		job->node->name, job->pid);
1402 	job_table_dump("job started");
1403     }
1404     JobSigUnlock(&mask);
1405 }
1406 
1407 /*-
1408  *-----------------------------------------------------------------------
1409  * JobMakeArgv --
1410  *	Create the argv needed to execute the shell for a given job.
1411  *
1412  *
1413  * Results:
1414  *
1415  * Side Effects:
1416  *
1417  *-----------------------------------------------------------------------
1418  */
1419 static void
1420 JobMakeArgv(Job *job, char **argv)
1421 {
1422     int	    	  argc;
1423     static char args[10]; 	/* For merged arguments */
1424 
1425     argv[0] = UNCONST(shellName);
1426     argc = 1;
1427 
1428     if ((commandShell->exit && (*commandShell->exit != '-')) ||
1429 	(commandShell->echo && (*commandShell->echo != '-')))
1430     {
1431 	/*
1432 	 * At least one of the flags doesn't have a minus before it, so
1433 	 * merge them together. Have to do this because the *(&(@*#*&#$#
1434 	 * Bourne shell thinks its second argument is a file to source.
1435 	 * Grrrr. Note the ten-character limitation on the combined arguments.
1436 	 */
1437 	(void)snprintf(args, sizeof(args), "-%s%s",
1438 		      ((job->flags & JOB_IGNERR) ? "" :
1439 		       (commandShell->exit ? commandShell->exit : "")),
1440 		      ((job->flags & JOB_SILENT) ? "" :
1441 		       (commandShell->echo ? commandShell->echo : "")));
1442 
1443 	if (args[1]) {
1444 	    argv[argc] = args;
1445 	    argc++;
1446 	}
1447     } else {
1448 	if (!(job->flags & JOB_IGNERR) && commandShell->exit) {
1449 	    argv[argc] = UNCONST(commandShell->exit);
1450 	    argc++;
1451 	}
1452 	if (!(job->flags & JOB_SILENT) && commandShell->echo) {
1453 	    argv[argc] = UNCONST(commandShell->echo);
1454 	    argc++;
1455 	}
1456     }
1457     argv[argc] = NULL;
1458 }
1459 
1460 /*-
1461  *-----------------------------------------------------------------------
1462  * JobStart  --
1463  *	Start a target-creation process going for the target described
1464  *	by the graph node gn.
1465  *
1466  * Input:
1467  *	gn		target to create
1468  *	flags		flags for the job to override normal ones.
1469  *			e.g. JOB_SPECIAL or JOB_IGNDOTS
1470  *	previous	The previous Job structure for this node, if any.
1471  *
1472  * Results:
1473  *	JOB_ERROR if there was an error in the commands, JOB_FINISHED
1474  *	if there isn't actually anything left to do for the job and
1475  *	JOB_RUNNING if the job has been started.
1476  *
1477  * Side Effects:
1478  *	A new Job node is created and added to the list of running
1479  *	jobs. PMake is forked and a child shell created.
1480  *
1481  * NB: I'm fairly sure that this code is never called with JOB_SPECIAL set
1482  *     JOB_IGNDOTS is never set (dsl)
1483  *     Also the return value is ignored by everyone.
1484  *-----------------------------------------------------------------------
1485  */
1486 static int
1487 JobStart(GNode *gn, int flags)
1488 {
1489     Job		  *job;       /* new job descriptor */
1490     char	  *argv[10];  /* Argument vector to shell */
1491     Boolean	  cmdsOK;     /* true if the nodes commands were all right */
1492     Boolean 	  noExec;     /* Set true if we decide not to run the job */
1493     int		  tfd;	      /* File descriptor to the temp file */
1494 
1495     for (job = job_table; job < job_table_end; job++) {
1496 	if (job->job_state == JOB_ST_FREE)
1497 	    break;
1498     }
1499     if (job >= job_table_end)
1500 	Punt("JobStart no job slots vacant");
1501 
1502     memset(job, 0, sizeof *job);
1503     job->job_state = JOB_ST_SETUP;
1504     if (gn->type & OP_SPECIAL)
1505 	flags |= JOB_SPECIAL;
1506 
1507     job->node = gn;
1508     job->tailCmds = NULL;
1509 
1510     /*
1511      * Set the initial value of the flags for this job based on the global
1512      * ones and the node's attributes... Any flags supplied by the caller
1513      * are also added to the field.
1514      */
1515     job->flags = 0;
1516     if (Targ_Ignore(gn)) {
1517 	job->flags |= JOB_IGNERR;
1518     }
1519     if (Targ_Silent(gn)) {
1520 	job->flags |= JOB_SILENT;
1521     }
1522     job->flags |= flags;
1523 
1524     /*
1525      * Check the commands now so any attributes from .DEFAULT have a chance
1526      * to migrate to the node
1527      */
1528     cmdsOK = Job_CheckCommands(gn, Error);
1529 
1530     job->inPollfd = NULL;
1531     /*
1532      * If the -n flag wasn't given, we open up OUR (not the child's)
1533      * temporary file to stuff commands in it. The thing is rd/wr so we don't
1534      * need to reopen it to feed it to the shell. If the -n flag *was* given,
1535      * we just set the file to be stdout. Cute, huh?
1536      */
1537     if (((gn->type & OP_MAKE) && !(noRecursiveExecute)) ||
1538 	    (!noExecute && !touchFlag)) {
1539 	/*
1540 	 * tfile is the name of a file into which all shell commands are
1541 	 * put. It is used over by removing it before the child shell is
1542 	 * executed. The XXXXXX in the string are replaced by the pid of
1543 	 * the make process in a 6-character field with leading zeroes.
1544 	 */
1545 	char     tfile[sizeof(TMPPAT)];
1546 	sigset_t mask;
1547 	/*
1548 	 * We're serious here, but if the commands were bogus, we're
1549 	 * also dead...
1550 	 */
1551 	if (!cmdsOK) {
1552 	    DieHorribly();
1553 	}
1554 
1555 	JobSigLock(&mask);
1556 	(void)strcpy(tfile, TMPPAT);
1557 	if ((tfd = mkstemp(tfile)) == -1)
1558 	    Punt("Could not create temporary file %s", strerror(errno));
1559 	if (!DEBUG(SCRIPT))
1560 		(void)eunlink(tfile);
1561 	JobSigUnlock(&mask);
1562 
1563 	job->cmdFILE = fdopen(tfd, "w+");
1564 	if (job->cmdFILE == NULL) {
1565 	    Punt("Could not fdopen %s", tfile);
1566 	}
1567 	(void)fcntl(FILENO(job->cmdFILE), F_SETFD, 1);
1568 	/*
1569 	 * Send the commands to the command file, flush all its buffers then
1570 	 * rewind and remove the thing.
1571 	 */
1572 	noExec = FALSE;
1573 
1574 	/*
1575 	 * We can do all the commands at once. hooray for sanity
1576 	 */
1577 	numCommands = 0;
1578 	Lst_ForEach(gn->commands, JobPrintCommand, job);
1579 
1580 	/*
1581 	 * If we didn't print out any commands to the shell script,
1582 	 * there's not much point in executing the shell, is there?
1583 	 */
1584 	if (numCommands == 0) {
1585 	    noExec = TRUE;
1586 	}
1587     } else if (NoExecute(gn)) {
1588 	/*
1589 	 * Not executing anything -- just print all the commands to stdout
1590 	 * in one fell swoop. This will still set up job->tailCmds correctly.
1591 	 */
1592 	if (lastNode != gn) {
1593 	    MESSAGE(stdout, gn);
1594 	    lastNode = gn;
1595 	}
1596 	job->cmdFILE = stdout;
1597 	/*
1598 	 * Only print the commands if they're ok, but don't die if they're
1599 	 * not -- just let the user know they're bad and keep going. It
1600 	 * doesn't do any harm in this case and may do some good.
1601 	 */
1602 	if (cmdsOK) {
1603 	    Lst_ForEach(gn->commands, JobPrintCommand, job);
1604 	}
1605 	/*
1606 	 * Don't execute the shell, thank you.
1607 	 */
1608 	noExec = TRUE;
1609     } else {
1610 	/*
1611 	 * Just touch the target and note that no shell should be executed.
1612 	 * Set cmdFILE to stdout to make life easier. Check the commands, too,
1613 	 * but don't die if they're no good -- it does no harm to keep working
1614 	 * up the graph.
1615 	 */
1616 	job->cmdFILE = stdout;
1617     	Job_Touch(gn, job->flags&JOB_SILENT);
1618 	noExec = TRUE;
1619     }
1620     /* Just in case it isn't already... */
1621     (void)fflush(job->cmdFILE);
1622 
1623     /*
1624      * If we're not supposed to execute a shell, don't.
1625      */
1626     if (noExec) {
1627 	if (!(job->flags & JOB_SPECIAL))
1628 	    Job_TokenReturn();
1629 	/*
1630 	 * Unlink and close the command file if we opened one
1631 	 */
1632 	if (job->cmdFILE != stdout) {
1633 	    if (job->cmdFILE != NULL) {
1634 		(void)fclose(job->cmdFILE);
1635 		job->cmdFILE = NULL;
1636 	    }
1637 	}
1638 
1639 	/*
1640 	 * We only want to work our way up the graph if we aren't here because
1641 	 * the commands for the job were no good.
1642 	 */
1643 	if (cmdsOK && aborting == 0) {
1644 	    if (job->tailCmds != NULL) {
1645 		Lst_ForEachFrom(job->node->commands, job->tailCmds,
1646 				JobSaveCommand,
1647 			       job->node);
1648 	    }
1649 	    job->node->made = MADE;
1650 	    Make_Update(job->node);
1651 	}
1652 	job->job_state = JOB_ST_FREE;
1653 	return cmdsOK ? JOB_FINISHED : JOB_ERROR;
1654     }
1655 
1656     /*
1657      * Set up the control arguments to the shell. This is based on the flags
1658      * set earlier for this job.
1659      */
1660     JobMakeArgv(job, argv);
1661 
1662     /* Create the pipe by which we'll get the shell's output.  */
1663     JobCreatePipe(job, 3);
1664 
1665     JobExec(job, argv);
1666     return(JOB_RUNNING);
1667 }
1668 
1669 static char *
1670 JobOutput(Job *job, char *cp, char *endp, int msg)
1671 {
1672     char *ecp;
1673 
1674     if (commandShell->noPrint) {
1675 	ecp = Str_FindSubstring(cp, commandShell->noPrint);
1676 	while (ecp != NULL) {
1677 	    if (cp != ecp) {
1678 		*ecp = '\0';
1679 		if (!beSilent && msg && job->node != lastNode) {
1680 		    MESSAGE(stdout, job->node);
1681 		    lastNode = job->node;
1682 		}
1683 		/*
1684 		 * The only way there wouldn't be a newline after
1685 		 * this line is if it were the last in the buffer.
1686 		 * however, since the non-printable comes after it,
1687 		 * there must be a newline, so we don't print one.
1688 		 */
1689 		(void)fprintf(stdout, "%s", cp);
1690 		(void)fflush(stdout);
1691 	    }
1692 	    cp = ecp + commandShell->noPLen;
1693 	    if (cp != endp) {
1694 		/*
1695 		 * Still more to print, look again after skipping
1696 		 * the whitespace following the non-printable
1697 		 * command....
1698 		 */
1699 		cp++;
1700 		while (*cp == ' ' || *cp == '\t' || *cp == '\n') {
1701 		    cp++;
1702 		}
1703 		ecp = Str_FindSubstring(cp, commandShell->noPrint);
1704 	    } else {
1705 		return cp;
1706 	    }
1707 	}
1708     }
1709     return cp;
1710 }
1711 
1712 /*-
1713  *-----------------------------------------------------------------------
1714  * JobDoOutput  --
1715  *	This function is called at different times depending on
1716  *	whether the user has specified that output is to be collected
1717  *	via pipes or temporary files. In the former case, we are called
1718  *	whenever there is something to read on the pipe. We collect more
1719  *	output from the given job and store it in the job's outBuf. If
1720  *	this makes up a line, we print it tagged by the job's identifier,
1721  *	as necessary.
1722  *	If output has been collected in a temporary file, we open the
1723  *	file and read it line by line, transfering it to our own
1724  *	output channel until the file is empty. At which point we
1725  *	remove the temporary file.
1726  *	In both cases, however, we keep our figurative eye out for the
1727  *	'noPrint' line for the shell from which the output came. If
1728  *	we recognize a line, we don't print it. If the command is not
1729  *	alone on the line (the character after it is not \0 or \n), we
1730  *	do print whatever follows it.
1731  *
1732  * Input:
1733  *	job		the job whose output needs printing
1734  *	finish		TRUE if this is the last time we'll be called
1735  *			for this job
1736  *
1737  * Results:
1738  *	None
1739  *
1740  * Side Effects:
1741  *	curPos may be shifted as may the contents of outBuf.
1742  *-----------------------------------------------------------------------
1743  */
1744 STATIC void
1745 JobDoOutput(Job *job, Boolean finish)
1746 {
1747     Boolean       gotNL = FALSE;  /* true if got a newline */
1748     Boolean       fbuf;  	  /* true if our buffer filled up */
1749     int		  nr;	      	  /* number of bytes read */
1750     int		  i;	      	  /* auxiliary index into outBuf */
1751     int		  max;	      	  /* limit for i (end of current data) */
1752     int		  nRead;      	  /* (Temporary) number of bytes read */
1753 
1754     /*
1755      * Read as many bytes as will fit in the buffer.
1756      */
1757 end_loop:
1758     gotNL = FALSE;
1759     fbuf = FALSE;
1760 
1761     nRead = read(job->inPipe, &job->outBuf[job->curPos],
1762 		     JOB_BUFSIZE - job->curPos);
1763     if (nRead < 0) {
1764 	if (errno == EAGAIN)
1765 	    return;
1766 	if (DEBUG(JOB)) {
1767 	    perror("JobDoOutput(piperead)");
1768 	}
1769 	nr = 0;
1770     } else {
1771 	nr = nRead;
1772     }
1773 
1774     /*
1775      * If we hit the end-of-file (the job is dead), we must flush its
1776      * remaining output, so pretend we read a newline if there's any
1777      * output remaining in the buffer.
1778      * Also clear the 'finish' flag so we stop looping.
1779      */
1780     if ((nr == 0) && (job->curPos != 0)) {
1781 	job->outBuf[job->curPos] = '\n';
1782 	nr = 1;
1783 	finish = FALSE;
1784     } else if (nr == 0) {
1785 	finish = FALSE;
1786     }
1787 
1788     /*
1789      * Look for the last newline in the bytes we just got. If there is
1790      * one, break out of the loop with 'i' as its index and gotNL set
1791      * TRUE.
1792      */
1793     max = job->curPos + nr;
1794     for (i = job->curPos + nr - 1; i >= job->curPos; i--) {
1795 	if (job->outBuf[i] == '\n') {
1796 	    gotNL = TRUE;
1797 	    break;
1798 	} else if (job->outBuf[i] == '\0') {
1799 	    /*
1800 	     * Why?
1801 	     */
1802 	    job->outBuf[i] = ' ';
1803 	}
1804     }
1805 
1806     if (!gotNL) {
1807 	job->curPos += nr;
1808 	if (job->curPos == JOB_BUFSIZE) {
1809 	    /*
1810 	     * If we've run out of buffer space, we have no choice
1811 	     * but to print the stuff. sigh.
1812 	     */
1813 	    fbuf = TRUE;
1814 	    i = job->curPos;
1815 	}
1816     }
1817     if (gotNL || fbuf) {
1818 	/*
1819 	 * Need to send the output to the screen. Null terminate it
1820 	 * first, overwriting the newline character if there was one.
1821 	 * So long as the line isn't one we should filter (according
1822 	 * to the shell description), we print the line, preceded
1823 	 * by a target banner if this target isn't the same as the
1824 	 * one for which we last printed something.
1825 	 * The rest of the data in the buffer are then shifted down
1826 	 * to the start of the buffer and curPos is set accordingly.
1827 	 */
1828 	job->outBuf[i] = '\0';
1829 	if (i >= job->curPos) {
1830 	    char *cp;
1831 
1832 	    cp = JobOutput(job, job->outBuf, &job->outBuf[i], FALSE);
1833 
1834 	    /*
1835 	     * There's still more in that thar buffer. This time, though,
1836 	     * we know there's no newline at the end, so we add one of
1837 	     * our own free will.
1838 	     */
1839 	    if (*cp != '\0') {
1840 		if (!beSilent && job->node != lastNode) {
1841 		    MESSAGE(stdout, job->node);
1842 		    lastNode = job->node;
1843 		}
1844 		(void)fprintf(stdout, "%s%s", cp, gotNL ? "\n" : "");
1845 		(void)fflush(stdout);
1846 	    }
1847 	}
1848 	if (i < max - 1) {
1849 	    /* shift the remaining characters down */
1850 	    (void)memcpy(job->outBuf, &job->outBuf[i + 1], max - (i + 1));
1851 	    job->curPos = max - (i + 1);
1852 
1853 	} else {
1854 	    /*
1855 	     * We have written everything out, so we just start over
1856 	     * from the start of the buffer. No copying. No nothing.
1857 	     */
1858 	    job->curPos = 0;
1859 	}
1860     }
1861     if (finish) {
1862 	/*
1863 	 * If the finish flag is true, we must loop until we hit
1864 	 * end-of-file on the pipe. This is guaranteed to happen
1865 	 * eventually since the other end of the pipe is now closed
1866 	 * (we closed it explicitly and the child has exited). When
1867 	 * we do get an EOF, finish will be set FALSE and we'll fall
1868 	 * through and out.
1869 	 */
1870 	goto end_loop;
1871     }
1872 }
1873 
1874 static void
1875 JobRun(GNode *targ)
1876 {
1877 #ifdef notyet
1878     /*
1879      * Unfortunately it is too complicated to run .BEGIN, .END,
1880      * and .INTERRUPT job in the parallel job module. This has
1881      * the nice side effect that it avoids a lot of other problems.
1882      */
1883     Lst lst = Lst_Init(FALSE);
1884     Lst_AtEnd(lst, targ);
1885     (void)Make_Run(lst);
1886     Lst_Destroy(lst, NULL);
1887     JobStart(targ, JOB_SPECIAL);
1888     while (jobTokensRunning) {
1889 	Job_CatchOutput();
1890     }
1891 #else
1892     Compat_Make(targ, targ);
1893     if (targ->made == ERROR) {
1894 	PrintOnError("\n\nStop.");
1895 	exit(1);
1896     }
1897 #endif
1898 }
1899 
1900 /*-
1901  *-----------------------------------------------------------------------
1902  * Job_CatchChildren --
1903  *	Handle the exit of a child. Called from Make_Make.
1904  *
1905  * Input:
1906  *	block		TRUE if should block on the wait
1907  *
1908  * Results:
1909  *	none.
1910  *
1911  * Side Effects:
1912  *	The job descriptor is removed from the list of children.
1913  *
1914  * Notes:
1915  *	We do waits, blocking or not, according to the wisdom of our
1916  *	caller, until there are no more children to report. For each
1917  *	job, call JobFinish to finish things off.
1918  *
1919  *-----------------------------------------------------------------------
1920  */
1921 
1922 void
1923 Job_CatchChildren(void)
1924 {
1925     int    	  pid;	    	/* pid of dead child */
1926     Job		  *job;	    	/* job descriptor for dead child */
1927     int	  	  status;   	/* Exit/termination status */
1928 
1929     /*
1930      * Don't even bother if we know there's no one around.
1931      */
1932     if (jobTokensRunning == 0)
1933 	return;
1934 
1935     while ((pid = waitpid((pid_t) -1, &status, WNOHANG | WUNTRACED)) > 0) {
1936 	if (DEBUG(JOB)) {
1937 	    (void)fprintf(debug_file, "Process %d exited/stopped status %x.\n", pid,
1938 	      status);
1939 	}
1940 
1941 	job = JobFindPid(pid, JOB_ST_RUNNING);
1942 	if (job == NULL) {
1943 	    if (!lurking_children)
1944 		Error("Child (%d) status %x not in table?", pid, status);
1945 	    continue;
1946 	}
1947 	if (WIFSTOPPED(status)) {
1948 	    if (DEBUG(JOB)) {
1949 		(void)fprintf(debug_file, "Process %d (%s) stopped.\n",
1950 				job->pid, job->node->name);
1951 	    }
1952 	    if (!make_suspended) {
1953 		    switch (WSTOPSIG(status)) {
1954 		    case SIGTSTP:
1955 			(void)printf("*** [%s] Suspended\n", job->node->name);
1956 			break;
1957 		    case SIGSTOP:
1958 			(void)printf("*** [%s] Stopped\n", job->node->name);
1959 			break;
1960 		    default:
1961 			(void)printf("*** [%s] Stopped -- signal %d\n",
1962 			    job->node->name, WSTOPSIG(status));
1963 		    }
1964 		    job->job_suspended = 1;
1965 	    }
1966 	    (void)fflush(stdout);
1967 	    continue;
1968 	}
1969 
1970 	job->job_state = JOB_ST_FINISHED;
1971 	job->exit_status = status;
1972 
1973 	JobFinish(job, status);
1974     }
1975 }
1976 
1977 /*-
1978  *-----------------------------------------------------------------------
1979  * Job_CatchOutput --
1980  *	Catch the output from our children, if we're using
1981  *	pipes do so. Otherwise just block time until we get a
1982  *	signal(most likely a SIGCHLD) since there's no point in
1983  *	just spinning when there's nothing to do and the reaping
1984  *	of a child can wait for a while.
1985  *
1986  * Results:
1987  *	None
1988  *
1989  * Side Effects:
1990  *	Output is read from pipes if we're piping.
1991  * -----------------------------------------------------------------------
1992  */
1993 void
1994 Job_CatchOutput(void)
1995 {
1996     int nready;
1997     Job *job;
1998     int i;
1999 
2000     (void)fflush(stdout);
2001 
2002     /* The first fd in the list is the job token pipe */
2003     nready = poll(fds + 1 - wantToken, nfds - 1 + wantToken, POLL_MSEC);
2004 
2005     if (nready < 0 || readyfd(&childExitJob)) {
2006 	char token = 0;
2007 	nready -= 1;
2008 	(void)read(childExitJob.inPipe, &token, 1);
2009 	if (token == DO_JOB_RESUME[0])
2010 	    /* Complete relay requested from our SIGCONT handler */
2011 	    JobRestartJobs();
2012 	Job_CatchChildren();
2013     }
2014 
2015     if (nready <= 0)
2016 	return;
2017 
2018     if (wantToken && readyfd(&tokenWaitJob))
2019 	nready--;
2020 
2021     for (i = 2; i < nfds; i++) {
2022 	if (!fds[i].revents)
2023 	    continue;
2024 	job = jobfds[i];
2025 	if (job->job_state != JOB_ST_RUNNING)
2026 	    continue;
2027 	JobDoOutput(job, FALSE);
2028     }
2029 }
2030 
2031 /*-
2032  *-----------------------------------------------------------------------
2033  * Job_Make --
2034  *	Start the creation of a target. Basically a front-end for
2035  *	JobStart used by the Make module.
2036  *
2037  * Results:
2038  *	None.
2039  *
2040  * Side Effects:
2041  *	Another job is started.
2042  *
2043  *-----------------------------------------------------------------------
2044  */
2045 void
2046 Job_Make(GNode *gn)
2047 {
2048     (void)JobStart(gn, 0);
2049 }
2050 
2051 void
2052 Shell_Init(void)
2053 {
2054     if (shellPath == NULL) {
2055 	/*
2056 	 * We are using the default shell, which may be an absolute
2057 	 * path if DEFSHELL_CUSTOM is defined.
2058 	 */
2059 	shellName = commandShell->name;
2060 #ifdef DEFSHELL_CUSTOM
2061 	if (*shellName == '/') {
2062 	    shellPath = shellName;
2063 	    shellName = strrchr(shellPath, '/');
2064 	    shellName++;
2065 	} else
2066 #endif
2067 	shellPath = str_concat(_PATH_DEFSHELLDIR, shellName, STR_ADDSLASH);
2068     }
2069     if (commandShell->exit == NULL) {
2070 	commandShell->exit = "";
2071     }
2072     if (commandShell->echo == NULL) {
2073 	commandShell->echo = "";
2074     }
2075 }
2076 
2077 /*-
2078  * Returns the string literal that is used in the current command shell
2079  * to produce a newline character.
2080  */
2081 const char *
2082 Shell_GetNewline(void)
2083 {
2084 
2085     return commandShell->newline;
2086 }
2087 
2088 void
2089 Job_SetPrefix(void)
2090 {
2091 
2092     if (targPrefix) {
2093 	free(targPrefix);
2094     } else if (!Var_Exists(MAKE_JOB_PREFIX, VAR_GLOBAL)) {
2095 	Var_Set(MAKE_JOB_PREFIX, "---", VAR_GLOBAL, 0);
2096     }
2097 
2098     targPrefix = Var_Subst(NULL, "${" MAKE_JOB_PREFIX "}", VAR_GLOBAL, 0);
2099 }
2100 
2101 /*-
2102  *-----------------------------------------------------------------------
2103  * Job_Init --
2104  *	Initialize the process module
2105  *
2106  * Input:
2107  *
2108  * Results:
2109  *	none
2110  *
2111  * Side Effects:
2112  *	lists and counters are initialized
2113  *-----------------------------------------------------------------------
2114  */
2115 void
2116 Job_Init(void)
2117 {
2118     GNode         *begin;     /* node for commands to do at the very start */
2119 
2120     /* Allocate space for all the job info */
2121     job_table = bmake_malloc(maxJobs * sizeof *job_table);
2122     memset(job_table, 0, maxJobs * sizeof *job_table);
2123     job_table_end = job_table + maxJobs;
2124     wantToken =	0;
2125 
2126     aborting = 	  0;
2127     errors = 	  0;
2128 
2129     lastNode =	  NULL;
2130 
2131     if (maxJobs == 1) {
2132 	/*
2133 	 * If only one job can run at a time, there's no need for a banner,
2134 	 * is there?
2135 	 */
2136 	targFmt = "";
2137     } else {
2138 	targFmt = TARG_FMT;
2139     }
2140 
2141     /*
2142      * There is a non-zero chance that we already have children.
2143      * eg after 'make -f- <<EOF'
2144      * Since their termination causes a 'Child (pid) not in table' message,
2145      * Collect the status of any that are already dead, and suppress the
2146      * error message if there are any undead ones.
2147      */
2148     for (;;) {
2149 	int rval, status;
2150 	rval = waitpid((pid_t) -1, &status, WNOHANG);
2151 	if (rval > 0)
2152 	    continue;
2153 	if (rval == 0)
2154 	    lurking_children = 1;
2155 	break;
2156     }
2157 
2158     Shell_Init();
2159 
2160     JobCreatePipe(&childExitJob, 3);
2161 
2162     /* We can only need to wait for tokens, children and output from each job */
2163     fds = bmake_malloc(sizeof (*fds) * (2 + maxJobs));
2164     jobfds = bmake_malloc(sizeof (*jobfds) * (2 + maxJobs));
2165 
2166     /* These are permanent entries and take slots 0 and 1 */
2167     watchfd(&tokenWaitJob);
2168     watchfd(&childExitJob);
2169 
2170     sigemptyset(&caught_signals);
2171     /*
2172      * Install a SIGCHLD handler.
2173      */
2174     (void)signal(SIGCHLD, JobChildSig);
2175     sigaddset(&caught_signals, SIGCHLD);
2176 
2177 #define ADDSIG(s,h)				\
2178     if (signal(s, SIG_IGN) != SIG_IGN) {	\
2179 	sigaddset(&caught_signals, s);		\
2180 	(void)signal(s, h);			\
2181     }
2182 
2183     /*
2184      * Catch the four signals that POSIX specifies if they aren't ignored.
2185      * JobPassSig will take care of calling JobInterrupt if appropriate.
2186      */
2187     ADDSIG(SIGINT, JobPassSig_int)
2188     ADDSIG(SIGHUP, JobPassSig_term)
2189     ADDSIG(SIGTERM, JobPassSig_term)
2190     ADDSIG(SIGQUIT, JobPassSig_term)
2191 
2192     /*
2193      * There are additional signals that need to be caught and passed if
2194      * either the export system wants to be told directly of signals or if
2195      * we're giving each job its own process group (since then it won't get
2196      * signals from the terminal driver as we own the terminal)
2197      */
2198     ADDSIG(SIGTSTP, JobPassSig_suspend)
2199     ADDSIG(SIGTTOU, JobPassSig_suspend)
2200     ADDSIG(SIGTTIN, JobPassSig_suspend)
2201     ADDSIG(SIGWINCH, JobCondPassSig)
2202     ADDSIG(SIGCONT, JobContinueSig)
2203 #undef ADDSIG
2204 
2205     begin = Targ_FindNode(".BEGIN", TARG_NOCREATE);
2206 
2207     if (begin != NULL) {
2208 	JobRun(begin);
2209 	if (begin->made == ERROR) {
2210 	    PrintOnError("\n\nStop.");
2211 	    exit(1);
2212 	}
2213     }
2214     postCommands = Targ_FindNode(".END", TARG_CREATE);
2215 }
2216 
2217 static void JobSigReset(void)
2218 {
2219 #define DELSIG(s)					\
2220     if (sigismember(&caught_signals, s)) {		\
2221 	(void)signal(s, SIG_DFL);			\
2222     }
2223 
2224     DELSIG(SIGINT)
2225     DELSIG(SIGHUP)
2226     DELSIG(SIGQUIT)
2227     DELSIG(SIGTERM)
2228     DELSIG(SIGTSTP)
2229     DELSIG(SIGTTOU)
2230     DELSIG(SIGTTIN)
2231     DELSIG(SIGWINCH)
2232     DELSIG(SIGCONT)
2233 #undef DELSIG
2234     (void)signal(SIGCHLD, SIG_DFL);
2235 }
2236 
2237 /*-
2238  *-----------------------------------------------------------------------
2239  * JobMatchShell --
2240  *	Find a shell in 'shells' given its name.
2241  *
2242  * Results:
2243  *	A pointer to the Shell structure.
2244  *
2245  * Side Effects:
2246  *	None.
2247  *
2248  *-----------------------------------------------------------------------
2249  */
2250 static Shell *
2251 JobMatchShell(const char *name)
2252 {
2253     Shell	*sh;
2254 
2255     for (sh = shells; sh->name != NULL; sh++) {
2256 	if (strcmp(name, sh->name) == 0)
2257 		return (sh);
2258     }
2259     return NULL;
2260 }
2261 
2262 /*-
2263  *-----------------------------------------------------------------------
2264  * Job_ParseShell --
2265  *	Parse a shell specification and set up commandShell, shellPath
2266  *	and shellName appropriately.
2267  *
2268  * Input:
2269  *	line		The shell spec
2270  *
2271  * Results:
2272  *	FAILURE if the specification was incorrect.
2273  *
2274  * Side Effects:
2275  *	commandShell points to a Shell structure (either predefined or
2276  *	created from the shell spec), shellPath is the full path of the
2277  *	shell described by commandShell, while shellName is just the
2278  *	final component of shellPath.
2279  *
2280  * Notes:
2281  *	A shell specification consists of a .SHELL target, with dependency
2282  *	operator, followed by a series of blank-separated words. Double
2283  *	quotes can be used to use blanks in words. A backslash escapes
2284  *	anything (most notably a double-quote and a space) and
2285  *	provides the functionality it does in C. Each word consists of
2286  *	keyword and value separated by an equal sign. There should be no
2287  *	unnecessary spaces in the word. The keywords are as follows:
2288  *	    name  	    Name of shell.
2289  *	    path  	    Location of shell.
2290  *	    quiet 	    Command to turn off echoing.
2291  *	    echo  	    Command to turn echoing on
2292  *	    filter	    Result of turning off echoing that shouldn't be
2293  *	    	  	    printed.
2294  *	    echoFlag	    Flag to turn echoing on at the start
2295  *	    errFlag	    Flag to turn error checking on at the start
2296  *	    hasErrCtl	    True if shell has error checking control
2297  *	    newline	    String literal to represent a newline char
2298  *	    check 	    Command to turn on error checking if hasErrCtl
2299  *	    	  	    is TRUE or template of command to echo a command
2300  *	    	  	    for which error checking is off if hasErrCtl is
2301  *	    	  	    FALSE.
2302  *	    ignore	    Command to turn off error checking if hasErrCtl
2303  *	    	  	    is TRUE or template of command to execute a
2304  *	    	  	    command so as to ignore any errors it returns if
2305  *	    	  	    hasErrCtl is FALSE.
2306  *
2307  *-----------------------------------------------------------------------
2308  */
2309 ReturnStatus
2310 Job_ParseShell(char *line)
2311 {
2312     char	**words;
2313     char	**argv;
2314     int		argc;
2315     char	*path;
2316     Shell	newShell;
2317     Boolean	fullSpec = FALSE;
2318     Shell	*sh;
2319 
2320     while (isspace((unsigned char)*line)) {
2321 	line++;
2322     }
2323 
2324     if (shellArgv)
2325 	free(UNCONST(shellArgv));
2326 
2327     memset(&newShell, 0, sizeof(newShell));
2328 
2329     /*
2330      * Parse the specification by keyword
2331      */
2332     words = brk_string(line, &argc, TRUE, &path);
2333     if (words == NULL) {
2334 	Error("Unterminated quoted string [%s]", line);
2335 	return FAILURE;
2336     }
2337     shellArgv = path;
2338 
2339     for (path = NULL, argv = words; argc != 0; argc--, argv++) {
2340 	    if (strncmp(*argv, "path=", 5) == 0) {
2341 		path = &argv[0][5];
2342 	    } else if (strncmp(*argv, "name=", 5) == 0) {
2343 		newShell.name = &argv[0][5];
2344 	    } else {
2345 		if (strncmp(*argv, "quiet=", 6) == 0) {
2346 		    newShell.echoOff = &argv[0][6];
2347 		} else if (strncmp(*argv, "echo=", 5) == 0) {
2348 		    newShell.echoOn = &argv[0][5];
2349 		} else if (strncmp(*argv, "filter=", 7) == 0) {
2350 		    newShell.noPrint = &argv[0][7];
2351 		    newShell.noPLen = strlen(newShell.noPrint);
2352 		} else if (strncmp(*argv, "echoFlag=", 9) == 0) {
2353 		    newShell.echo = &argv[0][9];
2354 		} else if (strncmp(*argv, "errFlag=", 8) == 0) {
2355 		    newShell.exit = &argv[0][8];
2356 		} else if (strncmp(*argv, "hasErrCtl=", 10) == 0) {
2357 		    char c = argv[0][10];
2358 		    newShell.hasErrCtl = !((c != 'Y') && (c != 'y') &&
2359 					   (c != 'T') && (c != 't'));
2360 		} else if (strncmp(*argv, "newline=", 8) == 0) {
2361 		    newShell.newline = &argv[0][8];
2362 		} else if (strncmp(*argv, "check=", 6) == 0) {
2363 		    newShell.errCheck = &argv[0][6];
2364 		} else if (strncmp(*argv, "ignore=", 7) == 0) {
2365 		    newShell.ignErr = &argv[0][7];
2366 		} else if (strncmp(*argv, "errout=", 7) == 0) {
2367 		    newShell.errOut = &argv[0][7];
2368 		} else if (strncmp(*argv, "comment=", 8) == 0) {
2369 		    newShell.commentChar = argv[0][8];
2370 		} else {
2371 		    Parse_Error(PARSE_FATAL, "Unknown keyword \"%s\"",
2372 				*argv);
2373 		    free(words);
2374 		    return(FAILURE);
2375 		}
2376 		fullSpec = TRUE;
2377 	    }
2378     }
2379 
2380     if (path == NULL) {
2381 	/*
2382 	 * If no path was given, the user wants one of the pre-defined shells,
2383 	 * yes? So we find the one s/he wants with the help of JobMatchShell
2384 	 * and set things up the right way. shellPath will be set up by
2385 	 * Job_Init.
2386 	 */
2387 	if (newShell.name == NULL) {
2388 	    Parse_Error(PARSE_FATAL, "Neither path nor name specified");
2389 	    free(words);
2390 	    return(FAILURE);
2391 	} else {
2392 	    if ((sh = JobMatchShell(newShell.name)) == NULL) {
2393 		    Parse_Error(PARSE_WARNING, "%s: No matching shell",
2394 				newShell.name);
2395 		    free(words);
2396 		    return(FAILURE);
2397 	    }
2398 	    commandShell = sh;
2399 	    shellName = newShell.name;
2400 	}
2401     } else {
2402 	/*
2403 	 * The user provided a path. If s/he gave nothing else (fullSpec is
2404 	 * FALSE), try and find a matching shell in the ones we know of.
2405 	 * Else we just take the specification at its word and copy it
2406 	 * to a new location. In either case, we need to record the
2407 	 * path the user gave for the shell.
2408 	 */
2409 	shellPath = path;
2410 	path = strrchr(path, '/');
2411 	if (path == NULL) {
2412 	    path = UNCONST(shellPath);
2413 	} else {
2414 	    path += 1;
2415 	}
2416 	if (newShell.name != NULL) {
2417 	    shellName = newShell.name;
2418 	} else {
2419 	    shellName = path;
2420 	}
2421 	if (!fullSpec) {
2422 	    if ((sh = JobMatchShell(shellName)) == NULL) {
2423 		    Parse_Error(PARSE_WARNING, "%s: No matching shell",
2424 				shellName);
2425 		    free(words);
2426 		    return(FAILURE);
2427 	    }
2428 	    commandShell = sh;
2429 	} else {
2430 	    commandShell = bmake_malloc(sizeof(Shell));
2431 	    *commandShell = newShell;
2432 	}
2433     }
2434 
2435     if (commandShell->echoOn && commandShell->echoOff) {
2436 	commandShell->hasEchoCtl = TRUE;
2437     }
2438 
2439     if (!commandShell->hasErrCtl) {
2440 	if (commandShell->errCheck == NULL) {
2441 	    commandShell->errCheck = "";
2442 	}
2443 	if (commandShell->ignErr == NULL) {
2444 	    commandShell->ignErr = "%s\n";
2445 	}
2446     }
2447 
2448     /*
2449      * Do not free up the words themselves, since they might be in use by the
2450      * shell specification.
2451      */
2452     free(words);
2453     return SUCCESS;
2454 }
2455 
2456 /*-
2457  *-----------------------------------------------------------------------
2458  * JobInterrupt --
2459  *	Handle the receipt of an interrupt.
2460  *
2461  * Input:
2462  *	runINTERRUPT	Non-zero if commands for the .INTERRUPT target
2463  *			should be executed
2464  *	signo		signal received
2465  *
2466  * Results:
2467  *	None
2468  *
2469  * Side Effects:
2470  *	All children are killed. Another job will be started if the
2471  *	.INTERRUPT target was given.
2472  *-----------------------------------------------------------------------
2473  */
2474 static void
2475 JobInterrupt(int runINTERRUPT, int signo)
2476 {
2477     Job		*job;		/* job descriptor in that element */
2478     GNode	*interrupt;	/* the node describing the .INTERRUPT target */
2479     sigset_t	mask;
2480     GNode	*gn;
2481 
2482     aborting = ABORT_INTERRUPT;
2483 
2484     JobSigLock(&mask);
2485 
2486     for (job = job_table; job < job_table_end; job++) {
2487 	if (job->job_state != JOB_ST_RUNNING)
2488 	    continue;
2489 
2490 	gn = job->node;
2491 
2492 	if ((gn->type & (OP_JOIN|OP_PHONY)) == 0 && !Targ_Precious(gn)) {
2493 	    char *file = (gn->path == NULL ? gn->name : gn->path);
2494 	    if (!noExecute && eunlink(file) != -1) {
2495 		Error("*** %s removed", file);
2496 	    }
2497 	}
2498 	if (job->pid) {
2499 	    if (DEBUG(JOB)) {
2500 		(void)fprintf(debug_file,
2501 			   "JobInterrupt passing signal %d to child %d.\n",
2502 			   signo, job->pid);
2503 	    }
2504 	    KILLPG(job->pid, signo);
2505 	}
2506     }
2507 
2508     JobSigUnlock(&mask);
2509 
2510     if (runINTERRUPT && !touchFlag) {
2511 	interrupt = Targ_FindNode(".INTERRUPT", TARG_NOCREATE);
2512 	if (interrupt != NULL) {
2513 	    ignoreErrors = FALSE;
2514 	    JobRun(interrupt);
2515 	}
2516     }
2517     Trace_Log(MAKEINTR, 0);
2518     exit(signo);
2519 }
2520 
2521 /*
2522  *-----------------------------------------------------------------------
2523  * Job_Finish --
2524  *	Do final processing such as the running of the commands
2525  *	attached to the .END target.
2526  *
2527  * Results:
2528  *	Number of errors reported.
2529  *
2530  * Side Effects:
2531  *	None.
2532  *-----------------------------------------------------------------------
2533  */
2534 int
2535 Job_Finish(void)
2536 {
2537     if (postCommands != NULL &&
2538 	(!Lst_IsEmpty(postCommands->commands) ||
2539 	 !Lst_IsEmpty(postCommands->children))) {
2540 	if (errors) {
2541 	    Error("Errors reported so .END ignored");
2542 	} else {
2543 	    JobRun(postCommands);
2544 	}
2545     }
2546     return(errors);
2547 }
2548 
2549 /*-
2550  *-----------------------------------------------------------------------
2551  * Job_End --
2552  *	Cleanup any memory used by the jobs module
2553  *
2554  * Results:
2555  *	None.
2556  *
2557  * Side Effects:
2558  *	Memory is freed
2559  *-----------------------------------------------------------------------
2560  */
2561 void
2562 Job_End(void)
2563 {
2564 #ifdef CLEANUP
2565     if (shellArgv)
2566 	free(shellArgv);
2567 #endif
2568 }
2569 
2570 /*-
2571  *-----------------------------------------------------------------------
2572  * Job_Wait --
2573  *	Waits for all running jobs to finish and returns. Sets 'aborting'
2574  *	to ABORT_WAIT to prevent other jobs from starting.
2575  *
2576  * Results:
2577  *	None.
2578  *
2579  * Side Effects:
2580  *	Currently running jobs finish.
2581  *
2582  *-----------------------------------------------------------------------
2583  */
2584 void
2585 Job_Wait(void)
2586 {
2587     aborting = ABORT_WAIT;
2588     while (jobTokensRunning != 0) {
2589 	Job_CatchOutput();
2590     }
2591     aborting = 0;
2592 }
2593 
2594 /*-
2595  *-----------------------------------------------------------------------
2596  * Job_AbortAll --
2597  *	Abort all currently running jobs without handling output or anything.
2598  *	This function is to be called only in the event of a major
2599  *	error. Most definitely NOT to be called from JobInterrupt.
2600  *
2601  * Results:
2602  *	None
2603  *
2604  * Side Effects:
2605  *	All children are killed, not just the firstborn
2606  *-----------------------------------------------------------------------
2607  */
2608 void
2609 Job_AbortAll(void)
2610 {
2611     Job		*job;	/* the job descriptor in that element */
2612     int		foo;
2613 
2614     aborting = ABORT_ERROR;
2615 
2616     if (jobTokensRunning) {
2617 	for (job = job_table; job < job_table_end; job++) {
2618 	    if (job->job_state != JOB_ST_RUNNING)
2619 		continue;
2620 	    /*
2621 	     * kill the child process with increasingly drastic signals to make
2622 	     * darn sure it's dead.
2623 	     */
2624 	    KILLPG(job->pid, SIGINT);
2625 	    KILLPG(job->pid, SIGKILL);
2626 	}
2627     }
2628 
2629     /*
2630      * Catch as many children as want to report in at first, then give up
2631      */
2632     while (waitpid((pid_t) -1, &foo, WNOHANG) > 0)
2633 	continue;
2634 }
2635 
2636 
2637 /*-
2638  *-----------------------------------------------------------------------
2639  * JobRestartJobs --
2640  *	Tries to restart stopped jobs if there are slots available.
2641  *	Called in process context in response to a SIGCONT.
2642  *
2643  * Results:
2644  *	None.
2645  *
2646  * Side Effects:
2647  *	Resumes jobs.
2648  *
2649  *-----------------------------------------------------------------------
2650  */
2651 static void
2652 JobRestartJobs(void)
2653 {
2654     Job *job;
2655 
2656     for (job = job_table; job < job_table_end; job++) {
2657 	if (job->job_state == JOB_ST_RUNNING &&
2658 		(make_suspended || job->job_suspended)) {
2659 	    if (DEBUG(JOB)) {
2660 		(void)fprintf(debug_file, "Restarting stopped job pid %d.\n",
2661 			job->pid);
2662 	    }
2663 	    if (job->job_suspended) {
2664 		    (void)printf("*** [%s] Continued\n", job->node->name);
2665 		    (void)fflush(stdout);
2666 	    }
2667 	    job->job_suspended = 0;
2668 	    if (KILLPG(job->pid, SIGCONT) != 0 && DEBUG(JOB)) {
2669 		fprintf(debug_file, "Failed to send SIGCONT to %d\n", job->pid);
2670 	    }
2671 	}
2672 	if (job->job_state == JOB_ST_FINISHED)
2673 	    /* Job exit deferred after calling waitpid() in a signal handler */
2674 	    JobFinish(job, job->exit_status);
2675     }
2676     make_suspended = 0;
2677 }
2678 
2679 static void
2680 watchfd(Job *job)
2681 {
2682     if (job->inPollfd != NULL)
2683 	Punt("Watching watched job");
2684 
2685     fds[nfds].fd = job->inPipe;
2686     fds[nfds].events = POLLIN;
2687     jobfds[nfds] = job;
2688     job->inPollfd = &fds[nfds];
2689     nfds++;
2690 }
2691 
2692 static void
2693 clearfd(Job *job)
2694 {
2695     int i;
2696     if (job->inPollfd == NULL)
2697 	Punt("Unwatching unwatched job");
2698     i = job->inPollfd - fds;
2699     nfds--;
2700     /*
2701      * Move last job in table into hole made by dead job.
2702      */
2703     if (nfds != i) {
2704 	fds[i] = fds[nfds];
2705 	jobfds[i] = jobfds[nfds];
2706 	jobfds[i]->inPollfd = &fds[i];
2707     }
2708     job->inPollfd = NULL;
2709 }
2710 
2711 static int
2712 readyfd(Job *job)
2713 {
2714     if (job->inPollfd == NULL)
2715 	Punt("Polling unwatched job");
2716     return (job->inPollfd->revents & POLLIN) != 0;
2717 }
2718 
2719 /*-
2720  *-----------------------------------------------------------------------
2721  * JobTokenAdd --
2722  *	Put a token into the job pipe so that some make process can start
2723  *	another job.
2724  *
2725  * Side Effects:
2726  *	Allows more build jobs to be spawned somewhere.
2727  *
2728  *-----------------------------------------------------------------------
2729  */
2730 
2731 static void
2732 JobTokenAdd(void)
2733 {
2734     char tok = JOB_TOKENS[aborting], tok1;
2735 
2736     /* If we are depositing an error token flush everything else */
2737     while (tok != '+' && read(tokenWaitJob.inPipe, &tok1, 1) == 1)
2738 	continue;
2739 
2740     if (DEBUG(JOB))
2741 	fprintf(debug_file, "(%d) aborting %d, deposit token %c\n",
2742 	    getpid(), aborting, JOB_TOKENS[aborting]);
2743     write(tokenWaitJob.outPipe, &tok, 1);
2744 }
2745 
2746 /*-
2747  *-----------------------------------------------------------------------
2748  * Job_ServerStartTokenAdd --
2749  *	Prep the job token pipe in the root make process.
2750  *
2751  *-----------------------------------------------------------------------
2752  */
2753 
2754 void
2755 Job_ServerStart(int max_tokens, int jp_0, int jp_1)
2756 {
2757     int i;
2758     char jobarg[64];
2759 
2760     if (jp_0 >= 0 && jp_1 >= 0) {
2761 	/* Pipe passed in from parent */
2762 	tokenWaitJob.inPipe = jp_0;
2763 	tokenWaitJob.outPipe = jp_1;
2764 	return;
2765     }
2766 
2767     JobCreatePipe(&tokenWaitJob, 15);
2768 
2769     snprintf(jobarg, sizeof(jobarg), "%d,%d",
2770 	    tokenWaitJob.inPipe, tokenWaitJob.outPipe);
2771 
2772     Var_Append(MAKEFLAGS, "-J", VAR_GLOBAL);
2773     Var_Append(MAKEFLAGS, jobarg, VAR_GLOBAL);
2774 
2775     /*
2776      * Preload the job pipe with one token per job, save the one
2777      * "extra" token for the primary job.
2778      *
2779      * XXX should clip maxJobs against PIPE_BUF -- if max_tokens is
2780      * larger than the write buffer size of the pipe, we will
2781      * deadlock here.
2782      */
2783     for (i = 1; i < max_tokens; i++)
2784 	JobTokenAdd();
2785 }
2786 
2787 /*-
2788  *-----------------------------------------------------------------------
2789  * Job_TokenReturn --
2790  *	Return a withdrawn token to the pool.
2791  *
2792  *-----------------------------------------------------------------------
2793  */
2794 
2795 void
2796 Job_TokenReturn(void)
2797 {
2798     jobTokensRunning--;
2799     if (jobTokensRunning < 0)
2800 	Punt("token botch");
2801     if (jobTokensRunning || JOB_TOKENS[aborting] != '+')
2802 	JobTokenAdd();
2803 }
2804 
2805 /*-
2806  *-----------------------------------------------------------------------
2807  * Job_TokenWithdraw --
2808  *	Attempt to withdraw a token from the pool.
2809  *
2810  * Results:
2811  *	Returns TRUE if a token was withdrawn, and FALSE if the pool
2812  *	is currently empty.
2813  *
2814  * Side Effects:
2815  * 	If pool is empty, set wantToken so that we wake up
2816  *	when a token is released.
2817  *
2818  *-----------------------------------------------------------------------
2819  */
2820 
2821 
2822 Boolean
2823 Job_TokenWithdraw(void)
2824 {
2825     char tok, tok1;
2826     int count;
2827 
2828     wantToken = 0;
2829     if (DEBUG(JOB))
2830 	fprintf(debug_file, "Job_TokenWithdraw(%d): aborting %d, running %d\n",
2831 		getpid(), aborting, jobTokensRunning);
2832 
2833     if (aborting || (jobTokensRunning >= maxJobs))
2834 	return FALSE;
2835 
2836     count = read(tokenWaitJob.inPipe, &tok, 1);
2837     if (count == 0)
2838 	Fatal("eof on job pipe!");
2839     if (count < 0 && jobTokensRunning != 0) {
2840 	if (errno != EAGAIN) {
2841 	    Fatal("job pipe read: %s", strerror(errno));
2842 	}
2843 	if (DEBUG(JOB))
2844 	    fprintf(debug_file, "(%d) blocked for token\n", getpid());
2845 	wantToken = 1;
2846 	return FALSE;
2847     }
2848 
2849     if (count == 1 && tok != '+') {
2850 	/* make being abvorted - remove any other job tokens */
2851 	if (DEBUG(JOB))
2852 	    fprintf(debug_file, "(%d) aborted by token %c\n", getpid(), tok);
2853 	while (read(tokenWaitJob.inPipe, &tok1, 1) == 1)
2854 	    continue;
2855 	/* And put the stopper back */
2856 	write(tokenWaitJob.outPipe, &tok, 1);
2857 	Fatal("A failure has been detected in another branch of the parallel make");
2858     }
2859 
2860     if (count == 1 && jobTokensRunning == 0)
2861 	/* We didn't want the token really */
2862 	write(tokenWaitJob.outPipe, &tok, 1);
2863 
2864     jobTokensRunning++;
2865     if (DEBUG(JOB))
2866 	fprintf(debug_file, "(%d) withdrew token\n", getpid());
2867     return TRUE;
2868 }
2869 
2870 #ifdef USE_SELECT
2871 int
2872 emul_poll(struct pollfd *fd, int nfd, int timeout)
2873 {
2874     fd_set rfds, wfds;
2875     int i, maxfd, nselect, npoll;
2876     struct timeval tv, *tvp;
2877     long usecs;
2878 
2879     FD_ZERO(&rfds);
2880     FD_ZERO(&wfds);
2881 
2882     maxfd = -1;
2883     for (i = 0; i < nfd; i++) {
2884 	fd[i].revents = 0;
2885 
2886 	if (fd[i].events & POLLIN)
2887 	    FD_SET(fd[i].fd, &rfds);
2888 
2889 	if (fd[i].events & POLLOUT)
2890 	    FD_SET(fd[i].fd, &wfds);
2891 
2892 	if (fd[i].fd > maxfd)
2893 	    maxfd = fd[i].fd;
2894     }
2895 
2896     if (maxfd >= FD_SETSIZE) {
2897 	Punt("Ran out of fd_set slots; "
2898 	     "recompile with a larger FD_SETSIZE.");
2899     }
2900 
2901     if (timeout < 0) {
2902 	tvp = NULL;
2903     } else {
2904 	usecs = timeout * 1000;
2905 	tv.tv_sec = usecs / 1000000;
2906 	tv.tv_usec = usecs % 1000000;
2907         tvp = &tv;
2908     }
2909 
2910     nselect = select(maxfd + 1, &rfds, &wfds, 0, tvp);
2911 
2912     if (nselect <= 0)
2913 	return nselect;
2914 
2915     npoll = 0;
2916     for (i = 0; i < nfd; i++) {
2917 	if (FD_ISSET(fd[i].fd, &rfds))
2918 	    fd[i].revents |= POLLIN;
2919 
2920 	if (FD_ISSET(fd[i].fd, &wfds))
2921 	    fd[i].revents |= POLLOUT;
2922 
2923 	if (fd[i].revents)
2924 	    npoll++;
2925     }
2926 
2927     return npoll;
2928 }
2929 #endif /* USE_SELECT */
2930