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.12 2004/12/01 02:02:14 joerg 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"
56 * The SEL_ constants determine the maximum amount of time spent in select
57 * before coming out to see if a child has finished. SEL_SEC is the number of
58 * seconds and SEL_USEC is the number of micro-seconds
62 #endif /* !USE_KQUEUE */
66 * Job Table definitions.
68 * Each job has several things associated with it:
69 * 1) The process id of the child shell
70 * 2) The graph node describing the target being made by this job
71 * 3) A LstNode for the first command to be saved after the job
72 * completes. This is NULL if there was no "..." in the job's
74 * 4) An FILE* for writing out the commands. This is only
75 * used before the job is actually started.
76 * 5) A union of things used for handling the shell's output. Different
77 * parts of the union are used based on the value of the usePipes
78 * flag. If it is true, the output is being caught via a pipe and
79 * the descriptors of our pipe, an array in which output is line
80 * buffered and the current position in that buffer are all
81 * maintained for each job. If, on the other hand, usePipes is false,
82 * the output is routed to a temporary file and all that is kept
83 * is the name of the file and the descriptor open to the file.
84 * 6) 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 short flags; /* Flags to control treatment of job */
106 #define JOB_IGNERR 0x001 /* Ignore non-zero exits */
107 #define JOB_SILENT 0x002 /* no output */
108 #define JOB_SPECIAL 0x004 /* Target is a special one. i.e. run it locally
109 * if we can't export it and maxLocal is 0 */
110 #define JOB_IGNDOTS 0x008 /* Ignore "..." lines when processing
112 #define JOB_FIRST 0x020 /* Job is first job for the node */
113 #define JOB_RESTART 0x080 /* Job needs to be completely restarted */
114 #define JOB_RESUME 0x100 /* Job needs to be resumed b/c it stopped,
116 #define JOB_CONTINUING 0x200 /* We are in the process of resuming this job.
117 * Used to avoid infinite recursion between
118 * JobFinish and JobRestart */
121 int op_inPipe; /* Input side of pipe associated
122 * with job's output channel */
123 int op_outPipe; /* Output side of pipe associated with
124 * job's output channel */
125 char op_outBuf[JOB_BUFSIZE + 1];
126 /* Buffer for storing the output of the
127 * job, line by line */
128 int op_curPos; /* Current position in op_outBuf */
129 } o_pipe; /* data used when catching the output via
132 char of_outFile[sizeof(TMPPAT)];
133 /* Name of file to which shell output
135 int of_outFd; /* Stream open to the output
136 * file. Used to funnel all
137 * from a single job to one file
138 * while still allowing
139 * multiple shell invocations */
140 } o_file; /* Data used when catching the output in
141 * a temporary file */
142 } output; /* Data for tracking a shell's output */
145 #define outPipe output.o_pipe.op_outPipe
146 #define inPipe output.o_pipe.op_inPipe
147 #define outBuf output.o_pipe.op_outBuf
148 #define curPos output.o_pipe.op_curPos
149 #define outFile output.o_file.of_outFile
150 #define outFd output.o_file.of_outFd
154 * Shell Specifications:
155 * Each shell type has associated with it the following information:
156 * 1) The string which must match the last character of the shell name
157 * for the shell to be considered of this type. The longest match
159 * 2) A command to issue to turn off echoing of command lines
160 * 3) A command to issue to turn echoing back on again
161 * 4) What the shell prints, and its length, when given the echo-off
162 * command. This line will not be printed when received from the shell
163 * 5) A boolean to tell if the shell has the ability to control
164 * error checking for individual commands.
165 * 6) The string to turn this checking on.
166 * 7) The string to turn it off.
167 * 8) The command-flag to give to cause the shell to start echoing
168 * commands right away.
169 * 9) The command-flag to cause the shell to Lib_Exit when an error is
170 * detected in one of the commands.
172 * Some special stuff goes on if a shell doesn't have error control. In such
173 * a case, errCheck becomes a printf template for echoing the command,
174 * should echoing be on and ignErr becomes another printf template for
175 * executing the command while ignoring the return status. If either of these
176 * strings is empty when hasErrCtl is FALSE, the command will be executed
177 * anyway as is and if it causes an error, so be it.
179 typedef struct Shell {
180 char *name; /* the name of the shell. For Bourne and C
181 * shells, this is used only to find the
182 * shell description when used as the single
183 * source of a .SHELL target. For user-defined
184 * shells, this is the full path of the shell.
186 Boolean hasEchoCtl; /* True if both echoOff and echoOn defined */
187 char *echoOff; /* command to turn off echo */
188 char *echoOn; /* command to turn it back on again */
189 char *noPrint; /* command to skip when printing output from
190 * shell. This is usually the command which
191 * was executed to turn off echoing */
192 int noPLen; /* length of noPrint command */
193 Boolean hasErrCtl; /* set if can control error checking for
194 * individual commands */
195 char *errCheck; /* string to turn error checking on */
196 char *ignErr; /* string to turn off error checking */
200 char *echo; /* echo commands */
201 char *exit; /* exit on error */
203 extern int maxJobs; /* Number of jobs that may run */
206 void Job_Touch(GNode *, Boolean);
207 Boolean Job_CheckCommands(GNode *, void (*abortProc)(const char *, ...));
208 void Job_CatchChildren(Boolean);
209 void Job_CatchOutput(void);
210 void Job_Make(GNode *);
212 Boolean Job_Full(void);
213 Boolean Job_Empty(void);
214 ReturnStatus Job_ParseShell(char *);
215 int Job_Finish(void);
217 void Job_AbortAll(void);