blob: 850783674278e095c3421cb99ffd0db70220f13d [file] [log] [blame]
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesf4432c52008-10-20 13:31:45 -04002# (c) 2001, Dave Jones. <davej@redhat.com> (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004# (c) 2007, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite, etc)
5# Licensed under the terms of the GNU GPL License version 2
6
7use strict;
8
9my $P = $0;
Andy Whitcroft00df3442007-06-08 13:47:06 -070010$P =~ s@.*/@@g;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070011
Andy Whitcroft6e144ee2008-10-15 22:02:36 -070012my $V = '0.24';
Andy Whitcroft0a920b52007-06-01 00:46:48 -070013
14use Getopt::Long qw(:config no_auto_abbrev);
15
16my $quiet = 0;
17my $tree = 1;
18my $chk_signoff = 1;
19my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070020my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070021my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080022my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070023my $file = 0;
24my $check = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080025my $summary = 1;
26my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080027my $summary_file = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070028my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080029my %debug;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070030GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070031 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-06-01 00:46:48 -070032 'tree!' => \$tree,
33 'signoff!' => \$chk_signoff,
34 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070035 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -080036 'terse!' => \$terse,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070037 'file!' => \$file,
38 'subjective!' => \$check,
39 'strict!' => \$check,
40 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -080041 'summary!' => \$summary,
42 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -080043 'summary-file!' => \$summary_file,
44
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080045 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -070046 'test-only=s' => \$tst_only,
Andy Whitcroft0a920b52007-06-01 00:46:48 -070047) or exit;
48
49my $exit = 0;
50
51if ($#ARGV < 0) {
Andy Whitcroft00df3442007-06-08 13:47:06 -070052 print "usage: $P [options] patchfile\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -070053 print "version: $V\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -080054 print "options: -q => quiet\n";
55 print " --no-tree => run without a kernel tree\n";
56 print " --terse => one line per report\n";
57 print " --emacs => emacs compile window format\n";
58 print " --file => check a source file\n";
59 print " --strict => enable more subjective tests\n";
60 print " --root => path to the kernel tree root\n";
61 print " --no-summary => suppress the per-file summary\n";
62 print " --summary-file => include the filename in summary\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -070063 exit(1);
64}
65
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080066my $dbg_values = 0;
67my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -070068my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -070069my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080070for my $key (keys %debug) {
71 eval "\${dbg_$key} = '$debug{$key}';"
72}
73
Andy Whitcroft8905a672007-11-28 16:21:06 -080074if ($terse) {
75 $emacs = 1;
76 $quiet++;
77}
78
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070079if ($tree) {
80 if (defined $root) {
81 if (!top_of_kernel_tree($root)) {
82 die "$P: $root: --root does not point at a valid tree\n";
83 }
84 } else {
85 if (top_of_kernel_tree('.')) {
86 $root = '.';
87 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
88 top_of_kernel_tree($1)) {
89 $root = $1;
90 }
91 }
92
93 if (!defined $root) {
94 print "Must be run from the top-level dir. of a kernel tree\n";
95 exit(2);
96 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -070097}
98
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070099my $emitted_corrupt = 0;
100
101our $Ident = qr{[A-Za-z_][A-Za-z\d_]*};
102our $Storage = qr{extern|static|asmlinkage};
103our $Sparse = qr{
104 __user|
105 __kernel|
106 __force|
107 __iomem|
108 __must_check|
109 __init_refok|
Andy Whitcroftcf655042008-03-04 14:28:20 -0800110 __kprobes
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700111 }x;
112our $Attribute = qr{
113 const|
114 __read_mostly|
115 __kprobes|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700116 __(?:mem|cpu|dev|)(?:initdata|init)|
117 ____cacheline_aligned|
118 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800119 ____cacheline_internodealigned_in_smp|
120 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700121 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700122our $Modifier;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700123our $Inline = qr{inline|__always_inline|noinline};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700124our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
125our $Lval = qr{$Ident(?:$Member)*};
126
127our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
128our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
129our $Operators = qr{
130 <=|>=|==|!=|
131 =>|->|<<|>>|<|>|!|~|
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800132 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700133 }x;
134
Andy Whitcroft8905a672007-11-28 16:21:06 -0800135our $NonptrType;
136our $Type;
137our $Declare;
138
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700139our $UTF8 = qr {
140 [\x09\x0A\x0D\x20-\x7E] # ASCII
141 | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
142 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
143 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
144 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
145 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
146 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
147 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
148}x;
149
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700150our $typeTypedefs = qr{(?x:
151 (?:__)?(?:u|s|be|le)(?:\d|\d\d)|
152 atomic_t
153)};
154
Andy Whitcroft8905a672007-11-28 16:21:06 -0800155our @typeList = (
156 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700157 qr{(?:unsigned\s+)?char},
158 qr{(?:unsigned\s+)?short},
159 qr{(?:unsigned\s+)?int},
160 qr{(?:unsigned\s+)?long},
161 qr{(?:unsigned\s+)?long\s+int},
162 qr{(?:unsigned\s+)?long\s+long},
163 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800164 qr{unsigned},
165 qr{float},
166 qr{double},
167 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800168 qr{struct\s+$Ident},
169 qr{union\s+$Ident},
170 qr{enum\s+$Ident},
171 qr{${Ident}_t},
172 qr{${Ident}_handler},
173 qr{${Ident}_handler_fn},
174);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700175our @modifierList = (
176 qr{fastcall},
177);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800178
179sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700180 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
181 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700182 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800183 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700184 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800185 (?:
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700186 (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700187 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700188 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800189 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700190 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800191 }x;
192 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700193 $NonptrType
Andy Whitcroft65863862009-01-06 14:41:21 -0800194 (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700195 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800196 }x;
197 $Declare = qr{(?:$Storage\s+)?$Type};
198}
199build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700200
201$chk_signoff = 0 if ($file);
202
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700203my @dep_includes = ();
204my @dep_functions = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700205my $removal = "Documentation/feature-removal-schedule.txt";
206if ($tree && -f "$root/$removal") {
207 open(REMOVE, "<$root/$removal") ||
208 die "$P: $removal: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700209 while (<REMOVE>) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700210 if (/^Check:\s+(.*\S)/) {
211 for my $entry (split(/[, ]+/, $1)) {
212 if ($entry =~ m@include/(.*)@) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700213 push(@dep_includes, $1);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700214
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700215 } elsif ($entry !~ m@/@) {
216 push(@dep_functions, $entry);
217 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700218 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700219 }
220 }
221}
222
Andy Whitcroft00df3442007-06-08 13:47:06 -0700223my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800224my @lines = ();
225my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700226for my $filename (@ARGV) {
227 if ($file) {
228 open(FILE, "diff -u /dev/null $filename|") ||
229 die "$P: $filename: diff failed - $!\n";
230 } else {
231 open(FILE, "<$filename") ||
232 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700233 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800234 if ($filename eq '-') {
235 $vname = 'Your patch';
236 } else {
237 $vname = $filename;
238 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700239 while (<FILE>) {
240 chomp;
241 push(@rawlines, $_);
242 }
243 close(FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800244 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700245 $exit = 1;
246 }
247 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800248 @lines = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700249}
250
251exit($exit);
252
253sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700254 my ($root) = @_;
255
256 my @tree_check = (
257 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
258 "README", "Documentation", "arch", "include", "drivers",
259 "fs", "init", "ipc", "kernel", "lib", "scripts",
260 );
261
262 foreach my $check (@tree_check) {
263 if (! -e $root . '/' . $check) {
264 return 0;
265 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700266 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700267 return 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700268}
269
270sub expand_tabs {
271 my ($str) = @_;
272
273 my $res = '';
274 my $n = 0;
275 for my $c (split(//, $str)) {
276 if ($c eq "\t") {
277 $res .= ' ';
278 $n++;
279 for (; ($n % 8) != 0; $n++) {
280 $res .= ' ';
281 }
282 next;
283 }
284 $res .= $c;
285 $n++;
286 }
287
288 return $res;
289}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700290sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700291 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700292 return $res;
293}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700294
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700295sub line_stats {
296 my ($line) = @_;
297
298 # Drop the diff line leader and expand tabs
299 $line =~ s/^.//;
300 $line = expand_tabs($line);
301
302 # Pick the indent from the front of the line.
303 my ($white) = ($line =~ /^(\s*)/);
304
305 return (length($line), length($white));
306}
307
Andy Whitcroft773647a2008-03-28 14:15:58 -0700308my $sanitise_quote = '';
309
310sub sanitise_line_reset {
311 my ($in_comment) = @_;
312
313 if ($in_comment) {
314 $sanitise_quote = '*/';
315 } else {
316 $sanitise_quote = '';
317 }
318}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700319sub sanitise_line {
320 my ($line) = @_;
321
322 my $res = '';
323 my $l = '';
324
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800325 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700326 my $off = 0;
327 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700328
Andy Whitcroft773647a2008-03-28 14:15:58 -0700329 # Always copy over the diff marker.
330 $res = substr($line, 0, 1);
331
332 for ($off = 1; $off < length($line); $off++) {
333 $c = substr($line, $off, 1);
334
335 # Comments we are wacking completly including the begin
336 # and end, all to $;.
337 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
338 $sanitise_quote = '*/';
339
340 substr($res, $off, 2, "$;$;");
341 $off++;
342 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800343 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700344 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700345 $sanitise_quote = '';
346 substr($res, $off, 2, "$;$;");
347 $off++;
348 next;
349 }
350
351 # A \ in a string means ignore the next character.
352 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
353 $c eq "\\") {
354 substr($res, $off, 2, 'XX');
355 $off++;
356 next;
357 }
358 # Regular quotes.
359 if ($c eq "'" || $c eq '"') {
360 if ($sanitise_quote eq '') {
361 $sanitise_quote = $c;
362
363 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700364 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700365 } elsif ($sanitise_quote eq $c) {
366 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700367 }
368 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700369
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800370 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700371 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
372 substr($res, $off, 1, $;);
373 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
374 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700375 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700376 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700377 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800378 }
379
380 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700381 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800382 my $clean = 'X' x length($1);
383 $res =~ s@\<.*\>@<$clean>@;
384
385 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700386 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800387 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700388 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800389 }
390
Andy Whitcroft00df3442007-06-08 13:47:06 -0700391 return $res;
392}
393
Andy Whitcroft8905a672007-11-28 16:21:06 -0800394sub ctx_statement_block {
395 my ($linenr, $remain, $off) = @_;
396 my $line = $linenr - 1;
397 my $blk = '';
398 my $soff = $off;
399 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700400 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800401
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800402 my $loff = 0;
403
Andy Whitcroft8905a672007-11-28 16:21:06 -0800404 my $type = '';
405 my $level = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800406 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800407 my $c;
408 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800409
410 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800411 while (1) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700412 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800413 # If we are about to drop off the end, pull in more
414 # context.
415 if ($off >= $len) {
416 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700417 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800418 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800419 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800420 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800421 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800422 $len = length($blk);
423 $line++;
424 last;
425 }
426 # Bail if there is no further context.
427 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800428 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800429 last;
430 }
431 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800432 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800433 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800434 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800435
Andy Whitcroft773647a2008-03-28 14:15:58 -0700436 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800437 # Statement ends at the ';' or a close '}' at the
438 # outermost level.
439 if ($level == 0 && $c eq ';') {
440 last;
441 }
442
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800443 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700444 if ($level == 0 && $coff_set == 0 &&
445 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
446 $remainder =~ /^(else)(?:\s|{)/ &&
447 $remainder !~ /^else\s+if\b/) {
448 $coff = $off + length($1) - 1;
449 $coff_set = 1;
450 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
451 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800452 }
453
Andy Whitcroft8905a672007-11-28 16:21:06 -0800454 if (($type eq '' || $type eq '(') && $c eq '(') {
455 $level++;
456 $type = '(';
457 }
458 if ($type eq '(' && $c eq ')') {
459 $level--;
460 $type = ($level != 0)? '(' : '';
461
462 if ($level == 0 && $coff < $soff) {
463 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700464 $coff_set = 1;
465 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800466 }
467 }
468 if (($type eq '' || $type eq '{') && $c eq '{') {
469 $level++;
470 $type = '{';
471 }
472 if ($type eq '{' && $c eq '}') {
473 $level--;
474 $type = ($level != 0)? '{' : '';
475
476 if ($level == 0) {
477 last;
478 }
479 }
480 $off++;
481 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700482 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800483 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700484 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800485 $line++;
486 $remain--;
487 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800488
489 my $statement = substr($blk, $soff, $off - $soff + 1);
490 my $condition = substr($blk, $soff, $coff - $soff + 1);
491
492 #warn "STATEMENT<$statement>\n";
493 #warn "CONDITION<$condition>\n";
494
Andy Whitcroft773647a2008-03-28 14:15:58 -0700495 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800496
497 return ($statement, $condition,
498 $line, $remain + 1, $off - $loff + 1, $level);
499}
500
Andy Whitcroftcf655042008-03-04 14:28:20 -0800501sub statement_lines {
502 my ($stmt) = @_;
503
504 # Strip the diff line prefixes and rip blank lines at start and end.
505 $stmt =~ s/(^|\n)./$1/g;
506 $stmt =~ s/^\s*//;
507 $stmt =~ s/\s*$//;
508
509 my @stmt_lines = ($stmt =~ /\n/g);
510
511 return $#stmt_lines + 2;
512}
513
514sub statement_rawlines {
515 my ($stmt) = @_;
516
517 my @stmt_lines = ($stmt =~ /\n/g);
518
519 return $#stmt_lines + 2;
520}
521
522sub statement_block_size {
523 my ($stmt) = @_;
524
525 $stmt =~ s/(^|\n)./$1/g;
526 $stmt =~ s/^\s*{//;
527 $stmt =~ s/}\s*$//;
528 $stmt =~ s/^\s*//;
529 $stmt =~ s/\s*$//;
530
531 my @stmt_lines = ($stmt =~ /\n/g);
532 my @stmt_statements = ($stmt =~ /;/g);
533
534 my $stmt_lines = $#stmt_lines + 2;
535 my $stmt_statements = $#stmt_statements + 1;
536
537 if ($stmt_lines > $stmt_statements) {
538 return $stmt_lines;
539 } else {
540 return $stmt_statements;
541 }
542}
543
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800544sub ctx_statement_full {
545 my ($linenr, $remain, $off) = @_;
546 my ($statement, $condition, $level);
547
548 my (@chunks);
549
Andy Whitcroftcf655042008-03-04 14:28:20 -0800550 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800551 ($statement, $condition, $linenr, $remain, $off, $level) =
552 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700553 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800554 push(@chunks, [ $condition, $statement ]);
555 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
556 return ($level, $linenr, @chunks);
557 }
558
559 # Pull in the following conditional/block pairs and see if they
560 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800561 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800562 ($statement, $condition, $linenr, $remain, $off, $level) =
563 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800564 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700565 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800566 #print "C: push\n";
567 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800568 }
569
570 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800571}
572
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700573sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700574 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700575 my $line;
576 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700577 my $blk = '';
578 my @o;
579 my @c;
580 my @res = ();
581
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700582 my $level = 0;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700583 for ($line = $start; $remain > 0; $line++) {
584 next if ($rawlines[$line] =~ /^-/);
585 $remain--;
586
587 $blk .= $rawlines[$line];
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700588 foreach my $c (split(//, $rawlines[$line])) {
589 ##print "C<$c>L<$level><$open$close>O<$off>\n";
590 if ($off > 0) {
591 $off--;
592 next;
593 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700594
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700595 if ($c eq $close && $level > 0) {
596 $level--;
597 last if ($level == 0);
598 } elsif ($c eq $open) {
599 $level++;
600 }
601 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700602
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700603 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700604 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700605 }
606
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700607 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700608 }
609
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700610 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700611}
612sub ctx_block_outer {
613 my ($linenr, $remain) = @_;
614
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700615 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
616 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700617}
618sub ctx_block {
619 my ($linenr, $remain) = @_;
620
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700621 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
622 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700623}
624sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700625 my ($linenr, $remain, $off) = @_;
626
627 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
628 return @r;
629}
630sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700631 my ($linenr, $remain) = @_;
632
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700633 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700634}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700635sub ctx_statement_level {
636 my ($linenr, $remain, $off) = @_;
637
638 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
639}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700640
641sub ctx_locate_comment {
642 my ($first_line, $end_line) = @_;
643
644 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700645 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700646 return $current_comment if (defined $current_comment);
647
648 # Look through the context and try and figure out if there is a
649 # comment.
650 my $in_comment = 0;
651 $current_comment = '';
652 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700653 my $line = $rawlines[$linenr - 1];
654 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700655 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
656 $in_comment = 1;
657 }
658 if ($line =~ m@/\*@) {
659 $in_comment = 1;
660 }
661 if (!$in_comment && $current_comment ne '') {
662 $current_comment = '';
663 }
664 $current_comment .= $line . "\n" if ($in_comment);
665 if ($line =~ m@\*/@) {
666 $in_comment = 0;
667 }
668 }
669
670 chomp($current_comment);
671 return($current_comment);
672}
673sub ctx_has_comment {
674 my ($first_line, $end_line) = @_;
675 my $cmt = ctx_locate_comment($first_line, $end_line);
676
Andy Whitcroft00df3442007-06-08 13:47:06 -0700677 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700678 ##print "CMMT: $cmt\n";
679
680 return ($cmt ne '');
681}
682
Andy Whitcroft4d001e42008-10-15 22:02:21 -0700683sub raw_line {
684 my ($linenr, $cnt) = @_;
685
686 my $offset = $linenr - 1;
687 $cnt++;
688
689 my $line;
690 while ($cnt) {
691 $line = $rawlines[$offset++];
692 next if (defined($line) && $line =~ /^-/);
693 $cnt--;
694 }
695
696 return $line;
697}
698
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700699sub cat_vet {
700 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700701 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700702
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700703 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700704 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
705 $res .= $1;
706 if ($2 ne '') {
707 $coded = sprintf("^%c", unpack('C', $2) + 64);
708 $res .= $coded;
709 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700710 }
711 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700712
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700713 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700714}
715
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800716my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800717my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800718my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700719my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800720
721sub annotate_reset {
722 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800723 $av_pending = '_';
724 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700725 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800726}
727
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700728sub annotate_values {
729 my ($stream, $type) = @_;
730
731 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700732 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700733 my $cur = $stream;
734
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800735 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700736
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700737 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700738 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800739 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700740 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700741 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800742 print "WS($1)\n" if ($dbg_values > 1);
743 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800744 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800745 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700746 }
747
Andy Whitcroft8ea3eb92008-07-23 21:29:08 -0700748 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800749 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700750 $type = 'T';
751
Andy Whitcroft389a2fe2008-07-23 21:29:05 -0700752 } elsif ($cur =~ /^($Modifier)\s*/) {
753 print "MODIFIER($1)\n" if ($dbg_values > 1);
754 $type = 'T';
755
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700756 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700757 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800758 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700759 push(@av_paren_type, $type);
760 if ($2 ne '') {
761 $av_pending = 'N';
762 }
763 $type = 'E';
764
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700765 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700766 print "UNDEF($1)\n" if ($dbg_values > 1);
767 $av_preprocessor = 1;
768 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700769
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700770 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800771 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800772 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800773
774 push(@av_paren_type, $type);
775 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700776 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800777
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700778 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800779 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
780 $av_preprocessor = 1;
781
782 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
783
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700784 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800785
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700786 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800787 print "PRE_END($1)\n" if ($dbg_values > 1);
788
789 $av_preprocessor = 1;
790
791 # Assume all arms of the conditional end as this
792 # one does, and continue as if the #endif was not here.
793 pop(@av_paren_type);
794 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700795 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700796
797 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800798 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700799
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700800 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
801 print "ATTR($1)\n" if ($dbg_values > 1);
802 $av_pending = $type;
803 $type = 'N';
804
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700805 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800806 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700807 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800808 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700809 }
810 $type = 'N';
811
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700812 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800813 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700814 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700815 $type = 'N';
816
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700817 } elsif ($cur =~/^(case)/o) {
818 print "CASE($1)\n" if ($dbg_values > 1);
819 $av_pend_colon = 'C';
820 $type = 'N';
821
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700822 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800823 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700824 $type = 'N';
825
826 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800827 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800828 push(@av_paren_type, $av_pending);
829 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700830 $type = 'N';
831
832 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800833 my $new_type = pop(@av_paren_type);
834 if ($new_type ne '_') {
835 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800836 print "PAREN('$1') -> $type\n"
837 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700838 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800839 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700840 }
841
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700842 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800843 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700844 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800845 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700846
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800847 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
848 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700849 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800850 } elsif ($type eq 'E') {
851 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700852 }
853 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
854 $type = 'V';
855
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700856 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800857 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700858 $type = 'V';
859
860 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800861 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700862 $type = 'N';
863
Andy Whitcroftcf655042008-03-04 14:28:20 -0800864 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800865 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800866 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700867 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800868
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800869 } elsif ($cur =~/^(,)/) {
870 print "COMMA($1)\n" if ($dbg_values > 1);
871 $type = 'C';
872
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700873 } elsif ($cur =~ /^(\?)/o) {
874 print "QUESTION($1)\n" if ($dbg_values > 1);
875 $type = 'N';
876
877 } elsif ($cur =~ /^(:)/o) {
878 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
879
880 substr($var, length($res), 1, $av_pend_colon);
881 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
882 $type = 'E';
883 } else {
884 $type = 'N';
885 }
886 $av_pend_colon = 'O';
887
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800888 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800889 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700890 $type = 'N';
891
Andy Whitcroft0d413862008-10-15 22:02:16 -0700892 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -0700893 my $variant;
894
895 print "OPV($1)\n" if ($dbg_values > 1);
896 if ($type eq 'V') {
897 $variant = 'B';
898 } else {
899 $variant = 'U';
900 }
901
902 substr($var, length($res), 1, $variant);
903 $type = 'N';
904
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700905 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800906 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700907 if ($1 ne '++' && $1 ne '--') {
908 $type = 'N';
909 }
910
911 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800912 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700913 }
914 if (defined $1) {
915 $cur = substr($cur, length($1));
916 $res .= $type x length($1);
917 }
918 }
919
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700920 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700921}
922
Andy Whitcroft8905a672007-11-28 16:21:06 -0800923sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800924 my ($possible, $line) = @_;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800925
Andy Whitcroft0776e592008-10-15 22:02:29 -0700926 print "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
927 if ($possible !~ /(?:
928 ^(?:
929 $Modifier|
930 $Storage|
931 $Type|
932 DEFINE_\S+|
933 goto|
934 return|
935 case|
936 else|
937 asm|__asm__|
938 do
939 )$|
940 ^(?:typedef|struct|enum)\b
941 )/x) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700942 # Check for modifiers.
943 $possible =~ s/\s*$Storage\s*//g;
944 $possible =~ s/\s*$Sparse\s*//g;
945 if ($possible =~ /^\s*$/) {
946
947 } elsif ($possible =~ /\s/) {
948 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -0700949 for my $modifier (split(' ', $possible)) {
950 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
951 push(@modifierList, $modifier);
952 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700953
954 } else {
955 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
956 push(@typeList, $possible);
957 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800958 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -0700959 } else {
960 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800961 }
962}
963
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700964my $prefix = '';
965
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700966sub report {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700967 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
968 return 0;
969 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800970 my $line = $prefix . $_[0];
971
972 $line = (split('\n', $line))[0] . "\n" if ($terse);
973
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800974 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700975
976 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700977}
978sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800979 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700980}
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700981sub ERROR {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700982 if (report("ERROR: $_[0]\n")) {
983 our $clean = 0;
984 our $cnt_error++;
985 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700986}
987sub WARN {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700988 if (report("WARNING: $_[0]\n")) {
989 our $clean = 0;
990 our $cnt_warn++;
991 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700992}
993sub CHK {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700994 if ($check && report("CHECK: $_[0]\n")) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700995 our $clean = 0;
996 our $cnt_chk++;
997 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700998}
999
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001000sub check_absolute_file {
1001 my ($absolute, $herecurr) = @_;
1002 my $file = $absolute;
1003
1004 ##print "absolute<$absolute>\n";
1005
1006 # See if any suffix of this path is a path within the tree.
1007 while ($file =~ s@^[^/]*/@@) {
1008 if (-f "$root/$file") {
1009 ##print "file<$file>\n";
1010 last;
1011 }
1012 }
1013 if (! -f _) {
1014 return 0;
1015 }
1016
1017 # It is, so see if the prefix is acceptable.
1018 my $prefix = $absolute;
1019 substr($prefix, -length($file)) = '';
1020
1021 ##print "prefix<$prefix>\n";
1022 if ($prefix ne ".../") {
1023 WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr);
1024 }
1025}
1026
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001027sub process {
1028 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001029
1030 my $linenr=0;
1031 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001032 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001033 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001034 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001035
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001036 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001037 my $indent;
1038 my $previndent=0;
1039 my $stashindent=0;
1040
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001041 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001042 my $signoff = 0;
1043 my $is_patch = 0;
1044
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001045 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001046 our $cnt_lines = 0;
1047 our $cnt_error = 0;
1048 our $cnt_warn = 0;
1049 our $cnt_chk = 0;
1050
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001051 # Trace the real file/line as we go.
1052 my $realfile = '';
1053 my $realline = 0;
1054 my $realcnt = 0;
1055 my $here = '';
1056 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001057 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001058 my $first_line = 0;
1059
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001060 my $prev_values = 'E';
1061
1062 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001063 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001064 my %suppress_whiletrailers;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001065
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001066 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001067 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001068 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001069 my @setup_docs = ();
1070 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001071
1072 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001073 my $line;
1074 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001075 $linenr++;
1076 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001077
Andy Whitcroft773647a2008-03-28 14:15:58 -07001078 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001079 $setup_docs = 0;
1080 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1081 $setup_docs = 1;
1082 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001083 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001084 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001085 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1086 $realline=$1-1;
1087 if (defined $2) {
1088 $realcnt=$3+1;
1089 } else {
1090 $realcnt=1+1;
1091 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001092 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001093
1094 # Guestimate if this is a continuing comment. Run
1095 # the context looking for a comment "edge". If this
1096 # edge is a close comment then we must be in a comment
1097 # at context start.
1098 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001099 my $cnt = $realcnt;
1100 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1101 next if (defined $rawlines[$ln - 1] &&
1102 $rawlines[$ln - 1] =~ /^-/);
1103 $cnt--;
1104 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001105 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001106 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1107 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1108 ($edge) = $1;
1109 last;
1110 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001111 }
1112 if (defined $edge && $edge eq '*/') {
1113 $in_comment = 1;
1114 }
1115
1116 # Guestimate if this is a continuing comment. If this
1117 # is the start of a diff block and this line starts
1118 # ' *' then it is very likely a comment.
1119 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001120 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001121 {
1122 $in_comment = 1;
1123 }
1124
1125 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1126 sanitise_line_reset($in_comment);
1127
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001128 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001129 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001130 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001131 $line = sanitise_line($rawline);
1132 }
1133 push(@lines, $line);
1134
1135 if ($realcnt > 1) {
1136 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1137 } else {
1138 $realcnt = 0;
1139 }
1140
1141 #print "==>$rawline\n";
1142 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001143
1144 if ($setup_docs && $line =~ /^\+/) {
1145 push(@setup_docs, $line);
1146 }
1147 }
1148
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001149 $prefix = '';
1150
Andy Whitcroft773647a2008-03-28 14:15:58 -07001151 $realcnt = 0;
1152 $linenr = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001153 foreach my $line (@lines) {
1154 $linenr++;
1155
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001156 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft306708542008-10-15 22:02:28 -07001157 my $hunk_line = ($realcnt != 0);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001158
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001159#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001160 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001161 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001162 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001163 $realline=$1-1;
1164 if (defined $2) {
1165 $realcnt=$3+1;
1166 } else {
1167 $realcnt=1+1;
1168 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001169 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001170 $prev_values = 'E';
1171
Andy Whitcroft773647a2008-03-28 14:15:58 -07001172 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001173 %suppress_whiletrailers = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001174 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001175
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001176# track the line number as we move through the hunk, note that
1177# new versions of GNU diff omit the leading space on completely
1178# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001179 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001180 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001181 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001182
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001183 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001184 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001185
1186 # Track the previous line.
1187 ($prevline, $stashline) = ($stashline, $line);
1188 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001189 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1190
Andy Whitcroft773647a2008-03-28 14:15:58 -07001191 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001192
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001193 } elsif ($realcnt == 1) {
1194 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001195 }
1196
1197#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001198 $prefix = "$filename:$realline: " if ($emacs && $file);
1199 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1200
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001201 $here = "#$linenr: " if (!$file);
1202 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001203
1204 # extract the filename as it passes
1205 if ($line=~/^\+\+\+\s+(\S+)/) {
1206 $realfile = $1;
1207 $realfile =~ s@^[^/]*/@@;
1208
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001209 if ($realfile =~ m@^include/asm/@) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001210 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1211 }
1212 next;
1213 }
1214
Randy Dunlap389834b2007-06-08 13:47:03 -07001215 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001216
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001217 my $hereline = "$here\n$rawline\n";
1218 my $herecurr = "$here\n$rawline\n";
1219 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001220
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001221 $cnt_lines++ if ($realcnt != 0);
1222
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001223#check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001224 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001225 # This is a signoff, if ugly, so do not double report.
1226 $signoff++;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001227 if (!($line =~ /^\s*Signed-off-by:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001228 WARN("Signed-off-by: is the preferred form\n" .
1229 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001230 }
1231 if ($line =~ /^\s*signed-off-by:\S/i) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001232 WARN("space required after Signed-off-by:\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001233 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001234 }
1235 }
1236
Andy Whitcroft00df3442007-06-08 13:47:06 -07001237# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001238 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001239 ERROR("patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001240 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001241 }
1242
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001243# Check for absolute kernel paths.
1244 if ($tree) {
1245 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1246 my $file = $1;
1247
1248 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1249 check_absolute_file($1, $herecurr)) {
1250 #
1251 } else {
1252 check_absolute_file($file, $herecurr);
1253 }
1254 }
1255 }
1256
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001257# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1258 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001259 $rawline !~ m/^$UTF8*$/) {
1260 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1261
1262 my $blank = copy_spacing($rawline);
1263 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1264 my $hereptr = "$hereline$ptr\n";
1265
1266 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001267 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001268
Andy Whitcroft306708542008-10-15 22:02:28 -07001269# ignore non-hunk lines and lines being removed
1270 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001271
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001272#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001273 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001274 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001275 ERROR("DOS line endings\n" . $herevet);
1276
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001277 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1278 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001279 ERROR("trailing whitespace\n" . $herevet);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001280 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07001281
1282# check we are in a valid source file if not then ignore this hunk
1283 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1284
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001285#80 column limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001286 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001287 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1288 $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1289 $length > 80)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001290 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001291 WARN("line over 80 characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001292 }
1293
Andy Whitcroft8905a672007-11-28 16:21:06 -08001294# check for adding lines without a newline.
1295 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1296 WARN("adding a line without newline at end of file\n" . $herecurr);
1297 }
1298
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001299# check we are in a valid source file C or perl if not then ignore this hunk
1300 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001301
1302# at the beginning of a line any tabs must come first and anything
1303# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001304 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1305 $rawline =~ /^\+\s* \s*/) {
1306 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001307 ERROR("code indent should use tabs where possible\n" . $herevet);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001308 }
1309
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001310# check we are in a valid C source file if not then ignore this hunk
1311 next if ($realfile !~ /\.(h|c)$/);
1312
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001313# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001314 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001315 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1316 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001317
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001318# Check for potential 'bare' types
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001319 my ($stat, $cond, $line_nr_next, $remain_next, $off_next);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001320 if ($realcnt && $line =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001321 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001322 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001323 $stat =~ s/\n./\n /g;
1324 $cond =~ s/\n./\n /g;
1325
1326 my $s = $stat;
1327 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001328
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001329 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001330 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001331
1332 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001333 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001334
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001335 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001336 } 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 -07001337 my $type = $1;
1338 $type =~ s/\s+/ /g;
1339 possible($type, "A:" . $s);
1340
Andy Whitcroft8905a672007-11-28 16:21:06 -08001341 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07001342 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001343 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001344 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001345
1346 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08001347 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001348 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001349 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001350
1351 # Check for any sort of function declaration.
1352 # int foo(something bar, other baz);
1353 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001354 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 -08001355 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001356
Andy Whitcroftcf655042008-03-04 14:28:20 -08001357 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001358 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001359 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001360
Andy Whitcroft8905a672007-11-28 16:21:06 -08001361 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001362 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001363
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001364 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001365 }
1366 }
1367 }
1368
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001369 }
1370
Andy Whitcroft653d4872007-06-23 17:16:34 -07001371#
1372# Checks which may be anchored in the context.
1373#
1374
1375# Check for switch () and associated case and default
1376# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07001377 if ($line=~/\bswitch\s*\(.*\)/) {
1378 my $err = '';
1379 my $sep = '';
1380 my @ctx = ctx_block_outer($linenr, $realcnt);
1381 shift(@ctx);
1382 for my $ctx (@ctx) {
1383 my ($clen, $cindent) = line_stats($ctx);
1384 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1385 $indent != $cindent) {
1386 $err .= "$sep$ctx\n";
1387 $sep = '';
1388 } else {
1389 $sep = "[...]\n";
1390 }
1391 }
1392 if ($err ne '') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001393 ERROR("switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001394 }
1395 }
1396
1397# if/while/etc brace do not go on next line, unless defining a do while loop,
1398# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001399 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001400 my $pre_ctx = "$1$2";
1401
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001402 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001403 my $ctx_cnt = $realcnt - $#ctx - 1;
1404 my $ctx = join("\n", @ctx);
1405
Andy Whitcroft548596d2008-07-23 21:29:01 -07001406 my $ctx_ln = $linenr;
1407 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001408
Andy Whitcroft548596d2008-07-23 21:29:01 -07001409 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1410 defined $lines[$ctx_ln - 1] &&
1411 $lines[$ctx_ln - 1] =~ /^-/)) {
1412 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1413 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001414 $ctx_ln++;
1415 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07001416
Andy Whitcroft53210162008-07-23 21:29:03 -07001417 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1418 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001419
1420 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1421 ERROR("that open brace { should be on the previous line\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001422 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07001423 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001424 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1425 $ctx =~ /\)\s*\;\s*$/ &&
1426 defined $lines[$ctx_ln - 1])
1427 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001428 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1429 if ($nindent > $indent) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001430 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001431 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001432 }
1433 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001434 }
1435
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001436# Check relative indent for conditionals and blocks.
1437 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1438 my ($s, $c) = ($stat, $cond);
1439
1440 substr($s, 0, length($c), '');
1441
1442 # Make sure we remove the line prefixes as we have
1443 # none on the first line, and are going to readd them
1444 # where necessary.
1445 $s =~ s/\n./\n/gs;
1446
1447 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07001448 my @newlines = ($c =~ /\n/gs);
1449 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001450
1451 # We want to check the first line inside the block
1452 # starting at the end of the conditional, so remove:
1453 # 1) any blank line termination
1454 # 2) any opening brace { on end of the line
1455 # 3) any do (...) {
1456 my $continuation = 0;
1457 my $check = 0;
1458 $s =~ s/^.*\bdo\b//;
1459 $s =~ s/^\s*{//;
1460 if ($s =~ s/^\s*\\//) {
1461 $continuation = 1;
1462 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001463 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001464 $check = 1;
1465 $cond_lines++;
1466 }
1467
1468 # Also ignore a loop construct at the end of a
1469 # preprocessor statement.
1470 if (($prevline =~ /^.\s*#\s*define\s/ ||
1471 $prevline =~ /\\\s*$/) && $continuation == 0) {
1472 $check = 0;
1473 }
1474
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001475 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07001476 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001477 while ($cond_ptr != $cond_lines) {
1478 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001479
Andy Whitcroftf16fa282008-10-15 22:02:32 -07001480 # If we see an #else/#elif then the code
1481 # is not linear.
1482 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1483 $check = 0;
1484 }
1485
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001486 # Ignore:
1487 # 1) blank lines, they should be at 0,
1488 # 2) preprocessor lines, and
1489 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07001490 if ($continuation ||
1491 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001492 $s =~ /^\s*#\s*?/ ||
1493 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07001494 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001495 $s =~ s/^.*?\n//;
1496 $cond_lines++;
1497 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001498 }
1499
1500 my (undef, $sindent) = line_stats("+" . $s);
1501 my $stat_real = raw_line($linenr, $cond_lines);
1502
1503 # Check if either of these lines are modified, else
1504 # this is not this patch's fault.
1505 if (!defined($stat_real) ||
1506 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1507 $check = 0;
1508 }
1509 if (defined($stat_real) && $cond_lines > 1) {
1510 $stat_real = "[...]\n$stat_real";
1511 }
1512
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001513 #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 -07001514
1515 if ($check && (($sindent % 8) != 0 ||
1516 ($sindent <= $indent && $s ne ''))) {
1517 WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1518 }
1519 }
1520
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001521 # Track the 'values' across context and added lines.
1522 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001523 my ($curr_values, $curr_vars) =
1524 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001525 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001526 if ($dbg_values) {
1527 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001528 print "$linenr > .$outline\n";
1529 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001530 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001531 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001532 $prev_values = substr($curr_values, -1);
1533
Andy Whitcroft00df3442007-06-08 13:47:06 -07001534#ignore lines not being added
1535 if ($line=~/^[^\+]/) {next;}
1536
Andy Whitcroft653d4872007-06-23 17:16:34 -07001537# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07001538 if ($dbg_type) {
1539 if ($line =~ /^.\s*$Declare\s*$/) {
1540 ERROR("TEST: is type\n" . $herecurr);
1541 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1542 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1543 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001544 next;
1545 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001546# TEST: allow direct testing of the attribute matcher.
1547 if ($dbg_attr) {
1548 if ($line =~ /^.\s*$Attribute\s*$/) {
1549 ERROR("TEST: is attr\n" . $herecurr);
1550 } elsif ($dbg_attr > 1 && $line =~ /^.+($Attribute)/) {
1551 ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1552 }
1553 next;
1554 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001555
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001556# check for initialisation to aggregates open brace on the next line
1557 if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1558 $line =~ /^.\s*{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001559 ERROR("that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001560 }
1561
Andy Whitcroft653d4872007-06-23 17:16:34 -07001562#
1563# Checks which are anchored on the added line.
1564#
1565
1566# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001567 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001568 my $path = $1;
1569 if ($path =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001570 ERROR("malformed #include filename\n" .
1571 $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001572 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001573 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001574
1575# no C99 // comments
1576 if ($line =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001577 ERROR("do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001578 }
1579 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001580 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001581 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001582
1583#EXPORT_SYMBOL should immediately follow its function closing }.
Andy Whitcroft653d4872007-06-23 17:16:34 -07001584 if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1585 ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1586 my $name = $1;
Andy Whitcroft48012052008-10-15 22:02:34 -07001587 if ($prevline !~ /(?:
1588 ^.}|
1589 ^.DEFINE_$Ident\(\Q$name\E\)|
1590 ^.DECLARE_$Ident\(\Q$name\E\)|
1591 ^.LIST_HEAD\(\Q$name\E\)|
1592 ^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
1593 \b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)
1594 )/x) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001595 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001596 }
1597 }
1598
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001599# check for external initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001600 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001601 ERROR("do not initialise externals to 0 or NULL\n" .
1602 $herecurr);
1603 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001604# check for static initialisers.
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001605 if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001606 ERROR("do not initialise statics to 0 or NULL\n" .
1607 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001608 }
1609
Andy Whitcroft653d4872007-06-23 17:16:34 -07001610# check for new typedefs, only function parameters and sparse annotations
1611# make sense.
1612 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001613 $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001614 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07001615 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001616 $line !~ /\b__bitwise(?:__|)\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001617 WARN("do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001618 }
1619
1620# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08001621 # (char*[ const])
1622 if ($line =~ m{\($NonptrType(\s*\*[\s\*]*(?:$Modifier\s*)*)\)}) {
1623 my ($from, $to) = ($1, $1);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001624
Andy Whitcroft65863862009-01-06 14:41:21 -08001625 # Should start with a space.
1626 $to =~ s/^(\S)/ $1/;
1627 # Should not end with a space.
1628 $to =~ s/\s+$//;
1629 # '*'s should not have spaces between.
1630 while ($to =~ s/(.)\s\*/$1\*/) {
1631 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001632
Andy Whitcroft65863862009-01-06 14:41:21 -08001633 #print "from<$from> to<$to>\n";
1634 if ($from ne $to) {
1635 ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
1636 }
1637 } elsif ($line =~ m{\b$NonptrType(\s*\*[\s\*]*(?:$Modifier\s*)?)($Ident)}) {
1638 my ($from, $to, $ident) = ($1, $1, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001639
Andy Whitcroft65863862009-01-06 14:41:21 -08001640 # Should start with a space.
1641 $to =~ s/^(\S)/ $1/;
1642 # Should not end with a space.
1643 $to =~ s/\s+$//;
1644 # '*'s should not have spaces between.
1645 while ($to =~ s/(.)\s\*/$1\*/) {
1646 }
1647 # Modifiers should have spaces.
1648 $to =~ s/(\b$Modifier$)/$1 /;
1649
1650 #print "from<$from> to<$to>\n";
1651 if ($from ne $to) {
1652 ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
1653 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001654 }
1655
1656# # no BUG() or BUG_ON()
1657# if ($line =~ /\b(BUG|BUG_ON)\b/) {
1658# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1659# print "$herecurr";
1660# $clean = 0;
1661# }
1662
Andy Whitcroft8905a672007-11-28 16:21:06 -08001663 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001664 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 -08001665 }
1666
Andy Whitcroft00df3442007-06-08 13:47:06 -07001667# printk should use KERN_* levels. Note that follow on printk's on the
1668# same line do not need a level, so we use the current block context
1669# to try and find and validate the current printk. In summary the current
1670# printk includes all preceeding printk's which have no newline on the end.
1671# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001672 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001673 my $ok = 0;
1674 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1675 #print "CHECK<$lines[$ln - 1]\n";
1676 # we have a preceeding printk if it ends
1677 # with "\n" ignore it, else it is to blame
1678 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1679 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1680 $ok = 1;
1681 }
1682 last;
1683 }
1684 }
1685 if ($ok == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001686 WARN("printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001687 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001688 }
1689
Andy Whitcroft653d4872007-06-23 17:16:34 -07001690# function brace can't be on same line, except for #defines of do while,
1691# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001692 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1693 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001694 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001695 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001696
Andy Whitcroft8905a672007-11-28 16:21:06 -08001697# open braces for enum, union and struct go on the same line.
1698 if ($line =~ /^.\s*{/ &&
1699 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1700 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1701 }
1702
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001703# check for spacing round square brackets; allowed:
1704# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001705# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1706# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001707 while ($line =~ /(.*?\s)\[/g) {
1708 my ($where, $prefix) = ($-[1], $1);
1709 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001710 ($where != 0 || $prefix !~ /^.\s+$/) &&
1711 $prefix !~ /{\s+$/) {
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001712 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1713 }
1714 }
1715
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001716# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001717 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001718 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001719 my $ctx_before = substr($line, 0, $-[1]);
1720 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001721
1722 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001723 if ($name =~ /^(?:
1724 if|for|while|switch|return|case|
1725 volatile|__volatile__|
1726 __attribute__|format|__extension__|
1727 asm|__asm__)$/x)
1728 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001729
1730 # cpp #define statements have non-optional spaces, ie
1731 # if there is a space between the name and the open
1732 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001733 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001734
1735 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001736 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001737
1738 # If this whole things ends with a type its most
1739 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001740 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001741
1742 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001743 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001744 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001745 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001746# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001747 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001748 my $ops = qr{
1749 <<=|>>=|<=|>=|==|!=|
1750 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1751 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001752 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1753 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001754 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001755 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001756 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001757
1758 my $blank = copy_spacing($opline);
1759
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001760 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001761 $off += length($elements[$n]);
1762
Andy Whitcroft773647a2008-03-28 14:15:58 -07001763 # Pick up the preceeding and succeeding characters.
1764 my $ca = substr($opline, 0, $off);
1765 my $cc = '';
1766 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1767 $cc = substr($opline, $off + length($elements[$n + 1]));
1768 }
1769 my $cb = "$ca$;$cc";
1770
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001771 my $a = '';
1772 $a = 'V' if ($elements[$n] ne '');
1773 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001774 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001775 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1776 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07001777 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001778
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001779 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001780
1781 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001782 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001783 $c = 'V' if ($elements[$n + 2] ne '');
1784 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001785 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001786 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1787 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001788 $c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001789 } else {
1790 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001791 }
1792
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001793 my $ctx = "${a}x${c}";
1794
1795 my $at = "(ctx:$ctx)";
1796
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001797 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001798 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001799
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001800 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001801 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001802
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001803 # Get the full operator variant.
1804 my $opv = $op . substr($curr_vars, $off, 1);
1805
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001806 # Ignore operators passed as parameters.
1807 if ($op_type ne 'V' &&
1808 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1809
Andy Whitcroftcf655042008-03-04 14:28:20 -08001810# # Ignore comments
1811# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001812
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001813 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001814 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001815 if ($ctx !~ /.x[WEBC]/ &&
1816 $cc !~ /^\\/ && $cc !~ /^;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001817 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001818 }
1819
1820 # // is a comment
1821 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001822
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001823 # No spaces for:
1824 # ->
1825 # : when part of a bitfield
1826 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001827 if ($ctx =~ /Wx.|.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001828 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001829 }
1830
1831 # , must have a space on the right.
1832 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001833 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001834 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001835 }
1836
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001837 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001838 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001839 #warn "'*' is part of type\n";
1840
1841 # unary operators should have a space before and
1842 # none after. May be left adjacent to another
1843 # unary operator, or a cast
1844 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001845 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07001846 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001847 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001848 ERROR("space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001849 }
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001850 if ($op eq '*' && $cc =~/\s*const\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001851 # A unary '*' may be const
1852
1853 } elsif ($ctx =~ /.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001854 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001855 }
1856
1857 # unary ++ and unary -- are allowed no space on one side.
1858 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001859 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1860 ERROR("space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001861 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001862 if ($ctx =~ /Wx[BE]/ ||
1863 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1864 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001865 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001866 if ($ctx =~ /ExW/) {
1867 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1868 }
1869
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001870
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001871 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001872 } elsif ($op eq '<<' or $op eq '>>' or
1873 $op eq '&' or $op eq '^' or $op eq '|' or
1874 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001875 $op eq '*' or $op eq '/' or
1876 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001877 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001878 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001879 ERROR("need consistent spacing around '$op' $at\n" .
1880 $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001881 }
1882
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001883 # A colon needs no spaces before when it is
1884 # terminating a case value or a label.
1885 } elsif ($opv eq ':C' || $opv eq ':L') {
1886 if ($ctx =~ /Wx./) {
1887 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1888 }
1889
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001890 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08001891 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001892 my $ok = 0;
1893
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001894 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001895 if (($op eq '<' &&
1896 $cc =~ /^\S+\@\S+>/) ||
1897 ($op eq '>' &&
1898 $ca =~ /<\S+\@\S+$/))
1899 {
1900 $ok = 1;
1901 }
1902
1903 # Ignore ?:
1904 if (($opv eq ':O' && $ca =~ /\?$/) ||
1905 ($op eq '?' && $cc =~ /^:/)) {
1906 $ok = 1;
1907 }
1908
1909 if ($ok == 0) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001910 ERROR("spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001911 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001912 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001913 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001914 }
1915 }
1916
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001917# check for multiple assignments
1918 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001919 CHK("multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001920 }
1921
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001922## # check for multiple declarations, allowing for a function declaration
1923## # continuation.
1924## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
1925## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
1926##
1927## # Remove any bracketed sections to ensure we do not
1928## # falsly report the parameters of functions.
1929## my $ln = $line;
1930## while ($ln =~ s/\([^\(\)]*\)//g) {
1931## }
1932## if ($ln =~ /,/) {
1933## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
1934## }
1935## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001936
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001937#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001938 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
1939 $line =~ /do{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001940 ERROR("space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001941 }
1942
1943# closing brace should have a space following it when it has anything
1944# on the line
1945 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001946 ERROR("space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001947 }
1948
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001949# check spacing on square brackets
1950 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001951 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001952 }
1953 if ($line =~ /\s\]/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001954 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001955 }
1956
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001957# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001958 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
1959 $line !~ /for\s*\(\s+;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001960 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001961 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001962 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001963 $line !~ /for\s*\(.*;\s+\)/ &&
1964 $line !~ /:\s+\)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001965 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001966 }
1967
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001968#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001969 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001970 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001971 WARN("labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001972 }
1973
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001974# Return is not a function.
1975 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
1976 my $spacing = $1;
1977 my $value = $2;
1978
1979 # Flatten any parentheses and braces
Andy Whitcroftfee61c42008-07-23 21:28:56 -07001980 $value =~ s/\)\(/\) \(/g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001981 while ($value =~ s/\([^\(\)]*\)/1/) {
1982 }
1983
1984 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
1985 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
1986
1987 } elsif ($spacing !~ /\s+/) {
1988 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1989 }
1990 }
1991
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001992# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001993 if ($line=~/\b(if|while|for|switch)\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001994 ERROR("space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001995 }
1996
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001997# Check for illegal assignment in if conditional -- and check for trailing
1998# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001999 if ($line =~ /do\s*(?!{)/) {
2000 my ($stat_next) = ctx_statement_block($line_nr_next,
2001 $remain_next, $off_next);
2002 $stat_next =~ s/\n./\n /g;
2003 ##print "stat<$stat> stat_next<$stat_next>\n";
2004
2005 if ($stat_next =~ /^\s*while\b/) {
2006 # If the statement carries leading newlines,
2007 # then count those as offsets.
2008 my ($whitespace) =
2009 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2010 my $offset =
2011 statement_rawlines($whitespace) - 1;
2012
2013 $suppress_whiletrailers{$line_nr_next +
2014 $offset} = 1;
2015 }
2016 }
2017 if (!defined $suppress_whiletrailers{$linenr} &&
2018 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002019 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002020
2021 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002022 ERROR("do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002023 }
2024
2025 # Find out what is on the end of the line after the
2026 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002027 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002028 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002029 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07002030 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2031 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002032 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002033 # Find out how long the conditional actually is.
2034 my @newlines = ($c =~ /\n/gs);
2035 my $cond_lines = 1 + $#newlines;
2036
2037 my $stat_real = raw_line($linenr, $cond_lines);
2038 if (defined($stat_real) && $cond_lines > 1) {
2039 $stat_real = "[...]\n$stat_real";
2040 }
2041
2042 ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002043 }
2044 }
2045
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002046# Check for bitwise tests written as boolean
2047 if ($line =~ /
2048 (?:
2049 (?:\[|\(|\&\&|\|\|)
2050 \s*0[xX][0-9]+\s*
2051 (?:\&\&|\|\|)
2052 |
2053 (?:\&\&|\|\|)
2054 \s*0[xX][0-9]+\s*
2055 (?:\&\&|\|\||\)|\])
2056 )/x)
2057 {
2058 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2059 }
2060
Andy Whitcroft8905a672007-11-28 16:21:06 -08002061# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002062 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2063 my $s = $1;
2064 $s =~ s/$;//g; # Remove any comments
2065 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2066 ERROR("trailing statements should be on next line\n" . $herecurr);
2067 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002068 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002069# case and default should not have general statements after them
2070 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2071 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07002072 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002073 \s*return\s+
2074 )/xg)
2075 {
2076 ERROR("trailing statements should be on next line\n" . $herecurr);
2077 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002078
2079 # Check for }<nl>else {, these must be at the same
2080 # indent level to be relevant to each other.
2081 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2082 $previndent == $indent) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002083 ERROR("else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002084 }
2085
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002086 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2087 $previndent == $indent) {
2088 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2089
2090 # Find out what is on the end of the line after the
2091 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002092 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002093 $s =~ s/\n.*//g;
2094
2095 if ($s =~ /^\s*;/) {
2096 ERROR("while should follow close brace '}'\n" . $hereprev);
2097 }
2098 }
2099
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002100#studly caps, commented out until figure out how to distinguish between use of existing and adding new
2101# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2102# print "No studly caps, use _\n";
2103# print "$herecurr";
2104# $clean = 0;
2105# }
2106
2107#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002108 if ($line=~/\#\s*define.*\\\s$/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002109 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002110 }
2111
Andy Whitcroft653d4872007-06-23 17:16:34 -07002112#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002113 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002114 my $file = "$1.h";
2115 my $checkfile = "include/linux/$file";
2116 if (-f "$root/$checkfile" &&
2117 $realfile ne $checkfile &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002118 $1 ne 'irq')
2119 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002120 if ($realfile =~ m{^arch/}) {
2121 CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2122 } else {
2123 WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2124 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002125 }
2126 }
2127
Andy Whitcroft653d4872007-06-23 17:16:34 -07002128# multi-statement macros should be enclosed in a do while loop, grab the
2129# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08002130# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07002131 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2132 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002133 my $ln = $linenr;
2134 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002135 my ($off, $dstat, $dcond, $rest);
2136 my $ctx = '';
Andy Whitcroft653d4872007-06-23 17:16:34 -07002137
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002138 my $args = defined($1);
2139
2140 # Find the end of the macro and limit our statement
2141 # search to that.
2142 while ($cnt > 0 && defined $lines[$ln - 1] &&
2143 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2144 {
2145 $ctx .= $rawlines[$ln - 1] . "\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002146 $cnt-- if ($lines[$ln - 1] !~ /^-/);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002147 $ln++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002148 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002149 $ctx .= $rawlines[$ln - 1];
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002150
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002151 ($dstat, $dcond, $ln, $cnt, $off) =
2152 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2153 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002154 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002155
2156 # Extract the remainder of the define (if any) and
2157 # rip off surrounding spaces, and trailing \'s.
2158 $rest = '';
Andy Whitcroft636d1402008-10-15 22:02:18 -07002159 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2160 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002161 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2162 $rest .= substr($lines[$ln - 1], $off) . "\n";
2163 $cnt--;
2164 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002165 $ln++;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002166 $off = 0;
2167 }
2168 $rest =~ s/\\\n.//g;
2169 $rest =~ s/^\s*//s;
2170 $rest =~ s/\s*$//s;
2171
2172 # Clean up the original statement.
2173 if ($args) {
2174 substr($dstat, 0, length($dcond), '');
2175 } else {
2176 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2177 }
Andy Whitcroft292f1a92008-07-23 21:29:11 -07002178 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002179 $dstat =~ s/\\\n.//g;
2180 $dstat =~ s/^\s*//s;
2181 $dstat =~ s/\s*$//s;
2182
2183 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07002184 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2185 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2186 $dstat =~ s/\[[^\{\}]*\]/1/)
2187 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002188 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002189
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002190 my $exceptions = qr{
2191 $Declare|
2192 module_param_named|
2193 MODULE_PARAM_DESC|
2194 DECLARE_PER_CPU|
2195 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08002196 __typeof__\(|
2197 \.$Ident\s*=\s*
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002198 }x;
Andy Whitcroft383099f2009-01-06 14:41:18 -08002199 #print "REST<$rest> dstat<$dstat>\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002200 if ($rest ne '') {
2201 if ($rest !~ /while\s*\(/ &&
2202 $dstat !~ /$exceptions/)
2203 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002204 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 -07002205 }
2206
2207 } elsif ($ctx !~ /;/) {
2208 if ($dstat ne '' &&
2209 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2210 $dstat !~ /$exceptions/ &&
Andy Whitcroftb132e5d2008-10-15 22:02:31 -07002211 $dstat !~ /^\.$Ident\s*=/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002212 $dstat =~ /$Operators/)
2213 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002214 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002215 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002216 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002217 }
2218
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002219# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002220 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2221 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08002222 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002223 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002224 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2225 if ($#chunks > 0 && $level == 0) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002226 my $allowed = 0;
2227 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002228 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002229 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002230 for my $chunk (@chunks) {
2231 my ($cond, $block) = @{$chunk};
2232
Andy Whitcroft773647a2008-03-28 14:15:58 -07002233 # If the condition carries leading newlines, then count those as offsets.
2234 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2235 my $offset = statement_rawlines($whitespace) - 1;
2236
2237 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2238
2239 # We have looked at and allowed this specific line.
2240 $suppress_ifbraces{$ln + $offset} = 1;
2241
2242 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002243 $ln += statement_rawlines($block) - 1;
2244
Andy Whitcroft773647a2008-03-28 14:15:58 -07002245 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002246
2247 $seen++ if ($block =~ /^\s*{/);
2248
Andy Whitcroftcf655042008-03-04 14:28:20 -08002249 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2250 if (statement_lines($cond) > 1) {
2251 #print "APW: ALLOWED: cond<$cond>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002252 $allowed = 1;
2253 }
2254 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002255 #print "APW: ALLOWED: block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002256 $allowed = 1;
2257 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002258 if (statement_block_size($block) > 1) {
2259 #print "APW: ALLOWED: lines block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002260 $allowed = 1;
2261 }
2262 }
2263 if ($seen && !$allowed) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002264 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002265 }
2266 }
2267 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002268 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002269 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002270 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002271
Andy Whitcroftcf655042008-03-04 14:28:20 -08002272 # Check the pre-context.
2273 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2274 #print "APW: ALLOWED: pre<$1>\n";
2275 $allowed = 1;
2276 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002277
2278 my ($level, $endln, @chunks) =
2279 ctx_statement_full($linenr, $realcnt, $-[0]);
2280
Andy Whitcroftcf655042008-03-04 14:28:20 -08002281 # Check the condition.
2282 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07002283 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002284 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002285 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08002286 }
2287 if (statement_lines($cond) > 1) {
2288 #print "APW: ALLOWED: cond<$cond>\n";
2289 $allowed = 1;
2290 }
2291 if ($block =~/\b(?:if|for|while)\b/) {
2292 #print "APW: ALLOWED: block<$block>\n";
2293 $allowed = 1;
2294 }
2295 if (statement_block_size($block) > 1) {
2296 #print "APW: ALLOWED: lines block<$block>\n";
2297 $allowed = 1;
2298 }
2299 # Check the post-context.
2300 if (defined $chunks[1]) {
2301 my ($cond, $block) = @{$chunks[1]};
2302 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002303 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002304 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002305 if ($block =~ /^\s*\{/) {
2306 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2307 $allowed = 1;
2308 }
2309 }
2310 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2311 my $herectx = $here . "\n";;
Andy Whitcroftf0556632008-10-15 22:02:23 -07002312 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002313
Andy Whitcroftf0556632008-10-15 22:02:23 -07002314 for (my $n = 0; $n < $cnt; $n++) {
2315 $herectx .= raw_line($linenr, $n) . "\n";;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002316 }
2317
2318 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002319 }
2320 }
2321
Andy Whitcroft653d4872007-06-23 17:16:34 -07002322# don't include deprecated include files (uses RAW line)
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002323 for my $inc (@dep_includes) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002324 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002325 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002326 }
2327 }
2328
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002329# don't use deprecated functions
2330 for my $func (@dep_functions) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002331 if ($line =~ /\b$func\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002332 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002333 }
2334 }
2335
2336# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002337 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2338 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002339 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002340 }
2341
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002342# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2343 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2344 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2345 }
2346
Andy Whitcroft00df3442007-06-08 13:47:06 -07002347# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002348 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002349 CHK("if this code is redundant consider removing it\n" .
2350 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002351 }
2352
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002353# check for needless kfree() checks
2354 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2355 my $expr = $1;
2356 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
Wolfram Sang3c232142008-07-23 21:29:05 -07002357 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002358 }
2359 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07002360# check for needless usb_free_urb() checks
2361 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2362 my $expr = $1;
2363 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2364 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2365 }
2366 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002367
Andy Whitcroft00df3442007-06-08 13:47:06 -07002368# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002369# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002370# print "#ifdef in C files should be avoided\n";
2371# print "$herecurr";
2372# $clean = 0;
2373# }
2374
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002375# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002376 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002377 ERROR("exactly one space required after that #$1\n" . $herecurr);
2378 }
2379
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002380# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002381 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2382 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002383 my $which = $1;
2384 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002385 CHK("$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002386 }
2387 }
2388# check for memory barriers without a comment.
2389 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2390 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002391 CHK("memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002392 }
2393 }
2394# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002395 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002396 CHK("architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002397 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002398
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002399# check the location of the inline attribute, that it is between
2400# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002401 if ($line =~ /\b$Type\s+$Inline\b/ ||
2402 $line =~ /\b$Inline\s+$Storage\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002403 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2404 }
2405
Andy Whitcroft8905a672007-11-28 16:21:06 -08002406# Check for __inline__ and __inline, prefer inline
2407 if ($line =~ /\b(__inline__|__inline)\b/) {
2408 WARN("plain inline is preferred over $1\n" . $herecurr);
2409 }
2410
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002411# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002412 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002413 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002414 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002415 my $function_name = $1;
2416 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002417
2418 my $s = $stat;
2419 if (defined $cond) {
2420 substr($s, 0, length($cond), '');
2421 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002422 if ($s =~ /^\s*;/ &&
2423 $function_name ne 'uninitialized_var')
2424 {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002425 WARN("externs should be avoided in .c files\n" . $herecurr);
2426 }
2427
2428 if ($paren_space =~ /\n/) {
2429 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2430 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002431
2432 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2433 $stat =~ /^.\s*extern\s+/)
2434 {
2435 WARN("externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002436 }
2437
2438# checks for new __setup's
2439 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2440 my $name = $1;
2441
2442 if (!grep(/$name/, @setup_docs)) {
2443 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2444 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002445 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002446
2447# check for pointless casting of kmalloc return
2448 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2449 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2450 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002451
2452# check for gcc specific __FUNCTION__
2453 if ($line =~ /__FUNCTION__/) {
2454 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2455 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002456
2457# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002458 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002459 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2460 }
2461# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002462 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002463 WARN("consider using a completion\n" . $herecurr);
2464 }
2465# recommend strict_strto* over simple_strto*
2466 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2467 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2468 }
Michael Ellermanf3db6632008-07-23 21:28:57 -07002469# check for __initcall(), use device_initcall() explicitly please
2470 if ($line =~ /^.\s*__initcall\s*\(/) {
2471 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2472 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002473
2474# use of NR_CPUS is usually wrong
2475# ignore definitions of NR_CPUS and usage to define arrays as likely right
2476 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002477 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2478 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002479 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2480 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2481 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002482 {
2483 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2484 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002485
2486# check for %L{u,d,i} in strings
2487 my $string;
2488 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2489 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07002490 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002491 if ($string =~ /(?<!%)%L[udi]/) {
2492 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2493 last;
2494 }
2495 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08002496
2497# whine mightly about in_atomic
2498 if ($line =~ /\bin_atomic\s*\(/) {
2499 if ($realfile =~ m@^drivers/@) {
2500 ERROR("do not use in_atomic in drivers\n" . $herecurr);
2501 } else {
2502 WARN("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
2503 }
2504 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002505 }
2506
2507 # If we have no input at all, then there is nothing to report on
2508 # so just keep quiet.
2509 if ($#rawlines == -1) {
2510 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002511 }
2512
Andy Whitcroft8905a672007-11-28 16:21:06 -08002513 # In mailback mode only produce a report in the negative, for
2514 # things that appear to be patches.
2515 if ($mailback && ($clean == 1 || !$is_patch)) {
2516 exit(0);
2517 }
2518
2519 # This is not a patch, and we are are in 'no-patch' mode so
2520 # just keep quiet.
2521 if (!$chk_patch && !$is_patch) {
2522 exit(0);
2523 }
2524
2525 if (!$is_patch) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002526 ERROR("Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002527 }
2528 if ($is_patch && $chk_signoff && $signoff == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002529 ERROR("Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002530 }
2531
Andy Whitcroft8905a672007-11-28 16:21:06 -08002532 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002533 if ($summary && !($clean == 1 && $quiet == 1)) {
2534 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002535 print "total: $cnt_error errors, $cnt_warn warnings, " .
2536 (($check)? "$cnt_chk checks, " : "") .
2537 "$cnt_lines lines checked\n";
2538 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002539 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002540
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002541 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002542 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002543 }
2544 if ($clean == 0 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002545 print "$vname has style problems, please review. If any of these errors\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002546 print "are false positives report them to the maintainer, see\n";
2547 print "CHECKPATCH in MAINTAINERS.\n";
2548 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002549
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002550 return $clean;
2551}