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