File: [local] / src / usr.bin / make / job.c (download)
Revision 1.95, Tue Oct 9 09:35:43 2007 UTC (16 years, 7 months ago) by espie
Branch: MAIN
Changes since 1.94: +12 -11 lines
rename jobs to more descriptive runningJobs (and easier to grep)
|
/* $OpenPackages$ */
/* $OpenBSD: job.c,v 1.95 2007/10/09 09:35:43 espie Exp $ */
/* $NetBSD: job.c,v 1.16 1996/11/06 17:59:08 christos Exp $ */
/*
* Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
* 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. 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.
*/
/*-
* job.c --
* handle the creation etc. of our child processes.
*
* Interface:
* Job_Make Start the creation of the given target.
*
* Job_CatchChildren Check for and handle the termination of any
* children. This must be called reasonably
* frequently to keep the whole make going at
* a decent clip, since job table entries aren't
* removed until their process is caught this way.
*
* Job_CatchOutput Print any output our children have produced.
* Should also be called fairly frequently to
* keep the user informed of what's going on.
* If no output is waiting, it will block for
* a time given by the SEL_* constants, below,
* or until output is ready.
*
* Job_Init Called to initialize this module. in addition,
* any commands attached to the .BEGIN target
* are executed before this function returns.
* Hence, the makefile must have been parsed
* before this function is called.
*
* Job_End Cleanup any memory used.
*
* Job_Full Return true if the job table is filled.
*
* Job_Empty Return true if the job table is completely
* empty.
*
* Job_Finish Perform any final processing which needs doing.
* This includes the execution of any commands
* which have been/were attached to the .END
* target. It should only be called when the
* job table is empty.
*
* Job_AbortAll Abort all currently running jobs. It doesn't
* handle output or do anything for the jobs,
* just kills them. It should only be called in
* an emergency, as it were.
*
* Job_Wait Wait for all currently-running jobs to finish.
*/
#include <sys/types.h>
#include <sys/wait.h>
#include <ctype.h>
#include <errno.h>
#include <fcntl.h>
#include <signal.h>
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include "config.h"
#include "defines.h"
#include "job.h"
#include "engine.h"
#include "pathnames.h"
#include "var.h"
#include "targ.h"
#include "error.h"
#include "lst.h"
#include "extern.h"
#include "gnode.h"
#include "memory.h"
#include "make.h"
/*
* The SEL_ constants determine the maximum amount of time spent in select
* before coming out to see if a child has finished. SEL_SEC is the number of
* seconds and SEL_USEC is the number of micro-seconds
*/
#define SEL_SEC 0
#define SEL_USEC 500000
/*-
* Job Table definitions.
*
* Each job has several things associated with it:
* 1) The process id of the child shell
* 2) The graph node describing the target being made by this job
* 3) An FILE* for writing out the commands. This is only
* used before the job is actually started.
* 4) Things used for handling the shell's output.
* the output is being caught via a pipe and
* the descriptors of our pipe, an array in which output is line
* buffered and the current position in that buffer are all
* maintained for each job.
* 5) A word of flags which determine how the module handles errors,
* echoing, etc. for the job
*
* The job "table" is kept as a linked Lst in 'jobs', with the number of
* active jobs maintained in the 'nJobs' variable. At no time will this
* exceed the value of 'maxJobs', initialized by the Job_Init function.
*
* When a job is finished, the Make_Update function is called on each of the
* parents of the node which was just remade. This takes care of the upward
* traversal of the dependency graph.
*/
#define JOB_BUFSIZE 1024
typedef struct Job_ {
pid_t pid; /* The child's process ID */
GNode *node; /* The target the child is making */
LstNode tailCmds; /* The node of the first command to be
* saved when the job has been run */
FILE *cmdFILE; /* When creating the shell script, this is
* where the commands go */
int rmtID; /* ID returned from Rmt module */
short flags; /* Flags to control treatment of job */
#define JOB_IGNERR 0x001 /* Ignore non-zero exits */
#define JOB_SILENT 0x002 /* no output */
#define JOB_SPECIAL 0x004 /* Target is a special one. */
#define JOB_IGNDOTS 0x008 /* Ignore "..." lines when processing
* commands */
#define JOB_RESTART 0x080 /* Job needs to be completely restarted */
#define JOB_RESUME 0x100 /* Job needs to be resumed b/c it stopped,
* for some reason */
#define JOB_CONTINUING 0x200 /* We are in the process of resuming this job.
* Used to avoid infinite recursion between
* JobFinish and JobRestart */
int inPipe; /* Input side of pipe associated
* with job's output channel */
int outPipe; /* Output side of pipe associated with
* job's output channel */
char outBuf[JOB_BUFSIZE + 1];
/* Buffer for storing the output of the
* job, line by line */
int curPos; /* Current position in op_outBuf */
} Job;
/*
* error handling variables
*/
static int errors = 0; /* number of errors reported */
static int aborting = 0; /* why is the make aborting? */
#define ABORT_ERROR 1 /* Because of an error */
#define ABORT_INTERRUPT 2 /* Because it was interrupted */
#define ABORT_WAIT 3 /* Waiting for jobs to finish */
static int numCommands; /* The number of commands actually printed
* for a target. Should this number be
* 0, no shell will be executed. */
/*
* Return values from JobStart.
*/
#define JOB_RUNNING 0 /* Job is running */
#define JOB_ERROR 1 /* Error in starting the job */
#define JOB_FINISHED 2 /* The job is already finished */
#define JOB_STOPPED 3 /* The job is stopped */
#define SHELL_ECHO_OFF "set -"
#define SHELL_ECHO_ON "set -v"
#define SHELL_ERROR_ON "set -e"
#define SHELL_ERROR_OFF "set +e"
#define SHELL_ECHO_FLAG "v"
#define SHELL_ERROR_FLAG "e"
static const char *shellPath = _PATH_BSHELL;
static const char *shellName = "sh";
static int maxJobs; /* The most children we can run at once */
static int nJobs; /* The number of children currently running */
static LIST runningJobs; /* The structures that describe them */
static bool jobFull; /* Flag to tell when the job table is full. It
* is set true when nJobs equals maxJobs */
static fd_set *outputsp; /* Set of descriptors of pipes connected to
* the output channels of children */
static int outputsn;
static GNode *lastNode; /* The node for which output was most recently
* produced. */
static char *targFmt; /* Format string to use to head output from a
* job when it's not the most-recent job heard
* from */
# define TARG_FMT "--- %s ---\n" /* Default format */
# define MESSAGE(fp, gn) \
(void)fprintf(fp, targFmt, gn->name);
/*
* When JobStart attempts to run a job but isn't allowed to,
* the job is placed on the stoppedJobs queue to be run
* when the next job finishes.
*/
static LIST stoppedJobs; /* Lst of Job structures describing
* jobs that were stopped due to concurrency
* limits or migration home */
#if defined(USE_PGRP) && defined(SYSV)
# define KILL(pid, sig) killpg(-(pid), (sig))
#else
# if defined(USE_PGRP)
# define KILL(pid, sig) killpg((pid), (sig))
# else
# define KILL(pid, sig) kill((pid), (sig))
# endif
#endif
/*
* Grmpf... There is no way to set bits of the wait structure
* anymore with the stupid W*() macros. I liked the union wait
* stuff much more. So, we devise our own macros... This is
* really ugly, use dramamine sparingly. You have been warned.
*/
#define W_SETMASKED(st, val, fun) \
{ \
int sh = (int) ~0; \
int mask = fun(sh); \
\
for (sh = 0; ((mask >> sh) & 1) == 0; sh++) \
continue; \
*(st) = (*(st) & ~mask) | ((val) << sh); \
}
#define W_SETTERMSIG(st, val) W_SETMASKED(st, val, WTERMSIG)
#define W_SETEXITSTATUS(st, val) W_SETMASKED(st, val, WEXITSTATUS)
static void pass_signal_to_job(void *, void *);
static void SigHandler(int);
static void handle_all_signals(void);
static void handle_signal(int);
static int JobCmpPid(void *, void *);
static int JobPrintCommand(LstNode, void *);
static void JobSaveCommand(void *, void *);
static void JobClose(Job *);
static void JobFinish(Job *, int *);
static void JobExec(Job *, char **);
static void JobMakeArgv(Job *, char **);
static void JobRestart(Job *);
static int JobStart(GNode *, int);
static char *JobOutput(Job *, char *, char *, int);
static void JobDoOutput(Job *, bool);
static void JobInterrupt(int, int);
static void JobRestartJobs(void);
static void DBPRINTF(Job *, const char *, ...);
static void debug_printf(const char *, ...);
static FILE *new_command_file(void);
static void setup_signal(int);
static void setup_all_signals(void);
static volatile sig_atomic_t got_signal;
static volatile sig_atomic_t got_SIGINT, got_SIGHUP, got_SIGQUIT,
got_SIGTERM, got_SIGTSTP, got_SIGTTOU, got_SIGTTIN, got_SIGWINCH;
#define TMPPAT "/tmp/makeXXXXXXXXXX"
static FILE *
new_command_file()
{
int fd;
FILE *f;
char tmp[] = TMPPAT;
fd = mkstemp(tmp);
if (fd == -1)
return NULL;
f = fdopen(fd, "w");
if (f == NULL)
close(fd);
eunlink(tmp);
return f;
}
static void
SigHandler(int sig)
{
switch(sig) {
case SIGINT:
got_SIGINT++;
got_signal = 1;
break;
case SIGHUP:
got_SIGHUP++;
got_signal = 1;
break;
case SIGQUIT:
got_SIGQUIT++;
got_signal = 1;
break;
case SIGTERM:
got_SIGTERM++;
got_signal = 1;
break;
#ifdef USE_PGRP
case SIGTSTP:
got_SIGTSTP++;
got_signal = 1;
break;
case SIGTTOU:
got_SIGTTOU++;
got_signal = 1;
break;
case SIGTTIN:
got_SIGTTIN++;
got_signal = 1;
break;
case SIGWINCH:
got_SIGWINCH++;
got_signal = 1;
break;
#endif
}
}
static void
handle_all_signals()
{
if (got_signal)
got_signal = 0;
else
return;
if (got_SIGINT) {
got_SIGINT=0;
handle_signal(SIGINT);
}
if (got_SIGHUP) {
got_SIGHUP=0;
handle_signal(SIGHUP);
}
if (got_SIGQUIT) {
got_SIGQUIT=0;
handle_signal(SIGQUIT);
}
if (got_SIGTERM) {
got_SIGTERM=0;
handle_signal(SIGTERM);
}
if (got_SIGTSTP) {
got_SIGTSTP=0;
handle_signal(SIGTSTP);
}
if (got_SIGTTOU) {
got_SIGTTOU=0;
handle_signal(SIGTTOU);
}
if (got_SIGTTIN) {
got_SIGTTIN=0;
handle_signal(SIGTTIN);
}
if (got_SIGWINCH) {
got_SIGWINCH=0;
handle_signal(SIGWINCH);
}
}
/*-
*-----------------------------------------------------------------------
* JobCondPassSig --
* Pass a signal to a job if USE_PGRP
* is defined.
*
* Side Effects:
* None, except the job may bite it.
*-----------------------------------------------------------------------
*/
static void
pass_signal_to_job(void *jobp, /* Job to biff */
void *signop) /* Signal to send it */
{
Job *job = (Job *)jobp;
int signo = *(int *)signop;
if (DEBUG(JOB)) {
(void)fprintf(stdout,
"pass_signal_to_job passing signal %d to child %ld.\n",
signo, (long)job->pid);
(void)fflush(stdout);
}
KILL(job->pid, signo);
}
/*-
*-----------------------------------------------------------------------
* handle_signal --
* Pass a signal to all local jobs if USE_PGRP is defined,
* then die ourselves.
*
* Side Effects:
* We die by the same signal.
*-----------------------------------------------------------------------
*/
static void
handle_signal(int signo) /* The signal number we've received */
{
sigset_t nmask, omask;
struct sigaction act;
if (DEBUG(JOB)) {
(void)fprintf(stdout, "handle_signal(%d) called.\n", signo);
(void)fflush(stdout);
}
Lst_ForEach(&runningJobs, pass_signal_to_job, &signo);
/*
* Deal with proper cleanup based on the signal received. We only run
* the .INTERRUPT target if the signal was in fact an interrupt. The
* other three termination signals are more of a "get out *now*"
* command.
*/
if (signo == SIGINT) {
JobInterrupt(true, signo);
} else if (signo == SIGHUP || signo == SIGTERM || signo == SIGQUIT) {
JobInterrupt(false, signo);
}
/*
* Leave gracefully if SIGQUIT, rather than core dumping.
*/
if (signo == SIGQUIT) {
Finish(0);
}
/*
* 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.
*/
sigemptyset(&nmask);
sigaddset(&nmask, signo);
sigprocmask(SIG_SETMASK, &nmask, &omask);
memset(&act, 0, sizeof act);
act.sa_handler = SIG_DFL;
sigemptyset(&act.sa_mask);
act.sa_flags = 0;
sigaction(signo, &act, NULL);
if (DEBUG(JOB)) {
(void)fprintf(stdout,
"handle_signal passing signal to self, mask = %x.\n",
~0 & ~(1 << (signo-1)));
(void)fflush(stdout);
}
(void)signal(signo, SIG_DFL);
(void)KILL(getpid(), signo);
signo = SIGCONT;
Lst_ForEach(&runningJobs, pass_signal_to_job, &signo);
(void)sigprocmask(SIG_SETMASK, &omask, NULL);
sigprocmask(SIG_SETMASK, &omask, NULL);
act.sa_handler = SigHandler;
sigaction(signo, &act, NULL);
}
/*-
*-----------------------------------------------------------------------
* JobCmpPid --
* Compare the pid of the job with the given pid and return 0 if they
* are equal. This function is called from Job_CatchChildren via
* Lst_Find to find the job descriptor of the finished job.
*
* Results:
* 0 if the pid's match
*-----------------------------------------------------------------------
*/
static int
JobCmpPid(void *job, /* job to examine */
void *pid) /* process id desired */
{
return *(pid_t *)pid - ((Job *)job)->pid;
}
static void
DBPRINTF(Job *job, const char *fmt, ...)
{
va_list va;
va_start(va, fmt);
if (DEBUG(JOB)) {
(void)vfprintf(stdout, fmt, va);
fflush(stdout);
}
vfprintf(job->cmdFILE, fmt, va);
va_end(va);
}
static void
debug_printf(const char *fmt, ...)
{
if (DEBUG(JOB)) {
va_list va;
va_start(va, fmt);
(void)vfprintf(stdout, fmt, va);
fflush(stdout);
va_end(va);
}
}
/*-
*-----------------------------------------------------------------------
* JobPrintCommand --
* Put out another command for the given job. If the command starts
* with an @ or a - we process it specially. In the former case,
* so long as the -s and -n flags weren't given to make, we stick
* a shell-specific echoOff command in the script. In the latter,
* we ignore errors for the entire job, unless the shell has error
* control.
* If the command is just "..." we take all future commands for this
* job to be commands to be executed once the entire graph has been
* made and return non-zero to signal that the end of the commands
* was reached. These commands are later attached to the end_node
* node and executed by Job_End when all things are done.
* This function is called from JobStart via Lst_Find
*
* Results:
* Always 1, unless the command was "..."
*
* Side Effects:
* If the command begins with a '-' and the shell has no error control,
* the JOB_IGNERR flag is set in the job descriptor.
* If the command is "..." and we're not ignoring such things,
* tailCmds is set to the successor node of the cmd.
* numCommands is incremented if the command is actually printed.
*-----------------------------------------------------------------------
*/
static int
JobPrintCommand(LstNode cmdNode, /* command string to print */
void *jobp) /* job for which to print it */
{
bool noSpecials; /* true if we shouldn't worry about
* inserting special commands into
* the input stream. */
bool shutUp = false; /* true if we put a no echo command
* into the command file */
bool errOff = false; /* true if we turned error checking
* off before printing the command
* and need to turn it back on */
char *cmdTemplate; /* Template to use when printing the
* command */
char *cmdStart; /* Start of expanded command */
char *cmd = (char *)Lst_Datum(cmdNode);
Job *job = (Job *)jobp;
noSpecials = (noExecute && !(job->node->type & OP_MAKE));
if (strcmp(cmd, "...") == 0) {
job->node->type |= OP_SAVE_CMDS;
if ((job->flags & JOB_IGNDOTS) == 0) {
job->tailCmds = Lst_Succ(cmdNode);
return 0;
}
return 1;
}
numCommands++;
/* For debugging, we replace each command with the result of expanding
* the variables in the command. */
cmdStart = cmd = Var_Subst(cmd, &job->node->context, false);
Lst_Replace(cmdNode, cmdStart);
cmdTemplate = "%s\n";
/*
* Check for leading @' and -'s to control echoing and error checking.
*/
for (;; cmd++) {
if (*cmd == '@')
shutUp = DEBUG(LOUD) ? false : true;
else if (*cmd == '-')
errOff = true;
else if (*cmd != '+')
break;
}
while (isspace(*cmd))
cmd++;
if (shutUp) {
if (!(job->flags & JOB_SILENT) && !noSpecials) {
DBPRINTF(job, "%s\n", SHELL_ECHO_OFF);
} else {
shutUp = false;
}
}
if (errOff) {
if ( !(job->flags & JOB_IGNERR) && !noSpecials) {
/*
* we don't want the error-control commands showing
* up either, so we turn off echoing while executing
* them. We could put another field in the shell
* structure to tell JobDoOutput to look for this
* string too, but why make it any more complex than
* it already is?
*/
if (!(job->flags & JOB_SILENT) && !shutUp) {
DBPRINTF(job, "%s; %s; %s\n", SHELL_ECHO_OFF,
SHELL_ERROR_OFF, SHELL_ECHO_ON);
} else {
DBPRINTF(job, "%s\n", SHELL_ERROR_OFF);
}
} else {
errOff = false;
}
}
DBPRINTF(job, cmdTemplate, cmd);
if (errOff) {
/*
* If echoing is already off, there's no point in issuing the
* echoOff command. Otherwise we issue it and pretend it was on
* for the whole command...
*/
if (!shutUp && !(job->flags & JOB_SILENT)) {
DBPRINTF(job, "%s\n", SHELL_ECHO_OFF);
shutUp = true;
}
DBPRINTF(job, "%s\n", SHELL_ERROR_ON);
}
if (shutUp) {
DBPRINTF(job, "%s\n", SHELL_ECHO_ON);
}
return 1;
}
/*-
*-----------------------------------------------------------------------
* JobSaveCommand --
* Save a command to be executed when everything else is done.
* Callback function for JobFinish...
*
* Side Effects:
* The command is tacked onto the end of end_node's commands list.
*-----------------------------------------------------------------------
*/
static void
JobSaveCommand(void *cmd, void *gn)
{
GNode *g = (GNode *)gn;
char *result;
result = Var_Subst((char *)cmd, &g->context, false);
Lst_AtEnd(&end_node->commands, result);
}
/*-
*-----------------------------------------------------------------------
* JobClose --
* Called to close both input and output pipes when a job is finished.
*
* Side Effects:
* The file descriptors associated with the job are closed.
*-----------------------------------------------------------------------
*/
static void
JobClose(Job *job)
{
FD_CLR(job->inPipe, outputsp);
if (job->outPipe != job->inPipe) {
(void)close(job->outPipe);
}
JobDoOutput(job, true);
(void)close(job->inPipe);
}
/*-
*-----------------------------------------------------------------------
* JobFinish --
* Do final processing for the given job including updating
* parents and starting new jobs as available/necessary. Note
* that we pay no attention to the JOB_IGNERR flag here.
* This is because when we're called because of a noexecute flag
* or something, jstat.w_status is 0 and when called from
* Job_CatchChildren, the status is zeroed if it s/b ignored.
*
* Side Effects:
* Some nodes may be put on the toBeMade queue.
* Final commands for the job are placed on end_node.
*
* If we got an error and are aborting (aborting == ABORT_ERROR) and
* the job list is now empty, we are done for the day.
* If we recognized an error (errors !=0), we set the aborting flag
* to ABORT_ERROR so no more jobs will be started.
*-----------------------------------------------------------------------
*/
/*ARGSUSED*/
static void
JobFinish(Job *job, /* job to finish */
int *status) /* sub-why job went away */
{
bool done;
if ((WIFEXITED(*status) &&
WEXITSTATUS(*status) != 0 && !(job->flags & JOB_IGNERR)) ||
(WIFSIGNALED(*status) && WTERMSIG(*status) != SIGCONT)) {
/*
* If it exited non-zero and either we're doing things our
* way or we're not ignoring errors, the job is finished.
* Similarly, if the shell died because of a signal
* the job is also finished. In these
* cases, finish out the job's output before printing the exit
* status...
*/
JobClose(job);
if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
(void)fclose(job->cmdFILE);
}
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 setting
* status.w_status to 0 so the next command gets run. To do
* this, we set done to be true if in -B mode and the job
* exited non-zero.
*/
done = WEXITSTATUS(*status) != 0;
/*
* Old comment said: "Note we don't want to close down any of
* the streams until we know we're at the end." But we do.
* Otherwise when are we going to print the rest of the stuff?
*/
JobClose(job);
} else {
/*
* No need to close things down or anything.
*/
done = false;
}
if (done ||
WIFSTOPPED(*status) ||
(WIFSIGNALED(*status) && WTERMSIG(*status) == SIGCONT) ||
DEBUG(JOB)) {
FILE *out;
out = stdout;
if (WIFEXITED(*status)) {
debug_printf("Process %ld exited.\n", (long)job->pid);
if (WEXITSTATUS(*status) != 0) {
if (job->node != lastNode) {
MESSAGE(out, job->node);
lastNode = job->node;
}
(void)fprintf(out, "*** Error code %d%s\n",
WEXITSTATUS(*status),
(job->flags & JOB_IGNERR) ? "(ignored)" :
"");
if (job->flags & JOB_IGNERR) {
*status = 0;
}
} else if (DEBUG(JOB)) {
if (job->node != lastNode) {
MESSAGE(out, job->node);
lastNode = job->node;
}
(void)fprintf(out,
"*** Completed successfully\n");
}
} else if (WIFSTOPPED(*status)) {
debug_printf("Process %ld stopped.\n", (long)job->pid);
if (job->node != lastNode) {
MESSAGE(out, job->node);
lastNode = job->node;
}
(void)fprintf(out, "*** Stopped -- signal %d\n",
WSTOPSIG(*status));
job->flags |= JOB_RESUME;
Lst_AtEnd(&stoppedJobs, job);
(void)fflush(out);
return;
} else if (WTERMSIG(*status) == SIGCONT) {
/*
* If the beastie has continued, shift the Job from the
* stopped list to the running one (or re-stop it if
* concurrency is exceeded) and go and get another
* child.
*/
if (job->flags & (JOB_RESUME|JOB_RESTART)) {
if (job->node != lastNode) {
MESSAGE(out, job->node);
lastNode = job->node;
}
(void)fprintf(out, "*** Continued\n");
}
if (!(job->flags & JOB_CONTINUING)) {
debug_printf(
"Warning: "
"process %ld was not continuing.\n",
(long)job->pid);
#if 0
/*
* We don't really want to restart a job from
* scratch just because it continued,
* especially not without killing the
* continuing process! That's why this is
* ifdef'ed out. FD - 9/17/90
*/
JobRestart(job);
#endif
}
job->flags &= ~JOB_CONTINUING;
Lst_AtEnd(&runningJobs, job);
nJobs++;
debug_printf("Process %ld is continuing locally.\n",
(long)job->pid);
if (nJobs == maxJobs) {
jobFull = true;
debug_printf("Job queue is full.\n");
}
(void)fflush(out);
return;
} else {
if (job->node != lastNode) {
MESSAGE(out, job->node);
lastNode = job->node;
}
(void)fprintf(out, "*** Signal %d\n",
WTERMSIG(*status));
}
(void)fflush(out);
}
done = true;
if (done &&
aborting != ABORT_ERROR &&
aborting != ABORT_INTERRUPT &&
*status == 0) {
/* As long as we aren't aborting and the job didn't return a
* non-zero status that we shouldn't ignore, we call
* Make_Update to update the parents. In addition, any saved
* commands for the node are placed on the .END target. */
Lst_ForEachFrom(job->tailCmds, JobSaveCommand, job->node);
job->node->made = MADE;
Make_Update(job->node);
free(job);
} else if (*status != 0) {
errors++;
free(job);
}
JobRestartJobs();
/*
* Set aborting if any error.
*/
if (errors && !keepgoing && aborting != ABORT_INTERRUPT) {
/*
* If we found any errors in this batch of children and the -k
* flag wasn't given, we set the aborting flag so no more jobs
* get started.
*/
aborting = ABORT_ERROR;
}
if (aborting == ABORT_ERROR && Job_Empty()) {
/*
* If we are aborting and the job table is now empty, we finish.
*/
Finish(errors);
}
}
/*-
*-----------------------------------------------------------------------
* JobExec --
* Execute the shell for the given job. Called from JobStart and
* JobRestart.
*
* Side Effects:
* A shell is executed, outputs is altered and the Job structure added
* to the job table.
*-----------------------------------------------------------------------
*/
static void
JobExec(Job *job, char **argv)
{
pid_t cpid; /* ID of new child */
static int signals_caught = 0;
if (DEBUG(JOB)) {
int i;
(void)fprintf(stdout, "Running %s\n", job->node->name);
(void)fprintf(stdout, "\tCommand: ");
for (i = 0; argv[i] != NULL; i++) {
(void)fprintf(stdout, "%s ", argv[i]);
}
(void)fprintf(stdout, "\n");
(void)fflush(stdout);
}
/*
* 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 (lastNode != job->node && !(job->flags & JOB_SILENT)) {
MESSAGE(stdout, job->node);
lastNode = job->node;
}
if (!signals_caught) {
signals_caught = 1;
setup_all_signals();
}
if ((cpid = fork()) == -1) {
Punt("Cannot fork");
} else if (cpid == 0) {
/*
* Must duplicate the input stream down to the child's input
* and reset it to the beginning (again). Since the stream was
* marked close-on-exec, we must clear that bit in the new
* input.
*/
if (dup2(fileno(job->cmdFILE), 0) == -1)
Punt("Cannot dup2(job->cmdFile): %s", strerror(errno));
(void)fcntl(0, F_SETFD, 0);
(void)lseek(0, 0, SEEK_SET);
/*
* Set up the child's output to be routed through the pipe
* we've created for it.
*/
if (dup2(job->outPipe, 1) == -1)
Punt("Cannot dup2(job->outPipe): %s", strerror(errno));
/*
* The output channels are marked close on exec. This bit was
* duplicated by the 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.
*/
(void)fcntl(1, F_SETFD, 0);
if (dup2(1, 2) == -1)
Punt("Cannot dup2(stdout): %s", strerror(errno));
#ifdef USE_PGRP
/*
* 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(SYSV)
(void)setsid();
# else
(void)setpgid(0, getpid());
# endif
#endif /* USE_PGRP */
(void)execv(shellPath, argv);
(void)write(STDERR_FILENO, "Could not execute shell\n",
sizeof("Could not execute shell"));
_exit(1);
} else {
job->pid = cpid;
/* we set the current position in the buffer to the beginning
* and mark another stream to watch in the outputs mask
*/
job->curPos = 0;
if (outputsp == NULL || job->inPipe > outputsn) {
int fdn, ofdn;
fd_set *tmp;
fdn = howmany(job->inPipe+1, NFDBITS);
ofdn = outputsn ? howmany(outputsn+1, NFDBITS) : 0;
if (fdn != ofdn) {
tmp = recalloc(outputsp, fdn, sizeof(fd_mask));
if (tmp == NULL)
return;
outputsp = tmp;
}
outputsn = job->inPipe;
}
FD_SET(job->inPipe, outputsp);
/*
* XXX: Used to not happen if REMOTE. Why?
*/
if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
(void)fclose(job->cmdFILE);
job->cmdFILE = NULL;
}
}
/*
* Now the job is actually running, add it to the table.
*/
nJobs++;
Lst_AtEnd(&runningJobs, job);
if (nJobs == maxJobs) {
jobFull = true;
}
}
/*-
*-----------------------------------------------------------------------
* JobMakeArgv --
* Create the argv needed to execute the shell for a given job.
*-----------------------------------------------------------------------
*/
static void
JobMakeArgv(Job *job, char **argv)
{
int argc;
static char args[10]; /* For merged arguments */
argv[0] = (char *)shellName;
argc = 1;
(void)snprintf(args, sizeof(args), "-%s%s",
(job->flags & JOB_IGNERR) ? "" : SHELL_ERROR_FLAG,
(job->flags & JOB_SILENT) ? "" : SHELL_ECHO_FLAG);
if (args[1]) {
argv[argc] = args;
argc++;
}
argv[argc] = NULL;
}
/*-
*-----------------------------------------------------------------------
* JobRestart --
* Restart a job that stopped for some reason.
*
* Side Effects:
* jobFull will be set if the job couldn't be run.
*-----------------------------------------------------------------------
*/
static void
JobRestart(Job *job)
{
if (job->flags & JOB_RESTART) {
/*
* Set up the control arguments to the shell. This is based on
* the flags set earlier for this job. If the JOB_IGNERR flag
* is clear, the 'exit' flag of the commandShell is used to
* cause it to exit upon receiving an error. If the JOB_SILENT
* flag is clear, the 'echo' flag of the commandShell is used
* to get it to start echoing as soon as it starts processing
* commands.
*/
char *argv[4];
JobMakeArgv(job, argv);
if (DEBUG(JOB)) {
(void)fprintf(stdout, "Restarting %s...",
job->node->name);
(void)fflush(stdout);
}
if (nJobs >= maxJobs && !(job->flags & JOB_SPECIAL)) {
/*
* Can't be exported and not allowed to run locally --
* put it back on the hold queue and mark the table
* full
*/
debug_printf("holding\n");
Lst_AtFront(&stoppedJobs, job);
jobFull = true;
debug_printf("Job queue is full.\n");
return;
} else {
/*
* Job may be run locally.
*/
debug_printf("running locally\n");
}
JobExec(job, argv);
} else {
/*
* The job has stopped and needs to be restarted. Why it
* stopped, we don't know...
*/
debug_printf("Resuming %s...", job->node->name);
if ((nJobs < maxJobs || ((job->flags & JOB_SPECIAL) &&
maxJobs == 0)) && nJobs != maxJobs) {
/*
* If we haven't reached the concurrency limit already
* (or maxJobs is 0), it's ok to resume the job.
*/
bool error;
int status;
error = KILL(job->pid, SIGCONT) != 0;
if (!error) {
/*
* Make sure the user knows we've continued the
* beast and actually put the thing in the job
* table.
*/
job->flags |= JOB_CONTINUING;
W_SETTERMSIG(&status, SIGCONT);
JobFinish(job, &status);
job->flags &= ~(JOB_RESUME|JOB_CONTINUING);
debug_printf("done\n");
} else {
Error("couldn't resume %s: %s",
job->node->name, strerror(errno));
status = 0;
W_SETEXITSTATUS(&status, 1);
JobFinish(job, &status);
}
} else {
/*
* Job cannot be restarted. Mark the table as full and
* place the job back on the list of stopped jobs.
*/
debug_printf("table full\n");
Lst_AtFront(&stoppedJobs, job);
jobFull = true;
debug_printf("Job queue is full.\n");
}
}
}
/*-
*-----------------------------------------------------------------------
* JobStart --
* Start a target-creation process going for the target described
* by the graph node gn.
*
* Results:
* JOB_ERROR if there was an error in the commands, JOB_FINISHED
* if there isn't actually anything left to do for the job and
* JOB_RUNNING if the job has been started.
*
* Side Effects:
* A new Job node is created and added to the list of running
* jobs. PMake is forked and a child shell created.
*-----------------------------------------------------------------------
*/
static int
JobStart(GNode *gn, /* target to create */
int flags) /* flags for the job to override normal ones.
* e.g. JOB_SPECIAL */
{
Job *job; /* new job descriptor */
char *argv[4]; /* Argument vector to shell */
bool cmdsOK; /* true if the nodes commands were all right */
bool noExec; /* Set true if we decide not to run the job */
int fd[2];
job = emalloc(sizeof(Job));
if (job == NULL) {
Punt("JobStart out of memory");
}
job->node = gn;
job->tailCmds = NULL;
/*
* Set the initial value of the flags for this job based on the global
* ones and the node's attributes... Any flags supplied by the caller
* are also added to the field.
*/
job->flags = flags;
if (Targ_Ignore(gn)) {
job->flags |= JOB_IGNERR;
}
if (Targ_Silent(gn)) {
job->flags |= JOB_SILENT;
}
/*
* Check the commands now so any attributes from .DEFAULT have a chance
* to migrate to the node
*/
cmdsOK = Job_CheckCommands(gn, Error);
/*
* If the -n flag wasn't given, we open up OUR (not the child's)
* temporary file to stuff commands in it. The thing is rd/wr so we
* don't need to reopen it to feed it to the shell. If the -n flag
* *was* given, we just set the file to be stdout. Cute, huh?
*/
if ((gn->type & OP_MAKE) || (!noExecute && !touchFlag)) {
/*
* We're serious here, but if the commands were bogus, we're
* also dead...
*/
if (!cmdsOK) {
DieHorribly();
}
job->cmdFILE = new_command_file();
if (job->cmdFILE == NULL) {
Punt("Error creating command file");
}
(void)fcntl(fileno(job->cmdFILE), F_SETFD, FD_CLOEXEC);
/*
* Send the commands to the command file, flush all its buffers
* then rewind and remove the thing.
*/
noExec = false;
/*
* We can do all the commands at once. hooray for
* sanity
*/
numCommands = 0;
Lst_ForEachNodeWhile(&gn->commands, JobPrintCommand,
job);
/*
* If we didn't print out any commands to the shell
* script, there's not much point in executing the
* shell, is there?
*/
if (numCommands == 0) {
noExec = true;
}
} else if (noExecute) {
/*
* Not executing anything -- just print all the commands to
* stdout in one fell swoop. This will still set up
* job->tailCmds correctly.
*/
if (lastNode != gn) {
MESSAGE(stdout, gn);
lastNode = gn;
}
job->cmdFILE = stdout;
/*
* Only print the commands if they're ok, but don't die if
* they're not -- just let the user know they're bad and keep
* going. It doesn't do any harm in this case and may do some
* good.
*/
if (cmdsOK) {
Lst_ForEachNodeWhile(&gn->commands, JobPrintCommand,
job);
}
/*
* Don't execute the shell, thank you.
*/
noExec = true;
} else {
/*
* Just touch the target and note that no shell should be
* executed. Set cmdFILE to stdout to make life easier. Check
* the commands, too, but don't die if they're no good -- it
* does no harm to keep working up the graph.
*/
job->cmdFILE = stdout;
Job_Touch(gn, job->flags & JOB_SILENT);
noExec = true;
}
/*
* If we're not supposed to execute a shell, don't.
*/
if (noExec) {
/*
* Unlink and close the command file if we opened one
*/
if (job->cmdFILE != stdout) {
if (job->cmdFILE != NULL)
(void)fclose(job->cmdFILE);
} else {
(void)fflush(stdout);
}
/*
* We only want to work our way up the graph if we aren't here
* because the commands for the job were no good.
*/
if (cmdsOK) {
if (aborting == 0) {
Lst_ForEachFrom(job->tailCmds, JobSaveCommand,
job->node);
Make_Update(job->node);
}
free(job);
return JOB_FINISHED;
} else {
free(job);
return JOB_ERROR;
}
} else {
(void)fflush(job->cmdFILE);
}
/*
* Set up the control arguments to the shell. This is based on the flags
* set earlier for this job.
*/
JobMakeArgv(job, argv);
/* Create the pipe by which we'll get the shell's output.
*/
if (pipe(fd) == -1)
Punt("Cannot create pipe: %s", strerror(errno));
job->inPipe = fd[0];
job->outPipe = fd[1];
(void)fcntl(job->inPipe, F_SETFD, FD_CLOEXEC);
(void)fcntl(job->outPipe, F_SETFD, FD_CLOEXEC);
if (nJobs >= maxJobs && !(job->flags & JOB_SPECIAL) &&
maxJobs != 0) {
/*
* The job can only be run locally, but we've hit the limit of
* local concurrency, so put the job on hold until some other
* job finishes. Note that the special jobs (.BEGIN, .INTERRUPT
* and .END) may be run locally even when the local limit has
* been reached (e.g. when maxJobs == 0), though they will be
* exported if at all possible. In addition, any target marked
* with .NOEXPORT will be run locally if maxJobs is 0.
*/
jobFull = true;
debug_printf("Can only run job locally.\n");
job->flags |= JOB_RESTART;
Lst_AtEnd(&stoppedJobs, job);
} else {
if (nJobs >= maxJobs) {
/*
* If we're running this job locally as a special case
* (see above), at least say the table is full.
*/
jobFull = true;
debug_printf("Local job queue is full.\n");
}
JobExec(job, argv);
}
return JOB_RUNNING;
}
static char *
JobOutput(Job *job, char *cp, char *endp, int msg)
{
char *ecp;
ecp = strstr(cp, SHELL_ECHO_OFF);
while (ecp != NULL) {
if (cp != ecp) {
*ecp = '\0';
if (msg && job->node != lastNode) {
MESSAGE(stdout, job->node);
lastNode = job->node;
}
/*
* The only way there wouldn't be a newline after
* this line is if it were the last in the buffer.
* however, since the non-printable comes after it,
* there must be a newline, so we don't print one.
*/
(void)fprintf(stdout, "%s", cp);
(void)fflush(stdout);
}
cp = ecp + strlen(SHELL_ECHO_OFF);
if (cp != endp) {
/*
* Still more to print, look again after skipping
* the whitespace following the non-printable
* command....
*/
cp++;
while (*cp == ' ' || *cp == '\t' || *cp == '\n') {
cp++;
}
ecp = strstr(cp, SHELL_ECHO_OFF);
} else {
return cp;
}
}
return cp;
}
/*-
*-----------------------------------------------------------------------
* JobDoOutput --
* This functions is called whenever there is something to read on the
* pipe. We collect more output from the given job and store it in the
* job's outBuf. If this makes up a line, we print it tagged by the job's
* identifier, as necessary.
* We also keep our figurative eye out for the
* 'noPrint' line for the shell from which the output came. If
* we recognize a line, we don't print it. If the command is not
* alone on the line (the character after it is not \0 or \n), we
* do print whatever follows it.
*
* Side Effects:
* curPos may be shifted as may the contents of outBuf.
*-----------------------------------------------------------------------
*/
static void
JobDoOutput(Job *job, /* the job whose output needs printing */
bool finish) /* true if this is the last time we'll be
* called for this job */
{
bool gotNL = false; /* true if got a newline */
bool fbuf; /* true if our buffer filled up */
int nr; /* number of bytes read */
int i; /* auxiliary index into outBuf */
int max; /* limit for i (end of current data) */
int nRead; /* (Temporary) number of bytes read */
/*
* Read as many bytes as will fit in the buffer.
*/
end_loop:
gotNL = false;
fbuf = false;
nRead = read(job->inPipe, &job->outBuf[job->curPos],
JOB_BUFSIZE - job->curPos);
if (nRead == -1) {
if (DEBUG(JOB)) {
perror("JobDoOutput(piperead)");
}
nr = 0;
} else {
nr = nRead;
}
/*
* If we hit the end-of-file (the job is dead), we must flush its
* remaining output, so pretend we read a newline if there's any
* output remaining in the buffer.
* Also clear the 'finish' flag so we stop looping.
*/
if (nr == 0 && job->curPos != 0) {
job->outBuf[job->curPos] = '\n';
nr = 1;
finish = false;
} else if (nr == 0) {
finish = false;
}
/*
* Look for the last newline in the bytes we just got. If there is
* one, break out of the loop with 'i' as its index and gotNL set
* true.
*/
max = job->curPos + nr;
for (i = job->curPos + nr - 1; i >= job->curPos; i--) {
if (job->outBuf[i] == '\n') {
gotNL = true;
break;
} else if (job->outBuf[i] == '\0') {
/*
* To be fixed: don't use printf, it stops at NUL bytes.
*/
job->outBuf[i] = ' ';
}
}
if (!gotNL) {
job->curPos += nr;
if (job->curPos == JOB_BUFSIZE) {
/*
* If we've run out of buffer space, we have no choice
* but to print the stuff. sigh.
*/
fbuf = true;
i = job->curPos;
}
}
if (gotNL || fbuf) {
/*
* Need to send the output to the screen. Null terminate it
* first, overwriting the newline character if there was one.
* So long as the line isn't one we should filter (according
* to the shell description), we print the line, preceded
* by a target banner if this target isn't the same as the
* one for which we last printed something.
* The rest of the data in the buffer are then shifted down
* to the start of the buffer and curPos is set accordingly.
*/
job->outBuf[i] = '\0';
if (i >= job->curPos) {
char *cp;
cp = JobOutput(job, job->outBuf, &job->outBuf[i],
false);
/*
* There's still more in that thar buffer. This time,
* though, we know there's no newline at the end, so we
* add one of our own free will.
*/
if (*cp != '\0') {
if (job->node != lastNode) {
MESSAGE(stdout, job->node);
lastNode = job->node;
}
(void)fprintf(stdout, "%s%s", cp,
gotNL ? "\n" : "");
(void)fflush(stdout);
}
}
if (i < max - 1) {
/* shift the remaining characters down */
(void)memcpy(job->outBuf, &job->outBuf[i + 1],
max - (i + 1));
job->curPos = max - (i + 1);
} else {
/*
* We have written everything out, so we just start over
* from the start of the buffer. No copying. No nothing.
*/
job->curPos = 0;
}
}
if (finish) {
/*
* If the finish flag is true, we must loop until we hit
* end-of-file on the pipe. This is guaranteed to happen
* eventually since the other end of the pipe is now closed
* (we closed it explicitly and the child has exited). When
* we do get an EOF, finish will be set false and we'll fall
* through and out.
*/
goto end_loop;
}
}
/*-
*-----------------------------------------------------------------------
* Job_CatchChildren --
* Handle the exit of a child. Called from Make_Make.
*
* Side Effects:
* The job descriptor is removed from the list of children.
*
* Notes:
* We do waits, blocking or not, according to the wisdom of our
* caller, until there are no more children to report. For each
* job, call JobFinish to finish things off. This will take care of
* putting jobs on the stoppedJobs queue.
*-----------------------------------------------------------------------
*/
void
Job_CatchChildren()
{
pid_t pid; /* pid of dead child */
Job *job; /* job descriptor for dead child */
LstNode jnode; /* list element for finding job */
int status; /* Exit/termination status */
/*
* Don't even bother if we know there's no one around.
*/
if (nJobs == 0) {
return;
}
while ((pid = waitpid((pid_t) -1, &status, WNOHANG|WUNTRACED)) > 0) {
handle_all_signals();
debug_printf("Process %ld exited or stopped.\n", (long)pid);
jnode = Lst_Find(&runningJobs, JobCmpPid, &pid);
if (jnode == NULL) {
if (WIFSIGNALED(status) &&
(WTERMSIG(status) == SIGCONT)) {
jnode = Lst_Find(&stoppedJobs, JobCmpPid, &pid);
if (jnode == NULL) {
Error("Resumed child (%ld) not in table", (long)pid);
continue;
}
job = (Job *)Lst_Datum(jnode);
Lst_Remove(&stoppedJobs, jnode);
} else {
Error("Child (%ld) not in table?", (long)pid);
continue;
}
} else {
job = (Job *)Lst_Datum(jnode);
Lst_Remove(&runningJobs, jnode);
nJobs--;
if (jobFull)
debug_printf("Job queue is no longer full.\n");
jobFull = false;
}
JobFinish(job, &status);
}
}
/*-
*-----------------------------------------------------------------------
* Job_CatchOutput --
* Catch the output from our children, if we're using
* pipes do so. Otherwise just block time until we get a
* signal (most likely a SIGCHLD) since there's no point in
* just spinning when there's nothing to do and the reaping
* of a child can wait for a while.
*
* Side Effects:
* Output is read from pipes if we're piping.
* -----------------------------------------------------------------------
*/
void
Job_CatchOutput(void)
{
int nfds;
struct timeval timeout;
LstNode ln;
Job *job;
int count = howmany(outputsn+1, NFDBITS) * sizeof(fd_mask);
fd_set *readfdsp = malloc(count);
(void)fflush(stdout);
if (readfdsp == NULL)
return;
memcpy(readfdsp, outputsp, count);
timeout.tv_sec = SEL_SEC;
timeout.tv_usec = SEL_USEC;
nfds = select(outputsn+1, readfdsp, NULL, NULL, &timeout);
handle_all_signals();
if (nfds > 0) {
for (ln = Lst_First(&runningJobs); nfds && ln != NULL;
ln = Lst_Adv(ln)) {
job = (Job *)Lst_Datum(ln);
if (FD_ISSET(job->inPipe, readfdsp)) {
JobDoOutput(job, false);
nfds--;
}
}
}
free(readfdsp);
}
/*-
*-----------------------------------------------------------------------
* Job_Make --
* Start the creation of a target. Basically a front-end for
* JobStart used by the Make module.
*
* Side Effects:
* Another job is started.
*-----------------------------------------------------------------------
*/
void
Job_Make(GNode *gn)
{
(void)JobStart(gn, 0);
}
static void
setup_signal(int sig)
{
if (signal(sig, SIG_IGN) != SIG_IGN) {
(void)signal(sig, SigHandler);
}
}
static void
setup_all_signals()
{
/*
* Catch the four signals that POSIX specifies if they aren't ignored.
* handle_signal will take care of calling JobInterrupt if appropriate.
*/
setup_signal(SIGINT);
setup_signal(SIGHUP);
setup_signal(SIGQUIT);
setup_signal(SIGTERM);
/*
* There are additional signals that need to be caught and passed if
* either the export system wants to be told directly of signals or if
* we're giving each job its own process group (since then it won't get
* signals from the terminal driver as we own the terminal)
*/
#if defined(USE_PGRP)
setup_signal(SIGTSTP);
setup_signal(SIGTTOU);
setup_signal(SIGTTIN);
setup_signal(SIGWINCH);
#endif
}
/*-
*-----------------------------------------------------------------------
* Job_Init --
* Initialize the process module
*
* Side Effects:
* lists and counters are initialized
*-----------------------------------------------------------------------
*/
void
Job_Init(int maxproc)
{
Static_Lst_Init(&runningJobs);
Static_Lst_Init(&stoppedJobs);
maxJobs = maxproc;
nJobs = 0;
jobFull = false;
aborting = 0;
errors = 0;
lastNode = NULL;
if (maxJobs == 1) {
/*
* If only one job can run at a time, there's no need for a
* banner, no is there?
*/
targFmt = "";
} else {
targFmt = TARG_FMT;
}
if ((begin_node->type & OP_DUMMY) == 0) {
JobStart(begin_node, JOB_SPECIAL);
while (nJobs) {
Job_CatchOutput();
Job_CatchChildren();
}
}
}
/*-
*-----------------------------------------------------------------------
* Job_Full --
* See if the job table is full. It is considered full if it is OR
* if we are in the process of aborting OR if we have
* reached/exceeded our local quota. This prevents any more jobs
* from starting up.
*
* Results:
* true if the job table is full, false otherwise
*-----------------------------------------------------------------------
*/
bool
Job_Full(void)
{
return aborting || jobFull;
}
/*-
*-----------------------------------------------------------------------
* Job_Empty --
* See if the job table is empty. Because the local concurrency may
* be set to 0, it is possible for the job table to become empty,
* while the list of stoppedJobs remains non-empty. In such a case,
* we want to restart as many jobs as we can.
*
* Results:
* true if it is. false if it ain't.
* -----------------------------------------------------------------------
*/
bool
Job_Empty(void)
{
if (nJobs == 0) {
if (!Lst_IsEmpty(&stoppedJobs) && !aborting) {
/*
* The job table is obviously not full if it has no
* jobs in it...Try and restart the stopped jobs.
*/
jobFull = false;
JobRestartJobs();
return false;
} else {
return true;
}
} else {
return false;
}
}
/*-
*-----------------------------------------------------------------------
* JobInterrupt --
* Handle the receipt of an interrupt.
*
* Side Effects:
* All children are killed. Another job will be started if the
* .INTERRUPT target was given.
*-----------------------------------------------------------------------
*/
static void
JobInterrupt(int runINTERRUPT, /* Non-zero if commands for the .INTERRUPT
* target should be executed */
int signo) /* signal received */
{
LstNode ln; /* element in job table */
Job *job; /* job descriptor in that element */
aborting = ABORT_INTERRUPT;
for (ln = Lst_First(&runningJobs); ln != NULL; ln = Lst_Adv(ln)) {
job = (Job *)Lst_Datum(ln);
if (!Targ_Precious(job->node)) {
const char *file = job->node->path == NULL ?
job->node->name : job->node->path;
if (!noExecute && eunlink(file) != -1) {
Error("*** %s removed", file);
}
}
if (job->pid) {
debug_printf("JobInterrupt passing signal to "
"child %ld.\n", (long)job->pid);
KILL(job->pid, signo);
}
}
if (runINTERRUPT && !touchFlag) {
if ((interrupt_node->type & OP_DUMMY) == 0) {
ignoreErrors = false;
JobStart(interrupt_node, JOB_IGNDOTS);
while (nJobs) {
Job_CatchOutput();
Job_CatchChildren();
}
}
}
exit(signo);
}
/*
*-----------------------------------------------------------------------
* Job_Finish --
* Do final processing such as the running of the commands
* attached to the .END target.
*
* Results:
* Number of errors reported.
*
*-----------------------------------------------------------------------
*/
int
Job_Finish(void)
{
if (end_node != NULL && !Lst_IsEmpty(&end_node->commands)) {
if (errors) {
Error("Errors reported so .END ignored");
} else {
JobStart(end_node, JOB_SPECIAL | JOB_IGNDOTS);
while (nJobs) {
Job_CatchOutput();
Job_CatchChildren();
}
}
}
return errors;
}
#ifdef CLEANUP
void
Job_End(void)
{
}
#endif
/*-
*-----------------------------------------------------------------------
* Job_Wait --
* Waits for all running jobs to finish and returns. Sets 'aborting'
* to ABORT_WAIT to prevent other jobs from starting.
*
* Side Effects:
* Currently running jobs finish.
*
*-----------------------------------------------------------------------
*/
void
Job_Wait(void)
{
aborting = ABORT_WAIT;
while (nJobs != 0) {
Job_CatchOutput();
Job_CatchChildren();
}
aborting = 0;
}
/*-
*-----------------------------------------------------------------------
* Job_AbortAll --
* 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.
*
* Side Effects:
* All children are killed, not just the firstborn
*-----------------------------------------------------------------------
*/
void
Job_AbortAll(void)
{
LstNode ln; /* element in job table */
Job *job; /* the job descriptor in that element */
int foo;
aborting = ABORT_ERROR;
if (nJobs) {
for (ln = Lst_First(&runningJobs); ln != NULL;
ln = Lst_Adv(ln)) {
job = (Job *)Lst_Datum(ln);
/*
* kill the child process with increasingly drastic
* signals to make darn sure it's dead.
*/
KILL(job->pid, SIGINT);
KILL(job->pid, SIGKILL);
}
}
/*
* Catch as many children as want to report in at first, then give up
*/
while (waitpid(-1, &foo, WNOHANG) > 0)
continue;
}
/*-
*-----------------------------------------------------------------------
* JobRestartJobs --
* Tries to restart stopped jobs if there are slots available.
* Note that this tries to restart them regardless of pending errors.
* It's not good to leave stopped jobs lying around!
*
* Side Effects:
* Resumes(and possibly migrates) jobs.
*-----------------------------------------------------------------------
*/
static void
JobRestartJobs(void)
{
Job *job;
while (!jobFull && (job = (Job *)Lst_DeQueue(&stoppedJobs)) != NULL) {
debug_printf("Job queue is not full. "
"Restarting a stopped job.\n");
JobRestart(job);
}
}
![[BACK]](/icons/back.gif){kind=icon}
Return to job.c CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / make