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