1 /* Pattern and suffix rule internals for GNU Make.
2 Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997,
3 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software
5 This file is part of GNU Make.
7 GNU Make is free software; you can redistribute it and/or modify it under the
8 terms of the GNU General Public License as published by the Free Software
9 Foundation; either version 3 of the License, or (at your option) any later
12 GNU Make is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License along with
17 this program. If not, see <http://www.gnu.org/licenses/>. */
30 static void freerule (struct rule
*rule
, struct rule
*lastrule
);
32 /* Chain of all pattern rules. */
34 struct rule
*pattern_rules
;
36 /* Pointer to last rule in the chain, so we can add onto the end. */
38 struct rule
*last_pattern_rule
;
40 /* Number of rules in the chain. */
42 unsigned int num_pattern_rules
;
44 /* Maximum number of target patterns of any pattern rule. */
46 unsigned int max_pattern_targets
;
48 /* Maximum number of dependencies of any pattern rule. */
50 unsigned int max_pattern_deps
;
52 /* Maximum length of the name of a dependencies of any pattern rule. */
54 unsigned int max_pattern_dep_length
;
56 /* Pointer to structure for the file .SUFFIXES
57 whose dependencies are the suffixes to be searched. */
59 struct file
*suffix_file
;
61 /* Maximum length of a suffix. */
63 unsigned int maxsuffix
;
65 /* Compute the maximum dependency length and maximum number of
66 dependencies of all implicit rules. Also sets the subdir
67 flag for a rule when appropriate, possibly removing the rule
68 completely when appropriate. */
71 count_implicit_rule_limits (void)
75 struct rule
*rule
, *lastrule
;
77 num_pattern_rules
= max_pattern_targets
= max_pattern_deps
= 0;
78 max_pattern_dep_length
= 0;
86 unsigned int ndeps
= 0;
88 struct rule
*next
= rule
->next
;
92 if (rule
->num
> max_pattern_targets
)
93 max_pattern_targets
= rule
->num
;
95 for (dep
= rule
->deps
; dep
!= 0; dep
= dep
->next
)
97 const char *dname
= dep_name (dep
);
98 unsigned int len
= strlen (dname
);
101 const char *p
= strrchr (dname
, ']');
104 p
= strrchr (dname
, ':');
105 p2
= p
!= 0 ? strchr (dname
, '%') : 0;
107 const char *p
= strrchr (dname
, '/');
108 const char *p2
= p
!= 0 ? strchr (dname
, '%') : 0;
112 if (len
> max_pattern_dep_length
)
113 max_pattern_dep_length
= len
;
115 if (p
!= 0 && p2
> p
)
117 /* There is a slash before the % in the dep name.
118 Extract the directory name. */
121 if (p
- dname
> namelen
)
124 name
= xrealloc (name
, namelen
+ 1);
126 memcpy (name
, dname
, p
- dname
);
127 name
[p
- dname
] = '\0';
129 /* In the deps of an implicit rule the `changed' flag
130 actually indicates that the dependency is in a
131 nonexistent subdirectory. */
133 dep
->changed
= !dir_file_exists_p (name
, "");
136 /* This dependency does not reside in a subdirectory. */
140 if (ndeps
> max_pattern_deps
)
141 max_pattern_deps
= ndeps
;
151 /* Create a pattern rule from a suffix rule.
152 TARGET is the target suffix; SOURCE is the source suffix.
153 CMDS are the commands.
154 If TARGET is nil, it means the target pattern should be `(%.o)'.
155 If SOURCE is nil, it means there should be no deps. */
158 convert_suffix_rule (const char *target
, const char *source
,
159 struct commands
*cmds
)
161 const char **names
, **percents
;
164 names
= xmalloc (sizeof (const char *));
165 percents
= xmalloc (sizeof (const char *));
169 /* Special case: TARGET being nil means we are defining a `.X.a' suffix
170 rule; the target pattern is always `(%.o)'. */
172 *names
= strcache_add_len ("(%.obj)", 7);
174 *names
= strcache_add_len ("(%.o)", 5);
176 *percents
= *names
+ 1;
180 /* Construct the target name. */
181 unsigned int len
= strlen (target
);
182 char *p
= alloca (1 + len
+ 1);
184 memcpy (p
+ 1, target
, len
+ 1);
185 *names
= strcache_add_len (p
, len
+ 1);
193 /* Construct the dependency name. */
194 unsigned int len
= strlen (source
);
195 char *p
= alloca (1 + len
+ 1);
197 memcpy (p
+ 1, source
, len
+ 1);
199 deps
->name
= strcache_add_len (p
, len
+ 1);
202 create_pattern_rule (names
, percents
, 1, 0, deps
, cmds
, 0);
205 /* Convert old-style suffix rules to pattern rules.
206 All rules for the suffixes on the .SUFFIXES list are converted and added to
207 the chain of pattern rules. */
210 convert_to_pattern (void)
215 /* We will compute every potential suffix rule (.x.y) from the list of
216 suffixes in the .SUFFIXES target's dependencies and see if it exists.
217 First find the longest of the suffixes. */
220 for (d
= suffix_file
->deps
; d
!= 0; d
= d
->next
)
222 unsigned int l
= strlen (dep_name (d
));
227 /* Space to construct the suffix rule target name. */
228 rulename
= alloca ((maxsuffix
* 2) + 1);
230 for (d
= suffix_file
->deps
; d
!= 0; d
= d
->next
)
234 /* Make a rule that is just the suffix, with no deps or commands.
235 This rule exists solely to disqualify match-anything rules. */
236 convert_suffix_rule (dep_name (d
), 0, 0);
238 if (d
->file
->cmds
!= 0)
239 /* Record a pattern for this suffix's null-suffix rule. */
240 convert_suffix_rule ("", dep_name (d
), d
->file
->cmds
);
242 /* Add every other suffix to this one and see if it exists as a
244 slen
= strlen (dep_name (d
));
245 memcpy (rulename
, dep_name (d
), slen
);
247 for (d2
= suffix_file
->deps
; d2
!= 0; d2
= d2
->next
)
252 s2len
= strlen (dep_name (d2
));
254 /* Can't build something from itself. */
255 if (slen
== s2len
&& streq (dep_name (d
), dep_name (d2
)))
258 memcpy (rulename
+ slen
, dep_name (d2
), s2len
+ 1);
259 f
= lookup_file (rulename
);
260 if (f
== 0 || f
->cmds
== 0)
263 if (s2len
== 2 && rulename
[slen
] == '.' && rulename
[slen
+ 1] == 'a')
264 /* A suffix rule `.X.a:' generates the pattern rule `(%.o): %.X'.
265 It also generates a normal `%.a: %.X' rule below. */
266 convert_suffix_rule (NULL
, /* Indicates `(%.o)'. */
270 /* The suffix rule `.X.Y:' is converted
271 to the pattern rule `%.Y: %.X'. */
272 convert_suffix_rule (dep_name (d2
), dep_name (d
), f
->cmds
);
278 /* Install the pattern rule RULE (whose fields have been filled in) at the end
279 of the list (so that any rules previously defined will take precedence).
280 If this rule duplicates a previous one (identical target and dependencies),
281 the old one is replaced if OVERRIDE is nonzero, otherwise this new one is
282 thrown out. When an old rule is replaced, the new one is put at the end of
283 the list. Return nonzero if RULE is used; zero if not. */
286 new_pattern_rule (struct rule
*rule
, int override
)
288 struct rule
*r
, *lastrule
;
296 /* Search for an identical rule. */
298 for (r
= pattern_rules
; r
!= 0; lastrule
= r
, r
= r
->next
)
299 for (i
= 0; i
< rule
->num
; ++i
)
301 for (j
= 0; j
< r
->num
; ++j
)
302 if (!streq (rule
->targets
[i
], r
->targets
[j
]))
304 /* If all the targets matched... */
308 for (d
= rule
->deps
, d2
= r
->deps
;
309 d
!= 0 && d2
!= 0; d
= d
->next
, d2
= d2
->next
)
310 if (!streq (dep_name (d
), dep_name (d2
)))
312 if (d
== 0 && d2
== 0)
314 /* All the dependencies matched. */
317 /* Remove the old rule. */
318 freerule (r
, lastrule
);
319 /* Install the new one. */
320 if (pattern_rules
== 0)
321 pattern_rules
= rule
;
323 last_pattern_rule
->next
= rule
;
324 last_pattern_rule
= rule
;
326 /* We got one. Stop looking. */
331 /* The old rule stays intact. Destroy the new one. */
332 freerule (rule
, (struct rule
*) 0);
343 /* There was no rule to replace. */
344 if (pattern_rules
== 0)
345 pattern_rules
= rule
;
347 last_pattern_rule
->next
= rule
;
348 last_pattern_rule
= rule
;
355 /* Install an implicit pattern rule based on the three text strings
356 in the structure P points to. These strings come from one of
357 the arrays of default implicit pattern rules.
358 TERMINAL specifies what the `terminal' field of the rule should be. */
361 install_pattern_rule (struct pspec
*p
, int terminal
)
366 r
= xmalloc (sizeof (struct rule
));
369 r
->targets
= xmalloc (sizeof (const char *));
370 r
->suffixes
= xmalloc (sizeof (const char *));
371 r
->lens
= xmalloc (sizeof (unsigned int));
373 r
->lens
[0] = strlen (p
->target
);
374 r
->targets
[0] = p
->target
;
375 r
->suffixes
[0] = find_percent_cached (&r
->targets
[0]);
376 assert (r
->suffixes
[0] != NULL
);
380 r
->deps
= PARSE_FILE_SEQ (&ptr
, struct dep
, '\0', NULL
, 0);
382 if (new_pattern_rule (r
, 0))
384 r
->terminal
= terminal
;
385 r
->cmds
= xmalloc (sizeof (struct commands
));
386 r
->cmds
->fileinfo
.filenm
= 0;
387 r
->cmds
->fileinfo
.lineno
= 0;
388 /* These will all be string literals, but we malloc space for them
389 anyway because somebody might want to free them later. */
390 r
->cmds
->commands
= xstrdup (p
->commands
);
391 r
->cmds
->command_lines
= 0;
396 /* Free all the storage used in RULE and take it out of the
397 pattern_rules chain. LASTRULE is the rule whose next pointer
401 freerule (struct rule
*rule
, struct rule
*lastrule
)
403 struct rule
*next
= rule
->next
;
409 struct dep
*t
= dep
->next
;
414 free (rule
->targets
);
415 free (rule
->suffixes
);
418 /* We can't free the storage for the commands because there
419 are ways that they could be in more than one place:
420 * If the commands came from a suffix rule, they could also be in
421 the `struct file's for other suffix rules or plain targets given
422 on the same makefile line.
423 * If two suffixes that together make a two-suffix rule were each
424 given twice in the .SUFFIXES list, and in the proper order, two
425 identical pattern rules would be created and the second one would
426 be discarded here, but both would contain the same `struct commands'
427 pointer from the `struct file' for the suffix rule. */
431 if (pattern_rules
== rule
)
435 pattern_rules
= next
;
436 else if (lastrule
!= 0)
437 lastrule
->next
= next
;
438 if (last_pattern_rule
== rule
)
439 last_pattern_rule
= lastrule
;
442 /* Create a new pattern rule with the targets in the nil-terminated array
443 TARGETS. TARGET_PERCENTS is an array of pointers to the % in each element
444 of TARGETS. N is the number of items in the array (not counting the nil
445 element). The new rule has dependencies DEPS and commands from COMMANDS.
446 It is a terminal rule if TERMINAL is nonzero. This rule overrides
447 identical rules with different commands if OVERRIDE is nonzero.
449 The storage for TARGETS and its elements and TARGET_PERCENTS is used and
450 must not be freed until the rule is destroyed. */
453 create_pattern_rule (const char **targets
, const char **target_percents
,
454 unsigned int n
, int terminal
, struct dep
*deps
,
455 struct commands
*commands
, int override
)
458 struct rule
*r
= xmalloc (sizeof (struct rule
));
463 r
->targets
= targets
;
464 r
->suffixes
= target_percents
;
465 r
->lens
= xmalloc (n
* sizeof (unsigned int));
467 for (i
= 0; i
< n
; ++i
)
469 r
->lens
[i
] = strlen (targets
[i
]);
470 assert (r
->suffixes
[i
] != NULL
);
474 if (new_pattern_rule (r
, override
))
475 r
->terminal
= terminal
;
478 /* Print the data base of rules. */
480 static void /* Useful to call from gdb. */
481 print_rule (struct rule
*r
)
485 for (i
= 0; i
< r
->num
; ++i
)
487 fputs (r
->targets
[i
], stdout
);
488 putchar ((i
+ 1 == r
->num
) ? ':' : ' ');
493 print_prereqs (r
->deps
);
496 print_commands (r
->cmds
);
500 print_rule_data_base (void)
502 unsigned int rules
, terminal
;
505 puts (_("\n# Implicit Rules"));
507 rules
= terminal
= 0;
508 for (r
= pattern_rules
; r
!= 0; r
= r
->next
)
520 puts (_("\n# No implicit rules."));
523 printf (_("\n# %u implicit rules, %u"), rules
, terminal
);
525 printf (" (%.1f%%)", (double) terminal
/ (double) rules
* 100.0);
528 int f
= (terminal
* 1000 + 5) / rules
;
529 printf (" (%d.%d%%)", f
/10, f
%10);
532 puts (_(" terminal."));
535 if (num_pattern_rules
!= rules
)
537 /* This can happen if a fatal error was detected while reading the
538 makefiles and thus count_implicit_rule_limits wasn't called yet. */
539 if (num_pattern_rules
!= 0)
540 fatal (NILF
, _("BUG: num_pattern_rules is wrong! %u != %u"),
541 num_pattern_rules
, rules
);