contrib/bmake/job.c

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