blob: 077a2ca33043fd7ab137798a6ecdd545f256a30b [file] [log] [blame]
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001#!/usr/bin/perl -w
2# (c) 2001, Dave Jones. <davej@codemonkey.org.uk> (the file handling bit)
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004# (c) 2007, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite, etc)
5# Licensed under the terms of the GNU GPL License version 2
6
7use strict;
8
9my $P = $0;
Andy Whitcroft00df344f2007-06-08 13:47:06 -070010$P =~ s@.*/@@g;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070011
Andy Whitcroft6cbb2e72008-07-23 21:28:55 -070012my $V = '0.20';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070013
14use Getopt::Long qw(:config no_auto_abbrev);
15
16my $quiet = 0;
17my $tree = 1;
18my $chk_signoff = 1;
19my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070020my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070021my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080022my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070023my $file = 0;
24my $check = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080025my $summary = 1;
26my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080027my $summary_file = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070028my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080029my %debug;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070030GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070031 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070032 'tree!' => \$tree,
33 'signoff!' => \$chk_signoff,
34 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070035 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -080036 'terse!' => \$terse,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070037 'file!' => \$file,
38 'subjective!' => \$check,
39 'strict!' => \$check,
40 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -080041 'summary!' => \$summary,
42 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -080043 'summary-file!' => \$summary_file,
44
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080045 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -070046 'test-only=s' => \$tst_only,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070047) or exit;
48
49my $exit = 0;
50
51if ($#ARGV < 0) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -070052 print "usage: $P [options] patchfile\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070053 print "version: $V\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -080054 print "options: -q => quiet\n";
55 print " --no-tree => run without a kernel tree\n";
56 print " --terse => one line per report\n";
57 print " --emacs => emacs compile window format\n";
58 print " --file => check a source file\n";
59 print " --strict => enable more subjective tests\n";
60 print " --root => path to the kernel tree root\n";
61 print " --no-summary => suppress the per-file summary\n";
62 print " --summary-file => include the filename in summary\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070063 exit(1);
64}
65
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080066my $dbg_values = 0;
67my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -070068my $dbg_type = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080069for my $key (keys %debug) {
70 eval "\${dbg_$key} = '$debug{$key}';"
71}
72
Andy Whitcroft8905a672007-11-28 16:21:06 -080073if ($terse) {
74 $emacs = 1;
75 $quiet++;
76}
77
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070078if ($tree) {
79 if (defined $root) {
80 if (!top_of_kernel_tree($root)) {
81 die "$P: $root: --root does not point at a valid tree\n";
82 }
83 } else {
84 if (top_of_kernel_tree('.')) {
85 $root = '.';
86 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
87 top_of_kernel_tree($1)) {
88 $root = $1;
89 }
90 }
91
92 if (!defined $root) {
93 print "Must be run from the top-level dir. of a kernel tree\n";
94 exit(2);
95 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070096}
97
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070098my $emitted_corrupt = 0;
99
100our $Ident = qr{[A-Za-z_][A-Za-z\d_]*};
101our $Storage = qr{extern|static|asmlinkage};
102our $Sparse = qr{
103 __user|
104 __kernel|
105 __force|
106 __iomem|
107 __must_check|
108 __init_refok|
Andy Whitcroftcf655042008-03-04 14:28:20 -0800109 __kprobes
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700110 }x;
111our $Attribute = qr{
112 const|
113 __read_mostly|
114 __kprobes|
115 __(?:mem|cpu|dev|)(?:initdata|init)
116 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700117our $Modifier;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700118our $Inline = qr{inline|__always_inline|noinline};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700119our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
120our $Lval = qr{$Ident(?:$Member)*};
121
122our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
123our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
124our $Operators = qr{
125 <=|>=|==|!=|
126 =>|->|<<|>>|<|>|!|~|
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800127 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700128 }x;
129
Andy Whitcroft8905a672007-11-28 16:21:06 -0800130our $NonptrType;
131our $Type;
132our $Declare;
133
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700134our $UTF8 = qr {
135 [\x09\x0A\x0D\x20-\x7E] # ASCII
136 | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
137 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
138 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
139 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
140 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
141 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
142 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
143}x;
144
Andy Whitcroft8905a672007-11-28 16:21:06 -0800145our @typeList = (
146 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700147 qr{(?:unsigned\s+)?char},
148 qr{(?:unsigned\s+)?short},
149 qr{(?:unsigned\s+)?int},
150 qr{(?:unsigned\s+)?long},
151 qr{(?:unsigned\s+)?long\s+int},
152 qr{(?:unsigned\s+)?long\s+long},
153 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800154 qr{unsigned},
155 qr{float},
156 qr{double},
157 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800158 qr{(?:__)?(?:u|s|be|le)(?:8|16|32|64)},
159 qr{struct\s+$Ident},
160 qr{union\s+$Ident},
161 qr{enum\s+$Ident},
162 qr{${Ident}_t},
163 qr{${Ident}_handler},
164 qr{${Ident}_handler_fn},
165);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700166our @modifierList = (
167 qr{fastcall},
168);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800169
170sub build_types {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700171 my $mods = "(?: \n" . join("|\n ", @modifierList) . "\n)";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800172 my $all = "(?: \n" . join("|\n ", @typeList) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700173 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800174 $NonptrType = qr{
Andy Whitcroft8905a672007-11-28 16:21:06 -0800175 (?:const\s+)?
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700176 (?:$mods\s+)?
Andy Whitcroftcf655042008-03-04 14:28:20 -0800177 (?:
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700178 (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
179 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800180 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700181 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800182 }x;
183 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700184 $NonptrType
Andy Whitcroft8905a672007-11-28 16:21:06 -0800185 (?:\s*\*+\s*const|\s*\*+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700186 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800187 }x;
188 $Declare = qr{(?:$Storage\s+)?$Type};
189}
190build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700191
192$chk_signoff = 0 if ($file);
193
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700194my @dep_includes = ();
195my @dep_functions = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700196my $removal = "Documentation/feature-removal-schedule.txt";
197if ($tree && -f "$root/$removal") {
198 open(REMOVE, "<$root/$removal") ||
199 die "$P: $removal: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700200 while (<REMOVE>) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700201 if (/^Check:\s+(.*\S)/) {
202 for my $entry (split(/[, ]+/, $1)) {
203 if ($entry =~ m@include/(.*)@) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700204 push(@dep_includes, $1);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700205
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700206 } elsif ($entry !~ m@/@) {
207 push(@dep_functions, $entry);
208 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700209 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700210 }
211 }
212}
213
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700214my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800215my @lines = ();
216my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700217for my $filename (@ARGV) {
218 if ($file) {
219 open(FILE, "diff -u /dev/null $filename|") ||
220 die "$P: $filename: diff failed - $!\n";
221 } else {
222 open(FILE, "<$filename") ||
223 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700224 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800225 if ($filename eq '-') {
226 $vname = 'Your patch';
227 } else {
228 $vname = $filename;
229 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700230 while (<FILE>) {
231 chomp;
232 push(@rawlines, $_);
233 }
234 close(FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800235 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700236 $exit = 1;
237 }
238 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800239 @lines = ();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700240}
241
242exit($exit);
243
244sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700245 my ($root) = @_;
246
247 my @tree_check = (
248 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
249 "README", "Documentation", "arch", "include", "drivers",
250 "fs", "init", "ipc", "kernel", "lib", "scripts",
251 );
252
253 foreach my $check (@tree_check) {
254 if (! -e $root . '/' . $check) {
255 return 0;
256 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700257 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700258 return 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700259}
260
261sub expand_tabs {
262 my ($str) = @_;
263
264 my $res = '';
265 my $n = 0;
266 for my $c (split(//, $str)) {
267 if ($c eq "\t") {
268 $res .= ' ';
269 $n++;
270 for (; ($n % 8) != 0; $n++) {
271 $res .= ' ';
272 }
273 next;
274 }
275 $res .= $c;
276 $n++;
277 }
278
279 return $res;
280}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700281sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700282 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700283 return $res;
284}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700285
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700286sub line_stats {
287 my ($line) = @_;
288
289 # Drop the diff line leader and expand tabs
290 $line =~ s/^.//;
291 $line = expand_tabs($line);
292
293 # Pick the indent from the front of the line.
294 my ($white) = ($line =~ /^(\s*)/);
295
296 return (length($line), length($white));
297}
298
Andy Whitcroft773647a2008-03-28 14:15:58 -0700299my $sanitise_quote = '';
300
301sub sanitise_line_reset {
302 my ($in_comment) = @_;
303
304 if ($in_comment) {
305 $sanitise_quote = '*/';
306 } else {
307 $sanitise_quote = '';
308 }
309}
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700310sub sanitise_line {
311 my ($line) = @_;
312
313 my $res = '';
314 my $l = '';
315
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800316 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700317 my $off = 0;
318 my $c;
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700319
Andy Whitcroft773647a2008-03-28 14:15:58 -0700320 # Always copy over the diff marker.
321 $res = substr($line, 0, 1);
322
323 for ($off = 1; $off < length($line); $off++) {
324 $c = substr($line, $off, 1);
325
326 # Comments we are wacking completly including the begin
327 # and end, all to $;.
328 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
329 $sanitise_quote = '*/';
330
331 substr($res, $off, 2, "$;$;");
332 $off++;
333 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800334 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700335 if (substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700336 $sanitise_quote = '';
337 substr($res, $off, 2, "$;$;");
338 $off++;
339 next;
340 }
341
342 # A \ in a string means ignore the next character.
343 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
344 $c eq "\\") {
345 substr($res, $off, 2, 'XX');
346 $off++;
347 next;
348 }
349 # Regular quotes.
350 if ($c eq "'" || $c eq '"') {
351 if ($sanitise_quote eq '') {
352 $sanitise_quote = $c;
353
354 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700355 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700356 } elsif ($sanitise_quote eq $c) {
357 $sanitise_quote = '';
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700358 }
359 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700360
361 #print "SQ:$sanitise_quote\n";
362 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
363 substr($res, $off, 1, $;);
364 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
365 substr($res, $off, 1, 'X');
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700366 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700367 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700368 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800369 }
370
371 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700372 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800373 my $clean = 'X' x length($1);
374 $res =~ s@\<.*\>@<$clean>@;
375
376 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700377 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800378 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700379 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800380 }
381
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700382 return $res;
383}
384
Andy Whitcroft8905a672007-11-28 16:21:06 -0800385sub ctx_statement_block {
386 my ($linenr, $remain, $off) = @_;
387 my $line = $linenr - 1;
388 my $blk = '';
389 my $soff = $off;
390 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700391 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800392
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800393 my $loff = 0;
394
Andy Whitcroft8905a672007-11-28 16:21:06 -0800395 my $type = '';
396 my $level = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800397 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800398 my $c;
399 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800400
401 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800402 while (1) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700403 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800404 # If we are about to drop off the end, pull in more
405 # context.
406 if ($off >= $len) {
407 for (; $remain > 0; $line++) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800408 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800409 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800410 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800411 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800412 $len = length($blk);
413 $line++;
414 last;
415 }
416 # Bail if there is no further context.
417 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800418 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800419 last;
420 }
421 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800422 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800423 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800424 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800425
Andy Whitcroft773647a2008-03-28 14:15:58 -0700426 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800427 # Statement ends at the ';' or a close '}' at the
428 # outermost level.
429 if ($level == 0 && $c eq ';') {
430 last;
431 }
432
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800433 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700434 if ($level == 0 && $coff_set == 0 &&
435 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
436 $remainder =~ /^(else)(?:\s|{)/ &&
437 $remainder !~ /^else\s+if\b/) {
438 $coff = $off + length($1) - 1;
439 $coff_set = 1;
440 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
441 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800442 }
443
Andy Whitcroft8905a672007-11-28 16:21:06 -0800444 if (($type eq '' || $type eq '(') && $c eq '(') {
445 $level++;
446 $type = '(';
447 }
448 if ($type eq '(' && $c eq ')') {
449 $level--;
450 $type = ($level != 0)? '(' : '';
451
452 if ($level == 0 && $coff < $soff) {
453 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700454 $coff_set = 1;
455 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800456 }
457 }
458 if (($type eq '' || $type eq '{') && $c eq '{') {
459 $level++;
460 $type = '{';
461 }
462 if ($type eq '{' && $c eq '}') {
463 $level--;
464 $type = ($level != 0)? '{' : '';
465
466 if ($level == 0) {
467 last;
468 }
469 }
470 $off++;
471 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700472 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800473 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700474 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800475 $line++;
476 $remain--;
477 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800478
479 my $statement = substr($blk, $soff, $off - $soff + 1);
480 my $condition = substr($blk, $soff, $coff - $soff + 1);
481
482 #warn "STATEMENT<$statement>\n";
483 #warn "CONDITION<$condition>\n";
484
Andy Whitcroft773647a2008-03-28 14:15:58 -0700485 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800486
487 return ($statement, $condition,
488 $line, $remain + 1, $off - $loff + 1, $level);
489}
490
Andy Whitcroftcf655042008-03-04 14:28:20 -0800491sub statement_lines {
492 my ($stmt) = @_;
493
494 # Strip the diff line prefixes and rip blank lines at start and end.
495 $stmt =~ s/(^|\n)./$1/g;
496 $stmt =~ s/^\s*//;
497 $stmt =~ s/\s*$//;
498
499 my @stmt_lines = ($stmt =~ /\n/g);
500
501 return $#stmt_lines + 2;
502}
503
504sub statement_rawlines {
505 my ($stmt) = @_;
506
507 my @stmt_lines = ($stmt =~ /\n/g);
508
509 return $#stmt_lines + 2;
510}
511
512sub statement_block_size {
513 my ($stmt) = @_;
514
515 $stmt =~ s/(^|\n)./$1/g;
516 $stmt =~ s/^\s*{//;
517 $stmt =~ s/}\s*$//;
518 $stmt =~ s/^\s*//;
519 $stmt =~ s/\s*$//;
520
521 my @stmt_lines = ($stmt =~ /\n/g);
522 my @stmt_statements = ($stmt =~ /;/g);
523
524 my $stmt_lines = $#stmt_lines + 2;
525 my $stmt_statements = $#stmt_statements + 1;
526
527 if ($stmt_lines > $stmt_statements) {
528 return $stmt_lines;
529 } else {
530 return $stmt_statements;
531 }
532}
533
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800534sub ctx_statement_full {
535 my ($linenr, $remain, $off) = @_;
536 my ($statement, $condition, $level);
537
538 my (@chunks);
539
Andy Whitcroftcf655042008-03-04 14:28:20 -0800540 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800541 ($statement, $condition, $linenr, $remain, $off, $level) =
542 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700543 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800544 push(@chunks, [ $condition, $statement ]);
545 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
546 return ($level, $linenr, @chunks);
547 }
548
549 # Pull in the following conditional/block pairs and see if they
550 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800551 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800552 ($statement, $condition, $linenr, $remain, $off, $level) =
553 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800554 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700555 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800556 #print "C: push\n";
557 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800558 }
559
560 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800561}
562
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700563sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700564 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700565 my $line;
566 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700567 my $blk = '';
568 my @o;
569 my @c;
570 my @res = ();
571
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700572 my $level = 0;
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700573 for ($line = $start; $remain > 0; $line++) {
574 next if ($rawlines[$line] =~ /^-/);
575 $remain--;
576
577 $blk .= $rawlines[$line];
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700578 foreach my $c (split(//, $rawlines[$line])) {
579 ##print "C<$c>L<$level><$open$close>O<$off>\n";
580 if ($off > 0) {
581 $off--;
582 next;
583 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700584
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700585 if ($c eq $close && $level > 0) {
586 $level--;
587 last if ($level == 0);
588 } elsif ($c eq $open) {
589 $level++;
590 }
591 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700592
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700593 if (!$outer || $level <= 1) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700594 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700595 }
596
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700597 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700598 }
599
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700600 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700601}
602sub ctx_block_outer {
603 my ($linenr, $remain) = @_;
604
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700605 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
606 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700607}
608sub ctx_block {
609 my ($linenr, $remain) = @_;
610
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700611 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
612 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700613}
614sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700615 my ($linenr, $remain, $off) = @_;
616
617 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
618 return @r;
619}
620sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700621 my ($linenr, $remain) = @_;
622
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700623 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700624}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700625sub ctx_statement_level {
626 my ($linenr, $remain, $off) = @_;
627
628 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
629}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700630
631sub ctx_locate_comment {
632 my ($first_line, $end_line) = @_;
633
634 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700635 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700636 return $current_comment if (defined $current_comment);
637
638 # Look through the context and try and figure out if there is a
639 # comment.
640 my $in_comment = 0;
641 $current_comment = '';
642 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700643 my $line = $rawlines[$linenr - 1];
644 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700645 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
646 $in_comment = 1;
647 }
648 if ($line =~ m@/\*@) {
649 $in_comment = 1;
650 }
651 if (!$in_comment && $current_comment ne '') {
652 $current_comment = '';
653 }
654 $current_comment .= $line . "\n" if ($in_comment);
655 if ($line =~ m@\*/@) {
656 $in_comment = 0;
657 }
658 }
659
660 chomp($current_comment);
661 return($current_comment);
662}
663sub ctx_has_comment {
664 my ($first_line, $end_line) = @_;
665 my $cmt = ctx_locate_comment($first_line, $end_line);
666
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700667 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700668 ##print "CMMT: $cmt\n";
669
670 return ($cmt ne '');
671}
672
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700673sub cat_vet {
674 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700675 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700676
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700677 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700678 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
679 $res .= $1;
680 if ($2 ne '') {
681 $coded = sprintf("^%c", unpack('C', $2) + 64);
682 $res .= $coded;
683 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700684 }
685 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700686
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700687 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700688}
689
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800690my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800691my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800692my @av_paren_type;
693
694sub annotate_reset {
695 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800696 $av_pending = '_';
697 @av_paren_type = ('E');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800698}
699
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700700sub annotate_values {
701 my ($stream, $type) = @_;
702
703 my $res;
704 my $cur = $stream;
705
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800706 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700707
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700708 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700709 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800710 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700711 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700712 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800713 print "WS($1)\n" if ($dbg_values > 1);
714 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800715 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800716 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700717 }
718
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700719 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\))/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800720 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700721 $type = 'T';
722
Andy Whitcroft389a2fe2008-07-23 21:29:05 -0700723 } elsif ($cur =~ /^($Modifier)\s*/) {
724 print "MODIFIER($1)\n" if ($dbg_values > 1);
725 $type = 'T';
726
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700727 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700728 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800729 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700730 push(@av_paren_type, $type);
731 if ($2 ne '') {
732 $av_pending = 'N';
733 }
734 $type = 'E';
735
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700736 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700737 print "UNDEF($1)\n" if ($dbg_values > 1);
738 $av_preprocessor = 1;
739 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700740
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700741 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800742 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800743 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800744
745 push(@av_paren_type, $type);
746 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700747 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800748
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700749 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800750 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
751 $av_preprocessor = 1;
752
753 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
754
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700755 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800756
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700757 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800758 print "PRE_END($1)\n" if ($dbg_values > 1);
759
760 $av_preprocessor = 1;
761
762 # Assume all arms of the conditional end as this
763 # one does, and continue as if the #endif was not here.
764 pop(@av_paren_type);
765 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700766 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700767
768 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800769 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700770
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700771 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
772 print "ATTR($1)\n" if ($dbg_values > 1);
773 $av_pending = $type;
774 $type = 'N';
775
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700776 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800777 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700778 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800779 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700780 }
781 $type = 'N';
782
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800783 } elsif ($cur =~ /^(if|while|typeof|__typeof__|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800784 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800785 $av_pending = 'N';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700786 $type = 'N';
787
Andy Whitcroft6ef9b292008-07-23 21:28:59 -0700788 } elsif ($cur =~/^(return|case|else|goto)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800789 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700790 $type = 'N';
791
792 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800793 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800794 push(@av_paren_type, $av_pending);
795 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700796 $type = 'N';
797
798 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800799 my $new_type = pop(@av_paren_type);
800 if ($new_type ne '_') {
801 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800802 print "PAREN('$1') -> $type\n"
803 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700804 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800805 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700806 }
807
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700808 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800809 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700810 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800811 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700812
813 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800814 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700815 $type = 'V';
816
817 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800818 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700819 $type = 'N';
820
Andy Whitcroftcf655042008-03-04 14:28:20 -0800821 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800822 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800823 $type = 'E';
824
Andy Whitcroftcf655042008-03-04 14:28:20 -0800825 } elsif ($cur =~ /^(;|\?|:|\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800826 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700827 $type = 'N';
828
829 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800830 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700831 if ($1 ne '++' && $1 ne '--') {
832 $type = 'N';
833 }
834
835 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800836 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700837 }
838 if (defined $1) {
839 $cur = substr($cur, length($1));
840 $res .= $type x length($1);
841 }
842 }
843
844 return $res;
845}
846
Andy Whitcroft8905a672007-11-28 16:21:06 -0800847sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800848 my ($possible, $line) = @_;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800849
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700850 print "CHECK<$possible> ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800851 if ($possible !~ /^(?:$Storage|$Type|DEFINE_\S+)$/ &&
852 $possible ne 'goto' && $possible ne 'return' &&
Andy Whitcroft8905a672007-11-28 16:21:06 -0800853 $possible ne 'case' && $possible ne 'else' &&
Andy Whitcroftd3ddcf42008-07-23 21:28:58 -0700854 $possible ne 'asm' && $possible ne '__asm__' &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700855 $possible !~ /^(typedef|struct|enum)\b/) {
856 # Check for modifiers.
857 $possible =~ s/\s*$Storage\s*//g;
858 $possible =~ s/\s*$Sparse\s*//g;
859 if ($possible =~ /^\s*$/) {
860
861 } elsif ($possible =~ /\s/) {
862 $possible =~ s/\s*$Type\s*//g;
863 warn "MODIFIER: $possible ($line)\n" if ($dbg_possible);
864 push(@modifierList, $possible);
865
866 } else {
867 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
868 push(@typeList, $possible);
869 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800870 build_types();
871 }
872}
873
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700874my $prefix = '';
875
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700876sub report {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700877 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
878 return 0;
879 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800880 my $line = $prefix . $_[0];
881
882 $line = (split('\n', $line))[0] . "\n" if ($terse);
883
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800884 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700885
886 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700887}
888sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800889 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700890}
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700891sub ERROR {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700892 if (report("ERROR: $_[0]\n")) {
893 our $clean = 0;
894 our $cnt_error++;
895 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700896}
897sub WARN {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700898 if (report("WARNING: $_[0]\n")) {
899 our $clean = 0;
900 our $cnt_warn++;
901 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700902}
903sub CHK {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700904 if ($check && report("CHECK: $_[0]\n")) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700905 our $clean = 0;
906 our $cnt_chk++;
907 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700908}
909
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700910sub process {
911 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700912
913 my $linenr=0;
914 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800915 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700916 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800917 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700918
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700919 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700920 my $indent;
921 my $previndent=0;
922 my $stashindent=0;
923
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700924 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700925 my $signoff = 0;
926 my $is_patch = 0;
927
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800928 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700929 our $cnt_lines = 0;
930 our $cnt_error = 0;
931 our $cnt_warn = 0;
932 our $cnt_chk = 0;
933
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700934 # Trace the real file/line as we go.
935 my $realfile = '';
936 my $realline = 0;
937 my $realcnt = 0;
938 my $here = '';
939 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800940 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700941 my $first_line = 0;
942
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800943 my $prev_values = 'E';
944
945 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -0700946 my %suppress_ifbraces;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700947
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800948 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700949 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800950 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700951 my @setup_docs = ();
952 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700953
954 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800955 my $line;
956 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700957 $linenr++;
958 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800959
Andy Whitcroft773647a2008-03-28 14:15:58 -0700960 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700961 $setup_docs = 0;
962 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
963 $setup_docs = 1;
964 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700965 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700966 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700967 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
968 $realline=$1-1;
969 if (defined $2) {
970 $realcnt=$3+1;
971 } else {
972 $realcnt=1+1;
973 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700974 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700975
976 # Guestimate if this is a continuing comment. Run
977 # the context looking for a comment "edge". If this
978 # edge is a close comment then we must be in a comment
979 # at context start.
980 my $edge;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700981 for (my $ln = $linenr + 1; $ln < ($linenr + $realcnt); $ln++) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700982 next if ($line =~ /^-/);
983 ($edge) = ($rawlines[$ln - 1] =~ m@(/\*|\*/)@);
984 last if (defined $edge);
985 }
986 if (defined $edge && $edge eq '*/') {
987 $in_comment = 1;
988 }
989
990 # Guestimate if this is a continuing comment. If this
991 # is the start of a diff block and this line starts
992 # ' *' then it is very likely a comment.
993 if (!defined $edge &&
994 $rawlines[$linenr] =~ m@^.\s* \*(?:\s|$)@)
995 {
996 $in_comment = 1;
997 }
998
999 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1000 sanitise_line_reset($in_comment);
1001
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001002 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001003 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001004 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001005 $line = sanitise_line($rawline);
1006 }
1007 push(@lines, $line);
1008
1009 if ($realcnt > 1) {
1010 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1011 } else {
1012 $realcnt = 0;
1013 }
1014
1015 #print "==>$rawline\n";
1016 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001017
1018 if ($setup_docs && $line =~ /^\+/) {
1019 push(@setup_docs, $line);
1020 }
1021 }
1022
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001023 $prefix = '';
1024
Andy Whitcroft773647a2008-03-28 14:15:58 -07001025 $realcnt = 0;
1026 $linenr = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001027 foreach my $line (@lines) {
1028 $linenr++;
1029
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001030 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001031
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001032#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001033 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001034 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001035 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001036 $realline=$1-1;
1037 if (defined $2) {
1038 $realcnt=$3+1;
1039 } else {
1040 $realcnt=1+1;
1041 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001042 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001043 $prev_values = 'E';
1044
Andy Whitcroft773647a2008-03-28 14:15:58 -07001045 %suppress_ifbraces = ();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001046 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001047
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001048# track the line number as we move through the hunk, note that
1049# new versions of GNU diff omit the leading space on completely
1050# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001051 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001052 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001053 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001054
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001055 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001056 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001057
1058 # Track the previous line.
1059 ($prevline, $stashline) = ($stashline, $line);
1060 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001061 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1062
Andy Whitcroft773647a2008-03-28 14:15:58 -07001063 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001064
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001065 } elsif ($realcnt == 1) {
1066 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001067 }
1068
1069#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001070 $prefix = "$filename:$realline: " if ($emacs && $file);
1071 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1072
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001073 $here = "#$linenr: " if (!$file);
1074 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001075
1076 # extract the filename as it passes
1077 if ($line=~/^\+\+\+\s+(\S+)/) {
1078 $realfile = $1;
1079 $realfile =~ s@^[^/]*/@@;
1080
1081 if ($realfile =~ m@include/asm/@) {
1082 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1083 }
1084 next;
1085 }
1086
Randy Dunlap389834b2007-06-08 13:47:03 -07001087 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001088
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001089 my $hereline = "$here\n$rawline\n";
1090 my $herecurr = "$here\n$rawline\n";
1091 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001092
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001093 $cnt_lines++ if ($realcnt != 0);
1094
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001095#check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001096 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001097 # This is a signoff, if ugly, so do not double report.
1098 $signoff++;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001099 if (!($line =~ /^\s*Signed-off-by:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001100 WARN("Signed-off-by: is the preferred form\n" .
1101 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001102 }
1103 if ($line =~ /^\s*signed-off-by:\S/i) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001104 WARN("space required after Signed-off-by:\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001105 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001106 }
1107 }
1108
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001109# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001110 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001111 ERROR("patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001112 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001113 }
1114
1115# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1116 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001117 $rawline !~ m/^$UTF8*$/) {
1118 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1119
1120 my $blank = copy_spacing($rawline);
1121 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1122 my $hereptr = "$hereline$ptr\n";
1123
1124 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001125 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001126
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001127#ignore lines being removed
1128 if ($line=~/^-/) {next;}
1129
1130# check we are in a valid source file if not then ignore this hunk
1131 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001132
1133#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001134 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001135 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001136 ERROR("DOS line endings\n" . $herevet);
1137
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001138 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1139 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001140 ERROR("trailing whitespace\n" . $herevet);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001141 }
1142#80 column limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001143 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001144 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1145 $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1146 $length > 80)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001147 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001148 WARN("line over 80 characters\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001149 }
1150
Andy Whitcroft8905a672007-11-28 16:21:06 -08001151# check for adding lines without a newline.
1152 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1153 WARN("adding a line without newline at end of file\n" . $herecurr);
1154 }
1155
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001156# check we are in a valid source file *.[hc] if not then ignore this hunk
1157 next if ($realfile !~ /\.[hc]$/);
1158
1159# at the beginning of a line any tabs must come first and anything
1160# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001161 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1162 $rawline =~ /^\+\s* \s*/) {
1163 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001164 ERROR("code indent should use tabs where possible\n" . $herevet);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001165 }
1166
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001167# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001168 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001169 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1170 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001171
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001172# Check for potential 'bare' types
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001173 my ($stat, $cond, $line_nr_next, $remain_next);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001174 if ($realcnt && $line =~ /.\s*\S/) {
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001175 ($stat, $cond, $line_nr_next, $remain_next) =
1176 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001177 $stat =~ s/\n./\n /g;
1178 $cond =~ s/\n./\n /g;
1179
1180 my $s = $stat;
1181 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001182
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001183 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001184 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001185
1186 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001187 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001188
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001189 # declarations always start with types
1190 } elsif ($prev_values eq 'E' && $s =~ /^.\s*(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?((?:\s*$Ident)+)\b(?:\s+$Sparse)?\s*\**\s*(?:$Ident|\(\*[^\)]*\))\s*(?:;|=|,|\()/s) {
1191 my $type = $1;
1192 $type =~ s/\s+/ /g;
1193 possible($type, "A:" . $s);
1194
Andy Whitcroft8905a672007-11-28 16:21:06 -08001195 # definitions in global scope can only start with types
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001196 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001197 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001198 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001199
1200 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001201 while ($s =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001202 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001203 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001204
1205 # Check for any sort of function declaration.
1206 # int foo(something bar, other baz);
1207 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001208 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001209 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001210
Andy Whitcroftcf655042008-03-04 14:28:20 -08001211 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001212 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001213 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001214
Andy Whitcroft8905a672007-11-28 16:21:06 -08001215 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001216 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001217
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001218 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001219 }
1220 }
1221 }
1222
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001223 }
1224
Andy Whitcroft653d4872007-06-23 17:16:34 -07001225#
1226# Checks which may be anchored in the context.
1227#
1228
1229# Check for switch () and associated case and default
1230# statements should be at the same indent.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001231 if ($line=~/\bswitch\s*\(.*\)/) {
1232 my $err = '';
1233 my $sep = '';
1234 my @ctx = ctx_block_outer($linenr, $realcnt);
1235 shift(@ctx);
1236 for my $ctx (@ctx) {
1237 my ($clen, $cindent) = line_stats($ctx);
1238 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1239 $indent != $cindent) {
1240 $err .= "$sep$ctx\n";
1241 $sep = '';
1242 } else {
1243 $sep = "[...]\n";
1244 }
1245 }
1246 if ($err ne '') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001247 ERROR("switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001248 }
1249 }
Andy Whitcrofte2a763c2008-07-23 21:29:02 -07001250 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
1251 $line !~ /\G(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$/g) {
1252 ERROR("trailing statements should be on next line\n" . $herecurr);
1253 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001254
1255# if/while/etc brace do not go on next line, unless defining a do while loop,
1256# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001257 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001258 my $pre_ctx = "$1$2";
1259
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001260 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001261 my $ctx_cnt = $realcnt - $#ctx - 1;
1262 my $ctx = join("\n", @ctx);
1263
Andy Whitcroft548596d2008-07-23 21:29:01 -07001264 my $ctx_ln = $linenr;
1265 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001266
Andy Whitcroft548596d2008-07-23 21:29:01 -07001267 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1268 defined $lines[$ctx_ln - 1] &&
1269 $lines[$ctx_ln - 1] =~ /^-/)) {
1270 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1271 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001272 $ctx_ln++;
1273 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07001274
Andy Whitcroft53210162008-07-23 21:29:03 -07001275 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1276 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001277
1278 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1279 ERROR("that open brace { should be on the previous line\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001280 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001281 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001282 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1283 $ctx =~ /\)\s*\;\s*$/ &&
1284 defined $lines[$ctx_ln - 1])
1285 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001286 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1287 if ($nindent > $indent) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001288 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001289 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001290 }
1291 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001292 }
1293
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001294 # Track the 'values' across context and added lines.
1295 my $opline = $line; $opline =~ s/^./ /;
1296 my $curr_values = annotate_values($opline . "\n", $prev_values);
1297 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001298 if ($dbg_values) {
1299 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001300 print "$linenr > .$outline\n";
1301 print "$linenr > $curr_values\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001302 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001303 $prev_values = substr($curr_values, -1);
1304
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001305#ignore lines not being added
1306 if ($line=~/^[^\+]/) {next;}
1307
Andy Whitcroft653d4872007-06-23 17:16:34 -07001308# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07001309 if ($dbg_type) {
1310 if ($line =~ /^.\s*$Declare\s*$/) {
1311 ERROR("TEST: is type\n" . $herecurr);
1312 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1313 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1314 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001315 next;
1316 }
1317
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001318# check for initialisation to aggregates open brace on the next line
1319 if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1320 $line =~ /^.\s*{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001321 ERROR("that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001322 }
1323
Andy Whitcroft653d4872007-06-23 17:16:34 -07001324#
1325# Checks which are anchored on the added line.
1326#
1327
1328# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001329 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001330 my $path = $1;
1331 if ($path =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001332 ERROR("malformed #include filename\n" .
1333 $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001334 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001335 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001336
1337# no C99 // comments
1338 if ($line =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001339 ERROR("do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001340 }
1341 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001342 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001343 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001344
1345#EXPORT_SYMBOL should immediately follow its function closing }.
Andy Whitcroft653d4872007-06-23 17:16:34 -07001346 if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1347 ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1348 my $name = $1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001349 if (($prevline !~ /^}/) &&
1350 ($prevline !~ /^\+}/) &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001351 ($prevline !~ /^ }/) &&
Andy Whitcroftcf655042008-03-04 14:28:20 -08001352 ($prevline !~ /^.DECLARE_$Ident\(\Q$name\E\)/) &&
1353 ($prevline !~ /^.LIST_HEAD\(\Q$name\E\)/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001354 ($prevline !~ /^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(/) &&
Andy Whitcroftcf655042008-03-04 14:28:20 -08001355 ($prevline !~ /\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001356 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001357 }
1358 }
1359
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001360# check for external initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001361 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001362 ERROR("do not initialise externals to 0 or NULL\n" .
1363 $herecurr);
1364 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001365# check for static initialisers.
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001366 if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001367 ERROR("do not initialise statics to 0 or NULL\n" .
1368 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001369 }
1370
Andy Whitcroft653d4872007-06-23 17:16:34 -07001371# check for new typedefs, only function parameters and sparse annotations
1372# make sense.
1373 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001374 $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001375 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001376 $line !~ /\b__bitwise(?:__|)\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001377 WARN("do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001378 }
1379
1380# * goes on variable not on type
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001381 if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001382 ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" .
1383 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001384
1385 } elsif ($line =~ m{\($NonptrType\s+(\*+)(?!\s+const)\s+\)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001386 ERROR("\"(foo $1 )\" should be \"(foo $1)\"\n" .
1387 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001388
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001389 } elsif ($line =~ m{$NonptrType(\*+)(?:\s+(?:$Attribute|$Sparse))?\s+[A-Za-z\d_]+}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001390 ERROR("\"foo$1 bar\" should be \"foo $1bar\"\n" .
1391 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001392
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001393 } elsif ($line =~ m{$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001394 ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" .
1395 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001396 }
1397
1398# # no BUG() or BUG_ON()
1399# if ($line =~ /\b(BUG|BUG_ON)\b/) {
1400# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1401# print "$herecurr";
1402# $clean = 0;
1403# }
1404
Andy Whitcroft8905a672007-11-28 16:21:06 -08001405 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001406 WARN("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001407 }
1408
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001409# printk should use KERN_* levels. Note that follow on printk's on the
1410# same line do not need a level, so we use the current block context
1411# to try and find and validate the current printk. In summary the current
1412# printk includes all preceeding printk's which have no newline on the end.
1413# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001414 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001415 my $ok = 0;
1416 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1417 #print "CHECK<$lines[$ln - 1]\n";
1418 # we have a preceeding printk if it ends
1419 # with "\n" ignore it, else it is to blame
1420 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1421 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1422 $ok = 1;
1423 }
1424 last;
1425 }
1426 }
1427 if ($ok == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001428 WARN("printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001429 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001430 }
1431
Andy Whitcroft653d4872007-06-23 17:16:34 -07001432# function brace can't be on same line, except for #defines of do while,
1433# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001434 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1435 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001436 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001437 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001438
Andy Whitcroft8905a672007-11-28 16:21:06 -08001439# open braces for enum, union and struct go on the same line.
1440 if ($line =~ /^.\s*{/ &&
1441 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1442 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1443 }
1444
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001445# check for spacing round square brackets; allowed:
1446# 1. with a type on the left -- int [] a;
1447# 2. at the beginning of a line for slice initialisers -- [0..10] = 5,
1448 while ($line =~ /(.*?\s)\[/g) {
1449 my ($where, $prefix) = ($-[1], $1);
1450 if ($prefix !~ /$Type\s+$/ &&
1451 ($where != 0 || $prefix !~ /^.\s+$/)) {
1452 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1453 }
1454 }
1455
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001456# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001457 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001458 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001459 my $ctx_before = substr($line, 0, $-[1]);
1460 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001461
1462 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001463 if ($name =~ /^(?:
1464 if|for|while|switch|return|case|
1465 volatile|__volatile__|
1466 __attribute__|format|__extension__|
1467 asm|__asm__)$/x)
1468 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001469
1470 # cpp #define statements have non-optional spaces, ie
1471 # if there is a space between the name and the open
1472 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001473 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001474
1475 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001476 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001477
1478 # If this whole things ends with a type its most
1479 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001480 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001481
1482 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001483 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001484 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001485 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001486# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001487 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001488 my $ops = qr{
1489 <<=|>>=|<=|>=|==|!=|
1490 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1491 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001492 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001493 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001494 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001495 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001496
1497 my $blank = copy_spacing($opline);
1498
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001499 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001500 $off += length($elements[$n]);
1501
Andy Whitcroft773647a2008-03-28 14:15:58 -07001502 # Pick up the preceeding and succeeding characters.
1503 my $ca = substr($opline, 0, $off);
1504 my $cc = '';
1505 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1506 $cc = substr($opline, $off + length($elements[$n + 1]));
1507 }
1508 my $cb = "$ca$;$cc";
1509
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001510 my $a = '';
1511 $a = 'V' if ($elements[$n] ne '');
1512 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001513 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001514 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1515 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07001516 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001517
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001518 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001519
1520 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001521 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001522 $c = 'V' if ($elements[$n + 2] ne '');
1523 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001524 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001525 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1526 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001527 $c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001528 } else {
1529 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001530 }
1531
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001532 my $ctx = "${a}x${c}";
1533
1534 my $at = "(ctx:$ctx)";
1535
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001536 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001537 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001538
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001539 # Classify operators into binary, unary, or
1540 # definitions (* only) where they have more
1541 # than one mode.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001542 my $op_type = substr($curr_values, $off + 1, 1);
1543 my $op_left = substr($curr_values, $off, 1);
1544 my $is_unary;
1545 if ($op_type eq 'T') {
1546 $is_unary = 2;
1547 } elsif ($op_left eq 'V') {
1548 $is_unary = 0;
1549 } else {
1550 $is_unary = 1;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001551 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001552 #if ($op eq '-' || $op eq '&' || $op eq '*') {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001553 # print "UNARY: <$op_left$op_type $is_unary $a:$op:$c> <$ca:$op:$cc> <$unary_ctx>\n";
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001554 #}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001555
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001556 # Ignore operators passed as parameters.
1557 if ($op_type ne 'V' &&
1558 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1559
Andy Whitcroftcf655042008-03-04 14:28:20 -08001560# # Ignore comments
1561# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001562
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001563 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001564 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001565 if ($ctx !~ /.x[WEBC]/ &&
1566 $cc !~ /^\\/ && $cc !~ /^;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001567 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001568 }
1569
1570 # // is a comment
1571 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001572
1573 # -> should have no spaces
1574 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001575 if ($ctx =~ /Wx.|.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001576 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001577 }
1578
1579 # , must have a space on the right.
1580 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001581 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001582 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001583 }
1584
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001585 # '*' as part of a type definition -- reported already.
1586 } elsif ($op eq '*' && $is_unary == 2) {
1587 #warn "'*' is part of type\n";
1588
1589 # unary operators should have a space before and
1590 # none after. May be left adjacent to another
1591 # unary operator, or a cast
1592 } elsif ($op eq '!' || $op eq '~' ||
1593 ($is_unary && ($op eq '*' || $op eq '-' || $op eq '&'))) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001594 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001595 ERROR("space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001596 }
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001597 if ($op eq '*' && $cc =~/\s*const\b/) {
1598 # A unary '*' may be const
1599
1600 } elsif ($ctx =~ /.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001601 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001602 }
1603
1604 # unary ++ and unary -- are allowed no space on one side.
1605 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001606 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1607 ERROR("space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001608 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001609 if ($ctx =~ /Wx[BE]/ ||
1610 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1611 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001612 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001613 if ($ctx =~ /ExW/) {
1614 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1615 }
1616
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001617
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001618 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001619 } elsif ($op eq '<<' or $op eq '>>' or
1620 $op eq '&' or $op eq '^' or $op eq '|' or
1621 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001622 $op eq '*' or $op eq '/' or
1623 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001624 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001625 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001626 ERROR("need consistent spacing around '$op' $at\n" .
1627 $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001628 }
1629
1630 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08001631 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001632 # Ignore email addresses <foo@bar>
1633 if (!($op eq '<' && $cb =~ /$;\S+\@\S+>/) &&
1634 !($op eq '>' && $cb =~ /<\S+\@\S+$;/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001635 ERROR("spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001636 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001637 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001638 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001639 }
1640 }
1641
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001642# check for multiple assignments
1643 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001644 CHK("multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001645 }
1646
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001647## # check for multiple declarations, allowing for a function declaration
1648## # continuation.
1649## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
1650## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
1651##
1652## # Remove any bracketed sections to ensure we do not
1653## # falsly report the parameters of functions.
1654## my $ln = $line;
1655## while ($ln =~ s/\([^\(\)]*\)//g) {
1656## }
1657## if ($ln =~ /,/) {
1658## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
1659## }
1660## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001661
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001662#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001663 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
1664 $line =~ /do{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001665 ERROR("space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001666 }
1667
1668# closing brace should have a space following it when it has anything
1669# on the line
1670 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001671 ERROR("space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001672 }
1673
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001674# check spacing on square brackets
1675 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001676 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001677 }
1678 if ($line =~ /\s\]/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001679 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001680 }
1681
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001682# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001683 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
1684 $line !~ /for\s*\(\s+;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001685 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001686 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001687 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001688 $line !~ /for\s*\(.*;\s+\)/ &&
1689 $line !~ /:\s+\)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001690 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001691 }
1692
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001693#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001694 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001695 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001696 WARN("labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001697 }
1698
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001699# Return is not a function.
1700 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
1701 my $spacing = $1;
1702 my $value = $2;
1703
1704 # Flatten any parentheses and braces
Andy Whitcroftfee61c42008-07-23 21:28:56 -07001705 $value =~ s/\)\(/\) \(/g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001706 while ($value =~ s/\([^\(\)]*\)/1/) {
1707 }
1708
1709 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
1710 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
1711
1712 } elsif ($spacing !~ /\s+/) {
1713 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1714 }
1715 }
1716
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001717# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001718 if ($line=~/\b(if|while|for|switch)\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001719 ERROR("space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001720 }
1721
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001722# Check for illegal assignment in if conditional -- and check for trailing
1723# statements after the conditional.
Andy Whitcroft53210162008-07-23 21:29:03 -07001724 if ($line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001725 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001726
1727 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001728 ERROR("do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001729 }
1730
1731 # Find out what is on the end of the line after the
1732 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001733 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001734 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001735 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07001736 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
1737 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001738 {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001739 ERROR("trailing statements should be on next line\n" . $herecurr);
1740 }
1741 }
1742
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001743# Check relative indent for conditionals and blocks.
1744 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1745 my ($s, $c) = ($stat, $cond);
1746
1747 substr($s, 0, length($c), '');
1748
1749 # Make sure we remove the line prefixes as we have
1750 # none on the first line, and are going to readd them
1751 # where necessary.
1752 $s =~ s/\n./\n/gs;
1753
1754 # We want to check the first line inside the block
1755 # starting at the end of the conditional, so remove:
1756 # 1) any blank line termination
1757 # 2) any opening brace { on end of the line
1758 # 3) any do (...) {
1759 my $continuation = 0;
1760 my $check = 0;
1761 $s =~ s/^.*\bdo\b//;
1762 $s =~ s/^\s*{//;
1763 if ($s =~ s/^\s*\\//) {
1764 $continuation = 1;
1765 }
1766 if ($s =~ s/^\s*\n//) {
1767 $check = 1;
1768 }
1769
1770 # Also ignore a loop construct at the end of a
1771 # preprocessor statement.
1772 if (($prevline =~ /^.\s*#\s*define\s/ ||
1773 $prevline =~ /\\\s*$/) && $continuation == 0) {
1774 $check = 0;
1775 }
1776
1777 # Ignore the current line if its is a preprocessor
1778 # line.
1779 if ($s =~ /^\s*#\s*/) {
1780 $check = 0;
1781 }
1782
1783 my (undef, $sindent) = line_stats("+" . $s);
1784
1785 ##print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s>\n";
1786
1787 if ($check && (($sindent % 8) != 0 ||
1788 ($sindent <= $indent && $s ne ''))) {
1789 WARN("suspect code indent for conditional statements\n" . $herecurr);
1790 }
1791 }
1792
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001793# Check for bitwise tests written as boolean
1794 if ($line =~ /
1795 (?:
1796 (?:\[|\(|\&\&|\|\|)
1797 \s*0[xX][0-9]+\s*
1798 (?:\&\&|\|\|)
1799 |
1800 (?:\&\&|\|\|)
1801 \s*0[xX][0-9]+\s*
1802 (?:\&\&|\|\||\)|\])
1803 )/x)
1804 {
1805 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
1806 }
1807
Andy Whitcroft8905a672007-11-28 16:21:06 -08001808# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001809 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
1810 my $s = $1;
1811 $s =~ s/$;//g; # Remove any comments
1812 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
1813 ERROR("trailing statements should be on next line\n" . $herecurr);
1814 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001815 }
1816
1817 # Check for }<nl>else {, these must be at the same
1818 # indent level to be relevant to each other.
1819 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
1820 $previndent == $indent) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001821 ERROR("else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001822 }
1823
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001824 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
1825 $previndent == $indent) {
1826 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
1827
1828 # Find out what is on the end of the line after the
1829 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001830 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001831 $s =~ s/\n.*//g;
1832
1833 if ($s =~ /^\s*;/) {
1834 ERROR("while should follow close brace '}'\n" . $hereprev);
1835 }
1836 }
1837
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001838#studly caps, commented out until figure out how to distinguish between use of existing and adding new
1839# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
1840# print "No studly caps, use _\n";
1841# print "$herecurr";
1842# $clean = 0;
1843# }
1844
1845#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001846 if ($line=~/\#\s*define.*\\\s$/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001847 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001848 }
1849
Andy Whitcroft653d4872007-06-23 17:16:34 -07001850#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001851 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
1852 my $checkfile = "include/linux/$1.h";
1853 if (-f "$root/$checkfile" && $realfile ne $checkfile &&
1854 $1 ne 'irq')
1855 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001856 WARN("Use #include <linux/$1.h> instead of <asm/$1.h>\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001857 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001858 }
1859 }
1860
Andy Whitcroft653d4872007-06-23 17:16:34 -07001861# multi-statement macros should be enclosed in a do while loop, grab the
1862# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08001863# in a known good container
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001864 if ($line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001865 my $ln = $linenr;
1866 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001867 my ($off, $dstat, $dcond, $rest);
1868 my $ctx = '';
Andy Whitcroft653d4872007-06-23 17:16:34 -07001869
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001870 my $args = defined($1);
1871
1872 # Find the end of the macro and limit our statement
1873 # search to that.
1874 while ($cnt > 0 && defined $lines[$ln - 1] &&
1875 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
1876 {
1877 $ctx .= $rawlines[$ln - 1] . "\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001878 $cnt-- if ($lines[$ln - 1] !~ /^-/);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001879 $ln++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001880 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001881 $ctx .= $rawlines[$ln - 1];
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001882
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001883 ($dstat, $dcond, $ln, $cnt, $off) =
1884 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
1885 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001886 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001887
1888 # Extract the remainder of the define (if any) and
1889 # rip off surrounding spaces, and trailing \'s.
1890 $rest = '';
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001891 while ($off != 0 || ($cnt > 0 && $rest =~ /(?:^|\\)\s*$/)) {
1892 #print "ADDING $off <" . substr($lines[$ln - 1], $off) . ">\n";
1893 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
1894 $rest .= substr($lines[$ln - 1], $off) . "\n";
1895 $cnt--;
1896 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001897 $ln++;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001898 $off = 0;
1899 }
1900 $rest =~ s/\\\n.//g;
1901 $rest =~ s/^\s*//s;
1902 $rest =~ s/\s*$//s;
1903
1904 # Clean up the original statement.
1905 if ($args) {
1906 substr($dstat, 0, length($dcond), '');
1907 } else {
1908 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
1909 }
1910 $dstat =~ s/\\\n.//g;
1911 $dstat =~ s/^\s*//s;
1912 $dstat =~ s/\s*$//s;
1913
1914 # Flatten any parentheses and braces
1915 while ($dstat =~ s/\([^\(\)]*\)/1/) {
1916 }
1917 while ($dstat =~ s/\{[^\{\}]*\}/1/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001918 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001919
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001920 my $exceptions = qr{
1921 $Declare|
1922 module_param_named|
1923 MODULE_PARAM_DESC|
1924 DECLARE_PER_CPU|
1925 DEFINE_PER_CPU|
1926 __typeof__\(
1927 }x;
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001928 #print "REST<$rest>\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001929 if ($rest ne '') {
1930 if ($rest !~ /while\s*\(/ &&
1931 $dstat !~ /$exceptions/)
1932 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001933 ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001934 }
1935
1936 } elsif ($ctx !~ /;/) {
1937 if ($dstat ne '' &&
1938 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
1939 $dstat !~ /$exceptions/ &&
1940 $dstat =~ /$Operators/)
1941 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001942 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001943 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001944 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001945 }
1946
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001947# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001948 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
1949 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08001950 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001951 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001952 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
1953 if ($#chunks > 0 && $level == 0) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001954 my $allowed = 0;
1955 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001956 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001957 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001958 for my $chunk (@chunks) {
1959 my ($cond, $block) = @{$chunk};
1960
Andy Whitcroft773647a2008-03-28 14:15:58 -07001961 # If the condition carries leading newlines, then count those as offsets.
1962 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
1963 my $offset = statement_rawlines($whitespace) - 1;
1964
1965 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
1966
1967 # We have looked at and allowed this specific line.
1968 $suppress_ifbraces{$ln + $offset} = 1;
1969
1970 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001971 $ln += statement_rawlines($block) - 1;
1972
Andy Whitcroft773647a2008-03-28 14:15:58 -07001973 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001974
1975 $seen++ if ($block =~ /^\s*{/);
1976
Andy Whitcroftcf655042008-03-04 14:28:20 -08001977 #print "cond<$cond> block<$block> allowed<$allowed>\n";
1978 if (statement_lines($cond) > 1) {
1979 #print "APW: ALLOWED: cond<$cond>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001980 $allowed = 1;
1981 }
1982 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001983 #print "APW: ALLOWED: block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001984 $allowed = 1;
1985 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001986 if (statement_block_size($block) > 1) {
1987 #print "APW: ALLOWED: lines block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001988 $allowed = 1;
1989 }
1990 }
1991 if ($seen && !$allowed) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001992 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001993 }
1994 }
1995 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001996 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001997 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001998 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001999
Andy Whitcroftcf655042008-03-04 14:28:20 -08002000 # Check the pre-context.
2001 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2002 #print "APW: ALLOWED: pre<$1>\n";
2003 $allowed = 1;
2004 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002005
2006 my ($level, $endln, @chunks) =
2007 ctx_statement_full($linenr, $realcnt, $-[0]);
2008
Andy Whitcroftcf655042008-03-04 14:28:20 -08002009 # Check the condition.
2010 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07002011 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002012 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002013 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08002014 }
2015 if (statement_lines($cond) > 1) {
2016 #print "APW: ALLOWED: cond<$cond>\n";
2017 $allowed = 1;
2018 }
2019 if ($block =~/\b(?:if|for|while)\b/) {
2020 #print "APW: ALLOWED: block<$block>\n";
2021 $allowed = 1;
2022 }
2023 if (statement_block_size($block) > 1) {
2024 #print "APW: ALLOWED: lines block<$block>\n";
2025 $allowed = 1;
2026 }
2027 # Check the post-context.
2028 if (defined $chunks[1]) {
2029 my ($cond, $block) = @{$chunks[1]};
2030 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002031 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002032 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002033 if ($block =~ /^\s*\{/) {
2034 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2035 $allowed = 1;
2036 }
2037 }
2038 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2039 my $herectx = $here . "\n";;
2040 my $end = $linenr + statement_rawlines($block) - 1;
2041
2042 for (my $ln = $linenr - 1; $ln < $end; $ln++) {
2043 $herectx .= $rawlines[$ln] . "\n";;
2044 }
2045
2046 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002047 }
2048 }
2049
Andy Whitcroft653d4872007-06-23 17:16:34 -07002050# don't include deprecated include files (uses RAW line)
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002051 for my $inc (@dep_includes) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002052 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002053 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002054 }
2055 }
2056
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002057# don't use deprecated functions
2058 for my $func (@dep_functions) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002059 if ($line =~ /\b$func\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002060 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002061 }
2062 }
2063
2064# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002065 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2066 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002067 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002068 }
2069
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002070# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2071 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2072 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2073 }
2074
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002075# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002076 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002077 CHK("if this code is redundant consider removing it\n" .
2078 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002079 }
2080
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002081# check for needless kfree() checks
2082 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2083 my $expr = $1;
2084 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
Wolfram Sang3c232142008-07-23 21:29:05 -07002085 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002086 }
2087 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07002088# check for needless usb_free_urb() checks
2089 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2090 my $expr = $1;
2091 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2092 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2093 }
2094 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002095
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002096# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002097# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002098# print "#ifdef in C files should be avoided\n";
2099# print "$herecurr";
2100# $clean = 0;
2101# }
2102
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002103# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002104 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002105 ERROR("exactly one space required after that #$1\n" . $herecurr);
2106 }
2107
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002108# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002109 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2110 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002111 my $which = $1;
2112 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002113 CHK("$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002114 }
2115 }
2116# check for memory barriers without a comment.
2117 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2118 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002119 CHK("memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002120 }
2121 }
2122# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002123 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002124 CHK("architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002125 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002126
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002127# check the location of the inline attribute, that it is between
2128# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002129 if ($line =~ /\b$Type\s+$Inline\b/ ||
2130 $line =~ /\b$Inline\s+$Storage\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002131 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2132 }
2133
Andy Whitcroft8905a672007-11-28 16:21:06 -08002134# Check for __inline__ and __inline, prefer inline
2135 if ($line =~ /\b(__inline__|__inline)\b/) {
2136 WARN("plain inline is preferred over $1\n" . $herecurr);
2137 }
2138
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002139# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002140 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002141 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002142 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002143 my $function_name = $1;
2144 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002145
2146 my $s = $stat;
2147 if (defined $cond) {
2148 substr($s, 0, length($cond), '');
2149 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002150 if ($s =~ /^\s*;/ &&
2151 $function_name ne 'uninitialized_var')
2152 {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002153 WARN("externs should be avoided in .c files\n" . $herecurr);
2154 }
2155
2156 if ($paren_space =~ /\n/) {
2157 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2158 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002159
2160 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2161 $stat =~ /^.\s*extern\s+/)
2162 {
2163 WARN("externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002164 }
2165
2166# checks for new __setup's
2167 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2168 my $name = $1;
2169
2170 if (!grep(/$name/, @setup_docs)) {
2171 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2172 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002173 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002174
2175# check for pointless casting of kmalloc return
2176 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2177 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2178 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002179
2180# check for gcc specific __FUNCTION__
2181 if ($line =~ /__FUNCTION__/) {
2182 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2183 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002184
2185# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002186 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002187 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2188 }
2189# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002190 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002191 WARN("consider using a completion\n" . $herecurr);
2192 }
2193# recommend strict_strto* over simple_strto*
2194 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2195 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2196 }
Michael Ellermanf3db6632008-07-23 21:28:57 -07002197# check for __initcall(), use device_initcall() explicitly please
2198 if ($line =~ /^.\s*__initcall\s*\(/) {
2199 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2200 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002201
2202# use of NR_CPUS is usually wrong
2203# ignore definitions of NR_CPUS and usage to define arrays as likely right
2204 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002205 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2206 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002207 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2208 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2209 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002210 {
2211 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2212 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002213
2214# check for %L{u,d,i} in strings
2215 my $string;
2216 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2217 $string = substr($rawline, $-[1], $+[1] - $-[1]);
2218 if ($string =~ /(?<!%)%L[udi]/) {
2219 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2220 last;
2221 }
2222 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002223 }
2224
2225 # If we have no input at all, then there is nothing to report on
2226 # so just keep quiet.
2227 if ($#rawlines == -1) {
2228 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002229 }
2230
Andy Whitcroft8905a672007-11-28 16:21:06 -08002231 # In mailback mode only produce a report in the negative, for
2232 # things that appear to be patches.
2233 if ($mailback && ($clean == 1 || !$is_patch)) {
2234 exit(0);
2235 }
2236
2237 # This is not a patch, and we are are in 'no-patch' mode so
2238 # just keep quiet.
2239 if (!$chk_patch && !$is_patch) {
2240 exit(0);
2241 }
2242
2243 if (!$is_patch) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002244 ERROR("Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002245 }
2246 if ($is_patch && $chk_signoff && $signoff == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002247 ERROR("Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002248 }
2249
Andy Whitcroft8905a672007-11-28 16:21:06 -08002250 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002251 if ($summary && !($clean == 1 && $quiet == 1)) {
2252 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002253 print "total: $cnt_error errors, $cnt_warn warnings, " .
2254 (($check)? "$cnt_chk checks, " : "") .
2255 "$cnt_lines lines checked\n";
2256 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002257 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002258
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002259 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002260 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002261 }
2262 if ($clean == 0 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002263 print "$vname has style problems, please review. If any of these errors\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002264 print "are false positives report them to the maintainer, see\n";
2265 print "CHECKPATCH in MAINTAINERS.\n";
2266 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002267
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002268 return $clean;
2269}