blob: 2d5ece798c4c6e786b3e6ee305e9830e490d75e9 [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 }
359
360 # A \ in a string means ignore the next character.
361 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
362 $c eq "\\") {
363 substr($res, $off, 2, 'XX');
364 $off++;
365 next;
366 }
367 # Regular quotes.
368 if ($c eq "'" || $c eq '"') {
369 if ($sanitise_quote eq '') {
370 $sanitise_quote = $c;
371
372 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700373 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700374 } elsif ($sanitise_quote eq $c) {
375 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700376 }
377 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700378
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800379 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700380 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
381 substr($res, $off, 1, $;);
382 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
383 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700384 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700385 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700386 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800387 }
388
389 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700390 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800391 my $clean = 'X' x length($1);
392 $res =~ s@\<.*\>@<$clean>@;
393
394 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700395 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800396 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700397 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800398 }
399
Andy Whitcroft00df3442007-06-08 13:47:06 -0700400 return $res;
401}
402
Andy Whitcroft8905a672007-11-28 16:21:06 -0800403sub ctx_statement_block {
404 my ($linenr, $remain, $off) = @_;
405 my $line = $linenr - 1;
406 my $blk = '';
407 my $soff = $off;
408 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700409 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800410
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800411 my $loff = 0;
412
Andy Whitcroft8905a672007-11-28 16:21:06 -0800413 my $type = '';
414 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800415 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800416 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800417 my $c;
418 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800419
420 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800421 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800422 @stack = (['', 0]) if ($#stack == -1);
423
Andy Whitcroft773647a2008-03-28 14:15:58 -0700424 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800425 # If we are about to drop off the end, pull in more
426 # context.
427 if ($off >= $len) {
428 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700429 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800430 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800431 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800432 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800433 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800434 $len = length($blk);
435 $line++;
436 last;
437 }
438 # Bail if there is no further context.
439 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800440 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800441 last;
442 }
443 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800444 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800445 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800446 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800447
Andy Whitcroft773647a2008-03-28 14:15:58 -0700448 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800449
450 # Handle nested #if/#else.
451 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
452 push(@stack, [ $type, $level ]);
453 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
454 ($type, $level) = @{$stack[$#stack - 1]};
455 } elsif ($remainder =~ /^#\s*endif\b/) {
456 ($type, $level) = @{pop(@stack)};
457 }
458
Andy Whitcroft8905a672007-11-28 16:21:06 -0800459 # Statement ends at the ';' or a close '}' at the
460 # outermost level.
461 if ($level == 0 && $c eq ';') {
462 last;
463 }
464
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800465 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700466 if ($level == 0 && $coff_set == 0 &&
467 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
468 $remainder =~ /^(else)(?:\s|{)/ &&
469 $remainder !~ /^else\s+if\b/) {
470 $coff = $off + length($1) - 1;
471 $coff_set = 1;
472 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
473 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800474 }
475
Andy Whitcroft8905a672007-11-28 16:21:06 -0800476 if (($type eq '' || $type eq '(') && $c eq '(') {
477 $level++;
478 $type = '(';
479 }
480 if ($type eq '(' && $c eq ')') {
481 $level--;
482 $type = ($level != 0)? '(' : '';
483
484 if ($level == 0 && $coff < $soff) {
485 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700486 $coff_set = 1;
487 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800488 }
489 }
490 if (($type eq '' || $type eq '{') && $c eq '{') {
491 $level++;
492 $type = '{';
493 }
494 if ($type eq '{' && $c eq '}') {
495 $level--;
496 $type = ($level != 0)? '{' : '';
497
498 if ($level == 0) {
499 last;
500 }
501 }
502 $off++;
503 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700504 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800505 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700506 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800507 $line++;
508 $remain--;
509 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800510
511 my $statement = substr($blk, $soff, $off - $soff + 1);
512 my $condition = substr($blk, $soff, $coff - $soff + 1);
513
514 #warn "STATEMENT<$statement>\n";
515 #warn "CONDITION<$condition>\n";
516
Andy Whitcroft773647a2008-03-28 14:15:58 -0700517 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800518
519 return ($statement, $condition,
520 $line, $remain + 1, $off - $loff + 1, $level);
521}
522
Andy Whitcroftcf655042008-03-04 14:28:20 -0800523sub statement_lines {
524 my ($stmt) = @_;
525
526 # Strip the diff line prefixes and rip blank lines at start and end.
527 $stmt =~ s/(^|\n)./$1/g;
528 $stmt =~ s/^\s*//;
529 $stmt =~ s/\s*$//;
530
531 my @stmt_lines = ($stmt =~ /\n/g);
532
533 return $#stmt_lines + 2;
534}
535
536sub statement_rawlines {
537 my ($stmt) = @_;
538
539 my @stmt_lines = ($stmt =~ /\n/g);
540
541 return $#stmt_lines + 2;
542}
543
544sub statement_block_size {
545 my ($stmt) = @_;
546
547 $stmt =~ s/(^|\n)./$1/g;
548 $stmt =~ s/^\s*{//;
549 $stmt =~ s/}\s*$//;
550 $stmt =~ s/^\s*//;
551 $stmt =~ s/\s*$//;
552
553 my @stmt_lines = ($stmt =~ /\n/g);
554 my @stmt_statements = ($stmt =~ /;/g);
555
556 my $stmt_lines = $#stmt_lines + 2;
557 my $stmt_statements = $#stmt_statements + 1;
558
559 if ($stmt_lines > $stmt_statements) {
560 return $stmt_lines;
561 } else {
562 return $stmt_statements;
563 }
564}
565
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800566sub ctx_statement_full {
567 my ($linenr, $remain, $off) = @_;
568 my ($statement, $condition, $level);
569
570 my (@chunks);
571
Andy Whitcroftcf655042008-03-04 14:28:20 -0800572 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800573 ($statement, $condition, $linenr, $remain, $off, $level) =
574 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700575 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800576 push(@chunks, [ $condition, $statement ]);
577 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
578 return ($level, $linenr, @chunks);
579 }
580
581 # Pull in the following conditional/block pairs and see if they
582 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800583 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800584 ($statement, $condition, $linenr, $remain, $off, $level) =
585 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800586 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700587 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800588 #print "C: push\n";
589 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800590 }
591
592 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800593}
594
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700595sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700596 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700597 my $line;
598 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700599 my $blk = '';
600 my @o;
601 my @c;
602 my @res = ();
603
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700604 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800605 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700606 for ($line = $start; $remain > 0; $line++) {
607 next if ($rawlines[$line] =~ /^-/);
608 $remain--;
609
610 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800611
612 # Handle nested #if/#else.
613 if ($rawlines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
614 push(@stack, $level);
615 } elsif ($rawlines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
616 $level = $stack[$#stack - 1];
617 } elsif ($rawlines[$line] =~ /^.\s*#\s*endif\b/) {
618 $level = pop(@stack);
619 }
620
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700621 foreach my $c (split(//, $rawlines[$line])) {
622 ##print "C<$c>L<$level><$open$close>O<$off>\n";
623 if ($off > 0) {
624 $off--;
625 next;
626 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700627
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700628 if ($c eq $close && $level > 0) {
629 $level--;
630 last if ($level == 0);
631 } elsif ($c eq $open) {
632 $level++;
633 }
634 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700635
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700636 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700637 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700638 }
639
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700640 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700641 }
642
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700643 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700644}
645sub ctx_block_outer {
646 my ($linenr, $remain) = @_;
647
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700648 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
649 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700650}
651sub ctx_block {
652 my ($linenr, $remain) = @_;
653
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700654 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
655 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700656}
657sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700658 my ($linenr, $remain, $off) = @_;
659
660 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
661 return @r;
662}
663sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700664 my ($linenr, $remain) = @_;
665
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700666 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700667}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700668sub ctx_statement_level {
669 my ($linenr, $remain, $off) = @_;
670
671 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
672}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700673
674sub ctx_locate_comment {
675 my ($first_line, $end_line) = @_;
676
677 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700678 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700679 return $current_comment if (defined $current_comment);
680
681 # Look through the context and try and figure out if there is a
682 # comment.
683 my $in_comment = 0;
684 $current_comment = '';
685 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700686 my $line = $rawlines[$linenr - 1];
687 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700688 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
689 $in_comment = 1;
690 }
691 if ($line =~ m@/\*@) {
692 $in_comment = 1;
693 }
694 if (!$in_comment && $current_comment ne '') {
695 $current_comment = '';
696 }
697 $current_comment .= $line . "\n" if ($in_comment);
698 if ($line =~ m@\*/@) {
699 $in_comment = 0;
700 }
701 }
702
703 chomp($current_comment);
704 return($current_comment);
705}
706sub ctx_has_comment {
707 my ($first_line, $end_line) = @_;
708 my $cmt = ctx_locate_comment($first_line, $end_line);
709
Andy Whitcroft00df3442007-06-08 13:47:06 -0700710 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700711 ##print "CMMT: $cmt\n";
712
713 return ($cmt ne '');
714}
715
Andy Whitcroft4d001e42008-10-15 22:02:21 -0700716sub raw_line {
717 my ($linenr, $cnt) = @_;
718
719 my $offset = $linenr - 1;
720 $cnt++;
721
722 my $line;
723 while ($cnt) {
724 $line = $rawlines[$offset++];
725 next if (defined($line) && $line =~ /^-/);
726 $cnt--;
727 }
728
729 return $line;
730}
731
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700732sub cat_vet {
733 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700734 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700735
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700736 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700737 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
738 $res .= $1;
739 if ($2 ne '') {
740 $coded = sprintf("^%c", unpack('C', $2) + 64);
741 $res .= $coded;
742 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700743 }
744 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700745
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700746 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700747}
748
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800749my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800750my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800751my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700752my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800753
754sub annotate_reset {
755 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800756 $av_pending = '_';
757 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700758 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800759}
760
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700761sub annotate_values {
762 my ($stream, $type) = @_;
763
764 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700765 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700766 my $cur = $stream;
767
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800768 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700769
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700770 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700771 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800772 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700773 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700774 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800775 print "WS($1)\n" if ($dbg_values > 1);
776 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800777 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800778 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700779 }
780
Andy Whitcroft8ea3eb92008-07-23 21:29:08 -0700781 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800782 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700783 $type = 'T';
784
Andy Whitcroft389a2fe2008-07-23 21:29:05 -0700785 } elsif ($cur =~ /^($Modifier)\s*/) {
786 print "MODIFIER($1)\n" if ($dbg_values > 1);
787 $type = 'T';
788
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700789 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700790 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800791 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700792 push(@av_paren_type, $type);
793 if ($2 ne '') {
794 $av_pending = 'N';
795 }
796 $type = 'E';
797
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700798 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700799 print "UNDEF($1)\n" if ($dbg_values > 1);
800 $av_preprocessor = 1;
801 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700802
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700803 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800804 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800805 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800806
807 push(@av_paren_type, $type);
808 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700809 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800810
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700811 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800812 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
813 $av_preprocessor = 1;
814
815 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
816
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700817 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800818
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700819 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800820 print "PRE_END($1)\n" if ($dbg_values > 1);
821
822 $av_preprocessor = 1;
823
824 # Assume all arms of the conditional end as this
825 # one does, and continue as if the #endif was not here.
826 pop(@av_paren_type);
827 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700828 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700829
830 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800831 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700832
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700833 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
834 print "ATTR($1)\n" if ($dbg_values > 1);
835 $av_pending = $type;
836 $type = 'N';
837
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700838 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800839 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700840 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800841 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700842 }
843 $type = 'N';
844
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700845 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800846 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700847 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700848 $type = 'N';
849
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700850 } elsif ($cur =~/^(case)/o) {
851 print "CASE($1)\n" if ($dbg_values > 1);
852 $av_pend_colon = 'C';
853 $type = 'N';
854
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700855 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800856 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700857 $type = 'N';
858
859 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800860 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800861 push(@av_paren_type, $av_pending);
862 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700863 $type = 'N';
864
865 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800866 my $new_type = pop(@av_paren_type);
867 if ($new_type ne '_') {
868 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800869 print "PAREN('$1') -> $type\n"
870 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700871 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800872 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700873 }
874
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700875 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800876 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700877 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800878 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700879
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800880 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
881 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700882 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800883 } elsif ($type eq 'E') {
884 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700885 }
886 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
887 $type = 'V';
888
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700889 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800890 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700891 $type = 'V';
892
893 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800894 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700895 $type = 'N';
896
Andy Whitcroftcf655042008-03-04 14:28:20 -0800897 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800898 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800899 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700900 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800901
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800902 } elsif ($cur =~/^(,)/) {
903 print "COMMA($1)\n" if ($dbg_values > 1);
904 $type = 'C';
905
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700906 } elsif ($cur =~ /^(\?)/o) {
907 print "QUESTION($1)\n" if ($dbg_values > 1);
908 $type = 'N';
909
910 } elsif ($cur =~ /^(:)/o) {
911 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
912
913 substr($var, length($res), 1, $av_pend_colon);
914 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
915 $type = 'E';
916 } else {
917 $type = 'N';
918 }
919 $av_pend_colon = 'O';
920
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800921 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800922 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700923 $type = 'N';
924
Andy Whitcroft0d413862008-10-15 22:02:16 -0700925 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -0700926 my $variant;
927
928 print "OPV($1)\n" if ($dbg_values > 1);
929 if ($type eq 'V') {
930 $variant = 'B';
931 } else {
932 $variant = 'U';
933 }
934
935 substr($var, length($res), 1, $variant);
936 $type = 'N';
937
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700938 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800939 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700940 if ($1 ne '++' && $1 ne '--') {
941 $type = 'N';
942 }
943
944 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800945 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700946 }
947 if (defined $1) {
948 $cur = substr($cur, length($1));
949 $res .= $type x length($1);
950 }
951 }
952
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700953 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700954}
955
Andy Whitcroft8905a672007-11-28 16:21:06 -0800956sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800957 my ($possible, $line) = @_;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800958
Andy Whitcroft0776e592008-10-15 22:02:29 -0700959 print "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
960 if ($possible !~ /(?:
961 ^(?:
962 $Modifier|
963 $Storage|
964 $Type|
965 DEFINE_\S+|
966 goto|
967 return|
968 case|
969 else|
970 asm|__asm__|
971 do
972 )$|
973 ^(?:typedef|struct|enum)\b
974 )/x) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700975 # Check for modifiers.
976 $possible =~ s/\s*$Storage\s*//g;
977 $possible =~ s/\s*$Sparse\s*//g;
978 if ($possible =~ /^\s*$/) {
979
980 } elsif ($possible =~ /\s/) {
981 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -0700982 for my $modifier (split(' ', $possible)) {
983 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
984 push(@modifierList, $modifier);
985 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700986
987 } else {
988 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
989 push(@typeList, $possible);
990 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800991 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -0700992 } else {
993 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800994 }
995}
996
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700997my $prefix = '';
998
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700999sub report {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001000 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
1001 return 0;
1002 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001003 my $line = $prefix . $_[0];
1004
1005 $line = (split('\n', $line))[0] . "\n" if ($terse);
1006
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001007 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001008
1009 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001010}
1011sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001012 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001013}
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001014sub ERROR {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001015 if (report("ERROR: $_[0]\n")) {
1016 our $clean = 0;
1017 our $cnt_error++;
1018 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001019}
1020sub WARN {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001021 if (report("WARNING: $_[0]\n")) {
1022 our $clean = 0;
1023 our $cnt_warn++;
1024 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001025}
1026sub CHK {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001027 if ($check && report("CHECK: $_[0]\n")) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001028 our $clean = 0;
1029 our $cnt_chk++;
1030 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001031}
1032
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001033sub check_absolute_file {
1034 my ($absolute, $herecurr) = @_;
1035 my $file = $absolute;
1036
1037 ##print "absolute<$absolute>\n";
1038
1039 # See if any suffix of this path is a path within the tree.
1040 while ($file =~ s@^[^/]*/@@) {
1041 if (-f "$root/$file") {
1042 ##print "file<$file>\n";
1043 last;
1044 }
1045 }
1046 if (! -f _) {
1047 return 0;
1048 }
1049
1050 # It is, so see if the prefix is acceptable.
1051 my $prefix = $absolute;
1052 substr($prefix, -length($file)) = '';
1053
1054 ##print "prefix<$prefix>\n";
1055 if ($prefix ne ".../") {
1056 WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr);
1057 }
1058}
1059
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001060sub process {
1061 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001062
1063 my $linenr=0;
1064 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001065 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001066 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001067 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001068
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001069 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001070 my $indent;
1071 my $previndent=0;
1072 my $stashindent=0;
1073
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001074 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001075 my $signoff = 0;
1076 my $is_patch = 0;
1077
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001078 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001079 our $cnt_lines = 0;
1080 our $cnt_error = 0;
1081 our $cnt_warn = 0;
1082 our $cnt_chk = 0;
1083
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001084 # Trace the real file/line as we go.
1085 my $realfile = '';
1086 my $realline = 0;
1087 my $realcnt = 0;
1088 my $here = '';
1089 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001090 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001091 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001092 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001093
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001094 my $prev_values = 'E';
1095
1096 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001097 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001098 my %suppress_whiletrailers;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001099
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001100 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001101 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001102 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001103 my @setup_docs = ();
1104 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001105
1106 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001107 my $line;
1108 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001109 $linenr++;
1110 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001111
Andy Whitcroft773647a2008-03-28 14:15:58 -07001112 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001113 $setup_docs = 0;
1114 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1115 $setup_docs = 1;
1116 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001117 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001118 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001119 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1120 $realline=$1-1;
1121 if (defined $2) {
1122 $realcnt=$3+1;
1123 } else {
1124 $realcnt=1+1;
1125 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001126 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001127
1128 # Guestimate if this is a continuing comment. Run
1129 # the context looking for a comment "edge". If this
1130 # edge is a close comment then we must be in a comment
1131 # at context start.
1132 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001133 my $cnt = $realcnt;
1134 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1135 next if (defined $rawlines[$ln - 1] &&
1136 $rawlines[$ln - 1] =~ /^-/);
1137 $cnt--;
1138 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001139 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001140 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1141 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1142 ($edge) = $1;
1143 last;
1144 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001145 }
1146 if (defined $edge && $edge eq '*/') {
1147 $in_comment = 1;
1148 }
1149
1150 # Guestimate if this is a continuing comment. If this
1151 # is the start of a diff block and this line starts
1152 # ' *' then it is very likely a comment.
1153 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001154 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001155 {
1156 $in_comment = 1;
1157 }
1158
1159 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1160 sanitise_line_reset($in_comment);
1161
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001162 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001163 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001164 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001165 $line = sanitise_line($rawline);
1166 }
1167 push(@lines, $line);
1168
1169 if ($realcnt > 1) {
1170 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1171 } else {
1172 $realcnt = 0;
1173 }
1174
1175 #print "==>$rawline\n";
1176 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001177
1178 if ($setup_docs && $line =~ /^\+/) {
1179 push(@setup_docs, $line);
1180 }
1181 }
1182
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001183 $prefix = '';
1184
Andy Whitcroft773647a2008-03-28 14:15:58 -07001185 $realcnt = 0;
1186 $linenr = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001187 foreach my $line (@lines) {
1188 $linenr++;
1189
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001190 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft306708542008-10-15 22:02:28 -07001191 my $hunk_line = ($realcnt != 0);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001192
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001193#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001194 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001195 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001196 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001197 $realline=$1-1;
1198 if (defined $2) {
1199 $realcnt=$3+1;
1200 } else {
1201 $realcnt=1+1;
1202 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001203 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001204 $prev_values = 'E';
1205
Andy Whitcroft773647a2008-03-28 14:15:58 -07001206 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001207 %suppress_whiletrailers = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001208 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001209
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001210# track the line number as we move through the hunk, note that
1211# new versions of GNU diff omit the leading space on completely
1212# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001213 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001214 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001215 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001216
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001217 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001218 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001219
1220 # Track the previous line.
1221 ($prevline, $stashline) = ($stashline, $line);
1222 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001223 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1224
Andy Whitcroft773647a2008-03-28 14:15:58 -07001225 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001226
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001227 } elsif ($realcnt == 1) {
1228 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001229 }
1230
1231#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001232 $prefix = "$filename:$realline: " if ($emacs && $file);
1233 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1234
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001235 $here = "#$linenr: " if (!$file);
1236 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001237
1238 # extract the filename as it passes
1239 if ($line=~/^\+\+\+\s+(\S+)/) {
1240 $realfile = $1;
Wolfram Sang1e855722009-01-06 14:41:24 -08001241 $realfile =~ s@^([^/]*)/@@;
1242
1243 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001244 if (!$file && $tree && $p1_prefix ne '' &&
1245 -e "$root/$p1_prefix") {
Wolfram Sang1e855722009-01-06 14:41:24 -08001246 WARN("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1247 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001248
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001249 if ($realfile =~ m@^include/asm/@) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001250 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1251 }
1252 next;
1253 }
1254
Randy Dunlap389834b2007-06-08 13:47:03 -07001255 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001256
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001257 my $hereline = "$here\n$rawline\n";
1258 my $herecurr = "$here\n$rawline\n";
1259 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001260
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001261 $cnt_lines++ if ($realcnt != 0);
1262
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001263#check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001264 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001265 # This is a signoff, if ugly, so do not double report.
1266 $signoff++;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001267 if (!($line =~ /^\s*Signed-off-by:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001268 WARN("Signed-off-by: is the preferred form\n" .
1269 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001270 }
1271 if ($line =~ /^\s*signed-off-by:\S/i) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001272 WARN("space required after Signed-off-by:\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001273 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001274 }
1275 }
1276
Andy Whitcroft00df3442007-06-08 13:47:06 -07001277# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001278 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001279 ERROR("patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001280 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001281 }
1282
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001283# Check for absolute kernel paths.
1284 if ($tree) {
1285 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1286 my $file = $1;
1287
1288 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1289 check_absolute_file($1, $herecurr)) {
1290 #
1291 } else {
1292 check_absolute_file($file, $herecurr);
1293 }
1294 }
1295 }
1296
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001297# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1298 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001299 $rawline !~ m/^$UTF8*$/) {
1300 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1301
1302 my $blank = copy_spacing($rawline);
1303 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1304 my $hereptr = "$hereline$ptr\n";
1305
1306 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001307 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001308
Andy Whitcroft306708542008-10-15 22:02:28 -07001309# ignore non-hunk lines and lines being removed
1310 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001311
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001312#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001313 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001314 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001315 ERROR("DOS line endings\n" . $herevet);
1316
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001317 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1318 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001319 ERROR("trailing whitespace\n" . $herevet);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001320 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07001321
1322# check we are in a valid source file if not then ignore this hunk
1323 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1324
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001325#80 column limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001326 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001327 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1328 $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1329 $length > 80)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001330 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001331 WARN("line over 80 characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001332 }
1333
Andy Whitcroft8905a672007-11-28 16:21:06 -08001334# check for adding lines without a newline.
1335 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1336 WARN("adding a line without newline at end of file\n" . $herecurr);
1337 }
1338
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001339# check we are in a valid source file C or perl if not then ignore this hunk
1340 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001341
1342# at the beginning of a line any tabs must come first and anything
1343# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001344 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1345 $rawline =~ /^\+\s* \s*/) {
1346 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001347 ERROR("code indent should use tabs where possible\n" . $herevet);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001348 }
1349
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001350# check we are in a valid C source file if not then ignore this hunk
1351 next if ($realfile !~ /\.(h|c)$/);
1352
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001353# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001354 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001355 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1356 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001357
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001358# Check for potential 'bare' types
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001359 my ($stat, $cond, $line_nr_next, $remain_next, $off_next);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001360 if ($realcnt && $line =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001361 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001362 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001363 $stat =~ s/\n./\n /g;
1364 $cond =~ s/\n./\n /g;
1365
1366 my $s = $stat;
1367 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001368
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001369 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001370 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001371
1372 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001373 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001374
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001375 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001376 } 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 -07001377 my $type = $1;
1378 $type =~ s/\s+/ /g;
1379 possible($type, "A:" . $s);
1380
Andy Whitcroft8905a672007-11-28 16:21:06 -08001381 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07001382 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001383 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001384 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001385
1386 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08001387 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001388 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001389 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001390
1391 # Check for any sort of function declaration.
1392 # int foo(something bar, other baz);
1393 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001394 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 -08001395 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001396
Andy Whitcroftcf655042008-03-04 14:28:20 -08001397 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001398 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001399 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001400
Andy Whitcroft8905a672007-11-28 16:21:06 -08001401 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001402 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001403
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001404 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001405 }
1406 }
1407 }
1408
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001409 }
1410
Andy Whitcroft653d4872007-06-23 17:16:34 -07001411#
1412# Checks which may be anchored in the context.
1413#
1414
1415# Check for switch () and associated case and default
1416# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07001417 if ($line=~/\bswitch\s*\(.*\)/) {
1418 my $err = '';
1419 my $sep = '';
1420 my @ctx = ctx_block_outer($linenr, $realcnt);
1421 shift(@ctx);
1422 for my $ctx (@ctx) {
1423 my ($clen, $cindent) = line_stats($ctx);
1424 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1425 $indent != $cindent) {
1426 $err .= "$sep$ctx\n";
1427 $sep = '';
1428 } else {
1429 $sep = "[...]\n";
1430 }
1431 }
1432 if ($err ne '') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001433 ERROR("switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001434 }
1435 }
1436
1437# if/while/etc brace do not go on next line, unless defining a do while loop,
1438# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001439 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001440 my $pre_ctx = "$1$2";
1441
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001442 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001443 my $ctx_cnt = $realcnt - $#ctx - 1;
1444 my $ctx = join("\n", @ctx);
1445
Andy Whitcroft548596d2008-07-23 21:29:01 -07001446 my $ctx_ln = $linenr;
1447 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001448
Andy Whitcroft548596d2008-07-23 21:29:01 -07001449 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1450 defined $lines[$ctx_ln - 1] &&
1451 $lines[$ctx_ln - 1] =~ /^-/)) {
1452 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1453 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001454 $ctx_ln++;
1455 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07001456
Andy Whitcroft53210162008-07-23 21:29:03 -07001457 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1458 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001459
1460 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1461 ERROR("that open brace { should be on the previous line\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001462 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07001463 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001464 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1465 $ctx =~ /\)\s*\;\s*$/ &&
1466 defined $lines[$ctx_ln - 1])
1467 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001468 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1469 if ($nindent > $indent) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001470 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001471 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001472 }
1473 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001474 }
1475
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001476# Check relative indent for conditionals and blocks.
1477 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1478 my ($s, $c) = ($stat, $cond);
1479
1480 substr($s, 0, length($c), '');
1481
1482 # Make sure we remove the line prefixes as we have
1483 # none on the first line, and are going to readd them
1484 # where necessary.
1485 $s =~ s/\n./\n/gs;
1486
1487 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07001488 my @newlines = ($c =~ /\n/gs);
1489 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001490
1491 # We want to check the first line inside the block
1492 # starting at the end of the conditional, so remove:
1493 # 1) any blank line termination
1494 # 2) any opening brace { on end of the line
1495 # 3) any do (...) {
1496 my $continuation = 0;
1497 my $check = 0;
1498 $s =~ s/^.*\bdo\b//;
1499 $s =~ s/^\s*{//;
1500 if ($s =~ s/^\s*\\//) {
1501 $continuation = 1;
1502 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001503 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001504 $check = 1;
1505 $cond_lines++;
1506 }
1507
1508 # Also ignore a loop construct at the end of a
1509 # preprocessor statement.
1510 if (($prevline =~ /^.\s*#\s*define\s/ ||
1511 $prevline =~ /\\\s*$/) && $continuation == 0) {
1512 $check = 0;
1513 }
1514
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001515 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07001516 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001517 while ($cond_ptr != $cond_lines) {
1518 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001519
Andy Whitcroftf16fa282008-10-15 22:02:32 -07001520 # If we see an #else/#elif then the code
1521 # is not linear.
1522 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1523 $check = 0;
1524 }
1525
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001526 # Ignore:
1527 # 1) blank lines, they should be at 0,
1528 # 2) preprocessor lines, and
1529 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07001530 if ($continuation ||
1531 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001532 $s =~ /^\s*#\s*?/ ||
1533 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07001534 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001535 $s =~ s/^.*?\n//;
1536 $cond_lines++;
1537 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001538 }
1539
1540 my (undef, $sindent) = line_stats("+" . $s);
1541 my $stat_real = raw_line($linenr, $cond_lines);
1542
1543 # Check if either of these lines are modified, else
1544 # this is not this patch's fault.
1545 if (!defined($stat_real) ||
1546 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1547 $check = 0;
1548 }
1549 if (defined($stat_real) && $cond_lines > 1) {
1550 $stat_real = "[...]\n$stat_real";
1551 }
1552
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001553 #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 -07001554
1555 if ($check && (($sindent % 8) != 0 ||
1556 ($sindent <= $indent && $s ne ''))) {
1557 WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1558 }
1559 }
1560
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001561 # Track the 'values' across context and added lines.
1562 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001563 my ($curr_values, $curr_vars) =
1564 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001565 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001566 if ($dbg_values) {
1567 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001568 print "$linenr > .$outline\n";
1569 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001570 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001571 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001572 $prev_values = substr($curr_values, -1);
1573
Andy Whitcroft00df3442007-06-08 13:47:06 -07001574#ignore lines not being added
1575 if ($line=~/^[^\+]/) {next;}
1576
Andy Whitcroft653d4872007-06-23 17:16:34 -07001577# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07001578 if ($dbg_type) {
1579 if ($line =~ /^.\s*$Declare\s*$/) {
1580 ERROR("TEST: is type\n" . $herecurr);
1581 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1582 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1583 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001584 next;
1585 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001586# TEST: allow direct testing of the attribute matcher.
1587 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08001588 if ($line =~ /^.\s*$Modifier\s*$/) {
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001589 ERROR("TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08001590 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001591 ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1592 }
1593 next;
1594 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001595
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001596# check for initialisation to aggregates open brace on the next line
1597 if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1598 $line =~ /^.\s*{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001599 ERROR("that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001600 }
1601
Andy Whitcroft653d4872007-06-23 17:16:34 -07001602#
1603# Checks which are anchored on the added line.
1604#
1605
1606# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001607 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001608 my $path = $1;
1609 if ($path =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001610 ERROR("malformed #include filename\n" .
1611 $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001612 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001613 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001614
1615# no C99 // comments
1616 if ($line =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001617 ERROR("do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001618 }
1619 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001620 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001621 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001622
1623#EXPORT_SYMBOL should immediately follow its function closing }.
Andy Whitcroft653d4872007-06-23 17:16:34 -07001624 if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1625 ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1626 my $name = $1;
Andy Whitcroft48012052008-10-15 22:02:34 -07001627 if ($prevline !~ /(?:
1628 ^.}|
1629 ^.DEFINE_$Ident\(\Q$name\E\)|
1630 ^.DECLARE_$Ident\(\Q$name\E\)|
1631 ^.LIST_HEAD\(\Q$name\E\)|
1632 ^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
1633 \b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)
1634 )/x) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001635 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001636 }
1637 }
1638
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001639# check for external initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001640 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001641 ERROR("do not initialise externals to 0 or NULL\n" .
1642 $herecurr);
1643 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001644# check for static initialisers.
Andy Whitcroft2d1bafd72009-01-06 14:41:28 -08001645 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001646 ERROR("do not initialise statics to 0 or NULL\n" .
1647 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001648 }
1649
Andy Whitcroft653d4872007-06-23 17:16:34 -07001650# check for new typedefs, only function parameters and sparse annotations
1651# make sense.
1652 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08001653 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001654 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07001655 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001656 $line !~ /\b__bitwise(?:__|)\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001657 WARN("do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001658 }
1659
1660# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08001661 # (char*[ const])
Andy Whitcroft00ef4ec2009-02-27 14:03:07 -08001662 if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001663 my ($from, $to) = ($1, $1);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001664
Andy Whitcroft65863862009-01-06 14:41:21 -08001665 # Should start with a space.
1666 $to =~ s/^(\S)/ $1/;
1667 # Should not end with a space.
1668 $to =~ s/\s+$//;
1669 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08001670 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001671 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001672
Andy Whitcroft65863862009-01-06 14:41:21 -08001673 #print "from<$from> to<$to>\n";
1674 if ($from ne $to) {
1675 ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
1676 }
Andy Whitcroft00ef4ec2009-02-27 14:03:07 -08001677 } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001678 my ($from, $to, $ident) = ($1, $1, $2);
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 }
1687 # Modifiers should have spaces.
1688 $to =~ s/(\b$Modifier$)/$1 /;
1689
Andy Whitcroft667026e2009-02-27 14:03:08 -08001690 #print "from<$from> to<$to> ident<$ident>\n";
1691 if ($from ne $to && $ident !~ /^$Modifier$/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001692 ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
1693 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001694 }
1695
1696# # no BUG() or BUG_ON()
1697# if ($line =~ /\b(BUG|BUG_ON)\b/) {
1698# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1699# print "$herecurr";
1700# $clean = 0;
1701# }
1702
Andy Whitcroft8905a672007-11-28 16:21:06 -08001703 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001704 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 -08001705 }
1706
Andy Whitcroft00df3442007-06-08 13:47:06 -07001707# printk should use KERN_* levels. Note that follow on printk's on the
1708# same line do not need a level, so we use the current block context
1709# to try and find and validate the current printk. In summary the current
1710# printk includes all preceeding printk's which have no newline on the end.
1711# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001712 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001713 my $ok = 0;
1714 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1715 #print "CHECK<$lines[$ln - 1]\n";
1716 # we have a preceeding printk if it ends
1717 # with "\n" ignore it, else it is to blame
1718 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1719 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1720 $ok = 1;
1721 }
1722 last;
1723 }
1724 }
1725 if ($ok == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001726 WARN("printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001727 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001728 }
1729
Andy Whitcroft653d4872007-06-23 17:16:34 -07001730# function brace can't be on same line, except for #defines of do while,
1731# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001732 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1733 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001734 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001735 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001736
Andy Whitcroft8905a672007-11-28 16:21:06 -08001737# open braces for enum, union and struct go on the same line.
1738 if ($line =~ /^.\s*{/ &&
1739 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1740 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1741 }
1742
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001743# check for spacing round square brackets; allowed:
1744# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001745# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1746# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001747 while ($line =~ /(.*?\s)\[/g) {
1748 my ($where, $prefix) = ($-[1], $1);
1749 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001750 ($where != 0 || $prefix !~ /^.\s+$/) &&
1751 $prefix !~ /{\s+$/) {
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001752 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1753 }
1754 }
1755
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001756# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001757 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001758 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001759 my $ctx_before = substr($line, 0, $-[1]);
1760 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001761
1762 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001763 if ($name =~ /^(?:
1764 if|for|while|switch|return|case|
1765 volatile|__volatile__|
1766 __attribute__|format|__extension__|
1767 asm|__asm__)$/x)
1768 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001769
1770 # cpp #define statements have non-optional spaces, ie
1771 # if there is a space between the name and the open
1772 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001773 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001774
1775 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001776 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001777
1778 # If this whole things ends with a type its most
1779 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001780 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001781
1782 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001783 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001784 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001785 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001786# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001787 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001788 my $ops = qr{
1789 <<=|>>=|<=|>=|==|!=|
1790 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1791 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001792 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1793 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001794 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001795 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001796 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001797
1798 my $blank = copy_spacing($opline);
1799
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001800 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001801 $off += length($elements[$n]);
1802
Andy Whitcroft773647a2008-03-28 14:15:58 -07001803 # Pick up the preceeding and succeeding characters.
1804 my $ca = substr($opline, 0, $off);
1805 my $cc = '';
1806 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1807 $cc = substr($opline, $off + length($elements[$n + 1]));
1808 }
1809 my $cb = "$ca$;$cc";
1810
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001811 my $a = '';
1812 $a = 'V' if ($elements[$n] ne '');
1813 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001814 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001815 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1816 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07001817 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001818
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001819 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001820
1821 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001822 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001823 $c = 'V' if ($elements[$n + 2] ne '');
1824 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001825 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001826 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1827 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08001828 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001829 } else {
1830 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001831 }
1832
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001833 my $ctx = "${a}x${c}";
1834
1835 my $at = "(ctx:$ctx)";
1836
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001837 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001838 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001839
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001840 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001841 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001842
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001843 # Get the full operator variant.
1844 my $opv = $op . substr($curr_vars, $off, 1);
1845
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001846 # Ignore operators passed as parameters.
1847 if ($op_type ne 'V' &&
1848 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1849
Andy Whitcroftcf655042008-03-04 14:28:20 -08001850# # Ignore comments
1851# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001852
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001853 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001854 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001855 if ($ctx !~ /.x[WEBC]/ &&
1856 $cc !~ /^\\/ && $cc !~ /^;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001857 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001858 }
1859
1860 # // is a comment
1861 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001862
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001863 # No spaces for:
1864 # ->
1865 # : when part of a bitfield
1866 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001867 if ($ctx =~ /Wx.|.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001868 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001869 }
1870
1871 # , must have a space on the right.
1872 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001873 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001874 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001875 }
1876
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001877 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001878 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001879 #warn "'*' is part of type\n";
1880
1881 # unary operators should have a space before and
1882 # none after. May be left adjacent to another
1883 # unary operator, or a cast
1884 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001885 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07001886 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001887 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001888 ERROR("space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001889 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08001890 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001891 # A unary '*' may be const
1892
1893 } elsif ($ctx =~ /.xW/) {
Andy Whitcrofta3340b32009-02-27 14:03:07 -08001894 ERROR("Aspace prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001895 }
1896
1897 # unary ++ and unary -- are allowed no space on one side.
1898 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001899 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1900 ERROR("space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001901 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001902 if ($ctx =~ /Wx[BE]/ ||
1903 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1904 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001905 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001906 if ($ctx =~ /ExW/) {
1907 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1908 }
1909
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001910
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001911 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001912 } elsif ($op eq '<<' or $op eq '>>' or
1913 $op eq '&' or $op eq '^' or $op eq '|' or
1914 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001915 $op eq '*' or $op eq '/' or
1916 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001917 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001918 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001919 ERROR("need consistent spacing around '$op' $at\n" .
1920 $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001921 }
1922
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001923 # A colon needs no spaces before when it is
1924 # terminating a case value or a label.
1925 } elsif ($opv eq ':C' || $opv eq ':L') {
1926 if ($ctx =~ /Wx./) {
1927 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1928 }
1929
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001930 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08001931 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001932 my $ok = 0;
1933
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001934 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001935 if (($op eq '<' &&
1936 $cc =~ /^\S+\@\S+>/) ||
1937 ($op eq '>' &&
1938 $ca =~ /<\S+\@\S+$/))
1939 {
1940 $ok = 1;
1941 }
1942
1943 # Ignore ?:
1944 if (($opv eq ':O' && $ca =~ /\?$/) ||
1945 ($op eq '?' && $cc =~ /^:/)) {
1946 $ok = 1;
1947 }
1948
1949 if ($ok == 0) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001950 ERROR("spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001951 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001952 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001953 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001954 }
1955 }
1956
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001957# check for multiple assignments
1958 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001959 CHK("multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001960 }
1961
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001962## # check for multiple declarations, allowing for a function declaration
1963## # continuation.
1964## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
1965## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
1966##
1967## # Remove any bracketed sections to ensure we do not
1968## # falsly report the parameters of functions.
1969## my $ln = $line;
1970## while ($ln =~ s/\([^\(\)]*\)//g) {
1971## }
1972## if ($ln =~ /,/) {
1973## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
1974## }
1975## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001976
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001977#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001978 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
1979 $line =~ /do{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001980 ERROR("space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001981 }
1982
1983# closing brace should have a space following it when it has anything
1984# on the line
1985 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001986 ERROR("space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001987 }
1988
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001989# check spacing on square brackets
1990 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001991 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001992 }
1993 if ($line =~ /\s\]/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001994 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001995 }
1996
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001997# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001998 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
1999 $line !~ /for\s*\(\s+;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002000 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002001 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002002 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002003 $line !~ /for\s*\(.*;\s+\)/ &&
2004 $line !~ /:\s+\)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002005 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002006 }
2007
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002008#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002009 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002010 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002011 WARN("labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002012 }
2013
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002014# Return is not a function.
2015 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2016 my $spacing = $1;
2017 my $value = $2;
2018
Andy Whitcroft86f9d052009-01-06 14:41:24 -08002019 # Flatten any parentheses
Andy Whitcroftfee61c42008-07-23 21:28:56 -07002020 $value =~ s/\)\(/\) \(/g;
Andy Whitcroft63f17f82009-01-15 13:51:06 -08002021 while ($value =~ s/\[[^\{\}]*\]/1/ ||
2022 $value !~ /(?:$Ident|-?$Constant)\s*
2023 $Compare\s*
2024 (?:$Ident|-?$Constant)/x &&
2025 $value =~ s/\([^\(\)]*\)/1/) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002026 }
2027
2028 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
2029 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
2030
2031 } elsif ($spacing !~ /\s+/) {
2032 ERROR("space required before the open parenthesis '('\n" . $herecurr);
2033 }
2034 }
2035
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002036# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002037 if ($line=~/\b(if|while|for|switch)\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002038 ERROR("space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002039 }
2040
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002041# Check for illegal assignment in if conditional -- and check for trailing
2042# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002043 if ($line =~ /do\s*(?!{)/) {
2044 my ($stat_next) = ctx_statement_block($line_nr_next,
2045 $remain_next, $off_next);
2046 $stat_next =~ s/\n./\n /g;
2047 ##print "stat<$stat> stat_next<$stat_next>\n";
2048
2049 if ($stat_next =~ /^\s*while\b/) {
2050 # If the statement carries leading newlines,
2051 # then count those as offsets.
2052 my ($whitespace) =
2053 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2054 my $offset =
2055 statement_rawlines($whitespace) - 1;
2056
2057 $suppress_whiletrailers{$line_nr_next +
2058 $offset} = 1;
2059 }
2060 }
2061 if (!defined $suppress_whiletrailers{$linenr} &&
2062 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002063 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002064
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08002065 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002066 ERROR("do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002067 }
2068
2069 # Find out what is on the end of the line after the
2070 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002071 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002072 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002073 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07002074 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2075 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002076 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002077 # Find out how long the conditional actually is.
2078 my @newlines = ($c =~ /\n/gs);
2079 my $cond_lines = 1 + $#newlines;
2080
2081 my $stat_real = raw_line($linenr, $cond_lines);
2082 if (defined($stat_real) && $cond_lines > 1) {
2083 $stat_real = "[...]\n$stat_real";
2084 }
2085
2086 ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002087 }
2088 }
2089
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002090# Check for bitwise tests written as boolean
2091 if ($line =~ /
2092 (?:
2093 (?:\[|\(|\&\&|\|\|)
2094 \s*0[xX][0-9]+\s*
2095 (?:\&\&|\|\|)
2096 |
2097 (?:\&\&|\|\|)
2098 \s*0[xX][0-9]+\s*
2099 (?:\&\&|\|\||\)|\])
2100 )/x)
2101 {
2102 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2103 }
2104
Andy Whitcroft8905a672007-11-28 16:21:06 -08002105# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002106 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2107 my $s = $1;
2108 $s =~ s/$;//g; # Remove any comments
2109 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2110 ERROR("trailing statements should be on next line\n" . $herecurr);
2111 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002112 }
Andy Whitcroft39667782009-01-15 13:51:06 -08002113# if should not continue a brace
2114 if ($line =~ /}\s*if\b/) {
2115 ERROR("trailing statements should be on next line\n" .
2116 $herecurr);
2117 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002118# case and default should not have general statements after them
2119 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2120 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07002121 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002122 \s*return\s+
2123 )/xg)
2124 {
2125 ERROR("trailing statements should be on next line\n" . $herecurr);
2126 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002127
2128 # Check for }<nl>else {, these must be at the same
2129 # indent level to be relevant to each other.
2130 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2131 $previndent == $indent) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002132 ERROR("else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002133 }
2134
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002135 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2136 $previndent == $indent) {
2137 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2138
2139 # Find out what is on the end of the line after the
2140 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002141 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002142 $s =~ s/\n.*//g;
2143
2144 if ($s =~ /^\s*;/) {
2145 ERROR("while should follow close brace '}'\n" . $hereprev);
2146 }
2147 }
2148
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002149#studly caps, commented out until figure out how to distinguish between use of existing and adding new
2150# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2151# print "No studly caps, use _\n";
2152# print "$herecurr";
2153# $clean = 0;
2154# }
2155
2156#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002157 if ($line=~/\#\s*define.*\\\s$/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002158 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002159 }
2160
Andy Whitcroft653d4872007-06-23 17:16:34 -07002161#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002162 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002163 my $file = "$1.h";
2164 my $checkfile = "include/linux/$file";
2165 if (-f "$root/$checkfile" &&
2166 $realfile ne $checkfile &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002167 $1 ne 'irq')
2168 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002169 if ($realfile =~ m{^arch/}) {
2170 CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2171 } else {
2172 WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2173 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002174 }
2175 }
2176
Andy Whitcroft653d4872007-06-23 17:16:34 -07002177# multi-statement macros should be enclosed in a do while loop, grab the
2178# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08002179# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07002180 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2181 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002182 my $ln = $linenr;
2183 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002184 my ($off, $dstat, $dcond, $rest);
2185 my $ctx = '';
Andy Whitcroft653d4872007-06-23 17:16:34 -07002186
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002187 my $args = defined($1);
2188
2189 # Find the end of the macro and limit our statement
2190 # search to that.
2191 while ($cnt > 0 && defined $lines[$ln - 1] &&
2192 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2193 {
2194 $ctx .= $rawlines[$ln - 1] . "\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002195 $cnt-- if ($lines[$ln - 1] !~ /^-/);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002196 $ln++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002197 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002198 $ctx .= $rawlines[$ln - 1];
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002199
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002200 ($dstat, $dcond, $ln, $cnt, $off) =
2201 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2202 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002203 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002204
2205 # Extract the remainder of the define (if any) and
2206 # rip off surrounding spaces, and trailing \'s.
2207 $rest = '';
Andy Whitcroft636d1402008-10-15 22:02:18 -07002208 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2209 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002210 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2211 $rest .= substr($lines[$ln - 1], $off) . "\n";
2212 $cnt--;
2213 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002214 $ln++;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002215 $off = 0;
2216 }
2217 $rest =~ s/\\\n.//g;
2218 $rest =~ s/^\s*//s;
2219 $rest =~ s/\s*$//s;
2220
2221 # Clean up the original statement.
2222 if ($args) {
2223 substr($dstat, 0, length($dcond), '');
2224 } else {
2225 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2226 }
Andy Whitcroft292f1a92008-07-23 21:29:11 -07002227 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002228 $dstat =~ s/\\\n.//g;
2229 $dstat =~ s/^\s*//s;
2230 $dstat =~ s/\s*$//s;
2231
2232 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07002233 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2234 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2235 $dstat =~ s/\[[^\{\}]*\]/1/)
2236 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002237 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002238
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002239 my $exceptions = qr{
2240 $Declare|
2241 module_param_named|
2242 MODULE_PARAM_DESC|
2243 DECLARE_PER_CPU|
2244 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08002245 __typeof__\(|
2246 \.$Ident\s*=\s*
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002247 }x;
Andy Whitcroft383099f2009-01-06 14:41:18 -08002248 #print "REST<$rest> dstat<$dstat>\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002249 if ($rest ne '') {
2250 if ($rest !~ /while\s*\(/ &&
2251 $dstat !~ /$exceptions/)
2252 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002253 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 -07002254 }
2255
2256 } elsif ($ctx !~ /;/) {
2257 if ($dstat ne '' &&
2258 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2259 $dstat !~ /$exceptions/ &&
Andy Whitcroftb132e5d2008-10-15 22:02:31 -07002260 $dstat !~ /^\.$Ident\s*=/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002261 $dstat =~ /$Operators/)
2262 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002263 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002264 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002265 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002266 }
2267
Mike Frysinger080ba922009-01-06 14:41:25 -08002268# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
2269# all assignments may have only one of the following with an assignment:
2270# .
2271# ALIGN(...)
2272# VMLINUX_SYMBOL(...)
2273 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
2274 WARN("vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
2275 }
2276
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002277# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002278 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2279 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08002280 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002281 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002282 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2283 if ($#chunks > 0 && $level == 0) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002284 my $allowed = 0;
2285 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002286 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002287 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002288 for my $chunk (@chunks) {
2289 my ($cond, $block) = @{$chunk};
2290
Andy Whitcroft773647a2008-03-28 14:15:58 -07002291 # If the condition carries leading newlines, then count those as offsets.
2292 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2293 my $offset = statement_rawlines($whitespace) - 1;
2294
2295 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2296
2297 # We have looked at and allowed this specific line.
2298 $suppress_ifbraces{$ln + $offset} = 1;
2299
2300 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002301 $ln += statement_rawlines($block) - 1;
2302
Andy Whitcroft773647a2008-03-28 14:15:58 -07002303 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002304
2305 $seen++ if ($block =~ /^\s*{/);
2306
Andy Whitcroftcf655042008-03-04 14:28:20 -08002307 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2308 if (statement_lines($cond) > 1) {
2309 #print "APW: ALLOWED: cond<$cond>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002310 $allowed = 1;
2311 }
2312 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002313 #print "APW: ALLOWED: block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002314 $allowed = 1;
2315 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002316 if (statement_block_size($block) > 1) {
2317 #print "APW: ALLOWED: lines block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002318 $allowed = 1;
2319 }
2320 }
2321 if ($seen && !$allowed) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002322 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002323 }
2324 }
2325 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002326 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002327 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002328 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002329
Andy Whitcroftcf655042008-03-04 14:28:20 -08002330 # Check the pre-context.
2331 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2332 #print "APW: ALLOWED: pre<$1>\n";
2333 $allowed = 1;
2334 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002335
2336 my ($level, $endln, @chunks) =
2337 ctx_statement_full($linenr, $realcnt, $-[0]);
2338
Andy Whitcroftcf655042008-03-04 14:28:20 -08002339 # Check the condition.
2340 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07002341 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002342 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002343 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08002344 }
2345 if (statement_lines($cond) > 1) {
2346 #print "APW: ALLOWED: cond<$cond>\n";
2347 $allowed = 1;
2348 }
2349 if ($block =~/\b(?:if|for|while)\b/) {
2350 #print "APW: ALLOWED: block<$block>\n";
2351 $allowed = 1;
2352 }
2353 if (statement_block_size($block) > 1) {
2354 #print "APW: ALLOWED: lines block<$block>\n";
2355 $allowed = 1;
2356 }
2357 # Check the post-context.
2358 if (defined $chunks[1]) {
2359 my ($cond, $block) = @{$chunks[1]};
2360 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002361 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002362 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002363 if ($block =~ /^\s*\{/) {
2364 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2365 $allowed = 1;
2366 }
2367 }
2368 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2369 my $herectx = $here . "\n";;
Andy Whitcroftf0556632008-10-15 22:02:23 -07002370 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002371
Andy Whitcroftf0556632008-10-15 22:02:23 -07002372 for (my $n = 0; $n < $cnt; $n++) {
2373 $herectx .= raw_line($linenr, $n) . "\n";;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002374 }
2375
2376 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002377 }
2378 }
2379
Andy Whitcroft653d4872007-06-23 17:16:34 -07002380# don't include deprecated include files (uses RAW line)
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002381 for my $inc (@dep_includes) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002382 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002383 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002384 }
2385 }
2386
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002387# don't use deprecated functions
2388 for my $func (@dep_functions) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002389 if ($line =~ /\b$func\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002390 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002391 }
2392 }
2393
2394# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002395 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2396 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002397 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002398 }
2399
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002400# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2401 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2402 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2403 }
2404
Andy Whitcroft00df3442007-06-08 13:47:06 -07002405# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002406 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002407 CHK("if this code is redundant consider removing it\n" .
2408 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002409 }
2410
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002411# check for needless kfree() checks
2412 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2413 my $expr = $1;
2414 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
Wolfram Sang3c232142008-07-23 21:29:05 -07002415 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002416 }
2417 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07002418# check for needless usb_free_urb() checks
2419 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2420 my $expr = $1;
2421 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2422 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2423 }
2424 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002425
Andy Whitcroft00df3442007-06-08 13:47:06 -07002426# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002427# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002428# print "#ifdef in C files should be avoided\n";
2429# print "$herecurr";
2430# $clean = 0;
2431# }
2432
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002433# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002434 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002435 ERROR("exactly one space required after that #$1\n" . $herecurr);
2436 }
2437
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002438# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002439 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2440 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002441 my $which = $1;
2442 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002443 CHK("$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002444 }
2445 }
2446# check for memory barriers without a comment.
2447 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2448 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002449 CHK("memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002450 }
2451 }
2452# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002453 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002454 CHK("architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002455 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002456
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002457# check the location of the inline attribute, that it is between
2458# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002459 if ($line =~ /\b$Type\s+$Inline\b/ ||
2460 $line =~ /\b$Inline\s+$Storage\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002461 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2462 }
2463
Andy Whitcroft8905a672007-11-28 16:21:06 -08002464# Check for __inline__ and __inline, prefer inline
2465 if ($line =~ /\b(__inline__|__inline)\b/) {
2466 WARN("plain inline is preferred over $1\n" . $herecurr);
2467 }
2468
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002469# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002470 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002471 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002472 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002473 my $function_name = $1;
2474 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002475
2476 my $s = $stat;
2477 if (defined $cond) {
2478 substr($s, 0, length($cond), '');
2479 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002480 if ($s =~ /^\s*;/ &&
2481 $function_name ne 'uninitialized_var')
2482 {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002483 WARN("externs should be avoided in .c files\n" . $herecurr);
2484 }
2485
2486 if ($paren_space =~ /\n/) {
2487 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2488 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002489
2490 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2491 $stat =~ /^.\s*extern\s+/)
2492 {
2493 WARN("externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002494 }
2495
2496# checks for new __setup's
2497 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2498 my $name = $1;
2499
2500 if (!grep(/$name/, @setup_docs)) {
2501 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2502 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002503 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002504
2505# check for pointless casting of kmalloc return
2506 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2507 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2508 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002509
2510# check for gcc specific __FUNCTION__
2511 if ($line =~ /__FUNCTION__/) {
2512 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2513 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002514
2515# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002516 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002517 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2518 }
2519# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002520 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002521 WARN("consider using a completion\n" . $herecurr);
2522 }
2523# recommend strict_strto* over simple_strto*
2524 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2525 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2526 }
Michael Ellermanf3db6632008-07-23 21:28:57 -07002527# check for __initcall(), use device_initcall() explicitly please
2528 if ($line =~ /^.\s*__initcall\s*\(/) {
2529 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2530 }
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08002531# check for struct file_operations, ensure they are const.
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08002532 if ($line !~ /\bconst\b/ &&
2533 $line =~ /\bstruct\s+(file_operations|seq_operations)\b/) {
2534 WARN("struct $1 should normally be const\n" .
2535 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08002536 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002537
2538# use of NR_CPUS is usually wrong
2539# ignore definitions of NR_CPUS and usage to define arrays as likely right
2540 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002541 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2542 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002543 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2544 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2545 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002546 {
2547 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2548 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002549
2550# check for %L{u,d,i} in strings
2551 my $string;
2552 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2553 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07002554 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002555 if ($string =~ /(?<!%)%L[udi]/) {
2556 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2557 last;
2558 }
2559 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08002560
2561# whine mightly about in_atomic
2562 if ($line =~ /\bin_atomic\s*\(/) {
2563 if ($realfile =~ m@^drivers/@) {
2564 ERROR("do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08002565 } elsif ($realfile !~ m@^kernel/@) {
Andy Whitcroft691d77b2009-01-06 14:41:16 -08002566 WARN("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
2567 }
2568 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002569 }
2570
2571 # If we have no input at all, then there is nothing to report on
2572 # so just keep quiet.
2573 if ($#rawlines == -1) {
2574 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002575 }
2576
Andy Whitcroft8905a672007-11-28 16:21:06 -08002577 # In mailback mode only produce a report in the negative, for
2578 # things that appear to be patches.
2579 if ($mailback && ($clean == 1 || !$is_patch)) {
2580 exit(0);
2581 }
2582
2583 # This is not a patch, and we are are in 'no-patch' mode so
2584 # just keep quiet.
2585 if (!$chk_patch && !$is_patch) {
2586 exit(0);
2587 }
2588
2589 if (!$is_patch) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002590 ERROR("Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002591 }
2592 if ($is_patch && $chk_signoff && $signoff == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002593 ERROR("Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002594 }
2595
Andy Whitcroft8905a672007-11-28 16:21:06 -08002596 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002597 if ($summary && !($clean == 1 && $quiet == 1)) {
2598 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002599 print "total: $cnt_error errors, $cnt_warn warnings, " .
2600 (($check)? "$cnt_chk checks, " : "") .
2601 "$cnt_lines lines checked\n";
2602 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002603 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002604
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002605 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002606 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002607 }
2608 if ($clean == 0 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002609 print "$vname has style problems, please review. If any of these errors\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002610 print "are false positives report them to the maintainer, see\n";
2611 print "CHECKPATCH in MAINTAINERS.\n";
2612 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002613
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002614 return $clean;
2615}