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