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