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