blob: 614999f29aa04846a5588e3f74537bb3f5104807 [file] [log] [blame]
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001#!/usr/bin/perl -w
2# (c) 2001, Dave Jones. <davej@codemonkey.org.uk> (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft0a920b52007-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 Whitcroft00df3442007-06-08 13:47:06 -070010$P =~ s@.*/@@g;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070011
Andy Whitcroft6cbb2e72008-07-23 21:28:55 -070012my $V = '0.20';
Andy Whitcroft0a920b52007-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 Whitcroft653d4872007-06-23 17:16:34 -070020my $tst_type = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -070021my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070022my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080023my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070024my $file = 0;
25my $check = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080026my $summary = 1;
27my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080028my $summary_file = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070029my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080030my %debug;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070031GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070032 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-06-01 00:46:48 -070033 'tree!' => \$tree,
34 'signoff!' => \$chk_signoff,
35 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070036 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -080037 'terse!' => \$terse,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070038 'file!' => \$file,
39 'subjective!' => \$check,
40 'strict!' => \$check,
41 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -080042 'summary!' => \$summary,
43 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -080044 'summary-file!' => \$summary_file,
45
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080046 'debug=s' => \%debug,
Andy Whitcroft13214ad2008-02-08 04:22:03 -080047 'test-type!' => \$tst_type,
Andy Whitcroft773647a2008-03-28 14:15:58 -070048 'test-only=s' => \$tst_only,
Andy Whitcroft0a920b52007-06-01 00:46:48 -070049) or exit;
50
51my $exit = 0;
52
53if ($#ARGV < 0) {
Andy Whitcroft00df3442007-06-08 13:47:06 -070054 print "usage: $P [options] patchfile\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -070055 print "version: $V\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -080056 print "options: -q => quiet\n";
57 print " --no-tree => run without a kernel tree\n";
58 print " --terse => one line per report\n";
59 print " --emacs => emacs compile window format\n";
60 print " --file => check a source file\n";
61 print " --strict => enable more subjective tests\n";
62 print " --root => path to the kernel tree root\n";
63 print " --no-summary => suppress the per-file summary\n";
64 print " --summary-file => include the filename in summary\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -070065 exit(1);
66}
67
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080068my $dbg_values = 0;
69my $dbg_possible = 0;
70for my $key (keys %debug) {
71 eval "\${dbg_$key} = '$debug{$key}';"
72}
73
Andy Whitcroft8905a672007-11-28 16:21:06 -080074if ($terse) {
75 $emacs = 1;
76 $quiet++;
77}
78
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070079if ($tree) {
80 if (defined $root) {
81 if (!top_of_kernel_tree($root)) {
82 die "$P: $root: --root does not point at a valid tree\n";
83 }
84 } else {
85 if (top_of_kernel_tree('.')) {
86 $root = '.';
87 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
88 top_of_kernel_tree($1)) {
89 $root = $1;
90 }
91 }
92
93 if (!defined $root) {
94 print "Must be run from the top-level dir. of a kernel tree\n";
95 exit(2);
96 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -070097}
98
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070099my $emitted_corrupt = 0;
100
101our $Ident = qr{[A-Za-z_][A-Za-z\d_]*};
102our $Storage = qr{extern|static|asmlinkage};
103our $Sparse = qr{
104 __user|
105 __kernel|
106 __force|
107 __iomem|
108 __must_check|
109 __init_refok|
Andy Whitcroftcf655042008-03-04 14:28:20 -0800110 __kprobes
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700111 }x;
112our $Attribute = qr{
113 const|
114 __read_mostly|
115 __kprobes|
116 __(?:mem|cpu|dev|)(?:initdata|init)
117 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700118our $Modifier;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700119our $Inline = qr{inline|__always_inline|noinline};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700120our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
121our $Lval = qr{$Ident(?:$Member)*};
122
123our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
124our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
125our $Operators = qr{
126 <=|>=|==|!=|
127 =>|->|<<|>>|<|>|!|~|
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800128 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700129 }x;
130
Andy Whitcroft8905a672007-11-28 16:21:06 -0800131our $NonptrType;
132our $Type;
133our $Declare;
134
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700135our $UTF8 = qr {
136 [\x09\x0A\x0D\x20-\x7E] # ASCII
137 | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
138 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
139 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
140 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
141 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
142 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
143 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
144}x;
145
Andy Whitcroft8905a672007-11-28 16:21:06 -0800146our @typeList = (
147 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700148 qr{(?:unsigned\s+)?char},
149 qr{(?:unsigned\s+)?short},
150 qr{(?:unsigned\s+)?int},
151 qr{(?:unsigned\s+)?long},
152 qr{(?:unsigned\s+)?long\s+int},
153 qr{(?:unsigned\s+)?long\s+long},
154 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800155 qr{unsigned},
156 qr{float},
157 qr{double},
158 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800159 qr{(?:__)?(?:u|s|be|le)(?:8|16|32|64)},
160 qr{struct\s+$Ident},
161 qr{union\s+$Ident},
162 qr{enum\s+$Ident},
163 qr{${Ident}_t},
164 qr{${Ident}_handler},
165 qr{${Ident}_handler_fn},
166);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700167our @modifierList = (
168 qr{fastcall},
169);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800170
171sub build_types {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700172 my $mods = "(?: \n" . join("|\n ", @modifierList) . "\n)";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800173 my $all = "(?: \n" . join("|\n ", @typeList) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700174 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800175 $NonptrType = qr{
Andy Whitcroft8905a672007-11-28 16:21:06 -0800176 (?:const\s+)?
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700177 (?:$mods\s+)?
Andy Whitcroftcf655042008-03-04 14:28:20 -0800178 (?:
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700179 (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
180 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800181 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700182 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800183 }x;
184 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700185 $NonptrType
Andy Whitcroft8905a672007-11-28 16:21:06 -0800186 (?:\s*\*+\s*const|\s*\*+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700187 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800188 }x;
189 $Declare = qr{(?:$Storage\s+)?$Type};
190}
191build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700192
193$chk_signoff = 0 if ($file);
194
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700195my @dep_includes = ();
196my @dep_functions = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700197my $removal = "Documentation/feature-removal-schedule.txt";
198if ($tree && -f "$root/$removal") {
199 open(REMOVE, "<$root/$removal") ||
200 die "$P: $removal: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700201 while (<REMOVE>) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700202 if (/^Check:\s+(.*\S)/) {
203 for my $entry (split(/[, ]+/, $1)) {
204 if ($entry =~ m@include/(.*)@) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700205 push(@dep_includes, $1);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700206
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700207 } elsif ($entry !~ m@/@) {
208 push(@dep_functions, $entry);
209 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700210 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700211 }
212 }
213}
214
Andy Whitcroft00df3442007-06-08 13:47:06 -0700215my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800216my @lines = ();
217my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700218for my $filename (@ARGV) {
219 if ($file) {
220 open(FILE, "diff -u /dev/null $filename|") ||
221 die "$P: $filename: diff failed - $!\n";
222 } else {
223 open(FILE, "<$filename") ||
224 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700225 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800226 if ($filename eq '-') {
227 $vname = 'Your patch';
228 } else {
229 $vname = $filename;
230 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700231 while (<FILE>) {
232 chomp;
233 push(@rawlines, $_);
234 }
235 close(FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800236 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700237 $exit = 1;
238 }
239 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800240 @lines = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700241}
242
243exit($exit);
244
245sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700246 my ($root) = @_;
247
248 my @tree_check = (
249 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
250 "README", "Documentation", "arch", "include", "drivers",
251 "fs", "init", "ipc", "kernel", "lib", "scripts",
252 );
253
254 foreach my $check (@tree_check) {
255 if (! -e $root . '/' . $check) {
256 return 0;
257 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700258 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700259 return 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700260}
261
262sub expand_tabs {
263 my ($str) = @_;
264
265 my $res = '';
266 my $n = 0;
267 for my $c (split(//, $str)) {
268 if ($c eq "\t") {
269 $res .= ' ';
270 $n++;
271 for (; ($n % 8) != 0; $n++) {
272 $res .= ' ';
273 }
274 next;
275 }
276 $res .= $c;
277 $n++;
278 }
279
280 return $res;
281}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700282sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700283 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700284 return $res;
285}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700286
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700287sub line_stats {
288 my ($line) = @_;
289
290 # Drop the diff line leader and expand tabs
291 $line =~ s/^.//;
292 $line = expand_tabs($line);
293
294 # Pick the indent from the front of the line.
295 my ($white) = ($line =~ /^(\s*)/);
296
297 return (length($line), length($white));
298}
299
Andy Whitcroft773647a2008-03-28 14:15:58 -0700300my $sanitise_quote = '';
301
302sub sanitise_line_reset {
303 my ($in_comment) = @_;
304
305 if ($in_comment) {
306 $sanitise_quote = '*/';
307 } else {
308 $sanitise_quote = '';
309 }
310}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700311sub sanitise_line {
312 my ($line) = @_;
313
314 my $res = '';
315 my $l = '';
316
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800317 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700318 my $off = 0;
319 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700320
Andy Whitcroft773647a2008-03-28 14:15:58 -0700321 # Always copy over the diff marker.
322 $res = substr($line, 0, 1);
323
324 for ($off = 1; $off < length($line); $off++) {
325 $c = substr($line, $off, 1);
326
327 # Comments we are wacking completly including the begin
328 # and end, all to $;.
329 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
330 $sanitise_quote = '*/';
331
332 substr($res, $off, 2, "$;$;");
333 $off++;
334 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800335 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700336 if (substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700337 $sanitise_quote = '';
338 substr($res, $off, 2, "$;$;");
339 $off++;
340 next;
341 }
342
343 # A \ in a string means ignore the next character.
344 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
345 $c eq "\\") {
346 substr($res, $off, 2, 'XX');
347 $off++;
348 next;
349 }
350 # Regular quotes.
351 if ($c eq "'" || $c eq '"') {
352 if ($sanitise_quote eq '') {
353 $sanitise_quote = $c;
354
355 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700356 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700357 } elsif ($sanitise_quote eq $c) {
358 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700359 }
360 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700361
362 #print "SQ:$sanitise_quote\n";
363 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
364 substr($res, $off, 1, $;);
365 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
366 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700367 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700368 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700369 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800370 }
371
372 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700373 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800374 my $clean = 'X' x length($1);
375 $res =~ s@\<.*\>@<$clean>@;
376
377 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700378 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800379 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700380 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800381 }
382
Andy Whitcroft00df3442007-06-08 13:47:06 -0700383 return $res;
384}
385
Andy Whitcroft8905a672007-11-28 16:21:06 -0800386sub ctx_statement_block {
387 my ($linenr, $remain, $off) = @_;
388 my $line = $linenr - 1;
389 my $blk = '';
390 my $soff = $off;
391 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700392 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800393
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800394 my $loff = 0;
395
Andy Whitcroft8905a672007-11-28 16:21:06 -0800396 my $type = '';
397 my $level = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800398 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800399 my $c;
400 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800401
402 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800403 while (1) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700404 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800405 # If we are about to drop off the end, pull in more
406 # context.
407 if ($off >= $len) {
408 for (; $remain > 0; $line++) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800409 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800410 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800411 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800412 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800413 $len = length($blk);
414 $line++;
415 last;
416 }
417 # Bail if there is no further context.
418 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800419 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800420 last;
421 }
422 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800423 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800424 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800425 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800426
Andy Whitcroft773647a2008-03-28 14:15:58 -0700427 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800428 # Statement ends at the ';' or a close '}' at the
429 # outermost level.
430 if ($level == 0 && $c eq ';') {
431 last;
432 }
433
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800434 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700435 if ($level == 0 && $coff_set == 0 &&
436 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
437 $remainder =~ /^(else)(?:\s|{)/ &&
438 $remainder !~ /^else\s+if\b/) {
439 $coff = $off + length($1) - 1;
440 $coff_set = 1;
441 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
442 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800443 }
444
Andy Whitcroft8905a672007-11-28 16:21:06 -0800445 if (($type eq '' || $type eq '(') && $c eq '(') {
446 $level++;
447 $type = '(';
448 }
449 if ($type eq '(' && $c eq ')') {
450 $level--;
451 $type = ($level != 0)? '(' : '';
452
453 if ($level == 0 && $coff < $soff) {
454 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700455 $coff_set = 1;
456 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800457 }
458 }
459 if (($type eq '' || $type eq '{') && $c eq '{') {
460 $level++;
461 $type = '{';
462 }
463 if ($type eq '{' && $c eq '}') {
464 $level--;
465 $type = ($level != 0)? '{' : '';
466
467 if ($level == 0) {
468 last;
469 }
470 }
471 $off++;
472 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700473 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800474 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700475 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800476 $line++;
477 $remain--;
478 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800479
480 my $statement = substr($blk, $soff, $off - $soff + 1);
481 my $condition = substr($blk, $soff, $coff - $soff + 1);
482
483 #warn "STATEMENT<$statement>\n";
484 #warn "CONDITION<$condition>\n";
485
Andy Whitcroft773647a2008-03-28 14:15:58 -0700486 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800487
488 return ($statement, $condition,
489 $line, $remain + 1, $off - $loff + 1, $level);
490}
491
Andy Whitcroftcf655042008-03-04 14:28:20 -0800492sub statement_lines {
493 my ($stmt) = @_;
494
495 # Strip the diff line prefixes and rip blank lines at start and end.
496 $stmt =~ s/(^|\n)./$1/g;
497 $stmt =~ s/^\s*//;
498 $stmt =~ s/\s*$//;
499
500 my @stmt_lines = ($stmt =~ /\n/g);
501
502 return $#stmt_lines + 2;
503}
504
505sub statement_rawlines {
506 my ($stmt) = @_;
507
508 my @stmt_lines = ($stmt =~ /\n/g);
509
510 return $#stmt_lines + 2;
511}
512
513sub statement_block_size {
514 my ($stmt) = @_;
515
516 $stmt =~ s/(^|\n)./$1/g;
517 $stmt =~ s/^\s*{//;
518 $stmt =~ s/}\s*$//;
519 $stmt =~ s/^\s*//;
520 $stmt =~ s/\s*$//;
521
522 my @stmt_lines = ($stmt =~ /\n/g);
523 my @stmt_statements = ($stmt =~ /;/g);
524
525 my $stmt_lines = $#stmt_lines + 2;
526 my $stmt_statements = $#stmt_statements + 1;
527
528 if ($stmt_lines > $stmt_statements) {
529 return $stmt_lines;
530 } else {
531 return $stmt_statements;
532 }
533}
534
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800535sub ctx_statement_full {
536 my ($linenr, $remain, $off) = @_;
537 my ($statement, $condition, $level);
538
539 my (@chunks);
540
Andy Whitcroftcf655042008-03-04 14:28:20 -0800541 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800542 ($statement, $condition, $linenr, $remain, $off, $level) =
543 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700544 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800545 push(@chunks, [ $condition, $statement ]);
546 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
547 return ($level, $linenr, @chunks);
548 }
549
550 # Pull in the following conditional/block pairs and see if they
551 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800552 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800553 ($statement, $condition, $linenr, $remain, $off, $level) =
554 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800555 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700556 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800557 #print "C: push\n";
558 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800559 }
560
561 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800562}
563
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700564sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700565 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700566 my $line;
567 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700568 my $blk = '';
569 my @o;
570 my @c;
571 my @res = ();
572
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700573 my $level = 0;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700574 for ($line = $start; $remain > 0; $line++) {
575 next if ($rawlines[$line] =~ /^-/);
576 $remain--;
577
578 $blk .= $rawlines[$line];
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700579 foreach my $c (split(//, $rawlines[$line])) {
580 ##print "C<$c>L<$level><$open$close>O<$off>\n";
581 if ($off > 0) {
582 $off--;
583 next;
584 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700585
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700586 if ($c eq $close && $level > 0) {
587 $level--;
588 last if ($level == 0);
589 } elsif ($c eq $open) {
590 $level++;
591 }
592 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700593
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700594 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700595 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700596 }
597
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700598 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700599 }
600
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700601 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700602}
603sub ctx_block_outer {
604 my ($linenr, $remain) = @_;
605
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700606 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
607 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700608}
609sub ctx_block {
610 my ($linenr, $remain) = @_;
611
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700612 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
613 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700614}
615sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700616 my ($linenr, $remain, $off) = @_;
617
618 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
619 return @r;
620}
621sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700622 my ($linenr, $remain) = @_;
623
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700624 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700625}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700626sub ctx_statement_level {
627 my ($linenr, $remain, $off) = @_;
628
629 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
630}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700631
632sub ctx_locate_comment {
633 my ($first_line, $end_line) = @_;
634
635 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700636 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700637 return $current_comment if (defined $current_comment);
638
639 # Look through the context and try and figure out if there is a
640 # comment.
641 my $in_comment = 0;
642 $current_comment = '';
643 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700644 my $line = $rawlines[$linenr - 1];
645 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700646 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
647 $in_comment = 1;
648 }
649 if ($line =~ m@/\*@) {
650 $in_comment = 1;
651 }
652 if (!$in_comment && $current_comment ne '') {
653 $current_comment = '';
654 }
655 $current_comment .= $line . "\n" if ($in_comment);
656 if ($line =~ m@\*/@) {
657 $in_comment = 0;
658 }
659 }
660
661 chomp($current_comment);
662 return($current_comment);
663}
664sub ctx_has_comment {
665 my ($first_line, $end_line) = @_;
666 my $cmt = ctx_locate_comment($first_line, $end_line);
667
Andy Whitcroft00df3442007-06-08 13:47:06 -0700668 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700669 ##print "CMMT: $cmt\n";
670
671 return ($cmt ne '');
672}
673
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700674sub cat_vet {
675 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700676 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700677
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700678 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700679 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
680 $res .= $1;
681 if ($2 ne '') {
682 $coded = sprintf("^%c", unpack('C', $2) + 64);
683 $res .= $coded;
684 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700685 }
686 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700687
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700688 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700689}
690
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800691my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800692my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800693my @av_paren_type;
694
695sub annotate_reset {
696 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800697 $av_pending = '_';
698 @av_paren_type = ('E');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800699}
700
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700701sub annotate_values {
702 my ($stream, $type) = @_;
703
704 my $res;
705 my $cur = $stream;
706
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800707 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700708
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700709 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700710 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800711 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700712 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700713 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800714 print "WS($1)\n" if ($dbg_values > 1);
715 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800716 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800717 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700718 }
719
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700720 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\))/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800721 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700722 $type = 'T';
723
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700724 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700725 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800726 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700727 push(@av_paren_type, $type);
728 if ($2 ne '') {
729 $av_pending = 'N';
730 }
731 $type = 'E';
732
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700733 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700734 print "UNDEF($1)\n" if ($dbg_values > 1);
735 $av_preprocessor = 1;
736 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700737
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700738 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800739 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800740 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800741
742 push(@av_paren_type, $type);
743 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700744 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800745
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700746 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800747 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
748 $av_preprocessor = 1;
749
750 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
751
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700752 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800753
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700754 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800755 print "PRE_END($1)\n" if ($dbg_values > 1);
756
757 $av_preprocessor = 1;
758
759 # Assume all arms of the conditional end as this
760 # one does, and continue as if the #endif was not here.
761 pop(@av_paren_type);
762 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700763 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700764
765 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800766 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700767
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700768 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
769 print "ATTR($1)\n" if ($dbg_values > 1);
770 $av_pending = $type;
771 $type = 'N';
772
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700773 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800774 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700775 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800776 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700777 }
778 $type = 'N';
779
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800780 } elsif ($cur =~ /^(if|while|typeof|__typeof__|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800781 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800782 $av_pending = 'N';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700783 $type = 'N';
784
Andy Whitcroft6ef9b292008-07-23 21:28:59 -0700785 } elsif ($cur =~/^(return|case|else|goto)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800786 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700787 $type = 'N';
788
789 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800790 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800791 push(@av_paren_type, $av_pending);
792 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700793 $type = 'N';
794
795 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800796 my $new_type = pop(@av_paren_type);
797 if ($new_type ne '_') {
798 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800799 print "PAREN('$1') -> $type\n"
800 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700801 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800802 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700803 }
804
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700805 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800806 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700807 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800808 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700809
810 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800811 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700812 $type = 'V';
813
814 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800815 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700816 $type = 'N';
817
Andy Whitcroftcf655042008-03-04 14:28:20 -0800818 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800819 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800820 $type = 'E';
821
Andy Whitcroftcf655042008-03-04 14:28:20 -0800822 } elsif ($cur =~ /^(;|\?|:|\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800823 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700824 $type = 'N';
825
826 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800827 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700828 if ($1 ne '++' && $1 ne '--') {
829 $type = 'N';
830 }
831
832 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800833 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700834 }
835 if (defined $1) {
836 $cur = substr($cur, length($1));
837 $res .= $type x length($1);
838 }
839 }
840
841 return $res;
842}
843
Andy Whitcroft8905a672007-11-28 16:21:06 -0800844sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800845 my ($possible, $line) = @_;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800846
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700847 print "CHECK<$possible> ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800848 if ($possible !~ /^(?:$Storage|$Type|DEFINE_\S+)$/ &&
849 $possible ne 'goto' && $possible ne 'return' &&
Andy Whitcroft8905a672007-11-28 16:21:06 -0800850 $possible ne 'case' && $possible ne 'else' &&
Andy Whitcroftd3ddcf42008-07-23 21:28:58 -0700851 $possible ne 'asm' && $possible ne '__asm__' &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700852 $possible !~ /^(typedef|struct|enum)\b/) {
853 # Check for modifiers.
854 $possible =~ s/\s*$Storage\s*//g;
855 $possible =~ s/\s*$Sparse\s*//g;
856 if ($possible =~ /^\s*$/) {
857
858 } elsif ($possible =~ /\s/) {
859 $possible =~ s/\s*$Type\s*//g;
860 warn "MODIFIER: $possible ($line)\n" if ($dbg_possible);
861 push(@modifierList, $possible);
862
863 } else {
864 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
865 push(@typeList, $possible);
866 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800867 build_types();
868 }
869}
870
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700871my $prefix = '';
872
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700873sub report {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700874 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
875 return 0;
876 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800877 my $line = $prefix . $_[0];
878
879 $line = (split('\n', $line))[0] . "\n" if ($terse);
880
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800881 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700882
883 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700884}
885sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800886 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700887}
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700888sub ERROR {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700889 if (report("ERROR: $_[0]\n")) {
890 our $clean = 0;
891 our $cnt_error++;
892 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700893}
894sub WARN {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700895 if (report("WARNING: $_[0]\n")) {
896 our $clean = 0;
897 our $cnt_warn++;
898 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700899}
900sub CHK {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700901 if ($check && report("CHECK: $_[0]\n")) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700902 our $clean = 0;
903 our $cnt_chk++;
904 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700905}
906
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700907sub process {
908 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700909
910 my $linenr=0;
911 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800912 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700913 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800914 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700915
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700916 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700917 my $indent;
918 my $previndent=0;
919 my $stashindent=0;
920
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700921 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700922 my $signoff = 0;
923 my $is_patch = 0;
924
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800925 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700926 our $cnt_lines = 0;
927 our $cnt_error = 0;
928 our $cnt_warn = 0;
929 our $cnt_chk = 0;
930
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700931 # Trace the real file/line as we go.
932 my $realfile = '';
933 my $realline = 0;
934 my $realcnt = 0;
935 my $here = '';
936 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800937 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700938 my $first_line = 0;
939
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800940 my $prev_values = 'E';
941
942 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -0700943 my %suppress_ifbraces;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700944
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800945 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700946 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800947 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700948 my @setup_docs = ();
949 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700950
951 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800952 my $line;
953 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700954 $linenr++;
955 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800956
Andy Whitcroft773647a2008-03-28 14:15:58 -0700957 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700958 $setup_docs = 0;
959 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
960 $setup_docs = 1;
961 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700962 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700963 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700964 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
965 $realline=$1-1;
966 if (defined $2) {
967 $realcnt=$3+1;
968 } else {
969 $realcnt=1+1;
970 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700971 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700972
973 # Guestimate if this is a continuing comment. Run
974 # the context looking for a comment "edge". If this
975 # edge is a close comment then we must be in a comment
976 # at context start.
977 my $edge;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700978 for (my $ln = $linenr + 1; $ln < ($linenr + $realcnt); $ln++) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700979 next if ($line =~ /^-/);
980 ($edge) = ($rawlines[$ln - 1] =~ m@(/\*|\*/)@);
981 last if (defined $edge);
982 }
983 if (defined $edge && $edge eq '*/') {
984 $in_comment = 1;
985 }
986
987 # Guestimate if this is a continuing comment. If this
988 # is the start of a diff block and this line starts
989 # ' *' then it is very likely a comment.
990 if (!defined $edge &&
991 $rawlines[$linenr] =~ m@^.\s* \*(?:\s|$)@)
992 {
993 $in_comment = 1;
994 }
995
996 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
997 sanitise_line_reset($in_comment);
998
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700999 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001000 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001001 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001002 $line = sanitise_line($rawline);
1003 }
1004 push(@lines, $line);
1005
1006 if ($realcnt > 1) {
1007 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1008 } else {
1009 $realcnt = 0;
1010 }
1011
1012 #print "==>$rawline\n";
1013 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001014
1015 if ($setup_docs && $line =~ /^\+/) {
1016 push(@setup_docs, $line);
1017 }
1018 }
1019
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001020 $prefix = '';
1021
Andy Whitcroft773647a2008-03-28 14:15:58 -07001022 $realcnt = 0;
1023 $linenr = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001024 foreach my $line (@lines) {
1025 $linenr++;
1026
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001027 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001028
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001029#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001030 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001031 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001032 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001033 $realline=$1-1;
1034 if (defined $2) {
1035 $realcnt=$3+1;
1036 } else {
1037 $realcnt=1+1;
1038 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001039 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001040 $prev_values = 'E';
1041
Andy Whitcroft773647a2008-03-28 14:15:58 -07001042 %suppress_ifbraces = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001043 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001044
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001045# track the line number as we move through the hunk, note that
1046# new versions of GNU diff omit the leading space on completely
1047# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001048 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001049 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001050 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001051
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001052 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001053 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001054
1055 # Track the previous line.
1056 ($prevline, $stashline) = ($stashline, $line);
1057 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001058 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1059
Andy Whitcroft773647a2008-03-28 14:15:58 -07001060 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001061
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001062 } elsif ($realcnt == 1) {
1063 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001064 }
1065
1066#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001067 $prefix = "$filename:$realline: " if ($emacs && $file);
1068 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1069
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001070 $here = "#$linenr: " if (!$file);
1071 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001072
1073 # extract the filename as it passes
1074 if ($line=~/^\+\+\+\s+(\S+)/) {
1075 $realfile = $1;
1076 $realfile =~ s@^[^/]*/@@;
1077
1078 if ($realfile =~ m@include/asm/@) {
1079 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1080 }
1081 next;
1082 }
1083
Randy Dunlap389834b2007-06-08 13:47:03 -07001084 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001085
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001086 my $hereline = "$here\n$rawline\n";
1087 my $herecurr = "$here\n$rawline\n";
1088 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001089
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001090 $cnt_lines++ if ($realcnt != 0);
1091
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001092#check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001093 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001094 # This is a signoff, if ugly, so do not double report.
1095 $signoff++;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001096 if (!($line =~ /^\s*Signed-off-by:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001097 WARN("Signed-off-by: is the preferred form\n" .
1098 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001099 }
1100 if ($line =~ /^\s*signed-off-by:\S/i) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001101 WARN("space required after Signed-off-by:\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001102 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001103 }
1104 }
1105
Andy Whitcroft00df3442007-06-08 13:47:06 -07001106# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001107 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001108 ERROR("patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001109 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001110 }
1111
1112# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1113 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001114 $rawline !~ m/^$UTF8*$/) {
1115 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1116
1117 my $blank = copy_spacing($rawline);
1118 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1119 my $hereptr = "$hereline$ptr\n";
1120
1121 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001122 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001123
Andy Whitcroft00df3442007-06-08 13:47:06 -07001124#ignore lines being removed
1125 if ($line=~/^-/) {next;}
1126
1127# check we are in a valid source file if not then ignore this hunk
1128 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001129
1130#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001131 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001132 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001133 ERROR("DOS line endings\n" . $herevet);
1134
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001135 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1136 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001137 ERROR("trailing whitespace\n" . $herevet);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001138 }
1139#80 column limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001140 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001141 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1142 $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1143 $length > 80)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001144 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001145 WARN("line over 80 characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001146 }
1147
Andy Whitcroft8905a672007-11-28 16:21:06 -08001148# check for adding lines without a newline.
1149 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1150 WARN("adding a line without newline at end of file\n" . $herecurr);
1151 }
1152
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001153# check we are in a valid source file *.[hc] if not then ignore this hunk
1154 next if ($realfile !~ /\.[hc]$/);
1155
1156# at the beginning of a line any tabs must come first and anything
1157# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001158 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1159 $rawline =~ /^\+\s* \s*/) {
1160 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001161 ERROR("code indent should use tabs where possible\n" . $herevet);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001162 }
1163
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001164# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001165 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001166 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1167 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001168
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001169# Check for potential 'bare' types
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001170 my ($stat, $cond);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001171 if ($realcnt && $line =~ /.\s*\S/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001172 ($stat, $cond) = ctx_statement_block($linenr,
1173 $realcnt, 0);
1174 $stat =~ s/\n./\n /g;
1175 $cond =~ s/\n./\n /g;
1176
1177 my $s = $stat;
1178 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001179
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001180 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001181 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001182
1183 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001184 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001185
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001186 # declarations always start with types
1187 } elsif ($prev_values eq 'E' && $s =~ /^.\s*(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?((?:\s*$Ident)+)\b(?:\s+$Sparse)?\s*\**\s*(?:$Ident|\(\*[^\)]*\))\s*(?:;|=|,|\()/s) {
1188 my $type = $1;
1189 $type =~ s/\s+/ /g;
1190 possible($type, "A:" . $s);
1191
Andy Whitcroft8905a672007-11-28 16:21:06 -08001192 # definitions in global scope can only start with types
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001193 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001194 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001195 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001196
1197 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001198 while ($s =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001199 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001200 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001201
1202 # Check for any sort of function declaration.
1203 # int foo(something bar, other baz);
1204 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001205 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 -08001206 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001207
Andy Whitcroftcf655042008-03-04 14:28:20 -08001208 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001209 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001210 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001211
Andy Whitcroft8905a672007-11-28 16:21:06 -08001212 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001213 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001214
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001215 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001216 }
1217 }
1218 }
1219
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001220 }
1221
Andy Whitcroft653d4872007-06-23 17:16:34 -07001222#
1223# Checks which may be anchored in the context.
1224#
1225
1226# Check for switch () and associated case and default
1227# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07001228 if ($line=~/\bswitch\s*\(.*\)/) {
1229 my $err = '';
1230 my $sep = '';
1231 my @ctx = ctx_block_outer($linenr, $realcnt);
1232 shift(@ctx);
1233 for my $ctx (@ctx) {
1234 my ($clen, $cindent) = line_stats($ctx);
1235 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1236 $indent != $cindent) {
1237 $err .= "$sep$ctx\n";
1238 $sep = '';
1239 } else {
1240 $sep = "[...]\n";
1241 }
1242 }
1243 if ($err ne '') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001244 ERROR("switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001245 }
1246 }
1247
1248# if/while/etc brace do not go on next line, unless defining a do while loop,
1249# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001250 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001251 my $pre_ctx = "$1$2";
1252
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001253 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001254 my $ctx_cnt = $realcnt - $#ctx - 1;
1255 my $ctx = join("\n", @ctx);
1256
Andy Whitcroft548596d2008-07-23 21:29:01 -07001257 my $ctx_ln = $linenr;
1258 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001259
Andy Whitcroft548596d2008-07-23 21:29:01 -07001260 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1261 defined $lines[$ctx_ln - 1] &&
1262 $lines[$ctx_ln - 1] =~ /^-/)) {
1263 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1264 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001265 $ctx_ln++;
1266 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07001267
1268 ##print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1269 ##print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001270
1271 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1272 ERROR("that open brace { should be on the previous line\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001273 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07001274 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001275 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1276 $ctx =~ /\)\s*\;\s*$/ &&
1277 defined $lines[$ctx_ln - 1])
1278 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001279 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1280 if ($nindent > $indent) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001281 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001282 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001283 }
1284 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001285 }
1286
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001287 # Track the 'values' across context and added lines.
1288 my $opline = $line; $opline =~ s/^./ /;
1289 my $curr_values = annotate_values($opline . "\n", $prev_values);
1290 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001291 if ($dbg_values) {
1292 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001293 print "$linenr > .$outline\n";
1294 print "$linenr > $curr_values\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001295 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001296 $prev_values = substr($curr_values, -1);
1297
Andy Whitcroft00df3442007-06-08 13:47:06 -07001298#ignore lines not being added
1299 if ($line=~/^[^\+]/) {next;}
1300
Andy Whitcroft653d4872007-06-23 17:16:34 -07001301# TEST: allow direct testing of the type matcher.
1302 if ($tst_type && $line =~ /^.$Declare$/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001303 ERROR("TEST: is type $Declare\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001304 next;
1305 }
1306
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001307# check for initialisation to aggregates open brace on the next line
1308 if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1309 $line =~ /^.\s*{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001310 ERROR("that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001311 }
1312
Andy Whitcroft653d4872007-06-23 17:16:34 -07001313#
1314# Checks which are anchored on the added line.
1315#
1316
1317# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001318 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001319 my $path = $1;
1320 if ($path =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001321 ERROR("malformed #include filename\n" .
1322 $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001323 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001324 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001325
1326# no C99 // comments
1327 if ($line =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001328 ERROR("do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001329 }
1330 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001331 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001332 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001333
1334#EXPORT_SYMBOL should immediately follow its function closing }.
Andy Whitcroft653d4872007-06-23 17:16:34 -07001335 if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1336 ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1337 my $name = $1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001338 if (($prevline !~ /^}/) &&
1339 ($prevline !~ /^\+}/) &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001340 ($prevline !~ /^ }/) &&
Andy Whitcroftcf655042008-03-04 14:28:20 -08001341 ($prevline !~ /^.DECLARE_$Ident\(\Q$name\E\)/) &&
1342 ($prevline !~ /^.LIST_HEAD\(\Q$name\E\)/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001343 ($prevline !~ /^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(/) &&
Andy Whitcroftcf655042008-03-04 14:28:20 -08001344 ($prevline !~ /\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001345 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001346 }
1347 }
1348
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001349# check for external initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001350 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001351 ERROR("do not initialise externals to 0 or NULL\n" .
1352 $herecurr);
1353 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001354# check for static initialisers.
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001355 if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001356 ERROR("do not initialise statics to 0 or NULL\n" .
1357 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001358 }
1359
Andy Whitcroft653d4872007-06-23 17:16:34 -07001360# check for new typedefs, only function parameters and sparse annotations
1361# make sense.
1362 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001363 $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001364 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001365 $line !~ /\b__bitwise(?:__|)\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001366 WARN("do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001367 }
1368
1369# * goes on variable not on type
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001370 if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001371 ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" .
1372 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001373
1374 } elsif ($line =~ m{\($NonptrType\s+(\*+)(?!\s+const)\s+\)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001375 ERROR("\"(foo $1 )\" should be \"(foo $1)\"\n" .
1376 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001377
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001378 } elsif ($line =~ m{$NonptrType(\*+)(?:\s+(?:$Attribute|$Sparse))?\s+[A-Za-z\d_]+}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001379 ERROR("\"foo$1 bar\" should be \"foo $1bar\"\n" .
1380 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001381
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001382 } elsif ($line =~ m{$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001383 ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" .
1384 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001385 }
1386
1387# # no BUG() or BUG_ON()
1388# if ($line =~ /\b(BUG|BUG_ON)\b/) {
1389# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1390# print "$herecurr";
1391# $clean = 0;
1392# }
1393
Andy Whitcroft8905a672007-11-28 16:21:06 -08001394 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001395 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 -08001396 }
1397
Andy Whitcroft00df3442007-06-08 13:47:06 -07001398# printk should use KERN_* levels. Note that follow on printk's on the
1399# same line do not need a level, so we use the current block context
1400# to try and find and validate the current printk. In summary the current
1401# printk includes all preceeding printk's which have no newline on the end.
1402# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001403 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001404 my $ok = 0;
1405 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1406 #print "CHECK<$lines[$ln - 1]\n";
1407 # we have a preceeding printk if it ends
1408 # with "\n" ignore it, else it is to blame
1409 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1410 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1411 $ok = 1;
1412 }
1413 last;
1414 }
1415 }
1416 if ($ok == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001417 WARN("printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001418 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001419 }
1420
Andy Whitcroft653d4872007-06-23 17:16:34 -07001421# function brace can't be on same line, except for #defines of do while,
1422# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001423 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1424 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001425 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001426 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001427
Andy Whitcroft8905a672007-11-28 16:21:06 -08001428# open braces for enum, union and struct go on the same line.
1429 if ($line =~ /^.\s*{/ &&
1430 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1431 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1432 }
1433
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001434# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001435 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001436 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001437 my $ctx_before = substr($line, 0, $-[1]);
1438 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001439
1440 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001441 if ($name =~ /^(?:
1442 if|for|while|switch|return|case|
1443 volatile|__volatile__|
1444 __attribute__|format|__extension__|
1445 asm|__asm__)$/x)
1446 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001447
1448 # cpp #define statements have non-optional spaces, ie
1449 # if there is a space between the name and the open
1450 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001451 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001452
1453 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001454 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001455
1456 # If this whole things ends with a type its most
1457 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001458 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001459
1460 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001461 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001462 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001463 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001464# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001465 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001466 my $ops = qr{
1467 <<=|>>=|<=|>=|==|!=|
1468 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1469 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001470 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001471 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001472 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001473 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001474
1475 my $blank = copy_spacing($opline);
1476
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001477 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001478 $off += length($elements[$n]);
1479
Andy Whitcroft773647a2008-03-28 14:15:58 -07001480 # Pick up the preceeding and succeeding characters.
1481 my $ca = substr($opline, 0, $off);
1482 my $cc = '';
1483 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1484 $cc = substr($opline, $off + length($elements[$n + 1]));
1485 }
1486 my $cb = "$ca$;$cc";
1487
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001488 my $a = '';
1489 $a = 'V' if ($elements[$n] ne '');
1490 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001491 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001492 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1493 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07001494 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001495
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001496 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001497
1498 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001499 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001500 $c = 'V' if ($elements[$n + 2] ne '');
1501 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001502 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001503 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1504 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001505 $c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001506 } else {
1507 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001508 }
1509
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001510 my $ctx = "${a}x${c}";
1511
1512 my $at = "(ctx:$ctx)";
1513
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001514 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001515 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001516
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001517 # Classify operators into binary, unary, or
1518 # definitions (* only) where they have more
1519 # than one mode.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001520 my $op_type = substr($curr_values, $off + 1, 1);
1521 my $op_left = substr($curr_values, $off, 1);
1522 my $is_unary;
1523 if ($op_type eq 'T') {
1524 $is_unary = 2;
1525 } elsif ($op_left eq 'V') {
1526 $is_unary = 0;
1527 } else {
1528 $is_unary = 1;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001529 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001530 #if ($op eq '-' || $op eq '&' || $op eq '*') {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001531 # print "UNARY: <$op_left$op_type $is_unary $a:$op:$c> <$ca:$op:$cc> <$unary_ctx>\n";
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001532 #}
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001533
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001534 # Ignore operators passed as parameters.
1535 if ($op_type ne 'V' &&
1536 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1537
Andy Whitcroftcf655042008-03-04 14:28:20 -08001538# # Ignore comments
1539# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001540
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001541 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001542 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001543 if ($ctx !~ /.x[WEBC]/ &&
1544 $cc !~ /^\\/ && $cc !~ /^;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001545 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001546 }
1547
1548 # // is a comment
1549 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001550
1551 # -> should have no spaces
1552 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001553 if ($ctx =~ /Wx.|.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001554 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001555 }
1556
1557 # , must have a space on the right.
1558 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001559 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001560 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001561 }
1562
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001563 # '*' as part of a type definition -- reported already.
1564 } elsif ($op eq '*' && $is_unary == 2) {
1565 #warn "'*' is part of type\n";
1566
1567 # unary operators should have a space before and
1568 # none after. May be left adjacent to another
1569 # unary operator, or a cast
1570 } elsif ($op eq '!' || $op eq '~' ||
1571 ($is_unary && ($op eq '*' || $op eq '-' || $op eq '&'))) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001572 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001573 ERROR("space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001574 }
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001575 if ($op eq '*' && $cc =~/\s*const\b/) {
1576 # A unary '*' may be const
1577
1578 } elsif ($ctx =~ /.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001579 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001580 }
1581
1582 # unary ++ and unary -- are allowed no space on one side.
1583 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001584 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1585 ERROR("space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001586 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001587 if ($ctx =~ /Wx[BE]/ ||
1588 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1589 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001590 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001591 if ($ctx =~ /ExW/) {
1592 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1593 }
1594
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001595
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001596 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001597 } elsif ($op eq '<<' or $op eq '>>' or
1598 $op eq '&' or $op eq '^' or $op eq '|' or
1599 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001600 $op eq '*' or $op eq '/' or
1601 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001602 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001603 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001604 ERROR("need consistent spacing around '$op' $at\n" .
1605 $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001606 }
1607
1608 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08001609 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001610 # Ignore email addresses <foo@bar>
1611 if (!($op eq '<' && $cb =~ /$;\S+\@\S+>/) &&
1612 !($op eq '>' && $cb =~ /<\S+\@\S+$;/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001613 ERROR("spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001614 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001615 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001616 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001617 }
1618 }
1619
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001620# check for multiple assignments
1621 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001622 CHK("multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001623 }
1624
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001625## # check for multiple declarations, allowing for a function declaration
1626## # continuation.
1627## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
1628## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
1629##
1630## # Remove any bracketed sections to ensure we do not
1631## # falsly report the parameters of functions.
1632## my $ln = $line;
1633## while ($ln =~ s/\([^\(\)]*\)//g) {
1634## }
1635## if ($ln =~ /,/) {
1636## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
1637## }
1638## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001639
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001640#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001641 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
1642 $line =~ /do{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001643 ERROR("space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001644 }
1645
1646# closing brace should have a space following it when it has anything
1647# on the line
1648 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001649 ERROR("space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001650 }
1651
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001652# check spacing on square brackets
1653 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001654 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001655 }
1656 if ($line =~ /\s\]/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001657 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001658 }
1659
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001660# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001661 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
1662 $line !~ /for\s*\(\s+;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001663 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001664 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001665 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001666 $line !~ /for\s*\(.*;\s+\)/ &&
1667 $line !~ /:\s+\)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001668 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001669 }
1670
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001671#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001672 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001673 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001674 WARN("labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001675 }
1676
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001677# Return is not a function.
1678 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
1679 my $spacing = $1;
1680 my $value = $2;
1681
1682 # Flatten any parentheses and braces
Andy Whitcroftfee61c42008-07-23 21:28:56 -07001683 $value =~ s/\)\(/\) \(/g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001684 while ($value =~ s/\([^\(\)]*\)/1/) {
1685 }
1686
1687 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
1688 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
1689
1690 } elsif ($spacing !~ /\s+/) {
1691 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1692 }
1693 }
1694
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001695# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001696 if ($line=~/\b(if|while|for|switch)\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001697 ERROR("space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001698 }
1699
1700# Check for illegal assignment in if conditional.
Andy Whitcroft8905a672007-11-28 16:21:06 -08001701 if ($line =~ /\bif\s*\(/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001702 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001703
1704 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001705 ERROR("do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001706 }
1707
1708 # Find out what is on the end of the line after the
1709 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001710 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001711 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001712 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft773647a2008-03-28 14:15:58 -07001713 if (length($c) && $s !~ /^\s*({|;|)\s*\\*\s*$/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001714 $c !~ /^.\s*\#\s*if/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001715 {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001716 ERROR("trailing statements should be on next line\n" . $herecurr);
1717 }
1718 }
1719
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001720# Check for bitwise tests written as boolean
1721 if ($line =~ /
1722 (?:
1723 (?:\[|\(|\&\&|\|\|)
1724 \s*0[xX][0-9]+\s*
1725 (?:\&\&|\|\|)
1726 |
1727 (?:\&\&|\|\|)
1728 \s*0[xX][0-9]+\s*
1729 (?:\&\&|\|\||\)|\])
1730 )/x)
1731 {
1732 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
1733 }
1734
Andy Whitcroft8905a672007-11-28 16:21:06 -08001735# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001736 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
1737 my $s = $1;
1738 $s =~ s/$;//g; # Remove any comments
1739 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
1740 ERROR("trailing statements should be on next line\n" . $herecurr);
1741 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001742 }
1743
1744 # Check for }<nl>else {, these must be at the same
1745 # indent level to be relevant to each other.
1746 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
1747 $previndent == $indent) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001748 ERROR("else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001749 }
1750
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001751 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
1752 $previndent == $indent) {
1753 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
1754
1755 # Find out what is on the end of the line after the
1756 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001757 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001758 $s =~ s/\n.*//g;
1759
1760 if ($s =~ /^\s*;/) {
1761 ERROR("while should follow close brace '}'\n" . $hereprev);
1762 }
1763 }
1764
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001765#studly caps, commented out until figure out how to distinguish between use of existing and adding new
1766# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
1767# print "No studly caps, use _\n";
1768# print "$herecurr";
1769# $clean = 0;
1770# }
1771
1772#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001773 if ($line=~/\#\s*define.*\\\s$/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001774 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001775 }
1776
Andy Whitcroft653d4872007-06-23 17:16:34 -07001777#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001778 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
1779 my $checkfile = "include/linux/$1.h";
1780 if (-f "$root/$checkfile" && $realfile ne $checkfile &&
1781 $1 ne 'irq')
1782 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001783 WARN("Use #include <linux/$1.h> instead of <asm/$1.h>\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001784 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001785 }
1786 }
1787
Andy Whitcroft653d4872007-06-23 17:16:34 -07001788# multi-statement macros should be enclosed in a do while loop, grab the
1789# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08001790# in a known good container
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001791 if ($line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001792 my $ln = $linenr;
1793 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001794 my ($off, $dstat, $dcond, $rest);
1795 my $ctx = '';
Andy Whitcroft653d4872007-06-23 17:16:34 -07001796
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001797 my $args = defined($1);
1798
1799 # Find the end of the macro and limit our statement
1800 # search to that.
1801 while ($cnt > 0 && defined $lines[$ln - 1] &&
1802 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
1803 {
1804 $ctx .= $rawlines[$ln - 1] . "\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001805 $cnt-- if ($lines[$ln - 1] !~ /^-/);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001806 $ln++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001807 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001808 $ctx .= $rawlines[$ln - 1];
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001809
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001810 ($dstat, $dcond, $ln, $cnt, $off) =
1811 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
1812 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001813 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001814
1815 # Extract the remainder of the define (if any) and
1816 # rip off surrounding spaces, and trailing \'s.
1817 $rest = '';
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001818 while ($off != 0 || ($cnt > 0 && $rest =~ /(?:^|\\)\s*$/)) {
1819 #print "ADDING $off <" . substr($lines[$ln - 1], $off) . ">\n";
1820 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
1821 $rest .= substr($lines[$ln - 1], $off) . "\n";
1822 $cnt--;
1823 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001824 $ln++;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001825 $off = 0;
1826 }
1827 $rest =~ s/\\\n.//g;
1828 $rest =~ s/^\s*//s;
1829 $rest =~ s/\s*$//s;
1830
1831 # Clean up the original statement.
1832 if ($args) {
1833 substr($dstat, 0, length($dcond), '');
1834 } else {
1835 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
1836 }
1837 $dstat =~ s/\\\n.//g;
1838 $dstat =~ s/^\s*//s;
1839 $dstat =~ s/\s*$//s;
1840
1841 # Flatten any parentheses and braces
1842 while ($dstat =~ s/\([^\(\)]*\)/1/) {
1843 }
1844 while ($dstat =~ s/\{[^\{\}]*\}/1/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001845 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001846
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001847 my $exceptions = qr{
1848 $Declare|
1849 module_param_named|
1850 MODULE_PARAM_DESC|
1851 DECLARE_PER_CPU|
1852 DEFINE_PER_CPU|
1853 __typeof__\(
1854 }x;
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001855 #print "REST<$rest>\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001856 if ($rest ne '') {
1857 if ($rest !~ /while\s*\(/ &&
1858 $dstat !~ /$exceptions/)
1859 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001860 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 -07001861 }
1862
1863 } elsif ($ctx !~ /;/) {
1864 if ($dstat ne '' &&
1865 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
1866 $dstat !~ /$exceptions/ &&
1867 $dstat =~ /$Operators/)
1868 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001869 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001870 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001871 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001872 }
1873
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001874# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001875 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
1876 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08001877 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001878 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001879 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
1880 if ($#chunks > 0 && $level == 0) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001881 my $allowed = 0;
1882 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001883 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001884 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001885 for my $chunk (@chunks) {
1886 my ($cond, $block) = @{$chunk};
1887
Andy Whitcroft773647a2008-03-28 14:15:58 -07001888 # If the condition carries leading newlines, then count those as offsets.
1889 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
1890 my $offset = statement_rawlines($whitespace) - 1;
1891
1892 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
1893
1894 # We have looked at and allowed this specific line.
1895 $suppress_ifbraces{$ln + $offset} = 1;
1896
1897 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001898 $ln += statement_rawlines($block) - 1;
1899
Andy Whitcroft773647a2008-03-28 14:15:58 -07001900 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001901
1902 $seen++ if ($block =~ /^\s*{/);
1903
Andy Whitcroftcf655042008-03-04 14:28:20 -08001904 #print "cond<$cond> block<$block> allowed<$allowed>\n";
1905 if (statement_lines($cond) > 1) {
1906 #print "APW: ALLOWED: cond<$cond>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001907 $allowed = 1;
1908 }
1909 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001910 #print "APW: ALLOWED: block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001911 $allowed = 1;
1912 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001913 if (statement_block_size($block) > 1) {
1914 #print "APW: ALLOWED: lines block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001915 $allowed = 1;
1916 }
1917 }
1918 if ($seen && !$allowed) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001919 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001920 }
1921 }
1922 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001923 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001924 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001925 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001926
Andy Whitcroftcf655042008-03-04 14:28:20 -08001927 # Check the pre-context.
1928 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
1929 #print "APW: ALLOWED: pre<$1>\n";
1930 $allowed = 1;
1931 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001932
1933 my ($level, $endln, @chunks) =
1934 ctx_statement_full($linenr, $realcnt, $-[0]);
1935
Andy Whitcroftcf655042008-03-04 14:28:20 -08001936 # Check the condition.
1937 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07001938 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001939 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001940 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08001941 }
1942 if (statement_lines($cond) > 1) {
1943 #print "APW: ALLOWED: cond<$cond>\n";
1944 $allowed = 1;
1945 }
1946 if ($block =~/\b(?:if|for|while)\b/) {
1947 #print "APW: ALLOWED: block<$block>\n";
1948 $allowed = 1;
1949 }
1950 if (statement_block_size($block) > 1) {
1951 #print "APW: ALLOWED: lines block<$block>\n";
1952 $allowed = 1;
1953 }
1954 # Check the post-context.
1955 if (defined $chunks[1]) {
1956 my ($cond, $block) = @{$chunks[1]};
1957 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001958 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001959 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001960 if ($block =~ /^\s*\{/) {
1961 #print "APW: ALLOWED: chunk-1 block<$block>\n";
1962 $allowed = 1;
1963 }
1964 }
1965 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
1966 my $herectx = $here . "\n";;
1967 my $end = $linenr + statement_rawlines($block) - 1;
1968
1969 for (my $ln = $linenr - 1; $ln < $end; $ln++) {
1970 $herectx .= $rawlines[$ln] . "\n";;
1971 }
1972
1973 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001974 }
1975 }
1976
Andy Whitcroft653d4872007-06-23 17:16:34 -07001977# don't include deprecated include files (uses RAW line)
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001978 for my $inc (@dep_includes) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001979 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001980 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001981 }
1982 }
1983
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001984# don't use deprecated functions
1985 for my $func (@dep_functions) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001986 if ($line =~ /\b$func\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001987 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001988 }
1989 }
1990
1991# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001992 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
1993 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001994 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001995 }
1996
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001997# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
1998 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
1999 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2000 }
2001
Andy Whitcroft00df3442007-06-08 13:47:06 -07002002# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002003 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002004 CHK("if this code is redundant consider removing it\n" .
2005 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002006 }
2007
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002008# check for needless kfree() checks
2009 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2010 my $expr = $1;
2011 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
2012 WARN("kfree(NULL) is safe this check is probabally not required\n" . $hereprev);
2013 }
2014 }
2015
Andy Whitcroft00df3442007-06-08 13:47:06 -07002016# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002017# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002018# print "#ifdef in C files should be avoided\n";
2019# print "$herecurr";
2020# $clean = 0;
2021# }
2022
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002023# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002024 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002025 ERROR("exactly one space required after that #$1\n" . $herecurr);
2026 }
2027
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002028# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002029 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2030 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002031 my $which = $1;
2032 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002033 CHK("$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002034 }
2035 }
2036# check for memory barriers without a comment.
2037 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2038 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002039 CHK("memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002040 }
2041 }
2042# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002043 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002044 CHK("architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002045 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002046
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002047# check the location of the inline attribute, that it is between
2048# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002049 if ($line =~ /\b$Type\s+$Inline\b/ ||
2050 $line =~ /\b$Inline\s+$Storage\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002051 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2052 }
2053
Andy Whitcroft8905a672007-11-28 16:21:06 -08002054# Check for __inline__ and __inline, prefer inline
2055 if ($line =~ /\b(__inline__|__inline)\b/) {
2056 WARN("plain inline is preferred over $1\n" . $herecurr);
2057 }
2058
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002059# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002060 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002061 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002062 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002063 my $function_name = $1;
2064 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002065
2066 my $s = $stat;
2067 if (defined $cond) {
2068 substr($s, 0, length($cond), '');
2069 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002070 if ($s =~ /^\s*;/ &&
2071 $function_name ne 'uninitialized_var')
2072 {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002073 WARN("externs should be avoided in .c files\n" . $herecurr);
2074 }
2075
2076 if ($paren_space =~ /\n/) {
2077 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2078 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002079
2080 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2081 $stat =~ /^.\s*extern\s+/)
2082 {
2083 WARN("externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002084 }
2085
2086# checks for new __setup's
2087 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2088 my $name = $1;
2089
2090 if (!grep(/$name/, @setup_docs)) {
2091 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2092 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002093 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002094
2095# check for pointless casting of kmalloc return
2096 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2097 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2098 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002099
2100# check for gcc specific __FUNCTION__
2101 if ($line =~ /__FUNCTION__/) {
2102 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2103 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002104
2105# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002106 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002107 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2108 }
2109# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002110 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002111 WARN("consider using a completion\n" . $herecurr);
2112 }
2113# recommend strict_strto* over simple_strto*
2114 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2115 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2116 }
Michael Ellermanf3db6632008-07-23 21:28:57 -07002117# check for __initcall(), use device_initcall() explicitly please
2118 if ($line =~ /^.\s*__initcall\s*\(/) {
2119 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2120 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002121
2122# use of NR_CPUS is usually wrong
2123# ignore definitions of NR_CPUS and usage to define arrays as likely right
2124 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002125 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2126 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002127 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2128 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2129 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002130 {
2131 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2132 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002133
2134# check for %L{u,d,i} in strings
2135 my $string;
2136 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2137 $string = substr($rawline, $-[1], $+[1] - $-[1]);
2138 if ($string =~ /(?<!%)%L[udi]/) {
2139 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2140 last;
2141 }
2142 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002143 }
2144
2145 # If we have no input at all, then there is nothing to report on
2146 # so just keep quiet.
2147 if ($#rawlines == -1) {
2148 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002149 }
2150
Andy Whitcroft8905a672007-11-28 16:21:06 -08002151 # In mailback mode only produce a report in the negative, for
2152 # things that appear to be patches.
2153 if ($mailback && ($clean == 1 || !$is_patch)) {
2154 exit(0);
2155 }
2156
2157 # This is not a patch, and we are are in 'no-patch' mode so
2158 # just keep quiet.
2159 if (!$chk_patch && !$is_patch) {
2160 exit(0);
2161 }
2162
2163 if (!$is_patch) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002164 ERROR("Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002165 }
2166 if ($is_patch && $chk_signoff && $signoff == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002167 ERROR("Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002168 }
2169
Andy Whitcroft8905a672007-11-28 16:21:06 -08002170 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002171 if ($summary && !($clean == 1 && $quiet == 1)) {
2172 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002173 print "total: $cnt_error errors, $cnt_warn warnings, " .
2174 (($check)? "$cnt_chk checks, " : "") .
2175 "$cnt_lines lines checked\n";
2176 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002177 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002178
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002179 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002180 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002181 }
2182 if ($clean == 0 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002183 print "$vname has style problems, please review. If any of these errors\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002184 print "are false positives report them to the maintainer, see\n";
2185 print "CHECKPATCH in MAINTAINERS.\n";
2186 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002187
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002188 return $clean;
2189}