usr.bin/make/job.h

   1 /*      $NetBSD: job.h,v 1.40 2010/09/13 15:36:57 sjg 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  * job.h --
  78  *      Definitions pertaining to the running of jobs in parallel mode.
  79  */
  80 #ifndef _JOB_H_
  81 #define _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 \f
 114 /*-
 115  * Job Table definitions.
 116  *
 117  * Each job has several things associated with it:
 118  *      1) The process id of the child shell
 119  *      2) The graph node describing the target being made by this job
 120  *      3) A LstNode for the first command to be saved after the job
 121  *         completes. This is NULL if there was no "..." in the job's
 122  *         commands.
 123  *      4) An FILE* for writing out the commands. This is only
 124  *         used before the job is actually started.
 125  *      5) The output is being caught via a pipe and
 126  *         the descriptors of our pipe, an array in which output is line
 127  *         buffered and the current position in that buffer are all
 128  *         maintained for each job.
 129  *      6) A word of flags which determine how the module handles errors,
 130  *         echoing, etc. for the job
 131  *
 132  * When a job is finished, the Make_Update function is called on each of the
 133  * parents of the node which was just remade. This takes care of the upward
 134  * traversal of the dependency graph.
 135  */
 136 struct pollfd;
 137
 138
 139 #ifdef USE_META
 140 # include "meta.h"
 141 #endif
 142
 143 #define JOB_BUFSIZE     1024
 144 typedef struct Job {
 145     int         pid;        /* The child's process ID */
 146     GNode       *node;      /* The target the child is making */
 147     LstNode     tailCmds;   /* The node of the first command to be
 148                              * saved when the job has been run */
 149     FILE        *cmdFILE;   /* When creating the shell script, this is
 150                              * where the commands go */
 151     int         exit_status; /* from wait4() in signal handler */
 152     char        job_state;  /* status of the job entry */
 153 #define JOB_ST_FREE     0       /* Job is available */
 154 #define JOB_ST_SETUP    1       /* Job is allocated but otherwise invalid */
 155 #define JOB_ST_RUNNING  3       /* Job is running, pid valid */
 156 #define JOB_ST_FINISHED 4       /* Job is done (ie after SIGCHILD) */
 157     char        job_suspended;
 158     short       flags;      /* Flags to control treatment of job */
 159 #define JOB_IGNERR      0x001   /* Ignore non-zero exits */
 160 #define JOB_SILENT      0x002   /* no output */
 161 #define JOB_SPECIAL     0x004   /* Target is a special one. i.e. run it locally
 162                                  * if we can't export it and maxLocal is 0 */
 163 #define JOB_IGNDOTS     0x008   /* Ignore "..." lines when processing
 164                                  * commands */
 165 #define JOB_TRACED      0x400   /* we've sent 'set -x' */
 166
 167     int          jobPipe[2];    /* Pipe for readind output from job */
 168     struct pollfd *inPollfd;    /* pollfd associated with inPipe */
 169     char        outBuf[JOB_BUFSIZE + 1];
 170                                 /* Buffer for storing the output of the
 171                                  * job, line by line */
 172     int         curPos; /* Current position in op_outBuf */
 173
 174 #ifdef USE_META
 175     struct BuildMon     bm;
 176 #endif
 177 } Job;
 178
 179 #define inPipe jobPipe[0]
 180 #define outPipe jobPipe[1]
 181
 182 \f
 183 /*-
 184  * Shell Specifications:
 185  * Each shell type has associated with it the following information:
 186  *      1) The string which must match the last character of the shell name
 187  *         for the shell to be considered of this type. The longest match
 188  *         wins.
 189  *      2) A command to issue to turn off echoing of command lines
 190  *      3) A command to issue to turn echoing back on again
 191  *      4) What the shell prints, and its length, when given the echo-off
 192  *         command. This line will not be printed when received from the shell
 193  *      5) A boolean to tell if the shell has the ability to control
 194  *         error checking for individual commands.
 195  *      6) The string to turn this checking on.
 196  *      7) The string to turn it off.
 197  *      8) The command-flag to give to cause the shell to start echoing
 198  *         commands right away.
 199  *      9) The command-flag to cause the shell to Lib_Exit when an error is
 200  *         detected in one of the commands.
 201  *
 202  * Some special stuff goes on if a shell doesn't have error control. In such
 203  * a case, errCheck becomes a printf template for echoing the command,
 204  * should echoing be on and ignErr becomes another printf template for
 205  * executing the command while ignoring the return status. Finally errOut
 206  * is a printf template for running the command and causing the shell to
 207  * exit on error. If any of these strings are empty when hasErrCtl is FALSE,
 208  * the command will be executed anyway as is and if it causes an error, so be
 209  * it. Any templates setup to echo the command will escape any '$ ` \ "'i
 210  * characters in the command string to avoid common problems with
 211  * echo "%s\n" as a template.
 212  */
 213 typedef struct Shell {
 214     const char   *name;         /* the name of the shell. For Bourne and C
 215                                  * shells, this is used only to find the
 216                                  * shell description when used as the single
 217                                  * source of a .SHELL target. For user-defined
 218                                  * shells, this is the full path of the shell.
 219                                  */
 220     Boolean       hasEchoCtl;   /* True if both echoOff and echoOn defined */
 221     const char   *echoOff;      /* command to turn off echo */
 222     const char   *echoOn;       /* command to turn it back on again */
 223     const char   *noPrint;      /* command to skip when printing output from
 224                                  * shell. This is usually the command which
 225                                  * was executed to turn off echoing */
 226     int           noPLen;       /* length of noPrint command */
 227     Boolean       hasErrCtl;    /* set if can control error checking for
 228                                  * individual commands */
 229     const char   *errCheck;     /* string to turn error checking on */
 230     const char   *ignErr;       /* string to turn off error checking */
 231     const char   *errOut;       /* string to use for testing exit code */
 232     const char   *newline;      /* string literal that results in a newline
 233                                  * character when it appears outside of any
 234                                  * 'quote' or "quote" characters */
 235     char   commentChar;         /* character used by shell for comment lines */
 236
 237     /*
 238      * command-line flags
 239      */
 240     const char   *echo;         /* echo commands */
 241     const char   *exit;         /* exit on error */
 242 }               Shell;
 243
 244 extern const char *shellPath;
 245 extern const char *shellName;
 246
 247 extern int      jobTokensRunning; /* tokens currently "out" */
 248 extern int      maxJobs;        /* Max jobs we can run */
 249
 250 void Shell_Init(void);
 251 const char *Shell_GetNewline(void);
 252 void Job_Touch(GNode *, Boolean);
 253 Boolean Job_CheckCommands(GNode *, void (*abortProc )(const char *, ...));
 254 #define CATCH_BLOCK     1
 255 void Job_CatchChildren(void);
 256 void Job_CatchOutput(void);
 257 void Job_Make(GNode *);
 258 void Job_Init(void);
 259 Boolean Job_Full(void);
 260 Boolean Job_Empty(void);
 261 ReturnStatus Job_ParseShell(char *);
 262 int Job_Finish(void);
 263 void Job_End(void);
 264 void Job_Wait(void);
 265 void Job_AbortAll(void);
 266 void JobFlagForMigration(int);
 267 void Job_TokenReturn(void);
 268 Boolean Job_TokenWithdraw(void);
 269 void Job_ServerStart(int, int, int);
 270 void Job_SetPrefix(void);
 271
 272 #endif /* _JOB_H_ */