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.95 2005/05/14 06:26:22 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 * The routines in this file implement the full-compatibility
101 * mode of PMake. Most of the special functionality of PMake
102 * is available in this mode. Things not supported:
103 * - different shells.
104 * - friendly variable substitution.
107 * Compat_Run Initialize things for this module and recreate
108 * thems as need creatin'
111 #include <sys/queue.h>
112 #include <sys/types.h>
113 #include <sys/select.h>
114 #include <sys/stat.h>
116 #include <sys/event.h>
118 #include <sys/wait.h>
122 #include <inttypes.h>
138 #include "pathnames.h"
145 #define TMPPAT "/tmp/makeXXXXXXXXXX"
149 * The SEL_ constants determine the maximum amount of time spent in select
150 * before coming out to see if a child has finished. SEL_SEC is the number of
151 * seconds and SEL_USEC is the number of micro-seconds
155 #endif /* !USE_KQUEUE */
158 * Job Table definitions.
160 * The job "table" is kept as a linked Lst in 'jobs', with the number of
161 * active jobs maintained in the 'nJobs' variable. At no time will this
162 * exceed the value of 'maxJobs', initialized by the Job_Init function.
164 * When a job is finished, the Make_Update function is called on each of the
165 * parents of the node which was just remade. This takes care of the upward
166 * traversal of the dependency graph.
168 #define JOB_BUFSIZE 1024
170 pid_t pid; /* The child's process ID */
172 struct GNode *node; /* The target the child is making */
175 * A LstNode for the first command to be saved after the job completes.
176 * This is NULL if there was no "..." in the job's commands.
181 * An FILE* for writing out the commands. This is only
182 * used before the job is actually started.
187 * A word of flags which determine how the module handles errors,
188 * echoing, etc. for the job
190 short flags; /* Flags to control treatment of job */
191 #define JOB_IGNERR 0x001 /* Ignore non-zero exits */
192 #define JOB_SILENT 0x002 /* no output */
193 #define JOB_SPECIAL 0x004 /* Target is a special one. i.e. run it locally
194 * if we can't export it and maxLocal is 0 */
195 #define JOB_IGNDOTS 0x008 /* Ignore "..." lines when processing
197 #define JOB_FIRST 0x020 /* Job is first job for the node */
198 #define JOB_RESTART 0x080 /* Job needs to be completely restarted */
199 #define JOB_RESUME 0x100 /* Job needs to be resumed b/c it stopped,
201 #define JOB_CONTINUING 0x200 /* We are in the process of resuming this job.
202 * Used to avoid infinite recursion between
203 * JobFinish and JobRestart */
205 /* union for handling shell's output */
208 * This part is used when usePipes is true.
209 * The output is being caught via a pipe and the descriptors
210 * of our pipe, an array in which output is line buffered and
211 * the current position in that buffer are all maintained for
216 * Input side of pipe associated with
217 * job's output channel
222 * Output side of pipe associated with job's
228 * Buffer for storing the output of the
231 char op_outBuf[JOB_BUFSIZE + 1];
233 /* Current position in op_outBuf */
238 * If usePipes is false the output is routed to a temporary
239 * file and all that is kept is the name of the file and the
240 * descriptor open to the file.
243 /* Name of file to which shell output was rerouted */
244 char of_outFile[sizeof(TMPPAT)];
247 * Stream open to the output file. Used to funnel all
248 * from a single job to one file while still allowing
249 * multiple shell invocations
254 } output; /* Data for tracking a shell's output */
256 TAILQ_ENTRY(Job) link; /* list link */
259 #define outPipe output.o_pipe.op_outPipe
260 #define inPipe output.o_pipe.op_inPipe
261 #define outBuf output.o_pipe.op_outBuf
262 #define curPos output.o_pipe.op_curPos
263 #define outFile output.o_file.of_outFile
264 #define outFd output.o_file.of_outFd
266 TAILQ_HEAD(JobList, Job);
269 * Shell Specifications:
271 * Some special stuff goes on if a shell doesn't have error control. In such
272 * a case, errCheck becomes a printf template for echoing the command,
273 * should echoing be on and ignErr becomes another printf template for
274 * executing the command while ignoring the return status. If either of these
275 * strings is empty when hasErrCtl is FALSE, the command will be executed
276 * anyway as is and if it causes an error, so be it.
278 #define DEF_SHELL_STRUCT(TAG, CONST) \
281 * the name of the shell. For Bourne and C shells, this is used \
282 * only to find the shell description when used as the single \
283 * source of a .SHELL target. For user-defined shells, this is \
284 * the full path of the shell. \
288 /* True if both echoOff and echoOn defined */ \
289 Boolean hasEchoCtl; \
291 CONST char *echoOff; /* command to turn off echo */ \
292 CONST char *echoOn; /* command to turn it back on */\
295 * What the shell prints, and its length, when given the \
296 * echo-off command. This line will not be printed when \
297 * received from the shell. This is usually the command which \
298 * was executed to turn off echoing \
300 CONST char *noPrint; \
302 /* set if can control error checking for individual commands */ \
305 /* string to turn error checking on */ \
306 CONST char *errCheck; \
308 /* string to turn off error checking */ \
309 CONST char *ignErr; \
311 CONST char *echo; /* command line flag: echo commands */ \
312 CONST char *exit; /* command line flag: exit on error */ \
315 DEF_SHELL_STRUCT(Shell,);
316 DEF_SHELL_STRUCT(CShell, const);
319 * error handling variables
321 static int errors = 0; /* number of errors reported */
322 static int aborting = 0; /* why is the make aborting? */
323 #define ABORT_ERROR 1 /* Because of an error */
324 #define ABORT_INTERRUPT 2 /* Because it was interrupted */
325 #define ABORT_WAIT 3 /* Waiting for jobs to finish */
328 * XXX: Avoid SunOS bug... FILENO() is fp->_file, and file
329 * is a char! So when we go above 127 we turn negative!
331 #define FILENO(a) ((unsigned)fileno(a))
334 * post-make command processing. The node postCommands is really just the
335 * .END target but we keep it around to avoid having to search for it
338 static GNode *postCommands;
341 * The number of commands actually printed for a target. Should this
342 * number be 0, no shell will be executed.
344 static int numCommands;
347 * Return values from JobStart.
349 #define JOB_RUNNING 0 /* Job is running */
350 #define JOB_ERROR 1 /* Error in starting the job */
351 #define JOB_FINISHED 2 /* The job is already finished */
352 #define JOB_STOPPED 3 /* The job is stopped */
355 * Descriptions for various shells.
357 static const struct CShell shells[] = {
359 * CSH description. The csh can do echo control by playing
360 * with the setting of the 'echo' shell variable. Sadly,
361 * however, it is unable to do error control nicely.
365 TRUE, "unset verbose", "set verbose", "unset verbose",
366 FALSE, "echo \"%s\"\n", "csh -c \"%s || exit 0\"",
370 * SH description. Echo control is also possible and, under
371 * sun UNIX anyway, one can even control error checking.
375 TRUE, "set -", "set -v", "set -",
376 TRUE, "set -e", "set +e",
377 #ifdef OLDBOURNESHELL
378 FALSE, "echo \"%s\"\n", "sh -c '%s || exit 0'\n",
383 * KSH description. The Korn shell has a superset of
384 * the Bourne shell's functionality.
388 TRUE, "set -", "set -v", "set -",
389 TRUE, "set -e", "set +e",
395 * This is the shell to which we pass all commands in the Makefile.
396 * It is set by the Job_ParseShell function.
398 static struct Shell *commandShell = NULL;
399 static char *shellPath = NULL; /* full pathname of executable image */
400 static char *shellName = NULL; /* last component of shell */
402 int maxJobs; /* The most children we can run at once */
403 static int nJobs; /* The number of children currently running */
405 /* The structures that describe them */
406 static struct JobList jobs = TAILQ_HEAD_INITIALIZER(jobs);
408 static Boolean jobFull; /* Flag to tell when the job table is full. It
409 * is set TRUE when (1) the total number of
410 * running jobs equals the maximum allowed */
412 static int kqfd; /* File descriptor obtained by kqueue() */
414 static fd_set outputs; /* Set of descriptors of pipes connected to
415 * the output channels of children */
418 static GNode *lastNode; /* The node for which output was most recently
420 static const char *targFmt; /* Format string to use to head output from a
421 * job when it's not the most-recent job heard
424 #define TARG_FMT "--- %s ---\n" /* Default format */
425 #define MESSAGE(fp, gn) \
426 fprintf(fp, targFmt, gn->name);
429 * When JobStart attempts to run a job but isn't allowed to
430 * or when Job_CatchChildren detects a job that has
431 * been stopped somehow, the job is placed on the stoppedJobs queue to be run
432 * when the next job finishes.
434 * Lst of Job structures describing jobs that were stopped due to
435 * concurrency limits or externally
437 static struct JobList stoppedJobs = TAILQ_HEAD_INITIALIZER(stoppedJobs);
439 static int fifoFd; /* Fd of our job fifo */
440 static char fifoName[] = "/tmp/make_fifo_XXXXXXXXX";
441 static int fifoMaster;
443 static sig_atomic_t interrupted;
446 #if defined(USE_PGRP) && defined(SYSV)
447 # define KILL(pid, sig) killpg(-(pid), (sig))
449 # if defined(USE_PGRP)
450 # define KILL(pid, sig) killpg((pid), (sig))
452 # define KILL(pid, sig) kill((pid), (sig))
457 * Grmpf... There is no way to set bits of the wait structure
458 * anymore with the stupid W*() macros. I liked the union wait
459 * stuff much more. So, we devise our own macros... This is
460 * really ugly, use dramamine sparingly. You have been warned.
462 #define W_SETMASKED(st, val, fun) \
465 int mask = fun(sh); \
467 for (sh = 0; ((mask >> sh) & 1) == 0; sh++) \
469 *(st) = (*(st) & ~mask) | ((val) << sh); \
472 #define W_SETTERMSIG(st, val) W_SETMASKED(st, val, WTERMSIG)
473 #define W_SETEXITSTATUS(st, val) W_SETMASKED(st, val, WEXITSTATUS)
476 * Information used to create a new process.
478 typedef struct ProcStuff {
479 int in; /* stdin for new process */
480 int out; /* stdout for new process */
481 int err; /* stderr for new process */
483 int merge_errors; /* true if stderr is redirected to stdin */
484 int pgroup; /* true if new process a process leader */
485 int searchpath; /* true if binary should be found via $PATH */
488 int argv_free; /* release argv after use */
494 static void JobRestart(Job *);
495 static int JobStart(GNode *, int, Job *);
496 static void JobDoOutput(Job *, Boolean);
497 static struct Shell *JobMatchShell(const char *);
498 static void JobInterrupt(int, int);
499 static void JobRestartJobs(void);
500 static void ProcExec(const ProcStuff *) __dead2;
501 static int Compat_RunCommand(char *, struct GNode *);
504 * The following array is used to make a fast determination of which
505 * characters are interpreted specially by the shell. If a command
506 * contains any of these characters, it is executed by the shell, not
509 static char meta[256];
511 static GNode *curTarg = NULL;
512 static GNode *ENDNode;
515 * Create a fifo file with a uniq filename, and returns a file
516 * descriptor to that fifo.
519 mkfifotemp(char *template)
524 const char padchar[] =
525 "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
527 if (template[0] == '\0') {
528 errno = EINVAL; /* bad input string */
532 /* Find end of template string. */
533 pathend = strchr(template, '\0');
537 * Starting from the end of the template replace spaces with 'X' in
538 * them with random characters until there are no more 'X'.
540 while (ptr >= template && *ptr == 'X') {
541 uint32_t rand_num = arc4random() % (sizeof(padchar) - 1);
542 *ptr-- = padchar[rand_num];
546 /* Check the target directory. */
547 for (; ptr > template; --ptr) {
552 if (stat(template, &sbuf) != 0)
555 if (!S_ISDIR(sbuf.st_mode)) {
565 if (mkfifo(template, 0600) == 0) {
568 if ((fd = open(template, O_RDWR, 0600)) < 0) {
575 if (errno != EEXIST) {
581 * If we have a collision, cycle through the space of
584 for (ptr = start;;) {
587 if (*ptr == '\0' || ptr == pathend)
590 pad = strchr(padchar, *ptr);
591 if (pad == NULL || *++pad == '\0') {
603 catch_child(int sig __unused)
613 * Catch SIGCHLD so that we get kicked out of select() when we
614 * need to look at a child. This is only known to matter for the
615 * -j case (perhaps without -P).
617 * XXX this is intentionally misplaced.
621 sigemptyset(&sa.sa_mask);
622 sa.sa_flags = SA_RESTART | SA_NOCLDSTOP;
623 sa.sa_handler = catch_child;
624 sigaction(SIGCHLD, &sa, NULL);
628 * Turn off ENV to make ksh happier.
635 * Replace the current process.
638 ProcExec(const ProcStuff *ps)
640 if (ps->in != STDIN_FILENO) {
642 * Redirect the child's stdin to the input fd
643 * and reset it to the beginning (again).
645 if (dup2(ps->in, STDIN_FILENO) == -1)
646 Punt("Cannot dup2: %s", strerror(errno));
647 lseek(STDIN_FILENO, (off_t)0, SEEK_SET);
650 if (ps->out != STDOUT_FILENO) {
652 * Redirect the child's stdout to the output fd.
654 if (dup2(ps->out, STDOUT_FILENO) == -1)
655 Punt("Cannot dup2: %s", strerror(errno));
659 if (ps->err != STDERR_FILENO) {
661 * Redirect the child's stderr to the err fd.
663 if (dup2(ps->err, STDERR_FILENO) == -1)
664 Punt("Cannot dup2: %s", strerror(errno));
668 if (ps->merge_errors) {
670 * Send stderr to parent process too.
672 if (dup2(STDOUT_FILENO, STDERR_FILENO) == -1)
673 Punt("Cannot dup2: %s", strerror(errno));
677 * The file descriptors for stdin, stdout, or stderr might
678 * have been marked close-on-exec. Clear the flag on all
681 fcntl(STDIN_FILENO, F_SETFD,
682 fcntl(STDIN_FILENO, F_GETFD) & (~FD_CLOEXEC));
683 fcntl(STDOUT_FILENO, F_SETFD,
684 fcntl(STDOUT_FILENO, F_GETFD) & (~FD_CLOEXEC));
685 fcntl(STDERR_FILENO, F_SETFD,
686 fcntl(STDERR_FILENO, F_GETFD) & (~FD_CLOEXEC));
691 * Become a process group leader, so we can kill it and all
692 * its descendants in one fell swoop, by killing its process
693 * family, but not commit suicide.
698 setpgid(0, getpid());
700 #endif /* USE_PGRP */
703 if (ps->searchpath) {
704 execvp(ps->argv[0], ps->argv);
706 write(STDERR_FILENO, ps->argv[0], strlen(ps->argv[0]));
707 write(STDERR_FILENO, ":", 1);
708 write(STDERR_FILENO, strerror(errno), strlen(strerror(errno)));
709 write(STDERR_FILENO, "\n", 1);
711 execv(shellPath, ps->argv);
714 "Could not execute shell\n",
715 sizeof("Could not execute shell"));
719 * Since we are the child process, exit without flushing buffers.
725 * Wait for child process to terminate.
728 ProcWait(ProcStuff *ps)
734 * Wait for the process to exit.
737 pid = waitpid(ps->child_pid, &status, 0);
738 if (pid == -1 && errno != EINTR) {
739 Fatal("error in wait: %d", pid);
742 if (pid == ps->child_pid) {
755 * Got a signal. Set global variables and hope that someone will
759 JobCatchSig(int signo)
767 * Pass a signal on to all local jobs if
768 * USE_PGRP is defined, then die ourselves.
771 * We die by the same signal.
774 JobPassSig(int signo)
777 sigset_t nmask, omask;
778 struct sigaction act;
781 sigaddset(&nmask, signo);
782 sigprocmask(SIG_SETMASK, &nmask, &omask);
784 DEBUGF(JOB, ("JobPassSig(%d) called.\n", signo));
785 TAILQ_FOREACH(job, &jobs, link) {
786 DEBUGF(JOB, ("JobPassSig passing signal %d to child %jd.\n",
787 signo, (intmax_t)job->pid));
788 KILL(job->pid, signo);
792 * Deal with proper cleanup based on the signal received. We only run
793 * the .INTERRUPT target if the signal was in fact an interrupt.
794 * The other three termination signals are more of a "get out *now*"
797 if (signo == SIGINT) {
798 JobInterrupt(TRUE, signo);
799 } else if (signo == SIGHUP || signo == SIGTERM || signo == SIGQUIT) {
800 JobInterrupt(FALSE, signo);
804 * Leave gracefully if SIGQUIT, rather than core dumping.
806 if (signo == SIGQUIT) {
811 * Send ourselves the signal now we've given the message to everyone
812 * else. Note we block everything else possible while we're getting
813 * the signal. This ensures that all our jobs get continued when we
814 * wake up before we take any other signal.
815 * XXX this comment seems wrong.
817 act.sa_handler = SIG_DFL;
818 sigemptyset(&act.sa_mask);
820 sigaction(signo, &act, NULL);
822 DEBUGF(JOB, ("JobPassSig passing signal to self, mask = %x.\n",
823 ~0 & ~(1 << (signo - 1))));
824 signal(signo, SIG_DFL);
826 KILL(getpid(), signo);
829 TAILQ_FOREACH(job, &jobs, link) {
830 DEBUGF(JOB, ("JobPassSig passing signal %d to child %jd.\n",
831 signo, (intmax_t)job->pid));
832 KILL(job->pid, signo);
835 sigprocmask(SIG_SETMASK, &omask, NULL);
836 sigprocmask(SIG_SETMASK, &omask, NULL);
837 act.sa_handler = JobPassSig;
838 sigaction(signo, &act, NULL);
843 * Put out another command for the given job. If the command starts
844 * with an @ or a - we process it specially. In the former case,
845 * so long as the -s and -n flags weren't given to make, we stick
846 * a shell-specific echoOff command in the script. In the latter,
847 * we ignore errors for the entire job, unless the shell has error
849 * If the command is just "..." we take all future commands for this
850 * job to be commands to be executed once the entire graph has been
851 * made and return non-zero to signal that the end of the commands
852 * was reached. These commands are later attached to the postCommands
853 * node and executed by Job_Finish when all things are done.
854 * This function is called from JobStart via LST_FOREACH.
857 * Always 0, unless the command was "..."
860 * If the command begins with a '-' and the shell has no error control,
861 * the JOB_IGNERR flag is set in the job descriptor.
862 * If the command is "..." and we're not ignoring such things,
863 * tailCmds is set to the successor node of the cmd.
864 * numCommands is incremented if the command is actually printed.
867 JobPrintCommand(char *cmd, Job *job)
869 Boolean noSpecials; /* true if we shouldn't worry about
870 * inserting special commands into
871 * the input stream. */
872 Boolean shutUp = FALSE; /* true if we put a no echo command
873 * into the command file */
874 Boolean errOff = FALSE; /* true if we turned error checking
875 * off before printing the command
876 * and need to turn it back on */
877 const char *cmdTemplate;/* Template to use when printing the command */
878 char *cmdStart; /* Start of expanded command */
879 LstNode *cmdNode; /* Node for replacing the command */
881 noSpecials = (noExecute && !(job->node->type & OP_MAKE));
883 if (strcmp(cmd, "...") == 0) {
884 job->node->type |= OP_SAVE_CMDS;
885 if ((job->flags & JOB_IGNDOTS) == 0) {
887 Lst_Succ(Lst_Member(&job->node->commands, cmd));
893 #define DBPRINTF(fmt, arg) \
894 DEBUGF(JOB, (fmt, arg)); \
895 fprintf(job->cmdFILE, fmt, arg); \
896 fflush(job->cmdFILE);
901 * For debugging, we replace each command with the result of expanding
902 * the variables in the command.
904 cmdNode = Lst_Member(&job->node->commands, cmd);
906 cmd = Buf_Peel(Var_Subst(cmd, job->node, FALSE));
909 Lst_Replace(cmdNode, cmdStart);
911 cmdTemplate = "%s\n";
914 * Check for leading @', -' or +'s to control echoing, error checking,
915 * and execution on -n.
917 while (*cmd == '@' || *cmd == '-' || *cmd == '+') {
921 shutUp = DEBUG(LOUD) ? FALSE : TRUE;
931 * We're not actually exececuting anything...
932 * but this one needs to be - use compat mode
935 Compat_RunCommand(cmd, job->node);
943 while (isspace((unsigned char)*cmd))
947 if (!(job->flags & JOB_SILENT) && !noSpecials &&
948 commandShell->hasEchoCtl) {
949 DBPRINTF("%s\n", commandShell->echoOff);
956 if (!(job->flags & JOB_IGNERR) && !noSpecials) {
957 if (commandShell->hasErrCtl) {
959 * We don't want the error-control commands
960 * showing up either, so we turn off echoing
961 * while executing them. We could put another
962 * field in the shell structure to tell
963 * JobDoOutput to look for this string too,
964 * but why make it any more complex than
967 if (!(job->flags & JOB_SILENT) && !shutUp &&
968 commandShell->hasEchoCtl) {
969 DBPRINTF("%s\n", commandShell->echoOff);
970 DBPRINTF("%s\n", commandShell->ignErr);
971 DBPRINTF("%s\n", commandShell->echoOn);
973 DBPRINTF("%s\n", commandShell->ignErr);
975 } else if (commandShell->ignErr &&
976 *commandShell->ignErr != '\0') {
978 * The shell has no error control, so we need to
979 * be weird to get it to ignore any errors from
980 * the command. If echoing is turned on, we turn
981 * it off and use the errCheck template to echo
982 * the command. Leave echoing off so the user
983 * doesn't see the weirdness we go through to
984 * ignore errors. Set cmdTemplate to use the
985 * weirdness instead of the simple "%s\n"
988 if (!(job->flags & JOB_SILENT) && !shutUp &&
989 commandShell->hasEchoCtl) {
990 DBPRINTF("%s\n", commandShell->echoOff);
991 DBPRINTF(commandShell->errCheck, cmd);
994 cmdTemplate = commandShell->ignErr;
996 * The error ignoration (hee hee) is already
997 * taken care of by the ignErr template, so
998 * pretend error checking is still on.
1009 DBPRINTF(cmdTemplate, cmd);
1013 * If echoing is already off, there's no point in issuing the
1014 * echoOff command. Otherwise we issue it and pretend it was on
1015 * for the whole command...
1017 if (!shutUp && !(job->flags & JOB_SILENT) &&
1018 commandShell->hasEchoCtl) {
1019 DBPRINTF("%s\n", commandShell->echoOff);
1022 DBPRINTF("%s\n", commandShell->errCheck);
1025 DBPRINTF("%s\n", commandShell->echoOn);
1032 * Called to close both input and output pipes when a job is finished.
1035 * The file descriptors associated with the job are closed.
1042 #if !defined(USE_KQUEUE)
1043 FD_CLR(job->inPipe, &outputs);
1045 if (job->outPipe != job->inPipe) {
1046 close(job->outPipe);
1048 JobDoOutput(job, TRUE);
1052 JobDoOutput(job, TRUE);
1058 * Do final processing for the given job including updating
1059 * parents and starting new jobs as available/necessary. Note
1060 * that we pay no attention to the JOB_IGNERR flag here.
1061 * This is because when we're called because of a noexecute flag
1062 * or something, jstat.w_status is 0 and when called from
1063 * Job_CatchChildren, the status is zeroed if it s/b ignored.
1066 * Some nodes may be put on the toBeMade queue.
1067 * Final commands for the job are placed on postCommands.
1069 * If we got an error and are aborting (aborting == ABORT_ERROR) and
1070 * the job list is now empty, we are done for the day.
1071 * If we recognized an error (errors !=0), we set the aborting flag
1072 * to ABORT_ERROR so no more jobs will be started.
1075 JobFinish(Job *job, int *status)
1080 if (WIFEXITED(*status)) {
1081 int job_status = WEXITSTATUS(*status);
1085 * Deal with ignored errors in -B mode. We need to
1086 * print a message telling of the ignored error as
1087 * well as setting status.w_status to 0 so the next
1088 * command gets run. To do this, we set done to be
1089 * TRUE if in -B mode and the job exited non-zero.
1091 if (job_status == 0) {
1094 if (job->flags & JOB_IGNERR) {
1098 * If it exited non-zero and either we're
1099 * doing things our way or we're not ignoring
1100 * errors, the job is finished. Similarly, if
1101 * the shell died because of a signal the job
1102 * is also finished. In these cases, finish
1103 * out the job's output before printing the
1107 if (job->cmdFILE != NULL &&
1108 job->cmdFILE != stdout) {
1109 fclose(job->cmdFILE);
1114 } else if (WIFSIGNALED(*status)) {
1115 if (WTERMSIG(*status) == SIGCONT) {
1117 * No need to close things down or anything.
1122 * If it exited non-zero and either we're
1123 * doing things our way or we're not ignoring
1124 * errors, the job is finished. Similarly, if
1125 * the shell died because of a signal the job
1126 * is also finished. In these cases, finish
1127 * out the job's output before printing the
1131 if (job->cmdFILE != NULL &&
1132 job->cmdFILE != stdout) {
1133 fclose(job->cmdFILE);
1139 * No need to close things down or anything.
1144 if (WIFEXITED(*status)) {
1145 if (done || DEBUG(JOB)) {
1150 (job->flags & JOB_IGNERR)) {
1152 * If output is going to a file and this job
1153 * is ignoring errors, arrange to have the
1154 * exit status sent to the output file as
1157 out = fdopen(job->outFd, "w");
1159 Punt("Cannot fdopen");
1164 DEBUGF(JOB, ("Process %jd exited.\n",
1165 (intmax_t)job->pid));
1167 if (WEXITSTATUS(*status) == 0) {
1169 if (usePipes && job->node != lastNode) {
1170 MESSAGE(out, job->node);
1171 lastNode = job->node;
1174 "*** Completed successfully\n");
1177 if (usePipes && job->node != lastNode) {
1178 MESSAGE(out, job->node);
1179 lastNode = job->node;
1181 fprintf(out, "*** Error code %d%s\n",
1182 WEXITSTATUS(*status),
1183 (job->flags & JOB_IGNERR) ?
1186 if (job->flags & JOB_IGNERR) {
1193 } else if (WIFSIGNALED(*status)) {
1194 if (done || DEBUG(JOB) || (WTERMSIG(*status) == SIGCONT)) {
1199 (job->flags & JOB_IGNERR)) {
1201 * If output is going to a file and this job
1202 * is ignoring errors, arrange to have the
1203 * exit status sent to the output file as
1206 out = fdopen(job->outFd, "w");
1208 Punt("Cannot fdopen");
1213 if (WTERMSIG(*status) == SIGCONT) {
1215 * If the beastie has continued, shift the
1216 * Job from the stopped list to the running
1217 * one (or re-stop it if concurrency is
1218 * exceeded) and go and get another child.
1220 if (job->flags & (JOB_RESUME | JOB_RESTART)) {
1221 if (usePipes && job->node != lastNode) {
1222 MESSAGE(out, job->node);
1223 lastNode = job->node;
1225 fprintf(out, "*** Continued\n");
1227 if (!(job->flags & JOB_CONTINUING)) {
1228 DEBUGF(JOB, ("Warning: process %jd was not "
1229 "continuing.\n", (intmax_t) job->pid));
1232 * We don't really want to restart a
1233 * job from scratch just because it
1234 * continued, especially not without
1235 * killing the continuing process!
1236 * That's why this is ifdef'ed out.
1242 job->flags &= ~JOB_CONTINUING;
1243 TAILQ_INSERT_TAIL(&jobs, job, link);
1245 DEBUGF(JOB, ("Process %jd is continuing locally.\n",
1246 (intmax_t) job->pid));
1247 if (nJobs == maxJobs) {
1249 DEBUGF(JOB, ("Job queue is full.\n"));
1255 if (usePipes && job->node != lastNode) {
1256 MESSAGE(out, job->node);
1257 lastNode = job->node;
1260 "*** Signal %d\n", WTERMSIG(*status));
1268 if (compatMake && !usePipes && (job->flags & JOB_IGNERR)) {
1270 * If output is going to a file and this job
1271 * is ignoring errors, arrange to have the
1272 * exit status sent to the output file as
1275 out = fdopen(job->outFd, "w");
1277 Punt("Cannot fdopen");
1282 DEBUGF(JOB, ("Process %jd stopped.\n", (intmax_t) job->pid));
1283 if (usePipes && job->node != lastNode) {
1284 MESSAGE(out, job->node);
1285 lastNode = job->node;
1287 fprintf(out, "*** Stopped -- signal %d\n", WSTOPSIG(*status));
1288 job->flags |= JOB_RESUME;
1289 TAILQ_INSERT_TAIL(&stoppedJobs, job, link);
1295 * Now handle the -B-mode stuff. If the beast still isn't finished,
1296 * try and restart the job on the next command. If JobStart says it's
1297 * ok, it's ok. If there's an error, this puppy is done.
1299 if (compatMake && WIFEXITED(*status) &&
1300 Lst_Succ(job->node->compat_command) != NULL) {
1301 switch (JobStart(job->node, job->flags & JOB_IGNDOTS, job)) {
1307 W_SETEXITSTATUS(status, 1);
1311 * If we got back a JOB_FINISHED code, JobStart has
1312 * already called Make_Update and freed the job
1313 * descriptor. We set done to false here to avoid fake
1314 * cycles and double frees. JobStart needs to do the
1315 * update so we can proceed up the graph when given
1327 if (done && aborting != ABORT_ERROR &&
1328 aborting != ABORT_INTERRUPT && *status == 0) {
1330 * As long as we aren't aborting and the job didn't return a
1331 * non-zero status that we shouldn't ignore, we call
1332 * Make_Update to update the parents. In addition, any saved
1333 * commands for the node are placed on the .END target.
1335 for (ln = job->tailCmds; ln != NULL; ln = LST_NEXT(ln)) {
1336 Lst_AtEnd(&postCommands->commands,
1338 Var_Subst(Lst_Datum(ln), job->node, FALSE)));
1341 job->node->made = MADE;
1342 Make_Update(job->node);
1345 } else if (*status != 0) {
1353 * Set aborting if any error.
1355 if (errors && !keepgoing && aborting != ABORT_INTERRUPT) {
1357 * If we found any errors in this batch of children and the -k
1358 * flag wasn't given, we set the aborting flag so no more jobs
1361 aborting = ABORT_ERROR;
1364 if (aborting == ABORT_ERROR && Job_Empty()) {
1366 * If we are aborting and the job table is now empty, we finish.
1374 * Touch the given target. Called by JobStart when the -t flag was
1375 * given. Prints messages unless told to be silent.
1378 * The data modification of the file is changed. In addition, if the
1379 * file did not exist, it is created.
1382 Job_Touch(GNode *gn, Boolean silent)
1384 int streamID; /* ID of stream opened to do the touch */
1385 struct utimbuf times; /* Times for utime() call */
1387 if (gn->type & (OP_JOIN | OP_USE | OP_EXEC | OP_OPTIONAL)) {
1389 * .JOIN, .USE, .ZEROTIME and .OPTIONAL targets are "virtual"
1390 * targets and, as such, shouldn't really be created.
1396 fprintf(stdout, "touch %s\n", gn->name);
1404 if (gn->type & OP_ARCHV) {
1406 } else if (gn->type & OP_LIB) {
1409 char *file = gn->path ? gn->path : gn->name;
1411 times.actime = times.modtime = now;
1412 if (utime(file, ×) < 0) {
1413 streamID = open(file, O_RDWR | O_CREAT, 0666);
1415 if (streamID >= 0) {
1419 * Read and write a byte to the file to change
1420 * the modification time, then close the file.
1422 if (read(streamID, &c, 1) == 1) {
1423 lseek(streamID, (off_t)0, SEEK_SET);
1424 write(streamID, &c, 1);
1429 fprintf(stdout, "*** couldn't touch %s: %s",
1430 file, strerror(errno));
1439 * Make sure the given node has all the commands it needs.
1442 * TRUE if the commands list is/was ok.
1445 * The node will have commands from the .DEFAULT rule added to it
1449 Job_CheckCommands(GNode *gn, void (*abortProc)(const char *, ...))
1452 if (OP_NOP(gn->type) && Lst_IsEmpty(&gn->commands) &&
1453 (gn->type & OP_LIB) == 0) {
1455 * No commands. Look for .DEFAULT rule from which we might infer
1458 if (DEFAULT != NULL && !Lst_IsEmpty(&DEFAULT->commands)) {
1461 * Make only looks for a .DEFAULT if the node was
1462 * never the target of an operator, so that's what we
1463 * do too. If a .DEFAULT was given, we substitute its
1464 * commands for gn's commands and set the IMPSRC
1465 * variable to be the target's name The DEFAULT node
1466 * acts like a transformation rule, in that gn also
1467 * inherits any attributes or sources attached to
1470 Make_HandleUse(DEFAULT, gn);
1471 Var_Set(IMPSRC, Var_Value(TARGET, gn, &p1), gn);
1474 } else if (Dir_MTime(gn) == 0) {
1476 * The node wasn't the target of an operator we have
1477 * no .DEFAULT rule to go on and the target doesn't
1478 * already exist. There's nothing more we can do for
1479 * this branch. If the -k flag wasn't given, we stop
1480 * in our tracks, otherwise we just don't update
1481 * this node's parents so they never get examined.
1483 static const char msg[] =
1484 "make: don't know how to make";
1486 if (gn->type & OP_OPTIONAL) {
1487 fprintf(stdout, "%s %s(ignored)\n",
1490 } else if (keepgoing) {
1491 fprintf(stdout, "%s %s(continuing)\n",
1497 if (strcmp(gn->name,"love") == 0)
1498 (*abortProc)("Not war.");
1501 (*abortProc)("%s %s. Stop",
1512 * Execute the shell for the given job. Called from JobStart and
1516 * A shell is executed, outputs is altered and the Job structure added
1520 JobExec(Job *job, char **argv)
1527 DEBUGF(JOB, ("Running %s\n", job->node->name));
1528 DEBUGF(JOB, ("\tCommand: "));
1529 for (i = 0; argv[i] != NULL; i++) {
1530 DEBUGF(JOB, ("%s ", argv[i]));
1532 DEBUGF(JOB, ("\n"));
1536 * Some jobs produce no output and it's disconcerting to have
1537 * no feedback of their running (since they produce no output, the
1538 * banner with their name in it never appears). This is an attempt to
1539 * provide that feedback, even if nothing follows it.
1541 if (lastNode != job->node && (job->flags & JOB_FIRST) &&
1542 !(job->flags & JOB_SILENT)) {
1543 MESSAGE(stdout, job->node);
1544 lastNode = job->node;
1547 ps.in = FILENO(job->cmdFILE);
1550 * Set up the child's output to be routed through the
1551 * pipe we've created for it.
1553 ps.out = job->outPipe;
1556 * We're capturing output in a file, so we duplicate
1557 * the descriptor to the temporary file into the
1560 ps.out = job->outFd;
1562 ps.err = STDERR_FILENO;
1564 ps.merge_errors = 1;
1572 * Fork. Warning since we are doing vfork() instead of fork(),
1573 * do not allocate memory in the child process!
1575 if ((ps.child_pid = vfork()) == -1) {
1576 Punt("Cannot fork");
1578 } else if (ps.child_pid == 0) {
1592 job->pid = ps.child_pid;
1594 if (usePipes && (job->flags & JOB_FIRST)) {
1596 * The first time a job is run for a node, we set the
1597 * current position in the buffer to the beginning and
1598 * mark another stream to watch in the outputs mask.
1601 struct kevent kev[2];
1605 #if defined(USE_KQUEUE)
1606 EV_SET(&kev[0], job->inPipe, EVFILT_READ, EV_ADD, 0, 0, job);
1607 EV_SET(&kev[1], job->pid, EVFILT_PROC,
1608 EV_ADD | EV_ONESHOT, NOTE_EXIT, 0, NULL);
1609 if (kevent(kqfd, kev, 2, NULL, 0, NULL) != 0) {
1611 * kevent() will fail if the job is already
1614 if (errno != EINTR && errno != EBADF && errno != ESRCH)
1615 Punt("kevent: %s", strerror(errno));
1618 FD_SET(job->inPipe, &outputs);
1619 #endif /* USE_KQUEUE */
1622 if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
1623 fclose(job->cmdFILE);
1624 job->cmdFILE = NULL;
1628 * Now the job is actually running, add it to the table.
1631 TAILQ_INSERT_TAIL(&jobs, job, link);
1632 if (nJobs == maxJobs) {
1640 * Create the argv needed to execute the shell for a given job.
1643 JobMakeArgv(Job *job, char **argv)
1646 static char args[10]; /* For merged arguments */
1648 argv[0] = shellName;
1651 if ((commandShell->exit && *commandShell->exit != '-') ||
1652 (commandShell->echo && *commandShell->echo != '-')) {
1654 * At least one of the flags doesn't have a minus before it, so
1655 * merge them together. Have to do this because the *(&(@*#*&#$#
1656 * Bourne shell thinks its second argument is a file to source.
1657 * Grrrr. Note the ten-character limitation on the combined
1660 sprintf(args, "-%s%s", (job->flags & JOB_IGNERR) ? "" :
1661 commandShell->exit ? commandShell->exit : "",
1662 (job->flags & JOB_SILENT) ? "" :
1663 commandShell->echo ? commandShell->echo : "");
1670 if (!(job->flags & JOB_IGNERR) && commandShell->exit) {
1671 argv[argc] = commandShell->exit;
1674 if (!(job->flags & JOB_SILENT) && commandShell->echo) {
1675 argv[argc] = commandShell->echo;
1684 * Restart a job that stopped for some reason. The job must be neither
1685 * on the jobs nor on the stoppedJobs list.
1688 * jobFull will be set if the job couldn't be run.
1691 JobRestart(Job *job)
1694 if (job->flags & JOB_RESTART) {
1696 * Set up the control arguments to the shell. This is based on
1697 * the flags set earlier for this job. If the JOB_IGNERR flag
1698 * is clear, the 'exit' flag of the commandShell is used to
1699 * cause it to exit upon receiving an error. If the JOB_SILENT
1700 * flag is clear, the 'echo' flag of the commandShell is used
1701 * to get it to start echoing as soon as it starts
1702 * processing commands.
1706 JobMakeArgv(job, argv);
1708 DEBUGF(JOB, ("Restarting %s...", job->node->name));
1709 if (nJobs >= maxJobs && !(job->flags & JOB_SPECIAL)) {
1711 * Not allowed to run -- put it back on the hold
1712 * queue and mark the table full
1714 DEBUGF(JOB, ("holding\n"));
1715 TAILQ_INSERT_HEAD(&stoppedJobs, job, link);
1717 DEBUGF(JOB, ("Job queue is full.\n"));
1721 * Job may be run locally.
1723 DEBUGF(JOB, ("running locally\n"));
1729 * The job has stopped and needs to be restarted.
1730 * Why it stopped, we don't know...
1732 DEBUGF(JOB, ("Resuming %s...", job->node->name));
1733 if ((nJobs < maxJobs || ((job->flags & JOB_SPECIAL) &&
1734 maxJobs == 0)) && nJobs != maxJobs) {
1736 * If we haven't reached the concurrency limit already
1737 * (or the job must be run and maxJobs is 0), it's ok
1743 error = (KILL(job->pid, SIGCONT) != 0);
1747 * Make sure the user knows we've continued
1748 * the beast and actually put the thing in the
1751 job->flags |= JOB_CONTINUING;
1753 W_SETTERMSIG(&status, SIGCONT);
1754 JobFinish(job, &status);
1756 job->flags &= ~(JOB_RESUME|JOB_CONTINUING);
1757 DEBUGF(JOB, ("done\n"));
1759 Error("couldn't resume %s: %s",
1760 job->node->name, strerror(errno));
1762 W_SETEXITSTATUS(&status, 1);
1763 JobFinish(job, &status);
1767 * Job cannot be restarted. Mark the table as full and
1768 * place the job back on the list of stopped jobs.
1770 DEBUGF(JOB, ("table full\n"));
1771 TAILQ_INSERT_HEAD(&stoppedJobs, job, link);
1773 DEBUGF(JOB, ("Job queue is full.\n"));
1780 * Start a target-creation process going for the target described
1781 * by the graph node gn.
1784 * JOB_ERROR if there was an error in the commands, JOB_FINISHED
1785 * if there isn't actually anything left to do for the job and
1786 * JOB_RUNNING if the job has been started.
1789 * A new Job node is created and added to the list of running
1790 * jobs. PMake is forked and a child shell created.
1793 JobStart(GNode *gn, int flags, Job *previous)
1795 Job *job; /* new job descriptor */
1796 char *argv[4]; /* Argument vector to shell */
1797 Boolean cmdsOK; /* true if the nodes commands were all right */
1798 Boolean noExec; /* Set true if we decide not to run the job */
1799 int tfd; /* File descriptor for temp file */
1801 char tfile[sizeof(TMPPAT)];
1804 JobPassSig(interrupted);
1807 if (previous != NULL) {
1808 previous->flags &= ~(JOB_FIRST | JOB_IGNERR | JOB_SILENT);
1811 job = emalloc(sizeof(Job));
1816 job->tailCmds = NULL;
1819 * Set the initial value of the flags for this job based on the global
1820 * ones and the node's attributes... Any flags supplied by the caller
1821 * are also added to the field.
1824 if (Targ_Ignore(gn)) {
1825 job->flags |= JOB_IGNERR;
1827 if (Targ_Silent(gn)) {
1828 job->flags |= JOB_SILENT;
1830 job->flags |= flags;
1833 * Check the commands now so any attributes from .DEFAULT have a chance
1834 * to migrate to the node.
1836 if (!compatMake && (job->flags & JOB_FIRST)) {
1837 cmdsOK = Job_CheckCommands(gn, Error);
1843 * If the -n flag wasn't given, we open up OUR (not the child's)
1844 * temporary file to stuff commands in it. The thing is rd/wr so we
1845 * don't need to reopen it to feed it to the shell. If the -n flag
1846 * *was* given, we just set the file to be stdout. Cute, huh?
1848 if ((gn->type & OP_MAKE) || (!noExecute && !touchFlag)) {
1850 * We're serious here, but if the commands were bogus, we're
1857 strcpy(tfile, TMPPAT);
1858 if ((tfd = mkstemp(tfile)) == -1)
1859 Punt("Cannot create temp file: %s", strerror(errno));
1860 job->cmdFILE = fdopen(tfd, "w+");
1862 if (job->cmdFILE == NULL) {
1864 Punt("Could not open %s", tfile);
1866 fcntl(FILENO(job->cmdFILE), F_SETFD, 1);
1868 * Send the commands to the command file, flush all its
1869 * buffers then rewind and remove the thing.
1874 * Used to be backwards; replace when start doing multiple
1875 * commands per shell.
1879 * Be compatible: If this is the first time for this
1880 * node, verify its commands are ok and open the
1881 * commands list for sequential access by later
1882 * invocations of JobStart. Once that is done, we take
1883 * the next command off the list and print it to the
1884 * command file. If the command was an ellipsis, note
1885 * that there's nothing more to execute.
1887 if (job->flags & JOB_FIRST)
1888 gn->compat_command = Lst_First(&gn->commands);
1890 gn->compat_command =
1891 Lst_Succ(gn->compat_command);
1893 if (gn->compat_command == NULL ||
1894 JobPrintCommand(Lst_Datum(gn->compat_command), job))
1897 if (noExec && !(job->flags & JOB_FIRST)) {
1899 * If we're not going to execute anything, the
1900 * job is done and we need to close down the
1901 * various file descriptors we've opened for
1902 * output, then call JobDoOutput to catch the
1903 * final characters or send the file to the
1904 * screen... Note that the i/o streams are only
1905 * open if this isn't the first job. Note also
1906 * that this could not be done in
1907 * Job_CatchChildren b/c it wasn't clear if
1908 * there were more commands to execute or not...
1914 * We can do all the commands at once. hooray for sanity
1917 LST_FOREACH(ln, &gn->commands) {
1918 if (JobPrintCommand(Lst_Datum(ln), job))
1923 * If we didn't print out any commands to the shell
1924 * script, there's not much point in executing the
1927 if (numCommands == 0) {
1932 } else if (noExecute) {
1934 * Not executing anything -- just print all the commands to
1935 * stdout in one fell swoop. This will still set up
1936 * job->tailCmds correctly.
1938 if (lastNode != gn) {
1939 MESSAGE(stdout, gn);
1942 job->cmdFILE = stdout;
1945 * Only print the commands if they're ok, but don't die if
1946 * they're not -- just let the user know they're bad and keep
1947 * going. It doesn't do any harm in this case and may do
1951 LST_FOREACH(ln, &gn->commands) {
1952 if (JobPrintCommand(Lst_Datum(ln), job))
1957 * Don't execute the shell, thank you.
1963 * Just touch the target and note that no shell should be
1964 * executed. Set cmdFILE to stdout to make life easier. Check
1965 * the commands, too, but don't die if they're no good -- it
1966 * does no harm to keep working up the graph.
1968 job->cmdFILE = stdout;
1969 Job_Touch(gn, job->flags & JOB_SILENT);
1974 * If we're not supposed to execute a shell, don't.
1978 * Unlink and close the command file if we opened one
1980 if (job->cmdFILE != stdout) {
1981 if (job->cmdFILE != NULL)
1982 fclose(job->cmdFILE);
1988 * We only want to work our way up the graph if we aren't here
1989 * because the commands for the job were no good.
1992 if (aborting == 0) {
1993 for (ln = job->tailCmds; ln != NULL;
1994 ln = LST_NEXT(ln)) {
1995 Lst_AtEnd(&postCommands->commands,
1996 Buf_Peel(Var_Subst(Lst_Datum(ln),
1997 job->node, FALSE)));
1999 job->node->made = MADE;
2000 Make_Update(job->node);
2003 return(JOB_FINISHED);
2009 fflush(job->cmdFILE);
2013 * Set up the control arguments to the shell. This is based on the flags
2014 * set earlier for this job.
2016 JobMakeArgv(job, argv);
2019 * If we're using pipes to catch output, create the pipe by which we'll
2020 * get the shell's output. If we're using files, print out that we're
2021 * starting a job and then set up its temporary-file name.
2023 if (!compatMake || (job->flags & JOB_FIRST)) {
2028 Punt("Cannot create pipe: %s", strerror(errno));
2029 job->inPipe = fd[0];
2030 job->outPipe = fd[1];
2031 fcntl(job->inPipe, F_SETFD, 1);
2032 fcntl(job->outPipe, F_SETFD, 1);
2034 fprintf(stdout, "Remaking `%s'\n", gn->name);
2036 strcpy(job->outFile, TMPPAT);
2037 if ((job->outFd = mkstemp(job->outFile)) == -1)
2038 Punt("cannot create temp file: %s",
2040 fcntl(job->outFd, F_SETFD, 1);
2044 if (nJobs >= maxJobs && !(job->flags & JOB_SPECIAL) && maxJobs != 0) {
2046 * We've hit the limit of concurrency, so put the job on hold
2047 * until some other job finishes. Note that the special jobs
2048 * (.BEGIN, .INTERRUPT and .END) may be run even when the
2049 * limit has been reached (e.g. when maxJobs == 0).
2053 DEBUGF(JOB, ("Can only run job locally.\n"));
2054 job->flags |= JOB_RESTART;
2055 TAILQ_INSERT_TAIL(&stoppedJobs, job, link);
2057 if (nJobs >= maxJobs) {
2059 * If we're running this job as a special case
2060 * (see above), at least say the table is full.
2063 DEBUGF(JOB, ("Local job queue is full.\n"));
2067 return (JOB_RUNNING);
2071 JobOutput(Job *job, char *cp, char *endp, int msg)
2075 if (commandShell->noPrint) {
2076 ecp = strstr(cp, commandShell->noPrint);
2077 while (ecp != NULL) {
2080 if (msg && job->node != lastNode) {
2081 MESSAGE(stdout, job->node);
2082 lastNode = job->node;
2085 * The only way there wouldn't be a newline
2086 * after this line is if it were the last in
2087 * the buffer. However, since the non-printable
2088 * comes after it, there must be a newline, so
2089 * we don't print one.
2091 fprintf(stdout, "%s", cp);
2094 cp = ecp + strlen(commandShell->noPrint);
2097 * Still more to print, look again after
2098 * skipping the whitespace following the
2099 * non-printable command....
2102 while (*cp == ' ' || *cp == '\t' ||
2106 ecp = strstr(cp, commandShell->noPrint);
2117 * This function is called at different times depending on
2118 * whether the user has specified that output is to be collected
2119 * via pipes or temporary files. In the former case, we are called
2120 * whenever there is something to read on the pipe. We collect more
2121 * output from the given job and store it in the job's outBuf. If
2122 * this makes up a line, we print it tagged by the job's identifier,
2124 * If output has been collected in a temporary file, we open the
2125 * file and read it line by line, transfering it to our own
2126 * output channel until the file is empty. At which point we
2127 * remove the temporary file.
2128 * In both cases, however, we keep our figurative eye out for the
2129 * 'noPrint' line for the shell from which the output came. If
2130 * we recognize a line, we don't print it. If the command is not
2131 * alone on the line (the character after it is not \0 or \n), we
2132 * do print whatever follows it.
2135 * curPos may be shifted as may the contents of outBuf.
2138 JobDoOutput(Job *job, Boolean finish)
2140 Boolean gotNL = FALSE; /* true if got a newline */
2141 Boolean fbuf; /* true if our buffer filled up */
2142 int nr; /* number of bytes read */
2143 int i; /* auxiliary index into outBuf */
2144 int max; /* limit for i (end of current data) */
2145 int nRead; /* (Temporary) number of bytes read */
2146 FILE *oFILE; /* Stream pointer to shell's output file */
2151 * Read as many bytes as will fit in the buffer.
2157 nRead = read(job->inPipe, &job->outBuf[job->curPos],
2158 JOB_BUFSIZE - job->curPos);
2160 * Check for interrupt here too, because the above read may
2161 * block when the child process is stopped. In this case the
2162 * interrupt will unblock it (we don't use SA_RESTART).
2165 JobPassSig(interrupted);
2168 DEBUGF(JOB, ("JobDoOutput(piperead)"));
2175 * If we hit the end-of-file (the job is dead), we must flush
2176 * its remaining output, so pretend we read a newline if
2177 * there's any output remaining in the buffer.
2178 * Also clear the 'finish' flag so we stop looping.
2180 if (nr == 0 && job->curPos != 0) {
2181 job->outBuf[job->curPos] = '\n';
2184 } else if (nr == 0) {
2189 * Look for the last newline in the bytes we just got. If there
2190 * is one, break out of the loop with 'i' as its index and
2193 max = job->curPos + nr;
2194 for (i = job->curPos + nr - 1; i >= job->curPos; i--) {
2195 if (job->outBuf[i] == '\n') {
2198 } else if (job->outBuf[i] == '\0') {
2202 job->outBuf[i] = ' ';
2208 if (job->curPos == JOB_BUFSIZE) {
2210 * If we've run out of buffer space, we have
2211 * no choice but to print the stuff. sigh.
2217 if (gotNL || fbuf) {
2219 * Need to send the output to the screen. Null terminate
2220 * it first, overwriting the newline character if there
2221 * was one. So long as the line isn't one we should
2222 * filter (according to the shell description), we print
2223 * the line, preceded by a target banner if this target
2224 * isn't the same as the one for which we last printed
2225 * something. The rest of the data in the buffer are
2226 * then shifted down to the start of the buffer and
2227 * curPos is set accordingly.
2229 job->outBuf[i] = '\0';
2230 if (i >= job->curPos) {
2233 cp = JobOutput(job, job->outBuf,
2234 &job->outBuf[i], FALSE);
2237 * There's still more in that buffer. This time,
2238 * though, we know there's no newline at the
2239 * end, so we add one of our own free will.
2242 if (job->node != lastNode) {
2243 MESSAGE(stdout, job->node);
2244 lastNode = job->node;
2246 fprintf(stdout, "%s%s", cp,
2252 /* shift the remaining characters down */
2253 memcpy(job->outBuf, &job->outBuf[i + 1],
2255 job->curPos = max - (i + 1);
2259 * We have written everything out, so we just
2260 * start over from the start of the buffer.
2261 * No copying. No nothing.
2268 * If the finish flag is true, we must loop until we hit
2269 * end-of-file on the pipe. This is guaranteed to happen
2270 * eventually since the other end of the pipe is now
2271 * closed (we closed it explicitly and the child has
2272 * exited). When we do get an EOF, finish will be set
2273 * FALSE and we'll fall through and out.
2280 * We've been called to retrieve the output of the job from the
2281 * temporary file where it's been squirreled away. This consists
2282 * of opening the file, reading the output line by line, being
2283 * sure not to print the noPrint line for the shell we used,
2284 * then close and remove the temporary file. Very simple.
2286 * Change to read in blocks and do FindSubString type things
2287 * as for pipes? That would allow for "@echo -n..."
2289 oFILE = fopen(job->outFile, "r");
2290 if (oFILE != NULL) {
2291 fprintf(stdout, "Results of making %s:\n",
2295 while (fgets(inLine, sizeof(inLine), oFILE) != NULL) {
2296 char *cp, *endp, *oendp;
2299 oendp = endp = inLine + strlen(inLine);
2300 if (endp[-1] == '\n') {
2303 cp = JobOutput(job, inLine, endp, FALSE);
2306 * There's still more in that buffer. This time,
2307 * though, we know there's no newline at the
2308 * end, so we add one of our own free will.
2310 fprintf(stdout, "%s", cp);
2312 if (endp != oendp) {
2313 fprintf(stdout, "\n");
2318 eunlink(job->outFile);
2325 * Handle the exit of a child. Called from Make_Make.
2328 * The job descriptor is removed from the list of children.
2331 * We do waits, blocking or not, according to the wisdom of our
2332 * caller, until there are no more children to report. For each
2333 * job, call JobFinish to finish things off. This will take care of
2334 * putting jobs on the stoppedJobs queue.
2337 Job_CatchChildren(Boolean block)
2339 pid_t pid; /* pid of dead child */
2340 Job *job; /* job descriptor for dead child */
2341 int status; /* Exit/termination status */
2344 * Don't even bother if we know there's no one around.
2351 pid = waitpid((pid_t)-1, &status,
2352 (block ? 0 : WNOHANG) | WUNTRACED);
2356 DEBUGF(JOB, ("Process %jd exited or stopped.\n",
2359 TAILQ_FOREACH(job, &jobs, link) {
2360 if (job->pid == pid)
2365 if (WIFSIGNALED(status) &&
2366 (WTERMSIG(status) == SIGCONT)) {
2367 TAILQ_FOREACH(job, &jobs, link) {
2368 if (job->pid == pid)
2372 Error("Resumed child (%jd) "
2373 "not in table", (intmax_t)pid);
2376 TAILQ_REMOVE(&stoppedJobs, job, link);
2378 Error("Child (%jd) not in table?",
2383 TAILQ_REMOVE(&jobs, job, link);
2385 if (fifoFd >= 0 && maxJobs > 1) {
2386 write(fifoFd, "+", 1);
2388 if (nJobs >= maxJobs)
2393 DEBUGF(JOB, ("Job queue is no longer full.\n"));
2398 JobFinish(job, &status);
2401 JobPassSig(interrupted);
2406 * Catch the output from our children, if we're using
2407 * pipes do so. Otherwise just block time until we get a
2408 * signal(most likely a SIGCHLD) since there's no point in
2409 * just spinning when there's nothing to do and the reaping
2410 * of a child can wait for a while.
2413 * Output is read from pipes if we're piping.
2414 * -----------------------------------------------------------------------
2418 Job_CatchOutput(int flag __unused)
2420 Job_CatchOutput(int flag)
2426 struct kevent kev[KEV_SIZE];
2429 struct timeval timeout;
2438 if ((nfds = kevent(kqfd, NULL, 0, kev, KEV_SIZE, NULL)) == -1) {
2440 Punt("kevent: %s", strerror(errno));
2442 JobPassSig(interrupted);
2444 for (i = 0; i < nfds; i++) {
2445 if (kev[i].flags & EV_ERROR) {
2446 warnc(kev[i].data, "kevent");
2449 switch (kev[i].filter) {
2451 JobDoOutput(kev[i].udata, FALSE);
2455 * Just wake up and let
2456 * Job_CatchChildren() collect the
2465 timeout.tv_sec = SEL_SEC;
2466 timeout.tv_usec = SEL_USEC;
2467 if (flag && jobFull && fifoFd >= 0)
2468 FD_SET(fifoFd, &readfds);
2470 nfds = select(FD_SETSIZE, &readfds, (fd_set *)NULL,
2471 (fd_set *)NULL, &timeout);
2474 JobPassSig(interrupted);
2477 if (fifoFd >= 0 && FD_ISSET(fifoFd, &readfds)) {
2481 job = TAILQ_FIRST(&jobs);
2482 while (nfds != 0 && job != NULL) {
2483 if (FD_ISSET(job->inPipe, &readfds)) {
2484 JobDoOutput(job, FALSE);
2487 job = TAILQ_NEXT(job, link);
2489 #endif /* !USE_KQUEUE */
2495 * Start the creation of a target. Basically a front-end for
2496 * JobStart used by the Make module.
2499 * Another job is started.
2505 JobStart(gn, 0, NULL);
2510 * Make a new copy of the shell structure including a copy of the strings
2511 * in it. This also defaults some fields in case they are NULL.
2514 * The function returns a pointer to the new shell structure.
2516 static struct Shell *
2517 JobCopyShell(const struct Shell *osh)
2521 nsh = emalloc(sizeof(*nsh));
2522 nsh->name = estrdup(osh->name);
2524 if (osh->echoOff != NULL)
2525 nsh->echoOff = estrdup(osh->echoOff);
2527 nsh->echoOff = NULL;
2528 if (osh->echoOn != NULL)
2529 nsh->echoOn = estrdup(osh->echoOn);
2532 nsh->hasEchoCtl = osh->hasEchoCtl;
2534 if (osh->noPrint != NULL)
2535 nsh->noPrint = estrdup(osh->noPrint);
2537 nsh->noPrint = NULL;
2539 nsh->hasErrCtl = osh->hasErrCtl;
2540 if (osh->errCheck == NULL)
2541 nsh->errCheck = estrdup("");
2543 nsh->errCheck = estrdup(osh->errCheck);
2544 if (osh->ignErr == NULL)
2545 nsh->ignErr = estrdup("%s");
2547 nsh->ignErr = estrdup(osh->ignErr);
2549 if (osh->echo == NULL)
2550 nsh->echo = estrdup("");
2552 nsh->echo = estrdup(osh->echo);
2554 if (osh->exit == NULL)
2555 nsh->exit = estrdup("");
2557 nsh->exit = estrdup(osh->exit);
2564 * Free a shell structure and all associated strings.
2567 JobFreeShell(struct Shell *sh)
2587 if (commandShell == NULL)
2588 commandShell = JobMatchShell(shells[DEFSHELL].name);
2590 if (shellPath == NULL) {
2592 * The user didn't specify a shell to use, so we are using the
2593 * default one... Both the absolute path and the last component
2594 * must be set. The last component is taken from the 'name'
2595 * field of the default shell description pointed-to by
2596 * commandShell. All default shells are located in
2599 shellName = commandShell->name;
2600 shellPath = str_concat(PATH_DEFSHELLDIR, shellName,
2607 * Initialize the process module, given a maximum number of jobs.
2610 * lists and counters are initialized
2613 Job_Init(int maxproc)
2615 GNode *begin; /* node for commands to do at the very start */
2617 struct sigaction sa;
2620 env = getenv("MAKE_JOBS_FIFO");
2622 if (env == NULL && maxproc > 1) {
2624 * We did not find the environment variable so we are the
2625 * leader. Create the fifo, open it, write one char per
2626 * allowed job into the pipe.
2628 fifoFd = mkfifotemp(fifoName);
2633 fcntl(fifoFd, F_SETFL, O_NONBLOCK);
2635 setenv("MAKE_JOBS_FIFO", env, 1);
2636 while (maxproc-- > 0) {
2637 write(fifoFd, "+", 1);
2639 /* The master make does not get a magic token */
2644 } else if (env != NULL) {
2646 * We had the environment variable so we are a slave.
2647 * Open fifo and give ourselves a magic token which represents
2648 * the token our parent make has grabbed to start his make
2649 * process. Otherwise the sub-makes would gobble up tokens and
2650 * the proper number of tokens to specify to -j would depend
2651 * on the depth of the tree and the order of execution.
2653 fifoFd = open(env, O_RDWR, 0);
2655 fcntl(fifoFd, F_SETFL, O_NONBLOCK);
2672 if ((maxJobs == 1 && fifoFd < 0) || beVerbose == 0) {
2674 * If only one job can run at a time, there's no need for a
2675 * banner, no is there?
2685 * Catch the four signals that POSIX specifies if they aren't ignored.
2686 * JobCatchSignal will just set global variables and hope someone
2687 * else is going to handle the interrupt.
2689 sa.sa_handler = JobCatchSig;
2690 sigemptyset(&sa.sa_mask);
2693 if (signal(SIGINT, SIG_IGN) != SIG_IGN) {
2694 sigaction(SIGINT, &sa, NULL);
2696 if (signal(SIGHUP, SIG_IGN) != SIG_IGN) {
2697 sigaction(SIGHUP, &sa, NULL);
2699 if (signal(SIGQUIT, SIG_IGN) != SIG_IGN) {
2700 sigaction(SIGQUIT, &sa, NULL);
2702 if (signal(SIGTERM, SIG_IGN) != SIG_IGN) {
2703 sigaction(SIGTERM, &sa, NULL);
2706 * There are additional signals that need to be caught and passed if
2707 * either the export system wants to be told directly of signals or if
2708 * we're giving each job its own process group (since then it won't get
2709 * signals from the terminal driver as we own the terminal)
2711 #if defined(USE_PGRP)
2712 if (signal(SIGTSTP, SIG_IGN) != SIG_IGN) {
2713 sigaction(SIGTSTP, &sa, NULL);
2715 if (signal(SIGTTOU, SIG_IGN) != SIG_IGN) {
2716 sigaction(SIGTTOU, &sa, NULL);
2718 if (signal(SIGTTIN, SIG_IGN) != SIG_IGN) {
2719 sigaction(SIGTTIN, &sa, NULL);
2721 if (signal(SIGWINCH, SIG_IGN) != SIG_IGN) {
2722 sigaction(SIGWINCH, &sa, NULL);
2727 if ((kqfd = kqueue()) == -1) {
2728 Punt("kqueue: %s", strerror(errno));
2732 begin = Targ_FindNode(".BEGIN", TARG_NOCREATE);
2734 if (begin != NULL) {
2735 JobStart(begin, JOB_SPECIAL, (Job *)NULL);
2738 Job_CatchChildren(!usePipes);
2741 postCommands = Targ_FindNode(".END", TARG_CREATE);
2746 * See if the job table is full. It is considered full if it is OR
2747 * if we are in the process of aborting OR if we have
2748 * reached/exceeded our local quota. This prevents any more jobs
2752 * TRUE if the job table is full, FALSE otherwise
2762 if (fifoFd >= 0 && jobFull) {
2763 i = read(fifoFd, &c, 1);
2774 * See if the job table is empty. Because the local concurrency may
2775 * be set to 0, it is possible for the job table to become empty,
2776 * while the list of stoppedJobs remains non-empty. In such a case,
2777 * we want to restart as many jobs as we can.
2780 * TRUE if it is. FALSE if it ain't.
2786 if (!TAILQ_EMPTY(&stoppedJobs) && !aborting) {
2788 * The job table is obviously not full if it has no
2789 * jobs in it...Try and restart the stopped jobs.
2804 * Find a matching shell in 'shells' given its final component.
2807 * A pointer to a freshly allocated Shell structure with a copy
2808 * of the static structure or NULL if no shell with the given name
2811 static struct Shell *
2812 JobMatchShell(const char *name)
2814 const struct CShell *sh; /* Pointer into shells table */
2817 for (sh = shells; sh < shells + __arysize(shells); sh++)
2818 if (strcmp(sh->name, name) == 0)
2821 if (sh == shells + __arysize(shells))
2825 nsh = emalloc(sizeof(*nsh));
2827 nsh->name = estrdup(sh->name);
2828 nsh->echoOff = estrdup(sh->echoOff);
2829 nsh->echoOn = estrdup(sh->echoOn);
2830 nsh->hasEchoCtl = sh->hasEchoCtl;
2831 nsh->noPrint = estrdup(sh->noPrint);
2832 nsh->hasErrCtl = sh->hasErrCtl;
2833 nsh->errCheck = estrdup(sh->errCheck);
2834 nsh->ignErr = estrdup(sh->ignErr);
2835 nsh->echo = estrdup(sh->echo);
2836 nsh->exit = estrdup(sh->exit);
2843 * Parse a shell specification and set up commandShell, shellPath
2844 * and shellName appropriately.
2847 * FAILURE if the specification was incorrect.
2850 * commandShell points to a Shell structure (either predefined or
2851 * created from the shell spec), shellPath is the full path of the
2852 * shell described by commandShell, while shellName is just the
2853 * final component of shellPath.
2856 * A shell specification consists of a .SHELL target, with dependency
2857 * operator, followed by a series of blank-separated words. Double
2858 * quotes can be used to use blanks in words. A backslash escapes
2859 * anything (most notably a double-quote and a space) and
2860 * provides the functionality it does in C. Each word consists of
2861 * keyword and value separated by an equal sign. There should be no
2862 * unnecessary spaces in the word. The keywords are as follows:
2863 * name Name of shell.
2864 * path Location of shell. Overrides "name" if given
2865 * quiet Command to turn off echoing.
2866 * echo Command to turn echoing on
2867 * filter Result of turning off echoing that shouldn't be
2869 * echoFlag Flag to turn echoing on at the start
2870 * errFlag Flag to turn error checking on at the start
2871 * hasErrCtl True if shell has error checking control
2872 * check Command to turn on error checking if hasErrCtl
2873 * is TRUE or template of command to echo a command
2874 * for which error checking is off if hasErrCtl is
2876 * ignore Command to turn off error checking if hasErrCtl
2877 * is TRUE or template of command to execute a
2878 * command so as to ignore any errors it returns if
2879 * hasErrCtl is FALSE.
2882 Job_ParseShell(const char line[])
2889 Boolean fullSpec = FALSE;
2890 struct Shell newShell;
2893 memset(&newShell, 0, sizeof(newShell));
2897 * Parse the specification by keyword but skip the first word
2899 brk_string(&aa, line, TRUE);
2901 for (argc = aa.argc - 1, argv = aa.argv + 1; argc != 0; argc--, argv++)
2904 * Split keyword and value
2906 if ((eq = strchr(*argv, '=')) == NULL) {
2907 Parse_Error(PARSE_FATAL, "missing '=' in shell "
2908 "specification keyword '%s'", *argv);
2914 if (strcmp(*argv, "path") == 0) {
2916 } else if (strcmp(*argv, "name") == 0) {
2918 } else if (strcmp(*argv, "quiet") == 0) {
2919 newShell.echoOff = eq;
2921 } else if (strcmp(*argv, "echo") == 0) {
2922 newShell.echoOn = eq;
2924 } else if (strcmp(*argv, "filter") == 0) {
2925 newShell.noPrint = eq;
2927 } else if (strcmp(*argv, "echoFlag") == 0) {
2930 } else if (strcmp(*argv, "errFlag") == 0) {
2933 } else if (strcmp(*argv, "hasErrCtl") == 0) {
2934 newShell.hasErrCtl = (*eq == 'Y' || *eq == 'y' ||
2935 *eq == 'T' || *eq == 't');
2937 } else if (strcmp(*argv, "check") == 0) {
2938 newShell.errCheck = eq;
2940 } else if (strcmp(*argv, "ignore") == 0) {
2941 newShell.ignErr = eq;
2944 Parse_Error(PARSE_FATAL, "unknown keyword in shell "
2945 "specification '%s'", *argv);
2952 * Some checks (could be more)
2955 if ((newShell.echoOn != NULL) ^ (newShell.echoOff != NULL))
2956 Parse_Error(PARSE_FATAL, "Shell must have either both "
2957 "echoOff and echoOn or none of them");
2959 if (newShell.echoOn != NULL && newShell.echoOff)
2960 newShell.hasEchoCtl = TRUE;
2965 * If no path was given, the user wants one of the pre-defined
2966 * shells, yes? So we find the one s/he wants with the help of
2967 * JobMatchShell and set things up the right way. shellPath
2968 * will be set up by Job_Init.
2970 if (newShell.name == NULL) {
2971 Parse_Error(PARSE_FATAL,
2972 "Neither path nor name specified");
2976 if ((sh = JobMatchShell(newShell.name)) == NULL) {
2977 Parse_Error(PARSE_FATAL, "%s: no matching shell",
2985 * The user provided a path. If s/he gave nothing else
2986 * (fullSpec is FALSE), try and find a matching shell in the
2987 * ones we know of. Else we just take the specification at its
2988 * word and copy it to a new location. In either case, we need
2989 * to record the path the user gave for the shell.
2992 shellPath = estrdup(path);
2993 if (newShell.name == NULL) {
2994 /* get the base name as the name */
2995 path = strrchr(path, '/');
3001 newShell.name = path;
3005 if ((sh = JobMatchShell(newShell.name)) == NULL) {
3006 Parse_Error(PARSE_FATAL,
3007 "%s: no matching shell", newShell.name);
3012 sh = JobCopyShell(&newShell);
3016 /* set the new shell */
3017 JobFreeShell(commandShell);
3020 shellName = commandShell->name;
3028 * Handle the receipt of an interrupt.
3031 * All children are killed. Another job will be started if the
3032 * .INTERRUPT target was given.
3035 JobInterrupt(int runINTERRUPT, int signo)
3037 Job *job; /* job descriptor in that element */
3038 GNode *interrupt; /* the node describing the .INTERRUPT target */
3040 aborting = ABORT_INTERRUPT;
3042 TAILQ_FOREACH(job, &jobs, link) {
3043 if (!Targ_Precious(job->node)) {
3044 char *file = (job->node->path == NULL ?
3045 job->node->name : job->node->path);
3047 if (!noExecute && eunlink(file) != -1) {
3048 Error("*** %s removed", file);
3052 DEBUGF(JOB, ("JobInterrupt passing signal to child "
3053 "%jd.\n", (intmax_t)job->pid));
3054 KILL(job->pid, signo);
3058 if (runINTERRUPT && !touchFlag) {
3060 * clear the interrupted flag because we would get an
3061 * infinite loop otherwise.
3065 interrupt = Targ_FindNode(".INTERRUPT", TARG_NOCREATE);
3066 if (interrupt != NULL) {
3067 ignoreErrors = FALSE;
3069 JobStart(interrupt, JOB_IGNDOTS, (Job *)NULL);
3072 Job_CatchChildren(!usePipes);
3080 * Do final processing such as the running of the commands
3081 * attached to the .END target.
3084 * Number of errors reported.
3090 if (postCommands != NULL && !Lst_IsEmpty(&postCommands->commands)) {
3092 Error("Errors reported so .END ignored");
3094 JobStart(postCommands, JOB_SPECIAL | JOB_IGNDOTS, NULL);
3098 Job_CatchChildren(!usePipes);
3113 * Waits for all running jobs to finish and returns. Sets 'aborting'
3114 * to ABORT_WAIT to prevent other jobs from starting.
3117 * Currently running jobs finish.
3123 aborting = ABORT_WAIT;
3124 while (nJobs != 0) {
3126 Job_CatchChildren(!usePipes);
3133 * Abort all currently running jobs without handling output or anything.
3134 * This function is to be called only in the event of a major
3135 * error. Most definitely NOT to be called from JobInterrupt.
3138 * All children are killed, not just the firstborn
3143 Job *job; /* the job descriptor in that element */
3146 aborting = ABORT_ERROR;
3149 TAILQ_FOREACH(job, &jobs, link) {
3151 * kill the child process with increasingly drastic
3152 * signals to make darn sure it's dead.
3154 KILL(job->pid, SIGINT);
3155 KILL(job->pid, SIGKILL);
3160 * Catch as many children as want to report in at first, then give up
3162 while (waitpid((pid_t)-1, &foo, WNOHANG) > 0)
3168 * Tries to restart stopped jobs if there are slots available.
3169 * Note that this tries to restart them regardless of pending errors.
3170 * It's not good to leave stopped jobs lying around!
3173 * Resumes(and possibly migrates) jobs.
3176 JobRestartJobs(void)
3180 while (!jobFull && (job = TAILQ_FIRST(&stoppedJobs)) != NULL) {
3181 DEBUGF(JOB, ("Job queue is not full. "
3182 "Restarting a stopped job.\n"));
3183 TAILQ_REMOVE(&stoppedJobs, job, link);
3190 * Execute the command in cmd, and return the output of that command
3194 * A string containing the output of the command, or the empty string
3195 * If error is not NULL, it contains the reason for the command failure
3196 * Any output sent to stderr in the child process is passed to stderr,
3197 * and not captured in the string.
3200 * The string must be freed by the caller.
3203 Cmd_Exec(const char *cmd, const char **error)
3205 int fds[2]; /* Pipe streams */
3206 int status; /* command exit status */
3207 Buffer *buf; /* buffer to store the result */
3214 if (shellPath == NULL)
3217 * Open a pipe for fetching its output
3219 if (pipe(fds) == -1) {
3220 *error = "Couldn't create pipe for \"%s\"";
3224 /* Set close-on-exec on read side of pipe. */
3225 fcntl(fds[0], F_SETFD, fcntl(fds[0], F_GETFD) | FD_CLOEXEC);
3227 ps.in = STDIN_FILENO;
3229 ps.err = STDERR_FILENO;
3231 ps.merge_errors = 0;
3235 /* Set up arguments for shell */
3236 ps.argv = emalloc(4 * sizeof(char *));
3237 ps.argv[0] = strdup(shellName);
3238 ps.argv[1] = strdup("-c");
3239 ps.argv[2] = strdup(cmd);
3244 * Fork. Warning since we are doing vfork() instead of fork(),
3245 * do not allocate memory in the child process!
3247 if ((ps.child_pid = vfork()) == -1) {
3248 *error = "Couldn't exec \"%s\"";
3250 } else if (ps.child_pid == 0) {
3263 close(fds[1]); /* No need for the writing half of the pipe. */
3266 char result[BUFSIZ];
3268 rcnt = read(fds[0], result, sizeof(result));
3270 Buf_AddBytes(buf, (size_t)rcnt, (Byte *)result);
3271 } while (rcnt > 0 || (rcnt == -1 && errno == EINTR));
3274 *error = "Error reading shell's output for \"%s\"";
3277 * Close the input side of the pipe.
3281 status = ProcWait(&ps);
3283 *error = "\"%s\" returned non-zero status";
3285 Buf_StripNewlines(buf);
3294 const char *cp; /* Pointer to string of shell meta-characters */
3296 for (cp = "#=|^(){};&<>*?[]:$`\\\n"; *cp != '\0'; cp++) {
3297 meta[(unsigned char)*cp] = 1;
3300 * The null character serves as a sentinel in the string.
3306 * Interrupt handler - set flag and defer handling to the main code
3309 CompatCatchSig(int signo)
3312 interrupted = signo;
3316 *-----------------------------------------------------------------------
3317 * CompatInterrupt --
3318 * Interrupt the creation of the current target and remove it if
3319 * it ain't precious.
3325 * The target is removed and the process exits. If .INTERRUPT exists,
3326 * its commands are run first WITH INTERRUPTS IGNORED..
3328 *-----------------------------------------------------------------------
3331 CompatInterrupt(int signo)
3334 sigset_t nmask, omask;
3337 sigemptyset(&nmask);
3338 sigaddset(&nmask, SIGINT);
3339 sigaddset(&nmask, SIGTERM);
3340 sigaddset(&nmask, SIGHUP);
3341 sigaddset(&nmask, SIGQUIT);
3342 sigprocmask(SIG_SETMASK, &nmask, &omask);
3344 /* prevent recursion in evaluation of .INTERRUPT */
3347 if (curTarg != NULL && !Targ_Precious(curTarg)) {
3349 char *file = Var_Value(TARGET, curTarg, &p1);
3351 if (!noExecute && eunlink(file) != -1) {
3352 printf("*** %s removed\n", file);
3358 * Run .INTERRUPT only if hit with interrupt signal
3360 if (signo == SIGINT) {
3361 gn = Targ_FindNode(".INTERRUPT", TARG_NOCREATE);
3363 LST_FOREACH(ln, &gn->commands) {
3364 if (Compat_RunCommand(Lst_Datum(ln), gn))
3370 sigprocmask(SIG_SETMASK, &omask, NULL);
3372 if (signo == SIGQUIT)
3374 signal(signo, SIG_DFL);
3375 kill(getpid(), signo);
3379 *-----------------------------------------------------------------------
3380 * Compat_RunCommand --
3381 * Execute the next command for a target. If the command returns an
3382 * error, the node's made field is set to ERROR and creation stops.
3383 * The node from which the command came is also given.
3386 * 0 if the command succeeded, 1 if an error occurred.
3389 * The node's 'made' field may be set to ERROR.
3391 *-----------------------------------------------------------------------
3394 Compat_RunCommand(char *cmd, GNode *gn)
3397 char *cmdStart; /* Start of expanded command */
3399 Boolean silent; /* Don't print command */
3400 Boolean doit; /* Execute even in -n */
3401 Boolean errCheck; /* Check errors */
3402 int reason; /* Reason for child's death */
3403 int status; /* Description of child's death */
3404 LstNode *cmdNode; /* Node where current cmd is located */
3405 char **av; /* Argument vector for thing to exec */
3408 silent = gn->type & OP_SILENT;
3409 errCheck = !(gn->type & OP_IGNORE);
3412 cmdNode = Lst_Member(&gn->commands, cmd);
3413 cmdStart = Buf_Peel(Var_Subst(cmd, gn, FALSE));
3415 if (*cmdStart == '\0') {
3417 Error("%s expands to empty string", cmd);
3422 Lst_Replace(cmdNode, cmdStart);
3424 if ((gn->type & OP_SAVE_CMDS) && (gn != ENDNode)) {
3425 Lst_AtEnd(&ENDNode->commands, cmdStart);
3427 } else if (strcmp(cmdStart, "...") == 0) {
3428 gn->type |= OP_SAVE_CMDS;
3432 while (*cmd == '@' || *cmd == '-' || *cmd == '+') {
3436 silent = DEBUG(LOUD) ? FALSE : TRUE;
3445 if (!meta[0]) /* we came here from jobs */
3452 while (isspace((unsigned char)*cmd))
3456 * Print the command before echoing if we're not supposed to be quiet
3457 * for this one. We also print the command if -n given, but not if '+'.
3459 if (!silent || (noExecute && !doit)) {
3460 printf("%s\n", cmd);
3465 * If we're not supposed to execute any commands, this is as far as
3468 if (!doit && noExecute) {
3473 * Search for meta characters in the command. If there are no meta
3474 * characters, there's no need to execute a shell to execute the
3477 for (cp = cmd; !meta[(unsigned char)*cp]; cp++)
3483 * If *cp isn't the null character, we hit a "meta" character
3484 * and need to pass the command off to the shell.
3490 const char *sh_builtin[] = {
3491 "alias", "cd", "eval", "exec",
3492 "exit", "read", "set", "ulimit",
3493 "unalias", "umask", "unset", "wait",
3498 * Break the command into words to form an argument
3499 * vector we can execute.
3501 brk_string(&aa, cmd, TRUE);
3504 for (p = sh_builtin; *p != 0; p++) {
3505 if (strcmp(av[0], *p) == 0) {
3507 * This command must be passed by the shell
3508 * for other reasons.. or.. possibly not at
3517 ps.in = STDIN_FILENO;
3518 ps.out = STDOUT_FILENO;
3519 ps.err = STDERR_FILENO;
3521 ps.merge_errors = 0;
3527 * We give the shell the -e flag as well as -c if it's
3528 * supposed to exit when it hits an error.
3530 ps.argv = emalloc(4 * sizeof(char *));
3531 ps.argv[0] = strdup(shellName);
3532 ps.argv[1] = strdup(errCheck ? "-ec" : "-c");
3533 ps.argv[2] = strdup(cmd);
3540 ps.errCheck = errCheck;
3543 * Fork and execute the single command. If the fork fails, we abort.
3544 * Warning since we are doing vfork() instead of fork(),
3545 * do not allocate memory in the child process!
3547 if ((ps.child_pid = vfork()) == -1) {
3548 Fatal("Could not fork");
3550 } else if (ps.child_pid == 0) {
3568 * we need to print out the command associated with this
3569 * Gnode in Targ_PrintCmd from Targ_PrintGraph when debugging
3570 * at level g2, in main(), Fatal() and DieHorribly(),
3571 * therefore do not free it when debugging.
3573 if (!DEBUG(GRAPH2)) {
3578 * The child is off and running. Now all we can do is wait...
3580 reason = ProcWait(&ps);
3583 CompatInterrupt(interrupted);
3586 * Decode and report the reason child exited, then
3587 * indicate how we handled it.
3589 if (WIFEXITED(reason)) {
3590 status = WEXITSTATUS(reason);
3594 printf("*** Error code %d", status);
3596 } else if (WIFSTOPPED(reason)) {
3597 status = WSTOPSIG(reason);
3599 status = WTERMSIG(reason);
3600 printf("*** Signal %d", status);
3611 printf(" (continuing)\n");
3616 * Continue executing
3617 * commands for this target.
3618 * If we return 0, this will
3621 printf(" (ignored)\n");
3628 *-----------------------------------------------------------------------
3630 * Make a target, given the parent, to abort if necessary.
3633 * If an error is detected and not being ignored, the process exits.
3635 *-----------------------------------------------------------------------
3638 CompatMake(GNode *gn, GNode *pgn)
3642 if (gn->type & OP_USE) {
3643 Make_HandleUse(gn, pgn);
3645 } else if (gn->made == UNMADE) {
3647 * First mark ourselves to be made, then apply whatever
3648 * transformations the suffix module thinks are necessary.
3649 * Once that's done, we can descend and make all our children.
3650 * If any of them has an error but the -k flag was given, our
3651 * 'make' field will be set FALSE again. This is our signal to
3652 * not attempt to do anything but abort our parent as well.
3655 gn->made = BEINGMADE;
3657 LST_FOREACH(ln, &gn->children)
3658 CompatMake(Lst_Datum(ln), gn);
3665 if (Lst_Member(&gn->iParents, pgn) != NULL) {
3667 Var_Set(IMPSRC, Var_Value(TARGET, gn, &p1), pgn);
3672 * All the children were made ok. Now cmtime contains the
3673 * modification time of the newest child, we need to find out
3674 * if we exist and when we were modified last. The criteria for
3675 * datedness are defined by the Make_OODate function.
3677 DEBUGF(MAKE, ("Examining %s...", gn->name));
3678 if (!Make_OODate(gn)) {
3679 gn->made = UPTODATE;
3680 DEBUGF(MAKE, ("up-to-date.\n"));
3683 DEBUGF(MAKE, ("out-of-date.\n"));
3687 * If the user is just seeing if something is out-of-date,
3688 * exit now to tell him/her "yes".
3695 * We need to be re-made. We also have to make sure we've got
3696 * a $? variable. To be nice, we also define the $> variable
3697 * using Make_DoAllVar().
3702 * Alter our type to tell if errors should be ignored or things
3703 * should not be printed so Compat_RunCommand knows what to do.
3705 if (Targ_Ignore(gn)) {
3706 gn->type |= OP_IGNORE;
3708 if (Targ_Silent(gn)) {
3709 gn->type |= OP_SILENT;
3712 if (Job_CheckCommands(gn, Fatal)) {
3714 * Our commands are ok, but we still have to worry
3715 * about the -t flag...
3719 LST_FOREACH(ln, &gn->commands) {
3720 if (Compat_RunCommand(Lst_Datum(ln),
3726 Job_Touch(gn, gn->type & OP_SILENT);
3732 if (gn->made != ERROR) {
3734 * If the node was made successfully, mark it so, update
3735 * its modification time and timestamp all its parents.
3736 * Note that for .ZEROTIME targets, the timestamping
3737 * isn't done. This is to keep its state from affecting
3738 * that of its parent.
3743 * We can't re-stat the thing, but we can at least take
3744 * care of rules where a target depends on a source that
3745 * actually creates the target, but only if it has
3753 * mv y.tab.o parse.o
3754 * cmp -s y.tab.h parse.h || mv y.tab.h parse.h
3756 * In this case, if the definitions produced by yacc
3757 * haven't changed from before, parse.h won't have been
3758 * updated and gn->mtime will reflect the current
3759 * modification time for parse.h. This is something of a
3760 * kludge, I admit, but it's a useful one..
3762 * XXX: People like to use a rule like
3766 * To force things that depend on FRC to be made, so we
3767 * have to check for gn->children being empty as well...
3769 if (!Lst_IsEmpty(&gn->commands) ||
3770 Lst_IsEmpty(&gn->children)) {
3775 * This is what Make does and it's actually a good
3776 * thing, as it allows rules like
3778 * cmp -s y.tab.h parse.h || cp y.tab.h parse.h
3780 * to function as intended. Unfortunately, thanks to
3781 * the stateless nature of NFS (and the speed of this
3782 * program), there are times when the modification time
3783 * of a file created on a remote machine will not be
3784 * modified before the stat() implied by the Dir_MTime
3785 * occurs, thus leading us to believe that the file
3786 * is unchanged, wreaking havoc with files that depend
3789 * I have decided it is better to make too much than to
3790 * make too little, so this stuff is commented out
3791 * unless you're sure it's ok.
3794 if (noExecute || Dir_MTime(gn) == 0) {
3797 if (gn->cmtime > gn->mtime)
3798 gn->mtime = gn->cmtime;
3799 DEBUGF(MAKE, ("update time: %s\n",
3800 Targ_FmtTime(gn->mtime)));
3802 if (!(gn->type & OP_EXEC)) {
3803 pgn->childMade = TRUE;
3804 Make_TimeStamp(pgn, gn);
3807 } else if (keepgoing) {
3813 printf("\n\nStop in %s.\n",
3814 Var_Value(".CURDIR", gn, &p1));
3818 } else if (gn->made == ERROR) {
3820 * Already had an error when making this beastie. Tell the
3825 if (Lst_Member(&gn->iParents, pgn) != NULL) {
3827 Var_Set(IMPSRC, Var_Value(TARGET, gn, &p1), pgn);
3832 Error("Graph cycles through %s\n", gn->name);
3837 if ((gn->type & OP_EXEC) == 0) {
3838 pgn->childMade = TRUE;
3839 Make_TimeStamp(pgn, gn);
3843 if ((gn->type & OP_EXEC) == 0) {
3844 Make_TimeStamp(pgn, gn);
3856 *-----------------------------------------------------------------------
3858 * Start making again, given a list of target nodes.
3866 *-----------------------------------------------------------------------
3869 Compat_Run(Lst *targs)
3871 GNode *gn = NULL; /* Current root target */
3872 int error_cnt; /* Number of targets not remade due to errors */
3876 Shell_Init(); /* Set up shell. */
3878 if (signal(SIGINT, SIG_IGN) != SIG_IGN) {
3879 signal(SIGINT, CompatCatchSig);
3881 if (signal(SIGTERM, SIG_IGN) != SIG_IGN) {
3882 signal(SIGTERM, CompatCatchSig);
3884 if (signal(SIGHUP, SIG_IGN) != SIG_IGN) {
3885 signal(SIGHUP, CompatCatchSig);
3887 if (signal(SIGQUIT, SIG_IGN) != SIG_IGN) {
3888 signal(SIGQUIT, CompatCatchSig);
3891 ENDNode = Targ_FindNode(".END", TARG_CREATE);
3893 * If the user has defined a .BEGIN target, execute the commands
3897 gn = Targ_FindNode(".BEGIN", TARG_NOCREATE);
3899 LST_FOREACH(ln, &gn->commands) {
3900 if (Compat_RunCommand(Lst_Datum(ln), gn))
3903 if (gn->made == ERROR) {
3904 printf("\n\nStop.\n");
3911 * For each entry in the list of targets to create, call CompatMake on
3912 * it to create the thing. CompatMake will leave the 'made' field of gn
3913 * in one of several states:
3914 * UPTODATE gn was already up-to-date
3915 * MADE gn was recreated successfully
3916 * ERROR An error occurred while gn was being created
3917 * ABORTED gn was not remade because one of its inferiors
3918 * could not be made due to errors.
3921 while (!Lst_IsEmpty(targs)) {
3922 gn = Lst_DeQueue(targs);
3925 if (gn->made == UPTODATE) {
3926 printf("`%s' is up to date.\n", gn->name);
3927 } else if (gn->made == ABORTED) {
3928 printf("`%s' not remade because of errors.\n",
3935 * If the user has defined a .END target, run its commands.
3937 if (error_cnt == 0) {
3938 LST_FOREACH(ln, &ENDNode->commands) {
3939 if (Compat_RunCommand(Lst_Datum(ln), gn))
lentferj's projects / dragonfly.git / blob