blob: 2039acdf51222b3961b06291d6a02f4a8105a240 [file] [log] [blame]
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft131edb32009-10-26 16:50:14 -07005# (c) 2008,2009, Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
9
10my $P = $0;
Andy Whitcroft00df3442007-06-08 13:47:06 -070011$P =~ s@.*/@@g;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070012
Andy Whitcroft5e8d8f62009-10-26 16:50:17 -070013my $V = '0.30';
Andy Whitcroft0a920b52007-06-01 00:46:48 -070014
15use Getopt::Long qw(:config no_auto_abbrev);
16
17my $quiet = 0;
18my $tree = 1;
19my $chk_signoff = 1;
20my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070021my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070022my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080023my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070024my $file = 0;
25my $check = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080026my $summary = 1;
27my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080028my $summary_file = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070029my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080030my %debug;
Hannes Eder77f5b102009-09-21 17:04:37 -070031my $help = 0;
32
33sub help {
34 my ($exitcode) = @_;
35
36 print << "EOM";
37Usage: $P [OPTION]... [FILE]...
38Version: $V
39
40Options:
41 -q, --quiet quiet
42 --no-tree run without a kernel tree
43 --no-signoff do not check for 'Signed-off-by' line
44 --patch treat FILE as patchfile (default)
45 --emacs emacs compile window format
46 --terse one line per report
47 -f, --file treat FILE as regular source file
48 --subjective, --strict enable more subjective tests
49 --root=PATH PATH to the kernel tree root
50 --no-summary suppress the per-file summary
51 --mailback only produce a report in case of warnings/errors
52 --summary-file include the filename in summary
53 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
54 'values', 'possible', 'type', and 'attr' (default
55 is all off)
56 --test-only=WORD report only warnings/errors containing WORD
57 literally
58 -h, --help, --version display this help and exit
59
60When FILE is - read standard input.
61EOM
62
63 exit($exitcode);
64}
65
Andy Whitcroft0a920b52007-06-01 00:46:48 -070066GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070067 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-06-01 00:46:48 -070068 'tree!' => \$tree,
69 'signoff!' => \$chk_signoff,
70 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070071 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -080072 'terse!' => \$terse,
Hannes Eder77f5b102009-09-21 17:04:37 -070073 'f|file!' => \$file,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070074 'subjective!' => \$check,
75 'strict!' => \$check,
76 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -080077 'summary!' => \$summary,
78 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -080079 'summary-file!' => \$summary_file,
80
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080081 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -070082 'test-only=s' => \$tst_only,
Hannes Eder77f5b102009-09-21 17:04:37 -070083 'h|help' => \$help,
84 'version' => \$help
85) or help(1);
86
87help(0) if ($help);
Andy Whitcroft0a920b52007-06-01 00:46:48 -070088
89my $exit = 0;
90
91if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -070092 print "$P: no input files\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -070093 exit(1);
94}
95
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080096my $dbg_values = 0;
97my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -070098my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -070099my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800100for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800101 ## no critic
102 eval "\${dbg_$key} = '$debug{$key}';";
103 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800104}
105
Andy Whitcroft8905a672007-11-28 16:21:06 -0800106if ($terse) {
107 $emacs = 1;
108 $quiet++;
109}
110
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700111if ($tree) {
112 if (defined $root) {
113 if (!top_of_kernel_tree($root)) {
114 die "$P: $root: --root does not point at a valid tree\n";
115 }
116 } else {
117 if (top_of_kernel_tree('.')) {
118 $root = '.';
119 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
120 top_of_kernel_tree($1)) {
121 $root = $1;
122 }
123 }
124
125 if (!defined $root) {
126 print "Must be run from the top-level dir. of a kernel tree\n";
127 exit(2);
128 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700129}
130
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700131my $emitted_corrupt = 0;
132
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700133our $Ident = qr{
134 [A-Za-z_][A-Za-z\d_]*
135 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
136 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700137our $Storage = qr{extern|static|asmlinkage};
138our $Sparse = qr{
139 __user|
140 __kernel|
141 __force|
142 __iomem|
143 __must_check|
144 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800145 __kprobes|
146 __ref
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700147 }x;
Wolfram Sang52131292010-03-05 13:43:51 -0800148
149# Notes to $Attribute:
150# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700151our $Attribute = qr{
152 const|
153 __read_mostly|
154 __kprobes|
Wolfram Sang52131292010-03-05 13:43:51 -0800155 __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700156 ____cacheline_aligned|
157 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800158 ____cacheline_internodealigned_in_smp|
159 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700160 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700161our $Modifier;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700162our $Inline = qr{inline|__always_inline|noinline};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700163our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
164our $Lval = qr{$Ident(?:$Member)*};
165
166our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
167our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
Andy Whitcroft86f9d052009-01-06 14:41:24 -0800168our $Compare = qr{<=|>=|==|!=|<|>};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700169our $Operators = qr{
170 <=|>=|==|!=|
171 =>|->|<<|>>|<|>|!|~|
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800172 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700173 }x;
174
Andy Whitcroft8905a672007-11-28 16:21:06 -0800175our $NonptrType;
176our $Type;
177our $Declare;
178
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700179our $UTF8 = qr {
180 [\x09\x0A\x0D\x20-\x7E] # ASCII
181 | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
182 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
183 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
184 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
185 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
186 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
187 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
188}x;
189
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700190our $typeTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700191 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700192 atomic_t
193)};
194
Joe Perches691e6692010-03-05 13:43:51 -0800195our $logFunctions = qr{(?x:
196 printk|
197 pr_(debug|dbg|vdbg|devel|info|warning|err|notice|alert|crit|emerg|cont)|
Joe Perches8bbea962010-08-09 17:21:01 -0700198 (dev|netdev|netif)_(printk|dbg|vdbg|info|warn|err|notice|alert|crit|emerg|WARN)|
Joe Perches691e6692010-03-05 13:43:51 -0800199 WARN|
200 panic
201)};
202
Andy Whitcroft8905a672007-11-28 16:21:06 -0800203our @typeList = (
204 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700205 qr{(?:unsigned\s+)?char},
206 qr{(?:unsigned\s+)?short},
207 qr{(?:unsigned\s+)?int},
208 qr{(?:unsigned\s+)?long},
209 qr{(?:unsigned\s+)?long\s+int},
210 qr{(?:unsigned\s+)?long\s+long},
211 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800212 qr{unsigned},
213 qr{float},
214 qr{double},
215 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800216 qr{struct\s+$Ident},
217 qr{union\s+$Ident},
218 qr{enum\s+$Ident},
219 qr{${Ident}_t},
220 qr{${Ident}_handler},
221 qr{${Ident}_handler_fn},
222);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700223our @modifierList = (
224 qr{fastcall},
225);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800226
Wolfram Sang7840a942010-08-09 17:20:57 -0700227our $allowed_asm_includes = qr{(?x:
228 irq|
229 memory
230)};
231# memory.h: ARM has a custom one
232
Andy Whitcroft8905a672007-11-28 16:21:06 -0800233sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700234 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
235 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700236 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800237 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700238 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800239 (?:
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700240 (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700241 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700242 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800243 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700244 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800245 }x;
246 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700247 $NonptrType
Andy Whitcroft65863862009-01-06 14:41:21 -0800248 (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700249 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800250 }x;
251 $Declare = qr{(?:$Storage\s+)?$Type};
252}
253build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700254
255$chk_signoff = 0 if ($file);
256
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700257my @dep_includes = ();
258my @dep_functions = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700259my $removal = "Documentation/feature-removal-schedule.txt";
260if ($tree && -f "$root/$removal") {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800261 open(my $REMOVE, '<', "$root/$removal") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700262 die "$P: $removal: open failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800263 while (<$REMOVE>) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700264 if (/^Check:\s+(.*\S)/) {
265 for my $entry (split(/[, ]+/, $1)) {
266 if ($entry =~ m@include/(.*)@) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700267 push(@dep_includes, $1);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700268
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700269 } elsif ($entry !~ m@/@) {
270 push(@dep_functions, $entry);
271 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700272 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700273 }
274 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800275 close($REMOVE);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700276}
277
Andy Whitcroft00df3442007-06-08 13:47:06 -0700278my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800279my @lines = ();
280my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700281for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800282 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700283 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800284 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700285 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800286 } elsif ($filename eq '-') {
287 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700288 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800289 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700290 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700291 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800292 if ($filename eq '-') {
293 $vname = 'Your patch';
294 } else {
295 $vname = $filename;
296 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800297 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700298 chomp;
299 push(@rawlines, $_);
300 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800301 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800302 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700303 $exit = 1;
304 }
305 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800306 @lines = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700307}
308
309exit($exit);
310
311sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700312 my ($root) = @_;
313
314 my @tree_check = (
315 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
316 "README", "Documentation", "arch", "include", "drivers",
317 "fs", "init", "ipc", "kernel", "lib", "scripts",
318 );
319
320 foreach my $check (@tree_check) {
321 if (! -e $root . '/' . $check) {
322 return 0;
323 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700324 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700325 return 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700326}
327
328sub expand_tabs {
329 my ($str) = @_;
330
331 my $res = '';
332 my $n = 0;
333 for my $c (split(//, $str)) {
334 if ($c eq "\t") {
335 $res .= ' ';
336 $n++;
337 for (; ($n % 8) != 0; $n++) {
338 $res .= ' ';
339 }
340 next;
341 }
342 $res .= $c;
343 $n++;
344 }
345
346 return $res;
347}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700348sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700349 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700350 return $res;
351}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700352
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700353sub line_stats {
354 my ($line) = @_;
355
356 # Drop the diff line leader and expand tabs
357 $line =~ s/^.//;
358 $line = expand_tabs($line);
359
360 # Pick the indent from the front of the line.
361 my ($white) = ($line =~ /^(\s*)/);
362
363 return (length($line), length($white));
364}
365
Andy Whitcroft773647a2008-03-28 14:15:58 -0700366my $sanitise_quote = '';
367
368sub sanitise_line_reset {
369 my ($in_comment) = @_;
370
371 if ($in_comment) {
372 $sanitise_quote = '*/';
373 } else {
374 $sanitise_quote = '';
375 }
376}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700377sub sanitise_line {
378 my ($line) = @_;
379
380 my $res = '';
381 my $l = '';
382
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800383 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700384 my $off = 0;
385 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700386
Andy Whitcroft773647a2008-03-28 14:15:58 -0700387 # Always copy over the diff marker.
388 $res = substr($line, 0, 1);
389
390 for ($off = 1; $off < length($line); $off++) {
391 $c = substr($line, $off, 1);
392
393 # Comments we are wacking completly including the begin
394 # and end, all to $;.
395 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
396 $sanitise_quote = '*/';
397
398 substr($res, $off, 2, "$;$;");
399 $off++;
400 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800401 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700402 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700403 $sanitise_quote = '';
404 substr($res, $off, 2, "$;$;");
405 $off++;
406 next;
407 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700408 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
409 $sanitise_quote = '//';
410
411 substr($res, $off, 2, $sanitise_quote);
412 $off++;
413 next;
414 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700415
416 # A \ in a string means ignore the next character.
417 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
418 $c eq "\\") {
419 substr($res, $off, 2, 'XX');
420 $off++;
421 next;
422 }
423 # Regular quotes.
424 if ($c eq "'" || $c eq '"') {
425 if ($sanitise_quote eq '') {
426 $sanitise_quote = $c;
427
428 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700429 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700430 } elsif ($sanitise_quote eq $c) {
431 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700432 }
433 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700434
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800435 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700436 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
437 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700438 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
439 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700440 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
441 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700442 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700443 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700444 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800445 }
446
Daniel Walker113f04a2009-09-21 17:04:35 -0700447 if ($sanitise_quote eq '//') {
448 $sanitise_quote = '';
449 }
450
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800451 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700452 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800453 my $clean = 'X' x length($1);
454 $res =~ s@\<.*\>@<$clean>@;
455
456 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700457 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800458 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700459 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800460 }
461
Andy Whitcroft00df3442007-06-08 13:47:06 -0700462 return $res;
463}
464
Andy Whitcroft8905a672007-11-28 16:21:06 -0800465sub ctx_statement_block {
466 my ($linenr, $remain, $off) = @_;
467 my $line = $linenr - 1;
468 my $blk = '';
469 my $soff = $off;
470 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700471 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800472
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800473 my $loff = 0;
474
Andy Whitcroft8905a672007-11-28 16:21:06 -0800475 my $type = '';
476 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800477 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800478 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800479 my $c;
480 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800481
482 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800483 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800484 @stack = (['', 0]) if ($#stack == -1);
485
Andy Whitcroft773647a2008-03-28 14:15:58 -0700486 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800487 # If we are about to drop off the end, pull in more
488 # context.
489 if ($off >= $len) {
490 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700491 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800492 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800493 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800494 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800495 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800496 $len = length($blk);
497 $line++;
498 last;
499 }
500 # Bail if there is no further context.
501 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800502 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800503 last;
504 }
505 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800506 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800507 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800508 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800509
Andy Whitcroft773647a2008-03-28 14:15:58 -0700510 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800511
512 # Handle nested #if/#else.
513 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
514 push(@stack, [ $type, $level ]);
515 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
516 ($type, $level) = @{$stack[$#stack - 1]};
517 } elsif ($remainder =~ /^#\s*endif\b/) {
518 ($type, $level) = @{pop(@stack)};
519 }
520
Andy Whitcroft8905a672007-11-28 16:21:06 -0800521 # Statement ends at the ';' or a close '}' at the
522 # outermost level.
523 if ($level == 0 && $c eq ';') {
524 last;
525 }
526
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800527 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700528 if ($level == 0 && $coff_set == 0 &&
529 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
530 $remainder =~ /^(else)(?:\s|{)/ &&
531 $remainder !~ /^else\s+if\b/) {
532 $coff = $off + length($1) - 1;
533 $coff_set = 1;
534 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
535 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800536 }
537
Andy Whitcroft8905a672007-11-28 16:21:06 -0800538 if (($type eq '' || $type eq '(') && $c eq '(') {
539 $level++;
540 $type = '(';
541 }
542 if ($type eq '(' && $c eq ')') {
543 $level--;
544 $type = ($level != 0)? '(' : '';
545
546 if ($level == 0 && $coff < $soff) {
547 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700548 $coff_set = 1;
549 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800550 }
551 }
552 if (($type eq '' || $type eq '{') && $c eq '{') {
553 $level++;
554 $type = '{';
555 }
556 if ($type eq '{' && $c eq '}') {
557 $level--;
558 $type = ($level != 0)? '{' : '';
559
560 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -0700561 if (substr($blk, $off + 1, 1) eq ';') {
562 $off++;
563 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800564 last;
565 }
566 }
567 $off++;
568 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700569 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800570 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700571 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800572 $line++;
573 $remain--;
574 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800575
576 my $statement = substr($blk, $soff, $off - $soff + 1);
577 my $condition = substr($blk, $soff, $coff - $soff + 1);
578
579 #warn "STATEMENT<$statement>\n";
580 #warn "CONDITION<$condition>\n";
581
Andy Whitcroft773647a2008-03-28 14:15:58 -0700582 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800583
584 return ($statement, $condition,
585 $line, $remain + 1, $off - $loff + 1, $level);
586}
587
Andy Whitcroftcf655042008-03-04 14:28:20 -0800588sub statement_lines {
589 my ($stmt) = @_;
590
591 # Strip the diff line prefixes and rip blank lines at start and end.
592 $stmt =~ s/(^|\n)./$1/g;
593 $stmt =~ s/^\s*//;
594 $stmt =~ s/\s*$//;
595
596 my @stmt_lines = ($stmt =~ /\n/g);
597
598 return $#stmt_lines + 2;
599}
600
601sub statement_rawlines {
602 my ($stmt) = @_;
603
604 my @stmt_lines = ($stmt =~ /\n/g);
605
606 return $#stmt_lines + 2;
607}
608
609sub statement_block_size {
610 my ($stmt) = @_;
611
612 $stmt =~ s/(^|\n)./$1/g;
613 $stmt =~ s/^\s*{//;
614 $stmt =~ s/}\s*$//;
615 $stmt =~ s/^\s*//;
616 $stmt =~ s/\s*$//;
617
618 my @stmt_lines = ($stmt =~ /\n/g);
619 my @stmt_statements = ($stmt =~ /;/g);
620
621 my $stmt_lines = $#stmt_lines + 2;
622 my $stmt_statements = $#stmt_statements + 1;
623
624 if ($stmt_lines > $stmt_statements) {
625 return $stmt_lines;
626 } else {
627 return $stmt_statements;
628 }
629}
630
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800631sub ctx_statement_full {
632 my ($linenr, $remain, $off) = @_;
633 my ($statement, $condition, $level);
634
635 my (@chunks);
636
Andy Whitcroftcf655042008-03-04 14:28:20 -0800637 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800638 ($statement, $condition, $linenr, $remain, $off, $level) =
639 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700640 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800641 push(@chunks, [ $condition, $statement ]);
642 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
643 return ($level, $linenr, @chunks);
644 }
645
646 # Pull in the following conditional/block pairs and see if they
647 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800648 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800649 ($statement, $condition, $linenr, $remain, $off, $level) =
650 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800651 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700652 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800653 #print "C: push\n";
654 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800655 }
656
657 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800658}
659
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700660sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700661 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700662 my $line;
663 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700664 my $blk = '';
665 my @o;
666 my @c;
667 my @res = ();
668
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700669 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800670 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700671 for ($line = $start; $remain > 0; $line++) {
672 next if ($rawlines[$line] =~ /^-/);
673 $remain--;
674
675 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800676
677 # Handle nested #if/#else.
678 if ($rawlines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
679 push(@stack, $level);
680 } elsif ($rawlines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
681 $level = $stack[$#stack - 1];
682 } elsif ($rawlines[$line] =~ /^.\s*#\s*endif\b/) {
683 $level = pop(@stack);
684 }
685
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700686 foreach my $c (split(//, $rawlines[$line])) {
687 ##print "C<$c>L<$level><$open$close>O<$off>\n";
688 if ($off > 0) {
689 $off--;
690 next;
691 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700692
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700693 if ($c eq $close && $level > 0) {
694 $level--;
695 last if ($level == 0);
696 } elsif ($c eq $open) {
697 $level++;
698 }
699 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700700
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700701 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700702 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700703 }
704
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700705 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700706 }
707
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700708 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700709}
710sub ctx_block_outer {
711 my ($linenr, $remain) = @_;
712
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700713 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
714 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700715}
716sub ctx_block {
717 my ($linenr, $remain) = @_;
718
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700719 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
720 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700721}
722sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700723 my ($linenr, $remain, $off) = @_;
724
725 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
726 return @r;
727}
728sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700729 my ($linenr, $remain) = @_;
730
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700731 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700732}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700733sub ctx_statement_level {
734 my ($linenr, $remain, $off) = @_;
735
736 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
737}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700738
739sub ctx_locate_comment {
740 my ($first_line, $end_line) = @_;
741
742 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700743 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700744 return $current_comment if (defined $current_comment);
745
746 # Look through the context and try and figure out if there is a
747 # comment.
748 my $in_comment = 0;
749 $current_comment = '';
750 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700751 my $line = $rawlines[$linenr - 1];
752 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700753 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
754 $in_comment = 1;
755 }
756 if ($line =~ m@/\*@) {
757 $in_comment = 1;
758 }
759 if (!$in_comment && $current_comment ne '') {
760 $current_comment = '';
761 }
762 $current_comment .= $line . "\n" if ($in_comment);
763 if ($line =~ m@\*/@) {
764 $in_comment = 0;
765 }
766 }
767
768 chomp($current_comment);
769 return($current_comment);
770}
771sub ctx_has_comment {
772 my ($first_line, $end_line) = @_;
773 my $cmt = ctx_locate_comment($first_line, $end_line);
774
Andy Whitcroft00df3442007-06-08 13:47:06 -0700775 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700776 ##print "CMMT: $cmt\n";
777
778 return ($cmt ne '');
779}
780
Andy Whitcroft4d001e42008-10-15 22:02:21 -0700781sub raw_line {
782 my ($linenr, $cnt) = @_;
783
784 my $offset = $linenr - 1;
785 $cnt++;
786
787 my $line;
788 while ($cnt) {
789 $line = $rawlines[$offset++];
790 next if (defined($line) && $line =~ /^-/);
791 $cnt--;
792 }
793
794 return $line;
795}
796
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700797sub cat_vet {
798 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700799 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700800
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700801 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700802 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
803 $res .= $1;
804 if ($2 ne '') {
805 $coded = sprintf("^%c", unpack('C', $2) + 64);
806 $res .= $coded;
807 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700808 }
809 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700810
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700811 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700812}
813
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800814my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800815my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800816my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700817my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800818
819sub annotate_reset {
820 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800821 $av_pending = '_';
822 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700823 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800824}
825
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700826sub annotate_values {
827 my ($stream, $type) = @_;
828
829 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700830 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700831 my $cur = $stream;
832
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800833 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700834
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700835 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700836 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800837 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700838 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700839 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800840 print "WS($1)\n" if ($dbg_values > 1);
841 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800842 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800843 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700844 }
845
Andy Whitcroft8ea3eb92008-07-23 21:29:08 -0700846 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800847 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700848 $type = 'T';
849
Andy Whitcroft389a2fe2008-07-23 21:29:05 -0700850 } elsif ($cur =~ /^($Modifier)\s*/) {
851 print "MODIFIER($1)\n" if ($dbg_values > 1);
852 $type = 'T';
853
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700854 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700855 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800856 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700857 push(@av_paren_type, $type);
858 if ($2 ne '') {
859 $av_pending = 'N';
860 }
861 $type = 'E';
862
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700863 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700864 print "UNDEF($1)\n" if ($dbg_values > 1);
865 $av_preprocessor = 1;
866 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700867
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700868 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800869 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800870 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800871
872 push(@av_paren_type, $type);
873 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700874 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800875
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700876 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800877 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
878 $av_preprocessor = 1;
879
880 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
881
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700882 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800883
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700884 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800885 print "PRE_END($1)\n" if ($dbg_values > 1);
886
887 $av_preprocessor = 1;
888
889 # Assume all arms of the conditional end as this
890 # one does, and continue as if the #endif was not here.
891 pop(@av_paren_type);
892 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700893 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700894
895 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800896 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700897
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700898 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
899 print "ATTR($1)\n" if ($dbg_values > 1);
900 $av_pending = $type;
901 $type = 'N';
902
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700903 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800904 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700905 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800906 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700907 }
908 $type = 'N';
909
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700910 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800911 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700912 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700913 $type = 'N';
914
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700915 } elsif ($cur =~/^(case)/o) {
916 print "CASE($1)\n" if ($dbg_values > 1);
917 $av_pend_colon = 'C';
918 $type = 'N';
919
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700920 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800921 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700922 $type = 'N';
923
924 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800925 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800926 push(@av_paren_type, $av_pending);
927 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700928 $type = 'N';
929
930 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800931 my $new_type = pop(@av_paren_type);
932 if ($new_type ne '_') {
933 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800934 print "PAREN('$1') -> $type\n"
935 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700936 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800937 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700938 }
939
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700940 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800941 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700942 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800943 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700944
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800945 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
946 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700947 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800948 } elsif ($type eq 'E') {
949 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700950 }
951 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
952 $type = 'V';
953
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700954 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800955 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700956 $type = 'V';
957
958 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800959 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700960 $type = 'N';
961
Andy Whitcroftcf655042008-03-04 14:28:20 -0800962 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800963 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800964 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700965 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800966
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800967 } elsif ($cur =~/^(,)/) {
968 print "COMMA($1)\n" if ($dbg_values > 1);
969 $type = 'C';
970
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700971 } elsif ($cur =~ /^(\?)/o) {
972 print "QUESTION($1)\n" if ($dbg_values > 1);
973 $type = 'N';
974
975 } elsif ($cur =~ /^(:)/o) {
976 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
977
978 substr($var, length($res), 1, $av_pend_colon);
979 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
980 $type = 'E';
981 } else {
982 $type = 'N';
983 }
984 $av_pend_colon = 'O';
985
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800986 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800987 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700988 $type = 'N';
989
Andy Whitcroft0d413862008-10-15 22:02:16 -0700990 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -0700991 my $variant;
992
993 print "OPV($1)\n" if ($dbg_values > 1);
994 if ($type eq 'V') {
995 $variant = 'B';
996 } else {
997 $variant = 'U';
998 }
999
1000 substr($var, length($res), 1, $variant);
1001 $type = 'N';
1002
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001003 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001004 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001005 if ($1 ne '++' && $1 ne '--') {
1006 $type = 'N';
1007 }
1008
1009 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001010 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001011 }
1012 if (defined $1) {
1013 $cur = substr($cur, length($1));
1014 $res .= $type x length($1);
1015 }
1016 }
1017
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001018 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001019}
1020
Andy Whitcroft8905a672007-11-28 16:21:06 -08001021sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001022 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001023 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001024 ^(?:
1025 $Modifier|
1026 $Storage|
1027 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001028 DEFINE_\S+
1029 )$|
1030 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001031 goto|
1032 return|
1033 case|
1034 else|
1035 asm|__asm__|
1036 do
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001037 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001038 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001039 )}x;
1040 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1041 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001042 # Check for modifiers.
1043 $possible =~ s/\s*$Storage\s*//g;
1044 $possible =~ s/\s*$Sparse\s*//g;
1045 if ($possible =~ /^\s*$/) {
1046
1047 } elsif ($possible =~ /\s/) {
1048 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001049 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001050 if ($modifier !~ $notPermitted) {
1051 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1052 push(@modifierList, $modifier);
1053 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001054 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001055
1056 } else {
1057 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1058 push(@typeList, $possible);
1059 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001060 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001061 } else {
1062 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001063 }
1064}
1065
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001066my $prefix = '';
1067
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001068sub report {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001069 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
1070 return 0;
1071 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001072 my $line = $prefix . $_[0];
1073
1074 $line = (split('\n', $line))[0] . "\n" if ($terse);
1075
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001076 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001077
1078 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001079}
1080sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001081 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001082}
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001083sub ERROR {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001084 if (report("ERROR: $_[0]\n")) {
1085 our $clean = 0;
1086 our $cnt_error++;
1087 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001088}
1089sub WARN {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001090 if (report("WARNING: $_[0]\n")) {
1091 our $clean = 0;
1092 our $cnt_warn++;
1093 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001094}
1095sub CHK {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001096 if ($check && report("CHECK: $_[0]\n")) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001097 our $clean = 0;
1098 our $cnt_chk++;
1099 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001100}
1101
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001102sub check_absolute_file {
1103 my ($absolute, $herecurr) = @_;
1104 my $file = $absolute;
1105
1106 ##print "absolute<$absolute>\n";
1107
1108 # See if any suffix of this path is a path within the tree.
1109 while ($file =~ s@^[^/]*/@@) {
1110 if (-f "$root/$file") {
1111 ##print "file<$file>\n";
1112 last;
1113 }
1114 }
1115 if (! -f _) {
1116 return 0;
1117 }
1118
1119 # It is, so see if the prefix is acceptable.
1120 my $prefix = $absolute;
1121 substr($prefix, -length($file)) = '';
1122
1123 ##print "prefix<$prefix>\n";
1124 if ($prefix ne ".../") {
1125 WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr);
1126 }
1127}
1128
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001129sub process {
1130 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001131
1132 my $linenr=0;
1133 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001134 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001135 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001136 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001137
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001138 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001139 my $indent;
1140 my $previndent=0;
1141 my $stashindent=0;
1142
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001143 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001144 my $signoff = 0;
1145 my $is_patch = 0;
1146
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001147 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001148 our $cnt_lines = 0;
1149 our $cnt_error = 0;
1150 our $cnt_warn = 0;
1151 our $cnt_chk = 0;
1152
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001153 # Trace the real file/line as we go.
1154 my $realfile = '';
1155 my $realline = 0;
1156 my $realcnt = 0;
1157 my $here = '';
1158 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001159 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001160 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001161 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001162
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001163 my $prev_values = 'E';
1164
1165 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001166 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001167 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001168 my %suppress_export;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001169
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001170 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001171 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001172 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001173 my @setup_docs = ();
1174 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001175
1176 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001177 my $line;
1178 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001179 $linenr++;
1180 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001181
Andy Whitcroft773647a2008-03-28 14:15:58 -07001182 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001183 $setup_docs = 0;
1184 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1185 $setup_docs = 1;
1186 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001187 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001188 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001189 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1190 $realline=$1-1;
1191 if (defined $2) {
1192 $realcnt=$3+1;
1193 } else {
1194 $realcnt=1+1;
1195 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001196 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001197
1198 # Guestimate if this is a continuing comment. Run
1199 # the context looking for a comment "edge". If this
1200 # edge is a close comment then we must be in a comment
1201 # at context start.
1202 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001203 my $cnt = $realcnt;
1204 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1205 next if (defined $rawlines[$ln - 1] &&
1206 $rawlines[$ln - 1] =~ /^-/);
1207 $cnt--;
1208 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001209 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001210 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1211 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1212 ($edge) = $1;
1213 last;
1214 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001215 }
1216 if (defined $edge && $edge eq '*/') {
1217 $in_comment = 1;
1218 }
1219
1220 # Guestimate if this is a continuing comment. If this
1221 # is the start of a diff block and this line starts
1222 # ' *' then it is very likely a comment.
1223 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001224 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001225 {
1226 $in_comment = 1;
1227 }
1228
1229 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1230 sanitise_line_reset($in_comment);
1231
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001232 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001233 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001234 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001235 $line = sanitise_line($rawline);
1236 }
1237 push(@lines, $line);
1238
1239 if ($realcnt > 1) {
1240 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1241 } else {
1242 $realcnt = 0;
1243 }
1244
1245 #print "==>$rawline\n";
1246 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001247
1248 if ($setup_docs && $line =~ /^\+/) {
1249 push(@setup_docs, $line);
1250 }
1251 }
1252
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001253 $prefix = '';
1254
Andy Whitcroft773647a2008-03-28 14:15:58 -07001255 $realcnt = 0;
1256 $linenr = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001257 foreach my $line (@lines) {
1258 $linenr++;
1259
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001260 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001261
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001262#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001263 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001264 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001265 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001266 $realline=$1-1;
1267 if (defined $2) {
1268 $realcnt=$3+1;
1269 } else {
1270 $realcnt=1+1;
1271 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001272 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001273 $prev_values = 'E';
1274
Andy Whitcroft773647a2008-03-28 14:15:58 -07001275 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001276 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001277 %suppress_export = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001278 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001279
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001280# track the line number as we move through the hunk, note that
1281# new versions of GNU diff omit the leading space on completely
1282# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001283 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001284 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001285 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001286
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001287 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001288 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001289
1290 # Track the previous line.
1291 ($prevline, $stashline) = ($stashline, $line);
1292 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001293 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1294
Andy Whitcroft773647a2008-03-28 14:15:58 -07001295 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001296
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001297 } elsif ($realcnt == 1) {
1298 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001299 }
1300
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001301 my $hunk_line = ($realcnt != 0);
1302
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001303#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001304 $prefix = "$filename:$realline: " if ($emacs && $file);
1305 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1306
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001307 $here = "#$linenr: " if (!$file);
1308 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001309
1310 # extract the filename as it passes
1311 if ($line=~/^\+\+\+\s+(\S+)/) {
1312 $realfile = $1;
Wolfram Sang1e855722009-01-06 14:41:24 -08001313 $realfile =~ s@^([^/]*)/@@;
1314
1315 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001316 if (!$file && $tree && $p1_prefix ne '' &&
1317 -e "$root/$p1_prefix") {
Wolfram Sang1e855722009-01-06 14:41:24 -08001318 WARN("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1319 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001320
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001321 if ($realfile =~ m@^include/asm/@) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001322 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1323 }
1324 next;
1325 }
1326
Randy Dunlap389834b2007-06-08 13:47:03 -07001327 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001328
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001329 my $hereline = "$here\n$rawline\n";
1330 my $herecurr = "$here\n$rawline\n";
1331 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001332
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001333 $cnt_lines++ if ($realcnt != 0);
1334
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001335#check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001336 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001337 # This is a signoff, if ugly, so do not double report.
1338 $signoff++;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001339 if (!($line =~ /^\s*Signed-off-by:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001340 WARN("Signed-off-by: is the preferred form\n" .
1341 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001342 }
1343 if ($line =~ /^\s*signed-off-by:\S/i) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001344 WARN("space required after Signed-off-by:\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001345 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001346 }
1347 }
1348
Andy Whitcroft00df3442007-06-08 13:47:06 -07001349# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001350 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001351 ERROR("patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001352 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001353 }
1354
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001355# Check for absolute kernel paths.
1356 if ($tree) {
1357 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1358 my $file = $1;
1359
1360 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1361 check_absolute_file($1, $herecurr)) {
1362 #
1363 } else {
1364 check_absolute_file($file, $herecurr);
1365 }
1366 }
1367 }
1368
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001369# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1370 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001371 $rawline !~ m/^$UTF8*$/) {
1372 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1373
1374 my $blank = copy_spacing($rawline);
1375 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1376 my $hereptr = "$hereline$ptr\n";
1377
1378 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001379 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001380
Andy Whitcroft306708542008-10-15 22:02:28 -07001381# ignore non-hunk lines and lines being removed
1382 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001383
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001384#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001385 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001386 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001387 ERROR("DOS line endings\n" . $herevet);
1388
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001389 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1390 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001391 ERROR("trailing whitespace\n" . $herevet);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001392 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07001393
Andi Kleen33549572010-05-24 14:33:29 -07001394# check for Kconfig help text having a real description
1395 if ($realfile =~ /Kconfig/ &&
1396 $line =~ /\+?\s*(---)?help(---)?$/) {
1397 my $length = 0;
1398 for (my $l = $linenr; defined($lines[$l]); $l++) {
1399 my $f = $lines[$l];
1400 $f =~ s/#.*//;
1401 $f =~ s/^\s+//;
1402 next if ($f =~ /^$/);
1403 last if ($f =~ /^\s*config\s/);
1404 $length++;
1405 }
1406 WARN("please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($length < 4);
1407 }
1408
Andy Whitcroft5368df22008-10-15 22:02:27 -07001409# check we are in a valid source file if not then ignore this hunk
1410 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1411
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001412#80 column limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001413 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001414 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches8bbea962010-08-09 17:21:01 -07001415 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ ||
1416 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001417 $length > 80)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001418 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001419 WARN("line over 80 characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001420 }
1421
Joe Perches5e79d962010-03-05 13:43:55 -08001422# check for spaces before a quoted newline
1423 if ($rawline =~ /^.*\".*\s\\n/) {
1424 WARN("unnecessary whitespace before a quoted newline\n" . $herecurr);
1425 }
1426
Andy Whitcroft8905a672007-11-28 16:21:06 -08001427# check for adding lines without a newline.
1428 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1429 WARN("adding a line without newline at end of file\n" . $herecurr);
1430 }
1431
Mike Frysinger42e41c52009-09-21 17:04:40 -07001432# Blackfin: use hi/lo macros
1433 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1434 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1435 my $herevet = "$here\n" . cat_vet($line) . "\n";
1436 ERROR("use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
1437 }
1438 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1439 my $herevet = "$here\n" . cat_vet($line) . "\n";
1440 ERROR("use the HI() macro, not (... >> 16)\n" . $herevet);
1441 }
1442 }
1443
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001444# check we are in a valid source file C or perl if not then ignore this hunk
1445 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001446
1447# at the beginning of a line any tabs must come first and anything
1448# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001449 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1450 $rawline =~ /^\+\s* \s*/) {
1451 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001452 ERROR("code indent should use tabs where possible\n" . $herevet);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001453 }
1454
Alberto Panizzo08e44362010-03-05 13:43:54 -08001455# check for space before tabs.
1456 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1457 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1458 WARN("please, no space before tabs\n" . $herevet);
1459 }
1460
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001461# check for spaces at the beginning of a line.
1462 if ($rawline =~ /^\+ / && $rawline !~ /\+ +\*/) {
1463 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1464 WARN("please, no space for starting a line, \
1465 excluding comments\n" . $herevet);
1466 }
1467
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001468# check we are in a valid C source file if not then ignore this hunk
1469 next if ($realfile !~ /\.(h|c)$/);
1470
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001471# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001472 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001473 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1474 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001475
Mike Frysinger42e41c52009-09-21 17:04:40 -07001476# Blackfin: don't use __builtin_bfin_[cs]sync
1477 if ($line =~ /__builtin_bfin_csync/) {
1478 my $herevet = "$here\n" . cat_vet($line) . "\n";
1479 ERROR("use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
1480 }
1481 if ($line =~ /__builtin_bfin_ssync/) {
1482 my $herevet = "$here\n" . cat_vet($line) . "\n";
1483 ERROR("use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
1484 }
1485
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001486# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001487 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1488 $realline_next);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001489 if ($realcnt && $line =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001490 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001491 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001492 $stat =~ s/\n./\n /g;
1493 $cond =~ s/\n./\n /g;
1494
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001495 # Find the real next line.
1496 $realline_next = $line_nr_next;
1497 if (defined $realline_next &&
1498 (!defined $lines[$realline_next - 1] ||
1499 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1500 $realline_next++;
1501 }
1502
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001503 my $s = $stat;
1504 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001505
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001506 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001507 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001508
1509 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001510 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001511
Andy Whitcroft463f2862009-09-21 17:04:34 -07001512 } elsif ($s =~ /^.\s*else\b/s) {
1513
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001514 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001515 } 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 -07001516 my $type = $1;
1517 $type =~ s/\s+/ /g;
1518 possible($type, "A:" . $s);
1519
Andy Whitcroft8905a672007-11-28 16:21:06 -08001520 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07001521 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001522 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001523 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001524
1525 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08001526 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001527 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001528 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001529
1530 # Check for any sort of function declaration.
1531 # int foo(something bar, other baz);
1532 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001533 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 -08001534 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001535
Andy Whitcroftcf655042008-03-04 14:28:20 -08001536 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001537 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001538 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001539
Andy Whitcroft8905a672007-11-28 16:21:06 -08001540 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001541 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001542
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001543 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001544 }
1545 }
1546 }
1547
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001548 }
1549
Andy Whitcroft653d4872007-06-23 17:16:34 -07001550#
1551# Checks which may be anchored in the context.
1552#
1553
1554# Check for switch () and associated case and default
1555# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07001556 if ($line=~/\bswitch\s*\(.*\)/) {
1557 my $err = '';
1558 my $sep = '';
1559 my @ctx = ctx_block_outer($linenr, $realcnt);
1560 shift(@ctx);
1561 for my $ctx (@ctx) {
1562 my ($clen, $cindent) = line_stats($ctx);
1563 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1564 $indent != $cindent) {
1565 $err .= "$sep$ctx\n";
1566 $sep = '';
1567 } else {
1568 $sep = "[...]\n";
1569 }
1570 }
1571 if ($err ne '') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001572 ERROR("switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001573 }
1574 }
1575
1576# if/while/etc brace do not go on next line, unless defining a do while loop,
1577# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001578 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001579 my $pre_ctx = "$1$2";
1580
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001581 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001582 my $ctx_cnt = $realcnt - $#ctx - 1;
1583 my $ctx = join("\n", @ctx);
1584
Andy Whitcroft548596d2008-07-23 21:29:01 -07001585 my $ctx_ln = $linenr;
1586 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001587
Andy Whitcroft548596d2008-07-23 21:29:01 -07001588 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1589 defined $lines[$ctx_ln - 1] &&
1590 $lines[$ctx_ln - 1] =~ /^-/)) {
1591 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1592 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001593 $ctx_ln++;
1594 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07001595
Andy Whitcroft53210162008-07-23 21:29:03 -07001596 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1597 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001598
1599 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1600 ERROR("that open brace { should be on the previous line\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001601 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07001602 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001603 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1604 $ctx =~ /\)\s*\;\s*$/ &&
1605 defined $lines[$ctx_ln - 1])
1606 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001607 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1608 if ($nindent > $indent) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001609 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001610 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001611 }
1612 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001613 }
1614
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001615# Check relative indent for conditionals and blocks.
1616 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1617 my ($s, $c) = ($stat, $cond);
1618
1619 substr($s, 0, length($c), '');
1620
1621 # Make sure we remove the line prefixes as we have
1622 # none on the first line, and are going to readd them
1623 # where necessary.
1624 $s =~ s/\n./\n/gs;
1625
1626 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07001627 my @newlines = ($c =~ /\n/gs);
1628 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001629
1630 # We want to check the first line inside the block
1631 # starting at the end of the conditional, so remove:
1632 # 1) any blank line termination
1633 # 2) any opening brace { on end of the line
1634 # 3) any do (...) {
1635 my $continuation = 0;
1636 my $check = 0;
1637 $s =~ s/^.*\bdo\b//;
1638 $s =~ s/^\s*{//;
1639 if ($s =~ s/^\s*\\//) {
1640 $continuation = 1;
1641 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001642 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001643 $check = 1;
1644 $cond_lines++;
1645 }
1646
1647 # Also ignore a loop construct at the end of a
1648 # preprocessor statement.
1649 if (($prevline =~ /^.\s*#\s*define\s/ ||
1650 $prevline =~ /\\\s*$/) && $continuation == 0) {
1651 $check = 0;
1652 }
1653
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001654 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07001655 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001656 while ($cond_ptr != $cond_lines) {
1657 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001658
Andy Whitcroftf16fa282008-10-15 22:02:32 -07001659 # If we see an #else/#elif then the code
1660 # is not linear.
1661 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1662 $check = 0;
1663 }
1664
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001665 # Ignore:
1666 # 1) blank lines, they should be at 0,
1667 # 2) preprocessor lines, and
1668 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07001669 if ($continuation ||
1670 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001671 $s =~ /^\s*#\s*?/ ||
1672 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07001673 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07001674 if ($s =~ s/^.*?\n//) {
1675 $cond_lines++;
1676 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001677 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001678 }
1679
1680 my (undef, $sindent) = line_stats("+" . $s);
1681 my $stat_real = raw_line($linenr, $cond_lines);
1682
1683 # Check if either of these lines are modified, else
1684 # this is not this patch's fault.
1685 if (!defined($stat_real) ||
1686 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1687 $check = 0;
1688 }
1689 if (defined($stat_real) && $cond_lines > 1) {
1690 $stat_real = "[...]\n$stat_real";
1691 }
1692
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001693 #print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s> cond_lines<$cond_lines> stat_real<$stat_real> stat<$stat>\n";
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001694
1695 if ($check && (($sindent % 8) != 0 ||
1696 ($sindent <= $indent && $s ne ''))) {
1697 WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1698 }
1699 }
1700
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001701 # Track the 'values' across context and added lines.
1702 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001703 my ($curr_values, $curr_vars) =
1704 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001705 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001706 if ($dbg_values) {
1707 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001708 print "$linenr > .$outline\n";
1709 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001710 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001711 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001712 $prev_values = substr($curr_values, -1);
1713
Andy Whitcroft00df3442007-06-08 13:47:06 -07001714#ignore lines not being added
1715 if ($line=~/^[^\+]/) {next;}
1716
Andy Whitcroft653d4872007-06-23 17:16:34 -07001717# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07001718 if ($dbg_type) {
1719 if ($line =~ /^.\s*$Declare\s*$/) {
1720 ERROR("TEST: is type\n" . $herecurr);
1721 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1722 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1723 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001724 next;
1725 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001726# TEST: allow direct testing of the attribute matcher.
1727 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08001728 if ($line =~ /^.\s*$Modifier\s*$/) {
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001729 ERROR("TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08001730 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001731 ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1732 }
1733 next;
1734 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001735
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001736# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07001737 if ($line =~ /^.\s*{/ &&
1738 $prevline =~ /(?:^|[^=])=\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001739 ERROR("that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001740 }
1741
Andy Whitcroft653d4872007-06-23 17:16:34 -07001742#
1743# Checks which are anchored on the added line.
1744#
1745
1746# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001747 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001748 my $path = $1;
1749 if ($path =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001750 ERROR("malformed #include filename\n" .
1751 $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001752 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001753 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001754
1755# no C99 // comments
1756 if ($line =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001757 ERROR("do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001758 }
1759 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001760 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001761 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001762
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001763# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
1764# the whole statement.
1765#print "APW <$lines[$realline_next - 1]>\n";
1766 if (defined $realline_next &&
1767 exists $lines[$realline_next - 1] &&
1768 !defined $suppress_export{$realline_next} &&
1769 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
1770 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001771 my $name = $1;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001772 if ($stat !~ /(?:
1773 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07001774 ^.DEFINE_$Ident\(\Q$name\E\)|
1775 ^.DECLARE_$Ident\(\Q$name\E\)|
1776 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001777 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
1778 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07001779 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001780#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
1781 $suppress_export{$realline_next} = 2;
1782 } else {
1783 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001784 }
1785 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001786 if (!defined $suppress_export{$linenr} &&
1787 $prevline =~ /^.\s*$/ &&
1788 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
1789 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1790#print "FOO B <$lines[$linenr - 1]>\n";
1791 $suppress_export{$linenr} = 2;
1792 }
1793 if (defined $suppress_export{$linenr} &&
1794 $suppress_export{$linenr} == 2) {
1795 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
1796 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001797
Joe Eloff5150bda2010-08-09 17:21:00 -07001798# check for global initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001799 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Joe Eloff5150bda2010-08-09 17:21:00 -07001800 ERROR("do not initialise globals to 0 or NULL\n" .
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001801 $herecurr);
1802 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001803# check for static initialisers.
Andy Whitcroft2d1bafd72009-01-06 14:41:28 -08001804 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001805 ERROR("do not initialise statics to 0 or NULL\n" .
1806 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001807 }
1808
Andy Whitcroft653d4872007-06-23 17:16:34 -07001809# check for new typedefs, only function parameters and sparse annotations
1810# make sense.
1811 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08001812 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001813 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07001814 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001815 $line !~ /\b__bitwise(?:__|)\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001816 WARN("do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001817 }
1818
1819# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08001820 # (char*[ const])
Andy Whitcroft00ef4ec2009-02-27 14:03:07 -08001821 if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001822 my ($from, $to) = ($1, $1);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001823
Andy Whitcroft65863862009-01-06 14:41:21 -08001824 # Should start with a space.
1825 $to =~ s/^(\S)/ $1/;
1826 # Should not end with a space.
1827 $to =~ s/\s+$//;
1828 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08001829 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001830 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001831
Andy Whitcroft65863862009-01-06 14:41:21 -08001832 #print "from<$from> to<$to>\n";
1833 if ($from ne $to) {
1834 ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
1835 }
Andy Whitcroft00ef4ec2009-02-27 14:03:07 -08001836 } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001837 my ($from, $to, $ident) = ($1, $1, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001838
Andy Whitcroft65863862009-01-06 14:41:21 -08001839 # Should start with a space.
1840 $to =~ s/^(\S)/ $1/;
1841 # Should not end with a space.
1842 $to =~ s/\s+$//;
1843 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08001844 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001845 }
1846 # Modifiers should have spaces.
1847 $to =~ s/(\b$Modifier$)/$1 /;
1848
Andy Whitcroft667026e2009-02-27 14:03:08 -08001849 #print "from<$from> to<$to> ident<$ident>\n";
1850 if ($from ne $to && $ident !~ /^$Modifier$/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001851 ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
1852 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001853 }
1854
1855# # no BUG() or BUG_ON()
1856# if ($line =~ /\b(BUG|BUG_ON)\b/) {
1857# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1858# print "$herecurr";
1859# $clean = 0;
1860# }
1861
Andy Whitcroft8905a672007-11-28 16:21:06 -08001862 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001863 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 -08001864 }
1865
Andy Whitcroft00df3442007-06-08 13:47:06 -07001866# printk should use KERN_* levels. Note that follow on printk's on the
1867# same line do not need a level, so we use the current block context
1868# to try and find and validate the current printk. In summary the current
1869# printk includes all preceeding printk's which have no newline on the end.
1870# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001871 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001872 my $ok = 0;
1873 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1874 #print "CHECK<$lines[$ln - 1]\n";
1875 # we have a preceeding printk if it ends
1876 # with "\n" ignore it, else it is to blame
1877 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1878 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1879 $ok = 1;
1880 }
1881 last;
1882 }
1883 }
1884 if ($ok == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001885 WARN("printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001886 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001887 }
1888
Andy Whitcroft653d4872007-06-23 17:16:34 -07001889# function brace can't be on same line, except for #defines of do while,
1890# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001891 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1892 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001893 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001894 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001895
Andy Whitcroft8905a672007-11-28 16:21:06 -08001896# open braces for enum, union and struct go on the same line.
1897 if ($line =~ /^.\s*{/ &&
1898 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1899 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1900 }
1901
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001902# check for spacing round square brackets; allowed:
1903# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001904# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1905# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001906 while ($line =~ /(.*?\s)\[/g) {
1907 my ($where, $prefix) = ($-[1], $1);
1908 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001909 ($where != 0 || $prefix !~ /^.\s+$/) &&
1910 $prefix !~ /{\s+$/) {
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001911 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1912 }
1913 }
1914
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001915# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001916 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001917 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001918 my $ctx_before = substr($line, 0, $-[1]);
1919 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001920
1921 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001922 if ($name =~ /^(?:
1923 if|for|while|switch|return|case|
1924 volatile|__volatile__|
1925 __attribute__|format|__extension__|
1926 asm|__asm__)$/x)
1927 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001928
1929 # cpp #define statements have non-optional spaces, ie
1930 # if there is a space between the name and the open
1931 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001932 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001933
1934 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001935 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001936
1937 # If this whole things ends with a type its most
1938 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001939 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001940
1941 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001942 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001943 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001944 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001945# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001946 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001947 my $ops = qr{
1948 <<=|>>=|<=|>=|==|!=|
1949 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1950 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001951 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1952 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001953 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001954 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001955 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001956
1957 my $blank = copy_spacing($opline);
1958
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001959 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001960 $off += length($elements[$n]);
1961
Andy Whitcroft773647a2008-03-28 14:15:58 -07001962 # Pick up the preceeding and succeeding characters.
1963 my $ca = substr($opline, 0, $off);
1964 my $cc = '';
1965 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1966 $cc = substr($opline, $off + length($elements[$n + 1]));
1967 }
1968 my $cb = "$ca$;$cc";
1969
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001970 my $a = '';
1971 $a = 'V' if ($elements[$n] ne '');
1972 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001973 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001974 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1975 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07001976 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001977
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001978 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001979
1980 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001981 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001982 $c = 'V' if ($elements[$n + 2] ne '');
1983 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001984 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001985 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1986 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08001987 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001988 } else {
1989 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001990 }
1991
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001992 my $ctx = "${a}x${c}";
1993
1994 my $at = "(ctx:$ctx)";
1995
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001996 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001997 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001998
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001999 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002000 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002001
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002002 # Get the full operator variant.
2003 my $opv = $op . substr($curr_vars, $off, 1);
2004
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002005 # Ignore operators passed as parameters.
2006 if ($op_type ne 'V' &&
2007 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2008
Andy Whitcroftcf655042008-03-04 14:28:20 -08002009# # Ignore comments
2010# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002011
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002012 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002013 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002014 if ($ctx !~ /.x[WEBC]/ &&
2015 $cc !~ /^\\/ && $cc !~ /^;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002016 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002017 }
2018
2019 # // is a comment
2020 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002021
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002022 # No spaces for:
2023 # ->
2024 # : when part of a bitfield
2025 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002026 if ($ctx =~ /Wx.|.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002027 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002028 }
2029
2030 # , must have a space on the right.
2031 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002032 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002033 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002034 }
2035
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002036 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002037 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002038 #warn "'*' is part of type\n";
2039
2040 # unary operators should have a space before and
2041 # none after. May be left adjacent to another
2042 # unary operator, or a cast
2043 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002044 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07002045 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002046 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002047 ERROR("space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002048 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08002049 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002050 # A unary '*' may be const
2051
2052 } elsif ($ctx =~ /.xW/) {
Andy Whitcroftfb9e9092009-09-21 17:04:38 -07002053 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002054 }
2055
2056 # unary ++ and unary -- are allowed no space on one side.
2057 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002058 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2059 ERROR("space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002060 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002061 if ($ctx =~ /Wx[BE]/ ||
2062 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
2063 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002064 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002065 if ($ctx =~ /ExW/) {
2066 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
2067 }
2068
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002069
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002070 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002071 } elsif ($op eq '<<' or $op eq '>>' or
2072 $op eq '&' or $op eq '^' or $op eq '|' or
2073 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002074 $op eq '*' or $op eq '/' or
2075 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002076 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002077 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002078 ERROR("need consistent spacing around '$op' $at\n" .
2079 $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002080 }
2081
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002082 # A colon needs no spaces before when it is
2083 # terminating a case value or a label.
2084 } elsif ($opv eq ':C' || $opv eq ':L') {
2085 if ($ctx =~ /Wx./) {
2086 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
2087 }
2088
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002089 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08002090 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002091 my $ok = 0;
2092
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002093 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002094 if (($op eq '<' &&
2095 $cc =~ /^\S+\@\S+>/) ||
2096 ($op eq '>' &&
2097 $ca =~ /<\S+\@\S+$/))
2098 {
2099 $ok = 1;
2100 }
2101
2102 # Ignore ?:
2103 if (($opv eq ':O' && $ca =~ /\?$/) ||
2104 ($op eq '?' && $cc =~ /^:/)) {
2105 $ok = 1;
2106 }
2107
2108 if ($ok == 0) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002109 ERROR("spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002110 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002111 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002112 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002113 }
2114 }
2115
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002116# check for multiple assignments
2117 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002118 CHK("multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002119 }
2120
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002121## # check for multiple declarations, allowing for a function declaration
2122## # continuation.
2123## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2124## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2125##
2126## # Remove any bracketed sections to ensure we do not
2127## # falsly report the parameters of functions.
2128## my $ln = $line;
2129## while ($ln =~ s/\([^\(\)]*\)//g) {
2130## }
2131## if ($ln =~ /,/) {
2132## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
2133## }
2134## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002135
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002136#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002137 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2138 $line =~ /do{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002139 ERROR("space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002140 }
2141
2142# closing brace should have a space following it when it has anything
2143# on the line
2144 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002145 ERROR("space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002146 }
2147
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002148# check spacing on square brackets
2149 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002150 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002151 }
2152 if ($line =~ /\s\]/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002153 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002154 }
2155
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002156# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002157 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2158 $line !~ /for\s*\(\s+;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002159 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002160 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002161 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002162 $line !~ /for\s*\(.*;\s+\)/ &&
2163 $line !~ /:\s+\)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002164 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002165 }
2166
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002167#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002168 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002169 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002170 WARN("labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002171 }
2172
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002173# Return is not a function.
2174 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2175 my $spacing = $1;
2176 my $value = $2;
2177
Andy Whitcroft86f9d052009-01-06 14:41:24 -08002178 # Flatten any parentheses
Andy Whitcroftfee61c42008-07-23 21:28:56 -07002179 $value =~ s/\)\(/\) \(/g;
Andy Whitcroft63f17f82009-01-15 13:51:06 -08002180 while ($value =~ s/\[[^\{\}]*\]/1/ ||
2181 $value !~ /(?:$Ident|-?$Constant)\s*
2182 $Compare\s*
2183 (?:$Ident|-?$Constant)/x &&
2184 $value =~ s/\([^\(\)]*\)/1/) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002185 }
2186
2187 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
2188 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
2189
2190 } elsif ($spacing !~ /\s+/) {
2191 ERROR("space required before the open parenthesis '('\n" . $herecurr);
2192 }
2193 }
2194
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002195# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002196 if ($line=~/\b(if|while|for|switch)\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002197 ERROR("space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002198 }
2199
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002200# Check for illegal assignment in if conditional -- and check for trailing
2201# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002202 if ($line =~ /do\s*(?!{)/) {
2203 my ($stat_next) = ctx_statement_block($line_nr_next,
2204 $remain_next, $off_next);
2205 $stat_next =~ s/\n./\n /g;
2206 ##print "stat<$stat> stat_next<$stat_next>\n";
2207
2208 if ($stat_next =~ /^\s*while\b/) {
2209 # If the statement carries leading newlines,
2210 # then count those as offsets.
2211 my ($whitespace) =
2212 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2213 my $offset =
2214 statement_rawlines($whitespace) - 1;
2215
2216 $suppress_whiletrailers{$line_nr_next +
2217 $offset} = 1;
2218 }
2219 }
2220 if (!defined $suppress_whiletrailers{$linenr} &&
2221 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002222 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002223
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08002224 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002225 ERROR("do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002226 }
2227
2228 # Find out what is on the end of the line after the
2229 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002230 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002231 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002232 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07002233 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2234 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002235 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002236 # Find out how long the conditional actually is.
2237 my @newlines = ($c =~ /\n/gs);
2238 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08002239 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002240
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08002241 $stat_real = raw_line($linenr, $cond_lines)
2242 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002243 if (defined($stat_real) && $cond_lines > 1) {
2244 $stat_real = "[...]\n$stat_real";
2245 }
2246
2247 ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002248 }
2249 }
2250
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002251# Check for bitwise tests written as boolean
2252 if ($line =~ /
2253 (?:
2254 (?:\[|\(|\&\&|\|\|)
2255 \s*0[xX][0-9]+\s*
2256 (?:\&\&|\|\|)
2257 |
2258 (?:\&\&|\|\|)
2259 \s*0[xX][0-9]+\s*
2260 (?:\&\&|\|\||\)|\])
2261 )/x)
2262 {
2263 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2264 }
2265
Andy Whitcroft8905a672007-11-28 16:21:06 -08002266# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002267 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2268 my $s = $1;
2269 $s =~ s/$;//g; # Remove any comments
2270 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2271 ERROR("trailing statements should be on next line\n" . $herecurr);
2272 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002273 }
Andy Whitcroft39667782009-01-15 13:51:06 -08002274# if should not continue a brace
2275 if ($line =~ /}\s*if\b/) {
2276 ERROR("trailing statements should be on next line\n" .
2277 $herecurr);
2278 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002279# case and default should not have general statements after them
2280 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2281 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07002282 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002283 \s*return\s+
2284 )/xg)
2285 {
2286 ERROR("trailing statements should be on next line\n" . $herecurr);
2287 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002288
2289 # Check for }<nl>else {, these must be at the same
2290 # indent level to be relevant to each other.
2291 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2292 $previndent == $indent) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002293 ERROR("else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002294 }
2295
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002296 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2297 $previndent == $indent) {
2298 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2299
2300 # Find out what is on the end of the line after the
2301 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002302 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002303 $s =~ s/\n.*//g;
2304
2305 if ($s =~ /^\s*;/) {
2306 ERROR("while should follow close brace '}'\n" . $hereprev);
2307 }
2308 }
2309
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002310#studly caps, commented out until figure out how to distinguish between use of existing and adding new
2311# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2312# print "No studly caps, use _\n";
2313# print "$herecurr";
2314# $clean = 0;
2315# }
2316
2317#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002318 if ($line=~/\#\s*define.*\\\s$/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002319 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002320 }
2321
Andy Whitcroft653d4872007-06-23 17:16:34 -07002322#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002323 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002324 my $file = "$1.h";
2325 my $checkfile = "include/linux/$file";
2326 if (-f "$root/$checkfile" &&
2327 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07002328 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002329 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002330 if ($realfile =~ m{^arch/}) {
2331 CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2332 } else {
2333 WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2334 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002335 }
2336 }
2337
Andy Whitcroft653d4872007-06-23 17:16:34 -07002338# multi-statement macros should be enclosed in a do while loop, grab the
2339# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08002340# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07002341 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2342 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002343 my $ln = $linenr;
2344 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002345 my ($off, $dstat, $dcond, $rest);
2346 my $ctx = '';
Andy Whitcroft653d4872007-06-23 17:16:34 -07002347
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002348 my $args = defined($1);
2349
2350 # Find the end of the macro and limit our statement
2351 # search to that.
2352 while ($cnt > 0 && defined $lines[$ln - 1] &&
2353 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2354 {
2355 $ctx .= $rawlines[$ln - 1] . "\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002356 $cnt-- if ($lines[$ln - 1] !~ /^-/);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002357 $ln++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002358 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002359 $ctx .= $rawlines[$ln - 1];
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002360
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002361 ($dstat, $dcond, $ln, $cnt, $off) =
2362 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2363 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002364 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002365
2366 # Extract the remainder of the define (if any) and
2367 # rip off surrounding spaces, and trailing \'s.
2368 $rest = '';
Andy Whitcroft636d1402008-10-15 22:02:18 -07002369 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2370 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002371 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2372 $rest .= substr($lines[$ln - 1], $off) . "\n";
2373 $cnt--;
2374 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002375 $ln++;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002376 $off = 0;
2377 }
2378 $rest =~ s/\\\n.//g;
2379 $rest =~ s/^\s*//s;
2380 $rest =~ s/\s*$//s;
2381
2382 # Clean up the original statement.
2383 if ($args) {
2384 substr($dstat, 0, length($dcond), '');
2385 } else {
2386 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2387 }
Andy Whitcroft292f1a92008-07-23 21:29:11 -07002388 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002389 $dstat =~ s/\\\n.//g;
2390 $dstat =~ s/^\s*//s;
2391 $dstat =~ s/\s*$//s;
2392
2393 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07002394 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2395 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2396 $dstat =~ s/\[[^\{\}]*\]/1/)
2397 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002398 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002399
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002400 my $exceptions = qr{
2401 $Declare|
2402 module_param_named|
2403 MODULE_PARAM_DESC|
2404 DECLARE_PER_CPU|
2405 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08002406 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08002407 union|
2408 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07002409 \.$Ident\s*=\s*|
2410 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002411 }x;
Andy Whitcroft383099f2009-01-06 14:41:18 -08002412 #print "REST<$rest> dstat<$dstat>\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002413 if ($rest ne '') {
2414 if ($rest !~ /while\s*\(/ &&
2415 $dstat !~ /$exceptions/)
2416 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002417 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 -07002418 }
2419
2420 } elsif ($ctx !~ /;/) {
2421 if ($dstat ne '' &&
2422 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2423 $dstat !~ /$exceptions/ &&
Andy Whitcroftb132e5d2008-10-15 22:02:31 -07002424 $dstat !~ /^\.$Ident\s*=/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002425 $dstat =~ /$Operators/)
2426 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002427 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002428 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002429 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002430 }
2431
Mike Frysinger080ba922009-01-06 14:41:25 -08002432# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
2433# all assignments may have only one of the following with an assignment:
2434# .
2435# ALIGN(...)
2436# VMLINUX_SYMBOL(...)
2437 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
2438 WARN("vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
2439 }
2440
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002441# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002442 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2443 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08002444 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002445 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002446 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2447 if ($#chunks > 0 && $level == 0) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002448 my $allowed = 0;
2449 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002450 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002451 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002452 for my $chunk (@chunks) {
2453 my ($cond, $block) = @{$chunk};
2454
Andy Whitcroft773647a2008-03-28 14:15:58 -07002455 # If the condition carries leading newlines, then count those as offsets.
2456 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2457 my $offset = statement_rawlines($whitespace) - 1;
2458
2459 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2460
2461 # We have looked at and allowed this specific line.
2462 $suppress_ifbraces{$ln + $offset} = 1;
2463
2464 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002465 $ln += statement_rawlines($block) - 1;
2466
Andy Whitcroft773647a2008-03-28 14:15:58 -07002467 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002468
2469 $seen++ if ($block =~ /^\s*{/);
2470
Andy Whitcroftcf655042008-03-04 14:28:20 -08002471 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2472 if (statement_lines($cond) > 1) {
2473 #print "APW: ALLOWED: cond<$cond>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002474 $allowed = 1;
2475 }
2476 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002477 #print "APW: ALLOWED: block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002478 $allowed = 1;
2479 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002480 if (statement_block_size($block) > 1) {
2481 #print "APW: ALLOWED: lines block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002482 $allowed = 1;
2483 }
2484 }
2485 if ($seen && !$allowed) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002486 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002487 }
2488 }
2489 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002490 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002491 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002492 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002493
Andy Whitcroftcf655042008-03-04 14:28:20 -08002494 # Check the pre-context.
2495 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2496 #print "APW: ALLOWED: pre<$1>\n";
2497 $allowed = 1;
2498 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002499
2500 my ($level, $endln, @chunks) =
2501 ctx_statement_full($linenr, $realcnt, $-[0]);
2502
Andy Whitcroftcf655042008-03-04 14:28:20 -08002503 # Check the condition.
2504 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07002505 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002506 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002507 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08002508 }
2509 if (statement_lines($cond) > 1) {
2510 #print "APW: ALLOWED: cond<$cond>\n";
2511 $allowed = 1;
2512 }
2513 if ($block =~/\b(?:if|for|while)\b/) {
2514 #print "APW: ALLOWED: block<$block>\n";
2515 $allowed = 1;
2516 }
2517 if (statement_block_size($block) > 1) {
2518 #print "APW: ALLOWED: lines block<$block>\n";
2519 $allowed = 1;
2520 }
2521 # Check the post-context.
2522 if (defined $chunks[1]) {
2523 my ($cond, $block) = @{$chunks[1]};
2524 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002525 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002526 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002527 if ($block =~ /^\s*\{/) {
2528 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2529 $allowed = 1;
2530 }
2531 }
2532 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2533 my $herectx = $here . "\n";;
Andy Whitcroftf0556632008-10-15 22:02:23 -07002534 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002535
Andy Whitcroftf0556632008-10-15 22:02:23 -07002536 for (my $n = 0; $n < $cnt; $n++) {
2537 $herectx .= raw_line($linenr, $n) . "\n";;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002538 }
2539
2540 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002541 }
2542 }
2543
Andy Whitcroft653d4872007-06-23 17:16:34 -07002544# don't include deprecated include files (uses RAW line)
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002545 for my $inc (@dep_includes) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002546 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002547 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002548 }
2549 }
2550
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002551# don't use deprecated functions
2552 for my $func (@dep_functions) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002553 if ($line =~ /\b$func\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002554 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002555 }
2556 }
2557
2558# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002559 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2560 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002561 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002562 }
2563
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002564# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2565 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2566 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2567 }
2568
Andy Whitcroft00df3442007-06-08 13:47:06 -07002569# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002570 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002571 CHK("if this code is redundant consider removing it\n" .
2572 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002573 }
2574
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002575# check for needless kfree() checks
2576 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2577 my $expr = $1;
2578 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
Wolfram Sang3c232142008-07-23 21:29:05 -07002579 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002580 }
2581 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07002582# check for needless usb_free_urb() checks
2583 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2584 my $expr = $1;
2585 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2586 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2587 }
2588 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002589
Patrick Pannuto1a15a252010-08-09 17:21:01 -07002590# prefer usleep_range over udelay
2591 if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) {
2592 # ignore udelay's < 10, however
2593 if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) {
2594 CHK("usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
2595 }
2596 }
2597
Patrick Pannuto09ef8722010-08-09 17:21:02 -07002598# warn about unexpectedly long msleep's
2599 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
2600 if ($1 < 20) {
2601 WARN("msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
2602 }
2603 }
2604
Andy Whitcroft00df3442007-06-08 13:47:06 -07002605# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002606# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002607# print "#ifdef in C files should be avoided\n";
2608# print "$herecurr";
2609# $clean = 0;
2610# }
2611
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002612# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002613 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002614 ERROR("exactly one space required after that #$1\n" . $herecurr);
2615 }
2616
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002617# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002618 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2619 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002620 my $which = $1;
2621 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002622 CHK("$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002623 }
2624 }
2625# check for memory barriers without a comment.
2626 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2627 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002628 CHK("memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002629 }
2630 }
2631# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002632 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002633 CHK("architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002634 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002635
Tobias Klauserd4977c72010-05-24 14:33:30 -07002636# Check that the storage class is at the beginning of a declaration
2637 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
2638 WARN("storage class should be at the beginning of the declaration\n" . $herecurr)
2639 }
2640
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002641# check the location of the inline attribute, that it is between
2642# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002643 if ($line =~ /\b$Type\s+$Inline\b/ ||
2644 $line =~ /\b$Inline\s+$Storage\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002645 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2646 }
2647
Andy Whitcroft8905a672007-11-28 16:21:06 -08002648# Check for __inline__ and __inline, prefer inline
2649 if ($line =~ /\b(__inline__|__inline)\b/) {
2650 WARN("plain inline is preferred over $1\n" . $herecurr);
2651 }
2652
Joe Perches8f53a9b2010-03-05 13:43:48 -08002653# check for sizeof(&)
2654 if ($line =~ /\bsizeof\s*\(\s*\&/) {
2655 WARN("sizeof(& should be avoided\n" . $herecurr);
2656 }
2657
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002658# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002659 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002660 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002661 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002662 my $function_name = $1;
2663 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002664
2665 my $s = $stat;
2666 if (defined $cond) {
2667 substr($s, 0, length($cond), '');
2668 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002669 if ($s =~ /^\s*;/ &&
2670 $function_name ne 'uninitialized_var')
2671 {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002672 WARN("externs should be avoided in .c files\n" . $herecurr);
2673 }
2674
2675 if ($paren_space =~ /\n/) {
2676 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2677 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002678
2679 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2680 $stat =~ /^.\s*extern\s+/)
2681 {
2682 WARN("externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002683 }
2684
2685# checks for new __setup's
2686 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2687 my $name = $1;
2688
2689 if (!grep(/$name/, @setup_docs)) {
2690 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2691 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002692 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002693
2694# check for pointless casting of kmalloc return
2695 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2696 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2697 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002698
2699# check for gcc specific __FUNCTION__
2700 if ($line =~ /__FUNCTION__/) {
2701 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2702 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002703
2704# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002705 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002706 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2707 }
2708# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002709 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002710 WARN("consider using a completion\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01002711
Andy Whitcroft773647a2008-03-28 14:15:58 -07002712 }
2713# recommend strict_strto* over simple_strto*
2714 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2715 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2716 }
Michael Ellermanf3db6632008-07-23 21:28:57 -07002717# check for __initcall(), use device_initcall() explicitly please
2718 if ($line =~ /^.\s*__initcall\s*\(/) {
2719 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2720 }
Emese Revfy79404842010-03-05 13:43:53 -08002721# check for various ops structs, ensure they are const.
2722 my $struct_ops = qr{acpi_dock_ops|
2723 address_space_operations|
2724 backlight_ops|
2725 block_device_operations|
2726 dentry_operations|
2727 dev_pm_ops|
2728 dma_map_ops|
2729 extent_io_ops|
2730 file_lock_operations|
2731 file_operations|
2732 hv_ops|
2733 ide_dma_ops|
2734 intel_dvo_dev_ops|
2735 item_operations|
2736 iwl_ops|
2737 kgdb_arch|
2738 kgdb_io|
2739 kset_uevent_ops|
2740 lock_manager_operations|
2741 microcode_ops|
2742 mtrr_ops|
2743 neigh_ops|
2744 nlmsvc_binding|
2745 pci_raw_ops|
2746 pipe_buf_operations|
2747 platform_hibernation_ops|
2748 platform_suspend_ops|
2749 proto_ops|
2750 rpc_pipe_ops|
2751 seq_operations|
2752 snd_ac97_build_ops|
2753 soc_pcmcia_socket_ops|
2754 stacktrace_ops|
2755 sysfs_ops|
2756 tty_operations|
2757 usb_mon_operations|
2758 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08002759 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08002760 $line =~ /\bstruct\s+($struct_ops)\b/) {
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08002761 WARN("struct $1 should normally be const\n" .
2762 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08002763 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002764
2765# use of NR_CPUS is usually wrong
2766# ignore definitions of NR_CPUS and usage to define arrays as likely right
2767 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002768 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2769 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002770 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2771 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2772 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002773 {
2774 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2775 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002776
2777# check for %L{u,d,i} in strings
2778 my $string;
2779 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2780 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07002781 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002782 if ($string =~ /(?<!%)%L[udi]/) {
2783 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2784 last;
2785 }
2786 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08002787
2788# whine mightly about in_atomic
2789 if ($line =~ /\bin_atomic\s*\(/) {
2790 if ($realfile =~ m@^drivers/@) {
2791 ERROR("do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08002792 } elsif ($realfile !~ m@^kernel/@) {
Andy Whitcroft691d77b2009-01-06 14:41:16 -08002793 WARN("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
2794 }
2795 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01002796
2797# check for lockdep_set_novalidate_class
2798 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
2799 $line =~ /__lockdep_no_validate__\s*\)/ ) {
2800 if ($realfile !~ m@^kernel/lockdep@ &&
2801 $realfile !~ m@^include/linux/lockdep@ &&
2802 $realfile !~ m@^drivers/base/core@) {
2803 ERROR("lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
2804 }
2805 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002806 }
2807
2808 # If we have no input at all, then there is nothing to report on
2809 # so just keep quiet.
2810 if ($#rawlines == -1) {
2811 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002812 }
2813
Andy Whitcroft8905a672007-11-28 16:21:06 -08002814 # In mailback mode only produce a report in the negative, for
2815 # things that appear to be patches.
2816 if ($mailback && ($clean == 1 || !$is_patch)) {
2817 exit(0);
2818 }
2819
2820 # This is not a patch, and we are are in 'no-patch' mode so
2821 # just keep quiet.
2822 if (!$chk_patch && !$is_patch) {
2823 exit(0);
2824 }
2825
2826 if (!$is_patch) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002827 ERROR("Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002828 }
2829 if ($is_patch && $chk_signoff && $signoff == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002830 ERROR("Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002831 }
2832
Andy Whitcroft8905a672007-11-28 16:21:06 -08002833 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002834 if ($summary && !($clean == 1 && $quiet == 1)) {
2835 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002836 print "total: $cnt_error errors, $cnt_warn warnings, " .
2837 (($check)? "$cnt_chk checks, " : "") .
2838 "$cnt_lines lines checked\n";
2839 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002840 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002841
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002842 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002843 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002844 }
2845 if ($clean == 0 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002846 print "$vname has style problems, please review. If any of these errors\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002847 print "are false positives report them to the maintainer, see\n";
2848 print "CHECKPATCH in MAINTAINERS.\n";
2849 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002850
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002851 return $clean;
2852}