checkpatch.pl 199.7 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 68 69 70 71 72 73 74 75 76 77 78 79 80 81

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

When FILE is - read standard input.
EOM

	exit($exitcode);
}

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

	exit($exitcode);
}

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

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

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

help(0) if ($help);
238

239 240
list_types(0) if ($list_types);

241
$fix = 1 if ($fix_inplace);
242
$check_orig = $check;
243

244 245
my $exit = 0;

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

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

258 259 260 261 262 263 264 265 266 267 268 269
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";
}

270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
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}++;
	}
}
286

287 288
sub hash_show_words {
	my ($hashRef, $prefix) = @_;
289

290
	if (keys %$hashRef) {
291
		print "\nNOTE: $prefix message types:";
292
		foreach my $word (sort keys %$hashRef) {
293 294
			print " $word";
		}
295
		print "\n";
296
	}
297 298
}

299 300 301
hash_save_array_words(\%ignore_type, \@ignore);
hash_save_array_words(\%use_type, \@use);

302 303
my $dbg_values = 0;
my $dbg_possible = 0;
304
my $dbg_type = 0;
305
my $dbg_attr = 0;
306
for my $key (keys %debug) {
307 308 309
	## no critic
	eval "\${dbg_$key} = '$debug{$key}';";
	die "$@" if ($@);
310 311
}

312 313
my $rpt_cleaners = 0;

314 315 316 317 318
if ($terse) {
	$emacs = 1;
	$quiet++;
}

319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
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);
	}
337 338
}

339 340
my $emitted_corrupt = 0;

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

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

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

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

420
our $BasicType;
421
our $NonptrType;
422
our $NonptrTypeMisordered;
423
our $NonptrTypeWithAttr;
424
our $Type;
425
our $TypeMisordered;
426
our $Declare;
427
our $DeclareMisordered;
428

429 430
our $NON_ASCII_UTF8	= qr{
	[\xC2-\xDF][\x80-\xBF]               # non-overlong 2-byte
431 432 433 434 435 436 437 438
	|  \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;

439 440 441 442 443
our $UTF8	= qr{
	[\x09\x0A\x0D\x20-\x7E]              # ASCII
	| $NON_ASCII_UTF8
}x;

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

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

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

471 472 473 474 475 476 477 478 479 480
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
)};

481 482
our $signature_tags = qr{(?xi:
	Signed-off-by:|
483
	Co-developed-by:|
484 485 486 487
	Acked-by:|
	Tested-by:|
	Reviewed-by:|
	Reported-by:|
488
	Suggested-by:|
489 490 491 492
	To:|
	Cc:
)};

493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
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},
);

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

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

556
our @typeListFile = ();
557 558 559 560 561 562
our @typeListWithAttr = (
	@typeList,
	qr{struct\s+$InitAttribute\s+$Ident},
	qr{union\s+$InitAttribute\s+$Ident},
);

563 564 565
our @modifierList = (
	qr{fastcall},
);
566
our @modifierListFile = ();
567

568 569 570 571 572 573
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],
574 575 576 577 578
	["(?: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],
579 580
);

581 582 583 584 585 586
#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];
}
587
$mode_perms_search = "(?:${mode_perms_search})";
588

589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609
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})";

610 611 612 613 614 615 616 617
our $mode_perms_world_writable = qr{
	S_IWUGO		|
	S_IWOTH		|
	S_IRWXUGO	|
	S_IALLUGO	|
	0[0-7][0-7][2367]
}x;

618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
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;
}
643 644 645 646 647 648 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
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);
}
674

675 676
our $allowed_asm_includes = qr{(?x:
	irq|
677 678 679
	memory|
	time|
	reboot
680 681 682
)};
# memory.h: ARM has a custom one

683 684 685 686
# Load common spelling mistakes and build regular expression list.
my $misspellings;
my %spelling_fix;

687 688 689
if (open(my $spelling, '<', $spelling_file)) {
	while (<$spelling>) {
		my $line = $_;
690

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

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

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

699 700 701 702 703
		$spelling_fix{$suspect} = $fix;
	}
	close($spelling);
} else {
	warn "No typos will be found - file '$spelling_file': $!\n";
704 705
}

706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
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;

732 733
sub read_words {
	my ($wordsRef, $file) = @_;
734

735 736 737
	if (open(my $words, '<', $file)) {
		while (<$words>) {
			my $line = $_;
738

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

742 743 744 745 746 747 748 749 750 751 752 753
			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;
754
	}
755 756 757 758 759 760 761 762 763 764 765 766

	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";
767
}
768
$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne "");
769

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

820
our $Typecast	= qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
821 822 823 824 825 826

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

