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