Mercurial > dropbear
comparison libtommath/helper.pl @ 1739:13d834efc376 fuzz
merge from main
author | Matt Johnston <matt@ucc.asn.au> |
---|---|
date | Thu, 15 Oct 2020 19:55:15 +0800 |
parents | 1051e4eea25a |
children |
comparison
equal
deleted
inserted
replaced
1562:768ebf737aa0 | 1739:13d834efc376 |
---|---|
1 #!/usr/bin/env perl | |
2 | |
3 use strict; | |
4 use warnings; | |
5 | |
6 use Getopt::Long; | |
7 use File::Find 'find'; | |
8 use File::Basename 'basename'; | |
9 use File::Glob 'bsd_glob'; | |
10 | |
11 sub read_file { | |
12 my $f = shift; | |
13 open my $fh, "<", $f or die "FATAL: read_rawfile() cannot open file '$f': $!"; | |
14 binmode $fh; | |
15 return do { local $/; <$fh> }; | |
16 } | |
17 | |
18 sub write_file { | |
19 my ($f, $data) = @_; | |
20 die "FATAL: write_file() no data" unless defined $data; | |
21 open my $fh, ">", $f or die "FATAL: write_file() cannot open file '$f': $!"; | |
22 binmode $fh; | |
23 print $fh $data or die "FATAL: write_file() cannot write to '$f': $!"; | |
24 close $fh or die "FATAL: write_file() cannot close '$f': $!"; | |
25 return; | |
26 } | |
27 | |
28 sub sanitize_comments { | |
29 my($content) = @_; | |
30 $content =~ s{/\*(.*?)\*/}{my $x=$1; $x =~ s/\w/x/g; "/*$x*/";}egs; | |
31 return $content; | |
32 } | |
33 | |
34 sub check_source { | |
35 my @all_files = ( | |
36 bsd_glob("Makefile*"), | |
37 bsd_glob("*.{h,c,sh,pl}"), | |
38 bsd_glob("*/*.{h,c,sh,pl}"), | |
39 ); | |
40 | |
41 my $fails = 0; | |
42 for my $file (sort @all_files) { | |
43 my $troubles = {}; | |
44 my $lineno = 1; | |
45 my $content = read_file($file); | |
46 $content = sanitize_comments $content; | |
47 push @{$troubles->{crlf_line_end}}, '?' if $content =~ /\r/; | |
48 for my $l (split /\n/, $content) { | |
49 push @{$troubles->{merge_conflict}}, $lineno if $l =~ /^(<<<<<<<|=======|>>>>>>>)([^<=>]|$)/; | |
50 push @{$troubles->{trailing_space}}, $lineno if $l =~ / $/; | |
51 push @{$troubles->{tab}}, $lineno if $l =~ /\t/ && basename($file) !~ /^makefile/i; | |
52 push @{$troubles->{non_ascii_char}}, $lineno if $l =~ /[^[:ascii:]]/; | |
53 push @{$troubles->{cpp_comment}}, $lineno if $file =~ /\.(c|h)$/ && ($l =~ /\s\/\// || $l =~ /\/\/\s/); | |
54 # we prefer using XMALLOC, XFREE, XREALLOC, XCALLOC ... | |
55 push @{$troubles->{unwanted_malloc}}, $lineno if $file =~ /^[^\/]+\.c$/ && $l =~ /\bmalloc\s*\(/; | |
56 push @{$troubles->{unwanted_realloc}}, $lineno if $file =~ /^[^\/]+\.c$/ && $l =~ /\brealloc\s*\(/; | |
57 push @{$troubles->{unwanted_calloc}}, $lineno if $file =~ /^[^\/]+\.c$/ && $l =~ /\bcalloc\s*\(/; | |
58 push @{$troubles->{unwanted_free}}, $lineno if $file =~ /^[^\/]+\.c$/ && $l =~ /\bfree\s*\(/; | |
59 # and we probably want to also avoid the following | |
60 push @{$troubles->{unwanted_memcpy}}, $lineno if $file =~ /^[^\/]+\.c$/ && $l =~ /\bmemcpy\s*\(/; | |
61 push @{$troubles->{unwanted_memset}}, $lineno if $file =~ /^[^\/]+\.c$/ && $l =~ /\bmemset\s*\(/; | |
62 push @{$troubles->{unwanted_memcpy}}, $lineno if $file =~ /^[^\/]+\.c$/ && $l =~ /\bmemcpy\s*\(/; | |
63 push @{$troubles->{unwanted_memmove}}, $lineno if $file =~ /^[^\/]+\.c$/ && $l =~ /\bmemmove\s*\(/; | |
64 push @{$troubles->{unwanted_memcmp}}, $lineno if $file =~ /^[^\/]+\.c$/ && $l =~ /\bmemcmp\s*\(/; | |
65 push @{$troubles->{unwanted_strcmp}}, $lineno if $file =~ /^[^\/]+\.c$/ && $l =~ /\bstrcmp\s*\(/; | |
66 push @{$troubles->{unwanted_strcpy}}, $lineno if $file =~ /^[^\/]+\.c$/ && $l =~ /\bstrcpy\s*\(/; | |
67 push @{$troubles->{unwanted_strncpy}}, $lineno if $file =~ /^[^\/]+\.c$/ && $l =~ /\bstrncpy\s*\(/; | |
68 push @{$troubles->{unwanted_clock}}, $lineno if $file =~ /^[^\/]+\.c$/ && $l =~ /\bclock\s*\(/; | |
69 push @{$troubles->{unwanted_qsort}}, $lineno if $file =~ /^[^\/]+\.c$/ && $l =~ /\bqsort\s*\(/; | |
70 push @{$troubles->{sizeof_no_brackets}}, $lineno if $file =~ /^[^\/]+\.c$/ && $l =~ /\bsizeof\s*[^\(]/; | |
71 if ($file =~ m|^[^\/]+\.c$| && $l =~ /^static(\s+[a-zA-Z0-9_]+)+\s+([a-zA-Z0-9_]+)\s*\(/) { | |
72 my $funcname = $2; | |
73 # static functions should start with s_ | |
74 push @{$troubles->{staticfunc_name}}, "$lineno($funcname)" if $funcname !~ /^s_/; | |
75 } | |
76 $lineno++; | |
77 } | |
78 for my $k (sort keys %$troubles) { | |
79 warn "[$k] $file line:" . join(",", @{$troubles->{$k}}) . "\n"; | |
80 $fails++; | |
81 } | |
82 } | |
83 | |
84 warn( $fails > 0 ? "check-source: FAIL $fails\n" : "check-source: PASS\n" ); | |
85 return $fails; | |
86 } | |
87 | |
88 sub check_comments { | |
89 my $fails = 0; | |
90 my $first_comment = <<'MARKER'; | |
91 /* LibTomMath, multiple-precision integer library -- Tom St Denis */ | |
92 /* SPDX-License-Identifier: Unlicense */ | |
93 MARKER | |
94 #my @all_files = (bsd_glob("*.{h,c}"), bsd_glob("*/*.{h,c}")); | |
95 my @all_files = (bsd_glob("*.{h,c}")); | |
96 for my $f (@all_files) { | |
97 my $txt = read_file($f); | |
98 if ($txt !~ /\Q$first_comment\E/s) { | |
99 warn "[first_comment] $f\n"; | |
100 $fails++; | |
101 } | |
102 } | |
103 warn( $fails > 0 ? "check-comments: FAIL $fails\n" : "check-comments: PASS\n" ); | |
104 return $fails; | |
105 } | |
106 | |
107 sub check_doc { | |
108 my $fails = 0; | |
109 my $tex = read_file('doc/bn.tex'); | |
110 my $tmh = read_file('tommath.h'); | |
111 my @functions = $tmh =~ /\n\s*[a-zA-Z0-9_* ]+?(mp_[a-z0-9_]+)\s*\([^\)]+\)\s*;/sg; | |
112 my @macros = $tmh =~ /\n\s*#define\s+([a-z0-9_]+)\s*\([^\)]+\)/sg; | |
113 for my $n (sort @functions) { | |
114 (my $nn = $n) =~ s/_/\\_/g; # mp_sub_d >> mp\_sub\_d | |
115 if ($tex !~ /index\Q{$nn}\E/) { | |
116 warn "[missing_doc_for_function] $n\n"; | |
117 $fails++ | |
118 } | |
119 } | |
120 for my $n (sort @macros) { | |
121 (my $nn = $n) =~ s/_/\\_/g; # mp_iszero >> mp\_iszero | |
122 if ($tex !~ /index\Q{$nn}\E/) { | |
123 warn "[missing_doc_for_macro] $n\n"; | |
124 $fails++ | |
125 } | |
126 } | |
127 warn( $fails > 0 ? "check_doc: FAIL $fails\n" : "check-doc: PASS\n" ); | |
128 return $fails; | |
129 } | |
130 | |
131 sub prepare_variable { | |
132 my ($varname, @list) = @_; | |
133 my $output = "$varname="; | |
134 my $len = length($output); | |
135 foreach my $obj (sort @list) { | |
136 $len = $len + length $obj; | |
137 $obj =~ s/\*/\$/; | |
138 if ($len > 100) { | |
139 $output .= "\\\n"; | |
140 $len = length $obj; | |
141 } | |
142 $output .= $obj . ' '; | |
143 } | |
144 $output =~ s/ $//; | |
145 return $output; | |
146 } | |
147 | |
148 sub prepare_msvc_files_xml { | |
149 my ($all, $exclude_re, $targets) = @_; | |
150 my $last = []; | |
151 my $depth = 2; | |
152 | |
153 # sort files in the same order as visual studio (ugly, I know) | |
154 my @parts = (); | |
155 for my $orig (@$all) { | |
156 my $p = $orig; | |
157 $p =~ s|/|/~|g; | |
158 $p =~ s|/~([^/]+)$|/$1|g; | |
159 my @l = map { sprintf "% -99s", $_ } split /\//, $p; | |
160 push @parts, [ $orig, join(':', @l) ]; | |
161 } | |
162 my @sorted = map { $_->[0] } sort { $a->[1] cmp $b->[1] } @parts; | |
163 | |
164 my $files = "<Files>\r\n"; | |
165 for my $full (@sorted) { | |
166 my @items = split /\//, $full; # split by '/' | |
167 $full =~ s|/|\\|g; # replace '/' bt '\' | |
168 shift @items; # drop first one (src) | |
169 pop @items; # drop last one (filename.ext) | |
170 my $current = \@items; | |
171 if (join(':', @$current) ne join(':', @$last)) { | |
172 my $common = 0; | |
173 $common++ while ($last->[$common] && $current->[$common] && $last->[$common] eq $current->[$common]); | |
174 my $back = @$last - $common; | |
175 if ($back > 0) { | |
176 $files .= ("\t" x --$depth) . "</Filter>\r\n" for (1..$back); | |
177 } | |
178 my $fwd = [ @$current ]; splice(@$fwd, 0, $common); | |
179 for my $i (0..scalar(@$fwd) - 1) { | |
180 $files .= ("\t" x $depth) . "<Filter\r\n"; | |
181 $files .= ("\t" x $depth) . "\tName=\"$fwd->[$i]\"\r\n"; | |
182 $files .= ("\t" x $depth) . "\t>\r\n"; | |
183 $depth++; | |
184 } | |
185 $last = $current; | |
186 } | |
187 $files .= ("\t" x $depth) . "<File\r\n"; | |
188 $files .= ("\t" x $depth) . "\tRelativePath=\"$full\"\r\n"; | |
189 $files .= ("\t" x $depth) . "\t>\r\n"; | |
190 if ($full =~ $exclude_re) { | |
191 for (@$targets) { | |
192 $files .= ("\t" x $depth) . "\t<FileConfiguration\r\n"; | |
193 $files .= ("\t" x $depth) . "\t\tName=\"$_\"\r\n"; | |
194 $files .= ("\t" x $depth) . "\t\tExcludedFromBuild=\"true\"\r\n"; | |
195 $files .= ("\t" x $depth) . "\t\t>\r\n"; | |
196 $files .= ("\t" x $depth) . "\t\t<Tool\r\n"; | |
197 $files .= ("\t" x $depth) . "\t\t\tName=\"VCCLCompilerTool\"\r\n"; | |
198 $files .= ("\t" x $depth) . "\t\t\tAdditionalIncludeDirectories=\"\"\r\n"; | |
199 $files .= ("\t" x $depth) . "\t\t\tPreprocessorDefinitions=\"\"\r\n"; | |
200 $files .= ("\t" x $depth) . "\t\t/>\r\n"; | |
201 $files .= ("\t" x $depth) . "\t</FileConfiguration>\r\n"; | |
202 } | |
203 } | |
204 $files .= ("\t" x $depth) . "</File>\r\n"; | |
205 } | |
206 $files .= ("\t" x --$depth) . "</Filter>\r\n" for (@$last); | |
207 $files .= "\t</Files>"; | |
208 return $files; | |
209 } | |
210 | |
211 sub patch_file { | |
212 my ($content, @variables) = @_; | |
213 for my $v (@variables) { | |
214 if ($v =~ /^([A-Z0-9_]+)\s*=.*$/si) { | |
215 my $name = $1; | |
216 $content =~ s/\n\Q$name\E\b.*?[^\\]\n/\n$v\n/s; | |
217 } | |
218 else { | |
219 die "patch_file failed: " . substr($v, 0, 30) . ".."; | |
220 } | |
221 } | |
222 return $content; | |
223 } | |
224 | |
225 sub process_makefiles { | |
226 my $write = shift; | |
227 my $changed_count = 0; | |
228 my @o = map { my $x = $_; $x =~ s/\.c$/.o/; $x } bsd_glob("*.c"); | |
229 my @all = bsd_glob("*.{c,h}"); | |
230 | |
231 my $var_o = prepare_variable("OBJECTS", @o); | |
232 (my $var_obj = $var_o) =~ s/\.o\b/.obj/sg; | |
233 | |
234 # update OBJECTS + HEADERS in makefile* | |
235 for my $m (qw/ Makefile.in /) { | |
236 my $old = read_file($m); | |
237 my $new = $m eq 'makefile.msvc' ? patch_file($old, $var_obj) | |
238 : patch_file($old, $var_o); | |
239 if ($old ne $new) { | |
240 write_file($m, $new) if $write; | |
241 warn "changed: $m\n"; | |
242 $changed_count++; | |
243 } | |
244 } | |
245 | |
246 if ($write) { | |
247 return 0; # no failures | |
248 } | |
249 else { | |
250 warn( $changed_count > 0 ? "check-makefiles: FAIL $changed_count\n" : "check-makefiles: PASS\n" ); | |
251 return $changed_count; | |
252 } | |
253 } | |
254 | |
255 sub draw_func | |
256 { | |
257 my ($deplist, $depmap, $out, $indent, $funcslist) = @_; | |
258 my @funcs = split ',', $funcslist; | |
259 # try this if you want to have a look at a minimized version of the callgraph without all the trivial functions | |
260 #if ($deplist =~ /$funcs[0]/ || $funcs[0] =~ /BN_MP_(ADD|SUB|CLEAR|CLEAR_\S+|DIV|MUL|COPY|ZERO|GROW|CLAMP|INIT|INIT_\S+|SET|ABS|CMP|CMP_D|EXCH)_C/) { | |
261 if ($deplist =~ /$funcs[0]/) { | |
262 return $deplist; | |
263 } else { | |
264 $deplist = $deplist . $funcs[0]; | |
265 } | |
266 if ($indent == 0) { | |
267 } elsif ($indent >= 1) { | |
268 print {$out} '| ' x ($indent - 1) . '+--->'; | |
269 } | |
270 print {$out} $funcs[0] . "\n"; | |
271 shift @funcs; | |
272 my $olddeplist = $deplist; | |
273 foreach my $i (@funcs) { | |
274 $deplist = draw_func($deplist, $depmap, $out, $indent + 1, ${$depmap}{$i}) if exists ${$depmap}{$i}; | |
275 } | |
276 return $olddeplist; | |
277 } | |
278 | |
279 sub update_dep | |
280 { | |
281 #open class file and write preamble | |
282 open(my $class, '>', 'tommath_class.h') or die "Couldn't open tommath_class.h for writing\n"; | |
283 print {$class} << 'EOS'; | |
284 /* LibTomMath, multiple-precision integer library -- Tom St Denis */ | |
285 /* SPDX-License-Identifier: Unlicense */ | |
286 | |
287 #if !(defined(LTM1) && defined(LTM2) && defined(LTM3)) | |
288 #define LTM_INSIDE | |
289 #if defined(LTM2) | |
290 # define LTM3 | |
291 #endif | |
292 #if defined(LTM1) | |
293 # define LTM2 | |
294 #endif | |
295 #define LTM1 | |
296 #if defined(LTM_ALL) | |
297 EOS | |
298 | |
299 foreach my $filename (glob 'bn*.c') { | |
300 my $define = $filename; | |
301 | |
302 print "Processing $filename\n"; | |
303 | |
304 # convert filename to upper case so we can use it as a define | |
305 $define =~ tr/[a-z]/[A-Z]/; | |
306 $define =~ tr/\./_/; | |
307 print {$class} "# define $define\n"; | |
308 | |
309 # now copy text and apply #ifdef as required | |
310 my $apply = 0; | |
311 open(my $src, '<', $filename); | |
312 open(my $out, '>', 'tmp'); | |
313 | |
314 # first line will be the #ifdef | |
315 my $line = <$src>; | |
316 if ($line =~ /include/) { | |
317 print {$out} $line; | |
318 } else { | |
319 print {$out} << "EOS"; | |
320 #include "tommath_private.h" | |
321 #ifdef $define | |
322 /* LibTomMath, multiple-precision integer library -- Tom St Denis */ | |
323 /* SPDX-License-Identifier: Unlicense */ | |
324 $line | |
325 EOS | |
326 $apply = 1; | |
327 } | |
328 while (<$src>) { | |
329 if ($_ !~ /tommath\.h/) { | |
330 print {$out} $_; | |
331 } | |
332 } | |
333 if ($apply == 1) { | |
334 print {$out} "#endif\n"; | |
335 } | |
336 close $src; | |
337 close $out; | |
338 | |
339 unlink $filename; | |
340 rename 'tmp', $filename; | |
341 } | |
342 print {$class} "#endif\n#endif\n"; | |
343 | |
344 # now do classes | |
345 my %depmap; | |
346 foreach my $filename (glob 'bn*.c') { | |
347 my $content; | |
348 if ($filename =~ "bn_deprecated.c") { | |
349 open(my $src, '<', $filename) or die "Can't open source file!\n"; | |
350 read $src, $content, -s $src; | |
351 close $src; | |
352 } else { | |
353 my $cc = $ENV{'CC'} || 'gcc'; | |
354 $content = `$cc -E -x c -DLTM_ALL $filename`; | |
355 $content =~ s/^# 1 "$filename".*?^# 2 "$filename"//ms; | |
356 } | |
357 | |
358 # convert filename to upper case so we can use it as a define | |
359 $filename =~ tr/[a-z]/[A-Z]/; | |
360 $filename =~ tr/\./_/; | |
361 | |
362 print {$class} "#if defined($filename)\n"; | |
363 my $list = $filename; | |
364 | |
365 # strip comments | |
366 $content =~ s{/\*.*?\*/}{}gs; | |
367 | |
368 # scan for mp_* and make classes | |
369 my @deps = (); | |
370 foreach my $line (split /\n/, $content) { | |
371 while ($line =~ /(fast_)?(s_)?mp\_[a-z_0-9]*((?=\;)|(?=\())|(?<=\()mp\_[a-z_0-9]*(?=\()/g) { | |
372 my $a = $&; | |
373 next if $a eq "mp_err"; | |
374 $a =~ tr/[a-z]/[A-Z]/; | |
375 $a = 'BN_' . $a . '_C'; | |
376 push @deps, $a; | |
377 } | |
378 } | |
379 @deps = sort(@deps); | |
380 foreach my $a (@deps) { | |
381 if ($list !~ /$a/) { | |
382 print {$class} "# define $a\n"; | |
383 } | |
384 $list = $list . ',' . $a; | |
385 } | |
386 $depmap{$filename} = $list; | |
387 | |
388 print {$class} "#endif\n\n"; | |
389 } | |
390 | |
391 print {$class} << 'EOS'; | |
392 #ifdef LTM_INSIDE | |
393 #undef LTM_INSIDE | |
394 #ifdef LTM3 | |
395 # define LTM_LAST | |
396 #endif | |
397 | |
398 #include "tommath_superclass.h" | |
399 #include "tommath_class.h" | |
400 #else | |
401 # define LTM_LAST | |
402 #endif | |
403 EOS | |
404 close $class; | |
405 | |
406 #now let's make a cool call graph... | |
407 | |
408 open(my $out, '>', 'callgraph.txt'); | |
409 foreach (sort keys %depmap) { | |
410 draw_func("", \%depmap, $out, 0, $depmap{$_}); | |
411 print {$out} "\n\n"; | |
412 } | |
413 close $out; | |
414 | |
415 return 0; | |
416 } | |
417 | |
418 sub generate_def { | |
419 my @files = split /\n/, `git ls-files`; | |
420 @files = grep(/\.c/, @files); | |
421 @files = map { my $x = $_; $x =~ s/^bn_|\.c$//g; $x; } @files; | |
422 @files = grep(!/mp_radix_smap/, @files); | |
423 | |
424 push(@files, qw(mp_set_int mp_set_long mp_set_long_long mp_get_int mp_get_long mp_get_long_long mp_init_set_int)); | |
425 | |
426 my $files = join("\n ", sort(grep(/^mp_/, @files))); | |
427 write_file "tommath.def", "; libtommath | |
428 ; | |
429 ; Use this command to produce a 32-bit .lib file, for use in any MSVC version | |
430 ; lib -machine:X86 -name:libtommath.dll -def:tommath.def -out:tommath.lib | |
431 ; Use this command to produce a 64-bit .lib file, for use in any MSVC version | |
432 ; lib -machine:X64 -name:libtommath.dll -def:tommath.def -out:tommath.lib | |
433 ; | |
434 EXPORTS | |
435 $files | |
436 "; | |
437 return 0; | |
438 } | |
439 | |
440 sub die_usage { | |
441 die <<"MARKER"; | |
442 usage: $0 -s OR $0 --check-source | |
443 $0 -o OR $0 --check-comments | |
444 $0 -m OR $0 --check-makefiles | |
445 $0 -a OR $0 --check-all | |
446 $0 -u OR $0 --update-files | |
447 MARKER | |
448 } | |
449 | |
450 GetOptions( "s|check-source" => \my $check_source, | |
451 "o|check-comments" => \my $check_comments, | |
452 "m|check-makefiles" => \my $check_makefiles, | |
453 "d|check-doc" => \my $check_doc, | |
454 "a|check-all" => \my $check_all, | |
455 "u|update-files" => \my $update_files, | |
456 "h|help" => \my $help | |
457 ) or die_usage; | |
458 | |
459 my $failure; | |
460 $failure ||= check_source() if $check_all || $check_source; | |
461 $failure ||= check_comments() if $check_all || $check_comments; | |
462 $failure ||= check_doc() if $check_doc; # temporarily excluded from --check-all | |
463 $failure ||= process_makefiles(0) if $check_all || $check_makefiles; | |
464 $failure ||= process_makefiles(1) if $update_files; | |
465 $failure ||= update_dep() if $update_files; | |
466 $failure ||= generate_def() if $update_files; | |
467 | |
468 die_usage unless defined $failure; | |
469 exit $failure ? 1 : 0; |