blob: ba677c17c3345126fd450b6587e15082e9b8a624 [file] [log] [blame]
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001#!/usr/bin/perl -w
2# (c) 2001, Dave Jones. <davej@codemonkey.org.uk> (the file handling bit)
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004# (c) 2007, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite, etc)
5# Licensed under the terms of the GNU GPL License version 2
6
7use strict;
8
9my $P = $0;
Andy Whitcroft00df344f2007-06-08 13:47:06 -070010$P =~ s@.*/@@g;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070011
Andy Whitcroft33cba062008-07-23 21:29:12 -070012my $V = '0.21';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070013
14use Getopt::Long qw(:config no_auto_abbrev);
15
16my $quiet = 0;
17my $tree = 1;
18my $chk_signoff = 1;
19my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070020my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070021my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080022my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070023my $file = 0;
24my $check = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080025my $summary = 1;
26my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080027my $summary_file = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070028my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080029my %debug;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070030GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070031 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070032 'tree!' => \$tree,
33 'signoff!' => \$chk_signoff,
34 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070035 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -080036 'terse!' => \$terse,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070037 'file!' => \$file,
38 'subjective!' => \$check,
39 'strict!' => \$check,
40 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -080041 'summary!' => \$summary,
42 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -080043 'summary-file!' => \$summary_file,
44
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080045 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -070046 'test-only=s' => \$tst_only,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070047) or exit;
48
49my $exit = 0;
50
51if ($#ARGV < 0) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -070052 print "usage: $P [options] patchfile\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070053 print "version: $V\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -080054 print "options: -q => quiet\n";
55 print " --no-tree => run without a kernel tree\n";
56 print " --terse => one line per report\n";
57 print " --emacs => emacs compile window format\n";
58 print " --file => check a source file\n";
59 print " --strict => enable more subjective tests\n";
60 print " --root => path to the kernel tree root\n";
61 print " --no-summary => suppress the per-file summary\n";
62 print " --summary-file => include the filename in summary\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070063 exit(1);
64}
65
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080066my $dbg_values = 0;
67my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -070068my $dbg_type = 0;
Andy 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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -0700213 }
214 }
215}
216
Andy Whitcroft00df344f2007-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -0700260 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700261 return 1;
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Whitcroft00df344f2007-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 Whitcroft00df344f2007-06-08 13:47:06 -0700322
Andy Whitcroft773647a2008-03-28 14:15:58 -0700323 # Always copy over the diff marker.
324 $res = substr($line, 0, 1);
325
326 for ($off = 1; $off < length($line); $off++) {
327 $c = substr($line, $off, 1);
328
329 # Comments we are wacking completly including the begin
330 # and end, all to $;.
331 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
332 $sanitise_quote = '*/';
333
334 substr($res, $off, 2, "$;$;");
335 $off++;
336 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800337 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700338 if (substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700339 $sanitise_quote = '';
340 substr($res, $off, 2, "$;$;");
341 $off++;
342 next;
343 }
344
345 # A \ in a string means ignore the next character.
346 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
347 $c eq "\\") {
348 substr($res, $off, 2, 'XX');
349 $off++;
350 next;
351 }
352 # Regular quotes.
353 if ($c eq "'" || $c eq '"') {
354 if ($sanitise_quote eq '') {
355 $sanitise_quote = $c;
356
357 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700358 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700359 } elsif ($sanitise_quote eq $c) {
360 $sanitise_quote = '';
Andy Whitcroft00df344f2007-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 Whitcroft00df344f2007-06-08 13:47:06 -0700369 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700370 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-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 Whitcroft00df344f2007-06-08 13:47:06 -0700385 return $res;
386}
387
Andy Whitcroft8905a672007-11-28 16:21:06 -0800388sub ctx_statement_block {
389 my ($linenr, $remain, $off) = @_;
390 my $line = $linenr - 1;
391 my $blk = '';
392 my $soff = $off;
393 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700394 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800395
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800396 my $loff = 0;
397
Andy Whitcroft8905a672007-11-28 16:21:06 -0800398 my $type = '';
399 my $level = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800400 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800401 my $c;
402 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800403
404 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800405 while (1) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700406 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800407 # If we are about to drop off the end, pull in more
408 # context.
409 if ($off >= $len) {
410 for (; $remain > 0; $line++) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800411 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800412 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800413 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800414 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800415 $len = length($blk);
416 $line++;
417 last;
418 }
419 # Bail if there is no further context.
420 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800421 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800422 last;
423 }
424 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800425 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800426 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800427 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800428
Andy Whitcroft773647a2008-03-28 14:15:58 -0700429 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800430 # Statement ends at the ';' or a close '}' at the
431 # outermost level.
432 if ($level == 0 && $c eq ';') {
433 last;
434 }
435
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800436 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700437 if ($level == 0 && $coff_set == 0 &&
438 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
439 $remainder =~ /^(else)(?:\s|{)/ &&
440 $remainder !~ /^else\s+if\b/) {
441 $coff = $off + length($1) - 1;
442 $coff_set = 1;
443 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
444 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800445 }
446
Andy Whitcroft8905a672007-11-28 16:21:06 -0800447 if (($type eq '' || $type eq '(') && $c eq '(') {
448 $level++;
449 $type = '(';
450 }
451 if ($type eq '(' && $c eq ')') {
452 $level--;
453 $type = ($level != 0)? '(' : '';
454
455 if ($level == 0 && $coff < $soff) {
456 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700457 $coff_set = 1;
458 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800459 }
460 }
461 if (($type eq '' || $type eq '{') && $c eq '{') {
462 $level++;
463 $type = '{';
464 }
465 if ($type eq '{' && $c eq '}') {
466 $level--;
467 $type = ($level != 0)? '{' : '';
468
469 if ($level == 0) {
470 last;
471 }
472 }
473 $off++;
474 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700475 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800476 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700477 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800478 $line++;
479 $remain--;
480 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800481
482 my $statement = substr($blk, $soff, $off - $soff + 1);
483 my $condition = substr($blk, $soff, $coff - $soff + 1);
484
485 #warn "STATEMENT<$statement>\n";
486 #warn "CONDITION<$condition>\n";
487
Andy Whitcroft773647a2008-03-28 14:15:58 -0700488 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800489
490 return ($statement, $condition,
491 $line, $remain + 1, $off - $loff + 1, $level);
492}
493
Andy Whitcroftcf655042008-03-04 14:28:20 -0800494sub statement_lines {
495 my ($stmt) = @_;
496
497 # Strip the diff line prefixes and rip blank lines at start and end.
498 $stmt =~ s/(^|\n)./$1/g;
499 $stmt =~ s/^\s*//;
500 $stmt =~ s/\s*$//;
501
502 my @stmt_lines = ($stmt =~ /\n/g);
503
504 return $#stmt_lines + 2;
505}
506
507sub statement_rawlines {
508 my ($stmt) = @_;
509
510 my @stmt_lines = ($stmt =~ /\n/g);
511
512 return $#stmt_lines + 2;
513}
514
515sub statement_block_size {
516 my ($stmt) = @_;
517
518 $stmt =~ s/(^|\n)./$1/g;
519 $stmt =~ s/^\s*{//;
520 $stmt =~ s/}\s*$//;
521 $stmt =~ s/^\s*//;
522 $stmt =~ s/\s*$//;
523
524 my @stmt_lines = ($stmt =~ /\n/g);
525 my @stmt_statements = ($stmt =~ /;/g);
526
527 my $stmt_lines = $#stmt_lines + 2;
528 my $stmt_statements = $#stmt_statements + 1;
529
530 if ($stmt_lines > $stmt_statements) {
531 return $stmt_lines;
532 } else {
533 return $stmt_statements;
534 }
535}
536
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800537sub ctx_statement_full {
538 my ($linenr, $remain, $off) = @_;
539 my ($statement, $condition, $level);
540
541 my (@chunks);
542
Andy Whitcroftcf655042008-03-04 14:28:20 -0800543 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800544 ($statement, $condition, $linenr, $remain, $off, $level) =
545 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700546 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800547 push(@chunks, [ $condition, $statement ]);
548 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
549 return ($level, $linenr, @chunks);
550 }
551
552 # Pull in the following conditional/block pairs and see if they
553 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800554 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800555 ($statement, $condition, $linenr, $remain, $off, $level) =
556 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800557 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700558 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800559 #print "C: push\n";
560 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800561 }
562
563 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800564}
565
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700566sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700567 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700568 my $line;
569 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700570 my $blk = '';
571 my @o;
572 my @c;
573 my @res = ();
574
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700575 my $level = 0;
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700576 for ($line = $start; $remain > 0; $line++) {
577 next if ($rawlines[$line] =~ /^-/);
578 $remain--;
579
580 $blk .= $rawlines[$line];
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700581 foreach my $c (split(//, $rawlines[$line])) {
582 ##print "C<$c>L<$level><$open$close>O<$off>\n";
583 if ($off > 0) {
584 $off--;
585 next;
586 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700587
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700588 if ($c eq $close && $level > 0) {
589 $level--;
590 last if ($level == 0);
591 } elsif ($c eq $open) {
592 $level++;
593 }
594 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700595
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700596 if (!$outer || $level <= 1) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700597 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700598 }
599
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700600 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700601 }
602
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700603 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700604}
605sub ctx_block_outer {
606 my ($linenr, $remain) = @_;
607
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700608 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
609 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700610}
611sub ctx_block {
612 my ($linenr, $remain) = @_;
613
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700614 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
615 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700616}
617sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700618 my ($linenr, $remain, $off) = @_;
619
620 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
621 return @r;
622}
623sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700624 my ($linenr, $remain) = @_;
625
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700626 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700627}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700628sub ctx_statement_level {
629 my ($linenr, $remain, $off) = @_;
630
631 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
632}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700633
634sub ctx_locate_comment {
635 my ($first_line, $end_line) = @_;
636
637 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700638 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700639 return $current_comment if (defined $current_comment);
640
641 # Look through the context and try and figure out if there is a
642 # comment.
643 my $in_comment = 0;
644 $current_comment = '';
645 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700646 my $line = $rawlines[$linenr - 1];
647 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700648 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
649 $in_comment = 1;
650 }
651 if ($line =~ m@/\*@) {
652 $in_comment = 1;
653 }
654 if (!$in_comment && $current_comment ne '') {
655 $current_comment = '';
656 }
657 $current_comment .= $line . "\n" if ($in_comment);
658 if ($line =~ m@\*/@) {
659 $in_comment = 0;
660 }
661 }
662
663 chomp($current_comment);
664 return($current_comment);
665}
666sub ctx_has_comment {
667 my ($first_line, $end_line) = @_;
668 my $cmt = ctx_locate_comment($first_line, $end_line);
669
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700670 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700671 ##print "CMMT: $cmt\n";
672
673 return ($cmt ne '');
674}
675
Andy Whitcroft4d001e42008-10-15 22:02:21 -0700676sub raw_line {
677 my ($linenr, $cnt) = @_;
678
679 my $offset = $linenr - 1;
680 $cnt++;
681
682 my $line;
683 while ($cnt) {
684 $line = $rawlines[$offset++];
685 next if (defined($line) && $line =~ /^-/);
686 $cnt--;
687 }
688
689 return $line;
690}
691
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700692sub cat_vet {
693 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700694 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700695
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700696 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700697 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
698 $res .= $1;
699 if ($2 ne '') {
700 $coded = sprintf("^%c", unpack('C', $2) + 64);
701 $res .= $coded;
702 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700703 }
704 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700705
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700706 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700707}
708
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800709my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800710my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800711my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700712my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800713
714sub annotate_reset {
715 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800716 $av_pending = '_';
717 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700718 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800719}
720
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700721sub annotate_values {
722 my ($stream, $type) = @_;
723
724 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700725 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700726 my $cur = $stream;
727
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800728 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700729
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700730 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700731 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800732 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700733 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700734 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800735 print "WS($1)\n" if ($dbg_values > 1);
736 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800737 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800738 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700739 }
740
Andy Whitcroft8ea3eb92008-07-23 21:29:08 -0700741 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800742 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700743 $type = 'T';
744
Andy Whitcroft389a2fe2008-07-23 21:29:05 -0700745 } elsif ($cur =~ /^($Modifier)\s*/) {
746 print "MODIFIER($1)\n" if ($dbg_values > 1);
747 $type = 'T';
748
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700749 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700750 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800751 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700752 push(@av_paren_type, $type);
753 if ($2 ne '') {
754 $av_pending = 'N';
755 }
756 $type = 'E';
757
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700758 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700759 print "UNDEF($1)\n" if ($dbg_values > 1);
760 $av_preprocessor = 1;
761 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700762
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700763 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800764 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800765 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800766
767 push(@av_paren_type, $type);
768 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700769 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800770
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700771 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800772 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
773 $av_preprocessor = 1;
774
775 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
776
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700777 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800778
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700779 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800780 print "PRE_END($1)\n" if ($dbg_values > 1);
781
782 $av_preprocessor = 1;
783
784 # Assume all arms of the conditional end as this
785 # one does, and continue as if the #endif was not here.
786 pop(@av_paren_type);
787 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700788 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700789
790 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800791 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700792
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700793 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
794 print "ATTR($1)\n" if ($dbg_values > 1);
795 $av_pending = $type;
796 $type = 'N';
797
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700798 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800799 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700800 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800801 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700802 }
803 $type = 'N';
804
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700805 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800806 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700807 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700808 $type = 'N';
809
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700810 } elsif ($cur =~/^(case)/o) {
811 print "CASE($1)\n" if ($dbg_values > 1);
812 $av_pend_colon = 'C';
813 $type = 'N';
814
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700815 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800816 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700817 $type = 'N';
818
819 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800820 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800821 push(@av_paren_type, $av_pending);
822 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700823 $type = 'N';
824
825 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800826 my $new_type = pop(@av_paren_type);
827 if ($new_type ne '_') {
828 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800829 print "PAREN('$1') -> $type\n"
830 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700831 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800832 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700833 }
834
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700835 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800836 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700837 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800838 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700839
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700840 } elsif ($cur =~ /^($Ident\s*):/) {
841 if ($type eq 'E') {
842 $av_pend_colon = 'L';
843 } elsif ($type eq 'T') {
844 $av_pend_colon = 'B';
845 }
846 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
847 $type = 'V';
848
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700849 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800850 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700851 $type = 'V';
852
853 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800854 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700855 $type = 'N';
856
Andy Whitcroftcf655042008-03-04 14:28:20 -0800857 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800858 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800859 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700860 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800861
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700862 } elsif ($cur =~ /^(\?)/o) {
863 print "QUESTION($1)\n" if ($dbg_values > 1);
864 $type = 'N';
865
866 } elsif ($cur =~ /^(:)/o) {
867 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
868
869 substr($var, length($res), 1, $av_pend_colon);
870 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
871 $type = 'E';
872 } else {
873 $type = 'N';
874 }
875 $av_pend_colon = 'O';
876
877 } elsif ($cur =~ /^(;|\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800878 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700879 $type = 'N';
880
Andy Whitcroft0d413862008-10-15 22:02:16 -0700881 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -0700882 my $variant;
883
884 print "OPV($1)\n" if ($dbg_values > 1);
885 if ($type eq 'V') {
886 $variant = 'B';
887 } else {
888 $variant = 'U';
889 }
890
891 substr($var, length($res), 1, $variant);
892 $type = 'N';
893
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700894 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800895 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700896 if ($1 ne '++' && $1 ne '--') {
897 $type = 'N';
898 }
899
900 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800901 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700902 }
903 if (defined $1) {
904 $cur = substr($cur, length($1));
905 $res .= $type x length($1);
906 }
907 }
908
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700909 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700910}
911
Andy Whitcroft8905a672007-11-28 16:21:06 -0800912sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800913 my ($possible, $line) = @_;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800914
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700915 print "CHECK<$possible> ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft0221f552008-07-23 21:29:08 -0700916 if ($possible !~ /^(?:$Modifier|$Storage|$Type|DEFINE_\S+)$/ &&
Andy Whitcroft8905a672007-11-28 16:21:06 -0800917 $possible ne 'goto' && $possible ne 'return' &&
Andy Whitcroft8905a672007-11-28 16:21:06 -0800918 $possible ne 'case' && $possible ne 'else' &&
Andy Whitcroftd3ddcf42008-07-23 21:28:58 -0700919 $possible ne 'asm' && $possible ne '__asm__' &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700920 $possible !~ /^(typedef|struct|enum)\b/) {
921 # Check for modifiers.
922 $possible =~ s/\s*$Storage\s*//g;
923 $possible =~ s/\s*$Sparse\s*//g;
924 if ($possible =~ /^\s*$/) {
925
926 } elsif ($possible =~ /\s/) {
927 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -0700928 for my $modifier (split(' ', $possible)) {
929 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
930 push(@modifierList, $modifier);
931 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700932
933 } else {
934 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
935 push(@typeList, $possible);
936 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800937 build_types();
938 }
939}
940
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700941my $prefix = '';
942
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700943sub report {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700944 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
945 return 0;
946 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800947 my $line = $prefix . $_[0];
948
949 $line = (split('\n', $line))[0] . "\n" if ($terse);
950
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800951 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700952
953 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700954}
955sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800956 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700957}
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700958sub ERROR {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700959 if (report("ERROR: $_[0]\n")) {
960 our $clean = 0;
961 our $cnt_error++;
962 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700963}
964sub WARN {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700965 if (report("WARNING: $_[0]\n")) {
966 our $clean = 0;
967 our $cnt_warn++;
968 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700969}
970sub CHK {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700971 if ($check && report("CHECK: $_[0]\n")) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700972 our $clean = 0;
973 our $cnt_chk++;
974 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700975}
976
Andy Whitcroft6ecd9672008-10-15 22:02:21 -0700977sub check_absolute_file {
978 my ($absolute, $herecurr) = @_;
979 my $file = $absolute;
980
981 ##print "absolute<$absolute>\n";
982
983 # See if any suffix of this path is a path within the tree.
984 while ($file =~ s@^[^/]*/@@) {
985 if (-f "$root/$file") {
986 ##print "file<$file>\n";
987 last;
988 }
989 }
990 if (! -f _) {
991 return 0;
992 }
993
994 # It is, so see if the prefix is acceptable.
995 my $prefix = $absolute;
996 substr($prefix, -length($file)) = '';
997
998 ##print "prefix<$prefix>\n";
999 if ($prefix ne ".../") {
1000 WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr);
1001 }
1002}
1003
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001004sub process {
1005 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001006
1007 my $linenr=0;
1008 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001009 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001010 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001011 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001012
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001013 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001014 my $indent;
1015 my $previndent=0;
1016 my $stashindent=0;
1017
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001018 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001019 my $signoff = 0;
1020 my $is_patch = 0;
1021
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001022 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001023 our $cnt_lines = 0;
1024 our $cnt_error = 0;
1025 our $cnt_warn = 0;
1026 our $cnt_chk = 0;
1027
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001028 # Trace the real file/line as we go.
1029 my $realfile = '';
1030 my $realline = 0;
1031 my $realcnt = 0;
1032 my $here = '';
1033 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001034 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001035 my $first_line = 0;
1036
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001037 my $prev_values = 'E';
1038
1039 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001040 my %suppress_ifbraces;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001041
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001042 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001043 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001044 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001045 my @setup_docs = ();
1046 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001047
1048 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001049 my $line;
1050 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001051 $linenr++;
1052 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001053
Andy Whitcroft773647a2008-03-28 14:15:58 -07001054 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001055 $setup_docs = 0;
1056 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1057 $setup_docs = 1;
1058 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001059 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001060 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001061 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1062 $realline=$1-1;
1063 if (defined $2) {
1064 $realcnt=$3+1;
1065 } else {
1066 $realcnt=1+1;
1067 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001068 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001069
1070 # Guestimate if this is a continuing comment. Run
1071 # the context looking for a comment "edge". If this
1072 # edge is a close comment then we must be in a comment
1073 # at context start.
1074 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001075 my $cnt = $realcnt;
1076 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1077 next if (defined $rawlines[$ln - 1] &&
1078 $rawlines[$ln - 1] =~ /^-/);
1079 $cnt--;
1080 #print "RAW<$rawlines[$ln - 1]>\n";
1081 ($edge) = (defined $rawlines[$ln - 1] &&
1082 $rawlines[$ln - 1] =~ m@(/\*|\*/)@);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001083 last if (defined $edge);
1084 }
1085 if (defined $edge && $edge eq '*/') {
1086 $in_comment = 1;
1087 }
1088
1089 # Guestimate if this is a continuing comment. If this
1090 # is the start of a diff block and this line starts
1091 # ' *' then it is very likely a comment.
1092 if (!defined $edge &&
1093 $rawlines[$linenr] =~ m@^.\s* \*(?:\s|$)@)
1094 {
1095 $in_comment = 1;
1096 }
1097
1098 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1099 sanitise_line_reset($in_comment);
1100
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001101 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001102 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001103 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001104 $line = sanitise_line($rawline);
1105 }
1106 push(@lines, $line);
1107
1108 if ($realcnt > 1) {
1109 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1110 } else {
1111 $realcnt = 0;
1112 }
1113
1114 #print "==>$rawline\n";
1115 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001116
1117 if ($setup_docs && $line =~ /^\+/) {
1118 push(@setup_docs, $line);
1119 }
1120 }
1121
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001122 $prefix = '';
1123
Andy Whitcroft773647a2008-03-28 14:15:58 -07001124 $realcnt = 0;
1125 $linenr = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001126 foreach my $line (@lines) {
1127 $linenr++;
1128
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001129 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001130
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001131#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001132 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001133 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001134 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001135 $realline=$1-1;
1136 if (defined $2) {
1137 $realcnt=$3+1;
1138 } else {
1139 $realcnt=1+1;
1140 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001141 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001142 $prev_values = 'E';
1143
Andy Whitcroft773647a2008-03-28 14:15:58 -07001144 %suppress_ifbraces = ();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001145 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001146
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001147# track the line number as we move through the hunk, note that
1148# new versions of GNU diff omit the leading space on completely
1149# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001150 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001151 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001152 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001153
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001154 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001155 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001156
1157 # Track the previous line.
1158 ($prevline, $stashline) = ($stashline, $line);
1159 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001160 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1161
Andy Whitcroft773647a2008-03-28 14:15:58 -07001162 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001163
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001164 } elsif ($realcnt == 1) {
1165 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001166 }
1167
1168#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001169 $prefix = "$filename:$realline: " if ($emacs && $file);
1170 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1171
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001172 $here = "#$linenr: " if (!$file);
1173 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001174
1175 # extract the filename as it passes
1176 if ($line=~/^\+\+\+\s+(\S+)/) {
1177 $realfile = $1;
1178 $realfile =~ s@^[^/]*/@@;
1179
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001180 if ($realfile =~ m@^include/asm/@) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001181 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1182 }
1183 next;
1184 }
1185
Randy Dunlap389834b2007-06-08 13:47:03 -07001186 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001187
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001188 my $hereline = "$here\n$rawline\n";
1189 my $herecurr = "$here\n$rawline\n";
1190 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001191
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001192 $cnt_lines++ if ($realcnt != 0);
1193
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001194#check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001195 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001196 # This is a signoff, if ugly, so do not double report.
1197 $signoff++;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001198 if (!($line =~ /^\s*Signed-off-by:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001199 WARN("Signed-off-by: is the preferred form\n" .
1200 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001201 }
1202 if ($line =~ /^\s*signed-off-by:\S/i) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001203 WARN("space required after Signed-off-by:\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001204 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001205 }
1206 }
1207
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001208# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001209 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001210 ERROR("patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001211 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001212 }
1213
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001214# Check for absolute kernel paths.
1215 if ($tree) {
1216 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1217 my $file = $1;
1218
1219 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1220 check_absolute_file($1, $herecurr)) {
1221 #
1222 } else {
1223 check_absolute_file($file, $herecurr);
1224 }
1225 }
1226 }
1227
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001228# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1229 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001230 $rawline !~ m/^$UTF8*$/) {
1231 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1232
1233 my $blank = copy_spacing($rawline);
1234 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1235 my $hereptr = "$hereline$ptr\n";
1236
1237 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001238 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001239
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001240#ignore lines being removed
1241 if ($line=~/^-/) {next;}
1242
1243# check we are in a valid source file if not then ignore this hunk
1244 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001245
1246#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001247 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001248 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001249 ERROR("DOS line endings\n" . $herevet);
1250
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001251 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1252 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001253 ERROR("trailing whitespace\n" . $herevet);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001254 }
1255#80 column limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001256 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001257 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1258 $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1259 $length > 80)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001260 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001261 WARN("line over 80 characters\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001262 }
1263
Andy Whitcroft8905a672007-11-28 16:21:06 -08001264# check for adding lines without a newline.
1265 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1266 WARN("adding a line without newline at end of file\n" . $herecurr);
1267 }
1268
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001269# check we are in a valid source file C or perl if not then ignore this hunk
1270 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001271
1272# at the beginning of a line any tabs must come first and anything
1273# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001274 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1275 $rawline =~ /^\+\s* \s*/) {
1276 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001277 ERROR("code indent should use tabs where possible\n" . $herevet);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001278 }
1279
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001280# check we are in a valid C source file if not then ignore this hunk
1281 next if ($realfile !~ /\.(h|c)$/);
1282
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001283# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001284 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001285 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1286 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001287
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001288# Check for potential 'bare' types
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001289 my ($stat, $cond, $line_nr_next, $remain_next);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001290 if ($realcnt && $line =~ /.\s*\S/) {
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001291 ($stat, $cond, $line_nr_next, $remain_next) =
1292 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001293 $stat =~ s/\n./\n /g;
1294 $cond =~ s/\n./\n /g;
1295
1296 my $s = $stat;
1297 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001298
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001299 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001300 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001301
1302 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001303 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001304
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001305 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001306 } 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 -07001307 my $type = $1;
1308 $type =~ s/\s+/ /g;
1309 possible($type, "A:" . $s);
1310
Andy Whitcroft8905a672007-11-28 16:21:06 -08001311 # definitions in global scope can only start with types
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001312 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001313 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001314 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001315
1316 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001317 while ($s =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001318 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001319 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001320
1321 # Check for any sort of function declaration.
1322 # int foo(something bar, other baz);
1323 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001324 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 -08001325 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001326
Andy Whitcroftcf655042008-03-04 14:28:20 -08001327 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001328 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001329 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001330
Andy Whitcroft8905a672007-11-28 16:21:06 -08001331 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001332 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001333
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001334 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001335 }
1336 }
1337 }
1338
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001339 }
1340
Andy Whitcroft653d4872007-06-23 17:16:34 -07001341#
1342# Checks which may be anchored in the context.
1343#
1344
1345# Check for switch () and associated case and default
1346# statements should be at the same indent.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001347 if ($line=~/\bswitch\s*\(.*\)/) {
1348 my $err = '';
1349 my $sep = '';
1350 my @ctx = ctx_block_outer($linenr, $realcnt);
1351 shift(@ctx);
1352 for my $ctx (@ctx) {
1353 my ($clen, $cindent) = line_stats($ctx);
1354 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1355 $indent != $cindent) {
1356 $err .= "$sep$ctx\n";
1357 $sep = '';
1358 } else {
1359 $sep = "[...]\n";
1360 }
1361 }
1362 if ($err ne '') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001363 ERROR("switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001364 }
1365 }
Andy Whitcrofte2a763c2008-07-23 21:29:02 -07001366 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
Andy Whitcroft1bdab9e2008-10-15 22:02:17 -07001367 $line !~ /\G(?:
1368 (?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
1369 \s*return\s+
1370 )/xg)
1371 {
Andy Whitcrofte2a763c2008-07-23 21:29:02 -07001372 ERROR("trailing statements should be on next line\n" . $herecurr);
1373 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001374
1375# if/while/etc brace do not go on next line, unless defining a do while loop,
1376# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001377 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001378 my $pre_ctx = "$1$2";
1379
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001380 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001381 my $ctx_cnt = $realcnt - $#ctx - 1;
1382 my $ctx = join("\n", @ctx);
1383
Andy Whitcroft548596d2008-07-23 21:29:01 -07001384 my $ctx_ln = $linenr;
1385 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001386
Andy Whitcroft548596d2008-07-23 21:29:01 -07001387 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1388 defined $lines[$ctx_ln - 1] &&
1389 $lines[$ctx_ln - 1] =~ /^-/)) {
1390 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1391 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001392 $ctx_ln++;
1393 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07001394
Andy Whitcroft53210162008-07-23 21:29:03 -07001395 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1396 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001397
1398 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1399 ERROR("that open brace { should be on the previous line\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001400 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001401 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001402 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1403 $ctx =~ /\)\s*\;\s*$/ &&
1404 defined $lines[$ctx_ln - 1])
1405 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001406 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1407 if ($nindent > $indent) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001408 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001409 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001410 }
1411 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001412 }
1413
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001414# Check relative indent for conditionals and blocks.
1415 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1416 my ($s, $c) = ($stat, $cond);
1417
1418 substr($s, 0, length($c), '');
1419
1420 # Make sure we remove the line prefixes as we have
1421 # none on the first line, and are going to readd them
1422 # where necessary.
1423 $s =~ s/\n./\n/gs;
1424
1425 # Find out how long the conditional actually is.
1426 my $cond_lines = 0 + $c =~ /\n/gs;
1427
1428 # We want to check the first line inside the block
1429 # starting at the end of the conditional, so remove:
1430 # 1) any blank line termination
1431 # 2) any opening brace { on end of the line
1432 # 3) any do (...) {
1433 my $continuation = 0;
1434 my $check = 0;
1435 $s =~ s/^.*\bdo\b//;
1436 $s =~ s/^\s*{//;
1437 if ($s =~ s/^\s*\\//) {
1438 $continuation = 1;
1439 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001440 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001441 $check = 1;
1442 $cond_lines++;
1443 }
1444
1445 # Also ignore a loop construct at the end of a
1446 # preprocessor statement.
1447 if (($prevline =~ /^.\s*#\s*define\s/ ||
1448 $prevline =~ /\\\s*$/) && $continuation == 0) {
1449 $check = 0;
1450 }
1451
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001452 my $cond_ptr = -1;
1453 while ($cond_ptr != $cond_lines) {
1454 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001455
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001456 # Ignore:
1457 # 1) blank lines, they should be at 0,
1458 # 2) preprocessor lines, and
1459 # 3) labels.
1460 if ($s =~ /^\s*?\n/ ||
1461 $s =~ /^\s*#\s*?/ ||
1462 $s =~ /^\s*$Ident\s*:/) {
1463 $s =~ s/^.*?\n//;
1464 $cond_lines++;
1465 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001466 }
1467
1468 my (undef, $sindent) = line_stats("+" . $s);
1469 my $stat_real = raw_line($linenr, $cond_lines);
1470
1471 # Check if either of these lines are modified, else
1472 # this is not this patch's fault.
1473 if (!defined($stat_real) ||
1474 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1475 $check = 0;
1476 }
1477 if (defined($stat_real) && $cond_lines > 1) {
1478 $stat_real = "[...]\n$stat_real";
1479 }
1480
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001481 #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 -07001482
1483 if ($check && (($sindent % 8) != 0 ||
1484 ($sindent <= $indent && $s ne ''))) {
1485 WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1486 }
1487 }
1488
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001489 # Track the 'values' across context and added lines.
1490 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001491 my ($curr_values, $curr_vars) =
1492 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001493 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001494 if ($dbg_values) {
1495 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001496 print "$linenr > .$outline\n";
1497 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001498 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001499 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001500 $prev_values = substr($curr_values, -1);
1501
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001502#ignore lines not being added
1503 if ($line=~/^[^\+]/) {next;}
1504
Andy Whitcroft653d4872007-06-23 17:16:34 -07001505# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07001506 if ($dbg_type) {
1507 if ($line =~ /^.\s*$Declare\s*$/) {
1508 ERROR("TEST: is type\n" . $herecurr);
1509 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1510 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1511 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001512 next;
1513 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001514# TEST: allow direct testing of the attribute matcher.
1515 if ($dbg_attr) {
1516 if ($line =~ /^.\s*$Attribute\s*$/) {
1517 ERROR("TEST: is attr\n" . $herecurr);
1518 } elsif ($dbg_attr > 1 && $line =~ /^.+($Attribute)/) {
1519 ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1520 }
1521 next;
1522 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001523
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001524# check for initialisation to aggregates open brace on the next line
1525 if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1526 $line =~ /^.\s*{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001527 ERROR("that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001528 }
1529
Andy Whitcroft653d4872007-06-23 17:16:34 -07001530#
1531# Checks which are anchored on the added line.
1532#
1533
1534# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001535 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001536 my $path = $1;
1537 if ($path =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001538 ERROR("malformed #include filename\n" .
1539 $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001540 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001541 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001542
1543# no C99 // comments
1544 if ($line =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001545 ERROR("do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001546 }
1547 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001548 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001549 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001550
1551#EXPORT_SYMBOL should immediately follow its function closing }.
Andy Whitcroft653d4872007-06-23 17:16:34 -07001552 if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1553 ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1554 my $name = $1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001555 if (($prevline !~ /^}/) &&
1556 ($prevline !~ /^\+}/) &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001557 ($prevline !~ /^ }/) &&
Andy Whitcroftcf655042008-03-04 14:28:20 -08001558 ($prevline !~ /^.DECLARE_$Ident\(\Q$name\E\)/) &&
1559 ($prevline !~ /^.LIST_HEAD\(\Q$name\E\)/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001560 ($prevline !~ /^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(/) &&
Andy Whitcroftcf655042008-03-04 14:28:20 -08001561 ($prevline !~ /\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001562 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001563 }
1564 }
1565
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001566# check for external initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001567 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001568 ERROR("do not initialise externals to 0 or NULL\n" .
1569 $herecurr);
1570 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001571# check for static initialisers.
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001572 if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001573 ERROR("do not initialise statics to 0 or NULL\n" .
1574 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001575 }
1576
Andy Whitcroft653d4872007-06-23 17:16:34 -07001577# check for new typedefs, only function parameters and sparse annotations
1578# make sense.
1579 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001580 $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001581 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001582 $line !~ /\b__bitwise(?:__|)\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001583 WARN("do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001584 }
1585
1586# * goes on variable not on type
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001587 if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001588 ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" .
1589 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001590
1591 } elsif ($line =~ m{\($NonptrType\s+(\*+)(?!\s+const)\s+\)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001592 ERROR("\"(foo $1 )\" should be \"(foo $1)\"\n" .
1593 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001594
Andy Whitcroft234fff62008-07-23 21:29:12 -07001595 } elsif ($line =~ m{\b$NonptrType(\*+)(?:\s+(?:$Attribute|$Sparse))?\s+[A-Za-z\d_]+}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001596 ERROR("\"foo$1 bar\" should be \"foo $1bar\"\n" .
1597 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001598
Andy Whitcroft234fff62008-07-23 21:29:12 -07001599 } elsif ($line =~ m{\b$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001600 ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" .
1601 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001602 }
1603
1604# # no BUG() or BUG_ON()
1605# if ($line =~ /\b(BUG|BUG_ON)\b/) {
1606# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1607# print "$herecurr";
1608# $clean = 0;
1609# }
1610
Andy Whitcroft8905a672007-11-28 16:21:06 -08001611 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001612 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 -08001613 }
1614
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001615# printk should use KERN_* levels. Note that follow on printk's on the
1616# same line do not need a level, so we use the current block context
1617# to try and find and validate the current printk. In summary the current
1618# printk includes all preceeding printk's which have no newline on the end.
1619# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001620 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001621 my $ok = 0;
1622 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1623 #print "CHECK<$lines[$ln - 1]\n";
1624 # we have a preceeding printk if it ends
1625 # with "\n" ignore it, else it is to blame
1626 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1627 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1628 $ok = 1;
1629 }
1630 last;
1631 }
1632 }
1633 if ($ok == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001634 WARN("printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001635 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001636 }
1637
Andy Whitcroft653d4872007-06-23 17:16:34 -07001638# function brace can't be on same line, except for #defines of do while,
1639# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001640 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1641 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001642 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001643 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001644
Andy Whitcroft8905a672007-11-28 16:21:06 -08001645# open braces for enum, union and struct go on the same line.
1646 if ($line =~ /^.\s*{/ &&
1647 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1648 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1649 }
1650
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001651# check for spacing round square brackets; allowed:
1652# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001653# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1654# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001655 while ($line =~ /(.*?\s)\[/g) {
1656 my ($where, $prefix) = ($-[1], $1);
1657 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001658 ($where != 0 || $prefix !~ /^.\s+$/) &&
1659 $prefix !~ /{\s+$/) {
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001660 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1661 }
1662 }
1663
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001664# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001665 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001666 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001667 my $ctx_before = substr($line, 0, $-[1]);
1668 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001669
1670 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001671 if ($name =~ /^(?:
1672 if|for|while|switch|return|case|
1673 volatile|__volatile__|
1674 __attribute__|format|__extension__|
1675 asm|__asm__)$/x)
1676 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001677
1678 # cpp #define statements have non-optional spaces, ie
1679 # if there is a space between the name and the open
1680 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001681 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001682
1683 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001684 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001685
1686 # If this whole things ends with a type its most
1687 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001688 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001689
1690 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001691 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001692 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001693 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001694# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001695 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001696 my $ops = qr{
1697 <<=|>>=|<=|>=|==|!=|
1698 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1699 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001700 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1701 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001702 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001703 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001704 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001705
1706 my $blank = copy_spacing($opline);
1707
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001708 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001709 $off += length($elements[$n]);
1710
Andy Whitcroft773647a2008-03-28 14:15:58 -07001711 # Pick up the preceeding and succeeding characters.
1712 my $ca = substr($opline, 0, $off);
1713 my $cc = '';
1714 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1715 $cc = substr($opline, $off + length($elements[$n + 1]));
1716 }
1717 my $cb = "$ca$;$cc";
1718
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001719 my $a = '';
1720 $a = 'V' if ($elements[$n] ne '');
1721 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001722 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001723 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1724 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07001725 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001726
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001727 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001728
1729 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001730 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001731 $c = 'V' if ($elements[$n + 2] ne '');
1732 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001733 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001734 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1735 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001736 $c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001737 } else {
1738 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001739 }
1740
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001741 my $ctx = "${a}x${c}";
1742
1743 my $at = "(ctx:$ctx)";
1744
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001745 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001746 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001747
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001748 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001749 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001750
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001751 # Get the full operator variant.
1752 my $opv = $op . substr($curr_vars, $off, 1);
1753
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001754 # Ignore operators passed as parameters.
1755 if ($op_type ne 'V' &&
1756 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1757
Andy Whitcroftcf655042008-03-04 14:28:20 -08001758# # Ignore comments
1759# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001760
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001761 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001762 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001763 if ($ctx !~ /.x[WEBC]/ &&
1764 $cc !~ /^\\/ && $cc !~ /^;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001765 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001766 }
1767
1768 # // is a comment
1769 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001770
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001771 # No spaces for:
1772 # ->
1773 # : when part of a bitfield
1774 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001775 if ($ctx =~ /Wx.|.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001776 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001777 }
1778
1779 # , must have a space on the right.
1780 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001781 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001782 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001783 }
1784
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001785 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001786 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001787 #warn "'*' is part of type\n";
1788
1789 # unary operators should have a space before and
1790 # none after. May be left adjacent to another
1791 # unary operator, or a cast
1792 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001793 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07001794 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001795 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001796 ERROR("space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001797 }
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001798 if ($op eq '*' && $cc =~/\s*const\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001799 # A unary '*' may be const
1800
1801 } elsif ($ctx =~ /.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001802 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001803 }
1804
1805 # unary ++ and unary -- are allowed no space on one side.
1806 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001807 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1808 ERROR("space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001809 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001810 if ($ctx =~ /Wx[BE]/ ||
1811 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1812 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001813 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001814 if ($ctx =~ /ExW/) {
1815 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1816 }
1817
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001818
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001819 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001820 } elsif ($op eq '<<' or $op eq '>>' or
1821 $op eq '&' or $op eq '^' or $op eq '|' or
1822 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001823 $op eq '*' or $op eq '/' or
1824 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001825 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001826 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001827 ERROR("need consistent spacing around '$op' $at\n" .
1828 $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001829 }
1830
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001831 # A colon needs no spaces before when it is
1832 # terminating a case value or a label.
1833 } elsif ($opv eq ':C' || $opv eq ':L') {
1834 if ($ctx =~ /Wx./) {
1835 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1836 }
1837
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001838 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08001839 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001840 my $ok = 0;
1841
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001842 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001843 if (($op eq '<' &&
1844 $cc =~ /^\S+\@\S+>/) ||
1845 ($op eq '>' &&
1846 $ca =~ /<\S+\@\S+$/))
1847 {
1848 $ok = 1;
1849 }
1850
1851 # Ignore ?:
1852 if (($opv eq ':O' && $ca =~ /\?$/) ||
1853 ($op eq '?' && $cc =~ /^:/)) {
1854 $ok = 1;
1855 }
1856
1857 if ($ok == 0) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001858 ERROR("spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001859 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001860 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001861 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001862 }
1863 }
1864
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001865# check for multiple assignments
1866 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001867 CHK("multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001868 }
1869
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001870## # check for multiple declarations, allowing for a function declaration
1871## # continuation.
1872## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
1873## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
1874##
1875## # Remove any bracketed sections to ensure we do not
1876## # falsly report the parameters of functions.
1877## my $ln = $line;
1878## while ($ln =~ s/\([^\(\)]*\)//g) {
1879## }
1880## if ($ln =~ /,/) {
1881## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
1882## }
1883## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001884
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001885#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001886 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
1887 $line =~ /do{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001888 ERROR("space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001889 }
1890
1891# closing brace should have a space following it when it has anything
1892# on the line
1893 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001894 ERROR("space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001895 }
1896
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001897# check spacing on square brackets
1898 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001899 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001900 }
1901 if ($line =~ /\s\]/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001902 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001903 }
1904
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001905# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001906 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
1907 $line !~ /for\s*\(\s+;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001908 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001909 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001910 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001911 $line !~ /for\s*\(.*;\s+\)/ &&
1912 $line !~ /:\s+\)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001913 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001914 }
1915
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001916#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001917 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001918 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001919 WARN("labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001920 }
1921
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001922# Return is not a function.
1923 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
1924 my $spacing = $1;
1925 my $value = $2;
1926
1927 # Flatten any parentheses and braces
Andy Whitcroftfee61c42008-07-23 21:28:56 -07001928 $value =~ s/\)\(/\) \(/g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001929 while ($value =~ s/\([^\(\)]*\)/1/) {
1930 }
1931
1932 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
1933 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
1934
1935 } elsif ($spacing !~ /\s+/) {
1936 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1937 }
1938 }
1939
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001940# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001941 if ($line=~/\b(if|while|for|switch)\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001942 ERROR("space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001943 }
1944
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001945# Check for illegal assignment in if conditional -- and check for trailing
1946# statements after the conditional.
Andy Whitcroft53210162008-07-23 21:29:03 -07001947 if ($line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001948 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001949
1950 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001951 ERROR("do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001952 }
1953
1954 # Find out what is on the end of the line after the
1955 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001956 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001957 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001958 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07001959 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
1960 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001961 {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001962 ERROR("trailing statements should be on next line\n" . $herecurr);
1963 }
1964 }
1965
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001966# Check for bitwise tests written as boolean
1967 if ($line =~ /
1968 (?:
1969 (?:\[|\(|\&\&|\|\|)
1970 \s*0[xX][0-9]+\s*
1971 (?:\&\&|\|\|)
1972 |
1973 (?:\&\&|\|\|)
1974 \s*0[xX][0-9]+\s*
1975 (?:\&\&|\|\||\)|\])
1976 )/x)
1977 {
1978 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
1979 }
1980
Andy Whitcroft8905a672007-11-28 16:21:06 -08001981# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001982 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
1983 my $s = $1;
1984 $s =~ s/$;//g; # Remove any comments
1985 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
1986 ERROR("trailing statements should be on next line\n" . $herecurr);
1987 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001988 }
1989
1990 # Check for }<nl>else {, these must be at the same
1991 # indent level to be relevant to each other.
1992 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
1993 $previndent == $indent) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001994 ERROR("else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001995 }
1996
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001997 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
1998 $previndent == $indent) {
1999 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2000
2001 # Find out what is on the end of the line after the
2002 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002003 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002004 $s =~ s/\n.*//g;
2005
2006 if ($s =~ /^\s*;/) {
2007 ERROR("while should follow close brace '}'\n" . $hereprev);
2008 }
2009 }
2010
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002011#studly caps, commented out until figure out how to distinguish between use of existing and adding new
2012# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2013# print "No studly caps, use _\n";
2014# print "$herecurr";
2015# $clean = 0;
2016# }
2017
2018#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002019 if ($line=~/\#\s*define.*\\\s$/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002020 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002021 }
2022
Andy Whitcroft653d4872007-06-23 17:16:34 -07002023#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002024 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002025 my $file = "$1.h";
2026 my $checkfile = "include/linux/$file";
2027 if (-f "$root/$checkfile" &&
2028 $realfile ne $checkfile &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002029 $1 ne 'irq')
2030 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002031 if ($realfile =~ m{^arch/}) {
2032 CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2033 } else {
2034 WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2035 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002036 }
2037 }
2038
Andy Whitcroft653d4872007-06-23 17:16:34 -07002039# multi-statement macros should be enclosed in a do while loop, grab the
2040# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08002041# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07002042 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2043 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002044 my $ln = $linenr;
2045 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002046 my ($off, $dstat, $dcond, $rest);
2047 my $ctx = '';
Andy Whitcroft653d4872007-06-23 17:16:34 -07002048
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002049 my $args = defined($1);
2050
2051 # Find the end of the macro and limit our statement
2052 # search to that.
2053 while ($cnt > 0 && defined $lines[$ln - 1] &&
2054 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2055 {
2056 $ctx .= $rawlines[$ln - 1] . "\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002057 $cnt-- if ($lines[$ln - 1] !~ /^-/);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002058 $ln++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002059 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002060 $ctx .= $rawlines[$ln - 1];
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002061
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002062 ($dstat, $dcond, $ln, $cnt, $off) =
2063 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2064 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002065 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002066
2067 # Extract the remainder of the define (if any) and
2068 # rip off surrounding spaces, and trailing \'s.
2069 $rest = '';
Andy Whitcroft636d140a2008-10-15 22:02:18 -07002070 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2071 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002072 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2073 $rest .= substr($lines[$ln - 1], $off) . "\n";
2074 $cnt--;
2075 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002076 $ln++;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002077 $off = 0;
2078 }
2079 $rest =~ s/\\\n.//g;
2080 $rest =~ s/^\s*//s;
2081 $rest =~ s/\s*$//s;
2082
2083 # Clean up the original statement.
2084 if ($args) {
2085 substr($dstat, 0, length($dcond), '');
2086 } else {
2087 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2088 }
Andy Whitcroft292f1a92008-07-23 21:29:11 -07002089 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002090 $dstat =~ s/\\\n.//g;
2091 $dstat =~ s/^\s*//s;
2092 $dstat =~ s/\s*$//s;
2093
2094 # Flatten any parentheses and braces
2095 while ($dstat =~ s/\([^\(\)]*\)/1/) {
2096 }
2097 while ($dstat =~ s/\{[^\{\}]*\}/1/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002098 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002099
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002100 my $exceptions = qr{
2101 $Declare|
2102 module_param_named|
2103 MODULE_PARAM_DESC|
2104 DECLARE_PER_CPU|
2105 DEFINE_PER_CPU|
2106 __typeof__\(
2107 }x;
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002108 #print "REST<$rest>\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002109 if ($rest ne '') {
2110 if ($rest !~ /while\s*\(/ &&
2111 $dstat !~ /$exceptions/)
2112 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002113 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 -07002114 }
2115
2116 } elsif ($ctx !~ /;/) {
2117 if ($dstat ne '' &&
2118 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2119 $dstat !~ /$exceptions/ &&
2120 $dstat =~ /$Operators/)
2121 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002122 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002123 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002124 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002125 }
2126
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002127# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002128 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2129 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08002130 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002131 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002132 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2133 if ($#chunks > 0 && $level == 0) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002134 my $allowed = 0;
2135 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002136 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002137 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002138 for my $chunk (@chunks) {
2139 my ($cond, $block) = @{$chunk};
2140
Andy Whitcroft773647a2008-03-28 14:15:58 -07002141 # If the condition carries leading newlines, then count those as offsets.
2142 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2143 my $offset = statement_rawlines($whitespace) - 1;
2144
2145 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2146
2147 # We have looked at and allowed this specific line.
2148 $suppress_ifbraces{$ln + $offset} = 1;
2149
2150 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002151 $ln += statement_rawlines($block) - 1;
2152
Andy Whitcroft773647a2008-03-28 14:15:58 -07002153 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002154
2155 $seen++ if ($block =~ /^\s*{/);
2156
Andy Whitcroftcf655042008-03-04 14:28:20 -08002157 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2158 if (statement_lines($cond) > 1) {
2159 #print "APW: ALLOWED: cond<$cond>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002160 $allowed = 1;
2161 }
2162 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002163 #print "APW: ALLOWED: block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002164 $allowed = 1;
2165 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002166 if (statement_block_size($block) > 1) {
2167 #print "APW: ALLOWED: lines block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002168 $allowed = 1;
2169 }
2170 }
2171 if ($seen && !$allowed) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002172 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002173 }
2174 }
2175 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002176 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002177 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002178 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002179
Andy Whitcroftcf655042008-03-04 14:28:20 -08002180 # Check the pre-context.
2181 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2182 #print "APW: ALLOWED: pre<$1>\n";
2183 $allowed = 1;
2184 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002185
2186 my ($level, $endln, @chunks) =
2187 ctx_statement_full($linenr, $realcnt, $-[0]);
2188
Andy Whitcroftcf655042008-03-04 14:28:20 -08002189 # Check the condition.
2190 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07002191 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002192 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002193 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08002194 }
2195 if (statement_lines($cond) > 1) {
2196 #print "APW: ALLOWED: cond<$cond>\n";
2197 $allowed = 1;
2198 }
2199 if ($block =~/\b(?:if|for|while)\b/) {
2200 #print "APW: ALLOWED: block<$block>\n";
2201 $allowed = 1;
2202 }
2203 if (statement_block_size($block) > 1) {
2204 #print "APW: ALLOWED: lines block<$block>\n";
2205 $allowed = 1;
2206 }
2207 # Check the post-context.
2208 if (defined $chunks[1]) {
2209 my ($cond, $block) = @{$chunks[1]};
2210 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002211 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002212 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002213 if ($block =~ /^\s*\{/) {
2214 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2215 $allowed = 1;
2216 }
2217 }
2218 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2219 my $herectx = $here . "\n";;
Andy Whitcroftf0556632008-10-15 22:02:23 -07002220 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002221
Andy Whitcroftf0556632008-10-15 22:02:23 -07002222 for (my $n = 0; $n < $cnt; $n++) {
2223 $herectx .= raw_line($linenr, $n) . "\n";;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002224 }
2225
2226 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002227 }
2228 }
2229
Andy Whitcroft653d4872007-06-23 17:16:34 -07002230# don't include deprecated include files (uses RAW line)
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002231 for my $inc (@dep_includes) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002232 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002233 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002234 }
2235 }
2236
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002237# don't use deprecated functions
2238 for my $func (@dep_functions) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002239 if ($line =~ /\b$func\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002240 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002241 }
2242 }
2243
2244# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002245 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2246 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002247 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002248 }
2249
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002250# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2251 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2252 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2253 }
2254
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002255# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002256 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002257 CHK("if this code is redundant consider removing it\n" .
2258 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002259 }
2260
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002261# check for needless kfree() checks
2262 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2263 my $expr = $1;
2264 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
Wolfram Sang3c232142008-07-23 21:29:05 -07002265 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002266 }
2267 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07002268# check for needless usb_free_urb() checks
2269 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2270 my $expr = $1;
2271 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2272 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2273 }
2274 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002275
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002276# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002277# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002278# print "#ifdef in C files should be avoided\n";
2279# print "$herecurr";
2280# $clean = 0;
2281# }
2282
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002283# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002284 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002285 ERROR("exactly one space required after that #$1\n" . $herecurr);
2286 }
2287
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002288# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002289 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2290 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002291 my $which = $1;
2292 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002293 CHK("$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002294 }
2295 }
2296# check for memory barriers without a comment.
2297 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2298 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002299 CHK("memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002300 }
2301 }
2302# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002303 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002304 CHK("architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002305 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002306
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002307# check the location of the inline attribute, that it is between
2308# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002309 if ($line =~ /\b$Type\s+$Inline\b/ ||
2310 $line =~ /\b$Inline\s+$Storage\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002311 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2312 }
2313
Andy Whitcroft8905a672007-11-28 16:21:06 -08002314# Check for __inline__ and __inline, prefer inline
2315 if ($line =~ /\b(__inline__|__inline)\b/) {
2316 WARN("plain inline is preferred over $1\n" . $herecurr);
2317 }
2318
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002319# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002320 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002321 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002322 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002323 my $function_name = $1;
2324 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002325
2326 my $s = $stat;
2327 if (defined $cond) {
2328 substr($s, 0, length($cond), '');
2329 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002330 if ($s =~ /^\s*;/ &&
2331 $function_name ne 'uninitialized_var')
2332 {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002333 WARN("externs should be avoided in .c files\n" . $herecurr);
2334 }
2335
2336 if ($paren_space =~ /\n/) {
2337 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2338 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002339
2340 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2341 $stat =~ /^.\s*extern\s+/)
2342 {
2343 WARN("externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002344 }
2345
2346# checks for new __setup's
2347 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2348 my $name = $1;
2349
2350 if (!grep(/$name/, @setup_docs)) {
2351 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2352 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002353 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002354
2355# check for pointless casting of kmalloc return
2356 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2357 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2358 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002359
2360# check for gcc specific __FUNCTION__
2361 if ($line =~ /__FUNCTION__/) {
2362 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2363 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002364
2365# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002366 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002367 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2368 }
2369# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002370 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002371 WARN("consider using a completion\n" . $herecurr);
2372 }
2373# recommend strict_strto* over simple_strto*
2374 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2375 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2376 }
Michael Ellermanf3db6632008-07-23 21:28:57 -07002377# check for __initcall(), use device_initcall() explicitly please
2378 if ($line =~ /^.\s*__initcall\s*\(/) {
2379 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2380 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002381
2382# use of NR_CPUS is usually wrong
2383# ignore definitions of NR_CPUS and usage to define arrays as likely right
2384 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002385 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2386 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002387 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2388 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2389 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002390 {
2391 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2392 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002393
2394# check for %L{u,d,i} in strings
2395 my $string;
2396 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2397 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07002398 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002399 if ($string =~ /(?<!%)%L[udi]/) {
2400 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2401 last;
2402 }
2403 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002404 }
2405
2406 # If we have no input at all, then there is nothing to report on
2407 # so just keep quiet.
2408 if ($#rawlines == -1) {
2409 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002410 }
2411
Andy Whitcroft8905a672007-11-28 16:21:06 -08002412 # In mailback mode only produce a report in the negative, for
2413 # things that appear to be patches.
2414 if ($mailback && ($clean == 1 || !$is_patch)) {
2415 exit(0);
2416 }
2417
2418 # This is not a patch, and we are are in 'no-patch' mode so
2419 # just keep quiet.
2420 if (!$chk_patch && !$is_patch) {
2421 exit(0);
2422 }
2423
2424 if (!$is_patch) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002425 ERROR("Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002426 }
2427 if ($is_patch && $chk_signoff && $signoff == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002428 ERROR("Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002429 }
2430
Andy Whitcroft8905a672007-11-28 16:21:06 -08002431 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002432 if ($summary && !($clean == 1 && $quiet == 1)) {
2433 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002434 print "total: $cnt_error errors, $cnt_warn warnings, " .
2435 (($check)? "$cnt_chk checks, " : "") .
2436 "$cnt_lines lines checked\n";
2437 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002438 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002439
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002440 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002441 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002442 }
2443 if ($clean == 0 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002444 print "$vname has style problems, please review. If any of these errors\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002445 print "are false positives report them to the maintainer, see\n";
2446 print "CHECKPATCH in MAINTAINERS.\n";
2447 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002448
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002449 return $clean;
2450}