job.c revision 1.89 1 /* $NetBSD: job.c,v 1.89 2005/02/16 15:11:52 christos Exp $ */
2
3 /*
4 * Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to Berkeley by
8 * Adam de Boor.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 */
34
35 /*
36 * Copyright (c) 1988, 1989 by Adam de Boor
37 * Copyright (c) 1989 by Berkeley Softworks
38 * All rights reserved.
39 *
40 * This code is derived from software contributed to Berkeley by
41 * Adam de Boor.
42 *
43 * Redistribution and use in source and binary forms, with or without
44 * modification, are permitted provided that the following conditions
45 * are met:
46 * 1. Redistributions of source code must retain the above copyright
47 * notice, this list of conditions and the following disclaimer.
48 * 2. Redistributions in binary form must reproduce the above copyright
49 * notice, this list of conditions and the following disclaimer in the
50 * documentation and/or other materials provided with the distribution.
51 * 3. All advertising materials mentioning features or use of this software
52 * must display the following acknowledgement:
53 * This product includes software developed by the University of
54 * California, Berkeley and its contributors.
55 * 4. Neither the name of the University nor the names of its contributors
56 * may be used to endorse or promote products derived from this software
57 * without specific prior written permission.
58 *
59 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
60 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
61 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
62 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
63 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
64 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
65 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
66 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
67 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
68 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
69 * SUCH DAMAGE.
70 */
71
72 #ifndef MAKE_NATIVE
73 static char rcsid[] = "$NetBSD: job.c,v 1.89 2005/02/16 15:11:52 christos Exp $";
74 #else
75 #include <sys/cdefs.h>
76 #ifndef lint
77 #if 0
78 static char sccsid[] = "@(#)job.c 8.2 (Berkeley) 3/19/94";
79 #else
80 __RCSID("$NetBSD: job.c,v 1.89 2005/02/16 15:11:52 christos Exp $");
81 #endif
82 #endif /* not lint */
83 #endif
84
85 /*-
86 * job.c --
87 * handle the creation etc. of our child processes.
88 *
89 * Interface:
90 * Job_Make Start the creation of the given target.
91 *
92 * Job_CatchChildren Check for and handle the termination of any
93 * children. This must be called reasonably
94 * frequently to keep the whole make going at
95 * a decent clip, since job table entries aren't
96 * removed until their process is caught this way.
97 * Its single argument is TRUE if the function
98 * should block waiting for a child to terminate.
99 *
100 * Job_CatchOutput Print any output our children have produced.
101 * Should also be called fairly frequently to
102 * keep the user informed of what's going on.
103 * If no output is waiting, it will block for
104 * a time given by the SEL_* constants, below,
105 * or until output is ready.
106 *
107 * Job_Init Called to intialize this module. in addition,
108 * any commands attached to the .BEGIN target
109 * are executed before this function returns.
110 * Hence, the makefile must have been parsed
111 * before this function is called.
112 *
113 * Job_End Cleanup any memory used.
114 *
115 * Job_Empty Return TRUE if the job table is completely
116 * empty.
117 *
118 * Job_ParseShell Given the line following a .SHELL target, parse
119 * the line as a shell specification. Returns
120 * FAILURE if the spec was incorrect.
121 *
122 * Job_Finish Perform any final processing which needs doing.
123 * This includes the execution of any commands
124 * which have been/were attached to the .END
125 * target. It should only be called when the
126 * job table is empty.
127 *
128 * Job_AbortAll Abort all currently running jobs. It doesn't
129 * handle output or do anything for the jobs,
130 * just kills them. It should only be called in
131 * an emergency, as it were.
132 *
133 * Job_CheckCommands Verify that the commands for a target are
134 * ok. Provide them if necessary and possible.
135 *
136 * Job_Touch Update a target without really updating it.
137 *
138 * Job_Wait Wait for all currently-running jobs to finish.
139 */
140
141 #include <sys/types.h>
142 #include <sys/stat.h>
143 #include <sys/file.h>
144 #include <sys/time.h>
145 #include <sys/wait.h>
146
147 #include <errno.h>
148 #include <fcntl.h>
149 #ifndef RMT_WILL_WATCH
150 #ifndef USE_SELECT
151 #include <poll.h>
152 #endif
153 #endif
154 #include <signal.h>
155 #include <stdio.h>
156 #include <string.h>
157 #include <utime.h>
158
159 #include "make.h"
160 #include "hash.h"
161 #include "dir.h"
162 #include "job.h"
163 #include "pathnames.h"
164 #include "trace.h"
165 #ifdef REMOTE
166 #include "rmt.h"
167 # define STATIC
168 #else
169 # define STATIC static
170 #endif
171
172 /*
173 * error handling variables
174 */
175 static int errors = 0; /* number of errors reported */
176 static int aborting = 0; /* why is the make aborting? */
177 #define ABORT_ERROR 1 /* Because of an error */
178 #define ABORT_INTERRUPT 2 /* Because it was interrupted */
179 #define ABORT_WAIT 3 /* Waiting for jobs to finish */
180
181 /*
182 * XXX: Avoid SunOS bug... FILENO() is fp->_file, and file
183 * is a char! So when we go above 127 we turn negative!
184 */
185 #define FILENO(a) ((unsigned) fileno(a))
186
187 /*
188 * post-make command processing. The node postCommands is really just the
189 * .END target but we keep it around to avoid having to search for it
190 * all the time.
191 */
192 static GNode *postCommands = NILGNODE;
193 /* node containing commands to execute when
194 * everything else is done */
195 static int numCommands; /* The number of commands actually printed
196 * for a target. Should this number be
197 * 0, no shell will be executed. */
198
199 /*
200 * Return values from JobStart.
201 */
202 #define JOB_RUNNING 0 /* Job is running */
203 #define JOB_ERROR 1 /* Error in starting the job */
204 #define JOB_FINISHED 2 /* The job is already finished */
205 #define JOB_STOPPED 3 /* The job is stopped */
206
207
208
209 /*
210 * Descriptions for various shells.
211 */
212 static Shell shells[] = {
213 /*
214 * CSH description. The csh can do echo control by playing
215 * with the setting of the 'echo' shell variable. Sadly,
216 * however, it is unable to do error control nicely.
217 */
218 {
219 "csh",
220 TRUE, "unset verbose", "set verbose", "unset verbose", 10,
221 FALSE, "echo \"%s\"\n", "csh -c \"%s || exit 0\"\n", "", '#',
222 "v", "e",
223 },
224 /*
225 * SH description. Echo control is also possible and, under
226 * sun UNIX anyway, one can even control error checking.
227 */
228 {
229 "sh",
230 FALSE, "", "", "", 0,
231 FALSE, "echo \"%s\"\n", "%s\n", "{ %s \n} || exit $?\n", '#',
232 #ifdef __NetBSD__
233 "q",
234 #else
235 "",
236 #endif
237 "",
238 },
239 /*
240 * KSH description.
241 */
242 {
243 "ksh",
244 TRUE, "set +v", "set -v", "set +v", 6,
245 FALSE, "echo \"%s\"\n", "%s\n", "{ %s \n} || exit $?\n", '#',
246 "v",
247 "",
248 },
249 /*
250 * UNKNOWN.
251 */
252 {
253 (char *) 0,
254 FALSE, (char *) 0, (char *) 0, (char *) 0, 0,
255 FALSE, (char *) 0, (char *) 0, (char *) 0, 0,
256 (char *) 0, (char *) 0,
257 }
258 };
259 static Shell *commandShell = &shells[DEFSHELL];/* this is the shell to
260 * which we pass all
261 * commands in the Makefile.
262 * It is set by the
263 * Job_ParseShell function */
264 const char *shellPath = NULL, /* full pathname of
265 * executable image */
266 *shellName = NULL; /* last component of shell */
267 static const char *shellArgv = NULL; /* Custom shell args */
268
269
270 static int maxJobs; /* The most children we can run at once */
271 static int maxLocal; /* The most local ones we can have */
272 STATIC int nJobs; /* The number of children currently running */
273 STATIC int nLocal; /* The number of local children */
274 STATIC Lst jobs; /* The structures that describe them */
275 static Boolean wantToken; /* we want a token */
276
277 /*
278 * Set of descriptors of pipes connected to
279 * the output channels of children
280 */
281 #ifndef RMT_WILL_WATCH
282 static struct pollfd *fds = NULL;
283 static Job **jobfds = NULL;
284 static int nfds = 0;
285 static int maxfds = 0;
286 static void watchfd(Job *);
287 static void clearfd(Job *);
288 static int readyfd(Job *);
289 #define JBSTART 256
290 #define JBFACTOR 2
291 #endif
292
293 STATIC GNode *lastNode; /* The node for which output was most recently
294 * produced. */
295 STATIC const char *targFmt; /* Format string to use to head output from a
296 * job when it's not the most-recent job heard
297 * from */
298 static Job tokenWaitJob; /* token wait pseudo-job */
299 int job_pipe[2] = { -1, -1 }; /* job server pipes. */
300
301 static Job childExitJob; /* child exit pseudo-job */
302 int exit_pipe[2] = { -1, -1 }; /* child exit signal pipe. */
303
304 #ifdef REMOTE
305 # define TARG_FMT "--- %s at %s ---\n" /* Default format */
306 # define MESSAGE(fp, gn) \
307 (void) fprintf(fp, targFmt, gn->name, gn->rem.hname)
308 #else
309 # define TARG_FMT "--- %s ---\n" /* Default format */
310 # define MESSAGE(fp, gn) \
311 (void) fprintf(fp, targFmt, gn->name)
312 #endif
313
314 /*
315 * When JobStart attempts to run a job remotely but can't, and isn't allowed
316 * to run the job locally, or when Job_CatchChildren detects a job that has
317 * been migrated home, the job is placed on the stoppedJobs queue to be run
318 * when the next job finishes.
319 */
320 STATIC Lst stoppedJobs; /* Lst of Job structures describing
321 * jobs that were stopped due to concurrency
322 * limits or migration home */
323
324
325 sigset_t caught_signals; /* Set of signals we handle */
326 #if defined(USE_PGRP) && defined(SYSV)
327 # define KILL(pid, sig) kill(-(pid), (sig))
328 #else
329 # if defined(USE_PGRP)
330 # define KILL(pid, sig) killpg((pid), (sig))
331 # else
332 # define KILL(pid, sig) kill((pid), (sig))
333 # endif
334 #endif
335
336 /*
337 * Grmpf... There is no way to set bits of the wait structure
338 * anymore with the stupid W*() macros. I liked the union wait
339 * stuff much more. So, we devise our own macros... This is
340 * really ugly, use dramamine sparingly. You have been warned.
341 */
342 #ifndef W_STOPCODE
343 #define W_STOPCODE(sig) (((sig) << 8) | 0177)
344 #endif
345 #ifndef W_EXITCODE
346 #define W_EXITCODE(ret, sig) ((ret << 8) | (sig))
347 #endif
348
349 static int JobCondPassSig(ClientData, ClientData);
350 static void JobPassSig(int);
351 static void JobChildSig(int);
352 #ifdef USE_PGRP
353 static void JobContinueSig(int);
354 #endif
355 static int JobCmpPid(ClientData, ClientData);
356 static int JobPrintCommand(ClientData, ClientData);
357 static int JobSaveCommand(ClientData, ClientData);
358 static void JobClose(Job *);
359 #ifdef REMOTE
360 static int JobCmpRmtID(ClientData, ClientData);
361 # ifdef RMT_WILL_WATCH
362 static void JobLocalInput(int, Job *);
363 # endif
364 #else
365 static void JobFinish(Job *, int *);
366 static void JobExec(Job *, char **);
367 #endif
368 static void JobMakeArgv(Job *, char **);
369 static int JobRestart(Job *);
370 static int JobStart(GNode *, int, Job *);
371 static char *JobOutput(Job *, char *, char *, int);
372 static void JobDoOutput(Job *, Boolean);
373 static Shell *JobMatchShell(const char *);
374 static void JobInterrupt(int, int);
375 static void JobRestartJobs(void);
376 static void JobTokenAdd(void);
377 static void JobSigLock(sigset_t *);
378 static void JobSigUnlock(sigset_t *);
379 static void JobSigReset(void);
380
381
382
383 /*
384 * JobSigLock/JobSigUnlock
385 *
386 * Signal lock routines to get exclusive access. Currently used to
387 * protect `jobs' and `stoppedJobs' list manipulations.
388 */
389 static void JobSigLock(sigset_t *omaskp)
390 {
391 if (sigprocmask(SIG_BLOCK, &caught_signals, omaskp) != 0) {
392 Punt("JobSigLock: sigprocmask: %s", strerror(errno));
393 sigemptyset(omaskp);
394 }
395 }
396
397 static void JobSigUnlock(sigset_t *omaskp)
398 {
399 (void) sigprocmask(SIG_SETMASK, omaskp, NULL);
400 }
401
402 /*-
403 *-----------------------------------------------------------------------
404 * JobCondPassSig --
405 * Pass a signal to a job if the job is remote or if USE_PGRP
406 * is defined.
407 *
408 * Input:
409 * jobp Job to biff
410 * signop Signal to send it
411 *
412 * Results:
413 * === 0
414 *
415 * Side Effects:
416 * None, except the job may bite it.
417 *
418 *-----------------------------------------------------------------------
419 */
420 static int
421 JobCondPassSig(ClientData jobp, ClientData signop)
422 {
423 Job *job = (Job *) jobp;
424 int signo = *(int *) signop;
425 #ifdef RMT_WANTS_SIGNALS
426 if (job->flags & JOB_REMOTE) {
427 (void) Rmt_Signal(job, signo);
428 } else {
429 KILL(job->pid, signo);
430 }
431 #else
432 /*
433 * Assume that sending the signal to job->pid will signal any remote
434 * job as well.
435 */
436 if (DEBUG(JOB)) {
437 (void) fprintf(stdout,
438 "JobCondPassSig passing signal %d to child %d.\n",
439 signo, job->pid);
440 (void) fflush(stdout);
441 }
442 KILL(job->pid, signo);
443 #endif
444 return 0;
445 }
446
447 /*-
448 *-----------------------------------------------------------------------
449 * JobChldSig --
450 * SIGCHLD handler.
451 *
452 * Input:
453 * signo The signal number we've received
454 *
455 * Results:
456 * None.
457 *
458 * Side Effects:
459 * Sends a token on the child exit pipe to wake us up from
460 * select()/poll().
461 *
462 *-----------------------------------------------------------------------
463 */
464 static void
465 JobChildSig(int signo __unused)
466 {
467 write(exit_pipe[1], ".", 1);
468 }
469
470
471 #ifdef USE_PGRP
472 /*-
473 *-----------------------------------------------------------------------
474 * JobContinueSig --
475 * Resume all stopped jobs.
476 *
477 * Input:
478 * signo The signal number we've received
479 *
480 * Results:
481 * None.
482 *
483 * Side Effects:
484 * Jobs start running again.
485 *
486 *-----------------------------------------------------------------------
487 */
488 static void
489 JobContinueSig(int signo __unused)
490 {
491 JobRestartJobs();
492 }
493 #endif
494
495 /*-
496 *-----------------------------------------------------------------------
497 * JobPassSig --
498 * Pass a signal on to all remote jobs and to all local jobs if
499 * USE_PGRP is defined, then die ourselves.
500 *
501 * Input:
502 * signo The signal number we've received
503 *
504 * Results:
505 * None.
506 *
507 * Side Effects:
508 * We die by the same signal.
509 *
510 *-----------------------------------------------------------------------
511 */
512 static void
513 JobPassSig(int signo)
514 {
515 sigset_t nmask, omask;
516 struct sigaction act;
517 int sigcont;
518
519 if (DEBUG(JOB)) {
520 (void) fprintf(stdout, "JobPassSig(%d) called.\n", signo);
521 (void) fflush(stdout);
522 }
523 Lst_ForEach(jobs, JobCondPassSig, (ClientData) &signo);
524
525 /*
526 * Deal with proper cleanup based on the signal received. We only run
527 * the .INTERRUPT target if the signal was in fact an interrupt. The other
528 * three termination signals are more of a "get out *now*" command.
529 */
530 if (signo == SIGINT) {
531 JobInterrupt(TRUE, signo);
532 } else if ((signo == SIGHUP) || (signo == SIGTERM) || (signo == SIGQUIT)) {
533 JobInterrupt(FALSE, signo);
534 }
535
536 /*
537 * Leave gracefully if SIGQUIT, rather than core dumping.
538 */
539 if (signo == SIGQUIT) {
540 Finish(0);
541 }
542
543 if (signo == SIGTSTP) {
544 Job_CatchChildren(FALSE);
545 }
546 /*
547 * Send ourselves the signal now we've given the message to everyone else.
548 * Note we block everything else possible while we're getting the signal.
549 * This ensures that all our jobs get continued when we wake up before
550 * we take any other signal.
551 */
552 sigfillset(&nmask);
553 sigdelset(&nmask, signo);
554 (void) sigprocmask(SIG_SETMASK, &nmask, &omask);
555
556 act.sa_handler = SIG_DFL;
557 sigemptyset(&act.sa_mask);
558 act.sa_flags = 0;
559 (void) sigaction(signo, &act, NULL);
560
561 if (DEBUG(JOB)) {
562 (void) fprintf(stdout,
563 "JobPassSig passing signal %d to self.\n", signo);
564 (void) fflush(stdout);
565 }
566
567 (void) kill(getpid(), signo);
568 if (signo != SIGTSTP) {
569 sigcont = SIGCONT;
570 Lst_ForEach(jobs, JobCondPassSig, (ClientData) &sigcont);
571 }
572
573 /* Restore handler and signal mask */
574 act.sa_handler = JobPassSig;
575 (void) sigaction(signo, &act, NULL);
576 (void) sigprocmask(SIG_SETMASK, &omask, NULL);
577 }
578
579 /*-
580 *-----------------------------------------------------------------------
581 * JobCmpPid --
582 * Compare the pid of the job with the given pid and return 0 if they
583 * are equal. This function is called from Job_CatchChildren via
584 * Lst_Find to find the job descriptor of the finished job.
585 *
586 * Input:
587 * job job to examine
588 * pid process id desired
589 *
590 * Results:
591 * 0 if the pid's match
592 *
593 * Side Effects:
594 * None
595 *-----------------------------------------------------------------------
596 */
597 static int
598 JobCmpPid(ClientData job, ClientData pid)
599 {
600 return *(int *) pid - ((Job *) job)->pid;
601 }
602
603 #ifdef REMOTE
604 /*-
605 *-----------------------------------------------------------------------
606 * JobCmpRmtID --
607 * Compare the rmtID of the job with the given rmtID and return 0 if they
608 * are equal.
609 *
610 * Input:
611 * job job to examine
612 * rmtID remote id desired
613 *
614 * Results:
615 * 0 if the rmtID's match
616 *
617 * Side Effects:
618 * None.
619 *-----------------------------------------------------------------------
620 */
621 static int
622 JobCmpRmtID(ClientData job, ClientData rmtID)
623 {
624 return(*(int *) rmtID - ((Job *) job)->rmtID);
625 }
626 #endif
627
628 /*-
629 *-----------------------------------------------------------------------
630 * JobPrintCommand --
631 * Put out another command for the given job. If the command starts
632 * with an @ or a - we process it specially. In the former case,
633 * so long as the -s and -n flags weren't given to make, we stick
634 * a shell-specific echoOff command in the script. In the latter,
635 * we ignore errors for the entire job, unless the shell has error
636 * control.
637 * If the command is just "..." we take all future commands for this
638 * job to be commands to be executed once the entire graph has been
639 * made and return non-zero to signal that the end of the commands
640 * was reached. These commands are later attached to the postCommands
641 * node and executed by Job_End when all things are done.
642 * This function is called from JobStart via Lst_ForEach.
643 *
644 * Input:
645 * cmdp command string to print
646 * jobp job for which to print it
647 *
648 * Results:
649 * Always 0, unless the command was "..."
650 *
651 * Side Effects:
652 * If the command begins with a '-' and the shell has no error control,
653 * the JOB_IGNERR flag is set in the job descriptor.
654 * If the command is "..." and we're not ignoring such things,
655 * tailCmds is set to the successor node of the cmd.
656 * numCommands is incremented if the command is actually printed.
657 *-----------------------------------------------------------------------
658 */
659 static int
660 JobPrintCommand(ClientData cmdp, ClientData jobp)
661 {
662 Boolean noSpecials; /* true if we shouldn't worry about
663 * inserting special commands into
664 * the input stream. */
665 Boolean shutUp = FALSE; /* true if we put a no echo command
666 * into the command file */
667 Boolean errOff = FALSE; /* true if we turned error checking
668 * off before printing the command
669 * and need to turn it back on */
670 const char *cmdTemplate; /* Template to use when printing the
671 * command */
672 char *cmdStart; /* Start of expanded command */
673 char *escCmd = NULL; /* Command with quotes/backticks escaped */
674 char *cmd = (char *) cmdp;
675 Job *job = (Job *) jobp;
676 char *cp, *tmp;
677 int i, j;
678
679 noSpecials = NoExecute(job->node);
680
681 if (strcmp(cmd, "...") == 0) {
682 job->node->type |= OP_SAVE_CMDS;
683 if ((job->flags & JOB_IGNDOTS) == 0) {
684 job->tailCmds = Lst_Succ(Lst_Member(job->node->commands,
685 (ClientData)cmd));
686 return 1;
687 }
688 return 0;
689 }
690
691 #define DBPRINTF(fmt, arg) if (DEBUG(JOB)) { \
692 (void) fprintf(stdout, fmt, arg); \
693 (void) fflush(stdout); \
694 } \
695 (void) fprintf(job->cmdFILE, fmt, arg); \
696 (void) fflush(job->cmdFILE);
697
698 numCommands += 1;
699
700 cmdStart = cmd = Var_Subst(NULL, cmd, job->node, FALSE);
701
702 cmdTemplate = "%s\n";
703
704 /*
705 * Check for leading @' and -'s to control echoing and error checking.
706 */
707 while (*cmd == '@' || *cmd == '-' || (*cmd == '+')) {
708 switch (*cmd) {
709 case '@':
710 shutUp = TRUE;
711 break;
712 case '-':
713 errOff = TRUE;
714 break;
715 case '+':
716 if (noSpecials) {
717 /*
718 * We're not actually executing anything...
719 * but this one needs to be - use compat mode just for it.
720 */
721 CompatRunCommand(cmdp, (ClientData)job->node);
722 return 0;
723 }
724 break;
725 }
726 cmd++;
727 }
728
729 while (isspace((unsigned char) *cmd))
730 cmd++;
731
732 /*
733 * If the shell doesn't have error control the alternate echo'ing will
734 * be done (to avoid showing additional error checking code)
735 * and this will need the characters '$ ` \ "' escaped
736 */
737
738 if (!commandShell->hasErrCtl) {
739 /* Worst that could happen is every char needs escaping. */
740 escCmd = emalloc((strlen(cmd) * 2) + 1);
741 for (i = 0, j= 0; cmd[i] != '\0'; i++, j++) {
742 if (cmd[i] == '$' || cmd[i] == '`' || cmd[i] == '\\' ||
743 cmd[i] == '"')
744 escCmd[j++] = '\\';
745 escCmd[j] = cmd[i];
746 }
747 escCmd[j] = 0;
748 }
749
750 if (shutUp) {
751 if (!(job->flags & JOB_SILENT) && !noSpecials &&
752 commandShell->hasEchoCtl) {
753 DBPRINTF("%s\n", commandShell->echoOff);
754 } else {
755 if (commandShell->hasErrCtl)
756 shutUp = FALSE;
757 }
758 }
759
760 if (errOff) {
761 if ( !(job->flags & JOB_IGNERR) && !noSpecials) {
762 if (commandShell->hasErrCtl) {
763 /*
764 * we don't want the error-control commands showing
765 * up either, so we turn off echoing while executing
766 * them. We could put another field in the shell
767 * structure to tell JobDoOutput to look for this
768 * string too, but why make it any more complex than
769 * it already is?
770 */
771 if (!(job->flags & JOB_SILENT) && !shutUp &&
772 commandShell->hasEchoCtl) {
773 DBPRINTF("%s\n", commandShell->echoOff);
774 DBPRINTF("%s\n", commandShell->ignErr);
775 DBPRINTF("%s\n", commandShell->echoOn);
776 } else {
777 DBPRINTF("%s\n", commandShell->ignErr);
778 }
779 } else if (commandShell->ignErr &&
780 (*commandShell->ignErr != '\0'))
781 {
782 /*
783 * The shell has no error control, so we need to be
784 * weird to get it to ignore any errors from the command.
785 * If echoing is turned on, we turn it off and use the
786 * errCheck template to echo the command. Leave echoing
787 * off so the user doesn't see the weirdness we go through
788 * to ignore errors. Set cmdTemplate to use the weirdness
789 * instead of the simple "%s\n" template.
790 */
791 if (!(job->flags & JOB_SILENT) && !shutUp) {
792 if (commandShell->hasEchoCtl) {
793 DBPRINTF("%s\n", commandShell->echoOff);
794 }
795 DBPRINTF(commandShell->errCheck, escCmd);
796 shutUp = TRUE;
797 } else {
798 if (!shutUp) {
799 DBPRINTF(commandShell->errCheck, escCmd);
800 }
801 }
802 cmdTemplate = commandShell->ignErr;
803 /*
804 * The error ignoration (hee hee) is already taken care
805 * of by the ignErr template, so pretend error checking
806 * is still on.
807 */
808 errOff = FALSE;
809 } else {
810 errOff = FALSE;
811 }
812 } else {
813 errOff = FALSE;
814 }
815 } else {
816
817 /*
818 * If errors are being checked and the shell doesn't have error control
819 * but does supply an errOut template, then setup commands to run
820 * through it.
821 */
822
823 if (!commandShell->hasErrCtl && commandShell->errOut &&
824 (*commandShell->errOut != '\0')) {
825 if (!(job->flags & JOB_SILENT) && !shutUp) {
826 if (commandShell->hasEchoCtl) {
827 DBPRINTF("%s\n", commandShell->echoOff);
828 }
829 DBPRINTF(commandShell->errCheck, escCmd);
830 shutUp = TRUE;
831 }
832 /* If it's a comment line, treat it like an ignored error */
833 if (escCmd[0] == commandShell->commentChar)
834 cmdTemplate = commandShell->ignErr;
835 else
836 cmdTemplate = commandShell->errOut;
837 errOff = FALSE;
838 }
839 }
840
841 if (DEBUG(SHELL) && strcmp(shellName, "sh") == 0 &&
842 (job->flags & JOB_TRACED) == 0) {
843 DBPRINTF("set -%s\n", "x");
844 job->flags |= JOB_TRACED;
845 }
846
847 if ((cp = Check_Cwd_Cmd(cmd)) != NULL) {
848 DBPRINTF("test -d %s && ", cp);
849 DBPRINTF("cd %s\n", cp);
850 }
851
852 DBPRINTF(cmdTemplate, cmd);
853 free(cmdStart);
854 if (escCmd)
855 free(escCmd);
856 if (errOff) {
857 /*
858 * If echoing is already off, there's no point in issuing the
859 * echoOff command. Otherwise we issue it and pretend it was on
860 * for the whole command...
861 */
862 if (!shutUp && !(job->flags & JOB_SILENT) && commandShell->hasEchoCtl){
863 DBPRINTF("%s\n", commandShell->echoOff);
864 shutUp = TRUE;
865 }
866 DBPRINTF("%s\n", commandShell->errCheck);
867 }
868 if (shutUp && commandShell->hasEchoCtl) {
869 DBPRINTF("%s\n", commandShell->echoOn);
870 }
871 if (cp != NULL) {
872 DBPRINTF("test -d %s && ", cp);
873 DBPRINTF("cd %s\n", Var_Value(".OBJDIR", VAR_GLOBAL, &tmp));
874 }
875 return 0;
876 }
877
878 /*-
879 *-----------------------------------------------------------------------
880 * JobSaveCommand --
881 * Save a command to be executed when everything else is done.
882 * Callback function for JobFinish...
883 *
884 * Results:
885 * Always returns 0
886 *
887 * Side Effects:
888 * The command is tacked onto the end of postCommands's commands list.
889 *
890 *-----------------------------------------------------------------------
891 */
892 static int
893 JobSaveCommand(ClientData cmd, ClientData gn)
894 {
895 cmd = (ClientData) Var_Subst(NULL, (char *) cmd, (GNode *) gn, FALSE);
896 (void) Lst_AtEnd(postCommands->commands, cmd);
897 return(0);
898 }
899
900
901 /*-
902 *-----------------------------------------------------------------------
903 * JobClose --
904 * Called to close both input and output pipes when a job is finished.
905 *
906 * Results:
907 * Nada
908 *
909 * Side Effects:
910 * The file descriptors associated with the job are closed.
911 *
912 *-----------------------------------------------------------------------
913 */
914 static void
915 JobClose(Job *job)
916 {
917 if (usePipes && (job->flags & JOB_FIRST)) {
918 #ifdef RMT_WILL_WATCH
919 Rmt_Ignore(job->inPipe);
920 #else
921 clearfd(job);
922 #endif
923 if (job->outPipe != job->inPipe) {
924 (void) close(job->outPipe);
925 }
926 JobDoOutput(job, TRUE);
927 (void) close(job->inPipe);
928 } else {
929 (void) close(job->outFd);
930 JobDoOutput(job, TRUE);
931 }
932 }
933
934 /*-
935 *-----------------------------------------------------------------------
936 * JobFinish --
937 * Do final processing for the given job including updating
938 * parents and starting new jobs as available/necessary. Note
939 * that we pay no attention to the JOB_IGNERR flag here.
940 * This is because when we're called because of a noexecute flag
941 * or something, jstat.w_status is 0 and when called from
942 * Job_CatchChildren, the status is zeroed if it s/b ignored.
943 *
944 * Input:
945 * job job to finish
946 * status sub-why job went away
947 *
948 * Results:
949 * None
950 *
951 * Side Effects:
952 * Some nodes may be put on the toBeMade queue.
953 * Final commands for the job are placed on postCommands.
954 *
955 * If we got an error and are aborting (aborting == ABORT_ERROR) and
956 * the job list is now empty, we are done for the day.
957 * If we recognized an error (errors !=0), we set the aborting flag
958 * to ABORT_ERROR so no more jobs will be started.
959 *-----------------------------------------------------------------------
960 */
961 /*ARGSUSED*/
962 static void
963 JobFinish(Job *job, int *status)
964 {
965 Boolean done;
966
967 if ((WIFEXITED(*status) &&
968 (((WEXITSTATUS(*status) != 0) && !(job->flags & JOB_IGNERR)))) ||
969 WIFSIGNALED(*status))
970 {
971 /*
972 * If it exited non-zero and either we're doing things our
973 * way or we're not ignoring errors, the job is finished.
974 * Similarly, if the shell died because of a signal
975 * the job is also finished. In these
976 * cases, finish out the job's output before printing the exit
977 * status...
978 */
979 #ifdef REMOTE
980 KILL(job->pid, SIGCONT);
981 #endif
982 JobClose(job);
983 if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
984 (void) fclose(job->cmdFILE);
985 job->cmdFILE = NULL;
986 }
987 done = TRUE;
988 #ifdef REMOTE
989 if (job->flags & JOB_REMOTE)
990 Rmt_Done(job->rmtID, job->node);
991 #endif
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 #ifdef REMOTE
1009 if (job->flags & JOB_REMOTE)
1010 Rmt_Done(job->rmtID, job->node);
1011 #endif /* REMOTE */
1012 } else {
1013 /*
1014 * No need to close things down or anything.
1015 */
1016 done = FALSE;
1017 }
1018
1019 if (done ||
1020 WIFSTOPPED(*status) ||
1021 (WIFSIGNALED(*status) && (WTERMSIG(*status) == SIGCONT)))
1022 {
1023 FILE *out;
1024
1025 if (compatMake && !usePipes && (job->flags & JOB_IGNERR)) {
1026 /*
1027 * If output is going to a file and this job is ignoring
1028 * errors, arrange to have the exit status sent to the
1029 * output file as well.
1030 */
1031 out = fdopen(job->outFd, "w");
1032 if (out == NULL)
1033 Punt("Cannot fdopen");
1034 } else {
1035 out = stdout;
1036 }
1037
1038 if (WIFEXITED(*status)) {
1039 if (DEBUG(JOB)) {
1040 (void) fprintf(stdout, "Process %d [%s] exited.\n",
1041 job->pid, job->node->name);
1042 (void) fflush(stdout);
1043 }
1044 if (WEXITSTATUS(*status) != 0) {
1045 if (usePipes && job->node != lastNode) {
1046 MESSAGE(out, job->node);
1047 lastNode = job->node;
1048 }
1049 (void) fprintf(out, "*** [%s] Error code %d%s\n",
1050 job->node->name,
1051 WEXITSTATUS(*status),
1052 (job->flags & JOB_IGNERR) ? "(ignored)" : "");
1053
1054 if (job->flags & JOB_IGNERR) {
1055 *status = 0;
1056 }
1057 } else if (DEBUG(JOB)) {
1058 if (usePipes && job->node != lastNode) {
1059 MESSAGE(out, job->node);
1060 lastNode = job->node;
1061 }
1062 (void) fprintf(out, "*** [%s] Completed successfully\n",
1063 job->node->name);
1064 }
1065 } else if (WIFSTOPPED(*status) && WSTOPSIG(*status) != SIGCONT) {
1066 if (DEBUG(JOB)) {
1067 (void) fprintf(stdout, "Process %d (%s) stopped.\n",
1068 job->pid, job->node->name);
1069 (void) fflush(stdout);
1070 }
1071 if (usePipes && job->node != lastNode) {
1072 MESSAGE(out, job->node);
1073 lastNode = job->node;
1074 }
1075 if (!(job->flags & JOB_REMIGRATE)) {
1076 switch (WSTOPSIG(*status)) {
1077 case SIGTSTP:
1078 (void) fprintf(out, "*** [%s] Suspended\n",
1079 job->node->name);
1080 break;
1081 case SIGSTOP:
1082 (void) fprintf(out, "*** [%s] Stopped\n",
1083 job->node->name);
1084 break;
1085 default:
1086 (void) fprintf(out, "*** [%s] Stopped -- signal %d\n",
1087 job->node->name, WSTOPSIG(*status));
1088 }
1089 }
1090 job->flags |= JOB_RESUME;
1091 (void)Lst_AtEnd(stoppedJobs, (ClientData)job);
1092 #ifdef REMOTE
1093 if (job->flags & JOB_REMIGRATE)
1094 JobRestart(job);
1095 #endif
1096 (void) fflush(out);
1097 return;
1098 } else if (WIFSTOPPED(*status) && WSTOPSIG(*status) == SIGCONT) {
1099 /*
1100 * If the beastie has continued, shift the Job from the stopped
1101 * list to the running one (or re-stop it if concurrency is
1102 * exceeded) and go and get another child.
1103 */
1104 if (job->flags & (JOB_RESUME|JOB_REMIGRATE|JOB_RESTART)) {
1105 if (usePipes && job->node != lastNode) {
1106 MESSAGE(out, job->node);
1107 lastNode = job->node;
1108 }
1109 (void) fprintf(out, "*** [%s] Continued\n", job->node->name);
1110 }
1111 if (!(job->flags & JOB_CONTINUING)) {
1112 if (DEBUG(JOB)) {
1113 (void) fprintf(stdout,
1114 "Warning: process %d [%s] was not continuing.\n",
1115 job->pid, job->node->name);
1116 (void) fflush(stdout);
1117 }
1118 #ifdef notdef
1119 /*
1120 * We don't really want to restart a job from scratch just
1121 * because it continued, especially not without killing the
1122 * continuing process! That's why this is ifdef'ed out.
1123 * FD - 9/17/90
1124 */
1125 JobRestart(job);
1126 #endif
1127 }
1128 job->flags &= ~JOB_CONTINUING;
1129 Lst_AtEnd(jobs, (ClientData)job);
1130 nJobs += 1;
1131 if (!(job->flags & JOB_REMOTE)) {
1132 if (DEBUG(JOB)) {
1133 (void) fprintf(stdout,
1134 "Process %d is continuing locally.\n",
1135 job->pid);
1136 (void) fflush(stdout);
1137 }
1138 nLocal += 1;
1139 }
1140 (void) fflush(out);
1141 return;
1142 } else {
1143 if (usePipes && job->node != lastNode) {
1144 MESSAGE(out, job->node);
1145 lastNode = job->node;
1146 }
1147 (void) fprintf(out, "*** [%s] Signal %d\n",
1148 job->node->name, WTERMSIG(*status));
1149 }
1150
1151 (void) fflush(out);
1152 }
1153
1154 /*
1155 * Now handle the -B-mode stuff. If the beast still isn't finished,
1156 * try and restart the job on the next command. If JobStart says it's
1157 * ok, it's ok. If there's an error, this puppy is done.
1158 */
1159 if (compatMake && (WIFEXITED(*status) &&
1160 !Lst_IsAtEnd(job->node->commands))) {
1161 switch (JobStart(job->node, job->flags & JOB_IGNDOTS, job)) {
1162 case JOB_RUNNING:
1163 done = FALSE;
1164 break;
1165 case JOB_ERROR:
1166 done = TRUE;
1167 *status = W_EXITCODE(1, 0);
1168 break;
1169 case JOB_FINISHED:
1170 /*
1171 * If we got back a JOB_FINISHED code, JobStart has already
1172 * called Make_Update and freed the job descriptor. We set
1173 * done to false here to avoid fake cycles and double frees.
1174 * JobStart needs to do the update so we can proceed up the
1175 * graph when given the -n flag..
1176 */
1177 done = FALSE;
1178 break;
1179 }
1180 } else {
1181 done = TRUE;
1182 }
1183
1184 if (done) {
1185 Trace_Log(JOBEND, job);
1186 if (!compatMake && !(job->flags & JOB_SPECIAL)) {
1187 if ((*status != 0) ||
1188 (aborting == ABORT_ERROR) ||
1189 (aborting == ABORT_INTERRUPT))
1190 Job_TokenReturn();
1191 }
1192
1193 }
1194
1195 if (done &&
1196 (aborting != ABORT_ERROR) &&
1197 (aborting != ABORT_INTERRUPT) &&
1198 (*status == 0))
1199 {
1200 /*
1201 * As long as we aren't aborting and the job didn't return a non-zero
1202 * status that we shouldn't ignore, we call Make_Update to update
1203 * the parents. In addition, any saved commands for the node are placed
1204 * on the .END target.
1205 */
1206 if (job->tailCmds != NILLNODE) {
1207 Lst_ForEachFrom(job->node->commands, job->tailCmds,
1208 JobSaveCommand,
1209 (ClientData)job->node);
1210 }
1211 job->node->made = MADE;
1212 if (!(job->flags & JOB_SPECIAL))
1213 Job_TokenReturn();
1214 Make_Update(job->node);
1215 free((Address)job);
1216 } else if (*status != 0) {
1217 errors += 1;
1218 free((Address)job);
1219 }
1220 JobRestartJobs();
1221
1222 /*
1223 * Set aborting if any error.
1224 */
1225 if (errors && !keepgoing && (aborting != ABORT_INTERRUPT)) {
1226 /*
1227 * If we found any errors in this batch of children and the -k flag
1228 * wasn't given, we set the aborting flag so no more jobs get
1229 * started.
1230 */
1231 aborting = ABORT_ERROR;
1232 }
1233
1234 if ((aborting == ABORT_ERROR) && Job_Empty()) {
1235 /*
1236 * If we are aborting and the job table is now empty, we finish.
1237 */
1238 Finish(errors);
1239 }
1240 }
1241
1242 /*-
1243 *-----------------------------------------------------------------------
1244 * Job_Touch --
1245 * Touch the given target. Called by JobStart when the -t flag was
1246 * given
1247 *
1248 * Input:
1249 * gn the node of the file to touch
1250 * silent TRUE if should not print message
1251 *
1252 * Results:
1253 * None
1254 *
1255 * Side Effects:
1256 * The data modification of the file is changed. In addition, if the
1257 * file did not exist, it is created.
1258 *-----------------------------------------------------------------------
1259 */
1260 void
1261 Job_Touch(GNode *gn, Boolean silent)
1262 {
1263 int streamID; /* ID of stream opened to do the touch */
1264 struct utimbuf times; /* Times for utime() call */
1265
1266 if (gn->type & (OP_JOIN|OP_USE|OP_USEBEFORE|OP_EXEC|OP_OPTIONAL|OP_PHONY)) {
1267 /*
1268 * .JOIN, .USE, .ZEROTIME and .OPTIONAL targets are "virtual" targets
1269 * and, as such, shouldn't really be created.
1270 */
1271 return;
1272 }
1273
1274 if (!silent || NoExecute(gn)) {
1275 (void) fprintf(stdout, "touch %s\n", gn->name);
1276 (void) fflush(stdout);
1277 }
1278
1279 if (NoExecute(gn)) {
1280 return;
1281 }
1282
1283 if (gn->type & OP_ARCHV) {
1284 Arch_Touch(gn);
1285 } else if (gn->type & OP_LIB) {
1286 Arch_TouchLib(gn);
1287 } else {
1288 char *file = gn->path ? gn->path : gn->name;
1289
1290 times.actime = times.modtime = now;
1291 if (utime(file, ×) < 0){
1292 streamID = open(file, O_RDWR | O_CREAT, 0666);
1293
1294 if (streamID >= 0) {
1295 char c;
1296
1297 /*
1298 * Read and write a byte to the file to change the
1299 * modification time, then close the file.
1300 */
1301 if (read(streamID, &c, 1) == 1) {
1302 (void) lseek(streamID, (off_t)0, SEEK_SET);
1303 (void) write(streamID, &c, 1);
1304 }
1305
1306 (void) close(streamID);
1307 } else {
1308 (void) fprintf(stdout, "*** couldn't touch %s: %s",
1309 file, strerror(errno));
1310 (void) fflush(stdout);
1311 }
1312 }
1313 }
1314 }
1315
1316 /*-
1317 *-----------------------------------------------------------------------
1318 * Job_CheckCommands --
1319 * Make sure the given node has all the commands it needs.
1320 *
1321 * Input:
1322 * gn The target whose commands need verifying
1323 * abortProc Function to abort with message
1324 *
1325 * Results:
1326 * TRUE if the commands list is/was ok.
1327 *
1328 * Side Effects:
1329 * The node will have commands from the .DEFAULT rule added to it
1330 * if it needs them.
1331 *-----------------------------------------------------------------------
1332 */
1333 Boolean
1334 Job_CheckCommands(GNode *gn, void (*abortProc)(const char *, ...))
1335 {
1336 if (OP_NOP(gn->type) && Lst_IsEmpty(gn->commands) &&
1337 ((gn->type & OP_LIB) == 0 || Lst_IsEmpty(gn->children))) {
1338 /*
1339 * No commands. Look for .DEFAULT rule from which we might infer
1340 * commands
1341 */
1342 if ((DEFAULT != NILGNODE) && !Lst_IsEmpty(DEFAULT->commands)) {
1343 char *p1;
1344 /*
1345 * Make only looks for a .DEFAULT if the node was never the
1346 * target of an operator, so that's what we do too. If
1347 * a .DEFAULT was given, we substitute its commands for gn's
1348 * commands and set the IMPSRC variable to be the target's name
1349 * The DEFAULT node acts like a transformation rule, in that
1350 * gn also inherits any attributes or sources attached to
1351 * .DEFAULT itself.
1352 */
1353 Make_HandleUse(DEFAULT, gn);
1354 Var_Set(IMPSRC, Var_Value(TARGET, gn, &p1), gn, 0);
1355 if (p1)
1356 free(p1);
1357 } else if (Dir_MTime(gn) == 0) {
1358 /*
1359 * The node wasn't the target of an operator we have no .DEFAULT
1360 * rule to go on and the target doesn't already exist. There's
1361 * nothing more we can do for this branch. If the -k flag wasn't
1362 * given, we stop in our tracks, otherwise we just don't update
1363 * this node's parents so they never get examined.
1364 */
1365 static const char msg[] = ": don't know how to make";
1366
1367 if (gn->type & OP_OPTIONAL) {
1368 (void) fprintf(stdout, "%s%s %s(ignored)\n", progname,
1369 msg, gn->name);
1370 (void) fflush(stdout);
1371 } else if (keepgoing) {
1372 (void) fprintf(stdout, "%s%s %s(continuing)\n", progname,
1373 msg, gn->name);
1374 (void) fflush(stdout);
1375 return FALSE;
1376 } else {
1377 (*abortProc)("%s%s %s. Stop", progname, msg, gn->name);
1378 return FALSE;
1379 }
1380 }
1381 }
1382 return TRUE;
1383 }
1384 #ifdef RMT_WILL_WATCH
1385 /*-
1386 *-----------------------------------------------------------------------
1387 * JobLocalInput --
1388 * Handle a pipe becoming readable. Callback function for Rmt_Watch
1389 *
1390 * Input:
1391 * stream Stream that's ready (ignored)
1392 * job Job to which the stream belongs
1393 *
1394 * Results:
1395 * None
1396 *
1397 * Side Effects:
1398 * JobDoOutput is called.
1399 *
1400 *-----------------------------------------------------------------------
1401 */
1402 /*ARGSUSED*/
1403 static void
1404 JobLocalInput(int stream, Job *job)
1405 {
1406 JobDoOutput(job, FALSE);
1407 }
1408 #endif /* RMT_WILL_WATCH */
1409
1410 /*-
1411 *-----------------------------------------------------------------------
1412 * JobExec --
1413 * Execute the shell for the given job. Called from JobStart and
1414 * JobRestart.
1415 *
1416 * Input:
1417 * job Job to execute
1418 *
1419 * Results:
1420 * None.
1421 *
1422 * Side Effects:
1423 * A shell is executed, outputs is altered and the Job structure added
1424 * to the job table.
1425 *
1426 *-----------------------------------------------------------------------
1427 */
1428 static void
1429 JobExec(Job *job, char **argv)
1430 {
1431 int cpid; /* ID of new child */
1432 sigset_t mask;
1433
1434 job->flags &= ~JOB_TRACED;
1435
1436 if (DEBUG(JOB)) {
1437 int i;
1438
1439 (void) fprintf(stdout, "Running %s %sly\n", job->node->name,
1440 job->flags&JOB_REMOTE?"remote":"local");
1441 (void) fprintf(stdout, "\tCommand: ");
1442 for (i = 0; argv[i] != NULL; i++) {
1443 (void) fprintf(stdout, "%s ", argv[i]);
1444 }
1445 (void) fprintf(stdout, "\n");
1446 (void) fflush(stdout);
1447 }
1448
1449 /*
1450 * Some jobs produce no output and it's disconcerting to have
1451 * no feedback of their running (since they produce no output, the
1452 * banner with their name in it never appears). This is an attempt to
1453 * provide that feedback, even if nothing follows it.
1454 */
1455 if ((lastNode != job->node) && (job->flags & JOB_FIRST) &&
1456 !(job->flags & JOB_SILENT)) {
1457 MESSAGE(stdout, job->node);
1458 lastNode = job->node;
1459 }
1460
1461 #ifdef RMT_NO_EXEC
1462 if (job->flags & JOB_REMOTE) {
1463 goto jobExecFinish;
1464 }
1465 #endif /* RMT_NO_EXEC */
1466
1467 /* No interruptions until this job is on the `jobs' list */
1468 JobSigLock(&mask);
1469
1470 if ((cpid = vfork()) == -1) {
1471 Punt("Cannot vfork: %s", strerror(errno));
1472 } else if (cpid == 0) {
1473
1474 /*
1475 * Reset all signal handlers; this is necessary because we also
1476 * need to unblock signals before we exec(2).
1477 */
1478 JobSigReset();
1479
1480 /* Now unblock signals */
1481 sigemptyset(&mask);
1482 JobSigUnlock(&mask);
1483
1484 /*
1485 * Must duplicate the input stream down to the child's input and
1486 * reset it to the beginning (again). Since the stream was marked
1487 * close-on-exec, we must clear that bit in the new input.
1488 */
1489 if (dup2(FILENO(job->cmdFILE), 0) == -1) {
1490 execError("dup2", "job->cmdFILE");
1491 _exit(1);
1492 }
1493 (void) fcntl(0, F_SETFD, 0);
1494 (void) lseek(0, (off_t)0, SEEK_SET);
1495
1496 if (job->node->type & OP_MAKE) {
1497 /*
1498 * Pass job token pipe to submakes.
1499 */
1500 fcntl(job_pipe[0], F_SETFD, 0);
1501 fcntl(job_pipe[1], F_SETFD, 0);
1502 }
1503
1504 if (usePipes) {
1505 /*
1506 * Set up the child's output to be routed through the pipe
1507 * we've created for it.
1508 */
1509 if (dup2(job->outPipe, 1) == -1) {
1510 execError("dup2", "job->outPipe");
1511 _exit(1);
1512 }
1513 } else {
1514 /*
1515 * We're capturing output in a file, so we duplicate the
1516 * descriptor to the temporary file into the standard
1517 * output.
1518 */
1519 if (dup2(job->outFd, 1) == -1) {
1520 execError("dup2", "job->outFd");
1521 _exit(1);
1522 }
1523 }
1524 /*
1525 * The output channels are marked close on exec. This bit was
1526 * duplicated by the dup2 (on some systems), so we have to clear
1527 * it before routing the shell's error output to the same place as
1528 * its standard output.
1529 */
1530 (void) fcntl(1, F_SETFD, 0);
1531 if (dup2(1, 2) == -1) {
1532 execError("dup2", "1, 2");
1533 _exit(1);
1534 }
1535
1536 #ifdef USE_PGRP
1537 /*
1538 * We want to switch the child into a different process family so
1539 * we can kill it and all its descendants in one fell swoop,
1540 * by killing its process family, but not commit suicide.
1541 */
1542 # if defined(SYSV)
1543 (void) setsid();
1544 # else
1545 (void) setpgid(0, getpid());
1546 # endif
1547 #endif /* USE_PGRP */
1548
1549 #ifdef REMOTE
1550 if (job->flags & JOB_REMOTE) {
1551 Rmt_Exec(shellPath, argv, FALSE);
1552 } else
1553 #endif /* REMOTE */
1554 {
1555 (void) execv(shellPath, argv);
1556 execError("exec", shellPath);
1557 }
1558 _exit(1);
1559 } else {
1560 job->pid = cpid;
1561
1562 Trace_Log(JOBSTART, job);
1563
1564 if (usePipes && (job->flags & JOB_FIRST)) {
1565 /*
1566 * The first time a job is run for a node, we set the current
1567 * position in the buffer to the beginning and mark another
1568 * stream to watch in the outputs mask
1569 */
1570 job->curPos = 0;
1571
1572 #ifdef RMT_WILL_WATCH
1573 Rmt_Watch(job->inPipe, JobLocalInput, job);
1574 #else
1575 watchfd(job);
1576 #endif /* RMT_WILL_WATCH */
1577 }
1578
1579 if (job->flags & JOB_REMOTE) {
1580 #ifndef REMOTE
1581 job->rmtID = 0;
1582 #else
1583 job->rmtID = Rmt_LastID(job->pid);
1584 #endif /* REMOTE */
1585 } else {
1586 nLocal += 1;
1587 /*
1588 * XXX: Used to not happen if REMOTE. Why?
1589 */
1590 if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
1591 (void) fclose(job->cmdFILE);
1592 job->cmdFILE = NULL;
1593 }
1594 }
1595 }
1596
1597 #ifdef RMT_NO_EXEC
1598 jobExecFinish:
1599 #endif
1600 /*
1601 * Now the job is actually running, add it to the table.
1602 */
1603 if (DEBUG(JOB)) {
1604 printf("JobExec(%s): pid %d added to jobs table\n",
1605 job->node->name, job->pid);
1606 }
1607 nJobs += 1;
1608 (void) Lst_AtEnd(jobs, (ClientData)job);
1609 JobSigUnlock(&mask);
1610 }
1611
1612 /*-
1613 *-----------------------------------------------------------------------
1614 * JobMakeArgv --
1615 * Create the argv needed to execute the shell for a given job.
1616 *
1617 *
1618 * Results:
1619 *
1620 * Side Effects:
1621 *
1622 *-----------------------------------------------------------------------
1623 */
1624 static void
1625 JobMakeArgv(Job *job, char **argv)
1626 {
1627 int argc;
1628 static char args[10]; /* For merged arguments */
1629
1630 argv[0] = UNCONST(shellName);
1631 argc = 1;
1632
1633 if ((commandShell->exit && (*commandShell->exit != '-')) ||
1634 (commandShell->echo && (*commandShell->echo != '-')))
1635 {
1636 /*
1637 * At least one of the flags doesn't have a minus before it, so
1638 * merge them together. Have to do this because the *(&(@*#*&#$#
1639 * Bourne shell thinks its second argument is a file to source.
1640 * Grrrr. Note the ten-character limitation on the combined arguments.
1641 */
1642 (void)snprintf(args, sizeof(args), "-%s%s",
1643 ((job->flags & JOB_IGNERR) ? "" :
1644 (commandShell->exit ? commandShell->exit : "")),
1645 ((job->flags & JOB_SILENT) ? "" :
1646 (commandShell->echo ? commandShell->echo : "")));
1647
1648 if (args[1]) {
1649 argv[argc] = args;
1650 argc++;
1651 }
1652 } else {
1653 if (!(job->flags & JOB_IGNERR) && commandShell->exit) {
1654 argv[argc] = UNCONST(commandShell->exit);
1655 argc++;
1656 }
1657 if (!(job->flags & JOB_SILENT) && commandShell->echo) {
1658 argv[argc] = UNCONST(commandShell->echo);
1659 argc++;
1660 }
1661 }
1662 argv[argc] = NULL;
1663 }
1664
1665 /*-
1666 *-----------------------------------------------------------------------
1667 * JobRestart --
1668 * Restart a job that stopped for some reason.
1669 *
1670 * Input:
1671 * job Job to restart
1672 *
1673 * Results:
1674 * 1 if max number of running jobs has been reached, 0 otherwise.
1675 *
1676 *-----------------------------------------------------------------------
1677 */
1678 static int
1679 JobRestart(Job *job)
1680 {
1681 #ifdef REMOTE
1682 int host;
1683 #endif
1684
1685 if (job->flags & JOB_REMIGRATE) {
1686 if (
1687 #ifdef REMOTE
1688 verboseRemigrates ||
1689 #endif
1690 DEBUG(JOB)) {
1691 (void) fprintf(stdout, "*** remigrating %x(%s)\n",
1692 job->pid, job->node->name);
1693 (void) fflush(stdout);
1694 }
1695
1696 #ifdef REMOTE
1697 if (!Rmt_ReExport(job->pid, job->node, &host)) {
1698 if (verboseRemigrates || DEBUG(JOB)) {
1699 (void) fprintf(stdout, "*** couldn't migrate...\n");
1700 (void) fflush(stdout);
1701 }
1702 #endif
1703 if (nLocal != maxLocal) {
1704 /*
1705 * Job cannot be remigrated, but there's room on the local
1706 * machine, so resume the job and note that another
1707 * local job has started.
1708 */
1709 if (
1710 #ifdef REMOTE
1711 verboseRemigrates ||
1712 #endif
1713 DEBUG(JOB)) {
1714 (void) fprintf(stdout, "*** resuming on local machine\n");
1715 (void) fflush(stdout);
1716 }
1717 KILL(job->pid, SIGCONT);
1718 nLocal +=1;
1719 #ifdef REMOTE
1720 job->flags &= ~(JOB_REMIGRATE|JOB_RESUME|JOB_REMOTE);
1721 job->flags |= JOB_CONTINUING;
1722 #else
1723 job->flags &= ~(JOB_REMIGRATE|JOB_RESUME);
1724 #endif
1725 } else {
1726 /*
1727 * Job cannot be restarted. Mark the table as full and
1728 * place the job back on the list of stopped jobs.
1729 */
1730 if (
1731 #ifdef REMOTE
1732 verboseRemigrates ||
1733 #endif
1734 DEBUG(JOB)) {
1735 (void) fprintf(stdout, "*** holding\n");
1736 (void) fflush(stdout);
1737 }
1738 (void)Lst_AtFront(stoppedJobs, (ClientData)job);
1739 return 1;
1740 }
1741 #ifdef REMOTE
1742 } else {
1743 /*
1744 * Clear out the remigrate and resume flags. Set the continuing
1745 * flag so we know later on that the process isn't exiting just
1746 * because of a signal.
1747 */
1748 job->flags &= ~(JOB_REMIGRATE|JOB_RESUME);
1749 job->flags |= JOB_CONTINUING;
1750 job->rmtID = host;
1751 }
1752 #endif
1753
1754 (void)Lst_AtEnd(jobs, (ClientData)job);
1755 nJobs += 1;
1756 } else if (job->flags & JOB_RESTART) {
1757 /*
1758 * Set up the control arguments to the shell. This is based on the
1759 * flags set earlier for this job. If the JOB_IGNERR flag is clear,
1760 * the 'exit' flag of the commandShell is used to cause it to exit
1761 * upon receiving an error. If the JOB_SILENT flag is clear, the
1762 * 'echo' flag of the commandShell is used to get it to start echoing
1763 * as soon as it starts processing commands.
1764 */
1765 char *argv[10];
1766
1767 JobMakeArgv(job, argv);
1768
1769 if (DEBUG(JOB)) {
1770 (void) fprintf(stdout, "Restarting %s...", job->node->name);
1771 (void) fflush(stdout);
1772 }
1773 #ifdef REMOTE
1774 if ((job->node->type & OP_NOEXPORT) ||
1775 (nLocal < maxLocal && runLocalFirst)
1776 # ifdef RMT_NO_EXEC
1777 || !Rmt_Export(shellPath, argv, job)
1778 # else
1779 || !Rmt_Begin(shellPath, argv, job->node)
1780 # endif
1781 )
1782 #endif
1783 {
1784 if (((nLocal >= maxLocal) && !(job->flags & JOB_SPECIAL))) {
1785 /*
1786 * Can't be exported and not allowed to run locally -- put it
1787 * back on the hold queue and mark the table full
1788 */
1789 if (DEBUG(JOB)) {
1790 (void) fprintf(stdout, "holding\n");
1791 (void) fflush(stdout);
1792 }
1793 (void)Lst_AtFront(stoppedJobs, (ClientData)job);
1794 return 1;
1795 } else {
1796 /*
1797 * Job may be run locally.
1798 */
1799 if (DEBUG(JOB)) {
1800 (void) fprintf(stdout, "running locally\n");
1801 (void) fflush(stdout);
1802 }
1803 job->flags &= ~JOB_REMOTE;
1804 }
1805 }
1806 #ifdef REMOTE
1807 else {
1808 /*
1809 * Can be exported. Hooray!
1810 */
1811 if (DEBUG(JOB)) {
1812 (void) fprintf(stdout, "exporting\n");
1813 (void) fflush(stdout);
1814 }
1815 job->flags |= JOB_REMOTE;
1816 }
1817 #endif
1818 JobExec(job, argv);
1819 } else {
1820 /*
1821 * The job has stopped and needs to be restarted. Why it stopped,
1822 * we don't know...
1823 */
1824 if (DEBUG(JOB)) {
1825 (void) fprintf(stdout, "Resuming %s...", job->node->name);
1826 (void) fflush(stdout);
1827 }
1828 if ((nJobs != maxJobs) &&
1829 ((job->flags & JOB_REMOTE) ||
1830 (nLocal < maxLocal) ||
1831 ((maxLocal == 0) &&
1832 ((job->flags & JOB_SPECIAL)
1833 #ifdef REMOTE
1834 && (job->node->type & OP_NOEXPORT)
1835 #endif
1836 ))))
1837 {
1838 /*
1839 * If the job is remote, it's ok to resume it as long as the
1840 * maximum concurrency won't be exceeded. If it's local and
1841 * we haven't reached the local concurrency limit already (or the
1842 * job must be run locally and maxLocal is 0), it's also ok to
1843 * resume it.
1844 */
1845 Boolean error;
1846 int status;
1847
1848 #ifdef RMT_WANTS_SIGNALS
1849 if (job->flags & JOB_REMOTE) {
1850 error = !Rmt_Signal(job, SIGCONT);
1851 } else
1852 #endif /* RMT_WANTS_SIGNALS */
1853 error = (KILL(job->pid, SIGCONT) != 0);
1854
1855 if (!error) {
1856 /*
1857 * Make sure the user knows we've continued the beast and
1858 * actually put the thing in the job table.
1859 */
1860 job->flags |= JOB_CONTINUING;
1861 status = W_STOPCODE(SIGCONT);
1862 JobFinish(job, &status);
1863
1864 job->flags &= ~(JOB_RESUME|JOB_CONTINUING);
1865 if (DEBUG(JOB)) {
1866 (void) fprintf(stdout, "done\n");
1867 (void) fflush(stdout);
1868 }
1869 } else {
1870 Error("couldn't resume %s: %s",
1871 job->node->name, strerror(errno));
1872 status = W_EXITCODE(1, 0);
1873 JobFinish(job, &status);
1874 }
1875 } else {
1876 /*
1877 * Job cannot be restarted. Mark the table as full and
1878 * place the job back on the list of stopped jobs.
1879 */
1880 if (DEBUG(JOB)) {
1881 (void) fprintf(stdout, "table full\n");
1882 (void) fflush(stdout);
1883 }
1884 (void) Lst_AtFront(stoppedJobs, (ClientData)job);
1885 return 1;
1886 }
1887 }
1888 return 0;
1889 }
1890
1891 /*-
1892 *-----------------------------------------------------------------------
1893 * JobStart --
1894 * Start a target-creation process going for the target described
1895 * by the graph node gn.
1896 *
1897 * Input:
1898 * gn target to create
1899 * flags flags for the job to override normal ones.
1900 * e.g. JOB_SPECIAL or JOB_IGNDOTS
1901 * previous The previous Job structure for this node, if any.
1902 *
1903 * Results:
1904 * JOB_ERROR if there was an error in the commands, JOB_FINISHED
1905 * if there isn't actually anything left to do for the job and
1906 * JOB_RUNNING if the job has been started.
1907 *
1908 * Side Effects:
1909 * A new Job node is created and added to the list of running
1910 * jobs. PMake is forked and a child shell created.
1911 *-----------------------------------------------------------------------
1912 */
1913 static int
1914 JobStart(GNode *gn, int flags, Job *previous)
1915 {
1916 Job *job; /* new job descriptor */
1917 char *argv[10]; /* Argument vector to shell */
1918 Boolean cmdsOK; /* true if the nodes commands were all right */
1919 Boolean local; /* Set true if the job was run locally */
1920 Boolean noExec; /* Set true if we decide not to run the job */
1921 int tfd; /* File descriptor to the temp file */
1922
1923 if (previous != NULL) {
1924 previous->flags &= ~(JOB_FIRST|JOB_IGNERR|JOB_SILENT|JOB_REMOTE);
1925 job = previous;
1926 } else {
1927 job = emalloc(sizeof(Job));
1928 if (job == NULL) {
1929 Punt("JobStart out of memory");
1930 }
1931 flags |= JOB_FIRST;
1932 }
1933
1934 job->node = gn;
1935 job->tailCmds = NILLNODE;
1936
1937 /*
1938 * Set the initial value of the flags for this job based on the global
1939 * ones and the node's attributes... Any flags supplied by the caller
1940 * are also added to the field.
1941 */
1942 job->flags = 0;
1943 if (Targ_Ignore(gn)) {
1944 job->flags |= JOB_IGNERR;
1945 }
1946 if (Targ_Silent(gn)) {
1947 job->flags |= JOB_SILENT;
1948 }
1949 job->flags |= flags;
1950
1951 /*
1952 * Check the commands now so any attributes from .DEFAULT have a chance
1953 * to migrate to the node
1954 */
1955 if (!compatMake && job->flags & JOB_FIRST) {
1956 cmdsOK = Job_CheckCommands(gn, Error);
1957 } else {
1958 cmdsOK = TRUE;
1959 }
1960
1961 #ifndef RMT_WILL_WATCH
1962 job->inPollfd = NULL;
1963 #endif
1964 /*
1965 * If the -n flag wasn't given, we open up OUR (not the child's)
1966 * temporary file to stuff commands in it. The thing is rd/wr so we don't
1967 * need to reopen it to feed it to the shell. If the -n flag *was* given,
1968 * we just set the file to be stdout. Cute, huh?
1969 */
1970 if (((gn->type & OP_MAKE) && !(noRecursiveExecute)) ||
1971 (!noExecute && !touchFlag)) {
1972 /*
1973 * tfile is the name of a file into which all shell commands are
1974 * put. It is used over by removing it before the child shell is
1975 * executed. The XXXXXX in the string are replaced by the pid of
1976 * the make process in a 6-character field with leading zeroes.
1977 */
1978 char tfile[sizeof(TMPPAT)];
1979 sigset_t mask;
1980 /*
1981 * We're serious here, but if the commands were bogus, we're
1982 * also dead...
1983 */
1984 if (!cmdsOK) {
1985 DieHorribly();
1986 }
1987
1988 JobSigLock(&mask);
1989 (void)strcpy(tfile, TMPPAT);
1990 if ((tfd = mkstemp(tfile)) == -1)
1991 Punt("Could not create temporary file %s", strerror(errno));
1992 (void) eunlink(tfile);
1993 JobSigUnlock(&mask);
1994
1995 job->cmdFILE = fdopen(tfd, "w+");
1996 if (job->cmdFILE == NULL) {
1997 Punt("Could not fdopen %s", tfile);
1998 }
1999 (void) fcntl(FILENO(job->cmdFILE), F_SETFD, 1);
2000 /*
2001 * Send the commands to the command file, flush all its buffers then
2002 * rewind and remove the thing.
2003 */
2004 noExec = FALSE;
2005
2006 /*
2007 * used to be backwards; replace when start doing multiple commands
2008 * per shell.
2009 */
2010 if (compatMake) {
2011 /*
2012 * Be compatible: If this is the first time for this node,
2013 * verify its commands are ok and open the commands list for
2014 * sequential access by later invocations of JobStart.
2015 * Once that is done, we take the next command off the list
2016 * and print it to the command file. If the command was an
2017 * ellipsis, note that there's nothing more to execute.
2018 */
2019 if ((job->flags&JOB_FIRST) && (Lst_Open(gn->commands) != SUCCESS)){
2020 cmdsOK = FALSE;
2021 } else {
2022 LstNode ln = Lst_Next(gn->commands);
2023
2024 if ((ln == NILLNODE) ||
2025 JobPrintCommand((ClientData) Lst_Datum(ln),
2026 (ClientData) job))
2027 {
2028 noExec = TRUE;
2029 Lst_Close(gn->commands);
2030 }
2031 if (noExec && !(job->flags & JOB_FIRST)) {
2032 /*
2033 * If we're not going to execute anything, the job
2034 * is done and we need to close down the various
2035 * file descriptors we've opened for output, then
2036 * call JobDoOutput to catch the final characters or
2037 * send the file to the screen... Note that the i/o streams
2038 * are only open if this isn't the first job.
2039 * Note also that this could not be done in
2040 * Job_CatchChildren b/c it wasn't clear if there were
2041 * more commands to execute or not...
2042 */
2043 JobClose(job);
2044 }
2045 }
2046 } else {
2047 /*
2048 * We can do all the commands at once. hooray for sanity
2049 */
2050 numCommands = 0;
2051 Lst_ForEach(gn->commands, JobPrintCommand, (ClientData)job);
2052
2053 /*
2054 * If we didn't print out any commands to the shell script,
2055 * there's not much point in executing the shell, is there?
2056 */
2057 if (numCommands == 0) {
2058 noExec = TRUE;
2059 }
2060 }
2061 } else if (NoExecute(gn)) {
2062 /*
2063 * Not executing anything -- just print all the commands to stdout
2064 * in one fell swoop. This will still set up job->tailCmds correctly.
2065 */
2066 if (lastNode != gn) {
2067 MESSAGE(stdout, gn);
2068 lastNode = gn;
2069 }
2070 job->cmdFILE = stdout;
2071 /*
2072 * Only print the commands if they're ok, but don't die if they're
2073 * not -- just let the user know they're bad and keep going. It
2074 * doesn't do any harm in this case and may do some good.
2075 */
2076 if (cmdsOK) {
2077 Lst_ForEach(gn->commands, JobPrintCommand, (ClientData)job);
2078 }
2079 /*
2080 * Don't execute the shell, thank you.
2081 */
2082 noExec = TRUE;
2083 } else {
2084 /*
2085 * Just touch the target and note that no shell should be executed.
2086 * Set cmdFILE to stdout to make life easier. Check the commands, too,
2087 * but don't die if they're no good -- it does no harm to keep working
2088 * up the graph.
2089 */
2090 job->cmdFILE = stdout;
2091 Job_Touch(gn, job->flags&JOB_SILENT);
2092 noExec = TRUE;
2093 }
2094
2095 /*
2096 * If we're not supposed to execute a shell, don't.
2097 */
2098 if (noExec) {
2099 /*
2100 * Unlink and close the command file if we opened one
2101 */
2102 if (job->cmdFILE != stdout) {
2103 if (job->cmdFILE != NULL) {
2104 (void) fclose(job->cmdFILE);
2105 job->cmdFILE = NULL;
2106 }
2107 } else {
2108 (void) fflush(stdout);
2109 }
2110
2111 /*
2112 * We only want to work our way up the graph if we aren't here because
2113 * the commands for the job were no good.
2114 */
2115 if (cmdsOK) {
2116 if (aborting == 0) {
2117 if (job->tailCmds != NILLNODE) {
2118 Lst_ForEachFrom(job->node->commands, job->tailCmds,
2119 JobSaveCommand,
2120 (ClientData)job->node);
2121 }
2122 if (!(job->flags & JOB_SPECIAL))
2123 Job_TokenReturn();
2124 job->node->made = MADE;
2125 Make_Update(job->node);
2126 }
2127 free((Address)job);
2128 return(JOB_FINISHED);
2129 } else {
2130 free((Address)job);
2131 return(JOB_ERROR);
2132 }
2133 } else {
2134 (void) fflush(job->cmdFILE);
2135 }
2136
2137 /*
2138 * Set up the control arguments to the shell. This is based on the flags
2139 * set earlier for this job.
2140 */
2141 JobMakeArgv(job, argv);
2142
2143 /*
2144 * If we're using pipes to catch output, create the pipe by which we'll
2145 * get the shell's output. If we're using files, print out that we're
2146 * starting a job and then set up its temporary-file name.
2147 */
2148 if (!compatMake || (job->flags & JOB_FIRST)) {
2149 if (usePipes) {
2150 int fd[2];
2151 if (pipe(fd) == -1)
2152 Punt("Cannot create pipe: %s", strerror(errno));
2153 job->inPipe = fd[0];
2154 job->outPipe = fd[1];
2155 (void) fcntl(job->inPipe, F_SETFD, 1);
2156 (void) fcntl(job->outPipe, F_SETFD, 1);
2157 } else {
2158 (void) fprintf(stdout, "Remaking `%s'\n", gn->name);
2159 (void) fflush(stdout);
2160 (void) strcpy(job->outFile, TMPPAT);
2161 job->outFd = mkstemp(job->outFile);
2162 (void) fcntl(job->outFd, F_SETFD, 1);
2163 }
2164 }
2165
2166 #ifdef REMOTE
2167 if (!(gn->type & OP_NOEXPORT) && !(runLocalFirst && nLocal < maxLocal)) {
2168 #ifdef RMT_NO_EXEC
2169 local = !Rmt_Export(shellPath, argv, job);
2170 #else
2171 local = !Rmt_Begin(shellPath, argv, job->node);
2172 #endif /* RMT_NO_EXEC */
2173 if (!local) {
2174 job->flags |= JOB_REMOTE;
2175 }
2176 } else
2177 #endif
2178 local = TRUE;
2179
2180 if (local && (((nLocal >= maxLocal) &&
2181 !(job->flags & JOB_SPECIAL) &&
2182 #ifdef REMOTE
2183 (!(gn->type & OP_NOEXPORT) || (maxLocal != 0))
2184 #else
2185 (maxLocal != 0)
2186 #endif
2187 )))
2188 {
2189 /*
2190 * The job can only be run locally, but we've hit the limit of
2191 * local concurrency, so put the job on hold until some other job
2192 * finishes. Note that the special jobs (.BEGIN, .INTERRUPT and .END)
2193 * may be run locally even when the local limit has been reached
2194 * (e.g. when maxLocal == 0), though they will be exported if at
2195 * all possible. In addition, any target marked with .NOEXPORT will
2196 * be run locally if maxLocal is 0.
2197 */
2198 job->flags |= JOB_RESTART;
2199 (void) Lst_AtEnd(stoppedJobs, (ClientData)job);
2200 } else {
2201 JobExec(job, argv);
2202 }
2203 return(JOB_RUNNING);
2204 }
2205
2206 static char *
2207 JobOutput(Job *job, char *cp, char *endp, int msg)
2208 {
2209 char *ecp;
2210
2211 if (commandShell->noPrint) {
2212 ecp = Str_FindSubstring(cp, commandShell->noPrint);
2213 while (ecp != NULL) {
2214 if (cp != ecp) {
2215 *ecp = '\0';
2216 if (msg && job->node != lastNode) {
2217 MESSAGE(stdout, job->node);
2218 lastNode = job->node;
2219 }
2220 /*
2221 * The only way there wouldn't be a newline after
2222 * this line is if it were the last in the buffer.
2223 * however, since the non-printable comes after it,
2224 * there must be a newline, so we don't print one.
2225 */
2226 (void) fprintf(stdout, "%s", cp);
2227 (void) fflush(stdout);
2228 }
2229 cp = ecp + commandShell->noPLen;
2230 if (cp != endp) {
2231 /*
2232 * Still more to print, look again after skipping
2233 * the whitespace following the non-printable
2234 * command....
2235 */
2236 cp++;
2237 while (*cp == ' ' || *cp == '\t' || *cp == '\n') {
2238 cp++;
2239 }
2240 ecp = Str_FindSubstring(cp, commandShell->noPrint);
2241 } else {
2242 return cp;
2243 }
2244 }
2245 }
2246 return cp;
2247 }
2248
2249 /*-
2250 *-----------------------------------------------------------------------
2251 * JobDoOutput --
2252 * This function is called at different times depending on
2253 * whether the user has specified that output is to be collected
2254 * via pipes or temporary files. In the former case, we are called
2255 * whenever there is something to read on the pipe. We collect more
2256 * output from the given job and store it in the job's outBuf. If
2257 * this makes up a line, we print it tagged by the job's identifier,
2258 * as necessary.
2259 * If output has been collected in a temporary file, we open the
2260 * file and read it line by line, transfering it to our own
2261 * output channel until the file is empty. At which point we
2262 * remove the temporary file.
2263 * In both cases, however, we keep our figurative eye out for the
2264 * 'noPrint' line for the shell from which the output came. If
2265 * we recognize a line, we don't print it. If the command is not
2266 * alone on the line (the character after it is not \0 or \n), we
2267 * do print whatever follows it.
2268 *
2269 * Input:
2270 * job the job whose output needs printing
2271 * finish TRUE if this is the last time we'll be called
2272 * for this job
2273 *
2274 * Results:
2275 * None
2276 *
2277 * Side Effects:
2278 * curPos may be shifted as may the contents of outBuf.
2279 *-----------------------------------------------------------------------
2280 */
2281 STATIC void
2282 JobDoOutput(Job *job, Boolean finish)
2283 {
2284 Boolean gotNL = FALSE; /* true if got a newline */
2285 Boolean fbuf; /* true if our buffer filled up */
2286 int nr; /* number of bytes read */
2287 int i; /* auxiliary index into outBuf */
2288 int max; /* limit for i (end of current data) */
2289 int nRead; /* (Temporary) number of bytes read */
2290
2291 FILE *oFILE; /* Stream pointer to shell's output file */
2292 char inLine[132];
2293
2294
2295 if (usePipes) {
2296 /*
2297 * Read as many bytes as will fit in the buffer.
2298 */
2299 end_loop:
2300 gotNL = FALSE;
2301 fbuf = FALSE;
2302
2303 nRead = read(job->inPipe, &job->outBuf[job->curPos],
2304 JOB_BUFSIZE - job->curPos);
2305 if (nRead < 0) {
2306 if (DEBUG(JOB)) {
2307 perror("JobDoOutput(piperead)");
2308 }
2309 nr = 0;
2310 } else {
2311 nr = nRead;
2312 }
2313
2314 /*
2315 * If we hit the end-of-file (the job is dead), we must flush its
2316 * remaining output, so pretend we read a newline if there's any
2317 * output remaining in the buffer.
2318 * Also clear the 'finish' flag so we stop looping.
2319 */
2320 if ((nr == 0) && (job->curPos != 0)) {
2321 job->outBuf[job->curPos] = '\n';
2322 nr = 1;
2323 finish = FALSE;
2324 } else if (nr == 0) {
2325 finish = FALSE;
2326 }
2327
2328 /*
2329 * Look for the last newline in the bytes we just got. If there is
2330 * one, break out of the loop with 'i' as its index and gotNL set
2331 * TRUE.
2332 */
2333 max = job->curPos + nr;
2334 for (i = job->curPos + nr - 1; i >= job->curPos; i--) {
2335 if (job->outBuf[i] == '\n') {
2336 gotNL = TRUE;
2337 break;
2338 } else if (job->outBuf[i] == '\0') {
2339 /*
2340 * Why?
2341 */
2342 job->outBuf[i] = ' ';
2343 }
2344 }
2345
2346 if (!gotNL) {
2347 job->curPos += nr;
2348 if (job->curPos == JOB_BUFSIZE) {
2349 /*
2350 * If we've run out of buffer space, we have no choice
2351 * but to print the stuff. sigh.
2352 */
2353 fbuf = TRUE;
2354 i = job->curPos;
2355 }
2356 }
2357 if (gotNL || fbuf) {
2358 /*
2359 * Need to send the output to the screen. Null terminate it
2360 * first, overwriting the newline character if there was one.
2361 * So long as the line isn't one we should filter (according
2362 * to the shell description), we print the line, preceded
2363 * by a target banner if this target isn't the same as the
2364 * one for which we last printed something.
2365 * The rest of the data in the buffer are then shifted down
2366 * to the start of the buffer and curPos is set accordingly.
2367 */
2368 job->outBuf[i] = '\0';
2369 if (i >= job->curPos) {
2370 char *cp;
2371
2372 cp = JobOutput(job, job->outBuf, &job->outBuf[i], FALSE);
2373
2374 /*
2375 * There's still more in that thar buffer. This time, though,
2376 * we know there's no newline at the end, so we add one of
2377 * our own free will.
2378 */
2379 if (*cp != '\0') {
2380 if (job->node != lastNode) {
2381 MESSAGE(stdout, job->node);
2382 lastNode = job->node;
2383 }
2384 (void) fprintf(stdout, "%s%s", cp, gotNL ? "\n" : "");
2385 (void) fflush(stdout);
2386 }
2387 }
2388 if (i < max - 1) {
2389 /* shift the remaining characters down */
2390 (void) memcpy(job->outBuf, &job->outBuf[i + 1], max - (i + 1));
2391 job->curPos = max - (i + 1);
2392
2393 } else {
2394 /*
2395 * We have written everything out, so we just start over
2396 * from the start of the buffer. No copying. No nothing.
2397 */
2398 job->curPos = 0;
2399 }
2400 }
2401 if (finish) {
2402 /*
2403 * If the finish flag is true, we must loop until we hit
2404 * end-of-file on the pipe. This is guaranteed to happen
2405 * eventually since the other end of the pipe is now closed
2406 * (we closed it explicitly and the child has exited). When
2407 * we do get an EOF, finish will be set FALSE and we'll fall
2408 * through and out.
2409 */
2410 goto end_loop;
2411 }
2412 } else {
2413 /*
2414 * We've been called to retrieve the output of the job from the
2415 * temporary file where it's been squirreled away. This consists of
2416 * opening the file, reading the output line by line, being sure not
2417 * to print the noPrint line for the shell we used, then close and
2418 * remove the temporary file. Very simple.
2419 *
2420 * Change to read in blocks and do FindSubString type things as for
2421 * pipes? That would allow for "@echo -n..."
2422 */
2423 oFILE = fopen(job->outFile, "r");
2424 if (oFILE != NULL) {
2425 (void) fprintf(stdout, "Results of making %s:\n", job->node->name);
2426 (void) fflush(stdout);
2427 while (fgets(inLine, sizeof(inLine), oFILE) != NULL) {
2428 char *cp, *endp, *oendp;
2429
2430 cp = inLine;
2431 oendp = endp = inLine + strlen(inLine);
2432 if (endp[-1] == '\n') {
2433 *--endp = '\0';
2434 }
2435 cp = JobOutput(job, inLine, endp, FALSE);
2436
2437 /*
2438 * There's still more in that thar buffer. This time, though,
2439 * we know there's no newline at the end, so we add one of
2440 * our own free will.
2441 */
2442 (void) fprintf(stdout, "%s", cp);
2443 (void) fflush(stdout);
2444 if (endp != oendp) {
2445 (void) fprintf(stdout, "\n");
2446 (void) fflush(stdout);
2447 }
2448 }
2449 (void) fclose(oFILE);
2450 (void) eunlink(job->outFile);
2451 } else {
2452 Punt("Cannot open `%s'", job->outFile);
2453 }
2454 }
2455 }
2456
2457 /*-
2458 *-----------------------------------------------------------------------
2459 * Job_CatchChildren --
2460 * Handle the exit of a child. Called from Make_Make.
2461 *
2462 * Input:
2463 * block TRUE if should block on the wait
2464 *
2465 * Results:
2466 * none.
2467 *
2468 * Side Effects:
2469 * The job descriptor is removed from the list of children.
2470 *
2471 * Notes:
2472 * We do waits, blocking or not, according to the wisdom of our
2473 * caller, until there are no more children to report. For each
2474 * job, call JobFinish to finish things off. This will take care of
2475 * putting jobs on the stoppedJobs queue.
2476 *
2477 *-----------------------------------------------------------------------
2478 */
2479 void
2480 Job_CatchChildren(Boolean block)
2481 {
2482 int pid; /* pid of dead child */
2483 Job *job; /* job descriptor for dead child */
2484 LstNode jnode; /* list element for finding job */
2485 int status; /* Exit/termination status */
2486
2487 /*
2488 * Don't even bother if we know there's no one around.
2489 */
2490 if (nLocal == 0) {
2491 return;
2492 }
2493
2494 while ((pid = waitpid((pid_t) -1, &status,
2495 (block?0:WNOHANG)|WUNTRACED)) > 0)
2496 {
2497 if (DEBUG(JOB)) {
2498 (void) fprintf(stdout, "Process %d exited or stopped %x.\n", pid,
2499 status);
2500 (void) fflush(stdout);
2501 }
2502
2503 jnode = Lst_Find(jobs, (ClientData)&pid, JobCmpPid);
2504 if (jnode == NILLNODE) {
2505 if (WIFSTOPPED(status) && (WSTOPSIG(status) == SIGCONT)) {
2506 jnode = Lst_Find(stoppedJobs, (ClientData) &pid, JobCmpPid);
2507 if (jnode == NILLNODE) {
2508 Error("Resumed child (%d) not in table", pid);
2509 continue;
2510 }
2511 job = (Job *)Lst_Datum(jnode);
2512 (void) Lst_Remove(stoppedJobs, jnode);
2513 } else {
2514 Error("Child (%d) not in table?", pid);
2515 continue;
2516 }
2517 } else {
2518 job = (Job *) Lst_Datum(jnode);
2519 (void) Lst_Remove(jobs, jnode);
2520 nJobs -= 1;
2521 #ifdef REMOTE
2522 if (!(job->flags & JOB_REMOTE)) {
2523 if (DEBUG(JOB)) {
2524 (void) fprintf(stdout,
2525 "Job queue has one fewer local process.\n");
2526 (void) fflush(stdout);
2527 }
2528 nLocal -= 1;
2529 }
2530 #else
2531 nLocal -= 1;
2532 #endif
2533 }
2534
2535 JobFinish(job, &status);
2536 }
2537 }
2538
2539 /*-
2540 *-----------------------------------------------------------------------
2541 * Job_CatchOutput --
2542 * Catch the output from our children, if we're using
2543 * pipes do so. Otherwise just block time until we get a
2544 * signal (most likely a SIGCHLD) since there's no point in
2545 * just spinning when there's nothing to do and the reaping
2546 * of a child can wait for a while.
2547 *
2548 * Results:
2549 * None
2550 *
2551 * Side Effects:
2552 * Output is read from pipes if we're piping.
2553 * -----------------------------------------------------------------------
2554 */
2555 void
2556 Job_CatchOutput(void)
2557 {
2558 int nready;
2559 LstNode ln;
2560 Job *job;
2561 #ifdef RMT_WILL_WATCH
2562 int pnJobs; /* Previous nJobs */
2563 #endif
2564
2565 (void) fflush(stdout);
2566 Job_TokenFlush();
2567 #ifdef RMT_WILL_WATCH
2568 pnJobs = nJobs;
2569
2570 /*
2571 * It is possible for us to be called with nJobs equal to 0. This happens
2572 * if all the jobs finish and a job that is stopped cannot be run
2573 * locally (eg if maxLocal is 0) and cannot be exported. The job will
2574 * be placed back on the stoppedJobs queue, Job_Empty() will return false,
2575 * Make_Run will call us again when there's nothing for which to wait.
2576 * nJobs never changes, so we loop forever. Hence the check. It could
2577 * be argued that we should sleep for a bit so as not to swamp the
2578 * exportation system with requests. Perhaps we should.
2579 *
2580 * NOTE: IT IS THE RESPONSIBILITY OF Rmt_Wait TO CALL Job_CatchChildren
2581 * IN A TIMELY FASHION TO CATCH ANY LOCALLY RUNNING JOBS THAT EXIT.
2582 * It may use the variable nLocal to determine if it needs to call
2583 * Job_CatchChildren(if nLocal is 0, there's nothing for which to
2584 * wait...)
2585 */
2586 while (nJobs != 0 && pnJobs == nJobs) {
2587 Rmt_Wait();
2588 }
2589 #else
2590 if (usePipes) {
2591 if ((nready = poll((wantToken ? fds : (fds + 1)),
2592 (wantToken ? nfds : (nfds - 1)), POLL_MSEC)) <= 0) {
2593 return;
2594 } else {
2595 sigset_t mask;
2596 JobSigLock(&mask);
2597 if (Lst_Open(jobs) == FAILURE) {
2598 Punt("Cannot open job table");
2599 }
2600
2601 if (readyfd(&childExitJob)) {
2602 char token;
2603 (void) read(childExitJob.inPipe, &token, 1);
2604 nready -= 1;
2605 }
2606
2607 while (nready && (ln = Lst_Next(jobs)) != NILLNODE) {
2608 job = (Job *) Lst_Datum(ln);
2609 if (readyfd(job)) {
2610 JobDoOutput(job, FALSE);
2611 nready -= 1;
2612 }
2613 }
2614 Lst_Close(jobs);
2615 JobSigUnlock(&mask);
2616 }
2617 }
2618 #endif /* RMT_WILL_WATCH */
2619 }
2620
2621 /*-
2622 *-----------------------------------------------------------------------
2623 * Job_Make --
2624 * Start the creation of a target. Basically a front-end for
2625 * JobStart used by the Make module.
2626 *
2627 * Results:
2628 * None.
2629 *
2630 * Side Effects:
2631 * Another job is started.
2632 *
2633 *-----------------------------------------------------------------------
2634 */
2635 void
2636 Job_Make(GNode *gn)
2637 {
2638 (void) JobStart(gn, 0, NULL);
2639 }
2640
2641 void
2642 Shell_Init()
2643 {
2644 if (shellPath == NULL) {
2645 /*
2646 * The user didn't specify a shell to use, so we are using the
2647 * default one... Both the absolute path and the last component
2648 * must be set. The last component is taken from the 'name' field
2649 * of the default shell description pointed-to by commandShell.
2650 * All default shells are located in _PATH_DEFSHELLDIR.
2651 */
2652 shellName = commandShell->name;
2653 shellPath = str_concat(_PATH_DEFSHELLDIR, shellName, STR_ADDSLASH);
2654 }
2655 if (commandShell->exit == NULL) {
2656 commandShell->exit = "";
2657 }
2658 if (commandShell->echo == NULL) {
2659 commandShell->echo = "";
2660 }
2661 }
2662
2663 /*-
2664 *-----------------------------------------------------------------------
2665 * Job_Init --
2666 * Initialize the process module
2667 *
2668 * Input:
2669 * maxproc the greatest number of jobs which may be running
2670 * at one time
2671 * maxlocal the greatest number of jobs which may be running
2672 * at once
2673 *
2674 * Results:
2675 * none
2676 *
2677 * Side Effects:
2678 * lists and counters are initialized
2679 *-----------------------------------------------------------------------
2680 */
2681 void
2682 Job_Init(int maxproc, int maxlocal)
2683 {
2684 GNode *begin; /* node for commands to do at the very start */
2685
2686 jobs = Lst_Init(FALSE);
2687 stoppedJobs = Lst_Init(FALSE);
2688 maxJobs = maxproc;
2689 maxLocal = maxlocal;
2690 nJobs = 0;
2691 nLocal = 0;
2692 wantToken = FALSE;
2693
2694 aborting = 0;
2695 errors = 0;
2696
2697 lastNode = NILGNODE;
2698
2699 if (maxJobs == 1
2700 #ifdef REMOTE
2701 || noMessages
2702 #endif
2703 ) {
2704 /*
2705 * If only one job can run at a time, there's no need for a banner,
2706 * is there?
2707 */
2708 targFmt = "";
2709 } else {
2710 targFmt = TARG_FMT;
2711 }
2712
2713 Shell_Init();
2714
2715 if (pipe(exit_pipe) < 0)
2716 Fatal("error in pipe: %s", strerror(errno));
2717 fcntl(exit_pipe[0], F_SETFD, 1);
2718 fcntl(exit_pipe[1], F_SETFD, 1);
2719
2720 childExitJob.inPipe = exit_pipe[0];
2721
2722 sigemptyset(&caught_signals);
2723 /*
2724 * Install a SIGCHLD handler.
2725 */
2726 (void)signal(SIGCHLD, JobChildSig);
2727 sigaddset(&caught_signals, SIGCHLD);
2728
2729 #define ADDSIG(s,h) \
2730 if (signal(s, SIG_IGN) != SIG_IGN) { \
2731 sigaddset(&caught_signals, s); \
2732 (void) signal(s, h); \
2733 }
2734
2735 /*
2736 * Catch the four signals that POSIX specifies if they aren't ignored.
2737 * JobPassSig will take care of calling JobInterrupt if appropriate.
2738 */
2739 ADDSIG(SIGINT, JobPassSig)
2740 ADDSIG(SIGHUP, JobPassSig)
2741 ADDSIG(SIGTERM, JobPassSig)
2742 ADDSIG(SIGQUIT, JobPassSig)
2743
2744 /*
2745 * There are additional signals that need to be caught and passed if
2746 * either the export system wants to be told directly of signals or if
2747 * we're giving each job its own process group (since then it won't get
2748 * signals from the terminal driver as we own the terminal)
2749 */
2750 #if defined(RMT_WANTS_SIGNALS) || defined(USE_PGRP)
2751 ADDSIG(SIGTSTP, JobPassSig)
2752 ADDSIG(SIGTTOU, JobPassSig)
2753 ADDSIG(SIGTTIN, JobPassSig)
2754 ADDSIG(SIGWINCH, JobPassSig)
2755 ADDSIG(SIGCONT, JobContinueSig)
2756 #endif
2757 #undef ADDSIG
2758
2759 begin = Targ_FindNode(".BEGIN", TARG_NOCREATE);
2760
2761 if (begin != NILGNODE) {
2762 JobStart(begin, JOB_SPECIAL, (Job *)0);
2763 while (nJobs) {
2764 Job_CatchOutput();
2765 #ifndef RMT_WILL_WATCH
2766 Job_CatchChildren(!usePipes);
2767 #endif /* RMT_WILL_WATCH */
2768 }
2769 }
2770 postCommands = Targ_FindNode(".END", TARG_CREATE);
2771 }
2772
2773 static void JobSigReset(void)
2774 {
2775 #define DELSIG(s) \
2776 if (sigismember(&caught_signals, s)) { \
2777 (void) signal(SIGINT, SIG_DFL); \
2778 }
2779
2780 DELSIG(SIGINT)
2781 DELSIG(SIGHUP)
2782 DELSIG(SIGQUIT)
2783 DELSIG(SIGTERM)
2784 #if defined(RMT_WANTS_SIGNALS) || defined(USE_PGRP)
2785 DELSIG(SIGTSTP)
2786 DELSIG(SIGTTOU)
2787 DELSIG(SIGTTIN)
2788 DELSIG(SIGWINCH)
2789 DELSIG(SIGCONT)
2790 #endif
2791 #undef DELSIG
2792 (void)signal(SIGCHLD, SIG_DFL);
2793 }
2794
2795 /*-
2796 *-----------------------------------------------------------------------
2797 * Job_Empty --
2798 * See if the job table is empty. Because the local concurrency may
2799 * be set to 0, it is possible for the job table to become empty,
2800 * while the list of stoppedJobs remains non-empty. In such a case,
2801 * we want to restart as many jobs as we can.
2802 *
2803 * Results:
2804 * TRUE if it is. FALSE if it ain't.
2805 *
2806 * Side Effects:
2807 * None.
2808 *
2809 * -----------------------------------------------------------------------
2810 */
2811 Boolean
2812 Job_Empty(void)
2813 {
2814 if (nJobs == 0) {
2815 if (!Lst_IsEmpty(stoppedJobs) && !aborting) {
2816 /*
2817 * The job table is obviously not full if it has no jobs in
2818 * it...Try and restart the stopped jobs.
2819 */
2820 JobRestartJobs();
2821 return(FALSE);
2822 } else {
2823 return(TRUE);
2824 }
2825 } else {
2826 return(FALSE);
2827 }
2828 }
2829
2830 /*-
2831 *-----------------------------------------------------------------------
2832 * JobMatchShell --
2833 * Find a shell in 'shells' given its name.
2834 *
2835 * Results:
2836 * A pointer to the Shell structure.
2837 *
2838 * Side Effects:
2839 * None.
2840 *
2841 *-----------------------------------------------------------------------
2842 */
2843 static Shell *
2844 JobMatchShell(const char *name)
2845 {
2846 Shell *sh;
2847
2848 for (sh = shells; sh->name != NULL; sh++) {
2849 if (strcmp(name, sh->name) == 0)
2850 return (sh);
2851 }
2852 return (NULL);
2853 }
2854
2855 /*-
2856 *-----------------------------------------------------------------------
2857 * Job_ParseShell --
2858 * Parse a shell specification and set up commandShell, shellPath
2859 * and shellName appropriately.
2860 *
2861 * Input:
2862 * line The shell spec
2863 *
2864 * Results:
2865 * FAILURE if the specification was incorrect.
2866 *
2867 * Side Effects:
2868 * commandShell points to a Shell structure (either predefined or
2869 * created from the shell spec), shellPath is the full path of the
2870 * shell described by commandShell, while shellName is just the
2871 * final component of shellPath.
2872 *
2873 * Notes:
2874 * A shell specification consists of a .SHELL target, with dependency
2875 * operator, followed by a series of blank-separated words. Double
2876 * quotes can be used to use blanks in words. A backslash escapes
2877 * anything (most notably a double-quote and a space) and
2878 * provides the functionality it does in C. Each word consists of
2879 * keyword and value separated by an equal sign. There should be no
2880 * unnecessary spaces in the word. The keywords are as follows:
2881 * name Name of shell.
2882 * path Location of shell.
2883 * quiet Command to turn off echoing.
2884 * echo Command to turn echoing on
2885 * filter Result of turning off echoing that shouldn't be
2886 * printed.
2887 * echoFlag Flag to turn echoing on at the start
2888 * errFlag Flag to turn error checking on at the start
2889 * hasErrCtl True if shell has error checking control
2890 * check Command to turn on error checking if hasErrCtl
2891 * is TRUE or template of command to echo a command
2892 * for which error checking is off if hasErrCtl is
2893 * FALSE.
2894 * ignore Command to turn off error checking if hasErrCtl
2895 * is TRUE or template of command to execute a
2896 * command so as to ignore any errors it returns if
2897 * hasErrCtl is FALSE.
2898 *
2899 *-----------------------------------------------------------------------
2900 */
2901 ReturnStatus
2902 Job_ParseShell(char *line)
2903 {
2904 char **words;
2905 char **argv;
2906 int argc;
2907 char *path;
2908 Shell newShell;
2909 Boolean fullSpec = FALSE;
2910 Shell *sh;
2911
2912 while (isspace((unsigned char)*line)) {
2913 line++;
2914 }
2915
2916 if (shellArgv)
2917 free(UNCONST(shellArgv));
2918
2919 memset((Address)&newShell, 0, sizeof(newShell));
2920
2921 /*
2922 * Parse the specification by keyword
2923 */
2924 words = brk_string(line, &argc, TRUE, &path);
2925 shellArgv = path;
2926
2927 for (path = NULL, argv = words; argc != 0; argc--, argv++) {
2928 if (strncmp(*argv, "path=", 5) == 0) {
2929 path = &argv[0][5];
2930 } else if (strncmp(*argv, "name=", 5) == 0) {
2931 newShell.name = &argv[0][5];
2932 } else {
2933 if (strncmp(*argv, "quiet=", 6) == 0) {
2934 newShell.echoOff = &argv[0][6];
2935 } else if (strncmp(*argv, "echo=", 5) == 0) {
2936 newShell.echoOn = &argv[0][5];
2937 } else if (strncmp(*argv, "filter=", 7) == 0) {
2938 newShell.noPrint = &argv[0][7];
2939 newShell.noPLen = strlen(newShell.noPrint);
2940 } else if (strncmp(*argv, "echoFlag=", 9) == 0) {
2941 newShell.echo = &argv[0][9];
2942 } else if (strncmp(*argv, "errFlag=", 8) == 0) {
2943 newShell.exit = &argv[0][8];
2944 } else if (strncmp(*argv, "hasErrCtl=", 10) == 0) {
2945 char c = argv[0][10];
2946 newShell.hasErrCtl = !((c != 'Y') && (c != 'y') &&
2947 (c != 'T') && (c != 't'));
2948 } else if (strncmp(*argv, "check=", 6) == 0) {
2949 newShell.errCheck = &argv[0][6];
2950 } else if (strncmp(*argv, "ignore=", 7) == 0) {
2951 newShell.ignErr = &argv[0][7];
2952 } else if (strncmp(*argv, "errout=", 7) == 0) {
2953 newShell.errOut = &argv[0][7];
2954 } else if (strncmp(*argv, "comment=", 8) == 0) {
2955 newShell.commentChar = argv[0][8];
2956 } else {
2957 Parse_Error(PARSE_FATAL, "Unknown keyword \"%s\"",
2958 *argv);
2959 free(words);
2960 return(FAILURE);
2961 }
2962 fullSpec = TRUE;
2963 }
2964 }
2965
2966 if (path == NULL) {
2967 /*
2968 * If no path was given, the user wants one of the pre-defined shells,
2969 * yes? So we find the one s/he wants with the help of JobMatchShell
2970 * and set things up the right way. shellPath will be set up by
2971 * Job_Init.
2972 */
2973 if (newShell.name == NULL) {
2974 Parse_Error(PARSE_FATAL, "Neither path nor name specified");
2975 free(words);
2976 return(FAILURE);
2977 } else {
2978 if ((sh = JobMatchShell(newShell.name)) == NULL) {
2979 Parse_Error(PARSE_WARNING, "%s: No matching shell",
2980 newShell.name);
2981 free(words);
2982 return(FAILURE);
2983 }
2984 commandShell = sh;
2985 shellName = newShell.name;
2986 }
2987 } else {
2988 /*
2989 * The user provided a path. If s/he gave nothing else (fullSpec is
2990 * FALSE), try and find a matching shell in the ones we know of.
2991 * Else we just take the specification at its word and copy it
2992 * to a new location. In either case, we need to record the
2993 * path the user gave for the shell.
2994 */
2995 shellPath = path;
2996 path = strrchr(path, '/');
2997 if (path == NULL) {
2998 path = UNCONST(shellPath);
2999 } else {
3000 path += 1;
3001 }
3002 if (newShell.name != NULL) {
3003 shellName = newShell.name;
3004 } else {
3005 shellName = path;
3006 }
3007 if (!fullSpec) {
3008 if ((sh = JobMatchShell(shellName)) == NULL) {
3009 Parse_Error(PARSE_WARNING, "%s: No matching shell",
3010 shellName);
3011 free(words);
3012 return(FAILURE);
3013 }
3014 commandShell = sh;
3015 } else {
3016 commandShell = emalloc(sizeof(Shell));
3017 *commandShell = newShell;
3018 }
3019 }
3020
3021 if (commandShell->echoOn && commandShell->echoOff) {
3022 commandShell->hasEchoCtl = TRUE;
3023 }
3024
3025 if (!commandShell->hasErrCtl) {
3026 if (commandShell->errCheck == NULL) {
3027 commandShell->errCheck = "";
3028 }
3029 if (commandShell->ignErr == NULL) {
3030 commandShell->ignErr = "%s\n";
3031 }
3032 }
3033
3034 /*
3035 * Do not free up the words themselves, since they might be in use by the
3036 * shell specification.
3037 */
3038 free(words);
3039 return SUCCESS;
3040 }
3041
3042 /*-
3043 *-----------------------------------------------------------------------
3044 * JobInterrupt --
3045 * Handle the receipt of an interrupt.
3046 *
3047 * Input:
3048 * runINTERRUPT Non-zero if commands for the .INTERRUPT target
3049 * should be executed
3050 * signo signal received
3051 *
3052 * Results:
3053 * None
3054 *
3055 * Side Effects:
3056 * All children are killed. Another job will be started if the
3057 * .INTERRUPT target was given.
3058 *-----------------------------------------------------------------------
3059 */
3060 static void
3061 JobInterrupt(int runINTERRUPT, int signo)
3062 {
3063 LstNode ln; /* element in job table */
3064 Job *job; /* job descriptor in that element */
3065 GNode *interrupt; /* the node describing the .INTERRUPT target */
3066 sigset_t mask;
3067
3068 aborting = ABORT_INTERRUPT;
3069
3070 JobSigLock(&mask);
3071
3072 (void) Lst_Open(jobs);
3073 while ((ln = Lst_Next(jobs)) != NILLNODE) {
3074 GNode *gn;
3075
3076 job = (Job *) Lst_Datum(ln);
3077 gn = job->node;
3078
3079 if ((gn->type & (OP_JOIN|OP_PHONY)) == 0 && !Targ_Precious(gn)) {
3080 char *file = (gn->path == NULL ? gn->name : gn->path);
3081 if (!noExecute && eunlink(file) != -1) {
3082 Error("*** %s removed", file);
3083 }
3084 }
3085 #ifdef RMT_WANTS_SIGNALS
3086 if (job->flags & JOB_REMOTE) {
3087 /*
3088 * If job is remote, let the Rmt module do the killing.
3089 */
3090 if (!Rmt_Signal(job, signo)) {
3091 /*
3092 * If couldn't kill the thing, finish it out now with an
3093 * error code, since no exit report will come in likely.
3094 */
3095 int status;
3096
3097 status.w_status = 0;
3098 status.w_retcode = 1;
3099 JobFinish(job, &status);
3100 }
3101 } else if (job->pid) {
3102 KILL(job->pid, signo);
3103 }
3104 #else
3105 if (job->pid) {
3106 if (DEBUG(JOB)) {
3107 (void) fprintf(stdout,
3108 "JobInterrupt passing signal %d to child %d.\n",
3109 signo, job->pid);
3110 (void) fflush(stdout);
3111 }
3112 KILL(job->pid, signo);
3113 }
3114 #endif /* RMT_WANTS_SIGNALS */
3115 }
3116 Lst_Close(jobs);
3117
3118 #ifdef REMOTE
3119 (void)Lst_Open(stoppedJobs);
3120 while ((ln = Lst_Next(stoppedJobs)) != NILLNODE) {
3121 GNode *gn;
3122
3123 job = (Job *) Lst_Datum(ln);
3124 gn = job->node;
3125
3126 if (job->flags & JOB_RESTART) {
3127 if (DEBUG(JOB)) {
3128 (void) fprintf(stdout, "%s%s",
3129 "JobInterrupt skipping job on stopped queue",
3130 "-- it was waiting to be restarted.\n");
3131 (void) fflush(stdout);
3132 }
3133 continue;
3134 }
3135 if ((gn->type & (OP_JOIN|OP_PHONY)) == 0 && !Targ_Precious(gn)) {
3136 char *file = (gn->path == NULL ? gn->name : gn->path);
3137 if (eunlink(file) == 0) {
3138 Error("*** %s removed", file);
3139 }
3140 }
3141 /*
3142 * Resume the thing so it will take the signal.
3143 */
3144 if (DEBUG(JOB)) {
3145 (void) fprintf(stdout,
3146 "JobInterrupt passing CONT to stopped child %d.\n",
3147 job->pid);
3148 (void) fflush(stdout);
3149 }
3150 KILL(job->pid, SIGCONT);
3151 #ifdef RMT_WANTS_SIGNALS
3152 if (job->flags & JOB_REMOTE) {
3153 /*
3154 * If job is remote, let the Rmt module do the killing.
3155 */
3156 if (!Rmt_Signal(job, SIGINT)) {
3157 /*
3158 * If couldn't kill the thing, finish it out now with an
3159 * error code, since no exit report will come in likely.
3160 */
3161 int status;
3162 status.w_status = 0;
3163 status.w_retcode = 1;
3164 JobFinish(job, &status);
3165 }
3166 } else if (job->pid) {
3167 if (DEBUG(JOB)) {
3168 (void) fprintf(stdout,
3169 "JobInterrupt passing interrupt to stopped child %d.\n",
3170 job->pid);
3171 (void) fflush(stdout);
3172 }
3173 KILL(job->pid, SIGINT);
3174 }
3175 #endif /* RMT_WANTS_SIGNALS */
3176 }
3177 Lst_Close(stoppedJobs);
3178 #endif /* REMOTE */
3179
3180 JobSigUnlock(&mask);
3181
3182 if (runINTERRUPT && !touchFlag) {
3183 interrupt = Targ_FindNode(".INTERRUPT", TARG_NOCREATE);
3184 if (interrupt != NILGNODE) {
3185 ignoreErrors = FALSE;
3186
3187 JobStart(interrupt, JOB_IGNDOTS, (Job *)0);
3188 while (nJobs) {
3189 Job_CatchOutput();
3190 #ifndef RMT_WILL_WATCH
3191 Job_CatchChildren(!usePipes);
3192 #endif /* RMT_WILL_WATCH */
3193 }
3194 }
3195 }
3196 Trace_Log(MAKEINTR, 0);
3197 exit(signo);
3198 }
3199
3200 /*
3201 *-----------------------------------------------------------------------
3202 * Job_Finish --
3203 * Do final processing such as the running of the commands
3204 * attached to the .END target.
3205 *
3206 * Results:
3207 * Number of errors reported.
3208 *
3209 * Side Effects:
3210 * None.
3211 *-----------------------------------------------------------------------
3212 */
3213 int
3214 Job_Finish(void)
3215 {
3216 if (postCommands != NILGNODE && !Lst_IsEmpty(postCommands->commands)) {
3217 if (errors) {
3218 Error("Errors reported so .END ignored");
3219 } else {
3220 JobStart(postCommands, JOB_SPECIAL | JOB_IGNDOTS, NULL);
3221
3222 while (nJobs) {
3223 Job_CatchOutput();
3224 #ifndef RMT_WILL_WATCH
3225 Job_CatchChildren(!usePipes);
3226 #endif /* RMT_WILL_WATCH */
3227 }
3228 }
3229 }
3230 Job_TokenFlush();
3231 return(errors);
3232 }
3233
3234 /*-
3235 *-----------------------------------------------------------------------
3236 * Job_End --
3237 * Cleanup any memory used by the jobs module
3238 *
3239 * Results:
3240 * None.
3241 *
3242 * Side Effects:
3243 * Memory is freed
3244 *-----------------------------------------------------------------------
3245 */
3246 void
3247 Job_End(void)
3248 {
3249 #ifdef CLEANUP
3250 if (shellArgv)
3251 free(shellArgv);
3252 #endif
3253 }
3254
3255 /*-
3256 *-----------------------------------------------------------------------
3257 * Job_Wait --
3258 * Waits for all running jobs to finish and returns. Sets 'aborting'
3259 * to ABORT_WAIT to prevent other jobs from starting.
3260 *
3261 * Results:
3262 * None.
3263 *
3264 * Side Effects:
3265 * Currently running jobs finish.
3266 *
3267 *-----------------------------------------------------------------------
3268 */
3269 void
3270 Job_Wait(void)
3271 {
3272 aborting = ABORT_WAIT;
3273 while (nJobs != 0) {
3274 Job_CatchOutput();
3275 #ifndef RMT_WILL_WATCH
3276 Job_CatchChildren(!usePipes);
3277 #endif /* RMT_WILL_WATCH */
3278 }
3279 Job_TokenFlush();
3280 aborting = 0;
3281 }
3282
3283 /*-
3284 *-----------------------------------------------------------------------
3285 * Job_AbortAll --
3286 * Abort all currently running jobs without handling output or anything.
3287 * This function is to be called only in the event of a major
3288 * error. Most definitely NOT to be called from JobInterrupt.
3289 *
3290 * Results:
3291 * None
3292 *
3293 * Side Effects:
3294 * All children are killed, not just the firstborn
3295 *-----------------------------------------------------------------------
3296 */
3297 void
3298 Job_AbortAll(void)
3299 {
3300 LstNode ln; /* element in job table */
3301 Job *job; /* the job descriptor in that element */
3302 int foo;
3303 sigset_t mask;
3304
3305 aborting = ABORT_ERROR;
3306
3307 if (nJobs) {
3308
3309 JobSigLock(&mask);
3310 (void) Lst_Open(jobs);
3311 while ((ln = Lst_Next(jobs)) != NILLNODE) {
3312 job = (Job *) Lst_Datum(ln);
3313
3314 /*
3315 * kill the child process with increasingly drastic signals to make
3316 * darn sure it's dead.
3317 */
3318 #ifdef RMT_WANTS_SIGNALS
3319 if (job->flags & JOB_REMOTE) {
3320 Rmt_Signal(job, SIGINT);
3321 Rmt_Signal(job, SIGKILL);
3322 } else {
3323 KILL(job->pid, SIGINT);
3324 KILL(job->pid, SIGKILL);
3325 }
3326 #else
3327 KILL(job->pid, SIGINT);
3328 KILL(job->pid, SIGKILL);
3329 #endif /* RMT_WANTS_SIGNALS */
3330 }
3331 Lst_Close(jobs);
3332 JobSigUnlock(&mask);
3333 }
3334
3335 /*
3336 * Catch as many children as want to report in at first, then give up
3337 */
3338 while (waitpid((pid_t) -1, &foo, WNOHANG) > 0)
3339 continue;
3340 }
3341
3342 #ifdef REMOTE
3343 /*-
3344 *-----------------------------------------------------------------------
3345 * JobFlagForMigration --
3346 * Handle the eviction of a child. Called from RmtStatusChange.
3347 * Flags the child as remigratable and then suspends it.
3348 *
3349 * Input:
3350 * hostID ID of host we used, for matching children
3351 *
3352 * Results:
3353 * none.
3354 *
3355 * Side Effects:
3356 * The job descriptor is flagged for remigration.
3357 *
3358 *-----------------------------------------------------------------------
3359 */
3360 void
3361 JobFlagForMigration(int hostID)
3362 {
3363 Job *job; /* job descriptor for dead child */
3364 LstNode jnode; /* list element for finding job */
3365
3366 if (DEBUG(JOB)) {
3367 (void) fprintf(stdout, "JobFlagForMigration(%d) called.\n", hostID);
3368 (void) fflush(stdout);
3369 }
3370 jnode = Lst_Find(jobs, (ClientData)&hostID, JobCmpRmtID);
3371
3372 if (jnode == NILLNODE) {
3373 jnode = Lst_Find(stoppedJobs, (ClientData)hostID, JobCmpRmtID);
3374 if (jnode == NILLNODE) {
3375 if (DEBUG(JOB)) {
3376 Error("Evicting host(%d) not in table", hostID);
3377 }
3378 return;
3379 }
3380 }
3381 job = (Job *) Lst_Datum(jnode);
3382
3383 if (DEBUG(JOB)) {
3384 (void) fprintf(stdout,
3385 "JobFlagForMigration(%d) found job '%s'.\n", hostID,
3386 job->node->name);
3387 (void) fflush(stdout);
3388 }
3389
3390 KILL(job->pid, SIGSTOP);
3391
3392 job->flags |= JOB_REMIGRATE;
3393 }
3394
3395 #endif
3396
3397 /*-
3399 *-----------------------------------------------------------------------
3400 * JobRestartJobs --
3401 * Tries to restart stopped jobs if there are slots available.
3402 * Note that this tries to restart them regardless of pending errors.
3403 * It's not good to leave stopped jobs lying around!
3404 *
3405 * Results:
3406 * None.
3407 *
3408 * Side Effects:
3409 * Resumes(and possibly migrates) jobs.
3410 *
3411 *-----------------------------------------------------------------------
3412 */
3413 static void
3414 JobRestartJobs(void)
3415 {
3416 sigset_t mask;
3417
3418 JobSigLock(&mask);
3419 while (!Lst_IsEmpty(stoppedJobs)) {
3420 if (DEBUG(JOB)) {
3421 (void) fprintf(stdout, "Restarting a stopped job.\n");
3422 (void) fflush(stdout);
3423 }
3424 if (JobRestart((Job *)Lst_DeQueue(stoppedJobs)) != 0)
3425 break;
3426 }
3427 JobSigUnlock(&mask);
3428 }
3429
3430 #ifndef RMT_WILL_WATCH
3431 static void
3432 watchfd(Job *job)
3433 {
3434 int i;
3435 if (job->inPollfd != NULL)
3436 Punt("Watching watched job");
3437 if (fds == NULL) {
3438 maxfds = JBSTART;
3439 fds = emalloc(sizeof(struct pollfd) * maxfds);
3440 jobfds = emalloc(sizeof(Job **) * maxfds);
3441
3442 fds[0].fd = job_pipe[0];
3443 fds[0].events = POLLIN;
3444 jobfds[0] = &tokenWaitJob;
3445 tokenWaitJob.inPollfd = &fds[0];
3446 nfds++;
3447
3448 fds[1].fd = exit_pipe[0];
3449 fds[1].events = POLLIN;
3450 jobfds[1] = &childExitJob;
3451 childExitJob.inPollfd = &fds[1];
3452 nfds++;
3453 } else if (nfds == maxfds) {
3454 maxfds *= JBFACTOR;
3455 fds = erealloc(fds, sizeof(struct pollfd) * maxfds);
3456 jobfds = erealloc(jobfds, sizeof(Job **) * maxfds);
3457 for (i = 0; i < nfds; i++)
3458 jobfds[i]->inPollfd = &fds[i];
3459 }
3460
3461 fds[nfds].fd = job->inPipe;
3462 fds[nfds].events = POLLIN;
3463 jobfds[nfds] = job;
3464 job->inPollfd = &fds[nfds];
3465 nfds++;
3466 }
3467
3468 static void
3469 clearfd(Job *job)
3470 {
3471 int i;
3472 if (job->inPollfd == NULL)
3473 Punt("Unwatching unwatched job");
3474 i = job->inPollfd - fds;
3475 nfds--;
3476 /*
3477 * Move last job in table into hole made by dead job.
3478 */
3479 if (nfds != i) {
3480 fds[i] = fds[nfds];
3481 jobfds[i] = jobfds[nfds];
3482 jobfds[i]->inPollfd = &fds[i];
3483 }
3484 job->inPollfd = NULL;
3485 }
3486
3487 static int
3488 readyfd(Job *job)
3489 {
3490 if (job->inPollfd == NULL)
3491 Punt("Polling unwatched job");
3492 return (job->inPollfd->revents & POLLIN) != 0;
3493 }
3494 #endif
3495
3496 /*-
3497 *-----------------------------------------------------------------------
3498 * JobTokenAdd --
3499 * Put a token into the job pipe so that some make process can start
3500 * another job.
3501 *
3502 * Side Effects:
3503 * Allows more build jobs to be spawned somewhere.
3504 *
3505 *-----------------------------------------------------------------------
3506 */
3507
3508 static void
3509 JobTokenAdd(void)
3510 {
3511
3512 if (DEBUG(JOB))
3513 printf("deposit token\n");
3514 write(job_pipe[1], "+", 1);
3515 }
3516
3517 /*-
3518 *-----------------------------------------------------------------------
3519 * Job_ServerStartTokenAdd --
3520 * Prep the job token pipe in the root make process.
3521 *
3522 *-----------------------------------------------------------------------
3523 */
3524
3525 void
3526 Job_ServerStart(int maxproc)
3527 {
3528 int i, flags;
3529 char jobarg[64];
3530
3531 if (pipe(job_pipe) < 0)
3532 Fatal("error in pipe: %s", strerror(errno));
3533
3534 /*
3535 * We mark the input side of the pipe non-blocking; we poll(2) the
3536 * pipe when we're waiting for a job token, but we might lose the
3537 * race for the token when a new one becomes available, so the read
3538 * from the pipe should not block.
3539 */
3540 flags = fcntl(job_pipe[0], F_GETFL, 0);
3541 flags |= O_NONBLOCK;
3542 fcntl(job_pipe[0], F_SETFL, flags);
3543
3544 /*
3545 * Mark job pipes as close-on-exec.
3546 * Note that we will clear this when executing submakes.
3547 */
3548 fcntl(job_pipe[0], F_SETFD, 1);
3549 fcntl(job_pipe[1], F_SETFD, 1);
3550
3551 snprintf(jobarg, sizeof(jobarg), "%d,%d", job_pipe[0], job_pipe[1]);
3552
3553 Var_Append(MAKEFLAGS, "-J", VAR_GLOBAL);
3554 Var_Append(MAKEFLAGS, jobarg, VAR_GLOBAL);
3555
3556 /*
3557 * Preload job_pipe with one token per job, save the one
3558 * "extra" token for the primary job.
3559 *
3560 * XXX should clip maxJobs against PIPE_BUF -- if maxJobs is
3561 * larger than the write buffer size of the pipe, we will
3562 * deadlock here.
3563 */
3564 for (i=1; i < maxproc; i++)
3565 JobTokenAdd();
3566 }
3567
3568 /*
3569 * this tracks the number of tokens currently "out" to build jobs.
3570 */
3571 int jobTokensRunning = 0;
3572 int jobTokensFree = 0;
3573 /*-
3574 *-----------------------------------------------------------------------
3575 * Job_TokenReturn --
3576 * Return a withdrawn token to the pool.
3577 *
3578 *-----------------------------------------------------------------------
3579 */
3580
3581 void
3582 Job_TokenReturn(void)
3583 {
3584 jobTokensRunning--;
3585 if (jobTokensRunning < 0)
3586 Punt("token botch");
3587 if (jobTokensRunning)
3588 jobTokensFree++;
3589 }
3590
3591 /*-
3592 *-----------------------------------------------------------------------
3593 * Job_TokenWithdraw --
3594 * Attempt to withdraw a token from the pool.
3595 *
3596 * Results:
3597 * Returns TRUE if a token was withdrawn, and FALSE if the pool
3598 * is currently empty.
3599 *
3600 * Side Effects:
3601 * If pool is empty, set wantToken so that we wake up
3602 * when a token is released.
3603 *
3604 *-----------------------------------------------------------------------
3605 */
3606
3607
3608 Boolean
3609 Job_TokenWithdraw(void)
3610 {
3611 char tok;
3612 int count;
3613
3614 wantToken = FALSE;
3615
3616 if (aborting)
3617 return FALSE;
3618
3619 if (jobTokensRunning == 0) {
3620 if (DEBUG(JOB))
3621 printf("first one's free\n");
3622 jobTokensRunning++;
3623 return TRUE;
3624 }
3625 if (jobTokensFree > 0) {
3626 jobTokensFree--;
3627 jobTokensRunning++;
3628 return TRUE;
3629 }
3630 count = read(job_pipe[0], &tok, 1);
3631 if (count == 0)
3632 Fatal("eof on job pipe!");
3633 else if (count < 0) {
3634 if (errno != EAGAIN) {
3635 Fatal("job pipe read: %s", strerror(errno));
3636 }
3637 if (DEBUG(JOB))
3638 printf("blocked for token\n");
3639 wantToken = TRUE;
3640 return FALSE;
3641 }
3642 jobTokensRunning++;
3643 if (DEBUG(JOB))
3644 printf("withdrew token\n");
3645 return TRUE;
3646 }
3647
3648 /*-
3649 *-----------------------------------------------------------------------
3650 * Job_TokenFlush --
3651 * Return free tokens to the pool.
3652 *
3653 *-----------------------------------------------------------------------
3654 */
3655
3656 void
3657 Job_TokenFlush(void)
3658 {
3659 if (compatMake) return;
3660
3661 while (jobTokensFree > 0) {
3662 JobTokenAdd();
3663 jobTokensFree--;
3664 }
3665 }
3666
3667 #ifdef USE_SELECT
3668 int
3669 emul_poll(struct pollfd *fd, int nfd, int timeout)
3670 {
3671 fd_set rfds, wfds;
3672 int i, maxfd, nselect, npoll;
3673 struct timeval tv, *tvp;
3674 long usecs;
3675
3676 FD_ZERO(&rfds);
3677 FD_ZERO(&wfds);
3678
3679 maxfd = -1;
3680 for (i = 0; i < nfd; i++) {
3681 fd[i].revents = 0;
3682
3683 if (fd[i].events & POLLIN)
3684 FD_SET(fd[i].fd, &rfds);
3685
3686 if (fd[i].events & POLLOUT)
3687 FD_SET(fd[i].fd, &wfds);
3688
3689 if (fd[i].fd > maxfd)
3690 maxfd = fd[i].fd;
3691 }
3692
3693 if (maxfd >= FD_SETSIZE) {
3694 Punt("Ran out of fd_set slots; "
3695 "recompile with a larger FD_SETSIZE.");
3696 }
3697
3698 if (timeout < 0) {
3699 tvp = NULL;
3700 } else {
3701 usecs = timeout * 1000;
3702 tv.tv_sec = usecs / 1000000;
3703 tv.tv_usec = usecs % 1000000;
3704 tvp = &tv;
3705 }
3706
3707 nselect = select(maxfd + 1, &rfds, &wfds, 0, tvp);
3708
3709 if (nselect <= 0)
3710 return nselect;
3711
3712 npoll = 0;
3713 for (i = 0; i < nfd; i++) {
3714 if (FD_ISSET(fd[i].fd, &rfds))
3715 fd[i].revents |= POLLIN;
3716
3717 if (FD_ISSET(fd[i].fd, &wfds))
3718 fd[i].revents |= POLLOUT;
3719
3720 if (fd[i].revents)
3721 npoll++;
3722 }
3723
3724 return npoll;
3725 }
3726 #endif /* USE_SELECT */
3727