usr.bin/make/make.h

   1 /*      $NetBSD: make.h,v 1.78 2009/01/24 14:43:28 dsl Exp $    */
   2
   3 /*
   4  * Copyright (c) 1988, 1989, 1990, 1993
   5  *      The Regents of the University of California.  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: @(#)make.h        8.3 (Berkeley) 6/13/95
  35  */
  36
  37 /*
  38  * Copyright (c) 1989 by Berkeley Softworks
  39  * All rights reserved.
  40  *
  41  * This code is derived from software contributed to Berkeley by
  42  * Adam de Boor.
  43  *
  44  * Redistribution and use in source and binary forms, with or without
  45  * modification, are permitted provided that the following conditions
  46  * are met:
  47  * 1. Redistributions of source code must retain the above copyright
  48  *    notice, this list of conditions and the following disclaimer.
  49  * 2. Redistributions in binary form must reproduce the above copyright
  50  *    notice, this list of conditions and the following disclaimer in the
  51  *    documentation and/or other materials provided with the distribution.
  52  * 3. All advertising materials mentioning features or use of this software
  53  *    must display the following acknowledgement:
  54  *      This product includes software developed by the University of
  55  *      California, Berkeley and its contributors.
  56  * 4. Neither the name of the University nor the names of its contributors
  57  *    may be used to endorse or promote products derived from this software
  58  *    without specific prior written permission.
  59  *
  60  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  61  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  62  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  63  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  64  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  65  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  66  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  67  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  68  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  69  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  70  * SUCH DAMAGE.
  71  *
  72  *      from: @(#)make.h        8.3 (Berkeley) 6/13/95
  73  */
  74
  75 /*-
  76  * make.h --
  77  *      The global definitions for pmake
  78  */
  79
  80 #ifndef _MAKE_H_
  81 #define _MAKE_H_
  82
  83 #include <sys/types.h>
  84 #include <sys/param.h>
  85
  86 #include <ctype.h>
  87 #include <stdio.h>
  88 #include <stdlib.h>
  89 #include <string.h>
  90 #include <unistd.h>
  91
  92 #ifdef BSD4_4
  93 # include <sys/cdefs.h>
  94 #endif
  95
  96 #if !defined(__GNUC_PREREQ__)
  97 #if defined(__GNUC__)
  98 #define __GNUC_PREREQ__(x, y)                                           \
  99         ((__GNUC__ == (x) && __GNUC_MINOR__ >= (y)) ||                  \
 100          (__GNUC__ > (x)))
 101 #else /* defined(__GNUC__) */
 102 #define __GNUC_PREREQ__(x, y)   0
 103 #endif /* defined(__GNUC__) */
 104 #endif /* !defined(__GNUC_PREREQ__) */
 105
 106 #if !defined(__unused)
 107 #if __GNUC_PREREQ__(2, 7)
 108 #define __unused        __attribute__((__unused__))
 109 #else
 110 #define __unused        /* delete */
 111 #endif
 112 #endif
 113
 114 #include "sprite.h"
 115 #include "lst.h"
 116 #include "hash.h"
 117 #include "config.h"
 118 #include "buf.h"
 119 #include "make_malloc.h"
 120
 121 /*-
 122  * The structure for an individual graph node. Each node has several
 123  * pieces of data associated with it.
 124  *      1) the name of the target it describes
 125  *      2) the location of the target file in the file system.
 126  *      3) the type of operator used to define its sources (qv. parse.c)
 127  *      4) whether it is involved in this invocation of make
 128  *      5) whether the target has been remade
 129  *      6) whether any of its children has been remade
 130  *      7) the number of its children that are, as yet, unmade
 131  *      8) its modification time
 132  *      9) the modification time of its youngest child (qv. make.c)
 133  *      10) a list of nodes for which this is a source (parents)
 134  *      11) a list of nodes on which this depends (children)
 135  *      12) a list of nodes that depend on this, as gleaned from the
 136  *          transformation rules (iParents)
 137  *      13) a list of ancestor nodes, which includes parents, iParents,
 138  *          and recursive parents of parents
 139  *      14) a list of nodes of the same name created by the :: operator
 140  *      15) a list of nodes that must be made (if they're made) before
 141  *          this node can be, but that do not enter into the datedness of
 142  *          this node.
 143  *      16) a list of nodes that must be made (if they're made) before
 144  *          this node or any child of this node can be, but that do not
 145  *          enter into the datedness of this node.
 146  *      17) a list of nodes that must be made (if they're made) after
 147  *          this node is, but that do not depend on this node, in the
 148  *          normal sense.
 149  *      18) a Lst of ``local'' variables that are specific to this target
 150  *         and this target only (qv. var.c [$@ $< $?, etc.])
 151  *      19) a Lst of strings that are commands to be given to a shell
 152  *         to create this target.
 153  */
 154 typedef struct GNode {
 155     char            *name;      /* The target's name */
 156     char            *uname;     /* The unexpanded name of a .USE node */
 157     char            *path;      /* The full pathname of the file */
 158     int             type;       /* Its type (see the OP flags, below) */
 159
 160     int             flags;
 161 #define REMAKE          0x1     /* this target needs to be (re)made */
 162 #define CHILDMADE       0x2     /* children of this target were made */
 163 #define FORCE           0x4     /* children don't exist, and we pretend made */
 164 #define DONE_WAIT       0x8     /* Set by Make_ProcessWait() */
 165 #define DONE_ORDER      0x10    /* Build requested by .ORDER processing */
 166 #define FROM_DEPEND     0x20    /* Node created from .depend */
 167 #define CYCLE           0x1000  /* Used by MakePrintStatus */
 168 #define DONECYCLE       0x2000  /* Used by MakePrintStatus */
 169     enum enum_made {
 170         UNMADE, DEFERRED, REQUESTED, BEINGMADE,
 171         MADE, UPTODATE, ERROR, ABORTED
 172     }               made;       /* Set to reflect the state of processing
 173                                  * on this node:
 174                                  *  UNMADE - Not examined yet
 175                                  *  DEFERRED - Examined once (building child)
 176                                  *  REQUESTED - on toBeMade list
 177                                  *  BEINGMADE - Target is already being made.
 178                                  *      Indicates a cycle in the graph.
 179                                  *  MADE - Was out-of-date and has been made
 180                                  *  UPTODATE - Was already up-to-date
 181                                  *  ERROR - An error occurred while it was being
 182                                  *      made (used only in compat mode)
 183                                  *  ABORTED - The target was aborted due to
 184                                  *      an error making an inferior (compat).
 185                                  */
 186     int             unmade;     /* The number of unmade children */
 187
 188     time_t          mtime;      /* Its modification time */
 189     time_t          cmtime;     /* The modification time of its youngest
 190                                  * child */
 191
 192     Lst             iParents;   /* Links to parents for which this is an
 193                                  * implied source, if any */
 194     Lst             cohorts;    /* Other nodes for the :: operator */
 195     Lst             parents;    /* Nodes that depend on this one */
 196     Lst             children;   /* Nodes on which this one depends */
 197     Lst             order_pred; /* .ORDER nodes we need made */
 198     Lst             order_succ; /* .ORDER nodes who need us */
 199
 200     char            cohort_num[8]; /* #n for this cohort */
 201     int             unmade_cohorts;/* # of unmade instances on the
 202                                       cohorts list */
 203     struct GNode    *centurion; /* Pointer to the first instance of a ::
 204                                    node; only set when on a cohorts list */
 205     unsigned int    checked;    /* Last time we tried to makle this node */
 206
 207     Hash_Table      context;    /* The local variables */
 208     Lst             commands;   /* Creation commands */
 209
 210     struct _Suff    *suffix;    /* Suffix for the node (determined by
 211                                  * Suff_FindDeps and opaque to everyone
 212                                  * but the Suff module) */
 213     const char      *fname;     /* filename where the GNode got defined */
 214     int              lineno;    /* line number where the GNode got defined */
 215 } GNode;
 216
 217 /*
 218  * The OP_ constants are used when parsing a dependency line as a way of
 219  * communicating to other parts of the program the way in which a target
 220  * should be made. These constants are bitwise-OR'ed together and
 221  * placed in the 'type' field of each node. Any node that has
 222  * a 'type' field which satisfies the OP_NOP function was never never on
 223  * the lefthand side of an operator, though it may have been on the
 224  * righthand side...
 225  */
 226 #define OP_DEPENDS      0x00000001  /* Execution of commands depends on
 227                                      * kids (:) */
 228 #define OP_FORCE        0x00000002  /* Always execute commands (!) */
 229 #define OP_DOUBLEDEP    0x00000004  /* Execution of commands depends on kids
 230                                      * per line (::) */
 231 #define OP_OPMASK       (OP_DEPENDS|OP_FORCE|OP_DOUBLEDEP)
 232
 233 #define OP_OPTIONAL     0x00000008  /* Don't care if the target doesn't
 234                                      * exist and can't be created */
 235 #define OP_USE          0x00000010  /* Use associated commands for parents */
 236 #define OP_EXEC         0x00000020  /* Target is never out of date, but always
 237                                      * execute commands anyway. Its time
 238                                      * doesn't matter, so it has none...sort
 239                                      * of */
 240 #define OP_IGNORE       0x00000040  /* Ignore errors when creating the node */
 241 #define OP_PRECIOUS     0x00000080  /* Don't remove the target when
 242                                      * interrupted */
 243 #define OP_SILENT       0x00000100  /* Don't echo commands when executed */
 244 #define OP_MAKE         0x00000200  /* Target is a recursive make so its
 245                                      * commands should always be executed when
 246                                      * it is out of date, regardless of the
 247                                      * state of the -n or -t flags */
 248 #define OP_JOIN         0x00000400  /* Target is out-of-date only if any of its
 249                                      * children was out-of-date */
 250 #define OP_MADE         0x00000800  /* Assume the children of the node have
 251                                      * been already made */
 252 #define OP_SPECIAL      0x00001000  /* Special .BEGIN, .END, .INTERRUPT */
 253 #define OP_USEBEFORE    0x00002000  /* Like .USE, only prepend commands */
 254 #define OP_INVISIBLE    0x00004000  /* The node is invisible to its parents.
 255                                      * I.e. it doesn't show up in the parents's
 256                                      * local variables. */
 257 #define OP_NOTMAIN      0x00008000  /* The node is exempt from normal 'main
 258                                      * target' processing in parse.c */
 259 #define OP_PHONY        0x00010000  /* Not a file target; run always */
 260 #define OP_NOPATH       0x00020000  /* Don't search for file in the path */
 261 #define OP_WAIT         0x00040000  /* .WAIT phony node */
 262 /* Attributes applied by PMake */
 263 #define OP_TRANSFORM    0x80000000  /* The node is a transformation rule */
 264 #define OP_MEMBER       0x40000000  /* Target is a member of an archive */
 265 #define OP_LIB          0x20000000  /* Target is a library */
 266 #define OP_ARCHV        0x10000000  /* Target is an archive construct */
 267 #define OP_HAS_COMMANDS 0x08000000  /* Target has all the commands it should.
 268                                      * Used when parsing to catch multiple
 269                                      * commands for a target */
 270 #define OP_SAVE_CMDS    0x04000000  /* Saving commands on .END (Compat) */
 271 #define OP_DEPS_FOUND   0x02000000  /* Already processed by Suff_FindDeps */
 272 #define OP_MARK         0x01000000  /* Node found while expanding .ALLSRC */
 273
 274 #define NoExecute(gn) ((gn->type & OP_MAKE) ? noRecursiveExecute : noExecute)
 275 /*
 276  * OP_NOP will return TRUE if the node with the given type was not the
 277  * object of a dependency operator
 278  */
 279 #define OP_NOP(t)       (((t) & OP_OPMASK) == 0x00000000)
 280
 281 #define OP_NOTARGET (OP_NOTMAIN|OP_USE|OP_EXEC|OP_TRANSFORM)
 282
 283 /*
 284  * The TARG_ constants are used when calling the Targ_FindNode and
 285  * Targ_FindList functions in targ.c. They simply tell the functions what to
 286  * do if the desired node(s) is (are) not found. If the TARG_CREATE constant
 287  * is given, a new, empty node will be created for the target, placed in the
 288  * table of all targets and its address returned. If TARG_NOCREATE is given,
 289  * a NULL pointer will be returned.
 290  */
 291 #define TARG_NOCREATE   0x00      /* don't create it */
 292 #define TARG_CREATE     0x01      /* create node if not found */
 293 #define TARG_NOHASH     0x02      /* don't look in/add to hash table */
 294
 295 /*
 296  * These constants are all used by the Str_Concat function to decide how the
 297  * final string should look. If STR_ADDSPACE is given, a space will be
 298  * placed between the two strings. If STR_ADDSLASH is given, a '/' will
 299  * be used instead of a space. If neither is given, no intervening characters
 300  * will be placed between the two strings in the final output. If the
 301  * STR_DOFREE bit is set, the two input strings will be freed before
 302  * Str_Concat returns.
 303  */
 304 #define STR_ADDSPACE    0x01    /* add a space when Str_Concat'ing */
 305 #define STR_ADDSLASH    0x02    /* add a slash when Str_Concat'ing */
 306
 307 /*
 308  * Error levels for parsing. PARSE_FATAL means the process cannot continue
 309  * once the makefile has been parsed. PARSE_WARNING means it can. Passed
 310  * as the first argument to Parse_Error.
 311  */
 312 #define PARSE_WARNING   2
 313 #define PARSE_FATAL     1
 314
 315 /*
 316  * Values returned by Cond_Eval.
 317  */
 318 #define COND_PARSE      0       /* Parse the next lines */
 319 #define COND_SKIP       1       /* Skip the next lines */
 320 #define COND_INVALID    2       /* Not a conditional statement */
 321
 322 /*
 323  * Definitions for the "local" variables. Used only for clarity.
 324  */
 325 #define TARGET            "@"   /* Target of dependency */
 326 #define OODATE            "?"   /* All out-of-date sources */
 327 #define ALLSRC            ">"   /* All sources */
 328 #define IMPSRC            "<"   /* Source implied by transformation */
 329 #define PREFIX            "*"   /* Common prefix */
 330 #define ARCHIVE           "!"   /* Archive in "archive(member)" syntax */
 331 #define MEMBER            "%"   /* Member in "archive(member)" syntax */
 332
 333 #define FTARGET           "@F"  /* file part of TARGET */
 334 #define DTARGET           "@D"  /* directory part of TARGET */
 335 #define FIMPSRC           "<F"  /* file part of IMPSRC */
 336 #define DIMPSRC           "<D"  /* directory part of IMPSRC */
 337 #define FPREFIX           "*F"  /* file part of PREFIX */
 338 #define DPREFIX           "*D"  /* directory part of PREFIX */
 339
 340 /*
 341  * Global Variables
 342  */
 343 extern Lst      create;         /* The list of target names specified on the
 344                                  * command line. used to resolve #if
 345                                  * make(...) statements */
 346 extern Lst      dirSearchPath;  /* The list of directories to search when
 347                                  * looking for targets */
 348
 349 extern Boolean  compatMake;     /* True if we are make compatible */
 350 extern Boolean  ignoreErrors;   /* True if should ignore all errors */
 351 extern Boolean  beSilent;       /* True if should print no commands */
 352 extern Boolean  noExecute;      /* True if should execute nothing */
 353 extern Boolean  noRecursiveExecute;     /* True if should execute nothing */
 354 extern Boolean  allPrecious;    /* True if every target is precious */
 355 extern Boolean  keepgoing;      /* True if should continue on unaffected
 356                                  * portions of the graph when have an error
 357                                  * in one portion */
 358 extern Boolean  touchFlag;      /* TRUE if targets should just be 'touched'
 359                                  * if out of date. Set by the -t flag */
 360 extern Boolean  queryFlag;      /* TRUE if we aren't supposed to really make
 361                                  * anything, just see if the targets are out-
 362                                  * of-date */
 363 extern Boolean  doing_depend;   /* TRUE if processing .depend */
 364
 365 extern Boolean  checkEnvFirst;  /* TRUE if environment should be searched for
 366                                  * variables before the global context */
 367 extern Boolean  jobServer;      /* a jobServer already exists */
 368
 369 extern Boolean  parseWarnFatal; /* TRUE if makefile parsing warnings are
 370                                  * treated as errors */
 371
 372 extern Boolean  varNoExportEnv; /* TRUE if we should not export variables
 373                                  * set on the command line to the env. */
 374
 375 extern GNode    *DEFAULT;       /* .DEFAULT rule */
 376
 377 extern GNode    *VAR_GLOBAL;    /* Variables defined in a global context, e.g
 378                                  * in the Makefile itself */
 379 extern GNode    *VAR_CMD;       /* Variables defined on the command line */
 380 extern GNode    *VAR_FOR;       /* Iteration variables */
 381 extern char     var_Error[];    /* Value returned by Var_Parse when an error
 382                                  * is encountered. It actually points to
 383                                  * an empty string, so naive callers needn't
 384                                  * worry about it. */
 385
 386 extern time_t   now;            /* The time at the start of this whole
 387                                  * process */
 388
 389 extern Boolean  oldVars;        /* Do old-style variable substitution */
 390
 391 extern Lst      sysIncPath;     /* The system include path. */
 392 extern Lst      defIncPath;     /* The default include path. */
 393
 394 extern char     *progname;      /* The program name */
 395
 396 #define MAKEFLAGS       ".MAKEFLAGS"
 397 #define MAKEOVERRIDES   ".MAKEOVERRIDES"
 398 #define MAKE_JOB_PREFIX ".MAKE.JOB.PREFIX" /* prefix for job target output */
 399 #define MAKE_EXPORTED   ".MAKE.EXPORTED"   /* variables we export */
 400 #define MAKE_MAKEFILES  ".MAKE.MAKEFILES"  /* all the makefiles we read */
 401 #define MAKE_LEVEL      ".MAKE.LEVEL"      /* recursion level */
 402
 403 /*
 404  * debug control:
 405  *      There is one bit per module.  It is up to the module what debug
 406  *      information to print.
 407  */
 408 FILE *debug_file;               /* Output written here - default stdout */
 409 extern int debug;
 410 #define DEBUG_ARCH      0x00001
 411 #define DEBUG_COND      0x00002
 412 #define DEBUG_DIR       0x00004
 413 #define DEBUG_GRAPH1    0x00008
 414 #define DEBUG_GRAPH2    0x00010
 415 #define DEBUG_JOB       0x00020
 416 #define DEBUG_MAKE      0x00040
 417 #define DEBUG_SUFF      0x00080
 418 #define DEBUG_TARG      0x00100
 419 #define DEBUG_VAR       0x00200
 420 #define DEBUG_FOR       0x00400
 421 #define DEBUG_SHELL     0x00800
 422 #define DEBUG_ERROR     0x01000
 423 #define DEBUG_LOUD      0x02000
 424 #define DEBUG_GRAPH3    0x10000
 425 #define DEBUG_SCRIPT    0x20000
 426 #define DEBUG_PARSE     0x40000
 427 #define DEBUG_CWD       0x80000
 428
 429 #define CONCAT(a,b)     a##b
 430
 431 #define DEBUG(module)   (debug & CONCAT(DEBUG_,module))
 432
 433 #include "nonints.h"
 434
 435 int Make_TimeStamp(GNode *, GNode *);
 436 Boolean Make_OODate(GNode *);
 437 void Make_ExpandUse(Lst);
 438 time_t Make_Recheck(GNode *);
 439 void Make_HandleUse(GNode *, GNode *);
 440 void Make_Update(GNode *);
 441 void Make_DoAllVar(GNode *);
 442 Boolean Make_Run(Lst);
 443 char * Check_Cwd_Cmd(const char *);
 444 void Check_Cwd(const char **);
 445 void PrintOnError(const char *);
 446 void Main_ExportMAKEFLAGS(Boolean);
 447 Boolean Main_SetObjdir(const char *);
 448
 449 #ifdef __GNUC__
 450 #define UNCONST(ptr)    ({              \
 451     union __unconst {                   \
 452         const void *__cp;               \
 453         void *__p;                      \
 454     } __d;                              \
 455     __d.__cp = ptr, __d.__p; })
 456 #else
 457 #define UNCONST(ptr)    (void *)(ptr)
 458 #endif
 459
 460 #ifndef MIN
 461 #define MIN(a, b) ((a < b) ? a : b)
 462 #endif
 463 #ifndef MAX
 464 #define MAX(a, b) ((a > b) ? a : b)
 465 #endif
 466
 467 #endif /* _MAKE_H_ */