blob: 45eb0ae98ebab2c6a771e1d10bfbb10df9231823 [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 Whitcroftdb92a652009-01-15 13:51:07 -080013my $V = '0.27';
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 Whitcroftcf655042008-03-04 14:28:20 -0800113 __kprobes
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700114 }x;
115our $Attribute = qr{
116 const|
117 __read_mostly|
118 __kprobes|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700119 __(?:mem|cpu|dev|)(?:initdata|init)|
120 ____cacheline_aligned|
121 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800122 ____cacheline_internodealigned_in_smp|
123 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700124 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700125our $Modifier;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700126our $Inline = qr{inline|__always_inline|noinline};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700127our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
128our $Lval = qr{$Ident(?:$Member)*};
129
130our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
131our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
Andy Whitcroft86f9d052009-01-06 14:41:24 -0800132our $Compare = qr{<=|>=|==|!=|<|>};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700133our $Operators = qr{
134 <=|>=|==|!=|
135 =>|->|<<|>>|<|>|!|~|
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800136 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700137 }x;
138
Andy Whitcroft8905a672007-11-28 16:21:06 -0800139our $NonptrType;
140our $Type;
141our $Declare;
142
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700143our $UTF8 = qr {
144 [\x09\x0A\x0D\x20-\x7E] # ASCII
145 | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
146 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
147 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
148 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
149 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
150 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
151 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
152}x;
153
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700154our $typeTypedefs = qr{(?x:
155 (?:__)?(?:u|s|be|le)(?:\d|\d\d)|
156 atomic_t
157)};
158
Andy Whitcroft8905a672007-11-28 16:21:06 -0800159our @typeList = (
160 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700161 qr{(?:unsigned\s+)?char},
162 qr{(?:unsigned\s+)?short},
163 qr{(?:unsigned\s+)?int},
164 qr{(?:unsigned\s+)?long},
165 qr{(?:unsigned\s+)?long\s+int},
166 qr{(?:unsigned\s+)?long\s+long},
167 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800168 qr{unsigned},
169 qr{float},
170 qr{double},
171 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800172 qr{struct\s+$Ident},
173 qr{union\s+$Ident},
174 qr{enum\s+$Ident},
175 qr{${Ident}_t},
176 qr{${Ident}_handler},
177 qr{${Ident}_handler_fn},
178);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700179our @modifierList = (
180 qr{fastcall},
181);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800182
183sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700184 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
185 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700186 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800187 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700188 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800189 (?:
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700190 (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700191 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700192 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800193 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700194 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800195 }x;
196 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700197 $NonptrType
Andy Whitcroft65863862009-01-06 14:41:21 -0800198 (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700199 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800200 }x;
201 $Declare = qr{(?:$Storage\s+)?$Type};
202}
203build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700204
205$chk_signoff = 0 if ($file);
206
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700207my @dep_includes = ();
208my @dep_functions = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700209my $removal = "Documentation/feature-removal-schedule.txt";
210if ($tree && -f "$root/$removal") {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800211 open(my $REMOVE, '<', "$root/$removal") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700212 die "$P: $removal: open failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800213 while (<$REMOVE>) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700214 if (/^Check:\s+(.*\S)/) {
215 for my $entry (split(/[, ]+/, $1)) {
216 if ($entry =~ m@include/(.*)@) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700217 push(@dep_includes, $1);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700218
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700219 } elsif ($entry !~ m@/@) {
220 push(@dep_functions, $entry);
221 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700222 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700223 }
224 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800225 close($REMOVE);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700226}
227
Andy Whitcroft00df3442007-06-08 13:47:06 -0700228my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800229my @lines = ();
230my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700231for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800232 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700233 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800234 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700235 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800236 } elsif ($filename eq '-') {
237 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700238 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800239 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700240 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700241 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800242 if ($filename eq '-') {
243 $vname = 'Your patch';
244 } else {
245 $vname = $filename;
246 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800247 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700248 chomp;
249 push(@rawlines, $_);
250 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800251 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800252 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700253 $exit = 1;
254 }
255 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800256 @lines = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700257}
258
259exit($exit);
260
261sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700262 my ($root) = @_;
263
264 my @tree_check = (
265 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
266 "README", "Documentation", "arch", "include", "drivers",
267 "fs", "init", "ipc", "kernel", "lib", "scripts",
268 );
269
270 foreach my $check (@tree_check) {
271 if (! -e $root . '/' . $check) {
272 return 0;
273 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700274 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700275 return 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700276}
277
278sub expand_tabs {
279 my ($str) = @_;
280
281 my $res = '';
282 my $n = 0;
283 for my $c (split(//, $str)) {
284 if ($c eq "\t") {
285 $res .= ' ';
286 $n++;
287 for (; ($n % 8) != 0; $n++) {
288 $res .= ' ';
289 }
290 next;
291 }
292 $res .= $c;
293 $n++;
294 }
295
296 return $res;
297}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700298sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700299 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700300 return $res;
301}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700302
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700303sub line_stats {
304 my ($line) = @_;
305
306 # Drop the diff line leader and expand tabs
307 $line =~ s/^.//;
308 $line = expand_tabs($line);
309
310 # Pick the indent from the front of the line.
311 my ($white) = ($line =~ /^(\s*)/);
312
313 return (length($line), length($white));
314}
315
Andy Whitcroft773647a2008-03-28 14:15:58 -0700316my $sanitise_quote = '';
317
318sub sanitise_line_reset {
319 my ($in_comment) = @_;
320
321 if ($in_comment) {
322 $sanitise_quote = '*/';
323 } else {
324 $sanitise_quote = '';
325 }
326}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700327sub sanitise_line {
328 my ($line) = @_;
329
330 my $res = '';
331 my $l = '';
332
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800333 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700334 my $off = 0;
335 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700336
Andy Whitcroft773647a2008-03-28 14:15:58 -0700337 # Always copy over the diff marker.
338 $res = substr($line, 0, 1);
339
340 for ($off = 1; $off < length($line); $off++) {
341 $c = substr($line, $off, 1);
342
343 # Comments we are wacking completly including the begin
344 # and end, all to $;.
345 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
346 $sanitise_quote = '*/';
347
348 substr($res, $off, 2, "$;$;");
349 $off++;
350 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800351 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700352 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700353 $sanitise_quote = '';
354 substr($res, $off, 2, "$;$;");
355 $off++;
356 next;
357 }
358
359 # A \ in a string means ignore the next character.
360 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
361 $c eq "\\") {
362 substr($res, $off, 2, 'XX');
363 $off++;
364 next;
365 }
366 # Regular quotes.
367 if ($c eq "'" || $c eq '"') {
368 if ($sanitise_quote eq '') {
369 $sanitise_quote = $c;
370
371 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700372 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700373 } elsif ($sanitise_quote eq $c) {
374 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700375 }
376 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700377
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800378 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700379 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
380 substr($res, $off, 1, $;);
381 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
382 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700383 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700384 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700385 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800386 }
387
388 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700389 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800390 my $clean = 'X' x length($1);
391 $res =~ s@\<.*\>@<$clean>@;
392
393 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700394 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800395 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700396 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800397 }
398
Andy Whitcroft00df3442007-06-08 13:47:06 -0700399 return $res;
400}
401
Andy Whitcroft8905a672007-11-28 16:21:06 -0800402sub ctx_statement_block {
403 my ($linenr, $remain, $off) = @_;
404 my $line = $linenr - 1;
405 my $blk = '';
406 my $soff = $off;
407 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700408 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800409
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800410 my $loff = 0;
411
Andy Whitcroft8905a672007-11-28 16:21:06 -0800412 my $type = '';
413 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800414 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800415 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800416 my $c;
417 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800418
419 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800420 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800421 @stack = (['', 0]) if ($#stack == -1);
422
Andy Whitcroft773647a2008-03-28 14:15:58 -0700423 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800424 # If we are about to drop off the end, pull in more
425 # context.
426 if ($off >= $len) {
427 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700428 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800429 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800430 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800431 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800432 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800433 $len = length($blk);
434 $line++;
435 last;
436 }
437 # Bail if there is no further context.
438 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800439 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800440 last;
441 }
442 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800443 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800444 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800445 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800446
Andy Whitcroft773647a2008-03-28 14:15:58 -0700447 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800448
449 # Handle nested #if/#else.
450 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
451 push(@stack, [ $type, $level ]);
452 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
453 ($type, $level) = @{$stack[$#stack - 1]};
454 } elsif ($remainder =~ /^#\s*endif\b/) {
455 ($type, $level) = @{pop(@stack)};
456 }
457
Andy Whitcroft8905a672007-11-28 16:21:06 -0800458 # Statement ends at the ';' or a close '}' at the
459 # outermost level.
460 if ($level == 0 && $c eq ';') {
461 last;
462 }
463
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800464 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700465 if ($level == 0 && $coff_set == 0 &&
466 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
467 $remainder =~ /^(else)(?:\s|{)/ &&
468 $remainder !~ /^else\s+if\b/) {
469 $coff = $off + length($1) - 1;
470 $coff_set = 1;
471 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
472 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800473 }
474
Andy Whitcroft8905a672007-11-28 16:21:06 -0800475 if (($type eq '' || $type eq '(') && $c eq '(') {
476 $level++;
477 $type = '(';
478 }
479 if ($type eq '(' && $c eq ')') {
480 $level--;
481 $type = ($level != 0)? '(' : '';
482
483 if ($level == 0 && $coff < $soff) {
484 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700485 $coff_set = 1;
486 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800487 }
488 }
489 if (($type eq '' || $type eq '{') && $c eq '{') {
490 $level++;
491 $type = '{';
492 }
493 if ($type eq '{' && $c eq '}') {
494 $level--;
495 $type = ($level != 0)? '{' : '';
496
497 if ($level == 0) {
498 last;
499 }
500 }
501 $off++;
502 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700503 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800504 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700505 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800506 $line++;
507 $remain--;
508 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800509
510 my $statement = substr($blk, $soff, $off - $soff + 1);
511 my $condition = substr($blk, $soff, $coff - $soff + 1);
512
513 #warn "STATEMENT<$statement>\n";
514 #warn "CONDITION<$condition>\n";
515
Andy Whitcroft773647a2008-03-28 14:15:58 -0700516 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800517
518 return ($statement, $condition,
519 $line, $remain + 1, $off - $loff + 1, $level);
520}
521
Andy Whitcroftcf655042008-03-04 14:28:20 -0800522sub statement_lines {
523 my ($stmt) = @_;
524
525 # Strip the diff line prefixes and rip blank lines at start and end.
526 $stmt =~ s/(^|\n)./$1/g;
527 $stmt =~ s/^\s*//;
528 $stmt =~ s/\s*$//;
529
530 my @stmt_lines = ($stmt =~ /\n/g);
531
532 return $#stmt_lines + 2;
533}
534
535sub statement_rawlines {
536 my ($stmt) = @_;
537
538 my @stmt_lines = ($stmt =~ /\n/g);
539
540 return $#stmt_lines + 2;
541}
542
543sub statement_block_size {
544 my ($stmt) = @_;
545
546 $stmt =~ s/(^|\n)./$1/g;
547 $stmt =~ s/^\s*{//;
548 $stmt =~ s/}\s*$//;
549 $stmt =~ s/^\s*//;
550 $stmt =~ s/\s*$//;
551
552 my @stmt_lines = ($stmt =~ /\n/g);
553 my @stmt_statements = ($stmt =~ /;/g);
554
555 my $stmt_lines = $#stmt_lines + 2;
556 my $stmt_statements = $#stmt_statements + 1;
557
558 if ($stmt_lines > $stmt_statements) {
559 return $stmt_lines;
560 } else {
561 return $stmt_statements;
562 }
563}
564
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800565sub ctx_statement_full {
566 my ($linenr, $remain, $off) = @_;
567 my ($statement, $condition, $level);
568
569 my (@chunks);
570
Andy Whitcroftcf655042008-03-04 14:28:20 -0800571 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800572 ($statement, $condition, $linenr, $remain, $off, $level) =
573 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700574 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800575 push(@chunks, [ $condition, $statement ]);
576 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
577 return ($level, $linenr, @chunks);
578 }
579
580 # Pull in the following conditional/block pairs and see if they
581 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800582 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800583 ($statement, $condition, $linenr, $remain, $off, $level) =
584 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800585 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700586 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800587 #print "C: push\n";
588 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800589 }
590
591 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800592}
593
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700594sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700595 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700596 my $line;
597 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700598 my $blk = '';
599 my @o;
600 my @c;
601 my @res = ();
602
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700603 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800604 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700605 for ($line = $start; $remain > 0; $line++) {
606 next if ($rawlines[$line] =~ /^-/);
607 $remain--;
608
609 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800610
611 # Handle nested #if/#else.
612 if ($rawlines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
613 push(@stack, $level);
614 } elsif ($rawlines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
615 $level = $stack[$#stack - 1];
616 } elsif ($rawlines[$line] =~ /^.\s*#\s*endif\b/) {
617 $level = pop(@stack);
618 }
619
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700620 foreach my $c (split(//, $rawlines[$line])) {
621 ##print "C<$c>L<$level><$open$close>O<$off>\n";
622 if ($off > 0) {
623 $off--;
624 next;
625 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700626
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700627 if ($c eq $close && $level > 0) {
628 $level--;
629 last if ($level == 0);
630 } elsif ($c eq $open) {
631 $level++;
632 }
633 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700634
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700635 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700636 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700637 }
638
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700639 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700640 }
641
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700642 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700643}
644sub ctx_block_outer {
645 my ($linenr, $remain) = @_;
646
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700647 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
648 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700649}
650sub ctx_block {
651 my ($linenr, $remain) = @_;
652
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700653 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
654 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700655}
656sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700657 my ($linenr, $remain, $off) = @_;
658
659 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
660 return @r;
661}
662sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700663 my ($linenr, $remain) = @_;
664
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700665 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700666}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700667sub ctx_statement_level {
668 my ($linenr, $remain, $off) = @_;
669
670 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
671}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700672
673sub ctx_locate_comment {
674 my ($first_line, $end_line) = @_;
675
676 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700677 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700678 return $current_comment if (defined $current_comment);
679
680 # Look through the context and try and figure out if there is a
681 # comment.
682 my $in_comment = 0;
683 $current_comment = '';
684 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700685 my $line = $rawlines[$linenr - 1];
686 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700687 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
688 $in_comment = 1;
689 }
690 if ($line =~ m@/\*@) {
691 $in_comment = 1;
692 }
693 if (!$in_comment && $current_comment ne '') {
694 $current_comment = '';
695 }
696 $current_comment .= $line . "\n" if ($in_comment);
697 if ($line =~ m@\*/@) {
698 $in_comment = 0;
699 }
700 }
701
702 chomp($current_comment);
703 return($current_comment);
704}
705sub ctx_has_comment {
706 my ($first_line, $end_line) = @_;
707 my $cmt = ctx_locate_comment($first_line, $end_line);
708
Andy Whitcroft00df3442007-06-08 13:47:06 -0700709 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700710 ##print "CMMT: $cmt\n";
711
712 return ($cmt ne '');
713}
714
Andy Whitcroft4d001e42008-10-15 22:02:21 -0700715sub raw_line {
716 my ($linenr, $cnt) = @_;
717
718 my $offset = $linenr - 1;
719 $cnt++;
720
721 my $line;
722 while ($cnt) {
723 $line = $rawlines[$offset++];
724 next if (defined($line) && $line =~ /^-/);
725 $cnt--;
726 }
727
728 return $line;
729}
730
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700731sub cat_vet {
732 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700733 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700734
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700735 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700736 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
737 $res .= $1;
738 if ($2 ne '') {
739 $coded = sprintf("^%c", unpack('C', $2) + 64);
740 $res .= $coded;
741 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700742 }
743 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700744
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700745 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700746}
747
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800748my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800749my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800750my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700751my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800752
753sub annotate_reset {
754 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800755 $av_pending = '_';
756 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700757 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800758}
759
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700760sub annotate_values {
761 my ($stream, $type) = @_;
762
763 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700764 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700765 my $cur = $stream;
766
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800767 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700768
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700769 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700770 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800771 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700772 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700773 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800774 print "WS($1)\n" if ($dbg_values > 1);
775 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800776 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800777 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700778 }
779
Andy Whitcroft8ea3eb92008-07-23 21:29:08 -0700780 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800781 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700782 $type = 'T';
783
Andy Whitcroft389a2fe2008-07-23 21:29:05 -0700784 } elsif ($cur =~ /^($Modifier)\s*/) {
785 print "MODIFIER($1)\n" if ($dbg_values > 1);
786 $type = 'T';
787
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700788 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700789 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800790 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700791 push(@av_paren_type, $type);
792 if ($2 ne '') {
793 $av_pending = 'N';
794 }
795 $type = 'E';
796
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700797 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700798 print "UNDEF($1)\n" if ($dbg_values > 1);
799 $av_preprocessor = 1;
800 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700801
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700802 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800803 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800804 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800805
806 push(@av_paren_type, $type);
807 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700808 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800809
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700810 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800811 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
812 $av_preprocessor = 1;
813
814 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
815
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700816 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800817
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700818 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800819 print "PRE_END($1)\n" if ($dbg_values > 1);
820
821 $av_preprocessor = 1;
822
823 # Assume all arms of the conditional end as this
824 # one does, and continue as if the #endif was not here.
825 pop(@av_paren_type);
826 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700827 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700828
829 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800830 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700831
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700832 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
833 print "ATTR($1)\n" if ($dbg_values > 1);
834 $av_pending = $type;
835 $type = 'N';
836
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700837 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800838 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700839 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800840 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700841 }
842 $type = 'N';
843
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700844 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800845 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700846 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700847 $type = 'N';
848
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700849 } elsif ($cur =~/^(case)/o) {
850 print "CASE($1)\n" if ($dbg_values > 1);
851 $av_pend_colon = 'C';
852 $type = 'N';
853
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700854 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800855 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700856 $type = 'N';
857
858 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800859 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800860 push(@av_paren_type, $av_pending);
861 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700862 $type = 'N';
863
864 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800865 my $new_type = pop(@av_paren_type);
866 if ($new_type ne '_') {
867 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800868 print "PAREN('$1') -> $type\n"
869 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700870 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800871 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700872 }
873
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700874 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800875 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700876 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800877 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700878
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800879 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
880 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700881 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800882 } elsif ($type eq 'E') {
883 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700884 }
885 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
886 $type = 'V';
887
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700888 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800889 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700890 $type = 'V';
891
892 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800893 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700894 $type = 'N';
895
Andy Whitcroftcf655042008-03-04 14:28:20 -0800896 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800897 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800898 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700899 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800900
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800901 } elsif ($cur =~/^(,)/) {
902 print "COMMA($1)\n" if ($dbg_values > 1);
903 $type = 'C';
904
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700905 } elsif ($cur =~ /^(\?)/o) {
906 print "QUESTION($1)\n" if ($dbg_values > 1);
907 $type = 'N';
908
909 } elsif ($cur =~ /^(:)/o) {
910 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
911
912 substr($var, length($res), 1, $av_pend_colon);
913 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
914 $type = 'E';
915 } else {
916 $type = 'N';
917 }
918 $av_pend_colon = 'O';
919
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800920 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800921 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700922 $type = 'N';
923
Andy Whitcroft0d413862008-10-15 22:02:16 -0700924 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -0700925 my $variant;
926
927 print "OPV($1)\n" if ($dbg_values > 1);
928 if ($type eq 'V') {
929 $variant = 'B';
930 } else {
931 $variant = 'U';
932 }
933
934 substr($var, length($res), 1, $variant);
935 $type = 'N';
936
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700937 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800938 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700939 if ($1 ne '++' && $1 ne '--') {
940 $type = 'N';
941 }
942
943 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800944 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700945 }
946 if (defined $1) {
947 $cur = substr($cur, length($1));
948 $res .= $type x length($1);
949 }
950 }
951
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700952 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700953}
954
Andy Whitcroft8905a672007-11-28 16:21:06 -0800955sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800956 my ($possible, $line) = @_;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800957
Andy Whitcroft0776e592008-10-15 22:02:29 -0700958 print "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
959 if ($possible !~ /(?:
960 ^(?:
961 $Modifier|
962 $Storage|
963 $Type|
964 DEFINE_\S+|
965 goto|
966 return|
967 case|
968 else|
969 asm|__asm__|
970 do
971 )$|
972 ^(?:typedef|struct|enum)\b
973 )/x) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700974 # Check for modifiers.
975 $possible =~ s/\s*$Storage\s*//g;
976 $possible =~ s/\s*$Sparse\s*//g;
977 if ($possible =~ /^\s*$/) {
978
979 } elsif ($possible =~ /\s/) {
980 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -0700981 for my $modifier (split(' ', $possible)) {
982 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
983 push(@modifierList, $modifier);
984 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700985
986 } else {
987 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
988 push(@typeList, $possible);
989 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800990 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -0700991 } else {
992 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800993 }
994}
995
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700996my $prefix = '';
997
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700998sub report {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700999 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
1000 return 0;
1001 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001002 my $line = $prefix . $_[0];
1003
1004 $line = (split('\n', $line))[0] . "\n" if ($terse);
1005
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001006 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001007
1008 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001009}
1010sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001011 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001012}
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001013sub ERROR {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001014 if (report("ERROR: $_[0]\n")) {
1015 our $clean = 0;
1016 our $cnt_error++;
1017 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001018}
1019sub WARN {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001020 if (report("WARNING: $_[0]\n")) {
1021 our $clean = 0;
1022 our $cnt_warn++;
1023 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001024}
1025sub CHK {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001026 if ($check && report("CHECK: $_[0]\n")) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001027 our $clean = 0;
1028 our $cnt_chk++;
1029 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001030}
1031
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001032sub check_absolute_file {
1033 my ($absolute, $herecurr) = @_;
1034 my $file = $absolute;
1035
1036 ##print "absolute<$absolute>\n";
1037
1038 # See if any suffix of this path is a path within the tree.
1039 while ($file =~ s@^[^/]*/@@) {
1040 if (-f "$root/$file") {
1041 ##print "file<$file>\n";
1042 last;
1043 }
1044 }
1045 if (! -f _) {
1046 return 0;
1047 }
1048
1049 # It is, so see if the prefix is acceptable.
1050 my $prefix = $absolute;
1051 substr($prefix, -length($file)) = '';
1052
1053 ##print "prefix<$prefix>\n";
1054 if ($prefix ne ".../") {
1055 WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr);
1056 }
1057}
1058
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001059sub process {
1060 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001061
1062 my $linenr=0;
1063 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001064 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001065 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001066 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001067
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001068 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001069 my $indent;
1070 my $previndent=0;
1071 my $stashindent=0;
1072
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001073 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001074 my $signoff = 0;
1075 my $is_patch = 0;
1076
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001077 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001078 our $cnt_lines = 0;
1079 our $cnt_error = 0;
1080 our $cnt_warn = 0;
1081 our $cnt_chk = 0;
1082
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001083 # Trace the real file/line as we go.
1084 my $realfile = '';
1085 my $realline = 0;
1086 my $realcnt = 0;
1087 my $here = '';
1088 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001089 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001090 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001091 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001092
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001093 my $prev_values = 'E';
1094
1095 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001096 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001097 my %suppress_whiletrailers;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001098
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001099 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001100 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001101 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001102 my @setup_docs = ();
1103 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001104
1105 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001106 my $line;
1107 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001108 $linenr++;
1109 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001110
Andy Whitcroft773647a2008-03-28 14:15:58 -07001111 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001112 $setup_docs = 0;
1113 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1114 $setup_docs = 1;
1115 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001116 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001117 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001118 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1119 $realline=$1-1;
1120 if (defined $2) {
1121 $realcnt=$3+1;
1122 } else {
1123 $realcnt=1+1;
1124 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001125 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001126
1127 # Guestimate if this is a continuing comment. Run
1128 # the context looking for a comment "edge". If this
1129 # edge is a close comment then we must be in a comment
1130 # at context start.
1131 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001132 my $cnt = $realcnt;
1133 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1134 next if (defined $rawlines[$ln - 1] &&
1135 $rawlines[$ln - 1] =~ /^-/);
1136 $cnt--;
1137 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001138 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001139 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1140 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1141 ($edge) = $1;
1142 last;
1143 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001144 }
1145 if (defined $edge && $edge eq '*/') {
1146 $in_comment = 1;
1147 }
1148
1149 # Guestimate if this is a continuing comment. If this
1150 # is the start of a diff block and this line starts
1151 # ' *' then it is very likely a comment.
1152 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001153 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001154 {
1155 $in_comment = 1;
1156 }
1157
1158 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1159 sanitise_line_reset($in_comment);
1160
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001161 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001162 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001163 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001164 $line = sanitise_line($rawline);
1165 }
1166 push(@lines, $line);
1167
1168 if ($realcnt > 1) {
1169 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1170 } else {
1171 $realcnt = 0;
1172 }
1173
1174 #print "==>$rawline\n";
1175 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001176
1177 if ($setup_docs && $line =~ /^\+/) {
1178 push(@setup_docs, $line);
1179 }
1180 }
1181
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001182 $prefix = '';
1183
Andy Whitcroft773647a2008-03-28 14:15:58 -07001184 $realcnt = 0;
1185 $linenr = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001186 foreach my $line (@lines) {
1187 $linenr++;
1188
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001189 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft306708542008-10-15 22:02:28 -07001190 my $hunk_line = ($realcnt != 0);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001191
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001192#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001193 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001194 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001195 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001196 $realline=$1-1;
1197 if (defined $2) {
1198 $realcnt=$3+1;
1199 } else {
1200 $realcnt=1+1;
1201 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001202 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001203 $prev_values = 'E';
1204
Andy Whitcroft773647a2008-03-28 14:15:58 -07001205 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001206 %suppress_whiletrailers = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001207 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001208
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001209# track the line number as we move through the hunk, note that
1210# new versions of GNU diff omit the leading space on completely
1211# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001212 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001213 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001214 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001215
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001216 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001217 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001218
1219 # Track the previous line.
1220 ($prevline, $stashline) = ($stashline, $line);
1221 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001222 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1223
Andy Whitcroft773647a2008-03-28 14:15:58 -07001224 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001225
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001226 } elsif ($realcnt == 1) {
1227 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001228 }
1229
1230#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001231 $prefix = "$filename:$realline: " if ($emacs && $file);
1232 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1233
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001234 $here = "#$linenr: " if (!$file);
1235 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001236
1237 # extract the filename as it passes
1238 if ($line=~/^\+\+\+\s+(\S+)/) {
1239 $realfile = $1;
Wolfram Sang1e855722009-01-06 14:41:24 -08001240 $realfile =~ s@^([^/]*)/@@;
1241
1242 $p1_prefix = $1;
1243 if ($tree && $p1_prefix ne '' && -e "$root/$p1_prefix") {
1244 WARN("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1245 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001246
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001247 if ($realfile =~ m@^include/asm/@) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001248 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1249 }
1250 next;
1251 }
1252
Randy Dunlap389834b2007-06-08 13:47:03 -07001253 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001254
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001255 my $hereline = "$here\n$rawline\n";
1256 my $herecurr = "$here\n$rawline\n";
1257 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001258
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001259 $cnt_lines++ if ($realcnt != 0);
1260
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001261#check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001262 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001263 # This is a signoff, if ugly, so do not double report.
1264 $signoff++;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001265 if (!($line =~ /^\s*Signed-off-by:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001266 WARN("Signed-off-by: is the preferred form\n" .
1267 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001268 }
1269 if ($line =~ /^\s*signed-off-by:\S/i) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001270 WARN("space required after Signed-off-by:\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001271 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001272 }
1273 }
1274
Andy Whitcroft00df3442007-06-08 13:47:06 -07001275# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001276 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001277 ERROR("patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001278 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001279 }
1280
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001281# Check for absolute kernel paths.
1282 if ($tree) {
1283 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1284 my $file = $1;
1285
1286 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1287 check_absolute_file($1, $herecurr)) {
1288 #
1289 } else {
1290 check_absolute_file($file, $herecurr);
1291 }
1292 }
1293 }
1294
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001295# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1296 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001297 $rawline !~ m/^$UTF8*$/) {
1298 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1299
1300 my $blank = copy_spacing($rawline);
1301 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1302 my $hereptr = "$hereline$ptr\n";
1303
1304 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001305 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001306
Andy Whitcroft306708542008-10-15 22:02:28 -07001307# ignore non-hunk lines and lines being removed
1308 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001309
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001310#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001311 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001312 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001313 ERROR("DOS line endings\n" . $herevet);
1314
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001315 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1316 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001317 ERROR("trailing whitespace\n" . $herevet);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001318 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07001319
1320# check we are in a valid source file if not then ignore this hunk
1321 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1322
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001323#80 column limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001324 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001325 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1326 $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1327 $length > 80)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001328 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001329 WARN("line over 80 characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001330 }
1331
Andy Whitcroft8905a672007-11-28 16:21:06 -08001332# check for adding lines without a newline.
1333 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1334 WARN("adding a line without newline at end of file\n" . $herecurr);
1335 }
1336
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001337# check we are in a valid source file C or perl if not then ignore this hunk
1338 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001339
1340# at the beginning of a line any tabs must come first and anything
1341# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001342 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1343 $rawline =~ /^\+\s* \s*/) {
1344 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001345 ERROR("code indent should use tabs where possible\n" . $herevet);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001346 }
1347
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001348# check we are in a valid C source file if not then ignore this hunk
1349 next if ($realfile !~ /\.(h|c)$/);
1350
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001351# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001352 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001353 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1354 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001355
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001356# Check for potential 'bare' types
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001357 my ($stat, $cond, $line_nr_next, $remain_next, $off_next);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001358 if ($realcnt && $line =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001359 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001360 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001361 $stat =~ s/\n./\n /g;
1362 $cond =~ s/\n./\n /g;
1363
1364 my $s = $stat;
1365 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001366
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001367 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001368 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001369
1370 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001371 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001372
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001373 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001374 } 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 -07001375 my $type = $1;
1376 $type =~ s/\s+/ /g;
1377 possible($type, "A:" . $s);
1378
Andy Whitcroft8905a672007-11-28 16:21:06 -08001379 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07001380 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001381 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001382 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001383
1384 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08001385 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001386 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001387 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001388
1389 # Check for any sort of function declaration.
1390 # int foo(something bar, other baz);
1391 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001392 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 -08001393 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001394
Andy Whitcroftcf655042008-03-04 14:28:20 -08001395 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001396 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001397 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001398
Andy Whitcroft8905a672007-11-28 16:21:06 -08001399 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001400 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001401
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001402 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001403 }
1404 }
1405 }
1406
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001407 }
1408
Andy Whitcroft653d4872007-06-23 17:16:34 -07001409#
1410# Checks which may be anchored in the context.
1411#
1412
1413# Check for switch () and associated case and default
1414# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07001415 if ($line=~/\bswitch\s*\(.*\)/) {
1416 my $err = '';
1417 my $sep = '';
1418 my @ctx = ctx_block_outer($linenr, $realcnt);
1419 shift(@ctx);
1420 for my $ctx (@ctx) {
1421 my ($clen, $cindent) = line_stats($ctx);
1422 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1423 $indent != $cindent) {
1424 $err .= "$sep$ctx\n";
1425 $sep = '';
1426 } else {
1427 $sep = "[...]\n";
1428 }
1429 }
1430 if ($err ne '') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001431 ERROR("switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001432 }
1433 }
1434
1435# if/while/etc brace do not go on next line, unless defining a do while loop,
1436# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001437 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001438 my $pre_ctx = "$1$2";
1439
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001440 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001441 my $ctx_cnt = $realcnt - $#ctx - 1;
1442 my $ctx = join("\n", @ctx);
1443
Andy Whitcroft548596d2008-07-23 21:29:01 -07001444 my $ctx_ln = $linenr;
1445 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001446
Andy Whitcroft548596d2008-07-23 21:29:01 -07001447 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1448 defined $lines[$ctx_ln - 1] &&
1449 $lines[$ctx_ln - 1] =~ /^-/)) {
1450 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1451 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001452 $ctx_ln++;
1453 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07001454
Andy Whitcroft53210162008-07-23 21:29:03 -07001455 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1456 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001457
1458 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1459 ERROR("that open brace { should be on the previous line\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001460 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07001461 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001462 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1463 $ctx =~ /\)\s*\;\s*$/ &&
1464 defined $lines[$ctx_ln - 1])
1465 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001466 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1467 if ($nindent > $indent) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001468 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001469 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001470 }
1471 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001472 }
1473
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001474# Check relative indent for conditionals and blocks.
1475 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1476 my ($s, $c) = ($stat, $cond);
1477
1478 substr($s, 0, length($c), '');
1479
1480 # Make sure we remove the line prefixes as we have
1481 # none on the first line, and are going to readd them
1482 # where necessary.
1483 $s =~ s/\n./\n/gs;
1484
1485 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07001486 my @newlines = ($c =~ /\n/gs);
1487 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001488
1489 # We want to check the first line inside the block
1490 # starting at the end of the conditional, so remove:
1491 # 1) any blank line termination
1492 # 2) any opening brace { on end of the line
1493 # 3) any do (...) {
1494 my $continuation = 0;
1495 my $check = 0;
1496 $s =~ s/^.*\bdo\b//;
1497 $s =~ s/^\s*{//;
1498 if ($s =~ s/^\s*\\//) {
1499 $continuation = 1;
1500 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001501 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001502 $check = 1;
1503 $cond_lines++;
1504 }
1505
1506 # Also ignore a loop construct at the end of a
1507 # preprocessor statement.
1508 if (($prevline =~ /^.\s*#\s*define\s/ ||
1509 $prevline =~ /\\\s*$/) && $continuation == 0) {
1510 $check = 0;
1511 }
1512
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001513 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07001514 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001515 while ($cond_ptr != $cond_lines) {
1516 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001517
Andy Whitcroftf16fa282008-10-15 22:02:32 -07001518 # If we see an #else/#elif then the code
1519 # is not linear.
1520 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1521 $check = 0;
1522 }
1523
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001524 # Ignore:
1525 # 1) blank lines, they should be at 0,
1526 # 2) preprocessor lines, and
1527 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07001528 if ($continuation ||
1529 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001530 $s =~ /^\s*#\s*?/ ||
1531 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07001532 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001533 $s =~ s/^.*?\n//;
1534 $cond_lines++;
1535 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001536 }
1537
1538 my (undef, $sindent) = line_stats("+" . $s);
1539 my $stat_real = raw_line($linenr, $cond_lines);
1540
1541 # Check if either of these lines are modified, else
1542 # this is not this patch's fault.
1543 if (!defined($stat_real) ||
1544 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1545 $check = 0;
1546 }
1547 if (defined($stat_real) && $cond_lines > 1) {
1548 $stat_real = "[...]\n$stat_real";
1549 }
1550
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001551 #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 -07001552
1553 if ($check && (($sindent % 8) != 0 ||
1554 ($sindent <= $indent && $s ne ''))) {
1555 WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1556 }
1557 }
1558
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001559 # Track the 'values' across context and added lines.
1560 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001561 my ($curr_values, $curr_vars) =
1562 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001563 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001564 if ($dbg_values) {
1565 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001566 print "$linenr > .$outline\n";
1567 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001568 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001569 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001570 $prev_values = substr($curr_values, -1);
1571
Andy Whitcroft00df3442007-06-08 13:47:06 -07001572#ignore lines not being added
1573 if ($line=~/^[^\+]/) {next;}
1574
Andy Whitcroft653d4872007-06-23 17:16:34 -07001575# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07001576 if ($dbg_type) {
1577 if ($line =~ /^.\s*$Declare\s*$/) {
1578 ERROR("TEST: is type\n" . $herecurr);
1579 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1580 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1581 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001582 next;
1583 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001584# TEST: allow direct testing of the attribute matcher.
1585 if ($dbg_attr) {
1586 if ($line =~ /^.\s*$Attribute\s*$/) {
1587 ERROR("TEST: is attr\n" . $herecurr);
1588 } elsif ($dbg_attr > 1 && $line =~ /^.+($Attribute)/) {
1589 ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1590 }
1591 next;
1592 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001593
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001594# check for initialisation to aggregates open brace on the next line
1595 if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1596 $line =~ /^.\s*{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001597 ERROR("that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001598 }
1599
Andy Whitcroft653d4872007-06-23 17:16:34 -07001600#
1601# Checks which are anchored on the added line.
1602#
1603
1604# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001605 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001606 my $path = $1;
1607 if ($path =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001608 ERROR("malformed #include filename\n" .
1609 $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001610 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001611 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001612
1613# no C99 // comments
1614 if ($line =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001615 ERROR("do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001616 }
1617 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001618 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001619 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001620
1621#EXPORT_SYMBOL should immediately follow its function closing }.
Andy Whitcroft653d4872007-06-23 17:16:34 -07001622 if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1623 ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1624 my $name = $1;
Andy Whitcroft48012052008-10-15 22:02:34 -07001625 if ($prevline !~ /(?:
1626 ^.}|
1627 ^.DEFINE_$Ident\(\Q$name\E\)|
1628 ^.DECLARE_$Ident\(\Q$name\E\)|
1629 ^.LIST_HEAD\(\Q$name\E\)|
1630 ^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
1631 \b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)
1632 )/x) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001633 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001634 }
1635 }
1636
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001637# check for external initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001638 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001639 ERROR("do not initialise externals to 0 or NULL\n" .
1640 $herecurr);
1641 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001642# check for static initialisers.
Andy Whitcroft2d1bafd72009-01-06 14:41:28 -08001643 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001644 ERROR("do not initialise statics to 0 or NULL\n" .
1645 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001646 }
1647
Andy Whitcroft653d4872007-06-23 17:16:34 -07001648# check for new typedefs, only function parameters and sparse annotations
1649# make sense.
1650 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08001651 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001652 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07001653 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001654 $line !~ /\b__bitwise(?:__|)\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001655 WARN("do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001656 }
1657
1658# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08001659 # (char*[ const])
1660 if ($line =~ m{\($NonptrType(\s*\*[\s\*]*(?:$Modifier\s*)*)\)}) {
1661 my ($from, $to) = ($1, $1);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001662
Andy Whitcroft65863862009-01-06 14:41:21 -08001663 # Should start with a space.
1664 $to =~ s/^(\S)/ $1/;
1665 # Should not end with a space.
1666 $to =~ s/\s+$//;
1667 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08001668 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001669 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001670
Andy Whitcroft65863862009-01-06 14:41:21 -08001671 #print "from<$from> to<$to>\n";
1672 if ($from ne $to) {
1673 ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
1674 }
1675 } elsif ($line =~ m{\b$NonptrType(\s*\*[\s\*]*(?:$Modifier\s*)?)($Ident)}) {
1676 my ($from, $to, $ident) = ($1, $1, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001677
Andy Whitcroft65863862009-01-06 14:41:21 -08001678 # Should start with a space.
1679 $to =~ s/^(\S)/ $1/;
1680 # Should not end with a space.
1681 $to =~ s/\s+$//;
1682 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08001683 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001684 }
1685 # Modifiers should have spaces.
1686 $to =~ s/(\b$Modifier$)/$1 /;
1687
1688 #print "from<$from> to<$to>\n";
1689 if ($from ne $to) {
1690 ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
1691 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001692 }
1693
1694# # no BUG() or BUG_ON()
1695# if ($line =~ /\b(BUG|BUG_ON)\b/) {
1696# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1697# print "$herecurr";
1698# $clean = 0;
1699# }
1700
Andy Whitcroft8905a672007-11-28 16:21:06 -08001701 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001702 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 -08001703 }
1704
Andy Whitcroft00df3442007-06-08 13:47:06 -07001705# printk should use KERN_* levels. Note that follow on printk's on the
1706# same line do not need a level, so we use the current block context
1707# to try and find and validate the current printk. In summary the current
1708# printk includes all preceeding printk's which have no newline on the end.
1709# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001710 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001711 my $ok = 0;
1712 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1713 #print "CHECK<$lines[$ln - 1]\n";
1714 # we have a preceeding printk if it ends
1715 # with "\n" ignore it, else it is to blame
1716 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1717 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1718 $ok = 1;
1719 }
1720 last;
1721 }
1722 }
1723 if ($ok == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001724 WARN("printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001725 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001726 }
1727
Andy Whitcroft653d4872007-06-23 17:16:34 -07001728# function brace can't be on same line, except for #defines of do while,
1729# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001730 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1731 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001732 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001733 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001734
Andy Whitcroft8905a672007-11-28 16:21:06 -08001735# open braces for enum, union and struct go on the same line.
1736 if ($line =~ /^.\s*{/ &&
1737 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1738 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1739 }
1740
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001741# check for spacing round square brackets; allowed:
1742# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001743# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1744# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001745 while ($line =~ /(.*?\s)\[/g) {
1746 my ($where, $prefix) = ($-[1], $1);
1747 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001748 ($where != 0 || $prefix !~ /^.\s+$/) &&
1749 $prefix !~ /{\s+$/) {
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001750 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1751 }
1752 }
1753
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001754# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001755 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001756 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001757 my $ctx_before = substr($line, 0, $-[1]);
1758 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001759
1760 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001761 if ($name =~ /^(?:
1762 if|for|while|switch|return|case|
1763 volatile|__volatile__|
1764 __attribute__|format|__extension__|
1765 asm|__asm__)$/x)
1766 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001767
1768 # cpp #define statements have non-optional spaces, ie
1769 # if there is a space between the name and the open
1770 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001771 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001772
1773 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001774 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001775
1776 # If this whole things ends with a type its most
1777 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001778 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001779
1780 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001781 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001782 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001783 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001784# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001785 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001786 my $ops = qr{
1787 <<=|>>=|<=|>=|==|!=|
1788 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1789 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001790 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1791 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001792 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001793 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001794 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001795
1796 my $blank = copy_spacing($opline);
1797
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001798 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001799 $off += length($elements[$n]);
1800
Andy Whitcroft773647a2008-03-28 14:15:58 -07001801 # Pick up the preceeding and succeeding characters.
1802 my $ca = substr($opline, 0, $off);
1803 my $cc = '';
1804 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1805 $cc = substr($opline, $off + length($elements[$n + 1]));
1806 }
1807 my $cb = "$ca$;$cc";
1808
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001809 my $a = '';
1810 $a = 'V' if ($elements[$n] ne '');
1811 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001812 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001813 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1814 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07001815 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001816
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001817 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001818
1819 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001820 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001821 $c = 'V' if ($elements[$n + 2] ne '');
1822 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001823 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001824 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1825 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08001826 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001827 } else {
1828 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001829 }
1830
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001831 my $ctx = "${a}x${c}";
1832
1833 my $at = "(ctx:$ctx)";
1834
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001835 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001836 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001837
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001838 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001839 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001840
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001841 # Get the full operator variant.
1842 my $opv = $op . substr($curr_vars, $off, 1);
1843
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001844 # Ignore operators passed as parameters.
1845 if ($op_type ne 'V' &&
1846 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1847
Andy Whitcroftcf655042008-03-04 14:28:20 -08001848# # Ignore comments
1849# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001850
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001851 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001852 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001853 if ($ctx !~ /.x[WEBC]/ &&
1854 $cc !~ /^\\/ && $cc !~ /^;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001855 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001856 }
1857
1858 # // is a comment
1859 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001860
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001861 # No spaces for:
1862 # ->
1863 # : when part of a bitfield
1864 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001865 if ($ctx =~ /Wx.|.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001866 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001867 }
1868
1869 # , must have a space on the right.
1870 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001871 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001872 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001873 }
1874
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001875 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001876 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001877 #warn "'*' is part of type\n";
1878
1879 # unary operators should have a space before and
1880 # none after. May be left adjacent to another
1881 # unary operator, or a cast
1882 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001883 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07001884 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001885 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001886 ERROR("space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001887 }
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001888 if ($op eq '*' && $cc =~/\s*const\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001889 # A unary '*' may be const
1890
1891 } elsif ($ctx =~ /.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001892 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001893 }
1894
1895 # unary ++ and unary -- are allowed no space on one side.
1896 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001897 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1898 ERROR("space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001899 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001900 if ($ctx =~ /Wx[BE]/ ||
1901 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1902 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001903 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001904 if ($ctx =~ /ExW/) {
1905 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1906 }
1907
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001908
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001909 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001910 } elsif ($op eq '<<' or $op eq '>>' or
1911 $op eq '&' or $op eq '^' or $op eq '|' or
1912 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001913 $op eq '*' or $op eq '/' or
1914 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001915 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001916 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001917 ERROR("need consistent spacing around '$op' $at\n" .
1918 $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001919 }
1920
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001921 # A colon needs no spaces before when it is
1922 # terminating a case value or a label.
1923 } elsif ($opv eq ':C' || $opv eq ':L') {
1924 if ($ctx =~ /Wx./) {
1925 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1926 }
1927
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001928 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08001929 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001930 my $ok = 0;
1931
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001932 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001933 if (($op eq '<' &&
1934 $cc =~ /^\S+\@\S+>/) ||
1935 ($op eq '>' &&
1936 $ca =~ /<\S+\@\S+$/))
1937 {
1938 $ok = 1;
1939 }
1940
1941 # Ignore ?:
1942 if (($opv eq ':O' && $ca =~ /\?$/) ||
1943 ($op eq '?' && $cc =~ /^:/)) {
1944 $ok = 1;
1945 }
1946
1947 if ($ok == 0) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001948 ERROR("spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001949 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001950 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001951 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001952 }
1953 }
1954
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001955# check for multiple assignments
1956 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001957 CHK("multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001958 }
1959
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001960## # check for multiple declarations, allowing for a function declaration
1961## # continuation.
1962## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
1963## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
1964##
1965## # Remove any bracketed sections to ensure we do not
1966## # falsly report the parameters of functions.
1967## my $ln = $line;
1968## while ($ln =~ s/\([^\(\)]*\)//g) {
1969## }
1970## if ($ln =~ /,/) {
1971## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
1972## }
1973## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001974
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001975#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001976 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
1977 $line =~ /do{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001978 ERROR("space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001979 }
1980
1981# closing brace should have a space following it when it has anything
1982# on the line
1983 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001984 ERROR("space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001985 }
1986
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001987# check spacing on square brackets
1988 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001989 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001990 }
1991 if ($line =~ /\s\]/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001992 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001993 }
1994
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001995# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001996 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
1997 $line !~ /for\s*\(\s+;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001998 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001999 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002000 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002001 $line !~ /for\s*\(.*;\s+\)/ &&
2002 $line !~ /:\s+\)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002003 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002004 }
2005
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002006#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002007 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002008 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002009 WARN("labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002010 }
2011
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002012# Return is not a function.
2013 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2014 my $spacing = $1;
2015 my $value = $2;
2016
Andy Whitcroft86f9d052009-01-06 14:41:24 -08002017 # Flatten any parentheses
Andy Whitcroftfee61c42008-07-23 21:28:56 -07002018 $value =~ s/\)\(/\) \(/g;
Andy Whitcroft63f17f82009-01-15 13:51:06 -08002019 while ($value =~ s/\[[^\{\}]*\]/1/ ||
2020 $value !~ /(?:$Ident|-?$Constant)\s*
2021 $Compare\s*
2022 (?:$Ident|-?$Constant)/x &&
2023 $value =~ s/\([^\(\)]*\)/1/) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002024 }
2025
2026 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
2027 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
2028
2029 } elsif ($spacing !~ /\s+/) {
2030 ERROR("space required before the open parenthesis '('\n" . $herecurr);
2031 }
2032 }
2033
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002034# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002035 if ($line=~/\b(if|while|for|switch)\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002036 ERROR("space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002037 }
2038
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002039# Check for illegal assignment in if conditional -- and check for trailing
2040# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002041 if ($line =~ /do\s*(?!{)/) {
2042 my ($stat_next) = ctx_statement_block($line_nr_next,
2043 $remain_next, $off_next);
2044 $stat_next =~ s/\n./\n /g;
2045 ##print "stat<$stat> stat_next<$stat_next>\n";
2046
2047 if ($stat_next =~ /^\s*while\b/) {
2048 # If the statement carries leading newlines,
2049 # then count those as offsets.
2050 my ($whitespace) =
2051 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2052 my $offset =
2053 statement_rawlines($whitespace) - 1;
2054
2055 $suppress_whiletrailers{$line_nr_next +
2056 $offset} = 1;
2057 }
2058 }
2059 if (!defined $suppress_whiletrailers{$linenr} &&
2060 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002061 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002062
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08002063 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002064 ERROR("do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002065 }
2066
2067 # Find out what is on the end of the line after the
2068 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002069 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002070 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002071 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07002072 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2073 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002074 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002075 # Find out how long the conditional actually is.
2076 my @newlines = ($c =~ /\n/gs);
2077 my $cond_lines = 1 + $#newlines;
2078
2079 my $stat_real = raw_line($linenr, $cond_lines);
2080 if (defined($stat_real) && $cond_lines > 1) {
2081 $stat_real = "[...]\n$stat_real";
2082 }
2083
2084 ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002085 }
2086 }
2087
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002088# Check for bitwise tests written as boolean
2089 if ($line =~ /
2090 (?:
2091 (?:\[|\(|\&\&|\|\|)
2092 \s*0[xX][0-9]+\s*
2093 (?:\&\&|\|\|)
2094 |
2095 (?:\&\&|\|\|)
2096 \s*0[xX][0-9]+\s*
2097 (?:\&\&|\|\||\)|\])
2098 )/x)
2099 {
2100 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2101 }
2102
Andy Whitcroft8905a672007-11-28 16:21:06 -08002103# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002104 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2105 my $s = $1;
2106 $s =~ s/$;//g; # Remove any comments
2107 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2108 ERROR("trailing statements should be on next line\n" . $herecurr);
2109 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002110 }
Andy Whitcroft39667782009-01-15 13:51:06 -08002111# if should not continue a brace
2112 if ($line =~ /}\s*if\b/) {
2113 ERROR("trailing statements should be on next line\n" .
2114 $herecurr);
2115 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002116# case and default should not have general statements after them
2117 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2118 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07002119 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002120 \s*return\s+
2121 )/xg)
2122 {
2123 ERROR("trailing statements should be on next line\n" . $herecurr);
2124 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002125
2126 # Check for }<nl>else {, these must be at the same
2127 # indent level to be relevant to each other.
2128 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2129 $previndent == $indent) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002130 ERROR("else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002131 }
2132
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002133 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2134 $previndent == $indent) {
2135 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2136
2137 # Find out what is on the end of the line after the
2138 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002139 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002140 $s =~ s/\n.*//g;
2141
2142 if ($s =~ /^\s*;/) {
2143 ERROR("while should follow close brace '}'\n" . $hereprev);
2144 }
2145 }
2146
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002147#studly caps, commented out until figure out how to distinguish between use of existing and adding new
2148# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2149# print "No studly caps, use _\n";
2150# print "$herecurr";
2151# $clean = 0;
2152# }
2153
2154#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002155 if ($line=~/\#\s*define.*\\\s$/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002156 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002157 }
2158
Andy Whitcroft653d4872007-06-23 17:16:34 -07002159#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002160 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002161 my $file = "$1.h";
2162 my $checkfile = "include/linux/$file";
2163 if (-f "$root/$checkfile" &&
2164 $realfile ne $checkfile &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002165 $1 ne 'irq')
2166 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002167 if ($realfile =~ m{^arch/}) {
2168 CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2169 } else {
2170 WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2171 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002172 }
2173 }
2174
Andy Whitcroft653d4872007-06-23 17:16:34 -07002175# multi-statement macros should be enclosed in a do while loop, grab the
2176# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08002177# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07002178 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2179 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002180 my $ln = $linenr;
2181 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002182 my ($off, $dstat, $dcond, $rest);
2183 my $ctx = '';
Andy Whitcroft653d4872007-06-23 17:16:34 -07002184
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002185 my $args = defined($1);
2186
2187 # Find the end of the macro and limit our statement
2188 # search to that.
2189 while ($cnt > 0 && defined $lines[$ln - 1] &&
2190 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2191 {
2192 $ctx .= $rawlines[$ln - 1] . "\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002193 $cnt-- if ($lines[$ln - 1] !~ /^-/);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002194 $ln++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002195 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002196 $ctx .= $rawlines[$ln - 1];
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002197
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002198 ($dstat, $dcond, $ln, $cnt, $off) =
2199 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2200 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002201 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002202
2203 # Extract the remainder of the define (if any) and
2204 # rip off surrounding spaces, and trailing \'s.
2205 $rest = '';
Andy Whitcroft636d1402008-10-15 22:02:18 -07002206 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2207 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002208 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2209 $rest .= substr($lines[$ln - 1], $off) . "\n";
2210 $cnt--;
2211 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002212 $ln++;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002213 $off = 0;
2214 }
2215 $rest =~ s/\\\n.//g;
2216 $rest =~ s/^\s*//s;
2217 $rest =~ s/\s*$//s;
2218
2219 # Clean up the original statement.
2220 if ($args) {
2221 substr($dstat, 0, length($dcond), '');
2222 } else {
2223 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2224 }
Andy Whitcroft292f1a92008-07-23 21:29:11 -07002225 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002226 $dstat =~ s/\\\n.//g;
2227 $dstat =~ s/^\s*//s;
2228 $dstat =~ s/\s*$//s;
2229
2230 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07002231 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2232 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2233 $dstat =~ s/\[[^\{\}]*\]/1/)
2234 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002235 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002236
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002237 my $exceptions = qr{
2238 $Declare|
2239 module_param_named|
2240 MODULE_PARAM_DESC|
2241 DECLARE_PER_CPU|
2242 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08002243 __typeof__\(|
2244 \.$Ident\s*=\s*
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002245 }x;
Andy Whitcroft383099f2009-01-06 14:41:18 -08002246 #print "REST<$rest> dstat<$dstat>\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002247 if ($rest ne '') {
2248 if ($rest !~ /while\s*\(/ &&
2249 $dstat !~ /$exceptions/)
2250 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002251 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 -07002252 }
2253
2254 } elsif ($ctx !~ /;/) {
2255 if ($dstat ne '' &&
2256 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2257 $dstat !~ /$exceptions/ &&
Andy Whitcroftb132e5d2008-10-15 22:02:31 -07002258 $dstat !~ /^\.$Ident\s*=/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002259 $dstat =~ /$Operators/)
2260 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002261 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002262 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002263 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002264 }
2265
Mike Frysinger080ba922009-01-06 14:41:25 -08002266# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
2267# all assignments may have only one of the following with an assignment:
2268# .
2269# ALIGN(...)
2270# VMLINUX_SYMBOL(...)
2271 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
2272 WARN("vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
2273 }
2274
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002275# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002276 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2277 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08002278 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002279 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002280 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2281 if ($#chunks > 0 && $level == 0) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002282 my $allowed = 0;
2283 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002284 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002285 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002286 for my $chunk (@chunks) {
2287 my ($cond, $block) = @{$chunk};
2288
Andy Whitcroft773647a2008-03-28 14:15:58 -07002289 # If the condition carries leading newlines, then count those as offsets.
2290 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2291 my $offset = statement_rawlines($whitespace) - 1;
2292
2293 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2294
2295 # We have looked at and allowed this specific line.
2296 $suppress_ifbraces{$ln + $offset} = 1;
2297
2298 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002299 $ln += statement_rawlines($block) - 1;
2300
Andy Whitcroft773647a2008-03-28 14:15:58 -07002301 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002302
2303 $seen++ if ($block =~ /^\s*{/);
2304
Andy Whitcroftcf655042008-03-04 14:28:20 -08002305 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2306 if (statement_lines($cond) > 1) {
2307 #print "APW: ALLOWED: cond<$cond>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002308 $allowed = 1;
2309 }
2310 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002311 #print "APW: ALLOWED: block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002312 $allowed = 1;
2313 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002314 if (statement_block_size($block) > 1) {
2315 #print "APW: ALLOWED: lines block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002316 $allowed = 1;
2317 }
2318 }
2319 if ($seen && !$allowed) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002320 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002321 }
2322 }
2323 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002324 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002325 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002326 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002327
Andy Whitcroftcf655042008-03-04 14:28:20 -08002328 # Check the pre-context.
2329 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2330 #print "APW: ALLOWED: pre<$1>\n";
2331 $allowed = 1;
2332 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002333
2334 my ($level, $endln, @chunks) =
2335 ctx_statement_full($linenr, $realcnt, $-[0]);
2336
Andy Whitcroftcf655042008-03-04 14:28:20 -08002337 # Check the condition.
2338 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07002339 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002340 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002341 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08002342 }
2343 if (statement_lines($cond) > 1) {
2344 #print "APW: ALLOWED: cond<$cond>\n";
2345 $allowed = 1;
2346 }
2347 if ($block =~/\b(?:if|for|while)\b/) {
2348 #print "APW: ALLOWED: block<$block>\n";
2349 $allowed = 1;
2350 }
2351 if (statement_block_size($block) > 1) {
2352 #print "APW: ALLOWED: lines block<$block>\n";
2353 $allowed = 1;
2354 }
2355 # Check the post-context.
2356 if (defined $chunks[1]) {
2357 my ($cond, $block) = @{$chunks[1]};
2358 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002359 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002360 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002361 if ($block =~ /^\s*\{/) {
2362 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2363 $allowed = 1;
2364 }
2365 }
2366 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2367 my $herectx = $here . "\n";;
Andy Whitcroftf0556632008-10-15 22:02:23 -07002368 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002369
Andy Whitcroftf0556632008-10-15 22:02:23 -07002370 for (my $n = 0; $n < $cnt; $n++) {
2371 $herectx .= raw_line($linenr, $n) . "\n";;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002372 }
2373
2374 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002375 }
2376 }
2377
Andy Whitcroft653d4872007-06-23 17:16:34 -07002378# don't include deprecated include files (uses RAW line)
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002379 for my $inc (@dep_includes) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002380 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002381 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002382 }
2383 }
2384
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002385# don't use deprecated functions
2386 for my $func (@dep_functions) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002387 if ($line =~ /\b$func\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002388 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002389 }
2390 }
2391
2392# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002393 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2394 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002395 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002396 }
2397
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002398# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2399 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2400 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2401 }
2402
Andy Whitcroft00df3442007-06-08 13:47:06 -07002403# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002404 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002405 CHK("if this code is redundant consider removing it\n" .
2406 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002407 }
2408
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002409# check for needless kfree() checks
2410 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2411 my $expr = $1;
2412 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
Wolfram Sang3c232142008-07-23 21:29:05 -07002413 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002414 }
2415 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07002416# check for needless usb_free_urb() checks
2417 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2418 my $expr = $1;
2419 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2420 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2421 }
2422 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002423
Andy Whitcroft00df3442007-06-08 13:47:06 -07002424# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002425# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002426# print "#ifdef in C files should be avoided\n";
2427# print "$herecurr";
2428# $clean = 0;
2429# }
2430
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002431# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002432 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002433 ERROR("exactly one space required after that #$1\n" . $herecurr);
2434 }
2435
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002436# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002437 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2438 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002439 my $which = $1;
2440 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002441 CHK("$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002442 }
2443 }
2444# check for memory barriers without a comment.
2445 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2446 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002447 CHK("memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002448 }
2449 }
2450# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002451 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002452 CHK("architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002453 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002454
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002455# check the location of the inline attribute, that it is between
2456# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002457 if ($line =~ /\b$Type\s+$Inline\b/ ||
2458 $line =~ /\b$Inline\s+$Storage\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002459 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2460 }
2461
Andy Whitcroft8905a672007-11-28 16:21:06 -08002462# Check for __inline__ and __inline, prefer inline
2463 if ($line =~ /\b(__inline__|__inline)\b/) {
2464 WARN("plain inline is preferred over $1\n" . $herecurr);
2465 }
2466
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002467# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002468 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002469 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002470 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002471 my $function_name = $1;
2472 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002473
2474 my $s = $stat;
2475 if (defined $cond) {
2476 substr($s, 0, length($cond), '');
2477 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002478 if ($s =~ /^\s*;/ &&
2479 $function_name ne 'uninitialized_var')
2480 {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002481 WARN("externs should be avoided in .c files\n" . $herecurr);
2482 }
2483
2484 if ($paren_space =~ /\n/) {
2485 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2486 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002487
2488 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2489 $stat =~ /^.\s*extern\s+/)
2490 {
2491 WARN("externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002492 }
2493
2494# checks for new __setup's
2495 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2496 my $name = $1;
2497
2498 if (!grep(/$name/, @setup_docs)) {
2499 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2500 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002501 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002502
2503# check for pointless casting of kmalloc return
2504 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2505 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2506 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002507
2508# check for gcc specific __FUNCTION__
2509 if ($line =~ /__FUNCTION__/) {
2510 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2511 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002512
2513# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002514 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002515 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2516 }
2517# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002518 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002519 WARN("consider using a completion\n" . $herecurr);
2520 }
2521# recommend strict_strto* over simple_strto*
2522 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2523 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2524 }
Michael Ellermanf3db6632008-07-23 21:28:57 -07002525# check for __initcall(), use device_initcall() explicitly please
2526 if ($line =~ /^.\s*__initcall\s*\(/) {
2527 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2528 }
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08002529# check for struct file_operations, ensure they are const.
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08002530 if ($line !~ /\bconst\b/ &&
2531 $line =~ /\bstruct\s+(file_operations|seq_operations)\b/) {
2532 WARN("struct $1 should normally be const\n" .
2533 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08002534 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002535
2536# use of NR_CPUS is usually wrong
2537# ignore definitions of NR_CPUS and usage to define arrays as likely right
2538 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002539 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2540 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002541 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2542 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2543 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002544 {
2545 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2546 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002547
2548# check for %L{u,d,i} in strings
2549 my $string;
2550 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2551 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07002552 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002553 if ($string =~ /(?<!%)%L[udi]/) {
2554 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2555 last;
2556 }
2557 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08002558
2559# whine mightly about in_atomic
2560 if ($line =~ /\bin_atomic\s*\(/) {
2561 if ($realfile =~ m@^drivers/@) {
2562 ERROR("do not use in_atomic in drivers\n" . $herecurr);
2563 } else {
2564 WARN("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
2565 }
2566 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002567 }
2568
2569 # If we have no input at all, then there is nothing to report on
2570 # so just keep quiet.
2571 if ($#rawlines == -1) {
2572 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002573 }
2574
Andy Whitcroft8905a672007-11-28 16:21:06 -08002575 # In mailback mode only produce a report in the negative, for
2576 # things that appear to be patches.
2577 if ($mailback && ($clean == 1 || !$is_patch)) {
2578 exit(0);
2579 }
2580
2581 # This is not a patch, and we are are in 'no-patch' mode so
2582 # just keep quiet.
2583 if (!$chk_patch && !$is_patch) {
2584 exit(0);
2585 }
2586
2587 if (!$is_patch) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002588 ERROR("Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002589 }
2590 if ($is_patch && $chk_signoff && $signoff == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002591 ERROR("Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002592 }
2593
Andy Whitcroft8905a672007-11-28 16:21:06 -08002594 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002595 if ($summary && !($clean == 1 && $quiet == 1)) {
2596 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002597 print "total: $cnt_error errors, $cnt_warn warnings, " .
2598 (($check)? "$cnt_chk checks, " : "") .
2599 "$cnt_lines lines checked\n";
2600 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002601 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002602
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002603 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002604 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002605 }
2606 if ($clean == 0 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002607 print "$vname has style problems, please review. If any of these errors\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002608 print "are false positives report them to the maintainer, see\n";
2609 print "CHECKPATCH in MAINTAINERS.\n";
2610 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002611
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002612 return $clean;
2613}