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