blob: 1c032b1fa9eb58151f61023ec95e471472cac36a [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 Whitcroft33cba062008-07-23 21:29:12 -070012my $V = '0.21';
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|
116 __(?:mem|cpu|dev|)(?:initdata|init)
117 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700118our $Modifier;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700119our $Inline = qr{inline|__always_inline|noinline};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700120our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
121our $Lval = qr{$Ident(?:$Member)*};
122
123our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
124our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
125our $Operators = qr{
126 <=|>=|==|!=|
127 =>|->|<<|>>|<|>|!|~|
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800128 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700129 }x;
130
Andy Whitcroft8905a672007-11-28 16:21:06 -0800131our $NonptrType;
132our $Type;
133our $Declare;
134
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700135our $UTF8 = qr {
136 [\x09\x0A\x0D\x20-\x7E] # ASCII
137 | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
138 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
139 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
140 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
141 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
142 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
143 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
144}x;
145
Andy Whitcroft8905a672007-11-28 16:21:06 -0800146our @typeList = (
147 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700148 qr{(?:unsigned\s+)?char},
149 qr{(?:unsigned\s+)?short},
150 qr{(?:unsigned\s+)?int},
151 qr{(?:unsigned\s+)?long},
152 qr{(?:unsigned\s+)?long\s+int},
153 qr{(?:unsigned\s+)?long\s+long},
154 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800155 qr{unsigned},
156 qr{float},
157 qr{double},
158 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800159 qr{(?:__)?(?:u|s|be|le)(?:8|16|32|64)},
160 qr{struct\s+$Ident},
161 qr{union\s+$Ident},
162 qr{enum\s+$Ident},
163 qr{${Ident}_t},
164 qr{${Ident}_handler},
165 qr{${Ident}_handler_fn},
166);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700167our @modifierList = (
168 qr{fastcall},
169);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800170
171sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700172 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
173 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700174 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800175 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700176 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800177 (?:
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700178 (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
179 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800180 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700181 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800182 }x;
183 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700184 $NonptrType
Andy Whitcroft8905a672007-11-28 16:21:06 -0800185 (?:\s*\*+\s*const|\s*\*+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700186 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800187 }x;
188 $Declare = qr{(?:$Storage\s+)?$Type};
189}
190build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700191
192$chk_signoff = 0 if ($file);
193
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700194my @dep_includes = ();
195my @dep_functions = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700196my $removal = "Documentation/feature-removal-schedule.txt";
197if ($tree && -f "$root/$removal") {
198 open(REMOVE, "<$root/$removal") ||
199 die "$P: $removal: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700200 while (<REMOVE>) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700201 if (/^Check:\s+(.*\S)/) {
202 for my $entry (split(/[, ]+/, $1)) {
203 if ($entry =~ m@include/(.*)@) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700204 push(@dep_includes, $1);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700205
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700206 } elsif ($entry !~ m@/@) {
207 push(@dep_functions, $entry);
208 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700209 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700210 }
211 }
212}
213
Andy Whitcroft00df3442007-06-08 13:47:06 -0700214my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800215my @lines = ();
216my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700217for my $filename (@ARGV) {
218 if ($file) {
219 open(FILE, "diff -u /dev/null $filename|") ||
220 die "$P: $filename: diff failed - $!\n";
221 } else {
222 open(FILE, "<$filename") ||
223 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700224 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800225 if ($filename eq '-') {
226 $vname = 'Your patch';
227 } else {
228 $vname = $filename;
229 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700230 while (<FILE>) {
231 chomp;
232 push(@rawlines, $_);
233 }
234 close(FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800235 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700236 $exit = 1;
237 }
238 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800239 @lines = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700240}
241
242exit($exit);
243
244sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700245 my ($root) = @_;
246
247 my @tree_check = (
248 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
249 "README", "Documentation", "arch", "include", "drivers",
250 "fs", "init", "ipc", "kernel", "lib", "scripts",
251 );
252
253 foreach my $check (@tree_check) {
254 if (! -e $root . '/' . $check) {
255 return 0;
256 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700257 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700258 return 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700259}
260
261sub expand_tabs {
262 my ($str) = @_;
263
264 my $res = '';
265 my $n = 0;
266 for my $c (split(//, $str)) {
267 if ($c eq "\t") {
268 $res .= ' ';
269 $n++;
270 for (; ($n % 8) != 0; $n++) {
271 $res .= ' ';
272 }
273 next;
274 }
275 $res .= $c;
276 $n++;
277 }
278
279 return $res;
280}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700281sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700282 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700283 return $res;
284}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700285
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700286sub line_stats {
287 my ($line) = @_;
288
289 # Drop the diff line leader and expand tabs
290 $line =~ s/^.//;
291 $line = expand_tabs($line);
292
293 # Pick the indent from the front of the line.
294 my ($white) = ($line =~ /^(\s*)/);
295
296 return (length($line), length($white));
297}
298
Andy Whitcroft773647a2008-03-28 14:15:58 -0700299my $sanitise_quote = '';
300
301sub sanitise_line_reset {
302 my ($in_comment) = @_;
303
304 if ($in_comment) {
305 $sanitise_quote = '*/';
306 } else {
307 $sanitise_quote = '';
308 }
309}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700310sub sanitise_line {
311 my ($line) = @_;
312
313 my $res = '';
314 my $l = '';
315
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800316 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700317 my $off = 0;
318 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700319
Andy Whitcroft773647a2008-03-28 14:15:58 -0700320 # Always copy over the diff marker.
321 $res = substr($line, 0, 1);
322
323 for ($off = 1; $off < length($line); $off++) {
324 $c = substr($line, $off, 1);
325
326 # Comments we are wacking completly including the begin
327 # and end, all to $;.
328 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
329 $sanitise_quote = '*/';
330
331 substr($res, $off, 2, "$;$;");
332 $off++;
333 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800334 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700335 if (substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700336 $sanitise_quote = '';
337 substr($res, $off, 2, "$;$;");
338 $off++;
339 next;
340 }
341
342 # A \ in a string means ignore the next character.
343 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
344 $c eq "\\") {
345 substr($res, $off, 2, 'XX');
346 $off++;
347 next;
348 }
349 # Regular quotes.
350 if ($c eq "'" || $c eq '"') {
351 if ($sanitise_quote eq '') {
352 $sanitise_quote = $c;
353
354 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700355 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700356 } elsif ($sanitise_quote eq $c) {
357 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700358 }
359 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700360
361 #print "SQ:$sanitise_quote\n";
362 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
363 substr($res, $off, 1, $;);
364 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
365 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700366 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700367 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700368 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800369 }
370
371 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700372 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800373 my $clean = 'X' x length($1);
374 $res =~ s@\<.*\>@<$clean>@;
375
376 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700377 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800378 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700379 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800380 }
381
Andy Whitcroft00df3442007-06-08 13:47:06 -0700382 return $res;
383}
384
Andy Whitcroft8905a672007-11-28 16:21:06 -0800385sub ctx_statement_block {
386 my ($linenr, $remain, $off) = @_;
387 my $line = $linenr - 1;
388 my $blk = '';
389 my $soff = $off;
390 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700391 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800392
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800393 my $loff = 0;
394
Andy Whitcroft8905a672007-11-28 16:21:06 -0800395 my $type = '';
396 my $level = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800397 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800398 my $c;
399 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800400
401 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800402 while (1) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700403 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800404 # If we are about to drop off the end, pull in more
405 # context.
406 if ($off >= $len) {
407 for (; $remain > 0; $line++) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800408 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800409 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800410 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800411 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800412 $len = length($blk);
413 $line++;
414 last;
415 }
416 # Bail if there is no further context.
417 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800418 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800419 last;
420 }
421 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800422 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800423 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800424 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800425
Andy Whitcroft773647a2008-03-28 14:15:58 -0700426 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800427 # Statement ends at the ';' or a close '}' at the
428 # outermost level.
429 if ($level == 0 && $c eq ';') {
430 last;
431 }
432
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800433 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700434 if ($level == 0 && $coff_set == 0 &&
435 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
436 $remainder =~ /^(else)(?:\s|{)/ &&
437 $remainder !~ /^else\s+if\b/) {
438 $coff = $off + length($1) - 1;
439 $coff_set = 1;
440 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
441 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800442 }
443
Andy Whitcroft8905a672007-11-28 16:21:06 -0800444 if (($type eq '' || $type eq '(') && $c eq '(') {
445 $level++;
446 $type = '(';
447 }
448 if ($type eq '(' && $c eq ')') {
449 $level--;
450 $type = ($level != 0)? '(' : '';
451
452 if ($level == 0 && $coff < $soff) {
453 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700454 $coff_set = 1;
455 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800456 }
457 }
458 if (($type eq '' || $type eq '{') && $c eq '{') {
459 $level++;
460 $type = '{';
461 }
462 if ($type eq '{' && $c eq '}') {
463 $level--;
464 $type = ($level != 0)? '{' : '';
465
466 if ($level == 0) {
467 last;
468 }
469 }
470 $off++;
471 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700472 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800473 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700474 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800475 $line++;
476 $remain--;
477 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800478
479 my $statement = substr($blk, $soff, $off - $soff + 1);
480 my $condition = substr($blk, $soff, $coff - $soff + 1);
481
482 #warn "STATEMENT<$statement>\n";
483 #warn "CONDITION<$condition>\n";
484
Andy Whitcroft773647a2008-03-28 14:15:58 -0700485 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800486
487 return ($statement, $condition,
488 $line, $remain + 1, $off - $loff + 1, $level);
489}
490
Andy Whitcroftcf655042008-03-04 14:28:20 -0800491sub statement_lines {
492 my ($stmt) = @_;
493
494 # Strip the diff line prefixes and rip blank lines at start and end.
495 $stmt =~ s/(^|\n)./$1/g;
496 $stmt =~ s/^\s*//;
497 $stmt =~ s/\s*$//;
498
499 my @stmt_lines = ($stmt =~ /\n/g);
500
501 return $#stmt_lines + 2;
502}
503
504sub statement_rawlines {
505 my ($stmt) = @_;
506
507 my @stmt_lines = ($stmt =~ /\n/g);
508
509 return $#stmt_lines + 2;
510}
511
512sub statement_block_size {
513 my ($stmt) = @_;
514
515 $stmt =~ s/(^|\n)./$1/g;
516 $stmt =~ s/^\s*{//;
517 $stmt =~ s/}\s*$//;
518 $stmt =~ s/^\s*//;
519 $stmt =~ s/\s*$//;
520
521 my @stmt_lines = ($stmt =~ /\n/g);
522 my @stmt_statements = ($stmt =~ /;/g);
523
524 my $stmt_lines = $#stmt_lines + 2;
525 my $stmt_statements = $#stmt_statements + 1;
526
527 if ($stmt_lines > $stmt_statements) {
528 return $stmt_lines;
529 } else {
530 return $stmt_statements;
531 }
532}
533
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800534sub ctx_statement_full {
535 my ($linenr, $remain, $off) = @_;
536 my ($statement, $condition, $level);
537
538 my (@chunks);
539
Andy Whitcroftcf655042008-03-04 14:28:20 -0800540 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800541 ($statement, $condition, $linenr, $remain, $off, $level) =
542 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700543 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800544 push(@chunks, [ $condition, $statement ]);
545 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
546 return ($level, $linenr, @chunks);
547 }
548
549 # Pull in the following conditional/block pairs and see if they
550 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800551 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800552 ($statement, $condition, $linenr, $remain, $off, $level) =
553 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800554 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700555 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800556 #print "C: push\n";
557 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800558 }
559
560 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800561}
562
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700563sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700564 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700565 my $line;
566 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700567 my $blk = '';
568 my @o;
569 my @c;
570 my @res = ();
571
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700572 my $level = 0;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700573 for ($line = $start; $remain > 0; $line++) {
574 next if ($rawlines[$line] =~ /^-/);
575 $remain--;
576
577 $blk .= $rawlines[$line];
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700578 foreach my $c (split(//, $rawlines[$line])) {
579 ##print "C<$c>L<$level><$open$close>O<$off>\n";
580 if ($off > 0) {
581 $off--;
582 next;
583 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700584
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700585 if ($c eq $close && $level > 0) {
586 $level--;
587 last if ($level == 0);
588 } elsif ($c eq $open) {
589 $level++;
590 }
591 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700592
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700593 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700594 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700595 }
596
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700597 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700598 }
599
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700600 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700601}
602sub ctx_block_outer {
603 my ($linenr, $remain) = @_;
604
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700605 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
606 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700607}
608sub ctx_block {
609 my ($linenr, $remain) = @_;
610
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700611 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
612 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700613}
614sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700615 my ($linenr, $remain, $off) = @_;
616
617 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
618 return @r;
619}
620sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700621 my ($linenr, $remain) = @_;
622
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700623 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700624}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700625sub ctx_statement_level {
626 my ($linenr, $remain, $off) = @_;
627
628 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
629}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700630
631sub ctx_locate_comment {
632 my ($first_line, $end_line) = @_;
633
634 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700635 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700636 return $current_comment if (defined $current_comment);
637
638 # Look through the context and try and figure out if there is a
639 # comment.
640 my $in_comment = 0;
641 $current_comment = '';
642 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700643 my $line = $rawlines[$linenr - 1];
644 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700645 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
646 $in_comment = 1;
647 }
648 if ($line =~ m@/\*@) {
649 $in_comment = 1;
650 }
651 if (!$in_comment && $current_comment ne '') {
652 $current_comment = '';
653 }
654 $current_comment .= $line . "\n" if ($in_comment);
655 if ($line =~ m@\*/@) {
656 $in_comment = 0;
657 }
658 }
659
660 chomp($current_comment);
661 return($current_comment);
662}
663sub ctx_has_comment {
664 my ($first_line, $end_line) = @_;
665 my $cmt = ctx_locate_comment($first_line, $end_line);
666
Andy Whitcroft00df3442007-06-08 13:47:06 -0700667 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700668 ##print "CMMT: $cmt\n";
669
670 return ($cmt ne '');
671}
672
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700673sub cat_vet {
674 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700675 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700676
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700677 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700678 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
679 $res .= $1;
680 if ($2 ne '') {
681 $coded = sprintf("^%c", unpack('C', $2) + 64);
682 $res .= $coded;
683 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700684 }
685 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700686
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700687 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700688}
689
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800690my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800691my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800692my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700693my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800694
695sub annotate_reset {
696 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800697 $av_pending = '_';
698 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700699 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800700}
701
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700702sub annotate_values {
703 my ($stream, $type) = @_;
704
705 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700706 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700707 my $cur = $stream;
708
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800709 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700710
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700711 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700712 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800713 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700714 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700715 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800716 print "WS($1)\n" if ($dbg_values > 1);
717 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800718 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800719 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700720 }
721
Andy Whitcroft8ea3eb92008-07-23 21:29:08 -0700722 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800723 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700724 $type = 'T';
725
Andy Whitcroft389a2fe2008-07-23 21:29:05 -0700726 } elsif ($cur =~ /^($Modifier)\s*/) {
727 print "MODIFIER($1)\n" if ($dbg_values > 1);
728 $type = 'T';
729
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700730 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700731 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800732 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700733 push(@av_paren_type, $type);
734 if ($2 ne '') {
735 $av_pending = 'N';
736 }
737 $type = 'E';
738
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700739 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700740 print "UNDEF($1)\n" if ($dbg_values > 1);
741 $av_preprocessor = 1;
742 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700743
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700744 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800745 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800746 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800747
748 push(@av_paren_type, $type);
749 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700750 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800751
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700752 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800753 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
754 $av_preprocessor = 1;
755
756 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
757
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700758 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800759
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700760 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800761 print "PRE_END($1)\n" if ($dbg_values > 1);
762
763 $av_preprocessor = 1;
764
765 # Assume all arms of the conditional end as this
766 # one does, and continue as if the #endif was not here.
767 pop(@av_paren_type);
768 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700769 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700770
771 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800772 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700773
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700774 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
775 print "ATTR($1)\n" if ($dbg_values > 1);
776 $av_pending = $type;
777 $type = 'N';
778
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700779 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800780 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700781 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800782 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700783 }
784 $type = 'N';
785
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700786 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800787 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700788 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700789 $type = 'N';
790
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700791 } elsif ($cur =~/^(case)/o) {
792 print "CASE($1)\n" if ($dbg_values > 1);
793 $av_pend_colon = 'C';
794 $type = 'N';
795
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700796 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800797 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700798 $type = 'N';
799
800 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800801 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800802 push(@av_paren_type, $av_pending);
803 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700804 $type = 'N';
805
806 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800807 my $new_type = pop(@av_paren_type);
808 if ($new_type ne '_') {
809 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800810 print "PAREN('$1') -> $type\n"
811 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700812 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800813 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700814 }
815
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700816 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800817 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700818 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800819 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700820
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700821 } elsif ($cur =~ /^($Ident\s*):/) {
822 if ($type eq 'E') {
823 $av_pend_colon = 'L';
824 } elsif ($type eq 'T') {
825 $av_pend_colon = 'B';
826 }
827 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
828 $type = 'V';
829
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700830 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800831 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700832 $type = 'V';
833
834 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800835 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700836 $type = 'N';
837
Andy Whitcroftcf655042008-03-04 14:28:20 -0800838 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800839 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800840 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700841 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800842
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700843 } elsif ($cur =~ /^(\?)/o) {
844 print "QUESTION($1)\n" if ($dbg_values > 1);
845 $type = 'N';
846
847 } elsif ($cur =~ /^(:)/o) {
848 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
849
850 substr($var, length($res), 1, $av_pend_colon);
851 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
852 $type = 'E';
853 } else {
854 $type = 'N';
855 }
856 $av_pend_colon = 'O';
857
858 } elsif ($cur =~ /^(;|\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800859 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700860 $type = 'N';
861
Andy Whitcroft0d413862008-10-15 22:02:16 -0700862 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -0700863 my $variant;
864
865 print "OPV($1)\n" if ($dbg_values > 1);
866 if ($type eq 'V') {
867 $variant = 'B';
868 } else {
869 $variant = 'U';
870 }
871
872 substr($var, length($res), 1, $variant);
873 $type = 'N';
874
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700875 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800876 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700877 if ($1 ne '++' && $1 ne '--') {
878 $type = 'N';
879 }
880
881 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800882 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700883 }
884 if (defined $1) {
885 $cur = substr($cur, length($1));
886 $res .= $type x length($1);
887 }
888 }
889
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700890 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700891}
892
Andy Whitcroft8905a672007-11-28 16:21:06 -0800893sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800894 my ($possible, $line) = @_;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800895
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700896 print "CHECK<$possible> ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft0221f552008-07-23 21:29:08 -0700897 if ($possible !~ /^(?:$Modifier|$Storage|$Type|DEFINE_\S+)$/ &&
Andy Whitcroft8905a672007-11-28 16:21:06 -0800898 $possible ne 'goto' && $possible ne 'return' &&
Andy Whitcroft8905a672007-11-28 16:21:06 -0800899 $possible ne 'case' && $possible ne 'else' &&
Andy Whitcroftd3ddcf42008-07-23 21:28:58 -0700900 $possible ne 'asm' && $possible ne '__asm__' &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700901 $possible !~ /^(typedef|struct|enum)\b/) {
902 # Check for modifiers.
903 $possible =~ s/\s*$Storage\s*//g;
904 $possible =~ s/\s*$Sparse\s*//g;
905 if ($possible =~ /^\s*$/) {
906
907 } elsif ($possible =~ /\s/) {
908 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -0700909 for my $modifier (split(' ', $possible)) {
910 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
911 push(@modifierList, $modifier);
912 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700913
914 } else {
915 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
916 push(@typeList, $possible);
917 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800918 build_types();
919 }
920}
921
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700922my $prefix = '';
923
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700924sub report {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700925 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
926 return 0;
927 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800928 my $line = $prefix . $_[0];
929
930 $line = (split('\n', $line))[0] . "\n" if ($terse);
931
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800932 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700933
934 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700935}
936sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800937 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700938}
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700939sub ERROR {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700940 if (report("ERROR: $_[0]\n")) {
941 our $clean = 0;
942 our $cnt_error++;
943 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700944}
945sub WARN {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700946 if (report("WARNING: $_[0]\n")) {
947 our $clean = 0;
948 our $cnt_warn++;
949 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700950}
951sub CHK {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700952 if ($check && report("CHECK: $_[0]\n")) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700953 our $clean = 0;
954 our $cnt_chk++;
955 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700956}
957
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700958sub process {
959 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700960
961 my $linenr=0;
962 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800963 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700964 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800965 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700966
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700967 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700968 my $indent;
969 my $previndent=0;
970 my $stashindent=0;
971
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700972 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700973 my $signoff = 0;
974 my $is_patch = 0;
975
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800976 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700977 our $cnt_lines = 0;
978 our $cnt_error = 0;
979 our $cnt_warn = 0;
980 our $cnt_chk = 0;
981
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700982 # Trace the real file/line as we go.
983 my $realfile = '';
984 my $realline = 0;
985 my $realcnt = 0;
986 my $here = '';
987 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800988 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700989 my $first_line = 0;
990
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800991 my $prev_values = 'E';
992
993 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -0700994 my %suppress_ifbraces;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700995
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800996 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700997 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800998 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700999 my @setup_docs = ();
1000 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001001
1002 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001003 my $line;
1004 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001005 $linenr++;
1006 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001007
Andy Whitcroft773647a2008-03-28 14:15:58 -07001008 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001009 $setup_docs = 0;
1010 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1011 $setup_docs = 1;
1012 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001013 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001014 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001015 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1016 $realline=$1-1;
1017 if (defined $2) {
1018 $realcnt=$3+1;
1019 } else {
1020 $realcnt=1+1;
1021 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001022 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001023
1024 # Guestimate if this is a continuing comment. Run
1025 # the context looking for a comment "edge". If this
1026 # edge is a close comment then we must be in a comment
1027 # at context start.
1028 my $edge;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001029 for (my $ln = $linenr + 1; $ln < ($linenr + $realcnt); $ln++) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001030 next if ($line =~ /^-/);
1031 ($edge) = ($rawlines[$ln - 1] =~ m@(/\*|\*/)@);
1032 last if (defined $edge);
1033 }
1034 if (defined $edge && $edge eq '*/') {
1035 $in_comment = 1;
1036 }
1037
1038 # Guestimate if this is a continuing comment. If this
1039 # is the start of a diff block and this line starts
1040 # ' *' then it is very likely a comment.
1041 if (!defined $edge &&
1042 $rawlines[$linenr] =~ m@^.\s* \*(?:\s|$)@)
1043 {
1044 $in_comment = 1;
1045 }
1046
1047 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1048 sanitise_line_reset($in_comment);
1049
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001050 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001051 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001052 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001053 $line = sanitise_line($rawline);
1054 }
1055 push(@lines, $line);
1056
1057 if ($realcnt > 1) {
1058 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1059 } else {
1060 $realcnt = 0;
1061 }
1062
1063 #print "==>$rawline\n";
1064 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001065
1066 if ($setup_docs && $line =~ /^\+/) {
1067 push(@setup_docs, $line);
1068 }
1069 }
1070
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001071 $prefix = '';
1072
Andy Whitcroft773647a2008-03-28 14:15:58 -07001073 $realcnt = 0;
1074 $linenr = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001075 foreach my $line (@lines) {
1076 $linenr++;
1077
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001078 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001079
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001080#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001081 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001082 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001083 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001084 $realline=$1-1;
1085 if (defined $2) {
1086 $realcnt=$3+1;
1087 } else {
1088 $realcnt=1+1;
1089 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001090 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001091 $prev_values = 'E';
1092
Andy Whitcroft773647a2008-03-28 14:15:58 -07001093 %suppress_ifbraces = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001094 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001095
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001096# track the line number as we move through the hunk, note that
1097# new versions of GNU diff omit the leading space on completely
1098# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001099 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001100 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001101 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001102
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001103 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001104 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001105
1106 # Track the previous line.
1107 ($prevline, $stashline) = ($stashline, $line);
1108 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001109 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1110
Andy Whitcroft773647a2008-03-28 14:15:58 -07001111 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001112
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001113 } elsif ($realcnt == 1) {
1114 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001115 }
1116
1117#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001118 $prefix = "$filename:$realline: " if ($emacs && $file);
1119 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1120
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001121 $here = "#$linenr: " if (!$file);
1122 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001123
1124 # extract the filename as it passes
1125 if ($line=~/^\+\+\+\s+(\S+)/) {
1126 $realfile = $1;
1127 $realfile =~ s@^[^/]*/@@;
1128
1129 if ($realfile =~ m@include/asm/@) {
1130 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1131 }
1132 next;
1133 }
1134
Randy Dunlap389834b2007-06-08 13:47:03 -07001135 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001136
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001137 my $hereline = "$here\n$rawline\n";
1138 my $herecurr = "$here\n$rawline\n";
1139 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001140
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001141 $cnt_lines++ if ($realcnt != 0);
1142
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001143#check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001144 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001145 # This is a signoff, if ugly, so do not double report.
1146 $signoff++;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001147 if (!($line =~ /^\s*Signed-off-by:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001148 WARN("Signed-off-by: is the preferred form\n" .
1149 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001150 }
1151 if ($line =~ /^\s*signed-off-by:\S/i) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001152 WARN("space required after Signed-off-by:\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001153 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001154 }
1155 }
1156
Andy Whitcroft00df3442007-06-08 13:47:06 -07001157# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001158 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001159 ERROR("patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001160 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001161 }
1162
1163# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1164 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001165 $rawline !~ m/^$UTF8*$/) {
1166 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1167
1168 my $blank = copy_spacing($rawline);
1169 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1170 my $hereptr = "$hereline$ptr\n";
1171
1172 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001173 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001174
Andy Whitcroft00df3442007-06-08 13:47:06 -07001175#ignore lines being removed
1176 if ($line=~/^-/) {next;}
1177
1178# check we are in a valid source file if not then ignore this hunk
1179 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001180
1181#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001182 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001183 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001184 ERROR("DOS line endings\n" . $herevet);
1185
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001186 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1187 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001188 ERROR("trailing whitespace\n" . $herevet);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001189 }
1190#80 column limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001191 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001192 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1193 $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1194 $length > 80)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001195 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001196 WARN("line over 80 characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001197 }
1198
Andy Whitcroft8905a672007-11-28 16:21:06 -08001199# check for adding lines without a newline.
1200 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1201 WARN("adding a line without newline at end of file\n" . $herecurr);
1202 }
1203
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001204# check we are in a valid source file *.[hc] if not then ignore this hunk
1205 next if ($realfile !~ /\.[hc]$/);
1206
1207# at the beginning of a line any tabs must come first and anything
1208# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001209 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1210 $rawline =~ /^\+\s* \s*/) {
1211 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001212 ERROR("code indent should use tabs where possible\n" . $herevet);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001213 }
1214
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001215# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001216 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001217 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1218 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001219
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001220# Check for potential 'bare' types
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001221 my ($stat, $cond, $line_nr_next, $remain_next);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001222 if ($realcnt && $line =~ /.\s*\S/) {
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001223 ($stat, $cond, $line_nr_next, $remain_next) =
1224 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001225 $stat =~ s/\n./\n /g;
1226 $cond =~ s/\n./\n /g;
1227
1228 my $s = $stat;
1229 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001230
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001231 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001232 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001233
1234 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001235 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001236
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001237 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001238 } 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 -07001239 my $type = $1;
1240 $type =~ s/\s+/ /g;
1241 possible($type, "A:" . $s);
1242
Andy Whitcroft8905a672007-11-28 16:21:06 -08001243 # definitions in global scope can only start with types
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001244 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001245 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001246 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001247
1248 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001249 while ($s =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001250 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001251 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001252
1253 # Check for any sort of function declaration.
1254 # int foo(something bar, other baz);
1255 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001256 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 -08001257 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001258
Andy Whitcroftcf655042008-03-04 14:28:20 -08001259 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001260 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001261 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001262
Andy Whitcroft8905a672007-11-28 16:21:06 -08001263 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001264 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001265
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001266 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001267 }
1268 }
1269 }
1270
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001271 }
1272
Andy Whitcroft653d4872007-06-23 17:16:34 -07001273#
1274# Checks which may be anchored in the context.
1275#
1276
1277# Check for switch () and associated case and default
1278# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07001279 if ($line=~/\bswitch\s*\(.*\)/) {
1280 my $err = '';
1281 my $sep = '';
1282 my @ctx = ctx_block_outer($linenr, $realcnt);
1283 shift(@ctx);
1284 for my $ctx (@ctx) {
1285 my ($clen, $cindent) = line_stats($ctx);
1286 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1287 $indent != $cindent) {
1288 $err .= "$sep$ctx\n";
1289 $sep = '';
1290 } else {
1291 $sep = "[...]\n";
1292 }
1293 }
1294 if ($err ne '') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001295 ERROR("switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001296 }
1297 }
Andy Whitcrofte2a763c2008-07-23 21:29:02 -07001298 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
Andy Whitcroft1bdab9e2008-10-15 22:02:17 -07001299 $line !~ /\G(?:
1300 (?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
1301 \s*return\s+
1302 )/xg)
1303 {
Andy Whitcrofte2a763c2008-07-23 21:29:02 -07001304 ERROR("trailing statements should be on next line\n" . $herecurr);
1305 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001306
1307# if/while/etc brace do not go on next line, unless defining a do while loop,
1308# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001309 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001310 my $pre_ctx = "$1$2";
1311
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001312 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001313 my $ctx_cnt = $realcnt - $#ctx - 1;
1314 my $ctx = join("\n", @ctx);
1315
Andy Whitcroft548596d2008-07-23 21:29:01 -07001316 my $ctx_ln = $linenr;
1317 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001318
Andy Whitcroft548596d2008-07-23 21:29:01 -07001319 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1320 defined $lines[$ctx_ln - 1] &&
1321 $lines[$ctx_ln - 1] =~ /^-/)) {
1322 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1323 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001324 $ctx_ln++;
1325 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07001326
Andy Whitcroft53210162008-07-23 21:29:03 -07001327 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1328 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001329
1330 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1331 ERROR("that open brace { should be on the previous line\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001332 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07001333 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001334 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1335 $ctx =~ /\)\s*\;\s*$/ &&
1336 defined $lines[$ctx_ln - 1])
1337 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001338 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1339 if ($nindent > $indent) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001340 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001341 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001342 }
1343 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001344 }
1345
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001346 # Track the 'values' across context and added lines.
1347 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001348 my ($curr_values, $curr_vars) =
1349 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001350 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001351 if ($dbg_values) {
1352 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001353 print "$linenr > .$outline\n";
1354 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001355 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001356 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001357 $prev_values = substr($curr_values, -1);
1358
Andy Whitcroft00df3442007-06-08 13:47:06 -07001359#ignore lines not being added
1360 if ($line=~/^[^\+]/) {next;}
1361
Andy Whitcroft653d4872007-06-23 17:16:34 -07001362# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07001363 if ($dbg_type) {
1364 if ($line =~ /^.\s*$Declare\s*$/) {
1365 ERROR("TEST: is type\n" . $herecurr);
1366 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1367 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1368 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001369 next;
1370 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001371# TEST: allow direct testing of the attribute matcher.
1372 if ($dbg_attr) {
1373 if ($line =~ /^.\s*$Attribute\s*$/) {
1374 ERROR("TEST: is attr\n" . $herecurr);
1375 } elsif ($dbg_attr > 1 && $line =~ /^.+($Attribute)/) {
1376 ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1377 }
1378 next;
1379 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001380
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001381# check for initialisation to aggregates open brace on the next line
1382 if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1383 $line =~ /^.\s*{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001384 ERROR("that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001385 }
1386
Andy Whitcroft653d4872007-06-23 17:16:34 -07001387#
1388# Checks which are anchored on the added line.
1389#
1390
1391# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001392 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001393 my $path = $1;
1394 if ($path =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001395 ERROR("malformed #include filename\n" .
1396 $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001397 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001398 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001399
1400# no C99 // comments
1401 if ($line =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001402 ERROR("do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001403 }
1404 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001405 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001406 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001407
1408#EXPORT_SYMBOL should immediately follow its function closing }.
Andy Whitcroft653d4872007-06-23 17:16:34 -07001409 if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1410 ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1411 my $name = $1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001412 if (($prevline !~ /^}/) &&
1413 ($prevline !~ /^\+}/) &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001414 ($prevline !~ /^ }/) &&
Andy Whitcroftcf655042008-03-04 14:28:20 -08001415 ($prevline !~ /^.DECLARE_$Ident\(\Q$name\E\)/) &&
1416 ($prevline !~ /^.LIST_HEAD\(\Q$name\E\)/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001417 ($prevline !~ /^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(/) &&
Andy Whitcroftcf655042008-03-04 14:28:20 -08001418 ($prevline !~ /\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001419 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001420 }
1421 }
1422
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001423# check for external initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001424 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001425 ERROR("do not initialise externals to 0 or NULL\n" .
1426 $herecurr);
1427 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001428# check for static initialisers.
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001429 if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001430 ERROR("do not initialise statics to 0 or NULL\n" .
1431 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001432 }
1433
Andy Whitcroft653d4872007-06-23 17:16:34 -07001434# check for new typedefs, only function parameters and sparse annotations
1435# make sense.
1436 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001437 $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001438 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001439 $line !~ /\b__bitwise(?:__|)\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001440 WARN("do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001441 }
1442
1443# * goes on variable not on type
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001444 if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001445 ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" .
1446 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001447
1448 } elsif ($line =~ m{\($NonptrType\s+(\*+)(?!\s+const)\s+\)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001449 ERROR("\"(foo $1 )\" should be \"(foo $1)\"\n" .
1450 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001451
Andy Whitcroft234fff62008-07-23 21:29:12 -07001452 } elsif ($line =~ m{\b$NonptrType(\*+)(?:\s+(?:$Attribute|$Sparse))?\s+[A-Za-z\d_]+}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001453 ERROR("\"foo$1 bar\" should be \"foo $1bar\"\n" .
1454 $herecurr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001455
Andy Whitcroft234fff62008-07-23 21:29:12 -07001456 } elsif ($line =~ m{\b$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001457 ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" .
1458 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001459 }
1460
1461# # no BUG() or BUG_ON()
1462# if ($line =~ /\b(BUG|BUG_ON)\b/) {
1463# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1464# print "$herecurr";
1465# $clean = 0;
1466# }
1467
Andy Whitcroft8905a672007-11-28 16:21:06 -08001468 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001469 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 -08001470 }
1471
Andy Whitcroft00df3442007-06-08 13:47:06 -07001472# printk should use KERN_* levels. Note that follow on printk's on the
1473# same line do not need a level, so we use the current block context
1474# to try and find and validate the current printk. In summary the current
1475# printk includes all preceeding printk's which have no newline on the end.
1476# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001477 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001478 my $ok = 0;
1479 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1480 #print "CHECK<$lines[$ln - 1]\n";
1481 # we have a preceeding printk if it ends
1482 # with "\n" ignore it, else it is to blame
1483 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1484 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1485 $ok = 1;
1486 }
1487 last;
1488 }
1489 }
1490 if ($ok == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001491 WARN("printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001492 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001493 }
1494
Andy Whitcroft653d4872007-06-23 17:16:34 -07001495# function brace can't be on same line, except for #defines of do while,
1496# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001497 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1498 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001499 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001500 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001501
Andy Whitcroft8905a672007-11-28 16:21:06 -08001502# open braces for enum, union and struct go on the same line.
1503 if ($line =~ /^.\s*{/ &&
1504 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1505 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1506 }
1507
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001508# check for spacing round square brackets; allowed:
1509# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001510# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1511# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001512 while ($line =~ /(.*?\s)\[/g) {
1513 my ($where, $prefix) = ($-[1], $1);
1514 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001515 ($where != 0 || $prefix !~ /^.\s+$/) &&
1516 $prefix !~ /{\s+$/) {
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001517 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1518 }
1519 }
1520
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001521# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001522 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001523 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001524 my $ctx_before = substr($line, 0, $-[1]);
1525 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001526
1527 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001528 if ($name =~ /^(?:
1529 if|for|while|switch|return|case|
1530 volatile|__volatile__|
1531 __attribute__|format|__extension__|
1532 asm|__asm__)$/x)
1533 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001534
1535 # cpp #define statements have non-optional spaces, ie
1536 # if there is a space between the name and the open
1537 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001538 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001539
1540 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001541 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001542
1543 # If this whole things ends with a type its most
1544 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001545 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001546
1547 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001548 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001549 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001550 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001551# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001552 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001553 my $ops = qr{
1554 <<=|>>=|<=|>=|==|!=|
1555 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1556 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001557 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1558 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001559 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001560 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001561 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001562
1563 my $blank = copy_spacing($opline);
1564
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001565 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001566 $off += length($elements[$n]);
1567
Andy Whitcroft773647a2008-03-28 14:15:58 -07001568 # Pick up the preceeding and succeeding characters.
1569 my $ca = substr($opline, 0, $off);
1570 my $cc = '';
1571 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1572 $cc = substr($opline, $off + length($elements[$n + 1]));
1573 }
1574 my $cb = "$ca$;$cc";
1575
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001576 my $a = '';
1577 $a = 'V' if ($elements[$n] ne '');
1578 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001579 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001580 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1581 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07001582 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001583
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001584 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001585
1586 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001587 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001588 $c = 'V' if ($elements[$n + 2] ne '');
1589 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001590 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001591 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1592 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001593 $c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001594 } else {
1595 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001596 }
1597
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001598 my $ctx = "${a}x${c}";
1599
1600 my $at = "(ctx:$ctx)";
1601
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001602 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001603 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001604
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001605 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001606 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001607
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001608 # Get the full operator variant.
1609 my $opv = $op . substr($curr_vars, $off, 1);
1610
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001611 # Ignore operators passed as parameters.
1612 if ($op_type ne 'V' &&
1613 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1614
Andy Whitcroftcf655042008-03-04 14:28:20 -08001615# # Ignore comments
1616# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001617
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001618 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001619 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001620 if ($ctx !~ /.x[WEBC]/ &&
1621 $cc !~ /^\\/ && $cc !~ /^;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001622 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001623 }
1624
1625 # // is a comment
1626 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001627
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001628 # No spaces for:
1629 # ->
1630 # : when part of a bitfield
1631 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001632 if ($ctx =~ /Wx.|.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001633 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001634 }
1635
1636 # , must have a space on the right.
1637 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001638 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001639 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001640 }
1641
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001642 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001643 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001644 #warn "'*' is part of type\n";
1645
1646 # unary operators should have a space before and
1647 # none after. May be left adjacent to another
1648 # unary operator, or a cast
1649 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001650 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07001651 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001652 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001653 ERROR("space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001654 }
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001655 if ($op eq '*' && $cc =~/\s*const\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001656 # A unary '*' may be const
1657
1658 } elsif ($ctx =~ /.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001659 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001660 }
1661
1662 # unary ++ and unary -- are allowed no space on one side.
1663 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001664 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1665 ERROR("space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001666 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001667 if ($ctx =~ /Wx[BE]/ ||
1668 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1669 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001670 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001671 if ($ctx =~ /ExW/) {
1672 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1673 }
1674
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001675
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001676 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001677 } elsif ($op eq '<<' or $op eq '>>' or
1678 $op eq '&' or $op eq '^' or $op eq '|' or
1679 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001680 $op eq '*' or $op eq '/' or
1681 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001682 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001683 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001684 ERROR("need consistent spacing around '$op' $at\n" .
1685 $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001686 }
1687
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001688 # A colon needs no spaces before when it is
1689 # terminating a case value or a label.
1690 } elsif ($opv eq ':C' || $opv eq ':L') {
1691 if ($ctx =~ /Wx./) {
1692 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1693 }
1694
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001695 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08001696 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001697 my $ok = 0;
1698
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001699 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001700 if (($op eq '<' &&
1701 $cc =~ /^\S+\@\S+>/) ||
1702 ($op eq '>' &&
1703 $ca =~ /<\S+\@\S+$/))
1704 {
1705 $ok = 1;
1706 }
1707
1708 # Ignore ?:
1709 if (($opv eq ':O' && $ca =~ /\?$/) ||
1710 ($op eq '?' && $cc =~ /^:/)) {
1711 $ok = 1;
1712 }
1713
1714 if ($ok == 0) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001715 ERROR("spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001716 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001717 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001718 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001719 }
1720 }
1721
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001722# check for multiple assignments
1723 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001724 CHK("multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001725 }
1726
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001727## # check for multiple declarations, allowing for a function declaration
1728## # continuation.
1729## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
1730## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
1731##
1732## # Remove any bracketed sections to ensure we do not
1733## # falsly report the parameters of functions.
1734## my $ln = $line;
1735## while ($ln =~ s/\([^\(\)]*\)//g) {
1736## }
1737## if ($ln =~ /,/) {
1738## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
1739## }
1740## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001741
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001742#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001743 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
1744 $line =~ /do{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001745 ERROR("space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001746 }
1747
1748# closing brace should have a space following it when it has anything
1749# on the line
1750 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001751 ERROR("space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001752 }
1753
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001754# check spacing on square brackets
1755 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001756 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001757 }
1758 if ($line =~ /\s\]/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001759 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001760 }
1761
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001762# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001763 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
1764 $line !~ /for\s*\(\s+;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001765 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001766 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001767 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001768 $line !~ /for\s*\(.*;\s+\)/ &&
1769 $line !~ /:\s+\)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001770 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001771 }
1772
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001773#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001774 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001775 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001776 WARN("labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001777 }
1778
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001779# Return is not a function.
1780 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
1781 my $spacing = $1;
1782 my $value = $2;
1783
1784 # Flatten any parentheses and braces
Andy Whitcroftfee61c42008-07-23 21:28:56 -07001785 $value =~ s/\)\(/\) \(/g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001786 while ($value =~ s/\([^\(\)]*\)/1/) {
1787 }
1788
1789 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
1790 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
1791
1792 } elsif ($spacing !~ /\s+/) {
1793 ERROR("space required before the open parenthesis '('\n" . $herecurr);
1794 }
1795 }
1796
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001797# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001798 if ($line=~/\b(if|while|for|switch)\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001799 ERROR("space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001800 }
1801
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001802# Check for illegal assignment in if conditional -- and check for trailing
1803# statements after the conditional.
Andy Whitcroft53210162008-07-23 21:29:03 -07001804 if ($line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001805 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001806
1807 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001808 ERROR("do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001809 }
1810
1811 # Find out what is on the end of the line after the
1812 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001813 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001814 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001815 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07001816 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
1817 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001818 {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001819 ERROR("trailing statements should be on next line\n" . $herecurr);
1820 }
1821 }
1822
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001823# Check relative indent for conditionals and blocks.
1824 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1825 my ($s, $c) = ($stat, $cond);
1826
1827 substr($s, 0, length($c), '');
1828
1829 # Make sure we remove the line prefixes as we have
1830 # none on the first line, and are going to readd them
1831 # where necessary.
1832 $s =~ s/\n./\n/gs;
1833
1834 # We want to check the first line inside the block
1835 # starting at the end of the conditional, so remove:
1836 # 1) any blank line termination
1837 # 2) any opening brace { on end of the line
1838 # 3) any do (...) {
1839 my $continuation = 0;
1840 my $check = 0;
1841 $s =~ s/^.*\bdo\b//;
1842 $s =~ s/^\s*{//;
1843 if ($s =~ s/^\s*\\//) {
1844 $continuation = 1;
1845 }
1846 if ($s =~ s/^\s*\n//) {
1847 $check = 1;
1848 }
1849
1850 # Also ignore a loop construct at the end of a
1851 # preprocessor statement.
1852 if (($prevline =~ /^.\s*#\s*define\s/ ||
1853 $prevline =~ /\\\s*$/) && $continuation == 0) {
1854 $check = 0;
1855 }
1856
1857 # Ignore the current line if its is a preprocessor
1858 # line.
1859 if ($s =~ /^\s*#\s*/) {
1860 $check = 0;
1861 }
1862
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001863 # Ignore the current line if it is label.
1864 if ($s =~ /^\s*$Ident\s*:/) {
1865 $check = 0;
1866 }
1867
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001868 my (undef, $sindent) = line_stats("+" . $s);
1869
1870 ##print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s>\n";
1871
1872 if ($check && (($sindent % 8) != 0 ||
1873 ($sindent <= $indent && $s ne ''))) {
1874 WARN("suspect code indent for conditional statements\n" . $herecurr);
1875 }
1876 }
1877
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001878# Check for bitwise tests written as boolean
1879 if ($line =~ /
1880 (?:
1881 (?:\[|\(|\&\&|\|\|)
1882 \s*0[xX][0-9]+\s*
1883 (?:\&\&|\|\|)
1884 |
1885 (?:\&\&|\|\|)
1886 \s*0[xX][0-9]+\s*
1887 (?:\&\&|\|\||\)|\])
1888 )/x)
1889 {
1890 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
1891 }
1892
Andy Whitcroft8905a672007-11-28 16:21:06 -08001893# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001894 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
1895 my $s = $1;
1896 $s =~ s/$;//g; # Remove any comments
1897 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
1898 ERROR("trailing statements should be on next line\n" . $herecurr);
1899 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001900 }
1901
1902 # Check for }<nl>else {, these must be at the same
1903 # indent level to be relevant to each other.
1904 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
1905 $previndent == $indent) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001906 ERROR("else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001907 }
1908
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001909 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
1910 $previndent == $indent) {
1911 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
1912
1913 # Find out what is on the end of the line after the
1914 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001915 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001916 $s =~ s/\n.*//g;
1917
1918 if ($s =~ /^\s*;/) {
1919 ERROR("while should follow close brace '}'\n" . $hereprev);
1920 }
1921 }
1922
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001923#studly caps, commented out until figure out how to distinguish between use of existing and adding new
1924# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
1925# print "No studly caps, use _\n";
1926# print "$herecurr";
1927# $clean = 0;
1928# }
1929
1930#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001931 if ($line=~/\#\s*define.*\\\s$/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001932 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001933 }
1934
Andy Whitcroft653d4872007-06-23 17:16:34 -07001935#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001936 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
1937 my $checkfile = "include/linux/$1.h";
1938 if (-f "$root/$checkfile" && $realfile ne $checkfile &&
1939 $1 ne 'irq')
1940 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001941 WARN("Use #include <linux/$1.h> instead of <asm/$1.h>\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001942 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001943 }
1944 }
1945
Andy Whitcroft653d4872007-06-23 17:16:34 -07001946# multi-statement macros should be enclosed in a do while loop, grab the
1947# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08001948# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07001949 if ($realfile !~ m@/vmlinux.lds.h$@ &&
1950 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001951 my $ln = $linenr;
1952 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001953 my ($off, $dstat, $dcond, $rest);
1954 my $ctx = '';
Andy Whitcroft653d4872007-06-23 17:16:34 -07001955
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001956 my $args = defined($1);
1957
1958 # Find the end of the macro and limit our statement
1959 # search to that.
1960 while ($cnt > 0 && defined $lines[$ln - 1] &&
1961 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
1962 {
1963 $ctx .= $rawlines[$ln - 1] . "\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001964 $cnt-- if ($lines[$ln - 1] !~ /^-/);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001965 $ln++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001966 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001967 $ctx .= $rawlines[$ln - 1];
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001968
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001969 ($dstat, $dcond, $ln, $cnt, $off) =
1970 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
1971 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001972 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001973
1974 # Extract the remainder of the define (if any) and
1975 # rip off surrounding spaces, and trailing \'s.
1976 $rest = '';
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001977 while ($off != 0 || ($cnt > 0 && $rest =~ /(?:^|\\)\s*$/)) {
1978 #print "ADDING $off <" . substr($lines[$ln - 1], $off) . ">\n";
1979 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
1980 $rest .= substr($lines[$ln - 1], $off) . "\n";
1981 $cnt--;
1982 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001983 $ln++;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001984 $off = 0;
1985 }
1986 $rest =~ s/\\\n.//g;
1987 $rest =~ s/^\s*//s;
1988 $rest =~ s/\s*$//s;
1989
1990 # Clean up the original statement.
1991 if ($args) {
1992 substr($dstat, 0, length($dcond), '');
1993 } else {
1994 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
1995 }
Andy Whitcroft292f1a92008-07-23 21:29:11 -07001996 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001997 $dstat =~ s/\\\n.//g;
1998 $dstat =~ s/^\s*//s;
1999 $dstat =~ s/\s*$//s;
2000
2001 # Flatten any parentheses and braces
2002 while ($dstat =~ s/\([^\(\)]*\)/1/) {
2003 }
2004 while ($dstat =~ s/\{[^\{\}]*\}/1/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002005 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002006
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002007 my $exceptions = qr{
2008 $Declare|
2009 module_param_named|
2010 MODULE_PARAM_DESC|
2011 DECLARE_PER_CPU|
2012 DEFINE_PER_CPU|
2013 __typeof__\(
2014 }x;
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002015 #print "REST<$rest>\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002016 if ($rest ne '') {
2017 if ($rest !~ /while\s*\(/ &&
2018 $dstat !~ /$exceptions/)
2019 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002020 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 -07002021 }
2022
2023 } elsif ($ctx !~ /;/) {
2024 if ($dstat ne '' &&
2025 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2026 $dstat !~ /$exceptions/ &&
2027 $dstat =~ /$Operators/)
2028 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002029 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002030 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002031 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002032 }
2033
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002034# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002035 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2036 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08002037 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002038 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002039 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2040 if ($#chunks > 0 && $level == 0) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002041 my $allowed = 0;
2042 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002043 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002044 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002045 for my $chunk (@chunks) {
2046 my ($cond, $block) = @{$chunk};
2047
Andy Whitcroft773647a2008-03-28 14:15:58 -07002048 # If the condition carries leading newlines, then count those as offsets.
2049 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2050 my $offset = statement_rawlines($whitespace) - 1;
2051
2052 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2053
2054 # We have looked at and allowed this specific line.
2055 $suppress_ifbraces{$ln + $offset} = 1;
2056
2057 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002058 $ln += statement_rawlines($block) - 1;
2059
Andy Whitcroft773647a2008-03-28 14:15:58 -07002060 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002061
2062 $seen++ if ($block =~ /^\s*{/);
2063
Andy Whitcroftcf655042008-03-04 14:28:20 -08002064 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2065 if (statement_lines($cond) > 1) {
2066 #print "APW: ALLOWED: cond<$cond>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002067 $allowed = 1;
2068 }
2069 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002070 #print "APW: ALLOWED: block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002071 $allowed = 1;
2072 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002073 if (statement_block_size($block) > 1) {
2074 #print "APW: ALLOWED: lines block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002075 $allowed = 1;
2076 }
2077 }
2078 if ($seen && !$allowed) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002079 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002080 }
2081 }
2082 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002083 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002084 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002085 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002086
Andy Whitcroftcf655042008-03-04 14:28:20 -08002087 # Check the pre-context.
2088 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2089 #print "APW: ALLOWED: pre<$1>\n";
2090 $allowed = 1;
2091 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002092
2093 my ($level, $endln, @chunks) =
2094 ctx_statement_full($linenr, $realcnt, $-[0]);
2095
Andy Whitcroftcf655042008-03-04 14:28:20 -08002096 # Check the condition.
2097 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07002098 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002099 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002100 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08002101 }
2102 if (statement_lines($cond) > 1) {
2103 #print "APW: ALLOWED: cond<$cond>\n";
2104 $allowed = 1;
2105 }
2106 if ($block =~/\b(?:if|for|while)\b/) {
2107 #print "APW: ALLOWED: block<$block>\n";
2108 $allowed = 1;
2109 }
2110 if (statement_block_size($block) > 1) {
2111 #print "APW: ALLOWED: lines block<$block>\n";
2112 $allowed = 1;
2113 }
2114 # Check the post-context.
2115 if (defined $chunks[1]) {
2116 my ($cond, $block) = @{$chunks[1]};
2117 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002118 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002119 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002120 if ($block =~ /^\s*\{/) {
2121 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2122 $allowed = 1;
2123 }
2124 }
2125 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2126 my $herectx = $here . "\n";;
2127 my $end = $linenr + statement_rawlines($block) - 1;
2128
2129 for (my $ln = $linenr - 1; $ln < $end; $ln++) {
2130 $herectx .= $rawlines[$ln] . "\n";;
2131 }
2132
2133 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002134 }
2135 }
2136
Andy Whitcroft653d4872007-06-23 17:16:34 -07002137# don't include deprecated include files (uses RAW line)
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002138 for my $inc (@dep_includes) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002139 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002140 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002141 }
2142 }
2143
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002144# don't use deprecated functions
2145 for my $func (@dep_functions) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002146 if ($line =~ /\b$func\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002147 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002148 }
2149 }
2150
2151# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002152 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2153 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002154 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002155 }
2156
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002157# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2158 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2159 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2160 }
2161
Andy Whitcroft00df3442007-06-08 13:47:06 -07002162# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002163 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002164 CHK("if this code is redundant consider removing it\n" .
2165 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002166 }
2167
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002168# check for needless kfree() checks
2169 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2170 my $expr = $1;
2171 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
Wolfram Sang3c232142008-07-23 21:29:05 -07002172 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002173 }
2174 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07002175# check for needless usb_free_urb() checks
2176 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2177 my $expr = $1;
2178 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2179 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2180 }
2181 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002182
Andy Whitcroft00df3442007-06-08 13:47:06 -07002183# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002184# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002185# print "#ifdef in C files should be avoided\n";
2186# print "$herecurr";
2187# $clean = 0;
2188# }
2189
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002190# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002191 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002192 ERROR("exactly one space required after that #$1\n" . $herecurr);
2193 }
2194
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002195# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002196 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2197 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002198 my $which = $1;
2199 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002200 CHK("$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002201 }
2202 }
2203# check for memory barriers without a comment.
2204 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2205 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002206 CHK("memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002207 }
2208 }
2209# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002210 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002211 CHK("architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002212 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002213
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002214# check the location of the inline attribute, that it is between
2215# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002216 if ($line =~ /\b$Type\s+$Inline\b/ ||
2217 $line =~ /\b$Inline\s+$Storage\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002218 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2219 }
2220
Andy Whitcroft8905a672007-11-28 16:21:06 -08002221# Check for __inline__ and __inline, prefer inline
2222 if ($line =~ /\b(__inline__|__inline)\b/) {
2223 WARN("plain inline is preferred over $1\n" . $herecurr);
2224 }
2225
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002226# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002227 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002228 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002229 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002230 my $function_name = $1;
2231 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002232
2233 my $s = $stat;
2234 if (defined $cond) {
2235 substr($s, 0, length($cond), '');
2236 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002237 if ($s =~ /^\s*;/ &&
2238 $function_name ne 'uninitialized_var')
2239 {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002240 WARN("externs should be avoided in .c files\n" . $herecurr);
2241 }
2242
2243 if ($paren_space =~ /\n/) {
2244 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2245 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002246
2247 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2248 $stat =~ /^.\s*extern\s+/)
2249 {
2250 WARN("externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002251 }
2252
2253# checks for new __setup's
2254 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2255 my $name = $1;
2256
2257 if (!grep(/$name/, @setup_docs)) {
2258 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2259 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002260 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002261
2262# check for pointless casting of kmalloc return
2263 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2264 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2265 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002266
2267# check for gcc specific __FUNCTION__
2268 if ($line =~ /__FUNCTION__/) {
2269 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2270 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002271
2272# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002273 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002274 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2275 }
2276# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002277 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002278 WARN("consider using a completion\n" . $herecurr);
2279 }
2280# recommend strict_strto* over simple_strto*
2281 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2282 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2283 }
Michael Ellermanf3db6632008-07-23 21:28:57 -07002284# check for __initcall(), use device_initcall() explicitly please
2285 if ($line =~ /^.\s*__initcall\s*\(/) {
2286 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2287 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002288
2289# use of NR_CPUS is usually wrong
2290# ignore definitions of NR_CPUS and usage to define arrays as likely right
2291 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002292 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2293 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002294 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2295 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2296 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002297 {
2298 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2299 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002300
2301# check for %L{u,d,i} in strings
2302 my $string;
2303 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2304 $string = substr($rawline, $-[1], $+[1] - $-[1]);
2305 if ($string =~ /(?<!%)%L[udi]/) {
2306 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2307 last;
2308 }
2309 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002310 }
2311
2312 # If we have no input at all, then there is nothing to report on
2313 # so just keep quiet.
2314 if ($#rawlines == -1) {
2315 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002316 }
2317
Andy Whitcroft8905a672007-11-28 16:21:06 -08002318 # In mailback mode only produce a report in the negative, for
2319 # things that appear to be patches.
2320 if ($mailback && ($clean == 1 || !$is_patch)) {
2321 exit(0);
2322 }
2323
2324 # This is not a patch, and we are are in 'no-patch' mode so
2325 # just keep quiet.
2326 if (!$chk_patch && !$is_patch) {
2327 exit(0);
2328 }
2329
2330 if (!$is_patch) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002331 ERROR("Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002332 }
2333 if ($is_patch && $chk_signoff && $signoff == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002334 ERROR("Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002335 }
2336
Andy Whitcroft8905a672007-11-28 16:21:06 -08002337 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002338 if ($summary && !($clean == 1 && $quiet == 1)) {
2339 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002340 print "total: $cnt_error errors, $cnt_warn warnings, " .
2341 (($check)? "$cnt_chk checks, " : "") .
2342 "$cnt_lines lines checked\n";
2343 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002344 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002345
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002346 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002347 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002348 }
2349 if ($clean == 0 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002350 print "$vname has style problems, please review. If any of these errors\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002351 print "are false positives report them to the maintainer, see\n";
2352 print "CHECKPATCH in MAINTAINERS.\n";
2353 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002354
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002355 return $clean;
2356}