Sync with manuals from netbsd-8 branch.
[minix3.git] / usr.bin / make / make.h
blobf162ef6703061a02de8d2052e7be8154704ab4c5
1 /* $NetBSD: make.h,v 1.96 2015/09/21 21:50:16 pooka Exp $ */
3 /*
4 * Copyright (c) 1988, 1989, 1990, 1993
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
8 * Adam de Boor.
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.
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.
34 * from: @(#)make.h 8.3 (Berkeley) 6/13/95
38 * Copyright (c) 1989 by Berkeley Softworks
39 * All rights reserved.
41 * This code is derived from software contributed to Berkeley by
42 * Adam de Boor.
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.
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.
72 * from: @(#)make.h 8.3 (Berkeley) 6/13/95
75 /*-
76 * make.h --
77 * The global definitions for pmake
80 #ifndef _MAKE_H_
81 #define _MAKE_H_
83 #include <sys/types.h>
84 #include <sys/param.h>
86 #include <ctype.h>
87 #include <stdio.h>
88 #include <stdlib.h>
89 #include <string.h>
90 #include <unistd.h>
92 #ifdef BSD4_4
93 # include <sys/cdefs.h>
94 #endif
96 #if defined(__GNUC__)
97 #define MAKE_GNUC_PREREQ(x, y) \
98 ((__GNUC__ == (x) && __GNUC_MINOR__ >= (y)) || \
99 (__GNUC__ > (x)))
100 #else /* defined(__GNUC__) */
101 #define MAKE_GNUC_PREREQ(x, y) 0
102 #endif /* defined(__GNUC__) */
104 #if MAKE_GNUC_PREREQ(2, 7)
105 #define MAKE_ATTR_UNUSED __attribute__((__unused__))
106 #else
107 #define MAKE_ATTR_UNUSED /* delete */
108 #endif
110 #if MAKE_GNUC_PREREQ(2, 5)
111 #define MAKE_ATTR_DEAD __attribute__((__noreturn__))
112 #elif defined(__GNUC__)
113 #define MAKE_ATTR_DEAD __volatile
114 #else
115 #define MAKE_ATTR_DEAD /* delete */
116 #endif
118 #if MAKE_GNUC_PREREQ(2, 7)
119 #define MAKE_ATTR_PRINTFLIKE(fmtarg, firstvararg) \
120 __attribute__((__format__ (__printf__, fmtarg, firstvararg)))
121 #else
122 #define MAKE_ATTR_PRINTFLIKE(fmtarg, firstvararg) /* delete */
123 #endif
125 #include "sprite.h"
126 #include "lst.h"
127 #include "hash.h"
128 #include "config.h"
129 #include "buf.h"
130 #include "make_malloc.h"
133 * The structure for an individual graph node. Each node has several
134 * pieces of data associated with it.
135 * 1) the name of the target it describes
136 * 2) the location of the target file in the file system.
137 * 3) the type of operator used to define its sources (qv. parse.c)
138 * 4) whether it is involved in this invocation of make
139 * 5) whether the target has been remade
140 * 6) whether any of its children has been remade
141 * 7) the number of its children that are, as yet, unmade
142 * 8) its modification time
143 * 9) the modification time of its youngest child (qv. make.c)
144 * 10) a list of nodes for which this is a source (parents)
145 * 11) a list of nodes on which this depends (children)
146 * 12) a list of nodes that depend on this, as gleaned from the
147 * transformation rules (iParents)
148 * 13) a list of ancestor nodes, which includes parents, iParents,
149 * and recursive parents of parents
150 * 14) a list of nodes of the same name created by the :: operator
151 * 15) a list of nodes that must be made (if they're made) before
152 * this node can be, but that do not enter into the datedness of
153 * this node.
154 * 16) a list of nodes that must be made (if they're made) before
155 * this node or any child of this node can be, but that do not
156 * enter into the datedness of this node.
157 * 17) a list of nodes that must be made (if they're made) after
158 * this node is, but that do not depend on this node, in the
159 * normal sense.
160 * 18) a Lst of ``local'' variables that are specific to this target
161 * and this target only (qv. var.c [$@ $< $?, etc.])
162 * 19) a Lst of strings that are commands to be given to a shell
163 * to create this target.
165 typedef struct GNode {
166 char *name; /* The target's name */
167 char *uname; /* The unexpanded name of a .USE node */
168 char *path; /* The full pathname of the file */
169 int type; /* Its type (see the OP flags, below) */
171 int flags;
172 #define REMAKE 0x1 /* this target needs to be (re)made */
173 #define CHILDMADE 0x2 /* children of this target were made */
174 #define FORCE 0x4 /* children don't exist, and we pretend made */
175 #define DONE_WAIT 0x8 /* Set by Make_ProcessWait() */
176 #define DONE_ORDER 0x10 /* Build requested by .ORDER processing */
177 #define FROM_DEPEND 0x20 /* Node created from .depend */
178 #define DONE_ALLSRC 0x40 /* We do it once only */
179 #define CYCLE 0x1000 /* Used by MakePrintStatus */
180 #define DONECYCLE 0x2000 /* Used by MakePrintStatus */
181 enum enum_made {
182 UNMADE, DEFERRED, REQUESTED, BEINGMADE,
183 MADE, UPTODATE, ERROR, ABORTED
184 } made; /* Set to reflect the state of processing
185 * on this node:
186 * UNMADE - Not examined yet
187 * DEFERRED - Examined once (building child)
188 * REQUESTED - on toBeMade list
189 * BEINGMADE - Target is already being made.
190 * Indicates a cycle in the graph.
191 * MADE - Was out-of-date and has been made
192 * UPTODATE - Was already up-to-date
193 * ERROR - An error occurred while it was being
194 * made (used only in compat mode)
195 * ABORTED - The target was aborted due to
196 * an error making an inferior (compat).
198 int unmade; /* The number of unmade children */
200 time_t mtime; /* Its modification time */
201 struct GNode *cmgn; /* The youngest child */
203 Lst iParents; /* Links to parents for which this is an
204 * implied source, if any */
205 Lst cohorts; /* Other nodes for the :: operator */
206 Lst parents; /* Nodes that depend on this one */
207 Lst children; /* Nodes on which this one depends */
208 Lst order_pred; /* .ORDER nodes we need made */
209 Lst order_succ; /* .ORDER nodes who need us */
211 char cohort_num[8]; /* #n for this cohort */
212 int unmade_cohorts;/* # of unmade instances on the
213 cohorts list */
214 struct GNode *centurion; /* Pointer to the first instance of a ::
215 node; only set when on a cohorts list */
216 unsigned int checked; /* Last time we tried to makle this node */
218 Hash_Table context; /* The local variables */
219 Lst commands; /* Creation commands */
221 struct _Suff *suffix; /* Suffix for the node (determined by
222 * Suff_FindDeps and opaque to everyone
223 * but the Suff module) */
224 const char *fname; /* filename where the GNode got defined */
225 int lineno; /* line number where the GNode got defined */
226 } GNode;
229 * The OP_ constants are used when parsing a dependency line as a way of
230 * communicating to other parts of the program the way in which a target
231 * should be made. These constants are bitwise-OR'ed together and
232 * placed in the 'type' field of each node. Any node that has
233 * a 'type' field which satisfies the OP_NOP function was never never on
234 * the lefthand side of an operator, though it may have been on the
235 * righthand side...
237 #define OP_DEPENDS 0x00000001 /* Execution of commands depends on
238 * kids (:) */
239 #define OP_FORCE 0x00000002 /* Always execute commands (!) */
240 #define OP_DOUBLEDEP 0x00000004 /* Execution of commands depends on kids
241 * per line (::) */
242 #define OP_OPMASK (OP_DEPENDS|OP_FORCE|OP_DOUBLEDEP)
244 #define OP_OPTIONAL 0x00000008 /* Don't care if the target doesn't
245 * exist and can't be created */
246 #define OP_USE 0x00000010 /* Use associated commands for parents */
247 #define OP_EXEC 0x00000020 /* Target is never out of date, but always
248 * execute commands anyway. Its time
249 * doesn't matter, so it has none...sort
250 * of */
251 #define OP_IGNORE 0x00000040 /* Ignore errors when creating the node */
252 #define OP_PRECIOUS 0x00000080 /* Don't remove the target when
253 * interrupted */
254 #define OP_SILENT 0x00000100 /* Don't echo commands when executed */
255 #define OP_MAKE 0x00000200 /* Target is a recursive make so its
256 * commands should always be executed when
257 * it is out of date, regardless of the
258 * state of the -n or -t flags */
259 #define OP_JOIN 0x00000400 /* Target is out-of-date only if any of its
260 * children was out-of-date */
261 #define OP_MADE 0x00000800 /* Assume the children of the node have
262 * been already made */
263 #define OP_SPECIAL 0x00001000 /* Special .BEGIN, .END, .INTERRUPT */
264 #define OP_USEBEFORE 0x00002000 /* Like .USE, only prepend commands */
265 #define OP_INVISIBLE 0x00004000 /* The node is invisible to its parents.
266 * I.e. it doesn't show up in the parents's
267 * local variables. */
268 #define OP_NOTMAIN 0x00008000 /* The node is exempt from normal 'main
269 * target' processing in parse.c */
270 #define OP_PHONY 0x00010000 /* Not a file target; run always */
271 #define OP_NOPATH 0x00020000 /* Don't search for file in the path */
272 #define OP_WAIT 0x00040000 /* .WAIT phony node */
273 #define OP_NOMETA 0x00080000 /* .NOMETA do not create a .meta file */
274 #define OP_META 0x00100000 /* .META we _do_ want a .meta file */
275 #define OP_NOMETA_CMP 0x00200000 /* Do not compare commands in .meta file */
276 #define OP_SUBMAKE 0x00400000 /* Possibly a submake node */
277 /* Attributes applied by PMake */
278 #define OP_TRANSFORM 0x80000000 /* The node is a transformation rule */
279 #define OP_MEMBER 0x40000000 /* Target is a member of an archive */
280 #define OP_LIB 0x20000000 /* Target is a library */
281 #define OP_ARCHV 0x10000000 /* Target is an archive construct */
282 #define OP_HAS_COMMANDS 0x08000000 /* Target has all the commands it should.
283 * Used when parsing to catch multiple
284 * commands for a target */
285 #define OP_SAVE_CMDS 0x04000000 /* Saving commands on .END (Compat) */
286 #define OP_DEPS_FOUND 0x02000000 /* Already processed by Suff_FindDeps */
287 #define OP_MARK 0x01000000 /* Node found while expanding .ALLSRC */
289 #define NoExecute(gn) ((gn->type & OP_MAKE) ? noRecursiveExecute : noExecute)
291 * OP_NOP will return TRUE if the node with the given type was not the
292 * object of a dependency operator
294 #define OP_NOP(t) (((t) & OP_OPMASK) == 0x00000000)
296 #define OP_NOTARGET (OP_NOTMAIN|OP_USE|OP_EXEC|OP_TRANSFORM)
299 * The TARG_ constants are used when calling the Targ_FindNode and
300 * Targ_FindList functions in targ.c. They simply tell the functions what to
301 * do if the desired node(s) is (are) not found. If the TARG_CREATE constant
302 * is given, a new, empty node will be created for the target, placed in the
303 * table of all targets and its address returned. If TARG_NOCREATE is given,
304 * a NULL pointer will be returned.
306 #define TARG_NOCREATE 0x00 /* don't create it */
307 #define TARG_CREATE 0x01 /* create node if not found */
308 #define TARG_NOHASH 0x02 /* don't look in/add to hash table */
311 * These constants are all used by the Str_Concat function to decide how the
312 * final string should look. If STR_ADDSPACE is given, a space will be
313 * placed between the two strings. If STR_ADDSLASH is given, a '/' will
314 * be used instead of a space. If neither is given, no intervening characters
315 * will be placed between the two strings in the final output. If the
316 * STR_DOFREE bit is set, the two input strings will be freed before
317 * Str_Concat returns.
319 #define STR_ADDSPACE 0x01 /* add a space when Str_Concat'ing */
320 #define STR_ADDSLASH 0x02 /* add a slash when Str_Concat'ing */
323 * Error levels for parsing. PARSE_FATAL means the process cannot continue
324 * once the makefile has been parsed. PARSE_WARNING means it can. Passed
325 * as the first argument to Parse_Error.
327 #define PARSE_WARNING 2
328 #define PARSE_FATAL 1
331 * Values returned by Cond_Eval.
333 #define COND_PARSE 0 /* Parse the next lines */
334 #define COND_SKIP 1 /* Skip the next lines */
335 #define COND_INVALID 2 /* Not a conditional statement */
338 * Definitions for the "local" variables. Used only for clarity.
340 #define TARGET "@" /* Target of dependency */
341 #define OODATE "?" /* All out-of-date sources */
342 #define ALLSRC ">" /* All sources */
343 #define IMPSRC "<" /* Source implied by transformation */
344 #define PREFIX "*" /* Common prefix */
345 #define ARCHIVE "!" /* Archive in "archive(member)" syntax */
346 #define MEMBER "%" /* Member in "archive(member)" syntax */
348 #define FTARGET "@F" /* file part of TARGET */
349 #define DTARGET "@D" /* directory part of TARGET */
350 #define FIMPSRC "<F" /* file part of IMPSRC */
351 #define DIMPSRC "<D" /* directory part of IMPSRC */
352 #define FPREFIX "*F" /* file part of PREFIX */
353 #define DPREFIX "*D" /* directory part of PREFIX */
356 * Global Variables
358 extern Lst create; /* The list of target names specified on the
359 * command line. used to resolve #if
360 * make(...) statements */
361 extern Lst dirSearchPath; /* The list of directories to search when
362 * looking for targets */
364 extern Boolean compatMake; /* True if we are make compatible */
365 extern Boolean ignoreErrors; /* True if should ignore all errors */
366 extern Boolean beSilent; /* True if should print no commands */
367 extern Boolean noExecute; /* True if should execute nothing */
368 extern Boolean noRecursiveExecute; /* True if should execute nothing */
369 extern Boolean allPrecious; /* True if every target is precious */
370 extern Boolean keepgoing; /* True if should continue on unaffected
371 * portions of the graph when have an error
372 * in one portion */
373 extern Boolean touchFlag; /* TRUE if targets should just be 'touched'
374 * if out of date. Set by the -t flag */
375 extern Boolean queryFlag; /* TRUE if we aren't supposed to really make
376 * anything, just see if the targets are out-
377 * of-date */
378 extern Boolean doing_depend; /* TRUE if processing .depend */
380 extern Boolean checkEnvFirst; /* TRUE if environment should be searched for
381 * variables before the global context */
382 extern Boolean jobServer; /* a jobServer already exists */
384 extern Boolean parseWarnFatal; /* TRUE if makefile parsing warnings are
385 * treated as errors */
387 extern Boolean varNoExportEnv; /* TRUE if we should not export variables
388 * set on the command line to the env. */
390 extern GNode *DEFAULT; /* .DEFAULT rule */
392 extern GNode *VAR_INTERNAL; /* Variables defined internally by make
393 * which should not override those set by
394 * makefiles.
396 extern GNode *VAR_GLOBAL; /* Variables defined in a global context, e.g
397 * in the Makefile itself */
398 extern GNode *VAR_CMD; /* Variables defined on the command line */
399 extern GNode *VAR_FOR; /* Iteration variables */
400 extern char var_Error[]; /* Value returned by Var_Parse when an error
401 * is encountered. It actually points to
402 * an empty string, so naive callers needn't
403 * worry about it. */
405 extern time_t now; /* The time at the start of this whole
406 * process */
408 extern Boolean oldVars; /* Do old-style variable substitution */
410 extern Lst sysIncPath; /* The system include path. */
411 extern Lst defIncPath; /* The default include path. */
413 extern char curdir[]; /* Startup directory */
414 extern char *progname; /* The program name */
415 extern char *makeDependfile; /* .depend */
416 extern char **savedEnv; /* if we replaced environ this will be non-NULL */
419 * We cannot vfork() in a child of vfork().
420 * Most systems do not enforce this but some do.
422 #define vFork() ((getpid() == myPid) ? vfork() : fork())
423 extern pid_t myPid;
425 #define MAKEFLAGS ".MAKEFLAGS"
426 #define MAKEOVERRIDES ".MAKEOVERRIDES"
427 #define MAKE_JOB_PREFIX ".MAKE.JOB.PREFIX" /* prefix for job target output */
428 #define MAKE_EXPORTED ".MAKE.EXPORTED" /* variables we export */
429 #define MAKE_MAKEFILES ".MAKE.MAKEFILES" /* all the makefiles we read */
430 #define MAKE_LEVEL ".MAKE.LEVEL" /* recursion level */
431 #define MAKEFILE_PREFERENCE ".MAKE.MAKEFILE_PREFERENCE"
432 #define MAKE_DEPENDFILE ".MAKE.DEPENDFILE" /* .depend */
433 #define MAKE_MODE ".MAKE.MODE"
434 #ifndef MAKE_LEVEL_ENV
435 # define MAKE_LEVEL_ENV "MAKELEVEL"
436 #endif
439 * debug control:
440 * There is one bit per module. It is up to the module what debug
441 * information to print.
443 FILE *debug_file; /* Output written here - default stdout */
444 extern int debug;
445 #define DEBUG_ARCH 0x00001
446 #define DEBUG_COND 0x00002
447 #define DEBUG_DIR 0x00004
448 #define DEBUG_GRAPH1 0x00008
449 #define DEBUG_GRAPH2 0x00010
450 #define DEBUG_JOB 0x00020
451 #define DEBUG_MAKE 0x00040
452 #define DEBUG_SUFF 0x00080
453 #define DEBUG_TARG 0x00100
454 #define DEBUG_VAR 0x00200
455 #define DEBUG_FOR 0x00400
456 #define DEBUG_SHELL 0x00800
457 #define DEBUG_ERROR 0x01000
458 #define DEBUG_LOUD 0x02000
459 #define DEBUG_META 0x04000
461 #define DEBUG_GRAPH3 0x10000
462 #define DEBUG_SCRIPT 0x20000
463 #define DEBUG_PARSE 0x40000
464 #define DEBUG_CWD 0x80000
466 #define CONCAT(a,b) a##b
468 #define DEBUG(module) (debug & CONCAT(DEBUG_,module))
470 #include "nonints.h"
472 int Make_TimeStamp(GNode *, GNode *);
473 Boolean Make_OODate(GNode *);
474 void Make_ExpandUse(Lst);
475 time_t Make_Recheck(GNode *);
476 void Make_HandleUse(GNode *, GNode *);
477 void Make_Update(GNode *);
478 void Make_DoAllVar(GNode *);
479 Boolean Make_Run(Lst);
480 char * Check_Cwd_Cmd(const char *);
481 void Check_Cwd(const char **);
482 void PrintOnError(GNode *, const char *);
483 void Main_ExportMAKEFLAGS(Boolean);
484 Boolean Main_SetObjdir(const char *);
485 int mkTempFile(const char *, char **);
486 int str2Lst_Append(Lst, char *, const char *);
488 #ifdef __GNUC__
489 #define UNCONST(ptr) ({ \
490 union __unconst { \
491 const void *__cp; \
492 void *__p; \
493 } __d; \
494 __d.__cp = ptr, __d.__p; })
495 #else
496 #define UNCONST(ptr) (void *)(ptr)
497 #endif
499 #ifndef MIN
500 #define MIN(a, b) ((a < b) ? a : b)
501 #endif
502 #ifndef MAX
503 #define MAX(a, b) ((a > b) ? a : b)
504 #endif
506 /* At least GNU/Hurd systems lack hardcoded MAXPATHLEN/PATH_MAX */
507 #include <limits.h>
508 #ifndef MAXPATHLEN
509 #define MAXPATHLEN 4096
510 #endif
511 #ifndef PATH_MAX
512 #define PATH_MAX MAXPATHLEN
513 #endif
515 #endif /* _MAKE_H_ */