-
Notifications
You must be signed in to change notification settings - Fork 138
/
checkdepend.t
331 lines (258 loc) · 8.29 KB
/
checkdepend.t
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
#! perl
# Copyright (C) 2009-2010, Parrot Foundation.
use strict;
use warnings;
use Cwd qw(abs_path getcwd realpath);
use Fatal qw(open);
use File::Find;
use File::Spec;
use Test::More;
use lib qw( lib );
use Parrot::Config;
=head1 NAME
t/src/checkdepend.t
=head1 DESCRIPTION
A script to check that every file has makefile deps on its includes.
checkdepend.pl [--dump]
If called with C<--dump>, no tests are run, and the pre-processed makefile
is dumped (in lieu of having C<cc>'s C<-E> for C<make>. This option is only
intended to be used by developers examining the build process.
The test's output shows the extra dependencies recorded for "got", and the
missing dependencies for "expected" - any dependencies that match up exactly
are not reported on. The number in parentheses indicates how many were found.
(Useful for identifying when a requirement is included multiple times.)
=head1 REQUIREMENTS
A built parrot (Configure and make) to generate all files so we can analyze
them. (That's why it's in t/src/ instead of t/codingstd)
=head1 BUGS
See L<http://trac.parrot.org/parrot/wiki/BuildTaskList>. Only checks C<.c>
and C<.h> files at the moment.
=cut
if (! -e 'Makefile') {
plan(skip_all =>
'no Makefile found; This test requires a full build for analysis.');
exit;
}
my @incfiles = [];
find( { wanted => \&wanted, no_chdir => 1 },
qw/src compilers include frontend/ );
our %deps;
foreach my $file (sort grep /\.[hc]$/, @incfiles) {
# skip pmcs - we don't handle inheritance correctly
next if $file =~ m{^src/(?:dyn)?pmc/};
next if ($file eq 'src/nci/core_thunks.c' and
! defined $Parrot::Config::PConfig_Temp{PARROT_HAS_CORE_NCI_THUNKS});
next if ($file eq 'src/nci/extra_thunks.c' and
! defined $Parrot::Config::PConfig_Temp{PARROT_HAS_EXTRA_NCI_THUNKS});
open my $fh, '<', $file;
my $guts;
{
local $/;
$guts = <$fh>;
}
# Ignore anything inside a c-style comment.
$guts =~ s{\Q/*\E.*?\Q*/}{}gm;
my @includes = $guts =~ m/# *include "(.*)"/g;
# Canonicalize each of these includes.
$deps{$file} = [ ];
foreach my $include (@includes) {
my $found;
my @include_dirs;
push @include_dirs, (File::Spec->splitpath($file))[1];
push @include_dirs, 'include';
push @include_dirs, 'include/pmc';
for my $path (@include_dirs) {
next if $found;
my $make_dep = File::Spec->catfile($path, $include);
if (defined($make_dep) && -f $make_dep) {
$make_dep = collapse_path($make_dep);
push @{$deps{$file}}, $make_dep;
$found = 1;
}
}
diag "couldn't find $include, included from $file"
unless $found;
}
# always require an explicit .o -> .c dep. This is lazy and not always
# needed. However, missing it when it is needed causes pain.
if ($file =~ /\.c$/) {
push @{$deps{$file}}, $file;
}
}
sub get_rules {
my ($filename, $rules) = @_;
open my $mf, '<', "$filename";
my $global_line_num = @$rules;
my $file_line_num = 1;
my $escape_start = 1;
foreach (<$mf>) {
my $line = $_;
chomp $line;
if ($_ =~ /^include\s+(.*)$/m) {
get_rules($1, $rules);
$global_line_num = @$rules;
$file_line_num++;
}
else {
$rules->[$global_line_num] =
{
filename => $filename,
line => $line,
line_num => $file_line_num,
};
# Convert all \-newline continuations into single lines for ease of
# processing. Leave blank lines to keep line numbers accurate.
if (exists $rules->[$escape_start]{line} &&
$rules->[$escape_start]{line} !~ /\\$/ &&
$rules->[$global_line_num]{line} =~ /\\$/) {
$escape_start = $global_line_num;
}
if ($rules->[$escape_start]{line} && $rules->[$escape_start]{line} =~ /\\$/ &&
$escape_start != $global_line_num) {
$rules->[$escape_start]{line} =~ s/\\$//;
$rules->[$escape_start]{line} .= $rules->[$global_line_num]{line};
$rules->[$global_line_num]{line} = '';
}
$file_line_num++;
$global_line_num++;
}
}
close $mf;
}
our $rules = [];
get_rules('Makefile', $rules);
#expand all variables
our %vars;
foreach (@$rules) {
#expand any known variables
while ($_->{line} =~ /\$\(([A-Z_]+)\)/) {
my $var_name = $1;
if (exists $vars{$var_name}) {
$_->{line} =~ s/\$\($var_name\)/$vars{$var_name}/g;
}
else {
$_->{line} =~ s/\$\($var_name\)//g;
}
}
#store any new definitions
if ($_->{line} =~ /^(\w+)\s+=\s+(.*)$/) {
$vars{$1} = $2;
}
}
if (@ARGV && $ARGV[0] eq '--dump') {
print "$_->{line}\n" for (@$rules);
exit 0;
}
my $test_count = grep {/\.(c)$/} (keys %deps);
plan( tests => $test_count );
#foreach my $header (sort grep {/\.h$/} (keys %deps)) {
# # static headers shouldn't depend on anything else.
# if ($rules =~ /^$header\s*:\s*(.*)\s*$/m) {
# #is("", $1, "$header should have no dependencies");
# }
#}
my @files = keys %deps;
@files = @ARGV if @ARGV;
check_files($rules, \@files, '.c', $vars{O});
sub check_files {
my ($rules, $possible_files, $src_ext, $obj_ext) = @_;
foreach my $file (sort grep {/$src_ext$/} @$possible_files) {
my ($active_makefile, $active_line_num);
my $rule = $file;
$rule =~ s/$src_ext$//;
#find the applicable rule for this file
my $rule_deps = '';
for (@$rules) {
if ($_->{line} =~ /^$rule$obj_ext\s*:\s*(.*)\s*$/) {
$rule_deps = $1;
$active_makefile = $_->{filename};
$active_line_num = $_->{line_num};
}
last if $rule_deps;
}
my $extra_info = "(no rule found for this file)";
if ($rule_deps) {
$extra_info = "($active_makefile: line $active_line_num)";
}
my @rule_deps = split /\s+/, $rule_deps;
my @expected_deps = (get_deps($file));
is_list_same(\@rule_deps, \@expected_deps, "$file $extra_info.");
}
}
sub collapse_path {
my $path = shift;
return $path unless defined $path;
my $cwd = getcwd();
$path = abs_path($path);
return $path unless defined $path;
$path =~ s/^\Q$cwd\E\///;
return $path;
}
sub get_deps {
my $file = shift;
my %all_deps;
if (! exists $deps{$file}) {
return;
}
# add explicit deps
my @pending_deps = @{$deps{$file}};
while (@pending_deps) {
my $dep = shift @pending_deps;
if (!exists $all_deps{$dep}) {
$all_deps{$dep} = 1;
if (exists $deps{$dep}) {
push @pending_deps, @{$deps{$dep}};
}
}
}
return keys %all_deps;
}
# I'd rather use Test::Differences, but this lets us skip a dependency.
sub is_list_same {
my $got = shift;
my $exp = shift;
my $test = shift;
# keep track of the number of times something appears to
# avoid redundant includes)
my(%got, %exp);
for my $file (@$got) { $got{$file}++ };
for my $file (@$exp) { $exp{$file}++ };
# Remove any elements found in both
my @gots = keys %got;
foreach my $file (@gots) {
if (exists $exp{$file}) {
if ($exp{$file} == $got{$file}) {
delete $got{$file};
delete $exp{$file};
}
}
}
my $extras = scalar(keys %got);
my $missing = scalar(keys %exp);
if ($extras == 0 && $missing == 0) {
pass($test);
return;
}
my $got_msg = "";
for my $file (keys %got) {
$got_msg .= "$file($got{$file})\n";
}
my $exp_msg = "";
for my $file (keys %exp) {
$exp_msg .= "$file($exp{$file})\n";
}
local $Test::Builder::Level = $Test::Builder::Level + 1;
is ($got_msg, $exp_msg, $test);
return;
}
sub wanted {
if ($File::Find::name =~ /\.(c|h)$/) {
push @incfiles, $File::Find::name;
}
}
# Local Variables:
# mode: cperl
# cperl-indent-level: 4
# fill-column: 100
# End:
# vim: expandtab shiftwidth=4: