1
/* $NetBSD: targ.c,v 1.57 2012/06/12 19:21:51 joerg Exp $ */
4
* Copyright (c) 1988, 1989, 1990, 1993
5
* The Regents of the University of California. All rights reserved.
7
* This code is derived from software contributed to Berkeley by
10
* Redistribution and use in source and binary forms, with or without
11
* modification, are permitted provided that the following conditions
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. Neither the name of the University nor the names of its contributors
19
* may be used to endorse or promote products derived from this software
20
* without specific prior written permission.
22
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36
* Copyright (c) 1989 by Berkeley Softworks
37
* All rights reserved.
39
* This code is derived from software contributed to Berkeley by
42
* Redistribution and use in source and binary forms, with or without
43
* modification, are permitted provided that the following conditions
45
* 1. Redistributions of source code must retain the above copyright
46
* notice, this list of conditions and the following disclaimer.
47
* 2. Redistributions in binary form must reproduce the above copyright
48
* notice, this list of conditions and the following disclaimer in the
49
* documentation and/or other materials provided with the distribution.
50
* 3. All advertising materials mentioning features or use of this software
51
* must display the following acknowledgement:
52
* This product includes software developed by the University of
53
* California, Berkeley and its contributors.
54
* 4. Neither the name of the University nor the names of its contributors
55
* may be used to endorse or promote products derived from this software
56
* without specific prior written permission.
58
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
59
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
60
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
61
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
62
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
63
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
64
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
65
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
66
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
67
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
72
static char rcsid[] = "$NetBSD: targ.c,v 1.57 2012/06/12 19:21:51 joerg Exp $";
74
#include <sys/cdefs.h>
77
static char sccsid[] = "@(#)targ.c 8.2 (Berkeley) 3/19/94";
79
__RCSID("$NetBSD: targ.c,v 1.57 2012/06/12 19:21:51 joerg Exp $");
86
* Functions for maintaining the Lst allTargets. Target nodes are
87
* kept in two structures: a Lst, maintained by the list library, and a
88
* hash table, maintained by the hash library.
91
* Targ_Init Initialization procedure.
93
* Targ_End Cleanup the module
95
* Targ_List Return the list of all targets so far.
97
* Targ_NewGN Create a new GNode for the passed target
98
* (string). The node is *not* placed in the
99
* hash table, though all its fields are
102
* Targ_FindNode Find the node for a given target, creating
103
* and storing it if it doesn't exist and the
104
* flags are right (TARG_CREATE)
106
* Targ_FindList Given a list of names, find nodes for all
107
* of them. If a name doesn't exist and the
108
* TARG_NOCREATE flag was given, an error message
109
* is printed. Else, if a name doesn't exist,
110
* its node is created.
112
* Targ_Ignore Return TRUE if errors should be ignored when
113
* creating the given target.
115
* Targ_Silent Return TRUE if we should be silent when
116
* creating the given target.
118
* Targ_Precious Return TRUE if the target is precious and
119
* should not be removed if we are interrupted.
121
* Targ_Propagate Propagate information between related
122
* nodes. Should be called after the
123
* makefiles are parsed but before any
127
* Targ_PrintGraph Print out the entire graphm all variables
128
* and statistics for the directory cache. Should
129
* print something for suffixes, too, but...
139
static Lst allTargets; /* the list of all targets found so far */
141
static Lst allGNs; /* List of all the GNodes */
143
static Hash_Table targets; /* a hash table of same */
145
#define HTSIZE 191 /* initial size of hash table */
147
static int TargPrintOnlySrc(void *, void *);
148
static int TargPrintName(void *, void *);
150
static void TargFreeGN(void *);
152
static int TargPropagateCohort(void *, void *);
153
static int TargPropagateNode(void *, void *);
156
*-----------------------------------------------------------------------
158
* Initialize this module
164
* The allTargets list and the targets hash table are initialized
165
*-----------------------------------------------------------------------
170
allTargets = Lst_Init(FALSE);
171
Hash_InitTable(&targets, HTSIZE);
175
*-----------------------------------------------------------------------
177
* Finalize this module
183
* All lists and gnodes are cleared
184
*-----------------------------------------------------------------------
190
Lst_Destroy(allTargets, NULL);
192
Lst_Destroy(allGNs, TargFreeGN);
193
Hash_DeleteTable(&targets);
198
*-----------------------------------------------------------------------
200
* Return the list of all targets
203
* The list of all targets.
207
*-----------------------------------------------------------------------
216
*-----------------------------------------------------------------------
218
* Create and initialize a new graph node
221
* name the name to stick in the new node
224
* An initialized graph node with the name field filled with a copy
228
* The gnode is added to the list of all gnodes.
229
*-----------------------------------------------------------------------
232
Targ_NewGN(const char *name)
236
gn = bmake_malloc(sizeof(GNode));
237
gn->name = bmake_strdup(name);
240
if (name[0] == '-' && name[1] == 'l') {
246
gn->unmade_cohorts = 0;
247
gn->cohort_num[0] = 0;
248
gn->centurion = NULL;
254
gn->iParents = Lst_Init(FALSE);
255
gn->cohorts = Lst_Init(FALSE);
256
gn->parents = Lst_Init(FALSE);
257
gn->children = Lst_Init(FALSE);
258
gn->order_pred = Lst_Init(FALSE);
259
gn->order_succ = Lst_Init(FALSE);
260
Hash_InitTable(&gn->context, 0);
261
gn->commands = Lst_Init(FALSE);
268
allGNs = Lst_Init(FALSE);
269
Lst_AtEnd(allGNs, gn);
277
*-----------------------------------------------------------------------
286
*-----------------------------------------------------------------------
289
TargFreeGN(void *gnp)
291
GNode *gn = (GNode *)gnp;
299
/* gn->fname points to name allocated when file was opened, don't free */
301
Lst_Destroy(gn->iParents, NULL);
302
Lst_Destroy(gn->cohorts, NULL);
303
Lst_Destroy(gn->parents, NULL);
304
Lst_Destroy(gn->children, NULL);
305
Lst_Destroy(gn->order_succ, NULL);
306
Lst_Destroy(gn->order_pred, NULL);
307
Hash_DeleteTable(&gn->context);
308
Lst_Destroy(gn->commands, NULL);
315
*-----------------------------------------------------------------------
317
* Find a node in the list using the given name for matching
320
* name the name to find
321
* flags flags governing events when target not
325
* The node in the list if it was. If it wasn't, return NULL of
326
* flags was TARG_NOCREATE or the newly created and initialized node
327
* if it was TARG_CREATE
330
* Sometimes a node is created and added to the list
331
*-----------------------------------------------------------------------
334
Targ_FindNode(const char *name, int flags)
336
GNode *gn; /* node in that element */
337
Hash_Entry *he = NULL; /* New or used hash entry for node */
338
Boolean isNew; /* Set TRUE if Hash_CreateEntry had to create */
339
/* an entry for the node */
341
if (!(flags & (TARG_CREATE | TARG_NOHASH))) {
342
he = Hash_FindEntry(&targets, name);
345
return (GNode *)Hash_GetValue(he);
348
if (!(flags & TARG_NOHASH)) {
349
he = Hash_CreateEntry(&targets, name, &isNew);
351
return (GNode *)Hash_GetValue(he);
354
gn = Targ_NewGN(name);
355
if (!(flags & TARG_NOHASH))
356
Hash_SetValue(he, gn);
357
Var_Append(".ALLTARGETS", name, VAR_GLOBAL);
358
(void)Lst_AtEnd(allTargets, gn);
360
gn->flags |= FROM_DEPEND;
365
*-----------------------------------------------------------------------
367
* Make a complete list of GNodes from the given list of names
370
* name list of names to find
371
* flags flags used if no node is found for a given name
374
* A complete list of graph nodes corresponding to all instances of all
375
* the names in names.
378
* If flags is TARG_CREATE, nodes will be created for all names in
379
* names which do not yet have graph nodes. If flags is TARG_NOCREATE,
380
* an error message will be printed for each name which can't be found.
381
* -----------------------------------------------------------------------
384
Targ_FindList(Lst names, int flags)
386
Lst nodes; /* result list */
387
LstNode ln; /* name list element */
388
GNode *gn; /* node in tLn */
391
nodes = Lst_Init(FALSE);
393
if (Lst_Open(names) == FAILURE) {
396
while ((ln = Lst_Next(names)) != NULL) {
397
name = (char *)Lst_Datum(ln);
398
gn = Targ_FindNode(name, flags);
401
* Note: Lst_AtEnd must come before the Lst_Concat so the nodes
402
* are added to the list in the order in which they were
403
* encountered in the makefile.
405
(void)Lst_AtEnd(nodes, gn);
406
} else if (flags == TARG_NOCREATE) {
407
Error("\"%s\" -- target unknown.", name);
415
*-----------------------------------------------------------------------
417
* Return true if should ignore errors when creating gn
420
* gn node to check for
423
* TRUE if should ignore errors
427
*-----------------------------------------------------------------------
430
Targ_Ignore(GNode *gn)
432
if (ignoreErrors || gn->type & OP_IGNORE) {
440
*-----------------------------------------------------------------------
442
* Return true if be silent when creating gn
445
* gn node to check for
448
* TRUE if should be silent
452
*-----------------------------------------------------------------------
455
Targ_Silent(GNode *gn)
457
if (beSilent || gn->type & OP_SILENT) {
465
*-----------------------------------------------------------------------
467
* See if the given target is precious
470
* gn the node to check
473
* TRUE if it is precious. FALSE otherwise
477
*-----------------------------------------------------------------------
480
Targ_Precious(GNode *gn)
482
if (allPrecious || (gn->type & (OP_PRECIOUS|OP_DOUBLEDEP))) {
489
/******************* DEBUG INFO PRINTING ****************/
491
static GNode *mainTarg; /* the main target, as set by Targ_SetMain */
493
*-----------------------------------------------------------------------
495
* Set our idea of the main target we'll be creating. Used for
499
* gn The main target we'll create
505
* "mainTarg" is set to the main target's node.
506
*-----------------------------------------------------------------------
509
Targ_SetMain(GNode *gn)
515
TargPrintName(void *gnp, void *pflags MAKE_ATTR_UNUSED)
517
GNode *gn = (GNode *)gnp;
519
fprintf(debug_file, "%s%s ", gn->name, gn->cohort_num);
526
Targ_PrintCmd(void *cmd, void *dummy)
528
fprintf(debug_file, "\t%s\n", (char *)cmd);
529
return (dummy ? 0 : 0);
533
*-----------------------------------------------------------------------
535
* Format a modification time in some reasonable way and return it.
538
* The time reformatted.
541
* The time is placed in a static area, so it is overwritten
544
*-----------------------------------------------------------------------
547
Targ_FmtTime(time_t tm)
550
static char buf[128];
552
parts = localtime(&tm);
553
(void)strftime(buf, sizeof buf, "%k:%M:%S %b %d, %Y", parts);
558
*-----------------------------------------------------------------------
560
* Print out a type field giving only those attributes the user can
567
*-----------------------------------------------------------------------
570
Targ_PrintType(int type)
574
#define PRINTBIT(attr) case CONCAT(OP_,attr): fprintf(debug_file, "." #attr " "); break
575
#define PRINTDBIT(attr) case CONCAT(OP_,attr): if (DEBUG(TARG))fprintf(debug_file, "." #attr " "); break
580
tbit = 1 << (ffs(type) - 1);
595
/*XXX: MEMBER is defined, so CONCAT(OP_,MEMBER) gives OP_"%" */
596
case OP_MEMBER: if (DEBUG(TARG))fprintf(debug_file, ".MEMBER "); break;
605
made_name(enum enum_made made)
608
case UNMADE: return "unmade";
609
case DEFERRED: return "deferred";
610
case REQUESTED: return "requested";
611
case BEINGMADE: return "being made";
612
case MADE: return "made";
613
case UPTODATE: return "up-to-date";
614
case ERROR: return "error when made";
615
case ABORTED: return "aborted";
616
default: return "unknown enum_made value";
621
*-----------------------------------------------------------------------
623
* print the contents of a node
624
*-----------------------------------------------------------------------
627
Targ_PrintNode(void *gnp, void *passp)
629
GNode *gn = (GNode *)gnp;
630
int pass = passp ? *(int *)passp : 0;
632
fprintf(debug_file, "# %s%s, flags %x, type %x, made %d\n",
633
gn->name, gn->cohort_num, gn->flags, gn->type, gn->made);
637
if (!OP_NOP(gn->type)) {
638
fprintf(debug_file, "#\n");
639
if (gn == mainTarg) {
640
fprintf(debug_file, "# *** MAIN TARGET ***\n");
644
fprintf(debug_file, "# %d unmade children\n", gn->unmade);
646
fprintf(debug_file, "# No unmade children\n");
648
if (! (gn->type & (OP_JOIN|OP_USE|OP_USEBEFORE|OP_EXEC))) {
649
if (gn->mtime != 0) {
650
fprintf(debug_file, "# last modified %s: %s\n",
651
Targ_FmtTime(gn->mtime),
652
made_name(gn->made));
653
} else if (gn->made != UNMADE) {
654
fprintf(debug_file, "# non-existent (maybe): %s\n",
655
made_name(gn->made));
657
fprintf(debug_file, "# unmade\n");
660
if (!Lst_IsEmpty (gn->iParents)) {
661
fprintf(debug_file, "# implicit parents: ");
662
Lst_ForEach(gn->iParents, TargPrintName, NULL);
663
fprintf(debug_file, "\n");
667
fprintf(debug_file, "# %d unmade children\n", gn->unmade);
669
if (!Lst_IsEmpty (gn->parents)) {
670
fprintf(debug_file, "# parents: ");
671
Lst_ForEach(gn->parents, TargPrintName, NULL);
672
fprintf(debug_file, "\n");
674
if (!Lst_IsEmpty (gn->order_pred)) {
675
fprintf(debug_file, "# order_pred: ");
676
Lst_ForEach(gn->order_pred, TargPrintName, NULL);
677
fprintf(debug_file, "\n");
679
if (!Lst_IsEmpty (gn->order_succ)) {
680
fprintf(debug_file, "# order_succ: ");
681
Lst_ForEach(gn->order_succ, TargPrintName, NULL);
682
fprintf(debug_file, "\n");
685
fprintf(debug_file, "%-16s", gn->name);
686
switch (gn->type & OP_OPMASK) {
688
fprintf(debug_file, ": "); break;
690
fprintf(debug_file, "! "); break;
692
fprintf(debug_file, ":: "); break;
694
Targ_PrintType(gn->type);
695
Lst_ForEach(gn->children, TargPrintName, NULL);
696
fprintf(debug_file, "\n");
697
Lst_ForEach(gn->commands, Targ_PrintCmd, NULL);
698
fprintf(debug_file, "\n\n");
699
if (gn->type & OP_DOUBLEDEP) {
700
Lst_ForEach(gn->cohorts, Targ_PrintNode, &pass);
707
*-----------------------------------------------------------------------
708
* TargPrintOnlySrc --
709
* Print only those targets that are just a source.
715
* The name of each file is printed preceded by #\t
717
*-----------------------------------------------------------------------
720
TargPrintOnlySrc(void *gnp, void *dummy MAKE_ATTR_UNUSED)
722
GNode *gn = (GNode *)gnp;
723
if (!OP_NOP(gn->type))
726
fprintf(debug_file, "#\t%s [%s] ",
727
gn->name, gn->path ? gn->path : gn->name);
728
Targ_PrintType(gn->type);
729
fprintf(debug_file, "\n");
735
*-----------------------------------------------------------------------
737
* print the entire graph. heh heh
740
* pass Which pass this is. 1 => no processing
741
* 2 => processing done
748
*-----------------------------------------------------------------------
751
Targ_PrintGraph(int pass)
753
fprintf(debug_file, "#*** Input graph:\n");
754
Lst_ForEach(allTargets, Targ_PrintNode, &pass);
755
fprintf(debug_file, "\n\n");
756
fprintf(debug_file, "#\n# Files that are only sources:\n");
757
Lst_ForEach(allTargets, TargPrintOnlySrc, NULL);
758
fprintf(debug_file, "#*** Global Variables:\n");
759
Var_Dump(VAR_GLOBAL);
760
fprintf(debug_file, "#*** Command-line Variables:\n");
762
fprintf(debug_file, "\n");
763
Dir_PrintDirectories();
764
fprintf(debug_file, "\n");
769
*-----------------------------------------------------------------------
770
* TargPropagateNode --
771
* Propagate information from a single node to related nodes if
775
* gnp The node that we are processing.
778
* Always returns 0, for the benefit of Lst_ForEach().
781
* Information is propagated from this node to cohort or child
784
* If the node was defined with "::", then TargPropagateCohort()
785
* will be called for each cohort node.
787
* If the node has recursive predecessors, then
788
* TargPropagateRecpred() will be called for each recursive
790
*-----------------------------------------------------------------------
793
TargPropagateNode(void *gnp, void *junk MAKE_ATTR_UNUSED)
795
GNode *gn = (GNode *)gnp;
797
if (gn->type & OP_DOUBLEDEP)
798
Lst_ForEach(gn->cohorts, TargPropagateCohort, gnp);
803
*-----------------------------------------------------------------------
804
* TargPropagateCohort --
805
* Propagate some bits in the type mask from a node to
806
* a related cohort node.
809
* cnp The node that we are processing.
810
* gnp Another node that has cnp as a cohort.
813
* Always returns 0, for the benefit of Lst_ForEach().
816
* cnp's type bitmask is modified to incorporate some of the
817
* bits from gnp's type bitmask. (XXX need a better explanation.)
818
*-----------------------------------------------------------------------
821
TargPropagateCohort(void *cgnp, void *pgnp)
823
GNode *cgn = (GNode *)cgnp;
824
GNode *pgn = (GNode *)pgnp;
826
cgn->type |= pgn->type & ~OP_OPMASK;
831
*-----------------------------------------------------------------------
833
* Propagate information between related nodes. Should be called
834
* after the makefiles are parsed but before any action is taken.
840
* Information is propagated between related nodes throughout the
842
*-----------------------------------------------------------------------
847
Lst_ForEach(allTargets, TargPropagateNode, NULL);