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