job.h revision 1.77
1/* $NetBSD: job.h,v 1.77 2021/12/15 12:58:01 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 emul_poll(struct pollfd *, int, int); 104#endif 105 106/* 107 * The POLL_MSEC constant determines the maximum number of milliseconds spent 108 * in poll before coming out to see if a child has finished. 109 */ 110#define POLL_MSEC 5000 111 112struct pollfd; 113 114 115#ifdef USE_META 116# include "meta.h" 117#endif 118 119typedef enum JobStatus { 120 JOB_ST_FREE = 0, /* Job is available */ 121 JOB_ST_SET_UP = 1, /* Job is allocated but otherwise invalid */ 122 /* XXX: What about the 2? */ 123 JOB_ST_RUNNING = 3, /* Job is running, pid valid */ 124 JOB_ST_FINISHED = 4 /* Job is done (ie after SIGCHILD) */ 125} JobStatus; 126 127/* 128 * A Job manages the shell commands that are run to create a single target. 129 * Each job is run in a separate subprocess by a shell. Several jobs can run 130 * in parallel. 131 * 132 * The shell commands for the target are written to a temporary file, 133 * then the shell is run with the temporary file as stdin, and the output 134 * of that shell is captured via a pipe. 135 * 136 * When a job is finished, Make_Update updates all parents of the node 137 * that was just remade, marking them as ready to be made next if all 138 * other dependencies are finished as well. 139 */ 140typedef struct Job { 141 /* The process ID of the shell running the commands */ 142 int pid; 143 144 /* The target the child is making */ 145 GNode *node; 146 147 /* 148 * If one of the shell commands is "...", all following commands are 149 * delayed until the .END node is made. This list node points to the 150 * first of these commands, if any. 151 */ 152 StringListNode *tailCmds; 153 154 /* This is where the shell commands go. */ 155 FILE *cmdFILE; 156 157 int exit_status; /* from wait4() in signal handler */ 158 159 JobStatus status; 160 161 bool suspended; 162 163 /* Ignore non-zero exits */ 164 bool ignerr; 165 /* Output the command before or instead of running it. */ 166 bool echo; 167 /* Target is a special one. */ 168 bool special; 169 170 int inPipe; /* Pipe for reading output from job */ 171 int outPipe; /* Pipe for writing control commands */ 172 struct pollfd *inPollfd; /* pollfd associated with inPipe */ 173 174#define JOB_BUFSIZE 1024 175 /* Buffer for storing the output of the job, line by line. */ 176 char outBuf[JOB_BUFSIZE + 1]; 177 size_t curPos; /* Current position in outBuf. */ 178 179#ifdef USE_META 180 struct BuildMon bm; 181#endif 182} Job; 183 184extern const char *shellPath; 185extern const char *shellName; 186extern char *shellErrFlag; 187 188extern int jobTokensRunning; /* tokens currently "out" */ 189 190void Shell_Init(void); 191const char *Shell_GetNewline(void) MAKE_ATTR_USE; 192void Job_Touch(GNode *, bool); 193bool Job_CheckCommands(GNode *, void (*abortProc)(const char *, ...)) 194 MAKE_ATTR_USE; 195void Job_CatchChildren(void); 196void Job_CatchOutput(void); 197void Job_Make(GNode *); 198void Job_Init(void); 199bool Job_ParseShell(char *) MAKE_ATTR_USE; 200int Job_Finish(void); 201void Job_End(void); 202void Job_Wait(void); 203void Job_AbortAll(void); 204void Job_TokenReturn(void); 205bool Job_TokenWithdraw(void) MAKE_ATTR_USE; 206void Job_ServerStart(int, int, int); 207void Job_SetPrefix(void); 208bool Job_RunTarget(const char *, const char *); 209void Job_FlagsToString(const Job *, char *, size_t); 210int Job_TempFile(const char *, char *, size_t) MAKE_ATTR_USE; 211 212#endif 213