/*
* Copyright (c) 1988, 1989, 1990, 1993
* The Regents of the University of California. All rights reserved.
*
* This code is derived from software contributed to Berkeley by
* Adam de Boor.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* from: @(#)make.h 8.3 (Berkeley) 6/13/95
*/
/*
* Copyright (c) 1989 by Berkeley Softworks
* All rights reserved.
*
* This code is derived from software contributed to Berkeley by
* Adam de Boor.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by the University of
* California, Berkeley and its contributors.
* 4. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* from: @(#)make.h 8.3 (Berkeley) 6/13/95
*/
/*
* make.h --
* The global definitions for make
*/
/* MAKE_STATIC marks a function that may or may not be inlined. */
#if defined(lint)
/* As of 2021-07-31, NetBSD lint ignores __attribute__((unused)). */
#define MAKE_STATIC MAKE_INLINE
#else
#define MAKE_STATIC static MAKE_ATTR_UNUSED
#endif
#if __STDC_VERSION__ >= 199901L || defined(lint) || defined(USE_C99_BOOLEAN)
#include <stdbool.h>
#elif defined(__bool_true_false_are_defined)
/*
* All files of make must be compiled with the same definition of bool.
* Since one of the files includes <stdbool.h>, that means the header is
* available on this platform. Recompile everything with -DUSE_C99_BOOLEAN.
*/
#error "<stdbool.h> is included in pre-C99 mode"
#elif defined(bool) || defined(true) || defined(false)
/*
* In pre-C99 mode, make does not expect that bool is already defined.
* You need to ensure that all translation units use the same definition for
* bool.
*/
#error "bool/true/false is defined in pre-C99 mode"
#else
typedef unsigned char bool;
#define true 1
#define false 0
#endif
/*
* In code coverage mode with gcc>=12, calling vfork/exec does not mark any
* further code from the parent process as covered. gcc-10.5.0 is fine, as
* are fork/exec calls, as well as posix_spawn.
*/
#ifndef FORK_FUNCTION
#define FORK_FUNCTION vfork
#endif
/*
* The typical flow of states is:
*
* The direct successful path:
* UNMADE -> BEINGMADE -> MADE.
*
* The direct error path:
* UNMADE -> BEINGMADE -> ERROR.
*
* The successful path when dependencies need to be made first:
* UNMADE -> DEFERRED -> REQUESTED -> BEINGMADE -> MADE.
*
* A node that has dependencies, and one of the dependencies cannot be made:
* UNMADE -> DEFERRED -> ABORTED.
*
* A node that turns out to be up-to-date:
* UNMADE -> BEINGMADE -> UPTODATE.
*/
typedef enum GNodeMade {
/* Not examined yet. */
UNMADE,
/*
* The node has been examined but is not yet ready since its
* dependencies have to be made first.
*/
DEFERRED,
/* The node is on the toBeMade list. */
REQUESTED,
/*
* The node is already being made. Trying to build a node in this
* state indicates a cycle in the graph.
*/
BEINGMADE,
/* Was out-of-date and has been made. */
MADE,
/* Was already up-to-date, does not need to be made. */
UPTODATE,
/*
* An error occurred while it was being made. Used only in compat
* mode.
*/
ERROR,
/*
* The target was aborted due to an error making a dependency. Used
* only in compat mode.
*/
ABORTED
} GNodeMade;
/*
* The OP_ constants are used when parsing a dependency line as a way of
* communicating to other parts of the program the way in which a target
* should be made.
*
* Some of the OP_ constants can be combined, others cannot.
*
* See the tests depsrc-*.mk and deptgt-*.mk.
*/
typedef enum GNodeType {
OP_NONE = 0,
/*
* The dependency operator ':' is the most common one. The commands
* of this node are executed if any child is out-of-date.
*/
OP_DEPENDS = 1 << 0,
/*
* The dependency operator '!' always executes its commands, even if
* its children are up-to-date.
*/
OP_FORCE = 1 << 1,
/*
* The dependency operator '::' behaves like ':', except that it
* allows multiple dependency groups to be defined. Each of these
* groups is executed on its own, independently from the others. Each
* individual dependency group is called a cohort.
*/
OP_DOUBLEDEP = 1 << 2,
/* Matches the dependency operators ':', '!' and '::'. */
OP_OPMASK = OP_DEPENDS | OP_FORCE | OP_DOUBLEDEP,
/* Don't care if the target doesn't exist and can't be created. */
OP_OPTIONAL = 1 << 3,
/* Use associated commands for parents. */
OP_USE = 1 << 4,
/*
* Target is never out of date, but always execute commands anyway.
* Its time doesn't matter, so it has none...sort of.
*/
OP_EXEC = 1 << 5,
/*
* Ignore non-zero exit status from shell commands when creating the
* node.
*/
OP_IGNORE = 1 << 6,
/* Don't remove the target when interrupted. */
OP_PRECIOUS = 1 << 7,
/* Don't echo commands when executed. */
OP_SILENT = 1 << 8,
/*
* Target is a recursive make so its commands should always be
* executed when it is out of date, regardless of the state of the -n
* or -t flags.
*/
OP_MAKE = 1 << 9,
/*
* Target is out-of-date only if any of its children was out-of-date.
*/
OP_JOIN = 1 << 10,
/* Assume the children of the node have been already made. */
OP_MADE = 1 << 11,
/* Special .BEGIN, .END or .INTERRUPT. */
OP_SPECIAL = 1 << 12,
/* Like .USE, only prepend commands. */
OP_USEBEFORE = 1 << 13,
/*
* The node is invisible to its parents. I.e. it doesn't show up in
* the parents' local variables (.IMPSRC, .ALLSRC).
*/
OP_INVISIBLE = 1 << 14,
/*
* The node does not become the main target, even if it is the first
* target in the first makefile.
*/
OP_NOTMAIN = 1 << 15,
/* Not a file target; run always. */
OP_PHONY = 1 << 16,
/* Don't search for the file in the path. */
OP_NOPATH = 1 << 17,
/*
* In a dependency line "target: source1 .WAIT source2", source1 is
* made first, including its children. Once that is finished,
* source2 is made, including its children. The .WAIT keyword may
* appear more than once in a single dependency declaration.
*/
OP_WAIT = 1 << 18,
/* .NOMETA do not create a .meta file */
OP_NOMETA = 1 << 19,
/* .META we _do_ want a .meta file */
OP_META = 1 << 20,
/* Do not compare commands in .meta file */
OP_NOMETA_CMP = 1 << 21,
/* Possibly a submake node */
OP_SUBMAKE = 1 << 22,
/* Attributes applied by PMake */
/* The node is a transformation rule, such as ".c.o". */
OP_TRANSFORM = 1 << 30,
/* Target is a member of an archive */
/* XXX: How does this differ from OP_ARCHV? */
OP_MEMBER = 1 << 29,
/*
* The node is a library, its name has the form "-l<libname>".
*/
OP_LIB = 1 << 28,
/*
* The node is an archive member, its name has the form
* "archive(member)".
*/
/* XXX: How does this differ from OP_MEMBER? */
OP_ARCHV = 1 << 27,
/*
* Target has all the commands it should. Used when parsing to catch
* multiple command groups for a target. Only applies to the
* dependency operators ':' and '!', but not to '::'.
*/
OP_HAS_COMMANDS = 1 << 26,
/*
* The special command "..." has been seen. All further commands from
* this node will be saved on the .END node instead, to be executed
* at the very end.
*/
OP_SAVE_CMDS = 1 << 25,
/*
* Already processed by Suff_FindDeps, to find dependencies from
* suffix transformation rules.
*/
OP_DEPS_FOUND = 1 << 24,
/* Node found while expanding .ALLSRC */
OP_MARK = 1 << 23
} GNodeType;
typedef struct GNodeFlags {
/* this target needs to be (re)made */
bool remake:1;
/* children of this target were made */
bool childMade:1;
/* children don't exist, and we pretend made */
bool force:1;
/* Set by Make_ProcessWait() */
bool doneWait:1;
/* Build requested by .ORDER processing */
bool doneOrder:1;
/* Node created from .depend */
bool fromDepend:1;
/* We do it once only */
bool doneAllsrc:1;
/* Used by MakePrintStatus */
bool cycle:1;
/* Used by MakePrintStatus */
bool doneCycle:1;
} GNodeFlags;
typedef struct List StringList;
typedef struct ListNode StringListNode;
typedef struct List GNodeList;
typedef struct ListNode GNodeListNode;
typedef struct SearchPath {
List /* of CachedDir */ dirs;
} SearchPath;
/*
* A graph node represents a target that can possibly be made, including its
* relation to other targets.
*/
typedef struct GNode {
/* The target's name, such as "clean" or "make.c" */
char *name;
/* The unexpanded name of a .USE node */
char *uname;
/*
* The full pathname of the file belonging to the target.
*
* XXX: What about .PHONY targets? These don't have an associated
* path.
*/
char *path;
/*
* The type of operator used to define the sources (see the OP flags
* below).
*
* XXX: This looks like a wild mixture of type and flags.
*/
GNodeType type;
GNodeFlags flags;
/* The state of processing on this node */
GNodeMade made;
/* The number of unmade children */
int unmade;
/*
* The modification time; 0 means the node does not have a
* corresponding file; see GNode_IsOODate.
*/
time_t mtime;
struct GNode *youngestChild;
/*
* The GNodes for which this node is an implied source. May be empty.
* For example, when there is an inference rule for .c.o, the node
* for file.c has the node for file.o in this list.
*/
GNodeList implicitParents;
/*
* The nodes that depend on this one, or in other words, the nodes
* for which this is a source.
*/
GNodeList parents;
/* The nodes on which this one depends. */
GNodeList children;
/*
* .ORDER nodes we need made. The nodes that must be made (if they're
* made) before this node can be made, but that do not enter into the
* datedness of this node.
*/
GNodeList order_pred;
/*
* .ORDER nodes who need us. The nodes that must be made (if they're
* made at all) after this node is made, but that do not depend on
* this node, in the normal sense.
*/
GNodeList order_succ;
/*
* Other nodes of the same name, for targets that were defined using
* the '::' dependency operator (OP_DOUBLEDEP).
*/
GNodeList cohorts;
/* The "#n" suffix for this cohort, or "" for other nodes */
char cohort_num[8];
/* The number of unmade instances on the cohorts list */
int unmade_cohorts;
/*
* Pointer to the first instance of a '::' node; only set when on a
* cohorts list
*/
struct GNode *centurion;
/* Last time (sequence number) we tried to make this node */
unsigned checked_seqno;
/*
* The "local" variables that are specific to this target and this
* target only, such as $@, $<, $?.
*
* Also used for the global variable scopes SCOPE_GLOBAL,
* SCOPE_CMDLINE, SCOPE_INTERNAL, which contain variables with
* arbitrary names.
*/
HashTable /* of Var pointer */ vars;
/* The commands to be given to a shell to create this target. */
StringList commands;
/*
* Suffix for the node (determined by Suff_FindDeps and opaque to
* everyone but the Suff module)
*/
struct Suffix *suffix;
/* Filename where the GNode got defined, unlimited lifetime */
const char *fname;
/* Line number where the GNode got defined, 1-based */
unsigned lineno;
int exit_status;
} GNode;
/*
* Keep track of whether to include <posix.mk> when parsing the line
* '.POSIX:'.
*/
extern enum PosixState {
PS_NOT_YET,
PS_MAYBE_NEXT_LINE,
PS_NOW_OR_NEVER,
PS_SET,
PS_TOO_LATE
} posix_state;
/* Error levels for diagnostics during parsing. */
typedef enum ParseErrorLevel {
/*
* Exit when the current top-level makefile has been parsed
* completely.
*/
PARSE_FATAL = 1,
/* Print "warning"; may be upgraded to fatal by the -w option. */
PARSE_WARNING,
/* Informational, mainly used during development of makefiles. */
PARSE_INFO
} ParseErrorLevel;
/*
* Values returned by Cond_EvalLine and Cond_EvalCondition.
*/
typedef enum CondResult {
CR_TRUE, /* Parse the next lines */
CR_FALSE, /* Skip the next lines */
CR_ERROR /* Unknown directive or parse error */
} CondResult;
/* Names of the variables that are "local" to a specific target. */
#define TARGET "@" /* Target of dependency */
#define OODATE "?" /* All out-of-date sources */
#define ALLSRC ">" /* All sources */
#define IMPSRC "<" /* Source implied by transformation */
#define PREFIX "*" /* Common prefix */
#define ARCHIVE "!" /* Archive in "archive(member)" syntax */
#define MEMBER "%" /* Member in "archive(member)" syntax */
/*
* Global Variables
*/
/* True if every target is precious */
extern bool allPrecious;
/* True if failed targets should be deleted */
extern bool deleteOnError;
/* true while processing .depend */
extern bool doing_depend;
/* .DEFAULT rule */
extern GNode *defaultNode;
/*
* Variables defined internally by make which should not override those set
* by makefiles.
*/
extern GNode *SCOPE_INTERNAL;
/* Variables defined in a global scope, e.g in the makefile itself. */
extern GNode *SCOPE_GLOBAL;
/* Variables defined on the command line. */
extern GNode *SCOPE_CMDLINE;
/*
* Value returned by Var_Parse when an error is encountered. It points to an
* empty string, so naive callers needn't worry about it.
*/
extern char var_Error[];
/* The time at the start of this whole process */
extern time_t now;
/*
* The list of directories to search when looking for targets (set by the
* special target .PATH).
*/
extern SearchPath dirSearchPath;
/* Used for .include "...". */
extern SearchPath *parseIncPath;
/*
* Used for .include <...>, for the built-in sys.mk and for makefiles from
* the command line arguments.
*/
extern SearchPath *sysIncPath;
/* The default for sysIncPath. */
extern SearchPath *defSysIncPath;
/* Startup directory */
extern char curdir[];
/* The basename of the program name, suffixed with [n] for sub-makes. */
extern const char *progname;
extern int makelevel;
/* Name of the .depend makefile */
extern char *makeDependfile;
/* If we replaced environ, this will be non-NULL. */
extern char **savedEnv;
extern GNode *mainNode;
/*
* Only parse the expression but don't evaluate any part of it.
*
* TODO: Document what Var_Parse and Var_Subst return in this mode.
* As of 2021-03-15, they return unspecified, inconsistent results.
*/
VARE_PARSE,
/*
* Parse text in which '${...}' and '$(...)' are not parsed as
* subexpressions (with all their individual escaping rules) but
* instead simply as text with balanced '${}' or '$()'. Other '$'
* are copied verbatim.
*/
VARE_PARSE_BALANCED,
/* Parse and evaluate the expression. */
VARE_EVAL,
/*
* Parse and evaluate the expression. It is an error if a
* subexpression evaluates to undefined.
*/
VARE_EVAL_DEFINED_LOUD,
/*
* Parse and evaluate the expression. It is a silent error if a
* subexpression evaluates to undefined.
*/
VARE_EVAL_DEFINED,
/*
* Parse and evaluate the expression. Keep undefined variables as-is
* instead of expanding them to an empty string.
*
* Example for a ':=' assignment:
* CFLAGS = $(.INCLUDES)
* CFLAGS := -I.. $(CFLAGS)
* # If .INCLUDES (an undocumented special variable, by the
* # way) is still undefined, the updated CFLAGS becomes
* # "-I.. $(.INCLUDES)".
*/
VARE_EVAL_KEEP_UNDEFINED,
/*
* Parse and evaluate the expression. Keep '$$' as '$$' and preserve
* undefined subexpressions.
*/
VARE_EVAL_KEEP_DOLLAR_AND_UNDEFINED
} VarEvalMode;
typedef enum VarSetFlags {
VAR_SET_NONE = 0,
/* do not export */
VAR_SET_NO_EXPORT = 1 << 0,
/*
* Make the variable read-only. No further modification is possible,
* except for another call to Var_Set with the same flag. See the
* special targets '.NOREADONLY' and '.READONLY'.
*/
VAR_SET_READONLY = 1 << 1,
VAR_SET_INTERNAL = 1 << 2
} VarSetFlags;
typedef enum VarExportMode {
/* .export-all */
VEM_ALL,
/* .export-env */
VEM_ENV,
/* .export: Initial export or update an already exported variable. */
VEM_PLAIN,
/* .export-literal: Do not expand the variable value. */
VEM_LITERAL
} VarExportMode;
/* See if the node was seen on the left-hand side of a dependency operator. */
MAKE_INLINE bool MAKE_ATTR_USE
GNode_IsTarget(const GNode *gn)
{
return (gn->type & OP_OPMASK) != OP_NONE;
}