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