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