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