blob: c79abb41793dfc5ef377d560776450769545be47 [file] [log] [blame]
Andy Whitcroft0a920b5b2007-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 Whitcroft00df344f2007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004# (c) 2007, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite, etc)
5# Licensed under the terms of the GNU GPL License version 2
6
7use strict;
8
9my $P = $0;
Andy Whitcroft00df344f2007-06-08 13:47:06 -070010$P =~ s@.*/@@g;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070011
Andy Whitcroft6e144ee2008-10-15 22:02:36 -070012my $V = '0.24';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070013
14use Getopt::Long qw(:config no_auto_abbrev);
15
16my $quiet = 0;
17my $tree = 1;
18my $chk_signoff = 1;
19my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070020my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070021my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080022my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070023my $file = 0;
24my $check = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080025my $summary = 1;
26my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080027my $summary_file = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070028my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080029my %debug;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070030GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070031 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070032 'tree!' => \$tree,
33 'signoff!' => \$chk_signoff,
34 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070035 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -080036 'terse!' => \$terse,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070037 'file!' => \$file,
38 'subjective!' => \$check,
39 'strict!' => \$check,
40 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -080041 'summary!' => \$summary,
42 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -080043 'summary-file!' => \$summary_file,
44
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080045 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -070046 'test-only=s' => \$tst_only,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070047) or exit;
48
49my $exit = 0;
50
51if ($#ARGV < 0) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -070052 print "usage: $P [options] patchfile\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070053 print "version: $V\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -080054 print "options: -q => quiet\n";
55 print " --no-tree => run without a kernel tree\n";
56 print " --terse => one line per report\n";
57 print " --emacs => emacs compile window format\n";
58 print " --file => check a source file\n";
59 print " --strict => enable more subjective tests\n";
60 print " --root => path to the kernel tree root\n";
61 print " --no-summary => suppress the per-file summary\n";
62 print " --summary-file => include the filename in summary\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070063 exit(1);
64}
65
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080066my $dbg_values = 0;
67my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -070068my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -070069my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080070for my $key (keys %debug) {
71 eval "\${dbg_$key} = '$debug{$key}';"
72}
73
Andy Whitcroft8905a672007-11-28 16:21:06 -080074if ($terse) {
75 $emacs = 1;
76 $quiet++;
77}
78
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070079if ($tree) {
80 if (defined $root) {
81 if (!top_of_kernel_tree($root)) {
82 die "$P: $root: --root does not point at a valid tree\n";
83 }
84 } else {
85 if (top_of_kernel_tree('.')) {
86 $root = '.';
87 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
88 top_of_kernel_tree($1)) {
89 $root = $1;
90 }
91 }
92
93 if (!defined $root) {
94 print "Must be run from the top-level dir. of a kernel tree\n";
95 exit(2);
96 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070097}
98
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070099my $emitted_corrupt = 0;
100
101our $Ident = qr{[A-Za-z_][A-Za-z\d_]*};
102our $Storage = qr{extern|static|asmlinkage};
103our $Sparse = qr{
104 __user|
105 __kernel|
106 __force|
107 __iomem|
108 __must_check|
109 __init_refok|
Andy Whitcroftcf655042008-03-04 14:28:20 -0800110 __kprobes
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700111 }x;
112our $Attribute = qr{
113 const|
114 __read_mostly|
115 __kprobes|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700116 __(?:mem|cpu|dev|)(?:initdata|init)|
117 ____cacheline_aligned|
118 ____cacheline_aligned_in_smp|
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 Whitcroft8905a672007-11-28 16:21:06 -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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -0700219 }
220 }
221}
222
Andy Whitcroft00df344f2007-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -0700266 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700267 return 1;
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Whitcroft00df344f2007-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 Whitcroft00df344f2007-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 Whitcroft00df344f2007-06-08 13:47:06 -0700364 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700365 } elsif ($sanitise_quote eq $c) {
366 $sanitise_quote = '';
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700367 }
368 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700369
370 #print "SQ:$sanitise_quote\n";
371 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 Whitcroft00df344f2007-06-08 13:47:06 -0700375 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700376 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-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 Whitcroft00df344f2007-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 Whitcroft00df344f2007-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 Whitcroft00df344f2007-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 Whitcroft00df344f2007-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 Whitcroft00df344f2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -0700699sub cat_vet {
700 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700701 my ($res, $coded);
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -0700712
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700713 return $res;
Andy Whitcroft0a920b5b2007-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 Whitcroft1f65f942008-07-23 21:29:10 -0700847 } elsif ($cur =~ /^($Ident\s*):/) {
848 if ($type eq 'E') {
849 $av_pend_colon = 'L';
850 } elsif ($type eq 'T') {
851 $av_pend_colon = 'B';
852 }
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 Whitcroft1f65f942008-07-23 21:29:10 -0700869 } elsif ($cur =~ /^(\?)/o) {
870 print "QUESTION($1)\n" if ($dbg_values > 1);
871 $type = 'N';
872
873 } elsif ($cur =~ /^(:)/o) {
874 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
875
876 substr($var, length($res), 1, $av_pend_colon);
877 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
878 $type = 'E';
879 } else {
880 $type = 'N';
881 }
882 $av_pend_colon = 'O';
883
884 } elsif ($cur =~ /^(;|\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800885 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700886 $type = 'N';
887
Andy Whitcroft0d413862008-10-15 22:02:16 -0700888 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -0700889 my $variant;
890
891 print "OPV($1)\n" if ($dbg_values > 1);
892 if ($type eq 'V') {
893 $variant = 'B';
894 } else {
895 $variant = 'U';
896 }
897
898 substr($var, length($res), 1, $variant);
899 $type = 'N';
900
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700901 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800902 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700903 if ($1 ne '++' && $1 ne '--') {
904 $type = 'N';
905 }
906
907 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800908 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700909 }
910 if (defined $1) {
911 $cur = substr($cur, length($1));
912 $res .= $type x length($1);
913 }
914 }
915
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700916 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700917}
918
Andy Whitcroft8905a672007-11-28 16:21:06 -0800919sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800920 my ($possible, $line) = @_;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800921
Andy Whitcroft0776e592008-10-15 22:02:29 -0700922 print "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
923 if ($possible !~ /(?:
924 ^(?:
925 $Modifier|
926 $Storage|
927 $Type|
928 DEFINE_\S+|
929 goto|
930 return|
931 case|
932 else|
933 asm|__asm__|
934 do
935 )$|
936 ^(?:typedef|struct|enum)\b
937 )/x) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700938 # Check for modifiers.
939 $possible =~ s/\s*$Storage\s*//g;
940 $possible =~ s/\s*$Sparse\s*//g;
941 if ($possible =~ /^\s*$/) {
942
943 } elsif ($possible =~ /\s/) {
944 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -0700945 for my $modifier (split(' ', $possible)) {
946 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
947 push(@modifierList, $modifier);
948 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700949
950 } else {
951 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
952 push(@typeList, $possible);
953 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800954 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -0700955 } else {
956 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800957 }
958}
959
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700960my $prefix = '';
961
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700962sub report {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700963 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
964 return 0;
965 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800966 my $line = $prefix . $_[0];
967
968 $line = (split('\n', $line))[0] . "\n" if ($terse);
969
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800970 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700971
972 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700973}
974sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800975 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700976}
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700977sub ERROR {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700978 if (report("ERROR: $_[0]\n")) {
979 our $clean = 0;
980 our $cnt_error++;
981 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700982}
983sub WARN {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700984 if (report("WARNING: $_[0]\n")) {
985 our $clean = 0;
986 our $cnt_warn++;
987 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700988}
989sub CHK {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700990 if ($check && report("CHECK: $_[0]\n")) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700991 our $clean = 0;
992 our $cnt_chk++;
993 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700994}
995
Andy Whitcroft6ecd9672008-10-15 22:02:21 -0700996sub check_absolute_file {
997 my ($absolute, $herecurr) = @_;
998 my $file = $absolute;
999
1000 ##print "absolute<$absolute>\n";
1001
1002 # See if any suffix of this path is a path within the tree.
1003 while ($file =~ s@^[^/]*/@@) {
1004 if (-f "$root/$file") {
1005 ##print "file<$file>\n";
1006 last;
1007 }
1008 }
1009 if (! -f _) {
1010 return 0;
1011 }
1012
1013 # It is, so see if the prefix is acceptable.
1014 my $prefix = $absolute;
1015 substr($prefix, -length($file)) = '';
1016
1017 ##print "prefix<$prefix>\n";
1018 if ($prefix ne ".../") {
1019 WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr);
1020 }
1021}
1022
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001023sub process {
1024 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001025
1026 my $linenr=0;
1027 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001028 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001029 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001030 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001031
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001032 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001033 my $indent;
1034 my $previndent=0;
1035 my $stashindent=0;
1036
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001037 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001038 my $signoff = 0;
1039 my $is_patch = 0;
1040
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001041 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001042 our $cnt_lines = 0;
1043 our $cnt_error = 0;
1044 our $cnt_warn = 0;
1045 our $cnt_chk = 0;
1046
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001047 # Trace the real file/line as we go.
1048 my $realfile = '';
1049 my $realline = 0;
1050 my $realcnt = 0;
1051 my $here = '';
1052 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001053 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001054 my $first_line = 0;
1055
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001056 my $prev_values = 'E';
1057
1058 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001059 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001060 my %suppress_whiletrailers;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001061
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001062 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001063 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001064 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001065 my @setup_docs = ();
1066 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001067
1068 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001069 my $line;
1070 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001071 $linenr++;
1072 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001073
Andy Whitcroft773647a2008-03-28 14:15:58 -07001074 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001075 $setup_docs = 0;
1076 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1077 $setup_docs = 1;
1078 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001079 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001080 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001081 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1082 $realline=$1-1;
1083 if (defined $2) {
1084 $realcnt=$3+1;
1085 } else {
1086 $realcnt=1+1;
1087 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001088 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001089
1090 # Guestimate if this is a continuing comment. Run
1091 # the context looking for a comment "edge". If this
1092 # edge is a close comment then we must be in a comment
1093 # at context start.
1094 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001095 my $cnt = $realcnt;
1096 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1097 next if (defined $rawlines[$ln - 1] &&
1098 $rawlines[$ln - 1] =~ /^-/);
1099 $cnt--;
1100 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001101 last if (!defined $rawlines[$ln - 1]);
1102 ($edge) = ($rawlines[$ln - 1] =~ m@(/\*|\*/)@);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001103 last if (defined $edge);
1104 }
1105 if (defined $edge && $edge eq '*/') {
1106 $in_comment = 1;
1107 }
1108
1109 # Guestimate if this is a continuing comment. If this
1110 # is the start of a diff block and this line starts
1111 # ' *' then it is very likely a comment.
1112 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001113 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001114 {
1115 $in_comment = 1;
1116 }
1117
1118 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1119 sanitise_line_reset($in_comment);
1120
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001121 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001122 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001123 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001124 $line = sanitise_line($rawline);
1125 }
1126 push(@lines, $line);
1127
1128 if ($realcnt > 1) {
1129 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1130 } else {
1131 $realcnt = 0;
1132 }
1133
1134 #print "==>$rawline\n";
1135 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001136
1137 if ($setup_docs && $line =~ /^\+/) {
1138 push(@setup_docs, $line);
1139 }
1140 }
1141
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001142 $prefix = '';
1143
Andy Whitcroft773647a2008-03-28 14:15:58 -07001144 $realcnt = 0;
1145 $linenr = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001146 foreach my $line (@lines) {
1147 $linenr++;
1148
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001149 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft306708542008-10-15 22:02:28 -07001150 my $hunk_line = ($realcnt != 0);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001151
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001152#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001153 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001154 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001155 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001156 $realline=$1-1;
1157 if (defined $2) {
1158 $realcnt=$3+1;
1159 } else {
1160 $realcnt=1+1;
1161 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001162 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001163 $prev_values = 'E';
1164
Andy Whitcroft773647a2008-03-28 14:15:58 -07001165 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001166 %suppress_whiletrailers = ();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001167 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001168
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001169# track the line number as we move through the hunk, note that
1170# new versions of GNU diff omit the leading space on completely
1171# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001172 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001173 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001174 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001175
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001176 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001177 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001178
1179 # Track the previous line.
1180 ($prevline, $stashline) = ($stashline, $line);
1181 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001182 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1183
Andy Whitcroft773647a2008-03-28 14:15:58 -07001184 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001185
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001186 } elsif ($realcnt == 1) {
1187 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001188 }
1189
1190#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001191 $prefix = "$filename:$realline: " if ($emacs && $file);
1192 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1193
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001194 $here = "#$linenr: " if (!$file);
1195 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001196
1197 # extract the filename as it passes
1198 if ($line=~/^\+\+\+\s+(\S+)/) {
1199 $realfile = $1;
1200 $realfile =~ s@^[^/]*/@@;
1201
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001202 if ($realfile =~ m@^include/asm/@) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001203 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1204 }
1205 next;
1206 }
1207
Randy Dunlap389834b2007-06-08 13:47:03 -07001208 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001209
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001210 my $hereline = "$here\n$rawline\n";
1211 my $herecurr = "$here\n$rawline\n";
1212 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001213
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001214 $cnt_lines++ if ($realcnt != 0);
1215
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001216#check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001217 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001218 # This is a signoff, if ugly, so do not double report.
1219 $signoff++;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001220 if (!($line =~ /^\s*Signed-off-by:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001221 WARN("Signed-off-by: is the preferred form\n" .
1222 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001223 }
1224 if ($line =~ /^\s*signed-off-by:\S/i) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001225 WARN("space required after Signed-off-by:\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001226 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001227 }
1228 }
1229
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001230# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001231 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001232 ERROR("patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001233 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001234 }
1235
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001236# Check for absolute kernel paths.
1237 if ($tree) {
1238 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1239 my $file = $1;
1240
1241 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1242 check_absolute_file($1, $herecurr)) {
1243 #
1244 } else {
1245 check_absolute_file($file, $herecurr);
1246 }
1247 }
1248 }
1249
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001250# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1251 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001252 $rawline !~ m/^$UTF8*$/) {
1253 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1254
1255 my $blank = copy_spacing($rawline);
1256 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1257 my $hereptr = "$hereline$ptr\n";
1258
1259 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001260 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001261
Andy Whitcroft306708542008-10-15 22:02:28 -07001262# ignore non-hunk lines and lines being removed
1263 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001264
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001265#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001266 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001267 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001268 ERROR("DOS line endings\n" . $herevet);
1269
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001270 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1271 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001272 ERROR("trailing whitespace\n" . $herevet);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001273 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07001274
1275# check we are in a valid source file if not then ignore this hunk
1276 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1277
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001278#80 column limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001279 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001280 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1281 $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1282 $length > 80)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001283 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001284 WARN("line over 80 characters\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001285 }
1286
Andy Whitcroft8905a672007-11-28 16:21:06 -08001287# check for adding lines without a newline.
1288 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1289 WARN("adding a line without newline at end of file\n" . $herecurr);
1290 }
1291
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001292# check we are in a valid source file C or perl if not then ignore this hunk
1293 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001294
1295# at the beginning of a line any tabs must come first and anything
1296# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001297 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1298 $rawline =~ /^\+\s* \s*/) {
1299 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001300 ERROR("code indent should use tabs where possible\n" . $herevet);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001301 }
1302
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001303# check we are in a valid C source file if not then ignore this hunk
1304 next if ($realfile !~ /\.(h|c)$/);
1305
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001306# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001307 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001308 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1309 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001310
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001311# Check for potential 'bare' types
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001312 my ($stat, $cond, $line_nr_next, $remain_next, $off_next);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001313 if ($realcnt && $line =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001314 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001315 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001316 $stat =~ s/\n./\n /g;
1317 $cond =~ s/\n./\n /g;
1318
1319 my $s = $stat;
1320 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001321
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001322 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001323 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001324
1325 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001326 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001327
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001328 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001329 } 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 -07001330 my $type = $1;
1331 $type =~ s/\s+/ /g;
1332 possible($type, "A:" . $s);
1333
Andy Whitcroft8905a672007-11-28 16:21:06 -08001334 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07001335 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001336 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001337 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001338
1339 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001340 while ($s =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001341 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001342 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001343
1344 # Check for any sort of function declaration.
1345 # int foo(something bar, other baz);
1346 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001347 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 -08001348 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001349
Andy Whitcroftcf655042008-03-04 14:28:20 -08001350 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001351 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001352 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001353
Andy Whitcroft8905a672007-11-28 16:21:06 -08001354 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001355 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001356
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001357 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001358 }
1359 }
1360 }
1361
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001362 }
1363
Andy Whitcroft653d4872007-06-23 17:16:34 -07001364#
1365# Checks which may be anchored in the context.
1366#
1367
1368# Check for switch () and associated case and default
1369# statements should be at the same indent.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001370 if ($line=~/\bswitch\s*\(.*\)/) {
1371 my $err = '';
1372 my $sep = '';
1373 my @ctx = ctx_block_outer($linenr, $realcnt);
1374 shift(@ctx);
1375 for my $ctx (@ctx) {
1376 my ($clen, $cindent) = line_stats($ctx);
1377 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1378 $indent != $cindent) {
1379 $err .= "$sep$ctx\n";
1380 $sep = '';
1381 } else {
1382 $sep = "[...]\n";
1383 }
1384 }
1385 if ($err ne '') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001386 ERROR("switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001387 }
1388 }
1389
1390# if/while/etc brace do not go on next line, unless defining a do while loop,
1391# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001392 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001393 my $pre_ctx = "$1$2";
1394
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001395 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001396 my $ctx_cnt = $realcnt - $#ctx - 1;
1397 my $ctx = join("\n", @ctx);
1398
Andy Whitcroft548596d2008-07-23 21:29:01 -07001399 my $ctx_ln = $linenr;
1400 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001401
Andy Whitcroft548596d2008-07-23 21:29:01 -07001402 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1403 defined $lines[$ctx_ln - 1] &&
1404 $lines[$ctx_ln - 1] =~ /^-/)) {
1405 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1406 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001407 $ctx_ln++;
1408 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07001409
Andy Whitcroft53210162008-07-23 21:29:03 -07001410 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1411 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001412
1413 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1414 ERROR("that open brace { should be on the previous line\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001415 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001416 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001417 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1418 $ctx =~ /\)\s*\;\s*$/ &&
1419 defined $lines[$ctx_ln - 1])
1420 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001421 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1422 if ($nindent > $indent) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001423 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001424 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001425 }
1426 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001427 }
1428
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001429# Check relative indent for conditionals and blocks.
1430 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1431 my ($s, $c) = ($stat, $cond);
1432
1433 substr($s, 0, length($c), '');
1434
1435 # Make sure we remove the line prefixes as we have
1436 # none on the first line, and are going to readd them
1437 # where necessary.
1438 $s =~ s/\n./\n/gs;
1439
1440 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07001441 my @newlines = ($c =~ /\n/gs);
1442 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001443
1444 # We want to check the first line inside the block
1445 # starting at the end of the conditional, so remove:
1446 # 1) any blank line termination
1447 # 2) any opening brace { on end of the line
1448 # 3) any do (...) {
1449 my $continuation = 0;
1450 my $check = 0;
1451 $s =~ s/^.*\bdo\b//;
1452 $s =~ s/^\s*{//;
1453 if ($s =~ s/^\s*\\//) {
1454 $continuation = 1;
1455 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001456 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001457 $check = 1;
1458 $cond_lines++;
1459 }
1460
1461 # Also ignore a loop construct at the end of a
1462 # preprocessor statement.
1463 if (($prevline =~ /^.\s*#\s*define\s/ ||
1464 $prevline =~ /\\\s*$/) && $continuation == 0) {
1465 $check = 0;
1466 }
1467
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001468 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07001469 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001470 while ($cond_ptr != $cond_lines) {
1471 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001472
Andy Whitcroftf16fa282008-10-15 22:02:32 -07001473 # If we see an #else/#elif then the code
1474 # is not linear.
1475 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1476 $check = 0;
1477 }
1478
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001479 # Ignore:
1480 # 1) blank lines, they should be at 0,
1481 # 2) preprocessor lines, and
1482 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07001483 if ($continuation ||
1484 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001485 $s =~ /^\s*#\s*?/ ||
1486 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07001487 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001488 $s =~ s/^.*?\n//;
1489 $cond_lines++;
1490 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001491 }
1492
1493 my (undef, $sindent) = line_stats("+" . $s);
1494 my $stat_real = raw_line($linenr, $cond_lines);
1495
1496 # Check if either of these lines are modified, else
1497 # this is not this patch's fault.
1498 if (!defined($stat_real) ||
1499 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1500 $check = 0;
1501 }
1502 if (defined($stat_real) && $cond_lines > 1) {
1503 $stat_real = "[...]\n$stat_real";
1504 }
1505
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001506 #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 -07001507
1508 if ($check && (($sindent % 8) != 0 ||
1509 ($sindent <= $indent && $s ne ''))) {
1510 WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1511 }
1512 }
1513
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001514 # Track the 'values' across context and added lines.
1515 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001516 my ($curr_values, $curr_vars) =
1517 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001518 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001519 if ($dbg_values) {
1520 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001521 print "$linenr > .$outline\n";
1522 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001523 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001524 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001525 $prev_values = substr($curr_values, -1);
1526
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001527#ignore lines not being added
1528 if ($line=~/^[^\+]/) {next;}
1529
Andy Whitcroft653d4872007-06-23 17:16:34 -07001530# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07001531 if ($dbg_type) {
1532 if ($line =~ /^.\s*$Declare\s*$/) {
1533 ERROR("TEST: is type\n" . $herecurr);
1534 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1535 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1536 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001537 next;
1538 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001539# TEST: allow direct testing of the attribute matcher.
1540 if ($dbg_attr) {
1541 if ($line =~ /^.\s*$Attribute\s*$/) {
1542 ERROR("TEST: is attr\n" . $herecurr);
1543 } elsif ($dbg_attr > 1 && $line =~ /^.+($Attribute)/) {
1544 ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1545 }
1546 next;
1547 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001548
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001549# check for initialisation to aggregates open brace on the next line
1550 if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1551 $line =~ /^.\s*{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001552 ERROR("that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001553 }
1554
Andy Whitcroft653d4872007-06-23 17:16:34 -07001555#
1556# Checks which are anchored on the added line.
1557#
1558
1559# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001560 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001561 my $path = $1;
1562 if ($path =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001563 ERROR("malformed #include filename\n" .
1564 $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001565 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001566 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001567
1568# no C99 // comments
1569 if ($line =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001570 ERROR("do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001571 }
1572 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001573 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001574 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001575
1576#EXPORT_SYMBOL should immediately follow its function closing }.
Andy Whitcroft653d4872007-06-23 17:16:34 -07001577 if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1578 ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1579 my $name = $1;
Andy Whitcroft48012052008-10-15 22:02:34 -07001580 if ($prevline !~ /(?:
1581 ^.}|
1582 ^.DEFINE_$Ident\(\Q$name\E\)|
1583 ^.DECLARE_$Ident\(\Q$name\E\)|
1584 ^.LIST_HEAD\(\Q$name\E\)|
1585 ^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
1586 \b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)
1587 )/x) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001588 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001589 }
1590 }
1591
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001592# check for external initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001593 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001594 ERROR("do not initialise externals to 0 or NULL\n" .
1595 $herecurr);
1596 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001597# check for static initialisers.
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001598 if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001599 ERROR("do not initialise statics to 0 or NULL\n" .
1600 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001601 }
1602
Andy Whitcroft653d4872007-06-23 17:16:34 -07001603# check for new typedefs, only function parameters and sparse annotations
1604# make sense.
1605 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001606 $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001607 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07001608 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001609 $line !~ /\b__bitwise(?:__|)\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001610 WARN("do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001611 }
1612
1613# * goes on variable not on type
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001614 if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001615 ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" .
1616 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001617
1618 } elsif ($line =~ m{\($NonptrType\s+(\*+)(?!\s+const)\s+\)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001619 ERROR("\"(foo $1 )\" should be \"(foo $1)\"\n" .
1620 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001621
Andy Whitcroft234fff62008-07-23 21:29:12 -07001622 } elsif ($line =~ m{\b$NonptrType(\*+)(?:\s+(?:$Attribute|$Sparse))?\s+[A-Za-z\d_]+}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001623 ERROR("\"foo$1 bar\" should be \"foo $1bar\"\n" .
1624 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001625
Andy Whitcroft234fff62008-07-23 21:29:12 -07001626 } elsif ($line =~ m{\b$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001627 ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" .
1628 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001629 }
1630
1631# # no BUG() or BUG_ON()
1632# if ($line =~ /\b(BUG|BUG_ON)\b/) {
1633# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1634# print "$herecurr";
1635# $clean = 0;
1636# }
1637
Andy Whitcroft8905a672007-11-28 16:21:06 -08001638 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001639 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 -08001640 }
1641
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001642# printk should use KERN_* levels. Note that follow on printk's on the
1643# same line do not need a level, so we use the current block context
1644# to try and find and validate the current printk. In summary the current
1645# printk includes all preceeding printk's which have no newline on the end.
1646# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001647 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001648 my $ok = 0;
1649 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1650 #print "CHECK<$lines[$ln - 1]\n";
1651 # we have a preceeding printk if it ends
1652 # with "\n" ignore it, else it is to blame
1653 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1654 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1655 $ok = 1;
1656 }
1657 last;
1658 }
1659 }
1660 if ($ok == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001661 WARN("printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001662 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001663 }
1664
Andy Whitcroft653d4872007-06-23 17:16:34 -07001665# function brace can't be on same line, except for #defines of do while,
1666# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001667 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1668 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001669 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001670 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001671
Andy Whitcroft8905a672007-11-28 16:21:06 -08001672# open braces for enum, union and struct go on the same line.
1673 if ($line =~ /^.\s*{/ &&
1674 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1675 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1676 }
1677
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001678# check for spacing round square brackets; allowed:
1679# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001680# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1681# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001682 while ($line =~ /(.*?\s)\[/g) {
1683 my ($where, $prefix) = ($-[1], $1);
1684 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001685 ($where != 0 || $prefix !~ /^.\s+$/) &&
1686 $prefix !~ /{\s+$/) {
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001687 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1688 }
1689 }
1690
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001691# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001692 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001693 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001694 my $ctx_before = substr($line, 0, $-[1]);
1695 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001696
1697 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001698 if ($name =~ /^(?:
1699 if|for|while|switch|return|case|
1700 volatile|__volatile__|
1701 __attribute__|format|__extension__|
1702 asm|__asm__)$/x)
1703 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001704
1705 # cpp #define statements have non-optional spaces, ie
1706 # if there is a space between the name and the open
1707 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001708 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001709
1710 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001711 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001712
1713 # If this whole things ends with a type its most
1714 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001715 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001716
1717 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001718 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001719 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001720 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001721# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001722 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001723 my $ops = qr{
1724 <<=|>>=|<=|>=|==|!=|
1725 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1726 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001727 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1728 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001729 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001730 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001731 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001732
1733 my $blank = copy_spacing($opline);
1734
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001735 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001736 $off += length($elements[$n]);
1737
Andy Whitcroft773647a2008-03-28 14:15:58 -07001738 # Pick up the preceeding and succeeding characters.
1739 my $ca = substr($opline, 0, $off);
1740 my $cc = '';
1741 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1742 $cc = substr($opline, $off + length($elements[$n + 1]));
1743 }
1744 my $cb = "$ca$;$cc";
1745
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001746 my $a = '';
1747 $a = 'V' if ($elements[$n] ne '');
1748 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001749 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001750 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1751 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07001752 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001753
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001754 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001755
1756 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001757 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001758 $c = 'V' if ($elements[$n + 2] ne '');
1759 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001760 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001761 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1762 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001763 $c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001764 } else {
1765 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001766 }
1767
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001768 my $ctx = "${a}x${c}";
1769
1770 my $at = "(ctx:$ctx)";
1771
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001772 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001773 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001774
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001775 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001776 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001777
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001778 # Get the full operator variant.
1779 my $opv = $op . substr($curr_vars, $off, 1);
1780
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001781 # Ignore operators passed as parameters.
1782 if ($op_type ne 'V' &&
1783 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1784
Andy Whitcroftcf655042008-03-04 14:28:20 -08001785# # Ignore comments
1786# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001787
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001788 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001789 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001790 if ($ctx !~ /.x[WEBC]/ &&
1791 $cc !~ /^\\/ && $cc !~ /^;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001792 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001793 }
1794
1795 # // is a comment
1796 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001797
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001798 # No spaces for:
1799 # ->
1800 # : when part of a bitfield
1801 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001802 if ($ctx =~ /Wx.|.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001803 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001804 }
1805
1806 # , must have a space on the right.
1807 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001808 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001809 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001810 }
1811
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001812 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001813 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001814 #warn "'*' is part of type\n";
1815
1816 # unary operators should have a space before and
1817 # none after. May be left adjacent to another
1818 # unary operator, or a cast
1819 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001820 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07001821 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001822 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001823 ERROR("space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001824 }
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001825 if ($op eq '*' && $cc =~/\s*const\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001826 # A unary '*' may be const
1827
1828 } elsif ($ctx =~ /.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001829 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001830 }
1831
1832 # unary ++ and unary -- are allowed no space on one side.
1833 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001834 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1835 ERROR("space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001836 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001837 if ($ctx =~ /Wx[BE]/ ||
1838 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1839 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001840 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001841 if ($ctx =~ /ExW/) {
1842 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1843 }
1844
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001845
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001846 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001847 } elsif ($op eq '<<' or $op eq '>>' or
1848 $op eq '&' or $op eq '^' or $op eq '|' or
1849 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001850 $op eq '*' or $op eq '/' or
1851 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001852 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001853 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001854 ERROR("need consistent spacing around '$op' $at\n" .
1855 $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001856 }
1857
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001858 # A colon needs no spaces before when it is
1859 # terminating a case value or a label.
1860 } elsif ($opv eq ':C' || $opv eq ':L') {
1861 if ($ctx =~ /Wx./) {
1862 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1863 }
1864
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001865 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08001866 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001867 my $ok = 0;
1868
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001869 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001870 if (($op eq '<' &&
1871 $cc =~ /^\S+\@\S+>/) ||
1872 ($op eq '>' &&
1873 $ca =~ /<\S+\@\S+$/))
1874 {
1875 $ok = 1;
1876 }
1877
1878 # Ignore ?:
1879 if (($opv eq ':O' && $ca =~ /\?$/) ||
1880 ($op eq '?' && $cc =~ /^:/)) {
1881 $ok = 1;
1882 }
1883
1884 if ($ok == 0) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001885 ERROR("spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001886 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001887 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001888 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001889 }
1890 }
1891
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001892# check for multiple assignments
1893 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001894 CHK("multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001895 }
1896
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001897## # check for multiple declarations, allowing for a function declaration
1898## # continuation.
1899## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
1900## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
1901##
1902## # Remove any bracketed sections to ensure we do not
1903## # falsly report the parameters of functions.
1904## my $ln = $line;
1905## while ($ln =~ s/\([^\(\)]*\)//g) {
1906## }
1907## if ($ln =~ /,/) {
1908## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
1909## }
1910## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001911
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001912#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001913 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
1914 $line =~ /do{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001915 ERROR("space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001916 }
1917
1918# closing brace should have a space following it when it has anything
1919# on the line
1920 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001921 ERROR("space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001922 }
1923
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001924# check spacing on square brackets
1925 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001926 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001927 }
1928 if ($line =~ /\s\]/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001929 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001930 }
1931
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001932# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001933 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
1934 $line !~ /for\s*\(\s+;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001935 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001936 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001937 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001938 $line !~ /for\s*\(.*;\s+\)/ &&
1939 $line !~ /:\s+\)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001940 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001941 }
1942
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001943#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001944 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001945 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001946 WARN("labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001947 }
1948
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001949# Return is not a function.
1950 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
1951 my $spacing = $1;
1952 my $value = $2;
1953
1954 # Flatten any parentheses and braces
Andy Whitcroftfee61c42008-07-23 21:28:56 -07001955 $value =~ s/\)\(/\) \(/g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001956 while ($value =~ s/\([^\(\)]*\)/1/) {
1957 }
1958
1959 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
1960 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
1961
1962 } elsif ($spacing !~ /\s+/) {
1963 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1964 }
1965 }
1966
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001967# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001968 if ($line=~/\b(if|while|for|switch)\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001969 ERROR("space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001970 }
1971
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001972# Check for illegal assignment in if conditional -- and check for trailing
1973# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001974 if ($line =~ /do\s*(?!{)/) {
1975 my ($stat_next) = ctx_statement_block($line_nr_next,
1976 $remain_next, $off_next);
1977 $stat_next =~ s/\n./\n /g;
1978 ##print "stat<$stat> stat_next<$stat_next>\n";
1979
1980 if ($stat_next =~ /^\s*while\b/) {
1981 # If the statement carries leading newlines,
1982 # then count those as offsets.
1983 my ($whitespace) =
1984 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
1985 my $offset =
1986 statement_rawlines($whitespace) - 1;
1987
1988 $suppress_whiletrailers{$line_nr_next +
1989 $offset} = 1;
1990 }
1991 }
1992 if (!defined $suppress_whiletrailers{$linenr} &&
1993 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001994 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001995
1996 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001997 ERROR("do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001998 }
1999
2000 # Find out what is on the end of the line after the
2001 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002002 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002003 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002004 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07002005 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2006 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002007 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002008 # Find out how long the conditional actually is.
2009 my @newlines = ($c =~ /\n/gs);
2010 my $cond_lines = 1 + $#newlines;
2011
2012 my $stat_real = raw_line($linenr, $cond_lines);
2013 if (defined($stat_real) && $cond_lines > 1) {
2014 $stat_real = "[...]\n$stat_real";
2015 }
2016
2017 ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002018 }
2019 }
2020
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002021# Check for bitwise tests written as boolean
2022 if ($line =~ /
2023 (?:
2024 (?:\[|\(|\&\&|\|\|)
2025 \s*0[xX][0-9]+\s*
2026 (?:\&\&|\|\|)
2027 |
2028 (?:\&\&|\|\|)
2029 \s*0[xX][0-9]+\s*
2030 (?:\&\&|\|\||\)|\])
2031 )/x)
2032 {
2033 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2034 }
2035
Andy Whitcroft8905a672007-11-28 16:21:06 -08002036# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002037 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2038 my $s = $1;
2039 $s =~ s/$;//g; # Remove any comments
2040 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2041 ERROR("trailing statements should be on next line\n" . $herecurr);
2042 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002043 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002044# case and default should not have general statements after them
2045 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2046 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07002047 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002048 \s*return\s+
2049 )/xg)
2050 {
2051 ERROR("trailing statements should be on next line\n" . $herecurr);
2052 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002053
2054 # Check for }<nl>else {, these must be at the same
2055 # indent level to be relevant to each other.
2056 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2057 $previndent == $indent) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002058 ERROR("else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002059 }
2060
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002061 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2062 $previndent == $indent) {
2063 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2064
2065 # Find out what is on the end of the line after the
2066 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002067 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002068 $s =~ s/\n.*//g;
2069
2070 if ($s =~ /^\s*;/) {
2071 ERROR("while should follow close brace '}'\n" . $hereprev);
2072 }
2073 }
2074
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002075#studly caps, commented out until figure out how to distinguish between use of existing and adding new
2076# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2077# print "No studly caps, use _\n";
2078# print "$herecurr";
2079# $clean = 0;
2080# }
2081
2082#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002083 if ($line=~/\#\s*define.*\\\s$/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002084 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002085 }
2086
Andy Whitcroft653d4872007-06-23 17:16:34 -07002087#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002088 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002089 my $file = "$1.h";
2090 my $checkfile = "include/linux/$file";
2091 if (-f "$root/$checkfile" &&
2092 $realfile ne $checkfile &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002093 $1 ne 'irq')
2094 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002095 if ($realfile =~ m{^arch/}) {
2096 CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2097 } else {
2098 WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2099 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002100 }
2101 }
2102
Andy Whitcroft653d4872007-06-23 17:16:34 -07002103# multi-statement macros should be enclosed in a do while loop, grab the
2104# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08002105# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07002106 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2107 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002108 my $ln = $linenr;
2109 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002110 my ($off, $dstat, $dcond, $rest);
2111 my $ctx = '';
Andy Whitcroft653d4872007-06-23 17:16:34 -07002112
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002113 my $args = defined($1);
2114
2115 # Find the end of the macro and limit our statement
2116 # search to that.
2117 while ($cnt > 0 && defined $lines[$ln - 1] &&
2118 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2119 {
2120 $ctx .= $rawlines[$ln - 1] . "\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002121 $cnt-- if ($lines[$ln - 1] !~ /^-/);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002122 $ln++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002123 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002124 $ctx .= $rawlines[$ln - 1];
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002125
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002126 ($dstat, $dcond, $ln, $cnt, $off) =
2127 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2128 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002129 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002130
2131 # Extract the remainder of the define (if any) and
2132 # rip off surrounding spaces, and trailing \'s.
2133 $rest = '';
Andy Whitcroft636d140a2008-10-15 22:02:18 -07002134 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2135 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002136 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2137 $rest .= substr($lines[$ln - 1], $off) . "\n";
2138 $cnt--;
2139 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002140 $ln++;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002141 $off = 0;
2142 }
2143 $rest =~ s/\\\n.//g;
2144 $rest =~ s/^\s*//s;
2145 $rest =~ s/\s*$//s;
2146
2147 # Clean up the original statement.
2148 if ($args) {
2149 substr($dstat, 0, length($dcond), '');
2150 } else {
2151 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2152 }
Andy Whitcroft292f1a92008-07-23 21:29:11 -07002153 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002154 $dstat =~ s/\\\n.//g;
2155 $dstat =~ s/^\s*//s;
2156 $dstat =~ s/\s*$//s;
2157
2158 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07002159 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2160 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2161 $dstat =~ s/\[[^\{\}]*\]/1/)
2162 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002163 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002164
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002165 my $exceptions = qr{
2166 $Declare|
2167 module_param_named|
2168 MODULE_PARAM_DESC|
2169 DECLARE_PER_CPU|
2170 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08002171 __typeof__\(|
2172 \.$Ident\s*=\s*
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002173 }x;
Andy Whitcroft383099f2009-01-06 14:41:18 -08002174 #print "REST<$rest> dstat<$dstat>\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002175 if ($rest ne '') {
2176 if ($rest !~ /while\s*\(/ &&
2177 $dstat !~ /$exceptions/)
2178 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002179 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 -07002180 }
2181
2182 } elsif ($ctx !~ /;/) {
2183 if ($dstat ne '' &&
2184 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2185 $dstat !~ /$exceptions/ &&
Andy Whitcroftb132e5d2008-10-15 22:02:31 -07002186 $dstat !~ /^\.$Ident\s*=/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002187 $dstat =~ /$Operators/)
2188 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002189 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002190 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002191 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002192 }
2193
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002194# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002195 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2196 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08002197 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002198 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002199 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2200 if ($#chunks > 0 && $level == 0) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002201 my $allowed = 0;
2202 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002203 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002204 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002205 for my $chunk (@chunks) {
2206 my ($cond, $block) = @{$chunk};
2207
Andy Whitcroft773647a2008-03-28 14:15:58 -07002208 # If the condition carries leading newlines, then count those as offsets.
2209 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2210 my $offset = statement_rawlines($whitespace) - 1;
2211
2212 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2213
2214 # We have looked at and allowed this specific line.
2215 $suppress_ifbraces{$ln + $offset} = 1;
2216
2217 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002218 $ln += statement_rawlines($block) - 1;
2219
Andy Whitcroft773647a2008-03-28 14:15:58 -07002220 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002221
2222 $seen++ if ($block =~ /^\s*{/);
2223
Andy Whitcroftcf655042008-03-04 14:28:20 -08002224 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2225 if (statement_lines($cond) > 1) {
2226 #print "APW: ALLOWED: cond<$cond>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002227 $allowed = 1;
2228 }
2229 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002230 #print "APW: ALLOWED: block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002231 $allowed = 1;
2232 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002233 if (statement_block_size($block) > 1) {
2234 #print "APW: ALLOWED: lines block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002235 $allowed = 1;
2236 }
2237 }
2238 if ($seen && !$allowed) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002239 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002240 }
2241 }
2242 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002243 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002244 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002245 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002246
Andy Whitcroftcf655042008-03-04 14:28:20 -08002247 # Check the pre-context.
2248 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2249 #print "APW: ALLOWED: pre<$1>\n";
2250 $allowed = 1;
2251 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002252
2253 my ($level, $endln, @chunks) =
2254 ctx_statement_full($linenr, $realcnt, $-[0]);
2255
Andy Whitcroftcf655042008-03-04 14:28:20 -08002256 # Check the condition.
2257 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07002258 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002259 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002260 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08002261 }
2262 if (statement_lines($cond) > 1) {
2263 #print "APW: ALLOWED: cond<$cond>\n";
2264 $allowed = 1;
2265 }
2266 if ($block =~/\b(?:if|for|while)\b/) {
2267 #print "APW: ALLOWED: block<$block>\n";
2268 $allowed = 1;
2269 }
2270 if (statement_block_size($block) > 1) {
2271 #print "APW: ALLOWED: lines block<$block>\n";
2272 $allowed = 1;
2273 }
2274 # Check the post-context.
2275 if (defined $chunks[1]) {
2276 my ($cond, $block) = @{$chunks[1]};
2277 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002278 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002279 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002280 if ($block =~ /^\s*\{/) {
2281 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2282 $allowed = 1;
2283 }
2284 }
2285 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2286 my $herectx = $here . "\n";;
Andy Whitcroftf0556632008-10-15 22:02:23 -07002287 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002288
Andy Whitcroftf0556632008-10-15 22:02:23 -07002289 for (my $n = 0; $n < $cnt; $n++) {
2290 $herectx .= raw_line($linenr, $n) . "\n";;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002291 }
2292
2293 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002294 }
2295 }
2296
Andy Whitcroft653d4872007-06-23 17:16:34 -07002297# don't include deprecated include files (uses RAW line)
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002298 for my $inc (@dep_includes) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002299 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002300 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002301 }
2302 }
2303
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002304# don't use deprecated functions
2305 for my $func (@dep_functions) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002306 if ($line =~ /\b$func\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002307 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002308 }
2309 }
2310
2311# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002312 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2313 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002314 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002315 }
2316
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002317# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2318 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2319 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2320 }
2321
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002322# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002323 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002324 CHK("if this code is redundant consider removing it\n" .
2325 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002326 }
2327
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002328# check for needless kfree() checks
2329 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2330 my $expr = $1;
2331 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
Wolfram Sang3c232142008-07-23 21:29:05 -07002332 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002333 }
2334 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07002335# check for needless usb_free_urb() checks
2336 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2337 my $expr = $1;
2338 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2339 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2340 }
2341 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002342
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002343# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002344# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002345# print "#ifdef in C files should be avoided\n";
2346# print "$herecurr";
2347# $clean = 0;
2348# }
2349
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002350# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002351 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002352 ERROR("exactly one space required after that #$1\n" . $herecurr);
2353 }
2354
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002355# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002356 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2357 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002358 my $which = $1;
2359 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002360 CHK("$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002361 }
2362 }
2363# check for memory barriers without a comment.
2364 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2365 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002366 CHK("memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002367 }
2368 }
2369# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002370 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002371 CHK("architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002372 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002373
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002374# check the location of the inline attribute, that it is between
2375# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002376 if ($line =~ /\b$Type\s+$Inline\b/ ||
2377 $line =~ /\b$Inline\s+$Storage\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002378 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2379 }
2380
Andy Whitcroft8905a672007-11-28 16:21:06 -08002381# Check for __inline__ and __inline, prefer inline
2382 if ($line =~ /\b(__inline__|__inline)\b/) {
2383 WARN("plain inline is preferred over $1\n" . $herecurr);
2384 }
2385
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002386# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002387 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002388 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002389 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002390 my $function_name = $1;
2391 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002392
2393 my $s = $stat;
2394 if (defined $cond) {
2395 substr($s, 0, length($cond), '');
2396 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002397 if ($s =~ /^\s*;/ &&
2398 $function_name ne 'uninitialized_var')
2399 {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002400 WARN("externs should be avoided in .c files\n" . $herecurr);
2401 }
2402
2403 if ($paren_space =~ /\n/) {
2404 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2405 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002406
2407 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2408 $stat =~ /^.\s*extern\s+/)
2409 {
2410 WARN("externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002411 }
2412
2413# checks for new __setup's
2414 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2415 my $name = $1;
2416
2417 if (!grep(/$name/, @setup_docs)) {
2418 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2419 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002420 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002421
2422# check for pointless casting of kmalloc return
2423 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2424 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2425 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002426
2427# check for gcc specific __FUNCTION__
2428 if ($line =~ /__FUNCTION__/) {
2429 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2430 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002431
2432# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002433 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002434 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2435 }
2436# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002437 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002438 WARN("consider using a completion\n" . $herecurr);
2439 }
2440# recommend strict_strto* over simple_strto*
2441 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2442 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2443 }
Michael Ellermanf3db6632008-07-23 21:28:57 -07002444# check for __initcall(), use device_initcall() explicitly please
2445 if ($line =~ /^.\s*__initcall\s*\(/) {
2446 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2447 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002448
2449# use of NR_CPUS is usually wrong
2450# ignore definitions of NR_CPUS and usage to define arrays as likely right
2451 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002452 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2453 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002454 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2455 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2456 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002457 {
2458 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2459 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002460
2461# check for %L{u,d,i} in strings
2462 my $string;
2463 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2464 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07002465 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002466 if ($string =~ /(?<!%)%L[udi]/) {
2467 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2468 last;
2469 }
2470 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08002471
2472# whine mightly about in_atomic
2473 if ($line =~ /\bin_atomic\s*\(/) {
2474 if ($realfile =~ m@^drivers/@) {
2475 ERROR("do not use in_atomic in drivers\n" . $herecurr);
2476 } else {
2477 WARN("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
2478 }
2479 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002480 }
2481
2482 # If we have no input at all, then there is nothing to report on
2483 # so just keep quiet.
2484 if ($#rawlines == -1) {
2485 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002486 }
2487
Andy Whitcroft8905a672007-11-28 16:21:06 -08002488 # In mailback mode only produce a report in the negative, for
2489 # things that appear to be patches.
2490 if ($mailback && ($clean == 1 || !$is_patch)) {
2491 exit(0);
2492 }
2493
2494 # This is not a patch, and we are are in 'no-patch' mode so
2495 # just keep quiet.
2496 if (!$chk_patch && !$is_patch) {
2497 exit(0);
2498 }
2499
2500 if (!$is_patch) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002501 ERROR("Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002502 }
2503 if ($is_patch && $chk_signoff && $signoff == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002504 ERROR("Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002505 }
2506
Andy Whitcroft8905a672007-11-28 16:21:06 -08002507 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002508 if ($summary && !($clean == 1 && $quiet == 1)) {
2509 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002510 print "total: $cnt_error errors, $cnt_warn warnings, " .
2511 (($check)? "$cnt_chk checks, " : "") .
2512 "$cnt_lines lines checked\n";
2513 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002514 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002515
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002516 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002517 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002518 }
2519 if ($clean == 0 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002520 print "$vname has style problems, please review. If any of these errors\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002521 print "are false positives report them to the maintainer, see\n";
2522 print "CHECKPATCH in MAINTAINERS.\n";
2523 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002524
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002525 return $clean;
2526}