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