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