job.c revision 1.93 1 /* $NetBSD: job.c,v 1.93 2005/06/16 18:07:45 jmc 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.93 2005/06/16 18:07:45 jmc 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.93 2005/06/16 18:07:45 jmc 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 or blank, treat as an ignored error */
833 if ((escCmd[0] == commandShell->commentChar) ||
834 (escCmd[0] == 0))
835 cmdTemplate = commandShell->ignErr;
836 else
837 cmdTemplate = commandShell->errOut;
838 errOff = FALSE;
839 }
840 }
841
842 if (DEBUG(SHELL) && strcmp(shellName, "sh") == 0 &&
843 (job->flags & JOB_TRACED) == 0) {
844 DBPRINTF("set -%s\n", "x");
845 job->flags |= JOB_TRACED;
846 }
847
848 if ((cp = Check_Cwd_Cmd(cmd)) != NULL) {
849 DBPRINTF("test -d %s && ", cp);
850 DBPRINTF("cd %s\n", cp);
851 }
852
853 DBPRINTF(cmdTemplate, cmd);
854 free(cmdStart);
855 if (escCmd)
856 free(escCmd);
857 if (errOff) {
858 /*
859 * If echoing is already off, there's no point in issuing the
860 * echoOff command. Otherwise we issue it and pretend it was on
861 * for the whole command...
862 */
863 if (!shutUp && !(job->flags & JOB_SILENT) && commandShell->hasEchoCtl){
864 DBPRINTF("%s\n", commandShell->echoOff);
865 shutUp = TRUE;
866 }
867 DBPRINTF("%s\n", commandShell->errCheck);
868 }
869 if (shutUp && commandShell->hasEchoCtl) {
870 DBPRINTF("%s\n", commandShell->echoOn);
871 }
872 if (cp != NULL) {
873 DBPRINTF("test -d %s && ", cp);
874 DBPRINTF("cd %s\n", Var_Value(".OBJDIR", VAR_GLOBAL, &tmp));
875 }
876 return 0;
877 }
878
879 /*-
880 *-----------------------------------------------------------------------
881 * JobSaveCommand --
882 * Save a command to be executed when everything else is done.
883 * Callback function for JobFinish...
884 *
885 * Results:
886 * Always returns 0
887 *
888 * Side Effects:
889 * The command is tacked onto the end of postCommands's commands list.
890 *
891 *-----------------------------------------------------------------------
892 */
893 static int
894 JobSaveCommand(ClientData cmd, ClientData gn)
895 {
896 cmd = (ClientData) Var_Subst(NULL, (char *) cmd, (GNode *) gn, FALSE);
897 (void) Lst_AtEnd(postCommands->commands, cmd);
898 return(0);
899 }
900
901
902 /*-
903 *-----------------------------------------------------------------------
904 * JobClose --
905 * Called to close both input and output pipes when a job is finished.
906 *
907 * Results:
908 * Nada
909 *
910 * Side Effects:
911 * The file descriptors associated with the job are closed.
912 *
913 *-----------------------------------------------------------------------
914 */
915 static void
916 JobClose(Job *job)
917 {
918 if (usePipes && (job->flags & JOB_FIRST)) {
919 #ifdef RMT_WILL_WATCH
920 Rmt_Ignore(job->inPipe);
921 #else
922 clearfd(job);
923 #endif
924 if (job->outPipe != job->inPipe) {
925 (void) close(job->outPipe);
926 }
927 JobDoOutput(job, TRUE);
928 (void) close(job->inPipe);
929 } else {
930 (void) close(job->outFd);
931 JobDoOutput(job, TRUE);
932 }
933 }
934
935 /*-
936 *-----------------------------------------------------------------------
937 * JobFinish --
938 * Do final processing for the given job including updating
939 * parents and starting new jobs as available/necessary. Note
940 * that we pay no attention to the JOB_IGNERR flag here.
941 * This is because when we're called because of a noexecute flag
942 * or something, jstat.w_status is 0 and when called from
943 * Job_CatchChildren, the status is zeroed if it s/b ignored.
944 *
945 * Input:
946 * job job to finish
947 * status sub-why job went away
948 *
949 * Results:
950 * None
951 *
952 * Side Effects:
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 && (gn->type & OP_SPECIAL) == 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 if (gn->type & OP_SPECIAL)
1934 flags |= JOB_SPECIAL;
1935
1936 job->node = gn;
1937 job->tailCmds = NILLNODE;
1938
1939 /*
1940 * Set the initial value of the flags for this job based on the global
1941 * ones and the node's attributes... Any flags supplied by the caller
1942 * are also added to the field.
1943 */
1944 job->flags = 0;
1945 if (Targ_Ignore(gn)) {
1946 job->flags |= JOB_IGNERR;
1947 }
1948 if (Targ_Silent(gn)) {
1949 job->flags |= JOB_SILENT;
1950 }
1951 job->flags |= flags;
1952
1953 /*
1954 * Check the commands now so any attributes from .DEFAULT have a chance
1955 * to migrate to the node
1956 */
1957 if (!compatMake && job->flags & JOB_FIRST) {
1958 cmdsOK = Job_CheckCommands(gn, Error);
1959 } else {
1960 cmdsOK = TRUE;
1961 }
1962
1963 #ifndef RMT_WILL_WATCH
1964 job->inPollfd = NULL;
1965 #endif
1966 /*
1967 * If the -n flag wasn't given, we open up OUR (not the child's)
1968 * temporary file to stuff commands in it. The thing is rd/wr so we don't
1969 * need to reopen it to feed it to the shell. If the -n flag *was* given,
1970 * we just set the file to be stdout. Cute, huh?
1971 */
1972 if (((gn->type & OP_MAKE) && !(noRecursiveExecute)) ||
1973 (!noExecute && !touchFlag)) {
1974 /*
1975 * tfile is the name of a file into which all shell commands are
1976 * put. It is used over by removing it before the child shell is
1977 * executed. The XXXXXX in the string are replaced by the pid of
1978 * the make process in a 6-character field with leading zeroes.
1979 */
1980 char tfile[sizeof(TMPPAT)];
1981 sigset_t mask;
1982 /*
1983 * We're serious here, but if the commands were bogus, we're
1984 * also dead...
1985 */
1986 if (!cmdsOK) {
1987 DieHorribly();
1988 }
1989
1990 JobSigLock(&mask);
1991 (void)strcpy(tfile, TMPPAT);
1992 if ((tfd = mkstemp(tfile)) == -1)
1993 Punt("Could not create temporary file %s", strerror(errno));
1994 (void) eunlink(tfile);
1995 JobSigUnlock(&mask);
1996
1997 job->cmdFILE = fdopen(tfd, "w+");
1998 if (job->cmdFILE == NULL) {
1999 Punt("Could not fdopen %s", tfile);
2000 }
2001 (void) fcntl(FILENO(job->cmdFILE), F_SETFD, 1);
2002 /*
2003 * Send the commands to the command file, flush all its buffers then
2004 * rewind and remove the thing.
2005 */
2006 noExec = FALSE;
2007
2008 /*
2009 * used to be backwards; replace when start doing multiple commands
2010 * per shell.
2011 */
2012 if (compatMake) {
2013 /*
2014 * Be compatible: If this is the first time for this node,
2015 * verify its commands are ok and open the commands list for
2016 * sequential access by later invocations of JobStart.
2017 * Once that is done, we take the next command off the list
2018 * and print it to the command file. If the command was an
2019 * ellipsis, note that there's nothing more to execute.
2020 */
2021 if ((job->flags&JOB_FIRST) && (Lst_Open(gn->commands) != SUCCESS)){
2022 cmdsOK = FALSE;
2023 } else {
2024 LstNode ln = Lst_Next(gn->commands);
2025
2026 if ((ln == NILLNODE) ||
2027 JobPrintCommand((ClientData) Lst_Datum(ln),
2028 (ClientData) job))
2029 {
2030 noExec = TRUE;
2031 Lst_Close(gn->commands);
2032 }
2033 if (noExec && !(job->flags & JOB_FIRST)) {
2034 /*
2035 * If we're not going to execute anything, the job
2036 * is done and we need to close down the various
2037 * file descriptors we've opened for output, then
2038 * call JobDoOutput to catch the final characters or
2039 * send the file to the screen... Note that the i/o streams
2040 * are only open if this isn't the first job.
2041 * Note also that this could not be done in
2042 * Job_CatchChildren b/c it wasn't clear if there were
2043 * more commands to execute or not...
2044 */
2045 JobClose(job);
2046 }
2047 }
2048 } else {
2049 /*
2050 * We can do all the commands at once. hooray for sanity
2051 */
2052 numCommands = 0;
2053 Lst_ForEach(gn->commands, JobPrintCommand, (ClientData)job);
2054
2055 /*
2056 * If we didn't print out any commands to the shell script,
2057 * there's not much point in executing the shell, is there?
2058 */
2059 if (numCommands == 0) {
2060 noExec = TRUE;
2061 }
2062 }
2063 } else if (NoExecute(gn)) {
2064 /*
2065 * Not executing anything -- just print all the commands to stdout
2066 * in one fell swoop. This will still set up job->tailCmds correctly.
2067 */
2068 if (lastNode != gn) {
2069 MESSAGE(stdout, gn);
2070 lastNode = gn;
2071 }
2072 job->cmdFILE = stdout;
2073 /*
2074 * Only print the commands if they're ok, but don't die if they're
2075 * not -- just let the user know they're bad and keep going. It
2076 * doesn't do any harm in this case and may do some good.
2077 */
2078 if (cmdsOK) {
2079 Lst_ForEach(gn->commands, JobPrintCommand, (ClientData)job);
2080 }
2081 /*
2082 * Don't execute the shell, thank you.
2083 */
2084 noExec = TRUE;
2085 } else {
2086 /*
2087 * Just touch the target and note that no shell should be executed.
2088 * Set cmdFILE to stdout to make life easier. Check the commands, too,
2089 * but don't die if they're no good -- it does no harm to keep working
2090 * up the graph.
2091 */
2092 job->cmdFILE = stdout;
2093 Job_Touch(gn, job->flags&JOB_SILENT);
2094 noExec = TRUE;
2095 }
2096
2097 /*
2098 * If we're not supposed to execute a shell, don't.
2099 */
2100 if (noExec) {
2101 /*
2102 * Unlink and close the command file if we opened one
2103 */
2104 if (job->cmdFILE != stdout) {
2105 if (job->cmdFILE != NULL) {
2106 (void) fclose(job->cmdFILE);
2107 job->cmdFILE = NULL;
2108 }
2109 } else {
2110 (void) fflush(stdout);
2111 }
2112
2113 /*
2114 * We only want to work our way up the graph if we aren't here because
2115 * the commands for the job were no good.
2116 */
2117 if (cmdsOK) {
2118 if (aborting == 0) {
2119 if (job->tailCmds != NILLNODE) {
2120 Lst_ForEachFrom(job->node->commands, job->tailCmds,
2121 JobSaveCommand,
2122 (ClientData)job->node);
2123 }
2124 if (!(job->flags & JOB_SPECIAL))
2125 Job_TokenReturn();
2126 job->node->made = MADE;
2127 Make_Update(job->node);
2128 }
2129 free((Address)job);
2130 return(JOB_FINISHED);
2131 } else {
2132 free((Address)job);
2133 return(JOB_ERROR);
2134 }
2135 } else {
2136 (void) fflush(job->cmdFILE);
2137 }
2138
2139 /*
2140 * Set up the control arguments to the shell. This is based on the flags
2141 * set earlier for this job.
2142 */
2143 JobMakeArgv(job, argv);
2144
2145 /*
2146 * If we're using pipes to catch output, create the pipe by which we'll
2147 * get the shell's output. If we're using files, print out that we're
2148 * starting a job and then set up its temporary-file name.
2149 */
2150 if (!compatMake || (job->flags & JOB_FIRST)) {
2151 if (usePipes) {
2152 int fd[2];
2153 if (pipe(fd) == -1)
2154 Punt("Cannot create pipe: %s", strerror(errno));
2155 job->inPipe = fd[0];
2156 job->outPipe = fd[1];
2157 (void) fcntl(job->inPipe, F_SETFD, 1);
2158 (void) fcntl(job->outPipe, F_SETFD, 1);
2159 } else {
2160 (void) fprintf(stdout, "Remaking `%s'\n", gn->name);
2161 (void) fflush(stdout);
2162 (void) strcpy(job->outFile, TMPPAT);
2163 job->outFd = mkstemp(job->outFile);
2164 (void) fcntl(job->outFd, F_SETFD, 1);
2165 }
2166 }
2167
2168 #ifdef REMOTE
2169 if (!(gn->type & OP_NOEXPORT) && !(runLocalFirst && nLocal < maxLocal)) {
2170 #ifdef RMT_NO_EXEC
2171 local = !Rmt_Export(shellPath, argv, job);
2172 #else
2173 local = !Rmt_Begin(shellPath, argv, job->node);
2174 #endif /* RMT_NO_EXEC */
2175 if (!local) {
2176 job->flags |= JOB_REMOTE;
2177 }
2178 } else
2179 #endif
2180 local = TRUE;
2181
2182 if (local && (((nLocal >= maxLocal) &&
2183 !(job->flags & JOB_SPECIAL) &&
2184 #ifdef REMOTE
2185 (!(gn->type & OP_NOEXPORT) || (maxLocal != 0))
2186 #else
2187 (maxLocal != 0)
2188 #endif
2189 )))
2190 {
2191 /*
2192 * The job can only be run locally, but we've hit the limit of
2193 * local concurrency, so put the job on hold until some other job
2194 * finishes. Note that the special jobs (.BEGIN, .INTERRUPT and .END)
2195 * may be run locally even when the local limit has been reached
2196 * (e.g. when maxLocal == 0), though they will be exported if at
2197 * all possible. In addition, any target marked with .NOEXPORT will
2198 * be run locally if maxLocal is 0.
2199 */
2200 job->flags |= JOB_RESTART;
2201 (void) Lst_AtEnd(stoppedJobs, (ClientData)job);
2202 } else {
2203 JobExec(job, argv);
2204 }
2205 return(JOB_RUNNING);
2206 }
2207
2208 static char *
2209 JobOutput(Job *job, char *cp, char *endp, int msg)
2210 {
2211 char *ecp;
2212
2213 if (commandShell->noPrint) {
2214 ecp = Str_FindSubstring(cp, commandShell->noPrint);
2215 while (ecp != NULL) {
2216 if (cp != ecp) {
2217 *ecp = '\0';
2218 if (msg && job->node != lastNode) {
2219 MESSAGE(stdout, job->node);
2220 lastNode = job->node;
2221 }
2222 /*
2223 * The only way there wouldn't be a newline after
2224 * this line is if it were the last in the buffer.
2225 * however, since the non-printable comes after it,
2226 * there must be a newline, so we don't print one.
2227 */
2228 (void) fprintf(stdout, "%s", cp);
2229 (void) fflush(stdout);
2230 }
2231 cp = ecp + commandShell->noPLen;
2232 if (cp != endp) {
2233 /*
2234 * Still more to print, look again after skipping
2235 * the whitespace following the non-printable
2236 * command....
2237 */
2238 cp++;
2239 while (*cp == ' ' || *cp == '\t' || *cp == '\n') {
2240 cp++;
2241 }
2242 ecp = Str_FindSubstring(cp, commandShell->noPrint);
2243 } else {
2244 return cp;
2245 }
2246 }
2247 }
2248 return cp;
2249 }
2250
2251 /*-
2252 *-----------------------------------------------------------------------
2253 * JobDoOutput --
2254 * This function is called at different times depending on
2255 * whether the user has specified that output is to be collected
2256 * via pipes or temporary files. In the former case, we are called
2257 * whenever there is something to read on the pipe. We collect more
2258 * output from the given job and store it in the job's outBuf. If
2259 * this makes up a line, we print it tagged by the job's identifier,
2260 * as necessary.
2261 * If output has been collected in a temporary file, we open the
2262 * file and read it line by line, transfering it to our own
2263 * output channel until the file is empty. At which point we
2264 * remove the temporary file.
2265 * In both cases, however, we keep our figurative eye out for the
2266 * 'noPrint' line for the shell from which the output came. If
2267 * we recognize a line, we don't print it. If the command is not
2268 * alone on the line (the character after it is not \0 or \n), we
2269 * do print whatever follows it.
2270 *
2271 * Input:
2272 * job the job whose output needs printing
2273 * finish TRUE if this is the last time we'll be called
2274 * for this job
2275 *
2276 * Results:
2277 * None
2278 *
2279 * Side Effects:
2280 * curPos may be shifted as may the contents of outBuf.
2281 *-----------------------------------------------------------------------
2282 */
2283 STATIC void
2284 JobDoOutput(Job *job, Boolean finish)
2285 {
2286 Boolean gotNL = FALSE; /* true if got a newline */
2287 Boolean fbuf; /* true if our buffer filled up */
2288 int nr; /* number of bytes read */
2289 int i; /* auxiliary index into outBuf */
2290 int max; /* limit for i (end of current data) */
2291 int nRead; /* (Temporary) number of bytes read */
2292
2293 FILE *oFILE; /* Stream pointer to shell's output file */
2294 char inLine[132];
2295
2296
2297 if (usePipes) {
2298 /*
2299 * Read as many bytes as will fit in the buffer.
2300 */
2301 end_loop:
2302 gotNL = FALSE;
2303 fbuf = FALSE;
2304
2305 nRead = read(job->inPipe, &job->outBuf[job->curPos],
2306 JOB_BUFSIZE - job->curPos);
2307 if (nRead < 0) {
2308 if (DEBUG(JOB)) {
2309 perror("JobDoOutput(piperead)");
2310 }
2311 nr = 0;
2312 } else {
2313 nr = nRead;
2314 }
2315
2316 /*
2317 * If we hit the end-of-file (the job is dead), we must flush its
2318 * remaining output, so pretend we read a newline if there's any
2319 * output remaining in the buffer.
2320 * Also clear the 'finish' flag so we stop looping.
2321 */
2322 if ((nr == 0) && (job->curPos != 0)) {
2323 job->outBuf[job->curPos] = '\n';
2324 nr = 1;
2325 finish = FALSE;
2326 } else if (nr == 0) {
2327 finish = FALSE;
2328 }
2329
2330 /*
2331 * Look for the last newline in the bytes we just got. If there is
2332 * one, break out of the loop with 'i' as its index and gotNL set
2333 * TRUE.
2334 */
2335 max = job->curPos + nr;
2336 for (i = job->curPos + nr - 1; i >= job->curPos; i--) {
2337 if (job->outBuf[i] == '\n') {
2338 gotNL = TRUE;
2339 break;
2340 } else if (job->outBuf[i] == '\0') {
2341 /*
2342 * Why?
2343 */
2344 job->outBuf[i] = ' ';
2345 }
2346 }
2347
2348 if (!gotNL) {
2349 job->curPos += nr;
2350 if (job->curPos == JOB_BUFSIZE) {
2351 /*
2352 * If we've run out of buffer space, we have no choice
2353 * but to print the stuff. sigh.
2354 */
2355 fbuf = TRUE;
2356 i = job->curPos;
2357 }
2358 }
2359 if (gotNL || fbuf) {
2360 /*
2361 * Need to send the output to the screen. Null terminate it
2362 * first, overwriting the newline character if there was one.
2363 * So long as the line isn't one we should filter (according
2364 * to the shell description), we print the line, preceded
2365 * by a target banner if this target isn't the same as the
2366 * one for which we last printed something.
2367 * The rest of the data in the buffer are then shifted down
2368 * to the start of the buffer and curPos is set accordingly.
2369 */
2370 job->outBuf[i] = '\0';
2371 if (i >= job->curPos) {
2372 char *cp;
2373
2374 cp = JobOutput(job, job->outBuf, &job->outBuf[i], FALSE);
2375
2376 /*
2377 * There's still more in that thar buffer. This time, though,
2378 * we know there's no newline at the end, so we add one of
2379 * our own free will.
2380 */
2381 if (*cp != '\0') {
2382 if (job->node != lastNode) {
2383 MESSAGE(stdout, job->node);
2384 lastNode = job->node;
2385 }
2386 (void) fprintf(stdout, "%s%s", cp, gotNL ? "\n" : "");
2387 (void) fflush(stdout);
2388 }
2389 }
2390 if (i < max - 1) {
2391 /* shift the remaining characters down */
2392 (void) memcpy(job->outBuf, &job->outBuf[i + 1], max - (i + 1));
2393 job->curPos = max - (i + 1);
2394
2395 } else {
2396 /*
2397 * We have written everything out, so we just start over
2398 * from the start of the buffer. No copying. No nothing.
2399 */
2400 job->curPos = 0;
2401 }
2402 }
2403 if (finish) {
2404 /*
2405 * If the finish flag is true, we must loop until we hit
2406 * end-of-file on the pipe. This is guaranteed to happen
2407 * eventually since the other end of the pipe is now closed
2408 * (we closed it explicitly and the child has exited). When
2409 * we do get an EOF, finish will be set FALSE and we'll fall
2410 * through and out.
2411 */
2412 goto end_loop;
2413 }
2414 } else {
2415 /*
2416 * We've been called to retrieve the output of the job from the
2417 * temporary file where it's been squirreled away. This consists of
2418 * opening the file, reading the output line by line, being sure not
2419 * to print the noPrint line for the shell we used, then close and
2420 * remove the temporary file. Very simple.
2421 *
2422 * Change to read in blocks and do FindSubString type things as for
2423 * pipes? That would allow for "@echo -n..."
2424 */
2425 oFILE = fopen(job->outFile, "r");
2426 if (oFILE != NULL) {
2427 (void) fprintf(stdout, "Results of making %s:\n", job->node->name);
2428 (void) fflush(stdout);
2429 while (fgets(inLine, sizeof(inLine), oFILE) != NULL) {
2430 char *cp, *endp, *oendp;
2431
2432 cp = inLine;
2433 oendp = endp = inLine + strlen(inLine);
2434 if (endp[-1] == '\n') {
2435 *--endp = '\0';
2436 }
2437 cp = JobOutput(job, inLine, endp, FALSE);
2438
2439 /*
2440 * There's still more in that thar buffer. This time, though,
2441 * we know there's no newline at the end, so we add one of
2442 * our own free will.
2443 */
2444 (void) fprintf(stdout, "%s", cp);
2445 (void) fflush(stdout);
2446 if (endp != oendp) {
2447 (void) fprintf(stdout, "\n");
2448 (void) fflush(stdout);
2449 }
2450 }
2451 (void) fclose(oFILE);
2452 (void) eunlink(job->outFile);
2453 } else {
2454 Punt("Cannot open `%s'", job->outFile);
2455 }
2456 }
2457 }
2458
2459 static void
2460 JobRun(GNode *targ)
2461 {
2462 #ifdef notyet
2463 /*
2464 * Unfortunately it is too complicated to run .BEGIN, .END,
2465 * and .INTERRUPT job in the parallel job module. This has
2466 * the nice side effect that it avoids a lot of other problems.
2467 */
2468 Lst lst = Lst_Init(FALSE);
2469 Lst_AtEnd(lst, targ);
2470 (void)Make_Run(lst);
2471 Lst_Destroy(lst, NOFREE);
2472 JobStart(targ, JOB_SPECIAL, (Job *)0);
2473 while (nJobs) {
2474 Job_CatchOutput();
2475 #ifndef RMT_WILL_WATCH
2476 Job_CatchChildren(!usePipes);
2477 #endif /* RMT_WILL_WATCH */
2478 }
2479 #else
2480 Compat_Make(targ, targ);
2481 if (targ->made == ERROR) {
2482 PrintOnError("\n\nStop.");
2483 exit(1);
2484 }
2485 #endif
2486 }
2487
2488 /*-
2489 *-----------------------------------------------------------------------
2490 * Job_CatchChildren --
2491 * Handle the exit of a child. Called from Make_Make.
2492 *
2493 * Input:
2494 * block TRUE if should block on the wait
2495 *
2496 * Results:
2497 * none.
2498 *
2499 * Side Effects:
2500 * The job descriptor is removed from the list of children.
2501 *
2502 * Notes:
2503 * We do waits, blocking or not, according to the wisdom of our
2504 * caller, until there are no more children to report. For each
2505 * job, call JobFinish to finish things off. This will take care of
2506 * putting jobs on the stoppedJobs queue.
2507 *
2508 *-----------------------------------------------------------------------
2509 */
2510 void
2511 Job_CatchChildren(Boolean block)
2512 {
2513 int pid; /* pid of dead child */
2514 Job *job; /* job descriptor for dead child */
2515 LstNode jnode; /* list element for finding job */
2516 int status; /* Exit/termination status */
2517
2518 /*
2519 * Don't even bother if we know there's no one around.
2520 */
2521 if (nLocal == 0) {
2522 return;
2523 }
2524
2525 while ((pid = waitpid((pid_t) -1, &status,
2526 (block?0:WNOHANG)|WUNTRACED)) > 0)
2527 {
2528 if (DEBUG(JOB)) {
2529 (void) fprintf(stdout, "Process %d exited or stopped %x.\n", pid,
2530 status);
2531 (void) fflush(stdout);
2532 }
2533
2534 jnode = Lst_Find(jobs, (ClientData)&pid, JobCmpPid);
2535 if (jnode == NILLNODE) {
2536 if (WIFSTOPPED(status) && (WSTOPSIG(status) == SIGCONT)) {
2537 jnode = Lst_Find(stoppedJobs, (ClientData) &pid, JobCmpPid);
2538 if (jnode == NILLNODE) {
2539 Error("Resumed child (%d) not in table", pid);
2540 continue;
2541 }
2542 job = (Job *)Lst_Datum(jnode);
2543 (void) Lst_Remove(stoppedJobs, jnode);
2544 } else {
2545 Error("Child (%d) not in table?", pid);
2546 continue;
2547 }
2548 } else {
2549 job = (Job *) Lst_Datum(jnode);
2550 (void) Lst_Remove(jobs, jnode);
2551 nJobs -= 1;
2552 #ifdef REMOTE
2553 if (!(job->flags & JOB_REMOTE)) {
2554 if (DEBUG(JOB)) {
2555 (void) fprintf(stdout,
2556 "Job queue has one fewer local process.\n");
2557 (void) fflush(stdout);
2558 }
2559 nLocal -= 1;
2560 }
2561 #else
2562 nLocal -= 1;
2563 #endif
2564 }
2565
2566 JobFinish(job, &status);
2567 }
2568 }
2569
2570 /*-
2571 *-----------------------------------------------------------------------
2572 * Job_CatchOutput --
2573 * Catch the output from our children, if we're using
2574 * pipes do so. Otherwise just block time until we get a
2575 * signal (most likely a SIGCHLD) since there's no point in
2576 * just spinning when there's nothing to do and the reaping
2577 * of a child can wait for a while.
2578 *
2579 * Results:
2580 * None
2581 *
2582 * Side Effects:
2583 * Output is read from pipes if we're piping.
2584 * -----------------------------------------------------------------------
2585 */
2586 void
2587 Job_CatchOutput(void)
2588 {
2589 int nready;
2590 LstNode ln;
2591 Job *job;
2592 #ifdef RMT_WILL_WATCH
2593 int pnJobs; /* Previous nJobs */
2594 #endif
2595
2596 (void) fflush(stdout);
2597 Job_TokenFlush();
2598 #ifdef RMT_WILL_WATCH
2599 pnJobs = nJobs;
2600
2601 /*
2602 * It is possible for us to be called with nJobs equal to 0. This happens
2603 * if all the jobs finish and a job that is stopped cannot be run
2604 * locally (eg if maxLocal is 0) and cannot be exported. The job will
2605 * be placed back on the stoppedJobs queue, Job_Empty() will return false,
2606 * Make_Run will call us again when there's nothing for which to wait.
2607 * nJobs never changes, so we loop forever. Hence the check. It could
2608 * be argued that we should sleep for a bit so as not to swamp the
2609 * exportation system with requests. Perhaps we should.
2610 *
2611 * NOTE: IT IS THE RESPONSIBILITY OF Rmt_Wait TO CALL Job_CatchChildren
2612 * IN A TIMELY FASHION TO CATCH ANY LOCALLY RUNNING JOBS THAT EXIT.
2613 * It may use the variable nLocal to determine if it needs to call
2614 * Job_CatchChildren(if nLocal is 0, there's nothing for which to
2615 * wait...)
2616 */
2617 while (nJobs != 0 && pnJobs == nJobs) {
2618 Rmt_Wait();
2619 }
2620 #else
2621 if (usePipes) {
2622 if ((nready = poll((wantToken ? fds : (fds + 1)),
2623 (wantToken ? nfds : (nfds - 1)), POLL_MSEC)) <= 0) {
2624 return;
2625 } else {
2626 sigset_t mask;
2627 JobSigLock(&mask);
2628 if (Lst_Open(jobs) == FAILURE) {
2629 Punt("Cannot open job table");
2630 }
2631
2632 if (readyfd(&childExitJob)) {
2633 char token;
2634 (void) read(childExitJob.inPipe, &token, 1);
2635 nready -= 1;
2636 }
2637
2638 while (nready && (ln = Lst_Next(jobs)) != NILLNODE) {
2639 job = (Job *) Lst_Datum(ln);
2640 if (readyfd(job)) {
2641 JobDoOutput(job, FALSE);
2642 nready -= 1;
2643 }
2644 }
2645 Lst_Close(jobs);
2646 JobSigUnlock(&mask);
2647 }
2648 }
2649 #endif /* RMT_WILL_WATCH */
2650 }
2651
2652 /*-
2653 *-----------------------------------------------------------------------
2654 * Job_Make --
2655 * Start the creation of a target. Basically a front-end for
2656 * JobStart used by the Make module.
2657 *
2658 * Results:
2659 * None.
2660 *
2661 * Side Effects:
2662 * Another job is started.
2663 *
2664 *-----------------------------------------------------------------------
2665 */
2666 void
2667 Job_Make(GNode *gn)
2668 {
2669 (void) JobStart(gn, 0, NULL);
2670 }
2671
2672 void
2673 Shell_Init()
2674 {
2675 if (shellPath == NULL) {
2676 /*
2677 * The user didn't specify a shell to use, so we are using the
2678 * default one... Both the absolute path and the last component
2679 * must be set. The last component is taken from the 'name' field
2680 * of the default shell description pointed-to by commandShell.
2681 * All default shells are located in _PATH_DEFSHELLDIR.
2682 */
2683 shellName = commandShell->name;
2684 shellPath = str_concat(_PATH_DEFSHELLDIR, shellName, STR_ADDSLASH);
2685 }
2686 if (commandShell->exit == NULL) {
2687 commandShell->exit = "";
2688 }
2689 if (commandShell->echo == NULL) {
2690 commandShell->echo = "";
2691 }
2692 }
2693
2694 /*-
2695 *-----------------------------------------------------------------------
2696 * Job_Init --
2697 * Initialize the process module
2698 *
2699 * Input:
2700 * maxproc the greatest number of jobs which may be running
2701 * at one time
2702 * maxlocal the greatest number of jobs which may be running
2703 * at once
2704 *
2705 * Results:
2706 * none
2707 *
2708 * Side Effects:
2709 * lists and counters are initialized
2710 *-----------------------------------------------------------------------
2711 */
2712 void
2713 Job_Init(int maxproc, int maxlocal)
2714 {
2715 GNode *begin; /* node for commands to do at the very start */
2716
2717 jobs = Lst_Init(FALSE);
2718 stoppedJobs = Lst_Init(FALSE);
2719 maxJobs = maxproc;
2720 maxLocal = maxlocal;
2721 nJobs = 0;
2722 nLocal = 0;
2723 wantToken = FALSE;
2724
2725 aborting = 0;
2726 errors = 0;
2727
2728 lastNode = NILGNODE;
2729
2730 if (maxJobs == 1
2731 #ifdef REMOTE
2732 || noMessages
2733 #endif
2734 ) {
2735 /*
2736 * If only one job can run at a time, there's no need for a banner,
2737 * is there?
2738 */
2739 targFmt = "";
2740 } else {
2741 targFmt = TARG_FMT;
2742 }
2743
2744 Shell_Init();
2745
2746 if (pipe(exit_pipe) < 0)
2747 Fatal("error in pipe: %s", strerror(errno));
2748 fcntl(exit_pipe[0], F_SETFD, 1);
2749 fcntl(exit_pipe[1], F_SETFD, 1);
2750
2751 childExitJob.inPipe = exit_pipe[0];
2752
2753 sigemptyset(&caught_signals);
2754 /*
2755 * Install a SIGCHLD handler.
2756 */
2757 (void)signal(SIGCHLD, JobChildSig);
2758 sigaddset(&caught_signals, SIGCHLD);
2759
2760 #define ADDSIG(s,h) \
2761 if (signal(s, SIG_IGN) != SIG_IGN) { \
2762 sigaddset(&caught_signals, s); \
2763 (void) signal(s, h); \
2764 }
2765
2766 /*
2767 * Catch the four signals that POSIX specifies if they aren't ignored.
2768 * JobPassSig will take care of calling JobInterrupt if appropriate.
2769 */
2770 ADDSIG(SIGINT, JobPassSig)
2771 ADDSIG(SIGHUP, JobPassSig)
2772 ADDSIG(SIGTERM, JobPassSig)
2773 ADDSIG(SIGQUIT, JobPassSig)
2774
2775 /*
2776 * There are additional signals that need to be caught and passed if
2777 * either the export system wants to be told directly of signals or if
2778 * we're giving each job its own process group (since then it won't get
2779 * signals from the terminal driver as we own the terminal)
2780 */
2781 #if defined(RMT_WANTS_SIGNALS) || defined(USE_PGRP)
2782 ADDSIG(SIGTSTP, JobPassSig)
2783 ADDSIG(SIGTTOU, JobPassSig)
2784 ADDSIG(SIGTTIN, JobPassSig)
2785 ADDSIG(SIGWINCH, JobPassSig)
2786 ADDSIG(SIGCONT, JobContinueSig)
2787 #endif
2788 #undef ADDSIG
2789
2790 begin = Targ_FindNode(".BEGIN", TARG_NOCREATE);
2791
2792 if (begin != NILGNODE) {
2793 JobRun(begin);
2794 if (begin->made == ERROR) {
2795 PrintOnError("\n\nStop.");
2796 exit(1);
2797 }
2798 }
2799 postCommands = Targ_FindNode(".END", TARG_CREATE);
2800 }
2801
2802 static void JobSigReset(void)
2803 {
2804 #define DELSIG(s) \
2805 if (sigismember(&caught_signals, s)) { \
2806 (void) signal(SIGINT, SIG_DFL); \
2807 }
2808
2809 DELSIG(SIGINT)
2810 DELSIG(SIGHUP)
2811 DELSIG(SIGQUIT)
2812 DELSIG(SIGTERM)
2813 #if defined(RMT_WANTS_SIGNALS) || defined(USE_PGRP)
2814 DELSIG(SIGTSTP)
2815 DELSIG(SIGTTOU)
2816 DELSIG(SIGTTIN)
2817 DELSIG(SIGWINCH)
2818 DELSIG(SIGCONT)
2819 #endif
2820 #undef DELSIG
2821 (void)signal(SIGCHLD, SIG_DFL);
2822 }
2823
2824 /*-
2825 *-----------------------------------------------------------------------
2826 * Job_Empty --
2827 * See if the job table is empty. Because the local concurrency may
2828 * be set to 0, it is possible for the job table to become empty,
2829 * while the list of stoppedJobs remains non-empty. In such a case,
2830 * we want to restart as many jobs as we can.
2831 *
2832 * Results:
2833 * TRUE if it is. FALSE if it ain't.
2834 *
2835 * Side Effects:
2836 * None.
2837 *
2838 * -----------------------------------------------------------------------
2839 */
2840 Boolean
2841 Job_Empty(void)
2842 {
2843 if (nJobs == 0) {
2844 if (!Lst_IsEmpty(stoppedJobs) && !aborting) {
2845 /*
2846 * The job table is obviously not full if it has no jobs in
2847 * it...Try and restart the stopped jobs.
2848 */
2849 JobRestartJobs();
2850 return(FALSE);
2851 } else {
2852 return(TRUE);
2853 }
2854 } else {
2855 return(FALSE);
2856 }
2857 }
2858
2859 /*-
2860 *-----------------------------------------------------------------------
2861 * JobMatchShell --
2862 * Find a shell in 'shells' given its name.
2863 *
2864 * Results:
2865 * A pointer to the Shell structure.
2866 *
2867 * Side Effects:
2868 * None.
2869 *
2870 *-----------------------------------------------------------------------
2871 */
2872 static Shell *
2873 JobMatchShell(const char *name)
2874 {
2875 Shell *sh;
2876
2877 for (sh = shells; sh->name != NULL; sh++) {
2878 if (strcmp(name, sh->name) == 0)
2879 return (sh);
2880 }
2881 return (NULL);
2882 }
2883
2884 /*-
2885 *-----------------------------------------------------------------------
2886 * Job_ParseShell --
2887 * Parse a shell specification and set up commandShell, shellPath
2888 * and shellName appropriately.
2889 *
2890 * Input:
2891 * line The shell spec
2892 *
2893 * Results:
2894 * FAILURE if the specification was incorrect.
2895 *
2896 * Side Effects:
2897 * commandShell points to a Shell structure (either predefined or
2898 * created from the shell spec), shellPath is the full path of the
2899 * shell described by commandShell, while shellName is just the
2900 * final component of shellPath.
2901 *
2902 * Notes:
2903 * A shell specification consists of a .SHELL target, with dependency
2904 * operator, followed by a series of blank-separated words. Double
2905 * quotes can be used to use blanks in words. A backslash escapes
2906 * anything (most notably a double-quote and a space) and
2907 * provides the functionality it does in C. Each word consists of
2908 * keyword and value separated by an equal sign. There should be no
2909 * unnecessary spaces in the word. The keywords are as follows:
2910 * name Name of shell.
2911 * path Location of shell.
2912 * quiet Command to turn off echoing.
2913 * echo Command to turn echoing on
2914 * filter Result of turning off echoing that shouldn't be
2915 * printed.
2916 * echoFlag Flag to turn echoing on at the start
2917 * errFlag Flag to turn error checking on at the start
2918 * hasErrCtl True if shell has error checking control
2919 * check Command to turn on error checking if hasErrCtl
2920 * is TRUE or template of command to echo a command
2921 * for which error checking is off if hasErrCtl is
2922 * FALSE.
2923 * ignore Command to turn off error checking if hasErrCtl
2924 * is TRUE or template of command to execute a
2925 * command so as to ignore any errors it returns if
2926 * hasErrCtl is FALSE.
2927 *
2928 *-----------------------------------------------------------------------
2929 */
2930 ReturnStatus
2931 Job_ParseShell(char *line)
2932 {
2933 char **words;
2934 char **argv;
2935 int argc;
2936 char *path;
2937 Shell newShell;
2938 Boolean fullSpec = FALSE;
2939 Shell *sh;
2940
2941 while (isspace((unsigned char)*line)) {
2942 line++;
2943 }
2944
2945 if (shellArgv)
2946 free(UNCONST(shellArgv));
2947
2948 memset((Address)&newShell, 0, sizeof(newShell));
2949
2950 /*
2951 * Parse the specification by keyword
2952 */
2953 words = brk_string(line, &argc, TRUE, &path);
2954 shellArgv = path;
2955
2956 for (path = NULL, argv = words; argc != 0; argc--, argv++) {
2957 if (strncmp(*argv, "path=", 5) == 0) {
2958 path = &argv[0][5];
2959 } else if (strncmp(*argv, "name=", 5) == 0) {
2960 newShell.name = &argv[0][5];
2961 } else {
2962 if (strncmp(*argv, "quiet=", 6) == 0) {
2963 newShell.echoOff = &argv[0][6];
2964 } else if (strncmp(*argv, "echo=", 5) == 0) {
2965 newShell.echoOn = &argv[0][5];
2966 } else if (strncmp(*argv, "filter=", 7) == 0) {
2967 newShell.noPrint = &argv[0][7];
2968 newShell.noPLen = strlen(newShell.noPrint);
2969 } else if (strncmp(*argv, "echoFlag=", 9) == 0) {
2970 newShell.echo = &argv[0][9];
2971 } else if (strncmp(*argv, "errFlag=", 8) == 0) {
2972 newShell.exit = &argv[0][8];
2973 } else if (strncmp(*argv, "hasErrCtl=", 10) == 0) {
2974 char c = argv[0][10];
2975 newShell.hasErrCtl = !((c != 'Y') && (c != 'y') &&
2976 (c != 'T') && (c != 't'));
2977 } else if (strncmp(*argv, "check=", 6) == 0) {
2978 newShell.errCheck = &argv[0][6];
2979 } else if (strncmp(*argv, "ignore=", 7) == 0) {
2980 newShell.ignErr = &argv[0][7];
2981 } else if (strncmp(*argv, "errout=", 7) == 0) {
2982 newShell.errOut = &argv[0][7];
2983 } else if (strncmp(*argv, "comment=", 8) == 0) {
2984 newShell.commentChar = argv[0][8];
2985 } else {
2986 Parse_Error(PARSE_FATAL, "Unknown keyword \"%s\"",
2987 *argv);
2988 free(words);
2989 return(FAILURE);
2990 }
2991 fullSpec = TRUE;
2992 }
2993 }
2994
2995 if (path == NULL) {
2996 /*
2997 * If no path was given, the user wants one of the pre-defined shells,
2998 * yes? So we find the one s/he wants with the help of JobMatchShell
2999 * and set things up the right way. shellPath will be set up by
3000 * Job_Init.
3001 */
3002 if (newShell.name == NULL) {
3003 Parse_Error(PARSE_FATAL, "Neither path nor name specified");
3004 free(words);
3005 return(FAILURE);
3006 } else {
3007 if ((sh = JobMatchShell(newShell.name)) == NULL) {
3008 Parse_Error(PARSE_WARNING, "%s: No matching shell",
3009 newShell.name);
3010 free(words);
3011 return(FAILURE);
3012 }
3013 commandShell = sh;
3014 shellName = newShell.name;
3015 }
3016 } else {
3017 /*
3018 * The user provided a path. If s/he gave nothing else (fullSpec is
3019 * FALSE), try and find a matching shell in the ones we know of.
3020 * Else we just take the specification at its word and copy it
3021 * to a new location. In either case, we need to record the
3022 * path the user gave for the shell.
3023 */
3024 shellPath = path;
3025 path = strrchr(path, '/');
3026 if (path == NULL) {
3027 path = UNCONST(shellPath);
3028 } else {
3029 path += 1;
3030 }
3031 if (newShell.name != NULL) {
3032 shellName = newShell.name;
3033 } else {
3034 shellName = path;
3035 }
3036 if (!fullSpec) {
3037 if ((sh = JobMatchShell(shellName)) == NULL) {
3038 Parse_Error(PARSE_WARNING, "%s: No matching shell",
3039 shellName);
3040 free(words);
3041 return(FAILURE);
3042 }
3043 commandShell = sh;
3044 } else {
3045 commandShell = emalloc(sizeof(Shell));
3046 *commandShell = newShell;
3047 }
3048 }
3049
3050 if (commandShell->echoOn && commandShell->echoOff) {
3051 commandShell->hasEchoCtl = TRUE;
3052 }
3053
3054 if (!commandShell->hasErrCtl) {
3055 if (commandShell->errCheck == NULL) {
3056 commandShell->errCheck = "";
3057 }
3058 if (commandShell->ignErr == NULL) {
3059 commandShell->ignErr = "%s\n";
3060 }
3061 }
3062
3063 /*
3064 * Do not free up the words themselves, since they might be in use by the
3065 * shell specification.
3066 */
3067 free(words);
3068 return SUCCESS;
3069 }
3070
3071 /*-
3072 *-----------------------------------------------------------------------
3073 * JobInterrupt --
3074 * Handle the receipt of an interrupt.
3075 *
3076 * Input:
3077 * runINTERRUPT Non-zero if commands for the .INTERRUPT target
3078 * should be executed
3079 * signo signal received
3080 *
3081 * Results:
3082 * None
3083 *
3084 * Side Effects:
3085 * All children are killed. Another job will be started if the
3086 * .INTERRUPT target was given.
3087 *-----------------------------------------------------------------------
3088 */
3089 static void
3090 JobInterrupt(int runINTERRUPT, int signo)
3091 {
3092 LstNode ln; /* element in job table */
3093 Job *job; /* job descriptor in that element */
3094 GNode *interrupt; /* the node describing the .INTERRUPT target */
3095 sigset_t mask;
3096
3097 aborting = ABORT_INTERRUPT;
3098
3099 JobSigLock(&mask);
3100
3101 (void) Lst_Open(jobs);
3102 while ((ln = Lst_Next(jobs)) != NILLNODE) {
3103 GNode *gn;
3104
3105 job = (Job *) Lst_Datum(ln);
3106 gn = job->node;
3107
3108 if ((gn->type & (OP_JOIN|OP_PHONY)) == 0 && !Targ_Precious(gn)) {
3109 char *file = (gn->path == NULL ? gn->name : gn->path);
3110 if (!noExecute && eunlink(file) != -1) {
3111 Error("*** %s removed", file);
3112 }
3113 }
3114 #ifdef RMT_WANTS_SIGNALS
3115 if (job->flags & JOB_REMOTE) {
3116 /*
3117 * If job is remote, let the Rmt module do the killing.
3118 */
3119 if (!Rmt_Signal(job, signo)) {
3120 /*
3121 * If couldn't kill the thing, finish it out now with an
3122 * error code, since no exit report will come in likely.
3123 */
3124 int status;
3125
3126 status.w_status = 0;
3127 status.w_retcode = 1;
3128 JobFinish(job, &status);
3129 }
3130 } else if (job->pid) {
3131 KILL(job->pid, signo);
3132 }
3133 #else
3134 if (job->pid) {
3135 if (DEBUG(JOB)) {
3136 (void) fprintf(stdout,
3137 "JobInterrupt passing signal %d to child %d.\n",
3138 signo, job->pid);
3139 (void) fflush(stdout);
3140 }
3141 KILL(job->pid, signo);
3142 }
3143 #endif /* RMT_WANTS_SIGNALS */
3144 }
3145 Lst_Close(jobs);
3146
3147 #ifdef REMOTE
3148 (void)Lst_Open(stoppedJobs);
3149 while ((ln = Lst_Next(stoppedJobs)) != NILLNODE) {
3150 GNode *gn;
3151
3152 job = (Job *) Lst_Datum(ln);
3153 gn = job->node;
3154
3155 if (job->flags & JOB_RESTART) {
3156 if (DEBUG(JOB)) {
3157 (void) fprintf(stdout, "%s%s",
3158 "JobInterrupt skipping job on stopped queue",
3159 "-- it was waiting to be restarted.\n");
3160 (void) fflush(stdout);
3161 }
3162 continue;
3163 }
3164 if ((gn->type & (OP_JOIN|OP_PHONY)) == 0 && !Targ_Precious(gn)) {
3165 char *file = (gn->path == NULL ? gn->name : gn->path);
3166 if (eunlink(file) == 0) {
3167 Error("*** %s removed", file);
3168 }
3169 }
3170 /*
3171 * Resume the thing so it will take the signal.
3172 */
3173 if (DEBUG(JOB)) {
3174 (void) fprintf(stdout,
3175 "JobInterrupt passing CONT to stopped child %d.\n",
3176 job->pid);
3177 (void) fflush(stdout);
3178 }
3179 KILL(job->pid, SIGCONT);
3180 #ifdef RMT_WANTS_SIGNALS
3181 if (job->flags & JOB_REMOTE) {
3182 /*
3183 * If job is remote, let the Rmt module do the killing.
3184 */
3185 if (!Rmt_Signal(job, SIGINT)) {
3186 /*
3187 * If couldn't kill the thing, finish it out now with an
3188 * error code, since no exit report will come in likely.
3189 */
3190 int status;
3191 status.w_status = 0;
3192 status.w_retcode = 1;
3193 JobFinish(job, &status);
3194 }
3195 } else if (job->pid) {
3196 if (DEBUG(JOB)) {
3197 (void) fprintf(stdout,
3198 "JobInterrupt passing interrupt to stopped child %d.\n",
3199 job->pid);
3200 (void) fflush(stdout);
3201 }
3202 KILL(job->pid, SIGINT);
3203 }
3204 #endif /* RMT_WANTS_SIGNALS */
3205 }
3206 Lst_Close(stoppedJobs);
3207 #endif /* REMOTE */
3208
3209 JobSigUnlock(&mask);
3210
3211 if (runINTERRUPT && !touchFlag) {
3212 interrupt = Targ_FindNode(".INTERRUPT", TARG_NOCREATE);
3213 if (interrupt != NILGNODE) {
3214 ignoreErrors = FALSE;
3215 JobRun(interrupt);
3216 }
3217 }
3218 Trace_Log(MAKEINTR, 0);
3219 exit(signo);
3220 }
3221
3222 /*
3223 *-----------------------------------------------------------------------
3224 * Job_Finish --
3225 * Do final processing such as the running of the commands
3226 * attached to the .END target.
3227 *
3228 * Results:
3229 * Number of errors reported.
3230 *
3231 * Side Effects:
3232 * None.
3233 *-----------------------------------------------------------------------
3234 */
3235 int
3236 Job_Finish(void)
3237 {
3238 if (postCommands != NILGNODE && !Lst_IsEmpty(postCommands->commands)) {
3239 if (errors) {
3240 Error("Errors reported so .END ignored");
3241 } else {
3242 JobRun(postCommands);
3243 }
3244 }
3245 Job_TokenFlush();
3246 return(errors);
3247 }
3248
3249 /*-
3250 *-----------------------------------------------------------------------
3251 * Job_End --
3252 * Cleanup any memory used by the jobs module
3253 *
3254 * Results:
3255 * None.
3256 *
3257 * Side Effects:
3258 * Memory is freed
3259 *-----------------------------------------------------------------------
3260 */
3261 void
3262 Job_End(void)
3263 {
3264 #ifdef CLEANUP
3265 if (shellArgv)
3266 free(shellArgv);
3267 #endif
3268 }
3269
3270 /*-
3271 *-----------------------------------------------------------------------
3272 * Job_Wait --
3273 * Waits for all running jobs to finish and returns. Sets 'aborting'
3274 * to ABORT_WAIT to prevent other jobs from starting.
3275 *
3276 * Results:
3277 * None.
3278 *
3279 * Side Effects:
3280 * Currently running jobs finish.
3281 *
3282 *-----------------------------------------------------------------------
3283 */
3284 void
3285 Job_Wait(void)
3286 {
3287 aborting = ABORT_WAIT;
3288 while (nJobs != 0) {
3289 Job_CatchOutput();
3290 #ifndef RMT_WILL_WATCH
3291 Job_CatchChildren(!usePipes);
3292 #endif /* RMT_WILL_WATCH */
3293 }
3294 Job_TokenFlush();
3295 aborting = 0;
3296 }
3297
3298 /*-
3299 *-----------------------------------------------------------------------
3300 * Job_AbortAll --
3301 * Abort all currently running jobs without handling output or anything.
3302 * This function is to be called only in the event of a major
3303 * error. Most definitely NOT to be called from JobInterrupt.
3304 *
3305 * Results:
3306 * None
3307 *
3308 * Side Effects:
3309 * All children are killed, not just the firstborn
3310 *-----------------------------------------------------------------------
3311 */
3312 void
3313 Job_AbortAll(void)
3314 {
3315 LstNode ln; /* element in job table */
3316 Job *job; /* the job descriptor in that element */
3317 int foo;
3318 sigset_t mask;
3319
3320 aborting = ABORT_ERROR;
3321
3322 if (nJobs) {
3323
3324 JobSigLock(&mask);
3325 (void) Lst_Open(jobs);
3326 while ((ln = Lst_Next(jobs)) != NILLNODE) {
3327 job = (Job *) Lst_Datum(ln);
3328
3329 /*
3330 * kill the child process with increasingly drastic signals to make
3331 * darn sure it's dead.
3332 */
3333 #ifdef RMT_WANTS_SIGNALS
3334 if (job->flags & JOB_REMOTE) {
3335 Rmt_Signal(job, SIGINT);
3336 Rmt_Signal(job, SIGKILL);
3337 } else {
3338 KILL(job->pid, SIGINT);
3339 KILL(job->pid, SIGKILL);
3340 }
3341 #else
3342 KILL(job->pid, SIGINT);
3343 KILL(job->pid, SIGKILL);
3344 #endif /* RMT_WANTS_SIGNALS */
3345 }
3346 Lst_Close(jobs);
3347 JobSigUnlock(&mask);
3348 }
3349
3350 /*
3351 * Catch as many children as want to report in at first, then give up
3352 */
3353 while (waitpid((pid_t) -1, &foo, WNOHANG) > 0)
3354 continue;
3355 }
3356
3357 #ifdef REMOTE
3358 /*-
3359 *-----------------------------------------------------------------------
3360 * JobFlagForMigration --
3361 * Handle the eviction of a child. Called from RmtStatusChange.
3362 * Flags the child as remigratable and then suspends it.
3363 *
3364 * Input:
3365 * hostID ID of host we used, for matching children
3366 *
3367 * Results:
3368 * none.
3369 *
3370 * Side Effects:
3371 * The job descriptor is flagged for remigration.
3372 *
3373 *-----------------------------------------------------------------------
3374 */
3375 void
3376 JobFlagForMigration(int hostID)
3377 {
3378 Job *job; /* job descriptor for dead child */
3379 LstNode jnode; /* list element for finding job */
3380
3381 if (DEBUG(JOB)) {
3382 (void) fprintf(stdout, "JobFlagForMigration(%d) called.\n", hostID);
3383 (void) fflush(stdout);
3384 }
3385 jnode = Lst_Find(jobs, (ClientData)&hostID, JobCmpRmtID);
3386
3387 if (jnode == NILLNODE) {
3388 jnode = Lst_Find(stoppedJobs, (ClientData)hostID, JobCmpRmtID);
3389 if (jnode == NILLNODE) {
3390 if (DEBUG(JOB)) {
3391 Error("Evicting host(%d) not in table", hostID);
3392 }
3393 return;
3394 }
3395 }
3396 job = (Job *) Lst_Datum(jnode);
3397
3398 if (DEBUG(JOB)) {
3399 (void) fprintf(stdout,
3400 "JobFlagForMigration(%d) found job '%s'.\n", hostID,
3401 job->node->name);
3402 (void) fflush(stdout);
3403 }
3404
3405 KILL(job->pid, SIGSTOP);
3406
3407 job->flags |= JOB_REMIGRATE;
3408 }
3409
3410 #endif
3411
3412 /*-
3414 *-----------------------------------------------------------------------
3415 * JobRestartJobs --
3416 * Tries to restart stopped jobs if there are slots available.
3417 * Note that this tries to restart them regardless of pending errors.
3418 * It's not good to leave stopped jobs lying around!
3419 *
3420 * Results:
3421 * None.
3422 *
3423 * Side Effects:
3424 * Resumes(and possibly migrates) jobs.
3425 *
3426 *-----------------------------------------------------------------------
3427 */
3428 static void
3429 JobRestartJobs(void)
3430 {
3431 sigset_t mask;
3432
3433 JobSigLock(&mask);
3434 while (!Lst_IsEmpty(stoppedJobs)) {
3435 if (DEBUG(JOB)) {
3436 (void) fprintf(stdout, "Restarting a stopped job.\n");
3437 (void) fflush(stdout);
3438 }
3439 if (JobRestart((Job *)Lst_DeQueue(stoppedJobs)) != 0)
3440 break;
3441 }
3442 JobSigUnlock(&mask);
3443 }
3444
3445 #ifndef RMT_WILL_WATCH
3446 static void
3447 watchfd(Job *job)
3448 {
3449 int i;
3450 if (job->inPollfd != NULL)
3451 Punt("Watching watched job");
3452 if (fds == NULL) {
3453 maxfds = JBSTART;
3454 fds = emalloc(sizeof(struct pollfd) * maxfds);
3455 jobfds = emalloc(sizeof(Job **) * maxfds);
3456
3457 fds[0].fd = job_pipe[0];
3458 fds[0].events = POLLIN;
3459 jobfds[0] = &tokenWaitJob;
3460 tokenWaitJob.inPollfd = &fds[0];
3461 nfds++;
3462
3463 fds[1].fd = exit_pipe[0];
3464 fds[1].events = POLLIN;
3465 jobfds[1] = &childExitJob;
3466 childExitJob.inPollfd = &fds[1];
3467 nfds++;
3468 } else if (nfds == maxfds) {
3469 maxfds *= JBFACTOR;
3470 fds = erealloc(fds, sizeof(struct pollfd) * maxfds);
3471 jobfds = erealloc(jobfds, sizeof(Job **) * maxfds);
3472 for (i = 0; i < nfds; i++)
3473 jobfds[i]->inPollfd = &fds[i];
3474 }
3475
3476 fds[nfds].fd = job->inPipe;
3477 fds[nfds].events = POLLIN;
3478 jobfds[nfds] = job;
3479 job->inPollfd = &fds[nfds];
3480 nfds++;
3481 }
3482
3483 static void
3484 clearfd(Job *job)
3485 {
3486 int i;
3487 if (job->inPollfd == NULL)
3488 Punt("Unwatching unwatched job");
3489 i = job->inPollfd - fds;
3490 nfds--;
3491 /*
3492 * Move last job in table into hole made by dead job.
3493 */
3494 if (nfds != i) {
3495 fds[i] = fds[nfds];
3496 jobfds[i] = jobfds[nfds];
3497 jobfds[i]->inPollfd = &fds[i];
3498 }
3499 job->inPollfd = NULL;
3500 }
3501
3502 static int
3503 readyfd(Job *job)
3504 {
3505 if (job->inPollfd == NULL)
3506 Punt("Polling unwatched job");
3507 return (job->inPollfd->revents & POLLIN) != 0;
3508 }
3509 #endif
3510
3511 /*-
3512 *-----------------------------------------------------------------------
3513 * JobTokenAdd --
3514 * Put a token into the job pipe so that some make process can start
3515 * another job.
3516 *
3517 * Side Effects:
3518 * Allows more build jobs to be spawned somewhere.
3519 *
3520 *-----------------------------------------------------------------------
3521 */
3522
3523 static void
3524 JobTokenAdd(void)
3525 {
3526
3527 if (DEBUG(JOB))
3528 printf("deposit token\n");
3529 write(job_pipe[1], "+", 1);
3530 }
3531
3532 /*-
3533 *-----------------------------------------------------------------------
3534 * Job_ServerStartTokenAdd --
3535 * Prep the job token pipe in the root make process.
3536 *
3537 *-----------------------------------------------------------------------
3538 */
3539
3540 void
3541 Job_ServerStart(int maxproc)
3542 {
3543 int i, flags;
3544 char jobarg[64];
3545
3546 if (pipe(job_pipe) < 0)
3547 Fatal("error in pipe: %s", strerror(errno));
3548
3549 /*
3550 * We mark the input side of the pipe non-blocking; we poll(2) the
3551 * pipe when we're waiting for a job token, but we might lose the
3552 * race for the token when a new one becomes available, so the read
3553 * from the pipe should not block.
3554 */
3555 flags = fcntl(job_pipe[0], F_GETFL, 0);
3556 flags |= O_NONBLOCK;
3557 fcntl(job_pipe[0], F_SETFL, flags);
3558
3559 /*
3560 * Mark job pipes as close-on-exec.
3561 * Note that we will clear this when executing submakes.
3562 */
3563 fcntl(job_pipe[0], F_SETFD, 1);
3564 fcntl(job_pipe[1], F_SETFD, 1);
3565
3566 snprintf(jobarg, sizeof(jobarg), "%d,%d", job_pipe[0], job_pipe[1]);
3567
3568 Var_Append(MAKEFLAGS, "-J", VAR_GLOBAL);
3569 Var_Append(MAKEFLAGS, jobarg, VAR_GLOBAL);
3570
3571 /*
3572 * Preload job_pipe with one token per job, save the one
3573 * "extra" token for the primary job.
3574 *
3575 * XXX should clip maxJobs against PIPE_BUF -- if maxJobs is
3576 * larger than the write buffer size of the pipe, we will
3577 * deadlock here.
3578 */
3579 for (i=1; i < maxproc; i++)
3580 JobTokenAdd();
3581 }
3582
3583 /*
3584 * this tracks the number of tokens currently "out" to build jobs.
3585 */
3586 int jobTokensRunning = 0;
3587 int jobTokensFree = 0;
3588 /*-
3589 *-----------------------------------------------------------------------
3590 * Job_TokenReturn --
3591 * Return a withdrawn token to the pool.
3592 *
3593 *-----------------------------------------------------------------------
3594 */
3595
3596 void
3597 Job_TokenReturn(void)
3598 {
3599 jobTokensRunning--;
3600 if (jobTokensRunning < 0)
3601 Punt("token botch");
3602 if (jobTokensRunning)
3603 jobTokensFree++;
3604 }
3605
3606 /*-
3607 *-----------------------------------------------------------------------
3608 * Job_TokenWithdraw --
3609 * Attempt to withdraw a token from the pool.
3610 *
3611 * Results:
3612 * Returns TRUE if a token was withdrawn, and FALSE if the pool
3613 * is currently empty.
3614 *
3615 * Side Effects:
3616 * If pool is empty, set wantToken so that we wake up
3617 * when a token is released.
3618 *
3619 *-----------------------------------------------------------------------
3620 */
3621
3622
3623 Boolean
3624 Job_TokenWithdraw(void)
3625 {
3626 char tok;
3627 int count;
3628
3629 wantToken = FALSE;
3630
3631 if (aborting)
3632 return FALSE;
3633
3634 if (jobTokensRunning == 0) {
3635 if (DEBUG(JOB))
3636 printf("first one's free\n");
3637 jobTokensRunning++;
3638 return TRUE;
3639 }
3640 if (jobTokensFree > 0) {
3641 jobTokensFree--;
3642 jobTokensRunning++;
3643 return TRUE;
3644 }
3645 count = read(job_pipe[0], &tok, 1);
3646 if (count == 0)
3647 Fatal("eof on job pipe!");
3648 else if (count < 0) {
3649 if (errno != EAGAIN) {
3650 Fatal("job pipe read: %s", strerror(errno));
3651 }
3652 if (DEBUG(JOB))
3653 printf("blocked for token\n");
3654 wantToken = TRUE;
3655 return FALSE;
3656 }
3657 jobTokensRunning++;
3658 if (DEBUG(JOB))
3659 printf("withdrew token\n");
3660 return TRUE;
3661 }
3662
3663 /*-
3664 *-----------------------------------------------------------------------
3665 * Job_TokenFlush --
3666 * Return free tokens to the pool.
3667 *
3668 *-----------------------------------------------------------------------
3669 */
3670
3671 void
3672 Job_TokenFlush(void)
3673 {
3674 if (compatMake) return;
3675
3676 while (jobTokensFree > 0) {
3677 JobTokenAdd();
3678 jobTokensFree--;
3679 }
3680 }
3681
3682 #ifdef USE_SELECT
3683 int
3684 emul_poll(struct pollfd *fd, int nfd, int timeout)
3685 {
3686 fd_set rfds, wfds;
3687 int i, maxfd, nselect, npoll;
3688 struct timeval tv, *tvp;
3689 long usecs;
3690
3691 FD_ZERO(&rfds);
3692 FD_ZERO(&wfds);
3693
3694 maxfd = -1;
3695 for (i = 0; i < nfd; i++) {
3696 fd[i].revents = 0;
3697
3698 if (fd[i].events & POLLIN)
3699 FD_SET(fd[i].fd, &rfds);
3700
3701 if (fd[i].events & POLLOUT)
3702 FD_SET(fd[i].fd, &wfds);
3703
3704 if (fd[i].fd > maxfd)
3705 maxfd = fd[i].fd;
3706 }
3707
3708 if (maxfd >= FD_SETSIZE) {
3709 Punt("Ran out of fd_set slots; "
3710 "recompile with a larger FD_SETSIZE.");
3711 }
3712
3713 if (timeout < 0) {
3714 tvp = NULL;
3715 } else {
3716 usecs = timeout * 1000;
3717 tv.tv_sec = usecs / 1000000;
3718 tv.tv_usec = usecs % 1000000;
3719 tvp = &tv;
3720 }
3721
3722 nselect = select(maxfd + 1, &rfds, &wfds, 0, tvp);
3723
3724 if (nselect <= 0)
3725 return nselect;
3726
3727 npoll = 0;
3728 for (i = 0; i < nfd; i++) {
3729 if (FD_ISSET(fd[i].fd, &rfds))
3730 fd[i].revents |= POLLIN;
3731
3732 if (FD_ISSET(fd[i].fd, &wfds))
3733 fd[i].revents |= POLLOUT;
3734
3735 if (fd[i].revents)
3736 npoll++;
3737 }
3738
3739 return npoll;
3740 }
3741 #endif /* USE_SELECT */
3742