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