Annotation of src/usr.bin/make/job.h, Revision 1.1.1.1
1.1 deraadt 1: /* $NetBSD: job.h,v 1.4 1995/06/14 15:19:26 christos Exp $ */
2:
3: /*
4: * Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
5: * Copyright (c) 1988, 1989 by Adam de Boor
6: * Copyright (c) 1989 by Berkeley Softworks
7: * All rights reserved.
8: *
9: * This code is derived from software contributed to Berkeley by
10: * Adam de Boor.
11: *
12: * Redistribution and use in source and binary forms, with or without
13: * modification, are permitted provided that the following conditions
14: * are met:
15: * 1. Redistributions of source code must retain the above copyright
16: * notice, this list of conditions and the following disclaimer.
17: * 2. Redistributions in binary form must reproduce the above copyright
18: * notice, this list of conditions and the following disclaimer in the
19: * documentation and/or other materials provided with the distribution.
20: * 3. All advertising materials mentioning features or use of this software
21: * must display the following acknowledgement:
22: * This product includes software developed by the University of
23: * California, Berkeley and its contributors.
24: * 4. Neither the name of the University nor the names of its contributors
25: * may be used to endorse or promote products derived from this software
26: * without specific prior written permission.
27: *
28: * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
29: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31: * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
32: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34: * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38: * SUCH DAMAGE.
39: *
40: * from: @(#)job.h 5.3 (Berkeley) 6/1/90
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/makeXXXXX"
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 500000
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 NILLNODE 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
95: typedef struct Job {
96: int pid; /* The child's process ID */
97: GNode *node; /* The target the child is making */
98: LstNode tailCmds; /* The node of the first command to be
99: * saved when the job has been run */
100: FILE *cmdFILE; /* When creating the shell script, this is
101: * where the commands go */
102: int rmtID; /* ID returned from Rmt module */
103: short flags; /* Flags to control treatment of job */
104: #define JOB_IGNERR 0x001 /* Ignore non-zero exits */
105: #define JOB_SILENT 0x002 /* no output */
106: #define JOB_SPECIAL 0x004 /* Target is a special one. i.e. run it locally
107: * if we can't export it and maxLocal is 0 */
108: #define JOB_IGNDOTS 0x008 /* Ignore "..." lines when processing
109: * commands */
110: #define JOB_REMOTE 0x010 /* Job is running remotely */
111: #define JOB_FIRST 0x020 /* Job is first job for the node */
112: #define JOB_REMIGRATE 0x040 /* Job needs to be remigrated */
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,
115: * for some reason */
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 */
119: union {
120: struct {
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
130: * a pipe */
131: struct {
132: char of_outFile[sizeof(TMPPAT)+2];
133: /* Name of file to which shell output
134: * was rerouted */
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 */
143: } Job;
144:
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
151:
152:
153: /*-
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
158: * wins.
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.
171: *
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.
178: */
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.
185: */
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 */
197: /*
198: * command-line flags
199: */
200: char *echo; /* echo commands */
201: char *exit; /* exit on error */
202: } Shell;
203:
204:
205: extern char *targFmt; /* Format string for banner that separates
206: * output from multiple jobs. Contains a
207: * single %s where the name of the node being
208: * made should be put. */
209: extern GNode *lastNode; /* Last node for which a banner was printed.
210: * If Rmt module finds it necessary to print
211: * a banner, it should set this to the node
212: * for which the banner was printed */
213: extern int nJobs; /* Number of jobs running (local and remote) */
214: extern int nLocal; /* Number of jobs running locally */
215: extern Lst jobs; /* List of active job descriptors */
216: extern Lst stoppedJobs; /* List of jobs that are stopped or didn't
217: * quite get started */
218: extern Boolean jobFull; /* Non-zero if no more jobs should/will start*/
219:
220:
221: void Job_Touch __P((GNode *, Boolean));
222: Boolean Job_CheckCommands __P((GNode *, void (*abortProc )(char *, ...)));
223: void Job_CatchChildren __P((Boolean));
224: void Job_CatchOutput __P((void));
225: void Job_Make __P((GNode *));
226: void Job_Init __P((int, int));
227: Boolean Job_Full __P((void));
228: Boolean Job_Empty __P((void));
229: ReturnStatus Job_ParseShell __P((char *));
230: int Job_End __P((void));
231: void Job_Wait __P((void));
232: void Job_AbortAll __P((void));
233: void JobFlagForMigration __P((int));
234:
235: #endif /* _JOB_H_ */
![[BACK]](/icons/back.gif){kind=icon}
Return to job.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / make