checkpatch.pl 201.9 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
my %debug;
47
my %camelcase = ();
48 49 50
my %use_type = ();
my @use = ();
my %ignore_type = ();
51
my @ignore = ();
52
my $help = 0;
53
my $configuration_file = ".checkpatch.conf";
54
my $max_line_length = 80;
55 56
my $ignore_perl_version = 0;
my $minimum_perl_version = 5.10.0;
57
my $min_conf_desc_length = 4;
58
my $spelling_file = "$D/spelling.txt";
59
my $codespell = 0;
60
my $codespellfile = "/usr/share/codespell/dictionary.txt";
61
my $conststructsfile = "$D/const_structs.checkpatch";
62
my $typedefsfile = "";
63
my $color = "auto";
64
my $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE
65 66
# git output parsing needs US English output, so first set backtick child process LANGUAGE
my $git_command ='export LANGUAGE=en_US.UTF-8; git';
67
my $tabsize = 8;
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82

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
83
  --showfile                 emit diffed file position, not input file position
84 85 86 87 88 89 90 91 92 93
  -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
94 95
  -f, --file                 treat FILE as regular source file
  --subjective, --strict     enable more subjective tests
96
  --list-types               list the possible message types
97
  --types TYPE(,TYPE2...)    show only these comma separated message types
98
  --ignore TYPE(,TYPE2...)   ignore various comma separated message types
99
  --show-types               show the specific message type in the output
100
  --max-line-length=n        set the maximum line length, if exceeded, warn
101
  --min-conf-desc-length=n   set the min description length, if shorter, warn
102
  --tab-size=n               set the number of spaces for tab (default 8)
103 104 105 106 107 108 109 110 111
  --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
112 113 114 115 116
  --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
117 118 119
  --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
120 121
  --ignore-perl-version      override checking of perl version.  expect
                             runtime errors.
122
  --codespell                Use the codespell dictionary for spelling/typos
123
                             (default:/usr/share/codespell/dictionary.txt)
124
  --codespellfile            Use this codespell dictionary
125
  --typedefsfile             Read additional types from this file
126 127
  --color[=WHEN]             Use colors 'always', 'never', or only when output
                             is a terminal ('auto'). Default is 'auto'.
128 129 130 131 132 133 134 135
  -h, --help, --version      display this help and exit

When FILE is - read standard input.
EOM

	exit($exitcode);
}

136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
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 = ();
155 156
	# Also catch when type or level is passed through a variable
	for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
157 158 159 160 161 162 163 164 165 166 167
		push (@types, $_);
	}
	@types = sort(uniq(@types));
	print("#\tMessage type\n\n");
	foreach my $type (@types) {
		print(++$count . "\t" . $type . "\n");
	}

	exit($exitcode);
}

168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
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;
}

194 195 196 197 198 199 200 201
# 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";
	}
}

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

help(0) if ($help);
241

242 243
list_types(0) if ($list_types);

244
$fix = 1 if ($fix_inplace);
245
$check_orig = $check;
246

247 248
my $exit = 0;

249
my $perl_version_ok = 1;
250
if ($^V && $^V lt $minimum_perl_version) {
251
	$perl_version_ok = 0;
252
	printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
253
	exit(1) if (!$ignore_perl_version);
254 255
}

256
#if no filenames are given, push '-' to read patch from stdin
257
if ($#ARGV < 0) {
258
	push(@ARGV, '-');
259 260
}

261 262 263 264 265 266 267 268 269 270 271 272
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 {
	die "Invalid color mode: $color\n";
}

273 274 275
# skip TAB size 1 to avoid additional checks on $tabsize - 1
die "Invalid TAB size: $tabsize\n" if ($tabsize < 2);

276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
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}++;
	}
}
292

293 294
sub hash_show_words {
	my ($hashRef, $prefix) = @_;
295

296
	if (keys %$hashRef) {
297
		print "\nNOTE: $prefix message types:";
298
		foreach my $word (sort keys %$hashRef) {
299 300
			print " $word";
		}
301
		print "\n";
302
	}
303 304
}

305 306 307
hash_save_array_words(\%ignore_type, \@ignore);
hash_save_array_words(\%use_type, \@use);

308 309
my $dbg_values = 0;
my $dbg_possible = 0;
310
my $dbg_type = 0;
311
my $dbg_attr = 0;
312
for my $key (keys %debug) {
313 314 315
	## no critic
	eval "\${dbg_$key} = '$debug{$key}';";
	die "$@" if ($@);
316 317
}

318 319
my $rpt_cleaners = 0;

320 321 322 323 324
if ($terse) {
	$emacs = 1;
	$quiet++;
}

325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
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);
	}
343 344
}

345 346
my $emitted_corrupt = 0;

347 348 349 350
our $Ident	= qr{
			[A-Za-z_][A-Za-z\d_]*
			(?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
		}x;
351 352 353 354 355 356 357
our $Storage	= qr{extern|static|asmlinkage};
our $Sparse	= qr{
			__user|
			__kernel|
			__force|
			__iomem|
			__must_check|
358
			__kprobes|
359
			__ref|
360 361
			__refconst|
			__refdata|
362 363
			__rcu|
			__private
364
		}x;
365 366 367 368 369
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};
370

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

404 405 406 407
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?};
408
our $Octal	= qr{0[0-7]+$Int_type?};
409
our $String	= qr{"[X\t]*"};
410 411 412
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]?};
413
our $Float	= qr{$Float_hex|$Float_dec|$Float_int};
414
our $Constant	= qr{$Float|$Binary|$Octal|$Hex|$Int};
415
our $Assignment	= qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
416
our $Compare    = qr{<=|>=|==|!=|<|(?<!-)>};
417
our $Arithmetic = qr{\+|-|\*|\/|%};
418 419 420
our $Operators	= qr{
			<=|>=|==|!=|
			=>|->|<<|>>|<|>|!|~|
421
			&&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
422 423
		  }x;

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

426
our $BasicType;
427
our $NonptrType;
428
our $NonptrTypeMisordered;
429
our $NonptrTypeWithAttr;
430
our $Type;
431
our $TypeMisordered;
432
our $Declare;
433
our $DeclareMisordered;
434

435 436
our $NON_ASCII_UTF8	= qr{
	[\xC2-\xDF][\x80-\xBF]               # non-overlong 2-byte
437 438 439 440 441 442 443 444
	|  \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;

445 446 447 448 449
our $UTF8	= qr{
	[\x09\x0A\x0D\x20-\x7E]              # ASCII
	| $NON_ASCII_UTF8
}x;

450
our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
451 452 453 454
our $typeOtherOSTypedefs = qr{(?x:
	u_(?:char|short|int|long) |          # bsd
	u(?:nchar|short|int|long)            # sysv
)};
455
our $typeKernelTypedefs = qr{(?x:
456
	(?:__)?(?:u|s|be|le)(?:8|16|32|64)|
457 458
	atomic_t
)};
459 460 461 462 463
our $typeTypedefs = qr{(?x:
	$typeC99Typedefs\b|
	$typeOtherOSTypedefs\b|
	$typeKernelTypedefs\b
)};
464

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

467
our $logFunctions = qr{(?x:
M
Miles Chen 已提交
468
	printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
469
	(?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
470
	TP_printk|
471
	WARN(?:_RATELIMIT|_ONCE|)|
472
	panic|
J
Joe Perches 已提交
473 474
	MODULE_[A-Z_]+|
	seq_vprintf|seq_printf|seq_puts
475 476
)};

477 478 479 480 481 482 483 484 485 486
our $allocFunctions = qr{(?x:
	(?:(?:devm_)?
		(?:kv|k|v)[czm]alloc(?:_node|_array)? |
		kstrdup(?:_const)? |
		kmemdup(?:_nul)?) |
	(?:\w+)?alloc_skb(?:ip_align)? |
				# dev_alloc_skb/netdev_alloc_skb, et al
	dma_alloc_coherent
)};

487 488
our $signature_tags = qr{(?xi:
	Signed-off-by:|
489
	Co-developed-by:|
490 491 492 493
	Acked-by:|
	Tested-by:|
	Reviewed-by:|
	Reported-by:|
494
	Suggested-by:|
495 496 497 498
	To:|
	Cc:
)};

499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
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},
);

518 519
our @typeList = (
	qr{void},
520 521 522 523 524 525 526 527 528
	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},
529 530 531 532 533 534 535 536 537
	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},
538
	@typeListMisordered,
539
);
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561

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
)};

562
our @typeListFile = ();
563 564 565 566 567 568
our @typeListWithAttr = (
	@typeList,
	qr{struct\s+$InitAttribute\s+$Ident},
	qr{union\s+$InitAttribute\s+$Ident},
);

569 570 571
our @modifierList = (
	qr{fastcall},
);
572
our @modifierListFile = ();
573

574 575 576 577 578 579
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],
580 581 582 583 584
	["(?: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],
585 586
);

587 588 589 590 591 592
#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];
}
593
$mode_perms_search = "(?:${mode_perms_search})";
594

595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
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})";

616 617 618 619 620 621 622 623
our $mode_perms_world_writable = qr{
	S_IWUGO		|
	S_IWOTH		|
	S_IRWXUGO	|
	S_IALLUGO	|
	0[0-7][0-7][2367]
}x;

624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
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;
}
649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
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);
}
680

681 682
our $allowed_asm_includes = qr{(?x:
	irq|
683 684 685
	memory|
	time|
	reboot
686 687 688
)};
# memory.h: ARM has a custom one

689 690 691 692
# Load common spelling mistakes and build regular expression list.
my $misspellings;
my %spelling_fix;

693 694 695
if (open(my $spelling, '<', $spelling_file)) {
	while (<$spelling>) {
		my $line = $_;
696

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

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

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

705 706 707 708 709
		$spelling_fix{$suspect} = $fix;
	}
	close($spelling);
} else {
	warn "No typos will be found - file '$spelling_file': $!\n";
710 711
}

712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
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;

738 739
sub read_words {
	my ($wordsRef, $file) = @_;
740

741 742 743
	if (open(my $words, '<', $file)) {
		while (<$words>) {
			my $line = $_;
744

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

748 749 750 751 752 753 754 755 756 757 758 759
			next if ($line =~ m/^\s*#/);
			next if ($line =~ m/^\s*$/);
			if ($line =~ /\s/) {
				print("$file: '$line' invalid - ignored\n");
				next;
			}

			$$wordsRef .= '|' if ($$wordsRef ne "");
			$$wordsRef .= $line;
		}
		close($file);
		return 1;
760
	}
761 762 763 764 765 766 767 768 769 770 771 772

	return 0;
}

my $const_structs = "";
read_words(\$const_structs, $conststructsfile)
    or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";

my $typeOtherTypedefs = "";
if (length($typedefsfile)) {
	read_words(\$typeOtherTypedefs, $typedefsfile)
	    or warn "No additional types will be considered - file '$typedefsfile': $!\n";
773
}
774
$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne "");
775

776
sub build_types {
777 778
	my $mods = "(?x:  \n" . join("|\n  ", (@modifierList, @modifierListFile)) . "\n)";
	my $all = "(?x:  \n" . join("|\n  ", (@typeList, @typeListFile)) . "\n)";
779
	my $Misordered = "(?x:  \n" . join("|\n  ", @typeListMisordered) . "\n)";
780
	my $allWithAttr = "(?x:  \n" . join("|\n  ", @typeListWithAttr) . "\n)";
781
	$Modifier	= qr{(?:$Attribute|$Sparse|$mods)};
782 783 784 785
	$BasicType	= qr{
				(?:$typeTypedefs\b)|
				(?:${all}\b)
		}x;
786
	$NonptrType	= qr{
787
			(?:$Modifier\s+|const\s+)*
788
			(?:
789
				(?:typeof|__typeof__)\s*\([^\)]*\)|
790
				(?:$typeTypedefs\b)|
791
				(?:${all}\b)
792
			)
793
			(?:\s+$Modifier|\s+const)*
794
		  }x;
795 796 797 798 799 800 801
	$NonptrTypeMisordered	= qr{
			(?:$Modifier\s+|const\s+)*
			(?:
				(?:${Misordered}\b)
			)
			(?:\s+$Modifier|\s+const)*
		  }x;
802 803 804 805 806 807 808 809 810
	$NonptrTypeWithAttr	= qr{
			(?:$Modifier\s+|const\s+)*
			(?:
				(?:typeof|__typeof__)\s*\([^\)]*\)|
				(?:$typeTypedefs\b)|
				(?:${allWithAttr}\b)
			)
			(?:\s+$Modifier|\s+const)*
		  }x;
