job.h revision 1.65
1/* $NetBSD: job.h,v 1.65 2020/12/10 20:49:11 rillig Exp $ */ 2 3/* 4 * Copyright (c) 1988, 1989, 1990 The Regents of the University of California. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to Berkeley by 8 * Adam de Boor. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. Neither the name of the University nor the names of its contributors 19 * may be used to endorse or promote products derived from this software 20 * without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 * SUCH DAMAGE. 33 * 34 * from: @(#)job.h 8.1 (Berkeley) 6/6/93 35 */ 36 37/* 38 * Copyright (c) 1988, 1989 by Adam de Boor 39 * Copyright (c) 1989 by Berkeley Softworks 40 * All rights reserved. 41 * 42 * This code is derived from software contributed to Berkeley by 43 * Adam de Boor. 44 * 45 * Redistribution and use in source and binary forms, with or without 46 * modification, are permitted provided that the following conditions 47 * are met: 48 * 1. Redistributions of source code must retain the above copyright 49 * notice, this list of conditions and the following disclaimer. 50 * 2. Redistributions in binary form must reproduce the above copyright 51 * notice, this list of conditions and the following disclaimer in the 52 * documentation and/or other materials provided with the distribution. 53 * 3. All advertising materials mentioning features or use of this software 54 * must display the following acknowledgement: 55 * This product includes software developed by the University of 56 * California, Berkeley and its contributors. 57 * 4. Neither the name of the University nor the names of its contributors 58 * may be used to endorse or promote products derived from this software 59 * without specific prior written permission. 60 * 61 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 62 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 63 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 64 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 65 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 66 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 67 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 68 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 69 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 70 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 71 * SUCH DAMAGE. 72 * 73 * from: @(#)job.h 8.1 (Berkeley) 6/6/93 74 */ 75 76/* 77 * Running of jobs in parallel mode. 78 */ 79 80#ifndef MAKE_JOB_H 81#define MAKE_JOB_H 82 83#define TMPPAT "makeXXXXXX" /* relative to tmpdir */ 84 85#ifdef USE_SELECT 86/* 87 * Emulate poll() in terms of select(). This is not a complete 88 * emulation but it is sufficient for make's purposes. 89 */ 90 91#define poll emul_poll 92#define pollfd emul_pollfd 93 94struct emul_pollfd { 95 int fd; 96 short events; 97 short revents; 98}; 99 100#define POLLIN 0x0001 101#define POLLOUT 0x0004 102 103int 104emul_poll(struct pollfd *fd, int nfd, int timeout); 105#endif 106 107/* 108 * The POLL_MSEC constant determines the maximum number of milliseconds spent 109 * in poll before coming out to see if a child has finished. 110 */ 111#define POLL_MSEC 5000 112 113struct pollfd; 114 115 116#ifdef USE_META 117# include "meta.h" 118#endif 119 120typedef enum JobStatus { 121 JOB_ST_FREE = 0, /* Job is available */ 122 JOB_ST_SET_UP = 1, /* Job is allocated but otherwise invalid */ 123 /* XXX: What about the 2? */ 124 JOB_ST_RUNNING = 3, /* Job is running, pid valid */ 125 JOB_ST_FINISHED = 4 /* Job is done (ie after SIGCHILD) */ 126} JobStatus; 127 128typedef struct JobFlags { 129 /* Ignore non-zero exits */ 130 Boolean ignerr; 131 /* no output */ 132 Boolean silent; 133 /* Target is a special one. i.e. run it locally 134 * if we can't export it and maxLocal is 0 */ 135 Boolean special; 136 /* we've sent 'set -x' */ 137 Boolean xtraced; 138} JobFlags; 139 140/* A Job manages the shell commands that are run to create a single target. 141 * Each job is run in a separate subprocess by a shell. Several jobs can run 142 * in parallel. 143 * 144 * The shell commands for the target are written to a temporary file, 145 * then the shell is run with the temporary file as stdin, and the output 146 * of that shell is captured via a pipe. 147 * 148 * When a job is finished, Make_Update updates all parents of the node 149 * that was just remade, marking them as ready to be made next if all 150 * other dependencies are finished as well. */ 151typedef struct Job { 152 /* The process ID of the shell running the commands */ 153 int pid; 154 155 /* The target the child is making */ 156 GNode *node; 157 158 /* If one of the shell commands is "...", all following commands are 159 * delayed until the .END node is made. This list node points to the 160 * first of these commands, if any. */ 161 StringListNode *tailCmds; 162 163 /* When creating the shell script, this is where the commands go. 164 * This is only used before the job is actually started. */ 165 FILE *cmdFILE; 166 167 int exit_status; /* from wait4() in signal handler */ 168 169 JobStatus status; 170 171 Boolean suspended; 172 173 JobFlags flags; /* Flags to control treatment of job */ 174 175 int inPipe; /* Pipe for reading output from job */ 176 int outPipe; /* Pipe for writing control commands */ 177 struct pollfd *inPollfd; /* pollfd associated with inPipe */ 178 179#define JOB_BUFSIZE 1024 180 /* Buffer for storing the output of the job, line by line. */ 181 char outBuf[JOB_BUFSIZE + 1]; 182 size_t curPos; /* Current position in outBuf. */ 183 184#ifdef USE_META 185 struct BuildMon bm; 186#endif 187} Job; 188 189extern const char *shellPath; 190extern const char *shellName; 191extern char *shellErrFlag; 192 193extern int jobTokensRunning; /* tokens currently "out" */ 194 195void Shell_Init(void); 196const char *Shell_GetNewline(void); 197void Job_Touch(GNode *, Boolean); 198Boolean Job_CheckCommands(GNode *, void (*abortProc)(const char *, ...)); 199void Job_CatchChildren(void); 200void Job_CatchOutput(void); 201void Job_Make(GNode *); 202void Job_Init(void); 203Boolean Job_ParseShell(char *); 204int Job_Finish(void); 205void Job_End(void); 206void Job_Wait(void); 207void Job_AbortAll(void); 208void Job_TokenReturn(void); 209Boolean Job_TokenWithdraw(void); 210void Job_ServerStart(int, int, int); 211void Job_SetPrefix(void); 212Boolean Job_RunTarget(const char *, const char *); 213void Job_FlagsToString(char *, size_t, const JobFlags *); 214 215#endif /* MAKE_JOB_H */ 216