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