checkpatch.pl 218.6 KB
Newer Older
1
#!/usr/bin/env perl
2 3
# SPDX-License-Identifier: GPL-2.0
#
4
# (c) 2001, Dave Jones. (the file handling bit)
5
# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
A
Andy Whitcroft 已提交
6
# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
7
# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
8
# (c) 2010-2018 Joe Perches <joe@perches.com>
9 10

use strict;
11
use warnings;
12
use POSIX;
13 14
use File::Basename;
use Cwd 'abs_path';
15
use Term::ANSIColor qw(:constants);
16
use Encode qw(decode encode);
17 18

my $P = $0;
19
my $D = dirname(abs_path($P));
20

21
my $V = '0.32';
22 23 24 25 26 27 28

use Getopt::Long qw(:config no_auto_abbrev);

my $quiet = 0;
my $tree = 1;
my $chk_signoff = 1;
my $chk_patch = 1;
29
my $tst_only;
30
my $emacs = 0;
31
my $terse = 0;
32
my $showfile = 0;
33
my $file = 0;
34
my $git = 0;
35
my %git_commits = ();
36
my $check = 0;
37
my $check_orig = 0;
38 39
my $summary = 1;
my $mailback = 0;
40
my $summary_file = 0;
41
my $show_types = 0;
42
my $list_types = 0;
43
my $fix = 0;
44
my $fix_inplace = 0;
45
my $root;
46 47
my $gitroot = $ENV{'GIT_DIR'};
$gitroot = ".git" if !defined($gitroot);
48
my %debug;
49
my %camelcase = ();
50 51 52
my %use_type = ();
my @use = ();
my %ignore_type = ();
53
my @ignore = ();
54
my $help = 0;
55
my $configuration_file = ".checkpatch.conf";
56
my $max_line_length = 100;
57 58
my $ignore_perl_version = 0;
my $minimum_perl_version = 5.10.0;
59
my $min_conf_desc_length = 4;
60
my $spelling_file = "$D/spelling.txt";
61
my $codespell = 0;
62
my $codespellfile = "/usr/share/codespell/dictionary.txt";
63
my $conststructsfile = "$D/const_structs.checkpatch";
64
my $typedefsfile;
65
my $color = "auto";
66
my $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE
67 68
# git output parsing needs US English output, so first set backtick child process LANGUAGE
my $git_command ='export LANGUAGE=en_US.UTF-8; git';
69
my $tabsize = 8;
70
my ${CONFIG_} = "CONFIG_";
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85

sub help {
	my ($exitcode) = @_;

	print << "EOM";
Usage: $P [OPTION]... [FILE]...
Version: $V

Options:
  -q, --quiet                quiet
  --no-tree                  run without a kernel tree
  --no-signoff               do not check for 'Signed-off-by' line
  --patch                    treat FILE as patchfile (default)
  --emacs                    emacs compile window format
  --terse                    one line per report
86
  --showfile                 emit diffed file position, not input file position
87 88 89 90 91 92 93 94 95 96
  -g, --git                  treat FILE as a single commit or git revision range
                             single git commit with:
                               <rev>
                               <rev>^
                               <rev>~n
                             multiple git commits with:
                               <rev1>..<rev2>
                               <rev1>...<rev2>
                               <rev>-<count>
                             git merges are ignored
97 98
  -f, --file                 treat FILE as regular source file
  --subjective, --strict     enable more subjective tests
99
  --list-types               list the possible message types
100
  --types TYPE(,TYPE2...)    show only these comma separated message types
101
  --ignore TYPE(,TYPE2...)   ignore various comma separated message types
102
  --show-types               show the specific message type in the output
103 104 105
  --max-line-length=n        set the maximum line length, (default $max_line_length)
                             if exceeded, warn on patches
                             requires --strict for use with --file
106
  --min-conf-desc-length=n   set the min description length, if shorter, warn
107
  --tab-size=n               set the number of spaces for tab (default $tabsize)
108 109 110 111 112 113 114 115 116
  --root=PATH                PATH to the kernel tree root
  --no-summary               suppress the per-file summary
  --mailback                 only produce a report in case of warnings/errors
  --summary-file             include the filename in summary
  --debug KEY=[0|1]          turn on/off debugging of KEY, where KEY is one of
                             'values', 'possible', 'type', and 'attr' (default
                             is all off)
  --test-only=WORD           report only warnings/errors containing WORD
                             literally
117 118 119 120 121
  --fix                      EXPERIMENTAL - may create horrible results
                             If correctable single-line errors exist, create
                             "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
                             with potential errors corrected to the preferred
                             checkpatch style
122 123 124
  --fix-inplace              EXPERIMENTAL - may create horrible results
                             Is the same as --fix, but overwrites the input
                             file.  It's your fault if there's no backup or git
125 126
  --ignore-perl-version      override checking of perl version.  expect
                             runtime errors.
127
  --codespell                Use the codespell dictionary for spelling/typos
128
                             (default:/usr/share/codespell/dictionary.txt)
129
  --codespellfile            Use this codespell dictionary
130
  --typedefsfile             Read additional types from this file
131 132
  --color[=WHEN]             Use colors 'always', 'never', or only when output
                             is a terminal ('auto'). Default is 'auto'.
133 134
  --kconfig-prefix=WORD      use WORD as a prefix for Kconfig symbols (default
                             ${CONFIG_})
135 136 137 138 139 140 141 142
  -h, --help, --version      display this help and exit

When FILE is - read standard input.
EOM

	exit($exitcode);
}

143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
sub uniq {
	my %seen;
	return grep { !$seen{$_}++ } @_;
}

sub list_types {
	my ($exitcode) = @_;

	my $count = 0;

	local $/ = undef;

	open(my $script, '<', abs_path($P)) or
	    die "$P: Can't read '$P' $!\n";

	my $text = <$script>;
	close($script);

	my @types = ();
162 163
	# Also catch when type or level is passed through a variable
	for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
164 165 166 167 168 169 170 171 172 173 174
		push (@types, $_);
	}
	@types = sort(uniq(@types));
	print("#\tMessage type\n\n");
	foreach my $type (@types) {
		print(++$count . "\t" . $type . "\n");
	}

	exit($exitcode);
}

175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
my $conf = which_conf($configuration_file);
if (-f $conf) {
	my @conf_args;
	open(my $conffile, '<', "$conf")
	    or warn "$P: Can't find a readable $configuration_file file $!\n";

	while (<$conffile>) {
		my $line = $_;

		$line =~ s/\s*\n?$//g;
		$line =~ s/^\s*//g;
		$line =~ s/\s+/ /g;

		next if ($line =~ m/^\s*#/);
		next if ($line =~ m/^\s*$/);

		my @words = split(" ", $line);
		foreach my $word (@words) {
			last if ($word =~ m/^#/);
			push (@conf_args, $word);
		}
	}
	close($conffile);
	unshift(@ARGV, @conf_args) if @conf_args;
}

201 202 203 204 205 206 207 208
# Perl's Getopt::Long allows options to take optional arguments after a space.
# Prevent --color by itself from consuming other arguments
foreach (@ARGV) {
	if ($_ eq "--color" || $_ eq "-color") {
		$_ = "--color=$color";
	}
}

209
GetOptions(
210
	'q|quiet+'	=> \$quiet,
211 212 213
	'tree!'		=> \$tree,
	'signoff!'	=> \$chk_signoff,
	'patch!'	=> \$chk_patch,
214
	'emacs!'	=> \$emacs,
215
	'terse!'	=> \$terse,
216
	'showfile!'	=> \$showfile,
217
	'f|file!'	=> \$file,
218
	'g|git!'	=> \$git,
219 220
	'subjective!'	=> \$check,
	'strict!'	=> \$check,
221
	'ignore=s'	=> \@ignore,
222
	'types=s'	=> \@use,
223
	'show-types!'	=> \$show_types,
224
	'list-types!'	=> \$list_types,
225
	'max-line-length=i' => \$max_line_length,
226
	'min-conf-desc-length=i' => \$min_conf_desc_length,
227
	'tab-size=i'	=> \$tabsize,
228
	'root=s'	=> \$root,
229 230
	'summary!'	=> \$summary,
	'mailback!'	=> \$mailback,
231
	'summary-file!'	=> \$summary_file,
232
	'fix!'		=> \$fix,
233
	'fix-inplace!'	=> \$fix_inplace,
234
	'ignore-perl-version!' => \$ignore_perl_version,
235
	'debug=s'	=> \%debug,
236
	'test-only=s'	=> \$tst_only,
237 238
	'codespell!'	=> \$codespell,
	'codespellfile=s'	=> \$codespellfile,
239
	'typedefsfile=s'	=> \$typedefsfile,
240 241 242
	'color=s'	=> \$color,
	'no-color'	=> \$color,	#keep old behaviors of -nocolor
	'nocolor'	=> \$color,	#keep old behaviors of -nocolor
243
	'kconfig-prefix=s'	=> \${CONFIG_},
244 245 246 247 248
	'h|help'	=> \$help,
	'version'	=> \$help
) or help(1);

help(0) if ($help);
249

250 251
list_types(0) if ($list_types);

252
$fix = 1 if ($fix_inplace);
253
$check_orig = $check;
254

255 256
die "$P: --git cannot be used with --file or --fix\n" if ($git && ($file || $fix));

257 258
my $exit = 0;

259
my $perl_version_ok = 1;
260
if ($^V && $^V lt $minimum_perl_version) {
261
	$perl_version_ok = 0;
262
	printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
263
	exit(1) if (!$ignore_perl_version);
264 265
}

266
#if no filenames are given, push '-' to read patch from stdin
267
if ($#ARGV < 0) {
268
	push(@ARGV, '-');
269 270
}

271 272 273 274 275 276 277 278 279
if ($color =~ /^[01]$/) {
	$color = !$color;
} elsif ($color =~ /^always$/i) {
	$color = 1;
} elsif ($color =~ /^never$/i) {
	$color = 0;
} elsif ($color =~ /^auto$/i) {
	$color = (-t STDOUT);
} else {
280
	die "$P: Invalid color mode: $color\n";
281 282
}

283
# skip TAB size 1 to avoid additional checks on $tabsize - 1
284
die "$P: Invalid TAB size: $tabsize\n" if ($tabsize < 2);
285

286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
sub hash_save_array_words {
	my ($hashRef, $arrayRef) = @_;

	my @array = split(/,/, join(',', @$arrayRef));
	foreach my $word (@array) {
		$word =~ s/\s*\n?$//g;
		$word =~ s/^\s*//g;
		$word =~ s/\s+/ /g;
		$word =~ tr/[a-z]/[A-Z]/;

		next if ($word =~ m/^\s*#/);
		next if ($word =~ m/^\s*$/);

		$hashRef->{$word}++;
	}
}
302

303 304
sub hash_show_words {
	my ($hashRef, $prefix) = @_;
305

306
	if (keys %$hashRef) {
307
		print "\nNOTE: $prefix message types:";
308
		foreach my $word (sort keys %$hashRef) {
309 310
			print " $word";
		}
311
		print "\n";
312
	}
313 314
}

315 316 317
hash_save_array_words(\%ignore_type, \@ignore);
hash_save_array_words(\%use_type, \@use);

318 319
my $dbg_values = 0;
my $dbg_possible = 0;
320
my $dbg_type = 0;
321
my $dbg_attr = 0;
322
for my $key (keys %debug) {
323 324 325
	## no critic
	eval "\${dbg_$key} = '$debug{$key}';";
	die "$@" if ($@);
326 327
}

328 329
my $rpt_cleaners = 0;

330 331 332 333 334
if ($terse) {
	$emacs = 1;
	$quiet++;
}

335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
if ($tree) {
	if (defined $root) {
		if (!top_of_kernel_tree($root)) {
			die "$P: $root: --root does not point at a valid tree\n";
		}
	} else {
		if (top_of_kernel_tree('.')) {
			$root = '.';
		} elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
						top_of_kernel_tree($1)) {
			$root = $1;
		}
	}

	if (!defined $root) {
		print "Must be run from the top-level dir. of a kernel tree\n";
		exit(2);
	}
353 354
}

355 356
my $emitted_corrupt = 0;

357 358 359 360
our $Ident	= qr{
			[A-Za-z_][A-Za-z\d_]*
			(?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
		}x;
361 362 363 364 365 366 367
our $Storage	= qr{extern|static|asmlinkage};
our $Sparse	= qr{
			__user|
			__kernel|
			__force|
			__iomem|
			__must_check|
368
			__kprobes|
369
			__ref|
370 371
			__refconst|
			__refdata|
372 373
			__rcu|
			__private
374
		}x;
375 376 377 378 379
our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
380

381 382
# Notes to $Attribute:
# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
383 384
our $Attribute	= qr{
			const|
385 386 387
			__percpu|
			__nocast|
			__safe|
388
			__bitwise|
389 390 391 392 393 394 395 396
			__packed__|
			__packed2__|
			__naked|
			__maybe_unused|
			__always_unused|
			__noreturn|
			__used|
			__cold|
397
			__pure|
398 399
			__noclone|
			__deprecated|
400
			__read_mostly|
401
			__ro_after_init|
402
			__kprobes|
403
			$InitAttribute|
404 405
			____cacheline_aligned|
			____cacheline_aligned_in_smp|
406 407
			____cacheline_internodealigned_in_smp|
			__weak
408
		  }x;
409
our $Modifier;
410
our $Inline	= qr{inline|__always_inline|noinline|__inline|__inline__};
411 412 413
our $Member	= qr{->$Ident|\.$Ident|\[[^]]*\]};
our $Lval	= qr{$Ident(?:$Member)*};

414 415 416 417
our $Int_type	= qr{(?i)llu|ull|ll|lu|ul|l|u};
our $Binary	= qr{(?i)0b[01]+$Int_type?};
our $Hex	= qr{(?i)0x[0-9a-f]+$Int_type?};
our $Int	= qr{[0-9]+$Int_type?};
418
our $Octal	= qr{0[0-7]+$Int_type?};
419
our $String	= qr{"[X\t]*"};
420 421 422
our $Float_hex	= qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
our $Float_dec	= qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
our $Float_int	= qr{(?i)[0-9]+e-?[0-9]+[fl]?};
423
our $Float	= qr{$Float_hex|$Float_dec|$Float_int};
424
our $Constant	= qr{$Float|$Binary|$Octal|$Hex|$Int};
425
our $Assignment	= qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
426
our $Compare    = qr{<=|>=|==|!=|<|(?<!-)>};
427
our $Arithmetic = qr{\+|-|\*|\/|%};
428 429 430
our $Operators	= qr{
			<=|>=|==|!=|
			=>|->|<<|>>|<|>|!|~|
431
			&&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
432 433
		  }x;

434 435
our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;

436
our $BasicType;
437
our $NonptrType;
438
our $NonptrTypeMisordered;
439
our $NonptrTypeWithAttr;
440
our $Type;
441
our $TypeMisordered;
442
our $Declare;
443
our $DeclareMisordered;
444

445 446
our $NON_ASCII_UTF8	= qr{
	[\xC2-\xDF][\x80-\xBF]               # non-overlong 2-byte
447 448 449 450 451 452 453 454
	|  \xE0[\xA0-\xBF][\x80-\xBF]        # excluding overlongs
	| [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}  # straight 3-byte
	|  \xED[\x80-\x9F][\x80-\xBF]        # excluding surrogates
	|  \xF0[\x90-\xBF][\x80-\xBF]{2}     # planes 1-3
	| [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
	|  \xF4[\x80-\x8F][\x80-\xBF]{2}     # plane 16
}x;

455 456 457 458 459
our $UTF8	= qr{
	[\x09\x0A\x0D\x20-\x7E]              # ASCII
	| $NON_ASCII_UTF8
}x;

460
our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
461 462 463 464
our $typeOtherOSTypedefs = qr{(?x:
	u_(?:char|short|int|long) |          # bsd
	u(?:nchar|short|int|long)            # sysv
)};
465
our $typeKernelTypedefs = qr{(?x:
466
	(?:__)?(?:u|s|be|le)(?:8|16|32|64)|
467 468
	atomic_t
)};
469 470 471 472 473
our $typeTypedefs = qr{(?x:
	$typeC99Typedefs\b|
	$typeOtherOSTypedefs\b|
	$typeKernelTypedefs\b
)};
474

475 476
our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};

477
our $logFunctions = qr{(?x:
M
Miles Chen 已提交
478
	printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
479
	(?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
480
	TP_printk|
481
	WARN(?:_RATELIMIT|_ONCE|)|
482
	panic|
J
Joe Perches 已提交
483 484
	MODULE_[A-Z_]+|
	seq_vprintf|seq_printf|seq_puts
485 486
)};

487 488 489 490 491
our $allocFunctions = qr{(?x:
	(?:(?:devm_)?
		(?:kv|k|v)[czm]alloc(?:_node|_array)? |
		kstrdup(?:_const)? |
		kmemdup(?:_nul)?) |
492
	(?:\w+)?alloc_skb(?:_ip_align)? |
493 494 495 496
				# dev_alloc_skb/netdev_alloc_skb, et al
	dma_alloc_coherent
)};

497 498
our $signature_tags = qr{(?xi:
	Signed-off-by:|
499
	Co-developed-by:|
500 501 502 503
	Acked-by:|
	Tested-by:|
	Reviewed-by:|
	Reported-by:|
504
	Suggested-by:|
505 506 507 508
	To:|
	Cc:
)};

509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
sub edit_distance_min {
	my (@arr) = @_;
	my $len = scalar @arr;
	if ((scalar @arr) < 1) {
		# if underflow, return
		return;
	}
	my $min = $arr[0];
	for my $i (0 .. ($len-1)) {
		if ($arr[$i] < $min) {
			$min = $arr[$i];
		}
	}
	return $min;
}

sub get_edit_distance {
	my ($str1, $str2) = @_;
	$str1 = lc($str1);
	$str2 = lc($str2);
	$str1 =~ s/-//g;
	$str2 =~ s/-//g;
	my $len1 = length($str1);
	my $len2 = length($str2);
	# two dimensional array storing minimum edit distance
	my @distance;
	for my $i (0 .. $len1) {
		for my $j (0 .. $len2) {
			if ($i == 0) {
				$distance[$i][$j] = $j;
			} elsif ($j == 0) {
				$distance[$i][$j] = $i;
			} elsif (substr($str1, $i-1, 1) eq substr($str2, $j-1, 1)) {
				$distance[$i][$j] = $distance[$i - 1][$j - 1];
			} else {
				my $dist1 = $distance[$i][$j - 1]; #insert distance
				my $dist2 = $distance[$i - 1][$j]; # remove
				my $dist3 = $distance[$i - 1][$j - 1]; #replace
				$distance[$i][$j] = 1 + edit_distance_min($dist1, $dist2, $dist3);
			}
		}
	}
	return $distance[$len1][$len2];
}

sub find_standard_signature {
	my ($sign_off) = @_;
	my @standard_signature_tags = (
		'Signed-off-by:', 'Co-developed-by:', 'Acked-by:', 'Tested-by:',
		'Reviewed-by:', 'Reported-by:', 'Suggested-by:'
	);
	foreach my $signature (@standard_signature_tags) {
		return $signature if (get_edit_distance($sign_off, $signature) <= 2);
	}

	return "";
}

567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585
our @typeListMisordered = (
	qr{char\s+(?:un)?signed},
	qr{int\s+(?:(?:un)?signed\s+)?short\s},
	qr{int\s+short(?:\s+(?:un)?signed)},
	qr{short\s+int(?:\s+(?:un)?signed)},
	qr{(?:un)?signed\s+int\s+short},
	qr{short\s+(?:un)?signed},
	qr{long\s+int\s+(?:un)?signed},
	qr{int\s+long\s+(?:un)?signed},
	qr{long\s+(?:un)?signed\s+int},
	qr{int\s+(?:un)?signed\s+long},
	qr{int\s+(?:un)?signed},
	qr{int\s+long\s+long\s+(?:un)?signed},
	qr{long\s+long\s+int\s+(?:un)?signed},
	qr{long\s+long\s+(?:un)?signed\s+int},
	qr{long\s+long\s+(?:un)?signed},
	qr{long\s+(?:un)?signed},
);

586 587
our @typeList = (
	qr{void},
588 589 590 591 592 593 594 595 596
	qr{(?:(?:un)?signed\s+)?char},
	qr{(?:(?:un)?signed\s+)?short\s+int},
	qr{(?:(?:un)?signed\s+)?short},
	qr{(?:(?:un)?signed\s+)?int},
	qr{(?:(?:un)?signed\s+)?long\s+int},
	qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
	qr{(?:(?:un)?signed\s+)?long\s+long},
	qr{(?:(?:un)?signed\s+)?long},
	qr{(?:un)?signed},
597 598 599 600 601 602 603 604 605
	qr{float},
	qr{double},
	qr{bool},
	qr{struct\s+$Ident},
	qr{union\s+$Ident},
	qr{enum\s+$Ident},
	qr{${Ident}_t},
	qr{${Ident}_handler},
	qr{${Ident}_handler_fn},
606
	@typeListMisordered,
607
);
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629

our $C90_int_types = qr{(?x:
	long\s+long\s+int\s+(?:un)?signed|
	long\s+long\s+(?:un)?signed\s+int|
	long\s+long\s+(?:un)?signed|
	(?:(?:un)?signed\s+)?long\s+long\s+int|
	(?:(?:un)?signed\s+)?long\s+long|
	int\s+long\s+long\s+(?:un)?signed|
	int\s+(?:(?:un)?signed\s+)?long\s+long|

	long\s+int\s+(?:un)?signed|
	long\s+(?:un)?signed\s+int|
	long\s+(?:un)?signed|
	(?:(?:un)?signed\s+)?long\s+int|
	(?:(?:un)?signed\s+)?long|
	int\s+long\s+(?:un)?signed|
	int\s+(?:(?:un)?signed\s+)?long|

	int\s+(?:un)?signed|
	(?:(?:un)?signed\s+)?int
)};

630
our @typeListFile = ();
631 632 633 634 635 636
our @typeListWithAttr = (
	@typeList,
	qr{struct\s+$InitAttribute\s+$Ident},
	qr{union\s+$InitAttribute\s+$Ident},
);

637 638 639
our @modifierList = (
	qr{fastcall},
);
640
our @modifierListFile = ();
641

642 643 644 645 646 647
our @mode_permission_funcs = (
	["module_param", 3],
	["module_param_(?:array|named|string)", 4],
	["module_param_array_named", 5],
	["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
	["proc_create(?:_data|)", 2],
648 649 650 651 652
	["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
	["IIO_DEV_ATTR_[A-Z_]+", 1],
	["SENSOR_(?:DEVICE_|)ATTR_2", 2],
	["SENSOR_TEMPLATE(?:_2|)", 3],
	["__ATTR", 2],
653 654
);

655 656
my $word_pattern = '\b[A-Z]?[a-z]{2,}\b';

657 658 659 660 661 662
#Create a search pattern for all these functions to speed up a loop below
our $mode_perms_search = "";
foreach my $entry (@mode_permission_funcs) {
	$mode_perms_search .= '|' if ($mode_perms_search ne "");
	$mode_perms_search .= $entry->[0];
}
663
$mode_perms_search = "(?:${mode_perms_search})";
664

665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685
our %deprecated_apis = (
	"synchronize_rcu_bh"			=> "synchronize_rcu",
	"synchronize_rcu_bh_expedited"		=> "synchronize_rcu_expedited",
	"call_rcu_bh"				=> "call_rcu",
	"rcu_barrier_bh"			=> "rcu_barrier",
	"synchronize_sched"			=> "synchronize_rcu",
	"synchronize_sched_expedited"		=> "synchronize_rcu_expedited",
	"call_rcu_sched"			=> "call_rcu",
	"rcu_barrier_sched"			=> "rcu_barrier",
	"get_state_synchronize_sched"		=> "get_state_synchronize_rcu",
	"cond_synchronize_sched"		=> "cond_synchronize_rcu",
);

#Create a search pattern for all these strings to speed up a loop below
our $deprecated_apis_search = "";
foreach my $entry (keys %deprecated_apis) {
	$deprecated_apis_search .= '|' if ($deprecated_apis_search ne "");
	$deprecated_apis_search .= $entry;
}
$deprecated_apis_search = "(?:${deprecated_apis_search})";

686 687 688 689 690 691 692 693
our $mode_perms_world_writable = qr{
	S_IWUGO		|
	S_IWOTH		|
	S_IRWXUGO	|
	S_IALLUGO	|
	0[0-7][0-7][2367]
}x;

694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
our %mode_permission_string_types = (
	"S_IRWXU" => 0700,
	"S_IRUSR" => 0400,
	"S_IWUSR" => 0200,
	"S_IXUSR" => 0100,
	"S_IRWXG" => 0070,
	"S_IRGRP" => 0040,
	"S_IWGRP" => 0020,
	"S_IXGRP" => 0010,
	"S_IRWXO" => 0007,
	"S_IROTH" => 0004,
	"S_IWOTH" => 0002,
	"S_IXOTH" => 0001,
	"S_IRWXUGO" => 0777,
	"S_IRUGO" => 0444,
	"S_IWUGO" => 0222,
	"S_IXUGO" => 0111,
);

#Create a search pattern for all these strings to speed up a loop below
our $mode_perms_string_search = "";
foreach my $entry (keys %mode_permission_string_types) {
	$mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
	$mode_perms_string_search .= $entry;
}
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749
our $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
our $multi_mode_perms_string_search = qr{
	${single_mode_perms_string_search}
	(?:\s*\|\s*${single_mode_perms_string_search})*
}x;

sub perms_to_octal {
	my ($string) = @_;

	return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);

	my $val = "";
	my $oval = "";
	my $to = 0;
	my $curpos = 0;
	my $lastpos = 0;
	while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
		$curpos = pos($string);
		my $match = $2;
		my $omatch = $1;
		last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
		$lastpos = $curpos;
		$to |= $mode_permission_string_types{$match};
		$val .= '\s*\|\s*' if ($val ne "");
		$val .= $match;
		$oval .= $omatch;
	}
	$oval =~ s/^\s*\|\s*//;
	$oval =~ s/\s*\|\s*$//;
	return sprintf("%04o", $to);
}
750

751 752
our $allowed_asm_includes = qr{(?x:
	irq|
753 754 755
	memory|
	time|
	reboot
756 757 758
)};
# memory.h: ARM has a custom one

759 760 761 762
# Load common spelling mistakes and build regular expression list.
my $misspellings;
my %spelling_fix;

763 764 765
if (open(my $spelling, '<', $spelling_file)) {
	while (<$spelling>) {
		my $line = $_;
766

767 768
		$line =~ s/\s*\n?$//g;
		$line =~ s/^\s*//g;
769

770 771 772 773
		next if ($line =~ m/^\s*#/);
		next if ($line =~ m/^\s*$/);

		my ($suspect, $fix) = split(/\|\|/, $line);
774

775 776 777 778 779
		$spelling_fix{$suspect} = $fix;
	}
	close($spelling);
} else {
	warn "No typos will be found - file '$spelling_file': $!\n";
780 781
}

782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
if ($codespell) {
	if (open(my $spelling, '<', $codespellfile)) {
		while (<$spelling>) {
			my $line = $_;

			$line =~ s/\s*\n?$//g;
			$line =~ s/^\s*//g;

			next if ($line =~ m/^\s*#/);
			next if ($line =~ m/^\s*$/);
			next if ($line =~ m/, disabled/i);

			$line =~ s/,.*$//;

			my ($suspect, $fix) = split(/->/, $line);

			$spelling_fix{$suspect} = $fix;
		}
		close($spelling);
	} else {
		warn "No codespell typos will be found - file '$codespellfile': $!\n";
	}
}

$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;

808 809
sub read_words {
	my ($wordsRef, $file) = @_;
810

811 812 813
	if (open(my $words, '<', $file)) {
		while (<$words>) {
			my $line = $_;
814

815 816
			$line =~ s/\s*\n?$//g;
			$line =~ s/^\s*//g;
817

818 819 820 821 822 823 824
			next if ($line =~ m/^\s*#/);
			next if ($line =~ m/^\s*$/);
			if ($line =~ /\s/) {
				print("$file: '$line' invalid - ignored\n");
				next;
			}

825
			$$wordsRef .= '|' if (defined $$wordsRef);
826 827 828 829
			$$wordsRef .= $line;
		}
		close($file);
		return 1;
830
	}
831 832 833 834

	return 0;
}

835 836 837 838 839
my $const_structs;
if (show_type("CONST_STRUCT")) {
	read_words(\$const_structs, $conststructsfile)
	    or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
}
840

841 842
if (defined($typedefsfile)) {
	my $typeOtherTypedefs;
843 844
	read_words(\$typeOtherTypedefs, $typedefsfile)
	    or warn "No additional types will be considered - file '$typedefsfile': $!\n";
845
	$typeTypedefs .= '|' . $typeOtherTypedefs if (defined $typeOtherTypedefs);
846 847
}

848
sub build_types {
849 850
	my $mods = "(?x:  \n" . join("|\n  ", (@modifierList, @modifierListFile)) . "\n)";
	my $all = "(?x:  \n" . join("|\n  ", (@typeList, @typeListFile)) . "\n)";
851
	my $Misordered = "(?x:  \n" . join("|\n  ", @typeListMisordered) . "\n)";
852
	my $allWithAttr = "(?x:  \n" . join("|\n  ", @typeListWithAttr) . "\n)";
853
	$Modifier	= qr{(?:$Attribute|$Sparse|$mods)};
854 855 856 857
	$BasicType	= qr{
				(?:$typeTypedefs\b)|
				(?:${all}\b)
		}x;
858
	$NonptrType	= qr{
859
			(?:$Modifier\s+|const\s+)*
860
			(?:
861
				(?:typeof|__typeof__)\s*\([^\)]*\)|
862
				(?:$typeTypedefs\b)|
863
				(?:${all}\b)
864
			)
865
			(?:\s+$Modifier|\s+const)*
866
		  }x;
867 868 869 870 871 872 873
	$NonptrTypeMisordered	= qr{
			(?:$Modifier\s+|const\s+)*
			(?:
				(?:${Misordered}\b)
			)
			(?:\s+$Modifier|\s+const)*
		  }x;
874 875 876 877 878 879 880 881 882
	$NonptrTypeWithAttr	= qr{
			(?:$Modifier\s+|const\s+)*
			(?:
				(?:typeof|__typeof__)\s*\([^\)]*\)|
				(?:$typeTypedefs\b)|
				(?:${allWithAttr}\b)
			)
			(?:\s+$Modifier|\s+const)*
		  }x;
883
	$Type	= qr{
884
			$NonptrType
885
			(?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
886
			(?:\s+$Inline|\s+$Modifier)*
887
		  }x;
888 889
	$TypeMisordered	= qr{
			$NonptrTypeMisordered
890
			(?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
891 892
			(?:\s+$Inline|\s+$Modifier)*
		  }x;
893
	$Declare	= qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
894
	$DeclareMisordered	= qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
895 896
}
build_types();
897

898
our $Typecast	= qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
899 900 901 902 903 904

# Using $balanced_parens, $LvalOrFunc, or $FuncArg
# requires at least perl version v5.10.0
# Any use must be runtime checked with $^V

our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
905
our $LvalOrFunc	= qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
906
our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
907

908
our $declaration_macros = qr{(?x:
909
	(?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
910
	(?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
911
	(?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(
912 913
)};

914 915 916 917 918 919 920
our %allow_repeated_words = (
	add => '',
	added => '',
	bad => '',
	be => '',
);

921 922 923
sub deparenthesize {
	my ($string) = @_;
	return "" if (!defined($string));
924 925 926 927 928 929

	while ($string =~ /^\s*\(.*\)\s*$/) {
		$string =~ s@^\s*\(\s*@@;
		$string =~ s@\s*\)\s*$@@;
	}

930
	$string =~ s@\s+@ @g;
931

932 933 934
	return $string;
}

935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952
sub seed_camelcase_file {
	my ($file) = @_;

	return if (!(-f $file));

	local $/;

	open(my $include_file, '<', "$file")
	    or warn "$P: Can't read '$file' $!\n";
	my $text = <$include_file>;
	close($include_file);

	my @lines = split('\n', $text);

	foreach my $line (@lines) {
		next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
		if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
			$camelcase{$1} = 1;
953 954 955
		} elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
			$camelcase{$1} = 1;
		} elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
956 957 958 959 960
			$camelcase{$1} = 1;
		}
	}
}

961 962
our %maintained_status = ();

963 964 965
sub is_maintained_obsolete {
	my ($filename) = @_;

966
	return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
967

968 969 970
	if (!exists($maintained_status{$filename})) {
		$maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
	}
971

972
	return $maintained_status{$filename} =~ /obsolete/i;
973 974
}

975 976 977
sub is_SPDX_License_valid {
	my ($license) = @_;

978
	return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$gitroot"));
979

980 981
	my $root_path = abs_path($root);
	my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`;
982 983 984 985
	return 0 if ($status ne "");
	return 1;
}

986 987 988 989 990
my $camelcase_seeded = 0;
sub seed_camelcase_includes {
	return if ($camelcase_seeded);

	my $files;
991 992 993 994
	my $camelcase_cache = "";
	my @include_files = ();

	$camelcase_seeded = 1;
995

996
	if (-e "$gitroot") {
997
		my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
998
		chomp $git_last_include_commit;
999
		$camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
1000
	} else {
1001
		my $last_mod_date = 0;
1002
		$files = `find $root/include -name "*.h"`;
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021
		@include_files = split('\n', $files);
		foreach my $file (@include_files) {
			my $date = POSIX::strftime("%Y%m%d%H%M",
						   localtime((stat $file)[9]));
			$last_mod_date = $date if ($last_mod_date < $date);
		}
		$camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
	}

	if ($camelcase_cache ne "" && -f $camelcase_cache) {
		open(my $camelcase_file, '<', "$camelcase_cache")
		    or warn "$P: Can't read '$camelcase_cache' $!\n";
		while (<$camelcase_file>) {
			chomp;
			$camelcase{$_} = 1;
		}
		close($camelcase_file);

		return;
1022
	}
1023

1024
	if (-e "$gitroot") {
1025
		$files = `${git_command} ls-files "include/*.h"`;
1026 1027 1028
		@include_files = split('\n', $files);
	}

1029 1030 1031
	foreach my $file (@include_files) {
		seed_camelcase_file($file);
	}
1032

1033
	if ($camelcase_cache ne "") {
1034
		unlink glob ".checkpatch-camelcase.*";
1035 1036
		open(my $camelcase_file, '>', "$camelcase_cache")
		    or warn "$P: Can't write '$camelcase_cache' $!\n";
1037 1038 1039 1040 1041
		foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
			print $camelcase_file ("$_\n");
		}
		close($camelcase_file);
	}
1042 1043
}

1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
sub git_is_single_file {
	my ($filename) = @_;

	return 0 if ((which("git") eq "") || !(-e "$gitroot"));

	my $output = `${git_command} ls-files -- $filename 2>/dev/null`;
	my $count = $output =~ tr/\n//;
	return $count eq 1 && $output =~ m{^${filename}$};
}

1054 1055 1056
sub git_commit_info {
	my ($commit, $id, $desc) = @_;

1057
	return ($id, $desc) if ((which("git") eq "") || !(-e "$gitroot"));
1058

1059
	my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`;
1060 1061 1062
	$output =~ s/^\s*//gm;
	my @lines = split("\n", $output);

1063 1064
	return ($id, $desc) if ($#lines < 0);

1065
	if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) {
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
# Maybe one day convert this block of bash into something that returns
# all matching commit ids, but it's very slow...
#
#		echo "checking commits $1..."
#		git rev-list --remotes | grep -i "^$1" |
#		while read line ; do
#		    git log --format='%H %s' -1 $line |
#		    echo "commit $(cut -c 1-12,41-)"
#		done
	} elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
1076
		$id = undef;
1077 1078 1079 1080 1081 1082 1083 1084
	} else {
		$id = substr($lines[0], 0, 12);
		$desc = substr($lines[0], 41);
	}

	return ($id, $desc);
}

1085 1086
$chk_signoff = 0 if ($file);

1087
my @rawlines = ();
1088
my @lines = ();
1089
my @fixed = ();
1090 1091
my @fixed_inserted = ();
my @fixed_deleted = ();
1092 1093
my $fixlinenr = -1;

1094 1095
# If input is git commits, extract all commits from the commit expressions.
# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
1096
die "$P: No git repository found\n" if ($git && !-e "$gitroot");
1097 1098 1099

if ($git) {
	my @commits = ();
1100
	foreach my $commit_expr (@ARGV) {
1101
		my $git_range;
1102 1103
		if ($commit_expr =~ m/^(.*)-(\d+)$/) {
			$git_range = "-$2 $1";
1104 1105 1106
		} elsif ($commit_expr =~ m/\.\./) {
			$git_range = "$commit_expr";
		} else {
1107 1108
			$git_range = "-1 $commit_expr";
		}
1109
		my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
1110
		foreach my $line (split(/\n/, $lines)) {
1111 1112
			$line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
			next if (!defined($1) || !defined($2));
1113 1114 1115 1116
			my $sha1 = $1;
			my $subject = $2;
			unshift(@commits, $sha1);
			$git_commits{$sha1} = $subject;
1117 1118 1119 1120 1121 1122
		}
	}
	die "$P: no git commits after extraction!\n" if (@commits == 0);
	@ARGV = @commits;
}

1123
my $vname;
1124
$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"};
1125
for my $filename (@ARGV) {
1126
	my $FILE;
1127 1128 1129
	my $is_git_file = git_is_single_file($filename);
	my $oldfile = $file;
	$file = 1 if ($is_git_file);
1130 1131 1132 1133
	if ($git) {
		open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
			die "$P: $filename: git format-patch failed - $!\n";
	} elsif ($file) {
1134
		open($FILE, '-|', "diff -u /dev/null $filename") ||
1135
			die "$P: $filename: diff failed - $!\n";
1136 1137
	} elsif ($filename eq '-') {
		open($FILE, '<&STDIN');
1138
	} else {
1139
		open($FILE, '<', "$filename") ||
1140
			die "$P: $filename: open failed - $!\n";
1141
	}
1142 1143
	if ($filename eq '-') {
		$vname = 'Your patch';
1144
	} elsif ($git) {
1145
		$vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
1146 1147 1148
	} else {
		$vname = $filename;
	}
1149
	while (<$FILE>) {
1150 1151
		chomp;
		push(@rawlines, $_);
1152
		$vname = qq("$1") if ($filename eq '-' && $_ =~ m/^Subject:\s+(.+)/i);
1153
	}
1154
	close($FILE);
1155 1156 1157 1158 1159 1160 1161

	if ($#ARGV > 0 && $quiet == 0) {
		print '-' x length($vname) . "\n";
		print "$vname\n";
		print '-' x length($vname) . "\n";
	}

1162
	if (!process($filename)) {
1163 1164 1165
		$exit = 1;
	}
	@rawlines = ();
1166
	@lines = ();
1167
	@fixed = ();
1168 1169
	@fixed_inserted = ();
	@fixed_deleted = ();
1170
	$fixlinenr = -1;
1171 1172 1173
	@modifierListFile = ();
	@typeListFile = ();
	build_types();
1174
	$file = $oldfile if ($is_git_file);
1175 1176
}

1177
if (!$quiet) {
1178 1179 1180
	hash_show_words(\%use_type, "Used");
	hash_show_words(\%ignore_type, "Ignored");

1181
	if (!$perl_version_ok) {
1182 1183 1184
		print << "EOM"

NOTE: perl $^V is not modern enough to detect all possible issues.
1185
      An upgrade to at least perl $minimum_perl_version is suggested.
1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196
EOM
	}
	if ($exit) {
		print << "EOM"

NOTE: If any of the errors are false positives, please report
      them to the maintainer, see CHECKPATCH in MAINTAINERS.
EOM
	}
}

1197 1198 1199
exit($exit);

sub top_of_kernel_tree {
1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
	my ($root) = @_;

	my @tree_check = (
		"COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
		"README", "Documentation", "arch", "include", "drivers",
		"fs", "init", "ipc", "kernel", "lib", "scripts",
	);

	foreach my $check (@tree_check) {
		if (! -e $root . '/' . $check) {
			return 0;
		}
1212
	}
1213
	return 1;
1214
}
1215

1216 1217 1218 1219
sub parse_email {
	my ($formatted_email) = @_;

	my $name = "";
D
Dwaipayan Ray 已提交
1220
	my $quoted = "";
1221
	my $name_comment = "";
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234
	my $address = "";
	my $comment = "";

	if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
		$name = $1;
		$address = $2;
		$comment = $3 if defined $3;
	} elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
		$address = $1;
		$comment = $2 if defined $2;
	} elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
		$address = $1;
		$comment = $2 if defined $2;
1235
		$formatted_email =~ s/\Q$address\E.*$//;
1236
		$name = $formatted_email;
1237
		$name = trim($name);
1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251
		$name =~ s/^\"|\"$//g;
		# If there's a name left after stripping spaces and
		# leading quotes, and the address doesn't have both
		# leading and trailing angle brackets, the address
		# is invalid. ie:
		#   "joe smith joe@smith.com" bad
		#   "joe smith <joe@smith.com" bad
		if ($name ne "" && $address !~ /^<[^>]+>$/) {
			$name = "";
			$address = "";
			$comment = "";
		}
	}

D
Dwaipayan Ray 已提交
1252 1253 1254 1255 1256 1257 1258
	# Extract comments from names excluding quoted parts
	# "John D. (Doe)" - Do not extract
	if ($name =~ s/\"(.+)\"//) {
		$quoted = $1;
	}
	while ($name =~ s/\s*($balanced_parens)\s*/ /) {
		$name_comment .= trim($1);
1259
	}
D
Dwaipayan Ray 已提交
1260 1261 1262
	$name =~ s/^[ \"]+|[ \"]+$//g;
	$name = trim("$quoted $name");

1263
	$address = trim($address);
1264
	$address =~ s/^\<|\>$//g;
D
Dwaipayan Ray 已提交
1265
	$comment = trim($comment);
1266 1267 1268 1269 1270 1271

	if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
		$name =~ s/(?<!\\)"/\\"/g; ##escape quotes
		$name = "\"$name\"";
	}

1272
	return ($name, $name_comment, $address, $comment);
1273 1274 1275
}

sub format_email {
1276
	my ($name, $name_comment, $address, $comment) = @_;
1277 1278 1279

	my $formatted_email;

D
Dwaipayan Ray 已提交
1280
	$name =~ s/^[ \"]+|[ \"]+$//g;
1281
	$address = trim($address);
D
Dwaipayan Ray 已提交
1282
	$address =~ s/(?:\.|\,|\")+$//; ##trailing commas, dots or quotes
1283 1284 1285 1286 1287 1288

	if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
		$name =~ s/(?<!\\)"/\\"/g; ##escape quotes
		$name = "\"$name\"";
	}

D
Dwaipayan Ray 已提交
1289 1290 1291 1292 1293
	$name_comment = trim($name_comment);
	$name_comment = " $name_comment" if ($name_comment ne "");
	$comment = trim($comment);
	$comment = " $comment" if ($comment ne "");

1294 1295 1296
	if ("$name" eq "") {
		$formatted_email = "$address";
	} else {
1297
		$formatted_email = "$name$name_comment <$address>";
1298
	}
1299
	$formatted_email .= "$comment";
1300 1301 1302
	return $formatted_email;
}

1303 1304 1305 1306
sub reformat_email {
	my ($email) = @_;

	my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
1307
	return format_email($email_name, $name_comment, $email_address, $comment);
1308 1309 1310
}

sub same_email_addresses {
D
Dwaipayan Ray 已提交
1311
	my ($email1, $email2) = @_;
1312 1313 1314 1315 1316

	my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1);
	my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2);

	return $email1_name eq $email2_name &&
1317 1318 1319
	       $email1_address eq $email2_address &&
	       $name1_comment eq $name2_comment &&
	       $comment1 eq $comment2;
1320 1321
}

1322
sub which {
1323
	my ($bin) = @_;
1324

1325 1326 1327 1328
	foreach my $path (split(/:/, $ENV{PATH})) {
		if (-e "$path/$bin") {
			return "$path/$bin";
		}
1329 1330
	}

1331
	return "";
1332 1333
}

1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345
sub which_conf {
	my ($conf) = @_;

	foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
		if (-e "$path/$conf") {
			return "$path/$conf";
		}
	}

	return "";
}

1346 1347 1348 1349 1350 1351 1352 1353 1354
sub expand_tabs {
	my ($str) = @_;

	my $res = '';
	my $n = 0;
	for my $c (split(//, $str)) {
		if ($c eq "\t") {
			$res .= ' ';
			$n++;
1355
			for (; ($n % $tabsize) != 0; $n++) {
1356 1357 1358 1359 1360 1361 1362 1363 1364 1365
				$res .= ' ';
			}
			next;
		}
		$res .= $c;
		$n++;
	}

	return $res;
}
1366
sub copy_spacing {
1367
	(my $res = shift) =~ tr/\t/ /c;
1368 1369
	return $res;
}
1370

1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383
sub line_stats {
	my ($line) = @_;

	# Drop the diff line leader and expand tabs
	$line =~ s/^.//;
	$line = expand_tabs($line);

	# Pick the indent from the front of the line.
	my ($white) = ($line =~ /^(\s*)/);

	return (length($line), length($white));
}

1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394
my $sanitise_quote = '';

sub sanitise_line_reset {
	my ($in_comment) = @_;

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
1395 1396 1397 1398 1399 1400
sub sanitise_line {
	my ($line) = @_;

	my $res = '';
	my $l = '';

1401
	my $qlen = 0;
1402 1403
	my $off = 0;
	my $c;
1404

1405 1406 1407 1408 1409 1410
	# Always copy over the diff marker.
	$res = substr($line, 0, 1);

	for ($off = 1; $off < length($line); $off++) {
		$c = substr($line, $off, 1);

C
Claudio Fontana 已提交
1411
		# Comments we are whacking completely including the begin
1412 1413 1414 1415 1416 1417 1418
		# and end, all to $;.
		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
			$sanitise_quote = '*/';

			substr($res, $off, 2, "$;$;");
			$off++;
			next;
1419
		}
1420
		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
1421 1422 1423 1424
			$sanitise_quote = '';
			substr($res, $off, 2, "$;$;");
			$off++;
			next;
1425
		}
1426 1427 1428 1429 1430 1431 1432
		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
			$sanitise_quote = '//';

			substr($res, $off, 2, $sanitise_quote);
			$off++;
			next;
		}
1433 1434 1435 1436 1437 1438 1439

		# A \ in a string means ignore the next character.
		if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
		    $c eq "\\") {
			substr($res, $off, 2, 'XX');
			$off++;
			next;
1440
		}
1441 1442 1443 1444
		# Regular quotes.
		if ($c eq "'" || $c eq '"') {
			if ($sanitise_quote eq '') {
				$sanitise_quote = $c;
1445

1446 1447 1448 1449 1450 1451
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
1452

1453
		#print "c<$c> SQ<$sanitise_quote>\n";
1454 1455
		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
			substr($res, $off, 1, $;);
1456 1457
		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
			substr($res, $off, 1, $;);
1458 1459 1460 1461 1462
		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
			substr($res, $off, 1, 'X');
		} else {
			substr($res, $off, 1, $c);
		}
1463 1464
	}

1465 1466 1467 1468
	if ($sanitise_quote eq '//') {
		$sanitise_quote = '';
	}

1469
	# The pathname on a #include may be surrounded by '<' and '>'.
1470
	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
1471 1472 1473 1474
		my $clean = 'X' x length($1);
		$res =~ s@\<.*\>@<$clean>@;

	# The whole of a #error is a string.
1475
	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
1476
		my $clean = 'X' x length($1);
1477
		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
1478 1479
	}

