1 /* $NetBSD: make.h,v 1.82 2010/04/23 00:18:50 sjg 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 92 #ifdef BSD4_4 93 # include <sys/cdefs.h> 94 #endif 95 96 #if !defined(__GNUC_PREREQ__) 97 #if defined(__GNUC__) 98 #define __GNUC_PREREQ__(x, y) \ 99 ((__GNUC__ == (x) && __GNUC_MINOR__ >= (y)) || \ 100 (__GNUC__ > (x))) 101 #else /* defined(__GNUC__) */ 102 #define __GNUC_PREREQ__(x, y) 0 103 #endif /* defined(__GNUC__) */ 104 #endif /* !defined(__GNUC_PREREQ__) */ 105 106 #if !defined(__unused) 107 #if __GNUC_PREREQ__(2, 7) 108 #define __unused __attribute__((__unused__)) 109 #else 110 #define __unused /* delete */ 111 #endif 112 #endif 113 114 #include "sprite.h" 115 #include "lst.h" 116 #include "hash.h" 117 #include "config.h" 118 #include "buf.h" 119 #include "make_malloc.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 160 int flags; 161 #define REMAKE 0x1 /* this target needs to be (re)made */ 162 #define CHILDMADE 0x2 /* children of this target were made */ 163 #define FORCE 0x4 /* children don't exist, and we pretend made */ 164 #define DONE_WAIT 0x8 /* Set by Make_ProcessWait() */ 165 #define DONE_ORDER 0x10 /* Build requested by .ORDER processing */ 166 #define FROM_DEPEND 0x20 /* Node created from .depend */ 167 #define DONE_ALLSRC 0x40 /* We do it once only */ 168 #define CYCLE 0x1000 /* Used by MakePrintStatus */ 169 #define DONECYCLE 0x2000 /* Used by MakePrintStatus */ 170 enum enum_made { 171 UNMADE, DEFERRED, REQUESTED, BEINGMADE, 172 MADE, UPTODATE, ERROR, ABORTED 173 } made; /* Set to reflect the state of processing 174 * on this node: 175 * UNMADE - Not examined yet 176 * DEFERRED - Examined once (building child) 177 * REQUESTED - on toBeMade list 178 * BEINGMADE - Target is already being made. 179 * Indicates a cycle in the graph. 180 * MADE - Was out-of-date and has been made 181 * UPTODATE - Was already up-to-date 182 * ERROR - An error occurred while it was being 183 * made (used only in compat mode) 184 * ABORTED - The target was aborted due to 185 * an error making an inferior (compat). 186 */ 187 int unmade; /* The number of unmade children */ 188 189 time_t mtime; /* Its modification time */ 190 time_t cmtime; /* The modification time of its youngest 191 * child */ 192 193 Lst iParents; /* Links to parents for which this is an 194 * implied source, if any */ 195 Lst cohorts; /* Other nodes for the :: operator */ 196 Lst parents; /* Nodes that depend on this one */ 197 Lst children; /* Nodes on which this one depends */ 198 Lst order_pred; /* .ORDER nodes we need made */ 199 Lst order_succ; /* .ORDER nodes who need us */ 200 201 char cohort_num[8]; /* #n for this cohort */ 202 int unmade_cohorts;/* # of unmade instances on the 203 cohorts list */ 204 struct GNode *centurion; /* Pointer to the first instance of a :: 205 node; only set when on a cohorts list */ 206 unsigned int checked; /* Last time we tried to makle this node */ 207 208 Hash_Table context; /* The local variables */ 209 Lst commands; /* Creation commands */ 210 211 struct _Suff *suffix; /* Suffix for the node (determined by 212 * Suff_FindDeps and opaque to everyone 213 * but the Suff module) */ 214 const char *fname; /* filename where the GNode got defined */ 215 int lineno; /* line number where the GNode got defined */ 216 } GNode; 217 218 /* 219 * The OP_ constants are used when parsing a dependency line as a way of 220 * communicating to other parts of the program the way in which a target 221 * should be made. These constants are bitwise-OR'ed together and 222 * placed in the 'type' field of each node. Any node that has 223 * a 'type' field which satisfies the OP_NOP function was never never on 224 * the lefthand side of an operator, though it may have been on the 225 * righthand side... 226 */ 227 #define OP_DEPENDS 0x00000001 /* Execution of commands depends on 228 * kids (:) */ 229 #define OP_FORCE 0x00000002 /* Always execute commands (!) */ 230 #define OP_DOUBLEDEP 0x00000004 /* Execution of commands depends on kids 231 * per line (::) */ 232 #define OP_OPMASK (OP_DEPENDS|OP_FORCE|OP_DOUBLEDEP) 233 234 #define OP_OPTIONAL 0x00000008 /* Don't care if the target doesn't 235 * exist and can't be created */ 236 #define OP_USE 0x00000010 /* Use associated commands for parents */ 237 #define OP_EXEC 0x00000020 /* Target is never out of date, but always 238 * execute commands anyway. Its time 239 * doesn't matter, so it has none...sort 240 * of */ 241 #define OP_IGNORE 0x00000040 /* Ignore errors when creating the node */ 242 #define OP_PRECIOUS 0x00000080 /* Don't remove the target when 243 * interrupted */ 244 #define OP_SILENT 0x00000100 /* Don't echo commands when executed */ 245 #define OP_MAKE 0x00000200 /* Target is a recursive make so its 246 * commands should always be executed when 247 * it is out of date, regardless of the 248 * state of the -n or -t flags */ 249 #define OP_JOIN 0x00000400 /* Target is out-of-date only if any of its 250 * children was out-of-date */ 251 #define OP_MADE 0x00000800 /* Assume the children of the node have 252 * been already made */ 253 #define OP_SPECIAL 0x00001000 /* Special .BEGIN, .END, .INTERRUPT */ 254 #define OP_USEBEFORE 0x00002000 /* Like .USE, only prepend commands */ 255 #define OP_INVISIBLE 0x00004000 /* The node is invisible to its parents. 256 * I.e. it doesn't show up in the parents's 257 * local variables. */ 258 #define OP_NOTMAIN 0x00008000 /* The node is exempt from normal 'main 259 * target' processing in parse.c */ 260 #define OP_PHONY 0x00010000 /* Not a file target; run always */ 261 #define OP_NOPATH 0x00020000 /* Don't search for file in the path */ 262 #define OP_WAIT 0x00040000 /* .WAIT phony node */ 263 /* Attributes applied by PMake */ 264 #define OP_TRANSFORM 0x80000000 /* The node is a transformation rule */ 265 #define OP_MEMBER 0x40000000 /* Target is a member of an archive */ 266 #define OP_LIB 0x20000000 /* Target is a library */ 267 #define OP_ARCHV 0x10000000 /* Target is an archive construct */ 268 #define OP_HAS_COMMANDS 0x08000000 /* Target has all the commands it should. 269 * Used when parsing to catch multiple 270 * commands for a target */ 271 #define OP_SAVE_CMDS 0x04000000 /* Saving commands on .END (Compat) */ 272 #define OP_DEPS_FOUND 0x02000000 /* Already processed by Suff_FindDeps */ 273 #define OP_MARK 0x01000000 /* Node found while expanding .ALLSRC */ 274 275 #define NoExecute(gn) ((gn->type & OP_MAKE) ? noRecursiveExecute : noExecute) 276 /* 277 * OP_NOP will return TRUE if the node with the given type was not the 278 * object of a dependency operator 279 */ 280 #define OP_NOP(t) (((t) & OP_OPMASK) == 0x00000000) 281 282 #define OP_NOTARGET (OP_NOTMAIN|OP_USE|OP_EXEC|OP_TRANSFORM) 283 284 /* 285 * The TARG_ constants are used when calling the Targ_FindNode and 286 * Targ_FindList functions in targ.c. They simply tell the functions what to 287 * do if the desired node(s) is (are) not found. If the TARG_CREATE constant 288 * is given, a new, empty node will be created for the target, placed in the 289 * table of all targets and its address returned. If TARG_NOCREATE is given, 290 * a NULL pointer will be returned. 291 */ 292 #define TARG_NOCREATE 0x00 /* don't create it */ 293 #define TARG_CREATE 0x01 /* create node if not found */ 294 #define TARG_NOHASH 0x02 /* don't look in/add to hash table */ 295 296 /* 297 * These constants are all used by the Str_Concat function to decide how the 298 * final string should look. If STR_ADDSPACE is given, a space will be 299 * placed between the two strings. If STR_ADDSLASH is given, a '/' will 300 * be used instead of a space. If neither is given, no intervening characters 301 * will be placed between the two strings in the final output. If the 302 * STR_DOFREE bit is set, the two input strings will be freed before 303 * Str_Concat returns. 304 */ 305 #define STR_ADDSPACE 0x01 /* add a space when Str_Concat'ing */ 306 #define STR_ADDSLASH 0x02 /* add a slash when Str_Concat'ing */ 307 308 /* 309 * Error levels for parsing. PARSE_FATAL means the process cannot continue 310 * once the makefile has been parsed. PARSE_WARNING means it can. Passed 311 * as the first argument to Parse_Error. 312 */ 313 #define PARSE_WARNING 2 314 #define PARSE_FATAL 1 315 316 /* 317 * Values returned by Cond_Eval. 318 */ 319 #define COND_PARSE 0 /* Parse the next lines */ 320 #define COND_SKIP 1 /* Skip the next lines */ 321 #define COND_INVALID 2 /* Not a conditional statement */ 322 323 /* 324 * Definitions for the "local" variables. Used only for clarity. 325 */ 326 #define TARGET "@" /* Target of dependency */ 327 #define OODATE "?" /* All out-of-date sources */ 328 #define ALLSRC ">" /* All sources */ 329 #define IMPSRC "<" /* Source implied by transformation */ 330 #define PREFIX "*" /* Common prefix */ 331 #define ARCHIVE "!" /* Archive in "archive(member)" syntax */ 332 #define MEMBER "%" /* Member in "archive(member)" syntax */ 333 334 #define FTARGET "@F" /* file part of TARGET */ 335 #define DTARGET "@D" /* directory part of TARGET */ 336 #define FIMPSRC "<F" /* file part of IMPSRC */ 337 #define DIMPSRC "<D" /* directory part of IMPSRC */ 338 #define FPREFIX "*F" /* file part of PREFIX */ 339 #define DPREFIX "*D" /* directory part of PREFIX */ 340 341 /* 342 * Global Variables 343 */ 344 extern Lst create; /* The list of target names specified on the 345 * command line. used to resolve #if 346 * make(...) statements */ 347 extern Lst dirSearchPath; /* The list of directories to search when 348 * looking for targets */ 349 350 extern Boolean compatMake; /* True if we are make compatible */ 351 extern Boolean ignoreErrors; /* True if should ignore all errors */ 352 extern Boolean beSilent; /* True if should print no commands */ 353 extern Boolean noExecute; /* True if should execute nothing */ 354 extern Boolean noRecursiveExecute; /* True if should execute nothing */ 355 extern Boolean allPrecious; /* True if every target is precious */ 356 extern Boolean keepgoing; /* True if should continue on unaffected 357 * portions of the graph when have an error 358 * in one portion */ 359 extern Boolean touchFlag; /* TRUE if targets should just be 'touched' 360 * if out of date. Set by the -t flag */ 361 extern Boolean queryFlag; /* TRUE if we aren't supposed to really make 362 * anything, just see if the targets are out- 363 * of-date */ 364 extern Boolean doing_depend; /* TRUE if processing .depend */ 365 366 extern Boolean checkEnvFirst; /* TRUE if environment should be searched for 367 * variables before the global context */ 368 extern Boolean jobServer; /* a jobServer already exists */ 369 370 extern Boolean parseWarnFatal; /* TRUE if makefile parsing warnings are 371 * treated as errors */ 372 373 extern Boolean varNoExportEnv; /* TRUE if we should not export variables 374 * set on the command line to the env. */ 375 376 extern GNode *DEFAULT; /* .DEFAULT rule */ 377 378 extern GNode *VAR_GLOBAL; /* Variables defined in a global context, e.g 379 * in the Makefile itself */ 380 extern GNode *VAR_CMD; /* Variables defined on the command line */ 381 extern GNode *VAR_FOR; /* Iteration variables */ 382 extern char var_Error[]; /* Value returned by Var_Parse when an error 383 * is encountered. It actually points to 384 * an empty string, so naive callers needn't 385 * worry about it. */ 386 387 extern time_t now; /* The time at the start of this whole 388 * process */ 389 390 extern Boolean oldVars; /* Do old-style variable substitution */ 391 392 extern Lst sysIncPath; /* The system include path. */ 393 extern Lst defIncPath; /* The default include path. */ 394 395 extern char *progname; /* The program name */ 396 extern char *makeDependfile; /* .depend */ 397 398 /* 399 * We cannot vfork() in a child of vfork(). 400 * Most systems do not enforce this but some do. 401 */ 402 #define vFork() ((getpid() == myPid) ? vfork() : fork()) 403 extern pid_t myPid; 404 405 #define MAKEFLAGS ".MAKEFLAGS" 406 #define MAKEOVERRIDES ".MAKEOVERRIDES" 407 #define MAKE_JOB_PREFIX ".MAKE.JOB.PREFIX" /* prefix for job target output */ 408 #define MAKE_EXPORTED ".MAKE.EXPORTED" /* variables we export */ 409 #define MAKE_MAKEFILES ".MAKE.MAKEFILES" /* all the makefiles we read */ 410 #define MAKE_LEVEL ".MAKE.LEVEL" /* recursion level */ 411 #define MAKEFILE_PREFERENCE ".MAKE.MAKEFILE_PREFERENCE" 412 #define MAKE_DEPENDFILE ".MAKE.DEPENDFILE" /* .depend */ 413 #define MAKE_MODE ".MAKE.MODE" 414 415 /* 416 * debug control: 417 * There is one bit per module. It is up to the module what debug 418 * information to print. 419 */ 420 FILE *debug_file; /* Output written here - default stdout */ 421 extern int debug; 422 #define DEBUG_ARCH 0x00001 423 #define DEBUG_COND 0x00002 424 #define DEBUG_DIR 0x00004 425 #define DEBUG_GRAPH1 0x00008 426 #define DEBUG_GRAPH2 0x00010 427 #define DEBUG_JOB 0x00020 428 #define DEBUG_MAKE 0x00040 429 #define DEBUG_SUFF 0x00080 430 #define DEBUG_TARG 0x00100 431 #define DEBUG_VAR 0x00200 432 #define DEBUG_FOR 0x00400 433 #define DEBUG_SHELL 0x00800 434 #define DEBUG_ERROR 0x01000 435 #define DEBUG_LOUD 0x02000 436 #define DEBUG_GRAPH3 0x10000 437 #define DEBUG_SCRIPT 0x20000 438 #define DEBUG_PARSE 0x40000 439 #define DEBUG_CWD 0x80000 440 441 #define CONCAT(a,b) a##b 442 443 #define DEBUG(module) (debug & CONCAT(DEBUG_,module)) 444 445 #include "nonints.h" 446 447 int Make_TimeStamp(GNode *, GNode *); 448 Boolean Make_OODate(GNode *); 449 void Make_ExpandUse(Lst); 450 time_t Make_Recheck(GNode *); 451 void Make_HandleUse(GNode *, GNode *); 452 void Make_Update(GNode *); 453 void Make_DoAllVar(GNode *); 454 Boolean Make_Run(Lst); 455 char * Check_Cwd_Cmd(const char *); 456 void Check_Cwd(const char **); 457 void PrintOnError(GNode *, const char *); 458 void Main_ExportMAKEFLAGS(Boolean); 459 Boolean Main_SetObjdir(const char *); 460 int mkTempFile(const char *, char **); 461 462 #ifdef __GNUC__ 463 #define UNCONST(ptr) ({ \ 464 union __unconst { \ 465 const void *__cp; \ 466 void *__p; \ 467 } __d; \ 468 __d.__cp = ptr, __d.__p; }) 469 #else 470 #define UNCONST(ptr) (void *)(ptr) 471 #endif 472 473 #ifndef MIN 474 #define MIN(a, b) ((a < b) ? a : b) 475 #endif 476 #ifndef MAX 477 #define MAX(a, b) ((a > b) ? a : b) 478 #endif 479 480 #endif /* _MAKE_H_ */ 481