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