1 /* $NetBSD: make.h,v 1.87 2011/09/16 15:38:04 joerg 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
83 #include <sys/types.h>
84 #include <sys/param.h>
93 # include <sys/cdefs.h>
96 #if !defined(__GNUC_PREREQ__)
98 #define __GNUC_PREREQ__(x, y) \
99 ((__GNUC__ == (x) && __GNUC_MINOR__ >= (y)) || \
101 #else /* defined(__GNUC__) */
102 #define __GNUC_PREREQ__(x, y) 0
103 #endif /* defined(__GNUC__) */
104 #endif /* !defined(__GNUC_PREREQ__) */
106 #if !defined(__unused)
107 #if __GNUC_PREREQ__(2, 7)
108 #define __unused __attribute__((__unused__))
110 #define __unused /* delete */
123 #include "make_malloc.h"
126 * The structure for an individual graph node. Each node has several
127 * pieces of data associated with it.
128 * 1) the name of the target it describes
129 * 2) the location of the target file in the file system.
130 * 3) the type of operator used to define its sources (qv. parse.c)
131 * 4) whether it is involved in this invocation of make
132 * 5) whether the target has been remade
133 * 6) whether any of its children has been remade
134 * 7) the number of its children that are, as yet, unmade
135 * 8) its modification time
136 * 9) the modification time of its youngest child (qv. make.c)
137 * 10) a list of nodes for which this is a source (parents)
138 * 11) a list of nodes on which this depends (children)
139 * 12) a list of nodes that depend on this, as gleaned from the
140 * transformation rules (iParents)
141 * 13) a list of ancestor nodes, which includes parents, iParents,
142 * and recursive parents of parents
143 * 14) a list of nodes of the same name created by the :: operator
144 * 15) a list of nodes that must be made (if they're made) before
145 * this node can be, but that do not enter into the datedness of
147 * 16) a list of nodes that must be made (if they're made) before
148 * this node or any child of this node can be, but that do not
149 * enter into the datedness of this node.
150 * 17) a list of nodes that must be made (if they're made) after
151 * this node is, but that do not depend on this node, in the
153 * 18) a Lst of ``local'' variables that are specific to this target
154 * and this target only (qv. var.c [$@ $< $?, etc.])
155 * 19) a Lst of strings that are commands to be given to a shell
156 * to create this target.
158 typedef struct GNode
{
159 char *name
; /* The target's name */
160 char *uname
; /* The unexpanded name of a .USE node */
161 char *path
; /* The full pathname of the file */
162 int type
; /* Its type (see the OP flags, below) */
165 #define REMAKE 0x1 /* this target needs to be (re)made */
166 #define CHILDMADE 0x2 /* children of this target were made */
167 #define FORCE 0x4 /* children don't exist, and we pretend made */
168 #define DONE_WAIT 0x8 /* Set by Make_ProcessWait() */
169 #define DONE_ORDER 0x10 /* Build requested by .ORDER processing */
170 #define FROM_DEPEND 0x20 /* Node created from .depend */
171 #define DONE_ALLSRC 0x40 /* We do it once only */
172 #define CYCLE 0x1000 /* Used by MakePrintStatus */
173 #define DONECYCLE 0x2000 /* Used by MakePrintStatus */
175 UNMADE
, DEFERRED
, REQUESTED
, BEINGMADE
,
176 MADE
, UPTODATE
, ERROR
, ABORTED
177 } made
; /* Set to reflect the state of processing
179 * UNMADE - Not examined yet
180 * DEFERRED - Examined once (building child)
181 * REQUESTED - on toBeMade list
182 * BEINGMADE - Target is already being made.
183 * Indicates a cycle in the graph.
184 * MADE - Was out-of-date and has been made
185 * UPTODATE - Was already up-to-date
186 * ERROR - An error occurred while it was being
187 * made (used only in compat mode)
188 * ABORTED - The target was aborted due to
189 * an error making an inferior (compat).
191 int unmade
; /* The number of unmade children */
193 time_t mtime
; /* Its modification time */
194 struct GNode
*cmgn
; /* The youngest child */
196 Lst iParents
; /* Links to parents for which this is an
197 * implied source, if any */
198 Lst cohorts
; /* Other nodes for the :: operator */
199 Lst parents
; /* Nodes that depend on this one */
200 Lst children
; /* Nodes on which this one depends */
201 Lst order_pred
; /* .ORDER nodes we need made */
202 Lst order_succ
; /* .ORDER nodes who need us */
204 char cohort_num
[8]; /* #n for this cohort */
205 int unmade_cohorts
;/* # of unmade instances on the
207 struct GNode
*centurion
; /* Pointer to the first instance of a ::
208 node; only set when on a cohorts list */
209 unsigned int checked
; /* Last time we tried to makle this node */
211 Hash_Table context
; /* The local variables */
212 Lst commands
; /* Creation commands */
214 struct _Suff
*suffix
; /* Suffix for the node (determined by
215 * Suff_FindDeps and opaque to everyone
216 * but the Suff module) */
217 const char *fname
; /* filename where the GNode got defined */
218 int lineno
; /* line number where the GNode got defined */
222 * The OP_ constants are used when parsing a dependency line as a way of
223 * communicating to other parts of the program the way in which a target
224 * should be made. These constants are bitwise-OR'ed together and
225 * placed in the 'type' field of each node. Any node that has
226 * a 'type' field which satisfies the OP_NOP function was never never on
227 * the lefthand side of an operator, though it may have been on the
230 #define OP_DEPENDS 0x00000001 /* Execution of commands depends on
232 #define OP_FORCE 0x00000002 /* Always execute commands (!) */
233 #define OP_DOUBLEDEP 0x00000004 /* Execution of commands depends on kids
235 #define OP_OPMASK (OP_DEPENDS|OP_FORCE|OP_DOUBLEDEP)
237 #define OP_OPTIONAL 0x00000008 /* Don't care if the target doesn't
238 * exist and can't be created */
239 #define OP_USE 0x00000010 /* Use associated commands for parents */
240 #define OP_EXEC 0x00000020 /* Target is never out of date, but always
241 * execute commands anyway. Its time
242 * doesn't matter, so it has none...sort
244 #define OP_IGNORE 0x00000040 /* Ignore errors when creating the node */
245 #define OP_PRECIOUS 0x00000080 /* Don't remove the target when
247 #define OP_SILENT 0x00000100 /* Don't echo commands when executed */
248 #define OP_MAKE 0x00000200 /* Target is a recursive make so its
249 * commands should always be executed when
250 * it is out of date, regardless of the
251 * state of the -n or -t flags */
252 #define OP_JOIN 0x00000400 /* Target is out-of-date only if any of its
253 * children was out-of-date */
254 #define OP_MADE 0x00000800 /* Assume the children of the node have
255 * been already made */
256 #define OP_SPECIAL 0x00001000 /* Special .BEGIN, .END, .INTERRUPT */
257 #define OP_USEBEFORE 0x00002000 /* Like .USE, only prepend commands */
258 #define OP_INVISIBLE 0x00004000 /* The node is invisible to its parents.
259 * I.e. it doesn't show up in the parents's
260 * local variables. */
261 #define OP_NOTMAIN 0x00008000 /* The node is exempt from normal 'main
262 * target' processing in parse.c */
263 #define OP_PHONY 0x00010000 /* Not a file target; run always */
264 #define OP_NOPATH 0x00020000 /* Don't search for file in the path */
265 #define OP_WAIT 0x00040000 /* .WAIT phony node */
266 #define OP_NOMETA 0x00080000 /* .NOMETA do not create a .meta file */
267 #define OP_META 0x00100000 /* .META we _do_ want a .meta file */
268 #define OP_NOMETA_CMP 0x00200000 /* Do not compare commands in .meta file */
269 /* Attributes applied by PMake */
270 #define OP_TRANSFORM 0x80000000 /* The node is a transformation rule */
271 #define OP_MEMBER 0x40000000 /* Target is a member of an archive */
272 #define OP_LIB 0x20000000 /* Target is a library */
273 #define OP_ARCHV 0x10000000 /* Target is an archive construct */
274 #define OP_HAS_COMMANDS 0x08000000 /* Target has all the commands it should.
275 * Used when parsing to catch multiple
276 * commands for a target */
277 #define OP_SAVE_CMDS 0x04000000 /* Saving commands on .END (Compat) */
278 #define OP_DEPS_FOUND 0x02000000 /* Already processed by Suff_FindDeps */
279 #define OP_MARK 0x01000000 /* Node found while expanding .ALLSRC */
281 #define NoExecute(gn) ((gn->type & OP_MAKE) ? noRecursiveExecute : noExecute)
283 * OP_NOP will return TRUE if the node with the given type was not the
284 * object of a dependency operator
286 #define OP_NOP(t) (((t) & OP_OPMASK) == 0x00000000)
288 #define OP_NOTARGET (OP_NOTMAIN|OP_USE|OP_EXEC|OP_TRANSFORM)
291 * The TARG_ constants are used when calling the Targ_FindNode and
292 * Targ_FindList functions in targ.c. They simply tell the functions what to
293 * do if the desired node(s) is (are) not found. If the TARG_CREATE constant
294 * is given, a new, empty node will be created for the target, placed in the
295 * table of all targets and its address returned. If TARG_NOCREATE is given,
296 * a NULL pointer will be returned.
298 #define TARG_NOCREATE 0x00 /* don't create it */
299 #define TARG_CREATE 0x01 /* create node if not found */
300 #define TARG_NOHASH 0x02 /* don't look in/add to hash table */
303 * These constants are all used by the Str_Concat function to decide how the
304 * final string should look. If STR_ADDSPACE is given, a space will be
305 * placed between the two strings. If STR_ADDSLASH is given, a '/' will
306 * be used instead of a space. If neither is given, no intervening characters
307 * will be placed between the two strings in the final output. If the
308 * STR_DOFREE bit is set, the two input strings will be freed before
309 * Str_Concat returns.
311 #define STR_ADDSPACE 0x01 /* add a space when Str_Concat'ing */
312 #define STR_ADDSLASH 0x02 /* add a slash when Str_Concat'ing */
315 * Error levels for parsing. PARSE_FATAL means the process cannot continue
316 * once the makefile has been parsed. PARSE_WARNING means it can. Passed
317 * as the first argument to Parse_Error.
319 #define PARSE_WARNING 2
320 #define PARSE_FATAL 1
323 * Values returned by Cond_Eval.
325 #define COND_PARSE 0 /* Parse the next lines */
326 #define COND_SKIP 1 /* Skip the next lines */
327 #define COND_INVALID 2 /* Not a conditional statement */
330 * Definitions for the "local" variables. Used only for clarity.
332 #define TARGET "@" /* Target of dependency */
333 #define OODATE "?" /* All out-of-date sources */
334 #define ALLSRC ">" /* All sources */
335 #define IMPSRC "<" /* Source implied by transformation */
336 #define PREFIX "*" /* Common prefix */
337 #define ARCHIVE "!" /* Archive in "archive(member)" syntax */
338 #define MEMBER "%" /* Member in "archive(member)" syntax */
340 #define FTARGET "@F" /* file part of TARGET */
341 #define DTARGET "@D" /* directory part of TARGET */
342 #define FIMPSRC "<F" /* file part of IMPSRC */
343 #define DIMPSRC "<D" /* directory part of IMPSRC */
344 #define FPREFIX "*F" /* file part of PREFIX */
345 #define DPREFIX "*D" /* directory part of PREFIX */
350 extern Lst create
; /* The list of target names specified on the
351 * command line. used to resolve #if
352 * make(...) statements */
353 extern Lst dirSearchPath
; /* The list of directories to search when
354 * looking for targets */
356 extern Boolean compatMake
; /* True if we are make compatible */
357 extern Boolean ignoreErrors
; /* True if should ignore all errors */
358 extern Boolean beSilent
; /* True if should print no commands */
359 extern Boolean noExecute
; /* True if should execute nothing */
360 extern Boolean noRecursiveExecute
; /* True if should execute nothing */
361 extern Boolean allPrecious
; /* True if every target is precious */
362 extern Boolean keepgoing
; /* True if should continue on unaffected
363 * portions of the graph when have an error
365 extern Boolean touchFlag
; /* TRUE if targets should just be 'touched'
366 * if out of date. Set by the -t flag */
367 extern Boolean queryFlag
; /* TRUE if we aren't supposed to really make
368 * anything, just see if the targets are out-
370 extern Boolean doing_depend
; /* TRUE if processing .depend */
372 extern Boolean checkEnvFirst
; /* TRUE if environment should be searched for
373 * variables before the global context */
374 extern Boolean jobServer
; /* a jobServer already exists */
376 extern Boolean parseWarnFatal
; /* TRUE if makefile parsing warnings are
377 * treated as errors */
379 extern Boolean varNoExportEnv
; /* TRUE if we should not export variables
380 * set on the command line to the env. */
382 extern GNode
*DEFAULT
; /* .DEFAULT rule */
384 extern GNode
*VAR_GLOBAL
; /* Variables defined in a global context, e.g
385 * in the Makefile itself */
386 extern GNode
*VAR_CMD
; /* Variables defined on the command line */
387 extern GNode
*VAR_FOR
; /* Iteration variables */
388 extern char var_Error
[]; /* Value returned by Var_Parse when an error
389 * is encountered. It actually points to
390 * an empty string, so naive callers needn't
393 extern time_t now
; /* The time at the start of this whole
396 extern Boolean oldVars
; /* Do old-style variable substitution */
398 extern Lst sysIncPath
; /* The system include path. */
399 extern Lst defIncPath
; /* The default include path. */
401 extern char curdir
[]; /* Startup directory */
402 extern char *progname
; /* The program name */
403 extern char *makeDependfile
; /* .depend */
406 * We cannot vfork() in a child of vfork().
407 * Most systems do not enforce this but some do.
409 #define vFork() ((getpid() == myPid) ? vfork() : fork())
412 #define MAKEFLAGS ".MAKEFLAGS"
413 #define MAKEOVERRIDES ".MAKEOVERRIDES"
414 #define MAKE_JOB_PREFIX ".MAKE.JOB.PREFIX" /* prefix for job target output */
415 #define MAKE_EXPORTED ".MAKE.EXPORTED" /* variables we export */
416 #define MAKE_MAKEFILES ".MAKE.MAKEFILES" /* all the makefiles we read */
417 #define MAKE_LEVEL ".MAKE.LEVEL" /* recursion level */
418 #define MAKEFILE_PREFERENCE ".MAKE.MAKEFILE_PREFERENCE"
419 #define MAKE_DEPENDFILE ".MAKE.DEPENDFILE" /* .depend */
420 #define MAKE_MODE ".MAKE.MODE"
424 * There is one bit per module. It is up to the module what debug
425 * information to print.
427 FILE *debug_file
; /* Output written here - default stdout */
429 #define DEBUG_ARCH 0x00001
430 #define DEBUG_COND 0x00002
431 #define DEBUG_DIR 0x00004
432 #define DEBUG_GRAPH1 0x00008
433 #define DEBUG_GRAPH2 0x00010
434 #define DEBUG_JOB 0x00020
435 #define DEBUG_MAKE 0x00040
436 #define DEBUG_SUFF 0x00080
437 #define DEBUG_TARG 0x00100
438 #define DEBUG_VAR 0x00200
439 #define DEBUG_FOR 0x00400
440 #define DEBUG_SHELL 0x00800
441 #define DEBUG_ERROR 0x01000
442 #define DEBUG_LOUD 0x02000
443 #define DEBUG_META 0x04000
445 #define DEBUG_GRAPH3 0x10000
446 #define DEBUG_SCRIPT 0x20000
447 #define DEBUG_PARSE 0x40000
448 #define DEBUG_CWD 0x80000
450 #define CONCAT(a,b) a##b
452 #define DEBUG(module) (debug & CONCAT(DEBUG_,module))
456 int Make_TimeStamp(GNode
*, GNode
*);
457 Boolean
Make_OODate(GNode
*);
458 void Make_ExpandUse(Lst
);
459 time_t Make_Recheck(GNode
*);
460 void Make_HandleUse(GNode
*, GNode
*);
461 void Make_Update(GNode
*);
462 void Make_DoAllVar(GNode
*);
463 Boolean
Make_Run(Lst
);
464 char * Check_Cwd_Cmd(const char *);
465 void Check_Cwd(const char **);
466 void PrintOnError(GNode
*, const char *);
467 void Main_ExportMAKEFLAGS(Boolean
);
468 Boolean
Main_SetObjdir(const char *);
469 int mkTempFile(const char *, char **);
470 int str2Lst_Append(Lst
, char *, const char *);
473 #define UNCONST(ptr) ({ \
478 __d.__cp = ptr, __d.__p; })
480 #define UNCONST(ptr) (void *)(ptr)
484 #define MIN(a, b) ((a < b) ? a : b)
487 #define MAX(a, b) ((a > b) ? a : b)
490 #endif /* _MAKE_H_ */