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