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