830
our $declaration_macros = qr{(?x:
831
	(?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
832
	(?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
833 834
	(?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(|
	(?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(
835 836
)};

837 838 839
sub deparenthesize {
	my ($string) = @_;
	return "" if (!defined($string));
840 841 842 843 844 845

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

846
	$string =~ s@\s+@ @g;
847

848 849 850
	return $string;
}

851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868
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;
869 870 871
		} 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*[;\{]/) {
872 873 874 875 876
			$camelcase{$1} = 1;
		}
	}
}

877 878 879
sub is_maintained_obsolete {
	my ($filename) = @_;

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

882
	my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
883 884 885 886

	return $status =~ /obsolete/i;
}

887 888 889
sub is_SPDX_License_valid {
	my ($license) = @_;

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

892 893
	my $root_path = abs_path($root);
	my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`;
894 895 896 897
	return 0 if ($status ne "");
	return 1;
}

898 899 900 901 902
my $camelcase_seeded = 0;
sub seed_camelcase_includes {
	return if ($camelcase_seeded);

	my $files;
903 904 905 906
	my $camelcase_cache = "";
	my @include_files = ();

	$camelcase_seeded = 1;
907

908
	if (-e ".git") {
909
		my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
910
		chomp $git_last_include_commit;
911
		$camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
912
	} else {
913
		my $last_mod_date = 0;
914
		$files = `find $root/include -name "*.h"`;
915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933
		@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;
934
	}
935

936
	if (-e ".git") {
937
		$files = `${git_command} ls-files "include/*.h"`;
938 939 940
		@include_files = split('\n', $files);
	}

941 942 943
	foreach my $file (@include_files) {
		seed_camelcase_file($file);
	}
944

945
	if ($camelcase_cache ne "") {
946
		unlink glob ".checkpatch-camelcase.*";
947 948
		open(my $camelcase_file, '>', "$camelcase_cache")
		    or warn "$P: Can't write '$camelcase_cache' $!\n";
949 950 951 952 953
		foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
			print $camelcase_file ("$_\n");
		}
		close($camelcase_file);
	}
954 955
}

956 957 958 959 960
sub git_commit_info {
	my ($commit, $id, $desc) = @_;

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

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

965 966
	return ($id, $desc) if ($#lines < 0);

967
	if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) {
968 969 970 971 972 973 974 975 976 977
# 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\./) {
978
		$id = undef;
979 980 981 982 983 984 985 986
	} else {
		$id = substr($lines[0], 0, 12);
		$desc = substr($lines[0], 41);
	}

	return ($id, $desc);
}

987 988
$chk_signoff = 0 if ($file);

989
my @rawlines = ();
990
my @lines = ();
991
my @fixed = ();
992 993
my @fixed_inserted = ();
my @fixed_deleted = ();
994 995
my $fixlinenr = -1;

996 997 998 999 1000 1001
# 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 = ();
1002
	foreach my $commit_expr (@ARGV) {
1003
		my $git_range;
1004 1005
		if ($commit_expr =~ m/^(.*)-(\d+)$/) {
			$git_range = "-$2 $1";
1006 1007 1008
		} elsif ($commit_expr =~ m/\.\./) {
			$git_range = "$commit_expr";
		} else {
1009 1010
			$git_range = "-1 $commit_expr";
		}
1011
		my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
1012
		foreach my $line (split(/\n/, $lines)) {
1013 1014
			$line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
			next if (!defined($1) || !defined($2));
1015 1016 1017 1018
			my $sha1 = $1;
			my $subject = $2;
			unshift(@commits, $sha1);
			$git_commits{$sha1} = $subject;
1019 1020 1021 1022 1023 1024
		}
	}
	die "$P: no git commits after extraction!\n" if (@commits == 0);
	@ARGV = @commits;
}

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

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

1060
	if (!process($filename)) {
1061 1062 1063
		$exit = 1;
	}
	@rawlines = ();
1064
	@lines = ();
1065
	@fixed = ();
1066 1067
	@fixed_inserted = ();
	@fixed_deleted = ();
1068
	$fixlinenr = -1;
1069 1070 1071
	@modifierListFile = ();
	@typeListFile = ();
	build_types();
1072 1073
}

1074
if (!$quiet) {
1075 1076 1077
	hash_show_words(\%use_type, "Used");
	hash_show_words(\%ignore_type, "Ignored");

1078
	if (!$perl_version_ok) {
1079 1080 1081
		print << "EOM"

NOTE: perl $^V is not modern enough to detect all possible issues.
1082
      An upgrade to at least perl $minimum_perl_version is suggested.
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
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
	}
}

1094 1095 1096
exit($exit);

sub top_of_kernel_tree {
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
	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;
		}
1109
	}
1110
	return 1;
1111
}
1112

1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129
sub parse_email {
	my ($formatted_email) = @_;

	my $name = "";
	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;
1130
		$formatted_email =~ s/\Q$address\E.*$//;
1131
		$name = $formatted_email;
1132
		$name = trim($name);
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146
		$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 = "";
		}
	}

1147
	$name = trim($name);
1148
	$name =~ s/^\"|\"$//g;
1149
	$address = trim($address);
1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164
	$address =~ s/^\<|\>$//g;

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

	return ($name, $address, $comment);
}

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

	my $formatted_email;

1165
	$name = trim($name);
1166
	$name =~ s/^\"|\"$//g;
1167
	$address = trim($address);
1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182

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

1183
sub which {
1184
	my ($bin) = @_;
1185

1186 1187 1188 1189
	foreach my $path (split(/:/, $ENV{PATH})) {
		if (-e "$path/$bin") {
			return "$path/$bin";
		}
1190 1191
	}

1192
	return "";
1193 1194
}

1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206
sub which_conf {
	my ($conf) = @_;

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

	return "";
}

1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226
sub expand_tabs {
	my ($str) = @_;

	my $res = '';
	my $n = 0;
	for my $c (split(//, $str)) {
		if ($c eq "\t") {
			$res .= ' ';
			$n++;
			for (; ($n % 8) != 0; $n++) {
				$res .= ' ';
			}
			next;
		}
		$res .= $c;
		$n++;
	}

	return $res;
}
1227
sub copy_spacing {
1228
	(my $res = shift) =~ tr/\t/ /c;
1229 1230
	return $res;
}
1231

1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244
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));
}

1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255
my $sanitise_quote = '';

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

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
1256 1257 1258 1259 1260 1261
sub sanitise_line {
	my ($line) = @_;

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

1262
	my $qlen = 0;
1263 1264
	my $off = 0;
	my $c;
1265

1266 1267 1268 1269 1270 1271
	# 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 已提交
1272
		# Comments we are whacking completely including the begin
1273 1274 1275 1276 1277 1278 1279
		# and end, all to $;.
		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
			$sanitise_quote = '*/';

			substr($res, $off, 2, "$;$;");
			$off++;
			next;
1280
		}
1281
		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
1282 1283 1284 1285
			$sanitise_quote = '';
			substr($res, $off, 2, "$;$;");
			$off++;
			next;
1286
		}
1287 1288 1289 1290 1291 1292 1293
		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
			$sanitise_quote = '//';

			substr($res, $off, 2, $sanitise_quote);
			$off++;
			next;
		}
1294 1295 1296 1297 1298 1299 1300

		# 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;
1301
		}
1302 1303 1304 1305
		# Regular quotes.
		if ($c eq "'" || $c eq '"') {
			if ($sanitise_quote eq '') {
				$sanitise_quote = $c;
1306

1307 1308 1309 1310 1311 1312
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
1313

1314
		#print "c<$c> SQ<$sanitise_quote>\n";
1315 1316
		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
			substr($res, $off, 1, $;);
1317 1318
		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
			substr($res, $off, 1, $;);
1319 1320 1321 1322 1323
		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
			substr($res, $off, 1, 'X');
		} else {
			substr($res, $off, 1, $c);
		}
1324 1325
	}

1326 1327 1328 1329
	if ($sanitise_quote eq '//') {
		$sanitise_quote = '';
	}

1330
	# The pathname on a #include may be surrounded by '<' and '>'.
1331
	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
1332 1333 1334 1335
		my $clean = 'X' x length($1);
		$res =~ s@\<.*\>@<$clean>@;

	# The whole of a #error is a string.
1336
	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
1337
		my $clean = 'X' x length($1);
1338
		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
1339 1340
	}

1341 1342 1343 1344 1345
	if ($allow_c99_comments && $res =~ m@(//.*$)@) {
		my $match = $1;
		$res =~ s/\Q$match\E/"$;" x length($match)/e;
	}

1346 1347 1348
	return $res;
}

1349 1350 1351
sub get_quoted_string {
	my ($line, $rawline) = @_;

1352
	return "" if (!defined($line) || !defined($rawline));
1353
	return "" if ($line !~ m/($String)/g);
1354 1355 1356
	return substr($rawline, $-[0], $+[0] - $-[0]);
}

1357 1358 1359 1360 1361 1362
sub ctx_statement_block {
	my ($linenr, $remain, $off) = @_;
	my $line = $linenr - 1;
	my $blk = '';
	my $soff = $off;
	my $coff = $off - 1;
1363
	my $coff_set = 0;
1364

1365 1366
	my $loff = 0;

1367 1368
	my $type = '';
	my $level = 0;
1369
	my @stack = ();
1370
	my $p;
1371 1372
	my $c;
	my $len = 0;
1373 1374

	my $remainder;
1375
	while (1) {
1376 1377
		@stack = (['', 0]) if ($#stack == -1);

1378
		#warn "CSB: blk<$blk> remain<$remain>\n";
1379 1380 1381 1382
		# If we are about to drop off the end, pull in more
		# context.
		if ($off >= $len) {
			for (; $remain > 0; $line++) {
1383
				last if (!defined $lines[$line]);
1384
				next if ($lines[$line] =~ /^-/);
1385
				$remain--;
1386
				$loff = $len;
1387
				$blk .= $lines[$line] . "\n";
1388 1389 1390 1391 1392 1393
				$len = length($blk);
				$line++;
				last;
			}
			# Bail if there is no further context.
			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
1394
			if ($off >= $len) {
1395 1396
				last;
			}
1397 1398 1399 1400
			if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
				$level++;
				$type = '#';
			}
1401
		}
1402
		$p = $c;
1403
		$c = substr($blk, $off, 1);
1404
		$remainder = substr($blk, $off);
1405

1406
		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1407 1408 1409 1410 1411 1412 1413 1414 1415 1416

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

1417 1418 1419 1420 1421 1422
		# Statement ends at the ';' or a close '}' at the
		# outermost level.
		if ($level == 0 && $c eq ';') {
			last;
		}

1423
		# An else is really a conditional as long as its not else if
1424 1425 1426 1427 1428 1429 1430 1431
		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";
1432 1433
		}

1434 1435 1436 1437 1438 1439 1440 1441 1442 1443
		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;
1444 1445
				$coff_set = 1;
				#warn "CSB: mark coff<$coff>\n";
1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456
			}
		}
		if (($type eq '' || $type eq '{') && $c eq '{') {
			$level++;
			$type = '{';
		}
		if ($type eq '{' && $c eq '}') {
			$level--;
			$type = ($level != 0)? '{' : '';

			if ($level == 0) {
1457 1458 1459
				if (substr($blk, $off + 1, 1) eq ';') {
					$off++;
				}
1460 1461 1462
				last;
			}
		}
1463 1464 1465 1466 1467 1468 1469
		# Preprocessor commands end at the newline unless escaped.
		if ($type eq '#' && $c eq "\n" && $p ne "\\") {
			$level--;
			$type = '';
			$off++;
			last;
		}
1470 1471
		$off++;
	}
1472
	# We are truly at the end, so shuffle to the next line.
1473
	if ($off == $len) {
1474
		$loff = $len + 1;
1475 1476 1477
		$line++;
		$remain--;
	}
1478 1479 1480 1481 1482 1483 1484

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

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

1485
	#print "coff<$coff> soff<$off> loff<$loff>\n";
1486 1487 1488 1489 1490

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

1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533
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;
	}
}

1534 1535 1536 1537 1538 1539
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

1540
	# Grab the first conditional/block pair.
1541 1542
	($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
1543
	#print "F: c<$condition> s<$statement> remain<$remain>\n";
1544 1545 1546 1547 1548 1549 1550
	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.
1551 1552 1553
	for (;;) {
		($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
1554
		#print "C: c<$condition> s<$statement> remain<$remain>\n";
1555
		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1556 1557
		#print "C: push\n";
		push(@chunks, [ $condition, $statement ]);
1558 1559 1560
	}

	return ($level, $linenr, @chunks);
1561 1562
}

1563
sub ctx_block_get {
1564
	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1565 1566 1567 1568 1569 1570 1571
	my $line;
	my $start = $linenr - 1;
	my $blk = '';
	my @o;
	my @c;
	my @res = ();

1572
	my $level = 0;
1573
	my @stack = ($level);
1574 1575 1576 1577 1578
	for ($line = $start; $remain > 0; $line++) {
		next if ($rawlines[$line] =~ /^-/);
		$remain--;

		$blk .= $rawlines[$line];
1579 1580

		# Handle nested #if/#else.
1581
		if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1582
			push(@stack, $level);
1583
		} elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1584
			$level = $stack[$#stack - 1];
1585
		} elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1586 1587 1588
			$level = pop(@stack);
		}

1589
		foreach my $c (split(//, $lines[$line])) {
1590 1591 1592 1593 1594
			##print "C<$c>L<$level><$open$close>O<$off>\n";
			if ($off > 0) {
				$off--;
				next;
			}
1595

1596 1597 1598 1599 1600 1601 1602
			if ($c eq $close && $level > 0) {
				$level--;
				last if ($level == 0);
			} elsif ($c eq $open) {
				$level++;
			}
		}
1603

1604
		if (!$outer || $level <= 1) {
1605
			push(@res, $rawlines[$line]);
1606 1607
		}

1608
		last if ($level == 0);
1609 1610
	}

1611
	return ($level, @res);
1612 1613 1614 1615
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

1616 1617
	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
	return @r;
1618 1619 1620 1621
}
sub ctx_block {
	my ($linenr, $remain) = @_;

1622 1623
	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
	return @r;
1624 1625
}
sub ctx_statement {
1626 1627 1628 1629 1630 1631
	my ($linenr, $remain, $off) = @_;

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

1634
	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1635
}
1636 1637 1638 1639 1640
sub ctx_statement_level {
	my ($linenr, $remain, $off) = @_;

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
1641 1642 1643 1644 1645

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

	# Catch a comment on the end of the line itself.
1646
	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1647 1648 1649 1650 1651 1652 1653
	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++) {
1654 1655
		my $line = $rawlines[$linenr - 1];
		#warn "           $line\n";
1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677
		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);

1678
	##print "LINE: $rawlines[$end_line - 1 ]\n";
1679 1680 1681 1682 1683
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699
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;
}

1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710
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;
}

1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721
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;
}

1722 1723 1724
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
1725

1726 1727 1728 1729 1730 1731
	$res = '';
	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
		$res .= $1;
		if ($2 ne '') {
			$coded = sprintf("^%c", unpack('C', $2) + 64);
			$res .= $coded;
1732 1733
		}
	}
1734
	$res =~ s/$/\$/;
1735

1736
	return $res;
1737 1738
}

1739
my $av_preprocessor = 0;
1740
my $av_pending;
1741
my @av_paren_type;
1742
my $av_pend_colon;
1743 1744 1745

sub annotate_reset {
	$av_preprocessor = 0;
1746 1747
	$av_pending = '_';
	@av_paren_type = ('E');
1748
	$av_pend_colon = 'O';
1749 1750
}

1751 1752
sub annotate_values {
	my ($stream, $type) = @_;
1753

1754
	my $res;
1755
	my $var = '_' x length($stream);
1756 1757
	my $cur = $stream;

1758
	print "$stream\n" if ($dbg_values > 1);
1759 1760

	while (length($cur)) {
1761
		@av_paren_type = ('E') if ($#av_paren_type < 0);
1762
		print " <" . join('', @av_paren_type) .
1763
				"> <$type> <$av_pending>" if ($dbg_values > 1);
1764
		if ($cur =~ /^(\s+)/o) {
1765 1766
			print "WS($1)\n" if ($dbg_values > 1);
			if ($1 =~ /\n/ && $av_preprocessor) {
1767
				$type = pop(@av_paren_type);
1768
				$av_preprocessor = 0;
1769 1770
			}

1771
		} elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1772 1773
			print "CAST($1)\n" if ($dbg_values > 1);
			push(@av_paren_type, $type);
1774
			$type = 'c';
1775

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

1780 1781 1782 1783
		} elsif ($cur =~ /^($Modifier)\s*/) {
			print "MODIFIER($1)\n" if ($dbg_values > 1);
			$type = 'T';

1784
		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1785
			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1786
			$av_preprocessor = 1;
1787 1788 1789 1790 1791 1792
			push(@av_paren_type, $type);
			if ($2 ne '') {
				$av_pending = 'N';
			}
			$type = 'E';

1793
		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1794 1795 1796
			print "UNDEF($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;
			push(@av_paren_type, $type);
1797

1798
		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1799
			print "PRE_START($1)\n" if ($dbg_values > 1);
1800
			$av_preprocessor = 1;
1801 1802 1803

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
1804
			$type = 'E';
1805

1806
		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1807 1808 1809 1810 1811
			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;

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

1812
			$type = 'E';
1813

1814
		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1815 1816 1817 1818 1819 1820 1821 1822
			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);
1823
			$type = 'E';
1824 1825

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

1828 1829 1830 1831 1832
		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
			print "ATTR($1)\n" if ($dbg_values > 1);
			$av_pending = $type;
			$type = 'N';

1833
		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1834
			print "SIZEOF($1)\n" if ($dbg_values > 1);
1835
			if (defined $2) {
1836
				$av_pending = 'V';
1837 1838 1839
			}
			$type = 'N';

1840
		} elsif ($cur =~ /^(if|while|for)\b/o) {
1841
			print "COND($1)\n" if ($dbg_values > 1);
1842
			$av_pending = 'E';
1843 1844
			$type = 'N';

1845 1846 1847 1848 1849
		} elsif ($cur =~/^(case)/o) {
			print "CASE($1)\n" if ($dbg_values > 1);
			$av_pend_colon = 'C';
			$type = 'N';

1850
		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1851
			print "KEYWORD($1)\n" if ($dbg_values > 1);
1852 1853 1854
			$type = 'N';

		} elsif ($cur =~ /^(\()/o) {
1855
			print "PAREN('$1')\n" if ($dbg_values > 1);
1856 1857
			push(@av_paren_type, $av_pending);
			$av_pending = '_';
1858 1859 1860
			$type = 'N';

		} elsif ($cur =~ /^(\))/o) {
1861 1862 1863
			my $new_type = pop(@av_paren_type);
			if ($new_type ne '_') {
				$type = $new_type;
1864 1865
				print "PAREN('$1') -> $type\n"
							if ($dbg_values > 1);
1866
			} else {
1867
				print "PAREN('$1')\n" if ($dbg_values > 1);
1868 1869
			}

1870
		} elsif ($cur =~ /^($Ident)\s*\(/o) {
1871
			print "FUNC($1)\n" if ($dbg_values > 1);
1872
			$type = 'V';
1873
			$av_pending = 'V';
1874

1875 1876
		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
			if (defined $2 && $type eq 'C' || $type eq 'T') {
1877
				$av_pend_colon = 'B';
1878 1879
			} elsif ($type eq 'E') {
				$av_pend_colon = 'L';
1880 1881 1882 1883
			}
			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
			$type = 'V';

1884
		} elsif ($cur =~ /^($Ident|$Constant)/o) {
1885
			print "IDENT($1)\n" if ($dbg_values > 1);
1886 1887 1888
			$type = 'V';

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

1892
		} elsif ($cur =~/^(;|{|})/) {
1893
			print "END($1)\n" if ($dbg_values > 1);
1894
			$type = 'E';
1895 1896
			$av_pend_colon = 'O';

1897 1898 1899 1900
		} elsif ($cur =~/^(,)/) {
			print "COMMA($1)\n" if ($dbg_values > 1);
			$type = 'C';

1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914
		} 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';
1915

1916
		} elsif ($cur =~ /^(\[)/o) {
1917
			print "CLOSE($1)\n" if ($dbg_values > 1);
1918 1919
			$type = 'N';

1920
		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932
			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';

1933
		} elsif ($cur =~ /^($Operators)/o) {
1934
			print "OP($1)\n" if ($dbg_values > 1);
1935 1936 1937 1938 1939
			if ($1 ne '++' && $1 ne '--') {
				$type = 'N';
			}

		} elsif ($cur =~ /(^.)/o) {
1940
			print "C($1)\n" if ($dbg_values > 1);
1941 1942 1943 1944 1945
		}
		if (defined $1) {
			$cur = substr($cur, length($1));
			$res .= $type x length($1);
		}
1946
	}
1947

1948
	return ($res, $var);
1949 1950
}

1951
sub possible {
1952
	my ($possible, $line) = @_;
1953
	my $notPermitted = qr{(?:
1954 1955 1956 1957
		^(?:
			$Modifier|
			$Storage|
			$Type|
1958 1959 1960
			DEFINE_\S+
		)$|
		^(?:
1961 1962 1963 1964 1965
			goto|
			return|
			case|
			else|
			asm|__asm__|
1966 1967 1968
			do|
			\#|
			\#\#|
1969
		)(?:\s|$)|
1970
		^(?:typedef|struct|enum)\b
1971 1972 1973
	    )}x;
	warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
	if ($possible !~ $notPermitted) {
1974 1975 1976 1977 1978 1979 1980
		# 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;
1981
			for my $modifier (split(' ', $possible)) {
1982 1983
				if ($modifier !~ $notPermitted) {
					warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1984
					push(@modifierListFile, $modifier);
1985
				}
1986
			}
1987 1988 1989

		} else {
			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1990
			push(@typeListFile, $possible);
1991
		}
1992
		build_types();
1993 1994
	} else {
		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1995 1996 1997
	}
}

1998 1999
my $prefix = '';

2000
sub show_type {
2001
	my ($type) = @_;
2002

2003 2004
	$type =~ tr/[a-z]/[A-Z]/;

2005 2006 2007
	return defined $use_type{$type} if (scalar keys %use_type > 0);

	return !defined $ignore_type{$type};
2008 2009
}

2010
sub report {
2011 2012 2013 2014
	my ($level, $type, $msg) = @_;

	if (!show_type($type) ||
	    (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
2015 2016
		return 0;
	}
2017
	my $output = '';
2018
	if ($color) {
2019 2020 2021 2022 2023 2024 2025 2026 2027
		if ($level eq 'ERROR') {
			$output .= RED;
		} elsif ($level eq 'WARNING') {
			$output .= YELLOW;
		} else {
			$output .= GREEN;
		}
	}
	$output .= $prefix . $level . ':';
2028
	if ($show_types) {
2029
		$output .= BLUE if ($color);
2030
		$output .= "$type:";
2031
	}
2032
	$output .= RESET if ($color);
2033
	$output .= ' ' . $msg . "\n";
2034 2035 2036 2037 2038 2039

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

2042
	push(our @report, $output);
2043 2044

	return 1;
2045
}
2046

2047
sub report_dump {
2048
	our @report;
2049
}
2050

2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082
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
2083
		if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) {	#new filename
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
			$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;
}

2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134
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);
}

2135
sub ERROR {
2136 2137 2138
	my ($type, $msg) = @_;

	if (report("ERROR", $type, $msg)) {
2139 2140
		our $clean = 0;
		our $cnt_error++;
2141
		return 1;
2142
	}
2143
	return 0;
2144 2145
}
sub WARN {
2146 2147 2148
	my ($type, $msg) = @_;

	if (report("WARNING", $type, $msg)) {
2149 2150
		our $clean = 0;
		our $cnt_warn++;
2151
		return 1;
2152
	}
2153
	return 0;
2154 2155
}
sub CHK {
2156 2157 2158
	my ($type, $msg) = @_;

	if ($check && report("CHECK", $type, $msg)) {
2159 2160
		our $clean = 0;
		our $cnt_chk++;
2161
		return 1;
2162
	}
2163
	return 0;
2164 2165
}

2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188
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 ".../") {
2189 2190
		WARN("USE_RELATIVE_PATH",
		     "use relative pathname instead of absolute in changelog text\n" . $herecurr);
2191 2192 2193
	}
}

2194 2195 2196
sub trim {
	my ($string) = @_;

2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213
	$string =~ s/^\s+|\s+$//g;

	return $string;
}

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

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

	return $string;
}

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

	$string =~ s/\s+$//;
2214 2215 2216 2217

	return $string;
}

2218 2219 2220 2221 2222 2223 2224 2225
sub string_find_replace {
	my ($string, $find, $replace) = @_;

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

	return $string;
}

2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240
sub tabify {
	my ($leading) = @_;

	my $source_indent = 8;
	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";
}

2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267
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;
		}
	}

2268
	return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
2269 2270
}

2271 2272 2273 2274 2275
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
2276
	my $prevrawline="";
2277
	my $stashline="";
2278
	my $stashrawline="";
2279

2280
	my $length;
2281 2282 2283 2284
	my $indent;
	my $previndent=0;
	my $stashindent=0;

2285
	our $clean = 1;
2286
	my $signoff = 0;
2287 2288
	my $author = '';
	my $authorsignoff = 0;
2289
	my $is_patch = 0;
2290
	my $is_binding_patch = -1;
2291
	my $in_header_lines = $file ? 0 : 1;
2292
	my $in_commit_log = 0;		#Scanning lines before patch
2293
	my $has_commit_log = 0;		#Encountered lines before patch
2294
	my $commit_log_lines = 0;	#Number of commit log lines
2295
	my $commit_log_possible_stack_dump = 0;
2296
	my $commit_log_long_line = 0;
2297
	my $commit_log_has_diff = 0;
2298
	my $reported_maintainer_file = 0;
2299 2300
	my $non_utf8_charset = 0;

2301
	my $last_blank_line = 0;
2302
	my $last_coalesced_string_linenr = -1;
2303

2304
	our @report = ();
2305 2306 2307 2308 2309
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

2310 2311 2312 2313 2314
	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
2315
	my $context_function;		#undef'd unless there's a known function
2316
	my $in_comment = 0;
2317
	my $comment_edge = 0;
2318
	my $first_line = 0;
2319
	my $p1_prefix = '';
2320

2321 2322 2323
	my $prev_values = 'E';

	# suppression flags
2324
	my %suppress_ifbraces;
2325
	my %suppress_whiletrailers;
2326
	my %suppress_export;
2327
	my $suppress_statement = 0;
2328

2329
	my %signatures = ();
2330

2331
	# Pre-scan the patch sanitizing the lines.
2332
	# Pre-scan the patch looking for any __setup documentation.
2333
	#
2334 2335
	my @setup_docs = ();
	my $setup_docs = 0;
2336

2337 2338
	my $camelcase_file_seeded = 0;

2339 2340
	my $checklicenseline = 1;

2341
	sanitise_line_reset();
2342 2343
	my $line;
	foreach my $rawline (@rawlines) {
2344 2345
		$linenr++;
		$line = $rawline;
2346

2347 2348
		push(@fixed, $rawline) if ($fix);

2349
		if ($rawline=~/^\+\+\+\s+(\S+)/) {
2350
			$setup_docs = 0;
2351
			if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
2352 2353
				$setup_docs = 1;
			}
2354 2355
			#next;
		}
2356
		if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2357 2358 2359 2360 2361 2362
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
2363
			$in_comment = 0;
2364 2365 2366 2367 2368 2369

			# 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;
2370 2371 2372 2373 2374 2375
			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";
2376
				last if (!defined $rawlines[$ln - 1]);
2377 2378 2379 2380 2381
				if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
				    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
					($edge) = $1;
					last;
				}
2382 2383 2384 2385 2386 2387 2388 2389 2390
			}
			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 &&
2391
			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
2392 2393 2394 2395 2396 2397 2398
			{
				$in_comment = 1;
			}

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

2399
		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2400
			# Standardise the strings and chars within the input to
2401
			# simplify matching -- only bother with positive lines.
2402
			$line = sanitise_line($rawline);
2403
		}
2404 2405 2406 2407 2408 2409 2410 2411 2412 2413
		push(@lines, $line);

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

		#print "==>$rawline\n";
		#print "-->$line\n";
2414 2415 2416 2417 2418 2419

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

2420 2421
	$prefix = '';

2422 2423
	$realcnt = 0;
	$linenr = 0;
2424
	$fixlinenr = -1;
2425 2426
	foreach my $line (@lines) {
		$linenr++;
2427
		$fixlinenr++;
2428 2429
		my $sline = $line;	#copy of $line
		$sline =~ s/$;/ /g;	#with comments as spaces
2430

2431
		my $rawline = $rawlines[$linenr - 1];
2432

2433 2434 2435 2436 2437 2438 2439 2440
# 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;
		}

2441
#extract the line range in the file after the patch is applied
2442
		if (!$in_commit_log &&
2443 2444
		    $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
			my $context = $4;
2445
			$is_patch = 1;
2446
			$first_line = $linenr + 1;
2447 2448 2449 2450 2451 2452
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
2453
			annotate_reset();
2454 2455
			$prev_values = 'E';

2456
			%suppress_ifbraces = ();
2457
			%suppress_whiletrailers = ();
2458
			%suppress_export = ();
2459
			$suppress_statement = 0;
2460 2461 2462 2463 2464
			if ($context =~ /\b(\w+)\s*\(/) {
				$context_function = $1;
			} else {
				undef $context_function;
			}
2465 2466
			next;

2467 2468 2469
# 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.
2470
		} elsif ($line =~ /^( |\+|$)/) {
2471
			$realline++;
2472
			$realcnt-- if ($realcnt != 0);
2473

2474
			# Measure the line length and indent.
2475
			($length, $indent) = line_stats($rawline);
2476 2477 2478 2479

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

2482
			#warn "line<$line>\n";
2483

2484 2485
		} elsif ($realcnt == 1) {
			$realcnt--;
2486 2487
		}

2488 2489
		my $hunk_line = ($realcnt != 0);

2490 2491
		$here = "#$linenr: " if (!$file);
		$here = "#$realline: " if ($file);
2492

2493
		my $found_file = 0;
2494
		# extract the filename as it passes
2495 2496
		if ($line =~ /^diff --git.*?(\S+)$/) {
			$realfile = $1;
2497
			$realfile =~ s@^([^/]*)/@@ if (!$file);
2498
			$in_commit_log = 0;
2499
			$found_file = 1;
2500
		} elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2501
			$realfile = $1;
2502
			$realfile =~ s@^([^/]*)/@@ if (!$file);
2503
			$in_commit_log = 0;
2504 2505

			$p1_prefix = $1;
2506 2507
			if (!$file && $tree && $p1_prefix ne '' &&
			    -e "$root/$p1_prefix") {
2508 2509
				WARN("PATCH_PREFIX",
				     "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2510
			}
2511

2512
			if ($realfile =~ m@^include/asm/@) {
2513 2514
				ERROR("MODIFIED_INCLUDE_ASM",
				      "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2515
			}
2516 2517 2518
			$found_file = 1;
		}

2519 2520 2521 2522
#make up the handle for any error we report on this line
		if ($showfile) {
			$prefix = "$realfile:$realline: "
		} elsif ($emacs) {
2523 2524 2525 2526 2527
			if ($file) {
				$prefix = "$filename:$realline: ";
			} else {
				$prefix = "$filename:$linenr: ";
			}
2528 2529
		}

2530
		if ($found_file) {
2531 2532 2533 2534
			if (is_maintained_obsolete($realfile)) {
				WARN("OBSOLETE",
				     "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy.  No unnecessary modifications please.\n");
			}
2535
			if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
2536 2537 2538 2539
				$check = 1;
			} else {
				$check = $check_orig;
			}
2540
			$checklicenseline = 1;
2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553

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

2554 2555 2556
			next;
		}

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

2559 2560 2561
		my $hereline = "$here\n$rawline\n";
		my $herecurr = "$here\n$rawline\n";
		my $hereprev = "$here\n$prevrawline\n$rawline\n";
2562

2563 2564
		$cnt_lines++ if ($realcnt != 0);

2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576
# 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
		}

2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587
# 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;
		}

2588 2589 2590
# Check for incorrect file permissions
		if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
			my $permhere = $here . "FILE: $realfile\n";
2591 2592
			if ($realfile !~ m@scripts/@ &&
			    $realfile !~ /\.(py|pl|awk|sh)$/) {
2593 2594
				ERROR("EXECUTE_PERMISSIONS",
				      "do not set execute permissions for source files\n" . $permhere);
2595 2596 2597
			}
		}

2598 2599 2600 2601 2602 2603 2604
# 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;
		}

2605
# Check the patch for a signoff:
2606
		if ($line =~ /^\s*signed-off-by:/i) {
2607
			$signoff++;
2608
			$in_commit_log = 0;
2609 2610 2611 2612 2613 2614 2615
			if ($author ne '') {
				my $l = $line;
				$l =~ s/"//g;
				if ($l =~ /^\s*signed-off-by:\s*\Q$author\E/i) {
				    $authorsignoff = 1;
				}
			}
2616 2617
		}

2618 2619 2620 2621 2622 2623
# 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;
		}

2624
# Check signature styles
2625
		if (!$in_header_lines &&
2626
		    $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2627 2628 2629 2630 2631 2632
			my $space_before = $1;
			my $sign_off = $2;
			my $space_after = $3;
			my $email = $4;
			my $ucfirst_sign_off = ucfirst(lc($sign_off));

2633 2634 2635 2636
			if ($sign_off !~ /$signature_tags/) {
				WARN("BAD_SIGN_OFF",
				     "Non-standard signature: $sign_off\n" . $herecurr);
			}
2637
			if (defined $space_before && $space_before ne "") {
2638 2639 2640
				if (WARN("BAD_SIGN_OFF",
					 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
				    $fix) {
2641
					$fixed[$fixlinenr] =
2642 2643
					    "$ucfirst_sign_off $email";
				}
2644 2645
			}
			if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2646 2647 2648
				if (WARN("BAD_SIGN_OFF",
					 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
				    $fix) {
2649
					$fixed[$fixlinenr] =
2650 2651 2652
					    "$ucfirst_sign_off $email";
				}

2653 2654
			}
			if (!defined $space_after || $space_after ne " ") {
2655 2656 2657
				if (WARN("BAD_SIGN_OFF",
					 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
				    $fix) {
2658
					$fixed[$fixlinenr] =
2659 2660
					    "$ucfirst_sign_off $email";
				}
2661
			}
2662 2663 2664 2665

			my ($email_name, $email_address, $comment) = parse_email($email);
			my $suggested_email = format_email(($email_name, $email_address));
			if ($suggested_email eq "") {
2666 2667
				ERROR("BAD_SIGN_OFF",
				      "Unrecognized email address: '$email'\n" . $herecurr);
2668 2669 2670 2671 2672 2673 2674 2675 2676
			} else {
				my $dequoted = $suggested_email;
				$dequoted =~ s/^"//;
				$dequoted =~ s/" </ </;
				# Don't force email to have quotes
				# Allow just an angle bracketed address
				if ("$dequoted$comment" ne $email &&
				    "<$email_address>$comment" ne $email &&
				    "$suggested_email$comment" ne $email) {
2677 2678
					WARN("BAD_SIGN_OFF",
					     "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2679
				}
2680
			}
2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691

# 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;
			}
2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709

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

2712 2713 2714 2715 2716 2717 2718
# 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);
		}

2719 2720 2721 2722 2723 2724
# Check for unwanted Gerrit info
		if ($in_commit_log && $line =~ /^\s*change-id:/i) {
			ERROR("GERRIT_CHANGE_ID",
			      "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
		}

2725 2726 2727 2728 2729
# 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
2730 2731 2732 2733
		     $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
2734 2735 2736
			$commit_log_possible_stack_dump = 1;
		}

2737 2738
# Check for line lengths > 75 in commit log, warn once
		if ($in_commit_log && !$commit_log_long_line &&
2739 2740 2741 2742 2743 2744 2745 2746
		    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)) {
2747 2748 2749 2750 2751
			WARN("COMMIT_LOG_LONG_LINE",
			     "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
			$commit_log_long_line = 1;
		}

2752
# Reset possible stack dump if a blank line is found
2753 2754 2755 2756
		if ($in_commit_log && $commit_log_possible_stack_dump &&
		    $line =~ /^\s*$/) {
			$commit_log_possible_stack_dump = 0;
		}
2757

2758
# Check for git id commit length and improperly formed commit descriptions
2759
		if ($in_commit_log && !$commit_log_possible_stack_dump &&
2760
		    $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
2761
		    $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
2762
		    ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
2763
		     ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
2764 2765
		      $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
		      $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
2766 2767
			my $init_char = "c";
			my $orig_commit = "";
2768 2769 2770 2771 2772
			my $short = 1;
			my $long = 0;
			my $case = 1;
			my $space = 1;
			my $hasdesc = 0;
2773
			my $hasparens = 0;
2774 2775 2776 2777
			my $id = '0123456789ab';
			my $orig_desc = "commit description";
			my $description = "";

2778 2779 2780 2781 2782 2783 2784
			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);
			}

2785 2786 2787 2788 2789 2790
			$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;
2791
				$hasparens = 1;
2792 2793 2794 2795
			} elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
				 defined $rawlines[$linenr] &&
				 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
				$orig_desc = $1;
2796
				$hasparens = 1;
2797 2798 2799 2800 2801 2802 2803
			} 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;
2804
				$hasparens = 1;
2805 2806 2807 2808 2809
			}

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

2810 2811
			if (defined($id) &&
			   ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
2812 2813 2814
				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);
			}
2815 2816
		}

2817 2818 2819 2820 2821 2822
# 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))))) {
2823
			$is_patch = 1;
2824 2825 2826 2827 2828
			$reported_maintainer_file = 1;
			WARN("FILE_PATH_CHANGES",
			     "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
		}

2829 2830 2831 2832 2833 2834 2835 2836
# 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");
		}

2837
# Check for wrappage within a valid hunk of the file
2838
		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2839 2840
			ERROR("CORRUPTED_PATCH",
			      "patch seems to be corrupt (line wrapped?)\n" .
2841
				$herecurr) if (!$emitted_corrupt++);
2842 2843 2844 2845
		}

# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2846 2847 2848 2849 2850 2851 2852
		    $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";

2853 2854
			CHK("INVALID_UTF8",
			    "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2855 2856
		}

2857 2858 2859
# 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 =~ /^$/ &&
2860 2861
		    !($rawline =~ /^\s+(?:\S|$)/ ||
		      $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
2862 2863
			$in_header_lines = 0;
			$in_commit_log = 1;
2864
			$has_commit_log = 1;
2865 2866
		}

2867 2868 2869 2870 2871 2872 2873 2874 2875
# 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 =~ /^$/ &&
2876
		    $rawline =~ /$NON_ASCII_UTF8/) {
2877
			WARN("UTF8_BEFORE_PATCH",
2878 2879 2880
			    "8-bit UTF-8 used in possible commit log\n" . $herecurr);
		}

2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894
# 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);
				}
			}
		}

2895
# Check for various typo / spelling mistakes
2896 2897
		if (defined($misspellings) &&
		    ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
2898
			while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
2899 2900 2901 2902
				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]+$/);
2903 2904 2905 2906
				my $msg_level = \&WARN;
				$msg_level = \&CHK if ($file);
				if (&{$msg_level}("TYPO_SPELLING",
						  "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2907 2908 2909 2910 2911 2912
				    $fix) {
					$fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
				}
			}
		}

2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923
# 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);
			}
		}

2924 2925
# ignore non-hunk lines and lines being removed
		next if (!$hunk_line || $line =~ /^-/);
2926 2927

#trailing whitespace
2928
		if ($line =~ /^\+.*\015/) {
2929
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2930 2931 2932
			if (ERROR("DOS_LINE_ENDINGS",
				  "DOS line endings\n" . $herevet) &&
			    $fix) {
2933
				$fixed[$fixlinenr] =~ s/[\s\015]+$//;
2934
			}
2935 2936
		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2937 2938 2939
			if (ERROR("TRAILING_WHITESPACE",
				  "trailing whitespace\n" . $herevet) &&
			    $fix) {
2940
				$fixed[$fixlinenr] =~ s/\s+$//;
2941 2942
			}

2943
			$rpt_cleaners = 1;
2944
		}
2945

2946
# Check for FSF mailing addresses.
2947
		if ($rawline =~ /\bwrite to the Free/i ||
2948
		    $rawline =~ /\b675\s+Mass\s+Ave/i ||
2949 2950
		    $rawline =~ /\b59\s+Temple\s+Pl/i ||
		    $rawline =~ /\b51\s+Franklin\s+St/i) {
2951
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2952 2953 2954 2955
			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)
2956 2957
		}

2958
# check for Kconfig help text having a real description
2959 2960
# Only applies when adding the entry originally, after that we do not have
# sufficient context to determine whether it is indeed long enough.
2961
		if ($realfile =~ /Kconfig/ &&
2962 2963 2964 2965
		    # '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/) {
2966
			my $length = 0;
2967 2968 2969
			my $cnt = $realcnt;
			my $ln = $linenr + 1;
			my $f;
2970
			my $is_start = 0;
2971
			my $is_end = 0;
2972
			for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2973 2974 2975 2976 2977
				$f = $lines[$ln - 1];
				$cnt-- if ($lines[$ln - 1] !~ /^-/);
				$is_end = $lines[$ln - 1] =~ /^\+/;

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

2980
				if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
2981
					$is_start = 1;
2982 2983 2984 2985 2986
				} 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);
					}
2987 2988 2989
					$length = -1;
				}

2990
				$f =~ s/^.//;
2991 2992 2993
				$f =~ s/#.*//;
				$f =~ s/^\s+//;
				next if ($f =~ /^$/);
2994 2995 2996 2997 2998 2999 3000

				# 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) {
3001 3002 3003
					$is_end = 1;
					last;
				}
3004 3005
				$length++;
			}
3006 3007 3008 3009
			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);
			}
3010
			#print "is_start<$is_start> is_end<$is_end> length<$length>\n";
3011 3012
		}

3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023
# 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/;
			}
		}

3024 3025 3026 3027 3028 3029 3030
# 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);
		}

3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044
		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});
		}

3045
# check for DT compatible documentation
3046 3047 3048 3049
		if (defined $root &&
			(($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
			 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {

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

3052
			my $dt_path = $root . "/Documentation/devicetree/bindings/";
3053
			my $vp_file = $dt_path . "vendor-prefixes.yaml";
3054

3055 3056
			foreach my $compat (@compats) {
				my $compat2 = $compat;
3057 3058 3059 3060
				$compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
				my $compat3 = $compat;
				$compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
				`grep -Erq "$compat|$compat2|$compat3" $dt_path`;
3061 3062 3063 3064 3065
				if ( $? >> 8 ) {
					WARN("UNDOCUMENTED_DT_STRING",
					     "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
				}

3066 3067
				next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
				my $vendor = $1;
3068
				`grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`;
3069 3070
				if ( $? >> 8 ) {
					WARN("UNDOCUMENTED_DT_STRING",
3071
					     "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
3072 3073 3074 3075
				}
			}
		}

3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091
# 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 = '//';
				} elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) {
					$comment = '#';
				} elsif ($realfile =~ /\.rst$/) {
					$comment = '..';
				}

3092 3093 3094
# check SPDX comment style for .[chsS] files
				if ($realfile =~ /\.[chsS]$/ &&
				    $rawline =~ /SPDX-License-Identifier:/ &&
3095
				    $rawline !~ m@^\+\s*\Q$comment\E\s*@) {
3096 3097 3098 3099
					WARN("SPDX_LICENSE_TAG",
					     "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr);
				}

3100
				if ($comment !~ /^$/ &&
3101 3102 3103
				    $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) {
					WARN("SPDX_LICENSE_TAG",
					     "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
3104
				} elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) {
3105 3106 3107 3108 3109
					my $spdx_license = $1;
					if (!is_SPDX_License_valid($spdx_license)) {
						WARN("SPDX_LICENSE_TAG",
						     "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr);
					}
3110 3111 3112 3113
				}
			}
		}

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

3117 3118 3119 3120 3121 3122 3123 3124
# 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);
		}

3125 3126 3127 3128 3129 3130
# 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
3131
#	lines with an RFC3986 like URL
3132 3133
#
# There are 3 different line length message types:
J
Jean Delvare 已提交
3134
# LONG_LINE_COMMENT	a comment starts before but extends beyond $max_line_length
3135 3136 3137 3138 3139 3140
# 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
#

3141
		if ($line =~ /^\+/ && $length > $max_line_length) {
3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157
			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 = "";

3158 3159 3160
			# More special cases
			} elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
				 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
3161 3162
				$msg_type = "";

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

3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184
			# 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);
			}
3185 3186
		}

3187 3188
# check for adding lines without a newline.
		if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3189 3190
			WARN("MISSING_EOF_NEWLINE",
			     "adding a line without newline at end of file\n" . $herecurr);
3191 3192
		}

3193
# check we are in a valid source file C or perl if not then ignore this hunk
3194
		next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
3195 3196 3197

# at the beginning of a line any tabs must come first and anything
# more than 8 must use tabs.
3198 3199 3200
		if ($rawline =~ /^\+\s* \t\s*\S/ ||
		    $rawline =~ /^\+\s*        \s*/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3201
			$rpt_cleaners = 1;
3202 3203 3204
			if (ERROR("CODE_INDENT",
				  "code indent should use tabs where possible\n" . $herevet) &&
			    $fix) {
3205
				$fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3206
			}
3207 3208
		}

3209 3210 3211
# check for space before tabs.
		if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3212 3213 3214
			if (WARN("SPACE_BEFORE_TAB",
				"please, no space before tabs\n" . $herevet) &&
			    $fix) {
3215
				while ($fixed[$fixlinenr] =~
3216
					   s/(^\+.*) {8,8}\t/$1\t\t/) {}
3217
				while ($fixed[$fixlinenr] =~
3218
					   s/(^\+.*) +\t/$1\t/) {}
3219
			}
3220
		}
3221 3222 3223 3224 3225 3226

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

3228 3229 3230 3231 3232 3233
# 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);
		}

3234
# check indentation starts on a tab stop
3235
		if ($perl_version_ok &&
3236
		    $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3237 3238 3239 3240 3241 3242 3243 3244 3245 3246
			my $indent = length($1);
			if ($indent % 8) {
				if (WARN("TABSTOP",
					 "Statements should start on a tabstop\n" . $herecurr) &&
				    $fix) {
					$fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
				}
			}
		}

3247
# check multi-line statement indentation matches previous line
3248
		if ($perl_version_ok &&
3249
		    $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3250 3251 3252 3253 3254 3255
			$prevline =~ /^\+(\t*)(.*)$/;
			my $oldindent = $1;
			my $rest = $2;

			my $pos = pos_last_openparen($rest);
			if ($pos >= 0) {
J
Joe Perches 已提交
3256 3257
				$line =~ /^(\+| )([ \t]*)/;
				my $newindent = $2;
3258 3259 3260 3261 3262 3263 3264 3265

				my $goodtabindent = $oldindent .
					"\t" x ($pos / 8) .
					" "  x ($pos % 8);
				my $goodspaceindent = $oldindent . " "  x $pos;

				if ($newindent ne $goodtabindent &&
				    $newindent ne $goodspaceindent) {
3266 3267 3268 3269

					if (CHK("PARENTHESIS_ALIGNMENT",
						"Alignment should match open parenthesis\n" . $hereprev) &&
					    $fix && $line =~ /^\+/) {
3270
						$fixed[$fixlinenr] =~
3271 3272
						    s/^\+[ \t]*/\+$goodtabindent/;
					}
3273 3274 3275 3276
				}
			}
		}

3277 3278 3279 3280 3281 3282 3283 3284 3285
# 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*$/)) {
3286
			if (CHK("SPACING",
3287
				"No space is necessary after a cast\n" . $herecurr) &&
3288
			    $fix) {
3289
				$fixed[$fixlinenr] =~
3290
				    s/(\(\s*$Type\s*\))[ \t]+/$1/;
3291
			}
3292 3293
		}

3294 3295
# Block comment styles
# Networking with an initial /*
3296
		if ($realfile =~ m@^(drivers/net/|net/)@ &&
3297
		    $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
3298 3299
		    $rawline =~ /^\+[ \t]*\*/ &&
		    $realline > 2) {
3300 3301 3302 3303
			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
			     "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
		}

3304 3305 3306
# Block comments use * on subsequent lines
		if ($prevline =~ /$;[ \t]*$/ &&			#ends in comment
		    $prevrawline =~ /^\+.*?\/\*/ &&		#starting /*
3307
		    $prevrawline !~ /\*\/[ \t]*$/ &&		#no trailing */
3308
		    $rawline =~ /^\+/ &&			#line is new
3309
		    $rawline !~ /^\+[ \t]*\*/) {		#no leading *
3310 3311
			WARN("BLOCK_COMMENT_STYLE",
			     "Block comments use * on subsequent lines\n" . $hereprev);
3312 3313
		}

3314 3315
# Block comments use */ on trailing lines
		if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ &&	#trailing */
3316 3317 3318
		    $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ &&	#inline /*...*/
		    $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ &&	#trailing **/
		    $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) {	#non blank */
3319 3320
			WARN("BLOCK_COMMENT_STYLE",
			     "Block comments use a trailing */ on a separate line\n" . $herecurr);
3321 3322
		}

3323 3324
# Block comment * alignment
		if ($prevline =~ /$;[ \t]*$/ &&			#ends in comment
3325 3326 3327
		    $line =~ /^\+[ \t]*$;/ &&			#leading comment
		    $rawline =~ /^\+[ \t]*\*/ &&		#leading *
		    (($prevrawline =~ /^\+.*?\/\*/ &&		#leading /*
3328
		      $prevrawline !~ /\*\/[ \t]*$/) ||		#no trailing */
3329 3330
		     $prevrawline =~ /^\+[ \t]*\*/)) {		#leading *
			my $oldindent;
3331
			$prevrawline =~ m@^\+([ \t]*/?)\*@;
3332 3333 3334 3335 3336 3337
			if (defined($1)) {
				$oldindent = expand_tabs($1);
			} else {
				$prevrawline =~ m@^\+(.*/?)\*@;
				$oldindent = expand_tabs($1);
			}
3338 3339 3340
			$rawline =~ m@^\+([ \t]*)\*@;
			my $newindent = $1;
			$newindent = expand_tabs($newindent);
3341
			if (length($oldindent) ne length($newindent)) {
3342 3343 3344 3345 3346
				WARN("BLOCK_COMMENT_STYLE",
				     "Block comments should align the * on each line\n" . $hereprev);
			}
		}

3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357
# 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/ ||
3358
		      $line =~ /^\+\s*builtin_[\w_]*driver/ ||
3359
		      $line =~ /^\+\s*__setup/)) {
3360 3361 3362
			if (CHK("LINE_SPACING",
				"Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
			    $fix) {
3363
				fix_insert_line($fixlinenr, "\+");
3364
			}
3365 3366
		}

3367 3368 3369 3370
# check for multiple consecutive blank lines
		if ($prevline =~ /^[\+ ]\s*$/ &&
		    $line =~ /^\+\s*$/ &&
		    $last_blank_line != ($linenr - 1)) {
3371 3372 3373
			if (CHK("LINE_SPACING",
				"Please don't use multiple blank lines\n" . $hereprev) &&
			    $fix) {
3374
				fix_delete_line($fixlinenr, $rawline);
3375 3376
			}

3377 3378 3379
			$last_blank_line = $linenr;
		}

3380
# check for missing blank lines after declarations
3381 3382 3383
		if ($sline =~ /^\+\s+\S/ &&			#Not at char 1
			# actual declarations
		    ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3384 3385
			# function pointer declarations
		     $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397
			# 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*[=,;:\[]/ ||
3398 3399
			# function pointer declarations
		      $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3400 3401 3402 3403 3404
			# 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
3405
		      $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ ||
3406 3407 3408 3409 3410 3411 3412 3413
			# 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/)) {
3414 3415 3416
			if (WARN("LINE_SPACING",
				 "Missing a blank line after declarations\n" . $hereprev) &&
			    $fix) {
3417
				fix_insert_line($fixlinenr, "\+");
3418
			}
3419 3420
		}

3421
# check for spaces at the beginning of a line.
3422 3423 3424 3425
# Exceptions:
#  1) within comments
#  2) indented preprocessor commands
#  3) hanging labels
3426
		if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/)  {
3427
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3428 3429 3430
			if (WARN("LEADING_SPACE",
				 "please, no spaces at the start of a line\n" . $herevet) &&
			    $fix) {
3431
				$fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3432
			}
3433 3434
		}

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

3438 3439 3440 3441 3442 3443
# check for unusual line ending [ or (
		if ($line =~ /^\+.*([\[\(])\s*$/) {
			CHK("OPEN_ENDED_LINE",
			    "Lines should not end with a '$1'\n" . $herecurr);
		}

3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454
# 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;
		}

3455
# check indentation of any line with a bare else
3456
# (but not if it is a multiple line "if (foo) return bar; else return baz;")
3457 3458 3459
# 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;
3460 3461 3462 3463
			if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
			    ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
			     defined $lines[$linenr] &&
			     $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
3464 3465 3466 3467 3468
				WARN("UNNECESSARY_ELSE",
				     "else is not generally useful after a break or return\n" . $hereprev);
			}
		}

3469 3470 3471 3472 3473 3474 3475 3476 3477 3478
# 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);
			}
		}

3479
# check for RCS/CVS revision markers
3480
		if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
3481 3482
			WARN("CVS_KEYWORD",
			     "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
3483
		}
3484

3485 3486 3487 3488 3489 3490
# 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);
		}

3491
# Check for potential 'bare' types
3492 3493
		my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
		    $realline_next);
3494
#print "LINE<$line>\n";
3495
		if ($linenr > $suppress_statement &&
3496
		    $realcnt && $sline =~ /.\s*\S/) {
3497
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3498
				ctx_statement_block($linenr, $realcnt, 0);
3499 3500 3501
			$stat =~ s/\n./\n /g;
			$cond =~ s/\n./\n /g;

3502 3503 3504 3505 3506 3507 3508 3509 3510
#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;
			}
3511

3512 3513 3514 3515 3516 3517 3518 3519
			# 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++;
			}

3520 3521
			my $s = $stat;
			$s =~ s/{.*$//s;
3522

3523
			# Ignore goto labels.
3524
			if ($s =~ /$Ident:\*$/s) {
3525 3526

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

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

3531
			# declarations always start with types
3532
			} 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) {
3533 3534 3535 3536
				my $type = $1;
				$type =~ s/\s+/ /g;
				possible($type, "A:" . $s);

3537
			# definitions in global scope can only start with types
3538
			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
3539
				possible($1, "B:" . $s);
3540
			}
3541 3542

			# any (foo ... *) is a pointer cast, and foo is a type
3543
			while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
3544
				possible($1, "C:" . $s);
3545 3546 3547 3548 3549
			}

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

3553
				my $ctx = $s;
3554
				substr($ctx, 0, $name_len + 1, '');
3555
				$ctx =~ s/\)[^\)]*$//;
3556

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

3560
						possible($1, "D:" . $s);
3561 3562
					}
				}
3563
			}
3564

3565 3566
		}

3567 3568 3569
#
# Checks which may be anchored in the context.
#
3570

3571 3572
# Check for switch () and associated case and default
# statements should be at the same indent.
3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588
		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 '') {
3589 3590
				ERROR("SWITCH_CASE_INDENT_LEVEL",
				      "switch and case should be at the same indent\n$hereline$err");
3591 3592 3593 3594 3595
			}
		}

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

3599
			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
3600 3601 3602 3603 3604 3605

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

3606 3607 3608
			my $ctx_cnt = $realcnt - $#ctx - 1;
			my $ctx = join("\n", @ctx);

3609 3610
			my $ctx_ln = $linenr;
			my $ctx_skip = $realcnt;
3611

3612 3613 3614 3615 3616
			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] !~ /^-/);
3617 3618
				$ctx_ln++;
			}
3619

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

3623
			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
3624 3625
				ERROR("OPEN_BRACE",
				      "that open brace { should be on the previous line\n" .
3626
					"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3627
			}
3628 3629 3630 3631
			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
			    $ctx =~ /\)\s*\;\s*$/ &&
			    defined $lines[$ctx_ln - 1])
			{
3632 3633
				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
				if ($nindent > $indent) {
3634 3635
					WARN("TRAILING_SEMICOLON",
					     "trailing semicolon indicates no statements, indent implies otherwise\n" .
3636
						"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3637 3638
				}
			}
3639 3640
		}

3641
# Check relative indent for conditionals and blocks.
3642
		if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3643 3644 3645
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
3646 3647 3648 3649
			my ($s, $c) = ($stat, $cond);

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

3650 3651 3652
			# remove inline comments
			$s =~ s/$;/ /g;
			$c =~ s/$;/ /g;
3653 3654

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

3658 3659 3660 3661 3662 3663 3664 3665
			# 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;
			}

3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677
			# 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;
			}
3678
			if ($s =~ s/^\s*?\n//) {
3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689
				$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;
			}

3690
			my $cond_ptr = -1;
3691
			$continuation = 0;
3692 3693 3694
			while ($cond_ptr != $cond_lines) {
				$cond_ptr = $cond_lines;

3695 3696 3697 3698 3699 3700
				# If we see an #else/#elif then the code
				# is not linear.
				if ($s =~ /^\s*\#\s*(?:else|elif)/) {
					$check = 0;
				}

3701 3702 3703 3704
				# Ignore:
				#  1) blank lines, they should be at 0,
				#  2) preprocessor lines, and
				#  3) labels.
3705 3706
				if ($continuation ||
				    $s =~ /^\s*?\n/ ||
3707 3708
				    $s =~ /^\s*#\s*?/ ||
				    $s =~ /^\s*$Ident\s*:/) {
3709
					$continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
3710 3711 3712
					if ($s =~ s/^.*?\n//) {
						$cond_lines++;
					}
3713
				}
3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728
			}

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

3729
			#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";
3730

3731 3732 3733
			if ($check && $s ne '' &&
			    (($sindent % 8) != 0 ||
			     ($sindent < $indent) ||
3734 3735
			     ($sindent == $indent &&
			      ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
3736
			     ($sindent > $indent + 8))) {
3737 3738
				WARN("SUSPECT_CODE_INDENT",
				     "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3739 3740 3741
			}
		}

3742 3743
		# Track the 'values' across context and added lines.
		my $opline = $line; $opline =~ s/^./ /;
3744 3745
		my ($curr_values, $curr_vars) =
				annotate_values($opline . "\n", $prev_values);
3746
		$curr_values = $prev_values . $curr_values;
3747 3748
		if ($dbg_values) {
			my $outline = $opline; $outline =~ s/\t/ /g;
3749 3750
			print "$linenr > .$outline\n";
			print "$linenr > $curr_values\n";
3751
			print "$linenr >  $curr_vars\n";
3752
		}
3753 3754
		$prev_values = substr($curr_values, -1);

3755
#ignore lines not being added
3756
		next if ($line =~ /^[^\+]/);
3757

3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769
# 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);
		}

3770
# check for declarations of signed or unsigned without int
3771
		while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3772 3773
			my $type = $1;
			my $var = $2;
3774 3775
			$var = "" if (!defined $var);
			if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
3776 3777 3778 3779 3780 3781 3782 3783 3784
				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 ";
3785 3786 3787 3788 3789
					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@;
3790 3791 3792 3793
				}
			}
		}

3794
# TEST: allow direct testing of the type matcher.
3795 3796
		if ($dbg_type) {
			if ($line =~ /^.\s*$Declare\s*$/) {
3797 3798
				ERROR("TEST_TYPE",
				      "TEST: is type\n" . $herecurr);
3799
			} elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3800 3801
				ERROR("TEST_NOT_TYPE",
				      "TEST: is not type ($1 is)\n". $herecurr);
3802
			}
3803 3804
			next;
		}
3805 3806
# TEST: allow direct testing of the attribute matcher.
		if ($dbg_attr) {
3807
			if ($line =~ /^.\s*$Modifier\s*$/) {
3808 3809
				ERROR("TEST_ATTR",
				      "TEST: is attr\n" . $herecurr);
3810
			} elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3811 3812
				ERROR("TEST_NOT_ATTR",
				      "TEST: is not attr ($1 is)\n". $herecurr);
3813 3814 3815
			}
			next;
		}
3816

3817
# check for initialisation to aggregates open brace on the next line
3818 3819
		if ($line =~ /^.\s*{/ &&
		    $prevline =~ /(?:^|[^=])=\s*$/) {
3820 3821
			if (ERROR("OPEN_BRACE",
				  "that open brace { should be on the previous line\n" . $hereprev) &&
3822 3823 3824
			    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
				fix_delete_line($fixlinenr - 1, $prevrawline);
				fix_delete_line($fixlinenr, $rawline);
3825 3826
				my $fixedline = $prevrawline;
				$fixedline =~ s/\s*=\s*$/ = {/;
3827
				fix_insert_line($fixlinenr, $fixedline);
3828
				$fixedline = $line;
3829
				$fixedline =~ s/^(.\s*)\{\s*/$1/;
3830
				fix_insert_line($fixlinenr, $fixedline);
3831
			}
3832 3833
		}

3834 3835 3836 3837 3838
#
# Checks which are anchored on the added line.
#

# check for malformed paths in #include statements (uses RAW line)
3839
		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3840 3841
			my $path = $1;
			if ($path =~ m{//}) {
3842
				ERROR("MALFORMED_INCLUDE",
3843 3844 3845 3846 3847
				      "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);
3848 3849
			}
		}
3850

3851
# no C99 // comments
3852
		if ($line =~ m{//}) {
3853 3854 3855
			if (ERROR("C99_COMMENTS",
				  "do not use C99 // comments\n" . $herecurr) &&
			    $fix) {
3856
				my $line = $fixed[$fixlinenr];
3857 3858
				if ($line =~ /\/\/(.*)$/) {
					my $comment = trim($1);
3859
					$fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3860 3861
				}
			}
3862
		}
3863
		# Remove C99 comments.
3864
		$line =~ s@//.*@@;
3865
		$opline =~ s@//.*@@;
3866

3867 3868 3869 3870 3871 3872 3873 3874
# 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.*\((.*)\)/)) {
3875 3876 3877 3878
			# Handle definitions which produce identifiers with
			# a prefix:
			#   XXX(foo);
			#   EXPORT_SYMBOL(something_foo);
3879
			my $name = $1;
3880
			if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3881 3882 3883 3884 3885
			    $name =~ /^${Ident}_$2/) {
#print "FOO C name<$name>\n";
				$suppress_export{$realline_next} = 1;

			} elsif ($stat !~ /(?:
3886
				\n.}\s*$|
3887 3888 3889
				^.DEFINE_$Ident\(\Q$name\E\)|
				^.DECLARE_$Ident\(\Q$name\E\)|
				^.LIST_HEAD\(\Q$name\E\)|
3890 3891
				^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
				\b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
3892
			    )/x) {
3893 3894 3895 3896
#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
				$suppress_export{$realline_next} = 2;
			} else {
				$suppress_export{$realline_next} = 1;
3897 3898
			}
		}
3899 3900 3901 3902 3903 3904 3905 3906 3907
		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) {
3908 3909
			WARN("EXPORT_SYMBOL",
			     "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3910
		}
3911

3912
# check for global initialisers.
3913
		if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
3914
			if (ERROR("GLOBAL_INITIALISERS",
3915
				  "do not initialise globals to $1\n" . $herecurr) &&
3916
			    $fix) {
3917
				$fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
3918
			}
3919
		}
3920
# check for static initialisers.
3921
		if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
3922
			if (ERROR("INITIALISED_STATIC",
3923
				  "do not initialise statics to $1\n" .
3924 3925
				      $herecurr) &&
			    $fix) {
3926
				$fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
3927
			}
3928 3929
		}

3930 3931 3932 3933 3934 3935 3936
# 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);
		}

3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956
# 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/;
			}
		}

3957 3958
# check for static const char * arrays.
		if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3959 3960
			WARN("STATIC_CONST_CHAR_ARRAY",
			     "static const char * array should probably be static const char * const\n" .
3961
				$herecurr);
3962 3963 3964 3965 3966 3967 3968 3969 3970 3971
		}

# 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/;
			}
		}
3972 3973 3974

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

3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991
# 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);
			}
		}

3992 3993 3994 3995 3996 3997 3998
# 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);
               }

3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011
# 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)/;
				}
			}
		}

4012 4013 4014 4015 4016
# 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) {
4017
				$fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
4018 4019 4020
			}
		}

4021 4022 4023
# check for new typedefs, only function parameters and sparse annotations
# make sense.
		if ($line =~ /\btypedef\s/ &&
4024
		    $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
4025
		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
4026
		    $line !~ /\b$typeTypedefs\b/ &&
4027
		    $line !~ /\b__bitwise\b/) {
4028 4029
			WARN("NEW_TYPEDEFS",
			     "do not add new typedefs\n" . $herecurr);
4030 4031 4032
		}

# * goes on variable not on type
4033
		# (char*[ const])
4034 4035
		while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
			#print "AA<$1>\n";
4036
			my ($ident, $from, $to) = ($1, $2, $2);
4037 4038 4039 4040 4041 4042

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

4046
##			print "1: from<$from> to<$to> ident<$ident>\n";
4047
			if ($from ne $to) {
4048 4049 4050 4051 4052 4053
				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/;
4054
					$fixed[$fixlinenr] =~
4055 4056
					    s@\Q$sub_from\E@$sub_to@;
				}
4057
			}
4058 4059 4060
		}
		while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
			#print "BB<$1>\n";
4061
			my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
4062 4063 4064 4065 4066 4067

			# Should start with a space.
			$to =~ s/^(\S)/ $1/;
			# Should not end with a space.
			$to =~ s/\s+$//;
			# '*'s should not have spaces between.
4068
			while ($to =~ s/\*\s+\*/\*\*/) {
4069 4070 4071
			}
			# Modifiers should have spaces.
			$to =~ s/(\b$Modifier$)/$1 /;
4072

4073
##			print "2: from<$from> to<$to> ident<$ident>\n";
4074
			if ($from ne $to && $ident !~ /^$Modifier$/) {
4075 4076 4077 4078 4079 4080 4081
				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/;
4082
					$fixed[$fixlinenr] =~
4083 4084
					    s@\Q$sub_from\E@$sub_to@;
				}
4085
			}
4086 4087
		}

4088 4089
# avoid BUG() or BUG_ON()
		if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
4090 4091 4092 4093
			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);
4094
		}
4095

4096
# avoid LINUX_VERSION_CODE
4097
		if ($line =~ /\bLINUX_VERSION_CODE\b/) {
4098 4099
			WARN("LINUX_VERSION_CODE",
			     "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
4100 4101
		}

4102 4103
# check for uses of printk_ratelimit
		if ($line =~ /\bprintk_ratelimit\s*\(/) {
4104
			WARN("PRINTK_RATELIMITED",
4105
			     "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
4106 4107
		}

4108 4109 4110 4111
# 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);
4112 4113
		}

4114 4115 4116 4117
		if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
			my $orig = $1;
			my $level = lc($orig);
			$level = "warn" if ($level eq "warning");
4118 4119
			my $level2 = $level;
			$level2 = "dbg" if ($level eq "debug");
4120
			WARN("PREFER_PR_LEVEL",
4121
			     "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(...  to printk(KERN_$orig ...\n" . $herecurr);
4122 4123
		}

4124 4125 4126 4127 4128 4129 4130 4131 4132
		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);
		}

4133 4134 4135 4136 4137 4138 4139 4140
# 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);
		}

4141 4142
# function brace can't be on same line, except for #defines of do while,
# or if closed on same line
4143
		if ($perl_version_ok &&
4144 4145 4146
		    $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
		    $sline !~ /\#\s*define\b.*do\s*\{/ &&
		    $sline !~ /}/) {
4147
			if (ERROR("OPEN_BRACE",
4148
				  "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160
			    $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));
				}
			}
4161
		}
4162

4163 4164 4165
# 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*$/) {
4166 4167 4168 4169 4170 4171 4172 4173
			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;
4174
				$fixedline =~ s/^(.\s*)\{\s*/$1\t/;
4175 4176 4177 4178
				if ($fixedline !~ /^\+\s*$/) {
					fix_insert_line($fixlinenr, $fixedline);
				}
			}
4179 4180
		}

4181
# missing space after union, struct or enum definition
4182 4183 4184 4185
		if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
			if (WARN("SPACING",
				 "missing space after $1 definition\n" . $herecurr) &&
			    $fix) {
4186
				$fixed[$fixlinenr] =~
4187 4188
				    s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
			}
4189 4190
		}

4191 4192 4193
# Function pointer declarations
# check spacing between type, funcptr, and args
# canonical declaration is "type (*funcptr)(args...)"
4194
		if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
4195 4196 4197 4198 4199 4200 4201
			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;

4202 4203 4204 4205 4206 4207 4208 4209 4210
# 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 =~ /^$/) {
4211 4212
				WARN("SPACING",
				     "missing space after return type\n" . $herecurr);
4213
				$post_declare_space = " ";
4214 4215 4216
			}

# unnecessary space "type  (*funcptr)(args...)"
4217 4218 4219 4220 4221 4222 4223 4224 4225
# 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);
#			}
4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255

# 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) {
4256
				$fixed[$fixlinenr] =~
4257
				    s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4258 4259 4260
			}
		}

4261 4262
# check for spacing round square brackets; allowed:
#  1. with a type on the left -- int [] a;
4263 4264
#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
#  3. inside a curly brace -- = { [0...10] = 5 }
4265 4266 4267
		while ($line =~ /(.*?\s)\[/g) {
			my ($where, $prefix) = ($-[1], $1);
			if ($prefix !~ /$Type\s+$/ &&
4268
			    ($where != 0 || $prefix !~ /^.\s+$/) &&
4269
			    $prefix !~ /[{,:]\s+$/) {
4270 4271 4272
				if (ERROR("BRACKET_SPACE",
					  "space prohibited before open square bracket '['\n" . $herecurr) &&
				    $fix) {
4273
				    $fixed[$fixlinenr] =~
4274 4275
					s/^(\+.*?)\s+\[/$1\[/;
				}
4276 4277 4278
			}
		}

4279
# check for spaces between functions and their parentheses.
4280
		while ($line =~ /($Ident)\s+\(/g) {
4281
			my $name = $1;
4282 4283
			my $ctx_before = substr($line, 0, $-[1]);
			my $ctx = "$ctx_before$name";
4284 4285

			# Ignore those directives where spaces _are_ permitted.
4286 4287 4288 4289 4290 4291
			if ($name =~ /^(?:
				if|for|while|switch|return|case|
				volatile|__volatile__|
				__attribute__|format|__extension__|
				asm|__asm__)$/x)
			{
4292 4293 4294
			# 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.
4295
			} elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
4296 4297

			# cpp #elif statement condition may start with a (
4298
			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
4299 4300 4301

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

			} else {
4305 4306 4307
				if (WARN("SPACING",
					 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
					     $fix) {
4308
					$fixed[$fixlinenr] =~
4309 4310
					    s/\b$name\s+\(/$name\(/;
				}
4311
			}
4312
		}
4313

4314
# Check operator spacing.
4315
		if (!($line=~/\#\s*include/)) {
4316 4317 4318
			my $fixed_line = "";
			my $line_fixed = 0;

4319 4320 4321 4322
			my $ops = qr{
				<<=|>>=|<=|>=|==|!=|
				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
				=>|->|<<|>>|<|>|=|!|~|
4323
				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
4324
				\?:|\?|:
4325
			}x;
4326
			my @elements = split(/($ops|;)/, $opline);
4327 4328 4329 4330 4331 4332 4333

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

			my @fix_elements = ();
4334
			my $off = 0;
4335

4336 4337 4338 4339 4340 4341 4342
			foreach my $el (@elements) {
				push(@fix_elements, substr($rawline, $off, length($el)));
				$off += length($el);
			}

			$off = 0;

4343
			my $blank = copy_spacing($opline);
4344
			my $last_after = -1;
4345

4346
			for (my $n = 0; $n < $#elements; $n += 2) {
4347 4348 4349 4350 4351

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

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

4352 4353
				$off += length($elements[$n]);

L
Lucas De Marchi 已提交
4354
				# Pick up the preceding and succeeding characters.
4355 4356 4357 4358 4359 4360 4361
				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";

4362 4363 4364
				my $a = '';
				$a = 'V' if ($elements[$n] ne '');
				$a = 'W' if ($elements[$n] =~ /\s$/);
4365
				$a = 'C' if ($elements[$n] =~ /$;$/);
4366 4367
				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
				$a = 'O' if ($elements[$n] eq '');
4368
				$a = 'E' if ($ca =~ /^\s*$/);
4369

4370
				my $op = $elements[$n + 1];
4371 4372

				my $c = '';
4373
				if (defined $elements[$n + 2]) {
4374 4375
					$c = 'V' if ($elements[$n + 2] ne '');
					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
4376
					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
4377 4378
					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
					$c = 'O' if ($elements[$n + 2] eq '');
4379
					$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
4380 4381
				} else {
					$c = 'E';
4382 4383
				}

4384 4385 4386 4387
				my $ctx = "${a}x${c}";

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

4388
				my $ptr = substr($blank, 0, $off) . "^";
4389
				my $hereptr = "$hereline$ptr\n";
4390

4391
				# Pull out the value of this operator.
4392
				my $op_type = substr($curr_values, $off + 1, 1);
4393

4394 4395 4396
				# Get the full operator variant.
				my $opv = $op . substr($curr_vars, $off, 1);

4397 4398
				# Ignore operators passed as parameters.
				if ($op_type ne 'V' &&
4399
				    $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
4400

4401 4402
#				# Ignore comments
#				} elsif ($op =~ /^$;+$/) {
4403

4404
				# ; should have either the end of line or a space or \ after it
4405
				} elsif ($op eq ';') {
4406 4407
					if ($ctx !~ /.x[WEBC]/ &&
					    $cc !~ /^\\/ && $cc !~ /^;/) {
4408 4409
						if (ERROR("SPACING",
							  "space required after that '$op' $at\n" . $hereptr)) {
4410
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4411 4412
							$line_fixed = 1;
						}
4413 4414 4415 4416
					}

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

4418 4419 4420 4421
				#   :   when part of a bitfield
				} elsif ($opv eq ':B') {
					# skip the bitfield test for now

4422 4423
				# No spaces for:
				#   ->
4424
				} elsif ($op eq '->') {
4425
					if ($ctx =~ /Wx.|.xW/) {
4426 4427
						if (ERROR("SPACING",
							  "spaces prohibited around that '$op' $at\n" . $hereptr)) {
4428
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4429 4430 4431
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
4432
							$line_fixed = 1;
4433
						}
4434 4435
					}

4436
				# , must not have a space before and must have a space on the right.
4437
				} elsif ($op eq ',') {
4438 4439 4440 4441 4442 4443 4444 4445 4446
					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;
						}
					}
4447
					if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
4448 4449 4450
						if (ERROR("SPACING",
							  "space required after that '$op' $at\n" . $hereptr)) {
							$line_fixed = 1;
4451
							$last_after = $n;
4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462
							$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 .= " ";
4463
						}
4464 4465
					}

4466
				# '*' as part of a type definition -- reported already.
4467
				} elsif ($opv eq '*_') {
4468 4469 4470 4471 4472 4473
					#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 '~' ||
4474
					 $opv eq '*U' || $opv eq '-U' ||
4475
					 $opv eq '&U' || $opv eq '&&U') {
4476
					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
4477 4478
						if (ERROR("SPACING",
							  "space required before that '$op' $at\n" . $hereptr)) {
4479 4480 4481 4482
							if ($n != $last_after + 2) {
								$good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
								$line_fixed = 1;
							}
4483
						}
4484
					}
4485
					if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
4486 4487 4488
						# A unary '*' may be const

					} elsif ($ctx =~ /.xW/) {
4489 4490
						if (ERROR("SPACING",
							  "space prohibited after that '$op' $at\n" . $hereptr)) {
4491
							$good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
4492 4493 4494
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
4495
							$line_fixed = 1;
4496
						}
4497 4498 4499 4500
					}

				# unary ++ and unary -- are allowed no space on one side.
				} elsif ($op eq '++' or $op eq '--') {
4501
					if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
4502 4503
						if (ERROR("SPACING",
							  "space required one side of that '$op' $at\n" . $hereptr)) {
4504
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4505 4506
							$line_fixed = 1;
						}
4507 4508 4509
					}
					if ($ctx =~ /Wx[BE]/ ||
					    ($ctx =~ /Wx./ && $cc =~ /^;/)) {
4510 4511
						if (ERROR("SPACING",
							  "space prohibited before that '$op' $at\n" . $hereptr)) {
4512
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4513 4514
							$line_fixed = 1;
						}
4515
					}
4516
					if ($ctx =~ /ExW/) {
4517 4518
						if (ERROR("SPACING",
							  "space prohibited after that '$op' $at\n" . $hereptr)) {
4519
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4520 4521 4522
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
4523
							$line_fixed = 1;
4524
						}
4525
					}
4526 4527

				# << and >> may either have or not have spaces both sides
4528 4529 4530
				} elsif ($op eq '<<' or $op eq '>>' or
					 $op eq '&' or $op eq '^' or $op eq '|' or
					 $op eq '+' or $op eq '-' or
4531 4532
					 $op eq '*' or $op eq '/' or
					 $op eq '%')
4533
				{
4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549
					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/) {
4550 4551
						if (ERROR("SPACING",
							  "need consistent spacing around '$op' $at\n" . $hereptr)) {
4552 4553 4554 4555
							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
4556 4557
							$line_fixed = 1;
						}
4558 4559
					}

4560 4561 4562 4563
				# 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./) {
4564 4565
						if (ERROR("SPACING",
							  "space prohibited before that '$op' $at\n" . $hereptr)) {
4566
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4567 4568
							$line_fixed = 1;
						}
4569 4570
					}

4571
				# All the others need spaces both sides.
4572
				} elsif ($ctx !~ /[EWC]x[CWE]/) {
4573 4574
					my $ok = 0;

4575
					# Ignore email addresses <foo@bar>
4576 4577 4578 4579 4580 4581 4582 4583
					if (($op eq '<' &&
					     $cc =~ /^\S+\@\S+>/) ||
					    ($op eq '>' &&
					     $ca =~ /<\S+\@\S+$/))
					{
					    	$ok = 1;
					}

4584 4585 4586 4587 4588 4589 4590 4591
					# for asm volatile statements
					# ignore a colon with another
					# colon immediately before or after
					if (($op eq ':') &&
					    ($ca =~ /:$/ || $cc =~ /^:/)) {
						$ok = 1;
					}

4592
					# messages are ERROR, but ?: are CHK
4593
					if ($ok == 0) {
4594 4595
						my $msg_level = \&ERROR;
						$msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4596

4597 4598
						if (&{$msg_level}("SPACING",
								  "spaces required around that '$op' $at\n" . $hereptr)) {
4599 4600 4601 4602
							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
4603 4604
							$line_fixed = 1;
						}
4605
					}
4606
				}
4607
				$off += length($elements[$n + 1]);
4608 4609 4610 4611 4612 4613 4614 4615

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

				$fixed_line = $fixed_line . $good;
			}

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

4618 4619
			if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
				$fixed[$fixlinenr] = $fixed_line;
4620 4621 4622
			}


4623 4624
		}

4625
# check for whitespace before a non-naked semicolon
4626
		if ($line =~ /^\+.*\S\s+;\s*$/) {
4627 4628 4629
			if (WARN("SPACING",
				 "space prohibited before semicolon\n" . $herecurr) &&
			    $fix) {
4630
				1 while $fixed[$fixlinenr] =~
4631 4632 4633 4634
				    s/^(\+.*\S)\s+;/$1;/;
			}
		}

4635 4636
# check for multiple assignments
		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
4637 4638
			CHK("MULTIPLE_ASSIGNMENTS",
			    "multiple assignments should be avoided\n" . $herecurr);
4639 4640
		}

4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651
## # 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 =~ /,/) {
4652 4653
## 				WARN("MULTIPLE_DECLARATION",
##				     "declaring multiple variables together should be avoided\n" . $herecurr);
4654 4655
## 			}
## 		}
4656

4657
#need space before brace following if, while, etc
4658
		if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
4659
		    $line =~ /\b(?:else|do)\{/) {
4660 4661 4662
			if (ERROR("SPACING",
				  "space required before the open brace '{'\n" . $herecurr) &&
			    $fix) {
4663
				$fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/;
4664
			}
4665 4666
		}

4667 4668 4669 4670 4671 4672 4673 4674
## # check for blank lines before declarations
##		if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
##		    $prevrawline =~ /^.\s*$/) {
##			WARN("SPACING",
##			     "No blank lines before declarations\n" . $hereprev);
##		}
##

4675 4676
# closing brace should have a space following it when it has anything
# on the line
4677
		if ($line =~ /}(?!(?:,|;|\)|\}))\S/) {
4678 4679 4680
			if (ERROR("SPACING",
				  "space required after that close brace '}'\n" . $herecurr) &&
			    $fix) {
4681
				$fixed[$fixlinenr] =~
4682 4683
				    s/}((?!(?:,|;|\)))\S)/} $1/;
			}
4684 4685
		}

4686 4687
# check spacing on square brackets
		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
4688 4689 4690
			if (ERROR("SPACING",
				  "space prohibited after that open square bracket '['\n" . $herecurr) &&
			    $fix) {
4691
				$fixed[$fixlinenr] =~
4692 4693
				    s/\[\s+/\[/;
			}
4694 4695
		}
		if ($line =~ /\s\]/) {
4696 4697 4698
			if (ERROR("SPACING",
				  "space prohibited before that close square bracket ']'\n" . $herecurr) &&
			    $fix) {
4699
				$fixed[$fixlinenr] =~
4700 4701
				    s/\s+\]/\]/;
			}
4702 4703
		}

4704
# check spacing on parentheses
4705 4706
		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
		    $line !~ /for\s*\(\s+;/) {
4707 4708 4709
			if (ERROR("SPACING",
				  "space prohibited after that open parenthesis '('\n" . $herecurr) &&
			    $fix) {
4710
				$fixed[$fixlinenr] =~
4711 4712
				    s/\(\s+/\(/;
			}
4713
		}
4714
		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
4715 4716
		    $line !~ /for\s*\(.*;\s+\)/ &&
		    $line !~ /:\s+\)/) {
4717 4718 4719
			if (ERROR("SPACING",
				  "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
			    $fix) {
4720
				$fixed[$fixlinenr] =~
4721 4722
				    s/\s+\)/\)/;
			}
4723 4724
		}

4725 4726 4727 4728
# 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) {
4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749
			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/;
			}
		}
4750

4751
# check for unnecessary parentheses around comparisons in if uses
4752 4753
# when !drivers/staging or command-line uses --strict
		if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
4754
		    $perl_version_ok && defined($stat) &&
4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776
		    $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);
			}
		}

4777
#goto labels aren't indented, allow a single space however
4778
		if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
4779
		   !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
4780 4781 4782
			if (WARN("INDENTED_LABEL",
				 "labels should not be indented\n" . $herecurr) &&
			    $fix) {
4783
				$fixed[$fixlinenr] =~
4784 4785
				    s/^(.)\s+/$1/;
			}
4786 4787
		}

4788
# return is not a function
4789
		if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
4790
			my $spacing = $1;
4791
			if ($perl_version_ok &&
4792 4793 4794 4795 4796 4797 4798
			    $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);
				}
4799
			} elsif ($spacing !~ /\s+/) {
4800 4801
				ERROR("SPACING",
				      "space required before the open parenthesis '('\n" . $herecurr);
4802 4803
			}
		}
4804

4805 4806 4807 4808 4809 4810 4811 4812
# 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*:/) {
4813
			WARN("RETURN_VOID",
4814 4815
			     "void function return statements are not generally useful\n" . $hereprev);
               }
4816

4817
# if statements using unnecessary parentheses - ie: if ((foo == bar))
4818
		if ($perl_version_ok &&
4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830
		    $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);
			}
		}

4831 4832 4833 4834
# 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"
4835
		if ($perl_version_ok &&
4836 4837 4838 4839 4840 4841
		    $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;
4842
			if ($lead !~ /(?:$Operators|\.)\s*$/ &&
4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859
			    $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)/;
			}
		}

4860 4861
# Return of what appears to be an errno should normally be negative
		if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
4862 4863
			my $name = $1;
			if ($name ne 'EOF' && $name ne 'ERROR') {
4864
				WARN("USE_NEGATIVE_ERRNO",
4865
				     "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
4866 4867
			}
		}
4868

4869
# Need a space before open parenthesis after if, while etc
4870 4871 4872 4873
		if ($line =~ /\b(if|while|for|switch)\(/) {
			if (ERROR("SPACING",
				  "space required before the open parenthesis '('\n" . $herecurr) &&
			    $fix) {
4874
				$fixed[$fixlinenr] =~
4875 4876
				    s/\b(if|while|for|switch)\(/$1 \(/;
			}
4877 4878
		}

4879 4880
# Check for illegal assignment in if conditional -- and check for trailing
# statements after the conditional.
4881
		if ($line =~ /do\s*(?!{)/) {
4882 4883 4884
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902
			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} &&
4903
		    defined($stat) && defined($cond) &&
4904
		    $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
4905
			my ($s, $c) = ($stat, $cond);
4906

4907
			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
4908 4909
				ERROR("ASSIGN_IN_IF",
				      "do not use assignment in if condition\n" . $herecurr);
4910 4911 4912 4913
			}

			# Find out what is on the end of the line after the
			# conditional.
4914
			substr($s, 0, length($c), '');
4915
			$s =~ s/\n.*//g;
4916
			$s =~ s/$;//g; 	# Remove any comments
4917 4918
			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
			    $c !~ /}\s*while\s*/)
4919
			{
4920 4921 4922
				# Find out how long the conditional actually is.
				my @newlines = ($c =~ /\n/gs);
				my $cond_lines = 1 + $#newlines;
4923
				my $stat_real = '';
4924

4925 4926
				$stat_real = raw_line($linenr, $cond_lines)
							. "\n" if ($cond_lines);
4927 4928 4929 4930
				if (defined($stat_real) && $cond_lines > 1) {
					$stat_real = "[...]\n$stat_real";
				}

4931 4932
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr . $stat_real);
4933 4934 4935
			}
		}

4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947
# Check for bitwise tests written as boolean
		if ($line =~ /
			(?:
				(?:\[|\(|\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\|)
			|
				(?:\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\||\)|\])
			)/x)
		{
4948 4949
			WARN("HEXADECIMAL_BOOLEAN_TEST",
			     "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
4950 4951
		}

4952
# if and else should not have general statements after it
4953 4954 4955 4956
		if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
			my $s = $1;
			$s =~ s/$;//g; 	# Remove any comments
			if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
4957 4958
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr);
4959
			}
4960
		}
4961 4962
# if should not continue a brace
		if ($line =~ /}\s*if\b/) {
4963
			ERROR("TRAILING_STATEMENTS",
4964
			      "trailing statements should be on next line (or did you mean 'else if'?)\n" .
4965 4966
				$herecurr);
		}
4967 4968 4969
# case and default should not have general statements after them
		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
		    $line !~ /\G(?:
4970
			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
4971 4972 4973
			\s*return\s+
		    )/xg)
		{
4974 4975
			ERROR("TRAILING_STATEMENTS",
			      "trailing statements should be on next line\n" . $herecurr);
4976
		}
4977 4978 4979

		# Check for }<nl>else {, these must be at the same
		# indent level to be relevant to each other.
4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995
		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);
			}
4996 4997
		}

4998 4999
		if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
		    $previndent == $indent) {
5000 5001 5002 5003
			my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);

			# Find out what is on the end of the line after the
			# conditional.
5004
			substr($s, 0, length($c), '');
5005 5006 5007
			$s =~ s/\n.*//g;

			if ($s =~ /^\s*;/) {
5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019
				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);
				}
5020 5021 5022
			}
		}

5023
#Specific variable tests
5024 5025
		while ($line =~ m{($Constant|$Lval)}g) {
			my $var = $1;
5026 5027

#CamelCase
5028
			if ($var !~ /^$Constant$/ &&
5029
			    $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
5030
#Ignore Page<foo> variants
5031
			    $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
5032
#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
5033 5034 5035
			    $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
#Ignore some three character SI units explicitly, like MiB and KHz
			    $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
5036 5037 5038
				while ($var =~ m{($Ident)}g) {
					my $word = $1;
					next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
5039 5040 5041 5042 5043 5044 5045
					if ($check) {
						seed_camelcase_includes();
						if (!$file && !$camelcase_file_seeded) {
							seed_camelcase_file($realfile);
							$camelcase_file_seeded = 1;
						}
					}
5046 5047 5048 5049 5050
					if (!defined $camelcase{$word}) {
						$camelcase{$word} = 1;
						CHK("CAMELCASE",
						    "Avoid CamelCase: <$word>\n" . $herecurr);
					}
5051
				}
5052 5053
			}
		}
5054 5055

#no spaces allowed after \ in define
5056 5057 5058 5059
		if ($line =~ /\#\s*define.*\\\s+$/) {
			if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
				 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
			    $fix) {
5060
				$fixed[$fixlinenr] =~ s/\s+$//;
5061
			}
5062 5063
		}

5064 5065
# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
# itself <asm/foo.h> (uses RAW line)
5066
		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
5067 5068 5069 5070
			my $file = "$1.h";
			my $checkfile = "include/linux/$file";
			if (-f "$root/$checkfile" &&
			    $realfile ne $checkfile &&
5071
			    $1 !~ /$allowed_asm_includes/)
5072
			{
5073 5074 5075 5076 5077 5078 5079 5080 5081
				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);
					}
5082
				}
5083 5084 5085
			}
		}

5086 5087
# 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
5088
# in a known good container
5089 5090
		if ($realfile !~ m@/vmlinux.lds.h$@ &&
		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
5091 5092
			my $ln = $linenr;
			my $cnt = $realcnt;
5093 5094
			my ($off, $dstat, $dcond, $rest);
			my $ctx = '';
5095 5096
			my $has_flow_statement = 0;
			my $has_arg_concat = 0;
5097
			($dstat, $dcond, $ln, $cnt, $off) =
5098 5099
				ctx_statement_block($linenr, $realcnt, 0);
			$ctx = $dstat;
5100
			#print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5101
			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5102

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

5106 5107 5108 5109 5110 5111 5112 5113
			$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;
5114
				$define_args =~ s/\\\+?//g;
5115 5116 5117
				@def_args = split(",", $define_args);
			}

5118
			$dstat =~ s/$;//g;
5119 5120 5121
			$dstat =~ s/\\\n.//g;
			$dstat =~ s/^\s*//s;
			$dstat =~ s/\s*$//s;
5122

5123
			# Flatten any parentheses and braces
5124 5125
			while ($dstat =~ s/\([^\(\)]*\)/1/ ||
			       $dstat =~ s/\{[^\{\}]*\}/1/ ||
5126
			       $dstat =~ s/.\[[^\[\]]*\]/1/)
5127
			{
5128
			}
5129

5130
			# Flatten any obvious string concatentation.
5131 5132
			while ($dstat =~ s/($String)\s*$Ident/$1/ ||
			       $dstat =~ s/$Ident\s*($String)/$1/)
5133 5134 5135
			{
			}

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

5139 5140 5141
			my $exceptions = qr{
				$Declare|
				module_param_named|
5142
				MODULE_PARM_DESC|
5143 5144
				DECLARE_PER_CPU|
				DEFINE_PER_CPU|
5145
				__typeof__\(|
5146 5147
				union|
				struct|
5148
				\.$Ident\s*=\s*|
5149 5150
				^\"|\"$|
				^\[
5151
			}x;
5152
			#print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5153 5154 5155

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

5158 5159 5160
			if ($dstat ne '' &&
			    $dstat !~ /^(?:$Ident|-?$Constant),$/ &&			# 10, // foo(),
			    $dstat !~ /^(?:$Ident|-?$Constant);$/ &&			# foo();
5161
			    $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ &&		# 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5162
			    $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ &&			# character constants
5163 5164
			    $dstat !~ /$exceptions/ &&
			    $dstat !~ /^\.$Ident\s*=/ &&				# .foo =
5165
			    $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ &&		# stringification #foo
5166
			    $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ &&	# do {...} while (...); // do {...} while (...)
5167 5168 5169
			    $dstat !~ /^for\s*$Constant$/ &&				# for (...)
			    $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ &&	# for (...) bar()
			    $dstat !~ /^do\s*{/ &&					# do {...
5170
			    $dstat !~ /^\(\{/ &&						# ({...
5171
			    $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
5172
			{
5173 5174 5175 5176
				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 =~ /;/) {
5177 5178 5179
					ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
					      "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
				} else {
5180
					ERROR("COMPLEX_MACRO",
A
Andrew Morton 已提交
5181
					      "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
5182
				}
5183 5184

			}
5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202

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

5203 5204 5205
# check if any macro arguments are reused (ignore '...' and 'type')
			foreach my $arg (@def_args) {
			        next if ($arg =~ /\.\.\./);
5206
			        next if ($arg =~ /^type$/i);
5207
				my $tmp_stmt = $define_stmt;
5208
				$tmp_stmt =~ s/\b(sizeof|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5209 5210
				$tmp_stmt =~ s/\#+\s*$arg\b//g;
				$tmp_stmt =~ s/\b$arg\s*\#\#//g;
5211
				my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
5212 5213 5214
				if ($use_cnt > 1) {
					CHK("MACRO_ARG_REUSE",
					    "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
5215 5216
				    }
# check if any macro arguments may have other precedence issues
5217
				if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
5218 5219 5220 5221
				    ((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");
5222
				}
5223
			}
5224

5225 5226 5227 5228
# 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);
5229
				my $herectx = get_stat_here($linenr, $cnt, $here);
5230 5231 5232 5233 5234

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

5235
# check for line continuations outside of #defines, preprocessor #, and asm
5236 5237 5238

		} else {
			if ($prevline !~ /^..*\\$/ &&
5239 5240
			    $line !~ /^\+\s*\#.*\\$/ &&		# preprocessor
			    $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ &&	# asm
5241 5242 5243 5244
			    $line =~ /^\+.*\\$/) {
				WARN("LINE_CONTINUATIONS",
				     "Avoid unnecessary line continuations\n" . $herecurr);
			}
5245 5246
		}

5247 5248 5249
# 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
5250
		if ($perl_version_ok &&
5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261
		    $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;
5262
			$dstat =~ s/$;/ /g;
5263 5264 5265 5266 5267 5268 5269

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

5272 5273
				if (($stmts =~ tr/;/;/) == 1 &&
				    $stmts !~ /^\s*(if|while|for|switch)\b/) {
5274 5275 5276 5277 5278 5279 5280
					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");
				}
5281 5282 5283
			} elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
				$ctx =~ s/\n*$//;
				my $cnt = statement_rawlines($ctx);
5284
				my $herectx = get_stat_here($linenr, $cnt, $here);
5285 5286 5287

				WARN("TRAILING_SEMICOLON",
				     "macros should not use a trailing semicolon\n" . "$herectx");
5288 5289 5290
			}
		}

5291
# check for redundant bracing round if etc
5292 5293
		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
			my ($level, $endln, @chunks) =
5294
				ctx_statement_full($linenr, $realcnt, 1);
5295
			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5296 5297
			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
			if ($#chunks > 0 && $level == 0) {
5298 5299
				my @allowed = ();
				my $allow = 0;
5300
				my $seen = 0;
5301
				my $herectx = $here . "\n";
5302
				my $ln = $linenr - 1;
5303 5304 5305
				for my $chunk (@chunks) {
					my ($cond, $block) = @{$chunk};

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

5310
					$allowed[$allow] = 0;
5311 5312 5313 5314 5315 5316
					#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";
5317 5318
					$ln += statement_rawlines($block) - 1;

5319
					substr($block, 0, length($cond), '');
5320 5321 5322

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

5323
					#print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5324 5325
					if (statement_lines($cond) > 1) {
						#print "APW: ALLOWED: cond<$cond>\n";
5326
						$allowed[$allow] = 1;
5327 5328
					}
					if ($block =~/\b(?:if|for|while)\b/) {
5329
						#print "APW: ALLOWED: block<$block>\n";
5330
						$allowed[$allow] = 1;
5331
					}
5332 5333
					if (statement_block_size($block) > 1) {
						#print "APW: ALLOWED: lines block<$block>\n";
5334
						$allowed[$allow] = 1;
5335
					}
5336
					$allow++;
5337
				}
5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350
				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);
					}
5351 5352 5353
				}
			}
		}
5354
		if (!defined $suppress_ifbraces{$linenr - 1} &&
5355
					$line =~ /\b(if|while|for|else)\b/) {
5356 5357 5358 5359 5360 5361 5362
			my $allowed = 0;

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

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

5367 5368
			# Check the condition.
			my ($cond, $block) = @{$chunks[0]};
5369
			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5370
			if (defined $cond) {
5371
				substr($block, 0, length($cond), '');
5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388
			}
			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) {
5389
					substr($block, 0, length($cond), '');
5390 5391 5392 5393 5394 5395 5396
				}
				if ($block =~ /^\s*\{/) {
					#print "APW: ALLOWED: chunk-1 block<$block>\n";
					$allowed = 1;
				}
			}
			if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
5397
				my $cnt = statement_rawlines($block);
5398
				my $herectx = get_stat_here($linenr, $cnt, $here);
5399

5400 5401
				WARN("BRACES",
				     "braces {} are not necessary for single statement blocks\n" . $herectx);
5402 5403 5404
			}
		}

5405
# check for single line unbalanced braces
5406 5407
		if ($sline =~ /^.\s*\}\s*else\s*$/ ||
		    $sline =~ /^.\s*else\s*\{\s*$/) {
5408 5409 5410
			CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
		}

5411
# check for unnecessary blank lines around braces
5412
		if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
5413 5414 5415 5416 5417
			if (CHK("BRACES",
				"Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
			    $fix && $prevrawline =~ /^\+/) {
				fix_delete_line($fixlinenr - 1, $prevrawline);
			}
5418
		}
5419
		if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
5420 5421 5422 5423 5424
			if (CHK("BRACES",
				"Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
			    $fix) {
				fix_delete_line($fixlinenr, $rawline);
			}
5425 5426
		}

5427
# no volatiles please
5428 5429
		my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
		if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
5430
			WARN("VOLATILE",
5431
			     "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5432 5433
		}

5434 5435 5436 5437
# 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
5438
		if ($line =~ /^\+\s*$String/ &&
5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472
		    $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);
		}

5473 5474 5475 5476
# 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
5477 5478
		if ($line =~ /^\+.*$String/ &&
		    defined($context_function) &&
5479 5480
		    get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
		    length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
5481
			WARN("EMBEDDED_FUNCTION_NAME",
5482
			     "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5483 5484
		}

5485 5486 5487 5488 5489 5490 5491 5492 5493 5494
# 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/;
			}

		}

5495
# concatenated string without spaces between elements
5496 5497 5498 5499 5500 5501 5502 5503 5504 5505
		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/;
				}
			}
5506 5507
		}

5508
# uncoalesced string fragments
5509
		if ($line =~ /$String\s*"/) {
5510 5511 5512 5513 5514 5515 5516 5517
			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;
				}
			}
5518 5519
		}

5520 5521 5522
# 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;
5523
		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5524
			my $string = substr($rawline, $-[1], $+[1] - $-[1]);
5525
			$string =~ s/%%/__/g;
5526 5527
			# check for %L
			if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
5528
				WARN("PRINTF_L",
5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540
				     "\%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",
5541 5542
				      "Prefixing 0x with decimal output is defective\n" . $herecurr);
			}
5543 5544 5545
		}

# check for line continuations in quoted strings with odd counts of "
5546
		if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
5547 5548 5549 5550
			WARN("LINE_CONTINUATIONS",
			     "Avoid line continuations in quoted strings\n" . $herecurr);
		}

5551
# warn about #if 0
5552
		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
5553 5554 5555 5556 5557 5558 5559 5560
			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);
5561 5562
		}

5563 5564
# check for needless "if (<foo>) fn(<foo>)" uses
		if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592
			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/;
					}
				}
5593 5594
			}
		}
5595

5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606
# 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");

5607 5608
			if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
			    $s !~ /\b__GFP_NOWARN\b/ ) {
5609 5610 5611 5612 5613
				WARN("OOM_MESSAGE",
				     "Possible unnecessary 'out of memory' message\n" . $hereprev);
			}
		}

5614
# check for logging functions with KERN_<LEVEL>
5615
		if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
5616 5617 5618 5619 5620 5621 5622 5623 5624
		    $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*//;
			}
		}

5625 5626 5627 5628 5629 5630
# 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);
		}

5631
# check for mask then right shift without a parentheses
5632
		if ($perl_version_ok &&
5633 5634 5635 5636 5637 5638
		    $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);
		}

5639
# check for pointer comparisons to NULL
5640
		if ($perl_version_ok) {
5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652
			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/;
				}
			}
		}

5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665
# 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) {
5666
					$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;
5667 5668 5669 5670
				}
			}
		}

5671 5672 5673 5674 5675 5676 5677 5678 5679
# 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) {
5680
				$fixed[$fixlinenr] =~
5681 5682 5683 5684 5685 5686 5687 5688 5689 5690
				    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) {
5691
				my $lead = $fixed[$fixlinenr] =~
5692 5693 5694 5695
				    /(^\+\s*(?:static\s+))/;
				$lead = rtrim($1);
				$lead = "$lead " if ($lead !~ /^\+$/);
				$lead = "${lead}const ";
5696
				$fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
5697 5698 5699
			}
		}

5700 5701 5702 5703 5704 5705 5706 5707 5708 5709
# 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//;
			}
		}

5710 5711 5712 5713 5714 5715 5716 5717 5718
# 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) {
5719
				$fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
5720 5721 5722
			}
		}

5723
# prefer usleep_range over udelay
B
Bruce Allan 已提交
5724
		if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
5725
			my $delay = $1;
5726
			# ignore udelay's < 10, however
5727
			if (! ($delay < 10) ) {
5728
				CHK("USLEEP_RANGE",
5729
				    "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
5730 5731 5732 5733
			}
			if ($delay > 2000) {
				WARN("LONG_UDELAY",
				     "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
5734 5735 5736
			}
		}

5737 5738 5739
# warn about unexpectedly long msleep's
		if ($line =~ /\bmsleep\s*\((\d+)\);/) {
			if ($1 < 20) {
5740
				WARN("MSLEEP",
5741
				     "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
5742 5743 5744
			}
		}

5745 5746 5747 5748 5749 5750
# 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);
		}

5751 5752 5753 5754 5755 5756
# 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);
		}

5757
# warn about #ifdefs in C files
5758
#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5759 5760 5761 5762 5763
#			print "#ifdef in C files should be avoided\n";
#			print "$herecurr";
#			$clean = 0;
#		}

5764
# warn about spacing in #ifdefs
5765
		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
5766 5767 5768
			if (ERROR("SPACING",
				  "exactly one space required after that #$1\n" . $herecurr) &&
			    $fix) {
5769
				$fixed[$fixlinenr] =~
5770 5771 5772
				    s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
			}

5773 5774
		}

5775
# check for spinlock_t definitions without a comment.
5776 5777
		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
5778 5779
			my $which = $1;
			if (!ctx_has_comment($first_line, $linenr)) {
5780 5781
				CHK("UNCOMMENTED_DEFINITION",
				    "$1 definition without comment\n" . $herecurr);
5782 5783 5784
			}
		}
# check for memory barriers without a comment.
5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801

		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)|
5802 5803
			smp_(?:$barrier_stems)|
			virt_(?:$barrier_stems)
5804 5805 5806
		}x;

		if ($line =~ /\b(?:$all_barriers)\s*\(/) {
5807
			if (!ctx_has_comment($first_line, $linenr)) {
5808 5809
				WARN("MEMORY_BARRIER",
				     "memory barrier without comment\n" . $herecurr);
5810 5811
			}
		}
5812

5813 5814 5815 5816 5817 5818 5819 5820 5821 5822
		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);
		}

5823 5824 5825 5826 5827 5828 5829
# 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);
			}
		}
5830

5831 5832 5833 5834 5835 5836
# 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);
		}

5837
# check of hardware specific defines
5838
		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5839 5840
			CHK("ARCH_DEFINES",
			    "architecture specific defines should be avoided\n" .  $herecurr);
5841
		}
5842

5843 5844 5845 5846 5847
# 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);
		}
5848
# Check that the storage class is at the beginning of a declaration
5849 5850 5851 5852
		if ($line =~ /\b$Storage\b/ &&
		    $line !~ /^.\s*$Storage/ &&
		    $line =~ /^.\s*(.+?)\$Storage\s/ &&
		    $1 !~ /[\,\)]\s*$/) {
5853
			WARN("STORAGE_CLASS",
5854
			     "storage class should be at the beginning of the declaration\n" . $herecurr);
5855 5856
		}

5857 5858
# check the location of the inline attribute, that it is between
# storage class and type.
5859 5860
		if ($line =~ /\b$Type\s+$Inline\b/ ||
		    $line =~ /\b$Inline\s+$Storage\b/) {
5861 5862
			ERROR("INLINE_LOCATION",
			      "inline keyword should sit between storage class and type\n" . $herecurr);
5863 5864
		}

5865
# Check for __inline__ and __inline, prefer inline
5866 5867
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b(__inline__|__inline)\b/) {
5868 5869 5870
			if (WARN("INLINE",
				 "plain inline is preferred over $1\n" . $herecurr) &&
			    $fix) {
5871
				$fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
5872 5873

			}
5874 5875
		}

5876
# Check for __attribute__ packed, prefer __packed
5877 5878
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
5879 5880
			WARN("PREFER_PACKED",
			     "__packed is preferred over __attribute__((packed))\n" . $herecurr);
5881 5882
		}

5883
# Check for __attribute__ aligned, prefer __aligned
5884 5885
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
5886 5887
			WARN("PREFER_ALIGNED",
			     "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
5888 5889
		}

5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901
# 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)/;
			}
		}

5902
# Check for __attribute__ format(printf, prefer __printf
5903 5904
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
5905 5906 5907
			if (WARN("PREFER_PRINTF",
				 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
			    $fix) {
5908
				$fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5909 5910

			}
5911 5912
		}

5913
# Check for __attribute__ format(scanf, prefer __scanf
5914 5915
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
5916 5917 5918
			if (WARN("PREFER_SCANF",
				 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
			    $fix) {
5919
				$fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5920
			}
5921 5922
		}

5923
# Check for __attribute__ weak, or __weak declarations (may have link issues)
5924
		if ($perl_version_ok &&
5925 5926 5927 5928 5929 5930 5931
		    $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);
		}

5932
# check for c99 types like uint8_t used outside of uapi/ and tools/
5933
		if ($realfile !~ m@\binclude/uapi/@ &&
5934
		    $realfile !~ m@\btools/@ &&
5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950
		    $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/;
				}
			}
		}

5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970
# 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/;
			}
		}

5971 5972
# check for sizeof(&)
		if ($line =~ /\bsizeof\s*\(\s*\&/) {
5973 5974
			WARN("SIZEOF_ADDRESS",
			     "sizeof(& should be avoided\n" . $herecurr);
5975 5976
		}

5977 5978
# check for sizeof without parenthesis
		if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
5979 5980 5981
			if (WARN("SIZEOF_PARENTHESIS",
				 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
			    $fix) {
5982
				$fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5983
			}
5984 5985
		}

5986 5987 5988 5989 5990 5991
# 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);
		}

5992
# check for seq_printf uses that could be seq_puts
J
Joe Perches 已提交
5993
		if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
5994
			my $fmt = get_quoted_string($line, $rawline);
5995 5996
			$fmt =~ s/%%//g;
			if ($fmt !~ /%/) {
5997 5998 5999
				if (WARN("PREFER_SEQ_PUTS",
					 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
				    $fix) {
6000
					$fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
6001
				}
6002 6003 6004
			}
		}

6005
# check for vsprintf extension %p<foo> misuses
6006
		if ($perl_version_ok &&
6007 6008 6009
		    defined $stat &&
		    $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
		    $1 !~ /^_*volatile_*$/) {
6010 6011
			my $stat_real;

6012 6013 6014
			my $lc = $stat =~ tr@\n@@;
			$lc = $lc + $linenr;
		        for (my $count = $linenr; $count <= $lc; $count++) {
6015 6016
				my $specifier;
				my $extension;
6017
				my $qualifier;
6018
				my $bad_specifier = "";
6019 6020
				my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
				$fmt =~ s/%%//g;
6021

6022
				while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) {
6023 6024
					$specifier = $1;
					$extension = $2;
6025
					$qualifier = $3;
6026
					if ($extension !~ /[SsBKRraEehMmIiUDdgVCbGNOxtf]/ ||
6027 6028
					    ($extension eq "f" &&
					     defined $qualifier && $qualifier !~ /^w/)) {
6029 6030 6031 6032 6033 6034 6035 6036 6037 6038
						$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");
					}
6039
				}
6040 6041 6042 6043 6044 6045 6046 6047
				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/);
					}
6048

6049 6050 6051
					WARN("VSPRINTF_POINTER_EXTENSION",
					     "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
				}
6052 6053 6054
			}
		}

6055
# Check for misused memsets
6056
		if ($perl_version_ok &&
6057
		    defined $stat &&
6058
		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
6059 6060

			my $ms_addr = $2;
6061 6062
			my $ms_val = $7;
			my $ms_size = $12;
6063 6064 6065

			if ($ms_size =~ /^(0x|)0$/i) {
				ERROR("MEMSET",
6066
				      "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
6067 6068
			} elsif ($ms_size =~ /^(0x|)1$/i) {
				WARN("MEMSET",
6069 6070 6071 6072
				     "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
			}
		}

6073
# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
6074
#		if ($perl_version_ok &&
6075 6076 6077 6078 6079 6080 6081 6082
#		    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)/;
#			}
#		}
6083

6084
# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
6085
#		if ($perl_version_ok &&
6086 6087 6088 6089 6090
#		    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")
#		}
6091

6092 6093
# 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
6094
#		if ($perl_version_ok &&
6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113
#		    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)/;
#				}
#			}
#		}
6114

6115
# typecasts on min/max could be min_t/max_t
6116
		if ($perl_version_ok &&
6117
		    defined $stat &&
6118
		    $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
6119
			if (defined $2 || defined $7) {
6120 6121 6122
				my $call = $1;
				my $cast1 = deparenthesize($2);
				my $arg1 = $3;
6123 6124
				my $cast2 = deparenthesize($7);
				my $arg2 = $8;
6125 6126
				my $cast;

6127
				if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
6128 6129 6130 6131 6132 6133 6134 6135
					$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");
6136 6137 6138
			}
		}

6139
# check usleep_range arguments
6140
		if ($perl_version_ok &&
6141 6142 6143 6144 6145 6146
		    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",
6147
				     "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6148 6149 6150
			} elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
				 $min > $max) {
				WARN("USLEEP_RANGE",
6151
				     "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6152 6153 6154
			}
		}

6155
# check for naked sscanf
6156
		if ($perl_version_ok &&
6157
		    defined $stat &&
6158
		    $line =~ /\bsscanf\b/ &&
6159 6160 6161 6162 6163
		    ($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;
6164
			my $stat_real = get_stat_real($linenr, $lc);
6165 6166 6167 6168
			WARN("NAKED_SSCANF",
			     "unchecked sscanf return value\n" . "$here\n$stat_real\n");
		}

6169
# check for simple sscanf that should be kstrto<foo>
6170
		if ($perl_version_ok &&
6171 6172 6173 6174
		    defined $stat &&
		    $line =~ /\bsscanf\b/) {
			my $lc = $stat =~ tr@\n@@;
			$lc = $lc + $linenr;
6175
			my $stat_real = get_stat_real($linenr, $lc);
6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186
			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");
				}
			}
		}

6187 6188 6189
# check for new externs in .h files.
		if ($realfile =~ /\.h$/ &&
		    $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
6190 6191
			if (CHK("AVOID_EXTERNS",
				"extern prototypes should be avoided in .h files\n" . $herecurr) &&
6192
			    $fix) {
6193
				$fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
6194 6195 6196
			}
		}

6197
# check for new externs in .c files.
6198
		if ($realfile =~ /\.c$/ && defined $stat &&
6199
		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
6200
		{
6201 6202
			my $function_name = $1;
			my $paren_space = $2;
6203 6204 6205 6206 6207

			my $s = $stat;
			if (defined $cond) {
				substr($s, 0, length($cond), '');
			}
6208 6209 6210
			if ($s =~ /^\s*;/ &&
			    $function_name ne 'uninitialized_var')
			{
6211 6212
				WARN("AVOID_EXTERNS",
				     "externs should be avoided in .c files\n" .  $herecurr);
6213 6214 6215
			}

			if ($paren_space =~ /\n/) {
6216 6217
				WARN("FUNCTION_ARGUMENTS",
				     "arguments for function declarations should follow identifier\n" . $herecurr);
6218
			}
6219 6220 6221 6222

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

6227 6228
# check for function declarations that have arguments without identifier names
		if (defined $stat &&
6229
		    $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240
		    $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);
				}
			}
		}

6241
# check for function definitions
6242
		if ($perl_version_ok &&
6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263
		    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);
			}
		}

6264 6265 6266 6267 6268
# checks for new __setup's
		if ($rawline =~ /\b__setup\("([^"]*)"/) {
			my $name = $1;

			if (!grep(/$name/, @setup_docs)) {
6269
				CHK("UNDOCUMENTED_SETUP",
6270
				    "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
6271
			}
6272
		}
6273

6274 6275
# check for pointless casting of alloc functions
		if ($line =~ /\*\s*\)\s*$allocFunctions\b/) {
6276 6277
			WARN("UNNECESSARY_CASTS",
			     "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6278
		}
6279

6280 6281
# alloc style
# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6282
		if ($perl_version_ok &&
6283
		    $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6284 6285 6286 6287
			CHK("ALLOC_SIZEOF_STRUCT",
			    "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
		}

6288
# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6289
		if ($perl_version_ok &&
6290 6291
		    defined $stat &&
		    $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6292 6293 6294 6295 6296
			my $oldfunc = $3;
			my $a1 = $4;
			my $a2 = $10;
			my $newfunc = "kmalloc_array";
			$newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
6297 6298 6299 6300 6301 6302 6303 6304
			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_]*$/)) {
6305
				my $cnt = statement_rawlines($stat);
6306 6307
				my $herectx = get_stat_here($linenr, $cnt, $here);

6308
				if (WARN("ALLOC_WITH_MULTIPLY",
6309 6310
					 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
				    $cnt == 1 &&
6311
				    $fix) {
6312
					$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;
6313 6314 6315 6316
				}
			}
		}

6317
# check for krealloc arg reuse
6318
		if ($perl_version_ok &&
6319 6320
		    $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ &&
		    $1 eq $3) {
6321 6322 6323 6324
			WARN("KREALLOC_ARG_REUSE",
			     "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
		}

6325 6326 6327 6328 6329 6330
# 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);
		}

6331 6332
# check for multiple semicolons
		if ($line =~ /;\s*;\s*$/) {
6333 6334 6335
			if (WARN("ONE_SEMICOLON",
				 "Statements terminations use 1 semicolon\n" . $herecurr) &&
			    $fix) {
6336
				$fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
6337
			}
6338 6339
		}

6340 6341 6342
# 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*\)?/) {
6343 6344 6345 6346 6347 6348 6349 6350 6351
			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)/;
			}
		}

6352 6353 6354 6355 6356 6357 6358 6359 6360 6361
# 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)";
			}
		}

6362
# check for case / default statements not preceded by break/fallthrough/switch
6363 6364 6365 6366 6367
		if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
			my $has_break = 0;
			my $has_statement = 0;
			my $count = 0;
			my $prevline = $linenr;
6368
			while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
6369 6370 6371 6372 6373 6374 6375 6376 6377 6378
				$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++;
6379
				$has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
6380 6381 6382
			}
			if (!$has_break && $has_statement) {
				WARN("MISSING_BREAK",
6383
				     "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
6384 6385 6386
			}
		}

6387
# check for switch/default statements without a break;
6388
		if ($perl_version_ok &&
6389 6390 6391
		    defined $stat &&
		    $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
			my $cnt = statement_rawlines($stat);
6392 6393
			my $herectx = get_stat_here($linenr, $cnt, $here);

6394 6395
			WARN("DEFAULT_NO_BREAK",
			     "switch default: should use break\n" . $herectx);
6396 6397
		}

6398
# check for gcc specific __FUNCTION__
6399 6400 6401 6402
		if ($line =~ /\b__FUNCTION__\b/) {
			if (WARN("USE_FUNC",
				 "__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr) &&
			    $fix) {
6403
				$fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
6404
			}
6405
		}
6406

6407 6408 6409 6410 6411 6412
# 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 已提交
6413 6414 6415 6416 6417 6418
# 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);
		}

6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445
# 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);

			}
		}

6446 6447
# check for semaphores initialized locked
		if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
6448 6449
			WARN("CONSIDER_COMPLETION",
			     "consider using a completion\n" . $herecurr);
6450
		}
6451

6452 6453
# recommend kstrto* over simple_strto* and strict_strto*
		if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
6454
			WARN("CONSIDER_KSTRTO",
6455
			     "$1 is obsolete, use k$3 instead\n" . $herecurr);
6456
		}
6457

6458
# check for __initcall(), use device_initcall() explicitly or more appropriate function please
6459
		if ($line =~ /^.\s*__initcall\s*\(/) {
6460
			WARN("USE_DEVICE_INITCALL",
6461
			     "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6462
		}
6463

6464 6465 6466 6467 6468 6469
# 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);
		}

6470 6471 6472 6473 6474 6475 6476 6477
# 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);
		}

6478
# check for various structs that are normally const (ops, kgdb, device_tree)
6479
# and avoid what seem like struct definitions 'struct foo {'
6480
		if ($line !~ /\bconst\b/ &&
6481
		    $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
6482
			WARN("CONST_STRUCT",
6483
			     "struct $1 should normally be const\n" . $herecurr);
6484
		}
6485 6486 6487 6488

# 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/ &&
6489 6490
		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
6491 6492 6493
		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
6494
		{
6495 6496
			WARN("NR_CPUS",
			     "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6497
		}
6498

6499 6500 6501 6502 6503 6504
# 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);
		}

6505
# likely/unlikely comparisons similar to "(likely(foo) > 0)"
6506
		if ($perl_version_ok &&
6507 6508 6509 6510 6511
		    $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
			WARN("LIKELY_MISUSE",
			     "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
		}

6512 6513 6514 6515 6516 6517
# 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);
		}

6518 6519 6520
# whine mightly about in_atomic
		if ($line =~ /\bin_atomic\s*\(/) {
			if ($realfile =~ m@^drivers/@) {
6521 6522
				ERROR("IN_ATOMIC",
				      "do not use in_atomic in drivers\n" . $herecurr);
6523
			} elsif ($realfile !~ m@^kernel/@) {
6524 6525
				WARN("IN_ATOMIC",
				     "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
6526 6527
			}
		}
6528

6529 6530 6531 6532 6533 6534
# check for mutex_trylock_recursive usage
		if ($line =~ /mutex_trylock_recursive/) {
			ERROR("LOCKING",
			      "recursive locking is bad, do not use this ever.\n" . $herecurr);
		}

6535 6536 6537 6538 6539 6540
# 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@) {
6541 6542
				ERROR("LOCKDEP",
				      "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
6543 6544
			}
		}
6545

6546 6547
		if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
		    $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
6548 6549
			WARN("EXPORTED_WORLD_WRITABLE",
			     "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6550
		}
6551

6552 6553 6554
# 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
6555
		if ($perl_version_ok &&
6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608
		    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);
			}
		}

6609 6610
# Mode permission misuses where it seems decimal should be octal
# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6611 6612 6613 6614
# 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
6615
		if ($perl_version_ok &&
6616
		    defined $stat &&
6617 6618 6619 6620 6621
		    $line =~ /$mode_perms_search/) {
			foreach my $entry (@mode_permission_funcs) {
				my $func = $entry->[0];
				my $arg_pos = $entry->[1];

6622 6623
				my $lc = $stat =~ tr@\n@@;
				$lc = $lc + $linenr;
6624
				my $stat_real = get_stat_real($linenr, $lc);
6625

6626 6627 6628 6629 6630
				my $skip_args = "";
				if ($arg_pos > 1) {
					$arg_pos--;
					$skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
				}
6631
				my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
6632
				if ($stat =~ /$test/) {
6633 6634
					my $val = $1;
					$val = $6 if ($skip_args ne "");
6635 6636 6637
					if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
					    (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
					     ($val =~ /^$Octal$/ && length($val) ne 4))) {
6638
						ERROR("NON_OCTAL_PERMISSIONS",
6639
						      "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
6640 6641
					}
					if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
6642
						ERROR("EXPORTED_WORLD_WRITABLE",
6643
						      "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6644
					}
6645 6646 6647
				}
			}
		}
6648

6649
# check for uses of S_<PERMS> that could be octal for readability
6650
		while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
6651 6652
			my $oval = $1;
			my $octal = perms_to_octal($oval);
6653 6654 6655
			if (WARN("SYMBOLIC_PERMS",
				 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
			    $fix) {
6656
				$fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
6657 6658 6659
			}
		}

6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676
# 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);
			}
		}
6677 6678 6679 6680 6681 6682

# 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);
		}
6683 6684 6685 6686 6687 6688
	}

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

6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702
	# 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);
	}

6703
	if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
6704 6705
		ERROR("NOT_UNIFIED_DIFF",
		      "Does not appear to be a unified-diff format patch\n");
6706
	}
6707 6708 6709 6710 6711 6712 6713 6714
	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");
		}
6715 6716
	}

6717
	print report_dump();
6718 6719
	if ($summary && !($clean == 1 && $quiet == 1)) {
		print "$filename " if ($summary_file);
6720 6721 6722
		print "total: $cnt_error errors, $cnt_warn warnings, " .
			(($check)? "$cnt_chk checks, " : "") .
			"$cnt_lines lines checked\n";
6723
	}
6724

6725
	if ($quiet == 0) {
6726 6727 6728 6729 6730 6731 6732 6733
		# 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
		}
6734 6735 6736
		# If there were whitespace errors which cleanpatch can fix
		# then suggest that.
		if ($rpt_cleaners) {
6737
			$rpt_cleaners = 0;
6738 6739 6740 6741 6742
			print << "EOM"

NOTE: Whitespace errors detected.
      You may wish to use scripts/cleanpatch or scripts/cleanfile
EOM
6743 6744 6745
		}
	}

6746 6747 6748
	if ($clean == 0 && $fix &&
	    ("@rawlines" ne "@fixed" ||
	     $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
6749 6750
		my $newfile = $filename;
		$newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
6751 6752 6753
		my $linecount = 0;
		my $f;

6754 6755
		@fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);

6756 6757 6758 6759 6760 6761 6762
		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/^\+//;
6763
					print $f $fixed_line . "\n";
6764 6765 6766 6767 6768 6769 6770 6771 6772
				}
			} else {
				print $f $fixed_line . "\n";
			}
		}
		close($f);

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

6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784
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
		}
	}

6785 6786 6787 6788 6789 6790 6791
	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";
		}
6792 6793 6794
	}
	return $clean;
}