media: gspca_kinect: cast sizeof to int for comparison
[linux-2.6-block.git] / scripts / checkpatch.pl
CommitLineData
cb77f0d6 1#!/usr/bin/env perl
882ea1d6
JP
2# SPDX-License-Identifier: GPL-2.0
3#
dbf004d7 4# (c) 2001, Dave Jones. (the file handling bit)
00df344f 5# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
2a5a2c25 6# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
015830be 7# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
882ea1d6 8# (c) 2010-2018 Joe Perches <joe@perches.com>
0a920b5b
AW
9
10use strict;
cb77f0d6 11use warnings;
c707a81d 12use POSIX;
36061e38
JP
13use File::Basename;
14use Cwd 'abs_path';
57230297 15use Term::ANSIColor qw(:constants);
0a920b5b
AW
16
17my $P = $0;
36061e38 18my $D = dirname(abs_path($P));
0a920b5b 19
000d1cc1 20my $V = '0.32';
0a920b5b
AW
21
22use Getopt::Long qw(:config no_auto_abbrev);
23
24my $quiet = 0;
25my $tree = 1;
26my $chk_signoff = 1;
27my $chk_patch = 1;
773647a0 28my $tst_only;
6c72ffaa 29my $emacs = 0;
8905a67c 30my $terse = 0;
34d8815f 31my $showfile = 0;
6c72ffaa 32my $file = 0;
4a593c34 33my $git = 0;
0dea9f1e 34my %git_commits = ();
6c72ffaa 35my $check = 0;
2ac73b4f 36my $check_orig = 0;
8905a67c
AW
37my $summary = 1;
38my $mailback = 0;
13214adf 39my $summary_file = 0;
000d1cc1 40my $show_types = 0;
3beb42ec 41my $list_types = 0;
3705ce5b 42my $fix = 0;
9624b8d6 43my $fix_inplace = 0;
6c72ffaa 44my $root;
c2fdda0d 45my %debug;
3445686a 46my %camelcase = ();
91bfe484
JP
47my %use_type = ();
48my @use = ();
49my %ignore_type = ();
000d1cc1 50my @ignore = ();
77f5b10a 51my $help = 0;
000d1cc1 52my $configuration_file = ".checkpatch.conf";
6cd7f386 53my $max_line_length = 80;
d62a201f
DH
54my $ignore_perl_version = 0;
55my $minimum_perl_version = 5.10.0;
56193274 56my $min_conf_desc_length = 4;
66b47b4a 57my $spelling_file = "$D/spelling.txt";
ebfd7d62 58my $codespell = 0;
f1a63678 59my $codespellfile = "/usr/share/codespell/dictionary.txt";
bf1fa1da 60my $conststructsfile = "$D/const_structs.checkpatch";
75ad8c57 61my $typedefsfile = "";
737c0767 62my $color = "auto";
dadf680d 63my $allow_c99_comments = 1;
77f5b10a
HE
64
65sub help {
66 my ($exitcode) = @_;
67
68 print << "EOM";
69Usage: $P [OPTION]... [FILE]...
70Version: $V
71
72Options:
73 -q, --quiet quiet
74 --no-tree run without a kernel tree
75 --no-signoff do not check for 'Signed-off-by' line
76 --patch treat FILE as patchfile (default)
77 --emacs emacs compile window format
78 --terse one line per report
34d8815f 79 --showfile emit diffed file position, not input file position
4a593c34
DC
80 -g, --git treat FILE as a single commit or git revision range
81 single git commit with:
82 <rev>
83 <rev>^
84 <rev>~n
85 multiple git commits with:
86 <rev1>..<rev2>
87 <rev1>...<rev2>
88 <rev>-<count>
89 git merges are ignored
77f5b10a
HE
90 -f, --file treat FILE as regular source file
91 --subjective, --strict enable more subjective tests
3beb42ec 92 --list-types list the possible message types
91bfe484 93 --types TYPE(,TYPE2...) show only these comma separated message types
000d1cc1 94 --ignore TYPE(,TYPE2...) ignore various comma separated message types
3beb42ec 95 --show-types show the specific message type in the output
6cd7f386 96 --max-line-length=n set the maximum line length, if exceeded, warn
56193274 97 --min-conf-desc-length=n set the min description length, if shorter, warn
77f5b10a
HE
98 --root=PATH PATH to the kernel tree root
99 --no-summary suppress the per-file summary
100 --mailback only produce a report in case of warnings/errors
101 --summary-file include the filename in summary
102 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
103 'values', 'possible', 'type', and 'attr' (default
104 is all off)
105 --test-only=WORD report only warnings/errors containing WORD
106 literally
3705ce5b
JP
107 --fix EXPERIMENTAL - may create horrible results
108 If correctable single-line errors exist, create
109 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
110 with potential errors corrected to the preferred
111 checkpatch style
9624b8d6
JP
112 --fix-inplace EXPERIMENTAL - may create horrible results
113 Is the same as --fix, but overwrites the input
114 file. It's your fault if there's no backup or git
d62a201f
DH
115 --ignore-perl-version override checking of perl version. expect
116 runtime errors.
ebfd7d62 117 --codespell Use the codespell dictionary for spelling/typos
f1a63678 118 (default:/usr/share/codespell/dictionary.txt)
ebfd7d62 119 --codespellfile Use this codespell dictionary
75ad8c57 120 --typedefsfile Read additional types from this file
737c0767
JB
121 --color[=WHEN] Use colors 'always', 'never', or only when output
122 is a terminal ('auto'). Default is 'auto'.
77f5b10a
HE
123 -h, --help, --version display this help and exit
124
125When FILE is - read standard input.
126EOM
127
128 exit($exitcode);
129}
130
3beb42ec
JP
131sub uniq {
132 my %seen;
133 return grep { !$seen{$_}++ } @_;
134}
135
136sub list_types {
137 my ($exitcode) = @_;
138
139 my $count = 0;
140
141 local $/ = undef;
142
143 open(my $script, '<', abs_path($P)) or
144 die "$P: Can't read '$P' $!\n";
145
146 my $text = <$script>;
147 close($script);
148
149 my @types = ();
0547fa58
JD
150 # Also catch when type or level is passed through a variable
151 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
3beb42ec
JP
152 push (@types, $_);
153 }
154 @types = sort(uniq(@types));
155 print("#\tMessage type\n\n");
156 foreach my $type (@types) {
157 print(++$count . "\t" . $type . "\n");
158 }
159
160 exit($exitcode);
161}
162
000d1cc1
JP
163my $conf = which_conf($configuration_file);
164if (-f $conf) {
165 my @conf_args;
166 open(my $conffile, '<', "$conf")
167 or warn "$P: Can't find a readable $configuration_file file $!\n";
168
169 while (<$conffile>) {
170 my $line = $_;
171
172 $line =~ s/\s*\n?$//g;
173 $line =~ s/^\s*//g;
174 $line =~ s/\s+/ /g;
175
176 next if ($line =~ m/^\s*#/);
177 next if ($line =~ m/^\s*$/);
178
179 my @words = split(" ", $line);
180 foreach my $word (@words) {
181 last if ($word =~ m/^#/);
182 push (@conf_args, $word);
183 }
184 }
185 close($conffile);
186 unshift(@ARGV, @conf_args) if @conf_args;
187}
188
737c0767
JB
189# Perl's Getopt::Long allows options to take optional arguments after a space.
190# Prevent --color by itself from consuming other arguments
191foreach (@ARGV) {
192 if ($_ eq "--color" || $_ eq "-color") {
193 $_ = "--color=$color";
194 }
195}
196
0a920b5b 197GetOptions(
6c72ffaa 198 'q|quiet+' => \$quiet,
0a920b5b
AW
199 'tree!' => \$tree,
200 'signoff!' => \$chk_signoff,
201 'patch!' => \$chk_patch,
6c72ffaa 202 'emacs!' => \$emacs,
8905a67c 203 'terse!' => \$terse,
34d8815f 204 'showfile!' => \$showfile,
77f5b10a 205 'f|file!' => \$file,
4a593c34 206 'g|git!' => \$git,
6c72ffaa
AW
207 'subjective!' => \$check,
208 'strict!' => \$check,
000d1cc1 209 'ignore=s' => \@ignore,
91bfe484 210 'types=s' => \@use,
000d1cc1 211 'show-types!' => \$show_types,
3beb42ec 212 'list-types!' => \$list_types,
6cd7f386 213 'max-line-length=i' => \$max_line_length,
56193274 214 'min-conf-desc-length=i' => \$min_conf_desc_length,
6c72ffaa 215 'root=s' => \$root,
8905a67c
AW
216 'summary!' => \$summary,
217 'mailback!' => \$mailback,
13214adf 218 'summary-file!' => \$summary_file,
3705ce5b 219 'fix!' => \$fix,
9624b8d6 220 'fix-inplace!' => \$fix_inplace,
d62a201f 221 'ignore-perl-version!' => \$ignore_perl_version,
c2fdda0d 222 'debug=s' => \%debug,
773647a0 223 'test-only=s' => \$tst_only,
ebfd7d62
JP
224 'codespell!' => \$codespell,
225 'codespellfile=s' => \$codespellfile,
75ad8c57 226 'typedefsfile=s' => \$typedefsfile,
737c0767
JB
227 'color=s' => \$color,
228 'no-color' => \$color, #keep old behaviors of -nocolor
229 'nocolor' => \$color, #keep old behaviors of -nocolor
77f5b10a
HE
230 'h|help' => \$help,
231 'version' => \$help
232) or help(1);
233
234help(0) if ($help);
0a920b5b 235
3beb42ec
JP
236list_types(0) if ($list_types);
237
9624b8d6 238$fix = 1 if ($fix_inplace);
2ac73b4f 239$check_orig = $check;
9624b8d6 240
0a920b5b
AW
241my $exit = 0;
242
d62a201f
DH
243if ($^V && $^V lt $minimum_perl_version) {
244 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
245 if (!$ignore_perl_version) {
246 exit(1);
247 }
248}
249
45107ff6 250#if no filenames are given, push '-' to read patch from stdin
0a920b5b 251if ($#ARGV < 0) {
45107ff6 252 push(@ARGV, '-');
0a920b5b
AW
253}
254
737c0767
JB
255if ($color =~ /^[01]$/) {
256 $color = !$color;
257} elsif ($color =~ /^always$/i) {
258 $color = 1;
259} elsif ($color =~ /^never$/i) {
260 $color = 0;
261} elsif ($color =~ /^auto$/i) {
262 $color = (-t STDOUT);
263} else {
264 die "Invalid color mode: $color\n";
265}
266
91bfe484
JP
267sub hash_save_array_words {
268 my ($hashRef, $arrayRef) = @_;
269
270 my @array = split(/,/, join(',', @$arrayRef));
271 foreach my $word (@array) {
272 $word =~ s/\s*\n?$//g;
273 $word =~ s/^\s*//g;
274 $word =~ s/\s+/ /g;
275 $word =~ tr/[a-z]/[A-Z]/;
276
277 next if ($word =~ m/^\s*#/);
278 next if ($word =~ m/^\s*$/);
279
280 $hashRef->{$word}++;
281 }
282}
000d1cc1 283
91bfe484
JP
284sub hash_show_words {
285 my ($hashRef, $prefix) = @_;
000d1cc1 286
3c816e49 287 if (keys %$hashRef) {
d8469f16 288 print "\nNOTE: $prefix message types:";
58cb3cf6 289 foreach my $word (sort keys %$hashRef) {
91bfe484
JP
290 print " $word";
291 }
d8469f16 292 print "\n";
91bfe484 293 }
000d1cc1
JP
294}
295
91bfe484
JP
296hash_save_array_words(\%ignore_type, \@ignore);
297hash_save_array_words(\%use_type, \@use);
298
c2fdda0d
AW
299my $dbg_values = 0;
300my $dbg_possible = 0;
7429c690 301my $dbg_type = 0;
a1ef277e 302my $dbg_attr = 0;
c2fdda0d 303for my $key (keys %debug) {
21caa13c
AW
304 ## no critic
305 eval "\${dbg_$key} = '$debug{$key}';";
306 die "$@" if ($@);
c2fdda0d
AW
307}
308
d2c0a235
AW
309my $rpt_cleaners = 0;
310
8905a67c
AW
311if ($terse) {
312 $emacs = 1;
313 $quiet++;
314}
315
6c72ffaa
AW
316if ($tree) {
317 if (defined $root) {
318 if (!top_of_kernel_tree($root)) {
319 die "$P: $root: --root does not point at a valid tree\n";
320 }
321 } else {
322 if (top_of_kernel_tree('.')) {
323 $root = '.';
324 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
325 top_of_kernel_tree($1)) {
326 $root = $1;
327 }
328 }
329
330 if (!defined $root) {
331 print "Must be run from the top-level dir. of a kernel tree\n";
332 exit(2);
333 }
0a920b5b
AW
334}
335
6c72ffaa
AW
336my $emitted_corrupt = 0;
337
2ceb532b
AW
338our $Ident = qr{
339 [A-Za-z_][A-Za-z\d_]*
340 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
341 }x;
6c72ffaa
AW
342our $Storage = qr{extern|static|asmlinkage};
343our $Sparse = qr{
344 __user|
345 __kernel|
346 __force|
347 __iomem|
348 __must_check|
349 __init_refok|
417495ed 350 __kprobes|
165e72a6 351 __ref|
ad315455
BF
352 __rcu|
353 __private
6c72ffaa 354 }x;
e970b884
JP
355our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
356our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
357our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
358our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
359our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
8716de38 360
52131292
WS
361# Notes to $Attribute:
362# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
6c72ffaa
AW
363our $Attribute = qr{
364 const|
03f1df7d
JP
365 __percpu|
366 __nocast|
367 __safe|
46d832f5 368 __bitwise|
03f1df7d
JP
369 __packed__|
370 __packed2__|
371 __naked|
372 __maybe_unused|
373 __always_unused|
374 __noreturn|
375 __used|
376 __cold|
e23ef1f3 377 __pure|
03f1df7d
JP
378 __noclone|
379 __deprecated|
6c72ffaa
AW
380 __read_mostly|
381 __kprobes|
8716de38 382 $InitAttribute|
24e1d81a
AW
383 ____cacheline_aligned|
384 ____cacheline_aligned_in_smp|
5fe3af11
AW
385 ____cacheline_internodealigned_in_smp|
386 __weak
6c72ffaa 387 }x;
c45dcabd 388our $Modifier;
91cb5195 389our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
6c72ffaa
AW
390our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
391our $Lval = qr{$Ident(?:$Member)*};
392
95e2c602
JP
393our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
394our $Binary = qr{(?i)0b[01]+$Int_type?};
395our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
396our $Int = qr{[0-9]+$Int_type?};
2435880f 397our $Octal = qr{0[0-7]+$Int_type?};
c0a5c898 398our $String = qr{"[X\t]*"};
326b1ffc
JP
399our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
400our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
401our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
74349bcc 402our $Float = qr{$Float_hex|$Float_dec|$Float_int};
2435880f 403our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
326b1ffc 404our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
447432f3 405our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
23f780c9 406our $Arithmetic = qr{\+|-|\*|\/|%};
6c72ffaa
AW
407our $Operators = qr{
408 <=|>=|==|!=|
409 =>|->|<<|>>|<|>|!|~|
23f780c9 410 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
6c72ffaa
AW
411 }x;
412
91cb5195
JP
413our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
414
ab7e23f3 415our $BasicType;
8905a67c 416our $NonptrType;
1813087d 417our $NonptrTypeMisordered;
8716de38 418our $NonptrTypeWithAttr;
8905a67c 419our $Type;
1813087d 420our $TypeMisordered;
8905a67c 421our $Declare;
1813087d 422our $DeclareMisordered;
8905a67c 423
15662b3e
JP
424our $NON_ASCII_UTF8 = qr{
425 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
171ae1a4
AW
426 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
427 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
428 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
429 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
430 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
431 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
432}x;
433
15662b3e
JP
434our $UTF8 = qr{
435 [\x09\x0A\x0D\x20-\x7E] # ASCII
436 | $NON_ASCII_UTF8
437}x;
438
e6176fa4 439our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
021158b4
JP
440our $typeOtherOSTypedefs = qr{(?x:
441 u_(?:char|short|int|long) | # bsd
442 u(?:nchar|short|int|long) # sysv
443)};
e6176fa4 444our $typeKernelTypedefs = qr{(?x:
fb9e9096 445 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
8ed22cad
AW
446 atomic_t
447)};
e6176fa4
JP
448our $typeTypedefs = qr{(?x:
449 $typeC99Typedefs\b|
450 $typeOtherOSTypedefs\b|
451 $typeKernelTypedefs\b
452)};
8ed22cad 453
6d32f7a3
JP
454our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
455
691e669b 456our $logFunctions = qr{(?x:
758d7aad 457 printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
7d0b6594 458 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
87bd499a 459 TP_printk|
6e60c02e 460 WARN(?:_RATELIMIT|_ONCE|)|
b0531722 461 panic|
06668727
JP
462 MODULE_[A-Z_]+|
463 seq_vprintf|seq_printf|seq_puts
691e669b
JP
464)};
465
20112475
JP
466our $signature_tags = qr{(?xi:
467 Signed-off-by:|
468 Acked-by:|
469 Tested-by:|
470 Reviewed-by:|
471 Reported-by:|
8543ae12 472 Suggested-by:|
20112475
JP
473 To:|
474 Cc:
475)};
476
1813087d
JP
477our @typeListMisordered = (
478 qr{char\s+(?:un)?signed},
479 qr{int\s+(?:(?:un)?signed\s+)?short\s},
480 qr{int\s+short(?:\s+(?:un)?signed)},
481 qr{short\s+int(?:\s+(?:un)?signed)},
482 qr{(?:un)?signed\s+int\s+short},
483 qr{short\s+(?:un)?signed},
484 qr{long\s+int\s+(?:un)?signed},
485 qr{int\s+long\s+(?:un)?signed},
486 qr{long\s+(?:un)?signed\s+int},
487 qr{int\s+(?:un)?signed\s+long},
488 qr{int\s+(?:un)?signed},
489 qr{int\s+long\s+long\s+(?:un)?signed},
490 qr{long\s+long\s+int\s+(?:un)?signed},
491 qr{long\s+long\s+(?:un)?signed\s+int},
492 qr{long\s+long\s+(?:un)?signed},
493 qr{long\s+(?:un)?signed},
494);
495
8905a67c
AW
496our @typeList = (
497 qr{void},
0c773d9d
JP
498 qr{(?:(?:un)?signed\s+)?char},
499 qr{(?:(?:un)?signed\s+)?short\s+int},
500 qr{(?:(?:un)?signed\s+)?short},
501 qr{(?:(?:un)?signed\s+)?int},
502 qr{(?:(?:un)?signed\s+)?long\s+int},
503 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
504 qr{(?:(?:un)?signed\s+)?long\s+long},
505 qr{(?:(?:un)?signed\s+)?long},
506 qr{(?:un)?signed},
8905a67c
AW
507 qr{float},
508 qr{double},
509 qr{bool},
8905a67c
AW
510 qr{struct\s+$Ident},
511 qr{union\s+$Ident},
512 qr{enum\s+$Ident},
513 qr{${Ident}_t},
514 qr{${Ident}_handler},
515 qr{${Ident}_handler_fn},
1813087d 516 @typeListMisordered,
8905a67c 517);
938224b5
JP
518
519our $C90_int_types = qr{(?x:
520 long\s+long\s+int\s+(?:un)?signed|
521 long\s+long\s+(?:un)?signed\s+int|
522 long\s+long\s+(?:un)?signed|
523 (?:(?:un)?signed\s+)?long\s+long\s+int|
524 (?:(?:un)?signed\s+)?long\s+long|
525 int\s+long\s+long\s+(?:un)?signed|
526 int\s+(?:(?:un)?signed\s+)?long\s+long|
527
528 long\s+int\s+(?:un)?signed|
529 long\s+(?:un)?signed\s+int|
530 long\s+(?:un)?signed|
531 (?:(?:un)?signed\s+)?long\s+int|
532 (?:(?:un)?signed\s+)?long|
533 int\s+long\s+(?:un)?signed|
534 int\s+(?:(?:un)?signed\s+)?long|
535
536 int\s+(?:un)?signed|
537 (?:(?:un)?signed\s+)?int
538)};
539
485ff23e 540our @typeListFile = ();
8716de38
JP
541our @typeListWithAttr = (
542 @typeList,
543 qr{struct\s+$InitAttribute\s+$Ident},
544 qr{union\s+$InitAttribute\s+$Ident},
545);
546
c45dcabd
AW
547our @modifierList = (
548 qr{fastcall},
549);
485ff23e 550our @modifierListFile = ();
8905a67c 551
2435880f
JP
552our @mode_permission_funcs = (
553 ["module_param", 3],
554 ["module_param_(?:array|named|string)", 4],
555 ["module_param_array_named", 5],
556 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
557 ["proc_create(?:_data|)", 2],
459cf0ae
JP
558 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
559 ["IIO_DEV_ATTR_[A-Z_]+", 1],
560 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
561 ["SENSOR_TEMPLATE(?:_2|)", 3],
562 ["__ATTR", 2],
2435880f
JP
563);
564
515a235e
JP
565#Create a search pattern for all these functions to speed up a loop below
566our $mode_perms_search = "";
567foreach my $entry (@mode_permission_funcs) {
568 $mode_perms_search .= '|' if ($mode_perms_search ne "");
569 $mode_perms_search .= $entry->[0];
570}
00180468 571$mode_perms_search = "(?:${mode_perms_search})";
515a235e 572
b392c64f
JP
573our $mode_perms_world_writable = qr{
574 S_IWUGO |
575 S_IWOTH |
576 S_IRWXUGO |
577 S_IALLUGO |
578 0[0-7][0-7][2367]
579}x;
580
f90774e1
JP
581our %mode_permission_string_types = (
582 "S_IRWXU" => 0700,
583 "S_IRUSR" => 0400,
584 "S_IWUSR" => 0200,
585 "S_IXUSR" => 0100,
586 "S_IRWXG" => 0070,
587 "S_IRGRP" => 0040,
588 "S_IWGRP" => 0020,
589 "S_IXGRP" => 0010,
590 "S_IRWXO" => 0007,
591 "S_IROTH" => 0004,
592 "S_IWOTH" => 0002,
593 "S_IXOTH" => 0001,
594 "S_IRWXUGO" => 0777,
595 "S_IRUGO" => 0444,
596 "S_IWUGO" => 0222,
597 "S_IXUGO" => 0111,
598);
599
600#Create a search pattern for all these strings to speed up a loop below
601our $mode_perms_string_search = "";
602foreach my $entry (keys %mode_permission_string_types) {
603 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
604 $mode_perms_string_search .= $entry;
605}
00180468
JP
606our $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
607our $multi_mode_perms_string_search = qr{
608 ${single_mode_perms_string_search}
609 (?:\s*\|\s*${single_mode_perms_string_search})*
610}x;
611
612sub perms_to_octal {
613 my ($string) = @_;
614
615 return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
616
617 my $val = "";
618 my $oval = "";
619 my $to = 0;
620 my $curpos = 0;
621 my $lastpos = 0;
622 while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
623 $curpos = pos($string);
624 my $match = $2;
625 my $omatch = $1;
626 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
627 $lastpos = $curpos;
628 $to |= $mode_permission_string_types{$match};
629 $val .= '\s*\|\s*' if ($val ne "");
630 $val .= $match;
631 $oval .= $omatch;
632 }
633 $oval =~ s/^\s*\|\s*//;
634 $oval =~ s/\s*\|\s*$//;
635 return sprintf("%04o", $to);
636}
f90774e1 637
7840a94c
WS
638our $allowed_asm_includes = qr{(?x:
639 irq|
cdcee686
SR
640 memory|
641 time|
642 reboot
7840a94c
WS
643)};
644# memory.h: ARM has a custom one
645
66b47b4a
KC
646# Load common spelling mistakes and build regular expression list.
647my $misspellings;
66b47b4a 648my %spelling_fix;
66b47b4a 649
36061e38 650if (open(my $spelling, '<', $spelling_file)) {
36061e38
JP
651 while (<$spelling>) {
652 my $line = $_;
66b47b4a 653
36061e38
JP
654 $line =~ s/\s*\n?$//g;
655 $line =~ s/^\s*//g;
66b47b4a 656
36061e38
JP
657 next if ($line =~ m/^\s*#/);
658 next if ($line =~ m/^\s*$/);
659
660 my ($suspect, $fix) = split(/\|\|/, $line);
66b47b4a 661
36061e38
JP
662 $spelling_fix{$suspect} = $fix;
663 }
664 close($spelling);
36061e38
JP
665} else {
666 warn "No typos will be found - file '$spelling_file': $!\n";
66b47b4a 667}
66b47b4a 668
ebfd7d62
JP
669if ($codespell) {
670 if (open(my $spelling, '<', $codespellfile)) {
671 while (<$spelling>) {
672 my $line = $_;
673
674 $line =~ s/\s*\n?$//g;
675 $line =~ s/^\s*//g;
676
677 next if ($line =~ m/^\s*#/);
678 next if ($line =~ m/^\s*$/);
679 next if ($line =~ m/, disabled/i);
680
681 $line =~ s/,.*$//;
682
683 my ($suspect, $fix) = split(/->/, $line);
684
685 $spelling_fix{$suspect} = $fix;
686 }
687 close($spelling);
688 } else {
689 warn "No codespell typos will be found - file '$codespellfile': $!\n";
690 }
691}
692
693$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
694
75ad8c57
JF
695sub read_words {
696 my ($wordsRef, $file) = @_;
bf1fa1da 697
75ad8c57
JF
698 if (open(my $words, '<', $file)) {
699 while (<$words>) {
700 my $line = $_;
bf1fa1da 701
75ad8c57
JF
702 $line =~ s/\s*\n?$//g;
703 $line =~ s/^\s*//g;
bf1fa1da 704
75ad8c57
JF
705 next if ($line =~ m/^\s*#/);
706 next if ($line =~ m/^\s*$/);
707 if ($line =~ /\s/) {
708 print("$file: '$line' invalid - ignored\n");
709 next;
710 }
711
712 $$wordsRef .= '|' if ($$wordsRef ne "");
713 $$wordsRef .= $line;
714 }
715 close($file);
716 return 1;
bf1fa1da 717 }
75ad8c57
JF
718
719 return 0;
720}
721
722my $const_structs = "";
723read_words(\$const_structs, $conststructsfile)
724 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
725
726my $typeOtherTypedefs = "";
727if (length($typedefsfile)) {
728 read_words(\$typeOtherTypedefs, $typedefsfile)
729 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
bf1fa1da 730}
75ad8c57 731$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne "");
bf1fa1da 732
8905a67c 733sub build_types {
485ff23e
AD
734 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
735 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
1813087d 736 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
8716de38 737 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
c8cb2ca3 738 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
ab7e23f3 739 $BasicType = qr{
ab7e23f3
JP
740 (?:$typeTypedefs\b)|
741 (?:${all}\b)
742 }x;
8905a67c 743 $NonptrType = qr{
d2172eb5 744 (?:$Modifier\s+|const\s+)*
cf655043 745 (?:
6b48db24 746 (?:typeof|__typeof__)\s*\([^\)]*\)|
8ed22cad 747 (?:$typeTypedefs\b)|
c45dcabd 748 (?:${all}\b)
cf655043 749 )
c8cb2ca3 750 (?:\s+$Modifier|\s+const)*
8905a67c 751 }x;
1813087d
JP
752 $NonptrTypeMisordered = qr{
753 (?:$Modifier\s+|const\s+)*
754 (?:
755 (?:${Misordered}\b)
756 )
757 (?:\s+$Modifier|\s+const)*
758 }x;
8716de38
JP
759 $NonptrTypeWithAttr = qr{
760 (?:$Modifier\s+|const\s+)*
761 (?:
762 (?:typeof|__typeof__)\s*\([^\)]*\)|
763 (?:$typeTypedefs\b)|
764 (?:${allWithAttr}\b)
765 )
766 (?:\s+$Modifier|\s+const)*
767 }x;
8905a67c 768 $Type = qr{
c45dcabd 769 $NonptrType
1574a29f 770 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
c8cb2ca3 771 (?:\s+$Inline|\s+$Modifier)*
8905a67c 772 }x;
1813087d
JP
773 $TypeMisordered = qr{
774 $NonptrTypeMisordered
775 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
776 (?:\s+$Inline|\s+$Modifier)*
777 }x;
91cb5195 778 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
1813087d 779 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
8905a67c
AW
780}
781build_types();
6c72ffaa 782
7d2367af 783our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
d1fe9c09
JP
784
785# Using $balanced_parens, $LvalOrFunc, or $FuncArg
786# requires at least perl version v5.10.0
787# Any use must be runtime checked with $^V
788
789our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
2435880f 790our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
c0a5c898 791our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
7d2367af 792
f8422308 793our $declaration_macros = qr{(?x:
3e838b6c 794 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
fe658f94 795 (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
3d102fc0
GBY
796 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(|
797 (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(
f8422308
JP
798)};
799
7d2367af
JP
800sub deparenthesize {
801 my ($string) = @_;
802 return "" if (!defined($string));
5b9553ab
JP
803
804 while ($string =~ /^\s*\(.*\)\s*$/) {
805 $string =~ s@^\s*\(\s*@@;
806 $string =~ s@\s*\)\s*$@@;
807 }
808
7d2367af 809 $string =~ s@\s+@ @g;
5b9553ab 810
7d2367af
JP
811 return $string;
812}
813
3445686a
JP
814sub seed_camelcase_file {
815 my ($file) = @_;
816
817 return if (!(-f $file));
818
819 local $/;
820
821 open(my $include_file, '<', "$file")
822 or warn "$P: Can't read '$file' $!\n";
823 my $text = <$include_file>;
824 close($include_file);
825
826 my @lines = split('\n', $text);
827
828 foreach my $line (@lines) {
829 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
830 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
831 $camelcase{$1} = 1;
11ea516a
JP
832 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
833 $camelcase{$1} = 1;
834 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
3445686a
JP
835 $camelcase{$1} = 1;
836 }
837 }
838}
839
85b0ee18
JP
840sub is_maintained_obsolete {
841 my ($filename) = @_;
842
f2c19c2f 843 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
85b0ee18 844
0616efa4 845 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
85b0ee18
JP
846
847 return $status =~ /obsolete/i;
848}
849
3445686a
JP
850my $camelcase_seeded = 0;
851sub seed_camelcase_includes {
852 return if ($camelcase_seeded);
853
854 my $files;
c707a81d
JP
855 my $camelcase_cache = "";
856 my @include_files = ();
857
858 $camelcase_seeded = 1;
351b2a1f 859
3645e328 860 if (-e ".git") {
351b2a1f
JP
861 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
862 chomp $git_last_include_commit;
c707a81d 863 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
3445686a 864 } else {
c707a81d 865 my $last_mod_date = 0;
3445686a 866 $files = `find $root/include -name "*.h"`;
c707a81d
JP
867 @include_files = split('\n', $files);
868 foreach my $file (@include_files) {
869 my $date = POSIX::strftime("%Y%m%d%H%M",
870 localtime((stat $file)[9]));
871 $last_mod_date = $date if ($last_mod_date < $date);
872 }
873 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
874 }
875
876 if ($camelcase_cache ne "" && -f $camelcase_cache) {
877 open(my $camelcase_file, '<', "$camelcase_cache")
878 or warn "$P: Can't read '$camelcase_cache' $!\n";
879 while (<$camelcase_file>) {
880 chomp;
881 $camelcase{$_} = 1;
882 }
883 close($camelcase_file);
884
885 return;
3445686a 886 }
c707a81d 887
3645e328 888 if (-e ".git") {
c707a81d
JP
889 $files = `git ls-files "include/*.h"`;
890 @include_files = split('\n', $files);
891 }
892
3445686a
JP
893 foreach my $file (@include_files) {
894 seed_camelcase_file($file);
895 }
351b2a1f 896
c707a81d 897 if ($camelcase_cache ne "") {
351b2a1f 898 unlink glob ".checkpatch-camelcase.*";
c707a81d
JP
899 open(my $camelcase_file, '>', "$camelcase_cache")
900 or warn "$P: Can't write '$camelcase_cache' $!\n";
351b2a1f
JP
901 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
902 print $camelcase_file ("$_\n");
903 }
904 close($camelcase_file);
905 }
3445686a
JP
906}
907
d311cd44
JP
908sub git_commit_info {
909 my ($commit, $id, $desc) = @_;
910
911 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
912
913 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
914 $output =~ s/^\s*//gm;
915 my @lines = split("\n", $output);
916
0d7835fc
JP
917 return ($id, $desc) if ($#lines < 0);
918
d311cd44
JP
919 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
920# Maybe one day convert this block of bash into something that returns
921# all matching commit ids, but it's very slow...
922#
923# echo "checking commits $1..."
924# git rev-list --remotes | grep -i "^$1" |
925# while read line ; do
926# git log --format='%H %s' -1 $line |
927# echo "commit $(cut -c 1-12,41-)"
928# done
929 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
948b133a 930 $id = undef;
d311cd44
JP
931 } else {
932 $id = substr($lines[0], 0, 12);
933 $desc = substr($lines[0], 41);
934 }
935
936 return ($id, $desc);
937}
938
6c72ffaa
AW
939$chk_signoff = 0 if ($file);
940
00df344f 941my @rawlines = ();
c2fdda0d 942my @lines = ();
3705ce5b 943my @fixed = ();
d752fcc8
JP
944my @fixed_inserted = ();
945my @fixed_deleted = ();
194f66fc
JP
946my $fixlinenr = -1;
947
4a593c34
DC
948# If input is git commits, extract all commits from the commit expressions.
949# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
950die "$P: No git repository found\n" if ($git && !-e ".git");
951
952if ($git) {
953 my @commits = ();
0dea9f1e 954 foreach my $commit_expr (@ARGV) {
4a593c34 955 my $git_range;
28898fd1
JP
956 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
957 $git_range = "-$2 $1";
4a593c34
DC
958 } elsif ($commit_expr =~ m/\.\./) {
959 $git_range = "$commit_expr";
4a593c34 960 } else {
0dea9f1e
JP
961 $git_range = "-1 $commit_expr";
962 }
963 my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
964 foreach my $line (split(/\n/, $lines)) {
28898fd1
JP
965 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
966 next if (!defined($1) || !defined($2));
0dea9f1e
JP
967 my $sha1 = $1;
968 my $subject = $2;
969 unshift(@commits, $sha1);
970 $git_commits{$sha1} = $subject;
4a593c34
DC
971 }
972 }
973 die "$P: no git commits after extraction!\n" if (@commits == 0);
974 @ARGV = @commits;
975}
976
c2fdda0d 977my $vname;
6c72ffaa 978for my $filename (@ARGV) {
21caa13c 979 my $FILE;
4a593c34
DC
980 if ($git) {
981 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
982 die "$P: $filename: git format-patch failed - $!\n";
983 } elsif ($file) {
21caa13c 984 open($FILE, '-|', "diff -u /dev/null $filename") ||
6c72ffaa 985 die "$P: $filename: diff failed - $!\n";
21caa13c
AW
986 } elsif ($filename eq '-') {
987 open($FILE, '<&STDIN');
6c72ffaa 988 } else {
21caa13c 989 open($FILE, '<', "$filename") ||
6c72ffaa 990 die "$P: $filename: open failed - $!\n";
0a920b5b 991 }
c2fdda0d
AW
992 if ($filename eq '-') {
993 $vname = 'Your patch';
4a593c34 994 } elsif ($git) {
0dea9f1e 995 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
c2fdda0d
AW
996 } else {
997 $vname = $filename;
998 }
21caa13c 999 while (<$FILE>) {
6c72ffaa
AW
1000 chomp;
1001 push(@rawlines, $_);
1002 }
21caa13c 1003 close($FILE);
d8469f16
JP
1004
1005 if ($#ARGV > 0 && $quiet == 0) {
1006 print '-' x length($vname) . "\n";
1007 print "$vname\n";
1008 print '-' x length($vname) . "\n";
1009 }
1010
c2fdda0d 1011 if (!process($filename)) {
6c72ffaa
AW
1012 $exit = 1;
1013 }
1014 @rawlines = ();
13214adf 1015 @lines = ();
3705ce5b 1016 @fixed = ();
d752fcc8
JP
1017 @fixed_inserted = ();
1018 @fixed_deleted = ();
194f66fc 1019 $fixlinenr = -1;
485ff23e
AD
1020 @modifierListFile = ();
1021 @typeListFile = ();
1022 build_types();
0a920b5b
AW
1023}
1024
d8469f16 1025if (!$quiet) {
3c816e49
JP
1026 hash_show_words(\%use_type, "Used");
1027 hash_show_words(\%ignore_type, "Ignored");
1028
d8469f16
JP
1029 if ($^V lt 5.10.0) {
1030 print << "EOM"
1031
1032NOTE: perl $^V is not modern enough to detect all possible issues.
1033 An upgrade to at least perl v5.10.0 is suggested.
1034EOM
1035 }
1036 if ($exit) {
1037 print << "EOM"
1038
1039NOTE: If any of the errors are false positives, please report
1040 them to the maintainer, see CHECKPATCH in MAINTAINERS.
1041EOM
1042 }
1043}
1044
0a920b5b
AW
1045exit($exit);
1046
1047sub top_of_kernel_tree {
6c72ffaa
AW
1048 my ($root) = @_;
1049
1050 my @tree_check = (
1051 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1052 "README", "Documentation", "arch", "include", "drivers",
1053 "fs", "init", "ipc", "kernel", "lib", "scripts",
1054 );
1055
1056 foreach my $check (@tree_check) {
1057 if (! -e $root . '/' . $check) {
1058 return 0;
1059 }
0a920b5b 1060 }
6c72ffaa 1061 return 1;
8f26b837 1062}
0a920b5b 1063
20112475
JP
1064sub parse_email {
1065 my ($formatted_email) = @_;
1066
1067 my $name = "";
1068 my $address = "";
1069 my $comment = "";
1070
1071 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1072 $name = $1;
1073 $address = $2;
1074 $comment = $3 if defined $3;
1075 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1076 $address = $1;
1077 $comment = $2 if defined $2;
1078 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1079 $address = $1;
1080 $comment = $2 if defined $2;
85e12066 1081 $formatted_email =~ s/\Q$address\E.*$//;
20112475 1082 $name = $formatted_email;
3705ce5b 1083 $name = trim($name);
20112475
JP
1084 $name =~ s/^\"|\"$//g;
1085 # If there's a name left after stripping spaces and
1086 # leading quotes, and the address doesn't have both
1087 # leading and trailing angle brackets, the address
1088 # is invalid. ie:
1089 # "joe smith joe@smith.com" bad
1090 # "joe smith <joe@smith.com" bad
1091 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1092 $name = "";
1093 $address = "";
1094 $comment = "";
1095 }
1096 }
1097
3705ce5b 1098 $name = trim($name);
20112475 1099 $name =~ s/^\"|\"$//g;
3705ce5b 1100 $address = trim($address);
20112475
JP
1101 $address =~ s/^\<|\>$//g;
1102
1103 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1104 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1105 $name = "\"$name\"";
1106 }
1107
1108 return ($name, $address, $comment);
1109}
1110
1111sub format_email {
1112 my ($name, $address) = @_;
1113
1114 my $formatted_email;
1115
3705ce5b 1116 $name = trim($name);
20112475 1117 $name =~ s/^\"|\"$//g;
3705ce5b 1118 $address = trim($address);
20112475
JP
1119
1120 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1121 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1122 $name = "\"$name\"";
1123 }
1124
1125 if ("$name" eq "") {
1126 $formatted_email = "$address";
1127 } else {
1128 $formatted_email = "$name <$address>";
1129 }
1130
1131 return $formatted_email;
1132}
1133
d311cd44 1134sub which {
bd474ca0 1135 my ($bin) = @_;
d311cd44 1136
bd474ca0
JP
1137 foreach my $path (split(/:/, $ENV{PATH})) {
1138 if (-e "$path/$bin") {
1139 return "$path/$bin";
1140 }
d311cd44 1141 }
d311cd44 1142
bd474ca0 1143 return "";
d311cd44
JP
1144}
1145
000d1cc1
JP
1146sub which_conf {
1147 my ($conf) = @_;
1148
1149 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1150 if (-e "$path/$conf") {
1151 return "$path/$conf";
1152 }
1153 }
1154
1155 return "";
1156}
1157
0a920b5b
AW
1158sub expand_tabs {
1159 my ($str) = @_;
1160
1161 my $res = '';
1162 my $n = 0;
1163 for my $c (split(//, $str)) {
1164 if ($c eq "\t") {
1165 $res .= ' ';
1166 $n++;
1167 for (; ($n % 8) != 0; $n++) {
1168 $res .= ' ';
1169 }
1170 next;
1171 }
1172 $res .= $c;
1173 $n++;
1174 }
1175
1176 return $res;
1177}
6c72ffaa 1178sub copy_spacing {
773647a0 1179 (my $res = shift) =~ tr/\t/ /c;
6c72ffaa
AW
1180 return $res;
1181}
0a920b5b 1182
4a0df2ef
AW
1183sub line_stats {
1184 my ($line) = @_;
1185
1186 # Drop the diff line leader and expand tabs
1187 $line =~ s/^.//;
1188 $line = expand_tabs($line);
1189
1190 # Pick the indent from the front of the line.
1191 my ($white) = ($line =~ /^(\s*)/);
1192
1193 return (length($line), length($white));
1194}
1195
773647a0
AW
1196my $sanitise_quote = '';
1197
1198sub sanitise_line_reset {
1199 my ($in_comment) = @_;
1200
1201 if ($in_comment) {
1202 $sanitise_quote = '*/';
1203 } else {
1204 $sanitise_quote = '';
1205 }
1206}
00df344f
AW
1207sub sanitise_line {
1208 my ($line) = @_;
1209
1210 my $res = '';
1211 my $l = '';
1212
c2fdda0d 1213 my $qlen = 0;
773647a0
AW
1214 my $off = 0;
1215 my $c;
00df344f 1216
773647a0
AW
1217 # Always copy over the diff marker.
1218 $res = substr($line, 0, 1);
1219
1220 for ($off = 1; $off < length($line); $off++) {
1221 $c = substr($line, $off, 1);
1222
8d2e11b2 1223 # Comments we are whacking completely including the begin
773647a0
AW
1224 # and end, all to $;.
1225 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1226 $sanitise_quote = '*/';
1227
1228 substr($res, $off, 2, "$;$;");
1229 $off++;
1230 next;
00df344f 1231 }
81bc0e02 1232 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
773647a0
AW
1233 $sanitise_quote = '';
1234 substr($res, $off, 2, "$;$;");
1235 $off++;
1236 next;
c2fdda0d 1237 }
113f04a8
DW
1238 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1239 $sanitise_quote = '//';
1240
1241 substr($res, $off, 2, $sanitise_quote);
1242 $off++;
1243 next;
1244 }
773647a0
AW
1245
1246 # A \ in a string means ignore the next character.
1247 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1248 $c eq "\\") {
1249 substr($res, $off, 2, 'XX');
1250 $off++;
1251 next;
00df344f 1252 }
773647a0
AW
1253 # Regular quotes.
1254 if ($c eq "'" || $c eq '"') {
1255 if ($sanitise_quote eq '') {
1256 $sanitise_quote = $c;
00df344f 1257
773647a0
AW
1258 substr($res, $off, 1, $c);
1259 next;
1260 } elsif ($sanitise_quote eq $c) {
1261 $sanitise_quote = '';
1262 }
1263 }
00df344f 1264
fae17dae 1265 #print "c<$c> SQ<$sanitise_quote>\n";
773647a0
AW
1266 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1267 substr($res, $off, 1, $;);
113f04a8
DW
1268 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1269 substr($res, $off, 1, $;);
773647a0
AW
1270 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1271 substr($res, $off, 1, 'X');
1272 } else {
1273 substr($res, $off, 1, $c);
1274 }
c2fdda0d
AW
1275 }
1276
113f04a8
DW
1277 if ($sanitise_quote eq '//') {
1278 $sanitise_quote = '';
1279 }
1280
c2fdda0d 1281 # The pathname on a #include may be surrounded by '<' and '>'.
c45dcabd 1282 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
c2fdda0d
AW
1283 my $clean = 'X' x length($1);
1284 $res =~ s@\<.*\>@<$clean>@;
1285
1286 # The whole of a #error is a string.
c45dcabd 1287 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
c2fdda0d 1288 my $clean = 'X' x length($1);
c45dcabd 1289 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
c2fdda0d
AW
1290 }
1291
dadf680d
JP
1292 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1293 my $match = $1;
1294 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1295 }
1296
00df344f
AW
1297 return $res;
1298}
1299
a6962d72
JP
1300sub get_quoted_string {
1301 my ($line, $rawline) = @_;
1302
478b1799 1303 return "" if (!defined($line) || !defined($rawline));
33acb54a 1304 return "" if ($line !~ m/($String)/g);
a6962d72
JP
1305 return substr($rawline, $-[0], $+[0] - $-[0]);
1306}
1307
8905a67c
AW
1308sub ctx_statement_block {
1309 my ($linenr, $remain, $off) = @_;
1310 my $line = $linenr - 1;
1311 my $blk = '';
1312 my $soff = $off;
1313 my $coff = $off - 1;
773647a0 1314 my $coff_set = 0;
8905a67c 1315
13214adf
AW
1316 my $loff = 0;
1317
8905a67c
AW
1318 my $type = '';
1319 my $level = 0;
a2750645 1320 my @stack = ();
cf655043 1321 my $p;
8905a67c
AW
1322 my $c;
1323 my $len = 0;
13214adf
AW
1324
1325 my $remainder;
8905a67c 1326 while (1) {
a2750645
AW
1327 @stack = (['', 0]) if ($#stack == -1);
1328
773647a0 1329 #warn "CSB: blk<$blk> remain<$remain>\n";
8905a67c
AW
1330 # If we are about to drop off the end, pull in more
1331 # context.
1332 if ($off >= $len) {
1333 for (; $remain > 0; $line++) {
dea33496 1334 last if (!defined $lines[$line]);
c2fdda0d 1335 next if ($lines[$line] =~ /^-/);
8905a67c 1336 $remain--;
13214adf 1337 $loff = $len;
c2fdda0d 1338 $blk .= $lines[$line] . "\n";
8905a67c
AW
1339 $len = length($blk);
1340 $line++;
1341 last;
1342 }
1343 # Bail if there is no further context.
1344 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
13214adf 1345 if ($off >= $len) {
8905a67c
AW
1346 last;
1347 }
f74bd194
AW
1348 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1349 $level++;
1350 $type = '#';
1351 }
8905a67c 1352 }
cf655043 1353 $p = $c;
8905a67c 1354 $c = substr($blk, $off, 1);
13214adf 1355 $remainder = substr($blk, $off);
8905a67c 1356
773647a0 1357 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
4635f4fb
AW
1358
1359 # Handle nested #if/#else.
1360 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1361 push(@stack, [ $type, $level ]);
1362 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1363 ($type, $level) = @{$stack[$#stack - 1]};
1364 } elsif ($remainder =~ /^#\s*endif\b/) {
1365 ($type, $level) = @{pop(@stack)};
1366 }
1367
8905a67c
AW
1368 # Statement ends at the ';' or a close '}' at the
1369 # outermost level.
1370 if ($level == 0 && $c eq ';') {
1371 last;
1372 }
1373
13214adf 1374 # An else is really a conditional as long as its not else if
773647a0
AW
1375 if ($level == 0 && $coff_set == 0 &&
1376 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1377 $remainder =~ /^(else)(?:\s|{)/ &&
1378 $remainder !~ /^else\s+if\b/) {
1379 $coff = $off + length($1) - 1;
1380 $coff_set = 1;
1381 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1382 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
13214adf
AW
1383 }
1384
8905a67c
AW
1385 if (($type eq '' || $type eq '(') && $c eq '(') {
1386 $level++;
1387 $type = '(';
1388 }
1389 if ($type eq '(' && $c eq ')') {
1390 $level--;
1391 $type = ($level != 0)? '(' : '';
1392
1393 if ($level == 0 && $coff < $soff) {
1394 $coff = $off;
773647a0
AW
1395 $coff_set = 1;
1396 #warn "CSB: mark coff<$coff>\n";
8905a67c
AW
1397 }
1398 }
1399 if (($type eq '' || $type eq '{') && $c eq '{') {
1400 $level++;
1401 $type = '{';
1402 }
1403 if ($type eq '{' && $c eq '}') {
1404 $level--;
1405 $type = ($level != 0)? '{' : '';
1406
1407 if ($level == 0) {
b998e001
PP
1408 if (substr($blk, $off + 1, 1) eq ';') {
1409 $off++;
1410 }
8905a67c
AW
1411 last;
1412 }
1413 }
f74bd194
AW
1414 # Preprocessor commands end at the newline unless escaped.
1415 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1416 $level--;
1417 $type = '';
1418 $off++;
1419 last;
1420 }
8905a67c
AW
1421 $off++;
1422 }
a3bb97a7 1423 # We are truly at the end, so shuffle to the next line.
13214adf 1424 if ($off == $len) {
a3bb97a7 1425 $loff = $len + 1;
13214adf
AW
1426 $line++;
1427 $remain--;
1428 }
8905a67c
AW
1429
1430 my $statement = substr($blk, $soff, $off - $soff + 1);
1431 my $condition = substr($blk, $soff, $coff - $soff + 1);
1432
1433 #warn "STATEMENT<$statement>\n";
1434 #warn "CONDITION<$condition>\n";
1435
773647a0 1436 #print "coff<$coff> soff<$off> loff<$loff>\n";
13214adf
AW
1437
1438 return ($statement, $condition,
1439 $line, $remain + 1, $off - $loff + 1, $level);
1440}
1441
cf655043
AW
1442sub statement_lines {
1443 my ($stmt) = @_;
1444
1445 # Strip the diff line prefixes and rip blank lines at start and end.
1446 $stmt =~ s/(^|\n)./$1/g;
1447 $stmt =~ s/^\s*//;
1448 $stmt =~ s/\s*$//;
1449
1450 my @stmt_lines = ($stmt =~ /\n/g);
1451
1452 return $#stmt_lines + 2;
1453}
1454
1455sub statement_rawlines {
1456 my ($stmt) = @_;
1457
1458 my @stmt_lines = ($stmt =~ /\n/g);
1459
1460 return $#stmt_lines + 2;
1461}
1462
1463sub statement_block_size {
1464 my ($stmt) = @_;
1465
1466 $stmt =~ s/(^|\n)./$1/g;
1467 $stmt =~ s/^\s*{//;
1468 $stmt =~ s/}\s*$//;
1469 $stmt =~ s/^\s*//;
1470 $stmt =~ s/\s*$//;
1471
1472 my @stmt_lines = ($stmt =~ /\n/g);
1473 my @stmt_statements = ($stmt =~ /;/g);
1474
1475 my $stmt_lines = $#stmt_lines + 2;
1476 my $stmt_statements = $#stmt_statements + 1;
1477
1478 if ($stmt_lines > $stmt_statements) {
1479 return $stmt_lines;
1480 } else {
1481 return $stmt_statements;
1482 }
1483}
1484
13214adf
AW
1485sub ctx_statement_full {
1486 my ($linenr, $remain, $off) = @_;
1487 my ($statement, $condition, $level);
1488
1489 my (@chunks);
1490
cf655043 1491 # Grab the first conditional/block pair.
13214adf
AW
1492 ($statement, $condition, $linenr, $remain, $off, $level) =
1493 ctx_statement_block($linenr, $remain, $off);
773647a0 1494 #print "F: c<$condition> s<$statement> remain<$remain>\n";
cf655043
AW
1495 push(@chunks, [ $condition, $statement ]);
1496 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1497 return ($level, $linenr, @chunks);
1498 }
1499
1500 # Pull in the following conditional/block pairs and see if they
1501 # could continue the statement.
13214adf 1502 for (;;) {
13214adf
AW
1503 ($statement, $condition, $linenr, $remain, $off, $level) =
1504 ctx_statement_block($linenr, $remain, $off);
cf655043 1505 #print "C: c<$condition> s<$statement> remain<$remain>\n";
773647a0 1506 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
cf655043
AW
1507 #print "C: push\n";
1508 push(@chunks, [ $condition, $statement ]);
13214adf
AW
1509 }
1510
1511 return ($level, $linenr, @chunks);
8905a67c
AW
1512}
1513
4a0df2ef 1514sub ctx_block_get {
f0a594c1 1515 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
4a0df2ef
AW
1516 my $line;
1517 my $start = $linenr - 1;
4a0df2ef
AW
1518 my $blk = '';
1519 my @o;
1520 my @c;
1521 my @res = ();
1522
f0a594c1 1523 my $level = 0;
4635f4fb 1524 my @stack = ($level);
00df344f
AW
1525 for ($line = $start; $remain > 0; $line++) {
1526 next if ($rawlines[$line] =~ /^-/);
1527 $remain--;
1528
1529 $blk .= $rawlines[$line];
4635f4fb
AW
1530
1531 # Handle nested #if/#else.
01464f30 1532 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
4635f4fb 1533 push(@stack, $level);
01464f30 1534 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
4635f4fb 1535 $level = $stack[$#stack - 1];
01464f30 1536 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
4635f4fb
AW
1537 $level = pop(@stack);
1538 }
1539
01464f30 1540 foreach my $c (split(//, $lines[$line])) {
f0a594c1
AW
1541 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1542 if ($off > 0) {
1543 $off--;
1544 next;
1545 }
4a0df2ef 1546
f0a594c1
AW
1547 if ($c eq $close && $level > 0) {
1548 $level--;
1549 last if ($level == 0);
1550 } elsif ($c eq $open) {
1551 $level++;
1552 }
1553 }
4a0df2ef 1554
f0a594c1 1555 if (!$outer || $level <= 1) {
00df344f 1556 push(@res, $rawlines[$line]);
4a0df2ef
AW
1557 }
1558
f0a594c1 1559 last if ($level == 0);
4a0df2ef
AW
1560 }
1561
f0a594c1 1562 return ($level, @res);
4a0df2ef
AW
1563}
1564sub ctx_block_outer {
1565 my ($linenr, $remain) = @_;
1566
f0a594c1
AW
1567 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1568 return @r;
4a0df2ef
AW
1569}
1570sub ctx_block {
1571 my ($linenr, $remain) = @_;
1572
f0a594c1
AW
1573 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1574 return @r;
653d4876
AW
1575}
1576sub ctx_statement {
f0a594c1
AW
1577 my ($linenr, $remain, $off) = @_;
1578
1579 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1580 return @r;
1581}
1582sub ctx_block_level {
653d4876
AW
1583 my ($linenr, $remain) = @_;
1584
f0a594c1 1585 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
4a0df2ef 1586}
9c0ca6f9
AW
1587sub ctx_statement_level {
1588 my ($linenr, $remain, $off) = @_;
1589
1590 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1591}
4a0df2ef
AW
1592
1593sub ctx_locate_comment {
1594 my ($first_line, $end_line) = @_;
1595
1596 # Catch a comment on the end of the line itself.
beae6332 1597 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
4a0df2ef
AW
1598 return $current_comment if (defined $current_comment);
1599
1600 # Look through the context and try and figure out if there is a
1601 # comment.
1602 my $in_comment = 0;
1603 $current_comment = '';
1604 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
00df344f
AW
1605 my $line = $rawlines[$linenr - 1];
1606 #warn " $line\n";
4a0df2ef
AW
1607 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1608 $in_comment = 1;
1609 }
1610 if ($line =~ m@/\*@) {
1611 $in_comment = 1;
1612 }
1613 if (!$in_comment && $current_comment ne '') {
1614 $current_comment = '';
1615 }
1616 $current_comment .= $line . "\n" if ($in_comment);
1617 if ($line =~ m@\*/@) {
1618 $in_comment = 0;
1619 }
1620 }
1621
1622 chomp($current_comment);
1623 return($current_comment);
1624}
1625sub ctx_has_comment {
1626 my ($first_line, $end_line) = @_;
1627 my $cmt = ctx_locate_comment($first_line, $end_line);
1628
00df344f 1629 ##print "LINE: $rawlines[$end_line - 1 ]\n";
4a0df2ef
AW
1630 ##print "CMMT: $cmt\n";
1631
1632 return ($cmt ne '');
1633}
1634
4d001e4d
AW
1635sub raw_line {
1636 my ($linenr, $cnt) = @_;
1637
1638 my $offset = $linenr - 1;
1639 $cnt++;
1640
1641 my $line;
1642 while ($cnt) {
1643 $line = $rawlines[$offset++];
1644 next if (defined($line) && $line =~ /^-/);
1645 $cnt--;
1646 }
1647
1648 return $line;
1649}
1650
2a9f9d85
TH
1651sub get_stat_real {
1652 my ($linenr, $lc) = @_;
1653
1654 my $stat_real = raw_line($linenr, 0);
1655 for (my $count = $linenr + 1; $count <= $lc; $count++) {
1656 $stat_real = $stat_real . "\n" . raw_line($count, 0);
1657 }
1658
1659 return $stat_real;
1660}
1661
e3d95a2a
TH
1662sub get_stat_here {
1663 my ($linenr, $cnt, $here) = @_;
1664
1665 my $herectx = $here . "\n";
1666 for (my $n = 0; $n < $cnt; $n++) {
1667 $herectx .= raw_line($linenr, $n) . "\n";
1668 }
1669
1670 return $herectx;
1671}
1672
6c72ffaa
AW
1673sub cat_vet {
1674 my ($vet) = @_;
1675 my ($res, $coded);
9c0ca6f9 1676
6c72ffaa
AW
1677 $res = '';
1678 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1679 $res .= $1;
1680 if ($2 ne '') {
1681 $coded = sprintf("^%c", unpack('C', $2) + 64);
1682 $res .= $coded;
9c0ca6f9
AW
1683 }
1684 }
6c72ffaa 1685 $res =~ s/$/\$/;
9c0ca6f9 1686
6c72ffaa 1687 return $res;
9c0ca6f9
AW
1688}
1689
c2fdda0d 1690my $av_preprocessor = 0;
cf655043 1691my $av_pending;
c2fdda0d 1692my @av_paren_type;
1f65f947 1693my $av_pend_colon;
c2fdda0d
AW
1694
1695sub annotate_reset {
1696 $av_preprocessor = 0;
cf655043
AW
1697 $av_pending = '_';
1698 @av_paren_type = ('E');
1f65f947 1699 $av_pend_colon = 'O';
c2fdda0d
AW
1700}
1701
6c72ffaa
AW
1702sub annotate_values {
1703 my ($stream, $type) = @_;
0a920b5b 1704
6c72ffaa 1705 my $res;
1f65f947 1706 my $var = '_' x length($stream);
6c72ffaa
AW
1707 my $cur = $stream;
1708
c2fdda0d 1709 print "$stream\n" if ($dbg_values > 1);
6c72ffaa 1710
6c72ffaa 1711 while (length($cur)) {
773647a0 1712 @av_paren_type = ('E') if ($#av_paren_type < 0);
cf655043 1713 print " <" . join('', @av_paren_type) .
171ae1a4 1714 "> <$type> <$av_pending>" if ($dbg_values > 1);
6c72ffaa 1715 if ($cur =~ /^(\s+)/o) {
c2fdda0d
AW
1716 print "WS($1)\n" if ($dbg_values > 1);
1717 if ($1 =~ /\n/ && $av_preprocessor) {
cf655043 1718 $type = pop(@av_paren_type);
c2fdda0d 1719 $av_preprocessor = 0;
6c72ffaa
AW
1720 }
1721
c023e473 1722 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
9446ef56
AW
1723 print "CAST($1)\n" if ($dbg_values > 1);
1724 push(@av_paren_type, $type);
addcdcea 1725 $type = 'c';
9446ef56 1726
e91b6e26 1727 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
c2fdda0d 1728 print "DECLARE($1)\n" if ($dbg_values > 1);
6c72ffaa
AW
1729 $type = 'T';
1730
389a2fe5
AW
1731 } elsif ($cur =~ /^($Modifier)\s*/) {
1732 print "MODIFIER($1)\n" if ($dbg_values > 1);
1733 $type = 'T';
1734
c45dcabd 1735 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
171ae1a4 1736 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
c2fdda0d 1737 $av_preprocessor = 1;
171ae1a4
AW
1738 push(@av_paren_type, $type);
1739 if ($2 ne '') {
1740 $av_pending = 'N';
1741 }
1742 $type = 'E';
1743
c45dcabd 1744 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
171ae1a4
AW
1745 print "UNDEF($1)\n" if ($dbg_values > 1);
1746 $av_preprocessor = 1;
1747 push(@av_paren_type, $type);
6c72ffaa 1748
c45dcabd 1749 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
cf655043 1750 print "PRE_START($1)\n" if ($dbg_values > 1);
c2fdda0d 1751 $av_preprocessor = 1;
cf655043
AW
1752
1753 push(@av_paren_type, $type);
1754 push(@av_paren_type, $type);
171ae1a4 1755 $type = 'E';
cf655043 1756
c45dcabd 1757 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
cf655043
AW
1758 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1759 $av_preprocessor = 1;
1760
1761 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1762
171ae1a4 1763 $type = 'E';
cf655043 1764
c45dcabd 1765 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
cf655043
AW
1766 print "PRE_END($1)\n" if ($dbg_values > 1);
1767
1768 $av_preprocessor = 1;
1769
1770 # Assume all arms of the conditional end as this
1771 # one does, and continue as if the #endif was not here.
1772 pop(@av_paren_type);
1773 push(@av_paren_type, $type);
171ae1a4 1774 $type = 'E';
6c72ffaa
AW
1775
1776 } elsif ($cur =~ /^(\\\n)/o) {
c2fdda0d 1777 print "PRECONT($1)\n" if ($dbg_values > 1);
6c72ffaa 1778
171ae1a4
AW
1779 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1780 print "ATTR($1)\n" if ($dbg_values > 1);
1781 $av_pending = $type;
1782 $type = 'N';
1783
6c72ffaa 1784 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
c2fdda0d 1785 print "SIZEOF($1)\n" if ($dbg_values > 1);
6c72ffaa 1786 if (defined $2) {
cf655043 1787 $av_pending = 'V';
6c72ffaa
AW
1788 }
1789 $type = 'N';
1790
14b111c1 1791 } elsif ($cur =~ /^(if|while|for)\b/o) {
c2fdda0d 1792 print "COND($1)\n" if ($dbg_values > 1);
14b111c1 1793 $av_pending = 'E';
6c72ffaa
AW
1794 $type = 'N';
1795
1f65f947
AW
1796 } elsif ($cur =~/^(case)/o) {
1797 print "CASE($1)\n" if ($dbg_values > 1);
1798 $av_pend_colon = 'C';
1799 $type = 'N';
1800
14b111c1 1801 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
c2fdda0d 1802 print "KEYWORD($1)\n" if ($dbg_values > 1);
6c72ffaa
AW
1803 $type = 'N';
1804
1805 } elsif ($cur =~ /^(\()/o) {
c2fdda0d 1806 print "PAREN('$1')\n" if ($dbg_values > 1);
cf655043
AW
1807 push(@av_paren_type, $av_pending);
1808 $av_pending = '_';
6c72ffaa
AW
1809 $type = 'N';
1810
1811 } elsif ($cur =~ /^(\))/o) {
cf655043
AW
1812 my $new_type = pop(@av_paren_type);
1813 if ($new_type ne '_') {
1814 $type = $new_type;
c2fdda0d
AW
1815 print "PAREN('$1') -> $type\n"
1816 if ($dbg_values > 1);
6c72ffaa 1817 } else {
c2fdda0d 1818 print "PAREN('$1')\n" if ($dbg_values > 1);
6c72ffaa
AW
1819 }
1820
c8cb2ca3 1821 } elsif ($cur =~ /^($Ident)\s*\(/o) {
c2fdda0d 1822 print "FUNC($1)\n" if ($dbg_values > 1);
c8cb2ca3 1823 $type = 'V';
cf655043 1824 $av_pending = 'V';
6c72ffaa 1825
8e761b04
AW
1826 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1827 if (defined $2 && $type eq 'C' || $type eq 'T') {
1f65f947 1828 $av_pend_colon = 'B';
8e761b04
AW
1829 } elsif ($type eq 'E') {
1830 $av_pend_colon = 'L';
1f65f947
AW
1831 }
1832 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1833 $type = 'V';
1834
6c72ffaa 1835 } elsif ($cur =~ /^($Ident|$Constant)/o) {
c2fdda0d 1836 print "IDENT($1)\n" if ($dbg_values > 1);
6c72ffaa
AW
1837 $type = 'V';
1838
1839 } elsif ($cur =~ /^($Assignment)/o) {
c2fdda0d 1840 print "ASSIGN($1)\n" if ($dbg_values > 1);
6c72ffaa
AW
1841 $type = 'N';
1842
cf655043 1843 } elsif ($cur =~/^(;|{|})/) {
c2fdda0d 1844 print "END($1)\n" if ($dbg_values > 1);
13214adf 1845 $type = 'E';
1f65f947
AW
1846 $av_pend_colon = 'O';
1847
8e761b04
AW
1848 } elsif ($cur =~/^(,)/) {
1849 print "COMMA($1)\n" if ($dbg_values > 1);
1850 $type = 'C';
1851
1f65f947
AW
1852 } elsif ($cur =~ /^(\?)/o) {
1853 print "QUESTION($1)\n" if ($dbg_values > 1);
1854 $type = 'N';
1855
1856 } elsif ($cur =~ /^(:)/o) {
1857 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1858
1859 substr($var, length($res), 1, $av_pend_colon);
1860 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1861 $type = 'E';
1862 } else {
1863 $type = 'N';
1864 }
1865 $av_pend_colon = 'O';
13214adf 1866
8e761b04 1867 } elsif ($cur =~ /^(\[)/o) {
13214adf 1868 print "CLOSE($1)\n" if ($dbg_values > 1);
6c72ffaa
AW
1869 $type = 'N';
1870
0d413866 1871 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
74048ed8
AW
1872 my $variant;
1873
1874 print "OPV($1)\n" if ($dbg_values > 1);
1875 if ($type eq 'V') {
1876 $variant = 'B';
1877 } else {
1878 $variant = 'U';
1879 }
1880
1881 substr($var, length($res), 1, $variant);
1882 $type = 'N';
1883
6c72ffaa 1884 } elsif ($cur =~ /^($Operators)/o) {
c2fdda0d 1885 print "OP($1)\n" if ($dbg_values > 1);
6c72ffaa
AW
1886 if ($1 ne '++' && $1 ne '--') {
1887 $type = 'N';
1888 }
1889
1890 } elsif ($cur =~ /(^.)/o) {
c2fdda0d 1891 print "C($1)\n" if ($dbg_values > 1);
6c72ffaa
AW
1892 }
1893 if (defined $1) {
1894 $cur = substr($cur, length($1));
1895 $res .= $type x length($1);
1896 }
9c0ca6f9 1897 }
0a920b5b 1898
1f65f947 1899 return ($res, $var);
0a920b5b
AW
1900}
1901
8905a67c 1902sub possible {
13214adf 1903 my ($possible, $line) = @_;
9a974fdb 1904 my $notPermitted = qr{(?:
0776e594
AW
1905 ^(?:
1906 $Modifier|
1907 $Storage|
1908 $Type|
9a974fdb
AW
1909 DEFINE_\S+
1910 )$|
1911 ^(?:
0776e594
AW
1912 goto|
1913 return|
1914 case|
1915 else|
1916 asm|__asm__|
89a88353
AW
1917 do|
1918 \#|
1919 \#\#|
9a974fdb 1920 )(?:\s|$)|
0776e594 1921 ^(?:typedef|struct|enum)\b
9a974fdb
AW
1922 )}x;
1923 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1924 if ($possible !~ $notPermitted) {
c45dcabd
AW
1925 # Check for modifiers.
1926 $possible =~ s/\s*$Storage\s*//g;
1927 $possible =~ s/\s*$Sparse\s*//g;
1928 if ($possible =~ /^\s*$/) {
1929
1930 } elsif ($possible =~ /\s/) {
1931 $possible =~ s/\s*$Type\s*//g;
d2506586 1932 for my $modifier (split(' ', $possible)) {
9a974fdb
AW
1933 if ($modifier !~ $notPermitted) {
1934 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
485ff23e 1935 push(@modifierListFile, $modifier);
9a974fdb 1936 }
d2506586 1937 }
c45dcabd
AW
1938
1939 } else {
1940 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
485ff23e 1941 push(@typeListFile, $possible);
c45dcabd 1942 }
8905a67c 1943 build_types();
0776e594
AW
1944 } else {
1945 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
8905a67c
AW
1946 }
1947}
1948
6c72ffaa
AW
1949my $prefix = '';
1950
000d1cc1 1951sub show_type {
cbec18af 1952 my ($type) = @_;
91bfe484 1953
522b837c
AD
1954 $type =~ tr/[a-z]/[A-Z]/;
1955
cbec18af
JP
1956 return defined $use_type{$type} if (scalar keys %use_type > 0);
1957
1958 return !defined $ignore_type{$type};
000d1cc1
JP
1959}
1960
f0a594c1 1961sub report {
cbec18af
JP
1962 my ($level, $type, $msg) = @_;
1963
1964 if (!show_type($type) ||
1965 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
773647a0
AW
1966 return 0;
1967 }
57230297 1968 my $output = '';
737c0767 1969 if ($color) {
57230297
JP
1970 if ($level eq 'ERROR') {
1971 $output .= RED;
1972 } elsif ($level eq 'WARNING') {
1973 $output .= YELLOW;
1974 } else {
1975 $output .= GREEN;
1976 }
1977 }
1978 $output .= $prefix . $level . ':';
000d1cc1 1979 if ($show_types) {
737c0767 1980 $output .= BLUE if ($color);
57230297 1981 $output .= "$type:";
000d1cc1 1982 }
737c0767 1983 $output .= RESET if ($color);
57230297 1984 $output .= ' ' . $msg . "\n";
34d8815f
JP
1985
1986 if ($showfile) {
1987 my @lines = split("\n", $output, -1);
1988 splice(@lines, 1, 1);
1989 $output = join("\n", @lines);
1990 }
57230297 1991 $output = (split('\n', $output))[0] . "\n" if ($terse);
8905a67c 1992
57230297 1993 push(our @report, $output);
773647a0
AW
1994
1995 return 1;
f0a594c1 1996}
cbec18af 1997
f0a594c1 1998sub report_dump {
13214adf 1999 our @report;
f0a594c1 2000}
000d1cc1 2001
d752fcc8
JP
2002sub fixup_current_range {
2003 my ($lineRef, $offset, $length) = @_;
2004
2005 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
2006 my $o = $1;
2007 my $l = $2;
2008 my $no = $o + $offset;
2009 my $nl = $l + $length;
2010 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
2011 }
2012}
2013
2014sub fix_inserted_deleted_lines {
2015 my ($linesRef, $insertedRef, $deletedRef) = @_;
2016
2017 my $range_last_linenr = 0;
2018 my $delta_offset = 0;
2019
2020 my $old_linenr = 0;
2021 my $new_linenr = 0;
2022
2023 my $next_insert = 0;
2024 my $next_delete = 0;
2025
2026 my @lines = ();
2027
2028 my $inserted = @{$insertedRef}[$next_insert++];
2029 my $deleted = @{$deletedRef}[$next_delete++];
2030
2031 foreach my $old_line (@{$linesRef}) {
2032 my $save_line = 1;
2033 my $line = $old_line; #don't modify the array
323b267f 2034 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
d752fcc8
JP
2035 $delta_offset = 0;
2036 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
2037 $range_last_linenr = $new_linenr;
2038 fixup_current_range(\$line, $delta_offset, 0);
2039 }
2040
2041 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2042 $deleted = @{$deletedRef}[$next_delete++];
2043 $save_line = 0;
2044 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2045 }
2046
2047 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2048 push(@lines, ${$inserted}{'LINE'});
2049 $inserted = @{$insertedRef}[$next_insert++];
2050 $new_linenr++;
2051 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2052 }
2053
2054 if ($save_line) {
2055 push(@lines, $line);
2056 $new_linenr++;
2057 }
2058
2059 $old_linenr++;
2060 }
2061
2062 return @lines;
2063}
2064
f2d7e4d4
JP
2065sub fix_insert_line {
2066 my ($linenr, $line) = @_;
2067
2068 my $inserted = {
2069 LINENR => $linenr,
2070 LINE => $line,
2071 };
2072 push(@fixed_inserted, $inserted);
2073}
2074
2075sub fix_delete_line {
2076 my ($linenr, $line) = @_;
2077
2078 my $deleted = {
2079 LINENR => $linenr,
2080 LINE => $line,
2081 };
2082
2083 push(@fixed_deleted, $deleted);
2084}
2085
de7d4f0e 2086sub ERROR {
cbec18af
JP
2087 my ($type, $msg) = @_;
2088
2089 if (report("ERROR", $type, $msg)) {
773647a0
AW
2090 our $clean = 0;
2091 our $cnt_error++;
3705ce5b 2092 return 1;
773647a0 2093 }
3705ce5b 2094 return 0;
de7d4f0e
AW
2095}
2096sub WARN {
cbec18af
JP
2097 my ($type, $msg) = @_;
2098
2099 if (report("WARNING", $type, $msg)) {
773647a0
AW
2100 our $clean = 0;
2101 our $cnt_warn++;
3705ce5b 2102 return 1;
773647a0 2103 }
3705ce5b 2104 return 0;
de7d4f0e
AW
2105}
2106sub CHK {
cbec18af
JP
2107 my ($type, $msg) = @_;
2108
2109 if ($check && report("CHECK", $type, $msg)) {
6c72ffaa
AW
2110 our $clean = 0;
2111 our $cnt_chk++;
3705ce5b 2112 return 1;
6c72ffaa 2113 }
3705ce5b 2114 return 0;
de7d4f0e
AW
2115}
2116
6ecd9674
AW
2117sub check_absolute_file {
2118 my ($absolute, $herecurr) = @_;
2119 my $file = $absolute;
2120
2121 ##print "absolute<$absolute>\n";
2122
2123 # See if any suffix of this path is a path within the tree.
2124 while ($file =~ s@^[^/]*/@@) {
2125 if (-f "$root/$file") {
2126 ##print "file<$file>\n";
2127 last;
2128 }
2129 }
2130 if (! -f _) {
2131 return 0;
2132 }
2133
2134 # It is, so see if the prefix is acceptable.
2135 my $prefix = $absolute;
2136 substr($prefix, -length($file)) = '';
2137
2138 ##print "prefix<$prefix>\n";
2139 if ($prefix ne ".../") {
000d1cc1
JP
2140 WARN("USE_RELATIVE_PATH",
2141 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
6ecd9674
AW
2142 }
2143}
2144
3705ce5b
JP
2145sub trim {
2146 my ($string) = @_;
2147
b34c648b
JP
2148 $string =~ s/^\s+|\s+$//g;
2149
2150 return $string;
2151}
2152
2153sub ltrim {
2154 my ($string) = @_;
2155
2156 $string =~ s/^\s+//;
2157
2158 return $string;
2159}
2160
2161sub rtrim {
2162 my ($string) = @_;
2163
2164 $string =~ s/\s+$//;
3705ce5b
JP
2165
2166 return $string;
2167}
2168
52ea8506
JP
2169sub string_find_replace {
2170 my ($string, $find, $replace) = @_;
2171
2172 $string =~ s/$find/$replace/g;
2173
2174 return $string;
2175}
2176
3705ce5b
JP
2177sub tabify {
2178 my ($leading) = @_;
2179
2180 my $source_indent = 8;
2181 my $max_spaces_before_tab = $source_indent - 1;
2182 my $spaces_to_tab = " " x $source_indent;
2183
2184 #convert leading spaces to tabs
2185 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2186 #Remove spaces before a tab
2187 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2188
2189 return "$leading";
2190}
2191
d1fe9c09
JP
2192sub pos_last_openparen {
2193 my ($line) = @_;
2194
2195 my $pos = 0;
2196
2197 my $opens = $line =~ tr/\(/\(/;
2198 my $closes = $line =~ tr/\)/\)/;
2199
2200 my $last_openparen = 0;
2201
2202 if (($opens == 0) || ($closes >= $opens)) {
2203 return -1;
2204 }
2205
2206 my $len = length($line);
2207
2208 for ($pos = 0; $pos < $len; $pos++) {
2209 my $string = substr($line, $pos);
2210 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2211 $pos += length($1) - 1;
2212 } elsif (substr($line, $pos, 1) eq '(') {
2213 $last_openparen = $pos;
2214 } elsif (index($string, '(') == -1) {
2215 last;
2216 }
2217 }
2218
91cb5195 2219 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
d1fe9c09
JP
2220}
2221
0a920b5b
AW
2222sub process {
2223 my $filename = shift;
0a920b5b
AW
2224
2225 my $linenr=0;
2226 my $prevline="";
c2fdda0d 2227 my $prevrawline="";
0a920b5b 2228 my $stashline="";
c2fdda0d 2229 my $stashrawline="";
0a920b5b 2230
4a0df2ef 2231 my $length;
0a920b5b
AW
2232 my $indent;
2233 my $previndent=0;
2234 my $stashindent=0;
2235
de7d4f0e 2236 our $clean = 1;
0a920b5b
AW
2237 my $signoff = 0;
2238 my $is_patch = 0;
29ee1b0c 2239 my $in_header_lines = $file ? 0 : 1;
15662b3e 2240 my $in_commit_log = 0; #Scanning lines before patch
ed43c4e5 2241 my $has_commit_log = 0; #Encountered lines before patch
77cb8546 2242 my $commit_log_possible_stack_dump = 0;
2a076f40 2243 my $commit_log_long_line = 0;
e518e9a5 2244 my $commit_log_has_diff = 0;
13f1937e 2245 my $reported_maintainer_file = 0;
fa64205d
PS
2246 my $non_utf8_charset = 0;
2247
365dd4ea 2248 my $last_blank_line = 0;
5e4f6ba5 2249 my $last_coalesced_string_linenr = -1;
365dd4ea 2250
13214adf 2251 our @report = ();
6c72ffaa
AW
2252 our $cnt_lines = 0;
2253 our $cnt_error = 0;
2254 our $cnt_warn = 0;
2255 our $cnt_chk = 0;
2256
0a920b5b
AW
2257 # Trace the real file/line as we go.
2258 my $realfile = '';
2259 my $realline = 0;
2260 my $realcnt = 0;
2261 my $here = '';
77cb8546 2262 my $context_function; #undef'd unless there's a known function
0a920b5b 2263 my $in_comment = 0;
c2fdda0d 2264 my $comment_edge = 0;
0a920b5b 2265 my $first_line = 0;
1e855726 2266 my $p1_prefix = '';
0a920b5b 2267
13214adf
AW
2268 my $prev_values = 'E';
2269
2270 # suppression flags
773647a0 2271 my %suppress_ifbraces;
170d3a22 2272 my %suppress_whiletrailers;
2b474a1a 2273 my %suppress_export;
3e469cdc 2274 my $suppress_statement = 0;
653d4876 2275
7e51f197 2276 my %signatures = ();
323c1260 2277
c2fdda0d 2278 # Pre-scan the patch sanitizing the lines.
de7d4f0e 2279 # Pre-scan the patch looking for any __setup documentation.
c2fdda0d 2280 #
de7d4f0e
AW
2281 my @setup_docs = ();
2282 my $setup_docs = 0;
773647a0 2283
d8b07710
JP
2284 my $camelcase_file_seeded = 0;
2285
9f3a8992
RH
2286 my $checklicenseline = 1;
2287
773647a0 2288 sanitise_line_reset();
c2fdda0d
AW
2289 my $line;
2290 foreach my $rawline (@rawlines) {
773647a0
AW
2291 $linenr++;
2292 $line = $rawline;
c2fdda0d 2293
3705ce5b
JP
2294 push(@fixed, $rawline) if ($fix);
2295
773647a0 2296 if ($rawline=~/^\+\+\+\s+(\S+)/) {
de7d4f0e 2297 $setup_docs = 0;
8c27ceff 2298 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
de7d4f0e
AW
2299 $setup_docs = 1;
2300 }
773647a0
AW
2301 #next;
2302 }
74fd4f34 2303 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
773647a0
AW
2304 $realline=$1-1;
2305 if (defined $2) {
2306 $realcnt=$3+1;
2307 } else {
2308 $realcnt=1+1;
2309 }
c45dcabd 2310 $in_comment = 0;
773647a0
AW
2311
2312 # Guestimate if this is a continuing comment. Run
2313 # the context looking for a comment "edge". If this
2314 # edge is a close comment then we must be in a comment
2315 # at context start.
2316 my $edge;
01fa9147
AW
2317 my $cnt = $realcnt;
2318 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2319 next if (defined $rawlines[$ln - 1] &&
2320 $rawlines[$ln - 1] =~ /^-/);
2321 $cnt--;
2322 #print "RAW<$rawlines[$ln - 1]>\n";
721c1cb6 2323 last if (!defined $rawlines[$ln - 1]);
fae17dae
AW
2324 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2325 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2326 ($edge) = $1;
2327 last;
2328 }
773647a0
AW
2329 }
2330 if (defined $edge && $edge eq '*/') {
2331 $in_comment = 1;
2332 }
2333
2334 # Guestimate if this is a continuing comment. If this
2335 # is the start of a diff block and this line starts
2336 # ' *' then it is very likely a comment.
2337 if (!defined $edge &&
83242e0c 2338 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
773647a0
AW
2339 {
2340 $in_comment = 1;
2341 }
2342
2343 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2344 sanitise_line_reset($in_comment);
2345
171ae1a4 2346 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
773647a0 2347 # Standardise the strings and chars within the input to
171ae1a4 2348 # simplify matching -- only bother with positive lines.
773647a0 2349 $line = sanitise_line($rawline);
de7d4f0e 2350 }
773647a0
AW
2351 push(@lines, $line);
2352
2353 if ($realcnt > 1) {
2354 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2355 } else {
2356 $realcnt = 0;
2357 }
2358
2359 #print "==>$rawline\n";
2360 #print "-->$line\n";
de7d4f0e
AW
2361
2362 if ($setup_docs && $line =~ /^\+/) {
2363 push(@setup_docs, $line);
2364 }
2365 }
2366
6c72ffaa
AW
2367 $prefix = '';
2368
773647a0
AW
2369 $realcnt = 0;
2370 $linenr = 0;
194f66fc 2371 $fixlinenr = -1;
0a920b5b
AW
2372 foreach my $line (@lines) {
2373 $linenr++;
194f66fc 2374 $fixlinenr++;
1b5539b1
JP
2375 my $sline = $line; #copy of $line
2376 $sline =~ s/$;/ /g; #with comments as spaces
0a920b5b 2377
c2fdda0d 2378 my $rawline = $rawlines[$linenr - 1];
6c72ffaa 2379
12c253ab
JP
2380# check if it's a mode change, rename or start of a patch
2381 if (!$in_commit_log &&
2382 ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ ||
2383 ($line =~ /^rename (?:from|to) \S+\s*$/ ||
2384 $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) {
2385 $is_patch = 1;
2386 }
2387
0a920b5b 2388#extract the line range in the file after the patch is applied
e518e9a5 2389 if (!$in_commit_log &&
74fd4f34
JP
2390 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2391 my $context = $4;
0a920b5b 2392 $is_patch = 1;
4a0df2ef 2393 $first_line = $linenr + 1;
0a920b5b
AW
2394 $realline=$1-1;
2395 if (defined $2) {
2396 $realcnt=$3+1;
2397 } else {
2398 $realcnt=1+1;
2399 }
c2fdda0d 2400 annotate_reset();
13214adf
AW
2401 $prev_values = 'E';
2402
773647a0 2403 %suppress_ifbraces = ();
170d3a22 2404 %suppress_whiletrailers = ();
2b474a1a 2405 %suppress_export = ();
3e469cdc 2406 $suppress_statement = 0;
74fd4f34
JP
2407 if ($context =~ /\b(\w+)\s*\(/) {
2408 $context_function = $1;
2409 } else {
2410 undef $context_function;
2411 }
0a920b5b 2412 next;
0a920b5b 2413
4a0df2ef
AW
2414# track the line number as we move through the hunk, note that
2415# new versions of GNU diff omit the leading space on completely
2416# blank context lines so we need to count that too.
773647a0 2417 } elsif ($line =~ /^( |\+|$)/) {
0a920b5b 2418 $realline++;
d8aaf121 2419 $realcnt-- if ($realcnt != 0);
0a920b5b 2420
4a0df2ef 2421 # Measure the line length and indent.
c2fdda0d 2422 ($length, $indent) = line_stats($rawline);
0a920b5b
AW
2423
2424 # Track the previous line.
2425 ($prevline, $stashline) = ($stashline, $line);
2426 ($previndent, $stashindent) = ($stashindent, $indent);
c2fdda0d
AW
2427 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2428
773647a0 2429 #warn "line<$line>\n";
6c72ffaa 2430
d8aaf121
AW
2431 } elsif ($realcnt == 1) {
2432 $realcnt--;
0a920b5b
AW
2433 }
2434
cc77cdca
AW
2435 my $hunk_line = ($realcnt != 0);
2436
6c72ffaa
AW
2437 $here = "#$linenr: " if (!$file);
2438 $here = "#$realline: " if ($file);
773647a0 2439
2ac73b4f 2440 my $found_file = 0;
773647a0 2441 # extract the filename as it passes
3bf9a009
RV
2442 if ($line =~ /^diff --git.*?(\S+)$/) {
2443 $realfile = $1;
2b7ab453 2444 $realfile =~ s@^([^/]*)/@@ if (!$file);
270c49a0 2445 $in_commit_log = 0;
2ac73b4f 2446 $found_file = 1;
3bf9a009 2447 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
773647a0 2448 $realfile = $1;
2b7ab453 2449 $realfile =~ s@^([^/]*)/@@ if (!$file);
270c49a0 2450 $in_commit_log = 0;
1e855726
WS
2451
2452 $p1_prefix = $1;
e2f7aa4b
AW
2453 if (!$file && $tree && $p1_prefix ne '' &&
2454 -e "$root/$p1_prefix") {
000d1cc1
JP
2455 WARN("PATCH_PREFIX",
2456 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1e855726 2457 }
773647a0 2458
c1ab3326 2459 if ($realfile =~ m@^include/asm/@) {
000d1cc1
JP
2460 ERROR("MODIFIED_INCLUDE_ASM",
2461 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
773647a0 2462 }
2ac73b4f
JP
2463 $found_file = 1;
2464 }
2465
34d8815f
JP
2466#make up the handle for any error we report on this line
2467 if ($showfile) {
2468 $prefix = "$realfile:$realline: "
2469 } elsif ($emacs) {
7d3a9f67
JP
2470 if ($file) {
2471 $prefix = "$filename:$realline: ";
2472 } else {
2473 $prefix = "$filename:$linenr: ";
2474 }
34d8815f
JP
2475 }
2476
2ac73b4f 2477 if ($found_file) {
85b0ee18
JP
2478 if (is_maintained_obsolete($realfile)) {
2479 WARN("OBSOLETE",
2480 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2481 }
7bd7e483 2482 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
2ac73b4f
JP
2483 $check = 1;
2484 } else {
2485 $check = $check_orig;
2486 }
9f3a8992 2487 $checklicenseline = 1;
773647a0
AW
2488 next;
2489 }
2490
389834b6 2491 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
0a920b5b 2492
c2fdda0d
AW
2493 my $hereline = "$here\n$rawline\n";
2494 my $herecurr = "$here\n$rawline\n";
2495 my $hereprev = "$here\n$prevrawline\n$rawline\n";
0a920b5b 2496
6c72ffaa
AW
2497 $cnt_lines++ if ($realcnt != 0);
2498
e518e9a5
JP
2499# Check if the commit log has what seems like a diff which can confuse patch
2500 if ($in_commit_log && !$commit_log_has_diff &&
2501 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2502 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2503 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2504 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2505 ERROR("DIFF_IN_COMMIT_MSG",
2506 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2507 $commit_log_has_diff = 1;
2508 }
2509
3bf9a009
RV
2510# Check for incorrect file permissions
2511 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2512 my $permhere = $here . "FILE: $realfile\n";
04db4d25
JP
2513 if ($realfile !~ m@scripts/@ &&
2514 $realfile !~ /\.(py|pl|awk|sh)$/) {
000d1cc1
JP
2515 ERROR("EXECUTE_PERMISSIONS",
2516 "do not set execute permissions for source files\n" . $permhere);
3bf9a009
RV
2517 }
2518 }
2519
20112475 2520# Check the patch for a signoff:
d8aaf121 2521 if ($line =~ /^\s*signed-off-by:/i) {
4a0df2ef 2522 $signoff++;
15662b3e 2523 $in_commit_log = 0;
20112475
JP
2524 }
2525
e0d975b1
JP
2526# Check if MAINTAINERS is being updated. If so, there's probably no need to
2527# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2528 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2529 $reported_maintainer_file = 1;
2530 }
2531
20112475 2532# Check signature styles
270c49a0 2533 if (!$in_header_lines &&
ce0338df 2534 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
20112475
JP
2535 my $space_before = $1;
2536 my $sign_off = $2;
2537 my $space_after = $3;
2538 my $email = $4;
2539 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2540
ce0338df
JP
2541 if ($sign_off !~ /$signature_tags/) {
2542 WARN("BAD_SIGN_OFF",
2543 "Non-standard signature: $sign_off\n" . $herecurr);
2544 }
20112475 2545 if (defined $space_before && $space_before ne "") {
3705ce5b
JP
2546 if (WARN("BAD_SIGN_OFF",
2547 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2548 $fix) {
194f66fc 2549 $fixed[$fixlinenr] =
3705ce5b
JP
2550 "$ucfirst_sign_off $email";
2551 }
20112475
JP
2552 }
2553 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
3705ce5b
JP
2554 if (WARN("BAD_SIGN_OFF",
2555 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2556 $fix) {
194f66fc 2557 $fixed[$fixlinenr] =
3705ce5b
JP
2558 "$ucfirst_sign_off $email";
2559 }
2560
20112475
JP
2561 }
2562 if (!defined $space_after || $space_after ne " ") {
3705ce5b
JP
2563 if (WARN("BAD_SIGN_OFF",
2564 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2565 $fix) {
194f66fc 2566 $fixed[$fixlinenr] =
3705ce5b
JP
2567 "$ucfirst_sign_off $email";
2568 }
0a920b5b 2569 }
20112475
JP
2570
2571 my ($email_name, $email_address, $comment) = parse_email($email);
2572 my $suggested_email = format_email(($email_name, $email_address));
2573 if ($suggested_email eq "") {
000d1cc1
JP
2574 ERROR("BAD_SIGN_OFF",
2575 "Unrecognized email address: '$email'\n" . $herecurr);
20112475
JP
2576 } else {
2577 my $dequoted = $suggested_email;
2578 $dequoted =~ s/^"//;
2579 $dequoted =~ s/" </ </;
2580 # Don't force email to have quotes
2581 # Allow just an angle bracketed address
2582 if ("$dequoted$comment" ne $email &&
2583 "<$email_address>$comment" ne $email &&
2584 "$suggested_email$comment" ne $email) {
000d1cc1
JP
2585 WARN("BAD_SIGN_OFF",
2586 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
20112475 2587 }
0a920b5b 2588 }
7e51f197
JP
2589
2590# Check for duplicate signatures
2591 my $sig_nospace = $line;
2592 $sig_nospace =~ s/\s//g;
2593 $sig_nospace = lc($sig_nospace);
2594 if (defined $signatures{$sig_nospace}) {
2595 WARN("BAD_SIGN_OFF",
2596 "Duplicate signature\n" . $herecurr);
2597 } else {
2598 $signatures{$sig_nospace} = 1;
2599 }
0a920b5b
AW
2600 }
2601
a2fe16b9
JP
2602# Check email subject for common tools that don't need to be mentioned
2603 if ($in_header_lines &&
2604 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2605 WARN("EMAIL_SUBJECT",
2606 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2607 }
2608
9b3189eb
JP
2609# Check for old stable address
2610 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2611 ERROR("STABLE_ADDRESS",
2612 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2613 }
2614
7ebd05ef
CC
2615# Check for unwanted Gerrit info
2616 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2617 ERROR("GERRIT_CHANGE_ID",
2618 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2619 }
2620
369c8dd3
JP
2621# Check if the commit log is in a possible stack dump
2622 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2623 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2624 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2625 # timestamp
2626 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2627 # stack dump address
2628 $commit_log_possible_stack_dump = 1;
2629 }
2630
2a076f40
JP
2631# Check for line lengths > 75 in commit log, warn once
2632 if ($in_commit_log && !$commit_log_long_line &&
369c8dd3
JP
2633 length($line) > 75 &&
2634 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2635 # file delta changes
2636 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2637 # filename then :
2638 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2639 # A Fixes: or Link: line
2640 $commit_log_possible_stack_dump)) {
2a076f40
JP
2641 WARN("COMMIT_LOG_LONG_LINE",
2642 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2643 $commit_log_long_line = 1;
2644 }
2645
bf4daf12 2646# Reset possible stack dump if a blank line is found
369c8dd3
JP
2647 if ($in_commit_log && $commit_log_possible_stack_dump &&
2648 $line =~ /^\s*$/) {
2649 $commit_log_possible_stack_dump = 0;
2650 }
bf4daf12 2651
0d7835fc 2652# Check for git id commit length and improperly formed commit descriptions
369c8dd3 2653 if ($in_commit_log && !$commit_log_possible_stack_dump &&
aab38f51 2654 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
e882dbfc 2655 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
fe043ea1 2656 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
aab38f51 2657 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
369c8dd3
JP
2658 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2659 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
fe043ea1
JP
2660 my $init_char = "c";
2661 my $orig_commit = "";
0d7835fc
JP
2662 my $short = 1;
2663 my $long = 0;
2664 my $case = 1;
2665 my $space = 1;
2666 my $hasdesc = 0;
19c146a6 2667 my $hasparens = 0;
0d7835fc
JP
2668 my $id = '0123456789ab';
2669 my $orig_desc = "commit description";
2670 my $description = "";
2671
fe043ea1
JP
2672 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2673 $init_char = $1;
2674 $orig_commit = lc($2);
2675 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2676 $orig_commit = lc($1);
2677 }
2678
0d7835fc
JP
2679 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2680 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2681 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2682 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2683 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2684 $orig_desc = $1;
19c146a6 2685 $hasparens = 1;
0d7835fc
JP
2686 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2687 defined $rawlines[$linenr] &&
2688 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2689 $orig_desc = $1;
19c146a6 2690 $hasparens = 1;
b671fde0
JP
2691 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2692 defined $rawlines[$linenr] &&
2693 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2694 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2695 $orig_desc = $1;
2696 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2697 $orig_desc .= " " . $1;
19c146a6 2698 $hasparens = 1;
0d7835fc
JP
2699 }
2700
2701 ($id, $description) = git_commit_info($orig_commit,
2702 $id, $orig_desc);
2703
948b133a
HS
2704 if (defined($id) &&
2705 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
0d7835fc
JP
2706 ERROR("GIT_COMMIT_ID",
2707 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2708 }
d311cd44
JP
2709 }
2710
13f1937e
JP
2711# Check for added, moved or deleted files
2712 if (!$reported_maintainer_file && !$in_commit_log &&
2713 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2714 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2715 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2716 (defined($1) || defined($2))))) {
a82603a8 2717 $is_patch = 1;
13f1937e
JP
2718 $reported_maintainer_file = 1;
2719 WARN("FILE_PATH_CHANGES",
2720 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2721 }
2722
00df344f 2723# Check for wrappage within a valid hunk of the file
8905a67c 2724 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
000d1cc1
JP
2725 ERROR("CORRUPTED_PATCH",
2726 "patch seems to be corrupt (line wrapped?)\n" .
6c72ffaa 2727 $herecurr) if (!$emitted_corrupt++);
de7d4f0e
AW
2728 }
2729
2730# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2731 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
171ae1a4
AW
2732 $rawline !~ m/^$UTF8*$/) {
2733 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2734
2735 my $blank = copy_spacing($rawline);
2736 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2737 my $hereptr = "$hereline$ptr\n";
2738
34d99219
JP
2739 CHK("INVALID_UTF8",
2740 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
00df344f
AW
2741 }
2742
15662b3e
JP
2743# Check if it's the start of a commit log
2744# (not a header line and we haven't seen the patch filename)
2745 if ($in_header_lines && $realfile =~ /^$/ &&
eb3a58de
JP
2746 !($rawline =~ /^\s+(?:\S|$)/ ||
2747 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
15662b3e
JP
2748 $in_header_lines = 0;
2749 $in_commit_log = 1;
ed43c4e5 2750 $has_commit_log = 1;
15662b3e
JP
2751 }
2752
fa64205d
PS
2753# Check if there is UTF-8 in a commit log when a mail header has explicitly
2754# declined it, i.e defined some charset where it is missing.
2755 if ($in_header_lines &&
2756 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2757 $1 !~ /utf-8/i) {
2758 $non_utf8_charset = 1;
2759 }
2760
2761 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
15662b3e 2762 $rawline =~ /$NON_ASCII_UTF8/) {
fa64205d 2763 WARN("UTF8_BEFORE_PATCH",
15662b3e
JP
2764 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2765 }
2766
d6430f71
JP
2767# Check for absolute kernel paths in commit message
2768 if ($tree && $in_commit_log) {
2769 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2770 my $file = $1;
2771
2772 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2773 check_absolute_file($1, $herecurr)) {
2774 #
2775 } else {
2776 check_absolute_file($file, $herecurr);
2777 }
2778 }
2779 }
2780
66b47b4a 2781# Check for various typo / spelling mistakes
66d7a382
JP
2782 if (defined($misspellings) &&
2783 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
ebfd7d62 2784 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
66b47b4a
KC
2785 my $typo = $1;
2786 my $typo_fix = $spelling_fix{lc($typo)};
2787 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2788 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
0675a8fb
JD
2789 my $msg_level = \&WARN;
2790 $msg_level = \&CHK if ($file);
2791 if (&{$msg_level}("TYPO_SPELLING",
2792 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
66b47b4a
KC
2793 $fix) {
2794 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2795 }
2796 }
2797 }
2798
30670854
AW
2799# ignore non-hunk lines and lines being removed
2800 next if (!$hunk_line || $line =~ /^-/);
0a920b5b 2801
0a920b5b 2802#trailing whitespace
9c0ca6f9 2803 if ($line =~ /^\+.*\015/) {
c2fdda0d 2804 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
d5e616fc
JP
2805 if (ERROR("DOS_LINE_ENDINGS",
2806 "DOS line endings\n" . $herevet) &&
2807 $fix) {
194f66fc 2808 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
d5e616fc 2809 }
c2fdda0d
AW
2810 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2811 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3705ce5b
JP
2812 if (ERROR("TRAILING_WHITESPACE",
2813 "trailing whitespace\n" . $herevet) &&
2814 $fix) {
194f66fc 2815 $fixed[$fixlinenr] =~ s/\s+$//;
3705ce5b
JP
2816 }
2817
d2c0a235 2818 $rpt_cleaners = 1;
0a920b5b 2819 }
5368df20 2820
4783f894 2821# Check for FSF mailing addresses.
109d8cb2 2822 if ($rawline =~ /\bwrite to the Free/i ||
1bde561e 2823 $rawline =~ /\b675\s+Mass\s+Ave/i ||
3e2232f2
JP
2824 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2825 $rawline =~ /\b51\s+Franklin\s+St/i) {
4783f894 2826 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
0675a8fb
JD
2827 my $msg_level = \&ERROR;
2828 $msg_level = \&CHK if ($file);
2829 &{$msg_level}("FSF_MAILING_ADDRESS",
2830 "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
2831 }
2832
3354957a 2833# check for Kconfig help text having a real description
9fe287d7
AW
2834# Only applies when adding the entry originally, after that we do not have
2835# sufficient context to determine whether it is indeed long enough.
3354957a 2836 if ($realfile =~ /Kconfig/ &&
678ae162
UM
2837 # 'choice' is usually the last thing on the line (though
2838 # Kconfig supports named choices), so use a word boundary
2839 # (\b) rather than a whitespace character (\s)
2840 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
3354957a 2841 my $length = 0;
9fe287d7
AW
2842 my $cnt = $realcnt;
2843 my $ln = $linenr + 1;
2844 my $f;
a1385803 2845 my $is_start = 0;
9fe287d7 2846 my $is_end = 0;
a1385803 2847 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
9fe287d7
AW
2848 $f = $lines[$ln - 1];
2849 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2850 $is_end = $lines[$ln - 1] =~ /^\+/;
9fe287d7
AW
2851
2852 next if ($f =~ /^-/);
8d73e0e7 2853 last if (!$file && $f =~ /^\@\@/);
a1385803 2854
86adf1a0 2855 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
a1385803 2856 $is_start = 1;
84af7a61
UM
2857 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) {
2858 if ($lines[$ln - 1] =~ "---help---") {
2859 WARN("CONFIG_DESCRIPTION",
2860 "prefer 'help' over '---help---' for new help texts\n" . $herecurr);
2861 }
a1385803
AW
2862 $length = -1;
2863 }
2864
9fe287d7 2865 $f =~ s/^.//;
3354957a
AK
2866 $f =~ s/#.*//;
2867 $f =~ s/^\s+//;
2868 next if ($f =~ /^$/);
678ae162
UM
2869
2870 # This only checks context lines in the patch
2871 # and so hopefully shouldn't trigger false
2872 # positives, even though some of these are
2873 # common words in help texts
2874 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
2875 if|endif|menu|endmenu|source)\b/x) {
9fe287d7
AW
2876 $is_end = 1;
2877 last;
2878 }
3354957a
AK
2879 $length++;
2880 }
56193274
VB
2881 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2882 WARN("CONFIG_DESCRIPTION",
2883 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2884 }
a1385803 2885 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
3354957a
AK
2886 }
2887
628f91a2
JP
2888# check for MAINTAINERS entries that don't have the right form
2889 if ($realfile =~ /^MAINTAINERS$/ &&
2890 $rawline =~ /^\+[A-Z]:/ &&
2891 $rawline !~ /^\+[A-Z]:\t\S/) {
2892 if (WARN("MAINTAINERS_STYLE",
2893 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
2894 $fix) {
2895 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
2896 }
2897 }
2898
327953e9
CJ
2899# discourage the use of boolean for type definition attributes of Kconfig options
2900 if ($realfile =~ /Kconfig/ &&
2901 $line =~ /^\+\s*\bboolean\b/) {
2902 WARN("CONFIG_TYPE_BOOLEAN",
2903 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2904 }
2905
c68e5878
AL
2906 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2907 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2908 my $flag = $1;
2909 my $replacement = {
2910 'EXTRA_AFLAGS' => 'asflags-y',
2911 'EXTRA_CFLAGS' => 'ccflags-y',
2912 'EXTRA_CPPFLAGS' => 'cppflags-y',
2913 'EXTRA_LDFLAGS' => 'ldflags-y',
2914 };
2915
2916 WARN("DEPRECATED_VARIABLE",
2917 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2918 }
2919
bff5da43 2920# check for DT compatible documentation
7dd05b38
FV
2921 if (defined $root &&
2922 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2923 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2924
bff5da43
RH
2925 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2926
cc93319b
FV
2927 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2928 my $vp_file = $dt_path . "vendor-prefixes.txt";
2929
bff5da43
RH
2930 foreach my $compat (@compats) {
2931 my $compat2 = $compat;
185d566b
RH
2932 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2933 my $compat3 = $compat;
2934 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2935 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
bff5da43
RH
2936 if ( $? >> 8 ) {
2937 WARN("UNDOCUMENTED_DT_STRING",
2938 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2939 }
2940
4fbf32a6
FV
2941 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2942 my $vendor = $1;
cc93319b 2943 `grep -Eq "^$vendor\\b" $vp_file`;
bff5da43
RH
2944 if ( $? >> 8 ) {
2945 WARN("UNDOCUMENTED_DT_STRING",
cc93319b 2946 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
bff5da43
RH
2947 }
2948 }
2949 }
2950
9f3a8992
RH
2951# check for using SPDX license tag at beginning of files
2952 if ($realline == $checklicenseline) {
2953 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
2954 $checklicenseline = 2;
2955 } elsif ($rawline =~ /^\+/) {
2956 my $comment = "";
2957 if ($realfile =~ /\.(h|s|S)$/) {
2958 $comment = '/*';
2959 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
2960 $comment = '//';
2961 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) {
2962 $comment = '#';
2963 } elsif ($realfile =~ /\.rst$/) {
2964 $comment = '..';
2965 }
2966
2967 if ($comment !~ /^$/ &&
2968 $rawline !~ /^\+\Q$comment\E SPDX-License-Identifier: /) {
2969 WARN("SPDX_LICENSE_TAG",
2970 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
2971 }
2972 }
2973 }
2974
5368df20 2975# check we are in a valid source file if not then ignore this hunk
d6430f71 2976 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
5368df20 2977
47e0c88b
JP
2978# line length limit (with some exclusions)
2979#
2980# There are a few types of lines that may extend beyond $max_line_length:
2981# logging functions like pr_info that end in a string
2982# lines with a single string
2983# #defines that are a single string
2e4bbbc5 2984# lines with an RFC3986 like URL
47e0c88b
JP
2985#
2986# There are 3 different line length message types:
ab1ecabf 2987# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
47e0c88b
JP
2988# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2989# LONG_LINE all other lines longer than $max_line_length
2990#
2991# if LONG_LINE is ignored, the other 2 types are also ignored
2992#
2993
b4749e96 2994 if ($line =~ /^\+/ && $length > $max_line_length) {
47e0c88b
JP
2995 my $msg_type = "LONG_LINE";
2996
2997 # Check the allowed long line types first
2998
2999 # logging functions that end in a string that starts
3000 # before $max_line_length
3001 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3002 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3003 $msg_type = "";
3004
3005 # lines with only strings (w/ possible termination)
3006 # #defines with only strings
3007 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
3008 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
3009 $msg_type = "";
3010
cc147506
JP
3011 # More special cases
3012 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3013 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
d560a5f8
JP
3014 $msg_type = "";
3015
2e4bbbc5
AB
3016 # URL ($rawline is used in case the URL is in a comment)
3017 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
3018 $msg_type = "";
3019
47e0c88b
JP
3020 # Otherwise set the alternate message types
3021
3022 # a comment starts before $max_line_length
3023 } elsif ($line =~ /($;[\s$;]*)$/ &&
3024 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3025 $msg_type = "LONG_LINE_COMMENT"
3026
3027 # a quoted string starts before $max_line_length
3028 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3029 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3030 $msg_type = "LONG_LINE_STRING"
3031 }
3032
3033 if ($msg_type ne "" &&
3034 (show_type("LONG_LINE") || show_type($msg_type))) {
3035 WARN($msg_type,
3036 "line over $max_line_length characters\n" . $herecurr);
3037 }
0a920b5b
AW
3038 }
3039
8905a67c
AW
3040# check for adding lines without a newline.
3041 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
000d1cc1
JP
3042 WARN("MISSING_EOF_NEWLINE",
3043 "adding a line without newline at end of file\n" . $herecurr);
8905a67c
AW
3044 }
3045
b9ea10d6 3046# check we are in a valid source file C or perl if not then ignore this hunk
de4c924c 3047 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
0a920b5b
AW
3048
3049# at the beginning of a line any tabs must come first and anything
3050# more than 8 must use tabs.
c2fdda0d
AW
3051 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3052 $rawline =~ /^\+\s* \s*/) {
3053 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
d2c0a235 3054 $rpt_cleaners = 1;
3705ce5b
JP
3055 if (ERROR("CODE_INDENT",
3056 "code indent should use tabs where possible\n" . $herevet) &&
3057 $fix) {
194f66fc 3058 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3705ce5b 3059 }
0a920b5b
AW
3060 }
3061
08e44365
AP
3062# check for space before tabs.
3063 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3064 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3705ce5b
JP
3065 if (WARN("SPACE_BEFORE_TAB",
3066 "please, no space before tabs\n" . $herevet) &&
3067 $fix) {
194f66fc 3068 while ($fixed[$fixlinenr] =~
d2207ccb 3069 s/(^\+.*) {8,8}\t/$1\t\t/) {}
194f66fc 3070 while ($fixed[$fixlinenr] =~
c76f4cb3 3071 s/(^\+.*) +\t/$1\t/) {}
3705ce5b 3072 }
08e44365 3073 }
6a487211
JP
3074
3075# check for assignments on the start of a line
3076 if ($sline =~ /^\+\s+($Assignment)[^=]/) {
3077 CHK("ASSIGNMENT_CONTINUATIONS",
3078 "Assignment operator '$1' should be on the previous line\n" . $hereprev);
3079 }
08e44365 3080
d1fe9c09
JP
3081# check for && or || at the start of a line
3082 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3083 CHK("LOGICAL_CONTINUATIONS",
3084 "Logical continuations should be on the previous line\n" . $hereprev);
3085 }
3086
a91e8994
JP
3087# check indentation starts on a tab stop
3088 if ($^V && $^V ge 5.10.0 &&
bd49111f 3089 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
a91e8994
JP
3090 my $indent = length($1);
3091 if ($indent % 8) {
3092 if (WARN("TABSTOP",
3093 "Statements should start on a tabstop\n" . $herecurr) &&
3094 $fix) {
3095 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
3096 }
3097 }
3098 }
3099
d1fe9c09
JP
3100# check multi-line statement indentation matches previous line
3101 if ($^V && $^V ge 5.10.0 &&
fd71f632 3102 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
d1fe9c09
JP
3103 $prevline =~ /^\+(\t*)(.*)$/;
3104 my $oldindent = $1;
3105 my $rest = $2;
3106
3107 my $pos = pos_last_openparen($rest);
3108 if ($pos >= 0) {
b34a26f3
JP
3109 $line =~ /^(\+| )([ \t]*)/;
3110 my $newindent = $2;
d1fe9c09
JP
3111
3112 my $goodtabindent = $oldindent .
3113 "\t" x ($pos / 8) .
3114 " " x ($pos % 8);
3115 my $goodspaceindent = $oldindent . " " x $pos;
3116
3117 if ($newindent ne $goodtabindent &&
3118 $newindent ne $goodspaceindent) {
3705ce5b
JP
3119
3120 if (CHK("PARENTHESIS_ALIGNMENT",
3121 "Alignment should match open parenthesis\n" . $hereprev) &&
3122 $fix && $line =~ /^\+/) {
194f66fc 3123 $fixed[$fixlinenr] =~
3705ce5b
JP
3124 s/^\+[ \t]*/\+$goodtabindent/;
3125 }
d1fe9c09
JP
3126 }
3127 }
3128 }
3129
6ab3a970
JP
3130# check for space after cast like "(int) foo" or "(struct foo) bar"
3131# avoid checking a few false positives:
3132# "sizeof(<type>)" or "__alignof__(<type>)"
3133# function pointer declarations like "(*foo)(int) = bar;"
3134# structure definitions like "(struct foo) { 0 };"
3135# multiline macros that define functions
3136# known attributes or the __attribute__ keyword
3137 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3138 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
3705ce5b 3139 if (CHK("SPACING",
f27c95db 3140 "No space is necessary after a cast\n" . $herecurr) &&
3705ce5b 3141 $fix) {
194f66fc 3142 $fixed[$fixlinenr] =~
f27c95db 3143 s/(\(\s*$Type\s*\))[ \t]+/$1/;
3705ce5b 3144 }
aad4f614
JP
3145 }
3146
86406b1c
JP
3147# Block comment styles
3148# Networking with an initial /*
05880600 3149 if ($realfile =~ m@^(drivers/net/|net/)@ &&
fdb4bcd6 3150 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
85ad978c
JP
3151 $rawline =~ /^\+[ \t]*\*/ &&
3152 $realline > 2) {
05880600
JP
3153 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3154 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3155 }
3156
86406b1c
JP
3157# Block comments use * on subsequent lines
3158 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3159 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
a605e32e 3160 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
61135e96 3161 $rawline =~ /^\+/ && #line is new
a605e32e 3162 $rawline !~ /^\+[ \t]*\*/) { #no leading *
86406b1c
JP
3163 WARN("BLOCK_COMMENT_STYLE",
3164 "Block comments use * on subsequent lines\n" . $hereprev);
a605e32e
JP
3165 }
3166
86406b1c
JP
3167# Block comments use */ on trailing lines
3168 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
c24f9f19
JP
3169 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3170 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3171 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
86406b1c
JP
3172 WARN("BLOCK_COMMENT_STYLE",
3173 "Block comments use a trailing */ on a separate line\n" . $herecurr);
05880600
JP
3174 }
3175
08eb9b80
JP
3176# Block comment * alignment
3177 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
af207524
JP
3178 $line =~ /^\+[ \t]*$;/ && #leading comment
3179 $rawline =~ /^\+[ \t]*\*/ && #leading *
3180 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
08eb9b80 3181 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
af207524
JP
3182 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3183 my $oldindent;
08eb9b80 3184 $prevrawline =~ m@^\+([ \t]*/?)\*@;
af207524
JP
3185 if (defined($1)) {
3186 $oldindent = expand_tabs($1);
3187 } else {
3188 $prevrawline =~ m@^\+(.*/?)\*@;
3189 $oldindent = expand_tabs($1);
3190 }
08eb9b80
JP
3191 $rawline =~ m@^\+([ \t]*)\*@;
3192 my $newindent = $1;
08eb9b80 3193 $newindent = expand_tabs($newindent);
af207524 3194 if (length($oldindent) ne length($newindent)) {
08eb9b80
JP
3195 WARN("BLOCK_COMMENT_STYLE",
3196 "Block comments should align the * on each line\n" . $hereprev);
3197 }
3198 }
3199
7f619191
JP
3200# check for missing blank lines after struct/union declarations
3201# with exceptions for various attributes and macros
3202 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3203 $line =~ /^\+/ &&
3204 !($line =~ /^\+\s*$/ ||
3205 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3206 $line =~ /^\+\s*MODULE_/i ||
3207 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3208 $line =~ /^\+[a-z_]*init/ ||
3209 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3210 $line =~ /^\+\s*DECLARE/ ||
0bc989ff 3211 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
7f619191 3212 $line =~ /^\+\s*__setup/)) {
d752fcc8
JP
3213 if (CHK("LINE_SPACING",
3214 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3215 $fix) {
f2d7e4d4 3216 fix_insert_line($fixlinenr, "\+");
d752fcc8 3217 }
7f619191
JP
3218 }
3219
365dd4ea
JP
3220# check for multiple consecutive blank lines
3221 if ($prevline =~ /^[\+ ]\s*$/ &&
3222 $line =~ /^\+\s*$/ &&
3223 $last_blank_line != ($linenr - 1)) {
d752fcc8
JP
3224 if (CHK("LINE_SPACING",
3225 "Please don't use multiple blank lines\n" . $hereprev) &&
3226 $fix) {
f2d7e4d4 3227 fix_delete_line($fixlinenr, $rawline);
d752fcc8
JP
3228 }
3229
365dd4ea
JP
3230 $last_blank_line = $linenr;
3231 }
3232
3b617e3b 3233# check for missing blank lines after declarations
3f7bac03
JP
3234 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3235 # actual declarations
3236 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
5a4e1fd3
JP
3237 # function pointer declarations
3238 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3f7bac03
JP
3239 # foo bar; where foo is some local typedef or #define
3240 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3241 # known declaration macros
3242 $prevline =~ /^\+\s+$declaration_macros/) &&
3243 # for "else if" which can look like "$Ident $Ident"
3244 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3245 # other possible extensions of declaration lines
3246 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3247 # not starting a section or a macro "\" extended line
3248 $prevline =~ /(?:\{\s*|\\)$/) &&
3249 # looks like a declaration
3250 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
5a4e1fd3
JP
3251 # function pointer declarations
3252 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3f7bac03
JP
3253 # foo bar; where foo is some local typedef or #define
3254 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3255 # known declaration macros
3256 $sline =~ /^\+\s+$declaration_macros/ ||
3257 # start of struct or union or enum
3b617e3b 3258 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
3f7bac03
JP
3259 # start or end of block or continuation of declaration
3260 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3261 # bitfield continuation
3262 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3263 # other possible extensions of declaration lines
3264 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3265 # indentation of previous and current line are the same
3266 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
d752fcc8
JP
3267 if (WARN("LINE_SPACING",
3268 "Missing a blank line after declarations\n" . $hereprev) &&
3269 $fix) {
f2d7e4d4 3270 fix_insert_line($fixlinenr, "\+");
d752fcc8 3271 }
3b617e3b
JP
3272 }
3273
5f7ddae6 3274# check for spaces at the beginning of a line.
6b4c5beb
AW
3275# Exceptions:
3276# 1) within comments
3277# 2) indented preprocessor commands
3278# 3) hanging labels
3705ce5b 3279 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
5f7ddae6 3280 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3705ce5b
JP
3281 if (WARN("LEADING_SPACE",
3282 "please, no spaces at the start of a line\n" . $herevet) &&
3283 $fix) {
194f66fc 3284 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3705ce5b 3285 }
5f7ddae6
RR
3286 }
3287
b9ea10d6
AW
3288# check we are in a valid C source file if not then ignore this hunk
3289 next if ($realfile !~ /\.(h|c)$/);
3290
5751a24e
JP
3291# check for unusual line ending [ or (
3292 if ($line =~ /^\+.*([\[\(])\s*$/) {
3293 CHK("OPEN_ENDED_LINE",
3294 "Lines should not end with a '$1'\n" . $herecurr);
3295 }
3296
4dbed76f
JP
3297# check if this appears to be the start function declaration, save the name
3298 if ($sline =~ /^\+\{\s*$/ &&
3299 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3300 $context_function = $1;
3301 }
3302
3303# check if this appears to be the end of function declaration
3304 if ($sline =~ /^\+\}\s*$/) {
3305 undef $context_function;
3306 }
3307
032a4c0f 3308# check indentation of any line with a bare else
840080a0 3309# (but not if it is a multiple line "if (foo) return bar; else return baz;")
032a4c0f
JP
3310# if the previous line is a break or return and is indented 1 tab more...
3311 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3312 my $tabs = length($1) + 1;
840080a0
JP
3313 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3314 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3315 defined $lines[$linenr] &&
3316 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
032a4c0f
JP
3317 WARN("UNNECESSARY_ELSE",
3318 "else is not generally useful after a break or return\n" . $hereprev);
3319 }
3320 }
3321
c00df19a
JP
3322# check indentation of a line with a break;
3323# if the previous line is a goto or return and is indented the same # of tabs
3324 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3325 my $tabs = $1;
3326 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3327 WARN("UNNECESSARY_BREAK",
3328 "break is not useful after a goto or return\n" . $hereprev);
3329 }
3330 }
3331
c2fdda0d 3332# check for RCS/CVS revision markers
cf655043 3333 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
000d1cc1
JP
3334 WARN("CVS_KEYWORD",
3335 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
c2fdda0d 3336 }
22f2a2ef 3337
56e77d70
JP
3338# check for old HOTPLUG __dev<foo> section markings
3339 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3340 WARN("HOTPLUG_SECTION",
3341 "Using $1 is unnecessary\n" . $herecurr);
3342 }
3343
9c0ca6f9 3344# Check for potential 'bare' types
2b474a1a
AW
3345 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3346 $realline_next);
3e469cdc 3347#print "LINE<$line>\n";
ca819864 3348 if ($linenr > $suppress_statement &&
1b5539b1 3349 $realcnt && $sline =~ /.\s*\S/) {
170d3a22 3350 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
f5fe35dd 3351 ctx_statement_block($linenr, $realcnt, 0);
171ae1a4
AW
3352 $stat =~ s/\n./\n /g;
3353 $cond =~ s/\n./\n /g;
3354
3e469cdc
AW
3355#print "linenr<$linenr> <$stat>\n";
3356 # If this statement has no statement boundaries within
3357 # it there is no point in retrying a statement scan
3358 # until we hit end of it.
3359 my $frag = $stat; $frag =~ s/;+\s*$//;
3360 if ($frag !~ /(?:{|;)/) {
3361#print "skip<$line_nr_next>\n";
3362 $suppress_statement = $line_nr_next;
3363 }
f74bd194 3364
2b474a1a
AW
3365 # Find the real next line.
3366 $realline_next = $line_nr_next;
3367 if (defined $realline_next &&
3368 (!defined $lines[$realline_next - 1] ||
3369 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3370 $realline_next++;
3371 }
3372
171ae1a4
AW
3373 my $s = $stat;
3374 $s =~ s/{.*$//s;
cf655043 3375
c2fdda0d 3376 # Ignore goto labels.
171ae1a4 3377 if ($s =~ /$Ident:\*$/s) {
c2fdda0d
AW
3378
3379 # Ignore functions being called
171ae1a4 3380 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
c2fdda0d 3381
463f2864
AW
3382 } elsif ($s =~ /^.\s*else\b/s) {
3383
c45dcabd 3384 # declarations always start with types
d2506586 3385 } 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
3386 my $type = $1;
3387 $type =~ s/\s+/ /g;
3388 possible($type, "A:" . $s);
3389
8905a67c 3390 # definitions in global scope can only start with types
a6a84062 3391 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
c45dcabd 3392 possible($1, "B:" . $s);
c2fdda0d 3393 }
8905a67c
AW
3394
3395 # any (foo ... *) is a pointer cast, and foo is a type
65863862 3396 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
c45dcabd 3397 possible($1, "C:" . $s);
8905a67c
AW
3398 }
3399
3400 # Check for any sort of function declaration.
3401 # int foo(something bar, other baz);
3402 # void (*store_gdt)(x86_descr_ptr *);
171ae1a4 3403 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
8905a67c 3404 my ($name_len) = length($1);
8905a67c 3405
cf655043 3406 my $ctx = $s;
773647a0 3407 substr($ctx, 0, $name_len + 1, '');
8905a67c 3408 $ctx =~ s/\)[^\)]*$//;
cf655043 3409
8905a67c 3410 for my $arg (split(/\s*,\s*/, $ctx)) {
c45dcabd 3411 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
8905a67c 3412
c45dcabd 3413 possible($1, "D:" . $s);
8905a67c
AW
3414 }
3415 }
9c0ca6f9 3416 }
8905a67c 3417
9c0ca6f9
AW
3418 }
3419
653d4876
AW
3420#
3421# Checks which may be anchored in the context.
3422#
00df344f 3423
653d4876
AW
3424# Check for switch () and associated case and default
3425# statements should be at the same indent.
00df344f
AW
3426 if ($line=~/\bswitch\s*\(.*\)/) {
3427 my $err = '';
3428 my $sep = '';
3429 my @ctx = ctx_block_outer($linenr, $realcnt);
3430 shift(@ctx);
3431 for my $ctx (@ctx) {
3432 my ($clen, $cindent) = line_stats($ctx);
3433 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3434 $indent != $cindent) {
3435 $err .= "$sep$ctx\n";
3436 $sep = '';
3437 } else {
3438 $sep = "[...]\n";
3439 }
3440 }
3441 if ($err ne '') {
000d1cc1
JP
3442 ERROR("SWITCH_CASE_INDENT_LEVEL",
3443 "switch and case should be at the same indent\n$hereline$err");
de7d4f0e
AW
3444 }
3445 }
3446
3447# if/while/etc brace do not go on next line, unless defining a do while loop,
3448# or if that brace on the next line is for something else
0fe3dc2b 3449 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
773647a0
AW
3450 my $pre_ctx = "$1$2";
3451
9c0ca6f9 3452 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
8eef05dd
JP
3453
3454 if ($line =~ /^\+\t{6,}/) {
3455 WARN("DEEP_INDENTATION",
3456 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3457 }
3458
de7d4f0e
AW
3459 my $ctx_cnt = $realcnt - $#ctx - 1;
3460 my $ctx = join("\n", @ctx);
3461
548596d5
AW
3462 my $ctx_ln = $linenr;
3463 my $ctx_skip = $realcnt;
773647a0 3464
548596d5
AW
3465 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3466 defined $lines[$ctx_ln - 1] &&
3467 $lines[$ctx_ln - 1] =~ /^-/)) {
3468 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3469 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
de7d4f0e 3470 $ctx_ln++;
de7d4f0e 3471 }
548596d5 3472
53210168
AW
3473 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3474 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
de7d4f0e 3475
d752fcc8 3476 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
000d1cc1
JP
3477 ERROR("OPEN_BRACE",
3478 "that open brace { should be on the previous line\n" .
01464f30 3479 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
00df344f 3480 }
773647a0
AW
3481 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3482 $ctx =~ /\)\s*\;\s*$/ &&
3483 defined $lines[$ctx_ln - 1])
3484 {
9c0ca6f9
AW
3485 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3486 if ($nindent > $indent) {
000d1cc1
JP
3487 WARN("TRAILING_SEMICOLON",
3488 "trailing semicolon indicates no statements, indent implies otherwise\n" .
01464f30 3489 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
9c0ca6f9
AW
3490 }
3491 }
00df344f
AW
3492 }
3493
4d001e4d 3494# Check relative indent for conditionals and blocks.
f6950a73 3495 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3e469cdc
AW
3496 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3497 ctx_statement_block($linenr, $realcnt, 0)
3498 if (!defined $stat);
4d001e4d
AW
3499 my ($s, $c) = ($stat, $cond);
3500
3501 substr($s, 0, length($c), '');
3502
9f5af480
JP
3503 # remove inline comments
3504 $s =~ s/$;/ /g;
3505 $c =~ s/$;/ /g;
4d001e4d
AW
3506
3507 # Find out how long the conditional actually is.
6f779c18
AW
3508 my @newlines = ($c =~ /\n/gs);
3509 my $cond_lines = 1 + $#newlines;
4d001e4d 3510
9f5af480
JP
3511 # Make sure we remove the line prefixes as we have
3512 # none on the first line, and are going to readd them
3513 # where necessary.
3514 $s =~ s/\n./\n/gs;
3515 while ($s =~ /\n\s+\\\n/) {
3516 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3517 }
3518
4d001e4d
AW
3519 # We want to check the first line inside the block
3520 # starting at the end of the conditional, so remove:
3521 # 1) any blank line termination
3522 # 2) any opening brace { on end of the line
3523 # 3) any do (...) {
3524 my $continuation = 0;
3525 my $check = 0;
3526 $s =~ s/^.*\bdo\b//;
3527 $s =~ s/^\s*{//;
3528 if ($s =~ s/^\s*\\//) {
3529 $continuation = 1;
3530 }
9bd49efe 3531 if ($s =~ s/^\s*?\n//) {
4d001e4d
AW
3532 $check = 1;
3533 $cond_lines++;
3534 }
3535
3536 # Also ignore a loop construct at the end of a
3537 # preprocessor statement.
3538 if (($prevline =~ /^.\s*#\s*define\s/ ||
3539 $prevline =~ /\\\s*$/) && $continuation == 0) {
3540 $check = 0;
3541 }
3542
9bd49efe 3543 my $cond_ptr = -1;
740504c6 3544 $continuation = 0;
9bd49efe
AW
3545 while ($cond_ptr != $cond_lines) {
3546 $cond_ptr = $cond_lines;
3547
f16fa28f
AW
3548 # If we see an #else/#elif then the code
3549 # is not linear.
3550 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3551 $check = 0;
3552 }
3553
9bd49efe
AW
3554 # Ignore:
3555 # 1) blank lines, they should be at 0,
3556 # 2) preprocessor lines, and
3557 # 3) labels.
740504c6
AW
3558 if ($continuation ||
3559 $s =~ /^\s*?\n/ ||
9bd49efe
AW
3560 $s =~ /^\s*#\s*?/ ||
3561 $s =~ /^\s*$Ident\s*:/) {
740504c6 3562 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
30dad6eb
AW
3563 if ($s =~ s/^.*?\n//) {
3564 $cond_lines++;
3565 }
9bd49efe 3566 }
4d001e4d
AW
3567 }
3568
3569 my (undef, $sindent) = line_stats("+" . $s);
3570 my $stat_real = raw_line($linenr, $cond_lines);
3571
3572 # Check if either of these lines are modified, else
3573 # this is not this patch's fault.
3574 if (!defined($stat_real) ||
3575 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3576 $check = 0;
3577 }
3578 if (defined($stat_real) && $cond_lines > 1) {
3579 $stat_real = "[...]\n$stat_real";
3580 }
3581
9bd49efe 3582 #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 3583
9f5af480
JP
3584 if ($check && $s ne '' &&
3585 (($sindent % 8) != 0 ||
3586 ($sindent < $indent) ||
f6950a73
JP
3587 ($sindent == $indent &&
3588 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
9f5af480 3589 ($sindent > $indent + 8))) {
000d1cc1
JP
3590 WARN("SUSPECT_CODE_INDENT",
3591 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
4d001e4d
AW
3592 }
3593 }
3594
6c72ffaa
AW
3595 # Track the 'values' across context and added lines.
3596 my $opline = $line; $opline =~ s/^./ /;
1f65f947
AW
3597 my ($curr_values, $curr_vars) =
3598 annotate_values($opline . "\n", $prev_values);
6c72ffaa 3599 $curr_values = $prev_values . $curr_values;
c2fdda0d
AW
3600 if ($dbg_values) {
3601 my $outline = $opline; $outline =~ s/\t/ /g;
cf655043
AW
3602 print "$linenr > .$outline\n";
3603 print "$linenr > $curr_values\n";
1f65f947 3604 print "$linenr > $curr_vars\n";
c2fdda0d 3605 }
6c72ffaa
AW
3606 $prev_values = substr($curr_values, -1);
3607
00df344f 3608#ignore lines not being added
3705ce5b 3609 next if ($line =~ /^[^\+]/);
00df344f 3610
11ca40a0
JP
3611# check for dereferences that span multiple lines
3612 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3613 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3614 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3615 my $ref = $1;
3616 $line =~ /^.\s*($Lval)/;
3617 $ref .= $1;
3618 $ref =~ s/\s//g;
3619 WARN("MULTILINE_DEREFERENCE",
3620 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3621 }
3622
a1ce18e4 3623# check for declarations of signed or unsigned without int
c8447115 3624 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
a1ce18e4
JP
3625 my $type = $1;
3626 my $var = $2;
207a8e84
JP
3627 $var = "" if (!defined $var);
3628 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
a1ce18e4
JP
3629 my $sign = $1;
3630 my $pointer = $2;
3631
3632 $pointer = "" if (!defined $pointer);
3633
3634 if (WARN("UNSPECIFIED_INT",
3635 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3636 $fix) {
3637 my $decl = trim($sign) . " int ";
207a8e84
JP
3638 my $comp_pointer = $pointer;
3639 $comp_pointer =~ s/\s//g;
3640 $decl .= $comp_pointer;
3641 $decl = rtrim($decl) if ($var eq "");
3642 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
a1ce18e4
JP
3643 }
3644 }
3645 }
3646
653d4876 3647# TEST: allow direct testing of the type matcher.
7429c690
AW
3648 if ($dbg_type) {
3649 if ($line =~ /^.\s*$Declare\s*$/) {
000d1cc1
JP
3650 ERROR("TEST_TYPE",
3651 "TEST: is type\n" . $herecurr);
7429c690 3652 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
000d1cc1
JP
3653 ERROR("TEST_NOT_TYPE",
3654 "TEST: is not type ($1 is)\n". $herecurr);
7429c690 3655 }
653d4876
AW
3656 next;
3657 }
a1ef277e
AW
3658# TEST: allow direct testing of the attribute matcher.
3659 if ($dbg_attr) {
9360b0e5 3660 if ($line =~ /^.\s*$Modifier\s*$/) {
000d1cc1
JP
3661 ERROR("TEST_ATTR",
3662 "TEST: is attr\n" . $herecurr);
9360b0e5 3663 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
000d1cc1
JP
3664 ERROR("TEST_NOT_ATTR",
3665 "TEST: is not attr ($1 is)\n". $herecurr);
a1ef277e
AW
3666 }
3667 next;
3668 }
653d4876 3669
f0a594c1 3670# check for initialisation to aggregates open brace on the next line
99423c20
AW
3671 if ($line =~ /^.\s*{/ &&
3672 $prevline =~ /(?:^|[^=])=\s*$/) {
d752fcc8
JP
3673 if (ERROR("OPEN_BRACE",
3674 "that open brace { should be on the previous line\n" . $hereprev) &&
f2d7e4d4
JP
3675 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3676 fix_delete_line($fixlinenr - 1, $prevrawline);
3677 fix_delete_line($fixlinenr, $rawline);
d752fcc8
JP
3678 my $fixedline = $prevrawline;
3679 $fixedline =~ s/\s*=\s*$/ = {/;
f2d7e4d4 3680 fix_insert_line($fixlinenr, $fixedline);
d752fcc8 3681 $fixedline = $line;
8d81ae05 3682 $fixedline =~ s/^(.\s*)\{\s*/$1/;
f2d7e4d4 3683 fix_insert_line($fixlinenr, $fixedline);
d752fcc8 3684 }
f0a594c1
AW
3685 }
3686
653d4876
AW
3687#
3688# Checks which are anchored on the added line.
3689#
3690
3691# check for malformed paths in #include statements (uses RAW line)
c45dcabd 3692 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
653d4876
AW
3693 my $path = $1;
3694 if ($path =~ m{//}) {
000d1cc1 3695 ERROR("MALFORMED_INCLUDE",
495e9d84
JP
3696 "malformed #include filename\n" . $herecurr);
3697 }
3698 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3699 ERROR("UAPI_INCLUDE",
3700 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
653d4876 3701 }
653d4876 3702 }
00df344f 3703
0a920b5b 3704# no C99 // comments
00df344f 3705 if ($line =~ m{//}) {
3705ce5b
JP
3706 if (ERROR("C99_COMMENTS",
3707 "do not use C99 // comments\n" . $herecurr) &&
3708 $fix) {
194f66fc 3709 my $line = $fixed[$fixlinenr];
3705ce5b
JP
3710 if ($line =~ /\/\/(.*)$/) {
3711 my $comment = trim($1);
194f66fc 3712 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3705ce5b
JP
3713 }
3714 }
0a920b5b 3715 }
00df344f 3716 # Remove C99 comments.
0a920b5b 3717 $line =~ s@//.*@@;
6c72ffaa 3718 $opline =~ s@//.*@@;
0a920b5b 3719
2b474a1a
AW
3720# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3721# the whole statement.
3722#print "APW <$lines[$realline_next - 1]>\n";
3723 if (defined $realline_next &&
3724 exists $lines[$realline_next - 1] &&
3725 !defined $suppress_export{$realline_next} &&
3726 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3727 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3cbf62df
AW
3728 # Handle definitions which produce identifiers with
3729 # a prefix:
3730 # XXX(foo);
3731 # EXPORT_SYMBOL(something_foo);
653d4876 3732 my $name = $1;
87a53877 3733 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3cbf62df
AW
3734 $name =~ /^${Ident}_$2/) {
3735#print "FOO C name<$name>\n";
3736 $suppress_export{$realline_next} = 1;
3737
3738 } elsif ($stat !~ /(?:
2b474a1a 3739 \n.}\s*$|
48012058
AW
3740 ^.DEFINE_$Ident\(\Q$name\E\)|
3741 ^.DECLARE_$Ident\(\Q$name\E\)|
3742 ^.LIST_HEAD\(\Q$name\E\)|
2b474a1a
AW
3743 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3744 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
48012058 3745 )/x) {
2b474a1a
AW
3746#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3747 $suppress_export{$realline_next} = 2;
3748 } else {
3749 $suppress_export{$realline_next} = 1;
0a920b5b
AW
3750 }
3751 }
2b474a1a
AW
3752 if (!defined $suppress_export{$linenr} &&
3753 $prevline =~ /^.\s*$/ &&
3754 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3755 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3756#print "FOO B <$lines[$linenr - 1]>\n";
3757 $suppress_export{$linenr} = 2;
3758 }
3759 if (defined $suppress_export{$linenr} &&
3760 $suppress_export{$linenr} == 2) {
000d1cc1
JP
3761 WARN("EXPORT_SYMBOL",
3762 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2b474a1a 3763 }
0a920b5b 3764
5150bda4 3765# check for global initialisers.
6d32f7a3 3766 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
d5e616fc 3767 if (ERROR("GLOBAL_INITIALISERS",
6d32f7a3 3768 "do not initialise globals to $1\n" . $herecurr) &&
d5e616fc 3769 $fix) {
6d32f7a3 3770 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
d5e616fc 3771 }
f0a594c1 3772 }
653d4876 3773# check for static initialisers.
6d32f7a3 3774 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
d5e616fc 3775 if (ERROR("INITIALISED_STATIC",
6d32f7a3 3776 "do not initialise statics to $1\n" .
d5e616fc
JP
3777 $herecurr) &&
3778 $fix) {
6d32f7a3 3779 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
d5e616fc 3780 }
0a920b5b
AW
3781 }
3782
1813087d
JP
3783# check for misordered declarations of char/short/int/long with signed/unsigned
3784 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3785 my $tmp = trim($1);
3786 WARN("MISORDERED_TYPE",
3787 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3788 }
3789
cb710eca
JP
3790# check for static const char * arrays.
3791 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
000d1cc1
JP
3792 WARN("STATIC_CONST_CHAR_ARRAY",
3793 "static const char * array should probably be static const char * const\n" .
cb710eca
JP
3794 $herecurr);
3795 }
3796
3797# check for static char foo[] = "bar" declarations.
3798 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
000d1cc1
JP
3799 WARN("STATIC_CONST_CHAR_ARRAY",
3800 "static char array declaration should probably be static const char\n" .
cb710eca
JP
3801 $herecurr);
3802 }
3803
ab7e23f3
JP
3804# check for const <foo> const where <foo> is not a pointer or array type
3805 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3806 my $found = $1;
3807 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3808 WARN("CONST_CONST",
3809 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3810 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3811 WARN("CONST_CONST",
3812 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3813 }
3814 }
3815
9b0fa60d
JP
3816# check for non-global char *foo[] = {"bar", ...} declarations.
3817 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3818 WARN("STATIC_CONST_CHAR_ARRAY",
3819 "char * array declaration might be better as static const\n" .
3820 $herecurr);
3821 }
3822
b598b670
JP
3823# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3824 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3825 my $array = $1;
3826 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3827 my $array_div = $1;
3828 if (WARN("ARRAY_SIZE",
3829 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3830 $fix) {
3831 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3832 }
3833 }
3834 }
3835
b36190c5
JP
3836# check for function declarations without arguments like "int foo()"
3837 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3838 if (ERROR("FUNCTION_WITHOUT_ARGS",
3839 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3840 $fix) {
194f66fc 3841 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
b36190c5
JP
3842 }
3843 }
3844
653d4876
AW
3845# check for new typedefs, only function parameters and sparse annotations
3846# make sense.
3847 if ($line =~ /\btypedef\s/ &&
8054576d 3848 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
c45dcabd 3849 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
8ed22cad 3850 $line !~ /\b$typeTypedefs\b/ &&
46d832f5 3851 $line !~ /\b__bitwise\b/) {
000d1cc1
JP
3852 WARN("NEW_TYPEDEFS",
3853 "do not add new typedefs\n" . $herecurr);
0a920b5b
AW
3854 }
3855
3856# * goes on variable not on type
65863862 3857 # (char*[ const])
bfcb2cc7
AW
3858 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3859 #print "AA<$1>\n";
3705ce5b 3860 my ($ident, $from, $to) = ($1, $2, $2);
65863862
AW
3861
3862 # Should start with a space.
3863 $to =~ s/^(\S)/ $1/;
3864 # Should not end with a space.
3865 $to =~ s/\s+$//;
3866 # '*'s should not have spaces between.
f9a0b3d1 3867 while ($to =~ s/\*\s+\*/\*\*/) {
65863862 3868 }
d8aaf121 3869
3705ce5b 3870## print "1: from<$from> to<$to> ident<$ident>\n";
65863862 3871 if ($from ne $to) {
3705ce5b
JP
3872 if (ERROR("POINTER_LOCATION",
3873 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3874 $fix) {
3875 my $sub_from = $ident;
3876 my $sub_to = $ident;
3877 $sub_to =~ s/\Q$from\E/$to/;
194f66fc 3878 $fixed[$fixlinenr] =~
3705ce5b
JP
3879 s@\Q$sub_from\E@$sub_to@;
3880 }
65863862 3881 }
bfcb2cc7
AW
3882 }
3883 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3884 #print "BB<$1>\n";
3705ce5b 3885 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
65863862
AW
3886
3887 # Should start with a space.
3888 $to =~ s/^(\S)/ $1/;
3889 # Should not end with a space.
3890 $to =~ s/\s+$//;
3891 # '*'s should not have spaces between.
f9a0b3d1 3892 while ($to =~ s/\*\s+\*/\*\*/) {
65863862
AW
3893 }
3894 # Modifiers should have spaces.
3895 $to =~ s/(\b$Modifier$)/$1 /;
d8aaf121 3896
3705ce5b 3897## print "2: from<$from> to<$to> ident<$ident>\n";
667026e7 3898 if ($from ne $to && $ident !~ /^$Modifier$/) {
3705ce5b
JP
3899 if (ERROR("POINTER_LOCATION",
3900 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3901 $fix) {
3902
3903 my $sub_from = $match;
3904 my $sub_to = $match;
3905 $sub_to =~ s/\Q$from\E/$to/;
194f66fc 3906 $fixed[$fixlinenr] =~
3705ce5b
JP
3907 s@\Q$sub_from\E@$sub_to@;
3908 }
65863862 3909 }
0a920b5b
AW
3910 }
3911
9d3e3c70
JP
3912# avoid BUG() or BUG_ON()
3913 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
0675a8fb
JD
3914 my $msg_level = \&WARN;
3915 $msg_level = \&CHK if ($file);
3916 &{$msg_level}("AVOID_BUG",
3917 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
9d3e3c70 3918 }
0a920b5b 3919
9d3e3c70 3920# avoid LINUX_VERSION_CODE
8905a67c 3921 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
000d1cc1
JP
3922 WARN("LINUX_VERSION_CODE",
3923 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
8905a67c
AW
3924 }
3925
17441227
JP
3926# check for uses of printk_ratelimit
3927 if ($line =~ /\bprintk_ratelimit\s*\(/) {
000d1cc1 3928 WARN("PRINTK_RATELIMITED",
101ee680 3929 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
17441227
JP
3930 }
3931
eeef5733
JP
3932# printk should use KERN_* levels
3933 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
3934 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3935 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
0a920b5b
AW
3936 }
3937
243f3803
JP
3938 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3939 my $orig = $1;
3940 my $level = lc($orig);
3941 $level = "warn" if ($level eq "warning");
8f26b837
JP
3942 my $level2 = $level;
3943 $level2 = "dbg" if ($level eq "debug");
243f3803 3944 WARN("PREFER_PR_LEVEL",
daa8b059 3945 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
243f3803
JP
3946 }
3947
3948 if ($line =~ /\bpr_warning\s*\(/) {
d5e616fc
JP
3949 if (WARN("PREFER_PR_LEVEL",
3950 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3951 $fix) {
194f66fc 3952 $fixed[$fixlinenr] =~
d5e616fc
JP
3953 s/\bpr_warning\b/pr_warn/;
3954 }
243f3803
JP
3955 }
3956
dc139313
JP
3957 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3958 my $orig = $1;
3959 my $level = lc($orig);
3960 $level = "warn" if ($level eq "warning");
3961 $level = "dbg" if ($level eq "debug");
3962 WARN("PREFER_DEV_LEVEL",
3963 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3964 }
3965
91c9afaf
AL
3966# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3967# number of false positives, but assembly files are not checked, so at
3968# least the arch entry code will not trigger this warning.
3969 if ($line =~ /\bENOSYS\b/) {
3970 WARN("ENOSYS",
3971 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3972 }
3973
653d4876
AW
3974# function brace can't be on same line, except for #defines of do while,
3975# or if closed on same line
2d453e3b
JP
3976 if ($^V && $^V ge 5.10.0 &&
3977 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
3978 $sline !~ /\#\s*define\b.*do\s*\{/ &&
3979 $sline !~ /}/) {
8d182478 3980 if (ERROR("OPEN_BRACE",
2d453e3b 3981 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
8d182478
JP
3982 $fix) {
3983 fix_delete_line($fixlinenr, $rawline);
3984 my $fixed_line = $rawline;
3985 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3986 my $line1 = $1;
3987 my $line2 = $2;
3988 fix_insert_line($fixlinenr, ltrim($line1));
3989 fix_insert_line($fixlinenr, "\+{");
3990 if ($line2 !~ /^\s*$/) {
3991 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3992 }
3993 }
0a920b5b 3994 }
653d4876 3995
8905a67c
AW
3996# open braces for enum, union and struct go on the same line.
3997 if ($line =~ /^.\s*{/ &&
3998 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
8d182478
JP
3999 if (ERROR("OPEN_BRACE",
4000 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
4001 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4002 fix_delete_line($fixlinenr - 1, $prevrawline);
4003 fix_delete_line($fixlinenr, $rawline);
4004 my $fixedline = rtrim($prevrawline) . " {";
4005 fix_insert_line($fixlinenr, $fixedline);
4006 $fixedline = $rawline;
8d81ae05 4007 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
8d182478
JP
4008 if ($fixedline !~ /^\+\s*$/) {
4009 fix_insert_line($fixlinenr, $fixedline);
4010 }
4011 }
8905a67c
AW
4012 }
4013
0c73b4eb 4014# missing space after union, struct or enum definition
3705ce5b
JP
4015 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
4016 if (WARN("SPACING",
4017 "missing space after $1 definition\n" . $herecurr) &&
4018 $fix) {
194f66fc 4019 $fixed[$fixlinenr] =~
3705ce5b
JP
4020 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
4021 }
0c73b4eb
AW
4022 }
4023
31070b5d
JP
4024# Function pointer declarations
4025# check spacing between type, funcptr, and args
4026# canonical declaration is "type (*funcptr)(args...)"
91f72e9c 4027 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
31070b5d
JP
4028 my $declare = $1;
4029 my $pre_pointer_space = $2;
4030 my $post_pointer_space = $3;
4031 my $funcname = $4;
4032 my $post_funcname_space = $5;
4033 my $pre_args_space = $6;
4034
91f72e9c
JP
4035# the $Declare variable will capture all spaces after the type
4036# so check it for a missing trailing missing space but pointer return types
4037# don't need a space so don't warn for those.
4038 my $post_declare_space = "";
4039 if ($declare =~ /(\s+)$/) {
4040 $post_declare_space = $1;
4041 $declare = rtrim($declare);
4042 }
4043 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
31070b5d
JP
4044 WARN("SPACING",
4045 "missing space after return type\n" . $herecurr);
91f72e9c 4046 $post_declare_space = " ";
31070b5d
JP
4047 }
4048
4049# unnecessary space "type (*funcptr)(args...)"
91f72e9c
JP
4050# This test is not currently implemented because these declarations are
4051# equivalent to
4052# int foo(int bar, ...)
4053# and this is form shouldn't/doesn't generate a checkpatch warning.
4054#
4055# elsif ($declare =~ /\s{2,}$/) {
4056# WARN("SPACING",
4057# "Multiple spaces after return type\n" . $herecurr);
4058# }
31070b5d
JP
4059
4060# unnecessary space "type ( *funcptr)(args...)"
4061 if (defined $pre_pointer_space &&
4062 $pre_pointer_space =~ /^\s/) {
4063 WARN("SPACING",
4064 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4065 }
4066
4067# unnecessary space "type (* funcptr)(args...)"
4068 if (defined $post_pointer_space &&
4069 $post_pointer_space =~ /^\s/) {
4070 WARN("SPACING",
4071 "Unnecessary space before function pointer name\n" . $herecurr);
4072 }
4073
4074# unnecessary space "type (*funcptr )(args...)"
4075 if (defined $post_funcname_space &&
4076 $post_funcname_space =~ /^\s/) {
4077 WARN("SPACING",
4078 "Unnecessary space after function pointer name\n" . $herecurr);
4079 }
4080
4081# unnecessary space "type (*funcptr) (args...)"
4082 if (defined $pre_args_space &&
4083 $pre_args_space =~ /^\s/) {
4084 WARN("SPACING",
4085 "Unnecessary space before function pointer arguments\n" . $herecurr);
4086 }
4087
4088 if (show_type("SPACING") && $fix) {
194f66fc 4089 $fixed[$fixlinenr] =~
91f72e9c 4090 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
31070b5d
JP
4091 }
4092 }
4093
8d31cfce
AW
4094# check for spacing round square brackets; allowed:
4095# 1. with a type on the left -- int [] a;
fe2a7dbc
AW
4096# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4097# 3. inside a curly brace -- = { [0...10] = 5 }
8d31cfce
AW
4098 while ($line =~ /(.*?\s)\[/g) {
4099 my ($where, $prefix) = ($-[1], $1);
4100 if ($prefix !~ /$Type\s+$/ &&
fe2a7dbc 4101 ($where != 0 || $prefix !~ /^.\s+$/) &&
38dca988 4102 $prefix !~ /[{,:]\s+$/) {
3705ce5b
JP
4103 if (ERROR("BRACKET_SPACE",
4104 "space prohibited before open square bracket '['\n" . $herecurr) &&
4105 $fix) {
194f66fc 4106 $fixed[$fixlinenr] =~
3705ce5b
JP
4107 s/^(\+.*?)\s+\[/$1\[/;
4108 }
8d31cfce
AW
4109 }
4110 }
4111
f0a594c1 4112# check for spaces between functions and their parentheses.
6c72ffaa 4113 while ($line =~ /($Ident)\s+\(/g) {
c2fdda0d 4114 my $name = $1;
773647a0
AW
4115 my $ctx_before = substr($line, 0, $-[1]);
4116 my $ctx = "$ctx_before$name";
c2fdda0d
AW
4117
4118 # Ignore those directives where spaces _are_ permitted.
773647a0
AW
4119 if ($name =~ /^(?:
4120 if|for|while|switch|return|case|
4121 volatile|__volatile__|
4122 __attribute__|format|__extension__|
4123 asm|__asm__)$/x)
4124 {
c2fdda0d
AW
4125 # cpp #define statements have non-optional spaces, ie
4126 # if there is a space between the name and the open
4127 # parenthesis it is simply not a parameter group.
c45dcabd 4128 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
773647a0
AW
4129
4130 # cpp #elif statement condition may start with a (
c45dcabd 4131 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
c2fdda0d
AW
4132
4133 # If this whole things ends with a type its most
4134 # likely a typedef for a function.
773647a0 4135 } elsif ($ctx =~ /$Type$/) {
c2fdda0d
AW
4136
4137 } else {
3705ce5b
JP
4138 if (WARN("SPACING",
4139 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4140 $fix) {
194f66fc 4141 $fixed[$fixlinenr] =~
3705ce5b
JP
4142 s/\b$name\s+\(/$name\(/;
4143 }
6c72ffaa 4144 }
f0a594c1 4145 }
9a4cad4e 4146
653d4876 4147# Check operator spacing.
0a920b5b 4148 if (!($line=~/\#\s*include/)) {
3705ce5b
JP
4149 my $fixed_line = "";
4150 my $line_fixed = 0;
4151
9c0ca6f9
AW
4152 my $ops = qr{
4153 <<=|>>=|<=|>=|==|!=|
4154 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4155 =>|->|<<|>>|<|>|=|!|~|
1f65f947 4156 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
84731623 4157 \?:|\?|:
9c0ca6f9 4158 }x;
cf655043 4159 my @elements = split(/($ops|;)/, $opline);
3705ce5b
JP
4160
4161## print("element count: <" . $#elements . ">\n");
4162## foreach my $el (@elements) {
4163## print("el: <$el>\n");
4164## }
4165
4166 my @fix_elements = ();
00df344f 4167 my $off = 0;
6c72ffaa 4168
3705ce5b
JP
4169 foreach my $el (@elements) {
4170 push(@fix_elements, substr($rawline, $off, length($el)));
4171 $off += length($el);
4172 }
4173
4174 $off = 0;
4175
6c72ffaa 4176 my $blank = copy_spacing($opline);
b34c648b 4177 my $last_after = -1;
6c72ffaa 4178
0a920b5b 4179 for (my $n = 0; $n < $#elements; $n += 2) {
3705ce5b
JP
4180
4181 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4182
4183## print("n: <$n> good: <$good>\n");
4184
4a0df2ef
AW
4185 $off += length($elements[$n]);
4186
25985edc 4187 # Pick up the preceding and succeeding characters.
773647a0
AW
4188 my $ca = substr($opline, 0, $off);
4189 my $cc = '';
4190 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4191 $cc = substr($opline, $off + length($elements[$n + 1]));
4192 }
4193 my $cb = "$ca$;$cc";
4194
4a0df2ef
AW
4195 my $a = '';
4196 $a = 'V' if ($elements[$n] ne '');
4197 $a = 'W' if ($elements[$n] =~ /\s$/);
cf655043 4198 $a = 'C' if ($elements[$n] =~ /$;$/);
4a0df2ef
AW
4199 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4200 $a = 'O' if ($elements[$n] eq '');
773647a0 4201 $a = 'E' if ($ca =~ /^\s*$/);
4a0df2ef 4202
0a920b5b 4203 my $op = $elements[$n + 1];
4a0df2ef
AW
4204
4205 my $c = '';
0a920b5b 4206 if (defined $elements[$n + 2]) {
4a0df2ef
AW
4207 $c = 'V' if ($elements[$n + 2] ne '');
4208 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
cf655043 4209 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
4a0df2ef
AW
4210 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4211 $c = 'O' if ($elements[$n + 2] eq '');
8b1b3378 4212 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
4a0df2ef
AW
4213 } else {
4214 $c = 'E';
0a920b5b
AW
4215 }
4216
4a0df2ef
AW
4217 my $ctx = "${a}x${c}";
4218
4219 my $at = "(ctx:$ctx)";
4220
6c72ffaa 4221 my $ptr = substr($blank, 0, $off) . "^";
de7d4f0e 4222 my $hereptr = "$hereline$ptr\n";
0a920b5b 4223
74048ed8 4224 # Pull out the value of this operator.
6c72ffaa 4225 my $op_type = substr($curr_values, $off + 1, 1);
0a920b5b 4226
1f65f947
AW
4227 # Get the full operator variant.
4228 my $opv = $op . substr($curr_vars, $off, 1);
4229
13214adf
AW
4230 # Ignore operators passed as parameters.
4231 if ($op_type ne 'V' &&
d7fe8065 4232 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
13214adf 4233
cf655043
AW
4234# # Ignore comments
4235# } elsif ($op =~ /^$;+$/) {
13214adf 4236
d8aaf121 4237 # ; should have either the end of line or a space or \ after it
13214adf 4238 } elsif ($op eq ';') {
cf655043
AW
4239 if ($ctx !~ /.x[WEBC]/ &&
4240 $cc !~ /^\\/ && $cc !~ /^;/) {
3705ce5b
JP
4241 if (ERROR("SPACING",
4242 "space required after that '$op' $at\n" . $hereptr)) {
b34c648b 4243 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3705ce5b
JP
4244 $line_fixed = 1;
4245 }
d8aaf121
AW
4246 }
4247
4248 # // is a comment
4249 } elsif ($op eq '//') {
0a920b5b 4250
b00e4814
JP
4251 # : when part of a bitfield
4252 } elsif ($opv eq ':B') {
4253 # skip the bitfield test for now
4254
1f65f947
AW
4255 # No spaces for:
4256 # ->
b00e4814 4257 } elsif ($op eq '->') {
4a0df2ef 4258 if ($ctx =~ /Wx.|.xW/) {
3705ce5b
JP
4259 if (ERROR("SPACING",
4260 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
b34c648b 4261 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3705ce5b
JP
4262 if (defined $fix_elements[$n + 2]) {
4263 $fix_elements[$n + 2] =~ s/^\s+//;
4264 }
b34c648b 4265 $line_fixed = 1;
3705ce5b 4266 }
0a920b5b
AW
4267 }
4268
2381097b 4269 # , must not have a space before and must have a space on the right.
0a920b5b 4270 } elsif ($op eq ',') {
2381097b
JP
4271 my $rtrim_before = 0;
4272 my $space_after = 0;
4273 if ($ctx =~ /Wx./) {
4274 if (ERROR("SPACING",
4275 "space prohibited before that '$op' $at\n" . $hereptr)) {
4276 $line_fixed = 1;
4277 $rtrim_before = 1;
4278 }
4279 }
cf655043 4280 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
3705ce5b
JP
4281 if (ERROR("SPACING",
4282 "space required after that '$op' $at\n" . $hereptr)) {
3705ce5b 4283 $line_fixed = 1;
b34c648b 4284 $last_after = $n;
2381097b
JP
4285 $space_after = 1;
4286 }
4287 }
4288 if ($rtrim_before || $space_after) {
4289 if ($rtrim_before) {
4290 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4291 } else {
4292 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4293 }
4294 if ($space_after) {
4295 $good .= " ";
3705ce5b 4296 }
0a920b5b
AW
4297 }
4298
9c0ca6f9 4299 # '*' as part of a type definition -- reported already.
74048ed8 4300 } elsif ($opv eq '*_') {
9c0ca6f9
AW
4301 #warn "'*' is part of type\n";
4302
4303 # unary operators should have a space before and
4304 # none after. May be left adjacent to another
4305 # unary operator, or a cast
4306 } elsif ($op eq '!' || $op eq '~' ||
74048ed8 4307 $opv eq '*U' || $opv eq '-U' ||
0d413866 4308 $opv eq '&U' || $opv eq '&&U') {
cf655043 4309 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
3705ce5b
JP
4310 if (ERROR("SPACING",
4311 "space required before that '$op' $at\n" . $hereptr)) {
b34c648b
JP
4312 if ($n != $last_after + 2) {
4313 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4314 $line_fixed = 1;
4315 }
3705ce5b 4316 }
0a920b5b 4317 }
a3340b35 4318 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
171ae1a4
AW
4319 # A unary '*' may be const
4320
4321 } elsif ($ctx =~ /.xW/) {
3705ce5b
JP
4322 if (ERROR("SPACING",
4323 "space prohibited after that '$op' $at\n" . $hereptr)) {
b34c648b 4324 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
3705ce5b
JP
4325 if (defined $fix_elements[$n + 2]) {
4326 $fix_elements[$n + 2] =~ s/^\s+//;
4327 }
b34c648b 4328 $line_fixed = 1;
3705ce5b 4329 }
0a920b5b
AW
4330 }
4331
4332 # unary ++ and unary -- are allowed no space on one side.
4333 } elsif ($op eq '++' or $op eq '--') {
773647a0 4334 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
3705ce5b
JP
4335 if (ERROR("SPACING",
4336 "space required one side of that '$op' $at\n" . $hereptr)) {
b34c648b 4337 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3705ce5b
JP
4338 $line_fixed = 1;
4339 }
773647a0
AW
4340 }
4341 if ($ctx =~ /Wx[BE]/ ||
4342 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
3705ce5b
JP
4343 if (ERROR("SPACING",
4344 "space prohibited before that '$op' $at\n" . $hereptr)) {
b34c648b 4345 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3705ce5b
JP
4346 $line_fixed = 1;
4347 }
0a920b5b 4348 }
773647a0 4349 if ($ctx =~ /ExW/) {
3705ce5b
JP
4350 if (ERROR("SPACING",
4351 "space prohibited after that '$op' $at\n" . $hereptr)) {
b34c648b 4352 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3705ce5b
JP
4353 if (defined $fix_elements[$n + 2]) {
4354 $fix_elements[$n + 2] =~ s/^\s+//;
4355 }
b34c648b 4356 $line_fixed = 1;
3705ce5b 4357 }
653d4876 4358 }
0a920b5b 4359
0a920b5b 4360 # << and >> may either have or not have spaces both sides
9c0ca6f9
AW
4361 } elsif ($op eq '<<' or $op eq '>>' or
4362 $op eq '&' or $op eq '^' or $op eq '|' or
4363 $op eq '+' or $op eq '-' or
c2fdda0d
AW
4364 $op eq '*' or $op eq '/' or
4365 $op eq '%')
0a920b5b 4366 {
d2e025f3
JP
4367 if ($check) {
4368 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4369 if (CHK("SPACING",
4370 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4371 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4372 $fix_elements[$n + 2] =~ s/^\s+//;
4373 $line_fixed = 1;
4374 }
4375 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4376 if (CHK("SPACING",
4377 "space preferred before that '$op' $at\n" . $hereptr)) {
4378 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4379 $line_fixed = 1;
4380 }
4381 }
4382 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
3705ce5b
JP
4383 if (ERROR("SPACING",
4384 "need consistent spacing around '$op' $at\n" . $hereptr)) {
b34c648b
JP
4385 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4386 if (defined $fix_elements[$n + 2]) {
4387 $fix_elements[$n + 2] =~ s/^\s+//;
4388 }
3705ce5b
JP
4389 $line_fixed = 1;
4390 }
0a920b5b
AW
4391 }
4392
1f65f947
AW
4393 # A colon needs no spaces before when it is
4394 # terminating a case value or a label.
4395 } elsif ($opv eq ':C' || $opv eq ':L') {
4396 if ($ctx =~ /Wx./) {
3705ce5b
JP
4397 if (ERROR("SPACING",
4398 "space prohibited before that '$op' $at\n" . $hereptr)) {
b34c648b 4399 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3705ce5b
JP
4400 $line_fixed = 1;
4401 }
1f65f947
AW
4402 }
4403
0a920b5b 4404 # All the others need spaces both sides.
cf655043 4405 } elsif ($ctx !~ /[EWC]x[CWE]/) {
1f65f947
AW
4406 my $ok = 0;
4407
22f2a2ef 4408 # Ignore email addresses <foo@bar>
1f65f947
AW
4409 if (($op eq '<' &&
4410 $cc =~ /^\S+\@\S+>/) ||
4411 ($op eq '>' &&
4412 $ca =~ /<\S+\@\S+$/))
4413 {
4414 $ok = 1;
4415 }
4416
e0df7e1f
JP
4417 # for asm volatile statements
4418 # ignore a colon with another
4419 # colon immediately before or after
4420 if (($op eq ':') &&
4421 ($ca =~ /:$/ || $cc =~ /^:/)) {
4422 $ok = 1;
4423 }
4424
84731623 4425 # messages are ERROR, but ?: are CHK
1f65f947 4426 if ($ok == 0) {
0675a8fb
JD
4427 my $msg_level = \&ERROR;
4428 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
84731623 4429
0675a8fb
JD
4430 if (&{$msg_level}("SPACING",
4431 "spaces required around that '$op' $at\n" . $hereptr)) {
b34c648b
JP
4432 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4433 if (defined $fix_elements[$n + 2]) {
4434 $fix_elements[$n + 2] =~ s/^\s+//;
4435 }
3705ce5b
JP
4436 $line_fixed = 1;
4437 }
22f2a2ef 4438 }
0a920b5b 4439 }
4a0df2ef 4440 $off += length($elements[$n + 1]);
3705ce5b
JP
4441
4442## print("n: <$n> GOOD: <$good>\n");
4443
4444 $fixed_line = $fixed_line . $good;
4445 }
4446
4447 if (($#elements % 2) == 0) {
4448 $fixed_line = $fixed_line . $fix_elements[$#elements];
0a920b5b 4449 }
3705ce5b 4450
194f66fc
JP
4451 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4452 $fixed[$fixlinenr] = $fixed_line;
3705ce5b
JP
4453 }
4454
4455
0a920b5b
AW
4456 }
4457
786b6326 4458# check for whitespace before a non-naked semicolon
d2e248e7 4459 if ($line =~ /^\+.*\S\s+;\s*$/) {
786b6326
JP
4460 if (WARN("SPACING",
4461 "space prohibited before semicolon\n" . $herecurr) &&
4462 $fix) {
194f66fc 4463 1 while $fixed[$fixlinenr] =~
786b6326
JP
4464 s/^(\+.*\S)\s+;/$1;/;
4465 }
4466 }
4467
f0a594c1
AW
4468# check for multiple assignments
4469 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
000d1cc1
JP
4470 CHK("MULTIPLE_ASSIGNMENTS",
4471 "multiple assignments should be avoided\n" . $herecurr);
f0a594c1
AW
4472 }
4473
22f2a2ef
AW
4474## # check for multiple declarations, allowing for a function declaration
4475## # continuation.
4476## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4477## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4478##
4479## # Remove any bracketed sections to ensure we do not
4480## # falsly report the parameters of functions.
4481## my $ln = $line;
4482## while ($ln =~ s/\([^\(\)]*\)//g) {
4483## }
4484## if ($ln =~ /,/) {
000d1cc1
JP
4485## WARN("MULTIPLE_DECLARATION",
4486## "declaring multiple variables together should be avoided\n" . $herecurr);
22f2a2ef
AW
4487## }
4488## }
f0a594c1 4489
0a920b5b 4490#need space before brace following if, while, etc
6b8c69e4 4491 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
4e5d56bd 4492 $line =~ /do\{/) {
3705ce5b
JP
4493 if (ERROR("SPACING",
4494 "space required before the open brace '{'\n" . $herecurr) &&
4495 $fix) {
8d81ae05 4496 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\)))\{/$1 {/;
3705ce5b 4497 }
de7d4f0e
AW
4498 }
4499
c4a62ef9
JP
4500## # check for blank lines before declarations
4501## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4502## $prevrawline =~ /^.\s*$/) {
4503## WARN("SPACING",
4504## "No blank lines before declarations\n" . $hereprev);
4505## }
4506##
4507
de7d4f0e
AW
4508# closing brace should have a space following it when it has anything
4509# on the line
4510 if ($line =~ /}(?!(?:,|;|\)))\S/) {
d5e616fc
JP
4511 if (ERROR("SPACING",
4512 "space required after that close brace '}'\n" . $herecurr) &&
4513 $fix) {
194f66fc 4514 $fixed[$fixlinenr] =~
d5e616fc
JP
4515 s/}((?!(?:,|;|\)))\S)/} $1/;
4516 }
0a920b5b
AW
4517 }
4518
22f2a2ef
AW
4519# check spacing on square brackets
4520 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
3705ce5b
JP
4521 if (ERROR("SPACING",
4522 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4523 $fix) {
194f66fc 4524 $fixed[$fixlinenr] =~
3705ce5b
JP
4525 s/\[\s+/\[/;
4526 }
22f2a2ef
AW
4527 }
4528 if ($line =~ /\s\]/) {
3705ce5b
JP
4529 if (ERROR("SPACING",
4530 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4531 $fix) {
194f66fc 4532 $fixed[$fixlinenr] =~
3705ce5b
JP
4533 s/\s+\]/\]/;
4534 }
22f2a2ef
AW
4535 }
4536
c45dcabd 4537# check spacing on parentheses
9c0ca6f9
AW
4538 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4539 $line !~ /for\s*\(\s+;/) {
3705ce5b
JP
4540 if (ERROR("SPACING",
4541 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4542 $fix) {
194f66fc 4543 $fixed[$fixlinenr] =~
3705ce5b
JP
4544 s/\(\s+/\(/;
4545 }
22f2a2ef 4546 }
13214adf 4547 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
c45dcabd
AW
4548 $line !~ /for\s*\(.*;\s+\)/ &&
4549 $line !~ /:\s+\)/) {
3705ce5b
JP
4550 if (ERROR("SPACING",
4551 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4552 $fix) {
194f66fc 4553 $fixed[$fixlinenr] =~
3705ce5b
JP
4554 s/\s+\)/\)/;
4555 }
22f2a2ef
AW
4556 }
4557
e2826fd0
JP
4558# check unnecessary parentheses around addressof/dereference single $Lvals
4559# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4560
4561 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
ea4acbb1
JP
4562 my $var = $1;
4563 if (CHK("UNNECESSARY_PARENTHESES",
4564 "Unnecessary parentheses around $var\n" . $herecurr) &&
4565 $fix) {
4566 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4567 }
4568 }
4569
4570# check for unnecessary parentheses around function pointer uses
4571# ie: (foo->bar)(); should be foo->bar();
4572# but not "if (foo->bar) (" to avoid some false positives
4573 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4574 my $var = $2;
4575 if (CHK("UNNECESSARY_PARENTHESES",
4576 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4577 $fix) {
4578 my $var2 = deparenthesize($var);
4579 $var2 =~ s/\s//g;
4580 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4581 }
4582 }
e2826fd0 4583
63b7c73e 4584# check for unnecessary parentheses around comparisons in if uses
a032aa4c
JP
4585# when !drivers/staging or command-line uses --strict
4586 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
4587 $^V && $^V ge 5.10.0 && defined($stat) &&
63b7c73e
JP
4588 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4589 my $if_stat = $1;
4590 my $test = substr($2, 1, -1);
4591 my $herectx;
4592 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4593 my $match = $1;
4594 # avoid parentheses around potential macro args
4595 next if ($match =~ /^\s*\w+\s*$/);
4596 if (!defined($herectx)) {
4597 $herectx = $here . "\n";
4598 my $cnt = statement_rawlines($if_stat);
4599 for (my $n = 0; $n < $cnt; $n++) {
4600 my $rl = raw_line($linenr, $n);
4601 $herectx .= $rl . "\n";
4602 last if $rl =~ /^[ \+].*\{/;
4603 }
4604 }
4605 CHK("UNNECESSARY_PARENTHESES",
4606 "Unnecessary parentheses around '$match'\n" . $herectx);
4607 }
4608 }
4609
0a920b5b 4610#goto labels aren't indented, allow a single space however
4a0df2ef 4611 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
0a920b5b 4612 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
3705ce5b
JP
4613 if (WARN("INDENTED_LABEL",
4614 "labels should not be indented\n" . $herecurr) &&
4615 $fix) {
194f66fc 4616 $fixed[$fixlinenr] =~
3705ce5b
JP
4617 s/^(.)\s+/$1/;
4618 }
0a920b5b
AW
4619 }
4620
5b9553ab 4621# return is not a function
507e5141 4622 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
c45dcabd 4623 my $spacing = $1;
507e5141 4624 if ($^V && $^V ge 5.10.0 &&
5b9553ab
JP
4625 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4626 my $value = $1;
4627 $value = deparenthesize($value);
4628 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4629 ERROR("RETURN_PARENTHESES",
4630 "return is not a function, parentheses are not required\n" . $herecurr);
4631 }
c45dcabd 4632 } elsif ($spacing !~ /\s+/) {
000d1cc1
JP
4633 ERROR("SPACING",
4634 "space required before the open parenthesis '('\n" . $herecurr);
c45dcabd
AW
4635 }
4636 }
507e5141 4637
b43ae21b
JP
4638# unnecessary return in a void function
4639# at end-of-function, with the previous line a single leading tab, then return;
4640# and the line before that not a goto label target like "out:"
4641 if ($sline =~ /^[ \+]}\s*$/ &&
4642 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4643 $linenr >= 3 &&
4644 $lines[$linenr - 3] =~ /^[ +]/ &&
4645 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
9819cf25 4646 WARN("RETURN_VOID",
b43ae21b
JP
4647 "void function return statements are not generally useful\n" . $hereprev);
4648 }
9819cf25 4649
189248d8
JP
4650# if statements using unnecessary parentheses - ie: if ((foo == bar))
4651 if ($^V && $^V ge 5.10.0 &&
4652 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4653 my $openparens = $1;
4654 my $count = $openparens =~ tr@\(@\(@;
4655 my $msg = "";
4656 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4657 my $comp = $4; #Not $1 because of $LvalOrFunc
4658 $msg = " - maybe == should be = ?" if ($comp eq "==");
4659 WARN("UNNECESSARY_PARENTHESES",
4660 "Unnecessary parentheses$msg\n" . $herecurr);
4661 }
4662 }
4663
c5595fa2
JP
4664# comparisons with a constant or upper case identifier on the left
4665# avoid cases like "foo + BAR < baz"
4666# only fix matches surrounded by parentheses to avoid incorrect
4667# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4668 if ($^V && $^V ge 5.10.0 &&
4669 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4670 my $lead = $1;
4671 my $const = $2;
4672 my $comp = $3;
4673 my $to = $4;
4674 my $newcomp = $comp;
f39e1769 4675 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
c5595fa2
JP
4676 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4677 WARN("CONSTANT_COMPARISON",
4678 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4679 $fix) {
4680 if ($comp eq "<") {
4681 $newcomp = ">";
4682 } elsif ($comp eq "<=") {
4683 $newcomp = ">=";
4684 } elsif ($comp eq ">") {
4685 $newcomp = "<";
4686 } elsif ($comp eq ">=") {
4687 $newcomp = "<=";
4688 }
4689 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4690 }
4691 }
4692
f34e4a4f
JP
4693# Return of what appears to be an errno should normally be negative
4694 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
53a3c448
AW
4695 my $name = $1;
4696 if ($name ne 'EOF' && $name ne 'ERROR') {
000d1cc1 4697 WARN("USE_NEGATIVE_ERRNO",
f34e4a4f 4698 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
53a3c448
AW
4699 }
4700 }
c45dcabd 4701
0a920b5b 4702# Need a space before open parenthesis after if, while etc
3705ce5b
JP
4703 if ($line =~ /\b(if|while|for|switch)\(/) {
4704 if (ERROR("SPACING",
4705 "space required before the open parenthesis '('\n" . $herecurr) &&
4706 $fix) {
194f66fc 4707 $fixed[$fixlinenr] =~
3705ce5b
JP
4708 s/\b(if|while|for|switch)\(/$1 \(/;
4709 }
0a920b5b
AW
4710 }
4711
f5fe35dd
AW
4712# Check for illegal assignment in if conditional -- and check for trailing
4713# statements after the conditional.
170d3a22 4714 if ($line =~ /do\s*(?!{)/) {
3e469cdc
AW
4715 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4716 ctx_statement_block($linenr, $realcnt, 0)
4717 if (!defined $stat);
170d3a22
AW
4718 my ($stat_next) = ctx_statement_block($line_nr_next,
4719 $remain_next, $off_next);
4720 $stat_next =~ s/\n./\n /g;
4721 ##print "stat<$stat> stat_next<$stat_next>\n";
4722
4723 if ($stat_next =~ /^\s*while\b/) {
4724 # If the statement carries leading newlines,
4725 # then count those as offsets.
4726 my ($whitespace) =
4727 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4728 my $offset =
4729 statement_rawlines($whitespace) - 1;
4730
4731 $suppress_whiletrailers{$line_nr_next +
4732 $offset} = 1;
4733 }
4734 }
4735 if (!defined $suppress_whiletrailers{$linenr} &&
c11230f4 4736 defined($stat) && defined($cond) &&
170d3a22 4737 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
171ae1a4 4738 my ($s, $c) = ($stat, $cond);
8905a67c 4739
b53c8e10 4740 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
000d1cc1
JP
4741 ERROR("ASSIGN_IN_IF",
4742 "do not use assignment in if condition\n" . $herecurr);
8905a67c
AW
4743 }
4744
4745 # Find out what is on the end of the line after the
4746 # conditional.
773647a0 4747 substr($s, 0, length($c), '');
8905a67c 4748 $s =~ s/\n.*//g;
13214adf 4749 $s =~ s/$;//g; # Remove any comments
53210168
AW
4750 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4751 $c !~ /}\s*while\s*/)
773647a0 4752 {
bb44ad39
AW
4753 # Find out how long the conditional actually is.
4754 my @newlines = ($c =~ /\n/gs);
4755 my $cond_lines = 1 + $#newlines;
42bdf74c 4756 my $stat_real = '';
bb44ad39 4757
42bdf74c
HS
4758 $stat_real = raw_line($linenr, $cond_lines)
4759 . "\n" if ($cond_lines);
bb44ad39
AW
4760 if (defined($stat_real) && $cond_lines > 1) {
4761 $stat_real = "[...]\n$stat_real";
4762 }
4763
000d1cc1
JP
4764 ERROR("TRAILING_STATEMENTS",
4765 "trailing statements should be on next line\n" . $herecurr . $stat_real);
8905a67c
AW
4766 }
4767 }
4768
13214adf
AW
4769# Check for bitwise tests written as boolean
4770 if ($line =~ /
4771 (?:
4772 (?:\[|\(|\&\&|\|\|)
4773 \s*0[xX][0-9]+\s*
4774 (?:\&\&|\|\|)
4775 |
4776 (?:\&\&|\|\|)
4777 \s*0[xX][0-9]+\s*
4778 (?:\&\&|\|\||\)|\])
4779 )/x)
4780 {
000d1cc1
JP
4781 WARN("HEXADECIMAL_BOOLEAN_TEST",
4782 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
13214adf
AW
4783 }
4784
8905a67c 4785# if and else should not have general statements after it
13214adf
AW
4786 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4787 my $s = $1;
4788 $s =~ s/$;//g; # Remove any comments
4789 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
000d1cc1
JP
4790 ERROR("TRAILING_STATEMENTS",
4791 "trailing statements should be on next line\n" . $herecurr);
13214adf 4792 }
0a920b5b 4793 }
39667782
AW
4794# if should not continue a brace
4795 if ($line =~ /}\s*if\b/) {
000d1cc1 4796 ERROR("TRAILING_STATEMENTS",
048b123f 4797 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
39667782
AW
4798 $herecurr);
4799 }
a1080bf8
AW
4800# case and default should not have general statements after them
4801 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4802 $line !~ /\G(?:
3fef12d6 4803 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
a1080bf8
AW
4804 \s*return\s+
4805 )/xg)
4806 {
000d1cc1
JP
4807 ERROR("TRAILING_STATEMENTS",
4808 "trailing statements should be on next line\n" . $herecurr);
a1080bf8 4809 }
0a920b5b
AW
4810
4811 # Check for }<nl>else {, these must be at the same
4812 # indent level to be relevant to each other.
8b8856f4
JP
4813 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4814 $previndent == $indent) {
4815 if (ERROR("ELSE_AFTER_BRACE",
4816 "else should follow close brace '}'\n" . $hereprev) &&
4817 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4818 fix_delete_line($fixlinenr - 1, $prevrawline);
4819 fix_delete_line($fixlinenr, $rawline);
4820 my $fixedline = $prevrawline;
4821 $fixedline =~ s/}\s*$//;
4822 if ($fixedline !~ /^\+\s*$/) {
4823 fix_insert_line($fixlinenr, $fixedline);
4824 }
4825 $fixedline = $rawline;
4826 $fixedline =~ s/^(.\s*)else/$1} else/;
4827 fix_insert_line($fixlinenr, $fixedline);
4828 }
0a920b5b
AW
4829 }
4830
8b8856f4
JP
4831 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4832 $previndent == $indent) {
c2fdda0d
AW
4833 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4834
4835 # Find out what is on the end of the line after the
4836 # conditional.
773647a0 4837 substr($s, 0, length($c), '');
c2fdda0d
AW
4838 $s =~ s/\n.*//g;
4839
4840 if ($s =~ /^\s*;/) {
8b8856f4
JP
4841 if (ERROR("WHILE_AFTER_BRACE",
4842 "while should follow close brace '}'\n" . $hereprev) &&
4843 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4844 fix_delete_line($fixlinenr - 1, $prevrawline);
4845 fix_delete_line($fixlinenr, $rawline);
4846 my $fixedline = $prevrawline;
4847 my $trailing = $rawline;
4848 $trailing =~ s/^\+//;
4849 $trailing = trim($trailing);
4850 $fixedline =~ s/}\s*$/} $trailing/;
4851 fix_insert_line($fixlinenr, $fixedline);
4852 }
c2fdda0d
AW
4853 }
4854 }
4855
95e2c602 4856#Specific variable tests
323c1260
JP
4857 while ($line =~ m{($Constant|$Lval)}g) {
4858 my $var = $1;
95e2c602
JP
4859
4860#gcc binary extension
4861 if ($var =~ /^$Binary$/) {
d5e616fc
JP
4862 if (WARN("GCC_BINARY_CONSTANT",
4863 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4864 $fix) {
4865 my $hexval = sprintf("0x%x", oct($var));
194f66fc 4866 $fixed[$fixlinenr] =~
d5e616fc
JP
4867 s/\b$var\b/$hexval/;
4868 }
95e2c602
JP
4869 }
4870
4871#CamelCase
807bd26c 4872 if ($var !~ /^$Constant$/ &&
be79794b 4873 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
22735ce8 4874#Ignore Page<foo> variants
807bd26c 4875 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
22735ce8 4876#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
f5123576
JW
4877 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4878#Ignore some three character SI units explicitly, like MiB and KHz
4879 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
7e781f67
JP
4880 while ($var =~ m{($Ident)}g) {
4881 my $word = $1;
4882 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
d8b07710
JP
4883 if ($check) {
4884 seed_camelcase_includes();
4885 if (!$file && !$camelcase_file_seeded) {
4886 seed_camelcase_file($realfile);
4887 $camelcase_file_seeded = 1;
4888 }
4889 }
7e781f67
JP
4890 if (!defined $camelcase{$word}) {
4891 $camelcase{$word} = 1;
4892 CHK("CAMELCASE",
4893 "Avoid CamelCase: <$word>\n" . $herecurr);
4894 }
3445686a 4895 }
323c1260
JP
4896 }
4897 }
0a920b5b
AW
4898
4899#no spaces allowed after \ in define
d5e616fc
JP
4900 if ($line =~ /\#\s*define.*\\\s+$/) {
4901 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4902 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4903 $fix) {
194f66fc 4904 $fixed[$fixlinenr] =~ s/\s+$//;
d5e616fc 4905 }
0a920b5b
AW
4906 }
4907
0e212e0a
FF
4908# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4909# itself <asm/foo.h> (uses RAW line)
c45dcabd 4910 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
e09dec48
AW
4911 my $file = "$1.h";
4912 my $checkfile = "include/linux/$file";
4913 if (-f "$root/$checkfile" &&
4914 $realfile ne $checkfile &&
7840a94c 4915 $1 !~ /$allowed_asm_includes/)
c45dcabd 4916 {
0e212e0a
FF
4917 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4918 if ($asminclude > 0) {
4919 if ($realfile =~ m{^arch/}) {
4920 CHK("ARCH_INCLUDE_LINUX",
4921 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4922 } else {
4923 WARN("INCLUDE_LINUX",
4924 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4925 }
e09dec48 4926 }
0a920b5b
AW
4927 }
4928 }
4929
653d4876
AW
4930# multi-statement macros should be enclosed in a do while loop, grab the
4931# first statement and ensure its the whole macro if its not enclosed
cf655043 4932# in a known good container
b8f96a31
AW
4933 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4934 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
d8aaf121
AW
4935 my $ln = $linenr;
4936 my $cnt = $realcnt;
c45dcabd
AW
4937 my ($off, $dstat, $dcond, $rest);
4938 my $ctx = '';
08a2843e
JP
4939 my $has_flow_statement = 0;
4940 my $has_arg_concat = 0;
c45dcabd 4941 ($dstat, $dcond, $ln, $cnt, $off) =
f74bd194
AW
4942 ctx_statement_block($linenr, $realcnt, 0);
4943 $ctx = $dstat;
c45dcabd 4944 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
a3bb97a7 4945 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
c45dcabd 4946
08a2843e 4947 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
62e15a6d 4948 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
08a2843e 4949
f59b64bf
JP
4950 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
4951 my $define_args = $1;
4952 my $define_stmt = $dstat;
4953 my @def_args = ();
4954
4955 if (defined $define_args && $define_args ne "") {
4956 $define_args = substr($define_args, 1, length($define_args) - 2);
4957 $define_args =~ s/\s*//g;
4958 @def_args = split(",", $define_args);
4959 }
4960
292f1a9b 4961 $dstat =~ s/$;//g;
c45dcabd
AW
4962 $dstat =~ s/\\\n.//g;
4963 $dstat =~ s/^\s*//s;
4964 $dstat =~ s/\s*$//s;
de7d4f0e 4965
c45dcabd 4966 # Flatten any parentheses and braces
bf30d6ed
AW
4967 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4968 $dstat =~ s/\{[^\{\}]*\}/1/ ||
6b10df42 4969 $dstat =~ s/.\[[^\[\]]*\]/1/)
bf30d6ed 4970 {
de7d4f0e 4971 }
d8aaf121 4972
e45bab8e 4973 # Flatten any obvious string concatentation.
33acb54a
JP
4974 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4975 $dstat =~ s/$Ident\s*($String)/$1/)
e45bab8e
AW
4976 {
4977 }
4978
42e15293
JP
4979 # Make asm volatile uses seem like a generic function
4980 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4981
c45dcabd
AW
4982 my $exceptions = qr{
4983 $Declare|
4984 module_param_named|
a0a0a7a9 4985 MODULE_PARM_DESC|
c45dcabd
AW
4986 DECLARE_PER_CPU|
4987 DEFINE_PER_CPU|
383099fd 4988 __typeof__\(|
22fd2d3e
SS
4989 union|
4990 struct|
ea71a0a0 4991 \.$Ident\s*=\s*|
6b10df42
VZ
4992 ^\"|\"$|
4993 ^\[
c45dcabd 4994 }x;
5eaa20b9 4995 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
f59b64bf
JP
4996
4997 $ctx =~ s/\n*$//;
f59b64bf 4998 my $stmt_cnt = statement_rawlines($ctx);
e3d95a2a 4999 my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
f59b64bf 5000
f74bd194
AW
5001 if ($dstat ne '' &&
5002 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
5003 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
3cc4b1c3 5004 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
356fd398 5005 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
f74bd194
AW
5006 $dstat !~ /$exceptions/ &&
5007 $dstat !~ /^\.$Ident\s*=/ && # .foo =
e942e2c3 5008 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
72f115f9 5009 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
f74bd194
AW
5010 $dstat !~ /^for\s*$Constant$/ && # for (...)
5011 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
5012 $dstat !~ /^do\s*{/ && # do {...
4e5d56bd 5013 $dstat !~ /^\(\{/ && # ({...
f95a7e6a 5014 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
f74bd194 5015 {
e795556a
JP
5016 if ($dstat =~ /^\s*if\b/) {
5017 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5018 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5019 } elsif ($dstat =~ /;/) {
f74bd194
AW
5020 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5021 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5022 } else {
000d1cc1 5023 ERROR("COMPLEX_MACRO",
388982b5 5024 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
d8aaf121 5025 }
f59b64bf
JP
5026
5027 }
5207649b
JP
5028
5029 # Make $define_stmt single line, comment-free, etc
5030 my @stmt_array = split('\n', $define_stmt);
5031 my $first = 1;
5032 $define_stmt = "";
5033 foreach my $l (@stmt_array) {
5034 $l =~ s/\\$//;
5035 if ($first) {
5036 $define_stmt = $l;
5037 $first = 0;
5038 } elsif ($l =~ /^[\+ ]/) {
5039 $define_stmt .= substr($l, 1);
5040 }
5041 }
5042 $define_stmt =~ s/$;//g;
5043 $define_stmt =~ s/\s+/ /g;
5044 $define_stmt = trim($define_stmt);
5045
f59b64bf
JP
5046# check if any macro arguments are reused (ignore '...' and 'type')
5047 foreach my $arg (@def_args) {
5048 next if ($arg =~ /\.\.\./);
9192d41a 5049 next if ($arg =~ /^type$/i);
7fe528a2
JP
5050 my $tmp_stmt = $define_stmt;
5051 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5052 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5053 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
d41362ed 5054 my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
f59b64bf
JP
5055 if ($use_cnt > 1) {
5056 CHK("MACRO_ARG_REUSE",
5057 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
9192d41a
JP
5058 }
5059# check if any macro arguments may have other precedence issues
7fe528a2 5060 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
9192d41a
JP
5061 ((defined($1) && $1 ne ',') ||
5062 (defined($2) && $2 ne ','))) {
5063 CHK("MACRO_ARG_PRECEDENCE",
5064 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
f59b64bf 5065 }
653d4876 5066 }
5023d347 5067
08a2843e
JP
5068# check for macros with flow control, but without ## concatenation
5069# ## concatenation is commonly a macro that defines a function so ignore those
5070 if ($has_flow_statement && !$has_arg_concat) {
08a2843e 5071 my $cnt = statement_rawlines($ctx);
e3d95a2a 5072 my $herectx = get_stat_here($linenr, $cnt, $here);
08a2843e 5073
08a2843e
JP
5074 WARN("MACRO_WITH_FLOW_CONTROL",
5075 "Macros with flow control statements should be avoided\n" . "$herectx");
5076 }
5077
481eb486 5078# check for line continuations outside of #defines, preprocessor #, and asm
5023d347
JP
5079
5080 } else {
5081 if ($prevline !~ /^..*\\$/ &&
481eb486
JP
5082 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5083 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
5023d347
JP
5084 $line =~ /^\+.*\\$/) {
5085 WARN("LINE_CONTINUATIONS",
5086 "Avoid unnecessary line continuations\n" . $herecurr);
5087 }
0a920b5b
AW
5088 }
5089
b13edf7f
JP
5090# do {} while (0) macro tests:
5091# single-statement macros do not need to be enclosed in do while (0) loop,
5092# macro should not end with a semicolon
5093 if ($^V && $^V ge 5.10.0 &&
5094 $realfile !~ m@/vmlinux.lds.h$@ &&
5095 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5096 my $ln = $linenr;
5097 my $cnt = $realcnt;
5098 my ($off, $dstat, $dcond, $rest);
5099 my $ctx = '';
5100 ($dstat, $dcond, $ln, $cnt, $off) =
5101 ctx_statement_block($linenr, $realcnt, 0);
5102 $ctx = $dstat;
5103
5104 $dstat =~ s/\\\n.//g;
1b36b201 5105 $dstat =~ s/$;/ /g;
b13edf7f
JP
5106
5107 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5108 my $stmts = $2;
5109 my $semis = $3;
5110
5111 $ctx =~ s/\n*$//;
5112 my $cnt = statement_rawlines($ctx);
e3d95a2a 5113 my $herectx = get_stat_here($linenr, $cnt, $here);
b13edf7f 5114
ac8e97f8
JP
5115 if (($stmts =~ tr/;/;/) == 1 &&
5116 $stmts !~ /^\s*(if|while|for|switch)\b/) {
b13edf7f
JP
5117 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5118 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5119 }
5120 if (defined $semis && $semis ne "") {
5121 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5122 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5123 }
f5ef95b1
JP
5124 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5125 $ctx =~ s/\n*$//;
5126 my $cnt = statement_rawlines($ctx);
e3d95a2a 5127 my $herectx = get_stat_here($linenr, $cnt, $here);
f5ef95b1
JP
5128
5129 WARN("TRAILING_SEMICOLON",
5130 "macros should not use a trailing semicolon\n" . "$herectx");
b13edf7f
JP
5131 }
5132 }
5133
f0a594c1 5134# check for redundant bracing round if etc
13214adf
AW
5135 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5136 my ($level, $endln, @chunks) =
cf655043 5137 ctx_statement_full($linenr, $realcnt, 1);
13214adf 5138 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
cf655043
AW
5139 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5140 if ($#chunks > 0 && $level == 0) {
aad4f614
JP
5141 my @allowed = ();
5142 my $allow = 0;
13214adf 5143 my $seen = 0;
773647a0 5144 my $herectx = $here . "\n";
cf655043 5145 my $ln = $linenr - 1;
13214adf
AW
5146 for my $chunk (@chunks) {
5147 my ($cond, $block) = @{$chunk};
5148
773647a0
AW
5149 # If the condition carries leading newlines, then count those as offsets.
5150 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5151 my $offset = statement_rawlines($whitespace) - 1;
5152
aad4f614 5153 $allowed[$allow] = 0;
773647a0
AW
5154 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5155
5156 # We have looked at and allowed this specific line.
5157 $suppress_ifbraces{$ln + $offset} = 1;
5158
5159 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
cf655043
AW
5160 $ln += statement_rawlines($block) - 1;
5161
773647a0 5162 substr($block, 0, length($cond), '');
13214adf
AW
5163
5164 $seen++ if ($block =~ /^\s*{/);
5165
aad4f614 5166 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
cf655043
AW
5167 if (statement_lines($cond) > 1) {
5168 #print "APW: ALLOWED: cond<$cond>\n";
aad4f614 5169 $allowed[$allow] = 1;
13214adf
AW
5170 }
5171 if ($block =~/\b(?:if|for|while)\b/) {
cf655043 5172 #print "APW: ALLOWED: block<$block>\n";
aad4f614 5173 $allowed[$allow] = 1;
13214adf 5174 }
cf655043
AW
5175 if (statement_block_size($block) > 1) {
5176 #print "APW: ALLOWED: lines block<$block>\n";
aad4f614 5177 $allowed[$allow] = 1;
13214adf 5178 }
aad4f614 5179 $allow++;
13214adf 5180 }
aad4f614
JP
5181 if ($seen) {
5182 my $sum_allowed = 0;
5183 foreach (@allowed) {
5184 $sum_allowed += $_;
5185 }
5186 if ($sum_allowed == 0) {
5187 WARN("BRACES",
5188 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5189 } elsif ($sum_allowed != $allow &&
5190 $seen != $allow) {
5191 CHK("BRACES",
5192 "braces {} should be used on all arms of this statement\n" . $herectx);
5193 }
13214adf
AW
5194 }
5195 }
5196 }
773647a0 5197 if (!defined $suppress_ifbraces{$linenr - 1} &&
13214adf 5198 $line =~ /\b(if|while|for|else)\b/) {
cf655043
AW
5199 my $allowed = 0;
5200
5201 # Check the pre-context.
5202 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5203 #print "APW: ALLOWED: pre<$1>\n";
5204 $allowed = 1;
5205 }
773647a0
AW
5206
5207 my ($level, $endln, @chunks) =
5208 ctx_statement_full($linenr, $realcnt, $-[0]);
5209
cf655043
AW
5210 # Check the condition.
5211 my ($cond, $block) = @{$chunks[0]};
773647a0 5212 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
cf655043 5213 if (defined $cond) {
773647a0 5214 substr($block, 0, length($cond), '');
cf655043
AW
5215 }
5216 if (statement_lines($cond) > 1) {
5217 #print "APW: ALLOWED: cond<$cond>\n";
5218 $allowed = 1;
5219 }
5220 if ($block =~/\b(?:if|for|while)\b/) {
5221 #print "APW: ALLOWED: block<$block>\n";
5222 $allowed = 1;
5223 }
5224 if (statement_block_size($block) > 1) {
5225 #print "APW: ALLOWED: lines block<$block>\n";
5226 $allowed = 1;
5227 }
5228 # Check the post-context.
5229 if (defined $chunks[1]) {
5230 my ($cond, $block) = @{$chunks[1]};
5231 if (defined $cond) {
773647a0 5232 substr($block, 0, length($cond), '');
cf655043
AW
5233 }
5234 if ($block =~ /^\s*\{/) {
5235 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5236 $allowed = 1;
5237 }
5238 }
5239 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
f055663c 5240 my $cnt = statement_rawlines($block);
e3d95a2a 5241 my $herectx = get_stat_here($linenr, $cnt, $here);
cf655043 5242
000d1cc1
JP
5243 WARN("BRACES",
5244 "braces {} are not necessary for single statement blocks\n" . $herectx);
f0a594c1
AW
5245 }
5246 }
5247
e4c5babd 5248# check for single line unbalanced braces
95330473
SE
5249 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5250 $sline =~ /^.\s*else\s*\{\s*$/) {
e4c5babd
JP
5251 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5252 }
5253
0979ae66 5254# check for unnecessary blank lines around braces
77b9a53a 5255 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
f8e58219
JP
5256 if (CHK("BRACES",
5257 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5258 $fix && $prevrawline =~ /^\+/) {
5259 fix_delete_line($fixlinenr - 1, $prevrawline);
5260 }
0979ae66 5261 }
77b9a53a 5262 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
f8e58219
JP
5263 if (CHK("BRACES",
5264 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5265 $fix) {
5266 fix_delete_line($fixlinenr, $rawline);
5267 }
0979ae66
JP
5268 }
5269
4a0df2ef 5270# no volatiles please
6c72ffaa
AW
5271 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5272 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
000d1cc1 5273 WARN("VOLATILE",
8c27ceff 5274 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
4a0df2ef
AW
5275 }
5276
5e4f6ba5
JP
5277# Check for user-visible strings broken across lines, which breaks the ability
5278# to grep for the string. Make exceptions when the previous string ends in a
5279# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5280# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
33acb54a 5281 if ($line =~ /^\+\s*$String/ &&
5e4f6ba5
JP
5282 $prevline =~ /"\s*$/ &&
5283 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5284 if (WARN("SPLIT_STRING",
5285 "quoted string split across lines\n" . $hereprev) &&
5286 $fix &&
5287 $prevrawline =~ /^\+.*"\s*$/ &&
5288 $last_coalesced_string_linenr != $linenr - 1) {
5289 my $extracted_string = get_quoted_string($line, $rawline);
5290 my $comma_close = "";
5291 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5292 $comma_close = $1;
5293 }
5294
5295 fix_delete_line($fixlinenr - 1, $prevrawline);
5296 fix_delete_line($fixlinenr, $rawline);
5297 my $fixedline = $prevrawline;
5298 $fixedline =~ s/"\s*$//;
5299 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5300 fix_insert_line($fixlinenr - 1, $fixedline);
5301 $fixedline = $rawline;
5302 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5303 if ($fixedline !~ /\+\s*$/) {
5304 fix_insert_line($fixlinenr, $fixedline);
5305 }
5306 $last_coalesced_string_linenr = $linenr;
5307 }
5308 }
5309
5310# check for missing a space in a string concatenation
5311 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5312 WARN('MISSING_SPACE',
5313 "break quoted strings at a space character\n" . $hereprev);
5314 }
5315
e4b7d309
JP
5316# check for an embedded function name in a string when the function is known
5317# This does not work very well for -f --file checking as it depends on patch
5318# context providing the function name or a single line form for in-file
5319# function declarations
77cb8546
JP
5320 if ($line =~ /^\+.*$String/ &&
5321 defined($context_function) &&
e4b7d309
JP
5322 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5323 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
77cb8546 5324 WARN("EMBEDDED_FUNCTION_NAME",
e4b7d309 5325 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
77cb8546
JP
5326 }
5327
5e4f6ba5
JP
5328# check for spaces before a quoted newline
5329 if ($rawline =~ /^.*\".*\s\\n/) {
5330 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5331 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5332 $fix) {
5333 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5334 }
5335
5336 }
5337
f17dba4f 5338# concatenated string without spaces between elements
33acb54a 5339 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
f17dba4f
JP
5340 CHK("CONCATENATED_STRING",
5341 "Concatenated strings should use spaces between elements\n" . $herecurr);
5342 }
5343
90ad30e5 5344# uncoalesced string fragments
33acb54a 5345 if ($line =~ /$String\s*"/) {
90ad30e5
JP
5346 WARN("STRING_FRAGMENTS",
5347 "Consecutive strings are generally better as a single string\n" . $herecurr);
5348 }
5349
522b837c
AD
5350# check for non-standard and hex prefixed decimal printf formats
5351 my $show_L = 1; #don't show the same defect twice
5352 my $show_Z = 1;
5e4f6ba5 5353 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
522b837c 5354 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
5e4f6ba5 5355 $string =~ s/%%/__/g;
522b837c
AD
5356 # check for %L
5357 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
5e4f6ba5 5358 WARN("PRINTF_L",
522b837c
AD
5359 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5360 $show_L = 0;
5361 }
5362 # check for %Z
5363 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5364 WARN("PRINTF_Z",
5365 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5366 $show_Z = 0;
5367 }
5368 # check for 0x<decimal>
5369 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5370 ERROR("PRINTF_0XDECIMAL",
6e300757
JP
5371 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5372 }
5e4f6ba5
JP
5373 }
5374
5375# check for line continuations in quoted strings with odd counts of "
3f7f335d 5376 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
5e4f6ba5
JP
5377 WARN("LINE_CONTINUATIONS",
5378 "Avoid line continuations in quoted strings\n" . $herecurr);
5379 }
5380
00df344f 5381# warn about #if 0
c45dcabd 5382 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
000d1cc1
JP
5383 CHK("REDUNDANT_CODE",
5384 "if this code is redundant consider removing it\n" .
de7d4f0e 5385 $herecurr);
4a0df2ef
AW
5386 }
5387
03df4b51
AW
5388# check for needless "if (<foo>) fn(<foo>)" uses
5389 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
100425de
JP
5390 my $tested = quotemeta($1);
5391 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5392 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5393 my $func = $1;
5394 if (WARN('NEEDLESS_IF',
5395 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5396 $fix) {
5397 my $do_fix = 1;
5398 my $leading_tabs = "";
5399 my $new_leading_tabs = "";
5400 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5401 $leading_tabs = $1;
5402 } else {
5403 $do_fix = 0;
5404 }
5405 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5406 $new_leading_tabs = $1;
5407 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5408 $do_fix = 0;
5409 }
5410 } else {
5411 $do_fix = 0;
5412 }
5413 if ($do_fix) {
5414 fix_delete_line($fixlinenr - 1, $prevrawline);
5415 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5416 }
5417 }
4c432a8f
GKH
5418 }
5419 }
f0a594c1 5420
ebfdc409
JP
5421# check for unnecessary "Out of Memory" messages
5422 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5423 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5424 (defined $1 || defined $3) &&
5425 $linenr > 3) {
5426 my $testval = $2;
5427 my $testline = $lines[$linenr - 3];
5428
5429 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5430# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5431
fb0d0e08 5432 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|kmemdup|(?:dev_)?alloc_skb)/) {
ebfdc409
JP
5433 WARN("OOM_MESSAGE",
5434 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5435 }
5436 }
5437
f78d98f6 5438# check for logging functions with KERN_<LEVEL>
dcaf1123 5439 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
f78d98f6
JP
5440 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5441 my $level = $1;
5442 if (WARN("UNNECESSARY_KERN_LEVEL",
5443 "Possible unnecessary $level\n" . $herecurr) &&
5444 $fix) {
5445 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5446 }
5447 }
5448
45c55e92
JP
5449# check for logging continuations
5450 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5451 WARN("LOGGING_CONTINUATION",
5452 "Avoid logging continuation uses where feasible\n" . $herecurr);
5453 }
5454
abb08a53
JP
5455# check for mask then right shift without a parentheses
5456 if ($^V && $^V ge 5.10.0 &&
5457 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5458 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5459 WARN("MASK_THEN_SHIFT",
5460 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5461 }
5462
b75ac618
JP
5463# check for pointer comparisons to NULL
5464 if ($^V && $^V ge 5.10.0) {
5465 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5466 my $val = $1;
5467 my $equal = "!";
5468 $equal = "" if ($4 eq "!=");
5469 if (CHK("COMPARISON_TO_NULL",
5470 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5471 $fix) {
5472 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5473 }
5474 }
5475 }
5476
8716de38
JP
5477# check for bad placement of section $InitAttribute (e.g.: __initdata)
5478 if ($line =~ /(\b$InitAttribute\b)/) {
5479 my $attr = $1;
5480 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5481 my $ptr = $1;
5482 my $var = $2;
5483 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5484 ERROR("MISPLACED_INIT",
5485 "$attr should be placed after $var\n" . $herecurr)) ||
5486 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5487 WARN("MISPLACED_INIT",
5488 "$attr should be placed after $var\n" . $herecurr))) &&
5489 $fix) {
194f66fc 5490 $fixed[$fixlinenr] =~ s/(\bstatic\s+(?:const\s+)?)(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*([=;])\s*/"$1" . trim(string_find_replace($2, "\\s*$attr\\s*", " ")) . " " . trim(string_find_replace($3, "\\s*$attr\\s*", "")) . " $attr" . ("$4" eq ";" ? ";" : " = ")/e;
8716de38
JP
5491 }
5492 }
5493 }
5494
e970b884
JP
5495# check for $InitAttributeData (ie: __initdata) with const
5496 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5497 my $attr = $1;
5498 $attr =~ /($InitAttributePrefix)(.*)/;
5499 my $attr_prefix = $1;
5500 my $attr_type = $2;
5501 if (ERROR("INIT_ATTRIBUTE",
5502 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5503 $fix) {
194f66fc 5504 $fixed[$fixlinenr] =~
e970b884
JP
5505 s/$InitAttributeData/${attr_prefix}initconst/;
5506 }
5507 }
5508
5509# check for $InitAttributeConst (ie: __initconst) without const
5510 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5511 my $attr = $1;
5512 if (ERROR("INIT_ATTRIBUTE",
5513 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5514 $fix) {
194f66fc 5515 my $lead = $fixed[$fixlinenr] =~
e970b884
JP
5516 /(^\+\s*(?:static\s+))/;
5517 $lead = rtrim($1);
5518 $lead = "$lead " if ($lead !~ /^\+$/);
5519 $lead = "${lead}const ";
194f66fc 5520 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
e970b884
JP
5521 }
5522 }
5523
c17893c7
JP
5524# check for __read_mostly with const non-pointer (should just be const)
5525 if ($line =~ /\b__read_mostly\b/ &&
5526 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5527 if (ERROR("CONST_READ_MOSTLY",
5528 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5529 $fix) {
5530 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5531 }
5532 }
5533
fbdb8138
JP
5534# don't use __constant_<foo> functions outside of include/uapi/
5535 if ($realfile !~ m@^include/uapi/@ &&
5536 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5537 my $constant_func = $1;
5538 my $func = $constant_func;
5539 $func =~ s/^__constant_//;
5540 if (WARN("CONSTANT_CONVERSION",
5541 "$constant_func should be $func\n" . $herecurr) &&
5542 $fix) {
194f66fc 5543 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
fbdb8138
JP
5544 }
5545 }
5546
1a15a250 5547# prefer usleep_range over udelay
37581c28 5548 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
43c1d77c 5549 my $delay = $1;
1a15a250 5550 # ignore udelay's < 10, however
43c1d77c 5551 if (! ($delay < 10) ) {
000d1cc1 5552 CHK("USLEEP_RANGE",
43c1d77c
JP
5553 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5554 }
5555 if ($delay > 2000) {
5556 WARN("LONG_UDELAY",
5557 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
1a15a250
PP
5558 }
5559 }
5560
09ef8725
PP
5561# warn about unexpectedly long msleep's
5562 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5563 if ($1 < 20) {
000d1cc1 5564 WARN("MSLEEP",
43c1d77c 5565 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
09ef8725
PP
5566 }
5567 }
5568
36ec1939
JP
5569# check for comparisons of jiffies
5570 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5571 WARN("JIFFIES_COMPARISON",
5572 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5573 }
5574
9d7a34a5
JP
5575# check for comparisons of get_jiffies_64()
5576 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5577 WARN("JIFFIES_COMPARISON",
5578 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5579 }
5580
00df344f 5581# warn about #ifdefs in C files
c45dcabd 5582# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
00df344f
AW
5583# print "#ifdef in C files should be avoided\n";
5584# print "$herecurr";
5585# $clean = 0;
5586# }
5587
22f2a2ef 5588# warn about spacing in #ifdefs
c45dcabd 5589 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
3705ce5b
JP
5590 if (ERROR("SPACING",
5591 "exactly one space required after that #$1\n" . $herecurr) &&
5592 $fix) {
194f66fc 5593 $fixed[$fixlinenr] =~
3705ce5b
JP
5594 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5595 }
5596
22f2a2ef
AW
5597 }
5598
4a0df2ef 5599# check for spinlock_t definitions without a comment.
171ae1a4
AW
5600 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5601 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
4a0df2ef
AW
5602 my $which = $1;
5603 if (!ctx_has_comment($first_line, $linenr)) {
000d1cc1
JP
5604 CHK("UNCOMMENTED_DEFINITION",
5605 "$1 definition without comment\n" . $herecurr);
4a0df2ef
AW
5606 }
5607 }
5608# check for memory barriers without a comment.
402c2553
MT
5609
5610 my $barriers = qr{
5611 mb|
5612 rmb|
5613 wmb|
5614 read_barrier_depends
5615 }x;
5616 my $barrier_stems = qr{
5617 mb__before_atomic|
5618 mb__after_atomic|
5619 store_release|
5620 load_acquire|
5621 store_mb|
5622 (?:$barriers)
5623 }x;
5624 my $all_barriers = qr{
5625 (?:$barriers)|
43e361f2
MT
5626 smp_(?:$barrier_stems)|
5627 virt_(?:$barrier_stems)
402c2553
MT
5628 }x;
5629
5630 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
4a0df2ef 5631 if (!ctx_has_comment($first_line, $linenr)) {
c1fd7bb9
JP
5632 WARN("MEMORY_BARRIER",
5633 "memory barrier without comment\n" . $herecurr);
4a0df2ef
AW
5634 }
5635 }
3ad81779 5636
f4073b0f
MT
5637 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5638
5639 if ($realfile !~ m@^include/asm-generic/@ &&
5640 $realfile !~ m@/barrier\.h$@ &&
5641 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5642 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5643 WARN("MEMORY_BARRIER",
5644 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5645 }
5646
cb426e99
JP
5647# check for waitqueue_active without a comment.
5648 if ($line =~ /\bwaitqueue_active\s*\(/) {
5649 if (!ctx_has_comment($first_line, $linenr)) {
5650 WARN("WAITQUEUE_ACTIVE",
5651 "waitqueue_active without comment\n" . $herecurr);
5652 }
5653 }
3ad81779 5654
91db2592
PM
5655# check for smp_read_barrier_depends and read_barrier_depends
5656 if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) {
5657 WARN("READ_BARRIER_DEPENDS",
5658 "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr);
5659 }
5660
4a0df2ef 5661# check of hardware specific defines
c45dcabd 5662 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
000d1cc1
JP
5663 CHK("ARCH_DEFINES",
5664 "architecture specific defines should be avoided\n" . $herecurr);
0a920b5b 5665 }
653d4876 5666
596ed45b
JP
5667# check that the storage class is not after a type
5668 if ($line =~ /\b($Type)\s+($Storage)\b/) {
5669 WARN("STORAGE_CLASS",
5670 "storage class '$2' should be located before type '$1'\n" . $herecurr);
5671 }
d4977c78 5672# Check that the storage class is at the beginning of a declaration
596ed45b
JP
5673 if ($line =~ /\b$Storage\b/ &&
5674 $line !~ /^.\s*$Storage/ &&
5675 $line =~ /^.\s*(.+?)\$Storage\s/ &&
5676 $1 !~ /[\,\)]\s*$/) {
000d1cc1 5677 WARN("STORAGE_CLASS",
596ed45b 5678 "storage class should be at the beginning of the declaration\n" . $herecurr);
d4977c78
TK
5679 }
5680
de7d4f0e
AW
5681# check the location of the inline attribute, that it is between
5682# storage class and type.
9c0ca6f9
AW
5683 if ($line =~ /\b$Type\s+$Inline\b/ ||
5684 $line =~ /\b$Inline\s+$Storage\b/) {
000d1cc1
JP
5685 ERROR("INLINE_LOCATION",
5686 "inline keyword should sit between storage class and type\n" . $herecurr);
de7d4f0e
AW
5687 }
5688
8905a67c 5689# Check for __inline__ and __inline, prefer inline
2b7ab453
JP
5690 if ($realfile !~ m@\binclude/uapi/@ &&
5691 $line =~ /\b(__inline__|__inline)\b/) {
d5e616fc
JP
5692 if (WARN("INLINE",
5693 "plain inline is preferred over $1\n" . $herecurr) &&
5694 $fix) {
194f66fc 5695 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
d5e616fc
JP
5696
5697 }
8905a67c
AW
5698 }
5699
3d130fd0 5700# Check for __attribute__ packed, prefer __packed
2b7ab453
JP
5701 if ($realfile !~ m@\binclude/uapi/@ &&
5702 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
000d1cc1
JP
5703 WARN("PREFER_PACKED",
5704 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
3d130fd0
JP
5705 }
5706
39b7e287 5707# Check for __attribute__ aligned, prefer __aligned
2b7ab453
JP
5708 if ($realfile !~ m@\binclude/uapi/@ &&
5709 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
000d1cc1
JP
5710 WARN("PREFER_ALIGNED",
5711 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
39b7e287
JP
5712 }
5713
5f14d3bd 5714# Check for __attribute__ format(printf, prefer __printf
2b7ab453
JP
5715 if ($realfile !~ m@\binclude/uapi/@ &&
5716 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
d5e616fc
JP
5717 if (WARN("PREFER_PRINTF",
5718 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5719 $fix) {
194f66fc 5720 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
d5e616fc
JP
5721
5722 }
5f14d3bd
JP
5723 }
5724
6061d949 5725# Check for __attribute__ format(scanf, prefer __scanf
2b7ab453
JP
5726 if ($realfile !~ m@\binclude/uapi/@ &&
5727 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
d5e616fc
JP
5728 if (WARN("PREFER_SCANF",
5729 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5730 $fix) {
194f66fc 5731 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
d5e616fc 5732 }
6061d949
JP
5733 }
5734
619a908a
JP
5735# Check for __attribute__ weak, or __weak declarations (may have link issues)
5736 if ($^V && $^V ge 5.10.0 &&
5737 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5738 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5739 $line =~ /\b__weak\b/)) {
5740 ERROR("WEAK_DECLARATION",
5741 "Using weak declarations can have unintended link defects\n" . $herecurr);
5742 }
5743
fd39f904 5744# check for c99 types like uint8_t used outside of uapi/ and tools/
e6176fa4 5745 if ($realfile !~ m@\binclude/uapi/@ &&
fd39f904 5746 $realfile !~ m@\btools/@ &&
e6176fa4
JP
5747 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5748 my $type = $1;
5749 if ($type =~ /\b($typeC99Typedefs)\b/) {
5750 $type = $1;
5751 my $kernel_type = 'u';
5752 $kernel_type = 's' if ($type =~ /^_*[si]/);
5753 $type =~ /(\d+)/;
5754 $kernel_type .= $1;
5755 if (CHK("PREFER_KERNEL_TYPES",
5756 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5757 $fix) {
5758 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5759 }
5760 }
5761 }
5762
938224b5
JP
5763# check for cast of C90 native int or longer types constants
5764 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5765 my $cast = $1;
5766 my $const = $2;
5767 if (WARN("TYPECAST_INT_CONSTANT",
5768 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5769 $fix) {
5770 my $suffix = "";
5771 my $newconst = $const;
5772 $newconst =~ s/${Int_type}$//;
5773 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5774 if ($cast =~ /\blong\s+long\b/) {
5775 $suffix .= 'LL';
5776 } elsif ($cast =~ /\blong\b/) {
5777 $suffix .= 'L';
5778 }
5779 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5780 }
5781 }
5782
8f53a9b8
JP
5783# check for sizeof(&)
5784 if ($line =~ /\bsizeof\s*\(\s*\&/) {
000d1cc1
JP
5785 WARN("SIZEOF_ADDRESS",
5786 "sizeof(& should be avoided\n" . $herecurr);
8f53a9b8
JP
5787 }
5788
66c80b60
JP
5789# check for sizeof without parenthesis
5790 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
d5e616fc
JP
5791 if (WARN("SIZEOF_PARENTHESIS",
5792 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5793 $fix) {
194f66fc 5794 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
d5e616fc 5795 }
66c80b60
JP
5796 }
5797
88982fea
JP
5798# check for struct spinlock declarations
5799 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5800 WARN("USE_SPINLOCK_T",
5801 "struct spinlock should be spinlock_t\n" . $herecurr);
5802 }
5803
a6962d72 5804# check for seq_printf uses that could be seq_puts
06668727 5805 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
a6962d72 5806 my $fmt = get_quoted_string($line, $rawline);
caac1d5f
HA
5807 $fmt =~ s/%%//g;
5808 if ($fmt !~ /%/) {
d5e616fc
JP
5809 if (WARN("PREFER_SEQ_PUTS",
5810 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5811 $fix) {
194f66fc 5812 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
d5e616fc 5813 }
a6962d72
JP
5814 }
5815 }
5816
478b1799 5817# check for vsprintf extension %p<foo> misuses
0b523769
JP
5818 if ($^V && $^V ge 5.10.0 &&
5819 defined $stat &&
5820 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
5821 $1 !~ /^_*volatile_*$/) {
e3c6bc95
TH
5822 my $specifier;
5823 my $extension;
5824 my $bad_specifier = "";
5825 my $stat_real;
5826
0b523769
JP
5827 my $lc = $stat =~ tr@\n@@;
5828 $lc = $lc + $linenr;
5829 for (my $count = $linenr; $count <= $lc; $count++) {
5830 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
5831 $fmt =~ s/%%//g;
e3c6bc95
TH
5832
5833 while ($fmt =~ /(\%[\*\d\.]*p(\w))/g) {
5834 $specifier = $1;
5835 $extension = $2;
5836 if ($extension !~ /[SsBKRraEhMmIiUDdgVCbGNOx]/) {
5837 $bad_specifier = $specifier;
5838 last;
5839 }
5840 if ($extension eq "x" && !defined($stat_real)) {
5841 if (!defined($stat_real)) {
5842 $stat_real = get_stat_real($linenr, $lc);
5843 }
5844 WARN("VSPRINTF_SPECIFIER_PX",
5845 "Using vsprintf specifier '\%px' potentially exposes the kernel memory layout, if you don't really need the address please consider using '\%p'.\n" . "$here\n$stat_real\n");
5846 }
1df7338a 5847 }
e3c6bc95
TH
5848 if ($bad_specifier ne "") {
5849 my $stat_real = get_stat_real($linenr, $lc);
5850 my $ext_type = "Invalid";
5851 my $use = "";
5852 if ($bad_specifier =~ /p[Ff]/) {
5853 $ext_type = "Deprecated";
5854 $use = " - use %pS instead";
5855 $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
5856 }
2a9f9d85 5857
e3c6bc95
TH
5858 WARN("VSPRINTF_POINTER_EXTENSION",
5859 "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
5860 }
0b523769
JP
5861 }
5862 }
5863
554e165c 5864# Check for misused memsets
d1fe9c09
JP
5865 if ($^V && $^V ge 5.10.0 &&
5866 defined $stat &&
9e20a853 5867 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
d7c76ba7
JP
5868
5869 my $ms_addr = $2;
d1fe9c09
JP
5870 my $ms_val = $7;
5871 my $ms_size = $12;
554e165c 5872
554e165c
AW
5873 if ($ms_size =~ /^(0x|)0$/i) {
5874 ERROR("MEMSET",
d7c76ba7 5875 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
554e165c
AW
5876 } elsif ($ms_size =~ /^(0x|)1$/i) {
5877 WARN("MEMSET",
d7c76ba7
JP
5878 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5879 }
5880 }
5881
98a9bba5 5882# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
f333195d
JP
5883# if ($^V && $^V ge 5.10.0 &&
5884# defined $stat &&
5885# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5886# if (WARN("PREFER_ETHER_ADDR_COPY",
5887# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5888# $fix) {
5889# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5890# }
5891# }
98a9bba5 5892
b6117d17 5893# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
f333195d
JP
5894# if ($^V && $^V ge 5.10.0 &&
5895# defined $stat &&
5896# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5897# WARN("PREFER_ETHER_ADDR_EQUAL",
5898# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5899# }
b6117d17 5900
8617cd09
MK
5901# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5902# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
f333195d
JP
5903# if ($^V && $^V ge 5.10.0 &&
5904# defined $stat &&
5905# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5906#
5907# my $ms_val = $7;
5908#
5909# if ($ms_val =~ /^(?:0x|)0+$/i) {
5910# if (WARN("PREFER_ETH_ZERO_ADDR",
5911# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5912# $fix) {
5913# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5914# }
5915# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5916# if (WARN("PREFER_ETH_BROADCAST_ADDR",
5917# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5918# $fix) {
5919# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5920# }
5921# }
5922# }
8617cd09 5923
d7c76ba7 5924# typecasts on min/max could be min_t/max_t
d1fe9c09
JP
5925 if ($^V && $^V ge 5.10.0 &&
5926 defined $stat &&
d7c76ba7 5927 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
d1fe9c09 5928 if (defined $2 || defined $7) {
d7c76ba7
JP
5929 my $call = $1;
5930 my $cast1 = deparenthesize($2);
5931 my $arg1 = $3;
d1fe9c09
JP
5932 my $cast2 = deparenthesize($7);
5933 my $arg2 = $8;
d7c76ba7
JP
5934 my $cast;
5935
d1fe9c09 5936 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
d7c76ba7
JP
5937 $cast = "$cast1 or $cast2";
5938 } elsif ($cast1 ne "") {
5939 $cast = $cast1;
5940 } else {
5941 $cast = $cast2;
5942 }
5943 WARN("MINMAX",
5944 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
554e165c
AW
5945 }
5946 }
5947
4a273195
JP
5948# check usleep_range arguments
5949 if ($^V && $^V ge 5.10.0 &&
5950 defined $stat &&
5951 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5952 my $min = $1;
5953 my $max = $7;
5954 if ($min eq $max) {
5955 WARN("USLEEP_RANGE",
5956 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5957 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5958 $min > $max) {
5959 WARN("USLEEP_RANGE",
5960 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5961 }
5962 }
5963
823b794c
JP
5964# check for naked sscanf
5965 if ($^V && $^V ge 5.10.0 &&
5966 defined $stat &&
6c8bd707 5967 $line =~ /\bsscanf\b/ &&
823b794c
JP
5968 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5969 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5970 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5971 my $lc = $stat =~ tr@\n@@;
5972 $lc = $lc + $linenr;
2a9f9d85 5973 my $stat_real = get_stat_real($linenr, $lc);
823b794c
JP
5974 WARN("NAKED_SSCANF",
5975 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5976 }
5977
afc819ab
JP
5978# check for simple sscanf that should be kstrto<foo>
5979 if ($^V && $^V ge 5.10.0 &&
5980 defined $stat &&
5981 $line =~ /\bsscanf\b/) {
5982 my $lc = $stat =~ tr@\n@@;
5983 $lc = $lc + $linenr;
2a9f9d85 5984 my $stat_real = get_stat_real($linenr, $lc);
afc819ab
JP
5985 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5986 my $format = $6;
5987 my $count = $format =~ tr@%@%@;
5988 if ($count == 1 &&
5989 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5990 WARN("SSCANF_TO_KSTRTO",
5991 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5992 }
5993 }
5994 }
5995
70dc8a48
JP
5996# check for new externs in .h files.
5997 if ($realfile =~ /\.h$/ &&
5998 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
d1d85780
JP
5999 if (CHK("AVOID_EXTERNS",
6000 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
70dc8a48 6001 $fix) {
194f66fc 6002 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
70dc8a48
JP
6003 }
6004 }
6005
de7d4f0e 6006# check for new externs in .c files.
171ae1a4 6007 if ($realfile =~ /\.c$/ && defined $stat &&
c45dcabd 6008 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
171ae1a4 6009 {
c45dcabd
AW
6010 my $function_name = $1;
6011 my $paren_space = $2;
171ae1a4
AW
6012
6013 my $s = $stat;
6014 if (defined $cond) {
6015 substr($s, 0, length($cond), '');
6016 }
c45dcabd
AW
6017 if ($s =~ /^\s*;/ &&
6018 $function_name ne 'uninitialized_var')
6019 {
000d1cc1
JP
6020 WARN("AVOID_EXTERNS",
6021 "externs should be avoided in .c files\n" . $herecurr);
171ae1a4
AW
6022 }
6023
6024 if ($paren_space =~ /\n/) {
000d1cc1
JP
6025 WARN("FUNCTION_ARGUMENTS",
6026 "arguments for function declarations should follow identifier\n" . $herecurr);
171ae1a4 6027 }
9c9ba34e
AW
6028
6029 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6030 $stat =~ /^.\s*extern\s+/)
6031 {
000d1cc1
JP
6032 WARN("AVOID_EXTERNS",
6033 "externs should be avoided in .c files\n" . $herecurr);
de7d4f0e
AW
6034 }
6035
a0ad7596
JP
6036# check for function declarations that have arguments without identifier names
6037 if (defined $stat &&
25bdda2b 6038 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
ca0d8929
JP
6039 $1 ne "void") {
6040 my $args = trim($1);
6041 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6042 my $arg = trim($1);
6043 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
6044 WARN("FUNCTION_ARGUMENTS",
6045 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6046 }
6047 }
6048 }
6049
a0ad7596
JP
6050# check for function definitions
6051 if ($^V && $^V ge 5.10.0 &&
6052 defined $stat &&
6053 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6054 $context_function = $1;
6055
6056# check for multiline function definition with misplaced open brace
6057 my $ok = 0;
6058 my $cnt = statement_rawlines($stat);
6059 my $herectx = $here . "\n";
6060 for (my $n = 0; $n < $cnt; $n++) {
6061 my $rl = raw_line($linenr, $n);
6062 $herectx .= $rl . "\n";
6063 $ok = 1 if ($rl =~ /^[ \+]\{/);
6064 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6065 last if $rl =~ /^[ \+].*\{/;
6066 }
6067 if (!$ok) {
6068 ERROR("OPEN_BRACE",
6069 "open brace '{' following function definitions go on the next line\n" . $herectx);
6070 }
6071 }
6072
de7d4f0e
AW
6073# checks for new __setup's
6074 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6075 my $name = $1;
6076
6077 if (!grep(/$name/, @setup_docs)) {
000d1cc1 6078 CHK("UNDOCUMENTED_SETUP",
8c27ceff 6079 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
de7d4f0e 6080 }
653d4876 6081 }
9c0ca6f9
AW
6082
6083# check for pointless casting of kmalloc return
caf2a54f 6084 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
000d1cc1
JP
6085 WARN("UNNECESSARY_CASTS",
6086 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
9c0ca6f9 6087 }
13214adf 6088
a640d25c
JP
6089# alloc style
6090# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6091 if ($^V && $^V ge 5.10.0 &&
6092 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6093 CHK("ALLOC_SIZEOF_STRUCT",
6094 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6095 }
6096
60a55369
JP
6097# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6098 if ($^V && $^V ge 5.10.0 &&
1b4a2ed4
JP
6099 defined $stat &&
6100 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
60a55369
JP
6101 my $oldfunc = $3;
6102 my $a1 = $4;
6103 my $a2 = $10;
6104 my $newfunc = "kmalloc_array";
6105 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
e367455a
JP
6106 my $r1 = $a1;
6107 my $r2 = $a2;
6108 if ($a1 =~ /^sizeof\s*\S/) {
6109 $r1 = $a2;
6110 $r2 = $a1;
6111 }
6112 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6113 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
1b4a2ed4 6114 my $cnt = statement_rawlines($stat);
e3d95a2a
TH
6115 my $herectx = get_stat_here($linenr, $cnt, $here);
6116
60a55369 6117 if (WARN("ALLOC_WITH_MULTIPLY",
1b4a2ed4
JP
6118 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6119 $cnt == 1 &&
60a55369 6120 $fix) {
194f66fc 6121 $fixed[$fixlinenr] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e;
60a55369
JP
6122 }
6123 }
6124 }
6125
972fdea2
JP
6126# check for krealloc arg reuse
6127 if ($^V && $^V ge 5.10.0 &&
6128 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
6129 WARN("KREALLOC_ARG_REUSE",
6130 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6131 }
6132
5ce59ae0
JP
6133# check for alloc argument mismatch
6134 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6135 WARN("ALLOC_ARRAY_ARGS",
6136 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6137 }
6138
caf2a54f
JP
6139# check for multiple semicolons
6140 if ($line =~ /;\s*;\s*$/) {
d5e616fc
JP
6141 if (WARN("ONE_SEMICOLON",
6142 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6143 $fix) {
194f66fc 6144 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
d5e616fc 6145 }
d1e2ad07
JP
6146 }
6147
cec3aaa5
TW
6148# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6149 if ($realfile !~ m@^include/uapi/@ &&
6150 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
0ab90191
JP
6151 my $ull = "";
6152 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6153 if (CHK("BIT_MACRO",
6154 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6155 $fix) {
6156 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6157 }
6158 }
6159
2d632745
JP
6160# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6161 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6162 my $config = $1;
6163 if (WARN("PREFER_IS_ENABLED",
6164 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6165 $fix) {
6166 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6167 }
6168 }
6169
e81f239b 6170# check for case / default statements not preceded by break/fallthrough/switch
c34c09a8
JP
6171 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6172 my $has_break = 0;
6173 my $has_statement = 0;
6174 my $count = 0;
6175 my $prevline = $linenr;
e81f239b 6176 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
c34c09a8
JP
6177 $prevline--;
6178 my $rline = $rawlines[$prevline - 1];
6179 my $fline = $lines[$prevline - 1];
6180 last if ($fline =~ /^\@\@/);
6181 next if ($fline =~ /^\-/);
6182 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6183 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6184 next if ($fline =~ /^.[\s$;]*$/);
6185 $has_statement = 1;
6186 $count++;
258f79d5 6187 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
c34c09a8
JP
6188 }
6189 if (!$has_break && $has_statement) {
6190 WARN("MISSING_BREAK",
224236d9 6191 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
c34c09a8
JP
6192 }
6193 }
6194
d1e2ad07
JP
6195# check for switch/default statements without a break;
6196 if ($^V && $^V ge 5.10.0 &&
6197 defined $stat &&
6198 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
d1e2ad07 6199 my $cnt = statement_rawlines($stat);
e3d95a2a
TH
6200 my $herectx = get_stat_here($linenr, $cnt, $here);
6201
d1e2ad07
JP
6202 WARN("DEFAULT_NO_BREAK",
6203 "switch default: should use break\n" . $herectx);
caf2a54f
JP
6204 }
6205
13214adf 6206# check for gcc specific __FUNCTION__
d5e616fc
JP
6207 if ($line =~ /\b__FUNCTION__\b/) {
6208 if (WARN("USE_FUNC",
6209 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6210 $fix) {
194f66fc 6211 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
d5e616fc 6212 }
13214adf 6213 }
773647a0 6214
62ec818f
JP
6215# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6216 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6217 ERROR("DATE_TIME",
6218 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6219 }
6220
2c92488a
JP
6221# check for use of yield()
6222 if ($line =~ /\byield\s*\(\s*\)/) {
6223 WARN("YIELD",
6224 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6225 }
6226
179f8f40
JP
6227# check for comparisons against true and false
6228 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6229 my $lead = $1;
6230 my $arg = $2;
6231 my $test = $3;
6232 my $otype = $4;
6233 my $trail = $5;
6234 my $op = "!";
6235
6236 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6237
6238 my $type = lc($otype);
6239 if ($type =~ /^(?:true|false)$/) {
6240 if (("$test" eq "==" && "$type" eq "true") ||
6241 ("$test" eq "!=" && "$type" eq "false")) {
6242 $op = "";
6243 }
6244
6245 CHK("BOOL_COMPARISON",
6246 "Using comparison to $otype is error prone\n" . $herecurr);
6247
6248## maybe suggesting a correct construct would better
6249## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6250
6251 }
6252 }
6253
5d430902
JP
6254# check for bool bitfields
6255 if ($sline =~ /^.\s+bool\s*$Ident\s*:\s*\d+\s*;/) {
6256 WARN("BOOL_BITFIELD",
6257 "Avoid using bool as bitfield. Prefer bool bitfields as unsigned int or u<8|16|32>\n" . $herecurr);
6258 }
6259
4882720b
TG
6260# check for semaphores initialized locked
6261 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
000d1cc1
JP
6262 WARN("CONSIDER_COMPLETION",
6263 "consider using a completion\n" . $herecurr);
773647a0 6264 }
6712d858 6265
67d0a075
JP
6266# recommend kstrto* over simple_strto* and strict_strto*
6267 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
000d1cc1 6268 WARN("CONSIDER_KSTRTO",
67d0a075 6269 "$1 is obsolete, use k$3 instead\n" . $herecurr);
773647a0 6270 }
6712d858 6271
ae3ccc46 6272# check for __initcall(), use device_initcall() explicitly or more appropriate function please
f3db6639 6273 if ($line =~ /^.\s*__initcall\s*\(/) {
000d1cc1 6274 WARN("USE_DEVICE_INITCALL",
ae3ccc46 6275 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
f3db6639 6276 }
6712d858 6277
0f3c5aab 6278# check for various structs that are normally const (ops, kgdb, device_tree)
d9190e4e 6279# and avoid what seem like struct definitions 'struct foo {'
6903ffb2 6280 if ($line !~ /\bconst\b/ &&
d9190e4e 6281 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
000d1cc1 6282 WARN("CONST_STRUCT",
d9190e4e 6283 "struct $1 should normally be const\n" . $herecurr);
2b6db5cb 6284 }
773647a0
AW
6285
6286# use of NR_CPUS is usually wrong
6287# ignore definitions of NR_CPUS and usage to define arrays as likely right
6288 if ($line =~ /\bNR_CPUS\b/ &&
c45dcabd
AW
6289 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6290 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
171ae1a4
AW
6291 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6292 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6293 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
773647a0 6294 {
000d1cc1
JP
6295 WARN("NR_CPUS",
6296 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
773647a0 6297 }
9c9ba34e 6298
52ea8506
JP
6299# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6300 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6301 ERROR("DEFINE_ARCH_HAS",
6302 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6303 }
6304
acd9362c
JP
6305# likely/unlikely comparisons similar to "(likely(foo) > 0)"
6306 if ($^V && $^V ge 5.10.0 &&
6307 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6308 WARN("LIKELY_MISUSE",
6309 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6310 }
6311
691d77b6
AW
6312# whine mightly about in_atomic
6313 if ($line =~ /\bin_atomic\s*\(/) {
6314 if ($realfile =~ m@^drivers/@) {
000d1cc1
JP
6315 ERROR("IN_ATOMIC",
6316 "do not use in_atomic in drivers\n" . $herecurr);
f4a87736 6317 } elsif ($realfile !~ m@^kernel/@) {
000d1cc1
JP
6318 WARN("IN_ATOMIC",
6319 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
691d77b6
AW
6320 }
6321 }
1704f47b 6322
0f5225b0
PZ
6323# check for mutex_trylock_recursive usage
6324 if ($line =~ /mutex_trylock_recursive/) {
6325 ERROR("LOCKING",
6326 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6327 }
6328
1704f47b
PZ
6329# check for lockdep_set_novalidate_class
6330 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6331 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6332 if ($realfile !~ m@^kernel/lockdep@ &&
6333 $realfile !~ m@^include/linux/lockdep@ &&
6334 $realfile !~ m@^drivers/base/core@) {
000d1cc1
JP
6335 ERROR("LOCKDEP",
6336 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
1704f47b
PZ
6337 }
6338 }
88f8831c 6339
b392c64f
JP
6340 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6341 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
000d1cc1
JP
6342 WARN("EXPORTED_WORLD_WRITABLE",
6343 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
88f8831c 6344 }
2435880f 6345
00180468
JP
6346# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6347# and whether or not function naming is typical and if
6348# DEVICE_ATTR permissions uses are unusual too
6349 if ($^V && $^V ge 5.10.0 &&
6350 defined $stat &&
6351 $stat =~ /\bDEVICE_ATTR\s*\(\s*(\w+)\s*,\s*\(?\s*(\s*(?:${multi_mode_perms_string_search}|0[0-7]{3,3})\s*)\s*\)?\s*,\s*(\w+)\s*,\s*(\w+)\s*\)/) {
6352 my $var = $1;
6353 my $perms = $2;
6354 my $show = $3;
6355 my $store = $4;
6356 my $octal_perms = perms_to_octal($perms);
6357 if ($show =~ /^${var}_show$/ &&
6358 $store =~ /^${var}_store$/ &&
6359 $octal_perms eq "0644") {
6360 if (WARN("DEVICE_ATTR_RW",
6361 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
6362 $fix) {
6363 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6364 }
6365 } elsif ($show =~ /^${var}_show$/ &&
6366 $store =~ /^NULL$/ &&
6367 $octal_perms eq "0444") {
6368 if (WARN("DEVICE_ATTR_RO",
6369 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
6370 $fix) {
6371 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6372 }
6373 } elsif ($show =~ /^NULL$/ &&
6374 $store =~ /^${var}_store$/ &&
6375 $octal_perms eq "0200") {
6376 if (WARN("DEVICE_ATTR_WO",
6377 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
6378 $fix) {
6379 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6380 }
6381 } elsif ($octal_perms eq "0644" ||
6382 $octal_perms eq "0444" ||
6383 $octal_perms eq "0200") {
6384 my $newshow = "$show";
6385 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
6386 my $newstore = $store;
6387 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
6388 my $rename = "";
6389 if ($show ne $newshow) {
6390 $rename .= " '$show' to '$newshow'";
6391 }
6392 if ($store ne $newstore) {
6393 $rename .= " '$store' to '$newstore'";
6394 }
6395 WARN("DEVICE_ATTR_FUNCTIONS",
6396 "Consider renaming function(s)$rename\n" . $herecurr);
6397 } else {
6398 WARN("DEVICE_ATTR_PERMS",
6399 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
6400 }
6401 }
6402
515a235e
JP
6403# Mode permission misuses where it seems decimal should be octal
6404# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
73121534
JP
6405# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6406# specific definition of not visible in sysfs.
6407# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6408# use the default permissions
515a235e 6409 if ($^V && $^V ge 5.10.0 &&
459cf0ae 6410 defined $stat &&
515a235e
JP
6411 $line =~ /$mode_perms_search/) {
6412 foreach my $entry (@mode_permission_funcs) {
6413 my $func = $entry->[0];
6414 my $arg_pos = $entry->[1];
6415
459cf0ae
JP
6416 my $lc = $stat =~ tr@\n@@;
6417 $lc = $lc + $linenr;
2a9f9d85 6418 my $stat_real = get_stat_real($linenr, $lc);
459cf0ae 6419
515a235e
JP
6420 my $skip_args = "";
6421 if ($arg_pos > 1) {
6422 $arg_pos--;
6423 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6424 }
f90774e1 6425 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
459cf0ae 6426 if ($stat =~ /$test/) {
515a235e
JP
6427 my $val = $1;
6428 $val = $6 if ($skip_args ne "");
73121534
JP
6429 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
6430 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6431 ($val =~ /^$Octal$/ && length($val) ne 4))) {
515a235e 6432 ERROR("NON_OCTAL_PERMISSIONS",
459cf0ae 6433 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
f90774e1
JP
6434 }
6435 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
c0a5c898 6436 ERROR("EXPORTED_WORLD_WRITABLE",
459cf0ae 6437 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
f90774e1 6438 }
2435880f
JP
6439 }
6440 }
6441 }
5a6d20ce 6442
459cf0ae 6443# check for uses of S_<PERMS> that could be octal for readability
bc22d9a7 6444 while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
00180468
JP
6445 my $oval = $1;
6446 my $octal = perms_to_octal($oval);
459cf0ae
JP
6447 if (WARN("SYMBOLIC_PERMS",
6448 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6449 $fix) {
00180468 6450 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
459cf0ae
JP
6451 }
6452 }
6453
5a6d20ce
BA
6454# validate content of MODULE_LICENSE against list from include/linux/module.h
6455 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6456 my $extracted_string = get_quoted_string($line, $rawline);
6457 my $valid_licenses = qr{
6458 GPL|
6459 GPL\ v2|
6460 GPL\ and\ additional\ rights|
6461 Dual\ BSD/GPL|
6462 Dual\ MIT/GPL|
6463 Dual\ MPL/GPL|
6464 Proprietary
6465 }x;
6466 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6467 WARN("MODULE_LICENSE",
6468 "unknown module license " . $extracted_string . "\n" . $herecurr);
6469 }
6470 }
13214adf
AW
6471 }
6472
6473 # If we have no input at all, then there is nothing to report on
6474 # so just keep quiet.
6475 if ($#rawlines == -1) {
6476 exit(0);
0a920b5b
AW
6477 }
6478
8905a67c
AW
6479 # In mailback mode only produce a report in the negative, for
6480 # things that appear to be patches.
6481 if ($mailback && ($clean == 1 || !$is_patch)) {
6482 exit(0);
6483 }
6484
6485 # This is not a patch, and we are are in 'no-patch' mode so
6486 # just keep quiet.
6487 if (!$chk_patch && !$is_patch) {
6488 exit(0);
6489 }
6490
a08ffbef 6491 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
000d1cc1
JP
6492 ERROR("NOT_UNIFIED_DIFF",
6493 "Does not appear to be a unified-diff format patch\n");
0a920b5b 6494 }
ed43c4e5 6495 if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
000d1cc1
JP
6496 ERROR("MISSING_SIGN_OFF",
6497 "Missing Signed-off-by: line(s)\n");
0a920b5b
AW
6498 }
6499
8905a67c 6500 print report_dump();
13214adf
AW
6501 if ($summary && !($clean == 1 && $quiet == 1)) {
6502 print "$filename " if ($summary_file);
8905a67c
AW
6503 print "total: $cnt_error errors, $cnt_warn warnings, " .
6504 (($check)? "$cnt_chk checks, " : "") .
6505 "$cnt_lines lines checked\n";
f0a594c1 6506 }
8905a67c 6507
d2c0a235 6508 if ($quiet == 0) {
ef212196
JP
6509 # If there were any defects found and not already fixing them
6510 if (!$clean and !$fix) {
6511 print << "EOM"
6512
6513NOTE: For some of the reported defects, checkpatch may be able to
6514 mechanically convert to the typical style using --fix or --fix-inplace.
6515EOM
6516 }
d2c0a235
AW
6517 # If there were whitespace errors which cleanpatch can fix
6518 # then suggest that.
6519 if ($rpt_cleaners) {
b0781216 6520 $rpt_cleaners = 0;
d8469f16
JP
6521 print << "EOM"
6522
6523NOTE: Whitespace errors detected.
6524 You may wish to use scripts/cleanpatch or scripts/cleanfile
6525EOM
d2c0a235
AW
6526 }
6527 }
6528
d752fcc8
JP
6529 if ($clean == 0 && $fix &&
6530 ("@rawlines" ne "@fixed" ||
6531 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
9624b8d6
JP
6532 my $newfile = $filename;
6533 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
3705ce5b
JP
6534 my $linecount = 0;
6535 my $f;
6536
d752fcc8
JP
6537 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6538
3705ce5b
JP
6539 open($f, '>', $newfile)
6540 or die "$P: Can't open $newfile for write\n";
6541 foreach my $fixed_line (@fixed) {
6542 $linecount++;
6543 if ($file) {
6544 if ($linecount > 3) {
6545 $fixed_line =~ s/^\+//;
d752fcc8 6546 print $f $fixed_line . "\n";
3705ce5b
JP
6547 }
6548 } else {
6549 print $f $fixed_line . "\n";
6550 }
6551 }
6552 close($f);
6553
6554 if (!$quiet) {
6555 print << "EOM";
d8469f16 6556
3705ce5b
JP
6557Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6558
6559Do _NOT_ trust the results written to this file.
6560Do _NOT_ submit these changes without inspecting them for correctness.
6561
6562This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6563No warranties, expressed or implied...
3705ce5b
JP
6564EOM
6565 }
6566 }
6567
d8469f16
JP
6568 if ($quiet == 0) {
6569 print "\n";
6570 if ($clean == 1) {
6571 print "$vname has no obvious style problems and is ready for submission.\n";
6572 } else {
6573 print "$vname has style problems, please review.\n";
6574 }
0a920b5b
AW
6575 }
6576 return $clean;
6577}