1 /* $NetBSD: make.h,v 1.36 2001/07/03 18:08:51 christos Exp $ */ 2 3 /* 4 * Copyright (c) 1988, 1989, 1990, 1993 5 * The Regents of the University of California. All rights reserved. 6 * Copyright (c) 1989 by Berkeley Softworks 7 * All rights reserved. 8 * 9 * This code is derived from software contributed to Berkeley by 10 * Adam de Boor. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 3. All advertising materials mentioning features or use of this software 21 * must display the following acknowledgement: 22 * This product includes software developed by the University of 23 * California, Berkeley and its contributors. 24 * 4. Neither the name of the University nor the names of its contributors 25 * may be used to endorse or promote products derived from this software 26 * without specific prior written permission. 27 * 28 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 29 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 30 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 31 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 32 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 36 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 37 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 38 * SUCH DAMAGE. 39 * 40 * from: @(#)make.h 8.3 (Berkeley) 6/13/95 41 */ 42 43 /*- 44 * make.h -- 45 * The global definitions for pmake 46 */ 47 48 #ifndef _MAKE_H_ 49 #define _MAKE_H_ 50 51 #include <sys/types.h> 52 #include <sys/param.h> 53 #include <stdio.h> 54 #include <string.h> 55 #include <ctype.h> 56 57 #ifdef BSD4_4 58 # include <sys/cdefs.h> 59 #else 60 # ifndef __P 61 # if defined(__STDC__) || defined(__cplusplus) 62 # define __P(protos) protos /* full-blown ANSI C */ 63 # else 64 # define __P(protos) () /* traditional C preprocessor */ 65 # endif 66 # endif 67 # ifndef __GNUC__ 68 # ifndef __inline 69 # define __inline 70 # endif 71 # endif 72 # ifndef __STDC__ 73 # ifndef const 74 # define const 75 # endif 76 # ifndef volatile 77 # define volatile 78 # endif 79 # endif 80 #endif 81 82 #if __STDC__ 83 #include <stdlib.h> 84 #include <unistd.h> 85 #endif 86 #include "sprite.h" 87 #include "lst.h" 88 #include "hash.h" 89 #include "config.h" 90 #include "buf.h" 91 92 /*- 93 * The structure for an individual graph node. Each node has several 94 * pieces of data associated with it. 95 * 1) the name of the target it describes 96 * 2) the location of the target file in the file system. 97 * 3) the type of operator used to define its sources (qv. parse.c) 98 * 4) whether it is involved in this invocation of make 99 * 5) whether the target has been remade 100 * 6) whether any of its children has been remade 101 * 7) the number of its children that are, as yet, unmade 102 * 8) its modification time 103 * 9) the modification time of its youngest child (qv. make.c) 104 * 10) a list of nodes for which this is a source 105 * 11) a list of nodes on which this depends 106 * 12) a list of nodes that depend on this, as gleaned from the 107 * transformation rules. 108 * 13) a list of nodes of the same name created by the :: operator 109 * 14) a list of nodes that must be made (if they're made) before 110 * this node can be, but that do no enter into the datedness of 111 * this node. 112 * 15) a list of nodes that must be made (if they're made) after 113 * this node is, but that do not depend on this node, in the 114 * normal sense. 115 * 16) a Lst of ``local'' variables that are specific to this target 116 * and this target only (qv. var.c [$@ $< $?, etc.]) 117 * 17) a Lst of strings that are commands to be given to a shell 118 * to create this target. 119 */ 120 typedef struct GNode { 121 char *name; /* The target's name */ 122 char *uname; /* The unexpanded name of a .USE node */ 123 char *path; /* The full pathname of the file */ 124 int type; /* Its type (see the OP flags, below) */ 125 int order; /* Its wait weight */ 126 127 int flags; 128 #define REMAKE 0x1 /* this target needs to be remade */ 129 #define CHILDMADE 0x2 /* children of this target were made */ 130 #define FORCE 0x4 /* children don't exist, and we pretend made */ 131 enum { 132 UNMADE, BEINGMADE, MADE, UPTODATE, ERROR, ABORTED, 133 CYCLE, ENDCYCLE 134 } made; /* Set to reflect the state of processing 135 * on this node: 136 * UNMADE - Not examined yet 137 * BEINGMADE - Target is already being made. 138 * Indicates a cycle in the graph. (compat 139 * mode only) 140 * MADE - Was out-of-date and has been made 141 * UPTODATE - Was already up-to-date 142 * ERROR - An error occured while it was being 143 * made (used only in compat mode) 144 * ABORTED - The target was aborted due to 145 * an error making an inferior (compat). 146 * CYCLE - Marked as potentially being part of 147 * a graph cycle. If we come back to a 148 * node marked this way, it is printed 149 * and 'made' is changed to ENDCYCLE. 150 * ENDCYCLE - the cycle has been completely 151 * printed. Go back and unmark all its 152 * members. 153 */ 154 int unmade; /* The number of unmade children */ 155 156 time_t mtime; /* Its modification time */ 157 time_t cmtime; /* The modification time of its youngest 158 * child */ 159 160 Lst iParents; /* Links to parents for which this is an 161 * implied source, if any */ 162 Lst cohorts; /* Other nodes for the :: operator */ 163 Lst parents; /* Nodes that depend on this one */ 164 Lst children; /* Nodes on which this one depends */ 165 Lst successors; /* Nodes that must be made after this one */ 166 Lst preds; /* Nodes that must be made before this one */ 167 168 Hash_Table context; /* The local variables */ 169 Lst commands; /* Creation commands */ 170 171 struct _Suff *suffix; /* Suffix for the node (determined by 172 * Suff_FindDeps and opaque to everyone 173 * but the Suff module) */ 174 char *fname; /* filename where the GNode got defined */ 175 int lineno; /* line number where the GNode got defined */ 176 } GNode; 177 178 /* 179 * Manifest constants 180 */ 181 #define NILGNODE ((GNode *) NIL) 182 183 /* 184 * The OP_ constants are used when parsing a dependency line as a way of 185 * communicating to other parts of the program the way in which a target 186 * should be made. These constants are bitwise-OR'ed together and 187 * placed in the 'type' field of each node. Any node that has 188 * a 'type' field which satisfies the OP_NOP function was never never on 189 * the lefthand side of an operator, though it may have been on the 190 * righthand side... 191 */ 192 #define OP_DEPENDS 0x00000001 /* Execution of commands depends on 193 * kids (:) */ 194 #define OP_FORCE 0x00000002 /* Always execute commands (!) */ 195 #define OP_DOUBLEDEP 0x00000004 /* Execution of commands depends on kids 196 * per line (::) */ 197 #define OP_OPMASK (OP_DEPENDS|OP_FORCE|OP_DOUBLEDEP) 198 199 #define OP_OPTIONAL 0x00000008 /* Don't care if the target doesn't 200 * exist and can't be created */ 201 #define OP_USE 0x00000010 /* Use associated commands for parents */ 202 #define OP_EXEC 0x00000020 /* Target is never out of date, but always 203 * execute commands anyway. Its time 204 * doesn't matter, so it has none...sort 205 * of */ 206 #define OP_IGNORE 0x00000040 /* Ignore errors when creating the node */ 207 #define OP_PRECIOUS 0x00000080 /* Don't remove the target when 208 * interrupted */ 209 #define OP_SILENT 0x00000100 /* Don't echo commands when executed */ 210 #define OP_MAKE 0x00000200 /* Target is a recurrsive make so its 211 * commands should always be executed when 212 * it is out of date, regardless of the 213 * state of the -n or -t flags */ 214 #define OP_JOIN 0x00000400 /* Target is out-of-date only if any of its 215 * children was out-of-date */ 216 #define OP_MADE 0x00000800 /* Assume the node is already made; even if 217 * it really is out of date */ 218 #define OP_USEBEFORE 0x00002000 /* Like .USE, only prepend commands */ 219 #define OP_INVISIBLE 0x00004000 /* The node is invisible to its parents. 220 * I.e. it doesn't show up in the parents's 221 * local variables. */ 222 #define OP_NOTMAIN 0x00008000 /* The node is exempt from normal 'main 223 * target' processing in parse.c */ 224 #define OP_PHONY 0x00010000 /* Not a file target; run always */ 225 #define OP_NOPATH 0x00020000 /* Don't search for file in the path */ 226 /* Attributes applied by PMake */ 227 #define OP_TRANSFORM 0x80000000 /* The node is a transformation rule */ 228 #define OP_MEMBER 0x40000000 /* Target is a member of an archive */ 229 #define OP_LIB 0x20000000 /* Target is a library */ 230 #define OP_ARCHV 0x10000000 /* Target is an archive construct */ 231 #define OP_HAS_COMMANDS 0x08000000 /* Target has all the commands it should. 232 * Used when parsing to catch multiple 233 * commands for a target */ 234 #define OP_SAVE_CMDS 0x04000000 /* Saving commands on .END (Compat) */ 235 #define OP_DEPS_FOUND 0x02000000 /* Already processed by Suff_FindDeps */ 236 #define OP_MARK 0x01000000 /* Node found while expanding .ALLSRC */ 237 238 #define NoExecute(gn) ((gn->type & OP_MAKE) ? noRecursiveExecute : noExecute) 239 /* 240 * OP_NOP will return TRUE if the node with the given type was not the 241 * object of a dependency operator 242 */ 243 #define OP_NOP(t) (((t) & OP_OPMASK) == 0x00000000) 244 245 #define OP_NOTARGET (OP_NOTMAIN|OP_USE|OP_EXEC|OP_TRANSFORM) 246 247 /* 248 * The TARG_ constants are used when calling the Targ_FindNode and 249 * Targ_FindList functions in targ.c. They simply tell the functions what to 250 * do if the desired node(s) is (are) not found. If the TARG_CREATE constant 251 * is given, a new, empty node will be created for the target, placed in the 252 * table of all targets and its address returned. If TARG_NOCREATE is given, 253 * a NIL pointer will be returned. 254 */ 255 #define TARG_CREATE 0x01 /* create node if not found */ 256 #define TARG_NOCREATE 0x00 /* don't create it */ 257 258 /* 259 * There are several places where expandable buffers are used (parse.c and 260 * var.c). This constant is merely the starting point for those buffers. If 261 * lines tend to be much shorter than this, it would be best to reduce BSIZE. 262 * If longer, it should be increased. Reducing it will cause more copying to 263 * be done for longer lines, but will save space for shorter ones. In any 264 * case, it ought to be a power of two simply because most storage allocation 265 * schemes allocate in powers of two. 266 */ 267 #define MAKE_BSIZE 256 /* starting size for expandable buffers */ 268 269 /* 270 * These constants are all used by the Str_Concat function to decide how the 271 * final string should look. If STR_ADDSPACE is given, a space will be 272 * placed between the two strings. If STR_ADDSLASH is given, a '/' will 273 * be used instead of a space. If neither is given, no intervening characters 274 * will be placed between the two strings in the final output. If the 275 * STR_DOFREE bit is set, the two input strings will be freed before 276 * Str_Concat returns. 277 */ 278 #define STR_ADDSPACE 0x01 /* add a space when Str_Concat'ing */ 279 #define STR_DOFREE 0x02 /* free source strings after concatenation */ 280 #define STR_ADDSLASH 0x04 /* add a slash when Str_Concat'ing */ 281 282 /* 283 * Error levels for parsing. PARSE_FATAL means the process cannot continue 284 * once the makefile has been parsed. PARSE_WARNING means it can. Passed 285 * as the first argument to Parse_Error. 286 */ 287 #define PARSE_WARNING 2 288 #define PARSE_FATAL 1 289 290 /* 291 * Values returned by Cond_Eval. 292 */ 293 #define COND_PARSE 0 /* Parse the next lines */ 294 #define COND_SKIP 1 /* Skip the next lines */ 295 #define COND_INVALID 2 /* Not a conditional statement */ 296 297 /* 298 * Definitions for the "local" variables. Used only for clarity. 299 */ 300 #define TARGET "@" /* Target of dependency */ 301 #define OODATE "?" /* All out-of-date sources */ 302 #define ALLSRC ">" /* All sources */ 303 #define IMPSRC "<" /* Source implied by transformation */ 304 #define PREFIX "*" /* Common prefix */ 305 #define ARCHIVE "!" /* Archive in "archive(member)" syntax */ 306 #define MEMBER "%" /* Member in "archive(member)" syntax */ 307 308 #define FTARGET "@F" /* file part of TARGET */ 309 #define DTARGET "@D" /* directory part of TARGET */ 310 #define FIMPSRC "<F" /* file part of IMPSRC */ 311 #define DIMPSRC "<D" /* directory part of IMPSRC */ 312 #define FPREFIX "*F" /* file part of PREFIX */ 313 #define DPREFIX "*D" /* directory part of PREFIX */ 314 315 /* 316 * Global Variables 317 */ 318 extern Lst create; /* The list of target names specified on the 319 * command line. used to resolve #if 320 * make(...) statements */ 321 extern Lst dirSearchPath; /* The list of directories to search when 322 * looking for targets */ 323 324 extern Boolean compatMake; /* True if we are make compatible */ 325 extern Boolean ignoreErrors; /* True if should ignore all errors */ 326 extern Boolean beSilent; /* True if should print no commands */ 327 extern Boolean noExecute; /* True if should execute nothing */ 328 extern Boolean noRecursiveExecute; /* True if should execute nothing */ 329 extern Boolean allPrecious; /* True if every target is precious */ 330 extern Boolean keepgoing; /* True if should continue on unaffected 331 * portions of the graph when have an error 332 * in one portion */ 333 extern Boolean touchFlag; /* TRUE if targets should just be 'touched' 334 * if out of date. Set by the -t flag */ 335 extern Boolean usePipes; /* TRUE if should capture the output of 336 * subshells by means of pipes. Otherwise it 337 * is routed to temporary files from which it 338 * is retrieved when the shell exits */ 339 extern Boolean queryFlag; /* TRUE if we aren't supposed to really make 340 * anything, just see if the targets are out- 341 * of-date */ 342 343 extern Boolean checkEnvFirst; /* TRUE if environment should be searched for 344 * variables before the global context */ 345 extern Boolean jobServer; /* a jobServer already exists */ 346 347 extern Boolean parseWarnFatal; /* TRUE if makefile parsing warnings are 348 * treated as errors */ 349 350 extern GNode *DEFAULT; /* .DEFAULT rule */ 351 352 extern GNode *VAR_GLOBAL; /* Variables defined in a global context, e.g 353 * in the Makefile itself */ 354 extern GNode *VAR_CMD; /* Variables defined on the command line */ 355 extern GNode *VAR_FOR; /* Iteration variables */ 356 extern char var_Error[]; /* Value returned by Var_Parse when an error 357 * is encountered. It actually points to 358 * an empty string, so naive callers needn't 359 * worry about it. */ 360 361 extern time_t now; /* The time at the start of this whole 362 * process */ 363 364 extern Boolean oldVars; /* Do old-style variable substitution */ 365 366 extern Lst sysIncPath; /* The system include path. */ 367 368 extern char *progname; /* The program name */ 369 370 #define MAKEFLAGS ".MAKEFLAGS" 371 #define MAKEOVERRIDES ".MAKEOVERRIDES" 372 373 /* 374 * debug control: 375 * There is one bit per module. It is up to the module what debug 376 * information to print. 377 */ 378 extern int debug; 379 #define DEBUG_ARCH 0x0001 380 #define DEBUG_COND 0x0002 381 #define DEBUG_DIR 0x0004 382 #define DEBUG_GRAPH1 0x0008 383 #define DEBUG_GRAPH2 0x0010 384 #define DEBUG_JOB 0x0020 385 #define DEBUG_MAKE 0x0040 386 #define DEBUG_SUFF 0x0080 387 #define DEBUG_TARG 0x0100 388 #define DEBUG_VAR 0x0200 389 #define DEBUG_FOR 0x0400 390 #define DEBUG_SHELL 0x0800 391 392 #ifdef __STDC__ 393 #define CONCAT(a,b) a##b 394 #else 395 #define I(a) a 396 #define CONCAT(a,b) I(a)b 397 #endif /* __STDC__ */ 398 399 #define DEBUG(module) (debug & CONCAT(DEBUG_,module)) 400 401 /* 402 * Since there are so many, all functions that return non-integer values are 403 * extracted by means of a sed script or two and stuck in the file "nonints.h" 404 */ 405 #include "nonints.h" 406 407 int Make_TimeStamp __P((GNode *, GNode *)); 408 Boolean Make_OODate __P((GNode *)); 409 Lst Make_ExpandUse __P((Lst)); 410 time_t Make_Recheck __P((GNode *)); 411 int Make_HandleUse __P((GNode *, GNode *)); 412 void Make_Update __P((GNode *)); 413 void Make_DoAllVar __P((GNode *)); 414 Boolean Make_Run __P((Lst)); 415 char * Check_Cwd_Cmd __P((char *)); 416 void Check_Cwd __P((char **)); 417 void PrintOnError __P((char *)); 418 void ExportMAKEFLAGS __P((int)); 419 420 #endif /* _MAKE_H_ */ 421