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