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