/*
* Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
* All rights reserved.
*
* This code is derived from software contributed to Berkeley by
* Adam de Boor.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* Copyright (c) 1988, 1989 by Adam de Boor
* Copyright (c) 1989 by Berkeley Softworks
* All rights reserved.
*
* This code is derived from software contributed to Berkeley by
* Adam de Boor.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by the University of
* California, Berkeley and its contributors.
* 4. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* Create child processes and collect their output.
*
* Interface:
* Job_Init Initialize this module and make the .BEGIN target.
*
* Job_End Clean up any memory used.
*
* Job_Make Start making the given target.
*
* Job_CatchChildren
* Handle the termination of any children.
*
* Job_CatchOutput
* Print any output the child processes have produced.
*
* Job_ParseShell Given a special dependency line with target '.SHELL',
* define the shell that is used for the creation
* commands in jobs mode.
*
* Job_Finish Make the .END target. Must only be called when the
* job table is empty.
*
* Job_AbortAll Kill all currently running jobs, in an emergency.
*
* Job_CheckCommands
* Add fallback commands to a target, if necessary.
*
* Job_Touch Update a target without really updating it.
*
* Job_Wait Wait for all currently-running jobs to finish.
*/
/*
* A Job manages the shell commands that are run to create a single target.
* Each job is run in a separate subprocess by a shell. Several jobs can run
* in parallel.
*
* The shell commands for the target are written to a temporary file,
* then the shell is run with the temporary file as stdin, and the output
* of that shell is captured via a pipe.
*
* When a job is finished, Make_Update updates all parents of the node
* that was just remade, marking them as ready to be made next if all
* other dependencies are finished as well.
*/
struct Job {
/* The process ID of the shell running the commands */
int pid;
/* The target the child is making */
GNode *node;
/*
* If one of the shell commands is "...", all following commands are
* delayed until the .END node is made. This list node points to the
* first of these commands, if any.
*/
StringListNode *tailCmds;
/* This is where the shell commands go. */
FILE *cmdFILE;
int exit_status; /* from wait4() in signal handler */
enum JobStatus status;
bool suspended;
/* Ignore non-zero exits */
bool ignerr;
/* Output the command before or instead of running it. */
bool echo;
/* Target is a special one. */
bool special;
int inPipe; /* Pipe for reading output from job */
int outPipe; /* Pipe for writing control commands */
struct pollfd *inPollfd; /* pollfd associated with inPipe */
#define JOB_BUFSIZE 1024
/* Buffer for storing the output of the job, line by line. */
char outBuf[JOB_BUFSIZE + 1];
size_t outBufLen;
#ifdef USE_META
struct BuildMon bm;
#endif
};
/*
* A shell defines how the commands are run. All commands for a target are
* written into a single file, which is then given to the shell to execute
* the commands from it. The commands are written to the file using a few
* templates for echo control and error control.
*
* The name of the shell is the basename for the predefined shells, such as
* "sh", "csh", "bash". For custom shells, it is the full pathname, and its
* basename is used to select the type of shell; the longest match wins.
* So /usr/pkg/bin/bash has type sh, /usr/local/bin/tcsh has type csh.
*
* The echoing of command lines is controlled using hasEchoCtl, echoOff,
* echoOn, noPrint and noPrintLen. When echoOff is executed by the shell, it
* still outputs something, but this something is not interesting, therefore
* it is filtered out using noPrint and noPrintLen.
*
* The error checking for individual commands is controlled using hasErrCtl,
* errOn, errOff and runChkTmpl.
*
* In case a shell doesn't have error control, echoTmpl is a printf template
* for echoing the command, should echoing be on; runIgnTmpl is another
* printf template for executing the command while ignoring the return
* status. Finally runChkTmpl is a printf template for running the command and
* causing the shell to exit on error. If any of these strings are empty when
* hasErrCtl is false, the command will be executed anyway as is, and if it
* causes an error, so be it. Any templates set up to echo the command will
* escape any '$ ` \ "' characters in the command string to avoid unwanted
* shell code injection, the escaped command is safe to use in double quotes.
*
* The command-line flags "echo" and "exit" also control the behavior. The
* "echo" flag causes the shell to start echoing commands right away. The
* "exit" flag causes the shell to exit when an error is detected in one of
* the commands.
*/
typedef struct Shell {
/*
* The name of the shell. For Bourne and C shells, this is used only
* to find the shell description when used as the single source of a
* .SHELL target. For user-defined shells, this is the full path of
* the shell.
*/
const char *name;
bool hasEchoCtl; /* whether both echoOff and echoOn are there */
const char *echoOff; /* command to turn echoing off */
const char *echoOn; /* command to turn echoing back on */
const char *noPrint; /* text to skip when printing output from the
* shell. This is usually the same as echoOff */
size_t noPrintLen; /* length of noPrint command */
bool hasErrCtl; /* whether error checking can be controlled
* for individual commands */
const char *errOn; /* command to turn on error checking */
const char *errOff; /* command to turn off error checking */
const char *echoTmpl; /* template to echo a command */
const char *runIgnTmpl; /* template to run a command without error
* checking */
const char *runChkTmpl; /* template to run a command with error
* checking */
/*
* A string literal that results in a newline character when it
* occurs outside of any 'quote' or "quote" characters.
*/
const char *newline;
char commentChar; /* character used by shell for comment lines */
const char *echoFlag; /* shell flag to echo commands */
const char *errFlag; /* shell flag to exit on error */
} Shell;
typedef struct CommandFlags {
/* Whether to echo the command before or instead of running it. */
bool echo;
/* Run the command even in -n or -N mode. */
bool always;
/*
* true if we turned error checking off before writing the command to
* the commands file and need to turn it back on
*/
bool ignerr;
} CommandFlags;
/*
* Write shell commands to a file.
*
* TODO: keep track of whether commands are echoed.
* TODO: keep track of whether error checking is active.
*/
typedef struct ShellWriter {
FILE *f;
/* we've sent 'set -x' */
bool xtraced;
} ShellWriter;
/* error handling variables */
static int job_errors = 0; /* number of errors reported */
static enum { /* Why is the make aborting? */
ABORT_NONE,
ABORT_ERROR, /* Aborted because of an error */
ABORT_INTERRUPT, /* Aborted because it was interrupted */
ABORT_WAIT /* Waiting for jobs to finish */
} aborting = ABORT_NONE;
#define JOB_TOKENS "+EI+" /* Token to requeue for each abort state */
/* Tracks the number of tokens currently "out" to build jobs. */
int jobTokensRunning = 0;
/*
* Descriptions for various shells.
*
* The build environment may set DEFSHELL_INDEX to one of
* DEFSHELL_INDEX_SH, DEFSHELL_INDEX_KSH, or DEFSHELL_INDEX_CSH, to
* select one of the predefined shells as the default shell.
*
* Alternatively, the build environment may set DEFSHELL_CUSTOM to the
* name or the full path of a sh-compatible shell, which will be used as
* the default shell.
*
* ".SHELL" lines in Makefiles can choose the default shell from the
* set defined here, or add additional shells.
*/
static Shell shells[] = {
#ifdef DEFSHELL_CUSTOM
/*
* An sh-compatible shell with a non-standard name.
*
* Keep this in sync with the "sh" description below, but avoid
* non-portable features that might not be supplied by all
* sh-compatible shells.
*/
{
DEFSHELL_CUSTOM, /* .name */
false, /* .hasEchoCtl */
"", /* .echoOff */
"", /* .echoOn */
"", /* .noPrint */
0, /* .noPrintLen */
false, /* .hasErrCtl */
"", /* .errOn */
"", /* .errOff */
"echo \"%s\"\n", /* .echoTmpl */
"%s\n", /* .runIgnTmpl */
"{ %s \n} || exit $?\n", /* .runChkTmpl */
"'\n'", /* .newline */
'#', /* .commentChar */
"", /* .echoFlag */
"", /* .errFlag */
},
#endif /* DEFSHELL_CUSTOM */
/*
* SH description. Echo control is also possible and, under
* sun UNIX anyway, one can even control error checking.
*/
{
"sh", /* .name */
false, /* .hasEchoCtl */
"", /* .echoOff */
"", /* .echoOn */
"", /* .noPrint */
0, /* .noPrintLen */
false, /* .hasErrCtl */
"", /* .errOn */
"", /* .errOff */
"echo \"%s\"\n", /* .echoTmpl */
"%s\n", /* .runIgnTmpl */
"{ %s \n} || exit $?\n", /* .runChkTmpl */
"'\n'", /* .newline */
'#', /* .commentChar*/
#if defined(MAKE_NATIVE) && defined(__NetBSD__)
/* XXX: -q is not really echoFlag, it's more like noEchoInSysFlag. */
"q", /* .echoFlag */
#else
"", /* .echoFlag */
#endif
"", /* .errFlag */
},
/*
* KSH description.
*/
{
"ksh", /* .name */
true, /* .hasEchoCtl */
"set +v", /* .echoOff */
"set -v", /* .echoOn */
"set +v", /* .noPrint */
6, /* .noPrintLen */
false, /* .hasErrCtl */
"", /* .errOn */
"", /* .errOff */
"echo \"%s\"\n", /* .echoTmpl */
"%s\n", /* .runIgnTmpl */
"{ %s \n} || exit $?\n", /* .runChkTmpl */
"'\n'", /* .newline */
'#', /* .commentChar */
"v", /* .echoFlag */
"", /* .errFlag */
},
/*
* CSH description. The csh can do echo control by playing
* with the setting of the 'echo' shell variable. Sadly,
* however, it is unable to do error control nicely.
*/
{
"csh", /* .name */
true, /* .hasEchoCtl */
"unset verbose", /* .echoOff */
"set verbose", /* .echoOn */
"unset verbose", /* .noPrint */
13, /* .noPrintLen */
false, /* .hasErrCtl */
"", /* .errOn */
"", /* .errOff */
"echo \"%s\"\n", /* .echoTmpl */
"csh -c \"%s || exit 0\"\n", /* .runIgnTmpl */
"", /* .runChkTmpl */
"'\\\n'", /* .newline */
'#', /* .commentChar */
"v", /* .echoFlag */
"e", /* .errFlag */
}
};
/*
* This is the shell to which we pass all commands in the Makefile.
* It is set by the Job_ParseShell function.
*/
static Shell *shell = &shells[DEFSHELL_INDEX];
char *shellPath; /* full pathname of executable image */
const char *shellName = NULL; /* last component of shellPath */
char *shellErrFlag = NULL;
static char *shell_freeIt = NULL; /* Allocated memory for custom .SHELL */
static Job *job_table; /* The structures that describe them */
static Job *job_table_end; /* job_table + maxJobs */
static bool wantToken;
static bool lurking_children = false;
static bool make_suspended = false; /* Whether we've seen a SIGTSTP (etc) */
/*
* Set of descriptors of pipes connected to
* the output channels of children
*/
static struct pollfd *fds = NULL;
static Job **jobByFdIndex = NULL;
static nfds_t fdsLen = 0;
static void watchfd(Job *);
static void clearfd(Job *);
static char *targPrefix = NULL; /* To identify a job change in the output. */
/* Lock the jobs table and the jobs therein. */
static void
JobsTable_Lock(sigset_t *omaskp)
{
if (sigprocmask(SIG_BLOCK, &caught_signals, omaskp) != 0)
Punt("JobsTable_Lock: %s", strerror(errno));
}
/* Unlock the jobs table and the jobs therein. */
static void
JobsTable_Unlock(sigset_t *omaskp)
{
(void)sigprocmask(SIG_SETMASK, omaskp, NULL);
}
if (fcntl(job->inPipe, F_SETFD, FD_CLOEXEC) == -1)
Punt("SetCloseOnExec: %s", strerror(errno));
if (fcntl(job->outPipe, F_SETFD, FD_CLOEXEC) == -1)
Punt("SetCloseOnExec: %s", strerror(errno));
/*
* We mark the input side of the pipe non-blocking; we poll(2) the
* pipe when we're waiting for a job token, but we might lose the
* race for the token when a new one becomes available, so the read
* from the pipe should not block.
*/
SetNonblocking(job->inPipe);
}
/* Pass the signal to each running job. */
static void
JobCondPassSig(int signo)
{
Job *job;
DEBUG1(JOB, "JobCondPassSig: signal %d\n", signo);
for (job = job_table; job < job_table_end; job++) {
if (job->status != JOB_ST_RUNNING)
continue;
DEBUG2(JOB, "JobCondPassSig passing signal %d to pid %d\n",
signo, job->pid);
KILLPG(job->pid, signo);
}
}
/*
* Pass a signal on to all jobs, then resend to ourselves.
* We die by the same signal.
*/
MAKE_ATTR_DEAD static void
JobPassSig_int(int signo)
{
/* Run .INTERRUPT target then exit */
JobInterrupt(true, signo);
}
/*
* Pass a signal on to all jobs, then resend to ourselves.
* We die by the same signal.
*/
MAKE_ATTR_DEAD static void
JobPassSig_term(int signo)
{
/* Dont run .INTERRUPT target then exit */
JobInterrupt(false, signo);
}
/* Pass the signal onto every job */
JobCondPassSig(signo);
/*
* Send ourselves the signal now we've given the message to everyone
* else. Note we block everything else possible while we're getting
* the signal. This ensures that all our jobs get continued when we
* wake up before we take any other signal.
*/
sigfillset(&nmask);
sigdelset(&nmask, signo);
(void)sigprocmask(SIG_SETMASK, &nmask, &omask);
DEBUG1(JOB, "JobPassSig_suspend passing signal %d to self\n", signo);
(void)kill(getpid(), signo);
/*
* We've been continued.
*
* A whole host of signals is going to happen!
* SIGCHLD for any processes that actually suspended themselves.
* SIGCHLD for any processes that exited while we were asleep.
* The SIGCONT that actually caused us to wake up.
*
* Since we defer passing the SIGCONT on to our children until
* the main processing loop, we can be sure that all the SIGCHLD
* events will have happened by then - and that the waitpid() will
* collect the child 'suspended' events.
* For correct sequencing we just need to ensure we process the
* waitpid() before passing on the SIGCONT.
*
* In any case nothing else is needed here.
*/
/* Restore handler and signal mask */
act.sa_handler = JobPassSig_suspend;
(void)sigaction(signo, &act, NULL);
(void)sigprocmask(SIG_SETMASK, &omask, NULL);
}
for (job = job_table; job < job_table_end; job++) {
if (job->status == status && job->pid == pid)
return job;
}
if (DEBUG(JOB) && isJobs)
DumpJobs("no pid");
return NULL;
}
/* Parse leading '@', '-' and '+', which control the exact execution mode. */
static void
ParseCommandFlags(char **pp, CommandFlags *out_cmdFlags)
{
char *p = *pp;
out_cmdFlags->echo = true;
out_cmdFlags->ignerr = false;
out_cmdFlags->always = false;
for (;;) {
if (*p == '@')
out_cmdFlags->echo = DEBUG(LOUD);
else if (*p == '-')
out_cmdFlags->ignerr = true;
else if (*p == '+')
out_cmdFlags->always = true;
else if (!ch_isspace(*p))
/* Ignore whitespace for compatibility with GNU make */
break;
p++;
}
*pp = p;
}
/* Escape a string for a double-quoted string literal in sh, csh and ksh. */
static char *
EscapeShellDblQuot(const char *cmd)
{
size_t i, j;
/* Worst that could happen is every char needs escaping. */
char *esc = bmake_malloc(strlen(cmd) * 2 + 1);
for (i = 0, j = 0; cmd[i] != '\0'; i++, j++) {
if (cmd[i] == '$' || cmd[i] == '`' || cmd[i] == '\\' ||
cmd[i] == '"')
esc[j++] = '\\';
esc[j] = cmd[i];
}
esc[j] = '\0';
static void
ShellWriter_ErrOff(ShellWriter *wr, bool echo)
{
if (echo)
ShellWriter_EchoOff(wr);
ShellWriter_WriteLine(wr, shell->errOff);
if (echo)
ShellWriter_EchoOn(wr);
}
static void
ShellWriter_ErrOn(ShellWriter *wr, bool echo)
{
if (echo)
ShellWriter_EchoOff(wr);
ShellWriter_WriteLine(wr, shell->errOn);
if (echo)
ShellWriter_EchoOn(wr);
}
/*
* The shell has no built-in error control, so emulate error control by
* enclosing each shell command in a template like "{ %s \n } || exit $?"
* (configurable per shell).
*/
static void
JobWriteSpecialsEchoCtl(Job *job, ShellWriter *wr, CommandFlags *inout_cmdFlags,
const char *escCmd, const char **inout_cmdTemplate)
{
/* XXX: Why is the whole job modified at this point? */
job->ignerr = true;
if (job->echo && inout_cmdFlags->echo) {
ShellWriter_EchoOff(wr);
ShellWriter_EchoCmd(wr, escCmd);
/*
* Leave echoing off so the user doesn't see the commands
* for toggling the error checking.
*/
inout_cmdFlags->echo = false;
}
*inout_cmdTemplate = shell->runIgnTmpl;
/*
* The template runIgnTmpl already takes care of ignoring errors,
* so pretend error checking is still on.
* XXX: What effects does this have, and why is it necessary?
*/
inout_cmdFlags->ignerr = false;
}
/*
* Write a shell command to the job's commands file, to be run later.
*
* If the command starts with '@' and neither the -s nor the -n flag was
* given to make, stick a shell-specific echoOff command in the script.
*
* If the command starts with '-' and the shell has no error control (none
* of the predefined shells has that), ignore errors for the rest of the job.
*
* XXX: Why ignore errors for the entire job? This is documented in the
* manual page, but without giving a rationale.
*
* If the command is just "...", attach all further commands of this job to
* the .END node instead, see Job_Finish.
*/
static void
JobWriteCommand(Job *job, ShellWriter *wr, StringListNode *ln, const char *ucmd)
{
bool run;
CommandFlags cmdFlags;
/* Template for writing a command to the shell file */
const char *cmdTemplate;
char *xcmd; /* The expanded command */
char *xcmdStart;
char *escCmd; /* xcmd escaped to be used in double quotes */
/* The '+' command flag overrides the -n or -N options. */
if (cmdFlags.always && !run) {
/*
* We're not actually executing anything...
* but this one needs to be - use compat mode just for it.
*/
(void)Compat_RunCommand(ucmd, job->node, ln);
free(xcmdStart);
return;
}
/*
* If the shell doesn't have error control, the alternate echoing
* will be done (to avoid showing additional error checking code)
* and this needs some characters escaped.
*/
escCmd = shell->hasErrCtl ? NULL : EscapeShellDblQuot(xcmd);
if (!cmdFlags.echo) {
if (job->echo && run && shell->hasEchoCtl)
ShellWriter_EchoOff(wr);
else if (shell->hasErrCtl)
cmdFlags.echo = true;
}
/*
* If errors are being checked and the shell doesn't have
* error control but does supply an runChkTmpl template, then
* set up commands to run through it.
*/
if (!shell->hasErrCtl && shell->runChkTmpl != NULL &&
shell->runChkTmpl[0] != '\0') {
if (job->echo && cmdFlags.echo) {
ShellWriter_EchoOff(wr);
ShellWriter_EchoCmd(wr, escCmd);
cmdFlags.echo = false;
}
/*
* If it's a comment line or blank, avoid the possible
* syntax error generated by "{\n} || exit $?".
*/
cmdTemplate = escCmd[0] == shell->commentChar ||
escCmd[0] == '\0'
? shell->runIgnTmpl
: shell->runChkTmpl;
cmdFlags.ignerr = false;
}
}
if (DEBUG(SHELL) && strcmp(shellName, "sh") == 0)
ShellWriter_TraceOn(wr);
if (cmdFlags.ignerr)
ShellWriter_ErrOn(wr, cmdFlags.echo && job->echo);
if (!cmdFlags.echo)
ShellWriter_EchoOn(wr);
}
/*
* Write all commands to the shell file that is later executed.
*
* The special command "..." stops writing and saves the remaining commands
* to be executed later, when the target '.END' is made.
*
* Return whether at least one command was written to the shell file.
*/
static bool
JobWriteCommands(Job *job)
{
StringListNode *ln;
bool seen = false;
ShellWriter wr;
JobWriteCommand(job, &wr, ln, ln->datum);
seen = true;
}
return seen;
}
/*
* Save the delayed commands (those after '...'), to be executed later in
* the '.END' node, when everything else is done.
*/
static void
JobSaveCommands(Job *job)
{
StringListNode *ln;
for (ln = job->tailCmds; ln != NULL; ln = ln->next) {
const char *cmd = ln->datum;
char *expanded_cmd;
/*
* XXX: This Var_Subst is only intended to expand the dynamic
* variables such as .TARGET, .IMPSRC. It is not intended to
* expand the other variables as well; see deptgt-end.mk.
*/
expanded_cmd = Var_SubstInTarget(cmd, job->node);
/* TODO: handle errors */
Lst_Append(&Targ_GetEndNode()->commands, expanded_cmd);
Parse_RegisterCommand(expanded_cmd);
}
}
/* Close both input and output pipes when a job is finished. */
static void
JobClosePipes(Job *job)
{
clearfd(job);
(void)close(job->outPipe);
job->outPipe = -1;
static void
JobFinishDoneSignaled(Job *job, int status)
{
SwitchOutputTo(job->node);
DebugFailedJob(job);
(void)printf("*** [%s] Signal %d\n", job->node->name, WTERMSIG(status));
if (deleteOnError)
JobDeleteTarget(job->node);
}
static void
JobFinishDone(Job *job, int *inout_status)
{
if (WIFEXITED(*inout_status))
JobFinishDoneExited(job, inout_status);
else
JobFinishDoneSignaled(job, *inout_status);
(void)fflush(stdout);
}
/*
* Finish the job, add deferred commands to the .END node, mark the job as
* free, update parent nodes and start new jobs as available/necessary.
*/
static void
JobFinish(Job *job, int status)
{
bool done, return_job_token;
if ((WIFEXITED(status) &&
((WEXITSTATUS(status) != 0 && !job->ignerr))) ||
WIFSIGNALED(status)) {
/* Finished because of an error. */
JobClosePipes(job);
if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
if (fclose(job->cmdFILE) != 0)
Punt("Cannot write shell script for \"%s\": %s",
job->node->name, strerror(errno));
job->cmdFILE = NULL;
}
done = true;
} else if (WIFEXITED(status)) {
/*
* Deal with ignored errors in -B mode. We need to print a
* message telling of the ignored error as well as to run
* the next command.
*/
done = WEXITSTATUS(status) != 0;
JobClosePipes(job);
} else {
/* No need to close things down or anything. */
done = false;
}
if (done)
JobFinishDone(job, &status);
#ifdef USE_META
if (useMeta) {
int meta_status = meta_job_finish(job);
if (meta_status != 0 && status == 0)
status = meta_status;
}
#endif
fd = open(file, O_RDWR | O_CREAT, 0666);
if (fd < 0) {
(void)fprintf(stderr, "*** couldn't touch %s: %s\n",
file, strerror(errno));
(void)fflush(stderr);
return; /* XXX: What about propagating the error? */
}
/*
* Last resort: update the file's time stamps in the traditional way.
* XXX: This doesn't work for empty files, which are sometimes used
* as marker files.
*/
if (read(fd, &c, 1) == 1) {
(void)lseek(fd, 0, SEEK_SET);
while (write(fd, &c, 1) == -1 && errno == EAGAIN)
continue;
}
(void)close(fd); /* XXX: What about propagating the error? */
}
/*
* Touch the given target. Called by Job_Make when the -t flag was given.
*
* The modification date of the file is changed.
* If the file did not exist, it is created.
*/
void
Job_Touch(GNode *gn, bool echo)
{
if (gn->type &
(OP_JOIN | OP_USE | OP_USEBEFORE | OP_EXEC | OP_OPTIONAL |
OP_SPECIAL | OP_PHONY)) {
/*
* These are "virtual" targets and should not really be
* created.
*/
return;
}
if (gn->type & OP_ARCHV)
Arch_Touch(gn);
else if (gn->type & OP_LIB)
Arch_TouchLib(gn);
else
TouchRegular(gn);
}
/*
* Make sure the given node has all the commands it needs.
*
* The node will have commands from the .DEFAULT rule added to it if it
* needs them.
*
* Input:
* gn The target whose commands need verifying
* abortProc Function to abort with message
*
* Results:
* true if the commands are ok.
*/
bool
Job_CheckCommands(GNode *gn, void (*abortProc)(const char *, ...))
{
if (GNode_IsTarget(gn))
return true;
if (!Lst_IsEmpty(&gn->commands))
return true;
if ((gn->type & OP_LIB) && !Lst_IsEmpty(&gn->children))
return true;
/*
* No commands. Look for .DEFAULT rule from which we might infer
* commands.
*/
if (defaultNode != NULL && !Lst_IsEmpty(&defaultNode->commands) &&
!(gn->type & OP_SPECIAL)) {
/*
* The traditional Make only looks for a .DEFAULT if the node
* was never the target of an operator, so that's what we do
* too.
*
* The .DEFAULT node acts like a transformation rule, in that
* gn also inherits any attributes or sources attached to
* .DEFAULT itself.
*/
Make_HandleUse(defaultNode, gn);
Var_Set(gn, IMPSRC, GNode_VarTarget(gn));
return true;
}
/*
* The node wasn't the target of an operator. We have no .DEFAULT
* rule to go on and the target doesn't already exist. There's
* nothing more we can do for this branch. If the -k flag wasn't
* given, we stop in our tracks, otherwise we just don't update
* this node's parents so they never get examined.
*/
if (gn->flags.fromDepend) {
if (!Job_RunTarget(".STALE", gn->fname))
fprintf(stdout,
"%s: %s:%u: ignoring stale %s for %s\n",
progname, gn->fname, gn->lineno, makeDependfile,
gn->name);
return true;
}
if (gn->type & OP_OPTIONAL) {
(void)fprintf(stdout, "%s: don't know how to make %s (%s)\n",
progname, gn->name, "ignored");
(void)fflush(stdout);
return true;
}
if (opts.keepgoing) {
(void)fprintf(stdout, "%s: don't know how to make %s (%s)\n",
progname, gn->name, "continuing");
(void)fflush(stdout);
return false;
}
abortProc("don't know how to make %s. Stop", gn->name);
return false;
}
/*
* Execute the shell for the given job.
*
* See Job_CatchOutput for handling the output of the shell.
*/
static void
JobExec(Job *job, char **argv)
{
int cpid; /* ID of new child */
sigset_t mask;
if (DEBUG(JOB)) {
int i;
debug_printf("Running %s\n", job->node->name);
debug_printf("\tCommand:");
for (i = 0; argv[i] != NULL; i++) {
debug_printf(" %s", argv[i]);
}
debug_printf("\n");
}
/*
* Some jobs produce no output, and it's disconcerting to have
* no feedback of their running (since they produce no output, the
* banner with their name in it never appears). This is an attempt to
* provide that feedback, even if nothing follows it.
*/
if (job->echo)
SwitchOutputTo(job->node);
/* No interruptions until this job is in the jobs table. */
JobsTable_Lock(&mask);
/* Pre-emptively mark job running, pid still zero though */
job->status = JOB_ST_RUNNING;
cpid = FORK_FUNCTION();
if (cpid == -1)
Punt("fork: %s", strerror(errno));
if (cpid == 0) {
/* Child */
sigset_t tmask;
#ifdef USE_META
if (useMeta)
meta_job_child(job);
#endif
/*
* Reset all signal handlers; this is necessary because we
* also need to unblock signals before we exec(2).
*/
JobSigReset();
sigemptyset(&tmask);
JobsTable_Unlock(&tmask);
if (dup2(fileno(job->cmdFILE), STDIN_FILENO) == -1)
execDie("dup2", "job->cmdFILE");
if (fcntl(STDIN_FILENO, F_SETFD, 0) == -1)
execDie("clear close-on-exec", "stdin");
if (lseek(STDIN_FILENO, 0, SEEK_SET) == -1)
execDie("lseek to 0", "stdin");
if (job->node->type & (OP_MAKE | OP_SUBMAKE)) {
/* Pass job token pipe to submakes. */
if (fcntl(tokenPoolJob.inPipe, F_SETFD, 0) == -1)
execDie("clear close-on-exec",
"tokenPoolJob.inPipe");
if (fcntl(tokenPoolJob.outPipe, F_SETFD, 0) == -1)
execDie("clear close-on-exec",
"tokenPoolJob.outPipe");
}
if (dup2(job->outPipe, STDOUT_FILENO) == -1)
execDie("dup2", "job->outPipe");
/*
* The output channels are marked close on exec. This bit
* was duplicated by dup2 (on some systems), so we have
* to clear it before routing the shell's error output to
* the same place as its standard output.
*/
if (fcntl(STDOUT_FILENO, F_SETFD, 0) == -1)
execDie("clear close-on-exec", "stdout");
if (dup2(STDOUT_FILENO, STDERR_FILENO) == -1)
execDie("dup2", "1, 2");
/*
* We want to switch the child into a different process
* family so we can kill it and all its descendants in
* one fell swoop, by killing its process family, but not
* commit suicide.
*/
#if defined(MAKE_NATIVE) || defined(HAVE_SETPGID)
# if defined(SYSV)
/* XXX: dsl - I'm sure this should be setpgrp()... */
(void)setsid();
# else
(void)setpgid(0, getpid());
# endif
#endif
if ((shell->errFlag != NULL && shell->errFlag[0] != '-') ||
(shell->echoFlag != NULL && shell->echoFlag[0] != '-')) {
/*
* At least one of the flags doesn't have a minus before it,
* so merge them together. Have to do this because the Bourne
* shell thinks its second argument is a file to source.
* Grrrr. Note the ten-character limitation on the combined
* arguments.
*
* TODO: Research until when the above comments were
* practically relevant.
*/
(void)snprintf(args, sizeof args, "-%s%s",
!job->ignerr && shell->errFlag != NULL
? shell->errFlag : "",
job->echo && shell->echoFlag != NULL
? shell->echoFlag : "");
if (args[1] != '\0') {
argv[argc] = args;
argc++;
}
} else {
if (!job->ignerr && shell->errFlag != NULL) {
argv[argc] = UNCONST(shell->errFlag);
argc++;
}
if (job->echo && shell->echoFlag != NULL) {
argv[argc] = UNCONST(shell->echoFlag);
argc++;
}
}
argv[argc] = NULL;
}
/*
* If the shell has an output filter (which only csh and ksh have by default),
* print the output of the child process, skipping the noPrint text of the
* shell.
*
* Return the part of the output that the calling function needs to output by
* itself.
*/
static const char *
PrintFilteredOutput(Job *job, size_t len)
{
const char *p = job->outBuf, *ep, *endp;
if (shell->noPrint == NULL || shell->noPrint[0] == '\0')
return p;
endp = p + len;
while ((ep = strstr(p, shell->noPrint)) != NULL && ep < endp) {
if (ep > p) {
if (!opts.silent)
SwitchOutputTo(job->node);
(void)fwrite(p, 1, (size_t)(ep - p), stdout);
(void)fflush(stdout);
}
p = ep + shell->noPrintLen;
if (p == endp)
break;
p++; /* skip over the (XXX: assumed) newline */
cpp_skip_whitespace(&p);
}
return p;
}
/*
* Collect output from the job. Print any complete lines.
*
* In the output of the shell, the 'noPrint' lines are removed. If the
* command is not alone on the line (the character after it is not \0 or
* \n), we do print whatever follows it.
*
* If finish is true, collect all remaining output for the job.
*/
static void
CollectOutput(Job *job, bool finish)
{
const char *p;
size_t nr; /* number of bytes read */
size_t i; /* auxiliary index into outBuf */
size_t max; /* limit for i (end of current data) */
again:
nr = (size_t)read(job->inPipe, job->outBuf + job->outBufLen,
JOB_BUFSIZE - job->outBufLen);
if (nr == (size_t)-1) {
if (errno == EAGAIN)
return;
if (DEBUG(JOB))
perror("CollectOutput(piperead)");
nr = 0;
}
if (nr == 0)
finish = false; /* stop looping */
if (nr == 0 && job->outBufLen > 0) {
job->outBuf[job->outBufLen] = '\n';
nr = 1;
}
max = job->outBufLen + nr;
job->outBuf[max] = '\0';
for (i = job->outBufLen; i < max; i++)
if (job->outBuf[i] == '\0')
job->outBuf[i] = ' ';
for (i = max; i > job->outBufLen; i--)
if (job->outBuf[i - 1] == '\n')
break;
if (i == job->outBufLen) {
job->outBufLen = max;
if (max < JOB_BUFSIZE)
goto unfinished_line;
i = max;
}
p = PrintFilteredOutput(job, i);
if (*p != '\0') {
if (!opts.silent)
SwitchOutputTo(job->node);
#ifdef USE_META
if (useMeta)
meta_job_output(job, p);
#endif
(void)fwrite(p, 1, (size_t)(job->outBuf + i - p), stdout);
(void)fflush(stdout);
}
memmove(job->outBuf, job->outBuf + i, max - i);
job->outBufLen = max - i;
unfinished_line:
if (finish)
goto again;
}
static void
JobRun(GNode *target)
{
/* Don't let these special jobs overlap with other unrelated jobs. */
Compat_Make(target, target);
if (GNode_IsError(target)) {
PrintOnError(target, "\n\nStop.\n");
exit(1);
}
}
void
Job_CatchChildren(void)
{
int pid;
int status;
if (jobTokensRunning == 0)
return;
if (caught_sigchld == 0)
return;
caught_sigchld = 0;
while ((pid = waitpid((pid_t)-1, &status, WNOHANG | WUNTRACED)) > 0) {
DEBUG2(JOB,
"Process with pid %d exited/stopped with status %#x.\n",
pid, status);
JobReapChild(pid, status, true);
}
}
/*
* It is possible that wait[pid]() was called from elsewhere,
* this lets us reap jobs regardless.
*/
void
JobReapChild(pid_t pid, int status, bool isJobs)
{
Job *job;
if (jobTokensRunning == 0)
return;
job = JobFindPid(pid, JOB_ST_RUNNING, isJobs);
if (job == NULL) {
if (isJobs && !lurking_children)
Error("Child with pid %d and status %#x not in table?",
pid, status);
return;
}
if (WIFSTOPPED(status)) {
DEBUG2(JOB, "Process for target %s, pid %d stopped\n",
job->node->name, job->pid);
if (!make_suspended) {
switch (WSTOPSIG(status)) {
case SIGTSTP:
(void)printf("*** [%s] Suspended\n",
job->node->name);
break;
case SIGSTOP:
(void)printf("*** [%s] Stopped\n",
job->node->name);
break;
default:
(void)printf("*** [%s] Stopped -- signal %d\n",
job->node->name, WSTOPSIG(status));
}
job->suspended = true;
}
(void)fflush(stdout);
return;
}
for (i = npseudojobs * nfds_per_job(); i < fdsLen; i++) {
if (fds[i].revents == 0)
continue;
job = jobByFdIndex[i];
if (job->status == JOB_ST_RUNNING)
CollectOutput(job, false);
#if defined(USE_FILEMON) && !defined(USE_FILEMON_DEV)
/*
* With meta mode, we may have activity on the job's filemon
* descriptor too, which at the moment is any pollfd other
* than job->inPollfd.
*/
if (useMeta && job->inPollfd != &fds[i]) {
if (meta_job_event(job) <= 0)
fds[i].events = 0; /* never mind */
}
#endif
if (--nready == 0)
return;
}
}
/*
* There is a non-zero chance that we already have children,
* e.g. after 'make -f- <<EOF'.
* Since their termination causes a 'Child (pid) not in table'
* message, Collect the status of any that are already dead, and
* suppress the error message if there are any undead ones.
*/
for (;;) {
int rval, status;
rval = waitpid((pid_t)-1, &status, WNOHANG);
if (rval > 0)
continue;
if (rval == 0)
lurking_children = true;
break;
}
/* Handle the signals specified by POSIX. */
AddSig(SIGINT, JobPassSig_int);
AddSig(SIGHUP, JobPassSig_term);
AddSig(SIGTERM, JobPassSig_term);
AddSig(SIGQUIT, JobPassSig_term);
/*
* These signals need to be passed to the jobs, as each job has its
* own process group and thus the terminal driver doesn't forward the
* signals itself.
*/
AddSig(SIGTSTP, JobPassSig_suspend);
AddSig(SIGTTOU, JobPassSig_suspend);
AddSig(SIGTTIN, JobPassSig_suspend);
AddSig(SIGWINCH, JobCondPassSig);
AddSig(SIGCONT, HandleSIGCONT);
(void)Job_RunTarget(".BEGIN", NULL);
/* Create the .END node, see Targ_GetEndNode in Compat_MakeAll. */
(void)Targ_GetEndNode();
}
for (sh = shells; sh < shellsEnd; sh++) {
if (strcmp(name, sh->name) == 0)
return sh;
}
return NULL;
}
/*
* Parse a shell specification and set up 'shell', shellPath and
* shellName appropriately.
*
* Input:
* line The shell spec
*
* Results:
* Returns false if the specification was incorrect.
* If successful, 'shell' is usable, shellPath is the full path of the
* shell described by 'shell', and shellName is the final component of
* shellPath.
*
* Notes:
* A shell specification has the form ".SHELL: keyword=value...". Double
* quotes can be used to enclose blanks in words. A backslash escapes
* anything (most notably a double-quote and a space) and
* provides the usual escape sequences from C. There should be no
* unnecessary spaces in the word. The keywords are:
* name Name of shell.
* path Location of shell.
* quiet Command to turn off echoing.
* echo Command to turn echoing on
* filter The output from the shell command that turns off
* echoing, to be filtered from the final output.
* echoFlag Flag to turn echoing on at the start.
* errFlag Flag to turn error checking on at the start.
* hasErrCtl True if the shell has error checking control.
* newline String literal to represent a newline character.
* check If hasErrCtl is true: The command to turn on error
* checking. If hasErrCtl is false: The template for a
* shell command that echoes a command for which error
* checking is off.
* ignore If hasErrCtl is true: The command to turn off error
* checking. If hasErrCtl is false: The template for a
* shell command that executes a command so as to ignore
* any errors it returns.
*/
bool
Job_ParseShell(char *line)
{
Words wordsList;
char **words;
char **argv;
size_t argc;
char *path;
Shell newShell;
bool fullSpec = false;
Shell *sh;
/* XXX: don't use line as an iterator variable */
pp_skip_whitespace(&line);
if (!shell->hasErrCtl) {
if (shell->echoTmpl == NULL)
shell->echoTmpl = "";
if (shell->runIgnTmpl == NULL)
shell->runIgnTmpl = "%s\n";
}
/*
* Do not free up the words themselves, since they may be in use
* by the shell specification.
*/
free(words);
return true;
}
/*
* After receiving an interrupt signal, terminate all child processes and if
* necessary make the .INTERRUPT target.
*/
static void
JobInterrupt(bool runINTERRUPT, int signo)
{
Job *job;
GNode *interrupt;
sigset_t mask;
aborting = ABORT_INTERRUPT;
JobsTable_Lock(&mask);
for (job = job_table; job < job_table_end; job++) {
if (job->status == JOB_ST_RUNNING && job->pid != 0) {
DEBUG2(JOB,
"JobInterrupt passing signal %d to child %d.\n",
signo, job->pid);
KILLPG(job->pid, signo);
}
}
for (job = job_table; job < job_table_end; job++) {
if (job->status == JOB_ST_RUNNING && job->pid != 0) {
int status;
(void)waitpid(job->pid, &status, 0);
JobDeleteTarget(job->node);
}
}
/* Make the .END target, returning the number of job-related errors. */
int
Job_Finish(void)
{
GNode *endNode = Targ_GetEndNode();
if (!Lst_IsEmpty(&endNode->commands) ||
!Lst_IsEmpty(&endNode->children)) {
if (job_errors != 0)
Error("Errors reported so .END ignored");
else
JobRun(endNode);
}
return job_errors;
}
/* Waits for all running jobs to finish. */
void
Job_Wait(void)
{
aborting = ABORT_WAIT; /* Prevent other jobs from starting. */
while (jobTokensRunning != 0)
Job_CatchOutput();
aborting = ABORT_NONE;
}
/*
* Abort all currently running jobs without handling output or anything.
* This function is to be called only in the event of a major error.
* Most definitely NOT to be called from JobInterrupt.
*/
void
Job_AbortAll(void)
{
Job *job;
int status;
aborting = ABORT_ERROR;
if (jobTokensRunning != 0) {
for (job = job_table; job < job_table_end; job++) {
if (job->status != JOB_ST_RUNNING)
continue;
KILLPG(job->pid, SIGINT);
KILLPG(job->pid, SIGKILL);
}
}
while (waitpid((pid_t)-1, &status, WNOHANG) > 0)
continue;
}
static void
TokenPool_Write(char tok)
{
if (write(tokenPoolJob.outPipe, &tok, 1) != 1)
Punt("Cannot write \"%c\" to the token pool: %s",
tok, strerror(errno));
}
/*
* Put a token (back) into the job token pool.
* This allows a make process to start a build job.
*/
static void
TokenPool_Add(void)
{
char tok = JOB_TOKENS[aborting], tok1;
/* If we are depositing an error token, flush everything else. */
while (tok != '+' && read(tokenPoolJob.inPipe, &tok1, 1) == 1)
continue;
/*
* Preload the job pipe with one token per job, save the one
* "extra" token for the primary job.
*/
SetNonblocking(tokenPoolJob.outPipe);
for (i = 1; i < maxJobTokens; i++)
TokenPool_Add();
}
void
TokenPool_Init(int maxJobTokens, int tokenPoolReader, int tokenPoolWriter)
{
if (tokenPoolReader >= 0 && tokenPoolWriter >= 0)
TokenPool_InitClient(tokenPoolReader, tokenPoolWriter);
else
TokenPool_InitServer(maxJobTokens);
}
/* Return a taken token to the pool. */
void
TokenPool_Return(void)
{
jobTokensRunning--;
if (jobTokensRunning < 0)
Punt("token botch");
if (jobTokensRunning != 0 || JOB_TOKENS[aborting] != '+')
TokenPool_Add();
}
/*
* Attempt to take a token from the pool.
*
* If the pool is empty, set wantToken so that we wake up when a token is
* released.
*
* Returns true if a token was taken, and false if the pool is currently
* empty.
*/
bool
TokenPool_Take(void)
{
char tok, tok1;
ssize_t count;
if (aborting != ABORT_NONE || jobTokensRunning >= opts.maxJobs)
return false;
count = read(tokenPoolJob.inPipe, &tok, 1);
if (count == 0)
Fatal("eof on job pipe");
if (count < 0 && jobTokensRunning != 0) {
if (errno != EAGAIN)
Fatal("job pipe read: %s", strerror(errno));
DEBUG1(JOB, "TokenPool_Take: pid %d blocked for token\n",
getpid());
wantToken = true;
return false;
}
if (count == 1 && tok != '+') {
/* make being aborted - remove any other job tokens */
DEBUG2(JOB, "TokenPool_Take: pid %d aborted by token %c\n",
getpid(), tok);
while (read(tokenPoolJob.inPipe, &tok1, 1) == 1)
continue;
/* And put the stopper back */
TokenPool_Write(tok);
if (shouldDieQuietly(NULL, 1)) {
Job_Wait();
exit(6);
}
Fatal("A failure has been detected "
"in another branch of the parallel make");
}
if (count == 1 && jobTokensRunning == 0)
/* We didn't want the token really */
TokenPool_Write(tok);
jobTokensRunning++;
DEBUG1(JOB, "TokenPool_Take: pid %d took a token\n", getpid());
return true;
}
/* Make the named target if found, exit if the target fails. */
bool
Job_RunTarget(const char *target, const char *fname)
{
GNode *gn = Targ_FindNode(target);
if (gn == NULL)
return false;
if (fname != NULL)
Var_Set(gn, ALLSRC, fname);
JobRun(gn);
return true;
}
#ifdef USE_SELECT
int
emul_poll(struct pollfd *fd, int nfd, int timeout)
{
fd_set rfds, wfds;
int i, maxfd, nselect, npoll;
struct timeval tv, *tvp;
long usecs;
FD_ZERO(&rfds);
FD_ZERO(&wfds);
maxfd = -1;
for (i = 0; i < nfd; i++) {
fd[i].revents = 0;
if (fd[i].events & POLLIN)
FD_SET(fd[i].fd, &rfds);
if (fd[i].events & POLLOUT)
FD_SET(fd[i].fd, &wfds);
if (fd[i].fd > maxfd)
maxfd = fd[i].fd;
}
if (maxfd >= FD_SETSIZE) {
Punt("Ran out of fd_set slots; "
"recompile with a larger FD_SETSIZE.");
}