blob: 2e513fdf3043eeed2fc37372c2d8c2cc0db06a32 [file] [log] [blame]
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001#!/usr/bin/perl -w
2# (c) 2001, Dave Jones. <davej@codemonkey.org.uk> (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004# (c) 2007, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite, etc)
5# Licensed under the terms of the GNU GPL License version 2
6
7use strict;
8
9my $P = $0;
Andy Whitcroft00df3442007-06-08 13:47:06 -070010$P =~ s@.*/@@g;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070011
Andy Whitcroftdea79cd2008-10-15 22:02:24 -070012my $V = '0.22';
Andy Whitcroft0a920b52007-06-01 00:46:48 -070013
14use Getopt::Long qw(:config no_auto_abbrev);
15
16my $quiet = 0;
17my $tree = 1;
18my $chk_signoff = 1;
19my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070020my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070021my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080022my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070023my $file = 0;
24my $check = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080025my $summary = 1;
26my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080027my $summary_file = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070028my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080029my %debug;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070030GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070031 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-06-01 00:46:48 -070032 'tree!' => \$tree,
33 'signoff!' => \$chk_signoff,
34 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070035 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -080036 'terse!' => \$terse,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070037 'file!' => \$file,
38 'subjective!' => \$check,
39 'strict!' => \$check,
40 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -080041 'summary!' => \$summary,
42 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -080043 'summary-file!' => \$summary_file,
44
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080045 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -070046 'test-only=s' => \$tst_only,
Andy Whitcroft0a920b52007-06-01 00:46:48 -070047) or exit;
48
49my $exit = 0;
50
51if ($#ARGV < 0) {
Andy Whitcroft00df3442007-06-08 13:47:06 -070052 print "usage: $P [options] patchfile\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -070053 print "version: $V\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -080054 print "options: -q => quiet\n";
55 print " --no-tree => run without a kernel tree\n";
56 print " --terse => one line per report\n";
57 print " --emacs => emacs compile window format\n";
58 print " --file => check a source file\n";
59 print " --strict => enable more subjective tests\n";
60 print " --root => path to the kernel tree root\n";
61 print " --no-summary => suppress the per-file summary\n";
62 print " --summary-file => include the filename in summary\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -070063 exit(1);
64}
65
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080066my $dbg_values = 0;
67my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -070068my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -070069my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080070for my $key (keys %debug) {
71 eval "\${dbg_$key} = '$debug{$key}';"
72}
73
Andy Whitcroft8905a672007-11-28 16:21:06 -080074if ($terse) {
75 $emacs = 1;
76 $quiet++;
77}
78
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070079if ($tree) {
80 if (defined $root) {
81 if (!top_of_kernel_tree($root)) {
82 die "$P: $root: --root does not point at a valid tree\n";
83 }
84 } else {
85 if (top_of_kernel_tree('.')) {
86 $root = '.';
87 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
88 top_of_kernel_tree($1)) {
89 $root = $1;
90 }
91 }
92
93 if (!defined $root) {
94 print "Must be run from the top-level dir. of a kernel tree\n";
95 exit(2);
96 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -070097}
98
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070099my $emitted_corrupt = 0;
100
101our $Ident = qr{[A-Za-z_][A-Za-z\d_]*};
102our $Storage = qr{extern|static|asmlinkage};
103our $Sparse = qr{
104 __user|
105 __kernel|
106 __force|
107 __iomem|
108 __must_check|
109 __init_refok|
Andy Whitcroftcf655042008-03-04 14:28:20 -0800110 __kprobes
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700111 }x;
112our $Attribute = qr{
113 const|
114 __read_mostly|
115 __kprobes|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700116 __(?:mem|cpu|dev|)(?:initdata|init)|
117 ____cacheline_aligned|
118 ____cacheline_aligned_in_smp|
119 ____cacheline_internodealigned_in_smp
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700120 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700121our $Modifier;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700122our $Inline = qr{inline|__always_inline|noinline};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700123our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
124our $Lval = qr{$Ident(?:$Member)*};
125
126our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
127our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
128our $Operators = qr{
129 <=|>=|==|!=|
130 =>|->|<<|>>|<|>|!|~|
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800131 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700132 }x;
133
Andy Whitcroft8905a672007-11-28 16:21:06 -0800134our $NonptrType;
135our $Type;
136our $Declare;
137
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700138our $UTF8 = qr {
139 [\x09\x0A\x0D\x20-\x7E] # ASCII
140 | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
141 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
142 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
143 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
144 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
145 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
146 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
147}x;
148
Andy Whitcroft8905a672007-11-28 16:21:06 -0800149our @typeList = (
150 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700151 qr{(?:unsigned\s+)?char},
152 qr{(?:unsigned\s+)?short},
153 qr{(?:unsigned\s+)?int},
154 qr{(?:unsigned\s+)?long},
155 qr{(?:unsigned\s+)?long\s+int},
156 qr{(?:unsigned\s+)?long\s+long},
157 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800158 qr{unsigned},
159 qr{float},
160 qr{double},
161 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800162 qr{(?:__)?(?:u|s|be|le)(?:8|16|32|64)},
163 qr{struct\s+$Ident},
164 qr{union\s+$Ident},
165 qr{enum\s+$Ident},
166 qr{${Ident}_t},
167 qr{${Ident}_handler},
168 qr{${Ident}_handler_fn},
169);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700170our @modifierList = (
171 qr{fastcall},
172);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800173
174sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700175 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
176 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700177 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800178 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700179 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800180 (?:
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700181 (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
182 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800183 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700184 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800185 }x;
186 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700187 $NonptrType
Andy Whitcroft8905a672007-11-28 16:21:06 -0800188 (?:\s*\*+\s*const|\s*\*+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700189 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800190 }x;
191 $Declare = qr{(?:$Storage\s+)?$Type};
192}
193build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700194
195$chk_signoff = 0 if ($file);
196
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700197my @dep_includes = ();
198my @dep_functions = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700199my $removal = "Documentation/feature-removal-schedule.txt";
200if ($tree && -f "$root/$removal") {
201 open(REMOVE, "<$root/$removal") ||
202 die "$P: $removal: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700203 while (<REMOVE>) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700204 if (/^Check:\s+(.*\S)/) {
205 for my $entry (split(/[, ]+/, $1)) {
206 if ($entry =~ m@include/(.*)@) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700207 push(@dep_includes, $1);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700208
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700209 } elsif ($entry !~ m@/@) {
210 push(@dep_functions, $entry);
211 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700212 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700213 }
214 }
215}
216
Andy Whitcroft00df3442007-06-08 13:47:06 -0700217my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800218my @lines = ();
219my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700220for my $filename (@ARGV) {
221 if ($file) {
222 open(FILE, "diff -u /dev/null $filename|") ||
223 die "$P: $filename: diff failed - $!\n";
224 } else {
225 open(FILE, "<$filename") ||
226 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700227 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800228 if ($filename eq '-') {
229 $vname = 'Your patch';
230 } else {
231 $vname = $filename;
232 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700233 while (<FILE>) {
234 chomp;
235 push(@rawlines, $_);
236 }
237 close(FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800238 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700239 $exit = 1;
240 }
241 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800242 @lines = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700243}
244
245exit($exit);
246
247sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700248 my ($root) = @_;
249
250 my @tree_check = (
251 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
252 "README", "Documentation", "arch", "include", "drivers",
253 "fs", "init", "ipc", "kernel", "lib", "scripts",
254 );
255
256 foreach my $check (@tree_check) {
257 if (! -e $root . '/' . $check) {
258 return 0;
259 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700260 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700261 return 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700262}
263
264sub expand_tabs {
265 my ($str) = @_;
266
267 my $res = '';
268 my $n = 0;
269 for my $c (split(//, $str)) {
270 if ($c eq "\t") {
271 $res .= ' ';
272 $n++;
273 for (; ($n % 8) != 0; $n++) {
274 $res .= ' ';
275 }
276 next;
277 }
278 $res .= $c;
279 $n++;
280 }
281
282 return $res;
283}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700284sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700285 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700286 return $res;
287}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700288
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700289sub line_stats {
290 my ($line) = @_;
291
292 # Drop the diff line leader and expand tabs
293 $line =~ s/^.//;
294 $line = expand_tabs($line);
295
296 # Pick the indent from the front of the line.
297 my ($white) = ($line =~ /^(\s*)/);
298
299 return (length($line), length($white));
300}
301
Andy Whitcroft773647a2008-03-28 14:15:58 -0700302my $sanitise_quote = '';
303
304sub sanitise_line_reset {
305 my ($in_comment) = @_;
306
307 if ($in_comment) {
308 $sanitise_quote = '*/';
309 } else {
310 $sanitise_quote = '';
311 }
312}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700313sub sanitise_line {
314 my ($line) = @_;
315
316 my $res = '';
317 my $l = '';
318
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800319 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700320 my $off = 0;
321 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700322
Andy Whitcroft773647a2008-03-28 14:15:58 -0700323 # Always copy over the diff marker.
324 $res = substr($line, 0, 1);
325
326 for ($off = 1; $off < length($line); $off++) {
327 $c = substr($line, $off, 1);
328
329 # Comments we are wacking completly including the begin
330 # and end, all to $;.
331 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
332 $sanitise_quote = '*/';
333
334 substr($res, $off, 2, "$;$;");
335 $off++;
336 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800337 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700338 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700339 $sanitise_quote = '';
340 substr($res, $off, 2, "$;$;");
341 $off++;
342 next;
343 }
344
345 # A \ in a string means ignore the next character.
346 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
347 $c eq "\\") {
348 substr($res, $off, 2, 'XX');
349 $off++;
350 next;
351 }
352 # Regular quotes.
353 if ($c eq "'" || $c eq '"') {
354 if ($sanitise_quote eq '') {
355 $sanitise_quote = $c;
356
357 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700358 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700359 } elsif ($sanitise_quote eq $c) {
360 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700361 }
362 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700363
364 #print "SQ:$sanitise_quote\n";
365 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
366 substr($res, $off, 1, $;);
367 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
368 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700369 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700370 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700371 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800372 }
373
374 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700375 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800376 my $clean = 'X' x length($1);
377 $res =~ s@\<.*\>@<$clean>@;
378
379 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700380 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800381 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700382 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800383 }
384
Andy Whitcroft00df3442007-06-08 13:47:06 -0700385 return $res;
386}
387
Andy Whitcroft8905a672007-11-28 16:21:06 -0800388sub ctx_statement_block {
389 my ($linenr, $remain, $off) = @_;
390 my $line = $linenr - 1;
391 my $blk = '';
392 my $soff = $off;
393 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700394 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800395
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800396 my $loff = 0;
397
Andy Whitcroft8905a672007-11-28 16:21:06 -0800398 my $type = '';
399 my $level = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800400 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800401 my $c;
402 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800403
404 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800405 while (1) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700406 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800407 # If we are about to drop off the end, pull in more
408 # context.
409 if ($off >= $len) {
410 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700411 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800412 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800413 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800414 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800415 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800416 $len = length($blk);
417 $line++;
418 last;
419 }
420 # Bail if there is no further context.
421 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800422 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800423 last;
424 }
425 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800426 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800427 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800428 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800429
Andy Whitcroft773647a2008-03-28 14:15:58 -0700430 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800431 # Statement ends at the ';' or a close '}' at the
432 # outermost level.
433 if ($level == 0 && $c eq ';') {
434 last;
435 }
436
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800437 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700438 if ($level == 0 && $coff_set == 0 &&
439 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
440 $remainder =~ /^(else)(?:\s|{)/ &&
441 $remainder !~ /^else\s+if\b/) {
442 $coff = $off + length($1) - 1;
443 $coff_set = 1;
444 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
445 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800446 }
447
Andy Whitcroft8905a672007-11-28 16:21:06 -0800448 if (($type eq '' || $type eq '(') && $c eq '(') {
449 $level++;
450 $type = '(';
451 }
452 if ($type eq '(' && $c eq ')') {
453 $level--;
454 $type = ($level != 0)? '(' : '';
455
456 if ($level == 0 && $coff < $soff) {
457 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700458 $coff_set = 1;
459 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800460 }
461 }
462 if (($type eq '' || $type eq '{') && $c eq '{') {
463 $level++;
464 $type = '{';
465 }
466 if ($type eq '{' && $c eq '}') {
467 $level--;
468 $type = ($level != 0)? '{' : '';
469
470 if ($level == 0) {
471 last;
472 }
473 }
474 $off++;
475 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700476 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800477 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700478 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800479 $line++;
480 $remain--;
481 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800482
483 my $statement = substr($blk, $soff, $off - $soff + 1);
484 my $condition = substr($blk, $soff, $coff - $soff + 1);
485
486 #warn "STATEMENT<$statement>\n";
487 #warn "CONDITION<$condition>\n";
488
Andy Whitcroft773647a2008-03-28 14:15:58 -0700489 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800490
491 return ($statement, $condition,
492 $line, $remain + 1, $off - $loff + 1, $level);
493}
494
Andy Whitcroftcf655042008-03-04 14:28:20 -0800495sub statement_lines {
496 my ($stmt) = @_;
497
498 # Strip the diff line prefixes and rip blank lines at start and end.
499 $stmt =~ s/(^|\n)./$1/g;
500 $stmt =~ s/^\s*//;
501 $stmt =~ s/\s*$//;
502
503 my @stmt_lines = ($stmt =~ /\n/g);
504
505 return $#stmt_lines + 2;
506}
507
508sub statement_rawlines {
509 my ($stmt) = @_;
510
511 my @stmt_lines = ($stmt =~ /\n/g);
512
513 return $#stmt_lines + 2;
514}
515
516sub statement_block_size {
517 my ($stmt) = @_;
518
519 $stmt =~ s/(^|\n)./$1/g;
520 $stmt =~ s/^\s*{//;
521 $stmt =~ s/}\s*$//;
522 $stmt =~ s/^\s*//;
523 $stmt =~ s/\s*$//;
524
525 my @stmt_lines = ($stmt =~ /\n/g);
526 my @stmt_statements = ($stmt =~ /;/g);
527
528 my $stmt_lines = $#stmt_lines + 2;
529 my $stmt_statements = $#stmt_statements + 1;
530
531 if ($stmt_lines > $stmt_statements) {
532 return $stmt_lines;
533 } else {
534 return $stmt_statements;
535 }
536}
537
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800538sub ctx_statement_full {
539 my ($linenr, $remain, $off) = @_;
540 my ($statement, $condition, $level);
541
542 my (@chunks);
543
Andy Whitcroftcf655042008-03-04 14:28:20 -0800544 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800545 ($statement, $condition, $linenr, $remain, $off, $level) =
546 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700547 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800548 push(@chunks, [ $condition, $statement ]);
549 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
550 return ($level, $linenr, @chunks);
551 }
552
553 # Pull in the following conditional/block pairs and see if they
554 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800555 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800556 ($statement, $condition, $linenr, $remain, $off, $level) =
557 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800558 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700559 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800560 #print "C: push\n";
561 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800562 }
563
564 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800565}
566
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700567sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700568 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700569 my $line;
570 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700571 my $blk = '';
572 my @o;
573 my @c;
574 my @res = ();
575
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700576 my $level = 0;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700577 for ($line = $start; $remain > 0; $line++) {
578 next if ($rawlines[$line] =~ /^-/);
579 $remain--;
580
581 $blk .= $rawlines[$line];
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700582 foreach my $c (split(//, $rawlines[$line])) {
583 ##print "C<$c>L<$level><$open$close>O<$off>\n";
584 if ($off > 0) {
585 $off--;
586 next;
587 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700588
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700589 if ($c eq $close && $level > 0) {
590 $level--;
591 last if ($level == 0);
592 } elsif ($c eq $open) {
593 $level++;
594 }
595 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700596
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700597 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700598 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700599 }
600
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700601 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700602 }
603
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700604 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700605}
606sub ctx_block_outer {
607 my ($linenr, $remain) = @_;
608
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700609 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
610 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700611}
612sub ctx_block {
613 my ($linenr, $remain) = @_;
614
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700615 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
616 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700617}
618sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700619 my ($linenr, $remain, $off) = @_;
620
621 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
622 return @r;
623}
624sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700625 my ($linenr, $remain) = @_;
626
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700627 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700628}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700629sub ctx_statement_level {
630 my ($linenr, $remain, $off) = @_;
631
632 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
633}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700634
635sub ctx_locate_comment {
636 my ($first_line, $end_line) = @_;
637
638 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700639 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700640 return $current_comment if (defined $current_comment);
641
642 # Look through the context and try and figure out if there is a
643 # comment.
644 my $in_comment = 0;
645 $current_comment = '';
646 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700647 my $line = $rawlines[$linenr - 1];
648 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700649 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
650 $in_comment = 1;
651 }
652 if ($line =~ m@/\*@) {
653 $in_comment = 1;
654 }
655 if (!$in_comment && $current_comment ne '') {
656 $current_comment = '';
657 }
658 $current_comment .= $line . "\n" if ($in_comment);
659 if ($line =~ m@\*/@) {
660 $in_comment = 0;
661 }
662 }
663
664 chomp($current_comment);
665 return($current_comment);
666}
667sub ctx_has_comment {
668 my ($first_line, $end_line) = @_;
669 my $cmt = ctx_locate_comment($first_line, $end_line);
670
Andy Whitcroft00df3442007-06-08 13:47:06 -0700671 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700672 ##print "CMMT: $cmt\n";
673
674 return ($cmt ne '');
675}
676
Andy Whitcroft4d001e42008-10-15 22:02:21 -0700677sub raw_line {
678 my ($linenr, $cnt) = @_;
679
680 my $offset = $linenr - 1;
681 $cnt++;
682
683 my $line;
684 while ($cnt) {
685 $line = $rawlines[$offset++];
686 next if (defined($line) && $line =~ /^-/);
687 $cnt--;
688 }
689
690 return $line;
691}
692
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700693sub cat_vet {
694 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700695 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700696
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700697 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700698 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
699 $res .= $1;
700 if ($2 ne '') {
701 $coded = sprintf("^%c", unpack('C', $2) + 64);
702 $res .= $coded;
703 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700704 }
705 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700706
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700707 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700708}
709
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800710my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800711my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800712my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700713my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800714
715sub annotate_reset {
716 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800717 $av_pending = '_';
718 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700719 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800720}
721
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700722sub annotate_values {
723 my ($stream, $type) = @_;
724
725 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700726 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700727 my $cur = $stream;
728
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800729 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700730
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700731 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700732 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800733 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700734 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700735 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800736 print "WS($1)\n" if ($dbg_values > 1);
737 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800738 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800739 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700740 }
741
Andy Whitcroft8ea3eb92008-07-23 21:29:08 -0700742 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800743 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700744 $type = 'T';
745
Andy Whitcroft389a2fe2008-07-23 21:29:05 -0700746 } elsif ($cur =~ /^($Modifier)\s*/) {
747 print "MODIFIER($1)\n" if ($dbg_values > 1);
748 $type = 'T';
749
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700750 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700751 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800752 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700753 push(@av_paren_type, $type);
754 if ($2 ne '') {
755 $av_pending = 'N';
756 }
757 $type = 'E';
758
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700759 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700760 print "UNDEF($1)\n" if ($dbg_values > 1);
761 $av_preprocessor = 1;
762 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700763
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700764 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800765 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800766 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800767
768 push(@av_paren_type, $type);
769 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700770 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800771
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700772 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800773 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
774 $av_preprocessor = 1;
775
776 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
777
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700778 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800779
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700780 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800781 print "PRE_END($1)\n" if ($dbg_values > 1);
782
783 $av_preprocessor = 1;
784
785 # Assume all arms of the conditional end as this
786 # one does, and continue as if the #endif was not here.
787 pop(@av_paren_type);
788 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700789 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700790
791 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800792 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700793
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700794 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
795 print "ATTR($1)\n" if ($dbg_values > 1);
796 $av_pending = $type;
797 $type = 'N';
798
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700799 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800800 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700801 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800802 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700803 }
804 $type = 'N';
805
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700806 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800807 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700808 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700809 $type = 'N';
810
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700811 } elsif ($cur =~/^(case)/o) {
812 print "CASE($1)\n" if ($dbg_values > 1);
813 $av_pend_colon = 'C';
814 $type = 'N';
815
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700816 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800817 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700818 $type = 'N';
819
820 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800821 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800822 push(@av_paren_type, $av_pending);
823 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700824 $type = 'N';
825
826 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800827 my $new_type = pop(@av_paren_type);
828 if ($new_type ne '_') {
829 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800830 print "PAREN('$1') -> $type\n"
831 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700832 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800833 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700834 }
835
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700836 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800837 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700838 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800839 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700840
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700841 } elsif ($cur =~ /^($Ident\s*):/) {
842 if ($type eq 'E') {
843 $av_pend_colon = 'L';
844 } elsif ($type eq 'T') {
845 $av_pend_colon = 'B';
846 }
847 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
848 $type = 'V';
849
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700850 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800851 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700852 $type = 'V';
853
854 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800855 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700856 $type = 'N';
857
Andy Whitcroftcf655042008-03-04 14:28:20 -0800858 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800859 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800860 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700861 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800862
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700863 } elsif ($cur =~ /^(\?)/o) {
864 print "QUESTION($1)\n" if ($dbg_values > 1);
865 $type = 'N';
866
867 } elsif ($cur =~ /^(:)/o) {
868 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
869
870 substr($var, length($res), 1, $av_pend_colon);
871 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
872 $type = 'E';
873 } else {
874 $type = 'N';
875 }
876 $av_pend_colon = 'O';
877
878 } elsif ($cur =~ /^(;|\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800879 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700880 $type = 'N';
881
Andy Whitcroft0d413862008-10-15 22:02:16 -0700882 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -0700883 my $variant;
884
885 print "OPV($1)\n" if ($dbg_values > 1);
886 if ($type eq 'V') {
887 $variant = 'B';
888 } else {
889 $variant = 'U';
890 }
891
892 substr($var, length($res), 1, $variant);
893 $type = 'N';
894
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700895 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800896 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700897 if ($1 ne '++' && $1 ne '--') {
898 $type = 'N';
899 }
900
901 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800902 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700903 }
904 if (defined $1) {
905 $cur = substr($cur, length($1));
906 $res .= $type x length($1);
907 }
908 }
909
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700910 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700911}
912
Andy Whitcroft8905a672007-11-28 16:21:06 -0800913sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800914 my ($possible, $line) = @_;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800915
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700916 print "CHECK<$possible> ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft0221f552008-07-23 21:29:08 -0700917 if ($possible !~ /^(?:$Modifier|$Storage|$Type|DEFINE_\S+)$/ &&
Andy Whitcroft8905a672007-11-28 16:21:06 -0800918 $possible ne 'goto' && $possible ne 'return' &&
Andy Whitcroft8905a672007-11-28 16:21:06 -0800919 $possible ne 'case' && $possible ne 'else' &&
Andy Whitcroftd3ddcf42008-07-23 21:28:58 -0700920 $possible ne 'asm' && $possible ne '__asm__' &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700921 $possible !~ /^(typedef|struct|enum)\b/) {
922 # Check for modifiers.
923 $possible =~ s/\s*$Storage\s*//g;
924 $possible =~ s/\s*$Sparse\s*//g;
925 if ($possible =~ /^\s*$/) {
926
927 } elsif ($possible =~ /\s/) {
928 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -0700929 for my $modifier (split(' ', $possible)) {
930 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
931 push(@modifierList, $modifier);
932 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700933
934 } else {
935 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
936 push(@typeList, $possible);
937 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800938 build_types();
939 }
940}
941
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700942my $prefix = '';
943
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700944sub report {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700945 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
946 return 0;
947 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800948 my $line = $prefix . $_[0];
949
950 $line = (split('\n', $line))[0] . "\n" if ($terse);
951
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800952 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700953
954 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700955}
956sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800957 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700958}
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700959sub ERROR {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700960 if (report("ERROR: $_[0]\n")) {
961 our $clean = 0;
962 our $cnt_error++;
963 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700964}
965sub WARN {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700966 if (report("WARNING: $_[0]\n")) {
967 our $clean = 0;
968 our $cnt_warn++;
969 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700970}
971sub CHK {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700972 if ($check && report("CHECK: $_[0]\n")) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700973 our $clean = 0;
974 our $cnt_chk++;
975 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700976}
977
Andy Whitcroft6ecd9672008-10-15 22:02:21 -0700978sub check_absolute_file {
979 my ($absolute, $herecurr) = @_;
980 my $file = $absolute;
981
982 ##print "absolute<$absolute>\n";
983
984 # See if any suffix of this path is a path within the tree.
985 while ($file =~ s@^[^/]*/@@) {
986 if (-f "$root/$file") {
987 ##print "file<$file>\n";
988 last;
989 }
990 }
991 if (! -f _) {
992 return 0;
993 }
994
995 # It is, so see if the prefix is acceptable.
996 my $prefix = $absolute;
997 substr($prefix, -length($file)) = '';
998
999 ##print "prefix<$prefix>\n";
1000 if ($prefix ne ".../") {
1001 WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr);
1002 }
1003}
1004
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001005sub process {
1006 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001007
1008 my $linenr=0;
1009 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001010 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001011 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001012 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001013
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001014 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001015 my $indent;
1016 my $previndent=0;
1017 my $stashindent=0;
1018
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001019 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001020 my $signoff = 0;
1021 my $is_patch = 0;
1022
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001023 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001024 our $cnt_lines = 0;
1025 our $cnt_error = 0;
1026 our $cnt_warn = 0;
1027 our $cnt_chk = 0;
1028
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001029 # Trace the real file/line as we go.
1030 my $realfile = '';
1031 my $realline = 0;
1032 my $realcnt = 0;
1033 my $here = '';
1034 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001035 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001036 my $first_line = 0;
1037
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001038 my $prev_values = 'E';
1039
1040 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001041 my %suppress_ifbraces;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001042
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001043 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001044 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001045 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001046 my @setup_docs = ();
1047 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001048
1049 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001050 my $line;
1051 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001052 $linenr++;
1053 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001054
Andy Whitcroft773647a2008-03-28 14:15:58 -07001055 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001056 $setup_docs = 0;
1057 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1058 $setup_docs = 1;
1059 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001060 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001061 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001062 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1063 $realline=$1-1;
1064 if (defined $2) {
1065 $realcnt=$3+1;
1066 } else {
1067 $realcnt=1+1;
1068 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001069 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001070
1071 # Guestimate if this is a continuing comment. Run
1072 # the context looking for a comment "edge". If this
1073 # edge is a close comment then we must be in a comment
1074 # at context start.
1075 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001076 my $cnt = $realcnt;
1077 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1078 next if (defined $rawlines[$ln - 1] &&
1079 $rawlines[$ln - 1] =~ /^-/);
1080 $cnt--;
1081 #print "RAW<$rawlines[$ln - 1]>\n";
1082 ($edge) = (defined $rawlines[$ln - 1] &&
1083 $rawlines[$ln - 1] =~ m@(/\*|\*/)@);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001084 last if (defined $edge);
1085 }
1086 if (defined $edge && $edge eq '*/') {
1087 $in_comment = 1;
1088 }
1089
1090 # Guestimate if this is a continuing comment. If this
1091 # is the start of a diff block and this line starts
1092 # ' *' then it is very likely a comment.
1093 if (!defined $edge &&
1094 $rawlines[$linenr] =~ m@^.\s* \*(?:\s|$)@)
1095 {
1096 $in_comment = 1;
1097 }
1098
1099 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1100 sanitise_line_reset($in_comment);
1101
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001102 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001103 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001104 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001105 $line = sanitise_line($rawline);
1106 }
1107 push(@lines, $line);
1108
1109 if ($realcnt > 1) {
1110 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1111 } else {
1112 $realcnt = 0;
1113 }
1114
1115 #print "==>$rawline\n";
1116 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001117
1118 if ($setup_docs && $line =~ /^\+/) {
1119 push(@setup_docs, $line);
1120 }
1121 }
1122
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001123 $prefix = '';
1124
Andy Whitcroft773647a2008-03-28 14:15:58 -07001125 $realcnt = 0;
1126 $linenr = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001127 foreach my $line (@lines) {
1128 $linenr++;
1129
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001130 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001131
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001132#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001133 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001134 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001135 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001136 $realline=$1-1;
1137 if (defined $2) {
1138 $realcnt=$3+1;
1139 } else {
1140 $realcnt=1+1;
1141 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001142 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001143 $prev_values = 'E';
1144
Andy Whitcroft773647a2008-03-28 14:15:58 -07001145 %suppress_ifbraces = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001146 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001147
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001148# track the line number as we move through the hunk, note that
1149# new versions of GNU diff omit the leading space on completely
1150# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001151 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001152 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001153 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001154
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001155 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001156 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001157
1158 # Track the previous line.
1159 ($prevline, $stashline) = ($stashline, $line);
1160 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001161 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1162
Andy Whitcroft773647a2008-03-28 14:15:58 -07001163 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001164
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001165 } elsif ($realcnt == 1) {
1166 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001167 }
1168
1169#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001170 $prefix = "$filename:$realline: " if ($emacs && $file);
1171 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1172
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001173 $here = "#$linenr: " if (!$file);
1174 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001175
1176 # extract the filename as it passes
1177 if ($line=~/^\+\+\+\s+(\S+)/) {
1178 $realfile = $1;
1179 $realfile =~ s@^[^/]*/@@;
1180
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001181 if ($realfile =~ m@^include/asm/@) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001182 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1183 }
1184 next;
1185 }
1186
Randy Dunlap389834b2007-06-08 13:47:03 -07001187 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001188
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001189 my $hereline = "$here\n$rawline\n";
1190 my $herecurr = "$here\n$rawline\n";
1191 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001192
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001193 $cnt_lines++ if ($realcnt != 0);
1194
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001195#check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001196 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001197 # This is a signoff, if ugly, so do not double report.
1198 $signoff++;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001199 if (!($line =~ /^\s*Signed-off-by:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001200 WARN("Signed-off-by: is the preferred form\n" .
1201 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001202 }
1203 if ($line =~ /^\s*signed-off-by:\S/i) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001204 WARN("space required after Signed-off-by:\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001205 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001206 }
1207 }
1208
Andy Whitcroft00df3442007-06-08 13:47:06 -07001209# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001210 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001211 ERROR("patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001212 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001213 }
1214
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001215# Check for absolute kernel paths.
1216 if ($tree) {
1217 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1218 my $file = $1;
1219
1220 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1221 check_absolute_file($1, $herecurr)) {
1222 #
1223 } else {
1224 check_absolute_file($file, $herecurr);
1225 }
1226 }
1227 }
1228
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001229# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1230 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001231 $rawline !~ m/^$UTF8*$/) {
1232 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1233
1234 my $blank = copy_spacing($rawline);
1235 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1236 my $hereptr = "$hereline$ptr\n";
1237
1238 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001239 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001240
Andy Whitcroft00df3442007-06-08 13:47:06 -07001241#ignore lines being removed
1242 if ($line=~/^-/) {next;}
1243
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001244#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001245 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001246 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001247 ERROR("DOS line endings\n" . $herevet);
1248
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001249 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1250 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001251 ERROR("trailing whitespace\n" . $herevet);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001252 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07001253
1254# check we are in a valid source file if not then ignore this hunk
1255 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1256
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001257#80 column limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001258 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001259 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1260 $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1261 $length > 80)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001262 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001263 WARN("line over 80 characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001264 }
1265
Andy Whitcroft8905a672007-11-28 16:21:06 -08001266# check for adding lines without a newline.
1267 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1268 WARN("adding a line without newline at end of file\n" . $herecurr);
1269 }
1270
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001271# check we are in a valid source file C or perl if not then ignore this hunk
1272 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001273
1274# at the beginning of a line any tabs must come first and anything
1275# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001276 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1277 $rawline =~ /^\+\s* \s*/) {
1278 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001279 ERROR("code indent should use tabs where possible\n" . $herevet);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001280 }
1281
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001282# check we are in a valid C source file if not then ignore this hunk
1283 next if ($realfile !~ /\.(h|c)$/);
1284
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001285# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001286 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001287 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1288 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001289
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001290# Check for potential 'bare' types
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001291 my ($stat, $cond, $line_nr_next, $remain_next);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001292 if ($realcnt && $line =~ /.\s*\S/) {
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001293 ($stat, $cond, $line_nr_next, $remain_next) =
1294 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001295 $stat =~ s/\n./\n /g;
1296 $cond =~ s/\n./\n /g;
1297
1298 my $s = $stat;
1299 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001300
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001301 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001302 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001303
1304 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001305 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001306
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001307 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001308 } 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 -07001309 my $type = $1;
1310 $type =~ s/\s+/ /g;
1311 possible($type, "A:" . $s);
1312
Andy Whitcroft8905a672007-11-28 16:21:06 -08001313 # definitions in global scope can only start with types
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001314 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001315 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001316 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001317
1318 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001319 while ($s =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001320 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001321 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001322
1323 # Check for any sort of function declaration.
1324 # int foo(something bar, other baz);
1325 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001326 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 -08001327 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001328
Andy Whitcroftcf655042008-03-04 14:28:20 -08001329 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001330 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001331 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001332
Andy Whitcroft8905a672007-11-28 16:21:06 -08001333 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001334 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001335
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001336 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001337 }
1338 }
1339 }
1340
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001341 }
1342
Andy Whitcroft653d4872007-06-23 17:16:34 -07001343#
1344# Checks which may be anchored in the context.
1345#
1346
1347# Check for switch () and associated case and default
1348# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07001349 if ($line=~/\bswitch\s*\(.*\)/) {
1350 my $err = '';
1351 my $sep = '';
1352 my @ctx = ctx_block_outer($linenr, $realcnt);
1353 shift(@ctx);
1354 for my $ctx (@ctx) {
1355 my ($clen, $cindent) = line_stats($ctx);
1356 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1357 $indent != $cindent) {
1358 $err .= "$sep$ctx\n";
1359 $sep = '';
1360 } else {
1361 $sep = "[...]\n";
1362 }
1363 }
1364 if ($err ne '') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001365 ERROR("switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001366 }
1367 }
1368
1369# if/while/etc brace do not go on next line, unless defining a do while loop,
1370# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001371 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001372 my $pre_ctx = "$1$2";
1373
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001374 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001375 my $ctx_cnt = $realcnt - $#ctx - 1;
1376 my $ctx = join("\n", @ctx);
1377
Andy Whitcroft548596d2008-07-23 21:29:01 -07001378 my $ctx_ln = $linenr;
1379 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001380
Andy Whitcroft548596d2008-07-23 21:29:01 -07001381 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1382 defined $lines[$ctx_ln - 1] &&
1383 $lines[$ctx_ln - 1] =~ /^-/)) {
1384 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1385 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001386 $ctx_ln++;
1387 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07001388
Andy Whitcroft53210162008-07-23 21:29:03 -07001389 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1390 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001391
1392 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1393 ERROR("that open brace { should be on the previous line\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001394 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07001395 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001396 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1397 $ctx =~ /\)\s*\;\s*$/ &&
1398 defined $lines[$ctx_ln - 1])
1399 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001400 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1401 if ($nindent > $indent) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001402 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001403 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001404 }
1405 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001406 }
1407
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001408# Check relative indent for conditionals and blocks.
1409 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1410 my ($s, $c) = ($stat, $cond);
1411
1412 substr($s, 0, length($c), '');
1413
1414 # Make sure we remove the line prefixes as we have
1415 # none on the first line, and are going to readd them
1416 # where necessary.
1417 $s =~ s/\n./\n/gs;
1418
1419 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07001420 my @newlines = ($c =~ /\n/gs);
1421 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001422
1423 # We want to check the first line inside the block
1424 # starting at the end of the conditional, so remove:
1425 # 1) any blank line termination
1426 # 2) any opening brace { on end of the line
1427 # 3) any do (...) {
1428 my $continuation = 0;
1429 my $check = 0;
1430 $s =~ s/^.*\bdo\b//;
1431 $s =~ s/^\s*{//;
1432 if ($s =~ s/^\s*\\//) {
1433 $continuation = 1;
1434 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001435 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001436 $check = 1;
1437 $cond_lines++;
1438 }
1439
1440 # Also ignore a loop construct at the end of a
1441 # preprocessor statement.
1442 if (($prevline =~ /^.\s*#\s*define\s/ ||
1443 $prevline =~ /\\\s*$/) && $continuation == 0) {
1444 $check = 0;
1445 }
1446
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001447 my $cond_ptr = -1;
1448 while ($cond_ptr != $cond_lines) {
1449 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001450
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001451 # Ignore:
1452 # 1) blank lines, they should be at 0,
1453 # 2) preprocessor lines, and
1454 # 3) labels.
1455 if ($s =~ /^\s*?\n/ ||
1456 $s =~ /^\s*#\s*?/ ||
1457 $s =~ /^\s*$Ident\s*:/) {
1458 $s =~ s/^.*?\n//;
1459 $cond_lines++;
1460 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001461 }
1462
1463 my (undef, $sindent) = line_stats("+" . $s);
1464 my $stat_real = raw_line($linenr, $cond_lines);
1465
1466 # Check if either of these lines are modified, else
1467 # this is not this patch's fault.
1468 if (!defined($stat_real) ||
1469 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1470 $check = 0;
1471 }
1472 if (defined($stat_real) && $cond_lines > 1) {
1473 $stat_real = "[...]\n$stat_real";
1474 }
1475
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001476 #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 -07001477
1478 if ($check && (($sindent % 8) != 0 ||
1479 ($sindent <= $indent && $s ne ''))) {
1480 WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1481 }
1482 }
1483
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001484 # Track the 'values' across context and added lines.
1485 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001486 my ($curr_values, $curr_vars) =
1487 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001488 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001489 if ($dbg_values) {
1490 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001491 print "$linenr > .$outline\n";
1492 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001493 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001494 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001495 $prev_values = substr($curr_values, -1);
1496
Andy Whitcroft00df3442007-06-08 13:47:06 -07001497#ignore lines not being added
1498 if ($line=~/^[^\+]/) {next;}
1499
Andy Whitcroft653d4872007-06-23 17:16:34 -07001500# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07001501 if ($dbg_type) {
1502 if ($line =~ /^.\s*$Declare\s*$/) {
1503 ERROR("TEST: is type\n" . $herecurr);
1504 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1505 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1506 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001507 next;
1508 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001509# TEST: allow direct testing of the attribute matcher.
1510 if ($dbg_attr) {
1511 if ($line =~ /^.\s*$Attribute\s*$/) {
1512 ERROR("TEST: is attr\n" . $herecurr);
1513 } elsif ($dbg_attr > 1 && $line =~ /^.+($Attribute)/) {
1514 ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1515 }
1516 next;
1517 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001518
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001519# check for initialisation to aggregates open brace on the next line
1520 if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1521 $line =~ /^.\s*{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001522 ERROR("that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001523 }
1524
Andy Whitcroft653d4872007-06-23 17:16:34 -07001525#
1526# Checks which are anchored on the added line.
1527#
1528
1529# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001530 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001531 my $path = $1;
1532 if ($path =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001533 ERROR("malformed #include filename\n" .
1534 $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001535 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001536 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001537
1538# no C99 // comments
1539 if ($line =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001540 ERROR("do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001541 }
1542 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001543 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001544 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001545
1546#EXPORT_SYMBOL should immediately follow its function closing }.
Andy Whitcroft653d4872007-06-23 17:16:34 -07001547 if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1548 ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1549 my $name = $1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001550 if (($prevline !~ /^}/) &&
1551 ($prevline !~ /^\+}/) &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001552 ($prevline !~ /^ }/) &&
Andy Whitcroftcf655042008-03-04 14:28:20 -08001553 ($prevline !~ /^.DECLARE_$Ident\(\Q$name\E\)/) &&
1554 ($prevline !~ /^.LIST_HEAD\(\Q$name\E\)/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001555 ($prevline !~ /^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(/) &&
Andy Whitcroftcf655042008-03-04 14:28:20 -08001556 ($prevline !~ /\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001557 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001558 }
1559 }
1560
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001561# check for external initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001562 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001563 ERROR("do not initialise externals to 0 or NULL\n" .
1564 $herecurr);
1565 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001566# check for static initialisers.
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001567 if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001568 ERROR("do not initialise statics to 0 or NULL\n" .
1569 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001570 }
1571
Andy Whitcroft653d4872007-06-23 17:16:34 -07001572# check for new typedefs, only function parameters and sparse annotations
1573# make sense.
1574 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001575 $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001576 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001577 $line !~ /\b__bitwise(?:__|)\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001578 WARN("do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001579 }
1580
1581# * goes on variable not on type
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001582 if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001583 ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" .
1584 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001585
1586 } elsif ($line =~ m{\($NonptrType\s+(\*+)(?!\s+const)\s+\)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001587 ERROR("\"(foo $1 )\" should be \"(foo $1)\"\n" .
1588 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001589
Andy Whitcroft234fff62008-07-23 21:29:12 -07001590 } elsif ($line =~ m{\b$NonptrType(\*+)(?:\s+(?:$Attribute|$Sparse))?\s+[A-Za-z\d_]+}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001591 ERROR("\"foo$1 bar\" should be \"foo $1bar\"\n" .
1592 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001593
Andy Whitcroft234fff62008-07-23 21:29:12 -07001594 } elsif ($line =~ m{\b$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001595 ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" .
1596 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001597 }
1598
1599# # no BUG() or BUG_ON()
1600# if ($line =~ /\b(BUG|BUG_ON)\b/) {
1601# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1602# print "$herecurr";
1603# $clean = 0;
1604# }
1605
Andy Whitcroft8905a672007-11-28 16:21:06 -08001606 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001607 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 -08001608 }
1609
Andy Whitcroft00df3442007-06-08 13:47:06 -07001610# printk should use KERN_* levels. Note that follow on printk's on the
1611# same line do not need a level, so we use the current block context
1612# to try and find and validate the current printk. In summary the current
1613# printk includes all preceeding printk's which have no newline on the end.
1614# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001615 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001616 my $ok = 0;
1617 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1618 #print "CHECK<$lines[$ln - 1]\n";
1619 # we have a preceeding printk if it ends
1620 # with "\n" ignore it, else it is to blame
1621 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1622 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1623 $ok = 1;
1624 }
1625 last;
1626 }
1627 }
1628 if ($ok == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001629 WARN("printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001630 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001631 }
1632
Andy Whitcroft653d4872007-06-23 17:16:34 -07001633# function brace can't be on same line, except for #defines of do while,
1634# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001635 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1636 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001637 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001638 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001639
Andy Whitcroft8905a672007-11-28 16:21:06 -08001640# open braces for enum, union and struct go on the same line.
1641 if ($line =~ /^.\s*{/ &&
1642 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1643 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1644 }
1645
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001646# check for spacing round square brackets; allowed:
1647# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001648# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1649# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001650 while ($line =~ /(.*?\s)\[/g) {
1651 my ($where, $prefix) = ($-[1], $1);
1652 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001653 ($where != 0 || $prefix !~ /^.\s+$/) &&
1654 $prefix !~ /{\s+$/) {
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001655 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1656 }
1657 }
1658
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001659# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001660 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001661 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001662 my $ctx_before = substr($line, 0, $-[1]);
1663 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001664
1665 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001666 if ($name =~ /^(?:
1667 if|for|while|switch|return|case|
1668 volatile|__volatile__|
1669 __attribute__|format|__extension__|
1670 asm|__asm__)$/x)
1671 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001672
1673 # cpp #define statements have non-optional spaces, ie
1674 # if there is a space between the name and the open
1675 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001676 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001677
1678 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001679 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001680
1681 # If this whole things ends with a type its most
1682 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001683 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001684
1685 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001686 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001687 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001688 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001689# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001690 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001691 my $ops = qr{
1692 <<=|>>=|<=|>=|==|!=|
1693 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1694 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001695 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1696 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001697 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001698 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001699 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001700
1701 my $blank = copy_spacing($opline);
1702
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001703 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001704 $off += length($elements[$n]);
1705
Andy Whitcroft773647a2008-03-28 14:15:58 -07001706 # Pick up the preceeding and succeeding characters.
1707 my $ca = substr($opline, 0, $off);
1708 my $cc = '';
1709 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1710 $cc = substr($opline, $off + length($elements[$n + 1]));
1711 }
1712 my $cb = "$ca$;$cc";
1713
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001714 my $a = '';
1715 $a = 'V' if ($elements[$n] ne '');
1716 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001717 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001718 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1719 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07001720 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001721
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001722 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001723
1724 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001725 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001726 $c = 'V' if ($elements[$n + 2] ne '');
1727 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001728 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001729 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1730 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001731 $c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001732 } else {
1733 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001734 }
1735
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001736 my $ctx = "${a}x${c}";
1737
1738 my $at = "(ctx:$ctx)";
1739
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001740 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001741 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001742
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001743 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001744 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001745
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001746 # Get the full operator variant.
1747 my $opv = $op . substr($curr_vars, $off, 1);
1748
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001749 # Ignore operators passed as parameters.
1750 if ($op_type ne 'V' &&
1751 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1752
Andy Whitcroftcf655042008-03-04 14:28:20 -08001753# # Ignore comments
1754# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001755
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001756 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001757 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001758 if ($ctx !~ /.x[WEBC]/ &&
1759 $cc !~ /^\\/ && $cc !~ /^;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001760 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001761 }
1762
1763 # // is a comment
1764 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001765
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001766 # No spaces for:
1767 # ->
1768 # : when part of a bitfield
1769 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001770 if ($ctx =~ /Wx.|.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001771 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001772 }
1773
1774 # , must have a space on the right.
1775 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001776 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001777 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001778 }
1779
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001780 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001781 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001782 #warn "'*' is part of type\n";
1783
1784 # unary operators should have a space before and
1785 # none after. May be left adjacent to another
1786 # unary operator, or a cast
1787 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001788 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07001789 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001790 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001791 ERROR("space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001792 }
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001793 if ($op eq '*' && $cc =~/\s*const\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001794 # A unary '*' may be const
1795
1796 } elsif ($ctx =~ /.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001797 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001798 }
1799
1800 # unary ++ and unary -- are allowed no space on one side.
1801 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001802 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1803 ERROR("space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001804 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001805 if ($ctx =~ /Wx[BE]/ ||
1806 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1807 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001808 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001809 if ($ctx =~ /ExW/) {
1810 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1811 }
1812
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001813
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001814 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001815 } elsif ($op eq '<<' or $op eq '>>' or
1816 $op eq '&' or $op eq '^' or $op eq '|' or
1817 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001818 $op eq '*' or $op eq '/' or
1819 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001820 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001821 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001822 ERROR("need consistent spacing around '$op' $at\n" .
1823 $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001824 }
1825
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001826 # A colon needs no spaces before when it is
1827 # terminating a case value or a label.
1828 } elsif ($opv eq ':C' || $opv eq ':L') {
1829 if ($ctx =~ /Wx./) {
1830 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1831 }
1832
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001833 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08001834 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001835 my $ok = 0;
1836
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001837 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001838 if (($op eq '<' &&
1839 $cc =~ /^\S+\@\S+>/) ||
1840 ($op eq '>' &&
1841 $ca =~ /<\S+\@\S+$/))
1842 {
1843 $ok = 1;
1844 }
1845
1846 # Ignore ?:
1847 if (($opv eq ':O' && $ca =~ /\?$/) ||
1848 ($op eq '?' && $cc =~ /^:/)) {
1849 $ok = 1;
1850 }
1851
1852 if ($ok == 0) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001853 ERROR("spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001854 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001855 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001856 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001857 }
1858 }
1859
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001860# check for multiple assignments
1861 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001862 CHK("multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001863 }
1864
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001865## # check for multiple declarations, allowing for a function declaration
1866## # continuation.
1867## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
1868## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
1869##
1870## # Remove any bracketed sections to ensure we do not
1871## # falsly report the parameters of functions.
1872## my $ln = $line;
1873## while ($ln =~ s/\([^\(\)]*\)//g) {
1874## }
1875## if ($ln =~ /,/) {
1876## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
1877## }
1878## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001879
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001880#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001881 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
1882 $line =~ /do{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001883 ERROR("space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001884 }
1885
1886# closing brace should have a space following it when it has anything
1887# on the line
1888 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001889 ERROR("space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001890 }
1891
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001892# check spacing on square brackets
1893 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001894 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001895 }
1896 if ($line =~ /\s\]/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001897 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001898 }
1899
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001900# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001901 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
1902 $line !~ /for\s*\(\s+;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001903 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001904 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001905 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001906 $line !~ /for\s*\(.*;\s+\)/ &&
1907 $line !~ /:\s+\)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001908 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001909 }
1910
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001911#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001912 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001913 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001914 WARN("labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001915 }
1916
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001917# Return is not a function.
1918 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
1919 my $spacing = $1;
1920 my $value = $2;
1921
1922 # Flatten any parentheses and braces
Andy Whitcroftfee61c42008-07-23 21:28:56 -07001923 $value =~ s/\)\(/\) \(/g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001924 while ($value =~ s/\([^\(\)]*\)/1/) {
1925 }
1926
1927 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
1928 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
1929
1930 } elsif ($spacing !~ /\s+/) {
1931 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1932 }
1933 }
1934
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001935# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001936 if ($line=~/\b(if|while|for|switch)\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001937 ERROR("space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001938 }
1939
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001940# Check for illegal assignment in if conditional -- and check for trailing
1941# statements after the conditional.
Andy Whitcroft53210162008-07-23 21:29:03 -07001942 if ($line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001943 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001944
1945 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001946 ERROR("do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001947 }
1948
1949 # Find out what is on the end of the line after the
1950 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001951 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001952 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001953 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07001954 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
1955 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001956 {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001957 ERROR("trailing statements should be on next line\n" . $herecurr);
1958 }
1959 }
1960
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001961# Check for bitwise tests written as boolean
1962 if ($line =~ /
1963 (?:
1964 (?:\[|\(|\&\&|\|\|)
1965 \s*0[xX][0-9]+\s*
1966 (?:\&\&|\|\|)
1967 |
1968 (?:\&\&|\|\|)
1969 \s*0[xX][0-9]+\s*
1970 (?:\&\&|\|\||\)|\])
1971 )/x)
1972 {
1973 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
1974 }
1975
Andy Whitcroft8905a672007-11-28 16:21:06 -08001976# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001977 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
1978 my $s = $1;
1979 $s =~ s/$;//g; # Remove any comments
1980 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
1981 ERROR("trailing statements should be on next line\n" . $herecurr);
1982 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001983 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07001984# case and default should not have general statements after them
1985 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
1986 $line !~ /\G(?:
1987 (?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
1988 \s*return\s+
1989 )/xg)
1990 {
1991 ERROR("trailing statements should be on next line\n" . $herecurr);
1992 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001993
1994 # Check for }<nl>else {, these must be at the same
1995 # indent level to be relevant to each other.
1996 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
1997 $previndent == $indent) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001998 ERROR("else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001999 }
2000
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002001 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2002 $previndent == $indent) {
2003 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2004
2005 # Find out what is on the end of the line after the
2006 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002007 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002008 $s =~ s/\n.*//g;
2009
2010 if ($s =~ /^\s*;/) {
2011 ERROR("while should follow close brace '}'\n" . $hereprev);
2012 }
2013 }
2014
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002015#studly caps, commented out until figure out how to distinguish between use of existing and adding new
2016# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2017# print "No studly caps, use _\n";
2018# print "$herecurr";
2019# $clean = 0;
2020# }
2021
2022#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002023 if ($line=~/\#\s*define.*\\\s$/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002024 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002025 }
2026
Andy Whitcroft653d4872007-06-23 17:16:34 -07002027#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002028 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002029 my $file = "$1.h";
2030 my $checkfile = "include/linux/$file";
2031 if (-f "$root/$checkfile" &&
2032 $realfile ne $checkfile &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002033 $1 ne 'irq')
2034 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002035 if ($realfile =~ m{^arch/}) {
2036 CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2037 } else {
2038 WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2039 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002040 }
2041 }
2042
Andy Whitcroft653d4872007-06-23 17:16:34 -07002043# multi-statement macros should be enclosed in a do while loop, grab the
2044# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08002045# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07002046 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2047 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002048 my $ln = $linenr;
2049 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002050 my ($off, $dstat, $dcond, $rest);
2051 my $ctx = '';
Andy Whitcroft653d4872007-06-23 17:16:34 -07002052
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002053 my $args = defined($1);
2054
2055 # Find the end of the macro and limit our statement
2056 # search to that.
2057 while ($cnt > 0 && defined $lines[$ln - 1] &&
2058 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2059 {
2060 $ctx .= $rawlines[$ln - 1] . "\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002061 $cnt-- if ($lines[$ln - 1] !~ /^-/);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002062 $ln++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002063 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002064 $ctx .= $rawlines[$ln - 1];
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002065
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002066 ($dstat, $dcond, $ln, $cnt, $off) =
2067 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2068 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002069 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002070
2071 # Extract the remainder of the define (if any) and
2072 # rip off surrounding spaces, and trailing \'s.
2073 $rest = '';
Andy Whitcroft636d1402008-10-15 22:02:18 -07002074 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2075 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002076 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2077 $rest .= substr($lines[$ln - 1], $off) . "\n";
2078 $cnt--;
2079 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002080 $ln++;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002081 $off = 0;
2082 }
2083 $rest =~ s/\\\n.//g;
2084 $rest =~ s/^\s*//s;
2085 $rest =~ s/\s*$//s;
2086
2087 # Clean up the original statement.
2088 if ($args) {
2089 substr($dstat, 0, length($dcond), '');
2090 } else {
2091 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2092 }
Andy Whitcroft292f1a92008-07-23 21:29:11 -07002093 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002094 $dstat =~ s/\\\n.//g;
2095 $dstat =~ s/^\s*//s;
2096 $dstat =~ s/\s*$//s;
2097
2098 # Flatten any parentheses and braces
2099 while ($dstat =~ s/\([^\(\)]*\)/1/) {
2100 }
2101 while ($dstat =~ s/\{[^\{\}]*\}/1/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002102 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002103
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002104 my $exceptions = qr{
2105 $Declare|
2106 module_param_named|
2107 MODULE_PARAM_DESC|
2108 DECLARE_PER_CPU|
2109 DEFINE_PER_CPU|
2110 __typeof__\(
2111 }x;
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002112 #print "REST<$rest>\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002113 if ($rest ne '') {
2114 if ($rest !~ /while\s*\(/ &&
2115 $dstat !~ /$exceptions/)
2116 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002117 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 -07002118 }
2119
2120 } elsif ($ctx !~ /;/) {
2121 if ($dstat ne '' &&
2122 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2123 $dstat !~ /$exceptions/ &&
2124 $dstat =~ /$Operators/)
2125 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002126 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002127 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002128 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002129 }
2130
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002131# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002132 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2133 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08002134 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002135 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002136 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2137 if ($#chunks > 0 && $level == 0) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002138 my $allowed = 0;
2139 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002140 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002141 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002142 for my $chunk (@chunks) {
2143 my ($cond, $block) = @{$chunk};
2144
Andy Whitcroft773647a2008-03-28 14:15:58 -07002145 # If the condition carries leading newlines, then count those as offsets.
2146 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2147 my $offset = statement_rawlines($whitespace) - 1;
2148
2149 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2150
2151 # We have looked at and allowed this specific line.
2152 $suppress_ifbraces{$ln + $offset} = 1;
2153
2154 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002155 $ln += statement_rawlines($block) - 1;
2156
Andy Whitcroft773647a2008-03-28 14:15:58 -07002157 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002158
2159 $seen++ if ($block =~ /^\s*{/);
2160
Andy Whitcroftcf655042008-03-04 14:28:20 -08002161 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2162 if (statement_lines($cond) > 1) {
2163 #print "APW: ALLOWED: cond<$cond>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002164 $allowed = 1;
2165 }
2166 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002167 #print "APW: ALLOWED: block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002168 $allowed = 1;
2169 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002170 if (statement_block_size($block) > 1) {
2171 #print "APW: ALLOWED: lines block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002172 $allowed = 1;
2173 }
2174 }
2175 if ($seen && !$allowed) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002176 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002177 }
2178 }
2179 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002180 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002181 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002182 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002183
Andy Whitcroftcf655042008-03-04 14:28:20 -08002184 # Check the pre-context.
2185 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2186 #print "APW: ALLOWED: pre<$1>\n";
2187 $allowed = 1;
2188 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002189
2190 my ($level, $endln, @chunks) =
2191 ctx_statement_full($linenr, $realcnt, $-[0]);
2192
Andy Whitcroftcf655042008-03-04 14:28:20 -08002193 # Check the condition.
2194 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07002195 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002196 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002197 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08002198 }
2199 if (statement_lines($cond) > 1) {
2200 #print "APW: ALLOWED: cond<$cond>\n";
2201 $allowed = 1;
2202 }
2203 if ($block =~/\b(?:if|for|while)\b/) {
2204 #print "APW: ALLOWED: block<$block>\n";
2205 $allowed = 1;
2206 }
2207 if (statement_block_size($block) > 1) {
2208 #print "APW: ALLOWED: lines block<$block>\n";
2209 $allowed = 1;
2210 }
2211 # Check the post-context.
2212 if (defined $chunks[1]) {
2213 my ($cond, $block) = @{$chunks[1]};
2214 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002215 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002216 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002217 if ($block =~ /^\s*\{/) {
2218 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2219 $allowed = 1;
2220 }
2221 }
2222 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2223 my $herectx = $here . "\n";;
Andy Whitcroftf0556632008-10-15 22:02:23 -07002224 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002225
Andy Whitcroftf0556632008-10-15 22:02:23 -07002226 for (my $n = 0; $n < $cnt; $n++) {
2227 $herectx .= raw_line($linenr, $n) . "\n";;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002228 }
2229
2230 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002231 }
2232 }
2233
Andy Whitcroft653d4872007-06-23 17:16:34 -07002234# don't include deprecated include files (uses RAW line)
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002235 for my $inc (@dep_includes) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002236 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002237 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002238 }
2239 }
2240
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002241# don't use deprecated functions
2242 for my $func (@dep_functions) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002243 if ($line =~ /\b$func\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002244 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002245 }
2246 }
2247
2248# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002249 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2250 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002251 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002252 }
2253
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002254# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2255 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2256 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2257 }
2258
Andy Whitcroft00df3442007-06-08 13:47:06 -07002259# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002260 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002261 CHK("if this code is redundant consider removing it\n" .
2262 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002263 }
2264
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002265# check for needless kfree() checks
2266 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2267 my $expr = $1;
2268 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
Wolfram Sang3c232142008-07-23 21:29:05 -07002269 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002270 }
2271 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07002272# check for needless usb_free_urb() checks
2273 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2274 my $expr = $1;
2275 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2276 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2277 }
2278 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002279
Andy Whitcroft00df3442007-06-08 13:47:06 -07002280# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002281# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002282# print "#ifdef in C files should be avoided\n";
2283# print "$herecurr";
2284# $clean = 0;
2285# }
2286
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002287# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002288 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002289 ERROR("exactly one space required after that #$1\n" . $herecurr);
2290 }
2291
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002292# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002293 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2294 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002295 my $which = $1;
2296 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002297 CHK("$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002298 }
2299 }
2300# check for memory barriers without a comment.
2301 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2302 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002303 CHK("memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002304 }
2305 }
2306# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002307 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002308 CHK("architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002309 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002310
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002311# check the location of the inline attribute, that it is between
2312# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002313 if ($line =~ /\b$Type\s+$Inline\b/ ||
2314 $line =~ /\b$Inline\s+$Storage\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002315 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2316 }
2317
Andy Whitcroft8905a672007-11-28 16:21:06 -08002318# Check for __inline__ and __inline, prefer inline
2319 if ($line =~ /\b(__inline__|__inline)\b/) {
2320 WARN("plain inline is preferred over $1\n" . $herecurr);
2321 }
2322
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002323# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002324 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002325 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002326 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002327 my $function_name = $1;
2328 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002329
2330 my $s = $stat;
2331 if (defined $cond) {
2332 substr($s, 0, length($cond), '');
2333 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002334 if ($s =~ /^\s*;/ &&
2335 $function_name ne 'uninitialized_var')
2336 {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002337 WARN("externs should be avoided in .c files\n" . $herecurr);
2338 }
2339
2340 if ($paren_space =~ /\n/) {
2341 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2342 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002343
2344 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2345 $stat =~ /^.\s*extern\s+/)
2346 {
2347 WARN("externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002348 }
2349
2350# checks for new __setup's
2351 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2352 my $name = $1;
2353
2354 if (!grep(/$name/, @setup_docs)) {
2355 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2356 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002357 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002358
2359# check for pointless casting of kmalloc return
2360 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2361 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2362 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002363
2364# check for gcc specific __FUNCTION__
2365 if ($line =~ /__FUNCTION__/) {
2366 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2367 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002368
2369# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002370 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002371 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2372 }
2373# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002374 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002375 WARN("consider using a completion\n" . $herecurr);
2376 }
2377# recommend strict_strto* over simple_strto*
2378 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2379 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2380 }
Michael Ellermanf3db6632008-07-23 21:28:57 -07002381# check for __initcall(), use device_initcall() explicitly please
2382 if ($line =~ /^.\s*__initcall\s*\(/) {
2383 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2384 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002385
2386# use of NR_CPUS is usually wrong
2387# ignore definitions of NR_CPUS and usage to define arrays as likely right
2388 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002389 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2390 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002391 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2392 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2393 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002394 {
2395 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2396 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002397
2398# check for %L{u,d,i} in strings
2399 my $string;
2400 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2401 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07002402 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002403 if ($string =~ /(?<!%)%L[udi]/) {
2404 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2405 last;
2406 }
2407 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002408 }
2409
2410 # If we have no input at all, then there is nothing to report on
2411 # so just keep quiet.
2412 if ($#rawlines == -1) {
2413 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002414 }
2415
Andy Whitcroft8905a672007-11-28 16:21:06 -08002416 # In mailback mode only produce a report in the negative, for
2417 # things that appear to be patches.
2418 if ($mailback && ($clean == 1 || !$is_patch)) {
2419 exit(0);
2420 }
2421
2422 # This is not a patch, and we are are in 'no-patch' mode so
2423 # just keep quiet.
2424 if (!$chk_patch && !$is_patch) {
2425 exit(0);
2426 }
2427
2428 if (!$is_patch) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002429 ERROR("Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002430 }
2431 if ($is_patch && $chk_signoff && $signoff == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002432 ERROR("Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002433 }
2434
Andy Whitcroft8905a672007-11-28 16:21:06 -08002435 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002436 if ($summary && !($clean == 1 && $quiet == 1)) {
2437 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002438 print "total: $cnt_error errors, $cnt_warn warnings, " .
2439 (($check)? "$cnt_chk checks, " : "") .
2440 "$cnt_lines lines checked\n";
2441 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002442 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002443
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002444 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002445 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002446 }
2447 if ($clean == 0 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002448 print "$vname has style problems, please review. If any of these errors\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002449 print "are false positives report them to the maintainer, see\n";
2450 print "CHECKPATCH in MAINTAINERS.\n";
2451 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002452
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002453 return $clean;
2454}