make.h revision 1.120
1 /* $NetBSD: make.h,v 1.120 2020/08/22 18:44:22 rillig 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_MAKE_H 81 #define MAKE_MAKE_H 82 83 #include <sys/types.h> 84 #include <sys/param.h> 85 86 #include <ctype.h> 87 #include <fcntl.h> 88 #include <stdio.h> 89 #include <stdlib.h> 90 #include <string.h> 91 #include <unistd.h> 92 93 #ifdef BSD4_4 94 # include <sys/cdefs.h> 95 #endif 96 97 #ifndef FD_CLOEXEC 98 #define FD_CLOEXEC 1 99 #endif 100 101 #if defined(__GNUC__) 102 #define MAKE_GNUC_PREREQ(x, y) \ 103 ((__GNUC__ == (x) && __GNUC_MINOR__ >= (y)) || \ 104 (__GNUC__ > (x))) 105 #else /* defined(__GNUC__) */ 106 #define MAKE_GNUC_PREREQ(x, y) 0 107 #endif /* defined(__GNUC__) */ 108 109 #if MAKE_GNUC_PREREQ(2, 7) 110 #define MAKE_ATTR_UNUSED __attribute__((__unused__)) 111 #else 112 #define MAKE_ATTR_UNUSED /* delete */ 113 #endif 114 115 #if MAKE_GNUC_PREREQ(2, 5) 116 #define MAKE_ATTR_DEAD __attribute__((__noreturn__)) 117 #elif defined(__GNUC__) 118 #define MAKE_ATTR_DEAD __volatile 119 #else 120 #define MAKE_ATTR_DEAD /* delete */ 121 #endif 122 123 #if MAKE_GNUC_PREREQ(2, 7) 124 #define MAKE_ATTR_PRINTFLIKE(fmtarg, firstvararg) \ 125 __attribute__((__format__ (__printf__, fmtarg, firstvararg))) 126 #else 127 #define MAKE_ATTR_PRINTFLIKE(fmtarg, firstvararg) /* delete */ 128 #endif 129 130 #include "sprite.h" 131 #include "lst.h" 132 #include "hash.h" 133 #include "config.h" 134 #include "buf.h" 135 #include "make_malloc.h" 136 137 typedef enum { 138 UNMADE, /* Not examined yet */ 139 DEFERRED, /* Examined once (building child) */ 140 REQUESTED, /* on toBeMade list */ 141 BEINGMADE, /* Target is already being made. 142 * Indicates a cycle in the graph. */ 143 MADE, /* Was out-of-date and has been made */ 144 UPTODATE, /* Was already up-to-date */ 145 ERROR, /* An error occurred while it was being 146 * made (used only in compat mode) */ 147 ABORTED /* The target was aborted due to an error 148 * making an inferior (compat). */ 149 } GNodeMade; 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. 154 * 155 * These constants are bitwise-OR'ed together and placed in the 'type' field 156 * of each node. Any node that has a 'type' field which satisfies the OP_NOP 157 * function was never never on the left-hand side of an operator, though it 158 * may have been on the right-hand side... */ 159 typedef enum { 160 /* Execution of commands depends on children (:) */ 161 OP_DEPENDS = 1 << 0, 162 /* Always execute commands (!) */ 163 OP_FORCE = 1 << 1, 164 /* Execution of commands depends on children per line (::) */ 165 OP_DOUBLEDEP = 1 << 2, 166 167 OP_OPMASK = OP_DEPENDS|OP_FORCE|OP_DOUBLEDEP, 168 169 /* Don't care if the target doesn't exist and can't be created */ 170 OP_OPTIONAL = 1 << 3, 171 /* Use associated commands for parents */ 172 OP_USE = 1 << 4, 173 /* Target is never out of date, but always execute commands anyway. 174 * Its time doesn't matter, so it has none...sort of */ 175 OP_EXEC = 1 << 5, 176 /* Ignore errors when creating the node */ 177 OP_IGNORE = 1 << 6, 178 /* Don't remove the target when interrupted */ 179 OP_PRECIOUS = 1 << 7, 180 /* Don't echo commands when executed */ 181 OP_SILENT = 1 << 8, 182 /* Target is a recursive make so its commands should always be executed 183 * when it is out of date, regardless of the state of the -n or -t flags */ 184 OP_MAKE = 1 << 9, 185 /* Target is out-of-date only if any of its children was out-of-date */ 186 OP_JOIN = 1 << 10, 187 /* Assume the children of the node have been already made */ 188 OP_MADE = 1 << 11, 189 /* Special .BEGIN, .END, .INTERRUPT */ 190 OP_SPECIAL = 1 << 12, 191 /* Like .USE, only prepend commands */ 192 OP_USEBEFORE = 1 << 13, 193 /* The node is invisible to its parents. I.e. it doesn't show up in the 194 * parents' local variables. */ 195 OP_INVISIBLE = 1 << 14, 196 /* The node is exempt from normal 'main target' processing in parse.c */ 197 OP_NOTMAIN = 1 << 15, 198 /* Not a file target; run always */ 199 OP_PHONY = 1 << 16, 200 /* Don't search for file in the path */ 201 OP_NOPATH = 1 << 17, 202 /* .WAIT phony node */ 203 OP_WAIT = 1 << 18, 204 /* .NOMETA do not create a .meta file */ 205 OP_NOMETA = 1 << 19, 206 /* .META we _do_ want a .meta file */ 207 OP_META = 1 << 20, 208 /* Do not compare commands in .meta file */ 209 OP_NOMETA_CMP = 1 << 21, 210 /* Possibly a submake node */ 211 OP_SUBMAKE = 1 << 22, 212 213 /* Attributes applied by PMake */ 214 215 /* The node is a transformation rule */ 216 OP_TRANSFORM = 1 << 31, 217 /* Target is a member of an archive */ 218 OP_MEMBER = 1 << 30, 219 /* Target is a library */ 220 OP_LIB = 1 << 29, 221 /* Target is an archive construct */ 222 OP_ARCHV = 1 << 28, 223 /* Target has all the commands it should. Used when parsing to catch 224 * multiple commands for a target. */ 225 OP_HAS_COMMANDS = 1 << 27, 226 /* Saving commands on .END (Compat) */ 227 OP_SAVE_CMDS = 1 << 26, 228 /* Already processed by Suff_FindDeps */ 229 OP_DEPS_FOUND = 1 << 25, 230 /* Node found while expanding .ALLSRC */ 231 OP_MARK = 1 << 24 232 } GNodeType; 233 234 typedef enum { 235 REMAKE = 0x0001, /* this target needs to be (re)made */ 236 CHILDMADE = 0x0002, /* children of this target were made */ 237 FORCE = 0x0004, /* children don't exist, and we pretend made */ 238 DONE_WAIT = 0x0008, /* Set by Make_ProcessWait() */ 239 DONE_ORDER = 0x0010, /* Build requested by .ORDER processing */ 240 FROM_DEPEND = 0x0020, /* Node created from .depend */ 241 DONE_ALLSRC = 0x0040, /* We do it once only */ 242 CYCLE = 0x1000, /* Used by MakePrintStatus */ 243 DONECYCLE = 0x2000, /* Used by MakePrintStatus */ 244 INTERNAL = 0x4000 /* Internal use only */ 245 } GNodeFlags; 246 247 /* A graph node represents a target that can possibly be made, including its 248 * relation to other targets and a lot of other details. */ 249 typedef struct GNode { 250 /* The target's name, such as "clean" or "make.c" */ 251 char *name; 252 /* The unexpanded name of a .USE node */ 253 char *uname; 254 /* The full pathname of the file belonging to the target. 255 * XXX: What about .PHONY targets? These don't have an associated path. */ 256 char *path; 257 258 /* The type of operator used to define the sources (see the OP flags below). 259 * XXX: This looks like a wild mixture of type and flags. */ 260 int type; 261 /* whether it is involved in this invocation of make */ 262 GNodeFlags flags; 263 264 /* The state of processing on this node */ 265 GNodeMade made; 266 int unmade; /* The number of unmade children */ 267 268 time_t mtime; /* Its modification time */ 269 struct GNode *cmgn; /* The youngest child */ 270 271 /* Links to parents for which this is an implied source. May be empty. 272 * Nodes that depend on this, as gleaned from the transformation rules. */ 273 Lst iParents; 274 275 /* Other nodes of the same name for the :: operator. */ 276 Lst cohorts; 277 278 /* The nodes that depend on this one, or in other words, the nodes for 279 * which this is a source. */ 280 Lst parents; 281 /* The nodes on which this one depends. */ 282 Lst children; 283 284 /* .ORDER nodes we need made. The nodes that must be made (if they're 285 * made) before this node can be made, but that do not enter into the 286 * datedness of this node. */ 287 Lst order_pred; 288 /* .ORDER nodes who need us. The nodes that must be made (if they're made 289 * at all) after this node is made, but that do not depend on this node, 290 * in the normal sense. */ 291 Lst order_succ; 292 293 /* #n for this cohort */ 294 char cohort_num[8]; 295 /* The number of unmade instances on the cohorts list */ 296 int unmade_cohorts; 297 /* Pointer to the first instance of a :: node; only set when on a cohorts 298 * list */ 299 struct GNode *centurion; 300 301 /* Last time we tried to make this node */ 302 unsigned int checked; /* XXX: year 2038 */ 303 304 /* The "local" variables that are specific to this target and this target 305 * only, such as $@, $<, $?. */ 306 Hash_Table context; 307 308 /* The commands to be given to a shell to create this target. */ 309 Lst commands; 310 311 /* Suffix for the node (determined by Suff_FindDeps and opaque to everyone 312 * but the Suff module) */ 313 struct Suff *suffix; 314 315 /* filename where the GNode got defined */ 316 const char *fname; 317 /* line number where the GNode got defined */ 318 int lineno; 319 } GNode; 320 321 #define NoExecute(gn) ((gn->type & OP_MAKE) ? noRecursiveExecute : noExecute) 322 /* 323 * OP_NOP will return TRUE if the node with the given type was not the 324 * object of a dependency operator 325 */ 326 #define OP_NOP(t) (((t) & OP_OPMASK) == 0x00000000) 327 328 #define OP_NOTARGET (OP_NOTMAIN|OP_USE|OP_EXEC|OP_TRANSFORM) 329 330 /* 331 * The TARG_ constants are used when calling the Targ_FindNode and 332 * Targ_FindList functions in targ.c. They simply tell the functions what to 333 * do if the desired node(s) is (are) not found. If the TARG_CREATE constant 334 * is given, a new, empty node will be created for the target, placed in the 335 * table of all targets and its address returned. If TARG_NOCREATE is given, 336 * a NULL pointer will be returned. 337 */ 338 #define TARG_NOCREATE 0x00 /* don't create it */ 339 #define TARG_CREATE 0x01 /* create node if not found */ 340 #define TARG_NOHASH 0x02 /* don't look in/add to hash table */ 341 342 /* 343 * Error levels for parsing. PARSE_FATAL means the process cannot continue 344 * once the makefile has been parsed. PARSE_WARNING means it can. Passed 345 * as the first argument to Parse_Error. 346 */ 347 #define PARSE_INFO 3 348 #define PARSE_WARNING 2 349 #define PARSE_FATAL 1 350 351 /* 352 * Values returned by Cond_Eval. 353 */ 354 typedef enum { 355 COND_PARSE, /* Parse the next lines */ 356 COND_SKIP, /* Skip the next lines */ 357 COND_INVALID /* Not a conditional statement */ 358 } CondEvalResult; 359 360 /* 361 * Definitions for the "local" variables. Used only for clarity. 362 */ 363 #define TARGET "@" /* Target of dependency */ 364 #define OODATE "?" /* All out-of-date sources */ 365 #define ALLSRC ">" /* All sources */ 366 #define IMPSRC "<" /* Source implied by transformation */ 367 #define PREFIX "*" /* Common prefix */ 368 #define ARCHIVE "!" /* Archive in "archive(member)" syntax */ 369 #define MEMBER "%" /* Member in "archive(member)" syntax */ 370 371 #define FTARGET "@F" /* file part of TARGET */ 372 #define DTARGET "@D" /* directory part of TARGET */ 373 #define FIMPSRC "<F" /* file part of IMPSRC */ 374 #define DIMPSRC "<D" /* directory part of IMPSRC */ 375 #define FPREFIX "*F" /* file part of PREFIX */ 376 #define DPREFIX "*D" /* directory part of PREFIX */ 377 378 /* 379 * Global Variables 380 */ 381 extern Lst create; /* The list of target names specified on the 382 * command line. used to resolve #if 383 * make(...) statements */ 384 extern Lst dirSearchPath; /* The list of directories to search when 385 * looking for targets */ 386 387 extern Boolean compatMake; /* True if we are make compatible */ 388 extern Boolean ignoreErrors; /* True if should ignore all errors */ 389 extern Boolean beSilent; /* True if should print no commands */ 390 extern Boolean noExecute; /* True if should execute nothing */ 391 extern Boolean noRecursiveExecute; /* True if should execute nothing */ 392 extern Boolean allPrecious; /* True if every target is precious */ 393 extern Boolean deleteOnError; /* True if failed targets should be deleted */ 394 extern Boolean keepgoing; /* True if should continue on unaffected 395 * portions of the graph when have an error 396 * in one portion */ 397 extern Boolean touchFlag; /* TRUE if targets should just be 'touched' 398 * if out of date. Set by the -t flag */ 399 extern Boolean queryFlag; /* TRUE if we aren't supposed to really make 400 * anything, just see if the targets are out- 401 * of-date */ 402 extern Boolean doing_depend; /* TRUE if processing .depend */ 403 404 extern Boolean checkEnvFirst; /* TRUE if environment should be searched for 405 * variables before the global context */ 406 extern Boolean jobServer; /* a jobServer already exists */ 407 408 extern Boolean parseWarnFatal; /* TRUE if makefile parsing warnings are 409 * treated as errors */ 410 411 extern Boolean varNoExportEnv; /* TRUE if we should not export variables 412 * set on the command line to the env. */ 413 414 extern GNode *DEFAULT; /* .DEFAULT rule */ 415 416 extern GNode *VAR_INTERNAL; /* Variables defined internally by make 417 * which should not override those set by 418 * makefiles. 419 */ 420 extern GNode *VAR_GLOBAL; /* Variables defined in a global context, e.g 421 * in the Makefile itself */ 422 extern GNode *VAR_CMD; /* Variables defined on the command line */ 423 extern GNode *VAR_FOR; /* Iteration variables */ 424 extern char var_Error[]; /* Value returned by Var_Parse when an error 425 * is encountered. It actually points to 426 * an empty string, so naive callers needn't 427 * worry about it. */ 428 429 extern time_t now; /* The time at the start of this whole 430 * process */ 431 432 extern Boolean oldVars; /* Do old-style variable substitution */ 433 434 extern Lst sysIncPath; /* The system include path. */ 435 extern Lst defIncPath; /* The default include path. */ 436 437 extern char curdir[]; /* Startup directory */ 438 extern char *progname; /* The program name */ 439 extern char *makeDependfile; /* .depend */ 440 extern char **savedEnv; /* if we replaced environ this will be non-NULL */ 441 442 extern int makelevel; 443 444 /* 445 * We cannot vfork() in a child of vfork(). 446 * Most systems do not enforce this but some do. 447 */ 448 #define vFork() ((getpid() == myPid) ? vfork() : fork()) 449 extern pid_t myPid; 450 451 #define MAKEFLAGS ".MAKEFLAGS" 452 #define MAKEOVERRIDES ".MAKEOVERRIDES" 453 #define MAKE_JOB_PREFIX ".MAKE.JOB.PREFIX" /* prefix for job target output */ 454 #define MAKE_EXPORTED ".MAKE.EXPORTED" /* variables we export */ 455 #define MAKE_MAKEFILES ".MAKE.MAKEFILES" /* all the makefiles we read */ 456 #define MAKE_LEVEL ".MAKE.LEVEL" /* recursion level */ 457 #define MAKEFILE_PREFERENCE ".MAKE.MAKEFILE_PREFERENCE" 458 #define MAKE_DEPENDFILE ".MAKE.DEPENDFILE" /* .depend */ 459 #define MAKE_MODE ".MAKE.MODE" 460 #ifndef MAKE_LEVEL_ENV 461 # define MAKE_LEVEL_ENV "MAKELEVEL" 462 #endif 463 464 /* 465 * debug control: 466 * There is one bit per module. It is up to the module what debug 467 * information to print. 468 */ 469 extern FILE *debug_file; /* Output is written here - default stderr */ 470 extern int debug; 471 #define DEBUG_ARCH 0x00001 472 #define DEBUG_COND 0x00002 473 #define DEBUG_DIR 0x00004 474 #define DEBUG_GRAPH1 0x00008 475 #define DEBUG_GRAPH2 0x00010 476 #define DEBUG_JOB 0x00020 477 #define DEBUG_MAKE 0x00040 478 #define DEBUG_SUFF 0x00080 479 #define DEBUG_TARG 0x00100 480 #define DEBUG_VAR 0x00200 481 #define DEBUG_FOR 0x00400 482 #define DEBUG_SHELL 0x00800 483 #define DEBUG_ERROR 0x01000 484 #define DEBUG_LOUD 0x02000 485 #define DEBUG_META 0x04000 486 #define DEBUG_HASH 0x08000 487 488 #define DEBUG_GRAPH3 0x10000 489 #define DEBUG_SCRIPT 0x20000 490 #define DEBUG_PARSE 0x40000 491 #define DEBUG_CWD 0x80000 492 493 #define DEBUG_LINT 0x100000 494 495 #define CONCAT(a,b) a##b 496 497 #define DEBUG(module) (debug & CONCAT(DEBUG_,module)) 498 499 #include "nonints.h" 500 501 int Make_TimeStamp(GNode *, GNode *); 502 Boolean Make_OODate(GNode *); 503 void Make_ExpandUse(Lst); 504 time_t Make_Recheck(GNode *); 505 void Make_HandleUse(GNode *, GNode *); 506 void Make_Update(GNode *); 507 void Make_DoAllVar(GNode *); 508 Boolean Make_Run(Lst); 509 int dieQuietly(GNode *, int); 510 void PrintOnError(GNode *, const char *); 511 void Main_ExportMAKEFLAGS(Boolean); 512 Boolean Main_SetObjdir(const char *, ...) MAKE_ATTR_PRINTFLIKE(1, 2); 513 int mkTempFile(const char *, char **); 514 int str2Lst_Append(Lst, char *, const char *); 515 int cached_lstat(const char *, void *); 516 int cached_stat(const char *, void *); 517 518 #ifdef __GNUC__ 519 #define UNCONST(ptr) ({ \ 520 union __unconst { \ 521 const void *__cp; \ 522 void *__p; \ 523 } __d; \ 524 __d.__cp = ptr, __d.__p; }) 525 #else 526 #define UNCONST(ptr) (void *)(ptr) 527 #endif 528 529 #ifndef MIN 530 #define MIN(a, b) ((a < b) ? a : b) 531 #endif 532 #ifndef MAX 533 #define MAX(a, b) ((a > b) ? a : b) 534 #endif 535 536 /* At least GNU/Hurd systems lack hardcoded MAXPATHLEN/PATH_MAX */ 537 #include <limits.h> 538 #ifndef MAXPATHLEN 539 #define MAXPATHLEN 4096 540 #endif 541 #ifndef PATH_MAX 542 #define PATH_MAX MAXPATHLEN 543 #endif 544 545 #if defined(SYSV) 546 #define KILLPG(pid, sig) kill(-(pid), (sig)) 547 #else 548 #define KILLPG(pid, sig) killpg((pid), (sig)) 549 #endif 550 551 #endif /* MAKE_MAKE_H */ 552
Indexes created Mon Sep 29 21:09:56 GMT 2025