1 #ifndef GNODE_H 2 #define GNODE_H 3 /* $OpenBSD: gnode.h,v 1.19 2012/04/11 18:27:30 espie Exp $ */ 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 30 #ifndef TIMESTAMP_TYPE 31 #include "timestamp_t.h" 32 #endif 33 #ifndef LIST_TYPE 34 #include "lst_t.h" 35 #endif 36 #ifndef LOCATION_TYPE 37 #include "location.h" 38 #endif 39 #ifndef SYMTABLE_H 40 #include "symtable.h" 41 #endif 42 43 struct Suff_; 44 /*- 45 * The structure for an individual graph node. Each node has several 46 * pieces of data associated with it. 47 * 1) the name of the target it describes 48 * 2) the location of the target file in the file system. 49 * 3) the type of operator used to define its sources (qv. parse.c) 50 * 4) whether it is involved in this invocation of make 51 * 5) whether the target has been remade 52 * 6) whether any of its children has been remade 53 * 7) the number of its children that are, as yet, unmade 54 * 8) its modification time 55 * 9) the modification time of its youngest child (qv. make.c) 56 * 10) a list of nodes for which this is a source 57 * 11) a list of nodes on which this depends 58 * 12) a list of nodes that depend on this, as gleaned from the 59 * transformation rules. 60 * 13) a list of nodes of the same name created by the :: operator 61 * 14) a list of nodes that must be made (if they're made) before 62 * this node can be, but that do no enter into the datedness of 63 * this node. 64 * 15) a list of nodes that must be made (if they're made) after 65 * this node is, but that do not depend on this node, in the 66 * normal sense. 67 * 16) a Lst of ``local'' variables that are specific to this target 68 * and this target only (qv. var.c [$@ $< $?, etc.]) 69 * 17) a Lst of strings that are commands to be given to a shell 70 * to create this target. 71 */ 72 73 #define UNKNOWN 0 74 #define BEINGMADE 1 75 #define MADE 2 76 #define UPTODATE 3 77 #define ERROR 4 78 #define ABORTED 5 79 #define CYCLE 6 80 #define ENDCYCLE 7 81 #define NOSUCHNODE 8 82 83 #define SPECIAL_NONE 0U 84 #define SPECIAL_PATH 21U 85 #define SPECIAL_MASK 63U 86 #define SPECIAL_TARGET 64U 87 #define SPECIAL_SOURCE 128U 88 #define SPECIAL_TARGETSOURCE (SPECIAL_TARGET|SPECIAL_SOURCE) 89 90 struct GNode_ { 91 unsigned int special_op; /* special op to apply */ 92 unsigned char special;/* type of special node */ 93 char must_make; /* true if this target needs to be remade */ 94 char childMade; /* true if one of this target's children was 95 * made */ 96 char built_status; /* Set to reflect the state of processing 97 * on this node: 98 * UNKNOWN - Not examined yet 99 * BEINGMADE - Target is currently being made. 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. 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 'built_status' is changed to ENDCYCLE. 110 * ENDCYCLE - the cycle has been completely 111 * printed. Go back and unmark all its 112 * members. 113 */ 114 char build_lock; /* for parallel build in siblings */ 115 char *path; /* The full pathname of the file */ 116 unsigned int type; /* Its type (see the OP flags, below) */ 117 int order; /* Its wait weight */ 118 119 int unmade; /* The number of unmade children */ 120 121 TIMESTAMP mtime; /* Its modification time */ 122 TIMESTAMP cmtime; /* The modification time of its youngest 123 * child */ 124 125 GNode *impliedsrc; 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 Location origin; /* First line number and file name of commands. */ 134 LIST commands; /* Creation commands */ 135 LIST expanded; /* Expanded commands */ 136 struct Suff_ *suffix;/* Suffix for the node (determined by 137 * Suff_FindDeps and opaque to everyone 138 * but the Suff module) */ 139 struct GNode_ *sibling; /* equivalent targets */ 140 /* stuff for target name equivalence */ 141 char *basename; /* pointer to name stripped of path */ 142 struct GNode_ *next; 143 char name[1]; /* The target's name */ 144 }; 145 146 #define has_been_built(gn) \ 147 ((gn)->built_status == MADE || (gn)->built_status == UPTODATE) 148 #define should_have_file(gn) \ 149 ((gn)->special == SPECIAL_NONE && \ 150 ((gn)->type & (OP_PHONY | OP_DUMMY)) == 0) 151 /* 152 * The OP_ constants are used when parsing a dependency line as a way of 153 * communicating to other parts of the program the way in which a target 154 * should be made. These constants are bitwise-OR'ed together and 155 * placed in the 'type' field of each node. Any node that has 156 * a 'type' field which satisfies the OP_NOP function was never never on 157 * the lefthand side of an operator, though it may have been on the 158 * righthand side... 159 */ 160 #define OP_DEPENDS 0x00000001 /* Execution of commands depends on 161 * kids (:) */ 162 #define OP_FORCE 0x00000002 /* Always execute commands (!) */ 163 #define OP_DOUBLEDEP 0x00000004 /* Execution of commands depends on kids 164 * per line (::) */ 165 #define OP_ERROR 0x00000000 166 #define OP_OPMASK (OP_DEPENDS|OP_FORCE|OP_DOUBLEDEP) 167 168 #define OP_OPTIONAL 0x00000008 /* Don't care if the target doesn't 169 * exist and can't be created */ 170 #define OP_USE 0x00000010 /* Use associated commands for parents */ 171 #define OP_EXEC 0x00000020 /* Target is never out of date, but always 172 * execute commands anyway. Its time 173 * doesn't matter, so it has none...sort 174 * of */ 175 #define OP_IGNORE 0x00000040 /* Ignore errors when creating the node */ 176 #define OP_PRECIOUS 0x00000080 /* Don't remove the target when 177 * interrupted */ 178 #define OP_SILENT 0x00000100 /* Don't echo commands when executed */ 179 #define OP_MAKE 0x00000200 /* Target is a recursive make so its 180 * commands should always be executed when 181 * it is out of date, regardless of the 182 * state of the -n or -t flags */ 183 #define OP_JOIN 0x00000400 /* Target is out-of-date only if any of its 184 * children was out-of-date */ 185 #define OP_MADE 0x00000800 /* Assume the node is already made; even if 186 * it really is out of date */ 187 #define OP_INVISIBLE 0x00001000 /* The node is invisible to its parents. 188 * I.e. it doesn't show up in the parents's 189 * local variables. */ 190 #define OP_NOTMAIN 0x00002000 /* The node is exempt from normal 'main 191 * target' processing in parse.c */ 192 #define OP_PHONY 0x00004000 /* Not a file target; run always */ 193 #define OP_NOPATH 0x00008000 /* Don't search for file in the path */ 194 #define OP_NODEFAULT 0x00010000 /* Special node that never needs */ 195 /* DEFAULT commands applied */ 196 #define OP_DUMMY 0x00020000 /* node was created by default, but it */ 197 /* does not really exist. */ 198 /* Attributes applied by PMake */ 199 #define OP_TRANSFORM 0x00040000 /* The node is a transformation rule */ 200 #define OP_MEMBER 0x00080000 /* Target is a member of an archive */ 201 #define OP_LIB 0x00100000 /* Target is a library */ 202 #define OP_ARCHV 0x00200000 /* Target is an archive construct */ 203 #define OP_HAS_COMMANDS 0x00400000 /* Target has all the commands it should. 204 * Used when parsing to catch multiple 205 * commands for a target */ 206 #define OP_DEPS_FOUND 0x00800000 /* Already processed by Suff_FindDeps */ 207 #define OP_RESOLVED 0x01000000 /* We looked harder already */ 208 #define OP_CHEAP 0x02000000 /* Assume job is not recursive */ 209 #define OP_EXPENSIVE 0x04000000 /* Recursive job, don't run in parallel */ 210 211 /* 212 * OP_NOP will return true if the node with the given type was not the 213 * object of a dependency operator 214 */ 215 #define OP_NOP(t) (((t) & OP_OPMASK) == 0x00000000) 216 217 #define OP_NOTARGET (OP_NOTMAIN|OP_USE|OP_EXEC|OP_TRANSFORM) 218 219 220 #endif 221