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