Home | History | Annotate | Line # | Download | only in make
make.h revision 1.281
      1 /*	$NetBSD: make.h,v 1.281 2021/12/28 14:22:51 rillig 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_MAKE_H
     81 #define MAKE_MAKE_H
     82 
     83 #include <sys/types.h>
     84 #include <sys/param.h>
     85 #include <sys/stat.h>
     86 
     87 #include <assert.h>
     88 #include <ctype.h>
     89 #include <fcntl.h>
     90 #include <stdarg.h>
     91 #include <stdio.h>
     92 #include <stdlib.h>
     93 #include <string.h>
     94 #include <unistd.h>
     95 
     96 #ifdef BSD4_4
     97 # include <sys/cdefs.h>
     98 #endif
     99 
    100 #ifndef FD_CLOEXEC
    101 #define FD_CLOEXEC 1
    102 #endif
    103 
    104 #if defined(__GNUC__)
    105 #define MAKE_GNUC_PREREQ(x, y)						\
    106 	((__GNUC__ == (x) && __GNUC_MINOR__ >= (y)) ||			\
    107 	 (__GNUC__ > (x)))
    108 #else
    109 #define MAKE_GNUC_PREREQ(x, y)	0
    110 #endif
    111 
    112 #if MAKE_GNUC_PREREQ(2, 7)
    113 #define MAKE_ATTR_UNUSED	__attribute__((__unused__))
    114 #else
    115 #define MAKE_ATTR_UNUSED	/* delete */
    116 #endif
    117 
    118 #if MAKE_GNUC_PREREQ(2, 5)
    119 #define MAKE_ATTR_DEAD		__attribute__((__noreturn__))
    120 #elif defined(__GNUC__)
    121 #define MAKE_ATTR_DEAD		__volatile
    122 #else
    123 #define MAKE_ATTR_DEAD		/* delete */
    124 #endif
    125 
    126 #if MAKE_GNUC_PREREQ(2, 7)
    127 #define MAKE_ATTR_PRINTFLIKE(fmtarg, firstvararg)	\
    128 	    __attribute__((__format__ (__printf__, fmtarg, firstvararg)))
    129 #else
    130 #define MAKE_ATTR_PRINTFLIKE(fmtarg, firstvararg)	/* delete */
    131 #endif
    132 
    133 #if MAKE_GNUC_PREREQ(4, 0)
    134 #define MAKE_ATTR_USE		__attribute__((__warn_unused_result__))
    135 #else
    136 #define MAKE_ATTR_USE		/* delete */
    137 #endif
    138 
    139 #define MAKE_INLINE static inline MAKE_ATTR_UNUSED
    140 
    141 /* MAKE_STATIC marks a function that may or may not be inlined. */
    142 #if defined(lint)
    143 /* As of 2021-07-31, NetBSD lint ignores __attribute__((unused)). */
    144 #define MAKE_STATIC MAKE_INLINE
    145 #else
    146 #define MAKE_STATIC static MAKE_ATTR_UNUSED
    147 #endif
    148 
    149 #if __STDC_VERSION__ >= 199901L || defined(lint) || defined(USE_C99_BOOLEAN)
    150 #include <stdbool.h>
    151 #elif defined(__bool_true_false_are_defined)
    152 /*
    153  * All files of make must be compiled with the same definition of bool.
    154  * Since one of the files includes <stdbool.h>, that means the header is
    155  * available on this platform.  Recompile everything with -DUSE_C99_BOOLEAN.
    156  */
    157 #error "<stdbool.h> is included in pre-C99 mode"
    158 #elif defined(bool) || defined(true) || defined(false)
    159 /*
    160  * In pre-C99 mode, make does not expect that bool is already defined.
    161  * You need to ensure that all translation units use the same definition for
    162  * bool.
    163  */
    164 #error "bool/true/false is defined in pre-C99 mode"
    165 #else
    166 typedef unsigned char bool;
    167 #define true	1
    168 #define false	0
    169 #endif
    170 
    171 #include "lst.h"
    172 #include "make_malloc.h"
    173 #include "str.h"
    174 #include "hash.h"
    175 #include "config.h"
    176 #include "buf.h"
    177 
    178 /*
    179  * The typical flow of states is:
    180  *
    181  * The direct successful path:
    182  * UNMADE -> BEINGMADE -> MADE.
    183  *
    184  * The direct error path:
    185  * UNMADE -> BEINGMADE -> ERROR.
    186  *
    187  * The successful path when dependencies need to be made first:
    188  * UNMADE -> DEFERRED -> REQUESTED -> BEINGMADE -> MADE.
    189  *
    190  * A node that has dependencies, and one of the dependencies cannot be made:
    191  * UNMADE -> DEFERRED -> ABORTED.
    192  *
    193  * A node that turns out to be up-to-date:
    194  * UNMADE -> BEINGMADE -> UPTODATE.
    195  */
    196 typedef enum GNodeMade {
    197 	/* Not examined yet. */
    198 	UNMADE,
    199 	/*
    200 	 * The node has been examined but is not yet ready since its
    201 	 * dependencies have to be made first.
    202 	 */
    203 	DEFERRED,
    204 
    205 	/* The node is on the toBeMade list. */
    206 	REQUESTED,
    207 
    208 	/*
    209 	 * The node is already being made. Trying to build a node in this
    210 	 * state indicates a cycle in the graph.
    211 	 */
    212 	BEINGMADE,
    213 
    214 	/* Was out-of-date and has been made. */
    215 	MADE,
    216 	/* Was already up-to-date, does not need to be made. */
    217 	UPTODATE,
    218 	/*
    219 	 * An error occurred while it was being made. Used only in compat
    220 	 * mode.
    221 	 */
    222 	ERROR,
    223 	/*
    224 	 * The target was aborted due to an error making a dependency. Used
    225 	 * only in compat mode.
    226 	 */
    227 	ABORTED
    228 } GNodeMade;
    229 
    230 /*
    231  * The OP_ constants are used when parsing a dependency line as a way of
    232  * communicating to other parts of the program the way in which a target
    233  * should be made.
    234  *
    235  * Some of the OP_ constants can be combined, others cannot.
    236  *
    237  * See the tests depsrc-*.mk and deptgt-*.mk.
    238  */
    239 typedef enum GNodeType {
    240 	OP_NONE		= 0,
    241 
    242 	/*
    243 	 * The dependency operator ':' is the most common one.  The commands
    244 	 * of this node are executed if any child is out-of-date.
    245 	 */
    246 	OP_DEPENDS	= 1 << 0,
    247 	/*
    248 	 * The dependency operator '!' always executes its commands, even if
    249 	 * its children are up-to-date.
    250 	 */
    251 	OP_FORCE	= 1 << 1,
    252 	/*
    253 	 * The dependency operator '::' behaves like ':', except that it
    254 	 * allows multiple dependency groups to be defined.  Each of these
    255 	 * groups is executed on its own, independently from the others. Each
    256 	 * individual dependency group is called a cohort.
    257 	 */
    258 	OP_DOUBLEDEP	= 1 << 2,
    259 
    260 	/* Matches the dependency operators ':', '!' and '::'. */
    261 	OP_OPMASK	= OP_DEPENDS | OP_FORCE | OP_DOUBLEDEP,
    262 
    263 	/* Don't care if the target doesn't exist and can't be created. */
    264 	OP_OPTIONAL	= 1 << 3,
    265 	/* Use associated commands for parents. */
    266 	OP_USE		= 1 << 4,
    267 	/*
    268 	 * Target is never out of date, but always execute commands anyway.
    269 	 * Its time doesn't matter, so it has none...sort of.
    270 	 */
    271 	OP_EXEC		= 1 << 5,
    272 	/*
    273 	 * Ignore non-zero exit status from shell commands when creating the
    274 	 * node.
    275 	 */
    276 	OP_IGNORE	= 1 << 6,
    277 	/* Don't remove the target when interrupted. */
    278 	OP_PRECIOUS	= 1 << 7,
    279 	/* Don't echo commands when executed. */
    280 	OP_SILENT	= 1 << 8,
    281 	/*
    282 	 * Target is a recursive make so its commands should always be
    283 	 * executed when it is out of date, regardless of the state of the -n
    284 	 * or -t flags.
    285 	 */
    286 	OP_MAKE		= 1 << 9,
    287 	/*
    288 	 * Target is out-of-date only if any of its children was out-of-date.
    289 	 */
    290 	OP_JOIN		= 1 << 10,
    291 	/* Assume the children of the node have been already made. */
    292 	OP_MADE		= 1 << 11,
    293 	/* Special .BEGIN, .END or .INTERRUPT. */
    294 	OP_SPECIAL	= 1 << 12,
    295 	/* Like .USE, only prepend commands. */
    296 	OP_USEBEFORE	= 1 << 13,
    297 	/*
    298 	 * The node is invisible to its parents. I.e. it doesn't show up in
    299 	 * the parents' local variables (.IMPSRC, .ALLSRC).
    300 	 */
    301 	OP_INVISIBLE	= 1 << 14,
    302 	/*
    303 	 * The node does not become the main target, even if it is the first
    304 	 * target in the first makefile.
    305 	 */
    306 	OP_NOTMAIN	= 1 << 15,
    307 	/* Not a file target; run always. */
    308 	OP_PHONY	= 1 << 16,
    309 	/* Don't search for the file in the path. */
    310 	OP_NOPATH	= 1 << 17,
    311 	/*
    312 	 * In a dependency line "target: source1 .WAIT source2", source1 is
    313 	 * made first, including its children.  Once that is finished,
    314 	 * source2 is made, including its children.  The .WAIT keyword may
    315 	 * appear more than once in a single dependency declaration.
    316 	 */
    317 	OP_WAIT		= 1 << 18,
    318 	/* .NOMETA do not create a .meta file */
    319 	OP_NOMETA	= 1 << 19,
    320 	/* .META we _do_ want a .meta file */
    321 	OP_META		= 1 << 20,
    322 	/* Do not compare commands in .meta file */
    323 	OP_NOMETA_CMP	= 1 << 21,
    324 	/* Possibly a submake node */
    325 	OP_SUBMAKE	= 1 << 22,
    326 
    327 	/* Attributes applied by PMake */
    328 
    329 	/* The node is a transformation rule, such as ".c.o". */
    330 	OP_TRANSFORM	= 1 << 30,
    331 	/* Target is a member of an archive */
    332 	/* XXX: How does this differ from OP_ARCHV? */
    333 	OP_MEMBER	= 1 << 29,
    334 	/*
    335 	 * The node is a library, its name has the form "-l<libname>".
    336 	 */
    337 	OP_LIB		= 1 << 28,
    338 	/*
    339 	 * The node is an archive member, its name has the form
    340 	 * "archive(member)".
    341 	 */
    342 	/* XXX: How does this differ from OP_MEMBER? */
    343 	OP_ARCHV	= 1 << 27,
    344 	/*
    345 	 * Target has all the commands it should. Used when parsing to catch
    346 	 * multiple command groups for a target.  Only applies to the
    347 	 * dependency operators ':' and '!', but not to '::'.
    348 	 */
    349 	OP_HAS_COMMANDS	= 1 << 26,
    350 	/*
    351 	 * The special command "..." has been seen. All further commands from
    352 	 * this node will be saved on the .END node instead, to be executed
    353 	 * at the very end.
    354 	 */
    355 	OP_SAVE_CMDS	= 1 << 25,
    356 	/*
    357 	 * Already processed by Suff_FindDeps, to find dependencies from
    358 	 * suffix transformation rules.
    359 	 */
    360 	OP_DEPS_FOUND	= 1 << 24,
    361 	/* Node found while expanding .ALLSRC */
    362 	OP_MARK		= 1 << 23,
    363 } GNodeType;
    364 
    365 typedef struct GNodeFlags {
    366 	/* this target needs to be (re)made */
    367 	bool remake:1;
    368 	/* children of this target were made */
    369 	bool childMade:1;
    370 	/* children don't exist, and we pretend made */
    371 	bool force:1;
    372 	/* Set by Make_ProcessWait() */
    373 	bool doneWait:1;
    374 	/* Build requested by .ORDER processing */
    375 	bool doneOrder:1;
    376 	/* Node created from .depend */
    377 	bool fromDepend:1;
    378 	/* We do it once only */
    379 	bool doneAllsrc:1;
    380 	/* Used by MakePrintStatus */
    381 	bool cycle:1;
    382 	/* Used by MakePrintStatus */
    383 	bool doneCycle:1;
    384 } GNodeFlags;
    385 
    386 typedef struct List StringList;
    387 typedef struct ListNode StringListNode;
    388 
    389 typedef struct List GNodeList;
    390 typedef struct ListNode GNodeListNode;
    391 
    392 typedef struct SearchPath {
    393 	List /* of CachedDir */ dirs;
    394 } SearchPath;
    395 
    396 /*
    397  * A graph node represents a target that can possibly be made, including its
    398  * relation to other targets and a lot of other details.
    399  */
    400 typedef struct GNode {
    401 	/* The target's name, such as "clean" or "make.c" */
    402 	char *name;
    403 	/* The unexpanded name of a .USE node */
    404 	char *uname;
    405 	/*
    406 	 * The full pathname of the file belonging to the target.
    407 	 *
    408 	 * XXX: What about .PHONY targets? These don't have an associated
    409 	 * path.
    410 	 */
    411 	char *path;
    412 
    413 	/*
    414 	 * The type of operator used to define the sources (see the OP flags
    415 	 * below).
    416 	 *
    417 	 * XXX: This looks like a wild mixture of type and flags.
    418 	 */
    419 	GNodeType type;
    420 	GNodeFlags flags;
    421 
    422 	/* The state of processing on this node */
    423 	GNodeMade made;
    424 	/* The number of unmade children */
    425 	int unmade;
    426 
    427 	/*
    428 	 * The modification time; 0 means the node does not have a
    429 	 * corresponding file; see GNode_IsOODate.
    430 	 */
    431 	time_t mtime;
    432 	struct GNode *youngestChild;
    433 
    434 	/*
    435 	 * The GNodes for which this node is an implied source. May be empty.
    436 	 * For example, when there is an inference rule for .c.o, the node
    437 	 * for file.c has the node for file.o in this list.
    438 	 */
    439 	GNodeList implicitParents;
    440 
    441 	/*
    442 	 * The nodes that depend on this one, or in other words, the nodes
    443 	 * for which this is a source.
    444 	 */
    445 	GNodeList parents;
    446 	/* The nodes on which this one depends. */
    447 	GNodeList children;
    448 
    449 	/*
    450 	 * .ORDER nodes we need made. The nodes that must be made (if they're
    451 	 * made) before this node can be made, but that do not enter into the
    452 	 * datedness of this node.
    453 	 */
    454 	GNodeList order_pred;
    455 	/*
    456 	 * .ORDER nodes who need us. The nodes that must be made (if they're
    457 	 * made at all) after this node is made, but that do not depend on
    458 	 * this node, in the normal sense.
    459 	 */
    460 	GNodeList order_succ;
    461 
    462 	/*
    463 	 * Other nodes of the same name, for targets that were defined using
    464 	 * the '::' dependency operator (OP_DOUBLEDEP).
    465 	 */
    466 	GNodeList cohorts;
    467 	/* The "#n" suffix for this cohort, or "" for other nodes */
    468 	char cohort_num[8];
    469 	/* The number of unmade instances on the cohorts list */
    470 	int unmade_cohorts;
    471 	/*
    472 	 * Pointer to the first instance of a '::' node; only set when on a
    473 	 * cohorts list
    474 	 */
    475 	struct GNode *centurion;
    476 
    477 	/* Last time (sequence number) we tried to make this node */
    478 	unsigned int checked_seqno;
    479 
    480 	/*
    481 	 * The "local" variables that are specific to this target and this
    482 	 * target only, such as $@, $<, $?.
    483 	 *
    484 	 * Also used for the global variable scopes SCOPE_GLOBAL,
    485 	 * SCOPE_CMDLINE, SCOPE_INTERNAL, which contain variables with
    486 	 * arbitrary names.
    487 	 */
    488 	HashTable /* of Var pointer */ vars;
    489 
    490 	/* The commands to be given to a shell to create this target. */
    491 	StringList commands;
    492 
    493 	/*
    494 	 * Suffix for the node (determined by Suff_FindDeps and opaque to
    495 	 * everyone but the Suff module)
    496 	 */
    497 	struct Suffix *suffix;
    498 
    499 	/* Filename where the GNode got defined, unlimited lifetime */
    500 	const char *fname;
    501 	/* Line number where the GNode got defined */
    502 	int lineno;
    503 } GNode;
    504 
    505 /* Error levels for diagnostics during parsing. */
    506 typedef enum ParseErrorLevel {
    507 	/*
    508 	 * Exit when the current top-level makefile has been parsed
    509 	 * completely.
    510 	 */
    511 	PARSE_FATAL = 1,
    512 	/* Print "warning"; may be upgraded to fatal by the -w option. */
    513 	PARSE_WARNING,
    514 	/* Informational, mainly used during development of makefiles. */
    515 	PARSE_INFO
    516 } ParseErrorLevel;
    517 
    518 /*
    519  * Values returned by Cond_EvalLine and Cond_EvalCondition.
    520  */
    521 typedef enum CondEvalResult {
    522 	COND_PARSE,		/* Parse the next lines */
    523 	COND_SKIP,		/* Skip the next lines */
    524 	COND_INVALID		/* Not a conditional statement */
    525 } CondEvalResult;
    526 
    527 /* Names of the variables that are "local" to a specific target. */
    528 #define TARGET	"@"		/* Target of dependency */
    529 #define OODATE	"?"		/* All out-of-date sources */
    530 #define ALLSRC	">"		/* All sources */
    531 #define IMPSRC	"<"		/* Source implied by transformation */
    532 #define PREFIX	"*"		/* Common prefix */
    533 #define ARCHIVE	"!"		/* Archive in "archive(member)" syntax */
    534 #define MEMBER	"%"		/* Member in "archive(member)" syntax */
    535 
    536 /*
    537  * Global Variables
    538  */
    539 
    540 /* True if every target is precious */
    541 extern bool allPrecious;
    542 /* True if failed targets should be deleted */
    543 extern bool deleteOnError;
    544 /* true while processing .depend */
    545 extern bool doing_depend;
    546 /* .DEFAULT rule */
    547 extern GNode *defaultNode;
    548 
    549 /*
    550  * Variables defined internally by make which should not override those set
    551  * by makefiles.
    552  */
    553 extern GNode *SCOPE_INTERNAL;
    554 /* Variables defined in a global scope, e.g in the makefile itself. */
    555 extern GNode *SCOPE_GLOBAL;
    556 /* Variables defined on the command line. */
    557 extern GNode *SCOPE_CMDLINE;
    558 
    559 /*
    560  * Value returned by Var_Parse when an error is encountered. It actually
    561  * points to an empty string, so naive callers needn't worry about it.
    562  */
    563 extern char var_Error[];
    564 
    565 /* The time at the start of this whole process */
    566 extern time_t now;
    567 
    568 /*
    569  * The list of directories to search when looking for targets (set by the
    570  * special target .PATH).
    571  */
    572 extern SearchPath dirSearchPath;
    573 /* Used for .include "...". */
    574 extern SearchPath *parseIncPath;
    575 /*
    576  * Used for .include <...>, for the built-in sys.mk and for makefiles from
    577  * the command line arguments.
    578  */
    579 extern SearchPath *sysIncPath;
    580 /* The default for sysIncPath. */
    581 extern SearchPath *defSysIncPath;
    582 
    583 /* Startup directory */
    584 extern char curdir[];
    585 /* The basename of the program name, suffixed with [n] for sub-makes.  */
    586 extern const char *progname;
    587 extern int makelevel;
    588 /* Name of the .depend makefile */
    589 extern char *makeDependfile;
    590 /* If we replaced environ, this will be non-NULL. */
    591 extern char **savedEnv;
    592 
    593 extern pid_t myPid;
    594 
    595 #define MAKEFLAGS	".MAKEFLAGS"
    596 #define MAKEOVERRIDES	".MAKEOVERRIDES"
    597 /* prefix when printing the target of a job */
    598 #define MAKE_JOB_PREFIX	".MAKE.JOB.PREFIX"
    599 #define MAKE_EXPORTED	".MAKE.EXPORTED"	/* exported variables */
    600 #define MAKE_MAKEFILES	".MAKE.MAKEFILES"	/* all loaded makefiles */
    601 #define MAKE_LEVEL	".MAKE.LEVEL"		/* recursion level */
    602 #define MAKE_MAKEFILE_PREFERENCE ".MAKE.MAKEFILE_PREFERENCE"
    603 #define MAKE_DEPENDFILE	".MAKE.DEPENDFILE"	/* .depend */
    604 #define MAKE_MODE	".MAKE.MODE"
    605 #ifndef MAKE_LEVEL_ENV
    606 # define MAKE_LEVEL_ENV	"MAKELEVEL"
    607 #endif
    608 
    609 typedef struct DebugFlags {
    610 	bool DEBUG_ARCH:1;
    611 	bool DEBUG_COND:1;
    612 	bool DEBUG_CWD:1;
    613 	bool DEBUG_DIR:1;
    614 	bool DEBUG_ERROR:1;
    615 	bool DEBUG_FOR:1;
    616 	bool DEBUG_GRAPH1:1;
    617 	bool DEBUG_GRAPH2:1;
    618 	bool DEBUG_GRAPH3:1;
    619 	bool DEBUG_HASH:1;
    620 	bool DEBUG_JOB:1;
    621 	bool DEBUG_LOUD:1;
    622 	bool DEBUG_MAKE:1;
    623 	bool DEBUG_META:1;
    624 	bool DEBUG_PARSE:1;
    625 	bool DEBUG_SCRIPT:1;
    626 	bool DEBUG_SHELL:1;
    627 	bool DEBUG_SUFF:1;
    628 	bool DEBUG_TARG:1;
    629 	bool DEBUG_VAR:1;
    630 } DebugFlags;
    631 
    632 #define CONCAT(a, b) a##b
    633 
    634 #define DEBUG(module) (opts.debug.CONCAT(DEBUG_, module))
    635 
    636 void debug_printf(const char *, ...) MAKE_ATTR_PRINTFLIKE(1, 2);
    637 
    638 #define DEBUG_IMPL(module, args) \
    639 	do { \
    640 		if (DEBUG(module)) \
    641 			debug_printf args; \
    642 	} while (false)
    643 
    644 #define DEBUG0(module, text) \
    645 	DEBUG_IMPL(module, ("%s", text))
    646 #define DEBUG1(module, fmt, arg1) \
    647 	DEBUG_IMPL(module, (fmt, arg1))
    648 #define DEBUG2(module, fmt, arg1, arg2) \
    649 	DEBUG_IMPL(module, (fmt, arg1, arg2))
    650 #define DEBUG3(module, fmt, arg1, arg2, arg3) \
    651 	DEBUG_IMPL(module, (fmt, arg1, arg2, arg3))
    652 #define DEBUG4(module, fmt, arg1, arg2, arg3, arg4) \
    653 	DEBUG_IMPL(module, (fmt, arg1, arg2, arg3, arg4))
    654 #define DEBUG5(module, fmt, arg1, arg2, arg3, arg4, arg5) \
    655 	DEBUG_IMPL(module, (fmt, arg1, arg2, arg3, arg4, arg5))
    656 
    657 typedef enum PrintVarsMode {
    658 	PVM_NONE,
    659 	PVM_UNEXPANDED,
    660 	PVM_EXPANDED
    661 } PrintVarsMode;
    662 
    663 /* Command line options */
    664 typedef struct CmdOpts {
    665 	/* -B: whether we are make compatible */
    666 	bool compatMake;
    667 
    668 	/*
    669 	 * -d: debug control: There is one bit per module.  It is up to the
    670 	 * module what debug information to print.
    671 	 */
    672 	DebugFlags debug;
    673 
    674 	/* -df: debug output is written here - default stderr */
    675 	FILE *debug_file;
    676 
    677 	/*
    678 	 * -dL: lint mode
    679 	 *
    680 	 * Runs make in strict mode, with additional checks and better error
    681 	 * handling.
    682 	 */
    683 	bool strict;
    684 
    685 	/* -dV: for the -V option, print unexpanded variable values */
    686 	bool debugVflag;
    687 
    688 	/* -e: check environment variables before global variables */
    689 	bool checkEnvFirst;
    690 
    691 	/* -f: the makefiles to read */
    692 	StringList makefiles;
    693 
    694 	/* -i: if true, ignore all errors from shell commands */
    695 	bool ignoreErrors;
    696 
    697 	/*
    698 	 * -j: the maximum number of jobs that can run in parallel; this is
    699 	 * coordinated with the submakes
    700 	 */
    701 	int maxJobs;
    702 
    703 	/*
    704 	 * -k: if true and an error occurs while making a node, continue
    705 	 * making nodes that do not depend on the erroneous node
    706 	 */
    707 	bool keepgoing;
    708 
    709 	/* -N: execute no commands from the targets */
    710 	bool noRecursiveExecute;
    711 
    712 	/* -n: execute almost no commands from the targets */
    713 	bool noExecute;
    714 
    715 	/*
    716 	 * -q: if true, do not really make anything, just see if the targets
    717 	 * are out-of-date
    718 	 */
    719 	bool query;
    720 
    721 	/* -r: raw mode, do not load the builtin rules. */
    722 	bool noBuiltins;
    723 
    724 	/* -s: don't echo the shell commands before executing them */
    725 	bool silent;
    726 
    727 	/*
    728 	 * -t: touch the targets if they are out-of-date, but don't actually
    729 	 * make them
    730 	 */
    731 	bool touch;
    732 
    733 	/* -[Vv]: print expanded or unexpanded selected variables */
    734 	PrintVarsMode printVars;
    735 	/* -[Vv]: the variables to print */
    736 	StringList variables;
    737 
    738 	/* -W: if true, makefile parsing warnings are treated as errors */
    739 	bool parseWarnFatal;
    740 
    741 	/* -w: print 'Entering' and 'Leaving' for submakes */
    742 	bool enterFlag;
    743 
    744 	/*
    745 	 * -X: if true, do not export variables set on the command line to
    746 	 * the environment.
    747 	 */
    748 	bool varNoExportEnv;
    749 
    750 	/*
    751 	 * The target names specified on the command line. Used to resolve
    752 	 * .if make(...) statements.
    753 	 */
    754 	StringList create;
    755 
    756 } CmdOpts;
    757 
    758 extern CmdOpts opts;
    759 
    760 #include "nonints.h"
    761 
    762 void GNode_UpdateYoungestChild(GNode *, GNode *);
    763 bool GNode_IsOODate(GNode *) MAKE_ATTR_USE;
    764 void Make_ExpandUse(GNodeList *);
    765 time_t Make_Recheck(GNode *) MAKE_ATTR_USE;
    766 void Make_HandleUse(GNode *, GNode *);
    767 void Make_Update(GNode *);
    768 void GNode_SetLocalVars(GNode *);
    769 bool Make_Run(GNodeList *);
    770 bool shouldDieQuietly(GNode *, int) MAKE_ATTR_USE;
    771 void PrintOnError(GNode *, const char *);
    772 void Main_ExportMAKEFLAGS(bool);
    773 bool Main_SetObjdir(bool, const char *, ...) MAKE_ATTR_PRINTFLIKE(2, 3);
    774 int mkTempFile(const char *, char *, size_t) MAKE_ATTR_USE;
    775 int str2Lst_Append(StringList *, char *);
    776 void GNode_FprintDetails(FILE *, const char *, const GNode *, const char *);
    777 bool GNode_ShouldExecute(GNode *gn) MAKE_ATTR_USE;
    778 
    779 /* See if the node was seen on the left-hand side of a dependency operator. */
    780 MAKE_INLINE bool MAKE_ATTR_USE
    781 GNode_IsTarget(const GNode *gn)
    782 {
    783 	return (gn->type & OP_OPMASK) != OP_NONE;
    784 }
    785 
    786 MAKE_INLINE const char * MAKE_ATTR_USE
    787 GNode_Path(const GNode *gn)
    788 {
    789 	return gn->path != NULL ? gn->path : gn->name;
    790 }
    791 
    792 MAKE_INLINE bool MAKE_ATTR_USE
    793 GNode_IsWaitingFor(const GNode *gn)
    794 {
    795 	return gn->flags.remake && gn->made <= REQUESTED;
    796 }
    797 
    798 MAKE_INLINE bool MAKE_ATTR_USE
    799 GNode_IsReady(const GNode *gn)
    800 {
    801 	return gn->made > DEFERRED;
    802 }
    803 
    804 MAKE_INLINE bool MAKE_ATTR_USE
    805 GNode_IsDone(const GNode *gn)
    806 {
    807 	return gn->made >= MADE;
    808 }
    809 
    810 MAKE_INLINE bool MAKE_ATTR_USE
    811 GNode_IsError(const GNode *gn)
    812 {
    813 	return gn->made == ERROR || gn->made == ABORTED;
    814 }
    815 
    816 MAKE_INLINE bool MAKE_ATTR_USE
    817 GNode_IsMainCandidate(const GNode *gn)
    818 {
    819 	return (gn->type & (OP_NOTMAIN | OP_USE | OP_USEBEFORE |
    820 			    OP_EXEC | OP_TRANSFORM)) == 0;
    821 }
    822 
    823 MAKE_INLINE const char * MAKE_ATTR_USE
    824 GNode_VarTarget(GNode *gn) { return GNode_ValueDirect(gn, TARGET); }
    825 MAKE_INLINE const char * MAKE_ATTR_USE
    826 GNode_VarOodate(GNode *gn) { return GNode_ValueDirect(gn, OODATE); }
    827 MAKE_INLINE const char * MAKE_ATTR_USE
    828 GNode_VarAllsrc(GNode *gn) { return GNode_ValueDirect(gn, ALLSRC); }
    829 MAKE_INLINE const char * MAKE_ATTR_USE
    830 GNode_VarImpsrc(GNode *gn) { return GNode_ValueDirect(gn, IMPSRC); }
    831 MAKE_INLINE const char * MAKE_ATTR_USE
    832 GNode_VarPrefix(GNode *gn) { return GNode_ValueDirect(gn, PREFIX); }
    833 MAKE_INLINE const char * MAKE_ATTR_USE
    834 GNode_VarArchive(GNode *gn) { return GNode_ValueDirect(gn, ARCHIVE); }
    835 MAKE_INLINE const char * MAKE_ATTR_USE
    836 GNode_VarMember(GNode *gn) { return GNode_ValueDirect(gn, MEMBER); }
    837 
    838 MAKE_INLINE void * MAKE_ATTR_USE
    839 UNCONST(const void *ptr)
    840 {
    841 	void *ret;
    842 	memcpy(&ret, &ptr, sizeof(ret));
    843 	return ret;
    844 }
    845 
    846 /* At least GNU/Hurd systems lack hardcoded MAXPATHLEN/PATH_MAX */
    847 #include <limits.h>
    848 #ifndef MAXPATHLEN
    849 #define MAXPATHLEN	4096
    850 #endif
    851 #ifndef PATH_MAX
    852 #define PATH_MAX	MAXPATHLEN
    853 #endif
    854 
    855 #if defined(SYSV)
    856 #define KILLPG(pid, sig) kill(-(pid), (sig))
    857 #else
    858 #define KILLPG(pid, sig) killpg((pid), (sig))
    859 #endif
    860 
    861 MAKE_INLINE bool MAKE_ATTR_USE
    862 ch_isalnum(char ch) { return isalnum((unsigned char)ch) != 0; }
    863 MAKE_INLINE bool MAKE_ATTR_USE
    864 ch_isalpha(char ch) { return isalpha((unsigned char)ch) != 0; }
    865 MAKE_INLINE bool MAKE_ATTR_USE
    866 ch_isdigit(char ch) { return isdigit((unsigned char)ch) != 0; }
    867 MAKE_INLINE bool MAKE_ATTR_USE
    868 ch_isspace(char ch) { return isspace((unsigned char)ch) != 0; }
    869 MAKE_INLINE bool MAKE_ATTR_USE
    870 ch_isupper(char ch) { return isupper((unsigned char)ch) != 0; }
    871 MAKE_INLINE char MAKE_ATTR_USE
    872 ch_tolower(char ch) { return (char)tolower((unsigned char)ch); }
    873 MAKE_INLINE char MAKE_ATTR_USE
    874 ch_toupper(char ch) { return (char)toupper((unsigned char)ch); }
    875 
    876 MAKE_INLINE void
    877 cpp_skip_whitespace(const char **pp)
    878 {
    879 	while (ch_isspace(**pp))
    880 		(*pp)++;
    881 }
    882 
    883 MAKE_INLINE void
    884 cpp_skip_hspace(const char **pp)
    885 {
    886 	while (**pp == ' ' || **pp == '\t')
    887 		(*pp)++;
    888 }
    889 
    890 MAKE_INLINE void
    891 pp_skip_whitespace(char **pp)
    892 {
    893 	while (ch_isspace(**pp))
    894 		(*pp)++;
    895 }
    896 
    897 MAKE_INLINE void
    898 pp_skip_hspace(char **pp)
    899 {
    900 	while (**pp == ' ' || **pp == '\t')
    901 		(*pp)++;
    902 }
    903 
    904 #if defined(lint)
    905 # define MAKE_RCSID(id) extern void do_not_define_rcsid(void)
    906 #elif defined(MAKE_NATIVE)
    907 # include <sys/cdefs.h>
    908 # define MAKE_RCSID(id) __RCSID(id)
    909 #elif defined(MAKE_ALL_IN_ONE) && defined(__COUNTER__)
    910 # define MAKE_RCSID_CONCAT(x, y) CONCAT(x, y)
    911 # define MAKE_RCSID(id) static volatile char \
    912 	MAKE_RCSID_CONCAT(rcsid_, __COUNTER__)[] = id
    913 #elif defined(MAKE_ALL_IN_ONE)
    914 # define MAKE_RCSID(id) extern void do_not_define_rcsid(void)
    915 #else
    916 # define MAKE_RCSID(id) static volatile char rcsid[] = id
    917 #endif
    918 
    919 #endif
    920