checkpatch: add --fix option for a couple OPEN_BRACE misuses
[linux-2.6-block.git] / scripts / checkpatch.pl
CommitLineData
0a920b5b 1#!/usr/bin/perl -w
dbf004d7 2# (c) 2001, Dave Jones. (the file handling bit)
00df344f 3# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
2a5a2c25 4# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
015830be 5# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
0a920b5b
AW
6# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
c707a81d 9use POSIX;
0a920b5b
AW
10
11my $P = $0;
00df344f 12$P =~ s@.*/@@g;
0a920b5b 13
000d1cc1 14my $V = '0.32';
0a920b5b
AW
15
16use Getopt::Long qw(:config no_auto_abbrev);
17
18my $quiet = 0;
19my $tree = 1;
20my $chk_signoff = 1;
21my $chk_patch = 1;
773647a0 22my $tst_only;
6c72ffaa 23my $emacs = 0;
8905a67c 24my $terse = 0;
6c72ffaa
AW
25my $file = 0;
26my $check = 0;
2ac73b4f 27my $check_orig = 0;
8905a67c
AW
28my $summary = 1;
29my $mailback = 0;
13214adf 30my $summary_file = 0;
000d1cc1 31my $show_types = 0;
3705ce5b 32my $fix = 0;
9624b8d6 33my $fix_inplace = 0;
6c72ffaa 34my $root;
c2fdda0d 35my %debug;
3445686a 36my %camelcase = ();
91bfe484
JP
37my %use_type = ();
38my @use = ();
39my %ignore_type = ();
000d1cc1 40my @ignore = ();
77f5b10a 41my $help = 0;
000d1cc1 42my $configuration_file = ".checkpatch.conf";
6cd7f386 43my $max_line_length = 80;
d62a201f
DH
44my $ignore_perl_version = 0;
45my $minimum_perl_version = 5.10.0;
77f5b10a
HE
46
47sub help {
48 my ($exitcode) = @_;
49
50 print << "EOM";
51Usage: $P [OPTION]... [FILE]...
52Version: $V
53
54Options:
55 -q, --quiet quiet
56 --no-tree run without a kernel tree
57 --no-signoff do not check for 'Signed-off-by' line
58 --patch treat FILE as patchfile (default)
59 --emacs emacs compile window format
60 --terse one line per report
61 -f, --file treat FILE as regular source file
62 --subjective, --strict enable more subjective tests
91bfe484 63 --types TYPE(,TYPE2...) show only these comma separated message types
000d1cc1 64 --ignore TYPE(,TYPE2...) ignore various comma separated message types
6cd7f386 65 --max-line-length=n set the maximum line length, if exceeded, warn
000d1cc1 66 --show-types show the message "types" in the output
77f5b10a
HE
67 --root=PATH PATH to the kernel tree root
68 --no-summary suppress the per-file summary
69 --mailback only produce a report in case of warnings/errors
70 --summary-file include the filename in summary
71 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
72 'values', 'possible', 'type', and 'attr' (default
73 is all off)
74 --test-only=WORD report only warnings/errors containing WORD
75 literally
3705ce5b
JP
76 --fix EXPERIMENTAL - may create horrible results
77 If correctable single-line errors exist, create
78 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
79 with potential errors corrected to the preferred
80 checkpatch style
9624b8d6
JP
81 --fix-inplace EXPERIMENTAL - may create horrible results
82 Is the same as --fix, but overwrites the input
83 file. It's your fault if there's no backup or git
d62a201f
DH
84 --ignore-perl-version override checking of perl version. expect
85 runtime errors.
77f5b10a
HE
86 -h, --help, --version display this help and exit
87
88When FILE is - read standard input.
89EOM
90
91 exit($exitcode);
92}
93
000d1cc1
JP
94my $conf = which_conf($configuration_file);
95if (-f $conf) {
96 my @conf_args;
97 open(my $conffile, '<', "$conf")
98 or warn "$P: Can't find a readable $configuration_file file $!\n";
99
100 while (<$conffile>) {
101 my $line = $_;
102
103 $line =~ s/\s*\n?$//g;
104 $line =~ s/^\s*//g;
105 $line =~ s/\s+/ /g;
106
107 next if ($line =~ m/^\s*#/);
108 next if ($line =~ m/^\s*$/);
109
110 my @words = split(" ", $line);
111 foreach my $word (@words) {
112 last if ($word =~ m/^#/);
113 push (@conf_args, $word);
114 }
115 }
116 close($conffile);
117 unshift(@ARGV, @conf_args) if @conf_args;
118}
119
0a920b5b 120GetOptions(
6c72ffaa 121 'q|quiet+' => \$quiet,
0a920b5b
AW
122 'tree!' => \$tree,
123 'signoff!' => \$chk_signoff,
124 'patch!' => \$chk_patch,
6c72ffaa 125 'emacs!' => \$emacs,
8905a67c 126 'terse!' => \$terse,
77f5b10a 127 'f|file!' => \$file,
6c72ffaa
AW
128 'subjective!' => \$check,
129 'strict!' => \$check,
000d1cc1 130 'ignore=s' => \@ignore,
91bfe484 131 'types=s' => \@use,
000d1cc1 132 'show-types!' => \$show_types,
6cd7f386 133 'max-line-length=i' => \$max_line_length,
6c72ffaa 134 'root=s' => \$root,
8905a67c
AW
135 'summary!' => \$summary,
136 'mailback!' => \$mailback,
13214adf 137 'summary-file!' => \$summary_file,
3705ce5b 138 'fix!' => \$fix,
9624b8d6 139 'fix-inplace!' => \$fix_inplace,
d62a201f 140 'ignore-perl-version!' => \$ignore_perl_version,
c2fdda0d 141 'debug=s' => \%debug,
773647a0 142 'test-only=s' => \$tst_only,
77f5b10a
HE
143 'h|help' => \$help,
144 'version' => \$help
145) or help(1);
146
147help(0) if ($help);
0a920b5b 148
9624b8d6 149$fix = 1 if ($fix_inplace);
2ac73b4f 150$check_orig = $check;
9624b8d6 151
0a920b5b
AW
152my $exit = 0;
153
d62a201f
DH
154if ($^V && $^V lt $minimum_perl_version) {
155 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
156 if (!$ignore_perl_version) {
157 exit(1);
158 }
159}
160
0a920b5b 161if ($#ARGV < 0) {
77f5b10a 162 print "$P: no input files\n";
0a920b5b
AW
163 exit(1);
164}
165
91bfe484
JP
166sub hash_save_array_words {
167 my ($hashRef, $arrayRef) = @_;
168
169 my @array = split(/,/, join(',', @$arrayRef));
170 foreach my $word (@array) {
171 $word =~ s/\s*\n?$//g;
172 $word =~ s/^\s*//g;
173 $word =~ s/\s+/ /g;
174 $word =~ tr/[a-z]/[A-Z]/;
175
176 next if ($word =~ m/^\s*#/);
177 next if ($word =~ m/^\s*$/);
178
179 $hashRef->{$word}++;
180 }
181}
000d1cc1 182
91bfe484
JP
183sub hash_show_words {
184 my ($hashRef, $prefix) = @_;
000d1cc1 185
58cb3cf6 186 if ($quiet == 0 && keys %$hashRef) {
91bfe484 187 print "NOTE: $prefix message types:";
58cb3cf6 188 foreach my $word (sort keys %$hashRef) {
91bfe484
JP
189 print " $word";
190 }
191 print "\n\n";
192 }
000d1cc1
JP
193}
194
91bfe484
JP
195hash_save_array_words(\%ignore_type, \@ignore);
196hash_save_array_words(\%use_type, \@use);
197
c2fdda0d
AW
198my $dbg_values = 0;
199my $dbg_possible = 0;
7429c690 200my $dbg_type = 0;
a1ef277e 201my $dbg_attr = 0;
c2fdda0d 202for my $key (keys %debug) {
21caa13c
AW
203 ## no critic
204 eval "\${dbg_$key} = '$debug{$key}';";
205 die "$@" if ($@);
c2fdda0d
AW
206}
207
d2c0a235
AW
208my $rpt_cleaners = 0;
209
8905a67c
AW
210if ($terse) {
211 $emacs = 1;
212 $quiet++;
213}
214
6c72ffaa
AW
215if ($tree) {
216 if (defined $root) {
217 if (!top_of_kernel_tree($root)) {
218 die "$P: $root: --root does not point at a valid tree\n";
219 }
220 } else {
221 if (top_of_kernel_tree('.')) {
222 $root = '.';
223 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
224 top_of_kernel_tree($1)) {
225 $root = $1;
226 }
227 }
228
229 if (!defined $root) {
230 print "Must be run from the top-level dir. of a kernel tree\n";
231 exit(2);
232 }
0a920b5b
AW
233}
234
6c72ffaa
AW
235my $emitted_corrupt = 0;
236
2ceb532b
AW
237our $Ident = qr{
238 [A-Za-z_][A-Za-z\d_]*
239 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
240 }x;
6c72ffaa
AW
241our $Storage = qr{extern|static|asmlinkage};
242our $Sparse = qr{
243 __user|
244 __kernel|
245 __force|
246 __iomem|
247 __must_check|
248 __init_refok|
417495ed 249 __kprobes|
165e72a6
SE
250 __ref|
251 __rcu
6c72ffaa 252 }x;
e970b884
JP
253our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
254our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
255our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
256our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
257our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
8716de38 258
52131292
WS
259# Notes to $Attribute:
260# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
6c72ffaa
AW
261our $Attribute = qr{
262 const|
03f1df7d
JP
263 __percpu|
264 __nocast|
265 __safe|
266 __bitwise__|
267 __packed__|
268 __packed2__|
269 __naked|
270 __maybe_unused|
271 __always_unused|
272 __noreturn|
273 __used|
274 __cold|
275 __noclone|
276 __deprecated|
6c72ffaa
AW
277 __read_mostly|
278 __kprobes|
8716de38 279 $InitAttribute|
24e1d81a
AW
280 ____cacheline_aligned|
281 ____cacheline_aligned_in_smp|
5fe3af11
AW
282 ____cacheline_internodealigned_in_smp|
283 __weak
6c72ffaa 284 }x;
c45dcabd 285our $Modifier;
91cb5195 286our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
6c72ffaa
AW
287our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
288our $Lval = qr{$Ident(?:$Member)*};
289
95e2c602
JP
290our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
291our $Binary = qr{(?i)0b[01]+$Int_type?};
292our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
293our $Int = qr{[0-9]+$Int_type?};
2435880f 294our $Octal = qr{0[0-7]+$Int_type?};
326b1ffc
JP
295our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
296our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
297our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
74349bcc 298our $Float = qr{$Float_hex|$Float_dec|$Float_int};
2435880f 299our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
326b1ffc 300our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
447432f3 301our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
23f780c9 302our $Arithmetic = qr{\+|-|\*|\/|%};
6c72ffaa
AW
303our $Operators = qr{
304 <=|>=|==|!=|
305 =>|->|<<|>>|<|>|!|~|
23f780c9 306 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
6c72ffaa
AW
307 }x;
308
91cb5195
JP
309our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
310
8905a67c 311our $NonptrType;
8716de38 312our $NonptrTypeWithAttr;
8905a67c
AW
313our $Type;
314our $Declare;
315
15662b3e
JP
316our $NON_ASCII_UTF8 = qr{
317 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
171ae1a4
AW
318 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
319 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
320 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
321 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
322 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
323 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
324}x;
325
15662b3e
JP
326our $UTF8 = qr{
327 [\x09\x0A\x0D\x20-\x7E] # ASCII
328 | $NON_ASCII_UTF8
329}x;
330
8ed22cad 331our $typeTypedefs = qr{(?x:
fb9e9096 332 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
8ed22cad
AW
333 atomic_t
334)};
335
691e669b 336our $logFunctions = qr{(?x:
6e60c02e 337 printk(?:_ratelimited|_once|)|
7d0b6594 338 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
6e60c02e 339 WARN(?:_RATELIMIT|_ONCE|)|
b0531722 340 panic|
06668727
JP
341 MODULE_[A-Z_]+|
342 seq_vprintf|seq_printf|seq_puts
691e669b
JP
343)};
344
20112475
JP
345our $signature_tags = qr{(?xi:
346 Signed-off-by:|
347 Acked-by:|
348 Tested-by:|
349 Reviewed-by:|
350 Reported-by:|
8543ae12 351 Suggested-by:|
20112475
JP
352 To:|
353 Cc:
354)};
355
8905a67c
AW
356our @typeList = (
357 qr{void},
c45dcabd
AW
358 qr{(?:unsigned\s+)?char},
359 qr{(?:unsigned\s+)?short},
360 qr{(?:unsigned\s+)?int},
361 qr{(?:unsigned\s+)?long},
362 qr{(?:unsigned\s+)?long\s+int},
363 qr{(?:unsigned\s+)?long\s+long},
364 qr{(?:unsigned\s+)?long\s+long\s+int},
8905a67c
AW
365 qr{unsigned},
366 qr{float},
367 qr{double},
368 qr{bool},
8905a67c
AW
369 qr{struct\s+$Ident},
370 qr{union\s+$Ident},
371 qr{enum\s+$Ident},
372 qr{${Ident}_t},
373 qr{${Ident}_handler},
374 qr{${Ident}_handler_fn},
375);
8716de38
JP
376our @typeListWithAttr = (
377 @typeList,
378 qr{struct\s+$InitAttribute\s+$Ident},
379 qr{union\s+$InitAttribute\s+$Ident},
380);
381
c45dcabd
AW
382our @modifierList = (
383 qr{fastcall},
384);
8905a67c 385
2435880f
JP
386our @mode_permission_funcs = (
387 ["module_param", 3],
388 ["module_param_(?:array|named|string)", 4],
389 ["module_param_array_named", 5],
390 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
391 ["proc_create(?:_data|)", 2],
392 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
393);
394
515a235e
JP
395#Create a search pattern for all these functions to speed up a loop below
396our $mode_perms_search = "";
397foreach my $entry (@mode_permission_funcs) {
398 $mode_perms_search .= '|' if ($mode_perms_search ne "");
399 $mode_perms_search .= $entry->[0];
400}
401
3f7bac03
JP
402our $declaration_macros = qr{(?x:
403 (?:$Storage\s+)?(?:DECLARE|DEFINE)_[A-Z]+\s*\(|
404 (?:$Storage\s+)?LIST_HEAD\s*\(
405)};
406
7840a94c
WS
407our $allowed_asm_includes = qr{(?x:
408 irq|
409 memory
410)};
411# memory.h: ARM has a custom one
412
8905a67c 413sub build_types {
d2172eb5
AW
414 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
415 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
8716de38 416 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
c8cb2ca3 417 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
8905a67c 418 $NonptrType = qr{
d2172eb5 419 (?:$Modifier\s+|const\s+)*
cf655043 420 (?:
6b48db24 421 (?:typeof|__typeof__)\s*\([^\)]*\)|
8ed22cad 422 (?:$typeTypedefs\b)|
c45dcabd 423 (?:${all}\b)
cf655043 424 )
c8cb2ca3 425 (?:\s+$Modifier|\s+const)*
8905a67c 426 }x;
8716de38
JP
427 $NonptrTypeWithAttr = qr{
428 (?:$Modifier\s+|const\s+)*
429 (?:
430 (?:typeof|__typeof__)\s*\([^\)]*\)|
431 (?:$typeTypedefs\b)|
432 (?:${allWithAttr}\b)
433 )
434 (?:\s+$Modifier|\s+const)*
435 }x;
8905a67c 436 $Type = qr{
c45dcabd 437 $NonptrType
1574a29f 438 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
c8cb2ca3 439 (?:\s+$Inline|\s+$Modifier)*
8905a67c 440 }x;
91cb5195 441 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
8905a67c
AW
442}
443build_types();
6c72ffaa 444
7d2367af 445our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
d1fe9c09
JP
446
447# Using $balanced_parens, $LvalOrFunc, or $FuncArg
448# requires at least perl version v5.10.0
449# Any use must be runtime checked with $^V
450
451our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
2435880f 452our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
d7c76ba7 453our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
7d2367af
JP
454
455sub deparenthesize {
456 my ($string) = @_;
457 return "" if (!defined($string));
5b9553ab
JP
458
459 while ($string =~ /^\s*\(.*\)\s*$/) {
460 $string =~ s@^\s*\(\s*@@;
461 $string =~ s@\s*\)\s*$@@;
462 }
463
7d2367af 464 $string =~ s@\s+@ @g;
5b9553ab 465
7d2367af
JP
466 return $string;
467}
468
3445686a
JP
469sub seed_camelcase_file {
470 my ($file) = @_;
471
472 return if (!(-f $file));
473
474 local $/;
475
476 open(my $include_file, '<', "$file")
477 or warn "$P: Can't read '$file' $!\n";
478 my $text = <$include_file>;
479 close($include_file);
480
481 my @lines = split('\n', $text);
482
483 foreach my $line (@lines) {
484 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
485 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
486 $camelcase{$1} = 1;
11ea516a
JP
487 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
488 $camelcase{$1} = 1;
489 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
3445686a
JP
490 $camelcase{$1} = 1;
491 }
492 }
493}
494
495my $camelcase_seeded = 0;
496sub seed_camelcase_includes {
497 return if ($camelcase_seeded);
498
499 my $files;
c707a81d
JP
500 my $camelcase_cache = "";
501 my @include_files = ();
502
503 $camelcase_seeded = 1;
351b2a1f 504
3645e328 505 if (-e ".git") {
351b2a1f
JP
506 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
507 chomp $git_last_include_commit;
c707a81d 508 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
3445686a 509 } else {
c707a81d 510 my $last_mod_date = 0;
3445686a 511 $files = `find $root/include -name "*.h"`;
c707a81d
JP
512 @include_files = split('\n', $files);
513 foreach my $file (@include_files) {
514 my $date = POSIX::strftime("%Y%m%d%H%M",
515 localtime((stat $file)[9]));
516 $last_mod_date = $date if ($last_mod_date < $date);
517 }
518 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
519 }
520
521 if ($camelcase_cache ne "" && -f $camelcase_cache) {
522 open(my $camelcase_file, '<', "$camelcase_cache")
523 or warn "$P: Can't read '$camelcase_cache' $!\n";
524 while (<$camelcase_file>) {
525 chomp;
526 $camelcase{$_} = 1;
527 }
528 close($camelcase_file);
529
530 return;
3445686a 531 }
c707a81d 532
3645e328 533 if (-e ".git") {
c707a81d
JP
534 $files = `git ls-files "include/*.h"`;
535 @include_files = split('\n', $files);
536 }
537
3445686a
JP
538 foreach my $file (@include_files) {
539 seed_camelcase_file($file);
540 }
351b2a1f 541
c707a81d 542 if ($camelcase_cache ne "") {
351b2a1f 543 unlink glob ".checkpatch-camelcase.*";
c707a81d
JP
544 open(my $camelcase_file, '>', "$camelcase_cache")
545 or warn "$P: Can't write '$camelcase_cache' $!\n";
351b2a1f
JP
546 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
547 print $camelcase_file ("$_\n");
548 }
549 close($camelcase_file);
550 }
3445686a
JP
551}
552
d311cd44
JP
553sub git_commit_info {
554 my ($commit, $id, $desc) = @_;
555
556 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
557
558 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
559 $output =~ s/^\s*//gm;
560 my @lines = split("\n", $output);
561
562 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
563# Maybe one day convert this block of bash into something that returns
564# all matching commit ids, but it's very slow...
565#
566# echo "checking commits $1..."
567# git rev-list --remotes | grep -i "^$1" |
568# while read line ; do
569# git log --format='%H %s' -1 $line |
570# echo "commit $(cut -c 1-12,41-)"
571# done
572 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
573 } else {
574 $id = substr($lines[0], 0, 12);
575 $desc = substr($lines[0], 41);
576 }
577
578 return ($id, $desc);
579}
580
6c72ffaa
AW
581$chk_signoff = 0 if ($file);
582
00df344f 583my @rawlines = ();
c2fdda0d 584my @lines = ();
3705ce5b 585my @fixed = ();
d752fcc8
JP
586my @fixed_inserted = ();
587my @fixed_deleted = ();
194f66fc
JP
588my $fixlinenr = -1;
589
c2fdda0d 590my $vname;
6c72ffaa 591for my $filename (@ARGV) {
21caa13c 592 my $FILE;
6c72ffaa 593 if ($file) {
21caa13c 594 open($FILE, '-|', "diff -u /dev/null $filename") ||
6c72ffaa 595 die "$P: $filename: diff failed - $!\n";
21caa13c
AW
596 } elsif ($filename eq '-') {
597 open($FILE, '<&STDIN');
6c72ffaa 598 } else {
21caa13c 599 open($FILE, '<', "$filename") ||
6c72ffaa 600 die "$P: $filename: open failed - $!\n";
0a920b5b 601 }
c2fdda0d
AW
602 if ($filename eq '-') {
603 $vname = 'Your patch';
604 } else {
605 $vname = $filename;
606 }
21caa13c 607 while (<$FILE>) {
6c72ffaa
AW
608 chomp;
609 push(@rawlines, $_);
610 }
21caa13c 611 close($FILE);
c2fdda0d 612 if (!process($filename)) {
6c72ffaa
AW
613 $exit = 1;
614 }
615 @rawlines = ();
13214adf 616 @lines = ();
3705ce5b 617 @fixed = ();
d752fcc8
JP
618 @fixed_inserted = ();
619 @fixed_deleted = ();
194f66fc 620 $fixlinenr = -1;
0a920b5b
AW
621}
622
623exit($exit);
624
625sub top_of_kernel_tree {
6c72ffaa
AW
626 my ($root) = @_;
627
628 my @tree_check = (
629 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
630 "README", "Documentation", "arch", "include", "drivers",
631 "fs", "init", "ipc", "kernel", "lib", "scripts",
632 );
633
634 foreach my $check (@tree_check) {
635 if (! -e $root . '/' . $check) {
636 return 0;
637 }
0a920b5b 638 }
6c72ffaa 639 return 1;
8f26b837 640}
0a920b5b 641
20112475
JP
642sub parse_email {
643 my ($formatted_email) = @_;
644
645 my $name = "";
646 my $address = "";
647 my $comment = "";
648
649 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
650 $name = $1;
651 $address = $2;
652 $comment = $3 if defined $3;
653 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
654 $address = $1;
655 $comment = $2 if defined $2;
656 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
657 $address = $1;
658 $comment = $2 if defined $2;
659 $formatted_email =~ s/$address.*$//;
660 $name = $formatted_email;
3705ce5b 661 $name = trim($name);
20112475
JP
662 $name =~ s/^\"|\"$//g;
663 # If there's a name left after stripping spaces and
664 # leading quotes, and the address doesn't have both
665 # leading and trailing angle brackets, the address
666 # is invalid. ie:
667 # "joe smith joe@smith.com" bad
668 # "joe smith <joe@smith.com" bad
669 if ($name ne "" && $address !~ /^<[^>]+>$/) {
670 $name = "";
671 $address = "";
672 $comment = "";
673 }
674 }
675
3705ce5b 676 $name = trim($name);
20112475 677 $name =~ s/^\"|\"$//g;
3705ce5b 678 $address = trim($address);
20112475
JP
679 $address =~ s/^\<|\>$//g;
680
681 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
682 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
683 $name = "\"$name\"";
684 }
685
686 return ($name, $address, $comment);
687}
688
689sub format_email {
690 my ($name, $address) = @_;
691
692 my $formatted_email;
693
3705ce5b 694 $name = trim($name);
20112475 695 $name =~ s/^\"|\"$//g;
3705ce5b 696 $address = trim($address);
20112475
JP
697
698 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
699 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
700 $name = "\"$name\"";
701 }
702
703 if ("$name" eq "") {
704 $formatted_email = "$address";
705 } else {
706 $formatted_email = "$name <$address>";
707 }
708
709 return $formatted_email;
710}
711
d311cd44 712sub which {
bd474ca0 713 my ($bin) = @_;
d311cd44 714
bd474ca0
JP
715 foreach my $path (split(/:/, $ENV{PATH})) {
716 if (-e "$path/$bin") {
717 return "$path/$bin";
718 }
d311cd44 719 }
d311cd44 720
bd474ca0 721 return "";
d311cd44
JP
722}
723
000d1cc1
JP
724sub which_conf {
725 my ($conf) = @_;
726
727 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
728 if (-e "$path/$conf") {
729 return "$path/$conf";
730 }
731 }
732
733 return "";
734}
735
0a920b5b
AW
736sub expand_tabs {
737 my ($str) = @_;
738
739 my $res = '';
740 my $n = 0;
741 for my $c (split(//, $str)) {
742 if ($c eq "\t") {
743 $res .= ' ';
744 $n++;
745 for (; ($n % 8) != 0; $n++) {
746 $res .= ' ';
747 }
748 next;
749 }
750 $res .= $c;
751 $n++;
752 }
753
754 return $res;
755}
6c72ffaa 756sub copy_spacing {
773647a0 757 (my $res = shift) =~ tr/\t/ /c;
6c72ffaa
AW
758 return $res;
759}
0a920b5b 760
4a0df2ef
AW
761sub line_stats {
762 my ($line) = @_;
763
764 # Drop the diff line leader and expand tabs
765 $line =~ s/^.//;
766 $line = expand_tabs($line);
767
768 # Pick the indent from the front of the line.
769 my ($white) = ($line =~ /^(\s*)/);
770
771 return (length($line), length($white));
772}
773
773647a0
AW
774my $sanitise_quote = '';
775
776sub sanitise_line_reset {
777 my ($in_comment) = @_;
778
779 if ($in_comment) {
780 $sanitise_quote = '*/';
781 } else {
782 $sanitise_quote = '';
783 }
784}
00df344f
AW
785sub sanitise_line {
786 my ($line) = @_;
787
788 my $res = '';
789 my $l = '';
790
c2fdda0d 791 my $qlen = 0;
773647a0
AW
792 my $off = 0;
793 my $c;
00df344f 794
773647a0
AW
795 # Always copy over the diff marker.
796 $res = substr($line, 0, 1);
797
798 for ($off = 1; $off < length($line); $off++) {
799 $c = substr($line, $off, 1);
800
801 # Comments we are wacking completly including the begin
802 # and end, all to $;.
803 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
804 $sanitise_quote = '*/';
805
806 substr($res, $off, 2, "$;$;");
807 $off++;
808 next;
00df344f 809 }
81bc0e02 810 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
773647a0
AW
811 $sanitise_quote = '';
812 substr($res, $off, 2, "$;$;");
813 $off++;
814 next;
c2fdda0d 815 }
113f04a8
DW
816 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
817 $sanitise_quote = '//';
818
819 substr($res, $off, 2, $sanitise_quote);
820 $off++;
821 next;
822 }
773647a0
AW
823
824 # A \ in a string means ignore the next character.
825 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
826 $c eq "\\") {
827 substr($res, $off, 2, 'XX');
828 $off++;
829 next;
00df344f 830 }
773647a0
AW
831 # Regular quotes.
832 if ($c eq "'" || $c eq '"') {
833 if ($sanitise_quote eq '') {
834 $sanitise_quote = $c;
00df344f 835
773647a0
AW
836 substr($res, $off, 1, $c);
837 next;
838 } elsif ($sanitise_quote eq $c) {
839 $sanitise_quote = '';
840 }
841 }
00df344f 842
fae17dae 843 #print "c<$c> SQ<$sanitise_quote>\n";
773647a0
AW
844 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
845 substr($res, $off, 1, $;);
113f04a8
DW
846 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
847 substr($res, $off, 1, $;);
773647a0
AW
848 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
849 substr($res, $off, 1, 'X');
850 } else {
851 substr($res, $off, 1, $c);
852 }
c2fdda0d
AW
853 }
854
113f04a8
DW
855 if ($sanitise_quote eq '//') {
856 $sanitise_quote = '';
857 }
858
c2fdda0d 859 # The pathname on a #include may be surrounded by '<' and '>'.
c45dcabd 860 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
c2fdda0d
AW
861 my $clean = 'X' x length($1);
862 $res =~ s@\<.*\>@<$clean>@;
863
864 # The whole of a #error is a string.
c45dcabd 865 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
c2fdda0d 866 my $clean = 'X' x length($1);
c45dcabd 867 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
c2fdda0d
AW
868 }
869
00df344f
AW
870 return $res;
871}
872
a6962d72
JP
873sub get_quoted_string {
874 my ($line, $rawline) = @_;
875
876 return "" if ($line !~ m/(\"[X]+\")/g);
877 return substr($rawline, $-[0], $+[0] - $-[0]);
878}
879
8905a67c
AW
880sub ctx_statement_block {
881 my ($linenr, $remain, $off) = @_;
882 my $line = $linenr - 1;
883 my $blk = '';
884 my $soff = $off;
885 my $coff = $off - 1;
773647a0 886 my $coff_set = 0;
8905a67c 887
13214adf
AW
888 my $loff = 0;
889
8905a67c
AW
890 my $type = '';
891 my $level = 0;
a2750645 892 my @stack = ();
cf655043 893 my $p;
8905a67c
AW
894 my $c;
895 my $len = 0;
13214adf
AW
896
897 my $remainder;
8905a67c 898 while (1) {
a2750645
AW
899 @stack = (['', 0]) if ($#stack == -1);
900
773647a0 901 #warn "CSB: blk<$blk> remain<$remain>\n";
8905a67c
AW
902 # If we are about to drop off the end, pull in more
903 # context.
904 if ($off >= $len) {
905 for (; $remain > 0; $line++) {
dea33496 906 last if (!defined $lines[$line]);
c2fdda0d 907 next if ($lines[$line] =~ /^-/);
8905a67c 908 $remain--;
13214adf 909 $loff = $len;
c2fdda0d 910 $blk .= $lines[$line] . "\n";
8905a67c
AW
911 $len = length($blk);
912 $line++;
913 last;
914 }
915 # Bail if there is no further context.
916 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
13214adf 917 if ($off >= $len) {
8905a67c
AW
918 last;
919 }
f74bd194
AW
920 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
921 $level++;
922 $type = '#';
923 }
8905a67c 924 }
cf655043 925 $p = $c;
8905a67c 926 $c = substr($blk, $off, 1);
13214adf 927 $remainder = substr($blk, $off);
8905a67c 928
773647a0 929 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
4635f4fb
AW
930
931 # Handle nested #if/#else.
932 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
933 push(@stack, [ $type, $level ]);
934 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
935 ($type, $level) = @{$stack[$#stack - 1]};
936 } elsif ($remainder =~ /^#\s*endif\b/) {
937 ($type, $level) = @{pop(@stack)};
938 }
939
8905a67c
AW
940 # Statement ends at the ';' or a close '}' at the
941 # outermost level.
942 if ($level == 0 && $c eq ';') {
943 last;
944 }
945
13214adf 946 # An else is really a conditional as long as its not else if
773647a0
AW
947 if ($level == 0 && $coff_set == 0 &&
948 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
949 $remainder =~ /^(else)(?:\s|{)/ &&
950 $remainder !~ /^else\s+if\b/) {
951 $coff = $off + length($1) - 1;
952 $coff_set = 1;
953 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
954 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
13214adf
AW
955 }
956
8905a67c
AW
957 if (($type eq '' || $type eq '(') && $c eq '(') {
958 $level++;
959 $type = '(';
960 }
961 if ($type eq '(' && $c eq ')') {
962 $level--;
963 $type = ($level != 0)? '(' : '';
964
965 if ($level == 0 && $coff < $soff) {
966 $coff = $off;
773647a0
AW
967 $coff_set = 1;
968 #warn "CSB: mark coff<$coff>\n";
8905a67c
AW
969 }
970 }
971 if (($type eq '' || $type eq '{') && $c eq '{') {
972 $level++;
973 $type = '{';
974 }
975 if ($type eq '{' && $c eq '}') {
976 $level--;
977 $type = ($level != 0)? '{' : '';
978
979 if ($level == 0) {
b998e001
PP
980 if (substr($blk, $off + 1, 1) eq ';') {
981 $off++;
982 }
8905a67c
AW
983 last;
984 }
985 }
f74bd194
AW
986 # Preprocessor commands end at the newline unless escaped.
987 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
988 $level--;
989 $type = '';
990 $off++;
991 last;
992 }
8905a67c
AW
993 $off++;
994 }
a3bb97a7 995 # We are truly at the end, so shuffle to the next line.
13214adf 996 if ($off == $len) {
a3bb97a7 997 $loff = $len + 1;
13214adf
AW
998 $line++;
999 $remain--;
1000 }
8905a67c
AW
1001
1002 my $statement = substr($blk, $soff, $off - $soff + 1);
1003 my $condition = substr($blk, $soff, $coff - $soff + 1);
1004
1005 #warn "STATEMENT<$statement>\n";
1006 #warn "CONDITION<$condition>\n";
1007
773647a0 1008 #print "coff<$coff> soff<$off> loff<$loff>\n";
13214adf
AW
1009
1010 return ($statement, $condition,
1011 $line, $remain + 1, $off - $loff + 1, $level);
1012}
1013
cf655043
AW
1014sub statement_lines {
1015 my ($stmt) = @_;
1016
1017 # Strip the diff line prefixes and rip blank lines at start and end.
1018 $stmt =~ s/(^|\n)./$1/g;
1019 $stmt =~ s/^\s*//;
1020 $stmt =~ s/\s*$//;
1021
1022 my @stmt_lines = ($stmt =~ /\n/g);
1023
1024 return $#stmt_lines + 2;
1025}
1026
1027sub statement_rawlines {
1028 my ($stmt) = @_;
1029
1030 my @stmt_lines = ($stmt =~ /\n/g);
1031
1032 return $#stmt_lines + 2;
1033}
1034
1035sub statement_block_size {
1036 my ($stmt) = @_;
1037
1038 $stmt =~ s/(^|\n)./$1/g;
1039 $stmt =~ s/^\s*{//;
1040 $stmt =~ s/}\s*$//;
1041 $stmt =~ s/^\s*//;
1042 $stmt =~ s/\s*$//;
1043
1044 my @stmt_lines = ($stmt =~ /\n/g);
1045 my @stmt_statements = ($stmt =~ /;/g);
1046
1047 my $stmt_lines = $#stmt_lines + 2;
1048 my $stmt_statements = $#stmt_statements + 1;
1049
1050 if ($stmt_lines > $stmt_statements) {
1051 return $stmt_lines;
1052 } else {
1053 return $stmt_statements;
1054 }
1055}
1056
13214adf
AW
1057sub ctx_statement_full {
1058 my ($linenr, $remain, $off) = @_;
1059 my ($statement, $condition, $level);
1060
1061 my (@chunks);
1062
cf655043 1063 # Grab the first conditional/block pair.
13214adf
AW
1064 ($statement, $condition, $linenr, $remain, $off, $level) =
1065 ctx_statement_block($linenr, $remain, $off);
773647a0 1066 #print "F: c<$condition> s<$statement> remain<$remain>\n";
cf655043
AW
1067 push(@chunks, [ $condition, $statement ]);
1068 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1069 return ($level, $linenr, @chunks);
1070 }
1071
1072 # Pull in the following conditional/block pairs and see if they
1073 # could continue the statement.
13214adf 1074 for (;;) {
13214adf
AW
1075 ($statement, $condition, $linenr, $remain, $off, $level) =
1076 ctx_statement_block($linenr, $remain, $off);
cf655043 1077 #print "C: c<$condition> s<$statement> remain<$remain>\n";
773647a0 1078 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
cf655043
AW
1079 #print "C: push\n";
1080 push(@chunks, [ $condition, $statement ]);
13214adf
AW
1081 }
1082
1083 return ($level, $linenr, @chunks);
8905a67c
AW
1084}
1085
4a0df2ef 1086sub ctx_block_get {
f0a594c1 1087 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
4a0df2ef
AW
1088 my $line;
1089 my $start = $linenr - 1;
4a0df2ef
AW
1090 my $blk = '';
1091 my @o;
1092 my @c;
1093 my @res = ();
1094
f0a594c1 1095 my $level = 0;
4635f4fb 1096 my @stack = ($level);
00df344f
AW
1097 for ($line = $start; $remain > 0; $line++) {
1098 next if ($rawlines[$line] =~ /^-/);
1099 $remain--;
1100
1101 $blk .= $rawlines[$line];
4635f4fb
AW
1102
1103 # Handle nested #if/#else.
01464f30 1104 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
4635f4fb 1105 push(@stack, $level);
01464f30 1106 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
4635f4fb 1107 $level = $stack[$#stack - 1];
01464f30 1108 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
4635f4fb
AW
1109 $level = pop(@stack);
1110 }
1111
01464f30 1112 foreach my $c (split(//, $lines[$line])) {
f0a594c1
AW
1113 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1114 if ($off > 0) {
1115 $off--;
1116 next;
1117 }
4a0df2ef 1118
f0a594c1
AW
1119 if ($c eq $close && $level > 0) {
1120 $level--;
1121 last if ($level == 0);
1122 } elsif ($c eq $open) {
1123 $level++;
1124 }
1125 }
4a0df2ef 1126
f0a594c1 1127 if (!$outer || $level <= 1) {
00df344f 1128 push(@res, $rawlines[$line]);
4a0df2ef
AW
1129 }
1130
f0a594c1 1131 last if ($level == 0);
4a0df2ef
AW
1132 }
1133
f0a594c1 1134 return ($level, @res);
4a0df2ef
AW
1135}
1136sub ctx_block_outer {
1137 my ($linenr, $remain) = @_;
1138
f0a594c1
AW
1139 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1140 return @r;
4a0df2ef
AW
1141}
1142sub ctx_block {
1143 my ($linenr, $remain) = @_;
1144
f0a594c1
AW
1145 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1146 return @r;
653d4876
AW
1147}
1148sub ctx_statement {
f0a594c1
AW
1149 my ($linenr, $remain, $off) = @_;
1150
1151 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1152 return @r;
1153}
1154sub ctx_block_level {
653d4876
AW
1155 my ($linenr, $remain) = @_;
1156
f0a594c1 1157 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
4a0df2ef 1158}
9c0ca6f9
AW
1159sub ctx_statement_level {
1160 my ($linenr, $remain, $off) = @_;
1161
1162 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1163}
4a0df2ef
AW
1164
1165sub ctx_locate_comment {
1166 my ($first_line, $end_line) = @_;
1167
1168 # Catch a comment on the end of the line itself.
beae6332 1169 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
4a0df2ef
AW
1170 return $current_comment if (defined $current_comment);
1171
1172 # Look through the context and try and figure out if there is a
1173 # comment.
1174 my $in_comment = 0;
1175 $current_comment = '';
1176 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
00df344f
AW
1177 my $line = $rawlines[$linenr - 1];
1178 #warn " $line\n";
4a0df2ef
AW
1179 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1180 $in_comment = 1;
1181 }
1182 if ($line =~ m@/\*@) {
1183 $in_comment = 1;
1184 }
1185 if (!$in_comment && $current_comment ne '') {
1186 $current_comment = '';
1187 }
1188 $current_comment .= $line . "\n" if ($in_comment);
1189 if ($line =~ m@\*/@) {
1190 $in_comment = 0;
1191 }
1192 }
1193
1194 chomp($current_comment);
1195 return($current_comment);
1196}
1197sub ctx_has_comment {
1198 my ($first_line, $end_line) = @_;
1199 my $cmt = ctx_locate_comment($first_line, $end_line);
1200
00df344f 1201 ##print "LINE: $rawlines[$end_line - 1 ]\n";
4a0df2ef
AW
1202 ##print "CMMT: $cmt\n";
1203
1204 return ($cmt ne '');
1205}
1206
4d001e4d
AW
1207sub raw_line {
1208 my ($linenr, $cnt) = @_;
1209
1210 my $offset = $linenr - 1;
1211 $cnt++;
1212
1213 my $line;
1214 while ($cnt) {
1215 $line = $rawlines[$offset++];
1216 next if (defined($line) && $line =~ /^-/);
1217 $cnt--;
1218 }
1219
1220 return $line;
1221}
1222
6c72ffaa
AW
1223sub cat_vet {
1224 my ($vet) = @_;
1225 my ($res, $coded);
9c0ca6f9 1226
6c72ffaa
AW
1227 $res = '';
1228 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1229 $res .= $1;
1230 if ($2 ne '') {
1231 $coded = sprintf("^%c", unpack('C', $2) + 64);
1232 $res .= $coded;
9c0ca6f9
AW
1233 }
1234 }
6c72ffaa 1235 $res =~ s/$/\$/;
9c0ca6f9 1236
6c72ffaa 1237 return $res;
9c0ca6f9
AW
1238}
1239
c2fdda0d 1240my $av_preprocessor = 0;
cf655043 1241my $av_pending;
c2fdda0d 1242my @av_paren_type;
1f65f947 1243my $av_pend_colon;
c2fdda0d
AW
1244
1245sub annotate_reset {
1246 $av_preprocessor = 0;
cf655043
AW
1247 $av_pending = '_';
1248 @av_paren_type = ('E');
1f65f947 1249 $av_pend_colon = 'O';
c2fdda0d
AW
1250}
1251
6c72ffaa
AW
1252sub annotate_values {
1253 my ($stream, $type) = @_;
0a920b5b 1254
6c72ffaa 1255 my $res;
1f65f947 1256 my $var = '_' x length($stream);
6c72ffaa
AW
1257 my $cur = $stream;
1258
c2fdda0d 1259 print "$stream\n" if ($dbg_values > 1);
6c72ffaa 1260
6c72ffaa 1261 while (length($cur)) {
773647a0 1262 @av_paren_type = ('E') if ($#av_paren_type < 0);
cf655043 1263 print " <" . join('', @av_paren_type) .
171ae1a4 1264 "> <$type> <$av_pending>" if ($dbg_values > 1);
6c72ffaa 1265 if ($cur =~ /^(\s+)/o) {
c2fdda0d
AW
1266 print "WS($1)\n" if ($dbg_values > 1);
1267 if ($1 =~ /\n/ && $av_preprocessor) {
cf655043 1268 $type = pop(@av_paren_type);
c2fdda0d 1269 $av_preprocessor = 0;
6c72ffaa
AW
1270 }
1271
c023e473 1272 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
9446ef56
AW
1273 print "CAST($1)\n" if ($dbg_values > 1);
1274 push(@av_paren_type, $type);
addcdcea 1275 $type = 'c';
9446ef56 1276
e91b6e26 1277 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
c2fdda0d 1278 print "DECLARE($1)\n" if ($dbg_values > 1);
6c72ffaa
AW
1279 $type = 'T';
1280
389a2fe5
AW
1281 } elsif ($cur =~ /^($Modifier)\s*/) {
1282 print "MODIFIER($1)\n" if ($dbg_values > 1);
1283 $type = 'T';
1284
c45dcabd 1285 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
171ae1a4 1286 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
c2fdda0d 1287 $av_preprocessor = 1;
171ae1a4
AW
1288 push(@av_paren_type, $type);
1289 if ($2 ne '') {
1290 $av_pending = 'N';
1291 }
1292 $type = 'E';
1293
c45dcabd 1294 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
171ae1a4
AW
1295 print "UNDEF($1)\n" if ($dbg_values > 1);
1296 $av_preprocessor = 1;
1297 push(@av_paren_type, $type);
6c72ffaa 1298
c45dcabd 1299 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
cf655043 1300 print "PRE_START($1)\n" if ($dbg_values > 1);
c2fdda0d 1301 $av_preprocessor = 1;
cf655043
AW
1302
1303 push(@av_paren_type, $type);
1304 push(@av_paren_type, $type);
171ae1a4 1305 $type = 'E';
cf655043 1306
c45dcabd 1307 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
cf655043
AW
1308 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1309 $av_preprocessor = 1;
1310
1311 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1312
171ae1a4 1313 $type = 'E';
cf655043 1314
c45dcabd 1315 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
cf655043
AW
1316 print "PRE_END($1)\n" if ($dbg_values > 1);
1317
1318 $av_preprocessor = 1;
1319
1320 # Assume all arms of the conditional end as this
1321 # one does, and continue as if the #endif was not here.
1322 pop(@av_paren_type);
1323 push(@av_paren_type, $type);
171ae1a4 1324 $type = 'E';
6c72ffaa
AW
1325
1326 } elsif ($cur =~ /^(\\\n)/o) {
c2fdda0d 1327 print "PRECONT($1)\n" if ($dbg_values > 1);
6c72ffaa 1328
171ae1a4
AW
1329 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1330 print "ATTR($1)\n" if ($dbg_values > 1);
1331 $av_pending = $type;
1332 $type = 'N';
1333
6c72ffaa 1334 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
c2fdda0d 1335 print "SIZEOF($1)\n" if ($dbg_values > 1);
6c72ffaa 1336 if (defined $2) {
cf655043 1337 $av_pending = 'V';
6c72ffaa
AW
1338 }
1339 $type = 'N';
1340
14b111c1 1341 } elsif ($cur =~ /^(if|while|for)\b/o) {
c2fdda0d 1342 print "COND($1)\n" if ($dbg_values > 1);
14b111c1 1343 $av_pending = 'E';
6c72ffaa
AW
1344 $type = 'N';
1345
1f65f947
AW
1346 } elsif ($cur =~/^(case)/o) {
1347 print "CASE($1)\n" if ($dbg_values > 1);
1348 $av_pend_colon = 'C';
1349 $type = 'N';
1350
14b111c1 1351 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
c2fdda0d 1352 print "KEYWORD($1)\n" if ($dbg_values > 1);
6c72ffaa
AW
1353 $type = 'N';
1354
1355 } elsif ($cur =~ /^(\()/o) {
c2fdda0d 1356 print "PAREN('$1')\n" if ($dbg_values > 1);
cf655043
AW
1357 push(@av_paren_type, $av_pending);
1358 $av_pending = '_';
6c72ffaa
AW
1359 $type = 'N';
1360
1361 } elsif ($cur =~ /^(\))/o) {
cf655043
AW
1362 my $new_type = pop(@av_paren_type);
1363 if ($new_type ne '_') {
1364 $type = $new_type;
c2fdda0d
AW
1365 print "PAREN('$1') -> $type\n"
1366 if ($dbg_values > 1);
6c72ffaa 1367 } else {
c2fdda0d 1368 print "PAREN('$1')\n" if ($dbg_values > 1);
6c72ffaa
AW
1369 }
1370
c8cb2ca3 1371 } elsif ($cur =~ /^($Ident)\s*\(/o) {
c2fdda0d 1372 print "FUNC($1)\n" if ($dbg_values > 1);
c8cb2ca3 1373 $type = 'V';
cf655043 1374 $av_pending = 'V';
6c72ffaa 1375
8e761b04
AW
1376 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1377 if (defined $2 && $type eq 'C' || $type eq 'T') {
1f65f947 1378 $av_pend_colon = 'B';
8e761b04
AW
1379 } elsif ($type eq 'E') {
1380 $av_pend_colon = 'L';
1f65f947
AW
1381 }
1382 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1383 $type = 'V';
1384
6c72ffaa 1385 } elsif ($cur =~ /^($Ident|$Constant)/o) {
c2fdda0d 1386 print "IDENT($1)\n" if ($dbg_values > 1);
6c72ffaa
AW
1387 $type = 'V';
1388
1389 } elsif ($cur =~ /^($Assignment)/o) {
c2fdda0d 1390 print "ASSIGN($1)\n" if ($dbg_values > 1);
6c72ffaa
AW
1391 $type = 'N';
1392
cf655043 1393 } elsif ($cur =~/^(;|{|})/) {
c2fdda0d 1394 print "END($1)\n" if ($dbg_values > 1);
13214adf 1395 $type = 'E';
1f65f947
AW
1396 $av_pend_colon = 'O';
1397
8e761b04
AW
1398 } elsif ($cur =~/^(,)/) {
1399 print "COMMA($1)\n" if ($dbg_values > 1);
1400 $type = 'C';
1401
1f65f947
AW
1402 } elsif ($cur =~ /^(\?)/o) {
1403 print "QUESTION($1)\n" if ($dbg_values > 1);
1404 $type = 'N';
1405
1406 } elsif ($cur =~ /^(:)/o) {
1407 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1408
1409 substr($var, length($res), 1, $av_pend_colon);
1410 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1411 $type = 'E';
1412 } else {
1413 $type = 'N';
1414 }
1415 $av_pend_colon = 'O';
13214adf 1416
8e761b04 1417 } elsif ($cur =~ /^(\[)/o) {
13214adf 1418 print "CLOSE($1)\n" if ($dbg_values > 1);
6c72ffaa
AW
1419 $type = 'N';
1420
0d413866 1421 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
74048ed8
AW
1422 my $variant;
1423
1424 print "OPV($1)\n" if ($dbg_values > 1);
1425 if ($type eq 'V') {
1426 $variant = 'B';
1427 } else {
1428 $variant = 'U';
1429 }
1430
1431 substr($var, length($res), 1, $variant);
1432 $type = 'N';
1433
6c72ffaa 1434 } elsif ($cur =~ /^($Operators)/o) {
c2fdda0d 1435 print "OP($1)\n" if ($dbg_values > 1);
6c72ffaa
AW
1436 if ($1 ne '++' && $1 ne '--') {
1437 $type = 'N';
1438 }
1439
1440 } elsif ($cur =~ /(^.)/o) {
c2fdda0d 1441 print "C($1)\n" if ($dbg_values > 1);
6c72ffaa
AW
1442 }
1443 if (defined $1) {
1444 $cur = substr($cur, length($1));
1445 $res .= $type x length($1);
1446 }
9c0ca6f9 1447 }
0a920b5b 1448
1f65f947 1449 return ($res, $var);
0a920b5b
AW
1450}
1451
8905a67c 1452sub possible {
13214adf 1453 my ($possible, $line) = @_;
9a974fdb 1454 my $notPermitted = qr{(?:
0776e594
AW
1455 ^(?:
1456 $Modifier|
1457 $Storage|
1458 $Type|
9a974fdb
AW
1459 DEFINE_\S+
1460 )$|
1461 ^(?:
0776e594
AW
1462 goto|
1463 return|
1464 case|
1465 else|
1466 asm|__asm__|
89a88353
AW
1467 do|
1468 \#|
1469 \#\#|
9a974fdb 1470 )(?:\s|$)|
0776e594 1471 ^(?:typedef|struct|enum)\b
9a974fdb
AW
1472 )}x;
1473 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1474 if ($possible !~ $notPermitted) {
c45dcabd
AW
1475 # Check for modifiers.
1476 $possible =~ s/\s*$Storage\s*//g;
1477 $possible =~ s/\s*$Sparse\s*//g;
1478 if ($possible =~ /^\s*$/) {
1479
1480 } elsif ($possible =~ /\s/) {
1481 $possible =~ s/\s*$Type\s*//g;
d2506586 1482 for my $modifier (split(' ', $possible)) {
9a974fdb
AW
1483 if ($modifier !~ $notPermitted) {
1484 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1485 push(@modifierList, $modifier);
1486 }
d2506586 1487 }
c45dcabd
AW
1488
1489 } else {
1490 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1491 push(@typeList, $possible);
1492 }
8905a67c 1493 build_types();
0776e594
AW
1494 } else {
1495 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
8905a67c
AW
1496 }
1497}
1498
6c72ffaa
AW
1499my $prefix = '';
1500
000d1cc1 1501sub show_type {
cbec18af 1502 my ($type) = @_;
91bfe484 1503
cbec18af
JP
1504 return defined $use_type{$type} if (scalar keys %use_type > 0);
1505
1506 return !defined $ignore_type{$type};
000d1cc1
JP
1507}
1508
f0a594c1 1509sub report {
cbec18af
JP
1510 my ($level, $type, $msg) = @_;
1511
1512 if (!show_type($type) ||
1513 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
773647a0
AW
1514 return 0;
1515 }
000d1cc1
JP
1516 my $line;
1517 if ($show_types) {
cbec18af 1518 $line = "$prefix$level:$type: $msg\n";
000d1cc1 1519 } else {
cbec18af 1520 $line = "$prefix$level: $msg\n";
000d1cc1 1521 }
8905a67c
AW
1522 $line = (split('\n', $line))[0] . "\n" if ($terse);
1523
13214adf 1524 push(our @report, $line);
773647a0
AW
1525
1526 return 1;
f0a594c1 1527}
cbec18af 1528
f0a594c1 1529sub report_dump {
13214adf 1530 our @report;
f0a594c1 1531}
000d1cc1 1532
d752fcc8
JP
1533sub fixup_current_range {
1534 my ($lineRef, $offset, $length) = @_;
1535
1536 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1537 my $o = $1;
1538 my $l = $2;
1539 my $no = $o + $offset;
1540 my $nl = $l + $length;
1541 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1542 }
1543}
1544
1545sub fix_inserted_deleted_lines {
1546 my ($linesRef, $insertedRef, $deletedRef) = @_;
1547
1548 my $range_last_linenr = 0;
1549 my $delta_offset = 0;
1550
1551 my $old_linenr = 0;
1552 my $new_linenr = 0;
1553
1554 my $next_insert = 0;
1555 my $next_delete = 0;
1556
1557 my @lines = ();
1558
1559 my $inserted = @{$insertedRef}[$next_insert++];
1560 my $deleted = @{$deletedRef}[$next_delete++];
1561
1562 foreach my $old_line (@{$linesRef}) {
1563 my $save_line = 1;
1564 my $line = $old_line; #don't modify the array
1565 if ($line =~ /^(?:\+\+\+\|\-\-\-)\s+\S+/) { #new filename
1566 $delta_offset = 0;
1567 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1568 $range_last_linenr = $new_linenr;
1569 fixup_current_range(\$line, $delta_offset, 0);
1570 }
1571
1572 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1573 $deleted = @{$deletedRef}[$next_delete++];
1574 $save_line = 0;
1575 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1576 }
1577
1578 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1579 push(@lines, ${$inserted}{'LINE'});
1580 $inserted = @{$insertedRef}[$next_insert++];
1581 $new_linenr++;
1582 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1583 }
1584
1585 if ($save_line) {
1586 push(@lines, $line);
1587 $new_linenr++;
1588 }
1589
1590 $old_linenr++;
1591 }
1592
1593 return @lines;
1594}
1595
f2d7e4d4
JP
1596sub fix_insert_line {
1597 my ($linenr, $line) = @_;
1598
1599 my $inserted = {
1600 LINENR => $linenr,
1601 LINE => $line,
1602 };
1603 push(@fixed_inserted, $inserted);
1604}
1605
1606sub fix_delete_line {
1607 my ($linenr, $line) = @_;
1608
1609 my $deleted = {
1610 LINENR => $linenr,
1611 LINE => $line,
1612 };
1613
1614 push(@fixed_deleted, $deleted);
1615}
1616
de7d4f0e 1617sub ERROR {
cbec18af
JP
1618 my ($type, $msg) = @_;
1619
1620 if (report("ERROR", $type, $msg)) {
773647a0
AW
1621 our $clean = 0;
1622 our $cnt_error++;
3705ce5b 1623 return 1;
773647a0 1624 }
3705ce5b 1625 return 0;
de7d4f0e
AW
1626}
1627sub WARN {
cbec18af
JP
1628 my ($type, $msg) = @_;
1629
1630 if (report("WARNING", $type, $msg)) {
773647a0
AW
1631 our $clean = 0;
1632 our $cnt_warn++;
3705ce5b 1633 return 1;
773647a0 1634 }
3705ce5b 1635 return 0;
de7d4f0e
AW
1636}
1637sub CHK {
cbec18af
JP
1638 my ($type, $msg) = @_;
1639
1640 if ($check && report("CHECK", $type, $msg)) {
6c72ffaa
AW
1641 our $clean = 0;
1642 our $cnt_chk++;
3705ce5b 1643 return 1;
6c72ffaa 1644 }
3705ce5b 1645 return 0;
de7d4f0e
AW
1646}
1647
6ecd9674
AW
1648sub check_absolute_file {
1649 my ($absolute, $herecurr) = @_;
1650 my $file = $absolute;
1651
1652 ##print "absolute<$absolute>\n";
1653
1654 # See if any suffix of this path is a path within the tree.
1655 while ($file =~ s@^[^/]*/@@) {
1656 if (-f "$root/$file") {
1657 ##print "file<$file>\n";
1658 last;
1659 }
1660 }
1661 if (! -f _) {
1662 return 0;
1663 }
1664
1665 # It is, so see if the prefix is acceptable.
1666 my $prefix = $absolute;
1667 substr($prefix, -length($file)) = '';
1668
1669 ##print "prefix<$prefix>\n";
1670 if ($prefix ne ".../") {
000d1cc1
JP
1671 WARN("USE_RELATIVE_PATH",
1672 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
6ecd9674
AW
1673 }
1674}
1675
3705ce5b
JP
1676sub trim {
1677 my ($string) = @_;
1678
b34c648b
JP
1679 $string =~ s/^\s+|\s+$//g;
1680
1681 return $string;
1682}
1683
1684sub ltrim {
1685 my ($string) = @_;
1686
1687 $string =~ s/^\s+//;
1688
1689 return $string;
1690}
1691
1692sub rtrim {
1693 my ($string) = @_;
1694
1695 $string =~ s/\s+$//;
3705ce5b
JP
1696
1697 return $string;
1698}
1699
52ea8506
JP
1700sub string_find_replace {
1701 my ($string, $find, $replace) = @_;
1702
1703 $string =~ s/$find/$replace/g;
1704
1705 return $string;
1706}
1707
3705ce5b
JP
1708sub tabify {
1709 my ($leading) = @_;
1710
1711 my $source_indent = 8;
1712 my $max_spaces_before_tab = $source_indent - 1;
1713 my $spaces_to_tab = " " x $source_indent;
1714
1715 #convert leading spaces to tabs
1716 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1717 #Remove spaces before a tab
1718 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1719
1720 return "$leading";
1721}
1722
d1fe9c09
JP
1723sub pos_last_openparen {
1724 my ($line) = @_;
1725
1726 my $pos = 0;
1727
1728 my $opens = $line =~ tr/\(/\(/;
1729 my $closes = $line =~ tr/\)/\)/;
1730
1731 my $last_openparen = 0;
1732
1733 if (($opens == 0) || ($closes >= $opens)) {
1734 return -1;
1735 }
1736
1737 my $len = length($line);
1738
1739 for ($pos = 0; $pos < $len; $pos++) {
1740 my $string = substr($line, $pos);
1741 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1742 $pos += length($1) - 1;
1743 } elsif (substr($line, $pos, 1) eq '(') {
1744 $last_openparen = $pos;
1745 } elsif (index($string, '(') == -1) {
1746 last;
1747 }
1748 }
1749
91cb5195 1750 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
d1fe9c09
JP
1751}
1752
0a920b5b
AW
1753sub process {
1754 my $filename = shift;
0a920b5b
AW
1755
1756 my $linenr=0;
1757 my $prevline="";
c2fdda0d 1758 my $prevrawline="";
0a920b5b 1759 my $stashline="";
c2fdda0d 1760 my $stashrawline="";
0a920b5b 1761
4a0df2ef 1762 my $length;
0a920b5b
AW
1763 my $indent;
1764 my $previndent=0;
1765 my $stashindent=0;
1766
de7d4f0e 1767 our $clean = 1;
0a920b5b
AW
1768 my $signoff = 0;
1769 my $is_patch = 0;
1770
29ee1b0c 1771 my $in_header_lines = $file ? 0 : 1;
15662b3e 1772 my $in_commit_log = 0; #Scanning lines before patch
13f1937e 1773 my $reported_maintainer_file = 0;
fa64205d
PS
1774 my $non_utf8_charset = 0;
1775
365dd4ea
JP
1776 my $last_blank_line = 0;
1777
13214adf 1778 our @report = ();
6c72ffaa
AW
1779 our $cnt_lines = 0;
1780 our $cnt_error = 0;
1781 our $cnt_warn = 0;
1782 our $cnt_chk = 0;
1783
0a920b5b
AW
1784 # Trace the real file/line as we go.
1785 my $realfile = '';
1786 my $realline = 0;
1787 my $realcnt = 0;
1788 my $here = '';
1789 my $in_comment = 0;
c2fdda0d 1790 my $comment_edge = 0;
0a920b5b 1791 my $first_line = 0;
1e855726 1792 my $p1_prefix = '';
0a920b5b 1793
13214adf
AW
1794 my $prev_values = 'E';
1795
1796 # suppression flags
773647a0 1797 my %suppress_ifbraces;
170d3a22 1798 my %suppress_whiletrailers;
2b474a1a 1799 my %suppress_export;
3e469cdc 1800 my $suppress_statement = 0;
653d4876 1801
7e51f197 1802 my %signatures = ();
323c1260 1803
c2fdda0d 1804 # Pre-scan the patch sanitizing the lines.
de7d4f0e 1805 # Pre-scan the patch looking for any __setup documentation.
c2fdda0d 1806 #
de7d4f0e
AW
1807 my @setup_docs = ();
1808 my $setup_docs = 0;
773647a0 1809
d8b07710
JP
1810 my $camelcase_file_seeded = 0;
1811
773647a0 1812 sanitise_line_reset();
c2fdda0d
AW
1813 my $line;
1814 foreach my $rawline (@rawlines) {
773647a0
AW
1815 $linenr++;
1816 $line = $rawline;
c2fdda0d 1817
3705ce5b
JP
1818 push(@fixed, $rawline) if ($fix);
1819
773647a0 1820 if ($rawline=~/^\+\+\+\s+(\S+)/) {
de7d4f0e
AW
1821 $setup_docs = 0;
1822 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1823 $setup_docs = 1;
1824 }
773647a0
AW
1825 #next;
1826 }
1827 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1828 $realline=$1-1;
1829 if (defined $2) {
1830 $realcnt=$3+1;
1831 } else {
1832 $realcnt=1+1;
1833 }
c45dcabd 1834 $in_comment = 0;
773647a0
AW
1835
1836 # Guestimate if this is a continuing comment. Run
1837 # the context looking for a comment "edge". If this
1838 # edge is a close comment then we must be in a comment
1839 # at context start.
1840 my $edge;
01fa9147
AW
1841 my $cnt = $realcnt;
1842 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1843 next if (defined $rawlines[$ln - 1] &&
1844 $rawlines[$ln - 1] =~ /^-/);
1845 $cnt--;
1846 #print "RAW<$rawlines[$ln - 1]>\n";
721c1cb6 1847 last if (!defined $rawlines[$ln - 1]);
fae17dae
AW
1848 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1849 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1850 ($edge) = $1;
1851 last;
1852 }
773647a0
AW
1853 }
1854 if (defined $edge && $edge eq '*/') {
1855 $in_comment = 1;
1856 }
1857
1858 # Guestimate if this is a continuing comment. If this
1859 # is the start of a diff block and this line starts
1860 # ' *' then it is very likely a comment.
1861 if (!defined $edge &&
83242e0c 1862 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
773647a0
AW
1863 {
1864 $in_comment = 1;
1865 }
1866
1867 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1868 sanitise_line_reset($in_comment);
1869
171ae1a4 1870 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
773647a0 1871 # Standardise the strings and chars within the input to
171ae1a4 1872 # simplify matching -- only bother with positive lines.
773647a0 1873 $line = sanitise_line($rawline);
de7d4f0e 1874 }
773647a0
AW
1875 push(@lines, $line);
1876
1877 if ($realcnt > 1) {
1878 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1879 } else {
1880 $realcnt = 0;
1881 }
1882
1883 #print "==>$rawline\n";
1884 #print "-->$line\n";
de7d4f0e
AW
1885
1886 if ($setup_docs && $line =~ /^\+/) {
1887 push(@setup_docs, $line);
1888 }
1889 }
1890
6c72ffaa
AW
1891 $prefix = '';
1892
773647a0
AW
1893 $realcnt = 0;
1894 $linenr = 0;
194f66fc 1895 $fixlinenr = -1;
0a920b5b
AW
1896 foreach my $line (@lines) {
1897 $linenr++;
194f66fc 1898 $fixlinenr++;
1b5539b1
JP
1899 my $sline = $line; #copy of $line
1900 $sline =~ s/$;/ /g; #with comments as spaces
0a920b5b 1901
c2fdda0d 1902 my $rawline = $rawlines[$linenr - 1];
6c72ffaa 1903
0a920b5b 1904#extract the line range in the file after the patch is applied
6c72ffaa 1905 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
0a920b5b 1906 $is_patch = 1;
4a0df2ef 1907 $first_line = $linenr + 1;
0a920b5b
AW
1908 $realline=$1-1;
1909 if (defined $2) {
1910 $realcnt=$3+1;
1911 } else {
1912 $realcnt=1+1;
1913 }
c2fdda0d 1914 annotate_reset();
13214adf
AW
1915 $prev_values = 'E';
1916
773647a0 1917 %suppress_ifbraces = ();
170d3a22 1918 %suppress_whiletrailers = ();
2b474a1a 1919 %suppress_export = ();
3e469cdc 1920 $suppress_statement = 0;
0a920b5b 1921 next;
0a920b5b 1922
4a0df2ef
AW
1923# track the line number as we move through the hunk, note that
1924# new versions of GNU diff omit the leading space on completely
1925# blank context lines so we need to count that too.
773647a0 1926 } elsif ($line =~ /^( |\+|$)/) {
0a920b5b 1927 $realline++;
d8aaf121 1928 $realcnt-- if ($realcnt != 0);
0a920b5b 1929
4a0df2ef 1930 # Measure the line length and indent.
c2fdda0d 1931 ($length, $indent) = line_stats($rawline);
0a920b5b
AW
1932
1933 # Track the previous line.
1934 ($prevline, $stashline) = ($stashline, $line);
1935 ($previndent, $stashindent) = ($stashindent, $indent);
c2fdda0d
AW
1936 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1937
773647a0 1938 #warn "line<$line>\n";
6c72ffaa 1939
d8aaf121
AW
1940 } elsif ($realcnt == 1) {
1941 $realcnt--;
0a920b5b
AW
1942 }
1943
cc77cdca
AW
1944 my $hunk_line = ($realcnt != 0);
1945
0a920b5b 1946#make up the handle for any error we report on this line
773647a0
AW
1947 $prefix = "$filename:$realline: " if ($emacs && $file);
1948 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1949
6c72ffaa
AW
1950 $here = "#$linenr: " if (!$file);
1951 $here = "#$realline: " if ($file);
773647a0 1952
2ac73b4f 1953 my $found_file = 0;
773647a0 1954 # extract the filename as it passes
3bf9a009
RV
1955 if ($line =~ /^diff --git.*?(\S+)$/) {
1956 $realfile = $1;
2b7ab453 1957 $realfile =~ s@^([^/]*)/@@ if (!$file);
270c49a0 1958 $in_commit_log = 0;
2ac73b4f 1959 $found_file = 1;
3bf9a009 1960 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
773647a0 1961 $realfile = $1;
2b7ab453 1962 $realfile =~ s@^([^/]*)/@@ if (!$file);
270c49a0 1963 $in_commit_log = 0;
1e855726
WS
1964
1965 $p1_prefix = $1;
e2f7aa4b
AW
1966 if (!$file && $tree && $p1_prefix ne '' &&
1967 -e "$root/$p1_prefix") {
000d1cc1
JP
1968 WARN("PATCH_PREFIX",
1969 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1e855726 1970 }
773647a0 1971
c1ab3326 1972 if ($realfile =~ m@^include/asm/@) {
000d1cc1
JP
1973 ERROR("MODIFIED_INCLUDE_ASM",
1974 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
773647a0 1975 }
2ac73b4f
JP
1976 $found_file = 1;
1977 }
1978
1979 if ($found_file) {
1980 if ($realfile =~ m@^(drivers/net/|net/)@) {
1981 $check = 1;
1982 } else {
1983 $check = $check_orig;
1984 }
773647a0
AW
1985 next;
1986 }
1987
389834b6 1988 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
0a920b5b 1989
c2fdda0d
AW
1990 my $hereline = "$here\n$rawline\n";
1991 my $herecurr = "$here\n$rawline\n";
1992 my $hereprev = "$here\n$prevrawline\n$rawline\n";
0a920b5b 1993
6c72ffaa
AW
1994 $cnt_lines++ if ($realcnt != 0);
1995
3bf9a009
RV
1996# Check for incorrect file permissions
1997 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1998 my $permhere = $here . "FILE: $realfile\n";
04db4d25
JP
1999 if ($realfile !~ m@scripts/@ &&
2000 $realfile !~ /\.(py|pl|awk|sh)$/) {
000d1cc1
JP
2001 ERROR("EXECUTE_PERMISSIONS",
2002 "do not set execute permissions for source files\n" . $permhere);
3bf9a009
RV
2003 }
2004 }
2005
20112475 2006# Check the patch for a signoff:
d8aaf121 2007 if ($line =~ /^\s*signed-off-by:/i) {
4a0df2ef 2008 $signoff++;
15662b3e 2009 $in_commit_log = 0;
20112475
JP
2010 }
2011
2012# Check signature styles
270c49a0 2013 if (!$in_header_lines &&
ce0338df 2014 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
20112475
JP
2015 my $space_before = $1;
2016 my $sign_off = $2;
2017 my $space_after = $3;
2018 my $email = $4;
2019 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2020
ce0338df
JP
2021 if ($sign_off !~ /$signature_tags/) {
2022 WARN("BAD_SIGN_OFF",
2023 "Non-standard signature: $sign_off\n" . $herecurr);
2024 }
20112475 2025 if (defined $space_before && $space_before ne "") {
3705ce5b
JP
2026 if (WARN("BAD_SIGN_OFF",
2027 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2028 $fix) {
194f66fc 2029 $fixed[$fixlinenr] =
3705ce5b
JP
2030 "$ucfirst_sign_off $email";
2031 }
20112475
JP
2032 }
2033 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
3705ce5b
JP
2034 if (WARN("BAD_SIGN_OFF",
2035 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2036 $fix) {
194f66fc 2037 $fixed[$fixlinenr] =
3705ce5b
JP
2038 "$ucfirst_sign_off $email";
2039 }
2040
20112475
JP
2041 }
2042 if (!defined $space_after || $space_after ne " ") {
3705ce5b
JP
2043 if (WARN("BAD_SIGN_OFF",
2044 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2045 $fix) {
194f66fc 2046 $fixed[$fixlinenr] =
3705ce5b
JP
2047 "$ucfirst_sign_off $email";
2048 }
0a920b5b 2049 }
20112475
JP
2050
2051 my ($email_name, $email_address, $comment) = parse_email($email);
2052 my $suggested_email = format_email(($email_name, $email_address));
2053 if ($suggested_email eq "") {
000d1cc1
JP
2054 ERROR("BAD_SIGN_OFF",
2055 "Unrecognized email address: '$email'\n" . $herecurr);
20112475
JP
2056 } else {
2057 my $dequoted = $suggested_email;
2058 $dequoted =~ s/^"//;
2059 $dequoted =~ s/" </ </;
2060 # Don't force email to have quotes
2061 # Allow just an angle bracketed address
2062 if ("$dequoted$comment" ne $email &&
2063 "<$email_address>$comment" ne $email &&
2064 "$suggested_email$comment" ne $email) {
000d1cc1
JP
2065 WARN("BAD_SIGN_OFF",
2066 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
20112475 2067 }
0a920b5b 2068 }
7e51f197
JP
2069
2070# Check for duplicate signatures
2071 my $sig_nospace = $line;
2072 $sig_nospace =~ s/\s//g;
2073 $sig_nospace = lc($sig_nospace);
2074 if (defined $signatures{$sig_nospace}) {
2075 WARN("BAD_SIGN_OFF",
2076 "Duplicate signature\n" . $herecurr);
2077 } else {
2078 $signatures{$sig_nospace} = 1;
2079 }
0a920b5b
AW
2080 }
2081
9b3189eb
JP
2082# Check for old stable address
2083 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2084 ERROR("STABLE_ADDRESS",
2085 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2086 }
2087
7ebd05ef
CC
2088# Check for unwanted Gerrit info
2089 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2090 ERROR("GERRIT_CHANGE_ID",
2091 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2092 }
2093
d311cd44
JP
2094# Check for improperly formed commit descriptions
2095 if ($in_commit_log &&
2096 $line =~ /\bcommit\s+[0-9a-f]{5,}/i &&
2097 $line !~ /\b[Cc]ommit [0-9a-f]{12,16} \("/) {
2098 $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i;
2099 my $init_char = $1;
2100 my $orig_commit = lc($2);
2101 my $id = '01234567890ab';
2102 my $desc = 'commit description';
2103 ($id, $desc) = git_commit_info($orig_commit, $id, $desc);
2104 ERROR("GIT_COMMIT_ID",
2105 "Please use 12 to 16 chars for the git commit ID like: '${init_char}ommit $id (\"$desc\")'\n" . $herecurr);
2106 }
2107
13f1937e
JP
2108# Check for added, moved or deleted files
2109 if (!$reported_maintainer_file && !$in_commit_log &&
2110 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2111 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2112 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2113 (defined($1) || defined($2))))) {
2114 $reported_maintainer_file = 1;
2115 WARN("FILE_PATH_CHANGES",
2116 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2117 }
2118
00df344f 2119# Check for wrappage within a valid hunk of the file
8905a67c 2120 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
000d1cc1
JP
2121 ERROR("CORRUPTED_PATCH",
2122 "patch seems to be corrupt (line wrapped?)\n" .
6c72ffaa 2123 $herecurr) if (!$emitted_corrupt++);
de7d4f0e
AW
2124 }
2125
6ecd9674
AW
2126# Check for absolute kernel paths.
2127 if ($tree) {
2128 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2129 my $file = $1;
2130
2131 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2132 check_absolute_file($1, $herecurr)) {
2133 #
2134 } else {
2135 check_absolute_file($file, $herecurr);
2136 }
2137 }
2138 }
2139
de7d4f0e
AW
2140# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2141 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
171ae1a4
AW
2142 $rawline !~ m/^$UTF8*$/) {
2143 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2144
2145 my $blank = copy_spacing($rawline);
2146 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2147 my $hereptr = "$hereline$ptr\n";
2148
34d99219
JP
2149 CHK("INVALID_UTF8",
2150 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
00df344f
AW
2151 }
2152
15662b3e
JP
2153# Check if it's the start of a commit log
2154# (not a header line and we haven't seen the patch filename)
2155 if ($in_header_lines && $realfile =~ /^$/ &&
29ee1b0c
JP
2156 !($rawline =~ /^\s+\S/ ||
2157 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
15662b3e
JP
2158 $in_header_lines = 0;
2159 $in_commit_log = 1;
2160 }
2161
fa64205d
PS
2162# Check if there is UTF-8 in a commit log when a mail header has explicitly
2163# declined it, i.e defined some charset where it is missing.
2164 if ($in_header_lines &&
2165 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2166 $1 !~ /utf-8/i) {
2167 $non_utf8_charset = 1;
2168 }
2169
2170 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
15662b3e 2171 $rawline =~ /$NON_ASCII_UTF8/) {
fa64205d 2172 WARN("UTF8_BEFORE_PATCH",
15662b3e
JP
2173 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2174 }
2175
30670854
AW
2176# ignore non-hunk lines and lines being removed
2177 next if (!$hunk_line || $line =~ /^-/);
0a920b5b 2178
0a920b5b 2179#trailing whitespace
9c0ca6f9 2180 if ($line =~ /^\+.*\015/) {
c2fdda0d 2181 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
d5e616fc
JP
2182 if (ERROR("DOS_LINE_ENDINGS",
2183 "DOS line endings\n" . $herevet) &&
2184 $fix) {
194f66fc 2185 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
d5e616fc 2186 }
c2fdda0d
AW
2187 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2188 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3705ce5b
JP
2189 if (ERROR("TRAILING_WHITESPACE",
2190 "trailing whitespace\n" . $herevet) &&
2191 $fix) {
194f66fc 2192 $fixed[$fixlinenr] =~ s/\s+$//;
3705ce5b
JP
2193 }
2194
d2c0a235 2195 $rpt_cleaners = 1;
0a920b5b 2196 }
5368df20 2197
4783f894 2198# Check for FSF mailing addresses.
109d8cb2 2199 if ($rawline =~ /\bwrite to the Free/i ||
3e2232f2
JP
2200 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2201 $rawline =~ /\b51\s+Franklin\s+St/i) {
4783f894
JT
2202 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2203 my $msg_type = \&ERROR;
2204 $msg_type = \&CHK if ($file);
2205 &{$msg_type}("FSF_MAILING_ADDRESS",
3e2232f2 2206 "Do not include the paragraph about writing to the Free Software Foundation's mailing address from the sample GPL notice. The FSF has changed addresses in the past, and may do so again. Linux already includes a copy of the GPL.\n" . $herevet)
4783f894
JT
2207 }
2208
3354957a 2209# check for Kconfig help text having a real description
9fe287d7
AW
2210# Only applies when adding the entry originally, after that we do not have
2211# sufficient context to determine whether it is indeed long enough.
3354957a 2212 if ($realfile =~ /Kconfig/ &&
8d73e0e7 2213 $line =~ /^\+\s*config\s+/) {
3354957a 2214 my $length = 0;
9fe287d7
AW
2215 my $cnt = $realcnt;
2216 my $ln = $linenr + 1;
2217 my $f;
a1385803 2218 my $is_start = 0;
9fe287d7 2219 my $is_end = 0;
a1385803 2220 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
9fe287d7
AW
2221 $f = $lines[$ln - 1];
2222 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2223 $is_end = $lines[$ln - 1] =~ /^\+/;
9fe287d7
AW
2224
2225 next if ($f =~ /^-/);
8d73e0e7 2226 last if (!$file && $f =~ /^\@\@/);
a1385803 2227
8d73e0e7 2228 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
a1385803 2229 $is_start = 1;
8d73e0e7 2230 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
a1385803
AW
2231 $length = -1;
2232 }
2233
9fe287d7 2234 $f =~ s/^.//;
3354957a
AK
2235 $f =~ s/#.*//;
2236 $f =~ s/^\s+//;
2237 next if ($f =~ /^$/);
9fe287d7
AW
2238 if ($f =~ /^\s*config\s/) {
2239 $is_end = 1;
2240 last;
2241 }
3354957a
AK
2242 $length++;
2243 }
000d1cc1 2244 WARN("CONFIG_DESCRIPTION",
a1385803
AW
2245 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
2246 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
3354957a
AK
2247 }
2248
1ba8dfd1
KC
2249# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2250 if ($realfile =~ /Kconfig/ &&
2251 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2252 WARN("CONFIG_EXPERIMENTAL",
2253 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2254 }
2255
c68e5878
AL
2256 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2257 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2258 my $flag = $1;
2259 my $replacement = {
2260 'EXTRA_AFLAGS' => 'asflags-y',
2261 'EXTRA_CFLAGS' => 'ccflags-y',
2262 'EXTRA_CPPFLAGS' => 'cppflags-y',
2263 'EXTRA_LDFLAGS' => 'ldflags-y',
2264 };
2265
2266 WARN("DEPRECATED_VARIABLE",
2267 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2268 }
2269
bff5da43 2270# check for DT compatible documentation
7dd05b38
FV
2271 if (defined $root &&
2272 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2273 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2274
bff5da43
RH
2275 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2276
cc93319b
FV
2277 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2278 my $vp_file = $dt_path . "vendor-prefixes.txt";
2279
bff5da43
RH
2280 foreach my $compat (@compats) {
2281 my $compat2 = $compat;
185d566b
RH
2282 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2283 my $compat3 = $compat;
2284 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2285 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
bff5da43
RH
2286 if ( $? >> 8 ) {
2287 WARN("UNDOCUMENTED_DT_STRING",
2288 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2289 }
2290
4fbf32a6
FV
2291 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2292 my $vendor = $1;
cc93319b 2293 `grep -Eq "^$vendor\\b" $vp_file`;
bff5da43
RH
2294 if ( $? >> 8 ) {
2295 WARN("UNDOCUMENTED_DT_STRING",
cc93319b 2296 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
bff5da43
RH
2297 }
2298 }
2299 }
2300
5368df20
AW
2301# check we are in a valid source file if not then ignore this hunk
2302 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
2303
6cd7f386 2304#line length limit
c45dcabd 2305 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
f4c014c0 2306 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
0fccc622 2307 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
8bbea968 2308 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
6cd7f386 2309 $length > $max_line_length)
c45dcabd 2310 {
000d1cc1 2311 WARN("LONG_LINE",
6cd7f386 2312 "line over $max_line_length characters\n" . $herecurr);
0a920b5b
AW
2313 }
2314
ca56dc09 2315# Check for user-visible strings broken across lines, which breaks the ability
8c5fcd24
JP
2316# to grep for the string. Make exceptions when the previous string ends in a
2317# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2318# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
ca56dc09
JT
2319 if ($line =~ /^\+\s*"/ &&
2320 $prevline =~ /"\s*$/ &&
8c5fcd24 2321 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
ca56dc09
JT
2322 WARN("SPLIT_STRING",
2323 "quoted string split across lines\n" . $hereprev);
2324 }
2325
5e79d96e
JP
2326# check for spaces before a quoted newline
2327 if ($rawline =~ /^.*\".*\s\\n/) {
3705ce5b
JP
2328 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
2329 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
2330 $fix) {
194f66fc 2331 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
3705ce5b
JP
2332 }
2333
5e79d96e
JP
2334 }
2335
8905a67c
AW
2336# check for adding lines without a newline.
2337 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
000d1cc1
JP
2338 WARN("MISSING_EOF_NEWLINE",
2339 "adding a line without newline at end of file\n" . $herecurr);
8905a67c
AW
2340 }
2341
42e41c54
MF
2342# Blackfin: use hi/lo macros
2343 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2344 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2345 my $herevet = "$here\n" . cat_vet($line) . "\n";
000d1cc1
JP
2346 ERROR("LO_MACRO",
2347 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
42e41c54
MF
2348 }
2349 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2350 my $herevet = "$here\n" . cat_vet($line) . "\n";
000d1cc1
JP
2351 ERROR("HI_MACRO",
2352 "use the HI() macro, not (... >> 16)\n" . $herevet);
42e41c54
MF
2353 }
2354 }
2355
b9ea10d6
AW
2356# check we are in a valid source file C or perl if not then ignore this hunk
2357 next if ($realfile !~ /\.(h|c|pl)$/);
0a920b5b
AW
2358
2359# at the beginning of a line any tabs must come first and anything
2360# more than 8 must use tabs.
c2fdda0d
AW
2361 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2362 $rawline =~ /^\+\s* \s*/) {
2363 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
d2c0a235 2364 $rpt_cleaners = 1;
3705ce5b
JP
2365 if (ERROR("CODE_INDENT",
2366 "code indent should use tabs where possible\n" . $herevet) &&
2367 $fix) {
194f66fc 2368 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3705ce5b 2369 }
0a920b5b
AW
2370 }
2371
08e44365
AP
2372# check for space before tabs.
2373 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2374 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3705ce5b
JP
2375 if (WARN("SPACE_BEFORE_TAB",
2376 "please, no space before tabs\n" . $herevet) &&
2377 $fix) {
194f66fc 2378 while ($fixed[$fixlinenr] =~
c76f4cb3 2379 s/(^\+.*) {8,8}+\t/$1\t\t/) {}
194f66fc 2380 while ($fixed[$fixlinenr] =~
c76f4cb3 2381 s/(^\+.*) +\t/$1\t/) {}
3705ce5b 2382 }
08e44365
AP
2383 }
2384
d1fe9c09
JP
2385# check for && or || at the start of a line
2386 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2387 CHK("LOGICAL_CONTINUATIONS",
2388 "Logical continuations should be on the previous line\n" . $hereprev);
2389 }
2390
2391# check multi-line statement indentation matches previous line
2392 if ($^V && $^V ge 5.10.0 &&
91cb5195 2393 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
d1fe9c09
JP
2394 $prevline =~ /^\+(\t*)(.*)$/;
2395 my $oldindent = $1;
2396 my $rest = $2;
2397
2398 my $pos = pos_last_openparen($rest);
2399 if ($pos >= 0) {
b34a26f3
JP
2400 $line =~ /^(\+| )([ \t]*)/;
2401 my $newindent = $2;
d1fe9c09
JP
2402
2403 my $goodtabindent = $oldindent .
2404 "\t" x ($pos / 8) .
2405 " " x ($pos % 8);
2406 my $goodspaceindent = $oldindent . " " x $pos;
2407
2408 if ($newindent ne $goodtabindent &&
2409 $newindent ne $goodspaceindent) {
3705ce5b
JP
2410
2411 if (CHK("PARENTHESIS_ALIGNMENT",
2412 "Alignment should match open parenthesis\n" . $hereprev) &&
2413 $fix && $line =~ /^\+/) {
194f66fc 2414 $fixed[$fixlinenr] =~
3705ce5b
JP
2415 s/^\+[ \t]*/\+$goodtabindent/;
2416 }
d1fe9c09
JP
2417 }
2418 }
2419 }
2420
f27c95db 2421 if ($line =~ /^\+.*\(\s*$Type\s*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
3705ce5b 2422 if (CHK("SPACING",
f27c95db 2423 "No space is necessary after a cast\n" . $herecurr) &&
3705ce5b 2424 $fix) {
194f66fc 2425 $fixed[$fixlinenr] =~
f27c95db 2426 s/(\(\s*$Type\s*\))[ \t]+/$1/;
3705ce5b 2427 }
aad4f614
JP
2428 }
2429
05880600 2430 if ($realfile =~ m@^(drivers/net/|net/)@ &&
fdb4bcd6 2431 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
85ad978c
JP
2432 $rawline =~ /^\+[ \t]*\*/ &&
2433 $realline > 2) {
05880600
JP
2434 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2435 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2436 }
2437
2438 if ($realfile =~ m@^(drivers/net/|net/)@ &&
a605e32e
JP
2439 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2440 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
61135e96 2441 $rawline =~ /^\+/ && #line is new
a605e32e
JP
2442 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2443 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2444 "networking block comments start with * on subsequent lines\n" . $hereprev);
2445 }
2446
2447 if ($realfile =~ m@^(drivers/net/|net/)@ &&
c24f9f19
JP
2448 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2449 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2450 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2451 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
05880600
JP
2452 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2453 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2454 }
2455
7f619191
JP
2456# check for missing blank lines after struct/union declarations
2457# with exceptions for various attributes and macros
2458 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2459 $line =~ /^\+/ &&
2460 !($line =~ /^\+\s*$/ ||
2461 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2462 $line =~ /^\+\s*MODULE_/i ||
2463 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2464 $line =~ /^\+[a-z_]*init/ ||
2465 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2466 $line =~ /^\+\s*DECLARE/ ||
2467 $line =~ /^\+\s*__setup/)) {
d752fcc8
JP
2468 if (CHK("LINE_SPACING",
2469 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2470 $fix) {
f2d7e4d4 2471 fix_insert_line($fixlinenr, "\+");
d752fcc8 2472 }
7f619191
JP
2473 }
2474
365dd4ea
JP
2475# check for multiple consecutive blank lines
2476 if ($prevline =~ /^[\+ ]\s*$/ &&
2477 $line =~ /^\+\s*$/ &&
2478 $last_blank_line != ($linenr - 1)) {
d752fcc8
JP
2479 if (CHK("LINE_SPACING",
2480 "Please don't use multiple blank lines\n" . $hereprev) &&
2481 $fix) {
f2d7e4d4 2482 fix_delete_line($fixlinenr, $rawline);
d752fcc8
JP
2483 }
2484
365dd4ea
JP
2485 $last_blank_line = $linenr;
2486 }
2487
3b617e3b 2488# check for missing blank lines after declarations
3f7bac03
JP
2489 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2490 # actual declarations
2491 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
5a4e1fd3
JP
2492 # function pointer declarations
2493 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3f7bac03
JP
2494 # foo bar; where foo is some local typedef or #define
2495 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2496 # known declaration macros
2497 $prevline =~ /^\+\s+$declaration_macros/) &&
2498 # for "else if" which can look like "$Ident $Ident"
2499 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2500 # other possible extensions of declaration lines
2501 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2502 # not starting a section or a macro "\" extended line
2503 $prevline =~ /(?:\{\s*|\\)$/) &&
2504 # looks like a declaration
2505 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
5a4e1fd3
JP
2506 # function pointer declarations
2507 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3f7bac03
JP
2508 # foo bar; where foo is some local typedef or #define
2509 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2510 # known declaration macros
2511 $sline =~ /^\+\s+$declaration_macros/ ||
2512 # start of struct or union or enum
3b617e3b 2513 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
3f7bac03
JP
2514 # start or end of block or continuation of declaration
2515 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2516 # bitfield continuation
2517 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2518 # other possible extensions of declaration lines
2519 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2520 # indentation of previous and current line are the same
2521 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
d752fcc8
JP
2522 if (WARN("LINE_SPACING",
2523 "Missing a blank line after declarations\n" . $hereprev) &&
2524 $fix) {
f2d7e4d4 2525 fix_insert_line($fixlinenr, "\+");
d752fcc8 2526 }
3b617e3b
JP
2527 }
2528
5f7ddae6 2529# check for spaces at the beginning of a line.
6b4c5beb
AW
2530# Exceptions:
2531# 1) within comments
2532# 2) indented preprocessor commands
2533# 3) hanging labels
3705ce5b 2534 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
5f7ddae6 2535 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3705ce5b
JP
2536 if (WARN("LEADING_SPACE",
2537 "please, no spaces at the start of a line\n" . $herevet) &&
2538 $fix) {
194f66fc 2539 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3705ce5b 2540 }
5f7ddae6
RR
2541 }
2542
b9ea10d6
AW
2543# check we are in a valid C source file if not then ignore this hunk
2544 next if ($realfile !~ /\.(h|c)$/);
2545
032a4c0f
JP
2546# check indentation of any line with a bare else
2547# if the previous line is a break or return and is indented 1 tab more...
2548 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2549 my $tabs = length($1) + 1;
2550 if ($prevline =~ /^\+\t{$tabs,$tabs}(?:break|return)\b/) {
2551 WARN("UNNECESSARY_ELSE",
2552 "else is not generally useful after a break or return\n" . $hereprev);
2553 }
2554 }
2555
c00df19a
JP
2556# check indentation of a line with a break;
2557# if the previous line is a goto or return and is indented the same # of tabs
2558 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
2559 my $tabs = $1;
2560 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
2561 WARN("UNNECESSARY_BREAK",
2562 "break is not useful after a goto or return\n" . $hereprev);
2563 }
2564 }
2565
1ba8dfd1
KC
2566# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2567 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2568 WARN("CONFIG_EXPERIMENTAL",
2569 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2570 }
2571
c2fdda0d 2572# check for RCS/CVS revision markers
cf655043 2573 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
000d1cc1
JP
2574 WARN("CVS_KEYWORD",
2575 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
c2fdda0d 2576 }
22f2a2ef 2577
42e41c54
MF
2578# Blackfin: don't use __builtin_bfin_[cs]sync
2579 if ($line =~ /__builtin_bfin_csync/) {
2580 my $herevet = "$here\n" . cat_vet($line) . "\n";
000d1cc1
JP
2581 ERROR("CSYNC",
2582 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
42e41c54
MF
2583 }
2584 if ($line =~ /__builtin_bfin_ssync/) {
2585 my $herevet = "$here\n" . cat_vet($line) . "\n";
000d1cc1
JP
2586 ERROR("SSYNC",
2587 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
42e41c54
MF
2588 }
2589
56e77d70
JP
2590# check for old HOTPLUG __dev<foo> section markings
2591 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2592 WARN("HOTPLUG_SECTION",
2593 "Using $1 is unnecessary\n" . $herecurr);
2594 }
2595
9c0ca6f9 2596# Check for potential 'bare' types
2b474a1a
AW
2597 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2598 $realline_next);
3e469cdc
AW
2599#print "LINE<$line>\n";
2600 if ($linenr >= $suppress_statement &&
1b5539b1 2601 $realcnt && $sline =~ /.\s*\S/) {
170d3a22 2602 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
f5fe35dd 2603 ctx_statement_block($linenr, $realcnt, 0);
171ae1a4
AW
2604 $stat =~ s/\n./\n /g;
2605 $cond =~ s/\n./\n /g;
2606
3e469cdc
AW
2607#print "linenr<$linenr> <$stat>\n";
2608 # If this statement has no statement boundaries within
2609 # it there is no point in retrying a statement scan
2610 # until we hit end of it.
2611 my $frag = $stat; $frag =~ s/;+\s*$//;
2612 if ($frag !~ /(?:{|;)/) {
2613#print "skip<$line_nr_next>\n";
2614 $suppress_statement = $line_nr_next;
2615 }
f74bd194 2616
2b474a1a
AW
2617 # Find the real next line.
2618 $realline_next = $line_nr_next;
2619 if (defined $realline_next &&
2620 (!defined $lines[$realline_next - 1] ||
2621 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2622 $realline_next++;
2623 }
2624
171ae1a4
AW
2625 my $s = $stat;
2626 $s =~ s/{.*$//s;
cf655043 2627
c2fdda0d 2628 # Ignore goto labels.
171ae1a4 2629 if ($s =~ /$Ident:\*$/s) {
c2fdda0d
AW
2630
2631 # Ignore functions being called
171ae1a4 2632 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
c2fdda0d 2633
463f2864
AW
2634 } elsif ($s =~ /^.\s*else\b/s) {
2635
c45dcabd 2636 # declarations always start with types
d2506586 2637 } 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) {
c45dcabd
AW
2638 my $type = $1;
2639 $type =~ s/\s+/ /g;
2640 possible($type, "A:" . $s);
2641
8905a67c 2642 # definitions in global scope can only start with types
a6a84062 2643 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
c45dcabd 2644 possible($1, "B:" . $s);
c2fdda0d 2645 }
8905a67c
AW
2646
2647 # any (foo ... *) is a pointer cast, and foo is a type
65863862 2648 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
c45dcabd 2649 possible($1, "C:" . $s);
8905a67c
AW
2650 }
2651
2652 # Check for any sort of function declaration.
2653 # int foo(something bar, other baz);
2654 # void (*store_gdt)(x86_descr_ptr *);
171ae1a4 2655 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
8905a67c 2656 my ($name_len) = length($1);
8905a67c 2657
cf655043 2658 my $ctx = $s;
773647a0 2659 substr($ctx, 0, $name_len + 1, '');
8905a67c 2660 $ctx =~ s/\)[^\)]*$//;
cf655043 2661
8905a67c 2662 for my $arg (split(/\s*,\s*/, $ctx)) {
c45dcabd 2663 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
8905a67c 2664
c45dcabd 2665 possible($1, "D:" . $s);
8905a67c
AW
2666 }
2667 }
9c0ca6f9 2668 }
8905a67c 2669
9c0ca6f9
AW
2670 }
2671
653d4876
AW
2672#
2673# Checks which may be anchored in the context.
2674#
00df344f 2675
653d4876
AW
2676# Check for switch () and associated case and default
2677# statements should be at the same indent.
00df344f
AW
2678 if ($line=~/\bswitch\s*\(.*\)/) {
2679 my $err = '';
2680 my $sep = '';
2681 my @ctx = ctx_block_outer($linenr, $realcnt);
2682 shift(@ctx);
2683 for my $ctx (@ctx) {
2684 my ($clen, $cindent) = line_stats($ctx);
2685 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2686 $indent != $cindent) {
2687 $err .= "$sep$ctx\n";
2688 $sep = '';
2689 } else {
2690 $sep = "[...]\n";
2691 }
2692 }
2693 if ($err ne '') {
000d1cc1
JP
2694 ERROR("SWITCH_CASE_INDENT_LEVEL",
2695 "switch and case should be at the same indent\n$hereline$err");
de7d4f0e
AW
2696 }
2697 }
2698
2699# if/while/etc brace do not go on next line, unless defining a do while loop,
2700# or if that brace on the next line is for something else
c45dcabd 2701 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
773647a0
AW
2702 my $pre_ctx = "$1$2";
2703
9c0ca6f9 2704 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
8eef05dd
JP
2705
2706 if ($line =~ /^\+\t{6,}/) {
2707 WARN("DEEP_INDENTATION",
2708 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2709 }
2710
de7d4f0e
AW
2711 my $ctx_cnt = $realcnt - $#ctx - 1;
2712 my $ctx = join("\n", @ctx);
2713
548596d5
AW
2714 my $ctx_ln = $linenr;
2715 my $ctx_skip = $realcnt;
773647a0 2716
548596d5
AW
2717 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2718 defined $lines[$ctx_ln - 1] &&
2719 $lines[$ctx_ln - 1] =~ /^-/)) {
2720 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2721 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
de7d4f0e 2722 $ctx_ln++;
de7d4f0e 2723 }
548596d5 2724
53210168
AW
2725 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2726 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
de7d4f0e 2727
d752fcc8 2728 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
000d1cc1
JP
2729 ERROR("OPEN_BRACE",
2730 "that open brace { should be on the previous line\n" .
01464f30 2731 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
00df344f 2732 }
773647a0
AW
2733 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2734 $ctx =~ /\)\s*\;\s*$/ &&
2735 defined $lines[$ctx_ln - 1])
2736 {
9c0ca6f9
AW
2737 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2738 if ($nindent > $indent) {
000d1cc1
JP
2739 WARN("TRAILING_SEMICOLON",
2740 "trailing semicolon indicates no statements, indent implies otherwise\n" .
01464f30 2741 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
9c0ca6f9
AW
2742 }
2743 }
00df344f
AW
2744 }
2745
4d001e4d
AW
2746# Check relative indent for conditionals and blocks.
2747 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3e469cdc
AW
2748 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2749 ctx_statement_block($linenr, $realcnt, 0)
2750 if (!defined $stat);
4d001e4d
AW
2751 my ($s, $c) = ($stat, $cond);
2752
2753 substr($s, 0, length($c), '');
2754
2755 # Make sure we remove the line prefixes as we have
2756 # none on the first line, and are going to readd them
2757 # where necessary.
2758 $s =~ s/\n./\n/gs;
2759
2760 # Find out how long the conditional actually is.
6f779c18
AW
2761 my @newlines = ($c =~ /\n/gs);
2762 my $cond_lines = 1 + $#newlines;
4d001e4d
AW
2763
2764 # We want to check the first line inside the block
2765 # starting at the end of the conditional, so remove:
2766 # 1) any blank line termination
2767 # 2) any opening brace { on end of the line
2768 # 3) any do (...) {
2769 my $continuation = 0;
2770 my $check = 0;
2771 $s =~ s/^.*\bdo\b//;
2772 $s =~ s/^\s*{//;
2773 if ($s =~ s/^\s*\\//) {
2774 $continuation = 1;
2775 }
9bd49efe 2776 if ($s =~ s/^\s*?\n//) {
4d001e4d
AW
2777 $check = 1;
2778 $cond_lines++;
2779 }
2780
2781 # Also ignore a loop construct at the end of a
2782 # preprocessor statement.
2783 if (($prevline =~ /^.\s*#\s*define\s/ ||
2784 $prevline =~ /\\\s*$/) && $continuation == 0) {
2785 $check = 0;
2786 }
2787
9bd49efe 2788 my $cond_ptr = -1;
740504c6 2789 $continuation = 0;
9bd49efe
AW
2790 while ($cond_ptr != $cond_lines) {
2791 $cond_ptr = $cond_lines;
2792
f16fa28f
AW
2793 # If we see an #else/#elif then the code
2794 # is not linear.
2795 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2796 $check = 0;
2797 }
2798
9bd49efe
AW
2799 # Ignore:
2800 # 1) blank lines, they should be at 0,
2801 # 2) preprocessor lines, and
2802 # 3) labels.
740504c6
AW
2803 if ($continuation ||
2804 $s =~ /^\s*?\n/ ||
9bd49efe
AW
2805 $s =~ /^\s*#\s*?/ ||
2806 $s =~ /^\s*$Ident\s*:/) {
740504c6 2807 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
30dad6eb
AW
2808 if ($s =~ s/^.*?\n//) {
2809 $cond_lines++;
2810 }
9bd49efe 2811 }
4d001e4d
AW
2812 }
2813
2814 my (undef, $sindent) = line_stats("+" . $s);
2815 my $stat_real = raw_line($linenr, $cond_lines);
2816
2817 # Check if either of these lines are modified, else
2818 # this is not this patch's fault.
2819 if (!defined($stat_real) ||
2820 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2821 $check = 0;
2822 }
2823 if (defined($stat_real) && $cond_lines > 1) {
2824 $stat_real = "[...]\n$stat_real";
2825 }
2826
9bd49efe 2827 #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";
4d001e4d
AW
2828
2829 if ($check && (($sindent % 8) != 0 ||
2830 ($sindent <= $indent && $s ne ''))) {
000d1cc1
JP
2831 WARN("SUSPECT_CODE_INDENT",
2832 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
4d001e4d
AW
2833 }
2834 }
2835
6c72ffaa
AW
2836 # Track the 'values' across context and added lines.
2837 my $opline = $line; $opline =~ s/^./ /;
1f65f947
AW
2838 my ($curr_values, $curr_vars) =
2839 annotate_values($opline . "\n", $prev_values);
6c72ffaa 2840 $curr_values = $prev_values . $curr_values;
c2fdda0d
AW
2841 if ($dbg_values) {
2842 my $outline = $opline; $outline =~ s/\t/ /g;
cf655043
AW
2843 print "$linenr > .$outline\n";
2844 print "$linenr > $curr_values\n";
1f65f947 2845 print "$linenr > $curr_vars\n";
c2fdda0d 2846 }
6c72ffaa
AW
2847 $prev_values = substr($curr_values, -1);
2848
00df344f 2849#ignore lines not being added
3705ce5b 2850 next if ($line =~ /^[^\+]/);
00df344f 2851
653d4876 2852# TEST: allow direct testing of the type matcher.
7429c690
AW
2853 if ($dbg_type) {
2854 if ($line =~ /^.\s*$Declare\s*$/) {
000d1cc1
JP
2855 ERROR("TEST_TYPE",
2856 "TEST: is type\n" . $herecurr);
7429c690 2857 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
000d1cc1
JP
2858 ERROR("TEST_NOT_TYPE",
2859 "TEST: is not type ($1 is)\n". $herecurr);
7429c690 2860 }
653d4876
AW
2861 next;
2862 }
a1ef277e
AW
2863# TEST: allow direct testing of the attribute matcher.
2864 if ($dbg_attr) {
9360b0e5 2865 if ($line =~ /^.\s*$Modifier\s*$/) {
000d1cc1
JP
2866 ERROR("TEST_ATTR",
2867 "TEST: is attr\n" . $herecurr);
9360b0e5 2868 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
000d1cc1
JP
2869 ERROR("TEST_NOT_ATTR",
2870 "TEST: is not attr ($1 is)\n". $herecurr);
a1ef277e
AW
2871 }
2872 next;
2873 }
653d4876 2874
f0a594c1 2875# check for initialisation to aggregates open brace on the next line
99423c20
AW
2876 if ($line =~ /^.\s*{/ &&
2877 $prevline =~ /(?:^|[^=])=\s*$/) {
d752fcc8
JP
2878 if (ERROR("OPEN_BRACE",
2879 "that open brace { should be on the previous line\n" . $hereprev) &&
f2d7e4d4
JP
2880 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
2881 fix_delete_line($fixlinenr - 1, $prevrawline);
2882 fix_delete_line($fixlinenr, $rawline);
d752fcc8
JP
2883 my $fixedline = $prevrawline;
2884 $fixedline =~ s/\s*=\s*$/ = {/;
f2d7e4d4 2885 fix_insert_line($fixlinenr, $fixedline);
d752fcc8
JP
2886 $fixedline = $line;
2887 $fixedline =~ s/^(.\s*){\s*/$1/;
f2d7e4d4 2888 fix_insert_line($fixlinenr, $fixedline);
d752fcc8 2889 }
f0a594c1
AW
2890 }
2891
653d4876
AW
2892#
2893# Checks which are anchored on the added line.
2894#
2895
2896# check for malformed paths in #include statements (uses RAW line)
c45dcabd 2897 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
653d4876
AW
2898 my $path = $1;
2899 if ($path =~ m{//}) {
000d1cc1 2900 ERROR("MALFORMED_INCLUDE",
495e9d84
JP
2901 "malformed #include filename\n" . $herecurr);
2902 }
2903 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2904 ERROR("UAPI_INCLUDE",
2905 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
653d4876 2906 }
653d4876 2907 }
00df344f 2908
0a920b5b 2909# no C99 // comments
00df344f 2910 if ($line =~ m{//}) {
3705ce5b
JP
2911 if (ERROR("C99_COMMENTS",
2912 "do not use C99 // comments\n" . $herecurr) &&
2913 $fix) {
194f66fc 2914 my $line = $fixed[$fixlinenr];
3705ce5b
JP
2915 if ($line =~ /\/\/(.*)$/) {
2916 my $comment = trim($1);
194f66fc 2917 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3705ce5b
JP
2918 }
2919 }
0a920b5b 2920 }
00df344f 2921 # Remove C99 comments.
0a920b5b 2922 $line =~ s@//.*@@;
6c72ffaa 2923 $opline =~ s@//.*@@;
0a920b5b 2924
2b474a1a
AW
2925# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2926# the whole statement.
2927#print "APW <$lines[$realline_next - 1]>\n";
2928 if (defined $realline_next &&
2929 exists $lines[$realline_next - 1] &&
2930 !defined $suppress_export{$realline_next} &&
2931 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2932 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3cbf62df
AW
2933 # Handle definitions which produce identifiers with
2934 # a prefix:
2935 # XXX(foo);
2936 # EXPORT_SYMBOL(something_foo);
653d4876 2937 my $name = $1;
87a53877 2938 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3cbf62df
AW
2939 $name =~ /^${Ident}_$2/) {
2940#print "FOO C name<$name>\n";
2941 $suppress_export{$realline_next} = 1;
2942
2943 } elsif ($stat !~ /(?:
2b474a1a 2944 \n.}\s*$|
48012058
AW
2945 ^.DEFINE_$Ident\(\Q$name\E\)|
2946 ^.DECLARE_$Ident\(\Q$name\E\)|
2947 ^.LIST_HEAD\(\Q$name\E\)|
2b474a1a
AW
2948 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2949 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
48012058 2950 )/x) {
2b474a1a
AW
2951#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2952 $suppress_export{$realline_next} = 2;
2953 } else {
2954 $suppress_export{$realline_next} = 1;
0a920b5b
AW
2955 }
2956 }
2b474a1a
AW
2957 if (!defined $suppress_export{$linenr} &&
2958 $prevline =~ /^.\s*$/ &&
2959 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2960 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2961#print "FOO B <$lines[$linenr - 1]>\n";
2962 $suppress_export{$linenr} = 2;
2963 }
2964 if (defined $suppress_export{$linenr} &&
2965 $suppress_export{$linenr} == 2) {
000d1cc1
JP
2966 WARN("EXPORT_SYMBOL",
2967 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2b474a1a 2968 }
0a920b5b 2969
5150bda4 2970# check for global initialisers.
d5e616fc
JP
2971 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
2972 if (ERROR("GLOBAL_INITIALISERS",
2973 "do not initialise globals to 0 or NULL\n" .
2974 $herecurr) &&
2975 $fix) {
194f66fc 2976 $fixed[$fixlinenr] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
d5e616fc 2977 }
f0a594c1 2978 }
653d4876 2979# check for static initialisers.
d5e616fc
JP
2980 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2981 if (ERROR("INITIALISED_STATIC",
2982 "do not initialise statics to 0 or NULL\n" .
2983 $herecurr) &&
2984 $fix) {
194f66fc 2985 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
d5e616fc 2986 }
0a920b5b
AW
2987 }
2988
cb710eca
JP
2989# check for static const char * arrays.
2990 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
000d1cc1
JP
2991 WARN("STATIC_CONST_CHAR_ARRAY",
2992 "static const char * array should probably be static const char * const\n" .
cb710eca
JP
2993 $herecurr);
2994 }
2995
2996# check for static char foo[] = "bar" declarations.
2997 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
000d1cc1
JP
2998 WARN("STATIC_CONST_CHAR_ARRAY",
2999 "static char array declaration should probably be static const char\n" .
cb710eca
JP
3000 $herecurr);
3001 }
3002
9b0fa60d
JP
3003# check for non-global char *foo[] = {"bar", ...} declarations.
3004 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3005 WARN("STATIC_CONST_CHAR_ARRAY",
3006 "char * array declaration might be better as static const\n" .
3007 $herecurr);
3008 }
3009
b36190c5
JP
3010# check for function declarations without arguments like "int foo()"
3011 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3012 if (ERROR("FUNCTION_WITHOUT_ARGS",
3013 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3014 $fix) {
194f66fc 3015 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
b36190c5
JP
3016 }
3017 }
3018
92e112fd
JP
3019# check for uses of DEFINE_PCI_DEVICE_TABLE
3020 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3021 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3022 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3023 $fix) {
194f66fc 3024 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
92e112fd 3025 }
93ed0e2d
JP
3026 }
3027
653d4876
AW
3028# check for new typedefs, only function parameters and sparse annotations
3029# make sense.
3030 if ($line =~ /\btypedef\s/ &&
8054576d 3031 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
c45dcabd 3032 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
8ed22cad 3033 $line !~ /\b$typeTypedefs\b/ &&
653d4876 3034 $line !~ /\b__bitwise(?:__|)\b/) {
000d1cc1
JP
3035 WARN("NEW_TYPEDEFS",
3036 "do not add new typedefs\n" . $herecurr);
0a920b5b
AW
3037 }
3038
3039# * goes on variable not on type
65863862 3040 # (char*[ const])
bfcb2cc7
AW
3041 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3042 #print "AA<$1>\n";
3705ce5b 3043 my ($ident, $from, $to) = ($1, $2, $2);
65863862
AW
3044
3045 # Should start with a space.
3046 $to =~ s/^(\S)/ $1/;
3047 # Should not end with a space.
3048 $to =~ s/\s+$//;
3049 # '*'s should not have spaces between.
f9a0b3d1 3050 while ($to =~ s/\*\s+\*/\*\*/) {
65863862 3051 }
d8aaf121 3052
3705ce5b 3053## print "1: from<$from> to<$to> ident<$ident>\n";
65863862 3054 if ($from ne $to) {
3705ce5b
JP
3055 if (ERROR("POINTER_LOCATION",
3056 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3057 $fix) {
3058 my $sub_from = $ident;
3059 my $sub_to = $ident;
3060 $sub_to =~ s/\Q$from\E/$to/;
194f66fc 3061 $fixed[$fixlinenr] =~
3705ce5b
JP
3062 s@\Q$sub_from\E@$sub_to@;
3063 }
65863862 3064 }
bfcb2cc7
AW
3065 }
3066 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3067 #print "BB<$1>\n";
3705ce5b 3068 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
65863862
AW
3069
3070 # Should start with a space.
3071 $to =~ s/^(\S)/ $1/;
3072 # Should not end with a space.
3073 $to =~ s/\s+$//;
3074 # '*'s should not have spaces between.
f9a0b3d1 3075 while ($to =~ s/\*\s+\*/\*\*/) {
65863862
AW
3076 }
3077 # Modifiers should have spaces.
3078 $to =~ s/(\b$Modifier$)/$1 /;
d8aaf121 3079
3705ce5b 3080## print "2: from<$from> to<$to> ident<$ident>\n";
667026e7 3081 if ($from ne $to && $ident !~ /^$Modifier$/) {
3705ce5b
JP
3082 if (ERROR("POINTER_LOCATION",
3083 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3084 $fix) {
3085
3086 my $sub_from = $match;
3087 my $sub_to = $match;
3088 $sub_to =~ s/\Q$from\E/$to/;
194f66fc 3089 $fixed[$fixlinenr] =~
3705ce5b
JP
3090 s@\Q$sub_from\E@$sub_to@;
3091 }
65863862 3092 }
0a920b5b
AW
3093 }
3094
3095# # no BUG() or BUG_ON()
3096# if ($line =~ /\b(BUG|BUG_ON)\b/) {
3097# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
3098# print "$herecurr";
3099# $clean = 0;
3100# }
3101
8905a67c 3102 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
000d1cc1
JP
3103 WARN("LINUX_VERSION_CODE",
3104 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
8905a67c
AW
3105 }
3106
17441227
JP
3107# check for uses of printk_ratelimit
3108 if ($line =~ /\bprintk_ratelimit\s*\(/) {
000d1cc1
JP
3109 WARN("PRINTK_RATELIMITED",
3110"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
17441227
JP
3111 }
3112
00df344f
AW
3113# printk should use KERN_* levels. Note that follow on printk's on the
3114# same line do not need a level, so we use the current block context
3115# to try and find and validate the current printk. In summary the current
25985edc 3116# printk includes all preceding printk's which have no newline on the end.
00df344f 3117# we assume the first bad printk is the one to report.
f0a594c1 3118 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
00df344f
AW
3119 my $ok = 0;
3120 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3121 #print "CHECK<$lines[$ln - 1]\n";
25985edc 3122 # we have a preceding printk if it ends
00df344f
AW
3123 # with "\n" ignore it, else it is to blame
3124 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3125 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3126 $ok = 1;
3127 }
3128 last;
3129 }
3130 }
3131 if ($ok == 0) {
000d1cc1
JP
3132 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3133 "printk() should include KERN_ facility level\n" . $herecurr);
00df344f 3134 }
0a920b5b
AW
3135 }
3136
243f3803
JP
3137 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3138 my $orig = $1;
3139 my $level = lc($orig);
3140 $level = "warn" if ($level eq "warning");
8f26b837
JP
3141 my $level2 = $level;
3142 $level2 = "dbg" if ($level eq "debug");
243f3803 3143 WARN("PREFER_PR_LEVEL",
daa8b059 3144 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
243f3803
JP
3145 }
3146
3147 if ($line =~ /\bpr_warning\s*\(/) {
d5e616fc
JP
3148 if (WARN("PREFER_PR_LEVEL",
3149 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3150 $fix) {
194f66fc 3151 $fixed[$fixlinenr] =~
d5e616fc
JP
3152 s/\bpr_warning\b/pr_warn/;
3153 }
243f3803
JP
3154 }
3155
dc139313
JP
3156 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3157 my $orig = $1;
3158 my $level = lc($orig);
3159 $level = "warn" if ($level eq "warning");
3160 $level = "dbg" if ($level eq "debug");
3161 WARN("PREFER_DEV_LEVEL",
3162 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3163 }
3164
653d4876
AW
3165# function brace can't be on same line, except for #defines of do while,
3166# or if closed on same line
8d182478 3167 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
c45dcabd 3168 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
8d182478
JP
3169 if (ERROR("OPEN_BRACE",
3170 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3171 $fix) {
3172 fix_delete_line($fixlinenr, $rawline);
3173 my $fixed_line = $rawline;
3174 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3175 my $line1 = $1;
3176 my $line2 = $2;
3177 fix_insert_line($fixlinenr, ltrim($line1));
3178 fix_insert_line($fixlinenr, "\+{");
3179 if ($line2 !~ /^\s*$/) {
3180 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3181 }
3182 }
0a920b5b 3183 }
653d4876 3184
8905a67c
AW
3185# open braces for enum, union and struct go on the same line.
3186 if ($line =~ /^.\s*{/ &&
3187 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
8d182478
JP
3188 if (ERROR("OPEN_BRACE",
3189 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3190 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3191 fix_delete_line($fixlinenr - 1, $prevrawline);
3192 fix_delete_line($fixlinenr, $rawline);
3193 my $fixedline = rtrim($prevrawline) . " {";
3194 fix_insert_line($fixlinenr, $fixedline);
3195 $fixedline = $rawline;
3196 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3197 if ($fixedline !~ /^\+\s*$/) {
3198 fix_insert_line($fixlinenr, $fixedline);
3199 }
3200 }
8905a67c
AW
3201 }
3202
0c73b4eb 3203# missing space after union, struct or enum definition
3705ce5b
JP
3204 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3205 if (WARN("SPACING",
3206 "missing space after $1 definition\n" . $herecurr) &&
3207 $fix) {
194f66fc 3208 $fixed[$fixlinenr] =~
3705ce5b
JP
3209 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3210 }
0c73b4eb
AW
3211 }
3212
31070b5d
JP
3213# Function pointer declarations
3214# check spacing between type, funcptr, and args
3215# canonical declaration is "type (*funcptr)(args...)"
91f72e9c 3216 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
31070b5d
JP
3217 my $declare = $1;
3218 my $pre_pointer_space = $2;
3219 my $post_pointer_space = $3;
3220 my $funcname = $4;
3221 my $post_funcname_space = $5;
3222 my $pre_args_space = $6;
3223
91f72e9c
JP
3224# the $Declare variable will capture all spaces after the type
3225# so check it for a missing trailing missing space but pointer return types
3226# don't need a space so don't warn for those.
3227 my $post_declare_space = "";
3228 if ($declare =~ /(\s+)$/) {
3229 $post_declare_space = $1;
3230 $declare = rtrim($declare);
3231 }
3232 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
31070b5d
JP
3233 WARN("SPACING",
3234 "missing space after return type\n" . $herecurr);
91f72e9c 3235 $post_declare_space = " ";
31070b5d
JP
3236 }
3237
3238# unnecessary space "type (*funcptr)(args...)"
91f72e9c
JP
3239# This test is not currently implemented because these declarations are
3240# equivalent to
3241# int foo(int bar, ...)
3242# and this is form shouldn't/doesn't generate a checkpatch warning.
3243#
3244# elsif ($declare =~ /\s{2,}$/) {
3245# WARN("SPACING",
3246# "Multiple spaces after return type\n" . $herecurr);
3247# }
31070b5d
JP
3248
3249# unnecessary space "type ( *funcptr)(args...)"
3250 if (defined $pre_pointer_space &&
3251 $pre_pointer_space =~ /^\s/) {
3252 WARN("SPACING",
3253 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3254 }
3255
3256# unnecessary space "type (* funcptr)(args...)"
3257 if (defined $post_pointer_space &&
3258 $post_pointer_space =~ /^\s/) {
3259 WARN("SPACING",
3260 "Unnecessary space before function pointer name\n" . $herecurr);
3261 }
3262
3263# unnecessary space "type (*funcptr )(args...)"
3264 if (defined $post_funcname_space &&
3265 $post_funcname_space =~ /^\s/) {
3266 WARN("SPACING",
3267 "Unnecessary space after function pointer name\n" . $herecurr);
3268 }
3269
3270# unnecessary space "type (*funcptr) (args...)"
3271 if (defined $pre_args_space &&
3272 $pre_args_space =~ /^\s/) {
3273 WARN("SPACING",
3274 "Unnecessary space before function pointer arguments\n" . $herecurr);
3275 }
3276
3277 if (show_type("SPACING") && $fix) {
194f66fc 3278 $fixed[$fixlinenr] =~
91f72e9c 3279 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
31070b5d
JP
3280 }
3281 }
3282
8d31cfce
AW
3283# check for spacing round square brackets; allowed:
3284# 1. with a type on the left -- int [] a;
fe2a7dbc
AW
3285# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3286# 3. inside a curly brace -- = { [0...10] = 5 }
8d31cfce
AW
3287 while ($line =~ /(.*?\s)\[/g) {
3288 my ($where, $prefix) = ($-[1], $1);
3289 if ($prefix !~ /$Type\s+$/ &&
fe2a7dbc 3290 ($where != 0 || $prefix !~ /^.\s+$/) &&
daebc534 3291 $prefix !~ /[{,]\s+$/) {
3705ce5b
JP
3292 if (ERROR("BRACKET_SPACE",
3293 "space prohibited before open square bracket '['\n" . $herecurr) &&
3294 $fix) {
194f66fc 3295 $fixed[$fixlinenr] =~
3705ce5b
JP
3296 s/^(\+.*?)\s+\[/$1\[/;
3297 }
8d31cfce
AW
3298 }
3299 }
3300
f0a594c1 3301# check for spaces between functions and their parentheses.
6c72ffaa 3302 while ($line =~ /($Ident)\s+\(/g) {
c2fdda0d 3303 my $name = $1;
773647a0
AW
3304 my $ctx_before = substr($line, 0, $-[1]);
3305 my $ctx = "$ctx_before$name";
c2fdda0d
AW
3306
3307 # Ignore those directives where spaces _are_ permitted.
773647a0
AW
3308 if ($name =~ /^(?:
3309 if|for|while|switch|return|case|
3310 volatile|__volatile__|
3311 __attribute__|format|__extension__|
3312 asm|__asm__)$/x)
3313 {
c2fdda0d
AW
3314 # cpp #define statements have non-optional spaces, ie
3315 # if there is a space between the name and the open
3316 # parenthesis it is simply not a parameter group.
c45dcabd 3317 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
773647a0
AW
3318
3319 # cpp #elif statement condition may start with a (
c45dcabd 3320 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
c2fdda0d
AW
3321
3322 # If this whole things ends with a type its most
3323 # likely a typedef for a function.
773647a0 3324 } elsif ($ctx =~ /$Type$/) {
c2fdda0d
AW
3325
3326 } else {
3705ce5b
JP
3327 if (WARN("SPACING",
3328 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3329 $fix) {
194f66fc 3330 $fixed[$fixlinenr] =~
3705ce5b
JP
3331 s/\b$name\s+\(/$name\(/;
3332 }
6c72ffaa 3333 }
f0a594c1 3334 }
9a4cad4e 3335
653d4876 3336# Check operator spacing.
0a920b5b 3337 if (!($line=~/\#\s*include/)) {
3705ce5b
JP
3338 my $fixed_line = "";
3339 my $line_fixed = 0;
3340
9c0ca6f9
AW
3341 my $ops = qr{
3342 <<=|>>=|<=|>=|==|!=|
3343 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3344 =>|->|<<|>>|<|>|=|!|~|
1f65f947 3345 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
84731623 3346 \?:|\?|:
9c0ca6f9 3347 }x;
cf655043 3348 my @elements = split(/($ops|;)/, $opline);
3705ce5b
JP
3349
3350## print("element count: <" . $#elements . ">\n");
3351## foreach my $el (@elements) {
3352## print("el: <$el>\n");
3353## }
3354
3355 my @fix_elements = ();
00df344f 3356 my $off = 0;
6c72ffaa 3357
3705ce5b
JP
3358 foreach my $el (@elements) {
3359 push(@fix_elements, substr($rawline, $off, length($el)));
3360 $off += length($el);
3361 }
3362
3363 $off = 0;
3364
6c72ffaa 3365 my $blank = copy_spacing($opline);
b34c648b 3366 my $last_after = -1;
6c72ffaa 3367
0a920b5b 3368 for (my $n = 0; $n < $#elements; $n += 2) {
3705ce5b
JP
3369
3370 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3371
3372## print("n: <$n> good: <$good>\n");
3373
4a0df2ef
AW
3374 $off += length($elements[$n]);
3375
25985edc 3376 # Pick up the preceding and succeeding characters.
773647a0
AW
3377 my $ca = substr($opline, 0, $off);
3378 my $cc = '';
3379 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3380 $cc = substr($opline, $off + length($elements[$n + 1]));
3381 }
3382 my $cb = "$ca$;$cc";
3383
4a0df2ef
AW
3384 my $a = '';
3385 $a = 'V' if ($elements[$n] ne '');
3386 $a = 'W' if ($elements[$n] =~ /\s$/);
cf655043 3387 $a = 'C' if ($elements[$n] =~ /$;$/);
4a0df2ef
AW
3388 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3389 $a = 'O' if ($elements[$n] eq '');
773647a0 3390 $a = 'E' if ($ca =~ /^\s*$/);
4a0df2ef 3391
0a920b5b 3392 my $op = $elements[$n + 1];
4a0df2ef
AW
3393
3394 my $c = '';
0a920b5b 3395 if (defined $elements[$n + 2]) {
4a0df2ef
AW
3396 $c = 'V' if ($elements[$n + 2] ne '');
3397 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
cf655043 3398 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
4a0df2ef
AW
3399 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3400 $c = 'O' if ($elements[$n + 2] eq '');
8b1b3378 3401 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
4a0df2ef
AW
3402 } else {
3403 $c = 'E';
0a920b5b
AW
3404 }
3405
4a0df2ef
AW
3406 my $ctx = "${a}x${c}";
3407
3408 my $at = "(ctx:$ctx)";
3409
6c72ffaa 3410 my $ptr = substr($blank, 0, $off) . "^";
de7d4f0e 3411 my $hereptr = "$hereline$ptr\n";
0a920b5b 3412
74048ed8 3413 # Pull out the value of this operator.
6c72ffaa 3414 my $op_type = substr($curr_values, $off + 1, 1);
0a920b5b 3415
1f65f947
AW
3416 # Get the full operator variant.
3417 my $opv = $op . substr($curr_vars, $off, 1);
3418
13214adf
AW
3419 # Ignore operators passed as parameters.
3420 if ($op_type ne 'V' &&
3421 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3422
cf655043
AW
3423# # Ignore comments
3424# } elsif ($op =~ /^$;+$/) {
13214adf 3425
d8aaf121 3426 # ; should have either the end of line or a space or \ after it
13214adf 3427 } elsif ($op eq ';') {
cf655043
AW
3428 if ($ctx !~ /.x[WEBC]/ &&
3429 $cc !~ /^\\/ && $cc !~ /^;/) {
3705ce5b
JP
3430 if (ERROR("SPACING",
3431 "space required after that '$op' $at\n" . $hereptr)) {
b34c648b 3432 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3705ce5b
JP
3433 $line_fixed = 1;
3434 }
d8aaf121
AW
3435 }
3436
3437 # // is a comment
3438 } elsif ($op eq '//') {
0a920b5b 3439
b00e4814
JP
3440 # : when part of a bitfield
3441 } elsif ($opv eq ':B') {
3442 # skip the bitfield test for now
3443
1f65f947
AW
3444 # No spaces for:
3445 # ->
b00e4814 3446 } elsif ($op eq '->') {
4a0df2ef 3447 if ($ctx =~ /Wx.|.xW/) {
3705ce5b
JP
3448 if (ERROR("SPACING",
3449 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
b34c648b 3450 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3705ce5b
JP
3451 if (defined $fix_elements[$n + 2]) {
3452 $fix_elements[$n + 2] =~ s/^\s+//;
3453 }
b34c648b 3454 $line_fixed = 1;
3705ce5b 3455 }
0a920b5b
AW
3456 }
3457
3458 # , must have a space on the right.
3459 } elsif ($op eq ',') {
cf655043 3460 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
3705ce5b
JP
3461 if (ERROR("SPACING",
3462 "space required after that '$op' $at\n" . $hereptr)) {
b34c648b 3463 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3705ce5b 3464 $line_fixed = 1;
b34c648b 3465 $last_after = $n;
3705ce5b 3466 }
0a920b5b
AW
3467 }
3468
9c0ca6f9 3469 # '*' as part of a type definition -- reported already.
74048ed8 3470 } elsif ($opv eq '*_') {
9c0ca6f9
AW
3471 #warn "'*' is part of type\n";
3472
3473 # unary operators should have a space before and
3474 # none after. May be left adjacent to another
3475 # unary operator, or a cast
3476 } elsif ($op eq '!' || $op eq '~' ||
74048ed8 3477 $opv eq '*U' || $opv eq '-U' ||
0d413866 3478 $opv eq '&U' || $opv eq '&&U') {
cf655043 3479 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
3705ce5b
JP
3480 if (ERROR("SPACING",
3481 "space required before that '$op' $at\n" . $hereptr)) {
b34c648b
JP
3482 if ($n != $last_after + 2) {
3483 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3484 $line_fixed = 1;
3485 }
3705ce5b 3486 }
0a920b5b 3487 }
a3340b35 3488 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
171ae1a4
AW
3489 # A unary '*' may be const
3490
3491 } elsif ($ctx =~ /.xW/) {
3705ce5b
JP
3492 if (ERROR("SPACING",
3493 "space prohibited after that '$op' $at\n" . $hereptr)) {
b34c648b 3494 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
3705ce5b
JP
3495 if (defined $fix_elements[$n + 2]) {
3496 $fix_elements[$n + 2] =~ s/^\s+//;
3497 }
b34c648b 3498 $line_fixed = 1;
3705ce5b 3499 }
0a920b5b
AW
3500 }
3501
3502 # unary ++ and unary -- are allowed no space on one side.
3503 } elsif ($op eq '++' or $op eq '--') {
773647a0 3504 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
3705ce5b
JP
3505 if (ERROR("SPACING",
3506 "space required one side of that '$op' $at\n" . $hereptr)) {
b34c648b 3507 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3705ce5b
JP
3508 $line_fixed = 1;
3509 }
773647a0
AW
3510 }
3511 if ($ctx =~ /Wx[BE]/ ||
3512 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
3705ce5b
JP
3513 if (ERROR("SPACING",
3514 "space prohibited before that '$op' $at\n" . $hereptr)) {
b34c648b 3515 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3705ce5b
JP
3516 $line_fixed = 1;
3517 }
0a920b5b 3518 }
773647a0 3519 if ($ctx =~ /ExW/) {
3705ce5b
JP
3520 if (ERROR("SPACING",
3521 "space prohibited after that '$op' $at\n" . $hereptr)) {
b34c648b 3522 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3705ce5b
JP
3523 if (defined $fix_elements[$n + 2]) {
3524 $fix_elements[$n + 2] =~ s/^\s+//;
3525 }
b34c648b 3526 $line_fixed = 1;
3705ce5b 3527 }
653d4876 3528 }
0a920b5b 3529
0a920b5b 3530 # << and >> may either have or not have spaces both sides
9c0ca6f9
AW
3531 } elsif ($op eq '<<' or $op eq '>>' or
3532 $op eq '&' or $op eq '^' or $op eq '|' or
3533 $op eq '+' or $op eq '-' or
c2fdda0d
AW
3534 $op eq '*' or $op eq '/' or
3535 $op eq '%')
0a920b5b 3536 {
773647a0 3537 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
3705ce5b
JP
3538 if (ERROR("SPACING",
3539 "need consistent spacing around '$op' $at\n" . $hereptr)) {
b34c648b
JP
3540 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3541 if (defined $fix_elements[$n + 2]) {
3542 $fix_elements[$n + 2] =~ s/^\s+//;
3543 }
3705ce5b
JP
3544 $line_fixed = 1;
3545 }
0a920b5b
AW
3546 }
3547
1f65f947
AW
3548 # A colon needs no spaces before when it is
3549 # terminating a case value or a label.
3550 } elsif ($opv eq ':C' || $opv eq ':L') {
3551 if ($ctx =~ /Wx./) {
3705ce5b
JP
3552 if (ERROR("SPACING",
3553 "space prohibited before that '$op' $at\n" . $hereptr)) {
b34c648b 3554 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3705ce5b
JP
3555 $line_fixed = 1;
3556 }
1f65f947
AW
3557 }
3558
0a920b5b 3559 # All the others need spaces both sides.
cf655043 3560 } elsif ($ctx !~ /[EWC]x[CWE]/) {
1f65f947
AW
3561 my $ok = 0;
3562
22f2a2ef 3563 # Ignore email addresses <foo@bar>
1f65f947
AW
3564 if (($op eq '<' &&
3565 $cc =~ /^\S+\@\S+>/) ||
3566 ($op eq '>' &&
3567 $ca =~ /<\S+\@\S+$/))
3568 {
3569 $ok = 1;
3570 }
3571
84731623 3572 # messages are ERROR, but ?: are CHK
1f65f947 3573 if ($ok == 0) {
84731623
JP
3574 my $msg_type = \&ERROR;
3575 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3576
3577 if (&{$msg_type}("SPACING",
3578 "spaces required around that '$op' $at\n" . $hereptr)) {
b34c648b
JP
3579 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3580 if (defined $fix_elements[$n + 2]) {
3581 $fix_elements[$n + 2] =~ s/^\s+//;
3582 }
3705ce5b
JP
3583 $line_fixed = 1;
3584 }
22f2a2ef 3585 }
0a920b5b 3586 }
4a0df2ef 3587 $off += length($elements[$n + 1]);
3705ce5b
JP
3588
3589## print("n: <$n> GOOD: <$good>\n");
3590
3591 $fixed_line = $fixed_line . $good;
3592 }
3593
3594 if (($#elements % 2) == 0) {
3595 $fixed_line = $fixed_line . $fix_elements[$#elements];
0a920b5b 3596 }
3705ce5b 3597
194f66fc
JP
3598 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
3599 $fixed[$fixlinenr] = $fixed_line;
3705ce5b
JP
3600 }
3601
3602
0a920b5b
AW
3603 }
3604
786b6326 3605# check for whitespace before a non-naked semicolon
d2e248e7 3606 if ($line =~ /^\+.*\S\s+;\s*$/) {
786b6326
JP
3607 if (WARN("SPACING",
3608 "space prohibited before semicolon\n" . $herecurr) &&
3609 $fix) {
194f66fc 3610 1 while $fixed[$fixlinenr] =~
786b6326
JP
3611 s/^(\+.*\S)\s+;/$1;/;
3612 }
3613 }
3614
f0a594c1
AW
3615# check for multiple assignments
3616 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
000d1cc1
JP
3617 CHK("MULTIPLE_ASSIGNMENTS",
3618 "multiple assignments should be avoided\n" . $herecurr);
f0a594c1
AW
3619 }
3620
22f2a2ef
AW
3621## # check for multiple declarations, allowing for a function declaration
3622## # continuation.
3623## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3624## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3625##
3626## # Remove any bracketed sections to ensure we do not
3627## # falsly report the parameters of functions.
3628## my $ln = $line;
3629## while ($ln =~ s/\([^\(\)]*\)//g) {
3630## }
3631## if ($ln =~ /,/) {
000d1cc1
JP
3632## WARN("MULTIPLE_DECLARATION",
3633## "declaring multiple variables together should be avoided\n" . $herecurr);
22f2a2ef
AW
3634## }
3635## }
f0a594c1 3636
0a920b5b 3637#need space before brace following if, while, etc
22f2a2ef
AW
3638 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3639 $line =~ /do{/) {
3705ce5b
JP
3640 if (ERROR("SPACING",
3641 "space required before the open brace '{'\n" . $herecurr) &&
3642 $fix) {
194f66fc 3643 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
3705ce5b 3644 }
de7d4f0e
AW
3645 }
3646
c4a62ef9
JP
3647## # check for blank lines before declarations
3648## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3649## $prevrawline =~ /^.\s*$/) {
3650## WARN("SPACING",
3651## "No blank lines before declarations\n" . $hereprev);
3652## }
3653##
3654
de7d4f0e
AW
3655# closing brace should have a space following it when it has anything
3656# on the line
3657 if ($line =~ /}(?!(?:,|;|\)))\S/) {
d5e616fc
JP
3658 if (ERROR("SPACING",
3659 "space required after that close brace '}'\n" . $herecurr) &&
3660 $fix) {
194f66fc 3661 $fixed[$fixlinenr] =~
d5e616fc
JP
3662 s/}((?!(?:,|;|\)))\S)/} $1/;
3663 }
0a920b5b
AW
3664 }
3665
22f2a2ef
AW
3666# check spacing on square brackets
3667 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
3705ce5b
JP
3668 if (ERROR("SPACING",
3669 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3670 $fix) {
194f66fc 3671 $fixed[$fixlinenr] =~
3705ce5b
JP
3672 s/\[\s+/\[/;
3673 }
22f2a2ef
AW
3674 }
3675 if ($line =~ /\s\]/) {
3705ce5b
JP
3676 if (ERROR("SPACING",
3677 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3678 $fix) {
194f66fc 3679 $fixed[$fixlinenr] =~
3705ce5b
JP
3680 s/\s+\]/\]/;
3681 }
22f2a2ef
AW
3682 }
3683
c45dcabd 3684# check spacing on parentheses
9c0ca6f9
AW
3685 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3686 $line !~ /for\s*\(\s+;/) {
3705ce5b
JP
3687 if (ERROR("SPACING",
3688 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3689 $fix) {
194f66fc 3690 $fixed[$fixlinenr] =~
3705ce5b
JP
3691 s/\(\s+/\(/;
3692 }
22f2a2ef 3693 }
13214adf 3694 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
c45dcabd
AW
3695 $line !~ /for\s*\(.*;\s+\)/ &&
3696 $line !~ /:\s+\)/) {
3705ce5b
JP
3697 if (ERROR("SPACING",
3698 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3699 $fix) {
194f66fc
JP
3700 print("fixlinenr: <$fixlinenr> fixed[fixlinenr]: <$fixed[$fixlinenr]>\n");
3701 $fixed[$fixlinenr] =~
3705ce5b
JP
3702 s/\s+\)/\)/;
3703 }
22f2a2ef
AW
3704 }
3705
e2826fd0
JP
3706# check unnecessary parentheses around addressof/dereference single $Lvals
3707# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
3708
3709 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
3710 CHK("UNNECESSARY_PARENTHESES",
3711 "Unnecessary parentheses around $1\n" . $herecurr);
3712 }
3713
0a920b5b 3714#goto labels aren't indented, allow a single space however
4a0df2ef 3715 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
0a920b5b 3716 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
3705ce5b
JP
3717 if (WARN("INDENTED_LABEL",
3718 "labels should not be indented\n" . $herecurr) &&
3719 $fix) {
194f66fc 3720 $fixed[$fixlinenr] =~
3705ce5b
JP
3721 s/^(.)\s+/$1/;
3722 }
0a920b5b
AW
3723 }
3724
5b9553ab 3725# return is not a function
507e5141 3726 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
c45dcabd 3727 my $spacing = $1;
507e5141 3728 if ($^V && $^V ge 5.10.0 &&
5b9553ab
JP
3729 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3730 my $value = $1;
3731 $value = deparenthesize($value);
3732 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3733 ERROR("RETURN_PARENTHESES",
3734 "return is not a function, parentheses are not required\n" . $herecurr);
3735 }
c45dcabd 3736 } elsif ($spacing !~ /\s+/) {
000d1cc1
JP
3737 ERROR("SPACING",
3738 "space required before the open parenthesis '('\n" . $herecurr);
c45dcabd
AW
3739 }
3740 }
507e5141 3741
b43ae21b
JP
3742# unnecessary return in a void function
3743# at end-of-function, with the previous line a single leading tab, then return;
3744# and the line before that not a goto label target like "out:"
3745 if ($sline =~ /^[ \+]}\s*$/ &&
3746 $prevline =~ /^\+\treturn\s*;\s*$/ &&
3747 $linenr >= 3 &&
3748 $lines[$linenr - 3] =~ /^[ +]/ &&
3749 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
9819cf25 3750 WARN("RETURN_VOID",
b43ae21b
JP
3751 "void function return statements are not generally useful\n" . $hereprev);
3752 }
9819cf25 3753
189248d8
JP
3754# if statements using unnecessary parentheses - ie: if ((foo == bar))
3755 if ($^V && $^V ge 5.10.0 &&
3756 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3757 my $openparens = $1;
3758 my $count = $openparens =~ tr@\(@\(@;
3759 my $msg = "";
3760 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3761 my $comp = $4; #Not $1 because of $LvalOrFunc
3762 $msg = " - maybe == should be = ?" if ($comp eq "==");
3763 WARN("UNNECESSARY_PARENTHESES",
3764 "Unnecessary parentheses$msg\n" . $herecurr);
3765 }
3766 }
3767
53a3c448
AW
3768# Return of what appears to be an errno should normally be -'ve
3769 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3770 my $name = $1;
3771 if ($name ne 'EOF' && $name ne 'ERROR') {
000d1cc1
JP
3772 WARN("USE_NEGATIVE_ERRNO",
3773 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
53a3c448
AW
3774 }
3775 }
c45dcabd 3776
0a920b5b 3777# Need a space before open parenthesis after if, while etc
3705ce5b
JP
3778 if ($line =~ /\b(if|while|for|switch)\(/) {
3779 if (ERROR("SPACING",
3780 "space required before the open parenthesis '('\n" . $herecurr) &&
3781 $fix) {
194f66fc 3782 $fixed[$fixlinenr] =~
3705ce5b
JP
3783 s/\b(if|while|for|switch)\(/$1 \(/;
3784 }
0a920b5b
AW
3785 }
3786
f5fe35dd
AW
3787# Check for illegal assignment in if conditional -- and check for trailing
3788# statements after the conditional.
170d3a22 3789 if ($line =~ /do\s*(?!{)/) {
3e469cdc
AW
3790 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3791 ctx_statement_block($linenr, $realcnt, 0)
3792 if (!defined $stat);
170d3a22
AW
3793 my ($stat_next) = ctx_statement_block($line_nr_next,
3794 $remain_next, $off_next);
3795 $stat_next =~ s/\n./\n /g;
3796 ##print "stat<$stat> stat_next<$stat_next>\n";
3797
3798 if ($stat_next =~ /^\s*while\b/) {
3799 # If the statement carries leading newlines,
3800 # then count those as offsets.
3801 my ($whitespace) =
3802 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3803 my $offset =
3804 statement_rawlines($whitespace) - 1;
3805
3806 $suppress_whiletrailers{$line_nr_next +
3807 $offset} = 1;
3808 }
3809 }
3810 if (!defined $suppress_whiletrailers{$linenr} &&
c11230f4 3811 defined($stat) && defined($cond) &&
170d3a22 3812 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
171ae1a4 3813 my ($s, $c) = ($stat, $cond);
8905a67c 3814
b53c8e10 3815 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
000d1cc1
JP
3816 ERROR("ASSIGN_IN_IF",
3817 "do not use assignment in if condition\n" . $herecurr);
8905a67c
AW
3818 }
3819
3820 # Find out what is on the end of the line after the
3821 # conditional.
773647a0 3822 substr($s, 0, length($c), '');
8905a67c 3823 $s =~ s/\n.*//g;
13214adf 3824 $s =~ s/$;//g; # Remove any comments
53210168
AW
3825 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3826 $c !~ /}\s*while\s*/)
773647a0 3827 {
bb44ad39
AW
3828 # Find out how long the conditional actually is.
3829 my @newlines = ($c =~ /\n/gs);
3830 my $cond_lines = 1 + $#newlines;
42bdf74c 3831 my $stat_real = '';
bb44ad39 3832
42bdf74c
HS
3833 $stat_real = raw_line($linenr, $cond_lines)
3834 . "\n" if ($cond_lines);
bb44ad39
AW
3835 if (defined($stat_real) && $cond_lines > 1) {
3836 $stat_real = "[...]\n$stat_real";
3837 }
3838
000d1cc1
JP
3839 ERROR("TRAILING_STATEMENTS",
3840 "trailing statements should be on next line\n" . $herecurr . $stat_real);
8905a67c
AW
3841 }
3842 }
3843
13214adf
AW
3844# Check for bitwise tests written as boolean
3845 if ($line =~ /
3846 (?:
3847 (?:\[|\(|\&\&|\|\|)
3848 \s*0[xX][0-9]+\s*
3849 (?:\&\&|\|\|)
3850 |
3851 (?:\&\&|\|\|)
3852 \s*0[xX][0-9]+\s*
3853 (?:\&\&|\|\||\)|\])
3854 )/x)
3855 {
000d1cc1
JP
3856 WARN("HEXADECIMAL_BOOLEAN_TEST",
3857 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
13214adf
AW
3858 }
3859
8905a67c 3860# if and else should not have general statements after it
13214adf
AW
3861 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3862 my $s = $1;
3863 $s =~ s/$;//g; # Remove any comments
3864 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
000d1cc1
JP
3865 ERROR("TRAILING_STATEMENTS",
3866 "trailing statements should be on next line\n" . $herecurr);
13214adf 3867 }
0a920b5b 3868 }
39667782
AW
3869# if should not continue a brace
3870 if ($line =~ /}\s*if\b/) {
000d1cc1 3871 ERROR("TRAILING_STATEMENTS",
048b123f 3872 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
39667782
AW
3873 $herecurr);
3874 }
a1080bf8
AW
3875# case and default should not have general statements after them
3876 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3877 $line !~ /\G(?:
3fef12d6 3878 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
a1080bf8
AW
3879 \s*return\s+
3880 )/xg)
3881 {
000d1cc1
JP
3882 ERROR("TRAILING_STATEMENTS",
3883 "trailing statements should be on next line\n" . $herecurr);
a1080bf8 3884 }
0a920b5b
AW
3885
3886 # Check for }<nl>else {, these must be at the same
3887 # indent level to be relevant to each other.
3888 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
3889 $previndent == $indent) {
000d1cc1
JP
3890 ERROR("ELSE_AFTER_BRACE",
3891 "else should follow close brace '}'\n" . $hereprev);
0a920b5b
AW
3892 }
3893
c2fdda0d
AW
3894 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
3895 $previndent == $indent) {
3896 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3897
3898 # Find out what is on the end of the line after the
3899 # conditional.
773647a0 3900 substr($s, 0, length($c), '');
c2fdda0d
AW
3901 $s =~ s/\n.*//g;
3902
3903 if ($s =~ /^\s*;/) {
000d1cc1
JP
3904 ERROR("WHILE_AFTER_BRACE",
3905 "while should follow close brace '}'\n" . $hereprev);
c2fdda0d
AW
3906 }
3907 }
3908
95e2c602 3909#Specific variable tests
323c1260
JP
3910 while ($line =~ m{($Constant|$Lval)}g) {
3911 my $var = $1;
95e2c602
JP
3912
3913#gcc binary extension
3914 if ($var =~ /^$Binary$/) {
d5e616fc
JP
3915 if (WARN("GCC_BINARY_CONSTANT",
3916 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3917 $fix) {
3918 my $hexval = sprintf("0x%x", oct($var));
194f66fc 3919 $fixed[$fixlinenr] =~
d5e616fc
JP
3920 s/\b$var\b/$hexval/;
3921 }
95e2c602
JP
3922 }
3923
3924#CamelCase
807bd26c 3925 if ($var !~ /^$Constant$/ &&
be79794b 3926 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
22735ce8 3927#Ignore Page<foo> variants
807bd26c 3928 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
22735ce8 3929#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
3445686a 3930 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
7e781f67
JP
3931 while ($var =~ m{($Ident)}g) {
3932 my $word = $1;
3933 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
d8b07710
JP
3934 if ($check) {
3935 seed_camelcase_includes();
3936 if (!$file && !$camelcase_file_seeded) {
3937 seed_camelcase_file($realfile);
3938 $camelcase_file_seeded = 1;
3939 }
3940 }
7e781f67
JP
3941 if (!defined $camelcase{$word}) {
3942 $camelcase{$word} = 1;
3943 CHK("CAMELCASE",
3944 "Avoid CamelCase: <$word>\n" . $herecurr);
3945 }
3445686a 3946 }
323c1260
JP
3947 }
3948 }
0a920b5b
AW
3949
3950#no spaces allowed after \ in define
d5e616fc
JP
3951 if ($line =~ /\#\s*define.*\\\s+$/) {
3952 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
3953 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
3954 $fix) {
194f66fc 3955 $fixed[$fixlinenr] =~ s/\s+$//;
d5e616fc 3956 }
0a920b5b
AW
3957 }
3958
653d4876 3959#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
c45dcabd 3960 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
e09dec48
AW
3961 my $file = "$1.h";
3962 my $checkfile = "include/linux/$file";
3963 if (-f "$root/$checkfile" &&
3964 $realfile ne $checkfile &&
7840a94c 3965 $1 !~ /$allowed_asm_includes/)
c45dcabd 3966 {
e09dec48 3967 if ($realfile =~ m{^arch/}) {
000d1cc1
JP
3968 CHK("ARCH_INCLUDE_LINUX",
3969 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
e09dec48 3970 } else {
000d1cc1
JP
3971 WARN("INCLUDE_LINUX",
3972 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
e09dec48 3973 }
0a920b5b
AW
3974 }
3975 }
3976
653d4876
AW
3977# multi-statement macros should be enclosed in a do while loop, grab the
3978# first statement and ensure its the whole macro if its not enclosed
cf655043 3979# in a known good container
b8f96a31
AW
3980 if ($realfile !~ m@/vmlinux.lds.h$@ &&
3981 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
d8aaf121
AW
3982 my $ln = $linenr;
3983 my $cnt = $realcnt;
c45dcabd
AW
3984 my ($off, $dstat, $dcond, $rest);
3985 my $ctx = '';
c45dcabd 3986 ($dstat, $dcond, $ln, $cnt, $off) =
f74bd194
AW
3987 ctx_statement_block($linenr, $realcnt, 0);
3988 $ctx = $dstat;
c45dcabd 3989 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
a3bb97a7 3990 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
c45dcabd 3991
f74bd194 3992 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
292f1a9b 3993 $dstat =~ s/$;//g;
c45dcabd
AW
3994 $dstat =~ s/\\\n.//g;
3995 $dstat =~ s/^\s*//s;
3996 $dstat =~ s/\s*$//s;
de7d4f0e 3997
c45dcabd 3998 # Flatten any parentheses and braces
bf30d6ed
AW
3999 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4000 $dstat =~ s/\{[^\{\}]*\}/1/ ||
c81769fd 4001 $dstat =~ s/\[[^\[\]]*\]/1/)
bf30d6ed 4002 {
de7d4f0e 4003 }
d8aaf121 4004
e45bab8e
AW
4005 # Flatten any obvious string concatentation.
4006 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
4007 $dstat =~ s/$Ident\s*("X*")/$1/)
4008 {
4009 }
4010
c45dcabd
AW
4011 my $exceptions = qr{
4012 $Declare|
4013 module_param_named|
a0a0a7a9 4014 MODULE_PARM_DESC|
c45dcabd
AW
4015 DECLARE_PER_CPU|
4016 DEFINE_PER_CPU|
383099fd 4017 __typeof__\(|
22fd2d3e
SS
4018 union|
4019 struct|
ea71a0a0
AW
4020 \.$Ident\s*=\s*|
4021 ^\"|\"$
c45dcabd 4022 }x;
5eaa20b9 4023 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
f74bd194
AW
4024 if ($dstat ne '' &&
4025 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4026 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
3cc4b1c3 4027 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
356fd398 4028 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
f74bd194
AW
4029 $dstat !~ /$exceptions/ &&
4030 $dstat !~ /^\.$Ident\s*=/ && # .foo =
e942e2c3 4031 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
72f115f9 4032 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
f74bd194
AW
4033 $dstat !~ /^for\s*$Constant$/ && # for (...)
4034 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4035 $dstat !~ /^do\s*{/ && # do {...
f95a7e6a
JP
4036 $dstat !~ /^\({/ && # ({...
4037 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
f74bd194
AW
4038 {
4039 $ctx =~ s/\n*$//;
4040 my $herectx = $here . "\n";
4041 my $cnt = statement_rawlines($ctx);
4042
4043 for (my $n = 0; $n < $cnt; $n++) {
4044 $herectx .= raw_line($linenr, $n) . "\n";
c45dcabd
AW
4045 }
4046
f74bd194
AW
4047 if ($dstat =~ /;/) {
4048 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4049 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4050 } else {
000d1cc1 4051 ERROR("COMPLEX_MACRO",
f74bd194 4052 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
d8aaf121 4053 }
653d4876 4054 }
5023d347 4055
481eb486 4056# check for line continuations outside of #defines, preprocessor #, and asm
5023d347
JP
4057
4058 } else {
4059 if ($prevline !~ /^..*\\$/ &&
481eb486
JP
4060 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4061 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
5023d347
JP
4062 $line =~ /^\+.*\\$/) {
4063 WARN("LINE_CONTINUATIONS",
4064 "Avoid unnecessary line continuations\n" . $herecurr);
4065 }
0a920b5b
AW
4066 }
4067
b13edf7f
JP
4068# do {} while (0) macro tests:
4069# single-statement macros do not need to be enclosed in do while (0) loop,
4070# macro should not end with a semicolon
4071 if ($^V && $^V ge 5.10.0 &&
4072 $realfile !~ m@/vmlinux.lds.h$@ &&
4073 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4074 my $ln = $linenr;
4075 my $cnt = $realcnt;
4076 my ($off, $dstat, $dcond, $rest);
4077 my $ctx = '';
4078 ($dstat, $dcond, $ln, $cnt, $off) =
4079 ctx_statement_block($linenr, $realcnt, 0);
4080 $ctx = $dstat;
4081
4082 $dstat =~ s/\\\n.//g;
4083
4084 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4085 my $stmts = $2;
4086 my $semis = $3;
4087
4088 $ctx =~ s/\n*$//;
4089 my $cnt = statement_rawlines($ctx);
4090 my $herectx = $here . "\n";
4091
4092 for (my $n = 0; $n < $cnt; $n++) {
4093 $herectx .= raw_line($linenr, $n) . "\n";
4094 }
4095
ac8e97f8
JP
4096 if (($stmts =~ tr/;/;/) == 1 &&
4097 $stmts !~ /^\s*(if|while|for|switch)\b/) {
b13edf7f
JP
4098 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4099 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4100 }
4101 if (defined $semis && $semis ne "") {
4102 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4103 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4104 }
f5ef95b1
JP
4105 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4106 $ctx =~ s/\n*$//;
4107 my $cnt = statement_rawlines($ctx);
4108 my $herectx = $here . "\n";
4109
4110 for (my $n = 0; $n < $cnt; $n++) {
4111 $herectx .= raw_line($linenr, $n) . "\n";
4112 }
4113
4114 WARN("TRAILING_SEMICOLON",
4115 "macros should not use a trailing semicolon\n" . "$herectx");
b13edf7f
JP
4116 }
4117 }
4118
080ba929
MF
4119# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4120# all assignments may have only one of the following with an assignment:
4121# .
4122# ALIGN(...)
4123# VMLINUX_SYMBOL(...)
4124 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
000d1cc1
JP
4125 WARN("MISSING_VMLINUX_SYMBOL",
4126 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
080ba929
MF
4127 }
4128
f0a594c1 4129# check for redundant bracing round if etc
13214adf
AW
4130 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4131 my ($level, $endln, @chunks) =
cf655043 4132 ctx_statement_full($linenr, $realcnt, 1);
13214adf 4133 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
cf655043
AW
4134 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4135 if ($#chunks > 0 && $level == 0) {
aad4f614
JP
4136 my @allowed = ();
4137 my $allow = 0;
13214adf 4138 my $seen = 0;
773647a0 4139 my $herectx = $here . "\n";
cf655043 4140 my $ln = $linenr - 1;
13214adf
AW
4141 for my $chunk (@chunks) {
4142 my ($cond, $block) = @{$chunk};
4143
773647a0
AW
4144 # If the condition carries leading newlines, then count those as offsets.
4145 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4146 my $offset = statement_rawlines($whitespace) - 1;
4147
aad4f614 4148 $allowed[$allow] = 0;
773647a0
AW
4149 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4150
4151 # We have looked at and allowed this specific line.
4152 $suppress_ifbraces{$ln + $offset} = 1;
4153
4154 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
cf655043
AW
4155 $ln += statement_rawlines($block) - 1;
4156
773647a0 4157 substr($block, 0, length($cond), '');
13214adf
AW
4158
4159 $seen++ if ($block =~ /^\s*{/);
4160
aad4f614 4161 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
cf655043
AW
4162 if (statement_lines($cond) > 1) {
4163 #print "APW: ALLOWED: cond<$cond>\n";
aad4f614 4164 $allowed[$allow] = 1;
13214adf
AW
4165 }
4166 if ($block =~/\b(?:if|for|while)\b/) {
cf655043 4167 #print "APW: ALLOWED: block<$block>\n";
aad4f614 4168 $allowed[$allow] = 1;
13214adf 4169 }
cf655043
AW
4170 if (statement_block_size($block) > 1) {
4171 #print "APW: ALLOWED: lines block<$block>\n";
aad4f614 4172 $allowed[$allow] = 1;
13214adf 4173 }
aad4f614 4174 $allow++;
13214adf 4175 }
aad4f614
JP
4176 if ($seen) {
4177 my $sum_allowed = 0;
4178 foreach (@allowed) {
4179 $sum_allowed += $_;
4180 }
4181 if ($sum_allowed == 0) {
4182 WARN("BRACES",
4183 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4184 } elsif ($sum_allowed != $allow &&
4185 $seen != $allow) {
4186 CHK("BRACES",
4187 "braces {} should be used on all arms of this statement\n" . $herectx);
4188 }
13214adf
AW
4189 }
4190 }
4191 }
773647a0 4192 if (!defined $suppress_ifbraces{$linenr - 1} &&
13214adf 4193 $line =~ /\b(if|while|for|else)\b/) {
cf655043
AW
4194 my $allowed = 0;
4195
4196 # Check the pre-context.
4197 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4198 #print "APW: ALLOWED: pre<$1>\n";
4199 $allowed = 1;
4200 }
773647a0
AW
4201
4202 my ($level, $endln, @chunks) =
4203 ctx_statement_full($linenr, $realcnt, $-[0]);
4204
cf655043
AW
4205 # Check the condition.
4206 my ($cond, $block) = @{$chunks[0]};
773647a0 4207 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
cf655043 4208 if (defined $cond) {
773647a0 4209 substr($block, 0, length($cond), '');
cf655043
AW
4210 }
4211 if (statement_lines($cond) > 1) {
4212 #print "APW: ALLOWED: cond<$cond>\n";
4213 $allowed = 1;
4214 }
4215 if ($block =~/\b(?:if|for|while)\b/) {
4216 #print "APW: ALLOWED: block<$block>\n";
4217 $allowed = 1;
4218 }
4219 if (statement_block_size($block) > 1) {
4220 #print "APW: ALLOWED: lines block<$block>\n";
4221 $allowed = 1;
4222 }
4223 # Check the post-context.
4224 if (defined $chunks[1]) {
4225 my ($cond, $block) = @{$chunks[1]};
4226 if (defined $cond) {
773647a0 4227 substr($block, 0, length($cond), '');
cf655043
AW
4228 }
4229 if ($block =~ /^\s*\{/) {
4230 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4231 $allowed = 1;
4232 }
4233 }
4234 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
69932487 4235 my $herectx = $here . "\n";
f055663c 4236 my $cnt = statement_rawlines($block);
cf655043 4237
f055663c 4238 for (my $n = 0; $n < $cnt; $n++) {
69932487 4239 $herectx .= raw_line($linenr, $n) . "\n";
f0a594c1 4240 }
cf655043 4241
000d1cc1
JP
4242 WARN("BRACES",
4243 "braces {} are not necessary for single statement blocks\n" . $herectx);
f0a594c1
AW
4244 }
4245 }
4246
0979ae66 4247# check for unnecessary blank lines around braces
77b9a53a 4248 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
0979ae66
JP
4249 CHK("BRACES",
4250 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
4251 }
77b9a53a 4252 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
0979ae66
JP
4253 CHK("BRACES",
4254 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
4255 }
4256
4a0df2ef 4257# no volatiles please
6c72ffaa
AW
4258 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4259 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
000d1cc1
JP
4260 WARN("VOLATILE",
4261 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4a0df2ef
AW
4262 }
4263
00df344f 4264# warn about #if 0
c45dcabd 4265 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
000d1cc1
JP
4266 CHK("REDUNDANT_CODE",
4267 "if this code is redundant consider removing it\n" .
de7d4f0e 4268 $herecurr);
4a0df2ef
AW
4269 }
4270
03df4b51
AW
4271# check for needless "if (<foo>) fn(<foo>)" uses
4272 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
4273 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
4274 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
4275 WARN('NEEDLESS_IF',
4276 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
4c432a8f
GKH
4277 }
4278 }
f0a594c1 4279
ebfdc409
JP
4280# check for unnecessary "Out of Memory" messages
4281 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4282 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4283 (defined $1 || defined $3) &&
4284 $linenr > 3) {
4285 my $testval = $2;
4286 my $testline = $lines[$linenr - 3];
4287
4288 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
4289# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4290
4291 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4292 WARN("OOM_MESSAGE",
4293 "Possible unnecessary 'out of memory' message\n" . $hereprev);
4294 }
4295 }
4296
8716de38
JP
4297# check for bad placement of section $InitAttribute (e.g.: __initdata)
4298 if ($line =~ /(\b$InitAttribute\b)/) {
4299 my $attr = $1;
4300 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4301 my $ptr = $1;
4302 my $var = $2;
4303 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4304 ERROR("MISPLACED_INIT",
4305 "$attr should be placed after $var\n" . $herecurr)) ||
4306 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4307 WARN("MISPLACED_INIT",
4308 "$attr should be placed after $var\n" . $herecurr))) &&
4309 $fix) {
194f66fc 4310 $fixed[$fixlinenr] =~ s/(\bstatic\s+(?:const\s+)?)(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*([=;])\s*/"$1" . trim(string_find_replace($2, "\\s*$attr\\s*", " ")) . " " . trim(string_find_replace($3, "\\s*$attr\\s*", "")) . " $attr" . ("$4" eq ";" ? ";" : " = ")/e;
8716de38
JP
4311 }
4312 }
4313 }
4314
e970b884
JP
4315# check for $InitAttributeData (ie: __initdata) with const
4316 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
4317 my $attr = $1;
4318 $attr =~ /($InitAttributePrefix)(.*)/;
4319 my $attr_prefix = $1;
4320 my $attr_type = $2;
4321 if (ERROR("INIT_ATTRIBUTE",
4322 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4323 $fix) {
194f66fc 4324 $fixed[$fixlinenr] =~
e970b884
JP
4325 s/$InitAttributeData/${attr_prefix}initconst/;
4326 }
4327 }
4328
4329# check for $InitAttributeConst (ie: __initconst) without const
4330 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4331 my $attr = $1;
4332 if (ERROR("INIT_ATTRIBUTE",
4333 "Use of $attr requires a separate use of const\n" . $herecurr) &&
4334 $fix) {
194f66fc 4335 my $lead = $fixed[$fixlinenr] =~
e970b884
JP
4336 /(^\+\s*(?:static\s+))/;
4337 $lead = rtrim($1);
4338 $lead = "$lead " if ($lead !~ /^\+$/);
4339 $lead = "${lead}const ";
194f66fc 4340 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
e970b884
JP
4341 }
4342 }
4343
fbdb8138
JP
4344# don't use __constant_<foo> functions outside of include/uapi/
4345 if ($realfile !~ m@^include/uapi/@ &&
4346 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4347 my $constant_func = $1;
4348 my $func = $constant_func;
4349 $func =~ s/^__constant_//;
4350 if (WARN("CONSTANT_CONVERSION",
4351 "$constant_func should be $func\n" . $herecurr) &&
4352 $fix) {
194f66fc 4353 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
fbdb8138
JP
4354 }
4355 }
4356
1a15a250 4357# prefer usleep_range over udelay
37581c28 4358 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
43c1d77c 4359 my $delay = $1;
1a15a250 4360 # ignore udelay's < 10, however
43c1d77c 4361 if (! ($delay < 10) ) {
000d1cc1 4362 CHK("USLEEP_RANGE",
43c1d77c
JP
4363 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4364 }
4365 if ($delay > 2000) {
4366 WARN("LONG_UDELAY",
4367 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
1a15a250
PP
4368 }
4369 }
4370
09ef8725
PP
4371# warn about unexpectedly long msleep's
4372 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4373 if ($1 < 20) {
000d1cc1 4374 WARN("MSLEEP",
43c1d77c 4375 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
09ef8725
PP
4376 }
4377 }
4378
36ec1939
JP
4379# check for comparisons of jiffies
4380 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4381 WARN("JIFFIES_COMPARISON",
4382 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4383 }
4384
9d7a34a5
JP
4385# check for comparisons of get_jiffies_64()
4386 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4387 WARN("JIFFIES_COMPARISON",
4388 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4389 }
4390
00df344f 4391# warn about #ifdefs in C files
c45dcabd 4392# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
00df344f
AW
4393# print "#ifdef in C files should be avoided\n";
4394# print "$herecurr";
4395# $clean = 0;
4396# }
4397
22f2a2ef 4398# warn about spacing in #ifdefs
c45dcabd 4399 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
3705ce5b
JP
4400 if (ERROR("SPACING",
4401 "exactly one space required after that #$1\n" . $herecurr) &&
4402 $fix) {
194f66fc 4403 $fixed[$fixlinenr] =~
3705ce5b
JP
4404 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4405 }
4406
22f2a2ef
AW
4407 }
4408
4a0df2ef 4409# check for spinlock_t definitions without a comment.
171ae1a4
AW
4410 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4411 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
4a0df2ef
AW
4412 my $which = $1;
4413 if (!ctx_has_comment($first_line, $linenr)) {
000d1cc1
JP
4414 CHK("UNCOMMENTED_DEFINITION",
4415 "$1 definition without comment\n" . $herecurr);
4a0df2ef
AW
4416 }
4417 }
4418# check for memory barriers without a comment.
4419 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4420 if (!ctx_has_comment($first_line, $linenr)) {
c1fd7bb9
JP
4421 WARN("MEMORY_BARRIER",
4422 "memory barrier without comment\n" . $herecurr);
4a0df2ef
AW
4423 }
4424 }
4425# check of hardware specific defines
c45dcabd 4426 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
000d1cc1
JP
4427 CHK("ARCH_DEFINES",
4428 "architecture specific defines should be avoided\n" . $herecurr);
0a920b5b 4429 }
653d4876 4430
d4977c78
TK
4431# Check that the storage class is at the beginning of a declaration
4432 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
000d1cc1
JP
4433 WARN("STORAGE_CLASS",
4434 "storage class should be at the beginning of the declaration\n" . $herecurr)
d4977c78
TK
4435 }
4436
de7d4f0e
AW
4437# check the location of the inline attribute, that it is between
4438# storage class and type.
9c0ca6f9
AW
4439 if ($line =~ /\b$Type\s+$Inline\b/ ||
4440 $line =~ /\b$Inline\s+$Storage\b/) {
000d1cc1
JP
4441 ERROR("INLINE_LOCATION",
4442 "inline keyword should sit between storage class and type\n" . $herecurr);
de7d4f0e
AW
4443 }
4444
8905a67c 4445# Check for __inline__ and __inline, prefer inline
2b7ab453
JP
4446 if ($realfile !~ m@\binclude/uapi/@ &&
4447 $line =~ /\b(__inline__|__inline)\b/) {
d5e616fc
JP
4448 if (WARN("INLINE",
4449 "plain inline is preferred over $1\n" . $herecurr) &&
4450 $fix) {
194f66fc 4451 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
d5e616fc
JP
4452
4453 }
8905a67c
AW
4454 }
4455
3d130fd0 4456# Check for __attribute__ packed, prefer __packed
2b7ab453
JP
4457 if ($realfile !~ m@\binclude/uapi/@ &&
4458 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
000d1cc1
JP
4459 WARN("PREFER_PACKED",
4460 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
3d130fd0
JP
4461 }
4462
39b7e287 4463# Check for __attribute__ aligned, prefer __aligned
2b7ab453
JP
4464 if ($realfile !~ m@\binclude/uapi/@ &&
4465 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
000d1cc1
JP
4466 WARN("PREFER_ALIGNED",
4467 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
39b7e287
JP
4468 }
4469
5f14d3bd 4470# Check for __attribute__ format(printf, prefer __printf
2b7ab453
JP
4471 if ($realfile !~ m@\binclude/uapi/@ &&
4472 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
d5e616fc
JP
4473 if (WARN("PREFER_PRINTF",
4474 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4475 $fix) {
194f66fc 4476 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
d5e616fc
JP
4477
4478 }
5f14d3bd
JP
4479 }
4480
6061d949 4481# Check for __attribute__ format(scanf, prefer __scanf
2b7ab453
JP
4482 if ($realfile !~ m@\binclude/uapi/@ &&
4483 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
d5e616fc
JP
4484 if (WARN("PREFER_SCANF",
4485 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4486 $fix) {
194f66fc 4487 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
d5e616fc 4488 }
6061d949
JP
4489 }
4490
8f53a9b8
JP
4491# check for sizeof(&)
4492 if ($line =~ /\bsizeof\s*\(\s*\&/) {
000d1cc1
JP
4493 WARN("SIZEOF_ADDRESS",
4494 "sizeof(& should be avoided\n" . $herecurr);
8f53a9b8
JP
4495 }
4496
66c80b60
JP
4497# check for sizeof without parenthesis
4498 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
d5e616fc
JP
4499 if (WARN("SIZEOF_PARENTHESIS",
4500 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4501 $fix) {
194f66fc 4502 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
d5e616fc 4503 }
66c80b60
JP
4504 }
4505
428e2fdc
JP
4506# check for line continuations in quoted strings with odd counts of "
4507 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
000d1cc1
JP
4508 WARN("LINE_CONTINUATIONS",
4509 "Avoid line continuations in quoted strings\n" . $herecurr);
428e2fdc
JP
4510 }
4511
88982fea
JP
4512# check for struct spinlock declarations
4513 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4514 WARN("USE_SPINLOCK_T",
4515 "struct spinlock should be spinlock_t\n" . $herecurr);
4516 }
4517
a6962d72 4518# check for seq_printf uses that could be seq_puts
06668727 4519 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
a6962d72 4520 my $fmt = get_quoted_string($line, $rawline);
06668727 4521 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
d5e616fc
JP
4522 if (WARN("PREFER_SEQ_PUTS",
4523 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4524 $fix) {
194f66fc 4525 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
d5e616fc 4526 }
a6962d72
JP
4527 }
4528 }
4529
554e165c 4530# Check for misused memsets
d1fe9c09
JP
4531 if ($^V && $^V ge 5.10.0 &&
4532 defined $stat &&
d7c76ba7
JP
4533 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
4534
4535 my $ms_addr = $2;
d1fe9c09
JP
4536 my $ms_val = $7;
4537 my $ms_size = $12;
554e165c 4538
554e165c
AW
4539 if ($ms_size =~ /^(0x|)0$/i) {
4540 ERROR("MEMSET",
d7c76ba7 4541 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
554e165c
AW
4542 } elsif ($ms_size =~ /^(0x|)1$/i) {
4543 WARN("MEMSET",
d7c76ba7
JP
4544 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4545 }
4546 }
4547
98a9bba5
JP
4548# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4549 if ($^V && $^V ge 5.10.0 &&
4550 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4551 if (WARN("PREFER_ETHER_ADDR_COPY",
4552 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4553 $fix) {
194f66fc 4554 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
98a9bba5
JP
4555 }
4556 }
4557
d7c76ba7 4558# typecasts on min/max could be min_t/max_t
d1fe9c09
JP
4559 if ($^V && $^V ge 5.10.0 &&
4560 defined $stat &&
d7c76ba7 4561 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
d1fe9c09 4562 if (defined $2 || defined $7) {
d7c76ba7
JP
4563 my $call = $1;
4564 my $cast1 = deparenthesize($2);
4565 my $arg1 = $3;
d1fe9c09
JP
4566 my $cast2 = deparenthesize($7);
4567 my $arg2 = $8;
d7c76ba7
JP
4568 my $cast;
4569
d1fe9c09 4570 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
d7c76ba7
JP
4571 $cast = "$cast1 or $cast2";
4572 } elsif ($cast1 ne "") {
4573 $cast = $cast1;
4574 } else {
4575 $cast = $cast2;
4576 }
4577 WARN("MINMAX",
4578 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
554e165c
AW
4579 }
4580 }
4581
4a273195
JP
4582# check usleep_range arguments
4583 if ($^V && $^V ge 5.10.0 &&
4584 defined $stat &&
4585 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4586 my $min = $1;
4587 my $max = $7;
4588 if ($min eq $max) {
4589 WARN("USLEEP_RANGE",
4590 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4591 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4592 $min > $max) {
4593 WARN("USLEEP_RANGE",
4594 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4595 }
4596 }
4597
823b794c
JP
4598# check for naked sscanf
4599 if ($^V && $^V ge 5.10.0 &&
4600 defined $stat &&
6c8bd707 4601 $line =~ /\bsscanf\b/ &&
823b794c
JP
4602 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4603 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4604 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4605 my $lc = $stat =~ tr@\n@@;
4606 $lc = $lc + $linenr;
4607 my $stat_real = raw_line($linenr, 0);
4608 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4609 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4610 }
4611 WARN("NAKED_SSCANF",
4612 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4613 }
4614
afc819ab
JP
4615# check for simple sscanf that should be kstrto<foo>
4616 if ($^V && $^V ge 5.10.0 &&
4617 defined $stat &&
4618 $line =~ /\bsscanf\b/) {
4619 my $lc = $stat =~ tr@\n@@;
4620 $lc = $lc + $linenr;
4621 my $stat_real = raw_line($linenr, 0);
4622 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4623 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4624 }
4625 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
4626 my $format = $6;
4627 my $count = $format =~ tr@%@%@;
4628 if ($count == 1 &&
4629 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
4630 WARN("SSCANF_TO_KSTRTO",
4631 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
4632 }
4633 }
4634 }
4635
70dc8a48
JP
4636# check for new externs in .h files.
4637 if ($realfile =~ /\.h$/ &&
4638 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
d1d85780
JP
4639 if (CHK("AVOID_EXTERNS",
4640 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
70dc8a48 4641 $fix) {
194f66fc 4642 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
70dc8a48
JP
4643 }
4644 }
4645
de7d4f0e 4646# check for new externs in .c files.
171ae1a4 4647 if ($realfile =~ /\.c$/ && defined $stat &&
c45dcabd 4648 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
171ae1a4 4649 {
c45dcabd
AW
4650 my $function_name = $1;
4651 my $paren_space = $2;
171ae1a4
AW
4652
4653 my $s = $stat;
4654 if (defined $cond) {
4655 substr($s, 0, length($cond), '');
4656 }
c45dcabd
AW
4657 if ($s =~ /^\s*;/ &&
4658 $function_name ne 'uninitialized_var')
4659 {
000d1cc1
JP
4660 WARN("AVOID_EXTERNS",
4661 "externs should be avoided in .c files\n" . $herecurr);
171ae1a4
AW
4662 }
4663
4664 if ($paren_space =~ /\n/) {
000d1cc1
JP
4665 WARN("FUNCTION_ARGUMENTS",
4666 "arguments for function declarations should follow identifier\n" . $herecurr);
171ae1a4 4667 }
9c9ba34e
AW
4668
4669 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4670 $stat =~ /^.\s*extern\s+/)
4671 {
000d1cc1
JP
4672 WARN("AVOID_EXTERNS",
4673 "externs should be avoided in .c files\n" . $herecurr);
de7d4f0e
AW
4674 }
4675
4676# checks for new __setup's
4677 if ($rawline =~ /\b__setup\("([^"]*)"/) {
4678 my $name = $1;
4679
4680 if (!grep(/$name/, @setup_docs)) {
000d1cc1
JP
4681 CHK("UNDOCUMENTED_SETUP",
4682 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
de7d4f0e 4683 }
653d4876 4684 }
9c0ca6f9
AW
4685
4686# check for pointless casting of kmalloc return
caf2a54f 4687 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
000d1cc1
JP
4688 WARN("UNNECESSARY_CASTS",
4689 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
9c0ca6f9 4690 }
13214adf 4691
a640d25c
JP
4692# alloc style
4693# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4694 if ($^V && $^V ge 5.10.0 &&
4695 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4696 CHK("ALLOC_SIZEOF_STRUCT",
4697 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
4698 }
4699
60a55369
JP
4700# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
4701 if ($^V && $^V ge 5.10.0 &&
e367455a 4702 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
60a55369
JP
4703 my $oldfunc = $3;
4704 my $a1 = $4;
4705 my $a2 = $10;
4706 my $newfunc = "kmalloc_array";
4707 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
e367455a
JP
4708 my $r1 = $a1;
4709 my $r2 = $a2;
4710 if ($a1 =~ /^sizeof\s*\S/) {
4711 $r1 = $a2;
4712 $r2 = $a1;
4713 }
4714 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
4715 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
60a55369
JP
4716 if (WARN("ALLOC_WITH_MULTIPLY",
4717 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
4718 $fix) {
194f66fc 4719 $fixed[$fixlinenr] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e;
60a55369
JP
4720
4721 }
4722 }
4723 }
4724
972fdea2
JP
4725# check for krealloc arg reuse
4726 if ($^V && $^V ge 5.10.0 &&
4727 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
4728 WARN("KREALLOC_ARG_REUSE",
4729 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
4730 }
4731
5ce59ae0
JP
4732# check for alloc argument mismatch
4733 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
4734 WARN("ALLOC_ARRAY_ARGS",
4735 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
4736 }
4737
caf2a54f
JP
4738# check for multiple semicolons
4739 if ($line =~ /;\s*;\s*$/) {
d5e616fc
JP
4740 if (WARN("ONE_SEMICOLON",
4741 "Statements terminations use 1 semicolon\n" . $herecurr) &&
4742 $fix) {
194f66fc 4743 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
d5e616fc 4744 }
d1e2ad07
JP
4745 }
4746
c34c09a8
JP
4747# check for case / default statements not preceeded by break/fallthrough/switch
4748 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
4749 my $has_break = 0;
4750 my $has_statement = 0;
4751 my $count = 0;
4752 my $prevline = $linenr;
4753 while ($prevline > 1 && $count < 3 && !$has_break) {
4754 $prevline--;
4755 my $rline = $rawlines[$prevline - 1];
4756 my $fline = $lines[$prevline - 1];
4757 last if ($fline =~ /^\@\@/);
4758 next if ($fline =~ /^\-/);
4759 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
4760 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
4761 next if ($fline =~ /^.[\s$;]*$/);
4762 $has_statement = 1;
4763 $count++;
4764 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
4765 }
4766 if (!$has_break && $has_statement) {
4767 WARN("MISSING_BREAK",
4768 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
4769 }
4770 }
4771
d1e2ad07
JP
4772# check for switch/default statements without a break;
4773 if ($^V && $^V ge 5.10.0 &&
4774 defined $stat &&
4775 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
4776 my $ctx = '';
4777 my $herectx = $here . "\n";
4778 my $cnt = statement_rawlines($stat);
4779 for (my $n = 0; $n < $cnt; $n++) {
4780 $herectx .= raw_line($linenr, $n) . "\n";
4781 }
4782 WARN("DEFAULT_NO_BREAK",
4783 "switch default: should use break\n" . $herectx);
caf2a54f
JP
4784 }
4785
13214adf 4786# check for gcc specific __FUNCTION__
d5e616fc
JP
4787 if ($line =~ /\b__FUNCTION__\b/) {
4788 if (WARN("USE_FUNC",
4789 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
4790 $fix) {
194f66fc 4791 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
d5e616fc 4792 }
13214adf 4793 }
773647a0 4794
2c92488a
JP
4795# check for use of yield()
4796 if ($line =~ /\byield\s*\(\s*\)/) {
4797 WARN("YIELD",
4798 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
4799 }
4800
179f8f40
JP
4801# check for comparisons against true and false
4802 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
4803 my $lead = $1;
4804 my $arg = $2;
4805 my $test = $3;
4806 my $otype = $4;
4807 my $trail = $5;
4808 my $op = "!";
4809
4810 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
4811
4812 my $type = lc($otype);
4813 if ($type =~ /^(?:true|false)$/) {
4814 if (("$test" eq "==" && "$type" eq "true") ||
4815 ("$test" eq "!=" && "$type" eq "false")) {
4816 $op = "";
4817 }
4818
4819 CHK("BOOL_COMPARISON",
4820 "Using comparison to $otype is error prone\n" . $herecurr);
4821
4822## maybe suggesting a correct construct would better
4823## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4824
4825 }
4826 }
4827
4882720b
TG
4828# check for semaphores initialized locked
4829 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
000d1cc1
JP
4830 WARN("CONSIDER_COMPLETION",
4831 "consider using a completion\n" . $herecurr);
773647a0 4832 }
6712d858 4833
67d0a075
JP
4834# recommend kstrto* over simple_strto* and strict_strto*
4835 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
000d1cc1 4836 WARN("CONSIDER_KSTRTO",
67d0a075 4837 "$1 is obsolete, use k$3 instead\n" . $herecurr);
773647a0 4838 }
6712d858 4839
ae3ccc46 4840# check for __initcall(), use device_initcall() explicitly or more appropriate function please
f3db6639 4841 if ($line =~ /^.\s*__initcall\s*\(/) {
000d1cc1 4842 WARN("USE_DEVICE_INITCALL",
ae3ccc46 4843 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
f3db6639 4844 }
6712d858 4845
79404849
ER
4846# check for various ops structs, ensure they are const.
4847 my $struct_ops = qr{acpi_dock_ops|
4848 address_space_operations|
4849 backlight_ops|
4850 block_device_operations|
4851 dentry_operations|
4852 dev_pm_ops|
4853 dma_map_ops|
4854 extent_io_ops|
4855 file_lock_operations|
4856 file_operations|
4857 hv_ops|
4858 ide_dma_ops|
4859 intel_dvo_dev_ops|
4860 item_operations|
4861 iwl_ops|
4862 kgdb_arch|
4863 kgdb_io|
4864 kset_uevent_ops|
4865 lock_manager_operations|
4866 microcode_ops|
4867 mtrr_ops|
4868 neigh_ops|
4869 nlmsvc_binding|
4870 pci_raw_ops|
4871 pipe_buf_operations|
4872 platform_hibernation_ops|
4873 platform_suspend_ops|
4874 proto_ops|
4875 rpc_pipe_ops|
4876 seq_operations|
4877 snd_ac97_build_ops|
4878 soc_pcmcia_socket_ops|
4879 stacktrace_ops|
4880 sysfs_ops|
4881 tty_operations|
4882 usb_mon_operations|
4883 wd_ops}x;
6903ffb2 4884 if ($line !~ /\bconst\b/ &&
79404849 4885 $line =~ /\bstruct\s+($struct_ops)\b/) {
000d1cc1
JP
4886 WARN("CONST_STRUCT",
4887 "struct $1 should normally be const\n" .
6903ffb2 4888 $herecurr);
2b6db5cb 4889 }
773647a0
AW
4890
4891# use of NR_CPUS is usually wrong
4892# ignore definitions of NR_CPUS and usage to define arrays as likely right
4893 if ($line =~ /\bNR_CPUS\b/ &&
c45dcabd
AW
4894 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4895 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
171ae1a4
AW
4896 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4897 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4898 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
773647a0 4899 {
000d1cc1
JP
4900 WARN("NR_CPUS",
4901 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
773647a0 4902 }
9c9ba34e 4903
52ea8506
JP
4904# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
4905 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
4906 ERROR("DEFINE_ARCH_HAS",
4907 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
4908 }
4909
9c9ba34e
AW
4910# check for %L{u,d,i} in strings
4911 my $string;
4912 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4913 $string = substr($rawline, $-[1], $+[1] - $-[1]);
2a1bc5d5 4914 $string =~ s/%%/__/g;
9c9ba34e 4915 if ($string =~ /(?<!%)%L[udi]/) {
000d1cc1
JP
4916 WARN("PRINTF_L",
4917 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
9c9ba34e
AW
4918 last;
4919 }
4920 }
691d77b6
AW
4921
4922# whine mightly about in_atomic
4923 if ($line =~ /\bin_atomic\s*\(/) {
4924 if ($realfile =~ m@^drivers/@) {
000d1cc1
JP
4925 ERROR("IN_ATOMIC",
4926 "do not use in_atomic in drivers\n" . $herecurr);
f4a87736 4927 } elsif ($realfile !~ m@^kernel/@) {
000d1cc1
JP
4928 WARN("IN_ATOMIC",
4929 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
691d77b6
AW
4930 }
4931 }
1704f47b
PZ
4932
4933# check for lockdep_set_novalidate_class
4934 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
4935 $line =~ /__lockdep_no_validate__\s*\)/ ) {
4936 if ($realfile !~ m@^kernel/lockdep@ &&
4937 $realfile !~ m@^include/linux/lockdep@ &&
4938 $realfile !~ m@^drivers/base/core@) {
000d1cc1
JP
4939 ERROR("LOCKDEP",
4940 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
1704f47b
PZ
4941 }
4942 }
88f8831c
DJ
4943
4944 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
4945 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
000d1cc1
JP
4946 WARN("EXPORTED_WORLD_WRITABLE",
4947 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
88f8831c 4948 }
2435880f 4949
515a235e
JP
4950# Mode permission misuses where it seems decimal should be octal
4951# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
4952 if ($^V && $^V ge 5.10.0 &&
4953 $line =~ /$mode_perms_search/) {
4954 foreach my $entry (@mode_permission_funcs) {
4955 my $func = $entry->[0];
4956 my $arg_pos = $entry->[1];
4957
4958 my $skip_args = "";
4959 if ($arg_pos > 1) {
4960 $arg_pos--;
4961 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
4962 }
4963 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
4964 if ($line =~ /$test/) {
4965 my $val = $1;
4966 $val = $6 if ($skip_args ne "");
4967
4968 if ($val !~ /^0$/ &&
4969 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
4970 length($val) ne 4)) {
4971 ERROR("NON_OCTAL_PERMISSIONS",
4972 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
4973 }
2435880f
JP
4974 }
4975 }
4976 }
13214adf
AW
4977 }
4978
4979 # If we have no input at all, then there is nothing to report on
4980 # so just keep quiet.
4981 if ($#rawlines == -1) {
4982 exit(0);
0a920b5b
AW
4983 }
4984
8905a67c
AW
4985 # In mailback mode only produce a report in the negative, for
4986 # things that appear to be patches.
4987 if ($mailback && ($clean == 1 || !$is_patch)) {
4988 exit(0);
4989 }
4990
4991 # This is not a patch, and we are are in 'no-patch' mode so
4992 # just keep quiet.
4993 if (!$chk_patch && !$is_patch) {
4994 exit(0);
4995 }
4996
4997 if (!$is_patch) {
000d1cc1
JP
4998 ERROR("NOT_UNIFIED_DIFF",
4999 "Does not appear to be a unified-diff format patch\n");
0a920b5b
AW
5000 }
5001 if ($is_patch && $chk_signoff && $signoff == 0) {
000d1cc1
JP
5002 ERROR("MISSING_SIGN_OFF",
5003 "Missing Signed-off-by: line(s)\n");
0a920b5b
AW
5004 }
5005
8905a67c 5006 print report_dump();
13214adf
AW
5007 if ($summary && !($clean == 1 && $quiet == 1)) {
5008 print "$filename " if ($summary_file);
8905a67c
AW
5009 print "total: $cnt_error errors, $cnt_warn warnings, " .
5010 (($check)? "$cnt_chk checks, " : "") .
5011 "$cnt_lines lines checked\n";
5012 print "\n" if ($quiet == 0);
f0a594c1 5013 }
8905a67c 5014
d2c0a235 5015 if ($quiet == 0) {
d1fe9c09
JP
5016
5017 if ($^V lt 5.10.0) {
5018 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
5019 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
5020 }
5021
d2c0a235
AW
5022 # If there were whitespace errors which cleanpatch can fix
5023 # then suggest that.
5024 if ($rpt_cleaners) {
5025 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
5026 print " scripts/cleanfile\n\n";
b0781216 5027 $rpt_cleaners = 0;
d2c0a235
AW
5028 }
5029 }
5030
91bfe484
JP
5031 hash_show_words(\%use_type, "Used");
5032 hash_show_words(\%ignore_type, "Ignored");
000d1cc1 5033
d752fcc8
JP
5034 if ($clean == 0 && $fix &&
5035 ("@rawlines" ne "@fixed" ||
5036 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
9624b8d6
JP
5037 my $newfile = $filename;
5038 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
3705ce5b
JP
5039 my $linecount = 0;
5040 my $f;
5041
d752fcc8
JP
5042 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
5043
3705ce5b
JP
5044 open($f, '>', $newfile)
5045 or die "$P: Can't open $newfile for write\n";
5046 foreach my $fixed_line (@fixed) {
5047 $linecount++;
5048 if ($file) {
5049 if ($linecount > 3) {
5050 $fixed_line =~ s/^\+//;
d752fcc8 5051 print $f $fixed_line . "\n";
3705ce5b
JP
5052 }
5053 } else {
5054 print $f $fixed_line . "\n";
5055 }
5056 }
5057 close($f);
5058
5059 if (!$quiet) {
5060 print << "EOM";
5061Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
5062
5063Do _NOT_ trust the results written to this file.
5064Do _NOT_ submit these changes without inspecting them for correctness.
5065
5066This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5067No warranties, expressed or implied...
5068
5069EOM
5070 }
5071 }
5072
0a920b5b 5073 if ($clean == 1 && $quiet == 0) {
c2fdda0d 5074 print "$vname has no obvious style problems and is ready for submission.\n"
0a920b5b
AW
5075 }
5076 if ($clean == 0 && $quiet == 0) {
000d1cc1
JP
5077 print << "EOM";
5078$vname has style problems, please review.
5079
5080If any of these errors are false positives, please report
5081them to the maintainer, see CHECKPATCH in MAINTAINERS.
5082EOM
0a920b5b 5083 }
13214adf 5084
0a920b5b
AW
5085 return $clean;
5086}