1480 1481 1482 1483 1484
	if ($allow_c99_comments && $res =~ m@(//.*$)@) {
		my $match = $1;
		$res =~ s/\Q$match\E/"$;" x length($match)/e;
	}

1485 1486 1487
	return $res;
}

1488 1489 1490
sub get_quoted_string {
	my ($line, $rawline) = @_;

1491
	return "" if (!defined($line) || !defined($rawline));
1492
	return "" if ($line !~ m/($String)/g);
1493 1494 1495
	return substr($rawline, $-[0], $+[0] - $-[0]);
}

1496 1497 1498 1499 1500 1501
sub ctx_statement_block {
	my ($linenr, $remain, $off) = @_;
	my $line = $linenr - 1;
	my $blk = '';
	my $soff = $off;
	my $coff = $off - 1;
1502
	my $coff_set = 0;
1503

1504 1505
	my $loff = 0;

1506 1507
	my $type = '';
	my $level = 0;
1508
	my @stack = ();
1509
	my $p;
1510 1511
	my $c;
	my $len = 0;
1512 1513

	my $remainder;
1514
	while (1) {
1515 1516
		@stack = (['', 0]) if ($#stack == -1);

1517
		#warn "CSB: blk<$blk> remain<$remain>\n";
1518 1519 1520 1521
		# If we are about to drop off the end, pull in more
		# context.
		if ($off >= $len) {
			for (; $remain > 0; $line++) {
1522
				last if (!defined $lines[$line]);
1523
				next if ($lines[$line] =~ /^-/);
1524
				$remain--;
1525
				$loff = $len;
1526
				$blk .= $lines[$line] . "\n";
1527 1528 1529 1530 1531 1532
				$len = length($blk);
				$line++;
				last;
			}
			# Bail if there is no further context.
			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
1533
			if ($off >= $len) {
1534 1535
				last;
			}
1536 1537 1538 1539
			if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
				$level++;
				$type = '#';
			}
1540
		}
1541
		$p = $c;
1542
		$c = substr($blk, $off, 1);
1543
		$remainder = substr($blk, $off);
1544

1545
		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1546 1547 1548 1549 1550 1551 1552 1553 1554 1555

		# Handle nested #if/#else.
		if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
			push(@stack, [ $type, $level ]);
		} elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
			($type, $level) = @{$stack[$#stack - 1]};
		} elsif ($remainder =~ /^#\s*endif\b/) {
			($type, $level) = @{pop(@stack)};
		}

1556 1557 1558 1559 1560 1561
		# Statement ends at the ';' or a close '}' at the
		# outermost level.
		if ($level == 0 && $c eq ';') {
			last;
		}

1562
		# An else is really a conditional as long as its not else if
1563 1564 1565 1566 1567 1568 1569 1570
		if ($level == 0 && $coff_set == 0 &&
				(!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
				$remainder =~ /^(else)(?:\s|{)/ &&
				$remainder !~ /^else\s+if\b/) {
			$coff = $off + length($1) - 1;
			$coff_set = 1;
			#warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
			#warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1571 1572
		}

1573 1574 1575 1576 1577 1578 1579 1580 1581 1582
		if (($type eq '' || $type eq '(') && $c eq '(') {
			$level++;
			$type = '(';
		}
		if ($type eq '(' && $c eq ')') {
			$level--;
			$type = ($level != 0)? '(' : '';

			if ($level == 0 && $coff < $soff) {
				$coff = $off;
1583 1584
				$coff_set = 1;
				#warn "CSB: mark coff<$coff>\n";
1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595
			}
		}
		if (($type eq '' || $type eq '{') && $c eq '{') {
			$level++;
			$type = '{';
		}
		if ($type eq '{' && $c eq '}') {
			$level--;
			$type = ($level != 0)? '{' : '';

			if ($level == 0) {
1596 1597 1598
				if (substr($blk, $off + 1, 1) eq ';') {
					$off++;
				}
1599 1600 1601
				last;
			}
		}
1602 1603 1604 1605 1606 1607 1608
		# Preprocessor commands end at the newline unless escaped.
		if ($type eq '#' && $c eq "\n" && $p ne "\\") {
			$level--;
			$type = '';
			$off++;
			last;
		}
1609 1610
		$off++;
	}
1611
	# We are truly at the end, so shuffle to the next line.
1612
	if ($off == $len) {
1613
		$loff = $len + 1;
1614 1615 1616
		$line++;
		$remain--;
	}
1617 1618 1619 1620 1621 1622 1623

	my $statement = substr($blk, $soff, $off - $soff + 1);
	my $condition = substr($blk, $soff, $coff - $soff + 1);

	#warn "STATEMENT<$statement>\n";
	#warn "CONDITION<$condition>\n";

1624
	#print "coff<$coff> soff<$off> loff<$loff>\n";
1625 1626 1627 1628 1629

	return ($statement, $condition,
			$line, $remain + 1, $off - $loff + 1, $level);
}

1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672
sub statement_lines {
	my ($stmt) = @_;

	# Strip the diff line prefixes and rip blank lines at start and end.
	$stmt =~ s/(^|\n)./$1/g;
	$stmt =~ s/^\s*//;
	$stmt =~ s/\s*$//;

	my @stmt_lines = ($stmt =~ /\n/g);

	return $#stmt_lines + 2;
}

sub statement_rawlines {
	my ($stmt) = @_;

	my @stmt_lines = ($stmt =~ /\n/g);

	return $#stmt_lines + 2;
}

sub statement_block_size {
	my ($stmt) = @_;

	$stmt =~ s/(^|\n)./$1/g;
	$stmt =~ s/^\s*{//;
	$stmt =~ s/}\s*$//;
	$stmt =~ s/^\s*//;
	$stmt =~ s/\s*$//;

	my @stmt_lines = ($stmt =~ /\n/g);
	my @stmt_statements = ($stmt =~ /;/g);

	my $stmt_lines = $#stmt_lines + 2;
	my $stmt_statements = $#stmt_statements + 1;

	if ($stmt_lines > $stmt_statements) {
		return $stmt_lines;
	} else {
		return $stmt_statements;
	}
}

1673 1674 1675 1676 1677 1678
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

1679
	# Grab the first conditional/block pair.
1680 1681
	($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
1682
	#print "F: c<$condition> s<$statement> remain<$remain>\n";
1683 1684 1685 1686 1687 1688 1689
	push(@chunks, [ $condition, $statement ]);
	if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
		return ($level, $linenr, @chunks);
	}

	# Pull in the following conditional/block pairs and see if they
	# could continue the statement.
1690 1691 1692
	for (;;) {
		($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
1693
		#print "C: c<$condition> s<$statement> remain<$remain>\n";
1694
		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1695 1696
		#print "C: push\n";
		push(@chunks, [ $condition, $statement ]);
1697 1698 1699
	}

	return ($level, $linenr, @chunks);
1700 1701
}

1702
sub ctx_block_get {
1703
	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1704 1705 1706 1707 1708 1709 1710
	my $line;
	my $start = $linenr - 1;
	my $blk = '';
	my @o;
	my @c;
	my @res = ();

1711
	my $level = 0;
1712
	my @stack = ($level);
1713 1714 1715 1716 1717
	for ($line = $start; $remain > 0; $line++) {
		next if ($rawlines[$line] =~ /^-/);
		$remain--;

		$blk .= $rawlines[$line];
1718 1719

		# Handle nested #if/#else.
1720
		if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1721
			push(@stack, $level);
1722
		} elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1723
			$level = $stack[$#stack - 1];
1724
		} elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1725 1726 1727
			$level = pop(@stack);
		}

1728
		foreach my $c (split(//, $lines[$line])) {
1729 1730 1731 1732 1733
			##print "C<$c>L<$level><$open$close>O<$off>\n";
			if ($off > 0) {
				$off--;
				next;
			}
1734

1735 1736 1737 1738 1739 1740 1741
			if ($c eq $close && $level > 0) {
				$level--;
				last if ($level == 0);
			} elsif ($c eq $open) {
				$level++;
			}
		}
1742

1743
		if (!$outer || $level <= 1) {
1744
			push(@res, $rawlines[$line]);
1745 1746
		}

1747
		last if ($level == 0);
1748 1749
	}

1750
	return ($level, @res);
1751 1752 1753 1754
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

1755 1756
	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
	return @r;
1757 1758 1759 1760
}
sub ctx_block {
	my ($linenr, $remain) = @_;

1761 1762
	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
	return @r;
1763 1764
}
sub ctx_statement {
1765 1766 1767 1768 1769 1770
	my ($linenr, $remain, $off) = @_;

	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
	return @r;
}
sub ctx_block_level {
1771 1772
	my ($linenr, $remain) = @_;

1773
	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1774
}
1775 1776 1777 1778 1779
sub ctx_statement_level {
	my ($linenr, $remain, $off) = @_;

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
1780 1781 1782 1783

sub ctx_locate_comment {
	my ($first_line, $end_line) = @_;

1784 1785 1786 1787 1788 1789 1790 1791
	# If c99 comment on the current line, or the line before or after
	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@^\+.*(//.*$)@);
	return $current_comment if (defined $current_comment);
	($current_comment) = ($rawlines[$end_line - 2] =~ m@^[\+ ].*(//.*$)@);
	return $current_comment if (defined $current_comment);
	($current_comment) = ($rawlines[$end_line] =~ m@^[\+ ].*(//.*$)@);
	return $current_comment if (defined $current_comment);

1792
	# Catch a comment on the end of the line itself.
1793
	($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1794 1795 1796 1797 1798 1799 1800
	return $current_comment if (defined $current_comment);

	# Look through the context and try and figure out if there is a
	# comment.
	my $in_comment = 0;
	$current_comment = '';
	for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1801 1802
		my $line = $rawlines[$linenr - 1];
		#warn "           $line\n";
1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824
		if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
			$in_comment = 1;
		}
		if ($line =~ m@/\*@) {
			$in_comment = 1;
		}
		if (!$in_comment && $current_comment ne '') {
			$current_comment = '';
		}
		$current_comment .= $line . "\n" if ($in_comment);
		if ($line =~ m@\*/@) {
			$in_comment = 0;
		}
	}

	chomp($current_comment);
	return($current_comment);
}
sub ctx_has_comment {
	my ($first_line, $end_line) = @_;
	my $cmt = ctx_locate_comment($first_line, $end_line);

1825
	##print "LINE: $rawlines[$end_line - 1 ]\n";
1826 1827 1828 1829 1830
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846
sub raw_line {
	my ($linenr, $cnt) = @_;

	my $offset = $linenr - 1;
	$cnt++;

	my $line;
	while ($cnt) {
		$line = $rawlines[$offset++];
		next if (defined($line) && $line =~ /^-/);
		$cnt--;
	}

	return $line;
}

1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857
sub get_stat_real {
	my ($linenr, $lc) = @_;

	my $stat_real = raw_line($linenr, 0);
	for (my $count = $linenr + 1; $count <= $lc; $count++) {
		$stat_real = $stat_real . "\n" . raw_line($count, 0);
	}

	return $stat_real;
}

1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868
sub get_stat_here {
	my ($linenr, $cnt, $here) = @_;

	my $herectx = $here . "\n";
	for (my $n = 0; $n < $cnt; $n++) {
		$herectx .= raw_line($linenr, $n) . "\n";
	}

	return $herectx;
}

1869 1870 1871
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
1872

1873 1874 1875 1876 1877 1878
	$res = '';
	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
		$res .= $1;
		if ($2 ne '') {
			$coded = sprintf("^%c", unpack('C', $2) + 64);
			$res .= $coded;
1879 1880
		}
	}
1881
	$res =~ s/$/\$/;
1882

1883
	return $res;
1884 1885
}

1886
my $av_preprocessor = 0;
1887
my $av_pending;
1888
my @av_paren_type;
1889
my $av_pend_colon;
1890 1891 1892

sub annotate_reset {
	$av_preprocessor = 0;
1893 1894
	$av_pending = '_';
	@av_paren_type = ('E');
1895
	$av_pend_colon = 'O';
1896 1897
}

1898 1899
sub annotate_values {
	my ($stream, $type) = @_;
1900

1901
	my $res;
1902
	my $var = '_' x length($stream);
1903 1904
	my $cur = $stream;

1905
	print "$stream\n" if ($dbg_values > 1);
1906 1907

	while (length($cur)) {
1908
		@av_paren_type = ('E') if ($#av_paren_type < 0);
1909
		print " <" . join('', @av_paren_type) .
1910
				"> <$type> <$av_pending>" if ($dbg_values > 1);
1911
		if ($cur =~ /^(\s+)/o) {
1912 1913
			print "WS($1)\n" if ($dbg_values > 1);
			if ($1 =~ /\n/ && $av_preprocessor) {
1914
				$type = pop(@av_paren_type);
1915
				$av_preprocessor = 0;
1916 1917
			}

1918
		} elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1919 1920
			print "CAST($1)\n" if ($dbg_values > 1);
			push(@av_paren_type, $type);
1921
			$type = 'c';
1922

1923
		} elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1924
			print "DECLARE($1)\n" if ($dbg_values > 1);
1925 1926
			$type = 'T';

1927 1928 1929 1930
		} elsif ($cur =~ /^($Modifier)\s*/) {
			print "MODIFIER($1)\n" if ($dbg_values > 1);
			$type = 'T';

1931
		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1932
			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1933
			$av_preprocessor = 1;
1934 1935 1936 1937 1938 1939
			push(@av_paren_type, $type);
			if ($2 ne '') {
				$av_pending = 'N';
			}
			$type = 'E';

1940
		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1941 1942 1943
			print "UNDEF($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;
			push(@av_paren_type, $type);
1944

1945
		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1946
			print "PRE_START($1)\n" if ($dbg_values > 1);
1947
			$av_preprocessor = 1;
1948 1949 1950

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
1951
			$type = 'E';
1952

1953
		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1954 1955 1956 1957 1958
			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;

			push(@av_paren_type, $av_paren_type[$#av_paren_type]);

1959
			$type = 'E';
1960

1961
		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1962 1963 1964 1965 1966 1967 1968 1969
			print "PRE_END($1)\n" if ($dbg_values > 1);

			$av_preprocessor = 1;

			# Assume all arms of the conditional end as this
			# one does, and continue as if the #endif was not here.
			pop(@av_paren_type);
			push(@av_paren_type, $type);
1970
			$type = 'E';
1971 1972

		} elsif ($cur =~ /^(\\\n)/o) {
1973
			print "PRECONT($1)\n" if ($dbg_values > 1);
1974

1975 1976 1977 1978 1979
		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
			print "ATTR($1)\n" if ($dbg_values > 1);
			$av_pending = $type;
			$type = 'N';

1980
		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1981
			print "SIZEOF($1)\n" if ($dbg_values > 1);
1982
			if (defined $2) {
1983
				$av_pending = 'V';
1984 1985 1986
			}
			$type = 'N';

1987
		} elsif ($cur =~ /^(if|while|for)\b/o) {
1988
			print "COND($1)\n" if ($dbg_values > 1);
1989
			$av_pending = 'E';
1990 1991
			$type = 'N';

1992 1993 1994 1995 1996
		} elsif ($cur =~/^(case)/o) {
			print "CASE($1)\n" if ($dbg_values > 1);
			$av_pend_colon = 'C';
			$type = 'N';

1997
		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1998
			print "KEYWORD($1)\n" if ($dbg_values > 1);
1999 2000 2001
			$type = 'N';

		} elsif ($cur =~ /^(\()/o) {
2002
			print "PAREN('$1')\n" if ($dbg_values > 1);
2003 2004
			push(@av_paren_type, $av_pending);
			$av_pending = '_';
2005 2006 2007
			$type = 'N';

		} elsif ($cur =~ /^(\))/o) {
2008 2009 2010
			my $new_type = pop(@av_paren_type);
			if ($new_type ne '_') {
				$type = $new_type;
2011 2012
				print "PAREN('$1') -> $type\n"
							if ($dbg_values > 1);
2013
			} else {
2014
				print "PAREN('$1')\n" if ($dbg_values > 1);
2015 2016
			}

2017
		} elsif ($cur =~ /^($Ident)\s*\(/o) {
2018
			print "FUNC($1)\n" if ($dbg_values > 1);
2019
			$type = 'V';
2020
			$av_pending = 'V';
2021

2022 2023
		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
			if (defined $2 && $type eq 'C' || $type eq 'T') {
2024
				$av_pend_colon = 'B';
2025 2026
			} elsif ($type eq 'E') {
				$av_pend_colon = 'L';
2027 2028 2029 2030
			}
			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
			$type = 'V';

2031
		} elsif ($cur =~ /^($Ident|$Constant)/o) {
2032
			print "IDENT($1)\n" if ($dbg_values > 1);
2033 2034 2035
			$type = 'V';

		} elsif ($cur =~ /^($Assignment)/o) {
2036
			print "ASSIGN($1)\n" if ($dbg_values > 1);
2037 2038
			$type = 'N';

2039
		} elsif ($cur =~/^(;|{|})/) {
2040
			print "END($1)\n" if ($dbg_values > 1);
2041
			$type = 'E';
2042 2043
			$av_pend_colon = 'O';

2044 2045 2046 2047
		} elsif ($cur =~/^(,)/) {
			print "COMMA($1)\n" if ($dbg_values > 1);
			$type = 'C';

2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061
		} elsif ($cur =~ /^(\?)/o) {
			print "QUESTION($1)\n" if ($dbg_values > 1);
			$type = 'N';

		} elsif ($cur =~ /^(:)/o) {
			print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);

			substr($var, length($res), 1, $av_pend_colon);
			if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
				$type = 'E';
			} else {
				$type = 'N';
			}
			$av_pend_colon = 'O';
2062

2063
		} elsif ($cur =~ /^(\[)/o) {
2064
			print "CLOSE($1)\n" if ($dbg_values > 1);
2065 2066
			$type = 'N';

2067
		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079
			my $variant;

			print "OPV($1)\n" if ($dbg_values > 1);
			if ($type eq 'V') {
				$variant = 'B';
			} else {
				$variant = 'U';
			}

			substr($var, length($res), 1, $variant);
			$type = 'N';

2080
		} elsif ($cur =~ /^($Operators)/o) {
2081
			print "OP($1)\n" if ($dbg_values > 1);
2082 2083 2084 2085 2086
			if ($1 ne '++' && $1 ne '--') {
				$type = 'N';
			}

		} elsif ($cur =~ /(^.)/o) {
2087
			print "C($1)\n" if ($dbg_values > 1);
2088 2089 2090 2091 2092
		}
		if (defined $1) {
			$cur = substr($cur, length($1));
			$res .= $type x length($1);
		}
2093
	}
2094

2095
	return ($res, $var);
2096 2097
}

2098
sub possible {
2099
	my ($possible, $line) = @_;
2100
	my $notPermitted = qr{(?:
2101 2102 2103 2104
		^(?:
			$Modifier|
			$Storage|
			$Type|
2105 2106 2107
			DEFINE_\S+
		)$|
		^(?:
2108 2109 2110 2111 2112
			goto|
			return|
			case|
			else|
			asm|__asm__|
2113 2114 2115
			do|
			\#|
			\#\#|
2116
		)(?:\s|$)|
2117
		^(?:typedef|struct|enum)\b
2118 2119 2120
	    )}x;
	warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
	if ($possible !~ $notPermitted) {
2121 2122 2123 2124 2125 2126 2127
		# Check for modifiers.
		$possible =~ s/\s*$Storage\s*//g;
		$possible =~ s/\s*$Sparse\s*//g;
		if ($possible =~ /^\s*$/) {

		} elsif ($possible =~ /\s/) {
			$possible =~ s/\s*$Type\s*//g;
2128
			for my $modifier (split(' ', $possible)) {
2129 2130
				if ($modifier !~ $notPermitted) {
					warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
2131
					push(@modifierListFile, $modifier);
2132
				}
2133
			}
2134 2135 2136

		} else {
			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
2137
			push(@typeListFile, $possible);
2138
		}
2139
		build_types();
2140 2141
	} else {
		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
2142 2143 2144
	}
}

2145 2146
my $prefix = '';

2147
sub show_type {
2148
	my ($type) = @_;
2149

2150 2151
	$type =~ tr/[a-z]/[A-Z]/;

2152 2153 2154
	return defined $use_type{$type} if (scalar keys %use_type > 0);

	return !defined $ignore_type{$type};
2155 2156
}

2157
sub report {
2158 2159 2160 2161
	my ($level, $type, $msg) = @_;

	if (!show_type($type) ||
	    (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
2162 2163
		return 0;
	}
2164
	my $output = '';
2165
	if ($color) {
2166 2167 2168 2169 2170 2171 2172 2173 2174
		if ($level eq 'ERROR') {
			$output .= RED;
		} elsif ($level eq 'WARNING') {
			$output .= YELLOW;
		} else {
			$output .= GREEN;
		}
	}
	$output .= $prefix . $level . ':';
2175
	if ($show_types) {
2176
		$output .= BLUE if ($color);
2177
		$output .= "$type:";
2178
	}
2179
	$output .= RESET if ($color);
2180
	$output .= ' ' . $msg . "\n";
2181 2182 2183 2184 2185 2186

	if ($showfile) {
		my @lines = split("\n", $output, -1);
		splice(@lines, 1, 1);
		$output = join("\n", @lines);
	}
2187
	$output = (split('\n', $output))[0] . "\n" if ($terse);
2188

2189
	push(our @report, $output);
2190 2191

	return 1;
2192
}
2193

2194
sub report_dump {
2195
	our @report;
2196
}
2197

2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229
sub fixup_current_range {
	my ($lineRef, $offset, $length) = @_;

	if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
		my $o = $1;
		my $l = $2;
		my $no = $o + $offset;
		my $nl = $l + $length;
		$$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
	}
}

sub fix_inserted_deleted_lines {
	my ($linesRef, $insertedRef, $deletedRef) = @_;

	my $range_last_linenr = 0;
	my $delta_offset = 0;

	my $old_linenr = 0;
	my $new_linenr = 0;

	my $next_insert = 0;
	my $next_delete = 0;

	my @lines = ();

	my $inserted = @{$insertedRef}[$next_insert++];
	my $deleted = @{$deletedRef}[$next_delete++];

	foreach my $old_line (@{$linesRef}) {
		my $save_line = 1;
		my $line = $old_line;	#don't modify the array
2230
		if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) {	#new filename
2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260
			$delta_offset = 0;
		} elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) {	#new hunk
			$range_last_linenr = $new_linenr;
			fixup_current_range(\$line, $delta_offset, 0);
		}

		while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
			$deleted = @{$deletedRef}[$next_delete++];
			$save_line = 0;
			fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
		}

		while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
			push(@lines, ${$inserted}{'LINE'});
			$inserted = @{$insertedRef}[$next_insert++];
			$new_linenr++;
			fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
		}

		if ($save_line) {
			push(@lines, $line);
			$new_linenr++;
		}

		$old_linenr++;
	}

	return @lines;
}

2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281
sub fix_insert_line {
	my ($linenr, $line) = @_;

	my $inserted = {
		LINENR => $linenr,
		LINE => $line,
	};
	push(@fixed_inserted, $inserted);
}

sub fix_delete_line {
	my ($linenr, $line) = @_;

	my $deleted = {
		LINENR => $linenr,
		LINE => $line,
	};

	push(@fixed_deleted, $deleted);
}

2282
sub ERROR {
2283 2284 2285
	my ($type, $msg) = @_;

	if (report("ERROR", $type, $msg)) {
2286 2287
		our $clean = 0;
		our $cnt_error++;
2288
		return 1;
2289
	}
2290
	return 0;
2291 2292
}
sub WARN {
2293 2294 2295
	my ($type, $msg) = @_;

	if (report("WARNING", $type, $msg)) {
2296 2297
		our $clean = 0;
		our $cnt_warn++;
2298
		return 1;
2299
	}
2300
	return 0;
2301 2302
}
sub CHK {
2303 2304 2305
	my ($type, $msg) = @_;

	if ($check && report("CHECK", $type, $msg)) {
2306 2307
		our $clean = 0;
		our $cnt_chk++;
2308
		return 1;
2309
	}
2310
	return 0;
2311 2312
}

2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335
sub check_absolute_file {
	my ($absolute, $herecurr) = @_;
	my $file = $absolute;

	##print "absolute<$absolute>\n";

	# See if any suffix of this path is a path within the tree.
	while ($file =~ s@^[^/]*/@@) {
		if (-f "$root/$file") {
			##print "file<$file>\n";
			last;
		}
	}
	if (! -f _)  {
		return 0;
	}

	# It is, so see if the prefix is acceptable.
	my $prefix = $absolute;
	substr($prefix, -length($file)) = '';

	##print "prefix<$prefix>\n";
	if ($prefix ne ".../") {
2336 2337
		WARN("USE_RELATIVE_PATH",
		     "use relative pathname instead of absolute in changelog text\n" . $herecurr);
2338 2339 2340
	}
}

2341 2342 2343
sub trim {
	my ($string) = @_;

2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360
	$string =~ s/^\s+|\s+$//g;

	return $string;
}

sub ltrim {
	my ($string) = @_;

	$string =~ s/^\s+//;

	return $string;
}

sub rtrim {
	my ($string) = @_;

	$string =~ s/\s+$//;
2361 2362 2363 2364

	return $string;
}

2365 2366 2367 2368 2369 2370 2371 2372
sub string_find_replace {
	my ($string, $find, $replace) = @_;

	$string =~ s/$find/$replace/g;

	return $string;
}

2373 2374 2375
sub tabify {
	my ($leading) = @_;

2376
	my $source_indent = $tabsize;
2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387
	my $max_spaces_before_tab = $source_indent - 1;
	my $spaces_to_tab = " " x $source_indent;

	#convert leading spaces to tabs
	1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
	#Remove spaces before a tab
	1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;

	return "$leading";
}

2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414
sub pos_last_openparen {
	my ($line) = @_;

	my $pos = 0;

	my $opens = $line =~ tr/\(/\(/;
	my $closes = $line =~ tr/\)/\)/;

	my $last_openparen = 0;

	if (($opens == 0) || ($closes >= $opens)) {
		return -1;
	}

	my $len = length($line);

	for ($pos = 0; $pos < $len; $pos++) {
		my $string = substr($line, $pos);
		if ($string =~ /^($FuncArg|$balanced_parens)/) {
			$pos += length($1) - 1;
		} elsif (substr($line, $pos, 1) eq '(') {
			$last_openparen = $pos;
		} elsif (index($string, '(') == -1) {
			last;
		}
	}

2415
	return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
2416 2417
}

2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430
sub get_raw_comment {
	my ($line, $rawline) = @_;
	my $comment = '';

	for my $i (0 .. (length($line) - 1)) {
		if (substr($line, $i, 1) eq "$;") {
			$comment .= substr($rawline, $i, 1);
		}
	}

	return $comment;
}

2431 2432 2433 2434 2435
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
2436
	my $prevrawline="";
2437
	my $stashline="";
2438
	my $stashrawline="";
2439

2440
	my $length;
2441 2442 2443 2444
	my $indent;
	my $previndent=0;
	my $stashindent=0;

2445
	our $clean = 1;
2446
	my $signoff = 0;
2447 2448
	my $author = '';
	my $authorsignoff = 0;
2449
	my $author_sob = '';
2450
	my $is_patch = 0;
2451
	my $is_binding_patch = -1;
2452
	my $in_header_lines = $file ? 0 : 1;
2453
	my $in_commit_log = 0;		#Scanning lines before patch
2454
	my $has_patch_separator = 0;	#Found a --- line
2455
	my $has_commit_log = 0;		#Encountered lines before patch
2456
	my $commit_log_lines = 0;	#Number of commit log lines
2457
	my $commit_log_possible_stack_dump = 0;
2458
	my $commit_log_long_line = 0;
2459
	my $commit_log_has_diff = 0;
2460
	my $reported_maintainer_file = 0;
2461 2462
	my $non_utf8_charset = 0;

2463
	my $last_blank_line = 0;
2464
	my $last_coalesced_string_linenr = -1;
2465

2466
	our @report = ();
2467 2468 2469 2470 2471
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

2472 2473 2474 2475 2476
	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
2477
	my $context_function;		#undef'd unless there's a known function
2478
	my $in_comment = 0;
2479
	my $comment_edge = 0;
2480
	my $first_line = 0;
2481
	my $p1_prefix = '';
2482

2483 2484 2485
	my $prev_values = 'E';

	# suppression flags
2486
	my %suppress_ifbraces;
2487
	my %suppress_whiletrailers;
2488
	my %suppress_export;
2489
	my $suppress_statement = 0;
2490

2491
	my %signatures = ();
2492

2493
	# Pre-scan the patch sanitizing the lines.
2494
	# Pre-scan the patch looking for any __setup documentation.
2495
	#
2496 2497
	my @setup_docs = ();
	my $setup_docs = 0;
2498

2499 2500
	my $camelcase_file_seeded = 0;

2501 2502
	my $checklicenseline = 1;

2503
	sanitise_line_reset();
2504 2505
	my $line;
	foreach my $rawline (@rawlines) {
2506 2507
		$linenr++;
		$line = $rawline;
2508

2509 2510
		push(@fixed, $rawline) if ($fix);

2511
		if ($rawline=~/^\+\+\+\s+(\S+)/) {
2512
			$setup_docs = 0;
2513
			if ($1 =~ m@Documentation/admin-guide/kernel-parameters.txt$@) {
2514 2515
				$setup_docs = 1;
			}
2516 2517
			#next;
		}
2518
		if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2519 2520 2521 2522 2523 2524
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
2525
			$in_comment = 0;
2526 2527 2528 2529 2530 2531

			# Guestimate if this is a continuing comment.  Run
			# the context looking for a comment "edge".  If this
			# edge is a close comment then we must be in a comment
			# at context start.
			my $edge;
2532 2533 2534 2535 2536 2537
			my $cnt = $realcnt;
			for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
				next if (defined $rawlines[$ln - 1] &&
					 $rawlines[$ln - 1] =~ /^-/);
				$cnt--;
				#print "RAW<$rawlines[$ln - 1]>\n";
2538
				last if (!defined $rawlines[$ln - 1]);
2539 2540 2541 2542 2543
				if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
				    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
					($edge) = $1;
					last;
				}
2544 2545 2546 2547 2548 2549 2550 2551 2552
			}
			if (defined $edge && $edge eq '*/') {
				$in_comment = 1;
			}

			# Guestimate if this is a continuing comment.  If this
			# is the start of a diff block and this line starts
			# ' *' then it is very likely a comment.
			if (!defined $edge &&
2553
			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
2554 2555 2556 2557 2558 2559 2560
			{
				$in_comment = 1;
			}

			##print "COMMENT:$in_comment edge<$edge> $rawline\n";
			sanitise_line_reset($in_comment);

2561
		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2562
			# Standardise the strings and chars within the input to
2563
			# simplify matching -- only bother with positive lines.
2564
			$line = sanitise_line($rawline);
2565
		}
2566 2567 2568 2569 2570 2571 2572 2573 2574 2575
		push(@lines, $line);

		if ($realcnt > 1) {
			$realcnt-- if ($line =~ /^(?:\+| |$)/);
		} else {
			$realcnt = 0;
		}

		#print "==>$rawline\n";
		#print "-->$line\n";
2576 2577 2578 2579 2580 2581

		if ($setup_docs && $line =~ /^\+/) {
			push(@setup_docs, $line);
		}
	}

