Annotation of src/usr.bin/make/make.h, Revision 1.27
1.27 ! espie 1: /* $OpenBSD: make.h,v 1.26 2000/09/14 13:40:03 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:
! 93: typedef time_t TIMESTAMP;
! 94: #define is_out_of_date(t) ((t) == INT_MIN)
! 95: #define set_out_of_date(t) (t) = INT_MIN
! 96: #define grab_stat(s, t) \
! 97: do { \
! 98: (t) = (s).st_mtime; \
! 99: if (is_out_of_date(t)) \
! 100: (t)++; \
! 101: } while (0)
! 102: #define is_before(t1, t2) ((t1) < (t2))
! 103: #define grab_date(d, t) \
! 104: do { \
! 105: (t) = d; \
! 106: if (is_out_of_date(t)) \
! 107: (t)++; \
! 108: } while (0)
! 109: #define grab(n) time(&(n))
! 110: #define timestamp2time_t(t) (t)
1.17 espie 111:
112: #define OUT_OF_DATE INT_MIN
1.1 deraadt 113:
1.21 espie 114: /* Variables that are kept in local GNodes. */
115: #define TARGET_INDEX 0
116: #define OODATE_INDEX 1
117: #define ALLSRC_INDEX 2
118: #define IMPSRC_INDEX 3
119: #define PREFIX_INDEX 4
120: #define ARCHIVE_INDEX 5
121: #define MEMBER_INDEX 6
1.23 espie 122:
123: #define LOCAL_SIZE 7
124:
125: /* SymTable is private to var.c, but is declared here to allow for
126: local declaration of context tables
127: */
128: typedef struct {
129: struct Var_ *locals[LOCAL_SIZE];
130: } SymTable;
131:
1.24 espie 132: typedef struct hash GSymT;
1.1 deraadt 133: /*-
134: * The structure for an individual graph node. Each node has several
135: * pieces of data associated with it.
136: * 1) the name of the target it describes
137: * 2) the location of the target file in the file system.
138: * 3) the type of operator used to define its sources (qv. parse.c)
139: * 4) whether it is involved in this invocation of make
140: * 5) whether the target has been remade
141: * 6) whether any of its children has been remade
142: * 7) the number of its children that are, as yet, unmade
143: * 8) its modification time
144: * 9) the modification time of its youngest child (qv. make.c)
145: * 10) a list of nodes for which this is a source
146: * 11) a list of nodes on which this depends
147: * 12) a list of nodes that depend on this, as gleaned from the
148: * transformation rules.
149: * 13) a list of nodes of the same name created by the :: operator
150: * 14) a list of nodes that must be made (if they're made) before
151: * this node can be, but that do no enter into the datedness of
152: * this node.
153: * 15) a list of nodes that must be made (if they're made) after
154: * this node is, but that do not depend on this node, in the
155: * normal sense.
156: * 16) a Lst of ``local'' variables that are specific to this target
157: * and this target only (qv. var.c [$@ $< $?, etc.])
158: * 17) a Lst of strings that are commands to be given to a shell
1.7 millert 159: * to create this target.
1.1 deraadt 160: */
1.26 espie 161: typedef struct GNode_ {
1.1 deraadt 162: char *path; /* The full pathname of the file */
163: int type; /* Its type (see the OP flags, below) */
1.2 deraadt 164: int order; /* Its wait weight */
1.1 deraadt 165:
166: Boolean make; /* TRUE if this target needs to be remade */
167: enum {
168: UNMADE, BEINGMADE, MADE, UPTODATE, ERROR, ABORTED,
1.11 mickey 169: CYCLE, ENDCYCLE
1.1 deraadt 170: } made; /* Set to reflect the state of processing
171: * on this node:
172: * UNMADE - Not examined yet
173: * BEINGMADE - Target is already being made.
174: * Indicates a cycle in the graph. (compat
175: * mode only)
176: * MADE - Was out-of-date and has been made
177: * UPTODATE - Was already up-to-date
178: * ERROR - An error occured while it was being
179: * made (used only in compat mode)
180: * ABORTED - The target was aborted due to
181: * an error making an inferior (compat).
182: * CYCLE - Marked as potentially being part of
183: * a graph cycle. If we come back to a
184: * node marked this way, it is printed
185: * and 'made' is changed to ENDCYCLE.
186: * ENDCYCLE - the cycle has been completely
187: * printed. Go back and unmark all its
188: * members.
189: */
190: Boolean childMade; /* TRUE if one of this target's children was
191: * made */
192: int unmade; /* The number of unmade children */
193:
1.13 espie 194: time_t mtime; /* Its modification time */
195: time_t cmtime; /* The modification time of its youngest
1.1 deraadt 196: * child */
197:
1.19 espie 198: LIST iParents; /* Links to parents for which this is an
1.1 deraadt 199: * implied source, if any */
1.19 espie 200: LIST cohorts; /* Other nodes for the :: operator */
201: LIST parents; /* Nodes that depend on this one */
202: LIST children; /* Nodes on which this one depends */
203: LIST successors; /* Nodes that must be made after this one */
204: LIST preds; /* Nodes that must be made before this one */
1.1 deraadt 205:
1.22 espie 206: SymTable context; /* The local variables */
1.18 espie 207: unsigned long lineno; /* First line number of commands. */
208: const char * fname; /* File name of commands. */
1.19 espie 209: LIST commands; /* Creation commands */
1.1 deraadt 210:
211: struct _Suff *suffix; /* Suffix for the node (determined by
212: * Suff_FindDeps and opaque to everyone
213: * but the Suff module) */
1.26 espie 214: char name[1]; /* The target's name */
1.1 deraadt 215: } GNode;
216:
217: /*
1.7 millert 218: * Manifest constants
1.1 deraadt 219: */
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.7 millert 228: * righthand side...
1.1 deraadt 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 */
248: #define OP_MAKE 0x00000200 /* Target is a recurrsive 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 */
1.8 millert 254: #define OP_MADE 0x00000800 /* Assume the node is already made; even if
255: * it really is out of date */
1.1 deraadt 256: #define OP_INVISIBLE 0x00004000 /* The node is invisible to its parents.
257: * I.e. it doesn't show up in the parents's
258: * local variables. */
259: #define OP_NOTMAIN 0x00008000 /* The node is exempt from normal 'main
260: * target' processing in parse.c */
261: #define OP_PHONY 0x00010000 /* Not a file target; run always */
1.13 espie 262: #define OP_NOPATH 0x00020000 /* Don't search for file in the path */
1.1 deraadt 263: /* Attributes applied by PMake */
264: #define OP_TRANSFORM 0x80000000 /* The node is a transformation rule */
265: #define OP_MEMBER 0x40000000 /* Target is a member of an archive */
266: #define OP_LIB 0x20000000 /* Target is a library */
267: #define OP_ARCHV 0x10000000 /* Target is an archive construct */
268: #define OP_HAS_COMMANDS 0x08000000 /* Target has all the commands it should.
269: * Used when parsing to catch multiple
270: * commands for a target */
271: #define OP_SAVE_CMDS 0x04000000 /* Saving commands on .END (Compat) */
272: #define OP_DEPS_FOUND 0x02000000 /* Already processed by Suff_FindDeps */
273:
274: /*
275: * OP_NOP will return TRUE if the node with the given type was not the
276: * object of a dependency operator
277: */
278: #define OP_NOP(t) (((t) & OP_OPMASK) == 0x00000000)
1.13 espie 279:
280: #define OP_NOTARGET (OP_NOTMAIN|OP_USE|OP_EXEC|OP_TRANSFORM)
1.1 deraadt 281:
282: /*
1.20 espie 283: * The TARG_ constants are used when calling the Targ_FindNode function in
284: * targ.c. They simply tell the function what to do if the desired node(s)
285: * is (are) not found.
286: * If the TARG_CREATE constant is given, a new, empty node will be created
287: * for the target, placed in the table of all targets and its address returned.
288: * If TARG_NOCREATE is given, a NULL pointer will be returned.
1.1 deraadt 289: */
290: #define TARG_CREATE 0x01 /* create node if not found */
291: #define TARG_NOCREATE 0x00 /* don't create it */
292:
293: /*
294: * There are several places where expandable buffers are used (parse.c and
295: * var.c). This constant is merely the starting point for those buffers. If
296: * lines tend to be much shorter than this, it would be best to reduce BSIZE.
297: * If longer, it should be increased. Reducing it will cause more copying to
298: * be done for longer lines, but will save space for shorter ones. In any
299: * case, it ought to be a power of two simply because most storage allocation
1.7 millert 300: * schemes allocate in powers of two.
1.1 deraadt 301: */
302: #define MAKE_BSIZE 256 /* starting size for expandable buffers */
303:
304: /*
305: * These constants are all used by the Str_Concat function to decide how the
306: * final string should look. If STR_ADDSPACE is given, a space will be
307: * placed between the two strings. If STR_ADDSLASH is given, a '/' will
308: * be used instead of a space. If neither is given, no intervening characters
309: * will be placed between the two strings in the final output. If the
310: * STR_DOFREE bit is set, the two input strings will be freed before
1.7 millert 311: * Str_Concat returns.
1.1 deraadt 312: */
313: #define STR_ADDSPACE 0x01 /* add a space when Str_Concat'ing */
314: #define STR_DOFREE 0x02 /* free source strings after concatenation */
315: #define STR_ADDSLASH 0x04 /* add a slash when Str_Concat'ing */
316:
317: /*
318: * Error levels for parsing. PARSE_FATAL means the process cannot continue
319: * once the makefile has been parsed. PARSE_WARNING means it can. Passed
320: * as the first argument to Parse_Error.
321: */
322: #define PARSE_WARNING 2
323: #define PARSE_FATAL 1
324:
325: /*
326: * Values returned by Cond_Eval.
327: */
328: #define COND_PARSE 0 /* Parse the next lines */
329: #define COND_SKIP 1 /* Skip the next lines */
330: #define COND_INVALID 2 /* Not a conditional statement */
331:
332: /*
333: * Definitions for the "local" variables. Used only for clarity.
334: */
335: #define TARGET "@" /* Target of dependency */
336: #define OODATE "?" /* All out-of-date sources */
337: #define ALLSRC ">" /* All sources */
338: #define IMPSRC "<" /* Source implied by transformation */
339: #define PREFIX "*" /* Common prefix */
340: #define ARCHIVE "!" /* Archive in "archive(member)" syntax */
341: #define MEMBER "%" /* Member in "archive(member)" syntax */
1.24 espie 342: #define LONGTARGET ".TARGET"
343: #define LONGOODATE ".OODATE"
344: #define LONGALLSRC ".ALLSRC"
345: #define LONGIMPSRC ".IMPSRC"
346: #define LONGPREFIX ".PREFIX"
347: #define LONGARCHIVE ".ARCHIVE"
348: #define LONGMEMBER ".MEMBER"
349:
1.1 deraadt 350:
351: #define FTARGET "@F" /* file part of TARGET */
352: #define DTARGET "@D" /* directory part of TARGET */
353: #define FIMPSRC "<F" /* file part of IMPSRC */
354: #define DIMPSRC "<D" /* directory part of IMPSRC */
355: #define FPREFIX "*F" /* file part of PREFIX */
356: #define DPREFIX "*D" /* directory part of PREFIX */
357:
358: /*
1.7 millert 359: * Global Variables
1.1 deraadt 360: */
1.19 espie 361: extern LIST create; /* The list of target names specified on the
1.1 deraadt 362: * command line. used to resolve #if
363: * make(...) statements */
1.19 espie 364: extern LIST dirSearchPath; /* The list of directories to search when
1.1 deraadt 365: * looking for targets */
366:
367: extern Boolean compatMake; /* True if we are make compatible */
368: extern Boolean ignoreErrors; /* True if should ignore all errors */
369: extern Boolean beSilent; /* True if should print no commands */
370: extern Boolean noExecute; /* True if should execute nothing */
371: extern Boolean allPrecious; /* True if every target is precious */
372: extern Boolean keepgoing; /* True if should continue on unaffected
373: * portions of the graph when have an error
374: * in one portion */
375: extern Boolean touchFlag; /* TRUE if targets should just be 'touched'
376: * if out of date. Set by the -t flag */
377: extern Boolean usePipes; /* TRUE if should capture the output of
378: * subshells by means of pipes. Otherwise it
379: * is routed to temporary files from which it
380: * is retrieved when the shell exits */
381: extern Boolean queryFlag; /* TRUE if we aren't supposed to really make
382: * anything, just see if the targets are out-
383: * of-date */
384:
385: extern Boolean checkEnvFirst; /* TRUE if environment should be searched for
386: * variables before the global context */
387:
388: extern GNode *DEFAULT; /* .DEFAULT rule */
389:
1.23 espie 390: extern GSymT *VAR_GLOBAL; /* Variables defined in a global context, e.g
1.1 deraadt 391: * in the Makefile itself */
1.23 espie 392: extern GSymT *VAR_CMD; /* Variables defined on the command line */
1.1 deraadt 393: extern char var_Error[]; /* Value returned by Var_Parse when an error
394: * is encountered. It actually points to
395: * an empty string, so naive callers needn't
396: * worry about it. */
397:
398: extern time_t now; /* The time at the start of this whole
399: * process */
400:
401: extern Boolean oldVars; /* Do old-style variable substitution */
402:
1.19 espie 403: extern LIST sysIncPath; /* The system include path. */
1.4 niklas 404:
1.1 deraadt 405: /*
406: * debug control:
407: * There is one bit per module. It is up to the module what debug
408: * information to print.
409: */
410: extern int debug;
411: #define DEBUG_ARCH 0x0001
412: #define DEBUG_COND 0x0002
413: #define DEBUG_DIR 0x0004
414: #define DEBUG_GRAPH1 0x0008
415: #define DEBUG_GRAPH2 0x0010
416: #define DEBUG_JOB 0x0020
417: #define DEBUG_MAKE 0x0040
418: #define DEBUG_SUFF 0x0080
419: #define DEBUG_TARG 0x0100
420: #define DEBUG_VAR 0x0200
421: #define DEBUG_FOR 0x0400
422:
423: #ifdef __STDC__
424: #define CONCAT(a,b) a##b
425: #else
426: #define I(a) a
427: #define CONCAT(a,b) I(a)b
428: #endif /* __STDC__ */
429:
430: #define DEBUG(module) (debug & CONCAT(DEBUG_,module))
431:
1.15 espie 432: #include "extern.h"
1.1 deraadt 433:
434: #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