Annotation of src/usr.bin/make/gnode.h, Revision 1.36
1.1 espie 1: #ifndef GNODE_H
2: #define GNODE_H
1.36 ! espie 3: /* $OpenBSD: gnode.h,v 1.35 2020/01/13 13:48:20 espie Exp $ */
1.1 espie 4:
5: /*
6: * Copyright (c) 2001 Marc Espie.
7: *
8: * Redistribution and use in source and binary forms, with or without
9: * modification, are permitted provided that the following conditions
10: * are met:
11: * 1. Redistributions of source code must retain the above copyright
12: * notice, this list of conditions and the following disclaimer.
13: * 2. Redistributions in binary form must reproduce the above copyright
14: * notice, this list of conditions and the following disclaimer in the
15: * documentation and/or other materials provided with the distribution.
16: *
17: * THIS SOFTWARE IS PROVIDED BY THE OPENBSD PROJECT AND CONTRIBUTORS
18: * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OPENBSD
21: * PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28: */
29:
1.24 espie 30: #include <sys/time.h>
1.1 espie 31: #ifndef LIST_TYPE
32: #include "lst_t.h"
33: #endif
1.18 espie 34: #ifndef LOCATION_TYPE
35: #include "location.h"
36: #endif
1.1 espie 37: #ifndef SYMTABLE_H
38: #include "symtable.h"
39: #endif
1.26 espie 40: #include <assert.h>
1.1 espie 41:
42: /*-
1.33 espie 43: * The structure for an individual graph node. Each node has a lot of
44: * of data associated with it.
45: * 1) the *name*of the target it describes (at end because ohash)
46: * 2) the *path* to the target file
47: * 3) the *type* of operator used to define its sources
48: * (cf parse.c, mostly : :: ! but...)
49: * 4) *must_make*: whether it is involved in this invocation of make
50: * 5) *built_status*: has the target been rebuilt/is up-to-date...
51: * 6) *child_rebuild*: at least one of its children has been rebuilt
52: * 7) *children_left*: number of children still to consider
53: * 8) *mtime*: node's modification time
54: * 9) *youngest*: youngest child (cf make.c)
55: * 10) *parents*: list of nodes for which this is a dependency
56: * 11) *children*: list of nodes on which this depends
57: * 12) *cohorts*: list of nodes of the same name created by the :: operator
58: * 13) *predecessors*: list of nodes, result of .ORDER:
1.31 espie 59: * if considered for building, they should be built before this node.
1.33 espie 60: * 14) *successors*: list of nodes, result of .ORDER:
1.31 espie 61: * if considered for building, they should be built after this node.
1.33 espie 62: * 15) *localvars*: ``local'' variables specific to this target
63: * and this target only (cf var.c [$@ $< $?, etc.])
64: * 16) *commands*: the actual LIST of strings to pass to the shell
1.1 espie 65: * to create this target.
66: */
1.5 espie 67:
1.35 espie 68: /* constants for specials: built of two parts
69: * - enumerated values (1-63U) hence SPECIAL_MASK
70: * - flags that say whether it can apply to a source or a target
71: * Most of these values are only handled by parse.c.
72: * In many cases, there is a corresponding OP_* flag
73: */
1.33 espie 74: #define SPECIAL_NONE 0U
1.35 espie 75: #define SPECIAL_PATH 62U /* handled by parse.c and suff.c */
1.15 espie 76: #define SPECIAL_MASK 63U
77: #define SPECIAL_TARGET 64U
78: #define SPECIAL_SOURCE 128U
1.5 espie 79: #define SPECIAL_TARGETSOURCE (SPECIAL_TARGET|SPECIAL_SOURCE)
80:
1.35 espie 81: #define SPECIAL_EXEC 4U
1.21 espie 82: #define SPECIAL_IGNORE 5U
1.36 ! espie 83: #define SPECIAL_NOTHING 6U /* this is used for things we
! 84: * recognize for compatibility but
! 85: * don't do anything with... */
1.35 espie 86: #define SPECIAL_INVISIBLE 8U
1.21 espie 87: #define SPECIAL_JOIN 9U
88: #define SPECIAL_MADE 11U
89: #define SPECIAL_MAIN 12U
90: #define SPECIAL_MAKE 13U
91: #define SPECIAL_MFLAGS 14U
1.35 espie 92: #define SPECIAL_NOTMAIN 15U
93: #define SPECIAL_NOTPARALLEL 16U
94: #define SPECIAL_OPTIONAL 18U
1.21 espie 95: #define SPECIAL_ORDER 19U
96: #define SPECIAL_PARALLEL 20U
97: #define SPECIAL_PHONY 22U
98: #define SPECIAL_PRECIOUS 23U
99: #define SPECIAL_SILENT 25U
100: #define SPECIAL_SUFFIXES 27U
1.35 espie 101: #define SPECIAL_USE 28U
1.21 espie 102: #define SPECIAL_WAIT 29U
103: #define SPECIAL_NOPATH 30U
104: #define SPECIAL_ERROR 31U
105: #define SPECIAL_CHEAP 32U
106: #define SPECIAL_EXPENSIVE 33U
107:
1.1 espie 108: struct GNode_ {
1.33 espie 109: unsigned int type; /* node type (see the OP flags, below) */
110: unsigned int special_op; /* special op to apply (only used in parse.c) */
111: unsigned char special; /* type of special node or SPECIAL_NONE */
1.32 espie 112: bool must_make; /* true if this target needs building */
113: bool child_rebuilt; /* true if at least one child was rebuilt,
1.31 espie 114: * thus triggering timestamps changes */
115:
116: char built_status;
117: #define UNKNOWN 0 /* Not examined yet */
118: #define BUILDING 1 /* In the process of building */
119: #define REBUILT 2 /* Was out of date and got rebuilt */
120: #define UPTODATE 3 /* Was already up-to-date */
121: #define ERROR 4 /* Error occurred while building
122: * (used only in compat mode) */
123: #define ABORTED 5 /* Was aborted due to an error
124: * making an inferior */
125: #define NOSUCHNODE 6 /* error from run_gnode */
126: #define HELDBACK 7 /* Another target in the same group is
1.33 espie 127: * currently building, avoid race conditions
128: * Only used in the parallel engine make.c */
1.31 espie 129:
1.33 espie 130: char *path; /* full pathname of the file */
131: int order; /* wait weight (see .ORDER/predecessors/successors) */
1.5 espie 132:
1.33 espie 133: int children_left; /* number of children left to build */
1.5 espie 134:
1.31 espie 135: struct timespec mtime; /* Node's modification time */
136: GNode *youngest; /* Node's youngest child */
1.5 espie 137:
1.33 espie 138: GNode *impliedsrc; /* found by suff, to help with localvars */
1.5 espie 139: LIST cohorts; /* Other nodes for the :: operator */
140: LIST parents; /* Nodes that depend on this one */
141: LIST children; /* Nodes on which this one depends */
1.31 espie 142: LIST predecessors;
143: LIST successors;
1.5 espie 144:
1.33 espie 145: SymTable localvars;
1.5 espie 146: LIST commands; /* Creation commands */
1.23 espie 147: Suff *suffix; /* Suffix for the node (determined by
1.5 espie 148: * Suff_FindDeps and opaque to everyone
149: * but the Suff module) */
1.33 espie 150: GNode *groupling; /* target lists, for HELDBACK: do not build two
151: * at the same time */
152: GNode *watched; /* the node currently building for HELDBACK */
153:
154: /* stuff for target name equivalence: */
155: GNode *sibling; /* equivalent targets (not complete yet) */
1.14 espie 156: char *basename; /* pointer to name stripped of path */
1.23 espie 157: GNode *next;
1.33 espie 158:
159: bool in_cycle; /* cycle detection */
1.5 espie 160: char name[1]; /* The target's name */
1.20 espie 161: };
162:
163: struct command
164: {
165: Location location;
166: char string[1];
1.1 espie 167: };
168:
1.14 espie 169: #define has_been_built(gn) \
1.30 espie 170: ((gn)->built_status == REBUILT || (gn)->built_status == UPTODATE)
1.14 espie 171: #define should_have_file(gn) \
172: ((gn)->special == SPECIAL_NONE && \
173: ((gn)->type & (OP_PHONY | OP_DUMMY)) == 0)
1.1 espie 174: /*
175: * The OP_ constants are used when parsing a dependency line as a way of
176: * communicating to other parts of the program the way in which a target
177: * should be made. These constants are bitwise-OR'ed together and
178: * placed in the 'type' field of each node. Any node that has
179: * a 'type' field which satisfies the OP_NOP function was never never on
180: * the lefthand side of an operator, though it may have been on the
181: * righthand side...
182: */
1.34 espie 183: #define OP_ZERO 0x00000000 /* No dependency operator seen so far */
1.1 espie 184: #define OP_DEPENDS 0x00000001 /* Execution of commands depends on
185: * kids (:) */
186: #define OP_FORCE 0x00000002 /* Always execute commands (!) */
187: #define OP_DOUBLEDEP 0x00000004 /* Execution of commands depends on kids
188: * per line (::) */
1.34 espie 189: #define OP_ERROR 0x00000007
1.1 espie 190: #define OP_OPMASK (OP_DEPENDS|OP_FORCE|OP_DOUBLEDEP)
191:
192: #define OP_OPTIONAL 0x00000008 /* Don't care if the target doesn't
193: * exist and can't be created */
194: #define OP_USE 0x00000010 /* Use associated commands for parents */
195: #define OP_EXEC 0x00000020 /* Target is never out of date, but always
196: * execute commands anyway. Its time
197: * doesn't matter, so it has none...sort
198: * of */
199: #define OP_IGNORE 0x00000040 /* Ignore errors when creating the node */
200: #define OP_PRECIOUS 0x00000080 /* Don't remove the target when
201: * interrupted */
202: #define OP_SILENT 0x00000100 /* Don't echo commands when executed */
1.5 espie 203: #define OP_MAKE 0x00000200 /* Target is a recursive make so its
1.1 espie 204: * commands should always be executed when
205: * it is out of date, regardless of the
206: * state of the -n or -t flags */
207: #define OP_JOIN 0x00000400 /* Target is out-of-date only if any of its
208: * children was out-of-date */
209: #define OP_MADE 0x00000800 /* Assume the node is already made; even if
210: * it really is out of date */
1.14 espie 211: #define OP_INVISIBLE 0x00001000 /* The node is invisible to its parents.
1.1 espie 212: * I.e. it doesn't show up in the parents's
213: * local variables. */
1.14 espie 214: #define OP_NOTMAIN 0x00002000 /* The node is exempt from normal 'main
1.1 espie 215: * target' processing in parse.c */
1.14 espie 216: #define OP_PHONY 0x00004000 /* Not a file target; run always */
217: #define OP_NOPATH 0x00008000 /* Don't search for file in the path */
218: #define OP_NODEFAULT 0x00010000 /* Special node that never needs */
1.5 espie 219: /* DEFAULT commands applied */
1.14 espie 220: #define OP_DUMMY 0x00020000 /* node was created by default, but it */
1.5 espie 221: /* does not really exist. */
1.1 espie 222: /* Attributes applied by PMake */
1.14 espie 223: #define OP_TRANSFORM 0x00040000 /* The node is a transformation rule */
224: #define OP_MEMBER 0x00080000 /* Target is a member of an archive */
1.23 espie 225: #define OP_DOUBLE 0x00100000 /* normal op with double commands */
1.14 espie 226: #define OP_ARCHV 0x00200000 /* Target is an archive construct */
227: #define OP_HAS_COMMANDS 0x00400000 /* Target has all the commands it should.
1.1 espie 228: * Used when parsing to catch multiple
229: * commands for a target */
1.14 espie 230: #define OP_DEPS_FOUND 0x00800000 /* Already processed by Suff_FindDeps */
1.7 espie 231: #define OP_RESOLVED 0x01000000 /* We looked harder already */
1.19 espie 232: #define OP_CHEAP 0x02000000 /* Assume job is not recursive */
233: #define OP_EXPENSIVE 0x04000000 /* Recursive job, don't run in parallel */
1.1 espie 234:
235: /*
236: * OP_NOP will return true if the node with the given type was not the
237: * object of a dependency operator
238: */
1.34 espie 239: #define OP_NOP(t) (((t) & OP_OPMASK) == OP_ZERO)
1.1 espie 240:
241: #define OP_NOTARGET (OP_NOTMAIN|OP_USE|OP_EXEC|OP_TRANSFORM)
242:
243:
244: #endif