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