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