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