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