job.h revision 94589 
1/*
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
6 * All rights reserved.
7 *
8 * This code is derived from software contributed to Berkeley by
9 * Adam de Boor.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
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.
26 *
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
37 * SUCH DAMAGE.
38 *
39 *	@(#)job.h	8.1 (Berkeley) 6/6/93
40 * $FreeBSD: head/usr.bin/make/job.h 94589 2002-04-13 10:57:56Z obrien $
41 */
42
43/*-
44 * job.h --
45 *	Definitions pertaining to the running of jobs in parallel mode.
46 *	Exported from job.c for the use of remote-execution modules.
47 */
48#ifndef _JOB_H_
49#define _JOB_H_
50
51#define TMPPAT	"/tmp/makeXXXXXXXXXX"
52
53/*
54 * The SEL_ constants determine the maximum amount of time spent in select
55 * before coming out to see if a child has finished. SEL_SEC is the number of
56 * seconds and SEL_USEC is the number of micro-seconds
57 */
58#define SEL_SEC		0
59#define SEL_USEC	100000
60
61
62/*-
63 * Job Table definitions.
64 *
65 * Each job has several things associated with it:
66 *	1) The process id of the child shell
67 *	2) The graph node describing the target being made by this job
68 *	3) A LstNode for the first command to be saved after the job
69 *	   completes. This is NULL if there was no "..." in the job's
70 *	   commands.
71 *	4) An FILE* for writing out the commands. This is only
72 *	   used before the job is actually started.
73 *	5) A union of things used for handling the shell's output. Different
74 *	   parts of the union are used based on the value of the usePipes
75 *	   flag. If it is true, the output is being caught via a pipe and
76 *	   the descriptors of our pipe, an array in which output is line
77 *	   buffered and the current position in that buffer are all
78 *	   maintained for each job. If, on the other hand, usePipes is false,
79 *	   the output is routed to a temporary file and all that is kept
80 *	   is the name of the file and the descriptor open to the file.
81 *	6) An identifier provided by and for the exclusive use of the
82 *	   Rmt module.
83 *	7) A word of flags which determine how the module handles errors,
84 *	   echoing, etc. for the job
85 *
86 * The job "table" is kept as a linked Lst in 'jobs', with the number of
87 * active jobs maintained in the 'nJobs' variable. At no time will this
88 * exceed the value of 'maxJobs', initialized by the Job_Init function.
89 *
90 * When a job is finished, the Make_Update function is called on each of the
91 * parents of the node which was just remade. This takes care of the upward
92 * traversal of the dependency graph.
93 */
94#define JOB_BUFSIZE	1024
95typedef struct Job {
96    int       	pid;	    /* The child's process ID */
97    char	tfile[sizeof(TMPPAT)];
98			    /* Temporary file to use for job */
99    GNode    	*node;      /* The target the child is making */
100    LstNode 	tailCmds;   /* The node of the first command to be
101			     * saved when the job has been run */
102    FILE 	*cmdFILE;   /* When creating the shell script, this is
103			     * where the commands go */
104    int    	rmtID;     /* ID returned from Rmt module */
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
111				 * commands */
112#define JOB_REMOTE	0x010	/* Job is running remotely */
113#define JOB_FIRST	0x020	/* Job is first job for the node */
114#define JOB_REMIGRATE	0x040	/* Job needs to be remigrated */
115#define JOB_RESTART	0x080	/* Job needs to be completely restarted */
116#define JOB_RESUME	0x100	/* Job needs to be resumed b/c it stopped,
117				 * for some reason */
118#define JOB_CONTINUING	0x200	/* We are in the process of resuming this job.
119				 * Used to avoid infinite recursion between
120				 * JobFinish and JobRestart */
121    union {
122	struct {
123	    int	  	op_inPipe;	/* Input side of pipe associated
124					 * with job's output channel */
125	    int   	op_outPipe;	/* Output side of pipe associated with
126					 * job's output channel */
127	    char  	op_outBuf[JOB_BUFSIZE + 1];
128	    	  	    	    	/* Buffer for storing the output of the
129					 * job, line by line */
130	    int   	op_curPos;	/* Current position in op_outBuf */
131	}   	    o_pipe;	    /* data used when catching the output via
132				     * a pipe */
133	struct {
134	    char  	of_outFile[sizeof(TMPPAT)];
135	    	  	    	    	/* Name of file to which shell output
136					 * was rerouted */
137	    int	    	of_outFd;	/* Stream open to the output
138					 * file. Used to funnel all
139					 * from a single job to one file
140					 * while still allowing
141					 * multiple shell invocations */
142	}   	    o_file;	    /* Data used when catching the output in
143				     * a temporary file */
144    }       	output;	    /* Data for tracking a shell's output */
145} Job;
146
147#define outPipe	  	output.o_pipe.op_outPipe
148#define inPipe	  	output.o_pipe.op_inPipe
149#define outBuf		output.o_pipe.op_outBuf
150#define curPos		output.o_pipe.op_curPos
151#define outFile		output.o_file.of_outFile
152#define outFd	  	output.o_file.of_outFd
153
154
155/*-
156 * Shell Specifications:
157 * Each shell type has associated with it the following information:
158 *	1) The string which must match the last character of the shell name
159 *	   for the shell to be considered of this type. The longest match
160 *	   wins.
161 *	2) A command to issue to turn off echoing of command lines
162 *	3) A command to issue to turn echoing back on again
163 *	4) What the shell prints, and its length, when given the echo-off
164 *	   command. This line will not be printed when received from the shell
165 *	5) A boolean to tell if the shell has the ability to control
166 *	   error checking for individual commands.
167 *	6) The string to turn this checking on.
168 *	7) The string to turn it off.
169 *	8) The command-flag to give to cause the shell to start echoing
170 *	   commands right away.
171 *	9) The command-flag to cause the shell to Lib_Exit when an error is
172 *	   detected in one of the commands.
173 *
174 * Some special stuff goes on if a shell doesn't have error control. In such
175 * a case, errCheck becomes a printf template for echoing the command,
176 * should echoing be on and ignErr becomes another printf template for
177 * executing the command while ignoring the return status. If either of these
178 * strings is empty when hasErrCtl is FALSE, the command will be executed
179 * anyway as is and if it causes an error, so be it.
180 */
181typedef struct Shell {
182    char	  *name;	/* the name of the shell. For Bourne and C
183				 * shells, this is used only to find the
184				 * shell description when used as the single
185				 * source of a .SHELL target. For user-defined
186				 * shells, this is the full path of the shell.
187				 */
188    Boolean 	  hasEchoCtl;	/* True if both echoOff and echoOn defined */
189    char          *echoOff;	/* command to turn off echo */
190    char          *echoOn;	/* command to turn it back on again */
191    char          *noPrint;	/* command to skip when printing output from
192				 * shell. This is usually the command which
193				 * was executed to turn off echoing */
194    int           noPLen;	/* length of noPrint command */
195    Boolean	  hasErrCtl;	/* set if can control error checking for
196				 * individual commands */
197    char	  *errCheck;	/* string to turn error checking on */
198    char	  *ignErr;	/* string to turn off error checking */
199    /*
200     * command-line flags
201     */
202    char          *echo;	/* echo commands */
203    char          *exit;	/* exit on error */
204}               Shell;
205
206
207extern char 	*targFmt;   	/* Format string for banner that separates
208				 * output from multiple jobs. Contains a
209				 * single %s where the name of the node being
210				 * made should be put. */
211extern GNode	*lastNode;  	/* Last node for which a banner was printed.
212				 * If Rmt module finds it necessary to print
213				 * a banner, it should set this to the node
214				 * for which the banner was printed */
215extern int  	nJobs;	    	/* Number of jobs running (local and remote) */
216extern int  	nLocal;	    	/* Number of jobs running locally */
217extern Lst  	jobs;	    	/* List of active job descriptors */
218extern Lst  	stoppedJobs;	/* List of jobs that are stopped or didn't
219				 * quite get started */
220extern Boolean	jobFull;    	/* Non-zero if no more jobs should/will start*/
221
222
223void Job_Touch(GNode *, Boolean);
224Boolean Job_CheckCommands(GNode *, void (*abortProc )(char *, ...));
225void Job_CatchChildren(Boolean);
226void Job_CatchOutput(void);
227void Job_Make(GNode *);
228void Job_Init(int, int);
229Boolean Job_Full(void);
230Boolean Job_Empty(void);
231ReturnStatus Job_ParseShell(char *);
232int Job_End(void);
233void Job_Wait(void);
234void Job_AbortAll(void);
235void JobFlagForMigration(int);
236
237#endif /* _JOB_H_ */
238