job.h revision 1.9
1/* $NetBSD: job.h,v 1.9 2000/12/04 20:13:29 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 8.1 (Berkeley) 6/6/93 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/makeXXXXXX" 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#ifndef RMT_WILL_WATCH 95#ifndef USE_SELECT 96struct pollfd; 97#endif 98#endif 99 100#define JOB_BUFSIZE 1024 101typedef struct Job { 102 int pid; /* The child's process ID */ 103 GNode *node; /* The target the child is making */ 104 LstNode tailCmds; /* The node of the first command to be 105 * saved when the job has been run */ 106 FILE *cmdFILE; /* When creating the shell script, this is 107 * where the commands go */ 108 int rmtID; /* ID returned from Rmt module */ 109 short flags; /* Flags to control treatment of job */ 110#define JOB_IGNERR 0x001 /* Ignore non-zero exits */ 111#define JOB_SILENT 0x002 /* no output */ 112#define JOB_SPECIAL 0x004 /* Target is a special one. i.e. run it locally 113 * if we can't export it and maxLocal is 0 */ 114#define JOB_IGNDOTS 0x008 /* Ignore "..." lines when processing 115 * commands */ 116#define JOB_REMOTE 0x010 /* Job is running remotely */ 117#define JOB_FIRST 0x020 /* Job is first job for the node */ 118#define JOB_REMIGRATE 0x040 /* Job needs to be remigrated */ 119#define JOB_RESTART 0x080 /* Job needs to be completely restarted */ 120#define JOB_RESUME 0x100 /* Job needs to be resumed b/c it stopped, 121 * for some reason */ 122#define JOB_CONTINUING 0x200 /* We are in the process of resuming this job. 123 * Used to avoid infinite recursion between 124 * JobFinish and JobRestart */ 125 union { 126 struct { 127 int op_inPipe; /* Input side of pipe associated 128 * with job's output channel */ 129#ifndef RMT_WILL_WATCH 130#ifndef USE_SELECT 131 struct pollfd *op_inPollfd; /* pollfd associated with inPipe */ 132#endif 133#endif 134 int op_outPipe; /* Output side of pipe associated with 135 * job's output channel */ 136 char op_outBuf[JOB_BUFSIZE + 1]; 137 /* Buffer for storing the output of the 138 * job, line by line */ 139 int op_curPos; /* Current position in op_outBuf */ 140 } o_pipe; /* data used when catching the output via 141 * a pipe */ 142 struct { 143 char of_outFile[sizeof(TMPPAT)+2]; 144 /* Name of file to which shell output 145 * was rerouted */ 146 int of_outFd; /* Stream open to the output 147 * file. Used to funnel all 148 * from a single job to one file 149 * while still allowing 150 * multiple shell invocations */ 151 } o_file; /* Data used when catching the output in 152 * a temporary file */ 153 } output; /* Data for tracking a shell's output */ 154} Job; 155 156#define outPipe output.o_pipe.op_outPipe 157#define inPipe output.o_pipe.op_inPipe 158#define inPollfd output.o_pipe.op_inPollfd 159#define outBuf output.o_pipe.op_outBuf 160#define curPos output.o_pipe.op_curPos 161#define outFile output.o_file.of_outFile 162#define outFd output.o_file.of_outFd 163 164 165/*- 166 * Shell Specifications: 167 * Each shell type has associated with it the following information: 168 * 1) The string which must match the last character of the shell name 169 * for the shell to be considered of this type. The longest match 170 * wins. 171 * 2) A command to issue to turn off echoing of command lines 172 * 3) A command to issue to turn echoing back on again 173 * 4) What the shell prints, and its length, when given the echo-off 174 * command. This line will not be printed when received from the shell 175 * 5) A boolean to tell if the shell has the ability to control 176 * error checking for individual commands. 177 * 6) The string to turn this checking on. 178 * 7) The string to turn it off. 179 * 8) The command-flag to give to cause the shell to start echoing 180 * commands right away. 181 * 9) The command-flag to cause the shell to Lib_Exit when an error is 182 * detected in one of the commands. 183 * 184 * Some special stuff goes on if a shell doesn't have error control. In such 185 * a case, errCheck becomes a printf template for echoing the command, 186 * should echoing be on and ignErr becomes another printf template for 187 * executing the command while ignoring the return status. If either of these 188 * strings is empty when hasErrCtl is FALSE, the command will be executed 189 * anyway as is and if it causes an error, so be it. 190 */ 191typedef struct Shell { 192 char *name; /* the name of the shell. For Bourne and C 193 * shells, this is used only to find the 194 * shell description when used as the single 195 * source of a .SHELL target. For user-defined 196 * shells, this is the full path of the shell. 197 */ 198 Boolean hasEchoCtl; /* True if both echoOff and echoOn defined */ 199 char *echoOff; /* command to turn off echo */ 200 char *echoOn; /* command to turn it back on again */ 201 char *noPrint; /* command to skip when printing output from 202 * shell. This is usually the command which 203 * was executed to turn off echoing */ 204 int noPLen; /* length of noPrint command */ 205 Boolean hasErrCtl; /* set if can control error checking for 206 * individual commands */ 207 char *errCheck; /* string to turn error checking on */ 208 char *ignErr; /* string to turn off error checking */ 209 /* 210 * command-line flags 211 */ 212 char *echo; /* echo commands */ 213 char *exit; /* exit on error */ 214} Shell; 215 216#ifdef REMOTE 217extern char *targFmt; /* Format string for banner that separates 218 * output from multiple jobs. Contains a 219 * single %s where the name of the node being 220 * made should be put. */ 221extern GNode *lastNode; /* Last node for which a banner was printed. 222 * If Rmt module finds it necessary to print 223 * a banner, it should set this to the node 224 * for which the banner was printed */ 225extern int nJobs; /* Number of jobs running (local and remote) */ 226extern int nLocal; /* Number of jobs running locally */ 227extern Lst jobs; /* List of active job descriptors */ 228extern Lst stoppedJobs; /* List of jobs that are stopped or didn't 229 * quite get started */ 230extern Boolean jobFull; /* Non-zero if no more jobs should/will start*/ 231#endif 232 233void Job_Touch __P((GNode *, Boolean)); 234Boolean Job_CheckCommands __P((GNode *, void (*abortProc )(char *, ...))); 235void Job_CatchChildren __P((Boolean)); 236void Job_CatchOutput __P((void)); 237void Job_Make __P((GNode *)); 238void Job_Init __P((int, int)); 239Boolean Job_Full __P((void)); 240Boolean Job_Empty __P((void)); 241ReturnStatus Job_ParseShell __P((char *)); 242int Job_Finish __P((void)); 243void Job_End __P((void)); 244void Job_Wait __P((void)); 245void Job_AbortAll __P((void)); 246void JobFlagForMigration __P((int)); 247 248#endif /* _JOB_H_ */ 249