2 * Copyright (c) 1988, 1989, 1990, 1993
3 * The Regents of the University of California. All rights reserved.
4 * Copyright (c) 1988, 1989 by Adam de Boor
5 * Copyright (c) 1989 by Berkeley Softworks
8 * This code is derived from software contributed to Berkeley by
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the University of
22 * California, Berkeley and its contributors.
23 * 4. Neither the name of the University nor the names of its contributors
24 * may be used to endorse or promote products derived from this software
25 * without specific prior written permission.
27 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39 * @(#)job.c 8.2 (Berkeley) 3/19/94
40 * $FreeBSD: src/usr.bin/make/job.c,v 1.75 2005/02/10 14:32:14 harti Exp $
41 * $DragonFly: src/usr.bin/make/job.c,v 1.75 2005/04/26 10:20:39 okumoto Exp $
50 * handle the creation etc. of our child processes.
53 * Job_Make Start the creation of the given target.
56 * Check for and handle the termination of any children.
57 * This must be called reasonably frequently to keep the
58 * whole make going at a decent clip, since job table
59 * entries aren't removed until their process is caught
60 * this way. Its single argument is TRUE if the function
61 * should block waiting for a child to terminate.
63 * Job_CatchOutput Print any output our children have produced. Should
64 * also be called fairly frequently to keep the user
65 * informed of what's going on. If no output is waiting,
66 * it will block for a time given by the SEL_* constants,
67 * below, or until output is ready.
69 * Job_Init Called to intialize this module. in addition, any
70 * commands attached to the .BEGIN target are executed
71 * before this function returns. Hence, the makefile must
72 * have been parsed before this function is called.
74 * Job_Full Return TRUE if the job table is filled.
76 * Job_Empty Return TRUE if the job table is completely empty.
78 * Job_ParseShell Given the line following a .SHELL target, parse the
79 * line as a shell specification. Returns FAILURE if the
82 * Job_Finish Perform any final processing which needs doing. This
83 * includes the execution of any commands which have
84 * been/were attached to the .END target. It should only
85 * be called when the job table is empty.
87 * Job_AbortAll Abort all currently running jobs. It doesn't handle
88 * output or do anything for the jobs, just kills them.
89 * It should only be called in an emergency, as it were.
92 * Verify that the commands for a target are ok. Provide
93 * them if necessary and possible.
95 * Job_Touch Update a target without really updating it.
97 * Job_Wait Wait for all currently-running jobs to finish.
100 #include <sys/queue.h>
101 #include <sys/types.h>
102 #include <sys/select.h>
103 #include <sys/stat.h>
105 #include <sys/event.h>
107 #include <sys/wait.h>
111 #include <inttypes.h>
127 #include "pathnames.h"
134 #define TMPPAT "/tmp/makeXXXXXXXXXX"
138 * The SEL_ constants determine the maximum amount of time spent in select
139 * before coming out to see if a child has finished. SEL_SEC is the number of
140 * seconds and SEL_USEC is the number of micro-seconds
144 #endif /* !USE_KQUEUE */
147 * Job Table definitions.
149 * The job "table" is kept as a linked Lst in 'jobs', with the number of
150 * active jobs maintained in the 'nJobs' variable. At no time will this
151 * exceed the value of 'maxJobs', initialized by the Job_Init function.
153 * When a job is finished, the Make_Update function is called on each of the
154 * parents of the node which was just remade. This takes care of the upward
155 * traversal of the dependency graph.
157 #define JOB_BUFSIZE 1024
159 pid_t pid; /* The child's process ID */
161 struct GNode *node; /* The target the child is making */
164 * A LstNode for the first command to be saved after the job completes.
165 * This is NULL if there was no "..." in the job's commands.
170 * An FILE* for writing out the commands. This is only
171 * used before the job is actually started.
176 * A word of flags which determine how the module handles errors,
177 * echoing, etc. for the job
179 short flags; /* Flags to control treatment of job */
180 #define JOB_IGNERR 0x001 /* Ignore non-zero exits */
181 #define JOB_SILENT 0x002 /* no output */
182 #define JOB_SPECIAL 0x004 /* Target is a special one. i.e. run it locally
183 * if we can't export it and maxLocal is 0 */
184 #define JOB_IGNDOTS 0x008 /* Ignore "..." lines when processing
186 #define JOB_FIRST 0x020 /* Job is first job for the node */
187 #define JOB_RESTART 0x080 /* Job needs to be completely restarted */
188 #define JOB_RESUME 0x100 /* Job needs to be resumed b/c it stopped,
190 #define JOB_CONTINUING 0x200 /* We are in the process of resuming this job.
191 * Used to avoid infinite recursion between
192 * JobFinish and JobRestart */
194 /* union for handling shell's output */
197 * This part is used when usePipes is true.
198 * The output is being caught via a pipe and the descriptors
199 * of our pipe, an array in which output is line buffered and
200 * the current position in that buffer are all maintained for
205 * Input side of pipe associated with
206 * job's output channel
211 * Output side of pipe associated with job's
217 * Buffer for storing the output of the
220 char op_outBuf[JOB_BUFSIZE + 1];
222 /* Current position in op_outBuf */
227 * If usePipes is false the output is routed to a temporary
228 * file and all that is kept is the name of the file and the
229 * descriptor open to the file.
232 /* Name of file to which shell output was rerouted */
233 char of_outFile[sizeof(TMPPAT)];
236 * Stream open to the output file. Used to funnel all
237 * from a single job to one file while still allowing
238 * multiple shell invocations
243 } output; /* Data for tracking a shell's output */
245 TAILQ_ENTRY(Job) link; /* list link */
248 #define outPipe output.o_pipe.op_outPipe
249 #define inPipe output.o_pipe.op_inPipe
250 #define outBuf output.o_pipe.op_outBuf
251 #define curPos output.o_pipe.op_curPos
252 #define outFile output.o_file.of_outFile
253 #define outFd output.o_file.of_outFd
255 TAILQ_HEAD(JobList, Job);
258 * Shell Specifications:
260 * Some special stuff goes on if a shell doesn't have error control. In such
261 * a case, errCheck becomes a printf template for echoing the command,
262 * should echoing be on and ignErr becomes another printf template for
263 * executing the command while ignoring the return status. If either of these
264 * strings is empty when hasErrCtl is FALSE, the command will be executed
265 * anyway as is and if it causes an error, so be it.
267 #define DEF_SHELL_STRUCT(TAG, CONST) \
270 * the name of the shell. For Bourne and C shells, this is used \
271 * only to find the shell description when used as the single \
272 * source of a .SHELL target. For user-defined shells, this is \
273 * the full path of the shell. \
277 /* True if both echoOff and echoOn defined */ \
278 Boolean hasEchoCtl; \
280 CONST char *echoOff; /* command to turn off echo */ \
281 CONST char *echoOn; /* command to turn it back on */\
284 * What the shell prints, and its length, when given the \
285 * echo-off command. This line will not be printed when \
286 * received from the shell. This is usually the command which \
287 * was executed to turn off echoing \
289 CONST char *noPrint; \
291 /* set if can control error checking for individual commands */ \
294 /* string to turn error checking on */ \
295 CONST char *errCheck; \
297 /* string to turn off error checking */ \
298 CONST char *ignErr; \
300 CONST char *echo; /* command line flag: echo commands */ \
301 CONST char *exit; /* command line flag: exit on error */ \
304 DEF_SHELL_STRUCT(Shell,);
305 DEF_SHELL_STRUCT(CShell, const);
308 * error handling variables
310 static int errors = 0; /* number of errors reported */
311 static int aborting = 0; /* why is the make aborting? */
312 #define ABORT_ERROR 1 /* Because of an error */
313 #define ABORT_INTERRUPT 2 /* Because it was interrupted */
314 #define ABORT_WAIT 3 /* Waiting for jobs to finish */
317 * XXX: Avoid SunOS bug... FILENO() is fp->_file, and file
318 * is a char! So when we go above 127 we turn negative!
320 #define FILENO(a) ((unsigned)fileno(a))
323 * post-make command processing. The node postCommands is really just the
324 * .END target but we keep it around to avoid having to search for it
327 static GNode *postCommands;
330 * The number of commands actually printed for a target. Should this
331 * number be 0, no shell will be executed.
333 static int numCommands;
336 * Return values from JobStart.
338 #define JOB_RUNNING 0 /* Job is running */
339 #define JOB_ERROR 1 /* Error in starting the job */
340 #define JOB_FINISHED 2 /* The job is already finished */
341 #define JOB_STOPPED 3 /* The job is stopped */
344 * Descriptions for various shells.
346 static const struct CShell shells[] = {
348 * CSH description. The csh can do echo control by playing
349 * with the setting of the 'echo' shell variable. Sadly,
350 * however, it is unable to do error control nicely.
354 TRUE, "unset verbose", "set verbose", "unset verbose",
355 FALSE, "echo \"%s\"\n", "csh -c \"%s || exit 0\"",
359 * SH description. Echo control is also possible and, under
360 * sun UNIX anyway, one can even control error checking.
364 TRUE, "set -", "set -v", "set -",
365 TRUE, "set -e", "set +e",
366 #ifdef OLDBOURNESHELL
367 FALSE, "echo \"%s\"\n", "sh -c '%s || exit 0'\n",
372 * KSH description. The Korn shell has a superset of
373 * the Bourne shell's functionality.
377 TRUE, "set -", "set -v", "set -",
378 TRUE, "set -e", "set +e",
384 * This is the shell to which we pass all commands in the Makefile.
385 * It is set by the Job_ParseShell function.
387 static struct Shell *commandShell = NULL;
388 static char *shellPath = NULL; /* full pathname of executable image */
389 static char *shellName = NULL; /* last component of shell */
391 int maxJobs; /* The most children we can run at once */
392 static int nJobs; /* The number of children currently running */
394 /* The structures that describe them */
395 static struct JobList jobs = TAILQ_HEAD_INITIALIZER(jobs);
397 static Boolean jobFull; /* Flag to tell when the job table is full. It
398 * is set TRUE when (1) the total number of
399 * running jobs equals the maximum allowed */
401 static int kqfd; /* File descriptor obtained by kqueue() */
403 static fd_set outputs; /* Set of descriptors of pipes connected to
404 * the output channels of children */
407 static GNode *lastNode; /* The node for which output was most recently
409 static const char *targFmt; /* Format string to use to head output from a
410 * job when it's not the most-recent job heard
413 #define TARG_FMT "--- %s ---\n" /* Default format */
414 #define MESSAGE(fp, gn) \
415 fprintf(fp, targFmt, gn->name);
418 * When JobStart attempts to run a job but isn't allowed to
419 * or when Job_CatchChildren detects a job that has
420 * been stopped somehow, the job is placed on the stoppedJobs queue to be run
421 * when the next job finishes.
423 * Lst of Job structures describing jobs that were stopped due to
424 * concurrency limits or externally
426 static struct JobList stoppedJobs = TAILQ_HEAD_INITIALIZER(stoppedJobs);
428 static int fifoFd; /* Fd of our job fifo */
429 static char fifoName[] = "/tmp/make_fifo_XXXXXXXXX";
430 static int fifoMaster;
432 static sig_atomic_t interrupted;
435 #if defined(USE_PGRP) && defined(SYSV)
436 # define KILL(pid, sig) killpg(-(pid), (sig))
438 # if defined(USE_PGRP)
439 # define KILL(pid, sig) killpg((pid), (sig))
441 # define KILL(pid, sig) kill((pid), (sig))
446 * Grmpf... There is no way to set bits of the wait structure
447 * anymore with the stupid W*() macros. I liked the union wait
448 * stuff much more. So, we devise our own macros... This is
449 * really ugly, use dramamine sparingly. You have been warned.
451 #define W_SETMASKED(st, val, fun) \
454 int mask = fun(sh); \
456 for (sh = 0; ((mask >> sh) & 1) == 0; sh++) \
458 *(st) = (*(st) & ~mask) | ((val) << sh); \
461 #define W_SETTERMSIG(st, val) W_SETMASKED(st, val, WTERMSIG)
462 #define W_SETEXITSTATUS(st, val) W_SETMASKED(st, val, WEXITSTATUS)
465 * Information used to create a new process.
467 typedef struct ProcStuff {
468 int in; /* stdin for new process */
469 int out; /* stdout for new process */
470 int err; /* stderr for new process */
472 int merge_errors; /* true if stderr is redirected to stdin */
473 int pgroup; /* true if new process a process leader */
474 int searchpath; /* true if binary should be found via $PATH */
479 static void JobRestart(Job *);
480 static int JobStart(GNode *, int, Job *);
481 static void JobDoOutput(Job *, Boolean);
482 static struct Shell *JobMatchShell(const char *);
483 static void JobInterrupt(int, int);
484 static void JobRestartJobs(void);
485 static void ProcExec(ProcStuff *) __dead2;
488 * Replace the current process.
491 ProcExec(ProcStuff *ps)
493 if (ps->in != STDIN_FILENO) {
495 * Redirect the child's stdin to the input fd
496 * and reset it to the beginning (again).
498 if (dup2(ps->in, STDIN_FILENO) == -1)
499 Punt("Cannot dup2: %s", strerror(errno));
500 lseek(STDIN_FILENO, (off_t)0, SEEK_SET);
503 if (ps->out != STDOUT_FILENO) {
505 * Redirect the child's stdout to the output fd.
507 if (dup2(ps->out, STDOUT_FILENO) == -1)
508 Punt("Cannot dup2: %s", strerror(errno));
512 if (ps->err != STDERR_FILENO) {
514 * Redirect the child's stderr to the err fd.
516 if (dup2(ps->err, STDERR_FILENO) == -1)
517 Punt("Cannot dup2: %s", strerror(errno));
521 if (ps->merge_errors) {
523 * Send stderr to parent process too.
525 if (dup2(STDOUT_FILENO, STDERR_FILENO) == -1)
526 Punt("Cannot dup2: %s", strerror(errno));
530 * The file descriptors for stdin, stdout, or stderr might
531 * have been marked close-on-exec. Clear the flag on all
534 fcntl(STDIN_FILENO, F_SETFD,
535 fcntl(STDIN_FILENO, F_GETFD) & (~FD_CLOEXEC));
536 fcntl(STDOUT_FILENO, F_SETFD,
537 fcntl(STDOUT_FILENO, F_GETFD) & (~FD_CLOEXEC));
538 fcntl(STDERR_FILENO, F_SETFD,
539 fcntl(STDERR_FILENO, F_GETFD) & (~FD_CLOEXEC));
544 * Become a process group leader, so we can kill it and all
545 * its descendants in one fell swoop, by killing its process
546 * family, but not commit suicide.
551 setpgid(0, getpid());
553 #endif /* USE_PGRP */
556 if (ps->searchpath) {
557 execvp(ps->argv[0], ps->argv);
559 write(STDERR_FILENO, ps->argv[0], strlen(ps->argv[0]));
560 write(STDERR_FILENO, ":", 1);
561 write(STDERR_FILENO, strerror(errno), strlen(strerror(errno)));
562 write(STDERR_FILENO, "\n", 1);
564 execv(shellPath, ps->argv);
567 "Could not execute shell\n",
568 sizeof("Could not execute shell"));
572 * Since we are the child process, exit without flushing buffers.
579 * Got a signal. Set global variables and hope that someone will
583 JobCatchSig(int signo)
591 * Pass a signal on to all local jobs if
592 * USE_PGRP is defined, then die ourselves.
595 * We die by the same signal.
598 JobPassSig(int signo)
601 sigset_t nmask, omask;
602 struct sigaction act;
605 sigaddset(&nmask, signo);
606 sigprocmask(SIG_SETMASK, &nmask, &omask);
608 DEBUGF(JOB, ("JobPassSig(%d) called.\n", signo));
609 TAILQ_FOREACH(job, &jobs, link) {
610 DEBUGF(JOB, ("JobPassSig passing signal %d to child %jd.\n",
611 signo, (intmax_t)job->pid));
612 KILL(job->pid, signo);
616 * Deal with proper cleanup based on the signal received. We only run
617 * the .INTERRUPT target if the signal was in fact an interrupt.
618 * The other three termination signals are more of a "get out *now*"
621 if (signo == SIGINT) {
622 JobInterrupt(TRUE, signo);
623 } else if (signo == SIGHUP || signo == SIGTERM || signo == SIGQUIT) {
624 JobInterrupt(FALSE, signo);
628 * Leave gracefully if SIGQUIT, rather than core dumping.
630 if (signo == SIGQUIT) {
635 * Send ourselves the signal now we've given the message to everyone
636 * else. Note we block everything else possible while we're getting
637 * the signal. This ensures that all our jobs get continued when we
638 * wake up before we take any other signal.
639 * XXX this comment seems wrong.
641 act.sa_handler = SIG_DFL;
642 sigemptyset(&act.sa_mask);
644 sigaction(signo, &act, NULL);
646 DEBUGF(JOB, ("JobPassSig passing signal to self, mask = %x.\n",
647 ~0 & ~(1 << (signo - 1))));
648 signal(signo, SIG_DFL);
650 KILL(getpid(), signo);
653 TAILQ_FOREACH(job, &jobs, link) {
654 DEBUGF(JOB, ("JobPassSig passing signal %d to child %jd.\n",
655 signo, (intmax_t)job->pid));
656 KILL(job->pid, signo);
659 sigprocmask(SIG_SETMASK, &omask, NULL);
660 sigprocmask(SIG_SETMASK, &omask, NULL);
661 act.sa_handler = JobPassSig;
662 sigaction(signo, &act, NULL);
667 * Put out another command for the given job. If the command starts
668 * with an @ or a - we process it specially. In the former case,
669 * so long as the -s and -n flags weren't given to make, we stick
670 * a shell-specific echoOff command in the script. In the latter,
671 * we ignore errors for the entire job, unless the shell has error
673 * If the command is just "..." we take all future commands for this
674 * job to be commands to be executed once the entire graph has been
675 * made and return non-zero to signal that the end of the commands
676 * was reached. These commands are later attached to the postCommands
677 * node and executed by Job_Finish when all things are done.
678 * This function is called from JobStart via LST_FOREACH.
681 * Always 0, unless the command was "..."
684 * If the command begins with a '-' and the shell has no error control,
685 * the JOB_IGNERR flag is set in the job descriptor.
686 * If the command is "..." and we're not ignoring such things,
687 * tailCmds is set to the successor node of the cmd.
688 * numCommands is incremented if the command is actually printed.
691 JobPrintCommand(char *cmd, Job *job)
693 Boolean noSpecials; /* true if we shouldn't worry about
694 * inserting special commands into
695 * the input stream. */
696 Boolean shutUp = FALSE; /* true if we put a no echo command
697 * into the command file */
698 Boolean errOff = FALSE; /* true if we turned error checking
699 * off before printing the command
700 * and need to turn it back on */
701 const char *cmdTemplate;/* Template to use when printing the command */
702 char *cmdStart; /* Start of expanded command */
703 LstNode *cmdNode; /* Node for replacing the command */
705 noSpecials = (noExecute && !(job->node->type & OP_MAKE));
707 if (strcmp(cmd, "...") == 0) {
708 job->node->type |= OP_SAVE_CMDS;
709 if ((job->flags & JOB_IGNDOTS) == 0) {
711 Lst_Succ(Lst_Member(&job->node->commands, cmd));
717 #define DBPRINTF(fmt, arg) \
718 DEBUGF(JOB, (fmt, arg)); \
719 fprintf(job->cmdFILE, fmt, arg); \
720 fflush(job->cmdFILE);
725 * For debugging, we replace each command with the result of expanding
726 * the variables in the command.
728 cmdNode = Lst_Member(&job->node->commands, cmd);
730 cmd = Buf_Peel(Var_Subst(cmd, job->node, FALSE));
733 Lst_Replace(cmdNode, cmdStart);
735 cmdTemplate = "%s\n";
738 * Check for leading @', -' or +'s to control echoing, error checking,
739 * and execution on -n.
741 while (*cmd == '@' || *cmd == '-' || *cmd == '+') {
745 shutUp = DEBUG(LOUD) ? FALSE : TRUE;
755 * We're not actually exececuting anything...
756 * but this one needs to be - use compat mode
759 Compat_RunCommand(cmd, job->node);
767 while (isspace((unsigned char)*cmd))
771 if (!(job->flags & JOB_SILENT) && !noSpecials &&
772 commandShell->hasEchoCtl) {
773 DBPRINTF("%s\n", commandShell->echoOff);
780 if (!(job->flags & JOB_IGNERR) && !noSpecials) {
781 if (commandShell->hasErrCtl) {
783 * We don't want the error-control commands
784 * showing up either, so we turn off echoing
785 * while executing them. We could put another
786 * field in the shell structure to tell
787 * JobDoOutput to look for this string too,
788 * but why make it any more complex than
791 if (!(job->flags & JOB_SILENT) && !shutUp &&
792 commandShell->hasEchoCtl) {
793 DBPRINTF("%s\n", commandShell->echoOff);
794 DBPRINTF("%s\n", commandShell->ignErr);
795 DBPRINTF("%s\n", commandShell->echoOn);
797 DBPRINTF("%s\n", commandShell->ignErr);
799 } else if (commandShell->ignErr &&
800 *commandShell->ignErr != '\0') {
802 * The shell has no error control, so we need to
803 * be weird to get it to ignore any errors from
804 * the command. If echoing is turned on, we turn
805 * it off and use the errCheck template to echo
806 * the command. Leave echoing off so the user
807 * doesn't see the weirdness we go through to
808 * ignore errors. Set cmdTemplate to use the
809 * weirdness instead of the simple "%s\n"
812 if (!(job->flags & JOB_SILENT) && !shutUp &&
813 commandShell->hasEchoCtl) {
814 DBPRINTF("%s\n", commandShell->echoOff);
815 DBPRINTF(commandShell->errCheck, cmd);
818 cmdTemplate = commandShell->ignErr;
820 * The error ignoration (hee hee) is already
821 * taken care of by the ignErr template, so
822 * pretend error checking is still on.
833 DBPRINTF(cmdTemplate, cmd);
837 * If echoing is already off, there's no point in issuing the
838 * echoOff command. Otherwise we issue it and pretend it was on
839 * for the whole command...
841 if (!shutUp && !(job->flags & JOB_SILENT) &&
842 commandShell->hasEchoCtl) {
843 DBPRINTF("%s\n", commandShell->echoOff);
846 DBPRINTF("%s\n", commandShell->errCheck);
849 DBPRINTF("%s\n", commandShell->echoOn);
856 * Called to close both input and output pipes when a job is finished.
859 * The file descriptors associated with the job are closed.
866 #if !defined(USE_KQUEUE)
867 FD_CLR(job->inPipe, &outputs);
869 if (job->outPipe != job->inPipe) {
872 JobDoOutput(job, TRUE);
876 JobDoOutput(job, TRUE);
882 * Do final processing for the given job including updating
883 * parents and starting new jobs as available/necessary. Note
884 * that we pay no attention to the JOB_IGNERR flag here.
885 * This is because when we're called because of a noexecute flag
886 * or something, jstat.w_status is 0 and when called from
887 * Job_CatchChildren, the status is zeroed if it s/b ignored.
890 * Some nodes may be put on the toBeMade queue.
891 * Final commands for the job are placed on postCommands.
893 * If we got an error and are aborting (aborting == ABORT_ERROR) and
894 * the job list is now empty, we are done for the day.
895 * If we recognized an error (errors !=0), we set the aborting flag
896 * to ABORT_ERROR so no more jobs will be started.
899 JobFinish(Job *job, int *status)
904 if ((WIFEXITED(*status) && WEXITSTATUS(*status) != 0 &&
905 !(job->flags & JOB_IGNERR)) ||
906 (WIFSIGNALED(*status) && WTERMSIG(*status) != SIGCONT)) {
908 * If it exited non-zero and either we're doing things our
909 * way or we're not ignoring errors, the job is finished.
910 * Similarly, if the shell died because of a signal
911 * the job is also finished. In these cases, finish out the
912 * job's output before printing the exit status...
915 if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
916 fclose(job->cmdFILE);
920 } else if (WIFEXITED(*status)) {
922 * Deal with ignored errors in -B mode. We need to print a
923 * message telling of the ignored error as well as setting
924 * status.w_status to 0 so the next command gets run. To do
925 * this, we set done to be TRUE if in -B mode and the job
928 done = WEXITSTATUS(*status) != 0;
931 * Old comment said: "Note we don't want to close down any of
932 * the streams until we know we're at the end." But we do.
933 * Otherwise when are we going to print the rest of the stuff?
938 * No need to close things down or anything.
943 if (done || WIFSTOPPED(*status) ||
944 (WIFSIGNALED(*status) && WTERMSIG(*status) == SIGCONT) ||
948 if (compatMake && !usePipes && (job->flags & JOB_IGNERR)) {
950 * If output is going to a file and this job is ignoring
951 * errors, arrange to have the exit status sent to the
952 * output file as well.
954 out = fdopen(job->outFd, "w");
956 Punt("Cannot fdopen");
961 if (WIFEXITED(*status)) {
962 DEBUGF(JOB, ("Process %jd exited.\n",
963 (intmax_t)job->pid));
964 if (WEXITSTATUS(*status) != 0) {
965 if (usePipes && job->node != lastNode) {
966 MESSAGE(out, job->node);
967 lastNode = job->node;
969 fprintf(out, "*** Error code %d%s\n",
970 WEXITSTATUS(*status),
971 (job->flags & JOB_IGNERR) ?
974 if (job->flags & JOB_IGNERR) {
977 } else if (DEBUG(JOB)) {
978 if (usePipes && job->node != lastNode) {
979 MESSAGE(out, job->node);
980 lastNode = job->node;
982 fprintf(out, "*** Completed successfully\n");
985 } else if (WIFSTOPPED(*status)) {
986 DEBUGF(JOB, ("Process %jd stopped.\n",
987 (intmax_t)job->pid));
988 if (usePipes && job->node != lastNode) {
989 MESSAGE(out, job->node);
990 lastNode = job->node;
992 fprintf(out, "*** Stopped -- signal %d\n",
994 job->flags |= JOB_RESUME;
995 TAILQ_INSERT_TAIL(&stoppedJobs, job, link);
999 } else if (WTERMSIG(*status) == SIGCONT) {
1001 * If the beastie has continued, shift the Job from
1002 * the stopped list to the running one (or re-stop it
1003 * if concurrency is exceeded) and go and get another
1006 if (job->flags & (JOB_RESUME | JOB_RESTART)) {
1007 if (usePipes && job->node != lastNode) {
1008 MESSAGE(out, job->node);
1009 lastNode = job->node;
1011 fprintf(out, "*** Continued\n");
1013 if (!(job->flags & JOB_CONTINUING)) {
1014 DEBUGF(JOB, ("Warning: process %jd was not "
1015 "continuing.\n", (intmax_t)job->pid));
1018 * We don't really want to restart a job from
1019 * scratch just because it continued, especially
1020 * not without killing the continuing process!
1021 * That's why this is ifdef'ed out.
1027 job->flags &= ~JOB_CONTINUING;
1028 TAILQ_INSERT_TAIL(&jobs, job, link);
1030 DEBUGF(JOB, ("Process %jd is continuing locally.\n",
1031 (intmax_t)job->pid));
1032 if (nJobs == maxJobs) {
1034 DEBUGF(JOB, ("Job queue is full.\n"));
1040 if (usePipes && job->node != lastNode) {
1041 MESSAGE(out, job->node);
1042 lastNode = job->node;
1044 fprintf(out, "*** Signal %d\n", WTERMSIG(*status));
1051 * Now handle the -B-mode stuff. If the beast still isn't finished,
1052 * try and restart the job on the next command. If JobStart says it's
1053 * ok, it's ok. If there's an error, this puppy is done.
1055 if (compatMake && WIFEXITED(*status) &&
1056 Lst_Succ(job->node->compat_command) != NULL) {
1057 switch (JobStart(job->node, job->flags & JOB_IGNDOTS, job)) {
1063 W_SETEXITSTATUS(status, 1);
1067 * If we got back a JOB_FINISHED code, JobStart has
1068 * already called Make_Update and freed the job
1069 * descriptor. We set done to false here to avoid fake
1070 * cycles and double frees. JobStart needs to do the
1071 * update so we can proceed up the graph when given
1083 if (done && aborting != ABORT_ERROR &&
1084 aborting != ABORT_INTERRUPT && *status == 0) {
1086 * As long as we aren't aborting and the job didn't return a
1087 * non-zero status that we shouldn't ignore, we call
1088 * Make_Update to update the parents. In addition, any saved
1089 * commands for the node are placed on the .END target.
1091 for (ln = job->tailCmds; ln != NULL; ln = LST_NEXT(ln)) {
1092 Lst_AtEnd(&postCommands->commands,
1094 Var_Subst(Lst_Datum(ln), job->node, FALSE)));
1097 job->node->made = MADE;
1098 Make_Update(job->node);
1101 } else if (*status != 0) {
1109 * Set aborting if any error.
1111 if (errors && !keepgoing && aborting != ABORT_INTERRUPT) {
1113 * If we found any errors in this batch of children and the -k
1114 * flag wasn't given, we set the aborting flag so no more jobs
1117 aborting = ABORT_ERROR;
1120 if (aborting == ABORT_ERROR && Job_Empty()) {
1122 * If we are aborting and the job table is now empty, we finish.
1130 * Touch the given target. Called by JobStart when the -t flag was
1131 * given. Prints messages unless told to be silent.
1134 * The data modification of the file is changed. In addition, if the
1135 * file did not exist, it is created.
1138 Job_Touch(GNode *gn, Boolean silent)
1140 int streamID; /* ID of stream opened to do the touch */
1141 struct utimbuf times; /* Times for utime() call */
1143 if (gn->type & (OP_JOIN | OP_USE | OP_EXEC | OP_OPTIONAL)) {
1145 * .JOIN, .USE, .ZEROTIME and .OPTIONAL targets are "virtual"
1146 * targets and, as such, shouldn't really be created.
1152 fprintf(stdout, "touch %s\n", gn->name);
1160 if (gn->type & OP_ARCHV) {
1162 } else if (gn->type & OP_LIB) {
1165 char *file = gn->path ? gn->path : gn->name;
1167 times.actime = times.modtime = now;
1168 if (utime(file, ×) < 0) {
1169 streamID = open(file, O_RDWR | O_CREAT, 0666);
1171 if (streamID >= 0) {
1175 * Read and write a byte to the file to change
1176 * the modification time, then close the file.
1178 if (read(streamID, &c, 1) == 1) {
1179 lseek(streamID, (off_t)0, SEEK_SET);
1180 write(streamID, &c, 1);
1185 fprintf(stdout, "*** couldn't touch %s: %s",
1186 file, strerror(errno));
1195 * Make sure the given node has all the commands it needs.
1198 * TRUE if the commands list is/was ok.
1201 * The node will have commands from the .DEFAULT rule added to it
1205 Job_CheckCommands(GNode *gn, void (*abortProc)(const char *, ...))
1208 if (OP_NOP(gn->type) && Lst_IsEmpty(&gn->commands) &&
1209 (gn->type & OP_LIB) == 0) {
1211 * No commands. Look for .DEFAULT rule from which we might infer
1214 if (DEFAULT != NULL && !Lst_IsEmpty(&DEFAULT->commands)) {
1217 * Make only looks for a .DEFAULT if the node was
1218 * never the target of an operator, so that's what we
1219 * do too. If a .DEFAULT was given, we substitute its
1220 * commands for gn's commands and set the IMPSRC
1221 * variable to be the target's name The DEFAULT node
1222 * acts like a transformation rule, in that gn also
1223 * inherits any attributes or sources attached to
1226 Make_HandleUse(DEFAULT, gn);
1227 Var_Set(IMPSRC, Var_Value(TARGET, gn, &p1), gn);
1230 } else if (Dir_MTime(gn) == 0) {
1232 * The node wasn't the target of an operator we have
1233 * no .DEFAULT rule to go on and the target doesn't
1234 * already exist. There's nothing more we can do for
1235 * this branch. If the -k flag wasn't given, we stop
1236 * in our tracks, otherwise we just don't update
1237 * this node's parents so they never get examined.
1239 static const char msg[] =
1240 "make: don't know how to make";
1242 if (gn->type & OP_OPTIONAL) {
1243 fprintf(stdout, "%s %s(ignored)\n",
1246 } else if (keepgoing) {
1247 fprintf(stdout, "%s %s(continuing)\n",
1253 if (strcmp(gn->name,"love") == 0)
1254 (*abortProc)("Not war.");
1257 (*abortProc)("%s %s. Stop",
1268 * Execute the shell for the given job. Called from JobStart and
1272 * A shell is executed, outputs is altered and the Job structure added
1276 JobExec(Job *job, char **argv)
1279 pid_t cpid; /* ID of new child */
1284 DEBUGF(JOB, ("Running %s\n", job->node->name));
1285 DEBUGF(JOB, ("\tCommand: "));
1286 for (i = 0; argv[i] != NULL; i++) {
1287 DEBUGF(JOB, ("%s ", argv[i]));
1289 DEBUGF(JOB, ("\n"));
1293 * Some jobs produce no output and it's disconcerting to have
1294 * no feedback of their running (since they produce no output, the
1295 * banner with their name in it never appears). This is an attempt to
1296 * provide that feedback, even if nothing follows it.
1298 if (lastNode != job->node && (job->flags & JOB_FIRST) &&
1299 !(job->flags & JOB_SILENT)) {
1300 MESSAGE(stdout, job->node);
1301 lastNode = job->node;
1304 ps.in = FILENO(job->cmdFILE);
1307 * Set up the child's output to be routed through the
1308 * pipe we've created for it.
1310 ps.out = job->outPipe;
1313 * We're capturing output in a file, so we duplicate
1314 * the descriptor to the temporary file into the
1317 ps.out = job->outFd;
1319 ps.err = STDERR_FILENO;
1321 ps.merge_errors = 1;
1330 if ((cpid = vfork()) == -1) {
1331 Punt("Cannot fork");
1333 } else if (cpid == 0) {
1349 if (usePipes && (job->flags & JOB_FIRST)) {
1351 * The first time a job is run for a node, we set the
1352 * current position in the buffer to the beginning and
1353 * mark another stream to watch in the outputs mask.
1356 struct kevent kev[2];
1360 #if defined(USE_KQUEUE)
1361 EV_SET(&kev[0], job->inPipe, EVFILT_READ, EV_ADD, 0, 0, job);
1362 EV_SET(&kev[1], job->pid, EVFILT_PROC,
1363 EV_ADD | EV_ONESHOT, NOTE_EXIT, 0, NULL);
1364 if (kevent(kqfd, kev, 2, NULL, 0, NULL) != 0) {
1366 * kevent() will fail if the job is already
1369 if (errno != EINTR && errno != EBADF && errno != ESRCH)
1370 Punt("kevent: %s", strerror(errno));
1373 FD_SET(job->inPipe, &outputs);
1374 #endif /* USE_KQUEUE */
1377 if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
1378 fclose(job->cmdFILE);
1379 job->cmdFILE = NULL;
1383 * Now the job is actually running, add it to the table.
1386 TAILQ_INSERT_TAIL(&jobs, job, link);
1387 if (nJobs == maxJobs) {
1395 * Create the argv needed to execute the shell for a given job.
1398 JobMakeArgv(Job *job, char **argv)
1401 static char args[10]; /* For merged arguments */
1403 argv[0] = shellName;
1406 if ((commandShell->exit && *commandShell->exit != '-') ||
1407 (commandShell->echo && *commandShell->echo != '-')) {
1409 * At least one of the flags doesn't have a minus before it, so
1410 * merge them together. Have to do this because the *(&(@*#*&#$#
1411 * Bourne shell thinks its second argument is a file to source.
1412 * Grrrr. Note the ten-character limitation on the combined
1415 sprintf(args, "-%s%s", (job->flags & JOB_IGNERR) ? "" :
1416 commandShell->exit ? commandShell->exit : "",
1417 (job->flags & JOB_SILENT) ? "" :
1418 commandShell->echo ? commandShell->echo : "");
1425 if (!(job->flags & JOB_IGNERR) && commandShell->exit) {
1426 argv[argc] = commandShell->exit;
1429 if (!(job->flags & JOB_SILENT) && commandShell->echo) {
1430 argv[argc] = commandShell->echo;
1439 * Restart a job that stopped for some reason. The job must be neither
1440 * on the jobs nor on the stoppedJobs list.
1443 * jobFull will be set if the job couldn't be run.
1446 JobRestart(Job *job)
1449 if (job->flags & JOB_RESTART) {
1451 * Set up the control arguments to the shell. This is based on
1452 * the flags set earlier for this job. If the JOB_IGNERR flag
1453 * is clear, the 'exit' flag of the commandShell is used to
1454 * cause it to exit upon receiving an error. If the JOB_SILENT
1455 * flag is clear, the 'echo' flag of the commandShell is used
1456 * to get it to start echoing as soon as it starts
1457 * processing commands.
1461 JobMakeArgv(job, argv);
1463 DEBUGF(JOB, ("Restarting %s...", job->node->name));
1464 if (nJobs >= maxJobs && !(job->flags & JOB_SPECIAL)) {
1466 * Not allowed to run -- put it back on the hold
1467 * queue and mark the table full
1469 DEBUGF(JOB, ("holding\n"));
1470 TAILQ_INSERT_HEAD(&stoppedJobs, job, link);
1472 DEBUGF(JOB, ("Job queue is full.\n"));
1476 * Job may be run locally.
1478 DEBUGF(JOB, ("running locally\n"));
1484 * The job has stopped and needs to be restarted.
1485 * Why it stopped, we don't know...
1487 DEBUGF(JOB, ("Resuming %s...", job->node->name));
1488 if ((nJobs < maxJobs || ((job->flags & JOB_SPECIAL) &&
1489 maxJobs == 0)) && nJobs != maxJobs) {
1491 * If we haven't reached the concurrency limit already
1492 * (or the job must be run and maxJobs is 0), it's ok
1498 error = (KILL(job->pid, SIGCONT) != 0);
1502 * Make sure the user knows we've continued
1503 * the beast and actually put the thing in the
1506 job->flags |= JOB_CONTINUING;
1508 W_SETTERMSIG(&status, SIGCONT);
1509 JobFinish(job, &status);
1511 job->flags &= ~(JOB_RESUME|JOB_CONTINUING);
1512 DEBUGF(JOB, ("done\n"));
1514 Error("couldn't resume %s: %s",
1515 job->node->name, strerror(errno));
1517 W_SETEXITSTATUS(&status, 1);
1518 JobFinish(job, &status);
1522 * Job cannot be restarted. Mark the table as full and
1523 * place the job back on the list of stopped jobs.
1525 DEBUGF(JOB, ("table full\n"));
1526 TAILQ_INSERT_HEAD(&stoppedJobs, job, link);
1528 DEBUGF(JOB, ("Job queue is full.\n"));
1535 * Start a target-creation process going for the target described
1536 * by the graph node gn.
1539 * JOB_ERROR if there was an error in the commands, JOB_FINISHED
1540 * if there isn't actually anything left to do for the job and
1541 * JOB_RUNNING if the job has been started.
1544 * A new Job node is created and added to the list of running
1545 * jobs. PMake is forked and a child shell created.
1548 JobStart(GNode *gn, int flags, Job *previous)
1550 Job *job; /* new job descriptor */
1551 char *argv[4]; /* Argument vector to shell */
1552 Boolean cmdsOK; /* true if the nodes commands were all right */
1553 Boolean noExec; /* Set true if we decide not to run the job */
1554 int tfd; /* File descriptor for temp file */
1556 char tfile[sizeof(TMPPAT)];
1559 JobPassSig(interrupted);
1562 if (previous != NULL) {
1563 previous->flags &= ~(JOB_FIRST | JOB_IGNERR | JOB_SILENT);
1566 job = emalloc(sizeof(Job));
1571 job->tailCmds = NULL;
1574 * Set the initial value of the flags for this job based on the global
1575 * ones and the node's attributes... Any flags supplied by the caller
1576 * are also added to the field.
1579 if (Targ_Ignore(gn)) {
1580 job->flags |= JOB_IGNERR;
1582 if (Targ_Silent(gn)) {
1583 job->flags |= JOB_SILENT;
1585 job->flags |= flags;
1588 * Check the commands now so any attributes from .DEFAULT have a chance
1589 * to migrate to the node.
1591 if (!compatMake && (job->flags & JOB_FIRST)) {
1592 cmdsOK = Job_CheckCommands(gn, Error);
1598 * If the -n flag wasn't given, we open up OUR (not the child's)
1599 * temporary file to stuff commands in it. The thing is rd/wr so we
1600 * don't need to reopen it to feed it to the shell. If the -n flag
1601 * *was* given, we just set the file to be stdout. Cute, huh?
1603 if ((gn->type & OP_MAKE) || (!noExecute && !touchFlag)) {
1605 * We're serious here, but if the commands were bogus, we're
1612 strcpy(tfile, TMPPAT);
1613 if ((tfd = mkstemp(tfile)) == -1)
1614 Punt("Cannot create temp file: %s", strerror(errno));
1615 job->cmdFILE = fdopen(tfd, "w+");
1617 if (job->cmdFILE == NULL) {
1619 Punt("Could not open %s", tfile);
1621 fcntl(FILENO(job->cmdFILE), F_SETFD, 1);
1623 * Send the commands to the command file, flush all its
1624 * buffers then rewind and remove the thing.
1629 * Used to be backwards; replace when start doing multiple
1630 * commands per shell.
1634 * Be compatible: If this is the first time for this
1635 * node, verify its commands are ok and open the
1636 * commands list for sequential access by later
1637 * invocations of JobStart. Once that is done, we take
1638 * the next command off the list and print it to the
1639 * command file. If the command was an ellipsis, note
1640 * that there's nothing more to execute.
1642 if (job->flags & JOB_FIRST)
1643 gn->compat_command = Lst_First(&gn->commands);
1645 gn->compat_command =
1646 Lst_Succ(gn->compat_command);
1648 if (gn->compat_command == NULL ||
1649 JobPrintCommand(Lst_Datum(gn->compat_command), job))
1652 if (noExec && !(job->flags & JOB_FIRST)) {
1654 * If we're not going to execute anything, the
1655 * job is done and we need to close down the
1656 * various file descriptors we've opened for
1657 * output, then call JobDoOutput to catch the
1658 * final characters or send the file to the
1659 * screen... Note that the i/o streams are only
1660 * open if this isn't the first job. Note also
1661 * that this could not be done in
1662 * Job_CatchChildren b/c it wasn't clear if
1663 * there were more commands to execute or not...
1669 * We can do all the commands at once. hooray for sanity
1672 LST_FOREACH(ln, &gn->commands) {
1673 if (JobPrintCommand(Lst_Datum(ln), job))
1678 * If we didn't print out any commands to the shell
1679 * script, there's not much point in executing the
1682 if (numCommands == 0) {
1687 } else if (noExecute) {
1689 * Not executing anything -- just print all the commands to
1690 * stdout in one fell swoop. This will still set up
1691 * job->tailCmds correctly.
1693 if (lastNode != gn) {
1694 MESSAGE(stdout, gn);
1697 job->cmdFILE = stdout;
1700 * Only print the commands if they're ok, but don't die if
1701 * they're not -- just let the user know they're bad and keep
1702 * going. It doesn't do any harm in this case and may do
1706 LST_FOREACH(ln, &gn->commands) {
1707 if (JobPrintCommand(Lst_Datum(ln), job))
1712 * Don't execute the shell, thank you.
1718 * Just touch the target and note that no shell should be
1719 * executed. Set cmdFILE to stdout to make life easier. Check
1720 * the commands, too, but don't die if they're no good -- it
1721 * does no harm to keep working up the graph.
1723 job->cmdFILE = stdout;
1724 Job_Touch(gn, job->flags & JOB_SILENT);
1729 * If we're not supposed to execute a shell, don't.
1733 * Unlink and close the command file if we opened one
1735 if (job->cmdFILE != stdout) {
1736 if (job->cmdFILE != NULL)
1737 fclose(job->cmdFILE);
1743 * We only want to work our way up the graph if we aren't here
1744 * because the commands for the job were no good.
1747 if (aborting == 0) {
1748 for (ln = job->tailCmds; ln != NULL;
1749 ln = LST_NEXT(ln)) {
1750 Lst_AtEnd(&postCommands->commands,
1751 Buf_Peel(Var_Subst(Lst_Datum(ln),
1752 job->node, FALSE)));
1754 job->node->made = MADE;
1755 Make_Update(job->node);
1758 return(JOB_FINISHED);
1764 fflush(job->cmdFILE);
1768 * Set up the control arguments to the shell. This is based on the flags
1769 * set earlier for this job.
1771 JobMakeArgv(job, argv);
1774 * If we're using pipes to catch output, create the pipe by which we'll
1775 * get the shell's output. If we're using files, print out that we're
1776 * starting a job and then set up its temporary-file name.
1778 if (!compatMake || (job->flags & JOB_FIRST)) {
1783 Punt("Cannot create pipe: %s", strerror(errno));
1784 job->inPipe = fd[0];
1785 job->outPipe = fd[1];
1786 fcntl(job->inPipe, F_SETFD, 1);
1787 fcntl(job->outPipe, F_SETFD, 1);
1789 fprintf(stdout, "Remaking `%s'\n", gn->name);
1791 strcpy(job->outFile, TMPPAT);
1792 if ((job->outFd = mkstemp(job->outFile)) == -1)
1793 Punt("cannot create temp file: %s",
1795 fcntl(job->outFd, F_SETFD, 1);
1799 if (nJobs >= maxJobs && !(job->flags & JOB_SPECIAL) && maxJobs != 0) {
1801 * We've hit the limit of concurrency, so put the job on hold
1802 * until some other job finishes. Note that the special jobs
1803 * (.BEGIN, .INTERRUPT and .END) may be run even when the
1804 * limit has been reached (e.g. when maxJobs == 0).
1808 DEBUGF(JOB, ("Can only run job locally.\n"));
1809 job->flags |= JOB_RESTART;
1810 TAILQ_INSERT_TAIL(&stoppedJobs, job, link);
1812 if (nJobs >= maxJobs) {
1814 * If we're running this job as a special case
1815 * (see above), at least say the table is full.
1818 DEBUGF(JOB, ("Local job queue is full.\n"));
1822 return (JOB_RUNNING);
1826 JobOutput(Job *job, char *cp, char *endp, int msg)
1830 if (commandShell->noPrint) {
1831 ecp = strstr(cp, commandShell->noPrint);
1832 while (ecp != NULL) {
1835 if (msg && job->node != lastNode) {
1836 MESSAGE(stdout, job->node);
1837 lastNode = job->node;
1840 * The only way there wouldn't be a newline
1841 * after this line is if it were the last in
1842 * the buffer. However, since the non-printable
1843 * comes after it, there must be a newline, so
1844 * we don't print one.
1846 fprintf(stdout, "%s", cp);
1849 cp = ecp + strlen(commandShell->noPrint);
1852 * Still more to print, look again after
1853 * skipping the whitespace following the
1854 * non-printable command....
1857 while (*cp == ' ' || *cp == '\t' ||
1861 ecp = strstr(cp, commandShell->noPrint);
1872 * This function is called at different times depending on
1873 * whether the user has specified that output is to be collected
1874 * via pipes or temporary files. In the former case, we are called
1875 * whenever there is something to read on the pipe. We collect more
1876 * output from the given job and store it in the job's outBuf. If
1877 * this makes up a line, we print it tagged by the job's identifier,
1879 * If output has been collected in a temporary file, we open the
1880 * file and read it line by line, transfering it to our own
1881 * output channel until the file is empty. At which point we
1882 * remove the temporary file.
1883 * In both cases, however, we keep our figurative eye out for the
1884 * 'noPrint' line for the shell from which the output came. If
1885 * we recognize a line, we don't print it. If the command is not
1886 * alone on the line (the character after it is not \0 or \n), we
1887 * do print whatever follows it.
1890 * curPos may be shifted as may the contents of outBuf.
1893 JobDoOutput(Job *job, Boolean finish)
1895 Boolean gotNL = FALSE; /* true if got a newline */
1896 Boolean fbuf; /* true if our buffer filled up */
1897 int nr; /* number of bytes read */
1898 int i; /* auxiliary index into outBuf */
1899 int max; /* limit for i (end of current data) */
1900 int nRead; /* (Temporary) number of bytes read */
1901 FILE *oFILE; /* Stream pointer to shell's output file */
1906 * Read as many bytes as will fit in the buffer.
1912 nRead = read(job->inPipe, &job->outBuf[job->curPos],
1913 JOB_BUFSIZE - job->curPos);
1915 * Check for interrupt here too, because the above read may
1916 * block when the child process is stopped. In this case the
1917 * interrupt will unblock it (we don't use SA_RESTART).
1920 JobPassSig(interrupted);
1923 DEBUGF(JOB, ("JobDoOutput(piperead)"));
1930 * If we hit the end-of-file (the job is dead), we must flush
1931 * its remaining output, so pretend we read a newline if
1932 * there's any output remaining in the buffer.
1933 * Also clear the 'finish' flag so we stop looping.
1935 if (nr == 0 && job->curPos != 0) {
1936 job->outBuf[job->curPos] = '\n';
1939 } else if (nr == 0) {
1944 * Look for the last newline in the bytes we just got. If there
1945 * is one, break out of the loop with 'i' as its index and
1948 max = job->curPos + nr;
1949 for (i = job->curPos + nr - 1; i >= job->curPos; i--) {
1950 if (job->outBuf[i] == '\n') {
1953 } else if (job->outBuf[i] == '\0') {
1957 job->outBuf[i] = ' ';
1963 if (job->curPos == JOB_BUFSIZE) {
1965 * If we've run out of buffer space, we have
1966 * no choice but to print the stuff. sigh.
1972 if (gotNL || fbuf) {
1974 * Need to send the output to the screen. Null terminate
1975 * it first, overwriting the newline character if there
1976 * was one. So long as the line isn't one we should
1977 * filter (according to the shell description), we print
1978 * the line, preceded by a target banner if this target
1979 * isn't the same as the one for which we last printed
1980 * something. The rest of the data in the buffer are
1981 * then shifted down to the start of the buffer and
1982 * curPos is set accordingly.
1984 job->outBuf[i] = '\0';
1985 if (i >= job->curPos) {
1988 cp = JobOutput(job, job->outBuf,
1989 &job->outBuf[i], FALSE);
1992 * There's still more in that buffer. This time,
1993 * though, we know there's no newline at the
1994 * end, so we add one of our own free will.
1997 if (job->node != lastNode) {
1998 MESSAGE(stdout, job->node);
1999 lastNode = job->node;
2001 fprintf(stdout, "%s%s", cp,
2007 /* shift the remaining characters down */
2008 memcpy(job->outBuf, &job->outBuf[i + 1],
2010 job->curPos = max - (i + 1);
2014 * We have written everything out, so we just
2015 * start over from the start of the buffer.
2016 * No copying. No nothing.
2023 * If the finish flag is true, we must loop until we hit
2024 * end-of-file on the pipe. This is guaranteed to happen
2025 * eventually since the other end of the pipe is now
2026 * closed (we closed it explicitly and the child has
2027 * exited). When we do get an EOF, finish will be set
2028 * FALSE and we'll fall through and out.
2035 * We've been called to retrieve the output of the job from the
2036 * temporary file where it's been squirreled away. This consists
2037 * of opening the file, reading the output line by line, being
2038 * sure not to print the noPrint line for the shell we used,
2039 * then close and remove the temporary file. Very simple.
2041 * Change to read in blocks and do FindSubString type things
2042 * as for pipes? That would allow for "@echo -n..."
2044 oFILE = fopen(job->outFile, "r");
2045 if (oFILE != NULL) {
2046 fprintf(stdout, "Results of making %s:\n",
2050 while (fgets(inLine, sizeof(inLine), oFILE) != NULL) {
2051 char *cp, *endp, *oendp;
2054 oendp = endp = inLine + strlen(inLine);
2055 if (endp[-1] == '\n') {
2058 cp = JobOutput(job, inLine, endp, FALSE);
2061 * There's still more in that buffer. This time,
2062 * though, we know there's no newline at the
2063 * end, so we add one of our own free will.
2065 fprintf(stdout, "%s", cp);
2067 if (endp != oendp) {
2068 fprintf(stdout, "\n");
2073 eunlink(job->outFile);
2080 * Handle the exit of a child. Called from Make_Make.
2083 * The job descriptor is removed from the list of children.
2086 * We do waits, blocking or not, according to the wisdom of our
2087 * caller, until there are no more children to report. For each
2088 * job, call JobFinish to finish things off. This will take care of
2089 * putting jobs on the stoppedJobs queue.
2092 Job_CatchChildren(Boolean block)
2094 pid_t pid; /* pid of dead child */
2095 Job *job; /* job descriptor for dead child */
2096 int status; /* Exit/termination status */
2099 * Don't even bother if we know there's no one around.
2106 pid = waitpid((pid_t)-1, &status,
2107 (block ? 0 : WNOHANG) | WUNTRACED);
2111 DEBUGF(JOB, ("Process %jd exited or stopped.\n",
2114 TAILQ_FOREACH(job, &jobs, link) {
2115 if (job->pid == pid)
2120 if (WIFSIGNALED(status) &&
2121 (WTERMSIG(status) == SIGCONT)) {
2122 TAILQ_FOREACH(job, &jobs, link) {
2123 if (job->pid == pid)
2127 Error("Resumed child (%jd) "
2128 "not in table", (intmax_t)pid);
2131 TAILQ_REMOVE(&stoppedJobs, job, link);
2133 Error("Child (%jd) not in table?",
2138 TAILQ_REMOVE(&jobs, job, link);
2140 if (fifoFd >= 0 && maxJobs > 1) {
2141 write(fifoFd, "+", 1);
2143 if (nJobs >= maxJobs)
2148 DEBUGF(JOB, ("Job queue is no longer full.\n"));
2153 JobFinish(job, &status);
2156 JobPassSig(interrupted);
2161 * Catch the output from our children, if we're using
2162 * pipes do so. Otherwise just block time until we get a
2163 * signal(most likely a SIGCHLD) since there's no point in
2164 * just spinning when there's nothing to do and the reaping
2165 * of a child can wait for a while.
2168 * Output is read from pipes if we're piping.
2169 * -----------------------------------------------------------------------
2173 Job_CatchOutput(int flag __unused)
2175 Job_CatchOutput(int flag)
2181 struct kevent kev[KEV_SIZE];
2184 struct timeval timeout;
2193 if ((nfds = kevent(kqfd, NULL, 0, kev, KEV_SIZE, NULL)) == -1) {
2195 Punt("kevent: %s", strerror(errno));
2197 JobPassSig(interrupted);
2199 for (i = 0; i < nfds; i++) {
2200 if (kev[i].flags & EV_ERROR) {
2201 warnc(kev[i].data, "kevent");
2204 switch (kev[i].filter) {
2206 JobDoOutput(kev[i].udata, FALSE);
2210 * Just wake up and let
2211 * Job_CatchChildren() collect the
2220 timeout.tv_sec = SEL_SEC;
2221 timeout.tv_usec = SEL_USEC;
2222 if (flag && jobFull && fifoFd >= 0)
2223 FD_SET(fifoFd, &readfds);
2225 nfds = select(FD_SETSIZE, &readfds, (fd_set *)NULL,
2226 (fd_set *)NULL, &timeout);
2229 JobPassSig(interrupted);
2232 if (fifoFd >= 0 && FD_ISSET(fifoFd, &readfds)) {
2236 job = TAILQ_FIRST(&jobs);
2237 while (nfds != 0 && job != NULL) {
2238 if (FD_ISSET(job->inPipe, &readfds)) {
2239 JobDoOutput(job, FALSE);
2242 job = TAILQ_NEXT(job, link);
2244 #endif /* !USE_KQUEUE */
2250 * Start the creation of a target. Basically a front-end for
2251 * JobStart used by the Make module.
2254 * Another job is started.
2260 JobStart(gn, 0, NULL);
2265 * Make a new copy of the shell structure including a copy of the strings
2266 * in it. This also defaults some fields in case they are NULL.
2269 * The function returns a pointer to the new shell structure.
2271 static struct Shell *
2272 JobCopyShell(const struct Shell *osh)
2276 nsh = emalloc(sizeof(*nsh));
2277 nsh->name = estrdup(osh->name);
2279 if (osh->echoOff != NULL)
2280 nsh->echoOff = estrdup(osh->echoOff);
2282 nsh->echoOff = NULL;
2283 if (osh->echoOn != NULL)
2284 nsh->echoOn = estrdup(osh->echoOn);
2287 nsh->hasEchoCtl = osh->hasEchoCtl;
2289 if (osh->noPrint != NULL)
2290 nsh->noPrint = estrdup(osh->noPrint);
2292 nsh->noPrint = NULL;
2294 nsh->hasErrCtl = osh->hasErrCtl;
2295 if (osh->errCheck == NULL)
2296 nsh->errCheck = estrdup("");
2298 nsh->errCheck = estrdup(osh->errCheck);
2299 if (osh->ignErr == NULL)
2300 nsh->ignErr = estrdup("%s");
2302 nsh->ignErr = estrdup(osh->ignErr);
2304 if (osh->echo == NULL)
2305 nsh->echo = estrdup("");
2307 nsh->echo = estrdup(osh->echo);
2309 if (osh->exit == NULL)
2310 nsh->exit = estrdup("");
2312 nsh->exit = estrdup(osh->exit);
2319 * Free a shell structure and all associated strings.
2322 JobFreeShell(struct Shell *sh)
2342 if (commandShell == NULL)
2343 commandShell = JobMatchShell(shells[DEFSHELL].name);
2345 if (shellPath == NULL) {
2347 * The user didn't specify a shell to use, so we are using the
2348 * default one... Both the absolute path and the last component
2349 * must be set. The last component is taken from the 'name'
2350 * field of the default shell description pointed-to by
2351 * commandShell. All default shells are located in
2354 shellName = commandShell->name;
2355 shellPath = str_concat(PATH_DEFSHELLDIR, shellName,
2362 * Initialize the process module, given a maximum number of jobs.
2365 * lists and counters are initialized
2368 Job_Init(int maxproc)
2370 GNode *begin; /* node for commands to do at the very start */
2372 struct sigaction sa;
2375 env = getenv("MAKE_JOBS_FIFO");
2377 if (env == NULL && maxproc > 1) {
2379 * We did not find the environment variable so we are the
2380 * leader. Create the fifo, open it, write one char per
2381 * allowed job into the pipe.
2384 if (!mkfifo(fifoName, 0600)) {
2385 fifoFd = open(fifoName, O_RDWR | O_NONBLOCK, 0);
2388 fcntl(fifoFd, F_SETFL, O_NONBLOCK);
2390 setenv("MAKE_JOBS_FIFO", env, 1);
2391 while (maxproc-- > 0) {
2392 write(fifoFd, "+", 1);
2394 /* The master make does not get a magic token */
2403 } else if (env != NULL) {
2405 * We had the environment variable so we are a slave.
2406 * Open fifo and give ourselves a magic token which represents
2407 * the token our parent make has grabbed to start his make
2408 * process. Otherwise the sub-makes would gobble up tokens and
2409 * the proper number of tokens to specify to -j would depend
2410 * on the depth of the tree and the order of execution.
2412 fifoFd = open(env, O_RDWR, 0);
2414 fcntl(fifoFd, F_SETFL, O_NONBLOCK);
2431 if ((maxJobs == 1 && fifoFd < 0) || beVerbose == 0) {
2433 * If only one job can run at a time, there's no need for a
2434 * banner, no is there?
2444 * Catch the four signals that POSIX specifies if they aren't ignored.
2445 * JobCatchSignal will just set global variables and hope someone
2446 * else is going to handle the interrupt.
2448 sa.sa_handler = JobCatchSig;
2449 sigemptyset(&sa.sa_mask);
2452 if (signal(SIGINT, SIG_IGN) != SIG_IGN) {
2453 sigaction(SIGINT, &sa, NULL);
2455 if (signal(SIGHUP, SIG_IGN) != SIG_IGN) {
2456 sigaction(SIGHUP, &sa, NULL);
2458 if (signal(SIGQUIT, SIG_IGN) != SIG_IGN) {
2459 sigaction(SIGQUIT, &sa, NULL);
2461 if (signal(SIGTERM, SIG_IGN) != SIG_IGN) {
2462 sigaction(SIGTERM, &sa, NULL);
2465 * There are additional signals that need to be caught and passed if
2466 * either the export system wants to be told directly of signals or if
2467 * we're giving each job its own process group (since then it won't get
2468 * signals from the terminal driver as we own the terminal)
2470 #if defined(USE_PGRP)
2471 if (signal(SIGTSTP, SIG_IGN) != SIG_IGN) {
2472 sigaction(SIGTSTP, &sa, NULL);
2474 if (signal(SIGTTOU, SIG_IGN) != SIG_IGN) {
2475 sigaction(SIGTTOU, &sa, NULL);
2477 if (signal(SIGTTIN, SIG_IGN) != SIG_IGN) {
2478 sigaction(SIGTTIN, &sa, NULL);
2480 if (signal(SIGWINCH, SIG_IGN) != SIG_IGN) {
2481 sigaction(SIGWINCH, &sa, NULL);
2486 if ((kqfd = kqueue()) == -1) {
2487 Punt("kqueue: %s", strerror(errno));
2491 begin = Targ_FindNode(".BEGIN", TARG_NOCREATE);
2493 if (begin != NULL) {
2494 JobStart(begin, JOB_SPECIAL, (Job *)NULL);
2497 Job_CatchChildren(!usePipes);
2500 postCommands = Targ_FindNode(".END", TARG_CREATE);
2505 * See if the job table is full. It is considered full if it is OR
2506 * if we are in the process of aborting OR if we have
2507 * reached/exceeded our local quota. This prevents any more jobs
2511 * TRUE if the job table is full, FALSE otherwise
2521 if (fifoFd >= 0 && jobFull) {
2522 i = read(fifoFd, &c, 1);
2533 * See if the job table is empty. Because the local concurrency may
2534 * be set to 0, it is possible for the job table to become empty,
2535 * while the list of stoppedJobs remains non-empty. In such a case,
2536 * we want to restart as many jobs as we can.
2539 * TRUE if it is. FALSE if it ain't.
2545 if (!TAILQ_EMPTY(&stoppedJobs) && !aborting) {
2547 * The job table is obviously not full if it has no
2548 * jobs in it...Try and restart the stopped jobs.
2563 * Find a matching shell in 'shells' given its final component.
2566 * A pointer to a freshly allocated Shell structure with a copy
2567 * of the static structure or NULL if no shell with the given name
2570 static struct Shell *
2571 JobMatchShell(const char *name)
2573 const struct CShell *sh; /* Pointer into shells table */
2576 for (sh = shells; sh < shells + __arysize(shells); sh++)
2577 if (strcmp(sh->name, name) == 0)
2580 if (sh == shells + __arysize(shells))
2584 nsh = emalloc(sizeof(*nsh));
2586 nsh->name = estrdup(sh->name);
2587 nsh->echoOff = estrdup(sh->echoOff);
2588 nsh->echoOn = estrdup(sh->echoOn);
2589 nsh->hasEchoCtl = sh->hasEchoCtl;
2590 nsh->noPrint = estrdup(sh->noPrint);
2591 nsh->hasErrCtl = sh->hasErrCtl;
2592 nsh->errCheck = estrdup(sh->errCheck);
2593 nsh->ignErr = estrdup(sh->ignErr);
2594 nsh->echo = estrdup(sh->echo);
2595 nsh->exit = estrdup(sh->exit);
2602 * Parse a shell specification and set up commandShell, shellPath
2603 * and shellName appropriately.
2606 * FAILURE if the specification was incorrect.
2609 * commandShell points to a Shell structure (either predefined or
2610 * created from the shell spec), shellPath is the full path of the
2611 * shell described by commandShell, while shellName is just the
2612 * final component of shellPath.
2615 * A shell specification consists of a .SHELL target, with dependency
2616 * operator, followed by a series of blank-separated words. Double
2617 * quotes can be used to use blanks in words. A backslash escapes
2618 * anything (most notably a double-quote and a space) and
2619 * provides the functionality it does in C. Each word consists of
2620 * keyword and value separated by an equal sign. There should be no
2621 * unnecessary spaces in the word. The keywords are as follows:
2622 * name Name of shell.
2623 * path Location of shell. Overrides "name" if given
2624 * quiet Command to turn off echoing.
2625 * echo Command to turn echoing on
2626 * filter Result of turning off echoing that shouldn't be
2628 * echoFlag Flag to turn echoing on at the start
2629 * errFlag Flag to turn error checking on at the start
2630 * hasErrCtl True if shell has error checking control
2631 * check Command to turn on error checking if hasErrCtl
2632 * is TRUE or template of command to echo a command
2633 * for which error checking is off if hasErrCtl is
2635 * ignore Command to turn off error checking if hasErrCtl
2636 * is TRUE or template of command to execute a
2637 * command so as to ignore any errors it returns if
2638 * hasErrCtl is FALSE.
2641 Job_ParseShell(char *line)
2649 Boolean fullSpec = FALSE;
2650 struct Shell newShell;
2653 while (isspace((unsigned char)*line)) {
2656 words = brk_string(line, &wordCount, TRUE);
2658 memset(&newShell, 0, sizeof(newShell));
2662 * Parse the specification by keyword but skip the first word - it
2663 * is not set by brk_string.
2668 for (argc = wordCount, argv = words; argc != 0; argc--, argv++) {
2670 * Split keyword and value
2672 if ((eq = strchr(*argv, '=')) == NULL) {
2673 Parse_Error(PARSE_FATAL, "missing '=' in shell "
2674 "specification keyword '%s'", *argv);
2679 if (strcmp(*argv, "path") == 0) {
2681 } else if (strcmp(*argv, "name") == 0) {
2683 } else if (strcmp(*argv, "quiet") == 0) {
2684 newShell.echoOff = eq;
2686 } else if (strcmp(*argv, "echo") == 0) {
2687 newShell.echoOn = eq;
2689 } else if (strcmp(*argv, "filter") == 0) {
2690 newShell.noPrint = eq;
2692 } else if (strcmp(*argv, "echoFlag") == 0) {
2695 } else if (strcmp(*argv, "errFlag") == 0) {
2698 } else if (strcmp(*argv, "hasErrCtl") == 0) {
2699 newShell.hasErrCtl = (*eq == 'Y' || *eq == 'y' ||
2700 *eq == 'T' || *eq == 't');
2702 } else if (strcmp(*argv, "check") == 0) {
2703 newShell.errCheck = eq;
2705 } else if (strcmp(*argv, "ignore") == 0) {
2706 newShell.ignErr = eq;
2709 Parse_Error(PARSE_FATAL, "unknown keyword in shell "
2710 "specification '%s'", *argv);
2716 * Some checks (could be more)
2719 if ((newShell.echoOn != NULL) ^ (newShell.echoOff != NULL))
2720 Parse_Error(PARSE_FATAL, "Shell must have either both "
2721 "echoOff and echoOn or none of them");
2723 if (newShell.echoOn != NULL && newShell.echoOff)
2724 newShell.hasEchoCtl = TRUE;
2729 * If no path was given, the user wants one of the pre-defined
2730 * shells, yes? So we find the one s/he wants with the help of
2731 * JobMatchShell and set things up the right way. shellPath
2732 * will be set up by Job_Init.
2734 if (newShell.name == NULL) {
2735 Parse_Error(PARSE_FATAL,
2736 "Neither path nor name specified");
2739 if ((sh = JobMatchShell(newShell.name)) == NULL) {
2740 Parse_Error(PARSE_FATAL, "%s: no matching shell",
2747 * The user provided a path. If s/he gave nothing else
2748 * (fullSpec is FALSE), try and find a matching shell in the
2749 * ones we know of. Else we just take the specification at its
2750 * word and copy it to a new location. In either case, we need
2751 * to record the path the user gave for the shell.
2754 shellPath = estrdup(path);
2755 if (newShell.name == NULL) {
2756 /* get the base name as the name */
2757 path = strrchr(path, '/');
2763 newShell.name = path;
2767 if ((sh = JobMatchShell(newShell.name)) == NULL) {
2768 Parse_Error(PARSE_FATAL,
2769 "%s: no matching shell", newShell.name);
2773 sh = JobCopyShell(&newShell);
2777 /* set the new shell */
2778 JobFreeShell(commandShell);
2781 shellName = commandShell->name;
2788 * Handle the receipt of an interrupt.
2791 * All children are killed. Another job will be started if the
2792 * .INTERRUPT target was given.
2795 JobInterrupt(int runINTERRUPT, int signo)
2797 Job *job; /* job descriptor in that element */
2798 GNode *interrupt; /* the node describing the .INTERRUPT target */
2800 aborting = ABORT_INTERRUPT;
2802 TAILQ_FOREACH(job, &jobs, link) {
2803 if (!Targ_Precious(job->node)) {
2804 char *file = (job->node->path == NULL ?
2805 job->node->name : job->node->path);
2807 if (!noExecute && eunlink(file) != -1) {
2808 Error("*** %s removed", file);
2812 DEBUGF(JOB, ("JobInterrupt passing signal to child "
2813 "%jd.\n", (intmax_t)job->pid));
2814 KILL(job->pid, signo);
2818 if (runINTERRUPT && !touchFlag) {
2820 * clear the interrupted flag because we would get an
2821 * infinite loop otherwise.
2825 interrupt = Targ_FindNode(".INTERRUPT", TARG_NOCREATE);
2826 if (interrupt != NULL) {
2827 ignoreErrors = FALSE;
2829 JobStart(interrupt, JOB_IGNDOTS, (Job *)NULL);
2832 Job_CatchChildren(!usePipes);
2840 * Do final processing such as the running of the commands
2841 * attached to the .END target.
2844 * Number of errors reported.
2850 if (postCommands != NULL && !Lst_IsEmpty(&postCommands->commands)) {
2852 Error("Errors reported so .END ignored");
2854 JobStart(postCommands, JOB_SPECIAL | JOB_IGNDOTS, NULL);
2858 Job_CatchChildren(!usePipes);
2873 * Waits for all running jobs to finish and returns. Sets 'aborting'
2874 * to ABORT_WAIT to prevent other jobs from starting.
2877 * Currently running jobs finish.
2883 aborting = ABORT_WAIT;
2884 while (nJobs != 0) {
2886 Job_CatchChildren(!usePipes);
2893 * Abort all currently running jobs without handling output or anything.
2894 * This function is to be called only in the event of a major
2895 * error. Most definitely NOT to be called from JobInterrupt.
2898 * All children are killed, not just the firstborn
2903 Job *job; /* the job descriptor in that element */
2906 aborting = ABORT_ERROR;
2909 TAILQ_FOREACH(job, &jobs, link) {
2911 * kill the child process with increasingly drastic
2912 * signals to make darn sure it's dead.
2914 KILL(job->pid, SIGINT);
2915 KILL(job->pid, SIGKILL);
2920 * Catch as many children as want to report in at first, then give up
2922 while (waitpid((pid_t)-1, &foo, WNOHANG) > 0)
2928 * Tries to restart stopped jobs if there are slots available.
2929 * Note that this tries to restart them regardless of pending errors.
2930 * It's not good to leave stopped jobs lying around!
2933 * Resumes(and possibly migrates) jobs.
2936 JobRestartJobs(void)
2940 while (!jobFull && (job = TAILQ_FIRST(&stoppedJobs)) != NULL) {
2941 DEBUGF(JOB, ("Job queue is not full. "
2942 "Restarting a stopped job.\n"));
2943 TAILQ_REMOVE(&stoppedJobs, job, link);
2950 * Execute the command in cmd, and return the output of that command
2954 * A string containing the output of the command, or the empty string
2955 * If error is not NULL, it contains the reason for the command failure
2956 * Any output sent to stderr in the child process is passed to stderr,
2957 * and not captured in the string.
2960 * The string must be freed by the caller.
2963 Cmd_Exec(const char *cmd, const char **error)
2965 int fds[2]; /* Pipe streams */
2966 int cpid; /* Child PID */
2967 int pid; /* PID from wait() */
2968 int status; /* command exit status */
2969 Buffer *buf; /* buffer to store the result */
2977 if (shellPath == NULL)
2980 * Open a pipe for fetching its output
2982 if (pipe(fds) == -1) {
2983 *error = "Couldn't create pipe for \"%s\"";
2987 ps.in = STDIN_FILENO;
2989 ps.err = STDERR_FILENO;
2991 ps.merge_errors = 0;
2995 /* Set up arguments for shell */
2996 argv[0] = shellName;
3006 if ((cpid = vfork()) == -1) {
3007 *error = "Couldn't exec \"%s\"";
3009 } else if (cpid == 0) {
3013 close(fds[0]); /* Close input side of pipe */
3020 * No need for the writing half
3025 char result[BUFSIZ];
3027 rcnt = read(fds[0], result, sizeof(result));
3029 Buf_AddBytes(buf, (size_t)rcnt, (Byte *)result);
3030 } while (rcnt > 0 || (rcnt == -1 && errno == EINTR));
3033 *error = "Error reading shell's output for \"%s\"";
3036 * Close the input side of the pipe.
3041 * Wait for the process to exit.
3043 while (((pid = wait(&status)) != cpid) && (pid >= 0))
3047 *error = "\"%s\" returned non-zero status";
3049 Buf_StripNewlines(buf);
3058 * The routines in this file implement the full-compatibility
3059 * mode of PMake. Most of the special functionality of PMake
3060 * is available in this mode. Things not supported:
3061 * - different shells.
3062 * - friendly variable substitution.
3065 * Compat_Run Initialize things for this module and recreate
3066 * thems as need creatin'
3070 * The following array is used to make a fast determination of which
3071 * characters are interpreted specially by the shell. If a command
3072 * contains any of these characters, it is executed by the shell, not
3075 static char meta[256];
3077 static GNode *curTarg = NULL;
3078 static GNode *ENDNode;
3083 const char *cp; /* Pointer to string of shell meta-characters */
3085 for (cp = "#=|^(){};&<>*?[]:$`\\\n"; *cp != '\0'; cp++) {
3086 meta[(unsigned char)*cp] = 1;
3089 * The null character serves as a sentinel in the string.
3095 * Interrupt handler - set flag and defer handling to the main code
3098 CompatCatchSig(int signo)
3101 interrupted = signo;
3105 *-----------------------------------------------------------------------
3106 * CompatInterrupt --
3107 * Interrupt the creation of the current target and remove it if
3108 * it ain't precious.
3114 * The target is removed and the process exits. If .INTERRUPT exists,
3115 * its commands are run first WITH INTERRUPTS IGNORED..
3117 *-----------------------------------------------------------------------
3120 CompatInterrupt(int signo)
3123 sigset_t nmask, omask;
3126 sigemptyset(&nmask);
3127 sigaddset(&nmask, SIGINT);
3128 sigaddset(&nmask, SIGTERM);
3129 sigaddset(&nmask, SIGHUP);
3130 sigaddset(&nmask, SIGQUIT);
3131 sigprocmask(SIG_SETMASK, &nmask, &omask);
3133 /* prevent recursion in evaluation of .INTERRUPT */
3136 if (curTarg != NULL && !Targ_Precious(curTarg)) {
3138 char *file = Var_Value(TARGET, curTarg, &p1);
3140 if (!noExecute && eunlink(file) != -1) {
3141 printf("*** %s removed\n", file);
3147 * Run .INTERRUPT only if hit with interrupt signal
3149 if (signo == SIGINT) {
3150 gn = Targ_FindNode(".INTERRUPT", TARG_NOCREATE);
3152 LST_FOREACH(ln, &gn->commands) {
3153 if (Compat_RunCommand(Lst_Datum(ln), gn))
3159 sigprocmask(SIG_SETMASK, &omask, NULL);
3161 if (signo == SIGQUIT)
3163 signal(signo, SIG_DFL);
3164 kill(getpid(), signo);
3168 *-----------------------------------------------------------------------
3172 * Returns 1 if a specified line must be executed by the shell,
3173 * and 0 if it can be run via execvp().
3176 * Uses brk_string so destroys the contents of argv.
3178 *-----------------------------------------------------------------------
3181 shellneed(char *cmd)
3183 static const char *sh_builtin[] = {
3184 "alias", "cd", "eval", "exec",
3185 "exit", "read", "set", "ulimit",
3186 "unalias", "umask", "unset", "wait",
3192 av = brk_string(cmd, NULL, TRUE);
3193 for (p = sh_builtin; *p != 0; p++)
3194 if (strcmp(av[1], *p) == 0)
3200 *-----------------------------------------------------------------------
3201 * Compat_RunCommand --
3202 * Execute the next command for a target. If the command returns an
3203 * error, the node's made field is set to ERROR and creation stops.
3204 * The node from which the command came is also given.
3207 * 0 if the command succeeded, 1 if an error occurred.
3210 * The node's 'made' field may be set to ERROR.
3212 *-----------------------------------------------------------------------
3215 Compat_RunCommand(char *cmd, GNode *gn)
3217 char *cmdStart; /* Start of expanded command */
3219 Boolean silent; /* Don't print command */
3220 Boolean doit; /* Execute even in -n */
3221 Boolean errCheck; /* Check errors */
3222 int reason; /* Reason for child's death */
3223 int status; /* Description of child's death */
3224 int cpid; /* Child actually found */
3225 ReturnStatus rstat; /* Status of fork */
3226 LstNode *cmdNode; /* Node where current command is located */
3227 char **av; /* Argument vector for thing to exec */
3228 char *cmd_save; /* saved cmd */
3232 * Avoid clobbered variable warnings by forcing the compiler
3233 * to ``unregister'' variables
3239 silent = gn->type & OP_SILENT;
3240 errCheck = !(gn->type & OP_IGNORE);
3243 cmdNode = Lst_Member(&gn->commands, cmd);
3244 cmdStart = Buf_Peel(Var_Subst(cmd, gn, FALSE));
3247 * brk_string will return an argv with a NULL in av[0], thus causing
3248 * execvp() to choke and die horribly. Besides, how can we execute a
3249 * null command? In any case, we warn the user that the command
3250 * expanded to nothing (is this the right thing to do?).
3252 if (*cmdStart == '\0') {
3254 Error("%s expands to empty string", cmd);
3259 Lst_Replace(cmdNode, cmdStart);
3261 if ((gn->type & OP_SAVE_CMDS) && (gn != ENDNode)) {
3262 Lst_AtEnd(&ENDNode->commands, cmdStart);
3264 } else if (strcmp(cmdStart, "...") == 0) {
3265 gn->type |= OP_SAVE_CMDS;
3269 while (*cmd == '@' || *cmd == '-' || *cmd == '+') {
3273 silent = DEBUG(LOUD) ? FALSE : TRUE;
3282 if (!meta[0]) /* we came here from jobs */
3289 while (isspace((unsigned char)*cmd))
3293 * Print the command before echoing if we're not supposed to be quiet
3294 * for this one. We also print the command if -n given, but not if '+'.
3296 if (!silent || (noExecute && !doit)) {
3297 printf("%s\n", cmd);
3302 * If we're not supposed to execute any commands, this is as far as
3305 if (!doit && noExecute) {
3310 * Search for meta characters in the command. If there are no meta
3311 * characters, there's no need to execute a shell to execute the
3314 for (cp = cmd; !meta[(unsigned char)*cp]; cp++)
3319 * If *cp isn't the null character, we hit a "meta" character
3320 * and need to pass the command off to the shell. We give the
3321 * shell the -e flag as well as -c if it's supposed to exit
3322 * when it hits an error.
3324 static char *shargv[4];
3326 shargv[0] = shellPath;
3327 shargv[1] = (errCheck ? "-ec" : "-c");
3332 } else if (shellneed(cmd)) {
3334 * This command must be passed by the shell for other reasons..
3335 * or.. possibly not at all.
3337 static char *shargv[4];
3339 shargv[0] = shellPath;
3340 shargv[1] = (errCheck ? "-ec" : "-c");
3347 * No meta-characters, so no need to exec a shell. Break the
3348 * command into words to form an argument vector we can execute.
3349 * brk_string sticks our name in av[0], so we have to
3352 av = brk_string(cmd, NULL, TRUE);
3356 ps.in = STDIN_FILENO;
3357 ps.out = STDOUT_FILENO;
3358 ps.err = STDERR_FILENO;
3360 ps.merge_errors = 0;
3367 * Fork and execute the single command. If the fork fails, we abort.
3369 if ((cpid = vfork()) == -1) {
3370 Fatal("Could not fork");
3372 } else if (cpid == 0) {
3381 * we need to print out the command associated with this
3382 * Gnode in Targ_PrintCmd from Targ_PrintGraph when debugging
3383 * at level g2, in main(), Fatal() and DieHorribly(),
3384 * therefore do not free it when debugging.
3386 if (!DEBUG(GRAPH2)) {
3388 Lst_Replace(cmdNode, cmd_save);
3391 * The child is off and running. Now all we can do is wait...
3394 while ((rstat = wait(&reason)) != cpid) {
3395 if (interrupted || (rstat == -1 && errno != EINTR)) {
3400 CompatInterrupt(interrupted);
3403 if (WIFSTOPPED(reason)) {
3405 status = WSTOPSIG(reason);
3406 } else if (WIFEXITED(reason)) {
3408 status = WEXITSTATUS(reason);
3410 printf("*** Error code %d",
3415 status = WTERMSIG(reason);
3416 printf("*** Signal %d", status);
3419 if (!WIFEXITED(reason) || status != 0) {
3428 printf(" (continuing)\n");
3432 * Continue executing
3433 * commands for this target.
3434 * If we return 0, this will
3437 printf(" (ignored)\n");
3443 Fatal("error in wait: %d", rstat);
3453 *-----------------------------------------------------------------------
3455 * Make a target, given the parent, to abort if necessary.
3458 * If an error is detected and not being ignored, the process exits.
3460 *-----------------------------------------------------------------------
3463 CompatMake(GNode *gn, GNode *pgn)
3467 if (gn->type & OP_USE) {
3468 Make_HandleUse(gn, pgn);
3470 } else if (gn->made == UNMADE) {
3472 * First mark ourselves to be made, then apply whatever
3473 * transformations the suffix module thinks are necessary.
3474 * Once that's done, we can descend and make all our children.
3475 * If any of them has an error but the -k flag was given, our
3476 * 'make' field will be set FALSE again. This is our signal to
3477 * not attempt to do anything but abort our parent as well.
3480 gn->made = BEINGMADE;
3482 LST_FOREACH(ln, &gn->children)
3483 CompatMake(Lst_Datum(ln), gn);
3490 if (Lst_Member(&gn->iParents, pgn) != NULL) {
3492 Var_Set(IMPSRC, Var_Value(TARGET, gn, &p1), pgn);
3497 * All the children were made ok. Now cmtime contains the
3498 * modification time of the newest child, we need to find out
3499 * if we exist and when we were modified last. The criteria for
3500 * datedness are defined by the Make_OODate function.
3502 DEBUGF(MAKE, ("Examining %s...", gn->name));
3503 if (!Make_OODate(gn)) {
3504 gn->made = UPTODATE;
3505 DEBUGF(MAKE, ("up-to-date.\n"));
3508 DEBUGF(MAKE, ("out-of-date.\n"));
3512 * If the user is just seeing if something is out-of-date,
3513 * exit now to tell him/her "yes".
3520 * We need to be re-made. We also have to make sure we've got
3521 * a $? variable. To be nice, we also define the $> variable
3522 * using Make_DoAllVar().
3527 * Alter our type to tell if errors should be ignored or things
3528 * should not be printed so Compat_RunCommand knows what to do.
3530 if (Targ_Ignore(gn)) {
3531 gn->type |= OP_IGNORE;
3533 if (Targ_Silent(gn)) {
3534 gn->type |= OP_SILENT;
3537 if (Job_CheckCommands(gn, Fatal)) {
3539 * Our commands are ok, but we still have to worry
3540 * about the -t flag...
3544 LST_FOREACH(ln, &gn->commands) {
3545 if (Compat_RunCommand(Lst_Datum(ln),
3551 Job_Touch(gn, gn->type & OP_SILENT);
3557 if (gn->made != ERROR) {
3559 * If the node was made successfully, mark it so, update
3560 * its modification time and timestamp all its parents.
3561 * Note that for .ZEROTIME targets, the timestamping
3562 * isn't done. This is to keep its state from affecting
3563 * that of its parent.
3568 * We can't re-stat the thing, but we can at least take
3569 * care of rules where a target depends on a source that
3570 * actually creates the target, but only if it has
3578 * mv y.tab.o parse.o
3579 * cmp -s y.tab.h parse.h || mv y.tab.h parse.h
3581 * In this case, if the definitions produced by yacc
3582 * haven't changed from before, parse.h won't have been
3583 * updated and gn->mtime will reflect the current
3584 * modification time for parse.h. This is something of a
3585 * kludge, I admit, but it's a useful one..
3587 * XXX: People like to use a rule like
3591 * To force things that depend on FRC to be made, so we
3592 * have to check for gn->children being empty as well...
3594 if (!Lst_IsEmpty(&gn->commands) ||
3595 Lst_IsEmpty(&gn->children)) {
3600 * This is what Make does and it's actually a good
3601 * thing, as it allows rules like
3603 * cmp -s y.tab.h parse.h || cp y.tab.h parse.h
3605 * to function as intended. Unfortunately, thanks to
3606 * the stateless nature of NFS (and the speed of this
3607 * program), there are times when the modification time
3608 * of a file created on a remote machine will not be
3609 * modified before the stat() implied by the Dir_MTime
3610 * occurs, thus leading us to believe that the file
3611 * is unchanged, wreaking havoc with files that depend
3614 * I have decided it is better to make too much than to
3615 * make too little, so this stuff is commented out
3616 * unless you're sure it's ok.
3619 if (noExecute || Dir_MTime(gn) == 0) {
3622 if (gn->cmtime > gn->mtime)
3623 gn->mtime = gn->cmtime;
3624 DEBUGF(MAKE, ("update time: %s\n",
3625 Targ_FmtTime(gn->mtime)));
3627 if (!(gn->type & OP_EXEC)) {
3628 pgn->childMade = TRUE;
3629 Make_TimeStamp(pgn, gn);
3632 } else if (keepgoing) {
3638 printf("\n\nStop in %s.\n",
3639 Var_Value(".CURDIR", gn, &p1));
3643 } else if (gn->made == ERROR) {
3645 * Already had an error when making this beastie. Tell the
3650 if (Lst_Member(&gn->iParents, pgn) != NULL) {
3652 Var_Set(IMPSRC, Var_Value(TARGET, gn, &p1), pgn);
3657 Error("Graph cycles through %s\n", gn->name);
3662 if ((gn->type & OP_EXEC) == 0) {
3663 pgn->childMade = TRUE;
3664 Make_TimeStamp(pgn, gn);
3668 if ((gn->type & OP_EXEC) == 0) {
3669 Make_TimeStamp(pgn, gn);
3681 *-----------------------------------------------------------------------
3683 * Start making again, given a list of target nodes.
3691 *-----------------------------------------------------------------------
3694 Compat_Run(Lst *targs)
3696 GNode *gn = NULL; /* Current root target */
3697 int error_cnt; /* Number of targets not remade due to errors */
3701 Shell_Init(); /* Set up shell. */
3703 if (signal(SIGINT, SIG_IGN) != SIG_IGN) {
3704 signal(SIGINT, CompatCatchSig);
3706 if (signal(SIGTERM, SIG_IGN) != SIG_IGN) {
3707 signal(SIGTERM, CompatCatchSig);
3709 if (signal(SIGHUP, SIG_IGN) != SIG_IGN) {
3710 signal(SIGHUP, CompatCatchSig);
3712 if (signal(SIGQUIT, SIG_IGN) != SIG_IGN) {
3713 signal(SIGQUIT, CompatCatchSig);
3716 ENDNode = Targ_FindNode(".END", TARG_CREATE);
3718 * If the user has defined a .BEGIN target, execute the commands
3722 gn = Targ_FindNode(".BEGIN", TARG_NOCREATE);
3724 LST_FOREACH(ln, &gn->commands) {
3725 if (Compat_RunCommand(Lst_Datum(ln), gn))
3728 if (gn->made == ERROR) {
3729 printf("\n\nStop.\n");
3736 * For each entry in the list of targets to create, call CompatMake on
3737 * it to create the thing. CompatMake will leave the 'made' field of gn
3738 * in one of several states:
3739 * UPTODATE gn was already up-to-date
3740 * MADE gn was recreated successfully
3741 * ERROR An error occurred while gn was being created
3742 * ABORTED gn was not remade because one of its inferiors
3743 * could not be made due to errors.
3746 while (!Lst_IsEmpty(targs)) {
3747 gn = Lst_DeQueue(targs);
3750 if (gn->made == UPTODATE) {
3751 printf("`%s' is up to date.\n", gn->name);
3752 } else if (gn->made == ABORTED) {
3753 printf("`%s' not remade because of errors.\n",
3760 * If the user has defined a .END target, run its commands.
3762 if (error_cnt == 0) {
3763 LST_FOREACH(ln, &ENDNode->commands) {
3764 if (Compat_RunCommand(Lst_Datum(ln), gn))
projects / dragonfly.git / blob