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