2582 2583
	$prefix = '';

2584 2585
	$realcnt = 0;
	$linenr = 0;
2586
	$fixlinenr = -1;
2587 2588
	foreach my $line (@lines) {
		$linenr++;
2589
		$fixlinenr++;
2590 2591
		my $sline = $line;	#copy of $line
		$sline =~ s/$;/ /g;	#with comments as spaces
2592

2593
		my $rawline = $rawlines[$linenr - 1];
2594
		my $raw_comment = get_raw_comment($line, $rawline);
2595

2596 2597 2598 2599 2600 2601 2602 2603
# check if it's a mode change, rename or start of a patch
		if (!$in_commit_log &&
		    ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ ||
		    ($line =~ /^rename (?:from|to) \S+\s*$/ ||
		     $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) {
			$is_patch = 1;
		}

2604
#extract the line range in the file after the patch is applied
2605
		if (!$in_commit_log &&
2606 2607
		    $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
			my $context = $4;
2608
			$is_patch = 1;
2609
			$first_line = $linenr + 1;
2610 2611 2612 2613 2614 2615
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
2616
			annotate_reset();
2617 2618
			$prev_values = 'E';

2619
			%suppress_ifbraces = ();
2620
			%suppress_whiletrailers = ();
2621
			%suppress_export = ();
2622
			$suppress_statement = 0;
2623 2624 2625 2626 2627
			if ($context =~ /\b(\w+)\s*\(/) {
				$context_function = $1;
			} else {
				undef $context_function;
			}
2628 2629
			next;

2630 2631 2632
# track the line number as we move through the hunk, note that
# new versions of GNU diff omit the leading space on completely
# blank context lines so we need to count that too.
2633
		} elsif ($line =~ /^( |\+|$)/) {
2634
			$realline++;
2635
			$realcnt-- if ($realcnt != 0);
2636

2637
			# Measure the line length and indent.
2638
			($length, $indent) = line_stats($rawline);
2639 2640 2641 2642

			# Track the previous line.
			($prevline, $stashline) = ($stashline, $line);
			($previndent, $stashindent) = ($stashindent, $indent);
2643 2644
			($prevrawline, $stashrawline) = ($stashrawline, $rawline);

2645
			#warn "line<$line>\n";
2646

2647 2648
		} elsif ($realcnt == 1) {
			$realcnt--;
2649 2650
		}

2651 2652
		my $hunk_line = ($realcnt != 0);

2653 2654
		$here = "#$linenr: " if (!$file);
		$here = "#$realline: " if ($file);
2655

2656
		my $found_file = 0;
2657
		# extract the filename as it passes
2658 2659
		if ($line =~ /^diff --git.*?(\S+)$/) {
			$realfile = $1;
2660
			$realfile =~ s@^([^/]*)/@@ if (!$file);
2661
			$in_commit_log = 0;
2662
			$found_file = 1;
2663
		} elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2664
			$realfile = $1;
2665
			$realfile =~ s@^([^/]*)/@@ if (!$file);
2666
			$in_commit_log = 0;
2667 2668

			$p1_prefix = $1;
2669 2670
			if (!$file && $tree && $p1_prefix ne '' &&
			    -e "$root/$p1_prefix") {
2671 2672
				WARN("PATCH_PREFIX",
				     "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2673
			}
2674

2675
			if ($realfile =~ m@^include/asm/@) {
2676 2677
				ERROR("MODIFIED_INCLUDE_ASM",
				      "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2678
			}
2679 2680 2681
			$found_file = 1;
		}

2682 2683 2684 2685
#make up the handle for any error we report on this line
		if ($showfile) {
			$prefix = "$realfile:$realline: "
		} elsif ($emacs) {
2686 2687 2688 2689 2690
			if ($file) {
				$prefix = "$filename:$realline: ";
			} else {
				$prefix = "$filename:$linenr: ";
			}
2691 2692
		}

2693
		if ($found_file) {
2694 2695 2696 2697
			if (is_maintained_obsolete($realfile)) {
				WARN("OBSOLETE",
				     "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy.  No unnecessary modifications please.\n");
			}
2698
			if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
2699 2700 2701 2702
				$check = 1;
			} else {
				$check = $check_orig;
			}
2703
			$checklicenseline = 1;
2704 2705 2706 2707 2708 2709 2710 2711 2712

			if ($realfile !~ /^MAINTAINERS/) {
				my $last_binding_patch = $is_binding_patch;

				$is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@;

				if (($last_binding_patch != -1) &&
				    ($last_binding_patch ^ $is_binding_patch)) {
					WARN("DT_SPLIT_BINDING_PATCH",
2713
					     "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n");
2714 2715 2716
				}
			}

2717 2718 2719
			next;
		}

2720
		$here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2721

2722 2723 2724
		my $hereline = "$here\n$rawline\n";
		my $herecurr = "$here\n$rawline\n";
		my $hereprev = "$here\n$prevrawline\n$rawline\n";
2725

2726 2727
		$cnt_lines++ if ($realcnt != 0);

2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739
# Verify the existence of a commit log if appropriate
# 2 is used because a $signature is counted in $commit_log_lines
		if ($in_commit_log) {
			if ($line !~ /^\s*$/) {
				$commit_log_lines++;	#could be a $signature
			}
		} elsif ($has_commit_log && $commit_log_lines < 2) {
			WARN("COMMIT_MESSAGE",
			     "Missing commit description - Add an appropriate one\n");
			$commit_log_lines = 2;	#warn only once
		}

2740 2741
# Check if the commit log has what seems like a diff which can confuse patch
		if ($in_commit_log && !$commit_log_has_diff &&
2742 2743
		    (($line =~ m@^\s+diff\b.*a/([\w/]+)@ &&
		      $line =~ m@^\s+diff\b.*a/[\w/]+\s+b/$1\b@) ||
2744 2745 2746 2747 2748 2749 2750
		     $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
		     $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
			ERROR("DIFF_IN_COMMIT_MSG",
			      "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
			$commit_log_has_diff = 1;
		}

2751 2752 2753
# Check for incorrect file permissions
		if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
			my $permhere = $here . "FILE: $realfile\n";
2754 2755
			if ($realfile !~ m@scripts/@ &&
			    $realfile !~ /\.(py|pl|awk|sh)$/) {
2756 2757
				ERROR("EXECUTE_PERMISSIONS",
				      "do not set execute permissions for source files\n" . $permhere);
2758 2759 2760
			}
		}

2761 2762 2763
# Check the patch for a From:
		if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) {
			$author = $1;
2764 2765 2766 2767
			my $curline = $linenr;
			while(defined($rawlines[$curline]) && ($rawlines[$curline++] =~ /^[ \t]\s*(.*)/)) {
				$author .= $1;
			}
2768 2769
			$author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i);
			$author =~ s/"//g;
2770
			$author = reformat_email($author);
2771 2772
		}

2773
# Check the patch for a signoff:
2774
		if ($line =~ /^\s*signed-off-by:\s*(.*)/i) {
2775
			$signoff++;
2776
			$in_commit_log = 0;
2777
			if ($author ne ''  && $authorsignoff != 1) {
D
Dwaipayan Ray 已提交
2778
				if (same_email_addresses($1, $author)) {
2779
					$authorsignoff = 1;
2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807
				} else {
					my $ctx = $1;
					my ($email_name, $email_comment, $email_address, $comment1) = parse_email($ctx);
					my ($author_name, $author_comment, $author_address, $comment2) = parse_email($author);

					if ($email_address eq $author_address && $email_name eq $author_name) {
						$author_sob = $ctx;
						$authorsignoff = 2;
					} elsif ($email_address eq $author_address) {
						$author_sob = $ctx;
						$authorsignoff = 3;
					} elsif ($email_name eq $author_name) {
						$author_sob = $ctx;
						$authorsignoff = 4;

						my $address1 = $email_address;
						my $address2 = $author_address;

						if ($address1 =~ /(\S+)\+\S+(\@.*)/) {
							$address1 = "$1$2";
						}
						if ($address2 =~ /(\S+)\+\S+(\@.*)/) {
							$address2 = "$1$2";
						}
						if ($address1 eq $address2) {
							$authorsignoff = 5;
						}
					}
2808 2809
				}
			}
2810 2811
		}

2812 2813 2814 2815 2816 2817
# Check for patch separator
		if ($line =~ /^---$/) {
			$has_patch_separator = 1;
			$in_commit_log = 0;
		}

2818 2819 2820 2821 2822 2823
# Check if MAINTAINERS is being updated.  If so, there's probably no need to
# emit the "does MAINTAINERS need updating?" message on file add/move/delete
		if ($line =~ /^\s*MAINTAINERS\s*\|/) {
			$reported_maintainer_file = 1;
		}

2824
# Check signature styles
2825
		if (!$in_header_lines &&
2826
		    $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2827 2828 2829 2830 2831 2832
			my $space_before = $1;
			my $sign_off = $2;
			my $space_after = $3;
			my $email = $4;
			my $ucfirst_sign_off = ucfirst(lc($sign_off));

2833
			if ($sign_off !~ /$signature_tags/) {
2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844
				my $suggested_signature = find_standard_signature($sign_off);
				if ($suggested_signature eq "") {
					WARN("BAD_SIGN_OFF",
					     "Non-standard signature: $sign_off\n" . $herecurr);
				} else {
					if (WARN("BAD_SIGN_OFF",
						 "Non-standard signature: '$sign_off' - perhaps '$suggested_signature'?\n" . $herecurr) &&
					    $fix) {
						$fixed[$fixlinenr] =~ s/$sign_off/$suggested_signature/;
					}
				}
2845
			}
2846
			if (defined $space_before && $space_before ne "") {
2847 2848 2849
				if (WARN("BAD_SIGN_OFF",
					 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
				    $fix) {
2850
					$fixed[$fixlinenr] =
2851 2852
					    "$ucfirst_sign_off $email";
				}
2853 2854
			}
			if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2855 2856 2857
				if (WARN("BAD_SIGN_OFF",
					 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
				    $fix) {
2858
					$fixed[$fixlinenr] =
2859 2860 2861
					    "$ucfirst_sign_off $email";
				}

2862 2863
			}
			if (!defined $space_after || $space_after ne " ") {
2864 2865 2866
				if (WARN("BAD_SIGN_OFF",
					 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
				    $fix) {
2867
					$fixed[$fixlinenr] =
2868 2869
					    "$ucfirst_sign_off $email";
				}
2870
			}
2871

2872
			my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
2873
			my $suggested_email = format_email(($email_name, $name_comment, $email_address, $comment));
2874
			if ($suggested_email eq "") {
2875 2876
				ERROR("BAD_SIGN_OFF",
				      "Unrecognized email address: '$email'\n" . $herecurr);
2877 2878 2879 2880 2881 2882
			} else {
				my $dequoted = $suggested_email;
				$dequoted =~ s/^"//;
				$dequoted =~ s/" </ </;
				# Don't force email to have quotes
				# Allow just an angle bracketed address
D
Dwaipayan Ray 已提交
2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904
				if (!same_email_addresses($email, $suggested_email)) {
					if (WARN("BAD_SIGN_OFF",
						 "email address '$email' might be better as '$suggested_email'\n" . $herecurr) &&
					    $fix) {
						$fixed[$fixlinenr] =~ s/\Q$email\E/$suggested_email/;
					}
				}

				# Address part shouldn't have comments
				my $stripped_address = $email_address;
				$stripped_address =~ s/\([^\(\)]*\)//g;
				if ($email_address ne $stripped_address) {
					if (WARN("BAD_SIGN_OFF",
						 "address part of email should not have comments: '$email_address'\n" . $herecurr) &&
					    $fix) {
						$fixed[$fixlinenr] =~ s/\Q$email_address\E/$stripped_address/;
					}
				}

				# Only one name comment should be allowed
				my $comment_count = () = $name_comment =~ /\([^\)]+\)/g;
				if ($comment_count > 1) {
2905
					WARN("BAD_SIGN_OFF",
D
Dwaipayan Ray 已提交
2906 2907 2908 2909 2910
					     "Use a single name comment in email: '$email'\n" . $herecurr);
				}


				# stable@vger.kernel.org or stable@kernel.org shouldn't
2911
				# have an email name. In addition comments should strictly
D
Dwaipayan Ray 已提交
2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953
				# begin with a #
				if ($email =~ /^.*stable\@(?:vger\.)?kernel\.org/i) {
					if (($comment ne "" && $comment !~ /^#.+/) ||
					    ($email_name ne "")) {
						my $cur_name = $email_name;
						my $new_comment = $comment;
						$cur_name =~ s/[a-zA-Z\s\-\"]+//g;

						# Remove brackets enclosing comment text
						# and # from start of comments to get comment text
						$new_comment =~ s/^\((.*)\)$/$1/;
						$new_comment =~ s/^\[(.*)\]$/$1/;
						$new_comment =~ s/^[\s\#]+|\s+$//g;

						$new_comment = trim("$new_comment $cur_name") if ($cur_name ne $new_comment);
						$new_comment = " # $new_comment" if ($new_comment ne "");
						my $new_email = "$email_address$new_comment";

						if (WARN("BAD_STABLE_ADDRESS_STYLE",
							 "Invalid email format for stable: '$email', prefer '$new_email'\n" . $herecurr) &&
						    $fix) {
							$fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/;
						}
					}
				} elsif ($comment ne "" && $comment !~ /^(?:#.+|\(.+\))$/) {
					my $new_comment = $comment;

					# Extract comment text from within brackets or
					# c89 style /*...*/ comments
					$new_comment =~ s/^\[(.*)\]$/$1/;
					$new_comment =~ s/^\/\*(.*)\*\/$/$1/;

					$new_comment = trim($new_comment);
					$new_comment =~ s/^[^\w]$//; # Single lettered comment with non word character is usually a typo
					$new_comment = "($new_comment)" if ($new_comment ne "");
					my $new_email = format_email($email_name, $name_comment, $email_address, $new_comment);

					if (WARN("BAD_SIGN_OFF",
						 "Unexpected content after email: '$email', should be: '$new_email'\n" . $herecurr) &&
					    $fix) {
						$fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/;
					}
2954
				}
2955
			}
2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966

# Check for duplicate signatures
			my $sig_nospace = $line;
			$sig_nospace =~ s/\s//g;
			$sig_nospace = lc($sig_nospace);
			if (defined $signatures{$sig_nospace}) {
				WARN("BAD_SIGN_OFF",
				     "Duplicate signature\n" . $herecurr);
			} else {
				$signatures{$sig_nospace} = 1;
			}
2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984

# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
			if ($sign_off =~ /^co-developed-by:$/i) {
				if ($email eq $author) {
					WARN("BAD_SIGN_OFF",
					      "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
				}
				if (!defined $lines[$linenr]) {
					WARN("BAD_SIGN_OFF",
                                             "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline);
				} elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) {
					WARN("BAD_SIGN_OFF",
					     "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
				} elsif ($1 ne $email) {
					WARN("BAD_SIGN_OFF",
					     "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
				}
			}
2985 2986
		}

2987 2988 2989 2990 2991 2992 2993
# Check email subject for common tools that don't need to be mentioned
		if ($in_header_lines &&
		    $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
			WARN("EMAIL_SUBJECT",
			     "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
		}

2994 2995
# Check for Gerrit Change-Ids not in any patch context
		if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) {
2996 2997 2998 2999 3000
			if (ERROR("GERRIT_CHANGE_ID",
			          "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr) &&
			    $fix) {
                                fix_delete_line($fixlinenr, $rawline);
                        }
3001 3002
		}

3003 3004 3005 3006 3007
# Check if the commit log is in a possible stack dump
		if ($in_commit_log && !$commit_log_possible_stack_dump &&
		    ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
		     $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
					# timestamp
3008 3009 3010 3011
		     $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) ||
		     $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ ||
		     $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) {
					# stack dump address styles
3012 3013 3014
			$commit_log_possible_stack_dump = 1;
		}

3015 3016
# Check for line lengths > 75 in commit log, warn once
		if ($in_commit_log && !$commit_log_long_line &&
3017 3018 3019 3020 3021
		    length($line) > 75 &&
		    !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
					# file delta changes
		      $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
					# filename then :
3022 3023
		      $line =~ /^\s*(?:Fixes:|Link:|$signature_tags)/i ||
					# A Fixes: or Link: line or signature tag line
3024
		      $commit_log_possible_stack_dump)) {
3025 3026 3027 3028 3029
			WARN("COMMIT_LOG_LONG_LINE",
			     "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
			$commit_log_long_line = 1;
		}

3030
# Reset possible stack dump if a blank line is found
3031 3032 3033 3034
		if ($in_commit_log && $commit_log_possible_stack_dump &&
		    $line =~ /^\s*$/) {
			$commit_log_possible_stack_dump = 0;
		}
3035

3036 3037 3038 3039 3040 3041 3042 3043 3044
# Check for lines starting with a #
		if ($in_commit_log && $line =~ /^#/) {
			if (WARN("COMMIT_COMMENT_SYMBOL",
				 "Commit log lines starting with '#' are dropped by git as comments\n" . $herecurr) &&
			    $fix) {
				$fixed[$fixlinenr] =~ s/^/ /;
			}
		}

3045
# Check for git id commit length and improperly formed commit descriptions
3046
		if ($in_commit_log && !$commit_log_possible_stack_dump &&
3047
		    $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i &&
3048
		    $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
3049
		    ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
3050
		     ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
3051 3052
		      $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
		      $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
3053 3054
			my $init_char = "c";
			my $orig_commit = "";
3055 3056 3057 3058 3059
			my $short = 1;
			my $long = 0;
			my $case = 1;
			my $space = 1;
			my $hasdesc = 0;
3060
			my $hasparens = 0;
3061 3062 3063 3064
			my $id = '0123456789ab';
			my $orig_desc = "commit description";
			my $description = "";

3065 3066 3067 3068 3069 3070 3071
			if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
				$init_char = $1;
				$orig_commit = lc($2);
			} elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
				$orig_commit = lc($1);
			}

3072 3073 3074 3075 3076 3077
			$short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
			$long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
			$space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
			$case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
			if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
				$orig_desc = $1;
3078
				$hasparens = 1;
3079 3080 3081 3082
			} elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
				 defined $rawlines[$linenr] &&
				 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
				$orig_desc = $1;
3083
				$hasparens = 1;
3084 3085 3086 3087 3088 3089 3090
			} elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
				 defined $rawlines[$linenr] &&
				 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
				$line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
				$orig_desc = $1;
				$rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
				$orig_desc .= " " . $1;
3091
				$hasparens = 1;
3092 3093 3094 3095 3096
			}

			($id, $description) = git_commit_info($orig_commit,
							      $id, $orig_desc);

3097 3098
			if (defined($id) &&
			   ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
3099 3100 3101
				ERROR("GIT_COMMIT_ID",
				      "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
			}
3102 3103
		}

3104 3105 3106 3107 3108 3109
# Check for added, moved or deleted files
		if (!$reported_maintainer_file && !$in_commit_log &&
		    ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
		     $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
		     ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
		      (defined($1) || defined($2))))) {
3110
			$is_patch = 1;
3111 3112 3113 3114 3115
			$reported_maintainer_file = 1;
			WARN("FILE_PATH_CHANGES",
			     "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
		}

3116 3117 3118 3119 3120 3121 3122 3123
# Check for adding new DT bindings not in schema format
		if (!$in_commit_log &&
		    ($line =~ /^new file mode\s*\d+\s*$/) &&
		    ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) {
			WARN("DT_SCHEMA_BINDING_PATCH",
			     "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n");
		}

3124
# Check for wrappage within a valid hunk of the file
3125
		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
3126 3127
			ERROR("CORRUPTED_PATCH",
			      "patch seems to be corrupt (line wrapped?)\n" .
3128
				$herecurr) if (!$emitted_corrupt++);
3129 3130 3131 3132
		}

# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
3133 3134 3135 3136 3137 3138 3139
		    $rawline !~ m/^$UTF8*$/) {
			my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);

			my $blank = copy_spacing($rawline);
			my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
			my $hereptr = "$hereline$ptr\n";

3140 3141
			CHK("INVALID_UTF8",
			    "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
3142 3143
		}

3144 3145 3146
# Check if it's the start of a commit log
# (not a header line and we haven't seen the patch filename)
		if ($in_header_lines && $realfile =~ /^$/ &&
3147 3148
		    !($rawline =~ /^\s+(?:\S|$)/ ||
		      $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
3149 3150
			$in_header_lines = 0;
			$in_commit_log = 1;
3151
			$has_commit_log = 1;
3152 3153
		}

3154 3155 3156 3157 3158 3159 3160 3161 3162
# Check if there is UTF-8 in a commit log when a mail header has explicitly
# declined it, i.e defined some charset where it is missing.
		if ($in_header_lines &&
		    $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
		    $1 !~ /utf-8/i) {
			$non_utf8_charset = 1;
		}

		if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
3163
		    $rawline =~ /$NON_ASCII_UTF8/) {
3164
			WARN("UTF8_BEFORE_PATCH",
3165 3166 3167
			    "8-bit UTF-8 used in possible commit log\n" . $herecurr);
		}

3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181
# Check for absolute kernel paths in commit message
		if ($tree && $in_commit_log) {
			while ($line =~ m{(?:^|\s)(/\S*)}g) {
				my $file = $1;

				if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
				    check_absolute_file($1, $herecurr)) {
					#
				} else {
					check_absolute_file($file, $herecurr);
				}
			}
		}

3182
# Check for various typo / spelling mistakes
3183 3184
		if (defined($misspellings) &&
		    ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
3185
			while ($rawline =~ /(?:^|[^\w\-'`])($misspellings)(?:[^\w\-'`]|$)/gi) {
3186
				my $typo = $1;
3187 3188 3189
				my $blank = copy_spacing($rawline);
				my $ptr = substr($blank, 0, $-[1]) . "^" x length($typo);
				my $hereptr = "$hereline$ptr\n";
3190 3191 3192
				my $typo_fix = $spelling_fix{lc($typo)};
				$typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
				$typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
3193 3194 3195
				my $msg_level = \&WARN;
				$msg_level = \&CHK if ($file);
				if (&{$msg_level}("TYPO_SPELLING",
3196
						  "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $hereptr) &&
3197 3198 3199 3200 3201 3202
				    $fix) {
					$fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
				}
			}
		}

3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213
# check for invalid commit id
		if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) {
			my $id;
			my $description;
			($id, $description) = git_commit_info($2, undef, undef);
			if (!defined($id)) {
				WARN("UNKNOWN_COMMIT_ID",
				     "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr);
			}
		}

J
Joe Perches 已提交
3214
# check for repeated words separated by a single space
3215 3216 3217
# avoid false positive from list command eg, '-rw-r--r-- 1 root root'
		if (($rawline =~ /^\+/ || $in_commit_log) &&
		    $rawline !~ /[bcCdDlMnpPs\?-][rwxsStT-]{9}/) {
3218
			pos($rawline) = 1 if (!$in_commit_log);
J
Joe Perches 已提交
3219 3220 3221 3222
			while ($rawline =~ /\b($word_pattern) (?=($word_pattern))/g) {

				my $first = $1;
				my $second = $2;
3223 3224
				my $start_pos = $-[1];
				my $end_pos = $+[2];
J
Joe Perches 已提交
3225 3226 3227 3228 3229
				if ($first =~ /(?:struct|union|enum)/) {
					pos($rawline) += length($first) + length($second) + 1;
					next;
				}

3230
				next if (lc($first) ne lc($second));
J
Joe Perches 已提交
3231 3232
				next if ($first eq 'long');

3233 3234 3235 3236 3237 3238 3239 3240 3241
				# check for character before and after the word matches
				my $start_char = '';
				my $end_char = '';
				$start_char = substr($rawline, $start_pos - 1, 1) if ($start_pos > ($in_commit_log ? 0 : 1));
				$end_char = substr($rawline, $end_pos, 1) if ($end_pos < length($rawline));

				next if ($start_char =~ /^\S$/);
				next if (index(" \t.,;?!", $end_char) == -1);

3242 3243 3244 3245 3246
                                # avoid repeating hex occurrences like 'ff ff fe 09 ...'
                                if ($first =~ /\b[0-9a-f]{2,}\b/i) {
                                        next if (!exists($allow_repeated_words{lc($first)}));
                                }

J
Joe Perches 已提交
3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267
				if (WARN("REPEATED_WORD",
					 "Possible repeated word: '$first'\n" . $herecurr) &&
				    $fix) {
					$fixed[$fixlinenr] =~ s/\b$first $second\b/$first/;
				}
			}

			# if it's a repeated word on consecutive lines in a comment block
			if ($prevline =~ /$;+\s*$/ &&
			    $prevrawline =~ /($word_pattern)\s*$/) {
				my $last_word = $1;
				if ($rawline =~ /^\+\s*\*\s*$last_word /) {
					if (WARN("REPEATED_WORD",
						 "Possible repeated word: '$last_word'\n" . $hereprev) &&
					    $fix) {
						$fixed[$fixlinenr] =~ s/(\+\s*\*\s*)$last_word /$1/;
					}
				}
			}
		}

3268 3269
# ignore non-hunk lines and lines being removed
		next if (!$hunk_line || $line =~ /^-/);
3270 3271

#trailing whitespace
3272
		if ($line =~ /^\+.*\015/) {
3273
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3274 3275 3276
			if (ERROR("DOS_LINE_ENDINGS",
				  "DOS line endings\n" . $herevet) &&
			    $fix) {
3277
				$fixed[$fixlinenr] =~ s/[\s\015]+$//;
3278
			}
3279 3280
		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3281 3282 3283
			if (ERROR("TRAILING_WHITESPACE",
				  "trailing whitespace\n" . $herevet) &&
			    $fix) {
3284
				$fixed[$fixlinenr] =~ s/\s+$//;
3285 3286
			}

3287
			$rpt_cleaners = 1;
3288
		}
3289

3290
# Check for FSF mailing addresses.
3291
		if ($rawline =~ /\bwrite to the Free/i ||
3292
		    $rawline =~ /\b675\s+Mass\s+Ave/i ||
3293 3294
		    $rawline =~ /\b59\s+Temple\s+Pl/i ||
		    $rawline =~ /\b51\s+Franklin\s+St/i) {
3295
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3296 3297 3298 3299
			my $msg_level = \&ERROR;
			$msg_level = \&CHK if ($file);
			&{$msg_level}("FSF_MAILING_ADDRESS",
				      "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)
3300 3301
		}

3302
# check for Kconfig help text having a real description
3303 3304
# Only applies when adding the entry originally, after that we do not have
# sufficient context to determine whether it is indeed long enough.
3305
		if ($realfile =~ /Kconfig/ &&
3306 3307 3308 3309
		    # 'choice' is usually the last thing on the line (though
		    # Kconfig supports named choices), so use a word boundary
		    # (\b) rather than a whitespace character (\s)
		    $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
3310
			my $length = 0;
3311 3312 3313
			my $cnt = $realcnt;
			my $ln = $linenr + 1;
			my $f;
3314
			my $is_start = 0;
3315
			my $is_end = 0;
3316
			for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
3317 3318 3319 3320 3321
				$f = $lines[$ln - 1];
				$cnt-- if ($lines[$ln - 1] !~ /^-/);
				$is_end = $lines[$ln - 1] =~ /^\+/;

				next if ($f =~ /^-/);
3322
				last if (!$file && $f =~ /^\@\@/);
3323

3324
				if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
3325
					$is_start = 1;
3326
				} elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
3327 3328 3329
					$length = -1;
				}

3330
				$f =~ s/^.//;
3331 3332 3333
				$f =~ s/#.*//;
				$f =~ s/^\s+//;
				next if ($f =~ /^$/);
3334 3335 3336 3337 3338 3339 3340

				# This only checks context lines in the patch
				# and so hopefully shouldn't trigger false
				# positives, even though some of these are
				# common words in help texts
				if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
						  if|endif|menu|endmenu|source)\b/x) {
3341 3342 3343
					$is_end = 1;
					last;
				}
3344 3345
				$length++;
			}
3346 3347 3348 3349
			if ($is_start && $is_end && $length < $min_conf_desc_length) {
				WARN("CONFIG_DESCRIPTION",
				     "please write a paragraph that describes the config symbol fully\n" . $herecurr);
			}
3350
			#print "is_start<$is_start> is_end<$is_end> length<$length>\n";
3351 3352
		}

3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389
# check MAINTAINERS entries
		if ($realfile =~ /^MAINTAINERS$/) {
# check MAINTAINERS entries for the right form
			if ($rawline =~ /^\+[A-Z]:/ &&
			    $rawline !~ /^\+[A-Z]:\t\S/) {
				if (WARN("MAINTAINERS_STYLE",
					 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
				    $fix) {
					$fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
				}
			}
# check MAINTAINERS entries for the right ordering too
			my $preferred_order = 'MRLSWQBCPTFXNK';
			if ($rawline =~ /^\+[A-Z]:/ &&
			    $prevrawline =~ /^[\+ ][A-Z]:/) {
				$rawline =~ /^\+([A-Z]):\s*(.*)/;
				my $cur = $1;
				my $curval = $2;
				$prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/;
				my $prev = $1;
				my $prevval = $2;
				my $curindex = index($preferred_order, $cur);
				my $previndex = index($preferred_order, $prev);
				if ($curindex < 0) {
					WARN("MAINTAINERS_STYLE",
					     "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr);
				} else {
					if ($previndex >= 0 && $curindex < $previndex) {
						WARN("MAINTAINERS_STYLE",
						     "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev);
					} elsif ((($prev eq 'F' && $cur eq 'F') ||
						  ($prev eq 'X' && $cur eq 'X')) &&
						 ($prevval cmp $curval) > 0) {
						WARN("MAINTAINERS_STYLE",
						     "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev);
					}
				}
3390 3391 3392
			}
		}

3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406
		if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
		    ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
			my $flag = $1;
			my $replacement = {
				'EXTRA_AFLAGS' =>   'asflags-y',
				'EXTRA_CFLAGS' =>   'ccflags-y',
				'EXTRA_CPPFLAGS' => 'cppflags-y',
				'EXTRA_LDFLAGS' =>  'ldflags-y',
			};

			WARN("DEPRECATED_VARIABLE",
			     "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
		}

3407
# check for DT compatible documentation
3408 3409 3410 3411
		if (defined $root &&
			(($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
			 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {

3412 3413
			my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;

3414
			my $dt_path = $root . "/Documentation/devicetree/bindings/";
3415
			my $vp_file = $dt_path . "vendor-prefixes.yaml";
3416

3417 3418
			foreach my $compat (@compats) {
				my $compat2 = $compat;
3419 3420 3421 3422
				$compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
				my $compat3 = $compat;
				$compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
				`grep -Erq "$compat|$compat2|$compat3" $dt_path`;
3423 3424 3425 3426 3427
				if ( $? >> 8 ) {
					WARN("UNDOCUMENTED_DT_STRING",
					     "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
				}

3428 3429
				next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
				my $vendor = $1;
3430
				`grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`;
3431 3432
				if ( $? >> 8 ) {
					WARN("UNDOCUMENTED_DT_STRING",
3433
					     "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
3434 3435 3436 3437
				}
			}
		}

3438 3439 3440 3441 3442 3443 3444 3445 3446 3447
# check for using SPDX license tag at beginning of files
		if ($realline == $checklicenseline) {
			if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
				$checklicenseline = 2;
			} elsif ($rawline =~ /^\+/) {
				my $comment = "";
				if ($realfile =~ /\.(h|s|S)$/) {
					$comment = '/*';
				} elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
					$comment = '//';
3448
				} elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) {
3449 3450 3451 3452 3453
					$comment = '#';
				} elsif ($realfile =~ /\.rst$/) {
					$comment = '..';
				}

3454 3455 3456
# check SPDX comment style for .[chsS] files
				if ($realfile =~ /\.[chsS]$/ &&
				    $rawline =~ /SPDX-License-Identifier:/ &&
3457
				    $rawline !~ m@^\+\s*\Q$comment\E\s*@) {
3458 3459 3460 3461
					WARN("SPDX_LICENSE_TAG",
					     "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr);
				}

3462
				if ($comment !~ /^$/ &&
3463 3464 3465
				    $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) {
					WARN("SPDX_LICENSE_TAG",
					     "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
3466
				} elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) {
3467 3468 3469 3470 3471
					my $spdx_license = $1;
					if (!is_SPDX_License_valid($spdx_license)) {
						WARN("SPDX_LICENSE_TAG",
						     "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr);
					}
3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482
					if ($realfile =~ m@^Documentation/devicetree/bindings/@ &&
					    not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) {
						my $msg_level = \&WARN;
						$msg_level = \&CHK if ($file);
						if (&{$msg_level}("SPDX_LICENSE_TAG",

								  "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) &&
						    $fix) {
							$fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/;
						}
					}
3483 3484 3485 3486
				}
			}
		}

3487 3488 3489 3490 3491 3492
# check for embedded filenames
		if ($rawline =~ /^\+.*\Q$realfile\E/) {
			WARN("EMBEDDED_FILENAME",
			     "It's generally not useful to have the filename in the file\n" . $herecurr);
		}

3493
# check we are in a valid source file if not then ignore this hunk
3494
		next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
3495

3496 3497 3498 3499 3500 3501 3502 3503
# check for using SPDX-License-Identifier on the wrong line number
		if ($realline != $checklicenseline &&
		    $rawline =~ /\bSPDX-License-Identifier:/ &&
		    substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) {
			WARN("SPDX_LICENSE_TAG",
			     "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr);
		}

3504 3505 3506 3507 3508 3509
# line length limit (with some exclusions)
#
# There are a few types of lines that may extend beyond $max_line_length:
#	logging functions like pr_info that end in a string
#	lines with a single string
#	#defines that are a single string
3510
#	lines with an RFC3986 like URL
3511 3512
#
# There are 3 different line length message types:
J
Jean Delvare 已提交
3513
# LONG_LINE_COMMENT	a comment starts before but extends beyond $max_line_length
3514 3515 3516 3517 3518 3519
# LONG_LINE_STRING	a string starts before but extends beyond $max_line_length
# LONG_LINE		all other lines longer than $max_line_length
#
# if LONG_LINE is ignored, the other 2 types are also ignored
#

3520
		if ($line =~ /^\+/ && $length > $max_line_length) {
3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536
			my $msg_type = "LONG_LINE";

			# Check the allowed long line types first

			# logging functions that end in a string that starts
			# before $max_line_length
			if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
			    length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
				$msg_type = "";

			# lines with only strings (w/ possible termination)
			# #defines with only strings
			} elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
				 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
				$msg_type = "";

3537 3538 3539
			# More special cases
			} elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
				 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
3540 3541
				$msg_type = "";

3542 3543 3544 3545
			# URL ($rawline is used in case the URL is in a comment)
			} elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
				$msg_type = "";

3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560
			# Otherwise set the alternate message types

			# a comment starts before $max_line_length
			} elsif ($line =~ /($;[\s$;]*)$/ &&
				 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
				$msg_type = "LONG_LINE_COMMENT"

			# a quoted string starts before $max_line_length
			} elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
				 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
				$msg_type = "LONG_LINE_STRING"
			}

			if ($msg_type ne "" &&
			    (show_type("LONG_LINE") || show_type($msg_type))) {
3561 3562 3563 3564
				my $msg_level = \&WARN;
				$msg_level = \&CHK if ($file);
				&{$msg_level}($msg_type,
					      "line length of $length exceeds $max_line_length columns\n" . $herecurr);
3565
			}
3566 3567
		}

3568 3569
# check for adding lines without a newline.
		if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3570 3571 3572 3573 3574
			if (WARN("MISSING_EOF_NEWLINE",
			         "adding a line without newline at end of file\n" . $herecurr) &&
			    $fix) {
				fix_delete_line($fixlinenr+1, "No newline at end of file");
			}
3575 3576
		}

3577
# check we are in a valid source file C or perl if not then ignore this hunk
3578
		next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
3579 3580

# at the beginning of a line any tabs must come first and anything
3581
# more than $tabsize must use tabs.
3582 3583 3584
		if ($rawline =~ /^\+\s* \t\s*\S/ ||
		    $rawline =~ /^\+\s*        \s*/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3585
			$rpt_cleaners = 1;
3586 3587 3588
			if (ERROR("CODE_INDENT",
				  "code indent should use tabs where possible\n" . $herevet) &&
			    $fix) {
3589
				$fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3590
			}
3591 3592
		}

3593 3594 3595
# check for space before tabs.
		if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3596 3597 3598
			if (WARN("SPACE_BEFORE_TAB",
				"please, no space before tabs\n" . $herevet) &&
			    $fix) {
3599
				while ($fixed[$fixlinenr] =~
3600
					   s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {}
3601
				while ($fixed[$fixlinenr] =~
3602
					   s/(^\+.*) +\t/$1\t/) {}
3603
			}
3604
		}
3605 3606 3607

# check for assignments on the start of a line
		if ($sline =~ /^\+\s+($Assignment)[^=]/) {
3608 3609 3610 3611 3612 3613 3614 3615
			my $operator = $1;
			if (CHK("ASSIGNMENT_CONTINUATIONS",
				"Assignment operator '$1' should be on the previous line\n" . $hereprev) &&
			    $fix && $prevrawline =~ /^\+/) {
				# add assignment operator to the previous line, remove from current line
				$fixed[$fixlinenr - 1] .= " $operator";
				$fixed[$fixlinenr] =~ s/\Q$operator\E\s*//;
			}
3616
		}
3617

3618 3619
# check for && or || at the start of a line
		if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3620 3621 3622 3623 3624 3625 3626 3627 3628 3629
			my $operator = $1;
			if (CHK("LOGICAL_CONTINUATIONS",
				"Logical continuations should be on the previous line\n" . $hereprev) &&
			    $fix && $prevrawline =~ /^\+/) {
				# insert logical operator at last non-comment, non-whitepsace char on previous line
				$prevline =~ /[\s$;]*$/;
				my $line_end = substr($prevrawline, $-[0]);
				$fixed[$fixlinenr - 1] =~ s/\Q$line_end\E$/ $operator$line_end/;
				$fixed[$fixlinenr] =~ s/\Q$operator\E\s*//;
			}
3630 3631
		}

3632
# check indentation starts on a tab stop
3633
		if ($perl_version_ok &&
3634
		    $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3635
			my $indent = length($1);
3636
			if ($indent % $tabsize) {
3637 3638 3639
				if (WARN("TABSTOP",
					 "Statements should start on a tabstop\n" . $herecurr) &&
				    $fix) {
3640
					$fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e;
3641 3642 3643 3644
				}
			}
		}

3645
# check multi-line statement indentation matches previous line
3646
		if ($perl_version_ok &&
3647
		    $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3648 3649 3650 3651 3652 3653
			$prevline =~ /^\+(\t*)(.*)$/;
			my $oldindent = $1;
			my $rest = $2;

			my $pos = pos_last_openparen($rest);
			if ($pos >= 0) {
J
Joe Perches 已提交
3654 3655
				$line =~ /^(\+| )([ \t]*)/;
				my $newindent = $2;
3656 3657

				my $goodtabindent = $oldindent .
3658 3659
					"\t" x ($pos / $tabsize) .
					" "  x ($pos % $tabsize);
3660 3661 3662 3663
				my $goodspaceindent = $oldindent . " "  x $pos;

				if ($newindent ne $goodtabindent &&
				    $newindent ne $goodspaceindent) {
3664 3665 3666 3667

					if (CHK("PARENTHESIS_ALIGNMENT",
						"Alignment should match open parenthesis\n" . $hereprev) &&
					    $fix && $line =~ /^\+/) {
3668
						$fixed[$fixlinenr] =~
3669 3670
						    s/^\+[ \t]*/\+$goodtabindent/;
					}
3671 3672 3673 3674
				}
			}
		}

3675 3676 3677 3678 3679 3680 3681 3682 3683
# check for space after cast like "(int) foo" or "(struct foo) bar"
# avoid checking a few false positives:
#   "sizeof(<type>)" or "__alignof__(<type>)"
#   function pointer declarations like "(*foo)(int) = bar;"
#   structure definitions like "(struct foo) { 0 };"
#   multiline macros that define functions
#   known attributes or the __attribute__ keyword
		if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
		    (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
3684
			if (CHK("SPACING",
3685
				"No space is necessary after a cast\n" . $herecurr) &&
3686
			    $fix) {
3687
				$fixed[$fixlinenr] =~
3688
				    s/(\(\s*$Type\s*\))[ \t]+/$1/;
3689
			}
3690 3691
		}

3692 3693
# Block comment styles
# Networking with an initial /*
3694
		if ($realfile =~ m@^(drivers/net/|net/)@ &&
3695
		    $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
3696
		    $rawline =~ /^\+[ \t]*\*/ &&
3697
		    $realline > 3) { # Do not warn about the initial copyright comment block after SPDX-License-Identifier
3698 3699 3700 3701
			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
			     "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
		}

3702 3703 3704
# Block comments use * on subsequent lines
		if ($prevline =~ /$;[ \t]*$/ &&			#ends in comment
		    $prevrawline =~ /^\+.*?\/\*/ &&		#starting /*
3705
		    $prevrawline !~ /\*\/[ \t]*$/ &&		#no trailing */
3706
		    $rawline =~ /^\+/ &&			#line is new
3707
		    $rawline !~ /^\+[ \t]*\*/) {		#no leading *
3708 3709
			WARN("BLOCK_COMMENT_STYLE",
			     "Block comments use * on subsequent lines\n" . $hereprev);
3710 3711
		}

3712 3713
# Block comments use */ on trailing lines
		if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ &&	#trailing */
3714 3715 3716
		    $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ &&	#inline /*...*/
		    $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ &&	#trailing **/
		    $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) {	#non blank */
3717 3718
			WARN("BLOCK_COMMENT_STYLE",
			     "Block comments use a trailing */ on a separate line\n" . $herecurr);
3719 3720
		}

3721 3722
# Block comment * alignment
		if ($prevline =~ /$;[ \t]*$/ &&			#ends in comment
3723 3724 3725
		    $line =~ /^\+[ \t]*$;/ &&			#leading comment
		    $rawline =~ /^\+[ \t]*\*/ &&		#leading *
		    (($prevrawline =~ /^\+.*?\/\*/ &&		#leading /*
3726
		      $prevrawline !~ /\*\/[ \t]*$/) ||		#no trailing */
3727 3728
		     $prevrawline =~ /^\+[ \t]*\*/)) {		#leading *
			my $oldindent;
3729
			$prevrawline =~ m@^\+([ \t]*/?)\*@;
3730 3731 3732 3733 3734 3735
			if (defined($1)) {
				$oldindent = expand_tabs($1);
			} else {
				$prevrawline =~ m@^\+(.*/?)\*@;
				$oldindent = expand_tabs($1);
			}
3736 3737 3738
			$rawline =~ m@^\+([ \t]*)\*@;
			my $newindent = $1;
			$newindent = expand_tabs($newindent);
3739
			if (length($oldindent) ne length($newindent)) {
3740 3741 3742 3743 3744
				WARN("BLOCK_COMMENT_STYLE",
				     "Block comments should align the * on each line\n" . $hereprev);
			}
		}

3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755
# check for missing blank lines after struct/union declarations
# with exceptions for various attributes and macros
		if ($prevline =~ /^[\+ ]};?\s*$/ &&
		    $line =~ /^\+/ &&
		    !($line =~ /^\+\s*$/ ||
		      $line =~ /^\+\s*EXPORT_SYMBOL/ ||
		      $line =~ /^\+\s*MODULE_/i ||
		      $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
		      $line =~ /^\+[a-z_]*init/ ||
		      $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
		      $line =~ /^\+\s*DECLARE/ ||
3756
		      $line =~ /^\+\s*builtin_[\w_]*driver/ ||
3757
		      $line =~ /^\+\s*__setup/)) {
3758 3759 3760
			if (CHK("LINE_SPACING",
				"Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
			    $fix) {
3761
				fix_insert_line($fixlinenr, "\+");
3762
			}
3763 3764
		}

3765 3766 3767 3768
# check for multiple consecutive blank lines
		if ($prevline =~ /^[\+ ]\s*$/ &&
		    $line =~ /^\+\s*$/ &&
		    $last_blank_line != ($linenr - 1)) {
3769 3770 3771
			if (CHK("LINE_SPACING",
				"Please don't use multiple blank lines\n" . $hereprev) &&
			    $fix) {
3772
				fix_delete_line($fixlinenr, $rawline);
3773 3774
			}

3775 3776 3777
			$last_blank_line = $linenr;
		}

3778
# check for missing blank lines after declarations
3779 3780 3781
		if ($sline =~ /^\+\s+\S/ &&			#Not at char 1
			# actual declarations
		    ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3782 3783
			# function pointer declarations
		     $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795
			# foo bar; where foo is some local typedef or #define
		     $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
			# known declaration macros
		     $prevline =~ /^\+\s+$declaration_macros/) &&
			# for "else if" which can look like "$Ident $Ident"
		    !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
			# other possible extensions of declaration lines
		      $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
			# not starting a section or a macro "\" extended line
		      $prevline =~ /(?:\{\s*|\\)$/) &&
			# looks like a declaration
		    !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3796 3797
			# function pointer declarations
		      $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3798 3799 3800 3801 3802
			# foo bar; where foo is some local typedef or #define
		      $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
			# known declaration macros
		      $sline =~ /^\+\s+$declaration_macros/ ||
			# start of struct or union or enum
3803
		      $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ ||
3804 3805 3806 3807 3808 3809 3810 3811
			# start or end of block or continuation of declaration
		      $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
			# bitfield continuation
		      $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
			# other possible extensions of declaration lines
		      $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
			# indentation of previous and current line are the same
		    (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
3812 3813 3814
			if (WARN("LINE_SPACING",
				 "Missing a blank line after declarations\n" . $hereprev) &&
			    $fix) {
3815
				fix_insert_line($fixlinenr, "\+");
3816
			}
3817 3818
		}

3819
# check for spaces at the beginning of a line.
3820 3821 3822 3823
# Exceptions:
#  1) within comments
#  2) indented preprocessor commands
#  3) hanging labels
3824
		if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/)  {
3825
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3826 3827 3828
			if (WARN("LEADING_SPACE",
				 "please, no spaces at the start of a line\n" . $herevet) &&
			    $fix) {
3829
				$fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3830
			}
3831 3832
		}

3833 3834 3835
# check we are in a valid C source file if not then ignore this hunk
		next if ($realfile !~ /\.(h|c)$/);

3836 3837 3838 3839 3840 3841
# check for unusual line ending [ or (
		if ($line =~ /^\+.*([\[\(])\s*$/) {
			CHK("OPEN_ENDED_LINE",
			    "Lines should not end with a '$1'\n" . $herecurr);
		}

3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852
# check if this appears to be the start function declaration, save the name
		if ($sline =~ /^\+\{\s*$/ &&
		    $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
			$context_function = $1;
		}

# check if this appears to be the end of function declaration
		if ($sline =~ /^\+\}\s*$/) {
			undef $context_function;
		}

3853
# check indentation of any line with a bare else
3854
# (but not if it is a multiple line "if (foo) return bar; else return baz;")
3855 3856 3857
# if the previous line is a break or return and is indented 1 tab more...
		if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
			my $tabs = length($1) + 1;
3858 3859 3860 3861
			if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
			    ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
			     defined $lines[$linenr] &&
			     $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
3862 3863 3864 3865 3866
				WARN("UNNECESSARY_ELSE",
				     "else is not generally useful after a break or return\n" . $hereprev);
			}
		}

3867
# check indentation of a line with a break;
3868 3869
# if the previous line is a goto, return or break
# and is indented the same # of tabs
3870 3871
		if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
			my $tabs = $1;
3872 3873 3874 3875 3876 3877
			if ($prevline =~ /^\+$tabs(goto|return|break)\b/) {
				if (WARN("UNNECESSARY_BREAK",
					 "break is not useful after a $1\n" . $hereprev) &&
				    $fix) {
					fix_delete_line($fixlinenr, $rawline);
				}
3878 3879 3880
			}
		}

3881
# check for RCS/CVS revision markers
3882
		if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
3883 3884
			WARN("CVS_KEYWORD",
			     "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
3885
		}
3886

3887 3888 3889 3890 3891 3892
# check for old HOTPLUG __dev<foo> section markings
		if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
			WARN("HOTPLUG_SECTION",
			     "Using $1 is unnecessary\n" . $herecurr);
		}

3893
# Check for potential 'bare' types
3894 3895
		my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
		    $realline_next);
3896
#print "LINE<$line>\n";
3897
		if ($linenr > $suppress_statement &&
3898
		    $realcnt && $sline =~ /.\s*\S/) {
3899
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3900
				ctx_statement_block($linenr, $realcnt, 0);
3901 3902 3903
			$stat =~ s/\n./\n /g;
			$cond =~ s/\n./\n /g;

3904 3905 3906 3907 3908 3909 3910 3911 3912
#print "linenr<$linenr> <$stat>\n";
			# If this statement has no statement boundaries within
			# it there is no point in retrying a statement scan
			# until we hit end of it.
			my $frag = $stat; $frag =~ s/;+\s*$//;
			if ($frag !~ /(?:{|;)/) {
#print "skip<$line_nr_next>\n";
				$suppress_statement = $line_nr_next;
			}
3913

3914 3915 3916 3917 3918 3919 3920 3921
			# Find the real next line.
			$realline_next = $line_nr_next;
			if (defined $realline_next &&
			    (!defined $lines[$realline_next - 1] ||
			     substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
				$realline_next++;
			}

3922 3923
			my $s = $stat;
			$s =~ s/{.*$//s;
3924

3925
			# Ignore goto labels.
3926
			if ($s =~ /$Ident:\*$/s) {
3927 3928

			# Ignore functions being called
3929
			} elsif ($s =~ /^.\s*$Ident\s*\(/s) {
3930

3931 3932
			} elsif ($s =~ /^.\s*else\b/s) {

3933
			# declarations always start with types
3934
			} 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) {
3935 3936 3937 3938
				my $type = $1;
				$type =~ s/\s+/ /g;
				possible($type, "A:" . $s);

3939
			# definitions in global scope can only start with types
3940
			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
3941
				possible($1, "B:" . $s);
3942
			}
3943 3944

			# any (foo ... *) is a pointer cast, and foo is a type
3945
			while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
3946
				possible($1, "C:" . $s);
3947 3948 3949 3950 3951
			}

			# Check for any sort of function declaration.
			# int foo(something bar, other baz);
			# void (*store_gdt)(x86_descr_ptr *);
3952
			if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3953 3954
				my ($name_len) = length($1);

3955
				my $ctx = $s;
3956
				substr($ctx, 0, $name_len + 1, '');
3957
				$ctx =~ s/\)[^\)]*$//;
3958

3959
				for my $arg (split(/\s*,\s*/, $ctx)) {
3960
					if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3961

3962
						possible($1, "D:" . $s);
3963 3964
					}
				}
3965
			}
3966

3967 3968
		}

3969 3970 3971
#
# Checks which may be anchored in the context.
#
3972

3973 3974
# Check for switch () and associated case and default
# statements should be at the same indent.
3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990
		if ($line=~/\bswitch\s*\(.*\)/) {
			my $err = '';
			my $sep = '';
			my @ctx = ctx_block_outer($linenr, $realcnt);
			shift(@ctx);
			for my $ctx (@ctx) {
				my ($clen, $cindent) = line_stats($ctx);
				if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
							$indent != $cindent) {
					$err .= "$sep$ctx\n";
					$sep = '';
				} else {
					$sep = "[...]\n";
				}
			}
			if ($err ne '') {
3991 3992
				ERROR("SWITCH_CASE_INDENT_LEVEL",
				      "switch and case should be at the same indent\n$hereline$err");
3993 3994 3995 3996 3997
			}
		}

# if/while/etc brace do not go on next line, unless defining a do while loop,
# or if that brace on the next line is for something else
3998
		if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3999 4000
			my $pre_ctx = "$1$2";

4001
			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
4002 4003 4004 4005 4006 4007

			if ($line =~ /^\+\t{6,}/) {
				WARN("DEEP_INDENTATION",
				     "Too many leading tabs - consider code refactoring\n" . $herecurr);
			}

4008 4009 4010
			my $ctx_cnt = $realcnt - $#ctx - 1;
			my $ctx = join("\n", @ctx);

4011 4012
			my $ctx_ln = $linenr;
			my $ctx_skip = $realcnt;
4013

4014 4015 4016 4017 4018
			while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
					defined $lines[$ctx_ln - 1] &&
					$lines[$ctx_ln - 1] =~ /^-/)) {
				##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
				$ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
4019 4020
				$ctx_ln++;
			}
4021

4022 4023
			#print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
			#print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
4024

4025
			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
4026 4027
				ERROR("OPEN_BRACE",
				      "that open brace { should be on the previous line\n" .
4028
					"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
4029
			}
4030 4031 4032 4033
			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
			    $ctx =~ /\)\s*\;\s*$/ &&
			    defined $lines[$ctx_ln - 1])
			{
4034 4035
				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
				if ($nindent > $indent) {
4036 4037
					WARN("TRAILING_SEMICOLON",
					     "trailing semicolon indicates no statements, indent implies otherwise\n" .
4038
						"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
4039 4040
				}
			}
4041 4042
		}

4043
# Check relative indent for conditionals and blocks.
4044
		if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
4045 4046 4047
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
4048 4049 4050 4051
			my ($s, $c) = ($stat, $cond);

			substr($s, 0, length($c), '');

4052 4053 4054
			# remove inline comments
			$s =~ s/$;/ /g;
			$c =~ s/$;/ /g;
4055 4056

			# Find out how long the conditional actually is.
4057 4058
			my @newlines = ($c =~ /\n/gs);
			my $cond_lines = 1 + $#newlines;
4059

4060 4061 4062 4063 4064 4065 4066 4067
			# Make sure we remove the line prefixes as we have
			# none on the first line, and are going to readd them
			# where necessary.
			$s =~ s/\n./\n/gs;
			while ($s =~ /\n\s+\\\n/) {
				$cond_lines += $s =~ s/\n\s+\\\n/\n/g;
			}

4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079
			# We want to check the first line inside the block
			# starting at the end of the conditional, so remove:
			#  1) any blank line termination
			#  2) any opening brace { on end of the line
			#  3) any do (...) {
			my $continuation = 0;
			my $check = 0;
			$s =~ s/^.*\bdo\b//;
			$s =~ s/^\s*{//;
			if ($s =~ s/^\s*\\//) {
				$continuation = 1;
			}
4080
			if ($s =~ s/^\s*?\n//) {
4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091
				$check = 1;
				$cond_lines++;
			}

			# Also ignore a loop construct at the end of a
			# preprocessor statement.
			if (($prevline =~ /^.\s*#\s*define\s/ ||
			    $prevline =~ /\\\s*$/) && $continuation == 0) {
				$check = 0;
			}

4092
			my $cond_ptr = -1;
4093
			$continuation = 0;
4094 4095 4096
			while ($cond_ptr != $cond_lines) {
				$cond_ptr = $cond_lines;

4097 4098 4099 4100 4101 4102
				# If we see an #else/#elif then the code
				# is not linear.
				if ($s =~ /^\s*\#\s*(?:else|elif)/) {
					$check = 0;
				}

4103 4104 4105 4106
				# Ignore:
				#  1) blank lines, they should be at 0,
				#  2) preprocessor lines, and
				#  3) labels.
4107 4108
				if ($continuation ||
				    $s =~ /^\s*?\n/ ||
4109 4110
				    $s =~ /^\s*#\s*?/ ||
				    $s =~ /^\s*$Ident\s*:/) {
4111
					$continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
4112 4113 4114
					if ($s =~ s/^.*?\n//) {
						$cond_lines++;
					}
4115
				}
4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130
			}

			my (undef, $sindent) = line_stats("+" . $s);
			my $stat_real = raw_line($linenr, $cond_lines);

			# Check if either of these lines are modified, else
			# this is not this patch's fault.
			if (!defined($stat_real) ||
			    $stat !~ /^\+/ && $stat_real !~ /^\+/) {
				$check = 0;
			}
			if (defined($stat_real) && $cond_lines > 1) {
				$stat_real = "[...]\n$stat_real";
			}

4131
			#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";
4132

4133
			if ($check && $s ne '' &&
4134
			    (($sindent % $tabsize) != 0 ||
4135
			     ($sindent < $indent) ||
4136 4137
			     ($sindent == $indent &&
			      ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
4138
			     ($sindent > $indent + $tabsize))) {
4139 4140
				WARN("SUSPECT_CODE_INDENT",
				     "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
4141 4142 4143
			}
		}

4144 4145
		# Track the 'values' across context and added lines.
		my $opline = $line; $opline =~ s/^./ /;
4146 4147
		my ($curr_values, $curr_vars) =
				annotate_values($opline . "\n", $prev_values);
4148
		$curr_values = $prev_values . $curr_values;
4149 4150
		if ($dbg_values) {
			my $outline = $opline; $outline =~ s/\t/ /g;
4151 4152
			print "$linenr > .$outline\n";
			print "$linenr > $curr_values\n";
4153
			print "$linenr >  $curr_vars\n";
4154
		}
4155 4156
		$prev_values = substr($curr_values, -1);

4157
#ignore lines not being added
4158
		next if ($line =~ /^[^\+]/);
4159

J
Joe Perches 已提交
4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170
# check for self assignments used to avoid compiler warnings
# e.g.:	int foo = foo, *bar = NULL;
#	struct foo bar = *(&(bar));
		if ($line =~ /^\+\s*(?:$Declare)?([A-Za-z_][A-Za-z\d_]*)\s*=/) {
			my $var = $1;
			if ($line =~ /^\+\s*(?:$Declare)?$var\s*=\s*(?:$var|\*\s*\(?\s*&\s*\(?\s*$var\s*\)?\s*\)?)\s*[;,]/) {
				WARN("SELF_ASSIGNMENT",
				     "Do not use self-assignments to avoid compiler warnings\n" . $herecurr);
			}
		}

4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182
# check for dereferences that span multiple lines
		if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
		    $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
			$prevline =~ /($Lval\s*(?:\.|->))\s*$/;
			my $ref = $1;
			$line =~ /^.\s*($Lval)/;
			$ref .= $1;
			$ref =~ s/\s//g;
			WARN("MULTILINE_DEREFERENCE",
			     "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
		}

4183
# check for declarations of signed or unsigned without int
4184
		while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
4185 4186
			my $type = $1;
			my $var = $2;
4187 4188
			$var = "" if (!defined $var);
			if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
4189 4190 4191 4192 4193 4194 4195 4196 4197
				my $sign = $1;
				my $pointer = $2;

				$pointer = "" if (!defined $pointer);

				if (WARN("UNSPECIFIED_INT",
					 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
				    $fix) {
					my $decl = trim($sign) . " int ";
4198 4199 4200 4201 4202
					my $comp_pointer = $pointer;
					$comp_pointer =~ s/\s//g;
					$decl .= $comp_pointer;
					$decl = rtrim($decl) if ($var eq "");
					$fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
4203 4204 4205 4206
				}
			}
		}

4207
# TEST: allow direct testing of the type matcher.
4208 4209
		if ($dbg_type) {
			if ($line =~ /^.\s*$Declare\s*$/) {
4210 4211
				ERROR("TEST_TYPE",
				      "TEST: is type\n" . $herecurr);
4212
			} elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
4213 4214
				ERROR("TEST_NOT_TYPE",
				      "TEST: is not type ($1 is)\n". $herecurr);
4215
			}
4216 4217
			next;
		}
4218 4219
# TEST: allow direct testing of the attribute matcher.
		if ($dbg_attr) {
4220
			if ($line =~ /^.\s*$Modifier\s*$/) {
4221 4222
				ERROR("TEST_ATTR",
				      "TEST: is attr\n" . $herecurr);
4223
			} elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
4224 4225
				ERROR("TEST_NOT_ATTR",
				      "TEST: is not attr ($1 is)\n". $herecurr);
4226 4227 4228
			}
			next;
		}
4229

4230
# check for initialisation to aggregates open brace on the next line
4231 4232
		if ($line =~ /^.\s*{/ &&
		    $prevline =~ /(?:^|[^=])=\s*$/) {
4233 4234
			if (ERROR("OPEN_BRACE",
				  "that open brace { should be on the previous line\n" . $hereprev) &&
4235 4236 4237
			    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
				fix_delete_line($fixlinenr - 1, $prevrawline);
				fix_delete_line($fixlinenr, $rawline);
4238 4239
				my $fixedline = $prevrawline;
				$fixedline =~ s/\s*=\s*$/ = {/;
4240
				fix_insert_line($fixlinenr, $fixedline);
4241
				$fixedline = $line;
4242
				$fixedline =~ s/^(.\s*)\{\s*/$1/;
4243
				fix_insert_line($fixlinenr, $fixedline);
4244
			}
4245 4246
		}

4247 4248 4249 4250 4251
#
# Checks which are anchored on the added line.
#

# check for malformed paths in #include statements (uses RAW line)
4252
		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
4253 4254
			my $path = $1;
			if ($path =~ m{//}) {
4255
				ERROR("MALFORMED_INCLUDE",
4256 4257 4258 4259 4260
				      "malformed #include filename\n" . $herecurr);
			}
			if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
				ERROR("UAPI_INCLUDE",
				      "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
4261 4262
			}
		}
4263

4264
# no C99 // comments
4265
		if ($line =~ m{//}) {
4266 4267 4268
			if (ERROR("C99_COMMENTS",
				  "do not use C99 // comments\n" . $herecurr) &&
			    $fix) {
4269
				my $line = $fixed[$fixlinenr];
4270 4271
				if ($line =~ /\/\/(.*)$/) {
					my $comment = trim($1);
4272
					$fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
4273 4274
				}
			}
4275
		}
4276
		# Remove C99 comments.
4277
		$line =~ s@//.*@@;
4278
		$opline =~ s@//.*@@;
4279

4280 4281 4282 4283 4284 4285 4286 4287
# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
# the whole statement.
#print "APW <$lines[$realline_next - 1]>\n";
		if (defined $realline_next &&
		    exists $lines[$realline_next - 1] &&
		    !defined $suppress_export{$realline_next} &&
		    ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
		     $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
4288 4289 4290 4291
			# Handle definitions which produce identifiers with
			# a prefix:
			#   XXX(foo);
			#   EXPORT_SYMBOL(something_foo);
4292
			my $name = $1;
4293
			if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
4294 4295 4296 4297 4298
			    $name =~ /^${Ident}_$2/) {
#print "FOO C name<$name>\n";
				$suppress_export{$realline_next} = 1;

			} elsif ($stat !~ /(?:
4299
				\n.}\s*$|
4300 4301 4302
				^.DEFINE_$Ident\(\Q$name\E\)|
				^.DECLARE_$Ident\(\Q$name\E\)|
				^.LIST_HEAD\(\Q$name\E\)|
4303 4304
				^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
				\b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
4305
			    )/x) {
4306 4307 4308 4309
#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
				$suppress_export{$realline_next} = 2;
			} else {
				$suppress_export{$realline_next} = 1;
4310 4311
			}
		}
4312 4313 4314 4315 4316 4317 4318 4319 4320
		if (!defined $suppress_export{$linenr} &&
		    $prevline =~ /^.\s*$/ &&
		    ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
		     $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
#print "FOO B <$lines[$linenr - 1]>\n";
			$suppress_export{$linenr} = 2;
		}
		if (defined $suppress_export{$linenr} &&
		    $suppress_export{$linenr} == 2) {
4321 4322
			WARN("EXPORT_SYMBOL",
			     "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
4323
		}
4324

4325
# check for global initialisers.
4326
		if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
4327
			if (ERROR("GLOBAL_INITIALISERS",
4328
				  "do not initialise globals to $1\n" . $herecurr) &&
4329
			    $fix) {
4330
				$fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
4331
			}
4332
		}
4333
# check for static initialisers.
4334
		if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
4335
			if (ERROR("INITIALISED_STATIC",
4336
				  "do not initialise statics to $1\n" .
4337 4338
				      $herecurr) &&
			    $fix) {
4339
				$fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
4340
			}
4341 4342
		}

4343 4344 4345 4346 4347 4348 4349
# check for misordered declarations of char/short/int/long with signed/unsigned
		while ($sline =~ m{(\b$TypeMisordered\b)}g) {
			my $tmp = trim($1);
			WARN("MISORDERED_TYPE",
			     "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
		}

4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369
# check for unnecessary <signed> int declarations of short/long/long long
		while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) {
			my $type = trim($1);
			next if ($type !~ /\bint\b/);
			next if ($type !~ /\b(?:short|long\s+long|long)\b/);
			my $new_type = $type;
			$new_type =~ s/\b\s*int\s*\b/ /;
			$new_type =~ s/\b\s*(?:un)?signed\b\s*/ /;
			$new_type =~ s/^const\s+//;
			$new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/);
			$new_type = "const $new_type" if ($type =~ /^const\b/);
			$new_type =~ s/\s+/ /g;
			$new_type = trim($new_type);
			if (WARN("UNNECESSARY_INT",
				 "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) &&
			    $fix) {
				$fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/;
			}
		}

4370 4371
# check for static const char * arrays.
		if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
4372 4373
			WARN("STATIC_CONST_CHAR_ARRAY",
			     "static const char * array should probably be static const char * const\n" .
4374
				$herecurr);
4375 4376 4377 4378 4379 4380 4381 4382 4383 4384
		}

# check for initialized const char arrays that should be static const
		if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
			if (WARN("STATIC_CONST_CHAR_ARRAY",
				 "const array should probably be static const\n" . $herecurr) &&
			    $fix) {
				$fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/;
			}
		}
4385 4386 4387

# check for static char foo[] = "bar" declarations.
		if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
4388 4389
			WARN("STATIC_CONST_CHAR_ARRAY",
			     "static char array declaration should probably be static const char\n" .
4390
				$herecurr);
4391
		}
4392

4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404
# check for const <foo> const where <foo> is not a pointer or array type
		if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
			my $found = $1;
			if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
				WARN("CONST_CONST",
				     "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
			} elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
				WARN("CONST_CONST",
				     "'const $found const' should probably be 'const $found'\n" . $herecurr);
			}
		}

4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416
# check for const static or static <non ptr type> const declarations
# prefer 'static const <foo>' over 'const static <foo>' and 'static <foo> const'
		if ($sline =~ /^\+\s*const\s+static\s+($Type)\b/ ||
		    $sline =~ /^\+\s*static\s+($BasicType)\s+const\b/) {
			if (WARN("STATIC_CONST",
				 "Move const after static - use 'static const $1'\n" . $herecurr) &&
			    $fix) {
				$fixed[$fixlinenr] =~ s/\bconst\s+static\b/static const/;
				$fixed[$fixlinenr] =~ s/\bstatic\s+($BasicType)\s+const\b/static const $1/;
			}
		}

4417 4418 4419 4420 4421 4422 4423
# check for non-global char *foo[] = {"bar", ...} declarations.
		if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
			WARN("STATIC_CONST_CHAR_ARRAY",
			     "char * array declaration might be better as static const\n" .
				$herecurr);
               }

4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436
# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
		if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
			my $array = $1;
			if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
				my $array_div = $1;
				if (WARN("ARRAY_SIZE",
					 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
				    $fix) {
					$fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
				}
			}
		}

4437
# check for function declarations without arguments like "int foo()"
4438
		if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) {
4439 4440 4441
			if (ERROR("FUNCTION_WITHOUT_ARGS",
				  "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
			    $fix) {
4442
				$fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
4443 4444 4445
			}
		}

4446 4447 4448
# check for new typedefs, only function parameters and sparse annotations
# make sense.
		if ($line =~ /\btypedef\s/ &&
4449
		    $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
4450
		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
4451
		    $line !~ /\b$typeTypedefs\b/ &&
4452
		    $line !~ /\b__bitwise\b/) {
4453 4454
			WARN("NEW_TYPEDEFS",
			     "do not add new typedefs\n" . $herecurr);
4455 4456 4457
		}

# * goes on variable not on type
4458
		# (char*[ const])
4459 4460
		while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
			#print "AA<$1>\n";
4461
			my ($ident, $from, $to) = ($1, $2, $2);
4462 4463 4464 4465 4466 4467

			# Should start with a space.
			$to =~ s/^(\S)/ $1/;
			# Should not end with a space.
			$to =~ s/\s+$//;
			# '*'s should not have spaces between.
4468
			while ($to =~ s/\*\s+\*/\*\*/) {
4469
			}
4470

4471
##			print "1: from<$from> to<$to> ident<$ident>\n";
4472
			if ($from ne $to) {
4473 4474 4475 4476 4477 4478
				if (ERROR("POINTER_LOCATION",
					  "\"(foo$from)\" should be \"(foo$to)\"\n" .  $herecurr) &&
				    $fix) {
					my $sub_from = $ident;
					my $sub_to = $ident;
					$sub_to =~ s/\Q$from\E/$to/;
4479
					$fixed[$fixlinenr] =~
4480 4481
					    s@\Q$sub_from\E@$sub_to@;
				}
4482
			}
4483 4484 4485
		}
		while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
			#print "BB<$1>\n";
4486
			my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
4487 4488 4489 4490 4491 4492

			# Should start with a space.
			$to =~ s/^(\S)/ $1/;
			# Should not end with a space.
			$to =~ s/\s+$//;
			# '*'s should not have spaces between.
4493
			while ($to =~ s/\*\s+\*/\*\*/) {
4494 4495 4496
			}
			# Modifiers should have spaces.
			$to =~ s/(\b$Modifier$)/$1 /;
4497

4498
##			print "2: from<$from> to<$to> ident<$ident>\n";
4499
			if ($from ne $to && $ident !~ /^$Modifier$/) {
4500 4501 4502 4503 4504 4505 4506
				if (ERROR("POINTER_LOCATION",
					  "\"foo${from}bar\" should be \"foo${to}bar\"\n" .  $herecurr) &&
				    $fix) {

					my $sub_from = $match;
					my $sub_to = $match;
					$sub_to =~ s/\Q$from\E/$to/;
4507
					$fixed[$fixlinenr] =~
4508 4509
					    s@\Q$sub_from\E@$sub_to@;
				}
4510
			}
4511 4512
		}

4513 4514
# avoid BUG() or BUG_ON()
		if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
4515 4516 4517 4518
			my $msg_level = \&WARN;
			$msg_level = \&CHK if ($file);
			&{$msg_level}("AVOID_BUG",
				      "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
4519
		}
4520

4521
# avoid LINUX_VERSION_CODE
4522
		if ($line =~ /\bLINUX_VERSION_CODE\b/) {
4523 4524
			WARN("LINUX_VERSION_CODE",
			     "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
4525 4526
		}

4527 4528
# check for uses of printk_ratelimit
		if ($line =~ /\bprintk_ratelimit\s*\(/) {
4529
			WARN("PRINTK_RATELIMITED",
4530
			     "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
4531 4532
		}

4533 4534 4535 4536
# printk should use KERN_* levels
		if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
			WARN("PRINTK_WITHOUT_KERN_LEVEL",
			     "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
4537 4538
		}

4539 4540 4541 4542 4543 4544
# prefer variants of (subsystem|netdev|dev|pr)_<level> to printk(KERN_<LEVEL>
		if ($line =~ /\b(printk(_once|_ratelimited)?)\s*\(\s*KERN_([A-Z]+)/) {
			my $printk = $1;
			my $modifier = $2;
			my $orig = $3;
			$modifier = "" if (!defined($modifier));
4545 4546
			my $level = lc($orig);
			$level = "warn" if ($level eq "warning");
4547 4548
			my $level2 = $level;
			$level2 = "dbg" if ($level eq "debug");
4549 4550
			$level .= $modifier;
			$level2 .= $modifier;
4551
			WARN("PREFER_PR_LEVEL",
4552
			     "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(...  to $printk(KERN_$orig ...\n" . $herecurr);
4553 4554
		}

4555
# prefer dev_<level> to dev_printk(KERN_<LEVEL>
4556 4557 4558 4559 4560 4561 4562 4563 4564
		if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
			my $orig = $1;
			my $level = lc($orig);
			$level = "warn" if ($level eq "warning");
			$level = "dbg" if ($level eq "debug");
			WARN("PREFER_DEV_LEVEL",
			     "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
		}

4565 4566 4567 4568 4569 4570
# trace_printk should not be used in production code.
		if ($line =~ /\b(trace_printk|trace_puts|ftrace_vprintk)\s*\(/) {
			WARN("TRACE_PRINTK",
			     "Do not use $1() in production code (this can be ignored if built only with a debug config option)\n" . $herecurr);
		}

4571 4572 4573 4574 4575 4576 4577 4578
# ENOSYS means "bad syscall nr" and nothing else.  This will have a small
# number of false positives, but assembly files are not checked, so at
# least the arch entry code will not trigger this warning.
		if ($line =~ /\bENOSYS\b/) {
			WARN("ENOSYS",
			     "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
		}

4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589
# ENOTSUPP is not a standard error code and should be avoided in new patches.
# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP.
# Similarly to ENOSYS warning a small number of false positives is expected.
		if (!$file && $line =~ /\bENOTSUPP\b/) {
			if (WARN("ENOTSUPP",
				 "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) &&
			    $fix) {
				$fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/;
			}
		}

4590 4591
# function brace can't be on same line, except for #defines of do while,
# or if closed on same line
4592
		if ($perl_version_ok &&
4593 4594 4595
		    $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
		    $sline !~ /\#\s*define\b.*do\s*\{/ &&
		    $sline !~ /}/) {
4596
			if (ERROR("OPEN_BRACE",
4597
				  "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
4598 4599 4600
			    $fix) {
				fix_delete_line($fixlinenr, $rawline);
				my $fixed_line = $rawline;
4601
				$fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*)\{(.*)$/;
4602 4603 4604 4605 4606 4607 4608 4609
				my $line1 = $1;
				my $line2 = $2;
				fix_insert_line($fixlinenr, ltrim($line1));
				fix_insert_line($fixlinenr, "\+{");
				if ($line2 !~ /^\s*$/) {
					fix_insert_line($fixlinenr, "\+\t" . trim($line2));
				}
			}
4610
		}
4611

4612 4613 4614
# open braces for enum, union and struct go on the same line.
		if ($line =~ /^.\s*{/ &&
		    $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
4615 4616 4617 4618 4619 4620 4621 4622
			if (ERROR("OPEN_BRACE",
				  "open brace '{' following $1 go on the same line\n" . $hereprev) &&
			    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
				fix_delete_line($fixlinenr - 1, $prevrawline);
				fix_delete_line($fixlinenr, $rawline);
				my $fixedline = rtrim($prevrawline) . " {";
				fix_insert_line($fixlinenr, $fixedline);
				$fixedline = $rawline;
4623
				$fixedline =~ s/^(.\s*)\{\s*/$1\t/;
4624 4625 4626 4627
				if ($fixedline !~ /^\+\s*$/) {
					fix_insert_line($fixlinenr, $fixedline);
				}
			}
4628 4629
		}

4630
# missing space after union, struct or enum definition
4631 4632 4633 4634
		if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
			if (WARN("SPACING",
				 "missing space after $1 definition\n" . $herecurr) &&
			    $fix) {
4635
				$fixed[$fixlinenr] =~
4636 4637
				    s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
			}
4638 4639
		}

4640 4641 4642
# Function pointer declarations
# check spacing between type, funcptr, and args
# canonical declaration is "type (*funcptr)(args...)"
4643
		if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
4644 4645 4646 4647 4648 4649 4650
			my $declare = $1;
			my $pre_pointer_space = $2;
			my $post_pointer_space = $3;
			my $funcname = $4;
			my $post_funcname_space = $5;
			my $pre_args_space = $6;

4651 4652 4653 4654 4655 4656 4657 4658 4659
# the $Declare variable will capture all spaces after the type
# so check it for a missing trailing missing space but pointer return types
# don't need a space so don't warn for those.
			my $post_declare_space = "";
			if ($declare =~ /(\s+)$/) {
				$post_declare_space = $1;
				$declare = rtrim($declare);
			}
			if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
4660 4661
				WARN("SPACING",
				     "missing space after return type\n" . $herecurr);
4662
				$post_declare_space = " ";
4663 4664 4665
			}

# unnecessary space "type  (*funcptr)(args...)"
4666 4667 4668 4669 4670 4671 4672 4673 4674
# This test is not currently implemented because these declarations are
# equivalent to
#	int  foo(int bar, ...)
# and this is form shouldn't/doesn't generate a checkpatch warning.
#
#			elsif ($declare =~ /\s{2,}$/) {
#				WARN("SPACING",
#				     "Multiple spaces after return type\n" . $herecurr);
#			}
4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704

# unnecessary space "type ( *funcptr)(args...)"
			if (defined $pre_pointer_space &&
			    $pre_pointer_space =~ /^\s/) {
				WARN("SPACING",
				     "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
			}

# unnecessary space "type (* funcptr)(args...)"
			if (defined $post_pointer_space &&
			    $post_pointer_space =~ /^\s/) {
				WARN("SPACING",
				     "Unnecessary space before function pointer name\n" . $herecurr);
			}

# unnecessary space "type (*funcptr )(args...)"
			if (defined $post_funcname_space &&
			    $post_funcname_space =~ /^\s/) {
				WARN("SPACING",
				     "Unnecessary space after function pointer name\n" . $herecurr);
			}

# unnecessary space "type (*funcptr) (args...)"
			if (defined $pre_args_space &&
			    $pre_args_space =~ /^\s/) {
				WARN("SPACING",
				     "Unnecessary space before function pointer arguments\n" . $herecurr);
			}

			if (show_type("SPACING") && $fix) {
4705
				$fixed[$fixlinenr] =~
4706
				    s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4707 4708 4709
			}
		}

4710 4711
# check for spacing round square brackets; allowed:
#  1. with a type on the left -- int [] a;
4712 4713
#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
#  3. inside a curly brace -- = { [0...10] = 5 }
4714 4715 4716
		while ($line =~ /(.*?\s)\[/g) {
			my ($where, $prefix) = ($-[1], $1);
			if ($prefix !~ /$Type\s+$/ &&
4717
			    ($where != 0 || $prefix !~ /^.\s+$/) &&
4718
			    $prefix !~ /[{,:]\s+$/) {
4719 4720 4721
				if (ERROR("BRACKET_SPACE",
					  "space prohibited before open square bracket '['\n" . $herecurr) &&
				    $fix) {
4722
				    $fixed[$fixlinenr] =~
4723 4724
					s/^(\+.*?)\s+\[/$1\[/;
				}
4725 4726 4727
			}
		}

4728
# check for spaces between functions and their parentheses.
4729
		while ($line =~ /($Ident)\s+\(/g) {
4730
			my $name = $1;
4731 4732
			my $ctx_before = substr($line, 0, $-[1]);
			my $ctx = "$ctx_before$name";
4733 4734

			# Ignore those directives where spaces _are_ permitted.
4735 4736 4737 4738 4739 4740
			if ($name =~ /^(?:
				if|for|while|switch|return|case|
				volatile|__volatile__|
				__attribute__|format|__extension__|
				asm|__asm__)$/x)
			{
4741 4742 4743
			# cpp #define statements have non-optional spaces, ie
			# if there is a space between the name and the open
			# parenthesis it is simply not a parameter group.
4744
			} elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
4745 4746

			# cpp #elif statement condition may start with a (
4747
			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
4748 4749 4750

			# If this whole things ends with a type its most
			# likely a typedef for a function.
4751
			} elsif ($ctx =~ /$Type$/) {
4752 4753

			} else {
4754 4755 4756
				if (WARN("SPACING",
					 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
					     $fix) {
4757
					$fixed[$fixlinenr] =~
4758 4759
					    s/\b$name\s+\(/$name\(/;
				}
4760
			}
4761
		}
4762

4763
# Check operator spacing.
4764
		if (!($line=~/\#\s*include/)) {
4765 4766 4767
			my $fixed_line = "";
			my $line_fixed = 0;

4768 4769 4770 4771
			my $ops = qr{
				<<=|>>=|<=|>=|==|!=|
				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
				=>|->|<<|>>|<|>|=|!|~|
4772
				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
4773
				\?:|\?|:
4774
			}x;
4775
			my @elements = split(/($ops|;)/, $opline);
4776 4777 4778 4779 4780 4781 4782

##			print("element count: <" . $#elements . ">\n");
##			foreach my $el (@elements) {
##				print("el: <$el>\n");
##			}

			my @fix_elements = ();
4783
			my $off = 0;
4784

4785 4786 4787 4788 4789 4790 4791
			foreach my $el (@elements) {
				push(@fix_elements, substr($rawline, $off, length($el)));
				$off += length($el);
			}

			$off = 0;

4792
			my $blank = copy_spacing($opline);
4793
			my $last_after = -1;
4794

4795
			for (my $n = 0; $n < $#elements; $n += 2) {
4796 4797 4798 4799 4800

				my $good = $fix_elements[$n] . $fix_elements[$n + 1];

##				print("n: <$n> good: <$good>\n");

4801 4802
				$off += length($elements[$n]);

L
Lucas De Marchi 已提交
4803
				# Pick up the preceding and succeeding characters.
4804 4805 4806 4807 4808 4809 4810
				my $ca = substr($opline, 0, $off);
				my $cc = '';
				if (length($opline) >= ($off + length($elements[$n + 1]))) {
					$cc = substr($opline, $off + length($elements[$n + 1]));
				}
				my $cb = "$ca$;$cc";

4811 4812 4813
				my $a = '';
				$a = 'V' if ($elements[$n] ne '');
				$a = 'W' if ($elements[$n] =~ /\s$/);
4814
				$a = 'C' if ($elements[$n] =~ /$;$/);
4815 4816
				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
				$a = 'O' if ($elements[$n] eq '');
4817
				$a = 'E' if ($ca =~ /^\s*$/);
4818

4819
				my $op = $elements[$n + 1];
4820 4821

				my $c = '';
4822
				if (defined $elements[$n + 2]) {
4823 4824
					$c = 'V' if ($elements[$n + 2] ne '');
					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
4825
					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
4826 4827
					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
					$c = 'O' if ($elements[$n + 2] eq '');
4828
					$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
4829 4830
				} else {
					$c = 'E';
4831 4832
				}

4833 4834 4835 4836
				my $ctx = "${a}x${c}";

				my $at = "(ctx:$ctx)";

4837
				my $ptr = substr($blank, 0, $off) . "^";
4838
				my $hereptr = "$hereline$ptr\n";
4839

4840
				# Pull out the value of this operator.
4841
				my $op_type = substr($curr_values, $off + 1, 1);
4842

4843 4844 4845
				# Get the full operator variant.
				my $opv = $op . substr($curr_vars, $off, 1);

4846 4847
				# Ignore operators passed as parameters.
				if ($op_type ne 'V' &&
4848
				    $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
4849

4850 4851
#				# Ignore comments
#				} elsif ($op =~ /^$;+$/) {
4852

4853
				# ; should have either the end of line or a space or \ after it
4854
				} elsif ($op eq ';') {
4855 4856
					if ($ctx !~ /.x[WEBC]/ &&
					    $cc !~ /^\\/ && $cc !~ /^;/) {
4857 4858
						if (ERROR("SPACING",
							  "space required after that '$op' $at\n" . $hereptr)) {
4859
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4860 4861
							$line_fixed = 1;
						}
4862 4863 4864 4865
					}

				# // is a comment
				} elsif ($op eq '//') {
4866

4867 4868 4869 4870
				#   :   when part of a bitfield
				} elsif ($opv eq ':B') {
					# skip the bitfield test for now

4871 4872
				# No spaces for:
				#   ->
4873
				} elsif ($op eq '->') {
4874
					if ($ctx =~ /Wx.|.xW/) {
4875 4876
						if (ERROR("SPACING",
							  "spaces prohibited around that '$op' $at\n" . $hereptr)) {
4877
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4878 4879 4880
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
4881
							$line_fixed = 1;
4882
						}
4883 4884
					}

4885
				# , must not have a space before and must have a space on the right.
4886
				} elsif ($op eq ',') {
4887 4888 4889 4890 4891 4892 4893 4894 4895
					my $rtrim_before = 0;
					my $space_after = 0;
					if ($ctx =~ /Wx./) {
						if (ERROR("SPACING",
							  "space prohibited before that '$op' $at\n" . $hereptr)) {
							$line_fixed = 1;
							$rtrim_before = 1;
						}
					}
4896
					if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
4897 4898 4899
						if (ERROR("SPACING",
							  "space required after that '$op' $at\n" . $hereptr)) {
							$line_fixed = 1;
4900
							$last_after = $n;
4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911
							$space_after = 1;
						}
					}
					if ($rtrim_before || $space_after) {
						if ($rtrim_before) {
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
						} else {
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
						}
						if ($space_after) {
							$good .= " ";
4912
						}
4913 4914
					}

4915
				# '*' as part of a type definition -- reported already.
4916
				} elsif ($opv eq '*_') {
4917 4918 4919 4920 4921 4922
					#warn "'*' is part of type\n";

				# unary operators should have a space before and
				# none after.  May be left adjacent to another
				# unary operator, or a cast
				} elsif ($op eq '!' || $op eq '~' ||
4923
					 $opv eq '*U' || $opv eq '-U' ||
4924
					 $opv eq '&U' || $opv eq '&&U') {
4925
					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
4926 4927
						if (ERROR("SPACING",
							  "space required before that '$op' $at\n" . $hereptr)) {
4928 4929 4930 4931
							if ($n != $last_after + 2) {
								$good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
								$line_fixed = 1;
							}
4932
						}
4933
					}
4934
					if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
4935 4936 4937
						# A unary '*' may be const

					} elsif ($ctx =~ /.xW/) {
4938 4939
						if (ERROR("SPACING",
							  "space prohibited after that '$op' $at\n" . $hereptr)) {
4940
							$good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
4941 4942 4943
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
4944
							$line_fixed = 1;
4945
						}
4946 4947 4948 4949
					}

				# unary ++ and unary -- are allowed no space on one side.
				} elsif ($op eq '++' or $op eq '--') {
4950
					if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
4951 4952
						if (ERROR("SPACING",
							  "space required one side of that '$op' $at\n" . $hereptr)) {
4953
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4954 4955
							$line_fixed = 1;
						}
4956 4957 4958
					}
					if ($ctx =~ /Wx[BE]/ ||
					    ($ctx =~ /Wx./ && $cc =~ /^;/)) {
4959 4960
						if (ERROR("SPACING",
							  "space prohibited before that '$op' $at\n" . $hereptr)) {
4961
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4962 4963
							$line_fixed = 1;
						}
4964
					}
4965
					if ($ctx =~ /ExW/) {
4966 4967
						if (ERROR("SPACING",
							  "space prohibited after that '$op' $at\n" . $hereptr)) {
4968
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4969 4970 4971
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
4972
							$line_fixed = 1;
4973
						}
4974
					}
4975 4976

				# << and >> may either have or not have spaces both sides
4977 4978 4979
				} elsif ($op eq '<<' or $op eq '>>' or
					 $op eq '&' or $op eq '^' or $op eq '|' or
					 $op eq '+' or $op eq '-' or
4980 4981
					 $op eq '*' or $op eq '/' or
					 $op eq '%')
4982
				{
4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998
					if ($check) {
						if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
							if (CHK("SPACING",
								"spaces preferred around that '$op' $at\n" . $hereptr)) {
								$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
								$fix_elements[$n + 2] =~ s/^\s+//;
								$line_fixed = 1;
							}
						} elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
							if (CHK("SPACING",
								"space preferred before that '$op' $at\n" . $hereptr)) {
								$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
								$line_fixed = 1;
							}
						}
					} elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
4999 5000
						if (ERROR("SPACING",
							  "need consistent spacing around '$op' $at\n" . $hereptr)) {
5001 5002 5003 5004
							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
5005 5006
							$line_fixed = 1;
						}
5007 5008
					}

5009 5010 5011 5012
				# A colon needs no spaces before when it is
				# terminating a case value or a label.
				} elsif ($opv eq ':C' || $opv eq ':L') {
					if ($ctx =~ /Wx./) {
5013 5014
						if (ERROR("SPACING",
							  "space prohibited before that '$op' $at\n" . $hereptr)) {
5015
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
5016 5017
							$line_fixed = 1;
						}
5018 5019
					}

5020
				# All the others need spaces both sides.
5021
				} elsif ($ctx !~ /[EWC]x[CWE]/) {
5022 5023
					my $ok = 0;

5024
					# Ignore email addresses <foo@bar>
5025 5026 5027 5028 5029
					if (($op eq '<' &&
					     $cc =~ /^\S+\@\S+>/) ||
					    ($op eq '>' &&
					     $ca =~ /<\S+\@\S+$/))
					{
5030
						$ok = 1;
5031 5032
					}

5033 5034 5035 5036 5037 5038 5039 5040
					# for asm volatile statements
					# ignore a colon with another
					# colon immediately before or after
					if (($op eq ':') &&
					    ($ca =~ /:$/ || $cc =~ /^:/)) {
						$ok = 1;
					}

5041
					# messages are ERROR, but ?: are CHK
5042
					if ($ok == 0) {
5043 5044
						my $msg_level = \&ERROR;
						$msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
5045

5046 5047
						if (&{$msg_level}("SPACING",
								  "spaces required around that '$op' $at\n" . $hereptr)) {
5048 5049 5050 5051
							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
5052 5053
							$line_fixed = 1;
						}
5054
					}
5055
				}
5056
				$off += length($elements[$n + 1]);
5057 5058 5059 5060 5061 5062 5063 5064

##				print("n: <$n> GOOD: <$good>\n");

				$fixed_line = $fixed_line . $good;
			}

			if (($#elements % 2) == 0) {
				$fixed_line = $fixed_line . $fix_elements[$#elements];
5065
			}
5066

5067 5068
			if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
				$fixed[$fixlinenr] = $fixed_line;
5069 5070 5071
			}


5072 5073
		}

5074
# check for whitespace before a non-naked semicolon
5075
		if ($line =~ /^\+.*\S\s+;\s*$/) {
5076 5077 5078
			if (WARN("SPACING",
				 "space prohibited before semicolon\n" . $herecurr) &&
			    $fix) {
5079
				1 while $fixed[$fixlinenr] =~
5080 5081 5082 5083
				    s/^(\+.*\S)\s+;/$1;/;
			}
		}

5084 5085
# check for multiple assignments
		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
5086 5087
			CHK("MULTIPLE_ASSIGNMENTS",
			    "multiple assignments should be avoided\n" . $herecurr);
5088 5089
		}

5090 5091 5092 5093 5094 5095
## # check for multiple declarations, allowing for a function declaration
## # continuation.
## 		if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
## 		    $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
##
## 			# Remove any bracketed sections to ensure we do not
5096
## 			# falsely report the parameters of functions.
5097 5098 5099 5100
## 			my $ln = $line;
## 			while ($ln =~ s/\([^\(\)]*\)//g) {
## 			}
## 			if ($ln =~ /,/) {
5101 5102
## 				WARN("MULTIPLE_DECLARATION",
##				     "declaring multiple variables together should be avoided\n" . $herecurr);
5103 5104
## 			}
## 		}
5105

5106
#need space before brace following if, while, etc
5107
		if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
5108
		    $line =~ /\b(?:else|do)\{/) {
5109 5110 5111
			if (ERROR("SPACING",
				  "space required before the open brace '{'\n" . $herecurr) &&
			    $fix) {
5112
				$fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/;
5113
			}
5114 5115
		}

5116 5117 5118 5119 5120 5121 5122 5123
## # check for blank lines before declarations
##		if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
##		    $prevrawline =~ /^.\s*$/) {
##			WARN("SPACING",
##			     "No blank lines before declarations\n" . $hereprev);
##		}
##

5124 5125
# closing brace should have a space following it when it has anything
# on the line
5126
		if ($line =~ /}(?!(?:,|;|\)|\}))\S/) {
5127 5128 5129
			if (ERROR("SPACING",
				  "space required after that close brace '}'\n" . $herecurr) &&
			    $fix) {
5130
				$fixed[$fixlinenr] =~
5131 5132
				    s/}((?!(?:,|;|\)))\S)/} $1/;
			}
5133 5134
		}

5135 5136
# check spacing on square brackets
		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
5137 5138 5139
			if (ERROR("SPACING",
				  "space prohibited after that open square bracket '['\n" . $herecurr) &&
			    $fix) {
5140
				$fixed[$fixlinenr] =~
5141 5142
				    s/\[\s+/\[/;
			}
5143 5144
		}
		if ($line =~ /\s\]/) {
5145 5146 5147
			if (ERROR("SPACING",
				  "space prohibited before that close square bracket ']'\n" . $herecurr) &&
			    $fix) {
5148
				$fixed[$fixlinenr] =~
5149 5150
				    s/\s+\]/\]/;
			}
5151 5152
		}

5153
# check spacing on parentheses
5154 5155
		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
		    $line !~ /for\s*\(\s+;/) {
5156 5157 5158
			if (ERROR("SPACING",
				  "space prohibited after that open parenthesis '('\n" . $herecurr) &&
			    $fix) {
5159
				$fixed[$fixlinenr] =~
5160 5161
				    s/\(\s+/\(/;
			}
5162
		}
5163
		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
5164 5165
		    $line !~ /for\s*\(.*;\s+\)/ &&
		    $line !~ /:\s+\)/) {
5166 5167 5168
			if (ERROR("SPACING",
				  "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
			    $fix) {
5169
				$fixed[$fixlinenr] =~
5170 5171
				    s/\s+\)/\)/;
			}
5172 5173
		}

5174 5175 5176 5177
# check unnecessary parentheses around addressof/dereference single $Lvals
# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar

		while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198
			my $var = $1;
			if (CHK("UNNECESSARY_PARENTHESES",
				"Unnecessary parentheses around $var\n" . $herecurr) &&
			    $fix) {
				$fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
			}
		}

# check for unnecessary parentheses around function pointer uses
# ie: (foo->bar)(); should be foo->bar();
# but not "if (foo->bar) (" to avoid some false positives
		if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
			my $var = $2;
			if (CHK("UNNECESSARY_PARENTHESES",
				"Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
			    $fix) {
				my $var2 = deparenthesize($var);
				$var2 =~ s/\s//g;
				$fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
			}
		}
5199

5200
# check for unnecessary parentheses around comparisons in if uses
5201 5202
# when !drivers/staging or command-line uses --strict
		if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
5203
		    $perl_version_ok && defined($stat) &&
5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225
		    $stat =~ /(^.\s*if\s*($balanced_parens))/) {
			my $if_stat = $1;
			my $test = substr($2, 1, -1);
			my $herectx;
			while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
				my $match = $1;
				# avoid parentheses around potential macro args
				next if ($match =~ /^\s*\w+\s*$/);
				if (!defined($herectx)) {
					$herectx = $here . "\n";
					my $cnt = statement_rawlines($if_stat);
					for (my $n = 0; $n < $cnt; $n++) {
						my $rl = raw_line($linenr, $n);
						$herectx .=  $rl . "\n";
						last if $rl =~ /^[ \+].*\{/;
					}
				}
				CHK("UNNECESSARY_PARENTHESES",
				    "Unnecessary parentheses around '$match'\n" . $herectx);
			}
		}

5226
#goto labels aren't indented, allow a single space however
5227
		if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
5228
		   !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
5229 5230 5231
			if (WARN("INDENTED_LABEL",
				 "labels should not be indented\n" . $herecurr) &&
			    $fix) {
5232
				$fixed[$fixlinenr] =~
5233 5234
				    s/^(.)\s+/$1/;
			}
5235 5236
		}

5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247
# check if a statement with a comma should be two statements like:
#	foo = bar(),	/* comma should be semicolon */
#	bar = baz();
		if (defined($stat) &&
		    $stat =~ /^\+\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*,\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*;\s*$/) {
			my $cnt = statement_rawlines($stat);
			my $herectx = get_stat_here($linenr, $cnt, $here);
			WARN("SUSPECT_COMMA_SEMICOLON",
			     "Possible comma where semicolon could be used\n" . $herectx);
		}

5248
# return is not a function
5249
		if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
5250
			my $spacing = $1;
5251
			if ($perl_version_ok &&
5252 5253 5254 5255 5256 5257 5258
			    $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
				my $value = $1;
				$value = deparenthesize($value);
				if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
					ERROR("RETURN_PARENTHESES",
					      "return is not a function, parentheses are not required\n" . $herecurr);
				}
5259
			} elsif ($spacing !~ /\s+/) {
5260 5261
				ERROR("SPACING",
				      "space required before the open parenthesis '('\n" . $herecurr);
5262 5263
			}
		}
5264

5265 5266 5267 5268 5269 5270 5271 5272
# unnecessary return in a void function
# at end-of-function, with the previous line a single leading tab, then return;
# and the line before that not a goto label target like "out:"
		if ($sline =~ /^[ \+]}\s*$/ &&
		    $prevline =~ /^\+\treturn\s*;\s*$/ &&
		    $linenr >= 3 &&
		    $lines[$linenr - 3] =~ /^[ +]/ &&
		    $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
5273
			WARN("RETURN_VOID",
5274 5275
			     "void function return statements are not generally useful\n" . $hereprev);
               }
5276

5277
# if statements using unnecessary parentheses - ie: if ((foo == bar))
5278
		if ($perl_version_ok &&
5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290
		    $line =~ /\bif\s*((?:\(\s*){2,})/) {
			my $openparens = $1;
			my $count = $openparens =~ tr@\(@\(@;
			my $msg = "";
			if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
				my $comp = $4;	#Not $1 because of $LvalOrFunc
				$msg = " - maybe == should be = ?" if ($comp eq "==");
				WARN("UNNECESSARY_PARENTHESES",
				     "Unnecessary parentheses$msg\n" . $herecurr);
			}
		}

5291 5292 5293 5294
# comparisons with a constant or upper case identifier on the left
#	avoid cases like "foo + BAR < baz"
#	only fix matches surrounded by parentheses to avoid incorrect
#	conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
5295
		if ($perl_version_ok &&
5296 5297 5298 5299 5300 5301
		    $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
			my $lead = $1;
			my $const = $2;
			my $comp = $3;
			my $to = $4;
			my $newcomp = $comp;
5302
			if ($lead !~ /(?:$Operators|\.)\s*$/ &&
5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319
			    $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
			    WARN("CONSTANT_COMPARISON",
				 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
			    $fix) {
				if ($comp eq "<") {
					$newcomp = ">";
				} elsif ($comp eq "<=") {
					$newcomp = ">=";
				} elsif ($comp eq ">") {
					$newcomp = "<";
				} elsif ($comp eq ">=") {
					$newcomp = "<=";
				}
				$fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
			}
		}

5320 5321
# Return of what appears to be an errno should normally be negative
		if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
5322 5323
			my $name = $1;
			if ($name ne 'EOF' && $name ne 'ERROR') {
5324
				WARN("USE_NEGATIVE_ERRNO",
5325
				     "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
5326 5327
			}
		}
5328

5329
# Need a space before open parenthesis after if, while etc
5330 5331 5332 5333
		if ($line =~ /\b(if|while|for|switch)\(/) {
			if (ERROR("SPACING",
				  "space required before the open parenthesis '('\n" . $herecurr) &&
			    $fix) {
5334
				$fixed[$fixlinenr] =~
5335 5336
				    s/\b(if|while|for|switch)\(/$1 \(/;
			}
5337 5338
		}

5339 5340
# Check for illegal assignment in if conditional -- and check for trailing
# statements after the conditional.
5341
		if ($line =~ /do\s*(?!{)/) {
5342 5343 5344
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362
			my ($stat_next) = ctx_statement_block($line_nr_next,
						$remain_next, $off_next);
			$stat_next =~ s/\n./\n /g;
			##print "stat<$stat> stat_next<$stat_next>\n";

			if ($stat_next =~ /^\s*while\b/) {
				# If the statement carries leading newlines,
				# then count those as offsets.
				my ($whitespace) =
					($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
				my $offset =
					statement_rawlines($whitespace) - 1;

				$suppress_whiletrailers{$line_nr_next +
								$offset} = 1;
			}
		}
		if (!defined $suppress_whiletrailers{$linenr} &&
5363
		    defined($stat) && defined($cond) &&
5364
		    $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
5365
			my ($s, $c) = ($stat, $cond);
5366

5367
			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391
				if (ERROR("ASSIGN_IN_IF",
					  "do not use assignment in if condition\n" . $herecurr) &&
				    $fix && $perl_version_ok) {
					if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) {
						my $space = $1;
						my $not = $2;
						my $statement = $3;
						my $assigned = $4;
						my $test = $8;
						my $against = $9;
						my $brace = $15;
						fix_delete_line($fixlinenr, $rawline);
						fix_insert_line($fixlinenr, "$space$statement;");
						my $newline = "${space}if (";
						$newline .= '!' if defined($not);
						$newline .= '(' if (defined $not && defined($test) && defined($against));
						$newline .= "$assigned";
						$newline .= " $test $against" if (defined($test) && defined($against));
						$newline .= ')' if (defined $not && defined($test) && defined($against));
						$newline .= ')';
						$newline .= " {" if (defined($brace));
						fix_insert_line($fixlinenr + 1, $newline);
					}
				}
5392 5393 5394 5395
			}

			# Find out what is on the end of the line after the
			# conditional.
5396
			substr($s, 0, length($c), '');
5397
			$s =~ s/\n.*//g;
5398
			$s =~ s/$;//g;	# Remove any comments
5399 5400
			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
			    $c !~ /}\s*while\s*/)
5401
			{
5402 5403 5404
				# Find out how long the conditional actually is.
				my @newlines = ($c =~ /\n/gs);
				my $cond_lines = 1 + $#newlines;
5405
				my $stat_real = '';
5406

5407 5408
				$stat_real = raw_line($linenr, $cond_lines)
							. "\n" if ($cond_lines);
5409 5410 5411 5412
				if (defined($stat_real) && $cond_lines > 1) {
					$stat_real = "[...]\n$stat_real";
				}

5413 5414
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr . $stat_real);
5415 5416 5417
			}
		}

5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429
# Check for bitwise tests written as boolean
		if ($line =~ /
			(?:
				(?:\[|\(|\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\|)
			|
				(?:\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\||\)|\])
			)/x)
		{
5430 5431
			WARN("HEXADECIMAL_BOOLEAN_TEST",
			     "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
5432 5433
		}

5434
# if and else should not have general statements after it
5435 5436
		if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
			my $s = $1;
5437
			$s =~ s/$;//g;	# Remove any comments
5438
			if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
5439 5440
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr);
5441
			}
5442
		}
5443 5444
# if should not continue a brace
		if ($line =~ /}\s*if\b/) {
5445
			ERROR("TRAILING_STATEMENTS",
5446
			      "trailing statements should be on next line (or did you mean 'else if'?)\n" .
5447 5448
				$herecurr);
		}
5449 5450 5451
# case and default should not have general statements after them
		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
		    $line !~ /\G(?:
5452
			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
5453 5454 5455
			\s*return\s+
		    )/xg)
		{
5456 5457
			ERROR("TRAILING_STATEMENTS",
			      "trailing statements should be on next line\n" . $herecurr);
5458
		}
5459 5460 5461

		# Check for }<nl>else {, these must be at the same
		# indent level to be relevant to each other.
5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477
		if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
		    $previndent == $indent) {
			if (ERROR("ELSE_AFTER_BRACE",
				  "else should follow close brace '}'\n" . $hereprev) &&
			    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
				fix_delete_line($fixlinenr - 1, $prevrawline);
				fix_delete_line($fixlinenr, $rawline);
				my $fixedline = $prevrawline;
				$fixedline =~ s/}\s*$//;
				if ($fixedline !~ /^\+\s*$/) {
					fix_insert_line($fixlinenr, $fixedline);
				}
				$fixedline = $rawline;
				$fixedline =~ s/^(.\s*)else/$1} else/;
				fix_insert_line($fixlinenr, $fixedline);
			}
5478 5479
		}

5480 5481
		if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
		    $previndent == $indent) {
5482 5483 5484 5485
			my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);

			# Find out what is on the end of the line after the
			# conditional.
5486
			substr($s, 0, length($c), '');
5487 5488 5489
			$s =~ s/\n.*//g;

			if ($s =~ /^\s*;/) {
5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501
				if (ERROR("WHILE_AFTER_BRACE",
					  "while should follow close brace '}'\n" . $hereprev) &&
				    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
					fix_delete_line($fixlinenr - 1, $prevrawline);
					fix_delete_line($fixlinenr, $rawline);
					my $fixedline = $prevrawline;
					my $trailing = $rawline;
					$trailing =~ s/^\+//;
					$trailing = trim($trailing);
					$fixedline =~ s/}\s*$/} $trailing/;
					fix_insert_line($fixlinenr, $fixedline);
				}
5502 5503 5504
			}
		}

5505
#Specific variable tests
5506 5507
		while ($line =~ m{($Constant|$Lval)}g) {
			my $var = $1;
5508 5509

#CamelCase
5510
			if ($var !~ /^$Constant$/ &&
5511
			    $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
5512 5513
#Ignore some autogenerated defines and enum values
			    $var !~ /^(?:[A-Z]+_){1,5}[A-Z]{1,3}[a-z]/ &&
5514
#Ignore Page<foo> variants
5515
			    $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
5516 5517 5518
#Ignore SI style variants like nS, mV and dB
#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
			    $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ &&
5519 5520
#Ignore some three character SI units explicitly, like MiB and KHz
			    $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
5521 5522 5523
				while ($var =~ m{($Ident)}g) {
					my $word = $1;
					next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
5524 5525 5526 5527 5528 5529 5530
					if ($check) {
						seed_camelcase_includes();
						if (!$file && !$camelcase_file_seeded) {
							seed_camelcase_file($realfile);
							$camelcase_file_seeded = 1;
						}
					}
5531 5532 5533 5534 5535
					if (!defined $camelcase{$word}) {
						$camelcase{$word} = 1;
						CHK("CAMELCASE",
						    "Avoid CamelCase: <$word>\n" . $herecurr);
					}
5536
				}
5537 5538
			}
		}
5539 5540

#no spaces allowed after \ in define
5541 5542 5543 5544
		if ($line =~ /\#\s*define.*\\\s+$/) {
			if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
				 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
			    $fix) {
5545
				$fixed[$fixlinenr] =~ s/\s+$//;
5546
			}
5547 5548
		}

5549 5550
# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
# itself <asm/foo.h> (uses RAW line)
5551
		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
5552 5553 5554 5555
			my $file = "$1.h";
			my $checkfile = "include/linux/$file";
			if (-f "$root/$checkfile" &&
			    $realfile ne $checkfile &&
5556
			    $1 !~ /$allowed_asm_includes/)
5557
			{
5558 5559 5560 5561 5562 5563 5564 5565 5566
				my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
				if ($asminclude > 0) {
					if ($realfile =~ m{^arch/}) {
						CHK("ARCH_INCLUDE_LINUX",
						    "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
					} else {
						WARN("INCLUDE_LINUX",
						     "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
					}
5567
				}
5568 5569 5570
			}
		}

5571 5572
# multi-statement macros should be enclosed in a do while loop, grab the
# first statement and ensure its the whole macro if its not enclosed
5573
# in a known good container
5574 5575
		if ($realfile !~ m@/vmlinux.lds.h$@ &&
		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
5576 5577
			my $ln = $linenr;
			my $cnt = $realcnt;
5578 5579
			my ($off, $dstat, $dcond, $rest);
			my $ctx = '';
5580 5581
			my $has_flow_statement = 0;
			my $has_arg_concat = 0;
5582
			($dstat, $dcond, $ln, $cnt, $off) =
5583 5584
				ctx_statement_block($linenr, $realcnt, 0);
			$ctx = $dstat;
5585
			#print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5586
			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5587

5588
			$has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
5589
			$has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
5590

5591 5592 5593 5594 5595 5596 5597 5598
			$dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
			my $define_args = $1;
			my $define_stmt = $dstat;
			my @def_args = ();

			if (defined $define_args && $define_args ne "") {
				$define_args = substr($define_args, 1, length($define_args) - 2);
				$define_args =~ s/\s*//g;
5599
				$define_args =~ s/\\\+?//g;
5600 5601 5602
				@def_args = split(",", $define_args);
			}

5603
			$dstat =~ s/$;//g;
5604 5605 5606
			$dstat =~ s/\\\n.//g;
			$dstat =~ s/^\s*//s;
			$dstat =~ s/\s*$//s;
5607

5608
			# Flatten any parentheses and braces
5609 5610 5611
			while ($dstat =~ s/\([^\(\)]*\)/1u/ ||
			       $dstat =~ s/\{[^\{\}]*\}/1u/ ||
			       $dstat =~ s/.\[[^\[\]]*\]/1u/)
5612
			{
5613
			}
5614

5615
			# Flatten any obvious string concatenation.
5616 5617
			while ($dstat =~ s/($String)\s*$Ident/$1/ ||
			       $dstat =~ s/$Ident\s*($String)/$1/)
5618 5619 5620
			{
			}

5621 5622 5623
			# Make asm volatile uses seem like a generic function
			$dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;

5624 5625 5626
			my $exceptions = qr{
				$Declare|
				module_param_named|
5627
				MODULE_PARM_DESC|
5628 5629
				DECLARE_PER_CPU|
				DEFINE_PER_CPU|
5630
				__typeof__\(|
5631 5632
				union|
				struct|
5633
				\.$Ident\s*=\s*|
5634 5635
				^\"|\"$|
				^\[
5636
			}x;
5637
			#print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5638 5639 5640

			$ctx =~ s/\n*$//;
			my $stmt_cnt = statement_rawlines($ctx);
5641
			my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
5642

5643 5644 5645
			if ($dstat ne '' &&
			    $dstat !~ /^(?:$Ident|-?$Constant),$/ &&			# 10, // foo(),
			    $dstat !~ /^(?:$Ident|-?$Constant);$/ &&			# foo();
5646
			    $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ &&		# 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5647
			    $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ &&			# character constants
5648 5649
			    $dstat !~ /$exceptions/ &&
			    $dstat !~ /^\.$Ident\s*=/ &&				# .foo =
5650
			    $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ &&		# stringification #foo
5651
			    $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ &&	# do {...} while (...); // do {...} while (...)
5652
			    $dstat !~ /^while\s*$Constant\s*$Constant\s*$/ &&		# while (...) {...}
5653 5654 5655
			    $dstat !~ /^for\s*$Constant$/ &&				# for (...)
			    $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ &&	# for (...) bar()
			    $dstat !~ /^do\s*{/ &&					# do {...
5656
			    $dstat !~ /^\(\{/ &&						# ({...
5657
			    $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
5658
			{
5659 5660 5661 5662
				if ($dstat =~ /^\s*if\b/) {
					ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
					      "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
				} elsif ($dstat =~ /;/) {
5663 5664 5665
					ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
					      "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
				} else {
5666
					ERROR("COMPLEX_MACRO",
A
Andrew Morton 已提交
5667
					      "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
5668
				}
5669 5670

			}
5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688

			# Make $define_stmt single line, comment-free, etc
			my @stmt_array = split('\n', $define_stmt);
			my $first = 1;
			$define_stmt = "";
			foreach my $l (@stmt_array) {
				$l =~ s/\\$//;
				if ($first) {
					$define_stmt = $l;
					$first = 0;
				} elsif ($l =~ /^[\+ ]/) {
					$define_stmt .= substr($l, 1);
				}
			}
			$define_stmt =~ s/$;//g;
			$define_stmt =~ s/\s+/ /g;
			$define_stmt = trim($define_stmt);

5689 5690 5691
# check if any macro arguments are reused (ignore '...' and 'type')
			foreach my $arg (@def_args) {
			        next if ($arg =~ /\.\.\./);
5692
			        next if ($arg =~ /^type$/i);
5693
				my $tmp_stmt = $define_stmt;
5694
				$tmp_stmt =~ s/\b(sizeof|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5695 5696
				$tmp_stmt =~ s/\#+\s*$arg\b//g;
				$tmp_stmt =~ s/\b$arg\s*\#\#//g;
5697
				my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
5698 5699 5700
				if ($use_cnt > 1) {
					CHK("MACRO_ARG_REUSE",
					    "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
5701 5702
				    }
# check if any macro arguments may have other precedence issues
5703
				if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
5704 5705 5706 5707
				    ((defined($1) && $1 ne ',') ||
				     (defined($2) && $2 ne ','))) {
					CHK("MACRO_ARG_PRECEDENCE",
					    "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
5708
				}
5709
			}
5710

5711 5712 5713 5714
# check for macros with flow control, but without ## concatenation
# ## concatenation is commonly a macro that defines a function so ignore those
			if ($has_flow_statement && !$has_arg_concat) {
				my $cnt = statement_rawlines($ctx);
5715
				my $herectx = get_stat_here($linenr, $cnt, $here);
5716 5717 5718 5719 5720

				WARN("MACRO_WITH_FLOW_CONTROL",
				     "Macros with flow control statements should be avoided\n" . "$herectx");
			}

5721
# check for line continuations outside of #defines, preprocessor #, and asm
5722 5723 5724

		} else {
			if ($prevline !~ /^..*\\$/ &&
5725 5726
			    $line !~ /^\+\s*\#.*\\$/ &&		# preprocessor
			    $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ &&	# asm
5727 5728 5729 5730
			    $line =~ /^\+.*\\$/) {
				WARN("LINE_CONTINUATIONS",
				     "Avoid unnecessary line continuations\n" . $herecurr);
			}
5731 5732
		}

5733 5734 5735
# do {} while (0) macro tests:
# single-statement macros do not need to be enclosed in do while (0) loop,
# macro should not end with a semicolon
5736
		if ($perl_version_ok &&
5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747
		    $realfile !~ m@/vmlinux.lds.h$@ &&
		    $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
			my $ln = $linenr;
			my $cnt = $realcnt;
			my ($off, $dstat, $dcond, $rest);
			my $ctx = '';
			($dstat, $dcond, $ln, $cnt, $off) =
				ctx_statement_block($linenr, $realcnt, 0);
			$ctx = $dstat;

			$dstat =~ s/\\\n.//g;
5748
			$dstat =~ s/$;/ /g;
5749 5750 5751 5752 5753 5754 5755

			if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
				my $stmts = $2;
				my $semis = $3;

				$ctx =~ s/\n*$//;
				my $cnt = statement_rawlines($ctx);
5756
				my $herectx = get_stat_here($linenr, $cnt, $here);
5757

5758 5759
				if (($stmts =~ tr/;/;/) == 1 &&
				    $stmts !~ /^\s*(if|while|for|switch)\b/) {
5760 5761 5762 5763 5764 5765 5766
					WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
					     "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
				}
				if (defined $semis && $semis ne "") {
					WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
					     "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
				}
5767 5768 5769
			} elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
				$ctx =~ s/\n*$//;
				my $cnt = statement_rawlines($ctx);
5770
				my $herectx = get_stat_here($linenr, $cnt, $here);
5771 5772 5773

				WARN("TRAILING_SEMICOLON",
				     "macros should not use a trailing semicolon\n" . "$herectx");
5774 5775 5776
			}
		}

5777
# check for redundant bracing round if etc
5778 5779
		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
			my ($level, $endln, @chunks) =
5780
				ctx_statement_full($linenr, $realcnt, 1);
5781
			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5782 5783
			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
			if ($#chunks > 0 && $level == 0) {
5784 5785
				my @allowed = ();
				my $allow = 0;
5786
				my $seen = 0;
5787
				my $herectx = $here . "\n";
5788
				my $ln = $linenr - 1;
5789 5790 5791
				for my $chunk (@chunks) {
					my ($cond, $block) = @{$chunk};

5792 5793 5794 5795
					# If the condition carries leading newlines, then count those as offsets.
					my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
					my $offset = statement_rawlines($whitespace) - 1;

5796
					$allowed[$allow] = 0;
5797 5798 5799 5800 5801 5802
					#print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";

					# We have looked at and allowed this specific line.
					$suppress_ifbraces{$ln + $offset} = 1;

					$herectx .= "$rawlines[$ln + $offset]\n[...]\n";
5803 5804
					$ln += statement_rawlines($block) - 1;

5805
					substr($block, 0, length($cond), '');
5806 5807 5808

					$seen++ if ($block =~ /^\s*{/);

5809
					#print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5810 5811
					if (statement_lines($cond) > 1) {
						#print "APW: ALLOWED: cond<$cond>\n";
5812
						$allowed[$allow] = 1;
5813 5814
					}
					if ($block =~/\b(?:if|for|while)\b/) {
5815
						#print "APW: ALLOWED: block<$block>\n";
5816
						$allowed[$allow] = 1;
5817
					}
5818 5819
					if (statement_block_size($block) > 1) {
						#print "APW: ALLOWED: lines block<$block>\n";
5820
						$allowed[$allow] = 1;
5821
					}
5822
					$allow++;
5823
				}
5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836
				if ($seen) {
					my $sum_allowed = 0;
					foreach (@allowed) {
						$sum_allowed += $_;
					}
					if ($sum_allowed == 0) {
						WARN("BRACES",
						     "braces {} are not necessary for any arm of this statement\n" . $herectx);
					} elsif ($sum_allowed != $allow &&
						 $seen != $allow) {
						CHK("BRACES",
						    "braces {} should be used on all arms of this statement\n" . $herectx);
					}
5837 5838 5839
				}
			}
		}
5840
		if (!defined $suppress_ifbraces{$linenr - 1} &&
5841
					$line =~ /\b(if|while|for|else)\b/) {
5842 5843 5844 5845 5846 5847 5848
			my $allowed = 0;

			# Check the pre-context.
			if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
				#print "APW: ALLOWED: pre<$1>\n";
				$allowed = 1;
			}
5849 5850 5851 5852

			my ($level, $endln, @chunks) =
				ctx_statement_full($linenr, $realcnt, $-[0]);

5853 5854
			# Check the condition.
			my ($cond, $block) = @{$chunks[0]};
5855
			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5856
			if (defined $cond) {
5857
				substr($block, 0, length($cond), '');
5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874
			}
			if (statement_lines($cond) > 1) {
				#print "APW: ALLOWED: cond<$cond>\n";
				$allowed = 1;
			}
			if ($block =~/\b(?:if|for|while)\b/) {
				#print "APW: ALLOWED: block<$block>\n";
				$allowed = 1;
			}
			if (statement_block_size($block) > 1) {
				#print "APW: ALLOWED: lines block<$block>\n";
				$allowed = 1;
			}
			# Check the post-context.
			if (defined $chunks[1]) {
				my ($cond, $block) = @{$chunks[1]};
				if (defined $cond) {
5875
					substr($block, 0, length($cond), '');
5876 5877 5878 5879 5880 5881 5882
				}
				if ($block =~ /^\s*\{/) {
					#print "APW: ALLOWED: chunk-1 block<$block>\n";
					$allowed = 1;
				}
			}
			if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
5883
				my $cnt = statement_rawlines($block);
5884
				my $herectx = get_stat_here($linenr, $cnt, $here);
5885

5886 5887
				WARN("BRACES",
				     "braces {} are not necessary for single statement blocks\n" . $herectx);
5888 5889 5890
			}
		}

5891
# check for single line unbalanced braces
5892 5893
		if ($sline =~ /^.\s*\}\s*else\s*$/ ||
		    $sline =~ /^.\s*else\s*\{\s*$/) {
5894 5895 5896
			CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
		}

5897
# check for unnecessary blank lines around braces
5898
		if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
5899 5900 5901 5902 5903
			if (CHK("BRACES",
				"Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
			    $fix && $prevrawline =~ /^\+/) {
				fix_delete_line($fixlinenr - 1, $prevrawline);
			}
5904
		}
5905
		if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
5906 5907 5908 5909 5910
			if (CHK("BRACES",
				"Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
			    $fix) {
				fix_delete_line($fixlinenr, $rawline);
			}
5911 5912
		}

5913
# no volatiles please
5914 5915
		my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
		if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
5916
			WARN("VOLATILE",
5917
			     "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5918 5919
		}

5920 5921 5922 5923
# Check for user-visible strings broken across lines, which breaks the ability
# to grep for the string.  Make exceptions when the previous string ends in a
# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5924
		if ($line =~ /^\+\s*$String/ &&
5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958
		    $prevline =~ /"\s*$/ &&
		    $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
			if (WARN("SPLIT_STRING",
				 "quoted string split across lines\n" . $hereprev) &&
				     $fix &&
				     $prevrawline =~ /^\+.*"\s*$/ &&
				     $last_coalesced_string_linenr != $linenr - 1) {
				my $extracted_string = get_quoted_string($line, $rawline);
				my $comma_close = "";
				if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
					$comma_close = $1;
				}

				fix_delete_line($fixlinenr - 1, $prevrawline);
				fix_delete_line($fixlinenr, $rawline);
				my $fixedline = $prevrawline;
				$fixedline =~ s/"\s*$//;
				$fixedline .= substr($extracted_string, 1) . trim($comma_close);
				fix_insert_line($fixlinenr - 1, $fixedline);
				$fixedline = $rawline;
				$fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
				if ($fixedline !~ /\+\s*$/) {
					fix_insert_line($fixlinenr, $fixedline);
				}
				$last_coalesced_string_linenr = $linenr;
			}
		}

# check for missing a space in a string concatenation
		if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
			WARN('MISSING_SPACE',
			     "break quoted strings at a space character\n" . $hereprev);
		}

5959 5960 5961 5962
# check for an embedded function name in a string when the function is known
# This does not work very well for -f --file checking as it depends on patch
# context providing the function name or a single line form for in-file
# function declarations
5963 5964
		if ($line =~ /^\+.*$String/ &&
		    defined($context_function) &&
5965 5966
		    get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
		    length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
5967
			WARN("EMBEDDED_FUNCTION_NAME",
5968
			     "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5969 5970
		}

5971 5972 5973 5974 5975 5976 5977 5978 5979 5980
# check for spaces before a quoted newline
		if ($rawline =~ /^.*\".*\s\\n/) {
			if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
				 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
			    $fix) {
				$fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
			}

		}

5981
# concatenated string without spaces between elements
5982 5983 5984 5985 5986 5987 5988 5989 5990 5991
		if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) {
			if (CHK("CONCATENATED_STRING",
				"Concatenated strings should use spaces between elements\n" . $herecurr) &&
			    $fix) {
				while ($line =~ /($String)/g) {
					my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
					$fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/;
					$fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/;
				}
			}
5992 5993
		}

5994
# uncoalesced string fragments
5995
		if ($line =~ /$String\s*"/) {
5996 5997 5998 5999 6000 6001 6002 6003
			if (WARN("STRING_FRAGMENTS",
				 "Consecutive strings are generally better as a single string\n" . $herecurr) &&
			    $fix) {
				while ($line =~ /($String)(?=\s*")/g) {
					my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
					$fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e;
				}
			}
6004 6005
		}

6006 6007 6008
# check for non-standard and hex prefixed decimal printf formats
		my $show_L = 1;	#don't show the same defect twice
		my $show_Z = 1;
6009
		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
6010
			my $string = substr($rawline, $-[1], $+[1] - $-[1]);
6011
			$string =~ s/%%/__/g;
6012 6013
			# check for %L
			if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
6014
				WARN("PRINTF_L",
6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026
				     "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
				$show_L = 0;
			}
			# check for %Z
			if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
				WARN("PRINTF_Z",
				     "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
				$show_Z = 0;
			}
			# check for 0x<decimal>
			if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
				ERROR("PRINTF_0XDECIMAL",
6027 6028
				      "Prefixing 0x with decimal output is defective\n" . $herecurr);
			}
6029 6030 6031
		}

# check for line continuations in quoted strings with odd counts of "
6032
		if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
6033 6034 6035 6036
			WARN("LINE_CONTINUATIONS",
			     "Avoid line continuations in quoted strings\n" . $herecurr);
		}

6037
# warn about #if 0
6038
		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
6039 6040 6041 6042 6043 6044 6045 6046
			WARN("IF_0",
			     "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr);
		}

# warn about #if 1
		if ($line =~ /^.\s*\#\s*if\s+1\b/) {
			WARN("IF_1",
			     "Consider removing the #if 1 and its #endif\n" . $herecurr);
6047 6048
		}

6049 6050
# check for needless "if (<foo>) fn(<foo>)" uses
		if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078
			my $tested = quotemeta($1);
			my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
			if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
				my $func = $1;
				if (WARN('NEEDLESS_IF',
					 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
				    $fix) {
					my $do_fix = 1;
					my $leading_tabs = "";
					my $new_leading_tabs = "";
					if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
						$leading_tabs = $1;
					} else {
						$do_fix = 0;
					}
					if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
						$new_leading_tabs = $1;
						if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
							$do_fix = 0;
						}
					} else {
						$do_fix = 0;
					}
					if ($do_fix) {
						fix_delete_line($fixlinenr - 1, $prevrawline);
						$fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
					}
				}
6079 6080
			}
		}
6081

6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092
# check for unnecessary "Out of Memory" messages
		if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
		    $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
		    (defined $1 || defined $3) &&
		    $linenr > 3) {
			my $testval = $2;
			my $testline = $lines[$linenr - 3];

			my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
#			print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");

6093 6094
			if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
			    $s !~ /\b__GFP_NOWARN\b/ ) {
6095 6096 6097 6098 6099
				WARN("OOM_MESSAGE",
				     "Possible unnecessary 'out of memory' message\n" . $hereprev);
			}
		}

6100
# check for logging functions with KERN_<LEVEL>
6101
		if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
6102 6103 6104 6105 6106 6107 6108 6109 6110
		    $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
			my $level = $1;
			if (WARN("UNNECESSARY_KERN_LEVEL",
				 "Possible unnecessary $level\n" . $herecurr) &&
			    $fix) {
				$fixed[$fixlinenr] =~ s/\s*$level\s*//;
			}
		}

6111 6112 6113 6114 6115 6116
# check for logging continuations
		if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
			WARN("LOGGING_CONTINUATION",
			     "Avoid logging continuation uses where feasible\n" . $herecurr);
		}

6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138
# check for unnecessary use of %h[xudi] and %hh[xudi] in logging functions
		if (defined $stat &&
		    $line =~ /\b$logFunctions\s*\(/ &&
		    index($stat, '"') >= 0) {
			my $lc = $stat =~ tr@\n@@;
			$lc = $lc + $linenr;
			my $stat_real = get_stat_real($linenr, $lc);
			pos($stat_real) = index($stat_real, '"');
			while ($stat_real =~ /[^\"%]*(%[\#\d\.\*\-]*(h+)[idux])/g) {
				my $pspec = $1;
				my $h = $2;
				my $lineoff = substr($stat_real, 0, $-[1]) =~ tr@\n@@;
				if (WARN("UNNECESSARY_MODIFIER",
					 "Integer promotion: Using '$h' in '$pspec' is unnecessary\n" . "$here\n$stat_real\n") &&
				    $fix && $fixed[$fixlinenr + $lineoff] =~ /^\+/) {
					my $nspec = $pspec;
					$nspec =~ s/h//g;
					$fixed[$fixlinenr + $lineoff] =~ s/\Q$pspec\E/$nspec/;
				}
			}
		}

6139
# check for mask then right shift without a parentheses
6140
		if ($perl_version_ok &&
6141 6142 6143 6144 6145 6146
		    $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
		    $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
			WARN("MASK_THEN_SHIFT",
			     "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
		}

6147
# check for pointer comparisons to NULL
6148
		if ($perl_version_ok) {
6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160
			while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
				my $val = $1;
				my $equal = "!";
				$equal = "" if ($4 eq "!=");
				if (CHK("COMPARISON_TO_NULL",
					"Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
					    $fix) {
					$fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
				}
			}
		}

6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173
# check for bad placement of section $InitAttribute (e.g.: __initdata)
		if ($line =~ /(\b$InitAttribute\b)/) {
			my $attr = $1;
			if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
				my $ptr = $1;
				my $var = $2;
				if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
				      ERROR("MISPLACED_INIT",
					    "$attr should be placed after $var\n" . $herecurr)) ||
				     ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
				      WARN("MISPLACED_INIT",
					   "$attr should be placed after $var\n" . $herecurr))) &&
				    $fix) {
6174
					$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;
6175 6176 6177 6178
				}
			}
		}

6179 6180 6181 6182 6183 6184 6185 6186 6187
# check for $InitAttributeData (ie: __initdata) with const
		if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
			my $attr = $1;
			$attr =~ /($InitAttributePrefix)(.*)/;
			my $attr_prefix = $1;
			my $attr_type = $2;
			if (ERROR("INIT_ATTRIBUTE",
				  "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
			    $fix) {
6188
				$fixed[$fixlinenr] =~
6189 6190 6191 6192 6193 6194 6195 6196 6197 6198
				    s/$InitAttributeData/${attr_prefix}initconst/;
			}
		}

# check for $InitAttributeConst (ie: __initconst) without const
		if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
			my $attr = $1;
			if (ERROR("INIT_ATTRIBUTE",
				  "Use of $attr requires a separate use of const\n" . $herecurr) &&
			    $fix) {
6199
				my $lead = $fixed[$fixlinenr] =~
6200 6201 6202 6203
				    /(^\+\s*(?:static\s+))/;
				$lead = rtrim($1);
				$lead = "$lead " if ($lead !~ /^\+$/);
				$lead = "${lead}const ";
6204
				$fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
6205 6206 6207
			}
		}

6208 6209 6210 6211 6212 6213 6214 6215 6216 6217
# check for __read_mostly with const non-pointer (should just be const)
		if ($line =~ /\b__read_mostly\b/ &&
		    $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
			if (ERROR("CONST_READ_MOSTLY",
				  "Invalid use of __read_mostly with const type\n" . $herecurr) &&
			    $fix) {
				$fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
			}
		}

6218 6219 6220 6221 6222 6223 6224 6225 6226
# don't use __constant_<foo> functions outside of include/uapi/
		if ($realfile !~ m@^include/uapi/@ &&
		    $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
			my $constant_func = $1;
			my $func = $constant_func;
			$func =~ s/^__constant_//;
			if (WARN("CONSTANT_CONVERSION",
				 "$constant_func should be $func\n" . $herecurr) &&
			    $fix) {
6227
				$fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
6228 6229 6230
			}
		}

6231
# prefer usleep_range over udelay
B
Bruce Allan 已提交
6232
		if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
6233
			my $delay = $1;
6234
			# ignore udelay's < 10, however
6235
			if (! ($delay < 10) ) {
6236
				CHK("USLEEP_RANGE",
6237
				    "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
6238 6239 6240 6241
			}
			if ($delay > 2000) {
				WARN("LONG_UDELAY",
				     "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
6242 6243 6244
			}
		}

6245 6246 6247
# warn about unexpectedly long msleep's
		if ($line =~ /\bmsleep\s*\((\d+)\);/) {
			if ($1 < 20) {
6248
				WARN("MSLEEP",
6249
				     "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
6250 6251 6252
			}
		}

6253 6254 6255 6256 6257 6258
# check for comparisons of jiffies
		if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
			WARN("JIFFIES_COMPARISON",
			     "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
		}

6259 6260 6261 6262 6263 6264
# check for comparisons of get_jiffies_64()
		if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
			WARN("JIFFIES_COMPARISON",
			     "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
		}

6265
# warn about #ifdefs in C files
6266
#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
6267 6268 6269 6270 6271
#			print "#ifdef in C files should be avoided\n";
#			print "$herecurr";
#			$clean = 0;
#		}

6272
# warn about spacing in #ifdefs
6273
		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
6274 6275 6276
			if (ERROR("SPACING",
				  "exactly one space required after that #$1\n" . $herecurr) &&
			    $fix) {
6277
				$fixed[$fixlinenr] =~
6278 6279 6280
				    s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
			}

6281 6282
		}

6283
# check for spinlock_t definitions without a comment.
6284 6285
		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
6286 6287
			my $which = $1;
			if (!ctx_has_comment($first_line, $linenr)) {
6288 6289
				CHK("UNCOMMENTED_DEFINITION",
				    "$1 definition without comment\n" . $herecurr);
6290 6291 6292
			}
		}
# check for memory barriers without a comment.
6293 6294 6295 6296

		my $barriers = qr{
			mb|
			rmb|
6297
			wmb
6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308
		}x;
		my $barrier_stems = qr{
			mb__before_atomic|
			mb__after_atomic|
			store_release|
			load_acquire|
			store_mb|
			(?:$barriers)
		}x;
		my $all_barriers = qr{
			(?:$barriers)|
6309 6310
			smp_(?:$barrier_stems)|
			virt_(?:$barrier_stems)
6311 6312 6313
		}x;

		if ($line =~ /\b(?:$all_barriers)\s*\(/) {
6314
			if (!ctx_has_comment($first_line, $linenr)) {
6315 6316
				WARN("MEMORY_BARRIER",
				     "memory barrier without comment\n" . $herecurr);
6317 6318
			}
		}
6319

6320 6321 6322 6323 6324 6325 6326 6327 6328 6329
		my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;

		if ($realfile !~ m@^include/asm-generic/@ &&
		    $realfile !~ m@/barrier\.h$@ &&
		    $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
		    $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
			WARN("MEMORY_BARRIER",
			     "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
		}

6330 6331 6332 6333 6334 6335 6336
# check for waitqueue_active without a comment.
		if ($line =~ /\bwaitqueue_active\s*\(/) {
			if (!ctx_has_comment($first_line, $linenr)) {
				WARN("WAITQUEUE_ACTIVE",
				     "waitqueue_active without comment\n" . $herecurr);
			}
		}
6337

6338 6339 6340 6341 6342 6343 6344 6345
# check for data_race without a comment.
		if ($line =~ /\bdata_race\s*\(/) {
			if (!ctx_has_comment($first_line, $linenr)) {
				WARN("DATA_RACE",
				     "data_race without comment\n" . $herecurr);
			}
		}

6346
# check of hardware specific defines
6347
		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
6348 6349
			CHK("ARCH_DEFINES",
			    "architecture specific defines should be avoided\n" .  $herecurr);
6350
		}
6351

6352 6353 6354 6355 6356
# check that the storage class is not after a type
		if ($line =~ /\b($Type)\s+($Storage)\b/) {
			WARN("STORAGE_CLASS",
			     "storage class '$2' should be located before type '$1'\n" . $herecurr);
		}
6357
# Check that the storage class is at the beginning of a declaration
6358 6359 6360 6361
		if ($line =~ /\b$Storage\b/ &&
		    $line !~ /^.\s*$Storage/ &&
		    $line =~ /^.\s*(.+?)\$Storage\s/ &&
		    $1 !~ /[\,\)]\s*$/) {
6362
			WARN("STORAGE_CLASS",
6363
			     "storage class should be at the beginning of the declaration\n" . $herecurr);
6364 6365
		}

6366 6367
# check the location of the inline attribute, that it is between
# storage class and type.
6368 6369
		if ($line =~ /\b$Type\s+$Inline\b/ ||
		    $line =~ /\b$Inline\s+$Storage\b/) {
6370 6371
			ERROR("INLINE_LOCATION",
			      "inline keyword should sit between storage class and type\n" . $herecurr);
6372 6373
		}

6374
# Check for __inline__ and __inline, prefer inline
6375 6376
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b(__inline__|__inline)\b/) {
6377 6378 6379
			if (WARN("INLINE",
				 "plain inline is preferred over $1\n" . $herecurr) &&
			    $fix) {
6380
				$fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
6381 6382

			}
6383 6384
		}

6385
# Check for compiler attributes
6386
		if ($realfile !~ m@\binclude/uapi/@ &&
6387 6388 6389 6390 6391
		    $rawline =~ /\b__attribute__\s*\(\s*($balanced_parens)\s*\)/) {
			my $attr = $1;
			$attr =~ s/\s*\(\s*(.*)\)\s*/$1/;

			my %attr_list = (
6392
				"alias"				=> "__alias",
6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411
				"aligned"			=> "__aligned",
				"always_inline"			=> "__always_inline",
				"assume_aligned"		=> "__assume_aligned",
				"cold"				=> "__cold",
				"const"				=> "__attribute_const__",
				"copy"				=> "__copy",
				"designated_init"		=> "__designated_init",
				"externally_visible"		=> "__visible",
				"format"			=> "printf|scanf",
				"gnu_inline"			=> "__gnu_inline",
				"malloc"			=> "__malloc",
				"mode"				=> "__mode",
				"no_caller_saved_registers"	=> "__no_caller_saved_registers",
				"noclone"			=> "__noclone",
				"noinline"			=> "noinline",
				"nonstring"			=> "__nonstring",
				"noreturn"			=> "__noreturn",
				"packed"			=> "__packed",
				"pure"				=> "__pure",
6412
				"section"			=> "__section",
6413 6414
				"used"				=> "__used",
				"weak"				=> "__weak"
6415 6416 6417
			);

			while ($attr =~ /\s*(\w+)\s*(${balanced_parens})?/g) {
6418
				my $orig_attr = $1;
6419 6420
				my $params = '';
				$params = $2 if defined($2);
6421
				my $curr_attr = $orig_attr;
6422 6423
				$curr_attr =~ s/^[\s_]+|[\s_]+$//g;
				if (exists($attr_list{$curr_attr})) {
6424
					my $new = $attr_list{$curr_attr};
6425 6426
					if ($curr_attr eq "format" && $params) {
						$params =~ /^\s*\(\s*(\w+)\s*,\s*(.*)/;
6427
						$new = "__$1\($2";
6428
					} else {
6429 6430 6431 6432 6433 6434 6435 6436 6437 6438
						$new = "$new$params";
					}
					if (WARN("PREFER_DEFINED_ATTRIBUTE_MACRO",
						 "Prefer $new over __attribute__(($orig_attr$params))\n" . $herecurr) &&
					    $fix) {
						my $remove = "\Q$orig_attr\E" . '\s*' . "\Q$params\E" . '(?:\s*,\s*)?';
						$fixed[$fixlinenr] =~ s/$remove//;
						$fixed[$fixlinenr] =~ s/\b__attribute__/$new __attribute__/;
						$fixed[$fixlinenr] =~ s/\}\Q$new\E/} $new/;
						$fixed[$fixlinenr] =~ s/ __attribute__\s*\(\s*\(\s*\)\s*\)//;
6439 6440
					}
				}
6441
			}
6442

6443 6444 6445 6446
			# Check for __attribute__ unused, prefer __always_unused or __maybe_unused
			if ($attr =~ /^_*unused/) {
				WARN("PREFER_DEFINED_ATTRIBUTE_MACRO",
				     "__always_unused or __maybe_unused is preferred over __attribute__((__unused__))\n" . $herecurr);
6447
			}
6448 6449
		}

6450
# Check for __attribute__ weak, or __weak declarations (may have link issues)
6451
		if ($perl_version_ok &&
6452 6453 6454 6455 6456 6457 6458
		    $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
		    ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
		     $line =~ /\b__weak\b/)) {
			ERROR("WEAK_DECLARATION",
			      "Using weak declarations can have unintended link defects\n" . $herecurr);
		}

6459
# check for c99 types like uint8_t used outside of uapi/ and tools/
6460
		if ($realfile !~ m@\binclude/uapi/@ &&
6461
		    $realfile !~ m@\btools/@ &&
6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477
		    $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
			my $type = $1;
			if ($type =~ /\b($typeC99Typedefs)\b/) {
				$type = $1;
				my $kernel_type = 'u';
				$kernel_type = 's' if ($type =~ /^_*[si]/);
				$type =~ /(\d+)/;
				$kernel_type .= $1;
				if (CHK("PREFER_KERNEL_TYPES",
					"Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
				    $fix) {
					$fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
				}
			}
		}

6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497
# check for cast of C90 native int or longer types constants
		if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
			my $cast = $1;
			my $const = $2;
			if (WARN("TYPECAST_INT_CONSTANT",
				 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
			    $fix) {
				my $suffix = "";
				my $newconst = $const;
				$newconst =~ s/${Int_type}$//;
				$suffix .= 'U' if ($cast =~ /\bunsigned\b/);
				if ($cast =~ /\blong\s+long\b/) {
					$suffix .= 'LL';
				} elsif ($cast =~ /\blong\b/) {
					$suffix .= 'L';
				}
				$fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
			}
		}

6498 6499
# check for sizeof(&)
		if ($line =~ /\bsizeof\s*\(\s*\&/) {
6500 6501
			WARN("SIZEOF_ADDRESS",
			     "sizeof(& should be avoided\n" . $herecurr);
6502 6503
		}

6504 6505
# check for sizeof without parenthesis
		if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
6506 6507 6508
			if (WARN("SIZEOF_PARENTHESIS",
				 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
			    $fix) {
6509
				$fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
6510
			}
6511 6512
		}

6513 6514 6515 6516 6517 6518
# check for struct spinlock declarations
		if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
			WARN("USE_SPINLOCK_T",
			     "struct spinlock should be spinlock_t\n" . $herecurr);
		}

6519
# check for seq_printf uses that could be seq_puts
J
Joe Perches 已提交
6520
		if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
6521
			my $fmt = get_quoted_string($line, $rawline);
6522 6523
			$fmt =~ s/%%//g;
			if ($fmt !~ /%/) {
6524 6525 6526
				if (WARN("PREFER_SEQ_PUTS",
					 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
				    $fix) {
6527
					$fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
6528
				}
6529 6530 6531
			}
		}

6532
# check for vsprintf extension %p<foo> misuses
6533
		if ($perl_version_ok &&
6534 6535 6536
		    defined $stat &&
		    $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
		    $1 !~ /^_*volatile_*$/) {
6537 6538
			my $stat_real;

6539 6540 6541
			my $lc = $stat =~ tr@\n@@;
			$lc = $lc + $linenr;
		        for (my $count = $linenr; $count <= $lc; $count++) {
6542 6543
				my $specifier;
				my $extension;
6544
				my $qualifier;
6545
				my $bad_specifier = "";
6546 6547
				my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
				$fmt =~ s/%%//g;
6548

6549
				while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) {
6550 6551
					$specifier = $1;
					$extension = $2;
6552
					$qualifier = $3;
6553
					if ($extension !~ /[SsBKRraEehMmIiUDdgVCbGNOxtf]/ ||
6554 6555
					    ($extension eq "f" &&
					     defined $qualifier && $qualifier !~ /^w/)) {
6556 6557 6558 6559 6560 6561 6562 6563 6564 6565
						$bad_specifier = $specifier;
						last;
					}
					if ($extension eq "x" && !defined($stat_real)) {
						if (!defined($stat_real)) {
							$stat_real = get_stat_real($linenr, $lc);
						}
						WARN("VSPRINTF_SPECIFIER_PX",
						     "Using vsprintf specifier '\%px' potentially exposes the kernel memory layout, if you don't really need the address please consider using '\%p'.\n" . "$here\n$stat_real\n");
					}
6566
				}
6567 6568 6569 6570 6571 6572 6573 6574
				if ($bad_specifier ne "") {
					my $stat_real = get_stat_real($linenr, $lc);
					my $ext_type = "Invalid";
					my $use = "";
					if ($bad_specifier =~ /p[Ff]/) {
						$use = " - use %pS instead";
						$use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
					}
6575

6576 6577 6578
					WARN("VSPRINTF_POINTER_EXTENSION",
					     "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
				}
6579 6580 6581
			}
		}

6582
# Check for misused memsets
6583
		if ($perl_version_ok &&
6584
		    defined $stat &&
6585
		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
6586 6587

			my $ms_addr = $2;
6588 6589
			my $ms_val = $7;
			my $ms_size = $12;
6590 6591 6592

			if ($ms_size =~ /^(0x|)0$/i) {
				ERROR("MEMSET",
6593
				      "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
6594 6595
			} elsif ($ms_size =~ /^(0x|)1$/i) {
				WARN("MEMSET",
6596 6597 6598 6599
				     "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
			}
		}

6600
# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
6601
#		if ($perl_version_ok &&
6602 6603 6604 6605 6606 6607 6608 6609
#		    defined $stat &&
#		    $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
#			if (WARN("PREFER_ETHER_ADDR_COPY",
#				 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
#			    $fix) {
#				$fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
#			}
#		}
6610

6611
# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
6612
#		if ($perl_version_ok &&
6613 6614 6615 6616 6617
#		    defined $stat &&
#		    $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
#			WARN("PREFER_ETHER_ADDR_EQUAL",
#			     "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
#		}
6618

6619 6620
# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
6621
#		if ($perl_version_ok &&
6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640
#		    defined $stat &&
#		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
#
#			my $ms_val = $7;
#
#			if ($ms_val =~ /^(?:0x|)0+$/i) {
#				if (WARN("PREFER_ETH_ZERO_ADDR",
#					 "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
#				    $fix) {
#					$fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
#				}
#			} elsif ($ms_val =~ /^(?:0xff|255)$/i) {
#				if (WARN("PREFER_ETH_BROADCAST_ADDR",
#					 "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
#				    $fix) {
#					$fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
#				}
#			}
#		}
6641

6642 6643 6644 6645 6646 6647
# strlcpy uses that should likely be strscpy
		if ($line =~ /\bstrlcpy\s*\(/) {
			WARN("STRLCPY",
			     "Prefer strscpy over strlcpy - see: https://lore.kernel.org/r/CAHk-=wgfRnXz0W3D37d01q3JFkr_i_uTL=V6A6G1oUZcprmknw\@mail.gmail.com/\n" . $herecurr);
		}

6648
# typecasts on min/max could be min_t/max_t
6649
		if ($perl_version_ok &&
6650
		    defined $stat &&
6651
		    $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
6652
			if (defined $2 || defined $7) {
6653 6654 6655
				my $call = $1;
				my $cast1 = deparenthesize($2);
				my $arg1 = $3;
6656 6657
				my $cast2 = deparenthesize($7);
				my $arg2 = $8;
6658 6659
				my $cast;

6660
				if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
6661 6662 6663 6664 6665 6666 6667 6668
					$cast = "$cast1 or $cast2";
				} elsif ($cast1 ne "") {
					$cast = $cast1;
				} else {
					$cast = $cast2;
				}
				WARN("MINMAX",
				     "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
6669 6670 6671
			}
		}

6672
# check usleep_range arguments
6673
		if ($perl_version_ok &&
6674 6675 6676 6677 6678 6679
		    defined $stat &&
		    $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
			my $min = $1;
			my $max = $7;
			if ($min eq $max) {
				WARN("USLEEP_RANGE",
6680
				     "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6681 6682 6683
			} elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
				 $min > $max) {
				WARN("USLEEP_RANGE",
6684
				     "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6685 6686 6687
			}
		}

6688
# check for naked sscanf
6689
		if ($perl_version_ok &&
6690
		    defined $stat &&
6691
		    $line =~ /\bsscanf\b/ &&
6692 6693 6694 6695 6696
		    ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
		     $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
		     $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
			my $lc = $stat =~ tr@\n@@;
			$lc = $lc + $linenr;
6697
			my $stat_real = get_stat_real($linenr, $lc);
6698 6699 6700 6701
			WARN("NAKED_SSCANF",
			     "unchecked sscanf return value\n" . "$here\n$stat_real\n");
		}

6702
# check for simple sscanf that should be kstrto<foo>
6703
		if ($perl_version_ok &&
6704 6705 6706 6707
		    defined $stat &&
		    $line =~ /\bsscanf\b/) {
			my $lc = $stat =~ tr@\n@@;
			$lc = $lc + $linenr;
6708
			my $stat_real = get_stat_real($linenr, $lc);
6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719
			if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
				my $format = $6;
				my $count = $format =~ tr@%@%@;
				if ($count == 1 &&
				    $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
					WARN("SSCANF_TO_KSTRTO",
					     "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
				}
			}
		}

6720 6721 6722
# check for new externs in .h files.
		if ($realfile =~ /\.h$/ &&
		    $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
6723 6724
			if (CHK("AVOID_EXTERNS",
				"extern prototypes should be avoided in .h files\n" . $herecurr) &&
6725
			    $fix) {
6726
				$fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
6727 6728 6729
			}
		}

6730
# check for new externs in .c files.
6731
		if ($realfile =~ /\.c$/ && defined $stat &&
6732
		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
6733
		{
6734 6735
			my $function_name = $1;
			my $paren_space = $2;
6736 6737 6738 6739 6740

			my $s = $stat;
			if (defined $cond) {
				substr($s, 0, length($cond), '');
			}
6741
			if ($s =~ /^\s*;/)
6742
			{
6743 6744
				WARN("AVOID_EXTERNS",
				     "externs should be avoided in .c files\n" .  $herecurr);
6745 6746 6747
			}

			if ($paren_space =~ /\n/) {
6748 6749
				WARN("FUNCTION_ARGUMENTS",
				     "arguments for function declarations should follow identifier\n" . $herecurr);
6750
			}
6751 6752 6753 6754

		} elsif ($realfile =~ /\.c$/ && defined $stat &&
		    $stat =~ /^.\s*extern\s+/)
		{
6755 6756
			WARN("AVOID_EXTERNS",
			     "externs should be avoided in .c files\n" .  $herecurr);
6757 6758
		}

6759 6760
# check for function declarations that have arguments without identifier names
		if (defined $stat &&
6761 6762 6763
		    $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
		    $1 ne "void") {
			my $args = trim($1);
6764 6765
			while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
				my $arg = trim($1);
6766
				if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
6767 6768 6769 6770 6771 6772
					WARN("FUNCTION_ARGUMENTS",
					     "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
				}
			}
		}

6773
# check for function definitions
6774
		if ($perl_version_ok &&
6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795
		    defined $stat &&
		    $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
			$context_function = $1;

# check for multiline function definition with misplaced open brace
			my $ok = 0;
			my $cnt = statement_rawlines($stat);
			my $herectx = $here . "\n";
			for (my $n = 0; $n < $cnt; $n++) {
				my $rl = raw_line($linenr, $n);
				$herectx .=  $rl . "\n";
				$ok = 1 if ($rl =~ /^[ \+]\{/);
				$ok = 1 if ($rl =~ /\{/ && $n == 0);
				last if $rl =~ /^[ \+].*\{/;
			}
			if (!$ok) {
				ERROR("OPEN_BRACE",
				      "open brace '{' following function definitions go on the next line\n" . $herectx);
			}
		}

6796 6797 6798 6799 6800
# checks for new __setup's
		if ($rawline =~ /\b__setup\("([^"]*)"/) {
			my $name = $1;

			if (!grep(/$name/, @setup_docs)) {
6801
				CHK("UNDOCUMENTED_SETUP",
6802
				    "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr);
6803
			}
6804
		}
6805

6806 6807
# check for pointless casting of alloc functions
		if ($line =~ /\*\s*\)\s*$allocFunctions\b/) {
6808 6809
			WARN("UNNECESSARY_CASTS",
			     "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6810
		}
6811

6812 6813
# alloc style
# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6814
		if ($perl_version_ok &&
6815
		    $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6816 6817 6818 6819
			CHK("ALLOC_SIZEOF_STRUCT",
			    "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
		}

6820
# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6821
		if ($perl_version_ok &&
6822 6823
		    defined $stat &&
		    $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6824 6825 6826 6827 6828
			my $oldfunc = $3;
			my $a1 = $4;
			my $a2 = $10;
			my $newfunc = "kmalloc_array";
			$newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
6829 6830 6831 6832 6833 6834 6835 6836
			my $r1 = $a1;
			my $r2 = $a2;
			if ($a1 =~ /^sizeof\s*\S/) {
				$r1 = $a2;
				$r2 = $a1;
			}
			if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
			    !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
6837
				my $cnt = statement_rawlines($stat);
6838 6839
				my $herectx = get_stat_here($linenr, $cnt, $here);

6840
				if (WARN("ALLOC_WITH_MULTIPLY",
6841 6842
					 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
				    $cnt == 1 &&
6843
				    $fix) {
6844
					$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;
6845 6846 6847 6848
				}
			}
		}

6849
# check for krealloc arg reuse
6850
		if ($perl_version_ok &&
6851 6852
		    $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ &&
		    $1 eq $3) {
6853 6854 6855 6856
			WARN("KREALLOC_ARG_REUSE",
			     "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
		}

6857 6858 6859 6860 6861 6862
# check for alloc argument mismatch
		if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
			WARN("ALLOC_ARRAY_ARGS",
			     "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
		}

6863 6864
# check for multiple semicolons
		if ($line =~ /;\s*;\s*$/) {
6865 6866 6867
			if (WARN("ONE_SEMICOLON",
				 "Statements terminations use 1 semicolon\n" . $herecurr) &&
			    $fix) {
6868
				$fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
6869
			}
6870 6871
		}

6872 6873 6874
# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
		if ($realfile !~ m@^include/uapi/@ &&
		    $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
6875 6876 6877 6878 6879 6880 6881 6882 6883
			my $ull = "";
			$ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
			if (CHK("BIT_MACRO",
				"Prefer using the BIT$ull macro\n" . $herecurr) &&
			    $fix) {
				$fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
			}
		}

6884
# check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too)
6885
		if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^${CONFIG_}/) {
6886
			WARN("IS_ENABLED_CONFIG",
6887
			     "IS_ENABLED($1) is normally used as IS_ENABLED(${CONFIG_}$1)\n" . $herecurr);
6888 6889
		}

6890
# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6891
		if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(${CONFIG_}[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6892 6893
			my $config = $1;
			if (WARN("PREFER_IS_ENABLED",
6894
				 "Prefer IS_ENABLED(<FOO>) to ${CONFIG_}<FOO> || ${CONFIG_}<FOO>_MODULE\n" . $herecurr) &&
6895 6896 6897 6898 6899
			    $fix) {
				$fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
			}
		}

6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921
# check for /* fallthrough */ like comment, prefer fallthrough;
		my @fallthroughs = (
			'fallthrough',
			'@fallthrough@',
			'lint -fallthrough[ \t]*',
			'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)',
			'(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?',
			'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
			'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
		    );
		if ($raw_comment ne '') {
			foreach my $ft (@fallthroughs) {
				if ($raw_comment =~ /$ft/) {
					my $msg_level = \&WARN;
					$msg_level = \&CHK if ($file);
					&{$msg_level}("PREFER_FALLTHROUGH",
						      "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr);
					last;
				}
			}
		}

6922
# check for switch/default statements without a break;
6923
		if ($perl_version_ok &&
6924 6925 6926
		    defined $stat &&
		    $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
			my $cnt = statement_rawlines($stat);
6927 6928
			my $herectx = get_stat_here($linenr, $cnt, $here);

6929 6930
			WARN("DEFAULT_NO_BREAK",
			     "switch default: should use break\n" . $herectx);
6931 6932
		}

6933
# check for gcc specific __FUNCTION__
6934 6935 6936 6937
		if ($line =~ /\b__FUNCTION__\b/) {
			if (WARN("USE_FUNC",
				 "__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr) &&
			    $fix) {
6938
				$fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
6939
			}
6940
		}
6941

6942 6943 6944 6945 6946 6947
# check for uses of __DATE__, __TIME__, __TIMESTAMP__
		while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
			ERROR("DATE_TIME",
			      "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
		}

J
Joe Perches 已提交
6948 6949 6950 6951 6952 6953
# check for use of yield()
		if ($line =~ /\byield\s*\(\s*\)/) {
			WARN("YIELD",
			     "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n"  . $herecurr);
		}

6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980
# check for comparisons against true and false
		if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
			my $lead = $1;
			my $arg = $2;
			my $test = $3;
			my $otype = $4;
			my $trail = $5;
			my $op = "!";

			($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);

			my $type = lc($otype);
			if ($type =~ /^(?:true|false)$/) {
				if (("$test" eq "==" && "$type" eq "true") ||
				    ("$test" eq "!=" && "$type" eq "false")) {
					$op = "";
				}

				CHK("BOOL_COMPARISON",
				    "Using comparison to $otype is error prone\n" . $herecurr);

## maybe suggesting a correct construct would better
##				    "Using comparison to $otype is error prone.  Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);

			}
		}

6981 6982
# check for semaphores initialized locked
		if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
6983 6984
			WARN("CONSIDER_COMPLETION",
			     "consider using a completion\n" . $herecurr);
6985
		}
6986

6987 6988
# recommend kstrto* over simple_strto* and strict_strto*
		if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
6989
			WARN("CONSIDER_KSTRTO",
6990
			     "$1 is obsolete, use k$3 instead\n" . $herecurr);
6991
		}
6992

6993
# check for __initcall(), use device_initcall() explicitly or more appropriate function please
6994
		if ($line =~ /^.\s*__initcall\s*\(/) {
6995
			WARN("USE_DEVICE_INITCALL",
6996
			     "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6997
		}
6998

6999 7000 7001 7002 7003 7004
# check for spin_is_locked(), suggest lockdep instead
		if ($line =~ /\bspin_is_locked\(/) {
			WARN("USE_LOCKDEP",
			     "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
		}

7005 7006 7007 7008 7009 7010 7011 7012
# check for deprecated apis
		if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) {
			my $deprecated_api = $1;
			my $new_api = $deprecated_apis{$deprecated_api};
			WARN("DEPRECATED_API",
			     "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr);
		}

7013
# check for various structs that are normally const (ops, kgdb, device_tree)
7014
# and avoid what seem like struct definitions 'struct foo {'
7015 7016
		if (defined($const_structs) &&
		    $line !~ /\bconst\b/ &&
7017
		    $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
7018
			WARN("CONST_STRUCT",
7019
			     "struct $1 should normally be const\n" . $herecurr);
7020
		}
7021 7022 7023 7024

# use of NR_CPUS is usually wrong
# ignore definitions of NR_CPUS and usage to define arrays as likely right
		if ($line =~ /\bNR_CPUS\b/ &&
7025 7026
		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
7027 7028 7029
		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
7030
		{
7031 7032
			WARN("NR_CPUS",
			     "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
7033
		}
7034

7035 7036 7037 7038 7039 7040
# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
		if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
			ERROR("DEFINE_ARCH_HAS",
			      "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
		}

7041
# likely/unlikely comparisons similar to "(likely(foo) > 0)"
7042
		if ($perl_version_ok &&
7043 7044 7045 7046 7047
		    $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
			WARN("LIKELY_MISUSE",
			     "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
		}

7048 7049 7050 7051 7052 7053
# nested likely/unlikely calls
		if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) {
			WARN("LIKELY_MISUSE",
			     "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr);
		}

7054 7055 7056
# whine mightly about in_atomic
		if ($line =~ /\bin_atomic\s*\(/) {
			if ($realfile =~ m@^drivers/@) {
7057 7058
				ERROR("IN_ATOMIC",
				      "do not use in_atomic in drivers\n" . $herecurr);
7059
			} elsif ($realfile !~ m@^kernel/@) {
7060 7061
				WARN("IN_ATOMIC",
				     "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
7062 7063
			}
		}
7064

7065 7066 7067 7068 7069 7070
# check for mutex_trylock_recursive usage
		if ($line =~ /mutex_trylock_recursive/) {
			ERROR("LOCKING",
			      "recursive locking is bad, do not use this ever.\n" . $herecurr);
		}

7071 7072 7073 7074 7075 7076
# check for lockdep_set_novalidate_class
		if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
		    $line =~ /__lockdep_no_validate__\s*\)/ ) {
			if ($realfile !~ m@^kernel/lockdep@ &&
			    $realfile !~ m@^include/linux/lockdep@ &&
			    $realfile !~ m@^drivers/base/core@) {
7077 7078
				ERROR("LOCKDEP",
				      "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
7079 7080
			}
		}
7081

7082 7083
		if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
		    $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
7084 7085
			WARN("EXPORTED_WORLD_WRITABLE",
			     "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
7086
		}
7087

7088 7089 7090
# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
# and whether or not function naming is typical and if
# DEVICE_ATTR permissions uses are unusual too
7091
		if ($perl_version_ok &&
7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144
		    defined $stat &&
		    $stat =~ /\bDEVICE_ATTR\s*\(\s*(\w+)\s*,\s*\(?\s*(\s*(?:${multi_mode_perms_string_search}|0[0-7]{3,3})\s*)\s*\)?\s*,\s*(\w+)\s*,\s*(\w+)\s*\)/) {
			my $var = $1;
			my $perms = $2;
			my $show = $3;
			my $store = $4;
			my $octal_perms = perms_to_octal($perms);
			if ($show =~ /^${var}_show$/ &&
			    $store =~ /^${var}_store$/ &&
			    $octal_perms eq "0644") {
				if (WARN("DEVICE_ATTR_RW",
					 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
				    $fix) {
					$fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
				}
			} elsif ($show =~ /^${var}_show$/ &&
				 $store =~ /^NULL$/ &&
				 $octal_perms eq "0444") {
				if (WARN("DEVICE_ATTR_RO",
					 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
				    $fix) {
					$fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
				}
			} elsif ($show =~ /^NULL$/ &&
				 $store =~ /^${var}_store$/ &&
				 $octal_perms eq "0200") {
				if (WARN("DEVICE_ATTR_WO",
					 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
				    $fix) {
					$fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
				}
			} elsif ($octal_perms eq "0644" ||
				 $octal_perms eq "0444" ||
				 $octal_perms eq "0200") {
				my $newshow = "$show";
				$newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
				my $newstore = $store;
				$newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
				my $rename = "";
				if ($show ne $newshow) {
					$rename .= " '$show' to '$newshow'";
				}
				if ($store ne $newstore) {
					$rename .= " '$store' to '$newstore'";
				}
				WARN("DEVICE_ATTR_FUNCTIONS",
				     "Consider renaming function(s)$rename\n" . $herecurr);
			} else {
				WARN("DEVICE_ATTR_PERMS",
				     "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
			}
		}

7145 7146
# Mode permission misuses where it seems decimal should be octal
# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
7147 7148 7149 7150
# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
#   specific definition of not visible in sysfs.
# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
#   use the default permissions
7151
		if ($perl_version_ok &&
7152
		    defined $stat &&
7153 7154 7155 7156 7157
		    $line =~ /$mode_perms_search/) {
			foreach my $entry (@mode_permission_funcs) {
				my $func = $entry->[0];
				my $arg_pos = $entry->[1];

7158 7159
				my $lc = $stat =~ tr@\n@@;
				$lc = $lc + $linenr;
7160
				my $stat_real = get_stat_real($linenr, $lc);
7161

7162 7163 7164 7165 7166
				my $skip_args = "";
				if ($arg_pos > 1) {
					$arg_pos--;
					$skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
				}
7167
				my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
7168
				if ($stat =~ /$test/) {
7169 7170
					my $val = $1;
					$val = $6 if ($skip_args ne "");
7171 7172 7173
					if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
					    (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
					     ($val =~ /^$Octal$/ && length($val) ne 4))) {
7174
						ERROR("NON_OCTAL_PERMISSIONS",
7175
						      "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
7176 7177
					}
					if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
7178
						ERROR("EXPORTED_WORLD_WRITABLE",
7179
						      "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
7180
					}
7181 7182 7183
				}
			}
		}
7184

7185
# check for uses of S_<PERMS> that could be octal for readability
7186
		while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
7187 7188
			my $oval = $1;
			my $octal = perms_to_octal($oval);
7189 7190 7191
			if (WARN("SYMBOLIC_PERMS",
				 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
			    $fix) {
7192
				$fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
7193 7194 7195
			}
		}

7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212
# validate content of MODULE_LICENSE against list from include/linux/module.h
		if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
			my $extracted_string = get_quoted_string($line, $rawline);
			my $valid_licenses = qr{
						GPL|
						GPL\ v2|
						GPL\ and\ additional\ rights|
						Dual\ BSD/GPL|
						Dual\ MIT/GPL|
						Dual\ MPL/GPL|
						Proprietary
					}x;
			if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
				WARN("MODULE_LICENSE",
				     "unknown module license " . $extracted_string . "\n" . $herecurr);
			}
		}
7213 7214 7215 7216 7217 7218

# check for sysctl duplicate constants
		if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) {
			WARN("DUPLICATED_SYSCTL_CONST",
				"duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
		}
7219 7220 7221 7222 7223 7224
	}

	# If we have no input at all, then there is nothing to report on
	# so just keep quiet.
	if ($#rawlines == -1) {
		exit(0);
7225 7226
	}

7227 7228 7229 7230 7231 7232
	# In mailback mode only produce a report in the negative, for
	# things that appear to be patches.
	if ($mailback && ($clean == 1 || !$is_patch)) {
		exit(0);
	}

7233
	# This is not a patch, and we are in 'no-patch' mode so
7234 7235 7236 7237 7238
	# just keep quiet.
	if (!$chk_patch && !$is_patch) {
		exit(0);
	}

7239
	if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
7240 7241
		ERROR("NOT_UNIFIED_DIFF",
		      "Does not appear to be a unified-diff format patch\n");
7242
	}
7243 7244 7245 7246
	if ($is_patch && $has_commit_log && $chk_signoff) {
		if ($signoff == 0) {
			ERROR("MISSING_SIGN_OFF",
			      "Missing Signed-off-by: line(s)\n");
7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273
		} elsif ($authorsignoff != 1) {
			# authorsignoff values:
			# 0 -> missing sign off
			# 1 -> sign off identical
			# 2 -> names and addresses match, comments mismatch
			# 3 -> addresses match, names different
			# 4 -> names match, addresses different
			# 5 -> names match, addresses excluding subaddress details (refer RFC 5233) match

			my $sob_msg = "'From: $author' != 'Signed-off-by: $author_sob'";

			if ($authorsignoff == 0) {
				ERROR("NO_AUTHOR_SIGN_OFF",
				      "Missing Signed-off-by: line by nominal patch author '$author'\n");
			} elsif ($authorsignoff == 2) {
				CHK("FROM_SIGN_OFF_MISMATCH",
				    "From:/Signed-off-by: email comments mismatch: $sob_msg\n");
			} elsif ($authorsignoff == 3) {
				WARN("FROM_SIGN_OFF_MISMATCH",
				     "From:/Signed-off-by: email name mismatch: $sob_msg\n");
			} elsif ($authorsignoff == 4) {
				WARN("FROM_SIGN_OFF_MISMATCH",
				     "From:/Signed-off-by: email address mismatch: $sob_msg\n");
			} elsif ($authorsignoff == 5) {
				WARN("FROM_SIGN_OFF_MISMATCH",
				     "From:/Signed-off-by: email subaddress mismatch: $sob_msg\n");
			}
7274
		}
7275 7276
	}

7277
	print report_dump();
7278 7279
	if ($summary && !($clean == 1 && $quiet == 1)) {
		print "$filename " if ($summary_file);
7280 7281 7282
		print "total: $cnt_error errors, $cnt_warn warnings, " .
			(($check)? "$cnt_chk checks, " : "") .
			"$cnt_lines lines checked\n";
7283
	}
7284

7285
	if ($quiet == 0) {
7286 7287 7288 7289 7290 7291 7292 7293
		# If there were any defects found and not already fixing them
		if (!$clean and !$fix) {
			print << "EOM"

NOTE: For some of the reported defects, checkpatch may be able to
      mechanically convert to the typical style using --fix or --fix-inplace.
EOM
		}
7294 7295 7296
		# If there were whitespace errors which cleanpatch can fix
		# then suggest that.
		if ($rpt_cleaners) {
7297
			$rpt_cleaners = 0;
7298 7299 7300 7301 7302
			print << "EOM"

NOTE: Whitespace errors detected.
      You may wish to use scripts/cleanpatch or scripts/cleanfile
EOM
7303 7304 7305
		}
	}

7306 7307 7308
	if ($clean == 0 && $fix &&
	    ("@rawlines" ne "@fixed" ||
	     $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
7309 7310
		my $newfile = $filename;
		$newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
7311 7312 7313
		my $linecount = 0;
		my $f;

7314 7315
		@fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);

7316 7317 7318 7319 7320 7321 7322
		open($f, '>', $newfile)
		    or die "$P: Can't open $newfile for write\n";
		foreach my $fixed_line (@fixed) {
			$linecount++;
			if ($file) {
				if ($linecount > 3) {
					$fixed_line =~ s/^\+//;
7323
					print $f $fixed_line . "\n";
7324 7325 7326 7327 7328 7329 7330 7331 7332
				}
			} else {
				print $f $fixed_line . "\n";
			}
		}
		close($f);

		if (!$quiet) {
			print << "EOM";
7333

7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344
Wrote EXPERIMENTAL --fix correction(s) to '$newfile'

Do _NOT_ trust the results written to this file.
Do _NOT_ submit these changes without inspecting them for correctness.

This EXPERIMENTAL file is simply a convenience to help rewrite patches.
No warranties, expressed or implied...
EOM
		}
	}

7345 7346 7347 7348 7349 7350 7351
	if ($quiet == 0) {
		print "\n";
		if ($clean == 1) {
			print "$vname has no obvious style problems and is ready for submission.\n";
		} else {
			print "$vname has style problems, please review.\n";
		}
7352 7353 7354
	}
	return $clean;
}