]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - scripts/checkpatch.pl
checkpatch: change blank line after declaration type to "LINE_SPACING"
[mirror_ubuntu-bionic-kernel.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/ &&
a1385803 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 =~ /^-/);
a1385803
AW
2068
2069 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
2070 $is_start = 1;
2071 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
2072 $length = -1;
2073 }
2074
9fe287d7 2075 $f =~ s/^.//;
3354957a
AK
2076 $f =~ s/#.*//;
2077 $f =~ s/^\s+//;
2078 next if ($f =~ /^$/);
9fe287d7
AW
2079 if ($f =~ /^\s*config\s/) {
2080 $is_end = 1;
2081 last;
2082 }
3354957a
AK
2083 $length++;
2084 }
000d1cc1 2085 WARN("CONFIG_DESCRIPTION",
a1385803
AW
2086 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
2087 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
3354957a
AK
2088 }
2089
1ba8dfd1
KC
2090# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2091 if ($realfile =~ /Kconfig/ &&
2092 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2093 WARN("CONFIG_EXPERIMENTAL",
2094 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2095 }
2096
c68e5878
AL
2097 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2098 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2099 my $flag = $1;
2100 my $replacement = {
2101 'EXTRA_AFLAGS' => 'asflags-y',
2102 'EXTRA_CFLAGS' => 'ccflags-y',
2103 'EXTRA_CPPFLAGS' => 'cppflags-y',
2104 'EXTRA_LDFLAGS' => 'ldflags-y',
2105 };
2106
2107 WARN("DEPRECATED_VARIABLE",
2108 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2109 }
2110
bff5da43 2111# check for DT compatible documentation
7dd05b38
FV
2112 if (defined $root &&
2113 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2114 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2115
bff5da43
RH
2116 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2117
cc93319b
FV
2118 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2119 my $vp_file = $dt_path . "vendor-prefixes.txt";
2120
bff5da43
RH
2121 foreach my $compat (@compats) {
2122 my $compat2 = $compat;
185d566b
RH
2123 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2124 my $compat3 = $compat;
2125 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2126 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
bff5da43
RH
2127 if ( $? >> 8 ) {
2128 WARN("UNDOCUMENTED_DT_STRING",
2129 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2130 }
2131
4fbf32a6
FV
2132 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2133 my $vendor = $1;
cc93319b 2134 `grep -Eq "^$vendor\\b" $vp_file`;
bff5da43
RH
2135 if ( $? >> 8 ) {
2136 WARN("UNDOCUMENTED_DT_STRING",
cc93319b 2137 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
bff5da43
RH
2138 }
2139 }
2140 }
2141
5368df20
AW
2142# check we are in a valid source file if not then ignore this hunk
2143 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
2144
6cd7f386 2145#line length limit
c45dcabd 2146 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
f4c014c0 2147 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
0fccc622 2148 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
8bbea968 2149 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
6cd7f386 2150 $length > $max_line_length)
c45dcabd 2151 {
000d1cc1 2152 WARN("LONG_LINE",
6cd7f386 2153 "line over $max_line_length characters\n" . $herecurr);
0a920b5b
AW
2154 }
2155
ca56dc09 2156# Check for user-visible strings broken across lines, which breaks the ability
8c5fcd24
JP
2157# to grep for the string. Make exceptions when the previous string ends in a
2158# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2159# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
ca56dc09
JT
2160 if ($line =~ /^\+\s*"/ &&
2161 $prevline =~ /"\s*$/ &&
8c5fcd24 2162 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
ca56dc09
JT
2163 WARN("SPLIT_STRING",
2164 "quoted string split across lines\n" . $hereprev);
2165 }
2166
5e79d96e
JP
2167# check for spaces before a quoted newline
2168 if ($rawline =~ /^.*\".*\s\\n/) {
3705ce5b
JP
2169 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
2170 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
2171 $fix) {
2172 $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
2173 }
2174
5e79d96e
JP
2175 }
2176
8905a67c
AW
2177# check for adding lines without a newline.
2178 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
000d1cc1
JP
2179 WARN("MISSING_EOF_NEWLINE",
2180 "adding a line without newline at end of file\n" . $herecurr);
8905a67c
AW
2181 }
2182
42e41c54
MF
2183# Blackfin: use hi/lo macros
2184 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2185 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2186 my $herevet = "$here\n" . cat_vet($line) . "\n";
000d1cc1
JP
2187 ERROR("LO_MACRO",
2188 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
42e41c54
MF
2189 }
2190 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2191 my $herevet = "$here\n" . cat_vet($line) . "\n";
000d1cc1
JP
2192 ERROR("HI_MACRO",
2193 "use the HI() macro, not (... >> 16)\n" . $herevet);
42e41c54
MF
2194 }
2195 }
2196
b9ea10d6
AW
2197# check we are in a valid source file C or perl if not then ignore this hunk
2198 next if ($realfile !~ /\.(h|c|pl)$/);
0a920b5b
AW
2199
2200# at the beginning of a line any tabs must come first and anything
2201# more than 8 must use tabs.
c2fdda0d
AW
2202 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2203 $rawline =~ /^\+\s* \s*/) {
2204 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
d2c0a235 2205 $rpt_cleaners = 1;
3705ce5b
JP
2206 if (ERROR("CODE_INDENT",
2207 "code indent should use tabs where possible\n" . $herevet) &&
2208 $fix) {
2209 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2210 }
0a920b5b
AW
2211 }
2212
08e44365
AP
2213# check for space before tabs.
2214 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2215 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3705ce5b
JP
2216 if (WARN("SPACE_BEFORE_TAB",
2217 "please, no space before tabs\n" . $herevet) &&
2218 $fix) {
c76f4cb3
JP
2219 while ($fixed[$linenr - 1] =~
2220 s/(^\+.*) {8,8}+\t/$1\t\t/) {}
2221 while ($fixed[$linenr - 1] =~
2222 s/(^\+.*) +\t/$1\t/) {}
3705ce5b 2223 }
08e44365
AP
2224 }
2225
d1fe9c09
JP
2226# check for && or || at the start of a line
2227 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2228 CHK("LOGICAL_CONTINUATIONS",
2229 "Logical continuations should be on the previous line\n" . $hereprev);
2230 }
2231
2232# check multi-line statement indentation matches previous line
2233 if ($^V && $^V ge 5.10.0 &&
91cb5195 2234 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
d1fe9c09
JP
2235 $prevline =~ /^\+(\t*)(.*)$/;
2236 my $oldindent = $1;
2237 my $rest = $2;
2238
2239 my $pos = pos_last_openparen($rest);
2240 if ($pos >= 0) {
b34a26f3
JP
2241 $line =~ /^(\+| )([ \t]*)/;
2242 my $newindent = $2;
d1fe9c09
JP
2243
2244 my $goodtabindent = $oldindent .
2245 "\t" x ($pos / 8) .
2246 " " x ($pos % 8);
2247 my $goodspaceindent = $oldindent . " " x $pos;
2248
2249 if ($newindent ne $goodtabindent &&
2250 $newindent ne $goodspaceindent) {
3705ce5b
JP
2251
2252 if (CHK("PARENTHESIS_ALIGNMENT",
2253 "Alignment should match open parenthesis\n" . $hereprev) &&
2254 $fix && $line =~ /^\+/) {
2255 $fixed[$linenr - 1] =~
2256 s/^\+[ \t]*/\+$goodtabindent/;
2257 }
d1fe9c09
JP
2258 }
2259 }
2260 }
2261
23f780c9 2262 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
3705ce5b
JP
2263 if (CHK("SPACING",
2264 "No space is necessary after a cast\n" . $hereprev) &&
2265 $fix) {
2266 $fixed[$linenr - 1] =~
2267 s/^(\+.*\*[ \t]*\))[ \t]+/$1/;
2268 }
aad4f614
JP
2269 }
2270
05880600 2271 if ($realfile =~ m@^(drivers/net/|net/)@ &&
fdb4bcd6 2272 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
85ad978c
JP
2273 $rawline =~ /^\+[ \t]*\*/ &&
2274 $realline > 2) {
05880600
JP
2275 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2276 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2277 }
2278
2279 if ($realfile =~ m@^(drivers/net/|net/)@ &&
a605e32e
JP
2280 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2281 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
61135e96 2282 $rawline =~ /^\+/ && #line is new
a605e32e
JP
2283 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2284 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2285 "networking block comments start with * on subsequent lines\n" . $hereprev);
2286 }
2287
2288 if ($realfile =~ m@^(drivers/net/|net/)@ &&
c24f9f19
JP
2289 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2290 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2291 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2292 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
05880600
JP
2293 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2294 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2295 }
2296
7f619191
JP
2297# check for missing blank lines after struct/union declarations
2298# with exceptions for various attributes and macros
2299 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2300 $line =~ /^\+/ &&
2301 !($line =~ /^\+\s*$/ ||
2302 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2303 $line =~ /^\+\s*MODULE_/i ||
2304 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2305 $line =~ /^\+[a-z_]*init/ ||
2306 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2307 $line =~ /^\+\s*DECLARE/ ||
2308 $line =~ /^\+\s*__setup/)) {
2309 CHK("LINE_SPACING",
2310 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev);
2311 }
2312
365dd4ea
JP
2313# check for multiple consecutive blank lines
2314 if ($prevline =~ /^[\+ ]\s*$/ &&
2315 $line =~ /^\+\s*$/ &&
2316 $last_blank_line != ($linenr - 1)) {
2317 CHK("LINE_SPACING",
2318 "Please don't use multiple blank lines\n" . $hereprev);
2319 $last_blank_line = $linenr;
2320 }
2321
3b617e3b 2322# check for missing blank lines after declarations
3f7bac03
JP
2323 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2324 # actual declarations
2325 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
5a4e1fd3
JP
2326 # function pointer declarations
2327 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3f7bac03
JP
2328 # foo bar; where foo is some local typedef or #define
2329 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2330 # known declaration macros
2331 $prevline =~ /^\+\s+$declaration_macros/) &&
2332 # for "else if" which can look like "$Ident $Ident"
2333 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2334 # other possible extensions of declaration lines
2335 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2336 # not starting a section or a macro "\" extended line
2337 $prevline =~ /(?:\{\s*|\\)$/) &&
2338 # looks like a declaration
2339 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
5a4e1fd3
JP
2340 # function pointer declarations
2341 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3f7bac03
JP
2342 # foo bar; where foo is some local typedef or #define
2343 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2344 # known declaration macros
2345 $sline =~ /^\+\s+$declaration_macros/ ||
2346 # start of struct or union or enum
3b617e3b 2347 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
3f7bac03
JP
2348 # start or end of block or continuation of declaration
2349 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2350 # bitfield continuation
2351 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2352 # other possible extensions of declaration lines
2353 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2354 # indentation of previous and current line are the same
2355 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
fee0aa83 2356 WARN("LINE_SPACING",
3f7bac03 2357 "Missing a blank line after declarations\n" . $hereprev);
3b617e3b
JP
2358 }
2359
5f7ddae6 2360# check for spaces at the beginning of a line.
6b4c5beb
AW
2361# Exceptions:
2362# 1) within comments
2363# 2) indented preprocessor commands
2364# 3) hanging labels
3705ce5b 2365 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
5f7ddae6 2366 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3705ce5b
JP
2367 if (WARN("LEADING_SPACE",
2368 "please, no spaces at the start of a line\n" . $herevet) &&
2369 $fix) {
2370 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2371 }
5f7ddae6
RR
2372 }
2373
b9ea10d6
AW
2374# check we are in a valid C source file if not then ignore this hunk
2375 next if ($realfile !~ /\.(h|c)$/);
2376
032a4c0f
JP
2377# check indentation of any line with a bare else
2378# if the previous line is a break or return and is indented 1 tab more...
2379 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2380 my $tabs = length($1) + 1;
2381 if ($prevline =~ /^\+\t{$tabs,$tabs}(?:break|return)\b/) {
2382 WARN("UNNECESSARY_ELSE",
2383 "else is not generally useful after a break or return\n" . $hereprev);
2384 }
2385 }
2386
1ba8dfd1
KC
2387# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2388 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2389 WARN("CONFIG_EXPERIMENTAL",
2390 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2391 }
2392
c2fdda0d 2393# check for RCS/CVS revision markers
cf655043 2394 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
000d1cc1
JP
2395 WARN("CVS_KEYWORD",
2396 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
c2fdda0d 2397 }
22f2a2ef 2398
42e41c54
MF
2399# Blackfin: don't use __builtin_bfin_[cs]sync
2400 if ($line =~ /__builtin_bfin_csync/) {
2401 my $herevet = "$here\n" . cat_vet($line) . "\n";
000d1cc1
JP
2402 ERROR("CSYNC",
2403 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
42e41c54
MF
2404 }
2405 if ($line =~ /__builtin_bfin_ssync/) {
2406 my $herevet = "$here\n" . cat_vet($line) . "\n";
000d1cc1
JP
2407 ERROR("SSYNC",
2408 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
42e41c54
MF
2409 }
2410
56e77d70
JP
2411# check for old HOTPLUG __dev<foo> section markings
2412 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2413 WARN("HOTPLUG_SECTION",
2414 "Using $1 is unnecessary\n" . $herecurr);
2415 }
2416
9c0ca6f9 2417# Check for potential 'bare' types
2b474a1a
AW
2418 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2419 $realline_next);
3e469cdc
AW
2420#print "LINE<$line>\n";
2421 if ($linenr >= $suppress_statement &&
1b5539b1 2422 $realcnt && $sline =~ /.\s*\S/) {
170d3a22 2423 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
f5fe35dd 2424 ctx_statement_block($linenr, $realcnt, 0);
171ae1a4
AW
2425 $stat =~ s/\n./\n /g;
2426 $cond =~ s/\n./\n /g;
2427
3e469cdc
AW
2428#print "linenr<$linenr> <$stat>\n";
2429 # If this statement has no statement boundaries within
2430 # it there is no point in retrying a statement scan
2431 # until we hit end of it.
2432 my $frag = $stat; $frag =~ s/;+\s*$//;
2433 if ($frag !~ /(?:{|;)/) {
2434#print "skip<$line_nr_next>\n";
2435 $suppress_statement = $line_nr_next;
2436 }
f74bd194 2437
2b474a1a
AW
2438 # Find the real next line.
2439 $realline_next = $line_nr_next;
2440 if (defined $realline_next &&
2441 (!defined $lines[$realline_next - 1] ||
2442 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2443 $realline_next++;
2444 }
2445
171ae1a4
AW
2446 my $s = $stat;
2447 $s =~ s/{.*$//s;
cf655043 2448
c2fdda0d 2449 # Ignore goto labels.
171ae1a4 2450 if ($s =~ /$Ident:\*$/s) {
c2fdda0d
AW
2451
2452 # Ignore functions being called
171ae1a4 2453 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
c2fdda0d 2454
463f2864
AW
2455 } elsif ($s =~ /^.\s*else\b/s) {
2456
c45dcabd 2457 # declarations always start with types
d2506586 2458 } 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
2459 my $type = $1;
2460 $type =~ s/\s+/ /g;
2461 possible($type, "A:" . $s);
2462
8905a67c 2463 # definitions in global scope can only start with types
a6a84062 2464 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
c45dcabd 2465 possible($1, "B:" . $s);
c2fdda0d 2466 }
8905a67c
AW
2467
2468 # any (foo ... *) is a pointer cast, and foo is a type
65863862 2469 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
c45dcabd 2470 possible($1, "C:" . $s);
8905a67c
AW
2471 }
2472
2473 # Check for any sort of function declaration.
2474 # int foo(something bar, other baz);
2475 # void (*store_gdt)(x86_descr_ptr *);
171ae1a4 2476 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
8905a67c 2477 my ($name_len) = length($1);
8905a67c 2478
cf655043 2479 my $ctx = $s;
773647a0 2480 substr($ctx, 0, $name_len + 1, '');
8905a67c 2481 $ctx =~ s/\)[^\)]*$//;
cf655043 2482
8905a67c 2483 for my $arg (split(/\s*,\s*/, $ctx)) {
c45dcabd 2484 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
8905a67c 2485
c45dcabd 2486 possible($1, "D:" . $s);
8905a67c
AW
2487 }
2488 }
9c0ca6f9 2489 }
8905a67c 2490
9c0ca6f9
AW
2491 }
2492
653d4876
AW
2493#
2494# Checks which may be anchored in the context.
2495#
00df344f 2496
653d4876
AW
2497# Check for switch () and associated case and default
2498# statements should be at the same indent.
00df344f
AW
2499 if ($line=~/\bswitch\s*\(.*\)/) {
2500 my $err = '';
2501 my $sep = '';
2502 my @ctx = ctx_block_outer($linenr, $realcnt);
2503 shift(@ctx);
2504 for my $ctx (@ctx) {
2505 my ($clen, $cindent) = line_stats($ctx);
2506 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2507 $indent != $cindent) {
2508 $err .= "$sep$ctx\n";
2509 $sep = '';
2510 } else {
2511 $sep = "[...]\n";
2512 }
2513 }
2514 if ($err ne '') {
000d1cc1
JP
2515 ERROR("SWITCH_CASE_INDENT_LEVEL",
2516 "switch and case should be at the same indent\n$hereline$err");
de7d4f0e
AW
2517 }
2518 }
2519
2520# if/while/etc brace do not go on next line, unless defining a do while loop,
2521# or if that brace on the next line is for something else
c45dcabd 2522 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
773647a0
AW
2523 my $pre_ctx = "$1$2";
2524
9c0ca6f9 2525 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
8eef05dd
JP
2526
2527 if ($line =~ /^\+\t{6,}/) {
2528 WARN("DEEP_INDENTATION",
2529 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2530 }
2531
de7d4f0e
AW
2532 my $ctx_cnt = $realcnt - $#ctx - 1;
2533 my $ctx = join("\n", @ctx);
2534
548596d5
AW
2535 my $ctx_ln = $linenr;
2536 my $ctx_skip = $realcnt;
773647a0 2537
548596d5
AW
2538 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2539 defined $lines[$ctx_ln - 1] &&
2540 $lines[$ctx_ln - 1] =~ /^-/)) {
2541 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2542 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
de7d4f0e 2543 $ctx_ln++;
de7d4f0e 2544 }
548596d5 2545
53210168
AW
2546 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2547 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
de7d4f0e 2548
773647a0 2549 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
000d1cc1
JP
2550 ERROR("OPEN_BRACE",
2551 "that open brace { should be on the previous line\n" .
01464f30 2552 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
00df344f 2553 }
773647a0
AW
2554 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2555 $ctx =~ /\)\s*\;\s*$/ &&
2556 defined $lines[$ctx_ln - 1])
2557 {
9c0ca6f9
AW
2558 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2559 if ($nindent > $indent) {
000d1cc1
JP
2560 WARN("TRAILING_SEMICOLON",
2561 "trailing semicolon indicates no statements, indent implies otherwise\n" .
01464f30 2562 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
9c0ca6f9
AW
2563 }
2564 }
00df344f
AW
2565 }
2566
4d001e4d
AW
2567# Check relative indent for conditionals and blocks.
2568 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3e469cdc
AW
2569 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2570 ctx_statement_block($linenr, $realcnt, 0)
2571 if (!defined $stat);
4d001e4d
AW
2572 my ($s, $c) = ($stat, $cond);
2573
2574 substr($s, 0, length($c), '');
2575
2576 # Make sure we remove the line prefixes as we have
2577 # none on the first line, and are going to readd them
2578 # where necessary.
2579 $s =~ s/\n./\n/gs;
2580
2581 # Find out how long the conditional actually is.
6f779c18
AW
2582 my @newlines = ($c =~ /\n/gs);
2583 my $cond_lines = 1 + $#newlines;
4d001e4d
AW
2584
2585 # We want to check the first line inside the block
2586 # starting at the end of the conditional, so remove:
2587 # 1) any blank line termination
2588 # 2) any opening brace { on end of the line
2589 # 3) any do (...) {
2590 my $continuation = 0;
2591 my $check = 0;
2592 $s =~ s/^.*\bdo\b//;
2593 $s =~ s/^\s*{//;
2594 if ($s =~ s/^\s*\\//) {
2595 $continuation = 1;
2596 }
9bd49efe 2597 if ($s =~ s/^\s*?\n//) {
4d001e4d
AW
2598 $check = 1;
2599 $cond_lines++;
2600 }
2601
2602 # Also ignore a loop construct at the end of a
2603 # preprocessor statement.
2604 if (($prevline =~ /^.\s*#\s*define\s/ ||
2605 $prevline =~ /\\\s*$/) && $continuation == 0) {
2606 $check = 0;
2607 }
2608
9bd49efe 2609 my $cond_ptr = -1;
740504c6 2610 $continuation = 0;
9bd49efe
AW
2611 while ($cond_ptr != $cond_lines) {
2612 $cond_ptr = $cond_lines;
2613
f16fa28f
AW
2614 # If we see an #else/#elif then the code
2615 # is not linear.
2616 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2617 $check = 0;
2618 }
2619
9bd49efe
AW
2620 # Ignore:
2621 # 1) blank lines, they should be at 0,
2622 # 2) preprocessor lines, and
2623 # 3) labels.
740504c6
AW
2624 if ($continuation ||
2625 $s =~ /^\s*?\n/ ||
9bd49efe
AW
2626 $s =~ /^\s*#\s*?/ ||
2627 $s =~ /^\s*$Ident\s*:/) {
740504c6 2628 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
30dad6eb
AW
2629 if ($s =~ s/^.*?\n//) {
2630 $cond_lines++;
2631 }
9bd49efe 2632 }
4d001e4d
AW
2633 }
2634
2635 my (undef, $sindent) = line_stats("+" . $s);
2636 my $stat_real = raw_line($linenr, $cond_lines);
2637
2638 # Check if either of these lines are modified, else
2639 # this is not this patch's fault.
2640 if (!defined($stat_real) ||
2641 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2642 $check = 0;
2643 }
2644 if (defined($stat_real) && $cond_lines > 1) {
2645 $stat_real = "[...]\n$stat_real";
2646 }
2647
9bd49efe 2648 #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
2649
2650 if ($check && (($sindent % 8) != 0 ||
2651 ($sindent <= $indent && $s ne ''))) {
000d1cc1
JP
2652 WARN("SUSPECT_CODE_INDENT",
2653 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
4d001e4d
AW
2654 }
2655 }
2656
6c72ffaa
AW
2657 # Track the 'values' across context and added lines.
2658 my $opline = $line; $opline =~ s/^./ /;
1f65f947
AW
2659 my ($curr_values, $curr_vars) =
2660 annotate_values($opline . "\n", $prev_values);
6c72ffaa 2661 $curr_values = $prev_values . $curr_values;
c2fdda0d
AW
2662 if ($dbg_values) {
2663 my $outline = $opline; $outline =~ s/\t/ /g;
cf655043
AW
2664 print "$linenr > .$outline\n";
2665 print "$linenr > $curr_values\n";
1f65f947 2666 print "$linenr > $curr_vars\n";
c2fdda0d 2667 }
6c72ffaa
AW
2668 $prev_values = substr($curr_values, -1);
2669
00df344f 2670#ignore lines not being added
3705ce5b 2671 next if ($line =~ /^[^\+]/);
00df344f 2672
653d4876 2673# TEST: allow direct testing of the type matcher.
7429c690
AW
2674 if ($dbg_type) {
2675 if ($line =~ /^.\s*$Declare\s*$/) {
000d1cc1
JP
2676 ERROR("TEST_TYPE",
2677 "TEST: is type\n" . $herecurr);
7429c690 2678 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
000d1cc1
JP
2679 ERROR("TEST_NOT_TYPE",
2680 "TEST: is not type ($1 is)\n". $herecurr);
7429c690 2681 }
653d4876
AW
2682 next;
2683 }
a1ef277e
AW
2684# TEST: allow direct testing of the attribute matcher.
2685 if ($dbg_attr) {
9360b0e5 2686 if ($line =~ /^.\s*$Modifier\s*$/) {
000d1cc1
JP
2687 ERROR("TEST_ATTR",
2688 "TEST: is attr\n" . $herecurr);
9360b0e5 2689 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
000d1cc1
JP
2690 ERROR("TEST_NOT_ATTR",
2691 "TEST: is not attr ($1 is)\n". $herecurr);
a1ef277e
AW
2692 }
2693 next;
2694 }
653d4876 2695
f0a594c1 2696# check for initialisation to aggregates open brace on the next line
99423c20
AW
2697 if ($line =~ /^.\s*{/ &&
2698 $prevline =~ /(?:^|[^=])=\s*$/) {
000d1cc1
JP
2699 ERROR("OPEN_BRACE",
2700 "that open brace { should be on the previous line\n" . $hereprev);
f0a594c1
AW
2701 }
2702
653d4876
AW
2703#
2704# Checks which are anchored on the added line.
2705#
2706
2707# check for malformed paths in #include statements (uses RAW line)
c45dcabd 2708 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
653d4876
AW
2709 my $path = $1;
2710 if ($path =~ m{//}) {
000d1cc1 2711 ERROR("MALFORMED_INCLUDE",
495e9d84
JP
2712 "malformed #include filename\n" . $herecurr);
2713 }
2714 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2715 ERROR("UAPI_INCLUDE",
2716 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
653d4876 2717 }
653d4876 2718 }
00df344f 2719
0a920b5b 2720# no C99 // comments
00df344f 2721 if ($line =~ m{//}) {
3705ce5b
JP
2722 if (ERROR("C99_COMMENTS",
2723 "do not use C99 // comments\n" . $herecurr) &&
2724 $fix) {
2725 my $line = $fixed[$linenr - 1];
2726 if ($line =~ /\/\/(.*)$/) {
2727 my $comment = trim($1);
2728 $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@;
2729 }
2730 }
0a920b5b 2731 }
00df344f 2732 # Remove C99 comments.
0a920b5b 2733 $line =~ s@//.*@@;
6c72ffaa 2734 $opline =~ s@//.*@@;
0a920b5b 2735
2b474a1a
AW
2736# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2737# the whole statement.
2738#print "APW <$lines[$realline_next - 1]>\n";
2739 if (defined $realline_next &&
2740 exists $lines[$realline_next - 1] &&
2741 !defined $suppress_export{$realline_next} &&
2742 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2743 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3cbf62df
AW
2744 # Handle definitions which produce identifiers with
2745 # a prefix:
2746 # XXX(foo);
2747 # EXPORT_SYMBOL(something_foo);
653d4876 2748 my $name = $1;
87a53877 2749 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3cbf62df
AW
2750 $name =~ /^${Ident}_$2/) {
2751#print "FOO C name<$name>\n";
2752 $suppress_export{$realline_next} = 1;
2753
2754 } elsif ($stat !~ /(?:
2b474a1a 2755 \n.}\s*$|
48012058
AW
2756 ^.DEFINE_$Ident\(\Q$name\E\)|
2757 ^.DECLARE_$Ident\(\Q$name\E\)|
2758 ^.LIST_HEAD\(\Q$name\E\)|
2b474a1a
AW
2759 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2760 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
48012058 2761 )/x) {
2b474a1a
AW
2762#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2763 $suppress_export{$realline_next} = 2;
2764 } else {
2765 $suppress_export{$realline_next} = 1;
0a920b5b
AW
2766 }
2767 }
2b474a1a
AW
2768 if (!defined $suppress_export{$linenr} &&
2769 $prevline =~ /^.\s*$/ &&
2770 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2771 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2772#print "FOO B <$lines[$linenr - 1]>\n";
2773 $suppress_export{$linenr} = 2;
2774 }
2775 if (defined $suppress_export{$linenr} &&
2776 $suppress_export{$linenr} == 2) {
000d1cc1
JP
2777 WARN("EXPORT_SYMBOL",
2778 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2b474a1a 2779 }
0a920b5b 2780
5150bda4 2781# check for global initialisers.
d5e616fc
JP
2782 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
2783 if (ERROR("GLOBAL_INITIALISERS",
2784 "do not initialise globals to 0 or NULL\n" .
2785 $herecurr) &&
2786 $fix) {
2787 $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
2788 }
f0a594c1 2789 }
653d4876 2790# check for static initialisers.
d5e616fc
JP
2791 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2792 if (ERROR("INITIALISED_STATIC",
2793 "do not initialise statics to 0 or NULL\n" .
2794 $herecurr) &&
2795 $fix) {
2796 $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
2797 }
0a920b5b
AW
2798 }
2799
cb710eca
JP
2800# check for static const char * arrays.
2801 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
000d1cc1
JP
2802 WARN("STATIC_CONST_CHAR_ARRAY",
2803 "static const char * array should probably be static const char * const\n" .
cb710eca
JP
2804 $herecurr);
2805 }
2806
2807# check for static char foo[] = "bar" declarations.
2808 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
000d1cc1
JP
2809 WARN("STATIC_CONST_CHAR_ARRAY",
2810 "static char array declaration should probably be static const char\n" .
cb710eca
JP
2811 $herecurr);
2812 }
2813
9b0fa60d
JP
2814# check for non-global char *foo[] = {"bar", ...} declarations.
2815 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
2816 WARN("STATIC_CONST_CHAR_ARRAY",
2817 "char * array declaration might be better as static const\n" .
2818 $herecurr);
2819 }
2820
b36190c5
JP
2821# check for function declarations without arguments like "int foo()"
2822 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
2823 if (ERROR("FUNCTION_WITHOUT_ARGS",
2824 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
2825 $fix) {
2826 $fixed[$linenr - 1] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
2827 }
2828 }
2829
92e112fd
JP
2830# check for uses of DEFINE_PCI_DEVICE_TABLE
2831 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
2832 if (WARN("DEFINE_PCI_DEVICE_TABLE",
2833 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
2834 $fix) {
2835 $fixed[$linenr - 1] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
2836 }
93ed0e2d
JP
2837 }
2838
653d4876
AW
2839# check for new typedefs, only function parameters and sparse annotations
2840# make sense.
2841 if ($line =~ /\btypedef\s/ &&
8054576d 2842 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
c45dcabd 2843 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
8ed22cad 2844 $line !~ /\b$typeTypedefs\b/ &&
653d4876 2845 $line !~ /\b__bitwise(?:__|)\b/) {
000d1cc1
JP
2846 WARN("NEW_TYPEDEFS",
2847 "do not add new typedefs\n" . $herecurr);
0a920b5b
AW
2848 }
2849
2850# * goes on variable not on type
65863862 2851 # (char*[ const])
bfcb2cc7
AW
2852 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2853 #print "AA<$1>\n";
3705ce5b 2854 my ($ident, $from, $to) = ($1, $2, $2);
65863862
AW
2855
2856 # Should start with a space.
2857 $to =~ s/^(\S)/ $1/;
2858 # Should not end with a space.
2859 $to =~ s/\s+$//;
2860 # '*'s should not have spaces between.
f9a0b3d1 2861 while ($to =~ s/\*\s+\*/\*\*/) {
65863862 2862 }
d8aaf121 2863
3705ce5b 2864## print "1: from<$from> to<$to> ident<$ident>\n";
65863862 2865 if ($from ne $to) {
3705ce5b
JP
2866 if (ERROR("POINTER_LOCATION",
2867 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
2868 $fix) {
2869 my $sub_from = $ident;
2870 my $sub_to = $ident;
2871 $sub_to =~ s/\Q$from\E/$to/;
2872 $fixed[$linenr - 1] =~
2873 s@\Q$sub_from\E@$sub_to@;
2874 }
65863862 2875 }
bfcb2cc7
AW
2876 }
2877 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2878 #print "BB<$1>\n";
3705ce5b 2879 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
65863862
AW
2880
2881 # Should start with a space.
2882 $to =~ s/^(\S)/ $1/;
2883 # Should not end with a space.
2884 $to =~ s/\s+$//;
2885 # '*'s should not have spaces between.
f9a0b3d1 2886 while ($to =~ s/\*\s+\*/\*\*/) {
65863862
AW
2887 }
2888 # Modifiers should have spaces.
2889 $to =~ s/(\b$Modifier$)/$1 /;
d8aaf121 2890
3705ce5b 2891## print "2: from<$from> to<$to> ident<$ident>\n";
667026e7 2892 if ($from ne $to && $ident !~ /^$Modifier$/) {
3705ce5b
JP
2893 if (ERROR("POINTER_LOCATION",
2894 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
2895 $fix) {
2896
2897 my $sub_from = $match;
2898 my $sub_to = $match;
2899 $sub_to =~ s/\Q$from\E/$to/;
2900 $fixed[$linenr - 1] =~
2901 s@\Q$sub_from\E@$sub_to@;
2902 }
65863862 2903 }
0a920b5b
AW
2904 }
2905
2906# # no BUG() or BUG_ON()
2907# if ($line =~ /\b(BUG|BUG_ON)\b/) {
2908# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2909# print "$herecurr";
2910# $clean = 0;
2911# }
2912
8905a67c 2913 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
000d1cc1
JP
2914 WARN("LINUX_VERSION_CODE",
2915 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
8905a67c
AW
2916 }
2917
17441227
JP
2918# check for uses of printk_ratelimit
2919 if ($line =~ /\bprintk_ratelimit\s*\(/) {
000d1cc1
JP
2920 WARN("PRINTK_RATELIMITED",
2921"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
17441227
JP
2922 }
2923
00df344f
AW
2924# printk should use KERN_* levels. Note that follow on printk's on the
2925# same line do not need a level, so we use the current block context
2926# to try and find and validate the current printk. In summary the current
25985edc 2927# printk includes all preceding printk's which have no newline on the end.
00df344f 2928# we assume the first bad printk is the one to report.
f0a594c1 2929 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
00df344f
AW
2930 my $ok = 0;
2931 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2932 #print "CHECK<$lines[$ln - 1]\n";
25985edc 2933 # we have a preceding printk if it ends
00df344f
AW
2934 # with "\n" ignore it, else it is to blame
2935 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2936 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2937 $ok = 1;
2938 }
2939 last;
2940 }
2941 }
2942 if ($ok == 0) {
000d1cc1
JP
2943 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2944 "printk() should include KERN_ facility level\n" . $herecurr);
00df344f 2945 }
0a920b5b
AW
2946 }
2947
243f3803
JP
2948 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2949 my $orig = $1;
2950 my $level = lc($orig);
2951 $level = "warn" if ($level eq "warning");
8f26b837
JP
2952 my $level2 = $level;
2953 $level2 = "dbg" if ($level eq "debug");
243f3803 2954 WARN("PREFER_PR_LEVEL",
daa8b059 2955 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
243f3803
JP
2956 }
2957
2958 if ($line =~ /\bpr_warning\s*\(/) {
d5e616fc
JP
2959 if (WARN("PREFER_PR_LEVEL",
2960 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
2961 $fix) {
2962 $fixed[$linenr - 1] =~
2963 s/\bpr_warning\b/pr_warn/;
2964 }
243f3803
JP
2965 }
2966
dc139313
JP
2967 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
2968 my $orig = $1;
2969 my $level = lc($orig);
2970 $level = "warn" if ($level eq "warning");
2971 $level = "dbg" if ($level eq "debug");
2972 WARN("PREFER_DEV_LEVEL",
2973 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
2974 }
2975
653d4876
AW
2976# function brace can't be on same line, except for #defines of do while,
2977# or if closed on same line
c45dcabd
AW
2978 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2979 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
000d1cc1
JP
2980 ERROR("OPEN_BRACE",
2981 "open brace '{' following function declarations go on the next line\n" . $herecurr);
0a920b5b 2982 }
653d4876 2983
8905a67c
AW
2984# open braces for enum, union and struct go on the same line.
2985 if ($line =~ /^.\s*{/ &&
2986 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
000d1cc1
JP
2987 ERROR("OPEN_BRACE",
2988 "open brace '{' following $1 go on the same line\n" . $hereprev);
8905a67c
AW
2989 }
2990
0c73b4eb 2991# missing space after union, struct or enum definition
3705ce5b
JP
2992 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
2993 if (WARN("SPACING",
2994 "missing space after $1 definition\n" . $herecurr) &&
2995 $fix) {
2996 $fixed[$linenr - 1] =~
2997 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
2998 }
0c73b4eb
AW
2999 }
3000
31070b5d
JP
3001# Function pointer declarations
3002# check spacing between type, funcptr, and args
3003# canonical declaration is "type (*funcptr)(args...)"
91f72e9c 3004 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
31070b5d
JP
3005 my $declare = $1;
3006 my $pre_pointer_space = $2;
3007 my $post_pointer_space = $3;
3008 my $funcname = $4;
3009 my $post_funcname_space = $5;
3010 my $pre_args_space = $6;
3011
91f72e9c
JP
3012# the $Declare variable will capture all spaces after the type
3013# so check it for a missing trailing missing space but pointer return types
3014# don't need a space so don't warn for those.
3015 my $post_declare_space = "";
3016 if ($declare =~ /(\s+)$/) {
3017 $post_declare_space = $1;
3018 $declare = rtrim($declare);
3019 }
3020 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
31070b5d
JP
3021 WARN("SPACING",
3022 "missing space after return type\n" . $herecurr);
91f72e9c 3023 $post_declare_space = " ";
31070b5d
JP
3024 }
3025
3026# unnecessary space "type (*funcptr)(args...)"
91f72e9c
JP
3027# This test is not currently implemented because these declarations are
3028# equivalent to
3029# int foo(int bar, ...)
3030# and this is form shouldn't/doesn't generate a checkpatch warning.
3031#
3032# elsif ($declare =~ /\s{2,}$/) {
3033# WARN("SPACING",
3034# "Multiple spaces after return type\n" . $herecurr);
3035# }
31070b5d
JP
3036
3037# unnecessary space "type ( *funcptr)(args...)"
3038 if (defined $pre_pointer_space &&
3039 $pre_pointer_space =~ /^\s/) {
3040 WARN("SPACING",
3041 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3042 }
3043
3044# unnecessary space "type (* funcptr)(args...)"
3045 if (defined $post_pointer_space &&
3046 $post_pointer_space =~ /^\s/) {
3047 WARN("SPACING",
3048 "Unnecessary space before function pointer name\n" . $herecurr);
3049 }
3050
3051# unnecessary space "type (*funcptr )(args...)"
3052 if (defined $post_funcname_space &&
3053 $post_funcname_space =~ /^\s/) {
3054 WARN("SPACING",
3055 "Unnecessary space after function pointer name\n" . $herecurr);
3056 }
3057
3058# unnecessary space "type (*funcptr) (args...)"
3059 if (defined $pre_args_space &&
3060 $pre_args_space =~ /^\s/) {
3061 WARN("SPACING",
3062 "Unnecessary space before function pointer arguments\n" . $herecurr);
3063 }
3064
3065 if (show_type("SPACING") && $fix) {
3066 $fixed[$linenr - 1] =~
91f72e9c 3067 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
31070b5d
JP
3068 }
3069 }
3070
8d31cfce
AW
3071# check for spacing round square brackets; allowed:
3072# 1. with a type on the left -- int [] a;
fe2a7dbc
AW
3073# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3074# 3. inside a curly brace -- = { [0...10] = 5 }
8d31cfce
AW
3075 while ($line =~ /(.*?\s)\[/g) {
3076 my ($where, $prefix) = ($-[1], $1);
3077 if ($prefix !~ /$Type\s+$/ &&
fe2a7dbc 3078 ($where != 0 || $prefix !~ /^.\s+$/) &&
daebc534 3079 $prefix !~ /[{,]\s+$/) {
3705ce5b
JP
3080 if (ERROR("BRACKET_SPACE",
3081 "space prohibited before open square bracket '['\n" . $herecurr) &&
3082 $fix) {
3083 $fixed[$linenr - 1] =~
3084 s/^(\+.*?)\s+\[/$1\[/;
3085 }
8d31cfce
AW
3086 }
3087 }
3088
f0a594c1 3089# check for spaces between functions and their parentheses.
6c72ffaa 3090 while ($line =~ /($Ident)\s+\(/g) {
c2fdda0d 3091 my $name = $1;
773647a0
AW
3092 my $ctx_before = substr($line, 0, $-[1]);
3093 my $ctx = "$ctx_before$name";
c2fdda0d
AW
3094
3095 # Ignore those directives where spaces _are_ permitted.
773647a0
AW
3096 if ($name =~ /^(?:
3097 if|for|while|switch|return|case|
3098 volatile|__volatile__|
3099 __attribute__|format|__extension__|
3100 asm|__asm__)$/x)
3101 {
c2fdda0d
AW
3102 # cpp #define statements have non-optional spaces, ie
3103 # if there is a space between the name and the open
3104 # parenthesis it is simply not a parameter group.
c45dcabd 3105 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
773647a0
AW
3106
3107 # cpp #elif statement condition may start with a (
c45dcabd 3108 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
c2fdda0d
AW
3109
3110 # If this whole things ends with a type its most
3111 # likely a typedef for a function.
773647a0 3112 } elsif ($ctx =~ /$Type$/) {
c2fdda0d
AW
3113
3114 } else {
3705ce5b
JP
3115 if (WARN("SPACING",
3116 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3117 $fix) {
3118 $fixed[$linenr - 1] =~
3119 s/\b$name\s+\(/$name\(/;
3120 }
6c72ffaa 3121 }
f0a594c1 3122 }
9a4cad4e 3123
653d4876 3124# Check operator spacing.
0a920b5b 3125 if (!($line=~/\#\s*include/)) {
3705ce5b
JP
3126 my $fixed_line = "";
3127 my $line_fixed = 0;
3128
9c0ca6f9
AW
3129 my $ops = qr{
3130 <<=|>>=|<=|>=|==|!=|
3131 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3132 =>|->|<<|>>|<|>|=|!|~|
1f65f947 3133 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
84731623 3134 \?:|\?|:
9c0ca6f9 3135 }x;
cf655043 3136 my @elements = split(/($ops|;)/, $opline);
3705ce5b
JP
3137
3138## print("element count: <" . $#elements . ">\n");
3139## foreach my $el (@elements) {
3140## print("el: <$el>\n");
3141## }
3142
3143 my @fix_elements = ();
00df344f 3144 my $off = 0;
6c72ffaa 3145
3705ce5b
JP
3146 foreach my $el (@elements) {
3147 push(@fix_elements, substr($rawline, $off, length($el)));
3148 $off += length($el);
3149 }
3150
3151 $off = 0;
3152
6c72ffaa 3153 my $blank = copy_spacing($opline);
b34c648b 3154 my $last_after = -1;
6c72ffaa 3155
0a920b5b 3156 for (my $n = 0; $n < $#elements; $n += 2) {
3705ce5b
JP
3157
3158 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3159
3160## print("n: <$n> good: <$good>\n");
3161
4a0df2ef
AW
3162 $off += length($elements[$n]);
3163
25985edc 3164 # Pick up the preceding and succeeding characters.
773647a0
AW
3165 my $ca = substr($opline, 0, $off);
3166 my $cc = '';
3167 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3168 $cc = substr($opline, $off + length($elements[$n + 1]));
3169 }
3170 my $cb = "$ca$;$cc";
3171
4a0df2ef
AW
3172 my $a = '';
3173 $a = 'V' if ($elements[$n] ne '');
3174 $a = 'W' if ($elements[$n] =~ /\s$/);
cf655043 3175 $a = 'C' if ($elements[$n] =~ /$;$/);
4a0df2ef
AW
3176 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3177 $a = 'O' if ($elements[$n] eq '');
773647a0 3178 $a = 'E' if ($ca =~ /^\s*$/);
4a0df2ef 3179
0a920b5b 3180 my $op = $elements[$n + 1];
4a0df2ef
AW
3181
3182 my $c = '';
0a920b5b 3183 if (defined $elements[$n + 2]) {
4a0df2ef
AW
3184 $c = 'V' if ($elements[$n + 2] ne '');
3185 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
cf655043 3186 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
4a0df2ef
AW
3187 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3188 $c = 'O' if ($elements[$n + 2] eq '');
8b1b3378 3189 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
4a0df2ef
AW
3190 } else {
3191 $c = 'E';
0a920b5b
AW
3192 }
3193
4a0df2ef
AW
3194 my $ctx = "${a}x${c}";
3195
3196 my $at = "(ctx:$ctx)";
3197
6c72ffaa 3198 my $ptr = substr($blank, 0, $off) . "^";
de7d4f0e 3199 my $hereptr = "$hereline$ptr\n";
0a920b5b 3200
74048ed8 3201 # Pull out the value of this operator.
6c72ffaa 3202 my $op_type = substr($curr_values, $off + 1, 1);
0a920b5b 3203
1f65f947
AW
3204 # Get the full operator variant.
3205 my $opv = $op . substr($curr_vars, $off, 1);
3206
13214adf
AW
3207 # Ignore operators passed as parameters.
3208 if ($op_type ne 'V' &&
3209 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3210
cf655043
AW
3211# # Ignore comments
3212# } elsif ($op =~ /^$;+$/) {
13214adf 3213
d8aaf121 3214 # ; should have either the end of line or a space or \ after it
13214adf 3215 } elsif ($op eq ';') {
cf655043
AW
3216 if ($ctx !~ /.x[WEBC]/ &&
3217 $cc !~ /^\\/ && $cc !~ /^;/) {
3705ce5b
JP
3218 if (ERROR("SPACING",
3219 "space required after that '$op' $at\n" . $hereptr)) {
b34c648b 3220 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3705ce5b
JP
3221 $line_fixed = 1;
3222 }
d8aaf121
AW
3223 }
3224
3225 # // is a comment
3226 } elsif ($op eq '//') {
0a920b5b 3227
b00e4814
JP
3228 # : when part of a bitfield
3229 } elsif ($opv eq ':B') {
3230 # skip the bitfield test for now
3231
1f65f947
AW
3232 # No spaces for:
3233 # ->
b00e4814 3234 } elsif ($op eq '->') {
4a0df2ef 3235 if ($ctx =~ /Wx.|.xW/) {
3705ce5b
JP
3236 if (ERROR("SPACING",
3237 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
b34c648b 3238 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3705ce5b
JP
3239 if (defined $fix_elements[$n + 2]) {
3240 $fix_elements[$n + 2] =~ s/^\s+//;
3241 }
b34c648b 3242 $line_fixed = 1;
3705ce5b 3243 }
0a920b5b
AW
3244 }
3245
3246 # , must have a space on the right.
3247 } elsif ($op eq ',') {
cf655043 3248 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
3705ce5b
JP
3249 if (ERROR("SPACING",
3250 "space required after that '$op' $at\n" . $hereptr)) {
b34c648b 3251 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3705ce5b 3252 $line_fixed = 1;
b34c648b 3253 $last_after = $n;
3705ce5b 3254 }
0a920b5b
AW
3255 }
3256
9c0ca6f9 3257 # '*' as part of a type definition -- reported already.
74048ed8 3258 } elsif ($opv eq '*_') {
9c0ca6f9
AW
3259 #warn "'*' is part of type\n";
3260
3261 # unary operators should have a space before and
3262 # none after. May be left adjacent to another
3263 # unary operator, or a cast
3264 } elsif ($op eq '!' || $op eq '~' ||
74048ed8 3265 $opv eq '*U' || $opv eq '-U' ||
0d413866 3266 $opv eq '&U' || $opv eq '&&U') {
cf655043 3267 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
3705ce5b
JP
3268 if (ERROR("SPACING",
3269 "space required before that '$op' $at\n" . $hereptr)) {
b34c648b
JP
3270 if ($n != $last_after + 2) {
3271 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3272 $line_fixed = 1;
3273 }
3705ce5b 3274 }
0a920b5b 3275 }
a3340b35 3276 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
171ae1a4
AW
3277 # A unary '*' may be const
3278
3279 } elsif ($ctx =~ /.xW/) {
3705ce5b
JP
3280 if (ERROR("SPACING",
3281 "space prohibited after that '$op' $at\n" . $hereptr)) {
b34c648b 3282 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
3705ce5b
JP
3283 if (defined $fix_elements[$n + 2]) {
3284 $fix_elements[$n + 2] =~ s/^\s+//;
3285 }
b34c648b 3286 $line_fixed = 1;
3705ce5b 3287 }
0a920b5b
AW
3288 }
3289
3290 # unary ++ and unary -- are allowed no space on one side.
3291 } elsif ($op eq '++' or $op eq '--') {
773647a0 3292 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
3705ce5b
JP
3293 if (ERROR("SPACING",
3294 "space required one side of that '$op' $at\n" . $hereptr)) {
b34c648b 3295 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3705ce5b
JP
3296 $line_fixed = 1;
3297 }
773647a0
AW
3298 }
3299 if ($ctx =~ /Wx[BE]/ ||
3300 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
3705ce5b
JP
3301 if (ERROR("SPACING",
3302 "space prohibited before that '$op' $at\n" . $hereptr)) {
b34c648b 3303 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3705ce5b
JP
3304 $line_fixed = 1;
3305 }
0a920b5b 3306 }
773647a0 3307 if ($ctx =~ /ExW/) {
3705ce5b
JP
3308 if (ERROR("SPACING",
3309 "space prohibited after that '$op' $at\n" . $hereptr)) {
b34c648b 3310 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3705ce5b
JP
3311 if (defined $fix_elements[$n + 2]) {
3312 $fix_elements[$n + 2] =~ s/^\s+//;
3313 }
b34c648b 3314 $line_fixed = 1;
3705ce5b 3315 }
653d4876 3316 }
0a920b5b 3317
0a920b5b 3318 # << and >> may either have or not have spaces both sides
9c0ca6f9
AW
3319 } elsif ($op eq '<<' or $op eq '>>' or
3320 $op eq '&' or $op eq '^' or $op eq '|' or
3321 $op eq '+' or $op eq '-' or
c2fdda0d
AW
3322 $op eq '*' or $op eq '/' or
3323 $op eq '%')
0a920b5b 3324 {
773647a0 3325 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
3705ce5b
JP
3326 if (ERROR("SPACING",
3327 "need consistent spacing around '$op' $at\n" . $hereptr)) {
b34c648b
JP
3328 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3329 if (defined $fix_elements[$n + 2]) {
3330 $fix_elements[$n + 2] =~ s/^\s+//;
3331 }
3705ce5b
JP
3332 $line_fixed = 1;
3333 }
0a920b5b
AW
3334 }
3335
1f65f947
AW
3336 # A colon needs no spaces before when it is
3337 # terminating a case value or a label.
3338 } elsif ($opv eq ':C' || $opv eq ':L') {
3339 if ($ctx =~ /Wx./) {
3705ce5b
JP
3340 if (ERROR("SPACING",
3341 "space prohibited before that '$op' $at\n" . $hereptr)) {
b34c648b 3342 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3705ce5b
JP
3343 $line_fixed = 1;
3344 }
1f65f947
AW
3345 }
3346
0a920b5b 3347 # All the others need spaces both sides.
cf655043 3348 } elsif ($ctx !~ /[EWC]x[CWE]/) {
1f65f947
AW
3349 my $ok = 0;
3350
22f2a2ef 3351 # Ignore email addresses <foo@bar>
1f65f947
AW
3352 if (($op eq '<' &&
3353 $cc =~ /^\S+\@\S+>/) ||
3354 ($op eq '>' &&
3355 $ca =~ /<\S+\@\S+$/))
3356 {
3357 $ok = 1;
3358 }
3359
84731623 3360 # messages are ERROR, but ?: are CHK
1f65f947 3361 if ($ok == 0) {
84731623
JP
3362 my $msg_type = \&ERROR;
3363 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3364
3365 if (&{$msg_type}("SPACING",
3366 "spaces required around that '$op' $at\n" . $hereptr)) {
b34c648b
JP
3367 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3368 if (defined $fix_elements[$n + 2]) {
3369 $fix_elements[$n + 2] =~ s/^\s+//;
3370 }
3705ce5b
JP
3371 $line_fixed = 1;
3372 }
22f2a2ef 3373 }
0a920b5b 3374 }
4a0df2ef 3375 $off += length($elements[$n + 1]);
3705ce5b
JP
3376
3377## print("n: <$n> GOOD: <$good>\n");
3378
3379 $fixed_line = $fixed_line . $good;
3380 }
3381
3382 if (($#elements % 2) == 0) {
3383 $fixed_line = $fixed_line . $fix_elements[$#elements];
0a920b5b 3384 }
3705ce5b
JP
3385
3386 if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) {
3387 $fixed[$linenr - 1] = $fixed_line;
3388 }
3389
3390
0a920b5b
AW
3391 }
3392
786b6326 3393# check for whitespace before a non-naked semicolon
d2e248e7 3394 if ($line =~ /^\+.*\S\s+;\s*$/) {
786b6326
JP
3395 if (WARN("SPACING",
3396 "space prohibited before semicolon\n" . $herecurr) &&
3397 $fix) {
3398 1 while $fixed[$linenr - 1] =~
3399 s/^(\+.*\S)\s+;/$1;/;
3400 }
3401 }
3402
f0a594c1
AW
3403# check for multiple assignments
3404 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
000d1cc1
JP
3405 CHK("MULTIPLE_ASSIGNMENTS",
3406 "multiple assignments should be avoided\n" . $herecurr);
f0a594c1
AW
3407 }
3408
22f2a2ef
AW
3409## # check for multiple declarations, allowing for a function declaration
3410## # continuation.
3411## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3412## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3413##
3414## # Remove any bracketed sections to ensure we do not
3415## # falsly report the parameters of functions.
3416## my $ln = $line;
3417## while ($ln =~ s/\([^\(\)]*\)//g) {
3418## }
3419## if ($ln =~ /,/) {
000d1cc1
JP
3420## WARN("MULTIPLE_DECLARATION",
3421## "declaring multiple variables together should be avoided\n" . $herecurr);
22f2a2ef
AW
3422## }
3423## }
f0a594c1 3424
0a920b5b 3425#need space before brace following if, while, etc
22f2a2ef
AW
3426 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3427 $line =~ /do{/) {
3705ce5b
JP
3428 if (ERROR("SPACING",
3429 "space required before the open brace '{'\n" . $herecurr) &&
3430 $fix) {
d5e616fc 3431 $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/;
3705ce5b 3432 }
de7d4f0e
AW
3433 }
3434
c4a62ef9
JP
3435## # check for blank lines before declarations
3436## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3437## $prevrawline =~ /^.\s*$/) {
3438## WARN("SPACING",
3439## "No blank lines before declarations\n" . $hereprev);
3440## }
3441##
3442
de7d4f0e
AW
3443# closing brace should have a space following it when it has anything
3444# on the line
3445 if ($line =~ /}(?!(?:,|;|\)))\S/) {
d5e616fc
JP
3446 if (ERROR("SPACING",
3447 "space required after that close brace '}'\n" . $herecurr) &&
3448 $fix) {
3449 $fixed[$linenr - 1] =~
3450 s/}((?!(?:,|;|\)))\S)/} $1/;
3451 }
0a920b5b
AW
3452 }
3453
22f2a2ef
AW
3454# check spacing on square brackets
3455 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
3705ce5b
JP
3456 if (ERROR("SPACING",
3457 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3458 $fix) {
3459 $fixed[$linenr - 1] =~
3460 s/\[\s+/\[/;
3461 }
22f2a2ef
AW
3462 }
3463 if ($line =~ /\s\]/) {
3705ce5b
JP
3464 if (ERROR("SPACING",
3465 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3466 $fix) {
3467 $fixed[$linenr - 1] =~
3468 s/\s+\]/\]/;
3469 }
22f2a2ef
AW
3470 }
3471
c45dcabd 3472# check spacing on parentheses
9c0ca6f9
AW
3473 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3474 $line !~ /for\s*\(\s+;/) {
3705ce5b
JP
3475 if (ERROR("SPACING",
3476 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3477 $fix) {
3478 $fixed[$linenr - 1] =~
3479 s/\(\s+/\(/;
3480 }
22f2a2ef 3481 }
13214adf 3482 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
c45dcabd
AW
3483 $line !~ /for\s*\(.*;\s+\)/ &&
3484 $line !~ /:\s+\)/) {
3705ce5b
JP
3485 if (ERROR("SPACING",
3486 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3487 $fix) {
3488 $fixed[$linenr - 1] =~
3489 s/\s+\)/\)/;
3490 }
22f2a2ef
AW
3491 }
3492
0a920b5b 3493#goto labels aren't indented, allow a single space however
4a0df2ef 3494 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
0a920b5b 3495 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
3705ce5b
JP
3496 if (WARN("INDENTED_LABEL",
3497 "labels should not be indented\n" . $herecurr) &&
3498 $fix) {
3499 $fixed[$linenr - 1] =~
3500 s/^(.)\s+/$1/;
3501 }
0a920b5b
AW
3502 }
3503
5b9553ab 3504# return is not a function
507e5141 3505 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
c45dcabd 3506 my $spacing = $1;
507e5141 3507 if ($^V && $^V ge 5.10.0 &&
5b9553ab
JP
3508 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3509 my $value = $1;
3510 $value = deparenthesize($value);
3511 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3512 ERROR("RETURN_PARENTHESES",
3513 "return is not a function, parentheses are not required\n" . $herecurr);
3514 }
c45dcabd 3515 } elsif ($spacing !~ /\s+/) {
000d1cc1
JP
3516 ERROR("SPACING",
3517 "space required before the open parenthesis '('\n" . $herecurr);
c45dcabd
AW
3518 }
3519 }
507e5141 3520
b43ae21b
JP
3521# unnecessary return in a void function
3522# at end-of-function, with the previous line a single leading tab, then return;
3523# and the line before that not a goto label target like "out:"
3524 if ($sline =~ /^[ \+]}\s*$/ &&
3525 $prevline =~ /^\+\treturn\s*;\s*$/ &&
3526 $linenr >= 3 &&
3527 $lines[$linenr - 3] =~ /^[ +]/ &&
3528 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
9819cf25 3529 WARN("RETURN_VOID",
b43ae21b
JP
3530 "void function return statements are not generally useful\n" . $hereprev);
3531 }
9819cf25 3532
189248d8
JP
3533# if statements using unnecessary parentheses - ie: if ((foo == bar))
3534 if ($^V && $^V ge 5.10.0 &&
3535 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3536 my $openparens = $1;
3537 my $count = $openparens =~ tr@\(@\(@;
3538 my $msg = "";
3539 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3540 my $comp = $4; #Not $1 because of $LvalOrFunc
3541 $msg = " - maybe == should be = ?" if ($comp eq "==");
3542 WARN("UNNECESSARY_PARENTHESES",
3543 "Unnecessary parentheses$msg\n" . $herecurr);
3544 }
3545 }
3546
53a3c448
AW
3547# Return of what appears to be an errno should normally be -'ve
3548 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3549 my $name = $1;
3550 if ($name ne 'EOF' && $name ne 'ERROR') {
000d1cc1
JP
3551 WARN("USE_NEGATIVE_ERRNO",
3552 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
53a3c448
AW
3553 }
3554 }
c45dcabd 3555
0a920b5b 3556# Need a space before open parenthesis after if, while etc
3705ce5b
JP
3557 if ($line =~ /\b(if|while|for|switch)\(/) {
3558 if (ERROR("SPACING",
3559 "space required before the open parenthesis '('\n" . $herecurr) &&
3560 $fix) {
3561 $fixed[$linenr - 1] =~
3562 s/\b(if|while|for|switch)\(/$1 \(/;
3563 }
0a920b5b
AW
3564 }
3565
f5fe35dd
AW
3566# Check for illegal assignment in if conditional -- and check for trailing
3567# statements after the conditional.
170d3a22 3568 if ($line =~ /do\s*(?!{)/) {
3e469cdc
AW
3569 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3570 ctx_statement_block($linenr, $realcnt, 0)
3571 if (!defined $stat);
170d3a22
AW
3572 my ($stat_next) = ctx_statement_block($line_nr_next,
3573 $remain_next, $off_next);
3574 $stat_next =~ s/\n./\n /g;
3575 ##print "stat<$stat> stat_next<$stat_next>\n";
3576
3577 if ($stat_next =~ /^\s*while\b/) {
3578 # If the statement carries leading newlines,
3579 # then count those as offsets.
3580 my ($whitespace) =
3581 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3582 my $offset =
3583 statement_rawlines($whitespace) - 1;
3584
3585 $suppress_whiletrailers{$line_nr_next +
3586 $offset} = 1;
3587 }
3588 }
3589 if (!defined $suppress_whiletrailers{$linenr} &&
c11230f4 3590 defined($stat) && defined($cond) &&
170d3a22 3591 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
171ae1a4 3592 my ($s, $c) = ($stat, $cond);
8905a67c 3593
b53c8e10 3594 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
000d1cc1
JP
3595 ERROR("ASSIGN_IN_IF",
3596 "do not use assignment in if condition\n" . $herecurr);
8905a67c
AW
3597 }
3598
3599 # Find out what is on the end of the line after the
3600 # conditional.
773647a0 3601 substr($s, 0, length($c), '');
8905a67c 3602 $s =~ s/\n.*//g;
13214adf 3603 $s =~ s/$;//g; # Remove any comments
53210168
AW
3604 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3605 $c !~ /}\s*while\s*/)
773647a0 3606 {
bb44ad39
AW
3607 # Find out how long the conditional actually is.
3608 my @newlines = ($c =~ /\n/gs);
3609 my $cond_lines = 1 + $#newlines;
42bdf74c 3610 my $stat_real = '';
bb44ad39 3611
42bdf74c
HS
3612 $stat_real = raw_line($linenr, $cond_lines)
3613 . "\n" if ($cond_lines);
bb44ad39
AW
3614 if (defined($stat_real) && $cond_lines > 1) {
3615 $stat_real = "[...]\n$stat_real";
3616 }
3617
000d1cc1
JP
3618 ERROR("TRAILING_STATEMENTS",
3619 "trailing statements should be on next line\n" . $herecurr . $stat_real);
8905a67c
AW
3620 }
3621 }
3622
13214adf
AW
3623# Check for bitwise tests written as boolean
3624 if ($line =~ /
3625 (?:
3626 (?:\[|\(|\&\&|\|\|)
3627 \s*0[xX][0-9]+\s*
3628 (?:\&\&|\|\|)
3629 |
3630 (?:\&\&|\|\|)
3631 \s*0[xX][0-9]+\s*
3632 (?:\&\&|\|\||\)|\])
3633 )/x)
3634 {
000d1cc1
JP
3635 WARN("HEXADECIMAL_BOOLEAN_TEST",
3636 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
13214adf
AW
3637 }
3638
8905a67c 3639# if and else should not have general statements after it
13214adf
AW
3640 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3641 my $s = $1;
3642 $s =~ s/$;//g; # Remove any comments
3643 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
000d1cc1
JP
3644 ERROR("TRAILING_STATEMENTS",
3645 "trailing statements should be on next line\n" . $herecurr);
13214adf 3646 }
0a920b5b 3647 }
39667782
AW
3648# if should not continue a brace
3649 if ($line =~ /}\s*if\b/) {
000d1cc1 3650 ERROR("TRAILING_STATEMENTS",
048b123f 3651 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
39667782
AW
3652 $herecurr);
3653 }
a1080bf8
AW
3654# case and default should not have general statements after them
3655 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3656 $line !~ /\G(?:
3fef12d6 3657 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
a1080bf8
AW
3658 \s*return\s+
3659 )/xg)
3660 {
000d1cc1
JP
3661 ERROR("TRAILING_STATEMENTS",
3662 "trailing statements should be on next line\n" . $herecurr);
a1080bf8 3663 }
0a920b5b
AW
3664
3665 # Check for }<nl>else {, these must be at the same
3666 # indent level to be relevant to each other.
3667 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
3668 $previndent == $indent) {
000d1cc1
JP
3669 ERROR("ELSE_AFTER_BRACE",
3670 "else should follow close brace '}'\n" . $hereprev);
0a920b5b
AW
3671 }
3672
c2fdda0d
AW
3673 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
3674 $previndent == $indent) {
3675 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3676
3677 # Find out what is on the end of the line after the
3678 # conditional.
773647a0 3679 substr($s, 0, length($c), '');
c2fdda0d
AW
3680 $s =~ s/\n.*//g;
3681
3682 if ($s =~ /^\s*;/) {
000d1cc1
JP
3683 ERROR("WHILE_AFTER_BRACE",
3684 "while should follow close brace '}'\n" . $hereprev);
c2fdda0d
AW
3685 }
3686 }
3687
95e2c602 3688#Specific variable tests
323c1260
JP
3689 while ($line =~ m{($Constant|$Lval)}g) {
3690 my $var = $1;
95e2c602
JP
3691
3692#gcc binary extension
3693 if ($var =~ /^$Binary$/) {
d5e616fc
JP
3694 if (WARN("GCC_BINARY_CONSTANT",
3695 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3696 $fix) {
3697 my $hexval = sprintf("0x%x", oct($var));
3698 $fixed[$linenr - 1] =~
3699 s/\b$var\b/$hexval/;
3700 }
95e2c602
JP
3701 }
3702
3703#CamelCase
807bd26c 3704 if ($var !~ /^$Constant$/ &&
be79794b 3705 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
22735ce8 3706#Ignore Page<foo> variants
807bd26c 3707 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
22735ce8 3708#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
3445686a 3709 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
7e781f67
JP
3710 while ($var =~ m{($Ident)}g) {
3711 my $word = $1;
3712 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
d8b07710
JP
3713 if ($check) {
3714 seed_camelcase_includes();
3715 if (!$file && !$camelcase_file_seeded) {
3716 seed_camelcase_file($realfile);
3717 $camelcase_file_seeded = 1;
3718 }
3719 }
7e781f67
JP
3720 if (!defined $camelcase{$word}) {
3721 $camelcase{$word} = 1;
3722 CHK("CAMELCASE",
3723 "Avoid CamelCase: <$word>\n" . $herecurr);
3724 }
3445686a 3725 }
323c1260
JP
3726 }
3727 }
0a920b5b
AW
3728
3729#no spaces allowed after \ in define
d5e616fc
JP
3730 if ($line =~ /\#\s*define.*\\\s+$/) {
3731 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
3732 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
3733 $fix) {
3734 $fixed[$linenr - 1] =~ s/\s+$//;
3735 }
0a920b5b
AW
3736 }
3737
653d4876 3738#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
c45dcabd 3739 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
e09dec48
AW
3740 my $file = "$1.h";
3741 my $checkfile = "include/linux/$file";
3742 if (-f "$root/$checkfile" &&
3743 $realfile ne $checkfile &&
7840a94c 3744 $1 !~ /$allowed_asm_includes/)
c45dcabd 3745 {
e09dec48 3746 if ($realfile =~ m{^arch/}) {
000d1cc1
JP
3747 CHK("ARCH_INCLUDE_LINUX",
3748 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
e09dec48 3749 } else {
000d1cc1
JP
3750 WARN("INCLUDE_LINUX",
3751 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
e09dec48 3752 }
0a920b5b
AW
3753 }
3754 }
3755
653d4876
AW
3756# multi-statement macros should be enclosed in a do while loop, grab the
3757# first statement and ensure its the whole macro if its not enclosed
cf655043 3758# in a known good container
b8f96a31
AW
3759 if ($realfile !~ m@/vmlinux.lds.h$@ &&
3760 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
d8aaf121
AW
3761 my $ln = $linenr;
3762 my $cnt = $realcnt;
c45dcabd
AW
3763 my ($off, $dstat, $dcond, $rest);
3764 my $ctx = '';
c45dcabd 3765 ($dstat, $dcond, $ln, $cnt, $off) =
f74bd194
AW
3766 ctx_statement_block($linenr, $realcnt, 0);
3767 $ctx = $dstat;
c45dcabd 3768 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
a3bb97a7 3769 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
c45dcabd 3770
f74bd194 3771 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
292f1a9b 3772 $dstat =~ s/$;//g;
c45dcabd
AW
3773 $dstat =~ s/\\\n.//g;
3774 $dstat =~ s/^\s*//s;
3775 $dstat =~ s/\s*$//s;
de7d4f0e 3776
c45dcabd 3777 # Flatten any parentheses and braces
bf30d6ed
AW
3778 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
3779 $dstat =~ s/\{[^\{\}]*\}/1/ ||
c81769fd 3780 $dstat =~ s/\[[^\[\]]*\]/1/)
bf30d6ed 3781 {
de7d4f0e 3782 }
d8aaf121 3783
e45bab8e
AW
3784 # Flatten any obvious string concatentation.
3785 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3786 $dstat =~ s/$Ident\s*("X*")/$1/)
3787 {
3788 }
3789
c45dcabd
AW
3790 my $exceptions = qr{
3791 $Declare|
3792 module_param_named|
a0a0a7a9 3793 MODULE_PARM_DESC|
c45dcabd
AW
3794 DECLARE_PER_CPU|
3795 DEFINE_PER_CPU|
383099fd 3796 __typeof__\(|
22fd2d3e
SS
3797 union|
3798 struct|
ea71a0a0
AW
3799 \.$Ident\s*=\s*|
3800 ^\"|\"$
c45dcabd 3801 }x;
5eaa20b9 3802 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
f74bd194
AW
3803 if ($dstat ne '' &&
3804 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
3805 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
3cc4b1c3 3806 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
356fd398 3807 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
f74bd194
AW
3808 $dstat !~ /$exceptions/ &&
3809 $dstat !~ /^\.$Ident\s*=/ && # .foo =
e942e2c3 3810 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
72f115f9 3811 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
f74bd194
AW
3812 $dstat !~ /^for\s*$Constant$/ && # for (...)
3813 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
3814 $dstat !~ /^do\s*{/ && # do {...
f95a7e6a
JP
3815 $dstat !~ /^\({/ && # ({...
3816 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
f74bd194
AW
3817 {
3818 $ctx =~ s/\n*$//;
3819 my $herectx = $here . "\n";
3820 my $cnt = statement_rawlines($ctx);
3821
3822 for (my $n = 0; $n < $cnt; $n++) {
3823 $herectx .= raw_line($linenr, $n) . "\n";
c45dcabd
AW
3824 }
3825
f74bd194
AW
3826 if ($dstat =~ /;/) {
3827 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3828 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3829 } else {
000d1cc1 3830 ERROR("COMPLEX_MACRO",
f74bd194 3831 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
d8aaf121 3832 }
653d4876 3833 }
5023d347 3834
481eb486 3835# check for line continuations outside of #defines, preprocessor #, and asm
5023d347
JP
3836
3837 } else {
3838 if ($prevline !~ /^..*\\$/ &&
481eb486
JP
3839 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3840 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
5023d347
JP
3841 $line =~ /^\+.*\\$/) {
3842 WARN("LINE_CONTINUATIONS",
3843 "Avoid unnecessary line continuations\n" . $herecurr);
3844 }
0a920b5b
AW
3845 }
3846
b13edf7f
JP
3847# do {} while (0) macro tests:
3848# single-statement macros do not need to be enclosed in do while (0) loop,
3849# macro should not end with a semicolon
3850 if ($^V && $^V ge 5.10.0 &&
3851 $realfile !~ m@/vmlinux.lds.h$@ &&
3852 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3853 my $ln = $linenr;
3854 my $cnt = $realcnt;
3855 my ($off, $dstat, $dcond, $rest);
3856 my $ctx = '';
3857 ($dstat, $dcond, $ln, $cnt, $off) =
3858 ctx_statement_block($linenr, $realcnt, 0);
3859 $ctx = $dstat;
3860
3861 $dstat =~ s/\\\n.//g;
3862
3863 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3864 my $stmts = $2;
3865 my $semis = $3;
3866
3867 $ctx =~ s/\n*$//;
3868 my $cnt = statement_rawlines($ctx);
3869 my $herectx = $here . "\n";
3870
3871 for (my $n = 0; $n < $cnt; $n++) {
3872 $herectx .= raw_line($linenr, $n) . "\n";
3873 }
3874
ac8e97f8
JP
3875 if (($stmts =~ tr/;/;/) == 1 &&
3876 $stmts !~ /^\s*(if|while|for|switch)\b/) {
b13edf7f
JP
3877 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3878 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3879 }
3880 if (defined $semis && $semis ne "") {
3881 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3882 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3883 }
f5ef95b1
JP
3884 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
3885 $ctx =~ s/\n*$//;
3886 my $cnt = statement_rawlines($ctx);
3887 my $herectx = $here . "\n";
3888
3889 for (my $n = 0; $n < $cnt; $n++) {
3890 $herectx .= raw_line($linenr, $n) . "\n";
3891 }
3892
3893 WARN("TRAILING_SEMICOLON",
3894 "macros should not use a trailing semicolon\n" . "$herectx");
b13edf7f
JP
3895 }
3896 }
3897
080ba929
MF
3898# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3899# all assignments may have only one of the following with an assignment:
3900# .
3901# ALIGN(...)
3902# VMLINUX_SYMBOL(...)
3903 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
000d1cc1
JP
3904 WARN("MISSING_VMLINUX_SYMBOL",
3905 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
080ba929
MF
3906 }
3907
f0a594c1 3908# check for redundant bracing round if etc
13214adf
AW
3909 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3910 my ($level, $endln, @chunks) =
cf655043 3911 ctx_statement_full($linenr, $realcnt, 1);
13214adf 3912 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
cf655043
AW
3913 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3914 if ($#chunks > 0 && $level == 0) {
aad4f614
JP
3915 my @allowed = ();
3916 my $allow = 0;
13214adf 3917 my $seen = 0;
773647a0 3918 my $herectx = $here . "\n";
cf655043 3919 my $ln = $linenr - 1;
13214adf
AW
3920 for my $chunk (@chunks) {
3921 my ($cond, $block) = @{$chunk};
3922
773647a0
AW
3923 # If the condition carries leading newlines, then count those as offsets.
3924 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3925 my $offset = statement_rawlines($whitespace) - 1;
3926
aad4f614 3927 $allowed[$allow] = 0;
773647a0
AW
3928 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3929
3930 # We have looked at and allowed this specific line.
3931 $suppress_ifbraces{$ln + $offset} = 1;
3932
3933 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
cf655043
AW
3934 $ln += statement_rawlines($block) - 1;
3935
773647a0 3936 substr($block, 0, length($cond), '');
13214adf
AW
3937
3938 $seen++ if ($block =~ /^\s*{/);
3939
aad4f614 3940 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
cf655043
AW
3941 if (statement_lines($cond) > 1) {
3942 #print "APW: ALLOWED: cond<$cond>\n";
aad4f614 3943 $allowed[$allow] = 1;
13214adf
AW
3944 }
3945 if ($block =~/\b(?:if|for|while)\b/) {
cf655043 3946 #print "APW: ALLOWED: block<$block>\n";
aad4f614 3947 $allowed[$allow] = 1;
13214adf 3948 }
cf655043
AW
3949 if (statement_block_size($block) > 1) {
3950 #print "APW: ALLOWED: lines block<$block>\n";
aad4f614 3951 $allowed[$allow] = 1;
13214adf 3952 }
aad4f614 3953 $allow++;
13214adf 3954 }
aad4f614
JP
3955 if ($seen) {
3956 my $sum_allowed = 0;
3957 foreach (@allowed) {
3958 $sum_allowed += $_;
3959 }
3960 if ($sum_allowed == 0) {
3961 WARN("BRACES",
3962 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3963 } elsif ($sum_allowed != $allow &&
3964 $seen != $allow) {
3965 CHK("BRACES",
3966 "braces {} should be used on all arms of this statement\n" . $herectx);
3967 }
13214adf
AW
3968 }
3969 }
3970 }
773647a0 3971 if (!defined $suppress_ifbraces{$linenr - 1} &&
13214adf 3972 $line =~ /\b(if|while|for|else)\b/) {
cf655043
AW
3973 my $allowed = 0;
3974
3975 # Check the pre-context.
3976 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3977 #print "APW: ALLOWED: pre<$1>\n";
3978 $allowed = 1;
3979 }
773647a0
AW
3980
3981 my ($level, $endln, @chunks) =
3982 ctx_statement_full($linenr, $realcnt, $-[0]);
3983
cf655043
AW
3984 # Check the condition.
3985 my ($cond, $block) = @{$chunks[0]};
773647a0 3986 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
cf655043 3987 if (defined $cond) {
773647a0 3988 substr($block, 0, length($cond), '');
cf655043
AW
3989 }
3990 if (statement_lines($cond) > 1) {
3991 #print "APW: ALLOWED: cond<$cond>\n";
3992 $allowed = 1;
3993 }
3994 if ($block =~/\b(?:if|for|while)\b/) {
3995 #print "APW: ALLOWED: block<$block>\n";
3996 $allowed = 1;
3997 }
3998 if (statement_block_size($block) > 1) {
3999 #print "APW: ALLOWED: lines block<$block>\n";
4000 $allowed = 1;
4001 }
4002 # Check the post-context.
4003 if (defined $chunks[1]) {
4004 my ($cond, $block) = @{$chunks[1]};
4005 if (defined $cond) {
773647a0 4006 substr($block, 0, length($cond), '');
cf655043
AW
4007 }
4008 if ($block =~ /^\s*\{/) {
4009 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4010 $allowed = 1;
4011 }
4012 }
4013 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
69932487 4014 my $herectx = $here . "\n";
f055663c 4015 my $cnt = statement_rawlines($block);
cf655043 4016
f055663c 4017 for (my $n = 0; $n < $cnt; $n++) {
69932487 4018 $herectx .= raw_line($linenr, $n) . "\n";
f0a594c1 4019 }
cf655043 4020
000d1cc1
JP
4021 WARN("BRACES",
4022 "braces {} are not necessary for single statement blocks\n" . $herectx);
f0a594c1
AW
4023 }
4024 }
4025
0979ae66 4026# check for unnecessary blank lines around braces
77b9a53a 4027 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
0979ae66
JP
4028 CHK("BRACES",
4029 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
4030 }
77b9a53a 4031 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
0979ae66
JP
4032 CHK("BRACES",
4033 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
4034 }
4035
4a0df2ef 4036# no volatiles please
6c72ffaa
AW
4037 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4038 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
000d1cc1
JP
4039 WARN("VOLATILE",
4040 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4a0df2ef
AW
4041 }
4042
00df344f 4043# warn about #if 0
c45dcabd 4044 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
000d1cc1
JP
4045 CHK("REDUNDANT_CODE",
4046 "if this code is redundant consider removing it\n" .
de7d4f0e 4047 $herecurr);
4a0df2ef
AW
4048 }
4049
03df4b51
AW
4050# check for needless "if (<foo>) fn(<foo>)" uses
4051 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
4052 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
4053 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
4054 WARN('NEEDLESS_IF',
4055 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
4c432a8f
GKH
4056 }
4057 }
f0a594c1 4058
ebfdc409
JP
4059# check for unnecessary "Out of Memory" messages
4060 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4061 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4062 (defined $1 || defined $3) &&
4063 $linenr > 3) {
4064 my $testval = $2;
4065 my $testline = $lines[$linenr - 3];
4066
4067 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
4068# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4069
4070 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4071 WARN("OOM_MESSAGE",
4072 "Possible unnecessary 'out of memory' message\n" . $hereprev);
4073 }
4074 }
4075
8716de38
JP
4076# check for bad placement of section $InitAttribute (e.g.: __initdata)
4077 if ($line =~ /(\b$InitAttribute\b)/) {
4078 my $attr = $1;
4079 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4080 my $ptr = $1;
4081 my $var = $2;
4082 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4083 ERROR("MISPLACED_INIT",
4084 "$attr should be placed after $var\n" . $herecurr)) ||
4085 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4086 WARN("MISPLACED_INIT",
4087 "$attr should be placed after $var\n" . $herecurr))) &&
4088 $fix) {
4089 $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;
4090 }
4091 }
4092 }
4093
e970b884
JP
4094# check for $InitAttributeData (ie: __initdata) with const
4095 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
4096 my $attr = $1;
4097 $attr =~ /($InitAttributePrefix)(.*)/;
4098 my $attr_prefix = $1;
4099 my $attr_type = $2;
4100 if (ERROR("INIT_ATTRIBUTE",
4101 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4102 $fix) {
4103 $fixed[$linenr - 1] =~
4104 s/$InitAttributeData/${attr_prefix}initconst/;
4105 }
4106 }
4107
4108# check for $InitAttributeConst (ie: __initconst) without const
4109 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4110 my $attr = $1;
4111 if (ERROR("INIT_ATTRIBUTE",
4112 "Use of $attr requires a separate use of const\n" . $herecurr) &&
4113 $fix) {
4114 my $lead = $fixed[$linenr - 1] =~
4115 /(^\+\s*(?:static\s+))/;
4116 $lead = rtrim($1);
4117 $lead = "$lead " if ($lead !~ /^\+$/);
4118 $lead = "${lead}const ";
4119 $fixed[$linenr - 1] =~ s/(^\+\s*(?:static\s+))/$lead/;
4120 }
4121 }
4122
fbdb8138
JP
4123# don't use __constant_<foo> functions outside of include/uapi/
4124 if ($realfile !~ m@^include/uapi/@ &&
4125 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4126 my $constant_func = $1;
4127 my $func = $constant_func;
4128 $func =~ s/^__constant_//;
4129 if (WARN("CONSTANT_CONVERSION",
4130 "$constant_func should be $func\n" . $herecurr) &&
4131 $fix) {
4132 $fixed[$linenr - 1] =~ s/\b$constant_func\b/$func/g;
4133 }
4134 }
4135
1a15a250 4136# prefer usleep_range over udelay
37581c28 4137 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
43c1d77c 4138 my $delay = $1;
1a15a250 4139 # ignore udelay's < 10, however
43c1d77c 4140 if (! ($delay < 10) ) {
000d1cc1 4141 CHK("USLEEP_RANGE",
43c1d77c
JP
4142 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4143 }
4144 if ($delay > 2000) {
4145 WARN("LONG_UDELAY",
4146 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
1a15a250
PP
4147 }
4148 }
4149
09ef8725
PP
4150# warn about unexpectedly long msleep's
4151 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4152 if ($1 < 20) {
000d1cc1 4153 WARN("MSLEEP",
43c1d77c 4154 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
09ef8725
PP
4155 }
4156 }
4157
36ec1939
JP
4158# check for comparisons of jiffies
4159 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4160 WARN("JIFFIES_COMPARISON",
4161 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4162 }
4163
9d7a34a5
JP
4164# check for comparisons of get_jiffies_64()
4165 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4166 WARN("JIFFIES_COMPARISON",
4167 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4168 }
4169
00df344f 4170# warn about #ifdefs in C files
c45dcabd 4171# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
00df344f
AW
4172# print "#ifdef in C files should be avoided\n";
4173# print "$herecurr";
4174# $clean = 0;
4175# }
4176
22f2a2ef 4177# warn about spacing in #ifdefs
c45dcabd 4178 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
3705ce5b
JP
4179 if (ERROR("SPACING",
4180 "exactly one space required after that #$1\n" . $herecurr) &&
4181 $fix) {
4182 $fixed[$linenr - 1] =~
4183 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4184 }
4185
22f2a2ef
AW
4186 }
4187
4a0df2ef 4188# check for spinlock_t definitions without a comment.
171ae1a4
AW
4189 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4190 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
4a0df2ef
AW
4191 my $which = $1;
4192 if (!ctx_has_comment($first_line, $linenr)) {
000d1cc1
JP
4193 CHK("UNCOMMENTED_DEFINITION",
4194 "$1 definition without comment\n" . $herecurr);
4a0df2ef
AW
4195 }
4196 }
4197# check for memory barriers without a comment.
4198 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4199 if (!ctx_has_comment($first_line, $linenr)) {
c1fd7bb9
JP
4200 WARN("MEMORY_BARRIER",
4201 "memory barrier without comment\n" . $herecurr);
4a0df2ef
AW
4202 }
4203 }
4204# check of hardware specific defines
c45dcabd 4205 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
000d1cc1
JP
4206 CHK("ARCH_DEFINES",
4207 "architecture specific defines should be avoided\n" . $herecurr);
0a920b5b 4208 }
653d4876 4209
d4977c78
TK
4210# Check that the storage class is at the beginning of a declaration
4211 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
000d1cc1
JP
4212 WARN("STORAGE_CLASS",
4213 "storage class should be at the beginning of the declaration\n" . $herecurr)
d4977c78
TK
4214 }
4215
de7d4f0e
AW
4216# check the location of the inline attribute, that it is between
4217# storage class and type.
9c0ca6f9
AW
4218 if ($line =~ /\b$Type\s+$Inline\b/ ||
4219 $line =~ /\b$Inline\s+$Storage\b/) {
000d1cc1
JP
4220 ERROR("INLINE_LOCATION",
4221 "inline keyword should sit between storage class and type\n" . $herecurr);
de7d4f0e
AW
4222 }
4223
8905a67c 4224# Check for __inline__ and __inline, prefer inline
2b7ab453
JP
4225 if ($realfile !~ m@\binclude/uapi/@ &&
4226 $line =~ /\b(__inline__|__inline)\b/) {
d5e616fc
JP
4227 if (WARN("INLINE",
4228 "plain inline is preferred over $1\n" . $herecurr) &&
4229 $fix) {
4230 $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/;
4231
4232 }
8905a67c
AW
4233 }
4234
3d130fd0 4235# Check for __attribute__ packed, prefer __packed
2b7ab453
JP
4236 if ($realfile !~ m@\binclude/uapi/@ &&
4237 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
000d1cc1
JP
4238 WARN("PREFER_PACKED",
4239 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
3d130fd0
JP
4240 }
4241
39b7e287 4242# Check for __attribute__ aligned, prefer __aligned
2b7ab453
JP
4243 if ($realfile !~ m@\binclude/uapi/@ &&
4244 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
000d1cc1
JP
4245 WARN("PREFER_ALIGNED",
4246 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
39b7e287
JP
4247 }
4248
5f14d3bd 4249# Check for __attribute__ format(printf, prefer __printf
2b7ab453
JP
4250 if ($realfile !~ m@\binclude/uapi/@ &&
4251 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
d5e616fc
JP
4252 if (WARN("PREFER_PRINTF",
4253 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4254 $fix) {
4255 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4256
4257 }
5f14d3bd
JP
4258 }
4259
6061d949 4260# Check for __attribute__ format(scanf, prefer __scanf
2b7ab453
JP
4261 if ($realfile !~ m@\binclude/uapi/@ &&
4262 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
d5e616fc
JP
4263 if (WARN("PREFER_SCANF",
4264 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4265 $fix) {
4266 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4267 }
6061d949
JP
4268 }
4269
8f53a9b8
JP
4270# check for sizeof(&)
4271 if ($line =~ /\bsizeof\s*\(\s*\&/) {
000d1cc1
JP
4272 WARN("SIZEOF_ADDRESS",
4273 "sizeof(& should be avoided\n" . $herecurr);
8f53a9b8
JP
4274 }
4275
66c80b60
JP
4276# check for sizeof without parenthesis
4277 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
d5e616fc
JP
4278 if (WARN("SIZEOF_PARENTHESIS",
4279 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4280 $fix) {
4281 $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4282 }
66c80b60
JP
4283 }
4284
428e2fdc
JP
4285# check for line continuations in quoted strings with odd counts of "
4286 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
000d1cc1
JP
4287 WARN("LINE_CONTINUATIONS",
4288 "Avoid line continuations in quoted strings\n" . $herecurr);
428e2fdc
JP
4289 }
4290
88982fea
JP
4291# check for struct spinlock declarations
4292 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4293 WARN("USE_SPINLOCK_T",
4294 "struct spinlock should be spinlock_t\n" . $herecurr);
4295 }
4296
a6962d72 4297# check for seq_printf uses that could be seq_puts
06668727 4298 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
a6962d72 4299 my $fmt = get_quoted_string($line, $rawline);
06668727 4300 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
d5e616fc
JP
4301 if (WARN("PREFER_SEQ_PUTS",
4302 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4303 $fix) {
4304 $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/;
4305 }
a6962d72
JP
4306 }
4307 }
4308
554e165c 4309# Check for misused memsets
d1fe9c09
JP
4310 if ($^V && $^V ge 5.10.0 &&
4311 defined $stat &&
d7c76ba7
JP
4312 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
4313
4314 my $ms_addr = $2;
d1fe9c09
JP
4315 my $ms_val = $7;
4316 my $ms_size = $12;
554e165c 4317
554e165c
AW
4318 if ($ms_size =~ /^(0x|)0$/i) {
4319 ERROR("MEMSET",
d7c76ba7 4320 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
554e165c
AW
4321 } elsif ($ms_size =~ /^(0x|)1$/i) {
4322 WARN("MEMSET",
d7c76ba7
JP
4323 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4324 }
4325 }
4326
98a9bba5
JP
4327# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4328 if ($^V && $^V ge 5.10.0 &&
4329 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4330 if (WARN("PREFER_ETHER_ADDR_COPY",
4331 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4332 $fix) {
4333 $fixed[$linenr - 1] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4334 }
4335 }
4336
d7c76ba7 4337# typecasts on min/max could be min_t/max_t
d1fe9c09
JP
4338 if ($^V && $^V ge 5.10.0 &&
4339 defined $stat &&
d7c76ba7 4340 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
d1fe9c09 4341 if (defined $2 || defined $7) {
d7c76ba7
JP
4342 my $call = $1;
4343 my $cast1 = deparenthesize($2);
4344 my $arg1 = $3;
d1fe9c09
JP
4345 my $cast2 = deparenthesize($7);
4346 my $arg2 = $8;
d7c76ba7
JP
4347 my $cast;
4348
d1fe9c09 4349 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
d7c76ba7
JP
4350 $cast = "$cast1 or $cast2";
4351 } elsif ($cast1 ne "") {
4352 $cast = $cast1;
4353 } else {
4354 $cast = $cast2;
4355 }
4356 WARN("MINMAX",
4357 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
554e165c
AW
4358 }
4359 }
4360
4a273195
JP
4361# check usleep_range arguments
4362 if ($^V && $^V ge 5.10.0 &&
4363 defined $stat &&
4364 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4365 my $min = $1;
4366 my $max = $7;
4367 if ($min eq $max) {
4368 WARN("USLEEP_RANGE",
4369 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4370 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4371 $min > $max) {
4372 WARN("USLEEP_RANGE",
4373 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4374 }
4375 }
4376
823b794c
JP
4377# check for naked sscanf
4378 if ($^V && $^V ge 5.10.0 &&
4379 defined $stat &&
6c8bd707 4380 $line =~ /\bsscanf\b/ &&
823b794c
JP
4381 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4382 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4383 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4384 my $lc = $stat =~ tr@\n@@;
4385 $lc = $lc + $linenr;
4386 my $stat_real = raw_line($linenr, 0);
4387 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4388 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4389 }
4390 WARN("NAKED_SSCANF",
4391 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4392 }
4393
afc819ab
JP
4394# check for simple sscanf that should be kstrto<foo>
4395 if ($^V && $^V ge 5.10.0 &&
4396 defined $stat &&
4397 $line =~ /\bsscanf\b/) {
4398 my $lc = $stat =~ tr@\n@@;
4399 $lc = $lc + $linenr;
4400 my $stat_real = raw_line($linenr, 0);
4401 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4402 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4403 }
4404 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
4405 my $format = $6;
4406 my $count = $format =~ tr@%@%@;
4407 if ($count == 1 &&
4408 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
4409 WARN("SSCANF_TO_KSTRTO",
4410 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
4411 }
4412 }
4413 }
4414
70dc8a48
JP
4415# check for new externs in .h files.
4416 if ($realfile =~ /\.h$/ &&
4417 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
d1d85780
JP
4418 if (CHK("AVOID_EXTERNS",
4419 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
70dc8a48
JP
4420 $fix) {
4421 $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
4422 }
4423 }
4424
de7d4f0e 4425# check for new externs in .c files.
171ae1a4 4426 if ($realfile =~ /\.c$/ && defined $stat &&
c45dcabd 4427 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
171ae1a4 4428 {
c45dcabd
AW
4429 my $function_name = $1;
4430 my $paren_space = $2;
171ae1a4
AW
4431
4432 my $s = $stat;
4433 if (defined $cond) {
4434 substr($s, 0, length($cond), '');
4435 }
c45dcabd
AW
4436 if ($s =~ /^\s*;/ &&
4437 $function_name ne 'uninitialized_var')
4438 {
000d1cc1
JP
4439 WARN("AVOID_EXTERNS",
4440 "externs should be avoided in .c files\n" . $herecurr);
171ae1a4
AW
4441 }
4442
4443 if ($paren_space =~ /\n/) {
000d1cc1
JP
4444 WARN("FUNCTION_ARGUMENTS",
4445 "arguments for function declarations should follow identifier\n" . $herecurr);
171ae1a4 4446 }
9c9ba34e
AW
4447
4448 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4449 $stat =~ /^.\s*extern\s+/)
4450 {
000d1cc1
JP
4451 WARN("AVOID_EXTERNS",
4452 "externs should be avoided in .c files\n" . $herecurr);
de7d4f0e
AW
4453 }
4454
4455# checks for new __setup's
4456 if ($rawline =~ /\b__setup\("([^"]*)"/) {
4457 my $name = $1;
4458
4459 if (!grep(/$name/, @setup_docs)) {
000d1cc1
JP
4460 CHK("UNDOCUMENTED_SETUP",
4461 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
de7d4f0e 4462 }
653d4876 4463 }
9c0ca6f9
AW
4464
4465# check for pointless casting of kmalloc return
caf2a54f 4466 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
000d1cc1
JP
4467 WARN("UNNECESSARY_CASTS",
4468 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
9c0ca6f9 4469 }
13214adf 4470
a640d25c
JP
4471# alloc style
4472# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4473 if ($^V && $^V ge 5.10.0 &&
4474 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4475 CHK("ALLOC_SIZEOF_STRUCT",
4476 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
4477 }
4478
60a55369
JP
4479# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
4480 if ($^V && $^V ge 5.10.0 &&
4481 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/) {
4482 my $oldfunc = $3;
4483 my $a1 = $4;
4484 my $a2 = $10;
4485 my $newfunc = "kmalloc_array";
4486 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
4487 if ($a1 =~ /^sizeof\s*\S/ || $a2 =~ /^sizeof\s*\S/) {
4488 if (WARN("ALLOC_WITH_MULTIPLY",
4489 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
4490 $fix) {
4491 my $r1 = $a1;
4492 my $r2 = $a2;
4493 if ($a1 =~ /^sizeof\s*\S/) {
4494 $r1 = $a2;
4495 $r2 = $a1;
4496 }
4497 $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;
4498
4499 }
4500 }
4501 }
4502
972fdea2
JP
4503# check for krealloc arg reuse
4504 if ($^V && $^V ge 5.10.0 &&
4505 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
4506 WARN("KREALLOC_ARG_REUSE",
4507 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
4508 }
4509
5ce59ae0
JP
4510# check for alloc argument mismatch
4511 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
4512 WARN("ALLOC_ARRAY_ARGS",
4513 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
4514 }
4515
caf2a54f
JP
4516# check for multiple semicolons
4517 if ($line =~ /;\s*;\s*$/) {
d5e616fc
JP
4518 if (WARN("ONE_SEMICOLON",
4519 "Statements terminations use 1 semicolon\n" . $herecurr) &&
4520 $fix) {
4521 $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g;
4522 }
d1e2ad07
JP
4523 }
4524
c34c09a8
JP
4525# check for case / default statements not preceeded by break/fallthrough/switch
4526 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
4527 my $has_break = 0;
4528 my $has_statement = 0;
4529 my $count = 0;
4530 my $prevline = $linenr;
4531 while ($prevline > 1 && $count < 3 && !$has_break) {
4532 $prevline--;
4533 my $rline = $rawlines[$prevline - 1];
4534 my $fline = $lines[$prevline - 1];
4535 last if ($fline =~ /^\@\@/);
4536 next if ($fline =~ /^\-/);
4537 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
4538 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
4539 next if ($fline =~ /^.[\s$;]*$/);
4540 $has_statement = 1;
4541 $count++;
4542 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
4543 }
4544 if (!$has_break && $has_statement) {
4545 WARN("MISSING_BREAK",
4546 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
4547 }
4548 }
4549
d1e2ad07
JP
4550# check for switch/default statements without a break;
4551 if ($^V && $^V ge 5.10.0 &&
4552 defined $stat &&
4553 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
4554 my $ctx = '';
4555 my $herectx = $here . "\n";
4556 my $cnt = statement_rawlines($stat);
4557 for (my $n = 0; $n < $cnt; $n++) {
4558 $herectx .= raw_line($linenr, $n) . "\n";
4559 }
4560 WARN("DEFAULT_NO_BREAK",
4561 "switch default: should use break\n" . $herectx);
caf2a54f
JP
4562 }
4563
13214adf 4564# check for gcc specific __FUNCTION__
d5e616fc
JP
4565 if ($line =~ /\b__FUNCTION__\b/) {
4566 if (WARN("USE_FUNC",
4567 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
4568 $fix) {
4569 $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g;
4570 }
13214adf 4571 }
773647a0 4572
2c92488a
JP
4573# check for use of yield()
4574 if ($line =~ /\byield\s*\(\s*\)/) {
4575 WARN("YIELD",
4576 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
4577 }
4578
179f8f40
JP
4579# check for comparisons against true and false
4580 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
4581 my $lead = $1;
4582 my $arg = $2;
4583 my $test = $3;
4584 my $otype = $4;
4585 my $trail = $5;
4586 my $op = "!";
4587
4588 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
4589
4590 my $type = lc($otype);
4591 if ($type =~ /^(?:true|false)$/) {
4592 if (("$test" eq "==" && "$type" eq "true") ||
4593 ("$test" eq "!=" && "$type" eq "false")) {
4594 $op = "";
4595 }
4596
4597 CHK("BOOL_COMPARISON",
4598 "Using comparison to $otype is error prone\n" . $herecurr);
4599
4600## maybe suggesting a correct construct would better
4601## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4602
4603 }
4604 }
4605
4882720b
TG
4606# check for semaphores initialized locked
4607 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
000d1cc1
JP
4608 WARN("CONSIDER_COMPLETION",
4609 "consider using a completion\n" . $herecurr);
773647a0 4610 }
6712d858 4611
67d0a075
JP
4612# recommend kstrto* over simple_strto* and strict_strto*
4613 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
000d1cc1 4614 WARN("CONSIDER_KSTRTO",
67d0a075 4615 "$1 is obsolete, use k$3 instead\n" . $herecurr);
773647a0 4616 }
6712d858 4617
ae3ccc46 4618# check for __initcall(), use device_initcall() explicitly or more appropriate function please
f3db6639 4619 if ($line =~ /^.\s*__initcall\s*\(/) {
000d1cc1 4620 WARN("USE_DEVICE_INITCALL",
ae3ccc46 4621 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
f3db6639 4622 }
6712d858 4623
79404849
ER
4624# check for various ops structs, ensure they are const.
4625 my $struct_ops = qr{acpi_dock_ops|
4626 address_space_operations|
4627 backlight_ops|
4628 block_device_operations|
4629 dentry_operations|
4630 dev_pm_ops|
4631 dma_map_ops|
4632 extent_io_ops|
4633 file_lock_operations|
4634 file_operations|
4635 hv_ops|
4636 ide_dma_ops|
4637 intel_dvo_dev_ops|
4638 item_operations|
4639 iwl_ops|
4640 kgdb_arch|
4641 kgdb_io|
4642 kset_uevent_ops|
4643 lock_manager_operations|
4644 microcode_ops|
4645 mtrr_ops|
4646 neigh_ops|
4647 nlmsvc_binding|
4648 pci_raw_ops|
4649 pipe_buf_operations|
4650 platform_hibernation_ops|
4651 platform_suspend_ops|
4652 proto_ops|
4653 rpc_pipe_ops|
4654 seq_operations|
4655 snd_ac97_build_ops|
4656 soc_pcmcia_socket_ops|
4657 stacktrace_ops|
4658 sysfs_ops|
4659 tty_operations|
4660 usb_mon_operations|
4661 wd_ops}x;
6903ffb2 4662 if ($line !~ /\bconst\b/ &&
79404849 4663 $line =~ /\bstruct\s+($struct_ops)\b/) {
000d1cc1
JP
4664 WARN("CONST_STRUCT",
4665 "struct $1 should normally be const\n" .
6903ffb2 4666 $herecurr);
2b6db5cb 4667 }
773647a0
AW
4668
4669# use of NR_CPUS is usually wrong
4670# ignore definitions of NR_CPUS and usage to define arrays as likely right
4671 if ($line =~ /\bNR_CPUS\b/ &&
c45dcabd
AW
4672 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4673 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
171ae1a4
AW
4674 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4675 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4676 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
773647a0 4677 {
000d1cc1
JP
4678 WARN("NR_CPUS",
4679 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
773647a0 4680 }
9c9ba34e 4681
52ea8506
JP
4682# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
4683 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
4684 ERROR("DEFINE_ARCH_HAS",
4685 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
4686 }
4687
9c9ba34e
AW
4688# check for %L{u,d,i} in strings
4689 my $string;
4690 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4691 $string = substr($rawline, $-[1], $+[1] - $-[1]);
2a1bc5d5 4692 $string =~ s/%%/__/g;
9c9ba34e 4693 if ($string =~ /(?<!%)%L[udi]/) {
000d1cc1
JP
4694 WARN("PRINTF_L",
4695 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
9c9ba34e
AW
4696 last;
4697 }
4698 }
691d77b6
AW
4699
4700# whine mightly about in_atomic
4701 if ($line =~ /\bin_atomic\s*\(/) {
4702 if ($realfile =~ m@^drivers/@) {
000d1cc1
JP
4703 ERROR("IN_ATOMIC",
4704 "do not use in_atomic in drivers\n" . $herecurr);
f4a87736 4705 } elsif ($realfile !~ m@^kernel/@) {
000d1cc1
JP
4706 WARN("IN_ATOMIC",
4707 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
691d77b6
AW
4708 }
4709 }
1704f47b
PZ
4710
4711# check for lockdep_set_novalidate_class
4712 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
4713 $line =~ /__lockdep_no_validate__\s*\)/ ) {
4714 if ($realfile !~ m@^kernel/lockdep@ &&
4715 $realfile !~ m@^include/linux/lockdep@ &&
4716 $realfile !~ m@^drivers/base/core@) {
000d1cc1
JP
4717 ERROR("LOCKDEP",
4718 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
1704f47b
PZ
4719 }
4720 }
88f8831c
DJ
4721
4722 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
4723 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
000d1cc1
JP
4724 WARN("EXPORTED_WORLD_WRITABLE",
4725 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
88f8831c 4726 }
2435880f 4727
515a235e
JP
4728# Mode permission misuses where it seems decimal should be octal
4729# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
4730 if ($^V && $^V ge 5.10.0 &&
4731 $line =~ /$mode_perms_search/) {
4732 foreach my $entry (@mode_permission_funcs) {
4733 my $func = $entry->[0];
4734 my $arg_pos = $entry->[1];
4735
4736 my $skip_args = "";
4737 if ($arg_pos > 1) {
4738 $arg_pos--;
4739 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
4740 }
4741 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
4742 if ($line =~ /$test/) {
4743 my $val = $1;
4744 $val = $6 if ($skip_args ne "");
4745
4746 if ($val !~ /^0$/ &&
4747 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
4748 length($val) ne 4)) {
4749 ERROR("NON_OCTAL_PERMISSIONS",
4750 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
4751 }
2435880f
JP
4752 }
4753 }
4754 }
13214adf
AW
4755 }
4756
4757 # If we have no input at all, then there is nothing to report on
4758 # so just keep quiet.
4759 if ($#rawlines == -1) {
4760 exit(0);
0a920b5b
AW
4761 }
4762
8905a67c
AW
4763 # In mailback mode only produce a report in the negative, for
4764 # things that appear to be patches.
4765 if ($mailback && ($clean == 1 || !$is_patch)) {
4766 exit(0);
4767 }
4768
4769 # This is not a patch, and we are are in 'no-patch' mode so
4770 # just keep quiet.
4771 if (!$chk_patch && !$is_patch) {
4772 exit(0);
4773 }
4774
4775 if (!$is_patch) {
000d1cc1
JP
4776 ERROR("NOT_UNIFIED_DIFF",
4777 "Does not appear to be a unified-diff format patch\n");
0a920b5b
AW
4778 }
4779 if ($is_patch && $chk_signoff && $signoff == 0) {
000d1cc1
JP
4780 ERROR("MISSING_SIGN_OFF",
4781 "Missing Signed-off-by: line(s)\n");
0a920b5b
AW
4782 }
4783
8905a67c 4784 print report_dump();
13214adf
AW
4785 if ($summary && !($clean == 1 && $quiet == 1)) {
4786 print "$filename " if ($summary_file);
8905a67c
AW
4787 print "total: $cnt_error errors, $cnt_warn warnings, " .
4788 (($check)? "$cnt_chk checks, " : "") .
4789 "$cnt_lines lines checked\n";
4790 print "\n" if ($quiet == 0);
f0a594c1 4791 }
8905a67c 4792
d2c0a235 4793 if ($quiet == 0) {
d1fe9c09
JP
4794
4795 if ($^V lt 5.10.0) {
4796 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
4797 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
4798 }
4799
d2c0a235
AW
4800 # If there were whitespace errors which cleanpatch can fix
4801 # then suggest that.
4802 if ($rpt_cleaners) {
4803 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
4804 print " scripts/cleanfile\n\n";
b0781216 4805 $rpt_cleaners = 0;
d2c0a235
AW
4806 }
4807 }
4808
91bfe484
JP
4809 hash_show_words(\%use_type, "Used");
4810 hash_show_words(\%ignore_type, "Ignored");
000d1cc1 4811
3705ce5b 4812 if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
9624b8d6
JP
4813 my $newfile = $filename;
4814 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
3705ce5b
JP
4815 my $linecount = 0;
4816 my $f;
4817
4818 open($f, '>', $newfile)
4819 or die "$P: Can't open $newfile for write\n";
4820 foreach my $fixed_line (@fixed) {
4821 $linecount++;
4822 if ($file) {
4823 if ($linecount > 3) {
4824 $fixed_line =~ s/^\+//;
4825 print $f $fixed_line. "\n";
4826 }
4827 } else {
4828 print $f $fixed_line . "\n";
4829 }
4830 }
4831 close($f);
4832
4833 if (!$quiet) {
4834 print << "EOM";
4835Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
4836
4837Do _NOT_ trust the results written to this file.
4838Do _NOT_ submit these changes without inspecting them for correctness.
4839
4840This EXPERIMENTAL file is simply a convenience to help rewrite patches.
4841No warranties, expressed or implied...
4842
4843EOM
4844 }
4845 }
4846
0a920b5b 4847 if ($clean == 1 && $quiet == 0) {
c2fdda0d 4848 print "$vname has no obvious style problems and is ready for submission.\n"
0a920b5b
AW
4849 }
4850 if ($clean == 0 && $quiet == 0) {
000d1cc1
JP
4851 print << "EOM";
4852$vname has style problems, please review.
4853
4854If any of these errors are false positives, please report
4855them to the maintainer, see CHECKPATCH in MAINTAINERS.
4856EOM
0a920b5b 4857 }
13214adf 4858
0a920b5b
AW
4859 return $clean;
4860}