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