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