2 * Copyright (c) 1988, 1989, 1990, 1993
3 * The Regents of the University of California. All rights reserved.
4 * Copyright (c) 1988, 1989 by Adam de Boor
5 * Copyright (c) 1989 by Berkeley Softworks
8 * This code is derived from software contributed to Berkeley by
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the University of
22 * California, Berkeley and its contributors.
23 * 4. Neither the name of the University nor the names of its contributors
24 * may be used to endorse or promote products derived from this software
25 * without specific prior written permission.
27 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39 * from: @(#)job.h 8.1 (Berkeley) 6/6/93
40 * $FreeBSD: src/usr.bin/make/job.h,v 1.11 2000/01/17 06:43:41 kris Exp $
41 * $DragonFly: src/usr.bin/make/job.h,v 1.8 2004/11/12 22:57:04 dillon Exp $
46 * Definitions pertaining to the running of jobs in parallel mode.
47 * Exported from job.c for the use of remote-execution modules.
52 #define TMPPAT "/tmp/makeXXXXXXXXXX"
55 * The SEL_ constants determine the maximum amount of time spent in select
56 * before coming out to see if a child has finished. SEL_SEC is the number of
57 * seconds and SEL_USEC is the number of micro-seconds
60 #define SEL_USEC 100000
64 * Job Table definitions.
66 * Each job has several things associated with it:
67 * 1) The process id of the child shell
68 * 2) The graph node describing the target being made by this job
69 * 3) A LstNode for the first command to be saved after the job
70 * completes. This is NULL if there was no "..." in the job's
72 * 4) An FILE* for writing out the commands. This is only
73 * used before the job is actually started.
74 * 5) A union of things used for handling the shell's output. Different
75 * parts of the union are used based on the value of the usePipes
76 * flag. If it is true, the output is being caught via a pipe and
77 * the descriptors of our pipe, an array in which output is line
78 * buffered and the current position in that buffer are all
79 * maintained for each job. If, on the other hand, usePipes is false,
80 * the output is routed to a temporary file and all that is kept
81 * is the name of the file and the descriptor open to the file.
82 * 6) An identifier provided by and for the exclusive use of the
84 * 7) A word of flags which determine how the module handles errors,
85 * echoing, etc. for the job
87 * The job "table" is kept as a linked Lst in 'jobs', with the number of
88 * active jobs maintained in the 'nJobs' variable. At no time will this
89 * exceed the value of 'maxJobs', initialized by the Job_Init function.
91 * When a job is finished, the Make_Update function is called on each of the
92 * parents of the node which was just remade. This takes care of the upward
93 * traversal of the dependency graph.
95 #define JOB_BUFSIZE 1024
97 int pid; /* The child's process ID */
98 char tfile[sizeof(TMPPAT)];
99 /* Temporary file to use for job */
100 GNode *node; /* The target the child is making */
101 LstNode tailCmds; /* The node of the first command to be
102 * saved when the job has been run */
103 FILE *cmdFILE; /* When creating the shell script, this is
104 * where the commands go */
105 int rmtID; /* ID returned from Rmt module */
106 short flags; /* Flags to control treatment of job */
107 #define JOB_IGNERR 0x001 /* Ignore non-zero exits */
108 #define JOB_SILENT 0x002 /* no output */
109 #define JOB_SPECIAL 0x004 /* Target is a special one. i.e. run it locally
110 * if we can't export it and maxLocal is 0 */
111 #define JOB_IGNDOTS 0x008 /* Ignore "..." lines when processing
113 #define JOB_REMOTE 0x010 /* Job is running remotely */
114 #define JOB_FIRST 0x020 /* Job is first job for the node */
115 #define JOB_REMIGRATE 0x040 /* Job needs to be remigrated */
116 #define JOB_RESTART 0x080 /* Job needs to be completely restarted */
117 #define JOB_RESUME 0x100 /* Job needs to be resumed b/c it stopped,
119 #define JOB_CONTINUING 0x200 /* We are in the process of resuming this job.
120 * Used to avoid infinite recursion between
121 * JobFinish and JobRestart */
124 int op_inPipe; /* Input side of pipe associated
125 * with job's output channel */
126 int op_outPipe; /* Output side of pipe associated with
127 * job's output channel */
128 char op_outBuf[JOB_BUFSIZE + 1];
129 /* Buffer for storing the output of the
130 * job, line by line */
131 int op_curPos; /* Current position in op_outBuf */
132 } o_pipe; /* data used when catching the output via
135 char of_outFile[sizeof(TMPPAT)];
136 /* Name of file to which shell output
138 int of_outFd; /* Stream open to the output
139 * file. Used to funnel all
140 * from a single job to one file
141 * while still allowing
142 * multiple shell invocations */
143 } o_file; /* Data used when catching the output in
144 * a temporary file */
145 } output; /* Data for tracking a shell's output */
148 #define outPipe output.o_pipe.op_outPipe
149 #define inPipe output.o_pipe.op_inPipe
150 #define outBuf output.o_pipe.op_outBuf
151 #define curPos output.o_pipe.op_curPos
152 #define outFile output.o_file.of_outFile
153 #define outFd output.o_file.of_outFd
157 * Shell Specifications:
158 * Each shell type has associated with it the following information:
159 * 1) The string which must match the last character of the shell name
160 * for the shell to be considered of this type. The longest match
162 * 2) A command to issue to turn off echoing of command lines
163 * 3) A command to issue to turn echoing back on again
164 * 4) What the shell prints, and its length, when given the echo-off
165 * command. This line will not be printed when received from the shell
166 * 5) A boolean to tell if the shell has the ability to control
167 * error checking for individual commands.
168 * 6) The string to turn this checking on.
169 * 7) The string to turn it off.
170 * 8) The command-flag to give to cause the shell to start echoing
171 * commands right away.
172 * 9) The command-flag to cause the shell to Lib_Exit when an error is
173 * detected in one of the commands.
175 * Some special stuff goes on if a shell doesn't have error control. In such
176 * a case, errCheck becomes a printf template for echoing the command,
177 * should echoing be on and ignErr becomes another printf template for
178 * executing the command while ignoring the return status. If either of these
179 * strings is empty when hasErrCtl is FALSE, the command will be executed
180 * anyway as is and if it causes an error, so be it.
182 typedef struct Shell {
183 char *name; /* the name of the shell. For Bourne and C
184 * shells, this is used only to find the
185 * shell description when used as the single
186 * source of a .SHELL target. For user-defined
187 * shells, this is the full path of the shell.
189 Boolean hasEchoCtl; /* True if both echoOff and echoOn defined */
190 char *echoOff; /* command to turn off echo */
191 char *echoOn; /* command to turn it back on again */
192 char *noPrint; /* command to skip when printing output from
193 * shell. This is usually the command which
194 * was executed to turn off echoing */
195 int noPLen; /* length of noPrint command */
196 Boolean hasErrCtl; /* set if can control error checking for
197 * individual commands */
198 char *errCheck; /* string to turn error checking on */
199 char *ignErr; /* string to turn off error checking */
203 char *echo; /* echo commands */
204 char *exit; /* exit on error */
208 extern char *targFmt; /* Format string for banner that separates
209 * output from multiple jobs. Contains a
210 * single %s where the name of the node being
211 * made should be put. */
212 extern GNode *lastNode; /* Last node for which a banner was printed.
213 * If Rmt module finds it necessary to print
214 * a banner, it should set this to the node
215 * for which the banner was printed */
216 extern int nJobs; /* Number of jobs running (local and remote) */
217 extern int nLocal; /* Number of jobs running locally */
218 extern Lst jobs; /* List of active job descriptors */
219 extern Lst stoppedJobs; /* List of jobs that are stopped or didn't
220 * quite get started */
221 extern Boolean jobFull; /* Non-zero if no more jobs should/will start*/
222 extern int maxJobs; /* Number of jobs that may run */
224 void Job_Touch(GNode *, Boolean);
225 Boolean Job_CheckCommands(GNode *, void (*abortProc)(const char *, ...));
226 void Job_CatchChildren(Boolean);
227 void Job_CatchOutput(void);
228 void Job_Make(GNode *);
229 void Job_Init(int, int);
230 Boolean Job_Full(void);
231 Boolean Job_Empty(void);
232 ReturnStatus Job_ParseShell(char *);
233 int Job_Finish(void);
235 void Job_AbortAll(void);
236 void JobFlagForMigration(int);