blob: 19690a2ddb746a2bcad699eb907f1ddb6b0c5fb2 [file] [log] [blame]
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001#!/usr/bin/perl -w
2# (c) 2001, Dave Jones. <davej@codemonkey.org.uk> (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004# (c) 2007, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite, etc)
5# Licensed under the terms of the GNU GPL License version 2
6
7use strict;
8
9my $P = $0;
Andy Whitcroft00df3442007-06-08 13:47:06 -070010$P =~ s@.*/@@g;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070011
Andy Whitcroft5fdd23a2008-10-15 22:02:28 -070012my $V = '0.23';
Andy Whitcroft0a920b52007-06-01 00:46:48 -070013
14use Getopt::Long qw(:config no_auto_abbrev);
15
16my $quiet = 0;
17my $tree = 1;
18my $chk_signoff = 1;
19my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070020my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070021my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080022my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070023my $file = 0;
24my $check = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080025my $summary = 1;
26my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080027my $summary_file = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070028my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080029my %debug;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070030GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070031 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-06-01 00:46:48 -070032 'tree!' => \$tree,
33 'signoff!' => \$chk_signoff,
34 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070035 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -080036 'terse!' => \$terse,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070037 'file!' => \$file,
38 'subjective!' => \$check,
39 'strict!' => \$check,
40 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -080041 'summary!' => \$summary,
42 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -080043 'summary-file!' => \$summary_file,
44
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080045 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -070046 'test-only=s' => \$tst_only,
Andy Whitcroft0a920b52007-06-01 00:46:48 -070047) or exit;
48
49my $exit = 0;
50
51if ($#ARGV < 0) {
Andy Whitcroft00df3442007-06-08 13:47:06 -070052 print "usage: $P [options] patchfile\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -070053 print "version: $V\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -080054 print "options: -q => quiet\n";
55 print " --no-tree => run without a kernel tree\n";
56 print " --terse => one line per report\n";
57 print " --emacs => emacs compile window format\n";
58 print " --file => check a source file\n";
59 print " --strict => enable more subjective tests\n";
60 print " --root => path to the kernel tree root\n";
61 print " --no-summary => suppress the per-file summary\n";
62 print " --summary-file => include the filename in summary\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -070063 exit(1);
64}
65
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080066my $dbg_values = 0;
67my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -070068my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -070069my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080070for my $key (keys %debug) {
71 eval "\${dbg_$key} = '$debug{$key}';"
72}
73
Andy Whitcroft8905a672007-11-28 16:21:06 -080074if ($terse) {
75 $emacs = 1;
76 $quiet++;
77}
78
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070079if ($tree) {
80 if (defined $root) {
81 if (!top_of_kernel_tree($root)) {
82 die "$P: $root: --root does not point at a valid tree\n";
83 }
84 } else {
85 if (top_of_kernel_tree('.')) {
86 $root = '.';
87 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
88 top_of_kernel_tree($1)) {
89 $root = $1;
90 }
91 }
92
93 if (!defined $root) {
94 print "Must be run from the top-level dir. of a kernel tree\n";
95 exit(2);
96 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -070097}
98
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070099my $emitted_corrupt = 0;
100
101our $Ident = qr{[A-Za-z_][A-Za-z\d_]*};
102our $Storage = qr{extern|static|asmlinkage};
103our $Sparse = qr{
104 __user|
105 __kernel|
106 __force|
107 __iomem|
108 __must_check|
109 __init_refok|
Andy Whitcroftcf655042008-03-04 14:28:20 -0800110 __kprobes
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700111 }x;
112our $Attribute = qr{
113 const|
114 __read_mostly|
115 __kprobes|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700116 __(?:mem|cpu|dev|)(?:initdata|init)|
117 ____cacheline_aligned|
118 ____cacheline_aligned_in_smp|
119 ____cacheline_internodealigned_in_smp
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700120 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700121our $Modifier;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700122our $Inline = qr{inline|__always_inline|noinline};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700123our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
124our $Lval = qr{$Ident(?:$Member)*};
125
126our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
127our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
128our $Operators = qr{
129 <=|>=|==|!=|
130 =>|->|<<|>>|<|>|!|~|
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800131 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700132 }x;
133
Andy Whitcroft8905a672007-11-28 16:21:06 -0800134our $NonptrType;
135our $Type;
136our $Declare;
137
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700138our $UTF8 = qr {
139 [\x09\x0A\x0D\x20-\x7E] # ASCII
140 | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
141 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
142 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
143 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
144 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
145 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
146 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
147}x;
148
Andy 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 Whitcroft81bc0e02008-10-15 22:02:26 -0700338 if ($sanitise_quote eq '*/' && 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 Whitcroftdea33492008-10-15 22:02:25 -0700411 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800412 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800413 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800414 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800415 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800416 $len = length($blk);
417 $line++;
418 last;
419 }
420 # Bail if there is no further context.
421 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800422 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800423 last;
424 }
425 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800426 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800427 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800428 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800429
Andy Whitcroft773647a2008-03-28 14:15:58 -0700430 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800431 # Statement ends at the ';' or a close '}' at the
432 # outermost level.
433 if ($level == 0 && $c eq ';') {
434 last;
435 }
436
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800437 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700438 if ($level == 0 && $coff_set == 0 &&
439 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
440 $remainder =~ /^(else)(?:\s|{)/ &&
441 $remainder !~ /^else\s+if\b/) {
442 $coff = $off + length($1) - 1;
443 $coff_set = 1;
444 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
445 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800446 }
447
Andy Whitcroft8905a672007-11-28 16:21:06 -0800448 if (($type eq '' || $type eq '(') && $c eq '(') {
449 $level++;
450 $type = '(';
451 }
452 if ($type eq '(' && $c eq ')') {
453 $level--;
454 $type = ($level != 0)? '(' : '';
455
456 if ($level == 0 && $coff < $soff) {
457 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700458 $coff_set = 1;
459 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800460 }
461 }
462 if (($type eq '' || $type eq '{') && $c eq '{') {
463 $level++;
464 $type = '{';
465 }
466 if ($type eq '{' && $c eq '}') {
467 $level--;
468 $type = ($level != 0)? '{' : '';
469
470 if ($level == 0) {
471 last;
472 }
473 }
474 $off++;
475 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700476 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800477 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700478 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800479 $line++;
480 $remain--;
481 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800482
483 my $statement = substr($blk, $soff, $off - $soff + 1);
484 my $condition = substr($blk, $soff, $coff - $soff + 1);
485
486 #warn "STATEMENT<$statement>\n";
487 #warn "CONDITION<$condition>\n";
488
Andy Whitcroft773647a2008-03-28 14:15:58 -0700489 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800490
491 return ($statement, $condition,
492 $line, $remain + 1, $off - $loff + 1, $level);
493}
494
Andy Whitcroftcf655042008-03-04 14:28:20 -0800495sub statement_lines {
496 my ($stmt) = @_;
497
498 # Strip the diff line prefixes and rip blank lines at start and end.
499 $stmt =~ s/(^|\n)./$1/g;
500 $stmt =~ s/^\s*//;
501 $stmt =~ s/\s*$//;
502
503 my @stmt_lines = ($stmt =~ /\n/g);
504
505 return $#stmt_lines + 2;
506}
507
508sub statement_rawlines {
509 my ($stmt) = @_;
510
511 my @stmt_lines = ($stmt =~ /\n/g);
512
513 return $#stmt_lines + 2;
514}
515
516sub statement_block_size {
517 my ($stmt) = @_;
518
519 $stmt =~ s/(^|\n)./$1/g;
520 $stmt =~ s/^\s*{//;
521 $stmt =~ s/}\s*$//;
522 $stmt =~ s/^\s*//;
523 $stmt =~ s/\s*$//;
524
525 my @stmt_lines = ($stmt =~ /\n/g);
526 my @stmt_statements = ($stmt =~ /;/g);
527
528 my $stmt_lines = $#stmt_lines + 2;
529 my $stmt_statements = $#stmt_statements + 1;
530
531 if ($stmt_lines > $stmt_statements) {
532 return $stmt_lines;
533 } else {
534 return $stmt_statements;
535 }
536}
537
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800538sub ctx_statement_full {
539 my ($linenr, $remain, $off) = @_;
540 my ($statement, $condition, $level);
541
542 my (@chunks);
543
Andy Whitcroftcf655042008-03-04 14:28:20 -0800544 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800545 ($statement, $condition, $linenr, $remain, $off, $level) =
546 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700547 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800548 push(@chunks, [ $condition, $statement ]);
549 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
550 return ($level, $linenr, @chunks);
551 }
552
553 # Pull in the following conditional/block pairs and see if they
554 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800555 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800556 ($statement, $condition, $linenr, $remain, $off, $level) =
557 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800558 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700559 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800560 #print "C: push\n";
561 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800562 }
563
564 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800565}
566
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700567sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700568 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700569 my $line;
570 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700571 my $blk = '';
572 my @o;
573 my @c;
574 my @res = ();
575
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700576 my $level = 0;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700577 for ($line = $start; $remain > 0; $line++) {
578 next if ($rawlines[$line] =~ /^-/);
579 $remain--;
580
581 $blk .= $rawlines[$line];
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700582 foreach my $c (split(//, $rawlines[$line])) {
583 ##print "C<$c>L<$level><$open$close>O<$off>\n";
584 if ($off > 0) {
585 $off--;
586 next;
587 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700588
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700589 if ($c eq $close && $level > 0) {
590 $level--;
591 last if ($level == 0);
592 } elsif ($c eq $open) {
593 $level++;
594 }
595 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700596
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700597 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700598 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700599 }
600
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700601 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700602 }
603
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700604 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700605}
606sub ctx_block_outer {
607 my ($linenr, $remain) = @_;
608
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700609 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
610 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700611}
612sub ctx_block {
613 my ($linenr, $remain) = @_;
614
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700615 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
616 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700617}
618sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700619 my ($linenr, $remain, $off) = @_;
620
621 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
622 return @r;
623}
624sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700625 my ($linenr, $remain) = @_;
626
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700627 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700628}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700629sub ctx_statement_level {
630 my ($linenr, $remain, $off) = @_;
631
632 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
633}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700634
635sub ctx_locate_comment {
636 my ($first_line, $end_line) = @_;
637
638 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700639 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700640 return $current_comment if (defined $current_comment);
641
642 # Look through the context and try and figure out if there is a
643 # comment.
644 my $in_comment = 0;
645 $current_comment = '';
646 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700647 my $line = $rawlines[$linenr - 1];
648 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700649 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
650 $in_comment = 1;
651 }
652 if ($line =~ m@/\*@) {
653 $in_comment = 1;
654 }
655 if (!$in_comment && $current_comment ne '') {
656 $current_comment = '';
657 }
658 $current_comment .= $line . "\n" if ($in_comment);
659 if ($line =~ m@\*/@) {
660 $in_comment = 0;
661 }
662 }
663
664 chomp($current_comment);
665 return($current_comment);
666}
667sub ctx_has_comment {
668 my ($first_line, $end_line) = @_;
669 my $cmt = ctx_locate_comment($first_line, $end_line);
670
Andy Whitcroft00df3442007-06-08 13:47:06 -0700671 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700672 ##print "CMMT: $cmt\n";
673
674 return ($cmt ne '');
675}
676
Andy Whitcroft4d001e42008-10-15 22:02:21 -0700677sub raw_line {
678 my ($linenr, $cnt) = @_;
679
680 my $offset = $linenr - 1;
681 $cnt++;
682
683 my $line;
684 while ($cnt) {
685 $line = $rawlines[$offset++];
686 next if (defined($line) && $line =~ /^-/);
687 $cnt--;
688 }
689
690 return $line;
691}
692
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700693sub cat_vet {
694 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700695 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700696
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700697 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700698 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
699 $res .= $1;
700 if ($2 ne '') {
701 $coded = sprintf("^%c", unpack('C', $2) + 64);
702 $res .= $coded;
703 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700704 }
705 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700706
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700707 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700708}
709
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800710my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800711my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800712my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700713my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800714
715sub annotate_reset {
716 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800717 $av_pending = '_';
718 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700719 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800720}
721
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700722sub annotate_values {
723 my ($stream, $type) = @_;
724
725 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700726 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700727 my $cur = $stream;
728
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800729 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700730
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700731 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700732 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800733 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700734 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700735 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800736 print "WS($1)\n" if ($dbg_values > 1);
737 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800738 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800739 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700740 }
741
Andy Whitcroft8ea3eb92008-07-23 21:29:08 -0700742 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800743 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700744 $type = 'T';
745
Andy Whitcroft389a2fe2008-07-23 21:29:05 -0700746 } elsif ($cur =~ /^($Modifier)\s*/) {
747 print "MODIFIER($1)\n" if ($dbg_values > 1);
748 $type = 'T';
749
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700750 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700751 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800752 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700753 push(@av_paren_type, $type);
754 if ($2 ne '') {
755 $av_pending = 'N';
756 }
757 $type = 'E';
758
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700759 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700760 print "UNDEF($1)\n" if ($dbg_values > 1);
761 $av_preprocessor = 1;
762 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700763
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700764 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800765 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800766 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800767
768 push(@av_paren_type, $type);
769 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700770 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800771
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700772 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800773 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
774 $av_preprocessor = 1;
775
776 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
777
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700778 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800779
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700780 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800781 print "PRE_END($1)\n" if ($dbg_values > 1);
782
783 $av_preprocessor = 1;
784
785 # Assume all arms of the conditional end as this
786 # one does, and continue as if the #endif was not here.
787 pop(@av_paren_type);
788 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700789 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700790
791 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800792 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700793
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700794 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
795 print "ATTR($1)\n" if ($dbg_values > 1);
796 $av_pending = $type;
797 $type = 'N';
798
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700799 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800800 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700801 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800802 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700803 }
804 $type = 'N';
805
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700806 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800807 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700808 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700809 $type = 'N';
810
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700811 } elsif ($cur =~/^(case)/o) {
812 print "CASE($1)\n" if ($dbg_values > 1);
813 $av_pend_colon = 'C';
814 $type = 'N';
815
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700816 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800817 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700818 $type = 'N';
819
820 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800821 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800822 push(@av_paren_type, $av_pending);
823 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700824 $type = 'N';
825
826 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800827 my $new_type = pop(@av_paren_type);
828 if ($new_type ne '_') {
829 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800830 print "PAREN('$1') -> $type\n"
831 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700832 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800833 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700834 }
835
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700836 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800837 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700838 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800839 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700840
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700841 } elsif ($cur =~ /^($Ident\s*):/) {
842 if ($type eq 'E') {
843 $av_pend_colon = 'L';
844 } elsif ($type eq 'T') {
845 $av_pend_colon = 'B';
846 }
847 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
848 $type = 'V';
849
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700850 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800851 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700852 $type = 'V';
853
854 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800855 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700856 $type = 'N';
857
Andy Whitcroftcf655042008-03-04 14:28:20 -0800858 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800859 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800860 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700861 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800862
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700863 } elsif ($cur =~ /^(\?)/o) {
864 print "QUESTION($1)\n" if ($dbg_values > 1);
865 $type = 'N';
866
867 } elsif ($cur =~ /^(:)/o) {
868 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
869
870 substr($var, length($res), 1, $av_pend_colon);
871 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
872 $type = 'E';
873 } else {
874 $type = 'N';
875 }
876 $av_pend_colon = 'O';
877
878 } elsif ($cur =~ /^(;|\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800879 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700880 $type = 'N';
881
Andy Whitcroft0d413862008-10-15 22:02:16 -0700882 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -0700883 my $variant;
884
885 print "OPV($1)\n" if ($dbg_values > 1);
886 if ($type eq 'V') {
887 $variant = 'B';
888 } else {
889 $variant = 'U';
890 }
891
892 substr($var, length($res), 1, $variant);
893 $type = 'N';
894
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700895 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800896 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700897 if ($1 ne '++' && $1 ne '--') {
898 $type = 'N';
899 }
900
901 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800902 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700903 }
904 if (defined $1) {
905 $cur = substr($cur, length($1));
906 $res .= $type x length($1);
907 }
908 }
909
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700910 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700911}
912
Andy Whitcroft8905a672007-11-28 16:21:06 -0800913sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800914 my ($possible, $line) = @_;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800915
Andy Whitcroft0776e592008-10-15 22:02:29 -0700916 print "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
917 if ($possible !~ /(?:
918 ^(?:
919 $Modifier|
920 $Storage|
921 $Type|
922 DEFINE_\S+|
923 goto|
924 return|
925 case|
926 else|
927 asm|__asm__|
928 do
929 )$|
930 ^(?:typedef|struct|enum)\b
931 )/x) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700932 # Check for modifiers.
933 $possible =~ s/\s*$Storage\s*//g;
934 $possible =~ s/\s*$Sparse\s*//g;
935 if ($possible =~ /^\s*$/) {
936
937 } elsif ($possible =~ /\s/) {
938 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -0700939 for my $modifier (split(' ', $possible)) {
940 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
941 push(@modifierList, $modifier);
942 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700943
944 } else {
945 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
946 push(@typeList, $possible);
947 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800948 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -0700949 } else {
950 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800951 }
952}
953
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700954my $prefix = '';
955
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700956sub report {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700957 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
958 return 0;
959 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800960 my $line = $prefix . $_[0];
961
962 $line = (split('\n', $line))[0] . "\n" if ($terse);
963
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800964 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700965
966 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700967}
968sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800969 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700970}
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700971sub ERROR {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700972 if (report("ERROR: $_[0]\n")) {
973 our $clean = 0;
974 our $cnt_error++;
975 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700976}
977sub WARN {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700978 if (report("WARNING: $_[0]\n")) {
979 our $clean = 0;
980 our $cnt_warn++;
981 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700982}
983sub CHK {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700984 if ($check && report("CHECK: $_[0]\n")) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700985 our $clean = 0;
986 our $cnt_chk++;
987 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700988}
989
Andy Whitcroft6ecd9672008-10-15 22:02:21 -0700990sub check_absolute_file {
991 my ($absolute, $herecurr) = @_;
992 my $file = $absolute;
993
994 ##print "absolute<$absolute>\n";
995
996 # See if any suffix of this path is a path within the tree.
997 while ($file =~ s@^[^/]*/@@) {
998 if (-f "$root/$file") {
999 ##print "file<$file>\n";
1000 last;
1001 }
1002 }
1003 if (! -f _) {
1004 return 0;
1005 }
1006
1007 # It is, so see if the prefix is acceptable.
1008 my $prefix = $absolute;
1009 substr($prefix, -length($file)) = '';
1010
1011 ##print "prefix<$prefix>\n";
1012 if ($prefix ne ".../") {
1013 WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr);
1014 }
1015}
1016
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001017sub process {
1018 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001019
1020 my $linenr=0;
1021 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001022 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001023 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001024 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001025
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001026 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001027 my $indent;
1028 my $previndent=0;
1029 my $stashindent=0;
1030
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001031 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001032 my $signoff = 0;
1033 my $is_patch = 0;
1034
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001035 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001036 our $cnt_lines = 0;
1037 our $cnt_error = 0;
1038 our $cnt_warn = 0;
1039 our $cnt_chk = 0;
1040
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001041 # Trace the real file/line as we go.
1042 my $realfile = '';
1043 my $realline = 0;
1044 my $realcnt = 0;
1045 my $here = '';
1046 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001047 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001048 my $first_line = 0;
1049
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001050 my $prev_values = 'E';
1051
1052 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001053 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001054 my %suppress_whiletrailers;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001055
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001056 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001057 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001058 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001059 my @setup_docs = ();
1060 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001061
1062 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001063 my $line;
1064 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001065 $linenr++;
1066 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001067
Andy Whitcroft773647a2008-03-28 14:15:58 -07001068 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001069 $setup_docs = 0;
1070 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1071 $setup_docs = 1;
1072 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001073 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001074 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001075 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1076 $realline=$1-1;
1077 if (defined $2) {
1078 $realcnt=$3+1;
1079 } else {
1080 $realcnt=1+1;
1081 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001082 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001083
1084 # Guestimate if this is a continuing comment. Run
1085 # the context looking for a comment "edge". If this
1086 # edge is a close comment then we must be in a comment
1087 # at context start.
1088 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001089 my $cnt = $realcnt;
1090 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1091 next if (defined $rawlines[$ln - 1] &&
1092 $rawlines[$ln - 1] =~ /^-/);
1093 $cnt--;
1094 #print "RAW<$rawlines[$ln - 1]>\n";
1095 ($edge) = (defined $rawlines[$ln - 1] &&
1096 $rawlines[$ln - 1] =~ m@(/\*|\*/)@);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001097 last if (defined $edge);
1098 }
1099 if (defined $edge && $edge eq '*/') {
1100 $in_comment = 1;
1101 }
1102
1103 # Guestimate if this is a continuing comment. If this
1104 # is the start of a diff block and this line starts
1105 # ' *' then it is very likely a comment.
1106 if (!defined $edge &&
1107 $rawlines[$linenr] =~ m@^.\s* \*(?:\s|$)@)
1108 {
1109 $in_comment = 1;
1110 }
1111
1112 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1113 sanitise_line_reset($in_comment);
1114
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001115 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001116 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001117 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001118 $line = sanitise_line($rawline);
1119 }
1120 push(@lines, $line);
1121
1122 if ($realcnt > 1) {
1123 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1124 } else {
1125 $realcnt = 0;
1126 }
1127
1128 #print "==>$rawline\n";
1129 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001130
1131 if ($setup_docs && $line =~ /^\+/) {
1132 push(@setup_docs, $line);
1133 }
1134 }
1135
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001136 $prefix = '';
1137
Andy Whitcroft773647a2008-03-28 14:15:58 -07001138 $realcnt = 0;
1139 $linenr = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001140 foreach my $line (@lines) {
1141 $linenr++;
1142
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001143 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft306708542008-10-15 22:02:28 -07001144 my $hunk_line = ($realcnt != 0);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001145
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001146#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001147 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001148 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001149 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001150 $realline=$1-1;
1151 if (defined $2) {
1152 $realcnt=$3+1;
1153 } else {
1154 $realcnt=1+1;
1155 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001156 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001157 $prev_values = 'E';
1158
Andy Whitcroft773647a2008-03-28 14:15:58 -07001159 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001160 %suppress_whiletrailers = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001161 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001162
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001163# track the line number as we move through the hunk, note that
1164# new versions of GNU diff omit the leading space on completely
1165# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001166 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001167 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001168 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001169
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001170 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001171 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001172
1173 # Track the previous line.
1174 ($prevline, $stashline) = ($stashline, $line);
1175 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001176 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1177
Andy Whitcroft773647a2008-03-28 14:15:58 -07001178 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001179
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001180 } elsif ($realcnt == 1) {
1181 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001182 }
1183
1184#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001185 $prefix = "$filename:$realline: " if ($emacs && $file);
1186 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1187
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001188 $here = "#$linenr: " if (!$file);
1189 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001190
1191 # extract the filename as it passes
1192 if ($line=~/^\+\+\+\s+(\S+)/) {
1193 $realfile = $1;
1194 $realfile =~ s@^[^/]*/@@;
1195
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001196 if ($realfile =~ m@^include/asm/@) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001197 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1198 }
1199 next;
1200 }
1201
Randy Dunlap389834b2007-06-08 13:47:03 -07001202 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001203
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001204 my $hereline = "$here\n$rawline\n";
1205 my $herecurr = "$here\n$rawline\n";
1206 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001207
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001208 $cnt_lines++ if ($realcnt != 0);
1209
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001210#check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001211 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001212 # This is a signoff, if ugly, so do not double report.
1213 $signoff++;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001214 if (!($line =~ /^\s*Signed-off-by:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001215 WARN("Signed-off-by: is the preferred form\n" .
1216 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001217 }
1218 if ($line =~ /^\s*signed-off-by:\S/i) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001219 WARN("space required after Signed-off-by:\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001220 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001221 }
1222 }
1223
Andy Whitcroft00df3442007-06-08 13:47:06 -07001224# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001225 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001226 ERROR("patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001227 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001228 }
1229
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001230# Check for absolute kernel paths.
1231 if ($tree) {
1232 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1233 my $file = $1;
1234
1235 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1236 check_absolute_file($1, $herecurr)) {
1237 #
1238 } else {
1239 check_absolute_file($file, $herecurr);
1240 }
1241 }
1242 }
1243
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001244# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1245 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001246 $rawline !~ m/^$UTF8*$/) {
1247 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1248
1249 my $blank = copy_spacing($rawline);
1250 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1251 my $hereptr = "$hereline$ptr\n";
1252
1253 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001254 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001255
Andy Whitcroft306708542008-10-15 22:02:28 -07001256# ignore non-hunk lines and lines being removed
1257 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001258
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001259#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001260 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001261 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001262 ERROR("DOS line endings\n" . $herevet);
1263
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001264 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1265 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001266 ERROR("trailing whitespace\n" . $herevet);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001267 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07001268
1269# check we are in a valid source file if not then ignore this hunk
1270 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1271
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001272#80 column limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001273 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001274 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1275 $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1276 $length > 80)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001277 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001278 WARN("line over 80 characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001279 }
1280
Andy Whitcroft8905a672007-11-28 16:21:06 -08001281# check for adding lines without a newline.
1282 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1283 WARN("adding a line without newline at end of file\n" . $herecurr);
1284 }
1285
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001286# check we are in a valid source file C or perl if not then ignore this hunk
1287 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001288
1289# at the beginning of a line any tabs must come first and anything
1290# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001291 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1292 $rawline =~ /^\+\s* \s*/) {
1293 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001294 ERROR("code indent should use tabs where possible\n" . $herevet);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001295 }
1296
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001297# check we are in a valid C source file if not then ignore this hunk
1298 next if ($realfile !~ /\.(h|c)$/);
1299
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001300# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001301 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001302 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1303 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001304
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001305# Check for potential 'bare' types
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001306 my ($stat, $cond, $line_nr_next, $remain_next, $off_next);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001307 if ($realcnt && $line =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001308 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001309 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001310 $stat =~ s/\n./\n /g;
1311 $cond =~ s/\n./\n /g;
1312
1313 my $s = $stat;
1314 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001315
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001316 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001317 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001318
1319 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001320 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001321
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001322 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001323 } 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 -07001324 my $type = $1;
1325 $type =~ s/\s+/ /g;
1326 possible($type, "A:" . $s);
1327
Andy Whitcroft8905a672007-11-28 16:21:06 -08001328 # definitions in global scope can only start with types
Andy Whitcrofta6a84062008-10-15 22:02:30 -07001329 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001330 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001331 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001332
1333 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001334 while ($s =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001335 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001336 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001337
1338 # Check for any sort of function declaration.
1339 # int foo(something bar, other baz);
1340 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001341 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 -08001342 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001343
Andy Whitcroftcf655042008-03-04 14:28:20 -08001344 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001345 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001346 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001347
Andy Whitcroft8905a672007-11-28 16:21:06 -08001348 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001349 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001350
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001351 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001352 }
1353 }
1354 }
1355
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001356 }
1357
Andy Whitcroft653d4872007-06-23 17:16:34 -07001358#
1359# Checks which may be anchored in the context.
1360#
1361
1362# Check for switch () and associated case and default
1363# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07001364 if ($line=~/\bswitch\s*\(.*\)/) {
1365 my $err = '';
1366 my $sep = '';
1367 my @ctx = ctx_block_outer($linenr, $realcnt);
1368 shift(@ctx);
1369 for my $ctx (@ctx) {
1370 my ($clen, $cindent) = line_stats($ctx);
1371 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1372 $indent != $cindent) {
1373 $err .= "$sep$ctx\n";
1374 $sep = '';
1375 } else {
1376 $sep = "[...]\n";
1377 }
1378 }
1379 if ($err ne '') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001380 ERROR("switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001381 }
1382 }
1383
1384# if/while/etc brace do not go on next line, unless defining a do while loop,
1385# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001386 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001387 my $pre_ctx = "$1$2";
1388
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001389 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001390 my $ctx_cnt = $realcnt - $#ctx - 1;
1391 my $ctx = join("\n", @ctx);
1392
Andy Whitcroft548596d2008-07-23 21:29:01 -07001393 my $ctx_ln = $linenr;
1394 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001395
Andy Whitcroft548596d2008-07-23 21:29:01 -07001396 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1397 defined $lines[$ctx_ln - 1] &&
1398 $lines[$ctx_ln - 1] =~ /^-/)) {
1399 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1400 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001401 $ctx_ln++;
1402 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07001403
Andy Whitcroft53210162008-07-23 21:29:03 -07001404 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1405 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001406
1407 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1408 ERROR("that open brace { should be on the previous line\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001409 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07001410 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001411 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1412 $ctx =~ /\)\s*\;\s*$/ &&
1413 defined $lines[$ctx_ln - 1])
1414 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001415 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1416 if ($nindent > $indent) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001417 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001418 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001419 }
1420 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001421 }
1422
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001423# Check relative indent for conditionals and blocks.
1424 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1425 my ($s, $c) = ($stat, $cond);
1426
1427 substr($s, 0, length($c), '');
1428
1429 # Make sure we remove the line prefixes as we have
1430 # none on the first line, and are going to readd them
1431 # where necessary.
1432 $s =~ s/\n./\n/gs;
1433
1434 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07001435 my @newlines = ($c =~ /\n/gs);
1436 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001437
1438 # We want to check the first line inside the block
1439 # starting at the end of the conditional, so remove:
1440 # 1) any blank line termination
1441 # 2) any opening brace { on end of the line
1442 # 3) any do (...) {
1443 my $continuation = 0;
1444 my $check = 0;
1445 $s =~ s/^.*\bdo\b//;
1446 $s =~ s/^\s*{//;
1447 if ($s =~ s/^\s*\\//) {
1448 $continuation = 1;
1449 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001450 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001451 $check = 1;
1452 $cond_lines++;
1453 }
1454
1455 # Also ignore a loop construct at the end of a
1456 # preprocessor statement.
1457 if (($prevline =~ /^.\s*#\s*define\s/ ||
1458 $prevline =~ /\\\s*$/) && $continuation == 0) {
1459 $check = 0;
1460 }
1461
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001462 my $cond_ptr = -1;
1463 while ($cond_ptr != $cond_lines) {
1464 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001465
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001466 # Ignore:
1467 # 1) blank lines, they should be at 0,
1468 # 2) preprocessor lines, and
1469 # 3) labels.
1470 if ($s =~ /^\s*?\n/ ||
1471 $s =~ /^\s*#\s*?/ ||
1472 $s =~ /^\s*$Ident\s*:/) {
1473 $s =~ s/^.*?\n//;
1474 $cond_lines++;
1475 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001476 }
1477
1478 my (undef, $sindent) = line_stats("+" . $s);
1479 my $stat_real = raw_line($linenr, $cond_lines);
1480
1481 # Check if either of these lines are modified, else
1482 # this is not this patch's fault.
1483 if (!defined($stat_real) ||
1484 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1485 $check = 0;
1486 }
1487 if (defined($stat_real) && $cond_lines > 1) {
1488 $stat_real = "[...]\n$stat_real";
1489 }
1490
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001491 #print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s> cond_lines<$cond_lines> stat_real<$stat_real> stat<$stat>\n";
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001492
1493 if ($check && (($sindent % 8) != 0 ||
1494 ($sindent <= $indent && $s ne ''))) {
1495 WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1496 }
1497 }
1498
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001499 # Track the 'values' across context and added lines.
1500 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001501 my ($curr_values, $curr_vars) =
1502 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001503 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001504 if ($dbg_values) {
1505 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001506 print "$linenr > .$outline\n";
1507 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001508 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001509 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001510 $prev_values = substr($curr_values, -1);
1511
Andy Whitcroft00df3442007-06-08 13:47:06 -07001512#ignore lines not being added
1513 if ($line=~/^[^\+]/) {next;}
1514
Andy Whitcroft653d4872007-06-23 17:16:34 -07001515# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07001516 if ($dbg_type) {
1517 if ($line =~ /^.\s*$Declare\s*$/) {
1518 ERROR("TEST: is type\n" . $herecurr);
1519 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1520 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1521 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001522 next;
1523 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001524# TEST: allow direct testing of the attribute matcher.
1525 if ($dbg_attr) {
1526 if ($line =~ /^.\s*$Attribute\s*$/) {
1527 ERROR("TEST: is attr\n" . $herecurr);
1528 } elsif ($dbg_attr > 1 && $line =~ /^.+($Attribute)/) {
1529 ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1530 }
1531 next;
1532 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001533
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001534# check for initialisation to aggregates open brace on the next line
1535 if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1536 $line =~ /^.\s*{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001537 ERROR("that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001538 }
1539
Andy Whitcroft653d4872007-06-23 17:16:34 -07001540#
1541# Checks which are anchored on the added line.
1542#
1543
1544# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001545 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001546 my $path = $1;
1547 if ($path =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001548 ERROR("malformed #include filename\n" .
1549 $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001550 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001551 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001552
1553# no C99 // comments
1554 if ($line =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001555 ERROR("do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001556 }
1557 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001558 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001559 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001560
1561#EXPORT_SYMBOL should immediately follow its function closing }.
Andy Whitcroft653d4872007-06-23 17:16:34 -07001562 if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1563 ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1564 my $name = $1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001565 if (($prevline !~ /^}/) &&
1566 ($prevline !~ /^\+}/) &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001567 ($prevline !~ /^ }/) &&
Andy Whitcroftcf655042008-03-04 14:28:20 -08001568 ($prevline !~ /^.DECLARE_$Ident\(\Q$name\E\)/) &&
1569 ($prevline !~ /^.LIST_HEAD\(\Q$name\E\)/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001570 ($prevline !~ /^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(/) &&
Andy Whitcroftcf655042008-03-04 14:28:20 -08001571 ($prevline !~ /\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001572 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001573 }
1574 }
1575
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001576# check for external initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001577 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001578 ERROR("do not initialise externals to 0 or NULL\n" .
1579 $herecurr);
1580 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001581# check for static initialisers.
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001582 if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001583 ERROR("do not initialise statics to 0 or NULL\n" .
1584 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001585 }
1586
Andy Whitcroft653d4872007-06-23 17:16:34 -07001587# check for new typedefs, only function parameters and sparse annotations
1588# make sense.
1589 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001590 $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001591 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001592 $line !~ /\b__bitwise(?:__|)\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001593 WARN("do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001594 }
1595
1596# * goes on variable not on type
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001597 if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001598 ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" .
1599 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001600
1601 } elsif ($line =~ m{\($NonptrType\s+(\*+)(?!\s+const)\s+\)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001602 ERROR("\"(foo $1 )\" should be \"(foo $1)\"\n" .
1603 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001604
Andy Whitcroft234fff62008-07-23 21:29:12 -07001605 } elsif ($line =~ m{\b$NonptrType(\*+)(?:\s+(?:$Attribute|$Sparse))?\s+[A-Za-z\d_]+}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001606 ERROR("\"foo$1 bar\" should be \"foo $1bar\"\n" .
1607 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001608
Andy Whitcroft234fff62008-07-23 21:29:12 -07001609 } elsif ($line =~ m{\b$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001610 ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" .
1611 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001612 }
1613
1614# # no BUG() or BUG_ON()
1615# if ($line =~ /\b(BUG|BUG_ON)\b/) {
1616# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1617# print "$herecurr";
1618# $clean = 0;
1619# }
1620
Andy Whitcroft8905a672007-11-28 16:21:06 -08001621 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001622 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 -08001623 }
1624
Andy Whitcroft00df3442007-06-08 13:47:06 -07001625# printk should use KERN_* levels. Note that follow on printk's on the
1626# same line do not need a level, so we use the current block context
1627# to try and find and validate the current printk. In summary the current
1628# printk includes all preceeding printk's which have no newline on the end.
1629# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001630 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001631 my $ok = 0;
1632 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1633 #print "CHECK<$lines[$ln - 1]\n";
1634 # we have a preceeding printk if it ends
1635 # with "\n" ignore it, else it is to blame
1636 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1637 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1638 $ok = 1;
1639 }
1640 last;
1641 }
1642 }
1643 if ($ok == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001644 WARN("printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001645 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001646 }
1647
Andy Whitcroft653d4872007-06-23 17:16:34 -07001648# function brace can't be on same line, except for #defines of do while,
1649# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001650 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1651 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001652 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001653 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001654
Andy Whitcroft8905a672007-11-28 16:21:06 -08001655# open braces for enum, union and struct go on the same line.
1656 if ($line =~ /^.\s*{/ &&
1657 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1658 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1659 }
1660
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001661# check for spacing round square brackets; allowed:
1662# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001663# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1664# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001665 while ($line =~ /(.*?\s)\[/g) {
1666 my ($where, $prefix) = ($-[1], $1);
1667 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001668 ($where != 0 || $prefix !~ /^.\s+$/) &&
1669 $prefix !~ /{\s+$/) {
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001670 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1671 }
1672 }
1673
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001674# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001675 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001676 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001677 my $ctx_before = substr($line, 0, $-[1]);
1678 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001679
1680 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001681 if ($name =~ /^(?:
1682 if|for|while|switch|return|case|
1683 volatile|__volatile__|
1684 __attribute__|format|__extension__|
1685 asm|__asm__)$/x)
1686 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001687
1688 # cpp #define statements have non-optional spaces, ie
1689 # if there is a space between the name and the open
1690 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001691 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001692
1693 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001694 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001695
1696 # If this whole things ends with a type its most
1697 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001698 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001699
1700 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001701 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001702 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001703 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001704# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001705 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001706 my $ops = qr{
1707 <<=|>>=|<=|>=|==|!=|
1708 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1709 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001710 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1711 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001712 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001713 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001714 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001715
1716 my $blank = copy_spacing($opline);
1717
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001718 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001719 $off += length($elements[$n]);
1720
Andy Whitcroft773647a2008-03-28 14:15:58 -07001721 # Pick up the preceeding and succeeding characters.
1722 my $ca = substr($opline, 0, $off);
1723 my $cc = '';
1724 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1725 $cc = substr($opline, $off + length($elements[$n + 1]));
1726 }
1727 my $cb = "$ca$;$cc";
1728
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001729 my $a = '';
1730 $a = 'V' if ($elements[$n] ne '');
1731 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001732 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001733 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1734 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07001735 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001736
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001737 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001738
1739 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001740 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001741 $c = 'V' if ($elements[$n + 2] ne '');
1742 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001743 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001744 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1745 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001746 $c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001747 } else {
1748 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001749 }
1750
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001751 my $ctx = "${a}x${c}";
1752
1753 my $at = "(ctx:$ctx)";
1754
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001755 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001756 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001757
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001758 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001759 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001760
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001761 # Get the full operator variant.
1762 my $opv = $op . substr($curr_vars, $off, 1);
1763
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001764 # Ignore operators passed as parameters.
1765 if ($op_type ne 'V' &&
1766 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1767
Andy Whitcroftcf655042008-03-04 14:28:20 -08001768# # Ignore comments
1769# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001770
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001771 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001772 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001773 if ($ctx !~ /.x[WEBC]/ &&
1774 $cc !~ /^\\/ && $cc !~ /^;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001775 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001776 }
1777
1778 # // is a comment
1779 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001780
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001781 # No spaces for:
1782 # ->
1783 # : when part of a bitfield
1784 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001785 if ($ctx =~ /Wx.|.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001786 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001787 }
1788
1789 # , must have a space on the right.
1790 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001791 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001792 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001793 }
1794
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001795 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001796 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001797 #warn "'*' is part of type\n";
1798
1799 # unary operators should have a space before and
1800 # none after. May be left adjacent to another
1801 # unary operator, or a cast
1802 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001803 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07001804 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001805 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001806 ERROR("space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001807 }
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001808 if ($op eq '*' && $cc =~/\s*const\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001809 # A unary '*' may be const
1810
1811 } elsif ($ctx =~ /.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001812 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001813 }
1814
1815 # unary ++ and unary -- are allowed no space on one side.
1816 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001817 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1818 ERROR("space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001819 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001820 if ($ctx =~ /Wx[BE]/ ||
1821 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1822 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001823 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001824 if ($ctx =~ /ExW/) {
1825 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1826 }
1827
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001828
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001829 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001830 } elsif ($op eq '<<' or $op eq '>>' or
1831 $op eq '&' or $op eq '^' or $op eq '|' or
1832 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001833 $op eq '*' or $op eq '/' or
1834 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001835 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001836 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001837 ERROR("need consistent spacing around '$op' $at\n" .
1838 $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001839 }
1840
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001841 # A colon needs no spaces before when it is
1842 # terminating a case value or a label.
1843 } elsif ($opv eq ':C' || $opv eq ':L') {
1844 if ($ctx =~ /Wx./) {
1845 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1846 }
1847
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001848 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08001849 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001850 my $ok = 0;
1851
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001852 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001853 if (($op eq '<' &&
1854 $cc =~ /^\S+\@\S+>/) ||
1855 ($op eq '>' &&
1856 $ca =~ /<\S+\@\S+$/))
1857 {
1858 $ok = 1;
1859 }
1860
1861 # Ignore ?:
1862 if (($opv eq ':O' && $ca =~ /\?$/) ||
1863 ($op eq '?' && $cc =~ /^:/)) {
1864 $ok = 1;
1865 }
1866
1867 if ($ok == 0) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001868 ERROR("spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001869 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001870 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001871 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001872 }
1873 }
1874
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001875# check for multiple assignments
1876 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001877 CHK("multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001878 }
1879
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001880## # check for multiple declarations, allowing for a function declaration
1881## # continuation.
1882## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
1883## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
1884##
1885## # Remove any bracketed sections to ensure we do not
1886## # falsly report the parameters of functions.
1887## my $ln = $line;
1888## while ($ln =~ s/\([^\(\)]*\)//g) {
1889## }
1890## if ($ln =~ /,/) {
1891## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
1892## }
1893## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001894
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001895#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001896 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
1897 $line =~ /do{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001898 ERROR("space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001899 }
1900
1901# closing brace should have a space following it when it has anything
1902# on the line
1903 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001904 ERROR("space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001905 }
1906
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001907# check spacing on square brackets
1908 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001909 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001910 }
1911 if ($line =~ /\s\]/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001912 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001913 }
1914
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001915# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001916 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
1917 $line !~ /for\s*\(\s+;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001918 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001919 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001920 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001921 $line !~ /for\s*\(.*;\s+\)/ &&
1922 $line !~ /:\s+\)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001923 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001924 }
1925
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001926#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001927 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001928 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001929 WARN("labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001930 }
1931
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001932# Return is not a function.
1933 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
1934 my $spacing = $1;
1935 my $value = $2;
1936
1937 # Flatten any parentheses and braces
Andy Whitcroftfee61c42008-07-23 21:28:56 -07001938 $value =~ s/\)\(/\) \(/g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001939 while ($value =~ s/\([^\(\)]*\)/1/) {
1940 }
1941
1942 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
1943 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
1944
1945 } elsif ($spacing !~ /\s+/) {
1946 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1947 }
1948 }
1949
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001950# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001951 if ($line=~/\b(if|while|for|switch)\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001952 ERROR("space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001953 }
1954
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001955# Check for illegal assignment in if conditional -- and check for trailing
1956# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001957 if ($line =~ /do\s*(?!{)/) {
1958 my ($stat_next) = ctx_statement_block($line_nr_next,
1959 $remain_next, $off_next);
1960 $stat_next =~ s/\n./\n /g;
1961 ##print "stat<$stat> stat_next<$stat_next>\n";
1962
1963 if ($stat_next =~ /^\s*while\b/) {
1964 # If the statement carries leading newlines,
1965 # then count those as offsets.
1966 my ($whitespace) =
1967 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
1968 my $offset =
1969 statement_rawlines($whitespace) - 1;
1970
1971 $suppress_whiletrailers{$line_nr_next +
1972 $offset} = 1;
1973 }
1974 }
1975 if (!defined $suppress_whiletrailers{$linenr} &&
1976 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001977 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001978
1979 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001980 ERROR("do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001981 }
1982
1983 # Find out what is on the end of the line after the
1984 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001985 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001986 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001987 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07001988 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
1989 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001990 {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001991 ERROR("trailing statements should be on next line\n" . $herecurr);
1992 }
1993 }
1994
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001995# Check for bitwise tests written as boolean
1996 if ($line =~ /
1997 (?:
1998 (?:\[|\(|\&\&|\|\|)
1999 \s*0[xX][0-9]+\s*
2000 (?:\&\&|\|\|)
2001 |
2002 (?:\&\&|\|\|)
2003 \s*0[xX][0-9]+\s*
2004 (?:\&\&|\|\||\)|\])
2005 )/x)
2006 {
2007 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2008 }
2009
Andy Whitcroft8905a672007-11-28 16:21:06 -08002010# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002011 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2012 my $s = $1;
2013 $s =~ s/$;//g; # Remove any comments
2014 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2015 ERROR("trailing statements should be on next line\n" . $herecurr);
2016 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002017 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002018# case and default should not have general statements after them
2019 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2020 $line !~ /\G(?:
2021 (?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
2022 \s*return\s+
2023 )/xg)
2024 {
2025 ERROR("trailing statements should be on next line\n" . $herecurr);
2026 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002027
2028 # Check for }<nl>else {, these must be at the same
2029 # indent level to be relevant to each other.
2030 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2031 $previndent == $indent) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002032 ERROR("else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002033 }
2034
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002035 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2036 $previndent == $indent) {
2037 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2038
2039 # Find out what is on the end of the line after the
2040 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002041 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002042 $s =~ s/\n.*//g;
2043
2044 if ($s =~ /^\s*;/) {
2045 ERROR("while should follow close brace '}'\n" . $hereprev);
2046 }
2047 }
2048
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002049#studly caps, commented out until figure out how to distinguish between use of existing and adding new
2050# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2051# print "No studly caps, use _\n";
2052# print "$herecurr";
2053# $clean = 0;
2054# }
2055
2056#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002057 if ($line=~/\#\s*define.*\\\s$/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002058 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002059 }
2060
Andy Whitcroft653d4872007-06-23 17:16:34 -07002061#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002062 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002063 my $file = "$1.h";
2064 my $checkfile = "include/linux/$file";
2065 if (-f "$root/$checkfile" &&
2066 $realfile ne $checkfile &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002067 $1 ne 'irq')
2068 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002069 if ($realfile =~ m{^arch/}) {
2070 CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2071 } else {
2072 WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2073 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002074 }
2075 }
2076
Andy Whitcroft653d4872007-06-23 17:16:34 -07002077# multi-statement macros should be enclosed in a do while loop, grab the
2078# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08002079# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07002080 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2081 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002082 my $ln = $linenr;
2083 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002084 my ($off, $dstat, $dcond, $rest);
2085 my $ctx = '';
Andy Whitcroft653d4872007-06-23 17:16:34 -07002086
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002087 my $args = defined($1);
2088
2089 # Find the end of the macro and limit our statement
2090 # search to that.
2091 while ($cnt > 0 && defined $lines[$ln - 1] &&
2092 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2093 {
2094 $ctx .= $rawlines[$ln - 1] . "\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002095 $cnt-- if ($lines[$ln - 1] !~ /^-/);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002096 $ln++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002097 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002098 $ctx .= $rawlines[$ln - 1];
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002099
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002100 ($dstat, $dcond, $ln, $cnt, $off) =
2101 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2102 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002103 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002104
2105 # Extract the remainder of the define (if any) and
2106 # rip off surrounding spaces, and trailing \'s.
2107 $rest = '';
Andy Whitcroft636d1402008-10-15 22:02:18 -07002108 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2109 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002110 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2111 $rest .= substr($lines[$ln - 1], $off) . "\n";
2112 $cnt--;
2113 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002114 $ln++;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002115 $off = 0;
2116 }
2117 $rest =~ s/\\\n.//g;
2118 $rest =~ s/^\s*//s;
2119 $rest =~ s/\s*$//s;
2120
2121 # Clean up the original statement.
2122 if ($args) {
2123 substr($dstat, 0, length($dcond), '');
2124 } else {
2125 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2126 }
Andy Whitcroft292f1a92008-07-23 21:29:11 -07002127 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002128 $dstat =~ s/\\\n.//g;
2129 $dstat =~ s/^\s*//s;
2130 $dstat =~ s/\s*$//s;
2131
2132 # Flatten any parentheses and braces
2133 while ($dstat =~ s/\([^\(\)]*\)/1/) {
2134 }
2135 while ($dstat =~ s/\{[^\{\}]*\}/1/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002136 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002137
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002138 my $exceptions = qr{
2139 $Declare|
2140 module_param_named|
2141 MODULE_PARAM_DESC|
2142 DECLARE_PER_CPU|
2143 DEFINE_PER_CPU|
2144 __typeof__\(
2145 }x;
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002146 #print "REST<$rest>\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002147 if ($rest ne '') {
2148 if ($rest !~ /while\s*\(/ &&
2149 $dstat !~ /$exceptions/)
2150 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002151 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 -07002152 }
2153
2154 } elsif ($ctx !~ /;/) {
2155 if ($dstat ne '' &&
2156 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2157 $dstat !~ /$exceptions/ &&
2158 $dstat =~ /$Operators/)
2159 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002160 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002161 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002162 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002163 }
2164
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002165# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002166 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2167 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08002168 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002169 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002170 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2171 if ($#chunks > 0 && $level == 0) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002172 my $allowed = 0;
2173 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002174 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002175 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002176 for my $chunk (@chunks) {
2177 my ($cond, $block) = @{$chunk};
2178
Andy Whitcroft773647a2008-03-28 14:15:58 -07002179 # If the condition carries leading newlines, then count those as offsets.
2180 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2181 my $offset = statement_rawlines($whitespace) - 1;
2182
2183 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2184
2185 # We have looked at and allowed this specific line.
2186 $suppress_ifbraces{$ln + $offset} = 1;
2187
2188 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002189 $ln += statement_rawlines($block) - 1;
2190
Andy Whitcroft773647a2008-03-28 14:15:58 -07002191 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002192
2193 $seen++ if ($block =~ /^\s*{/);
2194
Andy Whitcroftcf655042008-03-04 14:28:20 -08002195 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2196 if (statement_lines($cond) > 1) {
2197 #print "APW: ALLOWED: cond<$cond>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002198 $allowed = 1;
2199 }
2200 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002201 #print "APW: ALLOWED: block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002202 $allowed = 1;
2203 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002204 if (statement_block_size($block) > 1) {
2205 #print "APW: ALLOWED: lines block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002206 $allowed = 1;
2207 }
2208 }
2209 if ($seen && !$allowed) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002210 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002211 }
2212 }
2213 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002214 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002215 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002216 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002217
Andy Whitcroftcf655042008-03-04 14:28:20 -08002218 # Check the pre-context.
2219 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2220 #print "APW: ALLOWED: pre<$1>\n";
2221 $allowed = 1;
2222 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002223
2224 my ($level, $endln, @chunks) =
2225 ctx_statement_full($linenr, $realcnt, $-[0]);
2226
Andy Whitcroftcf655042008-03-04 14:28:20 -08002227 # Check the condition.
2228 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07002229 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002230 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002231 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08002232 }
2233 if (statement_lines($cond) > 1) {
2234 #print "APW: ALLOWED: cond<$cond>\n";
2235 $allowed = 1;
2236 }
2237 if ($block =~/\b(?:if|for|while)\b/) {
2238 #print "APW: ALLOWED: block<$block>\n";
2239 $allowed = 1;
2240 }
2241 if (statement_block_size($block) > 1) {
2242 #print "APW: ALLOWED: lines block<$block>\n";
2243 $allowed = 1;
2244 }
2245 # Check the post-context.
2246 if (defined $chunks[1]) {
2247 my ($cond, $block) = @{$chunks[1]};
2248 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002249 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002250 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002251 if ($block =~ /^\s*\{/) {
2252 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2253 $allowed = 1;
2254 }
2255 }
2256 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2257 my $herectx = $here . "\n";;
Andy Whitcroftf0556632008-10-15 22:02:23 -07002258 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002259
Andy Whitcroftf0556632008-10-15 22:02:23 -07002260 for (my $n = 0; $n < $cnt; $n++) {
2261 $herectx .= raw_line($linenr, $n) . "\n";;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002262 }
2263
2264 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002265 }
2266 }
2267
Andy Whitcroft653d4872007-06-23 17:16:34 -07002268# don't include deprecated include files (uses RAW line)
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002269 for my $inc (@dep_includes) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002270 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002271 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002272 }
2273 }
2274
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002275# don't use deprecated functions
2276 for my $func (@dep_functions) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002277 if ($line =~ /\b$func\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002278 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002279 }
2280 }
2281
2282# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002283 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2284 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002285 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002286 }
2287
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002288# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2289 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2290 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2291 }
2292
Andy Whitcroft00df3442007-06-08 13:47:06 -07002293# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002294 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002295 CHK("if this code is redundant consider removing it\n" .
2296 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002297 }
2298
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002299# check for needless kfree() checks
2300 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2301 my $expr = $1;
2302 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
Wolfram Sang3c232142008-07-23 21:29:05 -07002303 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002304 }
2305 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07002306# check for needless usb_free_urb() checks
2307 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2308 my $expr = $1;
2309 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2310 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2311 }
2312 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002313
Andy Whitcroft00df3442007-06-08 13:47:06 -07002314# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002315# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002316# print "#ifdef in C files should be avoided\n";
2317# print "$herecurr";
2318# $clean = 0;
2319# }
2320
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002321# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002322 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002323 ERROR("exactly one space required after that #$1\n" . $herecurr);
2324 }
2325
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002326# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002327 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2328 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002329 my $which = $1;
2330 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002331 CHK("$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002332 }
2333 }
2334# check for memory barriers without a comment.
2335 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2336 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002337 CHK("memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002338 }
2339 }
2340# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002341 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002342 CHK("architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002343 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002344
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002345# check the location of the inline attribute, that it is between
2346# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002347 if ($line =~ /\b$Type\s+$Inline\b/ ||
2348 $line =~ /\b$Inline\s+$Storage\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002349 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2350 }
2351
Andy Whitcroft8905a672007-11-28 16:21:06 -08002352# Check for __inline__ and __inline, prefer inline
2353 if ($line =~ /\b(__inline__|__inline)\b/) {
2354 WARN("plain inline is preferred over $1\n" . $herecurr);
2355 }
2356
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002357# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002358 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002359 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002360 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002361 my $function_name = $1;
2362 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002363
2364 my $s = $stat;
2365 if (defined $cond) {
2366 substr($s, 0, length($cond), '');
2367 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002368 if ($s =~ /^\s*;/ &&
2369 $function_name ne 'uninitialized_var')
2370 {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002371 WARN("externs should be avoided in .c files\n" . $herecurr);
2372 }
2373
2374 if ($paren_space =~ /\n/) {
2375 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2376 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002377
2378 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2379 $stat =~ /^.\s*extern\s+/)
2380 {
2381 WARN("externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002382 }
2383
2384# checks for new __setup's
2385 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2386 my $name = $1;
2387
2388 if (!grep(/$name/, @setup_docs)) {
2389 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2390 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002391 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002392
2393# check for pointless casting of kmalloc return
2394 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2395 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2396 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002397
2398# check for gcc specific __FUNCTION__
2399 if ($line =~ /__FUNCTION__/) {
2400 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2401 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002402
2403# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002404 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002405 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2406 }
2407# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002408 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002409 WARN("consider using a completion\n" . $herecurr);
2410 }
2411# recommend strict_strto* over simple_strto*
2412 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2413 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2414 }
Michael Ellermanf3db6632008-07-23 21:28:57 -07002415# check for __initcall(), use device_initcall() explicitly please
2416 if ($line =~ /^.\s*__initcall\s*\(/) {
2417 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2418 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002419
2420# use of NR_CPUS is usually wrong
2421# ignore definitions of NR_CPUS and usage to define arrays as likely right
2422 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002423 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2424 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002425 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2426 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2427 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002428 {
2429 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2430 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002431
2432# check for %L{u,d,i} in strings
2433 my $string;
2434 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2435 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07002436 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002437 if ($string =~ /(?<!%)%L[udi]/) {
2438 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2439 last;
2440 }
2441 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002442 }
2443
2444 # If we have no input at all, then there is nothing to report on
2445 # so just keep quiet.
2446 if ($#rawlines == -1) {
2447 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002448 }
2449
Andy Whitcroft8905a672007-11-28 16:21:06 -08002450 # In mailback mode only produce a report in the negative, for
2451 # things that appear to be patches.
2452 if ($mailback && ($clean == 1 || !$is_patch)) {
2453 exit(0);
2454 }
2455
2456 # This is not a patch, and we are are in 'no-patch' mode so
2457 # just keep quiet.
2458 if (!$chk_patch && !$is_patch) {
2459 exit(0);
2460 }
2461
2462 if (!$is_patch) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002463 ERROR("Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002464 }
2465 if ($is_patch && $chk_signoff && $signoff == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002466 ERROR("Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002467 }
2468
Andy Whitcroft8905a672007-11-28 16:21:06 -08002469 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002470 if ($summary && !($clean == 1 && $quiet == 1)) {
2471 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002472 print "total: $cnt_error errors, $cnt_warn warnings, " .
2473 (($check)? "$cnt_chk checks, " : "") .
2474 "$cnt_lines lines checked\n";
2475 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002476 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002477
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002478 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002479 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002480 }
2481 if ($clean == 0 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002482 print "$vname has style problems, please review. If any of these errors\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002483 print "are false positives report them to the maintainer, see\n";
2484 print "CHECKPATCH in MAINTAINERS.\n";
2485 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002486
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002487 return $clean;
2488}