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