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