blob: 8a3b0fd67ad739dc964adc98aa828a715a4c5e33 [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 Whitcroftd2172eb2008-07-23 21:29:07 -0700171 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
172 my $all = "(?x: \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 Whitcroftd2172eb2008-07-23 21:29:07 -0700175 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800176 (?:
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700177 (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
178 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800179 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700180 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800181 }x;
182 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700183 $NonptrType
Andy Whitcroft8905a672007-11-28 16:21:06 -0800184 (?:\s*\*+\s*const|\s*\*+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700185 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800186 }x;
187 $Declare = qr{(?:$Storage\s+)?$Type};
188}
189build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700190
191$chk_signoff = 0 if ($file);
192
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700193my @dep_includes = ();
194my @dep_functions = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700195my $removal = "Documentation/feature-removal-schedule.txt";
196if ($tree && -f "$root/$removal") {
197 open(REMOVE, "<$root/$removal") ||
198 die "$P: $removal: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700199 while (<REMOVE>) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700200 if (/^Check:\s+(.*\S)/) {
201 for my $entry (split(/[, ]+/, $1)) {
202 if ($entry =~ m@include/(.*)@) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700203 push(@dep_includes, $1);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700204
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700205 } elsif ($entry !~ m@/@) {
206 push(@dep_functions, $entry);
207 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700208 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700209 }
210 }
211}
212
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700213my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800214my @lines = ();
215my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700216for my $filename (@ARGV) {
217 if ($file) {
218 open(FILE, "diff -u /dev/null $filename|") ||
219 die "$P: $filename: diff failed - $!\n";
220 } else {
221 open(FILE, "<$filename") ||
222 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700223 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800224 if ($filename eq '-') {
225 $vname = 'Your patch';
226 } else {
227 $vname = $filename;
228 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700229 while (<FILE>) {
230 chomp;
231 push(@rawlines, $_);
232 }
233 close(FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800234 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700235 $exit = 1;
236 }
237 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800238 @lines = ();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700239}
240
241exit($exit);
242
243sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700244 my ($root) = @_;
245
246 my @tree_check = (
247 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
248 "README", "Documentation", "arch", "include", "drivers",
249 "fs", "init", "ipc", "kernel", "lib", "scripts",
250 );
251
252 foreach my $check (@tree_check) {
253 if (! -e $root . '/' . $check) {
254 return 0;
255 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700256 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700257 return 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700258}
259
260sub expand_tabs {
261 my ($str) = @_;
262
263 my $res = '';
264 my $n = 0;
265 for my $c (split(//, $str)) {
266 if ($c eq "\t") {
267 $res .= ' ';
268 $n++;
269 for (; ($n % 8) != 0; $n++) {
270 $res .= ' ';
271 }
272 next;
273 }
274 $res .= $c;
275 $n++;
276 }
277
278 return $res;
279}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700280sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700281 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700282 return $res;
283}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700284
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700285sub line_stats {
286 my ($line) = @_;
287
288 # Drop the diff line leader and expand tabs
289 $line =~ s/^.//;
290 $line = expand_tabs($line);
291
292 # Pick the indent from the front of the line.
293 my ($white) = ($line =~ /^(\s*)/);
294
295 return (length($line), length($white));
296}
297
Andy Whitcroft773647a2008-03-28 14:15:58 -0700298my $sanitise_quote = '';
299
300sub sanitise_line_reset {
301 my ($in_comment) = @_;
302
303 if ($in_comment) {
304 $sanitise_quote = '*/';
305 } else {
306 $sanitise_quote = '';
307 }
308}
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700309sub sanitise_line {
310 my ($line) = @_;
311
312 my $res = '';
313 my $l = '';
314
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800315 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700316 my $off = 0;
317 my $c;
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700318
Andy Whitcroft773647a2008-03-28 14:15:58 -0700319 # Always copy over the diff marker.
320 $res = substr($line, 0, 1);
321
322 for ($off = 1; $off < length($line); $off++) {
323 $c = substr($line, $off, 1);
324
325 # Comments we are wacking completly including the begin
326 # and end, all to $;.
327 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
328 $sanitise_quote = '*/';
329
330 substr($res, $off, 2, "$;$;");
331 $off++;
332 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800333 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700334 if (substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700335 $sanitise_quote = '';
336 substr($res, $off, 2, "$;$;");
337 $off++;
338 next;
339 }
340
341 # A \ in a string means ignore the next character.
342 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
343 $c eq "\\") {
344 substr($res, $off, 2, 'XX');
345 $off++;
346 next;
347 }
348 # Regular quotes.
349 if ($c eq "'" || $c eq '"') {
350 if ($sanitise_quote eq '') {
351 $sanitise_quote = $c;
352
353 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700354 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700355 } elsif ($sanitise_quote eq $c) {
356 $sanitise_quote = '';
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700357 }
358 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700359
360 #print "SQ:$sanitise_quote\n";
361 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
362 substr($res, $off, 1, $;);
363 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
364 substr($res, $off, 1, 'X');
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700365 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700366 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700367 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800368 }
369
370 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700371 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800372 my $clean = 'X' x length($1);
373 $res =~ s@\<.*\>@<$clean>@;
374
375 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700376 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800377 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700378 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800379 }
380
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700381 return $res;
382}
383
Andy Whitcroft8905a672007-11-28 16:21:06 -0800384sub ctx_statement_block {
385 my ($linenr, $remain, $off) = @_;
386 my $line = $linenr - 1;
387 my $blk = '';
388 my $soff = $off;
389 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700390 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800391
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800392 my $loff = 0;
393
Andy Whitcroft8905a672007-11-28 16:21:06 -0800394 my $type = '';
395 my $level = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800396 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800397 my $c;
398 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800399
400 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800401 while (1) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700402 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800403 # If we are about to drop off the end, pull in more
404 # context.
405 if ($off >= $len) {
406 for (; $remain > 0; $line++) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800407 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800408 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800409 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800410 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800411 $len = length($blk);
412 $line++;
413 last;
414 }
415 # Bail if there is no further context.
416 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800417 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800418 last;
419 }
420 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800421 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800422 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800423 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800424
Andy Whitcroft773647a2008-03-28 14:15:58 -0700425 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800426 # Statement ends at the ';' or a close '}' at the
427 # outermost level.
428 if ($level == 0 && $c eq ';') {
429 last;
430 }
431
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800432 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700433 if ($level == 0 && $coff_set == 0 &&
434 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
435 $remainder =~ /^(else)(?:\s|{)/ &&
436 $remainder !~ /^else\s+if\b/) {
437 $coff = $off + length($1) - 1;
438 $coff_set = 1;
439 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
440 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800441 }
442
Andy Whitcroft8905a672007-11-28 16:21:06 -0800443 if (($type eq '' || $type eq '(') && $c eq '(') {
444 $level++;
445 $type = '(';
446 }
447 if ($type eq '(' && $c eq ')') {
448 $level--;
449 $type = ($level != 0)? '(' : '';
450
451 if ($level == 0 && $coff < $soff) {
452 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700453 $coff_set = 1;
454 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800455 }
456 }
457 if (($type eq '' || $type eq '{') && $c eq '{') {
458 $level++;
459 $type = '{';
460 }
461 if ($type eq '{' && $c eq '}') {
462 $level--;
463 $type = ($level != 0)? '{' : '';
464
465 if ($level == 0) {
466 last;
467 }
468 }
469 $off++;
470 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700471 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800472 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700473 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800474 $line++;
475 $remain--;
476 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800477
478 my $statement = substr($blk, $soff, $off - $soff + 1);
479 my $condition = substr($blk, $soff, $coff - $soff + 1);
480
481 #warn "STATEMENT<$statement>\n";
482 #warn "CONDITION<$condition>\n";
483
Andy Whitcroft773647a2008-03-28 14:15:58 -0700484 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800485
486 return ($statement, $condition,
487 $line, $remain + 1, $off - $loff + 1, $level);
488}
489
Andy Whitcroftcf655042008-03-04 14:28:20 -0800490sub statement_lines {
491 my ($stmt) = @_;
492
493 # Strip the diff line prefixes and rip blank lines at start and end.
494 $stmt =~ s/(^|\n)./$1/g;
495 $stmt =~ s/^\s*//;
496 $stmt =~ s/\s*$//;
497
498 my @stmt_lines = ($stmt =~ /\n/g);
499
500 return $#stmt_lines + 2;
501}
502
503sub statement_rawlines {
504 my ($stmt) = @_;
505
506 my @stmt_lines = ($stmt =~ /\n/g);
507
508 return $#stmt_lines + 2;
509}
510
511sub statement_block_size {
512 my ($stmt) = @_;
513
514 $stmt =~ s/(^|\n)./$1/g;
515 $stmt =~ s/^\s*{//;
516 $stmt =~ s/}\s*$//;
517 $stmt =~ s/^\s*//;
518 $stmt =~ s/\s*$//;
519
520 my @stmt_lines = ($stmt =~ /\n/g);
521 my @stmt_statements = ($stmt =~ /;/g);
522
523 my $stmt_lines = $#stmt_lines + 2;
524 my $stmt_statements = $#stmt_statements + 1;
525
526 if ($stmt_lines > $stmt_statements) {
527 return $stmt_lines;
528 } else {
529 return $stmt_statements;
530 }
531}
532
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800533sub ctx_statement_full {
534 my ($linenr, $remain, $off) = @_;
535 my ($statement, $condition, $level);
536
537 my (@chunks);
538
Andy Whitcroftcf655042008-03-04 14:28:20 -0800539 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800540 ($statement, $condition, $linenr, $remain, $off, $level) =
541 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700542 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800543 push(@chunks, [ $condition, $statement ]);
544 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
545 return ($level, $linenr, @chunks);
546 }
547
548 # Pull in the following conditional/block pairs and see if they
549 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800550 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800551 ($statement, $condition, $linenr, $remain, $off, $level) =
552 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800553 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700554 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800555 #print "C: push\n";
556 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800557 }
558
559 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800560}
561
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700562sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700563 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700564 my $line;
565 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700566 my $blk = '';
567 my @o;
568 my @c;
569 my @res = ();
570
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700571 my $level = 0;
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700572 for ($line = $start; $remain > 0; $line++) {
573 next if ($rawlines[$line] =~ /^-/);
574 $remain--;
575
576 $blk .= $rawlines[$line];
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700577 foreach my $c (split(//, $rawlines[$line])) {
578 ##print "C<$c>L<$level><$open$close>O<$off>\n";
579 if ($off > 0) {
580 $off--;
581 next;
582 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700583
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700584 if ($c eq $close && $level > 0) {
585 $level--;
586 last if ($level == 0);
587 } elsif ($c eq $open) {
588 $level++;
589 }
590 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700591
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700592 if (!$outer || $level <= 1) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700593 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700594 }
595
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700596 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700597 }
598
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700599 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700600}
601sub ctx_block_outer {
602 my ($linenr, $remain) = @_;
603
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700604 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
605 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700606}
607sub ctx_block {
608 my ($linenr, $remain) = @_;
609
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700610 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
611 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700612}
613sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700614 my ($linenr, $remain, $off) = @_;
615
616 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
617 return @r;
618}
619sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700620 my ($linenr, $remain) = @_;
621
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700622 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700623}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700624sub ctx_statement_level {
625 my ($linenr, $remain, $off) = @_;
626
627 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
628}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700629
630sub ctx_locate_comment {
631 my ($first_line, $end_line) = @_;
632
633 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700634 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700635 return $current_comment if (defined $current_comment);
636
637 # Look through the context and try and figure out if there is a
638 # comment.
639 my $in_comment = 0;
640 $current_comment = '';
641 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700642 my $line = $rawlines[$linenr - 1];
643 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700644 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
645 $in_comment = 1;
646 }
647 if ($line =~ m@/\*@) {
648 $in_comment = 1;
649 }
650 if (!$in_comment && $current_comment ne '') {
651 $current_comment = '';
652 }
653 $current_comment .= $line . "\n" if ($in_comment);
654 if ($line =~ m@\*/@) {
655 $in_comment = 0;
656 }
657 }
658
659 chomp($current_comment);
660 return($current_comment);
661}
662sub ctx_has_comment {
663 my ($first_line, $end_line) = @_;
664 my $cmt = ctx_locate_comment($first_line, $end_line);
665
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700666 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700667 ##print "CMMT: $cmt\n";
668
669 return ($cmt ne '');
670}
671
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700672sub cat_vet {
673 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700674 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700675
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700676 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700677 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
678 $res .= $1;
679 if ($2 ne '') {
680 $coded = sprintf("^%c", unpack('C', $2) + 64);
681 $res .= $coded;
682 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700683 }
684 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700685
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700686 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700687}
688
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800689my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800690my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800691my @av_paren_type;
692
693sub annotate_reset {
694 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800695 $av_pending = '_';
696 @av_paren_type = ('E');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800697}
698
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700699sub annotate_values {
700 my ($stream, $type) = @_;
701
702 my $res;
703 my $cur = $stream;
704
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800705 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700706
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700707 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700708 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800709 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700710 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700711 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800712 print "WS($1)\n" if ($dbg_values > 1);
713 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800714 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800715 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700716 }
717
Andy Whitcroft8ea3eb92008-07-23 21:29:08 -0700718 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800719 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700720 $type = 'T';
721
Andy Whitcroft389a2fe2008-07-23 21:29:05 -0700722 } elsif ($cur =~ /^($Modifier)\s*/) {
723 print "MODIFIER($1)\n" if ($dbg_values > 1);
724 $type = 'T';
725
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700726 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700727 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800728 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700729 push(@av_paren_type, $type);
730 if ($2 ne '') {
731 $av_pending = 'N';
732 }
733 $type = 'E';
734
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700735 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700736 print "UNDEF($1)\n" if ($dbg_values > 1);
737 $av_preprocessor = 1;
738 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700739
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700740 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800741 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800742 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800743
744 push(@av_paren_type, $type);
745 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700746 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800747
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700748 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800749 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
750 $av_preprocessor = 1;
751
752 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
753
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700754 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800755
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700756 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800757 print "PRE_END($1)\n" if ($dbg_values > 1);
758
759 $av_preprocessor = 1;
760
761 # Assume all arms of the conditional end as this
762 # one does, and continue as if the #endif was not here.
763 pop(@av_paren_type);
764 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700765 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700766
767 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800768 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700769
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700770 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
771 print "ATTR($1)\n" if ($dbg_values > 1);
772 $av_pending = $type;
773 $type = 'N';
774
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700775 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800776 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700777 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800778 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700779 }
780 $type = 'N';
781
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800782 } elsif ($cur =~ /^(if|while|typeof|__typeof__|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800783 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800784 $av_pending = 'N';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700785 $type = 'N';
786
Andy Whitcroft6ef9b292008-07-23 21:28:59 -0700787 } elsif ($cur =~/^(return|case|else|goto)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800788 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700789 $type = 'N';
790
791 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800792 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800793 push(@av_paren_type, $av_pending);
794 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700795 $type = 'N';
796
797 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800798 my $new_type = pop(@av_paren_type);
799 if ($new_type ne '_') {
800 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800801 print "PAREN('$1') -> $type\n"
802 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700803 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800804 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700805 }
806
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700807 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800808 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700809 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800810 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700811
812 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800813 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700814 $type = 'V';
815
816 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800817 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700818 $type = 'N';
819
Andy Whitcroftcf655042008-03-04 14:28:20 -0800820 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800821 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800822 $type = 'E';
823
Andy Whitcroftcf655042008-03-04 14:28:20 -0800824 } elsif ($cur =~ /^(;|\?|:|\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800825 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700826 $type = 'N';
827
828 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800829 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700830 if ($1 ne '++' && $1 ne '--') {
831 $type = 'N';
832 }
833
834 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800835 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700836 }
837 if (defined $1) {
838 $cur = substr($cur, length($1));
839 $res .= $type x length($1);
840 }
841 }
842
843 return $res;
844}
845
Andy Whitcroft8905a672007-11-28 16:21:06 -0800846sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800847 my ($possible, $line) = @_;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800848
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700849 print "CHECK<$possible> ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft0221f552008-07-23 21:29:08 -0700850 if ($possible !~ /^(?:$Modifier|$Storage|$Type|DEFINE_\S+)$/ &&
Andy Whitcroft8905a672007-11-28 16:21:06 -0800851 $possible ne 'goto' && $possible ne 'return' &&
Andy Whitcroft8905a672007-11-28 16:21:06 -0800852 $possible ne 'case' && $possible ne 'else' &&
Andy Whitcroftd3ddcf42008-07-23 21:28:58 -0700853 $possible ne 'asm' && $possible ne '__asm__' &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700854 $possible !~ /^(typedef|struct|enum)\b/) {
855 # Check for modifiers.
856 $possible =~ s/\s*$Storage\s*//g;
857 $possible =~ s/\s*$Sparse\s*//g;
858 if ($possible =~ /^\s*$/) {
859
860 } elsif ($possible =~ /\s/) {
861 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -0700862 for my $modifier (split(' ', $possible)) {
863 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
864 push(@modifierList, $modifier);
865 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700866
867 } else {
868 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
869 push(@typeList, $possible);
870 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800871 build_types();
872 }
873}
874
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700875my $prefix = '';
876
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700877sub report {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700878 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
879 return 0;
880 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800881 my $line = $prefix . $_[0];
882
883 $line = (split('\n', $line))[0] . "\n" if ($terse);
884
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800885 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700886
887 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700888}
889sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800890 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700891}
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700892sub ERROR {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700893 if (report("ERROR: $_[0]\n")) {
894 our $clean = 0;
895 our $cnt_error++;
896 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700897}
898sub WARN {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700899 if (report("WARNING: $_[0]\n")) {
900 our $clean = 0;
901 our $cnt_warn++;
902 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700903}
904sub CHK {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700905 if ($check && report("CHECK: $_[0]\n")) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700906 our $clean = 0;
907 our $cnt_chk++;
908 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700909}
910
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700911sub process {
912 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700913
914 my $linenr=0;
915 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800916 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700917 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800918 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700919
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700920 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700921 my $indent;
922 my $previndent=0;
923 my $stashindent=0;
924
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700925 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700926 my $signoff = 0;
927 my $is_patch = 0;
928
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800929 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700930 our $cnt_lines = 0;
931 our $cnt_error = 0;
932 our $cnt_warn = 0;
933 our $cnt_chk = 0;
934
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700935 # Trace the real file/line as we go.
936 my $realfile = '';
937 my $realline = 0;
938 my $realcnt = 0;
939 my $here = '';
940 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800941 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700942 my $first_line = 0;
943
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800944 my $prev_values = 'E';
945
946 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -0700947 my %suppress_ifbraces;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700948
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800949 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700950 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800951 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700952 my @setup_docs = ();
953 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700954
955 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800956 my $line;
957 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700958 $linenr++;
959 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800960
Andy Whitcroft773647a2008-03-28 14:15:58 -0700961 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700962 $setup_docs = 0;
963 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
964 $setup_docs = 1;
965 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700966 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700967 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700968 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
969 $realline=$1-1;
970 if (defined $2) {
971 $realcnt=$3+1;
972 } else {
973 $realcnt=1+1;
974 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700975 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700976
977 # Guestimate if this is a continuing comment. Run
978 # the context looking for a comment "edge". If this
979 # edge is a close comment then we must be in a comment
980 # at context start.
981 my $edge;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700982 for (my $ln = $linenr + 1; $ln < ($linenr + $realcnt); $ln++) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700983 next if ($line =~ /^-/);
984 ($edge) = ($rawlines[$ln - 1] =~ m@(/\*|\*/)@);
985 last if (defined $edge);
986 }
987 if (defined $edge && $edge eq '*/') {
988 $in_comment = 1;
989 }
990
991 # Guestimate if this is a continuing comment. If this
992 # is the start of a diff block and this line starts
993 # ' *' then it is very likely a comment.
994 if (!defined $edge &&
995 $rawlines[$linenr] =~ m@^.\s* \*(?:\s|$)@)
996 {
997 $in_comment = 1;
998 }
999
1000 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1001 sanitise_line_reset($in_comment);
1002
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001003 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001004 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001005 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001006 $line = sanitise_line($rawline);
1007 }
1008 push(@lines, $line);
1009
1010 if ($realcnt > 1) {
1011 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1012 } else {
1013 $realcnt = 0;
1014 }
1015
1016 #print "==>$rawline\n";
1017 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001018
1019 if ($setup_docs && $line =~ /^\+/) {
1020 push(@setup_docs, $line);
1021 }
1022 }
1023
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001024 $prefix = '';
1025
Andy Whitcroft773647a2008-03-28 14:15:58 -07001026 $realcnt = 0;
1027 $linenr = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001028 foreach my $line (@lines) {
1029 $linenr++;
1030
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001031 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001032
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001033#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001034 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001035 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001036 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001037 $realline=$1-1;
1038 if (defined $2) {
1039 $realcnt=$3+1;
1040 } else {
1041 $realcnt=1+1;
1042 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001043 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001044 $prev_values = 'E';
1045
Andy Whitcroft773647a2008-03-28 14:15:58 -07001046 %suppress_ifbraces = ();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001047 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001048
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001049# track the line number as we move through the hunk, note that
1050# new versions of GNU diff omit the leading space on completely
1051# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001052 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001053 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001054 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001055
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001056 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001057 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001058
1059 # Track the previous line.
1060 ($prevline, $stashline) = ($stashline, $line);
1061 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001062 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1063
Andy Whitcroft773647a2008-03-28 14:15:58 -07001064 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001065
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001066 } elsif ($realcnt == 1) {
1067 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001068 }
1069
1070#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001071 $prefix = "$filename:$realline: " if ($emacs && $file);
1072 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1073
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001074 $here = "#$linenr: " if (!$file);
1075 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001076
1077 # extract the filename as it passes
1078 if ($line=~/^\+\+\+\s+(\S+)/) {
1079 $realfile = $1;
1080 $realfile =~ s@^[^/]*/@@;
1081
1082 if ($realfile =~ m@include/asm/@) {
1083 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1084 }
1085 next;
1086 }
1087
Randy Dunlap389834b2007-06-08 13:47:03 -07001088 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001089
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001090 my $hereline = "$here\n$rawline\n";
1091 my $herecurr = "$here\n$rawline\n";
1092 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001093
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001094 $cnt_lines++ if ($realcnt != 0);
1095
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001096#check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001097 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001098 # This is a signoff, if ugly, so do not double report.
1099 $signoff++;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001100 if (!($line =~ /^\s*Signed-off-by:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001101 WARN("Signed-off-by: is the preferred form\n" .
1102 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001103 }
1104 if ($line =~ /^\s*signed-off-by:\S/i) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001105 WARN("space required after Signed-off-by:\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001106 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001107 }
1108 }
1109
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001110# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001111 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001112 ERROR("patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001113 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001114 }
1115
1116# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1117 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001118 $rawline !~ m/^$UTF8*$/) {
1119 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1120
1121 my $blank = copy_spacing($rawline);
1122 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1123 my $hereptr = "$hereline$ptr\n";
1124
1125 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001126 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001127
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001128#ignore lines being removed
1129 if ($line=~/^-/) {next;}
1130
1131# check we are in a valid source file if not then ignore this hunk
1132 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001133
1134#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001135 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001136 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001137 ERROR("DOS line endings\n" . $herevet);
1138
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001139 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1140 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001141 ERROR("trailing whitespace\n" . $herevet);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001142 }
1143#80 column limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001144 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001145 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1146 $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1147 $length > 80)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001148 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001149 WARN("line over 80 characters\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001150 }
1151
Andy Whitcroft8905a672007-11-28 16:21:06 -08001152# check for adding lines without a newline.
1153 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1154 WARN("adding a line without newline at end of file\n" . $herecurr);
1155 }
1156
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001157# check we are in a valid source file *.[hc] if not then ignore this hunk
1158 next if ($realfile !~ /\.[hc]$/);
1159
1160# at the beginning of a line any tabs must come first and anything
1161# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001162 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1163 $rawline =~ /^\+\s* \s*/) {
1164 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001165 ERROR("code indent should use tabs where possible\n" . $herevet);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001166 }
1167
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001168# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001169 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001170 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1171 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001172
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001173# Check for potential 'bare' types
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001174 my ($stat, $cond, $line_nr_next, $remain_next);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001175 if ($realcnt && $line =~ /.\s*\S/) {
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001176 ($stat, $cond, $line_nr_next, $remain_next) =
1177 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001178 $stat =~ s/\n./\n /g;
1179 $cond =~ s/\n./\n /g;
1180
1181 my $s = $stat;
1182 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001183
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001184 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001185 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001186
1187 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001188 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001189
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001190 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001191 } elsif ($prev_values eq 'E' && $s =~ /^.\s*(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?((?:\s*$Ident)+?)\b(?:\s+$Sparse)?\s*\**\s*(?:$Ident|\(\*[^\)]*\))(?:\s*$Modifier)?\s*(?:;|=|,|\()/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001192 my $type = $1;
1193 $type =~ s/\s+/ /g;
1194 possible($type, "A:" . $s);
1195
Andy Whitcroft8905a672007-11-28 16:21:06 -08001196 # definitions in global scope can only start with types
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001197 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001198 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001199 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001200
1201 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001202 while ($s =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001203 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001204 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001205
1206 # Check for any sort of function declaration.
1207 # int foo(something bar, other baz);
1208 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001209 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 -08001210 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001211
Andy Whitcroftcf655042008-03-04 14:28:20 -08001212 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001213 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001214 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001215
Andy Whitcroft8905a672007-11-28 16:21:06 -08001216 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001217 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001218
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001219 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001220 }
1221 }
1222 }
1223
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001224 }
1225
Andy Whitcroft653d4872007-06-23 17:16:34 -07001226#
1227# Checks which may be anchored in the context.
1228#
1229
1230# Check for switch () and associated case and default
1231# statements should be at the same indent.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001232 if ($line=~/\bswitch\s*\(.*\)/) {
1233 my $err = '';
1234 my $sep = '';
1235 my @ctx = ctx_block_outer($linenr, $realcnt);
1236 shift(@ctx);
1237 for my $ctx (@ctx) {
1238 my ($clen, $cindent) = line_stats($ctx);
1239 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1240 $indent != $cindent) {
1241 $err .= "$sep$ctx\n";
1242 $sep = '';
1243 } else {
1244 $sep = "[...]\n";
1245 }
1246 }
1247 if ($err ne '') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001248 ERROR("switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001249 }
1250 }
Andy Whitcrofte2a763c2008-07-23 21:29:02 -07001251 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
1252 $line !~ /\G(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$/g) {
1253 ERROR("trailing statements should be on next line\n" . $herecurr);
1254 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001255
1256# if/while/etc brace do not go on next line, unless defining a do while loop,
1257# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001258 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001259 my $pre_ctx = "$1$2";
1260
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001261 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001262 my $ctx_cnt = $realcnt - $#ctx - 1;
1263 my $ctx = join("\n", @ctx);
1264
Andy Whitcroft548596d2008-07-23 21:29:01 -07001265 my $ctx_ln = $linenr;
1266 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001267
Andy Whitcroft548596d2008-07-23 21:29:01 -07001268 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1269 defined $lines[$ctx_ln - 1] &&
1270 $lines[$ctx_ln - 1] =~ /^-/)) {
1271 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1272 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001273 $ctx_ln++;
1274 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07001275
Andy Whitcroft53210162008-07-23 21:29:03 -07001276 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1277 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001278
1279 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1280 ERROR("that open brace { should be on the previous line\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001281 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001282 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001283 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1284 $ctx =~ /\)\s*\;\s*$/ &&
1285 defined $lines[$ctx_ln - 1])
1286 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001287 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1288 if ($nindent > $indent) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001289 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001290 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001291 }
1292 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001293 }
1294
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001295 # Track the 'values' across context and added lines.
1296 my $opline = $line; $opline =~ s/^./ /;
1297 my $curr_values = annotate_values($opline . "\n", $prev_values);
1298 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001299 if ($dbg_values) {
1300 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001301 print "$linenr > .$outline\n";
1302 print "$linenr > $curr_values\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001303 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001304 $prev_values = substr($curr_values, -1);
1305
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001306#ignore lines not being added
1307 if ($line=~/^[^\+]/) {next;}
1308
Andy Whitcroft653d4872007-06-23 17:16:34 -07001309# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07001310 if ($dbg_type) {
1311 if ($line =~ /^.\s*$Declare\s*$/) {
1312 ERROR("TEST: is type\n" . $herecurr);
1313 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1314 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1315 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001316 next;
1317 }
1318
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001319# check for initialisation to aggregates open brace on the next line
1320 if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1321 $line =~ /^.\s*{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001322 ERROR("that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001323 }
1324
Andy Whitcroft653d4872007-06-23 17:16:34 -07001325#
1326# Checks which are anchored on the added line.
1327#
1328
1329# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001330 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001331 my $path = $1;
1332 if ($path =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001333 ERROR("malformed #include filename\n" .
1334 $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001335 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001336 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001337
1338# no C99 // comments
1339 if ($line =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001340 ERROR("do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001341 }
1342 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001343 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001344 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001345
1346#EXPORT_SYMBOL should immediately follow its function closing }.
Andy Whitcroft653d4872007-06-23 17:16:34 -07001347 if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1348 ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1349 my $name = $1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001350 if (($prevline !~ /^}/) &&
1351 ($prevline !~ /^\+}/) &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001352 ($prevline !~ /^ }/) &&
Andy Whitcroftcf655042008-03-04 14:28:20 -08001353 ($prevline !~ /^.DECLARE_$Ident\(\Q$name\E\)/) &&
1354 ($prevline !~ /^.LIST_HEAD\(\Q$name\E\)/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001355 ($prevline !~ /^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(/) &&
Andy Whitcroftcf655042008-03-04 14:28:20 -08001356 ($prevline !~ /\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001357 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001358 }
1359 }
1360
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001361# check for external initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001362 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001363 ERROR("do not initialise externals to 0 or NULL\n" .
1364 $herecurr);
1365 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001366# check for static initialisers.
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001367 if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001368 ERROR("do not initialise statics to 0 or NULL\n" .
1369 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001370 }
1371
Andy Whitcroft653d4872007-06-23 17:16:34 -07001372# check for new typedefs, only function parameters and sparse annotations
1373# make sense.
1374 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001375 $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001376 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001377 $line !~ /\b__bitwise(?:__|)\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001378 WARN("do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001379 }
1380
1381# * goes on variable not on type
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001382 if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001383 ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" .
1384 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001385
1386 } elsif ($line =~ m{\($NonptrType\s+(\*+)(?!\s+const)\s+\)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001387 ERROR("\"(foo $1 )\" should be \"(foo $1)\"\n" .
1388 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001389
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001390 } elsif ($line =~ m{$NonptrType(\*+)(?:\s+(?:$Attribute|$Sparse))?\s+[A-Za-z\d_]+}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001391 ERROR("\"foo$1 bar\" should be \"foo $1bar\"\n" .
1392 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001393
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001394 } elsif ($line =~ m{$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001395 ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" .
1396 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001397 }
1398
1399# # no BUG() or BUG_ON()
1400# if ($line =~ /\b(BUG|BUG_ON)\b/) {
1401# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1402# print "$herecurr";
1403# $clean = 0;
1404# }
1405
Andy Whitcroft8905a672007-11-28 16:21:06 -08001406 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001407 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 -08001408 }
1409
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001410# printk should use KERN_* levels. Note that follow on printk's on the
1411# same line do not need a level, so we use the current block context
1412# to try and find and validate the current printk. In summary the current
1413# printk includes all preceeding printk's which have no newline on the end.
1414# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001415 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001416 my $ok = 0;
1417 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1418 #print "CHECK<$lines[$ln - 1]\n";
1419 # we have a preceeding printk if it ends
1420 # with "\n" ignore it, else it is to blame
1421 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1422 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1423 $ok = 1;
1424 }
1425 last;
1426 }
1427 }
1428 if ($ok == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001429 WARN("printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001430 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001431 }
1432
Andy Whitcroft653d4872007-06-23 17:16:34 -07001433# function brace can't be on same line, except for #defines of do while,
1434# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001435 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1436 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001437 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001438 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001439
Andy Whitcroft8905a672007-11-28 16:21:06 -08001440# open braces for enum, union and struct go on the same line.
1441 if ($line =~ /^.\s*{/ &&
1442 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1443 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1444 }
1445
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001446# check for spacing round square brackets; allowed:
1447# 1. with a type on the left -- int [] a;
1448# 2. at the beginning of a line for slice initialisers -- [0..10] = 5,
1449 while ($line =~ /(.*?\s)\[/g) {
1450 my ($where, $prefix) = ($-[1], $1);
1451 if ($prefix !~ /$Type\s+$/ &&
1452 ($where != 0 || $prefix !~ /^.\s+$/)) {
1453 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1454 }
1455 }
1456
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001457# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001458 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001459 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001460 my $ctx_before = substr($line, 0, $-[1]);
1461 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001462
1463 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001464 if ($name =~ /^(?:
1465 if|for|while|switch|return|case|
1466 volatile|__volatile__|
1467 __attribute__|format|__extension__|
1468 asm|__asm__)$/x)
1469 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001470
1471 # cpp #define statements have non-optional spaces, ie
1472 # if there is a space between the name and the open
1473 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001474 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001475
1476 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001477 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001478
1479 # If this whole things ends with a type its most
1480 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001481 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001482
1483 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001484 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001485 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001486 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001487# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001488 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001489 my $ops = qr{
1490 <<=|>>=|<=|>=|==|!=|
1491 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1492 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001493 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001494 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001495 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001496 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001497
1498 my $blank = copy_spacing($opline);
1499
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001500 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001501 $off += length($elements[$n]);
1502
Andy Whitcroft773647a2008-03-28 14:15:58 -07001503 # Pick up the preceeding and succeeding characters.
1504 my $ca = substr($opline, 0, $off);
1505 my $cc = '';
1506 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1507 $cc = substr($opline, $off + length($elements[$n + 1]));
1508 }
1509 my $cb = "$ca$;$cc";
1510
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001511 my $a = '';
1512 $a = 'V' if ($elements[$n] ne '');
1513 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001514 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001515 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1516 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07001517 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001518
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001519 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001520
1521 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001522 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001523 $c = 'V' if ($elements[$n + 2] ne '');
1524 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001525 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001526 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1527 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001528 $c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001529 } else {
1530 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001531 }
1532
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001533 my $ctx = "${a}x${c}";
1534
1535 my $at = "(ctx:$ctx)";
1536
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001537 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001538 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001539
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001540 # Classify operators into binary, unary, or
1541 # definitions (* only) where they have more
1542 # than one mode.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001543 my $op_type = substr($curr_values, $off + 1, 1);
1544 my $op_left = substr($curr_values, $off, 1);
1545 my $is_unary;
1546 if ($op_type eq 'T') {
1547 $is_unary = 2;
1548 } elsif ($op_left eq 'V') {
1549 $is_unary = 0;
1550 } else {
1551 $is_unary = 1;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001552 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001553 #if ($op eq '-' || $op eq '&' || $op eq '*') {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001554 # print "UNARY: <$op_left$op_type $is_unary $a:$op:$c> <$ca:$op:$cc> <$unary_ctx>\n";
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001555 #}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001556
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001557 # Ignore operators passed as parameters.
1558 if ($op_type ne 'V' &&
1559 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1560
Andy Whitcroftcf655042008-03-04 14:28:20 -08001561# # Ignore comments
1562# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001563
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001564 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001565 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001566 if ($ctx !~ /.x[WEBC]/ &&
1567 $cc !~ /^\\/ && $cc !~ /^;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001568 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001569 }
1570
1571 # // is a comment
1572 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001573
1574 # -> should have no spaces
1575 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001576 if ($ctx =~ /Wx.|.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001577 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001578 }
1579
1580 # , must have a space on the right.
1581 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001582 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001583 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001584 }
1585
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001586 # '*' as part of a type definition -- reported already.
1587 } elsif ($op eq '*' && $is_unary == 2) {
1588 #warn "'*' is part of type\n";
1589
1590 # unary operators should have a space before and
1591 # none after. May be left adjacent to another
1592 # unary operator, or a cast
1593 } elsif ($op eq '!' || $op eq '~' ||
1594 ($is_unary && ($op eq '*' || $op eq '-' || $op eq '&'))) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001595 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001596 ERROR("space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001597 }
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001598 if ($op eq '*' && $cc =~/\s*const\b/) {
1599 # A unary '*' may be const
1600
1601 } elsif ($ctx =~ /.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001602 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001603 }
1604
1605 # unary ++ and unary -- are allowed no space on one side.
1606 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001607 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1608 ERROR("space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001609 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001610 if ($ctx =~ /Wx[BE]/ ||
1611 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1612 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001613 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001614 if ($ctx =~ /ExW/) {
1615 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1616 }
1617
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001618
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001619 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001620 } elsif ($op eq '<<' or $op eq '>>' or
1621 $op eq '&' or $op eq '^' or $op eq '|' or
1622 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001623 $op eq '*' or $op eq '/' or
1624 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001625 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001626 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001627 ERROR("need consistent spacing around '$op' $at\n" .
1628 $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001629 }
1630
1631 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08001632 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001633 # Ignore email addresses <foo@bar>
1634 if (!($op eq '<' && $cb =~ /$;\S+\@\S+>/) &&
1635 !($op eq '>' && $cb =~ /<\S+\@\S+$;/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001636 ERROR("spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001637 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001638 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001639 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001640 }
1641 }
1642
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001643# check for multiple assignments
1644 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001645 CHK("multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001646 }
1647
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001648## # check for multiple declarations, allowing for a function declaration
1649## # continuation.
1650## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
1651## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
1652##
1653## # Remove any bracketed sections to ensure we do not
1654## # falsly report the parameters of functions.
1655## my $ln = $line;
1656## while ($ln =~ s/\([^\(\)]*\)//g) {
1657## }
1658## if ($ln =~ /,/) {
1659## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
1660## }
1661## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001662
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001663#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001664 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
1665 $line =~ /do{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001666 ERROR("space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001667 }
1668
1669# closing brace should have a space following it when it has anything
1670# on the line
1671 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001672 ERROR("space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001673 }
1674
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001675# check spacing on square brackets
1676 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001677 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001678 }
1679 if ($line =~ /\s\]/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001680 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001681 }
1682
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001683# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001684 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
1685 $line !~ /for\s*\(\s+;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001686 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001687 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001688 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001689 $line !~ /for\s*\(.*;\s+\)/ &&
1690 $line !~ /:\s+\)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001691 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001692 }
1693
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001694#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001695 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001696 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001697 WARN("labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001698 }
1699
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001700# Return is not a function.
1701 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
1702 my $spacing = $1;
1703 my $value = $2;
1704
1705 # Flatten any parentheses and braces
Andy Whitcroftfee61c42008-07-23 21:28:56 -07001706 $value =~ s/\)\(/\) \(/g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001707 while ($value =~ s/\([^\(\)]*\)/1/) {
1708 }
1709
1710 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
1711 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
1712
1713 } elsif ($spacing !~ /\s+/) {
1714 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1715 }
1716 }
1717
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001718# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001719 if ($line=~/\b(if|while|for|switch)\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001720 ERROR("space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001721 }
1722
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001723# Check for illegal assignment in if conditional -- and check for trailing
1724# statements after the conditional.
Andy Whitcroft53210162008-07-23 21:29:03 -07001725 if ($line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001726 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001727
1728 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001729 ERROR("do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001730 }
1731
1732 # Find out what is on the end of the line after the
1733 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001734 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001735 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001736 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07001737 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
1738 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001739 {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001740 ERROR("trailing statements should be on next line\n" . $herecurr);
1741 }
1742 }
1743
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001744# Check relative indent for conditionals and blocks.
1745 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1746 my ($s, $c) = ($stat, $cond);
1747
1748 substr($s, 0, length($c), '');
1749
1750 # Make sure we remove the line prefixes as we have
1751 # none on the first line, and are going to readd them
1752 # where necessary.
1753 $s =~ s/\n./\n/gs;
1754
1755 # We want to check the first line inside the block
1756 # starting at the end of the conditional, so remove:
1757 # 1) any blank line termination
1758 # 2) any opening brace { on end of the line
1759 # 3) any do (...) {
1760 my $continuation = 0;
1761 my $check = 0;
1762 $s =~ s/^.*\bdo\b//;
1763 $s =~ s/^\s*{//;
1764 if ($s =~ s/^\s*\\//) {
1765 $continuation = 1;
1766 }
1767 if ($s =~ s/^\s*\n//) {
1768 $check = 1;
1769 }
1770
1771 # Also ignore a loop construct at the end of a
1772 # preprocessor statement.
1773 if (($prevline =~ /^.\s*#\s*define\s/ ||
1774 $prevline =~ /\\\s*$/) && $continuation == 0) {
1775 $check = 0;
1776 }
1777
1778 # Ignore the current line if its is a preprocessor
1779 # line.
1780 if ($s =~ /^\s*#\s*/) {
1781 $check = 0;
1782 }
1783
1784 my (undef, $sindent) = line_stats("+" . $s);
1785
1786 ##print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s>\n";
1787
1788 if ($check && (($sindent % 8) != 0 ||
1789 ($sindent <= $indent && $s ne ''))) {
1790 WARN("suspect code indent for conditional statements\n" . $herecurr);
1791 }
1792 }
1793
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001794# Check for bitwise tests written as boolean
1795 if ($line =~ /
1796 (?:
1797 (?:\[|\(|\&\&|\|\|)
1798 \s*0[xX][0-9]+\s*
1799 (?:\&\&|\|\|)
1800 |
1801 (?:\&\&|\|\|)
1802 \s*0[xX][0-9]+\s*
1803 (?:\&\&|\|\||\)|\])
1804 )/x)
1805 {
1806 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
1807 }
1808
Andy Whitcroft8905a672007-11-28 16:21:06 -08001809# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001810 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
1811 my $s = $1;
1812 $s =~ s/$;//g; # Remove any comments
1813 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
1814 ERROR("trailing statements should be on next line\n" . $herecurr);
1815 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001816 }
1817
1818 # Check for }<nl>else {, these must be at the same
1819 # indent level to be relevant to each other.
1820 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
1821 $previndent == $indent) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001822 ERROR("else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001823 }
1824
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001825 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
1826 $previndent == $indent) {
1827 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
1828
1829 # Find out what is on the end of the line after the
1830 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001831 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001832 $s =~ s/\n.*//g;
1833
1834 if ($s =~ /^\s*;/) {
1835 ERROR("while should follow close brace '}'\n" . $hereprev);
1836 }
1837 }
1838
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001839#studly caps, commented out until figure out how to distinguish between use of existing and adding new
1840# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
1841# print "No studly caps, use _\n";
1842# print "$herecurr";
1843# $clean = 0;
1844# }
1845
1846#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001847 if ($line=~/\#\s*define.*\\\s$/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001848 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001849 }
1850
Andy Whitcroft653d4872007-06-23 17:16:34 -07001851#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001852 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
1853 my $checkfile = "include/linux/$1.h";
1854 if (-f "$root/$checkfile" && $realfile ne $checkfile &&
1855 $1 ne 'irq')
1856 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001857 WARN("Use #include <linux/$1.h> instead of <asm/$1.h>\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001858 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001859 }
1860 }
1861
Andy Whitcroft653d4872007-06-23 17:16:34 -07001862# multi-statement macros should be enclosed in a do while loop, grab the
1863# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08001864# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07001865 if ($realfile !~ m@/vmlinux.lds.h$@ &&
1866 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001867 my $ln = $linenr;
1868 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001869 my ($off, $dstat, $dcond, $rest);
1870 my $ctx = '';
Andy Whitcroft653d4872007-06-23 17:16:34 -07001871
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001872 my $args = defined($1);
1873
1874 # Find the end of the macro and limit our statement
1875 # search to that.
1876 while ($cnt > 0 && defined $lines[$ln - 1] &&
1877 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
1878 {
1879 $ctx .= $rawlines[$ln - 1] . "\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001880 $cnt-- if ($lines[$ln - 1] !~ /^-/);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001881 $ln++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001882 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001883 $ctx .= $rawlines[$ln - 1];
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001884
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001885 ($dstat, $dcond, $ln, $cnt, $off) =
1886 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
1887 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001888 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001889
1890 # Extract the remainder of the define (if any) and
1891 # rip off surrounding spaces, and trailing \'s.
1892 $rest = '';
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001893 while ($off != 0 || ($cnt > 0 && $rest =~ /(?:^|\\)\s*$/)) {
1894 #print "ADDING $off <" . substr($lines[$ln - 1], $off) . ">\n";
1895 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
1896 $rest .= substr($lines[$ln - 1], $off) . "\n";
1897 $cnt--;
1898 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001899 $ln++;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001900 $off = 0;
1901 }
1902 $rest =~ s/\\\n.//g;
1903 $rest =~ s/^\s*//s;
1904 $rest =~ s/\s*$//s;
1905
1906 # Clean up the original statement.
1907 if ($args) {
1908 substr($dstat, 0, length($dcond), '');
1909 } else {
1910 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
1911 }
1912 $dstat =~ s/\\\n.//g;
1913 $dstat =~ s/^\s*//s;
1914 $dstat =~ s/\s*$//s;
1915
1916 # Flatten any parentheses and braces
1917 while ($dstat =~ s/\([^\(\)]*\)/1/) {
1918 }
1919 while ($dstat =~ s/\{[^\{\}]*\}/1/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001920 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001921
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001922 my $exceptions = qr{
1923 $Declare|
1924 module_param_named|
1925 MODULE_PARAM_DESC|
1926 DECLARE_PER_CPU|
1927 DEFINE_PER_CPU|
1928 __typeof__\(
1929 }x;
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001930 #print "REST<$rest>\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001931 if ($rest ne '') {
1932 if ($rest !~ /while\s*\(/ &&
1933 $dstat !~ /$exceptions/)
1934 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001935 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 -07001936 }
1937
1938 } elsif ($ctx !~ /;/) {
1939 if ($dstat ne '' &&
1940 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
1941 $dstat !~ /$exceptions/ &&
1942 $dstat =~ /$Operators/)
1943 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001944 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001945 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001946 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001947 }
1948
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001949# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001950 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
1951 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08001952 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001953 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001954 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
1955 if ($#chunks > 0 && $level == 0) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001956 my $allowed = 0;
1957 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001958 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001959 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001960 for my $chunk (@chunks) {
1961 my ($cond, $block) = @{$chunk};
1962
Andy Whitcroft773647a2008-03-28 14:15:58 -07001963 # If the condition carries leading newlines, then count those as offsets.
1964 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
1965 my $offset = statement_rawlines($whitespace) - 1;
1966
1967 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
1968
1969 # We have looked at and allowed this specific line.
1970 $suppress_ifbraces{$ln + $offset} = 1;
1971
1972 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001973 $ln += statement_rawlines($block) - 1;
1974
Andy Whitcroft773647a2008-03-28 14:15:58 -07001975 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001976
1977 $seen++ if ($block =~ /^\s*{/);
1978
Andy Whitcroftcf655042008-03-04 14:28:20 -08001979 #print "cond<$cond> block<$block> allowed<$allowed>\n";
1980 if (statement_lines($cond) > 1) {
1981 #print "APW: ALLOWED: cond<$cond>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001982 $allowed = 1;
1983 }
1984 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001985 #print "APW: ALLOWED: block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001986 $allowed = 1;
1987 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001988 if (statement_block_size($block) > 1) {
1989 #print "APW: ALLOWED: lines block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001990 $allowed = 1;
1991 }
1992 }
1993 if ($seen && !$allowed) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001994 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001995 }
1996 }
1997 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001998 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001999 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002000 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002001
Andy Whitcroftcf655042008-03-04 14:28:20 -08002002 # Check the pre-context.
2003 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2004 #print "APW: ALLOWED: pre<$1>\n";
2005 $allowed = 1;
2006 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002007
2008 my ($level, $endln, @chunks) =
2009 ctx_statement_full($linenr, $realcnt, $-[0]);
2010
Andy Whitcroftcf655042008-03-04 14:28:20 -08002011 # Check the condition.
2012 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07002013 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002014 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002015 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08002016 }
2017 if (statement_lines($cond) > 1) {
2018 #print "APW: ALLOWED: cond<$cond>\n";
2019 $allowed = 1;
2020 }
2021 if ($block =~/\b(?:if|for|while)\b/) {
2022 #print "APW: ALLOWED: block<$block>\n";
2023 $allowed = 1;
2024 }
2025 if (statement_block_size($block) > 1) {
2026 #print "APW: ALLOWED: lines block<$block>\n";
2027 $allowed = 1;
2028 }
2029 # Check the post-context.
2030 if (defined $chunks[1]) {
2031 my ($cond, $block) = @{$chunks[1]};
2032 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002033 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002034 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002035 if ($block =~ /^\s*\{/) {
2036 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2037 $allowed = 1;
2038 }
2039 }
2040 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2041 my $herectx = $here . "\n";;
2042 my $end = $linenr + statement_rawlines($block) - 1;
2043
2044 for (my $ln = $linenr - 1; $ln < $end; $ln++) {
2045 $herectx .= $rawlines[$ln] . "\n";;
2046 }
2047
2048 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002049 }
2050 }
2051
Andy Whitcroft653d4872007-06-23 17:16:34 -07002052# don't include deprecated include files (uses RAW line)
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002053 for my $inc (@dep_includes) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002054 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002055 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002056 }
2057 }
2058
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002059# don't use deprecated functions
2060 for my $func (@dep_functions) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002061 if ($line =~ /\b$func\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002062 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002063 }
2064 }
2065
2066# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002067 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2068 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002069 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002070 }
2071
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002072# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2073 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2074 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2075 }
2076
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002077# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002078 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002079 CHK("if this code is redundant consider removing it\n" .
2080 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002081 }
2082
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002083# check for needless kfree() checks
2084 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2085 my $expr = $1;
2086 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
Wolfram Sang3c232142008-07-23 21:29:05 -07002087 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002088 }
2089 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07002090# check for needless usb_free_urb() checks
2091 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2092 my $expr = $1;
2093 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2094 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2095 }
2096 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002097
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002098# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002099# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002100# print "#ifdef in C files should be avoided\n";
2101# print "$herecurr";
2102# $clean = 0;
2103# }
2104
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002105# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002106 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002107 ERROR("exactly one space required after that #$1\n" . $herecurr);
2108 }
2109
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002110# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002111 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2112 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002113 my $which = $1;
2114 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002115 CHK("$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002116 }
2117 }
2118# check for memory barriers without a comment.
2119 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2120 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002121 CHK("memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002122 }
2123 }
2124# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002125 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002126 CHK("architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002127 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002128
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002129# check the location of the inline attribute, that it is between
2130# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002131 if ($line =~ /\b$Type\s+$Inline\b/ ||
2132 $line =~ /\b$Inline\s+$Storage\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002133 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2134 }
2135
Andy Whitcroft8905a672007-11-28 16:21:06 -08002136# Check for __inline__ and __inline, prefer inline
2137 if ($line =~ /\b(__inline__|__inline)\b/) {
2138 WARN("plain inline is preferred over $1\n" . $herecurr);
2139 }
2140
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002141# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002142 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002143 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002144 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002145 my $function_name = $1;
2146 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002147
2148 my $s = $stat;
2149 if (defined $cond) {
2150 substr($s, 0, length($cond), '');
2151 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002152 if ($s =~ /^\s*;/ &&
2153 $function_name ne 'uninitialized_var')
2154 {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002155 WARN("externs should be avoided in .c files\n" . $herecurr);
2156 }
2157
2158 if ($paren_space =~ /\n/) {
2159 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2160 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002161
2162 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2163 $stat =~ /^.\s*extern\s+/)
2164 {
2165 WARN("externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002166 }
2167
2168# checks for new __setup's
2169 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2170 my $name = $1;
2171
2172 if (!grep(/$name/, @setup_docs)) {
2173 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2174 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002175 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002176
2177# check for pointless casting of kmalloc return
2178 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2179 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2180 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002181
2182# check for gcc specific __FUNCTION__
2183 if ($line =~ /__FUNCTION__/) {
2184 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2185 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002186
2187# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002188 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002189 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2190 }
2191# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002192 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002193 WARN("consider using a completion\n" . $herecurr);
2194 }
2195# recommend strict_strto* over simple_strto*
2196 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2197 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2198 }
Michael Ellermanf3db6632008-07-23 21:28:57 -07002199# check for __initcall(), use device_initcall() explicitly please
2200 if ($line =~ /^.\s*__initcall\s*\(/) {
2201 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2202 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002203
2204# use of NR_CPUS is usually wrong
2205# ignore definitions of NR_CPUS and usage to define arrays as likely right
2206 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002207 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2208 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002209 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2210 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2211 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002212 {
2213 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2214 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002215
2216# check for %L{u,d,i} in strings
2217 my $string;
2218 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2219 $string = substr($rawline, $-[1], $+[1] - $-[1]);
2220 if ($string =~ /(?<!%)%L[udi]/) {
2221 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2222 last;
2223 }
2224 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002225 }
2226
2227 # If we have no input at all, then there is nothing to report on
2228 # so just keep quiet.
2229 if ($#rawlines == -1) {
2230 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002231 }
2232
Andy Whitcroft8905a672007-11-28 16:21:06 -08002233 # In mailback mode only produce a report in the negative, for
2234 # things that appear to be patches.
2235 if ($mailback && ($clean == 1 || !$is_patch)) {
2236 exit(0);
2237 }
2238
2239 # This is not a patch, and we are are in 'no-patch' mode so
2240 # just keep quiet.
2241 if (!$chk_patch && !$is_patch) {
2242 exit(0);
2243 }
2244
2245 if (!$is_patch) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002246 ERROR("Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002247 }
2248 if ($is_patch && $chk_signoff && $signoff == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002249 ERROR("Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002250 }
2251
Andy Whitcroft8905a672007-11-28 16:21:06 -08002252 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002253 if ($summary && !($clean == 1 && $quiet == 1)) {
2254 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002255 print "total: $cnt_error errors, $cnt_warn warnings, " .
2256 (($check)? "$cnt_chk checks, " : "") .
2257 "$cnt_lines lines checked\n";
2258 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002259 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002260
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002261 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002262 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002263 }
2264 if ($clean == 0 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002265 print "$vname has style problems, please review. If any of these errors\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002266 print "are false positives report them to the maintainer, see\n";
2267 print "CHECKPATCH in MAINTAINERS.\n";
2268 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002269
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002270 return $clean;
2271}