contrib/bmake/job.h

   1 /*      $NetBSD: job.h,v 1.63 2020/11/14 13:27: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
  94 struct emul_pollfd {
  95     int fd;
  96     short events;
  97     short revents;
  98 };
  99
 100 #define POLLIN          0x0001
 101 #define POLLOUT         0x0004
 102
 103 int
 104 emul_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
 113 struct pollfd;
 114
 115
 116 #ifdef USE_META
 117 # include "meta.h"
 118 #endif
 119
 120 typedef 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
 128 typedef enum JobFlags {
 129     JOB_NONE    = 0,
 130     /* Ignore non-zero exits */
 131     JOB_IGNERR  = 1 << 0,
 132     /* no output */
 133     JOB_SILENT  = 1 << 1,
 134     /* Target is a special one. i.e. run it locally
 135      * if we can't export it and maxLocal is 0 */
 136     JOB_SPECIAL = 1 << 2,
 137     /* we've sent 'set -x' */
 138     JOB_TRACED  = 1 << 10
 139 } JobFlags;
 140
 141 /* A Job manages the shell commands that are run to create a single target.
 142  * Each job is run in a separate subprocess by a shell.  Several jobs can run
 143  * in parallel.
 144  *
 145  * The shell commands for the target are written to a temporary file,
 146  * then the shell is run with the temporary file as stdin, and the output
 147  * of that shell is captured via a pipe.
 148  *
 149  * When a job is finished, Make_Update updates all parents of the node
 150  * that was just remade, marking them as ready to be made next if all
 151  * other dependencies are finished as well. */
 152 typedef struct Job {
 153     /* The process ID of the shell running the commands */
 154     int pid;
 155
 156     /* The target the child is making */
 157     GNode *node;
 158
 159     /* If one of the shell commands is "...", all following commands are
 160      * delayed until the .END node is made.  This list node points to the
 161      * first of these commands, if any. */
 162     StringListNode *tailCmds;
 163
 164     /* When creating the shell script, this is where the commands go.
 165      * This is only used before the job is actually started. */
 166     FILE *cmdFILE;
 167
 168     int exit_status;            /* from wait4() in signal handler */
 169
 170     JobStatus status;
 171
 172     Boolean suspended;
 173
 174     JobFlags flags;             /* Flags to control treatment of job */
 175
 176     int inPipe;                 /* Pipe for reading output from job */
 177     int outPipe;                /* Pipe for writing control commands */
 178     struct pollfd *inPollfd;    /* pollfd associated with inPipe */
 179
 180 #define JOB_BUFSIZE     1024
 181     /* Buffer for storing the output of the job, line by line. */
 182     char outBuf[JOB_BUFSIZE + 1];
 183     size_t curPos;              /* Current position in outBuf. */
 184
 185 #ifdef USE_META
 186     struct BuildMon bm;
 187 #endif
 188 } Job;
 189
 190 extern const char *shellPath;
 191 extern const char *shellName;
 192 extern char *shellErrFlag;
 193
 194 extern int jobTokensRunning;    /* tokens currently "out" */
 195
 196 void Shell_Init(void);
 197 const char *Shell_GetNewline(void);
 198 void Job_Touch(GNode *, Boolean);
 199 Boolean Job_CheckCommands(GNode *, void (*abortProc)(const char *, ...));
 200 void Job_CatchChildren(void);
 201 void Job_CatchOutput(void);
 202 void Job_Make(GNode *);
 203 void Job_Init(void);
 204 Boolean Job_ParseShell(char *);
 205 int Job_Finish(void);
 206 void Job_End(void);
 207 void Job_Wait(void);
 208 void Job_AbortAll(void);
 209 void Job_TokenReturn(void);
 210 Boolean Job_TokenWithdraw(void);
 211 void Job_ServerStart(int, int, int);
 212 void Job_SetPrefix(void);
 213 Boolean Job_RunTarget(const char *, const char *);
 214
 215 #endif /* MAKE_JOB_H */