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