blob: 2c1afba5758040db527674a621855663899ac510 [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 Whitcroft5fdd23a2008-10-15 22:02:28 -070012my $V = '0.23';
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 Whitcroft773647a2008-03-28 14:15:58 -070020my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070021my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080022my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070023my $file = 0;
24my $check = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080025my $summary = 1;
26my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080027my $summary_file = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070028my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080029my %debug;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070030GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070031 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-06-01 00:46:48 -070032 'tree!' => \$tree,
33 'signoff!' => \$chk_signoff,
34 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070035 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -080036 'terse!' => \$terse,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070037 'file!' => \$file,
38 'subjective!' => \$check,
39 'strict!' => \$check,
40 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -080041 'summary!' => \$summary,
42 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -080043 'summary-file!' => \$summary_file,
44
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080045 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -070046 'test-only=s' => \$tst_only,
Andy Whitcroft0a920b52007-06-01 00:46:48 -070047) or exit;
48
49my $exit = 0;
50
51if ($#ARGV < 0) {
Andy Whitcroft00df3442007-06-08 13:47:06 -070052 print "usage: $P [options] patchfile\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -070053 print "version: $V\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -080054 print "options: -q => quiet\n";
55 print " --no-tree => run without a kernel tree\n";
56 print " --terse => one line per report\n";
57 print " --emacs => emacs compile window format\n";
58 print " --file => check a source file\n";
59 print " --strict => enable more subjective tests\n";
60 print " --root => path to the kernel tree root\n";
61 print " --no-summary => suppress the per-file summary\n";
62 print " --summary-file => include the filename in summary\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -070063 exit(1);
64}
65
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080066my $dbg_values = 0;
67my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -070068my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -070069my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080070for 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|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700116 __(?:mem|cpu|dev|)(?:initdata|init)|
117 ____cacheline_aligned|
118 ____cacheline_aligned_in_smp|
119 ____cacheline_internodealigned_in_smp
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700120 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700121our $Modifier;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700122our $Inline = qr{inline|__always_inline|noinline};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700123our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
124our $Lval = qr{$Ident(?:$Member)*};
125
126our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
127our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
128our $Operators = qr{
129 <=|>=|==|!=|
130 =>|->|<<|>>|<|>|!|~|
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800131 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700132 }x;
133
Andy Whitcroft8905a672007-11-28 16:21:06 -0800134our $NonptrType;
135our $Type;
136our $Declare;
137
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700138our $UTF8 = qr {
139 [\x09\x0A\x0D\x20-\x7E] # ASCII
140 | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
141 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
142 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
143 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
144 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
145 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
146 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
147}x;
148
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700149our $typeTypedefs = qr{(?x:
150 (?:__)?(?:u|s|be|le)(?:\d|\d\d)|
151 atomic_t
152)};
153
Andy Whitcroft8905a672007-11-28 16:21:06 -0800154our @typeList = (
155 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700156 qr{(?:unsigned\s+)?char},
157 qr{(?:unsigned\s+)?short},
158 qr{(?:unsigned\s+)?int},
159 qr{(?:unsigned\s+)?long},
160 qr{(?:unsigned\s+)?long\s+int},
161 qr{(?:unsigned\s+)?long\s+long},
162 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800163 qr{unsigned},
164 qr{float},
165 qr{double},
166 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800167 qr{struct\s+$Ident},
168 qr{union\s+$Ident},
169 qr{enum\s+$Ident},
170 qr{${Ident}_t},
171 qr{${Ident}_handler},
172 qr{${Ident}_handler_fn},
173);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700174our @modifierList = (
175 qr{fastcall},
176);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800177
178sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700179 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
180 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700181 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800182 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700183 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800184 (?:
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700185 (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700186 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700187 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800188 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700189 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800190 }x;
191 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700192 $NonptrType
Andy Whitcroft8905a672007-11-28 16:21:06 -0800193 (?:\s*\*+\s*const|\s*\*+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700194 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800195 }x;
196 $Declare = qr{(?:$Storage\s+)?$Type};
197}
198build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700199
200$chk_signoff = 0 if ($file);
201
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700202my @dep_includes = ();
203my @dep_functions = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700204my $removal = "Documentation/feature-removal-schedule.txt";
205if ($tree && -f "$root/$removal") {
206 open(REMOVE, "<$root/$removal") ||
207 die "$P: $removal: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700208 while (<REMOVE>) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700209 if (/^Check:\s+(.*\S)/) {
210 for my $entry (split(/[, ]+/, $1)) {
211 if ($entry =~ m@include/(.*)@) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700212 push(@dep_includes, $1);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700213
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700214 } elsif ($entry !~ m@/@) {
215 push(@dep_functions, $entry);
216 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700217 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700218 }
219 }
220}
221
Andy Whitcroft00df3442007-06-08 13:47:06 -0700222my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800223my @lines = ();
224my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700225for my $filename (@ARGV) {
226 if ($file) {
227 open(FILE, "diff -u /dev/null $filename|") ||
228 die "$P: $filename: diff failed - $!\n";
229 } else {
230 open(FILE, "<$filename") ||
231 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700232 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800233 if ($filename eq '-') {
234 $vname = 'Your patch';
235 } else {
236 $vname = $filename;
237 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700238 while (<FILE>) {
239 chomp;
240 push(@rawlines, $_);
241 }
242 close(FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800243 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700244 $exit = 1;
245 }
246 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800247 @lines = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700248}
249
250exit($exit);
251
252sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700253 my ($root) = @_;
254
255 my @tree_check = (
256 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
257 "README", "Documentation", "arch", "include", "drivers",
258 "fs", "init", "ipc", "kernel", "lib", "scripts",
259 );
260
261 foreach my $check (@tree_check) {
262 if (! -e $root . '/' . $check) {
263 return 0;
264 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700265 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700266 return 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700267}
268
269sub expand_tabs {
270 my ($str) = @_;
271
272 my $res = '';
273 my $n = 0;
274 for my $c (split(//, $str)) {
275 if ($c eq "\t") {
276 $res .= ' ';
277 $n++;
278 for (; ($n % 8) != 0; $n++) {
279 $res .= ' ';
280 }
281 next;
282 }
283 $res .= $c;
284 $n++;
285 }
286
287 return $res;
288}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700289sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700290 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700291 return $res;
292}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700293
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700294sub line_stats {
295 my ($line) = @_;
296
297 # Drop the diff line leader and expand tabs
298 $line =~ s/^.//;
299 $line = expand_tabs($line);
300
301 # Pick the indent from the front of the line.
302 my ($white) = ($line =~ /^(\s*)/);
303
304 return (length($line), length($white));
305}
306
Andy Whitcroft773647a2008-03-28 14:15:58 -0700307my $sanitise_quote = '';
308
309sub sanitise_line_reset {
310 my ($in_comment) = @_;
311
312 if ($in_comment) {
313 $sanitise_quote = '*/';
314 } else {
315 $sanitise_quote = '';
316 }
317}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700318sub sanitise_line {
319 my ($line) = @_;
320
321 my $res = '';
322 my $l = '';
323
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800324 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700325 my $off = 0;
326 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700327
Andy Whitcroft773647a2008-03-28 14:15:58 -0700328 # Always copy over the diff marker.
329 $res = substr($line, 0, 1);
330
331 for ($off = 1; $off < length($line); $off++) {
332 $c = substr($line, $off, 1);
333
334 # Comments we are wacking completly including the begin
335 # and end, all to $;.
336 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
337 $sanitise_quote = '*/';
338
339 substr($res, $off, 2, "$;$;");
340 $off++;
341 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800342 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700343 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700344 $sanitise_quote = '';
345 substr($res, $off, 2, "$;$;");
346 $off++;
347 next;
348 }
349
350 # A \ in a string means ignore the next character.
351 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
352 $c eq "\\") {
353 substr($res, $off, 2, 'XX');
354 $off++;
355 next;
356 }
357 # Regular quotes.
358 if ($c eq "'" || $c eq '"') {
359 if ($sanitise_quote eq '') {
360 $sanitise_quote = $c;
361
362 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700363 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700364 } elsif ($sanitise_quote eq $c) {
365 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700366 }
367 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700368
369 #print "SQ:$sanitise_quote\n";
370 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
371 substr($res, $off, 1, $;);
372 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
373 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700374 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700375 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700376 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800377 }
378
379 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700380 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800381 my $clean = 'X' x length($1);
382 $res =~ s@\<.*\>@<$clean>@;
383
384 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700385 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800386 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700387 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800388 }
389
Andy Whitcroft00df3442007-06-08 13:47:06 -0700390 return $res;
391}
392
Andy Whitcroft8905a672007-11-28 16:21:06 -0800393sub ctx_statement_block {
394 my ($linenr, $remain, $off) = @_;
395 my $line = $linenr - 1;
396 my $blk = '';
397 my $soff = $off;
398 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700399 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800400
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800401 my $loff = 0;
402
Andy Whitcroft8905a672007-11-28 16:21:06 -0800403 my $type = '';
404 my $level = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800405 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800406 my $c;
407 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800408
409 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800410 while (1) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700411 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800412 # If we are about to drop off the end, pull in more
413 # context.
414 if ($off >= $len) {
415 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700416 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800417 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800418 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800419 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800420 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800421 $len = length($blk);
422 $line++;
423 last;
424 }
425 # Bail if there is no further context.
426 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800427 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800428 last;
429 }
430 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800431 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800432 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800433 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800434
Andy Whitcroft773647a2008-03-28 14:15:58 -0700435 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800436 # Statement ends at the ';' or a close '}' at the
437 # outermost level.
438 if ($level == 0 && $c eq ';') {
439 last;
440 }
441
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800442 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700443 if ($level == 0 && $coff_set == 0 &&
444 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
445 $remainder =~ /^(else)(?:\s|{)/ &&
446 $remainder !~ /^else\s+if\b/) {
447 $coff = $off + length($1) - 1;
448 $coff_set = 1;
449 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
450 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800451 }
452
Andy Whitcroft8905a672007-11-28 16:21:06 -0800453 if (($type eq '' || $type eq '(') && $c eq '(') {
454 $level++;
455 $type = '(';
456 }
457 if ($type eq '(' && $c eq ')') {
458 $level--;
459 $type = ($level != 0)? '(' : '';
460
461 if ($level == 0 && $coff < $soff) {
462 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700463 $coff_set = 1;
464 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800465 }
466 }
467 if (($type eq '' || $type eq '{') && $c eq '{') {
468 $level++;
469 $type = '{';
470 }
471 if ($type eq '{' && $c eq '}') {
472 $level--;
473 $type = ($level != 0)? '{' : '';
474
475 if ($level == 0) {
476 last;
477 }
478 }
479 $off++;
480 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700481 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800482 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700483 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800484 $line++;
485 $remain--;
486 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800487
488 my $statement = substr($blk, $soff, $off - $soff + 1);
489 my $condition = substr($blk, $soff, $coff - $soff + 1);
490
491 #warn "STATEMENT<$statement>\n";
492 #warn "CONDITION<$condition>\n";
493
Andy Whitcroft773647a2008-03-28 14:15:58 -0700494 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800495
496 return ($statement, $condition,
497 $line, $remain + 1, $off - $loff + 1, $level);
498}
499
Andy Whitcroftcf655042008-03-04 14:28:20 -0800500sub statement_lines {
501 my ($stmt) = @_;
502
503 # Strip the diff line prefixes and rip blank lines at start and end.
504 $stmt =~ s/(^|\n)./$1/g;
505 $stmt =~ s/^\s*//;
506 $stmt =~ s/\s*$//;
507
508 my @stmt_lines = ($stmt =~ /\n/g);
509
510 return $#stmt_lines + 2;
511}
512
513sub statement_rawlines {
514 my ($stmt) = @_;
515
516 my @stmt_lines = ($stmt =~ /\n/g);
517
518 return $#stmt_lines + 2;
519}
520
521sub statement_block_size {
522 my ($stmt) = @_;
523
524 $stmt =~ s/(^|\n)./$1/g;
525 $stmt =~ s/^\s*{//;
526 $stmt =~ s/}\s*$//;
527 $stmt =~ s/^\s*//;
528 $stmt =~ s/\s*$//;
529
530 my @stmt_lines = ($stmt =~ /\n/g);
531 my @stmt_statements = ($stmt =~ /;/g);
532
533 my $stmt_lines = $#stmt_lines + 2;
534 my $stmt_statements = $#stmt_statements + 1;
535
536 if ($stmt_lines > $stmt_statements) {
537 return $stmt_lines;
538 } else {
539 return $stmt_statements;
540 }
541}
542
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800543sub ctx_statement_full {
544 my ($linenr, $remain, $off) = @_;
545 my ($statement, $condition, $level);
546
547 my (@chunks);
548
Andy Whitcroftcf655042008-03-04 14:28:20 -0800549 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800550 ($statement, $condition, $linenr, $remain, $off, $level) =
551 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700552 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800553 push(@chunks, [ $condition, $statement ]);
554 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
555 return ($level, $linenr, @chunks);
556 }
557
558 # Pull in the following conditional/block pairs and see if they
559 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800560 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800561 ($statement, $condition, $linenr, $remain, $off, $level) =
562 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800563 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700564 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800565 #print "C: push\n";
566 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800567 }
568
569 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800570}
571
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700572sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700573 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700574 my $line;
575 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700576 my $blk = '';
577 my @o;
578 my @c;
579 my @res = ();
580
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700581 my $level = 0;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700582 for ($line = $start; $remain > 0; $line++) {
583 next if ($rawlines[$line] =~ /^-/);
584 $remain--;
585
586 $blk .= $rawlines[$line];
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700587 foreach my $c (split(//, $rawlines[$line])) {
588 ##print "C<$c>L<$level><$open$close>O<$off>\n";
589 if ($off > 0) {
590 $off--;
591 next;
592 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700593
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700594 if ($c eq $close && $level > 0) {
595 $level--;
596 last if ($level == 0);
597 } elsif ($c eq $open) {
598 $level++;
599 }
600 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700601
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700602 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700603 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700604 }
605
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700606 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700607 }
608
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700609 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700610}
611sub ctx_block_outer {
612 my ($linenr, $remain) = @_;
613
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700614 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
615 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700616}
617sub ctx_block {
618 my ($linenr, $remain) = @_;
619
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700620 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
621 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700622}
623sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700624 my ($linenr, $remain, $off) = @_;
625
626 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
627 return @r;
628}
629sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700630 my ($linenr, $remain) = @_;
631
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700632 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700633}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700634sub ctx_statement_level {
635 my ($linenr, $remain, $off) = @_;
636
637 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
638}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700639
640sub ctx_locate_comment {
641 my ($first_line, $end_line) = @_;
642
643 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700644 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700645 return $current_comment if (defined $current_comment);
646
647 # Look through the context and try and figure out if there is a
648 # comment.
649 my $in_comment = 0;
650 $current_comment = '';
651 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700652 my $line = $rawlines[$linenr - 1];
653 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700654 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
655 $in_comment = 1;
656 }
657 if ($line =~ m@/\*@) {
658 $in_comment = 1;
659 }
660 if (!$in_comment && $current_comment ne '') {
661 $current_comment = '';
662 }
663 $current_comment .= $line . "\n" if ($in_comment);
664 if ($line =~ m@\*/@) {
665 $in_comment = 0;
666 }
667 }
668
669 chomp($current_comment);
670 return($current_comment);
671}
672sub ctx_has_comment {
673 my ($first_line, $end_line) = @_;
674 my $cmt = ctx_locate_comment($first_line, $end_line);
675
Andy Whitcroft00df3442007-06-08 13:47:06 -0700676 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700677 ##print "CMMT: $cmt\n";
678
679 return ($cmt ne '');
680}
681
Andy Whitcroft4d001e42008-10-15 22:02:21 -0700682sub raw_line {
683 my ($linenr, $cnt) = @_;
684
685 my $offset = $linenr - 1;
686 $cnt++;
687
688 my $line;
689 while ($cnt) {
690 $line = $rawlines[$offset++];
691 next if (defined($line) && $line =~ /^-/);
692 $cnt--;
693 }
694
695 return $line;
696}
697
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700698sub cat_vet {
699 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700700 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700701
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700702 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700703 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
704 $res .= $1;
705 if ($2 ne '') {
706 $coded = sprintf("^%c", unpack('C', $2) + 64);
707 $res .= $coded;
708 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700709 }
710 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700711
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700712 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700713}
714
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800715my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800716my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800717my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700718my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800719
720sub annotate_reset {
721 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800722 $av_pending = '_';
723 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700724 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800725}
726
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700727sub annotate_values {
728 my ($stream, $type) = @_;
729
730 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700731 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700732 my $cur = $stream;
733
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800734 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700735
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700736 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700737 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800738 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700739 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700740 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800741 print "WS($1)\n" if ($dbg_values > 1);
742 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800743 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800744 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700745 }
746
Andy Whitcroft8ea3eb92008-07-23 21:29:08 -0700747 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800748 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700749 $type = 'T';
750
Andy Whitcroft389a2fe2008-07-23 21:29:05 -0700751 } elsif ($cur =~ /^($Modifier)\s*/) {
752 print "MODIFIER($1)\n" if ($dbg_values > 1);
753 $type = 'T';
754
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700755 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700756 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800757 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700758 push(@av_paren_type, $type);
759 if ($2 ne '') {
760 $av_pending = 'N';
761 }
762 $type = 'E';
763
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700764 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700765 print "UNDEF($1)\n" if ($dbg_values > 1);
766 $av_preprocessor = 1;
767 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700768
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700769 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800770 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800771 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800772
773 push(@av_paren_type, $type);
774 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700775 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800776
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700777 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800778 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
779 $av_preprocessor = 1;
780
781 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
782
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700783 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800784
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700785 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800786 print "PRE_END($1)\n" if ($dbg_values > 1);
787
788 $av_preprocessor = 1;
789
790 # Assume all arms of the conditional end as this
791 # one does, and continue as if the #endif was not here.
792 pop(@av_paren_type);
793 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700794 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700795
796 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800797 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700798
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700799 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
800 print "ATTR($1)\n" if ($dbg_values > 1);
801 $av_pending = $type;
802 $type = 'N';
803
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700804 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800805 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700806 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800807 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700808 }
809 $type = 'N';
810
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700811 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800812 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700813 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700814 $type = 'N';
815
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700816 } elsif ($cur =~/^(case)/o) {
817 print "CASE($1)\n" if ($dbg_values > 1);
818 $av_pend_colon = 'C';
819 $type = 'N';
820
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700821 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800822 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700823 $type = 'N';
824
825 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800826 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800827 push(@av_paren_type, $av_pending);
828 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700829 $type = 'N';
830
831 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800832 my $new_type = pop(@av_paren_type);
833 if ($new_type ne '_') {
834 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800835 print "PAREN('$1') -> $type\n"
836 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700837 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800838 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700839 }
840
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700841 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800842 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700843 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800844 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700845
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700846 } elsif ($cur =~ /^($Ident\s*):/) {
847 if ($type eq 'E') {
848 $av_pend_colon = 'L';
849 } elsif ($type eq 'T') {
850 $av_pend_colon = 'B';
851 }
852 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
853 $type = 'V';
854
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700855 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800856 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700857 $type = 'V';
858
859 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800860 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700861 $type = 'N';
862
Andy Whitcroftcf655042008-03-04 14:28:20 -0800863 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800864 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800865 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700866 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800867
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700868 } elsif ($cur =~ /^(\?)/o) {
869 print "QUESTION($1)\n" if ($dbg_values > 1);
870 $type = 'N';
871
872 } elsif ($cur =~ /^(:)/o) {
873 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
874
875 substr($var, length($res), 1, $av_pend_colon);
876 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
877 $type = 'E';
878 } else {
879 $type = 'N';
880 }
881 $av_pend_colon = 'O';
882
883 } elsif ($cur =~ /^(;|\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800884 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700885 $type = 'N';
886
Andy Whitcroft0d413862008-10-15 22:02:16 -0700887 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -0700888 my $variant;
889
890 print "OPV($1)\n" if ($dbg_values > 1);
891 if ($type eq 'V') {
892 $variant = 'B';
893 } else {
894 $variant = 'U';
895 }
896
897 substr($var, length($res), 1, $variant);
898 $type = 'N';
899
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700900 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800901 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700902 if ($1 ne '++' && $1 ne '--') {
903 $type = 'N';
904 }
905
906 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800907 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700908 }
909 if (defined $1) {
910 $cur = substr($cur, length($1));
911 $res .= $type x length($1);
912 }
913 }
914
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700915 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700916}
917
Andy Whitcroft8905a672007-11-28 16:21:06 -0800918sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800919 my ($possible, $line) = @_;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800920
Andy Whitcroft0776e592008-10-15 22:02:29 -0700921 print "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
922 if ($possible !~ /(?:
923 ^(?:
924 $Modifier|
925 $Storage|
926 $Type|
927 DEFINE_\S+|
928 goto|
929 return|
930 case|
931 else|
932 asm|__asm__|
933 do
934 )$|
935 ^(?:typedef|struct|enum)\b
936 )/x) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700937 # Check for modifiers.
938 $possible =~ s/\s*$Storage\s*//g;
939 $possible =~ s/\s*$Sparse\s*//g;
940 if ($possible =~ /^\s*$/) {
941
942 } elsif ($possible =~ /\s/) {
943 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -0700944 for my $modifier (split(' ', $possible)) {
945 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
946 push(@modifierList, $modifier);
947 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700948
949 } else {
950 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
951 push(@typeList, $possible);
952 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800953 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -0700954 } else {
955 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800956 }
957}
958
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700959my $prefix = '';
960
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700961sub report {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700962 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
963 return 0;
964 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800965 my $line = $prefix . $_[0];
966
967 $line = (split('\n', $line))[0] . "\n" if ($terse);
968
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800969 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700970
971 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700972}
973sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800974 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700975}
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700976sub ERROR {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700977 if (report("ERROR: $_[0]\n")) {
978 our $clean = 0;
979 our $cnt_error++;
980 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700981}
982sub WARN {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700983 if (report("WARNING: $_[0]\n")) {
984 our $clean = 0;
985 our $cnt_warn++;
986 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700987}
988sub CHK {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700989 if ($check && report("CHECK: $_[0]\n")) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700990 our $clean = 0;
991 our $cnt_chk++;
992 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700993}
994
Andy Whitcroft6ecd9672008-10-15 22:02:21 -0700995sub check_absolute_file {
996 my ($absolute, $herecurr) = @_;
997 my $file = $absolute;
998
999 ##print "absolute<$absolute>\n";
1000
1001 # See if any suffix of this path is a path within the tree.
1002 while ($file =~ s@^[^/]*/@@) {
1003 if (-f "$root/$file") {
1004 ##print "file<$file>\n";
1005 last;
1006 }
1007 }
1008 if (! -f _) {
1009 return 0;
1010 }
1011
1012 # It is, so see if the prefix is acceptable.
1013 my $prefix = $absolute;
1014 substr($prefix, -length($file)) = '';
1015
1016 ##print "prefix<$prefix>\n";
1017 if ($prefix ne ".../") {
1018 WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr);
1019 }
1020}
1021
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001022sub process {
1023 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001024
1025 my $linenr=0;
1026 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001027 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001028 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001029 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001030
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001031 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001032 my $indent;
1033 my $previndent=0;
1034 my $stashindent=0;
1035
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001036 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001037 my $signoff = 0;
1038 my $is_patch = 0;
1039
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001040 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001041 our $cnt_lines = 0;
1042 our $cnt_error = 0;
1043 our $cnt_warn = 0;
1044 our $cnt_chk = 0;
1045
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001046 # Trace the real file/line as we go.
1047 my $realfile = '';
1048 my $realline = 0;
1049 my $realcnt = 0;
1050 my $here = '';
1051 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001052 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001053 my $first_line = 0;
1054
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001055 my $prev_values = 'E';
1056
1057 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001058 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001059 my %suppress_whiletrailers;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001060
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001061 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001062 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001063 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001064 my @setup_docs = ();
1065 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001066
1067 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001068 my $line;
1069 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001070 $linenr++;
1071 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001072
Andy Whitcroft773647a2008-03-28 14:15:58 -07001073 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001074 $setup_docs = 0;
1075 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1076 $setup_docs = 1;
1077 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001078 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001079 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001080 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1081 $realline=$1-1;
1082 if (defined $2) {
1083 $realcnt=$3+1;
1084 } else {
1085 $realcnt=1+1;
1086 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001087 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001088
1089 # Guestimate if this is a continuing comment. Run
1090 # the context looking for a comment "edge". If this
1091 # edge is a close comment then we must be in a comment
1092 # at context start.
1093 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001094 my $cnt = $realcnt;
1095 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1096 next if (defined $rawlines[$ln - 1] &&
1097 $rawlines[$ln - 1] =~ /^-/);
1098 $cnt--;
1099 #print "RAW<$rawlines[$ln - 1]>\n";
1100 ($edge) = (defined $rawlines[$ln - 1] &&
1101 $rawlines[$ln - 1] =~ m@(/\*|\*/)@);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001102 last if (defined $edge);
1103 }
1104 if (defined $edge && $edge eq '*/') {
1105 $in_comment = 1;
1106 }
1107
1108 # Guestimate if this is a continuing comment. If this
1109 # is the start of a diff block and this line starts
1110 # ' *' then it is very likely a comment.
1111 if (!defined $edge &&
1112 $rawlines[$linenr] =~ m@^.\s* \*(?:\s|$)@)
1113 {
1114 $in_comment = 1;
1115 }
1116
1117 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1118 sanitise_line_reset($in_comment);
1119
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001120 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001121 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001122 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001123 $line = sanitise_line($rawline);
1124 }
1125 push(@lines, $line);
1126
1127 if ($realcnt > 1) {
1128 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1129 } else {
1130 $realcnt = 0;
1131 }
1132
1133 #print "==>$rawline\n";
1134 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001135
1136 if ($setup_docs && $line =~ /^\+/) {
1137 push(@setup_docs, $line);
1138 }
1139 }
1140
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001141 $prefix = '';
1142
Andy Whitcroft773647a2008-03-28 14:15:58 -07001143 $realcnt = 0;
1144 $linenr = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001145 foreach my $line (@lines) {
1146 $linenr++;
1147
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001148 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft306708542008-10-15 22:02:28 -07001149 my $hunk_line = ($realcnt != 0);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001150
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001151#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001152 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001153 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001154 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001155 $realline=$1-1;
1156 if (defined $2) {
1157 $realcnt=$3+1;
1158 } else {
1159 $realcnt=1+1;
1160 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001161 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001162 $prev_values = 'E';
1163
Andy Whitcroft773647a2008-03-28 14:15:58 -07001164 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001165 %suppress_whiletrailers = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001166 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001167
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001168# track the line number as we move through the hunk, note that
1169# new versions of GNU diff omit the leading space on completely
1170# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001171 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001172 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001173 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001174
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001175 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001176 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001177
1178 # Track the previous line.
1179 ($prevline, $stashline) = ($stashline, $line);
1180 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001181 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1182
Andy Whitcroft773647a2008-03-28 14:15:58 -07001183 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001184
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001185 } elsif ($realcnt == 1) {
1186 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001187 }
1188
1189#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001190 $prefix = "$filename:$realline: " if ($emacs && $file);
1191 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1192
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001193 $here = "#$linenr: " if (!$file);
1194 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001195
1196 # extract the filename as it passes
1197 if ($line=~/^\+\+\+\s+(\S+)/) {
1198 $realfile = $1;
1199 $realfile =~ s@^[^/]*/@@;
1200
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001201 if ($realfile =~ m@^include/asm/@) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001202 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1203 }
1204 next;
1205 }
1206
Randy Dunlap389834b2007-06-08 13:47:03 -07001207 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001208
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001209 my $hereline = "$here\n$rawline\n";
1210 my $herecurr = "$here\n$rawline\n";
1211 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001212
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001213 $cnt_lines++ if ($realcnt != 0);
1214
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001215#check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001216 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001217 # This is a signoff, if ugly, so do not double report.
1218 $signoff++;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001219 if (!($line =~ /^\s*Signed-off-by:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001220 WARN("Signed-off-by: is the preferred form\n" .
1221 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001222 }
1223 if ($line =~ /^\s*signed-off-by:\S/i) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001224 WARN("space required after Signed-off-by:\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001225 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001226 }
1227 }
1228
Andy Whitcroft00df3442007-06-08 13:47:06 -07001229# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001230 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001231 ERROR("patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001232 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001233 }
1234
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001235# Check for absolute kernel paths.
1236 if ($tree) {
1237 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1238 my $file = $1;
1239
1240 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1241 check_absolute_file($1, $herecurr)) {
1242 #
1243 } else {
1244 check_absolute_file($file, $herecurr);
1245 }
1246 }
1247 }
1248
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001249# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1250 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001251 $rawline !~ m/^$UTF8*$/) {
1252 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1253
1254 my $blank = copy_spacing($rawline);
1255 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1256 my $hereptr = "$hereline$ptr\n";
1257
1258 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001259 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001260
Andy Whitcroft306708542008-10-15 22:02:28 -07001261# ignore non-hunk lines and lines being removed
1262 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001263
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001264#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001265 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001266 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001267 ERROR("DOS line endings\n" . $herevet);
1268
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001269 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1270 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001271 ERROR("trailing whitespace\n" . $herevet);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001272 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07001273
1274# check we are in a valid source file if not then ignore this hunk
1275 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1276
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001277#80 column limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001278 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001279 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1280 $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1281 $length > 80)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001282 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001283 WARN("line over 80 characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001284 }
1285
Andy Whitcroft8905a672007-11-28 16:21:06 -08001286# check for adding lines without a newline.
1287 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1288 WARN("adding a line without newline at end of file\n" . $herecurr);
1289 }
1290
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001291# check we are in a valid source file C or perl if not then ignore this hunk
1292 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001293
1294# at the beginning of a line any tabs must come first and anything
1295# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001296 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1297 $rawline =~ /^\+\s* \s*/) {
1298 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001299 ERROR("code indent should use tabs where possible\n" . $herevet);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001300 }
1301
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001302# check we are in a valid C source file if not then ignore this hunk
1303 next if ($realfile !~ /\.(h|c)$/);
1304
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001305# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001306 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001307 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1308 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001309
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001310# Check for potential 'bare' types
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001311 my ($stat, $cond, $line_nr_next, $remain_next, $off_next);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001312 if ($realcnt && $line =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001313 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001314 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001315 $stat =~ s/\n./\n /g;
1316 $cond =~ s/\n./\n /g;
1317
1318 my $s = $stat;
1319 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001320
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001321 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001322 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001323
1324 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001325 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001326
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001327 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001328 } elsif ($prev_values eq 'E' && $s =~ /^.\s*(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?((?:\s*$Ident)+?)\b(?:\s+$Sparse)?\s*\**\s*(?:$Ident|\(\*[^\)]*\))(?:\s*$Modifier)?\s*(?:;|=|,|\()/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001329 my $type = $1;
1330 $type =~ s/\s+/ /g;
1331 possible($type, "A:" . $s);
1332
Andy Whitcroft8905a672007-11-28 16:21:06 -08001333 # definitions in global scope can only start with types
Andy Whitcrofta6a84062008-10-15 22:02:30 -07001334 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001335 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001336 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001337
1338 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001339 while ($s =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001340 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001341 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001342
1343 # Check for any sort of function declaration.
1344 # int foo(something bar, other baz);
1345 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001346 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 -08001347 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001348
Andy Whitcroftcf655042008-03-04 14:28:20 -08001349 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001350 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001351 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001352
Andy Whitcroft8905a672007-11-28 16:21:06 -08001353 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001354 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001355
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001356 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001357 }
1358 }
1359 }
1360
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001361 }
1362
Andy Whitcroft653d4872007-06-23 17:16:34 -07001363#
1364# Checks which may be anchored in the context.
1365#
1366
1367# Check for switch () and associated case and default
1368# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07001369 if ($line=~/\bswitch\s*\(.*\)/) {
1370 my $err = '';
1371 my $sep = '';
1372 my @ctx = ctx_block_outer($linenr, $realcnt);
1373 shift(@ctx);
1374 for my $ctx (@ctx) {
1375 my ($clen, $cindent) = line_stats($ctx);
1376 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1377 $indent != $cindent) {
1378 $err .= "$sep$ctx\n";
1379 $sep = '';
1380 } else {
1381 $sep = "[...]\n";
1382 }
1383 }
1384 if ($err ne '') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001385 ERROR("switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001386 }
1387 }
1388
1389# if/while/etc brace do not go on next line, unless defining a do while loop,
1390# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001391 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001392 my $pre_ctx = "$1$2";
1393
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001394 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001395 my $ctx_cnt = $realcnt - $#ctx - 1;
1396 my $ctx = join("\n", @ctx);
1397
Andy Whitcroft548596d2008-07-23 21:29:01 -07001398 my $ctx_ln = $linenr;
1399 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001400
Andy Whitcroft548596d2008-07-23 21:29:01 -07001401 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1402 defined $lines[$ctx_ln - 1] &&
1403 $lines[$ctx_ln - 1] =~ /^-/)) {
1404 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1405 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001406 $ctx_ln++;
1407 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07001408
Andy Whitcroft53210162008-07-23 21:29:03 -07001409 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1410 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001411
1412 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1413 ERROR("that open brace { should be on the previous line\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001414 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07001415 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001416 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1417 $ctx =~ /\)\s*\;\s*$/ &&
1418 defined $lines[$ctx_ln - 1])
1419 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001420 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1421 if ($nindent > $indent) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001422 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001423 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001424 }
1425 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001426 }
1427
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001428# Check relative indent for conditionals and blocks.
1429 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1430 my ($s, $c) = ($stat, $cond);
1431
1432 substr($s, 0, length($c), '');
1433
1434 # Make sure we remove the line prefixes as we have
1435 # none on the first line, and are going to readd them
1436 # where necessary.
1437 $s =~ s/\n./\n/gs;
1438
1439 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07001440 my @newlines = ($c =~ /\n/gs);
1441 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001442
1443 # We want to check the first line inside the block
1444 # starting at the end of the conditional, so remove:
1445 # 1) any blank line termination
1446 # 2) any opening brace { on end of the line
1447 # 3) any do (...) {
1448 my $continuation = 0;
1449 my $check = 0;
1450 $s =~ s/^.*\bdo\b//;
1451 $s =~ s/^\s*{//;
1452 if ($s =~ s/^\s*\\//) {
1453 $continuation = 1;
1454 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001455 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001456 $check = 1;
1457 $cond_lines++;
1458 }
1459
1460 # Also ignore a loop construct at the end of a
1461 # preprocessor statement.
1462 if (($prevline =~ /^.\s*#\s*define\s/ ||
1463 $prevline =~ /\\\s*$/) && $continuation == 0) {
1464 $check = 0;
1465 }
1466
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001467 my $cond_ptr = -1;
1468 while ($cond_ptr != $cond_lines) {
1469 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001470
Andy Whitcroftf16fa282008-10-15 22:02:32 -07001471 # If we see an #else/#elif then the code
1472 # is not linear.
1473 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1474 $check = 0;
1475 }
1476
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001477 # Ignore:
1478 # 1) blank lines, they should be at 0,
1479 # 2) preprocessor lines, and
1480 # 3) labels.
1481 if ($s =~ /^\s*?\n/ ||
1482 $s =~ /^\s*#\s*?/ ||
1483 $s =~ /^\s*$Ident\s*:/) {
1484 $s =~ s/^.*?\n//;
1485 $cond_lines++;
1486 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001487 }
1488
1489 my (undef, $sindent) = line_stats("+" . $s);
1490 my $stat_real = raw_line($linenr, $cond_lines);
1491
1492 # Check if either of these lines are modified, else
1493 # this is not this patch's fault.
1494 if (!defined($stat_real) ||
1495 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1496 $check = 0;
1497 }
1498 if (defined($stat_real) && $cond_lines > 1) {
1499 $stat_real = "[...]\n$stat_real";
1500 }
1501
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001502 #print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s> cond_lines<$cond_lines> stat_real<$stat_real> stat<$stat>\n";
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001503
1504 if ($check && (($sindent % 8) != 0 ||
1505 ($sindent <= $indent && $s ne ''))) {
1506 WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1507 }
1508 }
1509
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001510 # Track the 'values' across context and added lines.
1511 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001512 my ($curr_values, $curr_vars) =
1513 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001514 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001515 if ($dbg_values) {
1516 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001517 print "$linenr > .$outline\n";
1518 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001519 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001520 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001521 $prev_values = substr($curr_values, -1);
1522
Andy Whitcroft00df3442007-06-08 13:47:06 -07001523#ignore lines not being added
1524 if ($line=~/^[^\+]/) {next;}
1525
Andy Whitcroft653d4872007-06-23 17:16:34 -07001526# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07001527 if ($dbg_type) {
1528 if ($line =~ /^.\s*$Declare\s*$/) {
1529 ERROR("TEST: is type\n" . $herecurr);
1530 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1531 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1532 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001533 next;
1534 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001535# TEST: allow direct testing of the attribute matcher.
1536 if ($dbg_attr) {
1537 if ($line =~ /^.\s*$Attribute\s*$/) {
1538 ERROR("TEST: is attr\n" . $herecurr);
1539 } elsif ($dbg_attr > 1 && $line =~ /^.+($Attribute)/) {
1540 ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1541 }
1542 next;
1543 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001544
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001545# check for initialisation to aggregates open brace on the next line
1546 if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1547 $line =~ /^.\s*{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001548 ERROR("that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001549 }
1550
Andy Whitcroft653d4872007-06-23 17:16:34 -07001551#
1552# Checks which are anchored on the added line.
1553#
1554
1555# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001556 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001557 my $path = $1;
1558 if ($path =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001559 ERROR("malformed #include filename\n" .
1560 $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001561 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001562 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001563
1564# no C99 // comments
1565 if ($line =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001566 ERROR("do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001567 }
1568 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001569 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001570 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001571
1572#EXPORT_SYMBOL should immediately follow its function closing }.
Andy Whitcroft653d4872007-06-23 17:16:34 -07001573 if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1574 ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1575 my $name = $1;
Andy Whitcroft48012052008-10-15 22:02:34 -07001576 if ($prevline !~ /(?:
1577 ^.}|
1578 ^.DEFINE_$Ident\(\Q$name\E\)|
1579 ^.DECLARE_$Ident\(\Q$name\E\)|
1580 ^.LIST_HEAD\(\Q$name\E\)|
1581 ^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
1582 \b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)
1583 )/x) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001584 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001585 }
1586 }
1587
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001588# check for external initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001589 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001590 ERROR("do not initialise externals to 0 or NULL\n" .
1591 $herecurr);
1592 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001593# check for static initialisers.
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001594 if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001595 ERROR("do not initialise statics to 0 or NULL\n" .
1596 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001597 }
1598
Andy Whitcroft653d4872007-06-23 17:16:34 -07001599# check for new typedefs, only function parameters and sparse annotations
1600# make sense.
1601 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001602 $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001603 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07001604 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001605 $line !~ /\b__bitwise(?:__|)\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001606 WARN("do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001607 }
1608
1609# * goes on variable not on type
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001610 if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001611 ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" .
1612 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001613
1614 } elsif ($line =~ m{\($NonptrType\s+(\*+)(?!\s+const)\s+\)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001615 ERROR("\"(foo $1 )\" should be \"(foo $1)\"\n" .
1616 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001617
Andy Whitcroft234fff62008-07-23 21:29:12 -07001618 } elsif ($line =~ m{\b$NonptrType(\*+)(?:\s+(?:$Attribute|$Sparse))?\s+[A-Za-z\d_]+}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001619 ERROR("\"foo$1 bar\" should be \"foo $1bar\"\n" .
1620 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001621
Andy Whitcroft234fff62008-07-23 21:29:12 -07001622 } elsif ($line =~ m{\b$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001623 ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" .
1624 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001625 }
1626
1627# # no BUG() or BUG_ON()
1628# if ($line =~ /\b(BUG|BUG_ON)\b/) {
1629# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1630# print "$herecurr";
1631# $clean = 0;
1632# }
1633
Andy Whitcroft8905a672007-11-28 16:21:06 -08001634 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001635 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 -08001636 }
1637
Andy Whitcroft00df3442007-06-08 13:47:06 -07001638# printk should use KERN_* levels. Note that follow on printk's on the
1639# same line do not need a level, so we use the current block context
1640# to try and find and validate the current printk. In summary the current
1641# printk includes all preceeding printk's which have no newline on the end.
1642# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001643 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001644 my $ok = 0;
1645 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1646 #print "CHECK<$lines[$ln - 1]\n";
1647 # we have a preceeding printk if it ends
1648 # with "\n" ignore it, else it is to blame
1649 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1650 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1651 $ok = 1;
1652 }
1653 last;
1654 }
1655 }
1656 if ($ok == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001657 WARN("printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001658 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001659 }
1660
Andy Whitcroft653d4872007-06-23 17:16:34 -07001661# function brace can't be on same line, except for #defines of do while,
1662# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001663 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1664 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001665 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001666 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001667
Andy Whitcroft8905a672007-11-28 16:21:06 -08001668# open braces for enum, union and struct go on the same line.
1669 if ($line =~ /^.\s*{/ &&
1670 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1671 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1672 }
1673
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001674# check for spacing round square brackets; allowed:
1675# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001676# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1677# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001678 while ($line =~ /(.*?\s)\[/g) {
1679 my ($where, $prefix) = ($-[1], $1);
1680 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001681 ($where != 0 || $prefix !~ /^.\s+$/) &&
1682 $prefix !~ /{\s+$/) {
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001683 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1684 }
1685 }
1686
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001687# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001688 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001689 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001690 my $ctx_before = substr($line, 0, $-[1]);
1691 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001692
1693 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001694 if ($name =~ /^(?:
1695 if|for|while|switch|return|case|
1696 volatile|__volatile__|
1697 __attribute__|format|__extension__|
1698 asm|__asm__)$/x)
1699 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001700
1701 # cpp #define statements have non-optional spaces, ie
1702 # if there is a space between the name and the open
1703 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001704 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001705
1706 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001707 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001708
1709 # If this whole things ends with a type its most
1710 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001711 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001712
1713 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001714 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001715 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001716 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001717# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001718 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001719 my $ops = qr{
1720 <<=|>>=|<=|>=|==|!=|
1721 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1722 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001723 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1724 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001725 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001726 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001727 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001728
1729 my $blank = copy_spacing($opline);
1730
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001731 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001732 $off += length($elements[$n]);
1733
Andy Whitcroft773647a2008-03-28 14:15:58 -07001734 # Pick up the preceeding and succeeding characters.
1735 my $ca = substr($opline, 0, $off);
1736 my $cc = '';
1737 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1738 $cc = substr($opline, $off + length($elements[$n + 1]));
1739 }
1740 my $cb = "$ca$;$cc";
1741
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001742 my $a = '';
1743 $a = 'V' if ($elements[$n] ne '');
1744 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001745 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001746 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1747 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07001748 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001749
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001750 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001751
1752 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001753 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001754 $c = 'V' if ($elements[$n + 2] ne '');
1755 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001756 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001757 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1758 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001759 $c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001760 } else {
1761 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001762 }
1763
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001764 my $ctx = "${a}x${c}";
1765
1766 my $at = "(ctx:$ctx)";
1767
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001768 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001769 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001770
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001771 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001772 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001773
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001774 # Get the full operator variant.
1775 my $opv = $op . substr($curr_vars, $off, 1);
1776
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001777 # Ignore operators passed as parameters.
1778 if ($op_type ne 'V' &&
1779 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1780
Andy Whitcroftcf655042008-03-04 14:28:20 -08001781# # Ignore comments
1782# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001783
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001784 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001785 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001786 if ($ctx !~ /.x[WEBC]/ &&
1787 $cc !~ /^\\/ && $cc !~ /^;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001788 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001789 }
1790
1791 # // is a comment
1792 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001793
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001794 # No spaces for:
1795 # ->
1796 # : when part of a bitfield
1797 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001798 if ($ctx =~ /Wx.|.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001799 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001800 }
1801
1802 # , must have a space on the right.
1803 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001804 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001805 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001806 }
1807
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001808 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001809 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001810 #warn "'*' is part of type\n";
1811
1812 # unary operators should have a space before and
1813 # none after. May be left adjacent to another
1814 # unary operator, or a cast
1815 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001816 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07001817 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001818 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001819 ERROR("space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001820 }
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001821 if ($op eq '*' && $cc =~/\s*const\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001822 # A unary '*' may be const
1823
1824 } elsif ($ctx =~ /.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001825 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001826 }
1827
1828 # unary ++ and unary -- are allowed no space on one side.
1829 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001830 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1831 ERROR("space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001832 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001833 if ($ctx =~ /Wx[BE]/ ||
1834 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1835 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001836 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001837 if ($ctx =~ /ExW/) {
1838 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1839 }
1840
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001841
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001842 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001843 } elsif ($op eq '<<' or $op eq '>>' or
1844 $op eq '&' or $op eq '^' or $op eq '|' or
1845 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001846 $op eq '*' or $op eq '/' or
1847 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001848 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001849 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001850 ERROR("need consistent spacing around '$op' $at\n" .
1851 $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001852 }
1853
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001854 # A colon needs no spaces before when it is
1855 # terminating a case value or a label.
1856 } elsif ($opv eq ':C' || $opv eq ':L') {
1857 if ($ctx =~ /Wx./) {
1858 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1859 }
1860
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001861 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08001862 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001863 my $ok = 0;
1864
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001865 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001866 if (($op eq '<' &&
1867 $cc =~ /^\S+\@\S+>/) ||
1868 ($op eq '>' &&
1869 $ca =~ /<\S+\@\S+$/))
1870 {
1871 $ok = 1;
1872 }
1873
1874 # Ignore ?:
1875 if (($opv eq ':O' && $ca =~ /\?$/) ||
1876 ($op eq '?' && $cc =~ /^:/)) {
1877 $ok = 1;
1878 }
1879
1880 if ($ok == 0) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001881 ERROR("spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001882 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001883 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001884 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001885 }
1886 }
1887
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001888# check for multiple assignments
1889 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001890 CHK("multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001891 }
1892
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001893## # check for multiple declarations, allowing for a function declaration
1894## # continuation.
1895## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
1896## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
1897##
1898## # Remove any bracketed sections to ensure we do not
1899## # falsly report the parameters of functions.
1900## my $ln = $line;
1901## while ($ln =~ s/\([^\(\)]*\)//g) {
1902## }
1903## if ($ln =~ /,/) {
1904## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
1905## }
1906## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001907
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001908#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001909 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
1910 $line =~ /do{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001911 ERROR("space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001912 }
1913
1914# closing brace should have a space following it when it has anything
1915# on the line
1916 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001917 ERROR("space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001918 }
1919
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001920# check spacing on square brackets
1921 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001922 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001923 }
1924 if ($line =~ /\s\]/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001925 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001926 }
1927
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001928# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001929 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
1930 $line !~ /for\s*\(\s+;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001931 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001932 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001933 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001934 $line !~ /for\s*\(.*;\s+\)/ &&
1935 $line !~ /:\s+\)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001936 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001937 }
1938
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001939#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001940 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001941 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001942 WARN("labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001943 }
1944
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001945# Return is not a function.
1946 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
1947 my $spacing = $1;
1948 my $value = $2;
1949
1950 # Flatten any parentheses and braces
Andy Whitcroftfee61c42008-07-23 21:28:56 -07001951 $value =~ s/\)\(/\) \(/g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001952 while ($value =~ s/\([^\(\)]*\)/1/) {
1953 }
1954
1955 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
1956 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
1957
1958 } elsif ($spacing !~ /\s+/) {
1959 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1960 }
1961 }
1962
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001963# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001964 if ($line=~/\b(if|while|for|switch)\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001965 ERROR("space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001966 }
1967
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001968# Check for illegal assignment in if conditional -- and check for trailing
1969# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001970 if ($line =~ /do\s*(?!{)/) {
1971 my ($stat_next) = ctx_statement_block($line_nr_next,
1972 $remain_next, $off_next);
1973 $stat_next =~ s/\n./\n /g;
1974 ##print "stat<$stat> stat_next<$stat_next>\n";
1975
1976 if ($stat_next =~ /^\s*while\b/) {
1977 # If the statement carries leading newlines,
1978 # then count those as offsets.
1979 my ($whitespace) =
1980 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
1981 my $offset =
1982 statement_rawlines($whitespace) - 1;
1983
1984 $suppress_whiletrailers{$line_nr_next +
1985 $offset} = 1;
1986 }
1987 }
1988 if (!defined $suppress_whiletrailers{$linenr} &&
1989 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001990 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001991
1992 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001993 ERROR("do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001994 }
1995
1996 # Find out what is on the end of the line after the
1997 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001998 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001999 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002000 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07002001 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2002 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002003 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002004 # Find out how long the conditional actually is.
2005 my @newlines = ($c =~ /\n/gs);
2006 my $cond_lines = 1 + $#newlines;
2007
2008 my $stat_real = raw_line($linenr, $cond_lines);
2009 if (defined($stat_real) && $cond_lines > 1) {
2010 $stat_real = "[...]\n$stat_real";
2011 }
2012
2013 ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002014 }
2015 }
2016
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002017# Check for bitwise tests written as boolean
2018 if ($line =~ /
2019 (?:
2020 (?:\[|\(|\&\&|\|\|)
2021 \s*0[xX][0-9]+\s*
2022 (?:\&\&|\|\|)
2023 |
2024 (?:\&\&|\|\|)
2025 \s*0[xX][0-9]+\s*
2026 (?:\&\&|\|\||\)|\])
2027 )/x)
2028 {
2029 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2030 }
2031
Andy Whitcroft8905a672007-11-28 16:21:06 -08002032# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002033 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2034 my $s = $1;
2035 $s =~ s/$;//g; # Remove any comments
2036 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2037 ERROR("trailing statements should be on next line\n" . $herecurr);
2038 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002039 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002040# case and default should not have general statements after them
2041 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2042 $line !~ /\G(?:
2043 (?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
2044 \s*return\s+
2045 )/xg)
2046 {
2047 ERROR("trailing statements should be on next line\n" . $herecurr);
2048 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002049
2050 # Check for }<nl>else {, these must be at the same
2051 # indent level to be relevant to each other.
2052 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2053 $previndent == $indent) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002054 ERROR("else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002055 }
2056
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002057 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2058 $previndent == $indent) {
2059 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2060
2061 # Find out what is on the end of the line after the
2062 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002063 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002064 $s =~ s/\n.*//g;
2065
2066 if ($s =~ /^\s*;/) {
2067 ERROR("while should follow close brace '}'\n" . $hereprev);
2068 }
2069 }
2070
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002071#studly caps, commented out until figure out how to distinguish between use of existing and adding new
2072# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2073# print "No studly caps, use _\n";
2074# print "$herecurr";
2075# $clean = 0;
2076# }
2077
2078#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002079 if ($line=~/\#\s*define.*\\\s$/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002080 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002081 }
2082
Andy Whitcroft653d4872007-06-23 17:16:34 -07002083#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002084 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002085 my $file = "$1.h";
2086 my $checkfile = "include/linux/$file";
2087 if (-f "$root/$checkfile" &&
2088 $realfile ne $checkfile &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002089 $1 ne 'irq')
2090 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002091 if ($realfile =~ m{^arch/}) {
2092 CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2093 } else {
2094 WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2095 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002096 }
2097 }
2098
Andy Whitcroft653d4872007-06-23 17:16:34 -07002099# multi-statement macros should be enclosed in a do while loop, grab the
2100# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08002101# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07002102 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2103 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002104 my $ln = $linenr;
2105 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002106 my ($off, $dstat, $dcond, $rest);
2107 my $ctx = '';
Andy Whitcroft653d4872007-06-23 17:16:34 -07002108
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002109 my $args = defined($1);
2110
2111 # Find the end of the macro and limit our statement
2112 # search to that.
2113 while ($cnt > 0 && defined $lines[$ln - 1] &&
2114 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2115 {
2116 $ctx .= $rawlines[$ln - 1] . "\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002117 $cnt-- if ($lines[$ln - 1] !~ /^-/);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002118 $ln++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002119 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002120 $ctx .= $rawlines[$ln - 1];
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002121
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002122 ($dstat, $dcond, $ln, $cnt, $off) =
2123 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2124 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002125 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002126
2127 # Extract the remainder of the define (if any) and
2128 # rip off surrounding spaces, and trailing \'s.
2129 $rest = '';
Andy Whitcroft636d1402008-10-15 22:02:18 -07002130 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2131 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002132 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2133 $rest .= substr($lines[$ln - 1], $off) . "\n";
2134 $cnt--;
2135 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002136 $ln++;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002137 $off = 0;
2138 }
2139 $rest =~ s/\\\n.//g;
2140 $rest =~ s/^\s*//s;
2141 $rest =~ s/\s*$//s;
2142
2143 # Clean up the original statement.
2144 if ($args) {
2145 substr($dstat, 0, length($dcond), '');
2146 } else {
2147 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2148 }
Andy Whitcroft292f1a92008-07-23 21:29:11 -07002149 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002150 $dstat =~ s/\\\n.//g;
2151 $dstat =~ s/^\s*//s;
2152 $dstat =~ s/\s*$//s;
2153
2154 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07002155 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2156 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2157 $dstat =~ s/\[[^\{\}]*\]/1/)
2158 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002159 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002160
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002161 my $exceptions = qr{
2162 $Declare|
2163 module_param_named|
2164 MODULE_PARAM_DESC|
2165 DECLARE_PER_CPU|
2166 DEFINE_PER_CPU|
2167 __typeof__\(
2168 }x;
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002169 #print "REST<$rest>\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002170 if ($rest ne '') {
2171 if ($rest !~ /while\s*\(/ &&
2172 $dstat !~ /$exceptions/)
2173 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002174 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 -07002175 }
2176
2177 } elsif ($ctx !~ /;/) {
2178 if ($dstat ne '' &&
2179 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2180 $dstat !~ /$exceptions/ &&
Andy Whitcroftb132e5d2008-10-15 22:02:31 -07002181 $dstat !~ /^\.$Ident\s*=/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002182 $dstat =~ /$Operators/)
2183 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002184 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002185 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002186 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002187 }
2188
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002189# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002190 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2191 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08002192 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002193 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002194 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2195 if ($#chunks > 0 && $level == 0) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002196 my $allowed = 0;
2197 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002198 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002199 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002200 for my $chunk (@chunks) {
2201 my ($cond, $block) = @{$chunk};
2202
Andy Whitcroft773647a2008-03-28 14:15:58 -07002203 # If the condition carries leading newlines, then count those as offsets.
2204 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2205 my $offset = statement_rawlines($whitespace) - 1;
2206
2207 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2208
2209 # We have looked at and allowed this specific line.
2210 $suppress_ifbraces{$ln + $offset} = 1;
2211
2212 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002213 $ln += statement_rawlines($block) - 1;
2214
Andy Whitcroft773647a2008-03-28 14:15:58 -07002215 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002216
2217 $seen++ if ($block =~ /^\s*{/);
2218
Andy Whitcroftcf655042008-03-04 14:28:20 -08002219 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2220 if (statement_lines($cond) > 1) {
2221 #print "APW: ALLOWED: cond<$cond>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002222 $allowed = 1;
2223 }
2224 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002225 #print "APW: ALLOWED: block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002226 $allowed = 1;
2227 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002228 if (statement_block_size($block) > 1) {
2229 #print "APW: ALLOWED: lines block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002230 $allowed = 1;
2231 }
2232 }
2233 if ($seen && !$allowed) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002234 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002235 }
2236 }
2237 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002238 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002239 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002240 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002241
Andy Whitcroftcf655042008-03-04 14:28:20 -08002242 # Check the pre-context.
2243 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2244 #print "APW: ALLOWED: pre<$1>\n";
2245 $allowed = 1;
2246 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002247
2248 my ($level, $endln, @chunks) =
2249 ctx_statement_full($linenr, $realcnt, $-[0]);
2250
Andy Whitcroftcf655042008-03-04 14:28:20 -08002251 # Check the condition.
2252 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07002253 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002254 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002255 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08002256 }
2257 if (statement_lines($cond) > 1) {
2258 #print "APW: ALLOWED: cond<$cond>\n";
2259 $allowed = 1;
2260 }
2261 if ($block =~/\b(?:if|for|while)\b/) {
2262 #print "APW: ALLOWED: block<$block>\n";
2263 $allowed = 1;
2264 }
2265 if (statement_block_size($block) > 1) {
2266 #print "APW: ALLOWED: lines block<$block>\n";
2267 $allowed = 1;
2268 }
2269 # Check the post-context.
2270 if (defined $chunks[1]) {
2271 my ($cond, $block) = @{$chunks[1]};
2272 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002273 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002274 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002275 if ($block =~ /^\s*\{/) {
2276 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2277 $allowed = 1;
2278 }
2279 }
2280 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2281 my $herectx = $here . "\n";;
Andy Whitcroftf0556632008-10-15 22:02:23 -07002282 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002283
Andy Whitcroftf0556632008-10-15 22:02:23 -07002284 for (my $n = 0; $n < $cnt; $n++) {
2285 $herectx .= raw_line($linenr, $n) . "\n";;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002286 }
2287
2288 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002289 }
2290 }
2291
Andy Whitcroft653d4872007-06-23 17:16:34 -07002292# don't include deprecated include files (uses RAW line)
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002293 for my $inc (@dep_includes) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002294 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002295 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002296 }
2297 }
2298
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002299# don't use deprecated functions
2300 for my $func (@dep_functions) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002301 if ($line =~ /\b$func\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002302 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002303 }
2304 }
2305
2306# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002307 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2308 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002309 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002310 }
2311
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002312# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2313 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2314 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2315 }
2316
Andy Whitcroft00df3442007-06-08 13:47:06 -07002317# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002318 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002319 CHK("if this code is redundant consider removing it\n" .
2320 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002321 }
2322
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002323# check for needless kfree() checks
2324 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2325 my $expr = $1;
2326 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
Wolfram Sang3c232142008-07-23 21:29:05 -07002327 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002328 }
2329 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07002330# check for needless usb_free_urb() checks
2331 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2332 my $expr = $1;
2333 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2334 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2335 }
2336 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002337
Andy Whitcroft00df3442007-06-08 13:47:06 -07002338# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002339# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002340# print "#ifdef in C files should be avoided\n";
2341# print "$herecurr";
2342# $clean = 0;
2343# }
2344
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002345# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002346 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002347 ERROR("exactly one space required after that #$1\n" . $herecurr);
2348 }
2349
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002350# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002351 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2352 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002353 my $which = $1;
2354 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002355 CHK("$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002356 }
2357 }
2358# check for memory barriers without a comment.
2359 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2360 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002361 CHK("memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002362 }
2363 }
2364# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002365 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002366 CHK("architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002367 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002368
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002369# check the location of the inline attribute, that it is between
2370# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002371 if ($line =~ /\b$Type\s+$Inline\b/ ||
2372 $line =~ /\b$Inline\s+$Storage\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002373 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2374 }
2375
Andy Whitcroft8905a672007-11-28 16:21:06 -08002376# Check for __inline__ and __inline, prefer inline
2377 if ($line =~ /\b(__inline__|__inline)\b/) {
2378 WARN("plain inline is preferred over $1\n" . $herecurr);
2379 }
2380
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002381# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002382 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002383 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002384 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002385 my $function_name = $1;
2386 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002387
2388 my $s = $stat;
2389 if (defined $cond) {
2390 substr($s, 0, length($cond), '');
2391 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002392 if ($s =~ /^\s*;/ &&
2393 $function_name ne 'uninitialized_var')
2394 {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002395 WARN("externs should be avoided in .c files\n" . $herecurr);
2396 }
2397
2398 if ($paren_space =~ /\n/) {
2399 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2400 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002401
2402 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2403 $stat =~ /^.\s*extern\s+/)
2404 {
2405 WARN("externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002406 }
2407
2408# checks for new __setup's
2409 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2410 my $name = $1;
2411
2412 if (!grep(/$name/, @setup_docs)) {
2413 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2414 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002415 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002416
2417# check for pointless casting of kmalloc return
2418 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2419 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2420 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002421
2422# check for gcc specific __FUNCTION__
2423 if ($line =~ /__FUNCTION__/) {
2424 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2425 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002426
2427# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002428 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002429 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2430 }
2431# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002432 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002433 WARN("consider using a completion\n" . $herecurr);
2434 }
2435# recommend strict_strto* over simple_strto*
2436 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2437 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2438 }
Michael Ellermanf3db6632008-07-23 21:28:57 -07002439# check for __initcall(), use device_initcall() explicitly please
2440 if ($line =~ /^.\s*__initcall\s*\(/) {
2441 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2442 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002443
2444# use of NR_CPUS is usually wrong
2445# ignore definitions of NR_CPUS and usage to define arrays as likely right
2446 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002447 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2448 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002449 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2450 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2451 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002452 {
2453 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2454 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002455
2456# check for %L{u,d,i} in strings
2457 my $string;
2458 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2459 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07002460 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002461 if ($string =~ /(?<!%)%L[udi]/) {
2462 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2463 last;
2464 }
2465 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002466 }
2467
2468 # If we have no input at all, then there is nothing to report on
2469 # so just keep quiet.
2470 if ($#rawlines == -1) {
2471 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002472 }
2473
Andy Whitcroft8905a672007-11-28 16:21:06 -08002474 # In mailback mode only produce a report in the negative, for
2475 # things that appear to be patches.
2476 if ($mailback && ($clean == 1 || !$is_patch)) {
2477 exit(0);
2478 }
2479
2480 # This is not a patch, and we are are in 'no-patch' mode so
2481 # just keep quiet.
2482 if (!$chk_patch && !$is_patch) {
2483 exit(0);
2484 }
2485
2486 if (!$is_patch) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002487 ERROR("Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002488 }
2489 if ($is_patch && $chk_signoff && $signoff == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002490 ERROR("Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002491 }
2492
Andy Whitcroft8905a672007-11-28 16:21:06 -08002493 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002494 if ($summary && !($clean == 1 && $quiet == 1)) {
2495 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002496 print "total: $cnt_error errors, $cnt_warn warnings, " .
2497 (($check)? "$cnt_chk checks, " : "") .
2498 "$cnt_lines lines checked\n";
2499 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002500 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002501
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002502 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002503 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002504 }
2505 if ($clean == 0 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002506 print "$vname has style problems, please review. If any of these errors\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002507 print "are false positives report them to the maintainer, see\n";
2508 print "CHECKPATCH in MAINTAINERS.\n";
2509 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002510
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002511 return $clean;
2512}