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.101 2005/05/16 17:30:24 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>
123 #include <inttypes.h>
139 #include "pathnames.h"
146 #define TMPPAT "/tmp/makeXXXXXXXXXX"
150 * The SEL_ constants determine the maximum amount of time spent in select
151 * before coming out to see if a child has finished. SEL_SEC is the number of
152 * seconds and SEL_USEC is the number of micro-seconds
156 #endif /* !USE_KQUEUE */
159 * Job Table definitions.
161 * The job "table" is kept as a linked Lst in 'jobs', with the number of
162 * active jobs maintained in the 'nJobs' variable. At no time will this
163 * exceed the value of 'maxJobs', initialized by the Job_Init function.
165 * When a job is finished, the Make_Update function is called on each of the
166 * parents of the node which was just remade. This takes care of the upward
167 * traversal of the dependency graph.
169 #define JOB_BUFSIZE 1024
171 pid_t pid; /* The child's process ID */
173 struct GNode *node; /* The target the child is making */
176 * A LstNode for the first command to be saved after the job completes.
177 * This is NULL if there was no "..." in the job's commands.
182 * An FILE* for writing out the commands. This is only
183 * used before the job is actually started.
188 * A word of flags which determine how the module handles errors,
189 * echoing, etc. for the job
191 short flags; /* Flags to control treatment of job */
192 #define JOB_IGNERR 0x001 /* Ignore non-zero exits */
193 #define JOB_SILENT 0x002 /* no output */
194 #define JOB_SPECIAL 0x004 /* Target is a special one. i.e. run it locally
195 * if we can't export it and maxLocal is 0 */
196 #define JOB_IGNDOTS 0x008 /* Ignore "..." lines when processing
198 #define JOB_FIRST 0x020 /* Job is first job for the node */
199 #define JOB_RESTART 0x080 /* Job needs to be completely restarted */
200 #define JOB_RESUME 0x100 /* Job needs to be resumed b/c it stopped,
202 #define JOB_CONTINUING 0x200 /* We are in the process of resuming this job.
203 * Used to avoid infinite recursion between
204 * JobFinish and JobRestart */
206 /* union for handling shell's output */
209 * This part is used when usePipes is true.
210 * The output is being caught via a pipe and the descriptors
211 * of our pipe, an array in which output is line buffered and
212 * the current position in that buffer are all maintained for
217 * Input side of pipe associated with
218 * job's output channel
223 * Output side of pipe associated with job's
229 * Buffer for storing the output of the
232 char op_outBuf[JOB_BUFSIZE + 1];
234 /* Current position in op_outBuf */
239 * If usePipes is false the output is routed to a temporary
240 * file and all that is kept is the name of the file and the
241 * descriptor open to the file.
244 /* Name of file to which shell output was rerouted */
245 char of_outFile[sizeof(TMPPAT)];
248 * Stream open to the output file. Used to funnel all
249 * from a single job to one file while still allowing
250 * multiple shell invocations
255 } output; /* Data for tracking a shell's output */
257 TAILQ_ENTRY(Job) link; /* list link */
260 #define outPipe output.o_pipe.op_outPipe
261 #define inPipe output.o_pipe.op_inPipe
262 #define outBuf output.o_pipe.op_outBuf
263 #define curPos output.o_pipe.op_curPos
264 #define outFile output.o_file.of_outFile
265 #define outFd output.o_file.of_outFd
267 TAILQ_HEAD(JobList, Job);
270 * Shell Specifications:
272 * Some special stuff goes on if a shell doesn't have error control. In such
273 * a case, errCheck becomes a printf template for echoing the command,
274 * should echoing be on and ignErr becomes another printf template for
275 * executing the command while ignoring the return status. If either of these
276 * strings is empty when hasErrCtl is FALSE, the command will be executed
277 * anyway as is and if it causes an error, so be it.
279 #define DEF_SHELL_STRUCT(TAG, CONST) \
282 * the name of the shell. For Bourne and C shells, this is used \
283 * only to find the shell description when used as the single \
284 * source of a .SHELL target. For user-defined shells, this is \
285 * the full path of the shell. \
289 /* True if both echoOff and echoOn defined */ \
290 Boolean hasEchoCtl; \
292 CONST char *echoOff; /* command to turn off echo */ \
293 CONST char *echoOn; /* command to turn it back on */\
296 * What the shell prints, and its length, when given the \
297 * echo-off command. This line will not be printed when \
298 * received from the shell. This is usually the command which \
299 * was executed to turn off echoing \
301 CONST char *noPrint; \
303 /* set if can control error checking for individual commands */ \
306 /* string to turn error checking on */ \
307 CONST char *errCheck; \
309 /* string to turn off error checking */ \
310 CONST char *ignErr; \
312 CONST char *echo; /* command line flag: echo commands */ \
313 CONST char *exit; /* command line flag: exit on error */ \
316 DEF_SHELL_STRUCT(Shell,);
317 DEF_SHELL_STRUCT(CShell, const);
320 * error handling variables
322 static int errors = 0; /* number of errors reported */
323 static int aborting = 0; /* why is the make aborting? */
324 #define ABORT_ERROR 1 /* Because of an error */
325 #define ABORT_INTERRUPT 2 /* Because it was interrupted */
326 #define ABORT_WAIT 3 /* Waiting for jobs to finish */
329 * XXX: Avoid SunOS bug... FILENO() is fp->_file, and file
330 * is a char! So when we go above 127 we turn negative!
332 #define FILENO(a) ((unsigned)fileno(a))
335 * post-make command processing. The node postCommands is really just the
336 * .END target but we keep it around to avoid having to search for it
339 static GNode *postCommands;
342 * The number of commands actually printed for a target. Should this
343 * number be 0, no shell will be executed.
345 static int numCommands;
348 * Return values from JobStart.
350 #define JOB_RUNNING 0 /* Job is running */
351 #define JOB_ERROR 1 /* Error in starting the job */
352 #define JOB_FINISHED 2 /* The job is already finished */
353 #define JOB_STOPPED 3 /* The job is stopped */
356 * Descriptions for various shells.
358 static const struct CShell shells[] = {
360 * CSH description. The csh can do echo control by playing
361 * with the setting of the 'echo' shell variable. Sadly,
362 * however, it is unable to do error control nicely.
366 TRUE, "unset verbose", "set verbose", "unset verbose",
367 FALSE, "echo \"%s\"\n", "csh -c \"%s || exit 0\"",
371 * SH description. Echo control is also possible and, under
372 * sun UNIX anyway, one can even control error checking.
376 TRUE, "set -", "set -v", "set -",
377 TRUE, "set -e", "set +e",
378 #ifdef OLDBOURNESHELL
379 FALSE, "echo \"%s\"\n", "sh -c '%s || exit 0'\n",
384 * KSH description. The Korn shell has a superset of
385 * the Bourne shell's functionality.
389 TRUE, "set -", "set -v", "set -",
390 TRUE, "set -e", "set +e",
396 * This is the shell to which we pass all commands in the Makefile.
397 * It is set by the Job_ParseShell function.
399 static struct Shell *commandShell = NULL;
400 static char *shellPath = NULL; /* full pathname of executable image */
401 static char *shellName = NULL; /* last component of shell */
404 * The maximum number of jobs that may run. This is initialize from the
405 * -j argument for the leading make and from the FIFO for sub-makes.
409 static int nJobs; /* The number of children currently running */
411 /* The structures that describe them */
412 static struct JobList jobs = TAILQ_HEAD_INITIALIZER(jobs);
414 static Boolean jobFull; /* Flag to tell when the job table is full. It
415 * is set TRUE when (1) the total number of
416 * running jobs equals the maximum allowed */
418 static int kqfd; /* File descriptor obtained by kqueue() */
420 static fd_set outputs; /* Set of descriptors of pipes connected to
421 * the output channels of children */
424 static GNode *lastNode; /* The node for which output was most recently
426 static const char *targFmt; /* Format string to use to head output from a
427 * job when it's not the most-recent job heard
430 #define TARG_FMT "--- %s ---\n" /* Default format */
431 #define MESSAGE(fp, gn) \
432 fprintf(fp, targFmt, gn->name);
435 * When JobStart attempts to run a job but isn't allowed to
436 * or when Job_CatchChildren detects a job that has
437 * been stopped somehow, the job is placed on the stoppedJobs queue to be run
438 * when the next job finishes.
440 * Lst of Job structures describing jobs that were stopped due to
441 * concurrency limits or externally
443 static struct JobList stoppedJobs = TAILQ_HEAD_INITIALIZER(stoppedJobs);
445 static int fifoFd; /* Fd of our job fifo */
446 static char fifoName[] = "/tmp/make_fifo_XXXXXXXXX";
447 static int fifoMaster;
449 static sig_atomic_t interrupted;
452 #if defined(USE_PGRP) && defined(SYSV)
453 # define KILL(pid, sig) killpg(-(pid), (sig))
455 # if defined(USE_PGRP)
456 # define KILL(pid, sig) killpg((pid), (sig))
458 # define KILL(pid, sig) kill((pid), (sig))
463 * Grmpf... There is no way to set bits of the wait structure
464 * anymore with the stupid W*() macros. I liked the union wait
465 * stuff much more. So, we devise our own macros... This is
466 * really ugly, use dramamine sparingly. You have been warned.
468 #define W_SETMASKED(st, val, fun) \
471 int mask = fun(sh); \
473 for (sh = 0; ((mask >> sh) & 1) == 0; sh++) \
475 *(st) = (*(st) & ~mask) | ((val) << sh); \
478 #define W_SETTERMSIG(st, val) W_SETMASKED(st, val, WTERMSIG)
479 #define W_SETEXITSTATUS(st, val) W_SETMASKED(st, val, WEXITSTATUS)
482 * Information used to create a new process.
484 typedef struct ProcStuff {
485 int in; /* stdin for new process */
486 int out; /* stdout for new process */
487 int err; /* stderr for new process */
489 int merge_errors; /* true if stderr is redirected to stdin */
490 int pgroup; /* true if new process a process leader */
491 int searchpath; /* true if binary should be found via $PATH */
494 int argv_free; /* release argv after use */
500 static void JobRestart(Job *);
501 static int JobStart(GNode *, int, Job *);
502 static void JobDoOutput(Job *, Boolean);
503 static struct Shell *JobMatchShell(const char *);
504 static void JobInterrupt(int, int);
505 static void JobRestartJobs(void);
506 static void ProcExec(const ProcStuff *) __dead2;
507 static int Compat_RunCommand(char *, struct GNode *);
509 static GNode *curTarg = NULL;
510 static GNode *ENDNode;
513 * Create a fifo file with a uniq filename, and returns a file
514 * descriptor to that fifo.
517 mkfifotemp(char *template)
522 const char padchar[] =
523 "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
525 if (template[0] == '\0') {
526 errno = EINVAL; /* bad input string */
530 /* Find end of template string. */
531 pathend = strchr(template, '\0');
535 * Starting from the end of the template replace spaces with 'X' in
536 * them with random characters until there are no more 'X'.
538 while (ptr >= template && *ptr == 'X') {
539 uint32_t rand_num = arc4random() % (sizeof(padchar) - 1);
540 *ptr-- = padchar[rand_num];
544 /* Check the target directory. */
545 for (; ptr > template; --ptr) {
550 if (stat(template, &sbuf) != 0)
553 if (!S_ISDIR(sbuf.st_mode)) {
563 if (mkfifo(template, 0600) == 0) {
566 if ((fd = open(template, O_RDWR, 0600)) < 0) {
573 if (errno != EEXIST) {
579 * If we have a collision, cycle through the space of
582 for (ptr = start;;) {
585 if (*ptr == '\0' || ptr == pathend)
588 pad = strchr(padchar, *ptr);
589 if (pad == NULL || *++pad == '\0') {
601 catch_child(int sig __unused)
611 * Catch SIGCHLD so that we get kicked out of select() when we
612 * need to look at a child. This is only known to matter for the
613 * -j case (perhaps without -P).
615 * XXX this is intentionally misplaced.
619 sigemptyset(&sa.sa_mask);
620 sa.sa_flags = SA_RESTART | SA_NOCLDSTOP;
621 sa.sa_handler = catch_child;
622 sigaction(SIGCHLD, &sa, NULL);
626 * Turn off ENV to make ksh happier.
633 * Replace the current process.
636 ProcExec(const ProcStuff *ps)
638 if (ps->in != STDIN_FILENO) {
640 * Redirect the child's stdin to the input fd
641 * and reset it to the beginning (again).
643 if (dup2(ps->in, STDIN_FILENO) == -1)
644 Punt("Cannot dup2: %s", strerror(errno));
645 lseek(STDIN_FILENO, (off_t)0, SEEK_SET);
648 if (ps->out != STDOUT_FILENO) {
650 * Redirect the child's stdout to the output fd.
652 if (dup2(ps->out, STDOUT_FILENO) == -1)
653 Punt("Cannot dup2: %s", strerror(errno));
657 if (ps->err != STDERR_FILENO) {
659 * Redirect the child's stderr to the err fd.
661 if (dup2(ps->err, STDERR_FILENO) == -1)
662 Punt("Cannot dup2: %s", strerror(errno));
666 if (ps->merge_errors) {
668 * Send stderr to parent process too.
670 if (dup2(STDOUT_FILENO, STDERR_FILENO) == -1)
671 Punt("Cannot dup2: %s", strerror(errno));
675 * The file descriptors for stdin, stdout, or stderr might
676 * have been marked close-on-exec. Clear the flag on all
679 fcntl(STDIN_FILENO, F_SETFD,
680 fcntl(STDIN_FILENO, F_GETFD) & (~FD_CLOEXEC));
681 fcntl(STDOUT_FILENO, F_SETFD,
682 fcntl(STDOUT_FILENO, F_GETFD) & (~FD_CLOEXEC));
683 fcntl(STDERR_FILENO, F_SETFD,
684 fcntl(STDERR_FILENO, F_GETFD) & (~FD_CLOEXEC));
689 * Become a process group leader, so we can kill it and all
690 * its descendants in one fell swoop, by killing its process
691 * family, but not commit suicide.
696 setpgid(0, getpid());
698 #endif /* USE_PGRP */
701 if (ps->searchpath) {
702 execvp(ps->argv[0], ps->argv);
704 write(STDERR_FILENO, ps->argv[0], strlen(ps->argv[0]));
705 write(STDERR_FILENO, ":", 1);
706 write(STDERR_FILENO, strerror(errno), strlen(strerror(errno)));
707 write(STDERR_FILENO, "\n", 1);
709 execv(shellPath, ps->argv);
712 "Could not execute shell\n",
713 sizeof("Could not execute shell"));
717 * Since we are the child process, exit without flushing buffers.
723 * Wait for child process to terminate.
726 ProcWait(ProcStuff *ps)
732 * Wait for the process to exit.
735 pid = waitpid(ps->child_pid, &status, 0);
736 if (pid == -1 && errno != EINTR) {
737 Fatal("error in wait: %d", pid);
740 if (pid == ps->child_pid) {
753 * Got a signal. Set global variables and hope that someone will
757 JobCatchSig(int signo)
765 * Pass a signal on to all local jobs if
766 * USE_PGRP is defined, then die ourselves.
769 * We die by the same signal.
772 JobPassSig(int signo)
775 sigset_t nmask, omask;
776 struct sigaction act;
779 sigaddset(&nmask, signo);
780 sigprocmask(SIG_SETMASK, &nmask, &omask);
782 DEBUGF(JOB, ("JobPassSig(%d) called.\n", signo));
783 TAILQ_FOREACH(job, &jobs, link) {
784 DEBUGF(JOB, ("JobPassSig passing signal %d to child %jd.\n",
785 signo, (intmax_t)job->pid));
786 KILL(job->pid, signo);
790 * Deal with proper cleanup based on the signal received. We only run
791 * the .INTERRUPT target if the signal was in fact an interrupt.
792 * The other three termination signals are more of a "get out *now*"
795 if (signo == SIGINT) {
796 JobInterrupt(TRUE, signo);
797 } else if (signo == SIGHUP || signo == SIGTERM || signo == SIGQUIT) {
798 JobInterrupt(FALSE, signo);
802 * Leave gracefully if SIGQUIT, rather than core dumping.
804 if (signo == SIGQUIT) {
809 * Send ourselves the signal now we've given the message to everyone
810 * else. Note we block everything else possible while we're getting
811 * the signal. This ensures that all our jobs get continued when we
812 * wake up before we take any other signal.
813 * XXX this comment seems wrong.
815 act.sa_handler = SIG_DFL;
816 sigemptyset(&act.sa_mask);
818 sigaction(signo, &act, NULL);
820 DEBUGF(JOB, ("JobPassSig passing signal to self, mask = %x.\n",
821 ~0 & ~(1 << (signo - 1))));
822 signal(signo, SIG_DFL);
824 KILL(getpid(), signo);
827 TAILQ_FOREACH(job, &jobs, link) {
828 DEBUGF(JOB, ("JobPassSig passing signal %d to child %jd.\n",
829 signo, (intmax_t)job->pid));
830 KILL(job->pid, signo);
833 sigprocmask(SIG_SETMASK, &omask, NULL);
834 sigprocmask(SIG_SETMASK, &omask, NULL);
835 act.sa_handler = JobPassSig;
836 sigaction(signo, &act, NULL);
841 * Put out another command for the given job. If the command starts
842 * with an @ or a - we process it specially. In the former case,
843 * so long as the -s and -n flags weren't given to make, we stick
844 * a shell-specific echoOff command in the script. In the latter,
845 * we ignore errors for the entire job, unless the shell has error
847 * If the command is just "..." we take all future commands for this
848 * job to be commands to be executed once the entire graph has been
849 * made and return non-zero to signal that the end of the commands
850 * was reached. These commands are later attached to the postCommands
851 * node and executed by Job_Finish when all things are done.
852 * This function is called from JobStart via LST_FOREACH.
855 * Always 0, unless the command was "..."
858 * If the command begins with a '-' and the shell has no error control,
859 * the JOB_IGNERR flag is set in the job descriptor.
860 * If the command is "..." and we're not ignoring such things,
861 * tailCmds is set to the successor node of the cmd.
862 * numCommands is incremented if the command is actually printed.
865 JobPrintCommand(char *cmd, Job *job)
867 Boolean noSpecials; /* true if we shouldn't worry about
868 * inserting special commands into
869 * the input stream. */
870 Boolean shutUp = FALSE; /* true if we put a no echo command
871 * into the command file */
872 Boolean errOff = FALSE; /* true if we turned error checking
873 * off before printing the command
874 * and need to turn it back on */
875 const char *cmdTemplate;/* Template to use when printing the command */
876 char *cmdStart; /* Start of expanded command */
877 LstNode *cmdNode; /* Node for replacing the command */
879 noSpecials = (noExecute && !(job->node->type & OP_MAKE));
881 if (strcmp(cmd, "...") == 0) {
882 job->node->type |= OP_SAVE_CMDS;
883 if ((job->flags & JOB_IGNDOTS) == 0) {
885 Lst_Succ(Lst_Member(&job->node->commands, cmd));
891 #define DBPRINTF(fmt, arg) \
892 DEBUGF(JOB, (fmt, arg)); \
893 fprintf(job->cmdFILE, fmt, arg); \
894 fflush(job->cmdFILE);
899 * For debugging, we replace each command with the result of expanding
900 * the variables in the command.
902 cmdNode = Lst_Member(&job->node->commands, cmd);
904 cmd = Buf_Peel(Var_Subst(cmd, job->node, FALSE));
907 Lst_Replace(cmdNode, cmdStart);
909 cmdTemplate = "%s\n";
912 * Check for leading @', -' or +'s to control echoing, error checking,
913 * and execution on -n.
915 while (*cmd == '@' || *cmd == '-' || *cmd == '+') {
919 shutUp = DEBUG(LOUD) ? FALSE : TRUE;
929 * We're not actually exececuting anything...
930 * but this one needs to be - use compat mode
933 Compat_RunCommand(cmd, job->node);
941 while (isspace((unsigned char)*cmd))
945 if (!(job->flags & JOB_SILENT) && !noSpecials &&
946 commandShell->hasEchoCtl) {
947 DBPRINTF("%s\n", commandShell->echoOff);
954 if (!(job->flags & JOB_IGNERR) && !noSpecials) {
955 if (commandShell->hasErrCtl) {
957 * We don't want the error-control commands
958 * showing up either, so we turn off echoing
959 * while executing them. We could put another
960 * field in the shell structure to tell
961 * JobDoOutput to look for this string too,
962 * but why make it any more complex than
965 if (!(job->flags & JOB_SILENT) && !shutUp &&
966 commandShell->hasEchoCtl) {
967 DBPRINTF("%s\n", commandShell->echoOff);
968 DBPRINTF("%s\n", commandShell->ignErr);
969 DBPRINTF("%s\n", commandShell->echoOn);
971 DBPRINTF("%s\n", commandShell->ignErr);
973 } else if (commandShell->ignErr &&
974 *commandShell->ignErr != '\0') {
976 * The shell has no error control, so we need to
977 * be weird to get it to ignore any errors from
978 * the command. If echoing is turned on, we turn
979 * it off and use the errCheck template to echo
980 * the command. Leave echoing off so the user
981 * doesn't see the weirdness we go through to
982 * ignore errors. Set cmdTemplate to use the
983 * weirdness instead of the simple "%s\n"
986 if (!(job->flags & JOB_SILENT) && !shutUp &&
987 commandShell->hasEchoCtl) {
988 DBPRINTF("%s\n", commandShell->echoOff);
989 DBPRINTF(commandShell->errCheck, cmd);
992 cmdTemplate = commandShell->ignErr;
994 * The error ignoration (hee hee) is already
995 * taken care of by the ignErr template, so
996 * pretend error checking is still on.
1007 DBPRINTF(cmdTemplate, cmd);
1011 * If echoing is already off, there's no point in issuing the
1012 * echoOff command. Otherwise we issue it and pretend it was on
1013 * for the whole command...
1015 if (!shutUp && !(job->flags & JOB_SILENT) &&
1016 commandShell->hasEchoCtl) {
1017 DBPRINTF("%s\n", commandShell->echoOff);
1020 DBPRINTF("%s\n", commandShell->errCheck);
1023 DBPRINTF("%s\n", commandShell->echoOn);
1030 * Called to close both input and output pipes when a job is finished.
1033 * The file descriptors associated with the job are closed.
1040 #if !defined(USE_KQUEUE)
1041 FD_CLR(job->inPipe, &outputs);
1043 if (job->outPipe != job->inPipe) {
1044 close(job->outPipe);
1046 JobDoOutput(job, TRUE);
1050 JobDoOutput(job, TRUE);
1056 * Do final processing for the given job including updating
1057 * parents and starting new jobs as available/necessary. Note
1058 * that we pay no attention to the JOB_IGNERR flag here.
1059 * This is because when we're called because of a noexecute flag
1060 * or something, jstat.w_status is 0 and when called from
1061 * Job_CatchChildren, the status is zeroed if it s/b ignored.
1064 * Some nodes may be put on the toBeMade queue.
1065 * Final commands for the job are placed on postCommands.
1067 * If we got an error and are aborting (aborting == ABORT_ERROR) and
1068 * the job list is now empty, we are done for the day.
1069 * If we recognized an error (errors !=0), we set the aborting flag
1070 * to ABORT_ERROR so no more jobs will be started.
1073 JobFinish(Job *job, int *status)
1078 if (WIFEXITED(*status)) {
1079 int job_status = WEXITSTATUS(*status);
1083 * Deal with ignored errors in -B mode. We need to
1084 * print a message telling of the ignored error as
1085 * well as setting status.w_status to 0 so the next
1086 * command gets run. To do this, we set done to be
1087 * TRUE if in -B mode and the job exited non-zero.
1089 if (job_status == 0) {
1092 if (job->flags & JOB_IGNERR) {
1096 * If it exited non-zero and either we're
1097 * doing things our way or we're not ignoring
1098 * errors, the job is finished. Similarly, if
1099 * the shell died because of a signal the job
1100 * is also finished. In these cases, finish
1101 * out the job's output before printing the
1105 if (job->cmdFILE != NULL &&
1106 job->cmdFILE != stdout) {
1107 fclose(job->cmdFILE);
1112 } else if (WIFSIGNALED(*status)) {
1113 if (WTERMSIG(*status) == SIGCONT) {
1115 * No need to close things down or anything.
1120 * If it exited non-zero and either we're
1121 * doing things our way or we're not ignoring
1122 * errors, the job is finished. Similarly, if
1123 * the shell died because of a signal the job
1124 * is also finished. In these cases, finish
1125 * out the job's output before printing the
1129 if (job->cmdFILE != NULL &&
1130 job->cmdFILE != stdout) {
1131 fclose(job->cmdFILE);
1137 * No need to close things down or anything.
1142 if (WIFEXITED(*status)) {
1143 if (done || DEBUG(JOB)) {
1148 (job->flags & JOB_IGNERR)) {
1150 * If output is going to a file and this job
1151 * is ignoring errors, arrange to have the
1152 * exit status sent to the output file as
1155 out = fdopen(job->outFd, "w");
1157 Punt("Cannot fdopen");
1162 DEBUGF(JOB, ("Process %jd exited.\n",
1163 (intmax_t)job->pid));
1165 if (WEXITSTATUS(*status) == 0) {
1167 if (usePipes && job->node != lastNode) {
1168 MESSAGE(out, job->node);
1169 lastNode = job->node;
1172 "*** Completed successfully\n");
1175 if (usePipes && job->node != lastNode) {
1176 MESSAGE(out, job->node);
1177 lastNode = job->node;
1179 fprintf(out, "*** Error code %d%s\n",
1180 WEXITSTATUS(*status),
1181 (job->flags & JOB_IGNERR) ?
1184 if (job->flags & JOB_IGNERR) {
1191 } else if (WIFSIGNALED(*status)) {
1192 if (done || DEBUG(JOB) || (WTERMSIG(*status) == SIGCONT)) {
1197 (job->flags & JOB_IGNERR)) {
1199 * If output is going to a file and this job
1200 * is ignoring errors, arrange to have the
1201 * exit status sent to the output file as
1204 out = fdopen(job->outFd, "w");
1206 Punt("Cannot fdopen");
1211 if (WTERMSIG(*status) == SIGCONT) {
1213 * If the beastie has continued, shift the
1214 * Job from the stopped list to the running
1215 * one (or re-stop it if concurrency is
1216 * exceeded) and go and get another child.
1218 if (job->flags & (JOB_RESUME | JOB_RESTART)) {
1219 if (usePipes && job->node != lastNode) {
1220 MESSAGE(out, job->node);
1221 lastNode = job->node;
1223 fprintf(out, "*** Continued\n");
1225 if (!(job->flags & JOB_CONTINUING)) {
1226 DEBUGF(JOB, ("Warning: process %jd was not "
1227 "continuing.\n", (intmax_t) job->pid));
1230 * We don't really want to restart a
1231 * job from scratch just because it
1232 * continued, especially not without
1233 * killing the continuing process!
1234 * That's why this is ifdef'ed out.
1240 job->flags &= ~JOB_CONTINUING;
1241 TAILQ_INSERT_TAIL(&jobs, job, link);
1243 DEBUGF(JOB, ("Process %jd is continuing locally.\n",
1244 (intmax_t) job->pid));
1245 if (nJobs == maxJobs) {
1247 DEBUGF(JOB, ("Job queue is full.\n"));
1253 if (usePipes && job->node != lastNode) {
1254 MESSAGE(out, job->node);
1255 lastNode = job->node;
1258 "*** Signal %d\n", WTERMSIG(*status));
1266 if (compatMake && !usePipes && (job->flags & JOB_IGNERR)) {
1268 * If output is going to a file and this job
1269 * is ignoring errors, arrange to have the
1270 * exit status sent to the output file as
1273 out = fdopen(job->outFd, "w");
1275 Punt("Cannot fdopen");
1280 DEBUGF(JOB, ("Process %jd stopped.\n", (intmax_t) job->pid));
1281 if (usePipes && job->node != lastNode) {
1282 MESSAGE(out, job->node);
1283 lastNode = job->node;
1285 fprintf(out, "*** Stopped -- signal %d\n", WSTOPSIG(*status));
1286 job->flags |= JOB_RESUME;
1287 TAILQ_INSERT_TAIL(&stoppedJobs, job, link);
1293 * Now handle the -B-mode stuff. If the beast still isn't finished,
1294 * try and restart the job on the next command. If JobStart says it's
1295 * ok, it's ok. If there's an error, this puppy is done.
1297 if (compatMake && WIFEXITED(*status) &&
1298 Lst_Succ(job->node->compat_command) != NULL) {
1299 switch (JobStart(job->node, job->flags & JOB_IGNDOTS, job)) {
1305 W_SETEXITSTATUS(status, 1);
1309 * If we got back a JOB_FINISHED code, JobStart has
1310 * already called Make_Update and freed the job
1311 * descriptor. We set done to false here to avoid fake
1312 * cycles and double frees. JobStart needs to do the
1313 * update so we can proceed up the graph when given
1325 if (done && aborting != ABORT_ERROR &&
1326 aborting != ABORT_INTERRUPT && *status == 0) {
1328 * As long as we aren't aborting and the job didn't return a
1329 * non-zero status that we shouldn't ignore, we call
1330 * Make_Update to update the parents. In addition, any saved
1331 * commands for the node are placed on the .END target.
1333 for (ln = job->tailCmds; ln != NULL; ln = LST_NEXT(ln)) {
1334 Lst_AtEnd(&postCommands->commands,
1336 Var_Subst(Lst_Datum(ln), job->node, FALSE)));
1339 job->node->made = MADE;
1340 Make_Update(job->node);
1343 } else if (*status != 0) {
1351 * Set aborting if any error.
1353 if (errors && !keepgoing && aborting != ABORT_INTERRUPT) {
1355 * If we found any errors in this batch of children and the -k
1356 * flag wasn't given, we set the aborting flag so no more jobs
1359 aborting = ABORT_ERROR;
1362 if (aborting == ABORT_ERROR && Job_Empty()) {
1364 * If we are aborting and the job table is now empty, we finish.
1372 * Touch the given target. Called by JobStart when the -t flag was
1373 * given. Prints messages unless told to be silent.
1376 * The data modification of the file is changed. In addition, if the
1377 * file did not exist, it is created.
1380 Job_Touch(GNode *gn, Boolean silent)
1382 int streamID; /* ID of stream opened to do the touch */
1383 struct utimbuf times; /* Times for utime() call */
1385 if (gn->type & (OP_JOIN | OP_USE | OP_EXEC | OP_OPTIONAL)) {
1387 * .JOIN, .USE, .ZEROTIME and .OPTIONAL targets are "virtual"
1388 * targets and, as such, shouldn't really be created.
1394 fprintf(stdout, "touch %s\n", gn->name);
1402 if (gn->type & OP_ARCHV) {
1404 } else if (gn->type & OP_LIB) {
1407 char *file = gn->path ? gn->path : gn->name;
1409 times.actime = times.modtime = now;
1410 if (utime(file, ×) < 0) {
1411 streamID = open(file, O_RDWR | O_CREAT, 0666);
1413 if (streamID >= 0) {
1417 * Read and write a byte to the file to change
1418 * the modification time, then close the file.
1420 if (read(streamID, &c, 1) == 1) {
1421 lseek(streamID, (off_t)0, SEEK_SET);
1422 write(streamID, &c, 1);
1427 fprintf(stdout, "*** couldn't touch %s: %s",
1428 file, strerror(errno));
1437 * Make sure the given node has all the commands it needs.
1440 * TRUE if the commands list is/was ok.
1443 * The node will have commands from the .DEFAULT rule added to it
1447 Job_CheckCommands(GNode *gn, void (*abortProc)(const char *, ...))
1450 if (OP_NOP(gn->type) && Lst_IsEmpty(&gn->commands) &&
1451 (gn->type & OP_LIB) == 0) {
1453 * No commands. Look for .DEFAULT rule from which we might infer
1456 if (DEFAULT != NULL && !Lst_IsEmpty(&DEFAULT->commands)) {
1458 * Make only looks for a .DEFAULT if the node was
1459 * never the target of an operator, so that's what we
1460 * do too. If a .DEFAULT was given, we substitute its
1461 * commands for gn's commands and set the IMPSRC
1462 * variable to be the target's name The DEFAULT node
1463 * acts like a transformation rule, in that gn also
1464 * inherits any attributes or sources attached to
1467 Make_HandleUse(DEFAULT, gn);
1468 Var_Set(IMPSRC, Var_Value(TARGET, gn), gn);
1470 } else if (Dir_MTime(gn) == 0) {
1472 * The node wasn't the target of an operator we have
1473 * no .DEFAULT rule to go on and the target doesn't
1474 * already exist. There's nothing more we can do for
1475 * this branch. If the -k flag wasn't given, we stop
1476 * in our tracks, otherwise we just don't update
1477 * this node's parents so they never get examined.
1479 static const char msg[] =
1480 "make: don't know how to make";
1482 if (gn->type & OP_OPTIONAL) {
1483 fprintf(stdout, "%s %s(ignored)\n",
1486 } else if (keepgoing) {
1487 fprintf(stdout, "%s %s(continuing)\n",
1493 if (strcmp(gn->name,"love") == 0)
1494 (*abortProc)("Not war.");
1497 (*abortProc)("%s %s. Stop",
1508 * Execute the shell for the given job. Called from JobStart and
1512 * A shell is executed, outputs is altered and the Job structure added
1516 JobExec(Job *job, char **argv)
1523 DEBUGF(JOB, ("Running %s\n", job->node->name));
1524 DEBUGF(JOB, ("\tCommand: "));
1525 for (i = 0; argv[i] != NULL; i++) {
1526 DEBUGF(JOB, ("%s ", argv[i]));
1528 DEBUGF(JOB, ("\n"));
1532 * Some jobs produce no output and it's disconcerting to have
1533 * no feedback of their running (since they produce no output, the
1534 * banner with their name in it never appears). This is an attempt to
1535 * provide that feedback, even if nothing follows it.
1537 if (lastNode != job->node && (job->flags & JOB_FIRST) &&
1538 !(job->flags & JOB_SILENT)) {
1539 MESSAGE(stdout, job->node);
1540 lastNode = job->node;
1543 ps.in = FILENO(job->cmdFILE);
1546 * Set up the child's output to be routed through the
1547 * pipe we've created for it.
1549 ps.out = job->outPipe;
1552 * We're capturing output in a file, so we duplicate
1553 * the descriptor to the temporary file into the
1556 ps.out = job->outFd;
1558 ps.err = STDERR_FILENO;
1560 ps.merge_errors = 1;
1568 * Fork. Warning since we are doing vfork() instead of fork(),
1569 * do not allocate memory in the child process!
1571 if ((ps.child_pid = vfork()) == -1) {
1572 Punt("Cannot fork");
1574 } else if (ps.child_pid == 0) {
1588 job->pid = ps.child_pid;
1590 if (usePipes && (job->flags & JOB_FIRST)) {
1592 * The first time a job is run for a node, we set the
1593 * current position in the buffer to the beginning and
1594 * mark another stream to watch in the outputs mask.
1597 struct kevent kev[2];
1601 #if defined(USE_KQUEUE)
1602 EV_SET(&kev[0], job->inPipe, EVFILT_READ, EV_ADD, 0, 0, job);
1603 EV_SET(&kev[1], job->pid, EVFILT_PROC,
1604 EV_ADD | EV_ONESHOT, NOTE_EXIT, 0, NULL);
1605 if (kevent(kqfd, kev, 2, NULL, 0, NULL) != 0) {
1607 * kevent() will fail if the job is already
1610 if (errno != EINTR && errno != EBADF && errno != ESRCH)
1611 Punt("kevent: %s", strerror(errno));
1614 FD_SET(job->inPipe, &outputs);
1615 #endif /* USE_KQUEUE */
1618 if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
1619 fclose(job->cmdFILE);
1620 job->cmdFILE = NULL;
1624 * Now the job is actually running, add it to the table.
1627 TAILQ_INSERT_TAIL(&jobs, job, link);
1628 if (nJobs == maxJobs) {
1636 * Create the argv needed to execute the shell for a given job.
1639 JobMakeArgv(Job *job, char **argv)
1642 static char args[10]; /* For merged arguments */
1644 argv[0] = shellName;
1647 if ((commandShell->exit && *commandShell->exit != '-') ||
1648 (commandShell->echo && *commandShell->echo != '-')) {
1650 * At least one of the flags doesn't have a minus before it, so
1651 * merge them together. Have to do this because the *(&(@*#*&#$#
1652 * Bourne shell thinks its second argument is a file to source.
1653 * Grrrr. Note the ten-character limitation on the combined
1656 sprintf(args, "-%s%s", (job->flags & JOB_IGNERR) ? "" :
1657 commandShell->exit ? commandShell->exit : "",
1658 (job->flags & JOB_SILENT) ? "" :
1659 commandShell->echo ? commandShell->echo : "");
1666 if (!(job->flags & JOB_IGNERR) && commandShell->exit) {
1667 argv[argc] = commandShell->exit;
1670 if (!(job->flags & JOB_SILENT) && commandShell->echo) {
1671 argv[argc] = commandShell->echo;
1680 * Restart a job that stopped for some reason. The job must be neither
1681 * on the jobs nor on the stoppedJobs list.
1684 * jobFull will be set if the job couldn't be run.
1687 JobRestart(Job *job)
1690 if (job->flags & JOB_RESTART) {
1692 * Set up the control arguments to the shell. This is based on
1693 * the flags set earlier for this job. If the JOB_IGNERR flag
1694 * is clear, the 'exit' flag of the commandShell is used to
1695 * cause it to exit upon receiving an error. If the JOB_SILENT
1696 * flag is clear, the 'echo' flag of the commandShell is used
1697 * to get it to start echoing as soon as it starts
1698 * processing commands.
1702 JobMakeArgv(job, argv);
1704 DEBUGF(JOB, ("Restarting %s...", job->node->name));
1705 if (nJobs >= maxJobs && !(job->flags & JOB_SPECIAL)) {
1707 * Not allowed to run -- put it back on the hold
1708 * queue and mark the table full
1710 DEBUGF(JOB, ("holding\n"));
1711 TAILQ_INSERT_HEAD(&stoppedJobs, job, link);
1713 DEBUGF(JOB, ("Job queue is full.\n"));
1717 * Job may be run locally.
1719 DEBUGF(JOB, ("running locally\n"));
1725 * The job has stopped and needs to be restarted.
1726 * Why it stopped, we don't know...
1728 DEBUGF(JOB, ("Resuming %s...", job->node->name));
1729 if ((nJobs < maxJobs || ((job->flags & JOB_SPECIAL) &&
1730 maxJobs == 0)) && nJobs != maxJobs) {
1732 * If we haven't reached the concurrency limit already
1733 * (or the job must be run and maxJobs is 0), it's ok
1739 error = (KILL(job->pid, SIGCONT) != 0);
1743 * Make sure the user knows we've continued
1744 * the beast and actually put the thing in the
1747 job->flags |= JOB_CONTINUING;
1749 W_SETTERMSIG(&status, SIGCONT);
1750 JobFinish(job, &status);
1752 job->flags &= ~(JOB_RESUME|JOB_CONTINUING);
1753 DEBUGF(JOB, ("done\n"));
1755 Error("couldn't resume %s: %s",
1756 job->node->name, strerror(errno));
1758 W_SETEXITSTATUS(&status, 1);
1759 JobFinish(job, &status);
1763 * Job cannot be restarted. Mark the table as full and
1764 * place the job back on the list of stopped jobs.
1766 DEBUGF(JOB, ("table full\n"));
1767 TAILQ_INSERT_HEAD(&stoppedJobs, job, link);
1769 DEBUGF(JOB, ("Job queue is full.\n"));
1776 * Start a target-creation process going for the target described
1777 * by the graph node gn.
1780 * JOB_ERROR if there was an error in the commands, JOB_FINISHED
1781 * if there isn't actually anything left to do for the job and
1782 * JOB_RUNNING if the job has been started.
1785 * A new Job node is created and added to the list of running
1786 * jobs. PMake is forked and a child shell created.
1789 JobStart(GNode *gn, int flags, Job *previous)
1791 Job *job; /* new job descriptor */
1792 char *argv[4]; /* Argument vector to shell */
1793 Boolean cmdsOK; /* true if the nodes commands were all right */
1794 Boolean noExec; /* Set true if we decide not to run the job */
1795 int tfd; /* File descriptor for temp file */
1797 char tfile[sizeof(TMPPAT)];
1800 JobPassSig(interrupted);
1803 if (previous != NULL) {
1804 previous->flags &= ~(JOB_FIRST | JOB_IGNERR | JOB_SILENT);
1807 job = emalloc(sizeof(Job));
1812 job->tailCmds = NULL;
1815 * Set the initial value of the flags for this job based on the global
1816 * ones and the node's attributes... Any flags supplied by the caller
1817 * are also added to the field.
1820 if (Targ_Ignore(gn)) {
1821 job->flags |= JOB_IGNERR;
1823 if (Targ_Silent(gn)) {
1824 job->flags |= JOB_SILENT;
1826 job->flags |= flags;
1829 * Check the commands now so any attributes from .DEFAULT have a chance
1830 * to migrate to the node.
1832 if (!compatMake && (job->flags & JOB_FIRST)) {
1833 cmdsOK = Job_CheckCommands(gn, Error);
1839 * If the -n flag wasn't given, we open up OUR (not the child's)
1840 * temporary file to stuff commands in it. The thing is rd/wr so we
1841 * don't need to reopen it to feed it to the shell. If the -n flag
1842 * *was* given, we just set the file to be stdout. Cute, huh?
1844 if ((gn->type & OP_MAKE) || (!noExecute && !touchFlag)) {
1846 * We're serious here, but if the commands were bogus, we're
1853 strcpy(tfile, TMPPAT);
1854 if ((tfd = mkstemp(tfile)) == -1)
1855 Punt("Cannot create temp file: %s", strerror(errno));
1856 job->cmdFILE = fdopen(tfd, "w+");
1858 if (job->cmdFILE == NULL) {
1860 Punt("Could not open %s", tfile);
1862 fcntl(FILENO(job->cmdFILE), F_SETFD, 1);
1864 * Send the commands to the command file, flush all its
1865 * buffers then rewind and remove the thing.
1870 * Used to be backwards; replace when start doing multiple
1871 * commands per shell.
1875 * Be compatible: If this is the first time for this
1876 * node, verify its commands are ok and open the
1877 * commands list for sequential access by later
1878 * invocations of JobStart. Once that is done, we take
1879 * the next command off the list and print it to the
1880 * command file. If the command was an ellipsis, note
1881 * that there's nothing more to execute.
1883 if (job->flags & JOB_FIRST)
1884 gn->compat_command = Lst_First(&gn->commands);
1886 gn->compat_command =
1887 Lst_Succ(gn->compat_command);
1889 if (gn->compat_command == NULL ||
1890 JobPrintCommand(Lst_Datum(gn->compat_command), job))
1893 if (noExec && !(job->flags & JOB_FIRST)) {
1895 * If we're not going to execute anything, the
1896 * job is done and we need to close down the
1897 * various file descriptors we've opened for
1898 * output, then call JobDoOutput to catch the
1899 * final characters or send the file to the
1900 * screen... Note that the i/o streams are only
1901 * open if this isn't the first job. Note also
1902 * that this could not be done in
1903 * Job_CatchChildren b/c it wasn't clear if
1904 * there were more commands to execute or not...
1910 * We can do all the commands at once. hooray for sanity
1913 LST_FOREACH(ln, &gn->commands) {
1914 if (JobPrintCommand(Lst_Datum(ln), job))
1919 * If we didn't print out any commands to the shell
1920 * script, there's not much point in executing the
1923 if (numCommands == 0) {
1928 } else if (noExecute) {
1930 * Not executing anything -- just print all the commands to
1931 * stdout in one fell swoop. This will still set up
1932 * job->tailCmds correctly.
1934 if (lastNode != gn) {
1935 MESSAGE(stdout, gn);
1938 job->cmdFILE = stdout;
1941 * Only print the commands if they're ok, but don't die if
1942 * they're not -- just let the user know they're bad and keep
1943 * going. It doesn't do any harm in this case and may do
1947 LST_FOREACH(ln, &gn->commands) {
1948 if (JobPrintCommand(Lst_Datum(ln), job))
1953 * Don't execute the shell, thank you.
1959 * Just touch the target and note that no shell should be
1960 * executed. Set cmdFILE to stdout to make life easier. Check
1961 * the commands, too, but don't die if they're no good -- it
1962 * does no harm to keep working up the graph.
1964 job->cmdFILE = stdout;
1965 Job_Touch(gn, job->flags & JOB_SILENT);
1970 * If we're not supposed to execute a shell, don't.
1974 * Unlink and close the command file if we opened one
1976 if (job->cmdFILE != stdout) {
1977 if (job->cmdFILE != NULL)
1978 fclose(job->cmdFILE);
1984 * We only want to work our way up the graph if we aren't here
1985 * because the commands for the job were no good.
1988 if (aborting == 0) {
1989 for (ln = job->tailCmds; ln != NULL;
1990 ln = LST_NEXT(ln)) {
1991 Lst_AtEnd(&postCommands->commands,
1992 Buf_Peel(Var_Subst(Lst_Datum(ln),
1993 job->node, FALSE)));
1995 job->node->made = MADE;
1996 Make_Update(job->node);
1999 return(JOB_FINISHED);
2005 fflush(job->cmdFILE);
2009 * Set up the control arguments to the shell. This is based on the flags
2010 * set earlier for this job.
2012 JobMakeArgv(job, argv);
2015 * If we're using pipes to catch output, create the pipe by which we'll
2016 * get the shell's output. If we're using files, print out that we're
2017 * starting a job and then set up its temporary-file name.
2019 if (!compatMake || (job->flags & JOB_FIRST)) {
2024 Punt("Cannot create pipe: %s", strerror(errno));
2025 job->inPipe = fd[0];
2026 job->outPipe = fd[1];
2027 fcntl(job->inPipe, F_SETFD, 1);
2028 fcntl(job->outPipe, F_SETFD, 1);
2030 fprintf(stdout, "Remaking `%s'\n", gn->name);
2032 strcpy(job->outFile, TMPPAT);
2033 if ((job->outFd = mkstemp(job->outFile)) == -1)
2034 Punt("cannot create temp file: %s",
2036 fcntl(job->outFd, F_SETFD, 1);
2040 if (nJobs >= maxJobs && !(job->flags & JOB_SPECIAL) && maxJobs != 0) {
2042 * We've hit the limit of concurrency, so put the job on hold
2043 * until some other job finishes. Note that the special jobs
2044 * (.BEGIN, .INTERRUPT and .END) may be run even when the
2045 * limit has been reached (e.g. when maxJobs == 0).
2049 DEBUGF(JOB, ("Can only run job locally.\n"));
2050 job->flags |= JOB_RESTART;
2051 TAILQ_INSERT_TAIL(&stoppedJobs, job, link);
2053 if (nJobs >= maxJobs) {
2055 * If we're running this job as a special case
2056 * (see above), at least say the table is full.
2059 DEBUGF(JOB, ("Local job queue is full.\n"));
2063 return (JOB_RUNNING);
2067 JobOutput(Job *job, char *cp, char *endp, int msg)
2071 if (commandShell->noPrint) {
2072 ecp = strstr(cp, commandShell->noPrint);
2073 while (ecp != NULL) {
2076 if (msg && job->node != lastNode) {
2077 MESSAGE(stdout, job->node);
2078 lastNode = job->node;
2081 * The only way there wouldn't be a newline
2082 * after this line is if it were the last in
2083 * the buffer. However, since the non-printable
2084 * comes after it, there must be a newline, so
2085 * we don't print one.
2087 fprintf(stdout, "%s", cp);
2090 cp = ecp + strlen(commandShell->noPrint);
2093 * Still more to print, look again after
2094 * skipping the whitespace following the
2095 * non-printable command....
2098 while (*cp == ' ' || *cp == '\t' ||
2102 ecp = strstr(cp, commandShell->noPrint);
2113 * This function is called at different times depending on
2114 * whether the user has specified that output is to be collected
2115 * via pipes or temporary files. In the former case, we are called
2116 * whenever there is something to read on the pipe. We collect more
2117 * output from the given job and store it in the job's outBuf. If
2118 * this makes up a line, we print it tagged by the job's identifier,
2120 * If output has been collected in a temporary file, we open the
2121 * file and read it line by line, transfering it to our own
2122 * output channel until the file is empty. At which point we
2123 * remove the temporary file.
2124 * In both cases, however, we keep our figurative eye out for the
2125 * 'noPrint' line for the shell from which the output came. If
2126 * we recognize a line, we don't print it. If the command is not
2127 * alone on the line (the character after it is not \0 or \n), we
2128 * do print whatever follows it.
2131 * curPos may be shifted as may the contents of outBuf.
2134 JobDoOutput(Job *job, Boolean finish)
2136 Boolean gotNL = FALSE; /* true if got a newline */
2137 Boolean fbuf; /* true if our buffer filled up */
2138 int nr; /* number of bytes read */
2139 int i; /* auxiliary index into outBuf */
2140 int max; /* limit for i (end of current data) */
2141 int nRead; /* (Temporary) number of bytes read */
2142 FILE *oFILE; /* Stream pointer to shell's output file */
2147 * Read as many bytes as will fit in the buffer.
2153 nRead = read(job->inPipe, &job->outBuf[job->curPos],
2154 JOB_BUFSIZE - job->curPos);
2156 * Check for interrupt here too, because the above read may
2157 * block when the child process is stopped. In this case the
2158 * interrupt will unblock it (we don't use SA_RESTART).
2161 JobPassSig(interrupted);
2164 DEBUGF(JOB, ("JobDoOutput(piperead)"));
2171 * If we hit the end-of-file (the job is dead), we must flush
2172 * its remaining output, so pretend we read a newline if
2173 * there's any output remaining in the buffer.
2174 * Also clear the 'finish' flag so we stop looping.
2176 if (nr == 0 && job->curPos != 0) {
2177 job->outBuf[job->curPos] = '\n';
2180 } else if (nr == 0) {
2185 * Look for the last newline in the bytes we just got. If there
2186 * is one, break out of the loop with 'i' as its index and
2189 max = job->curPos + nr;
2190 for (i = job->curPos + nr - 1; i >= job->curPos; i--) {
2191 if (job->outBuf[i] == '\n') {
2194 } else if (job->outBuf[i] == '\0') {
2198 job->outBuf[i] = ' ';
2204 if (job->curPos == JOB_BUFSIZE) {
2206 * If we've run out of buffer space, we have
2207 * no choice but to print the stuff. sigh.
2213 if (gotNL || fbuf) {
2215 * Need to send the output to the screen. Null terminate
2216 * it first, overwriting the newline character if there
2217 * was one. So long as the line isn't one we should
2218 * filter (according to the shell description), we print
2219 * the line, preceded by a target banner if this target
2220 * isn't the same as the one for which we last printed
2221 * something. The rest of the data in the buffer are
2222 * then shifted down to the start of the buffer and
2223 * curPos is set accordingly.
2225 job->outBuf[i] = '\0';
2226 if (i >= job->curPos) {
2229 cp = JobOutput(job, job->outBuf,
2230 &job->outBuf[i], FALSE);
2233 * There's still more in that buffer. This time,
2234 * though, we know there's no newline at the
2235 * end, so we add one of our own free will.
2238 if (job->node != lastNode) {
2239 MESSAGE(stdout, job->node);
2240 lastNode = job->node;
2242 fprintf(stdout, "%s%s", cp,
2248 /* shift the remaining characters down */
2249 memcpy(job->outBuf, &job->outBuf[i + 1],
2251 job->curPos = max - (i + 1);
2255 * We have written everything out, so we just
2256 * start over from the start of the buffer.
2257 * No copying. No nothing.
2264 * If the finish flag is true, we must loop until we hit
2265 * end-of-file on the pipe. This is guaranteed to happen
2266 * eventually since the other end of the pipe is now
2267 * closed (we closed it explicitly and the child has
2268 * exited). When we do get an EOF, finish will be set
2269 * FALSE and we'll fall through and out.
2276 * We've been called to retrieve the output of the job from the
2277 * temporary file where it's been squirreled away. This consists
2278 * of opening the file, reading the output line by line, being
2279 * sure not to print the noPrint line for the shell we used,
2280 * then close and remove the temporary file. Very simple.
2282 * Change to read in blocks and do FindSubString type things
2283 * as for pipes? That would allow for "@echo -n..."
2285 oFILE = fopen(job->outFile, "r");
2286 if (oFILE != NULL) {
2287 fprintf(stdout, "Results of making %s:\n",
2291 while (fgets(inLine, sizeof(inLine), oFILE) != NULL) {
2292 char *cp, *endp, *oendp;
2295 oendp = endp = inLine + strlen(inLine);
2296 if (endp[-1] == '\n') {
2299 cp = JobOutput(job, inLine, endp, FALSE);
2302 * There's still more in that buffer. This time,
2303 * though, we know there's no newline at the
2304 * end, so we add one of our own free will.
2306 fprintf(stdout, "%s", cp);
2308 if (endp != oendp) {
2309 fprintf(stdout, "\n");
2314 eunlink(job->outFile);
2321 * Handle the exit of a child. Called from Make_Make.
2324 * The job descriptor is removed from the list of children.
2327 * We do waits, blocking or not, according to the wisdom of our
2328 * caller, until there are no more children to report. For each
2329 * job, call JobFinish to finish things off. This will take care of
2330 * putting jobs on the stoppedJobs queue.
2333 Job_CatchChildren(Boolean block)
2335 pid_t pid; /* pid of dead child */
2336 Job *job; /* job descriptor for dead child */
2337 int status; /* Exit/termination status */
2340 * Don't even bother if we know there's no one around.
2347 pid = waitpid((pid_t)-1, &status,
2348 (block ? 0 : WNOHANG) | WUNTRACED);
2352 DEBUGF(JOB, ("Process %jd exited or stopped.\n",
2355 TAILQ_FOREACH(job, &jobs, link) {
2356 if (job->pid == pid)
2361 if (WIFSIGNALED(status) &&
2362 (WTERMSIG(status) == SIGCONT)) {
2363 TAILQ_FOREACH(job, &jobs, link) {
2364 if (job->pid == pid)
2368 Error("Resumed child (%jd) "
2369 "not in table", (intmax_t)pid);
2372 TAILQ_REMOVE(&stoppedJobs, job, link);
2374 Error("Child (%jd) not in table?",
2379 TAILQ_REMOVE(&jobs, job, link);
2381 if (fifoFd >= 0 && maxJobs > 1) {
2382 write(fifoFd, "+", 1);
2384 if (nJobs >= maxJobs)
2389 DEBUGF(JOB, ("Job queue is no longer full.\n"));
2394 JobFinish(job, &status);
2397 JobPassSig(interrupted);
2402 * Catch the output from our children, if we're using
2403 * pipes do so. Otherwise just block time until we get a
2404 * signal(most likely a SIGCHLD) since there's no point in
2405 * just spinning when there's nothing to do and the reaping
2406 * of a child can wait for a while.
2409 * Output is read from pipes if we're piping.
2410 * -----------------------------------------------------------------------
2414 Job_CatchOutput(int flag __unused)
2416 Job_CatchOutput(int flag)
2422 struct kevent kev[KEV_SIZE];
2425 struct timeval timeout;
2434 if ((nfds = kevent(kqfd, NULL, 0, kev, KEV_SIZE, NULL)) == -1) {
2436 Punt("kevent: %s", strerror(errno));
2438 JobPassSig(interrupted);
2440 for (i = 0; i < nfds; i++) {
2441 if (kev[i].flags & EV_ERROR) {
2442 warnc(kev[i].data, "kevent");
2445 switch (kev[i].filter) {
2447 JobDoOutput(kev[i].udata, FALSE);
2451 * Just wake up and let
2452 * Job_CatchChildren() collect the
2461 timeout.tv_sec = SEL_SEC;
2462 timeout.tv_usec = SEL_USEC;
2463 if (flag && jobFull && fifoFd >= 0)
2464 FD_SET(fifoFd, &readfds);
2466 nfds = select(FD_SETSIZE, &readfds, (fd_set *)NULL,
2467 (fd_set *)NULL, &timeout);
2470 JobPassSig(interrupted);
2473 if (fifoFd >= 0 && FD_ISSET(fifoFd, &readfds)) {
2477 job = TAILQ_FIRST(&jobs);
2478 while (nfds != 0 && job != NULL) {
2479 if (FD_ISSET(job->inPipe, &readfds)) {
2480 JobDoOutput(job, FALSE);
2483 job = TAILQ_NEXT(job, link);
2485 #endif /* !USE_KQUEUE */
2491 * Start the creation of a target. Basically a front-end for
2492 * JobStart used by the Make module.
2495 * Another job is started.
2501 JobStart(gn, 0, NULL);
2506 * Make a new copy of the shell structure including a copy of the strings
2507 * in it. This also defaults some fields in case they are NULL.
2510 * The function returns a pointer to the new shell structure.
2512 static struct Shell *
2513 JobCopyShell(const struct Shell *osh)
2517 nsh = emalloc(sizeof(*nsh));
2518 nsh->name = estrdup(osh->name);
2520 if (osh->echoOff != NULL)
2521 nsh->echoOff = estrdup(osh->echoOff);
2523 nsh->echoOff = NULL;
2524 if (osh->echoOn != NULL)
2525 nsh->echoOn = estrdup(osh->echoOn);
2528 nsh->hasEchoCtl = osh->hasEchoCtl;
2530 if (osh->noPrint != NULL)
2531 nsh->noPrint = estrdup(osh->noPrint);
2533 nsh->noPrint = NULL;
2535 nsh->hasErrCtl = osh->hasErrCtl;
2536 if (osh->errCheck == NULL)
2537 nsh->errCheck = estrdup("");
2539 nsh->errCheck = estrdup(osh->errCheck);
2540 if (osh->ignErr == NULL)
2541 nsh->ignErr = estrdup("%s");
2543 nsh->ignErr = estrdup(osh->ignErr);
2545 if (osh->echo == NULL)
2546 nsh->echo = estrdup("");
2548 nsh->echo = estrdup(osh->echo);
2550 if (osh->exit == NULL)
2551 nsh->exit = estrdup("");
2553 nsh->exit = estrdup(osh->exit);
2560 * Free a shell structure and all associated strings.
2563 JobFreeShell(struct Shell *sh)
2583 if (commandShell == NULL)
2584 commandShell = JobMatchShell(shells[DEFSHELL].name);
2586 if (shellPath == NULL) {
2588 * The user didn't specify a shell to use, so we are using the
2589 * default one... Both the absolute path and the last component
2590 * must be set. The last component is taken from the 'name'
2591 * field of the default shell description pointed-to by
2592 * commandShell. All default shells are located in
2595 shellName = commandShell->name;
2596 shellPath = str_concat(PATH_DEFSHELLDIR, shellName,
2603 * Initialize the process module, given a maximum number of jobs.
2606 * lists and counters are initialized
2609 Job_Init(int maxproc)
2611 GNode *begin; /* node for commands to do at the very start */
2613 struct sigaction sa;
2616 env = getenv("MAKE_JOBS_FIFO");
2618 if (env == NULL && maxproc > 1) {
2620 * We did not find the environment variable so we are the
2621 * leader. Create the fifo, open it, write one char per
2622 * allowed job into the pipe.
2624 fifoFd = mkfifotemp(fifoName);
2629 fcntl(fifoFd, F_SETFL, O_NONBLOCK);
2631 setenv("MAKE_JOBS_FIFO", env, 1);
2632 while (maxproc-- > 0) {
2633 write(fifoFd, "+", 1);
2635 /* The master make does not get a magic token */
2640 } else if (env != NULL) {
2642 * We had the environment variable so we are a slave.
2643 * Open fifo and give ourselves a magic token which represents
2644 * the token our parent make has grabbed to start his make
2645 * process. Otherwise the sub-makes would gobble up tokens and
2646 * the proper number of tokens to specify to -j would depend
2647 * on the depth of the tree and the order of execution.
2649 fifoFd = open(env, O_RDWR, 0);
2651 fcntl(fifoFd, F_SETFL, O_NONBLOCK);
2668 if ((maxJobs == 1 && fifoFd < 0) || beVerbose == 0) {
2670 * If only one job can run at a time, there's no need for a
2671 * banner, no is there?
2681 * Catch the four signals that POSIX specifies if they aren't ignored.
2682 * JobCatchSignal will just set global variables and hope someone
2683 * else is going to handle the interrupt.
2685 sa.sa_handler = JobCatchSig;
2686 sigemptyset(&sa.sa_mask);
2689 if (signal(SIGINT, SIG_IGN) != SIG_IGN) {
2690 sigaction(SIGINT, &sa, NULL);
2692 if (signal(SIGHUP, SIG_IGN) != SIG_IGN) {
2693 sigaction(SIGHUP, &sa, NULL);
2695 if (signal(SIGQUIT, SIG_IGN) != SIG_IGN) {
2696 sigaction(SIGQUIT, &sa, NULL);
2698 if (signal(SIGTERM, SIG_IGN) != SIG_IGN) {
2699 sigaction(SIGTERM, &sa, NULL);
2702 * There are additional signals that need to be caught and passed if
2703 * either the export system wants to be told directly of signals or if
2704 * we're giving each job its own process group (since then it won't get
2705 * signals from the terminal driver as we own the terminal)
2707 #if defined(USE_PGRP)
2708 if (signal(SIGTSTP, SIG_IGN) != SIG_IGN) {
2709 sigaction(SIGTSTP, &sa, NULL);
2711 if (signal(SIGTTOU, SIG_IGN) != SIG_IGN) {
2712 sigaction(SIGTTOU, &sa, NULL);
2714 if (signal(SIGTTIN, SIG_IGN) != SIG_IGN) {
2715 sigaction(SIGTTIN, &sa, NULL);
2717 if (signal(SIGWINCH, SIG_IGN) != SIG_IGN) {
2718 sigaction(SIGWINCH, &sa, NULL);
2723 if ((kqfd = kqueue()) == -1) {
2724 Punt("kqueue: %s", strerror(errno));
2728 begin = Targ_FindNode(".BEGIN", TARG_NOCREATE);
2730 if (begin != NULL) {
2731 JobStart(begin, JOB_SPECIAL, (Job *)NULL);
2734 Job_CatchChildren(!usePipes);
2737 postCommands = Targ_FindNode(".END", TARG_CREATE);
2742 * See if the job table is full. It is considered full if it is OR
2743 * if we are in the process of aborting OR if we have
2744 * reached/exceeded our local quota. This prevents any more jobs
2748 * TRUE if the job table is full, FALSE otherwise
2758 if (fifoFd >= 0 && jobFull) {
2759 i = read(fifoFd, &c, 1);
2770 * See if the job table is empty. Because the local concurrency may
2771 * be set to 0, it is possible for the job table to become empty,
2772 * while the list of stoppedJobs remains non-empty. In such a case,
2773 * we want to restart as many jobs as we can.
2776 * TRUE if it is. FALSE if it ain't.
2782 if (!TAILQ_EMPTY(&stoppedJobs) && !aborting) {
2784 * The job table is obviously not full if it has no
2785 * jobs in it...Try and restart the stopped jobs.
2800 * Find a matching shell in 'shells' given its final component.
2803 * A pointer to a freshly allocated Shell structure with a copy
2804 * of the static structure or NULL if no shell with the given name
2807 static struct Shell *
2808 JobMatchShell(const char *name)
2810 const struct CShell *sh; /* Pointer into shells table */
2813 for (sh = shells; sh < shells + __arysize(shells); sh++)
2814 if (strcmp(sh->name, name) == 0)
2817 if (sh == shells + __arysize(shells))
2821 nsh = emalloc(sizeof(*nsh));
2823 nsh->name = estrdup(sh->name);
2824 nsh->echoOff = estrdup(sh->echoOff);
2825 nsh->echoOn = estrdup(sh->echoOn);
2826 nsh->hasEchoCtl = sh->hasEchoCtl;
2827 nsh->noPrint = estrdup(sh->noPrint);
2828 nsh->hasErrCtl = sh->hasErrCtl;
2829 nsh->errCheck = estrdup(sh->errCheck);
2830 nsh->ignErr = estrdup(sh->ignErr);
2831 nsh->echo = estrdup(sh->echo);
2832 nsh->exit = estrdup(sh->exit);
2839 * Parse a shell specification and set up commandShell, shellPath
2840 * and shellName appropriately.
2843 * FAILURE if the specification was incorrect.
2846 * commandShell points to a Shell structure (either predefined or
2847 * created from the shell spec), shellPath is the full path of the
2848 * shell described by commandShell, while shellName is just the
2849 * final component of shellPath.
2852 * A shell specification consists of a .SHELL target, with dependency
2853 * operator, followed by a series of blank-separated words. Double
2854 * quotes can be used to use blanks in words. A backslash escapes
2855 * anything (most notably a double-quote and a space) and
2856 * provides the functionality it does in C. Each word consists of
2857 * keyword and value separated by an equal sign. There should be no
2858 * unnecessary spaces in the word. The keywords are as follows:
2859 * name Name of shell.
2860 * path Location of shell. Overrides "name" if given
2861 * quiet Command to turn off echoing.
2862 * echo Command to turn echoing on
2863 * filter Result of turning off echoing that shouldn't be
2865 * echoFlag Flag to turn echoing on at the start
2866 * errFlag Flag to turn error checking on at the start
2867 * hasErrCtl True if shell has error checking control
2868 * check Command to turn on error checking if hasErrCtl
2869 * is TRUE or template of command to echo a command
2870 * for which error checking is off if hasErrCtl is
2872 * ignore Command to turn off error checking if hasErrCtl
2873 * is TRUE or template of command to execute a
2874 * command so as to ignore any errors it returns if
2875 * hasErrCtl is FALSE.
2878 Job_ParseShell(const char line[])
2885 Boolean fullSpec = FALSE;
2886 struct Shell newShell;
2889 memset(&newShell, 0, sizeof(newShell));
2893 * Parse the specification by keyword but skip the first word
2895 brk_string(&aa, line, TRUE);
2897 for (argc = aa.argc - 1, argv = aa.argv + 1; argc != 0; argc--, argv++)
2900 * Split keyword and value
2902 if ((eq = strchr(*argv, '=')) == NULL) {
2903 Parse_Error(PARSE_FATAL, "missing '=' in shell "
2904 "specification keyword '%s'", *argv);
2910 if (strcmp(*argv, "path") == 0) {
2912 } else if (strcmp(*argv, "name") == 0) {
2914 } else if (strcmp(*argv, "quiet") == 0) {
2915 newShell.echoOff = eq;
2917 } else if (strcmp(*argv, "echo") == 0) {
2918 newShell.echoOn = eq;
2920 } else if (strcmp(*argv, "filter") == 0) {
2921 newShell.noPrint = eq;
2923 } else if (strcmp(*argv, "echoFlag") == 0) {
2926 } else if (strcmp(*argv, "errFlag") == 0) {
2929 } else if (strcmp(*argv, "hasErrCtl") == 0) {
2930 newShell.hasErrCtl = (*eq == 'Y' || *eq == 'y' ||
2931 *eq == 'T' || *eq == 't');
2933 } else if (strcmp(*argv, "check") == 0) {
2934 newShell.errCheck = eq;
2936 } else if (strcmp(*argv, "ignore") == 0) {
2937 newShell.ignErr = eq;
2940 Parse_Error(PARSE_FATAL, "unknown keyword in shell "
2941 "specification '%s'", *argv);
2948 * Some checks (could be more)
2951 if ((newShell.echoOn != NULL) ^ (newShell.echoOff != NULL))
2952 Parse_Error(PARSE_FATAL, "Shell must have either both "
2953 "echoOff and echoOn or none of them");
2955 if (newShell.echoOn != NULL && newShell.echoOff)
2956 newShell.hasEchoCtl = TRUE;
2961 * If no path was given, the user wants one of the pre-defined
2962 * shells, yes? So we find the one s/he wants with the help of
2963 * JobMatchShell and set things up the right way. shellPath
2964 * will be set up by Job_Init.
2966 if (newShell.name == NULL) {
2967 Parse_Error(PARSE_FATAL,
2968 "Neither path nor name specified");
2972 if ((sh = JobMatchShell(newShell.name)) == NULL) {
2973 Parse_Error(PARSE_FATAL, "%s: no matching shell",
2981 * The user provided a path. If s/he gave nothing else
2982 * (fullSpec is FALSE), try and find a matching shell in the
2983 * ones we know of. Else we just take the specification at its
2984 * word and copy it to a new location. In either case, we need
2985 * to record the path the user gave for the shell.
2987 path = estrdup(path);
2988 if (newShell.name == NULL) {
2989 /* get the base name as the name */
2990 if ((newShell.name = strrchr(path, '/')) == NULL) {
2991 newShell.name = path;
2998 if ((sh = JobMatchShell(newShell.name)) == NULL) {
2999 Parse_Error(PARSE_FATAL,
3000 "%s: no matching shell", newShell.name);
3006 sh = JobCopyShell(&newShell);
3012 /* set the new shell */
3013 JobFreeShell(commandShell);
3016 shellName = commandShell->name;
3024 * Handle the receipt of an interrupt.
3027 * All children are killed. Another job will be started if the
3028 * .INTERRUPT target was given.
3031 JobInterrupt(int runINTERRUPT, int signo)
3033 Job *job; /* job descriptor in that element */
3034 GNode *interrupt; /* the node describing the .INTERRUPT target */
3036 aborting = ABORT_INTERRUPT;
3038 TAILQ_FOREACH(job, &jobs, link) {
3039 if (!Targ_Precious(job->node)) {
3040 char *file = (job->node->path == NULL ?
3041 job->node->name : job->node->path);
3043 if (!noExecute && eunlink(file) != -1) {
3044 Error("*** %s removed", file);
3048 DEBUGF(JOB, ("JobInterrupt passing signal to child "
3049 "%jd.\n", (intmax_t)job->pid));
3050 KILL(job->pid, signo);
3054 if (runINTERRUPT && !touchFlag) {
3056 * clear the interrupted flag because we would get an
3057 * infinite loop otherwise.
3061 interrupt = Targ_FindNode(".INTERRUPT", TARG_NOCREATE);
3062 if (interrupt != NULL) {
3063 ignoreErrors = FALSE;
3065 JobStart(interrupt, JOB_IGNDOTS, (Job *)NULL);
3068 Job_CatchChildren(!usePipes);
3076 * Do final processing such as the running of the commands
3077 * attached to the .END target.
3080 * Number of errors reported.
3086 if (postCommands != NULL && !Lst_IsEmpty(&postCommands->commands)) {
3088 Error("Errors reported so .END ignored");
3090 JobStart(postCommands, JOB_SPECIAL | JOB_IGNDOTS, NULL);
3094 Job_CatchChildren(!usePipes);
3109 * Waits for all running jobs to finish and returns. Sets 'aborting'
3110 * to ABORT_WAIT to prevent other jobs from starting.
3113 * Currently running jobs finish.
3119 aborting = ABORT_WAIT;
3120 while (nJobs != 0) {
3122 Job_CatchChildren(!usePipes);
3129 * Abort all currently running jobs without handling output or anything.
3130 * This function is to be called only in the event of a major
3131 * error. Most definitely NOT to be called from JobInterrupt.
3134 * All children are killed, not just the firstborn
3139 Job *job; /* the job descriptor in that element */
3142 aborting = ABORT_ERROR;
3145 TAILQ_FOREACH(job, &jobs, link) {
3147 * kill the child process with increasingly drastic
3148 * signals to make darn sure it's dead.
3150 KILL(job->pid, SIGINT);
3151 KILL(job->pid, SIGKILL);
3156 * Catch as many children as want to report in at first, then give up
3158 while (waitpid((pid_t)-1, &foo, WNOHANG) > 0)
3164 * Tries to restart stopped jobs if there are slots available.
3165 * Note that this tries to restart them regardless of pending errors.
3166 * It's not good to leave stopped jobs lying around!
3169 * Resumes(and possibly migrates) jobs.
3172 JobRestartJobs(void)
3176 while (!jobFull && (job = TAILQ_FIRST(&stoppedJobs)) != NULL) {
3177 DEBUGF(JOB, ("Job queue is not full. "
3178 "Restarting a stopped job.\n"));
3179 TAILQ_REMOVE(&stoppedJobs, job, link);
3186 * Execute the command in cmd, and return the output of that command
3190 * A string containing the output of the command, or the empty string
3191 * If error is not NULL, it contains the reason for the command failure
3192 * Any output sent to stderr in the child process is passed to stderr,
3193 * and not captured in the string.
3196 * The string must be freed by the caller.
3199 Cmd_Exec(const char *cmd, const char **error)
3201 int fds[2]; /* Pipe streams */
3202 int status; /* command exit status */
3203 Buffer *buf; /* buffer to store the result */
3210 if (shellPath == NULL)
3213 * Open a pipe for fetching its output
3215 if (pipe(fds) == -1) {
3216 *error = "Couldn't create pipe for \"%s\"";
3220 /* Set close-on-exec on read side of pipe. */
3221 fcntl(fds[0], F_SETFD, fcntl(fds[0], F_GETFD) | FD_CLOEXEC);
3223 ps.in = STDIN_FILENO;
3225 ps.err = STDERR_FILENO;
3227 ps.merge_errors = 0;
3231 /* Set up arguments for shell */
3232 ps.argv = emalloc(4 * sizeof(char *));
3233 ps.argv[0] = strdup(shellName);
3234 ps.argv[1] = strdup("-c");
3235 ps.argv[2] = strdup(cmd);
3240 * Fork. Warning since we are doing vfork() instead of fork(),
3241 * do not allocate memory in the child process!
3243 if ((ps.child_pid = vfork()) == -1) {
3244 *error = "Couldn't exec \"%s\"";
3246 } else if (ps.child_pid == 0) {
3259 close(fds[1]); /* No need for the writing half of the pipe. */
3262 char result[BUFSIZ];
3264 rcnt = read(fds[0], result, sizeof(result));
3266 Buf_AddBytes(buf, (size_t)rcnt, (Byte *)result);
3267 } while (rcnt > 0 || (rcnt == -1 && errno == EINTR));
3270 *error = "Error reading shell's output for \"%s\"";
3273 * Close the input side of the pipe.
3277 status = ProcWait(&ps);
3279 *error = "\"%s\" returned non-zero status";
3281 Buf_StripNewlines(buf);
3288 * Interrupt handler - set flag and defer handling to the main code
3291 CompatCatchSig(int signo)
3294 interrupted = signo;
3298 *-----------------------------------------------------------------------
3299 * CompatInterrupt --
3300 * Interrupt the creation of the current target and remove it if
3301 * it ain't precious.
3307 * The target is removed and the process exits. If .INTERRUPT exists,
3308 * its commands are run first WITH INTERRUPTS IGNORED..
3310 *-----------------------------------------------------------------------
3313 CompatInterrupt(int signo)
3316 sigset_t nmask, omask;
3319 sigemptyset(&nmask);
3320 sigaddset(&nmask, SIGINT);
3321 sigaddset(&nmask, SIGTERM);
3322 sigaddset(&nmask, SIGHUP);
3323 sigaddset(&nmask, SIGQUIT);
3324 sigprocmask(SIG_SETMASK, &nmask, &omask);
3326 /* prevent recursion in evaluation of .INTERRUPT */
3329 if (curTarg != NULL && !Targ_Precious(curTarg)) {
3330 const char *file = Var_Value(TARGET, curTarg);
3332 if (!noExecute && eunlink(file) != -1) {
3333 printf("*** %s removed\n", file);
3338 * Run .INTERRUPT only if hit with interrupt signal
3340 if (signo == SIGINT) {
3341 gn = Targ_FindNode(".INTERRUPT", TARG_NOCREATE);
3343 LST_FOREACH(ln, &gn->commands) {
3344 if (Compat_RunCommand(Lst_Datum(ln), gn))
3350 sigprocmask(SIG_SETMASK, &omask, NULL);
3352 if (signo == SIGQUIT)
3354 signal(signo, SIG_DFL);
3355 kill(getpid(), signo);
3359 *-----------------------------------------------------------------------
3360 * Compat_RunCommand --
3361 * Execute the next command for a target. If the command returns an
3362 * error, the node's made field is set to ERROR and creation stops.
3363 * The node from which the command came is also given.
3366 * 0 if the command succeeded, 1 if an error occurred.
3369 * The node's 'made' field may be set to ERROR.
3371 *-----------------------------------------------------------------------
3374 Compat_RunCommand(char *cmd, GNode *gn)
3377 char *cmdStart; /* Start of expanded command */
3378 Boolean silent; /* Don't print command */
3379 Boolean doit; /* Execute even in -n */
3380 Boolean errCheck; /* Check errors */
3381 int reason; /* Reason for child's death */
3382 int status; /* Description of child's death */
3383 LstNode *cmdNode; /* Node where current cmd is located */
3384 char **av; /* Argument vector for thing to exec */
3387 silent = gn->type & OP_SILENT;
3388 errCheck = !(gn->type & OP_IGNORE);
3391 cmdNode = Lst_Member(&gn->commands, cmd);
3392 cmdStart = Buf_Peel(Var_Subst(cmd, gn, FALSE));
3394 if (*cmdStart == '\0') {
3396 Error("%s expands to empty string", cmd);
3401 Lst_Replace(cmdNode, cmdStart);
3403 if ((gn->type & OP_SAVE_CMDS) && (gn != ENDNode)) {
3404 Lst_AtEnd(&ENDNode->commands, cmdStart);
3406 } else if (strcmp(cmdStart, "...") == 0) {
3407 gn->type |= OP_SAVE_CMDS;
3411 while (*cmd == '@' || *cmd == '-' || *cmd == '+') {
3415 silent = DEBUG(LOUD) ? FALSE : TRUE;
3429 while (isspace((unsigned char)*cmd))
3433 * Print the command before echoing if we're not supposed to be quiet
3434 * for this one. We also print the command if -n given, but not if '+'.
3436 if (!silent || (noExecute && !doit)) {
3437 printf("%s\n", cmd);
3442 * If we're not supposed to execute any commands, this is as far as
3445 if (!doit && noExecute) {
3449 if (strpbrk(cmd, "#=|^(){};&<>*?[]:$`\\\n")) {
3451 * We found a "meta" character and need to pass the command
3458 const char *sh_builtin[] = {
3459 "alias", "cd", "eval", "exec",
3460 "exit", "read", "set", "ulimit",
3461 "unalias", "umask", "unset", "wait",
3466 * Break the command into words to form an argument
3467 * vector we can execute.
3469 brk_string(&aa, cmd, TRUE);
3472 for (p = sh_builtin; *p != 0; p++) {
3473 if (strcmp(av[0], *p) == 0) {
3475 * This command must be passed by the shell
3476 * for other reasons.. or.. possibly not at
3485 ps.in = STDIN_FILENO;
3486 ps.out = STDOUT_FILENO;
3487 ps.err = STDERR_FILENO;
3489 ps.merge_errors = 0;
3495 * We give the shell the -e flag as well as -c if it's
3496 * supposed to exit when it hits an error.
3498 ps.argv = emalloc(4 * sizeof(char *));
3499 ps.argv[0] = strdup(shellPath);
3500 ps.argv[1] = strdup(errCheck ? "-ec" : "-c");
3501 ps.argv[2] = strdup(cmd);
3508 ps.errCheck = errCheck;
3511 * Fork and execute the single command. If the fork fails, we abort.
3512 * Warning since we are doing vfork() instead of fork(),
3513 * do not allocate memory in the child process!
3515 if ((ps.child_pid = vfork()) == -1) {
3516 Fatal("Could not fork");
3518 } else if (ps.child_pid == 0) {
3536 * we need to print out the command associated with this
3537 * Gnode in Targ_PrintCmd from Targ_PrintGraph when debugging
3538 * at level g2, in main(), Fatal() and DieHorribly(),
3539 * therefore do not free it when debugging.
3541 if (!DEBUG(GRAPH2)) {
3546 * The child is off and running. Now all we can do is wait...
3548 reason = ProcWait(&ps);
3551 CompatInterrupt(interrupted);
3554 * Decode and report the reason child exited, then
3555 * indicate how we handled it.
3557 if (WIFEXITED(reason)) {
3558 status = WEXITSTATUS(reason);
3562 printf("*** Error code %d", status);
3564 } else if (WIFSTOPPED(reason)) {
3565 status = WSTOPSIG(reason);
3567 status = WTERMSIG(reason);
3568 printf("*** Signal %d", status);
3579 printf(" (continuing)\n");
3584 * Continue executing
3585 * commands for this target.
3586 * If we return 0, this will
3589 printf(" (ignored)\n");
3596 *-----------------------------------------------------------------------
3598 * Make a target, given the parent, to abort if necessary.
3601 * If an error is detected and not being ignored, the process exits.
3603 *-----------------------------------------------------------------------
3606 CompatMake(GNode *gn, GNode *pgn)
3610 if (gn->type & OP_USE) {
3611 Make_HandleUse(gn, pgn);
3613 } else if (gn->made == UNMADE) {
3615 * First mark ourselves to be made, then apply whatever
3616 * transformations the suffix module thinks are necessary.
3617 * Once that's done, we can descend and make all our children.
3618 * If any of them has an error but the -k flag was given, our
3619 * 'make' field will be set FALSE again. This is our signal to
3620 * not attempt to do anything but abort our parent as well.
3623 gn->made = BEINGMADE;
3625 LST_FOREACH(ln, &gn->children)
3626 CompatMake(Lst_Datum(ln), gn);
3633 if (Lst_Member(&gn->iParents, pgn) != NULL) {
3634 Var_Set(IMPSRC, Var_Value(TARGET, gn), pgn);
3638 * All the children were made ok. Now cmtime contains the
3639 * modification time of the newest child, we need to find out
3640 * if we exist and when we were modified last. The criteria for
3641 * datedness are defined by the Make_OODate function.
3643 DEBUGF(MAKE, ("Examining %s...", gn->name));
3644 if (!Make_OODate(gn)) {
3645 gn->made = UPTODATE;
3646 DEBUGF(MAKE, ("up-to-date.\n"));
3649 DEBUGF(MAKE, ("out-of-date.\n"));
3653 * If the user is just seeing if something is out-of-date,
3654 * exit now to tell him/her "yes".
3661 * We need to be re-made. We also have to make sure we've got
3662 * a $? variable. To be nice, we also define the $> variable
3663 * using Make_DoAllVar().
3668 * Alter our type to tell if errors should be ignored or things
3669 * should not be printed so Compat_RunCommand knows what to do.
3671 if (Targ_Ignore(gn)) {
3672 gn->type |= OP_IGNORE;
3674 if (Targ_Silent(gn)) {
3675 gn->type |= OP_SILENT;
3678 if (Job_CheckCommands(gn, Fatal)) {
3680 * Our commands are ok, but we still have to worry
3681 * about the -t flag...
3685 LST_FOREACH(ln, &gn->commands) {
3686 if (Compat_RunCommand(Lst_Datum(ln),
3692 Job_Touch(gn, gn->type & OP_SILENT);
3698 if (gn->made != ERROR) {
3700 * If the node was made successfully, mark it so, update
3701 * its modification time and timestamp all its parents.
3702 * Note that for .ZEROTIME targets, the timestamping
3703 * isn't done. This is to keep its state from affecting
3704 * that of its parent.
3709 * We can't re-stat the thing, but we can at least take
3710 * care of rules where a target depends on a source that
3711 * actually creates the target, but only if it has
3719 * mv y.tab.o parse.o
3720 * cmp -s y.tab.h parse.h || mv y.tab.h parse.h
3722 * In this case, if the definitions produced by yacc
3723 * haven't changed from before, parse.h won't have been
3724 * updated and gn->mtime will reflect the current
3725 * modification time for parse.h. This is something of a
3726 * kludge, I admit, but it's a useful one..
3728 * XXX: People like to use a rule like
3732 * To force things that depend on FRC to be made, so we
3733 * have to check for gn->children being empty as well...
3735 if (!Lst_IsEmpty(&gn->commands) ||
3736 Lst_IsEmpty(&gn->children)) {
3741 * This is what Make does and it's actually a good
3742 * thing, as it allows rules like
3744 * cmp -s y.tab.h parse.h || cp y.tab.h parse.h
3746 * to function as intended. Unfortunately, thanks to
3747 * the stateless nature of NFS (and the speed of this
3748 * program), there are times when the modification time
3749 * of a file created on a remote machine will not be
3750 * modified before the stat() implied by the Dir_MTime
3751 * occurs, thus leading us to believe that the file
3752 * is unchanged, wreaking havoc with files that depend
3755 * I have decided it is better to make too much than to
3756 * make too little, so this stuff is commented out
3757 * unless you're sure it's ok.
3760 if (noExecute || Dir_MTime(gn) == 0) {
3763 if (gn->cmtime > gn->mtime)
3764 gn->mtime = gn->cmtime;
3765 DEBUGF(MAKE, ("update time: %s\n",
3766 Targ_FmtTime(gn->mtime)));
3768 if (!(gn->type & OP_EXEC)) {
3769 pgn->childMade = TRUE;
3770 Make_TimeStamp(pgn, gn);
3773 } else if (keepgoing) {
3777 printf("\n\nStop in %s.\n", Var_Value(".CURDIR", gn));
3780 } else if (gn->made == ERROR) {
3782 * Already had an error when making this beastie. Tell the
3787 if (Lst_Member(&gn->iParents, pgn) != NULL) {
3788 Var_Set(IMPSRC, Var_Value(TARGET, gn), pgn);
3792 Error("Graph cycles through %s\n", gn->name);
3797 if ((gn->type & OP_EXEC) == 0) {
3798 pgn->childMade = TRUE;
3799 Make_TimeStamp(pgn, gn);
3803 if ((gn->type & OP_EXEC) == 0) {
3804 Make_TimeStamp(pgn, gn);
3816 *-----------------------------------------------------------------------
3818 * Start making again, given a list of target nodes.
3826 *-----------------------------------------------------------------------
3829 Compat_Run(Lst *targs)
3831 GNode *gn = NULL; /* Current root target */
3832 int error_cnt; /* Number of targets not remade due to errors */
3835 Shell_Init(); /* Set up shell. */
3837 if (signal(SIGINT, SIG_IGN) != SIG_IGN) {
3838 signal(SIGINT, CompatCatchSig);
3840 if (signal(SIGTERM, SIG_IGN) != SIG_IGN) {
3841 signal(SIGTERM, CompatCatchSig);
3843 if (signal(SIGHUP, SIG_IGN) != SIG_IGN) {
3844 signal(SIGHUP, CompatCatchSig);
3846 if (signal(SIGQUIT, SIG_IGN) != SIG_IGN) {
3847 signal(SIGQUIT, CompatCatchSig);
3850 ENDNode = Targ_FindNode(".END", TARG_CREATE);
3852 * If the user has defined a .BEGIN target, execute the commands
3856 gn = Targ_FindNode(".BEGIN", TARG_NOCREATE);
3858 LST_FOREACH(ln, &gn->commands) {
3859 if (Compat_RunCommand(Lst_Datum(ln), gn))
3862 if (gn->made == ERROR) {
3863 printf("\n\nStop.\n");
3870 * For each entry in the list of targets to create, call CompatMake on
3871 * it to create the thing. CompatMake will leave the 'made' field of gn
3872 * in one of several states:
3873 * UPTODATE gn was already up-to-date
3874 * MADE gn was recreated successfully
3875 * ERROR An error occurred while gn was being created
3876 * ABORTED gn was not remade because one of its inferiors
3877 * could not be made due to errors.
3880 while (!Lst_IsEmpty(targs)) {
3881 gn = Lst_DeQueue(targs);
3884 if (gn->made == UPTODATE) {
3885 printf("`%s' is up to date.\n", gn->name);
3886 } else if (gn->made == ABORTED) {
3887 printf("`%s' not remade because of errors.\n",
3894 * If the user has defined a .END target, run its commands.
3896 if (error_cnt == 0) {
3897 LST_FOREACH(ln, &ENDNode->commands) {
3898 if (Compat_RunCommand(Lst_Datum(ln), gn))
lentferj's projects / dragonfly.git / blob