]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - scripts/checkpatch.pl
checkpatch: avoid multiple line dereferences
[mirror_ubuntu-hirsute-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
CD
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|
338 __bitwise__|
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:
6e60c02e 427 printk(?:_ratelimited|_once|)|
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
CD
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
CD
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
CD
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
CD
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
bf4daf12 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 = '';
2157 my $in_comment = 0;
c2fdda0d 2158 my $comment_edge = 0;
0a920b5b 2159 my $first_line = 0;
1e855726 2160 my $p1_prefix = '';
0a920b5b 2161
13214adf
AW
2162 my $prev_values = 'E';
2163
2164 # suppression flags
773647a0 2165 my %suppress_ifbraces;
170d3a22 2166 my %suppress_whiletrailers;
2b474a1a 2167 my %suppress_export;
3e469cdc 2168 my $suppress_statement = 0;
653d4876 2169
7e51f197 2170 my %signatures = ();
323c1260 2171
c2fdda0d 2172 # Pre-scan the patch sanitizing the lines.
de7d4f0e 2173 # Pre-scan the patch looking for any __setup documentation.
c2fdda0d 2174 #
de7d4f0e
AW
2175 my @setup_docs = ();
2176 my $setup_docs = 0;
773647a0 2177
d8b07710
JP
2178 my $camelcase_file_seeded = 0;
2179
773647a0 2180 sanitise_line_reset();
c2fdda0d
AW
2181 my $line;
2182 foreach my $rawline (@rawlines) {
773647a0
AW
2183 $linenr++;
2184 $line = $rawline;
c2fdda0d 2185
3705ce5b
JP
2186 push(@fixed, $rawline) if ($fix);
2187
773647a0 2188 if ($rawline=~/^\+\+\+\s+(\S+)/) {
de7d4f0e
AW
2189 $setup_docs = 0;
2190 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
2191 $setup_docs = 1;
2192 }
773647a0
AW
2193 #next;
2194 }
2195 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2196 $realline=$1-1;
2197 if (defined $2) {
2198 $realcnt=$3+1;
2199 } else {
2200 $realcnt=1+1;
2201 }
c45dcabd 2202 $in_comment = 0;
773647a0
AW
2203
2204 # Guestimate if this is a continuing comment. Run
2205 # the context looking for a comment "edge". If this
2206 # edge is a close comment then we must be in a comment
2207 # at context start.
2208 my $edge;
01fa9147
AW
2209 my $cnt = $realcnt;
2210 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2211 next if (defined $rawlines[$ln - 1] &&
2212 $rawlines[$ln - 1] =~ /^-/);
2213 $cnt--;
2214 #print "RAW<$rawlines[$ln - 1]>\n";
721c1cb6 2215 last if (!defined $rawlines[$ln - 1]);
fae17dae
AW
2216 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2217 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2218 ($edge) = $1;
2219 last;
2220 }
773647a0
AW
2221 }
2222 if (defined $edge && $edge eq '*/') {
2223 $in_comment = 1;
2224 }
2225
2226 # Guestimate if this is a continuing comment. If this
2227 # is the start of a diff block and this line starts
2228 # ' *' then it is very likely a comment.
2229 if (!defined $edge &&
83242e0c 2230 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
773647a0
AW
2231 {
2232 $in_comment = 1;
2233 }
2234
2235 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2236 sanitise_line_reset($in_comment);
2237
171ae1a4 2238 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
773647a0 2239 # Standardise the strings and chars within the input to
171ae1a4 2240 # simplify matching -- only bother with positive lines.
773647a0 2241 $line = sanitise_line($rawline);
de7d4f0e 2242 }
773647a0
AW
2243 push(@lines, $line);
2244
2245 if ($realcnt > 1) {
2246 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2247 } else {
2248 $realcnt = 0;
2249 }
2250
2251 #print "==>$rawline\n";
2252 #print "-->$line\n";
de7d4f0e
AW
2253
2254 if ($setup_docs && $line =~ /^\+/) {
2255 push(@setup_docs, $line);
2256 }
2257 }
2258
6c72ffaa
AW
2259 $prefix = '';
2260
773647a0
AW
2261 $realcnt = 0;
2262 $linenr = 0;
194f66fc 2263 $fixlinenr = -1;
0a920b5b
AW
2264 foreach my $line (@lines) {
2265 $linenr++;
194f66fc 2266 $fixlinenr++;
1b5539b1
JP
2267 my $sline = $line; #copy of $line
2268 $sline =~ s/$;/ /g; #with comments as spaces
0a920b5b 2269
c2fdda0d 2270 my $rawline = $rawlines[$linenr - 1];
6c72ffaa 2271
0a920b5b 2272#extract the line range in the file after the patch is applied
e518e9a5
JP
2273 if (!$in_commit_log &&
2274 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
0a920b5b 2275 $is_patch = 1;
4a0df2ef 2276 $first_line = $linenr + 1;
0a920b5b
AW
2277 $realline=$1-1;
2278 if (defined $2) {
2279 $realcnt=$3+1;
2280 } else {
2281 $realcnt=1+1;
2282 }
c2fdda0d 2283 annotate_reset();
13214adf
AW
2284 $prev_values = 'E';
2285
773647a0 2286 %suppress_ifbraces = ();
170d3a22 2287 %suppress_whiletrailers = ();
2b474a1a 2288 %suppress_export = ();
3e469cdc 2289 $suppress_statement = 0;
0a920b5b 2290 next;
0a920b5b 2291
4a0df2ef
AW
2292# track the line number as we move through the hunk, note that
2293# new versions of GNU diff omit the leading space on completely
2294# blank context lines so we need to count that too.
773647a0 2295 } elsif ($line =~ /^( |\+|$)/) {
0a920b5b 2296 $realline++;
d8aaf121 2297 $realcnt-- if ($realcnt != 0);
0a920b5b 2298
4a0df2ef 2299 # Measure the line length and indent.
c2fdda0d 2300 ($length, $indent) = line_stats($rawline);
0a920b5b
AW
2301
2302 # Track the previous line.
2303 ($prevline, $stashline) = ($stashline, $line);
2304 ($previndent, $stashindent) = ($stashindent, $indent);
c2fdda0d
AW
2305 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2306
773647a0 2307 #warn "line<$line>\n";
6c72ffaa 2308
d8aaf121
AW
2309 } elsif ($realcnt == 1) {
2310 $realcnt--;
0a920b5b
AW
2311 }
2312
cc77cdca
AW
2313 my $hunk_line = ($realcnt != 0);
2314
6c72ffaa
AW
2315 $here = "#$linenr: " if (!$file);
2316 $here = "#$realline: " if ($file);
773647a0 2317
2ac73b4f 2318 my $found_file = 0;
773647a0 2319 # extract the filename as it passes
3bf9a009
RV
2320 if ($line =~ /^diff --git.*?(\S+)$/) {
2321 $realfile = $1;
2b7ab453 2322 $realfile =~ s@^([^/]*)/@@ if (!$file);
270c49a0 2323 $in_commit_log = 0;
2ac73b4f 2324 $found_file = 1;
3bf9a009 2325 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
773647a0 2326 $realfile = $1;
2b7ab453 2327 $realfile =~ s@^([^/]*)/@@ if (!$file);
270c49a0 2328 $in_commit_log = 0;
1e855726
WS
2329
2330 $p1_prefix = $1;
e2f7aa4b
AW
2331 if (!$file && $tree && $p1_prefix ne '' &&
2332 -e "$root/$p1_prefix") {
000d1cc1
JP
2333 WARN("PATCH_PREFIX",
2334 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1e855726 2335 }
773647a0 2336
c1ab3326 2337 if ($realfile =~ m@^include/asm/@) {
000d1cc1
JP
2338 ERROR("MODIFIED_INCLUDE_ASM",
2339 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
773647a0 2340 }
2ac73b4f
JP
2341 $found_file = 1;
2342 }
2343
34d8815f
JP
2344#make up the handle for any error we report on this line
2345 if ($showfile) {
2346 $prefix = "$realfile:$realline: "
2347 } elsif ($emacs) {
7d3a9f67
JP
2348 if ($file) {
2349 $prefix = "$filename:$realline: ";
2350 } else {
2351 $prefix = "$filename:$linenr: ";
2352 }
34d8815f
JP
2353 }
2354
2ac73b4f 2355 if ($found_file) {
85b0ee18
JP
2356 if (is_maintained_obsolete($realfile)) {
2357 WARN("OBSOLETE",
2358 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2359 }
7bd7e483 2360 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
2ac73b4f
JP
2361 $check = 1;
2362 } else {
2363 $check = $check_orig;
2364 }
773647a0
AW
2365 next;
2366 }
2367
389834b6 2368 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
0a920b5b 2369
c2fdda0d
AW
2370 my $hereline = "$here\n$rawline\n";
2371 my $herecurr = "$here\n$rawline\n";
2372 my $hereprev = "$here\n$prevrawline\n$rawline\n";
0a920b5b 2373
6c72ffaa
AW
2374 $cnt_lines++ if ($realcnt != 0);
2375
e518e9a5
JP
2376# Check if the commit log has what seems like a diff which can confuse patch
2377 if ($in_commit_log && !$commit_log_has_diff &&
2378 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2379 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2380 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2381 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2382 ERROR("DIFF_IN_COMMIT_MSG",
2383 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2384 $commit_log_has_diff = 1;
2385 }
2386
3bf9a009
RV
2387# Check for incorrect file permissions
2388 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2389 my $permhere = $here . "FILE: $realfile\n";
04db4d25
JP
2390 if ($realfile !~ m@scripts/@ &&
2391 $realfile !~ /\.(py|pl|awk|sh)$/) {
000d1cc1
JP
2392 ERROR("EXECUTE_PERMISSIONS",
2393 "do not set execute permissions for source files\n" . $permhere);
3bf9a009
RV
2394 }
2395 }
2396
20112475 2397# Check the patch for a signoff:
d8aaf121 2398 if ($line =~ /^\s*signed-off-by:/i) {
4a0df2ef 2399 $signoff++;
15662b3e 2400 $in_commit_log = 0;
20112475
JP
2401 }
2402
e0d975b1
JP
2403# Check if MAINTAINERS is being updated. If so, there's probably no need to
2404# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2405 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2406 $reported_maintainer_file = 1;
2407 }
2408
20112475 2409# Check signature styles
270c49a0 2410 if (!$in_header_lines &&
ce0338df 2411 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
20112475
JP
2412 my $space_before = $1;
2413 my $sign_off = $2;
2414 my $space_after = $3;
2415 my $email = $4;
2416 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2417
ce0338df
JP
2418 if ($sign_off !~ /$signature_tags/) {
2419 WARN("BAD_SIGN_OFF",
2420 "Non-standard signature: $sign_off\n" . $herecurr);
2421 }
20112475 2422 if (defined $space_before && $space_before ne "") {
3705ce5b
JP
2423 if (WARN("BAD_SIGN_OFF",
2424 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2425 $fix) {
194f66fc 2426 $fixed[$fixlinenr] =
3705ce5b
JP
2427 "$ucfirst_sign_off $email";
2428 }
20112475
JP
2429 }
2430 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
3705ce5b
JP
2431 if (WARN("BAD_SIGN_OFF",
2432 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2433 $fix) {
194f66fc 2434 $fixed[$fixlinenr] =
3705ce5b
JP
2435 "$ucfirst_sign_off $email";
2436 }
2437
20112475
JP
2438 }
2439 if (!defined $space_after || $space_after ne " ") {
3705ce5b
JP
2440 if (WARN("BAD_SIGN_OFF",
2441 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2442 $fix) {
194f66fc 2443 $fixed[$fixlinenr] =
3705ce5b
JP
2444 "$ucfirst_sign_off $email";
2445 }
0a920b5b 2446 }
20112475
JP
2447
2448 my ($email_name, $email_address, $comment) = parse_email($email);
2449 my $suggested_email = format_email(($email_name, $email_address));
2450 if ($suggested_email eq "") {
000d1cc1
JP
2451 ERROR("BAD_SIGN_OFF",
2452 "Unrecognized email address: '$email'\n" . $herecurr);
20112475
JP
2453 } else {
2454 my $dequoted = $suggested_email;
2455 $dequoted =~ s/^"//;
2456 $dequoted =~ s/" </ </;
2457 # Don't force email to have quotes
2458 # Allow just an angle bracketed address
2459 if ("$dequoted$comment" ne $email &&
2460 "<$email_address>$comment" ne $email &&
2461 "$suggested_email$comment" ne $email) {
000d1cc1
JP
2462 WARN("BAD_SIGN_OFF",
2463 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
20112475 2464 }
0a920b5b 2465 }
7e51f197
JP
2466
2467# Check for duplicate signatures
2468 my $sig_nospace = $line;
2469 $sig_nospace =~ s/\s//g;
2470 $sig_nospace = lc($sig_nospace);
2471 if (defined $signatures{$sig_nospace}) {
2472 WARN("BAD_SIGN_OFF",
2473 "Duplicate signature\n" . $herecurr);
2474 } else {
2475 $signatures{$sig_nospace} = 1;
2476 }
0a920b5b
AW
2477 }
2478
a2fe16b9
JP
2479# Check email subject for common tools that don't need to be mentioned
2480 if ($in_header_lines &&
2481 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2482 WARN("EMAIL_SUBJECT",
2483 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2484 }
2485
9b3189eb
JP
2486# Check for old stable address
2487 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2488 ERROR("STABLE_ADDRESS",
2489 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2490 }
2491
7ebd05ef
CC
2492# Check for unwanted Gerrit info
2493 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2494 ERROR("GERRIT_CHANGE_ID",
2495 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2496 }
2497
369c8dd3
JP
2498# Check if the commit log is in a possible stack dump
2499 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2500 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2501 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2502 # timestamp
2503 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2504 # stack dump address
2505 $commit_log_possible_stack_dump = 1;
2506 }
2507
2a076f40
JP
2508# Check for line lengths > 75 in commit log, warn once
2509 if ($in_commit_log && !$commit_log_long_line &&
369c8dd3
JP
2510 length($line) > 75 &&
2511 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2512 # file delta changes
2513 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2514 # filename then :
2515 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2516 # A Fixes: or Link: line
2517 $commit_log_possible_stack_dump)) {
2a076f40
JP
2518 WARN("COMMIT_LOG_LONG_LINE",
2519 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2520 $commit_log_long_line = 1;
2521 }
2522
bf4daf12 2523# Reset possible stack dump if a blank line is found
369c8dd3
JP
2524 if ($in_commit_log && $commit_log_possible_stack_dump &&
2525 $line =~ /^\s*$/) {
2526 $commit_log_possible_stack_dump = 0;
2527 }
bf4daf12 2528
0d7835fc 2529# Check for git id commit length and improperly formed commit descriptions
369c8dd3 2530 if ($in_commit_log && !$commit_log_possible_stack_dump &&
aab38f51 2531 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
fe043ea1 2532 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
aab38f51 2533 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
369c8dd3
JP
2534 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2535 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
fe043ea1
JP
2536 my $init_char = "c";
2537 my $orig_commit = "";
0d7835fc
JP
2538 my $short = 1;
2539 my $long = 0;
2540 my $case = 1;
2541 my $space = 1;
2542 my $hasdesc = 0;
19c146a6 2543 my $hasparens = 0;
0d7835fc
JP
2544 my $id = '0123456789ab';
2545 my $orig_desc = "commit description";
2546 my $description = "";
2547
fe043ea1
JP
2548 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2549 $init_char = $1;
2550 $orig_commit = lc($2);
2551 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2552 $orig_commit = lc($1);
2553 }
2554
0d7835fc
JP
2555 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2556 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2557 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2558 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2559 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2560 $orig_desc = $1;
19c146a6 2561 $hasparens = 1;
0d7835fc
JP
2562 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2563 defined $rawlines[$linenr] &&
2564 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2565 $orig_desc = $1;
19c146a6 2566 $hasparens = 1;
b671fde0
JP
2567 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2568 defined $rawlines[$linenr] &&
2569 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2570 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2571 $orig_desc = $1;
2572 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2573 $orig_desc .= " " . $1;
19c146a6 2574 $hasparens = 1;
0d7835fc
JP
2575 }
2576
2577 ($id, $description) = git_commit_info($orig_commit,
2578 $id, $orig_desc);
2579
19c146a6 2580 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
0d7835fc
JP
2581 ERROR("GIT_COMMIT_ID",
2582 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2583 }
d311cd44
JP
2584 }
2585
13f1937e
JP
2586# Check for added, moved or deleted files
2587 if (!$reported_maintainer_file && !$in_commit_log &&
2588 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2589 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2590 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2591 (defined($1) || defined($2))))) {
2592 $reported_maintainer_file = 1;
2593 WARN("FILE_PATH_CHANGES",
2594 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2595 }
2596
00df344f 2597# Check for wrappage within a valid hunk of the file
8905a67c 2598 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
000d1cc1
JP
2599 ERROR("CORRUPTED_PATCH",
2600 "patch seems to be corrupt (line wrapped?)\n" .
6c72ffaa 2601 $herecurr) if (!$emitted_corrupt++);
de7d4f0e
AW
2602 }
2603
2604# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2605 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
171ae1a4
AW
2606 $rawline !~ m/^$UTF8*$/) {
2607 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2608
2609 my $blank = copy_spacing($rawline);
2610 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2611 my $hereptr = "$hereline$ptr\n";
2612
34d99219
JP
2613 CHK("INVALID_UTF8",
2614 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
00df344f
AW
2615 }
2616
15662b3e
JP
2617# Check if it's the start of a commit log
2618# (not a header line and we haven't seen the patch filename)
2619 if ($in_header_lines && $realfile =~ /^$/ &&
29ee1b0c
JP
2620 !($rawline =~ /^\s+\S/ ||
2621 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
15662b3e
JP
2622 $in_header_lines = 0;
2623 $in_commit_log = 1;
ed43c4e5 2624 $has_commit_log = 1;
15662b3e
JP
2625 }
2626
fa64205d
PS
2627# Check if there is UTF-8 in a commit log when a mail header has explicitly
2628# declined it, i.e defined some charset where it is missing.
2629 if ($in_header_lines &&
2630 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2631 $1 !~ /utf-8/i) {
2632 $non_utf8_charset = 1;
2633 }
2634
2635 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
15662b3e 2636 $rawline =~ /$NON_ASCII_UTF8/) {
fa64205d 2637 WARN("UTF8_BEFORE_PATCH",
15662b3e
JP
2638 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2639 }
2640
d6430f71
JP
2641# Check for absolute kernel paths in commit message
2642 if ($tree && $in_commit_log) {
2643 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2644 my $file = $1;
2645
2646 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2647 check_absolute_file($1, $herecurr)) {
2648 #
2649 } else {
2650 check_absolute_file($file, $herecurr);
2651 }
2652 }
2653 }
2654
66b47b4a 2655# Check for various typo / spelling mistakes
66d7a382
JP
2656 if (defined($misspellings) &&
2657 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
ebfd7d62 2658 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
66b47b4a
KC
2659 my $typo = $1;
2660 my $typo_fix = $spelling_fix{lc($typo)};
2661 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2662 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2663 my $msg_type = \&WARN;
2664 $msg_type = \&CHK if ($file);
2665 if (&{$msg_type}("TYPO_SPELLING",
2666 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2667 $fix) {
2668 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2669 }
2670 }
2671 }
2672
30670854
AW
2673# ignore non-hunk lines and lines being removed
2674 next if (!$hunk_line || $line =~ /^-/);
0a920b5b 2675
0a920b5b 2676#trailing whitespace
9c0ca6f9 2677 if ($line =~ /^\+.*\015/) {
c2fdda0d 2678 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
d5e616fc
JP
2679 if (ERROR("DOS_LINE_ENDINGS",
2680 "DOS line endings\n" . $herevet) &&
2681 $fix) {
194f66fc 2682 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
d5e616fc 2683 }
c2fdda0d
AW
2684 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2685 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3705ce5b
JP
2686 if (ERROR("TRAILING_WHITESPACE",
2687 "trailing whitespace\n" . $herevet) &&
2688 $fix) {
194f66fc 2689 $fixed[$fixlinenr] =~ s/\s+$//;
3705ce5b
JP
2690 }
2691
d2c0a235 2692 $rpt_cleaners = 1;
0a920b5b 2693 }
5368df20 2694
4783f894 2695# Check for FSF mailing addresses.
109d8cb2 2696 if ($rawline =~ /\bwrite to the Free/i ||
3e2232f2
JP
2697 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2698 $rawline =~ /\b51\s+Franklin\s+St/i) {
4783f894
JT
2699 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2700 my $msg_type = \&ERROR;
2701 $msg_type = \&CHK if ($file);
2702 &{$msg_type}("FSF_MAILING_ADDRESS",
3e2232f2 2703 "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
2704 }
2705
3354957a 2706# check for Kconfig help text having a real description
9fe287d7
AW
2707# Only applies when adding the entry originally, after that we do not have
2708# sufficient context to determine whether it is indeed long enough.
3354957a 2709 if ($realfile =~ /Kconfig/ &&
8d73e0e7 2710 $line =~ /^\+\s*config\s+/) {
3354957a 2711 my $length = 0;
9fe287d7
AW
2712 my $cnt = $realcnt;
2713 my $ln = $linenr + 1;
2714 my $f;
a1385803 2715 my $is_start = 0;
9fe287d7 2716 my $is_end = 0;
a1385803 2717 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
9fe287d7
AW
2718 $f = $lines[$ln - 1];
2719 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2720 $is_end = $lines[$ln - 1] =~ /^\+/;
9fe287d7
AW
2721
2722 next if ($f =~ /^-/);
8d73e0e7 2723 last if (!$file && $f =~ /^\@\@/);
a1385803 2724
8d73e0e7 2725 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
a1385803 2726 $is_start = 1;
8d73e0e7 2727 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
a1385803
AW
2728 $length = -1;
2729 }
2730
9fe287d7 2731 $f =~ s/^.//;
3354957a
AK
2732 $f =~ s/#.*//;
2733 $f =~ s/^\s+//;
2734 next if ($f =~ /^$/);
9fe287d7
AW
2735 if ($f =~ /^\s*config\s/) {
2736 $is_end = 1;
2737 last;
2738 }
3354957a
AK
2739 $length++;
2740 }
56193274
VB
2741 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2742 WARN("CONFIG_DESCRIPTION",
2743 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2744 }
a1385803 2745 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
3354957a
AK
2746 }
2747
1ba8dfd1
KC
2748# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2749 if ($realfile =~ /Kconfig/ &&
2750 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2751 WARN("CONFIG_EXPERIMENTAL",
2752 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2753 }
2754
327953e9
CJ
2755# discourage the use of boolean for type definition attributes of Kconfig options
2756 if ($realfile =~ /Kconfig/ &&
2757 $line =~ /^\+\s*\bboolean\b/) {
2758 WARN("CONFIG_TYPE_BOOLEAN",
2759 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2760 }
2761
c68e5878
AL
2762 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2763 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2764 my $flag = $1;
2765 my $replacement = {
2766 'EXTRA_AFLAGS' => 'asflags-y',
2767 'EXTRA_CFLAGS' => 'ccflags-y',
2768 'EXTRA_CPPFLAGS' => 'cppflags-y',
2769 'EXTRA_LDFLAGS' => 'ldflags-y',
2770 };
2771
2772 WARN("DEPRECATED_VARIABLE",
2773 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2774 }
2775
bff5da43 2776# check for DT compatible documentation
7dd05b38
FV
2777 if (defined $root &&
2778 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2779 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2780
bff5da43
RH
2781 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2782
cc93319b
FV
2783 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2784 my $vp_file = $dt_path . "vendor-prefixes.txt";
2785
bff5da43
RH
2786 foreach my $compat (@compats) {
2787 my $compat2 = $compat;
185d566b
RH
2788 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2789 my $compat3 = $compat;
2790 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2791 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
bff5da43
RH
2792 if ( $? >> 8 ) {
2793 WARN("UNDOCUMENTED_DT_STRING",
2794 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2795 }
2796
4fbf32a6
FV
2797 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2798 my $vendor = $1;
cc93319b 2799 `grep -Eq "^$vendor\\b" $vp_file`;
bff5da43
RH
2800 if ( $? >> 8 ) {
2801 WARN("UNDOCUMENTED_DT_STRING",
cc93319b 2802 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
bff5da43
RH
2803 }
2804 }
2805 }
2806
5368df20 2807# check we are in a valid source file if not then ignore this hunk
d6430f71 2808 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
5368df20 2809
47e0c88b
JP
2810# line length limit (with some exclusions)
2811#
2812# There are a few types of lines that may extend beyond $max_line_length:
2813# logging functions like pr_info that end in a string
2814# lines with a single string
2815# #defines that are a single string
2816#
2817# There are 3 different line length message types:
2818# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2819# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2820# LONG_LINE all other lines longer than $max_line_length
2821#
2822# if LONG_LINE is ignored, the other 2 types are also ignored
2823#
2824
b4749e96 2825 if ($line =~ /^\+/ && $length > $max_line_length) {
47e0c88b
JP
2826 my $msg_type = "LONG_LINE";
2827
2828 # Check the allowed long line types first
2829
2830 # logging functions that end in a string that starts
2831 # before $max_line_length
2832 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2833 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2834 $msg_type = "";
2835
2836 # lines with only strings (w/ possible termination)
2837 # #defines with only strings
2838 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2839 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2840 $msg_type = "";
2841
d560a5f8
JP
2842 # EFI_GUID is another special case
2843 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/) {
2844 $msg_type = "";
2845
47e0c88b
JP
2846 # Otherwise set the alternate message types
2847
2848 # a comment starts before $max_line_length
2849 } elsif ($line =~ /($;[\s$;]*)$/ &&
2850 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2851 $msg_type = "LONG_LINE_COMMENT"
2852
2853 # a quoted string starts before $max_line_length
2854 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2855 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2856 $msg_type = "LONG_LINE_STRING"
2857 }
2858
2859 if ($msg_type ne "" &&
2860 (show_type("LONG_LINE") || show_type($msg_type))) {
2861 WARN($msg_type,
2862 "line over $max_line_length characters\n" . $herecurr);
2863 }
0a920b5b
AW
2864 }
2865
8905a67c
AW
2866# check for adding lines without a newline.
2867 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
000d1cc1
JP
2868 WARN("MISSING_EOF_NEWLINE",
2869 "adding a line without newline at end of file\n" . $herecurr);
8905a67c
AW
2870 }
2871
42e41c54
MF
2872# Blackfin: use hi/lo macros
2873 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2874 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2875 my $herevet = "$here\n" . cat_vet($line) . "\n";
000d1cc1
JP
2876 ERROR("LO_MACRO",
2877 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
42e41c54
MF
2878 }
2879 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2880 my $herevet = "$here\n" . cat_vet($line) . "\n";
000d1cc1
JP
2881 ERROR("HI_MACRO",
2882 "use the HI() macro, not (... >> 16)\n" . $herevet);
42e41c54
MF
2883 }
2884 }
2885
b9ea10d6 2886# check we are in a valid source file C or perl if not then ignore this hunk
de4c924c 2887 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
0a920b5b
AW
2888
2889# at the beginning of a line any tabs must come first and anything
2890# more than 8 must use tabs.
c2fdda0d
AW
2891 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2892 $rawline =~ /^\+\s* \s*/) {
2893 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
d2c0a235 2894 $rpt_cleaners = 1;
3705ce5b
JP
2895 if (ERROR("CODE_INDENT",
2896 "code indent should use tabs where possible\n" . $herevet) &&
2897 $fix) {
194f66fc 2898 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3705ce5b 2899 }
0a920b5b
AW
2900 }
2901
08e44365
AP
2902# check for space before tabs.
2903 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2904 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3705ce5b
JP
2905 if (WARN("SPACE_BEFORE_TAB",
2906 "please, no space before tabs\n" . $herevet) &&
2907 $fix) {
194f66fc 2908 while ($fixed[$fixlinenr] =~
d2207ccb 2909 s/(^\+.*) {8,8}\t/$1\t\t/) {}
194f66fc 2910 while ($fixed[$fixlinenr] =~
c76f4cb3 2911 s/(^\+.*) +\t/$1\t/) {}
3705ce5b 2912 }
08e44365
AP
2913 }
2914
d1fe9c09
JP
2915# check for && or || at the start of a line
2916 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2917 CHK("LOGICAL_CONTINUATIONS",
2918 "Logical continuations should be on the previous line\n" . $hereprev);
2919 }
2920
a91e8994
JP
2921# check indentation starts on a tab stop
2922 if ($^V && $^V ge 5.10.0 &&
2923 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) {
2924 my $indent = length($1);
2925 if ($indent % 8) {
2926 if (WARN("TABSTOP",
2927 "Statements should start on a tabstop\n" . $herecurr) &&
2928 $fix) {
2929 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
2930 }
2931 }
2932 }
2933
d1fe9c09
JP
2934# check multi-line statement indentation matches previous line
2935 if ($^V && $^V ge 5.10.0 &&
91cb5195 2936 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
d1fe9c09
JP
2937 $prevline =~ /^\+(\t*)(.*)$/;
2938 my $oldindent = $1;
2939 my $rest = $2;
2940
2941 my $pos = pos_last_openparen($rest);
2942 if ($pos >= 0) {
b34a26f3
JP
2943 $line =~ /^(\+| )([ \t]*)/;
2944 my $newindent = $2;
d1fe9c09
JP
2945
2946 my $goodtabindent = $oldindent .
2947 "\t" x ($pos / 8) .
2948 " " x ($pos % 8);
2949 my $goodspaceindent = $oldindent . " " x $pos;
2950
2951 if ($newindent ne $goodtabindent &&
2952 $newindent ne $goodspaceindent) {
3705ce5b
JP
2953
2954 if (CHK("PARENTHESIS_ALIGNMENT",
2955 "Alignment should match open parenthesis\n" . $hereprev) &&
2956 $fix && $line =~ /^\+/) {
194f66fc 2957 $fixed[$fixlinenr] =~
3705ce5b
JP
2958 s/^\+[ \t]*/\+$goodtabindent/;
2959 }
d1fe9c09
JP
2960 }
2961 }
2962 }
2963
6ab3a970
JP
2964# check for space after cast like "(int) foo" or "(struct foo) bar"
2965# avoid checking a few false positives:
2966# "sizeof(<type>)" or "__alignof__(<type>)"
2967# function pointer declarations like "(*foo)(int) = bar;"
2968# structure definitions like "(struct foo) { 0 };"
2969# multiline macros that define functions
2970# known attributes or the __attribute__ keyword
2971 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2972 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
3705ce5b 2973 if (CHK("SPACING",
f27c95db 2974 "No space is necessary after a cast\n" . $herecurr) &&
3705ce5b 2975 $fix) {
194f66fc 2976 $fixed[$fixlinenr] =~
f27c95db 2977 s/(\(\s*$Type\s*\))[ \t]+/$1/;
3705ce5b 2978 }
aad4f614
JP
2979 }
2980
86406b1c
JP
2981# Block comment styles
2982# Networking with an initial /*
05880600 2983 if ($realfile =~ m@^(drivers/net/|net/)@ &&
fdb4bcd6 2984 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
85ad978c
JP
2985 $rawline =~ /^\+[ \t]*\*/ &&
2986 $realline > 2) {
05880600
JP
2987 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2988 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2989 }
2990
86406b1c
JP
2991# Block comments use * on subsequent lines
2992 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
2993 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
a605e32e 2994 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
61135e96 2995 $rawline =~ /^\+/ && #line is new
a605e32e 2996 $rawline !~ /^\+[ \t]*\*/) { #no leading *
86406b1c
JP
2997 WARN("BLOCK_COMMENT_STYLE",
2998 "Block comments use * on subsequent lines\n" . $hereprev);
a605e32e
JP
2999 }
3000
86406b1c
JP
3001# Block comments use */ on trailing lines
3002 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
c24f9f19
JP
3003 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3004 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3005 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
86406b1c
JP
3006 WARN("BLOCK_COMMENT_STYLE",
3007 "Block comments use a trailing */ on a separate line\n" . $herecurr);
05880600
JP
3008 }
3009
08eb9b80
JP
3010# Block comment * alignment
3011 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
af207524
JP
3012 $line =~ /^\+[ \t]*$;/ && #leading comment
3013 $rawline =~ /^\+[ \t]*\*/ && #leading *
3014 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
08eb9b80 3015 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
af207524
JP
3016 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3017 my $oldindent;
08eb9b80 3018 $prevrawline =~ m@^\+([ \t]*/?)\*@;
af207524
JP
3019 if (defined($1)) {
3020 $oldindent = expand_tabs($1);
3021 } else {
3022 $prevrawline =~ m@^\+(.*/?)\*@;
3023 $oldindent = expand_tabs($1);
3024 }
08eb9b80
JP
3025 $rawline =~ m@^\+([ \t]*)\*@;
3026 my $newindent = $1;
08eb9b80 3027 $newindent = expand_tabs($newindent);
af207524 3028 if (length($oldindent) ne length($newindent)) {
08eb9b80
JP
3029 WARN("BLOCK_COMMENT_STYLE",
3030 "Block comments should align the * on each line\n" . $hereprev);
3031 }
3032 }
3033
7f619191
JP
3034# check for missing blank lines after struct/union declarations
3035# with exceptions for various attributes and macros
3036 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3037 $line =~ /^\+/ &&
3038 !($line =~ /^\+\s*$/ ||
3039 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3040 $line =~ /^\+\s*MODULE_/i ||
3041 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3042 $line =~ /^\+[a-z_]*init/ ||
3043 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3044 $line =~ /^\+\s*DECLARE/ ||
3045 $line =~ /^\+\s*__setup/)) {
d752fcc8
JP
3046 if (CHK("LINE_SPACING",
3047 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3048 $fix) {
f2d7e4d4 3049 fix_insert_line($fixlinenr, "\+");
d752fcc8 3050 }
7f619191
JP
3051 }
3052
365dd4ea
JP
3053# check for multiple consecutive blank lines
3054 if ($prevline =~ /^[\+ ]\s*$/ &&
3055 $line =~ /^\+\s*$/ &&
3056 $last_blank_line != ($linenr - 1)) {
d752fcc8
JP
3057 if (CHK("LINE_SPACING",
3058 "Please don't use multiple blank lines\n" . $hereprev) &&
3059 $fix) {
f2d7e4d4 3060 fix_delete_line($fixlinenr, $rawline);
d752fcc8
JP
3061 }
3062
365dd4ea
JP
3063 $last_blank_line = $linenr;
3064 }
3065
3b617e3b 3066# check for missing blank lines after declarations
3f7bac03
JP
3067 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3068 # actual declarations
3069 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
5a4e1fd3
JP
3070 # function pointer declarations
3071 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3f7bac03
JP
3072 # foo bar; where foo is some local typedef or #define
3073 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3074 # known declaration macros
3075 $prevline =~ /^\+\s+$declaration_macros/) &&
3076 # for "else if" which can look like "$Ident $Ident"
3077 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3078 # other possible extensions of declaration lines
3079 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3080 # not starting a section or a macro "\" extended line
3081 $prevline =~ /(?:\{\s*|\\)$/) &&
3082 # looks like a declaration
3083 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
5a4e1fd3
JP
3084 # function pointer declarations
3085 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3f7bac03
JP
3086 # foo bar; where foo is some local typedef or #define
3087 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3088 # known declaration macros
3089 $sline =~ /^\+\s+$declaration_macros/ ||
3090 # start of struct or union or enum
3b617e3b 3091 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
3f7bac03
JP
3092 # start or end of block or continuation of declaration
3093 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3094 # bitfield continuation
3095 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3096 # other possible extensions of declaration lines
3097 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3098 # indentation of previous and current line are the same
3099 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
d752fcc8
JP
3100 if (WARN("LINE_SPACING",
3101 "Missing a blank line after declarations\n" . $hereprev) &&
3102 $fix) {
f2d7e4d4 3103 fix_insert_line($fixlinenr, "\+");
d752fcc8 3104 }
3b617e3b
JP
3105 }
3106
5f7ddae6 3107# check for spaces at the beginning of a line.
6b4c5beb
AW
3108# Exceptions:
3109# 1) within comments
3110# 2) indented preprocessor commands
3111# 3) hanging labels
3705ce5b 3112 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
5f7ddae6 3113 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3705ce5b
JP
3114 if (WARN("LEADING_SPACE",
3115 "please, no spaces at the start of a line\n" . $herevet) &&
3116 $fix) {
194f66fc 3117 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3705ce5b 3118 }
5f7ddae6
RR
3119 }
3120
b9ea10d6
AW
3121# check we are in a valid C source file if not then ignore this hunk
3122 next if ($realfile !~ /\.(h|c)$/);
3123
032a4c0f 3124# check indentation of any line with a bare else
840080a0 3125# (but not if it is a multiple line "if (foo) return bar; else return baz;")
032a4c0f
JP
3126# if the previous line is a break or return and is indented 1 tab more...
3127 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3128 my $tabs = length($1) + 1;
840080a0
JP
3129 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3130 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3131 defined $lines[$linenr] &&
3132 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
032a4c0f
JP
3133 WARN("UNNECESSARY_ELSE",
3134 "else is not generally useful after a break or return\n" . $hereprev);
3135 }
3136 }
3137
c00df19a
JP
3138# check indentation of a line with a break;
3139# if the previous line is a goto or return and is indented the same # of tabs
3140 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3141 my $tabs = $1;
3142 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3143 WARN("UNNECESSARY_BREAK",
3144 "break is not useful after a goto or return\n" . $hereprev);
3145 }
3146 }
3147
1ba8dfd1
KC
3148# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
3149 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
3150 WARN("CONFIG_EXPERIMENTAL",
3151 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
3152 }
3153
c2fdda0d 3154# check for RCS/CVS revision markers
cf655043 3155 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
000d1cc1
JP
3156 WARN("CVS_KEYWORD",
3157 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
c2fdda0d 3158 }
22f2a2ef 3159
42e41c54
MF
3160# Blackfin: don't use __builtin_bfin_[cs]sync
3161 if ($line =~ /__builtin_bfin_csync/) {
3162 my $herevet = "$here\n" . cat_vet($line) . "\n";
000d1cc1
JP
3163 ERROR("CSYNC",
3164 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
42e41c54
MF
3165 }
3166 if ($line =~ /__builtin_bfin_ssync/) {
3167 my $herevet = "$here\n" . cat_vet($line) . "\n";
000d1cc1
JP
3168 ERROR("SSYNC",
3169 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
42e41c54
MF
3170 }
3171
56e77d70
JP
3172# check for old HOTPLUG __dev<foo> section markings
3173 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3174 WARN("HOTPLUG_SECTION",
3175 "Using $1 is unnecessary\n" . $herecurr);
3176 }
3177
9c0ca6f9 3178# Check for potential 'bare' types
2b474a1a
AW
3179 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3180 $realline_next);
3e469cdc
AW
3181#print "LINE<$line>\n";
3182 if ($linenr >= $suppress_statement &&
1b5539b1 3183 $realcnt && $sline =~ /.\s*\S/) {
170d3a22 3184 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
f5fe35dd 3185 ctx_statement_block($linenr, $realcnt, 0);
171ae1a4
AW
3186 $stat =~ s/\n./\n /g;
3187 $cond =~ s/\n./\n /g;
3188
3e469cdc
AW
3189#print "linenr<$linenr> <$stat>\n";
3190 # If this statement has no statement boundaries within
3191 # it there is no point in retrying a statement scan
3192 # until we hit end of it.
3193 my $frag = $stat; $frag =~ s/;+\s*$//;
3194 if ($frag !~ /(?:{|;)/) {
3195#print "skip<$line_nr_next>\n";
3196 $suppress_statement = $line_nr_next;
3197 }
f74bd194 3198
2b474a1a
AW
3199 # Find the real next line.
3200 $realline_next = $line_nr_next;
3201 if (defined $realline_next &&
3202 (!defined $lines[$realline_next - 1] ||
3203 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3204 $realline_next++;
3205 }
3206
171ae1a4
AW
3207 my $s = $stat;
3208 $s =~ s/{.*$//s;
cf655043 3209
c2fdda0d 3210 # Ignore goto labels.
171ae1a4 3211 if ($s =~ /$Ident:\*$/s) {
c2fdda0d
AW
3212
3213 # Ignore functions being called
171ae1a4 3214 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
c2fdda0d 3215
463f2864
AW
3216 } elsif ($s =~ /^.\s*else\b/s) {
3217
c45dcabd 3218 # declarations always start with types
d2506586 3219 } 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
3220 my $type = $1;
3221 $type =~ s/\s+/ /g;
3222 possible($type, "A:" . $s);
3223
8905a67c 3224 # definitions in global scope can only start with types
a6a84062 3225 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
c45dcabd 3226 possible($1, "B:" . $s);
c2fdda0d 3227 }
8905a67c
AW
3228
3229 # any (foo ... *) is a pointer cast, and foo is a type
65863862 3230 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
c45dcabd 3231 possible($1, "C:" . $s);
8905a67c
AW
3232 }
3233
3234 # Check for any sort of function declaration.
3235 # int foo(something bar, other baz);
3236 # void (*store_gdt)(x86_descr_ptr *);
171ae1a4 3237 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
8905a67c 3238 my ($name_len) = length($1);
8905a67c 3239
cf655043 3240 my $ctx = $s;
773647a0 3241 substr($ctx, 0, $name_len + 1, '');
8905a67c 3242 $ctx =~ s/\)[^\)]*$//;
cf655043 3243
8905a67c 3244 for my $arg (split(/\s*,\s*/, $ctx)) {
c45dcabd 3245 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
8905a67c 3246
c45dcabd 3247 possible($1, "D:" . $s);
8905a67c
AW
3248 }
3249 }
9c0ca6f9 3250 }
8905a67c 3251
9c0ca6f9
AW
3252 }
3253
653d4876
AW
3254#
3255# Checks which may be anchored in the context.
3256#
00df344f 3257
653d4876
AW
3258# Check for switch () and associated case and default
3259# statements should be at the same indent.
00df344f
AW
3260 if ($line=~/\bswitch\s*\(.*\)/) {
3261 my $err = '';
3262 my $sep = '';
3263 my @ctx = ctx_block_outer($linenr, $realcnt);
3264 shift(@ctx);
3265 for my $ctx (@ctx) {
3266 my ($clen, $cindent) = line_stats($ctx);
3267 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3268 $indent != $cindent) {
3269 $err .= "$sep$ctx\n";
3270 $sep = '';
3271 } else {
3272 $sep = "[...]\n";
3273 }
3274 }
3275 if ($err ne '') {
000d1cc1
JP
3276 ERROR("SWITCH_CASE_INDENT_LEVEL",
3277 "switch and case should be at the same indent\n$hereline$err");
de7d4f0e
AW
3278 }
3279 }
3280
3281# if/while/etc brace do not go on next line, unless defining a do while loop,
3282# or if that brace on the next line is for something else
0fe3dc2b 3283 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
773647a0
AW
3284 my $pre_ctx = "$1$2";
3285
9c0ca6f9 3286 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
8eef05dd
JP
3287
3288 if ($line =~ /^\+\t{6,}/) {
3289 WARN("DEEP_INDENTATION",
3290 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3291 }
3292
de7d4f0e
AW
3293 my $ctx_cnt = $realcnt - $#ctx - 1;
3294 my $ctx = join("\n", @ctx);
3295
548596d5
AW
3296 my $ctx_ln = $linenr;
3297 my $ctx_skip = $realcnt;
773647a0 3298
548596d5
AW
3299 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3300 defined $lines[$ctx_ln - 1] &&
3301 $lines[$ctx_ln - 1] =~ /^-/)) {
3302 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3303 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
de7d4f0e 3304 $ctx_ln++;
de7d4f0e 3305 }
548596d5 3306
53210168
AW
3307 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3308 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
de7d4f0e 3309
d752fcc8 3310 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
000d1cc1
JP
3311 ERROR("OPEN_BRACE",
3312 "that open brace { should be on the previous line\n" .
01464f30 3313 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
00df344f 3314 }
773647a0
AW
3315 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3316 $ctx =~ /\)\s*\;\s*$/ &&
3317 defined $lines[$ctx_ln - 1])
3318 {
9c0ca6f9
AW
3319 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3320 if ($nindent > $indent) {
000d1cc1
JP
3321 WARN("TRAILING_SEMICOLON",
3322 "trailing semicolon indicates no statements, indent implies otherwise\n" .
01464f30 3323 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
9c0ca6f9
AW
3324 }
3325 }
00df344f
AW
3326 }
3327
4d001e4d 3328# Check relative indent for conditionals and blocks.
0fe3dc2b 3329 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3e469cdc
AW
3330 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3331 ctx_statement_block($linenr, $realcnt, 0)
3332 if (!defined $stat);
4d001e4d
AW
3333 my ($s, $c) = ($stat, $cond);
3334
3335 substr($s, 0, length($c), '');
3336
9f5af480
JP
3337 # remove inline comments
3338 $s =~ s/$;/ /g;
3339 $c =~ s/$;/ /g;
4d001e4d
AW
3340
3341 # Find out how long the conditional actually is.
6f779c18
AW
3342 my @newlines = ($c =~ /\n/gs);
3343 my $cond_lines = 1 + $#newlines;
4d001e4d 3344
9f5af480
JP
3345 # Make sure we remove the line prefixes as we have
3346 # none on the first line, and are going to readd them
3347 # where necessary.
3348 $s =~ s/\n./\n/gs;
3349 while ($s =~ /\n\s+\\\n/) {
3350 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3351 }
3352
4d001e4d
AW
3353 # We want to check the first line inside the block
3354 # starting at the end of the conditional, so remove:
3355 # 1) any blank line termination
3356 # 2) any opening brace { on end of the line
3357 # 3) any do (...) {
3358 my $continuation = 0;
3359 my $check = 0;
3360 $s =~ s/^.*\bdo\b//;
3361 $s =~ s/^\s*{//;
3362 if ($s =~ s/^\s*\\//) {
3363 $continuation = 1;
3364 }
9bd49efe 3365 if ($s =~ s/^\s*?\n//) {
4d001e4d
AW
3366 $check = 1;
3367 $cond_lines++;
3368 }
3369
3370 # Also ignore a loop construct at the end of a
3371 # preprocessor statement.
3372 if (($prevline =~ /^.\s*#\s*define\s/ ||
3373 $prevline =~ /\\\s*$/) && $continuation == 0) {
3374 $check = 0;
3375 }
3376
9bd49efe 3377 my $cond_ptr = -1;
740504c6 3378 $continuation = 0;
9bd49efe
AW
3379 while ($cond_ptr != $cond_lines) {
3380 $cond_ptr = $cond_lines;
3381
f16fa28f
AW
3382 # If we see an #else/#elif then the code
3383 # is not linear.
3384 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3385 $check = 0;
3386 }
3387
9bd49efe
AW
3388 # Ignore:
3389 # 1) blank lines, they should be at 0,
3390 # 2) preprocessor lines, and
3391 # 3) labels.
740504c6
AW
3392 if ($continuation ||
3393 $s =~ /^\s*?\n/ ||
9bd49efe
AW
3394 $s =~ /^\s*#\s*?/ ||
3395 $s =~ /^\s*$Ident\s*:/) {
740504c6 3396 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
30dad6eb
AW
3397 if ($s =~ s/^.*?\n//) {
3398 $cond_lines++;
3399 }
9bd49efe 3400 }
4d001e4d
AW
3401 }
3402
3403 my (undef, $sindent) = line_stats("+" . $s);
3404 my $stat_real = raw_line($linenr, $cond_lines);
3405
3406 # Check if either of these lines are modified, else
3407 # this is not this patch's fault.
3408 if (!defined($stat_real) ||
3409 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3410 $check = 0;
3411 }
3412 if (defined($stat_real) && $cond_lines > 1) {
3413 $stat_real = "[...]\n$stat_real";
3414 }
3415
9bd49efe 3416 #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 3417
9f5af480
JP
3418 if ($check && $s ne '' &&
3419 (($sindent % 8) != 0 ||
3420 ($sindent < $indent) ||
3421 ($sindent > $indent + 8))) {
000d1cc1
JP
3422 WARN("SUSPECT_CODE_INDENT",
3423 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
4d001e4d
AW
3424 }
3425 }
3426
6c72ffaa
AW
3427 # Track the 'values' across context and added lines.
3428 my $opline = $line; $opline =~ s/^./ /;
1f65f947
AW
3429 my ($curr_values, $curr_vars) =
3430 annotate_values($opline . "\n", $prev_values);
6c72ffaa 3431 $curr_values = $prev_values . $curr_values;
c2fdda0d
AW
3432 if ($dbg_values) {
3433 my $outline = $opline; $outline =~ s/\t/ /g;
cf655043
AW
3434 print "$linenr > .$outline\n";
3435 print "$linenr > $curr_values\n";
1f65f947 3436 print "$linenr > $curr_vars\n";
c2fdda0d 3437 }
6c72ffaa
AW
3438 $prev_values = substr($curr_values, -1);
3439
00df344f 3440#ignore lines not being added
3705ce5b 3441 next if ($line =~ /^[^\+]/);
00df344f 3442
11ca40a0
JP
3443# check for dereferences that span multiple lines
3444 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3445 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3446 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3447 my $ref = $1;
3448 $line =~ /^.\s*($Lval)/;
3449 $ref .= $1;
3450 $ref =~ s/\s//g;
3451 WARN("MULTILINE_DEREFERENCE",
3452 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3453 }
3454
a1ce18e4 3455# check for declarations of signed or unsigned without int
c8447115 3456 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
a1ce18e4
JP
3457 my $type = $1;
3458 my $var = $2;
207a8e84
JP
3459 $var = "" if (!defined $var);
3460 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
a1ce18e4
JP
3461 my $sign = $1;
3462 my $pointer = $2;
3463
3464 $pointer = "" if (!defined $pointer);
3465
3466 if (WARN("UNSPECIFIED_INT",
3467 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3468 $fix) {
3469 my $decl = trim($sign) . " int ";
207a8e84
JP
3470 my $comp_pointer = $pointer;
3471 $comp_pointer =~ s/\s//g;
3472 $decl .= $comp_pointer;
3473 $decl = rtrim($decl) if ($var eq "");
3474 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
a1ce18e4
JP
3475 }
3476 }
3477 }
3478
653d4876 3479# TEST: allow direct testing of the type matcher.
7429c690
AW
3480 if ($dbg_type) {
3481 if ($line =~ /^.\s*$Declare\s*$/) {
000d1cc1
JP
3482 ERROR("TEST_TYPE",
3483 "TEST: is type\n" . $herecurr);
7429c690 3484 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
000d1cc1
JP
3485 ERROR("TEST_NOT_TYPE",
3486 "TEST: is not type ($1 is)\n". $herecurr);
7429c690 3487 }
653d4876
AW
3488 next;
3489 }
a1ef277e
AW
3490# TEST: allow direct testing of the attribute matcher.
3491 if ($dbg_attr) {
9360b0e5 3492 if ($line =~ /^.\s*$Modifier\s*$/) {
000d1cc1
JP
3493 ERROR("TEST_ATTR",
3494 "TEST: is attr\n" . $herecurr);
9360b0e5 3495 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
000d1cc1
JP
3496 ERROR("TEST_NOT_ATTR",
3497 "TEST: is not attr ($1 is)\n". $herecurr);
a1ef277e
AW
3498 }
3499 next;
3500 }
653d4876 3501
f0a594c1 3502# check for initialisation to aggregates open brace on the next line
99423c20
AW
3503 if ($line =~ /^.\s*{/ &&
3504 $prevline =~ /(?:^|[^=])=\s*$/) {
d752fcc8
JP
3505 if (ERROR("OPEN_BRACE",
3506 "that open brace { should be on the previous line\n" . $hereprev) &&
f2d7e4d4
JP
3507 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3508 fix_delete_line($fixlinenr - 1, $prevrawline);
3509 fix_delete_line($fixlinenr, $rawline);
d752fcc8
JP
3510 my $fixedline = $prevrawline;
3511 $fixedline =~ s/\s*=\s*$/ = {/;
f2d7e4d4 3512 fix_insert_line($fixlinenr, $fixedline);
d752fcc8
JP
3513 $fixedline = $line;
3514 $fixedline =~ s/^(.\s*){\s*/$1/;
f2d7e4d4 3515 fix_insert_line($fixlinenr, $fixedline);
d752fcc8 3516 }
f0a594c1
AW
3517 }
3518
653d4876
AW
3519#
3520# Checks which are anchored on the added line.
3521#
3522
3523# check for malformed paths in #include statements (uses RAW line)
c45dcabd 3524 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
653d4876
AW
3525 my $path = $1;
3526 if ($path =~ m{//}) {
000d1cc1 3527 ERROR("MALFORMED_INCLUDE",
495e9d84
JP
3528 "malformed #include filename\n" . $herecurr);
3529 }
3530 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3531 ERROR("UAPI_INCLUDE",
3532 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
653d4876 3533 }
653d4876 3534 }
00df344f 3535
0a920b5b 3536# no C99 // comments
00df344f 3537 if ($line =~ m{//}) {
3705ce5b
JP
3538 if (ERROR("C99_COMMENTS",
3539 "do not use C99 // comments\n" . $herecurr) &&
3540 $fix) {
194f66fc 3541 my $line = $fixed[$fixlinenr];
3705ce5b
JP
3542 if ($line =~ /\/\/(.*)$/) {
3543 my $comment = trim($1);
194f66fc 3544 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3705ce5b
JP
3545 }
3546 }
0a920b5b 3547 }
00df344f 3548 # Remove C99 comments.
0a920b5b 3549 $line =~ s@//.*@@;
6c72ffaa 3550 $opline =~ s@//.*@@;
0a920b5b 3551
2b474a1a
AW
3552# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3553# the whole statement.
3554#print "APW <$lines[$realline_next - 1]>\n";
3555 if (defined $realline_next &&
3556 exists $lines[$realline_next - 1] &&
3557 !defined $suppress_export{$realline_next} &&
3558 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3559 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3cbf62df
AW
3560 # Handle definitions which produce identifiers with
3561 # a prefix:
3562 # XXX(foo);
3563 # EXPORT_SYMBOL(something_foo);
653d4876 3564 my $name = $1;
87a53877 3565 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3cbf62df
AW
3566 $name =~ /^${Ident}_$2/) {
3567#print "FOO C name<$name>\n";
3568 $suppress_export{$realline_next} = 1;
3569
3570 } elsif ($stat !~ /(?:
2b474a1a 3571 \n.}\s*$|
48012058
AW
3572 ^.DEFINE_$Ident\(\Q$name\E\)|
3573 ^.DECLARE_$Ident\(\Q$name\E\)|
3574 ^.LIST_HEAD\(\Q$name\E\)|
2b474a1a
AW
3575 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3576 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
48012058 3577 )/x) {
2b474a1a
AW
3578#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3579 $suppress_export{$realline_next} = 2;
3580 } else {
3581 $suppress_export{$realline_next} = 1;
0a920b5b
AW
3582 }
3583 }
2b474a1a
AW
3584 if (!defined $suppress_export{$linenr} &&
3585 $prevline =~ /^.\s*$/ &&
3586 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3587 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3588#print "FOO B <$lines[$linenr - 1]>\n";
3589 $suppress_export{$linenr} = 2;
3590 }
3591 if (defined $suppress_export{$linenr} &&
3592 $suppress_export{$linenr} == 2) {
000d1cc1
JP
3593 WARN("EXPORT_SYMBOL",
3594 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2b474a1a 3595 }
0a920b5b 3596
5150bda4 3597# check for global initialisers.
6d32f7a3 3598 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
d5e616fc 3599 if (ERROR("GLOBAL_INITIALISERS",
6d32f7a3 3600 "do not initialise globals to $1\n" . $herecurr) &&
d5e616fc 3601 $fix) {
6d32f7a3 3602 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
d5e616fc 3603 }
f0a594c1 3604 }
653d4876 3605# check for static initialisers.
6d32f7a3 3606 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
d5e616fc 3607 if (ERROR("INITIALISED_STATIC",
6d32f7a3 3608 "do not initialise statics to $1\n" .
d5e616fc
JP
3609 $herecurr) &&
3610 $fix) {
6d32f7a3 3611 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
d5e616fc 3612 }
0a920b5b
AW
3613 }
3614
1813087d
JP
3615# check for misordered declarations of char/short/int/long with signed/unsigned
3616 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3617 my $tmp = trim($1);
3618 WARN("MISORDERED_TYPE",
3619 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3620 }
3621
cb710eca
JP
3622# check for static const char * arrays.
3623 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
000d1cc1
JP
3624 WARN("STATIC_CONST_CHAR_ARRAY",
3625 "static const char * array should probably be static const char * const\n" .
cb710eca
JP
3626 $herecurr);
3627 }
3628
3629# check for static char foo[] = "bar" declarations.
3630 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
000d1cc1
JP
3631 WARN("STATIC_CONST_CHAR_ARRAY",
3632 "static char array declaration should probably be static const char\n" .
cb710eca
JP
3633 $herecurr);
3634 }
3635
ab7e23f3
JP
3636# check for const <foo> const where <foo> is not a pointer or array type
3637 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3638 my $found = $1;
3639 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3640 WARN("CONST_CONST",
3641 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3642 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3643 WARN("CONST_CONST",
3644 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3645 }
3646 }
3647
9b0fa60d
JP
3648# check for non-global char *foo[] = {"bar", ...} declarations.
3649 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3650 WARN("STATIC_CONST_CHAR_ARRAY",
3651 "char * array declaration might be better as static const\n" .
3652 $herecurr);
3653 }
3654
b598b670
JP
3655# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3656 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3657 my $array = $1;
3658 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3659 my $array_div = $1;
3660 if (WARN("ARRAY_SIZE",
3661 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3662 $fix) {
3663 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3664 }
3665 }
3666 }
3667
b36190c5
JP
3668# check for function declarations without arguments like "int foo()"
3669 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3670 if (ERROR("FUNCTION_WITHOUT_ARGS",
3671 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3672 $fix) {
194f66fc 3673 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
b36190c5
JP
3674 }
3675 }
3676
653d4876
AW
3677# check for new typedefs, only function parameters and sparse annotations
3678# make sense.
3679 if ($line =~ /\btypedef\s/ &&
8054576d 3680 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
c45dcabd 3681 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
8ed22cad 3682 $line !~ /\b$typeTypedefs\b/ &&
653d4876 3683 $line !~ /\b__bitwise(?:__|)\b/) {
000d1cc1
JP
3684 WARN("NEW_TYPEDEFS",
3685 "do not add new typedefs\n" . $herecurr);
0a920b5b
AW
3686 }
3687
3688# * goes on variable not on type
65863862 3689 # (char*[ const])
bfcb2cc7
AW
3690 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3691 #print "AA<$1>\n";
3705ce5b 3692 my ($ident, $from, $to) = ($1, $2, $2);
65863862
AW
3693
3694 # Should start with a space.
3695 $to =~ s/^(\S)/ $1/;
3696 # Should not end with a space.
3697 $to =~ s/\s+$//;
3698 # '*'s should not have spaces between.
f9a0b3d1 3699 while ($to =~ s/\*\s+\*/\*\*/) {
65863862 3700 }
d8aaf121 3701
3705ce5b 3702## print "1: from<$from> to<$to> ident<$ident>\n";
65863862 3703 if ($from ne $to) {
3705ce5b
JP
3704 if (ERROR("POINTER_LOCATION",
3705 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3706 $fix) {
3707 my $sub_from = $ident;
3708 my $sub_to = $ident;
3709 $sub_to =~ s/\Q$from\E/$to/;
194f66fc 3710 $fixed[$fixlinenr] =~
3705ce5b
JP
3711 s@\Q$sub_from\E@$sub_to@;
3712 }
65863862 3713 }
bfcb2cc7
AW
3714 }
3715 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3716 #print "BB<$1>\n";
3705ce5b 3717 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
65863862
AW
3718
3719 # Should start with a space.
3720 $to =~ s/^(\S)/ $1/;
3721 # Should not end with a space.
3722 $to =~ s/\s+$//;
3723 # '*'s should not have spaces between.
f9a0b3d1 3724 while ($to =~ s/\*\s+\*/\*\*/) {
65863862
AW
3725 }
3726 # Modifiers should have spaces.
3727 $to =~ s/(\b$Modifier$)/$1 /;
d8aaf121 3728
3705ce5b 3729## print "2: from<$from> to<$to> ident<$ident>\n";
667026e7 3730 if ($from ne $to && $ident !~ /^$Modifier$/) {
3705ce5b
JP
3731 if (ERROR("POINTER_LOCATION",
3732 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3733 $fix) {
3734
3735 my $sub_from = $match;
3736 my $sub_to = $match;
3737 $sub_to =~ s/\Q$from\E/$to/;
194f66fc 3738 $fixed[$fixlinenr] =~
3705ce5b
JP
3739 s@\Q$sub_from\E@$sub_to@;
3740 }
65863862 3741 }
0a920b5b
AW
3742 }
3743
9d3e3c70
JP
3744# avoid BUG() or BUG_ON()
3745 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3746 my $msg_type = \&WARN;
3747 $msg_type = \&CHK if ($file);
3748 &{$msg_type}("AVOID_BUG",
3749 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3750 }
0a920b5b 3751
9d3e3c70 3752# avoid LINUX_VERSION_CODE
8905a67c 3753 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
000d1cc1
JP
3754 WARN("LINUX_VERSION_CODE",
3755 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
8905a67c
AW
3756 }
3757
17441227
JP
3758# check for uses of printk_ratelimit
3759 if ($line =~ /\bprintk_ratelimit\s*\(/) {
000d1cc1 3760 WARN("PRINTK_RATELIMITED",
101ee680 3761 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
17441227
JP
3762 }
3763
00df344f
AW
3764# printk should use KERN_* levels. Note that follow on printk's on the
3765# same line do not need a level, so we use the current block context
3766# to try and find and validate the current printk. In summary the current
25985edc 3767# printk includes all preceding printk's which have no newline on the end.
00df344f 3768# we assume the first bad printk is the one to report.
f0a594c1 3769 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
00df344f
AW
3770 my $ok = 0;
3771 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3772 #print "CHECK<$lines[$ln - 1]\n";
25985edc 3773 # we have a preceding printk if it ends
00df344f
AW
3774 # with "\n" ignore it, else it is to blame
3775 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3776 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3777 $ok = 1;
3778 }
3779 last;
3780 }
3781 }
3782 if ($ok == 0) {
000d1cc1
JP
3783 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3784 "printk() should include KERN_ facility level\n" . $herecurr);
00df344f 3785 }
0a920b5b
AW
3786 }
3787
243f3803
JP
3788 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3789 my $orig = $1;
3790 my $level = lc($orig);
3791 $level = "warn" if ($level eq "warning");
8f26b837
JP
3792 my $level2 = $level;
3793 $level2 = "dbg" if ($level eq "debug");
243f3803 3794 WARN("PREFER_PR_LEVEL",
daa8b059 3795 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
243f3803
JP
3796 }
3797
3798 if ($line =~ /\bpr_warning\s*\(/) {
d5e616fc
JP
3799 if (WARN("PREFER_PR_LEVEL",
3800 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3801 $fix) {
194f66fc 3802 $fixed[$fixlinenr] =~
d5e616fc
JP
3803 s/\bpr_warning\b/pr_warn/;
3804 }
243f3803
JP
3805 }
3806
dc139313
JP
3807 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3808 my $orig = $1;
3809 my $level = lc($orig);
3810 $level = "warn" if ($level eq "warning");
3811 $level = "dbg" if ($level eq "debug");
3812 WARN("PREFER_DEV_LEVEL",
3813 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3814 }
3815
91c9afaf
AL
3816# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3817# number of false positives, but assembly files are not checked, so at
3818# least the arch entry code will not trigger this warning.
3819 if ($line =~ /\bENOSYS\b/) {
3820 WARN("ENOSYS",
3821 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3822 }
3823
653d4876
AW
3824# function brace can't be on same line, except for #defines of do while,
3825# or if closed on same line
8d182478 3826 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
4e5d56bd 3827 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
8d182478
JP
3828 if (ERROR("OPEN_BRACE",
3829 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3830 $fix) {
3831 fix_delete_line($fixlinenr, $rawline);
3832 my $fixed_line = $rawline;
3833 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3834 my $line1 = $1;
3835 my $line2 = $2;
3836 fix_insert_line($fixlinenr, ltrim($line1));
3837 fix_insert_line($fixlinenr, "\+{");
3838 if ($line2 !~ /^\s*$/) {
3839 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3840 }
3841 }
0a920b5b 3842 }
653d4876 3843
8905a67c
AW
3844# open braces for enum, union and struct go on the same line.
3845 if ($line =~ /^.\s*{/ &&
3846 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
8d182478
JP
3847 if (ERROR("OPEN_BRACE",
3848 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3849 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3850 fix_delete_line($fixlinenr - 1, $prevrawline);
3851 fix_delete_line($fixlinenr, $rawline);
3852 my $fixedline = rtrim($prevrawline) . " {";
3853 fix_insert_line($fixlinenr, $fixedline);
3854 $fixedline = $rawline;
3855 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3856 if ($fixedline !~ /^\+\s*$/) {
3857 fix_insert_line($fixlinenr, $fixedline);
3858 }
3859 }
8905a67c
AW
3860 }
3861
0c73b4eb 3862# missing space after union, struct or enum definition
3705ce5b
JP
3863 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3864 if (WARN("SPACING",
3865 "missing space after $1 definition\n" . $herecurr) &&
3866 $fix) {
194f66fc 3867 $fixed[$fixlinenr] =~
3705ce5b
JP
3868 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3869 }
0c73b4eb
AW
3870 }
3871
31070b5d
JP
3872# Function pointer declarations
3873# check spacing between type, funcptr, and args
3874# canonical declaration is "type (*funcptr)(args...)"
91f72e9c 3875 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
31070b5d
JP
3876 my $declare = $1;
3877 my $pre_pointer_space = $2;
3878 my $post_pointer_space = $3;
3879 my $funcname = $4;
3880 my $post_funcname_space = $5;
3881 my $pre_args_space = $6;
3882
91f72e9c
JP
3883# the $Declare variable will capture all spaces after the type
3884# so check it for a missing trailing missing space but pointer return types
3885# don't need a space so don't warn for those.
3886 my $post_declare_space = "";
3887 if ($declare =~ /(\s+)$/) {
3888 $post_declare_space = $1;
3889 $declare = rtrim($declare);
3890 }
3891 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
31070b5d
JP
3892 WARN("SPACING",
3893 "missing space after return type\n" . $herecurr);
91f72e9c 3894 $post_declare_space = " ";
31070b5d
JP
3895 }
3896
3897# unnecessary space "type (*funcptr)(args...)"
91f72e9c
JP
3898# This test is not currently implemented because these declarations are
3899# equivalent to
3900# int foo(int bar, ...)
3901# and this is form shouldn't/doesn't generate a checkpatch warning.
3902#
3903# elsif ($declare =~ /\s{2,}$/) {
3904# WARN("SPACING",
3905# "Multiple spaces after return type\n" . $herecurr);
3906# }
31070b5d
JP
3907
3908# unnecessary space "type ( *funcptr)(args...)"
3909 if (defined $pre_pointer_space &&
3910 $pre_pointer_space =~ /^\s/) {
3911 WARN("SPACING",
3912 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3913 }
3914
3915# unnecessary space "type (* funcptr)(args...)"
3916 if (defined $post_pointer_space &&
3917 $post_pointer_space =~ /^\s/) {
3918 WARN("SPACING",
3919 "Unnecessary space before function pointer name\n" . $herecurr);
3920 }
3921
3922# unnecessary space "type (*funcptr )(args...)"
3923 if (defined $post_funcname_space &&
3924 $post_funcname_space =~ /^\s/) {
3925 WARN("SPACING",
3926 "Unnecessary space after function pointer name\n" . $herecurr);
3927 }
3928
3929# unnecessary space "type (*funcptr) (args...)"
3930 if (defined $pre_args_space &&
3931 $pre_args_space =~ /^\s/) {
3932 WARN("SPACING",
3933 "Unnecessary space before function pointer arguments\n" . $herecurr);
3934 }
3935
3936 if (show_type("SPACING") && $fix) {
194f66fc 3937 $fixed[$fixlinenr] =~
91f72e9c 3938 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
31070b5d
JP
3939 }
3940 }
3941
8d31cfce
AW
3942# check for spacing round square brackets; allowed:
3943# 1. with a type on the left -- int [] a;
fe2a7dbc
AW
3944# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3945# 3. inside a curly brace -- = { [0...10] = 5 }
8d31cfce
AW
3946 while ($line =~ /(.*?\s)\[/g) {
3947 my ($where, $prefix) = ($-[1], $1);
3948 if ($prefix !~ /$Type\s+$/ &&
fe2a7dbc 3949 ($where != 0 || $prefix !~ /^.\s+$/) &&
daebc534 3950 $prefix !~ /[{,]\s+$/) {
3705ce5b
JP
3951 if (ERROR("BRACKET_SPACE",
3952 "space prohibited before open square bracket '['\n" . $herecurr) &&
3953 $fix) {
194f66fc 3954 $fixed[$fixlinenr] =~
3705ce5b
JP
3955 s/^(\+.*?)\s+\[/$1\[/;
3956 }
8d31cfce
AW
3957 }
3958 }
3959
f0a594c1 3960# check for spaces between functions and their parentheses.
6c72ffaa 3961 while ($line =~ /($Ident)\s+\(/g) {
c2fdda0d 3962 my $name = $1;
773647a0
AW
3963 my $ctx_before = substr($line, 0, $-[1]);
3964 my $ctx = "$ctx_before$name";
c2fdda0d
AW
3965
3966 # Ignore those directives where spaces _are_ permitted.
773647a0
AW
3967 if ($name =~ /^(?:
3968 if|for|while|switch|return|case|
3969 volatile|__volatile__|
3970 __attribute__|format|__extension__|
3971 asm|__asm__)$/x)
3972 {
c2fdda0d
AW
3973 # cpp #define statements have non-optional spaces, ie
3974 # if there is a space between the name and the open
3975 # parenthesis it is simply not a parameter group.
c45dcabd 3976 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
773647a0
AW
3977
3978 # cpp #elif statement condition may start with a (
c45dcabd 3979 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
c2fdda0d
AW
3980
3981 # If this whole things ends with a type its most
3982 # likely a typedef for a function.
773647a0 3983 } elsif ($ctx =~ /$Type$/) {
c2fdda0d
AW
3984
3985 } else {
3705ce5b
JP
3986 if (WARN("SPACING",
3987 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3988 $fix) {
194f66fc 3989 $fixed[$fixlinenr] =~
3705ce5b
JP
3990 s/\b$name\s+\(/$name\(/;
3991 }
6c72ffaa 3992 }
f0a594c1 3993 }
9a4cad4e 3994
653d4876 3995# Check operator spacing.
0a920b5b 3996 if (!($line=~/\#\s*include/)) {
3705ce5b
JP
3997 my $fixed_line = "";
3998 my $line_fixed = 0;
3999
9c0ca6f9
AW
4000 my $ops = qr{
4001 <<=|>>=|<=|>=|==|!=|
4002 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4003 =>|->|<<|>>|<|>|=|!|~|
1f65f947 4004 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
84731623 4005 \?:|\?|:
9c0ca6f9 4006 }x;
cf655043 4007 my @elements = split(/($ops|;)/, $opline);
3705ce5b
JP
4008
4009## print("element count: <" . $#elements . ">\n");
4010## foreach my $el (@elements) {
4011## print("el: <$el>\n");
4012## }
4013
4014 my @fix_elements = ();
00df344f 4015 my $off = 0;
6c72ffaa 4016
3705ce5b
JP
4017 foreach my $el (@elements) {
4018 push(@fix_elements, substr($rawline, $off, length($el)));
4019 $off += length($el);
4020 }
4021
4022 $off = 0;
4023
6c72ffaa 4024 my $blank = copy_spacing($opline);
b34c648b 4025 my $last_after = -1;
6c72ffaa 4026
0a920b5b 4027 for (my $n = 0; $n < $#elements; $n += 2) {
3705ce5b
JP
4028
4029 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4030
4031## print("n: <$n> good: <$good>\n");
4032
4a0df2ef
AW
4033 $off += length($elements[$n]);
4034
25985edc 4035 # Pick up the preceding and succeeding characters.
773647a0
AW
4036 my $ca = substr($opline, 0, $off);
4037 my $cc = '';
4038 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4039 $cc = substr($opline, $off + length($elements[$n + 1]));
4040 }
4041 my $cb = "$ca$;$cc";
4042
4a0df2ef
AW
4043 my $a = '';
4044 $a = 'V' if ($elements[$n] ne '');
4045 $a = 'W' if ($elements[$n] =~ /\s$/);
cf655043 4046 $a = 'C' if ($elements[$n] =~ /$;$/);
4a0df2ef
AW
4047 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4048 $a = 'O' if ($elements[$n] eq '');
773647a0 4049 $a = 'E' if ($ca =~ /^\s*$/);
4a0df2ef 4050
0a920b5b 4051 my $op = $elements[$n + 1];
4a0df2ef
AW
4052
4053 my $c = '';
0a920b5b 4054 if (defined $elements[$n + 2]) {
4a0df2ef
AW
4055 $c = 'V' if ($elements[$n + 2] ne '');
4056 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
cf655043 4057 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
4a0df2ef
AW
4058 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4059 $c = 'O' if ($elements[$n + 2] eq '');
8b1b3378 4060 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
4a0df2ef
AW
4061 } else {
4062 $c = 'E';
0a920b5b
AW
4063 }
4064
4a0df2ef
AW
4065 my $ctx = "${a}x${c}";
4066
4067 my $at = "(ctx:$ctx)";
4068
6c72ffaa 4069 my $ptr = substr($blank, 0, $off) . "^";
de7d4f0e 4070 my $hereptr = "$hereline$ptr\n";
0a920b5b 4071
74048ed8 4072 # Pull out the value of this operator.
6c72ffaa 4073 my $op_type = substr($curr_values, $off + 1, 1);
0a920b5b 4074
1f65f947
AW
4075 # Get the full operator variant.
4076 my $opv = $op . substr($curr_vars, $off, 1);
4077
13214adf
AW
4078 # Ignore operators passed as parameters.
4079 if ($op_type ne 'V' &&
d7fe8065 4080 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
13214adf 4081
cf655043
AW
4082# # Ignore comments
4083# } elsif ($op =~ /^$;+$/) {
13214adf 4084
d8aaf121 4085 # ; should have either the end of line or a space or \ after it
13214adf 4086 } elsif ($op eq ';') {
cf655043
AW
4087 if ($ctx !~ /.x[WEBC]/ &&
4088 $cc !~ /^\\/ && $cc !~ /^;/) {
3705ce5b
JP
4089 if (ERROR("SPACING",
4090 "space required after that '$op' $at\n" . $hereptr)) {
b34c648b 4091 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3705ce5b
JP
4092 $line_fixed = 1;
4093 }
d8aaf121
AW
4094 }
4095
4096 # // is a comment
4097 } elsif ($op eq '//') {
0a920b5b 4098
b00e4814
JP
4099 # : when part of a bitfield
4100 } elsif ($opv eq ':B') {
4101 # skip the bitfield test for now
4102
1f65f947
AW
4103 # No spaces for:
4104 # ->
b00e4814 4105 } elsif ($op eq '->') {
4a0df2ef 4106 if ($ctx =~ /Wx.|.xW/) {
3705ce5b
JP
4107 if (ERROR("SPACING",
4108 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
b34c648b 4109 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3705ce5b
JP
4110 if (defined $fix_elements[$n + 2]) {
4111 $fix_elements[$n + 2] =~ s/^\s+//;
4112 }
b34c648b 4113 $line_fixed = 1;
3705ce5b 4114 }
0a920b5b
AW
4115 }
4116
2381097b 4117 # , must not have a space before and must have a space on the right.
0a920b5b 4118 } elsif ($op eq ',') {
2381097b
JP
4119 my $rtrim_before = 0;
4120 my $space_after = 0;
4121 if ($ctx =~ /Wx./) {
4122 if (ERROR("SPACING",
4123 "space prohibited before that '$op' $at\n" . $hereptr)) {
4124 $line_fixed = 1;
4125 $rtrim_before = 1;
4126 }
4127 }
cf655043 4128 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
3705ce5b
JP
4129 if (ERROR("SPACING",
4130 "space required after that '$op' $at\n" . $hereptr)) {
3705ce5b 4131 $line_fixed = 1;
b34c648b 4132 $last_after = $n;
2381097b
JP
4133 $space_after = 1;
4134 }
4135 }
4136 if ($rtrim_before || $space_after) {
4137 if ($rtrim_before) {
4138 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4139 } else {
4140 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4141 }
4142 if ($space_after) {
4143 $good .= " ";
3705ce5b 4144 }
0a920b5b
AW
4145 }
4146
9c0ca6f9 4147 # '*' as part of a type definition -- reported already.
74048ed8 4148 } elsif ($opv eq '*_') {
9c0ca6f9
AW
4149 #warn "'*' is part of type\n";
4150
4151 # unary operators should have a space before and
4152 # none after. May be left adjacent to another
4153 # unary operator, or a cast
4154 } elsif ($op eq '!' || $op eq '~' ||
74048ed8 4155 $opv eq '*U' || $opv eq '-U' ||
0d413866 4156 $opv eq '&U' || $opv eq '&&U') {
cf655043 4157 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
3705ce5b
JP
4158 if (ERROR("SPACING",
4159 "space required before that '$op' $at\n" . $hereptr)) {
b34c648b
JP
4160 if ($n != $last_after + 2) {
4161 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4162 $line_fixed = 1;
4163 }
3705ce5b 4164 }
0a920b5b 4165 }
a3340b35 4166 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
171ae1a4
AW
4167 # A unary '*' may be const
4168
4169 } elsif ($ctx =~ /.xW/) {
3705ce5b
JP
4170 if (ERROR("SPACING",
4171 "space prohibited after that '$op' $at\n" . $hereptr)) {
b34c648b 4172 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
3705ce5b
JP
4173 if (defined $fix_elements[$n + 2]) {
4174 $fix_elements[$n + 2] =~ s/^\s+//;
4175 }
b34c648b 4176 $line_fixed = 1;
3705ce5b 4177 }
0a920b5b
AW
4178 }
4179
4180 # unary ++ and unary -- are allowed no space on one side.
4181 } elsif ($op eq '++' or $op eq '--') {
773647a0 4182 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
3705ce5b
JP
4183 if (ERROR("SPACING",
4184 "space required one side of that '$op' $at\n" . $hereptr)) {
b34c648b 4185 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3705ce5b
JP
4186 $line_fixed = 1;
4187 }
773647a0
AW
4188 }
4189 if ($ctx =~ /Wx[BE]/ ||
4190 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
3705ce5b
JP
4191 if (ERROR("SPACING",
4192 "space prohibited before that '$op' $at\n" . $hereptr)) {
b34c648b 4193 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3705ce5b
JP
4194 $line_fixed = 1;
4195 }
0a920b5b 4196 }
773647a0 4197 if ($ctx =~ /ExW/) {
3705ce5b
JP
4198 if (ERROR("SPACING",
4199 "space prohibited after that '$op' $at\n" . $hereptr)) {
b34c648b 4200 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3705ce5b
JP
4201 if (defined $fix_elements[$n + 2]) {
4202 $fix_elements[$n + 2] =~ s/^\s+//;
4203 }
b34c648b 4204 $line_fixed = 1;
3705ce5b 4205 }
653d4876 4206 }
0a920b5b 4207
0a920b5b 4208 # << and >> may either have or not have spaces both sides
9c0ca6f9
AW
4209 } elsif ($op eq '<<' or $op eq '>>' or
4210 $op eq '&' or $op eq '^' or $op eq '|' or
4211 $op eq '+' or $op eq '-' or
c2fdda0d
AW
4212 $op eq '*' or $op eq '/' or
4213 $op eq '%')
0a920b5b 4214 {
d2e025f3
JP
4215 if ($check) {
4216 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4217 if (CHK("SPACING",
4218 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4219 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4220 $fix_elements[$n + 2] =~ s/^\s+//;
4221 $line_fixed = 1;
4222 }
4223 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4224 if (CHK("SPACING",
4225 "space preferred before that '$op' $at\n" . $hereptr)) {
4226 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4227 $line_fixed = 1;
4228 }
4229 }
4230 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
3705ce5b
JP
4231 if (ERROR("SPACING",
4232 "need consistent spacing around '$op' $at\n" . $hereptr)) {
b34c648b
JP
4233 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4234 if (defined $fix_elements[$n + 2]) {
4235 $fix_elements[$n + 2] =~ s/^\s+//;
4236 }
3705ce5b
JP
4237 $line_fixed = 1;
4238 }
0a920b5b
AW
4239 }
4240
1f65f947
AW
4241 # A colon needs no spaces before when it is
4242 # terminating a case value or a label.
4243 } elsif ($opv eq ':C' || $opv eq ':L') {
4244 if ($ctx =~ /Wx./) {
3705ce5b
JP
4245 if (ERROR("SPACING",
4246 "space prohibited before that '$op' $at\n" . $hereptr)) {
b34c648b 4247 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3705ce5b
JP
4248 $line_fixed = 1;
4249 }
1f65f947
AW
4250 }
4251
0a920b5b 4252 # All the others need spaces both sides.
cf655043 4253 } elsif ($ctx !~ /[EWC]x[CWE]/) {
1f65f947
AW
4254 my $ok = 0;
4255
22f2a2ef 4256 # Ignore email addresses <foo@bar>
1f65f947
AW
4257 if (($op eq '<' &&
4258 $cc =~ /^\S+\@\S+>/) ||
4259 ($op eq '>' &&
4260 $ca =~ /<\S+\@\S+$/))
4261 {
4262 $ok = 1;
4263 }
4264
e0df7e1f
JP
4265 # for asm volatile statements
4266 # ignore a colon with another
4267 # colon immediately before or after
4268 if (($op eq ':') &&
4269 ($ca =~ /:$/ || $cc =~ /^:/)) {
4270 $ok = 1;
4271 }
4272
84731623 4273 # messages are ERROR, but ?: are CHK
1f65f947 4274 if ($ok == 0) {
84731623
JP
4275 my $msg_type = \&ERROR;
4276 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4277
4278 if (&{$msg_type}("SPACING",
4279 "spaces required around that '$op' $at\n" . $hereptr)) {
b34c648b
JP
4280 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4281 if (defined $fix_elements[$n + 2]) {
4282 $fix_elements[$n + 2] =~ s/^\s+//;
4283 }
3705ce5b
JP
4284 $line_fixed = 1;
4285 }
22f2a2ef 4286 }
0a920b5b 4287 }
4a0df2ef 4288 $off += length($elements[$n + 1]);
3705ce5b
JP
4289
4290## print("n: <$n> GOOD: <$good>\n");
4291
4292 $fixed_line = $fixed_line . $good;
4293 }
4294
4295 if (($#elements % 2) == 0) {
4296 $fixed_line = $fixed_line . $fix_elements[$#elements];
0a920b5b 4297 }
3705ce5b 4298
194f66fc
JP
4299 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4300 $fixed[$fixlinenr] = $fixed_line;
3705ce5b
JP
4301 }
4302
4303
0a920b5b
AW
4304 }
4305
786b6326 4306# check for whitespace before a non-naked semicolon
d2e248e7 4307 if ($line =~ /^\+.*\S\s+;\s*$/) {
786b6326
JP
4308 if (WARN("SPACING",
4309 "space prohibited before semicolon\n" . $herecurr) &&
4310 $fix) {
194f66fc 4311 1 while $fixed[$fixlinenr] =~
786b6326
JP
4312 s/^(\+.*\S)\s+;/$1;/;
4313 }
4314 }
4315
f0a594c1
AW
4316# check for multiple assignments
4317 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
000d1cc1
JP
4318 CHK("MULTIPLE_ASSIGNMENTS",
4319 "multiple assignments should be avoided\n" . $herecurr);
f0a594c1
AW
4320 }
4321
22f2a2ef
AW
4322## # check for multiple declarations, allowing for a function declaration
4323## # continuation.
4324## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4325## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4326##
4327## # Remove any bracketed sections to ensure we do not
4328## # falsly report the parameters of functions.
4329## my $ln = $line;
4330## while ($ln =~ s/\([^\(\)]*\)//g) {
4331## }
4332## if ($ln =~ /,/) {
000d1cc1
JP
4333## WARN("MULTIPLE_DECLARATION",
4334## "declaring multiple variables together should be avoided\n" . $herecurr);
22f2a2ef
AW
4335## }
4336## }
f0a594c1 4337
0a920b5b 4338#need space before brace following if, while, etc
6b8c69e4 4339 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
4e5d56bd 4340 $line =~ /do\{/) {
3705ce5b
JP
4341 if (ERROR("SPACING",
4342 "space required before the open brace '{'\n" . $herecurr) &&
4343 $fix) {
194f66fc 4344 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
3705ce5b 4345 }
de7d4f0e
AW
4346 }
4347
c4a62ef9
JP
4348## # check for blank lines before declarations
4349## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4350## $prevrawline =~ /^.\s*$/) {
4351## WARN("SPACING",
4352## "No blank lines before declarations\n" . $hereprev);
4353## }
4354##
4355
de7d4f0e
AW
4356# closing brace should have a space following it when it has anything
4357# on the line
4358 if ($line =~ /}(?!(?:,|;|\)))\S/) {
d5e616fc
JP
4359 if (ERROR("SPACING",
4360 "space required after that close brace '}'\n" . $herecurr) &&
4361 $fix) {
194f66fc 4362 $fixed[$fixlinenr] =~
d5e616fc
JP
4363 s/}((?!(?:,|;|\)))\S)/} $1/;
4364 }
0a920b5b
AW
4365 }
4366
22f2a2ef
AW
4367# check spacing on square brackets
4368 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
3705ce5b
JP
4369 if (ERROR("SPACING",
4370 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4371 $fix) {
194f66fc 4372 $fixed[$fixlinenr] =~
3705ce5b
JP
4373 s/\[\s+/\[/;
4374 }
22f2a2ef
AW
4375 }
4376 if ($line =~ /\s\]/) {
3705ce5b
JP
4377 if (ERROR("SPACING",
4378 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4379 $fix) {
194f66fc 4380 $fixed[$fixlinenr] =~
3705ce5b
JP
4381 s/\s+\]/\]/;
4382 }
22f2a2ef
AW
4383 }
4384
c45dcabd 4385# check spacing on parentheses
9c0ca6f9
AW
4386 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4387 $line !~ /for\s*\(\s+;/) {
3705ce5b
JP
4388 if (ERROR("SPACING",
4389 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4390 $fix) {
194f66fc 4391 $fixed[$fixlinenr] =~
3705ce5b
JP
4392 s/\(\s+/\(/;
4393 }
22f2a2ef 4394 }
13214adf 4395 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
c45dcabd
AW
4396 $line !~ /for\s*\(.*;\s+\)/ &&
4397 $line !~ /:\s+\)/) {
3705ce5b
JP
4398 if (ERROR("SPACING",
4399 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4400 $fix) {
194f66fc 4401 $fixed[$fixlinenr] =~
3705ce5b
JP
4402 s/\s+\)/\)/;
4403 }
22f2a2ef
AW
4404 }
4405
e2826fd0
JP
4406# check unnecessary parentheses around addressof/dereference single $Lvals
4407# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4408
4409 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
ea4acbb1
JP
4410 my $var = $1;
4411 if (CHK("UNNECESSARY_PARENTHESES",
4412 "Unnecessary parentheses around $var\n" . $herecurr) &&
4413 $fix) {
4414 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4415 }
4416 }
4417
4418# check for unnecessary parentheses around function pointer uses
4419# ie: (foo->bar)(); should be foo->bar();
4420# but not "if (foo->bar) (" to avoid some false positives
4421 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4422 my $var = $2;
4423 if (CHK("UNNECESSARY_PARENTHESES",
4424 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4425 $fix) {
4426 my $var2 = deparenthesize($var);
4427 $var2 =~ s/\s//g;
4428 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4429 }
4430 }
e2826fd0 4431
0a920b5b 4432#goto labels aren't indented, allow a single space however
4a0df2ef 4433 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
0a920b5b 4434 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
3705ce5b
JP
4435 if (WARN("INDENTED_LABEL",
4436 "labels should not be indented\n" . $herecurr) &&
4437 $fix) {
194f66fc 4438 $fixed[$fixlinenr] =~
3705ce5b
JP
4439 s/^(.)\s+/$1/;
4440 }
0a920b5b
AW
4441 }
4442
5b9553ab 4443# return is not a function
507e5141 4444 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
c45dcabd 4445 my $spacing = $1;
507e5141 4446 if ($^V && $^V ge 5.10.0 &&
5b9553ab
JP
4447 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4448 my $value = $1;
4449 $value = deparenthesize($value);
4450 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4451 ERROR("RETURN_PARENTHESES",
4452 "return is not a function, parentheses are not required\n" . $herecurr);
4453 }
c45dcabd 4454 } elsif ($spacing !~ /\s+/) {
000d1cc1
JP
4455 ERROR("SPACING",
4456 "space required before the open parenthesis '('\n" . $herecurr);
c45dcabd
AW
4457 }
4458 }
507e5141 4459
b43ae21b
JP
4460# unnecessary return in a void function
4461# at end-of-function, with the previous line a single leading tab, then return;
4462# and the line before that not a goto label target like "out:"
4463 if ($sline =~ /^[ \+]}\s*$/ &&
4464 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4465 $linenr >= 3 &&
4466 $lines[$linenr - 3] =~ /^[ +]/ &&
4467 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
9819cf25 4468 WARN("RETURN_VOID",
b43ae21b
JP
4469 "void function return statements are not generally useful\n" . $hereprev);
4470 }
9819cf25 4471
189248d8
JP
4472# if statements using unnecessary parentheses - ie: if ((foo == bar))
4473 if ($^V && $^V ge 5.10.0 &&
4474 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4475 my $openparens = $1;
4476 my $count = $openparens =~ tr@\(@\(@;
4477 my $msg = "";
4478 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4479 my $comp = $4; #Not $1 because of $LvalOrFunc
4480 $msg = " - maybe == should be = ?" if ($comp eq "==");
4481 WARN("UNNECESSARY_PARENTHESES",
4482 "Unnecessary parentheses$msg\n" . $herecurr);
4483 }
4484 }
4485
c5595fa2
JP
4486# comparisons with a constant or upper case identifier on the left
4487# avoid cases like "foo + BAR < baz"
4488# only fix matches surrounded by parentheses to avoid incorrect
4489# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4490 if ($^V && $^V ge 5.10.0 &&
4491 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4492 my $lead = $1;
4493 my $const = $2;
4494 my $comp = $3;
4495 my $to = $4;
4496 my $newcomp = $comp;
f39e1769 4497 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
c5595fa2
JP
4498 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4499 WARN("CONSTANT_COMPARISON",
4500 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4501 $fix) {
4502 if ($comp eq "<") {
4503 $newcomp = ">";
4504 } elsif ($comp eq "<=") {
4505 $newcomp = ">=";
4506 } elsif ($comp eq ">") {
4507 $newcomp = "<";
4508 } elsif ($comp eq ">=") {
4509 $newcomp = "<=";
4510 }
4511 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4512 }
4513 }
4514
f34e4a4f
JP
4515# Return of what appears to be an errno should normally be negative
4516 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
53a3c448
AW
4517 my $name = $1;
4518 if ($name ne 'EOF' && $name ne 'ERROR') {
000d1cc1 4519 WARN("USE_NEGATIVE_ERRNO",
f34e4a4f 4520 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
53a3c448
AW
4521 }
4522 }
c45dcabd 4523
0a920b5b 4524# Need a space before open parenthesis after if, while etc
3705ce5b
JP
4525 if ($line =~ /\b(if|while|for|switch)\(/) {
4526 if (ERROR("SPACING",
4527 "space required before the open parenthesis '('\n" . $herecurr) &&
4528 $fix) {
194f66fc 4529 $fixed[$fixlinenr] =~
3705ce5b
JP
4530 s/\b(if|while|for|switch)\(/$1 \(/;
4531 }
0a920b5b
AW
4532 }
4533
f5fe35dd
AW
4534# Check for illegal assignment in if conditional -- and check for trailing
4535# statements after the conditional.
170d3a22 4536 if ($line =~ /do\s*(?!{)/) {
3e469cdc
AW
4537 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4538 ctx_statement_block($linenr, $realcnt, 0)
4539 if (!defined $stat);
170d3a22
AW
4540 my ($stat_next) = ctx_statement_block($line_nr_next,
4541 $remain_next, $off_next);
4542 $stat_next =~ s/\n./\n /g;
4543 ##print "stat<$stat> stat_next<$stat_next>\n";
4544
4545 if ($stat_next =~ /^\s*while\b/) {
4546 # If the statement carries leading newlines,
4547 # then count those as offsets.
4548 my ($whitespace) =
4549 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4550 my $offset =
4551 statement_rawlines($whitespace) - 1;
4552
4553 $suppress_whiletrailers{$line_nr_next +
4554 $offset} = 1;
4555 }
4556 }
4557 if (!defined $suppress_whiletrailers{$linenr} &&
c11230f4 4558 defined($stat) && defined($cond) &&
170d3a22 4559 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
171ae1a4 4560 my ($s, $c) = ($stat, $cond);
8905a67c 4561
b53c8e10 4562 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
000d1cc1
JP
4563 ERROR("ASSIGN_IN_IF",
4564 "do not use assignment in if condition\n" . $herecurr);
8905a67c
AW
4565 }
4566
4567 # Find out what is on the end of the line after the
4568 # conditional.
773647a0 4569 substr($s, 0, length($c), '');
8905a67c 4570 $s =~ s/\n.*//g;
13214adf 4571 $s =~ s/$;//g; # Remove any comments
53210168
AW
4572 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4573 $c !~ /}\s*while\s*/)
773647a0 4574 {
bb44ad39
AW
4575 # Find out how long the conditional actually is.
4576 my @newlines = ($c =~ /\n/gs);
4577 my $cond_lines = 1 + $#newlines;
42bdf74c 4578 my $stat_real = '';
bb44ad39 4579
42bdf74c
HS
4580 $stat_real = raw_line($linenr, $cond_lines)
4581 . "\n" if ($cond_lines);
bb44ad39
AW
4582 if (defined($stat_real) && $cond_lines > 1) {
4583 $stat_real = "[...]\n$stat_real";
4584 }
4585
000d1cc1
JP
4586 ERROR("TRAILING_STATEMENTS",
4587 "trailing statements should be on next line\n" . $herecurr . $stat_real);
8905a67c
AW
4588 }
4589 }
4590
13214adf
AW
4591# Check for bitwise tests written as boolean
4592 if ($line =~ /
4593 (?:
4594 (?:\[|\(|\&\&|\|\|)
4595 \s*0[xX][0-9]+\s*
4596 (?:\&\&|\|\|)
4597 |
4598 (?:\&\&|\|\|)
4599 \s*0[xX][0-9]+\s*
4600 (?:\&\&|\|\||\)|\])
4601 )/x)
4602 {
000d1cc1
JP
4603 WARN("HEXADECIMAL_BOOLEAN_TEST",
4604 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
13214adf
AW
4605 }
4606
8905a67c 4607# if and else should not have general statements after it
13214adf
AW
4608 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4609 my $s = $1;
4610 $s =~ s/$;//g; # Remove any comments
4611 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
000d1cc1
JP
4612 ERROR("TRAILING_STATEMENTS",
4613 "trailing statements should be on next line\n" . $herecurr);
13214adf 4614 }
0a920b5b 4615 }
39667782
AW
4616# if should not continue a brace
4617 if ($line =~ /}\s*if\b/) {
000d1cc1 4618 ERROR("TRAILING_STATEMENTS",
048b123f 4619 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
39667782
AW
4620 $herecurr);
4621 }
a1080bf8
AW
4622# case and default should not have general statements after them
4623 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4624 $line !~ /\G(?:
3fef12d6 4625 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
a1080bf8
AW
4626 \s*return\s+
4627 )/xg)
4628 {
000d1cc1
JP
4629 ERROR("TRAILING_STATEMENTS",
4630 "trailing statements should be on next line\n" . $herecurr);
a1080bf8 4631 }
0a920b5b
AW
4632
4633 # Check for }<nl>else {, these must be at the same
4634 # indent level to be relevant to each other.
8b8856f4
JP
4635 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4636 $previndent == $indent) {
4637 if (ERROR("ELSE_AFTER_BRACE",
4638 "else should follow close brace '}'\n" . $hereprev) &&
4639 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4640 fix_delete_line($fixlinenr - 1, $prevrawline);
4641 fix_delete_line($fixlinenr, $rawline);
4642 my $fixedline = $prevrawline;
4643 $fixedline =~ s/}\s*$//;
4644 if ($fixedline !~ /^\+\s*$/) {
4645 fix_insert_line($fixlinenr, $fixedline);
4646 }
4647 $fixedline = $rawline;
4648 $fixedline =~ s/^(.\s*)else/$1} else/;
4649 fix_insert_line($fixlinenr, $fixedline);
4650 }
0a920b5b
AW
4651 }
4652
8b8856f4
JP
4653 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4654 $previndent == $indent) {
c2fdda0d
AW
4655 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4656
4657 # Find out what is on the end of the line after the
4658 # conditional.
773647a0 4659 substr($s, 0, length($c), '');
c2fdda0d
AW
4660 $s =~ s/\n.*//g;
4661
4662 if ($s =~ /^\s*;/) {
8b8856f4
JP
4663 if (ERROR("WHILE_AFTER_BRACE",
4664 "while should follow close brace '}'\n" . $hereprev) &&
4665 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4666 fix_delete_line($fixlinenr - 1, $prevrawline);
4667 fix_delete_line($fixlinenr, $rawline);
4668 my $fixedline = $prevrawline;
4669 my $trailing = $rawline;
4670 $trailing =~ s/^\+//;
4671 $trailing = trim($trailing);
4672 $fixedline =~ s/}\s*$/} $trailing/;
4673 fix_insert_line($fixlinenr, $fixedline);
4674 }
c2fdda0d
AW
4675 }
4676 }
4677
95e2c602 4678#Specific variable tests
323c1260
JP
4679 while ($line =~ m{($Constant|$Lval)}g) {
4680 my $var = $1;
95e2c602
JP
4681
4682#gcc binary extension
4683 if ($var =~ /^$Binary$/) {
d5e616fc
JP
4684 if (WARN("GCC_BINARY_CONSTANT",
4685 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4686 $fix) {
4687 my $hexval = sprintf("0x%x", oct($var));
194f66fc 4688 $fixed[$fixlinenr] =~
d5e616fc
JP
4689 s/\b$var\b/$hexval/;
4690 }
95e2c602
JP
4691 }
4692
4693#CamelCase
807bd26c 4694 if ($var !~ /^$Constant$/ &&
be79794b 4695 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
22735ce8 4696#Ignore Page<foo> variants
807bd26c 4697 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
22735ce8 4698#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
f5123576
JW
4699 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4700#Ignore some three character SI units explicitly, like MiB and KHz
4701 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
7e781f67
JP
4702 while ($var =~ m{($Ident)}g) {
4703 my $word = $1;
4704 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
d8b07710
JP
4705 if ($check) {
4706 seed_camelcase_includes();
4707 if (!$file && !$camelcase_file_seeded) {
4708 seed_camelcase_file($realfile);
4709 $camelcase_file_seeded = 1;
4710 }
4711 }
7e781f67
JP
4712 if (!defined $camelcase{$word}) {
4713 $camelcase{$word} = 1;
4714 CHK("CAMELCASE",
4715 "Avoid CamelCase: <$word>\n" . $herecurr);
4716 }
3445686a 4717 }
323c1260
JP
4718 }
4719 }
0a920b5b
AW
4720
4721#no spaces allowed after \ in define
d5e616fc
JP
4722 if ($line =~ /\#\s*define.*\\\s+$/) {
4723 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4724 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4725 $fix) {
194f66fc 4726 $fixed[$fixlinenr] =~ s/\s+$//;
d5e616fc 4727 }
0a920b5b
AW
4728 }
4729
0e212e0a
FF
4730# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4731# itself <asm/foo.h> (uses RAW line)
c45dcabd 4732 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
e09dec48
AW
4733 my $file = "$1.h";
4734 my $checkfile = "include/linux/$file";
4735 if (-f "$root/$checkfile" &&
4736 $realfile ne $checkfile &&
7840a94c 4737 $1 !~ /$allowed_asm_includes/)
c45dcabd 4738 {
0e212e0a
FF
4739 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4740 if ($asminclude > 0) {
4741 if ($realfile =~ m{^arch/}) {
4742 CHK("ARCH_INCLUDE_LINUX",
4743 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4744 } else {
4745 WARN("INCLUDE_LINUX",
4746 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4747 }
e09dec48 4748 }
0a920b5b
AW
4749 }
4750 }
4751
653d4876
AW
4752# multi-statement macros should be enclosed in a do while loop, grab the
4753# first statement and ensure its the whole macro if its not enclosed
cf655043 4754# in a known good container
b8f96a31
AW
4755 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4756 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
d8aaf121
AW
4757 my $ln = $linenr;
4758 my $cnt = $realcnt;
c45dcabd
AW
4759 my ($off, $dstat, $dcond, $rest);
4760 my $ctx = '';
08a2843e
JP
4761 my $has_flow_statement = 0;
4762 my $has_arg_concat = 0;
c45dcabd 4763 ($dstat, $dcond, $ln, $cnt, $off) =
f74bd194
AW
4764 ctx_statement_block($linenr, $realcnt, 0);
4765 $ctx = $dstat;
c45dcabd 4766 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
a3bb97a7 4767 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
c45dcabd 4768
08a2843e 4769 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
62e15a6d 4770 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
08a2843e 4771
f59b64bf
JP
4772 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
4773 my $define_args = $1;
4774 my $define_stmt = $dstat;
4775 my @def_args = ();
4776
4777 if (defined $define_args && $define_args ne "") {
4778 $define_args = substr($define_args, 1, length($define_args) - 2);
4779 $define_args =~ s/\s*//g;
4780 @def_args = split(",", $define_args);
4781 }
4782
292f1a9b 4783 $dstat =~ s/$;//g;
c45dcabd
AW
4784 $dstat =~ s/\\\n.//g;
4785 $dstat =~ s/^\s*//s;
4786 $dstat =~ s/\s*$//s;
de7d4f0e 4787
c45dcabd 4788 # Flatten any parentheses and braces
bf30d6ed
AW
4789 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4790 $dstat =~ s/\{[^\{\}]*\}/1/ ||
6b10df42 4791 $dstat =~ s/.\[[^\[\]]*\]/1/)
bf30d6ed 4792 {
de7d4f0e 4793 }
d8aaf121 4794
e45bab8e 4795 # Flatten any obvious string concatentation.
33acb54a
JP
4796 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4797 $dstat =~ s/$Ident\s*($String)/$1/)
e45bab8e
AW
4798 {
4799 }
4800
42e15293
JP
4801 # Make asm volatile uses seem like a generic function
4802 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4803
c45dcabd
AW
4804 my $exceptions = qr{
4805 $Declare|
4806 module_param_named|
a0a0a7a9 4807 MODULE_PARM_DESC|
c45dcabd
AW
4808 DECLARE_PER_CPU|
4809 DEFINE_PER_CPU|
383099fd 4810 __typeof__\(|
22fd2d3e
SS
4811 union|
4812 struct|
ea71a0a0 4813 \.$Ident\s*=\s*|
6b10df42
VZ
4814 ^\"|\"$|
4815 ^\[
c45dcabd 4816 }x;
5eaa20b9 4817 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
f59b64bf
JP
4818
4819 $ctx =~ s/\n*$//;
4820 my $herectx = $here . "\n";
4821 my $stmt_cnt = statement_rawlines($ctx);
4822
4823 for (my $n = 0; $n < $stmt_cnt; $n++) {
4824 $herectx .= raw_line($linenr, $n) . "\n";
4825 }
4826
f74bd194
AW
4827 if ($dstat ne '' &&
4828 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4829 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
3cc4b1c3 4830 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
356fd398 4831 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
f74bd194
AW
4832 $dstat !~ /$exceptions/ &&
4833 $dstat !~ /^\.$Ident\s*=/ && # .foo =
e942e2c3 4834 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
72f115f9 4835 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
f74bd194
AW
4836 $dstat !~ /^for\s*$Constant$/ && # for (...)
4837 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4838 $dstat !~ /^do\s*{/ && # do {...
4e5d56bd 4839 $dstat !~ /^\(\{/ && # ({...
f95a7e6a 4840 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
f74bd194 4841 {
c45dcabd 4842
f74bd194
AW
4843 if ($dstat =~ /;/) {
4844 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4845 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4846 } else {
000d1cc1 4847 ERROR("COMPLEX_MACRO",
388982b5 4848 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
d8aaf121 4849 }
f59b64bf
JP
4850
4851 }
5207649b
JP
4852
4853 # Make $define_stmt single line, comment-free, etc
4854 my @stmt_array = split('\n', $define_stmt);
4855 my $first = 1;
4856 $define_stmt = "";
4857 foreach my $l (@stmt_array) {
4858 $l =~ s/\\$//;
4859 if ($first) {
4860 $define_stmt = $l;
4861 $first = 0;
4862 } elsif ($l =~ /^[\+ ]/) {
4863 $define_stmt .= substr($l, 1);
4864 }
4865 }
4866 $define_stmt =~ s/$;//g;
4867 $define_stmt =~ s/\s+/ /g;
4868 $define_stmt = trim($define_stmt);
4869
f59b64bf
JP
4870# check if any macro arguments are reused (ignore '...' and 'type')
4871 foreach my $arg (@def_args) {
4872 next if ($arg =~ /\.\.\./);
9192d41a 4873 next if ($arg =~ /^type$/i);
f59b64bf
JP
4874 my $tmp = $define_stmt;
4875 $tmp =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5207649b 4876 $tmp =~ s/\#+\s*$arg\b//g;
f59b64bf
JP
4877 $tmp =~ s/\b$arg\s*\#\#//g;
4878 my $use_cnt = $tmp =~ s/\b$arg\b//g;
4879 if ($use_cnt > 1) {
4880 CHK("MACRO_ARG_REUSE",
4881 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
9192d41a
JP
4882 }
4883# check if any macro arguments may have other precedence issues
4884 if ($define_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
4885 ((defined($1) && $1 ne ',') ||
4886 (defined($2) && $2 ne ','))) {
4887 CHK("MACRO_ARG_PRECEDENCE",
4888 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
f59b64bf 4889 }
653d4876 4890 }
5023d347 4891
08a2843e
JP
4892# check for macros with flow control, but without ## concatenation
4893# ## concatenation is commonly a macro that defines a function so ignore those
4894 if ($has_flow_statement && !$has_arg_concat) {
4895 my $herectx = $here . "\n";
4896 my $cnt = statement_rawlines($ctx);
4897
4898 for (my $n = 0; $n < $cnt; $n++) {
4899 $herectx .= raw_line($linenr, $n) . "\n";
4900 }
4901 WARN("MACRO_WITH_FLOW_CONTROL",
4902 "Macros with flow control statements should be avoided\n" . "$herectx");
4903 }
4904
481eb486 4905# check for line continuations outside of #defines, preprocessor #, and asm
5023d347
JP
4906
4907 } else {
4908 if ($prevline !~ /^..*\\$/ &&
481eb486
JP
4909 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4910 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
5023d347
JP
4911 $line =~ /^\+.*\\$/) {
4912 WARN("LINE_CONTINUATIONS",
4913 "Avoid unnecessary line continuations\n" . $herecurr);
4914 }
0a920b5b
AW
4915 }
4916
b13edf7f
JP
4917# do {} while (0) macro tests:
4918# single-statement macros do not need to be enclosed in do while (0) loop,
4919# macro should not end with a semicolon
4920 if ($^V && $^V ge 5.10.0 &&
4921 $realfile !~ m@/vmlinux.lds.h$@ &&
4922 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4923 my $ln = $linenr;
4924 my $cnt = $realcnt;
4925 my ($off, $dstat, $dcond, $rest);
4926 my $ctx = '';
4927 ($dstat, $dcond, $ln, $cnt, $off) =
4928 ctx_statement_block($linenr, $realcnt, 0);
4929 $ctx = $dstat;
4930
4931 $dstat =~ s/\\\n.//g;
1b36b201 4932 $dstat =~ s/$;/ /g;
b13edf7f
JP
4933
4934 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4935 my $stmts = $2;
4936 my $semis = $3;
4937
4938 $ctx =~ s/\n*$//;
4939 my $cnt = statement_rawlines($ctx);
4940 my $herectx = $here . "\n";
4941
4942 for (my $n = 0; $n < $cnt; $n++) {
4943 $herectx .= raw_line($linenr, $n) . "\n";
4944 }
4945
ac8e97f8
JP
4946 if (($stmts =~ tr/;/;/) == 1 &&
4947 $stmts !~ /^\s*(if|while|for|switch)\b/) {
b13edf7f
JP
4948 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4949 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4950 }
4951 if (defined $semis && $semis ne "") {
4952 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4953 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4954 }
f5ef95b1
JP
4955 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4956 $ctx =~ s/\n*$//;
4957 my $cnt = statement_rawlines($ctx);
4958 my $herectx = $here . "\n";
4959
4960 for (my $n = 0; $n < $cnt; $n++) {
4961 $herectx .= raw_line($linenr, $n) . "\n";
4962 }
4963
4964 WARN("TRAILING_SEMICOLON",
4965 "macros should not use a trailing semicolon\n" . "$herectx");
b13edf7f
JP
4966 }
4967 }
4968
080ba929
MF
4969# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4970# all assignments may have only one of the following with an assignment:
4971# .
4972# ALIGN(...)
4973# VMLINUX_SYMBOL(...)
4974 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
000d1cc1
JP
4975 WARN("MISSING_VMLINUX_SYMBOL",
4976 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
080ba929
MF
4977 }
4978
f0a594c1 4979# check for redundant bracing round if etc
13214adf
AW
4980 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4981 my ($level, $endln, @chunks) =
cf655043 4982 ctx_statement_full($linenr, $realcnt, 1);
13214adf 4983 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
cf655043
AW
4984 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4985 if ($#chunks > 0 && $level == 0) {
aad4f614
JP
4986 my @allowed = ();
4987 my $allow = 0;
13214adf 4988 my $seen = 0;
773647a0 4989 my $herectx = $here . "\n";
cf655043 4990 my $ln = $linenr - 1;
13214adf
AW
4991 for my $chunk (@chunks) {
4992 my ($cond, $block) = @{$chunk};
4993
773647a0
AW
4994 # If the condition carries leading newlines, then count those as offsets.
4995 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4996 my $offset = statement_rawlines($whitespace) - 1;
4997
aad4f614 4998 $allowed[$allow] = 0;
773647a0
AW
4999 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5000
5001 # We have looked at and allowed this specific line.
5002 $suppress_ifbraces{$ln + $offset} = 1;
5003
5004 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
cf655043
AW
5005 $ln += statement_rawlines($block) - 1;
5006
773647a0 5007 substr($block, 0, length($cond), '');
13214adf
AW
5008
5009 $seen++ if ($block =~ /^\s*{/);
5010
aad4f614 5011 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
cf655043
AW
5012 if (statement_lines($cond) > 1) {
5013 #print "APW: ALLOWED: cond<$cond>\n";
aad4f614 5014 $allowed[$allow] = 1;
13214adf
AW
5015 }
5016 if ($block =~/\b(?:if|for|while)\b/) {
cf655043 5017 #print "APW: ALLOWED: block<$block>\n";
aad4f614 5018 $allowed[$allow] = 1;
13214adf 5019 }
cf655043
AW
5020 if (statement_block_size($block) > 1) {
5021 #print "APW: ALLOWED: lines block<$block>\n";
aad4f614 5022 $allowed[$allow] = 1;
13214adf 5023 }
aad4f614 5024 $allow++;
13214adf 5025 }
aad4f614
JP
5026 if ($seen) {
5027 my $sum_allowed = 0;
5028 foreach (@allowed) {
5029 $sum_allowed += $_;
5030 }
5031 if ($sum_allowed == 0) {
5032 WARN("BRACES",
5033 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5034 } elsif ($sum_allowed != $allow &&
5035 $seen != $allow) {
5036 CHK("BRACES",
5037 "braces {} should be used on all arms of this statement\n" . $herectx);
5038 }
13214adf
AW
5039 }
5040 }
5041 }
773647a0 5042 if (!defined $suppress_ifbraces{$linenr - 1} &&
13214adf 5043 $line =~ /\b(if|while|for|else)\b/) {
cf655043
AW
5044 my $allowed = 0;
5045
5046 # Check the pre-context.
5047 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5048 #print "APW: ALLOWED: pre<$1>\n";
5049 $allowed = 1;
5050 }
773647a0
AW
5051
5052 my ($level, $endln, @chunks) =
5053 ctx_statement_full($linenr, $realcnt, $-[0]);
5054
cf655043
AW
5055 # Check the condition.
5056 my ($cond, $block) = @{$chunks[0]};
773647a0 5057 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
cf655043 5058 if (defined $cond) {
773647a0 5059 substr($block, 0, length($cond), '');
cf655043
AW
5060 }
5061 if (statement_lines($cond) > 1) {
5062 #print "APW: ALLOWED: cond<$cond>\n";
5063 $allowed = 1;
5064 }
5065 if ($block =~/\b(?:if|for|while)\b/) {
5066 #print "APW: ALLOWED: block<$block>\n";
5067 $allowed = 1;
5068 }
5069 if (statement_block_size($block) > 1) {
5070 #print "APW: ALLOWED: lines block<$block>\n";
5071 $allowed = 1;
5072 }
5073 # Check the post-context.
5074 if (defined $chunks[1]) {
5075 my ($cond, $block) = @{$chunks[1]};
5076 if (defined $cond) {
773647a0 5077 substr($block, 0, length($cond), '');
cf655043
AW
5078 }
5079 if ($block =~ /^\s*\{/) {
5080 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5081 $allowed = 1;
5082 }
5083 }
5084 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
69932487 5085 my $herectx = $here . "\n";
f055663c 5086 my $cnt = statement_rawlines($block);
cf655043 5087
f055663c 5088 for (my $n = 0; $n < $cnt; $n++) {
69932487 5089 $herectx .= raw_line($linenr, $n) . "\n";
f0a594c1 5090 }
cf655043 5091
000d1cc1
JP
5092 WARN("BRACES",
5093 "braces {} are not necessary for single statement blocks\n" . $herectx);
f0a594c1
AW
5094 }
5095 }
5096
0979ae66 5097# check for unnecessary blank lines around braces
77b9a53a 5098 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
f8e58219
JP
5099 if (CHK("BRACES",
5100 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5101 $fix && $prevrawline =~ /^\+/) {
5102 fix_delete_line($fixlinenr - 1, $prevrawline);
5103 }
0979ae66 5104 }
77b9a53a 5105 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
f8e58219
JP
5106 if (CHK("BRACES",
5107 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5108 $fix) {
5109 fix_delete_line($fixlinenr, $rawline);
5110 }
0979ae66
JP
5111 }
5112
4a0df2ef 5113# no volatiles please
6c72ffaa
AW
5114 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5115 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
000d1cc1
JP
5116 WARN("VOLATILE",
5117 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4a0df2ef
AW
5118 }
5119
5e4f6ba5
JP
5120# Check for user-visible strings broken across lines, which breaks the ability
5121# to grep for the string. Make exceptions when the previous string ends in a
5122# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5123# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
33acb54a 5124 if ($line =~ /^\+\s*$String/ &&
5e4f6ba5
JP
5125 $prevline =~ /"\s*$/ &&
5126 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5127 if (WARN("SPLIT_STRING",
5128 "quoted string split across lines\n" . $hereprev) &&
5129 $fix &&
5130 $prevrawline =~ /^\+.*"\s*$/ &&
5131 $last_coalesced_string_linenr != $linenr - 1) {
5132 my $extracted_string = get_quoted_string($line, $rawline);
5133 my $comma_close = "";
5134 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5135 $comma_close = $1;
5136 }
5137
5138 fix_delete_line($fixlinenr - 1, $prevrawline);
5139 fix_delete_line($fixlinenr, $rawline);
5140 my $fixedline = $prevrawline;
5141 $fixedline =~ s/"\s*$//;
5142 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5143 fix_insert_line($fixlinenr - 1, $fixedline);
5144 $fixedline = $rawline;
5145 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5146 if ($fixedline !~ /\+\s*$/) {
5147 fix_insert_line($fixlinenr, $fixedline);
5148 }
5149 $last_coalesced_string_linenr = $linenr;
5150 }
5151 }
5152
5153# check for missing a space in a string concatenation
5154 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5155 WARN('MISSING_SPACE',
5156 "break quoted strings at a space character\n" . $hereprev);
5157 }
5158
5159# check for spaces before a quoted newline
5160 if ($rawline =~ /^.*\".*\s\\n/) {
5161 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5162 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5163 $fix) {
5164 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5165 }
5166
5167 }
5168
f17dba4f 5169# concatenated string without spaces between elements
33acb54a 5170 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
f17dba4f
JP
5171 CHK("CONCATENATED_STRING",
5172 "Concatenated strings should use spaces between elements\n" . $herecurr);
5173 }
5174
90ad30e5 5175# uncoalesced string fragments
33acb54a 5176 if ($line =~ /$String\s*"/) {
90ad30e5
JP
5177 WARN("STRING_FRAGMENTS",
5178 "Consecutive strings are generally better as a single string\n" . $herecurr);
5179 }
5180
6e300757 5181# check for %L{u,d,i} and 0x%[udi] in strings
5e4f6ba5
JP
5182 my $string;
5183 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5184 $string = substr($rawline, $-[1], $+[1] - $-[1]);
5185 $string =~ s/%%/__/g;
6e300757 5186 if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) {
5e4f6ba5
JP
5187 WARN("PRINTF_L",
5188 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
5189 last;
5190 }
6e300757
JP
5191 if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) {
5192 ERROR("PRINTF_0xDECIMAL",
5193 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5194 }
5e4f6ba5
JP
5195 }
5196
5197# check for line continuations in quoted strings with odd counts of "
5198 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
5199 WARN("LINE_CONTINUATIONS",
5200 "Avoid line continuations in quoted strings\n" . $herecurr);
5201 }
5202
00df344f 5203# warn about #if 0
c45dcabd 5204 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
000d1cc1
JP
5205 CHK("REDUNDANT_CODE",
5206 "if this code is redundant consider removing it\n" .
de7d4f0e 5207 $herecurr);
4a0df2ef
AW
5208 }
5209
03df4b51
AW
5210# check for needless "if (<foo>) fn(<foo>)" uses
5211 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
100425de
JP
5212 my $tested = quotemeta($1);
5213 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5214 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5215 my $func = $1;
5216 if (WARN('NEEDLESS_IF',
5217 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5218 $fix) {
5219 my $do_fix = 1;
5220 my $leading_tabs = "";
5221 my $new_leading_tabs = "";
5222 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5223 $leading_tabs = $1;
5224 } else {
5225 $do_fix = 0;
5226 }
5227 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5228 $new_leading_tabs = $1;
5229 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5230 $do_fix = 0;
5231 }
5232 } else {
5233 $do_fix = 0;
5234 }
5235 if ($do_fix) {
5236 fix_delete_line($fixlinenr - 1, $prevrawline);
5237 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5238 }
5239 }
4c432a8f
GKH
5240 }
5241 }
f0a594c1 5242
ebfdc409
JP
5243# check for unnecessary "Out of Memory" messages
5244 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5245 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5246 (defined $1 || defined $3) &&
5247 $linenr > 3) {
5248 my $testval = $2;
5249 my $testline = $lines[$linenr - 3];
5250
5251 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5252# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5253
5254 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
5255 WARN("OOM_MESSAGE",
5256 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5257 }
5258 }
5259
f78d98f6 5260# check for logging functions with KERN_<LEVEL>
dcaf1123 5261 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
f78d98f6
JP
5262 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5263 my $level = $1;
5264 if (WARN("UNNECESSARY_KERN_LEVEL",
5265 "Possible unnecessary $level\n" . $herecurr) &&
5266 $fix) {
5267 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5268 }
5269 }
5270
abb08a53
JP
5271# check for mask then right shift without a parentheses
5272 if ($^V && $^V ge 5.10.0 &&
5273 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5274 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5275 WARN("MASK_THEN_SHIFT",
5276 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5277 }
5278
b75ac618
JP
5279# check for pointer comparisons to NULL
5280 if ($^V && $^V ge 5.10.0) {
5281 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5282 my $val = $1;
5283 my $equal = "!";
5284 $equal = "" if ($4 eq "!=");
5285 if (CHK("COMPARISON_TO_NULL",
5286 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5287 $fix) {
5288 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5289 }
5290 }
5291 }
5292
8716de38
JP
5293# check for bad placement of section $InitAttribute (e.g.: __initdata)
5294 if ($line =~ /(\b$InitAttribute\b)/) {
5295 my $attr = $1;
5296 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5297 my $ptr = $1;
5298 my $var = $2;
5299 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5300 ERROR("MISPLACED_INIT",
5301 "$attr should be placed after $var\n" . $herecurr)) ||
5302 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5303 WARN("MISPLACED_INIT",
5304 "$attr should be placed after $var\n" . $herecurr))) &&
5305 $fix) {
194f66fc 5306 $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
5307 }
5308 }
5309 }
5310
e970b884
JP
5311# check for $InitAttributeData (ie: __initdata) with const
5312 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5313 my $attr = $1;
5314 $attr =~ /($InitAttributePrefix)(.*)/;
5315 my $attr_prefix = $1;
5316 my $attr_type = $2;
5317 if (ERROR("INIT_ATTRIBUTE",
5318 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5319 $fix) {
194f66fc 5320 $fixed[$fixlinenr] =~
e970b884
JP
5321 s/$InitAttributeData/${attr_prefix}initconst/;
5322 }
5323 }
5324
5325# check for $InitAttributeConst (ie: __initconst) without const
5326 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5327 my $attr = $1;
5328 if (ERROR("INIT_ATTRIBUTE",
5329 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5330 $fix) {
194f66fc 5331 my $lead = $fixed[$fixlinenr] =~
e970b884
JP
5332 /(^\+\s*(?:static\s+))/;
5333 $lead = rtrim($1);
5334 $lead = "$lead " if ($lead !~ /^\+$/);
5335 $lead = "${lead}const ";
194f66fc 5336 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
e970b884
JP
5337 }
5338 }
5339
c17893c7
JP
5340# check for __read_mostly with const non-pointer (should just be const)
5341 if ($line =~ /\b__read_mostly\b/ &&
5342 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5343 if (ERROR("CONST_READ_MOSTLY",
5344 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5345 $fix) {
5346 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5347 }
5348 }
5349
fbdb8138
JP
5350# don't use __constant_<foo> functions outside of include/uapi/
5351 if ($realfile !~ m@^include/uapi/@ &&
5352 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5353 my $constant_func = $1;
5354 my $func = $constant_func;
5355 $func =~ s/^__constant_//;
5356 if (WARN("CONSTANT_CONVERSION",
5357 "$constant_func should be $func\n" . $herecurr) &&
5358 $fix) {
194f66fc 5359 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
fbdb8138
JP
5360 }
5361 }
5362
1a15a250 5363# prefer usleep_range over udelay
37581c28 5364 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
43c1d77c 5365 my $delay = $1;
1a15a250 5366 # ignore udelay's < 10, however
43c1d77c 5367 if (! ($delay < 10) ) {
000d1cc1 5368 CHK("USLEEP_RANGE",
43c1d77c
JP
5369 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5370 }
5371 if ($delay > 2000) {
5372 WARN("LONG_UDELAY",
5373 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
1a15a250
PP
5374 }
5375 }
5376
09ef8725
PP
5377# warn about unexpectedly long msleep's
5378 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5379 if ($1 < 20) {
000d1cc1 5380 WARN("MSLEEP",
43c1d77c 5381 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
09ef8725
PP
5382 }
5383 }
5384
36ec1939
JP
5385# check for comparisons of jiffies
5386 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5387 WARN("JIFFIES_COMPARISON",
5388 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5389 }
5390
9d7a34a5
JP
5391# check for comparisons of get_jiffies_64()
5392 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5393 WARN("JIFFIES_COMPARISON",
5394 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5395 }
5396
00df344f 5397# warn about #ifdefs in C files
c45dcabd 5398# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
00df344f
AW
5399# print "#ifdef in C files should be avoided\n";
5400# print "$herecurr";
5401# $clean = 0;
5402# }
5403
22f2a2ef 5404# warn about spacing in #ifdefs
c45dcabd 5405 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
3705ce5b
JP
5406 if (ERROR("SPACING",
5407 "exactly one space required after that #$1\n" . $herecurr) &&
5408 $fix) {
194f66fc 5409 $fixed[$fixlinenr] =~
3705ce5b
JP
5410 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5411 }
5412
22f2a2ef
AW
5413 }
5414
4a0df2ef 5415# check for spinlock_t definitions without a comment.
171ae1a4
AW
5416 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5417 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
4a0df2ef
AW
5418 my $which = $1;
5419 if (!ctx_has_comment($first_line, $linenr)) {
000d1cc1
JP
5420 CHK("UNCOMMENTED_DEFINITION",
5421 "$1 definition without comment\n" . $herecurr);
4a0df2ef
AW
5422 }
5423 }
5424# check for memory barriers without a comment.
402c2553
MT
5425
5426 my $barriers = qr{
5427 mb|
5428 rmb|
5429 wmb|
5430 read_barrier_depends
5431 }x;
5432 my $barrier_stems = qr{
5433 mb__before_atomic|
5434 mb__after_atomic|
5435 store_release|
5436 load_acquire|
5437 store_mb|
5438 (?:$barriers)
5439 }x;
5440 my $all_barriers = qr{
5441 (?:$barriers)|
43e361f2
MT
5442 smp_(?:$barrier_stems)|
5443 virt_(?:$barrier_stems)
402c2553
MT
5444 }x;
5445
5446 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
4a0df2ef 5447 if (!ctx_has_comment($first_line, $linenr)) {
c1fd7bb9
JP
5448 WARN("MEMORY_BARRIER",
5449 "memory barrier without comment\n" . $herecurr);
4a0df2ef
AW
5450 }
5451 }
3ad81779 5452
f4073b0f
MT
5453 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5454
5455 if ($realfile !~ m@^include/asm-generic/@ &&
5456 $realfile !~ m@/barrier\.h$@ &&
5457 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5458 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5459 WARN("MEMORY_BARRIER",
5460 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5461 }
5462
cb426e99
JP
5463# check for waitqueue_active without a comment.
5464 if ($line =~ /\bwaitqueue_active\s*\(/) {
5465 if (!ctx_has_comment($first_line, $linenr)) {
5466 WARN("WAITQUEUE_ACTIVE",
5467 "waitqueue_active without comment\n" . $herecurr);
5468 }
5469 }
3ad81779
PM
5470
5471# Check for expedited grace periods that interrupt non-idle non-nohz
5472# online CPUs. These expedited can therefore degrade real-time response
5473# if used carelessly, and should be avoided where not absolutely
5474# needed. It is always OK to use synchronize_rcu_expedited() and
5475# synchronize_sched_expedited() at boot time (before real-time applications
5476# start) and in error situations where real-time response is compromised in
5477# any case. Note that synchronize_srcu_expedited() does -not- interrupt
5478# other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5479# Of course, nothing comes for free, and srcu_read_lock() and
5480# srcu_read_unlock() do contain full memory barriers in payment for
5481# synchronize_srcu_expedited() non-interruption properties.
5482 if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) {
5483 WARN("EXPEDITED_RCU_GRACE_PERIOD",
5484 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5485
5486 }
5487
4a0df2ef 5488# check of hardware specific defines
c45dcabd 5489 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
000d1cc1
JP
5490 CHK("ARCH_DEFINES",
5491 "architecture specific defines should be avoided\n" . $herecurr);
0a920b5b 5492 }
653d4876 5493
d4977c78
TK
5494# Check that the storage class is at the beginning of a declaration
5495 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
000d1cc1
JP
5496 WARN("STORAGE_CLASS",
5497 "storage class should be at the beginning of the declaration\n" . $herecurr)
d4977c78
TK
5498 }
5499
de7d4f0e
AW
5500# check the location of the inline attribute, that it is between
5501# storage class and type.
9c0ca6f9
AW
5502 if ($line =~ /\b$Type\s+$Inline\b/ ||
5503 $line =~ /\b$Inline\s+$Storage\b/) {
000d1cc1
JP
5504 ERROR("INLINE_LOCATION",
5505 "inline keyword should sit between storage class and type\n" . $herecurr);
de7d4f0e
AW
5506 }
5507
8905a67c 5508# Check for __inline__ and __inline, prefer inline
2b7ab453
JP
5509 if ($realfile !~ m@\binclude/uapi/@ &&
5510 $line =~ /\b(__inline__|__inline)\b/) {
d5e616fc
JP
5511 if (WARN("INLINE",
5512 "plain inline is preferred over $1\n" . $herecurr) &&
5513 $fix) {
194f66fc 5514 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
d5e616fc
JP
5515
5516 }
8905a67c
AW
5517 }
5518
3d130fd0 5519# Check for __attribute__ packed, prefer __packed
2b7ab453
JP
5520 if ($realfile !~ m@\binclude/uapi/@ &&
5521 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
000d1cc1
JP
5522 WARN("PREFER_PACKED",
5523 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
3d130fd0
JP
5524 }
5525
39b7e287 5526# Check for __attribute__ aligned, prefer __aligned
2b7ab453
JP
5527 if ($realfile !~ m@\binclude/uapi/@ &&
5528 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
000d1cc1
JP
5529 WARN("PREFER_ALIGNED",
5530 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
39b7e287
JP
5531 }
5532
5f14d3bd 5533# Check for __attribute__ format(printf, prefer __printf
2b7ab453
JP
5534 if ($realfile !~ m@\binclude/uapi/@ &&
5535 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
d5e616fc
JP
5536 if (WARN("PREFER_PRINTF",
5537 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5538 $fix) {
194f66fc 5539 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
d5e616fc
JP
5540
5541 }
5f14d3bd
JP
5542 }
5543
6061d949 5544# Check for __attribute__ format(scanf, prefer __scanf
2b7ab453
JP
5545 if ($realfile !~ m@\binclude/uapi/@ &&
5546 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
d5e616fc
JP
5547 if (WARN("PREFER_SCANF",
5548 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5549 $fix) {
194f66fc 5550 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
d5e616fc 5551 }
6061d949
JP
5552 }
5553
619a908a
JP
5554# Check for __attribute__ weak, or __weak declarations (may have link issues)
5555 if ($^V && $^V ge 5.10.0 &&
5556 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5557 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5558 $line =~ /\b__weak\b/)) {
5559 ERROR("WEAK_DECLARATION",
5560 "Using weak declarations can have unintended link defects\n" . $herecurr);
5561 }
5562
e6176fa4
JP
5563# check for c99 types like uint8_t used outside of uapi/
5564 if ($realfile !~ m@\binclude/uapi/@ &&
5565 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5566 my $type = $1;
5567 if ($type =~ /\b($typeC99Typedefs)\b/) {
5568 $type = $1;
5569 my $kernel_type = 'u';
5570 $kernel_type = 's' if ($type =~ /^_*[si]/);
5571 $type =~ /(\d+)/;
5572 $kernel_type .= $1;
5573 if (CHK("PREFER_KERNEL_TYPES",
5574 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5575 $fix) {
5576 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5577 }
5578 }
5579 }
5580
938224b5
JP
5581# check for cast of C90 native int or longer types constants
5582 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5583 my $cast = $1;
5584 my $const = $2;
5585 if (WARN("TYPECAST_INT_CONSTANT",
5586 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5587 $fix) {
5588 my $suffix = "";
5589 my $newconst = $const;
5590 $newconst =~ s/${Int_type}$//;
5591 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5592 if ($cast =~ /\blong\s+long\b/) {
5593 $suffix .= 'LL';
5594 } elsif ($cast =~ /\blong\b/) {
5595 $suffix .= 'L';
5596 }
5597 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5598 }
5599 }
5600
8f53a9b8
JP
5601# check for sizeof(&)
5602 if ($line =~ /\bsizeof\s*\(\s*\&/) {
000d1cc1
JP
5603 WARN("SIZEOF_ADDRESS",
5604 "sizeof(& should be avoided\n" . $herecurr);
8f53a9b8
JP
5605 }
5606
66c80b60
JP
5607# check for sizeof without parenthesis
5608 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
d5e616fc
JP
5609 if (WARN("SIZEOF_PARENTHESIS",
5610 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5611 $fix) {
194f66fc 5612 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
d5e616fc 5613 }
66c80b60
JP
5614 }
5615
88982fea
JP
5616# check for struct spinlock declarations
5617 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5618 WARN("USE_SPINLOCK_T",
5619 "struct spinlock should be spinlock_t\n" . $herecurr);
5620 }
5621
a6962d72 5622# check for seq_printf uses that could be seq_puts
06668727 5623 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
a6962d72 5624 my $fmt = get_quoted_string($line, $rawline);
caac1d5f
HA
5625 $fmt =~ s/%%//g;
5626 if ($fmt !~ /%/) {
d5e616fc
JP
5627 if (WARN("PREFER_SEQ_PUTS",
5628 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5629 $fix) {
194f66fc 5630 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
d5e616fc 5631 }
a6962d72
JP
5632 }
5633 }
5634
554e165c 5635# Check for misused memsets
d1fe9c09
JP
5636 if ($^V && $^V ge 5.10.0 &&
5637 defined $stat &&
9e20a853 5638 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
d7c76ba7
JP
5639
5640 my $ms_addr = $2;
d1fe9c09
JP
5641 my $ms_val = $7;
5642 my $ms_size = $12;
554e165c 5643
554e165c
AW
5644 if ($ms_size =~ /^(0x|)0$/i) {
5645 ERROR("MEMSET",
d7c76ba7 5646 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
554e165c
AW
5647 } elsif ($ms_size =~ /^(0x|)1$/i) {
5648 WARN("MEMSET",
d7c76ba7
JP
5649 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5650 }
5651 }
5652
98a9bba5 5653# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
f333195d
JP
5654# if ($^V && $^V ge 5.10.0 &&
5655# defined $stat &&
5656# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5657# if (WARN("PREFER_ETHER_ADDR_COPY",
5658# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5659# $fix) {
5660# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5661# }
5662# }
98a9bba5 5663
b6117d17 5664# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
f333195d
JP
5665# if ($^V && $^V ge 5.10.0 &&
5666# defined $stat &&
5667# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5668# WARN("PREFER_ETHER_ADDR_EQUAL",
5669# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5670# }
b6117d17 5671
8617cd09
MK
5672# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5673# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
f333195d
JP
5674# if ($^V && $^V ge 5.10.0 &&
5675# defined $stat &&
5676# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5677#
5678# my $ms_val = $7;
5679#
5680# if ($ms_val =~ /^(?:0x|)0+$/i) {
5681# if (WARN("PREFER_ETH_ZERO_ADDR",
5682# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5683# $fix) {
5684# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5685# }
5686# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5687# if (WARN("PREFER_ETH_BROADCAST_ADDR",
5688# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5689# $fix) {
5690# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5691# }
5692# }
5693# }
8617cd09 5694
d7c76ba7 5695# typecasts on min/max could be min_t/max_t
d1fe9c09
JP
5696 if ($^V && $^V ge 5.10.0 &&
5697 defined $stat &&
d7c76ba7 5698 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
d1fe9c09 5699 if (defined $2 || defined $7) {
d7c76ba7
JP
5700 my $call = $1;
5701 my $cast1 = deparenthesize($2);
5702 my $arg1 = $3;
d1fe9c09
JP
5703 my $cast2 = deparenthesize($7);
5704 my $arg2 = $8;
d7c76ba7
JP
5705 my $cast;
5706
d1fe9c09 5707 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
d7c76ba7
JP
5708 $cast = "$cast1 or $cast2";
5709 } elsif ($cast1 ne "") {
5710 $cast = $cast1;
5711 } else {
5712 $cast = $cast2;
5713 }
5714 WARN("MINMAX",
5715 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
554e165c
AW
5716 }
5717 }
5718
4a273195
JP
5719# check usleep_range arguments
5720 if ($^V && $^V ge 5.10.0 &&
5721 defined $stat &&
5722 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5723 my $min = $1;
5724 my $max = $7;
5725 if ($min eq $max) {
5726 WARN("USLEEP_RANGE",
5727 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5728 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5729 $min > $max) {
5730 WARN("USLEEP_RANGE",
5731 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5732 }
5733 }
5734
823b794c
JP
5735# check for naked sscanf
5736 if ($^V && $^V ge 5.10.0 &&
5737 defined $stat &&
6c8bd707 5738 $line =~ /\bsscanf\b/ &&
823b794c
JP
5739 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5740 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5741 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5742 my $lc = $stat =~ tr@\n@@;
5743 $lc = $lc + $linenr;
5744 my $stat_real = raw_line($linenr, 0);
5745 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5746 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5747 }
5748 WARN("NAKED_SSCANF",
5749 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5750 }
5751
afc819ab
JP
5752# check for simple sscanf that should be kstrto<foo>
5753 if ($^V && $^V ge 5.10.0 &&
5754 defined $stat &&
5755 $line =~ /\bsscanf\b/) {
5756 my $lc = $stat =~ tr@\n@@;
5757 $lc = $lc + $linenr;
5758 my $stat_real = raw_line($linenr, 0);
5759 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5760 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5761 }
5762 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5763 my $format = $6;
5764 my $count = $format =~ tr@%@%@;
5765 if ($count == 1 &&
5766 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5767 WARN("SSCANF_TO_KSTRTO",
5768 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5769 }
5770 }
5771 }
5772
70dc8a48
JP
5773# check for new externs in .h files.
5774 if ($realfile =~ /\.h$/ &&
5775 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
d1d85780
JP
5776 if (CHK("AVOID_EXTERNS",
5777 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
70dc8a48 5778 $fix) {
194f66fc 5779 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
70dc8a48
JP
5780 }
5781 }
5782
de7d4f0e 5783# check for new externs in .c files.
171ae1a4 5784 if ($realfile =~ /\.c$/ && defined $stat &&
c45dcabd 5785 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
171ae1a4 5786 {
c45dcabd
AW
5787 my $function_name = $1;
5788 my $paren_space = $2;
171ae1a4
AW
5789
5790 my $s = $stat;
5791 if (defined $cond) {
5792 substr($s, 0, length($cond), '');
5793 }
c45dcabd
AW
5794 if ($s =~ /^\s*;/ &&
5795 $function_name ne 'uninitialized_var')
5796 {
000d1cc1
JP
5797 WARN("AVOID_EXTERNS",
5798 "externs should be avoided in .c files\n" . $herecurr);
171ae1a4
AW
5799 }
5800
5801 if ($paren_space =~ /\n/) {
000d1cc1
JP
5802 WARN("FUNCTION_ARGUMENTS",
5803 "arguments for function declarations should follow identifier\n" . $herecurr);
171ae1a4 5804 }
9c9ba34e
AW
5805
5806 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5807 $stat =~ /^.\s*extern\s+/)
5808 {
000d1cc1
JP
5809 WARN("AVOID_EXTERNS",
5810 "externs should be avoided in .c files\n" . $herecurr);
de7d4f0e
AW
5811 }
5812
ca0d8929
JP
5813 if ($realfile =~ /\.[ch]$/ && defined $stat &&
5814 $stat =~ /^.\s*(?:extern\s+)?$Type\s*$Ident\s*\(\s*([^{]+)\s*\)\s*;/s &&
5815 $1 ne "void") {
5816 my $args = trim($1);
5817 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
5818 my $arg = trim($1);
5819 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
5820 WARN("FUNCTION_ARGUMENTS",
5821 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
5822 }
5823 }
5824 }
5825
de7d4f0e
AW
5826# checks for new __setup's
5827 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5828 my $name = $1;
5829
5830 if (!grep(/$name/, @setup_docs)) {
000d1cc1
JP
5831 CHK("UNDOCUMENTED_SETUP",
5832 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
de7d4f0e 5833 }
653d4876 5834 }
9c0ca6f9
AW
5835
5836# check for pointless casting of kmalloc return
caf2a54f 5837 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
000d1cc1
JP
5838 WARN("UNNECESSARY_CASTS",
5839 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
9c0ca6f9 5840 }
13214adf 5841
a640d25c
JP
5842# alloc style
5843# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5844 if ($^V && $^V ge 5.10.0 &&
5845 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5846 CHK("ALLOC_SIZEOF_STRUCT",
5847 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5848 }
5849
60a55369
JP
5850# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5851 if ($^V && $^V ge 5.10.0 &&
e367455a 5852 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
60a55369
JP
5853 my $oldfunc = $3;
5854 my $a1 = $4;
5855 my $a2 = $10;
5856 my $newfunc = "kmalloc_array";
5857 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
e367455a
JP
5858 my $r1 = $a1;
5859 my $r2 = $a2;
5860 if ($a1 =~ /^sizeof\s*\S/) {
5861 $r1 = $a2;
5862 $r2 = $a1;
5863 }
5864 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5865 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
60a55369
JP
5866 if (WARN("ALLOC_WITH_MULTIPLY",
5867 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5868 $fix) {
194f66fc 5869 $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
5870
5871 }
5872 }
5873 }
5874
972fdea2
JP
5875# check for krealloc arg reuse
5876 if ($^V && $^V ge 5.10.0 &&
5877 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5878 WARN("KREALLOC_ARG_REUSE",
5879 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5880 }
5881
5ce59ae0
JP
5882# check for alloc argument mismatch
5883 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5884 WARN("ALLOC_ARRAY_ARGS",
5885 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5886 }
5887
caf2a54f
JP
5888# check for multiple semicolons
5889 if ($line =~ /;\s*;\s*$/) {
d5e616fc
JP
5890 if (WARN("ONE_SEMICOLON",
5891 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5892 $fix) {
194f66fc 5893 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
d5e616fc 5894 }
d1e2ad07
JP
5895 }
5896
cec3aaa5
TW
5897# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
5898 if ($realfile !~ m@^include/uapi/@ &&
5899 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
0ab90191
JP
5900 my $ull = "";
5901 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5902 if (CHK("BIT_MACRO",
5903 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5904 $fix) {
5905 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5906 }
5907 }
5908
2d632745
JP
5909# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
5910 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
5911 my $config = $1;
5912 if (WARN("PREFER_IS_ENABLED",
5913 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
5914 $fix) {
5915 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
5916 }
5917 }
5918
e81f239b 5919# check for case / default statements not preceded by break/fallthrough/switch
c34c09a8
JP
5920 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5921 my $has_break = 0;
5922 my $has_statement = 0;
5923 my $count = 0;
5924 my $prevline = $linenr;
e81f239b 5925 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
c34c09a8
JP
5926 $prevline--;
5927 my $rline = $rawlines[$prevline - 1];
5928 my $fline = $lines[$prevline - 1];
5929 last if ($fline =~ /^\@\@/);
5930 next if ($fline =~ /^\-/);
5931 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5932 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5933 next if ($fline =~ /^.[\s$;]*$/);
5934 $has_statement = 1;
5935 $count++;
5936 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5937 }
5938 if (!$has_break && $has_statement) {
5939 WARN("MISSING_BREAK",
224236d9 5940 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
c34c09a8
JP
5941 }
5942 }
5943
d1e2ad07
JP
5944# check for switch/default statements without a break;
5945 if ($^V && $^V ge 5.10.0 &&
5946 defined $stat &&
5947 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5948 my $ctx = '';
5949 my $herectx = $here . "\n";
5950 my $cnt = statement_rawlines($stat);
5951 for (my $n = 0; $n < $cnt; $n++) {
5952 $herectx .= raw_line($linenr, $n) . "\n";
5953 }
5954 WARN("DEFAULT_NO_BREAK",
5955 "switch default: should use break\n" . $herectx);
caf2a54f
JP
5956 }
5957
13214adf 5958# check for gcc specific __FUNCTION__
d5e616fc
JP
5959 if ($line =~ /\b__FUNCTION__\b/) {
5960 if (WARN("USE_FUNC",
5961 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5962 $fix) {
194f66fc 5963 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
d5e616fc 5964 }
13214adf 5965 }
773647a0 5966
62ec818f
JP
5967# check for uses of __DATE__, __TIME__, __TIMESTAMP__
5968 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5969 ERROR("DATE_TIME",
5970 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5971 }
5972
2c92488a
JP
5973# check for use of yield()
5974 if ($line =~ /\byield\s*\(\s*\)/) {
5975 WARN("YIELD",
5976 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5977 }
5978
179f8f40
JP
5979# check for comparisons against true and false
5980 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5981 my $lead = $1;
5982 my $arg = $2;
5983 my $test = $3;
5984 my $otype = $4;
5985 my $trail = $5;
5986 my $op = "!";
5987
5988 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5989
5990 my $type = lc($otype);
5991 if ($type =~ /^(?:true|false)$/) {
5992 if (("$test" eq "==" && "$type" eq "true") ||
5993 ("$test" eq "!=" && "$type" eq "false")) {
5994 $op = "";
5995 }
5996
5997 CHK("BOOL_COMPARISON",
5998 "Using comparison to $otype is error prone\n" . $herecurr);
5999
6000## maybe suggesting a correct construct would better
6001## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6002
6003 }
6004 }
6005
4882720b
TG
6006# check for semaphores initialized locked
6007 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
000d1cc1
JP
6008 WARN("CONSIDER_COMPLETION",
6009 "consider using a completion\n" . $herecurr);
773647a0 6010 }
6712d858 6011
67d0a075
JP
6012# recommend kstrto* over simple_strto* and strict_strto*
6013 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
000d1cc1 6014 WARN("CONSIDER_KSTRTO",
67d0a075 6015 "$1 is obsolete, use k$3 instead\n" . $herecurr);
773647a0 6016 }
6712d858 6017
ae3ccc46 6018# check for __initcall(), use device_initcall() explicitly or more appropriate function please
f3db6639 6019 if ($line =~ /^.\s*__initcall\s*\(/) {
000d1cc1 6020 WARN("USE_DEVICE_INITCALL",
ae3ccc46 6021 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
f3db6639 6022 }
6712d858 6023
0f3c5aab 6024# check for various structs that are normally const (ops, kgdb, device_tree)
6903ffb2 6025 if ($line !~ /\bconst\b/ &&
0f3c5aab 6026 $line =~ /\bstruct\s+($const_structs)\b/) {
000d1cc1
JP
6027 WARN("CONST_STRUCT",
6028 "struct $1 should normally be const\n" .
6903ffb2 6029 $herecurr);
2b6db5cb 6030 }
773647a0
AW
6031
6032# use of NR_CPUS is usually wrong
6033# ignore definitions of NR_CPUS and usage to define arrays as likely right
6034 if ($line =~ /\bNR_CPUS\b/ &&
c45dcabd
AW
6035 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6036 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
171ae1a4
AW
6037 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6038 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6039 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
773647a0 6040 {
000d1cc1
JP
6041 WARN("NR_CPUS",
6042 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
773647a0 6043 }
9c9ba34e 6044
52ea8506
JP
6045# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6046 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6047 ERROR("DEFINE_ARCH_HAS",
6048 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6049 }
6050
acd9362c
JP
6051# likely/unlikely comparisons similar to "(likely(foo) > 0)"
6052 if ($^V && $^V ge 5.10.0 &&
6053 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6054 WARN("LIKELY_MISUSE",
6055 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6056 }
6057
691d77b6
AW
6058# whine mightly about in_atomic
6059 if ($line =~ /\bin_atomic\s*\(/) {
6060 if ($realfile =~ m@^drivers/@) {
000d1cc1
JP
6061 ERROR("IN_ATOMIC",
6062 "do not use in_atomic in drivers\n" . $herecurr);
f4a87736 6063 } elsif ($realfile !~ m@^kernel/@) {
000d1cc1
JP
6064 WARN("IN_ATOMIC",
6065 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
691d77b6
AW
6066 }
6067 }
1704f47b 6068
481aea5c
JP
6069# whine about ACCESS_ONCE
6070 if ($^V && $^V ge 5.10.0 &&
6071 $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) {
6072 my $par = $1;
6073 my $eq = $2;
6074 my $fun = $3;
6075 $par =~ s/^\(\s*(.*)\s*\)$/$1/;
6076 if (defined($eq)) {
6077 if (WARN("PREFER_WRITE_ONCE",
6078 "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) &&
6079 $fix) {
6080 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
6081 }
6082 } else {
6083 if (WARN("PREFER_READ_ONCE",
6084 "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) &&
6085 $fix) {
6086 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/;
6087 }
6088 }
6089 }
6090
0f5225b0
PZ
6091# check for mutex_trylock_recursive usage
6092 if ($line =~ /mutex_trylock_recursive/) {
6093 ERROR("LOCKING",
6094 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6095 }
6096
1704f47b
PZ
6097# check for lockdep_set_novalidate_class
6098 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6099 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6100 if ($realfile !~ m@^kernel/lockdep@ &&
6101 $realfile !~ m@^include/linux/lockdep@ &&
6102 $realfile !~ m@^drivers/base/core@) {
000d1cc1
JP
6103 ERROR("LOCKDEP",
6104 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
1704f47b
PZ
6105 }
6106 }
88f8831c 6107
b392c64f
JP
6108 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6109 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
000d1cc1
JP
6110 WARN("EXPORTED_WORLD_WRITABLE",
6111 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
88f8831c 6112 }
2435880f 6113
515a235e
JP
6114# Mode permission misuses where it seems decimal should be octal
6115# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6116 if ($^V && $^V ge 5.10.0 &&
459cf0ae 6117 defined $stat &&
515a235e
JP
6118 $line =~ /$mode_perms_search/) {
6119 foreach my $entry (@mode_permission_funcs) {
6120 my $func = $entry->[0];
6121 my $arg_pos = $entry->[1];
6122
459cf0ae
JP
6123 my $lc = $stat =~ tr@\n@@;
6124 $lc = $lc + $linenr;
6125 my $stat_real = raw_line($linenr, 0);
6126 for (my $count = $linenr + 1; $count <= $lc; $count++) {
6127 $stat_real = $stat_real . "\n" . raw_line($count, 0);
6128 }
6129
515a235e
JP
6130 my $skip_args = "";
6131 if ($arg_pos > 1) {
6132 $arg_pos--;
6133 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6134 }
f90774e1 6135 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
459cf0ae 6136 if ($stat =~ /$test/) {
515a235e
JP
6137 my $val = $1;
6138 $val = $6 if ($skip_args ne "");
f90774e1
JP
6139 if (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6140 ($val =~ /^$Octal$/ && length($val) ne 4)) {
515a235e 6141 ERROR("NON_OCTAL_PERMISSIONS",
459cf0ae 6142 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
f90774e1
JP
6143 }
6144 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
c0a5c898 6145 ERROR("EXPORTED_WORLD_WRITABLE",
459cf0ae 6146 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
f90774e1 6147 }
2435880f
JP
6148 }
6149 }
6150 }
5a6d20ce 6151
459cf0ae
JP
6152# check for uses of S_<PERMS> that could be octal for readability
6153 if ($line =~ /\b$mode_perms_string_search\b/) {
6154 my $val = "";
6155 my $oval = "";
6156 my $to = 0;
6157 my $curpos = 0;
6158 my $lastpos = 0;
6159 while ($line =~ /\b(($mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
6160 $curpos = pos($line);
6161 my $match = $2;
6162 my $omatch = $1;
6163 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
6164 $lastpos = $curpos;
6165 $to |= $mode_permission_string_types{$match};
6166 $val .= '\s*\|\s*' if ($val ne "");
6167 $val .= $match;
6168 $oval .= $omatch;
6169 }
6170 $oval =~ s/^\s*\|\s*//;
6171 $oval =~ s/\s*\|\s*$//;
6172 my $octal = sprintf("%04o", $to);
6173 if (WARN("SYMBOLIC_PERMS",
6174 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6175 $fix) {
6176 $fixed[$fixlinenr] =~ s/$val/$octal/;
6177 }
6178 }
6179
5a6d20ce
BA
6180# validate content of MODULE_LICENSE against list from include/linux/module.h
6181 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6182 my $extracted_string = get_quoted_string($line, $rawline);
6183 my $valid_licenses = qr{
6184 GPL|
6185 GPL\ v2|
6186 GPL\ and\ additional\ rights|
6187 Dual\ BSD/GPL|
6188 Dual\ MIT/GPL|
6189 Dual\ MPL/GPL|
6190 Proprietary
6191 }x;
6192 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6193 WARN("MODULE_LICENSE",
6194 "unknown module license " . $extracted_string . "\n" . $herecurr);
6195 }
6196 }
13214adf
AW
6197 }
6198
6199 # If we have no input at all, then there is nothing to report on
6200 # so just keep quiet.
6201 if ($#rawlines == -1) {
6202 exit(0);
0a920b5b
AW
6203 }
6204
8905a67c
AW
6205 # In mailback mode only produce a report in the negative, for
6206 # things that appear to be patches.
6207 if ($mailback && ($clean == 1 || !$is_patch)) {
6208 exit(0);
6209 }
6210
6211 # This is not a patch, and we are are in 'no-patch' mode so
6212 # just keep quiet.
6213 if (!$chk_patch && !$is_patch) {
6214 exit(0);
6215 }
6216
06330fc4 6217 if (!$is_patch && $file !~ /cover-letter\.patch$/) {
000d1cc1
JP
6218 ERROR("NOT_UNIFIED_DIFF",
6219 "Does not appear to be a unified-diff format patch\n");
0a920b5b 6220 }
ed43c4e5 6221 if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
000d1cc1
JP
6222 ERROR("MISSING_SIGN_OFF",
6223 "Missing Signed-off-by: line(s)\n");
0a920b5b
AW
6224 }
6225
8905a67c 6226 print report_dump();
13214adf
AW
6227 if ($summary && !($clean == 1 && $quiet == 1)) {
6228 print "$filename " if ($summary_file);
8905a67c
AW
6229 print "total: $cnt_error errors, $cnt_warn warnings, " .
6230 (($check)? "$cnt_chk checks, " : "") .
6231 "$cnt_lines lines checked\n";
f0a594c1 6232 }
8905a67c 6233
d2c0a235 6234 if ($quiet == 0) {
ef212196
JP
6235 # If there were any defects found and not already fixing them
6236 if (!$clean and !$fix) {
6237 print << "EOM"
6238
6239NOTE: For some of the reported defects, checkpatch may be able to
6240 mechanically convert to the typical style using --fix or --fix-inplace.
6241EOM
6242 }
d2c0a235
AW
6243 # If there were whitespace errors which cleanpatch can fix
6244 # then suggest that.
6245 if ($rpt_cleaners) {
b0781216 6246 $rpt_cleaners = 0;
d8469f16
JP
6247 print << "EOM"
6248
6249NOTE: Whitespace errors detected.
6250 You may wish to use scripts/cleanpatch or scripts/cleanfile
6251EOM
d2c0a235
AW
6252 }
6253 }
6254
d752fcc8
JP
6255 if ($clean == 0 && $fix &&
6256 ("@rawlines" ne "@fixed" ||
6257 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
9624b8d6
JP
6258 my $newfile = $filename;
6259 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
3705ce5b
JP
6260 my $linecount = 0;
6261 my $f;
6262
d752fcc8
JP
6263 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6264
3705ce5b
JP
6265 open($f, '>', $newfile)
6266 or die "$P: Can't open $newfile for write\n";
6267 foreach my $fixed_line (@fixed) {
6268 $linecount++;
6269 if ($file) {
6270 if ($linecount > 3) {
6271 $fixed_line =~ s/^\+//;
d752fcc8 6272 print $f $fixed_line . "\n";
3705ce5b
JP
6273 }
6274 } else {
6275 print $f $fixed_line . "\n";
6276 }
6277 }
6278 close($f);
6279
6280 if (!$quiet) {
6281 print << "EOM";
d8469f16 6282
3705ce5b
JP
6283Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6284
6285Do _NOT_ trust the results written to this file.
6286Do _NOT_ submit these changes without inspecting them for correctness.
6287
6288This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6289No warranties, expressed or implied...
3705ce5b
JP
6290EOM
6291 }
6292 }
6293
d8469f16
JP
6294 if ($quiet == 0) {
6295 print "\n";
6296 if ($clean == 1) {
6297 print "$vname has no obvious style problems and is ready for submission.\n";
6298 } else {
6299 print "$vname has style problems, please review.\n";
6300 }
0a920b5b
AW
6301 }
6302 return $clean;
6303}