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