blob: bd88f11b0953d161b259e80b27d6f423b12e8b1c [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)|
198 dev_(printk|dbg|vdbg|info|warn|err|notice|alert|crit|emerg|WARN)|
199 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
227sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700228 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
229 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700230 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800231 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700232 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800233 (?:
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700234 (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700235 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700236 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800237 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700238 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800239 }x;
240 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700241 $NonptrType
Andy Whitcroft65863862009-01-06 14:41:21 -0800242 (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700243 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800244 }x;
245 $Declare = qr{(?:$Storage\s+)?$Type};
246}
247build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700248
249$chk_signoff = 0 if ($file);
250
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700251my @dep_includes = ();
252my @dep_functions = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700253my $removal = "Documentation/feature-removal-schedule.txt";
254if ($tree && -f "$root/$removal") {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800255 open(my $REMOVE, '<', "$root/$removal") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700256 die "$P: $removal: open failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800257 while (<$REMOVE>) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700258 if (/^Check:\s+(.*\S)/) {
259 for my $entry (split(/[, ]+/, $1)) {
260 if ($entry =~ m@include/(.*)@) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700261 push(@dep_includes, $1);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700262
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700263 } elsif ($entry !~ m@/@) {
264 push(@dep_functions, $entry);
265 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700266 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700267 }
268 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800269 close($REMOVE);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700270}
271
Andy Whitcroft00df3442007-06-08 13:47:06 -0700272my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800273my @lines = ();
274my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700275for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800276 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700277 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800278 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700279 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800280 } elsif ($filename eq '-') {
281 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700282 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800283 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700284 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700285 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800286 if ($filename eq '-') {
287 $vname = 'Your patch';
288 } else {
289 $vname = $filename;
290 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800291 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700292 chomp;
293 push(@rawlines, $_);
294 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800295 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800296 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700297 $exit = 1;
298 }
299 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800300 @lines = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700301}
302
303exit($exit);
304
305sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700306 my ($root) = @_;
307
308 my @tree_check = (
309 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
310 "README", "Documentation", "arch", "include", "drivers",
311 "fs", "init", "ipc", "kernel", "lib", "scripts",
312 );
313
314 foreach my $check (@tree_check) {
315 if (! -e $root . '/' . $check) {
316 return 0;
317 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700318 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700319 return 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700320}
321
322sub expand_tabs {
323 my ($str) = @_;
324
325 my $res = '';
326 my $n = 0;
327 for my $c (split(//, $str)) {
328 if ($c eq "\t") {
329 $res .= ' ';
330 $n++;
331 for (; ($n % 8) != 0; $n++) {
332 $res .= ' ';
333 }
334 next;
335 }
336 $res .= $c;
337 $n++;
338 }
339
340 return $res;
341}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700342sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700343 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700344 return $res;
345}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700346
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700347sub line_stats {
348 my ($line) = @_;
349
350 # Drop the diff line leader and expand tabs
351 $line =~ s/^.//;
352 $line = expand_tabs($line);
353
354 # Pick the indent from the front of the line.
355 my ($white) = ($line =~ /^(\s*)/);
356
357 return (length($line), length($white));
358}
359
Andy Whitcroft773647a2008-03-28 14:15:58 -0700360my $sanitise_quote = '';
361
362sub sanitise_line_reset {
363 my ($in_comment) = @_;
364
365 if ($in_comment) {
366 $sanitise_quote = '*/';
367 } else {
368 $sanitise_quote = '';
369 }
370}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700371sub sanitise_line {
372 my ($line) = @_;
373
374 my $res = '';
375 my $l = '';
376
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800377 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700378 my $off = 0;
379 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700380
Andy Whitcroft773647a2008-03-28 14:15:58 -0700381 # Always copy over the diff marker.
382 $res = substr($line, 0, 1);
383
384 for ($off = 1; $off < length($line); $off++) {
385 $c = substr($line, $off, 1);
386
387 # Comments we are wacking completly including the begin
388 # and end, all to $;.
389 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
390 $sanitise_quote = '*/';
391
392 substr($res, $off, 2, "$;$;");
393 $off++;
394 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800395 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700396 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700397 $sanitise_quote = '';
398 substr($res, $off, 2, "$;$;");
399 $off++;
400 next;
401 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700402 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
403 $sanitise_quote = '//';
404
405 substr($res, $off, 2, $sanitise_quote);
406 $off++;
407 next;
408 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700409
410 # A \ in a string means ignore the next character.
411 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
412 $c eq "\\") {
413 substr($res, $off, 2, 'XX');
414 $off++;
415 next;
416 }
417 # Regular quotes.
418 if ($c eq "'" || $c eq '"') {
419 if ($sanitise_quote eq '') {
420 $sanitise_quote = $c;
421
422 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700423 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700424 } elsif ($sanitise_quote eq $c) {
425 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700426 }
427 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700428
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800429 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700430 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
431 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700432 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
433 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700434 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
435 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700436 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700437 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700438 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800439 }
440
Daniel Walker113f04a2009-09-21 17:04:35 -0700441 if ($sanitise_quote eq '//') {
442 $sanitise_quote = '';
443 }
444
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800445 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700446 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800447 my $clean = 'X' x length($1);
448 $res =~ s@\<.*\>@<$clean>@;
449
450 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700451 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800452 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700453 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800454 }
455
Andy Whitcroft00df3442007-06-08 13:47:06 -0700456 return $res;
457}
458
Andy Whitcroft8905a672007-11-28 16:21:06 -0800459sub ctx_statement_block {
460 my ($linenr, $remain, $off) = @_;
461 my $line = $linenr - 1;
462 my $blk = '';
463 my $soff = $off;
464 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700465 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800466
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800467 my $loff = 0;
468
Andy Whitcroft8905a672007-11-28 16:21:06 -0800469 my $type = '';
470 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800471 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800472 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800473 my $c;
474 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800475
476 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800477 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800478 @stack = (['', 0]) if ($#stack == -1);
479
Andy Whitcroft773647a2008-03-28 14:15:58 -0700480 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800481 # If we are about to drop off the end, pull in more
482 # context.
483 if ($off >= $len) {
484 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700485 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800486 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800487 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800488 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800489 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800490 $len = length($blk);
491 $line++;
492 last;
493 }
494 # Bail if there is no further context.
495 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800496 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800497 last;
498 }
499 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800500 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800501 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800502 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800503
Andy Whitcroft773647a2008-03-28 14:15:58 -0700504 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800505
506 # Handle nested #if/#else.
507 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
508 push(@stack, [ $type, $level ]);
509 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
510 ($type, $level) = @{$stack[$#stack - 1]};
511 } elsif ($remainder =~ /^#\s*endif\b/) {
512 ($type, $level) = @{pop(@stack)};
513 }
514
Andy Whitcroft8905a672007-11-28 16:21:06 -0800515 # Statement ends at the ';' or a close '}' at the
516 # outermost level.
517 if ($level == 0 && $c eq ';') {
518 last;
519 }
520
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800521 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700522 if ($level == 0 && $coff_set == 0 &&
523 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
524 $remainder =~ /^(else)(?:\s|{)/ &&
525 $remainder !~ /^else\s+if\b/) {
526 $coff = $off + length($1) - 1;
527 $coff_set = 1;
528 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
529 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800530 }
531
Andy Whitcroft8905a672007-11-28 16:21:06 -0800532 if (($type eq '' || $type eq '(') && $c eq '(') {
533 $level++;
534 $type = '(';
535 }
536 if ($type eq '(' && $c eq ')') {
537 $level--;
538 $type = ($level != 0)? '(' : '';
539
540 if ($level == 0 && $coff < $soff) {
541 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700542 $coff_set = 1;
543 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800544 }
545 }
546 if (($type eq '' || $type eq '{') && $c eq '{') {
547 $level++;
548 $type = '{';
549 }
550 if ($type eq '{' && $c eq '}') {
551 $level--;
552 $type = ($level != 0)? '{' : '';
553
554 if ($level == 0) {
555 last;
556 }
557 }
558 $off++;
559 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700560 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800561 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700562 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800563 $line++;
564 $remain--;
565 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800566
567 my $statement = substr($blk, $soff, $off - $soff + 1);
568 my $condition = substr($blk, $soff, $coff - $soff + 1);
569
570 #warn "STATEMENT<$statement>\n";
571 #warn "CONDITION<$condition>\n";
572
Andy Whitcroft773647a2008-03-28 14:15:58 -0700573 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800574
575 return ($statement, $condition,
576 $line, $remain + 1, $off - $loff + 1, $level);
577}
578
Andy Whitcroftcf655042008-03-04 14:28:20 -0800579sub statement_lines {
580 my ($stmt) = @_;
581
582 # Strip the diff line prefixes and rip blank lines at start and end.
583 $stmt =~ s/(^|\n)./$1/g;
584 $stmt =~ s/^\s*//;
585 $stmt =~ s/\s*$//;
586
587 my @stmt_lines = ($stmt =~ /\n/g);
588
589 return $#stmt_lines + 2;
590}
591
592sub statement_rawlines {
593 my ($stmt) = @_;
594
595 my @stmt_lines = ($stmt =~ /\n/g);
596
597 return $#stmt_lines + 2;
598}
599
600sub statement_block_size {
601 my ($stmt) = @_;
602
603 $stmt =~ s/(^|\n)./$1/g;
604 $stmt =~ s/^\s*{//;
605 $stmt =~ s/}\s*$//;
606 $stmt =~ s/^\s*//;
607 $stmt =~ s/\s*$//;
608
609 my @stmt_lines = ($stmt =~ /\n/g);
610 my @stmt_statements = ($stmt =~ /;/g);
611
612 my $stmt_lines = $#stmt_lines + 2;
613 my $stmt_statements = $#stmt_statements + 1;
614
615 if ($stmt_lines > $stmt_statements) {
616 return $stmt_lines;
617 } else {
618 return $stmt_statements;
619 }
620}
621
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800622sub ctx_statement_full {
623 my ($linenr, $remain, $off) = @_;
624 my ($statement, $condition, $level);
625
626 my (@chunks);
627
Andy Whitcroftcf655042008-03-04 14:28:20 -0800628 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800629 ($statement, $condition, $linenr, $remain, $off, $level) =
630 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700631 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800632 push(@chunks, [ $condition, $statement ]);
633 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
634 return ($level, $linenr, @chunks);
635 }
636
637 # Pull in the following conditional/block pairs and see if they
638 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800639 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800640 ($statement, $condition, $linenr, $remain, $off, $level) =
641 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800642 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700643 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800644 #print "C: push\n";
645 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800646 }
647
648 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800649}
650
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700651sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700652 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700653 my $line;
654 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700655 my $blk = '';
656 my @o;
657 my @c;
658 my @res = ();
659
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700660 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800661 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700662 for ($line = $start; $remain > 0; $line++) {
663 next if ($rawlines[$line] =~ /^-/);
664 $remain--;
665
666 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800667
668 # Handle nested #if/#else.
669 if ($rawlines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
670 push(@stack, $level);
671 } elsif ($rawlines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
672 $level = $stack[$#stack - 1];
673 } elsif ($rawlines[$line] =~ /^.\s*#\s*endif\b/) {
674 $level = pop(@stack);
675 }
676
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700677 foreach my $c (split(//, $rawlines[$line])) {
678 ##print "C<$c>L<$level><$open$close>O<$off>\n";
679 if ($off > 0) {
680 $off--;
681 next;
682 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700683
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700684 if ($c eq $close && $level > 0) {
685 $level--;
686 last if ($level == 0);
687 } elsif ($c eq $open) {
688 $level++;
689 }
690 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700691
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700692 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700693 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700694 }
695
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700696 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700697 }
698
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700699 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700700}
701sub ctx_block_outer {
702 my ($linenr, $remain) = @_;
703
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700704 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
705 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700706}
707sub ctx_block {
708 my ($linenr, $remain) = @_;
709
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700710 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
711 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700712}
713sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700714 my ($linenr, $remain, $off) = @_;
715
716 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
717 return @r;
718}
719sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700720 my ($linenr, $remain) = @_;
721
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700722 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700723}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700724sub ctx_statement_level {
725 my ($linenr, $remain, $off) = @_;
726
727 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
728}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700729
730sub ctx_locate_comment {
731 my ($first_line, $end_line) = @_;
732
733 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700734 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700735 return $current_comment if (defined $current_comment);
736
737 # Look through the context and try and figure out if there is a
738 # comment.
739 my $in_comment = 0;
740 $current_comment = '';
741 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700742 my $line = $rawlines[$linenr - 1];
743 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700744 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
745 $in_comment = 1;
746 }
747 if ($line =~ m@/\*@) {
748 $in_comment = 1;
749 }
750 if (!$in_comment && $current_comment ne '') {
751 $current_comment = '';
752 }
753 $current_comment .= $line . "\n" if ($in_comment);
754 if ($line =~ m@\*/@) {
755 $in_comment = 0;
756 }
757 }
758
759 chomp($current_comment);
760 return($current_comment);
761}
762sub ctx_has_comment {
763 my ($first_line, $end_line) = @_;
764 my $cmt = ctx_locate_comment($first_line, $end_line);
765
Andy Whitcroft00df3442007-06-08 13:47:06 -0700766 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700767 ##print "CMMT: $cmt\n";
768
769 return ($cmt ne '');
770}
771
Andy Whitcroft4d001e42008-10-15 22:02:21 -0700772sub raw_line {
773 my ($linenr, $cnt) = @_;
774
775 my $offset = $linenr - 1;
776 $cnt++;
777
778 my $line;
779 while ($cnt) {
780 $line = $rawlines[$offset++];
781 next if (defined($line) && $line =~ /^-/);
782 $cnt--;
783 }
784
785 return $line;
786}
787
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700788sub cat_vet {
789 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700790 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700791
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700792 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700793 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
794 $res .= $1;
795 if ($2 ne '') {
796 $coded = sprintf("^%c", unpack('C', $2) + 64);
797 $res .= $coded;
798 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700799 }
800 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700801
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700802 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700803}
804
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800805my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800806my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800807my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700808my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800809
810sub annotate_reset {
811 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800812 $av_pending = '_';
813 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700814 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800815}
816
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700817sub annotate_values {
818 my ($stream, $type) = @_;
819
820 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700821 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700822 my $cur = $stream;
823
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800824 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700825
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700826 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700827 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800828 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700829 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700830 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800831 print "WS($1)\n" if ($dbg_values > 1);
832 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800833 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800834 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700835 }
836
Andy Whitcroft8ea3eb92008-07-23 21:29:08 -0700837 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800838 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700839 $type = 'T';
840
Andy Whitcroft389a2fe2008-07-23 21:29:05 -0700841 } elsif ($cur =~ /^($Modifier)\s*/) {
842 print "MODIFIER($1)\n" if ($dbg_values > 1);
843 $type = 'T';
844
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700845 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700846 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800847 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700848 push(@av_paren_type, $type);
849 if ($2 ne '') {
850 $av_pending = 'N';
851 }
852 $type = 'E';
853
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700854 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700855 print "UNDEF($1)\n" if ($dbg_values > 1);
856 $av_preprocessor = 1;
857 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700858
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700859 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800860 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800861 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800862
863 push(@av_paren_type, $type);
864 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700865 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800866
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700867 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800868 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
869 $av_preprocessor = 1;
870
871 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
872
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700873 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800874
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700875 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800876 print "PRE_END($1)\n" if ($dbg_values > 1);
877
878 $av_preprocessor = 1;
879
880 # Assume all arms of the conditional end as this
881 # one does, and continue as if the #endif was not here.
882 pop(@av_paren_type);
883 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700884 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700885
886 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800887 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700888
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700889 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
890 print "ATTR($1)\n" if ($dbg_values > 1);
891 $av_pending = $type;
892 $type = 'N';
893
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700894 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800895 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700896 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800897 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700898 }
899 $type = 'N';
900
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700901 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800902 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700903 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700904 $type = 'N';
905
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700906 } elsif ($cur =~/^(case)/o) {
907 print "CASE($1)\n" if ($dbg_values > 1);
908 $av_pend_colon = 'C';
909 $type = 'N';
910
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700911 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800912 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700913 $type = 'N';
914
915 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800916 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800917 push(@av_paren_type, $av_pending);
918 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700919 $type = 'N';
920
921 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800922 my $new_type = pop(@av_paren_type);
923 if ($new_type ne '_') {
924 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800925 print "PAREN('$1') -> $type\n"
926 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700927 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800928 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700929 }
930
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700931 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800932 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700933 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800934 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700935
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800936 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
937 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700938 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800939 } elsif ($type eq 'E') {
940 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700941 }
942 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
943 $type = 'V';
944
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700945 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800946 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700947 $type = 'V';
948
949 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800950 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700951 $type = 'N';
952
Andy Whitcroftcf655042008-03-04 14:28:20 -0800953 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800954 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800955 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700956 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800957
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800958 } elsif ($cur =~/^(,)/) {
959 print "COMMA($1)\n" if ($dbg_values > 1);
960 $type = 'C';
961
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700962 } elsif ($cur =~ /^(\?)/o) {
963 print "QUESTION($1)\n" if ($dbg_values > 1);
964 $type = 'N';
965
966 } elsif ($cur =~ /^(:)/o) {
967 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
968
969 substr($var, length($res), 1, $av_pend_colon);
970 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
971 $type = 'E';
972 } else {
973 $type = 'N';
974 }
975 $av_pend_colon = 'O';
976
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800977 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800978 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700979 $type = 'N';
980
Andy Whitcroft0d413862008-10-15 22:02:16 -0700981 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -0700982 my $variant;
983
984 print "OPV($1)\n" if ($dbg_values > 1);
985 if ($type eq 'V') {
986 $variant = 'B';
987 } else {
988 $variant = 'U';
989 }
990
991 substr($var, length($res), 1, $variant);
992 $type = 'N';
993
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700994 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800995 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700996 if ($1 ne '++' && $1 ne '--') {
997 $type = 'N';
998 }
999
1000 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001001 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001002 }
1003 if (defined $1) {
1004 $cur = substr($cur, length($1));
1005 $res .= $type x length($1);
1006 }
1007 }
1008
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001009 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001010}
1011
Andy Whitcroft8905a672007-11-28 16:21:06 -08001012sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001013 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001014 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001015 ^(?:
1016 $Modifier|
1017 $Storage|
1018 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001019 DEFINE_\S+
1020 )$|
1021 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001022 goto|
1023 return|
1024 case|
1025 else|
1026 asm|__asm__|
1027 do
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001028 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001029 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001030 )}x;
1031 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1032 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001033 # Check for modifiers.
1034 $possible =~ s/\s*$Storage\s*//g;
1035 $possible =~ s/\s*$Sparse\s*//g;
1036 if ($possible =~ /^\s*$/) {
1037
1038 } elsif ($possible =~ /\s/) {
1039 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001040 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001041 if ($modifier !~ $notPermitted) {
1042 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1043 push(@modifierList, $modifier);
1044 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001045 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001046
1047 } else {
1048 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1049 push(@typeList, $possible);
1050 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001051 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001052 } else {
1053 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001054 }
1055}
1056
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001057my $prefix = '';
1058
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001059sub report {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001060 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
1061 return 0;
1062 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001063 my $line = $prefix . $_[0];
1064
1065 $line = (split('\n', $line))[0] . "\n" if ($terse);
1066
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001067 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001068
1069 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001070}
1071sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001072 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001073}
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001074sub ERROR {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001075 if (report("ERROR: $_[0]\n")) {
1076 our $clean = 0;
1077 our $cnt_error++;
1078 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001079}
1080sub WARN {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001081 if (report("WARNING: $_[0]\n")) {
1082 our $clean = 0;
1083 our $cnt_warn++;
1084 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001085}
1086sub CHK {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001087 if ($check && report("CHECK: $_[0]\n")) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001088 our $clean = 0;
1089 our $cnt_chk++;
1090 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001091}
1092
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001093sub check_absolute_file {
1094 my ($absolute, $herecurr) = @_;
1095 my $file = $absolute;
1096
1097 ##print "absolute<$absolute>\n";
1098
1099 # See if any suffix of this path is a path within the tree.
1100 while ($file =~ s@^[^/]*/@@) {
1101 if (-f "$root/$file") {
1102 ##print "file<$file>\n";
1103 last;
1104 }
1105 }
1106 if (! -f _) {
1107 return 0;
1108 }
1109
1110 # It is, so see if the prefix is acceptable.
1111 my $prefix = $absolute;
1112 substr($prefix, -length($file)) = '';
1113
1114 ##print "prefix<$prefix>\n";
1115 if ($prefix ne ".../") {
1116 WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr);
1117 }
1118}
1119
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001120sub process {
1121 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001122
1123 my $linenr=0;
1124 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001125 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001126 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001127 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001128
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001129 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001130 my $indent;
1131 my $previndent=0;
1132 my $stashindent=0;
1133
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001134 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001135 my $signoff = 0;
1136 my $is_patch = 0;
1137
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001138 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001139 our $cnt_lines = 0;
1140 our $cnt_error = 0;
1141 our $cnt_warn = 0;
1142 our $cnt_chk = 0;
1143
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001144 # Trace the real file/line as we go.
1145 my $realfile = '';
1146 my $realline = 0;
1147 my $realcnt = 0;
1148 my $here = '';
1149 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001150 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001151 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001152 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001153
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001154 my $prev_values = 'E';
1155
1156 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001157 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001158 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001159 my %suppress_export;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001160
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001161 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001162 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001163 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001164 my @setup_docs = ();
1165 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001166
1167 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001168 my $line;
1169 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001170 $linenr++;
1171 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001172
Andy Whitcroft773647a2008-03-28 14:15:58 -07001173 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001174 $setup_docs = 0;
1175 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1176 $setup_docs = 1;
1177 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001178 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001179 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001180 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1181 $realline=$1-1;
1182 if (defined $2) {
1183 $realcnt=$3+1;
1184 } else {
1185 $realcnt=1+1;
1186 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001187 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001188
1189 # Guestimate if this is a continuing comment. Run
1190 # the context looking for a comment "edge". If this
1191 # edge is a close comment then we must be in a comment
1192 # at context start.
1193 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001194 my $cnt = $realcnt;
1195 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1196 next if (defined $rawlines[$ln - 1] &&
1197 $rawlines[$ln - 1] =~ /^-/);
1198 $cnt--;
1199 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001200 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001201 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1202 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1203 ($edge) = $1;
1204 last;
1205 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001206 }
1207 if (defined $edge && $edge eq '*/') {
1208 $in_comment = 1;
1209 }
1210
1211 # Guestimate if this is a continuing comment. If this
1212 # is the start of a diff block and this line starts
1213 # ' *' then it is very likely a comment.
1214 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001215 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001216 {
1217 $in_comment = 1;
1218 }
1219
1220 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1221 sanitise_line_reset($in_comment);
1222
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001223 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001224 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001225 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001226 $line = sanitise_line($rawline);
1227 }
1228 push(@lines, $line);
1229
1230 if ($realcnt > 1) {
1231 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1232 } else {
1233 $realcnt = 0;
1234 }
1235
1236 #print "==>$rawline\n";
1237 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001238
1239 if ($setup_docs && $line =~ /^\+/) {
1240 push(@setup_docs, $line);
1241 }
1242 }
1243
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001244 $prefix = '';
1245
Andy Whitcroft773647a2008-03-28 14:15:58 -07001246 $realcnt = 0;
1247 $linenr = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001248 foreach my $line (@lines) {
1249 $linenr++;
1250
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001251 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001252
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001253#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001254 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001255 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001256 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001257 $realline=$1-1;
1258 if (defined $2) {
1259 $realcnt=$3+1;
1260 } else {
1261 $realcnt=1+1;
1262 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001263 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001264 $prev_values = 'E';
1265
Andy Whitcroft773647a2008-03-28 14:15:58 -07001266 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001267 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001268 %suppress_export = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001269 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001270
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001271# track the line number as we move through the hunk, note that
1272# new versions of GNU diff omit the leading space on completely
1273# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001274 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001275 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001276 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001277
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001278 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001279 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001280
1281 # Track the previous line.
1282 ($prevline, $stashline) = ($stashline, $line);
1283 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001284 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1285
Andy Whitcroft773647a2008-03-28 14:15:58 -07001286 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001287
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001288 } elsif ($realcnt == 1) {
1289 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001290 }
1291
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001292 my $hunk_line = ($realcnt != 0);
1293
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001294#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001295 $prefix = "$filename:$realline: " if ($emacs && $file);
1296 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1297
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001298 $here = "#$linenr: " if (!$file);
1299 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001300
1301 # extract the filename as it passes
1302 if ($line=~/^\+\+\+\s+(\S+)/) {
1303 $realfile = $1;
Wolfram Sang1e855722009-01-06 14:41:24 -08001304 $realfile =~ s@^([^/]*)/@@;
1305
1306 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001307 if (!$file && $tree && $p1_prefix ne '' &&
1308 -e "$root/$p1_prefix") {
Wolfram Sang1e855722009-01-06 14:41:24 -08001309 WARN("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1310 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001311
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001312 if ($realfile =~ m@^include/asm/@) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001313 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1314 }
1315 next;
1316 }
1317
Randy Dunlap389834b2007-06-08 13:47:03 -07001318 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001319
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001320 my $hereline = "$here\n$rawline\n";
1321 my $herecurr = "$here\n$rawline\n";
1322 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001323
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001324 $cnt_lines++ if ($realcnt != 0);
1325
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001326#check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001327 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001328 # This is a signoff, if ugly, so do not double report.
1329 $signoff++;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001330 if (!($line =~ /^\s*Signed-off-by:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001331 WARN("Signed-off-by: is the preferred form\n" .
1332 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001333 }
1334 if ($line =~ /^\s*signed-off-by:\S/i) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001335 WARN("space required after Signed-off-by:\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001336 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001337 }
1338 }
1339
Andy Whitcroft00df3442007-06-08 13:47:06 -07001340# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001341 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001342 ERROR("patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001343 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001344 }
1345
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001346# Check for absolute kernel paths.
1347 if ($tree) {
1348 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1349 my $file = $1;
1350
1351 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1352 check_absolute_file($1, $herecurr)) {
1353 #
1354 } else {
1355 check_absolute_file($file, $herecurr);
1356 }
1357 }
1358 }
1359
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001360# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1361 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001362 $rawline !~ m/^$UTF8*$/) {
1363 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1364
1365 my $blank = copy_spacing($rawline);
1366 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1367 my $hereptr = "$hereline$ptr\n";
1368
1369 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001370 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001371
Andy Whitcroft306708542008-10-15 22:02:28 -07001372# ignore non-hunk lines and lines being removed
1373 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001374
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001375#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001376 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001377 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001378 ERROR("DOS line endings\n" . $herevet);
1379
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001380 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1381 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001382 ERROR("trailing whitespace\n" . $herevet);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001383 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07001384
Andi Kleen33549572010-05-24 14:33:29 -07001385# check for Kconfig help text having a real description
1386 if ($realfile =~ /Kconfig/ &&
1387 $line =~ /\+?\s*(---)?help(---)?$/) {
1388 my $length = 0;
1389 for (my $l = $linenr; defined($lines[$l]); $l++) {
1390 my $f = $lines[$l];
1391 $f =~ s/#.*//;
1392 $f =~ s/^\s+//;
1393 next if ($f =~ /^$/);
1394 last if ($f =~ /^\s*config\s/);
1395 $length++;
1396 }
1397 WARN("please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($length < 4);
1398 }
1399
Andy Whitcroft5368df22008-10-15 22:02:27 -07001400# check we are in a valid source file if not then ignore this hunk
1401 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1402
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001403#80 column limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001404 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001405 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches691e6692010-03-05 13:43:51 -08001406 $line !~ /^\+\s*$logFunctions\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001407 $length > 80)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001408 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001409 WARN("line over 80 characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001410 }
1411
Joe Perches5e79d962010-03-05 13:43:55 -08001412# check for spaces before a quoted newline
1413 if ($rawline =~ /^.*\".*\s\\n/) {
1414 WARN("unnecessary whitespace before a quoted newline\n" . $herecurr);
1415 }
1416
Andy Whitcroft8905a672007-11-28 16:21:06 -08001417# check for adding lines without a newline.
1418 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1419 WARN("adding a line without newline at end of file\n" . $herecurr);
1420 }
1421
Mike Frysinger42e41c52009-09-21 17:04:40 -07001422# Blackfin: use hi/lo macros
1423 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1424 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1425 my $herevet = "$here\n" . cat_vet($line) . "\n";
1426 ERROR("use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
1427 }
1428 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1429 my $herevet = "$here\n" . cat_vet($line) . "\n";
1430 ERROR("use the HI() macro, not (... >> 16)\n" . $herevet);
1431 }
1432 }
1433
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001434# check we are in a valid source file C or perl if not then ignore this hunk
1435 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001436
1437# at the beginning of a line any tabs must come first and anything
1438# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001439 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1440 $rawline =~ /^\+\s* \s*/) {
1441 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001442 ERROR("code indent should use tabs where possible\n" . $herevet);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001443 }
1444
Alberto Panizzo08e44362010-03-05 13:43:54 -08001445# check for space before tabs.
1446 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1447 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1448 WARN("please, no space before tabs\n" . $herevet);
1449 }
1450
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001451# check we are in a valid C source file if not then ignore this hunk
1452 next if ($realfile !~ /\.(h|c)$/);
1453
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001454# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001455 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001456 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1457 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001458
Mike Frysinger42e41c52009-09-21 17:04:40 -07001459# Blackfin: don't use __builtin_bfin_[cs]sync
1460 if ($line =~ /__builtin_bfin_csync/) {
1461 my $herevet = "$here\n" . cat_vet($line) . "\n";
1462 ERROR("use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
1463 }
1464 if ($line =~ /__builtin_bfin_ssync/) {
1465 my $herevet = "$here\n" . cat_vet($line) . "\n";
1466 ERROR("use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
1467 }
1468
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001469# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001470 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1471 $realline_next);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001472 if ($realcnt && $line =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001473 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001474 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001475 $stat =~ s/\n./\n /g;
1476 $cond =~ s/\n./\n /g;
1477
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001478 # Find the real next line.
1479 $realline_next = $line_nr_next;
1480 if (defined $realline_next &&
1481 (!defined $lines[$realline_next - 1] ||
1482 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1483 $realline_next++;
1484 }
1485
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001486 my $s = $stat;
1487 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001488
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001489 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001490 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001491
1492 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001493 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001494
Andy Whitcroft463f2862009-09-21 17:04:34 -07001495 } elsif ($s =~ /^.\s*else\b/s) {
1496
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001497 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001498 } 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 -07001499 my $type = $1;
1500 $type =~ s/\s+/ /g;
1501 possible($type, "A:" . $s);
1502
Andy Whitcroft8905a672007-11-28 16:21:06 -08001503 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07001504 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001505 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001506 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001507
1508 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08001509 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001510 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001511 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001512
1513 # Check for any sort of function declaration.
1514 # int foo(something bar, other baz);
1515 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001516 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 -08001517 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001518
Andy Whitcroftcf655042008-03-04 14:28:20 -08001519 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001520 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001521 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001522
Andy Whitcroft8905a672007-11-28 16:21:06 -08001523 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001524 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001525
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001526 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001527 }
1528 }
1529 }
1530
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001531 }
1532
Andy Whitcroft653d4872007-06-23 17:16:34 -07001533#
1534# Checks which may be anchored in the context.
1535#
1536
1537# Check for switch () and associated case and default
1538# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07001539 if ($line=~/\bswitch\s*\(.*\)/) {
1540 my $err = '';
1541 my $sep = '';
1542 my @ctx = ctx_block_outer($linenr, $realcnt);
1543 shift(@ctx);
1544 for my $ctx (@ctx) {
1545 my ($clen, $cindent) = line_stats($ctx);
1546 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1547 $indent != $cindent) {
1548 $err .= "$sep$ctx\n";
1549 $sep = '';
1550 } else {
1551 $sep = "[...]\n";
1552 }
1553 }
1554 if ($err ne '') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001555 ERROR("switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001556 }
1557 }
1558
1559# if/while/etc brace do not go on next line, unless defining a do while loop,
1560# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001561 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001562 my $pre_ctx = "$1$2";
1563
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001564 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001565 my $ctx_cnt = $realcnt - $#ctx - 1;
1566 my $ctx = join("\n", @ctx);
1567
Andy Whitcroft548596d2008-07-23 21:29:01 -07001568 my $ctx_ln = $linenr;
1569 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001570
Andy Whitcroft548596d2008-07-23 21:29:01 -07001571 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1572 defined $lines[$ctx_ln - 1] &&
1573 $lines[$ctx_ln - 1] =~ /^-/)) {
1574 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1575 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001576 $ctx_ln++;
1577 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07001578
Andy Whitcroft53210162008-07-23 21:29:03 -07001579 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1580 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001581
1582 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1583 ERROR("that open brace { should be on the previous line\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001584 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07001585 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001586 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1587 $ctx =~ /\)\s*\;\s*$/ &&
1588 defined $lines[$ctx_ln - 1])
1589 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001590 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1591 if ($nindent > $indent) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001592 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001593 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001594 }
1595 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001596 }
1597
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001598# Check relative indent for conditionals and blocks.
1599 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1600 my ($s, $c) = ($stat, $cond);
1601
1602 substr($s, 0, length($c), '');
1603
1604 # Make sure we remove the line prefixes as we have
1605 # none on the first line, and are going to readd them
1606 # where necessary.
1607 $s =~ s/\n./\n/gs;
1608
1609 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07001610 my @newlines = ($c =~ /\n/gs);
1611 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001612
1613 # We want to check the first line inside the block
1614 # starting at the end of the conditional, so remove:
1615 # 1) any blank line termination
1616 # 2) any opening brace { on end of the line
1617 # 3) any do (...) {
1618 my $continuation = 0;
1619 my $check = 0;
1620 $s =~ s/^.*\bdo\b//;
1621 $s =~ s/^\s*{//;
1622 if ($s =~ s/^\s*\\//) {
1623 $continuation = 1;
1624 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001625 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001626 $check = 1;
1627 $cond_lines++;
1628 }
1629
1630 # Also ignore a loop construct at the end of a
1631 # preprocessor statement.
1632 if (($prevline =~ /^.\s*#\s*define\s/ ||
1633 $prevline =~ /\\\s*$/) && $continuation == 0) {
1634 $check = 0;
1635 }
1636
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001637 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07001638 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001639 while ($cond_ptr != $cond_lines) {
1640 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001641
Andy Whitcroftf16fa282008-10-15 22:02:32 -07001642 # If we see an #else/#elif then the code
1643 # is not linear.
1644 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1645 $check = 0;
1646 }
1647
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001648 # Ignore:
1649 # 1) blank lines, they should be at 0,
1650 # 2) preprocessor lines, and
1651 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07001652 if ($continuation ||
1653 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001654 $s =~ /^\s*#\s*?/ ||
1655 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07001656 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07001657 if ($s =~ s/^.*?\n//) {
1658 $cond_lines++;
1659 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001660 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001661 }
1662
1663 my (undef, $sindent) = line_stats("+" . $s);
1664 my $stat_real = raw_line($linenr, $cond_lines);
1665
1666 # Check if either of these lines are modified, else
1667 # this is not this patch's fault.
1668 if (!defined($stat_real) ||
1669 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1670 $check = 0;
1671 }
1672 if (defined($stat_real) && $cond_lines > 1) {
1673 $stat_real = "[...]\n$stat_real";
1674 }
1675
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001676 #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 -07001677
1678 if ($check && (($sindent % 8) != 0 ||
1679 ($sindent <= $indent && $s ne ''))) {
1680 WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1681 }
1682 }
1683
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001684 # Track the 'values' across context and added lines.
1685 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001686 my ($curr_values, $curr_vars) =
1687 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001688 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001689 if ($dbg_values) {
1690 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001691 print "$linenr > .$outline\n";
1692 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001693 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001694 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001695 $prev_values = substr($curr_values, -1);
1696
Andy Whitcroft00df3442007-06-08 13:47:06 -07001697#ignore lines not being added
1698 if ($line=~/^[^\+]/) {next;}
1699
Andy Whitcroft653d4872007-06-23 17:16:34 -07001700# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07001701 if ($dbg_type) {
1702 if ($line =~ /^.\s*$Declare\s*$/) {
1703 ERROR("TEST: is type\n" . $herecurr);
1704 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1705 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1706 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001707 next;
1708 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001709# TEST: allow direct testing of the attribute matcher.
1710 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08001711 if ($line =~ /^.\s*$Modifier\s*$/) {
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001712 ERROR("TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08001713 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001714 ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1715 }
1716 next;
1717 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001718
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001719# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07001720 if ($line =~ /^.\s*{/ &&
1721 $prevline =~ /(?:^|[^=])=\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001722 ERROR("that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001723 }
1724
Andy Whitcroft653d4872007-06-23 17:16:34 -07001725#
1726# Checks which are anchored on the added line.
1727#
1728
1729# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001730 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001731 my $path = $1;
1732 if ($path =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001733 ERROR("malformed #include filename\n" .
1734 $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001735 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001736 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001737
1738# no C99 // comments
1739 if ($line =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001740 ERROR("do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001741 }
1742 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001743 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001744 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001745
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001746# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
1747# the whole statement.
1748#print "APW <$lines[$realline_next - 1]>\n";
1749 if (defined $realline_next &&
1750 exists $lines[$realline_next - 1] &&
1751 !defined $suppress_export{$realline_next} &&
1752 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
1753 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001754 my $name = $1;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001755 if ($stat !~ /(?:
1756 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07001757 ^.DEFINE_$Ident\(\Q$name\E\)|
1758 ^.DECLARE_$Ident\(\Q$name\E\)|
1759 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001760 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
1761 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07001762 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001763#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
1764 $suppress_export{$realline_next} = 2;
1765 } else {
1766 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001767 }
1768 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001769 if (!defined $suppress_export{$linenr} &&
1770 $prevline =~ /^.\s*$/ &&
1771 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
1772 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1773#print "FOO B <$lines[$linenr - 1]>\n";
1774 $suppress_export{$linenr} = 2;
1775 }
1776 if (defined $suppress_export{$linenr} &&
1777 $suppress_export{$linenr} == 2) {
1778 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
1779 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001780
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001781# check for external initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001782 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001783 ERROR("do not initialise externals to 0 or NULL\n" .
1784 $herecurr);
1785 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001786# check for static initialisers.
Andy Whitcroft2d1bafd2009-01-06 14:41:28 -08001787 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001788 ERROR("do not initialise statics to 0 or NULL\n" .
1789 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001790 }
1791
Andy Whitcroft653d4872007-06-23 17:16:34 -07001792# check for new typedefs, only function parameters and sparse annotations
1793# make sense.
1794 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08001795 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001796 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07001797 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001798 $line !~ /\b__bitwise(?:__|)\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001799 WARN("do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001800 }
1801
1802# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08001803 # (char*[ const])
Andy Whitcroft00ef4ec2009-02-27 14:03:07 -08001804 if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001805 my ($from, $to) = ($1, $1);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001806
Andy Whitcroft65863862009-01-06 14:41:21 -08001807 # Should start with a space.
1808 $to =~ s/^(\S)/ $1/;
1809 # Should not end with a space.
1810 $to =~ s/\s+$//;
1811 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08001812 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001813 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001814
Andy Whitcroft65863862009-01-06 14:41:21 -08001815 #print "from<$from> to<$to>\n";
1816 if ($from ne $to) {
1817 ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
1818 }
Andy Whitcroft00ef4ec2009-02-27 14:03:07 -08001819 } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001820 my ($from, $to, $ident) = ($1, $1, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001821
Andy Whitcroft65863862009-01-06 14:41:21 -08001822 # Should start with a space.
1823 $to =~ s/^(\S)/ $1/;
1824 # Should not end with a space.
1825 $to =~ s/\s+$//;
1826 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08001827 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001828 }
1829 # Modifiers should have spaces.
1830 $to =~ s/(\b$Modifier$)/$1 /;
1831
Andy Whitcroft667026e2009-02-27 14:03:08 -08001832 #print "from<$from> to<$to> ident<$ident>\n";
1833 if ($from ne $to && $ident !~ /^$Modifier$/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001834 ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
1835 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001836 }
1837
1838# # no BUG() or BUG_ON()
1839# if ($line =~ /\b(BUG|BUG_ON)\b/) {
1840# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1841# print "$herecurr";
1842# $clean = 0;
1843# }
1844
Andy Whitcroft8905a672007-11-28 16:21:06 -08001845 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001846 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 -08001847 }
1848
Andy Whitcroft00df3442007-06-08 13:47:06 -07001849# printk should use KERN_* levels. Note that follow on printk's on the
1850# same line do not need a level, so we use the current block context
1851# to try and find and validate the current printk. In summary the current
1852# printk includes all preceeding printk's which have no newline on the end.
1853# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001854 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001855 my $ok = 0;
1856 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1857 #print "CHECK<$lines[$ln - 1]\n";
1858 # we have a preceeding printk if it ends
1859 # with "\n" ignore it, else it is to blame
1860 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1861 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1862 $ok = 1;
1863 }
1864 last;
1865 }
1866 }
1867 if ($ok == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001868 WARN("printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001869 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001870 }
1871
Andy Whitcroft653d4872007-06-23 17:16:34 -07001872# function brace can't be on same line, except for #defines of do while,
1873# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001874 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1875 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001876 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001877 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001878
Andy Whitcroft8905a672007-11-28 16:21:06 -08001879# open braces for enum, union and struct go on the same line.
1880 if ($line =~ /^.\s*{/ &&
1881 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1882 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1883 }
1884
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001885# check for spacing round square brackets; allowed:
1886# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001887# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1888# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001889 while ($line =~ /(.*?\s)\[/g) {
1890 my ($where, $prefix) = ($-[1], $1);
1891 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001892 ($where != 0 || $prefix !~ /^.\s+$/) &&
1893 $prefix !~ /{\s+$/) {
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001894 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1895 }
1896 }
1897
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001898# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001899 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001900 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001901 my $ctx_before = substr($line, 0, $-[1]);
1902 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001903
1904 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001905 if ($name =~ /^(?:
1906 if|for|while|switch|return|case|
1907 volatile|__volatile__|
1908 __attribute__|format|__extension__|
1909 asm|__asm__)$/x)
1910 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001911
1912 # cpp #define statements have non-optional spaces, ie
1913 # if there is a space between the name and the open
1914 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001915 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001916
1917 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001918 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001919
1920 # If this whole things ends with a type its most
1921 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001922 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001923
1924 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001925 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001926 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001927 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001928# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001929 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001930 my $ops = qr{
1931 <<=|>>=|<=|>=|==|!=|
1932 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1933 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001934 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1935 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001936 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001937 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001938 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001939
1940 my $blank = copy_spacing($opline);
1941
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001942 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001943 $off += length($elements[$n]);
1944
Andy Whitcroft773647a2008-03-28 14:15:58 -07001945 # Pick up the preceeding and succeeding characters.
1946 my $ca = substr($opline, 0, $off);
1947 my $cc = '';
1948 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1949 $cc = substr($opline, $off + length($elements[$n + 1]));
1950 }
1951 my $cb = "$ca$;$cc";
1952
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001953 my $a = '';
1954 $a = 'V' if ($elements[$n] ne '');
1955 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001956 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001957 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1958 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07001959 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001960
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001961 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001962
1963 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001964 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001965 $c = 'V' if ($elements[$n + 2] ne '');
1966 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001967 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001968 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1969 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08001970 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001971 } else {
1972 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001973 }
1974
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001975 my $ctx = "${a}x${c}";
1976
1977 my $at = "(ctx:$ctx)";
1978
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001979 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001980 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001981
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001982 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001983 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001984
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001985 # Get the full operator variant.
1986 my $opv = $op . substr($curr_vars, $off, 1);
1987
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001988 # Ignore operators passed as parameters.
1989 if ($op_type ne 'V' &&
1990 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1991
Andy Whitcroftcf655042008-03-04 14:28:20 -08001992# # Ignore comments
1993# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001994
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001995 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001996 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001997 if ($ctx !~ /.x[WEBC]/ &&
1998 $cc !~ /^\\/ && $cc !~ /^;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001999 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002000 }
2001
2002 # // is a comment
2003 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002004
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002005 # No spaces for:
2006 # ->
2007 # : when part of a bitfield
2008 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002009 if ($ctx =~ /Wx.|.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002010 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002011 }
2012
2013 # , must have a space on the right.
2014 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002015 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002016 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002017 }
2018
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002019 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002020 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002021 #warn "'*' is part of type\n";
2022
2023 # unary operators should have a space before and
2024 # none after. May be left adjacent to another
2025 # unary operator, or a cast
2026 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002027 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07002028 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002029 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002030 ERROR("space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002031 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08002032 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002033 # A unary '*' may be const
2034
2035 } elsif ($ctx =~ /.xW/) {
Andy Whitcroftfb9e9092009-09-21 17:04:38 -07002036 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002037 }
2038
2039 # unary ++ and unary -- are allowed no space on one side.
2040 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002041 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2042 ERROR("space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002043 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002044 if ($ctx =~ /Wx[BE]/ ||
2045 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
2046 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002047 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002048 if ($ctx =~ /ExW/) {
2049 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
2050 }
2051
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002052
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002053 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002054 } elsif ($op eq '<<' or $op eq '>>' or
2055 $op eq '&' or $op eq '^' or $op eq '|' or
2056 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002057 $op eq '*' or $op eq '/' or
2058 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002059 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002060 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002061 ERROR("need consistent spacing around '$op' $at\n" .
2062 $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002063 }
2064
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002065 # A colon needs no spaces before when it is
2066 # terminating a case value or a label.
2067 } elsif ($opv eq ':C' || $opv eq ':L') {
2068 if ($ctx =~ /Wx./) {
2069 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
2070 }
2071
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002072 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08002073 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002074 my $ok = 0;
2075
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002076 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002077 if (($op eq '<' &&
2078 $cc =~ /^\S+\@\S+>/) ||
2079 ($op eq '>' &&
2080 $ca =~ /<\S+\@\S+$/))
2081 {
2082 $ok = 1;
2083 }
2084
2085 # Ignore ?:
2086 if (($opv eq ':O' && $ca =~ /\?$/) ||
2087 ($op eq '?' && $cc =~ /^:/)) {
2088 $ok = 1;
2089 }
2090
2091 if ($ok == 0) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002092 ERROR("spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002093 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002094 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002095 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002096 }
2097 }
2098
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002099# check for multiple assignments
2100 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002101 CHK("multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002102 }
2103
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002104## # check for multiple declarations, allowing for a function declaration
2105## # continuation.
2106## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2107## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2108##
2109## # Remove any bracketed sections to ensure we do not
2110## # falsly report the parameters of functions.
2111## my $ln = $line;
2112## while ($ln =~ s/\([^\(\)]*\)//g) {
2113## }
2114## if ($ln =~ /,/) {
2115## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
2116## }
2117## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002118
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002119#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002120 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2121 $line =~ /do{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002122 ERROR("space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002123 }
2124
2125# closing brace should have a space following it when it has anything
2126# on the line
2127 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002128 ERROR("space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002129 }
2130
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002131# check spacing on square brackets
2132 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002133 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002134 }
2135 if ($line =~ /\s\]/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002136 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002137 }
2138
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002139# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002140 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2141 $line !~ /for\s*\(\s+;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002142 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002143 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002144 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002145 $line !~ /for\s*\(.*;\s+\)/ &&
2146 $line !~ /:\s+\)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002147 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002148 }
2149
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002150#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002151 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002152 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002153 WARN("labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002154 }
2155
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002156# Return is not a function.
2157 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2158 my $spacing = $1;
2159 my $value = $2;
2160
Andy Whitcroft86f9d052009-01-06 14:41:24 -08002161 # Flatten any parentheses
Andy Whitcroftfee61c42008-07-23 21:28:56 -07002162 $value =~ s/\)\(/\) \(/g;
Andy Whitcroft63f17f82009-01-15 13:51:06 -08002163 while ($value =~ s/\[[^\{\}]*\]/1/ ||
2164 $value !~ /(?:$Ident|-?$Constant)\s*
2165 $Compare\s*
2166 (?:$Ident|-?$Constant)/x &&
2167 $value =~ s/\([^\(\)]*\)/1/) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002168 }
2169
2170 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
2171 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
2172
2173 } elsif ($spacing !~ /\s+/) {
2174 ERROR("space required before the open parenthesis '('\n" . $herecurr);
2175 }
2176 }
2177
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002178# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002179 if ($line=~/\b(if|while|for|switch)\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002180 ERROR("space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002181 }
2182
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002183# Check for illegal assignment in if conditional -- and check for trailing
2184# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002185 if ($line =~ /do\s*(?!{)/) {
2186 my ($stat_next) = ctx_statement_block($line_nr_next,
2187 $remain_next, $off_next);
2188 $stat_next =~ s/\n./\n /g;
2189 ##print "stat<$stat> stat_next<$stat_next>\n";
2190
2191 if ($stat_next =~ /^\s*while\b/) {
2192 # If the statement carries leading newlines,
2193 # then count those as offsets.
2194 my ($whitespace) =
2195 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2196 my $offset =
2197 statement_rawlines($whitespace) - 1;
2198
2199 $suppress_whiletrailers{$line_nr_next +
2200 $offset} = 1;
2201 }
2202 }
2203 if (!defined $suppress_whiletrailers{$linenr} &&
2204 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002205 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002206
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08002207 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002208 ERROR("do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002209 }
2210
2211 # Find out what is on the end of the line after the
2212 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002213 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002214 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002215 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07002216 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2217 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002218 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002219 # Find out how long the conditional actually is.
2220 my @newlines = ($c =~ /\n/gs);
2221 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08002222 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002223
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08002224 $stat_real = raw_line($linenr, $cond_lines)
2225 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002226 if (defined($stat_real) && $cond_lines > 1) {
2227 $stat_real = "[...]\n$stat_real";
2228 }
2229
2230 ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002231 }
2232 }
2233
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002234# Check for bitwise tests written as boolean
2235 if ($line =~ /
2236 (?:
2237 (?:\[|\(|\&\&|\|\|)
2238 \s*0[xX][0-9]+\s*
2239 (?:\&\&|\|\|)
2240 |
2241 (?:\&\&|\|\|)
2242 \s*0[xX][0-9]+\s*
2243 (?:\&\&|\|\||\)|\])
2244 )/x)
2245 {
2246 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2247 }
2248
Andy Whitcroft8905a672007-11-28 16:21:06 -08002249# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002250 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2251 my $s = $1;
2252 $s =~ s/$;//g; # Remove any comments
2253 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2254 ERROR("trailing statements should be on next line\n" . $herecurr);
2255 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002256 }
Andy Whitcroft39667782009-01-15 13:51:06 -08002257# if should not continue a brace
2258 if ($line =~ /}\s*if\b/) {
2259 ERROR("trailing statements should be on next line\n" .
2260 $herecurr);
2261 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002262# case and default should not have general statements after them
2263 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2264 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07002265 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002266 \s*return\s+
2267 )/xg)
2268 {
2269 ERROR("trailing statements should be on next line\n" . $herecurr);
2270 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002271
2272 # Check for }<nl>else {, these must be at the same
2273 # indent level to be relevant to each other.
2274 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2275 $previndent == $indent) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002276 ERROR("else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002277 }
2278
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002279 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2280 $previndent == $indent) {
2281 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2282
2283 # Find out what is on the end of the line after the
2284 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002285 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002286 $s =~ s/\n.*//g;
2287
2288 if ($s =~ /^\s*;/) {
2289 ERROR("while should follow close brace '}'\n" . $hereprev);
2290 }
2291 }
2292
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002293#studly caps, commented out until figure out how to distinguish between use of existing and adding new
2294# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2295# print "No studly caps, use _\n";
2296# print "$herecurr";
2297# $clean = 0;
2298# }
2299
2300#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002301 if ($line=~/\#\s*define.*\\\s$/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002302 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002303 }
2304
Andy Whitcroft653d4872007-06-23 17:16:34 -07002305#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002306 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002307 my $file = "$1.h";
2308 my $checkfile = "include/linux/$file";
2309 if (-f "$root/$checkfile" &&
2310 $realfile ne $checkfile &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002311 $1 ne 'irq')
2312 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002313 if ($realfile =~ m{^arch/}) {
2314 CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2315 } else {
2316 WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2317 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002318 }
2319 }
2320
Andy Whitcroft653d4872007-06-23 17:16:34 -07002321# multi-statement macros should be enclosed in a do while loop, grab the
2322# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08002323# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07002324 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2325 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002326 my $ln = $linenr;
2327 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002328 my ($off, $dstat, $dcond, $rest);
2329 my $ctx = '';
Andy Whitcroft653d4872007-06-23 17:16:34 -07002330
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002331 my $args = defined($1);
2332
2333 # Find the end of the macro and limit our statement
2334 # search to that.
2335 while ($cnt > 0 && defined $lines[$ln - 1] &&
2336 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2337 {
2338 $ctx .= $rawlines[$ln - 1] . "\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002339 $cnt-- if ($lines[$ln - 1] !~ /^-/);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002340 $ln++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002341 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002342 $ctx .= $rawlines[$ln - 1];
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002343
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002344 ($dstat, $dcond, $ln, $cnt, $off) =
2345 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2346 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002347 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002348
2349 # Extract the remainder of the define (if any) and
2350 # rip off surrounding spaces, and trailing \'s.
2351 $rest = '';
Andy Whitcroft636d1402008-10-15 22:02:18 -07002352 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2353 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002354 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2355 $rest .= substr($lines[$ln - 1], $off) . "\n";
2356 $cnt--;
2357 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002358 $ln++;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002359 $off = 0;
2360 }
2361 $rest =~ s/\\\n.//g;
2362 $rest =~ s/^\s*//s;
2363 $rest =~ s/\s*$//s;
2364
2365 # Clean up the original statement.
2366 if ($args) {
2367 substr($dstat, 0, length($dcond), '');
2368 } else {
2369 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2370 }
Andy Whitcroft292f1a92008-07-23 21:29:11 -07002371 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002372 $dstat =~ s/\\\n.//g;
2373 $dstat =~ s/^\s*//s;
2374 $dstat =~ s/\s*$//s;
2375
2376 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07002377 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2378 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2379 $dstat =~ s/\[[^\{\}]*\]/1/)
2380 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002381 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002382
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002383 my $exceptions = qr{
2384 $Declare|
2385 module_param_named|
2386 MODULE_PARAM_DESC|
2387 DECLARE_PER_CPU|
2388 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08002389 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08002390 union|
2391 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07002392 \.$Ident\s*=\s*|
2393 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002394 }x;
Andy Whitcroft383099f2009-01-06 14:41:18 -08002395 #print "REST<$rest> dstat<$dstat>\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002396 if ($rest ne '') {
2397 if ($rest !~ /while\s*\(/ &&
2398 $dstat !~ /$exceptions/)
2399 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002400 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 -07002401 }
2402
2403 } elsif ($ctx !~ /;/) {
2404 if ($dstat ne '' &&
2405 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2406 $dstat !~ /$exceptions/ &&
Andy Whitcroftb132e5d2008-10-15 22:02:31 -07002407 $dstat !~ /^\.$Ident\s*=/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002408 $dstat =~ /$Operators/)
2409 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002410 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002411 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002412 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002413 }
2414
Mike Frysinger080ba922009-01-06 14:41:25 -08002415# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
2416# all assignments may have only one of the following with an assignment:
2417# .
2418# ALIGN(...)
2419# VMLINUX_SYMBOL(...)
2420 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
2421 WARN("vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
2422 }
2423
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002424# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002425 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2426 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08002427 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002428 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002429 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2430 if ($#chunks > 0 && $level == 0) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002431 my $allowed = 0;
2432 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002433 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002434 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002435 for my $chunk (@chunks) {
2436 my ($cond, $block) = @{$chunk};
2437
Andy Whitcroft773647a2008-03-28 14:15:58 -07002438 # If the condition carries leading newlines, then count those as offsets.
2439 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2440 my $offset = statement_rawlines($whitespace) - 1;
2441
2442 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2443
2444 # We have looked at and allowed this specific line.
2445 $suppress_ifbraces{$ln + $offset} = 1;
2446
2447 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002448 $ln += statement_rawlines($block) - 1;
2449
Andy Whitcroft773647a2008-03-28 14:15:58 -07002450 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002451
2452 $seen++ if ($block =~ /^\s*{/);
2453
Andy Whitcroftcf655042008-03-04 14:28:20 -08002454 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2455 if (statement_lines($cond) > 1) {
2456 #print "APW: ALLOWED: cond<$cond>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002457 $allowed = 1;
2458 }
2459 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002460 #print "APW: ALLOWED: block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002461 $allowed = 1;
2462 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002463 if (statement_block_size($block) > 1) {
2464 #print "APW: ALLOWED: lines block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002465 $allowed = 1;
2466 }
2467 }
2468 if ($seen && !$allowed) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002469 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002470 }
2471 }
2472 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002473 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002474 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002475 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002476
Andy Whitcroftcf655042008-03-04 14:28:20 -08002477 # Check the pre-context.
2478 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2479 #print "APW: ALLOWED: pre<$1>\n";
2480 $allowed = 1;
2481 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002482
2483 my ($level, $endln, @chunks) =
2484 ctx_statement_full($linenr, $realcnt, $-[0]);
2485
Andy Whitcroftcf655042008-03-04 14:28:20 -08002486 # Check the condition.
2487 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07002488 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002489 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002490 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08002491 }
2492 if (statement_lines($cond) > 1) {
2493 #print "APW: ALLOWED: cond<$cond>\n";
2494 $allowed = 1;
2495 }
2496 if ($block =~/\b(?:if|for|while)\b/) {
2497 #print "APW: ALLOWED: block<$block>\n";
2498 $allowed = 1;
2499 }
2500 if (statement_block_size($block) > 1) {
2501 #print "APW: ALLOWED: lines block<$block>\n";
2502 $allowed = 1;
2503 }
2504 # Check the post-context.
2505 if (defined $chunks[1]) {
2506 my ($cond, $block) = @{$chunks[1]};
2507 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002508 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002509 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002510 if ($block =~ /^\s*\{/) {
2511 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2512 $allowed = 1;
2513 }
2514 }
2515 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2516 my $herectx = $here . "\n";;
Andy Whitcroftf0556632008-10-15 22:02:23 -07002517 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002518
Andy Whitcroftf0556632008-10-15 22:02:23 -07002519 for (my $n = 0; $n < $cnt; $n++) {
2520 $herectx .= raw_line($linenr, $n) . "\n";;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002521 }
2522
2523 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002524 }
2525 }
2526
Andy Whitcroft653d4872007-06-23 17:16:34 -07002527# don't include deprecated include files (uses RAW line)
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002528 for my $inc (@dep_includes) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002529 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002530 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002531 }
2532 }
2533
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002534# don't use deprecated functions
2535 for my $func (@dep_functions) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002536 if ($line =~ /\b$func\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002537 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002538 }
2539 }
2540
2541# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002542 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2543 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002544 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002545 }
2546
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002547# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2548 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2549 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2550 }
2551
Andy Whitcroft00df3442007-06-08 13:47:06 -07002552# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002553 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002554 CHK("if this code is redundant consider removing it\n" .
2555 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002556 }
2557
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002558# check for needless kfree() checks
2559 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2560 my $expr = $1;
2561 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
Wolfram Sang3c232142008-07-23 21:29:05 -07002562 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002563 }
2564 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07002565# check for needless usb_free_urb() checks
2566 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2567 my $expr = $1;
2568 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2569 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2570 }
2571 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002572
Andy Whitcroft00df3442007-06-08 13:47:06 -07002573# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002574# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002575# print "#ifdef in C files should be avoided\n";
2576# print "$herecurr";
2577# $clean = 0;
2578# }
2579
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002580# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002581 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002582 ERROR("exactly one space required after that #$1\n" . $herecurr);
2583 }
2584
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002585# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002586 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2587 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002588 my $which = $1;
2589 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002590 CHK("$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002591 }
2592 }
2593# check for memory barriers without a comment.
2594 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2595 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002596 CHK("memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002597 }
2598 }
2599# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002600 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002601 CHK("architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002602 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002603
Tobias Klauserd4977c72010-05-24 14:33:30 -07002604# Check that the storage class is at the beginning of a declaration
2605 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
2606 WARN("storage class should be at the beginning of the declaration\n" . $herecurr)
2607 }
2608
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002609# check the location of the inline attribute, that it is between
2610# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002611 if ($line =~ /\b$Type\s+$Inline\b/ ||
2612 $line =~ /\b$Inline\s+$Storage\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002613 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2614 }
2615
Andy Whitcroft8905a672007-11-28 16:21:06 -08002616# Check for __inline__ and __inline, prefer inline
2617 if ($line =~ /\b(__inline__|__inline)\b/) {
2618 WARN("plain inline is preferred over $1\n" . $herecurr);
2619 }
2620
Joe Perches8f53a9b2010-03-05 13:43:48 -08002621# check for sizeof(&)
2622 if ($line =~ /\bsizeof\s*\(\s*\&/) {
2623 WARN("sizeof(& should be avoided\n" . $herecurr);
2624 }
2625
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002626# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002627 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002628 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002629 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002630 my $function_name = $1;
2631 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002632
2633 my $s = $stat;
2634 if (defined $cond) {
2635 substr($s, 0, length($cond), '');
2636 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002637 if ($s =~ /^\s*;/ &&
2638 $function_name ne 'uninitialized_var')
2639 {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002640 WARN("externs should be avoided in .c files\n" . $herecurr);
2641 }
2642
2643 if ($paren_space =~ /\n/) {
2644 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2645 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002646
2647 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2648 $stat =~ /^.\s*extern\s+/)
2649 {
2650 WARN("externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002651 }
2652
2653# checks for new __setup's
2654 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2655 my $name = $1;
2656
2657 if (!grep(/$name/, @setup_docs)) {
2658 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2659 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002660 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002661
2662# check for pointless casting of kmalloc return
2663 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2664 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2665 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002666
2667# check for gcc specific __FUNCTION__
2668 if ($line =~ /__FUNCTION__/) {
2669 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2670 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002671
2672# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002673 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002674 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2675 }
2676# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002677 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002678 WARN("consider using a completion\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01002679
Andy Whitcroft773647a2008-03-28 14:15:58 -07002680 }
2681# recommend strict_strto* over simple_strto*
2682 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2683 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2684 }
Michael Ellermanf3db6632008-07-23 21:28:57 -07002685# check for __initcall(), use device_initcall() explicitly please
2686 if ($line =~ /^.\s*__initcall\s*\(/) {
2687 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2688 }
Emese Revfy79404842010-03-05 13:43:53 -08002689# check for various ops structs, ensure they are const.
2690 my $struct_ops = qr{acpi_dock_ops|
2691 address_space_operations|
2692 backlight_ops|
2693 block_device_operations|
2694 dentry_operations|
2695 dev_pm_ops|
2696 dma_map_ops|
2697 extent_io_ops|
2698 file_lock_operations|
2699 file_operations|
2700 hv_ops|
2701 ide_dma_ops|
2702 intel_dvo_dev_ops|
2703 item_operations|
2704 iwl_ops|
2705 kgdb_arch|
2706 kgdb_io|
2707 kset_uevent_ops|
2708 lock_manager_operations|
2709 microcode_ops|
2710 mtrr_ops|
2711 neigh_ops|
2712 nlmsvc_binding|
2713 pci_raw_ops|
2714 pipe_buf_operations|
2715 platform_hibernation_ops|
2716 platform_suspend_ops|
2717 proto_ops|
2718 rpc_pipe_ops|
2719 seq_operations|
2720 snd_ac97_build_ops|
2721 soc_pcmcia_socket_ops|
2722 stacktrace_ops|
2723 sysfs_ops|
2724 tty_operations|
2725 usb_mon_operations|
2726 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08002727 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08002728 $line =~ /\bstruct\s+($struct_ops)\b/) {
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08002729 WARN("struct $1 should normally be const\n" .
2730 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08002731 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002732
2733# use of NR_CPUS is usually wrong
2734# ignore definitions of NR_CPUS and usage to define arrays as likely right
2735 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002736 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2737 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002738 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2739 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2740 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002741 {
2742 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2743 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002744
2745# check for %L{u,d,i} in strings
2746 my $string;
2747 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2748 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07002749 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002750 if ($string =~ /(?<!%)%L[udi]/) {
2751 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2752 last;
2753 }
2754 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08002755
2756# whine mightly about in_atomic
2757 if ($line =~ /\bin_atomic\s*\(/) {
2758 if ($realfile =~ m@^drivers/@) {
2759 ERROR("do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08002760 } elsif ($realfile !~ m@^kernel/@) {
Andy Whitcroft691d77b2009-01-06 14:41:16 -08002761 WARN("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
2762 }
2763 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01002764
2765# check for lockdep_set_novalidate_class
2766 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
2767 $line =~ /__lockdep_no_validate__\s*\)/ ) {
2768 if ($realfile !~ m@^kernel/lockdep@ &&
2769 $realfile !~ m@^include/linux/lockdep@ &&
2770 $realfile !~ m@^drivers/base/core@) {
2771 ERROR("lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
2772 }
2773 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002774 }
2775
2776 # If we have no input at all, then there is nothing to report on
2777 # so just keep quiet.
2778 if ($#rawlines == -1) {
2779 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002780 }
2781
Andy Whitcroft8905a672007-11-28 16:21:06 -08002782 # In mailback mode only produce a report in the negative, for
2783 # things that appear to be patches.
2784 if ($mailback && ($clean == 1 || !$is_patch)) {
2785 exit(0);
2786 }
2787
2788 # This is not a patch, and we are are in 'no-patch' mode so
2789 # just keep quiet.
2790 if (!$chk_patch && !$is_patch) {
2791 exit(0);
2792 }
2793
2794 if (!$is_patch) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002795 ERROR("Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002796 }
2797 if ($is_patch && $chk_signoff && $signoff == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002798 ERROR("Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002799 }
2800
Andy Whitcroft8905a672007-11-28 16:21:06 -08002801 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002802 if ($summary && !($clean == 1 && $quiet == 1)) {
2803 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002804 print "total: $cnt_error errors, $cnt_warn warnings, " .
2805 (($check)? "$cnt_chk checks, " : "") .
2806 "$cnt_lines lines checked\n";
2807 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002808 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002809
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002810 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002811 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002812 }
2813 if ($clean == 0 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002814 print "$vname has style problems, please review. If any of these errors\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002815 print "are false positives report them to the maintainer, see\n";
2816 print "CHECKPATCH in MAINTAINERS.\n";
2817 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002818
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002819 return $clean;
2820}