checkpatch: add TP_printk to list of logging functions
[linux-2.6-block.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/ ||
3108 $line =~ /^\+\s*__setup/)) {
d752fcc8
JP
3109 if (CHK("LINE_SPACING",
3110 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3111 $fix) {
f2d7e4d4 3112 fix_insert_line($fixlinenr, "\+");
d752fcc8 3113 }
7f619191
JP
3114 }
3115
365dd4ea
JP
3116# check for multiple consecutive blank lines
3117 if ($prevline =~ /^[\+ ]\s*$/ &&
3118 $line =~ /^\+\s*$/ &&
3119 $last_blank_line != ($linenr - 1)) {
d752fcc8
JP
3120 if (CHK("LINE_SPACING",
3121 "Please don't use multiple blank lines\n" . $hereprev) &&
3122 $fix) {
f2d7e4d4 3123 fix_delete_line($fixlinenr, $rawline);
d752fcc8
JP
3124 }
3125
365dd4ea
JP
3126 $last_blank_line = $linenr;
3127 }
3128
3b617e3b 3129# check for missing blank lines after declarations
3f7bac03
JP
3130 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3131 # actual declarations
3132 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
5a4e1fd3
JP
3133 # function pointer declarations
3134 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3f7bac03
JP
3135 # foo bar; where foo is some local typedef or #define
3136 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3137 # known declaration macros
3138 $prevline =~ /^\+\s+$declaration_macros/) &&
3139 # for "else if" which can look like "$Ident $Ident"
3140 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3141 # other possible extensions of declaration lines
3142 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3143 # not starting a section or a macro "\" extended line
3144 $prevline =~ /(?:\{\s*|\\)$/) &&
3145 # looks like a declaration
3146 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
5a4e1fd3
JP
3147 # function pointer declarations
3148 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3f7bac03
JP
3149 # foo bar; where foo is some local typedef or #define
3150 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3151 # known declaration macros
3152 $sline =~ /^\+\s+$declaration_macros/ ||
3153 # start of struct or union or enum
3b617e3b 3154 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
3f7bac03
JP
3155 # start or end of block or continuation of declaration
3156 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3157 # bitfield continuation
3158 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3159 # other possible extensions of declaration lines
3160 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3161 # indentation of previous and current line are the same
3162 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
d752fcc8
JP
3163 if (WARN("LINE_SPACING",
3164 "Missing a blank line after declarations\n" . $hereprev) &&
3165 $fix) {
f2d7e4d4 3166 fix_insert_line($fixlinenr, "\+");
d752fcc8 3167 }
3b617e3b
JP
3168 }
3169
5f7ddae6 3170# check for spaces at the beginning of a line.
6b4c5beb
AW
3171# Exceptions:
3172# 1) within comments
3173# 2) indented preprocessor commands
3174# 3) hanging labels
3705ce5b 3175 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
5f7ddae6 3176 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3705ce5b
JP
3177 if (WARN("LEADING_SPACE",
3178 "please, no spaces at the start of a line\n" . $herevet) &&
3179 $fix) {
194f66fc 3180 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3705ce5b 3181 }
5f7ddae6
RR
3182 }
3183
b9ea10d6
AW
3184# check we are in a valid C source file if not then ignore this hunk
3185 next if ($realfile !~ /\.(h|c)$/);
3186
4dbed76f
JP
3187# check if this appears to be the start function declaration, save the name
3188 if ($sline =~ /^\+\{\s*$/ &&
3189 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3190 $context_function = $1;
3191 }
3192
3193# check if this appears to be the end of function declaration
3194 if ($sline =~ /^\+\}\s*$/) {
3195 undef $context_function;
3196 }
3197
032a4c0f 3198# check indentation of any line with a bare else
840080a0 3199# (but not if it is a multiple line "if (foo) return bar; else return baz;")
032a4c0f
JP
3200# if the previous line is a break or return and is indented 1 tab more...
3201 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3202 my $tabs = length($1) + 1;
840080a0
JP
3203 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3204 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3205 defined $lines[$linenr] &&
3206 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
032a4c0f
JP
3207 WARN("UNNECESSARY_ELSE",
3208 "else is not generally useful after a break or return\n" . $hereprev);
3209 }
3210 }
3211
c00df19a
JP
3212# check indentation of a line with a break;
3213# if the previous line is a goto or return and is indented the same # of tabs
3214 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3215 my $tabs = $1;
3216 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3217 WARN("UNNECESSARY_BREAK",
3218 "break is not useful after a goto or return\n" . $hereprev);
3219 }
3220 }
3221
c2fdda0d 3222# check for RCS/CVS revision markers
cf655043 3223 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
000d1cc1
JP
3224 WARN("CVS_KEYWORD",
3225 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
c2fdda0d 3226 }
22f2a2ef 3227
42e41c54
MF
3228# Blackfin: don't use __builtin_bfin_[cs]sync
3229 if ($line =~ /__builtin_bfin_csync/) {
3230 my $herevet = "$here\n" . cat_vet($line) . "\n";
000d1cc1
JP
3231 ERROR("CSYNC",
3232 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
42e41c54
MF
3233 }
3234 if ($line =~ /__builtin_bfin_ssync/) {
3235 my $herevet = "$here\n" . cat_vet($line) . "\n";
000d1cc1
JP
3236 ERROR("SSYNC",
3237 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
42e41c54
MF
3238 }
3239
56e77d70
JP
3240# check for old HOTPLUG __dev<foo> section markings
3241 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3242 WARN("HOTPLUG_SECTION",
3243 "Using $1 is unnecessary\n" . $herecurr);
3244 }
3245
9c0ca6f9 3246# Check for potential 'bare' types
2b474a1a
AW
3247 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3248 $realline_next);
3e469cdc 3249#print "LINE<$line>\n";
ca819864 3250 if ($linenr > $suppress_statement &&
1b5539b1 3251 $realcnt && $sline =~ /.\s*\S/) {
170d3a22 3252 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
f5fe35dd 3253 ctx_statement_block($linenr, $realcnt, 0);
171ae1a4
AW
3254 $stat =~ s/\n./\n /g;
3255 $cond =~ s/\n./\n /g;
3256
3e469cdc
AW
3257#print "linenr<$linenr> <$stat>\n";
3258 # If this statement has no statement boundaries within
3259 # it there is no point in retrying a statement scan
3260 # until we hit end of it.
3261 my $frag = $stat; $frag =~ s/;+\s*$//;
3262 if ($frag !~ /(?:{|;)/) {
3263#print "skip<$line_nr_next>\n";
3264 $suppress_statement = $line_nr_next;
3265 }
f74bd194 3266
2b474a1a
AW
3267 # Find the real next line.
3268 $realline_next = $line_nr_next;
3269 if (defined $realline_next &&
3270 (!defined $lines[$realline_next - 1] ||
3271 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3272 $realline_next++;
3273 }
3274
171ae1a4
AW
3275 my $s = $stat;
3276 $s =~ s/{.*$//s;
cf655043 3277
c2fdda0d 3278 # Ignore goto labels.
171ae1a4 3279 if ($s =~ /$Ident:\*$/s) {
c2fdda0d
AW
3280
3281 # Ignore functions being called
171ae1a4 3282 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
c2fdda0d 3283
463f2864
AW
3284 } elsif ($s =~ /^.\s*else\b/s) {
3285
c45dcabd 3286 # declarations always start with types
d2506586 3287 } 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
3288 my $type = $1;
3289 $type =~ s/\s+/ /g;
3290 possible($type, "A:" . $s);
3291
8905a67c 3292 # definitions in global scope can only start with types
a6a84062 3293 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
c45dcabd 3294 possible($1, "B:" . $s);
c2fdda0d 3295 }
8905a67c
AW
3296
3297 # any (foo ... *) is a pointer cast, and foo is a type
65863862 3298 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
c45dcabd 3299 possible($1, "C:" . $s);
8905a67c
AW
3300 }
3301
3302 # Check for any sort of function declaration.
3303 # int foo(something bar, other baz);
3304 # void (*store_gdt)(x86_descr_ptr *);
171ae1a4 3305 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
8905a67c 3306 my ($name_len) = length($1);
8905a67c 3307
cf655043 3308 my $ctx = $s;
773647a0 3309 substr($ctx, 0, $name_len + 1, '');
8905a67c 3310 $ctx =~ s/\)[^\)]*$//;
cf655043 3311
8905a67c 3312 for my $arg (split(/\s*,\s*/, $ctx)) {
c45dcabd 3313 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
8905a67c 3314
c45dcabd 3315 possible($1, "D:" . $s);
8905a67c
AW
3316 }
3317 }
9c0ca6f9 3318 }
8905a67c 3319
9c0ca6f9
AW
3320 }
3321
653d4876
AW
3322#
3323# Checks which may be anchored in the context.
3324#
00df344f 3325
653d4876
AW
3326# Check for switch () and associated case and default
3327# statements should be at the same indent.
00df344f
AW
3328 if ($line=~/\bswitch\s*\(.*\)/) {
3329 my $err = '';
3330 my $sep = '';
3331 my @ctx = ctx_block_outer($linenr, $realcnt);
3332 shift(@ctx);
3333 for my $ctx (@ctx) {
3334 my ($clen, $cindent) = line_stats($ctx);
3335 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3336 $indent != $cindent) {
3337 $err .= "$sep$ctx\n";
3338 $sep = '';
3339 } else {
3340 $sep = "[...]\n";
3341 }
3342 }
3343 if ($err ne '') {
000d1cc1
JP
3344 ERROR("SWITCH_CASE_INDENT_LEVEL",
3345 "switch and case should be at the same indent\n$hereline$err");
de7d4f0e
AW
3346 }
3347 }
3348
3349# if/while/etc brace do not go on next line, unless defining a do while loop,
3350# or if that brace on the next line is for something else
0fe3dc2b 3351 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
773647a0
AW
3352 my $pre_ctx = "$1$2";
3353
9c0ca6f9 3354 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
8eef05dd
JP
3355
3356 if ($line =~ /^\+\t{6,}/) {
3357 WARN("DEEP_INDENTATION",
3358 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3359 }
3360
de7d4f0e
AW
3361 my $ctx_cnt = $realcnt - $#ctx - 1;
3362 my $ctx = join("\n", @ctx);
3363
548596d5
AW
3364 my $ctx_ln = $linenr;
3365 my $ctx_skip = $realcnt;
773647a0 3366
548596d5
AW
3367 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3368 defined $lines[$ctx_ln - 1] &&
3369 $lines[$ctx_ln - 1] =~ /^-/)) {
3370 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3371 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
de7d4f0e 3372 $ctx_ln++;
de7d4f0e 3373 }
548596d5 3374
53210168
AW
3375 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3376 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
de7d4f0e 3377
d752fcc8 3378 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
000d1cc1
JP
3379 ERROR("OPEN_BRACE",
3380 "that open brace { should be on the previous line\n" .
01464f30 3381 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
00df344f 3382 }
773647a0
AW
3383 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3384 $ctx =~ /\)\s*\;\s*$/ &&
3385 defined $lines[$ctx_ln - 1])
3386 {
9c0ca6f9
AW
3387 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3388 if ($nindent > $indent) {
000d1cc1
JP
3389 WARN("TRAILING_SEMICOLON",
3390 "trailing semicolon indicates no statements, indent implies otherwise\n" .
01464f30 3391 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
9c0ca6f9
AW
3392 }
3393 }
00df344f
AW
3394 }
3395
4d001e4d 3396# Check relative indent for conditionals and blocks.
f6950a73 3397 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3e469cdc
AW
3398 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3399 ctx_statement_block($linenr, $realcnt, 0)
3400 if (!defined $stat);
4d001e4d
AW
3401 my ($s, $c) = ($stat, $cond);
3402
3403 substr($s, 0, length($c), '');
3404
9f5af480
JP
3405 # remove inline comments
3406 $s =~ s/$;/ /g;
3407 $c =~ s/$;/ /g;
4d001e4d
AW
3408
3409 # Find out how long the conditional actually is.
6f779c18
AW
3410 my @newlines = ($c =~ /\n/gs);
3411 my $cond_lines = 1 + $#newlines;
4d001e4d 3412
9f5af480
JP
3413 # Make sure we remove the line prefixes as we have
3414 # none on the first line, and are going to readd them
3415 # where necessary.
3416 $s =~ s/\n./\n/gs;
3417 while ($s =~ /\n\s+\\\n/) {
3418 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3419 }
3420
4d001e4d
AW
3421 # We want to check the first line inside the block
3422 # starting at the end of the conditional, so remove:
3423 # 1) any blank line termination
3424 # 2) any opening brace { on end of the line
3425 # 3) any do (...) {
3426 my $continuation = 0;
3427 my $check = 0;
3428 $s =~ s/^.*\bdo\b//;
3429 $s =~ s/^\s*{//;
3430 if ($s =~ s/^\s*\\//) {
3431 $continuation = 1;
3432 }
9bd49efe 3433 if ($s =~ s/^\s*?\n//) {
4d001e4d
AW
3434 $check = 1;
3435 $cond_lines++;
3436 }
3437
3438 # Also ignore a loop construct at the end of a
3439 # preprocessor statement.
3440 if (($prevline =~ /^.\s*#\s*define\s/ ||
3441 $prevline =~ /\\\s*$/) && $continuation == 0) {
3442 $check = 0;
3443 }
3444
9bd49efe 3445 my $cond_ptr = -1;
740504c6 3446 $continuation = 0;
9bd49efe
AW
3447 while ($cond_ptr != $cond_lines) {
3448 $cond_ptr = $cond_lines;
3449
f16fa28f
AW
3450 # If we see an #else/#elif then the code
3451 # is not linear.
3452 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3453 $check = 0;
3454 }
3455
9bd49efe
AW
3456 # Ignore:
3457 # 1) blank lines, they should be at 0,
3458 # 2) preprocessor lines, and
3459 # 3) labels.
740504c6
AW
3460 if ($continuation ||
3461 $s =~ /^\s*?\n/ ||
9bd49efe
AW
3462 $s =~ /^\s*#\s*?/ ||
3463 $s =~ /^\s*$Ident\s*:/) {
740504c6 3464 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
30dad6eb
AW
3465 if ($s =~ s/^.*?\n//) {
3466 $cond_lines++;
3467 }
9bd49efe 3468 }
4d001e4d
AW
3469 }
3470
3471 my (undef, $sindent) = line_stats("+" . $s);
3472 my $stat_real = raw_line($linenr, $cond_lines);
3473
3474 # Check if either of these lines are modified, else
3475 # this is not this patch's fault.
3476 if (!defined($stat_real) ||
3477 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3478 $check = 0;
3479 }
3480 if (defined($stat_real) && $cond_lines > 1) {
3481 $stat_real = "[...]\n$stat_real";
3482 }
3483
9bd49efe 3484 #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 3485
9f5af480
JP
3486 if ($check && $s ne '' &&
3487 (($sindent % 8) != 0 ||
3488 ($sindent < $indent) ||
f6950a73
JP
3489 ($sindent == $indent &&
3490 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
9f5af480 3491 ($sindent > $indent + 8))) {
000d1cc1
JP
3492 WARN("SUSPECT_CODE_INDENT",
3493 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
4d001e4d
AW
3494 }
3495 }
3496
6c72ffaa
AW
3497 # Track the 'values' across context and added lines.
3498 my $opline = $line; $opline =~ s/^./ /;
1f65f947
AW
3499 my ($curr_values, $curr_vars) =
3500 annotate_values($opline . "\n", $prev_values);
6c72ffaa 3501 $curr_values = $prev_values . $curr_values;
c2fdda0d
AW
3502 if ($dbg_values) {
3503 my $outline = $opline; $outline =~ s/\t/ /g;
cf655043
AW
3504 print "$linenr > .$outline\n";
3505 print "$linenr > $curr_values\n";
1f65f947 3506 print "$linenr > $curr_vars\n";
c2fdda0d 3507 }
6c72ffaa
AW
3508 $prev_values = substr($curr_values, -1);
3509
00df344f 3510#ignore lines not being added
3705ce5b 3511 next if ($line =~ /^[^\+]/);
00df344f 3512
11ca40a0
JP
3513# check for dereferences that span multiple lines
3514 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3515 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3516 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3517 my $ref = $1;
3518 $line =~ /^.\s*($Lval)/;
3519 $ref .= $1;
3520 $ref =~ s/\s//g;
3521 WARN("MULTILINE_DEREFERENCE",
3522 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3523 }
3524
a1ce18e4 3525# check for declarations of signed or unsigned without int
c8447115 3526 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
a1ce18e4
JP
3527 my $type = $1;
3528 my $var = $2;
207a8e84
JP
3529 $var = "" if (!defined $var);
3530 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
a1ce18e4
JP
3531 my $sign = $1;
3532 my $pointer = $2;
3533
3534 $pointer = "" if (!defined $pointer);
3535
3536 if (WARN("UNSPECIFIED_INT",
3537 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3538 $fix) {
3539 my $decl = trim($sign) . " int ";
207a8e84
JP
3540 my $comp_pointer = $pointer;
3541 $comp_pointer =~ s/\s//g;
3542 $decl .= $comp_pointer;
3543 $decl = rtrim($decl) if ($var eq "");
3544 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
a1ce18e4
JP
3545 }
3546 }
3547 }
3548
653d4876 3549# TEST: allow direct testing of the type matcher.
7429c690
AW
3550 if ($dbg_type) {
3551 if ($line =~ /^.\s*$Declare\s*$/) {
000d1cc1
JP
3552 ERROR("TEST_TYPE",
3553 "TEST: is type\n" . $herecurr);
7429c690 3554 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
000d1cc1
JP
3555 ERROR("TEST_NOT_TYPE",
3556 "TEST: is not type ($1 is)\n". $herecurr);
7429c690 3557 }
653d4876
AW
3558 next;
3559 }
a1ef277e
AW
3560# TEST: allow direct testing of the attribute matcher.
3561 if ($dbg_attr) {
9360b0e5 3562 if ($line =~ /^.\s*$Modifier\s*$/) {
000d1cc1
JP
3563 ERROR("TEST_ATTR",
3564 "TEST: is attr\n" . $herecurr);
9360b0e5 3565 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
000d1cc1
JP
3566 ERROR("TEST_NOT_ATTR",
3567 "TEST: is not attr ($1 is)\n". $herecurr);
a1ef277e
AW
3568 }
3569 next;
3570 }
653d4876 3571
f0a594c1 3572# check for initialisation to aggregates open brace on the next line
99423c20
AW
3573 if ($line =~ /^.\s*{/ &&
3574 $prevline =~ /(?:^|[^=])=\s*$/) {
d752fcc8
JP
3575 if (ERROR("OPEN_BRACE",
3576 "that open brace { should be on the previous line\n" . $hereprev) &&
f2d7e4d4
JP
3577 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3578 fix_delete_line($fixlinenr - 1, $prevrawline);
3579 fix_delete_line($fixlinenr, $rawline);
d752fcc8
JP
3580 my $fixedline = $prevrawline;
3581 $fixedline =~ s/\s*=\s*$/ = {/;
f2d7e4d4 3582 fix_insert_line($fixlinenr, $fixedline);
d752fcc8 3583 $fixedline = $line;
8d81ae05 3584 $fixedline =~ s/^(.\s*)\{\s*/$1/;
f2d7e4d4 3585 fix_insert_line($fixlinenr, $fixedline);
d752fcc8 3586 }
f0a594c1
AW
3587 }
3588
653d4876
AW
3589#
3590# Checks which are anchored on the added line.
3591#
3592
3593# check for malformed paths in #include statements (uses RAW line)
c45dcabd 3594 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
653d4876
AW
3595 my $path = $1;
3596 if ($path =~ m{//}) {
000d1cc1 3597 ERROR("MALFORMED_INCLUDE",
495e9d84
JP
3598 "malformed #include filename\n" . $herecurr);
3599 }
3600 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3601 ERROR("UAPI_INCLUDE",
3602 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
653d4876 3603 }
653d4876 3604 }
00df344f 3605
0a920b5b 3606# no C99 // comments
00df344f 3607 if ($line =~ m{//}) {
3705ce5b
JP
3608 if (ERROR("C99_COMMENTS",
3609 "do not use C99 // comments\n" . $herecurr) &&
3610 $fix) {
194f66fc 3611 my $line = $fixed[$fixlinenr];
3705ce5b
JP
3612 if ($line =~ /\/\/(.*)$/) {
3613 my $comment = trim($1);
194f66fc 3614 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3705ce5b
JP
3615 }
3616 }
0a920b5b 3617 }
00df344f 3618 # Remove C99 comments.
0a920b5b 3619 $line =~ s@//.*@@;
6c72ffaa 3620 $opline =~ s@//.*@@;
0a920b5b 3621
2b474a1a
AW
3622# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3623# the whole statement.
3624#print "APW <$lines[$realline_next - 1]>\n";
3625 if (defined $realline_next &&
3626 exists $lines[$realline_next - 1] &&
3627 !defined $suppress_export{$realline_next} &&
3628 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3629 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3cbf62df
AW
3630 # Handle definitions which produce identifiers with
3631 # a prefix:
3632 # XXX(foo);
3633 # EXPORT_SYMBOL(something_foo);
653d4876 3634 my $name = $1;
87a53877 3635 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3cbf62df
AW
3636 $name =~ /^${Ident}_$2/) {
3637#print "FOO C name<$name>\n";
3638 $suppress_export{$realline_next} = 1;
3639
3640 } elsif ($stat !~ /(?:
2b474a1a 3641 \n.}\s*$|
48012058
AW
3642 ^.DEFINE_$Ident\(\Q$name\E\)|
3643 ^.DECLARE_$Ident\(\Q$name\E\)|
3644 ^.LIST_HEAD\(\Q$name\E\)|
2b474a1a
AW
3645 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3646 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
48012058 3647 )/x) {
2b474a1a
AW
3648#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3649 $suppress_export{$realline_next} = 2;
3650 } else {
3651 $suppress_export{$realline_next} = 1;
0a920b5b
AW
3652 }
3653 }
2b474a1a
AW
3654 if (!defined $suppress_export{$linenr} &&
3655 $prevline =~ /^.\s*$/ &&
3656 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3657 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3658#print "FOO B <$lines[$linenr - 1]>\n";
3659 $suppress_export{$linenr} = 2;
3660 }
3661 if (defined $suppress_export{$linenr} &&
3662 $suppress_export{$linenr} == 2) {
000d1cc1
JP
3663 WARN("EXPORT_SYMBOL",
3664 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2b474a1a 3665 }
0a920b5b 3666
5150bda4 3667# check for global initialisers.
6d32f7a3 3668 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
d5e616fc 3669 if (ERROR("GLOBAL_INITIALISERS",
6d32f7a3 3670 "do not initialise globals to $1\n" . $herecurr) &&
d5e616fc 3671 $fix) {
6d32f7a3 3672 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
d5e616fc 3673 }
f0a594c1 3674 }
653d4876 3675# check for static initialisers.
6d32f7a3 3676 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
d5e616fc 3677 if (ERROR("INITIALISED_STATIC",
6d32f7a3 3678 "do not initialise statics to $1\n" .
d5e616fc
JP
3679 $herecurr) &&
3680 $fix) {
6d32f7a3 3681 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
d5e616fc 3682 }
0a920b5b
AW
3683 }
3684
1813087d
JP
3685# check for misordered declarations of char/short/int/long with signed/unsigned
3686 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3687 my $tmp = trim($1);
3688 WARN("MISORDERED_TYPE",
3689 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3690 }
3691
cb710eca
JP
3692# check for static const char * arrays.
3693 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
000d1cc1
JP
3694 WARN("STATIC_CONST_CHAR_ARRAY",
3695 "static const char * array should probably be static const char * const\n" .
cb710eca
JP
3696 $herecurr);
3697 }
3698
3699# check for static char foo[] = "bar" declarations.
3700 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
000d1cc1
JP
3701 WARN("STATIC_CONST_CHAR_ARRAY",
3702 "static char array declaration should probably be static const char\n" .
cb710eca
JP
3703 $herecurr);
3704 }
3705
ab7e23f3
JP
3706# check for const <foo> const where <foo> is not a pointer or array type
3707 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3708 my $found = $1;
3709 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3710 WARN("CONST_CONST",
3711 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3712 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3713 WARN("CONST_CONST",
3714 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3715 }
3716 }
3717
9b0fa60d
JP
3718# check for non-global char *foo[] = {"bar", ...} declarations.
3719 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3720 WARN("STATIC_CONST_CHAR_ARRAY",
3721 "char * array declaration might be better as static const\n" .
3722 $herecurr);
3723 }
3724
b598b670
JP
3725# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3726 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3727 my $array = $1;
3728 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3729 my $array_div = $1;
3730 if (WARN("ARRAY_SIZE",
3731 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3732 $fix) {
3733 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3734 }
3735 }
3736 }
3737
b36190c5
JP
3738# check for function declarations without arguments like "int foo()"
3739 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3740 if (ERROR("FUNCTION_WITHOUT_ARGS",
3741 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3742 $fix) {
194f66fc 3743 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
b36190c5
JP
3744 }
3745 }
3746
653d4876
AW
3747# check for new typedefs, only function parameters and sparse annotations
3748# make sense.
3749 if ($line =~ /\btypedef\s/ &&
8054576d 3750 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
c45dcabd 3751 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
8ed22cad 3752 $line !~ /\b$typeTypedefs\b/ &&
46d832f5 3753 $line !~ /\b__bitwise\b/) {
000d1cc1
JP
3754 WARN("NEW_TYPEDEFS",
3755 "do not add new typedefs\n" . $herecurr);
0a920b5b
AW
3756 }
3757
3758# * goes on variable not on type
65863862 3759 # (char*[ const])
bfcb2cc7
AW
3760 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3761 #print "AA<$1>\n";
3705ce5b 3762 my ($ident, $from, $to) = ($1, $2, $2);
65863862
AW
3763
3764 # Should start with a space.
3765 $to =~ s/^(\S)/ $1/;
3766 # Should not end with a space.
3767 $to =~ s/\s+$//;
3768 # '*'s should not have spaces between.
f9a0b3d1 3769 while ($to =~ s/\*\s+\*/\*\*/) {
65863862 3770 }
d8aaf121 3771
3705ce5b 3772## print "1: from<$from> to<$to> ident<$ident>\n";
65863862 3773 if ($from ne $to) {
3705ce5b
JP
3774 if (ERROR("POINTER_LOCATION",
3775 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3776 $fix) {
3777 my $sub_from = $ident;
3778 my $sub_to = $ident;
3779 $sub_to =~ s/\Q$from\E/$to/;
194f66fc 3780 $fixed[$fixlinenr] =~
3705ce5b
JP
3781 s@\Q$sub_from\E@$sub_to@;
3782 }
65863862 3783 }
bfcb2cc7
AW
3784 }
3785 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3786 #print "BB<$1>\n";
3705ce5b 3787 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
65863862
AW
3788
3789 # Should start with a space.
3790 $to =~ s/^(\S)/ $1/;
3791 # Should not end with a space.
3792 $to =~ s/\s+$//;
3793 # '*'s should not have spaces between.
f9a0b3d1 3794 while ($to =~ s/\*\s+\*/\*\*/) {
65863862
AW
3795 }
3796 # Modifiers should have spaces.
3797 $to =~ s/(\b$Modifier$)/$1 /;
d8aaf121 3798
3705ce5b 3799## print "2: from<$from> to<$to> ident<$ident>\n";
667026e7 3800 if ($from ne $to && $ident !~ /^$Modifier$/) {
3705ce5b
JP
3801 if (ERROR("POINTER_LOCATION",
3802 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3803 $fix) {
3804
3805 my $sub_from = $match;
3806 my $sub_to = $match;
3807 $sub_to =~ s/\Q$from\E/$to/;
194f66fc 3808 $fixed[$fixlinenr] =~
3705ce5b
JP
3809 s@\Q$sub_from\E@$sub_to@;
3810 }
65863862 3811 }
0a920b5b
AW
3812 }
3813
9d3e3c70
JP
3814# avoid BUG() or BUG_ON()
3815 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
0675a8fb
JD
3816 my $msg_level = \&WARN;
3817 $msg_level = \&CHK if ($file);
3818 &{$msg_level}("AVOID_BUG",
3819 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
9d3e3c70 3820 }
0a920b5b 3821
9d3e3c70 3822# avoid LINUX_VERSION_CODE
8905a67c 3823 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
000d1cc1
JP
3824 WARN("LINUX_VERSION_CODE",
3825 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
8905a67c
AW
3826 }
3827
17441227
JP
3828# check for uses of printk_ratelimit
3829 if ($line =~ /\bprintk_ratelimit\s*\(/) {
000d1cc1 3830 WARN("PRINTK_RATELIMITED",
101ee680 3831 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
17441227
JP
3832 }
3833
eeef5733
JP
3834# printk should use KERN_* levels
3835 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
3836 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3837 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
0a920b5b
AW
3838 }
3839
243f3803
JP
3840 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3841 my $orig = $1;
3842 my $level = lc($orig);
3843 $level = "warn" if ($level eq "warning");
8f26b837
JP
3844 my $level2 = $level;
3845 $level2 = "dbg" if ($level eq "debug");
243f3803 3846 WARN("PREFER_PR_LEVEL",
daa8b059 3847 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
243f3803
JP
3848 }
3849
3850 if ($line =~ /\bpr_warning\s*\(/) {
d5e616fc
JP
3851 if (WARN("PREFER_PR_LEVEL",
3852 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3853 $fix) {
194f66fc 3854 $fixed[$fixlinenr] =~
d5e616fc
JP
3855 s/\bpr_warning\b/pr_warn/;
3856 }
243f3803
JP
3857 }
3858
dc139313
JP
3859 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3860 my $orig = $1;
3861 my $level = lc($orig);
3862 $level = "warn" if ($level eq "warning");
3863 $level = "dbg" if ($level eq "debug");
3864 WARN("PREFER_DEV_LEVEL",
3865 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3866 }
3867
91c9afaf
AL
3868# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3869# number of false positives, but assembly files are not checked, so at
3870# least the arch entry code will not trigger this warning.
3871 if ($line =~ /\bENOSYS\b/) {
3872 WARN("ENOSYS",
3873 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3874 }
3875
653d4876
AW
3876# function brace can't be on same line, except for #defines of do while,
3877# or if closed on same line
8d182478 3878 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
4e5d56bd 3879 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
8d182478
JP
3880 if (ERROR("OPEN_BRACE",
3881 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3882 $fix) {
3883 fix_delete_line($fixlinenr, $rawline);
3884 my $fixed_line = $rawline;
3885 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3886 my $line1 = $1;
3887 my $line2 = $2;
3888 fix_insert_line($fixlinenr, ltrim($line1));
3889 fix_insert_line($fixlinenr, "\+{");
3890 if ($line2 !~ /^\s*$/) {
3891 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3892 }
3893 }
0a920b5b 3894 }
653d4876 3895
8905a67c
AW
3896# open braces for enum, union and struct go on the same line.
3897 if ($line =~ /^.\s*{/ &&
3898 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
8d182478
JP
3899 if (ERROR("OPEN_BRACE",
3900 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3901 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3902 fix_delete_line($fixlinenr - 1, $prevrawline);
3903 fix_delete_line($fixlinenr, $rawline);
3904 my $fixedline = rtrim($prevrawline) . " {";
3905 fix_insert_line($fixlinenr, $fixedline);
3906 $fixedline = $rawline;
8d81ae05 3907 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
8d182478
JP
3908 if ($fixedline !~ /^\+\s*$/) {
3909 fix_insert_line($fixlinenr, $fixedline);
3910 }
3911 }
8905a67c
AW
3912 }
3913
0c73b4eb 3914# missing space after union, struct or enum definition
3705ce5b
JP
3915 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3916 if (WARN("SPACING",
3917 "missing space after $1 definition\n" . $herecurr) &&
3918 $fix) {
194f66fc 3919 $fixed[$fixlinenr] =~
3705ce5b
JP
3920 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3921 }
0c73b4eb
AW
3922 }
3923
31070b5d
JP
3924# Function pointer declarations
3925# check spacing between type, funcptr, and args
3926# canonical declaration is "type (*funcptr)(args...)"
91f72e9c 3927 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
31070b5d
JP
3928 my $declare = $1;
3929 my $pre_pointer_space = $2;
3930 my $post_pointer_space = $3;
3931 my $funcname = $4;
3932 my $post_funcname_space = $5;
3933 my $pre_args_space = $6;
3934
91f72e9c
JP
3935# the $Declare variable will capture all spaces after the type
3936# so check it for a missing trailing missing space but pointer return types
3937# don't need a space so don't warn for those.
3938 my $post_declare_space = "";
3939 if ($declare =~ /(\s+)$/) {
3940 $post_declare_space = $1;
3941 $declare = rtrim($declare);
3942 }
3943 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
31070b5d
JP
3944 WARN("SPACING",
3945 "missing space after return type\n" . $herecurr);
91f72e9c 3946 $post_declare_space = " ";
31070b5d
JP
3947 }
3948
3949# unnecessary space "type (*funcptr)(args...)"
91f72e9c
JP
3950# This test is not currently implemented because these declarations are
3951# equivalent to
3952# int foo(int bar, ...)
3953# and this is form shouldn't/doesn't generate a checkpatch warning.
3954#
3955# elsif ($declare =~ /\s{2,}$/) {
3956# WARN("SPACING",
3957# "Multiple spaces after return type\n" . $herecurr);
3958# }
31070b5d
JP
3959
3960# unnecessary space "type ( *funcptr)(args...)"
3961 if (defined $pre_pointer_space &&
3962 $pre_pointer_space =~ /^\s/) {
3963 WARN("SPACING",
3964 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3965 }
3966
3967# unnecessary space "type (* funcptr)(args...)"
3968 if (defined $post_pointer_space &&
3969 $post_pointer_space =~ /^\s/) {
3970 WARN("SPACING",
3971 "Unnecessary space before function pointer name\n" . $herecurr);
3972 }
3973
3974# unnecessary space "type (*funcptr )(args...)"
3975 if (defined $post_funcname_space &&
3976 $post_funcname_space =~ /^\s/) {
3977 WARN("SPACING",
3978 "Unnecessary space after function pointer name\n" . $herecurr);
3979 }
3980
3981# unnecessary space "type (*funcptr) (args...)"
3982 if (defined $pre_args_space &&
3983 $pre_args_space =~ /^\s/) {
3984 WARN("SPACING",
3985 "Unnecessary space before function pointer arguments\n" . $herecurr);
3986 }
3987
3988 if (show_type("SPACING") && $fix) {
194f66fc 3989 $fixed[$fixlinenr] =~
91f72e9c 3990 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
31070b5d
JP
3991 }
3992 }
3993
8d31cfce
AW
3994# check for spacing round square brackets; allowed:
3995# 1. with a type on the left -- int [] a;
fe2a7dbc
AW
3996# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3997# 3. inside a curly brace -- = { [0...10] = 5 }
8d31cfce
AW
3998 while ($line =~ /(.*?\s)\[/g) {
3999 my ($where, $prefix) = ($-[1], $1);
4000 if ($prefix !~ /$Type\s+$/ &&
fe2a7dbc 4001 ($where != 0 || $prefix !~ /^.\s+$/) &&
daebc534 4002 $prefix !~ /[{,]\s+$/) {
3705ce5b
JP
4003 if (ERROR("BRACKET_SPACE",
4004 "space prohibited before open square bracket '['\n" . $herecurr) &&
4005 $fix) {
194f66fc 4006 $fixed[$fixlinenr] =~
3705ce5b
JP
4007 s/^(\+.*?)\s+\[/$1\[/;
4008 }
8d31cfce
AW
4009 }
4010 }
4011
f0a594c1 4012# check for spaces between functions and their parentheses.
6c72ffaa 4013 while ($line =~ /($Ident)\s+\(/g) {
c2fdda0d 4014 my $name = $1;
773647a0
AW
4015 my $ctx_before = substr($line, 0, $-[1]);
4016 my $ctx = "$ctx_before$name";
c2fdda0d
AW
4017
4018 # Ignore those directives where spaces _are_ permitted.
773647a0
AW
4019 if ($name =~ /^(?:
4020 if|for|while|switch|return|case|
4021 volatile|__volatile__|
4022 __attribute__|format|__extension__|
4023 asm|__asm__)$/x)
4024 {
c2fdda0d
AW
4025 # cpp #define statements have non-optional spaces, ie
4026 # if there is a space between the name and the open
4027 # parenthesis it is simply not a parameter group.
c45dcabd 4028 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
773647a0
AW
4029
4030 # cpp #elif statement condition may start with a (
c45dcabd 4031 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
c2fdda0d
AW
4032
4033 # If this whole things ends with a type its most
4034 # likely a typedef for a function.
773647a0 4035 } elsif ($ctx =~ /$Type$/) {
c2fdda0d
AW
4036
4037 } else {
3705ce5b
JP
4038 if (WARN("SPACING",
4039 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4040 $fix) {
194f66fc 4041 $fixed[$fixlinenr] =~
3705ce5b
JP
4042 s/\b$name\s+\(/$name\(/;
4043 }
6c72ffaa 4044 }
f0a594c1 4045 }
9a4cad4e 4046
653d4876 4047# Check operator spacing.
0a920b5b 4048 if (!($line=~/\#\s*include/)) {
3705ce5b
JP
4049 my $fixed_line = "";
4050 my $line_fixed = 0;
4051
9c0ca6f9
AW
4052 my $ops = qr{
4053 <<=|>>=|<=|>=|==|!=|
4054 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4055 =>|->|<<|>>|<|>|=|!|~|
1f65f947 4056 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
84731623 4057 \?:|\?|:
9c0ca6f9 4058 }x;
cf655043 4059 my @elements = split(/($ops|;)/, $opline);
3705ce5b
JP
4060
4061## print("element count: <" . $#elements . ">\n");
4062## foreach my $el (@elements) {
4063## print("el: <$el>\n");
4064## }
4065
4066 my @fix_elements = ();
00df344f 4067 my $off = 0;
6c72ffaa 4068
3705ce5b
JP
4069 foreach my $el (@elements) {
4070 push(@fix_elements, substr($rawline, $off, length($el)));
4071 $off += length($el);
4072 }
4073
4074 $off = 0;
4075
6c72ffaa 4076 my $blank = copy_spacing($opline);
b34c648b 4077 my $last_after = -1;
6c72ffaa 4078
0a920b5b 4079 for (my $n = 0; $n < $#elements; $n += 2) {
3705ce5b
JP
4080
4081 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4082
4083## print("n: <$n> good: <$good>\n");
4084
4a0df2ef
AW
4085 $off += length($elements[$n]);
4086
25985edc 4087 # Pick up the preceding and succeeding characters.
773647a0
AW
4088 my $ca = substr($opline, 0, $off);
4089 my $cc = '';
4090 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4091 $cc = substr($opline, $off + length($elements[$n + 1]));
4092 }
4093 my $cb = "$ca$;$cc";
4094
4a0df2ef
AW
4095 my $a = '';
4096 $a = 'V' if ($elements[$n] ne '');
4097 $a = 'W' if ($elements[$n] =~ /\s$/);
cf655043 4098 $a = 'C' if ($elements[$n] =~ /$;$/);
4a0df2ef
AW
4099 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4100 $a = 'O' if ($elements[$n] eq '');
773647a0 4101 $a = 'E' if ($ca =~ /^\s*$/);
4a0df2ef 4102
0a920b5b 4103 my $op = $elements[$n + 1];
4a0df2ef
AW
4104
4105 my $c = '';
0a920b5b 4106 if (defined $elements[$n + 2]) {
4a0df2ef
AW
4107 $c = 'V' if ($elements[$n + 2] ne '');
4108 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
cf655043 4109 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
4a0df2ef
AW
4110 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4111 $c = 'O' if ($elements[$n + 2] eq '');
8b1b3378 4112 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
4a0df2ef
AW
4113 } else {
4114 $c = 'E';
0a920b5b
AW
4115 }
4116
4a0df2ef
AW
4117 my $ctx = "${a}x${c}";
4118
4119 my $at = "(ctx:$ctx)";
4120
6c72ffaa 4121 my $ptr = substr($blank, 0, $off) . "^";
de7d4f0e 4122 my $hereptr = "$hereline$ptr\n";
0a920b5b 4123
74048ed8 4124 # Pull out the value of this operator.
6c72ffaa 4125 my $op_type = substr($curr_values, $off + 1, 1);
0a920b5b 4126
1f65f947
AW
4127 # Get the full operator variant.
4128 my $opv = $op . substr($curr_vars, $off, 1);
4129
13214adf
AW
4130 # Ignore operators passed as parameters.
4131 if ($op_type ne 'V' &&
d7fe8065 4132 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
13214adf 4133
cf655043
AW
4134# # Ignore comments
4135# } elsif ($op =~ /^$;+$/) {
13214adf 4136
d8aaf121 4137 # ; should have either the end of line or a space or \ after it
13214adf 4138 } elsif ($op eq ';') {
cf655043
AW
4139 if ($ctx !~ /.x[WEBC]/ &&
4140 $cc !~ /^\\/ && $cc !~ /^;/) {
3705ce5b
JP
4141 if (ERROR("SPACING",
4142 "space required after that '$op' $at\n" . $hereptr)) {
b34c648b 4143 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3705ce5b
JP
4144 $line_fixed = 1;
4145 }
d8aaf121
AW
4146 }
4147
4148 # // is a comment
4149 } elsif ($op eq '//') {
0a920b5b 4150
b00e4814
JP
4151 # : when part of a bitfield
4152 } elsif ($opv eq ':B') {
4153 # skip the bitfield test for now
4154
1f65f947
AW
4155 # No spaces for:
4156 # ->
b00e4814 4157 } elsif ($op eq '->') {
4a0df2ef 4158 if ($ctx =~ /Wx.|.xW/) {
3705ce5b
JP
4159 if (ERROR("SPACING",
4160 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
b34c648b 4161 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3705ce5b
JP
4162 if (defined $fix_elements[$n + 2]) {
4163 $fix_elements[$n + 2] =~ s/^\s+//;
4164 }
b34c648b 4165 $line_fixed = 1;
3705ce5b 4166 }
0a920b5b
AW
4167 }
4168
2381097b 4169 # , must not have a space before and must have a space on the right.
0a920b5b 4170 } elsif ($op eq ',') {
2381097b
JP
4171 my $rtrim_before = 0;
4172 my $space_after = 0;
4173 if ($ctx =~ /Wx./) {
4174 if (ERROR("SPACING",
4175 "space prohibited before that '$op' $at\n" . $hereptr)) {
4176 $line_fixed = 1;
4177 $rtrim_before = 1;
4178 }
4179 }
cf655043 4180 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
3705ce5b
JP
4181 if (ERROR("SPACING",
4182 "space required after that '$op' $at\n" . $hereptr)) {
3705ce5b 4183 $line_fixed = 1;
b34c648b 4184 $last_after = $n;
2381097b
JP
4185 $space_after = 1;
4186 }
4187 }
4188 if ($rtrim_before || $space_after) {
4189 if ($rtrim_before) {
4190 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4191 } else {
4192 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4193 }
4194 if ($space_after) {
4195 $good .= " ";
3705ce5b 4196 }
0a920b5b
AW
4197 }
4198
9c0ca6f9 4199 # '*' as part of a type definition -- reported already.
74048ed8 4200 } elsif ($opv eq '*_') {
9c0ca6f9
AW
4201 #warn "'*' is part of type\n";
4202
4203 # unary operators should have a space before and
4204 # none after. May be left adjacent to another
4205 # unary operator, or a cast
4206 } elsif ($op eq '!' || $op eq '~' ||
74048ed8 4207 $opv eq '*U' || $opv eq '-U' ||
0d413866 4208 $opv eq '&U' || $opv eq '&&U') {
cf655043 4209 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
3705ce5b
JP
4210 if (ERROR("SPACING",
4211 "space required before that '$op' $at\n" . $hereptr)) {
b34c648b
JP
4212 if ($n != $last_after + 2) {
4213 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4214 $line_fixed = 1;
4215 }
3705ce5b 4216 }
0a920b5b 4217 }
a3340b35 4218 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
171ae1a4
AW
4219 # A unary '*' may be const
4220
4221 } elsif ($ctx =~ /.xW/) {
3705ce5b
JP
4222 if (ERROR("SPACING",
4223 "space prohibited after that '$op' $at\n" . $hereptr)) {
b34c648b 4224 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
3705ce5b
JP
4225 if (defined $fix_elements[$n + 2]) {
4226 $fix_elements[$n + 2] =~ s/^\s+//;
4227 }
b34c648b 4228 $line_fixed = 1;
3705ce5b 4229 }
0a920b5b
AW
4230 }
4231
4232 # unary ++ and unary -- are allowed no space on one side.
4233 } elsif ($op eq '++' or $op eq '--') {
773647a0 4234 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
3705ce5b
JP
4235 if (ERROR("SPACING",
4236 "space required one side of that '$op' $at\n" . $hereptr)) {
b34c648b 4237 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3705ce5b
JP
4238 $line_fixed = 1;
4239 }
773647a0
AW
4240 }
4241 if ($ctx =~ /Wx[BE]/ ||
4242 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
3705ce5b
JP
4243 if (ERROR("SPACING",
4244 "space prohibited before that '$op' $at\n" . $hereptr)) {
b34c648b 4245 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3705ce5b
JP
4246 $line_fixed = 1;
4247 }
0a920b5b 4248 }
773647a0 4249 if ($ctx =~ /ExW/) {
3705ce5b
JP
4250 if (ERROR("SPACING",
4251 "space prohibited after that '$op' $at\n" . $hereptr)) {
b34c648b 4252 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3705ce5b
JP
4253 if (defined $fix_elements[$n + 2]) {
4254 $fix_elements[$n + 2] =~ s/^\s+//;
4255 }
b34c648b 4256 $line_fixed = 1;
3705ce5b 4257 }
653d4876 4258 }
0a920b5b 4259
0a920b5b 4260 # << and >> may either have or not have spaces both sides
9c0ca6f9
AW
4261 } elsif ($op eq '<<' or $op eq '>>' or
4262 $op eq '&' or $op eq '^' or $op eq '|' or
4263 $op eq '+' or $op eq '-' or
c2fdda0d
AW
4264 $op eq '*' or $op eq '/' or
4265 $op eq '%')
0a920b5b 4266 {
d2e025f3
JP
4267 if ($check) {
4268 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4269 if (CHK("SPACING",
4270 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4271 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4272 $fix_elements[$n + 2] =~ s/^\s+//;
4273 $line_fixed = 1;
4274 }
4275 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4276 if (CHK("SPACING",
4277 "space preferred before that '$op' $at\n" . $hereptr)) {
4278 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4279 $line_fixed = 1;
4280 }
4281 }
4282 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
3705ce5b
JP
4283 if (ERROR("SPACING",
4284 "need consistent spacing around '$op' $at\n" . $hereptr)) {
b34c648b
JP
4285 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4286 if (defined $fix_elements[$n + 2]) {
4287 $fix_elements[$n + 2] =~ s/^\s+//;
4288 }
3705ce5b
JP
4289 $line_fixed = 1;
4290 }
0a920b5b
AW
4291 }
4292
1f65f947
AW
4293 # A colon needs no spaces before when it is
4294 # terminating a case value or a label.
4295 } elsif ($opv eq ':C' || $opv eq ':L') {
4296 if ($ctx =~ /Wx./) {
3705ce5b
JP
4297 if (ERROR("SPACING",
4298 "space prohibited before that '$op' $at\n" . $hereptr)) {
b34c648b 4299 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3705ce5b
JP
4300 $line_fixed = 1;
4301 }
1f65f947
AW
4302 }
4303
0a920b5b 4304 # All the others need spaces both sides.
cf655043 4305 } elsif ($ctx !~ /[EWC]x[CWE]/) {
1f65f947
AW
4306 my $ok = 0;
4307
22f2a2ef 4308 # Ignore email addresses <foo@bar>
1f65f947
AW
4309 if (($op eq '<' &&
4310 $cc =~ /^\S+\@\S+>/) ||
4311 ($op eq '>' &&
4312 $ca =~ /<\S+\@\S+$/))
4313 {
4314 $ok = 1;
4315 }
4316
e0df7e1f
JP
4317 # for asm volatile statements
4318 # ignore a colon with another
4319 # colon immediately before or after
4320 if (($op eq ':') &&
4321 ($ca =~ /:$/ || $cc =~ /^:/)) {
4322 $ok = 1;
4323 }
4324
84731623 4325 # messages are ERROR, but ?: are CHK
1f65f947 4326 if ($ok == 0) {
0675a8fb
JD
4327 my $msg_level = \&ERROR;
4328 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
84731623 4329
0675a8fb
JD
4330 if (&{$msg_level}("SPACING",
4331 "spaces required around that '$op' $at\n" . $hereptr)) {
b34c648b
JP
4332 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4333 if (defined $fix_elements[$n + 2]) {
4334 $fix_elements[$n + 2] =~ s/^\s+//;
4335 }
3705ce5b
JP
4336 $line_fixed = 1;
4337 }
22f2a2ef 4338 }
0a920b5b 4339 }
4a0df2ef 4340 $off += length($elements[$n + 1]);
3705ce5b
JP
4341
4342## print("n: <$n> GOOD: <$good>\n");
4343
4344 $fixed_line = $fixed_line . $good;
4345 }
4346
4347 if (($#elements % 2) == 0) {
4348 $fixed_line = $fixed_line . $fix_elements[$#elements];
0a920b5b 4349 }
3705ce5b 4350
194f66fc
JP
4351 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4352 $fixed[$fixlinenr] = $fixed_line;
3705ce5b
JP
4353 }
4354
4355
0a920b5b
AW
4356 }
4357
786b6326 4358# check for whitespace before a non-naked semicolon
d2e248e7 4359 if ($line =~ /^\+.*\S\s+;\s*$/) {
786b6326
JP
4360 if (WARN("SPACING",
4361 "space prohibited before semicolon\n" . $herecurr) &&
4362 $fix) {
194f66fc 4363 1 while $fixed[$fixlinenr] =~
786b6326
JP
4364 s/^(\+.*\S)\s+;/$1;/;
4365 }
4366 }
4367
f0a594c1
AW
4368# check for multiple assignments
4369 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
000d1cc1
JP
4370 CHK("MULTIPLE_ASSIGNMENTS",
4371 "multiple assignments should be avoided\n" . $herecurr);
f0a594c1
AW
4372 }
4373
22f2a2ef
AW
4374## # check for multiple declarations, allowing for a function declaration
4375## # continuation.
4376## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4377## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4378##
4379## # Remove any bracketed sections to ensure we do not
4380## # falsly report the parameters of functions.
4381## my $ln = $line;
4382## while ($ln =~ s/\([^\(\)]*\)//g) {
4383## }
4384## if ($ln =~ /,/) {
000d1cc1
JP
4385## WARN("MULTIPLE_DECLARATION",
4386## "declaring multiple variables together should be avoided\n" . $herecurr);
22f2a2ef
AW
4387## }
4388## }
f0a594c1 4389
0a920b5b 4390#need space before brace following if, while, etc
6b8c69e4 4391 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
4e5d56bd 4392 $line =~ /do\{/) {
3705ce5b
JP
4393 if (ERROR("SPACING",
4394 "space required before the open brace '{'\n" . $herecurr) &&
4395 $fix) {
8d81ae05 4396 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\)))\{/$1 {/;
3705ce5b 4397 }
de7d4f0e
AW
4398 }
4399
c4a62ef9
JP
4400## # check for blank lines before declarations
4401## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4402## $prevrawline =~ /^.\s*$/) {
4403## WARN("SPACING",
4404## "No blank lines before declarations\n" . $hereprev);
4405## }
4406##
4407
de7d4f0e
AW
4408# closing brace should have a space following it when it has anything
4409# on the line
4410 if ($line =~ /}(?!(?:,|;|\)))\S/) {
d5e616fc
JP
4411 if (ERROR("SPACING",
4412 "space required after that close brace '}'\n" . $herecurr) &&
4413 $fix) {
194f66fc 4414 $fixed[$fixlinenr] =~
d5e616fc
JP
4415 s/}((?!(?:,|;|\)))\S)/} $1/;
4416 }
0a920b5b
AW
4417 }
4418
22f2a2ef
AW
4419# check spacing on square brackets
4420 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
3705ce5b
JP
4421 if (ERROR("SPACING",
4422 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4423 $fix) {
194f66fc 4424 $fixed[$fixlinenr] =~
3705ce5b
JP
4425 s/\[\s+/\[/;
4426 }
22f2a2ef
AW
4427 }
4428 if ($line =~ /\s\]/) {
3705ce5b
JP
4429 if (ERROR("SPACING",
4430 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4431 $fix) {
194f66fc 4432 $fixed[$fixlinenr] =~
3705ce5b
JP
4433 s/\s+\]/\]/;
4434 }
22f2a2ef
AW
4435 }
4436
c45dcabd 4437# check spacing on parentheses
9c0ca6f9
AW
4438 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4439 $line !~ /for\s*\(\s+;/) {
3705ce5b
JP
4440 if (ERROR("SPACING",
4441 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4442 $fix) {
194f66fc 4443 $fixed[$fixlinenr] =~
3705ce5b
JP
4444 s/\(\s+/\(/;
4445 }
22f2a2ef 4446 }
13214adf 4447 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
c45dcabd
AW
4448 $line !~ /for\s*\(.*;\s+\)/ &&
4449 $line !~ /:\s+\)/) {
3705ce5b
JP
4450 if (ERROR("SPACING",
4451 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4452 $fix) {
194f66fc 4453 $fixed[$fixlinenr] =~
3705ce5b
JP
4454 s/\s+\)/\)/;
4455 }
22f2a2ef
AW
4456 }
4457
e2826fd0
JP
4458# check unnecessary parentheses around addressof/dereference single $Lvals
4459# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4460
4461 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
ea4acbb1
JP
4462 my $var = $1;
4463 if (CHK("UNNECESSARY_PARENTHESES",
4464 "Unnecessary parentheses around $var\n" . $herecurr) &&
4465 $fix) {
4466 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4467 }
4468 }
4469
4470# check for unnecessary parentheses around function pointer uses
4471# ie: (foo->bar)(); should be foo->bar();
4472# but not "if (foo->bar) (" to avoid some false positives
4473 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4474 my $var = $2;
4475 if (CHK("UNNECESSARY_PARENTHESES",
4476 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4477 $fix) {
4478 my $var2 = deparenthesize($var);
4479 $var2 =~ s/\s//g;
4480 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4481 }
4482 }
e2826fd0 4483
63b7c73e
JP
4484# check for unnecessary parentheses around comparisons in if uses
4485 if ($^V && $^V ge 5.10.0 && defined($stat) &&
4486 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4487 my $if_stat = $1;
4488 my $test = substr($2, 1, -1);
4489 my $herectx;
4490 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4491 my $match = $1;
4492 # avoid parentheses around potential macro args
4493 next if ($match =~ /^\s*\w+\s*$/);
4494 if (!defined($herectx)) {
4495 $herectx = $here . "\n";
4496 my $cnt = statement_rawlines($if_stat);
4497 for (my $n = 0; $n < $cnt; $n++) {
4498 my $rl = raw_line($linenr, $n);
4499 $herectx .= $rl . "\n";
4500 last if $rl =~ /^[ \+].*\{/;
4501 }
4502 }
4503 CHK("UNNECESSARY_PARENTHESES",
4504 "Unnecessary parentheses around '$match'\n" . $herectx);
4505 }
4506 }
4507
0a920b5b 4508#goto labels aren't indented, allow a single space however
4a0df2ef 4509 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
0a920b5b 4510 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
3705ce5b
JP
4511 if (WARN("INDENTED_LABEL",
4512 "labels should not be indented\n" . $herecurr) &&
4513 $fix) {
194f66fc 4514 $fixed[$fixlinenr] =~
3705ce5b
JP
4515 s/^(.)\s+/$1/;
4516 }
0a920b5b
AW
4517 }
4518
5b9553ab 4519# return is not a function
507e5141 4520 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
c45dcabd 4521 my $spacing = $1;
507e5141 4522 if ($^V && $^V ge 5.10.0 &&
5b9553ab
JP
4523 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4524 my $value = $1;
4525 $value = deparenthesize($value);
4526 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4527 ERROR("RETURN_PARENTHESES",
4528 "return is not a function, parentheses are not required\n" . $herecurr);
4529 }
c45dcabd 4530 } elsif ($spacing !~ /\s+/) {
000d1cc1
JP
4531 ERROR("SPACING",
4532 "space required before the open parenthesis '('\n" . $herecurr);
c45dcabd
AW
4533 }
4534 }
507e5141 4535
b43ae21b
JP
4536# unnecessary return in a void function
4537# at end-of-function, with the previous line a single leading tab, then return;
4538# and the line before that not a goto label target like "out:"
4539 if ($sline =~ /^[ \+]}\s*$/ &&
4540 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4541 $linenr >= 3 &&
4542 $lines[$linenr - 3] =~ /^[ +]/ &&
4543 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
9819cf25 4544 WARN("RETURN_VOID",
b43ae21b
JP
4545 "void function return statements are not generally useful\n" . $hereprev);
4546 }
9819cf25 4547
189248d8
JP
4548# if statements using unnecessary parentheses - ie: if ((foo == bar))
4549 if ($^V && $^V ge 5.10.0 &&
4550 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4551 my $openparens = $1;
4552 my $count = $openparens =~ tr@\(@\(@;
4553 my $msg = "";
4554 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4555 my $comp = $4; #Not $1 because of $LvalOrFunc
4556 $msg = " - maybe == should be = ?" if ($comp eq "==");
4557 WARN("UNNECESSARY_PARENTHESES",
4558 "Unnecessary parentheses$msg\n" . $herecurr);
4559 }
4560 }
4561
c5595fa2
JP
4562# comparisons with a constant or upper case identifier on the left
4563# avoid cases like "foo + BAR < baz"
4564# only fix matches surrounded by parentheses to avoid incorrect
4565# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4566 if ($^V && $^V ge 5.10.0 &&
4567 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4568 my $lead = $1;
4569 my $const = $2;
4570 my $comp = $3;
4571 my $to = $4;
4572 my $newcomp = $comp;
f39e1769 4573 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
c5595fa2
JP
4574 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4575 WARN("CONSTANT_COMPARISON",
4576 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4577 $fix) {
4578 if ($comp eq "<") {
4579 $newcomp = ">";
4580 } elsif ($comp eq "<=") {
4581 $newcomp = ">=";
4582 } elsif ($comp eq ">") {
4583 $newcomp = "<";
4584 } elsif ($comp eq ">=") {
4585 $newcomp = "<=";
4586 }
4587 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4588 }
4589 }
4590
f34e4a4f
JP
4591# Return of what appears to be an errno should normally be negative
4592 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
53a3c448
AW
4593 my $name = $1;
4594 if ($name ne 'EOF' && $name ne 'ERROR') {
000d1cc1 4595 WARN("USE_NEGATIVE_ERRNO",
f34e4a4f 4596 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
53a3c448
AW
4597 }
4598 }
c45dcabd 4599
0a920b5b 4600# Need a space before open parenthesis after if, while etc
3705ce5b
JP
4601 if ($line =~ /\b(if|while|for|switch)\(/) {
4602 if (ERROR("SPACING",
4603 "space required before the open parenthesis '('\n" . $herecurr) &&
4604 $fix) {
194f66fc 4605 $fixed[$fixlinenr] =~
3705ce5b
JP
4606 s/\b(if|while|for|switch)\(/$1 \(/;
4607 }
0a920b5b
AW
4608 }
4609
f5fe35dd
AW
4610# Check for illegal assignment in if conditional -- and check for trailing
4611# statements after the conditional.
170d3a22 4612 if ($line =~ /do\s*(?!{)/) {
3e469cdc
AW
4613 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4614 ctx_statement_block($linenr, $realcnt, 0)
4615 if (!defined $stat);
170d3a22
AW
4616 my ($stat_next) = ctx_statement_block($line_nr_next,
4617 $remain_next, $off_next);
4618 $stat_next =~ s/\n./\n /g;
4619 ##print "stat<$stat> stat_next<$stat_next>\n";
4620
4621 if ($stat_next =~ /^\s*while\b/) {
4622 # If the statement carries leading newlines,
4623 # then count those as offsets.
4624 my ($whitespace) =
4625 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4626 my $offset =
4627 statement_rawlines($whitespace) - 1;
4628
4629 $suppress_whiletrailers{$line_nr_next +
4630 $offset} = 1;
4631 }
4632 }
4633 if (!defined $suppress_whiletrailers{$linenr} &&
c11230f4 4634 defined($stat) && defined($cond) &&
170d3a22 4635 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
171ae1a4 4636 my ($s, $c) = ($stat, $cond);
8905a67c 4637
b53c8e10 4638 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
000d1cc1
JP
4639 ERROR("ASSIGN_IN_IF",
4640 "do not use assignment in if condition\n" . $herecurr);
8905a67c
AW
4641 }
4642
4643 # Find out what is on the end of the line after the
4644 # conditional.
773647a0 4645 substr($s, 0, length($c), '');
8905a67c 4646 $s =~ s/\n.*//g;
13214adf 4647 $s =~ s/$;//g; # Remove any comments
53210168
AW
4648 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4649 $c !~ /}\s*while\s*/)
773647a0 4650 {
bb44ad39
AW
4651 # Find out how long the conditional actually is.
4652 my @newlines = ($c =~ /\n/gs);
4653 my $cond_lines = 1 + $#newlines;
42bdf74c 4654 my $stat_real = '';
bb44ad39 4655
42bdf74c
HS
4656 $stat_real = raw_line($linenr, $cond_lines)
4657 . "\n" if ($cond_lines);
bb44ad39
AW
4658 if (defined($stat_real) && $cond_lines > 1) {
4659 $stat_real = "[...]\n$stat_real";
4660 }
4661
000d1cc1
JP
4662 ERROR("TRAILING_STATEMENTS",
4663 "trailing statements should be on next line\n" . $herecurr . $stat_real);
8905a67c
AW
4664 }
4665 }
4666
13214adf
AW
4667# Check for bitwise tests written as boolean
4668 if ($line =~ /
4669 (?:
4670 (?:\[|\(|\&\&|\|\|)
4671 \s*0[xX][0-9]+\s*
4672 (?:\&\&|\|\|)
4673 |
4674 (?:\&\&|\|\|)
4675 \s*0[xX][0-9]+\s*
4676 (?:\&\&|\|\||\)|\])
4677 )/x)
4678 {
000d1cc1
JP
4679 WARN("HEXADECIMAL_BOOLEAN_TEST",
4680 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
13214adf
AW
4681 }
4682
8905a67c 4683# if and else should not have general statements after it
13214adf
AW
4684 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4685 my $s = $1;
4686 $s =~ s/$;//g; # Remove any comments
4687 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
000d1cc1
JP
4688 ERROR("TRAILING_STATEMENTS",
4689 "trailing statements should be on next line\n" . $herecurr);
13214adf 4690 }
0a920b5b 4691 }
39667782
AW
4692# if should not continue a brace
4693 if ($line =~ /}\s*if\b/) {
000d1cc1 4694 ERROR("TRAILING_STATEMENTS",
048b123f 4695 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
39667782
AW
4696 $herecurr);
4697 }
a1080bf8
AW
4698# case and default should not have general statements after them
4699 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4700 $line !~ /\G(?:
3fef12d6 4701 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
a1080bf8
AW
4702 \s*return\s+
4703 )/xg)
4704 {
000d1cc1
JP
4705 ERROR("TRAILING_STATEMENTS",
4706 "trailing statements should be on next line\n" . $herecurr);
a1080bf8 4707 }
0a920b5b
AW
4708
4709 # Check for }<nl>else {, these must be at the same
4710 # indent level to be relevant to each other.
8b8856f4
JP
4711 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4712 $previndent == $indent) {
4713 if (ERROR("ELSE_AFTER_BRACE",
4714 "else should follow close brace '}'\n" . $hereprev) &&
4715 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4716 fix_delete_line($fixlinenr - 1, $prevrawline);
4717 fix_delete_line($fixlinenr, $rawline);
4718 my $fixedline = $prevrawline;
4719 $fixedline =~ s/}\s*$//;
4720 if ($fixedline !~ /^\+\s*$/) {
4721 fix_insert_line($fixlinenr, $fixedline);
4722 }
4723 $fixedline = $rawline;
4724 $fixedline =~ s/^(.\s*)else/$1} else/;
4725 fix_insert_line($fixlinenr, $fixedline);
4726 }
0a920b5b
AW
4727 }
4728
8b8856f4
JP
4729 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4730 $previndent == $indent) {
c2fdda0d
AW
4731 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4732
4733 # Find out what is on the end of the line after the
4734 # conditional.
773647a0 4735 substr($s, 0, length($c), '');
c2fdda0d
AW
4736 $s =~ s/\n.*//g;
4737
4738 if ($s =~ /^\s*;/) {
8b8856f4
JP
4739 if (ERROR("WHILE_AFTER_BRACE",
4740 "while should follow close brace '}'\n" . $hereprev) &&
4741 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4742 fix_delete_line($fixlinenr - 1, $prevrawline);
4743 fix_delete_line($fixlinenr, $rawline);
4744 my $fixedline = $prevrawline;
4745 my $trailing = $rawline;
4746 $trailing =~ s/^\+//;
4747 $trailing = trim($trailing);
4748 $fixedline =~ s/}\s*$/} $trailing/;
4749 fix_insert_line($fixlinenr, $fixedline);
4750 }
c2fdda0d
AW
4751 }
4752 }
4753
95e2c602 4754#Specific variable tests
323c1260
JP
4755 while ($line =~ m{($Constant|$Lval)}g) {
4756 my $var = $1;
95e2c602
JP
4757
4758#gcc binary extension
4759 if ($var =~ /^$Binary$/) {
d5e616fc
JP
4760 if (WARN("GCC_BINARY_CONSTANT",
4761 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4762 $fix) {
4763 my $hexval = sprintf("0x%x", oct($var));
194f66fc 4764 $fixed[$fixlinenr] =~
d5e616fc
JP
4765 s/\b$var\b/$hexval/;
4766 }
95e2c602
JP
4767 }
4768
4769#CamelCase
807bd26c 4770 if ($var !~ /^$Constant$/ &&
be79794b 4771 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
22735ce8 4772#Ignore Page<foo> variants
807bd26c 4773 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
22735ce8 4774#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
f5123576
JW
4775 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4776#Ignore some three character SI units explicitly, like MiB and KHz
4777 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
7e781f67
JP
4778 while ($var =~ m{($Ident)}g) {
4779 my $word = $1;
4780 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
d8b07710
JP
4781 if ($check) {
4782 seed_camelcase_includes();
4783 if (!$file && !$camelcase_file_seeded) {
4784 seed_camelcase_file($realfile);
4785 $camelcase_file_seeded = 1;
4786 }
4787 }
7e781f67
JP
4788 if (!defined $camelcase{$word}) {
4789 $camelcase{$word} = 1;
4790 CHK("CAMELCASE",
4791 "Avoid CamelCase: <$word>\n" . $herecurr);
4792 }
3445686a 4793 }
323c1260
JP
4794 }
4795 }
0a920b5b
AW
4796
4797#no spaces allowed after \ in define
d5e616fc
JP
4798 if ($line =~ /\#\s*define.*\\\s+$/) {
4799 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4800 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4801 $fix) {
194f66fc 4802 $fixed[$fixlinenr] =~ s/\s+$//;
d5e616fc 4803 }
0a920b5b
AW
4804 }
4805
0e212e0a
FF
4806# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4807# itself <asm/foo.h> (uses RAW line)
c45dcabd 4808 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
e09dec48
AW
4809 my $file = "$1.h";
4810 my $checkfile = "include/linux/$file";
4811 if (-f "$root/$checkfile" &&
4812 $realfile ne $checkfile &&
7840a94c 4813 $1 !~ /$allowed_asm_includes/)
c45dcabd 4814 {
0e212e0a
FF
4815 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4816 if ($asminclude > 0) {
4817 if ($realfile =~ m{^arch/}) {
4818 CHK("ARCH_INCLUDE_LINUX",
4819 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4820 } else {
4821 WARN("INCLUDE_LINUX",
4822 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4823 }
e09dec48 4824 }
0a920b5b
AW
4825 }
4826 }
4827
653d4876
AW
4828# multi-statement macros should be enclosed in a do while loop, grab the
4829# first statement and ensure its the whole macro if its not enclosed
cf655043 4830# in a known good container
b8f96a31
AW
4831 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4832 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
d8aaf121
AW
4833 my $ln = $linenr;
4834 my $cnt = $realcnt;
c45dcabd
AW
4835 my ($off, $dstat, $dcond, $rest);
4836 my $ctx = '';
08a2843e
JP
4837 my $has_flow_statement = 0;
4838 my $has_arg_concat = 0;
c45dcabd 4839 ($dstat, $dcond, $ln, $cnt, $off) =
f74bd194
AW
4840 ctx_statement_block($linenr, $realcnt, 0);
4841 $ctx = $dstat;
c45dcabd 4842 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
a3bb97a7 4843 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
c45dcabd 4844
08a2843e 4845 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
62e15a6d 4846 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
08a2843e 4847
f59b64bf
JP
4848 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
4849 my $define_args = $1;
4850 my $define_stmt = $dstat;
4851 my @def_args = ();
4852
4853 if (defined $define_args && $define_args ne "") {
4854 $define_args = substr($define_args, 1, length($define_args) - 2);
4855 $define_args =~ s/\s*//g;
4856 @def_args = split(",", $define_args);
4857 }
4858
292f1a9b 4859 $dstat =~ s/$;//g;
c45dcabd
AW
4860 $dstat =~ s/\\\n.//g;
4861 $dstat =~ s/^\s*//s;
4862 $dstat =~ s/\s*$//s;
de7d4f0e 4863
c45dcabd 4864 # Flatten any parentheses and braces
bf30d6ed
AW
4865 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4866 $dstat =~ s/\{[^\{\}]*\}/1/ ||
6b10df42 4867 $dstat =~ s/.\[[^\[\]]*\]/1/)
bf30d6ed 4868 {
de7d4f0e 4869 }
d8aaf121 4870
e45bab8e 4871 # Flatten any obvious string concatentation.
33acb54a
JP
4872 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4873 $dstat =~ s/$Ident\s*($String)/$1/)
e45bab8e
AW
4874 {
4875 }
4876
42e15293
JP
4877 # Make asm volatile uses seem like a generic function
4878 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4879
c45dcabd
AW
4880 my $exceptions = qr{
4881 $Declare|
4882 module_param_named|
a0a0a7a9 4883 MODULE_PARM_DESC|
c45dcabd
AW
4884 DECLARE_PER_CPU|
4885 DEFINE_PER_CPU|
383099fd 4886 __typeof__\(|
22fd2d3e
SS
4887 union|
4888 struct|
ea71a0a0 4889 \.$Ident\s*=\s*|
6b10df42
VZ
4890 ^\"|\"$|
4891 ^\[
c45dcabd 4892 }x;
5eaa20b9 4893 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
f59b64bf
JP
4894
4895 $ctx =~ s/\n*$//;
4896 my $herectx = $here . "\n";
4897 my $stmt_cnt = statement_rawlines($ctx);
4898
4899 for (my $n = 0; $n < $stmt_cnt; $n++) {
4900 $herectx .= raw_line($linenr, $n) . "\n";
4901 }
4902
f74bd194
AW
4903 if ($dstat ne '' &&
4904 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4905 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
3cc4b1c3 4906 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
356fd398 4907 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
f74bd194
AW
4908 $dstat !~ /$exceptions/ &&
4909 $dstat !~ /^\.$Ident\s*=/ && # .foo =
e942e2c3 4910 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
72f115f9 4911 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
f74bd194
AW
4912 $dstat !~ /^for\s*$Constant$/ && # for (...)
4913 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4914 $dstat !~ /^do\s*{/ && # do {...
4e5d56bd 4915 $dstat !~ /^\(\{/ && # ({...
f95a7e6a 4916 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
f74bd194 4917 {
e795556a
JP
4918 if ($dstat =~ /^\s*if\b/) {
4919 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4920 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
4921 } elsif ($dstat =~ /;/) {
f74bd194
AW
4922 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4923 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4924 } else {
000d1cc1 4925 ERROR("COMPLEX_MACRO",
388982b5 4926 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
d8aaf121 4927 }
f59b64bf
JP
4928
4929 }
5207649b
JP
4930
4931 # Make $define_stmt single line, comment-free, etc
4932 my @stmt_array = split('\n', $define_stmt);
4933 my $first = 1;
4934 $define_stmt = "";
4935 foreach my $l (@stmt_array) {
4936 $l =~ s/\\$//;
4937 if ($first) {
4938 $define_stmt = $l;
4939 $first = 0;
4940 } elsif ($l =~ /^[\+ ]/) {
4941 $define_stmt .= substr($l, 1);
4942 }
4943 }
4944 $define_stmt =~ s/$;//g;
4945 $define_stmt =~ s/\s+/ /g;
4946 $define_stmt = trim($define_stmt);
4947
f59b64bf
JP
4948# check if any macro arguments are reused (ignore '...' and 'type')
4949 foreach my $arg (@def_args) {
4950 next if ($arg =~ /\.\.\./);
9192d41a 4951 next if ($arg =~ /^type$/i);
7fe528a2
JP
4952 my $tmp_stmt = $define_stmt;
4953 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
4954 $tmp_stmt =~ s/\#+\s*$arg\b//g;
4955 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
4956 my $use_cnt = $tmp_stmt =~ s/\b$arg\b//g;
f59b64bf
JP
4957 if ($use_cnt > 1) {
4958 CHK("MACRO_ARG_REUSE",
4959 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
9192d41a
JP
4960 }
4961# check if any macro arguments may have other precedence issues
7fe528a2 4962 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
9192d41a
JP
4963 ((defined($1) && $1 ne ',') ||
4964 (defined($2) && $2 ne ','))) {
4965 CHK("MACRO_ARG_PRECEDENCE",
4966 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
f59b64bf 4967 }
653d4876 4968 }
5023d347 4969
08a2843e
JP
4970# check for macros with flow control, but without ## concatenation
4971# ## concatenation is commonly a macro that defines a function so ignore those
4972 if ($has_flow_statement && !$has_arg_concat) {
4973 my $herectx = $here . "\n";
4974 my $cnt = statement_rawlines($ctx);
4975
4976 for (my $n = 0; $n < $cnt; $n++) {
4977 $herectx .= raw_line($linenr, $n) . "\n";
4978 }
4979 WARN("MACRO_WITH_FLOW_CONTROL",
4980 "Macros with flow control statements should be avoided\n" . "$herectx");
4981 }
4982
481eb486 4983# check for line continuations outside of #defines, preprocessor #, and asm
5023d347
JP
4984
4985 } else {
4986 if ($prevline !~ /^..*\\$/ &&
481eb486
JP
4987 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4988 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
5023d347
JP
4989 $line =~ /^\+.*\\$/) {
4990 WARN("LINE_CONTINUATIONS",
4991 "Avoid unnecessary line continuations\n" . $herecurr);
4992 }
0a920b5b
AW
4993 }
4994
b13edf7f
JP
4995# do {} while (0) macro tests:
4996# single-statement macros do not need to be enclosed in do while (0) loop,
4997# macro should not end with a semicolon
4998 if ($^V && $^V ge 5.10.0 &&
4999 $realfile !~ m@/vmlinux.lds.h$@ &&
5000 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5001 my $ln = $linenr;
5002 my $cnt = $realcnt;
5003 my ($off, $dstat, $dcond, $rest);
5004 my $ctx = '';
5005 ($dstat, $dcond, $ln, $cnt, $off) =
5006 ctx_statement_block($linenr, $realcnt, 0);
5007 $ctx = $dstat;
5008
5009 $dstat =~ s/\\\n.//g;
1b36b201 5010 $dstat =~ s/$;/ /g;
b13edf7f
JP
5011
5012 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5013 my $stmts = $2;
5014 my $semis = $3;
5015
5016 $ctx =~ s/\n*$//;
5017 my $cnt = statement_rawlines($ctx);
5018 my $herectx = $here . "\n";
5019
5020 for (my $n = 0; $n < $cnt; $n++) {
5021 $herectx .= raw_line($linenr, $n) . "\n";
5022 }
5023
ac8e97f8
JP
5024 if (($stmts =~ tr/;/;/) == 1 &&
5025 $stmts !~ /^\s*(if|while|for|switch)\b/) {
b13edf7f
JP
5026 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5027 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5028 }
5029 if (defined $semis && $semis ne "") {
5030 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5031 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5032 }
f5ef95b1
JP
5033 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5034 $ctx =~ s/\n*$//;
5035 my $cnt = statement_rawlines($ctx);
5036 my $herectx = $here . "\n";
5037
5038 for (my $n = 0; $n < $cnt; $n++) {
5039 $herectx .= raw_line($linenr, $n) . "\n";
5040 }
5041
5042 WARN("TRAILING_SEMICOLON",
5043 "macros should not use a trailing semicolon\n" . "$herectx");
b13edf7f
JP
5044 }
5045 }
5046
080ba929
MF
5047# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
5048# all assignments may have only one of the following with an assignment:
5049# .
5050# ALIGN(...)
5051# VMLINUX_SYMBOL(...)
5052 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
000d1cc1
JP
5053 WARN("MISSING_VMLINUX_SYMBOL",
5054 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
080ba929
MF
5055 }
5056
f0a594c1 5057# check for redundant bracing round if etc
13214adf
AW
5058 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5059 my ($level, $endln, @chunks) =
cf655043 5060 ctx_statement_full($linenr, $realcnt, 1);
13214adf 5061 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
cf655043
AW
5062 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5063 if ($#chunks > 0 && $level == 0) {
aad4f614
JP
5064 my @allowed = ();
5065 my $allow = 0;
13214adf 5066 my $seen = 0;
773647a0 5067 my $herectx = $here . "\n";
cf655043 5068 my $ln = $linenr - 1;
13214adf
AW
5069 for my $chunk (@chunks) {
5070 my ($cond, $block) = @{$chunk};
5071
773647a0
AW
5072 # If the condition carries leading newlines, then count those as offsets.
5073 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5074 my $offset = statement_rawlines($whitespace) - 1;
5075
aad4f614 5076 $allowed[$allow] = 0;
773647a0
AW
5077 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5078
5079 # We have looked at and allowed this specific line.
5080 $suppress_ifbraces{$ln + $offset} = 1;
5081
5082 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
cf655043
AW
5083 $ln += statement_rawlines($block) - 1;
5084
773647a0 5085 substr($block, 0, length($cond), '');
13214adf
AW
5086
5087 $seen++ if ($block =~ /^\s*{/);
5088
aad4f614 5089 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
cf655043
AW
5090 if (statement_lines($cond) > 1) {
5091 #print "APW: ALLOWED: cond<$cond>\n";
aad4f614 5092 $allowed[$allow] = 1;
13214adf
AW
5093 }
5094 if ($block =~/\b(?:if|for|while)\b/) {
cf655043 5095 #print "APW: ALLOWED: block<$block>\n";
aad4f614 5096 $allowed[$allow] = 1;
13214adf 5097 }
cf655043
AW
5098 if (statement_block_size($block) > 1) {
5099 #print "APW: ALLOWED: lines block<$block>\n";
aad4f614 5100 $allowed[$allow] = 1;
13214adf 5101 }
aad4f614 5102 $allow++;
13214adf 5103 }
aad4f614
JP
5104 if ($seen) {
5105 my $sum_allowed = 0;
5106 foreach (@allowed) {
5107 $sum_allowed += $_;
5108 }
5109 if ($sum_allowed == 0) {
5110 WARN("BRACES",
5111 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5112 } elsif ($sum_allowed != $allow &&
5113 $seen != $allow) {
5114 CHK("BRACES",
5115 "braces {} should be used on all arms of this statement\n" . $herectx);
5116 }
13214adf
AW
5117 }
5118 }
5119 }
773647a0 5120 if (!defined $suppress_ifbraces{$linenr - 1} &&
13214adf 5121 $line =~ /\b(if|while|for|else)\b/) {
cf655043
AW
5122 my $allowed = 0;
5123
5124 # Check the pre-context.
5125 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5126 #print "APW: ALLOWED: pre<$1>\n";
5127 $allowed = 1;
5128 }
773647a0
AW
5129
5130 my ($level, $endln, @chunks) =
5131 ctx_statement_full($linenr, $realcnt, $-[0]);
5132
cf655043
AW
5133 # Check the condition.
5134 my ($cond, $block) = @{$chunks[0]};
773647a0 5135 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
cf655043 5136 if (defined $cond) {
773647a0 5137 substr($block, 0, length($cond), '');
cf655043
AW
5138 }
5139 if (statement_lines($cond) > 1) {
5140 #print "APW: ALLOWED: cond<$cond>\n";
5141 $allowed = 1;
5142 }
5143 if ($block =~/\b(?:if|for|while)\b/) {
5144 #print "APW: ALLOWED: block<$block>\n";
5145 $allowed = 1;
5146 }
5147 if (statement_block_size($block) > 1) {
5148 #print "APW: ALLOWED: lines block<$block>\n";
5149 $allowed = 1;
5150 }
5151 # Check the post-context.
5152 if (defined $chunks[1]) {
5153 my ($cond, $block) = @{$chunks[1]};
5154 if (defined $cond) {
773647a0 5155 substr($block, 0, length($cond), '');
cf655043
AW
5156 }
5157 if ($block =~ /^\s*\{/) {
5158 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5159 $allowed = 1;
5160 }
5161 }
5162 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
69932487 5163 my $herectx = $here . "\n";
f055663c 5164 my $cnt = statement_rawlines($block);
cf655043 5165
f055663c 5166 for (my $n = 0; $n < $cnt; $n++) {
69932487 5167 $herectx .= raw_line($linenr, $n) . "\n";
f0a594c1 5168 }
cf655043 5169
000d1cc1
JP
5170 WARN("BRACES",
5171 "braces {} are not necessary for single statement blocks\n" . $herectx);
f0a594c1
AW
5172 }
5173 }
5174
e4c5babd 5175# check for single line unbalanced braces
95330473
SE
5176 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5177 $sline =~ /^.\s*else\s*\{\s*$/) {
e4c5babd
JP
5178 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5179 }
5180
0979ae66 5181# check for unnecessary blank lines around braces
77b9a53a 5182 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
f8e58219
JP
5183 if (CHK("BRACES",
5184 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5185 $fix && $prevrawline =~ /^\+/) {
5186 fix_delete_line($fixlinenr - 1, $prevrawline);
5187 }
0979ae66 5188 }
77b9a53a 5189 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
f8e58219
JP
5190 if (CHK("BRACES",
5191 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5192 $fix) {
5193 fix_delete_line($fixlinenr, $rawline);
5194 }
0979ae66
JP
5195 }
5196
4a0df2ef 5197# no volatiles please
6c72ffaa
AW
5198 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5199 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
000d1cc1 5200 WARN("VOLATILE",
8c27ceff 5201 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
4a0df2ef
AW
5202 }
5203
5e4f6ba5
JP
5204# Check for user-visible strings broken across lines, which breaks the ability
5205# to grep for the string. Make exceptions when the previous string ends in a
5206# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5207# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
33acb54a 5208 if ($line =~ /^\+\s*$String/ &&
5e4f6ba5
JP
5209 $prevline =~ /"\s*$/ &&
5210 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5211 if (WARN("SPLIT_STRING",
5212 "quoted string split across lines\n" . $hereprev) &&
5213 $fix &&
5214 $prevrawline =~ /^\+.*"\s*$/ &&
5215 $last_coalesced_string_linenr != $linenr - 1) {
5216 my $extracted_string = get_quoted_string($line, $rawline);
5217 my $comma_close = "";
5218 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5219 $comma_close = $1;
5220 }
5221
5222 fix_delete_line($fixlinenr - 1, $prevrawline);
5223 fix_delete_line($fixlinenr, $rawline);
5224 my $fixedline = $prevrawline;
5225 $fixedline =~ s/"\s*$//;
5226 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5227 fix_insert_line($fixlinenr - 1, $fixedline);
5228 $fixedline = $rawline;
5229 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5230 if ($fixedline !~ /\+\s*$/) {
5231 fix_insert_line($fixlinenr, $fixedline);
5232 }
5233 $last_coalesced_string_linenr = $linenr;
5234 }
5235 }
5236
5237# check for missing a space in a string concatenation
5238 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5239 WARN('MISSING_SPACE',
5240 "break quoted strings at a space character\n" . $hereprev);
5241 }
5242
e4b7d309
JP
5243# check for an embedded function name in a string when the function is known
5244# This does not work very well for -f --file checking as it depends on patch
5245# context providing the function name or a single line form for in-file
5246# function declarations
77cb8546
JP
5247 if ($line =~ /^\+.*$String/ &&
5248 defined($context_function) &&
e4b7d309
JP
5249 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5250 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
77cb8546 5251 WARN("EMBEDDED_FUNCTION_NAME",
e4b7d309 5252 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
77cb8546
JP
5253 }
5254
5e4f6ba5
JP
5255# check for spaces before a quoted newline
5256 if ($rawline =~ /^.*\".*\s\\n/) {
5257 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5258 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5259 $fix) {
5260 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5261 }
5262
5263 }
5264
f17dba4f 5265# concatenated string without spaces between elements
33acb54a 5266 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
f17dba4f
JP
5267 CHK("CONCATENATED_STRING",
5268 "Concatenated strings should use spaces between elements\n" . $herecurr);
5269 }
5270
90ad30e5 5271# uncoalesced string fragments
33acb54a 5272 if ($line =~ /$String\s*"/) {
90ad30e5
JP
5273 WARN("STRING_FRAGMENTS",
5274 "Consecutive strings are generally better as a single string\n" . $herecurr);
5275 }
5276
522b837c
AD
5277# check for non-standard and hex prefixed decimal printf formats
5278 my $show_L = 1; #don't show the same defect twice
5279 my $show_Z = 1;
5e4f6ba5 5280 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
522b837c 5281 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
5e4f6ba5 5282 $string =~ s/%%/__/g;
522b837c
AD
5283 # check for %L
5284 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
5e4f6ba5 5285 WARN("PRINTF_L",
522b837c
AD
5286 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5287 $show_L = 0;
5288 }
5289 # check for %Z
5290 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5291 WARN("PRINTF_Z",
5292 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5293 $show_Z = 0;
5294 }
5295 # check for 0x<decimal>
5296 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5297 ERROR("PRINTF_0XDECIMAL",
6e300757
JP
5298 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5299 }
5e4f6ba5
JP
5300 }
5301
5302# check for line continuations in quoted strings with odd counts of "
5303 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
5304 WARN("LINE_CONTINUATIONS",
5305 "Avoid line continuations in quoted strings\n" . $herecurr);
5306 }
5307
00df344f 5308# warn about #if 0
c45dcabd 5309 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
000d1cc1
JP
5310 CHK("REDUNDANT_CODE",
5311 "if this code is redundant consider removing it\n" .
de7d4f0e 5312 $herecurr);
4a0df2ef
AW
5313 }
5314
03df4b51
AW
5315# check for needless "if (<foo>) fn(<foo>)" uses
5316 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
100425de
JP
5317 my $tested = quotemeta($1);
5318 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5319 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5320 my $func = $1;
5321 if (WARN('NEEDLESS_IF',
5322 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5323 $fix) {
5324 my $do_fix = 1;
5325 my $leading_tabs = "";
5326 my $new_leading_tabs = "";
5327 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5328 $leading_tabs = $1;
5329 } else {
5330 $do_fix = 0;
5331 }
5332 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5333 $new_leading_tabs = $1;
5334 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5335 $do_fix = 0;
5336 }
5337 } else {
5338 $do_fix = 0;
5339 }
5340 if ($do_fix) {
5341 fix_delete_line($fixlinenr - 1, $prevrawline);
5342 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5343 }
5344 }
4c432a8f
GKH
5345 }
5346 }
f0a594c1 5347
ebfdc409
JP
5348# check for unnecessary "Out of Memory" messages
5349 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5350 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5351 (defined $1 || defined $3) &&
5352 $linenr > 3) {
5353 my $testval = $2;
5354 my $testline = $lines[$linenr - 3];
5355
5356 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5357# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5358
fb0d0e08 5359 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
5360 WARN("OOM_MESSAGE",
5361 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5362 }
5363 }
5364
f78d98f6 5365# check for logging functions with KERN_<LEVEL>
dcaf1123 5366 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
f78d98f6
JP
5367 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5368 my $level = $1;
5369 if (WARN("UNNECESSARY_KERN_LEVEL",
5370 "Possible unnecessary $level\n" . $herecurr) &&
5371 $fix) {
5372 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5373 }
5374 }
5375
45c55e92
JP
5376# check for logging continuations
5377 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5378 WARN("LOGGING_CONTINUATION",
5379 "Avoid logging continuation uses where feasible\n" . $herecurr);
5380 }
5381
abb08a53
JP
5382# check for mask then right shift without a parentheses
5383 if ($^V && $^V ge 5.10.0 &&
5384 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5385 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5386 WARN("MASK_THEN_SHIFT",
5387 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5388 }
5389
b75ac618
JP
5390# check for pointer comparisons to NULL
5391 if ($^V && $^V ge 5.10.0) {
5392 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5393 my $val = $1;
5394 my $equal = "!";
5395 $equal = "" if ($4 eq "!=");
5396 if (CHK("COMPARISON_TO_NULL",
5397 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5398 $fix) {
5399 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5400 }
5401 }
5402 }
5403
8716de38
JP
5404# check for bad placement of section $InitAttribute (e.g.: __initdata)
5405 if ($line =~ /(\b$InitAttribute\b)/) {
5406 my $attr = $1;
5407 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5408 my $ptr = $1;
5409 my $var = $2;
5410 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5411 ERROR("MISPLACED_INIT",
5412 "$attr should be placed after $var\n" . $herecurr)) ||
5413 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5414 WARN("MISPLACED_INIT",
5415 "$attr should be placed after $var\n" . $herecurr))) &&
5416 $fix) {
194f66fc 5417 $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
5418 }
5419 }
5420 }
5421
e970b884
JP
5422# check for $InitAttributeData (ie: __initdata) with const
5423 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5424 my $attr = $1;
5425 $attr =~ /($InitAttributePrefix)(.*)/;
5426 my $attr_prefix = $1;
5427 my $attr_type = $2;
5428 if (ERROR("INIT_ATTRIBUTE",
5429 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5430 $fix) {
194f66fc 5431 $fixed[$fixlinenr] =~
e970b884
JP
5432 s/$InitAttributeData/${attr_prefix}initconst/;
5433 }
5434 }
5435
5436# check for $InitAttributeConst (ie: __initconst) without const
5437 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5438 my $attr = $1;
5439 if (ERROR("INIT_ATTRIBUTE",
5440 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5441 $fix) {
194f66fc 5442 my $lead = $fixed[$fixlinenr] =~
e970b884
JP
5443 /(^\+\s*(?:static\s+))/;
5444 $lead = rtrim($1);
5445 $lead = "$lead " if ($lead !~ /^\+$/);
5446 $lead = "${lead}const ";
194f66fc 5447 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
e970b884
JP
5448 }
5449 }
5450
c17893c7
JP
5451# check for __read_mostly with const non-pointer (should just be const)
5452 if ($line =~ /\b__read_mostly\b/ &&
5453 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5454 if (ERROR("CONST_READ_MOSTLY",
5455 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5456 $fix) {
5457 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5458 }
5459 }
5460
fbdb8138
JP
5461# don't use __constant_<foo> functions outside of include/uapi/
5462 if ($realfile !~ m@^include/uapi/@ &&
5463 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5464 my $constant_func = $1;
5465 my $func = $constant_func;
5466 $func =~ s/^__constant_//;
5467 if (WARN("CONSTANT_CONVERSION",
5468 "$constant_func should be $func\n" . $herecurr) &&
5469 $fix) {
194f66fc 5470 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
fbdb8138
JP
5471 }
5472 }
5473
1a15a250 5474# prefer usleep_range over udelay
37581c28 5475 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
43c1d77c 5476 my $delay = $1;
1a15a250 5477 # ignore udelay's < 10, however
43c1d77c 5478 if (! ($delay < 10) ) {
000d1cc1 5479 CHK("USLEEP_RANGE",
43c1d77c
JP
5480 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5481 }
5482 if ($delay > 2000) {
5483 WARN("LONG_UDELAY",
5484 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
1a15a250
PP
5485 }
5486 }
5487
09ef8725
PP
5488# warn about unexpectedly long msleep's
5489 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5490 if ($1 < 20) {
000d1cc1 5491 WARN("MSLEEP",
43c1d77c 5492 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
09ef8725
PP
5493 }
5494 }
5495
36ec1939
JP
5496# check for comparisons of jiffies
5497 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5498 WARN("JIFFIES_COMPARISON",
5499 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5500 }
5501
9d7a34a5
JP
5502# check for comparisons of get_jiffies_64()
5503 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5504 WARN("JIFFIES_COMPARISON",
5505 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5506 }
5507
00df344f 5508# warn about #ifdefs in C files
c45dcabd 5509# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
00df344f
AW
5510# print "#ifdef in C files should be avoided\n";
5511# print "$herecurr";
5512# $clean = 0;
5513# }
5514
22f2a2ef 5515# warn about spacing in #ifdefs
c45dcabd 5516 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
3705ce5b
JP
5517 if (ERROR("SPACING",
5518 "exactly one space required after that #$1\n" . $herecurr) &&
5519 $fix) {
194f66fc 5520 $fixed[$fixlinenr] =~
3705ce5b
JP
5521 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5522 }
5523
22f2a2ef
AW
5524 }
5525
4a0df2ef 5526# check for spinlock_t definitions without a comment.
171ae1a4
AW
5527 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5528 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
4a0df2ef
AW
5529 my $which = $1;
5530 if (!ctx_has_comment($first_line, $linenr)) {
000d1cc1
JP
5531 CHK("UNCOMMENTED_DEFINITION",
5532 "$1 definition without comment\n" . $herecurr);
4a0df2ef
AW
5533 }
5534 }
5535# check for memory barriers without a comment.
402c2553
MT
5536
5537 my $barriers = qr{
5538 mb|
5539 rmb|
5540 wmb|
5541 read_barrier_depends
5542 }x;
5543 my $barrier_stems = qr{
5544 mb__before_atomic|
5545 mb__after_atomic|
5546 store_release|
5547 load_acquire|
5548 store_mb|
5549 (?:$barriers)
5550 }x;
5551 my $all_barriers = qr{
5552 (?:$barriers)|
43e361f2
MT
5553 smp_(?:$barrier_stems)|
5554 virt_(?:$barrier_stems)
402c2553
MT
5555 }x;
5556
5557 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
4a0df2ef 5558 if (!ctx_has_comment($first_line, $linenr)) {
c1fd7bb9
JP
5559 WARN("MEMORY_BARRIER",
5560 "memory barrier without comment\n" . $herecurr);
4a0df2ef
AW
5561 }
5562 }
3ad81779 5563
f4073b0f
MT
5564 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5565
5566 if ($realfile !~ m@^include/asm-generic/@ &&
5567 $realfile !~ m@/barrier\.h$@ &&
5568 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5569 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5570 WARN("MEMORY_BARRIER",
5571 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5572 }
5573
cb426e99
JP
5574# check for waitqueue_active without a comment.
5575 if ($line =~ /\bwaitqueue_active\s*\(/) {
5576 if (!ctx_has_comment($first_line, $linenr)) {
5577 WARN("WAITQUEUE_ACTIVE",
5578 "waitqueue_active without comment\n" . $herecurr);
5579 }
5580 }
3ad81779 5581
4a0df2ef 5582# check of hardware specific defines
c45dcabd 5583 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
000d1cc1
JP
5584 CHK("ARCH_DEFINES",
5585 "architecture specific defines should be avoided\n" . $herecurr);
0a920b5b 5586 }
653d4876 5587
596ed45b
JP
5588# check that the storage class is not after a type
5589 if ($line =~ /\b($Type)\s+($Storage)\b/) {
5590 WARN("STORAGE_CLASS",
5591 "storage class '$2' should be located before type '$1'\n" . $herecurr);
5592 }
d4977c78 5593# Check that the storage class is at the beginning of a declaration
596ed45b
JP
5594 if ($line =~ /\b$Storage\b/ &&
5595 $line !~ /^.\s*$Storage/ &&
5596 $line =~ /^.\s*(.+?)\$Storage\s/ &&
5597 $1 !~ /[\,\)]\s*$/) {
000d1cc1 5598 WARN("STORAGE_CLASS",
596ed45b 5599 "storage class should be at the beginning of the declaration\n" . $herecurr);
d4977c78
TK
5600 }
5601
de7d4f0e
AW
5602# check the location of the inline attribute, that it is between
5603# storage class and type.
9c0ca6f9
AW
5604 if ($line =~ /\b$Type\s+$Inline\b/ ||
5605 $line =~ /\b$Inline\s+$Storage\b/) {
000d1cc1
JP
5606 ERROR("INLINE_LOCATION",
5607 "inline keyword should sit between storage class and type\n" . $herecurr);
de7d4f0e
AW
5608 }
5609
8905a67c 5610# Check for __inline__ and __inline, prefer inline
2b7ab453
JP
5611 if ($realfile !~ m@\binclude/uapi/@ &&
5612 $line =~ /\b(__inline__|__inline)\b/) {
d5e616fc
JP
5613 if (WARN("INLINE",
5614 "plain inline is preferred over $1\n" . $herecurr) &&
5615 $fix) {
194f66fc 5616 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
d5e616fc
JP
5617
5618 }
8905a67c
AW
5619 }
5620
3d130fd0 5621# Check for __attribute__ packed, prefer __packed
2b7ab453
JP
5622 if ($realfile !~ m@\binclude/uapi/@ &&
5623 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
000d1cc1
JP
5624 WARN("PREFER_PACKED",
5625 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
3d130fd0
JP
5626 }
5627
39b7e287 5628# Check for __attribute__ aligned, prefer __aligned
2b7ab453
JP
5629 if ($realfile !~ m@\binclude/uapi/@ &&
5630 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
000d1cc1
JP
5631 WARN("PREFER_ALIGNED",
5632 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
39b7e287
JP
5633 }
5634
5f14d3bd 5635# Check for __attribute__ format(printf, prefer __printf
2b7ab453
JP
5636 if ($realfile !~ m@\binclude/uapi/@ &&
5637 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
d5e616fc
JP
5638 if (WARN("PREFER_PRINTF",
5639 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5640 $fix) {
194f66fc 5641 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
d5e616fc
JP
5642
5643 }
5f14d3bd
JP
5644 }
5645
6061d949 5646# Check for __attribute__ format(scanf, prefer __scanf
2b7ab453
JP
5647 if ($realfile !~ m@\binclude/uapi/@ &&
5648 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
d5e616fc
JP
5649 if (WARN("PREFER_SCANF",
5650 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5651 $fix) {
194f66fc 5652 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
d5e616fc 5653 }
6061d949
JP
5654 }
5655
619a908a
JP
5656# Check for __attribute__ weak, or __weak declarations (may have link issues)
5657 if ($^V && $^V ge 5.10.0 &&
5658 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5659 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5660 $line =~ /\b__weak\b/)) {
5661 ERROR("WEAK_DECLARATION",
5662 "Using weak declarations can have unintended link defects\n" . $herecurr);
5663 }
5664
fd39f904 5665# check for c99 types like uint8_t used outside of uapi/ and tools/
e6176fa4 5666 if ($realfile !~ m@\binclude/uapi/@ &&
fd39f904 5667 $realfile !~ m@\btools/@ &&
e6176fa4
JP
5668 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5669 my $type = $1;
5670 if ($type =~ /\b($typeC99Typedefs)\b/) {
5671 $type = $1;
5672 my $kernel_type = 'u';
5673 $kernel_type = 's' if ($type =~ /^_*[si]/);
5674 $type =~ /(\d+)/;
5675 $kernel_type .= $1;
5676 if (CHK("PREFER_KERNEL_TYPES",
5677 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5678 $fix) {
5679 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5680 }
5681 }
5682 }
5683
938224b5
JP
5684# check for cast of C90 native int or longer types constants
5685 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5686 my $cast = $1;
5687 my $const = $2;
5688 if (WARN("TYPECAST_INT_CONSTANT",
5689 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5690 $fix) {
5691 my $suffix = "";
5692 my $newconst = $const;
5693 $newconst =~ s/${Int_type}$//;
5694 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5695 if ($cast =~ /\blong\s+long\b/) {
5696 $suffix .= 'LL';
5697 } elsif ($cast =~ /\blong\b/) {
5698 $suffix .= 'L';
5699 }
5700 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5701 }
5702 }
5703
8f53a9b8
JP
5704# check for sizeof(&)
5705 if ($line =~ /\bsizeof\s*\(\s*\&/) {
000d1cc1
JP
5706 WARN("SIZEOF_ADDRESS",
5707 "sizeof(& should be avoided\n" . $herecurr);
8f53a9b8
JP
5708 }
5709
66c80b60
JP
5710# check for sizeof without parenthesis
5711 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
d5e616fc
JP
5712 if (WARN("SIZEOF_PARENTHESIS",
5713 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5714 $fix) {
194f66fc 5715 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
d5e616fc 5716 }
66c80b60
JP
5717 }
5718
88982fea
JP
5719# check for struct spinlock declarations
5720 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5721 WARN("USE_SPINLOCK_T",
5722 "struct spinlock should be spinlock_t\n" . $herecurr);
5723 }
5724
a6962d72 5725# check for seq_printf uses that could be seq_puts
06668727 5726 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
a6962d72 5727 my $fmt = get_quoted_string($line, $rawline);
caac1d5f
HA
5728 $fmt =~ s/%%//g;
5729 if ($fmt !~ /%/) {
d5e616fc
JP
5730 if (WARN("PREFER_SEQ_PUTS",
5731 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5732 $fix) {
194f66fc 5733 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
d5e616fc 5734 }
a6962d72
JP
5735 }
5736 }
5737
0b523769
JP
5738 # check for vsprintf extension %p<foo> misuses
5739 if ($^V && $^V ge 5.10.0 &&
5740 defined $stat &&
5741 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
5742 $1 !~ /^_*volatile_*$/) {
5743 my $bad_extension = "";
5744 my $lc = $stat =~ tr@\n@@;
5745 $lc = $lc + $linenr;
5746 for (my $count = $linenr; $count <= $lc; $count++) {
5747 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
5748 $fmt =~ s/%%//g;
ce4fecf1 5749 if ($fmt =~ /(\%[\*\d\.]*p(?![\WFfSsBKRraEhMmIiUDdgVCbGNO]).)/) {
0b523769
JP
5750 $bad_extension = $1;
5751 last;
5752 }
5753 }
5754 if ($bad_extension ne "") {
5755 my $stat_real = raw_line($linenr, 0);
5756 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5757 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5758 }
5759 WARN("VSPRINTF_POINTER_EXTENSION",
5760 "Invalid vsprintf pointer extension '$bad_extension'\n" . "$here\n$stat_real\n");
5761 }
5762 }
5763
554e165c 5764# Check for misused memsets
d1fe9c09
JP
5765 if ($^V && $^V ge 5.10.0 &&
5766 defined $stat &&
9e20a853 5767 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
d7c76ba7
JP
5768
5769 my $ms_addr = $2;
d1fe9c09
JP
5770 my $ms_val = $7;
5771 my $ms_size = $12;
554e165c 5772
554e165c
AW
5773 if ($ms_size =~ /^(0x|)0$/i) {
5774 ERROR("MEMSET",
d7c76ba7 5775 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
554e165c
AW
5776 } elsif ($ms_size =~ /^(0x|)1$/i) {
5777 WARN("MEMSET",
d7c76ba7
JP
5778 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5779 }
5780 }
5781
98a9bba5 5782# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
f333195d
JP
5783# if ($^V && $^V ge 5.10.0 &&
5784# defined $stat &&
5785# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5786# if (WARN("PREFER_ETHER_ADDR_COPY",
5787# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5788# $fix) {
5789# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5790# }
5791# }
98a9bba5 5792
b6117d17 5793# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
f333195d
JP
5794# if ($^V && $^V ge 5.10.0 &&
5795# defined $stat &&
5796# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5797# WARN("PREFER_ETHER_ADDR_EQUAL",
5798# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5799# }
b6117d17 5800
8617cd09
MK
5801# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5802# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
f333195d
JP
5803# if ($^V && $^V ge 5.10.0 &&
5804# defined $stat &&
5805# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5806#
5807# my $ms_val = $7;
5808#
5809# if ($ms_val =~ /^(?:0x|)0+$/i) {
5810# if (WARN("PREFER_ETH_ZERO_ADDR",
5811# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5812# $fix) {
5813# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5814# }
5815# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5816# if (WARN("PREFER_ETH_BROADCAST_ADDR",
5817# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5818# $fix) {
5819# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5820# }
5821# }
5822# }
8617cd09 5823
d7c76ba7 5824# typecasts on min/max could be min_t/max_t
d1fe9c09
JP
5825 if ($^V && $^V ge 5.10.0 &&
5826 defined $stat &&
d7c76ba7 5827 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
d1fe9c09 5828 if (defined $2 || defined $7) {
d7c76ba7
JP
5829 my $call = $1;
5830 my $cast1 = deparenthesize($2);
5831 my $arg1 = $3;
d1fe9c09
JP
5832 my $cast2 = deparenthesize($7);
5833 my $arg2 = $8;
d7c76ba7
JP
5834 my $cast;
5835
d1fe9c09 5836 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
d7c76ba7
JP
5837 $cast = "$cast1 or $cast2";
5838 } elsif ($cast1 ne "") {
5839 $cast = $cast1;
5840 } else {
5841 $cast = $cast2;
5842 }
5843 WARN("MINMAX",
5844 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
554e165c
AW
5845 }
5846 }
5847
4a273195
JP
5848# check usleep_range arguments
5849 if ($^V && $^V ge 5.10.0 &&
5850 defined $stat &&
5851 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5852 my $min = $1;
5853 my $max = $7;
5854 if ($min eq $max) {
5855 WARN("USLEEP_RANGE",
5856 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5857 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5858 $min > $max) {
5859 WARN("USLEEP_RANGE",
5860 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5861 }
5862 }
5863
823b794c
JP
5864# check for naked sscanf
5865 if ($^V && $^V ge 5.10.0 &&
5866 defined $stat &&
6c8bd707 5867 $line =~ /\bsscanf\b/ &&
823b794c
JP
5868 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5869 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5870 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5871 my $lc = $stat =~ tr@\n@@;
5872 $lc = $lc + $linenr;
5873 my $stat_real = raw_line($linenr, 0);
5874 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5875 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5876 }
5877 WARN("NAKED_SSCANF",
5878 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5879 }
5880
afc819ab
JP
5881# check for simple sscanf that should be kstrto<foo>
5882 if ($^V && $^V ge 5.10.0 &&
5883 defined $stat &&
5884 $line =~ /\bsscanf\b/) {
5885 my $lc = $stat =~ tr@\n@@;
5886 $lc = $lc + $linenr;
5887 my $stat_real = raw_line($linenr, 0);
5888 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5889 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5890 }
5891 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5892 my $format = $6;
5893 my $count = $format =~ tr@%@%@;
5894 if ($count == 1 &&
5895 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5896 WARN("SSCANF_TO_KSTRTO",
5897 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5898 }
5899 }
5900 }
5901
70dc8a48
JP
5902# check for new externs in .h files.
5903 if ($realfile =~ /\.h$/ &&
5904 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
d1d85780
JP
5905 if (CHK("AVOID_EXTERNS",
5906 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
70dc8a48 5907 $fix) {
194f66fc 5908 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
70dc8a48
JP
5909 }
5910 }
5911
de7d4f0e 5912# check for new externs in .c files.
171ae1a4 5913 if ($realfile =~ /\.c$/ && defined $stat &&
c45dcabd 5914 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
171ae1a4 5915 {
c45dcabd
AW
5916 my $function_name = $1;
5917 my $paren_space = $2;
171ae1a4
AW
5918
5919 my $s = $stat;
5920 if (defined $cond) {
5921 substr($s, 0, length($cond), '');
5922 }
c45dcabd
AW
5923 if ($s =~ /^\s*;/ &&
5924 $function_name ne 'uninitialized_var')
5925 {
000d1cc1
JP
5926 WARN("AVOID_EXTERNS",
5927 "externs should be avoided in .c files\n" . $herecurr);
171ae1a4
AW
5928 }
5929
5930 if ($paren_space =~ /\n/) {
000d1cc1
JP
5931 WARN("FUNCTION_ARGUMENTS",
5932 "arguments for function declarations should follow identifier\n" . $herecurr);
171ae1a4 5933 }
9c9ba34e
AW
5934
5935 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5936 $stat =~ /^.\s*extern\s+/)
5937 {
000d1cc1
JP
5938 WARN("AVOID_EXTERNS",
5939 "externs should be avoided in .c files\n" . $herecurr);
de7d4f0e
AW
5940 }
5941
a0ad7596
JP
5942# check for function declarations that have arguments without identifier names
5943 if (defined $stat &&
25bdda2b 5944 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
ca0d8929
JP
5945 $1 ne "void") {
5946 my $args = trim($1);
5947 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
5948 my $arg = trim($1);
5949 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
5950 WARN("FUNCTION_ARGUMENTS",
5951 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
5952 }
5953 }
5954 }
5955
a0ad7596
JP
5956# check for function definitions
5957 if ($^V && $^V ge 5.10.0 &&
5958 defined $stat &&
5959 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
5960 $context_function = $1;
5961
5962# check for multiline function definition with misplaced open brace
5963 my $ok = 0;
5964 my $cnt = statement_rawlines($stat);
5965 my $herectx = $here . "\n";
5966 for (my $n = 0; $n < $cnt; $n++) {
5967 my $rl = raw_line($linenr, $n);
5968 $herectx .= $rl . "\n";
5969 $ok = 1 if ($rl =~ /^[ \+]\{/);
5970 $ok = 1 if ($rl =~ /\{/ && $n == 0);
5971 last if $rl =~ /^[ \+].*\{/;
5972 }
5973 if (!$ok) {
5974 ERROR("OPEN_BRACE",
5975 "open brace '{' following function definitions go on the next line\n" . $herectx);
5976 }
5977 }
5978
de7d4f0e
AW
5979# checks for new __setup's
5980 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5981 my $name = $1;
5982
5983 if (!grep(/$name/, @setup_docs)) {
000d1cc1 5984 CHK("UNDOCUMENTED_SETUP",
8c27ceff 5985 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
de7d4f0e 5986 }
653d4876 5987 }
9c0ca6f9
AW
5988
5989# check for pointless casting of kmalloc return
caf2a54f 5990 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
000d1cc1
JP
5991 WARN("UNNECESSARY_CASTS",
5992 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
9c0ca6f9 5993 }
13214adf 5994
a640d25c
JP
5995# alloc style
5996# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5997 if ($^V && $^V ge 5.10.0 &&
5998 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5999 CHK("ALLOC_SIZEOF_STRUCT",
6000 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6001 }
6002
60a55369
JP
6003# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6004 if ($^V && $^V ge 5.10.0 &&
1b4a2ed4
JP
6005 defined $stat &&
6006 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
60a55369
JP
6007 my $oldfunc = $3;
6008 my $a1 = $4;
6009 my $a2 = $10;
6010 my $newfunc = "kmalloc_array";
6011 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
e367455a
JP
6012 my $r1 = $a1;
6013 my $r2 = $a2;
6014 if ($a1 =~ /^sizeof\s*\S/) {
6015 $r1 = $a2;
6016 $r2 = $a1;
6017 }
6018 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6019 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
1b4a2ed4
JP
6020 my $ctx = '';
6021 my $herectx = $here . "\n";
6022 my $cnt = statement_rawlines($stat);
6023 for (my $n = 0; $n < $cnt; $n++) {
6024 $herectx .= raw_line($linenr, $n) . "\n";
6025 }
60a55369 6026 if (WARN("ALLOC_WITH_MULTIPLY",
1b4a2ed4
JP
6027 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6028 $cnt == 1 &&
60a55369 6029 $fix) {
194f66fc 6030 $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
6031 }
6032 }
6033 }
6034
972fdea2
JP
6035# check for krealloc arg reuse
6036 if ($^V && $^V ge 5.10.0 &&
6037 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
6038 WARN("KREALLOC_ARG_REUSE",
6039 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6040 }
6041
5ce59ae0
JP
6042# check for alloc argument mismatch
6043 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6044 WARN("ALLOC_ARRAY_ARGS",
6045 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6046 }
6047
caf2a54f
JP
6048# check for multiple semicolons
6049 if ($line =~ /;\s*;\s*$/) {
d5e616fc
JP
6050 if (WARN("ONE_SEMICOLON",
6051 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6052 $fix) {
194f66fc 6053 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
d5e616fc 6054 }
d1e2ad07
JP
6055 }
6056
cec3aaa5
TW
6057# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6058 if ($realfile !~ m@^include/uapi/@ &&
6059 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
0ab90191
JP
6060 my $ull = "";
6061 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6062 if (CHK("BIT_MACRO",
6063 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6064 $fix) {
6065 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6066 }
6067 }
6068
2d632745
JP
6069# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6070 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6071 my $config = $1;
6072 if (WARN("PREFER_IS_ENABLED",
6073 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6074 $fix) {
6075 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6076 }
6077 }
6078
e81f239b 6079# check for case / default statements not preceded by break/fallthrough/switch
c34c09a8
JP
6080 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6081 my $has_break = 0;
6082 my $has_statement = 0;
6083 my $count = 0;
6084 my $prevline = $linenr;
e81f239b 6085 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
c34c09a8
JP
6086 $prevline--;
6087 my $rline = $rawlines[$prevline - 1];
6088 my $fline = $lines[$prevline - 1];
6089 last if ($fline =~ /^\@\@/);
6090 next if ($fline =~ /^\-/);
6091 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6092 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6093 next if ($fline =~ /^.[\s$;]*$/);
6094 $has_statement = 1;
6095 $count++;
258f79d5 6096 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
c34c09a8
JP
6097 }
6098 if (!$has_break && $has_statement) {
6099 WARN("MISSING_BREAK",
224236d9 6100 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
c34c09a8
JP
6101 }
6102 }
6103
d1e2ad07
JP
6104# check for switch/default statements without a break;
6105 if ($^V && $^V ge 5.10.0 &&
6106 defined $stat &&
6107 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
6108 my $ctx = '';
6109 my $herectx = $here . "\n";
6110 my $cnt = statement_rawlines($stat);
6111 for (my $n = 0; $n < $cnt; $n++) {
6112 $herectx .= raw_line($linenr, $n) . "\n";
6113 }
6114 WARN("DEFAULT_NO_BREAK",
6115 "switch default: should use break\n" . $herectx);
caf2a54f
JP
6116 }
6117
13214adf 6118# check for gcc specific __FUNCTION__
d5e616fc
JP
6119 if ($line =~ /\b__FUNCTION__\b/) {
6120 if (WARN("USE_FUNC",
6121 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6122 $fix) {
194f66fc 6123 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
d5e616fc 6124 }
13214adf 6125 }
773647a0 6126
62ec818f
JP
6127# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6128 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6129 ERROR("DATE_TIME",
6130 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6131 }
6132
2c92488a
JP
6133# check for use of yield()
6134 if ($line =~ /\byield\s*\(\s*\)/) {
6135 WARN("YIELD",
6136 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6137 }
6138
179f8f40
JP
6139# check for comparisons against true and false
6140 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6141 my $lead = $1;
6142 my $arg = $2;
6143 my $test = $3;
6144 my $otype = $4;
6145 my $trail = $5;
6146 my $op = "!";
6147
6148 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6149
6150 my $type = lc($otype);
6151 if ($type =~ /^(?:true|false)$/) {
6152 if (("$test" eq "==" && "$type" eq "true") ||
6153 ("$test" eq "!=" && "$type" eq "false")) {
6154 $op = "";
6155 }
6156
6157 CHK("BOOL_COMPARISON",
6158 "Using comparison to $otype is error prone\n" . $herecurr);
6159
6160## maybe suggesting a correct construct would better
6161## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6162
6163 }
6164 }
6165
4882720b
TG
6166# check for semaphores initialized locked
6167 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
000d1cc1
JP
6168 WARN("CONSIDER_COMPLETION",
6169 "consider using a completion\n" . $herecurr);
773647a0 6170 }
6712d858 6171
67d0a075
JP
6172# recommend kstrto* over simple_strto* and strict_strto*
6173 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
000d1cc1 6174 WARN("CONSIDER_KSTRTO",
67d0a075 6175 "$1 is obsolete, use k$3 instead\n" . $herecurr);
773647a0 6176 }
6712d858 6177
ae3ccc46 6178# check for __initcall(), use device_initcall() explicitly or more appropriate function please
f3db6639 6179 if ($line =~ /^.\s*__initcall\s*\(/) {
000d1cc1 6180 WARN("USE_DEVICE_INITCALL",
ae3ccc46 6181 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
f3db6639 6182 }
6712d858 6183
0f3c5aab 6184# check for various structs that are normally const (ops, kgdb, device_tree)
d9190e4e 6185# and avoid what seem like struct definitions 'struct foo {'
6903ffb2 6186 if ($line !~ /\bconst\b/ &&
d9190e4e 6187 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
000d1cc1 6188 WARN("CONST_STRUCT",
d9190e4e 6189 "struct $1 should normally be const\n" . $herecurr);
2b6db5cb 6190 }
773647a0
AW
6191
6192# use of NR_CPUS is usually wrong
6193# ignore definitions of NR_CPUS and usage to define arrays as likely right
6194 if ($line =~ /\bNR_CPUS\b/ &&
c45dcabd
AW
6195 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6196 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
171ae1a4
AW
6197 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6198 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6199 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
773647a0 6200 {
000d1cc1
JP
6201 WARN("NR_CPUS",
6202 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
773647a0 6203 }
9c9ba34e 6204
52ea8506
JP
6205# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6206 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6207 ERROR("DEFINE_ARCH_HAS",
6208 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6209 }
6210
acd9362c
JP
6211# likely/unlikely comparisons similar to "(likely(foo) > 0)"
6212 if ($^V && $^V ge 5.10.0 &&
6213 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6214 WARN("LIKELY_MISUSE",
6215 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6216 }
6217
691d77b6
AW
6218# whine mightly about in_atomic
6219 if ($line =~ /\bin_atomic\s*\(/) {
6220 if ($realfile =~ m@^drivers/@) {
000d1cc1
JP
6221 ERROR("IN_ATOMIC",
6222 "do not use in_atomic in drivers\n" . $herecurr);
f4a87736 6223 } elsif ($realfile !~ m@^kernel/@) {
000d1cc1
JP
6224 WARN("IN_ATOMIC",
6225 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
691d77b6
AW
6226 }
6227 }
1704f47b 6228
481aea5c
JP
6229# whine about ACCESS_ONCE
6230 if ($^V && $^V ge 5.10.0 &&
6231 $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) {
6232 my $par = $1;
6233 my $eq = $2;
6234 my $fun = $3;
6235 $par =~ s/^\(\s*(.*)\s*\)$/$1/;
6236 if (defined($eq)) {
6237 if (WARN("PREFER_WRITE_ONCE",
6238 "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) &&
6239 $fix) {
6240 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
6241 }
6242 } else {
6243 if (WARN("PREFER_READ_ONCE",
6244 "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) &&
6245 $fix) {
6246 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/;
6247 }
6248 }
6249 }
6250
0f5225b0
PZ
6251# check for mutex_trylock_recursive usage
6252 if ($line =~ /mutex_trylock_recursive/) {
6253 ERROR("LOCKING",
6254 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6255 }
6256
1704f47b
PZ
6257# check for lockdep_set_novalidate_class
6258 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6259 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6260 if ($realfile !~ m@^kernel/lockdep@ &&
6261 $realfile !~ m@^include/linux/lockdep@ &&
6262 $realfile !~ m@^drivers/base/core@) {
000d1cc1
JP
6263 ERROR("LOCKDEP",
6264 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
1704f47b
PZ
6265 }
6266 }
88f8831c 6267
b392c64f
JP
6268 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6269 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
000d1cc1
JP
6270 WARN("EXPORTED_WORLD_WRITABLE",
6271 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
88f8831c 6272 }
2435880f 6273
515a235e
JP
6274# Mode permission misuses where it seems decimal should be octal
6275# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6276 if ($^V && $^V ge 5.10.0 &&
459cf0ae 6277 defined $stat &&
515a235e
JP
6278 $line =~ /$mode_perms_search/) {
6279 foreach my $entry (@mode_permission_funcs) {
6280 my $func = $entry->[0];
6281 my $arg_pos = $entry->[1];
6282
459cf0ae
JP
6283 my $lc = $stat =~ tr@\n@@;
6284 $lc = $lc + $linenr;
6285 my $stat_real = raw_line($linenr, 0);
6286 for (my $count = $linenr + 1; $count <= $lc; $count++) {
6287 $stat_real = $stat_real . "\n" . raw_line($count, 0);
6288 }
6289
515a235e
JP
6290 my $skip_args = "";
6291 if ($arg_pos > 1) {
6292 $arg_pos--;
6293 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6294 }
f90774e1 6295 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
459cf0ae 6296 if ($stat =~ /$test/) {
515a235e
JP
6297 my $val = $1;
6298 $val = $6 if ($skip_args ne "");
f90774e1
JP
6299 if (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6300 ($val =~ /^$Octal$/ && length($val) ne 4)) {
515a235e 6301 ERROR("NON_OCTAL_PERMISSIONS",
459cf0ae 6302 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
f90774e1
JP
6303 }
6304 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
c0a5c898 6305 ERROR("EXPORTED_WORLD_WRITABLE",
459cf0ae 6306 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
f90774e1 6307 }
2435880f
JP
6308 }
6309 }
6310 }
5a6d20ce 6311
459cf0ae
JP
6312# check for uses of S_<PERMS> that could be octal for readability
6313 if ($line =~ /\b$mode_perms_string_search\b/) {
6314 my $val = "";
6315 my $oval = "";
6316 my $to = 0;
6317 my $curpos = 0;
6318 my $lastpos = 0;
6319 while ($line =~ /\b(($mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
6320 $curpos = pos($line);
6321 my $match = $2;
6322 my $omatch = $1;
6323 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
6324 $lastpos = $curpos;
6325 $to |= $mode_permission_string_types{$match};
6326 $val .= '\s*\|\s*' if ($val ne "");
6327 $val .= $match;
6328 $oval .= $omatch;
6329 }
6330 $oval =~ s/^\s*\|\s*//;
6331 $oval =~ s/\s*\|\s*$//;
6332 my $octal = sprintf("%04o", $to);
6333 if (WARN("SYMBOLIC_PERMS",
6334 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6335 $fix) {
6336 $fixed[$fixlinenr] =~ s/$val/$octal/;
6337 }
6338 }
6339
5a6d20ce
BA
6340# validate content of MODULE_LICENSE against list from include/linux/module.h
6341 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6342 my $extracted_string = get_quoted_string($line, $rawline);
6343 my $valid_licenses = qr{
6344 GPL|
6345 GPL\ v2|
6346 GPL\ and\ additional\ rights|
6347 Dual\ BSD/GPL|
6348 Dual\ MIT/GPL|
6349 Dual\ MPL/GPL|
6350 Proprietary
6351 }x;
6352 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6353 WARN("MODULE_LICENSE",
6354 "unknown module license " . $extracted_string . "\n" . $herecurr);
6355 }
6356 }
13214adf
AW
6357 }
6358
6359 # If we have no input at all, then there is nothing to report on
6360 # so just keep quiet.
6361 if ($#rawlines == -1) {
6362 exit(0);
0a920b5b
AW
6363 }
6364
8905a67c
AW
6365 # In mailback mode only produce a report in the negative, for
6366 # things that appear to be patches.
6367 if ($mailback && ($clean == 1 || !$is_patch)) {
6368 exit(0);
6369 }
6370
6371 # This is not a patch, and we are are in 'no-patch' mode so
6372 # just keep quiet.
6373 if (!$chk_patch && !$is_patch) {
6374 exit(0);
6375 }
6376
a08ffbef 6377 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
000d1cc1
JP
6378 ERROR("NOT_UNIFIED_DIFF",
6379 "Does not appear to be a unified-diff format patch\n");
0a920b5b 6380 }
ed43c4e5 6381 if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
000d1cc1
JP
6382 ERROR("MISSING_SIGN_OFF",
6383 "Missing Signed-off-by: line(s)\n");
0a920b5b
AW
6384 }
6385
8905a67c 6386 print report_dump();
13214adf
AW
6387 if ($summary && !($clean == 1 && $quiet == 1)) {
6388 print "$filename " if ($summary_file);
8905a67c
AW
6389 print "total: $cnt_error errors, $cnt_warn warnings, " .
6390 (($check)? "$cnt_chk checks, " : "") .
6391 "$cnt_lines lines checked\n";
f0a594c1 6392 }
8905a67c 6393
d2c0a235 6394 if ($quiet == 0) {
ef212196
JP
6395 # If there were any defects found and not already fixing them
6396 if (!$clean and !$fix) {
6397 print << "EOM"
6398
6399NOTE: For some of the reported defects, checkpatch may be able to
6400 mechanically convert to the typical style using --fix or --fix-inplace.
6401EOM
6402 }
d2c0a235
AW
6403 # If there were whitespace errors which cleanpatch can fix
6404 # then suggest that.
6405 if ($rpt_cleaners) {
b0781216 6406 $rpt_cleaners = 0;
d8469f16
JP
6407 print << "EOM"
6408
6409NOTE: Whitespace errors detected.
6410 You may wish to use scripts/cleanpatch or scripts/cleanfile
6411EOM
d2c0a235
AW
6412 }
6413 }
6414
d752fcc8
JP
6415 if ($clean == 0 && $fix &&
6416 ("@rawlines" ne "@fixed" ||
6417 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
9624b8d6
JP
6418 my $newfile = $filename;
6419 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
3705ce5b
JP
6420 my $linecount = 0;
6421 my $f;
6422
d752fcc8
JP
6423 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6424
3705ce5b
JP
6425 open($f, '>', $newfile)
6426 or die "$P: Can't open $newfile for write\n";
6427 foreach my $fixed_line (@fixed) {
6428 $linecount++;
6429 if ($file) {
6430 if ($linecount > 3) {
6431 $fixed_line =~ s/^\+//;
d752fcc8 6432 print $f $fixed_line . "\n";
3705ce5b
JP
6433 }
6434 } else {
6435 print $f $fixed_line . "\n";
6436 }
6437 }
6438 close($f);
6439
6440 if (!$quiet) {
6441 print << "EOM";
d8469f16 6442
3705ce5b
JP
6443Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6444
6445Do _NOT_ trust the results written to this file.
6446Do _NOT_ submit these changes without inspecting them for correctness.
6447
6448This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6449No warranties, expressed or implied...
3705ce5b
JP
6450EOM
6451 }
6452 }
6453
d8469f16
JP
6454 if ($quiet == 0) {
6455 print "\n";
6456 if ($clean == 1) {
6457 print "$vname has no obvious style problems and is ready for submission.\n";
6458 } else {
6459 print "$vname has style problems, please review.\n";
6460 }
0a920b5b
AW
6461 }
6462 return $clean;
6463}