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