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