blob: 9e7e9d1d59586b73f0c834c549169cce55c44857 [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 Whitcroft33cba062008-07-23 21:29:12 -070012my $V = '0.21';
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 Whitcroft8905a672007-11-28 16:21:06 -0800149our @typeList = (
150 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700151 qr{(?:unsigned\s+)?char},
152 qr{(?:unsigned\s+)?short},
153 qr{(?:unsigned\s+)?int},
154 qr{(?:unsigned\s+)?long},
155 qr{(?:unsigned\s+)?long\s+int},
156 qr{(?:unsigned\s+)?long\s+long},
157 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800158 qr{unsigned},
159 qr{float},
160 qr{double},
161 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800162 qr{(?:__)?(?:u|s|be|le)(?:8|16|32|64)},
163 qr{struct\s+$Ident},
164 qr{union\s+$Ident},
165 qr{enum\s+$Ident},
166 qr{${Ident}_t},
167 qr{${Ident}_handler},
168 qr{${Ident}_handler_fn},
169);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700170our @modifierList = (
171 qr{fastcall},
172);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800173
174sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700175 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
176 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700177 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800178 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700179 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800180 (?:
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700181 (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
182 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800183 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700184 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800185 }x;
186 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700187 $NonptrType
Andy Whitcroft8905a672007-11-28 16:21:06 -0800188 (?:\s*\*+\s*const|\s*\*+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700189 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800190 }x;
191 $Declare = qr{(?:$Storage\s+)?$Type};
192}
193build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700194
195$chk_signoff = 0 if ($file);
196
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700197my @dep_includes = ();
198my @dep_functions = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700199my $removal = "Documentation/feature-removal-schedule.txt";
200if ($tree && -f "$root/$removal") {
201 open(REMOVE, "<$root/$removal") ||
202 die "$P: $removal: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700203 while (<REMOVE>) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700204 if (/^Check:\s+(.*\S)/) {
205 for my $entry (split(/[, ]+/, $1)) {
206 if ($entry =~ m@include/(.*)@) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700207 push(@dep_includes, $1);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700208
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700209 } elsif ($entry !~ m@/@) {
210 push(@dep_functions, $entry);
211 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700212 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700213 }
214 }
215}
216
Andy Whitcroft00df3442007-06-08 13:47:06 -0700217my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800218my @lines = ();
219my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700220for my $filename (@ARGV) {
221 if ($file) {
222 open(FILE, "diff -u /dev/null $filename|") ||
223 die "$P: $filename: diff failed - $!\n";
224 } else {
225 open(FILE, "<$filename") ||
226 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700227 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800228 if ($filename eq '-') {
229 $vname = 'Your patch';
230 } else {
231 $vname = $filename;
232 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700233 while (<FILE>) {
234 chomp;
235 push(@rawlines, $_);
236 }
237 close(FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800238 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700239 $exit = 1;
240 }
241 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800242 @lines = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700243}
244
245exit($exit);
246
247sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700248 my ($root) = @_;
249
250 my @tree_check = (
251 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
252 "README", "Documentation", "arch", "include", "drivers",
253 "fs", "init", "ipc", "kernel", "lib", "scripts",
254 );
255
256 foreach my $check (@tree_check) {
257 if (! -e $root . '/' . $check) {
258 return 0;
259 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700260 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700261 return 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700262}
263
264sub expand_tabs {
265 my ($str) = @_;
266
267 my $res = '';
268 my $n = 0;
269 for my $c (split(//, $str)) {
270 if ($c eq "\t") {
271 $res .= ' ';
272 $n++;
273 for (; ($n % 8) != 0; $n++) {
274 $res .= ' ';
275 }
276 next;
277 }
278 $res .= $c;
279 $n++;
280 }
281
282 return $res;
283}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700284sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700285 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700286 return $res;
287}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700288
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700289sub line_stats {
290 my ($line) = @_;
291
292 # Drop the diff line leader and expand tabs
293 $line =~ s/^.//;
294 $line = expand_tabs($line);
295
296 # Pick the indent from the front of the line.
297 my ($white) = ($line =~ /^(\s*)/);
298
299 return (length($line), length($white));
300}
301
Andy Whitcroft773647a2008-03-28 14:15:58 -0700302my $sanitise_quote = '';
303
304sub sanitise_line_reset {
305 my ($in_comment) = @_;
306
307 if ($in_comment) {
308 $sanitise_quote = '*/';
309 } else {
310 $sanitise_quote = '';
311 }
312}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700313sub sanitise_line {
314 my ($line) = @_;
315
316 my $res = '';
317 my $l = '';
318
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800319 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700320 my $off = 0;
321 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700322
Andy Whitcroft773647a2008-03-28 14:15:58 -0700323 # Always copy over the diff marker.
324 $res = substr($line, 0, 1);
325
326 for ($off = 1; $off < length($line); $off++) {
327 $c = substr($line, $off, 1);
328
329 # Comments we are wacking completly including the begin
330 # and end, all to $;.
331 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
332 $sanitise_quote = '*/';
333
334 substr($res, $off, 2, "$;$;");
335 $off++;
336 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800337 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700338 if (substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700339 $sanitise_quote = '';
340 substr($res, $off, 2, "$;$;");
341 $off++;
342 next;
343 }
344
345 # A \ in a string means ignore the next character.
346 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
347 $c eq "\\") {
348 substr($res, $off, 2, 'XX');
349 $off++;
350 next;
351 }
352 # Regular quotes.
353 if ($c eq "'" || $c eq '"') {
354 if ($sanitise_quote eq '') {
355 $sanitise_quote = $c;
356
357 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700358 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700359 } elsif ($sanitise_quote eq $c) {
360 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700361 }
362 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700363
364 #print "SQ:$sanitise_quote\n";
365 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
366 substr($res, $off, 1, $;);
367 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
368 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700369 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700370 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700371 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800372 }
373
374 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700375 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800376 my $clean = 'X' x length($1);
377 $res =~ s@\<.*\>@<$clean>@;
378
379 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700380 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800381 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700382 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800383 }
384
Andy Whitcroft00df3442007-06-08 13:47:06 -0700385 return $res;
386}
387
Andy Whitcroft8905a672007-11-28 16:21:06 -0800388sub ctx_statement_block {
389 my ($linenr, $remain, $off) = @_;
390 my $line = $linenr - 1;
391 my $blk = '';
392 my $soff = $off;
393 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700394 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800395
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800396 my $loff = 0;
397
Andy Whitcroft8905a672007-11-28 16:21:06 -0800398 my $type = '';
399 my $level = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800400 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800401 my $c;
402 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800403
404 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800405 while (1) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700406 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800407 # If we are about to drop off the end, pull in more
408 # context.
409 if ($off >= $len) {
410 for (; $remain > 0; $line++) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800411 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800412 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800413 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800414 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800415 $len = length($blk);
416 $line++;
417 last;
418 }
419 # Bail if there is no further context.
420 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800421 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800422 last;
423 }
424 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800425 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800426 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800427 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800428
Andy Whitcroft773647a2008-03-28 14:15:58 -0700429 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800430 # Statement ends at the ';' or a close '}' at the
431 # outermost level.
432 if ($level == 0 && $c eq ';') {
433 last;
434 }
435
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800436 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700437 if ($level == 0 && $coff_set == 0 &&
438 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
439 $remainder =~ /^(else)(?:\s|{)/ &&
440 $remainder !~ /^else\s+if\b/) {
441 $coff = $off + length($1) - 1;
442 $coff_set = 1;
443 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
444 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800445 }
446
Andy Whitcroft8905a672007-11-28 16:21:06 -0800447 if (($type eq '' || $type eq '(') && $c eq '(') {
448 $level++;
449 $type = '(';
450 }
451 if ($type eq '(' && $c eq ')') {
452 $level--;
453 $type = ($level != 0)? '(' : '';
454
455 if ($level == 0 && $coff < $soff) {
456 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700457 $coff_set = 1;
458 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800459 }
460 }
461 if (($type eq '' || $type eq '{') && $c eq '{') {
462 $level++;
463 $type = '{';
464 }
465 if ($type eq '{' && $c eq '}') {
466 $level--;
467 $type = ($level != 0)? '{' : '';
468
469 if ($level == 0) {
470 last;
471 }
472 }
473 $off++;
474 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700475 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800476 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700477 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800478 $line++;
479 $remain--;
480 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800481
482 my $statement = substr($blk, $soff, $off - $soff + 1);
483 my $condition = substr($blk, $soff, $coff - $soff + 1);
484
485 #warn "STATEMENT<$statement>\n";
486 #warn "CONDITION<$condition>\n";
487
Andy Whitcroft773647a2008-03-28 14:15:58 -0700488 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800489
490 return ($statement, $condition,
491 $line, $remain + 1, $off - $loff + 1, $level);
492}
493
Andy Whitcroftcf655042008-03-04 14:28:20 -0800494sub statement_lines {
495 my ($stmt) = @_;
496
497 # Strip the diff line prefixes and rip blank lines at start and end.
498 $stmt =~ s/(^|\n)./$1/g;
499 $stmt =~ s/^\s*//;
500 $stmt =~ s/\s*$//;
501
502 my @stmt_lines = ($stmt =~ /\n/g);
503
504 return $#stmt_lines + 2;
505}
506
507sub statement_rawlines {
508 my ($stmt) = @_;
509
510 my @stmt_lines = ($stmt =~ /\n/g);
511
512 return $#stmt_lines + 2;
513}
514
515sub statement_block_size {
516 my ($stmt) = @_;
517
518 $stmt =~ s/(^|\n)./$1/g;
519 $stmt =~ s/^\s*{//;
520 $stmt =~ s/}\s*$//;
521 $stmt =~ s/^\s*//;
522 $stmt =~ s/\s*$//;
523
524 my @stmt_lines = ($stmt =~ /\n/g);
525 my @stmt_statements = ($stmt =~ /;/g);
526
527 my $stmt_lines = $#stmt_lines + 2;
528 my $stmt_statements = $#stmt_statements + 1;
529
530 if ($stmt_lines > $stmt_statements) {
531 return $stmt_lines;
532 } else {
533 return $stmt_statements;
534 }
535}
536
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800537sub ctx_statement_full {
538 my ($linenr, $remain, $off) = @_;
539 my ($statement, $condition, $level);
540
541 my (@chunks);
542
Andy Whitcroftcf655042008-03-04 14:28:20 -0800543 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800544 ($statement, $condition, $linenr, $remain, $off, $level) =
545 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700546 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800547 push(@chunks, [ $condition, $statement ]);
548 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
549 return ($level, $linenr, @chunks);
550 }
551
552 # Pull in the following conditional/block pairs and see if they
553 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800554 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800555 ($statement, $condition, $linenr, $remain, $off, $level) =
556 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800557 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700558 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800559 #print "C: push\n";
560 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800561 }
562
563 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800564}
565
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700566sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700567 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700568 my $line;
569 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700570 my $blk = '';
571 my @o;
572 my @c;
573 my @res = ();
574
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700575 my $level = 0;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700576 for ($line = $start; $remain > 0; $line++) {
577 next if ($rawlines[$line] =~ /^-/);
578 $remain--;
579
580 $blk .= $rawlines[$line];
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700581 foreach my $c (split(//, $rawlines[$line])) {
582 ##print "C<$c>L<$level><$open$close>O<$off>\n";
583 if ($off > 0) {
584 $off--;
585 next;
586 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700587
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700588 if ($c eq $close && $level > 0) {
589 $level--;
590 last if ($level == 0);
591 } elsif ($c eq $open) {
592 $level++;
593 }
594 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700595
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700596 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700597 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700598 }
599
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700600 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700601 }
602
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700603 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700604}
605sub ctx_block_outer {
606 my ($linenr, $remain) = @_;
607
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700608 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
609 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700610}
611sub ctx_block {
612 my ($linenr, $remain) = @_;
613
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700614 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
615 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700616}
617sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700618 my ($linenr, $remain, $off) = @_;
619
620 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
621 return @r;
622}
623sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700624 my ($linenr, $remain) = @_;
625
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700626 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700627}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700628sub ctx_statement_level {
629 my ($linenr, $remain, $off) = @_;
630
631 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
632}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700633
634sub ctx_locate_comment {
635 my ($first_line, $end_line) = @_;
636
637 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700638 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700639 return $current_comment if (defined $current_comment);
640
641 # Look through the context and try and figure out if there is a
642 # comment.
643 my $in_comment = 0;
644 $current_comment = '';
645 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700646 my $line = $rawlines[$linenr - 1];
647 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700648 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
649 $in_comment = 1;
650 }
651 if ($line =~ m@/\*@) {
652 $in_comment = 1;
653 }
654 if (!$in_comment && $current_comment ne '') {
655 $current_comment = '';
656 }
657 $current_comment .= $line . "\n" if ($in_comment);
658 if ($line =~ m@\*/@) {
659 $in_comment = 0;
660 }
661 }
662
663 chomp($current_comment);
664 return($current_comment);
665}
666sub ctx_has_comment {
667 my ($first_line, $end_line) = @_;
668 my $cmt = ctx_locate_comment($first_line, $end_line);
669
Andy Whitcroft00df3442007-06-08 13:47:06 -0700670 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700671 ##print "CMMT: $cmt\n";
672
673 return ($cmt ne '');
674}
675
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700676sub cat_vet {
677 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700678 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700679
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700680 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700681 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
682 $res .= $1;
683 if ($2 ne '') {
684 $coded = sprintf("^%c", unpack('C', $2) + 64);
685 $res .= $coded;
686 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700687 }
688 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700689
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700690 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700691}
692
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800693my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800694my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800695my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700696my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800697
698sub annotate_reset {
699 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800700 $av_pending = '_';
701 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700702 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800703}
704
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700705sub annotate_values {
706 my ($stream, $type) = @_;
707
708 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700709 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700710 my $cur = $stream;
711
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800712 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700713
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700714 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700715 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800716 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700717 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700718 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800719 print "WS($1)\n" if ($dbg_values > 1);
720 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800721 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800722 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700723 }
724
Andy Whitcroft8ea3eb92008-07-23 21:29:08 -0700725 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800726 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700727 $type = 'T';
728
Andy Whitcroft389a2fe2008-07-23 21:29:05 -0700729 } elsif ($cur =~ /^($Modifier)\s*/) {
730 print "MODIFIER($1)\n" if ($dbg_values > 1);
731 $type = 'T';
732
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700733 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700734 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800735 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700736 push(@av_paren_type, $type);
737 if ($2 ne '') {
738 $av_pending = 'N';
739 }
740 $type = 'E';
741
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700742 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700743 print "UNDEF($1)\n" if ($dbg_values > 1);
744 $av_preprocessor = 1;
745 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700746
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700747 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800748 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800749 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800750
751 push(@av_paren_type, $type);
752 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700753 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800754
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700755 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800756 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
757 $av_preprocessor = 1;
758
759 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
760
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700761 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800762
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700763 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800764 print "PRE_END($1)\n" if ($dbg_values > 1);
765
766 $av_preprocessor = 1;
767
768 # Assume all arms of the conditional end as this
769 # one does, and continue as if the #endif was not here.
770 pop(@av_paren_type);
771 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700772 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700773
774 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800775 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700776
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700777 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
778 print "ATTR($1)\n" if ($dbg_values > 1);
779 $av_pending = $type;
780 $type = 'N';
781
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700782 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800783 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700784 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800785 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700786 }
787 $type = 'N';
788
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700789 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800790 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700791 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700792 $type = 'N';
793
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700794 } elsif ($cur =~/^(case)/o) {
795 print "CASE($1)\n" if ($dbg_values > 1);
796 $av_pend_colon = 'C';
797 $type = 'N';
798
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700799 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800800 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700801 $type = 'N';
802
803 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800804 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800805 push(@av_paren_type, $av_pending);
806 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700807 $type = 'N';
808
809 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800810 my $new_type = pop(@av_paren_type);
811 if ($new_type ne '_') {
812 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800813 print "PAREN('$1') -> $type\n"
814 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700815 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800816 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700817 }
818
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700819 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800820 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700821 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800822 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700823
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700824 } elsif ($cur =~ /^($Ident\s*):/) {
825 if ($type eq 'E') {
826 $av_pend_colon = 'L';
827 } elsif ($type eq 'T') {
828 $av_pend_colon = 'B';
829 }
830 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
831 $type = 'V';
832
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700833 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800834 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700835 $type = 'V';
836
837 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800838 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700839 $type = 'N';
840
Andy Whitcroftcf655042008-03-04 14:28:20 -0800841 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800842 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800843 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700844 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800845
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700846 } elsif ($cur =~ /^(\?)/o) {
847 print "QUESTION($1)\n" if ($dbg_values > 1);
848 $type = 'N';
849
850 } elsif ($cur =~ /^(:)/o) {
851 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
852
853 substr($var, length($res), 1, $av_pend_colon);
854 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
855 $type = 'E';
856 } else {
857 $type = 'N';
858 }
859 $av_pend_colon = 'O';
860
861 } elsif ($cur =~ /^(;|\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800862 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700863 $type = 'N';
864
Andy Whitcroft0d413862008-10-15 22:02:16 -0700865 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -0700866 my $variant;
867
868 print "OPV($1)\n" if ($dbg_values > 1);
869 if ($type eq 'V') {
870 $variant = 'B';
871 } else {
872 $variant = 'U';
873 }
874
875 substr($var, length($res), 1, $variant);
876 $type = 'N';
877
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700878 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800879 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700880 if ($1 ne '++' && $1 ne '--') {
881 $type = 'N';
882 }
883
884 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800885 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700886 }
887 if (defined $1) {
888 $cur = substr($cur, length($1));
889 $res .= $type x length($1);
890 }
891 }
892
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700893 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700894}
895
Andy Whitcroft8905a672007-11-28 16:21:06 -0800896sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800897 my ($possible, $line) = @_;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800898
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700899 print "CHECK<$possible> ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft0221f552008-07-23 21:29:08 -0700900 if ($possible !~ /^(?:$Modifier|$Storage|$Type|DEFINE_\S+)$/ &&
Andy Whitcroft8905a672007-11-28 16:21:06 -0800901 $possible ne 'goto' && $possible ne 'return' &&
Andy Whitcroft8905a672007-11-28 16:21:06 -0800902 $possible ne 'case' && $possible ne 'else' &&
Andy Whitcroftd3ddcf42008-07-23 21:28:58 -0700903 $possible ne 'asm' && $possible ne '__asm__' &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700904 $possible !~ /^(typedef|struct|enum)\b/) {
905 # Check for modifiers.
906 $possible =~ s/\s*$Storage\s*//g;
907 $possible =~ s/\s*$Sparse\s*//g;
908 if ($possible =~ /^\s*$/) {
909
910 } elsif ($possible =~ /\s/) {
911 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -0700912 for my $modifier (split(' ', $possible)) {
913 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
914 push(@modifierList, $modifier);
915 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700916
917 } else {
918 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
919 push(@typeList, $possible);
920 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800921 build_types();
922 }
923}
924
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700925my $prefix = '';
926
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700927sub report {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700928 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
929 return 0;
930 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800931 my $line = $prefix . $_[0];
932
933 $line = (split('\n', $line))[0] . "\n" if ($terse);
934
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800935 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700936
937 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700938}
939sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800940 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700941}
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700942sub ERROR {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700943 if (report("ERROR: $_[0]\n")) {
944 our $clean = 0;
945 our $cnt_error++;
946 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700947}
948sub WARN {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700949 if (report("WARNING: $_[0]\n")) {
950 our $clean = 0;
951 our $cnt_warn++;
952 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700953}
954sub CHK {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700955 if ($check && report("CHECK: $_[0]\n")) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700956 our $clean = 0;
957 our $cnt_chk++;
958 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700959}
960
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700961sub process {
962 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700963
964 my $linenr=0;
965 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800966 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700967 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800968 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700969
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700970 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700971 my $indent;
972 my $previndent=0;
973 my $stashindent=0;
974
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700975 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700976 my $signoff = 0;
977 my $is_patch = 0;
978
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800979 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700980 our $cnt_lines = 0;
981 our $cnt_error = 0;
982 our $cnt_warn = 0;
983 our $cnt_chk = 0;
984
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700985 # Trace the real file/line as we go.
986 my $realfile = '';
987 my $realline = 0;
988 my $realcnt = 0;
989 my $here = '';
990 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800991 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700992 my $first_line = 0;
993
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800994 my $prev_values = 'E';
995
996 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -0700997 my %suppress_ifbraces;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700998
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800999 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001000 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001001 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001002 my @setup_docs = ();
1003 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001004
1005 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001006 my $line;
1007 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001008 $linenr++;
1009 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001010
Andy Whitcroft773647a2008-03-28 14:15:58 -07001011 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001012 $setup_docs = 0;
1013 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1014 $setup_docs = 1;
1015 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001016 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001017 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001018 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1019 $realline=$1-1;
1020 if (defined $2) {
1021 $realcnt=$3+1;
1022 } else {
1023 $realcnt=1+1;
1024 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001025 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001026
1027 # Guestimate if this is a continuing comment. Run
1028 # the context looking for a comment "edge". If this
1029 # edge is a close comment then we must be in a comment
1030 # at context start.
1031 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001032 my $cnt = $realcnt;
1033 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1034 next if (defined $rawlines[$ln - 1] &&
1035 $rawlines[$ln - 1] =~ /^-/);
1036 $cnt--;
1037 #print "RAW<$rawlines[$ln - 1]>\n";
1038 ($edge) = (defined $rawlines[$ln - 1] &&
1039 $rawlines[$ln - 1] =~ m@(/\*|\*/)@);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001040 last if (defined $edge);
1041 }
1042 if (defined $edge && $edge eq '*/') {
1043 $in_comment = 1;
1044 }
1045
1046 # Guestimate if this is a continuing comment. If this
1047 # is the start of a diff block and this line starts
1048 # ' *' then it is very likely a comment.
1049 if (!defined $edge &&
1050 $rawlines[$linenr] =~ m@^.\s* \*(?:\s|$)@)
1051 {
1052 $in_comment = 1;
1053 }
1054
1055 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1056 sanitise_line_reset($in_comment);
1057
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001058 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001059 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001060 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001061 $line = sanitise_line($rawline);
1062 }
1063 push(@lines, $line);
1064
1065 if ($realcnt > 1) {
1066 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1067 } else {
1068 $realcnt = 0;
1069 }
1070
1071 #print "==>$rawline\n";
1072 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001073
1074 if ($setup_docs && $line =~ /^\+/) {
1075 push(@setup_docs, $line);
1076 }
1077 }
1078
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001079 $prefix = '';
1080
Andy Whitcroft773647a2008-03-28 14:15:58 -07001081 $realcnt = 0;
1082 $linenr = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001083 foreach my $line (@lines) {
1084 $linenr++;
1085
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001086 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001087
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001088#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001089 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001090 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001091 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001092 $realline=$1-1;
1093 if (defined $2) {
1094 $realcnt=$3+1;
1095 } else {
1096 $realcnt=1+1;
1097 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001098 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001099 $prev_values = 'E';
1100
Andy Whitcroft773647a2008-03-28 14:15:58 -07001101 %suppress_ifbraces = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001102 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001103
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001104# track the line number as we move through the hunk, note that
1105# new versions of GNU diff omit the leading space on completely
1106# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001107 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001108 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001109 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001110
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001111 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001112 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001113
1114 # Track the previous line.
1115 ($prevline, $stashline) = ($stashline, $line);
1116 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001117 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1118
Andy Whitcroft773647a2008-03-28 14:15:58 -07001119 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001120
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001121 } elsif ($realcnt == 1) {
1122 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001123 }
1124
1125#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001126 $prefix = "$filename:$realline: " if ($emacs && $file);
1127 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1128
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001129 $here = "#$linenr: " if (!$file);
1130 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001131
1132 # extract the filename as it passes
1133 if ($line=~/^\+\+\+\s+(\S+)/) {
1134 $realfile = $1;
1135 $realfile =~ s@^[^/]*/@@;
1136
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001137 if ($realfile =~ m@^include/asm/@) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001138 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1139 }
1140 next;
1141 }
1142
Randy Dunlap389834b2007-06-08 13:47:03 -07001143 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001144
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001145 my $hereline = "$here\n$rawline\n";
1146 my $herecurr = "$here\n$rawline\n";
1147 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001148
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001149 $cnt_lines++ if ($realcnt != 0);
1150
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001151#check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001152 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001153 # This is a signoff, if ugly, so do not double report.
1154 $signoff++;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001155 if (!($line =~ /^\s*Signed-off-by:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001156 WARN("Signed-off-by: is the preferred form\n" .
1157 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001158 }
1159 if ($line =~ /^\s*signed-off-by:\S/i) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001160 WARN("space required after Signed-off-by:\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001161 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001162 }
1163 }
1164
Andy Whitcroft00df3442007-06-08 13:47:06 -07001165# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001166 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001167 ERROR("patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001168 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001169 }
1170
1171# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1172 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001173 $rawline !~ m/^$UTF8*$/) {
1174 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1175
1176 my $blank = copy_spacing($rawline);
1177 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1178 my $hereptr = "$hereline$ptr\n";
1179
1180 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001181 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001182
Andy Whitcroft00df3442007-06-08 13:47:06 -07001183#ignore lines being removed
1184 if ($line=~/^-/) {next;}
1185
1186# check we are in a valid source file if not then ignore this hunk
1187 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001188
1189#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001190 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001191 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001192 ERROR("DOS line endings\n" . $herevet);
1193
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001194 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1195 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001196 ERROR("trailing whitespace\n" . $herevet);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001197 }
1198#80 column limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001199 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001200 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1201 $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1202 $length > 80)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001203 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001204 WARN("line over 80 characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001205 }
1206
Andy Whitcroft8905a672007-11-28 16:21:06 -08001207# check for adding lines without a newline.
1208 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1209 WARN("adding a line without newline at end of file\n" . $herecurr);
1210 }
1211
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001212# check we are in a valid source file *.[hc] if not then ignore this hunk
1213 next if ($realfile !~ /\.[hc]$/);
1214
1215# at the beginning of a line any tabs must come first and anything
1216# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001217 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1218 $rawline =~ /^\+\s* \s*/) {
1219 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001220 ERROR("code indent should use tabs where possible\n" . $herevet);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001221 }
1222
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001223# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001224 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001225 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1226 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001227
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001228# Check for potential 'bare' types
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001229 my ($stat, $cond, $line_nr_next, $remain_next);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001230 if ($realcnt && $line =~ /.\s*\S/) {
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001231 ($stat, $cond, $line_nr_next, $remain_next) =
1232 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001233 $stat =~ s/\n./\n /g;
1234 $cond =~ s/\n./\n /g;
1235
1236 my $s = $stat;
1237 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001238
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001239 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001240 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001241
1242 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001243 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001244
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001245 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001246 } 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 -07001247 my $type = $1;
1248 $type =~ s/\s+/ /g;
1249 possible($type, "A:" . $s);
1250
Andy Whitcroft8905a672007-11-28 16:21:06 -08001251 # definitions in global scope can only start with types
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001252 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001253 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001254 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001255
1256 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001257 while ($s =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001258 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001259 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001260
1261 # Check for any sort of function declaration.
1262 # int foo(something bar, other baz);
1263 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001264 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 -08001265 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001266
Andy Whitcroftcf655042008-03-04 14:28:20 -08001267 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001268 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001269 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001270
Andy Whitcroft8905a672007-11-28 16:21:06 -08001271 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001272 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001273
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001274 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001275 }
1276 }
1277 }
1278
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001279 }
1280
Andy Whitcroft653d4872007-06-23 17:16:34 -07001281#
1282# Checks which may be anchored in the context.
1283#
1284
1285# Check for switch () and associated case and default
1286# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07001287 if ($line=~/\bswitch\s*\(.*\)/) {
1288 my $err = '';
1289 my $sep = '';
1290 my @ctx = ctx_block_outer($linenr, $realcnt);
1291 shift(@ctx);
1292 for my $ctx (@ctx) {
1293 my ($clen, $cindent) = line_stats($ctx);
1294 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1295 $indent != $cindent) {
1296 $err .= "$sep$ctx\n";
1297 $sep = '';
1298 } else {
1299 $sep = "[...]\n";
1300 }
1301 }
1302 if ($err ne '') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001303 ERROR("switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001304 }
1305 }
Andy Whitcrofte2a763c2008-07-23 21:29:02 -07001306 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
Andy Whitcroft1bdab9e2008-10-15 22:02:17 -07001307 $line !~ /\G(?:
1308 (?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
1309 \s*return\s+
1310 )/xg)
1311 {
Andy Whitcrofte2a763c2008-07-23 21:29:02 -07001312 ERROR("trailing statements should be on next line\n" . $herecurr);
1313 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001314
1315# if/while/etc brace do not go on next line, unless defining a do while loop,
1316# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001317 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001318 my $pre_ctx = "$1$2";
1319
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001320 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001321 my $ctx_cnt = $realcnt - $#ctx - 1;
1322 my $ctx = join("\n", @ctx);
1323
Andy Whitcroft548596d2008-07-23 21:29:01 -07001324 my $ctx_ln = $linenr;
1325 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001326
Andy Whitcroft548596d2008-07-23 21:29:01 -07001327 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1328 defined $lines[$ctx_ln - 1] &&
1329 $lines[$ctx_ln - 1] =~ /^-/)) {
1330 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1331 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001332 $ctx_ln++;
1333 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07001334
Andy Whitcroft53210162008-07-23 21:29:03 -07001335 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1336 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001337
1338 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1339 ERROR("that open brace { should be on the previous line\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001340 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07001341 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001342 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1343 $ctx =~ /\)\s*\;\s*$/ &&
1344 defined $lines[$ctx_ln - 1])
1345 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001346 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1347 if ($nindent > $indent) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001348 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001349 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001350 }
1351 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001352 }
1353
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001354 # Track the 'values' across context and added lines.
1355 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001356 my ($curr_values, $curr_vars) =
1357 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001358 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001359 if ($dbg_values) {
1360 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001361 print "$linenr > .$outline\n";
1362 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001363 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001364 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001365 $prev_values = substr($curr_values, -1);
1366
Andy Whitcroft00df3442007-06-08 13:47:06 -07001367#ignore lines not being added
1368 if ($line=~/^[^\+]/) {next;}
1369
Andy Whitcroft653d4872007-06-23 17:16:34 -07001370# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07001371 if ($dbg_type) {
1372 if ($line =~ /^.\s*$Declare\s*$/) {
1373 ERROR("TEST: is type\n" . $herecurr);
1374 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1375 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1376 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001377 next;
1378 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001379# TEST: allow direct testing of the attribute matcher.
1380 if ($dbg_attr) {
1381 if ($line =~ /^.\s*$Attribute\s*$/) {
1382 ERROR("TEST: is attr\n" . $herecurr);
1383 } elsif ($dbg_attr > 1 && $line =~ /^.+($Attribute)/) {
1384 ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1385 }
1386 next;
1387 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001388
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001389# check for initialisation to aggregates open brace on the next line
1390 if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1391 $line =~ /^.\s*{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001392 ERROR("that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001393 }
1394
Andy Whitcroft653d4872007-06-23 17:16:34 -07001395#
1396# Checks which are anchored on the added line.
1397#
1398
1399# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001400 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001401 my $path = $1;
1402 if ($path =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001403 ERROR("malformed #include filename\n" .
1404 $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001405 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001406 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001407
1408# no C99 // comments
1409 if ($line =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001410 ERROR("do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001411 }
1412 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001413 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001414 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001415
1416#EXPORT_SYMBOL should immediately follow its function closing }.
Andy Whitcroft653d4872007-06-23 17:16:34 -07001417 if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1418 ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1419 my $name = $1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001420 if (($prevline !~ /^}/) &&
1421 ($prevline !~ /^\+}/) &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001422 ($prevline !~ /^ }/) &&
Andy Whitcroftcf655042008-03-04 14:28:20 -08001423 ($prevline !~ /^.DECLARE_$Ident\(\Q$name\E\)/) &&
1424 ($prevline !~ /^.LIST_HEAD\(\Q$name\E\)/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001425 ($prevline !~ /^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(/) &&
Andy Whitcroftcf655042008-03-04 14:28:20 -08001426 ($prevline !~ /\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001427 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001428 }
1429 }
1430
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001431# check for external initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001432 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001433 ERROR("do not initialise externals to 0 or NULL\n" .
1434 $herecurr);
1435 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001436# check for static initialisers.
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001437 if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001438 ERROR("do not initialise statics to 0 or NULL\n" .
1439 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001440 }
1441
Andy Whitcroft653d4872007-06-23 17:16:34 -07001442# check for new typedefs, only function parameters and sparse annotations
1443# make sense.
1444 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001445 $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001446 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001447 $line !~ /\b__bitwise(?:__|)\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001448 WARN("do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001449 }
1450
1451# * goes on variable not on type
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001452 if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001453 ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" .
1454 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001455
1456 } elsif ($line =~ m{\($NonptrType\s+(\*+)(?!\s+const)\s+\)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001457 ERROR("\"(foo $1 )\" should be \"(foo $1)\"\n" .
1458 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001459
Andy Whitcroft234fff62008-07-23 21:29:12 -07001460 } elsif ($line =~ m{\b$NonptrType(\*+)(?:\s+(?:$Attribute|$Sparse))?\s+[A-Za-z\d_]+}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001461 ERROR("\"foo$1 bar\" should be \"foo $1bar\"\n" .
1462 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001463
Andy Whitcroft234fff62008-07-23 21:29:12 -07001464 } elsif ($line =~ m{\b$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001465 ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" .
1466 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001467 }
1468
1469# # no BUG() or BUG_ON()
1470# if ($line =~ /\b(BUG|BUG_ON)\b/) {
1471# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1472# print "$herecurr";
1473# $clean = 0;
1474# }
1475
Andy Whitcroft8905a672007-11-28 16:21:06 -08001476 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001477 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 -08001478 }
1479
Andy Whitcroft00df3442007-06-08 13:47:06 -07001480# printk should use KERN_* levels. Note that follow on printk's on the
1481# same line do not need a level, so we use the current block context
1482# to try and find and validate the current printk. In summary the current
1483# printk includes all preceeding printk's which have no newline on the end.
1484# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001485 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001486 my $ok = 0;
1487 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1488 #print "CHECK<$lines[$ln - 1]\n";
1489 # we have a preceeding printk if it ends
1490 # with "\n" ignore it, else it is to blame
1491 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1492 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1493 $ok = 1;
1494 }
1495 last;
1496 }
1497 }
1498 if ($ok == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001499 WARN("printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001500 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001501 }
1502
Andy Whitcroft653d4872007-06-23 17:16:34 -07001503# function brace can't be on same line, except for #defines of do while,
1504# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001505 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1506 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001507 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001508 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001509
Andy Whitcroft8905a672007-11-28 16:21:06 -08001510# open braces for enum, union and struct go on the same line.
1511 if ($line =~ /^.\s*{/ &&
1512 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1513 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1514 }
1515
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001516# check for spacing round square brackets; allowed:
1517# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001518# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1519# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001520 while ($line =~ /(.*?\s)\[/g) {
1521 my ($where, $prefix) = ($-[1], $1);
1522 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001523 ($where != 0 || $prefix !~ /^.\s+$/) &&
1524 $prefix !~ /{\s+$/) {
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001525 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1526 }
1527 }
1528
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001529# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001530 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001531 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001532 my $ctx_before = substr($line, 0, $-[1]);
1533 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001534
1535 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001536 if ($name =~ /^(?:
1537 if|for|while|switch|return|case|
1538 volatile|__volatile__|
1539 __attribute__|format|__extension__|
1540 asm|__asm__)$/x)
1541 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001542
1543 # cpp #define statements have non-optional spaces, ie
1544 # if there is a space between the name and the open
1545 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001546 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001547
1548 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001549 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001550
1551 # If this whole things ends with a type its most
1552 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001553 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001554
1555 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001556 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001557 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001558 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001559# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001560 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001561 my $ops = qr{
1562 <<=|>>=|<=|>=|==|!=|
1563 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1564 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001565 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1566 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001567 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001568 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001569 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001570
1571 my $blank = copy_spacing($opline);
1572
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001573 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001574 $off += length($elements[$n]);
1575
Andy Whitcroft773647a2008-03-28 14:15:58 -07001576 # Pick up the preceeding and succeeding characters.
1577 my $ca = substr($opline, 0, $off);
1578 my $cc = '';
1579 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1580 $cc = substr($opline, $off + length($elements[$n + 1]));
1581 }
1582 my $cb = "$ca$;$cc";
1583
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001584 my $a = '';
1585 $a = 'V' if ($elements[$n] ne '');
1586 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001587 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001588 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1589 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07001590 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001591
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001592 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001593
1594 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001595 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001596 $c = 'V' if ($elements[$n + 2] ne '');
1597 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001598 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001599 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1600 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001601 $c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001602 } else {
1603 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001604 }
1605
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001606 my $ctx = "${a}x${c}";
1607
1608 my $at = "(ctx:$ctx)";
1609
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001610 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001611 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001612
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001613 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001614 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001615
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001616 # Get the full operator variant.
1617 my $opv = $op . substr($curr_vars, $off, 1);
1618
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001619 # Ignore operators passed as parameters.
1620 if ($op_type ne 'V' &&
1621 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1622
Andy Whitcroftcf655042008-03-04 14:28:20 -08001623# # Ignore comments
1624# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001625
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001626 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001627 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001628 if ($ctx !~ /.x[WEBC]/ &&
1629 $cc !~ /^\\/ && $cc !~ /^;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001630 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001631 }
1632
1633 # // is a comment
1634 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001635
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001636 # No spaces for:
1637 # ->
1638 # : when part of a bitfield
1639 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001640 if ($ctx =~ /Wx.|.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001641 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001642 }
1643
1644 # , must have a space on the right.
1645 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001646 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001647 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001648 }
1649
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001650 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001651 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001652 #warn "'*' is part of type\n";
1653
1654 # unary operators should have a space before and
1655 # none after. May be left adjacent to another
1656 # unary operator, or a cast
1657 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001658 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07001659 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001660 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001661 ERROR("space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001662 }
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001663 if ($op eq '*' && $cc =~/\s*const\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001664 # A unary '*' may be const
1665
1666 } elsif ($ctx =~ /.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001667 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001668 }
1669
1670 # unary ++ and unary -- are allowed no space on one side.
1671 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001672 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1673 ERROR("space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001674 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001675 if ($ctx =~ /Wx[BE]/ ||
1676 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1677 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001678 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001679 if ($ctx =~ /ExW/) {
1680 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1681 }
1682
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001683
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001684 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001685 } elsif ($op eq '<<' or $op eq '>>' or
1686 $op eq '&' or $op eq '^' or $op eq '|' or
1687 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001688 $op eq '*' or $op eq '/' or
1689 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001690 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001691 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001692 ERROR("need consistent spacing around '$op' $at\n" .
1693 $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001694 }
1695
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001696 # A colon needs no spaces before when it is
1697 # terminating a case value or a label.
1698 } elsif ($opv eq ':C' || $opv eq ':L') {
1699 if ($ctx =~ /Wx./) {
1700 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1701 }
1702
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001703 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08001704 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001705 my $ok = 0;
1706
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001707 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001708 if (($op eq '<' &&
1709 $cc =~ /^\S+\@\S+>/) ||
1710 ($op eq '>' &&
1711 $ca =~ /<\S+\@\S+$/))
1712 {
1713 $ok = 1;
1714 }
1715
1716 # Ignore ?:
1717 if (($opv eq ':O' && $ca =~ /\?$/) ||
1718 ($op eq '?' && $cc =~ /^:/)) {
1719 $ok = 1;
1720 }
1721
1722 if ($ok == 0) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001723 ERROR("spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001724 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001725 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001726 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001727 }
1728 }
1729
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001730# check for multiple assignments
1731 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001732 CHK("multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001733 }
1734
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001735## # check for multiple declarations, allowing for a function declaration
1736## # continuation.
1737## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
1738## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
1739##
1740## # Remove any bracketed sections to ensure we do not
1741## # falsly report the parameters of functions.
1742## my $ln = $line;
1743## while ($ln =~ s/\([^\(\)]*\)//g) {
1744## }
1745## if ($ln =~ /,/) {
1746## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
1747## }
1748## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001749
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001750#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001751 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
1752 $line =~ /do{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001753 ERROR("space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001754 }
1755
1756# closing brace should have a space following it when it has anything
1757# on the line
1758 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001759 ERROR("space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001760 }
1761
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001762# check spacing on square brackets
1763 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001764 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001765 }
1766 if ($line =~ /\s\]/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001767 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001768 }
1769
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001770# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001771 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
1772 $line !~ /for\s*\(\s+;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001773 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001774 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001775 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001776 $line !~ /for\s*\(.*;\s+\)/ &&
1777 $line !~ /:\s+\)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001778 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001779 }
1780
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001781#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001782 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001783 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001784 WARN("labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001785 }
1786
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001787# Return is not a function.
1788 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
1789 my $spacing = $1;
1790 my $value = $2;
1791
1792 # Flatten any parentheses and braces
Andy Whitcroftfee61c42008-07-23 21:28:56 -07001793 $value =~ s/\)\(/\) \(/g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001794 while ($value =~ s/\([^\(\)]*\)/1/) {
1795 }
1796
1797 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
1798 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
1799
1800 } elsif ($spacing !~ /\s+/) {
1801 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1802 }
1803 }
1804
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001805# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001806 if ($line=~/\b(if|while|for|switch)\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001807 ERROR("space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001808 }
1809
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001810# Check for illegal assignment in if conditional -- and check for trailing
1811# statements after the conditional.
Andy Whitcroft53210162008-07-23 21:29:03 -07001812 if ($line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001813 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001814
1815 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001816 ERROR("do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001817 }
1818
1819 # Find out what is on the end of the line after the
1820 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001821 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001822 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001823 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07001824 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
1825 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001826 {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001827 ERROR("trailing statements should be on next line\n" . $herecurr);
1828 }
1829 }
1830
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001831# Check relative indent for conditionals and blocks.
1832 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1833 my ($s, $c) = ($stat, $cond);
1834
1835 substr($s, 0, length($c), '');
1836
1837 # Make sure we remove the line prefixes as we have
1838 # none on the first line, and are going to readd them
1839 # where necessary.
1840 $s =~ s/\n./\n/gs;
1841
1842 # We want to check the first line inside the block
1843 # starting at the end of the conditional, so remove:
1844 # 1) any blank line termination
1845 # 2) any opening brace { on end of the line
1846 # 3) any do (...) {
1847 my $continuation = 0;
1848 my $check = 0;
1849 $s =~ s/^.*\bdo\b//;
1850 $s =~ s/^\s*{//;
1851 if ($s =~ s/^\s*\\//) {
1852 $continuation = 1;
1853 }
1854 if ($s =~ s/^\s*\n//) {
1855 $check = 1;
1856 }
1857
1858 # Also ignore a loop construct at the end of a
1859 # preprocessor statement.
1860 if (($prevline =~ /^.\s*#\s*define\s/ ||
1861 $prevline =~ /\\\s*$/) && $continuation == 0) {
1862 $check = 0;
1863 }
1864
1865 # Ignore the current line if its is a preprocessor
1866 # line.
1867 if ($s =~ /^\s*#\s*/) {
1868 $check = 0;
1869 }
1870
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001871 # Ignore the current line if it is label.
1872 if ($s =~ /^\s*$Ident\s*:/) {
1873 $check = 0;
1874 }
1875
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001876 my (undef, $sindent) = line_stats("+" . $s);
1877
1878 ##print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s>\n";
1879
1880 if ($check && (($sindent % 8) != 0 ||
1881 ($sindent <= $indent && $s ne ''))) {
1882 WARN("suspect code indent for conditional statements\n" . $herecurr);
1883 }
1884 }
1885
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001886# Check for bitwise tests written as boolean
1887 if ($line =~ /
1888 (?:
1889 (?:\[|\(|\&\&|\|\|)
1890 \s*0[xX][0-9]+\s*
1891 (?:\&\&|\|\|)
1892 |
1893 (?:\&\&|\|\|)
1894 \s*0[xX][0-9]+\s*
1895 (?:\&\&|\|\||\)|\])
1896 )/x)
1897 {
1898 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
1899 }
1900
Andy Whitcroft8905a672007-11-28 16:21:06 -08001901# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001902 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
1903 my $s = $1;
1904 $s =~ s/$;//g; # Remove any comments
1905 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
1906 ERROR("trailing statements should be on next line\n" . $herecurr);
1907 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001908 }
1909
1910 # Check for }<nl>else {, these must be at the same
1911 # indent level to be relevant to each other.
1912 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
1913 $previndent == $indent) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001914 ERROR("else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001915 }
1916
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001917 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
1918 $previndent == $indent) {
1919 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
1920
1921 # Find out what is on the end of the line after the
1922 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001923 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001924 $s =~ s/\n.*//g;
1925
1926 if ($s =~ /^\s*;/) {
1927 ERROR("while should follow close brace '}'\n" . $hereprev);
1928 }
1929 }
1930
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001931#studly caps, commented out until figure out how to distinguish between use of existing and adding new
1932# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
1933# print "No studly caps, use _\n";
1934# print "$herecurr";
1935# $clean = 0;
1936# }
1937
1938#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001939 if ($line=~/\#\s*define.*\\\s$/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001940 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001941 }
1942
Andy Whitcroft653d4872007-06-23 17:16:34 -07001943#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001944 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07001945 my $file = "$1.h";
1946 my $checkfile = "include/linux/$file";
1947 if (-f "$root/$checkfile" &&
1948 $realfile ne $checkfile &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001949 $1 ne 'irq')
1950 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07001951 if ($realfile =~ m{^arch/}) {
1952 CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
1953 } else {
1954 WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
1955 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001956 }
1957 }
1958
Andy Whitcroft653d4872007-06-23 17:16:34 -07001959# multi-statement macros should be enclosed in a do while loop, grab the
1960# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08001961# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07001962 if ($realfile !~ m@/vmlinux.lds.h$@ &&
1963 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001964 my $ln = $linenr;
1965 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001966 my ($off, $dstat, $dcond, $rest);
1967 my $ctx = '';
Andy Whitcroft653d4872007-06-23 17:16:34 -07001968
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001969 my $args = defined($1);
1970
1971 # Find the end of the macro and limit our statement
1972 # search to that.
1973 while ($cnt > 0 && defined $lines[$ln - 1] &&
1974 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
1975 {
1976 $ctx .= $rawlines[$ln - 1] . "\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001977 $cnt-- if ($lines[$ln - 1] !~ /^-/);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001978 $ln++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001979 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001980 $ctx .= $rawlines[$ln - 1];
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001981
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001982 ($dstat, $dcond, $ln, $cnt, $off) =
1983 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
1984 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001985 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001986
1987 # Extract the remainder of the define (if any) and
1988 # rip off surrounding spaces, and trailing \'s.
1989 $rest = '';
Andy Whitcroft636d1402008-10-15 22:02:18 -07001990 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
1991 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001992 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
1993 $rest .= substr($lines[$ln - 1], $off) . "\n";
1994 $cnt--;
1995 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001996 $ln++;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001997 $off = 0;
1998 }
1999 $rest =~ s/\\\n.//g;
2000 $rest =~ s/^\s*//s;
2001 $rest =~ s/\s*$//s;
2002
2003 # Clean up the original statement.
2004 if ($args) {
2005 substr($dstat, 0, length($dcond), '');
2006 } else {
2007 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2008 }
Andy Whitcroft292f1a92008-07-23 21:29:11 -07002009 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002010 $dstat =~ s/\\\n.//g;
2011 $dstat =~ s/^\s*//s;
2012 $dstat =~ s/\s*$//s;
2013
2014 # Flatten any parentheses and braces
2015 while ($dstat =~ s/\([^\(\)]*\)/1/) {
2016 }
2017 while ($dstat =~ s/\{[^\{\}]*\}/1/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002018 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002019
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002020 my $exceptions = qr{
2021 $Declare|
2022 module_param_named|
2023 MODULE_PARAM_DESC|
2024 DECLARE_PER_CPU|
2025 DEFINE_PER_CPU|
2026 __typeof__\(
2027 }x;
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002028 #print "REST<$rest>\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002029 if ($rest ne '') {
2030 if ($rest !~ /while\s*\(/ &&
2031 $dstat !~ /$exceptions/)
2032 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002033 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 -07002034 }
2035
2036 } elsif ($ctx !~ /;/) {
2037 if ($dstat ne '' &&
2038 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2039 $dstat !~ /$exceptions/ &&
2040 $dstat =~ /$Operators/)
2041 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002042 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002043 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002044 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002045 }
2046
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002047# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002048 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2049 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08002050 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002051 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002052 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2053 if ($#chunks > 0 && $level == 0) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002054 my $allowed = 0;
2055 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002056 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002057 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002058 for my $chunk (@chunks) {
2059 my ($cond, $block) = @{$chunk};
2060
Andy Whitcroft773647a2008-03-28 14:15:58 -07002061 # If the condition carries leading newlines, then count those as offsets.
2062 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2063 my $offset = statement_rawlines($whitespace) - 1;
2064
2065 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2066
2067 # We have looked at and allowed this specific line.
2068 $suppress_ifbraces{$ln + $offset} = 1;
2069
2070 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002071 $ln += statement_rawlines($block) - 1;
2072
Andy Whitcroft773647a2008-03-28 14:15:58 -07002073 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002074
2075 $seen++ if ($block =~ /^\s*{/);
2076
Andy Whitcroftcf655042008-03-04 14:28:20 -08002077 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2078 if (statement_lines($cond) > 1) {
2079 #print "APW: ALLOWED: cond<$cond>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002080 $allowed = 1;
2081 }
2082 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002083 #print "APW: ALLOWED: block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002084 $allowed = 1;
2085 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002086 if (statement_block_size($block) > 1) {
2087 #print "APW: ALLOWED: lines block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002088 $allowed = 1;
2089 }
2090 }
2091 if ($seen && !$allowed) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002092 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002093 }
2094 }
2095 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002096 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002097 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002098 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002099
Andy Whitcroftcf655042008-03-04 14:28:20 -08002100 # Check the pre-context.
2101 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2102 #print "APW: ALLOWED: pre<$1>\n";
2103 $allowed = 1;
2104 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002105
2106 my ($level, $endln, @chunks) =
2107 ctx_statement_full($linenr, $realcnt, $-[0]);
2108
Andy Whitcroftcf655042008-03-04 14:28:20 -08002109 # Check the condition.
2110 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07002111 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002112 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002113 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08002114 }
2115 if (statement_lines($cond) > 1) {
2116 #print "APW: ALLOWED: cond<$cond>\n";
2117 $allowed = 1;
2118 }
2119 if ($block =~/\b(?:if|for|while)\b/) {
2120 #print "APW: ALLOWED: block<$block>\n";
2121 $allowed = 1;
2122 }
2123 if (statement_block_size($block) > 1) {
2124 #print "APW: ALLOWED: lines block<$block>\n";
2125 $allowed = 1;
2126 }
2127 # Check the post-context.
2128 if (defined $chunks[1]) {
2129 my ($cond, $block) = @{$chunks[1]};
2130 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002131 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002132 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002133 if ($block =~ /^\s*\{/) {
2134 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2135 $allowed = 1;
2136 }
2137 }
2138 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2139 my $herectx = $here . "\n";;
2140 my $end = $linenr + statement_rawlines($block) - 1;
2141
2142 for (my $ln = $linenr - 1; $ln < $end; $ln++) {
2143 $herectx .= $rawlines[$ln] . "\n";;
2144 }
2145
2146 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002147 }
2148 }
2149
Andy Whitcroft653d4872007-06-23 17:16:34 -07002150# don't include deprecated include files (uses RAW line)
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002151 for my $inc (@dep_includes) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002152 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002153 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002154 }
2155 }
2156
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002157# don't use deprecated functions
2158 for my $func (@dep_functions) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002159 if ($line =~ /\b$func\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002160 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002161 }
2162 }
2163
2164# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002165 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2166 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002167 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002168 }
2169
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002170# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2171 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2172 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2173 }
2174
Andy Whitcroft00df3442007-06-08 13:47:06 -07002175# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002176 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002177 CHK("if this code is redundant consider removing it\n" .
2178 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002179 }
2180
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002181# check for needless kfree() checks
2182 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2183 my $expr = $1;
2184 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
Wolfram Sang3c232142008-07-23 21:29:05 -07002185 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002186 }
2187 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07002188# check for needless usb_free_urb() checks
2189 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2190 my $expr = $1;
2191 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2192 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2193 }
2194 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002195
Andy Whitcroft00df3442007-06-08 13:47:06 -07002196# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002197# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002198# print "#ifdef in C files should be avoided\n";
2199# print "$herecurr";
2200# $clean = 0;
2201# }
2202
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002203# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002204 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002205 ERROR("exactly one space required after that #$1\n" . $herecurr);
2206 }
2207
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002208# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002209 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2210 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002211 my $which = $1;
2212 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002213 CHK("$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002214 }
2215 }
2216# check for memory barriers without a comment.
2217 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2218 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002219 CHK("memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002220 }
2221 }
2222# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002223 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002224 CHK("architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002225 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002226
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002227# check the location of the inline attribute, that it is between
2228# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002229 if ($line =~ /\b$Type\s+$Inline\b/ ||
2230 $line =~ /\b$Inline\s+$Storage\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002231 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2232 }
2233
Andy Whitcroft8905a672007-11-28 16:21:06 -08002234# Check for __inline__ and __inline, prefer inline
2235 if ($line =~ /\b(__inline__|__inline)\b/) {
2236 WARN("plain inline is preferred over $1\n" . $herecurr);
2237 }
2238
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002239# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002240 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002241 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002242 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002243 my $function_name = $1;
2244 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002245
2246 my $s = $stat;
2247 if (defined $cond) {
2248 substr($s, 0, length($cond), '');
2249 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002250 if ($s =~ /^\s*;/ &&
2251 $function_name ne 'uninitialized_var')
2252 {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002253 WARN("externs should be avoided in .c files\n" . $herecurr);
2254 }
2255
2256 if ($paren_space =~ /\n/) {
2257 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2258 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002259
2260 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2261 $stat =~ /^.\s*extern\s+/)
2262 {
2263 WARN("externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002264 }
2265
2266# checks for new __setup's
2267 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2268 my $name = $1;
2269
2270 if (!grep(/$name/, @setup_docs)) {
2271 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2272 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002273 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002274
2275# check for pointless casting of kmalloc return
2276 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2277 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2278 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002279
2280# check for gcc specific __FUNCTION__
2281 if ($line =~ /__FUNCTION__/) {
2282 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2283 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002284
2285# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002286 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002287 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2288 }
2289# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002290 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002291 WARN("consider using a completion\n" . $herecurr);
2292 }
2293# recommend strict_strto* over simple_strto*
2294 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2295 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2296 }
Michael Ellermanf3db6632008-07-23 21:28:57 -07002297# check for __initcall(), use device_initcall() explicitly please
2298 if ($line =~ /^.\s*__initcall\s*\(/) {
2299 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2300 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002301
2302# use of NR_CPUS is usually wrong
2303# ignore definitions of NR_CPUS and usage to define arrays as likely right
2304 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002305 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2306 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002307 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2308 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2309 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002310 {
2311 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2312 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002313
2314# check for %L{u,d,i} in strings
2315 my $string;
2316 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2317 $string = substr($rawline, $-[1], $+[1] - $-[1]);
2318 if ($string =~ /(?<!%)%L[udi]/) {
2319 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2320 last;
2321 }
2322 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002323 }
2324
2325 # If we have no input at all, then there is nothing to report on
2326 # so just keep quiet.
2327 if ($#rawlines == -1) {
2328 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002329 }
2330
Andy Whitcroft8905a672007-11-28 16:21:06 -08002331 # In mailback mode only produce a report in the negative, for
2332 # things that appear to be patches.
2333 if ($mailback && ($clean == 1 || !$is_patch)) {
2334 exit(0);
2335 }
2336
2337 # This is not a patch, and we are are in 'no-patch' mode so
2338 # just keep quiet.
2339 if (!$chk_patch && !$is_patch) {
2340 exit(0);
2341 }
2342
2343 if (!$is_patch) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002344 ERROR("Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002345 }
2346 if ($is_patch && $chk_signoff && $signoff == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002347 ERROR("Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002348 }
2349
Andy Whitcroft8905a672007-11-28 16:21:06 -08002350 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002351 if ($summary && !($clean == 1 && $quiet == 1)) {
2352 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002353 print "total: $cnt_error errors, $cnt_warn warnings, " .
2354 (($check)? "$cnt_chk checks, " : "") .
2355 "$cnt_lines lines checked\n";
2356 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002357 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002358
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002359 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002360 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002361 }
2362 if ($clean == 0 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002363 print "$vname has style problems, please review. If any of these errors\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002364 print "are false positives report them to the maintainer, see\n";
2365 print "CHECKPATCH in MAINTAINERS.\n";
2366 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002367
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002368 return $clean;
2369}