make.h revision 1.132 1 /* $NetBSD: make.h,v 1.132 2020/08/29 12:20:17 rillig Exp $ */
2
3 /*
4 * Copyright (c) 1988, 1989, 1990, 1993
5 * The Regents of the University of California. All rights reserved.
6 *
7 * This code is derived from software contributed to Berkeley by
8 * Adam de Boor.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 *
34 * from: @(#)make.h 8.3 (Berkeley) 6/13/95
35 */
36
37 /*
38 * Copyright (c) 1989 by Berkeley Softworks
39 * All rights reserved.
40 *
41 * This code is derived from software contributed to Berkeley by
42 * Adam de Boor.
43 *
44 * Redistribution and use in source and binary forms, with or without
45 * modification, are permitted provided that the following conditions
46 * are met:
47 * 1. Redistributions of source code must retain the above copyright
48 * notice, this list of conditions and the following disclaimer.
49 * 2. Redistributions in binary form must reproduce the above copyright
50 * notice, this list of conditions and the following disclaimer in the
51 * documentation and/or other materials provided with the distribution.
52 * 3. All advertising materials mentioning features or use of this software
53 * must display the following acknowledgement:
54 * This product includes software developed by the University of
55 * California, Berkeley and its contributors.
56 * 4. Neither the name of the University nor the names of its contributors
57 * may be used to endorse or promote products derived from this software
58 * without specific prior written permission.
59 *
60 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
61 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
62 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
63 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
64 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
65 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
66 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
67 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
68 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
69 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
70 * SUCH DAMAGE.
71 *
72 * from: @(#)make.h 8.3 (Berkeley) 6/13/95
73 */
74
75 /*-
76 * make.h --
77 * The global definitions for pmake
78 */
79
80 #ifndef MAKE_MAKE_H
81 #define MAKE_MAKE_H
82
83 #include <sys/types.h>
84 #include <sys/param.h>
85
86 #include <assert.h>
87 #include <ctype.h>
88 #include <fcntl.h>
89 #include <stdio.h>
90 #include <stdlib.h>
91 #include <string.h>
92 #include <unistd.h>
93
94 #ifdef BSD4_4
95 # include <sys/cdefs.h>
96 #endif
97
98 #ifndef FD_CLOEXEC
99 #define FD_CLOEXEC 1
100 #endif
101
102 #if defined(__GNUC__)
103 #define MAKE_GNUC_PREREQ(x, y) \
104 ((__GNUC__ == (x) && __GNUC_MINOR__ >= (y)) || \
105 (__GNUC__ > (x)))
106 #else /* defined(__GNUC__) */
107 #define MAKE_GNUC_PREREQ(x, y) 0
108 #endif /* defined(__GNUC__) */
109
110 #if MAKE_GNUC_PREREQ(2, 7)
111 #define MAKE_ATTR_UNUSED __attribute__((__unused__))
112 #else
113 #define MAKE_ATTR_UNUSED /* delete */
114 #endif
115
116 #if MAKE_GNUC_PREREQ(2, 5)
117 #define MAKE_ATTR_DEAD __attribute__((__noreturn__))
118 #elif defined(__GNUC__)
119 #define MAKE_ATTR_DEAD __volatile
120 #else
121 #define MAKE_ATTR_DEAD /* delete */
122 #endif
123
124 #if MAKE_GNUC_PREREQ(2, 7)
125 #define MAKE_ATTR_PRINTFLIKE(fmtarg, firstvararg) \
126 __attribute__((__format__ (__printf__, fmtarg, firstvararg)))
127 #else
128 #define MAKE_ATTR_PRINTFLIKE(fmtarg, firstvararg) /* delete */
129 #endif
130
131 /*
132 * A boolean type is defined as an integer, not an enum. This allows a
133 * boolean argument to be an expression that isn't strictly 0 or 1 valued.
134 */
135
136 #ifdef USE_DOUBLE_BOOLEAN
137 /* During development, to find type mismatches in function declarations. */
138 typedef double Boolean;
139 #elif defined(USE_UCHAR_BOOLEAN)
140 /* During development, to find code that depends on the exact value of TRUE or
141 * that stores other values in Boolean variables. */
142 typedef unsigned char Boolean;
143 #define TRUE ((unsigned char)0xFF)
144 #define FALSE ((unsigned char)0x00)
145 #else
146 typedef int Boolean;
147 #endif
148 #ifndef TRUE
149 #define TRUE 1
150 #endif /* TRUE */
151 #ifndef FALSE
152 #define FALSE 0
153 #endif /* FALSE */
154
155 #include "lst.h"
156 #include "enum.h"
157 #include "hash.h"
158 #include "config.h"
159 #include "buf.h"
160 #include "make_malloc.h"
161
162 typedef enum {
163 UNMADE, /* Not examined yet */
164 DEFERRED, /* Examined once (building child) */
165 REQUESTED, /* on toBeMade list */
166 BEINGMADE, /* Target is already being made.
167 * Indicates a cycle in the graph. */
168 MADE, /* Was out-of-date and has been made */
169 UPTODATE, /* Was already up-to-date */
170 ERROR, /* An error occurred while it was being
171 * made (used only in compat mode) */
172 ABORTED /* The target was aborted due to an error
173 * making an inferior (compat). */
174 } GNodeMade;
175
176 /* The OP_ constants are used when parsing a dependency line as a way of
177 * communicating to other parts of the program the way in which a target
178 * should be made.
179 *
180 * These constants are bitwise-OR'ed together and placed in the 'type' field
181 * of each node. Any node that has a 'type' field which satisfies the OP_NOP
182 * function was never never on the left-hand side of an operator, though it
183 * may have been on the right-hand side... */
184 typedef enum {
185 /* Execution of commands depends on children (:) */
186 OP_DEPENDS = 1 << 0,
187 /* Always execute commands (!) */
188 OP_FORCE = 1 << 1,
189 /* Execution of commands depends on children per line (::) */
190 OP_DOUBLEDEP = 1 << 2,
191
192 OP_OPMASK = OP_DEPENDS|OP_FORCE|OP_DOUBLEDEP,
193
194 /* Don't care if the target doesn't exist and can't be created */
195 OP_OPTIONAL = 1 << 3,
196 /* Use associated commands for parents */
197 OP_USE = 1 << 4,
198 /* Target is never out of date, but always execute commands anyway.
199 * Its time doesn't matter, so it has none...sort of */
200 OP_EXEC = 1 << 5,
201 /* Ignore errors when creating the node */
202 OP_IGNORE = 1 << 6,
203 /* Don't remove the target when interrupted */
204 OP_PRECIOUS = 1 << 7,
205 /* Don't echo commands when executed */
206 OP_SILENT = 1 << 8,
207 /* Target is a recursive make so its commands should always be executed
208 * when it is out of date, regardless of the state of the -n or -t flags */
209 OP_MAKE = 1 << 9,
210 /* Target is out-of-date only if any of its children was out-of-date */
211 OP_JOIN = 1 << 10,
212 /* Assume the children of the node have been already made */
213 OP_MADE = 1 << 11,
214 /* Special .BEGIN, .END, .INTERRUPT */
215 OP_SPECIAL = 1 << 12,
216 /* Like .USE, only prepend commands */
217 OP_USEBEFORE = 1 << 13,
218 /* The node is invisible to its parents. I.e. it doesn't show up in the
219 * parents' local variables. */
220 OP_INVISIBLE = 1 << 14,
221 /* The node is exempt from normal 'main target' processing in parse.c */
222 OP_NOTMAIN = 1 << 15,
223 /* Not a file target; run always */
224 OP_PHONY = 1 << 16,
225 /* Don't search for file in the path */
226 OP_NOPATH = 1 << 17,
227 /* .WAIT phony node */
228 OP_WAIT = 1 << 18,
229 /* .NOMETA do not create a .meta file */
230 OP_NOMETA = 1 << 19,
231 /* .META we _do_ want a .meta file */
232 OP_META = 1 << 20,
233 /* Do not compare commands in .meta file */
234 OP_NOMETA_CMP = 1 << 21,
235 /* Possibly a submake node */
236 OP_SUBMAKE = 1 << 22,
237
238 /* Attributes applied by PMake */
239
240 /* The node is a transformation rule */
241 OP_TRANSFORM = 1 << 31,
242 /* Target is a member of an archive */
243 OP_MEMBER = 1 << 30,
244 /* Target is a library */
245 OP_LIB = 1 << 29,
246 /* Target is an archive construct */
247 OP_ARCHV = 1 << 28,
248 /* Target has all the commands it should. Used when parsing to catch
249 * multiple commands for a target. */
250 OP_HAS_COMMANDS = 1 << 27,
251 /* Saving commands on .END (Compat) */
252 OP_SAVE_CMDS = 1 << 26,
253 /* Already processed by Suff_FindDeps */
254 OP_DEPS_FOUND = 1 << 25,
255 /* Node found while expanding .ALLSRC */
256 OP_MARK = 1 << 24
257 } GNodeType;
258
259 typedef enum {
260 REMAKE = 0x0001, /* this target needs to be (re)made */
261 CHILDMADE = 0x0002, /* children of this target were made */
262 FORCE = 0x0004, /* children don't exist, and we pretend made */
263 DONE_WAIT = 0x0008, /* Set by Make_ProcessWait() */
264 DONE_ORDER = 0x0010, /* Build requested by .ORDER processing */
265 FROM_DEPEND = 0x0020, /* Node created from .depend */
266 DONE_ALLSRC = 0x0040, /* We do it once only */
267 CYCLE = 0x1000, /* Used by MakePrintStatus */
268 DONECYCLE = 0x2000, /* Used by MakePrintStatus */
269 INTERNAL = 0x4000 /* Internal use only */
270 } GNodeFlags;
271
272 /* A graph node represents a target that can possibly be made, including its
273 * relation to other targets and a lot of other details. */
274 typedef struct GNode {
275 /* The target's name, such as "clean" or "make.c" */
276 char *name;
277 /* The unexpanded name of a .USE node */
278 char *uname;
279 /* The full pathname of the file belonging to the target.
280 * XXX: What about .PHONY targets? These don't have an associated path. */
281 char *path;
282
283 /* The type of operator used to define the sources (see the OP flags below).
284 * XXX: This looks like a wild mixture of type and flags. */
285 GNodeType type;
286 /* whether it is involved in this invocation of make */
287 GNodeFlags flags;
288
289 /* The state of processing on this node */
290 GNodeMade made;
291 int unmade; /* The number of unmade children */
292
293 time_t mtime; /* Its modification time */
294 struct GNode *cmgn; /* The youngest child */
295
296 /* Links to parents for which this is an implied source. May be empty.
297 * Nodes that depend on this, as gleaned from the transformation rules. */
298 Lst iParents;
299
300 /* Other nodes of the same name for the :: operator. */
301 Lst cohorts;
302
303 /* The nodes that depend on this one, or in other words, the nodes for
304 * which this is a source. */
305 Lst parents;
306 /* The nodes on which this one depends. */
307 Lst children;
308
309 /* .ORDER nodes we need made. The nodes that must be made (if they're
310 * made) before this node can be made, but that do not enter into the
311 * datedness of this node. */
312 Lst order_pred;
313 /* .ORDER nodes who need us. The nodes that must be made (if they're made
314 * at all) after this node is made, but that do not depend on this node,
315 * in the normal sense. */
316 Lst order_succ;
317
318 /* #n for this cohort */
319 char cohort_num[8];
320 /* The number of unmade instances on the cohorts list */
321 int unmade_cohorts;
322 /* Pointer to the first instance of a '::' node; only set when on a
323 * cohorts list */
324 struct GNode *centurion;
325
326 /* Last time (sequence number) we tried to make this node */
327 unsigned int checked;
328
329 /* The "local" variables that are specific to this target and this target
330 * only, such as $@, $<, $?. */
331 Hash_Table context;
332
333 /* The commands to be given to a shell to create this target. */
334 Lst commands;
335
336 /* Suffix for the node (determined by Suff_FindDeps and opaque to everyone
337 * but the Suff module) */
338 struct Suff *suffix;
339
340 /* filename where the GNode got defined */
341 const char *fname;
342 /* line number where the GNode got defined */
343 int lineno;
344 } GNode;
345
346 #define NoExecute(gn) ((gn->type & OP_MAKE) ? noRecursiveExecute : noExecute)
347 /*
348 * OP_NOP will return TRUE if the node with the given type was not the
349 * object of a dependency operator
350 */
351 #define OP_NOP(t) (((t) & OP_OPMASK) == 0x00000000)
352
353 #define OP_NOTARGET (OP_NOTMAIN|OP_USE|OP_EXEC|OP_TRANSFORM)
354
355 /*
356 * The TARG_ constants are used when calling the Targ_FindNode and
357 * Targ_FindList functions in targ.c. They simply tell the functions what to
358 * do if the desired node(s) is (are) not found. If the TARG_CREATE constant
359 * is given, a new, empty node will be created for the target, placed in the
360 * table of all targets and its address returned. If TARG_NOCREATE is given,
361 * a NULL pointer will be returned.
362 */
363 #define TARG_NOCREATE 0x00 /* don't create it */
364 #define TARG_CREATE 0x01 /* create node if not found */
365 #define TARG_NOHASH 0x02 /* don't look in/add to hash table */
366
367 /*
368 * Error levels for parsing. PARSE_FATAL means the process cannot continue
369 * once the makefile has been parsed. PARSE_WARNING means it can. Passed
370 * as the first argument to Parse_Error.
371 */
372 #define PARSE_INFO 3
373 #define PARSE_WARNING 2
374 #define PARSE_FATAL 1
375
376 /*
377 * Values returned by Cond_Eval.
378 */
379 typedef enum {
380 COND_PARSE, /* Parse the next lines */
381 COND_SKIP, /* Skip the next lines */
382 COND_INVALID /* Not a conditional statement */
383 } CondEvalResult;
384
385 /*
386 * Definitions for the "local" variables. Used only for clarity.
387 */
388 #define TARGET "@" /* Target of dependency */
389 #define OODATE "?" /* All out-of-date sources */
390 #define ALLSRC ">" /* All sources */
391 #define IMPSRC "<" /* Source implied by transformation */
392 #define PREFIX "*" /* Common prefix */
393 #define ARCHIVE "!" /* Archive in "archive(member)" syntax */
394 #define MEMBER "%" /* Member in "archive(member)" syntax */
395
396 #define FTARGET "@F" /* file part of TARGET */
397 #define DTARGET "@D" /* directory part of TARGET */
398 #define FIMPSRC "<F" /* file part of IMPSRC */
399 #define DIMPSRC "<D" /* directory part of IMPSRC */
400 #define FPREFIX "*F" /* file part of PREFIX */
401 #define DPREFIX "*D" /* directory part of PREFIX */
402
403 /*
404 * Global Variables
405 */
406 extern Lst create; /* The list of target names specified on the
407 * command line. used to resolve #if
408 * make(...) statements */
409 extern Lst dirSearchPath; /* The list of directories to search when
410 * looking for targets */
411
412 extern Boolean compatMake; /* True if we are make compatible */
413 extern Boolean ignoreErrors; /* True if should ignore all errors */
414 extern Boolean beSilent; /* True if should print no commands */
415 extern Boolean noExecute; /* True if should execute nothing */
416 extern Boolean noRecursiveExecute; /* True if should execute nothing */
417 extern Boolean allPrecious; /* True if every target is precious */
418 extern Boolean deleteOnError; /* True if failed targets should be deleted */
419 extern Boolean keepgoing; /* True if should continue on unaffected
420 * portions of the graph when have an error
421 * in one portion */
422 extern Boolean touchFlag; /* TRUE if targets should just be 'touched'
423 * if out of date. Set by the -t flag */
424 extern Boolean queryFlag; /* TRUE if we aren't supposed to really make
425 * anything, just see if the targets are out-
426 * of-date */
427 extern Boolean doing_depend; /* TRUE if processing .depend */
428
429 extern Boolean checkEnvFirst; /* TRUE if environment should be searched for
430 * variables before the global context */
431
432 extern Boolean parseWarnFatal; /* TRUE if makefile parsing warnings are
433 * treated as errors */
434
435 extern Boolean varNoExportEnv; /* TRUE if we should not export variables
436 * set on the command line to the env. */
437
438 extern GNode *DEFAULT; /* .DEFAULT rule */
439
440 extern GNode *VAR_INTERNAL; /* Variables defined internally by make
441 * which should not override those set by
442 * makefiles.
443 */
444 extern GNode *VAR_GLOBAL; /* Variables defined in a global context, e.g
445 * in the Makefile itself */
446 extern GNode *VAR_CMD; /* Variables defined on the command line */
447 extern char var_Error[]; /* Value returned by Var_Parse when an error
448 * is encountered. It actually points to
449 * an empty string, so naive callers needn't
450 * worry about it. */
451
452 extern time_t now; /* The time at the start of this whole
453 * process */
454
455 extern Boolean oldVars; /* Do old-style variable substitution */
456
457 extern Lst sysIncPath; /* The system include path. */
458 extern Lst defIncPath; /* The default include path. */
459
460 extern char curdir[]; /* Startup directory */
461 extern char *progname; /* The program name */
462 extern char *makeDependfile; /* .depend */
463 extern char **savedEnv; /* if we replaced environ this will be non-NULL */
464
465 extern int makelevel;
466
467 /*
468 * We cannot vfork() in a child of vfork().
469 * Most systems do not enforce this but some do.
470 */
471 #define vFork() ((getpid() == myPid) ? vfork() : fork())
472 extern pid_t myPid;
473
474 #define MAKEFLAGS ".MAKEFLAGS"
475 #define MAKEOVERRIDES ".MAKEOVERRIDES"
476 #define MAKE_JOB_PREFIX ".MAKE.JOB.PREFIX" /* prefix for job target output */
477 #define MAKE_EXPORTED ".MAKE.EXPORTED" /* variables we export */
478 #define MAKE_MAKEFILES ".MAKE.MAKEFILES" /* all the makefiles we read */
479 #define MAKE_LEVEL ".MAKE.LEVEL" /* recursion level */
480 #define MAKEFILE_PREFERENCE ".MAKE.MAKEFILE_PREFERENCE"
481 #define MAKE_DEPENDFILE ".MAKE.DEPENDFILE" /* .depend */
482 #define MAKE_MODE ".MAKE.MODE"
483 #ifndef MAKE_LEVEL_ENV
484 # define MAKE_LEVEL_ENV "MAKELEVEL"
485 #endif
486
487 /*
488 * debug control:
489 * There is one bit per module. It is up to the module what debug
490 * information to print.
491 */
492 extern FILE *debug_file; /* Output is written here - default stderr */
493 extern int debug;
494 #define DEBUG_ARCH 0x00001
495 #define DEBUG_COND 0x00002
496 #define DEBUG_DIR 0x00004
497 #define DEBUG_GRAPH1 0x00008
498 #define DEBUG_GRAPH2 0x00010
499 #define DEBUG_JOB 0x00020
500 #define DEBUG_MAKE 0x00040
501 #define DEBUG_SUFF 0x00080
502 #define DEBUG_TARG 0x00100
503 #define DEBUG_VAR 0x00200
504 #define DEBUG_FOR 0x00400
505 #define DEBUG_SHELL 0x00800
506 #define DEBUG_ERROR 0x01000
507 #define DEBUG_LOUD 0x02000
508 #define DEBUG_META 0x04000
509 #define DEBUG_HASH 0x08000
510
511 #define DEBUG_GRAPH3 0x10000
512 #define DEBUG_SCRIPT 0x20000
513 #define DEBUG_PARSE 0x40000
514 #define DEBUG_CWD 0x80000
515
516 #define DEBUG_LINT 0x100000
517
518 #define CONCAT(a,b) a##b
519
520 #define DEBUG(module) (debug & CONCAT(DEBUG_,module))
521
522 #include "nonints.h"
523
524 int Make_TimeStamp(GNode *, GNode *);
525 Boolean Make_OODate(GNode *);
526 void Make_ExpandUse(Lst);
527 time_t Make_Recheck(GNode *);
528 void Make_HandleUse(GNode *, GNode *);
529 void Make_Update(GNode *);
530 void Make_DoAllVar(GNode *);
531 Boolean Make_Run(Lst);
532 int dieQuietly(GNode *, int);
533 void PrintOnError(GNode *, const char *);
534 void Main_ExportMAKEFLAGS(Boolean);
535 Boolean Main_SetObjdir(const char *, ...) MAKE_ATTR_PRINTFLIKE(1, 2);
536 int mkTempFile(const char *, char **);
537 int str2Lst_Append(Lst, char *, const char *);
538 int cached_lstat(const char *, void *);
539 int cached_stat(const char *, void *);
540 void GNode_FprintDetails(FILE *, const char *, const GNode *, const char *);
541
542 #ifdef __GNUC__
543 #define UNCONST(ptr) ({ \
544 union __unconst { \
545 const void *__cp; \
546 void *__p; \
547 } __d; \
548 __d.__cp = ptr, __d.__p; })
549 #else
550 #define UNCONST(ptr) (void *)(ptr)
551 #endif
552
553 #ifndef MIN
554 #define MIN(a, b) ((a < b) ? a : b)
555 #endif
556 #ifndef MAX
557 #define MAX(a, b) ((a > b) ? a : b)
558 #endif
559
560 /* At least GNU/Hurd systems lack hardcoded MAXPATHLEN/PATH_MAX */
561 #include <limits.h>
562 #ifndef MAXPATHLEN
563 #define MAXPATHLEN 4096
564 #endif
565 #ifndef PATH_MAX
566 #define PATH_MAX MAXPATHLEN
567 #endif
568
569 #if defined(SYSV)
570 #define KILLPG(pid, sig) kill(-(pid), (sig))
571 #else
572 #define KILLPG(pid, sig) killpg((pid), (sig))
573 #endif
574
575 #endif /* MAKE_MAKE_H */
576