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