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