job.h revision 138228
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 138228 2004-11-30 15:35:51Z harti $ 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#ifndef USE_KQUEUE 54/* 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 58 */ 59#define SEL_SEC 2 60#define SEL_USEC 0 61#endif /* !USE_KQUEUE */ 62 63 64/*- 65 * Job Table definitions. 66 * 67 * Each job has several things associated with it: 68 * 1) The process id of the child shell 69 * 2) The graph node describing the target being made by this job 70 * 3) A LstNode for the first command to be saved after the job 71 * completes. This is NULL if there was no "..." in the job's 72 * commands. 73 * 4) An FILE* for writing out the commands. This is only 74 * used before the job is actually started. 75 * 5) A union of things used for handling the shell's output. Different 76 * parts of the union are used based on the value of the usePipes 77 * flag. If it is true, the output is being caught via a pipe and 78 * the descriptors of our pipe, an array in which output is line 79 * buffered and the current position in that buffer are all 80 * maintained for each job. If, on the other hand, usePipes is false, 81 * the output is routed to a temporary file and all that is kept 82 * is the name of the file and the descriptor open to the file. 83 * 6) 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 short flags; /* Flags to control treatment of job */ 105#define JOB_IGNERR 0x001 /* Ignore non-zero exits */ 106#define JOB_SILENT 0x002 /* no output */ 107#define JOB_SPECIAL 0x004 /* Target is a special one. i.e. run it locally 108 * if we can't export it and maxLocal is 0 */ 109#define JOB_IGNDOTS 0x008 /* Ignore "..." lines when processing 110 * commands */ 111#define JOB_FIRST 0x020 /* Job is first job for the node */ 112#define JOB_RESTART 0x080 /* Job needs to be completely restarted */ 113#define JOB_RESUME 0x100 /* Job needs to be resumed b/c it stopped, 114 * for some reason */ 115#define JOB_CONTINUING 0x200 /* We are in the process of resuming this job. 116 * Used to avoid infinite recursion between 117 * JobFinish and JobRestart */ 118 union { 119 struct { 120 int op_inPipe; /* Input side of pipe associated 121 * with job's output channel */ 122 int op_outPipe; /* Output side of pipe associated with 123 * job's output channel */ 124 char op_outBuf[JOB_BUFSIZE + 1]; 125 /* Buffer for storing the output of the 126 * job, line by line */ 127 int op_curPos; /* Current position in op_outBuf */ 128 } o_pipe; /* data used when catching the output via 129 * a pipe */ 130 struct { 131 char of_outFile[sizeof(TMPPAT)]; 132 /* Name of file to which shell output 133 * was rerouted */ 134 int of_outFd; /* Stream open to the output 135 * file. Used to funnel all 136 * from a single job to one file 137 * while still allowing 138 * multiple shell invocations */ 139 } o_file; /* Data used when catching the output in 140 * a temporary file */ 141 } output; /* Data for tracking a shell's output */ 142} Job; 143 144#define outPipe output.o_pipe.op_outPipe 145#define inPipe output.o_pipe.op_inPipe 146#define outBuf output.o_pipe.op_outBuf 147#define curPos output.o_pipe.op_curPos 148#define outFile output.o_file.of_outFile 149#define outFd output.o_file.of_outFd 150 151 152/*- 153 * Shell Specifications: 154 * Each shell type has associated with it the following information: 155 * 1) The string which must match the last character of the shell name 156 * for the shell to be considered of this type. The longest match 157 * wins. 158 * 2) A command to issue to turn off echoing of command lines 159 * 3) A command to issue to turn echoing back on again 160 * 4) What the shell prints, and its length, when given the echo-off 161 * command. This line will not be printed when received from the shell 162 * 5) A boolean to tell if the shell has the ability to control 163 * error checking for individual commands. 164 * 6) The string to turn this checking on. 165 * 7) The string to turn it off. 166 * 8) The command-flag to give to cause the shell to start echoing 167 * commands right away. 168 * 9) The command-flag to cause the shell to Lib_Exit when an error is 169 * detected in one of the commands. 170 * 171 * Some special stuff goes on if a shell doesn't have error control. In such 172 * a case, errCheck becomes a printf template for echoing the command, 173 * should echoing be on and ignErr becomes another printf template for 174 * executing the command while ignoring the return status. If either of these 175 * strings is empty when hasErrCtl is FALSE, the command will be executed 176 * anyway as is and if it causes an error, so be it. 177 */ 178#define DEF_SHELL_STRUCT(TAG, CONST) \ 179struct TAG { \ 180 CONST 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 CONST char *echoOff; /* command to turn off echo */ \ 188 CONST char *echoOn; /* command to turn it back on again */ \ 189 CONST 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 CONST char *errCheck; /* string to turn error checking on */ \ 196 CONST char *ignErr; /* string to turn off error checking */ \ 197 /* \ 198 * command-line flags \ 199 */ \ 200 CONST char *echo; /* echo commands */ \ 201 CONST char *exit; /* exit on error */ \ 202} 203 204typedef DEF_SHELL_STRUCT(Shell,) Shell; 205 206extern char *shellPath; 207extern char *shellName; 208extern int maxJobs; /* Number of jobs that may run */ 209 210 211void Shell_Init(void); 212void Job_Touch(GNode *, Boolean); 213Boolean Job_CheckCommands(GNode *, void (*abortProc)(const char *, ...)); 214void Job_CatchChildren(Boolean); 215void Job_CatchOutput(int flag); 216void Job_Make(GNode *); 217void Job_Init(int); 218Boolean Job_Full(void); 219Boolean Job_Empty(void); 220ReturnStatus Job_ParseShell(char *); 221int Job_Finish(void); 222void Job_Wait(void); 223void Job_AbortAll(void); 224 225#endif /* _JOB_H_ */ 226