blob: aa009a3b5b81cbcd6f7766cef3956b90ed2bbc01 [file] [log] [blame]
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesf4432c52008-10-20 13:31:45 -04002# (c) 2001, Dave Jones. <davej@redhat.com> (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
5# (c) 2008, Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
9
10my $P = $0;
Andy Whitcroft00df3442007-06-08 13:47:06 -070011$P =~ s@.*/@@g;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070012
Andy Whitcroftbea56062009-02-27 14:03:09 -080013my $V = '0.28';
Andy Whitcroft0a920b52007-06-01 00:46:48 -070014
15use Getopt::Long qw(:config no_auto_abbrev);
16
17my $quiet = 0;
18my $tree = 1;
19my $chk_signoff = 1;
20my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070021my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070022my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080023my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070024my $file = 0;
25my $check = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080026my $summary = 1;
27my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080028my $summary_file = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070029my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080030my %debug;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070031GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070032 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-06-01 00:46:48 -070033 'tree!' => \$tree,
34 'signoff!' => \$chk_signoff,
35 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070036 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -080037 'terse!' => \$terse,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070038 'file!' => \$file,
39 'subjective!' => \$check,
40 'strict!' => \$check,
41 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -080042 'summary!' => \$summary,
43 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -080044 'summary-file!' => \$summary_file,
45
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080046 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -070047 'test-only=s' => \$tst_only,
Andy Whitcroft0a920b52007-06-01 00:46:48 -070048) or exit;
49
50my $exit = 0;
51
52if ($#ARGV < 0) {
Andy Whitcroft00df3442007-06-08 13:47:06 -070053 print "usage: $P [options] patchfile\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -070054 print "version: $V\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -080055 print "options: -q => quiet\n";
56 print " --no-tree => run without a kernel tree\n";
57 print " --terse => one line per report\n";
58 print " --emacs => emacs compile window format\n";
59 print " --file => check a source file\n";
60 print " --strict => enable more subjective tests\n";
61 print " --root => path to the kernel tree root\n";
62 print " --no-summary => suppress the per-file summary\n";
63 print " --summary-file => include the filename in summary\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -070064 exit(1);
65}
66
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080067my $dbg_values = 0;
68my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -070069my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -070070my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080071for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -080072 ## no critic
73 eval "\${dbg_$key} = '$debug{$key}';";
74 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080075}
76
Andy Whitcroft8905a672007-11-28 16:21:06 -080077if ($terse) {
78 $emacs = 1;
79 $quiet++;
80}
81
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070082if ($tree) {
83 if (defined $root) {
84 if (!top_of_kernel_tree($root)) {
85 die "$P: $root: --root does not point at a valid tree\n";
86 }
87 } else {
88 if (top_of_kernel_tree('.')) {
89 $root = '.';
90 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
91 top_of_kernel_tree($1)) {
92 $root = $1;
93 }
94 }
95
96 if (!defined $root) {
97 print "Must be run from the top-level dir. of a kernel tree\n";
98 exit(2);
99 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700100}
101
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700102my $emitted_corrupt = 0;
103
104our $Ident = qr{[A-Za-z_][A-Za-z\d_]*};
105our $Storage = qr{extern|static|asmlinkage};
106our $Sparse = qr{
107 __user|
108 __kernel|
109 __force|
110 __iomem|
111 __must_check|
112 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800113 __kprobes|
114 __ref
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700115 }x;
116our $Attribute = qr{
117 const|
118 __read_mostly|
119 __kprobes|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700120 __(?:mem|cpu|dev|)(?:initdata|init)|
121 ____cacheline_aligned|
122 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800123 ____cacheline_internodealigned_in_smp|
124 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700125 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700126our $Modifier;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700127our $Inline = qr{inline|__always_inline|noinline};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700128our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
129our $Lval = qr{$Ident(?:$Member)*};
130
131our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
132our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
Andy Whitcroft86f9d052009-01-06 14:41:24 -0800133our $Compare = qr{<=|>=|==|!=|<|>};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700134our $Operators = qr{
135 <=|>=|==|!=|
136 =>|->|<<|>>|<|>|!|~|
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800137 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700138 }x;
139
Andy Whitcroft8905a672007-11-28 16:21:06 -0800140our $NonptrType;
141our $Type;
142our $Declare;
143
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700144our $UTF8 = qr {
145 [\x09\x0A\x0D\x20-\x7E] # ASCII
146 | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
147 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
148 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
149 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
150 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
151 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
152 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
153}x;
154
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700155our $typeTypedefs = qr{(?x:
156 (?:__)?(?:u|s|be|le)(?:\d|\d\d)|
157 atomic_t
158)};
159
Andy Whitcroft8905a672007-11-28 16:21:06 -0800160our @typeList = (
161 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700162 qr{(?:unsigned\s+)?char},
163 qr{(?:unsigned\s+)?short},
164 qr{(?:unsigned\s+)?int},
165 qr{(?:unsigned\s+)?long},
166 qr{(?:unsigned\s+)?long\s+int},
167 qr{(?:unsigned\s+)?long\s+long},
168 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800169 qr{unsigned},
170 qr{float},
171 qr{double},
172 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800173 qr{struct\s+$Ident},
174 qr{union\s+$Ident},
175 qr{enum\s+$Ident},
176 qr{${Ident}_t},
177 qr{${Ident}_handler},
178 qr{${Ident}_handler_fn},
179);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700180our @modifierList = (
181 qr{fastcall},
182);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800183
184sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700185 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
186 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700187 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800188 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700189 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800190 (?:
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700191 (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700192 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700193 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800194 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700195 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800196 }x;
197 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700198 $NonptrType
Andy Whitcroft65863862009-01-06 14:41:21 -0800199 (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700200 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800201 }x;
202 $Declare = qr{(?:$Storage\s+)?$Type};
203}
204build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700205
206$chk_signoff = 0 if ($file);
207
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700208my @dep_includes = ();
209my @dep_functions = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700210my $removal = "Documentation/feature-removal-schedule.txt";
211if ($tree && -f "$root/$removal") {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800212 open(my $REMOVE, '<', "$root/$removal") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700213 die "$P: $removal: open failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800214 while (<$REMOVE>) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700215 if (/^Check:\s+(.*\S)/) {
216 for my $entry (split(/[, ]+/, $1)) {
217 if ($entry =~ m@include/(.*)@) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700218 push(@dep_includes, $1);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700219
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700220 } elsif ($entry !~ m@/@) {
221 push(@dep_functions, $entry);
222 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700223 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700224 }
225 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800226 close($REMOVE);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700227}
228
Andy Whitcroft00df3442007-06-08 13:47:06 -0700229my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800230my @lines = ();
231my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700232for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800233 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700234 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800235 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700236 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800237 } elsif ($filename eq '-') {
238 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700239 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800240 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700241 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700242 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800243 if ($filename eq '-') {
244 $vname = 'Your patch';
245 } else {
246 $vname = $filename;
247 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800248 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700249 chomp;
250 push(@rawlines, $_);
251 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800252 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800253 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700254 $exit = 1;
255 }
256 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800257 @lines = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700258}
259
260exit($exit);
261
262sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700263 my ($root) = @_;
264
265 my @tree_check = (
266 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
267 "README", "Documentation", "arch", "include", "drivers",
268 "fs", "init", "ipc", "kernel", "lib", "scripts",
269 );
270
271 foreach my $check (@tree_check) {
272 if (! -e $root . '/' . $check) {
273 return 0;
274 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700275 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700276 return 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700277}
278
279sub expand_tabs {
280 my ($str) = @_;
281
282 my $res = '';
283 my $n = 0;
284 for my $c (split(//, $str)) {
285 if ($c eq "\t") {
286 $res .= ' ';
287 $n++;
288 for (; ($n % 8) != 0; $n++) {
289 $res .= ' ';
290 }
291 next;
292 }
293 $res .= $c;
294 $n++;
295 }
296
297 return $res;
298}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700299sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700300 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700301 return $res;
302}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700303
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700304sub line_stats {
305 my ($line) = @_;
306
307 # Drop the diff line leader and expand tabs
308 $line =~ s/^.//;
309 $line = expand_tabs($line);
310
311 # Pick the indent from the front of the line.
312 my ($white) = ($line =~ /^(\s*)/);
313
314 return (length($line), length($white));
315}
316
Andy Whitcroft773647a2008-03-28 14:15:58 -0700317my $sanitise_quote = '';
318
319sub sanitise_line_reset {
320 my ($in_comment) = @_;
321
322 if ($in_comment) {
323 $sanitise_quote = '*/';
324 } else {
325 $sanitise_quote = '';
326 }
327}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700328sub sanitise_line {
329 my ($line) = @_;
330
331 my $res = '';
332 my $l = '';
333
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800334 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700335 my $off = 0;
336 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700337
Andy Whitcroft773647a2008-03-28 14:15:58 -0700338 # Always copy over the diff marker.
339 $res = substr($line, 0, 1);
340
341 for ($off = 1; $off < length($line); $off++) {
342 $c = substr($line, $off, 1);
343
344 # Comments we are wacking completly including the begin
345 # and end, all to $;.
346 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
347 $sanitise_quote = '*/';
348
349 substr($res, $off, 2, "$;$;");
350 $off++;
351 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800352 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700353 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700354 $sanitise_quote = '';
355 substr($res, $off, 2, "$;$;");
356 $off++;
357 next;
358 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700359 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
360 $sanitise_quote = '//';
361
362 substr($res, $off, 2, $sanitise_quote);
363 $off++;
364 next;
365 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700366
367 # A \ in a string means ignore the next character.
368 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
369 $c eq "\\") {
370 substr($res, $off, 2, 'XX');
371 $off++;
372 next;
373 }
374 # Regular quotes.
375 if ($c eq "'" || $c eq '"') {
376 if ($sanitise_quote eq '') {
377 $sanitise_quote = $c;
378
379 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700380 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700381 } elsif ($sanitise_quote eq $c) {
382 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700383 }
384 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700385
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800386 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700387 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
388 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700389 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
390 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700391 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
392 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700393 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700394 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700395 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800396 }
397
Daniel Walker113f04a2009-09-21 17:04:35 -0700398 if ($sanitise_quote eq '//') {
399 $sanitise_quote = '';
400 }
401
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800402 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700403 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800404 my $clean = 'X' x length($1);
405 $res =~ s@\<.*\>@<$clean>@;
406
407 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700408 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800409 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700410 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800411 }
412
Andy Whitcroft00df3442007-06-08 13:47:06 -0700413 return $res;
414}
415
Andy Whitcroft8905a672007-11-28 16:21:06 -0800416sub ctx_statement_block {
417 my ($linenr, $remain, $off) = @_;
418 my $line = $linenr - 1;
419 my $blk = '';
420 my $soff = $off;
421 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700422 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800423
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800424 my $loff = 0;
425
Andy Whitcroft8905a672007-11-28 16:21:06 -0800426 my $type = '';
427 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800428 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800429 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800430 my $c;
431 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800432
433 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800434 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800435 @stack = (['', 0]) if ($#stack == -1);
436
Andy Whitcroft773647a2008-03-28 14:15:58 -0700437 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800438 # If we are about to drop off the end, pull in more
439 # context.
440 if ($off >= $len) {
441 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700442 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800443 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800444 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800445 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800446 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800447 $len = length($blk);
448 $line++;
449 last;
450 }
451 # Bail if there is no further context.
452 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800453 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800454 last;
455 }
456 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800457 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800458 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800459 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800460
Andy Whitcroft773647a2008-03-28 14:15:58 -0700461 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800462
463 # Handle nested #if/#else.
464 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
465 push(@stack, [ $type, $level ]);
466 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
467 ($type, $level) = @{$stack[$#stack - 1]};
468 } elsif ($remainder =~ /^#\s*endif\b/) {
469 ($type, $level) = @{pop(@stack)};
470 }
471
Andy Whitcroft8905a672007-11-28 16:21:06 -0800472 # Statement ends at the ';' or a close '}' at the
473 # outermost level.
474 if ($level == 0 && $c eq ';') {
475 last;
476 }
477
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800478 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700479 if ($level == 0 && $coff_set == 0 &&
480 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
481 $remainder =~ /^(else)(?:\s|{)/ &&
482 $remainder !~ /^else\s+if\b/) {
483 $coff = $off + length($1) - 1;
484 $coff_set = 1;
485 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
486 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800487 }
488
Andy Whitcroft8905a672007-11-28 16:21:06 -0800489 if (($type eq '' || $type eq '(') && $c eq '(') {
490 $level++;
491 $type = '(';
492 }
493 if ($type eq '(' && $c eq ')') {
494 $level--;
495 $type = ($level != 0)? '(' : '';
496
497 if ($level == 0 && $coff < $soff) {
498 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700499 $coff_set = 1;
500 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800501 }
502 }
503 if (($type eq '' || $type eq '{') && $c eq '{') {
504 $level++;
505 $type = '{';
506 }
507 if ($type eq '{' && $c eq '}') {
508 $level--;
509 $type = ($level != 0)? '{' : '';
510
511 if ($level == 0) {
512 last;
513 }
514 }
515 $off++;
516 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700517 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800518 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700519 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800520 $line++;
521 $remain--;
522 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800523
524 my $statement = substr($blk, $soff, $off - $soff + 1);
525 my $condition = substr($blk, $soff, $coff - $soff + 1);
526
527 #warn "STATEMENT<$statement>\n";
528 #warn "CONDITION<$condition>\n";
529
Andy Whitcroft773647a2008-03-28 14:15:58 -0700530 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800531
532 return ($statement, $condition,
533 $line, $remain + 1, $off - $loff + 1, $level);
534}
535
Andy Whitcroftcf655042008-03-04 14:28:20 -0800536sub statement_lines {
537 my ($stmt) = @_;
538
539 # Strip the diff line prefixes and rip blank lines at start and end.
540 $stmt =~ s/(^|\n)./$1/g;
541 $stmt =~ s/^\s*//;
542 $stmt =~ s/\s*$//;
543
544 my @stmt_lines = ($stmt =~ /\n/g);
545
546 return $#stmt_lines + 2;
547}
548
549sub statement_rawlines {
550 my ($stmt) = @_;
551
552 my @stmt_lines = ($stmt =~ /\n/g);
553
554 return $#stmt_lines + 2;
555}
556
557sub statement_block_size {
558 my ($stmt) = @_;
559
560 $stmt =~ s/(^|\n)./$1/g;
561 $stmt =~ s/^\s*{//;
562 $stmt =~ s/}\s*$//;
563 $stmt =~ s/^\s*//;
564 $stmt =~ s/\s*$//;
565
566 my @stmt_lines = ($stmt =~ /\n/g);
567 my @stmt_statements = ($stmt =~ /;/g);
568
569 my $stmt_lines = $#stmt_lines + 2;
570 my $stmt_statements = $#stmt_statements + 1;
571
572 if ($stmt_lines > $stmt_statements) {
573 return $stmt_lines;
574 } else {
575 return $stmt_statements;
576 }
577}
578
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800579sub ctx_statement_full {
580 my ($linenr, $remain, $off) = @_;
581 my ($statement, $condition, $level);
582
583 my (@chunks);
584
Andy Whitcroftcf655042008-03-04 14:28:20 -0800585 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800586 ($statement, $condition, $linenr, $remain, $off, $level) =
587 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700588 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800589 push(@chunks, [ $condition, $statement ]);
590 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
591 return ($level, $linenr, @chunks);
592 }
593
594 # Pull in the following conditional/block pairs and see if they
595 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800596 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800597 ($statement, $condition, $linenr, $remain, $off, $level) =
598 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800599 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700600 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800601 #print "C: push\n";
602 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800603 }
604
605 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800606}
607
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700608sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700609 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700610 my $line;
611 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700612 my $blk = '';
613 my @o;
614 my @c;
615 my @res = ();
616
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700617 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800618 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700619 for ($line = $start; $remain > 0; $line++) {
620 next if ($rawlines[$line] =~ /^-/);
621 $remain--;
622
623 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800624
625 # Handle nested #if/#else.
626 if ($rawlines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
627 push(@stack, $level);
628 } elsif ($rawlines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
629 $level = $stack[$#stack - 1];
630 } elsif ($rawlines[$line] =~ /^.\s*#\s*endif\b/) {
631 $level = pop(@stack);
632 }
633
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700634 foreach my $c (split(//, $rawlines[$line])) {
635 ##print "C<$c>L<$level><$open$close>O<$off>\n";
636 if ($off > 0) {
637 $off--;
638 next;
639 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700640
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700641 if ($c eq $close && $level > 0) {
642 $level--;
643 last if ($level == 0);
644 } elsif ($c eq $open) {
645 $level++;
646 }
647 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700648
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700649 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700650 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700651 }
652
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700653 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700654 }
655
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700656 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700657}
658sub ctx_block_outer {
659 my ($linenr, $remain) = @_;
660
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700661 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
662 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700663}
664sub ctx_block {
665 my ($linenr, $remain) = @_;
666
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700667 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
668 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700669}
670sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700671 my ($linenr, $remain, $off) = @_;
672
673 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
674 return @r;
675}
676sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700677 my ($linenr, $remain) = @_;
678
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700679 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700680}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700681sub ctx_statement_level {
682 my ($linenr, $remain, $off) = @_;
683
684 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
685}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700686
687sub ctx_locate_comment {
688 my ($first_line, $end_line) = @_;
689
690 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700691 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700692 return $current_comment if (defined $current_comment);
693
694 # Look through the context and try and figure out if there is a
695 # comment.
696 my $in_comment = 0;
697 $current_comment = '';
698 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700699 my $line = $rawlines[$linenr - 1];
700 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700701 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
702 $in_comment = 1;
703 }
704 if ($line =~ m@/\*@) {
705 $in_comment = 1;
706 }
707 if (!$in_comment && $current_comment ne '') {
708 $current_comment = '';
709 }
710 $current_comment .= $line . "\n" if ($in_comment);
711 if ($line =~ m@\*/@) {
712 $in_comment = 0;
713 }
714 }
715
716 chomp($current_comment);
717 return($current_comment);
718}
719sub ctx_has_comment {
720 my ($first_line, $end_line) = @_;
721 my $cmt = ctx_locate_comment($first_line, $end_line);
722
Andy Whitcroft00df3442007-06-08 13:47:06 -0700723 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700724 ##print "CMMT: $cmt\n";
725
726 return ($cmt ne '');
727}
728
Andy Whitcroft4d001e42008-10-15 22:02:21 -0700729sub raw_line {
730 my ($linenr, $cnt) = @_;
731
732 my $offset = $linenr - 1;
733 $cnt++;
734
735 my $line;
736 while ($cnt) {
737 $line = $rawlines[$offset++];
738 next if (defined($line) && $line =~ /^-/);
739 $cnt--;
740 }
741
742 return $line;
743}
744
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700745sub cat_vet {
746 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700747 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700748
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700749 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700750 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
751 $res .= $1;
752 if ($2 ne '') {
753 $coded = sprintf("^%c", unpack('C', $2) + 64);
754 $res .= $coded;
755 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700756 }
757 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700758
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700759 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700760}
761
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800762my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800763my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800764my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700765my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800766
767sub annotate_reset {
768 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800769 $av_pending = '_';
770 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700771 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800772}
773
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700774sub annotate_values {
775 my ($stream, $type) = @_;
776
777 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700778 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700779 my $cur = $stream;
780
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800781 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700782
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700783 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700784 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800785 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700786 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700787 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800788 print "WS($1)\n" if ($dbg_values > 1);
789 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800790 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800791 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700792 }
793
Andy Whitcroft8ea3eb92008-07-23 21:29:08 -0700794 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800795 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700796 $type = 'T';
797
Andy Whitcroft389a2fe2008-07-23 21:29:05 -0700798 } elsif ($cur =~ /^($Modifier)\s*/) {
799 print "MODIFIER($1)\n" if ($dbg_values > 1);
800 $type = 'T';
801
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700802 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700803 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800804 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700805 push(@av_paren_type, $type);
806 if ($2 ne '') {
807 $av_pending = 'N';
808 }
809 $type = 'E';
810
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700811 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700812 print "UNDEF($1)\n" if ($dbg_values > 1);
813 $av_preprocessor = 1;
814 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700815
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700816 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800817 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800818 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800819
820 push(@av_paren_type, $type);
821 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700822 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800823
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700824 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800825 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
826 $av_preprocessor = 1;
827
828 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
829
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700830 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800831
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700832 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800833 print "PRE_END($1)\n" if ($dbg_values > 1);
834
835 $av_preprocessor = 1;
836
837 # Assume all arms of the conditional end as this
838 # one does, and continue as if the #endif was not here.
839 pop(@av_paren_type);
840 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700841 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700842
843 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800844 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700845
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700846 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
847 print "ATTR($1)\n" if ($dbg_values > 1);
848 $av_pending = $type;
849 $type = 'N';
850
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700851 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800852 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700853 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800854 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700855 }
856 $type = 'N';
857
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700858 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800859 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700860 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700861 $type = 'N';
862
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700863 } elsif ($cur =~/^(case)/o) {
864 print "CASE($1)\n" if ($dbg_values > 1);
865 $av_pend_colon = 'C';
866 $type = 'N';
867
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700868 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800869 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700870 $type = 'N';
871
872 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800873 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800874 push(@av_paren_type, $av_pending);
875 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700876 $type = 'N';
877
878 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800879 my $new_type = pop(@av_paren_type);
880 if ($new_type ne '_') {
881 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800882 print "PAREN('$1') -> $type\n"
883 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700884 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800885 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700886 }
887
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700888 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800889 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700890 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800891 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700892
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800893 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
894 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700895 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800896 } elsif ($type eq 'E') {
897 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700898 }
899 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
900 $type = 'V';
901
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700902 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800903 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700904 $type = 'V';
905
906 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800907 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700908 $type = 'N';
909
Andy Whitcroftcf655042008-03-04 14:28:20 -0800910 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800911 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800912 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700913 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800914
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800915 } elsif ($cur =~/^(,)/) {
916 print "COMMA($1)\n" if ($dbg_values > 1);
917 $type = 'C';
918
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700919 } elsif ($cur =~ /^(\?)/o) {
920 print "QUESTION($1)\n" if ($dbg_values > 1);
921 $type = 'N';
922
923 } elsif ($cur =~ /^(:)/o) {
924 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
925
926 substr($var, length($res), 1, $av_pend_colon);
927 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
928 $type = 'E';
929 } else {
930 $type = 'N';
931 }
932 $av_pend_colon = 'O';
933
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800934 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800935 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700936 $type = 'N';
937
Andy Whitcroft0d413862008-10-15 22:02:16 -0700938 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -0700939 my $variant;
940
941 print "OPV($1)\n" if ($dbg_values > 1);
942 if ($type eq 'V') {
943 $variant = 'B';
944 } else {
945 $variant = 'U';
946 }
947
948 substr($var, length($res), 1, $variant);
949 $type = 'N';
950
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700951 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800952 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700953 if ($1 ne '++' && $1 ne '--') {
954 $type = 'N';
955 }
956
957 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800958 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700959 }
960 if (defined $1) {
961 $cur = substr($cur, length($1));
962 $res .= $type x length($1);
963 }
964 }
965
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700966 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700967}
968
Andy Whitcroft8905a672007-11-28 16:21:06 -0800969sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800970 my ($possible, $line) = @_;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800971
Andy Whitcroft0776e592008-10-15 22:02:29 -0700972 print "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
973 if ($possible !~ /(?:
974 ^(?:
975 $Modifier|
976 $Storage|
977 $Type|
978 DEFINE_\S+|
979 goto|
980 return|
981 case|
982 else|
983 asm|__asm__|
984 do
985 )$|
986 ^(?:typedef|struct|enum)\b
987 )/x) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700988 # Check for modifiers.
989 $possible =~ s/\s*$Storage\s*//g;
990 $possible =~ s/\s*$Sparse\s*//g;
991 if ($possible =~ /^\s*$/) {
992
993 } elsif ($possible =~ /\s/) {
994 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -0700995 for my $modifier (split(' ', $possible)) {
996 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
997 push(@modifierList, $modifier);
998 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700999
1000 } else {
1001 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1002 push(@typeList, $possible);
1003 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001004 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001005 } else {
1006 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001007 }
1008}
1009
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001010my $prefix = '';
1011
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001012sub report {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001013 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
1014 return 0;
1015 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001016 my $line = $prefix . $_[0];
1017
1018 $line = (split('\n', $line))[0] . "\n" if ($terse);
1019
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001020 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001021
1022 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001023}
1024sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001025 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001026}
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001027sub ERROR {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001028 if (report("ERROR: $_[0]\n")) {
1029 our $clean = 0;
1030 our $cnt_error++;
1031 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001032}
1033sub WARN {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001034 if (report("WARNING: $_[0]\n")) {
1035 our $clean = 0;
1036 our $cnt_warn++;
1037 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001038}
1039sub CHK {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001040 if ($check && report("CHECK: $_[0]\n")) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001041 our $clean = 0;
1042 our $cnt_chk++;
1043 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001044}
1045
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001046sub check_absolute_file {
1047 my ($absolute, $herecurr) = @_;
1048 my $file = $absolute;
1049
1050 ##print "absolute<$absolute>\n";
1051
1052 # See if any suffix of this path is a path within the tree.
1053 while ($file =~ s@^[^/]*/@@) {
1054 if (-f "$root/$file") {
1055 ##print "file<$file>\n";
1056 last;
1057 }
1058 }
1059 if (! -f _) {
1060 return 0;
1061 }
1062
1063 # It is, so see if the prefix is acceptable.
1064 my $prefix = $absolute;
1065 substr($prefix, -length($file)) = '';
1066
1067 ##print "prefix<$prefix>\n";
1068 if ($prefix ne ".../") {
1069 WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr);
1070 }
1071}
1072
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001073sub process {
1074 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001075
1076 my $linenr=0;
1077 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001078 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001079 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001080 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001081
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001082 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001083 my $indent;
1084 my $previndent=0;
1085 my $stashindent=0;
1086
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001087 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001088 my $signoff = 0;
1089 my $is_patch = 0;
1090
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001091 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001092 our $cnt_lines = 0;
1093 our $cnt_error = 0;
1094 our $cnt_warn = 0;
1095 our $cnt_chk = 0;
1096
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001097 # Trace the real file/line as we go.
1098 my $realfile = '';
1099 my $realline = 0;
1100 my $realcnt = 0;
1101 my $here = '';
1102 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001103 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001104 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001105 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001106
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001107 my $prev_values = 'E';
1108
1109 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001110 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001111 my %suppress_whiletrailers;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001112
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001113 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001114 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001115 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001116 my @setup_docs = ();
1117 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001118
1119 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001120 my $line;
1121 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001122 $linenr++;
1123 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001124
Andy Whitcroft773647a2008-03-28 14:15:58 -07001125 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001126 $setup_docs = 0;
1127 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1128 $setup_docs = 1;
1129 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001130 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001131 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001132 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1133 $realline=$1-1;
1134 if (defined $2) {
1135 $realcnt=$3+1;
1136 } else {
1137 $realcnt=1+1;
1138 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001139 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001140
1141 # Guestimate if this is a continuing comment. Run
1142 # the context looking for a comment "edge". If this
1143 # edge is a close comment then we must be in a comment
1144 # at context start.
1145 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001146 my $cnt = $realcnt;
1147 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1148 next if (defined $rawlines[$ln - 1] &&
1149 $rawlines[$ln - 1] =~ /^-/);
1150 $cnt--;
1151 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001152 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001153 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1154 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1155 ($edge) = $1;
1156 last;
1157 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001158 }
1159 if (defined $edge && $edge eq '*/') {
1160 $in_comment = 1;
1161 }
1162
1163 # Guestimate if this is a continuing comment. If this
1164 # is the start of a diff block and this line starts
1165 # ' *' then it is very likely a comment.
1166 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001167 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001168 {
1169 $in_comment = 1;
1170 }
1171
1172 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1173 sanitise_line_reset($in_comment);
1174
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001175 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001176 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001177 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001178 $line = sanitise_line($rawline);
1179 }
1180 push(@lines, $line);
1181
1182 if ($realcnt > 1) {
1183 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1184 } else {
1185 $realcnt = 0;
1186 }
1187
1188 #print "==>$rawline\n";
1189 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001190
1191 if ($setup_docs && $line =~ /^\+/) {
1192 push(@setup_docs, $line);
1193 }
1194 }
1195
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001196 $prefix = '';
1197
Andy Whitcroft773647a2008-03-28 14:15:58 -07001198 $realcnt = 0;
1199 $linenr = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001200 foreach my $line (@lines) {
1201 $linenr++;
1202
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001203 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft306708542008-10-15 22:02:28 -07001204 my $hunk_line = ($realcnt != 0);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001205
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001206#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001207 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001208 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001209 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001210 $realline=$1-1;
1211 if (defined $2) {
1212 $realcnt=$3+1;
1213 } else {
1214 $realcnt=1+1;
1215 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001216 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001217 $prev_values = 'E';
1218
Andy Whitcroft773647a2008-03-28 14:15:58 -07001219 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001220 %suppress_whiletrailers = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001221 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001222
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001223# track the line number as we move through the hunk, note that
1224# new versions of GNU diff omit the leading space on completely
1225# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001226 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001227 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001228 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001229
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001230 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001231 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001232
1233 # Track the previous line.
1234 ($prevline, $stashline) = ($stashline, $line);
1235 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001236 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1237
Andy Whitcroft773647a2008-03-28 14:15:58 -07001238 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001239
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001240 } elsif ($realcnt == 1) {
1241 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001242 }
1243
1244#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001245 $prefix = "$filename:$realline: " if ($emacs && $file);
1246 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1247
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001248 $here = "#$linenr: " if (!$file);
1249 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001250
1251 # extract the filename as it passes
1252 if ($line=~/^\+\+\+\s+(\S+)/) {
1253 $realfile = $1;
Wolfram Sang1e855722009-01-06 14:41:24 -08001254 $realfile =~ s@^([^/]*)/@@;
1255
1256 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001257 if (!$file && $tree && $p1_prefix ne '' &&
1258 -e "$root/$p1_prefix") {
Wolfram Sang1e855722009-01-06 14:41:24 -08001259 WARN("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1260 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001261
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001262 if ($realfile =~ m@^include/asm/@) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001263 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1264 }
1265 next;
1266 }
1267
Randy Dunlap389834b2007-06-08 13:47:03 -07001268 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001269
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001270 my $hereline = "$here\n$rawline\n";
1271 my $herecurr = "$here\n$rawline\n";
1272 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001273
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001274 $cnt_lines++ if ($realcnt != 0);
1275
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001276#check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001277 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001278 # This is a signoff, if ugly, so do not double report.
1279 $signoff++;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001280 if (!($line =~ /^\s*Signed-off-by:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001281 WARN("Signed-off-by: is the preferred form\n" .
1282 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001283 }
1284 if ($line =~ /^\s*signed-off-by:\S/i) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001285 WARN("space required after Signed-off-by:\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001286 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001287 }
1288 }
1289
Andy Whitcroft00df3442007-06-08 13:47:06 -07001290# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001291 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001292 ERROR("patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001293 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001294 }
1295
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001296# Check for absolute kernel paths.
1297 if ($tree) {
1298 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1299 my $file = $1;
1300
1301 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1302 check_absolute_file($1, $herecurr)) {
1303 #
1304 } else {
1305 check_absolute_file($file, $herecurr);
1306 }
1307 }
1308 }
1309
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001310# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1311 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001312 $rawline !~ m/^$UTF8*$/) {
1313 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1314
1315 my $blank = copy_spacing($rawline);
1316 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1317 my $hereptr = "$hereline$ptr\n";
1318
1319 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001320 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001321
Andy Whitcroft306708542008-10-15 22:02:28 -07001322# ignore non-hunk lines and lines being removed
1323 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001324
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001325#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001326 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001327 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001328 ERROR("DOS line endings\n" . $herevet);
1329
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001330 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1331 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001332 ERROR("trailing whitespace\n" . $herevet);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001333 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07001334
1335# check we are in a valid source file if not then ignore this hunk
1336 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1337
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001338#80 column limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001339 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001340 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1341 $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1342 $length > 80)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001343 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001344 WARN("line over 80 characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001345 }
1346
Andy Whitcroft8905a672007-11-28 16:21:06 -08001347# check for adding lines without a newline.
1348 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1349 WARN("adding a line without newline at end of file\n" . $herecurr);
1350 }
1351
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001352# check we are in a valid source file C or perl if not then ignore this hunk
1353 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001354
1355# at the beginning of a line any tabs must come first and anything
1356# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001357 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1358 $rawline =~ /^\+\s* \s*/) {
1359 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001360 ERROR("code indent should use tabs where possible\n" . $herevet);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001361 }
1362
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001363# check we are in a valid C source file if not then ignore this hunk
1364 next if ($realfile !~ /\.(h|c)$/);
1365
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001366# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001367 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001368 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1369 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001370
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001371# Check for potential 'bare' types
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001372 my ($stat, $cond, $line_nr_next, $remain_next, $off_next);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001373 if ($realcnt && $line =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001374 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001375 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001376 $stat =~ s/\n./\n /g;
1377 $cond =~ s/\n./\n /g;
1378
1379 my $s = $stat;
1380 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001381
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001382 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001383 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001384
1385 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001386 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001387
Andy Whitcroft463f2862009-09-21 17:04:34 -07001388 } elsif ($s =~ /^.\s*else\b/s) {
1389
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001390 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001391 } 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 -07001392 my $type = $1;
1393 $type =~ s/\s+/ /g;
1394 possible($type, "A:" . $s);
1395
Andy Whitcroft8905a672007-11-28 16:21:06 -08001396 # definitions in global scope can only start with types
Andy Whitcrofta6a84062008-10-15 22:02:30 -07001397 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001398 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001399 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001400
1401 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08001402 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001403 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001404 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001405
1406 # Check for any sort of function declaration.
1407 # int foo(something bar, other baz);
1408 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001409 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 -08001410 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001411
Andy Whitcroftcf655042008-03-04 14:28:20 -08001412 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001413 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001414 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001415
Andy Whitcroft8905a672007-11-28 16:21:06 -08001416 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001417 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001418
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001419 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001420 }
1421 }
1422 }
1423
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001424 }
1425
Andy Whitcroft653d4872007-06-23 17:16:34 -07001426#
1427# Checks which may be anchored in the context.
1428#
1429
1430# Check for switch () and associated case and default
1431# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07001432 if ($line=~/\bswitch\s*\(.*\)/) {
1433 my $err = '';
1434 my $sep = '';
1435 my @ctx = ctx_block_outer($linenr, $realcnt);
1436 shift(@ctx);
1437 for my $ctx (@ctx) {
1438 my ($clen, $cindent) = line_stats($ctx);
1439 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1440 $indent != $cindent) {
1441 $err .= "$sep$ctx\n";
1442 $sep = '';
1443 } else {
1444 $sep = "[...]\n";
1445 }
1446 }
1447 if ($err ne '') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001448 ERROR("switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001449 }
1450 }
1451
1452# if/while/etc brace do not go on next line, unless defining a do while loop,
1453# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001454 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001455 my $pre_ctx = "$1$2";
1456
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001457 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001458 my $ctx_cnt = $realcnt - $#ctx - 1;
1459 my $ctx = join("\n", @ctx);
1460
Andy Whitcroft548596d2008-07-23 21:29:01 -07001461 my $ctx_ln = $linenr;
1462 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001463
Andy Whitcroft548596d2008-07-23 21:29:01 -07001464 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1465 defined $lines[$ctx_ln - 1] &&
1466 $lines[$ctx_ln - 1] =~ /^-/)) {
1467 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1468 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001469 $ctx_ln++;
1470 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07001471
Andy Whitcroft53210162008-07-23 21:29:03 -07001472 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1473 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001474
1475 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1476 ERROR("that open brace { should be on the previous line\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001477 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07001478 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001479 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1480 $ctx =~ /\)\s*\;\s*$/ &&
1481 defined $lines[$ctx_ln - 1])
1482 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001483 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1484 if ($nindent > $indent) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001485 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001486 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001487 }
1488 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001489 }
1490
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001491# Check relative indent for conditionals and blocks.
1492 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1493 my ($s, $c) = ($stat, $cond);
1494
1495 substr($s, 0, length($c), '');
1496
1497 # Make sure we remove the line prefixes as we have
1498 # none on the first line, and are going to readd them
1499 # where necessary.
1500 $s =~ s/\n./\n/gs;
1501
1502 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07001503 my @newlines = ($c =~ /\n/gs);
1504 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001505
1506 # We want to check the first line inside the block
1507 # starting at the end of the conditional, so remove:
1508 # 1) any blank line termination
1509 # 2) any opening brace { on end of the line
1510 # 3) any do (...) {
1511 my $continuation = 0;
1512 my $check = 0;
1513 $s =~ s/^.*\bdo\b//;
1514 $s =~ s/^\s*{//;
1515 if ($s =~ s/^\s*\\//) {
1516 $continuation = 1;
1517 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001518 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001519 $check = 1;
1520 $cond_lines++;
1521 }
1522
1523 # Also ignore a loop construct at the end of a
1524 # preprocessor statement.
1525 if (($prevline =~ /^.\s*#\s*define\s/ ||
1526 $prevline =~ /\\\s*$/) && $continuation == 0) {
1527 $check = 0;
1528 }
1529
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001530 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07001531 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001532 while ($cond_ptr != $cond_lines) {
1533 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001534
Andy Whitcroftf16fa282008-10-15 22:02:32 -07001535 # If we see an #else/#elif then the code
1536 # is not linear.
1537 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1538 $check = 0;
1539 }
1540
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001541 # Ignore:
1542 # 1) blank lines, they should be at 0,
1543 # 2) preprocessor lines, and
1544 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07001545 if ($continuation ||
1546 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001547 $s =~ /^\s*#\s*?/ ||
1548 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07001549 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001550 $s =~ s/^.*?\n//;
1551 $cond_lines++;
1552 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001553 }
1554
1555 my (undef, $sindent) = line_stats("+" . $s);
1556 my $stat_real = raw_line($linenr, $cond_lines);
1557
1558 # Check if either of these lines are modified, else
1559 # this is not this patch's fault.
1560 if (!defined($stat_real) ||
1561 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1562 $check = 0;
1563 }
1564 if (defined($stat_real) && $cond_lines > 1) {
1565 $stat_real = "[...]\n$stat_real";
1566 }
1567
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001568 #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 -07001569
1570 if ($check && (($sindent % 8) != 0 ||
1571 ($sindent <= $indent && $s ne ''))) {
1572 WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1573 }
1574 }
1575
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001576 # Track the 'values' across context and added lines.
1577 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001578 my ($curr_values, $curr_vars) =
1579 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001580 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001581 if ($dbg_values) {
1582 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001583 print "$linenr > .$outline\n";
1584 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001585 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001586 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001587 $prev_values = substr($curr_values, -1);
1588
Andy Whitcroft00df3442007-06-08 13:47:06 -07001589#ignore lines not being added
1590 if ($line=~/^[^\+]/) {next;}
1591
Andy Whitcroft653d4872007-06-23 17:16:34 -07001592# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07001593 if ($dbg_type) {
1594 if ($line =~ /^.\s*$Declare\s*$/) {
1595 ERROR("TEST: is type\n" . $herecurr);
1596 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1597 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1598 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001599 next;
1600 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001601# TEST: allow direct testing of the attribute matcher.
1602 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08001603 if ($line =~ /^.\s*$Modifier\s*$/) {
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001604 ERROR("TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08001605 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001606 ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1607 }
1608 next;
1609 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001610
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001611# check for initialisation to aggregates open brace on the next line
1612 if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1613 $line =~ /^.\s*{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001614 ERROR("that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001615 }
1616
Andy Whitcroft653d4872007-06-23 17:16:34 -07001617#
1618# Checks which are anchored on the added line.
1619#
1620
1621# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001622 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001623 my $path = $1;
1624 if ($path =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001625 ERROR("malformed #include filename\n" .
1626 $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001627 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001628 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001629
1630# no C99 // comments
1631 if ($line =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001632 ERROR("do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001633 }
1634 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001635 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001636 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001637
1638#EXPORT_SYMBOL should immediately follow its function closing }.
Andy Whitcroft653d4872007-06-23 17:16:34 -07001639 if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1640 ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1641 my $name = $1;
Andy Whitcroft48012052008-10-15 22:02:34 -07001642 if ($prevline !~ /(?:
1643 ^.}|
1644 ^.DEFINE_$Ident\(\Q$name\E\)|
1645 ^.DECLARE_$Ident\(\Q$name\E\)|
1646 ^.LIST_HEAD\(\Q$name\E\)|
1647 ^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
1648 \b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)
1649 )/x) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001650 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001651 }
1652 }
1653
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001654# check for external initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001655 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001656 ERROR("do not initialise externals to 0 or NULL\n" .
1657 $herecurr);
1658 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001659# check for static initialisers.
Andy Whitcroft2d1bafd2009-01-06 14:41:28 -08001660 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001661 ERROR("do not initialise statics to 0 or NULL\n" .
1662 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001663 }
1664
Andy Whitcroft653d4872007-06-23 17:16:34 -07001665# check for new typedefs, only function parameters and sparse annotations
1666# make sense.
1667 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08001668 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001669 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07001670 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001671 $line !~ /\b__bitwise(?:__|)\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001672 WARN("do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001673 }
1674
1675# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08001676 # (char*[ const])
Andy Whitcroft00ef4ec2009-02-27 14:03:07 -08001677 if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001678 my ($from, $to) = ($1, $1);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001679
Andy Whitcroft65863862009-01-06 14:41:21 -08001680 # Should start with a space.
1681 $to =~ s/^(\S)/ $1/;
1682 # Should not end with a space.
1683 $to =~ s/\s+$//;
1684 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08001685 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001686 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001687
Andy Whitcroft65863862009-01-06 14:41:21 -08001688 #print "from<$from> to<$to>\n";
1689 if ($from ne $to) {
1690 ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
1691 }
Andy Whitcroft00ef4ec2009-02-27 14:03:07 -08001692 } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001693 my ($from, $to, $ident) = ($1, $1, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001694
Andy Whitcroft65863862009-01-06 14:41:21 -08001695 # Should start with a space.
1696 $to =~ s/^(\S)/ $1/;
1697 # Should not end with a space.
1698 $to =~ s/\s+$//;
1699 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08001700 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001701 }
1702 # Modifiers should have spaces.
1703 $to =~ s/(\b$Modifier$)/$1 /;
1704
Andy Whitcroft667026e2009-02-27 14:03:08 -08001705 #print "from<$from> to<$to> ident<$ident>\n";
1706 if ($from ne $to && $ident !~ /^$Modifier$/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001707 ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
1708 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001709 }
1710
1711# # no BUG() or BUG_ON()
1712# if ($line =~ /\b(BUG|BUG_ON)\b/) {
1713# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1714# print "$herecurr";
1715# $clean = 0;
1716# }
1717
Andy Whitcroft8905a672007-11-28 16:21:06 -08001718 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001719 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 -08001720 }
1721
Andy Whitcroft00df3442007-06-08 13:47:06 -07001722# printk should use KERN_* levels. Note that follow on printk's on the
1723# same line do not need a level, so we use the current block context
1724# to try and find and validate the current printk. In summary the current
1725# printk includes all preceeding printk's which have no newline on the end.
1726# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001727 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001728 my $ok = 0;
1729 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1730 #print "CHECK<$lines[$ln - 1]\n";
1731 # we have a preceeding printk if it ends
1732 # with "\n" ignore it, else it is to blame
1733 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1734 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1735 $ok = 1;
1736 }
1737 last;
1738 }
1739 }
1740 if ($ok == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001741 WARN("printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001742 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001743 }
1744
Andy Whitcroft653d4872007-06-23 17:16:34 -07001745# function brace can't be on same line, except for #defines of do while,
1746# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001747 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1748 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001749 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001750 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001751
Andy Whitcroft8905a672007-11-28 16:21:06 -08001752# open braces for enum, union and struct go on the same line.
1753 if ($line =~ /^.\s*{/ &&
1754 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1755 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1756 }
1757
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001758# check for spacing round square brackets; allowed:
1759# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001760# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1761# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001762 while ($line =~ /(.*?\s)\[/g) {
1763 my ($where, $prefix) = ($-[1], $1);
1764 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001765 ($where != 0 || $prefix !~ /^.\s+$/) &&
1766 $prefix !~ /{\s+$/) {
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001767 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1768 }
1769 }
1770
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001771# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001772 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001773 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001774 my $ctx_before = substr($line, 0, $-[1]);
1775 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001776
1777 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001778 if ($name =~ /^(?:
1779 if|for|while|switch|return|case|
1780 volatile|__volatile__|
1781 __attribute__|format|__extension__|
1782 asm|__asm__)$/x)
1783 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001784
1785 # cpp #define statements have non-optional spaces, ie
1786 # if there is a space between the name and the open
1787 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001788 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001789
1790 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001791 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001792
1793 # If this whole things ends with a type its most
1794 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001795 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001796
1797 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001798 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001799 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001800 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001801# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001802 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001803 my $ops = qr{
1804 <<=|>>=|<=|>=|==|!=|
1805 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1806 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001807 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1808 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001809 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001810 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001811 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001812
1813 my $blank = copy_spacing($opline);
1814
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001815 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001816 $off += length($elements[$n]);
1817
Andy Whitcroft773647a2008-03-28 14:15:58 -07001818 # Pick up the preceeding and succeeding characters.
1819 my $ca = substr($opline, 0, $off);
1820 my $cc = '';
1821 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1822 $cc = substr($opline, $off + length($elements[$n + 1]));
1823 }
1824 my $cb = "$ca$;$cc";
1825
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001826 my $a = '';
1827 $a = 'V' if ($elements[$n] ne '');
1828 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001829 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001830 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1831 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07001832 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001833
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001834 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001835
1836 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001837 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001838 $c = 'V' if ($elements[$n + 2] ne '');
1839 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001840 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001841 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1842 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08001843 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001844 } else {
1845 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001846 }
1847
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001848 my $ctx = "${a}x${c}";
1849
1850 my $at = "(ctx:$ctx)";
1851
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001852 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001853 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001854
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001855 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001856 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001857
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001858 # Get the full operator variant.
1859 my $opv = $op . substr($curr_vars, $off, 1);
1860
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001861 # Ignore operators passed as parameters.
1862 if ($op_type ne 'V' &&
1863 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1864
Andy Whitcroftcf655042008-03-04 14:28:20 -08001865# # Ignore comments
1866# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001867
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001868 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001869 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001870 if ($ctx !~ /.x[WEBC]/ &&
1871 $cc !~ /^\\/ && $cc !~ /^;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001872 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001873 }
1874
1875 # // is a comment
1876 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001877
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001878 # No spaces for:
1879 # ->
1880 # : when part of a bitfield
1881 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001882 if ($ctx =~ /Wx.|.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001883 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001884 }
1885
1886 # , must have a space on the right.
1887 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001888 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001889 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001890 }
1891
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001892 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001893 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001894 #warn "'*' is part of type\n";
1895
1896 # unary operators should have a space before and
1897 # none after. May be left adjacent to another
1898 # unary operator, or a cast
1899 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001900 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07001901 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001902 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001903 ERROR("space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001904 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08001905 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001906 # A unary '*' may be const
1907
1908 } elsif ($ctx =~ /.xW/) {
Andy Whitcrofta3340b32009-02-27 14:03:07 -08001909 ERROR("Aspace prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001910 }
1911
1912 # unary ++ and unary -- are allowed no space on one side.
1913 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001914 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1915 ERROR("space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001916 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001917 if ($ctx =~ /Wx[BE]/ ||
1918 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1919 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001920 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001921 if ($ctx =~ /ExW/) {
1922 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1923 }
1924
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001925
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001926 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001927 } elsif ($op eq '<<' or $op eq '>>' or
1928 $op eq '&' or $op eq '^' or $op eq '|' or
1929 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001930 $op eq '*' or $op eq '/' or
1931 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001932 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001933 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001934 ERROR("need consistent spacing around '$op' $at\n" .
1935 $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001936 }
1937
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001938 # A colon needs no spaces before when it is
1939 # terminating a case value or a label.
1940 } elsif ($opv eq ':C' || $opv eq ':L') {
1941 if ($ctx =~ /Wx./) {
1942 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1943 }
1944
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001945 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08001946 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001947 my $ok = 0;
1948
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001949 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001950 if (($op eq '<' &&
1951 $cc =~ /^\S+\@\S+>/) ||
1952 ($op eq '>' &&
1953 $ca =~ /<\S+\@\S+$/))
1954 {
1955 $ok = 1;
1956 }
1957
1958 # Ignore ?:
1959 if (($opv eq ':O' && $ca =~ /\?$/) ||
1960 ($op eq '?' && $cc =~ /^:/)) {
1961 $ok = 1;
1962 }
1963
1964 if ($ok == 0) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001965 ERROR("spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001966 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001967 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001968 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001969 }
1970 }
1971
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001972# check for multiple assignments
1973 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001974 CHK("multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001975 }
1976
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001977## # check for multiple declarations, allowing for a function declaration
1978## # continuation.
1979## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
1980## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
1981##
1982## # Remove any bracketed sections to ensure we do not
1983## # falsly report the parameters of functions.
1984## my $ln = $line;
1985## while ($ln =~ s/\([^\(\)]*\)//g) {
1986## }
1987## if ($ln =~ /,/) {
1988## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
1989## }
1990## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001991
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001992#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001993 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
1994 $line =~ /do{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001995 ERROR("space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001996 }
1997
1998# closing brace should have a space following it when it has anything
1999# on the line
2000 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002001 ERROR("space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002002 }
2003
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002004# check spacing on square brackets
2005 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002006 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002007 }
2008 if ($line =~ /\s\]/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002009 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002010 }
2011
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002012# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002013 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2014 $line !~ /for\s*\(\s+;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002015 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002016 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002017 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002018 $line !~ /for\s*\(.*;\s+\)/ &&
2019 $line !~ /:\s+\)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002020 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002021 }
2022
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002023#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002024 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002025 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002026 WARN("labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002027 }
2028
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002029# Return is not a function.
2030 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2031 my $spacing = $1;
2032 my $value = $2;
2033
Andy Whitcroft86f9d052009-01-06 14:41:24 -08002034 # Flatten any parentheses
Andy Whitcroftfee61c42008-07-23 21:28:56 -07002035 $value =~ s/\)\(/\) \(/g;
Andy Whitcroft63f17f82009-01-15 13:51:06 -08002036 while ($value =~ s/\[[^\{\}]*\]/1/ ||
2037 $value !~ /(?:$Ident|-?$Constant)\s*
2038 $Compare\s*
2039 (?:$Ident|-?$Constant)/x &&
2040 $value =~ s/\([^\(\)]*\)/1/) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002041 }
2042
2043 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
2044 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
2045
2046 } elsif ($spacing !~ /\s+/) {
2047 ERROR("space required before the open parenthesis '('\n" . $herecurr);
2048 }
2049 }
2050
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002051# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002052 if ($line=~/\b(if|while|for|switch)\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002053 ERROR("space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002054 }
2055
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002056# Check for illegal assignment in if conditional -- and check for trailing
2057# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002058 if ($line =~ /do\s*(?!{)/) {
2059 my ($stat_next) = ctx_statement_block($line_nr_next,
2060 $remain_next, $off_next);
2061 $stat_next =~ s/\n./\n /g;
2062 ##print "stat<$stat> stat_next<$stat_next>\n";
2063
2064 if ($stat_next =~ /^\s*while\b/) {
2065 # If the statement carries leading newlines,
2066 # then count those as offsets.
2067 my ($whitespace) =
2068 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2069 my $offset =
2070 statement_rawlines($whitespace) - 1;
2071
2072 $suppress_whiletrailers{$line_nr_next +
2073 $offset} = 1;
2074 }
2075 }
2076 if (!defined $suppress_whiletrailers{$linenr} &&
2077 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002078 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002079
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08002080 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002081 ERROR("do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002082 }
2083
2084 # Find out what is on the end of the line after the
2085 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002086 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002087 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002088 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07002089 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2090 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002091 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002092 # Find out how long the conditional actually is.
2093 my @newlines = ($c =~ /\n/gs);
2094 my $cond_lines = 1 + $#newlines;
2095
2096 my $stat_real = raw_line($linenr, $cond_lines);
2097 if (defined($stat_real) && $cond_lines > 1) {
2098 $stat_real = "[...]\n$stat_real";
2099 }
2100
2101 ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002102 }
2103 }
2104
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002105# Check for bitwise tests written as boolean
2106 if ($line =~ /
2107 (?:
2108 (?:\[|\(|\&\&|\|\|)
2109 \s*0[xX][0-9]+\s*
2110 (?:\&\&|\|\|)
2111 |
2112 (?:\&\&|\|\|)
2113 \s*0[xX][0-9]+\s*
2114 (?:\&\&|\|\||\)|\])
2115 )/x)
2116 {
2117 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2118 }
2119
Andy Whitcroft8905a672007-11-28 16:21:06 -08002120# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002121 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2122 my $s = $1;
2123 $s =~ s/$;//g; # Remove any comments
2124 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2125 ERROR("trailing statements should be on next line\n" . $herecurr);
2126 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002127 }
Andy Whitcroft39667782009-01-15 13:51:06 -08002128# if should not continue a brace
2129 if ($line =~ /}\s*if\b/) {
2130 ERROR("trailing statements should be on next line\n" .
2131 $herecurr);
2132 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002133# case and default should not have general statements after them
2134 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2135 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07002136 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002137 \s*return\s+
2138 )/xg)
2139 {
2140 ERROR("trailing statements should be on next line\n" . $herecurr);
2141 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002142
2143 # Check for }<nl>else {, these must be at the same
2144 # indent level to be relevant to each other.
2145 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2146 $previndent == $indent) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002147 ERROR("else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002148 }
2149
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002150 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2151 $previndent == $indent) {
2152 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2153
2154 # Find out what is on the end of the line after the
2155 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002156 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002157 $s =~ s/\n.*//g;
2158
2159 if ($s =~ /^\s*;/) {
2160 ERROR("while should follow close brace '}'\n" . $hereprev);
2161 }
2162 }
2163
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002164#studly caps, commented out until figure out how to distinguish between use of existing and adding new
2165# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2166# print "No studly caps, use _\n";
2167# print "$herecurr";
2168# $clean = 0;
2169# }
2170
2171#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002172 if ($line=~/\#\s*define.*\\\s$/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002173 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002174 }
2175
Andy Whitcroft653d4872007-06-23 17:16:34 -07002176#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002177 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002178 my $file = "$1.h";
2179 my $checkfile = "include/linux/$file";
2180 if (-f "$root/$checkfile" &&
2181 $realfile ne $checkfile &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002182 $1 ne 'irq')
2183 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002184 if ($realfile =~ m{^arch/}) {
2185 CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2186 } else {
2187 WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2188 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002189 }
2190 }
2191
Andy Whitcroft653d4872007-06-23 17:16:34 -07002192# multi-statement macros should be enclosed in a do while loop, grab the
2193# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08002194# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07002195 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2196 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002197 my $ln = $linenr;
2198 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002199 my ($off, $dstat, $dcond, $rest);
2200 my $ctx = '';
Andy Whitcroft653d4872007-06-23 17:16:34 -07002201
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002202 my $args = defined($1);
2203
2204 # Find the end of the macro and limit our statement
2205 # search to that.
2206 while ($cnt > 0 && defined $lines[$ln - 1] &&
2207 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2208 {
2209 $ctx .= $rawlines[$ln - 1] . "\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002210 $cnt-- if ($lines[$ln - 1] !~ /^-/);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002211 $ln++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002212 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002213 $ctx .= $rawlines[$ln - 1];
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002214
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002215 ($dstat, $dcond, $ln, $cnt, $off) =
2216 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2217 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002218 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002219
2220 # Extract the remainder of the define (if any) and
2221 # rip off surrounding spaces, and trailing \'s.
2222 $rest = '';
Andy Whitcroft636d1402008-10-15 22:02:18 -07002223 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2224 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002225 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2226 $rest .= substr($lines[$ln - 1], $off) . "\n";
2227 $cnt--;
2228 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002229 $ln++;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002230 $off = 0;
2231 }
2232 $rest =~ s/\\\n.//g;
2233 $rest =~ s/^\s*//s;
2234 $rest =~ s/\s*$//s;
2235
2236 # Clean up the original statement.
2237 if ($args) {
2238 substr($dstat, 0, length($dcond), '');
2239 } else {
2240 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2241 }
Andy Whitcroft292f1a92008-07-23 21:29:11 -07002242 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002243 $dstat =~ s/\\\n.//g;
2244 $dstat =~ s/^\s*//s;
2245 $dstat =~ s/\s*$//s;
2246
2247 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07002248 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2249 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2250 $dstat =~ s/\[[^\{\}]*\]/1/)
2251 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002252 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002253
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002254 my $exceptions = qr{
2255 $Declare|
2256 module_param_named|
2257 MODULE_PARAM_DESC|
2258 DECLARE_PER_CPU|
2259 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08002260 __typeof__\(|
2261 \.$Ident\s*=\s*
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002262 }x;
Andy Whitcroft383099f2009-01-06 14:41:18 -08002263 #print "REST<$rest> dstat<$dstat>\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002264 if ($rest ne '') {
2265 if ($rest !~ /while\s*\(/ &&
2266 $dstat !~ /$exceptions/)
2267 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002268 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 -07002269 }
2270
2271 } elsif ($ctx !~ /;/) {
2272 if ($dstat ne '' &&
2273 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2274 $dstat !~ /$exceptions/ &&
Andy Whitcroftb132e5d2008-10-15 22:02:31 -07002275 $dstat !~ /^\.$Ident\s*=/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002276 $dstat =~ /$Operators/)
2277 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002278 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002279 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002280 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002281 }
2282
Mike Frysinger080ba922009-01-06 14:41:25 -08002283# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
2284# all assignments may have only one of the following with an assignment:
2285# .
2286# ALIGN(...)
2287# VMLINUX_SYMBOL(...)
2288 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
2289 WARN("vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
2290 }
2291
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002292# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002293 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2294 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08002295 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002296 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002297 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2298 if ($#chunks > 0 && $level == 0) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002299 my $allowed = 0;
2300 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002301 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002302 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002303 for my $chunk (@chunks) {
2304 my ($cond, $block) = @{$chunk};
2305
Andy Whitcroft773647a2008-03-28 14:15:58 -07002306 # If the condition carries leading newlines, then count those as offsets.
2307 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2308 my $offset = statement_rawlines($whitespace) - 1;
2309
2310 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2311
2312 # We have looked at and allowed this specific line.
2313 $suppress_ifbraces{$ln + $offset} = 1;
2314
2315 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002316 $ln += statement_rawlines($block) - 1;
2317
Andy Whitcroft773647a2008-03-28 14:15:58 -07002318 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002319
2320 $seen++ if ($block =~ /^\s*{/);
2321
Andy Whitcroftcf655042008-03-04 14:28:20 -08002322 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2323 if (statement_lines($cond) > 1) {
2324 #print "APW: ALLOWED: cond<$cond>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002325 $allowed = 1;
2326 }
2327 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002328 #print "APW: ALLOWED: block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002329 $allowed = 1;
2330 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002331 if (statement_block_size($block) > 1) {
2332 #print "APW: ALLOWED: lines block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002333 $allowed = 1;
2334 }
2335 }
2336 if ($seen && !$allowed) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002337 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002338 }
2339 }
2340 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002341 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002342 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002343 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002344
Andy Whitcroftcf655042008-03-04 14:28:20 -08002345 # Check the pre-context.
2346 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2347 #print "APW: ALLOWED: pre<$1>\n";
2348 $allowed = 1;
2349 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002350
2351 my ($level, $endln, @chunks) =
2352 ctx_statement_full($linenr, $realcnt, $-[0]);
2353
Andy Whitcroftcf655042008-03-04 14:28:20 -08002354 # Check the condition.
2355 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07002356 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002357 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002358 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08002359 }
2360 if (statement_lines($cond) > 1) {
2361 #print "APW: ALLOWED: cond<$cond>\n";
2362 $allowed = 1;
2363 }
2364 if ($block =~/\b(?:if|for|while)\b/) {
2365 #print "APW: ALLOWED: block<$block>\n";
2366 $allowed = 1;
2367 }
2368 if (statement_block_size($block) > 1) {
2369 #print "APW: ALLOWED: lines block<$block>\n";
2370 $allowed = 1;
2371 }
2372 # Check the post-context.
2373 if (defined $chunks[1]) {
2374 my ($cond, $block) = @{$chunks[1]};
2375 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002376 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002377 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002378 if ($block =~ /^\s*\{/) {
2379 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2380 $allowed = 1;
2381 }
2382 }
2383 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2384 my $herectx = $here . "\n";;
Andy Whitcroftf0556632008-10-15 22:02:23 -07002385 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002386
Andy Whitcroftf0556632008-10-15 22:02:23 -07002387 for (my $n = 0; $n < $cnt; $n++) {
2388 $herectx .= raw_line($linenr, $n) . "\n";;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002389 }
2390
2391 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002392 }
2393 }
2394
Andy Whitcroft653d4872007-06-23 17:16:34 -07002395# don't include deprecated include files (uses RAW line)
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002396 for my $inc (@dep_includes) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002397 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002398 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002399 }
2400 }
2401
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002402# don't use deprecated functions
2403 for my $func (@dep_functions) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002404 if ($line =~ /\b$func\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002405 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002406 }
2407 }
2408
2409# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002410 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2411 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002412 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002413 }
2414
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002415# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2416 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2417 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2418 }
2419
Andy Whitcroft00df3442007-06-08 13:47:06 -07002420# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002421 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002422 CHK("if this code is redundant consider removing it\n" .
2423 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002424 }
2425
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002426# check for needless kfree() checks
2427 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2428 my $expr = $1;
2429 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
Wolfram Sang3c232142008-07-23 21:29:05 -07002430 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002431 }
2432 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07002433# check for needless usb_free_urb() checks
2434 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2435 my $expr = $1;
2436 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2437 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2438 }
2439 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002440
Andy Whitcroft00df3442007-06-08 13:47:06 -07002441# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002442# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002443# print "#ifdef in C files should be avoided\n";
2444# print "$herecurr";
2445# $clean = 0;
2446# }
2447
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002448# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002449 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002450 ERROR("exactly one space required after that #$1\n" . $herecurr);
2451 }
2452
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002453# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002454 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2455 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002456 my $which = $1;
2457 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002458 CHK("$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002459 }
2460 }
2461# check for memory barriers without a comment.
2462 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2463 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002464 CHK("memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002465 }
2466 }
2467# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002468 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002469 CHK("architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002470 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002471
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002472# check the location of the inline attribute, that it is between
2473# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002474 if ($line =~ /\b$Type\s+$Inline\b/ ||
2475 $line =~ /\b$Inline\s+$Storage\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002476 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2477 }
2478
Andy Whitcroft8905a672007-11-28 16:21:06 -08002479# Check for __inline__ and __inline, prefer inline
2480 if ($line =~ /\b(__inline__|__inline)\b/) {
2481 WARN("plain inline is preferred over $1\n" . $herecurr);
2482 }
2483
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002484# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002485 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002486 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002487 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002488 my $function_name = $1;
2489 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002490
2491 my $s = $stat;
2492 if (defined $cond) {
2493 substr($s, 0, length($cond), '');
2494 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002495 if ($s =~ /^\s*;/ &&
2496 $function_name ne 'uninitialized_var')
2497 {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002498 WARN("externs should be avoided in .c files\n" . $herecurr);
2499 }
2500
2501 if ($paren_space =~ /\n/) {
2502 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2503 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002504
2505 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2506 $stat =~ /^.\s*extern\s+/)
2507 {
2508 WARN("externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002509 }
2510
2511# checks for new __setup's
2512 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2513 my $name = $1;
2514
2515 if (!grep(/$name/, @setup_docs)) {
2516 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2517 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002518 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002519
2520# check for pointless casting of kmalloc return
2521 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2522 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2523 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002524
2525# check for gcc specific __FUNCTION__
2526 if ($line =~ /__FUNCTION__/) {
2527 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2528 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002529
2530# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002531 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002532 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2533 }
2534# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002535 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002536 WARN("consider using a completion\n" . $herecurr);
2537 }
2538# recommend strict_strto* over simple_strto*
2539 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2540 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2541 }
Michael Ellermanf3db6632008-07-23 21:28:57 -07002542# check for __initcall(), use device_initcall() explicitly please
2543 if ($line =~ /^.\s*__initcall\s*\(/) {
2544 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2545 }
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08002546# check for struct file_operations, ensure they are const.
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08002547 if ($line !~ /\bconst\b/ &&
2548 $line =~ /\bstruct\s+(file_operations|seq_operations)\b/) {
2549 WARN("struct $1 should normally be const\n" .
2550 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08002551 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002552
2553# use of NR_CPUS is usually wrong
2554# ignore definitions of NR_CPUS and usage to define arrays as likely right
2555 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002556 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2557 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002558 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2559 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2560 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002561 {
2562 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2563 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002564
2565# check for %L{u,d,i} in strings
2566 my $string;
2567 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2568 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07002569 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002570 if ($string =~ /(?<!%)%L[udi]/) {
2571 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2572 last;
2573 }
2574 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08002575
2576# whine mightly about in_atomic
2577 if ($line =~ /\bin_atomic\s*\(/) {
2578 if ($realfile =~ m@^drivers/@) {
2579 ERROR("do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08002580 } elsif ($realfile !~ m@^kernel/@) {
Andy Whitcroft691d77b2009-01-06 14:41:16 -08002581 WARN("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
2582 }
2583 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002584 }
2585
2586 # If we have no input at all, then there is nothing to report on
2587 # so just keep quiet.
2588 if ($#rawlines == -1) {
2589 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002590 }
2591
Andy Whitcroft8905a672007-11-28 16:21:06 -08002592 # In mailback mode only produce a report in the negative, for
2593 # things that appear to be patches.
2594 if ($mailback && ($clean == 1 || !$is_patch)) {
2595 exit(0);
2596 }
2597
2598 # This is not a patch, and we are are in 'no-patch' mode so
2599 # just keep quiet.
2600 if (!$chk_patch && !$is_patch) {
2601 exit(0);
2602 }
2603
2604 if (!$is_patch) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002605 ERROR("Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002606 }
2607 if ($is_patch && $chk_signoff && $signoff == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002608 ERROR("Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002609 }
2610
Andy Whitcroft8905a672007-11-28 16:21:06 -08002611 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002612 if ($summary && !($clean == 1 && $quiet == 1)) {
2613 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002614 print "total: $cnt_error errors, $cnt_warn warnings, " .
2615 (($check)? "$cnt_chk checks, " : "") .
2616 "$cnt_lines lines checked\n";
2617 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002618 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002619
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002620 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002621 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002622 }
2623 if ($clean == 0 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002624 print "$vname has style problems, please review. If any of these errors\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002625 print "are false positives report them to the maintainer, see\n";
2626 print "CHECKPATCH in MAINTAINERS.\n";
2627 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002628
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002629 return $clean;
2630}