1 /* $NetBSD: make.h,v 1.332 2024/04/27 20:41:32 rillig Exp $ */
4 * Copyright (c) 1988, 1989, 1990, 1993
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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.
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
34 * from: @(#)make.h 8.3 (Berkeley) 6/13/95
38 * Copyright (c) 1989 by Berkeley Softworks
39 * All rights reserved.
41 * This code is derived from software contributed to Berkeley by
44 * Redistribution and use in source and binary forms, with or without
45 * modification, are permitted provided that the following conditions
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.
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
72 * from: @(#)make.h 8.3 (Berkeley) 6/13/95
77 * The global definitions for make
87 #include <sys/types.h>
88 #include <sys/param.h>
103 #include <sys/cdefs.h>
109 #if defined(__GNUC__)
110 #define MAKE_GNUC_PREREQ(x, y) \
111 ((__GNUC__ == (x) && __GNUC_MINOR__ >= (y)) || \
114 #define MAKE_GNUC_PREREQ(x, y) 0
117 #if MAKE_GNUC_PREREQ(2, 7)
118 #define MAKE_ATTR_UNUSED __attribute__((__unused__))
120 #define MAKE_ATTR_UNUSED /* delete */
123 #if MAKE_GNUC_PREREQ(2, 5)
124 #define MAKE_ATTR_DEAD __attribute__((__noreturn__))
125 #elif defined(__GNUC__)
126 #define MAKE_ATTR_DEAD __volatile
128 #define MAKE_ATTR_DEAD /* delete */
131 #if MAKE_GNUC_PREREQ(2, 7)
132 #define MAKE_ATTR_PRINTFLIKE(fmtarg, firstvararg) \
133 __attribute__((__format__ (__printf__, fmtarg, firstvararg)))
135 #define MAKE_ATTR_PRINTFLIKE(fmtarg, firstvararg) /* delete */
138 #if MAKE_GNUC_PREREQ(4, 0)
139 #define MAKE_ATTR_USE __attribute__((__warn_unused_result__))
141 #define MAKE_ATTR_USE /* delete */
144 #if MAKE_GNUC_PREREQ(8, 0)
145 #define MAKE_ATTR_NOINLINE __attribute__((__noinline__))
147 #define MAKE_ATTR_NOINLINE /* delete */
150 #if __STDC_VERSION__ >= 199901L || defined(lint)
151 #define MAKE_INLINE static inline MAKE_ATTR_UNUSED
153 #define MAKE_INLINE static MAKE_ATTR_UNUSED
156 /* MAKE_STATIC marks a function that may or may not be inlined. */
158 /* As of 2021-07-31, NetBSD lint ignores __attribute__((unused)). */
159 #define MAKE_STATIC MAKE_INLINE
161 #define MAKE_STATIC static MAKE_ATTR_UNUSED
164 #if __STDC_VERSION__ >= 199901L || defined(lint) || defined(USE_C99_BOOLEAN)
166 #elif defined(__bool_true_false_are_defined)
168 * All files of make must be compiled with the same definition of bool.
169 * Since one of the files includes <stdbool.h>, that means the header is
170 * available on this platform. Recompile everything with -DUSE_C99_BOOLEAN.
172 #error "<stdbool.h> is included in pre-C99 mode"
173 #elif defined(bool) || defined(true) || defined(false)
175 * In pre-C99 mode, make does not expect that bool is already defined.
176 * You need to ensure that all translation units use the same definition for
179 #error "bool/true/false is defined in pre-C99 mode"
181 typedef unsigned char bool;
187 #include "make_malloc.h"
190 #include "make-conf.h"
194 * some vendors don't have this --sjg
196 #if defined(S_IFDIR) && !defined(S_ISDIR)
197 # define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
200 #if defined(sun) && (defined(__svr4__) || defined(__SVR4))
201 # define POSIX_SIGNALS
205 * IRIX defines OP_NONE in sys/fcntl.h
212 * The typical flow of states is:
214 * The direct successful path:
215 * UNMADE -> BEINGMADE -> MADE.
217 * The direct error path:
218 * UNMADE -> BEINGMADE -> ERROR.
220 * The successful path when dependencies need to be made first:
221 * UNMADE -> DEFERRED -> REQUESTED -> BEINGMADE -> MADE.
223 * A node that has dependencies, and one of the dependencies cannot be made:
224 * UNMADE -> DEFERRED -> ABORTED.
226 * A node that turns out to be up-to-date:
227 * UNMADE -> BEINGMADE -> UPTODATE.
229 typedef enum GNodeMade {
230 /* Not examined yet. */
233 * The node has been examined but is not yet ready since its
234 * dependencies have to be made first.
238 /* The node is on the toBeMade list. */
242 * The node is already being made. Trying to build a node in this
243 * state indicates a cycle in the graph.
247 /* Was out-of-date and has been made. */
249 /* Was already up-to-date, does not need to be made. */
252 * An error occurred while it was being made. Used only in compat
257 * The target was aborted due to an error making a dependency. Used
258 * only in compat mode.
264 * The OP_ constants are used when parsing a dependency line as a way of
265 * communicating to other parts of the program the way in which a target
268 * Some of the OP_ constants can be combined, others cannot.
270 * See the tests depsrc-*.mk and deptgt-*.mk.
272 typedef enum GNodeType {
276 * The dependency operator ':' is the most common one. The commands
277 * of this node are executed if any child is out-of-date.
281 * The dependency operator '!' always executes its commands, even if
282 * its children are up-to-date.
286 * The dependency operator '::' behaves like ':', except that it
287 * allows multiple dependency groups to be defined. Each of these
288 * groups is executed on its own, independently from the others. Each
289 * individual dependency group is called a cohort.
291 OP_DOUBLEDEP = 1 << 2,
293 /* Matches the dependency operators ':', '!' and '::'. */
294 OP_OPMASK = OP_DEPENDS | OP_FORCE | OP_DOUBLEDEP,
296 /* Don't care if the target doesn't exist and can't be created. */
297 OP_OPTIONAL = 1 << 3,
298 /* Use associated commands for parents. */
301 * Target is never out of date, but always execute commands anyway.
302 * Its time doesn't matter, so it has none...sort of.
306 * Ignore non-zero exit status from shell commands when creating the
310 /* Don't remove the target when interrupted. */
311 OP_PRECIOUS = 1 << 7,
312 /* Don't echo commands when executed. */
315 * Target is a recursive make so its commands should always be
316 * executed when it is out of date, regardless of the state of the -n
321 * Target is out-of-date only if any of its children was out-of-date.
324 /* Assume the children of the node have been already made. */
326 /* Special .BEGIN, .END or .INTERRUPT. */
327 OP_SPECIAL = 1 << 12,
328 /* Like .USE, only prepend commands. */
329 OP_USEBEFORE = 1 << 13,
331 * The node is invisible to its parents. I.e. it doesn't show up in
332 * the parents' local variables (.IMPSRC, .ALLSRC).
334 OP_INVISIBLE = 1 << 14,
336 * The node does not become the main target, even if it is the first
337 * target in the first makefile.
339 OP_NOTMAIN = 1 << 15,
340 /* Not a file target; run always. */
342 /* Don't search for the file in the path. */
345 * In a dependency line "target: source1 .WAIT source2", source1 is
346 * made first, including its children. Once that is finished,
347 * source2 is made, including its children. The .WAIT keyword may
348 * appear more than once in a single dependency declaration.
351 /* .NOMETA do not create a .meta file */
353 /* .META we _do_ want a .meta file */
355 /* Do not compare commands in .meta file */
356 OP_NOMETA_CMP = 1 << 21,
357 /* Possibly a submake node */
358 OP_SUBMAKE = 1 << 22,
360 /* Attributes applied by PMake */
362 /* The node is a transformation rule, such as ".c.o". */
363 OP_TRANSFORM = 1 << 30,
364 /* Target is a member of an archive */
365 /* XXX: How does this differ from OP_ARCHV? */
368 * The node is a library, its name has the form "-l<libname>".
372 * The node is an archive member, its name has the form
375 /* XXX: How does this differ from OP_MEMBER? */
378 * Target has all the commands it should. Used when parsing to catch
379 * multiple command groups for a target. Only applies to the
380 * dependency operators ':' and '!', but not to '::'.
382 OP_HAS_COMMANDS = 1 << 26,
384 * The special command "..." has been seen. All further commands from
385 * this node will be saved on the .END node instead, to be executed
388 OP_SAVE_CMDS = 1 << 25,
390 * Already processed by Suff_FindDeps, to find dependencies from
391 * suffix transformation rules.
393 OP_DEPS_FOUND = 1 << 24,
394 /* Node found while expanding .ALLSRC */
398 typedef struct GNodeFlags {
399 /* this target needs to be (re)made */
401 /* children of this target were made */
403 /* children don't exist, and we pretend made */
405 /* Set by Make_ProcessWait() */
407 /* Build requested by .ORDER processing */
409 /* Node created from .depend */
411 /* We do it once only */
413 /* Used by MakePrintStatus */
415 /* Used by MakePrintStatus */
419 typedef struct List StringList;
420 typedef struct ListNode StringListNode;
422 typedef struct List GNodeList;
423 typedef struct ListNode GNodeListNode;
425 typedef struct SearchPath {
426 List /* of CachedDir */ dirs;
430 * A graph node represents a target that can possibly be made, including its
431 * relation to other targets.
433 typedef struct GNode {
434 /* The target's name, such as "clean" or "make.c" */
436 /* The unexpanded name of a .USE node */
439 * The full pathname of the file belonging to the target.
441 * XXX: What about .PHONY targets? These don't have an associated
447 * The type of operator used to define the sources (see the OP flags
450 * XXX: This looks like a wild mixture of type and flags.
455 /* The state of processing on this node */
457 /* The number of unmade children */
461 * The modification time; 0 means the node does not have a
462 * corresponding file; see GNode_IsOODate.
465 struct GNode *youngestChild;
468 * The GNodes for which this node is an implied source. May be empty.
469 * For example, when there is an inference rule for .c.o, the node
470 * for file.c has the node for file.o in this list.
472 GNodeList implicitParents;
475 * The nodes that depend on this one, or in other words, the nodes
476 * for which this is a source.
479 /* The nodes on which this one depends. */
483 * .ORDER nodes we need made. The nodes that must be made (if they're
484 * made) before this node can be made, but that do not enter into the
485 * datedness of this node.
487 GNodeList order_pred;
489 * .ORDER nodes who need us. The nodes that must be made (if they're
490 * made at all) after this node is made, but that do not depend on
491 * this node, in the normal sense.
493 GNodeList order_succ;
496 * Other nodes of the same name, for targets that were defined using
497 * the '::' dependency operator (OP_DOUBLEDEP).
500 /* The "#n" suffix for this cohort, or "" for other nodes */
502 /* The number of unmade instances on the cohorts list */
505 * Pointer to the first instance of a '::' node; only set when on a
508 struct GNode *centurion;
510 /* Last time (sequence number) we tried to make this node */
511 unsigned int checked_seqno;
514 * The "local" variables that are specific to this target and this
515 * target only, such as $@, $<, $?.
517 * Also used for the global variable scopes SCOPE_GLOBAL,
518 * SCOPE_CMDLINE, SCOPE_INTERNAL, which contain variables with
521 HashTable /* of Var pointer */ vars;
523 /* The commands to be given to a shell to create this target. */
527 * Suffix for the node (determined by Suff_FindDeps and opaque to
528 * everyone but the Suff module)
530 struct Suffix *suffix;
532 /* Filename where the GNode got defined, unlimited lifetime */
534 /* Line number where the GNode got defined, 1-based */
540 * Keep track of whether to include <posix.mk> when parsing the line
543 extern enum PosixState {
550 /* Error levels for diagnostics during parsing. */
551 typedef enum ParseErrorLevel {
553 * Exit when the current top-level makefile has been parsed
557 /* Print "warning"; may be upgraded to fatal by the -w option. */
559 /* Informational, mainly used during development of makefiles. */
564 * Values returned by Cond_EvalLine and Cond_EvalCondition.
566 typedef enum CondResult {
567 CR_TRUE, /* Parse the next lines */
568 CR_FALSE, /* Skip the next lines */
569 CR_ERROR /* Unknown directive or parse error */
580 /* Names of the variables that are "local" to a specific target. */
581 #define TARGET "@" /* Target of dependency */
582 #define OODATE "?" /* All out-of-date sources */
583 #define ALLSRC ">" /* All sources */
584 #define IMPSRC "<" /* Source implied by transformation */
585 #define PREFIX "*" /* Common prefix */
586 #define ARCHIVE "!" /* Archive in "archive(member)" syntax */
587 #define MEMBER "%" /* Member in "archive(member)" syntax */
593 /* True if every target is precious */
594 extern bool allPrecious;
595 /* True if failed targets should be deleted */
596 extern bool deleteOnError;
597 /* true while processing .depend */
598 extern bool doing_depend;
600 extern GNode *defaultNode;
603 * Variables defined internally by make which should not override those set
606 extern GNode *SCOPE_INTERNAL;
607 /* Variables defined in a global scope, e.g in the makefile itself. */
608 extern GNode *SCOPE_GLOBAL;
609 /* Variables defined on the command line. */
610 extern GNode *SCOPE_CMDLINE;
613 * Value returned by Var_Parse when an error is encountered. It points to an
614 * empty string, so naive callers needn't worry about it.
616 extern char var_Error[];
618 /* The time at the start of this whole process */
622 * The list of directories to search when looking for targets (set by the
623 * special target .PATH).
625 extern SearchPath dirSearchPath;
626 /* Used for .include "...". */
627 extern SearchPath *parseIncPath;
629 * Used for .include <...>, for the built-in sys.mk and for makefiles from
630 * the command line arguments.
632 extern SearchPath *sysIncPath;
633 /* The default for sysIncPath. */
634 extern SearchPath *defSysIncPath;
636 /* Startup directory */
637 extern char curdir[];
638 /* The basename of the program name, suffixed with [n] for sub-makes. */
639 extern const char *progname;
640 extern int makelevel;
641 /* Name of the .depend makefile */
642 extern char *makeDependfile;
643 /* If we replaced environ, this will be non-NULL. */
644 extern char **savedEnv;
645 extern GNode *mainNode;
649 #define MAKEFLAGS ".MAKEFLAGS"
650 #ifndef MAKE_LEVEL_ENV
651 # define MAKE_LEVEL_ENV "MAKELEVEL"
654 typedef struct DebugFlags {
677 #define CONCAT(a, b) a##b
679 #define DEBUG(module) (opts.debug.CONCAT(DEBUG_, module))
681 void debug_printf(const char *, ...) MAKE_ATTR_PRINTFLIKE(1, 2);
683 #define DEBUG_IMPL(module, args) \
689 #define DEBUG0(module, fmt) \
690 DEBUG_IMPL(module, (fmt))
691 #define DEBUG1(module, fmt, arg1) \
692 DEBUG_IMPL(module, (fmt, arg1))
693 #define DEBUG2(module, fmt, arg1, arg2) \
694 DEBUG_IMPL(module, (fmt, arg1, arg2))
695 #define DEBUG3(module, fmt, arg1, arg2, arg3) \
696 DEBUG_IMPL(module, (fmt, arg1, arg2, arg3))
697 #define DEBUG4(module, fmt, arg1, arg2, arg3, arg4) \
698 DEBUG_IMPL(module, (fmt, arg1, arg2, arg3, arg4))
699 #define DEBUG5(module, fmt, arg1, arg2, arg3, arg4, arg5) \
700 DEBUG_IMPL(module, (fmt, arg1, arg2, arg3, arg4, arg5))
702 typedef enum PrintVarsMode {
708 /* Command line options */
709 typedef struct CmdOpts {
710 /* -B: whether to be compatible to traditional make */
714 * -d: debug control: There is one flag per module. It is up to the
715 * module what debug information to print.
719 /* -df: debug output is written here - default stderr */
725 * Runs make in strict mode, with additional checks and better error
730 /* -dV: for the -V option, print unexpanded variable values */
733 /* -e: check environment variables before global variables */
736 /* -f: the makefiles to read */
737 StringList makefiles;
739 /* -i: if true, ignore all errors from shell commands */
743 * -j: the maximum number of jobs that can run in parallel; this is
744 * coordinated with the submakes
749 * -k: if true and an error occurs while making a node, continue
750 * making nodes that do not depend on the erroneous node
754 /* -N: execute no commands from the targets */
755 bool noRecursiveExecute;
757 /* -n: execute almost no commands from the targets */
761 * -q: if true, do not really make anything, just see if the targets
766 /* -r: raw mode, do not load the builtin rules. */
769 /* -s: don't echo the shell commands before executing them */
773 * -t: touch the targets if they are out-of-date, but don't actually
778 /* -[Vv]: print expanded or unexpanded selected variables */
779 PrintVarsMode printVars;
780 /* -[Vv]: the variables to print */
781 StringList variables;
783 /* -W: if true, makefile parsing warnings are treated as errors */
786 /* -w: print 'Entering' and 'Leaving' for submakes */
790 * -X: if true, do not export variables set on the command line to
796 * The target names specified on the command line. Used to resolve
797 * .if make(...) statements.
802 * Randomize the order in which the targets from toBeMade are made,
803 * to catch undeclared dependencies.
805 bool randomizeTargets;
809 extern bool forceJobs;
810 extern char **environ;
813 void Arch_Init(void);
816 bool Arch_ParseArchive(char **, GNodeList *, GNode *);
817 void Arch_Touch(GNode *);
818 void Arch_TouchLib(GNode *);
819 void Arch_UpdateMTime(GNode *);
820 void Arch_UpdateMemberMTime(GNode *);
821 void Arch_FindLib(GNode *, SearchPath *);
822 bool Arch_LibOODate(GNode *) MAKE_ATTR_USE;
823 bool Arch_IsLib(GNode *) MAKE_ATTR_USE;
826 bool Compat_RunCommand(const char *, GNode *, StringListNode *);
827 void Compat_MakeAll(GNodeList *);
828 void Compat_Make(GNode *, GNode *);
831 extern unsigned int cond_depth;
832 CondResult Cond_EvalCondition(const char *) MAKE_ATTR_USE;
833 CondResult Cond_EvalLine(const char *) MAKE_ATTR_USE;
834 Guard *Cond_ExtractGuard(const char *) MAKE_ATTR_USE;
835 void Cond_EndFile(void);
837 /* dir.c; see also dir.h */
839 MAKE_INLINE const char * MAKE_ATTR_USE
840 str_basename(const char *pathname)
842 const char *lastSlash = strrchr(pathname, '/');
843 return lastSlash != NULL ? lastSlash + 1 : pathname;
846 MAKE_INLINE SearchPath * MAKE_ATTR_USE
849 SearchPath *path = bmake_malloc(sizeof *path);
850 Lst_Init(&path->dirs);
854 void SearchPath_Free(SearchPath *);
858 int For_Eval(const char *) MAKE_ATTR_USE;
859 bool For_Accum(const char *, int *) MAKE_ATTR_USE;
860 void For_Run(unsigned, unsigned);
861 bool For_NextIteration(struct ForLoop *, Buffer *);
862 char *ForLoop_Details(const struct ForLoop *);
863 void ForLoop_Free(struct ForLoop *);
864 void For_Break(struct ForLoop *);
867 void JobReapChild(pid_t, int, bool);
870 void Main_ParseArgLine(const char *);
871 char *Cmd_Exec(const char *, char **) MAKE_ATTR_USE;
872 void Error(const char *, ...) MAKE_ATTR_PRINTFLIKE(1, 2);
873 void Fatal(const char *, ...) MAKE_ATTR_PRINTFLIKE(1, 2) MAKE_ATTR_DEAD;
874 void Punt(const char *, ...) MAKE_ATTR_PRINTFLIKE(1, 2) MAKE_ATTR_DEAD;
875 void DieHorribly(void) MAKE_ATTR_DEAD;
876 void Finish(int) MAKE_ATTR_DEAD;
877 int unlink_file(const char *) MAKE_ATTR_USE;
878 void execDie(const char *, const char *);
879 char *getTmpdir(void) MAKE_ATTR_USE;
880 bool ParseBoolean(const char *, bool) MAKE_ATTR_USE;
881 const char *cached_realpath(const char *, char *);
882 bool GetBooleanExpr(const char *, bool);
885 void Parse_Init(void);
886 void Parse_End(void);
888 void PrintLocation(FILE *, bool, const GNode *);
889 void PrintStackTrace(bool);
890 void Parse_Error(ParseErrorLevel, const char *, ...) MAKE_ATTR_PRINTFLIKE(2, 3);
891 bool Parse_VarAssign(const char *, bool, GNode *) MAKE_ATTR_USE;
892 void Parse_File(const char *, int);
893 void Parse_PushInput(const char *, unsigned, unsigned, Buffer,
895 void Parse_MainName(GNodeList *);
896 int Parse_NumErrors(void) MAKE_ATTR_USE;
897 unsigned int CurFile_CondMinDepth(void) MAKE_ATTR_USE;
898 void Parse_GuardElse(void);
899 void Parse_GuardEndif(void);
903 void Suff_Init(void);
906 void Suff_ClearSuffixes(void);
907 bool Suff_IsTransform(const char *) MAKE_ATTR_USE;
908 GNode *Suff_AddTransform(const char *);
909 void Suff_EndTransform(GNode *);
910 void Suff_AddSuffix(const char *);
911 SearchPath *Suff_GetPath(const char *) MAKE_ATTR_USE;
912 void Suff_ExtendPaths(void);
913 void Suff_AddInclude(const char *);
914 void Suff_AddLib(const char *);
915 void Suff_FindDeps(GNode *);
916 SearchPath *Suff_FindPath(GNode *) MAKE_ATTR_USE;
917 void Suff_SetNull(const char *);
918 void Suff_PrintAll(void);
919 char *Suff_NamesStr(void) MAKE_ATTR_USE;
922 void Targ_Init(void);
925 void Targ_Stats(void);
926 GNodeList *Targ_List(void) MAKE_ATTR_USE;
927 GNode *GNode_New(const char *) MAKE_ATTR_USE;
928 GNode *Targ_FindNode(const char *) MAKE_ATTR_USE;
929 GNode *Targ_GetNode(const char *) MAKE_ATTR_USE;
930 GNode *Targ_NewInternalNode(const char *) MAKE_ATTR_USE;
931 GNode *Targ_GetEndNode(void);
932 void Targ_FindList(GNodeList *, StringList *);
933 void Targ_PrintCmds(GNode *);
934 void Targ_PrintNode(GNode *, int);
935 void Targ_PrintNodes(GNodeList *, int);
936 const char *Targ_FmtTime(time_t) MAKE_ATTR_USE;
937 void Targ_PrintType(GNodeType);
938 void Targ_PrintGraph(int);
939 void Targ_Propagate(void);
940 const char *GNodeMade_Name(GNodeMade) MAKE_ATTR_USE;
946 typedef enum VarEvalMode {
949 * Only parse the expression but don't evaluate any part of it.
951 * TODO: Document what Var_Parse and Var_Subst return in this mode.
952 * As of 2021-03-15, they return unspecified, inconsistent results.
957 * Parse text in which '${...}' and '$(...)' are not parsed as
958 * subexpressions (with all their individual escaping rules) but
959 * instead simply as text with balanced '${}' or '$()'. Other '$'
960 * are copied verbatim.
964 /* Parse and evaluate the expression. */
968 * Parse and evaluate the expression. It is an error if a
969 * subexpression evaluates to undefined.
974 * Parse and evaluate the expression. Keep '$$' as '$$' instead of
975 * reducing it to a single '$'. Subexpressions that evaluate to
976 * undefined expand to an empty string.
978 * Used in variable assignments using the ':=' operator. It allows
979 * multiple such assignments to be chained without accidentally
980 * expanding '$$file' to '$file' in the first assignment and
981 * interpreting it as '${f}' followed by 'ile' in the next assignment.
983 VARE_EVAL_KEEP_DOLLAR,
986 * Parse and evaluate the expression. Keep undefined variables as-is
987 * instead of expanding them to an empty string.
989 * Example for a ':=' assignment:
990 * CFLAGS = $(.INCLUDES)
991 * CFLAGS := -I.. $(CFLAGS)
992 * # If .INCLUDES (an undocumented special variable, by the
993 * # way) is still undefined, the updated CFLAGS becomes
994 * # "-I.. $(.INCLUDES)".
996 VARE_EVAL_KEEP_UNDEF,
999 * Parse and evaluate the expression. Keep '$$' as '$$' and preserve
1000 * undefined subexpressions.
1002 VARE_KEEP_DOLLAR_UNDEF
1005 typedef enum VarSetFlags {
1009 VAR_SET_NO_EXPORT = 1 << 0,
1012 * Make the variable read-only. No further modification is possible,
1013 * except for another call to Var_Set with the same flag. See the
1014 * special targets '.NOREADONLY' and '.READONLY'.
1016 VAR_SET_READONLY = 1 << 1
1019 typedef enum VarExportMode {
1022 /* .export: Initial export or update an already exported variable. */
1024 /* .export-literal: Do not expand the variable value. */
1028 void Var_Delete(GNode *, const char *);
1029 void Var_Undef(const char *);
1030 void Var_Set(GNode *, const char *, const char *);
1031 void Var_SetExpand(GNode *, const char *, const char *);
1032 void Var_SetWithFlags(GNode *, const char *, const char *, VarSetFlags);
1033 void Var_Append(GNode *, const char *, const char *);
1034 void Var_AppendExpand(GNode *, const char *, const char *);
1035 bool Var_Exists(GNode *, const char *) MAKE_ATTR_USE;
1036 bool Var_ExistsExpand(GNode *, const char *) MAKE_ATTR_USE;
1037 FStr Var_Value(GNode *, const char *) MAKE_ATTR_USE;
1038 const char *GNode_ValueDirect(GNode *, const char *) MAKE_ATTR_USE;
1039 FStr Var_Parse(const char **, GNode *, VarEvalMode);
1040 char *Var_Subst(const char *, GNode *, VarEvalMode);
1041 void Var_Expand(FStr *, GNode *, VarEvalMode);
1042 void Var_Stats(void);
1043 void Var_Dump(GNode *);
1044 void Var_ReexportVars(GNode *);
1045 void Var_Export(VarExportMode, const char *);
1046 void Var_ExportVars(const char *);
1047 void Var_UnExport(bool, const char *);
1048 void Var_ReadOnly(const char *, bool);
1050 void Global_Set(const char *, const char *);
1051 void Global_Append(const char *, const char *);
1052 void Global_Delete(const char *);
1053 void Global_Set_ReadOnly(const char *, const char *);
1055 void EvalStack_Push(const char *, const char *, const char *);
1056 void EvalStack_Pop(void);
1057 const char *EvalStack_Details(void);
1060 typedef void (*SignalProc)(int);
1061 SignalProc bmake_signal(int, SignalProc);
1064 void GNode_UpdateYoungestChild(GNode *, GNode *);
1065 bool GNode_IsOODate(GNode *) MAKE_ATTR_USE;
1066 void Make_ExpandUse(GNodeList *);
1067 time_t Make_Recheck(GNode *) MAKE_ATTR_USE;
1068 void Make_HandleUse(GNode *, GNode *);
1069 void Make_Update(GNode *);
1070 void GNode_SetLocalVars(GNode *);
1071 bool Make_Run(GNodeList *);
1072 bool shouldDieQuietly(GNode *, int) MAKE_ATTR_USE;
1073 void PrintOnError(GNode *, const char *);
1074 void Main_ExportMAKEFLAGS(bool);
1075 bool Main_SetObjdir(bool, const char *, ...) MAKE_ATTR_PRINTFLIKE(2, 3);
1076 int mkTempFile(const char *, char *, size_t) MAKE_ATTR_USE;
1077 void AppendWords(StringList *, char *);
1078 void GNode_FprintDetails(FILE *, const char *, const GNode *, const char *);
1079 bool GNode_ShouldExecute(GNode *gn) MAKE_ATTR_USE;
1081 #ifndef HAVE_STRLCPY
1082 size_t strlcpy(char *, const char *, size_t);
1085 /* See if the node was seen on the left-hand side of a dependency operator. */
1086 MAKE_INLINE bool MAKE_ATTR_USE
1087 GNode_IsTarget(const GNode *gn)
1089 return (gn->type & OP_OPMASK) != OP_NONE;
1092 MAKE_INLINE const char * MAKE_ATTR_USE
1093 GNode_Path(const GNode *gn)
1095 return gn->path != NULL ? gn->path : gn->name;
1098 MAKE_INLINE bool MAKE_ATTR_USE
1099 GNode_IsWaitingFor(const GNode *gn)
1101 return gn->flags.remake && gn->made <= REQUESTED;
1104 MAKE_INLINE bool MAKE_ATTR_USE
1105 GNode_IsReady(const GNode *gn)
1107 return gn->made > DEFERRED;
1110 MAKE_INLINE bool MAKE_ATTR_USE
1111 GNode_IsDone(const GNode *gn)
1113 return gn->made >= MADE;
1116 MAKE_INLINE bool MAKE_ATTR_USE
1117 GNode_IsError(const GNode *gn)
1119 return gn->made == ERROR || gn->made == ABORTED;
1122 MAKE_INLINE bool MAKE_ATTR_USE
1123 GNode_IsMainCandidate(const GNode *gn)
1125 return (gn->type & (OP_NOTMAIN | OP_USE | OP_USEBEFORE |
1126 OP_EXEC | OP_TRANSFORM)) == 0;
1129 /* Return whether the target file should be preserved on interrupt. */
1130 MAKE_INLINE bool MAKE_ATTR_USE
1131 GNode_IsPrecious(const GNode *gn)
1133 /* XXX: Why are '::' targets precious? */
1134 return allPrecious || gn->type & (OP_PRECIOUS | OP_DOUBLEDEP);
1137 MAKE_INLINE const char * MAKE_ATTR_USE
1138 GNode_VarTarget(GNode *gn) { return GNode_ValueDirect(gn, TARGET); }
1139 MAKE_INLINE const char * MAKE_ATTR_USE
1140 GNode_VarOodate(GNode *gn) { return GNode_ValueDirect(gn, OODATE); }
1141 MAKE_INLINE const char * MAKE_ATTR_USE
1142 GNode_VarAllsrc(GNode *gn) { return GNode_ValueDirect(gn, ALLSRC); }
1143 MAKE_INLINE const char * MAKE_ATTR_USE
1144 GNode_VarImpsrc(GNode *gn) { return GNode_ValueDirect(gn, IMPSRC); }
1145 MAKE_INLINE const char * MAKE_ATTR_USE
1146 GNode_VarPrefix(GNode *gn) { return GNode_ValueDirect(gn, PREFIX); }
1147 MAKE_INLINE const char * MAKE_ATTR_USE
1148 GNode_VarArchive(GNode *gn) { return GNode_ValueDirect(gn, ARCHIVE); }
1149 MAKE_INLINE const char * MAKE_ATTR_USE
1150 GNode_VarMember(GNode *gn) { return GNode_ValueDirect(gn, MEMBER); }
1152 MAKE_INLINE void * MAKE_ATTR_USE
1153 UNCONST(const void *ptr)
1156 memcpy(&ret, &ptr, sizeof(ret));
1160 /* At least GNU/Hurd systems lack hardcoded MAXPATHLEN/PATH_MAX */
1161 #ifdef HAVE_LIMITS_H
1165 #define MAXPATHLEN BMAKE_PATH_MAX
1168 #define PATH_MAX MAXPATHLEN
1172 #define KILLPG(pid, sig) kill(-(pid), (sig))
1174 #define KILLPG(pid, sig) killpg((pid), (sig))
1177 MAKE_INLINE bool MAKE_ATTR_USE
1178 ch_isalnum(char ch) { return isalnum((unsigned char)ch) != 0; }
1179 MAKE_INLINE bool MAKE_ATTR_USE
1180 ch_isalpha(char ch) { return isalpha((unsigned char)ch) != 0; }
1181 MAKE_INLINE bool MAKE_ATTR_USE
1182 ch_isdigit(char ch) { return isdigit((unsigned char)ch) != 0; }
1183 MAKE_INLINE bool MAKE_ATTR_USE
1184 ch_islower(char ch) { return islower((unsigned char)ch) != 0; }
1185 MAKE_INLINE bool MAKE_ATTR_USE
1186 ch_isspace(char ch) { return isspace((unsigned char)ch) != 0; }
1187 MAKE_INLINE bool MAKE_ATTR_USE
1188 ch_isupper(char ch) { return isupper((unsigned char)ch) != 0; }
1189 MAKE_INLINE char MAKE_ATTR_USE
1190 ch_tolower(char ch) { return (char)tolower((unsigned char)ch); }
1191 MAKE_INLINE char MAKE_ATTR_USE
1192 ch_toupper(char ch) { return (char)toupper((unsigned char)ch); }
1195 cpp_skip_whitespace(const char **pp)
1197 while (ch_isspace(**pp))
1202 cpp_skip_hspace(const char **pp)
1204 while (**pp == ' ' || **pp == '\t')
1209 cpp_skip_string(const char **pp, const char *s)
1211 const char *p = *pp;
1212 while (*p == *s && *s != '\0')
1220 pp_skip_whitespace(char **pp)
1222 while (ch_isspace(**pp))
1227 pp_skip_hspace(char **pp)
1229 while (**pp == ' ' || **pp == '\t')
1234 void do_not_define_rcsid(void); /* for lint */
1235 # define MAKE_RCSID(id) void do_not_define_rcsid(void)
1236 #elif defined(MAKE_NATIVE)
1237 # include <sys/cdefs.h>
1239 # define __IDSTRING(name,string) \
1240 static const char name[] MAKE_ATTR_UNUSED = string
1243 # define __RCSID(s) __IDSTRING(rcsid,s)
1245 # ifndef __COPYRIGHT
1246 # define __COPYRIGHT(s) __IDSTRING(copyright,s)
1248 # define MAKE_RCSID(id) __RCSID(id)
1249 #elif defined(MAKE_ALL_IN_ONE) && defined(__COUNTER__)
1250 # define MAKE_RCSID_CONCAT(x, y) CONCAT(x, y)
1251 # define MAKE_RCSID(id) static volatile char \
1252 MAKE_RCSID_CONCAT(rcsid_, __COUNTER__)[] = id
1253 #elif defined(MAKE_ALL_IN_ONE)
1254 # define MAKE_RCSID(id) void do_not_define_rcsid(void)
1256 # define MAKE_RCSID(id) static volatile char rcsid[] = id