2 * Copyright (c) 1988, 1989, 1990, 1993
3 * The Regents of the University of California. All rights reserved.
4 * Copyright (c) 1989 by Berkeley Softworks
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. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the University of
21 * California, Berkeley and its contributors.
22 * 4. Neither the name of the University nor the names of its contributors
23 * may be used to endorse or promote products derived from this software
24 * without specific prior written permission.
26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 * from: @(#)make.h 8.3 (Berkeley) 6/13/95
39 * $FreeBSD: src/usr.bin/make/make.h,v 1.12.2.2 2001/02/13 03:13:58 will Exp $
40 * $DragonFly: src/usr.bin/make/make.h,v 1.16 2004/12/20 16:58:34 joerg Exp $
45 * The global definitions for pmake
51 #include <sys/types.h>
63 /* buildworld needs this on FreeBSD */
65 #define __arysize(ary) (sizeof(ary)/sizeof((ary)[0]))
69 * The structure for an individual graph node. Each node has several
70 * pieces of data associated with it.
71 * 1) the name of the target it describes
72 * 2) the location of the target file in the filesystem.
73 * 3) the type of operator used to define its sources (qv. parse.c)
74 * 4) whether it is involved in this invocation of make
75 * 5) whether the target has been remade
76 * 6) whether any of its children has been remade
77 * 7) the number of its children that are, as yet, unmade
78 * 8) its modification time
79 * 9) the modification time of its youngest child (qv. make.c)
80 * 10) a list of nodes for which this is a source
81 * 11) a list of nodes on which this depends
82 * 12) a list of nodes that depend on this, as gleaned from the
83 * transformation rules.
84 * 13) a list of nodes of the same name created by the :: operator
85 * 14) a list of nodes that must be made (if they're made) before
86 * this node can be, but that do no enter into the datedness of
88 * 15) a list of nodes that must be made (if they're made) after
89 * this node is, but that do not depend on this node, in the
91 * 16) a Lst of ``local'' variables that are specific to this target
92 * and this target only (qv. var.c [$@ $< $?, etc.])
93 * 17) a Lst of strings that are commands to be given to a shell
94 * to create this target.
96 typedef struct GNode {
97 char *name; /* The target's name */
98 char *path; /* The full pathname of the file */
99 int type; /* Its type (see the OP flags, below) */
100 int order; /* Its wait weight */
102 Boolean make; /* TRUE if this target needs to be remade */
104 UNMADE, BEINGMADE, MADE, UPTODATE, ERROR, ABORTED,
106 } made; /* Set to reflect the state of processing
108 * UNMADE - Not examined yet
109 * BEINGMADE - Target is already being made.
110 * Indicates a cycle in the graph. (compat
112 * MADE - Was out-of-date and has been made
113 * UPTODATE - Was already up-to-date
114 * ERROR - An error occured while it was being
115 * made (used only in compat mode)
116 * ABORTED - The target was aborted due to
117 * an error making an inferior (compat).
118 * CYCLE - Marked as potentially being part of
119 * a graph cycle. If we come back to a
120 * node marked this way, it is printed
121 * and 'made' is changed to ENDCYCLE.
122 * ENDCYCLE - the cycle has been completely
123 * printed. Go back and unmark all its
126 Boolean childMade; /* TRUE if one of this target's children was
128 int unmade; /* The number of unmade children */
130 int mtime; /* Its modification time */
131 int cmtime; /* The modification time of its youngest
134 Lst iParents; /* Links to parents for which this is an
135 * implied source, if any */
136 Lst cohorts; /* Other nodes for the :: operator */
137 Lst parents; /* Nodes that depend on this one */
138 Lst children; /* Nodes on which this one depends */
139 Lst successors; /* Nodes that must be made after this one */
140 Lst preds; /* Nodes that must be made before this one */
142 Lst context; /* The local variables */
143 Lst commands; /* Creation commands */
145 /* current command executing in compat mode */
146 LstNode *compat_command;
148 struct _Suff *suffix; /* Suffix for the node (determined by
149 * Suff_FindDeps and opaque to everyone
150 * but the Suff module) */
155 * Definitions for handling #include specifications
161 typedef struct IFile {
162 char *fname; /* name of previous file */
163 int lineno; /* saved line number */
164 FILE *F; /* the open stream */
165 PTR *p; /* the char pointer */
169 * The OP_ constants are used when parsing a dependency line as a way of
170 * communicating to other parts of the program the way in which a target
171 * should be made. These constants are bitwise-OR'ed together and
172 * placed in the 'type' field of each node. Any node that has
173 * a 'type' field which satisfies the OP_NOP function was never never on
174 * the lefthand side of an operator, though it may have been on the
177 #define OP_DEPENDS 0x00000001 /* Execution of commands depends on
179 #define OP_FORCE 0x00000002 /* Always execute commands (!) */
180 #define OP_DOUBLEDEP 0x00000004 /* Execution of commands depends on kids
182 #define OP_OPMASK (OP_DEPENDS|OP_FORCE|OP_DOUBLEDEP)
184 #define OP_OPTIONAL 0x00000008 /* Don't care if the target doesn't
185 * exist and can't be created */
186 #define OP_USE 0x00000010 /* Use associated commands for parents */
187 #define OP_EXEC 0x00000020 /* Target is never out of date, but always
188 * execute commands anyway. Its time
189 * doesn't matter, so it has none...sort
191 #define OP_IGNORE 0x00000040 /* Ignore errors when creating the node */
192 #define OP_PRECIOUS 0x00000080 /* Don't remove the target when
194 #define OP_SILENT 0x00000100 /* Don't echo commands when executed */
195 #define OP_MAKE 0x00000200 /* Target is a recurrsive make so its
196 * commands should always be executed when
197 * it is out of date, regardless of the
198 * state of the -n or -t flags */
199 #define OP_JOIN 0x00000400 /* Target is out-of-date only if any of its
200 * children was out-of-date */
201 #define OP_INVISIBLE 0x00004000 /* The node is invisible to its parents.
202 * I.e. it doesn't show up in the parents's
203 * local variables. */
204 #define OP_NOTMAIN 0x00008000 /* The node is exempt from normal 'main
205 * target' processing in parse.c */
206 #define OP_PHONY 0x00010000 /* Not a file target; run always */
207 /* Attributes applied by PMake */
208 #define OP_TRANSFORM 0x80000000 /* The node is a transformation rule */
209 #define OP_MEMBER 0x40000000 /* Target is a member of an archive */
210 #define OP_LIB 0x20000000 /* Target is a library */
211 #define OP_ARCHV 0x10000000 /* Target is an archive construct */
212 #define OP_HAS_COMMANDS 0x08000000 /* Target has all the commands it should.
213 * Used when parsing to catch multiple
214 * commands for a target */
215 #define OP_SAVE_CMDS 0x04000000 /* Saving commands on .END (Compat) */
216 #define OP_DEPS_FOUND 0x02000000 /* Already processed by Suff_FindDeps */
219 * OP_NOP will return TRUE if the node with the given type was not the
220 * object of a dependency operator
222 #define OP_NOP(t) (((t) & OP_OPMASK) == 0x00000000)
225 * The TARG_ constants are used when calling the Targ_FindNode and
226 * Targ_FindList functions in targ.c. They simply tell the functions what to
227 * do if the desired node(s) is (are) not found. If the TARG_CREATE constant
228 * is given, a new, empty node will be created for the target, placed in the
229 * table of all targets and its address returned. If TARG_NOCREATE is given,
230 * a NULL pointer will be returned.
232 #define TARG_CREATE 0x01 /* create node if not found */
233 #define TARG_NOCREATE 0x00 /* don't create it */
236 * There are several places where expandable buffers are used (parse.c and
237 * var.c). This constant is merely the starting point for those buffers. If
238 * lines tend to be much shorter than this, it would be best to reduce BSIZE.
239 * If longer, it should be increased. Reducing it will cause more copying to
240 * be done for longer lines, but will save space for shorter ones. In any
241 * case, it ought to be a power of two simply because most storage allocation
242 * schemes allocate in powers of two.
244 #define MAKE_BSIZE 256 /* starting size for expandable buffers */
247 * These constants are all used by the Str_Concat function to decide how the
248 * final string should look. If STR_ADDSPACE is given, a space will be
249 * placed between the two strings. If STR_ADDSLASH is given, a '/' will
250 * be used instead of a space. If neither is given, no intervening characters
251 * will be placed between the two strings in the final output.
253 #define STR_ADDSPACE 0x01 /* add a space when Str_Concat'ing */
254 #define STR_ADDSLASH 0x04 /* add a slash when Str_Concat'ing */
257 * Error levels for parsing. PARSE_FATAL means the process cannot continue
258 * once the makefile has been parsed. PARSE_WARNING means it can. Passed
259 * as the first argument to Parse_Error.
261 #define PARSE_WARNING 2
262 #define PARSE_FATAL 1
265 * Values returned by Cond_Eval.
267 #define COND_PARSE 0 /* Parse the next lines */
268 #define COND_SKIP 1 /* Skip the next lines */
269 #define COND_INVALID 2 /* Not a conditional statement */
272 * Definitions for the "local" variables. Used only for clarity.
274 #define TARGET "@" /* Target of dependency */
275 #define OODATE "?" /* All out-of-date sources */
276 #define ALLSRC ">" /* All sources */
277 #define IMPSRC "<" /* Source implied by transformation */
278 #define PREFIX "*" /* Common prefix */
279 #define ARCHIVE "!" /* Archive in "archive(member)" syntax */
280 #define MEMBER "%" /* Member in "archive(member)" syntax */
282 #define FTARGET "@F" /* file part of TARGET */
283 #define DTARGET "@D" /* directory part of TARGET */
284 #define FIMPSRC "<F" /* file part of IMPSRC */
285 #define DIMPSRC "<D" /* directory part of IMPSRC */
286 #define FPREFIX "*F" /* file part of PREFIX */
287 #define DPREFIX "*D" /* directory part of PREFIX */
292 /* The list of target names specified on the command line.
293 * Used to resolve #if make(...) statements */
296 /* The list of directories to search when looking for targets */
297 extern Lst dirSearchPath;
299 extern IFile curFile; /* current makefile */
301 /* The list of directories to search when looking for includes */
302 extern Lst parseIncPath;
304 extern Boolean jobsRunning; /* True if jobs are running */
305 extern Boolean compatMake; /* True if we are make compatible */
306 extern Boolean ignoreErrors; /* True if should ignore all errors */
307 extern Boolean beSilent; /* True if should print no commands */
308 extern Boolean beVerbose; /* True if should print extra cruft */
309 extern Boolean noExecute; /* True if should execute nothing */
310 extern Boolean allPrecious; /* True if every target is precious */
311 extern Boolean keepgoing; /* True if should continue on unaffected
312 * portions of the graph when have an error
314 extern Boolean touchFlag; /* TRUE if targets should just be 'touched'
315 * if out of date. Set by the -t flag */
316 extern Boolean usePipes; /* TRUE if should capture the output of
317 * subshells by means of pipes. Otherwise it
318 * is routed to temporary files from which it
319 * is retrieved when the shell exits */
320 extern Boolean queryFlag; /* TRUE if we aren't supposed to really make
321 * anything, just see if the targets are out-
324 extern Boolean checkEnvFirst; /* TRUE if environment should be searched for
325 * all variables before the global context */
327 /* List of specific variables for which the environment should be
328 * searched before the global context */
329 extern Lst envFirstVars;
331 extern GNode *DEFAULT; /* .DEFAULT rule */
333 extern GNode *VAR_GLOBAL; /* Variables defined in a global context, e.g
334 * in the Makefile itself */
335 extern GNode *VAR_CMD; /* Variables defined on the command line */
336 extern char var_Error[]; /* Value returned by Var_Parse when an error
337 * is encountered. It actually points to
338 * an empty string, so naive callers needn't
341 extern time_t now; /* The time at the start of this whole
344 extern Boolean oldVars; /* Do old-style variable substitution */
346 /* The system include path. */
347 extern Lst sysIncPath;
351 * There is one bit per module. It is up to the module what debug
352 * information to print.
355 #define DEBUG_ARCH 0x0001
356 #define DEBUG_COND 0x0002
357 #define DEBUG_DIR 0x0004
358 #define DEBUG_GRAPH1 0x0008
359 #define DEBUG_GRAPH2 0x0010
360 #define DEBUG_JOB 0x0020
361 #define DEBUG_MAKE 0x0040
362 #define DEBUG_SUFF 0x0080
363 #define DEBUG_TARG 0x0100
364 #define DEBUG_VAR 0x0200
365 #define DEBUG_FOR 0x0400
366 #define DEBUG_LOUD 0x0800
368 #define CONCAT(a,b) a##b
370 #define DEBUG(module) (debug & CONCAT(DEBUG_,module))
371 #define DEBUGF(module,args) \
373 if (DEBUG(module)) { \
377 #define ISDOT(c) ((c)[0] == '.' && (((c)[1] == '\0') || ((c)[1] == '/')))
378 #define ISDOTDOT(c) ((c)[0] == '.' && ISDOT(&((c)[1])))
381 * Since there are so many, all functions that return non-integer values are
382 * extracted by means of a sed script or two and stuck in the file "nonints.h"
386 int Make_TimeStamp(GNode *, GNode *);
387 Boolean Make_OODate(GNode *);
388 int Make_HandleUse(GNode *, GNode *);
389 void Make_Update(GNode *);
390 void Make_DoAllVar(GNode *);
391 Boolean Make_Run(Lst *);
393 #endif /* _MAKE_H_ */