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