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