job.c revision 1.269 1 1.269 rillig /* $NetBSD: job.c,v 1.269 2020/10/23 05:18:18 rillig Exp $ */
2 1.10 christos
3 1.1 cgd /*
4 1.1 cgd * Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
5 1.82 agc * All rights reserved.
6 1.82 agc *
7 1.82 agc * This code is derived from software contributed to Berkeley by
8 1.82 agc * Adam de Boor.
9 1.82 agc *
10 1.82 agc * Redistribution and use in source and binary forms, with or without
11 1.82 agc * modification, are permitted provided that the following conditions
12 1.82 agc * are met:
13 1.82 agc * 1. Redistributions of source code must retain the above copyright
14 1.82 agc * notice, this list of conditions and the following disclaimer.
15 1.82 agc * 2. Redistributions in binary form must reproduce the above copyright
16 1.82 agc * notice, this list of conditions and the following disclaimer in the
17 1.82 agc * documentation and/or other materials provided with the distribution.
18 1.82 agc * 3. Neither the name of the University nor the names of its contributors
19 1.82 agc * may be used to endorse or promote products derived from this software
20 1.82 agc * without specific prior written permission.
21 1.82 agc *
22 1.82 agc * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 1.82 agc * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 1.82 agc * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 1.82 agc * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 1.82 agc * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 1.82 agc * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 1.82 agc * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 1.82 agc * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 1.82 agc * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 1.82 agc * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 1.82 agc * SUCH DAMAGE.
33 1.82 agc */
34 1.82 agc
35 1.82 agc /*
36 1.1 cgd * Copyright (c) 1988, 1989 by Adam de Boor
37 1.1 cgd * Copyright (c) 1989 by Berkeley Softworks
38 1.1 cgd * All rights reserved.
39 1.1 cgd *
40 1.1 cgd * This code is derived from software contributed to Berkeley by
41 1.1 cgd * Adam de Boor.
42 1.1 cgd *
43 1.1 cgd * Redistribution and use in source and binary forms, with or without
44 1.1 cgd * modification, are permitted provided that the following conditions
45 1.1 cgd * are met:
46 1.1 cgd * 1. Redistributions of source code must retain the above copyright
47 1.1 cgd * notice, this list of conditions and the following disclaimer.
48 1.1 cgd * 2. Redistributions in binary form must reproduce the above copyright
49 1.1 cgd * notice, this list of conditions and the following disclaimer in the
50 1.1 cgd * documentation and/or other materials provided with the distribution.
51 1.1 cgd * 3. All advertising materials mentioning features or use of this software
52 1.1 cgd * must display the following acknowledgement:
53 1.1 cgd * This product includes software developed by the University of
54 1.1 cgd * California, Berkeley and its contributors.
55 1.1 cgd * 4. Neither the name of the University nor the names of its contributors
56 1.1 cgd * may be used to endorse or promote products derived from this software
57 1.1 cgd * without specific prior written permission.
58 1.1 cgd *
59 1.1 cgd * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
60 1.1 cgd * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
61 1.1 cgd * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
62 1.1 cgd * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
63 1.1 cgd * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
64 1.1 cgd * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
65 1.1 cgd * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
66 1.1 cgd * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
67 1.1 cgd * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
68 1.1 cgd * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
69 1.1 cgd * SUCH DAMAGE.
70 1.1 cgd */
71 1.1 cgd
72 1.1 cgd /*-
73 1.1 cgd * job.c --
74 1.1 cgd * handle the creation etc. of our child processes.
75 1.1 cgd *
76 1.1 cgd * Interface:
77 1.246 rillig * Job_Make Start the creation of the given target.
78 1.1 cgd *
79 1.246 rillig * Job_CatchChildren
80 1.246 rillig * Check for and handle the termination of any
81 1.246 rillig * children. This must be called reasonably
82 1.246 rillig * frequently to keep the whole make going at
83 1.246 rillig * a decent clip, since job table entries aren't
84 1.246 rillig * removed until their process is caught this way.
85 1.246 rillig *
86 1.246 rillig * Job_CatchOutput
87 1.246 rillig * Print any output our children have produced.
88 1.246 rillig * Should also be called fairly frequently to
89 1.246 rillig * keep the user informed of what's going on.
90 1.246 rillig * If no output is waiting, it will block for
91 1.246 rillig * a time given by the SEL_* constants, below,
92 1.246 rillig * or until output is ready.
93 1.246 rillig *
94 1.246 rillig * Job_Init Called to initialize this module. in addition,
95 1.246 rillig * any commands attached to the .BEGIN target
96 1.246 rillig * are executed before this function returns.
97 1.246 rillig * Hence, the makefile must have been parsed
98 1.246 rillig * before this function is called.
99 1.246 rillig *
100 1.263 rillig * Job_End Clean up any memory used.
101 1.246 rillig *
102 1.246 rillig * Job_ParseShell Given the line following a .SHELL target, parse
103 1.246 rillig * the line as a shell specification. Returns
104 1.246 rillig * FALSE if the spec was incorrect.
105 1.246 rillig *
106 1.246 rillig * Job_Finish Perform any final processing which needs doing.
107 1.246 rillig * This includes the execution of any commands
108 1.246 rillig * which have been/were attached to the .END
109 1.246 rillig * target. It should only be called when the
110 1.246 rillig * job table is empty.
111 1.246 rillig *
112 1.246 rillig * Job_AbortAll Abort all currently running jobs. It doesn't
113 1.246 rillig * handle output or do anything for the jobs,
114 1.246 rillig * just kills them. It should only be called in
115 1.246 rillig * an emergency, as it were.
116 1.246 rillig *
117 1.246 rillig * Job_CheckCommands
118 1.246 rillig * Verify that the commands for a target are
119 1.246 rillig * ok. Provide them if necessary and possible.
120 1.1 cgd *
121 1.246 rillig * Job_Touch Update a target without really updating it.
122 1.1 cgd *
123 1.246 rillig * Job_Wait Wait for all currently-running jobs to finish.
124 1.1 cgd */
125 1.1 cgd
126 1.5 cgd #include <sys/types.h>
127 1.1 cgd #include <sys/stat.h>
128 1.1 cgd #include <sys/file.h>
129 1.1 cgd #include <sys/time.h>
130 1.1 cgd #include <sys/wait.h>
131 1.72 wiz
132 1.72 wiz #include <errno.h>
133 1.35 christos #ifndef USE_SELECT
134 1.35 christos #include <poll.h>
135 1.35 christos #endif
136 1.72 wiz #include <signal.h>
137 1.72 wiz #include <utime.h>
138 1.72 wiz
139 1.5 cgd #include "make.h"
140 1.5 cgd #include "dir.h"
141 1.1 cgd #include "job.h"
142 1.1 cgd #include "pathnames.h"
143 1.40 sommerfe #include "trace.h"
144 1.232 rillig
145 1.232 rillig /* "@(#)job.c 8.2 (Berkeley) 3/19/94" */
146 1.269 rillig MAKE_RCSID("$NetBSD: job.c,v 1.269 2020/10/23 05:18:18 rillig Exp $");
147 1.232 rillig
148 1.12 christos # define STATIC static
149 1.1 cgd
150 1.266 rillig /*-
151 1.266 rillig * Shell Specifications:
152 1.266 rillig * Each shell type has associated with it the following information:
153 1.266 rillig * 1) The string which must match the last character of the shell name
154 1.266 rillig * for the shell to be considered of this type. The longest match
155 1.266 rillig * wins.
156 1.266 rillig * 2) A command to issue to turn off echoing of command lines
157 1.266 rillig * 3) A command to issue to turn echoing back on again
158 1.266 rillig * 4) What the shell prints, and its length, when given the echo-off
159 1.266 rillig * command. This line will not be printed when received from the shell
160 1.266 rillig * 5) A boolean to tell if the shell has the ability to control
161 1.266 rillig * error checking for individual commands.
162 1.266 rillig * 6) The string to turn this checking on.
163 1.266 rillig * 7) The string to turn it off.
164 1.266 rillig * 8) The command-flag to give to cause the shell to start echoing
165 1.266 rillig * commands right away.
166 1.266 rillig * 9) The command-flag to cause the shell to Lib_Exit when an error is
167 1.266 rillig * detected in one of the commands.
168 1.266 rillig *
169 1.266 rillig * Some special stuff goes on if a shell doesn't have error control. In such
170 1.266 rillig * a case, errCheck becomes a printf template for echoing the command,
171 1.266 rillig * should echoing be on and ignErr becomes another printf template for
172 1.266 rillig * executing the command while ignoring the return status. Finally errOut
173 1.266 rillig * is a printf template for running the command and causing the shell to
174 1.266 rillig * exit on error. If any of these strings are empty when hasErrCtl is FALSE,
175 1.266 rillig * the command will be executed anyway as is and if it causes an error, so be
176 1.266 rillig * it. Any templates setup to echo the command will escape any '$ ` \ "'i
177 1.266 rillig * characters in the command string to avoid common problems with
178 1.266 rillig * echo "%s\n" as a template.
179 1.266 rillig */
180 1.266 rillig typedef struct Shell {
181 1.266 rillig const char *name; /* the name of the shell. For Bourne and C
182 1.266 rillig * shells, this is used only to find the
183 1.266 rillig * shell description when used as the single
184 1.266 rillig * source of a .SHELL target. For user-defined
185 1.266 rillig * shells, this is the full path of the shell.
186 1.266 rillig */
187 1.266 rillig Boolean hasEchoCtl; /* True if both echoOff and echoOn defined */
188 1.266 rillig const char *echoOff; /* command to turn off echo */
189 1.266 rillig const char *echoOn; /* command to turn it back on again */
190 1.266 rillig const char *noPrint; /* command to skip when printing output from
191 1.266 rillig * shell. This is usually the command which
192 1.266 rillig * was executed to turn off echoing */
193 1.267 rillig size_t noPrintLen; /* length of noPrint command */
194 1.266 rillig Boolean hasErrCtl; /* set if can control error checking for
195 1.266 rillig * individual commands */
196 1.267 rillig const char *errCheck; /* string to turn on error checking */
197 1.266 rillig const char *ignErr; /* string to turn off error checking */
198 1.266 rillig const char *errOut; /* string to use for testing exit code */
199 1.266 rillig const char *newline; /* string literal that results in a newline
200 1.266 rillig * character when it appears outside of any
201 1.266 rillig * 'quote' or "quote" characters */
202 1.266 rillig char commentChar; /* character used by shell for comment lines */
203 1.266 rillig
204 1.266 rillig /*
205 1.266 rillig * command-line flags
206 1.266 rillig */
207 1.266 rillig const char *echo; /* echo commands */
208 1.266 rillig const char *exit; /* exit on error */
209 1.266 rillig } Shell;
210 1.266 rillig
211 1.1 cgd /*
212 1.16 christos * error handling variables
213 1.1 cgd */
214 1.246 rillig static int errors = 0; /* number of errors reported */
215 1.246 rillig static int aborting = 0; /* why is the make aborting? */
216 1.246 rillig #define ABORT_ERROR 1 /* Because of an error */
217 1.246 rillig #define ABORT_INTERRUPT 2 /* Because it was interrupted */
218 1.246 rillig #define ABORT_WAIT 3 /* Waiting for jobs to finish */
219 1.246 rillig #define JOB_TOKENS "+EI+" /* Token to requeue for each abort state */
220 1.1 cgd
221 1.16 christos /*
222 1.103 dsl * this tracks the number of tokens currently "out" to build jobs.
223 1.103 dsl */
224 1.103 dsl int jobTokensRunning = 0;
225 1.103 dsl
226 1.243 rillig /* The number of commands actually printed for a target.
227 1.243 rillig * XXX: Why printed? Shouldn't that be run/printed instead, depending on the
228 1.243 rillig * command line options?
229 1.243 rillig * Should this number be 0, no shell will be executed. */
230 1.246 rillig static int numCommands;
231 1.1 cgd
232 1.1 cgd /*
233 1.1 cgd * Return values from JobStart.
234 1.1 cgd */
235 1.246 rillig #define JOB_RUNNING 0 /* Job is running */
236 1.246 rillig #define JOB_ERROR 1 /* Error in starting the job */
237 1.246 rillig #define JOB_FINISHED 2 /* The job is already finished */
238 1.1 cgd
239 1.1 cgd /*
240 1.1 cgd * Descriptions for various shells.
241 1.121 apb *
242 1.133 apb * The build environment may set DEFSHELL_INDEX to one of
243 1.133 apb * DEFSHELL_INDEX_SH, DEFSHELL_INDEX_KSH, or DEFSHELL_INDEX_CSH, to
244 1.243 rillig * select one of the predefined shells as the default shell.
245 1.133 apb *
246 1.133 apb * Alternatively, the build environment may set DEFSHELL_CUSTOM to the
247 1.133 apb * name or the full path of a sh-compatible shell, which will be used as
248 1.133 apb * the default shell.
249 1.133 apb *
250 1.133 apb * ".SHELL" lines in Makefiles can choose the default shell from the
251 1.133 apb # set defined here, or add additional shells.
252 1.133 apb */
253 1.133 apb
254 1.133 apb #ifdef DEFSHELL_CUSTOM
255 1.133 apb #define DEFSHELL_INDEX_CUSTOM 0
256 1.133 apb #define DEFSHELL_INDEX_SH 1
257 1.133 apb #define DEFSHELL_INDEX_KSH 2
258 1.133 apb #define DEFSHELL_INDEX_CSH 3
259 1.133 apb #else /* !DEFSHELL_CUSTOM */
260 1.133 apb #define DEFSHELL_INDEX_SH 0
261 1.133 apb #define DEFSHELL_INDEX_KSH 1
262 1.133 apb #define DEFSHELL_INDEX_CSH 2
263 1.133 apb #endif /* !DEFSHELL_CUSTOM */
264 1.133 apb
265 1.133 apb #ifndef DEFSHELL_INDEX
266 1.133 apb #define DEFSHELL_INDEX 0 /* DEFSHELL_INDEX_CUSTOM or DEFSHELL_INDEX_SH */
267 1.133 apb #endif /* !DEFSHELL_INDEX */
268 1.133 apb
269 1.1 cgd static Shell shells[] = {
270 1.133 apb #ifdef DEFSHELL_CUSTOM
271 1.1 cgd /*
272 1.121 apb * An sh-compatible shell with a non-standard name.
273 1.121 apb *
274 1.121 apb * Keep this in sync with the "sh" description below, but avoid
275 1.121 apb * non-portable features that might not be supplied by all
276 1.121 apb * sh-compatible shells.
277 1.1 cgd */
278 1.1 cgd {
279 1.133 apb DEFSHELL_CUSTOM,
280 1.121 apb FALSE, "", "", "", 0,
281 1.121 apb FALSE, "echo \"%s\"\n", "%s\n", "{ %s \n} || exit $?\n", "'\n'", '#',
282 1.121 apb "",
283 1.121 apb "",
284 1.1 cgd },
285 1.133 apb #endif /* DEFSHELL_CUSTOM */
286 1.1 cgd /*
287 1.1 cgd * SH description. Echo control is also possible and, under
288 1.1 cgd * sun UNIX anyway, one can even control error checking.
289 1.1 cgd */
290 1.1 cgd {
291 1.1 cgd "sh",
292 1.83 jmc FALSE, "", "", "", 0,
293 1.112 rillig FALSE, "echo \"%s\"\n", "%s\n", "{ %s \n} || exit $?\n", "'\n'", '#',
294 1.121 apb #if defined(MAKE_NATIVE) && defined(__NetBSD__)
295 1.83 jmc "q",
296 1.27 christos #else
297 1.83 jmc "",
298 1.27 christos #endif
299 1.83 jmc "",
300 1.1 cgd },
301 1.1 cgd /*
302 1.201 rillig * KSH description.
303 1.81 sjg */
304 1.81 sjg {
305 1.81 sjg "ksh",
306 1.81 sjg TRUE, "set +v", "set -v", "set +v", 6,
307 1.112 rillig FALSE, "echo \"%s\"\n", "%s\n", "{ %s \n} || exit $?\n", "'\n'", '#',
308 1.81 sjg "v",
309 1.83 jmc "",
310 1.81 sjg },
311 1.81 sjg /*
312 1.121 apb * CSH description. The csh can do echo control by playing
313 1.121 apb * with the setting of the 'echo' shell variable. Sadly,
314 1.121 apb * however, it is unable to do error control nicely.
315 1.121 apb */
316 1.121 apb {
317 1.121 apb "csh",
318 1.260 rillig TRUE, "unset verbose", "set verbose", "unset verbose", 13,
319 1.121 apb FALSE, "echo \"%s\"\n", "csh -c \"%s || exit 0\"\n", "", "'\\\n'", '#',
320 1.121 apb "v", "e",
321 1.121 apb },
322 1.121 apb /*
323 1.1 cgd * UNKNOWN.
324 1.1 cgd */
325 1.1 cgd {
326 1.98 christos NULL,
327 1.98 christos FALSE, NULL, NULL, NULL, 0,
328 1.112 rillig FALSE, NULL, NULL, NULL, NULL, 0,
329 1.98 christos NULL, NULL,
330 1.1 cgd }
331 1.1 cgd };
332 1.243 rillig
333 1.243 rillig /* This is the shell to which we pass all commands in the Makefile.
334 1.243 rillig * It is set by the Job_ParseShell function. */
335 1.243 rillig static Shell *commandShell = &shells[DEFSHELL_INDEX];
336 1.243 rillig const char *shellPath = NULL; /* full pathname of executable image */
337 1.243 rillig const char *shellName = NULL; /* last component of shellPath */
338 1.174 sjg char *shellErrFlag = NULL;
339 1.209 rillig static char *shellArgv = NULL; /* Custom shell args */
340 1.1 cgd
341 1.1 cgd
342 1.114 dsl STATIC Job *job_table; /* The structures that describe them */
343 1.114 dsl STATIC Job *job_table_end; /* job_table + maxJobs */
344 1.261 rillig static unsigned int wantToken; /* we want a token */
345 1.117 dsl static int lurking_children = 0;
346 1.118 dsl static int make_suspended = 0; /* non-zero if we've seen a SIGTSTP (etc) */
347 1.40 sommerfe
348 1.35 christos /*
349 1.35 christos * Set of descriptors of pipes connected to
350 1.35 christos * the output channels of children
351 1.35 christos */
352 1.35 christos static struct pollfd *fds = NULL;
353 1.36 christos static Job **jobfds = NULL;
354 1.261 rillig static nfds_t nfds = 0;
355 1.72 wiz static void watchfd(Job *);
356 1.72 wiz static void clearfd(Job *);
357 1.72 wiz static int readyfd(Job *);
358 1.1 cgd
359 1.246 rillig STATIC GNode *lastNode; /* The node for which output was most recently
360 1.1 cgd * produced. */
361 1.158 christos static char *targPrefix = NULL; /* What we print at the start of TARG_FMT */
362 1.40 sommerfe static Job tokenWaitJob; /* token wait pseudo-job */
363 1.12 christos
364 1.73 gson static Job childExitJob; /* child exit pseudo-job */
365 1.105 dsl #define CHILD_EXIT "."
366 1.106 dsl #define DO_JOB_RESUME "R"
367 1.73 gson
368 1.261 rillig enum { npseudojobs = 2 }; /* number of pseudo-jobs */
369 1.196 riastrad
370 1.125 sjg #define TARG_FMT "%s %s ---\n" /* Default format */
371 1.106 dsl #define MESSAGE(fp, gn) \
372 1.175 sjg if (maxJobs != 1 && targPrefix && *targPrefix) \
373 1.158 christos (void)fprintf(fp, TARG_FMT, targPrefix, gn->name)
374 1.1 cgd
375 1.104 dsl static sigset_t caught_signals; /* Set of signals we handle */
376 1.1 cgd
377 1.72 wiz static void JobDoOutput(Job *, Boolean);
378 1.162 joerg static void JobInterrupt(int, int) MAKE_ATTR_DEAD;
379 1.72 wiz static void JobRestartJobs(void);
380 1.69 pk static void JobSigReset(void);
381 1.69 pk
382 1.196 riastrad static unsigned
383 1.196 riastrad nfds_per_job(void)
384 1.196 riastrad {
385 1.197 sjg #if defined(USE_FILEMON) && !defined(USE_FILEMON_DEV)
386 1.196 riastrad if (useMeta)
387 1.196 riastrad return 2;
388 1.196 riastrad #endif
389 1.196 riastrad return 1;
390 1.196 riastrad }
391 1.196 riastrad
392 1.114 dsl static void
393 1.114 dsl job_table_dump(const char *where)
394 1.114 dsl {
395 1.114 dsl Job *job;
396 1.114 dsl
397 1.251 rillig debug_printf("job table @ %s\n", where);
398 1.114 dsl for (job = job_table; job < job_table_end; job++) {
399 1.251 rillig debug_printf("job %d, status %d, flags %d, pid %d\n",
400 1.139 christos (int)(job - job_table), job->job_state, job->flags, job->pid);
401 1.114 dsl }
402 1.114 dsl }
403 1.69 pk
404 1.69 pk /*
405 1.188 dholland * Delete the target of a failed, interrupted, or otherwise
406 1.188 dholland * unsuccessful job unless inhibited by .PRECIOUS.
407 1.188 dholland */
408 1.188 dholland static void
409 1.188 dholland JobDeleteTarget(GNode *gn)
410 1.188 dholland {
411 1.188 dholland if ((gn->type & (OP_JOIN|OP_PHONY)) == 0 && !Targ_Precious(gn)) {
412 1.188 dholland char *file = (gn->path == NULL ? gn->name : gn->path);
413 1.188 dholland if (!noExecute && eunlink(file) != -1) {
414 1.188 dholland Error("*** %s removed", file);
415 1.188 dholland }
416 1.188 dholland }
417 1.188 dholland }
418 1.188 dholland
419 1.188 dholland /*
420 1.69 pk * JobSigLock/JobSigUnlock
421 1.69 pk *
422 1.69 pk * Signal lock routines to get exclusive access. Currently used to
423 1.69 pk * protect `jobs' and `stoppedJobs' list manipulations.
424 1.69 pk */
425 1.72 wiz static void JobSigLock(sigset_t *omaskp)
426 1.69 pk {
427 1.69 pk if (sigprocmask(SIG_BLOCK, &caught_signals, omaskp) != 0) {
428 1.69 pk Punt("JobSigLock: sigprocmask: %s", strerror(errno));
429 1.104 dsl sigemptyset(omaskp);
430 1.69 pk }
431 1.69 pk }
432 1.69 pk
433 1.72 wiz static void JobSigUnlock(sigset_t *omaskp)
434 1.69 pk {
435 1.96 christos (void)sigprocmask(SIG_SETMASK, omaskp, NULL);
436 1.69 pk }
437 1.1 cgd
438 1.122 dsl static void
439 1.122 dsl JobCreatePipe(Job *job, int minfd)
440 1.122 dsl {
441 1.189 riastrad int i, fd, flags;
442 1.249 rillig int pipe_fds[2];
443 1.122 dsl
444 1.249 rillig if (pipe(pipe_fds) == -1)
445 1.122 dsl Punt("Cannot create pipe: %s", strerror(errno));
446 1.122 dsl
447 1.173 sjg for (i = 0; i < 2; i++) {
448 1.247 rillig /* Avoid using low numbered fds */
449 1.249 rillig fd = fcntl(pipe_fds[i], F_DUPFD, minfd);
450 1.247 rillig if (fd != -1) {
451 1.249 rillig close(pipe_fds[i]);
452 1.249 rillig pipe_fds[i] = fd;
453 1.247 rillig }
454 1.173 sjg }
455 1.201 rillig
456 1.249 rillig job->inPipe = pipe_fds[0];
457 1.249 rillig job->outPipe = pipe_fds[1];
458 1.249 rillig
459 1.122 dsl /* Set close-on-exec flag for both */
460 1.248 rillig if (fcntl(job->inPipe, F_SETFD, FD_CLOEXEC) == -1)
461 1.189 riastrad Punt("Cannot set close-on-exec: %s", strerror(errno));
462 1.248 rillig if (fcntl(job->outPipe, F_SETFD, FD_CLOEXEC) == -1)
463 1.189 riastrad Punt("Cannot set close-on-exec: %s", strerror(errno));
464 1.122 dsl
465 1.122 dsl /*
466 1.122 dsl * We mark the input side of the pipe non-blocking; we poll(2) the
467 1.122 dsl * pipe when we're waiting for a job token, but we might lose the
468 1.201 rillig * race for the token when a new one becomes available, so the read
469 1.122 dsl * from the pipe should not block.
470 1.122 dsl */
471 1.248 rillig flags = fcntl(job->inPipe, F_GETFL, 0);
472 1.189 riastrad if (flags == -1)
473 1.189 riastrad Punt("Cannot get flags: %s", strerror(errno));
474 1.189 riastrad flags |= O_NONBLOCK;
475 1.248 rillig if (fcntl(job->inPipe, F_SETFL, flags) == -1)
476 1.189 riastrad Punt("Cannot set flags: %s", strerror(errno));
477 1.122 dsl }
478 1.122 dsl
479 1.243 rillig /* Pass the signal to each running job. */
480 1.114 dsl static void
481 1.114 dsl JobCondPassSig(int signo)
482 1.1 cgd {
483 1.114 dsl Job *job;
484 1.106 dsl
485 1.250 rillig DEBUG1(JOB, "JobCondPassSig(%d) called.\n", signo);
486 1.116 dsl
487 1.114 dsl for (job = job_table; job < job_table_end; job++) {
488 1.116 dsl if (job->job_state != JOB_ST_RUNNING)
489 1.114 dsl continue;
490 1.250 rillig DEBUG2(JOB, "JobCondPassSig passing signal %d to child %d.\n",
491 1.250 rillig signo, job->pid);
492 1.116 dsl KILLPG(job->pid, signo);
493 1.12 christos }
494 1.1 cgd }
495 1.1 cgd
496 1.243 rillig /* SIGCHLD handler.
497 1.37 sommerfe *
498 1.243 rillig * Sends a token on the child exit pipe to wake us up from select()/poll(). */
499 1.37 sommerfe static void
500 1.162 joerg JobChildSig(int signo MAKE_ATTR_UNUSED)
501 1.37 sommerfe {
502 1.165 christos while (write(childExitJob.outPipe, CHILD_EXIT, 1) == -1 && errno == EAGAIN)
503 1.165 christos continue;
504 1.37 sommerfe }
505 1.37 sommerfe
506 1.37 sommerfe
507 1.243 rillig /* Resume all stopped jobs. */
508 1.47 sommerfe static void
509 1.162 joerg JobContinueSig(int signo MAKE_ATTR_UNUSED)
510 1.47 sommerfe {
511 1.116 dsl /*
512 1.118 dsl * Defer sending to SIGCONT to our stopped children until we return
513 1.116 dsl * from the signal handler.
514 1.116 dsl */
515 1.165 christos while (write(childExitJob.outPipe, DO_JOB_RESUME, 1) == -1 &&
516 1.165 christos errno == EAGAIN)
517 1.165 christos continue;
518 1.47 sommerfe }
519 1.37 sommerfe
520 1.243 rillig /* Pass a signal on to all jobs, then resend to ourselves.
521 1.243 rillig * We die by the same signal. */
522 1.162 joerg MAKE_ATTR_DEAD static void
523 1.116 dsl JobPassSig_int(int signo)
524 1.116 dsl {
525 1.116 dsl /* Run .INTERRUPT target then exit */
526 1.116 dsl JobInterrupt(TRUE, signo);
527 1.116 dsl }
528 1.116 dsl
529 1.243 rillig /* Pass a signal on to all jobs, then resend to ourselves.
530 1.243 rillig * We die by the same signal. */
531 1.162 joerg MAKE_ATTR_DEAD static void
532 1.116 dsl JobPassSig_term(int signo)
533 1.116 dsl {
534 1.116 dsl /* Dont run .INTERRUPT target then exit */
535 1.116 dsl JobInterrupt(FALSE, signo);
536 1.116 dsl }
537 1.116 dsl
538 1.116 dsl static void
539 1.116 dsl JobPassSig_suspend(int signo)
540 1.1 cgd {
541 1.13 christos sigset_t nmask, omask;
542 1.14 christos struct sigaction act;
543 1.118 dsl
544 1.118 dsl /* Suppress job started/continued messages */
545 1.118 dsl make_suspended = 1;
546 1.16 christos
547 1.116 dsl /* Pass the signal onto every job */
548 1.114 dsl JobCondPassSig(signo);
549 1.1 cgd
550 1.1 cgd /*
551 1.1 cgd * Send ourselves the signal now we've given the message to everyone else.
552 1.1 cgd * Note we block everything else possible while we're getting the signal.
553 1.1 cgd * This ensures that all our jobs get continued when we wake up before
554 1.1 cgd * we take any other signal.
555 1.1 cgd */
556 1.28 christos sigfillset(&nmask);
557 1.68 pk sigdelset(&nmask, signo);
558 1.96 christos (void)sigprocmask(SIG_SETMASK, &nmask, &omask);
559 1.68 pk
560 1.14 christos act.sa_handler = SIG_DFL;
561 1.14 christos sigemptyset(&act.sa_mask);
562 1.14 christos act.sa_flags = 0;
563 1.96 christos (void)sigaction(signo, &act, NULL);
564 1.13 christos
565 1.251 rillig if (DEBUG(JOB))
566 1.251 rillig debug_printf("JobPassSig passing signal %d to self.\n", signo);
567 1.1 cgd
568 1.96 christos (void)kill(getpid(), signo);
569 1.115 dsl
570 1.115 dsl /*
571 1.116 dsl * We've been continued.
572 1.116 dsl *
573 1.116 dsl * A whole host of signals continue to happen!
574 1.118 dsl * SIGCHLD for any processes that actually suspended themselves.
575 1.116 dsl * SIGCHLD for any processes that exited while we were alseep.
576 1.116 dsl * The SIGCONT that actually caused us to wakeup.
577 1.116 dsl *
578 1.116 dsl * Since we defer passing the SIGCONT on to our children until
579 1.116 dsl * the main processing loop, we can be sure that all the SIGCHLD
580 1.116 dsl * events will have happened by then - and that the waitpid() will
581 1.116 dsl * collect the child 'suspended' events.
582 1.116 dsl * For correct sequencing we just need to ensure we process the
583 1.116 dsl * waitpid() before passign on the SIGCONT.
584 1.116 dsl *
585 1.116 dsl * In any case nothing else is needed here.
586 1.115 dsl */
587 1.1 cgd
588 1.68 pk /* Restore handler and signal mask */
589 1.116 dsl act.sa_handler = JobPassSig_suspend;
590 1.96 christos (void)sigaction(signo, &act, NULL);
591 1.96 christos (void)sigprocmask(SIG_SETMASK, &omask, NULL);
592 1.1 cgd }
593 1.1 cgd
594 1.114 dsl static Job *
595 1.153 sjg JobFindPid(int pid, int status, Boolean isJobs)
596 1.1 cgd {
597 1.114 dsl Job *job;
598 1.114 dsl
599 1.114 dsl for (job = job_table; job < job_table_end; job++) {
600 1.116 dsl if ((job->job_state == status) && job->pid == pid)
601 1.114 dsl return job;
602 1.114 dsl }
603 1.153 sjg if (DEBUG(JOB) && isJobs)
604 1.114 dsl job_table_dump("no pid");
605 1.114 dsl return NULL;
606 1.12 christos }
607 1.12 christos
608 1.1 cgd /*-
609 1.1 cgd *-----------------------------------------------------------------------
610 1.1 cgd * JobPrintCommand --
611 1.1 cgd * Put out another command for the given job. If the command starts
612 1.1 cgd * with an @ or a - we process it specially. In the former case,
613 1.1 cgd * so long as the -s and -n flags weren't given to make, we stick
614 1.1 cgd * a shell-specific echoOff command in the script. In the latter,
615 1.1 cgd * we ignore errors for the entire job, unless the shell has error
616 1.1 cgd * control.
617 1.1 cgd * If the command is just "..." we take all future commands for this
618 1.1 cgd * job to be commands to be executed once the entire graph has been
619 1.1 cgd * made and return non-zero to signal that the end of the commands
620 1.1 cgd * was reached. These commands are later attached to the postCommands
621 1.1 cgd * node and executed by Job_End when all things are done.
622 1.237 rillig * This function is called from JobStart via Lst_ForEachUntil.
623 1.1 cgd *
624 1.72 wiz * Input:
625 1.72 wiz * cmdp command string to print
626 1.72 wiz * jobp job for which to print it
627 1.72 wiz *
628 1.1 cgd * Results:
629 1.269 rillig * FALSE, unless the command was "..."
630 1.1 cgd *
631 1.1 cgd * Side Effects:
632 1.1 cgd * If the command begins with a '-' and the shell has no error control,
633 1.1 cgd * the JOB_IGNERR flag is set in the job descriptor.
634 1.1 cgd * If the command is "..." and we're not ignoring such things,
635 1.1 cgd * tailCmds is set to the successor node of the cmd.
636 1.1 cgd * numCommands is incremented if the command is actually printed.
637 1.1 cgd *-----------------------------------------------------------------------
638 1.1 cgd */
639 1.269 rillig static Boolean
640 1.269 rillig JobPrintCommand(Job *job, char *cmd)
641 1.1 cgd {
642 1.269 rillig const char *const cmdp = cmd;
643 1.246 rillig Boolean noSpecials; /* true if we shouldn't worry about
644 1.246 rillig * inserting special commands into
645 1.246 rillig * the input stream. */
646 1.246 rillig Boolean shutUp = FALSE; /* true if we put a no echo command
647 1.246 rillig * into the command file */
648 1.246 rillig Boolean errOff = FALSE; /* true if we turned error checking
649 1.246 rillig * off before printing the command
650 1.246 rillig * and need to turn it back on */
651 1.246 rillig const char *cmdTemplate; /* Template to use when printing the
652 1.246 rillig * command */
653 1.246 rillig char *cmdStart; /* Start of expanded command */
654 1.246 rillig char *escCmd = NULL; /* Command with quotes/backticks escaped */
655 1.83 jmc
656 1.45 sommerfe noSpecials = NoExecute(job->node);
657 1.1 cgd
658 1.12 christos if (strcmp(cmd, "...") == 0) {
659 1.16 christos job->node->type |= OP_SAVE_CMDS;
660 1.1 cgd if ((job->flags & JOB_IGNDOTS) == 0) {
661 1.233 rillig StringListNode *dotsNode = Lst_FindDatum(job->node->commands, cmd);
662 1.241 rillig job->tailCmds = dotsNode != NULL ? dotsNode->next : NULL;
663 1.269 rillig return TRUE;
664 1.12 christos }
665 1.269 rillig return FALSE;
666 1.1 cgd }
667 1.1 cgd
668 1.12 christos #define DBPRINTF(fmt, arg) if (DEBUG(JOB)) { \
669 1.251 rillig debug_printf(fmt, arg); \
670 1.12 christos } \
671 1.96 christos (void)fprintf(job->cmdFILE, fmt, arg); \
672 1.96 christos (void)fflush(job->cmdFILE);
673 1.1 cgd
674 1.252 rillig numCommands++;
675 1.1 cgd
676 1.234 rillig Var_Subst(cmd, job->node, VARE_WANTRES, &cmd);
677 1.234 rillig /* TODO: handle errors */
678 1.234 rillig cmdStart = cmd;
679 1.1 cgd
680 1.1 cgd cmdTemplate = "%s\n";
681 1.1 cgd
682 1.1 cgd /*
683 1.1 cgd * Check for leading @' and -'s to control echoing and error checking.
684 1.1 cgd */
685 1.85 sjg while (*cmd == '@' || *cmd == '-' || (*cmd == '+')) {
686 1.85 sjg switch (*cmd) {
687 1.85 sjg case '@':
688 1.135 sjg shutUp = DEBUG(LOUD) ? FALSE : TRUE;
689 1.85 sjg break;
690 1.85 sjg case '-':
691 1.1 cgd errOff = TRUE;
692 1.85 sjg break;
693 1.85 sjg case '+':
694 1.85 sjg if (noSpecials) {
695 1.85 sjg /*
696 1.85 sjg * We're not actually executing anything...
697 1.85 sjg * but this one needs to be - use compat mode just for it.
698 1.85 sjg */
699 1.231 rillig Compat_RunCommand(cmdp, job->node);
700 1.190 riastrad free(cmdStart);
701 1.85 sjg return 0;
702 1.85 sjg }
703 1.85 sjg break;
704 1.1 cgd }
705 1.1 cgd cmd++;
706 1.1 cgd }
707 1.1 cgd
708 1.260 rillig pp_skip_whitespace(&cmd);
709 1.1 cgd
710 1.83 jmc /*
711 1.83 jmc * If the shell doesn't have error control the alternate echo'ing will
712 1.201 rillig * be done (to avoid showing additional error checking code)
713 1.83 jmc * and this will need the characters '$ ` \ "' escaped
714 1.83 jmc */
715 1.83 jmc
716 1.83 jmc if (!commandShell->hasErrCtl) {
717 1.222 rillig int i, j;
718 1.222 rillig
719 1.83 jmc /* Worst that could happen is every char needs escaping. */
720 1.140 joerg escCmd = bmake_malloc((strlen(cmd) * 2) + 1);
721 1.222 rillig for (i = 0, j = 0; cmd[i] != '\0'; i++, j++) {
722 1.222 rillig if (cmd[i] == '$' || cmd[i] == '`' || cmd[i] == '\\' ||
723 1.222 rillig cmd[i] == '"')
724 1.222 rillig escCmd[j++] = '\\';
725 1.222 rillig escCmd[j] = cmd[i];
726 1.83 jmc }
727 1.222 rillig escCmd[j] = '\0';
728 1.83 jmc }
729 1.83 jmc
730 1.1 cgd if (shutUp) {
731 1.12 christos if (!(job->flags & JOB_SILENT) && !noSpecials &&
732 1.1 cgd commandShell->hasEchoCtl) {
733 1.12 christos DBPRINTF("%s\n", commandShell->echoOff);
734 1.1 cgd } else {
735 1.83 jmc if (commandShell->hasErrCtl)
736 1.83 jmc shutUp = FALSE;
737 1.1 cgd }
738 1.1 cgd }
739 1.1 cgd
740 1.1 cgd if (errOff) {
741 1.152 christos if (!noSpecials) {
742 1.1 cgd if (commandShell->hasErrCtl) {
743 1.1 cgd /*
744 1.1 cgd * we don't want the error-control commands showing
745 1.1 cgd * up either, so we turn off echoing while executing
746 1.1 cgd * them. We could put another field in the shell
747 1.1 cgd * structure to tell JobDoOutput to look for this
748 1.1 cgd * string too, but why make it any more complex than
749 1.1 cgd * it already is?
750 1.1 cgd */
751 1.12 christos if (!(job->flags & JOB_SILENT) && !shutUp &&
752 1.1 cgd commandShell->hasEchoCtl) {
753 1.12 christos DBPRINTF("%s\n", commandShell->echoOff);
754 1.12 christos DBPRINTF("%s\n", commandShell->ignErr);
755 1.12 christos DBPRINTF("%s\n", commandShell->echoOn);
756 1.1 cgd } else {
757 1.83 jmc DBPRINTF("%s\n", commandShell->ignErr);
758 1.1 cgd }
759 1.1 cgd } else if (commandShell->ignErr &&
760 1.229 rillig commandShell->ignErr[0] != '\0')
761 1.1 cgd {
762 1.1 cgd /*
763 1.1 cgd * The shell has no error control, so we need to be
764 1.1 cgd * weird to get it to ignore any errors from the command.
765 1.1 cgd * If echoing is turned on, we turn it off and use the
766 1.1 cgd * errCheck template to echo the command. Leave echoing
767 1.1 cgd * off so the user doesn't see the weirdness we go through
768 1.1 cgd * to ignore errors. Set cmdTemplate to use the weirdness
769 1.1 cgd * instead of the simple "%s\n" template.
770 1.1 cgd */
771 1.178 sjg job->flags |= JOB_IGNERR;
772 1.83 jmc if (!(job->flags & JOB_SILENT) && !shutUp) {
773 1.83 jmc if (commandShell->hasEchoCtl) {
774 1.83 jmc DBPRINTF("%s\n", commandShell->echoOff);
775 1.83 jmc }
776 1.83 jmc DBPRINTF(commandShell->errCheck, escCmd);
777 1.1 cgd shutUp = TRUE;
778 1.83 jmc } else {
779 1.83 jmc if (!shutUp) {
780 1.83 jmc DBPRINTF(commandShell->errCheck, escCmd);
781 1.83 jmc }
782 1.1 cgd }
783 1.1 cgd cmdTemplate = commandShell->ignErr;
784 1.1 cgd /*
785 1.16 christos * The error ignoration (hee hee) is already taken care
786 1.1 cgd * of by the ignErr template, so pretend error checking
787 1.1 cgd * is still on.
788 1.1 cgd */
789 1.1 cgd errOff = FALSE;
790 1.1 cgd } else {
791 1.1 cgd errOff = FALSE;
792 1.1 cgd }
793 1.1 cgd } else {
794 1.1 cgd errOff = FALSE;
795 1.1 cgd }
796 1.83 jmc } else {
797 1.83 jmc
798 1.201 rillig /*
799 1.83 jmc * If errors are being checked and the shell doesn't have error control
800 1.83 jmc * but does supply an errOut template, then setup commands to run
801 1.83 jmc * through it.
802 1.83 jmc */
803 1.83 jmc
804 1.201 rillig if (!commandShell->hasErrCtl && commandShell->errOut &&
805 1.229 rillig commandShell->errOut[0] != '\0') {
806 1.83 jmc if (!(job->flags & JOB_SILENT) && !shutUp) {
807 1.83 jmc if (commandShell->hasEchoCtl) {
808 1.83 jmc DBPRINTF("%s\n", commandShell->echoOff);
809 1.83 jmc }
810 1.83 jmc DBPRINTF(commandShell->errCheck, escCmd);
811 1.83 jmc shutUp = TRUE;
812 1.83 jmc }
813 1.93 jmc /* If it's a comment line or blank, treat as an ignored error */
814 1.93 jmc if ((escCmd[0] == commandShell->commentChar) ||
815 1.93 jmc (escCmd[0] == 0))
816 1.83 jmc cmdTemplate = commandShell->ignErr;
817 1.83 jmc else
818 1.83 jmc cmdTemplate = commandShell->errOut;
819 1.83 jmc errOff = FALSE;
820 1.83 jmc }
821 1.1 cgd }
822 1.16 christos
823 1.49 sjg if (DEBUG(SHELL) && strcmp(shellName, "sh") == 0 &&
824 1.49 sjg (job->flags & JOB_TRACED) == 0) {
825 1.49 sjg DBPRINTF("set -%s\n", "x");
826 1.49 sjg job->flags |= JOB_TRACED;
827 1.49 sjg }
828 1.201 rillig
829 1.12 christos DBPRINTF(cmdTemplate, cmd);
830 1.23 itohy free(cmdStart);
831 1.185 christos free(escCmd);
832 1.1 cgd if (errOff) {
833 1.1 cgd /*
834 1.1 cgd * If echoing is already off, there's no point in issuing the
835 1.1 cgd * echoOff command. Otherwise we issue it and pretend it was on
836 1.1 cgd * for the whole command...
837 1.1 cgd */
838 1.1 cgd if (!shutUp && !(job->flags & JOB_SILENT) && commandShell->hasEchoCtl){
839 1.12 christos DBPRINTF("%s\n", commandShell->echoOff);
840 1.1 cgd shutUp = TRUE;
841 1.1 cgd }
842 1.12 christos DBPRINTF("%s\n", commandShell->errCheck);
843 1.1 cgd }
844 1.83 jmc if (shutUp && commandShell->hasEchoCtl) {
845 1.12 christos DBPRINTF("%s\n", commandShell->echoOn);
846 1.1 cgd }
847 1.269 rillig return FALSE;
848 1.269 rillig }
849 1.269 rillig
850 1.269 rillig static void
851 1.269 rillig JobPrintCommands(Job *job)
852 1.269 rillig {
853 1.269 rillig StringListNode *ln;
854 1.269 rillig
855 1.269 rillig for (ln = job->node->commands->first; ln != NULL; ln = ln->next)
856 1.269 rillig if (JobPrintCommand(job, ln->datum))
857 1.269 rillig break;
858 1.1 cgd }
859 1.1 cgd
860 1.236 rillig /* Save the delayed commands, to be executed when everything else is done. */
861 1.236 rillig static void
862 1.236 rillig JobSaveCommands(Job *job)
863 1.1 cgd {
864 1.236 rillig StringListNode *node;
865 1.236 rillig
866 1.241 rillig for (node = job->tailCmds; node != NULL; node = node->next) {
867 1.241 rillig const char *cmd = node->datum;
868 1.236 rillig char *expanded_cmd;
869 1.236 rillig /* XXX: This Var_Subst is only intended to expand the dynamic
870 1.236 rillig * variables such as .TARGET, .IMPSRC. It is not intended to
871 1.236 rillig * expand the other variables as well; see deptgt-end.mk. */
872 1.236 rillig (void)Var_Subst(cmd, job->node, VARE_WANTRES, &expanded_cmd);
873 1.236 rillig /* TODO: handle errors */
874 1.236 rillig Lst_Append(Targ_GetEndNode()->commands, expanded_cmd);
875 1.236 rillig }
876 1.12 christos }
877 1.12 christos
878 1.12 christos
879 1.243 rillig /* Called to close both input and output pipes when a job is finished. */
880 1.12 christos static void
881 1.72 wiz JobClose(Job *job)
882 1.12 christos {
883 1.120 dsl clearfd(job);
884 1.122 dsl (void)close(job->outPipe);
885 1.122 dsl job->outPipe = -1;
886 1.122 dsl
887 1.120 dsl JobDoOutput(job, TRUE);
888 1.120 dsl (void)close(job->inPipe);
889 1.120 dsl job->inPipe = -1;
890 1.1 cgd }
891 1.1 cgd
892 1.1 cgd /*-
893 1.1 cgd *-----------------------------------------------------------------------
894 1.1 cgd * JobFinish --
895 1.1 cgd * Do final processing for the given job including updating
896 1.1 cgd * parents and starting new jobs as available/necessary. Note
897 1.1 cgd * that we pay no attention to the JOB_IGNERR flag here.
898 1.1 cgd * This is because when we're called because of a noexecute flag
899 1.1 cgd * or something, jstat.w_status is 0 and when called from
900 1.1 cgd * Job_CatchChildren, the status is zeroed if it s/b ignored.
901 1.1 cgd *
902 1.72 wiz * Input:
903 1.72 wiz * job job to finish
904 1.72 wiz * status sub-why job went away
905 1.72 wiz *
906 1.1 cgd * Side Effects:
907 1.1 cgd * Final commands for the job are placed on postCommands.
908 1.1 cgd *
909 1.16 christos * If we got an error and are aborting (aborting == ABORT_ERROR) and
910 1.1 cgd * the job list is now empty, we are done for the day.
911 1.16 christos * If we recognized an error (errors !=0), we set the aborting flag
912 1.1 cgd * to ABORT_ERROR so no more jobs will be started.
913 1.1 cgd *-----------------------------------------------------------------------
914 1.1 cgd */
915 1.5 cgd static void
916 1.116 dsl JobFinish(Job *job, int status)
917 1.1 cgd {
918 1.246 rillig Boolean done, return_job_token;
919 1.1 cgd
920 1.253 rillig DEBUG3(JOB, "JobFinish: %d [%s], status %d\n",
921 1.250 rillig job->pid, job->node->name, status);
922 1.116 dsl
923 1.116 dsl if ((WIFEXITED(status) &&
924 1.116 dsl (((WEXITSTATUS(status) != 0) && !(job->flags & JOB_IGNERR)))) ||
925 1.116 dsl WIFSIGNALED(status))
926 1.1 cgd {
927 1.1 cgd /*
928 1.1 cgd * If it exited non-zero and either we're doing things our
929 1.1 cgd * way or we're not ignoring errors, the job is finished.
930 1.1 cgd * Similarly, if the shell died because of a signal
931 1.1 cgd * the job is also finished. In these
932 1.1 cgd * cases, finish out the job's output before printing the exit
933 1.1 cgd * status...
934 1.1 cgd */
935 1.12 christos JobClose(job);
936 1.1 cgd if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
937 1.96 christos (void)fclose(job->cmdFILE);
938 1.34 christos job->cmdFILE = NULL;
939 1.1 cgd }
940 1.1 cgd done = TRUE;
941 1.116 dsl } else if (WIFEXITED(status)) {
942 1.1 cgd /*
943 1.1 cgd * Deal with ignored errors in -B mode. We need to print a message
944 1.1 cgd * telling of the ignored error as well as setting status.w_status
945 1.1 cgd * to 0 so the next command gets run. To do this, we set done to be
946 1.12 christos * TRUE if in -B mode and the job exited non-zero.
947 1.12 christos */
948 1.116 dsl done = WEXITSTATUS(status) != 0;
949 1.16 christos /*
950 1.12 christos * Old comment said: "Note we don't
951 1.1 cgd * want to close down any of the streams until we know we're at the
952 1.12 christos * end."
953 1.12 christos * But we do. Otherwise when are we going to print the rest of the
954 1.12 christos * stuff?
955 1.12 christos */
956 1.12 christos JobClose(job);
957 1.1 cgd } else {
958 1.1 cgd /*
959 1.1 cgd * No need to close things down or anything.
960 1.1 cgd */
961 1.1 cgd done = FALSE;
962 1.1 cgd }
963 1.16 christos
964 1.116 dsl if (done) {
965 1.116 dsl if (WIFEXITED(status)) {
966 1.250 rillig DEBUG2(JOB, "Process %d [%s] exited.\n",
967 1.250 rillig job->pid, job->node->name);
968 1.116 dsl if (WEXITSTATUS(status) != 0) {
969 1.120 dsl if (job->node != lastNode) {
970 1.107 dsl MESSAGE(stdout, job->node);
971 1.1 cgd lastNode = job->node;
972 1.1 cgd }
973 1.155 sjg #ifdef USE_META
974 1.155 sjg if (useMeta) {
975 1.155 sjg meta_job_error(job, job->node, job->flags, WEXITSTATUS(status));
976 1.155 sjg }
977 1.155 sjg #endif
978 1.198 sjg if (!dieQuietly(job->node, -1))
979 1.198 sjg (void)printf("*** [%s] Error code %d%s\n",
980 1.198 sjg job->node->name,
981 1.198 sjg WEXITSTATUS(status),
982 1.198 sjg (job->flags & JOB_IGNERR) ? " (ignored)" : "");
983 1.151 sjg if (job->flags & JOB_IGNERR) {
984 1.116 dsl status = 0;
985 1.151 sjg } else {
986 1.188 dholland if (deleteOnError) {
987 1.188 dholland JobDeleteTarget(job->node);
988 1.188 dholland }
989 1.151 sjg PrintOnError(job->node, NULL);
990 1.151 sjg }
991 1.1 cgd } else if (DEBUG(JOB)) {
992 1.120 dsl if (job->node != lastNode) {
993 1.107 dsl MESSAGE(stdout, job->node);
994 1.1 cgd lastNode = job->node;
995 1.1 cgd }
996 1.107 dsl (void)printf("*** [%s] Completed successfully\n",
997 1.61 pk job->node->name);
998 1.12 christos }
999 1.1 cgd } else {
1000 1.120 dsl if (job->node != lastNode) {
1001 1.107 dsl MESSAGE(stdout, job->node);
1002 1.1 cgd lastNode = job->node;
1003 1.1 cgd }
1004 1.107 dsl (void)printf("*** [%s] Signal %d\n",
1005 1.116 dsl job->node->name, WTERMSIG(status));
1006 1.188 dholland if (deleteOnError) {
1007 1.188 dholland JobDeleteTarget(job->node);
1008 1.188 dholland }
1009 1.1 cgd }
1010 1.107 dsl (void)fflush(stdout);
1011 1.1 cgd }
1012 1.16 christos
1013 1.156 sjg #ifdef USE_META
1014 1.156 sjg if (useMeta) {
1015 1.187 sjg int x;
1016 1.187 sjg
1017 1.187 sjg if ((x = meta_job_finish(job)) != 0 && status == 0) {
1018 1.187 sjg status = x;
1019 1.187 sjg }
1020 1.156 sjg }
1021 1.156 sjg #endif
1022 1.201 rillig
1023 1.102 dsl return_job_token = FALSE;
1024 1.102 dsl
1025 1.107 dsl Trace_Log(JOBEND, job);
1026 1.107 dsl if (!(job->flags & JOB_SPECIAL)) {
1027 1.116 dsl if ((status != 0) ||
1028 1.107 dsl (aborting == ABORT_ERROR) ||
1029 1.107 dsl (aborting == ABORT_INTERRUPT))
1030 1.107 dsl return_job_token = TRUE;
1031 1.42 sommerfe }
1032 1.1 cgd
1033 1.116 dsl if ((aborting != ABORT_ERROR) && (aborting != ABORT_INTERRUPT) && (status == 0)) {
1034 1.1 cgd /*
1035 1.1 cgd * As long as we aren't aborting and the job didn't return a non-zero
1036 1.1 cgd * status that we shouldn't ignore, we call Make_Update to update
1037 1.236 rillig * the parents.
1038 1.1 cgd */
1039 1.236 rillig JobSaveCommands(job);
1040 1.1 cgd job->node->made = MADE;
1041 1.43 sommerfe if (!(job->flags & JOB_SPECIAL))
1042 1.102 dsl return_job_token = TRUE;
1043 1.12 christos Make_Update(job->node);
1044 1.116 dsl job->job_state = JOB_ST_FREE;
1045 1.116 dsl } else if (status != 0) {
1046 1.252 rillig errors++;
1047 1.116 dsl job->job_state = JOB_ST_FREE;
1048 1.1 cgd }
1049 1.1 cgd
1050 1.1 cgd /*
1051 1.1 cgd * Set aborting if any error.
1052 1.1 cgd */
1053 1.1 cgd if (errors && !keepgoing && (aborting != ABORT_INTERRUPT)) {
1054 1.1 cgd /*
1055 1.1 cgd * If we found any errors in this batch of children and the -k flag
1056 1.1 cgd * wasn't given, we set the aborting flag so no more jobs get
1057 1.1 cgd * started.
1058 1.1 cgd */
1059 1.1 cgd aborting = ABORT_ERROR;
1060 1.1 cgd }
1061 1.16 christos
1062 1.102 dsl if (return_job_token)
1063 1.102 dsl Job_TokenReturn();
1064 1.102 dsl
1065 1.111 dsl if (aborting == ABORT_ERROR && jobTokensRunning == 0) {
1066 1.1 cgd /*
1067 1.1 cgd * If we are aborting and the job table is now empty, we finish.
1068 1.1 cgd */
1069 1.12 christos Finish(errors);
1070 1.1 cgd }
1071 1.1 cgd }
1072 1.1 cgd
1073 1.243 rillig /* Touch the given target. Called by JobStart when the -t flag was given.
1074 1.1 cgd *
1075 1.243 rillig * The modification date of the file is changed.
1076 1.243 rillig * If the file did not exist, it is created. */
1077 1.1 cgd void
1078 1.72 wiz Job_Touch(GNode *gn, Boolean silent)
1079 1.1 cgd {
1080 1.246 rillig int streamID; /* ID of stream opened to do the touch */
1081 1.14 christos struct utimbuf times; /* Times for utime() call */
1082 1.1 cgd
1083 1.157 christos if (gn->type & (OP_JOIN|OP_USE|OP_USEBEFORE|OP_EXEC|OP_OPTIONAL|
1084 1.157 christos OP_SPECIAL|OP_PHONY)) {
1085 1.1 cgd /*
1086 1.1 cgd * .JOIN, .USE, .ZEROTIME and .OPTIONAL targets are "virtual" targets
1087 1.1 cgd * and, as such, shouldn't really be created.
1088 1.1 cgd */
1089 1.1 cgd return;
1090 1.1 cgd }
1091 1.16 christos
1092 1.45 sommerfe if (!silent || NoExecute(gn)) {
1093 1.96 christos (void)fprintf(stdout, "touch %s\n", gn->name);
1094 1.96 christos (void)fflush(stdout);
1095 1.1 cgd }
1096 1.1 cgd
1097 1.45 sommerfe if (NoExecute(gn)) {
1098 1.1 cgd return;
1099 1.1 cgd }
1100 1.1 cgd
1101 1.1 cgd if (gn->type & OP_ARCHV) {
1102 1.12 christos Arch_Touch(gn);
1103 1.1 cgd } else if (gn->type & OP_LIB) {
1104 1.12 christos Arch_TouchLib(gn);
1105 1.1 cgd } else {
1106 1.1 cgd char *file = gn->path ? gn->path : gn->name;
1107 1.1 cgd
1108 1.14 christos times.actime = times.modtime = now;
1109 1.14 christos if (utime(file, ×) < 0){
1110 1.12 christos streamID = open(file, O_RDWR | O_CREAT, 0666);
1111 1.1 cgd
1112 1.1 cgd if (streamID >= 0) {
1113 1.1 cgd char c;
1114 1.1 cgd
1115 1.1 cgd /*
1116 1.1 cgd * Read and write a byte to the file to change the
1117 1.1 cgd * modification time, then close the file.
1118 1.1 cgd */
1119 1.1 cgd if (read(streamID, &c, 1) == 1) {
1120 1.96 christos (void)lseek(streamID, (off_t)0, SEEK_SET);
1121 1.165 christos while (write(streamID, &c, 1) == -1 && errno == EAGAIN)
1122 1.165 christos continue;
1123 1.1 cgd }
1124 1.16 christos
1125 1.96 christos (void)close(streamID);
1126 1.12 christos } else {
1127 1.96 christos (void)fprintf(stdout, "*** couldn't touch %s: %s",
1128 1.12 christos file, strerror(errno));
1129 1.96 christos (void)fflush(stdout);
1130 1.12 christos }
1131 1.1 cgd }
1132 1.1 cgd }
1133 1.1 cgd }
1134 1.1 cgd
1135 1.243 rillig /* Make sure the given node has all the commands it needs.
1136 1.243 rillig *
1137 1.243 rillig * The node will have commands from the .DEFAULT rule added to it if it
1138 1.243 rillig * needs them.
1139 1.1 cgd *
1140 1.72 wiz * Input:
1141 1.72 wiz * gn The target whose commands need verifying
1142 1.72 wiz * abortProc Function to abort with message
1143 1.72 wiz *
1144 1.1 cgd * Results:
1145 1.1 cgd * TRUE if the commands list is/was ok.
1146 1.1 cgd */
1147 1.1 cgd Boolean
1148 1.77 christos Job_CheckCommands(GNode *gn, void (*abortProc)(const char *, ...))
1149 1.1 cgd {
1150 1.220 rillig if (OP_NOP(gn->type) && Lst_IsEmpty(gn->commands) &&
1151 1.220 rillig ((gn->type & OP_LIB) == 0 || Lst_IsEmpty(gn->children))) {
1152 1.1 cgd /*
1153 1.1 cgd * No commands. Look for .DEFAULT rule from which we might infer
1154 1.16 christos * commands
1155 1.1 cgd */
1156 1.220 rillig if ((DEFAULT != NULL) && !Lst_IsEmpty(DEFAULT->commands) &&
1157 1.110 dsl (gn->type & OP_SPECIAL) == 0) {
1158 1.6 jtc char *p1;
1159 1.1 cgd /*
1160 1.1 cgd * Make only looks for a .DEFAULT if the node was never the
1161 1.1 cgd * target of an operator, so that's what we do too. If
1162 1.1 cgd * a .DEFAULT was given, we substitute its commands for gn's
1163 1.1 cgd * commands and set the IMPSRC variable to be the target's name
1164 1.1 cgd * The DEFAULT node acts like a transformation rule, in that
1165 1.1 cgd * gn also inherits any attributes or sources attached to
1166 1.1 cgd * .DEFAULT itself.
1167 1.1 cgd */
1168 1.1 cgd Make_HandleUse(DEFAULT, gn);
1169 1.199 rillig Var_Set(IMPSRC, Var_Value(TARGET, gn, &p1), gn);
1170 1.204 rillig bmake_free(p1);
1171 1.161 christos } else if (Dir_MTime(gn, 0) == 0 && (gn->type & OP_SPECIAL) == 0) {
1172 1.1 cgd /*
1173 1.228 rillig * The node wasn't the target of an operator. We have no .DEFAULT
1174 1.1 cgd * rule to go on and the target doesn't already exist. There's
1175 1.1 cgd * nothing more we can do for this branch. If the -k flag wasn't
1176 1.1 cgd * given, we stop in our tracks, otherwise we just don't update
1177 1.16 christos * this node's parents so they never get examined.
1178 1.1 cgd */
1179 1.46 christos static const char msg[] = ": don't know how to make";
1180 1.12 christos
1181 1.134 dsl if (gn->flags & FROM_DEPEND) {
1182 1.172 christos if (!Job_RunTarget(".STALE", gn->fname))
1183 1.172 christos fprintf(stdout, "%s: %s, %d: ignoring stale %s for %s\n",
1184 1.172 christos progname, gn->fname, gn->lineno, makeDependfile,
1185 1.172 christos gn->name);
1186 1.134 dsl return TRUE;
1187 1.134 dsl }
1188 1.134 dsl
1189 1.1 cgd if (gn->type & OP_OPTIONAL) {
1190 1.152 christos (void)fprintf(stdout, "%s%s %s (ignored)\n", progname,
1191 1.46 christos msg, gn->name);
1192 1.96 christos (void)fflush(stdout);
1193 1.1 cgd } else if (keepgoing) {
1194 1.152 christos (void)fprintf(stdout, "%s%s %s (continuing)\n", progname,
1195 1.46 christos msg, gn->name);
1196 1.96 christos (void)fflush(stdout);
1197 1.205 rillig return FALSE;
1198 1.1 cgd } else {
1199 1.46 christos (*abortProc)("%s%s %s. Stop", progname, msg, gn->name);
1200 1.12 christos return FALSE;
1201 1.1 cgd }
1202 1.1 cgd }
1203 1.1 cgd }
1204 1.12 christos return TRUE;
1205 1.1 cgd }
1206 1.1 cgd
1207 1.228 rillig /* Execute the shell for the given job. Called from JobStart
1208 1.1 cgd *
1209 1.228 rillig * A shell is executed, its output is altered and the Job structure added
1210 1.228 rillig * to the job table.
1211 1.1 cgd */
1212 1.1 cgd static void
1213 1.72 wiz JobExec(Job *job, char **argv)
1214 1.1 cgd {
1215 1.246 rillig int cpid; /* ID of new child */
1216 1.69 pk sigset_t mask;
1217 1.16 christos
1218 1.49 sjg job->flags &= ~JOB_TRACED;
1219 1.49 sjg
1220 1.1 cgd if (DEBUG(JOB)) {
1221 1.246 rillig int i;
1222 1.16 christos
1223 1.251 rillig debug_printf("Running %s %sly\n", job->node->name, "local");
1224 1.251 rillig debug_printf("\tCommand: ");
1225 1.12 christos for (i = 0; argv[i] != NULL; i++) {
1226 1.251 rillig debug_printf("%s ", argv[i]);
1227 1.1 cgd }
1228 1.251 rillig debug_printf("\n");
1229 1.1 cgd }
1230 1.16 christos
1231 1.1 cgd /*
1232 1.1 cgd * Some jobs produce no output and it's disconcerting to have
1233 1.16 christos * no feedback of their running (since they produce no output, the
1234 1.1 cgd * banner with their name in it never appears). This is an attempt to
1235 1.1 cgd * provide that feedback, even if nothing follows it.
1236 1.1 cgd */
1237 1.109 dsl if ((lastNode != job->node) && !(job->flags & JOB_SILENT)) {
1238 1.12 christos MESSAGE(stdout, job->node);
1239 1.1 cgd lastNode = job->node;
1240 1.1 cgd }
1241 1.16 christos
1242 1.69 pk /* No interruptions until this job is on the `jobs' list */
1243 1.69 pk JobSigLock(&mask);
1244 1.69 pk
1245 1.116 dsl /* Pre-emptively mark job running, pid still zero though */
1246 1.116 dsl job->job_state = JOB_ST_RUNNING;
1247 1.116 dsl
1248 1.149 sjg cpid = vFork();
1249 1.116 dsl if (cpid == -1)
1250 1.53 matt Punt("Cannot vfork: %s", strerror(errno));
1251 1.116 dsl
1252 1.116 dsl if (cpid == 0) {
1253 1.116 dsl /* Child */
1254 1.146 sjg sigset_t tmask;
1255 1.1 cgd
1256 1.155 sjg #ifdef USE_META
1257 1.155 sjg if (useMeta) {
1258 1.155 sjg meta_job_child(job);
1259 1.155 sjg }
1260 1.155 sjg #endif
1261 1.1 cgd /*
1262 1.69 pk * Reset all signal handlers; this is necessary because we also
1263 1.69 pk * need to unblock signals before we exec(2).
1264 1.69 pk */
1265 1.69 pk JobSigReset();
1266 1.69 pk
1267 1.69 pk /* Now unblock signals */
1268 1.146 sjg sigemptyset(&tmask);
1269 1.146 sjg JobSigUnlock(&tmask);
1270 1.69 pk
1271 1.69 pk /*
1272 1.1 cgd * Must duplicate the input stream down to the child's input and
1273 1.16 christos * reset it to the beginning (again). Since the stream was marked
1274 1.1 cgd * close-on-exec, we must clear that bit in the new input.
1275 1.1 cgd */
1276 1.264 rillig if (dup2(fileno(job->cmdFILE), 0) == -1)
1277 1.264 rillig execDie("dup2", "job->cmdFILE");
1278 1.264 rillig if (fcntl(0, F_SETFD, 0) == -1)
1279 1.264 rillig execDie("fcntl clear close-on-exec", "stdin");
1280 1.264 rillig if (lseek(0, (off_t)0, SEEK_SET) == -1)
1281 1.264 rillig execDie("lseek to 0", "stdin");
1282 1.16 christos
1283 1.177 christos if (job->node->type & (OP_MAKE | OP_SUBMAKE)) {
1284 1.40 sommerfe /*
1285 1.40 sommerfe * Pass job token pipe to submakes.
1286 1.40 sommerfe */
1287 1.264 rillig if (fcntl(tokenWaitJob.inPipe, F_SETFD, 0) == -1)
1288 1.264 rillig execDie("clear close-on-exec", "tokenWaitJob.inPipe");
1289 1.264 rillig if (fcntl(tokenWaitJob.outPipe, F_SETFD, 0) == -1)
1290 1.264 rillig execDie("clear close-on-exec", "tokenWaitJob.outPipe");
1291 1.40 sommerfe }
1292 1.201 rillig
1293 1.120 dsl /*
1294 1.120 dsl * Set up the child's output to be routed through the pipe
1295 1.120 dsl * we've created for it.
1296 1.120 dsl */
1297 1.264 rillig if (dup2(job->outPipe, 1) == -1)
1298 1.264 rillig execDie("dup2", "job->outPipe");
1299 1.264 rillig
1300 1.1 cgd /*
1301 1.1 cgd * The output channels are marked close on exec. This bit was
1302 1.96 christos * duplicated by the dup2(on some systems), so we have to clear
1303 1.1 cgd * it before routing the shell's error output to the same place as
1304 1.1 cgd * its standard output.
1305 1.1 cgd */
1306 1.264 rillig if (fcntl(1, F_SETFD, 0) == -1)
1307 1.264 rillig execDie("clear close-on-exec", "stdout");
1308 1.264 rillig if (dup2(1, 2) == -1)
1309 1.264 rillig execDie("dup2", "1, 2");
1310 1.1 cgd
1311 1.1 cgd /*
1312 1.1 cgd * We want to switch the child into a different process family so
1313 1.1 cgd * we can kill it and all its descendants in one fell swoop,
1314 1.1 cgd * by killing its process family, but not commit suicide.
1315 1.1 cgd */
1316 1.170 christos #if defined(MAKE_NATIVE) || defined(HAVE_SETPGID)
1317 1.119 dsl #if defined(SYSV)
1318 1.119 dsl /* XXX: dsl - I'm sure this should be setpgrp()... */
1319 1.97 christos (void)setsid();
1320 1.119 dsl #else
1321 1.96 christos (void)setpgid(0, getpid());
1322 1.119 dsl #endif
1323 1.170 christos #endif
1324 1.1 cgd
1325 1.126 sjg Var_ExportVars();
1326 1.126 sjg
1327 1.106 dsl (void)execv(shellPath, argv);
1328 1.264 rillig execDie("exec", shellPath);
1329 1.116 dsl }
1330 1.116 dsl
1331 1.116 dsl /* Parent, continuing after the child exec */
1332 1.116 dsl job->pid = cpid;
1333 1.1 cgd
1334 1.116 dsl Trace_Log(JOBSTART, job);
1335 1.40 sommerfe
1336 1.196 riastrad #ifdef USE_META
1337 1.196 riastrad if (useMeta) {
1338 1.196 riastrad meta_job_parent(job, cpid);
1339 1.196 riastrad }
1340 1.196 riastrad #endif
1341 1.196 riastrad
1342 1.120 dsl /*
1343 1.120 dsl * Set the current position in the buffer to the beginning
1344 1.120 dsl * and mark another stream to watch in the outputs mask
1345 1.120 dsl */
1346 1.120 dsl job->curPos = 0;
1347 1.16 christos
1348 1.120 dsl watchfd(job);
1349 1.1 cgd
1350 1.116 dsl if (job->cmdFILE != NULL && job->cmdFILE != stdout) {
1351 1.116 dsl (void)fclose(job->cmdFILE);
1352 1.116 dsl job->cmdFILE = NULL;
1353 1.1 cgd }
1354 1.1 cgd
1355 1.1 cgd /*
1356 1.1 cgd * Now the job is actually running, add it to the table.
1357 1.1 cgd */
1358 1.69 pk if (DEBUG(JOB)) {
1359 1.251 rillig debug_printf("JobExec(%s): pid %d added to jobs table\n",
1360 1.251 rillig job->node->name, job->pid);
1361 1.114 dsl job_table_dump("job started");
1362 1.69 pk }
1363 1.69 pk JobSigUnlock(&mask);
1364 1.1 cgd }
1365 1.1 cgd
1366 1.228 rillig /* Create the argv needed to execute the shell for a given job. */
1367 1.1 cgd static void
1368 1.72 wiz JobMakeArgv(Job *job, char **argv)
1369 1.1 cgd {
1370 1.246 rillig int argc;
1371 1.246 rillig static char args[10]; /* For merged arguments */
1372 1.16 christos
1373 1.77 christos argv[0] = UNCONST(shellName);
1374 1.1 cgd argc = 1;
1375 1.1 cgd
1376 1.229 rillig if ((commandShell->exit && commandShell->exit[0] != '-') ||
1377 1.229 rillig (commandShell->echo && commandShell->echo[0] != '-'))
1378 1.1 cgd {
1379 1.1 cgd /*
1380 1.1 cgd * At least one of the flags doesn't have a minus before it, so
1381 1.1 cgd * merge them together. Have to do this because the *(&(@*#*&#$#
1382 1.1 cgd * Bourne shell thinks its second argument is a file to source.
1383 1.1 cgd * Grrrr. Note the ten-character limitation on the combined arguments.
1384 1.1 cgd */
1385 1.29 christos (void)snprintf(args, sizeof(args), "-%s%s",
1386 1.1 cgd ((job->flags & JOB_IGNERR) ? "" :
1387 1.1 cgd (commandShell->exit ? commandShell->exit : "")),
1388 1.1 cgd ((job->flags & JOB_SILENT) ? "" :
1389 1.1 cgd (commandShell->echo ? commandShell->echo : "")));
1390 1.1 cgd
1391 1.1 cgd if (args[1]) {
1392 1.1 cgd argv[argc] = args;
1393 1.1 cgd argc++;
1394 1.1 cgd }
1395 1.1 cgd } else {
1396 1.1 cgd if (!(job->flags & JOB_IGNERR) && commandShell->exit) {
1397 1.77 christos argv[argc] = UNCONST(commandShell->exit);
1398 1.1 cgd argc++;
1399 1.1 cgd }
1400 1.1 cgd if (!(job->flags & JOB_SILENT) && commandShell->echo) {
1401 1.77 christos argv[argc] = UNCONST(commandShell->echo);
1402 1.1 cgd argc++;
1403 1.1 cgd }
1404 1.1 cgd }
1405 1.12 christos argv[argc] = NULL;
1406 1.1 cgd }
1407 1.1 cgd
1408 1.1 cgd /*-
1409 1.1 cgd *-----------------------------------------------------------------------
1410 1.1 cgd * JobStart --
1411 1.1 cgd * Start a target-creation process going for the target described
1412 1.16 christos * by the graph node gn.
1413 1.1 cgd *
1414 1.72 wiz * Input:
1415 1.72 wiz * gn target to create
1416 1.72 wiz * flags flags for the job to override normal ones.
1417 1.72 wiz * e.g. JOB_SPECIAL or JOB_IGNDOTS
1418 1.72 wiz * previous The previous Job structure for this node, if any.
1419 1.72 wiz *
1420 1.1 cgd * Results:
1421 1.1 cgd * JOB_ERROR if there was an error in the commands, JOB_FINISHED
1422 1.1 cgd * if there isn't actually anything left to do for the job and
1423 1.1 cgd * JOB_RUNNING if the job has been started.
1424 1.1 cgd *
1425 1.1 cgd * Side Effects:
1426 1.1 cgd * A new Job node is created and added to the list of running
1427 1.1 cgd * jobs. PMake is forked and a child shell created.
1428 1.110 dsl *
1429 1.110 dsl * NB: I'm fairly sure that this code is never called with JOB_SPECIAL set
1430 1.110 dsl * JOB_IGNDOTS is never set (dsl)
1431 1.122 dsl * Also the return value is ignored by everyone.
1432 1.1 cgd *-----------------------------------------------------------------------
1433 1.1 cgd */
1434 1.1 cgd static int
1435 1.108 dsl JobStart(GNode *gn, int flags)
1436 1.1 cgd {
1437 1.246 rillig Job *job; /* new job descriptor */
1438 1.246 rillig char *argv[10]; /* Argument vector to shell */
1439 1.246 rillig Boolean cmdsOK; /* true if the nodes commands were all right */
1440 1.246 rillig Boolean noExec; /* Set true if we decide not to run the job */
1441 1.246 rillig int tfd; /* File descriptor to the temp file */
1442 1.1 cgd
1443 1.114 dsl for (job = job_table; job < job_table_end; job++) {
1444 1.116 dsl if (job->job_state == JOB_ST_FREE)
1445 1.114 dsl break;
1446 1.114 dsl }
1447 1.114 dsl if (job >= job_table_end)
1448 1.122 dsl Punt("JobStart no job slots vacant");
1449 1.122 dsl
1450 1.114 dsl memset(job, 0, sizeof *job);
1451 1.116 dsl job->job_state = JOB_ST_SETUP;
1452 1.91 christos if (gn->type & OP_SPECIAL)
1453 1.91 christos flags |= JOB_SPECIAL;
1454 1.1 cgd
1455 1.1 cgd job->node = gn;
1456 1.142 dsl job->tailCmds = NULL;
1457 1.1 cgd
1458 1.1 cgd /*
1459 1.1 cgd * Set the initial value of the flags for this job based on the global
1460 1.1 cgd * ones and the node's attributes... Any flags supplied by the caller
1461 1.1 cgd * are also added to the field.
1462 1.1 cgd */
1463 1.1 cgd job->flags = 0;
1464 1.12 christos if (Targ_Ignore(gn)) {
1465 1.1 cgd job->flags |= JOB_IGNERR;
1466 1.1 cgd }
1467 1.12 christos if (Targ_Silent(gn)) {
1468 1.1 cgd job->flags |= JOB_SILENT;
1469 1.1 cgd }
1470 1.1 cgd job->flags |= flags;
1471 1.1 cgd
1472 1.1 cgd /*
1473 1.1 cgd * Check the commands now so any attributes from .DEFAULT have a chance
1474 1.1 cgd * to migrate to the node
1475 1.1 cgd */
1476 1.109 dsl cmdsOK = Job_CheckCommands(gn, Error);
1477 1.16 christos
1478 1.36 christos job->inPollfd = NULL;
1479 1.1 cgd /*
1480 1.16 christos * If the -n flag wasn't given, we open up OUR (not the child's)
1481 1.1 cgd * temporary file to stuff commands in it. The thing is rd/wr so we don't
1482 1.1 cgd * need to reopen it to feed it to the shell. If the -n flag *was* given,
1483 1.1 cgd * we just set the file to be stdout. Cute, huh?
1484 1.1 cgd */
1485 1.45 sommerfe if (((gn->type & OP_MAKE) && !(noRecursiveExecute)) ||
1486 1.122 dsl (!noExecute && !touchFlag)) {
1487 1.1 cgd /*
1488 1.34 christos * tfile is the name of a file into which all shell commands are
1489 1.145 apb * put. It is removed before the child shell is executed, unless
1490 1.145 apb * DEBUG(SCRIPT) is set.
1491 1.34 christos */
1492 1.145 apb char *tfile;
1493 1.69 pk sigset_t mask;
1494 1.34 christos /*
1495 1.1 cgd * We're serious here, but if the commands were bogus, we're
1496 1.1 cgd * also dead...
1497 1.1 cgd */
1498 1.1 cgd if (!cmdsOK) {
1499 1.154 sjg PrintOnError(gn, NULL); /* provide some clue */
1500 1.1 cgd DieHorribly();
1501 1.1 cgd }
1502 1.16 christos
1503 1.69 pk JobSigLock(&mask);
1504 1.148 sjg tfd = mkTempFile(TMPPAT, &tfile);
1505 1.94 jmc if (!DEBUG(SCRIPT))
1506 1.96 christos (void)eunlink(tfile);
1507 1.69 pk JobSigUnlock(&mask);
1508 1.31 christos
1509 1.31 christos job->cmdFILE = fdopen(tfd, "w+");
1510 1.12 christos if (job->cmdFILE == NULL) {
1511 1.31 christos Punt("Could not fdopen %s", tfile);
1512 1.1 cgd }
1513 1.262 rillig (void)fcntl(fileno(job->cmdFILE), F_SETFD, FD_CLOEXEC);
1514 1.1 cgd /*
1515 1.1 cgd * Send the commands to the command file, flush all its buffers then
1516 1.1 cgd * rewind and remove the thing.
1517 1.1 cgd */
1518 1.1 cgd noExec = FALSE;
1519 1.1 cgd
1520 1.155 sjg #ifdef USE_META
1521 1.155 sjg if (useMeta) {
1522 1.155 sjg meta_job_start(job, gn);
1523 1.159 sjg if (Targ_Silent(gn)) { /* might have changed */
1524 1.159 sjg job->flags |= JOB_SILENT;
1525 1.159 sjg }
1526 1.155 sjg }
1527 1.155 sjg #endif
1528 1.1 cgd /*
1529 1.107 dsl * We can do all the commands at once. hooray for sanity
1530 1.1 cgd */
1531 1.107 dsl numCommands = 0;
1532 1.269 rillig JobPrintCommands(job);
1533 1.16 christos
1534 1.107 dsl /*
1535 1.107 dsl * If we didn't print out any commands to the shell script,
1536 1.107 dsl * there's not much point in executing the shell, is there?
1537 1.107 dsl */
1538 1.107 dsl if (numCommands == 0) {
1539 1.107 dsl noExec = TRUE;
1540 1.1 cgd }
1541 1.145 apb
1542 1.145 apb free(tfile);
1543 1.45 sommerfe } else if (NoExecute(gn)) {
1544 1.1 cgd /*
1545 1.1 cgd * Not executing anything -- just print all the commands to stdout
1546 1.1 cgd * in one fell swoop. This will still set up job->tailCmds correctly.
1547 1.1 cgd */
1548 1.1 cgd if (lastNode != gn) {
1549 1.12 christos MESSAGE(stdout, gn);
1550 1.1 cgd lastNode = gn;
1551 1.1 cgd }
1552 1.1 cgd job->cmdFILE = stdout;
1553 1.1 cgd /*
1554 1.1 cgd * Only print the commands if they're ok, but don't die if they're
1555 1.1 cgd * not -- just let the user know they're bad and keep going. It
1556 1.1 cgd * doesn't do any harm in this case and may do some good.
1557 1.1 cgd */
1558 1.269 rillig if (cmdsOK)
1559 1.269 rillig JobPrintCommands(job);
1560 1.1 cgd /*
1561 1.1 cgd * Don't execute the shell, thank you.
1562 1.1 cgd */
1563 1.1 cgd noExec = TRUE;
1564 1.1 cgd } else {
1565 1.1 cgd /*
1566 1.1 cgd * Just touch the target and note that no shell should be executed.
1567 1.1 cgd * Set cmdFILE to stdout to make life easier. Check the commands, too,
1568 1.1 cgd * but don't die if they're no good -- it does no harm to keep working
1569 1.1 cgd * up the graph.
1570 1.1 cgd */
1571 1.1 cgd job->cmdFILE = stdout;
1572 1.205 rillig Job_Touch(gn, job->flags&JOB_SILENT);
1573 1.1 cgd noExec = TRUE;
1574 1.1 cgd }
1575 1.118 dsl /* Just in case it isn't already... */
1576 1.118 dsl (void)fflush(job->cmdFILE);
1577 1.1 cgd
1578 1.1 cgd /*
1579 1.16 christos * If we're not supposed to execute a shell, don't.
1580 1.1 cgd */
1581 1.1 cgd if (noExec) {
1582 1.110 dsl if (!(job->flags & JOB_SPECIAL))
1583 1.110 dsl Job_TokenReturn();
1584 1.1 cgd /*
1585 1.1 cgd * Unlink and close the command file if we opened one
1586 1.1 cgd */
1587 1.1 cgd if (job->cmdFILE != stdout) {
1588 1.34 christos if (job->cmdFILE != NULL) {
1589 1.96 christos (void)fclose(job->cmdFILE);
1590 1.34 christos job->cmdFILE = NULL;
1591 1.34 christos }
1592 1.1 cgd }
1593 1.1 cgd
1594 1.1 cgd /*
1595 1.1 cgd * We only want to work our way up the graph if we aren't here because
1596 1.1 cgd * the commands for the job were no good.
1597 1.1 cgd */
1598 1.118 dsl if (cmdsOK && aborting == 0) {
1599 1.236 rillig JobSaveCommands(job);
1600 1.118 dsl job->node->made = MADE;
1601 1.118 dsl Make_Update(job->node);
1602 1.1 cgd }
1603 1.118 dsl job->job_state = JOB_ST_FREE;
1604 1.118 dsl return cmdsOK ? JOB_FINISHED : JOB_ERROR;
1605 1.1 cgd }
1606 1.1 cgd
1607 1.1 cgd /*
1608 1.1 cgd * Set up the control arguments to the shell. This is based on the flags
1609 1.1 cgd * set earlier for this job.
1610 1.1 cgd */
1611 1.1 cgd JobMakeArgv(job, argv);
1612 1.1 cgd
1613 1.122 dsl /* Create the pipe by which we'll get the shell's output. */
1614 1.122 dsl JobCreatePipe(job, 3);
1615 1.1 cgd
1616 1.106 dsl JobExec(job, argv);
1617 1.200 rillig return JOB_RUNNING;
1618 1.1 cgd }
1619 1.1 cgd
1620 1.16 christos static char *
1621 1.260 rillig JobOutput(Job *job, char *cp, char *endp)
1622 1.12 christos {
1623 1.72 wiz char *ecp;
1624 1.12 christos
1625 1.260 rillig if (commandShell->noPrint && commandShell->noPrint[0] != '\0') {
1626 1.260 rillig while ((ecp = strstr(cp, commandShell->noPrint)) != NULL) {
1627 1.12 christos if (cp != ecp) {
1628 1.12 christos *ecp = '\0';
1629 1.12 christos /*
1630 1.12 christos * The only way there wouldn't be a newline after
1631 1.12 christos * this line is if it were the last in the buffer.
1632 1.12 christos * however, since the non-printable comes after it,
1633 1.12 christos * there must be a newline, so we don't print one.
1634 1.12 christos */
1635 1.96 christos (void)fprintf(stdout, "%s", cp);
1636 1.96 christos (void)fflush(stdout);
1637 1.12 christos }
1638 1.267 rillig cp = ecp + commandShell->noPrintLen;
1639 1.12 christos if (cp != endp) {
1640 1.12 christos /*
1641 1.12 christos * Still more to print, look again after skipping
1642 1.12 christos * the whitespace following the non-printable
1643 1.12 christos * command....
1644 1.12 christos */
1645 1.12 christos cp++;
1646 1.12 christos while (*cp == ' ' || *cp == '\t' || *cp == '\n') {
1647 1.12 christos cp++;
1648 1.12 christos }
1649 1.12 christos } else {
1650 1.12 christos return cp;
1651 1.12 christos }
1652 1.12 christos }
1653 1.12 christos }
1654 1.12 christos return cp;
1655 1.12 christos }
1656 1.12 christos
1657 1.1 cgd /*-
1658 1.1 cgd *-----------------------------------------------------------------------
1659 1.1 cgd * JobDoOutput --
1660 1.1 cgd * This function is called at different times depending on
1661 1.1 cgd * whether the user has specified that output is to be collected
1662 1.1 cgd * via pipes or temporary files. In the former case, we are called
1663 1.1 cgd * whenever there is something to read on the pipe. We collect more
1664 1.1 cgd * output from the given job and store it in the job's outBuf. If
1665 1.1 cgd * this makes up a line, we print it tagged by the job's identifier,
1666 1.1 cgd * as necessary.
1667 1.1 cgd * If output has been collected in a temporary file, we open the
1668 1.243 rillig * file and read it line by line, transferring it to our own
1669 1.1 cgd * output channel until the file is empty. At which point we
1670 1.1 cgd * remove the temporary file.
1671 1.1 cgd * In both cases, however, we keep our figurative eye out for the
1672 1.1 cgd * 'noPrint' line for the shell from which the output came. If
1673 1.1 cgd * we recognize a line, we don't print it. If the command is not
1674 1.16 christos * alone on the line (the character after it is not \0 or \n), we
1675 1.1 cgd * do print whatever follows it.
1676 1.1 cgd *
1677 1.72 wiz * Input:
1678 1.72 wiz * job the job whose output needs printing
1679 1.72 wiz * finish TRUE if this is the last time we'll be called
1680 1.72 wiz * for this job
1681 1.72 wiz *
1682 1.1 cgd * Results:
1683 1.1 cgd * None
1684 1.1 cgd *
1685 1.1 cgd * Side Effects:
1686 1.1 cgd * curPos may be shifted as may the contents of outBuf.
1687 1.1 cgd *-----------------------------------------------------------------------
1688 1.1 cgd */
1689 1.12 christos STATIC void
1690 1.72 wiz JobDoOutput(Job *job, Boolean finish)
1691 1.1 cgd {
1692 1.246 rillig Boolean gotNL = FALSE; /* true if got a newline */
1693 1.246 rillig Boolean fbuf; /* true if our buffer filled up */
1694 1.261 rillig size_t nr; /* number of bytes read */
1695 1.261 rillig size_t i; /* auxiliary index into outBuf */
1696 1.261 rillig size_t max; /* limit for i (end of current data) */
1697 1.261 rillig ssize_t nRead; /* (Temporary) number of bytes read */
1698 1.1 cgd
1699 1.120 dsl /*
1700 1.120 dsl * Read as many bytes as will fit in the buffer.
1701 1.120 dsl */
1702 1.1 cgd end_loop:
1703 1.120 dsl gotNL = FALSE;
1704 1.120 dsl fbuf = FALSE;
1705 1.16 christos
1706 1.120 dsl nRead = read(job->inPipe, &job->outBuf[job->curPos],
1707 1.139 christos JOB_BUFSIZE - job->curPos);
1708 1.120 dsl if (nRead < 0) {
1709 1.122 dsl if (errno == EAGAIN)
1710 1.122 dsl return;
1711 1.120 dsl if (DEBUG(JOB)) {
1712 1.120 dsl perror("JobDoOutput(piperead)");
1713 1.1 cgd }
1714 1.120 dsl nr = 0;
1715 1.120 dsl } else {
1716 1.261 rillig nr = (size_t)nRead;
1717 1.120 dsl }
1718 1.1 cgd
1719 1.120 dsl /*
1720 1.120 dsl * If we hit the end-of-file (the job is dead), we must flush its
1721 1.120 dsl * remaining output, so pretend we read a newline if there's any
1722 1.120 dsl * output remaining in the buffer.
1723 1.120 dsl * Also clear the 'finish' flag so we stop looping.
1724 1.120 dsl */
1725 1.120 dsl if ((nr == 0) && (job->curPos != 0)) {
1726 1.120 dsl job->outBuf[job->curPos] = '\n';
1727 1.120 dsl nr = 1;
1728 1.120 dsl finish = FALSE;
1729 1.120 dsl } else if (nr == 0) {
1730 1.120 dsl finish = FALSE;
1731 1.120 dsl }
1732 1.16 christos
1733 1.120 dsl /*
1734 1.120 dsl * Look for the last newline in the bytes we just got. If there is
1735 1.120 dsl * one, break out of the loop with 'i' as its index and gotNL set
1736 1.120 dsl * TRUE.
1737 1.120 dsl */
1738 1.120 dsl max = job->curPos + nr;
1739 1.261 rillig for (i = job->curPos + nr - 1; i >= job->curPos && i != (size_t)-1; i--) {
1740 1.139 christos if (job->outBuf[i] == '\n') {
1741 1.139 christos gotNL = TRUE;
1742 1.139 christos break;
1743 1.139 christos } else if (job->outBuf[i] == '\0') {
1744 1.139 christos /*
1745 1.139 christos * Why?
1746 1.139 christos */
1747 1.139 christos job->outBuf[i] = ' ';
1748 1.1 cgd }
1749 1.139 christos }
1750 1.16 christos
1751 1.120 dsl if (!gotNL) {
1752 1.120 dsl job->curPos += nr;
1753 1.120 dsl if (job->curPos == JOB_BUFSIZE) {
1754 1.1 cgd /*
1755 1.120 dsl * If we've run out of buffer space, we have no choice
1756 1.120 dsl * but to print the stuff. sigh.
1757 1.1 cgd */
1758 1.120 dsl fbuf = TRUE;
1759 1.120 dsl i = job->curPos;
1760 1.120 dsl }
1761 1.120 dsl }
1762 1.120 dsl if (gotNL || fbuf) {
1763 1.120 dsl /*
1764 1.120 dsl * Need to send the output to the screen. Null terminate it
1765 1.120 dsl * first, overwriting the newline character if there was one.
1766 1.120 dsl * So long as the line isn't one we should filter (according
1767 1.120 dsl * to the shell description), we print the line, preceded
1768 1.120 dsl * by a target banner if this target isn't the same as the
1769 1.120 dsl * one for which we last printed something.
1770 1.120 dsl * The rest of the data in the buffer are then shifted down
1771 1.120 dsl * to the start of the buffer and curPos is set accordingly.
1772 1.120 dsl */
1773 1.120 dsl job->outBuf[i] = '\0';
1774 1.120 dsl if (i >= job->curPos) {
1775 1.120 dsl char *cp;
1776 1.16 christos
1777 1.260 rillig cp = JobOutput(job, job->outBuf, &job->outBuf[i]);
1778 1.1 cgd
1779 1.120 dsl /*
1780 1.120 dsl * There's still more in that thar buffer. This time, though,
1781 1.120 dsl * we know there's no newline at the end, so we add one of
1782 1.120 dsl * our own free will.
1783 1.120 dsl */
1784 1.120 dsl if (*cp != '\0') {
1785 1.120 dsl if (!beSilent && job->node != lastNode) {
1786 1.120 dsl MESSAGE(stdout, job->node);
1787 1.120 dsl lastNode = job->node;
1788 1.1 cgd }
1789 1.155 sjg #ifdef USE_META
1790 1.155 sjg if (useMeta) {
1791 1.155 sjg meta_job_output(job, cp, gotNL ? "\n" : "");
1792 1.155 sjg }
1793 1.155 sjg #endif
1794 1.120 dsl (void)fprintf(stdout, "%s%s", cp, gotNL ? "\n" : "");
1795 1.120 dsl (void)fflush(stdout);
1796 1.1 cgd }
1797 1.120 dsl }
1798 1.180 joerg /*
1799 1.180 joerg * max is the last offset still in the buffer. Move any remaining
1800 1.180 joerg * characters to the start of the buffer and update the end marker
1801 1.180 joerg * curPos.
1802 1.180 joerg */
1803 1.180 joerg if (i < max) {
1804 1.180 joerg (void)memmove(job->outBuf, &job->outBuf[i + 1], max - (i + 1));
1805 1.180 joerg job->curPos = max - (i + 1);
1806 1.180 joerg } else {
1807 1.180 joerg assert(i == max);
1808 1.180 joerg job->curPos = 0;
1809 1.180 joerg }
1810 1.120 dsl }
1811 1.120 dsl if (finish) {
1812 1.1 cgd /*
1813 1.120 dsl * If the finish flag is true, we must loop until we hit
1814 1.120 dsl * end-of-file on the pipe. This is guaranteed to happen
1815 1.120 dsl * eventually since the other end of the pipe is now closed
1816 1.120 dsl * (we closed it explicitly and the child has exited). When
1817 1.120 dsl * we do get an EOF, finish will be set FALSE and we'll fall
1818 1.120 dsl * through and out.
1819 1.120 dsl */
1820 1.120 dsl goto end_loop;
1821 1.1 cgd }
1822 1.1 cgd }
1823 1.1 cgd
1824 1.91 christos static void
1825 1.91 christos JobRun(GNode *targ)
1826 1.91 christos {
1827 1.238 rillig #if 0
1828 1.91 christos /*
1829 1.238 rillig * Unfortunately it is too complicated to run .BEGIN, .END, and
1830 1.238 rillig * .INTERRUPT job in the parallel job module. As of 2020-09-25,
1831 1.238 rillig * unit-tests/deptgt-end-jobs.mk hangs in an endless loop.
1832 1.238 rillig *
1833 1.238 rillig * Running these jobs in compat mode also guarantees that these
1834 1.238 rillig * jobs do not overlap with other unrelated jobs.
1835 1.91 christos */
1836 1.265 rillig List *lst = Lst_New();
1837 1.220 rillig Lst_Append(lst, targ);
1838 1.91 christos (void)Make_Run(lst);
1839 1.142 dsl Lst_Destroy(lst, NULL);
1840 1.108 dsl JobStart(targ, JOB_SPECIAL);
1841 1.110 dsl while (jobTokensRunning) {
1842 1.91 christos Job_CatchOutput();
1843 1.91 christos }
1844 1.91 christos #else
1845 1.91 christos Compat_Make(targ, targ);
1846 1.91 christos if (targ->made == ERROR) {
1847 1.147 sjg PrintOnError(targ, "\n\nStop.");
1848 1.91 christos exit(1);
1849 1.91 christos }
1850 1.91 christos #endif
1851 1.91 christos }
1852 1.91 christos
1853 1.243 rillig /* Handle the exit of a child. Called from Make_Make.
1854 1.1 cgd *
1855 1.243 rillig * The job descriptor is removed from the list of children.
1856 1.1 cgd *
1857 1.1 cgd * Notes:
1858 1.1 cgd * We do waits, blocking or not, according to the wisdom of our
1859 1.1 cgd * caller, until there are no more children to report. For each
1860 1.118 dsl * job, call JobFinish to finish things off.
1861 1.1 cgd */
1862 1.1 cgd void
1863 1.120 dsl Job_CatchChildren(void)
1864 1.1 cgd {
1865 1.246 rillig int pid; /* pid of dead child */
1866 1.246 rillig int status; /* Exit/termination status */
1867 1.1 cgd
1868 1.1 cgd /*
1869 1.1 cgd * Don't even bother if we know there's no one around.
1870 1.1 cgd */
1871 1.116 dsl if (jobTokensRunning == 0)
1872 1.1 cgd return;
1873 1.16 christos
1874 1.120 dsl while ((pid = waitpid((pid_t) -1, &status, WNOHANG | WUNTRACED)) > 0) {
1875 1.250 rillig DEBUG2(JOB, "Process %d exited/stopped status %x.\n", pid, status);
1876 1.153 sjg JobReapChild(pid, status, TRUE);
1877 1.153 sjg }
1878 1.153 sjg }
1879 1.153 sjg
1880 1.153 sjg /*
1881 1.153 sjg * It is possible that wait[pid]() was called from elsewhere,
1882 1.153 sjg * this lets us reap jobs regardless.
1883 1.153 sjg */
1884 1.153 sjg void
1885 1.153 sjg JobReapChild(pid_t pid, int status, Boolean isJobs)
1886 1.153 sjg {
1887 1.246 rillig Job *job; /* job descriptor for dead child */
1888 1.153 sjg
1889 1.153 sjg /*
1890 1.153 sjg * Don't even bother if we know there's no one around.
1891 1.153 sjg */
1892 1.153 sjg if (jobTokensRunning == 0)
1893 1.153 sjg return;
1894 1.16 christos
1895 1.153 sjg job = JobFindPid(pid, JOB_ST_RUNNING, isJobs);
1896 1.153 sjg if (job == NULL) {
1897 1.153 sjg if (isJobs) {
1898 1.117 dsl if (!lurking_children)
1899 1.139 christos Error("Child (%d) status %x not in table?", pid, status);
1900 1.116 dsl }
1901 1.153 sjg return; /* not ours */
1902 1.153 sjg }
1903 1.153 sjg if (WIFSTOPPED(status)) {
1904 1.250 rillig DEBUG2(JOB, "Process %d (%s) stopped.\n", job->pid, job->node->name);
1905 1.153 sjg if (!make_suspended) {
1906 1.153 sjg switch (WSTOPSIG(status)) {
1907 1.153 sjg case SIGTSTP:
1908 1.153 sjg (void)printf("*** [%s] Suspended\n", job->node->name);
1909 1.153 sjg break;
1910 1.153 sjg case SIGSTOP:
1911 1.153 sjg (void)printf("*** [%s] Stopped\n", job->node->name);
1912 1.153 sjg break;
1913 1.153 sjg default:
1914 1.153 sjg (void)printf("*** [%s] Stopped -- signal %d\n",
1915 1.153 sjg job->node->name, WSTOPSIG(status));
1916 1.1 cgd }
1917 1.153 sjg job->job_suspended = 1;
1918 1.1 cgd }
1919 1.153 sjg (void)fflush(stdout);
1920 1.153 sjg return;
1921 1.153 sjg }
1922 1.1 cgd
1923 1.153 sjg job->job_state = JOB_ST_FINISHED;
1924 1.153 sjg job->exit_status = status;
1925 1.116 dsl
1926 1.153 sjg JobFinish(job, status);
1927 1.1 cgd }
1928 1.1 cgd
1929 1.243 rillig /* Catch the output from our children, if we're using pipes do so. Otherwise
1930 1.243 rillig * just block time until we get a signal(most likely a SIGCHLD) since there's
1931 1.243 rillig * no point in just spinning when there's nothing to do and the reaping of a
1932 1.243 rillig * child can wait for a while. */
1933 1.1 cgd void
1934 1.72 wiz Job_CatchOutput(void)
1935 1.1 cgd {
1936 1.122 dsl int nready;
1937 1.122 dsl Job *job;
1938 1.261 rillig unsigned int i;
1939 1.1 cgd
1940 1.96 christos (void)fflush(stdout);
1941 1.105 dsl
1942 1.120 dsl /* The first fd in the list is the job token pipe */
1943 1.169 christos do {
1944 1.169 christos nready = poll(fds + 1 - wantToken, nfds - 1 + wantToken, POLL_MSEC);
1945 1.169 christos } while (nready < 0 && errno == EINTR);
1946 1.169 christos
1947 1.169 christos if (nready < 0)
1948 1.169 christos Punt("poll: %s", strerror(errno));
1949 1.120 dsl
1950 1.169 christos if (nready > 0 && readyfd(&childExitJob)) {
1951 1.120 dsl char token = 0;
1952 1.169 christos ssize_t count;
1953 1.169 christos count = read(childExitJob.inPipe, &token, 1);
1954 1.169 christos switch (count) {
1955 1.169 christos case 0:
1956 1.169 christos Punt("unexpected eof on token pipe");
1957 1.169 christos case -1:
1958 1.169 christos Punt("token pipe read: %s", strerror(errno));
1959 1.169 christos case 1:
1960 1.169 christos if (token == DO_JOB_RESUME[0])
1961 1.169 christos /* Complete relay requested from our SIGCONT handler */
1962 1.169 christos JobRestartJobs();
1963 1.169 christos break;
1964 1.169 christos default:
1965 1.169 christos abort();
1966 1.169 christos }
1967 1.169 christos --nready;
1968 1.120 dsl }
1969 1.120 dsl
1970 1.169 christos Job_CatchChildren();
1971 1.169 christos if (nready == 0)
1972 1.261 rillig return;
1973 1.122 dsl
1974 1.261 rillig for (i = npseudojobs * nfds_per_job(); i < nfds; i++) {
1975 1.122 dsl if (!fds[i].revents)
1976 1.122 dsl continue;
1977 1.122 dsl job = jobfds[i];
1978 1.169 christos if (job->job_state == JOB_ST_RUNNING)
1979 1.169 christos JobDoOutput(job, FALSE);
1980 1.197 sjg #if defined(USE_FILEMON) && !defined(USE_FILEMON_DEV)
1981 1.196 riastrad /*
1982 1.196 riastrad * With meta mode, we may have activity on the job's filemon
1983 1.196 riastrad * descriptor too, which at the moment is any pollfd other than
1984 1.196 riastrad * job->inPollfd.
1985 1.196 riastrad */
1986 1.196 riastrad if (useMeta && job->inPollfd != &fds[i]) {
1987 1.196 riastrad if (meta_job_event(job) <= 0) {
1988 1.196 riastrad fds[i].events = 0; /* never mind */
1989 1.196 riastrad }
1990 1.196 riastrad }
1991 1.196 riastrad #endif
1992 1.169 christos if (--nready == 0)
1993 1.261 rillig return;
1994 1.1 cgd }
1995 1.1 cgd }
1996 1.1 cgd
1997 1.243 rillig /* Start the creation of a target. Basically a front-end for JobStart used by
1998 1.243 rillig * the Make module. */
1999 1.1 cgd void
2000 1.72 wiz Job_Make(GNode *gn)
2001 1.1 cgd {
2002 1.108 dsl (void)JobStart(gn, 0);
2003 1.1 cgd }
2004 1.1 cgd
2005 1.81 sjg void
2006 1.120 dsl Shell_Init(void)
2007 1.81 sjg {
2008 1.81 sjg if (shellPath == NULL) {
2009 1.81 sjg /*
2010 1.127 sjg * We are using the default shell, which may be an absolute
2011 1.133 apb * path if DEFSHELL_CUSTOM is defined.
2012 1.81 sjg */
2013 1.81 sjg shellName = commandShell->name;
2014 1.133 apb #ifdef DEFSHELL_CUSTOM
2015 1.127 sjg if (*shellName == '/') {
2016 1.127 sjg shellPath = shellName;
2017 1.127 sjg shellName = strrchr(shellPath, '/');
2018 1.127 sjg shellName++;
2019 1.127 sjg } else
2020 1.127 sjg #endif
2021 1.206 rillig shellPath = str_concat3(_PATH_DEFSHELLDIR, "/", shellName);
2022 1.81 sjg }
2023 1.213 sjg Var_Set_with_flags(".SHELL", shellPath, VAR_CMD, VAR_SET_READONLY);
2024 1.81 sjg if (commandShell->exit == NULL) {
2025 1.81 sjg commandShell->exit = "";
2026 1.81 sjg }
2027 1.81 sjg if (commandShell->echo == NULL) {
2028 1.81 sjg commandShell->echo = "";
2029 1.81 sjg }
2030 1.229 rillig if (commandShell->hasErrCtl && commandShell->exit[0] != '\0') {
2031 1.174 sjg if (shellErrFlag &&
2032 1.174 sjg strcmp(commandShell->exit, &shellErrFlag[1]) != 0) {
2033 1.174 sjg free(shellErrFlag);
2034 1.174 sjg shellErrFlag = NULL;
2035 1.174 sjg }
2036 1.174 sjg if (!shellErrFlag) {
2037 1.261 rillig size_t n = strlen(commandShell->exit) + 2;
2038 1.174 sjg
2039 1.174 sjg shellErrFlag = bmake_malloc(n);
2040 1.174 sjg if (shellErrFlag) {
2041 1.174 sjg snprintf(shellErrFlag, n, "-%s", commandShell->exit);
2042 1.174 sjg }
2043 1.174 sjg }
2044 1.174 sjg } else if (shellErrFlag) {
2045 1.174 sjg free(shellErrFlag);
2046 1.174 sjg shellErrFlag = NULL;
2047 1.174 sjg }
2048 1.81 sjg }
2049 1.81 sjg
2050 1.243 rillig /* Return the string literal that is used in the current command shell
2051 1.243 rillig * to produce a newline character. */
2052 1.112 rillig const char *
2053 1.112 rillig Shell_GetNewline(void)
2054 1.112 rillig {
2055 1.112 rillig return commandShell->newline;
2056 1.112 rillig }
2057 1.112 rillig
2058 1.125 sjg void
2059 1.125 sjg Job_SetPrefix(void)
2060 1.125 sjg {
2061 1.125 sjg if (targPrefix) {
2062 1.125 sjg free(targPrefix);
2063 1.126 sjg } else if (!Var_Exists(MAKE_JOB_PREFIX, VAR_GLOBAL)) {
2064 1.199 rillig Var_Set(MAKE_JOB_PREFIX, "---", VAR_GLOBAL);
2065 1.125 sjg }
2066 1.128 dsl
2067 1.234 rillig (void)Var_Subst("${" MAKE_JOB_PREFIX "}",
2068 1.234 rillig VAR_GLOBAL, VARE_WANTRES, &targPrefix);
2069 1.234 rillig /* TODO: handle errors */
2070 1.125 sjg }
2071 1.125 sjg
2072 1.222 rillig /* Initialize the process module. */
2073 1.1 cgd void
2074 1.111 dsl Job_Init(void)
2075 1.1 cgd {
2076 1.176 sjg Job_SetPrefix();
2077 1.114 dsl /* Allocate space for all the job info */
2078 1.261 rillig job_table = bmake_malloc((size_t)maxJobs * sizeof *job_table);
2079 1.261 rillig memset(job_table, 0, (size_t)maxJobs * sizeof *job_table);
2080 1.114 dsl job_table_end = job_table + maxJobs;
2081 1.120 dsl wantToken = 0;
2082 1.1 cgd
2083 1.246 rillig aborting = 0;
2084 1.246 rillig errors = 0;
2085 1.1 cgd
2086 1.246 rillig lastNode = NULL;
2087 1.1 cgd
2088 1.117 dsl /*
2089 1.117 dsl * There is a non-zero chance that we already have children.
2090 1.117 dsl * eg after 'make -f- <<EOF'
2091 1.117 dsl * Since their termination causes a 'Child (pid) not in table' message,
2092 1.117 dsl * Collect the status of any that are already dead, and suppress the
2093 1.117 dsl * error message if there are any undead ones.
2094 1.117 dsl */
2095 1.117 dsl for (;;) {
2096 1.117 dsl int rval, status;
2097 1.117 dsl rval = waitpid((pid_t) -1, &status, WNOHANG);
2098 1.117 dsl if (rval > 0)
2099 1.117 dsl continue;
2100 1.117 dsl if (rval == 0)
2101 1.117 dsl lurking_children = 1;
2102 1.117 dsl break;
2103 1.117 dsl }
2104 1.117 dsl
2105 1.81 sjg Shell_Init();
2106 1.1 cgd
2107 1.122 dsl JobCreatePipe(&childExitJob, 3);
2108 1.73 gson
2109 1.196 riastrad /* Preallocate enough for the maximum number of jobs. */
2110 1.196 riastrad fds = bmake_malloc(sizeof(*fds) *
2111 1.261 rillig (npseudojobs + (size_t)maxJobs) * nfds_per_job());
2112 1.196 riastrad jobfds = bmake_malloc(sizeof(*jobfds) *
2113 1.261 rillig (npseudojobs + (size_t)maxJobs) * nfds_per_job());
2114 1.122 dsl
2115 1.122 dsl /* These are permanent entries and take slots 0 and 1 */
2116 1.122 dsl watchfd(&tokenWaitJob);
2117 1.122 dsl watchfd(&childExitJob);
2118 1.73 gson
2119 1.69 pk sigemptyset(&caught_signals);
2120 1.1 cgd /*
2121 1.73 gson * Install a SIGCHLD handler.
2122 1.1 cgd */
2123 1.150 sjg (void)bmake_signal(SIGCHLD, JobChildSig);
2124 1.69 pk sigaddset(&caught_signals, SIGCHLD);
2125 1.69 pk
2126 1.69 pk #define ADDSIG(s,h) \
2127 1.150 sjg if (bmake_signal(s, SIG_IGN) != SIG_IGN) { \
2128 1.69 pk sigaddset(&caught_signals, s); \
2129 1.150 sjg (void)bmake_signal(s, h); \
2130 1.1 cgd }
2131 1.69 pk
2132 1.37 sommerfe /*
2133 1.69 pk * Catch the four signals that POSIX specifies if they aren't ignored.
2134 1.69 pk * JobPassSig will take care of calling JobInterrupt if appropriate.
2135 1.37 sommerfe */
2136 1.116 dsl ADDSIG(SIGINT, JobPassSig_int)
2137 1.116 dsl ADDSIG(SIGHUP, JobPassSig_term)
2138 1.116 dsl ADDSIG(SIGTERM, JobPassSig_term)
2139 1.116 dsl ADDSIG(SIGQUIT, JobPassSig_term)
2140 1.69 pk
2141 1.1 cgd /*
2142 1.1 cgd * There are additional signals that need to be caught and passed if
2143 1.1 cgd * either the export system wants to be told directly of signals or if
2144 1.16 christos * we're giving each job its own process group (since then it won't get
2145 1.1 cgd * signals from the terminal driver as we own the terminal)
2146 1.1 cgd */
2147 1.116 dsl ADDSIG(SIGTSTP, JobPassSig_suspend)
2148 1.116 dsl ADDSIG(SIGTTOU, JobPassSig_suspend)
2149 1.116 dsl ADDSIG(SIGTTIN, JobPassSig_suspend)
2150 1.116 dsl ADDSIG(SIGWINCH, JobCondPassSig)
2151 1.69 pk ADDSIG(SIGCONT, JobContinueSig)
2152 1.69 pk #undef ADDSIG
2153 1.16 christos
2154 1.172 christos (void)Job_RunTarget(".BEGIN", NULL);
2155 1.235 rillig /* Create the .END node now, even though no code in the unit tests
2156 1.235 rillig * depends on it. See also Targ_GetEndNode in Compat_Run. */
2157 1.235 rillig (void)Targ_GetEndNode();
2158 1.1 cgd }
2159 1.1 cgd
2160 1.72 wiz static void JobSigReset(void)
2161 1.69 pk {
2162 1.69 pk #define DELSIG(s) \
2163 1.69 pk if (sigismember(&caught_signals, s)) { \
2164 1.150 sjg (void)bmake_signal(s, SIG_DFL); \
2165 1.69 pk }
2166 1.69 pk
2167 1.69 pk DELSIG(SIGINT)
2168 1.69 pk DELSIG(SIGHUP)
2169 1.69 pk DELSIG(SIGQUIT)
2170 1.69 pk DELSIG(SIGTERM)
2171 1.69 pk DELSIG(SIGTSTP)
2172 1.69 pk DELSIG(SIGTTOU)
2173 1.69 pk DELSIG(SIGTTIN)
2174 1.69 pk DELSIG(SIGWINCH)
2175 1.69 pk DELSIG(SIGCONT)
2176 1.69 pk #undef DELSIG
2177 1.150 sjg (void)bmake_signal(SIGCHLD, SIG_DFL);
2178 1.69 pk }
2179 1.69 pk
2180 1.222 rillig /* Find a shell in 'shells' given its name, or return NULL. */
2181 1.1 cgd static Shell *
2182 1.77 christos JobMatchShell(const char *name)
2183 1.1 cgd {
2184 1.66 pk Shell *sh;
2185 1.1 cgd
2186 1.1 cgd for (sh = shells; sh->name != NULL; sh++) {
2187 1.66 pk if (strcmp(name, sh->name) == 0)
2188 1.200 rillig return sh;
2189 1.1 cgd }
2190 1.142 dsl return NULL;
2191 1.1 cgd }
2192 1.1 cgd
2193 1.1 cgd /*-
2194 1.1 cgd *-----------------------------------------------------------------------
2195 1.1 cgd * Job_ParseShell --
2196 1.1 cgd * Parse a shell specification and set up commandShell, shellPath
2197 1.1 cgd * and shellName appropriately.
2198 1.1 cgd *
2199 1.72 wiz * Input:
2200 1.72 wiz * line The shell spec
2201 1.72 wiz *
2202 1.1 cgd * Results:
2203 1.224 rillig * FALSE if the specification was incorrect.
2204 1.1 cgd *
2205 1.1 cgd * Side Effects:
2206 1.1 cgd * commandShell points to a Shell structure (either predefined or
2207 1.1 cgd * created from the shell spec), shellPath is the full path of the
2208 1.1 cgd * shell described by commandShell, while shellName is just the
2209 1.1 cgd * final component of shellPath.
2210 1.1 cgd *
2211 1.1 cgd * Notes:
2212 1.1 cgd * A shell specification consists of a .SHELL target, with dependency
2213 1.1 cgd * operator, followed by a series of blank-separated words. Double
2214 1.1 cgd * quotes can be used to use blanks in words. A backslash escapes
2215 1.1 cgd * anything (most notably a double-quote and a space) and
2216 1.1 cgd * provides the functionality it does in C. Each word consists of
2217 1.1 cgd * keyword and value separated by an equal sign. There should be no
2218 1.1 cgd * unnecessary spaces in the word. The keywords are as follows:
2219 1.246 rillig * name Name of shell.
2220 1.246 rillig * path Location of shell.
2221 1.246 rillig * quiet Command to turn off echoing.
2222 1.246 rillig * echo Command to turn echoing on
2223 1.246 rillig * filter Result of turning off echoing that shouldn't be
2224 1.246 rillig * printed.
2225 1.246 rillig * echoFlag Flag to turn echoing on at the start
2226 1.246 rillig * errFlag Flag to turn error checking on at the start
2227 1.246 rillig * hasErrCtl True if shell has error checking control
2228 1.246 rillig * newline String literal to represent a newline char
2229 1.246 rillig * check Command to turn on error checking if hasErrCtl
2230 1.246 rillig * is TRUE or template of command to echo a command
2231 1.246 rillig * for which error checking is off if hasErrCtl is
2232 1.246 rillig * FALSE.
2233 1.246 rillig * ignore Command to turn off error checking if hasErrCtl
2234 1.246 rillig * is TRUE or template of command to execute a
2235 1.246 rillig * command so as to ignore any errors it returns if
2236 1.246 rillig * hasErrCtl is FALSE.
2237 1.1 cgd *
2238 1.1 cgd *-----------------------------------------------------------------------
2239 1.1 cgd */
2240 1.224 rillig Boolean
2241 1.72 wiz Job_ParseShell(char *line)
2242 1.1 cgd {
2243 1.227 rillig Words wordsList;
2244 1.65 pk char **words;
2245 1.65 pk char **argv;
2246 1.215 rillig size_t argc;
2247 1.65 pk char *path;
2248 1.65 pk Shell newShell;
2249 1.65 pk Boolean fullSpec = FALSE;
2250 1.66 pk Shell *sh;
2251 1.1 cgd
2252 1.260 rillig pp_skip_whitespace(&line);
2253 1.22 christos
2254 1.209 rillig free(shellArgv);
2255 1.22 christos
2256 1.97 christos memset(&newShell, 0, sizeof(newShell));
2257 1.16 christos
2258 1.1 cgd /*
2259 1.1 cgd * Parse the specification by keyword
2260 1.1 cgd */
2261 1.227 rillig wordsList = Str_Words(line, TRUE);
2262 1.227 rillig words = wordsList.words;
2263 1.227 rillig argc = wordsList.len;
2264 1.227 rillig path = wordsList.freeIt;
2265 1.143 christos if (words == NULL) {
2266 1.143 christos Error("Unterminated quoted string [%s]", line);
2267 1.224 rillig return FALSE;
2268 1.143 christos }
2269 1.77 christos shellArgv = path;
2270 1.65 pk
2271 1.65 pk for (path = NULL, argv = words; argc != 0; argc--, argv++) {
2272 1.245 rillig char *arg = *argv;
2273 1.245 rillig if (strncmp(arg, "path=", 5) == 0) {
2274 1.245 rillig path = arg + 5;
2275 1.245 rillig } else if (strncmp(arg, "name=", 5) == 0) {
2276 1.245 rillig newShell.name = arg + 5;
2277 1.244 rillig } else {
2278 1.245 rillig if (strncmp(arg, "quiet=", 6) == 0) {
2279 1.245 rillig newShell.echoOff = arg + 6;
2280 1.245 rillig } else if (strncmp(arg, "echo=", 5) == 0) {
2281 1.245 rillig newShell.echoOn = arg + 5;
2282 1.245 rillig } else if (strncmp(arg, "filter=", 7) == 0) {
2283 1.245 rillig newShell.noPrint = arg + 7;
2284 1.267 rillig newShell.noPrintLen = strlen(newShell.noPrint);
2285 1.245 rillig } else if (strncmp(arg, "echoFlag=", 9) == 0) {
2286 1.245 rillig newShell.echo = arg + 9;
2287 1.245 rillig } else if (strncmp(arg, "errFlag=", 8) == 0) {
2288 1.245 rillig newShell.exit = arg + 8;
2289 1.245 rillig } else if (strncmp(arg, "hasErrCtl=", 10) == 0) {
2290 1.245 rillig char c = arg[10];
2291 1.244 rillig newShell.hasErrCtl = !((c != 'Y') && (c != 'y') &&
2292 1.244 rillig (c != 'T') && (c != 't'));
2293 1.245 rillig } else if (strncmp(arg, "newline=", 8) == 0) {
2294 1.245 rillig newShell.newline = arg + 8;
2295 1.245 rillig } else if (strncmp(arg, "check=", 6) == 0) {
2296 1.245 rillig newShell.errCheck = arg + 6;
2297 1.245 rillig } else if (strncmp(arg, "ignore=", 7) == 0) {
2298 1.245 rillig newShell.ignErr = arg + 7;
2299 1.245 rillig } else if (strncmp(arg, "errout=", 7) == 0) {
2300 1.245 rillig newShell.errOut = arg + 7;
2301 1.245 rillig } else if (strncmp(arg, "comment=", 8) == 0) {
2302 1.245 rillig newShell.commentChar = arg[8];
2303 1.22 christos } else {
2304 1.245 rillig Parse_Error(PARSE_FATAL, "Unknown keyword \"%s\"", arg);
2305 1.244 rillig free(words);
2306 1.244 rillig return FALSE;
2307 1.22 christos }
2308 1.244 rillig fullSpec = TRUE;
2309 1.244 rillig }
2310 1.1 cgd }
2311 1.1 cgd
2312 1.12 christos if (path == NULL) {
2313 1.1 cgd /*
2314 1.1 cgd * If no path was given, the user wants one of the pre-defined shells,
2315 1.1 cgd * yes? So we find the one s/he wants with the help of JobMatchShell
2316 1.1 cgd * and set things up the right way. shellPath will be set up by
2317 1.163 sjg * Shell_Init.
2318 1.1 cgd */
2319 1.12 christos if (newShell.name == NULL) {
2320 1.12 christos Parse_Error(PARSE_FATAL, "Neither path nor name specified");
2321 1.66 pk free(words);
2322 1.224 rillig return FALSE;
2323 1.1 cgd } else {
2324 1.66 pk if ((sh = JobMatchShell(newShell.name)) == NULL) {
2325 1.66 pk Parse_Error(PARSE_WARNING, "%s: No matching shell",
2326 1.66 pk newShell.name);
2327 1.66 pk free(words);
2328 1.224 rillig return FALSE;
2329 1.66 pk }
2330 1.66 pk commandShell = sh;
2331 1.1 cgd shellName = newShell.name;
2332 1.163 sjg if (shellPath) {
2333 1.163 sjg /* Shell_Init has already been called! Do it again. */
2334 1.163 sjg free(UNCONST(shellPath));
2335 1.163 sjg shellPath = NULL;
2336 1.163 sjg Shell_Init();
2337 1.163 sjg }
2338 1.1 cgd }
2339 1.1 cgd } else {
2340 1.1 cgd /*
2341 1.16 christos * The user provided a path. If s/he gave nothing else (fullSpec is
2342 1.1 cgd * FALSE), try and find a matching shell in the ones we know of.
2343 1.1 cgd * Else we just take the specification at its word and copy it
2344 1.1 cgd * to a new location. In either case, we need to record the
2345 1.1 cgd * path the user gave for the shell.
2346 1.1 cgd */
2347 1.1 cgd shellPath = path;
2348 1.12 christos path = strrchr(path, '/');
2349 1.12 christos if (path == NULL) {
2350 1.77 christos path = UNCONST(shellPath);
2351 1.1 cgd } else {
2352 1.252 rillig path++;
2353 1.1 cgd }
2354 1.12 christos if (newShell.name != NULL) {
2355 1.1 cgd shellName = newShell.name;
2356 1.1 cgd } else {
2357 1.1 cgd shellName = path;
2358 1.1 cgd }
2359 1.1 cgd if (!fullSpec) {
2360 1.66 pk if ((sh = JobMatchShell(shellName)) == NULL) {
2361 1.66 pk Parse_Error(PARSE_WARNING, "%s: No matching shell",
2362 1.66 pk shellName);
2363 1.66 pk free(words);
2364 1.224 rillig return FALSE;
2365 1.66 pk }
2366 1.66 pk commandShell = sh;
2367 1.1 cgd } else {
2368 1.140 joerg commandShell = bmake_malloc(sizeof(Shell));
2369 1.1 cgd *commandShell = newShell;
2370 1.1 cgd }
2371 1.174 sjg /* this will take care of shellErrFlag */
2372 1.174 sjg Shell_Init();
2373 1.1 cgd }
2374 1.1 cgd
2375 1.1 cgd if (commandShell->echoOn && commandShell->echoOff) {
2376 1.1 cgd commandShell->hasEchoCtl = TRUE;
2377 1.1 cgd }
2378 1.16 christos
2379 1.1 cgd if (!commandShell->hasErrCtl) {
2380 1.12 christos if (commandShell->errCheck == NULL) {
2381 1.1 cgd commandShell->errCheck = "";
2382 1.1 cgd }
2383 1.12 christos if (commandShell->ignErr == NULL) {
2384 1.1 cgd commandShell->ignErr = "%s\n";
2385 1.1 cgd }
2386 1.1 cgd }
2387 1.16 christos
2388 1.1 cgd /*
2389 1.1 cgd * Do not free up the words themselves, since they might be in use by the
2390 1.22 christos * shell specification.
2391 1.1 cgd */
2392 1.12 christos free(words);
2393 1.224 rillig return TRUE;
2394 1.1 cgd }
2395 1.1 cgd
2396 1.243 rillig /* Handle the receipt of an interrupt.
2397 1.243 rillig *
2398 1.243 rillig * All children are killed. Another job will be started if the .INTERRUPT
2399 1.243 rillig * target is defined.
2400 1.1 cgd *
2401 1.72 wiz * Input:
2402 1.72 wiz * runINTERRUPT Non-zero if commands for the .INTERRUPT target
2403 1.72 wiz * should be executed
2404 1.72 wiz * signo signal received
2405 1.1 cgd */
2406 1.1 cgd static void
2407 1.72 wiz JobInterrupt(int runINTERRUPT, int signo)
2408 1.69 pk {
2409 1.69 pk Job *job; /* job descriptor in that element */
2410 1.69 pk GNode *interrupt; /* the node describing the .INTERRUPT target */
2411 1.69 pk sigset_t mask;
2412 1.114 dsl GNode *gn;
2413 1.16 christos
2414 1.1 cgd aborting = ABORT_INTERRUPT;
2415 1.1 cgd
2416 1.69 pk JobSigLock(&mask);
2417 1.69 pk
2418 1.114 dsl for (job = job_table; job < job_table_end; job++) {
2419 1.116 dsl if (job->job_state != JOB_ST_RUNNING)
2420 1.114 dsl continue;
2421 1.67 pk
2422 1.67 pk gn = job->node;
2423 1.1 cgd
2424 1.188 dholland JobDeleteTarget(gn);
2425 1.1 cgd if (job->pid) {
2426 1.250 rillig DEBUG2(JOB, "JobInterrupt passing signal %d to child %d.\n",
2427 1.250 rillig signo, job->pid);
2428 1.116 dsl KILLPG(job->pid, signo);
2429 1.12 christos }
2430 1.12 christos }
2431 1.12 christos
2432 1.69 pk JobSigUnlock(&mask);
2433 1.69 pk
2434 1.1 cgd if (runINTERRUPT && !touchFlag) {
2435 1.239 rillig interrupt = Targ_FindNode(".INTERRUPT");
2436 1.142 dsl if (interrupt != NULL) {
2437 1.1 cgd ignoreErrors = FALSE;
2438 1.91 christos JobRun(interrupt);
2439 1.1 cgd }
2440 1.1 cgd }
2441 1.40 sommerfe Trace_Log(MAKEINTR, 0);
2442 1.12 christos exit(signo);
2443 1.1 cgd }
2444 1.1 cgd
2445 1.235 rillig /* Do the final processing, i.e. run the commands attached to the .END target.
2446 1.1 cgd *
2447 1.243 rillig * Return the number of errors reported. */
2448 1.1 cgd int
2449 1.72 wiz Job_Finish(void)
2450 1.1 cgd {
2451 1.235 rillig GNode *endNode = Targ_GetEndNode();
2452 1.235 rillig if (!Lst_IsEmpty(endNode->commands) || !Lst_IsEmpty(endNode->children)) {
2453 1.1 cgd if (errors) {
2454 1.12 christos Error("Errors reported so .END ignored");
2455 1.1 cgd } else {
2456 1.235 rillig JobRun(endNode);
2457 1.1 cgd }
2458 1.1 cgd }
2459 1.200 rillig return errors;
2460 1.22 christos }
2461 1.22 christos
2462 1.243 rillig /* Clean up any memory used by the jobs module. */
2463 1.22 christos void
2464 1.72 wiz Job_End(void)
2465 1.22 christos {
2466 1.30 mycroft #ifdef CLEANUP
2467 1.185 christos free(shellArgv);
2468 1.30 mycroft #endif
2469 1.1 cgd }
2470 1.1 cgd
2471 1.243 rillig /* Waits for all running jobs to finish and returns.
2472 1.243 rillig * Sets 'aborting' to ABORT_WAIT to prevent other jobs from starting. */
2473 1.1 cgd void
2474 1.72 wiz Job_Wait(void)
2475 1.1 cgd {
2476 1.1 cgd aborting = ABORT_WAIT;
2477 1.110 dsl while (jobTokensRunning != 0) {
2478 1.1 cgd Job_CatchOutput();
2479 1.1 cgd }
2480 1.1 cgd aborting = 0;
2481 1.1 cgd }
2482 1.1 cgd
2483 1.243 rillig /* Abort all currently running jobs without handling output or anything.
2484 1.243 rillig * This function is to be called only in the event of a major error.
2485 1.243 rillig * Most definitely NOT to be called from JobInterrupt.
2486 1.1 cgd *
2487 1.243 rillig * All children are killed, not just the firstborn. */
2488 1.1 cgd void
2489 1.72 wiz Job_AbortAll(void)
2490 1.1 cgd {
2491 1.63 pk Job *job; /* the job descriptor in that element */
2492 1.63 pk int foo;
2493 1.16 christos
2494 1.1 cgd aborting = ABORT_ERROR;
2495 1.16 christos
2496 1.110 dsl if (jobTokensRunning) {
2497 1.114 dsl for (job = job_table; job < job_table_end; job++) {
2498 1.116 dsl if (job->job_state != JOB_ST_RUNNING)
2499 1.114 dsl continue;
2500 1.1 cgd /*
2501 1.1 cgd * kill the child process with increasingly drastic signals to make
2502 1.16 christos * darn sure it's dead.
2503 1.1 cgd */
2504 1.116 dsl KILLPG(job->pid, SIGINT);
2505 1.116 dsl KILLPG(job->pid, SIGKILL);
2506 1.1 cgd }
2507 1.1 cgd }
2508 1.16 christos
2509 1.1 cgd /*
2510 1.1 cgd * Catch as many children as want to report in at first, then give up
2511 1.1 cgd */
2512 1.13 christos while (waitpid((pid_t) -1, &foo, WNOHANG) > 0)
2513 1.5 cgd continue;
2514 1.12 christos }
2515 1.12 christos
2516 1.243 rillig /* Tries to restart stopped jobs if there are slots available.
2517 1.243 rillig * Called in process context in response to a SIGCONT. */
2518 1.12 christos static void
2519 1.72 wiz JobRestartJobs(void)
2520 1.12 christos {
2521 1.114 dsl Job *job;
2522 1.69 pk
2523 1.114 dsl for (job = job_table; job < job_table_end; job++) {
2524 1.118 dsl if (job->job_state == JOB_ST_RUNNING &&
2525 1.118 dsl (make_suspended || job->job_suspended)) {
2526 1.250 rillig DEBUG1(JOB, "Restarting stopped job pid %d.\n", job->pid);
2527 1.118 dsl if (job->job_suspended) {
2528 1.118 dsl (void)printf("*** [%s] Continued\n", job->node->name);
2529 1.118 dsl (void)fflush(stdout);
2530 1.118 dsl }
2531 1.118 dsl job->job_suspended = 0;
2532 1.116 dsl if (KILLPG(job->pid, SIGCONT) != 0 && DEBUG(JOB)) {
2533 1.251 rillig debug_printf("Failed to send SIGCONT to %d\n", job->pid);
2534 1.116 dsl }
2535 1.12 christos }
2536 1.116 dsl if (job->job_state == JOB_ST_FINISHED)
2537 1.116 dsl /* Job exit deferred after calling waitpid() in a signal handler */
2538 1.116 dsl JobFinish(job, job->exit_status);
2539 1.12 christos }
2540 1.118 dsl make_suspended = 0;
2541 1.1 cgd }
2542 1.35 christos
2543 1.35 christos static void
2544 1.72 wiz watchfd(Job *job)
2545 1.35 christos {
2546 1.36 christos if (job->inPollfd != NULL)
2547 1.36 christos Punt("Watching watched job");
2548 1.35 christos
2549 1.36 christos fds[nfds].fd = job->inPipe;
2550 1.39 mycroft fds[nfds].events = POLLIN;
2551 1.39 mycroft jobfds[nfds] = job;
2552 1.36 christos job->inPollfd = &fds[nfds];
2553 1.39 mycroft nfds++;
2554 1.197 sjg #if defined(USE_FILEMON) && !defined(USE_FILEMON_DEV)
2555 1.196 riastrad if (useMeta) {
2556 1.196 riastrad fds[nfds].fd = meta_job_fd(job);
2557 1.196 riastrad fds[nfds].events = fds[nfds].fd == -1 ? 0 : POLLIN;
2558 1.196 riastrad jobfds[nfds] = job;
2559 1.196 riastrad nfds++;
2560 1.196 riastrad }
2561 1.196 riastrad #endif
2562 1.35 christos }
2563 1.35 christos
2564 1.35 christos static void
2565 1.72 wiz clearfd(Job *job)
2566 1.35 christos {
2567 1.261 rillig size_t i;
2568 1.36 christos if (job->inPollfd == NULL)
2569 1.36 christos Punt("Unwatching unwatched job");
2570 1.261 rillig i = (size_t)(job->inPollfd - fds);
2571 1.36 christos nfds--;
2572 1.197 sjg #if defined(USE_FILEMON) && !defined(USE_FILEMON_DEV)
2573 1.196 riastrad if (useMeta) {
2574 1.196 riastrad /*
2575 1.196 riastrad * Sanity check: there should be two fds per job, so the job's
2576 1.196 riastrad * pollfd number should be even.
2577 1.196 riastrad */
2578 1.196 riastrad assert(nfds_per_job() == 2);
2579 1.196 riastrad if (i % 2)
2580 1.196 riastrad Punt("odd-numbered fd with meta");
2581 1.196 riastrad nfds--;
2582 1.196 riastrad }
2583 1.196 riastrad #endif
2584 1.38 sommerfe /*
2585 1.38 sommerfe * Move last job in table into hole made by dead job.
2586 1.38 sommerfe */
2587 1.36 christos if (nfds != i) {
2588 1.38 sommerfe fds[i] = fds[nfds];
2589 1.38 sommerfe jobfds[i] = jobfds[nfds];
2590 1.38 sommerfe jobfds[i]->inPollfd = &fds[i];
2591 1.197 sjg #if defined(USE_FILEMON) && !defined(USE_FILEMON_DEV)
2592 1.196 riastrad if (useMeta) {
2593 1.196 riastrad fds[i + 1] = fds[nfds + 1];
2594 1.196 riastrad jobfds[i + 1] = jobfds[nfds + 1];
2595 1.196 riastrad }
2596 1.196 riastrad #endif
2597 1.36 christos }
2598 1.36 christos job->inPollfd = NULL;
2599 1.35 christos }
2600 1.35 christos
2601 1.35 christos static int
2602 1.72 wiz readyfd(Job *job)
2603 1.35 christos {
2604 1.36 christos if (job->inPollfd == NULL)
2605 1.36 christos Punt("Polling unwatched job");
2606 1.36 christos return (job->inPollfd->revents & POLLIN) != 0;
2607 1.35 christos }
2608 1.40 sommerfe
2609 1.243 rillig /* Put a token (back) into the job pipe.
2610 1.243 rillig * This allows a make process to start a build job. */
2611 1.40 sommerfe static void
2612 1.72 wiz JobTokenAdd(void)
2613 1.40 sommerfe {
2614 1.101 dsl char tok = JOB_TOKENS[aborting], tok1;
2615 1.101 dsl
2616 1.101 dsl /* If we are depositing an error token flush everything else */
2617 1.122 dsl while (tok != '+' && read(tokenWaitJob.inPipe, &tok1, 1) == 1)
2618 1.101 dsl continue;
2619 1.40 sommerfe
2620 1.250 rillig DEBUG3(JOB, "(%d) aborting %d, deposit token %c\n",
2621 1.250 rillig getpid(), aborting, JOB_TOKENS[aborting]);
2622 1.165 christos while (write(tokenWaitJob.outPipe, &tok, 1) == -1 && errno == EAGAIN)
2623 1.165 christos continue;
2624 1.40 sommerfe }
2625 1.40 sommerfe
2626 1.243 rillig /* Prep the job token pipe in the root make process. */
2627 1.72 wiz void
2628 1.122 dsl Job_ServerStart(int max_tokens, int jp_0, int jp_1)
2629 1.40 sommerfe {
2630 1.122 dsl int i;
2631 1.40 sommerfe char jobarg[64];
2632 1.201 rillig
2633 1.122 dsl if (jp_0 >= 0 && jp_1 >= 0) {
2634 1.122 dsl /* Pipe passed in from parent */
2635 1.122 dsl tokenWaitJob.inPipe = jp_0;
2636 1.122 dsl tokenWaitJob.outPipe = jp_1;
2637 1.183 christos (void)fcntl(jp_0, F_SETFD, FD_CLOEXEC);
2638 1.183 christos (void)fcntl(jp_1, F_SETFD, FD_CLOEXEC);
2639 1.122 dsl return;
2640 1.100 dsl }
2641 1.100 dsl
2642 1.122 dsl JobCreatePipe(&tokenWaitJob, 15);
2643 1.40 sommerfe
2644 1.122 dsl snprintf(jobarg, sizeof(jobarg), "%d,%d",
2645 1.122 dsl tokenWaitJob.inPipe, tokenWaitJob.outPipe);
2646 1.40 sommerfe
2647 1.40 sommerfe Var_Append(MAKEFLAGS, "-J", VAR_GLOBAL);
2648 1.201 rillig Var_Append(MAKEFLAGS, jobarg, VAR_GLOBAL);
2649 1.101 dsl
2650 1.40 sommerfe /*
2651 1.122 dsl * Preload the job pipe with one token per job, save the one
2652 1.40 sommerfe * "extra" token for the primary job.
2653 1.201 rillig *
2654 1.122 dsl * XXX should clip maxJobs against PIPE_BUF -- if max_tokens is
2655 1.40 sommerfe * larger than the write buffer size of the pipe, we will
2656 1.40 sommerfe * deadlock here.
2657 1.40 sommerfe */
2658 1.122 dsl for (i = 1; i < max_tokens; i++)
2659 1.40 sommerfe JobTokenAdd();
2660 1.40 sommerfe }
2661 1.40 sommerfe
2662 1.243 rillig /* Return a withdrawn token to the pool. */
2663 1.40 sommerfe void
2664 1.72 wiz Job_TokenReturn(void)
2665 1.40 sommerfe {
2666 1.44 sommerfe jobTokensRunning--;
2667 1.44 sommerfe if (jobTokensRunning < 0)
2668 1.40 sommerfe Punt("token botch");
2669 1.102 dsl if (jobTokensRunning || JOB_TOKENS[aborting] != '+')
2670 1.101 dsl JobTokenAdd();
2671 1.40 sommerfe }
2672 1.40 sommerfe
2673 1.243 rillig /* Attempt to withdraw a token from the pool.
2674 1.40 sommerfe *
2675 1.243 rillig * If pool is empty, set wantToken so that we wake up when a token is
2676 1.243 rillig * released.
2677 1.40 sommerfe *
2678 1.243 rillig * Returns TRUE if a token was withdrawn, and FALSE if the pool is currently
2679 1.243 rillig * empty. */
2680 1.40 sommerfe Boolean
2681 1.72 wiz Job_TokenWithdraw(void)
2682 1.40 sommerfe {
2683 1.101 dsl char tok, tok1;
2684 1.261 rillig ssize_t count;
2685 1.40 sommerfe
2686 1.120 dsl wantToken = 0;
2687 1.250 rillig DEBUG3(JOB, "Job_TokenWithdraw(%d): aborting %d, running %d\n",
2688 1.250 rillig getpid(), aborting, jobTokensRunning);
2689 1.60 enami
2690 1.111 dsl if (aborting || (jobTokensRunning >= maxJobs))
2691 1.102 dsl return FALSE;
2692 1.40 sommerfe
2693 1.122 dsl count = read(tokenWaitJob.inPipe, &tok, 1);
2694 1.40 sommerfe if (count == 0)
2695 1.40 sommerfe Fatal("eof on job pipe!");
2696 1.194 christos if (count < 0 && jobTokensRunning != 0) {
2697 1.40 sommerfe if (errno != EAGAIN) {
2698 1.40 sommerfe Fatal("job pipe read: %s", strerror(errno));
2699 1.40 sommerfe }
2700 1.250 rillig DEBUG1(JOB, "(%d) blocked for token\n", getpid());
2701 1.194 christos return FALSE;
2702 1.40 sommerfe }
2703 1.102 dsl
2704 1.102 dsl if (count == 1 && tok != '+') {
2705 1.120 dsl /* make being abvorted - remove any other job tokens */
2706 1.250 rillig DEBUG2(JOB, "(%d) aborted by token %c\n", getpid(), tok);
2707 1.122 dsl while (read(tokenWaitJob.inPipe, &tok1, 1) == 1)
2708 1.101 dsl continue;
2709 1.101 dsl /* And put the stopper back */
2710 1.165 christos while (write(tokenWaitJob.outPipe, &tok, 1) == -1 && errno == EAGAIN)
2711 1.165 christos continue;
2712 1.198 sjg if (dieQuietly(NULL, 1))
2713 1.198 sjg exit(2);
2714 1.102 dsl Fatal("A failure has been detected in another branch of the parallel make");
2715 1.101 dsl }
2716 1.102 dsl
2717 1.102 dsl if (count == 1 && jobTokensRunning == 0)
2718 1.102 dsl /* We didn't want the token really */
2719 1.165 christos while (write(tokenWaitJob.outPipe, &tok, 1) == -1 && errno == EAGAIN)
2720 1.165 christos continue;
2721 1.102 dsl
2722 1.44 sommerfe jobTokensRunning++;
2723 1.250 rillig DEBUG1(JOB, "(%d) withdrew token\n", getpid());
2724 1.40 sommerfe return TRUE;
2725 1.41 sommerfe }
2726 1.41 sommerfe
2727 1.243 rillig /* Run the named target if found. If a filename is specified, then set that
2728 1.243 rillig * to the sources.
2729 1.172 christos *
2730 1.243 rillig * Exits if the target fails. */
2731 1.172 christos Boolean
2732 1.172 christos Job_RunTarget(const char *target, const char *fname) {
2733 1.239 rillig GNode *gn = Targ_FindNode(target);
2734 1.172 christos if (gn == NULL)
2735 1.172 christos return FALSE;
2736 1.172 christos
2737 1.172 christos if (fname)
2738 1.199 rillig Var_Set(ALLSRC, fname, gn);
2739 1.172 christos
2740 1.172 christos JobRun(gn);
2741 1.172 christos if (gn->made == ERROR) {
2742 1.172 christos PrintOnError(gn, "\n\nStop.");
2743 1.172 christos exit(1);
2744 1.172 christos }
2745 1.172 christos return TRUE;
2746 1.172 christos }
2747 1.172 christos
2748 1.73 gson #ifdef USE_SELECT
2749 1.73 gson int
2750 1.73 gson emul_poll(struct pollfd *fd, int nfd, int timeout)
2751 1.73 gson {
2752 1.73 gson fd_set rfds, wfds;
2753 1.73 gson int i, maxfd, nselect, npoll;
2754 1.73 gson struct timeval tv, *tvp;
2755 1.73 gson long usecs;
2756 1.73 gson
2757 1.73 gson FD_ZERO(&rfds);
2758 1.73 gson FD_ZERO(&wfds);
2759 1.73 gson
2760 1.73 gson maxfd = -1;
2761 1.73 gson for (i = 0; i < nfd; i++) {
2762 1.73 gson fd[i].revents = 0;
2763 1.73 gson
2764 1.73 gson if (fd[i].events & POLLIN)
2765 1.73 gson FD_SET(fd[i].fd, &rfds);
2766 1.73 gson
2767 1.73 gson if (fd[i].events & POLLOUT)
2768 1.73 gson FD_SET(fd[i].fd, &wfds);
2769 1.73 gson
2770 1.73 gson if (fd[i].fd > maxfd)
2771 1.73 gson maxfd = fd[i].fd;
2772 1.73 gson }
2773 1.201 rillig
2774 1.73 gson if (maxfd >= FD_SETSIZE) {
2775 1.201 rillig Punt("Ran out of fd_set slots; "
2776 1.73 gson "recompile with a larger FD_SETSIZE.");
2777 1.73 gson }
2778 1.73 gson
2779 1.73 gson if (timeout < 0) {
2780 1.73 gson tvp = NULL;
2781 1.73 gson } else {
2782 1.73 gson usecs = timeout * 1000;
2783 1.73 gson tv.tv_sec = usecs / 1000000;
2784 1.73 gson tv.tv_usec = usecs % 1000000;
2785 1.205 rillig tvp = &tv;
2786 1.73 gson }
2787 1.73 gson
2788 1.73 gson nselect = select(maxfd + 1, &rfds, &wfds, 0, tvp);
2789 1.73 gson
2790 1.73 gson if (nselect <= 0)
2791 1.73 gson return nselect;
2792 1.73 gson
2793 1.73 gson npoll = 0;
2794 1.73 gson for (i = 0; i < nfd; i++) {
2795 1.73 gson if (FD_ISSET(fd[i].fd, &rfds))
2796 1.73 gson fd[i].revents |= POLLIN;
2797 1.73 gson
2798 1.73 gson if (FD_ISSET(fd[i].fd, &wfds))
2799 1.73 gson fd[i].revents |= POLLOUT;
2800 1.73 gson
2801 1.73 gson if (fd[i].revents)
2802 1.73 gson npoll++;
2803 1.73 gson }
2804 1.73 gson
2805 1.73 gson return npoll;
2806 1.73 gson }
2807 1.73 gson #endif /* USE_SELECT */
2808