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