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