1 #ifndef GNODE_H 2 #define GNODE_H 3 /* $OpenPackages$ */ 4 /* $OpenBSD: gnode.h,v 1.14 2008/11/04 07:22:35 espie Exp $ */ 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 */ 70 71 #define UNKNOWN 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 88 struct GNode_ { 89 int special_op; /* special op to apply */ 90 unsigned char special;/* type of special node */ 91 char must_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 built_status; /* Set to reflect the state of processing 95 * on this node: 96 * UNKNOWN - Not examined yet 97 * BEINGMADE - Target is currently being made. 98 * MADE - Was out-of-date and has been made 99 * UPTODATE - Was already up-to-date 100 * ERROR - An error occurred while it was being 101 * made (used only in compat mode) 102 * ABORTED - The target was aborted due to 103 * an error making an inferior. 104 * CYCLE - Marked as potentially being part of 105 * a graph cycle. If we come back to a 106 * node marked this way, it is printed 107 * and 'built_status' is changed to ENDCYCLE. 108 * ENDCYCLE - the cycle has been completely 109 * printed. Go back and unmark all its 110 * members. 111 */ 112 char build_lock; /* for parallel build in siblings */ 113 char *path; /* The full pathname of the file */ 114 unsigned int type; /* Its type (see the OP flags, below) */ 115 int order; /* Its wait weight */ 116 117 int unmade; /* The number of unmade children */ 118 119 TIMESTAMP mtime; /* Its modification time */ 120 TIMESTAMP cmtime; /* The modification time of its youngest 121 * child */ 122 123 GNode *impliedsrc; 124 LIST cohorts; /* Other nodes for the :: operator */ 125 LIST parents; /* Nodes that depend on this one */ 126 LIST children; /* Nodes on which this one depends */ 127 LIST successors; /* Nodes that must be made after this one */ 128 LIST preds; /* Nodes that must be made before this one */ 129 130 SymTable context; /* The local variables */ 131 unsigned long lineno;/* First line number of commands. */ 132 const char *fname; /* File name of commands. */ 133 LIST commands; /* Creation commands */ 134 LIST expanded; /* Expanded commands */ 135 struct Suff_ *suffix;/* Suffix for the node (determined by 136 * Suff_FindDeps and opaque to everyone 137 * but the Suff module) */ 138 struct GNode_ *sibling; /* equivalent targets */ 139 /* stuff for target name equivalence */ 140 char *basename; /* pointer to name stripped of path */ 141 struct GNode_ *next; 142 char name[1]; /* The target's name */ 143 }; 144 145 #define has_been_built(gn) \ 146 ((gn)->built_status == MADE || (gn)->built_status == UPTODATE) 147 #define should_have_file(gn) \ 148 ((gn)->special == SPECIAL_NONE && \ 149 ((gn)->type & (OP_PHONY | OP_DUMMY)) == 0) 150 /* 151 * The OP_ constants are used when parsing a dependency line as a way of 152 * communicating to other parts of the program the way in which a target 153 * should be made. These constants are bitwise-OR'ed together and 154 * placed in the 'type' field of each node. Any node that has 155 * a 'type' field which satisfies the OP_NOP function was never never on 156 * the lefthand side of an operator, though it may have been on the 157 * righthand side... 158 */ 159 #define OP_DEPENDS 0x00000001 /* Execution of commands depends on 160 * kids (:) */ 161 #define OP_FORCE 0x00000002 /* Always execute commands (!) */ 162 #define OP_DOUBLEDEP 0x00000004 /* Execution of commands depends on kids 163 * per line (::) */ 164 #define OP_ERROR 0x00000000 165 #define OP_OPMASK (OP_DEPENDS|OP_FORCE|OP_DOUBLEDEP) 166 167 #define OP_OPTIONAL 0x00000008 /* Don't care if the target doesn't 168 * exist and can't be created */ 169 #define OP_USE 0x00000010 /* Use associated commands for parents */ 170 #define OP_EXEC 0x00000020 /* Target is never out of date, but always 171 * execute commands anyway. Its time 172 * doesn't matter, so it has none...sort 173 * of */ 174 #define OP_IGNORE 0x00000040 /* Ignore errors when creating the node */ 175 #define OP_PRECIOUS 0x00000080 /* Don't remove the target when 176 * interrupted */ 177 #define OP_SILENT 0x00000100 /* Don't echo commands when executed */ 178 #define OP_MAKE 0x00000200 /* Target is a recursive make so its 179 * commands should always be executed when 180 * it is out of date, regardless of the 181 * state of the -n or -t flags */ 182 #define OP_JOIN 0x00000400 /* Target is out-of-date only if any of its 183 * children was out-of-date */ 184 #define OP_MADE 0x00000800 /* Assume the node is already made; even if 185 * it really is out of date */ 186 #define OP_INVISIBLE 0x00001000 /* The node is invisible to its parents. 187 * I.e. it doesn't show up in the parents's 188 * local variables. */ 189 #define OP_NOTMAIN 0x00002000 /* The node is exempt from normal 'main 190 * target' processing in parse.c */ 191 #define OP_PHONY 0x00004000 /* Not a file target; run always */ 192 #define OP_NOPATH 0x00008000 /* Don't search for file in the path */ 193 #define OP_NODEFAULT 0x00010000 /* Special node that never needs */ 194 /* DEFAULT commands applied */ 195 #define OP_DUMMY 0x00020000 /* node was created by default, but it */ 196 /* does not really exist. */ 197 /* Attributes applied by PMake */ 198 #define OP_TRANSFORM 0x00040000 /* The node is a transformation rule */ 199 #define OP_MEMBER 0x00080000 /* Target is a member of an archive */ 200 #define OP_LIB 0x00100000 /* Target is a library */ 201 #define OP_ARCHV 0x00200000 /* Target is an archive construct */ 202 #define OP_HAS_COMMANDS 0x00400000 /* Target has all the commands it should. 203 * Used when parsing to catch multiple 204 * commands for a target */ 205 #define OP_DEPS_FOUND 0x00800000 /* Already processed by Suff_FindDeps */ 206 #define OP_RESOLVED 0x01000000 /* We looked harder already */ 207 208 /* 209 * OP_NOP will return true if the node with the given type was not the 210 * object of a dependency operator 211 */ 212 #define OP_NOP(t) (((t) & OP_OPMASK) == 0x00000000) 213 214 #define OP_NOTARGET (OP_NOTMAIN|OP_USE|OP_EXEC|OP_TRANSFORM) 215 216 217 #endif 218