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