1 /* $NetBSD: job.c,v 1.186 2016/02/18 18:29:14 christos Exp $ */ 2 3 /* 4 * Copyright (c) 1988, 1989, 1990 The Regents of the University of California. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to Berkeley by 8 * Adam de Boor. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. Neither the name of the University nor the names of its contributors 19 * may be used to endorse or promote products derived from this software 20 * without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 * SUCH DAMAGE. 33 */ 34 35 /* 36 * Copyright (c) 1988, 1989 by Adam de Boor 37 * Copyright (c) 1989 by Berkeley Softworks 38 * All rights reserved. 39 * 40 * This code is derived from software contributed to Berkeley by 41 * Adam de Boor. 42 * 43 * Redistribution and use in source and binary forms, with or without 44 * modification, are permitted provided that the following conditions 45 * are met: 46 * 1. Redistributions of source code must retain the above copyright 47 * notice, this list of conditions and the following disclaimer. 48 * 2. Redistributions in binary form must reproduce the above copyright 49 * notice, this list of conditions and the following disclaimer in the 50 * documentation and/or other materials provided with the distribution. 51 * 3. All advertising materials mentioning features or use of this software 52 * must display the following acknowledgement: 53 * This product includes software developed by the University of 54 * California, Berkeley and its contributors. 55 * 4. Neither the name of the University nor the names of its contributors 56 * may be used to endorse or promote products derived from this software 57 * without specific prior written permission. 58 * 59 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 60 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 61 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 62 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 63 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 64 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 65 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 66 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 67 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 68 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 69 * SUCH DAMAGE. 70 */ 71 72 #ifndef MAKE_NATIVE 73 static char rcsid[] = "$NetBSD: job.c,v 1.186 2016/02/18 18:29:14 christos Exp $"; 74 #else 75 #include <sys/cdefs.h> 76 #ifndef lint 77 #if 0 78 static char sccsid[] = "@(#)job.c 8.2 (Berkeley) 3/19/94"; 79 #else 80 __RCSID("$NetBSD: job.c,v 1.186 2016/02/18 18:29:14 christos Exp $"); 81 #endif 82 #endif /* not lint */ 83 #endif 84 85 /*- 86 * job.c -- 87 * handle the creation etc. of our child processes. 88 * 89 * Interface: 90 * Job_Make Start the creation of the given target. 91 * 92 * Job_CatchChildren Check for and handle the termination of any 93 * children. This must be called reasonably 94 * frequently to keep the whole make going at 95 * a decent clip, since job table entries aren't 96 * removed until their process is caught this way. 97 * 98 * Job_CatchOutput Print any output our children have produced. 99 * Should also be called fairly frequently to 100 * keep the user informed of what's going on. 101 * If no output is waiting, it will block for 102 * a time given by the SEL_* constants, below, 103 * or until output is ready. 104 * 105 * Job_Init Called to intialize this module. in addition, 106 * any commands attached to the .BEGIN target 107 * are executed before this function returns. 108 * Hence, the makefile must have been parsed 109 * before this function is called. 110 * 111 * Job_End Cleanup any memory used. 112 * 113 * Job_ParseShell Given the line following a .SHELL target, parse 114 * the line as a shell specification. Returns 115 * FAILURE if the spec was incorrect. 116 * 117 * Job_Finish Perform any final processing which needs doing. 118 * This includes the execution of any commands 119 * which have been/were attached to the .END 120 * target. It should only be called when the 121 * job table is empty. 122 * 123 * Job_AbortAll Abort all currently running jobs. It doesn't 124 * handle output or do anything for the jobs, 125 * just kills them. It should only be called in 126 * an emergency, as it were. 127 * 128 * Job_CheckCommands Verify that the commands for a target are 129 * ok. Provide them if necessary and possible. 130 * 131 * Job_Touch Update a target without really updating it. 132 * 133 * Job_Wait Wait for all currently-running jobs to finish. 134 */ 135 136 #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 meta_job_finish(job); 1076 } 1077 #endif 1078 1079 return_job_token = FALSE; 1080 1081 Trace_Log(JOBEND, job); 1082 if (!(job->flags & JOB_SPECIAL)) { 1083 if ((WAIT_STATUS(status) != 0) || 1084 (aborting == ABORT_ERROR) || 1085 (aborting == ABORT_INTERRUPT)) 1086 return_job_token = TRUE; 1087 } 1088 1089 if ((aborting != ABORT_ERROR) && (aborting != ABORT_INTERRUPT) && 1090 (WAIT_STATUS(status) == 0)) { 1091 /* 1092 * As long as we aren't aborting and the job didn't return a non-zero 1093 * status that we shouldn't ignore, we call Make_Update to update 1094 * the parents. In addition, any saved commands for the node are placed 1095 * on the .END target. 1096 */ 1097 if (job->tailCmds != NULL) { 1098 Lst_ForEachFrom(job->node->commands, job->tailCmds, 1099 JobSaveCommand, 1100 job->node); 1101 } 1102 job->node->made = MADE; 1103 if (!(job->flags & JOB_SPECIAL)) 1104 return_job_token = TRUE; 1105 Make_Update(job->node); 1106 job->job_state = JOB_ST_FREE; 1107 } else if (WAIT_STATUS(status)) { 1108 errors += 1; 1109 job->job_state = JOB_ST_FREE; 1110 } 1111 1112 /* 1113 * Set aborting if any error. 1114 */ 1115 if (errors && !keepgoing && (aborting != ABORT_INTERRUPT)) { 1116 /* 1117 * If we found any errors in this batch of children and the -k flag 1118 * wasn't given, we set the aborting flag so no more jobs get 1119 * started. 1120 */ 1121 aborting = ABORT_ERROR; 1122 } 1123 1124 if (return_job_token) 1125 Job_TokenReturn(); 1126 1127 if (aborting == ABORT_ERROR && jobTokensRunning == 0) { 1128 /* 1129 * If we are aborting and the job table is now empty, we finish. 1130 */ 1131 Finish(errors); 1132 } 1133 } 1134 1135 /*- 1136 *----------------------------------------------------------------------- 1137 * Job_Touch -- 1138 * Touch the given target. Called by JobStart when the -t flag was 1139 * given 1140 * 1141 * Input: 1142 * gn the node of the file to touch 1143 * silent TRUE if should not print message 1144 * 1145 * Results: 1146 * None 1147 * 1148 * Side Effects: 1149 * The data modification of the file is changed. In addition, if the 1150 * file did not exist, it is created. 1151 *----------------------------------------------------------------------- 1152 */ 1153 void 1154 Job_Touch(GNode *gn, Boolean silent) 1155 { 1156 int streamID; /* ID of stream opened to do the touch */ 1157 struct utimbuf times; /* Times for utime() call */ 1158 1159 if (gn->type & (OP_JOIN|OP_USE|OP_USEBEFORE|OP_EXEC|OP_OPTIONAL| 1160 OP_SPECIAL|OP_PHONY)) { 1161 /* 1162 * .JOIN, .USE, .ZEROTIME and .OPTIONAL targets are "virtual" targets 1163 * and, as such, shouldn't really be created. 1164 */ 1165 return; 1166 } 1167 1168 if (!silent || NoExecute(gn)) { 1169 (void)fprintf(stdout, "touch %s\n", gn->name); 1170 (void)fflush(stdout); 1171 } 1172 1173 if (NoExecute(gn)) { 1174 return; 1175 } 1176 1177 if (gn->type & OP_ARCHV) { 1178 Arch_Touch(gn); 1179 } else if (gn->type & OP_LIB) { 1180 Arch_TouchLib(gn); 1181 } else { 1182 char *file = gn->path ? gn->path : gn->name; 1183 1184 times.actime = times.modtime = now; 1185 if (utime(file, ×) < 0){ 1186 streamID = open(file, O_RDWR | O_CREAT, 0666); 1187 1188 if (streamID >= 0) { 1189 char c; 1190 1191 /* 1192 * Read and write a byte to the file to change the 1193 * modification time, then close the file. 1194 */ 1195 if (read(streamID, &c, 1) == 1) { 1196 (void)lseek(streamID, (off_t)0, SEEK_SET); 1197 while (write(streamID, &c, 1) == -1 && errno == EAGAIN) 1198 continue; 1199 } 1200 1201 (void)close(streamID); 1202 } else { 1203 (void)fprintf(stdout, "*** couldn't touch %s: %s", 1204 file, strerror(errno)); 1205 (void)fflush(stdout); 1206 } 1207 } 1208 } 1209 } 1210 1211 /*- 1212 *----------------------------------------------------------------------- 1213 * Job_CheckCommands -- 1214 * Make sure the given node has all the commands it needs. 1215 * 1216 * Input: 1217 * gn The target whose commands need verifying 1218 * abortProc Function to abort with message 1219 * 1220 * Results: 1221 * TRUE if the commands list is/was ok. 1222 * 1223 * Side Effects: 1224 * The node will have commands from the .DEFAULT rule added to it 1225 * if it needs them. 1226 *----------------------------------------------------------------------- 1227 */ 1228 Boolean 1229 Job_CheckCommands(GNode *gn, void (*abortProc)(const char *, ...)) 1230 { 1231 if (OP_NOP(gn->type) && Lst_IsEmpty(gn->commands) && 1232 ((gn->type & OP_LIB) == 0 || Lst_IsEmpty(gn->children))) { 1233 /* 1234 * No commands. Look for .DEFAULT rule from which we might infer 1235 * commands 1236 */ 1237 if ((DEFAULT != NULL) && !Lst_IsEmpty(DEFAULT->commands) && 1238 (gn->type & OP_SPECIAL) == 0) { 1239 char *p1; 1240 /* 1241 * Make only looks for a .DEFAULT if the node was never the 1242 * target of an operator, so that's what we do too. If 1243 * a .DEFAULT was given, we substitute its commands for gn's 1244 * commands and set the IMPSRC variable to be the target's name 1245 * The DEFAULT node acts like a transformation rule, in that 1246 * gn also inherits any attributes or sources attached to 1247 * .DEFAULT itself. 1248 */ 1249 Make_HandleUse(DEFAULT, gn); 1250 Var_Set(IMPSRC, Var_Value(TARGET, gn, &p1), gn, 0); 1251 free(p1); 1252 } else if (Dir_MTime(gn, 0) == 0 && (gn->type & OP_SPECIAL) == 0) { 1253 /* 1254 * The node wasn't the target of an operator we have no .DEFAULT 1255 * rule to go on and the target doesn't already exist. There's 1256 * nothing more we can do for this branch. If the -k flag wasn't 1257 * given, we stop in our tracks, otherwise we just don't update 1258 * this node's parents so they never get examined. 1259 */ 1260 static const char msg[] = ": don't know how to make"; 1261 1262 if (gn->flags & FROM_DEPEND) { 1263 if (!Job_RunTarget(".STALE", gn->fname)) 1264 fprintf(stdout, "%s: %s, %d: ignoring stale %s for %s\n", 1265 progname, gn->fname, gn->lineno, makeDependfile, 1266 gn->name); 1267 return TRUE; 1268 } 1269 1270 if (gn->type & OP_OPTIONAL) { 1271 (void)fprintf(stdout, "%s%s %s (ignored)\n", progname, 1272 msg, gn->name); 1273 (void)fflush(stdout); 1274 } else if (keepgoing) { 1275 (void)fprintf(stdout, "%s%s %s (continuing)\n", progname, 1276 msg, gn->name); 1277 (void)fflush(stdout); 1278 return FALSE; 1279 } else { 1280 (*abortProc)("%s%s %s. Stop", progname, msg, gn->name); 1281 return FALSE; 1282 } 1283 } 1284 } 1285 return TRUE; 1286 } 1287 1288 /*- 1289 *----------------------------------------------------------------------- 1290 * JobExec -- 1291 * Execute the shell for the given job. Called from JobStart 1292 * 1293 * Input: 1294 * job Job to execute 1295 * 1296 * Results: 1297 * None. 1298 * 1299 * Side Effects: 1300 * A shell is executed, outputs is altered and the Job structure added 1301 * to the job table. 1302 * 1303 *----------------------------------------------------------------------- 1304 */ 1305 static void 1306 JobExec(Job *job, char **argv) 1307 { 1308 int cpid; /* ID of new child */ 1309 sigset_t mask; 1310 1311 job->flags &= ~JOB_TRACED; 1312 1313 if (DEBUG(JOB)) { 1314 int i; 1315 1316 (void)fprintf(debug_file, "Running %s %sly\n", job->node->name, "local"); 1317 (void)fprintf(debug_file, "\tCommand: "); 1318 for (i = 0; argv[i] != NULL; i++) { 1319 (void)fprintf(debug_file, "%s ", argv[i]); 1320 } 1321 (void)fprintf(debug_file, "\n"); 1322 } 1323 1324 /* 1325 * Some jobs produce no output and it's disconcerting to have 1326 * no feedback of their running (since they produce no output, the 1327 * banner with their name in it never appears). This is an attempt to 1328 * provide that feedback, even if nothing follows it. 1329 */ 1330 if ((lastNode != job->node) && !(job->flags & JOB_SILENT)) { 1331 MESSAGE(stdout, job->node); 1332 lastNode = job->node; 1333 } 1334 1335 /* No interruptions until this job is on the `jobs' list */ 1336 JobSigLock(&mask); 1337 1338 /* Pre-emptively mark job running, pid still zero though */ 1339 job->job_state = JOB_ST_RUNNING; 1340 1341 cpid = vFork(); 1342 if (cpid == -1) 1343 Punt("Cannot vfork: %s", strerror(errno)); 1344 1345 if (cpid == 0) { 1346 /* Child */ 1347 sigset_t tmask; 1348 1349 #ifdef USE_META 1350 if (useMeta) { 1351 meta_job_child(job); 1352 } 1353 #endif 1354 /* 1355 * Reset all signal handlers; this is necessary because we also 1356 * need to unblock signals before we exec(2). 1357 */ 1358 JobSigReset(); 1359 1360 /* Now unblock signals */ 1361 sigemptyset(&tmask); 1362 JobSigUnlock(&tmask); 1363 1364 /* 1365 * Must duplicate the input stream down to the child's input and 1366 * reset it to the beginning (again). Since the stream was marked 1367 * close-on-exec, we must clear that bit in the new input. 1368 */ 1369 if (dup2(FILENO(job->cmdFILE), 0) == -1) { 1370 execError("dup2", "job->cmdFILE"); 1371 _exit(1); 1372 } 1373 (void)fcntl(0, F_SETFD, 0); 1374 (void)lseek(0, (off_t)0, SEEK_SET); 1375 1376 if (Always_pass_job_queue || 1377 (job->node->type & (OP_MAKE | OP_SUBMAKE))) { 1378 /* 1379 * Pass job token pipe to submakes. 1380 */ 1381 fcntl(tokenWaitJob.inPipe, F_SETFD, 0); 1382 fcntl(tokenWaitJob.outPipe, F_SETFD, 0); 1383 } 1384 1385 /* 1386 * Set up the child's output to be routed through the pipe 1387 * we've created for it. 1388 */ 1389 if (dup2(job->outPipe, 1) == -1) { 1390 execError("dup2", "job->outPipe"); 1391 _exit(1); 1392 } 1393 /* 1394 * The output channels are marked close on exec. This bit was 1395 * duplicated by the dup2(on some systems), so we have to clear 1396 * it before routing the shell's error output to the same place as 1397 * its standard output. 1398 */ 1399 (void)fcntl(1, F_SETFD, 0); 1400 if (dup2(1, 2) == -1) { 1401 execError("dup2", "1, 2"); 1402 _exit(1); 1403 } 1404 1405 /* 1406 * We want to switch the child into a different process family so 1407 * we can kill it and all its descendants in one fell swoop, 1408 * by killing its process family, but not commit suicide. 1409 */ 1410 #if defined(HAVE_SETPGID) 1411 (void)setpgid(0, getpid()); 1412 #else 1413 #if defined(HAVE_SETSID) 1414 /* XXX: dsl - I'm sure this should be setpgrp()... */ 1415 (void)setsid(); 1416 #else 1417 (void)setpgrp(0, getpid()); 1418 #endif 1419 #endif 1420 1421 Var_ExportVars(); 1422 1423 (void)execv(shellPath, argv); 1424 execError("exec", shellPath); 1425 _exit(1); 1426 } 1427 1428 /* Parent, continuing after the child exec */ 1429 job->pid = cpid; 1430 1431 Trace_Log(JOBSTART, job); 1432 1433 /* 1434 * Set the current position in the buffer to the beginning 1435 * and mark another stream to watch in the outputs mask 1436 */ 1437 job->curPos = 0; 1438 1439 watchfd(job); 1440 1441 if (job->cmdFILE != NULL && job->cmdFILE != stdout) { 1442 (void)fclose(job->cmdFILE); 1443 job->cmdFILE = NULL; 1444 } 1445 1446 /* 1447 * Now the job is actually running, add it to the table. 1448 */ 1449 if (DEBUG(JOB)) { 1450 fprintf(debug_file, "JobExec(%s): pid %d added to jobs table\n", 1451 job->node->name, job->pid); 1452 job_table_dump("job started"); 1453 } 1454 JobSigUnlock(&mask); 1455 } 1456 1457 /*- 1458 *----------------------------------------------------------------------- 1459 * JobMakeArgv -- 1460 * Create the argv needed to execute the shell for a given job. 1461 * 1462 * 1463 * Results: 1464 * 1465 * Side Effects: 1466 * 1467 *----------------------------------------------------------------------- 1468 */ 1469 static void 1470 JobMakeArgv(Job *job, char **argv) 1471 { 1472 int argc; 1473 static char args[10]; /* For merged arguments */ 1474 1475 argv[0] = UNCONST(shellName); 1476 argc = 1; 1477 1478 if ((commandShell->exit && (*commandShell->exit != '-')) || 1479 (commandShell->echo && (*commandShell->echo != '-'))) 1480 { 1481 /* 1482 * At least one of the flags doesn't have a minus before it, so 1483 * merge them together. Have to do this because the *(&(@*#*&#$# 1484 * Bourne shell thinks its second argument is a file to source. 1485 * Grrrr. Note the ten-character limitation on the combined arguments. 1486 */ 1487 (void)snprintf(args, sizeof(args), "-%s%s", 1488 ((job->flags & JOB_IGNERR) ? "" : 1489 (commandShell->exit ? commandShell->exit : "")), 1490 ((job->flags & JOB_SILENT) ? "" : 1491 (commandShell->echo ? commandShell->echo : ""))); 1492 1493 if (args[1]) { 1494 argv[argc] = args; 1495 argc++; 1496 } 1497 } else { 1498 if (!(job->flags & JOB_IGNERR) && commandShell->exit) { 1499 argv[argc] = UNCONST(commandShell->exit); 1500 argc++; 1501 } 1502 if (!(job->flags & JOB_SILENT) && commandShell->echo) { 1503 argv[argc] = UNCONST(commandShell->echo); 1504 argc++; 1505 } 1506 } 1507 argv[argc] = NULL; 1508 } 1509 1510 /*- 1511 *----------------------------------------------------------------------- 1512 * JobStart -- 1513 * Start a target-creation process going for the target described 1514 * by the graph node gn. 1515 * 1516 * Input: 1517 * gn target to create 1518 * flags flags for the job to override normal ones. 1519 * e.g. JOB_SPECIAL or JOB_IGNDOTS 1520 * previous The previous Job structure for this node, if any. 1521 * 1522 * Results: 1523 * JOB_ERROR if there was an error in the commands, JOB_FINISHED 1524 * if there isn't actually anything left to do for the job and 1525 * JOB_RUNNING if the job has been started. 1526 * 1527 * Side Effects: 1528 * A new Job node is created and added to the list of running 1529 * jobs. PMake is forked and a child shell created. 1530 * 1531 * NB: I'm fairly sure that this code is never called with JOB_SPECIAL set 1532 * JOB_IGNDOTS is never set (dsl) 1533 * Also the return value is ignored by everyone. 1534 *----------------------------------------------------------------------- 1535 */ 1536 static int 1537 JobStart(GNode *gn, int flags) 1538 { 1539 Job *job; /* new job descriptor */ 1540 char *argv[10]; /* Argument vector to shell */ 1541 Boolean cmdsOK; /* true if the nodes commands were all right */ 1542 Boolean noExec; /* Set true if we decide not to run the job */ 1543 int tfd; /* File descriptor to the temp file */ 1544 1545 for (job = job_table; job < job_table_end; job++) { 1546 if (job->job_state == JOB_ST_FREE) 1547 break; 1548 } 1549 if (job >= job_table_end) 1550 Punt("JobStart no job slots vacant"); 1551 1552 memset(job, 0, sizeof *job); 1553 job->job_state = JOB_ST_SETUP; 1554 if (gn->type & OP_SPECIAL) 1555 flags |= JOB_SPECIAL; 1556 1557 job->node = gn; 1558 job->tailCmds = NULL; 1559 1560 /* 1561 * Set the initial value of the flags for this job based on the global 1562 * ones and the node's attributes... Any flags supplied by the caller 1563 * are also added to the field. 1564 */ 1565 job->flags = 0; 1566 if (Targ_Ignore(gn)) { 1567 job->flags |= JOB_IGNERR; 1568 } 1569 if (Targ_Silent(gn)) { 1570 job->flags |= JOB_SILENT; 1571 } 1572 job->flags |= flags; 1573 1574 /* 1575 * Check the commands now so any attributes from .DEFAULT have a chance 1576 * to migrate to the node 1577 */ 1578 cmdsOK = Job_CheckCommands(gn, Error); 1579 1580 job->inPollfd = NULL; 1581 /* 1582 * If the -n flag wasn't given, we open up OUR (not the child's) 1583 * temporary file to stuff commands in it. The thing is rd/wr so we don't 1584 * need to reopen it to feed it to the shell. If the -n flag *was* given, 1585 * we just set the file to be stdout. Cute, huh? 1586 */ 1587 if (((gn->type & OP_MAKE) && !(noRecursiveExecute)) || 1588 (!noExecute && !touchFlag)) { 1589 /* 1590 * tfile is the name of a file into which all shell commands are 1591 * put. It is removed before the child shell is executed, unless 1592 * DEBUG(SCRIPT) is set. 1593 */ 1594 char *tfile; 1595 sigset_t mask; 1596 /* 1597 * We're serious here, but if the commands were bogus, we're 1598 * also dead... 1599 */ 1600 if (!cmdsOK) { 1601 PrintOnError(gn, NULL); /* provide some clue */ 1602 DieHorribly(); 1603 } 1604 1605 JobSigLock(&mask); 1606 tfd = mkTempFile(TMPPAT, &tfile); 1607 if (!DEBUG(SCRIPT)) 1608 (void)eunlink(tfile); 1609 JobSigUnlock(&mask); 1610 1611 job->cmdFILE = fdopen(tfd, "w+"); 1612 if (job->cmdFILE == NULL) { 1613 Punt("Could not fdopen %s", tfile); 1614 } 1615 (void)fcntl(FILENO(job->cmdFILE), F_SETFD, FD_CLOEXEC); 1616 /* 1617 * Send the commands to the command file, flush all its buffers then 1618 * rewind and remove the thing. 1619 */ 1620 noExec = FALSE; 1621 1622 #ifdef USE_META 1623 if (useMeta) { 1624 meta_job_start(job, gn); 1625 if (Targ_Silent(gn)) { /* might have changed */ 1626 job->flags |= JOB_SILENT; 1627 } 1628 } 1629 #endif 1630 /* 1631 * We can do all the commands at once. hooray for sanity 1632 */ 1633 numCommands = 0; 1634 Lst_ForEach(gn->commands, JobPrintCommand, job); 1635 1636 /* 1637 * If we didn't print out any commands to the shell script, 1638 * there's not much point in executing the shell, is there? 1639 */ 1640 if (numCommands == 0) { 1641 noExec = TRUE; 1642 } 1643 1644 free(tfile); 1645 } else if (NoExecute(gn)) { 1646 /* 1647 * Not executing anything -- just print all the commands to stdout 1648 * in one fell swoop. This will still set up job->tailCmds correctly. 1649 */ 1650 if (lastNode != gn) { 1651 MESSAGE(stdout, gn); 1652 lastNode = gn; 1653 } 1654 job->cmdFILE = stdout; 1655 /* 1656 * Only print the commands if they're ok, but don't die if they're 1657 * not -- just let the user know they're bad and keep going. It 1658 * doesn't do any harm in this case and may do some good. 1659 */ 1660 if (cmdsOK) { 1661 Lst_ForEach(gn->commands, JobPrintCommand, job); 1662 } 1663 /* 1664 * Don't execute the shell, thank you. 1665 */ 1666 noExec = TRUE; 1667 } else { 1668 /* 1669 * Just touch the target and note that no shell should be executed. 1670 * Set cmdFILE to stdout to make life easier. Check the commands, too, 1671 * but don't die if they're no good -- it does no harm to keep working 1672 * up the graph. 1673 */ 1674 job->cmdFILE = stdout; 1675 Job_Touch(gn, job->flags&JOB_SILENT); 1676 noExec = TRUE; 1677 } 1678 /* Just in case it isn't already... */ 1679 (void)fflush(job->cmdFILE); 1680 1681 /* 1682 * If we're not supposed to execute a shell, don't. 1683 */ 1684 if (noExec) { 1685 if (!(job->flags & JOB_SPECIAL)) 1686 Job_TokenReturn(); 1687 /* 1688 * Unlink and close the command file if we opened one 1689 */ 1690 if (job->cmdFILE != stdout) { 1691 if (job->cmdFILE != NULL) { 1692 (void)fclose(job->cmdFILE); 1693 job->cmdFILE = NULL; 1694 } 1695 } 1696 1697 /* 1698 * We only want to work our way up the graph if we aren't here because 1699 * the commands for the job were no good. 1700 */ 1701 if (cmdsOK && aborting == 0) { 1702 if (job->tailCmds != NULL) { 1703 Lst_ForEachFrom(job->node->commands, job->tailCmds, 1704 JobSaveCommand, 1705 job->node); 1706 } 1707 job->node->made = MADE; 1708 Make_Update(job->node); 1709 } 1710 job->job_state = JOB_ST_FREE; 1711 return cmdsOK ? JOB_FINISHED : JOB_ERROR; 1712 } 1713 1714 /* 1715 * Set up the control arguments to the shell. This is based on the flags 1716 * set earlier for this job. 1717 */ 1718 JobMakeArgv(job, argv); 1719 1720 /* Create the pipe by which we'll get the shell's output. */ 1721 JobCreatePipe(job, 3); 1722 1723 JobExec(job, argv); 1724 return(JOB_RUNNING); 1725 } 1726 1727 static char * 1728 JobOutput(Job *job, char *cp, char *endp, int msg) 1729 { 1730 char *ecp; 1731 1732 if (commandShell->noPrint) { 1733 ecp = Str_FindSubstring(cp, commandShell->noPrint); 1734 while (ecp != NULL) { 1735 if (cp != ecp) { 1736 *ecp = '\0'; 1737 if (!beSilent && msg && job->node != lastNode) { 1738 MESSAGE(stdout, job->node); 1739 lastNode = job->node; 1740 } 1741 /* 1742 * The only way there wouldn't be a newline after 1743 * this line is if it were the last in the buffer. 1744 * however, since the non-printable comes after it, 1745 * there must be a newline, so we don't print one. 1746 */ 1747 (void)fprintf(stdout, "%s", cp); 1748 (void)fflush(stdout); 1749 } 1750 cp = ecp + commandShell->noPLen; 1751 if (cp != endp) { 1752 /* 1753 * Still more to print, look again after skipping 1754 * the whitespace following the non-printable 1755 * command.... 1756 */ 1757 cp++; 1758 while (*cp == ' ' || *cp == '\t' || *cp == '\n') { 1759 cp++; 1760 } 1761 ecp = Str_FindSubstring(cp, commandShell->noPrint); 1762 } else { 1763 return cp; 1764 } 1765 } 1766 } 1767 return cp; 1768 } 1769 1770 /*- 1771 *----------------------------------------------------------------------- 1772 * JobDoOutput -- 1773 * This function is called at different times depending on 1774 * whether the user has specified that output is to be collected 1775 * via pipes or temporary files. In the former case, we are called 1776 * whenever there is something to read on the pipe. We collect more 1777 * output from the given job and store it in the job's outBuf. If 1778 * this makes up a line, we print it tagged by the job's identifier, 1779 * as necessary. 1780 * If output has been collected in a temporary file, we open the 1781 * file and read it line by line, transfering it to our own 1782 * output channel until the file is empty. At which point we 1783 * remove the temporary file. 1784 * In both cases, however, we keep our figurative eye out for the 1785 * 'noPrint' line for the shell from which the output came. If 1786 * we recognize a line, we don't print it. If the command is not 1787 * alone on the line (the character after it is not \0 or \n), we 1788 * do print whatever follows it. 1789 * 1790 * Input: 1791 * job the job whose output needs printing 1792 * finish TRUE if this is the last time we'll be called 1793 * for this job 1794 * 1795 * Results: 1796 * None 1797 * 1798 * Side Effects: 1799 * curPos may be shifted as may the contents of outBuf. 1800 *----------------------------------------------------------------------- 1801 */ 1802 STATIC void 1803 JobDoOutput(Job *job, Boolean finish) 1804 { 1805 Boolean gotNL = FALSE; /* true if got a newline */ 1806 Boolean fbuf; /* true if our buffer filled up */ 1807 int nr; /* number of bytes read */ 1808 int i; /* auxiliary index into outBuf */ 1809 int max; /* limit for i (end of current data) */ 1810 int nRead; /* (Temporary) number of bytes read */ 1811 1812 /* 1813 * Read as many bytes as will fit in the buffer. 1814 */ 1815 end_loop: 1816 gotNL = FALSE; 1817 fbuf = FALSE; 1818 1819 nRead = read(job->inPipe, &job->outBuf[job->curPos], 1820 JOB_BUFSIZE - job->curPos); 1821 if (nRead < 0) { 1822 if (errno == EAGAIN) 1823 return; 1824 if (DEBUG(JOB)) { 1825 perror("JobDoOutput(piperead)"); 1826 } 1827 nr = 0; 1828 } else { 1829 nr = nRead; 1830 } 1831 1832 /* 1833 * If we hit the end-of-file (the job is dead), we must flush its 1834 * remaining output, so pretend we read a newline if there's any 1835 * output remaining in the buffer. 1836 * Also clear the 'finish' flag so we stop looping. 1837 */ 1838 if ((nr == 0) && (job->curPos != 0)) { 1839 job->outBuf[job->curPos] = '\n'; 1840 nr = 1; 1841 finish = FALSE; 1842 } else if (nr == 0) { 1843 finish = FALSE; 1844 } 1845 1846 /* 1847 * Look for the last newline in the bytes we just got. If there is 1848 * one, break out of the loop with 'i' as its index and gotNL set 1849 * TRUE. 1850 */ 1851 max = job->curPos + nr; 1852 for (i = job->curPos + nr - 1; i >= job->curPos; i--) { 1853 if (job->outBuf[i] == '\n') { 1854 gotNL = TRUE; 1855 break; 1856 } else if (job->outBuf[i] == '\0') { 1857 /* 1858 * Why? 1859 */ 1860 job->outBuf[i] = ' '; 1861 } 1862 } 1863 1864 if (!gotNL) { 1865 job->curPos += nr; 1866 if (job->curPos == JOB_BUFSIZE) { 1867 /* 1868 * If we've run out of buffer space, we have no choice 1869 * but to print the stuff. sigh. 1870 */ 1871 fbuf = TRUE; 1872 i = job->curPos; 1873 } 1874 } 1875 if (gotNL || fbuf) { 1876 /* 1877 * Need to send the output to the screen. Null terminate it 1878 * first, overwriting the newline character if there was one. 1879 * So long as the line isn't one we should filter (according 1880 * to the shell description), we print the line, preceded 1881 * by a target banner if this target isn't the same as the 1882 * one for which we last printed something. 1883 * The rest of the data in the buffer are then shifted down 1884 * to the start of the buffer and curPos is set accordingly. 1885 */ 1886 job->outBuf[i] = '\0'; 1887 if (i >= job->curPos) { 1888 char *cp; 1889 1890 cp = JobOutput(job, job->outBuf, &job->outBuf[i], FALSE); 1891 1892 /* 1893 * There's still more in that thar buffer. This time, though, 1894 * we know there's no newline at the end, so we add one of 1895 * our own free will. 1896 */ 1897 if (*cp != '\0') { 1898 if (!beSilent && job->node != lastNode) { 1899 MESSAGE(stdout, job->node); 1900 lastNode = job->node; 1901 } 1902 #ifdef USE_META 1903 if (useMeta) { 1904 meta_job_output(job, cp, gotNL ? "\n" : ""); 1905 } 1906 #endif 1907 (void)fprintf(stdout, "%s%s", cp, gotNL ? "\n" : ""); 1908 (void)fflush(stdout); 1909 } 1910 } 1911 /* 1912 * max is the last offset still in the buffer. Move any remaining 1913 * characters to the start of the buffer and update the end marker 1914 * curPos. 1915 */ 1916 if (i < max) { 1917 (void)memmove(job->outBuf, &job->outBuf[i + 1], max - (i + 1)); 1918 job->curPos = max - (i + 1); 1919 } else { 1920 assert(i == max); 1921 job->curPos = 0; 1922 } 1923 } 1924 if (finish) { 1925 /* 1926 * If the finish flag is true, we must loop until we hit 1927 * end-of-file on the pipe. This is guaranteed to happen 1928 * eventually since the other end of the pipe is now closed 1929 * (we closed it explicitly and the child has exited). When 1930 * we do get an EOF, finish will be set FALSE and we'll fall 1931 * through and out. 1932 */ 1933 goto end_loop; 1934 } 1935 } 1936 1937 static void 1938 JobRun(GNode *targ) 1939 { 1940 #ifdef notyet 1941 /* 1942 * Unfortunately it is too complicated to run .BEGIN, .END, 1943 * and .INTERRUPT job in the parallel job module. This has 1944 * the nice side effect that it avoids a lot of other problems. 1945 */ 1946 Lst lst = Lst_Init(FALSE); 1947 Lst_AtEnd(lst, targ); 1948 (void)Make_Run(lst); 1949 Lst_Destroy(lst, NULL); 1950 JobStart(targ, JOB_SPECIAL); 1951 while (jobTokensRunning) { 1952 Job_CatchOutput(); 1953 } 1954 #else 1955 Compat_Make(targ, targ); 1956 if (targ->made == ERROR) { 1957 PrintOnError(targ, "\n\nStop."); 1958 exit(1); 1959 } 1960 #endif 1961 } 1962 1963 /*- 1964 *----------------------------------------------------------------------- 1965 * Job_CatchChildren -- 1966 * Handle the exit of a child. Called from Make_Make. 1967 * 1968 * Input: 1969 * block TRUE if should block on the wait 1970 * 1971 * Results: 1972 * none. 1973 * 1974 * Side Effects: 1975 * The job descriptor is removed from the list of children. 1976 * 1977 * Notes: 1978 * We do waits, blocking or not, according to the wisdom of our 1979 * caller, until there are no more children to report. For each 1980 * job, call JobFinish to finish things off. 1981 * 1982 *----------------------------------------------------------------------- 1983 */ 1984 1985 void 1986 Job_CatchChildren(void) 1987 { 1988 int pid; /* pid of dead child */ 1989 WAIT_T status; /* Exit/termination status */ 1990 1991 /* 1992 * Don't even bother if we know there's no one around. 1993 */ 1994 if (jobTokensRunning == 0) 1995 return; 1996 1997 while ((pid = waitpid((pid_t) -1, &status, WNOHANG | WUNTRACED)) > 0) { 1998 if (DEBUG(JOB)) { 1999 (void)fprintf(debug_file, "Process %d exited/stopped status %x.\n", pid, 2000 WAIT_STATUS(status)); 2001 } 2002 JobReapChild(pid, status, TRUE); 2003 } 2004 } 2005 2006 /* 2007 * It is possible that wait[pid]() was called from elsewhere, 2008 * this lets us reap jobs regardless. 2009 */ 2010 void 2011 JobReapChild(pid_t pid, WAIT_T status, Boolean isJobs) 2012 { 2013 Job *job; /* job descriptor for dead child */ 2014 2015 /* 2016 * Don't even bother if we know there's no one around. 2017 */ 2018 if (jobTokensRunning == 0) 2019 return; 2020 2021 job = JobFindPid(pid, JOB_ST_RUNNING, isJobs); 2022 if (job == NULL) { 2023 if (isJobs) { 2024 if (!lurking_children) 2025 Error("Child (%d) status %x not in table?", pid, status); 2026 } 2027 return; /* not ours */ 2028 } 2029 if (WIFSTOPPED(status)) { 2030 if (DEBUG(JOB)) { 2031 (void)fprintf(debug_file, "Process %d (%s) stopped.\n", 2032 job->pid, job->node->name); 2033 } 2034 if (!make_suspended) { 2035 switch (WSTOPSIG(status)) { 2036 case SIGTSTP: 2037 (void)printf("*** [%s] Suspended\n", job->node->name); 2038 break; 2039 case SIGSTOP: 2040 (void)printf("*** [%s] Stopped\n", job->node->name); 2041 break; 2042 default: 2043 (void)printf("*** [%s] Stopped -- signal %d\n", 2044 job->node->name, WSTOPSIG(status)); 2045 } 2046 job->job_suspended = 1; 2047 } 2048 (void)fflush(stdout); 2049 return; 2050 } 2051 2052 job->job_state = JOB_ST_FINISHED; 2053 job->exit_status = WAIT_STATUS(status); 2054 2055 JobFinish(job, status); 2056 } 2057 2058 /*- 2059 *----------------------------------------------------------------------- 2060 * Job_CatchOutput -- 2061 * Catch the output from our children, if we're using 2062 * pipes do so. Otherwise just block time until we get a 2063 * signal(most likely a SIGCHLD) since there's no point in 2064 * just spinning when there's nothing to do and the reaping 2065 * of a child can wait for a while. 2066 * 2067 * Results: 2068 * None 2069 * 2070 * Side Effects: 2071 * Output is read from pipes if we're piping. 2072 * ----------------------------------------------------------------------- 2073 */ 2074 void 2075 Job_CatchOutput(void) 2076 { 2077 int nready; 2078 Job *job; 2079 int i; 2080 2081 (void)fflush(stdout); 2082 2083 /* The first fd in the list is the job token pipe */ 2084 do { 2085 nready = poll(fds + 1 - wantToken, nfds - 1 + wantToken, POLL_MSEC); 2086 } while (nready < 0 && errno == EINTR); 2087 2088 if (nready < 0) 2089 Punt("poll: %s", strerror(errno)); 2090 2091 if (nready > 0 && readyfd(&childExitJob)) { 2092 char token = 0; 2093 ssize_t count; 2094 count = read(childExitJob.inPipe, &token, 1); 2095 switch (count) { 2096 case 0: 2097 Punt("unexpected eof on token pipe"); 2098 case -1: 2099 Punt("token pipe read: %s", strerror(errno)); 2100 case 1: 2101 if (token == DO_JOB_RESUME[0]) 2102 /* Complete relay requested from our SIGCONT handler */ 2103 JobRestartJobs(); 2104 break; 2105 default: 2106 abort(); 2107 } 2108 --nready; 2109 } 2110 2111 Job_CatchChildren(); 2112 if (nready == 0) 2113 return; 2114 2115 for (i = 2; i < nfds; i++) { 2116 if (!fds[i].revents) 2117 continue; 2118 job = jobfds[i]; 2119 if (job->job_state == JOB_ST_RUNNING) 2120 JobDoOutput(job, FALSE); 2121 if (--nready == 0) 2122 return; 2123 } 2124 } 2125 2126 /*- 2127 *----------------------------------------------------------------------- 2128 * Job_Make -- 2129 * Start the creation of a target. Basically a front-end for 2130 * JobStart used by the Make module. 2131 * 2132 * Results: 2133 * None. 2134 * 2135 * Side Effects: 2136 * Another job is started. 2137 * 2138 *----------------------------------------------------------------------- 2139 */ 2140 void 2141 Job_Make(GNode *gn) 2142 { 2143 (void)JobStart(gn, 0); 2144 } 2145 2146 void 2147 Shell_Init(void) 2148 { 2149 if (shellPath == NULL) { 2150 /* 2151 * We are using the default shell, which may be an absolute 2152 * path if DEFSHELL_CUSTOM is defined. 2153 */ 2154 shellName = commandShell->name; 2155 #ifdef DEFSHELL_CUSTOM 2156 if (*shellName == '/') { 2157 shellPath = shellName; 2158 shellName = strrchr(shellPath, '/'); 2159 shellName++; 2160 } else 2161 #endif 2162 shellPath = str_concat(_PATH_DEFSHELLDIR, shellName, STR_ADDSLASH); 2163 } 2164 if (commandShell->exit == NULL) { 2165 commandShell->exit = ""; 2166 } 2167 if (commandShell->echo == NULL) { 2168 commandShell->echo = ""; 2169 } 2170 if (commandShell->hasErrCtl && *commandShell->exit) { 2171 if (shellErrFlag && 2172 strcmp(commandShell->exit, &shellErrFlag[1]) != 0) { 2173 free(shellErrFlag); 2174 shellErrFlag = NULL; 2175 } 2176 if (!shellErrFlag) { 2177 int n = strlen(commandShell->exit) + 2; 2178 2179 shellErrFlag = bmake_malloc(n); 2180 if (shellErrFlag) { 2181 snprintf(shellErrFlag, n, "-%s", commandShell->exit); 2182 } 2183 } 2184 } else if (shellErrFlag) { 2185 free(shellErrFlag); 2186 shellErrFlag = NULL; 2187 } 2188 } 2189 2190 /*- 2191 * Returns the string literal that is used in the current command shell 2192 * to produce a newline character. 2193 */ 2194 const char * 2195 Shell_GetNewline(void) 2196 { 2197 2198 return commandShell->newline; 2199 } 2200 2201 void 2202 Job_SetPrefix(void) 2203 { 2204 2205 if (targPrefix) { 2206 free(targPrefix); 2207 } else if (!Var_Exists(MAKE_JOB_PREFIX, VAR_GLOBAL)) { 2208 Var_Set(MAKE_JOB_PREFIX, "---", VAR_GLOBAL, 0); 2209 } 2210 2211 targPrefix = Var_Subst(NULL, "${" MAKE_JOB_PREFIX "}", 2212 VAR_GLOBAL, VARF_WANTRES); 2213 } 2214 2215 /*- 2216 *----------------------------------------------------------------------- 2217 * Job_Init -- 2218 * Initialize the process module 2219 * 2220 * Input: 2221 * 2222 * Results: 2223 * none 2224 * 2225 * Side Effects: 2226 * lists and counters are initialized 2227 *----------------------------------------------------------------------- 2228 */ 2229 void 2230 Job_Init(void) 2231 { 2232 Job_SetPrefix(); 2233 /* Allocate space for all the job info */ 2234 job_table = bmake_malloc(maxJobs * sizeof *job_table); 2235 memset(job_table, 0, maxJobs * sizeof *job_table); 2236 job_table_end = job_table + maxJobs; 2237 wantToken = 0; 2238 2239 aborting = 0; 2240 errors = 0; 2241 2242 lastNode = NULL; 2243 2244 Always_pass_job_queue = getBoolean(MAKE_ALWAYS_PASS_JOB_QUEUE, 2245 Always_pass_job_queue); 2246 2247 Job_error_token = getBoolean(MAKE_JOB_ERROR_TOKEN, Job_error_token); 2248 2249 2250 /* 2251 * There is a non-zero chance that we already have children. 2252 * eg after 'make -f- <<EOF' 2253 * Since their termination causes a 'Child (pid) not in table' message, 2254 * Collect the status of any that are already dead, and suppress the 2255 * error message if there are any undead ones. 2256 */ 2257 for (;;) { 2258 int rval, status; 2259 rval = waitpid((pid_t) -1, &status, WNOHANG); 2260 if (rval > 0) 2261 continue; 2262 if (rval == 0) 2263 lurking_children = 1; 2264 break; 2265 } 2266 2267 Shell_Init(); 2268 2269 JobCreatePipe(&childExitJob, 3); 2270 2271 /* We can only need to wait for tokens, children and output from each job */ 2272 fds = bmake_malloc(sizeof (*fds) * (2 + maxJobs)); 2273 jobfds = bmake_malloc(sizeof (*jobfds) * (2 + maxJobs)); 2274 2275 /* These are permanent entries and take slots 0 and 1 */ 2276 watchfd(&tokenWaitJob); 2277 watchfd(&childExitJob); 2278 2279 sigemptyset(&caught_signals); 2280 /* 2281 * Install a SIGCHLD handler. 2282 */ 2283 (void)bmake_signal(SIGCHLD, JobChildSig); 2284 sigaddset(&caught_signals, SIGCHLD); 2285 2286 #define ADDSIG(s,h) \ 2287 if (bmake_signal(s, SIG_IGN) != SIG_IGN) { \ 2288 sigaddset(&caught_signals, s); \ 2289 (void)bmake_signal(s, h); \ 2290 } 2291 2292 /* 2293 * Catch the four signals that POSIX specifies if they aren't ignored. 2294 * JobPassSig will take care of calling JobInterrupt if appropriate. 2295 */ 2296 ADDSIG(SIGINT, JobPassSig_int) 2297 ADDSIG(SIGHUP, JobPassSig_term) 2298 ADDSIG(SIGTERM, JobPassSig_term) 2299 ADDSIG(SIGQUIT, JobPassSig_term) 2300 2301 /* 2302 * There are additional signals that need to be caught and passed if 2303 * either the export system wants to be told directly of signals or if 2304 * we're giving each job its own process group (since then it won't get 2305 * signals from the terminal driver as we own the terminal) 2306 */ 2307 ADDSIG(SIGTSTP, JobPassSig_suspend) 2308 ADDSIG(SIGTTOU, JobPassSig_suspend) 2309 ADDSIG(SIGTTIN, JobPassSig_suspend) 2310 ADDSIG(SIGWINCH, JobCondPassSig) 2311 ADDSIG(SIGCONT, JobContinueSig) 2312 #undef ADDSIG 2313 2314 (void)Job_RunTarget(".BEGIN", NULL); 2315 postCommands = Targ_FindNode(".END", TARG_CREATE); 2316 } 2317 2318 static void JobSigReset(void) 2319 { 2320 #define DELSIG(s) \ 2321 if (sigismember(&caught_signals, s)) { \ 2322 (void)bmake_signal(s, SIG_DFL); \ 2323 } 2324 2325 DELSIG(SIGINT) 2326 DELSIG(SIGHUP) 2327 DELSIG(SIGQUIT) 2328 DELSIG(SIGTERM) 2329 DELSIG(SIGTSTP) 2330 DELSIG(SIGTTOU) 2331 DELSIG(SIGTTIN) 2332 DELSIG(SIGWINCH) 2333 DELSIG(SIGCONT) 2334 #undef DELSIG 2335 (void)bmake_signal(SIGCHLD, SIG_DFL); 2336 } 2337 2338 /*- 2339 *----------------------------------------------------------------------- 2340 * JobMatchShell -- 2341 * Find a shell in 'shells' given its name. 2342 * 2343 * Results: 2344 * A pointer to the Shell structure. 2345 * 2346 * Side Effects: 2347 * None. 2348 * 2349 *----------------------------------------------------------------------- 2350 */ 2351 static Shell * 2352 JobMatchShell(const char *name) 2353 { 2354 Shell *sh; 2355 2356 for (sh = shells; sh->name != NULL; sh++) { 2357 if (strcmp(name, sh->name) == 0) 2358 return (sh); 2359 } 2360 return NULL; 2361 } 2362 2363 /*- 2364 *----------------------------------------------------------------------- 2365 * Job_ParseShell -- 2366 * Parse a shell specification and set up commandShell, shellPath 2367 * and shellName appropriately. 2368 * 2369 * Input: 2370 * line The shell spec 2371 * 2372 * Results: 2373 * FAILURE if the specification was incorrect. 2374 * 2375 * Side Effects: 2376 * commandShell points to a Shell structure (either predefined or 2377 * created from the shell spec), shellPath is the full path of the 2378 * shell described by commandShell, while shellName is just the 2379 * final component of shellPath. 2380 * 2381 * Notes: 2382 * A shell specification consists of a .SHELL target, with dependency 2383 * operator, followed by a series of blank-separated words. Double 2384 * quotes can be used to use blanks in words. A backslash escapes 2385 * anything (most notably a double-quote and a space) and 2386 * provides the functionality it does in C. Each word consists of 2387 * keyword and value separated by an equal sign. There should be no 2388 * unnecessary spaces in the word. The keywords are as follows: 2389 * name Name of shell. 2390 * path Location of shell. 2391 * quiet Command to turn off echoing. 2392 * echo Command to turn echoing on 2393 * filter Result of turning off echoing that shouldn't be 2394 * printed. 2395 * echoFlag Flag to turn echoing on at the start 2396 * errFlag Flag to turn error checking on at the start 2397 * hasErrCtl True if shell has error checking control 2398 * newline String literal to represent a newline char 2399 * check Command to turn on error checking if hasErrCtl 2400 * is TRUE or template of command to echo a command 2401 * for which error checking is off if hasErrCtl is 2402 * FALSE. 2403 * ignore Command to turn off error checking if hasErrCtl 2404 * is TRUE or template of command to execute a 2405 * command so as to ignore any errors it returns if 2406 * hasErrCtl is FALSE. 2407 * 2408 *----------------------------------------------------------------------- 2409 */ 2410 ReturnStatus 2411 Job_ParseShell(char *line) 2412 { 2413 char **words; 2414 char **argv; 2415 int argc; 2416 char *path; 2417 Shell newShell; 2418 Boolean fullSpec = FALSE; 2419 Shell *sh; 2420 2421 while (isspace((unsigned char)*line)) { 2422 line++; 2423 } 2424 2425 free(UNCONST(shellArgv)); 2426 2427 memset(&newShell, 0, sizeof(newShell)); 2428 2429 /* 2430 * Parse the specification by keyword 2431 */ 2432 words = brk_string(line, &argc, TRUE, &path); 2433 if (words == NULL) { 2434 Error("Unterminated quoted string [%s]", line); 2435 return FAILURE; 2436 } 2437 shellArgv = path; 2438 2439 for (path = NULL, argv = words; argc != 0; argc--, argv++) { 2440 if (strncmp(*argv, "path=", 5) == 0) { 2441 path = &argv[0][5]; 2442 } else if (strncmp(*argv, "name=", 5) == 0) { 2443 newShell.name = &argv[0][5]; 2444 } else { 2445 if (strncmp(*argv, "quiet=", 6) == 0) { 2446 newShell.echoOff = &argv[0][6]; 2447 } else if (strncmp(*argv, "echo=", 5) == 0) { 2448 newShell.echoOn = &argv[0][5]; 2449 } else if (strncmp(*argv, "filter=", 7) == 0) { 2450 newShell.noPrint = &argv[0][7]; 2451 newShell.noPLen = strlen(newShell.noPrint); 2452 } else if (strncmp(*argv, "echoFlag=", 9) == 0) { 2453 newShell.echo = &argv[0][9]; 2454 } else if (strncmp(*argv, "errFlag=", 8) == 0) { 2455 newShell.exit = &argv[0][8]; 2456 } else if (strncmp(*argv, "hasErrCtl=", 10) == 0) { 2457 char c = argv[0][10]; 2458 newShell.hasErrCtl = !((c != 'Y') && (c != 'y') && 2459 (c != 'T') && (c != 't')); 2460 } else if (strncmp(*argv, "newline=", 8) == 0) { 2461 newShell.newline = &argv[0][8]; 2462 } else if (strncmp(*argv, "check=", 6) == 0) { 2463 newShell.errCheck = &argv[0][6]; 2464 } else if (strncmp(*argv, "ignore=", 7) == 0) { 2465 newShell.ignErr = &argv[0][7]; 2466 } else if (strncmp(*argv, "errout=", 7) == 0) { 2467 newShell.errOut = &argv[0][7]; 2468 } else if (strncmp(*argv, "comment=", 8) == 0) { 2469 newShell.commentChar = argv[0][8]; 2470 } else { 2471 Parse_Error(PARSE_FATAL, "Unknown keyword \"%s\"", 2472 *argv); 2473 free(words); 2474 return(FAILURE); 2475 } 2476 fullSpec = TRUE; 2477 } 2478 } 2479 2480 if (path == NULL) { 2481 /* 2482 * If no path was given, the user wants one of the pre-defined shells, 2483 * yes? So we find the one s/he wants with the help of JobMatchShell 2484 * and set things up the right way. shellPath will be set up by 2485 * Shell_Init. 2486 */ 2487 if (newShell.name == NULL) { 2488 Parse_Error(PARSE_FATAL, "Neither path nor name specified"); 2489 free(words); 2490 return(FAILURE); 2491 } else { 2492 if ((sh = JobMatchShell(newShell.name)) == NULL) { 2493 Parse_Error(PARSE_WARNING, "%s: No matching shell", 2494 newShell.name); 2495 free(words); 2496 return(FAILURE); 2497 } 2498 commandShell = sh; 2499 shellName = newShell.name; 2500 if (shellPath) { 2501 /* Shell_Init has already been called! Do it again. */ 2502 free(UNCONST(shellPath)); 2503 shellPath = NULL; 2504 Shell_Init(); 2505 } 2506 } 2507 } else { 2508 /* 2509 * The user provided a path. If s/he gave nothing else (fullSpec is 2510 * FALSE), try and find a matching shell in the ones we know of. 2511 * Else we just take the specification at its word and copy it 2512 * to a new location. In either case, we need to record the 2513 * path the user gave for the shell. 2514 */ 2515 shellPath = path; 2516 path = strrchr(path, '/'); 2517 if (path == NULL) { 2518 path = UNCONST(shellPath); 2519 } else { 2520 path += 1; 2521 } 2522 if (newShell.name != NULL) { 2523 shellName = newShell.name; 2524 } else { 2525 shellName = path; 2526 } 2527 if (!fullSpec) { 2528 if ((sh = JobMatchShell(shellName)) == NULL) { 2529 Parse_Error(PARSE_WARNING, "%s: No matching shell", 2530 shellName); 2531 free(words); 2532 return(FAILURE); 2533 } 2534 commandShell = sh; 2535 } else { 2536 commandShell = bmake_malloc(sizeof(Shell)); 2537 *commandShell = newShell; 2538 } 2539 /* this will take care of shellErrFlag */ 2540 Shell_Init(); 2541 } 2542 2543 if (commandShell->echoOn && commandShell->echoOff) { 2544 commandShell->hasEchoCtl = TRUE; 2545 } 2546 2547 if (!commandShell->hasErrCtl) { 2548 if (commandShell->errCheck == NULL) { 2549 commandShell->errCheck = ""; 2550 } 2551 if (commandShell->ignErr == NULL) { 2552 commandShell->ignErr = "%s\n"; 2553 } 2554 } 2555 2556 /* 2557 * Do not free up the words themselves, since they might be in use by the 2558 * shell specification. 2559 */ 2560 free(words); 2561 return SUCCESS; 2562 } 2563 2564 /*- 2565 *----------------------------------------------------------------------- 2566 * JobInterrupt -- 2567 * Handle the receipt of an interrupt. 2568 * 2569 * Input: 2570 * runINTERRUPT Non-zero if commands for the .INTERRUPT target 2571 * should be executed 2572 * signo signal received 2573 * 2574 * Results: 2575 * None 2576 * 2577 * Side Effects: 2578 * All children are killed. Another job will be started if the 2579 * .INTERRUPT target was given. 2580 *----------------------------------------------------------------------- 2581 */ 2582 static void 2583 JobInterrupt(int runINTERRUPT, int signo) 2584 { 2585 Job *job; /* job descriptor in that element */ 2586 GNode *interrupt; /* the node describing the .INTERRUPT target */ 2587 sigset_t mask; 2588 GNode *gn; 2589 2590 aborting = ABORT_INTERRUPT; 2591 2592 JobSigLock(&mask); 2593 2594 for (job = job_table; job < job_table_end; job++) { 2595 if (job->job_state != JOB_ST_RUNNING) 2596 continue; 2597 2598 gn = job->node; 2599 2600 if ((gn->type & (OP_JOIN|OP_PHONY)) == 0 && !Targ_Precious(gn)) { 2601 char *file = (gn->path == NULL ? gn->name : gn->path); 2602 if (!noExecute && eunlink(file) != -1) { 2603 Error("*** %s removed", file); 2604 } 2605 } 2606 if (job->pid) { 2607 if (DEBUG(JOB)) { 2608 (void)fprintf(debug_file, 2609 "JobInterrupt passing signal %d to child %d.\n", 2610 signo, job->pid); 2611 } 2612 KILLPG(job->pid, signo); 2613 } 2614 } 2615 2616 JobSigUnlock(&mask); 2617 2618 if (runINTERRUPT && !touchFlag) { 2619 interrupt = Targ_FindNode(".INTERRUPT", TARG_NOCREATE); 2620 if (interrupt != NULL) { 2621 ignoreErrors = FALSE; 2622 JobRun(interrupt); 2623 } 2624 } 2625 Trace_Log(MAKEINTR, 0); 2626 exit(signo); 2627 } 2628 2629 /* 2630 *----------------------------------------------------------------------- 2631 * Job_Finish -- 2632 * Do final processing such as the running of the commands 2633 * attached to the .END target. 2634 * 2635 * Results: 2636 * Number of errors reported. 2637 * 2638 * Side Effects: 2639 * None. 2640 *----------------------------------------------------------------------- 2641 */ 2642 int 2643 Job_Finish(void) 2644 { 2645 if (postCommands != NULL && 2646 (!Lst_IsEmpty(postCommands->commands) || 2647 !Lst_IsEmpty(postCommands->children))) { 2648 if (errors) { 2649 Error("Errors reported so .END ignored"); 2650 } else { 2651 JobRun(postCommands); 2652 } 2653 } 2654 return(errors); 2655 } 2656 2657 /*- 2658 *----------------------------------------------------------------------- 2659 * Job_End -- 2660 * Cleanup any memory used by the jobs module 2661 * 2662 * Results: 2663 * None. 2664 * 2665 * Side Effects: 2666 * Memory is freed 2667 *----------------------------------------------------------------------- 2668 */ 2669 void 2670 Job_End(void) 2671 { 2672 #ifdef CLEANUP 2673 free(shellArgv); 2674 #endif 2675 } 2676 2677 /*- 2678 *----------------------------------------------------------------------- 2679 * Job_Wait -- 2680 * Waits for all running jobs to finish and returns. Sets 'aborting' 2681 * to ABORT_WAIT to prevent other jobs from starting. 2682 * 2683 * Results: 2684 * None. 2685 * 2686 * Side Effects: 2687 * Currently running jobs finish. 2688 * 2689 *----------------------------------------------------------------------- 2690 */ 2691 void 2692 Job_Wait(void) 2693 { 2694 aborting = ABORT_WAIT; 2695 while (jobTokensRunning != 0) { 2696 Job_CatchOutput(); 2697 } 2698 aborting = 0; 2699 } 2700 2701 /*- 2702 *----------------------------------------------------------------------- 2703 * Job_AbortAll -- 2704 * Abort all currently running jobs without handling output or anything. 2705 * This function is to be called only in the event of a major 2706 * error. Most definitely NOT to be called from JobInterrupt. 2707 * 2708 * Results: 2709 * None 2710 * 2711 * Side Effects: 2712 * All children are killed, not just the firstborn 2713 *----------------------------------------------------------------------- 2714 */ 2715 void 2716 Job_AbortAll(void) 2717 { 2718 Job *job; /* the job descriptor in that element */ 2719 WAIT_T foo; 2720 2721 aborting = ABORT_ERROR; 2722 2723 if (jobTokensRunning) { 2724 for (job = job_table; job < job_table_end; job++) { 2725 if (job->job_state != JOB_ST_RUNNING) 2726 continue; 2727 /* 2728 * kill the child process with increasingly drastic signals to make 2729 * darn sure it's dead. 2730 */ 2731 KILLPG(job->pid, SIGINT); 2732 KILLPG(job->pid, SIGKILL); 2733 } 2734 } 2735 2736 /* 2737 * Catch as many children as want to report in at first, then give up 2738 */ 2739 while (waitpid((pid_t) -1, &foo, WNOHANG) > 0) 2740 continue; 2741 } 2742 2743 2744 /*- 2745 *----------------------------------------------------------------------- 2746 * JobRestartJobs -- 2747 * Tries to restart stopped jobs if there are slots available. 2748 * Called in process context in response to a SIGCONT. 2749 * 2750 * Results: 2751 * None. 2752 * 2753 * Side Effects: 2754 * Resumes jobs. 2755 * 2756 *----------------------------------------------------------------------- 2757 */ 2758 static void 2759 JobRestartJobs(void) 2760 { 2761 Job *job; 2762 2763 for (job = job_table; job < job_table_end; job++) { 2764 if (job->job_state == JOB_ST_RUNNING && 2765 (make_suspended || job->job_suspended)) { 2766 if (DEBUG(JOB)) { 2767 (void)fprintf(debug_file, "Restarting stopped job pid %d.\n", 2768 job->pid); 2769 } 2770 if (job->job_suspended) { 2771 (void)printf("*** [%s] Continued\n", job->node->name); 2772 (void)fflush(stdout); 2773 } 2774 job->job_suspended = 0; 2775 if (KILLPG(job->pid, SIGCONT) != 0 && DEBUG(JOB)) { 2776 fprintf(debug_file, "Failed to send SIGCONT to %d\n", job->pid); 2777 } 2778 } 2779 if (job->job_state == JOB_ST_FINISHED) 2780 /* Job exit deferred after calling waitpid() in a signal handler */ 2781 JobFinish(job, job->exit_status); 2782 } 2783 make_suspended = 0; 2784 } 2785 2786 static void 2787 watchfd(Job *job) 2788 { 2789 if (job->inPollfd != NULL) 2790 Punt("Watching watched job"); 2791 2792 fds[nfds].fd = job->inPipe; 2793 fds[nfds].events = POLLIN; 2794 jobfds[nfds] = job; 2795 job->inPollfd = &fds[nfds]; 2796 nfds++; 2797 } 2798 2799 static void 2800 clearfd(Job *job) 2801 { 2802 int i; 2803 if (job->inPollfd == NULL) 2804 Punt("Unwatching unwatched job"); 2805 i = job->inPollfd - fds; 2806 nfds--; 2807 /* 2808 * Move last job in table into hole made by dead job. 2809 */ 2810 if (nfds != i) { 2811 fds[i] = fds[nfds]; 2812 jobfds[i] = jobfds[nfds]; 2813 jobfds[i]->inPollfd = &fds[i]; 2814 } 2815 job->inPollfd = NULL; 2816 } 2817 2818 static int 2819 readyfd(Job *job) 2820 { 2821 if (job->inPollfd == NULL) 2822 Punt("Polling unwatched job"); 2823 return (job->inPollfd->revents & POLLIN) != 0; 2824 } 2825 2826 /*- 2827 *----------------------------------------------------------------------- 2828 * JobTokenAdd -- 2829 * Put a token into the job pipe so that some make process can start 2830 * another job. 2831 * 2832 * Side Effects: 2833 * Allows more build jobs to be spawned somewhere. 2834 * 2835 *----------------------------------------------------------------------- 2836 */ 2837 2838 static void 2839 JobTokenAdd(void) 2840 { 2841 char tok = JOB_TOKENS[aborting], tok1; 2842 2843 if (!Job_error_token && aborting == ABORT_ERROR) { 2844 if (jobTokensRunning == 0) 2845 return; 2846 tok = '+'; /* no error token */ 2847 } 2848 2849 /* If we are depositing an error token flush everything else */ 2850 while (tok != '+' && read(tokenWaitJob.inPipe, &tok1, 1) == 1) 2851 continue; 2852 2853 if (DEBUG(JOB)) 2854 fprintf(debug_file, "(%d) aborting %d, deposit token %c\n", 2855 getpid(), aborting, tok); 2856 while (write(tokenWaitJob.outPipe, &tok, 1) == -1 && errno == EAGAIN) 2857 continue; 2858 } 2859 2860 /*- 2861 *----------------------------------------------------------------------- 2862 * Job_ServerStartTokenAdd -- 2863 * Prep the job token pipe in the root make process. 2864 * 2865 *----------------------------------------------------------------------- 2866 */ 2867 2868 void 2869 Job_ServerStart(int max_tokens, int jp_0, int jp_1) 2870 { 2871 int i; 2872 char jobarg[64]; 2873 2874 if (jp_0 >= 0 && jp_1 >= 0) { 2875 /* Pipe passed in from parent */ 2876 tokenWaitJob.inPipe = jp_0; 2877 tokenWaitJob.outPipe = jp_1; 2878 (void)fcntl(jp_0, F_SETFD, FD_CLOEXEC); 2879 (void)fcntl(jp_1, F_SETFD, FD_CLOEXEC); 2880 return; 2881 } 2882 2883 JobCreatePipe(&tokenWaitJob, 15); 2884 2885 snprintf(jobarg, sizeof(jobarg), "%d,%d", 2886 tokenWaitJob.inPipe, tokenWaitJob.outPipe); 2887 2888 Var_Append(MAKEFLAGS, "-J", VAR_GLOBAL); 2889 Var_Append(MAKEFLAGS, jobarg, VAR_GLOBAL); 2890 2891 /* 2892 * Preload the job pipe with one token per job, save the one 2893 * "extra" token for the primary job. 2894 * 2895 * XXX should clip maxJobs against PIPE_BUF -- if max_tokens is 2896 * larger than the write buffer size of the pipe, we will 2897 * deadlock here. 2898 */ 2899 for (i = 1; i < max_tokens; i++) 2900 JobTokenAdd(); 2901 } 2902 2903 /*- 2904 *----------------------------------------------------------------------- 2905 * Job_TokenReturn -- 2906 * Return a withdrawn token to the pool. 2907 * 2908 *----------------------------------------------------------------------- 2909 */ 2910 2911 void 2912 Job_TokenReturn(void) 2913 { 2914 jobTokensRunning--; 2915 if (jobTokensRunning < 0) 2916 Punt("token botch"); 2917 if (jobTokensRunning || JOB_TOKENS[aborting] != '+') 2918 JobTokenAdd(); 2919 } 2920 2921 /*- 2922 *----------------------------------------------------------------------- 2923 * Job_TokenWithdraw -- 2924 * Attempt to withdraw a token from the pool. 2925 * 2926 * Results: 2927 * Returns TRUE if a token was withdrawn, and FALSE if the pool 2928 * is currently empty. 2929 * 2930 * Side Effects: 2931 * If pool is empty, set wantToken so that we wake up 2932 * when a token is released. 2933 * 2934 *----------------------------------------------------------------------- 2935 */ 2936 2937 2938 Boolean 2939 Job_TokenWithdraw(void) 2940 { 2941 char tok, tok1; 2942 int count; 2943 2944 wantToken = 0; 2945 if (DEBUG(JOB)) 2946 fprintf(debug_file, "Job_TokenWithdraw(%d): aborting %d, running %d\n", 2947 getpid(), aborting, jobTokensRunning); 2948 2949 if (aborting || (jobTokensRunning >= maxJobs)) 2950 return FALSE; 2951 2952 count = read(tokenWaitJob.inPipe, &tok, 1); 2953 if (count == 0) 2954 Fatal("eof on job pipe!"); 2955 if (count < 0 && jobTokensRunning != 0) { 2956 if (errno != EAGAIN) { 2957 Fatal("job pipe read: %s", strerror(errno)); 2958 } 2959 if (DEBUG(JOB)) 2960 fprintf(debug_file, "(%d) blocked for token\n", getpid()); 2961 wantToken = 1; 2962 return FALSE; 2963 } 2964 2965 if (count == 1 && tok != '+') { 2966 /* make being abvorted - remove any other job tokens */ 2967 if (DEBUG(JOB)) 2968 fprintf(debug_file, "(%d) aborted by token %c\n", getpid(), tok); 2969 while (read(tokenWaitJob.inPipe, &tok1, 1) == 1) 2970 continue; 2971 /* And put the stopper back */ 2972 while (write(tokenWaitJob.outPipe, &tok, 1) == -1 && errno == EAGAIN) 2973 continue; 2974 Fatal("A failure has been detected in another branch of the parallel make"); 2975 } 2976 2977 if (count == 1 && jobTokensRunning == 0) 2978 /* We didn't want the token really */ 2979 while (write(tokenWaitJob.outPipe, &tok, 1) == -1 && errno == EAGAIN) 2980 continue; 2981 2982 jobTokensRunning++; 2983 if (DEBUG(JOB)) 2984 fprintf(debug_file, "(%d) withdrew token\n", getpid()); 2985 return TRUE; 2986 } 2987 2988 /*- 2989 *----------------------------------------------------------------------- 2990 * Job_RunTarget -- 2991 * Run the named target if found. If a filename is specified, then 2992 * set that to the sources. 2993 * 2994 * Results: 2995 * None 2996 * 2997 * Side Effects: 2998 * exits if the target fails. 2999 * 3000 *----------------------------------------------------------------------- 3001 */ 3002 Boolean 3003 Job_RunTarget(const char *target, const char *fname) { 3004 GNode *gn = Targ_FindNode(target, TARG_NOCREATE); 3005 3006 if (gn == NULL) 3007 return FALSE; 3008 3009 if (fname) 3010 Var_Set(ALLSRC, fname, gn, 0); 3011 3012 JobRun(gn); 3013 if (gn->made == ERROR) { 3014 PrintOnError(gn, "\n\nStop."); 3015 exit(1); 3016 } 3017 return TRUE; 3018 } 3019 3020 #ifdef USE_SELECT 3021 int 3022 emul_poll(struct pollfd *fd, int nfd, int timeout) 3023 { 3024 fd_set rfds, wfds; 3025 int i, maxfd, nselect, npoll; 3026 struct timeval tv, *tvp; 3027 long usecs; 3028 3029 FD_ZERO(&rfds); 3030 FD_ZERO(&wfds); 3031 3032 maxfd = -1; 3033 for (i = 0; i < nfd; i++) { 3034 fd[i].revents = 0; 3035 3036 if (fd[i].events & POLLIN) 3037 FD_SET(fd[i].fd, &rfds); 3038 3039 if (fd[i].events & POLLOUT) 3040 FD_SET(fd[i].fd, &wfds); 3041 3042 if (fd[i].fd > maxfd) 3043 maxfd = fd[i].fd; 3044 } 3045 3046 if (maxfd >= FD_SETSIZE) { 3047 Punt("Ran out of fd_set slots; " 3048 "recompile with a larger FD_SETSIZE."); 3049 } 3050 3051 if (timeout < 0) { 3052 tvp = NULL; 3053 } else { 3054 usecs = timeout * 1000; 3055 tv.tv_sec = usecs / 1000000; 3056 tv.tv_usec = usecs % 1000000; 3057 tvp = &tv; 3058 } 3059 3060 nselect = select(maxfd + 1, &rfds, &wfds, 0, tvp); 3061 3062 if (nselect <= 0) 3063 return nselect; 3064 3065 npoll = 0; 3066 for (i = 0; i < nfd; i++) { 3067 if (FD_ISSET(fd[i].fd, &rfds)) 3068 fd[i].revents |= POLLIN; 3069 3070 if (FD_ISSET(fd[i].fd, &wfds)) 3071 fd[i].revents |= POLLOUT; 3072 3073 if (fd[i].revents) 3074 npoll++; 3075 } 3076 3077 return npoll; 3078 } 3079 #endif /* USE_SELECT */ 3080