1 /* 2 * Copyright (c) 1988, 1989, 1990, 1993 3 * The Regents of the University of California. All rights reserved. 4 * Copyright (c) 1989 by Berkeley Softworks 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to Berkeley by 8 * Adam de Boor. 9 * 10 * %sccs.include.redist.c% 11 * 12 * @(#)make.h 8.1 (Berkeley) 06/06/93 13 */ 14 15 /*- 16 * make.h -- 17 * The global definitions for pmake 18 */ 19 20 #ifndef _MAKE_H_ 21 #define _MAKE_H_ 22 23 #include <sys/types.h> 24 #include <stdio.h> 25 #include <string.h> 26 #include <ctype.h> 27 #include <sys/cdefs.h> 28 #if __STDC__ 29 #include <stdlib.h> 30 #include <unistd.h> 31 #endif 32 #include "sprite.h" 33 #include "lst.h" 34 #include "config.h" 35 #include "buf.h" 36 37 /*- 38 * The structure for an individual graph node. Each node has several 39 * pieces of data associated with it. 40 * 1) the name of the target it describes 41 * 2) the location of the target file in the file system. 42 * 3) the type of operator used to define its sources (qv. parse.c) 43 * 4) whether it is involved in this invocation of make 44 * 5) whether the target has been remade 45 * 6) whether any of its children has been remade 46 * 7) the number of its children that are, as yet, unmade 47 * 8) its modification time 48 * 9) the modification time of its youngest child (qv. make.c) 49 * 10) a list of nodes for which this is a source 50 * 11) a list of nodes on which this depends 51 * 12) a list of nodes that depend on this, as gleaned from the 52 * transformation rules. 53 * 13) a list of nodes of the same name created by the :: operator 54 * 14) a list of nodes that must be made (if they're made) before 55 * this node can be, but that do no enter into the datedness of 56 * this node. 57 * 15) a list of nodes that must be made (if they're made) after 58 * this node is, but that do not depend on this node, in the 59 * normal sense. 60 * 16) a Lst of ``local'' variables that are specific to this target 61 * and this target only (qv. var.c [$@ $< $?, etc.]) 62 * 17) a Lst of strings that are commands to be given to a shell 63 * to create this target. 64 */ 65 typedef struct GNode { 66 char *name; /* The target's name */ 67 char *path; /* The full pathname of the file */ 68 int type; /* Its type (see the OP flags, below) */ 69 70 Boolean make; /* TRUE if this target needs to be remade */ 71 enum { 72 UNMADE, BEINGMADE, MADE, UPTODATE, ERROR, ABORTED, 73 CYCLE, ENDCYCLE, 74 } made; /* Set to reflect the state of processing 75 * on this node: 76 * UNMADE - Not examined yet 77 * BEINGMADE - Target is already being made. 78 * Indicates a cycle in the graph. (compat 79 * mode only) 80 * MADE - Was out-of-date and has been made 81 * UPTODATE - Was already up-to-date 82 * ERROR - An error occured while it was being 83 * made (used only in compat mode) 84 * ABORTED - The target was aborted due to 85 * an error making an inferior (compat). 86 * CYCLE - Marked as potentially being part of 87 * a graph cycle. If we come back to a 88 * node marked this way, it is printed 89 * and 'made' is changed to ENDCYCLE. 90 * ENDCYCLE - the cycle has been completely 91 * printed. Go back and unmark all its 92 * members. 93 */ 94 Boolean childMade; /* TRUE if one of this target's children was 95 * made */ 96 int unmade; /* The number of unmade children */ 97 98 int mtime; /* Its modification time */ 99 int cmtime; /* The modification time of its youngest 100 * child */ 101 102 Lst iParents; /* Links to parents for which this is an 103 * implied source, if any */ 104 Lst cohorts; /* Other nodes for the :: operator */ 105 Lst parents; /* Nodes that depend on this one */ 106 Lst children; /* Nodes on which this one depends */ 107 Lst successors; /* Nodes that must be made after this one */ 108 Lst preds; /* Nodes that must be made before this one */ 109 110 Lst context; /* The local variables */ 111 Lst commands; /* Creation commands */ 112 113 struct _Suff *suffix; /* Suffix for the node (determined by 114 * Suff_FindDeps and opaque to everyone 115 * but the Suff module) */ 116 } GNode; 117 118 /* 119 * Manifest constants 120 */ 121 #define NILGNODE ((GNode *) NIL) 122 123 /* 124 * The OP_ constants are used when parsing a dependency line as a way of 125 * communicating to other parts of the program the way in which a target 126 * should be made. These constants are bitwise-OR'ed together and 127 * placed in the 'type' field of each node. Any node that has 128 * a 'type' field which satisfies the OP_NOP function was never never on 129 * the lefthand side of an operator, though it may have been on the 130 * righthand side... 131 */ 132 #define OP_DEPENDS 0x00000001 /* Execution of commands depends on 133 * kids (:) */ 134 #define OP_FORCE 0x00000002 /* Always execute commands (!) */ 135 #define OP_DOUBLEDEP 0x00000004 /* Execution of commands depends on kids 136 * per line (::) */ 137 #define OP_OPMASK (OP_DEPENDS|OP_FORCE|OP_DOUBLEDEP) 138 139 #define OP_OPTIONAL 0x00000008 /* Don't care if the target doesn't 140 * exist and can't be created */ 141 #define OP_USE 0x00000010 /* Use associated commands for parents */ 142 #define OP_EXEC 0x00000020 /* Target is never out of date, but always 143 * execute commands anyway. Its time 144 * doesn't matter, so it has none...sort 145 * of */ 146 #define OP_IGNORE 0x00000040 /* Ignore errors when creating the node */ 147 #define OP_PRECIOUS 0x00000080 /* Don't remove the target when 148 * interrupted */ 149 #define OP_SILENT 0x00000100 /* Don't echo commands when executed */ 150 #define OP_MAKE 0x00000200 /* Target is a recurrsive make so its 151 * commands should always be executed when 152 * it is out of date, regardless of the 153 * state of the -n or -t flags */ 154 #define OP_JOIN 0x00000400 /* Target is out-of-date only if any of its 155 * children was out-of-date */ 156 #define OP_INVISIBLE 0x00004000 /* The node is invisible to its parents. 157 * I.e. it doesn't show up in the parents's 158 * local variables. */ 159 #define OP_NOTMAIN 0x00008000 /* The node is exempt from normal 'main 160 * target' processing in parse.c */ 161 /* Attributes applied by PMake */ 162 #define OP_TRANSFORM 0x80000000 /* The node is a transformation rule */ 163 #define OP_MEMBER 0x40000000 /* Target is a member of an archive */ 164 #define OP_LIB 0x20000000 /* Target is a library */ 165 #define OP_ARCHV 0x10000000 /* Target is an archive construct */ 166 #define OP_HAS_COMMANDS 0x08000000 /* Target has all the commands it should. 167 * Used when parsing to catch multiple 168 * commands for a target */ 169 #define OP_SAVE_CMDS 0x04000000 /* Saving commands on .END (Compat) */ 170 #define OP_DEPS_FOUND 0x02000000 /* Already processed by Suff_FindDeps */ 171 172 /* 173 * OP_NOP will return TRUE if the node with the given type was not the 174 * object of a dependency operator 175 */ 176 #define OP_NOP(t) (((t) & OP_OPMASK) == 0x00000000) 177 178 /* 179 * The TARG_ constants are used when calling the Targ_FindNode and 180 * Targ_FindList functions in targ.c. They simply tell the functions what to 181 * do if the desired node(s) is (are) not found. If the TARG_CREATE constant 182 * is given, a new, empty node will be created for the target, placed in the 183 * table of all targets and its address returned. If TARG_NOCREATE is given, 184 * a NIL pointer will be returned. 185 */ 186 #define TARG_CREATE 0x01 /* create node if not found */ 187 #define TARG_NOCREATE 0x00 /* don't create it */ 188 189 /* 190 * There are several places where expandable buffers are used (parse.c and 191 * var.c). This constant is merely the starting point for those buffers. If 192 * lines tend to be much shorter than this, it would be best to reduce BSIZE. 193 * If longer, it should be increased. Reducing it will cause more copying to 194 * be done for longer lines, but will save space for shorter ones. In any 195 * case, it ought to be a power of two simply because most storage allocation 196 * schemes allocate in powers of two. 197 */ 198 #define MAKE_BSIZE 256 /* starting size for expandable buffers */ 199 200 /* 201 * These constants are all used by the Str_Concat function to decide how the 202 * final string should look. If STR_ADDSPACE is given, a space will be 203 * placed between the two strings. If STR_ADDSLASH is given, a '/' will 204 * be used instead of a space. If neither is given, no intervening characters 205 * will be placed between the two strings in the final output. If the 206 * STR_DOFREE bit is set, the two input strings will be freed before 207 * Str_Concat returns. 208 */ 209 #define STR_ADDSPACE 0x01 /* add a space when Str_Concat'ing */ 210 #define STR_DOFREE 0x02 /* free source strings after concatenation */ 211 #define STR_ADDSLASH 0x04 /* add a slash when Str_Concat'ing */ 212 213 /* 214 * Error levels for parsing. PARSE_FATAL means the process cannot continue 215 * once the makefile has been parsed. PARSE_WARNING means it can. Passed 216 * as the first argument to Parse_Error. 217 */ 218 #define PARSE_WARNING 2 219 #define PARSE_FATAL 1 220 221 /* 222 * Values returned by Cond_Eval. 223 */ 224 #define COND_PARSE 0 /* Parse the next lines */ 225 #define COND_SKIP 1 /* Skip the next lines */ 226 #define COND_INVALID 2 /* Not a conditional statement */ 227 228 /* 229 * Definitions for the "local" variables. Used only for clarity. 230 */ 231 #define TARGET "@" /* Target of dependency */ 232 #define OODATE "?" /* All out-of-date sources */ 233 #define ALLSRC ">" /* All sources */ 234 #define IMPSRC "<" /* Source implied by transformation */ 235 #define PREFIX "*" /* Common prefix */ 236 #define ARCHIVE "!" /* Archive in "archive(member)" syntax */ 237 #define MEMBER "%" /* Member in "archive(member)" syntax */ 238 239 #define FTARGET "@F" /* file part of TARGET */ 240 #define DTARGET "@D" /* directory part of TARGET */ 241 #define FIMPSRC "<F" /* file part of IMPSRC */ 242 #define DIMPSRC "<D" /* directory part of IMPSRC */ 243 #define FPREFIX "*F" /* file part of PREFIX */ 244 #define DPREFIX "*D" /* directory part of PREFIX */ 245 246 /* 247 * Global Variables 248 */ 249 extern Lst create; /* The list of target names specified on the 250 * command line. used to resolve #if 251 * make(...) statements */ 252 extern Lst dirSearchPath; /* The list of directories to search when 253 * looking for targets */ 254 255 extern Boolean compatMake; /* True if we are make compatible */ 256 extern Boolean ignoreErrors; /* True if should ignore all errors */ 257 extern Boolean beSilent; /* True if should print no commands */ 258 extern Boolean noExecute; /* True if should execute nothing */ 259 extern Boolean allPrecious; /* True if every target is precious */ 260 extern Boolean keepgoing; /* True if should continue on unaffected 261 * portions of the graph when have an error 262 * in one portion */ 263 extern Boolean touchFlag; /* TRUE if targets should just be 'touched' 264 * if out of date. Set by the -t flag */ 265 extern Boolean usePipes; /* TRUE if should capture the output of 266 * subshells by means of pipes. Otherwise it 267 * is routed to temporary files from which it 268 * is retrieved when the shell exits */ 269 extern Boolean queryFlag; /* TRUE if we aren't supposed to really make 270 * anything, just see if the targets are out- 271 * of-date */ 272 273 extern Boolean checkEnvFirst; /* TRUE if environment should be searched for 274 * variables before the global context */ 275 276 extern GNode *DEFAULT; /* .DEFAULT rule */ 277 278 extern GNode *VAR_GLOBAL; /* Variables defined in a global context, e.g 279 * in the Makefile itself */ 280 extern GNode *VAR_CMD; /* Variables defined on the command line */ 281 extern char var_Error[]; /* Value returned by Var_Parse when an error 282 * is encountered. It actually points to 283 * an empty string, so naive callers needn't 284 * worry about it. */ 285 286 extern time_t now; /* The time at the start of this whole 287 * process */ 288 289 extern Boolean oldVars; /* Do old-style variable substitution */ 290 291 /* 292 * debug control: 293 * There is one bit per module. It is up to the module what debug 294 * information to print. 295 */ 296 extern int debug; 297 #define DEBUG_ARCH 0x0001 298 #define DEBUG_COND 0x0002 299 #define DEBUG_DIR 0x0004 300 #define DEBUG_GRAPH1 0x0008 301 #define DEBUG_GRAPH2 0x0010 302 #define DEBUG_JOB 0x0020 303 #define DEBUG_MAKE 0x0040 304 #define DEBUG_SUFF 0x0080 305 #define DEBUG_TARG 0x0100 306 #define DEBUG_VAR 0x0200 307 #define DEBUG_FOR 0x0400 308 309 #ifdef __STDC__ 310 #define CONCAT(a,b) a##b 311 #else 312 #define I(a) a 313 #define CONCAT(a,b) I(a)b 314 #endif /* __STDC__ */ 315 316 #define DEBUG(module) (debug & CONCAT(DEBUG_,module)) 317 318 /* 319 * Since there are so many, all functions that return non-integer values are 320 * extracted by means of a sed script or two and stuck in the file "nonints.h" 321 */ 322 #include "nonints.h" 323 324 void Make_DoAllVar __P((GNode *)); 325 int Make_HandleUse __P((GNode *, GNode *)); 326 Boolean Make_OODate __P((GNode *)); 327 Boolean Make_Run __P((Lst)); 328 int Make_TimeStamp __P((GNode *, GNode *)); 329 void Make_Update __P((GNode *)); 330 331 #endif /* _MAKE_H_ */ 332