blob: 5382f7287397d3aabd832a4f7f615216ce3d495e [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 Whitcroft00df3442007-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 Whitcroft00df3442007-06-08 13:47:06 -070010$P =~ s@.*/@@g;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070011
Andy Whitcroftdea79cd2008-10-15 22:02:24 -070012my $V = '0.22';
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 Whitcroft00df3442007-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 Whitcroft00df3442007-06-08 13:47:06 -0700217my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800218my @lines = ();
219my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700220for my $filename (@ARGV) {
221 if ($file) {
222 open(FILE, "diff -u /dev/null $filename|") ||
223 die "$P: $filename: diff failed - $!\n";
224 } else {
225 open(FILE, "<$filename") ||
226 die "$P: $filename: open failed - $!\n";
Andy 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 Whitcroft00df3442007-06-08 13:47:06 -0700313sub sanitise_line {
314 my ($line) = @_;
315
316 my $res = '';
317 my $l = '';
318
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800319 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700320 my $off = 0;
321 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700322
Andy Whitcroft773647a2008-03-28 14:15:58 -0700323 # Always copy over the diff marker.
324 $res = substr($line, 0, 1);
325
326 for ($off = 1; $off < length($line); $off++) {
327 $c = substr($line, $off, 1);
328
329 # Comments we are wacking completly including the begin
330 # and end, all to $;.
331 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
332 $sanitise_quote = '*/';
333
334 substr($res, $off, 2, "$;$;");
335 $off++;
336 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800337 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700338 if (substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700339 $sanitise_quote = '';
340 substr($res, $off, 2, "$;$;");
341 $off++;
342 next;
343 }
344
345 # A \ in a string means ignore the next character.
346 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
347 $c eq "\\") {
348 substr($res, $off, 2, 'XX');
349 $off++;
350 next;
351 }
352 # Regular quotes.
353 if ($c eq "'" || $c eq '"') {
354 if ($sanitise_quote eq '') {
355 $sanitise_quote = $c;
356
357 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700358 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700359 } elsif ($sanitise_quote eq $c) {
360 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700361 }
362 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700363
364 #print "SQ:$sanitise_quote\n";
365 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
366 substr($res, $off, 1, $;);
367 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
368 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700369 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700370 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700371 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800372 }
373
374 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700375 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800376 my $clean = 'X' x length($1);
377 $res =~ s@\<.*\>@<$clean>@;
378
379 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700380 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800381 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700382 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800383 }
384
Andy Whitcroft00df3442007-06-08 13:47:06 -0700385 return $res;
386}
387
Andy Whitcroft8905a672007-11-28 16:21:06 -0800388sub ctx_statement_block {
389 my ($linenr, $remain, $off) = @_;
390 my $line = $linenr - 1;
391 my $blk = '';
392 my $soff = $off;
393 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700394 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800395
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800396 my $loff = 0;
397
Andy Whitcroft8905a672007-11-28 16:21:06 -0800398 my $type = '';
399 my $level = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800400 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800401 my $c;
402 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800403
404 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800405 while (1) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700406 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800407 # If we are about to drop off the end, pull in more
408 # context.
409 if ($off >= $len) {
410 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700411 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800412 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800413 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800414 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800415 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800416 $len = length($blk);
417 $line++;
418 last;
419 }
420 # Bail if there is no further context.
421 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800422 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800423 last;
424 }
425 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800426 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800427 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800428 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800429
Andy Whitcroft773647a2008-03-28 14:15:58 -0700430 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800431 # Statement ends at the ';' or a close '}' at the
432 # outermost level.
433 if ($level == 0 && $c eq ';') {
434 last;
435 }
436
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800437 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700438 if ($level == 0 && $coff_set == 0 &&
439 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
440 $remainder =~ /^(else)(?:\s|{)/ &&
441 $remainder !~ /^else\s+if\b/) {
442 $coff = $off + length($1) - 1;
443 $coff_set = 1;
444 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
445 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800446 }
447
Andy Whitcroft8905a672007-11-28 16:21:06 -0800448 if (($type eq '' || $type eq '(') && $c eq '(') {
449 $level++;
450 $type = '(';
451 }
452 if ($type eq '(' && $c eq ')') {
453 $level--;
454 $type = ($level != 0)? '(' : '';
455
456 if ($level == 0 && $coff < $soff) {
457 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700458 $coff_set = 1;
459 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800460 }
461 }
462 if (($type eq '' || $type eq '{') && $c eq '{') {
463 $level++;
464 $type = '{';
465 }
466 if ($type eq '{' && $c eq '}') {
467 $level--;
468 $type = ($level != 0)? '{' : '';
469
470 if ($level == 0) {
471 last;
472 }
473 }
474 $off++;
475 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700476 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800477 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700478 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800479 $line++;
480 $remain--;
481 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800482
483 my $statement = substr($blk, $soff, $off - $soff + 1);
484 my $condition = substr($blk, $soff, $coff - $soff + 1);
485
486 #warn "STATEMENT<$statement>\n";
487 #warn "CONDITION<$condition>\n";
488
Andy Whitcroft773647a2008-03-28 14:15:58 -0700489 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800490
491 return ($statement, $condition,
492 $line, $remain + 1, $off - $loff + 1, $level);
493}
494
Andy Whitcroftcf655042008-03-04 14:28:20 -0800495sub statement_lines {
496 my ($stmt) = @_;
497
498 # Strip the diff line prefixes and rip blank lines at start and end.
499 $stmt =~ s/(^|\n)./$1/g;
500 $stmt =~ s/^\s*//;
501 $stmt =~ s/\s*$//;
502
503 my @stmt_lines = ($stmt =~ /\n/g);
504
505 return $#stmt_lines + 2;
506}
507
508sub statement_rawlines {
509 my ($stmt) = @_;
510
511 my @stmt_lines = ($stmt =~ /\n/g);
512
513 return $#stmt_lines + 2;
514}
515
516sub statement_block_size {
517 my ($stmt) = @_;
518
519 $stmt =~ s/(^|\n)./$1/g;
520 $stmt =~ s/^\s*{//;
521 $stmt =~ s/}\s*$//;
522 $stmt =~ s/^\s*//;
523 $stmt =~ s/\s*$//;
524
525 my @stmt_lines = ($stmt =~ /\n/g);
526 my @stmt_statements = ($stmt =~ /;/g);
527
528 my $stmt_lines = $#stmt_lines + 2;
529 my $stmt_statements = $#stmt_statements + 1;
530
531 if ($stmt_lines > $stmt_statements) {
532 return $stmt_lines;
533 } else {
534 return $stmt_statements;
535 }
536}
537
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800538sub ctx_statement_full {
539 my ($linenr, $remain, $off) = @_;
540 my ($statement, $condition, $level);
541
542 my (@chunks);
543
Andy Whitcroftcf655042008-03-04 14:28:20 -0800544 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800545 ($statement, $condition, $linenr, $remain, $off, $level) =
546 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700547 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800548 push(@chunks, [ $condition, $statement ]);
549 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
550 return ($level, $linenr, @chunks);
551 }
552
553 # Pull in the following conditional/block pairs and see if they
554 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800555 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800556 ($statement, $condition, $linenr, $remain, $off, $level) =
557 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800558 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700559 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800560 #print "C: push\n";
561 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800562 }
563
564 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800565}
566
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700567sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700568 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700569 my $line;
570 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700571 my $blk = '';
572 my @o;
573 my @c;
574 my @res = ();
575
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700576 my $level = 0;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700577 for ($line = $start; $remain > 0; $line++) {
578 next if ($rawlines[$line] =~ /^-/);
579 $remain--;
580
581 $blk .= $rawlines[$line];
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700582 foreach my $c (split(//, $rawlines[$line])) {
583 ##print "C<$c>L<$level><$open$close>O<$off>\n";
584 if ($off > 0) {
585 $off--;
586 next;
587 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700588
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700589 if ($c eq $close && $level > 0) {
590 $level--;
591 last if ($level == 0);
592 } elsif ($c eq $open) {
593 $level++;
594 }
595 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700596
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700597 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700598 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700599 }
600
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700601 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700602 }
603
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700604 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700605}
606sub ctx_block_outer {
607 my ($linenr, $remain) = @_;
608
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700609 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
610 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700611}
612sub ctx_block {
613 my ($linenr, $remain) = @_;
614
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700615 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
616 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700617}
618sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700619 my ($linenr, $remain, $off) = @_;
620
621 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
622 return @r;
623}
624sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700625 my ($linenr, $remain) = @_;
626
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700627 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700628}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700629sub ctx_statement_level {
630 my ($linenr, $remain, $off) = @_;
631
632 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
633}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700634
635sub ctx_locate_comment {
636 my ($first_line, $end_line) = @_;
637
638 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700639 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700640 return $current_comment if (defined $current_comment);
641
642 # Look through the context and try and figure out if there is a
643 # comment.
644 my $in_comment = 0;
645 $current_comment = '';
646 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700647 my $line = $rawlines[$linenr - 1];
648 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700649 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
650 $in_comment = 1;
651 }
652 if ($line =~ m@/\*@) {
653 $in_comment = 1;
654 }
655 if (!$in_comment && $current_comment ne '') {
656 $current_comment = '';
657 }
658 $current_comment .= $line . "\n" if ($in_comment);
659 if ($line =~ m@\*/@) {
660 $in_comment = 0;
661 }
662 }
663
664 chomp($current_comment);
665 return($current_comment);
666}
667sub ctx_has_comment {
668 my ($first_line, $end_line) = @_;
669 my $cmt = ctx_locate_comment($first_line, $end_line);
670
Andy Whitcroft00df3442007-06-08 13:47:06 -0700671 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700672 ##print "CMMT: $cmt\n";
673
674 return ($cmt ne '');
675}
676
Andy Whitcroft4d001e42008-10-15 22:02:21 -0700677sub raw_line {
678 my ($linenr, $cnt) = @_;
679
680 my $offset = $linenr - 1;
681 $cnt++;
682
683 my $line;
684 while ($cnt) {
685 $line = $rawlines[$offset++];
686 next if (defined($line) && $line =~ /^-/);
687 $cnt--;
688 }
689
690 return $line;
691}
692
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700693sub cat_vet {
694 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700695 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700696
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700697 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700698 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
699 $res .= $1;
700 if ($2 ne '') {
701 $coded = sprintf("^%c", unpack('C', $2) + 64);
702 $res .= $coded;
703 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700704 }
705 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700706
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700707 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700708}
709
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800710my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800711my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800712my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700713my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800714
715sub annotate_reset {
716 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800717 $av_pending = '_';
718 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700719 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800720}
721
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700722sub annotate_values {
723 my ($stream, $type) = @_;
724
725 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700726 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700727 my $cur = $stream;
728
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800729 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700730
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700731 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700732 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800733 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700734 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700735 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800736 print "WS($1)\n" if ($dbg_values > 1);
737 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800738 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800739 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700740 }
741
Andy Whitcroft8ea3eb92008-07-23 21:29:08 -0700742 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800743 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700744 $type = 'T';
745
Andy Whitcroft389a2fe2008-07-23 21:29:05 -0700746 } elsif ($cur =~ /^($Modifier)\s*/) {
747 print "MODIFIER($1)\n" if ($dbg_values > 1);
748 $type = 'T';
749
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700750 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700751 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800752 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700753 push(@av_paren_type, $type);
754 if ($2 ne '') {
755 $av_pending = 'N';
756 }
757 $type = 'E';
758
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700759 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700760 print "UNDEF($1)\n" if ($dbg_values > 1);
761 $av_preprocessor = 1;
762 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700763
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700764 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800765 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800766 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800767
768 push(@av_paren_type, $type);
769 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700770 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800771
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700772 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800773 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
774 $av_preprocessor = 1;
775
776 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
777
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700778 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800779
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700780 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800781 print "PRE_END($1)\n" if ($dbg_values > 1);
782
783 $av_preprocessor = 1;
784
785 # Assume all arms of the conditional end as this
786 # one does, and continue as if the #endif was not here.
787 pop(@av_paren_type);
788 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700789 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700790
791 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800792 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700793
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700794 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
795 print "ATTR($1)\n" if ($dbg_values > 1);
796 $av_pending = $type;
797 $type = 'N';
798
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700799 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800800 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700801 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800802 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700803 }
804 $type = 'N';
805
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700806 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800807 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700808 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700809 $type = 'N';
810
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700811 } elsif ($cur =~/^(case)/o) {
812 print "CASE($1)\n" if ($dbg_values > 1);
813 $av_pend_colon = 'C';
814 $type = 'N';
815
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700816 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800817 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700818 $type = 'N';
819
820 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800821 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800822 push(@av_paren_type, $av_pending);
823 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700824 $type = 'N';
825
826 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800827 my $new_type = pop(@av_paren_type);
828 if ($new_type ne '_') {
829 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800830 print "PAREN('$1') -> $type\n"
831 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700832 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800833 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700834 }
835
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700836 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800837 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700838 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800839 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700840
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700841 } elsif ($cur =~ /^($Ident\s*):/) {
842 if ($type eq 'E') {
843 $av_pend_colon = 'L';
844 } elsif ($type eq 'T') {
845 $av_pend_colon = 'B';
846 }
847 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
848 $type = 'V';
849
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700850 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800851 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700852 $type = 'V';
853
854 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800855 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700856 $type = 'N';
857
Andy Whitcroftcf655042008-03-04 14:28:20 -0800858 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800859 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800860 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700861 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800862
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700863 } elsif ($cur =~ /^(\?)/o) {
864 print "QUESTION($1)\n" if ($dbg_values > 1);
865 $type = 'N';
866
867 } elsif ($cur =~ /^(:)/o) {
868 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
869
870 substr($var, length($res), 1, $av_pend_colon);
871 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
872 $type = 'E';
873 } else {
874 $type = 'N';
875 }
876 $av_pend_colon = 'O';
877
878 } elsif ($cur =~ /^(;|\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800879 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700880 $type = 'N';
881
Andy Whitcroft0d413862008-10-15 22:02:16 -0700882 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -0700883 my $variant;
884
885 print "OPV($1)\n" if ($dbg_values > 1);
886 if ($type eq 'V') {
887 $variant = 'B';
888 } else {
889 $variant = 'U';
890 }
891
892 substr($var, length($res), 1, $variant);
893 $type = 'N';
894
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700895 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800896 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700897 if ($1 ne '++' && $1 ne '--') {
898 $type = 'N';
899 }
900
901 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800902 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700903 }
904 if (defined $1) {
905 $cur = substr($cur, length($1));
906 $res .= $type x length($1);
907 }
908 }
909
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700910 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700911}
912
Andy Whitcroft8905a672007-11-28 16:21:06 -0800913sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800914 my ($possible, $line) = @_;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800915
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700916 print "CHECK<$possible> ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft0221f552008-07-23 21:29:08 -0700917 if ($possible !~ /^(?:$Modifier|$Storage|$Type|DEFINE_\S+)$/ &&
Andy Whitcroft8905a672007-11-28 16:21:06 -0800918 $possible ne 'goto' && $possible ne 'return' &&
Andy Whitcroft8905a672007-11-28 16:21:06 -0800919 $possible ne 'case' && $possible ne 'else' &&
Andy Whitcroftd3ddcf42008-07-23 21:28:58 -0700920 $possible ne 'asm' && $possible ne '__asm__' &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700921 $possible !~ /^(typedef|struct|enum)\b/) {
922 # Check for modifiers.
923 $possible =~ s/\s*$Storage\s*//g;
924 $possible =~ s/\s*$Sparse\s*//g;
925 if ($possible =~ /^\s*$/) {
926
927 } elsif ($possible =~ /\s/) {
928 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -0700929 for my $modifier (split(' ', $possible)) {
930 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
931 push(@modifierList, $modifier);
932 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700933
934 } else {
935 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
936 push(@typeList, $possible);
937 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800938 build_types();
939 }
940}
941
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700942my $prefix = '';
943
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700944sub report {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700945 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
946 return 0;
947 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800948 my $line = $prefix . $_[0];
949
950 $line = (split('\n', $line))[0] . "\n" if ($terse);
951
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800952 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700953
954 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700955}
956sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800957 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700958}
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700959sub ERROR {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700960 if (report("ERROR: $_[0]\n")) {
961 our $clean = 0;
962 our $cnt_error++;
963 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700964}
965sub WARN {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700966 if (report("WARNING: $_[0]\n")) {
967 our $clean = 0;
968 our $cnt_warn++;
969 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700970}
971sub CHK {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700972 if ($check && report("CHECK: $_[0]\n")) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700973 our $clean = 0;
974 our $cnt_chk++;
975 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700976}
977
Andy Whitcroft6ecd9672008-10-15 22:02:21 -0700978sub check_absolute_file {
979 my ($absolute, $herecurr) = @_;
980 my $file = $absolute;
981
982 ##print "absolute<$absolute>\n";
983
984 # See if any suffix of this path is a path within the tree.
985 while ($file =~ s@^[^/]*/@@) {
986 if (-f "$root/$file") {
987 ##print "file<$file>\n";
988 last;
989 }
990 }
991 if (! -f _) {
992 return 0;
993 }
994
995 # It is, so see if the prefix is acceptable.
996 my $prefix = $absolute;
997 substr($prefix, -length($file)) = '';
998
999 ##print "prefix<$prefix>\n";
1000 if ($prefix ne ".../") {
1001 WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr);
1002 }
1003}
1004
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001005sub process {
1006 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001007
1008 my $linenr=0;
1009 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001010 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001011 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001012 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001013
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001014 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001015 my $indent;
1016 my $previndent=0;
1017 my $stashindent=0;
1018
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001019 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001020 my $signoff = 0;
1021 my $is_patch = 0;
1022
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001023 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001024 our $cnt_lines = 0;
1025 our $cnt_error = 0;
1026 our $cnt_warn = 0;
1027 our $cnt_chk = 0;
1028
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001029 # Trace the real file/line as we go.
1030 my $realfile = '';
1031 my $realline = 0;
1032 my $realcnt = 0;
1033 my $here = '';
1034 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001035 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001036 my $first_line = 0;
1037
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001038 my $prev_values = 'E';
1039
1040 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001041 my %suppress_ifbraces;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001042
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001043 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001044 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001045 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001046 my @setup_docs = ();
1047 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001048
1049 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001050 my $line;
1051 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001052 $linenr++;
1053 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001054
Andy Whitcroft773647a2008-03-28 14:15:58 -07001055 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001056 $setup_docs = 0;
1057 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1058 $setup_docs = 1;
1059 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001060 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001061 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001062 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1063 $realline=$1-1;
1064 if (defined $2) {
1065 $realcnt=$3+1;
1066 } else {
1067 $realcnt=1+1;
1068 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001069 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001070
1071 # Guestimate if this is a continuing comment. Run
1072 # the context looking for a comment "edge". If this
1073 # edge is a close comment then we must be in a comment
1074 # at context start.
1075 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001076 my $cnt = $realcnt;
1077 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1078 next if (defined $rawlines[$ln - 1] &&
1079 $rawlines[$ln - 1] =~ /^-/);
1080 $cnt--;
1081 #print "RAW<$rawlines[$ln - 1]>\n";
1082 ($edge) = (defined $rawlines[$ln - 1] &&
1083 $rawlines[$ln - 1] =~ m@(/\*|\*/)@);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001084 last if (defined $edge);
1085 }
1086 if (defined $edge && $edge eq '*/') {
1087 $in_comment = 1;
1088 }
1089
1090 # Guestimate if this is a continuing comment. If this
1091 # is the start of a diff block and this line starts
1092 # ' *' then it is very likely a comment.
1093 if (!defined $edge &&
1094 $rawlines[$linenr] =~ m@^.\s* \*(?:\s|$)@)
1095 {
1096 $in_comment = 1;
1097 }
1098
1099 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1100 sanitise_line_reset($in_comment);
1101
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001102 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001103 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001104 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001105 $line = sanitise_line($rawline);
1106 }
1107 push(@lines, $line);
1108
1109 if ($realcnt > 1) {
1110 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1111 } else {
1112 $realcnt = 0;
1113 }
1114
1115 #print "==>$rawline\n";
1116 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001117
1118 if ($setup_docs && $line =~ /^\+/) {
1119 push(@setup_docs, $line);
1120 }
1121 }
1122
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001123 $prefix = '';
1124
Andy Whitcroft773647a2008-03-28 14:15:58 -07001125 $realcnt = 0;
1126 $linenr = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001127 foreach my $line (@lines) {
1128 $linenr++;
1129
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001130 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001131
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001132#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001133 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001134 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001135 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001136 $realline=$1-1;
1137 if (defined $2) {
1138 $realcnt=$3+1;
1139 } else {
1140 $realcnt=1+1;
1141 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001142 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001143 $prev_values = 'E';
1144
Andy Whitcroft773647a2008-03-28 14:15:58 -07001145 %suppress_ifbraces = ();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001146 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001147
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001148# track the line number as we move through the hunk, note that
1149# new versions of GNU diff omit the leading space on completely
1150# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001151 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001152 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001153 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001154
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001155 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001156 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001157
1158 # Track the previous line.
1159 ($prevline, $stashline) = ($stashline, $line);
1160 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001161 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1162
Andy Whitcroft773647a2008-03-28 14:15:58 -07001163 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001164
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001165 } elsif ($realcnt == 1) {
1166 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001167 }
1168
1169#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001170 $prefix = "$filename:$realline: " if ($emacs && $file);
1171 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1172
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001173 $here = "#$linenr: " if (!$file);
1174 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001175
1176 # extract the filename as it passes
1177 if ($line=~/^\+\+\+\s+(\S+)/) {
1178 $realfile = $1;
1179 $realfile =~ s@^[^/]*/@@;
1180
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001181 if ($realfile =~ m@^include/asm/@) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001182 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1183 }
1184 next;
1185 }
1186
Randy Dunlap389834b2007-06-08 13:47:03 -07001187 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001188
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001189 my $hereline = "$here\n$rawline\n";
1190 my $herecurr = "$here\n$rawline\n";
1191 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001192
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001193 $cnt_lines++ if ($realcnt != 0);
1194
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001195#check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001196 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001197 # This is a signoff, if ugly, so do not double report.
1198 $signoff++;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001199 if (!($line =~ /^\s*Signed-off-by:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001200 WARN("Signed-off-by: is the preferred form\n" .
1201 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001202 }
1203 if ($line =~ /^\s*signed-off-by:\S/i) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001204 WARN("space required after Signed-off-by:\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001205 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001206 }
1207 }
1208
Andy Whitcroft00df3442007-06-08 13:47:06 -07001209# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001210 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001211 ERROR("patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001212 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001213 }
1214
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001215# Check for absolute kernel paths.
1216 if ($tree) {
1217 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1218 my $file = $1;
1219
1220 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1221 check_absolute_file($1, $herecurr)) {
1222 #
1223 } else {
1224 check_absolute_file($file, $herecurr);
1225 }
1226 }
1227 }
1228
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001229# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1230 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001231 $rawline !~ m/^$UTF8*$/) {
1232 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1233
1234 my $blank = copy_spacing($rawline);
1235 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1236 my $hereptr = "$hereline$ptr\n";
1237
1238 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001239 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001240
Andy Whitcroft00df3442007-06-08 13:47:06 -07001241#ignore lines being removed
1242 if ($line=~/^-/) {next;}
1243
1244# check we are in a valid source file if not then ignore this hunk
1245 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001246
1247#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001248 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001249 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001250 ERROR("DOS line endings\n" . $herevet);
1251
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001252 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1253 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001254 ERROR("trailing whitespace\n" . $herevet);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001255 }
1256#80 column limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001257 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001258 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1259 $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1260 $length > 80)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001261 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001262 WARN("line over 80 characters\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001263 }
1264
Andy Whitcroft8905a672007-11-28 16:21:06 -08001265# check for adding lines without a newline.
1266 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1267 WARN("adding a line without newline at end of file\n" . $herecurr);
1268 }
1269
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001270# check we are in a valid source file C or perl if not then ignore this hunk
1271 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001272
1273# at the beginning of a line any tabs must come first and anything
1274# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001275 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1276 $rawline =~ /^\+\s* \s*/) {
1277 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001278 ERROR("code indent should use tabs where possible\n" . $herevet);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001279 }
1280
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001281# check we are in a valid C source file if not then ignore this hunk
1282 next if ($realfile !~ /\.(h|c)$/);
1283
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001284# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001285 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001286 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1287 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001288
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001289# Check for potential 'bare' types
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001290 my ($stat, $cond, $line_nr_next, $remain_next);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001291 if ($realcnt && $line =~ /.\s*\S/) {
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001292 ($stat, $cond, $line_nr_next, $remain_next) =
1293 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001294 $stat =~ s/\n./\n /g;
1295 $cond =~ s/\n./\n /g;
1296
1297 my $s = $stat;
1298 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001299
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001300 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001301 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001302
1303 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001304 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001305
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001306 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001307 } 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 -07001308 my $type = $1;
1309 $type =~ s/\s+/ /g;
1310 possible($type, "A:" . $s);
1311
Andy Whitcroft8905a672007-11-28 16:21:06 -08001312 # definitions in global scope can only start with types
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001313 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001314 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001315 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001316
1317 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001318 while ($s =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001319 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001320 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001321
1322 # Check for any sort of function declaration.
1323 # int foo(something bar, other baz);
1324 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001325 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 -08001326 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001327
Andy Whitcroftcf655042008-03-04 14:28:20 -08001328 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001329 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001330 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001331
Andy Whitcroft8905a672007-11-28 16:21:06 -08001332 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001333 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001334
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001335 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001336 }
1337 }
1338 }
1339
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001340 }
1341
Andy Whitcroft653d4872007-06-23 17:16:34 -07001342#
1343# Checks which may be anchored in the context.
1344#
1345
1346# Check for switch () and associated case and default
1347# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07001348 if ($line=~/\bswitch\s*\(.*\)/) {
1349 my $err = '';
1350 my $sep = '';
1351 my @ctx = ctx_block_outer($linenr, $realcnt);
1352 shift(@ctx);
1353 for my $ctx (@ctx) {
1354 my ($clen, $cindent) = line_stats($ctx);
1355 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1356 $indent != $cindent) {
1357 $err .= "$sep$ctx\n";
1358 $sep = '';
1359 } else {
1360 $sep = "[...]\n";
1361 }
1362 }
1363 if ($err ne '') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001364 ERROR("switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001365 }
1366 }
1367
1368# if/while/etc brace do not go on next line, unless defining a do while loop,
1369# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001370 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001371 my $pre_ctx = "$1$2";
1372
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001373 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001374 my $ctx_cnt = $realcnt - $#ctx - 1;
1375 my $ctx = join("\n", @ctx);
1376
Andy Whitcroft548596d2008-07-23 21:29:01 -07001377 my $ctx_ln = $linenr;
1378 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001379
Andy Whitcroft548596d2008-07-23 21:29:01 -07001380 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1381 defined $lines[$ctx_ln - 1] &&
1382 $lines[$ctx_ln - 1] =~ /^-/)) {
1383 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1384 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001385 $ctx_ln++;
1386 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07001387
Andy Whitcroft53210162008-07-23 21:29:03 -07001388 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1389 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001390
1391 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1392 ERROR("that open brace { should be on the previous line\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001393 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07001394 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001395 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1396 $ctx =~ /\)\s*\;\s*$/ &&
1397 defined $lines[$ctx_ln - 1])
1398 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001399 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1400 if ($nindent > $indent) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001401 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001402 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001403 }
1404 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001405 }
1406
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001407# Check relative indent for conditionals and blocks.
1408 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1409 my ($s, $c) = ($stat, $cond);
1410
1411 substr($s, 0, length($c), '');
1412
1413 # Make sure we remove the line prefixes as we have
1414 # none on the first line, and are going to readd them
1415 # where necessary.
1416 $s =~ s/\n./\n/gs;
1417
1418 # Find out how long the conditional actually is.
1419 my $cond_lines = 0 + $c =~ /\n/gs;
1420
1421 # We want to check the first line inside the block
1422 # starting at the end of the conditional, so remove:
1423 # 1) any blank line termination
1424 # 2) any opening brace { on end of the line
1425 # 3) any do (...) {
1426 my $continuation = 0;
1427 my $check = 0;
1428 $s =~ s/^.*\bdo\b//;
1429 $s =~ s/^\s*{//;
1430 if ($s =~ s/^\s*\\//) {
1431 $continuation = 1;
1432 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001433 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001434 $check = 1;
1435 $cond_lines++;
1436 }
1437
1438 # Also ignore a loop construct at the end of a
1439 # preprocessor statement.
1440 if (($prevline =~ /^.\s*#\s*define\s/ ||
1441 $prevline =~ /\\\s*$/) && $continuation == 0) {
1442 $check = 0;
1443 }
1444
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001445 my $cond_ptr = -1;
1446 while ($cond_ptr != $cond_lines) {
1447 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001448
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001449 # Ignore:
1450 # 1) blank lines, they should be at 0,
1451 # 2) preprocessor lines, and
1452 # 3) labels.
1453 if ($s =~ /^\s*?\n/ ||
1454 $s =~ /^\s*#\s*?/ ||
1455 $s =~ /^\s*$Ident\s*:/) {
1456 $s =~ s/^.*?\n//;
1457 $cond_lines++;
1458 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001459 }
1460
1461 my (undef, $sindent) = line_stats("+" . $s);
1462 my $stat_real = raw_line($linenr, $cond_lines);
1463
1464 # Check if either of these lines are modified, else
1465 # this is not this patch's fault.
1466 if (!defined($stat_real) ||
1467 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1468 $check = 0;
1469 }
1470 if (defined($stat_real) && $cond_lines > 1) {
1471 $stat_real = "[...]\n$stat_real";
1472 }
1473
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001474 #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 -07001475
1476 if ($check && (($sindent % 8) != 0 ||
1477 ($sindent <= $indent && $s ne ''))) {
1478 WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1479 }
1480 }
1481
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001482 # Track the 'values' across context and added lines.
1483 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001484 my ($curr_values, $curr_vars) =
1485 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001486 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001487 if ($dbg_values) {
1488 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001489 print "$linenr > .$outline\n";
1490 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001491 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001492 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001493 $prev_values = substr($curr_values, -1);
1494
Andy Whitcroft00df3442007-06-08 13:47:06 -07001495#ignore lines not being added
1496 if ($line=~/^[^\+]/) {next;}
1497
Andy Whitcroft653d4872007-06-23 17:16:34 -07001498# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07001499 if ($dbg_type) {
1500 if ($line =~ /^.\s*$Declare\s*$/) {
1501 ERROR("TEST: is type\n" . $herecurr);
1502 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1503 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1504 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001505 next;
1506 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001507# TEST: allow direct testing of the attribute matcher.
1508 if ($dbg_attr) {
1509 if ($line =~ /^.\s*$Attribute\s*$/) {
1510 ERROR("TEST: is attr\n" . $herecurr);
1511 } elsif ($dbg_attr > 1 && $line =~ /^.+($Attribute)/) {
1512 ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1513 }
1514 next;
1515 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001516
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001517# check for initialisation to aggregates open brace on the next line
1518 if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1519 $line =~ /^.\s*{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001520 ERROR("that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001521 }
1522
Andy Whitcroft653d4872007-06-23 17:16:34 -07001523#
1524# Checks which are anchored on the added line.
1525#
1526
1527# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001528 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001529 my $path = $1;
1530 if ($path =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001531 ERROR("malformed #include filename\n" .
1532 $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001533 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001534 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001535
1536# no C99 // comments
1537 if ($line =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001538 ERROR("do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001539 }
1540 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001541 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001542 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001543
1544#EXPORT_SYMBOL should immediately follow its function closing }.
Andy Whitcroft653d4872007-06-23 17:16:34 -07001545 if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1546 ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1547 my $name = $1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001548 if (($prevline !~ /^}/) &&
1549 ($prevline !~ /^\+}/) &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001550 ($prevline !~ /^ }/) &&
Andy Whitcroftcf655042008-03-04 14:28:20 -08001551 ($prevline !~ /^.DECLARE_$Ident\(\Q$name\E\)/) &&
1552 ($prevline !~ /^.LIST_HEAD\(\Q$name\E\)/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001553 ($prevline !~ /^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(/) &&
Andy Whitcroftcf655042008-03-04 14:28:20 -08001554 ($prevline !~ /\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001555 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001556 }
1557 }
1558
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001559# check for external initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001560 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001561 ERROR("do not initialise externals to 0 or NULL\n" .
1562 $herecurr);
1563 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001564# check for static initialisers.
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001565 if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001566 ERROR("do not initialise statics to 0 or NULL\n" .
1567 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001568 }
1569
Andy Whitcroft653d4872007-06-23 17:16:34 -07001570# check for new typedefs, only function parameters and sparse annotations
1571# make sense.
1572 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001573 $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001574 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001575 $line !~ /\b__bitwise(?:__|)\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001576 WARN("do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001577 }
1578
1579# * goes on variable not on type
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001580 if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001581 ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" .
1582 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001583
1584 } elsif ($line =~ m{\($NonptrType\s+(\*+)(?!\s+const)\s+\)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001585 ERROR("\"(foo $1 )\" should be \"(foo $1)\"\n" .
1586 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001587
Andy Whitcroft234fff62008-07-23 21:29:12 -07001588 } elsif ($line =~ m{\b$NonptrType(\*+)(?:\s+(?:$Attribute|$Sparse))?\s+[A-Za-z\d_]+}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001589 ERROR("\"foo$1 bar\" should be \"foo $1bar\"\n" .
1590 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001591
Andy Whitcroft234fff62008-07-23 21:29:12 -07001592 } elsif ($line =~ m{\b$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001593 ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" .
1594 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001595 }
1596
1597# # no BUG() or BUG_ON()
1598# if ($line =~ /\b(BUG|BUG_ON)\b/) {
1599# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1600# print "$herecurr";
1601# $clean = 0;
1602# }
1603
Andy Whitcroft8905a672007-11-28 16:21:06 -08001604 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001605 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 -08001606 }
1607
Andy Whitcroft00df3442007-06-08 13:47:06 -07001608# printk should use KERN_* levels. Note that follow on printk's on the
1609# same line do not need a level, so we use the current block context
1610# to try and find and validate the current printk. In summary the current
1611# printk includes all preceeding printk's which have no newline on the end.
1612# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001613 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001614 my $ok = 0;
1615 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1616 #print "CHECK<$lines[$ln - 1]\n";
1617 # we have a preceeding printk if it ends
1618 # with "\n" ignore it, else it is to blame
1619 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1620 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1621 $ok = 1;
1622 }
1623 last;
1624 }
1625 }
1626 if ($ok == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001627 WARN("printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001628 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001629 }
1630
Andy Whitcroft653d4872007-06-23 17:16:34 -07001631# function brace can't be on same line, except for #defines of do while,
1632# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001633 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1634 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001635 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001636 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001637
Andy Whitcroft8905a672007-11-28 16:21:06 -08001638# open braces for enum, union and struct go on the same line.
1639 if ($line =~ /^.\s*{/ &&
1640 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1641 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1642 }
1643
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001644# check for spacing round square brackets; allowed:
1645# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001646# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1647# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001648 while ($line =~ /(.*?\s)\[/g) {
1649 my ($where, $prefix) = ($-[1], $1);
1650 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001651 ($where != 0 || $prefix !~ /^.\s+$/) &&
1652 $prefix !~ /{\s+$/) {
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001653 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1654 }
1655 }
1656
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001657# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001658 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001659 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001660 my $ctx_before = substr($line, 0, $-[1]);
1661 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001662
1663 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001664 if ($name =~ /^(?:
1665 if|for|while|switch|return|case|
1666 volatile|__volatile__|
1667 __attribute__|format|__extension__|
1668 asm|__asm__)$/x)
1669 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001670
1671 # cpp #define statements have non-optional spaces, ie
1672 # if there is a space between the name and the open
1673 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001674 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001675
1676 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001677 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001678
1679 # If this whole things ends with a type its most
1680 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001681 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001682
1683 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001684 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001685 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001686 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001687# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001688 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001689 my $ops = qr{
1690 <<=|>>=|<=|>=|==|!=|
1691 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1692 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001693 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1694 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001695 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001696 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001697 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001698
1699 my $blank = copy_spacing($opline);
1700
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001701 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001702 $off += length($elements[$n]);
1703
Andy Whitcroft773647a2008-03-28 14:15:58 -07001704 # Pick up the preceeding and succeeding characters.
1705 my $ca = substr($opline, 0, $off);
1706 my $cc = '';
1707 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1708 $cc = substr($opline, $off + length($elements[$n + 1]));
1709 }
1710 my $cb = "$ca$;$cc";
1711
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001712 my $a = '';
1713 $a = 'V' if ($elements[$n] ne '');
1714 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001715 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001716 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1717 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07001718 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001719
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001720 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001721
1722 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001723 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001724 $c = 'V' if ($elements[$n + 2] ne '');
1725 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001726 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001727 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1728 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001729 $c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001730 } else {
1731 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001732 }
1733
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001734 my $ctx = "${a}x${c}";
1735
1736 my $at = "(ctx:$ctx)";
1737
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001738 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001739 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001740
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001741 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001742 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001743
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001744 # Get the full operator variant.
1745 my $opv = $op . substr($curr_vars, $off, 1);
1746
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001747 # Ignore operators passed as parameters.
1748 if ($op_type ne 'V' &&
1749 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1750
Andy Whitcroftcf655042008-03-04 14:28:20 -08001751# # Ignore comments
1752# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001753
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001754 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001755 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001756 if ($ctx !~ /.x[WEBC]/ &&
1757 $cc !~ /^\\/ && $cc !~ /^;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001758 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001759 }
1760
1761 # // is a comment
1762 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001763
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001764 # No spaces for:
1765 # ->
1766 # : when part of a bitfield
1767 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001768 if ($ctx =~ /Wx.|.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001769 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001770 }
1771
1772 # , must have a space on the right.
1773 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001774 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001775 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001776 }
1777
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001778 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001779 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001780 #warn "'*' is part of type\n";
1781
1782 # unary operators should have a space before and
1783 # none after. May be left adjacent to another
1784 # unary operator, or a cast
1785 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001786 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07001787 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001788 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001789 ERROR("space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001790 }
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001791 if ($op eq '*' && $cc =~/\s*const\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001792 # A unary '*' may be const
1793
1794 } elsif ($ctx =~ /.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001795 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001796 }
1797
1798 # unary ++ and unary -- are allowed no space on one side.
1799 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001800 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1801 ERROR("space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001802 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001803 if ($ctx =~ /Wx[BE]/ ||
1804 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1805 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001806 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001807 if ($ctx =~ /ExW/) {
1808 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1809 }
1810
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001811
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001812 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001813 } elsif ($op eq '<<' or $op eq '>>' or
1814 $op eq '&' or $op eq '^' or $op eq '|' or
1815 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001816 $op eq '*' or $op eq '/' or
1817 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001818 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001819 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001820 ERROR("need consistent spacing around '$op' $at\n" .
1821 $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001822 }
1823
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001824 # A colon needs no spaces before when it is
1825 # terminating a case value or a label.
1826 } elsif ($opv eq ':C' || $opv eq ':L') {
1827 if ($ctx =~ /Wx./) {
1828 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1829 }
1830
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001831 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08001832 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001833 my $ok = 0;
1834
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001835 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001836 if (($op eq '<' &&
1837 $cc =~ /^\S+\@\S+>/) ||
1838 ($op eq '>' &&
1839 $ca =~ /<\S+\@\S+$/))
1840 {
1841 $ok = 1;
1842 }
1843
1844 # Ignore ?:
1845 if (($opv eq ':O' && $ca =~ /\?$/) ||
1846 ($op eq '?' && $cc =~ /^:/)) {
1847 $ok = 1;
1848 }
1849
1850 if ($ok == 0) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001851 ERROR("spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001852 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001853 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001854 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001855 }
1856 }
1857
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001858# check for multiple assignments
1859 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001860 CHK("multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001861 }
1862
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001863## # check for multiple declarations, allowing for a function declaration
1864## # continuation.
1865## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
1866## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
1867##
1868## # Remove any bracketed sections to ensure we do not
1869## # falsly report the parameters of functions.
1870## my $ln = $line;
1871## while ($ln =~ s/\([^\(\)]*\)//g) {
1872## }
1873## if ($ln =~ /,/) {
1874## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
1875## }
1876## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001877
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001878#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001879 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
1880 $line =~ /do{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001881 ERROR("space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001882 }
1883
1884# closing brace should have a space following it when it has anything
1885# on the line
1886 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001887 ERROR("space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001888 }
1889
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001890# check spacing on square brackets
1891 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001892 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001893 }
1894 if ($line =~ /\s\]/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001895 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001896 }
1897
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001898# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001899 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
1900 $line !~ /for\s*\(\s+;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001901 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001902 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001903 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001904 $line !~ /for\s*\(.*;\s+\)/ &&
1905 $line !~ /:\s+\)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001906 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001907 }
1908
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001909#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001910 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001911 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001912 WARN("labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001913 }
1914
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001915# Return is not a function.
1916 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
1917 my $spacing = $1;
1918 my $value = $2;
1919
1920 # Flatten any parentheses and braces
Andy Whitcroftfee61c42008-07-23 21:28:56 -07001921 $value =~ s/\)\(/\) \(/g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001922 while ($value =~ s/\([^\(\)]*\)/1/) {
1923 }
1924
1925 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
1926 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
1927
1928 } elsif ($spacing !~ /\s+/) {
1929 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1930 }
1931 }
1932
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001933# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001934 if ($line=~/\b(if|while|for|switch)\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001935 ERROR("space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001936 }
1937
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001938# Check for illegal assignment in if conditional -- and check for trailing
1939# statements after the conditional.
Andy Whitcroft53210162008-07-23 21:29:03 -07001940 if ($line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001941 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001942
1943 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001944 ERROR("do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001945 }
1946
1947 # Find out what is on the end of the line after the
1948 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001949 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001950 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001951 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07001952 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
1953 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001954 {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001955 ERROR("trailing statements should be on next line\n" . $herecurr);
1956 }
1957 }
1958
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001959# Check for bitwise tests written as boolean
1960 if ($line =~ /
1961 (?:
1962 (?:\[|\(|\&\&|\|\|)
1963 \s*0[xX][0-9]+\s*
1964 (?:\&\&|\|\|)
1965 |
1966 (?:\&\&|\|\|)
1967 \s*0[xX][0-9]+\s*
1968 (?:\&\&|\|\||\)|\])
1969 )/x)
1970 {
1971 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
1972 }
1973
Andy Whitcroft8905a672007-11-28 16:21:06 -08001974# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001975 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
1976 my $s = $1;
1977 $s =~ s/$;//g; # Remove any comments
1978 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
1979 ERROR("trailing statements should be on next line\n" . $herecurr);
1980 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001981 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07001982# case and default should not have general statements after them
1983 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
1984 $line !~ /\G(?:
1985 (?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
1986 \s*return\s+
1987 )/xg)
1988 {
1989 ERROR("trailing statements should be on next line\n" . $herecurr);
1990 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001991
1992 # Check for }<nl>else {, these must be at the same
1993 # indent level to be relevant to each other.
1994 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
1995 $previndent == $indent) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001996 ERROR("else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001997 }
1998
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001999 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2000 $previndent == $indent) {
2001 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2002
2003 # Find out what is on the end of the line after the
2004 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002005 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002006 $s =~ s/\n.*//g;
2007
2008 if ($s =~ /^\s*;/) {
2009 ERROR("while should follow close brace '}'\n" . $hereprev);
2010 }
2011 }
2012
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002013#studly caps, commented out until figure out how to distinguish between use of existing and adding new
2014# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2015# print "No studly caps, use _\n";
2016# print "$herecurr";
2017# $clean = 0;
2018# }
2019
2020#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002021 if ($line=~/\#\s*define.*\\\s$/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002022 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002023 }
2024
Andy Whitcroft653d4872007-06-23 17:16:34 -07002025#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002026 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002027 my $file = "$1.h";
2028 my $checkfile = "include/linux/$file";
2029 if (-f "$root/$checkfile" &&
2030 $realfile ne $checkfile &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002031 $1 ne 'irq')
2032 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002033 if ($realfile =~ m{^arch/}) {
2034 CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2035 } else {
2036 WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2037 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002038 }
2039 }
2040
Andy Whitcroft653d4872007-06-23 17:16:34 -07002041# multi-statement macros should be enclosed in a do while loop, grab the
2042# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08002043# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07002044 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2045 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002046 my $ln = $linenr;
2047 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002048 my ($off, $dstat, $dcond, $rest);
2049 my $ctx = '';
Andy Whitcroft653d4872007-06-23 17:16:34 -07002050
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002051 my $args = defined($1);
2052
2053 # Find the end of the macro and limit our statement
2054 # search to that.
2055 while ($cnt > 0 && defined $lines[$ln - 1] &&
2056 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2057 {
2058 $ctx .= $rawlines[$ln - 1] . "\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002059 $cnt-- if ($lines[$ln - 1] !~ /^-/);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002060 $ln++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002061 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002062 $ctx .= $rawlines[$ln - 1];
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002063
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002064 ($dstat, $dcond, $ln, $cnt, $off) =
2065 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2066 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002067 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002068
2069 # Extract the remainder of the define (if any) and
2070 # rip off surrounding spaces, and trailing \'s.
2071 $rest = '';
Andy Whitcroft636d1402008-10-15 22:02:18 -07002072 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2073 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002074 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2075 $rest .= substr($lines[$ln - 1], $off) . "\n";
2076 $cnt--;
2077 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002078 $ln++;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002079 $off = 0;
2080 }
2081 $rest =~ s/\\\n.//g;
2082 $rest =~ s/^\s*//s;
2083 $rest =~ s/\s*$//s;
2084
2085 # Clean up the original statement.
2086 if ($args) {
2087 substr($dstat, 0, length($dcond), '');
2088 } else {
2089 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2090 }
Andy Whitcroft292f1a92008-07-23 21:29:11 -07002091 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002092 $dstat =~ s/\\\n.//g;
2093 $dstat =~ s/^\s*//s;
2094 $dstat =~ s/\s*$//s;
2095
2096 # Flatten any parentheses and braces
2097 while ($dstat =~ s/\([^\(\)]*\)/1/) {
2098 }
2099 while ($dstat =~ s/\{[^\{\}]*\}/1/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002100 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002101
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002102 my $exceptions = qr{
2103 $Declare|
2104 module_param_named|
2105 MODULE_PARAM_DESC|
2106 DECLARE_PER_CPU|
2107 DEFINE_PER_CPU|
2108 __typeof__\(
2109 }x;
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002110 #print "REST<$rest>\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002111 if ($rest ne '') {
2112 if ($rest !~ /while\s*\(/ &&
2113 $dstat !~ /$exceptions/)
2114 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002115 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 -07002116 }
2117
2118 } elsif ($ctx !~ /;/) {
2119 if ($dstat ne '' &&
2120 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2121 $dstat !~ /$exceptions/ &&
2122 $dstat =~ /$Operators/)
2123 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002124 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002125 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002126 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002127 }
2128
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002129# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002130 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2131 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08002132 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002133 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002134 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2135 if ($#chunks > 0 && $level == 0) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002136 my $allowed = 0;
2137 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002138 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002139 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002140 for my $chunk (@chunks) {
2141 my ($cond, $block) = @{$chunk};
2142
Andy Whitcroft773647a2008-03-28 14:15:58 -07002143 # If the condition carries leading newlines, then count those as offsets.
2144 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2145 my $offset = statement_rawlines($whitespace) - 1;
2146
2147 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2148
2149 # We have looked at and allowed this specific line.
2150 $suppress_ifbraces{$ln + $offset} = 1;
2151
2152 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002153 $ln += statement_rawlines($block) - 1;
2154
Andy Whitcroft773647a2008-03-28 14:15:58 -07002155 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002156
2157 $seen++ if ($block =~ /^\s*{/);
2158
Andy Whitcroftcf655042008-03-04 14:28:20 -08002159 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2160 if (statement_lines($cond) > 1) {
2161 #print "APW: ALLOWED: cond<$cond>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002162 $allowed = 1;
2163 }
2164 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002165 #print "APW: ALLOWED: block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002166 $allowed = 1;
2167 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002168 if (statement_block_size($block) > 1) {
2169 #print "APW: ALLOWED: lines block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002170 $allowed = 1;
2171 }
2172 }
2173 if ($seen && !$allowed) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002174 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002175 }
2176 }
2177 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002178 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002179 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002180 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002181
Andy Whitcroftcf655042008-03-04 14:28:20 -08002182 # Check the pre-context.
2183 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2184 #print "APW: ALLOWED: pre<$1>\n";
2185 $allowed = 1;
2186 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002187
2188 my ($level, $endln, @chunks) =
2189 ctx_statement_full($linenr, $realcnt, $-[0]);
2190
Andy Whitcroftcf655042008-03-04 14:28:20 -08002191 # Check the condition.
2192 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07002193 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002194 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002195 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08002196 }
2197 if (statement_lines($cond) > 1) {
2198 #print "APW: ALLOWED: cond<$cond>\n";
2199 $allowed = 1;
2200 }
2201 if ($block =~/\b(?:if|for|while)\b/) {
2202 #print "APW: ALLOWED: block<$block>\n";
2203 $allowed = 1;
2204 }
2205 if (statement_block_size($block) > 1) {
2206 #print "APW: ALLOWED: lines block<$block>\n";
2207 $allowed = 1;
2208 }
2209 # Check the post-context.
2210 if (defined $chunks[1]) {
2211 my ($cond, $block) = @{$chunks[1]};
2212 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002213 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002214 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002215 if ($block =~ /^\s*\{/) {
2216 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2217 $allowed = 1;
2218 }
2219 }
2220 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2221 my $herectx = $here . "\n";;
Andy Whitcroftf0556632008-10-15 22:02:23 -07002222 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002223
Andy Whitcroftf0556632008-10-15 22:02:23 -07002224 for (my $n = 0; $n < $cnt; $n++) {
2225 $herectx .= raw_line($linenr, $n) . "\n";;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002226 }
2227
2228 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002229 }
2230 }
2231
Andy Whitcroft653d4872007-06-23 17:16:34 -07002232# don't include deprecated include files (uses RAW line)
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002233 for my $inc (@dep_includes) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002234 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002235 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002236 }
2237 }
2238
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002239# don't use deprecated functions
2240 for my $func (@dep_functions) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002241 if ($line =~ /\b$func\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002242 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002243 }
2244 }
2245
2246# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002247 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2248 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002249 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002250 }
2251
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002252# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2253 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2254 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2255 }
2256
Andy Whitcroft00df3442007-06-08 13:47:06 -07002257# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002258 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002259 CHK("if this code is redundant consider removing it\n" .
2260 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002261 }
2262
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002263# check for needless kfree() checks
2264 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2265 my $expr = $1;
2266 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
Wolfram Sang3c232142008-07-23 21:29:05 -07002267 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002268 }
2269 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07002270# check for needless usb_free_urb() checks
2271 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2272 my $expr = $1;
2273 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2274 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2275 }
2276 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002277
Andy Whitcroft00df3442007-06-08 13:47:06 -07002278# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002279# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002280# print "#ifdef in C files should be avoided\n";
2281# print "$herecurr";
2282# $clean = 0;
2283# }
2284
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002285# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002286 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002287 ERROR("exactly one space required after that #$1\n" . $herecurr);
2288 }
2289
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002290# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002291 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2292 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002293 my $which = $1;
2294 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002295 CHK("$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002296 }
2297 }
2298# check for memory barriers without a comment.
2299 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2300 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002301 CHK("memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002302 }
2303 }
2304# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002305 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002306 CHK("architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002307 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002308
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002309# check the location of the inline attribute, that it is between
2310# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002311 if ($line =~ /\b$Type\s+$Inline\b/ ||
2312 $line =~ /\b$Inline\s+$Storage\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002313 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2314 }
2315
Andy Whitcroft8905a672007-11-28 16:21:06 -08002316# Check for __inline__ and __inline, prefer inline
2317 if ($line =~ /\b(__inline__|__inline)\b/) {
2318 WARN("plain inline is preferred over $1\n" . $herecurr);
2319 }
2320
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002321# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002322 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002323 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002324 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002325 my $function_name = $1;
2326 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002327
2328 my $s = $stat;
2329 if (defined $cond) {
2330 substr($s, 0, length($cond), '');
2331 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002332 if ($s =~ /^\s*;/ &&
2333 $function_name ne 'uninitialized_var')
2334 {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002335 WARN("externs should be avoided in .c files\n" . $herecurr);
2336 }
2337
2338 if ($paren_space =~ /\n/) {
2339 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2340 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002341
2342 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2343 $stat =~ /^.\s*extern\s+/)
2344 {
2345 WARN("externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002346 }
2347
2348# checks for new __setup's
2349 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2350 my $name = $1;
2351
2352 if (!grep(/$name/, @setup_docs)) {
2353 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2354 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002355 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002356
2357# check for pointless casting of kmalloc return
2358 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2359 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2360 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002361
2362# check for gcc specific __FUNCTION__
2363 if ($line =~ /__FUNCTION__/) {
2364 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2365 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002366
2367# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002368 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002369 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2370 }
2371# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002372 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002373 WARN("consider using a completion\n" . $herecurr);
2374 }
2375# recommend strict_strto* over simple_strto*
2376 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2377 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2378 }
Michael Ellermanf3db6632008-07-23 21:28:57 -07002379# check for __initcall(), use device_initcall() explicitly please
2380 if ($line =~ /^.\s*__initcall\s*\(/) {
2381 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2382 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002383
2384# use of NR_CPUS is usually wrong
2385# ignore definitions of NR_CPUS and usage to define arrays as likely right
2386 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002387 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2388 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002389 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2390 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2391 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002392 {
2393 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2394 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002395
2396# check for %L{u,d,i} in strings
2397 my $string;
2398 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2399 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07002400 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002401 if ($string =~ /(?<!%)%L[udi]/) {
2402 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2403 last;
2404 }
2405 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002406 }
2407
2408 # If we have no input at all, then there is nothing to report on
2409 # so just keep quiet.
2410 if ($#rawlines == -1) {
2411 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002412 }
2413
Andy Whitcroft8905a672007-11-28 16:21:06 -08002414 # In mailback mode only produce a report in the negative, for
2415 # things that appear to be patches.
2416 if ($mailback && ($clean == 1 || !$is_patch)) {
2417 exit(0);
2418 }
2419
2420 # This is not a patch, and we are are in 'no-patch' mode so
2421 # just keep quiet.
2422 if (!$chk_patch && !$is_patch) {
2423 exit(0);
2424 }
2425
2426 if (!$is_patch) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002427 ERROR("Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002428 }
2429 if ($is_patch && $chk_signoff && $signoff == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002430 ERROR("Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002431 }
2432
Andy Whitcroft8905a672007-11-28 16:21:06 -08002433 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002434 if ($summary && !($clean == 1 && $quiet == 1)) {
2435 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002436 print "total: $cnt_error errors, $cnt_warn warnings, " .
2437 (($check)? "$cnt_chk checks, " : "") .
2438 "$cnt_lines lines checked\n";
2439 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002440 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002441
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002442 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002443 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002444 }
2445 if ($clean == 0 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002446 print "$vname has style problems, please review. If any of these errors\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002447 print "are false positives report them to the maintainer, see\n";
2448 print "CHECKPATCH in MAINTAINERS.\n";
2449 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002450
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002451 return $clean;
2452}