job.c revision 1.48 1 /* $NetBSD: job.c,v 1.48 2001/05/29 17:37:52 christos 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.48 2001/05/29 17:37:52 christos 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.48 2001/05/29 17:37:52 christos 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 void 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 LstNode cmdNode; /* Node for replacing the command */
600 char *cmd = (char *) cmdp;
601 Job *job = (Job *) jobp;
602 char *cp;
603
604 noSpecials = NoExecute(job->node);
605
606 if (strcmp(cmd, "...") == 0) {
607 job->node->type |= OP_SAVE_CMDS;
608 if ((job->flags & JOB_IGNDOTS) == 0) {
609 job->tailCmds = Lst_Succ(Lst_Member(job->node->commands,
610 (ClientData)cmd));
611 return 1;
612 }
613 return 0;
614 }
615
616 #define DBPRINTF(fmt, arg) if (DEBUG(JOB)) { \
617 (void) fprintf(stdout, fmt, arg); \
618 (void) fflush(stdout); \
619 } \
620 (void) fprintf(job->cmdFILE, fmt, arg); \
621 (void) fflush(job->cmdFILE);
622
623 numCommands += 1;
624
625 /*
626 * For debugging, we replace each command with the result of expanding
627 * the variables in the command.
628 */
629 cmdNode = Lst_Member(job->node->commands, (ClientData)cmd);
630 cmdStart = cmd = Var_Subst(NULL, cmd, job->node, FALSE);
631 Lst_Replace(cmdNode, (ClientData)cmdStart);
632
633 cmdTemplate = "%s\n";
634
635 /*
636 * Check for leading @' and -'s to control echoing and error checking.
637 */
638 while (*cmd == '@' || *cmd == '-') {
639 if (*cmd == '@') {
640 shutUp = TRUE;
641 } else {
642 errOff = TRUE;
643 }
644 cmd++;
645 }
646
647 while (isspace((unsigned char) *cmd))
648 cmd++;
649
650 if (shutUp) {
651 if (!(job->flags & JOB_SILENT) && !noSpecials &&
652 commandShell->hasEchoCtl) {
653 DBPRINTF("%s\n", commandShell->echoOff);
654 } else {
655 shutUp = FALSE;
656 }
657 }
658
659 if (errOff) {
660 if ( !(job->flags & JOB_IGNERR) && !noSpecials) {
661 if (commandShell->hasErrCtl) {
662 /*
663 * we don't want the error-control commands showing
664 * up either, so we turn off echoing while executing
665 * them. We could put another field in the shell
666 * structure to tell JobDoOutput to look for this
667 * string too, but why make it any more complex than
668 * it already is?
669 */
670 if (!(job->flags & JOB_SILENT) && !shutUp &&
671 commandShell->hasEchoCtl) {
672 DBPRINTF("%s\n", commandShell->echoOff);
673 DBPRINTF("%s\n", commandShell->ignErr);
674 DBPRINTF("%s\n", commandShell->echoOn);
675 } else {
676 DBPRINTF("%s\n", commandShell->ignErr);
677 }
678 } else if (commandShell->ignErr &&
679 (*commandShell->ignErr != '\0'))
680 {
681 /*
682 * The shell has no error control, so we need to be
683 * weird to get it to ignore any errors from the command.
684 * If echoing is turned on, we turn it off and use the
685 * errCheck template to echo the command. Leave echoing
686 * off so the user doesn't see the weirdness we go through
687 * to ignore errors. Set cmdTemplate to use the weirdness
688 * instead of the simple "%s\n" template.
689 */
690 if (!(job->flags & JOB_SILENT) && !shutUp &&
691 commandShell->hasEchoCtl) {
692 DBPRINTF("%s\n", commandShell->echoOff);
693 DBPRINTF(commandShell->errCheck, cmd);
694 shutUp = TRUE;
695 }
696 cmdTemplate = commandShell->ignErr;
697 /*
698 * The error ignoration (hee hee) is already taken care
699 * of by the ignErr template, so pretend error checking
700 * is still on.
701 */
702 errOff = FALSE;
703 } else {
704 errOff = FALSE;
705 }
706 } else {
707 errOff = FALSE;
708 }
709 }
710
711 if ((cp = Check_Cwd_Cmd(cmd)) != NULL) {
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 exited.\n", job->pid);
903 (void) fflush(stdout);
904 }
905 if (WEXITSTATUS(*status) != 0) {
906 if (usePipes && job->node != lastNode) {
907 MESSAGE(out, job->node);
908 lastNode = job->node;
909 }
910 (void) fprintf(out, "*** Error code %d%s\n",
911 WEXITSTATUS(*status),
912 (job->flags & JOB_IGNERR) ? "(ignored)" : "");
913
914 if (job->flags & JOB_IGNERR) {
915 *status = 0;
916 }
917 } else if (DEBUG(JOB)) {
918 if (usePipes && job->node != lastNode) {
919 MESSAGE(out, job->node);
920 lastNode = job->node;
921 }
922 (void) fprintf(out, "*** Completed successfully\n");
923 }
924 } else if (WIFSTOPPED(*status) && WSTOPSIG(*status) != SIGCONT) {
925 if (DEBUG(JOB)) {
926 (void) fprintf(stdout, "Process %d stopped.\n", job->pid);
927 (void) fflush(stdout);
928 }
929 if (usePipes && job->node != lastNode) {
930 MESSAGE(out, job->node);
931 lastNode = job->node;
932 }
933 if (!(job->flags & JOB_REMIGRATE)) {
934 switch (WSTOPSIG(*status)) {
935 case SIGTSTP:
936 (void) fprintf(out, "*** Suspended\n");
937 break;
938 case SIGSTOP:
939 (void) fprintf(out, "*** Stopped\n");
940 break;
941 default:
942 (void) fprintf(out, "*** Stopped -- signal %d\n",
943 WSTOPSIG(*status));
944 }
945 }
946 job->flags |= JOB_RESUME;
947 (void)Lst_AtEnd(stoppedJobs, (ClientData)job);
948 #ifdef REMOTE
949 if (job->flags & JOB_REMIGRATE)
950 JobRestart(job);
951 #endif
952 (void) fflush(out);
953 return;
954 } else if (WIFSTOPPED(*status) && WSTOPSIG(*status) == SIGCONT) {
955 /*
956 * If the beastie has continued, shift the Job from the stopped
957 * list to the running one (or re-stop it if concurrency is
958 * exceeded) and go and get another child.
959 */
960 if (job->flags & (JOB_RESUME|JOB_REMIGRATE|JOB_RESTART)) {
961 if (usePipes && job->node != lastNode) {
962 MESSAGE(out, job->node);
963 lastNode = job->node;
964 }
965 (void) fprintf(out, "*** Continued\n");
966 }
967 if (!(job->flags & JOB_CONTINUING)) {
968 if (DEBUG(JOB)) {
969 (void) fprintf(stdout,
970 "Warning: process %d was not continuing.\n",
971 job->pid);
972 (void) fflush(stdout);
973 }
974 #ifdef notdef
975 /*
976 * We don't really want to restart a job from scratch just
977 * because it continued, especially not without killing the
978 * continuing process! That's why this is ifdef'ed out.
979 * FD - 9/17/90
980 */
981 JobRestart(job);
982 #endif
983 }
984 job->flags &= ~JOB_CONTINUING;
985 Lst_AtEnd(jobs, (ClientData)job);
986 nJobs += 1;
987 if (!(job->flags & JOB_REMOTE)) {
988 if (DEBUG(JOB)) {
989 (void) fprintf(stdout,
990 "Process %d is continuing locally.\n",
991 job->pid);
992 (void) fflush(stdout);
993 }
994 nLocal += 1;
995 }
996 (void) fflush(out);
997 return;
998 } else {
999 if (usePipes && job->node != lastNode) {
1000 MESSAGE(out, job->node);
1001 lastNode = job->node;
1002 }
1003 (void) fprintf(out, "*** Signal %d\n", WTERMSIG(*status));
1004 }
1005
1006 (void) fflush(out);
1007 }
1008
1009 /*
1010 * Now handle the -B-mode stuff. If the beast still isn't finished,
1011 * try and restart the job on the next command. If JobStart says it's
1012 * ok, it's ok. If there's an error, this puppy is done.
1013 */
1014 if (compatMake && (WIFEXITED(*status) &&
1015 !Lst_IsAtEnd(job->node->commands))) {
1016 switch (JobStart(job->node, job->flags & JOB_IGNDOTS, job)) {
1017 case JOB_RUNNING:
1018 done = FALSE;
1019 break;
1020 case JOB_ERROR:
1021 done = TRUE;
1022 *status = W_EXITCODE(1, 0);
1023 break;
1024 case JOB_FINISHED:
1025 /*
1026 * If we got back a JOB_FINISHED code, JobStart has already
1027 * called Make_Update and freed the job descriptor. We set
1028 * done to false here to avoid fake cycles and double frees.
1029 * JobStart needs to do the update so we can proceed up the
1030 * graph when given the -n flag..
1031 */
1032 done = FALSE;
1033 break;
1034 }
1035 } else {
1036 done = TRUE;
1037 }
1038
1039 if (done) {
1040 Trace_Log(JOBEND, job);
1041 if (!compatMake && !(job->flags & JOB_SPECIAL)) {
1042 if ((*status != 0) ||
1043 (aborting == ABORT_ERROR) ||
1044 (aborting == ABORT_INTERRUPT))
1045 Job_TokenReturn();
1046 }
1047
1048 }
1049
1050 if (done &&
1051 (aborting != ABORT_ERROR) &&
1052 (aborting != ABORT_INTERRUPT) &&
1053 (*status == 0))
1054 {
1055 /*
1056 * As long as we aren't aborting and the job didn't return a non-zero
1057 * status that we shouldn't ignore, we call Make_Update to update
1058 * the parents. In addition, any saved commands for the node are placed
1059 * on the .END target.
1060 */
1061 if (job->tailCmds != NILLNODE) {
1062 Lst_ForEachFrom(job->node->commands, job->tailCmds,
1063 JobSaveCommand,
1064 (ClientData)job->node);
1065 }
1066 job->node->made = MADE;
1067 if (!(job->flags & JOB_SPECIAL))
1068 Job_TokenReturn();
1069 Make_Update(job->node);
1070 free((Address)job);
1071 } else if (*status != 0) {
1072 errors += 1;
1073 free((Address)job);
1074 }
1075 JobRestartJobs();
1076
1077 /*
1078 * Set aborting if any error.
1079 */
1080 if (errors && !keepgoing && (aborting != ABORT_INTERRUPT)) {
1081 /*
1082 * If we found any errors in this batch of children and the -k flag
1083 * wasn't given, we set the aborting flag so no more jobs get
1084 * started.
1085 */
1086 aborting = ABORT_ERROR;
1087 }
1088
1089 if ((aborting == ABORT_ERROR) && Job_Empty()) {
1090 /*
1091 * If we are aborting and the job table is now empty, we finish.
1092 */
1093 Finish(errors);
1094 }
1095 }
1096
1097 /*-
1098 *-----------------------------------------------------------------------
1099 * Job_Touch --
1100 * Touch the given target. Called by JobStart when the -t flag was
1101 * given
1102 *
1103 * Results:
1104 * None
1105 *
1106 * Side Effects:
1107 * The data modification of the file is changed. In addition, if the
1108 * file did not exist, it is created.
1109 *-----------------------------------------------------------------------
1110 */
1111 void
1112 Job_Touch(gn, silent)
1113 GNode *gn; /* the node of the file to touch */
1114 Boolean silent; /* TRUE if should not print messages */
1115 {
1116 int streamID; /* ID of stream opened to do the touch */
1117 struct utimbuf times; /* Times for utime() call */
1118
1119 if (gn->type & (OP_JOIN|OP_USE|OP_EXEC|OP_OPTIONAL|OP_PHONY)) {
1120 /*
1121 * .JOIN, .USE, .ZEROTIME and .OPTIONAL targets are "virtual" targets
1122 * and, as such, shouldn't really be created.
1123 */
1124 return;
1125 }
1126
1127 if (!silent || NoExecute(gn)) {
1128 (void) fprintf(stdout, "touch %s\n", gn->name);
1129 (void) fflush(stdout);
1130 }
1131
1132 if (NoExecute(gn)) {
1133 return;
1134 }
1135
1136 if (gn->type & OP_ARCHV) {
1137 Arch_Touch(gn);
1138 } else if (gn->type & OP_LIB) {
1139 Arch_TouchLib(gn);
1140 } else {
1141 char *file = gn->path ? gn->path : gn->name;
1142
1143 times.actime = times.modtime = now;
1144 if (utime(file, ×) < 0){
1145 streamID = open(file, O_RDWR | O_CREAT, 0666);
1146
1147 if (streamID >= 0) {
1148 char c;
1149
1150 /*
1151 * Read and write a byte to the file to change the
1152 * modification time, then close the file.
1153 */
1154 if (read(streamID, &c, 1) == 1) {
1155 (void) lseek(streamID, (off_t)0, SEEK_SET);
1156 (void) write(streamID, &c, 1);
1157 }
1158
1159 (void) close(streamID);
1160 } else {
1161 (void) fprintf(stdout, "*** couldn't touch %s: %s",
1162 file, strerror(errno));
1163 (void) fflush(stdout);
1164 }
1165 }
1166 }
1167 }
1168
1169 /*-
1170 *-----------------------------------------------------------------------
1171 * Job_CheckCommands --
1172 * Make sure the given node has all the commands it needs.
1173 *
1174 * Results:
1175 * TRUE if the commands list is/was ok.
1176 *
1177 * Side Effects:
1178 * The node will have commands from the .DEFAULT rule added to it
1179 * if it needs them.
1180 *-----------------------------------------------------------------------
1181 */
1182 Boolean
1183 Job_CheckCommands(gn, abortProc)
1184 GNode *gn; /* The target whose commands need
1185 * verifying */
1186 void (*abortProc) __P((char *, ...));
1187 /* Function to abort with message */
1188 {
1189 if (OP_NOP(gn->type) && Lst_IsEmpty(gn->commands) &&
1190 (gn->type & OP_LIB) == 0) {
1191 /*
1192 * No commands. Look for .DEFAULT rule from which we might infer
1193 * commands
1194 */
1195 if ((DEFAULT != NILGNODE) && !Lst_IsEmpty(DEFAULT->commands)) {
1196 char *p1;
1197 /*
1198 * Make only looks for a .DEFAULT if the node was never the
1199 * target of an operator, so that's what we do too. If
1200 * a .DEFAULT was given, we substitute its commands for gn's
1201 * commands and set the IMPSRC variable to be the target's name
1202 * The DEFAULT node acts like a transformation rule, in that
1203 * gn also inherits any attributes or sources attached to
1204 * .DEFAULT itself.
1205 */
1206 Make_HandleUse(DEFAULT, gn);
1207 Var_Set(IMPSRC, Var_Value(TARGET, gn, &p1), gn);
1208 if (p1)
1209 free(p1);
1210 } else if (Dir_MTime(gn) == 0) {
1211 /*
1212 * The node wasn't the target of an operator we have no .DEFAULT
1213 * rule to go on and the target doesn't already exist. There's
1214 * nothing more we can do for this branch. If the -k flag wasn't
1215 * given, we stop in our tracks, otherwise we just don't update
1216 * this node's parents so they never get examined.
1217 */
1218 static const char msg[] = ": don't know how to make";
1219
1220 if (gn->type & OP_OPTIONAL) {
1221 (void) fprintf(stdout, "%s%s %s(ignored)\n", progname,
1222 msg, gn->name);
1223 (void) fflush(stdout);
1224 } else if (keepgoing) {
1225 (void) fprintf(stdout, "%s%s %s(continuing)\n", progname,
1226 msg, gn->name);
1227 (void) fflush(stdout);
1228 return FALSE;
1229 } else {
1230 (*abortProc)("%s%s %s. Stop", progname, msg, gn->name);
1231 return FALSE;
1232 }
1233 }
1234 }
1235 return TRUE;
1236 }
1237 #ifdef RMT_WILL_WATCH
1238 /*-
1239 *-----------------------------------------------------------------------
1240 * JobLocalInput --
1241 * Handle a pipe becoming readable. Callback function for Rmt_Watch
1242 *
1243 * Results:
1244 * None
1245 *
1246 * Side Effects:
1247 * JobDoOutput is called.
1248 *
1249 *-----------------------------------------------------------------------
1250 */
1251 /*ARGSUSED*/
1252 static void
1253 JobLocalInput(stream, job)
1254 int stream; /* Stream that's ready (ignored) */
1255 Job *job; /* Job to which the stream belongs */
1256 {
1257 JobDoOutput(job, FALSE);
1258 }
1259 #endif /* RMT_WILL_WATCH */
1260
1261 /*-
1262 *-----------------------------------------------------------------------
1263 * JobExec --
1264 * Execute the shell for the given job. Called from JobStart and
1265 * JobRestart.
1266 *
1267 * Results:
1268 * None.
1269 *
1270 * Side Effects:
1271 * A shell is executed, outputs is altered and the Job structure added
1272 * to the job table.
1273 *
1274 *-----------------------------------------------------------------------
1275 */
1276 static void
1277 JobExec(job, argv)
1278 Job *job; /* Job to execute */
1279 char **argv;
1280 {
1281 int cpid; /* ID of new child */
1282
1283 if (DEBUG(JOB)) {
1284 int i;
1285
1286 (void) fprintf(stdout, "Running %s %sly\n", job->node->name,
1287 job->flags&JOB_REMOTE?"remote":"local");
1288 (void) fprintf(stdout, "\tCommand: ");
1289 for (i = 0; argv[i] != NULL; i++) {
1290 (void) fprintf(stdout, "%s ", argv[i]);
1291 }
1292 (void) fprintf(stdout, "\n");
1293 (void) fflush(stdout);
1294 }
1295
1296 /*
1297 * Some jobs produce no output and it's disconcerting to have
1298 * no feedback of their running (since they produce no output, the
1299 * banner with their name in it never appears). This is an attempt to
1300 * provide that feedback, even if nothing follows it.
1301 */
1302 if ((lastNode != job->node) && (job->flags & JOB_FIRST) &&
1303 !(job->flags & JOB_SILENT)) {
1304 MESSAGE(stdout, job->node);
1305 lastNode = job->node;
1306 }
1307
1308 #ifdef RMT_NO_EXEC
1309 if (job->flags & JOB_REMOTE) {
1310 goto jobExecFinish;
1311 }
1312 #endif /* RMT_NO_EXEC */
1313
1314 if ((cpid = vfork()) == -1) {
1315 Punt("Cannot vfork");
1316 } else if (cpid == 0) {
1317
1318 /*
1319 * Must duplicate the input stream down to the child's input and
1320 * reset it to the beginning (again). Since the stream was marked
1321 * close-on-exec, we must clear that bit in the new input.
1322 */
1323 if (dup2(FILENO(job->cmdFILE), 0) == -1)
1324 Punt("Cannot dup2: %s", strerror(errno));
1325 (void) fcntl(0, F_SETFD, 0);
1326 (void) lseek(0, (off_t)0, SEEK_SET);
1327
1328 if (job->node->type & OP_MAKE) {
1329 /*
1330 * Pass job token pipe to submakes.
1331 */
1332 fcntl(job_pipe[0], F_SETFD, 0);
1333 fcntl(job_pipe[1], F_SETFD, 0);
1334 }
1335
1336 if (usePipes) {
1337 /*
1338 * Set up the child's output to be routed through the pipe
1339 * we've created for it.
1340 */
1341 if (dup2(job->outPipe, 1) == -1)
1342 Punt("Cannot dup2: %s", strerror(errno));
1343 } else {
1344 /*
1345 * We're capturing output in a file, so we duplicate the
1346 * descriptor to the temporary file into the standard
1347 * output.
1348 */
1349 if (dup2(job->outFd, 1) == -1)
1350 Punt("Cannot dup2: %s", strerror(errno));
1351 }
1352 /*
1353 * The output channels are marked close on exec. This bit was
1354 * duplicated by the dup2 (on some systems), so we have to clear
1355 * it before routing the shell's error output to the same place as
1356 * its standard output.
1357 */
1358 (void) fcntl(1, F_SETFD, 0);
1359 if (dup2(1, 2) == -1)
1360 Punt("Cannot dup2: %s", strerror(errno));
1361
1362 #ifdef USE_PGRP
1363 /*
1364 * We want to switch the child into a different process family so
1365 * we can kill it and all its descendants in one fell swoop,
1366 * by killing its process family, but not commit suicide.
1367 */
1368 # if defined(SYSV)
1369 (void) setsid();
1370 # else
1371 (void) setpgid(0, getpid());
1372 # endif
1373 #endif /* USE_PGRP */
1374
1375 #ifdef REMOTE
1376 if (job->flags & JOB_REMOTE) {
1377 Rmt_Exec(shellPath, argv, FALSE);
1378 } else
1379 #endif /* REMOTE */
1380 {
1381 (void) execv(shellPath, argv);
1382 execError(shellPath);
1383 }
1384 _exit(1);
1385 } else {
1386 #ifdef REMOTE
1387 sigset_t nmask, omask;
1388 sigemptyset(&nmask);
1389 sigaddset(&nmask, SIGCHLD);
1390 sigprocmask(SIG_BLOCK, &nmask, &omask);
1391 #endif
1392 job->pid = cpid;
1393
1394 Trace_Log(JOBSTART, job);
1395
1396 if (usePipes && (job->flags & JOB_FIRST)) {
1397 /*
1398 * The first time a job is run for a node, we set the current
1399 * position in the buffer to the beginning and mark another
1400 * stream to watch in the outputs mask
1401 */
1402 job->curPos = 0;
1403
1404 #ifdef RMT_WILL_WATCH
1405 Rmt_Watch(job->inPipe, JobLocalInput, job);
1406 #else
1407 #ifdef USE_SELECT
1408 FD_SET(job->inPipe, &outputs);
1409 #else
1410 watchfd(job);
1411 #endif
1412 #endif /* RMT_WILL_WATCH */
1413 }
1414
1415 if (job->flags & JOB_REMOTE) {
1416 #ifndef REMOTE
1417 job->rmtID = 0;
1418 #else
1419 job->rmtID = Rmt_LastID(job->pid);
1420 #endif /* REMOTE */
1421 } else {
1422 nLocal += 1;
1423 /*
1424 * XXX: Used to not happen if REMOTE. Why?
1425 */
1426 if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
1427 (void) fclose(job->cmdFILE);
1428 job->cmdFILE = NULL;
1429 }
1430 }
1431 #ifdef REMOTE
1432 sigprocmask(SIG_SETMASK, &omask, NULL);
1433 #endif
1434 }
1435
1436 #ifdef RMT_NO_EXEC
1437 jobExecFinish:
1438 #endif
1439 /*
1440 * Now the job is actually running, add it to the table.
1441 */
1442 nJobs += 1;
1443 (void) Lst_AtEnd(jobs, (ClientData)job);
1444 }
1445
1446 /*-
1447 *-----------------------------------------------------------------------
1448 * JobMakeArgv --
1449 * Create the argv needed to execute the shell for a given job.
1450 *
1451 *
1452 * Results:
1453 *
1454 * Side Effects:
1455 *
1456 *-----------------------------------------------------------------------
1457 */
1458 static void
1459 JobMakeArgv(job, argv)
1460 Job *job;
1461 char **argv;
1462 {
1463 int argc;
1464 static char args[10]; /* For merged arguments */
1465
1466 argv[0] = shellName;
1467 argc = 1;
1468
1469 if ((commandShell->exit && (*commandShell->exit != '-')) ||
1470 (commandShell->echo && (*commandShell->echo != '-')))
1471 {
1472 /*
1473 * At least one of the flags doesn't have a minus before it, so
1474 * merge them together. Have to do this because the *(&(@*#*&#$#
1475 * Bourne shell thinks its second argument is a file to source.
1476 * Grrrr. Note the ten-character limitation on the combined arguments.
1477 */
1478 (void)snprintf(args, sizeof(args), "-%s%s",
1479 ((job->flags & JOB_IGNERR) ? "" :
1480 (commandShell->exit ? commandShell->exit : "")),
1481 ((job->flags & JOB_SILENT) ? "" :
1482 (commandShell->echo ? commandShell->echo : "")));
1483
1484 if (args[1]) {
1485 argv[argc] = args;
1486 argc++;
1487 }
1488 } else {
1489 if (!(job->flags & JOB_IGNERR) && commandShell->exit) {
1490 argv[argc] = commandShell->exit;
1491 argc++;
1492 }
1493 if (!(job->flags & JOB_SILENT) && commandShell->echo) {
1494 argv[argc] = commandShell->echo;
1495 argc++;
1496 }
1497 }
1498 argv[argc] = NULL;
1499 }
1500
1501 /*-
1502 *-----------------------------------------------------------------------
1503 * JobRestart --
1504 * Restart a job that stopped for some reason.
1505 *
1506 * Results:
1507 * None.
1508 *
1509 *-----------------------------------------------------------------------
1510 */
1511 static void
1512 JobRestart(job)
1513 Job *job; /* Job to restart */
1514 {
1515 #ifdef REMOTE
1516 int host;
1517 #endif
1518
1519 if (job->flags & JOB_REMIGRATE) {
1520 if (
1521 #ifdef REMOTE
1522 verboseRemigrates ||
1523 #endif
1524 DEBUG(JOB)) {
1525 (void) fprintf(stdout, "*** remigrating %x(%s)\n",
1526 job->pid, job->node->name);
1527 (void) fflush(stdout);
1528 }
1529
1530 #ifdef REMOTE
1531 if (!Rmt_ReExport(job->pid, job->node, &host)) {
1532 if (verboseRemigrates || DEBUG(JOB)) {
1533 (void) fprintf(stdout, "*** couldn't migrate...\n");
1534 (void) fflush(stdout);
1535 }
1536 #endif
1537 if (nLocal != maxLocal) {
1538 /*
1539 * Job cannot be remigrated, but there's room on the local
1540 * machine, so resume the job and note that another
1541 * local job has started.
1542 */
1543 if (
1544 #ifdef REMOTE
1545 verboseRemigrates ||
1546 #endif
1547 DEBUG(JOB)) {
1548 (void) fprintf(stdout, "*** resuming on local machine\n");
1549 (void) fflush(stdout);
1550 }
1551 KILL(job->pid, SIGCONT);
1552 nLocal +=1;
1553 #ifdef REMOTE
1554 job->flags &= ~(JOB_REMIGRATE|JOB_RESUME|JOB_REMOTE);
1555 job->flags |= JOB_CONTINUING;
1556 #else
1557 job->flags &= ~(JOB_REMIGRATE|JOB_RESUME);
1558 #endif
1559 } else {
1560 /*
1561 * Job cannot be restarted. Mark the table as full and
1562 * place the job back on the list of stopped jobs.
1563 */
1564 if (
1565 #ifdef REMOTE
1566 verboseRemigrates ||
1567 #endif
1568 DEBUG(JOB)) {
1569 (void) fprintf(stdout, "*** holding\n");
1570 (void) fflush(stdout);
1571 }
1572 (void)Lst_AtFront(stoppedJobs, (ClientData)job);
1573 return;
1574 }
1575 #ifdef REMOTE
1576 } else {
1577 /*
1578 * Clear out the remigrate and resume flags. Set the continuing
1579 * flag so we know later on that the process isn't exiting just
1580 * because of a signal.
1581 */
1582 job->flags &= ~(JOB_REMIGRATE|JOB_RESUME);
1583 job->flags |= JOB_CONTINUING;
1584 job->rmtID = host;
1585 }
1586 #endif
1587
1588 (void)Lst_AtEnd(jobs, (ClientData)job);
1589 nJobs += 1;
1590 } else if (job->flags & JOB_RESTART) {
1591 /*
1592 * Set up the control arguments to the shell. This is based on the
1593 * flags set earlier for this job. If the JOB_IGNERR flag is clear,
1594 * the 'exit' flag of the commandShell is used to cause it to exit
1595 * upon receiving an error. If the JOB_SILENT flag is clear, the
1596 * 'echo' flag of the commandShell is used to get it to start echoing
1597 * as soon as it starts processing commands.
1598 */
1599 char *argv[10];
1600
1601 JobMakeArgv(job, argv);
1602
1603 if (DEBUG(JOB)) {
1604 (void) fprintf(stdout, "Restarting %s...", job->node->name);
1605 (void) fflush(stdout);
1606 }
1607 #ifdef REMOTE
1608 if ((job->node->type&OP_NOEXPORT) ||
1609 (nLocal < maxLocal && runLocalFirst)
1610 # ifdef RMT_NO_EXEC
1611 || !Rmt_Export(shellPath, argv, job)
1612 # else
1613 || !Rmt_Begin(shellPath, argv, job->node)
1614 # endif
1615 #endif
1616 {
1617 if (((nLocal >= maxLocal) && !(job->flags & JOB_SPECIAL))) {
1618 /*
1619 * Can't be exported and not allowed to run locally -- put it
1620 * back on the hold queue and mark the table full
1621 */
1622 if (DEBUG(JOB)) {
1623 (void) fprintf(stdout, "holding\n");
1624 (void) fflush(stdout);
1625 }
1626 (void)Lst_AtFront(stoppedJobs, (ClientData)job);
1627 return;
1628 } else {
1629 /*
1630 * Job may be run locally.
1631 */
1632 if (DEBUG(JOB)) {
1633 (void) fprintf(stdout, "running locally\n");
1634 (void) fflush(stdout);
1635 }
1636 job->flags &= ~JOB_REMOTE;
1637 }
1638 }
1639 #ifdef REMOTE
1640 else {
1641 /*
1642 * Can be exported. Hooray!
1643 */
1644 if (DEBUG(JOB)) {
1645 (void) fprintf(stdout, "exporting\n");
1646 (void) fflush(stdout);
1647 }
1648 job->flags |= JOB_REMOTE;
1649 }
1650 #endif
1651 JobExec(job, argv);
1652 } else {
1653 /*
1654 * The job has stopped and needs to be restarted. Why it stopped,
1655 * we don't know...
1656 */
1657 if (DEBUG(JOB)) {
1658 (void) fprintf(stdout, "Resuming %s...", job->node->name);
1659 (void) fflush(stdout);
1660 }
1661 if (((job->flags & JOB_REMOTE) ||
1662 (nLocal < maxLocal) ||
1663 #ifdef REMOTE
1664 (((job->flags & JOB_SPECIAL) &&
1665 (job->node->type & OP_NOEXPORT)) &&
1666 (maxLocal == 0))) &&
1667 #else
1668 ((job->flags & JOB_SPECIAL) &&
1669 (maxLocal == 0))) &&
1670 #endif
1671 (nJobs != maxJobs))
1672 {
1673 /*
1674 * If the job is remote, it's ok to resume it as long as the
1675 * maximum concurrency won't be exceeded. If it's local and
1676 * we haven't reached the local concurrency limit already (or the
1677 * job must be run locally and maxLocal is 0), it's also ok to
1678 * resume it.
1679 */
1680 Boolean error;
1681 int status;
1682
1683 #ifdef RMT_WANTS_SIGNALS
1684 if (job->flags & JOB_REMOTE) {
1685 error = !Rmt_Signal(job, SIGCONT);
1686 } else
1687 #endif /* RMT_WANTS_SIGNALS */
1688 error = (KILL(job->pid, SIGCONT) != 0);
1689
1690 if (!error) {
1691 /*
1692 * Make sure the user knows we've continued the beast and
1693 * actually put the thing in the job table.
1694 */
1695 job->flags |= JOB_CONTINUING;
1696 status = W_STOPCODE(SIGCONT);
1697 JobFinish(job, &status);
1698
1699 job->flags &= ~(JOB_RESUME|JOB_CONTINUING);
1700 if (DEBUG(JOB)) {
1701 (void) fprintf(stdout, "done\n");
1702 (void) fflush(stdout);
1703 }
1704 } else {
1705 Error("couldn't resume %s: %s",
1706 job->node->name, strerror(errno));
1707 status = W_EXITCODE(1, 0);
1708 JobFinish(job, &status);
1709 }
1710 } else {
1711 /*
1712 * Job cannot be restarted. Mark the table as full and
1713 * place the job back on the list of stopped jobs.
1714 */
1715 if (DEBUG(JOB)) {
1716 (void) fprintf(stdout, "table full\n");
1717 (void) fflush(stdout);
1718 }
1719 (void) Lst_AtFront(stoppedJobs, (ClientData)job);
1720 }
1721 }
1722 }
1723
1724 /*-
1725 *-----------------------------------------------------------------------
1726 * JobStart --
1727 * Start a target-creation process going for the target described
1728 * by the graph node gn.
1729 *
1730 * Results:
1731 * JOB_ERROR if there was an error in the commands, JOB_FINISHED
1732 * if there isn't actually anything left to do for the job and
1733 * JOB_RUNNING if the job has been started.
1734 *
1735 * Side Effects:
1736 * A new Job node is created and added to the list of running
1737 * jobs. PMake is forked and a child shell created.
1738 *-----------------------------------------------------------------------
1739 */
1740 static int
1741 JobStart(gn, flags, previous)
1742 GNode *gn; /* target to create */
1743 int flags; /* flags for the job to override normal ones.
1744 * e.g. JOB_SPECIAL or JOB_IGNDOTS */
1745 Job *previous; /* The previous Job structure for this node,
1746 * if any. */
1747 {
1748 register Job *job; /* new job descriptor */
1749 char *argv[10]; /* Argument vector to shell */
1750 Boolean cmdsOK; /* true if the nodes commands were all right */
1751 Boolean local; /* Set true if the job was run locally */
1752 Boolean noExec; /* Set true if we decide not to run the job */
1753 int tfd; /* File descriptor to the temp file */
1754
1755 if (previous != NULL) {
1756 previous->flags &= ~(JOB_FIRST|JOB_IGNERR|JOB_SILENT|JOB_REMOTE);
1757 job = previous;
1758 } else {
1759 job = (Job *) emalloc(sizeof(Job));
1760 if (job == NULL) {
1761 Punt("JobStart out of memory");
1762 }
1763 flags |= JOB_FIRST;
1764 }
1765
1766 job->node = gn;
1767 job->tailCmds = NILLNODE;
1768
1769 /*
1770 * Set the initial value of the flags for this job based on the global
1771 * ones and the node's attributes... Any flags supplied by the caller
1772 * are also added to the field.
1773 */
1774 job->flags = 0;
1775 if (Targ_Ignore(gn)) {
1776 job->flags |= JOB_IGNERR;
1777 }
1778 if (Targ_Silent(gn)) {
1779 job->flags |= JOB_SILENT;
1780 }
1781 job->flags |= flags;
1782
1783 /*
1784 * Check the commands now so any attributes from .DEFAULT have a chance
1785 * to migrate to the node
1786 */
1787 if (!compatMake && job->flags & JOB_FIRST) {
1788 cmdsOK = Job_CheckCommands(gn, Error);
1789 } else {
1790 cmdsOK = TRUE;
1791 }
1792
1793 #ifndef RMT_WILL_WATCH
1794 #ifndef USE_SELECT
1795 job->inPollfd = NULL;
1796 #endif
1797 #endif
1798 /*
1799 * If the -n flag wasn't given, we open up OUR (not the child's)
1800 * temporary file to stuff commands in it. The thing is rd/wr so we don't
1801 * need to reopen it to feed it to the shell. If the -n flag *was* given,
1802 * we just set the file to be stdout. Cute, huh?
1803 */
1804 if (((gn->type & OP_MAKE) && !(noRecursiveExecute)) ||
1805 (!noExecute && !touchFlag)) {
1806 /*
1807 * tfile is the name of a file into which all shell commands are
1808 * put. It is used over by removing it before the child shell is
1809 * executed. The XXXXXX in the string are replaced by the pid of
1810 * the make process in a 6-character field with leading zeroes.
1811 */
1812 char tfile[sizeof(TMPPAT)];
1813 /*
1814 * We're serious here, but if the commands were bogus, we're
1815 * also dead...
1816 */
1817 if (!cmdsOK) {
1818 DieHorribly();
1819 }
1820
1821 (void)strcpy(tfile, TMPPAT);
1822 if ((tfd = mkstemp(tfile)) == -1)
1823 Punt("Could not create temporary file %s", strerror(errno));
1824 (void) eunlink(tfile);
1825
1826 job->cmdFILE = fdopen(tfd, "w+");
1827 if (job->cmdFILE == NULL) {
1828 Punt("Could not fdopen %s", tfile);
1829 }
1830 (void) fcntl(FILENO(job->cmdFILE), F_SETFD, 1);
1831 /*
1832 * Send the commands to the command file, flush all its buffers then
1833 * rewind and remove the thing.
1834 */
1835 noExec = FALSE;
1836
1837 /*
1838 * used to be backwards; replace when start doing multiple commands
1839 * per shell.
1840 */
1841 if (compatMake) {
1842 /*
1843 * Be compatible: If this is the first time for this node,
1844 * verify its commands are ok and open the commands list for
1845 * sequential access by later invocations of JobStart.
1846 * Once that is done, we take the next command off the list
1847 * and print it to the command file. If the command was an
1848 * ellipsis, note that there's nothing more to execute.
1849 */
1850 if ((job->flags&JOB_FIRST) && (Lst_Open(gn->commands) != SUCCESS)){
1851 cmdsOK = FALSE;
1852 } else {
1853 LstNode ln = Lst_Next(gn->commands);
1854
1855 if ((ln == NILLNODE) ||
1856 JobPrintCommand((ClientData) Lst_Datum(ln),
1857 (ClientData) job))
1858 {
1859 noExec = TRUE;
1860 Lst_Close(gn->commands);
1861 }
1862 if (noExec && !(job->flags & JOB_FIRST)) {
1863 /*
1864 * If we're not going to execute anything, the job
1865 * is done and we need to close down the various
1866 * file descriptors we've opened for output, then
1867 * call JobDoOutput to catch the final characters or
1868 * send the file to the screen... Note that the i/o streams
1869 * are only open if this isn't the first job.
1870 * Note also that this could not be done in
1871 * Job_CatchChildren b/c it wasn't clear if there were
1872 * more commands to execute or not...
1873 */
1874 JobClose(job);
1875 }
1876 }
1877 } else {
1878 /*
1879 * We can do all the commands at once. hooray for sanity
1880 */
1881 numCommands = 0;
1882 Lst_ForEach(gn->commands, JobPrintCommand, (ClientData)job);
1883
1884 /*
1885 * If we didn't print out any commands to the shell script,
1886 * there's not much point in executing the shell, is there?
1887 */
1888 if (numCommands == 0) {
1889 noExec = TRUE;
1890 }
1891 }
1892 } else if (NoExecute(gn)) {
1893 /*
1894 * Not executing anything -- just print all the commands to stdout
1895 * in one fell swoop. This will still set up job->tailCmds correctly.
1896 */
1897 if (lastNode != gn) {
1898 MESSAGE(stdout, gn);
1899 lastNode = gn;
1900 }
1901 job->cmdFILE = stdout;
1902 /*
1903 * Only print the commands if they're ok, but don't die if they're
1904 * not -- just let the user know they're bad and keep going. It
1905 * doesn't do any harm in this case and may do some good.
1906 */
1907 if (cmdsOK) {
1908 Lst_ForEach(gn->commands, JobPrintCommand, (ClientData)job);
1909 }
1910 /*
1911 * Don't execute the shell, thank you.
1912 */
1913 noExec = TRUE;
1914 } else {
1915 /*
1916 * Just touch the target and note that no shell should be executed.
1917 * Set cmdFILE to stdout to make life easier. Check the commands, too,
1918 * but don't die if they're no good -- it does no harm to keep working
1919 * up the graph.
1920 */
1921 job->cmdFILE = stdout;
1922 Job_Touch(gn, job->flags&JOB_SILENT);
1923 noExec = TRUE;
1924 }
1925
1926 /*
1927 * If we're not supposed to execute a shell, don't.
1928 */
1929 if (noExec) {
1930 /*
1931 * Unlink and close the command file if we opened one
1932 */
1933 if (job->cmdFILE != stdout) {
1934 if (job->cmdFILE != NULL) {
1935 (void) fclose(job->cmdFILE);
1936 job->cmdFILE = NULL;
1937 }
1938 } else {
1939 (void) fflush(stdout);
1940 }
1941
1942 /*
1943 * We only want to work our way up the graph if we aren't here because
1944 * the commands for the job were no good.
1945 */
1946 if (cmdsOK) {
1947 if (aborting == 0) {
1948 if (job->tailCmds != NILLNODE) {
1949 Lst_ForEachFrom(job->node->commands, job->tailCmds,
1950 JobSaveCommand,
1951 (ClientData)job->node);
1952 }
1953 if (!(job->flags & JOB_SPECIAL))
1954 Job_TokenReturn();
1955 Make_Update(job->node);
1956 }
1957 free((Address)job);
1958 return(JOB_FINISHED);
1959 } else {
1960 free((Address)job);
1961 return(JOB_ERROR);
1962 }
1963 } else {
1964 (void) fflush(job->cmdFILE);
1965 }
1966
1967 /*
1968 * Set up the control arguments to the shell. This is based on the flags
1969 * set earlier for this job.
1970 */
1971 JobMakeArgv(job, argv);
1972
1973 /*
1974 * If we're using pipes to catch output, create the pipe by which we'll
1975 * get the shell's output. If we're using files, print out that we're
1976 * starting a job and then set up its temporary-file name.
1977 */
1978 if (!compatMake || (job->flags & JOB_FIRST)) {
1979 if (usePipes) {
1980 int fd[2];
1981 if (pipe(fd) == -1)
1982 Punt("Cannot create pipe: %s", strerror(errno));
1983 job->inPipe = fd[0];
1984 #ifdef USE_SELECT
1985 if (job->inPipe >= FD_SETSIZE)
1986 Punt("Ran out of fd_set slots; "
1987 "recompile with a larger FD_SETSIZE.");
1988 #endif
1989 job->outPipe = fd[1];
1990 (void) fcntl(job->inPipe, F_SETFD, 1);
1991 (void) fcntl(job->outPipe, F_SETFD, 1);
1992 } else {
1993 (void) fprintf(stdout, "Remaking `%s'\n", gn->name);
1994 (void) fflush(stdout);
1995 (void) strcpy(job->outFile, TMPPAT);
1996 job->outFd = mkstemp(job->outFile);
1997 (void) fcntl(job->outFd, F_SETFD, 1);
1998 }
1999 }
2000
2001 #ifdef REMOTE
2002 if (!(gn->type & OP_NOEXPORT) && !(runLocalFirst && nLocal < maxLocal)) {
2003 #ifdef RMT_NO_EXEC
2004 local = !Rmt_Export(shellPath, argv, job);
2005 #else
2006 local = !Rmt_Begin(shellPath, argv, job->node);
2007 #endif /* RMT_NO_EXEC */
2008 if (!local) {
2009 job->flags |= JOB_REMOTE;
2010 }
2011 } else
2012 #endif
2013 local = TRUE;
2014
2015 if (local && (((nLocal >= maxLocal) &&
2016 !(job->flags & JOB_SPECIAL) &&
2017 #ifdef REMOTE
2018 (!(gn->type & OP_NOEXPORT) || (maxLocal != 0))
2019 #else
2020 (maxLocal != 0)
2021 #endif
2022 )))
2023 {
2024 /*
2025 * The job can only be run locally, but we've hit the limit of
2026 * local concurrency, so put the job on hold until some other job
2027 * finishes. Note that the special jobs (.BEGIN, .INTERRUPT and .END)
2028 * may be run locally even when the local limit has been reached
2029 * (e.g. when maxLocal == 0), though they will be exported if at
2030 * all possible. In addition, any target marked with .NOEXPORT will
2031 * be run locally if maxLocal is 0.
2032 */
2033 job->flags |= JOB_RESTART;
2034 (void) Lst_AtEnd(stoppedJobs, (ClientData)job);
2035 } else {
2036 JobExec(job, argv);
2037 }
2038 return(JOB_RUNNING);
2039 }
2040
2041 static char *
2042 JobOutput(job, cp, endp, msg)
2043 register Job *job;
2044 register char *cp, *endp;
2045 int msg;
2046 {
2047 register char *ecp;
2048
2049 if (commandShell->noPrint) {
2050 ecp = Str_FindSubstring(cp, commandShell->noPrint);
2051 while (ecp != NULL) {
2052 if (cp != ecp) {
2053 *ecp = '\0';
2054 if (msg && job->node != lastNode) {
2055 MESSAGE(stdout, job->node);
2056 lastNode = job->node;
2057 }
2058 /*
2059 * The only way there wouldn't be a newline after
2060 * this line is if it were the last in the buffer.
2061 * however, since the non-printable comes after it,
2062 * there must be a newline, so we don't print one.
2063 */
2064 (void) fprintf(stdout, "%s", cp);
2065 (void) fflush(stdout);
2066 }
2067 cp = ecp + commandShell->noPLen;
2068 if (cp != endp) {
2069 /*
2070 * Still more to print, look again after skipping
2071 * the whitespace following the non-printable
2072 * command....
2073 */
2074 cp++;
2075 while (*cp == ' ' || *cp == '\t' || *cp == '\n') {
2076 cp++;
2077 }
2078 ecp = Str_FindSubstring(cp, commandShell->noPrint);
2079 } else {
2080 return cp;
2081 }
2082 }
2083 }
2084 return cp;
2085 }
2086
2087 /*-
2088 *-----------------------------------------------------------------------
2089 * JobDoOutput --
2090 * This function is called at different times depending on
2091 * whether the user has specified that output is to be collected
2092 * via pipes or temporary files. In the former case, we are called
2093 * whenever there is something to read on the pipe. We collect more
2094 * output from the given job and store it in the job's outBuf. If
2095 * this makes up a line, we print it tagged by the job's identifier,
2096 * as necessary.
2097 * If output has been collected in a temporary file, we open the
2098 * file and read it line by line, transfering it to our own
2099 * output channel until the file is empty. At which point we
2100 * remove the temporary file.
2101 * In both cases, however, we keep our figurative eye out for the
2102 * 'noPrint' line for the shell from which the output came. If
2103 * we recognize a line, we don't print it. If the command is not
2104 * alone on the line (the character after it is not \0 or \n), we
2105 * do print whatever follows it.
2106 *
2107 * Results:
2108 * None
2109 *
2110 * Side Effects:
2111 * curPos may be shifted as may the contents of outBuf.
2112 *-----------------------------------------------------------------------
2113 */
2114 STATIC void
2115 JobDoOutput(job, finish)
2116 register Job *job; /* the job whose output needs printing */
2117 Boolean finish; /* TRUE if this is the last time we'll be
2118 * called for this job */
2119 {
2120 Boolean gotNL = FALSE; /* true if got a newline */
2121 Boolean fbuf; /* true if our buffer filled up */
2122 register int nr; /* number of bytes read */
2123 register int i; /* auxiliary index into outBuf */
2124 register int max; /* limit for i (end of current data) */
2125 int nRead; /* (Temporary) number of bytes read */
2126
2127 FILE *oFILE; /* Stream pointer to shell's output file */
2128 char inLine[132];
2129
2130
2131 if (usePipes) {
2132 /*
2133 * Read as many bytes as will fit in the buffer.
2134 */
2135 end_loop:
2136 gotNL = FALSE;
2137 fbuf = FALSE;
2138
2139 nRead = read(job->inPipe, &job->outBuf[job->curPos],
2140 JOB_BUFSIZE - job->curPos);
2141 if (nRead < 0) {
2142 if (DEBUG(JOB)) {
2143 perror("JobDoOutput(piperead)");
2144 }
2145 nr = 0;
2146 } else {
2147 nr = nRead;
2148 }
2149
2150 /*
2151 * If we hit the end-of-file (the job is dead), we must flush its
2152 * remaining output, so pretend we read a newline if there's any
2153 * output remaining in the buffer.
2154 * Also clear the 'finish' flag so we stop looping.
2155 */
2156 if ((nr == 0) && (job->curPos != 0)) {
2157 job->outBuf[job->curPos] = '\n';
2158 nr = 1;
2159 finish = FALSE;
2160 } else if (nr == 0) {
2161 finish = FALSE;
2162 }
2163
2164 /*
2165 * Look for the last newline in the bytes we just got. If there is
2166 * one, break out of the loop with 'i' as its index and gotNL set
2167 * TRUE.
2168 */
2169 max = job->curPos + nr;
2170 for (i = job->curPos + nr - 1; i >= job->curPos; i--) {
2171 if (job->outBuf[i] == '\n') {
2172 gotNL = TRUE;
2173 break;
2174 } else if (job->outBuf[i] == '\0') {
2175 /*
2176 * Why?
2177 */
2178 job->outBuf[i] = ' ';
2179 }
2180 }
2181
2182 if (!gotNL) {
2183 job->curPos += nr;
2184 if (job->curPos == JOB_BUFSIZE) {
2185 /*
2186 * If we've run out of buffer space, we have no choice
2187 * but to print the stuff. sigh.
2188 */
2189 fbuf = TRUE;
2190 i = job->curPos;
2191 }
2192 }
2193 if (gotNL || fbuf) {
2194 /*
2195 * Need to send the output to the screen. Null terminate it
2196 * first, overwriting the newline character if there was one.
2197 * So long as the line isn't one we should filter (according
2198 * to the shell description), we print the line, preceeded
2199 * by a target banner if this target isn't the same as the
2200 * one for which we last printed something.
2201 * The rest of the data in the buffer are then shifted down
2202 * to the start of the buffer and curPos is set accordingly.
2203 */
2204 job->outBuf[i] = '\0';
2205 if (i >= job->curPos) {
2206 char *cp;
2207
2208 cp = JobOutput(job, job->outBuf, &job->outBuf[i], FALSE);
2209
2210 /*
2211 * There's still more in that thar buffer. This time, though,
2212 * we know there's no newline at the end, so we add one of
2213 * our own free will.
2214 */
2215 if (*cp != '\0') {
2216 if (job->node != lastNode) {
2217 MESSAGE(stdout, job->node);
2218 lastNode = job->node;
2219 }
2220 (void) fprintf(stdout, "%s%s", cp, gotNL ? "\n" : "");
2221 (void) fflush(stdout);
2222 }
2223 }
2224 if (i < max - 1) {
2225 /* shift the remaining characters down */
2226 (void) memcpy(job->outBuf, &job->outBuf[i + 1], max - (i + 1));
2227 job->curPos = max - (i + 1);
2228
2229 } else {
2230 /*
2231 * We have written everything out, so we just start over
2232 * from the start of the buffer. No copying. No nothing.
2233 */
2234 job->curPos = 0;
2235 }
2236 }
2237 if (finish) {
2238 /*
2239 * If the finish flag is true, we must loop until we hit
2240 * end-of-file on the pipe. This is guaranteed to happen
2241 * eventually since the other end of the pipe is now closed
2242 * (we closed it explicitly and the child has exited). When
2243 * we do get an EOF, finish will be set FALSE and we'll fall
2244 * through and out.
2245 */
2246 goto end_loop;
2247 }
2248 } else {
2249 /*
2250 * We've been called to retrieve the output of the job from the
2251 * temporary file where it's been squirreled away. This consists of
2252 * opening the file, reading the output line by line, being sure not
2253 * to print the noPrint line for the shell we used, then close and
2254 * remove the temporary file. Very simple.
2255 *
2256 * Change to read in blocks and do FindSubString type things as for
2257 * pipes? That would allow for "@echo -n..."
2258 */
2259 oFILE = fopen(job->outFile, "r");
2260 if (oFILE != NULL) {
2261 (void) fprintf(stdout, "Results of making %s:\n", job->node->name);
2262 (void) fflush(stdout);
2263 while (fgets(inLine, sizeof(inLine), oFILE) != NULL) {
2264 register char *cp, *endp, *oendp;
2265
2266 cp = inLine;
2267 oendp = endp = inLine + strlen(inLine);
2268 if (endp[-1] == '\n') {
2269 *--endp = '\0';
2270 }
2271 cp = JobOutput(job, inLine, endp, FALSE);
2272
2273 /*
2274 * There's still more in that thar buffer. This time, though,
2275 * we know there's no newline at the end, so we add one of
2276 * our own free will.
2277 */
2278 (void) fprintf(stdout, "%s", cp);
2279 (void) fflush(stdout);
2280 if (endp != oendp) {
2281 (void) fprintf(stdout, "\n");
2282 (void) fflush(stdout);
2283 }
2284 }
2285 (void) fclose(oFILE);
2286 (void) eunlink(job->outFile);
2287 } else {
2288 Punt("Cannot open `%s'", job->outFile);
2289 }
2290 }
2291 }
2292
2293 /*-
2294 *-----------------------------------------------------------------------
2295 * Job_CatchChildren --
2296 * Handle the exit of a child. Called from Make_Make.
2297 *
2298 * Results:
2299 * none.
2300 *
2301 * Side Effects:
2302 * The job descriptor is removed from the list of children.
2303 *
2304 * Notes:
2305 * We do waits, blocking or not, according to the wisdom of our
2306 * caller, until there are no more children to report. For each
2307 * job, call JobFinish to finish things off. This will take care of
2308 * putting jobs on the stoppedJobs queue.
2309 *
2310 *-----------------------------------------------------------------------
2311 */
2312 void
2313 Job_CatchChildren(block)
2314 Boolean block; /* TRUE if should block on the wait. */
2315 {
2316 int pid; /* pid of dead child */
2317 register Job *job; /* job descriptor for dead child */
2318 LstNode jnode; /* list element for finding job */
2319 int status; /* Exit/termination status */
2320
2321 /*
2322 * Don't even bother if we know there's no one around.
2323 */
2324 if (nLocal == 0) {
2325 return;
2326 }
2327
2328 while ((pid = waitpid((pid_t) -1, &status,
2329 (block?0:WNOHANG)|WUNTRACED)) > 0)
2330 {
2331 if (DEBUG(JOB)) {
2332 (void) fprintf(stdout, "Process %d exited or stopped %x.\n", pid,
2333 status);
2334 (void) fflush(stdout);
2335 }
2336
2337
2338 jnode = Lst_Find(jobs, (ClientData)&pid, JobCmpPid);
2339
2340 if (jnode == NILLNODE) {
2341 if (WIFSTOPPED(status) && (WSTOPSIG(status) == SIGCONT)) {
2342 jnode = Lst_Find(stoppedJobs, (ClientData) &pid, JobCmpPid);
2343 if (jnode == NILLNODE) {
2344 Error("Resumed child (%d) not in table", pid);
2345 continue;
2346 }
2347 job = (Job *)Lst_Datum(jnode);
2348 (void) Lst_Remove(stoppedJobs, jnode);
2349 } else {
2350 Error("Child (%d) not in table?", pid);
2351 continue;
2352 }
2353 } else {
2354 job = (Job *) Lst_Datum(jnode);
2355 (void) Lst_Remove(jobs, jnode);
2356 nJobs -= 1;
2357 #ifdef REMOTE
2358 if (!(job->flags & JOB_REMOTE)) {
2359 if (DEBUG(JOB)) {
2360 (void) fprintf(stdout,
2361 "Job queue has one fewer local process.\n");
2362 (void) fflush(stdout);
2363 }
2364 nLocal -= 1;
2365 }
2366 #else
2367 nLocal -= 1;
2368 #endif
2369 }
2370
2371 JobFinish(job, &status);
2372 }
2373 }
2374
2375 /*-
2376 *-----------------------------------------------------------------------
2377 * Job_CatchOutput --
2378 * Catch the output from our children, if we're using
2379 * pipes do so. Otherwise just block time until we get a
2380 * signal (most likely a SIGCHLD) since there's no point in
2381 * just spinning when there's nothing to do and the reaping
2382 * of a child can wait for a while.
2383 *
2384 * Results:
2385 * None
2386 *
2387 * Side Effects:
2388 * Output is read from pipes if we're piping.
2389 * -----------------------------------------------------------------------
2390 */
2391 void
2392 Job_CatchOutput()
2393 {
2394 int nready;
2395 register LstNode ln;
2396 register Job *job;
2397 #ifdef RMT_WILL_WATCH
2398 int pnJobs; /* Previous nJobs */
2399 #endif
2400
2401 (void) fflush(stdout);
2402 Job_TokenFlush();
2403 #ifdef RMT_WILL_WATCH
2404 pnJobs = nJobs;
2405
2406 /*
2407 * It is possible for us to be called with nJobs equal to 0. This happens
2408 * if all the jobs finish and a job that is stopped cannot be run
2409 * locally (eg if maxLocal is 0) and cannot be exported. The job will
2410 * be placed back on the stoppedJobs queue, Job_Empty() will return false,
2411 * Make_Run will call us again when there's nothing for which to wait.
2412 * nJobs never changes, so we loop forever. Hence the check. It could
2413 * be argued that we should sleep for a bit so as not to swamp the
2414 * exportation system with requests. Perhaps we should.
2415 *
2416 * NOTE: IT IS THE RESPONSIBILITY OF Rmt_Wait TO CALL Job_CatchChildren
2417 * IN A TIMELY FASHION TO CATCH ANY LOCALLY RUNNING JOBS THAT EXIT.
2418 * It may use the variable nLocal to determine if it needs to call
2419 * Job_CatchChildren (if nLocal is 0, there's nothing for which to
2420 * wait...)
2421 */
2422 while (nJobs != 0 && pnJobs == nJobs) {
2423 Rmt_Wait();
2424 }
2425 #else
2426 if (usePipes) {
2427 #ifdef USE_SELECT
2428 struct timeval timeout;
2429 fd_set readfds;
2430
2431 readfds = outputs;
2432 timeout.tv_sec = SEL_SEC;
2433 timeout.tv_usec = SEL_USEC;
2434
2435 if ((nready = select(FD_SETSIZE, &readfds, (fd_set *) 0,
2436 (fd_set *) 0, &timeout)) <= 0)
2437 return;
2438 #else
2439 if ((nready = poll((wantToken ? fds : (fds + 1)),
2440 (wantToken ? nfds : (nfds - 1)), POLL_MSEC)) <= 0)
2441 return;
2442 #endif
2443 else {
2444 if (Lst_Open(jobs) == FAILURE) {
2445 Punt("Cannot open job table");
2446 }
2447 while (nready && (ln = Lst_Next(jobs)) != NILLNODE) {
2448 job = (Job *) Lst_Datum(ln);
2449 #ifdef USE_SELECT
2450 if (FD_ISSET(job->inPipe, &readfds))
2451 #else
2452 if (readyfd(job))
2453 #endif
2454 {
2455 JobDoOutput(job, FALSE);
2456 nready -= 1;
2457 }
2458
2459 }
2460 Lst_Close(jobs);
2461 }
2462 }
2463 #endif /* RMT_WILL_WATCH */
2464 }
2465
2466 /*-
2467 *-----------------------------------------------------------------------
2468 * Job_Make --
2469 * Start the creation of a target. Basically a front-end for
2470 * JobStart used by the Make module.
2471 *
2472 * Results:
2473 * None.
2474 *
2475 * Side Effects:
2476 * Another job is started.
2477 *
2478 *-----------------------------------------------------------------------
2479 */
2480 void
2481 Job_Make(gn)
2482 GNode *gn;
2483 {
2484 (void) JobStart(gn, 0, NULL);
2485 }
2486
2487 /*-
2488 *-----------------------------------------------------------------------
2489 * Job_Init --
2490 * Initialize the process module
2491 *
2492 * Results:
2493 * none
2494 *
2495 * Side Effects:
2496 * lists and counters are initialized
2497 *-----------------------------------------------------------------------
2498 */
2499 void
2500 Job_Init(maxproc, maxlocal)
2501 int maxproc; /* the greatest number of jobs which may be
2502 * running at one time */
2503 int maxlocal; /* the greatest number of local jobs which may
2504 * be running at once. */
2505 {
2506 GNode *begin; /* node for commands to do at the very start */
2507
2508 jobs = Lst_Init(FALSE);
2509 stoppedJobs = Lst_Init(FALSE);
2510 maxJobs = maxproc;
2511 maxLocal = maxlocal;
2512 nJobs = 0;
2513 nLocal = 0;
2514 wantToken = FALSE;
2515
2516 aborting = 0;
2517 errors = 0;
2518
2519 lastNode = NILGNODE;
2520
2521 if (maxJobs == 1
2522 #ifdef REMOTE
2523 || noMessages
2524 #endif
2525 ) {
2526 /*
2527 * If only one job can run at a time, there's no need for a banner,
2528 * is there?
2529 */
2530 targFmt = "";
2531 } else {
2532 targFmt = TARG_FMT;
2533 }
2534
2535 if (shellPath == NULL) {
2536 /*
2537 * The user didn't specify a shell to use, so we are using the
2538 * default one... Both the absolute path and the last component
2539 * must be set. The last component is taken from the 'name' field
2540 * of the default shell description pointed-to by commandShell.
2541 * All default shells are located in _PATH_DEFSHELLDIR.
2542 */
2543 shellName = commandShell->name;
2544 shellPath = str_concat(_PATH_DEFSHELLDIR, shellName, STR_ADDSLASH);
2545 }
2546
2547 if (commandShell->exit == NULL) {
2548 commandShell->exit = "";
2549 }
2550 if (commandShell->echo == NULL) {
2551 commandShell->echo = "";
2552 }
2553
2554 /*
2555 * Catch the four signals that POSIX specifies if they aren't ignored.
2556 * JobPassSig will take care of calling JobInterrupt if appropriate.
2557 */
2558 if (signal(SIGINT, SIG_IGN) != SIG_IGN) {
2559 (void) signal(SIGINT, JobPassSig);
2560 }
2561 if (signal(SIGHUP, SIG_IGN) != SIG_IGN) {
2562 (void) signal(SIGHUP, JobPassSig);
2563 }
2564 if (signal(SIGQUIT, SIG_IGN) != SIG_IGN) {
2565 (void) signal(SIGQUIT, JobPassSig);
2566 }
2567 if (signal(SIGTERM, SIG_IGN) != SIG_IGN) {
2568 (void) signal(SIGTERM, JobPassSig);
2569 }
2570 /*
2571 * Install a NOOP SIGCHLD handler so we are woken up if we're blocked.
2572 */
2573 signal(SIGCHLD, JobIgnoreSig);
2574
2575 /*
2576 * There are additional signals that need to be caught and passed if
2577 * either the export system wants to be told directly of signals or if
2578 * we're giving each job its own process group (since then it won't get
2579 * signals from the terminal driver as we own the terminal)
2580 */
2581 #if defined(RMT_WANTS_SIGNALS) || defined(USE_PGRP)
2582 if (signal(SIGTSTP, SIG_IGN) != SIG_IGN) {
2583 (void) signal(SIGTSTP, JobPassSig);
2584 }
2585 if (signal(SIGTTOU, SIG_IGN) != SIG_IGN) {
2586 (void) signal(SIGTTOU, JobPassSig);
2587 }
2588 if (signal(SIGTTIN, SIG_IGN) != SIG_IGN) {
2589 (void) signal(SIGTTIN, JobPassSig);
2590 }
2591 if (signal(SIGWINCH, SIG_IGN) != SIG_IGN) {
2592 (void) signal(SIGWINCH, JobPassSig);
2593 }
2594 if (signal(SIGCONT, SIG_IGN) != SIG_IGN) {
2595 (void) signal(SIGCONT, JobContinueSig);
2596 }
2597 #endif
2598
2599 begin = Targ_FindNode(".BEGIN", TARG_NOCREATE);
2600
2601 if (begin != NILGNODE) {
2602 JobStart(begin, JOB_SPECIAL, (Job *)0);
2603 while (nJobs) {
2604 Job_CatchOutput();
2605 #ifndef RMT_WILL_WATCH
2606 Job_CatchChildren(!usePipes);
2607 #endif /* RMT_WILL_WATCH */
2608 }
2609 }
2610 postCommands = Targ_FindNode(".END", TARG_CREATE);
2611 }
2612
2613 /*-
2614 *-----------------------------------------------------------------------
2615 * Job_Empty --
2616 * See if the job table is empty. Because the local concurrency may
2617 * be set to 0, it is possible for the job table to become empty,
2618 * while the list of stoppedJobs remains non-empty. In such a case,
2619 * we want to restart as many jobs as we can.
2620 *
2621 * Results:
2622 * TRUE if it is. FALSE if it ain't.
2623 *
2624 * Side Effects:
2625 * None.
2626 *
2627 * -----------------------------------------------------------------------
2628 */
2629 Boolean
2630 Job_Empty()
2631 {
2632 if (nJobs == 0) {
2633 if (!Lst_IsEmpty(stoppedJobs) && !aborting) {
2634 /*
2635 * The job table is obviously not full if it has no jobs in
2636 * it...Try and restart the stopped jobs.
2637 */
2638 JobRestartJobs();
2639 return(FALSE);
2640 } else {
2641 return(TRUE);
2642 }
2643 } else {
2644 return(FALSE);
2645 }
2646 }
2647
2648 /*-
2649 *-----------------------------------------------------------------------
2650 * JobMatchShell --
2651 * Find a matching shell in 'shells' given its final component.
2652 *
2653 * Results:
2654 * A pointer to the Shell structure.
2655 *
2656 * Side Effects:
2657 * None.
2658 *
2659 *-----------------------------------------------------------------------
2660 */
2661 static Shell *
2662 JobMatchShell(name)
2663 char *name; /* Final component of shell path */
2664 {
2665 register Shell *sh; /* Pointer into shells table */
2666 Shell *match; /* Longest-matching shell */
2667 register char *cp1,
2668 *cp2;
2669 char *eoname;
2670
2671 eoname = name + strlen(name);
2672
2673 match = NULL;
2674
2675 for (sh = shells; sh->name != NULL; sh++) {
2676 for (cp1 = eoname - strlen(sh->name), cp2 = sh->name;
2677 *cp1 != '\0' && *cp1 == *cp2;
2678 cp1++, cp2++) {
2679 continue;
2680 }
2681 if (*cp1 != *cp2) {
2682 continue;
2683 } else if (match == NULL || strlen(match->name) < strlen(sh->name)) {
2684 match = sh;
2685 }
2686 }
2687 return(match == NULL ? sh : match);
2688 }
2689
2690 /*-
2691 *-----------------------------------------------------------------------
2692 * Job_ParseShell --
2693 * Parse a shell specification and set up commandShell, shellPath
2694 * and shellName appropriately.
2695 *
2696 * Results:
2697 * FAILURE if the specification was incorrect.
2698 *
2699 * Side Effects:
2700 * commandShell points to a Shell structure (either predefined or
2701 * created from the shell spec), shellPath is the full path of the
2702 * shell described by commandShell, while shellName is just the
2703 * final component of shellPath.
2704 *
2705 * Notes:
2706 * A shell specification consists of a .SHELL target, with dependency
2707 * operator, followed by a series of blank-separated words. Double
2708 * quotes can be used to use blanks in words. A backslash escapes
2709 * anything (most notably a double-quote and a space) and
2710 * provides the functionality it does in C. Each word consists of
2711 * keyword and value separated by an equal sign. There should be no
2712 * unnecessary spaces in the word. The keywords are as follows:
2713 * name Name of shell.
2714 * path Location of shell. Overrides "name" if given
2715 * quiet Command to turn off echoing.
2716 * echo Command to turn echoing on
2717 * filter Result of turning off echoing that shouldn't be
2718 * printed.
2719 * echoFlag Flag to turn echoing on at the start
2720 * errFlag Flag to turn error checking on at the start
2721 * hasErrCtl True if shell has error checking control
2722 * check Command to turn on error checking if hasErrCtl
2723 * is TRUE or template of command to echo a command
2724 * for which error checking is off if hasErrCtl is
2725 * FALSE.
2726 * ignore Command to turn off error checking if hasErrCtl
2727 * is TRUE or template of command to execute a
2728 * command so as to ignore any errors it returns if
2729 * hasErrCtl is FALSE.
2730 *
2731 *-----------------------------------------------------------------------
2732 */
2733 ReturnStatus
2734 Job_ParseShell(line)
2735 char *line; /* The shell spec */
2736 {
2737 char **words;
2738 int wordCount;
2739 register char **argv;
2740 register int argc;
2741 char *path;
2742 Shell newShell;
2743 Boolean fullSpec = FALSE;
2744
2745 while (isspace((unsigned char)*line)) {
2746 line++;
2747 }
2748
2749 if (shellArgv)
2750 free(shellArgv);
2751
2752 words = brk_string(line, &wordCount, TRUE, &shellArgv);
2753
2754 memset((Address)&newShell, 0, sizeof(newShell));
2755
2756 /*
2757 * Parse the specification by keyword
2758 */
2759 for (path = NULL, argc = wordCount - 1, argv = words;
2760 argc != 0;
2761 argc--, argv++) {
2762 if (strncmp(*argv, "path=", 5) == 0) {
2763 path = &argv[0][5];
2764 } else if (strncmp(*argv, "name=", 5) == 0) {
2765 newShell.name = &argv[0][5];
2766 } else {
2767 if (strncmp(*argv, "quiet=", 6) == 0) {
2768 newShell.echoOff = &argv[0][6];
2769 } else if (strncmp(*argv, "echo=", 5) == 0) {
2770 newShell.echoOn = &argv[0][5];
2771 } else if (strncmp(*argv, "filter=", 7) == 0) {
2772 newShell.noPrint = &argv[0][7];
2773 newShell.noPLen = strlen(newShell.noPrint);
2774 } else if (strncmp(*argv, "echoFlag=", 9) == 0) {
2775 newShell.echo = &argv[0][9];
2776 } else if (strncmp(*argv, "errFlag=", 8) == 0) {
2777 newShell.exit = &argv[0][8];
2778 } else if (strncmp(*argv, "hasErrCtl=", 10) == 0) {
2779 char c = argv[0][10];
2780 newShell.hasErrCtl = !((c != 'Y') && (c != 'y') &&
2781 (c != 'T') && (c != 't'));
2782 } else if (strncmp(*argv, "check=", 6) == 0) {
2783 newShell.errCheck = &argv[0][6];
2784 } else if (strncmp(*argv, "ignore=", 7) == 0) {
2785 newShell.ignErr = &argv[0][7];
2786 } else {
2787 Parse_Error(PARSE_FATAL, "Unknown keyword \"%s\"",
2788 *argv);
2789 free(words);
2790 return(FAILURE);
2791 }
2792 fullSpec = TRUE;
2793 }
2794 }
2795
2796 if (path == NULL) {
2797 /*
2798 * If no path was given, the user wants one of the pre-defined shells,
2799 * yes? So we find the one s/he wants with the help of JobMatchShell
2800 * and set things up the right way. shellPath will be set up by
2801 * Job_Init.
2802 */
2803 if (newShell.name == NULL) {
2804 Parse_Error(PARSE_FATAL, "Neither path nor name specified");
2805 return(FAILURE);
2806 } else {
2807 commandShell = JobMatchShell(newShell.name);
2808 shellName = newShell.name;
2809 }
2810 } else {
2811 /*
2812 * The user provided a path. If s/he gave nothing else (fullSpec is
2813 * FALSE), try and find a matching shell in the ones we know of.
2814 * Else we just take the specification at its word and copy it
2815 * to a new location. In either case, we need to record the
2816 * path the user gave for the shell.
2817 */
2818 shellPath = path;
2819 path = strrchr(path, '/');
2820 if (path == NULL) {
2821 path = shellPath;
2822 } else {
2823 path += 1;
2824 }
2825 if (newShell.name != NULL) {
2826 shellName = newShell.name;
2827 } else {
2828 shellName = path;
2829 }
2830 if (!fullSpec) {
2831 commandShell = JobMatchShell(shellName);
2832 } else {
2833 commandShell = (Shell *) emalloc(sizeof(Shell));
2834 *commandShell = newShell;
2835 }
2836 }
2837
2838 if (commandShell->echoOn && commandShell->echoOff) {
2839 commandShell->hasEchoCtl = TRUE;
2840 }
2841
2842 if (!commandShell->hasErrCtl) {
2843 if (commandShell->errCheck == NULL) {
2844 commandShell->errCheck = "";
2845 }
2846 if (commandShell->ignErr == NULL) {
2847 commandShell->ignErr = "%s\n";
2848 }
2849 }
2850
2851 /*
2852 * Do not free up the words themselves, since they might be in use by the
2853 * shell specification.
2854 */
2855 free(words);
2856 return SUCCESS;
2857 }
2858
2859 /*-
2860 *-----------------------------------------------------------------------
2861 * JobInterrupt --
2862 * Handle the receipt of an interrupt.
2863 *
2864 * Results:
2865 * None
2866 *
2867 * Side Effects:
2868 * All children are killed. Another job will be started if the
2869 * .INTERRUPT target was given.
2870 *-----------------------------------------------------------------------
2871 */
2872 static void
2873 JobInterrupt(runINTERRUPT, signo)
2874 int runINTERRUPT; /* Non-zero if commands for the .INTERRUPT
2875 * target should be executed */
2876 int signo; /* signal received */
2877 {
2878 LstNode ln; /* element in job table */
2879 Job *job; /* job descriptor in that element */
2880 GNode *interrupt; /* the node describing the .INTERRUPT target */
2881
2882 aborting = ABORT_INTERRUPT;
2883
2884 (void) Lst_Open(jobs);
2885 while ((ln = Lst_Next(jobs)) != NILLNODE) {
2886 job = (Job *) Lst_Datum(ln);
2887
2888 if (!Targ_Precious(job->node)) {
2889 char *file = (job->node->path == NULL ?
2890 job->node->name :
2891 job->node->path);
2892 if (!noExecute && eunlink(file) != -1) {
2893 Error("*** %s removed", file);
2894 }
2895 }
2896 #ifdef RMT_WANTS_SIGNALS
2897 if (job->flags & JOB_REMOTE) {
2898 /*
2899 * If job is remote, let the Rmt module do the killing.
2900 */
2901 if (!Rmt_Signal(job, signo)) {
2902 /*
2903 * If couldn't kill the thing, finish it out now with an
2904 * error code, since no exit report will come in likely.
2905 */
2906 int status;
2907
2908 status.w_status = 0;
2909 status.w_retcode = 1;
2910 JobFinish(job, &status);
2911 }
2912 } else if (job->pid) {
2913 KILL(job->pid, signo);
2914 }
2915 #else
2916 if (job->pid) {
2917 if (DEBUG(JOB)) {
2918 (void) fprintf(stdout,
2919 "JobInterrupt passing signal to child %d.\n",
2920 job->pid);
2921 (void) fflush(stdout);
2922 }
2923 KILL(job->pid, signo);
2924 }
2925 #endif /* RMT_WANTS_SIGNALS */
2926 }
2927
2928 #ifdef REMOTE
2929 (void)Lst_Open(stoppedJobs);
2930 while ((ln = Lst_Next(stoppedJobs)) != NILLNODE) {
2931 job = (Job *) Lst_Datum(ln);
2932
2933 if (job->flags & JOB_RESTART) {
2934 if (DEBUG(JOB)) {
2935 (void) fprintf(stdout, "%s%s",
2936 "JobInterrupt skipping job on stopped queue",
2937 "-- it was waiting to be restarted.\n");
2938 (void) fflush(stdout);
2939 }
2940 continue;
2941 }
2942 if (!Targ_Precious(job->node)) {
2943 char *file = (job->node->path == NULL ?
2944 job->node->name :
2945 job->node->path);
2946 if (eunlink(file) == 0) {
2947 Error("*** %s removed", file);
2948 }
2949 }
2950 /*
2951 * Resume the thing so it will take the signal.
2952 */
2953 if (DEBUG(JOB)) {
2954 (void) fprintf(stdout,
2955 "JobInterrupt passing CONT to stopped child %d.\n",
2956 job->pid);
2957 (void) fflush(stdout);
2958 }
2959 KILL(job->pid, SIGCONT);
2960 #ifdef RMT_WANTS_SIGNALS
2961 if (job->flags & JOB_REMOTE) {
2962 /*
2963 * If job is remote, let the Rmt module do the killing.
2964 */
2965 if (!Rmt_Signal(job, SIGINT)) {
2966 /*
2967 * If couldn't kill the thing, finish it out now with an
2968 * error code, since no exit report will come in likely.
2969 */
2970 int status;
2971 status.w_status = 0;
2972 status.w_retcode = 1;
2973 JobFinish(job, &status);
2974 }
2975 } else if (job->pid) {
2976 if (DEBUG(JOB)) {
2977 (void) fprintf(stdout,
2978 "JobInterrupt passing interrupt to stopped child %d.\n",
2979 job->pid);
2980 (void) fflush(stdout);
2981 }
2982 KILL(job->pid, SIGINT);
2983 }
2984 #endif /* RMT_WANTS_SIGNALS */
2985 }
2986 #endif
2987 Lst_Close(stoppedJobs);
2988
2989 if (runINTERRUPT && !touchFlag) {
2990 interrupt = Targ_FindNode(".INTERRUPT", TARG_NOCREATE);
2991 if (interrupt != NILGNODE) {
2992 ignoreErrors = FALSE;
2993
2994 JobStart(interrupt, JOB_IGNDOTS, (Job *)0);
2995 while (nJobs) {
2996 Job_CatchOutput();
2997 #ifndef RMT_WILL_WATCH
2998 Job_CatchChildren(!usePipes);
2999 #endif /* RMT_WILL_WATCH */
3000 }
3001 }
3002 }
3003 Trace_Log(MAKEINTR, 0);
3004 exit(signo);
3005 }
3006
3007 /*
3008 *-----------------------------------------------------------------------
3009 * Job_Finish --
3010 * Do final processing such as the running of the commands
3011 * attached to the .END target.
3012 *
3013 * Results:
3014 * Number of errors reported.
3015 *
3016 * Side Effects:
3017 * None.
3018 *-----------------------------------------------------------------------
3019 */
3020 int
3021 Job_Finish()
3022 {
3023 if (postCommands != NILGNODE && !Lst_IsEmpty(postCommands->commands)) {
3024 if (errors) {
3025 Error("Errors reported so .END ignored");
3026 } else {
3027 JobStart(postCommands, JOB_SPECIAL | JOB_IGNDOTS, NULL);
3028
3029 while (nJobs) {
3030 Job_CatchOutput();
3031 #ifndef RMT_WILL_WATCH
3032 Job_CatchChildren(!usePipes);
3033 #endif /* RMT_WILL_WATCH */
3034 }
3035 }
3036 }
3037 Job_TokenFlush();
3038 return(errors);
3039 }
3040
3041 /*-
3042 *-----------------------------------------------------------------------
3043 * Job_End --
3044 * Cleanup any memory used by the jobs module
3045 *
3046 * Results:
3047 * None.
3048 *
3049 * Side Effects:
3050 * Memory is freed
3051 *-----------------------------------------------------------------------
3052 */
3053 void
3054 Job_End()
3055 {
3056 #ifdef CLEANUP
3057 if (shellArgv)
3058 free(shellArgv);
3059 #endif
3060 }
3061
3062 /*-
3063 *-----------------------------------------------------------------------
3064 * Job_Wait --
3065 * Waits for all running jobs to finish and returns. Sets 'aborting'
3066 * to ABORT_WAIT to prevent other jobs from starting.
3067 *
3068 * Results:
3069 * None.
3070 *
3071 * Side Effects:
3072 * Currently running jobs finish.
3073 *
3074 *-----------------------------------------------------------------------
3075 */
3076 void
3077 Job_Wait()
3078 {
3079 aborting = ABORT_WAIT;
3080 while (nJobs != 0) {
3081 Job_CatchOutput();
3082 #ifndef RMT_WILL_WATCH
3083 Job_CatchChildren(!usePipes);
3084 #endif /* RMT_WILL_WATCH */
3085 }
3086 Job_TokenFlush();
3087 aborting = 0;
3088 }
3089
3090 /*-
3091 *-----------------------------------------------------------------------
3092 * Job_AbortAll --
3093 * Abort all currently running jobs without handling output or anything.
3094 * This function is to be called only in the event of a major
3095 * error. Most definitely NOT to be called from JobInterrupt.
3096 *
3097 * Results:
3098 * None
3099 *
3100 * Side Effects:
3101 * All children are killed, not just the firstborn
3102 *-----------------------------------------------------------------------
3103 */
3104 void
3105 Job_AbortAll()
3106 {
3107 LstNode ln; /* element in job table */
3108 Job *job; /* the job descriptor in that element */
3109 int foo;
3110
3111 aborting = ABORT_ERROR;
3112
3113 if (nJobs) {
3114
3115 (void) Lst_Open(jobs);
3116 while ((ln = Lst_Next(jobs)) != NILLNODE) {
3117 job = (Job *) Lst_Datum(ln);
3118
3119 /*
3120 * kill the child process with increasingly drastic signals to make
3121 * darn sure it's dead.
3122 */
3123 #ifdef RMT_WANTS_SIGNALS
3124 if (job->flags & JOB_REMOTE) {
3125 Rmt_Signal(job, SIGINT);
3126 Rmt_Signal(job, SIGKILL);
3127 } else {
3128 KILL(job->pid, SIGINT);
3129 KILL(job->pid, SIGKILL);
3130 }
3131 #else
3132 KILL(job->pid, SIGINT);
3133 KILL(job->pid, SIGKILL);
3134 #endif /* RMT_WANTS_SIGNALS */
3135 }
3136 }
3137
3138 /*
3139 * Catch as many children as want to report in at first, then give up
3140 */
3141 while (waitpid((pid_t) -1, &foo, WNOHANG) > 0)
3142 continue;
3143 }
3144
3145 #ifdef REMOTE
3146 /*-
3147 *-----------------------------------------------------------------------
3148 * JobFlagForMigration --
3149 * Handle the eviction of a child. Called from RmtStatusChange.
3150 * Flags the child as remigratable and then suspends it.
3151 *
3152 * Results:
3153 * none.
3154 *
3155 * Side Effects:
3156 * The job descriptor is flagged for remigration.
3157 *
3158 *-----------------------------------------------------------------------
3159 */
3160 void
3161 JobFlagForMigration(hostID)
3162 int hostID; /* ID of host we used, for matching children. */
3163 {
3164 register Job *job; /* job descriptor for dead child */
3165 LstNode jnode; /* list element for finding job */
3166
3167 if (DEBUG(JOB)) {
3168 (void) fprintf(stdout, "JobFlagForMigration(%d) called.\n", hostID);
3169 (void) fflush(stdout);
3170 }
3171 jnode = Lst_Find(jobs, (ClientData)hostID, JobCmpRmtID);
3172
3173 if (jnode == NILLNODE) {
3174 jnode = Lst_Find(stoppedJobs, (ClientData)hostID, JobCmpRmtID);
3175 if (jnode == NILLNODE) {
3176 if (DEBUG(JOB)) {
3177 Error("Evicting host(%d) not in table", hostID);
3178 }
3179 return;
3180 }
3181 }
3182 job = (Job *) Lst_Datum(jnode);
3183
3184 if (DEBUG(JOB)) {
3185 (void) fprintf(stdout,
3186 "JobFlagForMigration(%d) found job '%s'.\n", hostID,
3187 job->node->name);
3188 (void) fflush(stdout);
3189 }
3190
3191 KILL(job->pid, SIGSTOP);
3192
3193 job->flags |= JOB_REMIGRATE;
3194 }
3195
3196 #endif
3197
3198 /*-
3200 *-----------------------------------------------------------------------
3201 * JobRestartJobs --
3202 * Tries to restart stopped jobs if there are slots available.
3203 * Note that this tries to restart them regardless of pending errors.
3204 * It's not good to leave stopped jobs lying around!
3205 *
3206 * Results:
3207 * None.
3208 *
3209 * Side Effects:
3210 * Resumes(and possibly migrates) jobs.
3211 *
3212 *-----------------------------------------------------------------------
3213 */
3214 static void
3215 JobRestartJobs()
3216 {
3217 while (!Lst_IsEmpty(stoppedJobs)) {
3218 if (DEBUG(JOB)) {
3219 (void) fprintf(stdout, "Restarting a stopped job.\n");
3220 (void) fflush(stdout);
3221 }
3222 JobRestart((Job *)Lst_DeQueue(stoppedJobs));
3223 }
3224 }
3225
3226 #ifndef RMT_WILL_WATCH
3227 #ifndef USE_SELECT
3228 static void
3229 watchfd(job)
3230 Job *job;
3231 {
3232 int i;
3233 if (job->inPollfd != NULL)
3234 Punt("Watching watched job");
3235 if (fds == NULL) {
3236 maxfds = JBSTART;
3237 fds = emalloc(sizeof(struct pollfd) * maxfds);
3238 jobfds = emalloc(sizeof(Job **) * maxfds);
3239
3240 fds[0].fd = job_pipe[0];
3241 fds[0].events = POLLIN;
3242 jobfds[0] = &tokenWaitJob;
3243 tokenWaitJob.inPollfd = &fds[0];
3244 nfds++;
3245 } else if (nfds == maxfds) {
3246 maxfds *= JBFACTOR;
3247 fds = erealloc(fds, sizeof(struct pollfd) * maxfds);
3248 jobfds = erealloc(jobfds, sizeof(Job **) * maxfds);
3249 for (i = 0; i < nfds; i++)
3250 jobfds[i]->inPollfd = &fds[i];
3251 }
3252
3253 fds[nfds].fd = job->inPipe;
3254 fds[nfds].events = POLLIN;
3255 jobfds[nfds] = job;
3256 job->inPollfd = &fds[nfds];
3257 nfds++;
3258 }
3259
3260 static void
3261 clearfd(job)
3262 Job *job;
3263 {
3264 int i;
3265 if (job->inPollfd == NULL)
3266 Punt("Unwatching unwatched job");
3267 i = job->inPollfd - fds;
3268 nfds--;
3269 /*
3270 * Move last job in table into hole made by dead job.
3271 */
3272 if (nfds != i) {
3273 fds[i] = fds[nfds];
3274 jobfds[i] = jobfds[nfds];
3275 jobfds[i]->inPollfd = &fds[i];
3276 }
3277 job->inPollfd = NULL;
3278 }
3279
3280 static int
3281 readyfd(job)
3282 Job *job;
3283 {
3284 if (job->inPollfd == NULL)
3285 Punt("Polling unwatched job");
3286 return (job->inPollfd->revents & POLLIN) != 0;
3287 }
3288 #endif
3289 #endif
3290
3291 /*-
3292 *-----------------------------------------------------------------------
3293 * JobTokenAdd --
3294 * Put a token into the job pipe so that some make process can start
3295 * another job.
3296 *
3297 * Side Effects:
3298 * Allows more build jobs to be spawned somewhere.
3299 *
3300 *-----------------------------------------------------------------------
3301 */
3302
3303 static void
3304 JobTokenAdd()
3305 {
3306
3307 if (DEBUG(JOB))
3308 printf("deposit token\n");
3309 write(job_pipe[1], "+", 1);
3310 }
3311
3312 /*-
3313 *-----------------------------------------------------------------------
3314 * Job_ServerStartTokenAdd --
3315 * Prep the job token pipe in the root make process.
3316 *
3317 *-----------------------------------------------------------------------
3318 */
3319
3320 void Job_ServerStart(maxproc)
3321 int maxproc;
3322 {
3323 int i, flags;
3324 char jobarg[64];
3325
3326 if (pipe(job_pipe) < 0)
3327 Fatal ("error in pipe: %s", strerror(errno));
3328
3329 /*
3330 * We mark the input side of the pipe non-blocking; we poll(2) the
3331 * pipe when we're waiting for a job token, but we might lose the
3332 * race for the token when a new one becomes available, so the read
3333 * from the pipe should not block.
3334 */
3335 flags = fcntl(job_pipe[0], F_GETFL, 0);
3336 flags |= O_NONBLOCK;
3337 fcntl(job_pipe[0], F_SETFL, flags);
3338
3339 /*
3340 * Mark job pipes as close-on-exec.
3341 * Note that we will clear this when executing submakes.
3342 */
3343 fcntl(job_pipe[0], F_SETFD, 1);
3344 fcntl(job_pipe[1], F_SETFD, 1);
3345
3346 snprintf(jobarg, sizeof(jobarg), "%d,%d", job_pipe[0], job_pipe[1]);
3347
3348 Var_Append(MAKEFLAGS, "-J", VAR_GLOBAL);
3349 Var_Append(MAKEFLAGS, jobarg, VAR_GLOBAL);
3350
3351 /*
3352 * Preload job_pipe with one token per job, save the one
3353 * "extra" token for the primary job.
3354 *
3355 * XXX should clip maxJobs against PIPE_BUF -- if maxJobs is
3356 * larger than the write buffer size of the pipe, we will
3357 * deadlock here.
3358 */
3359 for (i=1; i < maxproc; i++)
3360 JobTokenAdd();
3361 }
3362
3363 /*
3364 * this tracks the number of tokens currently "out" to build jobs.
3365 */
3366 int jobTokensRunning = 0;
3367 int jobTokensFree = 0;
3368 /*-
3369 *-----------------------------------------------------------------------
3370 * Job_TokenReturn --
3371 * Return a withdrawn token to the pool.
3372 *
3373 *-----------------------------------------------------------------------
3374 */
3375
3376 void
3377 Job_TokenReturn()
3378 {
3379 jobTokensRunning--;
3380 if (jobTokensRunning < 0)
3381 Punt("token botch");
3382 if (jobTokensRunning)
3383 jobTokensFree++;
3384 }
3385
3386 /*-
3387 *-----------------------------------------------------------------------
3388 * Job_TokenWithdraw --
3389 * Attempt to withdraw a token from the pool.
3390 *
3391 * Results:
3392 * Returns TRUE if a token was withdrawn, and FALSE if the pool
3393 * is currently empty.
3394 *
3395 * Side Effects:
3396 * If pool is empty, set wantToken so that we wake up
3397 * when a token is released.
3398 *
3399 *-----------------------------------------------------------------------
3400 */
3401
3402
3403 Boolean
3404 Job_TokenWithdraw()
3405 {
3406 char tok;
3407 int count;
3408
3409 if (aborting)
3410 return FALSE;
3411
3412 if (jobTokensRunning == 0) {
3413 if (DEBUG(JOB))
3414 printf("first one's free\n");
3415 jobTokensRunning++;
3416 wantToken = FALSE;
3417 return TRUE;
3418 }
3419 if (jobTokensFree > 0) {
3420 jobTokensFree--;
3421 jobTokensRunning++;
3422 wantToken = FALSE;
3423 return TRUE;
3424 }
3425 count = read(job_pipe[0], &tok, 1);
3426 if (count == 0)
3427 Fatal("eof on job pipe!");
3428 else if (count < 0) {
3429 if (errno != EAGAIN) {
3430 Fatal("job pipe read: %s", strerror(errno));
3431 }
3432 if (DEBUG(JOB))
3433 printf("blocked for token\n");
3434 wantToken = TRUE;
3435 return FALSE;
3436 }
3437 wantToken = FALSE;
3438 jobTokensRunning++;
3439 if (DEBUG(JOB))
3440 printf("withdrew token\n");
3441 return TRUE;
3442 }
3443
3444 /*-
3445 *-----------------------------------------------------------------------
3446 * Job_TokenFlush --
3447 * Return free tokens to the pool.
3448 *
3449 *-----------------------------------------------------------------------
3450 */
3451
3452 void
3453 Job_TokenFlush()
3454 {
3455 if (compatMake) return;
3456
3457 while (jobTokensFree > 0) {
3458 JobTokenAdd();
3459 jobTokensFree--;
3460 }
3461 }
3462
3463