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