1 /* $NetBSD: make.h,v 1.43 2002/03/20 18:10:30 pk Exp $ */ 2 3 /* 4 * Copyright (c) 1988, 1989, 1990, 1993 5 * The Regents of the University of California. All rights reserved. 6 * Copyright (c) 1989 by Berkeley Softworks 7 * All rights reserved. 8 * 9 * This code is derived from software contributed to Berkeley by 10 * Adam de Boor. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 3. All advertising materials mentioning features or use of this software 21 * must display the following acknowledgement: 22 * This product includes software developed by the University of 23 * California, Berkeley and its contributors. 24 * 4. Neither the name of the University nor the names of its contributors 25 * may be used to endorse or promote products derived from this software 26 * without specific prior written permission. 27 * 28 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 29 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 30 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 31 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 32 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 36 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 37 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 38 * SUCH DAMAGE. 39 * 40 * from: @(#)make.h 8.3 (Berkeley) 6/13/95 41 */ 42 43 /*- 44 * make.h -- 45 * The global definitions for pmake 46 */ 47 48 #ifndef _MAKE_H_ 49 #define _MAKE_H_ 50 51 #include <sys/types.h> 52 #include <sys/param.h> 53 #include <stdio.h> 54 #include <string.h> 55 #include <ctype.h> 56 57 #ifdef BSD4_4 58 # include <sys/cdefs.h> 59 #else 60 # ifndef __P 61 # if defined(__STDC__) || defined(__cplusplus) 62 # define __P(protos) protos /* full-blown ANSI C */ 63 # else 64 # define __P(protos) () /* traditional C preprocessor */ 65 # endif 66 # endif 67 # ifndef __GNUC__ 68 # ifndef __inline 69 # define __inline 70 # endif 71 # endif 72 # ifndef __STDC__ 73 # ifndef const 74 # define const 75 # endif 76 # ifndef volatile 77 # define volatile 78 # endif 79 # endif 80 #endif 81 82 #if __STDC__ 83 #include <stdlib.h> 84 #include <unistd.h> 85 #endif 86 #include "sprite.h" 87 #include "lst.h" 88 #include "hash.h" 89 #include "config.h" 90 #include "buf.h" 91 92 /*- 93 * The structure for an individual graph node. Each node has several 94 * pieces of data associated with it. 95 * 1) the name of the target it describes 96 * 2) the location of the target file in the file system. 97 * 3) the type of operator used to define its sources (qv. parse.c) 98 * 4) whether it is involved in this invocation of make 99 * 5) whether the target has been remade 100 * 6) whether any of its children has been remade 101 * 7) the number of its children that are, as yet, unmade 102 * 8) its modification time 103 * 9) the modification time of its youngest child (qv. make.c) 104 * 10) a list of nodes for which this is a source 105 * 11) a list of nodes on which this depends 106 * 12) a list of nodes that depend on this, as gleaned from the 107 * transformation rules. 108 * 13) a list of nodes of the same name created by the :: operator 109 * 14) a list of nodes that must be made (if they're made) before 110 * this node can be, but that do no enter into the datedness of 111 * this node. 112 * 15) a list of nodes that must be made (if they're made) after 113 * this node is, but that do not depend on this node, in the 114 * normal sense. 115 * 16) a Lst of ``local'' variables that are specific to this target 116 * and this target only (qv. var.c [$@ $< $?, etc.]) 117 * 17) a Lst of strings that are commands to be given to a shell 118 * to create this target. 119 */ 120 typedef struct GNode { 121 char *name; /* The target's name */ 122 char *uname; /* The unexpanded name of a .USE node */ 123 char *path; /* The full pathname of the file */ 124 int type; /* Its type (see the OP flags, below) */ 125 int order; /* Its wait weight */ 126 127 int flags; 128 #define REMAKE 0x1 /* this target needs to be remade */ 129 #define CHILDMADE 0x2 /* children of this target were made */ 130 #define FORCE 0x4 /* children don't exist, and we pretend made */ 131 enum { 132 UNMADE, BEINGMADE, MADE, UPTODATE, ERROR, ABORTED, 133 CYCLE, ENDCYCLE 134 } made; /* Set to reflect the state of processing 135 * on this node: 136 * UNMADE - Not examined yet 137 * BEINGMADE - Target is already being made. 138 * Indicates a cycle in the graph. (compat 139 * mode only) 140 * MADE - Was out-of-date and has been made 141 * UPTODATE - Was already up-to-date 142 * ERROR - An error occurred while it was being 143 * made (used only in compat mode) 144 * ABORTED - The target was aborted due to 145 * an error making an inferior (compat). 146 * CYCLE - Marked as potentially being part of 147 * a graph cycle. If we come back to a 148 * node marked this way, it is printed 149 * and 'made' is changed to ENDCYCLE. 150 * ENDCYCLE - the cycle has been completely 151 * printed. Go back and unmark all its 152 * members. 153 */ 154 int unmade; /* The number of unmade children */ 155 156 time_t mtime; /* Its modification time */ 157 time_t cmtime; /* The modification time of its youngest 158 * child */ 159 160 Lst iParents; /* Links to parents for which this is an 161 * implied source, if any */ 162 Lst cohorts; /* Other nodes for the :: operator */ 163 Lst parents; /* Nodes that depend on this one */ 164 Lst children; /* Nodes on which this one depends */ 165 Lst successors; /* Nodes that must be made after this one */ 166 Lst preds; /* Nodes that must be made before this one */ 167 int unmade_cohorts;/* # of unmade instances on the 168 cohorts list */ 169 struct GNode *centurion; /* Pointer to the first instance of a :: 170 node; only set when on a cohorts list */ 171 172 Hash_Table context; /* The local variables */ 173 Lst commands; /* Creation commands */ 174 175 struct _Suff *suffix; /* Suffix for the node (determined by 176 * Suff_FindDeps and opaque to everyone 177 * but the Suff module) */ 178 char *fname; /* filename where the GNode got defined */ 179 int lineno; /* line number where the GNode got defined */ 180 } GNode; 181 182 /* 183 * Manifest constants 184 */ 185 #define NILGNODE ((GNode *) NIL) 186 187 /* 188 * The OP_ constants are used when parsing a dependency line as a way of 189 * communicating to other parts of the program the way in which a target 190 * should be made. These constants are bitwise-OR'ed together and 191 * placed in the 'type' field of each node. Any node that has 192 * a 'type' field which satisfies the OP_NOP function was never never on 193 * the lefthand side of an operator, though it may have been on the 194 * righthand side... 195 */ 196 #define OP_DEPENDS 0x00000001 /* Execution of commands depends on 197 * kids (:) */ 198 #define OP_FORCE 0x00000002 /* Always execute commands (!) */ 199 #define OP_DOUBLEDEP 0x00000004 /* Execution of commands depends on kids 200 * per line (::) */ 201 #define OP_OPMASK (OP_DEPENDS|OP_FORCE|OP_DOUBLEDEP) 202 203 #define OP_OPTIONAL 0x00000008 /* Don't care if the target doesn't 204 * exist and can't be created */ 205 #define OP_USE 0x00000010 /* Use associated commands for parents */ 206 #define OP_EXEC 0x00000020 /* Target is never out of date, but always 207 * execute commands anyway. Its time 208 * doesn't matter, so it has none...sort 209 * of */ 210 #define OP_IGNORE 0x00000040 /* Ignore errors when creating the node */ 211 #define OP_PRECIOUS 0x00000080 /* Don't remove the target when 212 * interrupted */ 213 #define OP_SILENT 0x00000100 /* Don't echo commands when executed */ 214 #define OP_MAKE 0x00000200 /* Target is a recursive make so its 215 * commands should always be executed when 216 * it is out of date, regardless of the 217 * state of the -n or -t flags */ 218 #define OP_JOIN 0x00000400 /* Target is out-of-date only if any of its 219 * children was out-of-date */ 220 #define OP_MADE 0x00000800 /* Assume the children of the node have 221 * been already made */ 222 #define OP_USEBEFORE 0x00002000 /* Like .USE, only prepend commands */ 223 #define OP_INVISIBLE 0x00004000 /* The node is invisible to its parents. 224 * I.e. it doesn't show up in the parents's 225 * local variables. */ 226 #define OP_NOTMAIN 0x00008000 /* The node is exempt from normal 'main 227 * target' processing in parse.c */ 228 #define OP_PHONY 0x00010000 /* Not a file target; run always */ 229 #define OP_NOPATH 0x00020000 /* Don't search for file in the path */ 230 /* Attributes applied by PMake */ 231 #define OP_TRANSFORM 0x80000000 /* The node is a transformation rule */ 232 #define OP_MEMBER 0x40000000 /* Target is a member of an archive */ 233 #define OP_LIB 0x20000000 /* Target is a library */ 234 #define OP_ARCHV 0x10000000 /* Target is an archive construct */ 235 #define OP_HAS_COMMANDS 0x08000000 /* Target has all the commands it should. 236 * Used when parsing to catch multiple 237 * commands for a target */ 238 #define OP_SAVE_CMDS 0x04000000 /* Saving commands on .END (Compat) */ 239 #define OP_DEPS_FOUND 0x02000000 /* Already processed by Suff_FindDeps */ 240 #define OP_MARK 0x01000000 /* Node found while expanding .ALLSRC */ 241 242 #define NoExecute(gn) ((gn->type & OP_MAKE) ? noRecursiveExecute : noExecute) 243 /* 244 * OP_NOP will return TRUE if the node with the given type was not the 245 * object of a dependency operator 246 */ 247 #define OP_NOP(t) (((t) & OP_OPMASK) == 0x00000000) 248 249 #define OP_NOTARGET (OP_NOTMAIN|OP_USE|OP_EXEC|OP_TRANSFORM) 250 251 /* 252 * The TARG_ constants are used when calling the Targ_FindNode and 253 * Targ_FindList functions in targ.c. They simply tell the functions what to 254 * do if the desired node(s) is (are) not found. If the TARG_CREATE constant 255 * is given, a new, empty node will be created for the target, placed in the 256 * table of all targets and its address returned. If TARG_NOCREATE is given, 257 * a NIL pointer will be returned. 258 */ 259 #define TARG_CREATE 0x01 /* create node if not found */ 260 #define TARG_NOCREATE 0x00 /* don't create it */ 261 262 /* 263 * There are several places where expandable buffers are used (parse.c and 264 * var.c). This constant is merely the starting point for those buffers. If 265 * lines tend to be much shorter than this, it would be best to reduce BSIZE. 266 * If longer, it should be increased. Reducing it will cause more copying to 267 * be done for longer lines, but will save space for shorter ones. In any 268 * case, it ought to be a power of two simply because most storage allocation 269 * schemes allocate in powers of two. 270 */ 271 #define MAKE_BSIZE 256 /* starting size for expandable buffers */ 272 273 /* 274 * These constants are all used by the Str_Concat function to decide how the 275 * final string should look. If STR_ADDSPACE is given, a space will be 276 * placed between the two strings. If STR_ADDSLASH is given, a '/' will 277 * be used instead of a space. If neither is given, no intervening characters 278 * will be placed between the two strings in the final output. If the 279 * STR_DOFREE bit is set, the two input strings will be freed before 280 * Str_Concat returns. 281 */ 282 #define STR_ADDSPACE 0x01 /* add a space when Str_Concat'ing */ 283 #define STR_DOFREE 0x02 /* free source strings after concatenation */ 284 #define STR_ADDSLASH 0x04 /* add a slash when Str_Concat'ing */ 285 286 /* 287 * Error levels for parsing. PARSE_FATAL means the process cannot continue 288 * once the makefile has been parsed. PARSE_WARNING means it can. Passed 289 * as the first argument to Parse_Error. 290 */ 291 #define PARSE_WARNING 2 292 #define PARSE_FATAL 1 293 294 /* 295 * Values returned by Cond_Eval. 296 */ 297 #define COND_PARSE 0 /* Parse the next lines */ 298 #define COND_SKIP 1 /* Skip the next lines */ 299 #define COND_INVALID 2 /* Not a conditional statement */ 300 301 /* 302 * Definitions for the "local" variables. Used only for clarity. 303 */ 304 #define TARGET "@" /* Target of dependency */ 305 #define OODATE "?" /* All out-of-date sources */ 306 #define ALLSRC ">" /* All sources */ 307 #define IMPSRC "<" /* Source implied by transformation */ 308 #define PREFIX "*" /* Common prefix */ 309 #define ARCHIVE "!" /* Archive in "archive(member)" syntax */ 310 #define MEMBER "%" /* Member in "archive(member)" syntax */ 311 312 #define FTARGET "@F" /* file part of TARGET */ 313 #define DTARGET "@D" /* directory part of TARGET */ 314 #define FIMPSRC "<F" /* file part of IMPSRC */ 315 #define DIMPSRC "<D" /* directory part of IMPSRC */ 316 #define FPREFIX "*F" /* file part of PREFIX */ 317 #define DPREFIX "*D" /* directory part of PREFIX */ 318 319 /* 320 * Global Variables 321 */ 322 extern Lst create; /* The list of target names specified on the 323 * command line. used to resolve #if 324 * make(...) statements */ 325 extern Lst dirSearchPath; /* The list of directories to search when 326 * looking for targets */ 327 328 extern Boolean compatMake; /* True if we are make compatible */ 329 extern Boolean ignoreErrors; /* True if should ignore all errors */ 330 extern Boolean beSilent; /* True if should print no commands */ 331 extern Boolean noExecute; /* True if should execute nothing */ 332 extern Boolean noRecursiveExecute; /* True if should execute nothing */ 333 extern Boolean allPrecious; /* True if every target is precious */ 334 extern Boolean keepgoing; /* True if should continue on unaffected 335 * portions of the graph when have an error 336 * in one portion */ 337 extern Boolean touchFlag; /* TRUE if targets should just be 'touched' 338 * if out of date. Set by the -t flag */ 339 extern Boolean usePipes; /* TRUE if should capture the output of 340 * subshells by means of pipes. Otherwise it 341 * is routed to temporary files from which it 342 * is retrieved when the shell exits */ 343 extern Boolean queryFlag; /* TRUE if we aren't supposed to really make 344 * anything, just see if the targets are out- 345 * of-date */ 346 347 extern Boolean checkEnvFirst; /* TRUE if environment should be searched for 348 * variables before the global context */ 349 extern Boolean jobServer; /* a jobServer already exists */ 350 351 extern Boolean parseWarnFatal; /* TRUE if makefile parsing warnings are 352 * treated as errors */ 353 354 extern GNode *DEFAULT; /* .DEFAULT rule */ 355 356 extern GNode *VAR_GLOBAL; /* Variables defined in a global context, e.g 357 * in the Makefile itself */ 358 extern GNode *VAR_CMD; /* Variables defined on the command line */ 359 extern GNode *VAR_FOR; /* Iteration variables */ 360 extern char var_Error[]; /* Value returned by Var_Parse when an error 361 * is encountered. It actually points to 362 * an empty string, so naive callers needn't 363 * worry about it. */ 364 365 extern time_t now; /* The time at the start of this whole 366 * process */ 367 368 extern Boolean oldVars; /* Do old-style variable substitution */ 369 370 extern Lst sysIncPath; /* The system include path. */ 371 extern Lst defIncPath; /* The default include path. */ 372 373 extern char *progname; /* The program name */ 374 375 #define MAKEFLAGS ".MAKEFLAGS" 376 #define MAKEOVERRIDES ".MAKEOVERRIDES" 377 378 /* 379 * debug control: 380 * There is one bit per module. It is up to the module what debug 381 * information to print. 382 */ 383 extern int debug; 384 #define DEBUG_ARCH 0x0001 385 #define DEBUG_COND 0x0002 386 #define DEBUG_DIR 0x0004 387 #define DEBUG_GRAPH1 0x0008 388 #define DEBUG_GRAPH2 0x0010 389 #define DEBUG_JOB 0x0020 390 #define DEBUG_MAKE 0x0040 391 #define DEBUG_SUFF 0x0080 392 #define DEBUG_TARG 0x0100 393 #define DEBUG_VAR 0x0200 394 #define DEBUG_FOR 0x0400 395 #define DEBUG_SHELL 0x0800 396 397 #ifdef __STDC__ 398 #define CONCAT(a,b) a##b 399 #else 400 #define I(a) a 401 #define CONCAT(a,b) I(a)b 402 #endif /* __STDC__ */ 403 404 #define DEBUG(module) (debug & CONCAT(DEBUG_,module)) 405 406 /* 407 * Since there are so many, all functions that return non-integer values are 408 * extracted by means of a sed script or two and stuck in the file "nonints.h" 409 */ 410 #include "nonints.h" 411 412 int Make_TimeStamp __P((GNode *, GNode *)); 413 Boolean Make_OODate __P((GNode *)); 414 Lst Make_ExpandUse __P((Lst)); 415 time_t Make_Recheck __P((GNode *)); 416 void Make_HandleUse __P((GNode *, GNode *)); 417 void Make_Update __P((GNode *)); 418 void Make_DoAllVar __P((GNode *)); 419 Boolean Make_Run __P((Lst)); 420 char * Check_Cwd_Cmd __P((char *)); 421 void Check_Cwd __P((char **)); 422 void PrintOnError __P((char *)); 423 void Main_ExportMAKEFLAGS __P((Boolean)); 424 Boolean Main_SetObjdir __P((const char *)); 425 426 #endif /* _MAKE_H_ */ 427