Annotation of src/usr.bin/make/gnode.h, Revision 1.6
1.1 espie 1: #ifndef GNODE_H
2: #define GNODE_H
3: /* $OpenPackages$ */
1.6 ! espie 4: /* $OpenBSD$ */
1.1 espie 5:
6: /*
7: * Copyright (c) 2001 Marc Espie.
8: *
9: * Redistribution and use in source and binary forms, with or without
10: * modification, are permitted provided that the following conditions
11: * are met:
12: * 1. Redistributions of source code must retain the above copyright
13: * notice, this list of conditions and the following disclaimer.
14: * 2. Redistributions in binary form must reproduce the above copyright
15: * notice, this list of conditions and the following disclaimer in the
16: * documentation and/or other materials provided with the distribution.
17: *
18: * THIS SOFTWARE IS PROVIDED BY THE OPENBSD PROJECT AND CONTRIBUTORS
19: * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OPENBSD
22: * PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29: */
30:
31: #ifndef TIMESTAMP_TYPE
32: #include "timestamp_t.h"
33: #endif
34: #ifndef LIST_TYPE
35: #include "lst_t.h"
36: #endif
37: #ifndef SYMTABLE_H
38: #include "symtable.h"
39: #endif
40:
41: struct Suff_;
42: /*-
43: * The structure for an individual graph node. Each node has several
44: * pieces of data associated with it.
45: * 1) the name of the target it describes
46: * 2) the location of the target file in the file system.
47: * 3) the type of operator used to define its sources (qv. parse.c)
48: * 4) whether it is involved in this invocation of make
49: * 5) whether the target has been remade
50: * 6) whether any of its children has been remade
51: * 7) the number of its children that are, as yet, unmade
52: * 8) its modification time
53: * 9) the modification time of its youngest child (qv. make.c)
54: * 10) a list of nodes for which this is a source
55: * 11) a list of nodes on which this depends
56: * 12) a list of nodes that depend on this, as gleaned from the
57: * transformation rules.
58: * 13) a list of nodes of the same name created by the :: operator
59: * 14) a list of nodes that must be made (if they're made) before
60: * this node can be, but that do no enter into the datedness of
61: * this node.
62: * 15) a list of nodes that must be made (if they're made) after
63: * this node is, but that do not depend on this node, in the
64: * normal sense.
65: * 16) a Lst of ``local'' variables that are specific to this target
66: * and this target only (qv. var.c [$@ $< $?, etc.])
67: * 17) a Lst of strings that are commands to be given to a shell
68: * to create this target.
69: */
1.5 espie 70:
71: #define UNMADE 0
72: #define BEINGMADE 1
73: #define MADE 2
74: #define UPTODATE 3
75: #define ERROR 4
76: #define ABORTED 5
77: #define CYCLE 6
78: #define ENDCYCLE 7
79: #define NOSUCHNODE 8
80:
81: #define SPECIAL_NONE 0
82: #define SPECIAL_PATH 21
83: #define SPECIAL_MASK 63
84: #define SPECIAL_TARGET 64
85: #define SPECIAL_SOURCE 128
86: #define SPECIAL_TARGETSOURCE (SPECIAL_TARGET|SPECIAL_SOURCE)
87:
1.1 espie 88: struct GNode_ {
1.5 espie 89: int special_op; /* special op to apply */
90: unsigned char special;/* type of special node */
91: char make; /* true if this target needs to be remade */
92: char childMade; /* true if one of this target's children was
93: * made */
94: char made; /* Set to reflect the state of processing
95: * on this node:
96: * UNMADE - Not examined yet
97: * BEINGMADE - Target is already being made.
98: * Indicates a cycle in the graph. (compat
99: * mode only)
100: * MADE - Was out-of-date and has been made
101: * UPTODATE - Was already up-to-date
102: * ERROR - An error occurred while it was being
103: * made (used only in compat mode)
104: * ABORTED - The target was aborted due to
105: * an error making an inferior (compat).
106: * CYCLE - Marked as potentially being part of
107: * a graph cycle. If we come back to a
108: * node marked this way, it is printed
109: * and 'made' is changed to ENDCYCLE.
110: * ENDCYCLE - the cycle has been completely
111: * printed. Go back and unmark all its
112: * members.
113: */
114: char *path; /* The full pathname of the file */
115: int type; /* Its type (see the OP flags, below) */
116: int order; /* Its wait weight */
117:
118: int unmade; /* The number of unmade children */
119:
120: TIMESTAMP mtime; /* Its modification time */
121: TIMESTAMP cmtime; /* The modification time of its youngest
122: * child */
123:
124: LIST iParents; /* Links to parents for which this is an
125: * implied source, if any */
126: LIST cohorts; /* Other nodes for the :: operator */
127: LIST parents; /* Nodes that depend on this one */
128: LIST children; /* Nodes on which this one depends */
129: LIST successors; /* Nodes that must be made after this one */
130: LIST preds; /* Nodes that must be made before this one */
131:
132: SymTable context; /* The local variables */
133: unsigned long lineno;/* First line number of commands. */
134: const char *fname; /* File name of commands. */
135: LIST commands; /* Creation commands */
136: LstNode current; /* Current command, for job */
137:
138: struct Suff_ *suffix;/* Suffix for the node (determined by
139: * Suff_FindDeps and opaque to everyone
140: * but the Suff module) */
141: char name[1]; /* The target's name */
1.1 espie 142: };
143:
144: /*
145: * The OP_ constants are used when parsing a dependency line as a way of
146: * communicating to other parts of the program the way in which a target
147: * should be made. These constants are bitwise-OR'ed together and
148: * placed in the 'type' field of each node. Any node that has
149: * a 'type' field which satisfies the OP_NOP function was never never on
150: * the lefthand side of an operator, though it may have been on the
151: * righthand side...
152: */
153: #define OP_DEPENDS 0x00000001 /* Execution of commands depends on
154: * kids (:) */
155: #define OP_FORCE 0x00000002 /* Always execute commands (!) */
156: #define OP_DOUBLEDEP 0x00000004 /* Execution of commands depends on kids
157: * per line (::) */
1.6 ! espie 158: #define OP_ERROR 0x00000000
1.1 espie 159: #define OP_OPMASK (OP_DEPENDS|OP_FORCE|OP_DOUBLEDEP)
160:
161: #define OP_OPTIONAL 0x00000008 /* Don't care if the target doesn't
162: * exist and can't be created */
163: #define OP_USE 0x00000010 /* Use associated commands for parents */
164: #define OP_EXEC 0x00000020 /* Target is never out of date, but always
165: * execute commands anyway. Its time
166: * doesn't matter, so it has none...sort
167: * of */
168: #define OP_IGNORE 0x00000040 /* Ignore errors when creating the node */
169: #define OP_PRECIOUS 0x00000080 /* Don't remove the target when
170: * interrupted */
171: #define OP_SILENT 0x00000100 /* Don't echo commands when executed */
1.5 espie 172: #define OP_MAKE 0x00000200 /* Target is a recursive make so its
1.1 espie 173: * commands should always be executed when
174: * it is out of date, regardless of the
175: * state of the -n or -t flags */
176: #define OP_JOIN 0x00000400 /* Target is out-of-date only if any of its
177: * children was out-of-date */
178: #define OP_MADE 0x00000800 /* Assume the node is already made; even if
179: * it really is out of date */
180: #define OP_INVISIBLE 0x00004000 /* The node is invisible to its parents.
181: * I.e. it doesn't show up in the parents's
182: * local variables. */
183: #define OP_NOTMAIN 0x00008000 /* The node is exempt from normal 'main
184: * target' processing in parse.c */
185: #define OP_PHONY 0x00010000 /* Not a file target; run always */
186: #define OP_NOPATH 0x00020000 /* Don't search for file in the path */
1.5 espie 187: #define OP_NODEFAULT 0x00040000 /* Special node that never needs */
188: /* DEFAULT commands applied */
189: #define OP_DUMMY 0x00080000 /* node was created by default, but it */
190: /* does not really exist. */
1.1 espie 191: /* Attributes applied by PMake */
192: #define OP_TRANSFORM 0x80000000 /* The node is a transformation rule */
193: #define OP_MEMBER 0x40000000 /* Target is a member of an archive */
194: #define OP_LIB 0x20000000 /* Target is a library */
195: #define OP_ARCHV 0x10000000 /* Target is an archive construct */
196: #define OP_HAS_COMMANDS 0x08000000 /* Target has all the commands it should.
197: * Used when parsing to catch multiple
198: * commands for a target */
199: #define OP_SAVE_CMDS 0x04000000 /* Saving commands on .END (Compat) */
200: #define OP_DEPS_FOUND 0x02000000 /* Already processed by Suff_FindDeps */
201:
202: /*
203: * OP_NOP will return true if the node with the given type was not the
204: * object of a dependency operator
205: */
206: #define OP_NOP(t) (((t) & OP_OPMASK) == 0x00000000)
207:
208: #define OP_NOTARGET (OP_NOTMAIN|OP_USE|OP_EXEC|OP_TRANSFORM)
209:
210:
211: #endif