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