blob: 7fee82384ed4601ac455dc667fe1f190bed43e39 [file] [log] [blame]
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesf4432c52008-10-20 13:31:45 -04002# (c) 2001, Dave Jones. <davej@redhat.com> (the file handling bit)
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
5# (c) 2008, Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b5b2007-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 Whitcroft00df344f2007-06-08 13:47:06 -070011$P =~ s@.*/@@g;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070012
Andy Whitcroftbea56062009-02-27 14:03:09 -080013my $V = '0.28';
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -070066GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070067 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -0700129}
130
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700131my $emitted_corrupt = 0;
132
133our $Ident = qr{[A-Za-z_][A-Za-z\d_]*};
134our $Storage = qr{extern|static|asmlinkage};
135our $Sparse = qr{
136 __user|
137 __kernel|
138 __force|
139 __iomem|
140 __must_check|
141 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800142 __kprobes|
143 __ref
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700144 }x;
145our $Attribute = qr{
146 const|
147 __read_mostly|
148 __kprobes|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700149 __(?:mem|cpu|dev|)(?:initdata|init)|
150 ____cacheline_aligned|
151 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800152 ____cacheline_internodealigned_in_smp|
153 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700154 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700155our $Modifier;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700156our $Inline = qr{inline|__always_inline|noinline};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700157our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
158our $Lval = qr{$Ident(?:$Member)*};
159
160our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
161our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
Andy Whitcroft86f9d052009-01-06 14:41:24 -0800162our $Compare = qr{<=|>=|==|!=|<|>};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700163our $Operators = qr{
164 <=|>=|==|!=|
165 =>|->|<<|>>|<|>|!|~|
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800166 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700167 }x;
168
Andy Whitcroft8905a672007-11-28 16:21:06 -0800169our $NonptrType;
170our $Type;
171our $Declare;
172
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700173our $UTF8 = qr {
174 [\x09\x0A\x0D\x20-\x7E] # ASCII
175 | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
176 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
177 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
178 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
179 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
180 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
181 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
182}x;
183
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700184our $typeTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700185 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700186 atomic_t
187)};
188
Andy Whitcroft8905a672007-11-28 16:21:06 -0800189our @typeList = (
190 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700191 qr{(?:unsigned\s+)?char},
192 qr{(?:unsigned\s+)?short},
193 qr{(?:unsigned\s+)?int},
194 qr{(?:unsigned\s+)?long},
195 qr{(?:unsigned\s+)?long\s+int},
196 qr{(?:unsigned\s+)?long\s+long},
197 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800198 qr{unsigned},
199 qr{float},
200 qr{double},
201 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800202 qr{struct\s+$Ident},
203 qr{union\s+$Ident},
204 qr{enum\s+$Ident},
205 qr{${Ident}_t},
206 qr{${Ident}_handler},
207 qr{${Ident}_handler_fn},
208);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700209our @modifierList = (
210 qr{fastcall},
211);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800212
213sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700214 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
215 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700216 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800217 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700218 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800219 (?:
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700220 (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700221 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700222 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800223 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700224 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800225 }x;
226 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700227 $NonptrType
Andy Whitcroft65863862009-01-06 14:41:21 -0800228 (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700229 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800230 }x;
231 $Declare = qr{(?:$Storage\s+)?$Type};
232}
233build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700234
235$chk_signoff = 0 if ($file);
236
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700237my @dep_includes = ();
238my @dep_functions = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700239my $removal = "Documentation/feature-removal-schedule.txt";
240if ($tree && -f "$root/$removal") {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800241 open(my $REMOVE, '<', "$root/$removal") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700242 die "$P: $removal: open failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800243 while (<$REMOVE>) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700244 if (/^Check:\s+(.*\S)/) {
245 for my $entry (split(/[, ]+/, $1)) {
246 if ($entry =~ m@include/(.*)@) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700247 push(@dep_includes, $1);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700248
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700249 } elsif ($entry !~ m@/@) {
250 push(@dep_functions, $entry);
251 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700252 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700253 }
254 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800255 close($REMOVE);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700256}
257
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700258my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800259my @lines = ();
260my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700261for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800262 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700263 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800264 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700265 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800266 } elsif ($filename eq '-') {
267 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700268 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800269 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700270 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700271 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800272 if ($filename eq '-') {
273 $vname = 'Your patch';
274 } else {
275 $vname = $filename;
276 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800277 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700278 chomp;
279 push(@rawlines, $_);
280 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800281 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800282 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700283 $exit = 1;
284 }
285 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800286 @lines = ();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700287}
288
289exit($exit);
290
291sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700292 my ($root) = @_;
293
294 my @tree_check = (
295 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
296 "README", "Documentation", "arch", "include", "drivers",
297 "fs", "init", "ipc", "kernel", "lib", "scripts",
298 );
299
300 foreach my $check (@tree_check) {
301 if (! -e $root . '/' . $check) {
302 return 0;
303 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700304 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700305 return 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700306}
307
308sub expand_tabs {
309 my ($str) = @_;
310
311 my $res = '';
312 my $n = 0;
313 for my $c (split(//, $str)) {
314 if ($c eq "\t") {
315 $res .= ' ';
316 $n++;
317 for (; ($n % 8) != 0; $n++) {
318 $res .= ' ';
319 }
320 next;
321 }
322 $res .= $c;
323 $n++;
324 }
325
326 return $res;
327}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700328sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700329 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700330 return $res;
331}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700332
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700333sub line_stats {
334 my ($line) = @_;
335
336 # Drop the diff line leader and expand tabs
337 $line =~ s/^.//;
338 $line = expand_tabs($line);
339
340 # Pick the indent from the front of the line.
341 my ($white) = ($line =~ /^(\s*)/);
342
343 return (length($line), length($white));
344}
345
Andy Whitcroft773647a2008-03-28 14:15:58 -0700346my $sanitise_quote = '';
347
348sub sanitise_line_reset {
349 my ($in_comment) = @_;
350
351 if ($in_comment) {
352 $sanitise_quote = '*/';
353 } else {
354 $sanitise_quote = '';
355 }
356}
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700357sub sanitise_line {
358 my ($line) = @_;
359
360 my $res = '';
361 my $l = '';
362
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800363 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700364 my $off = 0;
365 my $c;
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700366
Andy Whitcroft773647a2008-03-28 14:15:58 -0700367 # Always copy over the diff marker.
368 $res = substr($line, 0, 1);
369
370 for ($off = 1; $off < length($line); $off++) {
371 $c = substr($line, $off, 1);
372
373 # Comments we are wacking completly including the begin
374 # and end, all to $;.
375 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
376 $sanitise_quote = '*/';
377
378 substr($res, $off, 2, "$;$;");
379 $off++;
380 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800381 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700382 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700383 $sanitise_quote = '';
384 substr($res, $off, 2, "$;$;");
385 $off++;
386 next;
387 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700388 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
389 $sanitise_quote = '//';
390
391 substr($res, $off, 2, $sanitise_quote);
392 $off++;
393 next;
394 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700395
396 # A \ in a string means ignore the next character.
397 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
398 $c eq "\\") {
399 substr($res, $off, 2, 'XX');
400 $off++;
401 next;
402 }
403 # Regular quotes.
404 if ($c eq "'" || $c eq '"') {
405 if ($sanitise_quote eq '') {
406 $sanitise_quote = $c;
407
408 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700409 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700410 } elsif ($sanitise_quote eq $c) {
411 $sanitise_quote = '';
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700412 }
413 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700414
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800415 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700416 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
417 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700418 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
419 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700420 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
421 substr($res, $off, 1, 'X');
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700422 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700423 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700424 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800425 }
426
Daniel Walker113f04a2009-09-21 17:04:35 -0700427 if ($sanitise_quote eq '//') {
428 $sanitise_quote = '';
429 }
430
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800431 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700432 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800433 my $clean = 'X' x length($1);
434 $res =~ s@\<.*\>@<$clean>@;
435
436 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700437 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800438 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700439 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800440 }
441
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700442 return $res;
443}
444
Andy Whitcroft8905a672007-11-28 16:21:06 -0800445sub ctx_statement_block {
446 my ($linenr, $remain, $off) = @_;
447 my $line = $linenr - 1;
448 my $blk = '';
449 my $soff = $off;
450 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700451 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800452
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800453 my $loff = 0;
454
Andy Whitcroft8905a672007-11-28 16:21:06 -0800455 my $type = '';
456 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800457 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800458 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800459 my $c;
460 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800461
462 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800463 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800464 @stack = (['', 0]) if ($#stack == -1);
465
Andy Whitcroft773647a2008-03-28 14:15:58 -0700466 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800467 # If we are about to drop off the end, pull in more
468 # context.
469 if ($off >= $len) {
470 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700471 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800472 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800473 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800474 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800475 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800476 $len = length($blk);
477 $line++;
478 last;
479 }
480 # Bail if there is no further context.
481 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800482 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800483 last;
484 }
485 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800486 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800487 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800488 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800489
Andy Whitcroft773647a2008-03-28 14:15:58 -0700490 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800491
492 # Handle nested #if/#else.
493 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
494 push(@stack, [ $type, $level ]);
495 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
496 ($type, $level) = @{$stack[$#stack - 1]};
497 } elsif ($remainder =~ /^#\s*endif\b/) {
498 ($type, $level) = @{pop(@stack)};
499 }
500
Andy Whitcroft8905a672007-11-28 16:21:06 -0800501 # Statement ends at the ';' or a close '}' at the
502 # outermost level.
503 if ($level == 0 && $c eq ';') {
504 last;
505 }
506
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800507 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700508 if ($level == 0 && $coff_set == 0 &&
509 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
510 $remainder =~ /^(else)(?:\s|{)/ &&
511 $remainder !~ /^else\s+if\b/) {
512 $coff = $off + length($1) - 1;
513 $coff_set = 1;
514 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
515 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800516 }
517
Andy Whitcroft8905a672007-11-28 16:21:06 -0800518 if (($type eq '' || $type eq '(') && $c eq '(') {
519 $level++;
520 $type = '(';
521 }
522 if ($type eq '(' && $c eq ')') {
523 $level--;
524 $type = ($level != 0)? '(' : '';
525
526 if ($level == 0 && $coff < $soff) {
527 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700528 $coff_set = 1;
529 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800530 }
531 }
532 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) {
541 last;
542 }
543 }
544 $off++;
545 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700546 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800547 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700548 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800549 $line++;
550 $remain--;
551 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800552
553 my $statement = substr($blk, $soff, $off - $soff + 1);
554 my $condition = substr($blk, $soff, $coff - $soff + 1);
555
556 #warn "STATEMENT<$statement>\n";
557 #warn "CONDITION<$condition>\n";
558
Andy Whitcroft773647a2008-03-28 14:15:58 -0700559 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800560
561 return ($statement, $condition,
562 $line, $remain + 1, $off - $loff + 1, $level);
563}
564
Andy Whitcroftcf655042008-03-04 14:28:20 -0800565sub statement_lines {
566 my ($stmt) = @_;
567
568 # Strip the diff line prefixes and rip blank lines at start and end.
569 $stmt =~ s/(^|\n)./$1/g;
570 $stmt =~ s/^\s*//;
571 $stmt =~ s/\s*$//;
572
573 my @stmt_lines = ($stmt =~ /\n/g);
574
575 return $#stmt_lines + 2;
576}
577
578sub statement_rawlines {
579 my ($stmt) = @_;
580
581 my @stmt_lines = ($stmt =~ /\n/g);
582
583 return $#stmt_lines + 2;
584}
585
586sub statement_block_size {
587 my ($stmt) = @_;
588
589 $stmt =~ s/(^|\n)./$1/g;
590 $stmt =~ s/^\s*{//;
591 $stmt =~ s/}\s*$//;
592 $stmt =~ s/^\s*//;
593 $stmt =~ s/\s*$//;
594
595 my @stmt_lines = ($stmt =~ /\n/g);
596 my @stmt_statements = ($stmt =~ /;/g);
597
598 my $stmt_lines = $#stmt_lines + 2;
599 my $stmt_statements = $#stmt_statements + 1;
600
601 if ($stmt_lines > $stmt_statements) {
602 return $stmt_lines;
603 } else {
604 return $stmt_statements;
605 }
606}
607
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800608sub ctx_statement_full {
609 my ($linenr, $remain, $off) = @_;
610 my ($statement, $condition, $level);
611
612 my (@chunks);
613
Andy Whitcroftcf655042008-03-04 14:28:20 -0800614 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800615 ($statement, $condition, $linenr, $remain, $off, $level) =
616 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700617 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800618 push(@chunks, [ $condition, $statement ]);
619 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
620 return ($level, $linenr, @chunks);
621 }
622
623 # Pull in the following conditional/block pairs and see if they
624 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800625 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800626 ($statement, $condition, $linenr, $remain, $off, $level) =
627 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800628 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700629 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800630 #print "C: push\n";
631 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800632 }
633
634 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800635}
636
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700637sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700638 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700639 my $line;
640 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700641 my $blk = '';
642 my @o;
643 my @c;
644 my @res = ();
645
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700646 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800647 my @stack = ($level);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700648 for ($line = $start; $remain > 0; $line++) {
649 next if ($rawlines[$line] =~ /^-/);
650 $remain--;
651
652 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800653
654 # Handle nested #if/#else.
655 if ($rawlines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
656 push(@stack, $level);
657 } elsif ($rawlines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
658 $level = $stack[$#stack - 1];
659 } elsif ($rawlines[$line] =~ /^.\s*#\s*endif\b/) {
660 $level = pop(@stack);
661 }
662
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700663 foreach my $c (split(//, $rawlines[$line])) {
664 ##print "C<$c>L<$level><$open$close>O<$off>\n";
665 if ($off > 0) {
666 $off--;
667 next;
668 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700669
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700670 if ($c eq $close && $level > 0) {
671 $level--;
672 last if ($level == 0);
673 } elsif ($c eq $open) {
674 $level++;
675 }
676 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700677
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700678 if (!$outer || $level <= 1) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700679 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700680 }
681
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700682 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700683 }
684
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700685 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700686}
687sub ctx_block_outer {
688 my ($linenr, $remain) = @_;
689
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700690 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
691 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700692}
693sub ctx_block {
694 my ($linenr, $remain) = @_;
695
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700696 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
697 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700698}
699sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700700 my ($linenr, $remain, $off) = @_;
701
702 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
703 return @r;
704}
705sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700706 my ($linenr, $remain) = @_;
707
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700708 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700709}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700710sub ctx_statement_level {
711 my ($linenr, $remain, $off) = @_;
712
713 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
714}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700715
716sub ctx_locate_comment {
717 my ($first_line, $end_line) = @_;
718
719 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700720 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700721 return $current_comment if (defined $current_comment);
722
723 # Look through the context and try and figure out if there is a
724 # comment.
725 my $in_comment = 0;
726 $current_comment = '';
727 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700728 my $line = $rawlines[$linenr - 1];
729 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700730 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
731 $in_comment = 1;
732 }
733 if ($line =~ m@/\*@) {
734 $in_comment = 1;
735 }
736 if (!$in_comment && $current_comment ne '') {
737 $current_comment = '';
738 }
739 $current_comment .= $line . "\n" if ($in_comment);
740 if ($line =~ m@\*/@) {
741 $in_comment = 0;
742 }
743 }
744
745 chomp($current_comment);
746 return($current_comment);
747}
748sub ctx_has_comment {
749 my ($first_line, $end_line) = @_;
750 my $cmt = ctx_locate_comment($first_line, $end_line);
751
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700752 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700753 ##print "CMMT: $cmt\n";
754
755 return ($cmt ne '');
756}
757
Andy Whitcroft4d001e42008-10-15 22:02:21 -0700758sub raw_line {
759 my ($linenr, $cnt) = @_;
760
761 my $offset = $linenr - 1;
762 $cnt++;
763
764 my $line;
765 while ($cnt) {
766 $line = $rawlines[$offset++];
767 next if (defined($line) && $line =~ /^-/);
768 $cnt--;
769 }
770
771 return $line;
772}
773
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700774sub cat_vet {
775 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700776 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700777
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700778 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700779 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
780 $res .= $1;
781 if ($2 ne '') {
782 $coded = sprintf("^%c", unpack('C', $2) + 64);
783 $res .= $coded;
784 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700785 }
786 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700787
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700788 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700789}
790
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800791my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800792my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800793my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700794my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800795
796sub annotate_reset {
797 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800798 $av_pending = '_';
799 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700800 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800801}
802
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700803sub annotate_values {
804 my ($stream, $type) = @_;
805
806 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700807 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700808 my $cur = $stream;
809
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800810 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700811
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700812 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700813 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800814 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700815 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700816 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800817 print "WS($1)\n" if ($dbg_values > 1);
818 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800819 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800820 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700821 }
822
Andy Whitcroft8ea3eb92008-07-23 21:29:08 -0700823 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800824 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700825 $type = 'T';
826
Andy Whitcroft389a2fe2008-07-23 21:29:05 -0700827 } elsif ($cur =~ /^($Modifier)\s*/) {
828 print "MODIFIER($1)\n" if ($dbg_values > 1);
829 $type = 'T';
830
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700831 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700832 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800833 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700834 push(@av_paren_type, $type);
835 if ($2 ne '') {
836 $av_pending = 'N';
837 }
838 $type = 'E';
839
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700840 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700841 print "UNDEF($1)\n" if ($dbg_values > 1);
842 $av_preprocessor = 1;
843 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700844
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700845 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800846 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800847 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800848
849 push(@av_paren_type, $type);
850 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700851 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800852
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700853 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800854 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
855 $av_preprocessor = 1;
856
857 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
858
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700859 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800860
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700861 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800862 print "PRE_END($1)\n" if ($dbg_values > 1);
863
864 $av_preprocessor = 1;
865
866 # Assume all arms of the conditional end as this
867 # one does, and continue as if the #endif was not here.
868 pop(@av_paren_type);
869 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700870 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700871
872 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800873 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700874
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700875 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
876 print "ATTR($1)\n" if ($dbg_values > 1);
877 $av_pending = $type;
878 $type = 'N';
879
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700880 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800881 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700882 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800883 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700884 }
885 $type = 'N';
886
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700887 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800888 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700889 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700890 $type = 'N';
891
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700892 } elsif ($cur =~/^(case)/o) {
893 print "CASE($1)\n" if ($dbg_values > 1);
894 $av_pend_colon = 'C';
895 $type = 'N';
896
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700897 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800898 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700899 $type = 'N';
900
901 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800902 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800903 push(@av_paren_type, $av_pending);
904 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700905 $type = 'N';
906
907 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800908 my $new_type = pop(@av_paren_type);
909 if ($new_type ne '_') {
910 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800911 print "PAREN('$1') -> $type\n"
912 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700913 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800914 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700915 }
916
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700917 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800918 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700919 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800920 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700921
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800922 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
923 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700924 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800925 } elsif ($type eq 'E') {
926 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700927 }
928 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
929 $type = 'V';
930
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700931 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800932 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700933 $type = 'V';
934
935 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800936 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700937 $type = 'N';
938
Andy Whitcroftcf655042008-03-04 14:28:20 -0800939 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800940 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800941 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700942 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800943
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800944 } elsif ($cur =~/^(,)/) {
945 print "COMMA($1)\n" if ($dbg_values > 1);
946 $type = 'C';
947
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700948 } elsif ($cur =~ /^(\?)/o) {
949 print "QUESTION($1)\n" if ($dbg_values > 1);
950 $type = 'N';
951
952 } elsif ($cur =~ /^(:)/o) {
953 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
954
955 substr($var, length($res), 1, $av_pend_colon);
956 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
957 $type = 'E';
958 } else {
959 $type = 'N';
960 }
961 $av_pend_colon = 'O';
962
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800963 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800964 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700965 $type = 'N';
966
Andy Whitcroft0d413862008-10-15 22:02:16 -0700967 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -0700968 my $variant;
969
970 print "OPV($1)\n" if ($dbg_values > 1);
971 if ($type eq 'V') {
972 $variant = 'B';
973 } else {
974 $variant = 'U';
975 }
976
977 substr($var, length($res), 1, $variant);
978 $type = 'N';
979
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700980 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800981 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700982 if ($1 ne '++' && $1 ne '--') {
983 $type = 'N';
984 }
985
986 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800987 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700988 }
989 if (defined $1) {
990 $cur = substr($cur, length($1));
991 $res .= $type x length($1);
992 }
993 }
994
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700995 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700996}
997
Andy Whitcroft8905a672007-11-28 16:21:06 -0800998sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800999 my ($possible, $line) = @_;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001000
Andy Whitcroft0776e592008-10-15 22:02:29 -07001001 print "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1002 if ($possible !~ /(?:
1003 ^(?:
1004 $Modifier|
1005 $Storage|
1006 $Type|
1007 DEFINE_\S+|
1008 goto|
1009 return|
1010 case|
1011 else|
1012 asm|__asm__|
1013 do
1014 )$|
1015 ^(?:typedef|struct|enum)\b
1016 )/x) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001017 # Check for modifiers.
1018 $possible =~ s/\s*$Storage\s*//g;
1019 $possible =~ s/\s*$Sparse\s*//g;
1020 if ($possible =~ /^\s*$/) {
1021
1022 } elsif ($possible =~ /\s/) {
1023 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001024 for my $modifier (split(' ', $possible)) {
1025 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1026 push(@modifierList, $modifier);
1027 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001028
1029 } else {
1030 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1031 push(@typeList, $possible);
1032 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001033 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001034 } else {
1035 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001036 }
1037}
1038
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001039my $prefix = '';
1040
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001041sub report {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001042 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
1043 return 0;
1044 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001045 my $line = $prefix . $_[0];
1046
1047 $line = (split('\n', $line))[0] . "\n" if ($terse);
1048
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001049 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001050
1051 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001052}
1053sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001054 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001055}
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001056sub ERROR {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001057 if (report("ERROR: $_[0]\n")) {
1058 our $clean = 0;
1059 our $cnt_error++;
1060 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001061}
1062sub WARN {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001063 if (report("WARNING: $_[0]\n")) {
1064 our $clean = 0;
1065 our $cnt_warn++;
1066 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001067}
1068sub CHK {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001069 if ($check && report("CHECK: $_[0]\n")) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001070 our $clean = 0;
1071 our $cnt_chk++;
1072 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001073}
1074
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001075sub check_absolute_file {
1076 my ($absolute, $herecurr) = @_;
1077 my $file = $absolute;
1078
1079 ##print "absolute<$absolute>\n";
1080
1081 # See if any suffix of this path is a path within the tree.
1082 while ($file =~ s@^[^/]*/@@) {
1083 if (-f "$root/$file") {
1084 ##print "file<$file>\n";
1085 last;
1086 }
1087 }
1088 if (! -f _) {
1089 return 0;
1090 }
1091
1092 # It is, so see if the prefix is acceptable.
1093 my $prefix = $absolute;
1094 substr($prefix, -length($file)) = '';
1095
1096 ##print "prefix<$prefix>\n";
1097 if ($prefix ne ".../") {
1098 WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr);
1099 }
1100}
1101
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001102sub process {
1103 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001104
1105 my $linenr=0;
1106 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001107 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001108 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001109 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001110
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001111 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001112 my $indent;
1113 my $previndent=0;
1114 my $stashindent=0;
1115
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001116 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001117 my $signoff = 0;
1118 my $is_patch = 0;
1119
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001120 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001121 our $cnt_lines = 0;
1122 our $cnt_error = 0;
1123 our $cnt_warn = 0;
1124 our $cnt_chk = 0;
1125
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001126 # Trace the real file/line as we go.
1127 my $realfile = '';
1128 my $realline = 0;
1129 my $realcnt = 0;
1130 my $here = '';
1131 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001132 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001133 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001134 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001135
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001136 my $prev_values = 'E';
1137
1138 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001139 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001140 my %suppress_whiletrailers;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001141
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001142 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001143 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001144 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001145 my @setup_docs = ();
1146 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001147
1148 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001149 my $line;
1150 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001151 $linenr++;
1152 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001153
Andy Whitcroft773647a2008-03-28 14:15:58 -07001154 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001155 $setup_docs = 0;
1156 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1157 $setup_docs = 1;
1158 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001159 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001160 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001161 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1162 $realline=$1-1;
1163 if (defined $2) {
1164 $realcnt=$3+1;
1165 } else {
1166 $realcnt=1+1;
1167 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001168 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001169
1170 # Guestimate if this is a continuing comment. Run
1171 # the context looking for a comment "edge". If this
1172 # edge is a close comment then we must be in a comment
1173 # at context start.
1174 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001175 my $cnt = $realcnt;
1176 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1177 next if (defined $rawlines[$ln - 1] &&
1178 $rawlines[$ln - 1] =~ /^-/);
1179 $cnt--;
1180 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001181 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001182 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1183 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1184 ($edge) = $1;
1185 last;
1186 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001187 }
1188 if (defined $edge && $edge eq '*/') {
1189 $in_comment = 1;
1190 }
1191
1192 # Guestimate if this is a continuing comment. If this
1193 # is the start of a diff block and this line starts
1194 # ' *' then it is very likely a comment.
1195 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001196 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001197 {
1198 $in_comment = 1;
1199 }
1200
1201 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1202 sanitise_line_reset($in_comment);
1203
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001204 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001205 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001206 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001207 $line = sanitise_line($rawline);
1208 }
1209 push(@lines, $line);
1210
1211 if ($realcnt > 1) {
1212 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1213 } else {
1214 $realcnt = 0;
1215 }
1216
1217 #print "==>$rawline\n";
1218 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001219
1220 if ($setup_docs && $line =~ /^\+/) {
1221 push(@setup_docs, $line);
1222 }
1223 }
1224
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001225 $prefix = '';
1226
Andy Whitcroft773647a2008-03-28 14:15:58 -07001227 $realcnt = 0;
1228 $linenr = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001229 foreach my $line (@lines) {
1230 $linenr++;
1231
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001232 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft306708542008-10-15 22:02:28 -07001233 my $hunk_line = ($realcnt != 0);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001234
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001235#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001236 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001237 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001238 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001239 $realline=$1-1;
1240 if (defined $2) {
1241 $realcnt=$3+1;
1242 } else {
1243 $realcnt=1+1;
1244 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001245 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001246 $prev_values = 'E';
1247
Andy Whitcroft773647a2008-03-28 14:15:58 -07001248 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001249 %suppress_whiletrailers = ();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001250 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001251
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001252# track the line number as we move through the hunk, note that
1253# new versions of GNU diff omit the leading space on completely
1254# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001255 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001256 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001257 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001258
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001259 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001260 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001261
1262 # Track the previous line.
1263 ($prevline, $stashline) = ($stashline, $line);
1264 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001265 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1266
Andy Whitcroft773647a2008-03-28 14:15:58 -07001267 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001268
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001269 } elsif ($realcnt == 1) {
1270 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001271 }
1272
1273#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001274 $prefix = "$filename:$realline: " if ($emacs && $file);
1275 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1276
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001277 $here = "#$linenr: " if (!$file);
1278 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001279
1280 # extract the filename as it passes
1281 if ($line=~/^\+\+\+\s+(\S+)/) {
1282 $realfile = $1;
Wolfram Sang1e855722009-01-06 14:41:24 -08001283 $realfile =~ s@^([^/]*)/@@;
1284
1285 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001286 if (!$file && $tree && $p1_prefix ne '' &&
1287 -e "$root/$p1_prefix") {
Wolfram Sang1e855722009-01-06 14:41:24 -08001288 WARN("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1289 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001290
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001291 if ($realfile =~ m@^include/asm/@) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001292 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1293 }
1294 next;
1295 }
1296
Randy Dunlap389834b2007-06-08 13:47:03 -07001297 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001298
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001299 my $hereline = "$here\n$rawline\n";
1300 my $herecurr = "$here\n$rawline\n";
1301 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001302
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001303 $cnt_lines++ if ($realcnt != 0);
1304
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001305#check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001306 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001307 # This is a signoff, if ugly, so do not double report.
1308 $signoff++;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001309 if (!($line =~ /^\s*Signed-off-by:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001310 WARN("Signed-off-by: is the preferred form\n" .
1311 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001312 }
1313 if ($line =~ /^\s*signed-off-by:\S/i) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001314 WARN("space required after Signed-off-by:\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001315 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001316 }
1317 }
1318
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001319# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001320 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001321 ERROR("patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001322 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001323 }
1324
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001325# Check for absolute kernel paths.
1326 if ($tree) {
1327 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1328 my $file = $1;
1329
1330 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1331 check_absolute_file($1, $herecurr)) {
1332 #
1333 } else {
1334 check_absolute_file($file, $herecurr);
1335 }
1336 }
1337 }
1338
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001339# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1340 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001341 $rawline !~ m/^$UTF8*$/) {
1342 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1343
1344 my $blank = copy_spacing($rawline);
1345 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1346 my $hereptr = "$hereline$ptr\n";
1347
1348 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001349 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001350
Andy Whitcroft306708542008-10-15 22:02:28 -07001351# ignore non-hunk lines and lines being removed
1352 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001353
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001354#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001355 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001356 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001357 ERROR("DOS line endings\n" . $herevet);
1358
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001359 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1360 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001361 ERROR("trailing whitespace\n" . $herevet);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001362 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07001363
1364# check we are in a valid source file if not then ignore this hunk
1365 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1366
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001367#80 column limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001368 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001369 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1370 $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1371 $length > 80)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001372 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001373 WARN("line over 80 characters\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001374 }
1375
Andy Whitcroft8905a672007-11-28 16:21:06 -08001376# check for adding lines without a newline.
1377 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1378 WARN("adding a line without newline at end of file\n" . $herecurr);
1379 }
1380
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001381# check we are in a valid source file C or perl if not then ignore this hunk
1382 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001383
1384# at the beginning of a line any tabs must come first and anything
1385# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001386 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1387 $rawline =~ /^\+\s* \s*/) {
1388 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001389 ERROR("code indent should use tabs where possible\n" . $herevet);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001390 }
1391
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001392# check we are in a valid C source file if not then ignore this hunk
1393 next if ($realfile !~ /\.(h|c)$/);
1394
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001395# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001396 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001397 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1398 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001399
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001400# Check for potential 'bare' types
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001401 my ($stat, $cond, $line_nr_next, $remain_next, $off_next);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001402 if ($realcnt && $line =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001403 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001404 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001405 $stat =~ s/\n./\n /g;
1406 $cond =~ s/\n./\n /g;
1407
1408 my $s = $stat;
1409 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001410
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001411 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001412 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001413
1414 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001415 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001416
Andy Whitcroft463f2862009-09-21 17:04:34 -07001417 } elsif ($s =~ /^.\s*else\b/s) {
1418
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001419 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001420 } 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 -07001421 my $type = $1;
1422 $type =~ s/\s+/ /g;
1423 possible($type, "A:" . $s);
1424
Andy Whitcroft8905a672007-11-28 16:21:06 -08001425 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07001426 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001427 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001428 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001429
1430 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08001431 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001432 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001433 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001434
1435 # Check for any sort of function declaration.
1436 # int foo(something bar, other baz);
1437 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001438 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 -08001439 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001440
Andy Whitcroftcf655042008-03-04 14:28:20 -08001441 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001442 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001443 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001444
Andy Whitcroft8905a672007-11-28 16:21:06 -08001445 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001446 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001447
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001448 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001449 }
1450 }
1451 }
1452
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001453 }
1454
Andy Whitcroft653d4872007-06-23 17:16:34 -07001455#
1456# Checks which may be anchored in the context.
1457#
1458
1459# Check for switch () and associated case and default
1460# statements should be at the same indent.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001461 if ($line=~/\bswitch\s*\(.*\)/) {
1462 my $err = '';
1463 my $sep = '';
1464 my @ctx = ctx_block_outer($linenr, $realcnt);
1465 shift(@ctx);
1466 for my $ctx (@ctx) {
1467 my ($clen, $cindent) = line_stats($ctx);
1468 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1469 $indent != $cindent) {
1470 $err .= "$sep$ctx\n";
1471 $sep = '';
1472 } else {
1473 $sep = "[...]\n";
1474 }
1475 }
1476 if ($err ne '') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001477 ERROR("switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001478 }
1479 }
1480
1481# if/while/etc brace do not go on next line, unless defining a do while loop,
1482# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001483 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001484 my $pre_ctx = "$1$2";
1485
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001486 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001487 my $ctx_cnt = $realcnt - $#ctx - 1;
1488 my $ctx = join("\n", @ctx);
1489
Andy Whitcroft548596d2008-07-23 21:29:01 -07001490 my $ctx_ln = $linenr;
1491 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001492
Andy Whitcroft548596d2008-07-23 21:29:01 -07001493 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1494 defined $lines[$ctx_ln - 1] &&
1495 $lines[$ctx_ln - 1] =~ /^-/)) {
1496 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1497 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001498 $ctx_ln++;
1499 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07001500
Andy Whitcroft53210162008-07-23 21:29:03 -07001501 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1502 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001503
1504 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1505 ERROR("that open brace { should be on the previous line\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001506 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001507 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001508 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1509 $ctx =~ /\)\s*\;\s*$/ &&
1510 defined $lines[$ctx_ln - 1])
1511 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001512 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1513 if ($nindent > $indent) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001514 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001515 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001516 }
1517 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001518 }
1519
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001520# Check relative indent for conditionals and blocks.
1521 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1522 my ($s, $c) = ($stat, $cond);
1523
1524 substr($s, 0, length($c), '');
1525
1526 # Make sure we remove the line prefixes as we have
1527 # none on the first line, and are going to readd them
1528 # where necessary.
1529 $s =~ s/\n./\n/gs;
1530
1531 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07001532 my @newlines = ($c =~ /\n/gs);
1533 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001534
1535 # We want to check the first line inside the block
1536 # starting at the end of the conditional, so remove:
1537 # 1) any blank line termination
1538 # 2) any opening brace { on end of the line
1539 # 3) any do (...) {
1540 my $continuation = 0;
1541 my $check = 0;
1542 $s =~ s/^.*\bdo\b//;
1543 $s =~ s/^\s*{//;
1544 if ($s =~ s/^\s*\\//) {
1545 $continuation = 1;
1546 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001547 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001548 $check = 1;
1549 $cond_lines++;
1550 }
1551
1552 # Also ignore a loop construct at the end of a
1553 # preprocessor statement.
1554 if (($prevline =~ /^.\s*#\s*define\s/ ||
1555 $prevline =~ /\\\s*$/) && $continuation == 0) {
1556 $check = 0;
1557 }
1558
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001559 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07001560 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001561 while ($cond_ptr != $cond_lines) {
1562 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001563
Andy Whitcroftf16fa282008-10-15 22:02:32 -07001564 # If we see an #else/#elif then the code
1565 # is not linear.
1566 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1567 $check = 0;
1568 }
1569
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001570 # Ignore:
1571 # 1) blank lines, they should be at 0,
1572 # 2) preprocessor lines, and
1573 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07001574 if ($continuation ||
1575 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001576 $s =~ /^\s*#\s*?/ ||
1577 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07001578 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07001579 if ($s =~ s/^.*?\n//) {
1580 $cond_lines++;
1581 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001582 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001583 }
1584
1585 my (undef, $sindent) = line_stats("+" . $s);
1586 my $stat_real = raw_line($linenr, $cond_lines);
1587
1588 # Check if either of these lines are modified, else
1589 # this is not this patch's fault.
1590 if (!defined($stat_real) ||
1591 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1592 $check = 0;
1593 }
1594 if (defined($stat_real) && $cond_lines > 1) {
1595 $stat_real = "[...]\n$stat_real";
1596 }
1597
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001598 #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 -07001599
1600 if ($check && (($sindent % 8) != 0 ||
1601 ($sindent <= $indent && $s ne ''))) {
1602 WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1603 }
1604 }
1605
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001606 # Track the 'values' across context and added lines.
1607 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001608 my ($curr_values, $curr_vars) =
1609 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001610 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001611 if ($dbg_values) {
1612 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001613 print "$linenr > .$outline\n";
1614 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001615 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001616 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001617 $prev_values = substr($curr_values, -1);
1618
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001619#ignore lines not being added
1620 if ($line=~/^[^\+]/) {next;}
1621
Andy Whitcroft653d4872007-06-23 17:16:34 -07001622# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07001623 if ($dbg_type) {
1624 if ($line =~ /^.\s*$Declare\s*$/) {
1625 ERROR("TEST: is type\n" . $herecurr);
1626 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1627 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1628 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001629 next;
1630 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001631# TEST: allow direct testing of the attribute matcher.
1632 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08001633 if ($line =~ /^.\s*$Modifier\s*$/) {
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001634 ERROR("TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08001635 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001636 ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1637 }
1638 next;
1639 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001640
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001641# check for initialisation to aggregates open brace on the next line
1642 if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1643 $line =~ /^.\s*{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001644 ERROR("that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001645 }
1646
Andy Whitcroft653d4872007-06-23 17:16:34 -07001647#
1648# Checks which are anchored on the added line.
1649#
1650
1651# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001652 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001653 my $path = $1;
1654 if ($path =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001655 ERROR("malformed #include filename\n" .
1656 $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001657 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001658 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001659
1660# no C99 // comments
1661 if ($line =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001662 ERROR("do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001663 }
1664 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001665 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001666 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001667
1668#EXPORT_SYMBOL should immediately follow its function closing }.
Andy Whitcroft653d4872007-06-23 17:16:34 -07001669 if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1670 ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1671 my $name = $1;
Andy Whitcroft48012052008-10-15 22:02:34 -07001672 if ($prevline !~ /(?:
1673 ^.}|
1674 ^.DEFINE_$Ident\(\Q$name\E\)|
1675 ^.DECLARE_$Ident\(\Q$name\E\)|
1676 ^.LIST_HEAD\(\Q$name\E\)|
1677 ^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
1678 \b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)
1679 )/x) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001680 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001681 }
1682 }
1683
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001684# check for external initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001685 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001686 ERROR("do not initialise externals to 0 or NULL\n" .
1687 $herecurr);
1688 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001689# check for static initialisers.
Andy Whitcroft2d1bafd2009-01-06 14:41:28 -08001690 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001691 ERROR("do not initialise statics to 0 or NULL\n" .
1692 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001693 }
1694
Andy Whitcroft653d4872007-06-23 17:16:34 -07001695# check for new typedefs, only function parameters and sparse annotations
1696# make sense.
1697 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08001698 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001699 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07001700 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001701 $line !~ /\b__bitwise(?:__|)\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001702 WARN("do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001703 }
1704
1705# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08001706 # (char*[ const])
Andy Whitcroft00ef4ec2009-02-27 14:03:07 -08001707 if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001708 my ($from, $to) = ($1, $1);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001709
Andy Whitcroft65863862009-01-06 14:41:21 -08001710 # Should start with a space.
1711 $to =~ s/^(\S)/ $1/;
1712 # Should not end with a space.
1713 $to =~ s/\s+$//;
1714 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08001715 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001716 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001717
Andy Whitcroft65863862009-01-06 14:41:21 -08001718 #print "from<$from> to<$to>\n";
1719 if ($from ne $to) {
1720 ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
1721 }
Andy Whitcroft00ef4ec2009-02-27 14:03:07 -08001722 } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001723 my ($from, $to, $ident) = ($1, $1, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001724
Andy Whitcroft65863862009-01-06 14:41:21 -08001725 # Should start with a space.
1726 $to =~ s/^(\S)/ $1/;
1727 # Should not end with a space.
1728 $to =~ s/\s+$//;
1729 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08001730 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001731 }
1732 # Modifiers should have spaces.
1733 $to =~ s/(\b$Modifier$)/$1 /;
1734
Andy Whitcroft667026e2009-02-27 14:03:08 -08001735 #print "from<$from> to<$to> ident<$ident>\n";
1736 if ($from ne $to && $ident !~ /^$Modifier$/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001737 ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
1738 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001739 }
1740
1741# # no BUG() or BUG_ON()
1742# if ($line =~ /\b(BUG|BUG_ON)\b/) {
1743# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1744# print "$herecurr";
1745# $clean = 0;
1746# }
1747
Andy Whitcroft8905a672007-11-28 16:21:06 -08001748 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001749 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 -08001750 }
1751
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001752# printk should use KERN_* levels. Note that follow on printk's on the
1753# same line do not need a level, so we use the current block context
1754# to try and find and validate the current printk. In summary the current
1755# printk includes all preceeding printk's which have no newline on the end.
1756# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001757 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001758 my $ok = 0;
1759 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1760 #print "CHECK<$lines[$ln - 1]\n";
1761 # we have a preceeding printk if it ends
1762 # with "\n" ignore it, else it is to blame
1763 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1764 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1765 $ok = 1;
1766 }
1767 last;
1768 }
1769 }
1770 if ($ok == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001771 WARN("printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001772 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001773 }
1774
Andy Whitcroft653d4872007-06-23 17:16:34 -07001775# function brace can't be on same line, except for #defines of do while,
1776# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001777 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1778 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001779 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001780 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001781
Andy Whitcroft8905a672007-11-28 16:21:06 -08001782# open braces for enum, union and struct go on the same line.
1783 if ($line =~ /^.\s*{/ &&
1784 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1785 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1786 }
1787
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001788# check for spacing round square brackets; allowed:
1789# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001790# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1791# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001792 while ($line =~ /(.*?\s)\[/g) {
1793 my ($where, $prefix) = ($-[1], $1);
1794 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001795 ($where != 0 || $prefix !~ /^.\s+$/) &&
1796 $prefix !~ /{\s+$/) {
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001797 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1798 }
1799 }
1800
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001801# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001802 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001803 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001804 my $ctx_before = substr($line, 0, $-[1]);
1805 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001806
1807 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001808 if ($name =~ /^(?:
1809 if|for|while|switch|return|case|
1810 volatile|__volatile__|
1811 __attribute__|format|__extension__|
1812 asm|__asm__)$/x)
1813 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001814
1815 # cpp #define statements have non-optional spaces, ie
1816 # if there is a space between the name and the open
1817 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001818 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001819
1820 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001821 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001822
1823 # If this whole things ends with a type its most
1824 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001825 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001826
1827 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001828 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001829 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001830 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001831# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001832 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001833 my $ops = qr{
1834 <<=|>>=|<=|>=|==|!=|
1835 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1836 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001837 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1838 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001839 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001840 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001841 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001842
1843 my $blank = copy_spacing($opline);
1844
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001845 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001846 $off += length($elements[$n]);
1847
Andy Whitcroft773647a2008-03-28 14:15:58 -07001848 # Pick up the preceeding and succeeding characters.
1849 my $ca = substr($opline, 0, $off);
1850 my $cc = '';
1851 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1852 $cc = substr($opline, $off + length($elements[$n + 1]));
1853 }
1854 my $cb = "$ca$;$cc";
1855
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001856 my $a = '';
1857 $a = 'V' if ($elements[$n] ne '');
1858 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001859 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001860 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1861 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07001862 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001863
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001864 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001865
1866 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001867 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001868 $c = 'V' if ($elements[$n + 2] ne '');
1869 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001870 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001871 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1872 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08001873 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001874 } else {
1875 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001876 }
1877
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001878 my $ctx = "${a}x${c}";
1879
1880 my $at = "(ctx:$ctx)";
1881
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001882 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001883 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001884
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001885 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001886 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001887
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001888 # Get the full operator variant.
1889 my $opv = $op . substr($curr_vars, $off, 1);
1890
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001891 # Ignore operators passed as parameters.
1892 if ($op_type ne 'V' &&
1893 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1894
Andy Whitcroftcf655042008-03-04 14:28:20 -08001895# # Ignore comments
1896# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001897
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001898 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001899 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001900 if ($ctx !~ /.x[WEBC]/ &&
1901 $cc !~ /^\\/ && $cc !~ /^;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001902 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001903 }
1904
1905 # // is a comment
1906 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001907
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001908 # No spaces for:
1909 # ->
1910 # : when part of a bitfield
1911 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001912 if ($ctx =~ /Wx.|.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001913 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001914 }
1915
1916 # , must have a space on the right.
1917 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001918 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001919 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001920 }
1921
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001922 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001923 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001924 #warn "'*' is part of type\n";
1925
1926 # unary operators should have a space before and
1927 # none after. May be left adjacent to another
1928 # unary operator, or a cast
1929 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001930 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07001931 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001932 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001933 ERROR("space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001934 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08001935 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001936 # A unary '*' may be const
1937
1938 } elsif ($ctx =~ /.xW/) {
Andy Whitcroftfb9e9092009-09-21 17:04:38 -07001939 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001940 }
1941
1942 # unary ++ and unary -- are allowed no space on one side.
1943 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001944 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1945 ERROR("space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001946 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001947 if ($ctx =~ /Wx[BE]/ ||
1948 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1949 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001950 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001951 if ($ctx =~ /ExW/) {
1952 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1953 }
1954
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001955
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001956 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001957 } elsif ($op eq '<<' or $op eq '>>' or
1958 $op eq '&' or $op eq '^' or $op eq '|' or
1959 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001960 $op eq '*' or $op eq '/' or
1961 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001962 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001963 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001964 ERROR("need consistent spacing around '$op' $at\n" .
1965 $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001966 }
1967
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001968 # A colon needs no spaces before when it is
1969 # terminating a case value or a label.
1970 } elsif ($opv eq ':C' || $opv eq ':L') {
1971 if ($ctx =~ /Wx./) {
1972 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1973 }
1974
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001975 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08001976 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001977 my $ok = 0;
1978
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001979 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001980 if (($op eq '<' &&
1981 $cc =~ /^\S+\@\S+>/) ||
1982 ($op eq '>' &&
1983 $ca =~ /<\S+\@\S+$/))
1984 {
1985 $ok = 1;
1986 }
1987
1988 # Ignore ?:
1989 if (($opv eq ':O' && $ca =~ /\?$/) ||
1990 ($op eq '?' && $cc =~ /^:/)) {
1991 $ok = 1;
1992 }
1993
1994 if ($ok == 0) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001995 ERROR("spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001996 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001997 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001998 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001999 }
2000 }
2001
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002002# check for multiple assignments
2003 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002004 CHK("multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002005 }
2006
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002007## # check for multiple declarations, allowing for a function declaration
2008## # continuation.
2009## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2010## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2011##
2012## # Remove any bracketed sections to ensure we do not
2013## # falsly report the parameters of functions.
2014## my $ln = $line;
2015## while ($ln =~ s/\([^\(\)]*\)//g) {
2016## }
2017## if ($ln =~ /,/) {
2018## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
2019## }
2020## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002021
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002022#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002023 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2024 $line =~ /do{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002025 ERROR("space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002026 }
2027
2028# closing brace should have a space following it when it has anything
2029# on the line
2030 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002031 ERROR("space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002032 }
2033
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002034# check spacing on square brackets
2035 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002036 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002037 }
2038 if ($line =~ /\s\]/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002039 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002040 }
2041
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002042# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002043 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2044 $line !~ /for\s*\(\s+;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002045 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002046 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002047 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002048 $line !~ /for\s*\(.*;\s+\)/ &&
2049 $line !~ /:\s+\)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002050 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002051 }
2052
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002053#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002054 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002055 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002056 WARN("labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002057 }
2058
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002059# Return is not a function.
2060 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2061 my $spacing = $1;
2062 my $value = $2;
2063
Andy Whitcroft86f9d052009-01-06 14:41:24 -08002064 # Flatten any parentheses
Andy Whitcroftfee61c42008-07-23 21:28:56 -07002065 $value =~ s/\)\(/\) \(/g;
Andy Whitcroft63f17f82009-01-15 13:51:06 -08002066 while ($value =~ s/\[[^\{\}]*\]/1/ ||
2067 $value !~ /(?:$Ident|-?$Constant)\s*
2068 $Compare\s*
2069 (?:$Ident|-?$Constant)/x &&
2070 $value =~ s/\([^\(\)]*\)/1/) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002071 }
2072
2073 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
2074 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
2075
2076 } elsif ($spacing !~ /\s+/) {
2077 ERROR("space required before the open parenthesis '('\n" . $herecurr);
2078 }
2079 }
2080
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002081# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002082 if ($line=~/\b(if|while|for|switch)\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002083 ERROR("space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002084 }
2085
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002086# Check for illegal assignment in if conditional -- and check for trailing
2087# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002088 if ($line =~ /do\s*(?!{)/) {
2089 my ($stat_next) = ctx_statement_block($line_nr_next,
2090 $remain_next, $off_next);
2091 $stat_next =~ s/\n./\n /g;
2092 ##print "stat<$stat> stat_next<$stat_next>\n";
2093
2094 if ($stat_next =~ /^\s*while\b/) {
2095 # If the statement carries leading newlines,
2096 # then count those as offsets.
2097 my ($whitespace) =
2098 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2099 my $offset =
2100 statement_rawlines($whitespace) - 1;
2101
2102 $suppress_whiletrailers{$line_nr_next +
2103 $offset} = 1;
2104 }
2105 }
2106 if (!defined $suppress_whiletrailers{$linenr} &&
2107 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002108 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002109
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08002110 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002111 ERROR("do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002112 }
2113
2114 # Find out what is on the end of the line after the
2115 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002116 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002117 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002118 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07002119 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2120 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002121 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002122 # Find out how long the conditional actually is.
2123 my @newlines = ($c =~ /\n/gs);
2124 my $cond_lines = 1 + $#newlines;
2125
2126 my $stat_real = raw_line($linenr, $cond_lines);
2127 if (defined($stat_real) && $cond_lines > 1) {
2128 $stat_real = "[...]\n$stat_real";
2129 }
2130
2131 ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002132 }
2133 }
2134
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002135# Check for bitwise tests written as boolean
2136 if ($line =~ /
2137 (?:
2138 (?:\[|\(|\&\&|\|\|)
2139 \s*0[xX][0-9]+\s*
2140 (?:\&\&|\|\|)
2141 |
2142 (?:\&\&|\|\|)
2143 \s*0[xX][0-9]+\s*
2144 (?:\&\&|\|\||\)|\])
2145 )/x)
2146 {
2147 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2148 }
2149
Andy Whitcroft8905a672007-11-28 16:21:06 -08002150# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002151 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2152 my $s = $1;
2153 $s =~ s/$;//g; # Remove any comments
2154 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2155 ERROR("trailing statements should be on next line\n" . $herecurr);
2156 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002157 }
Andy Whitcroft39667782009-01-15 13:51:06 -08002158# if should not continue a brace
2159 if ($line =~ /}\s*if\b/) {
2160 ERROR("trailing statements should be on next line\n" .
2161 $herecurr);
2162 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002163# case and default should not have general statements after them
2164 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2165 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07002166 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002167 \s*return\s+
2168 )/xg)
2169 {
2170 ERROR("trailing statements should be on next line\n" . $herecurr);
2171 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002172
2173 # Check for }<nl>else {, these must be at the same
2174 # indent level to be relevant to each other.
2175 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2176 $previndent == $indent) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002177 ERROR("else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002178 }
2179
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002180 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2181 $previndent == $indent) {
2182 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2183
2184 # Find out what is on the end of the line after the
2185 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002186 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002187 $s =~ s/\n.*//g;
2188
2189 if ($s =~ /^\s*;/) {
2190 ERROR("while should follow close brace '}'\n" . $hereprev);
2191 }
2192 }
2193
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002194#studly caps, commented out until figure out how to distinguish between use of existing and adding new
2195# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2196# print "No studly caps, use _\n";
2197# print "$herecurr";
2198# $clean = 0;
2199# }
2200
2201#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002202 if ($line=~/\#\s*define.*\\\s$/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002203 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002204 }
2205
Andy Whitcroft653d4872007-06-23 17:16:34 -07002206#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002207 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002208 my $file = "$1.h";
2209 my $checkfile = "include/linux/$file";
2210 if (-f "$root/$checkfile" &&
2211 $realfile ne $checkfile &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002212 $1 ne 'irq')
2213 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002214 if ($realfile =~ m{^arch/}) {
2215 CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2216 } else {
2217 WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2218 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002219 }
2220 }
2221
Andy Whitcroft653d4872007-06-23 17:16:34 -07002222# multi-statement macros should be enclosed in a do while loop, grab the
2223# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08002224# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07002225 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2226 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002227 my $ln = $linenr;
2228 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002229 my ($off, $dstat, $dcond, $rest);
2230 my $ctx = '';
Andy Whitcroft653d4872007-06-23 17:16:34 -07002231
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002232 my $args = defined($1);
2233
2234 # Find the end of the macro and limit our statement
2235 # search to that.
2236 while ($cnt > 0 && defined $lines[$ln - 1] &&
2237 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2238 {
2239 $ctx .= $rawlines[$ln - 1] . "\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002240 $cnt-- if ($lines[$ln - 1] !~ /^-/);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002241 $ln++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002242 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002243 $ctx .= $rawlines[$ln - 1];
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002244
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002245 ($dstat, $dcond, $ln, $cnt, $off) =
2246 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2247 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002248 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002249
2250 # Extract the remainder of the define (if any) and
2251 # rip off surrounding spaces, and trailing \'s.
2252 $rest = '';
Andy Whitcroft636d140a2008-10-15 22:02:18 -07002253 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2254 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002255 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2256 $rest .= substr($lines[$ln - 1], $off) . "\n";
2257 $cnt--;
2258 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002259 $ln++;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002260 $off = 0;
2261 }
2262 $rest =~ s/\\\n.//g;
2263 $rest =~ s/^\s*//s;
2264 $rest =~ s/\s*$//s;
2265
2266 # Clean up the original statement.
2267 if ($args) {
2268 substr($dstat, 0, length($dcond), '');
2269 } else {
2270 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2271 }
Andy Whitcroft292f1a92008-07-23 21:29:11 -07002272 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002273 $dstat =~ s/\\\n.//g;
2274 $dstat =~ s/^\s*//s;
2275 $dstat =~ s/\s*$//s;
2276
2277 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07002278 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2279 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2280 $dstat =~ s/\[[^\{\}]*\]/1/)
2281 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002282 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002283
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002284 my $exceptions = qr{
2285 $Declare|
2286 module_param_named|
2287 MODULE_PARAM_DESC|
2288 DECLARE_PER_CPU|
2289 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08002290 __typeof__\(|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07002291 \.$Ident\s*=\s*|
2292 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002293 }x;
Andy Whitcroft383099f2009-01-06 14:41:18 -08002294 #print "REST<$rest> dstat<$dstat>\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002295 if ($rest ne '') {
2296 if ($rest !~ /while\s*\(/ &&
2297 $dstat !~ /$exceptions/)
2298 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002299 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 -07002300 }
2301
2302 } elsif ($ctx !~ /;/) {
2303 if ($dstat ne '' &&
2304 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2305 $dstat !~ /$exceptions/ &&
Andy Whitcroftb132e5d2008-10-15 22:02:31 -07002306 $dstat !~ /^\.$Ident\s*=/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002307 $dstat =~ /$Operators/)
2308 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002309 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002310 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002311 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002312 }
2313
Mike Frysinger080ba922009-01-06 14:41:25 -08002314# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
2315# all assignments may have only one of the following with an assignment:
2316# .
2317# ALIGN(...)
2318# VMLINUX_SYMBOL(...)
2319 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
2320 WARN("vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
2321 }
2322
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002323# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002324 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2325 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08002326 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002327 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002328 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2329 if ($#chunks > 0 && $level == 0) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002330 my $allowed = 0;
2331 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002332 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002333 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002334 for my $chunk (@chunks) {
2335 my ($cond, $block) = @{$chunk};
2336
Andy Whitcroft773647a2008-03-28 14:15:58 -07002337 # If the condition carries leading newlines, then count those as offsets.
2338 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2339 my $offset = statement_rawlines($whitespace) - 1;
2340
2341 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2342
2343 # We have looked at and allowed this specific line.
2344 $suppress_ifbraces{$ln + $offset} = 1;
2345
2346 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002347 $ln += statement_rawlines($block) - 1;
2348
Andy Whitcroft773647a2008-03-28 14:15:58 -07002349 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002350
2351 $seen++ if ($block =~ /^\s*{/);
2352
Andy Whitcroftcf655042008-03-04 14:28:20 -08002353 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2354 if (statement_lines($cond) > 1) {
2355 #print "APW: ALLOWED: cond<$cond>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002356 $allowed = 1;
2357 }
2358 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002359 #print "APW: ALLOWED: block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002360 $allowed = 1;
2361 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002362 if (statement_block_size($block) > 1) {
2363 #print "APW: ALLOWED: lines block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002364 $allowed = 1;
2365 }
2366 }
2367 if ($seen && !$allowed) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002368 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002369 }
2370 }
2371 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002372 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002373 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002374 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002375
Andy Whitcroftcf655042008-03-04 14:28:20 -08002376 # Check the pre-context.
2377 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2378 #print "APW: ALLOWED: pre<$1>\n";
2379 $allowed = 1;
2380 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002381
2382 my ($level, $endln, @chunks) =
2383 ctx_statement_full($linenr, $realcnt, $-[0]);
2384
Andy Whitcroftcf655042008-03-04 14:28:20 -08002385 # Check the condition.
2386 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07002387 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002388 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002389 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08002390 }
2391 if (statement_lines($cond) > 1) {
2392 #print "APW: ALLOWED: cond<$cond>\n";
2393 $allowed = 1;
2394 }
2395 if ($block =~/\b(?:if|for|while)\b/) {
2396 #print "APW: ALLOWED: block<$block>\n";
2397 $allowed = 1;
2398 }
2399 if (statement_block_size($block) > 1) {
2400 #print "APW: ALLOWED: lines block<$block>\n";
2401 $allowed = 1;
2402 }
2403 # Check the post-context.
2404 if (defined $chunks[1]) {
2405 my ($cond, $block) = @{$chunks[1]};
2406 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002407 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002408 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002409 if ($block =~ /^\s*\{/) {
2410 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2411 $allowed = 1;
2412 }
2413 }
2414 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2415 my $herectx = $here . "\n";;
Andy Whitcroftf0556632008-10-15 22:02:23 -07002416 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002417
Andy Whitcroftf0556632008-10-15 22:02:23 -07002418 for (my $n = 0; $n < $cnt; $n++) {
2419 $herectx .= raw_line($linenr, $n) . "\n";;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002420 }
2421
2422 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002423 }
2424 }
2425
Andy Whitcroft653d4872007-06-23 17:16:34 -07002426# don't include deprecated include files (uses RAW line)
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002427 for my $inc (@dep_includes) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002428 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002429 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002430 }
2431 }
2432
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002433# don't use deprecated functions
2434 for my $func (@dep_functions) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002435 if ($line =~ /\b$func\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002436 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002437 }
2438 }
2439
2440# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002441 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2442 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002443 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002444 }
2445
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002446# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2447 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2448 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2449 }
2450
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002451# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002452 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002453 CHK("if this code is redundant consider removing it\n" .
2454 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002455 }
2456
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002457# check for needless kfree() checks
2458 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2459 my $expr = $1;
2460 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
Wolfram Sang3c232142008-07-23 21:29:05 -07002461 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002462 }
2463 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07002464# check for needless usb_free_urb() checks
2465 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2466 my $expr = $1;
2467 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2468 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2469 }
2470 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002471
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002472# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002473# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002474# print "#ifdef in C files should be avoided\n";
2475# print "$herecurr";
2476# $clean = 0;
2477# }
2478
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002479# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002480 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002481 ERROR("exactly one space required after that #$1\n" . $herecurr);
2482 }
2483
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002484# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002485 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2486 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002487 my $which = $1;
2488 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002489 CHK("$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002490 }
2491 }
2492# check for memory barriers without a comment.
2493 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2494 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002495 CHK("memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002496 }
2497 }
2498# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002499 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002500 CHK("architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002501 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002502
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002503# check the location of the inline attribute, that it is between
2504# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002505 if ($line =~ /\b$Type\s+$Inline\b/ ||
2506 $line =~ /\b$Inline\s+$Storage\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002507 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2508 }
2509
Andy Whitcroft8905a672007-11-28 16:21:06 -08002510# Check for __inline__ and __inline, prefer inline
2511 if ($line =~ /\b(__inline__|__inline)\b/) {
2512 WARN("plain inline is preferred over $1\n" . $herecurr);
2513 }
2514
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002515# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002516 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002517 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002518 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002519 my $function_name = $1;
2520 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002521
2522 my $s = $stat;
2523 if (defined $cond) {
2524 substr($s, 0, length($cond), '');
2525 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002526 if ($s =~ /^\s*;/ &&
2527 $function_name ne 'uninitialized_var')
2528 {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002529 WARN("externs should be avoided in .c files\n" . $herecurr);
2530 }
2531
2532 if ($paren_space =~ /\n/) {
2533 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2534 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002535
2536 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2537 $stat =~ /^.\s*extern\s+/)
2538 {
2539 WARN("externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002540 }
2541
2542# checks for new __setup's
2543 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2544 my $name = $1;
2545
2546 if (!grep(/$name/, @setup_docs)) {
2547 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2548 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002549 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002550
2551# check for pointless casting of kmalloc return
2552 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2553 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2554 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002555
2556# check for gcc specific __FUNCTION__
2557 if ($line =~ /__FUNCTION__/) {
2558 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2559 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002560
2561# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002562 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002563 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2564 }
2565# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002566 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002567 WARN("consider using a completion\n" . $herecurr);
2568 }
2569# recommend strict_strto* over simple_strto*
2570 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2571 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2572 }
Michael Ellermanf3db6632008-07-23 21:28:57 -07002573# check for __initcall(), use device_initcall() explicitly please
2574 if ($line =~ /^.\s*__initcall\s*\(/) {
2575 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2576 }
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08002577# check for struct file_operations, ensure they are const.
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08002578 if ($line !~ /\bconst\b/ &&
2579 $line =~ /\bstruct\s+(file_operations|seq_operations)\b/) {
2580 WARN("struct $1 should normally be const\n" .
2581 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08002582 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002583
2584# use of NR_CPUS is usually wrong
2585# ignore definitions of NR_CPUS and usage to define arrays as likely right
2586 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002587 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2588 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002589 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2590 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2591 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002592 {
2593 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2594 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002595
2596# check for %L{u,d,i} in strings
2597 my $string;
2598 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2599 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07002600 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002601 if ($string =~ /(?<!%)%L[udi]/) {
2602 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2603 last;
2604 }
2605 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08002606
2607# whine mightly about in_atomic
2608 if ($line =~ /\bin_atomic\s*\(/) {
2609 if ($realfile =~ m@^drivers/@) {
2610 ERROR("do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08002611 } elsif ($realfile !~ m@^kernel/@) {
Andy Whitcroft691d77b2009-01-06 14:41:16 -08002612 WARN("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
2613 }
2614 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002615 }
2616
2617 # If we have no input at all, then there is nothing to report on
2618 # so just keep quiet.
2619 if ($#rawlines == -1) {
2620 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002621 }
2622
Andy Whitcroft8905a672007-11-28 16:21:06 -08002623 # In mailback mode only produce a report in the negative, for
2624 # things that appear to be patches.
2625 if ($mailback && ($clean == 1 || !$is_patch)) {
2626 exit(0);
2627 }
2628
2629 # This is not a patch, and we are are in 'no-patch' mode so
2630 # just keep quiet.
2631 if (!$chk_patch && !$is_patch) {
2632 exit(0);
2633 }
2634
2635 if (!$is_patch) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002636 ERROR("Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002637 }
2638 if ($is_patch && $chk_signoff && $signoff == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002639 ERROR("Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002640 }
2641
Andy Whitcroft8905a672007-11-28 16:21:06 -08002642 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002643 if ($summary && !($clean == 1 && $quiet == 1)) {
2644 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002645 print "total: $cnt_error errors, $cnt_warn warnings, " .
2646 (($check)? "$cnt_chk checks, " : "") .
2647 "$cnt_lines lines checked\n";
2648 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002649 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002650
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002651 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002652 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002653 }
2654 if ($clean == 0 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002655 print "$vname has style problems, please review. If any of these errors\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002656 print "are false positives report them to the maintainer, see\n";
2657 print "CHECKPATCH in MAINTAINERS.\n";
2658 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002659
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002660 return $clean;
2661}