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