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