usr.bin/make/make.h

   1 /*
   2  * Copyright (c) 1988, 1989, 1990, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  * Copyright (c) 1989 by Berkeley Softworks
   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. All advertising materials mentioning features or use of this software
  19  *    must display the following acknowledgement:
  20  *      This product includes software developed by the University of
  21  *      California, Berkeley and its contributors.
  22  * 4. Neither the name of the University nor the names of its contributors
  23  *    may be used to endorse or promote products derived from this software
  24  *    without specific prior written permission.
  25  *
  26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  36  * SUCH DAMAGE.
  37  *
  38  *      from: @(#)make.h        8.3 (Berkeley) 6/13/95
  39  * $FreeBSD: src/usr.bin/make/make.h,v 1.12.2.2 2001/02/13 03:13:58 will Exp $
  40  * $DragonFly: src/usr.bin/make/make.h,v 1.12 2004/12/01 15:17:28 joerg Exp $
  41  */
  42
  43 /*-
  44  * make.h --
  45  *      The global definitions for pmake
  46  */
  47
  48 #ifndef _MAKE_H_
  49 #define _MAKE_H_
  50
  51 #include <sys/types.h>
  52 #include <stdio.h>
  53 #include <string.h>
  54 #include <ctype.h>
  55
  56 #include <stdlib.h>
  57 #include <unistd.h>
  58 #include "sprite.h"
  59 #include "lst.h"
  60 #include "config.h"
  61 #include "buf.h"
  62
  63 /*-
  64  * The structure for an individual graph node. Each node has several
  65  * pieces of data associated with it.
  66  *      1) the name of the target it describes
  67  *      2) the location of the target file in the filesystem.
  68  *      3) the type of operator used to define its sources (qv. parse.c)
  69  *      4) whether it is involved in this invocation of make
  70  *      5) whether the target has been remade
  71  *      6) whether any of its children has been remade
  72  *      7) the number of its children that are, as yet, unmade
  73  *      8) its modification time
  74  *      9) the modification time of its youngest child (qv. make.c)
  75  *      10) a list of nodes for which this is a source
  76  *      11) a list of nodes on which this depends
  77  *      12) a list of nodes that depend on this, as gleaned from the
  78  *          transformation rules.
  79  *      13) a list of nodes of the same name created by the :: operator
  80  *      14) a list of nodes that must be made (if they're made) before
  81  *          this node can be, but that do no enter into the datedness of
  82  *          this node.
  83  *      15) a list of nodes that must be made (if they're made) after
  84  *          this node is, but that do not depend on this node, in the
  85  *          normal sense.
  86  *      16) a Lst of ``local'' variables that are specific to this target
  87  *         and this target only (qv. var.c [$@ $< $?, etc.])
  88  *      17) a Lst of strings that are commands to be given to a shell
  89  *         to create this target.
  90  */
  91 typedef struct GNode {
  92     char            *name;      /* The target's name */
  93     char            *path;      /* The full pathname of the file */
  94     int             type;       /* Its type (see the OP flags, below) */
  95     int             order;      /* Its wait weight */
  96
  97     Boolean         make;       /* TRUE if this target needs to be remade */
  98     enum {
  99         UNMADE, BEINGMADE, MADE, UPTODATE, ERROR, ABORTED,
 100         CYCLE, ENDCYCLE
 101     }               made;       /* Set to reflect the state of processing
 102                                  * on this node:
 103                                  *  UNMADE - Not examined yet
 104                                  *  BEINGMADE - Target is already being made.
 105                                  *      Indicates a cycle in the graph. (compat
 106                                  *      mode only)
 107                                  *  MADE - Was out-of-date and has been made
 108                                  *  UPTODATE - Was already up-to-date
 109                                  *  ERROR - An error occured while it was being
 110                                  *      made (used only in compat mode)
 111                                  *  ABORTED - The target was aborted due to
 112                                  *      an error making an inferior (compat).
 113                                  *  CYCLE - Marked as potentially being part of
 114                                  *      a graph cycle. If we come back to a
 115                                  *      node marked this way, it is printed
 116                                  *      and 'made' is changed to ENDCYCLE.
 117                                  *  ENDCYCLE - the cycle has been completely
 118                                  *      printed. Go back and unmark all its
 119                                  *      members.
 120                                  */
 121     Boolean         childMade;  /* TRUE if one of this target's children was
 122                                  * made */
 123     int             unmade;     /* The number of unmade children */
 124
 125     int             mtime;      /* Its modification time */
 126     int             cmtime;     /* The modification time of its youngest
 127                                  * child */
 128
 129     Lst             iParents;   /* Links to parents for which this is an
 130                                  * implied source, if any */
 131     Lst             cohorts;    /* Other nodes for the :: operator */
 132     Lst             parents;    /* Nodes that depend on this one */
 133     Lst             children;   /* Nodes on which this one depends */
 134     Lst             successors; /* Nodes that must be made after this one */
 135     Lst             preds;      /* Nodes that must be made before this one */
 136
 137     Lst             context;    /* The local variables */
 138     Lst             commands;   /* Creation commands */
 139
 140     struct _Suff    *suffix;    /* Suffix for the node (determined by
 141                                  * Suff_FindDeps and opaque to everyone
 142                                  * but the Suff module) */
 143 } GNode;
 144
 145
 146 /*
 147  * Definitions for handling #include specifications
 148  */
 149 typedef struct {
 150     char *str;
 151     char *ptr;
 152 } PTR;
 153 typedef struct IFile {
 154     char            *fname;         /* name of previous file */
 155     int             lineno;         /* saved line number */
 156     FILE            *F;             /* the open stream */
 157     PTR             *p;             /* the char pointer */
 158 } IFile;
 159
 160 /*
 161  * The OP_ constants are used when parsing a dependency line as a way of
 162  * communicating to other parts of the program the way in which a target
 163  * should be made. These constants are bitwise-OR'ed together and
 164  * placed in the 'type' field of each node. Any node that has
 165  * a 'type' field which satisfies the OP_NOP function was never never on
 166  * the lefthand side of an operator, though it may have been on the
 167  * righthand side...
 168  */
 169 #define OP_DEPENDS      0x00000001  /* Execution of commands depends on
 170                                      * kids (:) */
 171 #define OP_FORCE        0x00000002  /* Always execute commands (!) */
 172 #define OP_DOUBLEDEP    0x00000004  /* Execution of commands depends on kids
 173                                      * per line (::) */
 174 #define OP_OPMASK       (OP_DEPENDS|OP_FORCE|OP_DOUBLEDEP)
 175
 176 #define OP_OPTIONAL     0x00000008  /* Don't care if the target doesn't
 177                                      * exist and can't be created */
 178 #define OP_USE          0x00000010  /* Use associated commands for parents */
 179 #define OP_EXEC         0x00000020  /* Target is never out of date, but always
 180                                      * execute commands anyway. Its time
 181                                      * doesn't matter, so it has none...sort
 182                                      * of */
 183 #define OP_IGNORE       0x00000040  /* Ignore errors when creating the node */
 184 #define OP_PRECIOUS     0x00000080  /* Don't remove the target when
 185                                      * interrupted */
 186 #define OP_SILENT       0x00000100  /* Don't echo commands when executed */
 187 #define OP_MAKE         0x00000200  /* Target is a recurrsive make so its
 188                                      * commands should always be executed when
 189                                      * it is out of date, regardless of the
 190                                      * state of the -n or -t flags */
 191 #define OP_JOIN         0x00000400  /* Target is out-of-date only if any of its
 192                                      * children was out-of-date */
 193 #define OP_INVISIBLE    0x00004000  /* The node is invisible to its parents.
 194                                      * I.e. it doesn't show up in the parents's
 195                                      * local variables. */
 196 #define OP_NOTMAIN      0x00008000  /* The node is exempt from normal 'main
 197                                      * target' processing in parse.c */
 198 #define OP_PHONY        0x00010000  /* Not a file target; run always */
 199 /* Attributes applied by PMake */
 200 #define OP_TRANSFORM    0x80000000  /* The node is a transformation rule */
 201 #define OP_MEMBER       0x40000000  /* Target is a member of an archive */
 202 #define OP_LIB          0x20000000  /* Target is a library */
 203 #define OP_ARCHV        0x10000000  /* Target is an archive construct */
 204 #define OP_HAS_COMMANDS 0x08000000  /* Target has all the commands it should.
 205                                      * Used when parsing to catch multiple
 206                                      * commands for a target */
 207 #define OP_SAVE_CMDS    0x04000000  /* Saving commands on .END (Compat) */
 208 #define OP_DEPS_FOUND   0x02000000  /* Already processed by Suff_FindDeps */
 209
 210 /*
 211  * OP_NOP will return TRUE if the node with the given type was not the
 212  * object of a dependency operator
 213  */
 214 #define OP_NOP(t)       (((t) & OP_OPMASK) == 0x00000000)
 215
 216 /*
 217  * The TARG_ constants are used when calling the Targ_FindNode and
 218  * Targ_FindList functions in targ.c. They simply tell the functions what to
 219  * do if the desired node(s) is (are) not found. If the TARG_CREATE constant
 220  * is given, a new, empty node will be created for the target, placed in the
 221  * table of all targets and its address returned. If TARG_NOCREATE is given,
 222  * a NULL pointer will be returned.
 223  */
 224 #define TARG_CREATE     0x01      /* create node if not found */
 225 #define TARG_NOCREATE   0x00      /* don't create it */
 226
 227 /*
 228  * There are several places where expandable buffers are used (parse.c and
 229  * var.c). This constant is merely the starting point for those buffers. If
 230  * lines tend to be much shorter than this, it would be best to reduce BSIZE.
 231  * If longer, it should be increased. Reducing it will cause more copying to
 232  * be done for longer lines, but will save space for shorter ones. In any
 233  * case, it ought to be a power of two simply because most storage allocation
 234  * schemes allocate in powers of two.
 235  */
 236 #define MAKE_BSIZE              256     /* starting size for expandable buffers */
 237
 238 /*
 239  * These constants are all used by the Str_Concat function to decide how the
 240  * final string should look. If STR_ADDSPACE is given, a space will be
 241  * placed between the two strings. If STR_ADDSLASH is given, a '/' will
 242  * be used instead of a space. If neither is given, no intervening characters
 243  * will be placed between the two strings in the final output.
 244  */
 245 #define STR_ADDSPACE    0x01    /* add a space when Str_Concat'ing */
 246 #define STR_ADDSLASH    0x04    /* add a slash when Str_Concat'ing */
 247
 248 /*
 249  * Error levels for parsing. PARSE_FATAL means the process cannot continue
 250  * once the makefile has been parsed. PARSE_WARNING means it can. Passed
 251  * as the first argument to Parse_Error.
 252  */
 253 #define PARSE_WARNING   2
 254 #define PARSE_FATAL     1
 255
 256 /*
 257  * Values returned by Cond_Eval.
 258  */
 259 #define COND_PARSE      0       /* Parse the next lines */
 260 #define COND_SKIP       1       /* Skip the next lines */
 261 #define COND_INVALID    2       /* Not a conditional statement */
 262
 263 /*
 264  * Definitions for the "local" variables. Used only for clarity.
 265  */
 266 #define TARGET            "@"   /* Target of dependency */
 267 #define OODATE            "?"   /* All out-of-date sources */
 268 #define ALLSRC            ">"   /* All sources */
 269 #define IMPSRC            "<"   /* Source implied by transformation */
 270 #define PREFIX            "*"   /* Common prefix */
 271 #define ARCHIVE           "!"   /* Archive in "archive(member)" syntax */
 272 #define MEMBER            "%"   /* Member in "archive(member)" syntax */
 273
 274 #define FTARGET           "@F"  /* file part of TARGET */
 275 #define DTARGET           "@D"  /* directory part of TARGET */
 276 #define FIMPSRC           "<F"  /* file part of IMPSRC */
 277 #define DIMPSRC           "<D"  /* directory part of IMPSRC */
 278 #define FPREFIX           "*F"  /* file part of PREFIX */
 279 #define DPREFIX           "*D"  /* directory part of PREFIX */
 280
 281 /*
 282  * Global Variables
 283  */
 284 extern Lst      create;         /* The list of target names specified on the
 285                                  * command line. used to resolve #if
 286                                  * make(...) statements */
 287 extern Lst      dirSearchPath;  /* The list of directories to search when
 288                                  * looking for targets */
 289 extern IFile    curFile;        /* current makefile */
 290 extern Lst      parseIncPath;   /* The list of directories to search when
 291                                  * looking for includes */
 292
 293 extern Boolean  jobsRunning;    /* True if jobs are running */
 294 extern Boolean  compatMake;     /* True if we are make compatible */
 295 extern Boolean  ignoreErrors;   /* True if should ignore all errors */
 296 extern Boolean  beSilent;       /* True if should print no commands */
 297 extern Boolean  beVerbose;      /* True if should print extra cruft */
 298 extern Boolean  noExecute;      /* True if should execute nothing */
 299 extern Boolean  allPrecious;    /* True if every target is precious */
 300 extern Boolean  keepgoing;      /* True if should continue on unaffected
 301                                  * portions of the graph when have an error
 302                                  * in one portion */
 303 extern Boolean  touchFlag;      /* TRUE if targets should just be 'touched'
 304                                  * if out of date. Set by the -t flag */
 305 extern Boolean  usePipes;       /* TRUE if should capture the output of
 306                                  * subshells by means of pipes. Otherwise it
 307                                  * is routed to temporary files from which it
 308                                  * is retrieved when the shell exits */
 309 extern Boolean  queryFlag;      /* TRUE if we aren't supposed to really make
 310                                  * anything, just see if the targets are out-
 311                                  * of-date */
 312
 313 extern Boolean  checkEnvFirst;  /* TRUE if environment should be searched for
 314                                  * all variables before the global context */
 315 extern Lst      envFirstVars;   /* List of specific variables for which the
 316                                  * environment should be searched before the
 317                                  * global context */
 318
 319 extern GNode    *DEFAULT;       /* .DEFAULT rule */
 320
 321 extern GNode    *VAR_GLOBAL;    /* Variables defined in a global context, e.g
 322                                  * in the Makefile itself */
 323 extern GNode    *VAR_CMD;       /* Variables defined on the command line */
 324 extern char     var_Error[];    /* Value returned by Var_Parse when an error
 325                                  * is encountered. It actually points to
 326                                  * an empty string, so naive callers needn't
 327                                  * worry about it. */
 328
 329 extern time_t   now;            /* The time at the start of this whole
 330                                  * process */
 331
 332 extern Boolean  oldVars;        /* Do old-style variable substitution */
 333
 334 extern Lst      sysIncPath;     /* The system include path. */
 335
 336 /*
 337  * debug control:
 338  *      There is one bit per module.  It is up to the module what debug
 339  *      information to print.
 340  */
 341 extern int debug;
 342 #define DEBUG_ARCH      0x0001
 343 #define DEBUG_COND      0x0002
 344 #define DEBUG_DIR       0x0004
 345 #define DEBUG_GRAPH1    0x0008
 346 #define DEBUG_GRAPH2    0x0010
 347 #define DEBUG_JOB       0x0020
 348 #define DEBUG_MAKE      0x0040
 349 #define DEBUG_SUFF      0x0080
 350 #define DEBUG_TARG      0x0100
 351 #define DEBUG_VAR       0x0200
 352 #define DEBUG_FOR       0x0400
 353 #define DEBUG_LOUD      0x0800
 354
 355 #define CONCAT(a,b)     a##b
 356
 357 #define DEBUG(module)   (debug & CONCAT(DEBUG_,module))
 358 #define DEBUGF(module,args)             \
 359 do {                                            \
 360         if (DEBUG(module)) {                    \
 361                 Debug args ;                    \
 362         }                                       \
 363 } while (0)
 364 #define ISDOT(c) ((c)[0] == '.' && (((c)[1] == '\0') || ((c)[1] == '/')))
 365 #define ISDOTDOT(c) ((c)[0] == '.' && ISDOT(&((c)[1])))
 366
 367 /*
 368  * Since there are so many, all functions that return non-integer values are
 369  * extracted by means of a sed script or two and stuck in the file "nonints.h"
 370  */
 371 #include "nonints.h"
 372
 373 int Make_TimeStamp(GNode *, GNode *);
 374 Boolean Make_OODate(GNode *);
 375 int Make_HandleUse(GNode *, GNode *);
 376 void Make_Update(GNode *);
 377 void Make_DoAllVar(GNode *);
 378 Boolean Make_Run(Lst);
 379
 380 #endif /* _MAKE_H_ */