Annotation of src/usr.bin/make/make.h, Revision 1.53
1.53 ! christos 1: /* $NetBSD: make.h,v 1.52 2004/07/15 09:01:29 yamt Exp $ */
1.6 christos 2:
1.1 cgd 3: /*
1.6 christos 4: * Copyright (c) 1988, 1989, 1990, 1993
5: * The Regents of the University of California. All rights reserved.
1.47 agc 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: /*
1.1 cgd 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: *
1.11 christos 72: * from: @(#)make.h 8.3 (Berkeley) 6/13/95
1.1 cgd 73: */
74:
75: /*-
76: * make.h --
77: * The global definitions for pmake
78: */
79:
80: #ifndef _MAKE_H_
81: #define _MAKE_H_
82:
83: #include <sys/types.h>
1.13 christos 84: #include <sys/param.h>
1.44 wiz 85:
86: #include <ctype.h>
1.3 cgd 87: #include <stdio.h>
1.44 wiz 88: #include <stdlib.h>
1.1 cgd 89: #include <string.h>
1.44 wiz 90: #include <unistd.h>
1.12 christos 91:
1.19 tv 92: #ifdef BSD4_4
1.12 christos 93: # include <sys/cdefs.h>
1.5 glass 94: #else
1.23 kim 95: # ifndef __GNUC__
96: # ifndef __inline
97: # define __inline
1.12 christos 98: # endif
99: # endif
1.4 glass 100: #endif
1.12 christos 101:
1.52 yamt 102: #if !defined(__GNUC_PREREQ__)
103: #if defined(__GNUC__)
104: #define __GNUC_PREREQ__(x, y) \
105: ((__GNUC__ == (x) && __GNUC_MINOR__ >= (y)) || \
106: (__GNUC__ > (x)))
107: #else /* defined(__GNUC__) */
108: #define __GNUC_PREREQ__(x, y) 0
109: #endif /* defined(__GNUC__) */
110: #endif /* !defined(__GNUC_PREREQ__) */
111:
1.51 jmc 112: #if !defined(__unused)
113: #if __GNUC_PREREQ__(2, 7)
114: #define __unused __attribute__((__unused__))
115: #else
116: #define __unused /* delete */
117: #endif
118: #endif
1.44 wiz 119:
1.1 cgd 120: #include "sprite.h"
121: #include "lst.h"
1.22 mycroft 122: #include "hash.h"
1.1 cgd 123: #include "config.h"
1.3 cgd 124: #include "buf.h"
1.1 cgd 125:
126: /*-
127: * The structure for an individual graph node. Each node has several
128: * pieces of data associated with it.
129: * 1) the name of the target it describes
130: * 2) the location of the target file in the file system.
131: * 3) the type of operator used to define its sources (qv. parse.c)
132: * 4) whether it is involved in this invocation of make
133: * 5) whether the target has been remade
134: * 6) whether any of its children has been remade
135: * 7) the number of its children that are, as yet, unmade
136: * 8) its modification time
137: * 9) the modification time of its youngest child (qv. make.c)
138: * 10) a list of nodes for which this is a source
139: * 11) a list of nodes on which this depends
140: * 12) a list of nodes that depend on this, as gleaned from the
141: * transformation rules.
142: * 13) a list of nodes of the same name created by the :: operator
143: * 14) a list of nodes that must be made (if they're made) before
144: * this node can be, but that do no enter into the datedness of
145: * this node.
146: * 15) a list of nodes that must be made (if they're made) after
147: * this node is, but that do not depend on this node, in the
148: * normal sense.
149: * 16) a Lst of ``local'' variables that are specific to this target
150: * and this target only (qv. var.c [$@ $< $?, etc.])
151: * 17) a Lst of strings that are commands to be given to a shell
1.11 christos 152: * to create this target.
1.1 cgd 153: */
154: typedef struct GNode {
155: char *name; /* The target's name */
1.14 christos 156: char *uname; /* The unexpanded name of a .USE node */
1.1 cgd 157: char *path; /* The full pathname of the file */
158: int type; /* Its type (see the OP flags, below) */
1.7 christos 159: int order; /* Its wait weight */
1.1 cgd 160:
1.21 christos 161: int flags;
162: #define REMAKE 0x1 /* this target needs to be remade */
163: #define CHILDMADE 0x2 /* children of this target were made */
164: #define FORCE 0x4 /* children don't exist, and we pretend made */
1.1 cgd 165: enum {
166: UNMADE, BEINGMADE, MADE, UPTODATE, ERROR, ABORTED,
1.25 drochner 167: CYCLE, ENDCYCLE
1.1 cgd 168: } made; /* Set to reflect the state of processing
169: * on this node:
170: * UNMADE - Not examined yet
171: * BEINGMADE - Target is already being made.
172: * Indicates a cycle in the graph. (compat
173: * mode only)
174: * MADE - Was out-of-date and has been made
175: * UPTODATE - Was already up-to-date
1.37 wiz 176: * ERROR - An error occurred while it was being
1.1 cgd 177: * made (used only in compat mode)
178: * ABORTED - The target was aborted due to
179: * an error making an inferior (compat).
180: * CYCLE - Marked as potentially being part of
181: * a graph cycle. If we come back to a
182: * node marked this way, it is printed
183: * and 'made' is changed to ENDCYCLE.
184: * ENDCYCLE - the cycle has been completely
185: * printed. Go back and unmark all its
186: * members.
187: */
188: int unmade; /* The number of unmade children */
189:
1.18 fair 190: time_t mtime; /* Its modification time */
191: time_t cmtime; /* The modification time of its youngest
1.1 cgd 192: * child */
193:
194: Lst iParents; /* Links to parents for which this is an
195: * implied source, if any */
196: Lst cohorts; /* Other nodes for the :: operator */
197: Lst parents; /* Nodes that depend on this one */
198: Lst children; /* Nodes on which this one depends */
199: Lst successors; /* Nodes that must be made after this one */
200: Lst preds; /* Nodes that must be made before this one */
1.43 pk 201: int unmade_cohorts;/* # of unmade instances on the
202: cohorts list */
203: struct GNode *centurion; /* Pointer to the first instance of a ::
204: node; only set when on a cohorts list */
1.1 cgd 205:
1.22 mycroft 206: Hash_Table context; /* The local variables */
1.1 cgd 207: Lst commands; /* Creation commands */
208:
209: struct _Suff *suffix; /* Suffix for the node (determined by
210: * Suff_FindDeps and opaque to everyone
211: * but the Suff module) */
1.33 christos 212: char *fname; /* filename where the GNode got defined */
213: int lineno; /* line number where the GNode got defined */
1.1 cgd 214: } GNode;
215:
216: /*
1.11 christos 217: * Manifest constants
1.1 cgd 218: */
219: #define NILGNODE ((GNode *) NIL)
220:
221: /*
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
1.11 christos 228: * righthand side...
1.1 cgd 229: */
230: #define OP_DEPENDS 0x00000001 /* Execution of commands depends on
231: * kids (:) */
232: #define OP_FORCE 0x00000002 /* Always execute commands (!) */
233: #define OP_DOUBLEDEP 0x00000004 /* Execution of commands depends on kids
234: * per line (::) */
235: #define OP_OPMASK (OP_DEPENDS|OP_FORCE|OP_DOUBLEDEP)
236:
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
243: * of */
244: #define OP_IGNORE 0x00000040 /* Ignore errors when creating the node */
245: #define OP_PRECIOUS 0x00000080 /* Don't remove the target when
246: * interrupted */
247: #define OP_SILENT 0x00000100 /* Don't echo commands when executed */
1.40 christos 248: #define OP_MAKE 0x00000200 /* Target is a recursive make so its
1.1 cgd 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 */
1.41 christos 254: #define OP_MADE 0x00000800 /* Assume the children of the node have
255: * been already made */
1.53 ! christos 256: #define OP_NODEP 0x00001000 /* Dependencies are invalid */
1.36 christos 257: #define OP_USEBEFORE 0x00002000 /* Like .USE, only prepend commands */
1.1 cgd 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 */
1.6 christos 263: #define OP_PHONY 0x00010000 /* Not a file target; run always */
1.17 gwr 264: #define OP_NOPATH 0x00020000 /* Don't search for file in the path */
1.1 cgd 265: /* Attributes applied by PMake */
266: #define OP_TRANSFORM 0x80000000 /* The node is a transformation rule */
267: #define OP_MEMBER 0x40000000 /* Target is a member of an archive */
268: #define OP_LIB 0x20000000 /* Target is a library */
269: #define OP_ARCHV 0x10000000 /* Target is an archive construct */
270: #define OP_HAS_COMMANDS 0x08000000 /* Target has all the commands it should.
271: * Used when parsing to catch multiple
272: * commands for a target */
273: #define OP_SAVE_CMDS 0x04000000 /* Saving commands on .END (Compat) */
274: #define OP_DEPS_FOUND 0x02000000 /* Already processed by Suff_FindDeps */
1.29 mycroft 275: #define OP_MARK 0x01000000 /* Node found while expanding .ALLSRC */
1.1 cgd 276:
1.31 sommerfe 277: #define NoExecute(gn) ((gn->type & OP_MAKE) ? noRecursiveExecute : noExecute)
1.1 cgd 278: /*
279: * OP_NOP will return TRUE if the node with the given type was not the
280: * object of a dependency operator
281: */
282: #define OP_NOP(t) (((t) & OP_OPMASK) == 0x00000000)
1.16 christos 283:
284: #define OP_NOTARGET (OP_NOTMAIN|OP_USE|OP_EXEC|OP_TRANSFORM)
1.1 cgd 285:
286: /*
287: * The TARG_ constants are used when calling the Targ_FindNode and
288: * Targ_FindList functions in targ.c. They simply tell the functions what to
289: * do if the desired node(s) is (are) not found. If the TARG_CREATE constant
290: * is given, a new, empty node will be created for the target, placed in the
291: * table of all targets and its address returned. If TARG_NOCREATE is given,
1.11 christos 292: * a NIL pointer will be returned.
1.1 cgd 293: */
294: #define TARG_CREATE 0x01 /* create node if not found */
295: #define TARG_NOCREATE 0x00 /* don't create it */
296:
297: /*
298: * There are several places where expandable buffers are used (parse.c and
299: * var.c). This constant is merely the starting point for those buffers. If
300: * lines tend to be much shorter than this, it would be best to reduce BSIZE.
301: * If longer, it should be increased. Reducing it will cause more copying to
302: * be done for longer lines, but will save space for shorter ones. In any
303: * case, it ought to be a power of two simply because most storage allocation
1.11 christos 304: * schemes allocate in powers of two.
1.1 cgd 305: */
1.3 cgd 306: #define MAKE_BSIZE 256 /* starting size for expandable buffers */
1.1 cgd 307:
308: /*
309: * These constants are all used by the Str_Concat function to decide how the
310: * final string should look. If STR_ADDSPACE is given, a space will be
311: * placed between the two strings. If STR_ADDSLASH is given, a '/' will
312: * be used instead of a space. If neither is given, no intervening characters
313: * will be placed between the two strings in the final output. If the
314: * STR_DOFREE bit is set, the two input strings will be freed before
1.11 christos 315: * Str_Concat returns.
1.1 cgd 316: */
317: #define STR_ADDSPACE 0x01 /* add a space when Str_Concat'ing */
1.46 christos 318: #define STR_ADDSLASH 0x02 /* add a slash when Str_Concat'ing */
1.1 cgd 319:
320: /*
321: * Error levels for parsing. PARSE_FATAL means the process cannot continue
322: * once the makefile has been parsed. PARSE_WARNING means it can. Passed
323: * as the first argument to Parse_Error.
324: */
325: #define PARSE_WARNING 2
326: #define PARSE_FATAL 1
327:
328: /*
329: * Values returned by Cond_Eval.
330: */
331: #define COND_PARSE 0 /* Parse the next lines */
332: #define COND_SKIP 1 /* Skip the next lines */
333: #define COND_INVALID 2 /* Not a conditional statement */
334:
335: /*
336: * Definitions for the "local" variables. Used only for clarity.
337: */
338: #define TARGET "@" /* Target of dependency */
339: #define OODATE "?" /* All out-of-date sources */
340: #define ALLSRC ">" /* All sources */
341: #define IMPSRC "<" /* Source implied by transformation */
342: #define PREFIX "*" /* Common prefix */
343: #define ARCHIVE "!" /* Archive in "archive(member)" syntax */
344: #define MEMBER "%" /* Member in "archive(member)" syntax */
345:
346: #define FTARGET "@F" /* file part of TARGET */
347: #define DTARGET "@D" /* directory part of TARGET */
348: #define FIMPSRC "<F" /* file part of IMPSRC */
349: #define DIMPSRC "<D" /* directory part of IMPSRC */
350: #define FPREFIX "*F" /* file part of PREFIX */
351: #define DPREFIX "*D" /* directory part of PREFIX */
352:
353: /*
1.11 christos 354: * Global Variables
1.1 cgd 355: */
356: extern Lst create; /* The list of target names specified on the
357: * command line. used to resolve #if
358: * make(...) statements */
359: extern Lst dirSearchPath; /* The list of directories to search when
360: * looking for targets */
361:
1.3 cgd 362: extern Boolean compatMake; /* True if we are make compatible */
1.1 cgd 363: extern Boolean ignoreErrors; /* True if should ignore all errors */
364: extern Boolean beSilent; /* True if should print no commands */
365: extern Boolean noExecute; /* True if should execute nothing */
1.31 sommerfe 366: extern Boolean noRecursiveExecute; /* True if should execute nothing */
1.1 cgd 367: extern Boolean allPrecious; /* True if every target is precious */
368: extern Boolean keepgoing; /* True if should continue on unaffected
369: * portions of the graph when have an error
370: * in one portion */
371: extern Boolean touchFlag; /* TRUE if targets should just be 'touched'
372: * if out of date. Set by the -t flag */
373: extern Boolean usePipes; /* TRUE if should capture the output of
374: * subshells by means of pipes. Otherwise it
375: * is routed to temporary files from which it
376: * is retrieved when the shell exits */
377: extern Boolean queryFlag; /* TRUE if we aren't supposed to really make
378: * anything, just see if the targets are out-
379: * of-date */
380:
381: extern Boolean checkEnvFirst; /* TRUE if environment should be searched for
382: * variables before the global context */
1.30 sommerfe 383: extern Boolean jobServer; /* a jobServer already exists */
1.1 cgd 384:
1.32 christos 385: extern Boolean parseWarnFatal; /* TRUE if makefile parsing warnings are
386: * treated as errors */
1.45 thorpej 387:
388: extern Boolean varNoExportEnv; /* TRUE if we should not export variables
389: * set on the command line to the env. */
1.32 christos 390:
1.1 cgd 391: extern GNode *DEFAULT; /* .DEFAULT rule */
392:
393: extern GNode *VAR_GLOBAL; /* Variables defined in a global context, e.g
394: * in the Makefile itself */
395: extern GNode *VAR_CMD; /* Variables defined on the command line */
1.26 mycroft 396: extern GNode *VAR_FOR; /* Iteration variables */
1.1 cgd 397: extern char var_Error[]; /* Value returned by Var_Parse when an error
398: * is encountered. It actually points to
399: * an empty string, so naive callers needn't
400: * worry about it. */
401:
402: extern time_t now; /* The time at the start of this whole
403: * process */
404:
405: extern Boolean oldVars; /* Do old-style variable substitution */
1.9 christos 406:
407: extern Lst sysIncPath; /* The system include path. */
1.38 tv 408: extern Lst defIncPath; /* The default include path. */
1.32 christos 409:
410: extern char *progname; /* The program name */
1.30 sommerfe 411:
412: #define MAKEFLAGS ".MAKEFLAGS"
1.35 sjg 413: #define MAKEOVERRIDES ".MAKEOVERRIDES"
1.1 cgd 414:
415: /*
416: * debug control:
417: * There is one bit per module. It is up to the module what debug
418: * information to print.
419: */
420: extern int debug;
421: #define DEBUG_ARCH 0x0001
422: #define DEBUG_COND 0x0002
423: #define DEBUG_DIR 0x0004
424: #define DEBUG_GRAPH1 0x0008
425: #define DEBUG_GRAPH2 0x0010
426: #define DEBUG_JOB 0x0020
427: #define DEBUG_MAKE 0x0040
428: #define DEBUG_SUFF 0x0080
429: #define DEBUG_TARG 0x0100
430: #define DEBUG_VAR 0x0200
1.3 cgd 431: #define DEBUG_FOR 0x0400
1.34 sjg 432: #define DEBUG_SHELL 0x0800
1.48 jmmv 433: #define DEBUG_ERROR 0x1000
1.50 dsl 434: #define DEBUG_GRAPH3 0x10000
1.1 cgd 435:
436: #define CONCAT(a,b) a##b
437:
438: #define DEBUG(module) (debug & CONCAT(DEBUG_,module))
439:
440: /*
441: * Since there are so many, all functions that return non-integer values are
442: * extracted by means of a sed script or two and stuck in the file "nonints.h"
443: */
444: #include "nonints.h"
445:
1.44 wiz 446: int Make_TimeStamp(GNode *, GNode *);
447: Boolean Make_OODate(GNode *);
448: Lst Make_ExpandUse(Lst);
449: time_t Make_Recheck(GNode *);
450: void Make_HandleUse(GNode *, GNode *);
451: void Make_Update(GNode *);
452: void Make_DoAllVar(GNode *);
453: Boolean Make_Run(Lst);
1.46 christos 454: char * Check_Cwd_Cmd(const char *);
455: void Check_Cwd(const char **);
456: void PrintOnError(const char *);
1.44 wiz 457: void Main_ExportMAKEFLAGS(Boolean);
458: Boolean Main_SetObjdir(const char *);
1.46 christos 459:
460: #ifdef __GNUC__
461: #define UNCONST(ptr) ({ \
462: union __unconst { \
463: const void *__cp; \
464: void *__p; \
465: } __d; \
466: __d.__cp = ptr, __d.__p; })
467: #else
468: #define UNCONST(ptr) (void *)(ptr)
1.49 sjg 469: #endif
470:
471: #ifndef MIN
472: #define MIN(a, b) ((a < b) ? a : b)
473: #endif
474: #ifndef MAX
475: #define MAX(a, b) ((a > b) ? a : b)
1.46 christos 476: #endif
1.3 cgd 477:
478: #endif /* _MAKE_H_ */
CVSweb <webmaster@jp.NetBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to make.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [cvs.NetBSD.org] / src / usr.bin / make