811
	$Type	= qr{
812
			$NonptrType
813
			(?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
814
			(?:\s+$Inline|\s+$Modifier)*
815
		  }x;
816 817
	$TypeMisordered	= qr{
			$NonptrTypeMisordered
818
			(?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
819 820
			(?:\s+$Inline|\s+$Modifier)*
		  }x;
821
	$Declare	= qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
822
	$DeclareMisordered	= qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
823 824
}
build_types();
825

826
our $Typecast	= qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
827 828 829 830 831 832

# 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))*\))/;
833
our $LvalOrFunc	= qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
834
our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
835

836
our $declaration_macros = qr{(?x:
837
	(?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
838
	(?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
839 840
	(?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(|
	(?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(
841 842
)};

843 844 845
sub deparenthesize {
	my ($string) = @_;
	return "" if (!defined($string));
846 847 848 849 850 851

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

852
	$string =~ s@\s+@ @g;
853

854 855 856
	return $string;
}

857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874
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;
875 876 877
		} 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*[;\{]/) {
878 879 880 881 882
			$camelcase{$1} = 1;
		}
	}
}

883 884
our %maintained_status = ();

885 886 887
sub is_maintained_obsolete {
	my ($filename) = @_;

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

890 891 892
	if (!exists($maintained_status{$filename})) {
		$maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
	}
893

894
	return $maintained_status{$filename} =~ /obsolete/i;
895 896
}

897 898 899
sub is_SPDX_License_valid {
	my ($license) = @_;

900
	return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git"));
901

902 903
	my $root_path = abs_path($root);
	my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`;
904 905 906 907
	return 0 if ($status ne "");
	return 1;
}

908 909 910 911 912
my $camelcase_seeded = 0;
sub seed_camelcase_includes {
	return if ($camelcase_seeded);

	my $files;
913 914 915 916
	my $camelcase_cache = "";
	my @include_files = ();

	$camelcase_seeded = 1;
917

918
	if (-e ".git") {
919
		my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
920
		chomp $git_last_include_commit;
921
		$camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
922
	} else {
923
		my $last_mod_date = 0;
924
		$files = `find $root/include -name "*.h"`;
925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943
		@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;
944
	}
945

946
	if (-e ".git") {
947
		$files = `${git_command} ls-files "include/*.h"`;
948 949 950
		@include_files = split('\n', $files);
	}

951 952 953
	foreach my $file (@include_files) {
		seed_camelcase_file($file);
	}
954

955
	if ($camelcase_cache ne "") {
956
		unlink glob ".checkpatch-camelcase.*";
957 958
		open(my $camelcase_file, '>', "$camelcase_cache")
		    or warn "$P: Can't write '$camelcase_cache' $!\n";
959 960 961 962 963
		foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
			print $camelcase_file ("$_\n");
		}
		close($camelcase_file);
	}
964 965
}

966 967 968 969 970
sub git_commit_info {
	my ($commit, $id, $desc) = @_;

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

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

975 976
	return ($id, $desc) if ($#lines < 0);

977
	if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) {
978 979 980 981 982 983 984 985 986 987
# 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\./) {
988
		$id = undef;
989 990 991 992 993 994 995 996
	} else {
		$id = substr($lines[0], 0, 12);
		$desc = substr($lines[0], 41);
	}

	return ($id, $desc);
}

997 998
$chk_signoff = 0 if ($file);

999
my @rawlines = ();
1000
my @lines = ();
1001
my @fixed = ();
1002 1003
my @fixed_inserted = ();
my @fixed_deleted = ();
1004 1005
my $fixlinenr = -1;

1006 1007 1008 1009 1010 1011
# 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'.
die "$P: No git repository found\n" if ($git && !-e ".git");

if ($git) {
	my @commits = ();
1012
	foreach my $commit_expr (@ARGV) {
1013
		my $git_range;
1014 1015
		if ($commit_expr =~ m/^(.*)-(\d+)$/) {
			$git_range = "-$2 $1";
1016 1017 1018
		} elsif ($commit_expr =~ m/\.\./) {
			$git_range = "$commit_expr";
		} else {
1019 1020
			$git_range = "-1 $commit_expr";
		}
1021
		my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
1022
		foreach my $line (split(/\n/, $lines)) {
1023 1024
			$line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
			next if (!defined($1) || !defined($2));
1025 1026 1027 1028
			my $sha1 = $1;
			my $subject = $2;
			unshift(@commits, $sha1);
			$git_commits{$sha1} = $subject;
1029 1030 1031 1032 1033 1034
		}
	}
	die "$P: no git commits after extraction!\n" if (@commits == 0);
	@ARGV = @commits;
}

1035
my $vname;
1036
$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"};
1037
for my $filename (@ARGV) {
1038
	my $FILE;
1039 1040 1041 1042
	if ($git) {
		open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
			die "$P: $filename: git format-patch failed - $!\n";
	} elsif ($file) {
1043
		open($FILE, '-|', "diff -u /dev/null $filename") ||
1044
			die "$P: $filename: diff failed - $!\n";
1045 1046
	} elsif ($filename eq '-') {
		open($FILE, '<&STDIN');
1047
	} else {
1048
		open($FILE, '<', "$filename") ||
1049
			die "$P: $filename: open failed - $!\n";
1050
	}
1051 1052
	if ($filename eq '-') {
		$vname = 'Your patch';
1053
	} elsif ($git) {
1054
		$vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
1055 1056 1057
	} else {
		$vname = $filename;
	}
1058
	while (<$FILE>) {
1059 1060 1061
		chomp;
		push(@rawlines, $_);
	}
1062
	close($FILE);
1063 1064 1065 1066 1067 1068 1069

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

1070
	if (!process($filename)) {
1071 1072 1073
		$exit = 1;
	}
	@rawlines = ();
1074
	@lines = ();
1075
	@fixed = ();
1076 1077
	@fixed_inserted = ();
	@fixed_deleted = ();
1078
	$fixlinenr = -1;
1079 1080 1081
	@modifierListFile = ();
	@typeListFile = ();
	build_types();
1082 1083
}

1084
if (!$quiet) {
1085 1086 1087
	hash_show_words(\%use_type, "Used");
	hash_show_words(\%ignore_type, "Ignored");

1088
	if (!$perl_version_ok) {
1089 1090 1091
		print << "EOM"

NOTE: perl $^V is not modern enough to detect all possible issues.
1092
      An upgrade to at least perl $minimum_perl_version is suggested.
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
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
	}
}

1104 1105 1106
exit($exit);

sub top_of_kernel_tree {
1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118
	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;
		}
1119
	}
1120
	return 1;
1121
}
1122

1123 1124 1125 1126
sub parse_email {
	my ($formatted_email) = @_;

	my $name = "";
1127
	my $name_comment = "";
1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
	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;
1141
		$formatted_email =~ s/\Q$address\E.*$//;
1142
		$name = $formatted_email;
1143
		$name = trim($name);
1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157
		$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 = "";
		}
	}

1158
	$name = trim($name);
1159
	$name =~ s/^\"|\"$//g;
1160 1161 1162 1163
	$name =~ s/(\s*\([^\)]+\))\s*//;
	if (defined($1)) {
		$name_comment = trim($1);
	}
1164
	$address = trim($address);
1165 1166 1167 1168 1169 1170 1171
	$address =~ s/^\<|\>$//g;

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

1172
	return ($name, $name_comment, $address, $comment);
1173 1174 1175 1176 1177 1178 1179
}

sub format_email {
	my ($name, $address) = @_;

	my $formatted_email;

1180
	$name = trim($name);
1181
	$name =~ s/^\"|\"$//g;
1182
	$address = trim($address);
1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197

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

	if ("$name" eq "") {
		$formatted_email = "$address";
	} else {
		$formatted_email = "$name <$address>";
	}

	return $formatted_email;
}

1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214
sub reformat_email {
	my ($email) = @_;

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

sub same_email_addresses {
	my ($email1, $email2) = @_;

	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 &&
	       $email1_address eq $email2_address;
}

1215
sub which {
1216
	my ($bin) = @_;
1217

1218 1219 1220 1221
	foreach my $path (split(/:/, $ENV{PATH})) {
		if (-e "$path/$bin") {
			return "$path/$bin";
		}
1222 1223
	}

1224
	return "";
1225 1226
}

1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238
sub which_conf {
	my ($conf) = @_;

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

	return "";
}

1239 1240 1241 1242 1243 1244 1245 1246 1247
sub expand_tabs {
	my ($str) = @_;

	my $res = '';
	my $n = 0;
	for my $c (split(//, $str)) {
		if ($c eq "\t") {
			$res .= ' ';
			$n++;
1248
			for (; ($n % $tabsize) != 0; $n++) {
1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
				$res .= ' ';
			}
			next;
		}
		$res .= $c;
		$n++;
	}

	return $res;
}
1259
sub copy_spacing {
1260
	(my $res = shift) =~ tr/\t/ /c;
1261 1262
	return $res;
}
1263

1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276
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));
}

1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287
my $sanitise_quote = '';

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

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
1288 1289 1290 1291 1292 1293
sub sanitise_line {
	my ($line) = @_;

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

1294
	my $qlen = 0;
1295 1296
	my $off = 0;
	my $c;
1297

1298 1299 1300 1301 1302 1303
	# 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 已提交
1304
		# Comments we are whacking completely including the begin
1305 1306 1307 1308 1309 1310 1311
		# and end, all to $;.
		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
			$sanitise_quote = '*/';

			substr($res, $off, 2, "$;$;");
			$off++;
			next;
1312
		}
1313
		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
1314 1315 1316 1317
			$sanitise_quote = '';
			substr($res, $off, 2, "$;$;");
			$off++;
			next;
1318
		}
1319 1320 1321 1322 1323 1324 1325
		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
			$sanitise_quote = '//';

			substr($res, $off, 2, $sanitise_quote);
			$off++;
			next;
		}
1326 1327 1328 1329 1330 1331 1332

		# 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;
1333
		}
1334 1335 1336 1337
		# Regular quotes.
		if ($c eq "'" || $c eq '"') {
			if ($sanitise_quote eq '') {
				$sanitise_quote = $c;
1338

1339 1340 1341 1342 1343 1344
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
1345

1346
		#print "c<$c> SQ<$sanitise_quote>\n";
1347 1348
		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
			substr($res, $off, 1, $;);
1349 1350
		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
			substr($res, $off, 1, $;);
1351 1352 1353 1354 1355
		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
			substr($res, $off, 1, 'X');
		} else {
			substr($res, $off, 1, $c);
		}
1356 1357
	}

1358 1359 1360 1361
	if ($sanitise_quote eq '//') {
		$sanitise_quote = '';
	}

1362
	# The pathname on a #include may be surrounded by '<' and '>'.
1363
	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
1364 1365 1366 1367
		my $clean = 'X' x length($1);
		$res =~ s@\<.*\>@<$clean>@;

	# The whole of a #error is a string.
1368
	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
1369
		my $clean = 'X' x length($1);
1370
		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
1371 1372
	}

1373 1374 1375 1376 1377
	if ($allow_c99_comments && $res =~ m@(//.*$)@) {
		my $match = $1;
		$res =~ s/\Q$match\E/"$;" x length($match)/e;
	}

1378 1379 1380
	return $res;
}

1381 1382 1383
sub get_quoted_string {
	my ($line, $rawline) = @_;

1384
	return "" if (!defined($line) || !defined($rawline));
1385
	return "" if ($line !~ m/($String)/g);
1386 1387 1388
	return substr($rawline, $-[0], $+[0] - $-[0]);
}

1389 1390 1391 1392 1393 1394
sub ctx_statement_block {
	my ($linenr, $remain, $off) = @_;
	my $line = $linenr - 1;
	my $blk = '';
	my $soff = $off;
	my $coff = $off - 1;
1395
	my $coff_set = 0;
1396

1397 1398
	my $loff = 0;

1399 1400
	my $type = '';
	my $level = 0;
1401
	my @stack = ();
1402
	my $p;
1403 1404
	my $c;
	my $len = 0;
1405 1406

	my $remainder;
1407
	while (1) {
1408 1409
		@stack = (['', 0]) if ($#stack == -1);

1410
		#warn "CSB: blk<$blk> remain<$remain>\n";
1411 1412 1413 1414
		# If we are about to drop off the end, pull in more
		# context.
		if ($off >= $len) {
			for (; $remain > 0; $line++) {
1415
				last if (!defined $lines[$line]);
1416
				next if ($lines[$line] =~ /^-/);
1417
				$remain--;
1418
				$loff = $len;
1419
				$blk .= $lines[$line] . "\n";
1420 1421 1422 1423 1424 1425
				$len = length($blk);
				$line++;
				last;
			}
			# Bail if there is no further context.
			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
1426
			if ($off >= $len) {
1427 1428
				last;
			}
1429 1430 1431 1432
			if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
				$level++;
				$type = '#';
			}
1433
		}
1434
		$p = $c;
1435
		$c = substr($blk, $off, 1);
1436
		$remainder = substr($blk, $off);
1437

1438
		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1439 1440 1441 1442 1443 1444 1445 1446 1447 1448

		# 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)};
		}

1449 1450 1451 1452 1453 1454
		# Statement ends at the ';' or a close '}' at the
		# outermost level.
		if ($level == 0 && $c eq ';') {
			last;
		}

1455
		# An else is really a conditional as long as its not else if
1456 1457 1458 1459 1460 1461 1462 1463
		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";
1464 1465
		}

1466 1467 1468 1469 1470 1471 1472 1473 1474 1475
		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;
1476 1477
				$coff_set = 1;
				#warn "CSB: mark coff<$coff>\n";
1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488
			}
		}
		if (($type eq '' || $type eq '{') && $c eq '{') {
			$level++;
			$type = '{';
		}
		if ($type eq '{' && $c eq '}') {
			$level--;
			$type = ($level != 0)? '{' : '';

			if ($level == 0) {
1489 1490 1491
				if (substr($blk, $off + 1, 1) eq ';') {
					$off++;
				}
1492 1493 1494
				last;
			}
		}
1495 1496 1497 1498 1499 1500 1501
		# Preprocessor commands end at the newline unless escaped.
		if ($type eq '#' && $c eq "\n" && $p ne "\\") {
			$level--;
			$type = '';
			$off++;
			last;
		}
1502 1503
		$off++;
	}
1504
	# We are truly at the end, so shuffle to the next line.
1505
	if ($off == $len) {
1506
		$loff = $len + 1;
1507 1508 1509
		$line++;
		$remain--;
	}
1510 1511 1512 1513 1514 1515 1516

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

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

1517
	#print "coff<$coff> soff<$off> loff<$loff>\n";
1518 1519 1520 1521 1522

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

1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565
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;
	}
}

1566 1567 1568 1569 1570 1571
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

1572
	# Grab the first conditional/block pair.
1573 1574
	($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
1575
	#print "F: c<$condition> s<$statement> remain<$remain>\n";
1576 1577 1578 1579 1580 1581 1582
	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.
1583 1584 1585
	for (;;) {
		($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
1586
		#print "C: c<$condition> s<$statement> remain<$remain>\n";
1587
		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1588 1589
		#print "C: push\n";
		push(@chunks, [ $condition, $statement ]);
1590 1591 1592
	}

	return ($level, $linenr, @chunks);
1593 1594
}

1595
sub ctx_block_get {
1596
	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1597 1598 1599 1600 1601 1602 1603
	my $line;
	my $start = $linenr - 1;
	my $blk = '';
	my @o;
	my @c;
	my @res = ();

1604
	my $level = 0;
1605
	my @stack = ($level);
1606 1607 1608 1609 1610
	for ($line = $start; $remain > 0; $line++) {
		next if ($rawlines[$line] =~ /^-/);
		$remain--;

		$blk .= $rawlines[$line];
1611 1612

		# Handle nested #if/#else.
1613
		if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1614
			push(@stack, $level);
1615
		} elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1616
			$level = $stack[$#stack - 1];
1617
		} elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1618 1619 1620
			$level = pop(@stack);
		}

1621
		foreach my $c (split(//, $lines[$line])) {
1622 1623 1624 1625 1626
			##print "C<$c>L<$level><$open$close>O<$off>\n";
			if ($off > 0) {
				$off--;
				next;
			}
1627

1628 1629 1630 1631 1632 1633 1634
			if ($c eq $close && $level > 0) {
				$level--;
				last if ($level == 0);
			} elsif ($c eq $open) {
				$level++;
			}
		}
1635

1636
		if (!$outer || $level <= 1) {
1637
			push(@res, $rawlines[$line]);
1638 1639
		}

1640
		last if ($level == 0);
1641 1642
	}

1643
	return ($level, @res);
1644 1645 1646 1647
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

1648 1649
	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
	return @r;
1650 1651 1652 1653
}
sub ctx_block {
	my ($linenr, $remain) = @_;

1654 1655
	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
	return @r;
1656 1657
}
sub ctx_statement {
1658 1659 1660 1661 1662 1663
	my ($linenr, $remain, $off) = @_;

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

1666
	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1667
}
1668 1669 1670 1671 1672
sub ctx_statement_level {
	my ($linenr, $remain, $off) = @_;

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
1673 1674 1675 1676 1677

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

	# Catch a comment on the end of the line itself.
1678
	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1679 1680 1681 1682 1683 1684 1685
	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++) {
1686 1687
		my $line = $rawlines[$linenr - 1];
		#warn "           $line\n";
1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709
		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);

1710
	##print "LINE: $rawlines[$end_line - 1 ]\n";
1711 1712 1713 1714 1715
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731
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;
}

1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742
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;
}

1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753
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;
}

1754 1755 1756
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
1757

1758 1759 1760 1761 1762 1763
	$res = '';
	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
		$res .= $1;
		if ($2 ne '') {
			$coded = sprintf("^%c", unpack('C', $2) + 64);
			$res .= $coded;
1764 1765
		}
	}
1766
	$res =~ s/$/\$/;
1767

1768
	return $res;
1769 1770
}

1771
my $av_preprocessor = 0;
1772
my $av_pending;
1773
my @av_paren_type;
1774
my $av_pend_colon;
1775 1776 1777

sub annotate_reset {
	$av_preprocessor = 0;
1778 1779
	$av_pending = '_';
	@av_paren_type = ('E');
1780
	$av_pend_colon = 'O';
1781 1782
}

1783 1784
sub annotate_values {
	my ($stream, $type) = @_;
1785

1786
	my $res;
1787
	my $var = '_' x length($stream);
1788 1789
	my $cur = $stream;

1790
	print "$stream\n" if ($dbg_values > 1);
1791 1792

	while (length($cur)) {
1793
		@av_paren_type = ('E') if ($#av_paren_type < 0);
1794
		print " <" . join('', @av_paren_type) .
1795
				"> <$type> <$av_pending>" if ($dbg_values > 1);
1796
		if ($cur =~ /^(\s+)/o) {
1797 1798
			print "WS($1)\n" if ($dbg_values > 1);
			if ($1 =~ /\n/ && $av_preprocessor) {
1799
				$type = pop(@av_paren_type);
1800
				$av_preprocessor = 0;
1801 1802
			}

1803
		} elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1804 1805
			print "CAST($1)\n" if ($dbg_values > 1);
			push(@av_paren_type, $type);
1806
			$type = 'c';
1807

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

1812 1813 1814 1815
		} elsif ($cur =~ /^($Modifier)\s*/) {
			print "MODIFIER($1)\n" if ($dbg_values > 1);
			$type = 'T';

1816
		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1817
			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1818
			$av_preprocessor = 1;
1819 1820 1821 1822 1823 1824
			push(@av_paren_type, $type);
			if ($2 ne '') {
				$av_pending = 'N';
			}
			$type = 'E';

1825
		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1826 1827 1828
			print "UNDEF($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;
			push(@av_paren_type, $type);
1829

1830
		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1831
			print "PRE_START($1)\n" if ($dbg_values > 1);
1832
			$av_preprocessor = 1;
1833 1834 1835

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
1836
			$type = 'E';
1837

1838
		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1839 1840 1841 1842 1843
			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;

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

1844
			$type = 'E';
1845

1846
		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1847 1848 1849 1850 1851 1852 1853 1854
			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);
1855
			$type = 'E';
1856 1857

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

1860 1861 1862 1863 1864
		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
			print "ATTR($1)\n" if ($dbg_values > 1);
			$av_pending = $type;
			$type = 'N';

1865
		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1866
			print "SIZEOF($1)\n" if ($dbg_values > 1);
1867
			if (defined $2) {
1868
				$av_pending = 'V';
1869 1870 1871
			}
			$type = 'N';

1872
		} elsif ($cur =~ /^(if|while|for)\b/o) {
1873
			print "COND($1)\n" if ($dbg_values > 1);
1874
			$av_pending = 'E';
1875 1876
			$type = 'N';

1877 1878 1879 1880 1881
		} elsif ($cur =~/^(case)/o) {
			print "CASE($1)\n" if ($dbg_values > 1);
			$av_pend_colon = 'C';
			$type = 'N';

1882
		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1883
			print "KEYWORD($1)\n" if ($dbg_values > 1);
1884 1885 1886
			$type = 'N';

		} elsif ($cur =~ /^(\()/o) {
1887
			print "PAREN('$1')\n" if ($dbg_values > 1);
1888 1889
			push(@av_paren_type, $av_pending);
			$av_pending = '_';
1890 1891 1892
			$type = 'N';

		} elsif ($cur =~ /^(\))/o) {
1893 1894 1895
			my $new_type = pop(@av_paren_type);
			if ($new_type ne '_') {
				$type = $new_type;
1896 1897
				print "PAREN('$1') -> $type\n"
							if ($dbg_values > 1);
1898
			} else {
1899
				print "PAREN('$1')\n" if ($dbg_values > 1);
1900 1901
			}

1902
		} elsif ($cur =~ /^($Ident)\s*\(/o) {
1903
			print "FUNC($1)\n" if ($dbg_values > 1);
1904
			$type = 'V';
1905
			$av_pending = 'V';
1906

1907 1908
		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
			if (defined $2 && $type eq 'C' || $type eq 'T') {
1909
				$av_pend_colon = 'B';
1910 1911
			} elsif ($type eq 'E') {
				$av_pend_colon = 'L';
1912 1913 1914 1915
			}
			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
			$type = 'V';

1916
		} elsif ($cur =~ /^($Ident|$Constant)/o) {
1917
			print "IDENT($1)\n" if ($dbg_values > 1);
1918 1919 1920
			$type = 'V';

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

1924
		} elsif ($cur =~/^(;|{|})/) {
1925
			print "END($1)\n" if ($dbg_values > 1);
1926
			$type = 'E';
1927 1928
			$av_pend_colon = 'O';

1929 1930 1931 1932
		} elsif ($cur =~/^(,)/) {
			print "COMMA($1)\n" if ($dbg_values > 1);
			$type = 'C';

1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946
		} 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';
1947

1948
		} elsif ($cur =~ /^(\[)/o) {
1949
			print "CLOSE($1)\n" if ($dbg_values > 1);
1950 1951
			$type = 'N';

1952
		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964
			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';

1965
		} elsif ($cur =~ /^($Operators)/o) {
1966
			print "OP($1)\n" if ($dbg_values > 1);
1967 1968 1969 1970 1971
			if ($1 ne '++' && $1 ne '--') {
				$type = 'N';
			}

		} elsif ($cur =~ /(^.)/o) {
1972
			print "C($1)\n" if ($dbg_values > 1);
1973 1974 1975 1976 1977
		}
		if (defined $1) {
			$cur = substr($cur, length($1));
			$res .= $type x length($1);
		}
1978
	}
1979

1980
	return ($res, $var);
1981 1982
}

1983
sub possible {
1984
	my ($possible, $line) = @_;
1985
	my $notPermitted = qr{(?:
1986 1987 1988 1989
		^(?:
			$Modifier|
			$Storage|
			$Type|
1990 1991 1992
			DEFINE_\S+
		)$|
		^(?:
1993 1994 1995 1996 1997
			goto|
			return|
			case|
			else|
			asm|__asm__|
1998 1999 2000
			do|
			\#|
			\#\#|
2001
		)(?:\s|$)|
2002
		^(?:typedef|struct|enum)\b
2003 2004 2005
	    )}x;
	warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
	if ($possible !~ $notPermitted) {
2006 2007 2008 2009 2010 2011 2012
		# 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;
2013
			for my $modifier (split(' ', $possible)) {
2014 2015
				if ($modifier !~ $notPermitted) {
					warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
2016
					push(@modifierListFile, $modifier);
2017
				}
2018
			}
2019 2020 2021

		} else {
			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
2022
			push(@typeListFile, $possible);
2023
		}
2024
		build_types();
2025 2026
	} else {
		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
2027 2028 2029
	}
}

2030 2031
my $prefix = '';

2032
sub show_type {
2033
	my ($type) = @_;
2034

2035 2036
	$type =~ tr/[a-z]/[A-Z]/;

2037 2038 2039
	return defined $use_type{$type} if (scalar keys %use_type > 0);

	return !defined $ignore_type{$type};
2040 2041
}

2042
sub report {
2043 2044 2045 2046
	my ($level, $type, $msg) = @_;

	if (!show_type($type) ||
	    (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
2047 2048
		return 0;
	}
2049
	my $output = '';
2050
	if ($color) {
2051 2052 2053 2054 2055 2056 2057 2058 2059
		if ($level eq 'ERROR') {
			$output .= RED;
		} elsif ($level eq 'WARNING') {
			$output .= YELLOW;
		} else {
			$output .= GREEN;
		}
	}
	$output .= $prefix . $level . ':';
2060
	if ($show_types) {
2061
		$output .= BLUE if ($color);
2062
		$output .= "$type:";
2063
	}
2064
	$output .= RESET if ($color);
2065
	$output .= ' ' . $msg . "\n";
2066 2067 2068 2069 2070 2071

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

2074
	push(our @report, $output);
2075 2076

	return 1;
2077
}
2078

2079
sub report_dump {
2080
	our @report;
2081
}
2082

2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114
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
2115
		if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) {	#new filename
2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145
			$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;
}

2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166
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);
}

2167
sub ERROR {
2168 2169 2170
	my ($type, $msg) = @_;

	if (report("ERROR", $type, $msg)) {
2171 2172
		our $clean = 0;
		our $cnt_error++;
2173
		return 1;
2174
	}
2175
	return 0;
2176 2177
}
sub WARN {
2178 2179 2180
	my ($type, $msg) = @_;

	if (report("WARNING", $type, $msg)) {
2181 2182
		our $clean = 0;
		our $cnt_warn++;
2183
		return 1;
2184
	}
2185
	return 0;
2186 2187
}
sub CHK {
2188 2189 2190
	my ($type, $msg) = @_;

	if ($check && report("CHECK", $type, $msg)) {
2191 2192
		our $clean = 0;
		our $cnt_chk++;
2193
		return 1;
2194
	}
2195
	return 0;
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
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 ".../") {
2221 2222
		WARN("USE_RELATIVE_PATH",
		     "use relative pathname instead of absolute in changelog text\n" . $herecurr);
2223 2224 2225
	}
}

2226 2227 2228
sub trim {
	my ($string) = @_;

2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245
	$string =~ s/^\s+|\s+$//g;

	return $string;
}

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

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

	return $string;
}

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

	$string =~ s/\s+$//;
2246 2247 2248 2249

	return $string;
}

2250 2251 2252 2253 2254 2255 2256 2257
sub string_find_replace {
	my ($string, $find, $replace) = @_;

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

	return $string;
}

2258 2259 2260
sub tabify {
	my ($leading) = @_;

2261
	my $source_indent = $tabsize;
2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272
	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";
}

2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299
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;
		}
	}

2300
	return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
2301 2302
}

2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315
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;
}

2316 2317 2318 2319 2320
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
2321
	my $prevrawline="";
2322
	my $stashline="";
2323
	my $stashrawline="";
2324

2325
	my $length;
2326 2327 2328 2329
	my $indent;
	my $previndent=0;
	my $stashindent=0;

2330
	our $clean = 1;
2331
	my $signoff = 0;
2332 2333
	my $author = '';
	my $authorsignoff = 0;
2334
	my $is_patch = 0;
2335
	my $is_binding_patch = -1;
2336
	my $in_header_lines = $file ? 0 : 1;
2337
	my $in_commit_log = 0;		#Scanning lines before patch
2338
	my $has_patch_separator = 0;	#Found a --- line
2339
	my $has_commit_log = 0;		#Encountered lines before patch
2340
	my $commit_log_lines = 0;	#Number of commit log lines
2341
	my $commit_log_possible_stack_dump = 0;
2342
	my $commit_log_long_line = 0;
2343
	my $commit_log_has_diff = 0;
2344
	my $reported_maintainer_file = 0;
2345 2346
	my $non_utf8_charset = 0;

2347
	my $last_blank_line = 0;
2348
	my $last_coalesced_string_linenr = -1;
2349

2350
	our @report = ();
2351 2352 2353 2354 2355
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

2356 2357 2358 2359 2360
	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
2361
	my $context_function;		#undef'd unless there's a known function
2362
	my $in_comment = 0;
2363
	my $comment_edge = 0;
2364
	my $first_line = 0;
2365
	my $p1_prefix = '';
2366

2367 2368 2369
	my $prev_values = 'E';

	# suppression flags
2370
	my %suppress_ifbraces;
2371
	my %suppress_whiletrailers;
2372
	my %suppress_export;
2373
	my $suppress_statement = 0;
2374

2375
	my %signatures = ();
2376

2377
	# Pre-scan the patch sanitizing the lines.
2378
	# Pre-scan the patch looking for any __setup documentation.
2379
	#
2380 2381
	my @setup_docs = ();
	my $setup_docs = 0;
2382

2383 2384
	my $camelcase_file_seeded = 0;

2385 2386
	my $checklicenseline = 1;

2387
	sanitise_line_reset();
2388 2389
	my $line;
	foreach my $rawline (@rawlines) {
2390 2391
		$linenr++;
		$line = $rawline;
2392

2393 2394
		push(@fixed, $rawline) if ($fix);

2395
		if ($rawline=~/^\+\+\+\s+(\S+)/) {
2396
			$setup_docs = 0;
2397
			if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
2398 2399
				$setup_docs = 1;
			}
2400 2401
			#next;
		}
2402
		if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2403 2404 2405 2406 2407 2408
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
2409
			$in_comment = 0;
2410 2411 2412 2413 2414 2415

			# 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;
2416 2417 2418 2419 2420 2421
			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";
2422
				last if (!defined $rawlines[$ln - 1]);
2423 2424 2425 2426 2427
				if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
				    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
					($edge) = $1;
					last;
				}
2428 2429 2430 2431 2432 2433 2434 2435 2436
			}
			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 &&
2437
			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
2438 2439 2440 2441 2442 2443 2444
			{
				$in_comment = 1;
			}

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

2445
		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2446
			# Standardise the strings and chars within the input to
2447
			# simplify matching -- only bother with positive lines.
2448
			$line = sanitise_line($rawline);
2449
		}
2450 2451 2452 2453 2454 2455 2456 2457 2458 2459
		push(@lines, $line);

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

		#print "==>$rawline\n";
		#print "-->$line\n";
2460 2461 2462 2463 2464 2465

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

2466 2467
	$prefix = '';

2468 2469
	$realcnt = 0;
	$linenr = 0;
2470
	$fixlinenr = -1;
2471 2472
	foreach my $line (@lines) {
		$linenr++;
2473
		$fixlinenr++;
2474 2475
		my $sline = $line;	#copy of $line
		$sline =~ s/$;/ /g;	#with comments as spaces
2476

2477
		my $rawline = $rawlines[$linenr - 1];
2478
		my $raw_comment = get_raw_comment($line, $rawline);
2479

2480 2481 2482 2483 2484 2485 2486 2487
# 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;
		}

2488
#extract the line range in the file after the patch is applied
2489
		if (!$in_commit_log &&
2490 2491
		    $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
			my $context = $4;
2492
			$is_patch = 1;
2493
			$first_line = $linenr + 1;
2494 2495 2496 2497 2498 2499
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
2500
			annotate_reset();
2501 2502
			$prev_values = 'E';

2503
			%suppress_ifbraces = ();
2504
			%suppress_whiletrailers = ();
2505
			%suppress_export = ();
2506
			$suppress_statement = 0;
2507 2508 2509 2510 2511
			if ($context =~ /\b(\w+)\s*\(/) {
				$context_function = $1;
			} else {
				undef $context_function;
			}
2512 2513
			next;

2514 2515 2516
# 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.
2517
		} elsif ($line =~ /^( |\+|$)/) {
2518
			$realline++;
2519
			$realcnt-- if ($realcnt != 0);
2520

2521
			# Measure the line length and indent.
2522
			($length, $indent) = line_stats($rawline);
2523 2524 2525 2526

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

2529
			#warn "line<$line>\n";
2530

2531 2532
		} elsif ($realcnt == 1) {
			$realcnt--;
2533 2534
		}

2535 2536
		my $hunk_line = ($realcnt != 0);

2537 2538
		$here = "#$linenr: " if (!$file);
		$here = "#$realline: " if ($file);
2539

2540
		my $found_file = 0;
2541
		# extract the filename as it passes
2542 2543
		if ($line =~ /^diff --git.*?(\S+)$/) {
			$realfile = $1;
2544
			$realfile =~ s@^([^/]*)/@@ if (!$file);
2545
			$in_commit_log = 0;
2546
			$found_file = 1;
2547
		} elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2548
			$realfile = $1;
2549
			$realfile =~ s@^([^/]*)/@@ if (!$file);
2550
			$in_commit_log = 0;
2551 2552

			$p1_prefix = $1;
2553 2554
			if (!$file && $tree && $p1_prefix ne '' &&
			    -e "$root/$p1_prefix") {
2555 2556
				WARN("PATCH_PREFIX",
				     "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2557
			}
2558

2559
			if ($realfile =~ m@^include/asm/@) {
2560 2561
				ERROR("MODIFIED_INCLUDE_ASM",
				      "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2562
			}
2563 2564 2565
			$found_file = 1;
		}

2566 2567 2568 2569
#make up the handle for any error we report on this line
		if ($showfile) {
			$prefix = "$realfile:$realline: "
		} elsif ($emacs) {
2570 2571 2572 2573 2574
			if ($file) {
				$prefix = "$filename:$realline: ";
			} else {
				$prefix = "$filename:$linenr: ";
			}
2575 2576
		}

2577
		if ($found_file) {
2578 2579 2580 2581
			if (is_maintained_obsolete($realfile)) {
				WARN("OBSOLETE",
				     "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy.  No unnecessary modifications please.\n");
			}
2582
			if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
2583 2584 2585 2586
				$check = 1;
			} else {
				$check = $check_orig;
			}
2587
			$checklicenseline = 1;
2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600

			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",
					     "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt\n");
				}
			}

2601 2602 2603
			next;
		}

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

2606 2607 2608
		my $hereline = "$here\n$rawline\n";
		my $herecurr = "$here\n$rawline\n";
		my $hereprev = "$here\n$prevrawline\n$rawline\n";
2609

2610 2611
		$cnt_lines++ if ($realcnt != 0);

2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623
# 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
		}

2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634
# Check if the commit log has what seems like a diff which can confuse patch
		if ($in_commit_log && !$commit_log_has_diff &&
		    (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
		      $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
		     $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;
		}

2635 2636 2637
# Check for incorrect file permissions
		if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
			my $permhere = $here . "FILE: $realfile\n";
2638 2639
			if ($realfile !~ m@scripts/@ &&
			    $realfile !~ /\.(py|pl|awk|sh)$/) {
2640 2641
				ERROR("EXECUTE_PERMISSIONS",
				      "do not set execute permissions for source files\n" . $permhere);
2642 2643 2644
			}
		}

2645 2646 2647 2648 2649
# Check the patch for a From:
		if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) {
			$author = $1;
			$author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i);
			$author =~ s/"//g;
2650
			$author = reformat_email($author);
2651 2652
		}

2653
# Check the patch for a signoff:
2654
		if ($line =~ /^\s*signed-off-by:\s*(.*)/i) {
2655
			$signoff++;
2656
			$in_commit_log = 0;
2657
			if ($author ne '') {
2658 2659
				if (same_email_addresses($1, $author)) {
					$authorsignoff = 1;
2660 2661
				}
			}
2662 2663
		}

2664 2665 2666 2667 2668 2669
# Check for patch separator
		if ($line =~ /^---$/) {
			$has_patch_separator = 1;
			$in_commit_log = 0;
		}

2670 2671 2672 2673 2674 2675
# 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;
		}

2676
# Check signature styles
2677
		if (!$in_header_lines &&
2678
		    $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2679 2680 2681 2682 2683 2684
			my $space_before = $1;
			my $sign_off = $2;
			my $space_after = $3;
			my $email = $4;
			my $ucfirst_sign_off = ucfirst(lc($sign_off));

2685 2686 2687 2688
			if ($sign_off !~ /$signature_tags/) {
				WARN("BAD_SIGN_OFF",
				     "Non-standard signature: $sign_off\n" . $herecurr);
			}
2689
			if (defined $space_before && $space_before ne "") {
2690 2691 2692
				if (WARN("BAD_SIGN_OFF",
					 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
				    $fix) {
2693
					$fixed[$fixlinenr] =
2694 2695
					    "$ucfirst_sign_off $email";
				}
2696 2697
			}
			if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2698 2699 2700
				if (WARN("BAD_SIGN_OFF",
					 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
				    $fix) {
2701
					$fixed[$fixlinenr] =
2702 2703 2704
					    "$ucfirst_sign_off $email";
				}

2705 2706
			}
			if (!defined $space_after || $space_after ne " ") {
2707 2708 2709
				if (WARN("BAD_SIGN_OFF",
					 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
				    $fix) {
2710
					$fixed[$fixlinenr] =
2711 2712
					    "$ucfirst_sign_off $email";
				}
2713
			}
2714

2715
			my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
2716 2717
			my $suggested_email = format_email(($email_name, $email_address));
			if ($suggested_email eq "") {
2718 2719
				ERROR("BAD_SIGN_OFF",
				      "Unrecognized email address: '$email'\n" . $herecurr);
2720 2721 2722 2723 2724 2725
			} else {
				my $dequoted = $suggested_email;
				$dequoted =~ s/^"//;
				$dequoted =~ s/" </ </;
				# Don't force email to have quotes
				# Allow just an angle bracketed address
2726
				if (!same_email_addresses($email, $suggested_email)) {
2727 2728
					WARN("BAD_SIGN_OFF",
					     "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2729
				}
2730
			}
2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741

# 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;
			}
2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759

# 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]);
				}
			}
2760 2761
		}

2762 2763 2764 2765 2766 2767 2768
# 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);
		}

2769 2770
# Check for Gerrit Change-Ids not in any patch context
		if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) {
2771
			ERROR("GERRIT_CHANGE_ID",
2772
			      "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr);
2773 2774
		}

2775 2776 2777 2778 2779
# 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
2780 2781 2782 2783
		     $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
2784 2785 2786
			$commit_log_possible_stack_dump = 1;
		}

2787 2788
# Check for line lengths > 75 in commit log, warn once
		if ($in_commit_log && !$commit_log_long_line &&
2789 2790 2791 2792 2793 2794 2795 2796
		    length($line) > 75 &&
		    !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
					# file delta changes
		      $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
					# filename then :
		      $line =~ /^\s*(?:Fixes:|Link:)/i ||
					# A Fixes: or Link: line
		      $commit_log_possible_stack_dump)) {
2797 2798 2799 2800 2801
			WARN("COMMIT_LOG_LONG_LINE",
			     "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
			$commit_log_long_line = 1;
		}

2802
# Reset possible stack dump if a blank line is found
2803 2804 2805 2806
		if ($in_commit_log && $commit_log_possible_stack_dump &&
		    $line =~ /^\s*$/) {
			$commit_log_possible_stack_dump = 0;
		}
2807

2808
# Check for git id commit length and improperly formed commit descriptions
2809
		if ($in_commit_log && !$commit_log_possible_stack_dump &&
2810
		    $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i &&
2811
		    $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
2812
		    ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
2813
		     ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
2814 2815
		      $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
		      $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
2816 2817
			my $init_char = "c";
			my $orig_commit = "";
2818 2819 2820 2821 2822
			my $short = 1;
			my $long = 0;
			my $case = 1;
			my $space = 1;
			my $hasdesc = 0;
2823
			my $hasparens = 0;
2824 2825 2826 2827
			my $id = '0123456789ab';
			my $orig_desc = "commit description";
			my $description = "";

2828 2829 2830 2831 2832 2833 2834
			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);
			}

2835 2836 2837 2838 2839 2840
			$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;
2841
				$hasparens = 1;
2842 2843 2844 2845
			} elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
				 defined $rawlines[$linenr] &&
				 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
				$orig_desc = $1;
2846
				$hasparens = 1;
2847 2848 2849 2850 2851 2852 2853
			} 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;
2854
				$hasparens = 1;
2855 2856 2857 2858 2859
			}

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

2860 2861
			if (defined($id) &&
			   ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
2862 2863 2864
				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);
			}
2865 2866
		}

2867 2868 2869 2870 2871 2872
# 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))))) {
2873
			$is_patch = 1;
2874 2875 2876 2877 2878
			$reported_maintainer_file = 1;
			WARN("FILE_PATH_CHANGES",
			     "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
		}

2879 2880 2881 2882 2883 2884 2885 2886
# 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");
		}

2887
# Check for wrappage within a valid hunk of the file
2888
		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2889 2890
			ERROR("CORRUPTED_PATCH",
			      "patch seems to be corrupt (line wrapped?)\n" .
2891
				$herecurr) if (!$emitted_corrupt++);
2892 2893 2894 2895
		}

# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2896 2897 2898 2899 2900 2901 2902
		    $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";

2903 2904
			CHK("INVALID_UTF8",
			    "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2905 2906
		}

2907 2908 2909
# 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 =~ /^$/ &&
2910 2911
		    !($rawline =~ /^\s+(?:\S|$)/ ||
		      $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
2912 2913
			$in_header_lines = 0;
			$in_commit_log = 1;
2914
			$has_commit_log = 1;
2915 2916
		}

2917 2918 2919 2920 2921 2922 2923 2924 2925
# 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 =~ /^$/ &&
2926
		    $rawline =~ /$NON_ASCII_UTF8/) {
2927
			WARN("UTF8_BEFORE_PATCH",
2928 2929 2930
			    "8-bit UTF-8 used in possible commit log\n" . $herecurr);
		}

2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944
# 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);
				}
			}
		}

2945
# Check for various typo / spelling mistakes
2946 2947
		if (defined($misspellings) &&
		    ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
2948
			while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
2949 2950 2951 2952
				my $typo = $1;
				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]+$/);
2953 2954 2955 2956
				my $msg_level = \&WARN;
				$msg_level = \&CHK if ($file);
				if (&{$msg_level}("TYPO_SPELLING",
						  "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2957 2958 2959 2960 2961 2962
				    $fix) {
					$fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
				}
			}
		}

2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973
# 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);
			}
		}

2974 2975
# ignore non-hunk lines and lines being removed
		next if (!$hunk_line || $line =~ /^-/);
2976 2977

#trailing whitespace
2978
		if ($line =~ /^\+.*\015/) {
2979
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2980 2981 2982
			if (ERROR("DOS_LINE_ENDINGS",
				  "DOS line endings\n" . $herevet) &&
			    $fix) {
2983
				$fixed[$fixlinenr] =~ s/[\s\015]+$//;
2984
			}
2985 2986
		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2987 2988 2989
			if (ERROR("TRAILING_WHITESPACE",
				  "trailing whitespace\n" . $herevet) &&
			    $fix) {
2990
				$fixed[$fixlinenr] =~ s/\s+$//;
2991 2992
			}

2993
			$rpt_cleaners = 1;
2994
		}
2995

2996
# Check for FSF mailing addresses.
2997
		if ($rawline =~ /\bwrite to the Free/i ||
2998
		    $rawline =~ /\b675\s+Mass\s+Ave/i ||
2999 3000
		    $rawline =~ /\b59\s+Temple\s+Pl/i ||
		    $rawline =~ /\b51\s+Franklin\s+St/i) {
3001
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3002 3003 3004 3005
			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)
3006 3007
		}

3008
# check for Kconfig help text having a real description
3009 3010
# Only applies when adding the entry originally, after that we do not have
# sufficient context to determine whether it is indeed long enough.
3011
		if ($realfile =~ /Kconfig/ &&
3012 3013 3014 3015
		    # '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/) {
3016
			my $length = 0;
3017 3018 3019
			my $cnt = $realcnt;
			my $ln = $linenr + 1;
			my $f;
3020
			my $is_start = 0;
3021
			my $is_end = 0;
3022
			for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
3023 3024 3025 3026 3027
				$f = $lines[$ln - 1];
				$cnt-- if ($lines[$ln - 1] !~ /^-/);
				$is_end = $lines[$ln - 1] =~ /^\+/;

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

3030
				if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
3031
					$is_start = 1;
3032 3033 3034 3035 3036
				} elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) {
					if ($lines[$ln - 1] =~ "---help---") {
						WARN("CONFIG_DESCRIPTION",
						     "prefer 'help' over '---help---' for new help texts\n" . $herecurr);
					}
3037 3038 3039
					$length = -1;
				}

3040
				$f =~ s/^.//;
3041 3042 3043
				$f =~ s/#.*//;
				$f =~ s/^\s+//;
				next if ($f =~ /^$/);
3044 3045 3046 3047 3048 3049 3050

				# 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) {
3051 3052 3053
					$is_end = 1;
					last;
				}
3054 3055
				$length++;
			}
3056 3057 3058 3059
			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);
			}
3060
			#print "is_start<$is_start> is_end<$is_end> length<$length>\n";
3061 3062
		}

3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073
# check for MAINTAINERS entries that don't have the right form
		if ($realfile =~ /^MAINTAINERS$/ &&
		    $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/;
			}
		}

3074 3075 3076 3077 3078 3079 3080
# discourage the use of boolean for type definition attributes of Kconfig options
		if ($realfile =~ /Kconfig/ &&
		    $line =~ /^\+\s*\bboolean\b/) {
			WARN("CONFIG_TYPE_BOOLEAN",
			     "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
		}

3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094
		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});
		}

3095
# check for DT compatible documentation
3096 3097 3098 3099
		if (defined $root &&
			(($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
			 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {

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

3102
			my $dt_path = $root . "/Documentation/devicetree/bindings/";
3103
			my $vp_file = $dt_path . "vendor-prefixes.yaml";
3104

3105 3106
			foreach my $compat (@compats) {
				my $compat2 = $compat;
3107 3108 3109 3110
				$compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
				my $compat3 = $compat;
				$compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
				`grep -Erq "$compat|$compat2|$compat3" $dt_path`;
3111 3112 3113 3114 3115
				if ( $? >> 8 ) {
					WARN("UNDOCUMENTED_DT_STRING",
					     "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
				}

3116 3117
				next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
				my $vendor = $1;
3118
				`grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`;
3119 3120
				if ( $? >> 8 ) {
					WARN("UNDOCUMENTED_DT_STRING",
3121
					     "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
3122 3123 3124 3125
				}
			}
		}

3126 3127 3128 3129 3130 3131 3132 3133 3134 3135
# 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 = '//';
3136
				} elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) {
3137 3138 3139 3140 3141
					$comment = '#';
				} elsif ($realfile =~ /\.rst$/) {
					$comment = '..';
				}

3142 3143 3144
# check SPDX comment style for .[chsS] files
				if ($realfile =~ /\.[chsS]$/ &&
				    $rawline =~ /SPDX-License-Identifier:/ &&
3145
				    $rawline !~ m@^\+\s*\Q$comment\E\s*@) {
3146 3147 3148 3149
					WARN("SPDX_LICENSE_TAG",
					     "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr);
				}

3150
				if ($comment !~ /^$/ &&
3151 3152 3153
				    $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) {
					WARN("SPDX_LICENSE_TAG",
					     "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
3154
				} elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) {
3155 3156 3157 3158 3159
					my $spdx_license = $1;
					if (!is_SPDX_License_valid($spdx_license)) {
						WARN("SPDX_LICENSE_TAG",
						     "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr);
					}
3160 3161 3162 3163
				}
			}
		}

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

3167 3168 3169 3170 3171 3172 3173 3174
# 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);
		}

3175 3176 3177 3178 3179 3180
# 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
3181
#	lines with an RFC3986 like URL
3182 3183
#
# There are 3 different line length message types:
J
Jean Delvare 已提交
3184
# LONG_LINE_COMMENT	a comment starts before but extends beyond $max_line_length
3185 3186 3187 3188 3189 3190
# 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
#

3191
		if ($line =~ /^\+/ && $length > $max_line_length) {
3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207
			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 = "";

3208 3209 3210
			# More special cases
			} elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
				 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
3211 3212
				$msg_type = "";

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

3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234
			# 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))) {
				WARN($msg_type,
				     "line over $max_line_length characters\n" . $herecurr);
			}
3235 3236
		}

3237 3238
# check for adding lines without a newline.
		if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3239 3240
			WARN("MISSING_EOF_NEWLINE",
			     "adding a line without newline at end of file\n" . $herecurr);
3241 3242
		}

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

# at the beginning of a line any tabs must come first and anything
3247
# more than $tabsize must use tabs.
3248 3249 3250
		if ($rawline =~ /^\+\s* \t\s*\S/ ||
		    $rawline =~ /^\+\s*        \s*/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3251
			$rpt_cleaners = 1;
3252 3253 3254
			if (ERROR("CODE_INDENT",
				  "code indent should use tabs where possible\n" . $herevet) &&
			    $fix) {
3255
				$fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3256
			}
3257 3258
		}

3259 3260 3261
# check for space before tabs.
		if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3262 3263 3264
			if (WARN("SPACE_BEFORE_TAB",
				"please, no space before tabs\n" . $herevet) &&
			    $fix) {
3265
				while ($fixed[$fixlinenr] =~
3266
					   s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {}
3267
				while ($fixed[$fixlinenr] =~
3268
					   s/(^\+.*) +\t/$1\t/) {}
3269
			}
3270
		}
3271 3272 3273 3274 3275 3276

# check for assignments on the start of a line
		if ($sline =~ /^\+\s+($Assignment)[^=]/) {
			CHK("ASSIGNMENT_CONTINUATIONS",
			    "Assignment operator '$1' should be on the previous line\n" . $hereprev);
		}
3277

3278 3279 3280 3281 3282 3283
# check for && or || at the start of a line
		if ($rawline =~ /^\+\s*(&&|\|\|)/) {
			CHK("LOGICAL_CONTINUATIONS",
			    "Logical continuations should be on the previous line\n" . $hereprev);
		}

3284
# check indentation starts on a tab stop
3285
		if ($perl_version_ok &&
3286
		    $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3287
			my $indent = length($1);
3288
			if ($indent % $tabsize) {
3289 3290 3291
				if (WARN("TABSTOP",
					 "Statements should start on a tabstop\n" . $herecurr) &&
				    $fix) {
3292
					$fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e;
3293 3294 3295 3296
				}
			}
		}

3297
# check multi-line statement indentation matches previous line
3298
		if ($perl_version_ok &&
3299
		    $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3300 3301 3302 3303 3304 3305
			$prevline =~ /^\+(\t*)(.*)$/;
			my $oldindent = $1;
			my $rest = $2;

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

				my $goodtabindent = $oldindent .
3310 3311
					"\t" x ($pos / $tabsize) .
					" "  x ($pos % $tabsize);
3312 3313 3314 3315
				my $goodspaceindent = $oldindent . " "  x $pos;

				if ($newindent ne $goodtabindent &&
				    $newindent ne $goodspaceindent) {
3316 3317 3318 3319

					if (CHK("PARENTHESIS_ALIGNMENT",
						"Alignment should match open parenthesis\n" . $hereprev) &&
					    $fix && $line =~ /^\+/) {
3320
						$fixed[$fixlinenr] =~
3321 3322
						    s/^\+[ \t]*/\+$goodtabindent/;
					}
3323 3324 3325 3326
				}
			}
		}

3327 3328 3329 3330 3331 3332 3333 3334 3335
# 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*$/)) {
3336
			if (CHK("SPACING",
3337
				"No space is necessary after a cast\n" . $herecurr) &&
3338
			    $fix) {
3339
				$fixed[$fixlinenr] =~
3340
				    s/(\(\s*$Type\s*\))[ \t]+/$1/;
3341
			}
3342 3343
		}

3344 3345
# Block comment styles
# Networking with an initial /*
3346
		if ($realfile =~ m@^(drivers/net/|net/)@ &&
3347
		    $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
3348 3349
		    $rawline =~ /^\+[ \t]*\*/ &&
		    $realline > 2) {
3350 3351 3352 3353
			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
			     "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
		}

3354 3355 3356
# Block comments use * on subsequent lines
		if ($prevline =~ /$;[ \t]*$/ &&			#ends in comment
		    $prevrawline =~ /^\+.*?\/\*/ &&		#starting /*
3357
		    $prevrawline !~ /\*\/[ \t]*$/ &&		#no trailing */
3358
		    $rawline =~ /^\+/ &&			#line is new
3359
		    $rawline !~ /^\+[ \t]*\*/) {		#no leading *
3360 3361
			WARN("BLOCK_COMMENT_STYLE",
			     "Block comments use * on subsequent lines\n" . $hereprev);
3362 3363
		}

3364 3365
# Block comments use */ on trailing lines
		if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ &&	#trailing */
3366 3367 3368
		    $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ &&	#inline /*...*/
		    $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ &&	#trailing **/
		    $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) {	#non blank */
3369 3370
			WARN("BLOCK_COMMENT_STYLE",
			     "Block comments use a trailing */ on a separate line\n" . $herecurr);
3371 3372
		}

3373 3374
# Block comment * alignment
		if ($prevline =~ /$;[ \t]*$/ &&			#ends in comment
3375 3376 3377
		    $line =~ /^\+[ \t]*$;/ &&			#leading comment
		    $rawline =~ /^\+[ \t]*\*/ &&		#leading *
		    (($prevrawline =~ /^\+.*?\/\*/ &&		#leading /*
3378
		      $prevrawline !~ /\*\/[ \t]*$/) ||		#no trailing */
3379 3380
		     $prevrawline =~ /^\+[ \t]*\*/)) {		#leading *
			my $oldindent;
3381
			$prevrawline =~ m@^\+([ \t]*/?)\*@;
3382 3383 3384 3385 3386 3387
			if (defined($1)) {
				$oldindent = expand_tabs($1);
			} else {
				$prevrawline =~ m@^\+(.*/?)\*@;
				$oldindent = expand_tabs($1);
			}
3388 3389 3390
			$rawline =~ m@^\+([ \t]*)\*@;
			my $newindent = $1;
			$newindent = expand_tabs($newindent);
3391
			if (length($oldindent) ne length($newindent)) {
3392 3393 3394 3395 3396
				WARN("BLOCK_COMMENT_STYLE",
				     "Block comments should align the * on each line\n" . $hereprev);
			}
		}

3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407
# 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/ ||
3408
		      $line =~ /^\+\s*builtin_[\w_]*driver/ ||
3409
		      $line =~ /^\+\s*__setup/)) {
3410 3411 3412
			if (CHK("LINE_SPACING",
				"Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
			    $fix) {
3413
				fix_insert_line($fixlinenr, "\+");
3414
			}
3415 3416
		}

3417 3418 3419 3420
# check for multiple consecutive blank lines
		if ($prevline =~ /^[\+ ]\s*$/ &&
		    $line =~ /^\+\s*$/ &&
		    $last_blank_line != ($linenr - 1)) {
3421 3422 3423
			if (CHK("LINE_SPACING",
				"Please don't use multiple blank lines\n" . $hereprev) &&
			    $fix) {
3424
				fix_delete_line($fixlinenr, $rawline);
3425 3426
			}

3427 3428 3429
			$last_blank_line = $linenr;
		}

3430
# check for missing blank lines after declarations
3431 3432 3433
		if ($sline =~ /^\+\s+\S/ &&			#Not at char 1
			# actual declarations
		    ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3434 3435
			# function pointer declarations
		     $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447
			# 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*[=,;:\[]/ ||
3448 3449
			# function pointer declarations
		      $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3450 3451 3452 3453 3454
			# 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
3455
		      $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ ||
3456 3457 3458 3459 3460 3461 3462 3463
			# 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/)) {
3464 3465 3466
			if (WARN("LINE_SPACING",
				 "Missing a blank line after declarations\n" . $hereprev) &&
			    $fix) {
3467
				fix_insert_line($fixlinenr, "\+");
3468
			}
3469 3470
		}

3471
# check for spaces at the beginning of a line.
3472 3473 3474 3475
# Exceptions:
#  1) within comments
#  2) indented preprocessor commands
#  3) hanging labels
3476
		if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/)  {
3477
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3478 3479 3480
			if (WARN("LEADING_SPACE",
				 "please, no spaces at the start of a line\n" . $herevet) &&
			    $fix) {
3481
				$fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3482
			}
3483 3484
		}

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

3488 3489 3490 3491 3492 3493
# check for unusual line ending [ or (
		if ($line =~ /^\+.*([\[\(])\s*$/) {
			CHK("OPEN_ENDED_LINE",
			    "Lines should not end with a '$1'\n" . $herecurr);
		}

3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504
# 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;
		}

3505
# check indentation of any line with a bare else
3506
# (but not if it is a multiple line "if (foo) return bar; else return baz;")
3507 3508 3509
# 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;
3510 3511 3512 3513
			if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
			    ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
			     defined $lines[$linenr] &&
			     $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
3514 3515 3516 3517 3518
				WARN("UNNECESSARY_ELSE",
				     "else is not generally useful after a break or return\n" . $hereprev);
			}
		}

3519 3520 3521 3522 3523 3524 3525 3526 3527 3528
# check indentation of a line with a break;
# if the previous line is a goto or return and is indented the same # of tabs
		if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
			my $tabs = $1;
			if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
				WARN("UNNECESSARY_BREAK",
				     "break is not useful after a goto or return\n" . $hereprev);
			}
		}

3529
# check for RCS/CVS revision markers
3530
		if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
3531 3532
			WARN("CVS_KEYWORD",
			     "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
3533
		}
3534

3535 3536 3537 3538 3539 3540
# 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);
		}

3541
# Check for potential 'bare' types
3542 3543
		my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
		    $realline_next);
3544
#print "LINE<$line>\n";
3545
		if ($linenr > $suppress_statement &&
3546
		    $realcnt && $sline =~ /.\s*\S/) {
3547
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3548
				ctx_statement_block($linenr, $realcnt, 0);
3549 3550 3551
			$stat =~ s/\n./\n /g;
			$cond =~ s/\n./\n /g;

3552 3553 3554 3555 3556 3557 3558 3559 3560
#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;
			}
3561

3562 3563 3564 3565 3566 3567 3568 3569
			# 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++;
			}

3570 3571
			my $s = $stat;
			$s =~ s/{.*$//s;
3572

3573
			# Ignore goto labels.
3574
			if ($s =~ /$Ident:\*$/s) {
3575 3576

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

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

3581
			# declarations always start with types
3582
			} 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) {
3583 3584 3585 3586
				my $type = $1;
				$type =~ s/\s+/ /g;
				possible($type, "A:" . $s);

3587
			# definitions in global scope can only start with types
3588
			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
3589
				possible($1, "B:" . $s);
3590
			}
3591 3592

			# any (foo ... *) is a pointer cast, and foo is a type
3593
			while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
3594
				possible($1, "C:" . $s);
3595 3596 3597 3598 3599
			}

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

3603
				my $ctx = $s;
3604
				substr($ctx, 0, $name_len + 1, '');
3605
				$ctx =~ s/\)[^\)]*$//;
3606

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

3610
						possible($1, "D:" . $s);
3611 3612
					}
				}
3613
			}
3614

3615 3616
		}

3617 3618 3619
#
# Checks which may be anchored in the context.
#
3620

3621 3622
# Check for switch () and associated case and default
# statements should be at the same indent.
3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638
		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 '') {
3639 3640
				ERROR("SWITCH_CASE_INDENT_LEVEL",
				      "switch and case should be at the same indent\n$hereline$err");
3641 3642 3643 3644 3645
			}
		}

# 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
3646
		if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3647 3648
			my $pre_ctx = "$1$2";

3649
			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
3650 3651 3652 3653 3654 3655

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

3656 3657 3658
			my $ctx_cnt = $realcnt - $#ctx - 1;
			my $ctx = join("\n", @ctx);

3659 3660
			my $ctx_ln = $linenr;
			my $ctx_skip = $realcnt;
3661

3662 3663 3664 3665 3666
			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] !~ /^-/);
3667 3668
				$ctx_ln++;
			}
3669

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

3673
			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
3674 3675
				ERROR("OPEN_BRACE",
				      "that open brace { should be on the previous line\n" .
3676
					"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3677
			}
3678 3679 3680 3681
			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
			    $ctx =~ /\)\s*\;\s*$/ &&
			    defined $lines[$ctx_ln - 1])
			{
3682 3683
				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
				if ($nindent > $indent) {
3684 3685
					WARN("TRAILING_SEMICOLON",
					     "trailing semicolon indicates no statements, indent implies otherwise\n" .
3686
						"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3687 3688
				}
			}
3689 3690
		}

3691
# Check relative indent for conditionals and blocks.
3692
		if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3693 3694 3695
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
3696 3697 3698 3699
			my ($s, $c) = ($stat, $cond);

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

3700 3701 3702
			# remove inline comments
			$s =~ s/$;/ /g;
			$c =~ s/$;/ /g;
3703 3704

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

3708 3709 3710 3711 3712 3713 3714 3715
			# 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;
			}

3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727
			# 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;
			}
3728
			if ($s =~ s/^\s*?\n//) {
3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739
				$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;
			}

3740
			my $cond_ptr = -1;
3741
			$continuation = 0;
3742 3743 3744
			while ($cond_ptr != $cond_lines) {
				$cond_ptr = $cond_lines;

3745 3746 3747 3748 3749 3750
				# If we see an #else/#elif then the code
				# is not linear.
				if ($s =~ /^\s*\#\s*(?:else|elif)/) {
					$check = 0;
				}

3751 3752 3753 3754
				# Ignore:
				#  1) blank lines, they should be at 0,
				#  2) preprocessor lines, and
				#  3) labels.
3755 3756
				if ($continuation ||
				    $s =~ /^\s*?\n/ ||
3757 3758
				    $s =~ /^\s*#\s*?/ ||
				    $s =~ /^\s*$Ident\s*:/) {
3759
					$continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
3760 3761 3762
					if ($s =~ s/^.*?\n//) {
						$cond_lines++;
					}
3763
				}
3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778
			}

			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";
			}

3779
			#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";
3780

3781
			if ($check && $s ne '' &&
3782
			    (($sindent % $tabsize) != 0 ||
3783
			     ($sindent < $indent) ||
3784 3785
			     ($sindent == $indent &&
			      ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
3786
			     ($sindent > $indent + $tabsize))) {
3787 3788
				WARN("SUSPECT_CODE_INDENT",
				     "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3789 3790 3791
			}
		}

3792 3793
		# Track the 'values' across context and added lines.
		my $opline = $line; $opline =~ s/^./ /;
3794 3795
		my ($curr_values, $curr_vars) =
				annotate_values($opline . "\n", $prev_values);
3796
		$curr_values = $prev_values . $curr_values;
3797 3798
		if ($dbg_values) {
			my $outline = $opline; $outline =~ s/\t/ /g;
3799 3800
			print "$linenr > .$outline\n";
			print "$linenr > $curr_values\n";
3801
			print "$linenr >  $curr_vars\n";
3802
		}
3803 3804
		$prev_values = substr($curr_values, -1);

3805
#ignore lines not being added
3806
		next if ($line =~ /^[^\+]/);
3807

3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819
# 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);
		}

3820
# check for declarations of signed or unsigned without int
3821
		while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3822 3823
			my $type = $1;
			my $var = $2;
3824 3825
			$var = "" if (!defined $var);
			if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
3826 3827 3828 3829 3830 3831 3832 3833 3834
				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 ";
3835 3836 3837 3838 3839
					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@;
3840 3841 3842 3843
				}
			}
		}

3844
# TEST: allow direct testing of the type matcher.
3845 3846
		if ($dbg_type) {
			if ($line =~ /^.\s*$Declare\s*$/) {
3847 3848
				ERROR("TEST_TYPE",
				      "TEST: is type\n" . $herecurr);
3849
			} elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3850 3851
				ERROR("TEST_NOT_TYPE",
				      "TEST: is not type ($1 is)\n". $herecurr);
3852
			}
3853 3854
			next;
		}
3855 3856
# TEST: allow direct testing of the attribute matcher.
		if ($dbg_attr) {
3857
			if ($line =~ /^.\s*$Modifier\s*$/) {
3858 3859
				ERROR("TEST_ATTR",
				      "TEST: is attr\n" . $herecurr);
3860
			} elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3861 3862
				ERROR("TEST_NOT_ATTR",
				      "TEST: is not attr ($1 is)\n". $herecurr);
3863 3864 3865
			}
			next;
		}
3866

3867
# check for initialisation to aggregates open brace on the next line
3868 3869
		if ($line =~ /^.\s*{/ &&
		    $prevline =~ /(?:^|[^=])=\s*$/) {
3870 3871
			if (ERROR("OPEN_BRACE",
				  "that open brace { should be on the previous line\n" . $hereprev) &&
3872 3873 3874
			    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
				fix_delete_line($fixlinenr - 1, $prevrawline);
				fix_delete_line($fixlinenr, $rawline);
3875 3876
				my $fixedline = $prevrawline;
				$fixedline =~ s/\s*=\s*$/ = {/;
3877
				fix_insert_line($fixlinenr, $fixedline);
3878
				$fixedline = $line;
3879
				$fixedline =~ s/^(.\s*)\{\s*/$1/;
3880
				fix_insert_line($fixlinenr, $fixedline);
3881
			}
3882 3883
		}

3884 3885 3886 3887 3888
#
# Checks which are anchored on the added line.
#

# check for malformed paths in #include statements (uses RAW line)
3889
		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3890 3891
			my $path = $1;
			if ($path =~ m{//}) {
3892
				ERROR("MALFORMED_INCLUDE",
3893 3894 3895 3896 3897
				      "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);
3898 3899
			}
		}
3900

3901
# no C99 // comments
3902
		if ($line =~ m{//}) {
3903 3904 3905
			if (ERROR("C99_COMMENTS",
				  "do not use C99 // comments\n" . $herecurr) &&
			    $fix) {
3906
				my $line = $fixed[$fixlinenr];
3907 3908
				if ($line =~ /\/\/(.*)$/) {
					my $comment = trim($1);
3909
					$fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3910 3911
				}
			}
3912
		}
3913
		# Remove C99 comments.
3914
		$line =~ s@//.*@@;
3915
		$opline =~ s@//.*@@;
3916

3917 3918 3919 3920 3921 3922 3923 3924
# 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.*\((.*)\)/)) {
3925 3926 3927 3928
			# Handle definitions which produce identifiers with
			# a prefix:
			#   XXX(foo);
			#   EXPORT_SYMBOL(something_foo);
3929
			my $name = $1;
3930
			if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3931 3932 3933 3934 3935
			    $name =~ /^${Ident}_$2/) {
#print "FOO C name<$name>\n";
				$suppress_export{$realline_next} = 1;

			} elsif ($stat !~ /(?:
3936
				\n.}\s*$|
3937 3938 3939
				^.DEFINE_$Ident\(\Q$name\E\)|
				^.DECLARE_$Ident\(\Q$name\E\)|
				^.LIST_HEAD\(\Q$name\E\)|
3940 3941
				^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
				\b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
3942
			    )/x) {
3943 3944 3945 3946
#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
				$suppress_export{$realline_next} = 2;
			} else {
				$suppress_export{$realline_next} = 1;
3947 3948
			}
		}
3949 3950 3951 3952 3953 3954 3955 3956 3957
		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) {
3958 3959
			WARN("EXPORT_SYMBOL",
			     "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3960
		}
3961

3962
# check for global initialisers.
3963
		if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
3964
			if (ERROR("GLOBAL_INITIALISERS",
3965
				  "do not initialise globals to $1\n" . $herecurr) &&
3966
			    $fix) {
3967
				$fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
3968
			}
3969
		}
3970
# check for static initialisers.
3971
		if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
3972
			if (ERROR("INITIALISED_STATIC",
3973
				  "do not initialise statics to $1\n" .
3974 3975
				      $herecurr) &&
			    $fix) {
3976
				$fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
3977
			}
3978 3979
		}

3980 3981 3982 3983 3984 3985 3986
# 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);
		}

3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006
# 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/;
			}
		}

4007 4008
# check for static const char * arrays.
		if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
4009 4010
			WARN("STATIC_CONST_CHAR_ARRAY",
			     "static const char * array should probably be static const char * const\n" .
4011
				$herecurr);
4012 4013 4014 4015 4016 4017 4018 4019 4020 4021
		}

# 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/;
			}
		}
4022 4023 4024

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

4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041
# 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);
			}
		}

4042 4043 4044 4045 4046 4047 4048
# 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);
               }

4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061
# 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)/;
				}
			}
		}

4062 4063 4064 4065 4066
# check for function declarations without arguments like "int foo()"
		if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
			if (ERROR("FUNCTION_WITHOUT_ARGS",
				  "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
			    $fix) {
4067
				$fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
4068 4069 4070
			}
		}

4071 4072 4073
# check for new typedefs, only function parameters and sparse annotations
# make sense.
		if ($line =~ /\btypedef\s/ &&
4074
		    $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
4075
		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
4076
		    $line !~ /\b$typeTypedefs\b/ &&
4077
		    $line !~ /\b__bitwise\b/) {
4078 4079
			WARN("NEW_TYPEDEFS",
			     "do not add new typedefs\n" . $herecurr);
4080 4081 4082
		}

# * goes on variable not on type
4083
		# (char*[ const])
4084 4085
		while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
			#print "AA<$1>\n";
4086
			my ($ident, $from, $to) = ($1, $2, $2);
4087 4088 4089 4090 4091 4092

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

4096
##			print "1: from<$from> to<$to> ident<$ident>\n";
4097
			if ($from ne $to) {
4098 4099 4100 4101 4102 4103
				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/;
4104
					$fixed[$fixlinenr] =~
4105 4106
					    s@\Q$sub_from\E@$sub_to@;
				}
4107
			}
4108 4109 4110
		}
		while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
			#print "BB<$1>\n";
4111
			my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
4112 4113 4114 4115 4116 4117

			# Should start with a space.
			$to =~ s/^(\S)/ $1/;
			# Should not end with a space.
			$to =~ s/\s+$//;
			# '*'s should not have spaces between.
4118
			while ($to =~ s/\*\s+\*/\*\*/) {
4119 4120 4121
			}
			# Modifiers should have spaces.
			$to =~ s/(\b$Modifier$)/$1 /;
4122

4123
##			print "2: from<$from> to<$to> ident<$ident>\n";
4124
			if ($from ne $to && $ident !~ /^$Modifier$/) {
4125 4126 4127 4128 4129 4130 4131
				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/;
4132
					$fixed[$fixlinenr] =~
4133 4134
					    s@\Q$sub_from\E@$sub_to@;
				}
4135
			}
4136 4137
		}

4138 4139
# avoid BUG() or BUG_ON()
		if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
4140 4141 4142 4143
			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);
4144
		}
4145

4146
# avoid LINUX_VERSION_CODE
4147
		if ($line =~ /\bLINUX_VERSION_CODE\b/) {
4148 4149
			WARN("LINUX_VERSION_CODE",
			     "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
4150 4151
		}

4152 4153
# check for uses of printk_ratelimit
		if ($line =~ /\bprintk_ratelimit\s*\(/) {
4154
			WARN("PRINTK_RATELIMITED",
4155
			     "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
4156 4157
		}

4158 4159 4160 4161
# 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);
4162 4163
		}

4164 4165 4166 4167
		if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
			my $orig = $1;
			my $level = lc($orig);
			$level = "warn" if ($level eq "warning");
4168 4169
			my $level2 = $level;
			$level2 = "dbg" if ($level eq "debug");
4170
			WARN("PREFER_PR_LEVEL",
4171
			     "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(...  to printk(KERN_$orig ...\n" . $herecurr);
4172 4173
		}

4174 4175 4176 4177 4178 4179 4180 4181 4182
		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);
		}

4183 4184 4185 4186 4187 4188 4189 4190
# 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);
		}

4191 4192
# function brace can't be on same line, except for #defines of do while,
# or if closed on same line
4193
		if ($perl_version_ok &&
4194 4195 4196
		    $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
		    $sline !~ /\#\s*define\b.*do\s*\{/ &&
		    $sline !~ /}/) {
4197
			if (ERROR("OPEN_BRACE",
4198
				  "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210
			    $fix) {
				fix_delete_line($fixlinenr, $rawline);
				my $fixed_line = $rawline;
				$fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
				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));
				}
			}
4211
		}
4212

4213 4214 4215
# 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*$/) {
4216 4217 4218 4219 4220 4221 4222 4223
			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;
4224
				$fixedline =~ s/^(.\s*)\{\s*/$1\t/;
4225 4226 4227 4228
				if ($fixedline !~ /^\+\s*$/) {
					fix_insert_line($fixlinenr, $fixedline);
				}
			}
4229 4230
		}

4231
# missing space after union, struct or enum definition
4232 4233 4234 4235
		if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
			if (WARN("SPACING",
				 "missing space after $1 definition\n" . $herecurr) &&
			    $fix) {
4236
				$fixed[$fixlinenr] =~
4237 4238
				    s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
			}
4239 4240
		}

4241 4242 4243
# Function pointer declarations
# check spacing between type, funcptr, and args
# canonical declaration is "type (*funcptr)(args...)"
4244
		if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
4245 4246 4247 4248 4249 4250 4251
			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;

4252 4253 4254 4255 4256 4257 4258 4259 4260
# 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 =~ /^$/) {
4261 4262
				WARN("SPACING",
				     "missing space after return type\n" . $herecurr);
4263
				$post_declare_space = " ";
4264 4265 4266
			}

# unnecessary space "type  (*funcptr)(args...)"
4267 4268 4269 4270 4271 4272 4273 4274 4275
# 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);
#			}
4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305

# 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) {
4306
				$fixed[$fixlinenr] =~
4307
				    s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4308 4309 4310
			}
		}

4311 4312
# check for spacing round square brackets; allowed:
#  1. with a type on the left -- int [] a;
4313 4314
#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
#  3. inside a curly brace -- = { [0...10] = 5 }
4315 4316 4317
		while ($line =~ /(.*?\s)\[/g) {
			my ($where, $prefix) = ($-[1], $1);
			if ($prefix !~ /$Type\s+$/ &&
4318
			    ($where != 0 || $prefix !~ /^.\s+$/) &&
4319
			    $prefix !~ /[{,:]\s+$/) {
4320 4321 4322
				if (ERROR("BRACKET_SPACE",
					  "space prohibited before open square bracket '['\n" . $herecurr) &&
				    $fix) {
4323
				    $fixed[$fixlinenr] =~
4324 4325
					s/^(\+.*?)\s+\[/$1\[/;
				}
4326 4327 4328
			}
		}

4329
# check for spaces between functions and their parentheses.
4330
		while ($line =~ /($Ident)\s+\(/g) {
4331
			my $name = $1;
4332 4333
			my $ctx_before = substr($line, 0, $-[1]);
			my $ctx = "$ctx_before$name";
4334 4335

			# Ignore those directives where spaces _are_ permitted.
4336 4337 4338 4339 4340 4341
			if ($name =~ /^(?:
				if|for|while|switch|return|case|
				volatile|__volatile__|
				__attribute__|format|__extension__|
				asm|__asm__)$/x)
			{
4342 4343 4344
			# 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.
4345
			} elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
4346 4347

			# cpp #elif statement condition may start with a (
4348
			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
4349 4350 4351

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

			} else {
4355 4356 4357
				if (WARN("SPACING",
					 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
					     $fix) {
4358
					$fixed[$fixlinenr] =~
4359 4360
					    s/\b$name\s+\(/$name\(/;
				}
4361
			}
4362
		}
4363

4364
# Check operator spacing.
4365
		if (!($line=~/\#\s*include/)) {
4366 4367 4368
			my $fixed_line = "";
			my $line_fixed = 0;

4369 4370 4371 4372
			my $ops = qr{
				<<=|>>=|<=|>=|==|!=|
				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
				=>|->|<<|>>|<|>|=|!|~|
4373
				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
4374
				\?:|\?|:
4375
			}x;
4376
			my @elements = split(/($ops|;)/, $opline);
4377 4378 4379 4380 4381 4382 4383

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

			my @fix_elements = ();
4384
			my $off = 0;
4385

4386 4387 4388 4389 4390 4391 4392
			foreach my $el (@elements) {
				push(@fix_elements, substr($rawline, $off, length($el)));
				$off += length($el);
			}

			$off = 0;

4393
			my $blank = copy_spacing($opline);
4394
			my $last_after = -1;
4395

4396
			for (my $n = 0; $n < $#elements; $n += 2) {
4397 4398 4399 4400 4401

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

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

4402 4403
				$off += length($elements[$n]);

L
Lucas De Marchi 已提交
4404
				# Pick up the preceding and succeeding characters.
4405 4406 4407 4408 4409 4410 4411
				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";

4412 4413 4414
				my $a = '';
				$a = 'V' if ($elements[$n] ne '');
				$a = 'W' if ($elements[$n] =~ /\s$/);
4415
				$a = 'C' if ($elements[$n] =~ /$;$/);
4416 4417
				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
				$a = 'O' if ($elements[$n] eq '');
4418
				$a = 'E' if ($ca =~ /^\s*$/);
4419

4420
				my $op = $elements[$n + 1];
4421 4422

				my $c = '';
4423
				if (defined $elements[$n + 2]) {
4424 4425
					$c = 'V' if ($elements[$n + 2] ne '');
					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
4426
					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
4427 4428
					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
					$c = 'O' if ($elements[$n + 2] eq '');
4429
					$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
4430 4431
				} else {
					$c = 'E';
4432 4433
				}

4434 4435 4436 4437
				my $ctx = "${a}x${c}";

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

4438
				my $ptr = substr($blank, 0, $off) . "^";
4439
				my $hereptr = "$hereline$ptr\n";
4440

4441
				# Pull out the value of this operator.
4442
				my $op_type = substr($curr_values, $off + 1, 1);
4443

4444 4445 4446
				# Get the full operator variant.
				my $opv = $op . substr($curr_vars, $off, 1);

4447 4448
				# Ignore operators passed as parameters.
				if ($op_type ne 'V' &&
4449
				    $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
4450

4451 4452
#				# Ignore comments
#				} elsif ($op =~ /^$;+$/) {
4453

4454
				# ; should have either the end of line or a space or \ after it
4455
				} elsif ($op eq ';') {
4456 4457
					if ($ctx !~ /.x[WEBC]/ &&
					    $cc !~ /^\\/ && $cc !~ /^;/) {
4458 4459
						if (ERROR("SPACING",
							  "space required after that '$op' $at\n" . $hereptr)) {
4460
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4461 4462
							$line_fixed = 1;
						}
4463 4464 4465 4466
					}

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

4468 4469 4470 4471
				#   :   when part of a bitfield
				} elsif ($opv eq ':B') {
					# skip the bitfield test for now

4472 4473
				# No spaces for:
				#   ->
4474
				} elsif ($op eq '->') {
4475
					if ($ctx =~ /Wx.|.xW/) {
4476 4477
						if (ERROR("SPACING",
							  "spaces prohibited around that '$op' $at\n" . $hereptr)) {
4478
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4479 4480 4481
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
4482
							$line_fixed = 1;
4483
						}
4484 4485
					}

4486
				# , must not have a space before and must have a space on the right.
4487
				} elsif ($op eq ',') {
4488 4489 4490 4491 4492 4493 4494 4495 4496
					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;
						}
					}
4497
					if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
4498 4499 4500
						if (ERROR("SPACING",
							  "space required after that '$op' $at\n" . $hereptr)) {
							$line_fixed = 1;
4501
							$last_after = $n;
4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512
							$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 .= " ";
4513
						}
4514 4515
					}

4516
				# '*' as part of a type definition -- reported already.
4517
				} elsif ($opv eq '*_') {
4518 4519 4520 4521 4522 4523
					#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 '~' ||
4524
					 $opv eq '*U' || $opv eq '-U' ||
4525
					 $opv eq '&U' || $opv eq '&&U') {
4526
					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
4527 4528
						if (ERROR("SPACING",
							  "space required before that '$op' $at\n" . $hereptr)) {
4529 4530 4531 4532
							if ($n != $last_after + 2) {
								$good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
								$line_fixed = 1;
							}
4533
						}
4534
					}
4535
					if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
4536 4537 4538
						# A unary '*' may be const

					} elsif ($ctx =~ /.xW/) {
4539 4540
						if (ERROR("SPACING",
							  "space prohibited after that '$op' $at\n" . $hereptr)) {
4541
							$good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
4542 4543 4544
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
4545
							$line_fixed = 1;
4546
						}
4547 4548 4549 4550
					}

				# unary ++ and unary -- are allowed no space on one side.
				} elsif ($op eq '++' or $op eq '--') {
4551
					if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
4552 4553
						if (ERROR("SPACING",
							  "space required one side of that '$op' $at\n" . $hereptr)) {
4554
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4555 4556
							$line_fixed = 1;
						}
4557 4558 4559
					}
					if ($ctx =~ /Wx[BE]/ ||
					    ($ctx =~ /Wx./ && $cc =~ /^;/)) {
4560 4561
						if (ERROR("SPACING",
							  "space prohibited before that '$op' $at\n" . $hereptr)) {
4562
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4563 4564
							$line_fixed = 1;
						}
4565
					}
4566
					if ($ctx =~ /ExW/) {
4567 4568
						if (ERROR("SPACING",
							  "space prohibited after that '$op' $at\n" . $hereptr)) {
4569
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4570 4571 4572
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
4573
							$line_fixed = 1;
4574
						}
4575
					}
4576 4577

				# << and >> may either have or not have spaces both sides
4578 4579 4580
				} elsif ($op eq '<<' or $op eq '>>' or
					 $op eq '&' or $op eq '^' or $op eq '|' or
					 $op eq '+' or $op eq '-' or
4581 4582
					 $op eq '*' or $op eq '/' or
					 $op eq '%')
4583
				{
4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599
					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/) {
4600 4601
						if (ERROR("SPACING",
							  "need consistent spacing around '$op' $at\n" . $hereptr)) {
4602 4603 4604 4605
							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
4606 4607
							$line_fixed = 1;
						}
4608 4609
					}

4610 4611 4612 4613
				# 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./) {
4614 4615
						if (ERROR("SPACING",
							  "space prohibited before that '$op' $at\n" . $hereptr)) {
4616
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4617 4618
							$line_fixed = 1;
						}
4619 4620
					}

4621
				# All the others need spaces both sides.
4622
				} elsif ($ctx !~ /[EWC]x[CWE]/) {
4623 4624
					my $ok = 0;

4625
					# Ignore email addresses <foo@bar>
4626 4627 4628 4629 4630
					if (($op eq '<' &&
					     $cc =~ /^\S+\@\S+>/) ||
					    ($op eq '>' &&
					     $ca =~ /<\S+\@\S+$/))
					{
4631
						$ok = 1;
4632 4633
					}

4634 4635 4636 4637 4638 4639 4640 4641
					# for asm volatile statements
					# ignore a colon with another
					# colon immediately before or after
					if (($op eq ':') &&
					    ($ca =~ /:$/ || $cc =~ /^:/)) {
						$ok = 1;
					}

4642
					# messages are ERROR, but ?: are CHK
4643
					if ($ok == 0) {
4644 4645
						my $msg_level = \&ERROR;
						$msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4646

4647 4648
						if (&{$msg_level}("SPACING",
								  "spaces required around that '$op' $at\n" . $hereptr)) {
4649 4650 4651 4652
							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
4653 4654
							$line_fixed = 1;
						}
4655
					}
4656
				}
4657
				$off += length($elements[$n + 1]);
4658 4659 4660 4661 4662 4663 4664 4665

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

				$fixed_line = $fixed_line . $good;
			}

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

4668 4669
			if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
				$fixed[$fixlinenr] = $fixed_line;
4670 4671 4672
			}


4673 4674
		}

4675
# check for whitespace before a non-naked semicolon
4676
		if ($line =~ /^\+.*\S\s+;\s*$/) {
4677 4678 4679
			if (WARN("SPACING",
				 "space prohibited before semicolon\n" . $herecurr) &&
			    $fix) {
4680
				1 while $fixed[$fixlinenr] =~
4681 4682 4683 4684
				    s/^(\+.*\S)\s+;/$1;/;
			}
		}

4685 4686
# check for multiple assignments
		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
4687 4688
			CHK("MULTIPLE_ASSIGNMENTS",
			    "multiple assignments should be avoided\n" . $herecurr);
4689 4690
		}

4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701
## # 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
## 			# falsly report the parameters of functions.
## 			my $ln = $line;
## 			while ($ln =~ s/\([^\(\)]*\)//g) {
## 			}
## 			if ($ln =~ /,/) {
4702 4703
## 				WARN("MULTIPLE_DECLARATION",
##				     "declaring multiple variables together should be avoided\n" . $herecurr);
4704 4705
## 			}
## 		}
4706

4707
#need space before brace following if, while, etc
4708
		if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
4709
		    $line =~ /\b(?:else|do)\{/) {
4710 4711 4712
			if (ERROR("SPACING",
				  "space required before the open brace '{'\n" . $herecurr) &&
			    $fix) {
4713
				$fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/;
4714
			}
4715 4716
		}

4717 4718 4719 4720 4721 4722 4723 4724
## # check for blank lines before declarations
##		if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
##		    $prevrawline =~ /^.\s*$/) {
##			WARN("SPACING",
##			     "No blank lines before declarations\n" . $hereprev);
##		}
##

4725 4726
# closing brace should have a space following it when it has anything
# on the line
4727
		if ($line =~ /}(?!(?:,|;|\)|\}))\S/) {
4728 4729 4730
			if (ERROR("SPACING",
				  "space required after that close brace '}'\n" . $herecurr) &&
			    $fix) {
4731
				$fixed[$fixlinenr] =~
4732 4733
				    s/}((?!(?:,|;|\)))\S)/} $1/;
			}
4734 4735
		}

4736 4737
# check spacing on square brackets
		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
4738 4739 4740
			if (ERROR("SPACING",
				  "space prohibited after that open square bracket '['\n" . $herecurr) &&
			    $fix) {
4741
				$fixed[$fixlinenr] =~
4742 4743
				    s/\[\s+/\[/;
			}
4744 4745
		}
		if ($line =~ /\s\]/) {
4746 4747 4748
			if (ERROR("SPACING",
				  "space prohibited before that close square bracket ']'\n" . $herecurr) &&
			    $fix) {
4749
				$fixed[$fixlinenr] =~
4750 4751
				    s/\s+\]/\]/;
			}
4752 4753
		}

4754
# check spacing on parentheses
4755 4756
		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
		    $line !~ /for\s*\(\s+;/) {
4757 4758 4759
			if (ERROR("SPACING",
				  "space prohibited after that open parenthesis '('\n" . $herecurr) &&
			    $fix) {
4760
				$fixed[$fixlinenr] =~
4761 4762
				    s/\(\s+/\(/;
			}
4763
		}
4764
		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
4765 4766
		    $line !~ /for\s*\(.*;\s+\)/ &&
		    $line !~ /:\s+\)/) {
4767 4768 4769
			if (ERROR("SPACING",
				  "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
			    $fix) {
4770
				$fixed[$fixlinenr] =~
4771 4772
				    s/\s+\)/\)/;
			}
4773 4774
		}

4775 4776 4777 4778
# 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) {
4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799
			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/;
			}
		}
4800

4801
# check for unnecessary parentheses around comparisons in if uses
4802 4803
# when !drivers/staging or command-line uses --strict
		if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
4804
		    $perl_version_ok && defined($stat) &&
4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826
		    $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);
			}
		}

4827
#goto labels aren't indented, allow a single space however
4828
		if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
4829
		   !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
4830 4831 4832
			if (WARN("INDENTED_LABEL",
				 "labels should not be indented\n" . $herecurr) &&
			    $fix) {
4833
				$fixed[$fixlinenr] =~
4834 4835
				    s/^(.)\s+/$1/;
			}
4836 4837
		}

4838
# return is not a function
4839
		if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
4840
			my $spacing = $1;
4841
			if ($perl_version_ok &&
4842 4843 4844 4845 4846 4847 4848
			    $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);
				}
4849
			} elsif ($spacing !~ /\s+/) {
4850 4851
				ERROR("SPACING",
				      "space required before the open parenthesis '('\n" . $herecurr);
4852 4853
			}
		}
4854

4855 4856 4857 4858 4859 4860 4861 4862
# 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*:/) {
4863
			WARN("RETURN_VOID",
4864 4865
			     "void function return statements are not generally useful\n" . $hereprev);
               }
4866

4867
# if statements using unnecessary parentheses - ie: if ((foo == bar))
4868
		if ($perl_version_ok &&
4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880
		    $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);
			}
		}

4881 4882 4883 4884
# 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"
4885
		if ($perl_version_ok &&
4886 4887 4888 4889 4890 4891
		    $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;
4892
			if ($lead !~ /(?:$Operators|\.)\s*$/ &&
4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909
			    $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)/;
			}
		}

4910 4911
# Return of what appears to be an errno should normally be negative
		if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
4912 4913
			my $name = $1;
			if ($name ne 'EOF' && $name ne 'ERROR') {
4914
				WARN("USE_NEGATIVE_ERRNO",
4915
				     "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
4916 4917
			}
		}
4918

4919
# Need a space before open parenthesis after if, while etc
4920 4921 4922 4923
		if ($line =~ /\b(if|while|for|switch)\(/) {
			if (ERROR("SPACING",
				  "space required before the open parenthesis '('\n" . $herecurr) &&
			    $fix) {
4924
				$fixed[$fixlinenr] =~
4925 4926
				    s/\b(if|while|for|switch)\(/$1 \(/;
			}
4927 4928
		}

4929 4930
# Check for illegal assignment in if conditional -- and check for trailing
# statements after the conditional.
4931
		if ($line =~ /do\s*(?!{)/) {
4932 4933 4934
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952
			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} &&
4953
		    defined($stat) && defined($cond) &&
4954
		    $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
4955
			my ($s, $c) = ($stat, $cond);
4956

4957
			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
4958 4959
				ERROR("ASSIGN_IN_IF",
				      "do not use assignment in if condition\n" . $herecurr);
4960 4961 4962 4963
			}

			# Find out what is on the end of the line after the
			# conditional.
4964
			substr($s, 0, length($c), '');
4965
			$s =~ s/\n.*//g;
4966
			$s =~ s/$;//g;	# Remove any comments
4967 4968
			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
			    $c !~ /}\s*while\s*/)
4969
			{
4970 4971 4972
				# Find out how long the conditional actually is.
				my @newlines = ($c =~ /\n/gs);
				my $cond_lines = 1 + $#newlines;
4973
				my $stat_real = '';
4974

4975 4976
				$stat_real = raw_line($linenr, $cond_lines)
							. "\n" if ($cond_lines);
4977 4978 4979 4980
				if (defined($stat_real) && $cond_lines > 1) {
					$stat_real = "[...]\n$stat_real";
				}

4981 4982
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr . $stat_real);
4983 4984 4985
			}
		}

4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997
# Check for bitwise tests written as boolean
		if ($line =~ /
			(?:
				(?:\[|\(|\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\|)
			|
				(?:\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\||\)|\])
			)/x)
		{
4998 4999
			WARN("HEXADECIMAL_BOOLEAN_TEST",
			     "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
5000 5001
		}

5002
# if and else should not have general statements after it
5003 5004
		if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
			my $s = $1;
5005
			$s =~ s/$;//g;	# Remove any comments
5006
			if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
5007 5008
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr);
5009
			}
5010
		}
5011 5012
# if should not continue a brace
		if ($line =~ /}\s*if\b/) {
5013
			ERROR("TRAILING_STATEMENTS",
5014
			      "trailing statements should be on next line (or did you mean 'else if'?)\n" .
5015 5016
				$herecurr);
		}
5017 5018 5019
# case and default should not have general statements after them
		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
		    $line !~ /\G(?:
5020
			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
5021 5022 5023
			\s*return\s+
		    )/xg)
		{
5024 5025
			ERROR("TRAILING_STATEMENTS",
			      "trailing statements should be on next line\n" . $herecurr);
5026
		}
5027 5028 5029

		# Check for }<nl>else {, these must be at the same
		# indent level to be relevant to each other.
5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045
		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);
			}
5046 5047
		}

5048 5049
		if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
		    $previndent == $indent) {
5050 5051 5052 5053
			my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);

			# Find out what is on the end of the line after the
			# conditional.
5054
			substr($s, 0, length($c), '');
5055 5056 5057
			$s =~ s/\n.*//g;

			if ($s =~ /^\s*;/) {
5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069
				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);
				}
5070 5071 5072
			}
		}

5073
#Specific variable tests
5074 5075
		while ($line =~ m{($Constant|$Lval)}g) {
			my $var = $1;
5076 5077

#CamelCase
5078
			if ($var !~ /^$Constant$/ &&
5079
			    $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
5080
#Ignore Page<foo> variants
5081
			    $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
5082 5083 5084
#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_]+)?$/ &&
5085 5086
#Ignore some three character SI units explicitly, like MiB and KHz
			    $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
5087 5088 5089
				while ($var =~ m{($Ident)}g) {
					my $word = $1;
					next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
5090 5091 5092 5093 5094 5095 5096
					if ($check) {
						seed_camelcase_includes();
						if (!$file && !$camelcase_file_seeded) {
							seed_camelcase_file($realfile);
							$camelcase_file_seeded = 1;
						}
					}
5097 5098 5099 5100 5101
					if (!defined $camelcase{$word}) {
						$camelcase{$word} = 1;
						CHK("CAMELCASE",
						    "Avoid CamelCase: <$word>\n" . $herecurr);
					}
5102
				}
5103 5104
			}
		}
5105 5106

#no spaces allowed after \ in define
5107 5108 5109 5110
		if ($line =~ /\#\s*define.*\\\s+$/) {
			if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
				 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
			    $fix) {
5111
				$fixed[$fixlinenr] =~ s/\s+$//;
5112
			}
5113 5114
		}

5115 5116
# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
# itself <asm/foo.h> (uses RAW line)
5117
		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
5118 5119 5120 5121
			my $file = "$1.h";
			my $checkfile = "include/linux/$file";
			if (-f "$root/$checkfile" &&
			    $realfile ne $checkfile &&
5122
			    $1 !~ /$allowed_asm_includes/)
5123
			{
5124 5125 5126 5127 5128 5129 5130 5131 5132
				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);
					}
5133
				}
5134 5135 5136
			}
		}

5137 5138
# 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
5139
# in a known good container
5140 5141
		if ($realfile !~ m@/vmlinux.lds.h$@ &&
		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
5142 5143
			my $ln = $linenr;
			my $cnt = $realcnt;
5144 5145
			my ($off, $dstat, $dcond, $rest);
			my $ctx = '';
5146 5147
			my $has_flow_statement = 0;
			my $has_arg_concat = 0;
5148
			($dstat, $dcond, $ln, $cnt, $off) =
5149 5150
				ctx_statement_block($linenr, $realcnt, 0);
			$ctx = $dstat;
5151
			#print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5152
			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5153

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

5157 5158 5159 5160 5161 5162 5163 5164
			$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;
5165
				$define_args =~ s/\\\+?//g;
5166 5167 5168
				@def_args = split(",", $define_args);
			}

5169
			$dstat =~ s/$;//g;
5170 5171 5172
			$dstat =~ s/\\\n.//g;
			$dstat =~ s/^\s*//s;
			$dstat =~ s/\s*$//s;
5173

5174
			# Flatten any parentheses and braces
5175 5176
			while ($dstat =~ s/\([^\(\)]*\)/1/ ||
			       $dstat =~ s/\{[^\{\}]*\}/1/ ||
5177
			       $dstat =~ s/.\[[^\[\]]*\]/1/)
5178
			{
5179
			}
5180

5181
			# Flatten any obvious string concatenation.
5182 5183
			while ($dstat =~ s/($String)\s*$Ident/$1/ ||
			       $dstat =~ s/$Ident\s*($String)/$1/)
5184 5185 5186
			{
			}

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

5190 5191 5192
			my $exceptions = qr{
				$Declare|
				module_param_named|
5193
				MODULE_PARM_DESC|
5194 5195
				DECLARE_PER_CPU|
				DEFINE_PER_CPU|
5196
				__typeof__\(|
5197 5198
				union|
				struct|
5199
				\.$Ident\s*=\s*|
5200 5201
				^\"|\"$|
				^\[
5202
			}x;
5203
			#print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5204 5205 5206

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

5209 5210 5211
			if ($dstat ne '' &&
			    $dstat !~ /^(?:$Ident|-?$Constant),$/ &&			# 10, // foo(),
			    $dstat !~ /^(?:$Ident|-?$Constant);$/ &&			# foo();
5212
			    $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ &&		# 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5213
			    $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ &&			# character constants
5214 5215
			    $dstat !~ /$exceptions/ &&
			    $dstat !~ /^\.$Ident\s*=/ &&				# .foo =
5216
			    $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ &&		# stringification #foo
5217
			    $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ &&	# do {...} while (...); // do {...} while (...)
5218 5219 5220
			    $dstat !~ /^for\s*$Constant$/ &&				# for (...)
			    $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ &&	# for (...) bar()
			    $dstat !~ /^do\s*{/ &&					# do {...
5221
			    $dstat !~ /^\(\{/ &&						# ({...
5222
			    $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
5223
			{
5224 5225 5226 5227
				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 =~ /;/) {
5228 5229 5230
					ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
					      "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
				} else {
5231
					ERROR("COMPLEX_MACRO",
A
Andrew Morton 已提交
5232
					      "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
5233
				}
5234 5235

			}
5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253

			# 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);

5254 5255 5256
# check if any macro arguments are reused (ignore '...' and 'type')
			foreach my $arg (@def_args) {
			        next if ($arg =~ /\.\.\./);
5257
			        next if ($arg =~ /^type$/i);
5258
				my $tmp_stmt = $define_stmt;
5259
				$tmp_stmt =~ s/\b(sizeof|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5260 5261
				$tmp_stmt =~ s/\#+\s*$arg\b//g;
				$tmp_stmt =~ s/\b$arg\s*\#\#//g;
5262
				my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
5263 5264 5265
				if ($use_cnt > 1) {
					CHK("MACRO_ARG_REUSE",
					    "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
5266 5267
				    }
# check if any macro arguments may have other precedence issues
5268
				if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
5269 5270 5271 5272
				    ((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");
5273
				}
5274
			}
5275

5276 5277 5278 5279
# 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);
5280
				my $herectx = get_stat_here($linenr, $cnt, $here);
5281 5282 5283 5284 5285

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

5286
# check for line continuations outside of #defines, preprocessor #, and asm
5287 5288 5289

		} else {
			if ($prevline !~ /^..*\\$/ &&
5290 5291
			    $line !~ /^\+\s*\#.*\\$/ &&		# preprocessor
			    $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ &&	# asm
5292 5293 5294 5295
			    $line =~ /^\+.*\\$/) {
				WARN("LINE_CONTINUATIONS",
				     "Avoid unnecessary line continuations\n" . $herecurr);
			}
5296 5297
		}

5298 5299 5300
# 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
5301
		if ($perl_version_ok &&
5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312
		    $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;
5313
			$dstat =~ s/$;/ /g;
5314 5315 5316 5317 5318 5319 5320

			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);
5321
				my $herectx = get_stat_here($linenr, $cnt, $here);
5322

5323 5324
				if (($stmts =~ tr/;/;/) == 1 &&
				    $stmts !~ /^\s*(if|while|for|switch)\b/) {
5325 5326 5327 5328 5329 5330 5331
					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");
				}
5332 5333 5334
			} elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
				$ctx =~ s/\n*$//;
				my $cnt = statement_rawlines($ctx);
5335
				my $herectx = get_stat_here($linenr, $cnt, $here);
5336 5337 5338

				WARN("TRAILING_SEMICOLON",
				     "macros should not use a trailing semicolon\n" . "$herectx");
5339 5340 5341
			}
		}

5342
# check for redundant bracing round if etc
5343 5344
		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
			my ($level, $endln, @chunks) =
5345
				ctx_statement_full($linenr, $realcnt, 1);
5346
			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5347 5348
			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
			if ($#chunks > 0 && $level == 0) {
5349 5350
				my @allowed = ();
				my $allow = 0;
5351
				my $seen = 0;
5352
				my $herectx = $here . "\n";
5353
				my $ln = $linenr - 1;
5354 5355 5356
				for my $chunk (@chunks) {
					my ($cond, $block) = @{$chunk};

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

5361
					$allowed[$allow] = 0;
5362 5363 5364 5365 5366 5367
					#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";
5368 5369
					$ln += statement_rawlines($block) - 1;

5370
					substr($block, 0, length($cond), '');
5371 5372 5373

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

5374
					#print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5375 5376
					if (statement_lines($cond) > 1) {
						#print "APW: ALLOWED: cond<$cond>\n";
5377
						$allowed[$allow] = 1;
5378 5379
					}
					if ($block =~/\b(?:if|for|while)\b/) {
5380
						#print "APW: ALLOWED: block<$block>\n";
5381
						$allowed[$allow] = 1;
5382
					}
5383 5384
					if (statement_block_size($block) > 1) {
						#print "APW: ALLOWED: lines block<$block>\n";
5385
						$allowed[$allow] = 1;
5386
					}
5387
					$allow++;
5388
				}
5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401
				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);
					}
5402 5403 5404
				}
			}
		}
5405
		if (!defined $suppress_ifbraces{$linenr - 1} &&
5406
					$line =~ /\b(if|while|for|else)\b/) {
5407 5408 5409 5410 5411 5412 5413
			my $allowed = 0;

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

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

5418 5419
			# Check the condition.
			my ($cond, $block) = @{$chunks[0]};
5420
			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5421
			if (defined $cond) {
5422
				substr($block, 0, length($cond), '');
5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439
			}
			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) {
5440
					substr($block, 0, length($cond), '');
5441 5442 5443 5444 5445 5446 5447
				}
				if ($block =~ /^\s*\{/) {
					#print "APW: ALLOWED: chunk-1 block<$block>\n";
					$allowed = 1;
				}
			}
			if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
5448
				my $cnt = statement_rawlines($block);
5449
				my $herectx = get_stat_here($linenr, $cnt, $here);
5450

5451 5452
				WARN("BRACES",
				     "braces {} are not necessary for single statement blocks\n" . $herectx);
5453 5454 5455
			}
		}

5456
# check for single line unbalanced braces
5457 5458
		if ($sline =~ /^.\s*\}\s*else\s*$/ ||
		    $sline =~ /^.\s*else\s*\{\s*$/) {
5459 5460 5461
			CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
		}

5462
# check for unnecessary blank lines around braces
5463
		if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
5464 5465 5466 5467 5468
			if (CHK("BRACES",
				"Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
			    $fix && $prevrawline =~ /^\+/) {
				fix_delete_line($fixlinenr - 1, $prevrawline);
			}
5469
		}
5470
		if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
5471 5472 5473 5474 5475
			if (CHK("BRACES",
				"Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
			    $fix) {
				fix_delete_line($fixlinenr, $rawline);
			}
5476 5477
		}

5478
# no volatiles please
5479 5480
		my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
		if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
5481
			WARN("VOLATILE",
5482
			     "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5483 5484
		}

5485 5486 5487 5488
# 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
5489
		if ($line =~ /^\+\s*$String/ &&
5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523
		    $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);
		}

5524 5525 5526 5527
# 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
5528 5529
		if ($line =~ /^\+.*$String/ &&
		    defined($context_function) &&
5530 5531
		    get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
		    length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
5532
			WARN("EMBEDDED_FUNCTION_NAME",
5533
			     "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5534 5535
		}

5536 5537 5538 5539 5540 5541 5542 5543 5544 5545
# 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/;
			}

		}

5546
# concatenated string without spaces between elements
5547 5548 5549 5550 5551 5552 5553 5554 5555 5556
		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/;
				}
			}
5557 5558
		}

5559
# uncoalesced string fragments
5560
		if ($line =~ /$String\s*"/) {
5561 5562 5563 5564 5565 5566 5567 5568
			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;
				}
			}
5569 5570
		}

5571 5572 5573
# 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;
5574
		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5575
			my $string = substr($rawline, $-[1], $+[1] - $-[1]);
5576
			$string =~ s/%%/__/g;
5577 5578
			# check for %L
			if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
5579
				WARN("PRINTF_L",
5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591
				     "\%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",
5592 5593
				      "Prefixing 0x with decimal output is defective\n" . $herecurr);
			}
5594 5595 5596
		}

# check for line continuations in quoted strings with odd counts of "
5597
		if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
5598 5599 5600 5601
			WARN("LINE_CONTINUATIONS",
			     "Avoid line continuations in quoted strings\n" . $herecurr);
		}

5602
# warn about #if 0
5603
		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
5604 5605 5606 5607 5608 5609 5610 5611
			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);
5612 5613
		}

5614 5615
# check for needless "if (<foo>) fn(<foo>)" uses
		if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643
			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/;
					}
				}
5644 5645
			}
		}
5646

5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657
# 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");

5658 5659
			if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
			    $s !~ /\b__GFP_NOWARN\b/ ) {
5660 5661 5662 5663 5664
				WARN("OOM_MESSAGE",
				     "Possible unnecessary 'out of memory' message\n" . $hereprev);
			}
		}

5665
# check for logging functions with KERN_<LEVEL>
5666
		if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
5667 5668 5669 5670 5671 5672 5673 5674 5675
		    $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*//;
			}
		}

5676 5677 5678 5679 5680 5681
# 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);
		}

5682
# check for mask then right shift without a parentheses
5683
		if ($perl_version_ok &&
5684 5685 5686 5687 5688 5689
		    $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);
		}

5690
# check for pointer comparisons to NULL
5691
		if ($perl_version_ok) {
5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703
			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/;
				}
			}
		}

5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716
# 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) {
5717
					$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;
5718 5719 5720 5721
				}
			}
		}

5722 5723 5724 5725 5726 5727 5728 5729 5730
# 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) {
5731
				$fixed[$fixlinenr] =~
5732 5733 5734 5735 5736 5737 5738 5739 5740 5741
				    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) {
5742
				my $lead = $fixed[$fixlinenr] =~
5743 5744 5745 5746
				    /(^\+\s*(?:static\s+))/;
				$lead = rtrim($1);
				$lead = "$lead " if ($lead !~ /^\+$/);
				$lead = "${lead}const ";
5747
				$fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
5748 5749 5750
			}
		}

5751 5752 5753 5754 5755 5756 5757 5758 5759 5760
# 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//;
			}
		}

5761 5762 5763 5764 5765 5766 5767 5768 5769
# 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) {
5770
				$fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
5771 5772 5773
			}
		}

5774
# prefer usleep_range over udelay
B
Bruce Allan 已提交
5775
		if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
5776
			my $delay = $1;
5777
			# ignore udelay's < 10, however
5778
			if (! ($delay < 10) ) {
5779
				CHK("USLEEP_RANGE",
5780
				    "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
5781 5782 5783 5784
			}
			if ($delay > 2000) {
				WARN("LONG_UDELAY",
				     "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
5785 5786 5787
			}
		}

5788 5789 5790
# warn about unexpectedly long msleep's
		if ($line =~ /\bmsleep\s*\((\d+)\);/) {
			if ($1 < 20) {
5791
				WARN("MSLEEP",
5792
				     "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
5793 5794 5795
			}
		}

5796 5797 5798 5799 5800 5801
# 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);
		}

5802 5803 5804 5805 5806 5807
# 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);
		}

5808
# warn about #ifdefs in C files
5809
#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5810 5811 5812 5813 5814
#			print "#ifdef in C files should be avoided\n";
#			print "$herecurr";
#			$clean = 0;
#		}

5815
# warn about spacing in #ifdefs
5816
		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
5817 5818 5819
			if (ERROR("SPACING",
				  "exactly one space required after that #$1\n" . $herecurr) &&
			    $fix) {
5820
				$fixed[$fixlinenr] =~
5821 5822 5823
				    s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
			}

5824 5825
		}

5826
# check for spinlock_t definitions without a comment.
5827 5828
		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
5829 5830
			my $which = $1;
			if (!ctx_has_comment($first_line, $linenr)) {
5831 5832
				CHK("UNCOMMENTED_DEFINITION",
				    "$1 definition without comment\n" . $herecurr);
5833 5834 5835
			}
		}
# check for memory barriers without a comment.
5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852

		my $barriers = qr{
			mb|
			rmb|
			wmb|
			read_barrier_depends
		}x;
		my $barrier_stems = qr{
			mb__before_atomic|
			mb__after_atomic|
			store_release|
			load_acquire|
			store_mb|
			(?:$barriers)
		}x;
		my $all_barriers = qr{
			(?:$barriers)|
5853 5854
			smp_(?:$barrier_stems)|
			virt_(?:$barrier_stems)
5855 5856 5857
		}x;

		if ($line =~ /\b(?:$all_barriers)\s*\(/) {
5858
			if (!ctx_has_comment($first_line, $linenr)) {
5859 5860
				WARN("MEMORY_BARRIER",
				     "memory barrier without comment\n" . $herecurr);
5861 5862
			}
		}
5863

5864 5865 5866 5867 5868 5869 5870 5871 5872 5873
		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);
		}

5874 5875 5876 5877 5878 5879 5880
# 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);
			}
		}
5881

5882 5883 5884 5885 5886 5887
# check for smp_read_barrier_depends and read_barrier_depends
		if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) {
			WARN("READ_BARRIER_DEPENDS",
			     "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr);
		}

5888
# check of hardware specific defines
5889
		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5890 5891
			CHK("ARCH_DEFINES",
			    "architecture specific defines should be avoided\n" .  $herecurr);
5892
		}
5893

5894 5895 5896 5897 5898
# 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);
		}
5899
# Check that the storage class is at the beginning of a declaration
5900 5901 5902 5903
		if ($line =~ /\b$Storage\b/ &&
		    $line !~ /^.\s*$Storage/ &&
		    $line =~ /^.\s*(.+?)\$Storage\s/ &&
		    $1 !~ /[\,\)]\s*$/) {
5904
			WARN("STORAGE_CLASS",
5905
			     "storage class should be at the beginning of the declaration\n" . $herecurr);
5906 5907
		}

5908 5909
# check the location of the inline attribute, that it is between
# storage class and type.
5910 5911
		if ($line =~ /\b$Type\s+$Inline\b/ ||
		    $line =~ /\b$Inline\s+$Storage\b/) {
5912 5913
			ERROR("INLINE_LOCATION",
			      "inline keyword should sit between storage class and type\n" . $herecurr);
5914 5915
		}

5916
# Check for __inline__ and __inline, prefer inline
5917 5918
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b(__inline__|__inline)\b/) {
5919 5920 5921
			if (WARN("INLINE",
				 "plain inline is preferred over $1\n" . $herecurr) &&
			    $fix) {
5922
				$fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
5923 5924

			}
5925 5926
		}

5927
# Check for __attribute__ packed, prefer __packed
5928 5929
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
5930 5931
			WARN("PREFER_PACKED",
			     "__packed is preferred over __attribute__((packed))\n" . $herecurr);
5932 5933
		}

5934
# Check for __attribute__ aligned, prefer __aligned
5935 5936
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
5937 5938
			WARN("PREFER_ALIGNED",
			     "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
5939 5940
		}

5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952
# Check for __attribute__ section, prefer __section
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(.*_*section_*\s*\(\s*("[^"]*")/) {
			my $old = substr($rawline, $-[1], $+[1] - $-[1]);
			my $new = substr($old, 1, -1);
			if (WARN("PREFER_SECTION",
				 "__section($new) is preferred over __attribute__((section($old)))\n" . $herecurr) &&
			    $fix) {
				$fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/;
			}
		}

5953
# Check for __attribute__ format(printf, prefer __printf
5954 5955
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
5956 5957 5958
			if (WARN("PREFER_PRINTF",
				 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
			    $fix) {
5959
				$fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5960 5961

			}
5962 5963
		}

5964
# Check for __attribute__ format(scanf, prefer __scanf
5965 5966
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
5967 5968 5969
			if (WARN("PREFER_SCANF",
				 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
			    $fix) {
5970
				$fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5971
			}
5972 5973
		}

5974
# Check for __attribute__ weak, or __weak declarations (may have link issues)
5975
		if ($perl_version_ok &&
5976 5977 5978 5979 5980 5981 5982
		    $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);
		}

5983
# check for c99 types like uint8_t used outside of uapi/ and tools/
5984
		if ($realfile !~ m@\binclude/uapi/@ &&
5985
		    $realfile !~ m@\btools/@ &&
5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001
		    $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/;
				}
			}
		}

6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021
# 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/;
			}
		}

6022 6023
# check for sizeof(&)
		if ($line =~ /\bsizeof\s*\(\s*\&/) {
6024 6025
			WARN("SIZEOF_ADDRESS",
			     "sizeof(& should be avoided\n" . $herecurr);
6026 6027
		}

6028 6029
# check for sizeof without parenthesis
		if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
6030 6031 6032
			if (WARN("SIZEOF_PARENTHESIS",
				 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
			    $fix) {
6033
				$fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
6034
			}
6035 6036
		}

6037 6038 6039 6040 6041 6042
# 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);
		}

6043
# check for seq_printf uses that could be seq_puts
J
Joe Perches 已提交
6044
		if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
6045
			my $fmt = get_quoted_string($line, $rawline);
6046 6047
			$fmt =~ s/%%//g;
			if ($fmt !~ /%/) {
6048 6049 6050
				if (WARN("PREFER_SEQ_PUTS",
					 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
				    $fix) {
6051
					$fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
6052
				}
6053 6054 6055
			}
		}

6056
# check for vsprintf extension %p<foo> misuses
6057
		if ($perl_version_ok &&
6058 6059 6060
		    defined $stat &&
		    $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
		    $1 !~ /^_*volatile_*$/) {
6061 6062
			my $stat_real;

6063 6064 6065
			my $lc = $stat =~ tr@\n@@;
			$lc = $lc + $linenr;
		        for (my $count = $linenr; $count <= $lc; $count++) {
6066 6067
				my $specifier;
				my $extension;
6068
				my $qualifier;
6069
				my $bad_specifier = "";
6070 6071
				my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
				$fmt =~ s/%%//g;
6072

6073
				while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) {
6074 6075
					$specifier = $1;
					$extension = $2;
6076
					$qualifier = $3;
6077
					if ($extension !~ /[SsBKRraEehMmIiUDdgVCbGNOxtf]/ ||
6078 6079
					    ($extension eq "f" &&
					     defined $qualifier && $qualifier !~ /^w/)) {
6080 6081 6082 6083 6084 6085 6086 6087 6088 6089
						$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");
					}
6090
				}
6091 6092 6093 6094 6095 6096 6097 6098
				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/);
					}
6099

6100 6101 6102
					WARN("VSPRINTF_POINTER_EXTENSION",
					     "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
				}
6103 6104 6105
			}
		}

6106
# Check for misused memsets
6107
		if ($perl_version_ok &&
6108
		    defined $stat &&
6109
		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
6110 6111

			my $ms_addr = $2;
6112 6113
			my $ms_val = $7;
			my $ms_size = $12;
6114 6115 6116

			if ($ms_size =~ /^(0x|)0$/i) {
				ERROR("MEMSET",
6117
				      "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
6118 6119
			} elsif ($ms_size =~ /^(0x|)1$/i) {
				WARN("MEMSET",
6120 6121 6122 6123
				     "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
			}
		}

6124
# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
6125
#		if ($perl_version_ok &&
6126 6127 6128 6129 6130 6131 6132 6133
#		    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)/;
#			}
#		}
6134

6135
# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
6136
#		if ($perl_version_ok &&
6137 6138 6139 6140 6141
#		    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")
#		}
6142

6143 6144
# 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
6145
#		if ($perl_version_ok &&
6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164
#		    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)/;
#				}
#			}
#		}
6165

6166
# typecasts on min/max could be min_t/max_t
6167
		if ($perl_version_ok &&
6168
		    defined $stat &&
6169
		    $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
6170
			if (defined $2 || defined $7) {
6171 6172 6173
				my $call = $1;
				my $cast1 = deparenthesize($2);
				my $arg1 = $3;
6174 6175
				my $cast2 = deparenthesize($7);
				my $arg2 = $8;
6176 6177
				my $cast;

6178
				if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
6179 6180 6181 6182 6183 6184 6185 6186
					$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");
6187 6188 6189
			}
		}

6190
# check usleep_range arguments
6191
		if ($perl_version_ok &&
6192 6193 6194 6195 6196 6197
		    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",
6198
				     "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6199 6200 6201
			} elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
				 $min > $max) {
				WARN("USLEEP_RANGE",
6202
				     "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6203 6204 6205
			}
		}

6206
# check for naked sscanf
6207
		if ($perl_version_ok &&
6208
		    defined $stat &&
6209
		    $line =~ /\bsscanf\b/ &&
6210 6211 6212 6213 6214
		    ($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;
6215
			my $stat_real = get_stat_real($linenr, $lc);
6216 6217 6218 6219
			WARN("NAKED_SSCANF",
			     "unchecked sscanf return value\n" . "$here\n$stat_real\n");
		}

6220
# check for simple sscanf that should be kstrto<foo>
6221
		if ($perl_version_ok &&
6222 6223 6224 6225
		    defined $stat &&
		    $line =~ /\bsscanf\b/) {
			my $lc = $stat =~ tr@\n@@;
			$lc = $lc + $linenr;
6226
			my $stat_real = get_stat_real($linenr, $lc);
6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237
			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");
				}
			}
		}

6238 6239 6240
# check for new externs in .h files.
		if ($realfile =~ /\.h$/ &&
		    $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
6241 6242
			if (CHK("AVOID_EXTERNS",
				"extern prototypes should be avoided in .h files\n" . $herecurr) &&
6243
			    $fix) {
6244
				$fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
6245 6246 6247
			}
		}

6248
# check for new externs in .c files.
6249
		if ($realfile =~ /\.c$/ && defined $stat &&
6250
		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
6251
		{
6252 6253
			my $function_name = $1;
			my $paren_space = $2;
6254 6255 6256 6257 6258

			my $s = $stat;
			if (defined $cond) {
				substr($s, 0, length($cond), '');
			}
6259 6260 6261
			if ($s =~ /^\s*;/ &&
			    $function_name ne 'uninitialized_var')
			{
6262 6263
				WARN("AVOID_EXTERNS",
				     "externs should be avoided in .c files\n" .  $herecurr);
6264 6265 6266
			}

			if ($paren_space =~ /\n/) {
6267 6268
				WARN("FUNCTION_ARGUMENTS",
				     "arguments for function declarations should follow identifier\n" . $herecurr);
6269
			}
6270 6271 6272 6273

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

6278 6279
# check for function declarations that have arguments without identifier names
		if (defined $stat &&
6280
		    $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291
		    $1 ne "void") {
			my $args = trim($1);
			while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
				my $arg = trim($1);
				if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
					WARN("FUNCTION_ARGUMENTS",
					     "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
				}
			}
		}

6292
# check for function definitions
6293
		if ($perl_version_ok &&
6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314
		    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);
			}
		}

6315 6316 6317 6318 6319
# checks for new __setup's
		if ($rawline =~ /\b__setup\("([^"]*)"/) {
			my $name = $1;

			if (!grep(/$name/, @setup_docs)) {
6320
				CHK("UNDOCUMENTED_SETUP",
6321
				    "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
6322
			}
6323
		}
6324

6325 6326
# check for pointless casting of alloc functions
		if ($line =~ /\*\s*\)\s*$allocFunctions\b/) {
6327 6328
			WARN("UNNECESSARY_CASTS",
			     "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6329
		}
6330

6331 6332
# alloc style
# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6333
		if ($perl_version_ok &&
6334
		    $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6335 6336 6337 6338
			CHK("ALLOC_SIZEOF_STRUCT",
			    "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
		}

6339
# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6340
		if ($perl_version_ok &&
6341 6342
		    defined $stat &&
		    $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6343 6344 6345 6346 6347
			my $oldfunc = $3;
			my $a1 = $4;
			my $a2 = $10;
			my $newfunc = "kmalloc_array";
			$newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
6348 6349 6350 6351 6352 6353 6354 6355
			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_]*$/)) {
6356
				my $cnt = statement_rawlines($stat);
6357 6358
				my $herectx = get_stat_here($linenr, $cnt, $here);

6359
				if (WARN("ALLOC_WITH_MULTIPLY",
6360 6361
					 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
				    $cnt == 1 &&
6362
				    $fix) {
6363
					$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;
6364 6365 6366 6367
				}
			}
		}

6368
# check for krealloc arg reuse
6369
		if ($perl_version_ok &&
6370 6371
		    $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ &&
		    $1 eq $3) {
6372 6373 6374 6375
			WARN("KREALLOC_ARG_REUSE",
			     "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
		}

6376 6377 6378 6379 6380 6381
# 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);
		}

6382 6383
# check for multiple semicolons
		if ($line =~ /;\s*;\s*$/) {
6384 6385 6386
			if (WARN("ONE_SEMICOLON",
				 "Statements terminations use 1 semicolon\n" . $herecurr) &&
			    $fix) {
6387
				$fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
6388
			}
6389 6390
		}

6391 6392 6393
# 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*\)?/) {
6394 6395 6396 6397 6398 6399 6400 6401 6402
			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)/;
			}
		}

6403 6404 6405 6406 6407 6408 6409 6410 6411 6412
# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
		if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
			my $config = $1;
			if (WARN("PREFER_IS_ENABLED",
				 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
			    $fix) {
				$fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
			}
		}

6413
# check for case / default statements not preceded by break/fallthrough/switch
6414 6415 6416 6417 6418
		if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
			my $has_break = 0;
			my $has_statement = 0;
			my $count = 0;
			my $prevline = $linenr;
6419
			while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
6420 6421 6422 6423 6424 6425 6426 6427 6428 6429
				$prevline--;
				my $rline = $rawlines[$prevline - 1];
				my $fline = $lines[$prevline - 1];
				last if ($fline =~ /^\@\@/);
				next if ($fline =~ /^\-/);
				next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
				$has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
				next if ($fline =~ /^.[\s$;]*$/);
				$has_statement = 1;
				$count++;
6430
				$has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
6431 6432 6433
			}
			if (!$has_break && $has_statement) {
				WARN("MISSING_BREAK",
6434
				     "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
6435 6436 6437
			}
		}

6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459
# 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;
				}
			}
		}

6460
# check for switch/default statements without a break;
6461
		if ($perl_version_ok &&
6462 6463 6464
		    defined $stat &&
		    $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
			my $cnt = statement_rawlines($stat);
6465 6466
			my $herectx = get_stat_here($linenr, $cnt, $here);

6467 6468
			WARN("DEFAULT_NO_BREAK",
			     "switch default: should use break\n" . $herectx);
6469 6470
		}

6471
# check for gcc specific __FUNCTION__
6472 6473 6474 6475
		if ($line =~ /\b__FUNCTION__\b/) {
			if (WARN("USE_FUNC",
				 "__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr) &&
			    $fix) {
6476
				$fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
6477
			}
6478
		}
6479

6480 6481 6482 6483 6484 6485
# 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 已提交
6486 6487 6488 6489 6490 6491
# 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);
		}

6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518
# 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);

			}
		}

6519 6520
# check for semaphores initialized locked
		if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
6521 6522
			WARN("CONSIDER_COMPLETION",
			     "consider using a completion\n" . $herecurr);
6523
		}
6524

6525 6526
# recommend kstrto* over simple_strto* and strict_strto*
		if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
6527
			WARN("CONSIDER_KSTRTO",
6528
			     "$1 is obsolete, use k$3 instead\n" . $herecurr);
6529
		}
6530

6531
# check for __initcall(), use device_initcall() explicitly or more appropriate function please
6532
		if ($line =~ /^.\s*__initcall\s*\(/) {
6533
			WARN("USE_DEVICE_INITCALL",
6534
			     "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6535
		}
6536

6537 6538 6539 6540 6541 6542
# 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);
		}

6543 6544 6545 6546 6547 6548 6549 6550
# 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);
		}

6551
# check for various structs that are normally const (ops, kgdb, device_tree)
6552
# and avoid what seem like struct definitions 'struct foo {'
6553
		if ($line !~ /\bconst\b/ &&
6554
		    $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
6555
			WARN("CONST_STRUCT",
6556
			     "struct $1 should normally be const\n" . $herecurr);
6557
		}
6558 6559 6560 6561

# 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/ &&
6562 6563
		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
6564 6565 6566
		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
6567
		{
6568 6569
			WARN("NR_CPUS",
			     "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6570
		}
6571

6572 6573 6574 6575 6576 6577
# 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);
		}

6578
# likely/unlikely comparisons similar to "(likely(foo) > 0)"
6579
		if ($perl_version_ok &&
6580 6581 6582 6583 6584
		    $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
			WARN("LIKELY_MISUSE",
			     "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
		}

6585 6586 6587 6588 6589 6590
# 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);
		}

6591 6592 6593
# whine mightly about in_atomic
		if ($line =~ /\bin_atomic\s*\(/) {
			if ($realfile =~ m@^drivers/@) {
6594 6595
				ERROR("IN_ATOMIC",
				      "do not use in_atomic in drivers\n" . $herecurr);
6596
			} elsif ($realfile !~ m@^kernel/@) {
6597 6598
				WARN("IN_ATOMIC",
				     "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
6599 6600
			}
		}
6601

6602 6603 6604 6605 6606 6607
# check for mutex_trylock_recursive usage
		if ($line =~ /mutex_trylock_recursive/) {
			ERROR("LOCKING",
			      "recursive locking is bad, do not use this ever.\n" . $herecurr);
		}

6608 6609 6610 6611 6612 6613
# 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@) {
6614 6615
				ERROR("LOCKDEP",
				      "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
6616 6617
			}
		}
6618

6619 6620
		if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
		    $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
6621 6622
			WARN("EXPORTED_WORLD_WRITABLE",
			     "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6623
		}
6624

6625 6626 6627
# 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
6628
		if ($perl_version_ok &&
6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681
		    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);
			}
		}

6682 6683
# Mode permission misuses where it seems decimal should be octal
# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6684 6685 6686 6687
# 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
6688
		if ($perl_version_ok &&
6689
		    defined $stat &&
6690 6691 6692 6693 6694
		    $line =~ /$mode_perms_search/) {
			foreach my $entry (@mode_permission_funcs) {
				my $func = $entry->[0];
				my $arg_pos = $entry->[1];

6695 6696
				my $lc = $stat =~ tr@\n@@;
				$lc = $lc + $linenr;
6697
				my $stat_real = get_stat_real($linenr, $lc);
6698

6699 6700 6701 6702 6703
				my $skip_args = "";
				if ($arg_pos > 1) {
					$arg_pos--;
					$skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
				}
6704
				my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
6705
				if ($stat =~ /$test/) {
6706 6707
					my $val = $1;
					$val = $6 if ($skip_args ne "");
6708 6709 6710
					if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
					    (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
					     ($val =~ /^$Octal$/ && length($val) ne 4))) {
6711
						ERROR("NON_OCTAL_PERMISSIONS",
6712
						      "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
6713 6714
					}
					if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
6715
						ERROR("EXPORTED_WORLD_WRITABLE",
6716
						      "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6717
					}
6718 6719 6720
				}
			}
		}
6721

6722
# check for uses of S_<PERMS> that could be octal for readability
6723
		while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
6724 6725
			my $oval = $1;
			my $octal = perms_to_octal($oval);
6726 6727 6728
			if (WARN("SYMBOLIC_PERMS",
				 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
			    $fix) {
6729
				$fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
6730 6731 6732
			}
		}

6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749
# 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);
			}
		}
6750 6751 6752 6753 6754 6755

# 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);
		}
6756 6757 6758 6759 6760 6761
	}

	# If we have no input at all, then there is nothing to report on
	# so just keep quiet.
	if ($#rawlines == -1) {
		exit(0);
6762 6763
	}

6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775
	# 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);
	}

	# This is not a patch, and we are are in 'no-patch' mode so
	# just keep quiet.
	if (!$chk_patch && !$is_patch) {
		exit(0);
	}

6776
	if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
6777 6778
		ERROR("NOT_UNIFIED_DIFF",
		      "Does not appear to be a unified-diff format patch\n");
6779
	}
6780 6781 6782 6783 6784 6785 6786 6787
	if ($is_patch && $has_commit_log && $chk_signoff) {
		if ($signoff == 0) {
			ERROR("MISSING_SIGN_OFF",
			      "Missing Signed-off-by: line(s)\n");
		} elsif (!$authorsignoff) {
			WARN("NO_AUTHOR_SIGN_OFF",
			     "Missing Signed-off-by: line by nominal patch author '$author'\n");
		}
6788 6789
	}

6790
	print report_dump();
6791 6792
	if ($summary && !($clean == 1 && $quiet == 1)) {
		print "$filename " if ($summary_file);
6793 6794 6795
		print "total: $cnt_error errors, $cnt_warn warnings, " .
			(($check)? "$cnt_chk checks, " : "") .
			"$cnt_lines lines checked\n";
6796
	}
6797

6798
	if ($quiet == 0) {
6799 6800 6801 6802 6803 6804 6805 6806
		# 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
		}
6807 6808 6809
		# If there were whitespace errors which cleanpatch can fix
		# then suggest that.
		if ($rpt_cleaners) {
6810
			$rpt_cleaners = 0;
6811 6812 6813 6814 6815
			print << "EOM"

NOTE: Whitespace errors detected.
      You may wish to use scripts/cleanpatch or scripts/cleanfile
EOM
6816 6817 6818
		}
	}

6819 6820 6821
	if ($clean == 0 && $fix &&
	    ("@rawlines" ne "@fixed" ||
	     $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
6822 6823
		my $newfile = $filename;
		$newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
6824 6825 6826
		my $linecount = 0;
		my $f;

6827 6828
		@fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);

6829 6830 6831 6832 6833 6834 6835
		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/^\+//;
6836
					print $f $fixed_line . "\n";
6837 6838 6839 6840 6841 6842 6843 6844 6845
				}
			} else {
				print $f $fixed_line . "\n";
			}
		}
		close($f);

		if (!$quiet) {
			print << "EOM";
6846

6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857
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
		}
	}

6858 6859 6860 6861 6862 6863 6864
	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";
		}
6865 6866 6867
	}
	return $clean;
}