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