Annotation of src/usr.bin/make/gnode.h, Revision 1.33
1.1 espie 1: #ifndef GNODE_H
2: #define GNODE_H
1.33 ! espie 3: /* $OpenBSD: gnode.h,v 1.32 2019/12/21 15:29:59 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.33 ! espie 68: #define SPECIAL_NONE 0U
1.15 espie 69: #define SPECIAL_PATH 21U
70: #define SPECIAL_MASK 63U
71: #define SPECIAL_TARGET 64U
72: #define SPECIAL_SOURCE 128U
1.5 espie 73: #define SPECIAL_TARGETSOURCE (SPECIAL_TARGET|SPECIAL_SOURCE)
74:
1.21 espie 75: #define SPECIAL_EXEC 4U
76: #define SPECIAL_IGNORE 5U
1.23 espie 77: #define SPECIAL_NOTHING 6U
1.21 espie 78: #define SPECIAL_INVISIBLE 8U
79: #define SPECIAL_JOIN 9U
80: #define SPECIAL_MADE 11U
81: #define SPECIAL_MAIN 12U
82: #define SPECIAL_MAKE 13U
83: #define SPECIAL_MFLAGS 14U
84: #define SPECIAL_NOTMAIN 15U
85: #define SPECIAL_NOTPARALLEL 16U
86: #define SPECIAL_OPTIONAL 18U
87: #define SPECIAL_ORDER 19U
88: #define SPECIAL_PARALLEL 20U
89: #define SPECIAL_PHONY 22U
90: #define SPECIAL_PRECIOUS 23U
91: #define SPECIAL_SILENT 25U
92: #define SPECIAL_SUFFIXES 27U
93: #define SPECIAL_USE 28U
94: #define SPECIAL_WAIT 29U
95: #define SPECIAL_NOPATH 30U
96: #define SPECIAL_ERROR 31U
97: #define SPECIAL_CHEAP 32U
98: #define SPECIAL_EXPENSIVE 33U
99:
1.1 espie 100: struct GNode_ {
1.33 ! espie 101: unsigned int type; /* node type (see the OP flags, below) */
! 102: unsigned int special_op; /* special op to apply (only used in parse.c) */
! 103: unsigned char special; /* type of special node or SPECIAL_NONE */
1.32 espie 104: bool must_make; /* true if this target needs building */
105: bool child_rebuilt; /* true if at least one child was rebuilt,
1.31 espie 106: * thus triggering timestamps changes */
107:
108: char built_status;
109: #define UNKNOWN 0 /* Not examined yet */
110: #define BUILDING 1 /* In the process of building */
111: #define REBUILT 2 /* Was out of date and got rebuilt */
112: #define UPTODATE 3 /* Was already up-to-date */
113: #define ERROR 4 /* Error occurred while building
114: * (used only in compat mode) */
115: #define ABORTED 5 /* Was aborted due to an error
116: * making an inferior */
117: #define NOSUCHNODE 6 /* error from run_gnode */
118: #define HELDBACK 7 /* Another target in the same group is
1.33 ! espie 119: * currently building, avoid race conditions
! 120: * Only used in the parallel engine make.c */
1.31 espie 121:
1.33 ! espie 122: char *path; /* full pathname of the file */
! 123: int order; /* wait weight (see .ORDER/predecessors/successors) */
1.5 espie 124:
1.33 ! espie 125: int children_left; /* number of children left to build */
1.5 espie 126:
1.31 espie 127: struct timespec mtime; /* Node's modification time */
128: GNode *youngest; /* Node's youngest child */
1.5 espie 129:
1.33 ! espie 130: GNode *impliedsrc; /* found by suff, to help with localvars */
1.5 espie 131: LIST cohorts; /* Other nodes for the :: operator */
132: LIST parents; /* Nodes that depend on this one */
133: LIST children; /* Nodes on which this one depends */
1.31 espie 134: LIST predecessors;
135: LIST successors;
1.5 espie 136:
1.33 ! espie 137: SymTable localvars;
1.5 espie 138: LIST commands; /* Creation commands */
1.23 espie 139: Suff *suffix; /* Suffix for the node (determined by
1.5 espie 140: * Suff_FindDeps and opaque to everyone
141: * but the Suff module) */
1.33 ! espie 142: GNode *groupling; /* target lists, for HELDBACK: do not build two
! 143: * at the same time */
! 144: GNode *watched; /* the node currently building for HELDBACK */
! 145:
! 146: /* stuff for target name equivalence: */
! 147: GNode *sibling; /* equivalent targets (not complete yet) */
1.14 espie 148: char *basename; /* pointer to name stripped of path */
1.23 espie 149: GNode *next;
1.33 ! espie 150:
! 151: bool in_cycle; /* cycle detection */
1.5 espie 152: char name[1]; /* The target's name */
1.20 espie 153: };
154:
155: struct command
156: {
157: Location location;
158: char string[1];
1.1 espie 159: };
160:
1.14 espie 161: #define has_been_built(gn) \
1.30 espie 162: ((gn)->built_status == REBUILT || (gn)->built_status == UPTODATE)
1.14 espie 163: #define should_have_file(gn) \
164: ((gn)->special == SPECIAL_NONE && \
165: ((gn)->type & (OP_PHONY | OP_DUMMY)) == 0)
1.1 espie 166: /*
167: * The OP_ constants are used when parsing a dependency line as a way of
168: * communicating to other parts of the program the way in which a target
169: * should be made. These constants are bitwise-OR'ed together and
170: * placed in the 'type' field of each node. Any node that has
171: * a 'type' field which satisfies the OP_NOP function was never never on
172: * the lefthand side of an operator, though it may have been on the
173: * righthand side...
174: */
175: #define OP_DEPENDS 0x00000001 /* Execution of commands depends on
176: * kids (:) */
177: #define OP_FORCE 0x00000002 /* Always execute commands (!) */
178: #define OP_DOUBLEDEP 0x00000004 /* Execution of commands depends on kids
179: * per line (::) */
1.6 espie 180: #define OP_ERROR 0x00000000
1.1 espie 181: #define OP_OPMASK (OP_DEPENDS|OP_FORCE|OP_DOUBLEDEP)
182:
183: #define OP_OPTIONAL 0x00000008 /* Don't care if the target doesn't
184: * exist and can't be created */
185: #define OP_USE 0x00000010 /* Use associated commands for parents */
186: #define OP_EXEC 0x00000020 /* Target is never out of date, but always
187: * execute commands anyway. Its time
188: * doesn't matter, so it has none...sort
189: * of */
190: #define OP_IGNORE 0x00000040 /* Ignore errors when creating the node */
191: #define OP_PRECIOUS 0x00000080 /* Don't remove the target when
192: * interrupted */
193: #define OP_SILENT 0x00000100 /* Don't echo commands when executed */
1.5 espie 194: #define OP_MAKE 0x00000200 /* Target is a recursive make so its
1.1 espie 195: * commands should always be executed when
196: * it is out of date, regardless of the
197: * state of the -n or -t flags */
198: #define OP_JOIN 0x00000400 /* Target is out-of-date only if any of its
199: * children was out-of-date */
200: #define OP_MADE 0x00000800 /* Assume the node is already made; even if
201: * it really is out of date */
1.14 espie 202: #define OP_INVISIBLE 0x00001000 /* The node is invisible to its parents.
1.1 espie 203: * I.e. it doesn't show up in the parents's
204: * local variables. */
1.14 espie 205: #define OP_NOTMAIN 0x00002000 /* The node is exempt from normal 'main
1.1 espie 206: * target' processing in parse.c */
1.14 espie 207: #define OP_PHONY 0x00004000 /* Not a file target; run always */
208: #define OP_NOPATH 0x00008000 /* Don't search for file in the path */
209: #define OP_NODEFAULT 0x00010000 /* Special node that never needs */
1.5 espie 210: /* DEFAULT commands applied */
1.14 espie 211: #define OP_DUMMY 0x00020000 /* node was created by default, but it */
1.5 espie 212: /* does not really exist. */
1.1 espie 213: /* Attributes applied by PMake */
1.14 espie 214: #define OP_TRANSFORM 0x00040000 /* The node is a transformation rule */
215: #define OP_MEMBER 0x00080000 /* Target is a member of an archive */
1.23 espie 216: #define OP_DOUBLE 0x00100000 /* normal op with double commands */
1.14 espie 217: #define OP_ARCHV 0x00200000 /* Target is an archive construct */
218: #define OP_HAS_COMMANDS 0x00400000 /* Target has all the commands it should.
1.1 espie 219: * Used when parsing to catch multiple
220: * commands for a target */
1.14 espie 221: #define OP_DEPS_FOUND 0x00800000 /* Already processed by Suff_FindDeps */
1.7 espie 222: #define OP_RESOLVED 0x01000000 /* We looked harder already */
1.19 espie 223: #define OP_CHEAP 0x02000000 /* Assume job is not recursive */
224: #define OP_EXPENSIVE 0x04000000 /* Recursive job, don't run in parallel */
1.1 espie 225:
226: /*
227: * OP_NOP will return true if the node with the given type was not the
228: * object of a dependency operator
229: */
230: #define OP_NOP(t) (((t) & OP_OPMASK) == 0x00000000)
231:
232: #define OP_NOTARGET (OP_NOTMAIN|OP_USE|OP_EXEC|OP_TRANSFORM)
233:
234:
235: #endif
![[BACK]](/icons/back.gif){kind=icon}
Return to gnode.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / make