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