]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - scripts/checkpatch.pl
checkpatch: fix wildcard DT compatible string checking
[mirror_ubuntu-artful-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;
185d566b
RH
2096 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2097 my $compat3 = $compat;
2098 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2099 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
bff5da43
RH
2100 if ( $? >> 8 ) {
2101 WARN("UNDOCUMENTED_DT_STRING",
2102 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2103 }
2104
4fbf32a6
FV
2105 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2106 my $vendor = $1;
cc93319b 2107 `grep -Eq "^$vendor\\b" $vp_file`;
bff5da43
RH
2108 if ( $? >> 8 ) {
2109 WARN("UNDOCUMENTED_DT_STRING",
cc93319b 2110 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
bff5da43
RH
2111 }
2112 }
2113 }
2114
5368df20
AW
2115# check we are in a valid source file if not then ignore this hunk
2116 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
2117
6cd7f386 2118#line length limit
c45dcabd 2119 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
f4c014c0 2120 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
0fccc622 2121 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
8bbea968 2122 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
6cd7f386 2123 $length > $max_line_length)
c45dcabd 2124 {
000d1cc1 2125 WARN("LONG_LINE",
6cd7f386 2126 "line over $max_line_length characters\n" . $herecurr);
0a920b5b
AW
2127 }
2128
ca56dc09 2129# Check for user-visible strings broken across lines, which breaks the ability
8c5fcd24
JP
2130# to grep for the string. Make exceptions when the previous string ends in a
2131# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2132# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
ca56dc09
JT
2133 if ($line =~ /^\+\s*"/ &&
2134 $prevline =~ /"\s*$/ &&
8c5fcd24 2135 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
ca56dc09
JT
2136 WARN("SPLIT_STRING",
2137 "quoted string split across lines\n" . $hereprev);
2138 }
2139
5e79d96e
JP
2140# check for spaces before a quoted newline
2141 if ($rawline =~ /^.*\".*\s\\n/) {
3705ce5b
JP
2142 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
2143 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
2144 $fix) {
2145 $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
2146 }
2147
5e79d96e
JP
2148 }
2149
8905a67c
AW
2150# check for adding lines without a newline.
2151 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
000d1cc1
JP
2152 WARN("MISSING_EOF_NEWLINE",
2153 "adding a line without newline at end of file\n" . $herecurr);
8905a67c
AW
2154 }
2155
42e41c54
MF
2156# Blackfin: use hi/lo macros
2157 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2158 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2159 my $herevet = "$here\n" . cat_vet($line) . "\n";
000d1cc1
JP
2160 ERROR("LO_MACRO",
2161 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
42e41c54
MF
2162 }
2163 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2164 my $herevet = "$here\n" . cat_vet($line) . "\n";
000d1cc1
JP
2165 ERROR("HI_MACRO",
2166 "use the HI() macro, not (... >> 16)\n" . $herevet);
42e41c54
MF
2167 }
2168 }
2169
b9ea10d6
AW
2170# check we are in a valid source file C or perl if not then ignore this hunk
2171 next if ($realfile !~ /\.(h|c|pl)$/);
0a920b5b
AW
2172
2173# at the beginning of a line any tabs must come first and anything
2174# more than 8 must use tabs.
c2fdda0d
AW
2175 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2176 $rawline =~ /^\+\s* \s*/) {
2177 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
d2c0a235 2178 $rpt_cleaners = 1;
3705ce5b
JP
2179 if (ERROR("CODE_INDENT",
2180 "code indent should use tabs where possible\n" . $herevet) &&
2181 $fix) {
2182 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2183 }
0a920b5b
AW
2184 }
2185
08e44365
AP
2186# check for space before tabs.
2187 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2188 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3705ce5b
JP
2189 if (WARN("SPACE_BEFORE_TAB",
2190 "please, no space before tabs\n" . $herevet) &&
2191 $fix) {
c76f4cb3
JP
2192 while ($fixed[$linenr - 1] =~
2193 s/(^\+.*) {8,8}+\t/$1\t\t/) {}
2194 while ($fixed[$linenr - 1] =~
2195 s/(^\+.*) +\t/$1\t/) {}
3705ce5b 2196 }
08e44365
AP
2197 }
2198
d1fe9c09
JP
2199# check for && or || at the start of a line
2200 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2201 CHK("LOGICAL_CONTINUATIONS",
2202 "Logical continuations should be on the previous line\n" . $hereprev);
2203 }
2204
2205# check multi-line statement indentation matches previous line
2206 if ($^V && $^V ge 5.10.0 &&
91cb5195 2207 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
d1fe9c09
JP
2208 $prevline =~ /^\+(\t*)(.*)$/;
2209 my $oldindent = $1;
2210 my $rest = $2;
2211
2212 my $pos = pos_last_openparen($rest);
2213 if ($pos >= 0) {
b34a26f3
JP
2214 $line =~ /^(\+| )([ \t]*)/;
2215 my $newindent = $2;
d1fe9c09
JP
2216
2217 my $goodtabindent = $oldindent .
2218 "\t" x ($pos / 8) .
2219 " " x ($pos % 8);
2220 my $goodspaceindent = $oldindent . " " x $pos;
2221
2222 if ($newindent ne $goodtabindent &&
2223 $newindent ne $goodspaceindent) {
3705ce5b
JP
2224
2225 if (CHK("PARENTHESIS_ALIGNMENT",
2226 "Alignment should match open parenthesis\n" . $hereprev) &&
2227 $fix && $line =~ /^\+/) {
2228 $fixed[$linenr - 1] =~
2229 s/^\+[ \t]*/\+$goodtabindent/;
2230 }
d1fe9c09
JP
2231 }
2232 }
2233 }
2234
23f780c9 2235 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
3705ce5b
JP
2236 if (CHK("SPACING",
2237 "No space is necessary after a cast\n" . $hereprev) &&
2238 $fix) {
2239 $fixed[$linenr - 1] =~
2240 s/^(\+.*\*[ \t]*\))[ \t]+/$1/;
2241 }
aad4f614
JP
2242 }
2243
05880600 2244 if ($realfile =~ m@^(drivers/net/|net/)@ &&
fdb4bcd6 2245 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
85ad978c
JP
2246 $rawline =~ /^\+[ \t]*\*/ &&
2247 $realline > 2) {
05880600
JP
2248 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2249 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2250 }
2251
2252 if ($realfile =~ m@^(drivers/net/|net/)@ &&
a605e32e
JP
2253 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2254 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
61135e96 2255 $rawline =~ /^\+/ && #line is new
a605e32e
JP
2256 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2257 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2258 "networking block comments start with * on subsequent lines\n" . $hereprev);
2259 }
2260
2261 if ($realfile =~ m@^(drivers/net/|net/)@ &&
c24f9f19
JP
2262 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2263 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2264 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2265 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
05880600
JP
2266 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2267 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2268 }
2269
3b617e3b
JP
2270# check for missing blank lines after declarations
2271 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2272 $prevline =~ /^\+\s+$Declare\s+$Ident/ &&
2273 !($prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2274 $prevline =~ /(?:\{\s*|\\)$/) && #extended lines
2275 $sline =~ /^\+\s+/ && #Not at char 1
2276 !($sline =~ /^\+\s+$Declare/ ||
2277 $sline =~ /^\+\s+$Ident\s+$Ident/ || #eg: typedef foo
2278 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
2279 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(])/ ||
2280 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/)) {
2281 WARN("SPACING",
2282 "networking uses a blank line after declarations\n" . $hereprev);
2283 }
2284
5f7ddae6 2285# check for spaces at the beginning of a line.
6b4c5beb
AW
2286# Exceptions:
2287# 1) within comments
2288# 2) indented preprocessor commands
2289# 3) hanging labels
3705ce5b 2290 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
5f7ddae6 2291 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3705ce5b
JP
2292 if (WARN("LEADING_SPACE",
2293 "please, no spaces at the start of a line\n" . $herevet) &&
2294 $fix) {
2295 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2296 }
5f7ddae6
RR
2297 }
2298
b9ea10d6
AW
2299# check we are in a valid C source file if not then ignore this hunk
2300 next if ($realfile !~ /\.(h|c)$/);
2301
1ba8dfd1
KC
2302# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2303 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2304 WARN("CONFIG_EXPERIMENTAL",
2305 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2306 }
2307
c2fdda0d 2308# check for RCS/CVS revision markers
cf655043 2309 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
000d1cc1
JP
2310 WARN("CVS_KEYWORD",
2311 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
c2fdda0d 2312 }
22f2a2ef 2313
42e41c54
MF
2314# Blackfin: don't use __builtin_bfin_[cs]sync
2315 if ($line =~ /__builtin_bfin_csync/) {
2316 my $herevet = "$here\n" . cat_vet($line) . "\n";
000d1cc1
JP
2317 ERROR("CSYNC",
2318 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
42e41c54
MF
2319 }
2320 if ($line =~ /__builtin_bfin_ssync/) {
2321 my $herevet = "$here\n" . cat_vet($line) . "\n";
000d1cc1
JP
2322 ERROR("SSYNC",
2323 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
42e41c54
MF
2324 }
2325
56e77d70
JP
2326# check for old HOTPLUG __dev<foo> section markings
2327 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2328 WARN("HOTPLUG_SECTION",
2329 "Using $1 is unnecessary\n" . $herecurr);
2330 }
2331
9c0ca6f9 2332# Check for potential 'bare' types
2b474a1a
AW
2333 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2334 $realline_next);
3e469cdc
AW
2335#print "LINE<$line>\n";
2336 if ($linenr >= $suppress_statement &&
1b5539b1 2337 $realcnt && $sline =~ /.\s*\S/) {
170d3a22 2338 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
f5fe35dd 2339 ctx_statement_block($linenr, $realcnt, 0);
171ae1a4
AW
2340 $stat =~ s/\n./\n /g;
2341 $cond =~ s/\n./\n /g;
2342
3e469cdc
AW
2343#print "linenr<$linenr> <$stat>\n";
2344 # If this statement has no statement boundaries within
2345 # it there is no point in retrying a statement scan
2346 # until we hit end of it.
2347 my $frag = $stat; $frag =~ s/;+\s*$//;
2348 if ($frag !~ /(?:{|;)/) {
2349#print "skip<$line_nr_next>\n";
2350 $suppress_statement = $line_nr_next;
2351 }
f74bd194 2352
2b474a1a
AW
2353 # Find the real next line.
2354 $realline_next = $line_nr_next;
2355 if (defined $realline_next &&
2356 (!defined $lines[$realline_next - 1] ||
2357 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2358 $realline_next++;
2359 }
2360
171ae1a4
AW
2361 my $s = $stat;
2362 $s =~ s/{.*$//s;
cf655043 2363
c2fdda0d 2364 # Ignore goto labels.
171ae1a4 2365 if ($s =~ /$Ident:\*$/s) {
c2fdda0d
AW
2366
2367 # Ignore functions being called
171ae1a4 2368 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
c2fdda0d 2369
463f2864
AW
2370 } elsif ($s =~ /^.\s*else\b/s) {
2371
c45dcabd 2372 # declarations always start with types
d2506586 2373 } 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
2374 my $type = $1;
2375 $type =~ s/\s+/ /g;
2376 possible($type, "A:" . $s);
2377
8905a67c 2378 # definitions in global scope can only start with types
a6a84062 2379 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
c45dcabd 2380 possible($1, "B:" . $s);
c2fdda0d 2381 }
8905a67c
AW
2382
2383 # any (foo ... *) is a pointer cast, and foo is a type
65863862 2384 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
c45dcabd 2385 possible($1, "C:" . $s);
8905a67c
AW
2386 }
2387
2388 # Check for any sort of function declaration.
2389 # int foo(something bar, other baz);
2390 # void (*store_gdt)(x86_descr_ptr *);
171ae1a4 2391 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
8905a67c 2392 my ($name_len) = length($1);
8905a67c 2393
cf655043 2394 my $ctx = $s;
773647a0 2395 substr($ctx, 0, $name_len + 1, '');
8905a67c 2396 $ctx =~ s/\)[^\)]*$//;
cf655043 2397
8905a67c 2398 for my $arg (split(/\s*,\s*/, $ctx)) {
c45dcabd 2399 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
8905a67c 2400
c45dcabd 2401 possible($1, "D:" . $s);
8905a67c
AW
2402 }
2403 }
9c0ca6f9 2404 }
8905a67c 2405
9c0ca6f9
AW
2406 }
2407
653d4876
AW
2408#
2409# Checks which may be anchored in the context.
2410#
00df344f 2411
653d4876
AW
2412# Check for switch () and associated case and default
2413# statements should be at the same indent.
00df344f
AW
2414 if ($line=~/\bswitch\s*\(.*\)/) {
2415 my $err = '';
2416 my $sep = '';
2417 my @ctx = ctx_block_outer($linenr, $realcnt);
2418 shift(@ctx);
2419 for my $ctx (@ctx) {
2420 my ($clen, $cindent) = line_stats($ctx);
2421 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2422 $indent != $cindent) {
2423 $err .= "$sep$ctx\n";
2424 $sep = '';
2425 } else {
2426 $sep = "[...]\n";
2427 }
2428 }
2429 if ($err ne '') {
000d1cc1
JP
2430 ERROR("SWITCH_CASE_INDENT_LEVEL",
2431 "switch and case should be at the same indent\n$hereline$err");
de7d4f0e
AW
2432 }
2433 }
2434
2435# if/while/etc brace do not go on next line, unless defining a do while loop,
2436# or if that brace on the next line is for something else
c45dcabd 2437 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
773647a0
AW
2438 my $pre_ctx = "$1$2";
2439
9c0ca6f9 2440 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
8eef05dd
JP
2441
2442 if ($line =~ /^\+\t{6,}/) {
2443 WARN("DEEP_INDENTATION",
2444 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2445 }
2446
de7d4f0e
AW
2447 my $ctx_cnt = $realcnt - $#ctx - 1;
2448 my $ctx = join("\n", @ctx);
2449
548596d5
AW
2450 my $ctx_ln = $linenr;
2451 my $ctx_skip = $realcnt;
773647a0 2452
548596d5
AW
2453 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2454 defined $lines[$ctx_ln - 1] &&
2455 $lines[$ctx_ln - 1] =~ /^-/)) {
2456 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2457 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
de7d4f0e 2458 $ctx_ln++;
de7d4f0e 2459 }
548596d5 2460
53210168
AW
2461 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2462 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
de7d4f0e 2463
773647a0 2464 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
000d1cc1
JP
2465 ERROR("OPEN_BRACE",
2466 "that open brace { should be on the previous line\n" .
01464f30 2467 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
00df344f 2468 }
773647a0
AW
2469 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2470 $ctx =~ /\)\s*\;\s*$/ &&
2471 defined $lines[$ctx_ln - 1])
2472 {
9c0ca6f9
AW
2473 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2474 if ($nindent > $indent) {
000d1cc1
JP
2475 WARN("TRAILING_SEMICOLON",
2476 "trailing semicolon indicates no statements, indent implies otherwise\n" .
01464f30 2477 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
9c0ca6f9
AW
2478 }
2479 }
00df344f
AW
2480 }
2481
4d001e4d
AW
2482# Check relative indent for conditionals and blocks.
2483 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3e469cdc
AW
2484 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2485 ctx_statement_block($linenr, $realcnt, 0)
2486 if (!defined $stat);
4d001e4d
AW
2487 my ($s, $c) = ($stat, $cond);
2488
2489 substr($s, 0, length($c), '');
2490
2491 # Make sure we remove the line prefixes as we have
2492 # none on the first line, and are going to readd them
2493 # where necessary.
2494 $s =~ s/\n./\n/gs;
2495
2496 # Find out how long the conditional actually is.
6f779c18
AW
2497 my @newlines = ($c =~ /\n/gs);
2498 my $cond_lines = 1 + $#newlines;
4d001e4d
AW
2499
2500 # We want to check the first line inside the block
2501 # starting at the end of the conditional, so remove:
2502 # 1) any blank line termination
2503 # 2) any opening brace { on end of the line
2504 # 3) any do (...) {
2505 my $continuation = 0;
2506 my $check = 0;
2507 $s =~ s/^.*\bdo\b//;
2508 $s =~ s/^\s*{//;
2509 if ($s =~ s/^\s*\\//) {
2510 $continuation = 1;
2511 }
9bd49efe 2512 if ($s =~ s/^\s*?\n//) {
4d001e4d
AW
2513 $check = 1;
2514 $cond_lines++;
2515 }
2516
2517 # Also ignore a loop construct at the end of a
2518 # preprocessor statement.
2519 if (($prevline =~ /^.\s*#\s*define\s/ ||
2520 $prevline =~ /\\\s*$/) && $continuation == 0) {
2521 $check = 0;
2522 }
2523
9bd49efe 2524 my $cond_ptr = -1;
740504c6 2525 $continuation = 0;
9bd49efe
AW
2526 while ($cond_ptr != $cond_lines) {
2527 $cond_ptr = $cond_lines;
2528
f16fa28f
AW
2529 # If we see an #else/#elif then the code
2530 # is not linear.
2531 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2532 $check = 0;
2533 }
2534
9bd49efe
AW
2535 # Ignore:
2536 # 1) blank lines, they should be at 0,
2537 # 2) preprocessor lines, and
2538 # 3) labels.
740504c6
AW
2539 if ($continuation ||
2540 $s =~ /^\s*?\n/ ||
9bd49efe
AW
2541 $s =~ /^\s*#\s*?/ ||
2542 $s =~ /^\s*$Ident\s*:/) {
740504c6 2543 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
30dad6eb
AW
2544 if ($s =~ s/^.*?\n//) {
2545 $cond_lines++;
2546 }
9bd49efe 2547 }
4d001e4d
AW
2548 }
2549
2550 my (undef, $sindent) = line_stats("+" . $s);
2551 my $stat_real = raw_line($linenr, $cond_lines);
2552
2553 # Check if either of these lines are modified, else
2554 # this is not this patch's fault.
2555 if (!defined($stat_real) ||
2556 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2557 $check = 0;
2558 }
2559 if (defined($stat_real) && $cond_lines > 1) {
2560 $stat_real = "[...]\n$stat_real";
2561 }
2562
9bd49efe 2563 #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
2564
2565 if ($check && (($sindent % 8) != 0 ||
2566 ($sindent <= $indent && $s ne ''))) {
000d1cc1
JP
2567 WARN("SUSPECT_CODE_INDENT",
2568 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
4d001e4d
AW
2569 }
2570 }
2571
6c72ffaa
AW
2572 # Track the 'values' across context and added lines.
2573 my $opline = $line; $opline =~ s/^./ /;
1f65f947
AW
2574 my ($curr_values, $curr_vars) =
2575 annotate_values($opline . "\n", $prev_values);
6c72ffaa 2576 $curr_values = $prev_values . $curr_values;
c2fdda0d
AW
2577 if ($dbg_values) {
2578 my $outline = $opline; $outline =~ s/\t/ /g;
cf655043
AW
2579 print "$linenr > .$outline\n";
2580 print "$linenr > $curr_values\n";
1f65f947 2581 print "$linenr > $curr_vars\n";
c2fdda0d 2582 }
6c72ffaa
AW
2583 $prev_values = substr($curr_values, -1);
2584
00df344f 2585#ignore lines not being added
3705ce5b 2586 next if ($line =~ /^[^\+]/);
00df344f 2587
653d4876 2588# TEST: allow direct testing of the type matcher.
7429c690
AW
2589 if ($dbg_type) {
2590 if ($line =~ /^.\s*$Declare\s*$/) {
000d1cc1
JP
2591 ERROR("TEST_TYPE",
2592 "TEST: is type\n" . $herecurr);
7429c690 2593 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
000d1cc1
JP
2594 ERROR("TEST_NOT_TYPE",
2595 "TEST: is not type ($1 is)\n". $herecurr);
7429c690 2596 }
653d4876
AW
2597 next;
2598 }
a1ef277e
AW
2599# TEST: allow direct testing of the attribute matcher.
2600 if ($dbg_attr) {
9360b0e5 2601 if ($line =~ /^.\s*$Modifier\s*$/) {
000d1cc1
JP
2602 ERROR("TEST_ATTR",
2603 "TEST: is attr\n" . $herecurr);
9360b0e5 2604 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
000d1cc1
JP
2605 ERROR("TEST_NOT_ATTR",
2606 "TEST: is not attr ($1 is)\n". $herecurr);
a1ef277e
AW
2607 }
2608 next;
2609 }
653d4876 2610
f0a594c1 2611# check for initialisation to aggregates open brace on the next line
99423c20
AW
2612 if ($line =~ /^.\s*{/ &&
2613 $prevline =~ /(?:^|[^=])=\s*$/) {
000d1cc1
JP
2614 ERROR("OPEN_BRACE",
2615 "that open brace { should be on the previous line\n" . $hereprev);
f0a594c1
AW
2616 }
2617
653d4876
AW
2618#
2619# Checks which are anchored on the added line.
2620#
2621
2622# check for malformed paths in #include statements (uses RAW line)
c45dcabd 2623 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
653d4876
AW
2624 my $path = $1;
2625 if ($path =~ m{//}) {
000d1cc1 2626 ERROR("MALFORMED_INCLUDE",
495e9d84
JP
2627 "malformed #include filename\n" . $herecurr);
2628 }
2629 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2630 ERROR("UAPI_INCLUDE",
2631 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
653d4876 2632 }
653d4876 2633 }
00df344f 2634
0a920b5b 2635# no C99 // comments
00df344f 2636 if ($line =~ m{//}) {
3705ce5b
JP
2637 if (ERROR("C99_COMMENTS",
2638 "do not use C99 // comments\n" . $herecurr) &&
2639 $fix) {
2640 my $line = $fixed[$linenr - 1];
2641 if ($line =~ /\/\/(.*)$/) {
2642 my $comment = trim($1);
2643 $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@;
2644 }
2645 }
0a920b5b 2646 }
00df344f 2647 # Remove C99 comments.
0a920b5b 2648 $line =~ s@//.*@@;
6c72ffaa 2649 $opline =~ s@//.*@@;
0a920b5b 2650
2b474a1a
AW
2651# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2652# the whole statement.
2653#print "APW <$lines[$realline_next - 1]>\n";
2654 if (defined $realline_next &&
2655 exists $lines[$realline_next - 1] &&
2656 !defined $suppress_export{$realline_next} &&
2657 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2658 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3cbf62df
AW
2659 # Handle definitions which produce identifiers with
2660 # a prefix:
2661 # XXX(foo);
2662 # EXPORT_SYMBOL(something_foo);
653d4876 2663 my $name = $1;
87a53877 2664 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3cbf62df
AW
2665 $name =~ /^${Ident}_$2/) {
2666#print "FOO C name<$name>\n";
2667 $suppress_export{$realline_next} = 1;
2668
2669 } elsif ($stat !~ /(?:
2b474a1a 2670 \n.}\s*$|
48012058
AW
2671 ^.DEFINE_$Ident\(\Q$name\E\)|
2672 ^.DECLARE_$Ident\(\Q$name\E\)|
2673 ^.LIST_HEAD\(\Q$name\E\)|
2b474a1a
AW
2674 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2675 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
48012058 2676 )/x) {
2b474a1a
AW
2677#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2678 $suppress_export{$realline_next} = 2;
2679 } else {
2680 $suppress_export{$realline_next} = 1;
0a920b5b
AW
2681 }
2682 }
2b474a1a
AW
2683 if (!defined $suppress_export{$linenr} &&
2684 $prevline =~ /^.\s*$/ &&
2685 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2686 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2687#print "FOO B <$lines[$linenr - 1]>\n";
2688 $suppress_export{$linenr} = 2;
2689 }
2690 if (defined $suppress_export{$linenr} &&
2691 $suppress_export{$linenr} == 2) {
000d1cc1
JP
2692 WARN("EXPORT_SYMBOL",
2693 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2b474a1a 2694 }
0a920b5b 2695
5150bda4 2696# check for global initialisers.
d5e616fc
JP
2697 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
2698 if (ERROR("GLOBAL_INITIALISERS",
2699 "do not initialise globals to 0 or NULL\n" .
2700 $herecurr) &&
2701 $fix) {
2702 $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
2703 }
f0a594c1 2704 }
653d4876 2705# check for static initialisers.
d5e616fc
JP
2706 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2707 if (ERROR("INITIALISED_STATIC",
2708 "do not initialise statics to 0 or NULL\n" .
2709 $herecurr) &&
2710 $fix) {
2711 $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
2712 }
0a920b5b
AW
2713 }
2714
cb710eca
JP
2715# check for static const char * arrays.
2716 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
000d1cc1
JP
2717 WARN("STATIC_CONST_CHAR_ARRAY",
2718 "static const char * array should probably be static const char * const\n" .
cb710eca
JP
2719 $herecurr);
2720 }
2721
2722# check for static char foo[] = "bar" declarations.
2723 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
000d1cc1
JP
2724 WARN("STATIC_CONST_CHAR_ARRAY",
2725 "static char array declaration should probably be static const char\n" .
cb710eca
JP
2726 $herecurr);
2727 }
2728
9b0fa60d
JP
2729# check for non-global char *foo[] = {"bar", ...} declarations.
2730 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
2731 WARN("STATIC_CONST_CHAR_ARRAY",
2732 "char * array declaration might be better as static const\n" .
2733 $herecurr);
2734 }
2735
b36190c5
JP
2736# check for function declarations without arguments like "int foo()"
2737 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
2738 if (ERROR("FUNCTION_WITHOUT_ARGS",
2739 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
2740 $fix) {
2741 $fixed[$linenr - 1] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
2742 }
2743 }
2744
92e112fd
JP
2745# check for uses of DEFINE_PCI_DEVICE_TABLE
2746 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
2747 if (WARN("DEFINE_PCI_DEVICE_TABLE",
2748 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
2749 $fix) {
2750 $fixed[$linenr - 1] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
2751 }
93ed0e2d
JP
2752 }
2753
653d4876
AW
2754# check for new typedefs, only function parameters and sparse annotations
2755# make sense.
2756 if ($line =~ /\btypedef\s/ &&
8054576d 2757 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
c45dcabd 2758 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
8ed22cad 2759 $line !~ /\b$typeTypedefs\b/ &&
653d4876 2760 $line !~ /\b__bitwise(?:__|)\b/) {
000d1cc1
JP
2761 WARN("NEW_TYPEDEFS",
2762 "do not add new typedefs\n" . $herecurr);
0a920b5b
AW
2763 }
2764
2765# * goes on variable not on type
65863862 2766 # (char*[ const])
bfcb2cc7
AW
2767 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2768 #print "AA<$1>\n";
3705ce5b 2769 my ($ident, $from, $to) = ($1, $2, $2);
65863862
AW
2770
2771 # Should start with a space.
2772 $to =~ s/^(\S)/ $1/;
2773 # Should not end with a space.
2774 $to =~ s/\s+$//;
2775 # '*'s should not have spaces between.
f9a0b3d1 2776 while ($to =~ s/\*\s+\*/\*\*/) {
65863862 2777 }
d8aaf121 2778
3705ce5b 2779## print "1: from<$from> to<$to> ident<$ident>\n";
65863862 2780 if ($from ne $to) {
3705ce5b
JP
2781 if (ERROR("POINTER_LOCATION",
2782 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
2783 $fix) {
2784 my $sub_from = $ident;
2785 my $sub_to = $ident;
2786 $sub_to =~ s/\Q$from\E/$to/;
2787 $fixed[$linenr - 1] =~
2788 s@\Q$sub_from\E@$sub_to@;
2789 }
65863862 2790 }
bfcb2cc7
AW
2791 }
2792 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2793 #print "BB<$1>\n";
3705ce5b 2794 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
65863862
AW
2795
2796 # Should start with a space.
2797 $to =~ s/^(\S)/ $1/;
2798 # Should not end with a space.
2799 $to =~ s/\s+$//;
2800 # '*'s should not have spaces between.
f9a0b3d1 2801 while ($to =~ s/\*\s+\*/\*\*/) {
65863862
AW
2802 }
2803 # Modifiers should have spaces.
2804 $to =~ s/(\b$Modifier$)/$1 /;
d8aaf121 2805
3705ce5b 2806## print "2: from<$from> to<$to> ident<$ident>\n";
667026e7 2807 if ($from ne $to && $ident !~ /^$Modifier$/) {
3705ce5b
JP
2808 if (ERROR("POINTER_LOCATION",
2809 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
2810 $fix) {
2811
2812 my $sub_from = $match;
2813 my $sub_to = $match;
2814 $sub_to =~ s/\Q$from\E/$to/;
2815 $fixed[$linenr - 1] =~
2816 s@\Q$sub_from\E@$sub_to@;
2817 }
65863862 2818 }
0a920b5b
AW
2819 }
2820
2821# # no BUG() or BUG_ON()
2822# if ($line =~ /\b(BUG|BUG_ON)\b/) {
2823# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2824# print "$herecurr";
2825# $clean = 0;
2826# }
2827
8905a67c 2828 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
000d1cc1
JP
2829 WARN("LINUX_VERSION_CODE",
2830 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
8905a67c
AW
2831 }
2832
17441227
JP
2833# check for uses of printk_ratelimit
2834 if ($line =~ /\bprintk_ratelimit\s*\(/) {
000d1cc1
JP
2835 WARN("PRINTK_RATELIMITED",
2836"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
17441227
JP
2837 }
2838
00df344f
AW
2839# printk should use KERN_* levels. Note that follow on printk's on the
2840# same line do not need a level, so we use the current block context
2841# to try and find and validate the current printk. In summary the current
25985edc 2842# printk includes all preceding printk's which have no newline on the end.
00df344f 2843# we assume the first bad printk is the one to report.
f0a594c1 2844 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
00df344f
AW
2845 my $ok = 0;
2846 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2847 #print "CHECK<$lines[$ln - 1]\n";
25985edc 2848 # we have a preceding printk if it ends
00df344f
AW
2849 # with "\n" ignore it, else it is to blame
2850 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2851 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2852 $ok = 1;
2853 }
2854 last;
2855 }
2856 }
2857 if ($ok == 0) {
000d1cc1
JP
2858 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2859 "printk() should include KERN_ facility level\n" . $herecurr);
00df344f 2860 }
0a920b5b
AW
2861 }
2862
243f3803
JP
2863 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2864 my $orig = $1;
2865 my $level = lc($orig);
2866 $level = "warn" if ($level eq "warning");
8f26b837
JP
2867 my $level2 = $level;
2868 $level2 = "dbg" if ($level eq "debug");
243f3803 2869 WARN("PREFER_PR_LEVEL",
daa8b059 2870 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
243f3803
JP
2871 }
2872
2873 if ($line =~ /\bpr_warning\s*\(/) {
d5e616fc
JP
2874 if (WARN("PREFER_PR_LEVEL",
2875 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
2876 $fix) {
2877 $fixed[$linenr - 1] =~
2878 s/\bpr_warning\b/pr_warn/;
2879 }
243f3803
JP
2880 }
2881
dc139313
JP
2882 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
2883 my $orig = $1;
2884 my $level = lc($orig);
2885 $level = "warn" if ($level eq "warning");
2886 $level = "dbg" if ($level eq "debug");
2887 WARN("PREFER_DEV_LEVEL",
2888 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
2889 }
2890
653d4876
AW
2891# function brace can't be on same line, except for #defines of do while,
2892# or if closed on same line
c45dcabd
AW
2893 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2894 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
000d1cc1
JP
2895 ERROR("OPEN_BRACE",
2896 "open brace '{' following function declarations go on the next line\n" . $herecurr);
0a920b5b 2897 }
653d4876 2898
8905a67c
AW
2899# open braces for enum, union and struct go on the same line.
2900 if ($line =~ /^.\s*{/ &&
2901 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
000d1cc1
JP
2902 ERROR("OPEN_BRACE",
2903 "open brace '{' following $1 go on the same line\n" . $hereprev);
8905a67c
AW
2904 }
2905
0c73b4eb 2906# missing space after union, struct or enum definition
3705ce5b
JP
2907 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
2908 if (WARN("SPACING",
2909 "missing space after $1 definition\n" . $herecurr) &&
2910 $fix) {
2911 $fixed[$linenr - 1] =~
2912 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
2913 }
0c73b4eb
AW
2914 }
2915
31070b5d
JP
2916# Function pointer declarations
2917# check spacing between type, funcptr, and args
2918# canonical declaration is "type (*funcptr)(args...)"
91f72e9c 2919 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
31070b5d
JP
2920 my $declare = $1;
2921 my $pre_pointer_space = $2;
2922 my $post_pointer_space = $3;
2923 my $funcname = $4;
2924 my $post_funcname_space = $5;
2925 my $pre_args_space = $6;
2926
91f72e9c
JP
2927# the $Declare variable will capture all spaces after the type
2928# so check it for a missing trailing missing space but pointer return types
2929# don't need a space so don't warn for those.
2930 my $post_declare_space = "";
2931 if ($declare =~ /(\s+)$/) {
2932 $post_declare_space = $1;
2933 $declare = rtrim($declare);
2934 }
2935 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
31070b5d
JP
2936 WARN("SPACING",
2937 "missing space after return type\n" . $herecurr);
91f72e9c 2938 $post_declare_space = " ";
31070b5d
JP
2939 }
2940
2941# unnecessary space "type (*funcptr)(args...)"
91f72e9c
JP
2942# This test is not currently implemented because these declarations are
2943# equivalent to
2944# int foo(int bar, ...)
2945# and this is form shouldn't/doesn't generate a checkpatch warning.
2946#
2947# elsif ($declare =~ /\s{2,}$/) {
2948# WARN("SPACING",
2949# "Multiple spaces after return type\n" . $herecurr);
2950# }
31070b5d
JP
2951
2952# unnecessary space "type ( *funcptr)(args...)"
2953 if (defined $pre_pointer_space &&
2954 $pre_pointer_space =~ /^\s/) {
2955 WARN("SPACING",
2956 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
2957 }
2958
2959# unnecessary space "type (* funcptr)(args...)"
2960 if (defined $post_pointer_space &&
2961 $post_pointer_space =~ /^\s/) {
2962 WARN("SPACING",
2963 "Unnecessary space before function pointer name\n" . $herecurr);
2964 }
2965
2966# unnecessary space "type (*funcptr )(args...)"
2967 if (defined $post_funcname_space &&
2968 $post_funcname_space =~ /^\s/) {
2969 WARN("SPACING",
2970 "Unnecessary space after function pointer name\n" . $herecurr);
2971 }
2972
2973# unnecessary space "type (*funcptr) (args...)"
2974 if (defined $pre_args_space &&
2975 $pre_args_space =~ /^\s/) {
2976 WARN("SPACING",
2977 "Unnecessary space before function pointer arguments\n" . $herecurr);
2978 }
2979
2980 if (show_type("SPACING") && $fix) {
2981 $fixed[$linenr - 1] =~
91f72e9c 2982 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
31070b5d
JP
2983 }
2984 }
2985
8d31cfce
AW
2986# check for spacing round square brackets; allowed:
2987# 1. with a type on the left -- int [] a;
fe2a7dbc
AW
2988# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2989# 3. inside a curly brace -- = { [0...10] = 5 }
8d31cfce
AW
2990 while ($line =~ /(.*?\s)\[/g) {
2991 my ($where, $prefix) = ($-[1], $1);
2992 if ($prefix !~ /$Type\s+$/ &&
fe2a7dbc 2993 ($where != 0 || $prefix !~ /^.\s+$/) &&
daebc534 2994 $prefix !~ /[{,]\s+$/) {
3705ce5b
JP
2995 if (ERROR("BRACKET_SPACE",
2996 "space prohibited before open square bracket '['\n" . $herecurr) &&
2997 $fix) {
2998 $fixed[$linenr - 1] =~
2999 s/^(\+.*?)\s+\[/$1\[/;
3000 }
8d31cfce
AW
3001 }
3002 }
3003
f0a594c1 3004# check for spaces between functions and their parentheses.
6c72ffaa 3005 while ($line =~ /($Ident)\s+\(/g) {
c2fdda0d 3006 my $name = $1;
773647a0
AW
3007 my $ctx_before = substr($line, 0, $-[1]);
3008 my $ctx = "$ctx_before$name";
c2fdda0d
AW
3009
3010 # Ignore those directives where spaces _are_ permitted.
773647a0
AW
3011 if ($name =~ /^(?:
3012 if|for|while|switch|return|case|
3013 volatile|__volatile__|
3014 __attribute__|format|__extension__|
3015 asm|__asm__)$/x)
3016 {
c2fdda0d
AW
3017 # cpp #define statements have non-optional spaces, ie
3018 # if there is a space between the name and the open
3019 # parenthesis it is simply not a parameter group.
c45dcabd 3020 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
773647a0
AW
3021
3022 # cpp #elif statement condition may start with a (
c45dcabd 3023 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
c2fdda0d
AW
3024
3025 # If this whole things ends with a type its most
3026 # likely a typedef for a function.
773647a0 3027 } elsif ($ctx =~ /$Type$/) {
c2fdda0d
AW
3028
3029 } else {
3705ce5b
JP
3030 if (WARN("SPACING",
3031 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3032 $fix) {
3033 $fixed[$linenr - 1] =~
3034 s/\b$name\s+\(/$name\(/;
3035 }
6c72ffaa 3036 }
f0a594c1 3037 }
9a4cad4e 3038
653d4876 3039# Check operator spacing.
0a920b5b 3040 if (!($line=~/\#\s*include/)) {
3705ce5b
JP
3041 my $fixed_line = "";
3042 my $line_fixed = 0;
3043
9c0ca6f9
AW
3044 my $ops = qr{
3045 <<=|>>=|<=|>=|==|!=|
3046 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3047 =>|->|<<|>>|<|>|=|!|~|
1f65f947 3048 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
84731623 3049 \?:|\?|:
9c0ca6f9 3050 }x;
cf655043 3051 my @elements = split(/($ops|;)/, $opline);
3705ce5b
JP
3052
3053## print("element count: <" . $#elements . ">\n");
3054## foreach my $el (@elements) {
3055## print("el: <$el>\n");
3056## }
3057
3058 my @fix_elements = ();
00df344f 3059 my $off = 0;
6c72ffaa 3060
3705ce5b
JP
3061 foreach my $el (@elements) {
3062 push(@fix_elements, substr($rawline, $off, length($el)));
3063 $off += length($el);
3064 }
3065
3066 $off = 0;
3067
6c72ffaa 3068 my $blank = copy_spacing($opline);
b34c648b 3069 my $last_after = -1;
6c72ffaa 3070
0a920b5b 3071 for (my $n = 0; $n < $#elements; $n += 2) {
3705ce5b
JP
3072
3073 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3074
3075## print("n: <$n> good: <$good>\n");
3076
4a0df2ef
AW
3077 $off += length($elements[$n]);
3078
25985edc 3079 # Pick up the preceding and succeeding characters.
773647a0
AW
3080 my $ca = substr($opline, 0, $off);
3081 my $cc = '';
3082 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3083 $cc = substr($opline, $off + length($elements[$n + 1]));
3084 }
3085 my $cb = "$ca$;$cc";
3086
4a0df2ef
AW
3087 my $a = '';
3088 $a = 'V' if ($elements[$n] ne '');
3089 $a = 'W' if ($elements[$n] =~ /\s$/);
cf655043 3090 $a = 'C' if ($elements[$n] =~ /$;$/);
4a0df2ef
AW
3091 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3092 $a = 'O' if ($elements[$n] eq '');
773647a0 3093 $a = 'E' if ($ca =~ /^\s*$/);
4a0df2ef 3094
0a920b5b 3095 my $op = $elements[$n + 1];
4a0df2ef
AW
3096
3097 my $c = '';
0a920b5b 3098 if (defined $elements[$n + 2]) {
4a0df2ef
AW
3099 $c = 'V' if ($elements[$n + 2] ne '');
3100 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
cf655043 3101 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
4a0df2ef
AW
3102 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3103 $c = 'O' if ($elements[$n + 2] eq '');
8b1b3378 3104 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
4a0df2ef
AW
3105 } else {
3106 $c = 'E';
0a920b5b
AW
3107 }
3108
4a0df2ef
AW
3109 my $ctx = "${a}x${c}";
3110
3111 my $at = "(ctx:$ctx)";
3112
6c72ffaa 3113 my $ptr = substr($blank, 0, $off) . "^";
de7d4f0e 3114 my $hereptr = "$hereline$ptr\n";
0a920b5b 3115
74048ed8 3116 # Pull out the value of this operator.
6c72ffaa 3117 my $op_type = substr($curr_values, $off + 1, 1);
0a920b5b 3118
1f65f947
AW
3119 # Get the full operator variant.
3120 my $opv = $op . substr($curr_vars, $off, 1);
3121
13214adf
AW
3122 # Ignore operators passed as parameters.
3123 if ($op_type ne 'V' &&
3124 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3125
cf655043
AW
3126# # Ignore comments
3127# } elsif ($op =~ /^$;+$/) {
13214adf 3128
d8aaf121 3129 # ; should have either the end of line or a space or \ after it
13214adf 3130 } elsif ($op eq ';') {
cf655043
AW
3131 if ($ctx !~ /.x[WEBC]/ &&
3132 $cc !~ /^\\/ && $cc !~ /^;/) {
3705ce5b
JP
3133 if (ERROR("SPACING",
3134 "space required after that '$op' $at\n" . $hereptr)) {
b34c648b 3135 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3705ce5b
JP
3136 $line_fixed = 1;
3137 }
d8aaf121
AW
3138 }
3139
3140 # // is a comment
3141 } elsif ($op eq '//') {
0a920b5b 3142
b00e4814
JP
3143 # : when part of a bitfield
3144 } elsif ($opv eq ':B') {
3145 # skip the bitfield test for now
3146
1f65f947
AW
3147 # No spaces for:
3148 # ->
b00e4814 3149 } elsif ($op eq '->') {
4a0df2ef 3150 if ($ctx =~ /Wx.|.xW/) {
3705ce5b
JP
3151 if (ERROR("SPACING",
3152 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
b34c648b 3153 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3705ce5b
JP
3154 if (defined $fix_elements[$n + 2]) {
3155 $fix_elements[$n + 2] =~ s/^\s+//;
3156 }
b34c648b 3157 $line_fixed = 1;
3705ce5b 3158 }
0a920b5b
AW
3159 }
3160
3161 # , must have a space on the right.
3162 } elsif ($op eq ',') {
cf655043 3163 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
3705ce5b
JP
3164 if (ERROR("SPACING",
3165 "space required after that '$op' $at\n" . $hereptr)) {
b34c648b 3166 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3705ce5b 3167 $line_fixed = 1;
b34c648b 3168 $last_after = $n;
3705ce5b 3169 }
0a920b5b
AW
3170 }
3171
9c0ca6f9 3172 # '*' as part of a type definition -- reported already.
74048ed8 3173 } elsif ($opv eq '*_') {
9c0ca6f9
AW
3174 #warn "'*' is part of type\n";
3175
3176 # unary operators should have a space before and
3177 # none after. May be left adjacent to another
3178 # unary operator, or a cast
3179 } elsif ($op eq '!' || $op eq '~' ||
74048ed8 3180 $opv eq '*U' || $opv eq '-U' ||
0d413866 3181 $opv eq '&U' || $opv eq '&&U') {
cf655043 3182 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
3705ce5b
JP
3183 if (ERROR("SPACING",
3184 "space required before that '$op' $at\n" . $hereptr)) {
b34c648b
JP
3185 if ($n != $last_after + 2) {
3186 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3187 $line_fixed = 1;
3188 }
3705ce5b 3189 }
0a920b5b 3190 }
a3340b35 3191 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
171ae1a4
AW
3192 # A unary '*' may be const
3193
3194 } elsif ($ctx =~ /.xW/) {
3705ce5b
JP
3195 if (ERROR("SPACING",
3196 "space prohibited after that '$op' $at\n" . $hereptr)) {
b34c648b 3197 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
3705ce5b
JP
3198 if (defined $fix_elements[$n + 2]) {
3199 $fix_elements[$n + 2] =~ s/^\s+//;
3200 }
b34c648b 3201 $line_fixed = 1;
3705ce5b 3202 }
0a920b5b
AW
3203 }
3204
3205 # unary ++ and unary -- are allowed no space on one side.
3206 } elsif ($op eq '++' or $op eq '--') {
773647a0 3207 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
3705ce5b
JP
3208 if (ERROR("SPACING",
3209 "space required one side of that '$op' $at\n" . $hereptr)) {
b34c648b 3210 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3705ce5b
JP
3211 $line_fixed = 1;
3212 }
773647a0
AW
3213 }
3214 if ($ctx =~ /Wx[BE]/ ||
3215 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
3705ce5b
JP
3216 if (ERROR("SPACING",
3217 "space prohibited before that '$op' $at\n" . $hereptr)) {
b34c648b 3218 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3705ce5b
JP
3219 $line_fixed = 1;
3220 }
0a920b5b 3221 }
773647a0 3222 if ($ctx =~ /ExW/) {
3705ce5b
JP
3223 if (ERROR("SPACING",
3224 "space prohibited after that '$op' $at\n" . $hereptr)) {
b34c648b 3225 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3705ce5b
JP
3226 if (defined $fix_elements[$n + 2]) {
3227 $fix_elements[$n + 2] =~ s/^\s+//;
3228 }
b34c648b 3229 $line_fixed = 1;
3705ce5b 3230 }
653d4876 3231 }
0a920b5b 3232
0a920b5b 3233 # << and >> may either have or not have spaces both sides
9c0ca6f9
AW
3234 } elsif ($op eq '<<' or $op eq '>>' or
3235 $op eq '&' or $op eq '^' or $op eq '|' or
3236 $op eq '+' or $op eq '-' or
c2fdda0d
AW
3237 $op eq '*' or $op eq '/' or
3238 $op eq '%')
0a920b5b 3239 {
773647a0 3240 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
3705ce5b
JP
3241 if (ERROR("SPACING",
3242 "need consistent spacing around '$op' $at\n" . $hereptr)) {
b34c648b
JP
3243 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3244 if (defined $fix_elements[$n + 2]) {
3245 $fix_elements[$n + 2] =~ s/^\s+//;
3246 }
3705ce5b
JP
3247 $line_fixed = 1;
3248 }
0a920b5b
AW
3249 }
3250
1f65f947
AW
3251 # A colon needs no spaces before when it is
3252 # terminating a case value or a label.
3253 } elsif ($opv eq ':C' || $opv eq ':L') {
3254 if ($ctx =~ /Wx./) {
3705ce5b
JP
3255 if (ERROR("SPACING",
3256 "space prohibited before that '$op' $at\n" . $hereptr)) {
b34c648b 3257 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3705ce5b
JP
3258 $line_fixed = 1;
3259 }
1f65f947
AW
3260 }
3261
0a920b5b 3262 # All the others need spaces both sides.
cf655043 3263 } elsif ($ctx !~ /[EWC]x[CWE]/) {
1f65f947
AW
3264 my $ok = 0;
3265
22f2a2ef 3266 # Ignore email addresses <foo@bar>
1f65f947
AW
3267 if (($op eq '<' &&
3268 $cc =~ /^\S+\@\S+>/) ||
3269 ($op eq '>' &&
3270 $ca =~ /<\S+\@\S+$/))
3271 {
3272 $ok = 1;
3273 }
3274
84731623 3275 # messages are ERROR, but ?: are CHK
1f65f947 3276 if ($ok == 0) {
84731623
JP
3277 my $msg_type = \&ERROR;
3278 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3279
3280 if (&{$msg_type}("SPACING",
3281 "spaces required around that '$op' $at\n" . $hereptr)) {
b34c648b
JP
3282 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3283 if (defined $fix_elements[$n + 2]) {
3284 $fix_elements[$n + 2] =~ s/^\s+//;
3285 }
3705ce5b
JP
3286 $line_fixed = 1;
3287 }
22f2a2ef 3288 }
0a920b5b 3289 }
4a0df2ef 3290 $off += length($elements[$n + 1]);
3705ce5b
JP
3291
3292## print("n: <$n> GOOD: <$good>\n");
3293
3294 $fixed_line = $fixed_line . $good;
3295 }
3296
3297 if (($#elements % 2) == 0) {
3298 $fixed_line = $fixed_line . $fix_elements[$#elements];
0a920b5b 3299 }
3705ce5b
JP
3300
3301 if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) {
3302 $fixed[$linenr - 1] = $fixed_line;
3303 }
3304
3305
0a920b5b
AW
3306 }
3307
786b6326 3308# check for whitespace before a non-naked semicolon
d2e248e7 3309 if ($line =~ /^\+.*\S\s+;\s*$/) {
786b6326
JP
3310 if (WARN("SPACING",
3311 "space prohibited before semicolon\n" . $herecurr) &&
3312 $fix) {
3313 1 while $fixed[$linenr - 1] =~
3314 s/^(\+.*\S)\s+;/$1;/;
3315 }
3316 }
3317
f0a594c1
AW
3318# check for multiple assignments
3319 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
000d1cc1
JP
3320 CHK("MULTIPLE_ASSIGNMENTS",
3321 "multiple assignments should be avoided\n" . $herecurr);
f0a594c1
AW
3322 }
3323
22f2a2ef
AW
3324## # check for multiple declarations, allowing for a function declaration
3325## # continuation.
3326## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3327## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3328##
3329## # Remove any bracketed sections to ensure we do not
3330## # falsly report the parameters of functions.
3331## my $ln = $line;
3332## while ($ln =~ s/\([^\(\)]*\)//g) {
3333## }
3334## if ($ln =~ /,/) {
000d1cc1
JP
3335## WARN("MULTIPLE_DECLARATION",
3336## "declaring multiple variables together should be avoided\n" . $herecurr);
22f2a2ef
AW
3337## }
3338## }
f0a594c1 3339
0a920b5b 3340#need space before brace following if, while, etc
22f2a2ef
AW
3341 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3342 $line =~ /do{/) {
3705ce5b
JP
3343 if (ERROR("SPACING",
3344 "space required before the open brace '{'\n" . $herecurr) &&
3345 $fix) {
d5e616fc 3346 $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/;
3705ce5b 3347 }
de7d4f0e
AW
3348 }
3349
c4a62ef9
JP
3350## # check for blank lines before declarations
3351## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3352## $prevrawline =~ /^.\s*$/) {
3353## WARN("SPACING",
3354## "No blank lines before declarations\n" . $hereprev);
3355## }
3356##
3357
de7d4f0e
AW
3358# closing brace should have a space following it when it has anything
3359# on the line
3360 if ($line =~ /}(?!(?:,|;|\)))\S/) {
d5e616fc
JP
3361 if (ERROR("SPACING",
3362 "space required after that close brace '}'\n" . $herecurr) &&
3363 $fix) {
3364 $fixed[$linenr - 1] =~
3365 s/}((?!(?:,|;|\)))\S)/} $1/;
3366 }
0a920b5b
AW
3367 }
3368
22f2a2ef
AW
3369# check spacing on square brackets
3370 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
3705ce5b
JP
3371 if (ERROR("SPACING",
3372 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3373 $fix) {
3374 $fixed[$linenr - 1] =~
3375 s/\[\s+/\[/;
3376 }
22f2a2ef
AW
3377 }
3378 if ($line =~ /\s\]/) {
3705ce5b
JP
3379 if (ERROR("SPACING",
3380 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3381 $fix) {
3382 $fixed[$linenr - 1] =~
3383 s/\s+\]/\]/;
3384 }
22f2a2ef
AW
3385 }
3386
c45dcabd 3387# check spacing on parentheses
9c0ca6f9
AW
3388 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3389 $line !~ /for\s*\(\s+;/) {
3705ce5b
JP
3390 if (ERROR("SPACING",
3391 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3392 $fix) {
3393 $fixed[$linenr - 1] =~
3394 s/\(\s+/\(/;
3395 }
22f2a2ef 3396 }
13214adf 3397 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
c45dcabd
AW
3398 $line !~ /for\s*\(.*;\s+\)/ &&
3399 $line !~ /:\s+\)/) {
3705ce5b
JP
3400 if (ERROR("SPACING",
3401 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3402 $fix) {
3403 $fixed[$linenr - 1] =~
3404 s/\s+\)/\)/;
3405 }
22f2a2ef
AW
3406 }
3407
0a920b5b 3408#goto labels aren't indented, allow a single space however
4a0df2ef 3409 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
0a920b5b 3410 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
3705ce5b
JP
3411 if (WARN("INDENTED_LABEL",
3412 "labels should not be indented\n" . $herecurr) &&
3413 $fix) {
3414 $fixed[$linenr - 1] =~
3415 s/^(.)\s+/$1/;
3416 }
0a920b5b
AW
3417 }
3418
5b9553ab 3419# return is not a function
507e5141 3420 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
c45dcabd 3421 my $spacing = $1;
507e5141 3422 if ($^V && $^V ge 5.10.0 &&
5b9553ab
JP
3423 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3424 my $value = $1;
3425 $value = deparenthesize($value);
3426 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3427 ERROR("RETURN_PARENTHESES",
3428 "return is not a function, parentheses are not required\n" . $herecurr);
3429 }
c45dcabd 3430 } elsif ($spacing !~ /\s+/) {
000d1cc1
JP
3431 ERROR("SPACING",
3432 "space required before the open parenthesis '('\n" . $herecurr);
c45dcabd
AW
3433 }
3434 }
507e5141 3435
189248d8
JP
3436# if statements using unnecessary parentheses - ie: if ((foo == bar))
3437 if ($^V && $^V ge 5.10.0 &&
3438 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3439 my $openparens = $1;
3440 my $count = $openparens =~ tr@\(@\(@;
3441 my $msg = "";
3442 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3443 my $comp = $4; #Not $1 because of $LvalOrFunc
3444 $msg = " - maybe == should be = ?" if ($comp eq "==");
3445 WARN("UNNECESSARY_PARENTHESES",
3446 "Unnecessary parentheses$msg\n" . $herecurr);
3447 }
3448 }
3449
53a3c448
AW
3450# Return of what appears to be an errno should normally be -'ve
3451 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3452 my $name = $1;
3453 if ($name ne 'EOF' && $name ne 'ERROR') {
000d1cc1
JP
3454 WARN("USE_NEGATIVE_ERRNO",
3455 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
53a3c448
AW
3456 }
3457 }
c45dcabd 3458
0a920b5b 3459# Need a space before open parenthesis after if, while etc
3705ce5b
JP
3460 if ($line =~ /\b(if|while|for|switch)\(/) {
3461 if (ERROR("SPACING",
3462 "space required before the open parenthesis '('\n" . $herecurr) &&
3463 $fix) {
3464 $fixed[$linenr - 1] =~
3465 s/\b(if|while|for|switch)\(/$1 \(/;
3466 }
0a920b5b
AW
3467 }
3468
f5fe35dd
AW
3469# Check for illegal assignment in if conditional -- and check for trailing
3470# statements after the conditional.
170d3a22 3471 if ($line =~ /do\s*(?!{)/) {
3e469cdc
AW
3472 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3473 ctx_statement_block($linenr, $realcnt, 0)
3474 if (!defined $stat);
170d3a22
AW
3475 my ($stat_next) = ctx_statement_block($line_nr_next,
3476 $remain_next, $off_next);
3477 $stat_next =~ s/\n./\n /g;
3478 ##print "stat<$stat> stat_next<$stat_next>\n";
3479
3480 if ($stat_next =~ /^\s*while\b/) {
3481 # If the statement carries leading newlines,
3482 # then count those as offsets.
3483 my ($whitespace) =
3484 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3485 my $offset =
3486 statement_rawlines($whitespace) - 1;
3487
3488 $suppress_whiletrailers{$line_nr_next +
3489 $offset} = 1;
3490 }
3491 }
3492 if (!defined $suppress_whiletrailers{$linenr} &&
c11230f4 3493 defined($stat) && defined($cond) &&
170d3a22 3494 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
171ae1a4 3495 my ($s, $c) = ($stat, $cond);
8905a67c 3496
b53c8e10 3497 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
000d1cc1
JP
3498 ERROR("ASSIGN_IN_IF",
3499 "do not use assignment in if condition\n" . $herecurr);
8905a67c
AW
3500 }
3501
3502 # Find out what is on the end of the line after the
3503 # conditional.
773647a0 3504 substr($s, 0, length($c), '');
8905a67c 3505 $s =~ s/\n.*//g;
13214adf 3506 $s =~ s/$;//g; # Remove any comments
53210168
AW
3507 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3508 $c !~ /}\s*while\s*/)
773647a0 3509 {
bb44ad39
AW
3510 # Find out how long the conditional actually is.
3511 my @newlines = ($c =~ /\n/gs);
3512 my $cond_lines = 1 + $#newlines;
42bdf74c 3513 my $stat_real = '';
bb44ad39 3514
42bdf74c
HS
3515 $stat_real = raw_line($linenr, $cond_lines)
3516 . "\n" if ($cond_lines);
bb44ad39
AW
3517 if (defined($stat_real) && $cond_lines > 1) {
3518 $stat_real = "[...]\n$stat_real";
3519 }
3520
000d1cc1
JP
3521 ERROR("TRAILING_STATEMENTS",
3522 "trailing statements should be on next line\n" . $herecurr . $stat_real);
8905a67c
AW
3523 }
3524 }
3525
13214adf
AW
3526# Check for bitwise tests written as boolean
3527 if ($line =~ /
3528 (?:
3529 (?:\[|\(|\&\&|\|\|)
3530 \s*0[xX][0-9]+\s*
3531 (?:\&\&|\|\|)
3532 |
3533 (?:\&\&|\|\|)
3534 \s*0[xX][0-9]+\s*
3535 (?:\&\&|\|\||\)|\])
3536 )/x)
3537 {
000d1cc1
JP
3538 WARN("HEXADECIMAL_BOOLEAN_TEST",
3539 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
13214adf
AW
3540 }
3541
8905a67c 3542# if and else should not have general statements after it
13214adf
AW
3543 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3544 my $s = $1;
3545 $s =~ s/$;//g; # Remove any comments
3546 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
000d1cc1
JP
3547 ERROR("TRAILING_STATEMENTS",
3548 "trailing statements should be on next line\n" . $herecurr);
13214adf 3549 }
0a920b5b 3550 }
39667782
AW
3551# if should not continue a brace
3552 if ($line =~ /}\s*if\b/) {
000d1cc1
JP
3553 ERROR("TRAILING_STATEMENTS",
3554 "trailing statements should be on next line\n" .
39667782
AW
3555 $herecurr);
3556 }
a1080bf8
AW
3557# case and default should not have general statements after them
3558 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3559 $line !~ /\G(?:
3fef12d6 3560 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
a1080bf8
AW
3561 \s*return\s+
3562 )/xg)
3563 {
000d1cc1
JP
3564 ERROR("TRAILING_STATEMENTS",
3565 "trailing statements should be on next line\n" . $herecurr);
a1080bf8 3566 }
0a920b5b
AW
3567
3568 # Check for }<nl>else {, these must be at the same
3569 # indent level to be relevant to each other.
3570 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
3571 $previndent == $indent) {
000d1cc1
JP
3572 ERROR("ELSE_AFTER_BRACE",
3573 "else should follow close brace '}'\n" . $hereprev);
0a920b5b
AW
3574 }
3575
c2fdda0d
AW
3576 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
3577 $previndent == $indent) {
3578 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3579
3580 # Find out what is on the end of the line after the
3581 # conditional.
773647a0 3582 substr($s, 0, length($c), '');
c2fdda0d
AW
3583 $s =~ s/\n.*//g;
3584
3585 if ($s =~ /^\s*;/) {
000d1cc1
JP
3586 ERROR("WHILE_AFTER_BRACE",
3587 "while should follow close brace '}'\n" . $hereprev);
c2fdda0d
AW
3588 }
3589 }
3590
95e2c602 3591#Specific variable tests
323c1260
JP
3592 while ($line =~ m{($Constant|$Lval)}g) {
3593 my $var = $1;
95e2c602
JP
3594
3595#gcc binary extension
3596 if ($var =~ /^$Binary$/) {
d5e616fc
JP
3597 if (WARN("GCC_BINARY_CONSTANT",
3598 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3599 $fix) {
3600 my $hexval = sprintf("0x%x", oct($var));
3601 $fixed[$linenr - 1] =~
3602 s/\b$var\b/$hexval/;
3603 }
95e2c602
JP
3604 }
3605
3606#CamelCase
807bd26c 3607 if ($var !~ /^$Constant$/ &&
be79794b 3608 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
22735ce8 3609#Ignore Page<foo> variants
807bd26c 3610 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
22735ce8 3611#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
3445686a 3612 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
7e781f67
JP
3613 while ($var =~ m{($Ident)}g) {
3614 my $word = $1;
3615 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
d8b07710
JP
3616 if ($check) {
3617 seed_camelcase_includes();
3618 if (!$file && !$camelcase_file_seeded) {
3619 seed_camelcase_file($realfile);
3620 $camelcase_file_seeded = 1;
3621 }
3622 }
7e781f67
JP
3623 if (!defined $camelcase{$word}) {
3624 $camelcase{$word} = 1;
3625 CHK("CAMELCASE",
3626 "Avoid CamelCase: <$word>\n" . $herecurr);
3627 }
3445686a 3628 }
323c1260
JP
3629 }
3630 }
0a920b5b
AW
3631
3632#no spaces allowed after \ in define
d5e616fc
JP
3633 if ($line =~ /\#\s*define.*\\\s+$/) {
3634 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
3635 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
3636 $fix) {
3637 $fixed[$linenr - 1] =~ s/\s+$//;
3638 }
0a920b5b
AW
3639 }
3640
653d4876 3641#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
c45dcabd 3642 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
e09dec48
AW
3643 my $file = "$1.h";
3644 my $checkfile = "include/linux/$file";
3645 if (-f "$root/$checkfile" &&
3646 $realfile ne $checkfile &&
7840a94c 3647 $1 !~ /$allowed_asm_includes/)
c45dcabd 3648 {
e09dec48 3649 if ($realfile =~ m{^arch/}) {
000d1cc1
JP
3650 CHK("ARCH_INCLUDE_LINUX",
3651 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
e09dec48 3652 } else {
000d1cc1
JP
3653 WARN("INCLUDE_LINUX",
3654 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
e09dec48 3655 }
0a920b5b
AW
3656 }
3657 }
3658
653d4876
AW
3659# multi-statement macros should be enclosed in a do while loop, grab the
3660# first statement and ensure its the whole macro if its not enclosed
cf655043 3661# in a known good container
b8f96a31
AW
3662 if ($realfile !~ m@/vmlinux.lds.h$@ &&
3663 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
d8aaf121
AW
3664 my $ln = $linenr;
3665 my $cnt = $realcnt;
c45dcabd
AW
3666 my ($off, $dstat, $dcond, $rest);
3667 my $ctx = '';
c45dcabd 3668 ($dstat, $dcond, $ln, $cnt, $off) =
f74bd194
AW
3669 ctx_statement_block($linenr, $realcnt, 0);
3670 $ctx = $dstat;
c45dcabd 3671 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
a3bb97a7 3672 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
c45dcabd 3673
f74bd194 3674 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
292f1a9b 3675 $dstat =~ s/$;//g;
c45dcabd
AW
3676 $dstat =~ s/\\\n.//g;
3677 $dstat =~ s/^\s*//s;
3678 $dstat =~ s/\s*$//s;
de7d4f0e 3679
c45dcabd 3680 # Flatten any parentheses and braces
bf30d6ed
AW
3681 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
3682 $dstat =~ s/\{[^\{\}]*\}/1/ ||
c81769fd 3683 $dstat =~ s/\[[^\[\]]*\]/1/)
bf30d6ed 3684 {
de7d4f0e 3685 }
d8aaf121 3686
e45bab8e
AW
3687 # Flatten any obvious string concatentation.
3688 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3689 $dstat =~ s/$Ident\s*("X*")/$1/)
3690 {
3691 }
3692
c45dcabd
AW
3693 my $exceptions = qr{
3694 $Declare|
3695 module_param_named|
a0a0a7a9 3696 MODULE_PARM_DESC|
c45dcabd
AW
3697 DECLARE_PER_CPU|
3698 DEFINE_PER_CPU|
383099fd 3699 __typeof__\(|
22fd2d3e
SS
3700 union|
3701 struct|
ea71a0a0
AW
3702 \.$Ident\s*=\s*|
3703 ^\"|\"$
c45dcabd 3704 }x;
5eaa20b9 3705 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
f74bd194
AW
3706 if ($dstat ne '' &&
3707 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
3708 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
3cc4b1c3 3709 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
b9df76ac 3710 $dstat !~ /^'X'$/ && # character constants
f74bd194
AW
3711 $dstat !~ /$exceptions/ &&
3712 $dstat !~ /^\.$Ident\s*=/ && # .foo =
e942e2c3 3713 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
72f115f9 3714 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
f74bd194
AW
3715 $dstat !~ /^for\s*$Constant$/ && # for (...)
3716 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
3717 $dstat !~ /^do\s*{/ && # do {...
f95a7e6a
JP
3718 $dstat !~ /^\({/ && # ({...
3719 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
f74bd194
AW
3720 {
3721 $ctx =~ s/\n*$//;
3722 my $herectx = $here . "\n";
3723 my $cnt = statement_rawlines($ctx);
3724
3725 for (my $n = 0; $n < $cnt; $n++) {
3726 $herectx .= raw_line($linenr, $n) . "\n";
c45dcabd
AW
3727 }
3728
f74bd194
AW
3729 if ($dstat =~ /;/) {
3730 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3731 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3732 } else {
000d1cc1 3733 ERROR("COMPLEX_MACRO",
f74bd194 3734 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
d8aaf121 3735 }
653d4876 3736 }
5023d347 3737
481eb486 3738# check for line continuations outside of #defines, preprocessor #, and asm
5023d347
JP
3739
3740 } else {
3741 if ($prevline !~ /^..*\\$/ &&
481eb486
JP
3742 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3743 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
5023d347
JP
3744 $line =~ /^\+.*\\$/) {
3745 WARN("LINE_CONTINUATIONS",
3746 "Avoid unnecessary line continuations\n" . $herecurr);
3747 }
0a920b5b
AW
3748 }
3749
b13edf7f
JP
3750# do {} while (0) macro tests:
3751# single-statement macros do not need to be enclosed in do while (0) loop,
3752# macro should not end with a semicolon
3753 if ($^V && $^V ge 5.10.0 &&
3754 $realfile !~ m@/vmlinux.lds.h$@ &&
3755 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3756 my $ln = $linenr;
3757 my $cnt = $realcnt;
3758 my ($off, $dstat, $dcond, $rest);
3759 my $ctx = '';
3760 ($dstat, $dcond, $ln, $cnt, $off) =
3761 ctx_statement_block($linenr, $realcnt, 0);
3762 $ctx = $dstat;
3763
3764 $dstat =~ s/\\\n.//g;
3765
3766 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3767 my $stmts = $2;
3768 my $semis = $3;
3769
3770 $ctx =~ s/\n*$//;
3771 my $cnt = statement_rawlines($ctx);
3772 my $herectx = $here . "\n";
3773
3774 for (my $n = 0; $n < $cnt; $n++) {
3775 $herectx .= raw_line($linenr, $n) . "\n";
3776 }
3777
ac8e97f8
JP
3778 if (($stmts =~ tr/;/;/) == 1 &&
3779 $stmts !~ /^\s*(if|while|for|switch)\b/) {
b13edf7f
JP
3780 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3781 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3782 }
3783 if (defined $semis && $semis ne "") {
3784 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3785 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3786 }
3787 }
3788 }
3789
080ba929
MF
3790# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3791# all assignments may have only one of the following with an assignment:
3792# .
3793# ALIGN(...)
3794# VMLINUX_SYMBOL(...)
3795 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
000d1cc1
JP
3796 WARN("MISSING_VMLINUX_SYMBOL",
3797 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
080ba929
MF
3798 }
3799
f0a594c1 3800# check for redundant bracing round if etc
13214adf
AW
3801 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3802 my ($level, $endln, @chunks) =
cf655043 3803 ctx_statement_full($linenr, $realcnt, 1);
13214adf 3804 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
cf655043
AW
3805 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3806 if ($#chunks > 0 && $level == 0) {
aad4f614
JP
3807 my @allowed = ();
3808 my $allow = 0;
13214adf 3809 my $seen = 0;
773647a0 3810 my $herectx = $here . "\n";
cf655043 3811 my $ln = $linenr - 1;
13214adf
AW
3812 for my $chunk (@chunks) {
3813 my ($cond, $block) = @{$chunk};
3814
773647a0
AW
3815 # If the condition carries leading newlines, then count those as offsets.
3816 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3817 my $offset = statement_rawlines($whitespace) - 1;
3818
aad4f614 3819 $allowed[$allow] = 0;
773647a0
AW
3820 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3821
3822 # We have looked at and allowed this specific line.
3823 $suppress_ifbraces{$ln + $offset} = 1;
3824
3825 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
cf655043
AW
3826 $ln += statement_rawlines($block) - 1;
3827
773647a0 3828 substr($block, 0, length($cond), '');
13214adf
AW
3829
3830 $seen++ if ($block =~ /^\s*{/);
3831
aad4f614 3832 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
cf655043
AW
3833 if (statement_lines($cond) > 1) {
3834 #print "APW: ALLOWED: cond<$cond>\n";
aad4f614 3835 $allowed[$allow] = 1;
13214adf
AW
3836 }
3837 if ($block =~/\b(?:if|for|while)\b/) {
cf655043 3838 #print "APW: ALLOWED: block<$block>\n";
aad4f614 3839 $allowed[$allow] = 1;
13214adf 3840 }
cf655043
AW
3841 if (statement_block_size($block) > 1) {
3842 #print "APW: ALLOWED: lines block<$block>\n";
aad4f614 3843 $allowed[$allow] = 1;
13214adf 3844 }
aad4f614 3845 $allow++;
13214adf 3846 }
aad4f614
JP
3847 if ($seen) {
3848 my $sum_allowed = 0;
3849 foreach (@allowed) {
3850 $sum_allowed += $_;
3851 }
3852 if ($sum_allowed == 0) {
3853 WARN("BRACES",
3854 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3855 } elsif ($sum_allowed != $allow &&
3856 $seen != $allow) {
3857 CHK("BRACES",
3858 "braces {} should be used on all arms of this statement\n" . $herectx);
3859 }
13214adf
AW
3860 }
3861 }
3862 }
773647a0 3863 if (!defined $suppress_ifbraces{$linenr - 1} &&
13214adf 3864 $line =~ /\b(if|while|for|else)\b/) {
cf655043
AW
3865 my $allowed = 0;
3866
3867 # Check the pre-context.
3868 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3869 #print "APW: ALLOWED: pre<$1>\n";
3870 $allowed = 1;
3871 }
773647a0
AW
3872
3873 my ($level, $endln, @chunks) =
3874 ctx_statement_full($linenr, $realcnt, $-[0]);
3875
cf655043
AW
3876 # Check the condition.
3877 my ($cond, $block) = @{$chunks[0]};
773647a0 3878 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
cf655043 3879 if (defined $cond) {
773647a0 3880 substr($block, 0, length($cond), '');
cf655043
AW
3881 }
3882 if (statement_lines($cond) > 1) {
3883 #print "APW: ALLOWED: cond<$cond>\n";
3884 $allowed = 1;
3885 }
3886 if ($block =~/\b(?:if|for|while)\b/) {
3887 #print "APW: ALLOWED: block<$block>\n";
3888 $allowed = 1;
3889 }
3890 if (statement_block_size($block) > 1) {
3891 #print "APW: ALLOWED: lines block<$block>\n";
3892 $allowed = 1;
3893 }
3894 # Check the post-context.
3895 if (defined $chunks[1]) {
3896 my ($cond, $block) = @{$chunks[1]};
3897 if (defined $cond) {
773647a0 3898 substr($block, 0, length($cond), '');
cf655043
AW
3899 }
3900 if ($block =~ /^\s*\{/) {
3901 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3902 $allowed = 1;
3903 }
3904 }
3905 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
69932487 3906 my $herectx = $here . "\n";
f055663c 3907 my $cnt = statement_rawlines($block);
cf655043 3908
f055663c 3909 for (my $n = 0; $n < $cnt; $n++) {
69932487 3910 $herectx .= raw_line($linenr, $n) . "\n";
f0a594c1 3911 }
cf655043 3912
000d1cc1
JP
3913 WARN("BRACES",
3914 "braces {} are not necessary for single statement blocks\n" . $herectx);
f0a594c1
AW
3915 }
3916 }
3917
0979ae66 3918# check for unnecessary blank lines around braces
77b9a53a 3919 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
0979ae66
JP
3920 CHK("BRACES",
3921 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
3922 }
77b9a53a 3923 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
0979ae66
JP
3924 CHK("BRACES",
3925 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
3926 }
3927
4a0df2ef 3928# no volatiles please
6c72ffaa
AW
3929 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3930 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
000d1cc1
JP
3931 WARN("VOLATILE",
3932 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4a0df2ef
AW
3933 }
3934
00df344f 3935# warn about #if 0
c45dcabd 3936 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
000d1cc1
JP
3937 CHK("REDUNDANT_CODE",
3938 "if this code is redundant consider removing it\n" .
de7d4f0e 3939 $herecurr);
4a0df2ef
AW
3940 }
3941
03df4b51
AW
3942# check for needless "if (<foo>) fn(<foo>)" uses
3943 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
3944 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
3945 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
3946 WARN('NEEDLESS_IF',
3947 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
4c432a8f
GKH
3948 }
3949 }
f0a594c1 3950
8716de38
JP
3951# check for bad placement of section $InitAttribute (e.g.: __initdata)
3952 if ($line =~ /(\b$InitAttribute\b)/) {
3953 my $attr = $1;
3954 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
3955 my $ptr = $1;
3956 my $var = $2;
3957 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
3958 ERROR("MISPLACED_INIT",
3959 "$attr should be placed after $var\n" . $herecurr)) ||
3960 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
3961 WARN("MISPLACED_INIT",
3962 "$attr should be placed after $var\n" . $herecurr))) &&
3963 $fix) {
3964 $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;
3965 }
3966 }
3967 }
3968
e970b884
JP
3969# check for $InitAttributeData (ie: __initdata) with const
3970 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
3971 my $attr = $1;
3972 $attr =~ /($InitAttributePrefix)(.*)/;
3973 my $attr_prefix = $1;
3974 my $attr_type = $2;
3975 if (ERROR("INIT_ATTRIBUTE",
3976 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
3977 $fix) {
3978 $fixed[$linenr - 1] =~
3979 s/$InitAttributeData/${attr_prefix}initconst/;
3980 }
3981 }
3982
3983# check for $InitAttributeConst (ie: __initconst) without const
3984 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
3985 my $attr = $1;
3986 if (ERROR("INIT_ATTRIBUTE",
3987 "Use of $attr requires a separate use of const\n" . $herecurr) &&
3988 $fix) {
3989 my $lead = $fixed[$linenr - 1] =~
3990 /(^\+\s*(?:static\s+))/;
3991 $lead = rtrim($1);
3992 $lead = "$lead " if ($lead !~ /^\+$/);
3993 $lead = "${lead}const ";
3994 $fixed[$linenr - 1] =~ s/(^\+\s*(?:static\s+))/$lead/;
3995 }
3996 }
3997
fbdb8138
JP
3998# don't use __constant_<foo> functions outside of include/uapi/
3999 if ($realfile !~ m@^include/uapi/@ &&
4000 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4001 my $constant_func = $1;
4002 my $func = $constant_func;
4003 $func =~ s/^__constant_//;
4004 if (WARN("CONSTANT_CONVERSION",
4005 "$constant_func should be $func\n" . $herecurr) &&
4006 $fix) {
4007 $fixed[$linenr - 1] =~ s/\b$constant_func\b/$func/g;
4008 }
4009 }
4010
1a15a250 4011# prefer usleep_range over udelay
37581c28 4012 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
43c1d77c 4013 my $delay = $1;
1a15a250 4014 # ignore udelay's < 10, however
43c1d77c 4015 if (! ($delay < 10) ) {
000d1cc1 4016 CHK("USLEEP_RANGE",
43c1d77c
JP
4017 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4018 }
4019 if ($delay > 2000) {
4020 WARN("LONG_UDELAY",
4021 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
1a15a250
PP
4022 }
4023 }
4024
09ef8725
PP
4025# warn about unexpectedly long msleep's
4026 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4027 if ($1 < 20) {
000d1cc1 4028 WARN("MSLEEP",
43c1d77c 4029 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
09ef8725
PP
4030 }
4031 }
4032
36ec1939
JP
4033# check for comparisons of jiffies
4034 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4035 WARN("JIFFIES_COMPARISON",
4036 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4037 }
4038
9d7a34a5
JP
4039# check for comparisons of get_jiffies_64()
4040 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4041 WARN("JIFFIES_COMPARISON",
4042 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4043 }
4044
00df344f 4045# warn about #ifdefs in C files
c45dcabd 4046# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
00df344f
AW
4047# print "#ifdef in C files should be avoided\n";
4048# print "$herecurr";
4049# $clean = 0;
4050# }
4051
22f2a2ef 4052# warn about spacing in #ifdefs
c45dcabd 4053 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
3705ce5b
JP
4054 if (ERROR("SPACING",
4055 "exactly one space required after that #$1\n" . $herecurr) &&
4056 $fix) {
4057 $fixed[$linenr - 1] =~
4058 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4059 }
4060
22f2a2ef
AW
4061 }
4062
4a0df2ef 4063# check for spinlock_t definitions without a comment.
171ae1a4
AW
4064 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4065 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
4a0df2ef
AW
4066 my $which = $1;
4067 if (!ctx_has_comment($first_line, $linenr)) {
000d1cc1
JP
4068 CHK("UNCOMMENTED_DEFINITION",
4069 "$1 definition without comment\n" . $herecurr);
4a0df2ef
AW
4070 }
4071 }
4072# check for memory barriers without a comment.
4073 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4074 if (!ctx_has_comment($first_line, $linenr)) {
c1fd7bb9
JP
4075 WARN("MEMORY_BARRIER",
4076 "memory barrier without comment\n" . $herecurr);
4a0df2ef
AW
4077 }
4078 }
4079# check of hardware specific defines
c45dcabd 4080 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
000d1cc1
JP
4081 CHK("ARCH_DEFINES",
4082 "architecture specific defines should be avoided\n" . $herecurr);
0a920b5b 4083 }
653d4876 4084
d4977c78
TK
4085# Check that the storage class is at the beginning of a declaration
4086 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
000d1cc1
JP
4087 WARN("STORAGE_CLASS",
4088 "storage class should be at the beginning of the declaration\n" . $herecurr)
d4977c78
TK
4089 }
4090
de7d4f0e
AW
4091# check the location of the inline attribute, that it is between
4092# storage class and type.
9c0ca6f9
AW
4093 if ($line =~ /\b$Type\s+$Inline\b/ ||
4094 $line =~ /\b$Inline\s+$Storage\b/) {
000d1cc1
JP
4095 ERROR("INLINE_LOCATION",
4096 "inline keyword should sit between storage class and type\n" . $herecurr);
de7d4f0e
AW
4097 }
4098
8905a67c 4099# Check for __inline__ and __inline, prefer inline
2b7ab453
JP
4100 if ($realfile !~ m@\binclude/uapi/@ &&
4101 $line =~ /\b(__inline__|__inline)\b/) {
d5e616fc
JP
4102 if (WARN("INLINE",
4103 "plain inline is preferred over $1\n" . $herecurr) &&
4104 $fix) {
4105 $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/;
4106
4107 }
8905a67c
AW
4108 }
4109
3d130fd0 4110# Check for __attribute__ packed, prefer __packed
2b7ab453
JP
4111 if ($realfile !~ m@\binclude/uapi/@ &&
4112 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
000d1cc1
JP
4113 WARN("PREFER_PACKED",
4114 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
3d130fd0
JP
4115 }
4116
39b7e287 4117# Check for __attribute__ aligned, prefer __aligned
2b7ab453
JP
4118 if ($realfile !~ m@\binclude/uapi/@ &&
4119 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
000d1cc1
JP
4120 WARN("PREFER_ALIGNED",
4121 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
39b7e287
JP
4122 }
4123
5f14d3bd 4124# Check for __attribute__ format(printf, prefer __printf
2b7ab453
JP
4125 if ($realfile !~ m@\binclude/uapi/@ &&
4126 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
d5e616fc
JP
4127 if (WARN("PREFER_PRINTF",
4128 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4129 $fix) {
4130 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4131
4132 }
5f14d3bd
JP
4133 }
4134
6061d949 4135# Check for __attribute__ format(scanf, prefer __scanf
2b7ab453
JP
4136 if ($realfile !~ m@\binclude/uapi/@ &&
4137 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
d5e616fc
JP
4138 if (WARN("PREFER_SCANF",
4139 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4140 $fix) {
4141 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4142 }
6061d949
JP
4143 }
4144
8f53a9b8
JP
4145# check for sizeof(&)
4146 if ($line =~ /\bsizeof\s*\(\s*\&/) {
000d1cc1
JP
4147 WARN("SIZEOF_ADDRESS",
4148 "sizeof(& should be avoided\n" . $herecurr);
8f53a9b8
JP
4149 }
4150
66c80b60
JP
4151# check for sizeof without parenthesis
4152 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
d5e616fc
JP
4153 if (WARN("SIZEOF_PARENTHESIS",
4154 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4155 $fix) {
4156 $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4157 }
66c80b60
JP
4158 }
4159
428e2fdc
JP
4160# check for line continuations in quoted strings with odd counts of "
4161 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
000d1cc1
JP
4162 WARN("LINE_CONTINUATIONS",
4163 "Avoid line continuations in quoted strings\n" . $herecurr);
428e2fdc
JP
4164 }
4165
88982fea
JP
4166# check for struct spinlock declarations
4167 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4168 WARN("USE_SPINLOCK_T",
4169 "struct spinlock should be spinlock_t\n" . $herecurr);
4170 }
4171
a6962d72 4172# check for seq_printf uses that could be seq_puts
06668727 4173 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
a6962d72 4174 my $fmt = get_quoted_string($line, $rawline);
06668727 4175 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
d5e616fc
JP
4176 if (WARN("PREFER_SEQ_PUTS",
4177 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4178 $fix) {
4179 $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/;
4180 }
a6962d72
JP
4181 }
4182 }
4183
554e165c 4184# Check for misused memsets
d1fe9c09
JP
4185 if ($^V && $^V ge 5.10.0 &&
4186 defined $stat &&
d7c76ba7
JP
4187 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
4188
4189 my $ms_addr = $2;
d1fe9c09
JP
4190 my $ms_val = $7;
4191 my $ms_size = $12;
554e165c 4192
554e165c
AW
4193 if ($ms_size =~ /^(0x|)0$/i) {
4194 ERROR("MEMSET",
d7c76ba7 4195 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
554e165c
AW
4196 } elsif ($ms_size =~ /^(0x|)1$/i) {
4197 WARN("MEMSET",
d7c76ba7
JP
4198 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4199 }
4200 }
4201
98a9bba5
JP
4202# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4203 if ($^V && $^V ge 5.10.0 &&
4204 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4205 if (WARN("PREFER_ETHER_ADDR_COPY",
4206 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4207 $fix) {
4208 $fixed[$linenr - 1] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4209 }
4210 }
4211
d7c76ba7 4212# typecasts on min/max could be min_t/max_t
d1fe9c09
JP
4213 if ($^V && $^V ge 5.10.0 &&
4214 defined $stat &&
d7c76ba7 4215 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
d1fe9c09 4216 if (defined $2 || defined $7) {
d7c76ba7
JP
4217 my $call = $1;
4218 my $cast1 = deparenthesize($2);
4219 my $arg1 = $3;
d1fe9c09
JP
4220 my $cast2 = deparenthesize($7);
4221 my $arg2 = $8;
d7c76ba7
JP
4222 my $cast;
4223
d1fe9c09 4224 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
d7c76ba7
JP
4225 $cast = "$cast1 or $cast2";
4226 } elsif ($cast1 ne "") {
4227 $cast = $cast1;
4228 } else {
4229 $cast = $cast2;
4230 }
4231 WARN("MINMAX",
4232 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
554e165c
AW
4233 }
4234 }
4235
4a273195
JP
4236# check usleep_range arguments
4237 if ($^V && $^V ge 5.10.0 &&
4238 defined $stat &&
4239 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4240 my $min = $1;
4241 my $max = $7;
4242 if ($min eq $max) {
4243 WARN("USLEEP_RANGE",
4244 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4245 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4246 $min > $max) {
4247 WARN("USLEEP_RANGE",
4248 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4249 }
4250 }
4251
823b794c
JP
4252# check for naked sscanf
4253 if ($^V && $^V ge 5.10.0 &&
4254 defined $stat &&
6c8bd707 4255 $line =~ /\bsscanf\b/ &&
823b794c
JP
4256 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4257 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4258 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4259 my $lc = $stat =~ tr@\n@@;
4260 $lc = $lc + $linenr;
4261 my $stat_real = raw_line($linenr, 0);
4262 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4263 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4264 }
4265 WARN("NAKED_SSCANF",
4266 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4267 }
4268
70dc8a48
JP
4269# check for new externs in .h files.
4270 if ($realfile =~ /\.h$/ &&
4271 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
d1d85780
JP
4272 if (CHK("AVOID_EXTERNS",
4273 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
70dc8a48
JP
4274 $fix) {
4275 $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
4276 }
4277 }
4278
de7d4f0e 4279# check for new externs in .c files.
171ae1a4 4280 if ($realfile =~ /\.c$/ && defined $stat &&
c45dcabd 4281 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
171ae1a4 4282 {
c45dcabd
AW
4283 my $function_name = $1;
4284 my $paren_space = $2;
171ae1a4
AW
4285
4286 my $s = $stat;
4287 if (defined $cond) {
4288 substr($s, 0, length($cond), '');
4289 }
c45dcabd
AW
4290 if ($s =~ /^\s*;/ &&
4291 $function_name ne 'uninitialized_var')
4292 {
000d1cc1
JP
4293 WARN("AVOID_EXTERNS",
4294 "externs should be avoided in .c files\n" . $herecurr);
171ae1a4
AW
4295 }
4296
4297 if ($paren_space =~ /\n/) {
000d1cc1
JP
4298 WARN("FUNCTION_ARGUMENTS",
4299 "arguments for function declarations should follow identifier\n" . $herecurr);
171ae1a4 4300 }
9c9ba34e
AW
4301
4302 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4303 $stat =~ /^.\s*extern\s+/)
4304 {
000d1cc1
JP
4305 WARN("AVOID_EXTERNS",
4306 "externs should be avoided in .c files\n" . $herecurr);
de7d4f0e
AW
4307 }
4308
4309# checks for new __setup's
4310 if ($rawline =~ /\b__setup\("([^"]*)"/) {
4311 my $name = $1;
4312
4313 if (!grep(/$name/, @setup_docs)) {
000d1cc1
JP
4314 CHK("UNDOCUMENTED_SETUP",
4315 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
de7d4f0e 4316 }
653d4876 4317 }
9c0ca6f9
AW
4318
4319# check for pointless casting of kmalloc return
caf2a54f 4320 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
000d1cc1
JP
4321 WARN("UNNECESSARY_CASTS",
4322 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
9c0ca6f9 4323 }
13214adf 4324
a640d25c
JP
4325# alloc style
4326# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4327 if ($^V && $^V ge 5.10.0 &&
4328 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4329 CHK("ALLOC_SIZEOF_STRUCT",
4330 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
4331 }
4332
972fdea2
JP
4333# check for krealloc arg reuse
4334 if ($^V && $^V ge 5.10.0 &&
4335 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
4336 WARN("KREALLOC_ARG_REUSE",
4337 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
4338 }
4339
5ce59ae0
JP
4340# check for alloc argument mismatch
4341 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
4342 WARN("ALLOC_ARRAY_ARGS",
4343 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
4344 }
4345
caf2a54f
JP
4346# check for multiple semicolons
4347 if ($line =~ /;\s*;\s*$/) {
d5e616fc
JP
4348 if (WARN("ONE_SEMICOLON",
4349 "Statements terminations use 1 semicolon\n" . $herecurr) &&
4350 $fix) {
4351 $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g;
4352 }
d1e2ad07
JP
4353 }
4354
c34c09a8
JP
4355# check for case / default statements not preceeded by break/fallthrough/switch
4356 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
4357 my $has_break = 0;
4358 my $has_statement = 0;
4359 my $count = 0;
4360 my $prevline = $linenr;
4361 while ($prevline > 1 && $count < 3 && !$has_break) {
4362 $prevline--;
4363 my $rline = $rawlines[$prevline - 1];
4364 my $fline = $lines[$prevline - 1];
4365 last if ($fline =~ /^\@\@/);
4366 next if ($fline =~ /^\-/);
4367 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
4368 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
4369 next if ($fline =~ /^.[\s$;]*$/);
4370 $has_statement = 1;
4371 $count++;
4372 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
4373 }
4374 if (!$has_break && $has_statement) {
4375 WARN("MISSING_BREAK",
4376 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
4377 }
4378 }
4379
d1e2ad07
JP
4380# check for switch/default statements without a break;
4381 if ($^V && $^V ge 5.10.0 &&
4382 defined $stat &&
4383 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
4384 my $ctx = '';
4385 my $herectx = $here . "\n";
4386 my $cnt = statement_rawlines($stat);
4387 for (my $n = 0; $n < $cnt; $n++) {
4388 $herectx .= raw_line($linenr, $n) . "\n";
4389 }
4390 WARN("DEFAULT_NO_BREAK",
4391 "switch default: should use break\n" . $herectx);
caf2a54f
JP
4392 }
4393
13214adf 4394# check for gcc specific __FUNCTION__
d5e616fc
JP
4395 if ($line =~ /\b__FUNCTION__\b/) {
4396 if (WARN("USE_FUNC",
4397 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
4398 $fix) {
4399 $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g;
4400 }
13214adf 4401 }
773647a0 4402
2c92488a
JP
4403# check for use of yield()
4404 if ($line =~ /\byield\s*\(\s*\)/) {
4405 WARN("YIELD",
4406 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
4407 }
4408
179f8f40
JP
4409# check for comparisons against true and false
4410 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
4411 my $lead = $1;
4412 my $arg = $2;
4413 my $test = $3;
4414 my $otype = $4;
4415 my $trail = $5;
4416 my $op = "!";
4417
4418 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
4419
4420 my $type = lc($otype);
4421 if ($type =~ /^(?:true|false)$/) {
4422 if (("$test" eq "==" && "$type" eq "true") ||
4423 ("$test" eq "!=" && "$type" eq "false")) {
4424 $op = "";
4425 }
4426
4427 CHK("BOOL_COMPARISON",
4428 "Using comparison to $otype is error prone\n" . $herecurr);
4429
4430## maybe suggesting a correct construct would better
4431## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4432
4433 }
4434 }
4435
4882720b
TG
4436# check for semaphores initialized locked
4437 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
000d1cc1
JP
4438 WARN("CONSIDER_COMPLETION",
4439 "consider using a completion\n" . $herecurr);
773647a0 4440 }
6712d858 4441
67d0a075
JP
4442# recommend kstrto* over simple_strto* and strict_strto*
4443 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
000d1cc1 4444 WARN("CONSIDER_KSTRTO",
67d0a075 4445 "$1 is obsolete, use k$3 instead\n" . $herecurr);
773647a0 4446 }
6712d858 4447
f3db6639
ME
4448# check for __initcall(), use device_initcall() explicitly please
4449 if ($line =~ /^.\s*__initcall\s*\(/) {
000d1cc1
JP
4450 WARN("USE_DEVICE_INITCALL",
4451 "please use device_initcall() instead of __initcall()\n" . $herecurr);
f3db6639 4452 }
6712d858 4453
79404849
ER
4454# check for various ops structs, ensure they are const.
4455 my $struct_ops = qr{acpi_dock_ops|
4456 address_space_operations|
4457 backlight_ops|
4458 block_device_operations|
4459 dentry_operations|
4460 dev_pm_ops|
4461 dma_map_ops|
4462 extent_io_ops|
4463 file_lock_operations|
4464 file_operations|
4465 hv_ops|
4466 ide_dma_ops|
4467 intel_dvo_dev_ops|
4468 item_operations|
4469 iwl_ops|
4470 kgdb_arch|
4471 kgdb_io|
4472 kset_uevent_ops|
4473 lock_manager_operations|
4474 microcode_ops|
4475 mtrr_ops|
4476 neigh_ops|
4477 nlmsvc_binding|
4478 pci_raw_ops|
4479 pipe_buf_operations|
4480 platform_hibernation_ops|
4481 platform_suspend_ops|
4482 proto_ops|
4483 rpc_pipe_ops|
4484 seq_operations|
4485 snd_ac97_build_ops|
4486 soc_pcmcia_socket_ops|
4487 stacktrace_ops|
4488 sysfs_ops|
4489 tty_operations|
4490 usb_mon_operations|
4491 wd_ops}x;
6903ffb2 4492 if ($line !~ /\bconst\b/ &&
79404849 4493 $line =~ /\bstruct\s+($struct_ops)\b/) {
000d1cc1
JP
4494 WARN("CONST_STRUCT",
4495 "struct $1 should normally be const\n" .
6903ffb2 4496 $herecurr);
2b6db5cb 4497 }
773647a0
AW
4498
4499# use of NR_CPUS is usually wrong
4500# ignore definitions of NR_CPUS and usage to define arrays as likely right
4501 if ($line =~ /\bNR_CPUS\b/ &&
c45dcabd
AW
4502 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4503 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
171ae1a4
AW
4504 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4505 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4506 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
773647a0 4507 {
000d1cc1
JP
4508 WARN("NR_CPUS",
4509 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
773647a0 4510 }
9c9ba34e 4511
52ea8506
JP
4512# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
4513 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
4514 ERROR("DEFINE_ARCH_HAS",
4515 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
4516 }
4517
9c9ba34e
AW
4518# check for %L{u,d,i} in strings
4519 my $string;
4520 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4521 $string = substr($rawline, $-[1], $+[1] - $-[1]);
2a1bc5d5 4522 $string =~ s/%%/__/g;
9c9ba34e 4523 if ($string =~ /(?<!%)%L[udi]/) {
000d1cc1
JP
4524 WARN("PRINTF_L",
4525 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
9c9ba34e
AW
4526 last;
4527 }
4528 }
691d77b6
AW
4529
4530# whine mightly about in_atomic
4531 if ($line =~ /\bin_atomic\s*\(/) {
4532 if ($realfile =~ m@^drivers/@) {
000d1cc1
JP
4533 ERROR("IN_ATOMIC",
4534 "do not use in_atomic in drivers\n" . $herecurr);
f4a87736 4535 } elsif ($realfile !~ m@^kernel/@) {
000d1cc1
JP
4536 WARN("IN_ATOMIC",
4537 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
691d77b6
AW
4538 }
4539 }
1704f47b
PZ
4540
4541# check for lockdep_set_novalidate_class
4542 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
4543 $line =~ /__lockdep_no_validate__\s*\)/ ) {
4544 if ($realfile !~ m@^kernel/lockdep@ &&
4545 $realfile !~ m@^include/linux/lockdep@ &&
4546 $realfile !~ m@^drivers/base/core@) {
000d1cc1
JP
4547 ERROR("LOCKDEP",
4548 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
1704f47b
PZ
4549 }
4550 }
88f8831c
DJ
4551
4552 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
4553 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
000d1cc1
JP
4554 WARN("EXPORTED_WORLD_WRITABLE",
4555 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
88f8831c 4556 }
2435880f 4557
515a235e
JP
4558# Mode permission misuses where it seems decimal should be octal
4559# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
4560 if ($^V && $^V ge 5.10.0 &&
4561 $line =~ /$mode_perms_search/) {
4562 foreach my $entry (@mode_permission_funcs) {
4563 my $func = $entry->[0];
4564 my $arg_pos = $entry->[1];
4565
4566 my $skip_args = "";
4567 if ($arg_pos > 1) {
4568 $arg_pos--;
4569 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
4570 }
4571 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
4572 if ($line =~ /$test/) {
4573 my $val = $1;
4574 $val = $6 if ($skip_args ne "");
4575
4576 if ($val !~ /^0$/ &&
4577 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
4578 length($val) ne 4)) {
4579 ERROR("NON_OCTAL_PERMISSIONS",
4580 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
4581 }
2435880f
JP
4582 }
4583 }
4584 }
13214adf
AW
4585 }
4586
4587 # If we have no input at all, then there is nothing to report on
4588 # so just keep quiet.
4589 if ($#rawlines == -1) {
4590 exit(0);
0a920b5b
AW
4591 }
4592
8905a67c
AW
4593 # In mailback mode only produce a report in the negative, for
4594 # things that appear to be patches.
4595 if ($mailback && ($clean == 1 || !$is_patch)) {
4596 exit(0);
4597 }
4598
4599 # This is not a patch, and we are are in 'no-patch' mode so
4600 # just keep quiet.
4601 if (!$chk_patch && !$is_patch) {
4602 exit(0);
4603 }
4604
4605 if (!$is_patch) {
000d1cc1
JP
4606 ERROR("NOT_UNIFIED_DIFF",
4607 "Does not appear to be a unified-diff format patch\n");
0a920b5b
AW
4608 }
4609 if ($is_patch && $chk_signoff && $signoff == 0) {
000d1cc1
JP
4610 ERROR("MISSING_SIGN_OFF",
4611 "Missing Signed-off-by: line(s)\n");
0a920b5b
AW
4612 }
4613
8905a67c 4614 print report_dump();
13214adf
AW
4615 if ($summary && !($clean == 1 && $quiet == 1)) {
4616 print "$filename " if ($summary_file);
8905a67c
AW
4617 print "total: $cnt_error errors, $cnt_warn warnings, " .
4618 (($check)? "$cnt_chk checks, " : "") .
4619 "$cnt_lines lines checked\n";
4620 print "\n" if ($quiet == 0);
f0a594c1 4621 }
8905a67c 4622
d2c0a235 4623 if ($quiet == 0) {
d1fe9c09
JP
4624
4625 if ($^V lt 5.10.0) {
4626 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
4627 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
4628 }
4629
d2c0a235
AW
4630 # If there were whitespace errors which cleanpatch can fix
4631 # then suggest that.
4632 if ($rpt_cleaners) {
4633 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
4634 print " scripts/cleanfile\n\n";
b0781216 4635 $rpt_cleaners = 0;
d2c0a235
AW
4636 }
4637 }
4638
91bfe484
JP
4639 hash_show_words(\%use_type, "Used");
4640 hash_show_words(\%ignore_type, "Ignored");
000d1cc1 4641
3705ce5b 4642 if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
9624b8d6
JP
4643 my $newfile = $filename;
4644 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
3705ce5b
JP
4645 my $linecount = 0;
4646 my $f;
4647
4648 open($f, '>', $newfile)
4649 or die "$P: Can't open $newfile for write\n";
4650 foreach my $fixed_line (@fixed) {
4651 $linecount++;
4652 if ($file) {
4653 if ($linecount > 3) {
4654 $fixed_line =~ s/^\+//;
4655 print $f $fixed_line. "\n";
4656 }
4657 } else {
4658 print $f $fixed_line . "\n";
4659 }
4660 }
4661 close($f);
4662
4663 if (!$quiet) {
4664 print << "EOM";
4665Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
4666
4667Do _NOT_ trust the results written to this file.
4668Do _NOT_ submit these changes without inspecting them for correctness.
4669
4670This EXPERIMENTAL file is simply a convenience to help rewrite patches.
4671No warranties, expressed or implied...
4672
4673EOM
4674 }
4675 }
4676
0a920b5b 4677 if ($clean == 1 && $quiet == 0) {
c2fdda0d 4678 print "$vname has no obvious style problems and is ready for submission.\n"
0a920b5b
AW
4679 }
4680 if ($clean == 0 && $quiet == 0) {
000d1cc1
JP
4681 print << "EOM";
4682$vname has style problems, please review.
4683
4684If any of these errors are false positives, please report
4685them to the maintainer, see CHECKPATCH in MAINTAINERS.
4686EOM
0a920b5b 4687 }
13214adf 4688
0a920b5b
AW
4689 return $clean;
4690}