Annotation of src/usr.bin/make/make.h, Revision 1.30
1.30 ! espie 1: /* $OpenBSD: make.h,v 1.29 2000/11/24 14:36:35 espie Exp $ */
1.8 millert 2: /* $NetBSD: make.h,v 1.15 1997/03/10 21:20:00 christos Exp $ */
1.1 deraadt 3:
4: /*
5: * Copyright (c) 1988, 1989, 1990, 1993
6: * The Regents of the University of California. All rights reserved.
7: * Copyright (c) 1989 by Berkeley Softworks
8: * All rights reserved.
9: *
10: * This code is derived from software contributed to Berkeley by
11: * Adam de Boor.
12: *
13: * Redistribution and use in source and binary forms, with or without
14: * modification, are permitted provided that the following conditions
15: * are met:
16: * 1. Redistributions of source code must retain the above copyright
17: * notice, this list of conditions and the following disclaimer.
18: * 2. Redistributions in binary form must reproduce the above copyright
19: * notice, this list of conditions and the following disclaimer in the
20: * documentation and/or other materials provided with the distribution.
21: * 3. All advertising materials mentioning features or use of this software
22: * must display the following acknowledgement:
23: * This product includes software developed by the University of
24: * California, Berkeley and its contributors.
25: * 4. Neither the name of the University nor the names of its contributors
26: * may be used to endorse or promote products derived from this software
27: * without specific prior written permission.
28: *
29: * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
30: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
31: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
32: * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
33: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
34: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
35: * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
37: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
38: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39: * SUCH DAMAGE.
40: *
1.7 millert 41: * from: @(#)make.h 8.3 (Berkeley) 6/13/95
1.1 deraadt 42: */
43:
44: /*-
45: * make.h --
46: * The global definitions for pmake
47: */
48:
49: #ifndef _MAKE_H_
50: #define _MAKE_H_
51:
52: #include <sys/types.h>
1.8 millert 53: #include <sys/param.h>
1.1 deraadt 54: #include <stdio.h>
55: #include <string.h>
56: #include <ctype.h>
1.25 espie 57:
58: #ifdef __GNUC__
59: #define UNUSED __attribute__((unused))
60: #else
61: #define UNUSED
62: #endif
1.8 millert 63:
64: #if !defined(MAKE_BOOTSTRAP) && defined(BSD4_4)
65: # include <sys/cdefs.h>
1.1 deraadt 66: #else
1.8 millert 67: # ifndef __P
68: # if defined(__STDC__) || defined(__cplusplus)
69: # define __P(protos) protos /* full-blown ANSI C */
70: # else
71: # define __P(protos) () /* traditional C preprocessor */
72: # endif
73: # endif
1.12 art 74: # ifndef __STDC__
75: # ifndef const
76: # define const
77: # endif
78: # ifndef volatile
79: # define volatile
80: # endif
1.8 millert 81: # endif
1.1 deraadt 82: #endif
1.8 millert 83:
1.10 mickey 84: #ifdef __STDC__
1.1 deraadt 85: #include <stdlib.h>
86: #include <unistd.h>
87: #endif
88: #include "sprite.h"
89: #include "lst.h"
90: #include "config.h"
91: #include "buf.h"
1.27 espie 92:
1.29 espie 93: #ifdef USE_TIMESPEC
94: #include <sys/time.h>
95: typedef struct timespec TIMESTAMP;
96: #define set_out_of_date(t) (t).tv_sec = INT_MIN, (t).tv_nsec = 0
97: #define is_out_of_date(t) ((t).tv_sec == INT_MIN && (t).tv_nsec == 0)
98: #define grab_stat(s, t) \
99: do { \
100: (t).tv_sec = (s).st_mtime; \
101: (t).tv_nsec = (s).st_mtimensec; \
102: if (is_out_of_date(t)) \
103: (t).tv_nsec++; \
104: } while (0)
105: #define is_before(t1, t2) timespeccmp(&(t1), &(t2), <)
106: #define grab_date(d, t) \
107: do { \
108: (t).tv_sec = d; \
109: (t).tv_nsec = 0; \
110: if (is_out_of_date(t)) \
111: (t).tv_nsec++; \
112: } while (0)
113: #define grab(n) \
114: do { \
115: struct timeval tv; \
116: gettimeofday(&tv, NULL); \
117: TIMEVAL_TO_TIMESPEC(&(tv), &n); \
118: } while (0)
119: #define timestamp2time_t(t) ((t).tv_sec)
120: #else
1.27 espie 121: typedef time_t TIMESTAMP;
122: #define is_out_of_date(t) ((t) == INT_MIN)
123: #define set_out_of_date(t) (t) = INT_MIN
124: #define grab_stat(s, t) \
125: do { \
126: (t) = (s).st_mtime; \
127: if (is_out_of_date(t)) \
128: (t)++; \
129: } while (0)
130: #define is_before(t1, t2) ((t1) < (t2))
131: #define grab_date(d, t) \
132: do { \
133: (t) = d; \
134: if (is_out_of_date(t)) \
135: (t)++; \
136: } while (0)
137: #define grab(n) time(&(n))
138: #define timestamp2time_t(t) (t)
1.29 espie 139: #endif
1.1 deraadt 140:
1.21 espie 141: /* Variables that are kept in local GNodes. */
142: #define TARGET_INDEX 0
143: #define OODATE_INDEX 1
144: #define ALLSRC_INDEX 2
145: #define IMPSRC_INDEX 3
146: #define PREFIX_INDEX 4
147: #define ARCHIVE_INDEX 5
148: #define MEMBER_INDEX 6
1.23 espie 149:
150: #define LOCAL_SIZE 7
151:
152: /* SymTable is private to var.c, but is declared here to allow for
153: local declaration of context tables
154: */
155: typedef struct {
156: struct Var_ *locals[LOCAL_SIZE];
157: } SymTable;
158:
1.30 ! espie 159: typedef struct ohash GSymT;
1.1 deraadt 160: /*-
161: * The structure for an individual graph node. Each node has several
162: * pieces of data associated with it.
163: * 1) the name of the target it describes
164: * 2) the location of the target file in the file system.
165: * 3) the type of operator used to define its sources (qv. parse.c)
166: * 4) whether it is involved in this invocation of make
167: * 5) whether the target has been remade
168: * 6) whether any of its children has been remade
169: * 7) the number of its children that are, as yet, unmade
170: * 8) its modification time
171: * 9) the modification time of its youngest child (qv. make.c)
172: * 10) a list of nodes for which this is a source
173: * 11) a list of nodes on which this depends
174: * 12) a list of nodes that depend on this, as gleaned from the
175: * transformation rules.
176: * 13) a list of nodes of the same name created by the :: operator
177: * 14) a list of nodes that must be made (if they're made) before
178: * this node can be, but that do no enter into the datedness of
179: * this node.
180: * 15) a list of nodes that must be made (if they're made) after
181: * this node is, but that do not depend on this node, in the
182: * normal sense.
183: * 16) a Lst of ``local'' variables that are specific to this target
184: * and this target only (qv. var.c [$@ $< $?, etc.])
185: * 17) a Lst of strings that are commands to be given to a shell
1.7 millert 186: * to create this target.
1.1 deraadt 187: */
1.26 espie 188: typedef struct GNode_ {
1.1 deraadt 189: char *path; /* The full pathname of the file */
190: int type; /* Its type (see the OP flags, below) */
1.2 deraadt 191: int order; /* Its wait weight */
1.1 deraadt 192:
193: Boolean make; /* TRUE if this target needs to be remade */
194: enum {
195: UNMADE, BEINGMADE, MADE, UPTODATE, ERROR, ABORTED,
1.11 mickey 196: CYCLE, ENDCYCLE
1.1 deraadt 197: } made; /* Set to reflect the state of processing
198: * on this node:
199: * UNMADE - Not examined yet
200: * BEINGMADE - Target is already being made.
201: * Indicates a cycle in the graph. (compat
202: * mode only)
203: * MADE - Was out-of-date and has been made
204: * UPTODATE - Was already up-to-date
205: * ERROR - An error occured while it was being
206: * made (used only in compat mode)
207: * ABORTED - The target was aborted due to
208: * an error making an inferior (compat).
209: * CYCLE - Marked as potentially being part of
210: * a graph cycle. If we come back to a
211: * node marked this way, it is printed
212: * and 'made' is changed to ENDCYCLE.
213: * ENDCYCLE - the cycle has been completely
214: * printed. Go back and unmark all its
215: * members.
216: */
217: Boolean childMade; /* TRUE if one of this target's children was
218: * made */
219: int unmade; /* The number of unmade children */
220:
1.29 espie 221: TIMESTAMP mtime; /* Its modification time */
222: TIMESTAMP cmtime; /* The modification time of its youngest
1.1 deraadt 223: * child */
224:
1.19 espie 225: LIST iParents; /* Links to parents for which this is an
1.1 deraadt 226: * implied source, if any */
1.19 espie 227: LIST cohorts; /* Other nodes for the :: operator */
228: LIST parents; /* Nodes that depend on this one */
229: LIST children; /* Nodes on which this one depends */
230: LIST successors; /* Nodes that must be made after this one */
231: LIST preds; /* Nodes that must be made before this one */
1.1 deraadt 232:
1.22 espie 233: SymTable context; /* The local variables */
1.18 espie 234: unsigned long lineno; /* First line number of commands. */
235: const char * fname; /* File name of commands. */
1.19 espie 236: LIST commands; /* Creation commands */
1.1 deraadt 237:
1.28 espie 238: struct Suff_ *suffix; /* Suffix for the node (determined by
1.1 deraadt 239: * Suff_FindDeps and opaque to everyone
240: * but the Suff module) */
1.26 espie 241: char name[1]; /* The target's name */
1.1 deraadt 242: } GNode;
243:
244: /*
1.7 millert 245: * Manifest constants
1.1 deraadt 246: */
247:
248: /*
249: * The OP_ constants are used when parsing a dependency line as a way of
250: * communicating to other parts of the program the way in which a target
251: * should be made. These constants are bitwise-OR'ed together and
252: * placed in the 'type' field of each node. Any node that has
253: * a 'type' field which satisfies the OP_NOP function was never never on
254: * the lefthand side of an operator, though it may have been on the
1.7 millert 255: * righthand side...
1.1 deraadt 256: */
257: #define OP_DEPENDS 0x00000001 /* Execution of commands depends on
258: * kids (:) */
259: #define OP_FORCE 0x00000002 /* Always execute commands (!) */
260: #define OP_DOUBLEDEP 0x00000004 /* Execution of commands depends on kids
261: * per line (::) */
262: #define OP_OPMASK (OP_DEPENDS|OP_FORCE|OP_DOUBLEDEP)
263:
264: #define OP_OPTIONAL 0x00000008 /* Don't care if the target doesn't
265: * exist and can't be created */
266: #define OP_USE 0x00000010 /* Use associated commands for parents */
267: #define OP_EXEC 0x00000020 /* Target is never out of date, but always
268: * execute commands anyway. Its time
269: * doesn't matter, so it has none...sort
270: * of */
271: #define OP_IGNORE 0x00000040 /* Ignore errors when creating the node */
272: #define OP_PRECIOUS 0x00000080 /* Don't remove the target when
273: * interrupted */
274: #define OP_SILENT 0x00000100 /* Don't echo commands when executed */
275: #define OP_MAKE 0x00000200 /* Target is a recurrsive make so its
276: * commands should always be executed when
277: * it is out of date, regardless of the
278: * state of the -n or -t flags */
279: #define OP_JOIN 0x00000400 /* Target is out-of-date only if any of its
280: * children was out-of-date */
1.8 millert 281: #define OP_MADE 0x00000800 /* Assume the node is already made; even if
282: * it really is out of date */
1.1 deraadt 283: #define OP_INVISIBLE 0x00004000 /* The node is invisible to its parents.
284: * I.e. it doesn't show up in the parents's
285: * local variables. */
286: #define OP_NOTMAIN 0x00008000 /* The node is exempt from normal 'main
287: * target' processing in parse.c */
288: #define OP_PHONY 0x00010000 /* Not a file target; run always */
1.13 espie 289: #define OP_NOPATH 0x00020000 /* Don't search for file in the path */
1.1 deraadt 290: /* Attributes applied by PMake */
291: #define OP_TRANSFORM 0x80000000 /* The node is a transformation rule */
292: #define OP_MEMBER 0x40000000 /* Target is a member of an archive */
293: #define OP_LIB 0x20000000 /* Target is a library */
294: #define OP_ARCHV 0x10000000 /* Target is an archive construct */
295: #define OP_HAS_COMMANDS 0x08000000 /* Target has all the commands it should.
296: * Used when parsing to catch multiple
297: * commands for a target */
298: #define OP_SAVE_CMDS 0x04000000 /* Saving commands on .END (Compat) */
299: #define OP_DEPS_FOUND 0x02000000 /* Already processed by Suff_FindDeps */
300:
301: /*
302: * OP_NOP will return TRUE if the node with the given type was not the
303: * object of a dependency operator
304: */
305: #define OP_NOP(t) (((t) & OP_OPMASK) == 0x00000000)
1.13 espie 306:
307: #define OP_NOTARGET (OP_NOTMAIN|OP_USE|OP_EXEC|OP_TRANSFORM)
1.1 deraadt 308:
309: /*
1.20 espie 310: * The TARG_ constants are used when calling the Targ_FindNode function in
311: * targ.c. They simply tell the function what to do if the desired node(s)
312: * is (are) not found.
313: * If the TARG_CREATE constant is given, a new, empty node will be created
314: * for the target, placed in the table of all targets and its address returned.
315: * If TARG_NOCREATE is given, a NULL pointer will be returned.
1.1 deraadt 316: */
317: #define TARG_CREATE 0x01 /* create node if not found */
318: #define TARG_NOCREATE 0x00 /* don't create it */
319:
320: /*
321: * There are several places where expandable buffers are used (parse.c and
322: * var.c). This constant is merely the starting point for those buffers. If
323: * lines tend to be much shorter than this, it would be best to reduce BSIZE.
324: * If longer, it should be increased. Reducing it will cause more copying to
325: * be done for longer lines, but will save space for shorter ones. In any
326: * case, it ought to be a power of two simply because most storage allocation
1.7 millert 327: * schemes allocate in powers of two.
1.1 deraadt 328: */
329: #define MAKE_BSIZE 256 /* starting size for expandable buffers */
330:
331: /*
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
1.7 millert 338: * Str_Concat returns.
1.1 deraadt 339: */
340: #define STR_ADDSPACE 0x01 /* add a space when Str_Concat'ing */
341: #define STR_DOFREE 0x02 /* free source strings after concatenation */
342: #define STR_ADDSLASH 0x04 /* add a slash when Str_Concat'ing */
343:
344: /*
345: * Error levels for parsing. PARSE_FATAL means the process cannot continue
346: * once the makefile has been parsed. PARSE_WARNING means it can. Passed
347: * as the first argument to Parse_Error.
348: */
349: #define PARSE_WARNING 2
350: #define PARSE_FATAL 1
351:
352: /*
353: * Values returned by Cond_Eval.
354: */
355: #define COND_PARSE 0 /* Parse the next lines */
356: #define COND_SKIP 1 /* Skip the next lines */
357: #define COND_INVALID 2 /* Not a conditional statement */
358:
359: /*
360: * Definitions for the "local" variables. Used only for clarity.
361: */
362: #define TARGET "@" /* Target of dependency */
363: #define OODATE "?" /* All out-of-date sources */
364: #define ALLSRC ">" /* All sources */
365: #define IMPSRC "<" /* Source implied by transformation */
366: #define PREFIX "*" /* Common prefix */
367: #define ARCHIVE "!" /* Archive in "archive(member)" syntax */
368: #define MEMBER "%" /* Member in "archive(member)" syntax */
1.24 espie 369: #define LONGTARGET ".TARGET"
370: #define LONGOODATE ".OODATE"
371: #define LONGALLSRC ".ALLSRC"
372: #define LONGIMPSRC ".IMPSRC"
373: #define LONGPREFIX ".PREFIX"
374: #define LONGARCHIVE ".ARCHIVE"
375: #define LONGMEMBER ".MEMBER"
376:
1.1 deraadt 377:
378: #define FTARGET "@F" /* file part of TARGET */
379: #define DTARGET "@D" /* directory part of TARGET */
380: #define FIMPSRC "<F" /* file part of IMPSRC */
381: #define DIMPSRC "<D" /* directory part of IMPSRC */
382: #define FPREFIX "*F" /* file part of PREFIX */
383: #define DPREFIX "*D" /* directory part of PREFIX */
384:
385: /*
1.7 millert 386: * Global Variables
1.1 deraadt 387: */
1.19 espie 388: extern LIST create; /* The list of target names specified on the
1.1 deraadt 389: * command line. used to resolve #if
390: * make(...) statements */
1.19 espie 391: extern LIST dirSearchPath; /* The list of directories to search when
1.1 deraadt 392: * looking for targets */
393:
394: extern Boolean compatMake; /* True if we are make compatible */
395: extern Boolean ignoreErrors; /* True if should ignore all errors */
396: extern Boolean beSilent; /* True if should print no commands */
397: extern Boolean noExecute; /* True if should execute nothing */
398: extern Boolean allPrecious; /* True if every target is precious */
399: extern Boolean keepgoing; /* True if should continue on unaffected
400: * portions of the graph when have an error
401: * in one portion */
402: extern Boolean touchFlag; /* TRUE if targets should just be 'touched'
403: * if out of date. Set by the -t flag */
404: extern Boolean usePipes; /* TRUE if should capture the output of
405: * subshells by means of pipes. Otherwise it
406: * is routed to temporary files from which it
407: * is retrieved when the shell exits */
408: extern Boolean queryFlag; /* TRUE if we aren't supposed to really make
409: * anything, just see if the targets are out-
410: * of-date */
411:
412: extern Boolean checkEnvFirst; /* TRUE if environment should be searched for
413: * variables before the global context */
414:
415: extern GNode *DEFAULT; /* .DEFAULT rule */
416:
1.23 espie 417: extern GSymT *VAR_GLOBAL; /* Variables defined in a global context, e.g
1.1 deraadt 418: * in the Makefile itself */
1.23 espie 419: extern GSymT *VAR_CMD; /* Variables defined on the command line */
1.1 deraadt 420: extern char var_Error[]; /* Value returned by Var_Parse when an error
421: * is encountered. It actually points to
422: * an empty string, so naive callers needn't
423: * worry about it. */
424:
1.29 espie 425: extern TIMESTAMP now; /* The time at the start of this whole
1.1 deraadt 426: * process */
427:
428: extern Boolean oldVars; /* Do old-style variable substitution */
429:
1.19 espie 430: extern LIST sysIncPath; /* The system include path. */
1.4 niklas 431:
1.1 deraadt 432: /*
433: * debug control:
434: * There is one bit per module. It is up to the module what debug
435: * information to print.
436: */
437: extern int debug;
438: #define DEBUG_ARCH 0x0001
439: #define DEBUG_COND 0x0002
440: #define DEBUG_DIR 0x0004
441: #define DEBUG_GRAPH1 0x0008
442: #define DEBUG_GRAPH2 0x0010
443: #define DEBUG_JOB 0x0020
444: #define DEBUG_MAKE 0x0040
445: #define DEBUG_SUFF 0x0080
446: #define DEBUG_TARG 0x0100
447: #define DEBUG_VAR 0x0200
448: #define DEBUG_FOR 0x0400
449:
450: #ifdef __STDC__
451: #define CONCAT(a,b) a##b
452: #else
453: #define I(a) a
454: #define CONCAT(a,b) I(a)b
455: #endif /* __STDC__ */
456:
457: #define DEBUG(module) (debug & CONCAT(DEBUG_,module))
458:
1.15 espie 459: #include "extern.h"
1.1 deraadt 460:
461: #endif /* _MAKE_H_ */
![[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 [local] / src / usr.bin / make