checkpatch.pl 199.8 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
our %maintained_status = ();

879 880 881
sub is_maintained_obsolete {
	my ($filename) = @_;

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

884 885 886
	if (!exists($maintained_status{$filename})) {
		$maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
	}
887

888
	return $maintained_status{$filename} =~ /obsolete/i;
889 890
}

891 892 893
sub is_SPDX_License_valid {
	my ($license) = @_;

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

896 897
	my $root_path = abs_path($root);
	my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`;
898 899 900 901
	return 0 if ($status ne "");
	return 1;
}

902 903 904 905 906
my $camelcase_seeded = 0;
sub seed_camelcase_includes {
	return if ($camelcase_seeded);

	my $files;
907 908 909 910
	my $camelcase_cache = "";
	my @include_files = ();

	$camelcase_seeded = 1;
911

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

940
	if (-e ".git") {
941
		$files = `${git_command} ls-files "include/*.h"`;
942 943 944
		@include_files = split('\n', $files);
	}

945 946 947
	foreach my $file (@include_files) {
		seed_camelcase_file($file);
	}
948

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

960 961 962 963 964
sub git_commit_info {
	my ($commit, $id, $desc) = @_;

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

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

969 970
	return ($id, $desc) if ($#lines < 0);

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

	return ($id, $desc);
}

991 992
$chk_signoff = 0 if ($file);

993
my @rawlines = ();
994
my @lines = ();
995
my @fixed = ();
996 997
my @fixed_inserted = ();
my @fixed_deleted = ();
998 999
my $fixlinenr = -1;

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

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

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

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

1078
if (!$quiet) {
1079 1080 1081
	hash_show_words(\%use_type, "Used");
	hash_show_words(\%ignore_type, "Ignored");

1082
	if (!$perl_version_ok) {
1083 1084 1085
		print << "EOM"

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

1098 1099 1100
exit($exit);

sub top_of_kernel_tree {
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112
	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;
		}
1113
	}
1114
	return 1;
1115
}
1116

1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133
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;
1134
		$formatted_email =~ s/\Q$address\E.*$//;
1135
		$name = $formatted_email;
1136
		$name = trim($name);
1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150
		$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 = "";
		}
	}

1151
	$name = trim($name);
1152
	$name =~ s/^\"|\"$//g;
1153
	$address = trim($address);
1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168
	$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;

1169
	$name = trim($name);
1170
	$name =~ s/^\"|\"$//g;
1171
	$address = trim($address);
1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186

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

1187
sub which {
1188
	my ($bin) = @_;
1189

1190 1191 1192 1193
	foreach my $path (split(/:/, $ENV{PATH})) {
		if (-e "$path/$bin") {
			return "$path/$bin";
		}
1194 1195
	}

1196
	return "";
1197 1198
}

1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210
sub which_conf {
	my ($conf) = @_;

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

	return "";
}

1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230
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;
}
1231
sub copy_spacing {
1232
	(my $res = shift) =~ tr/\t/ /c;
1233 1234
	return $res;
}
1235

1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248
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));
}

1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259
my $sanitise_quote = '';

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

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
1260 1261 1262 1263 1264 1265
sub sanitise_line {
	my ($line) = @_;

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

1266
	my $qlen = 0;
1267 1268
	my $off = 0;
	my $c;
1269

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

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

			substr($res, $off, 2, $sanitise_quote);
			$off++;
			next;
		}
1298 1299 1300 1301 1302 1303 1304

		# 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;
1305
		}
1306 1307 1308 1309
		# Regular quotes.
		if ($c eq "'" || $c eq '"') {
			if ($sanitise_quote eq '') {
				$sanitise_quote = $c;
1310

1311 1312 1313 1314 1315 1316
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
1317

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

1330 1331 1332 1333
	if ($sanitise_quote eq '//') {
		$sanitise_quote = '';
	}

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

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

1345 1346 1347 1348 1349
	if ($allow_c99_comments && $res =~ m@(//.*$)@) {
		my $match = $1;
		$res =~ s/\Q$match\E/"$;" x length($match)/e;
	}

1350 1351 1352
	return $res;
}

1353 1354 1355
sub get_quoted_string {
	my ($line, $rawline) = @_;

1356
	return "" if (!defined($line) || !defined($rawline));
1357
	return "" if ($line !~ m/($String)/g);
1358 1359 1360
	return substr($rawline, $-[0], $+[0] - $-[0]);
}

1361 1362 1363 1364 1365 1366
sub ctx_statement_block {
	my ($linenr, $remain, $off) = @_;
	my $line = $linenr - 1;
	my $blk = '';
	my $soff = $off;
	my $coff = $off - 1;
1367
	my $coff_set = 0;
1368

1369 1370
	my $loff = 0;

1371 1372
	my $type = '';
	my $level = 0;
1373
	my @stack = ();
1374
	my $p;
1375 1376
	my $c;
	my $len = 0;
1377 1378

	my $remainder;
1379
	while (1) {
1380 1381
		@stack = (['', 0]) if ($#stack == -1);

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

1410
		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1411 1412 1413 1414 1415 1416 1417 1418 1419 1420

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

1421 1422 1423 1424 1425 1426
		# Statement ends at the ';' or a close '}' at the
		# outermost level.
		if ($level == 0 && $c eq ';') {
			last;
		}

1427
		# An else is really a conditional as long as its not else if
1428 1429 1430 1431 1432 1433 1434 1435
		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";
1436 1437
		}

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

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

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

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

1489
	#print "coff<$coff> soff<$off> loff<$loff>\n";
1490 1491 1492 1493 1494

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

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 1534 1535 1536 1537
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;
	}
}

1538 1539 1540 1541 1542 1543
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

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

	return ($level, $linenr, @chunks);
1565 1566
}

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

1576
	my $level = 0;
1577
	my @stack = ($level);
1578 1579 1580 1581 1582
	for ($line = $start; $remain > 0; $line++) {
		next if ($rawlines[$line] =~ /^-/);
		$remain--;

		$blk .= $rawlines[$line];
1583 1584

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

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

1600 1601 1602 1603 1604 1605 1606
			if ($c eq $close && $level > 0) {
				$level--;
				last if ($level == 0);
			} elsif ($c eq $open) {
				$level++;
			}
		}
1607

1608
		if (!$outer || $level <= 1) {
1609
			push(@res, $rawlines[$line]);
1610 1611
		}

1612
		last if ($level == 0);
1613 1614
	}

1615
	return ($level, @res);
1616 1617 1618 1619
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

1620 1621
	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
	return @r;
1622 1623 1624 1625
}
sub ctx_block {
	my ($linenr, $remain) = @_;

1626 1627
	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
	return @r;
1628 1629
}
sub ctx_statement {
1630 1631 1632 1633 1634 1635
	my ($linenr, $remain, $off) = @_;

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

1638
	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1639
}
1640 1641 1642 1643 1644
sub ctx_statement_level {
	my ($linenr, $remain, $off) = @_;

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
1645 1646 1647 1648 1649

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

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

1682
	##print "LINE: $rawlines[$end_line - 1 ]\n";
1683 1684 1685 1686 1687
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703
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;
}

1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714
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;
}

1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725
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;
}

1726 1727 1728
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
1729

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

1740
	return $res;
1741 1742
}

1743
my $av_preprocessor = 0;
1744
my $av_pending;
1745
my @av_paren_type;
1746
my $av_pend_colon;
1747 1748 1749

sub annotate_reset {
	$av_preprocessor = 0;
1750 1751
	$av_pending = '_';
	@av_paren_type = ('E');
1752
	$av_pend_colon = 'O';
1753 1754
}

1755 1756
sub annotate_values {
	my ($stream, $type) = @_;
1757

1758
	my $res;
1759
	my $var = '_' x length($stream);
1760 1761
	my $cur = $stream;

1762
	print "$stream\n" if ($dbg_values > 1);
1763 1764

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

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

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

1784 1785 1786 1787
		} elsif ($cur =~ /^($Modifier)\s*/) {
			print "MODIFIER($1)\n" if ($dbg_values > 1);
			$type = 'T';

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

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

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

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
1808
			$type = 'E';
1809

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

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

1816
			$type = 'E';
1817

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

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

1832 1833 1834 1835 1836
		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
			print "ATTR($1)\n" if ($dbg_values > 1);
			$av_pending = $type;
			$type = 'N';

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

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

1849 1850 1851 1852 1853
		} elsif ($cur =~/^(case)/o) {
			print "CASE($1)\n" if ($dbg_values > 1);
			$av_pend_colon = 'C';
			$type = 'N';

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

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

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

1874
		} elsif ($cur =~ /^($Ident)\s*\(/o) {
1875
			print "FUNC($1)\n" if ($dbg_values > 1);
1876
			$type = 'V';
1877
			$av_pending = 'V';
1878

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

1888
		} elsif ($cur =~ /^($Ident|$Constant)/o) {
1889
			print "IDENT($1)\n" if ($dbg_values > 1);
1890 1891 1892
			$type = 'V';

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

1896
		} elsif ($cur =~/^(;|{|})/) {
1897
			print "END($1)\n" if ($dbg_values > 1);
1898
			$type = 'E';
1899 1900
			$av_pend_colon = 'O';

1901 1902 1903 1904
		} elsif ($cur =~/^(,)/) {
			print "COMMA($1)\n" if ($dbg_values > 1);
			$type = 'C';

1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918
		} 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';
1919

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

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

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

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

1952
	return ($res, $var);
1953 1954
}

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

		} else {
			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1994
			push(@typeListFile, $possible);
1995
		}
1996
		build_types();
1997 1998
	} else {
		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1999 2000 2001
	}
}

2002 2003
my $prefix = '';

2004
sub show_type {
2005
	my ($type) = @_;
2006

2007 2008
	$type =~ tr/[a-z]/[A-Z]/;

2009 2010 2011
	return defined $use_type{$type} if (scalar keys %use_type > 0);

	return !defined $ignore_type{$type};
2012 2013
}

2014
sub report {
2015 2016 2017 2018
	my ($level, $type, $msg) = @_;

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

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

2046
	push(our @report, $output);
2047 2048

	return 1;
2049
}
2050

2051
sub report_dump {
2052
	our @report;
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 2083 2084 2085 2086
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
2087
		if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) {	#new filename
2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117
			$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;
}

2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138
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);
}

2139
sub ERROR {
2140 2141 2142
	my ($type, $msg) = @_;

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

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

	if ($check && report("CHECK", $type, $msg)) {
2163 2164
		our $clean = 0;
		our $cnt_chk++;
2165
		return 1;
2166
	}
2167
	return 0;
2168 2169
}

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

2198 2199 2200
sub trim {
	my ($string) = @_;

2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217
	$string =~ s/^\s+|\s+$//g;

	return $string;
}

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

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

	return $string;
}

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

	$string =~ s/\s+$//;
2218 2219 2220 2221

	return $string;
}

2222 2223 2224 2225 2226 2227 2228 2229
sub string_find_replace {
	my ($string, $find, $replace) = @_;

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

	return $string;
}

2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244
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";
}

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

2272
	return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
2273 2274
}

2275 2276 2277 2278 2279
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
2280
	my $prevrawline="";
2281
	my $stashline="";
2282
	my $stashrawline="";
2283

2284
	my $length;
2285 2286 2287 2288
	my $indent;
	my $previndent=0;
	my $stashindent=0;

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

2305
	my $last_blank_line = 0;
2306
	my $last_coalesced_string_linenr = -1;
2307

2308
	our @report = ();
2309 2310 2311 2312 2313
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

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

2325 2326 2327
	my $prev_values = 'E';

	# suppression flags
2328
	my %suppress_ifbraces;
2329
	my %suppress_whiletrailers;
2330
	my %suppress_export;
2331
	my $suppress_statement = 0;
2332

2333
	my %signatures = ();
2334

2335
	# Pre-scan the patch sanitizing the lines.
2336
	# Pre-scan the patch looking for any __setup documentation.
2337
	#
2338 2339
	my @setup_docs = ();
	my $setup_docs = 0;
2340

2341 2342
	my $camelcase_file_seeded = 0;

2343 2344
	my $checklicenseline = 1;

2345
	sanitise_line_reset();
2346 2347
	my $line;
	foreach my $rawline (@rawlines) {
2348 2349
		$linenr++;
		$line = $rawline;
2350

2351 2352
		push(@fixed, $rawline) if ($fix);

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

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

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

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

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

		#print "==>$rawline\n";
		#print "-->$line\n";
2418 2419 2420 2421 2422 2423

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

2424 2425
	$prefix = '';

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

2435
		my $rawline = $rawlines[$linenr - 1];
2436

2437 2438 2439 2440 2441 2442 2443 2444
# 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;
		}

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

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

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

2478
			# Measure the line length and indent.
2479
			($length, $indent) = line_stats($rawline);
2480 2481 2482 2483

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

2486
			#warn "line<$line>\n";
2487

2488 2489
		} elsif ($realcnt == 1) {
			$realcnt--;
2490 2491
		}

2492 2493
		my $hunk_line = ($realcnt != 0);

2494 2495
		$here = "#$linenr: " if (!$file);
		$here = "#$realline: " if ($file);
2496

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

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

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

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

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

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

2558 2559 2560
			next;
		}

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

2563 2564 2565
		my $hereline = "$here\n$rawline\n";
		my $herecurr = "$here\n$rawline\n";
		my $hereprev = "$here\n$prevrawline\n$rawline\n";
2566

2567 2568
		$cnt_lines++ if ($realcnt != 0);

2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580
# 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
		}

2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591
# 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;
		}

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

2602 2603 2604 2605 2606 2607 2608
# 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;
		}

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

2622 2623 2624 2625 2626 2627
# 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;
		}

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

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

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

			my ($email_name, $email_address, $comment) = parse_email($email);
			my $suggested_email = format_email(($email_name, $email_address));
			if ($suggested_email eq "") {
2670 2671
				ERROR("BAD_SIGN_OFF",
				      "Unrecognized email address: '$email'\n" . $herecurr);
2672 2673 2674 2675 2676 2677 2678 2679 2680
			} 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) {
2681 2682
					WARN("BAD_SIGN_OFF",
					     "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2683
				}
2684
			}
2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695

# 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;
			}
2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713

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

2716 2717 2718 2719 2720 2721 2722
# 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);
		}

2723 2724 2725 2726 2727 2728
# 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);
		}

2729 2730 2731 2732 2733
# 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
2734 2735 2736 2737
		     $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
2738 2739 2740
			$commit_log_possible_stack_dump = 1;
		}

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

2756
# Reset possible stack dump if a blank line is found
2757 2758 2759 2760
		if ($in_commit_log && $commit_log_possible_stack_dump &&
		    $line =~ /^\s*$/) {
			$commit_log_possible_stack_dump = 0;
		}
2761

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

2782 2783 2784 2785 2786 2787 2788
			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);
			}

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

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

2814 2815
			if (defined($id) &&
			   ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
2816 2817 2818
				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);
			}
2819 2820
		}

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

2833 2834 2835 2836 2837 2838 2839 2840
# 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");
		}

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

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

2857 2858
			CHK("INVALID_UTF8",
			    "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2859 2860
		}

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

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

2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898
# 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);
				}
			}
		}

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

2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927
# 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);
			}
		}

2928 2929
# ignore non-hunk lines and lines being removed
		next if (!$hunk_line || $line =~ /^-/);
2930 2931

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

2947
			$rpt_cleaners = 1;
2948
		}
2949

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

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

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

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

2994
				$f =~ s/^.//;
2995 2996 2997
				$f =~ s/#.*//;
				$f =~ s/^\s+//;
				next if ($f =~ /^$/);
2998 2999 3000 3001 3002 3003 3004

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

3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027
# 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/;
			}
		}

3028 3029 3030 3031 3032 3033 3034
# 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);
		}

3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048
		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});
		}

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

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

3056
			my $dt_path = $root . "/Documentation/devicetree/bindings/";
3057
			my $vp_file = $dt_path . "vendor-prefixes.yaml";
3058

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

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

3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095
# 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 = '..';
				}

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

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

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

3121 3122 3123 3124 3125 3126 3127 3128
# 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);
		}

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

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

3162 3163 3164
			# More special cases
			} elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
				 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
3165 3166
				$msg_type = "";

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

3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188
			# 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);
			}
3189 3190
		}

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

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

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

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

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

3232 3233 3234 3235 3236 3237
# 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);
		}

3238
# check indentation starts on a tab stop
3239
		if ($perl_version_ok &&
3240
		    $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3241 3242 3243 3244 3245 3246 3247 3248 3249 3250
			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;
				}
			}
		}

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

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

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

				if ($newindent ne $goodtabindent &&
				    $newindent ne $goodspaceindent) {
3270 3271 3272 3273

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

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

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

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

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

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

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

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

3381 3382 3383
			$last_blank_line = $linenr;
		}

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

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

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

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

3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458
# 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;
		}

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

3473 3474 3475 3476 3477 3478 3479 3480 3481 3482
# 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);
			}
		}

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

3489 3490 3491 3492 3493 3494
# 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);
		}

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

3506 3507 3508 3509 3510 3511 3512 3513 3514
#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;
			}
3515

3516 3517 3518 3519 3520 3521 3522 3523
			# 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++;
			}

3524 3525
			my $s = $stat;
			$s =~ s/{.*$//s;
3526

3527
			# Ignore goto labels.
3528
			if ($s =~ /$Ident:\*$/s) {
3529 3530

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

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

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

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

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

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

3557
				my $ctx = $s;
3558
				substr($ctx, 0, $name_len + 1, '');
3559
				$ctx =~ s/\)[^\)]*$//;
3560

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

3564
						possible($1, "D:" . $s);
3565 3566
					}
				}
3567
			}
3568

3569 3570
		}

3571 3572 3573
#
# Checks which may be anchored in the context.
#
3574

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

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

3603
			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
3604 3605 3606 3607 3608 3609

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

3610 3611 3612
			my $ctx_cnt = $realcnt - $#ctx - 1;
			my $ctx = join("\n", @ctx);

3613 3614
			my $ctx_ln = $linenr;
			my $ctx_skip = $realcnt;
3615

3616 3617 3618 3619 3620
			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] !~ /^-/);
3621 3622
				$ctx_ln++;
			}
3623

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

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

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

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

3654 3655 3656
			# remove inline comments
			$s =~ s/$;/ /g;
			$c =~ s/$;/ /g;
3657 3658

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

3662 3663 3664 3665 3666 3667 3668 3669
			# 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;
			}

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

3694
			my $cond_ptr = -1;
3695
			$continuation = 0;
3696 3697 3698
			while ($cond_ptr != $cond_lines) {
				$cond_ptr = $cond_lines;

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

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

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

3733
			#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";
3734

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

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

3759
#ignore lines not being added
3760
		next if ($line =~ /^[^\+]/);
3761

3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773
# 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);
		}

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

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

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

3838 3839 3840 3841 3842
#
# Checks which are anchored on the added line.
#

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

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

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

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

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

3934 3935 3936 3937 3938 3939 3940
# 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);
		}

3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960
# 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/;
			}
		}

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

# 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/;
			}
		}
3976 3977 3978

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

3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995
# 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);
			}
		}

3996 3997 3998 3999 4000 4001 4002
# 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);
               }

4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015
# 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)/;
				}
			}
		}

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

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

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

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

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

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

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

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

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

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

4112 4113 4114 4115
# 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);
4116 4117
		}

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

4128 4129 4130 4131 4132 4133 4134 4135 4136
		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);
		}

4137 4138 4139 4140 4141 4142 4143 4144
# 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);
		}

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

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

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

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

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

# unnecessary space "type  (*funcptr)(args...)"
4221 4222 4223 4224 4225 4226 4227 4228 4229
# 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);
#			}
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 4256 4257 4258 4259

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

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

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

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

			# cpp #elif statement condition may start with a (
4302
			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
4303 4304 4305

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

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

4318
# Check operator spacing.
4319
		if (!($line=~/\#\s*include/)) {
4320 4321 4322
			my $fixed_line = "";
			my $line_fixed = 0;

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

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

			my @fix_elements = ();
4338
			my $off = 0;
4339

4340 4341 4342 4343 4344 4345 4346
			foreach my $el (@elements) {
				push(@fix_elements, substr($rawline, $off, length($el)));
				$off += length($el);
			}

			$off = 0;

4347
			my $blank = copy_spacing($opline);
4348
			my $last_after = -1;
4349

4350
			for (my $n = 0; $n < $#elements; $n += 2) {
4351 4352 4353 4354 4355

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

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

4356 4357
				$off += length($elements[$n]);

L
Lucas De Marchi 已提交
4358
				# Pick up the preceding and succeeding characters.
4359 4360 4361 4362 4363 4364 4365
				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";

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

4374
				my $op = $elements[$n + 1];
4375 4376

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

4388 4389 4390 4391
				my $ctx = "${a}x${c}";

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

4392
				my $ptr = substr($blank, 0, $off) . "^";
4393
				my $hereptr = "$hereline$ptr\n";
4394

4395
				# Pull out the value of this operator.
4396
				my $op_type = substr($curr_values, $off + 1, 1);
4397

4398 4399 4400
				# Get the full operator variant.
				my $opv = $op . substr($curr_vars, $off, 1);

4401 4402
				# Ignore operators passed as parameters.
				if ($op_type ne 'V' &&
4403
				    $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
4404

4405 4406
#				# Ignore comments
#				} elsif ($op =~ /^$;+$/) {
4407

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

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

4422 4423 4424 4425
				#   :   when part of a bitfield
				} elsif ($opv eq ':B') {
					# skip the bitfield test for now

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

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

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

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

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

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

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

4575
				# All the others need spaces both sides.
4576
				} elsif ($ctx !~ /[EWC]x[CWE]/) {
4577 4578
					my $ok = 0;

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

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

4596
					# messages are ERROR, but ?: are CHK
4597
					if ($ok == 0) {
4598 4599
						my $msg_level = \&ERROR;
						$msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4600

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

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

				$fixed_line = $fixed_line . $good;
			}

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

4622 4623
			if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
				$fixed[$fixlinenr] = $fixed_line;
4624 4625 4626
			}


4627 4628
		}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

4929 4930
				$stat_real = raw_line($linenr, $cond_lines)
							. "\n" if ($cond_lines);
4931 4932 4933 4934
				if (defined($stat_real) && $cond_lines > 1) {
					$stat_real = "[...]\n$stat_real";
				}

4935 4936
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr . $stat_real);
4937 4938 4939
			}
		}

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

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

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

5002 5003
		if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
		    $previndent == $indent) {
5004 5005 5006 5007
			my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);

			# Find out what is on the end of the line after the
			# conditional.
5008
			substr($s, 0, length($c), '');
5009 5010 5011
			$s =~ s/\n.*//g;

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

5027
#Specific variable tests
5028 5029
		while ($line =~ m{($Constant|$Lval)}g) {
			my $var = $1;
5030 5031

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

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

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

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

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

5111 5112 5113 5114 5115 5116 5117 5118
			$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;
5119
				$define_args =~ s/\\\+?//g;
5120 5121 5122
				@def_args = split(",", $define_args);
			}

5123
			$dstat =~ s/$;//g;
5124 5125 5126
			$dstat =~ s/\\\n.//g;
			$dstat =~ s/^\s*//s;
			$dstat =~ s/\s*$//s;
5127

5128
			# Flatten any parentheses and braces
5129 5130
			while ($dstat =~ s/\([^\(\)]*\)/1/ ||
			       $dstat =~ s/\{[^\{\}]*\}/1/ ||
5131
			       $dstat =~ s/.\[[^\[\]]*\]/1/)
5132
			{
5133
			}
5134

5135
			# Flatten any obvious string concatentation.
5136 5137
			while ($dstat =~ s/($String)\s*$Ident/$1/ ||
			       $dstat =~ s/$Ident\s*($String)/$1/)
5138 5139 5140
			{
			}

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

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

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

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

			}
5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207

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

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

5230 5231 5232 5233
# 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);
5234
				my $herectx = get_stat_here($linenr, $cnt, $here);
5235 5236 5237 5238 5239

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

5240
# check for line continuations outside of #defines, preprocessor #, and asm
5241 5242 5243

		} else {
			if ($prevline !~ /^..*\\$/ &&
5244 5245
			    $line !~ /^\+\s*\#.*\\$/ &&		# preprocessor
			    $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ &&	# asm
5246 5247 5248 5249
			    $line =~ /^\+.*\\$/) {
				WARN("LINE_CONTINUATIONS",
				     "Avoid unnecessary line continuations\n" . $herecurr);
			}
5250 5251
		}

5252 5253 5254
# 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
5255
		if ($perl_version_ok &&
5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266
		    $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;
5267
			$dstat =~ s/$;/ /g;
5268 5269 5270 5271 5272 5273 5274

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

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

				WARN("TRAILING_SEMICOLON",
				     "macros should not use a trailing semicolon\n" . "$herectx");
5293 5294 5295
			}
		}

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

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

5315
					$allowed[$allow] = 0;
5316 5317 5318 5319 5320 5321
					#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";
5322 5323
					$ln += statement_rawlines($block) - 1;

5324
					substr($block, 0, length($cond), '');
5325 5326 5327

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

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

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

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

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

5405 5406
				WARN("BRACES",
				     "braces {} are not necessary for single statement blocks\n" . $herectx);
5407 5408 5409
			}
		}

5410
# check for single line unbalanced braces
5411 5412
		if ($sline =~ /^.\s*\}\s*else\s*$/ ||
		    $sline =~ /^.\s*else\s*\{\s*$/) {
5413 5414 5415
			CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
		}

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

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

5439 5440 5441 5442
# 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
5443
		if ($line =~ /^\+\s*$String/ &&
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 5473 5474 5475 5476 5477
		    $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);
		}

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

5490 5491 5492 5493 5494 5495 5496 5497 5498 5499
# 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/;
			}

		}

5500
# concatenated string without spaces between elements
5501 5502 5503 5504 5505 5506 5507 5508 5509 5510
		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/;
				}
			}
5511 5512
		}

5513
# uncoalesced string fragments
5514
		if ($line =~ /$String\s*"/) {
5515 5516 5517 5518 5519 5520 5521 5522
			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;
				}
			}
5523 5524
		}

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

# check for line continuations in quoted strings with odd counts of "
5551
		if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
5552 5553 5554 5555
			WARN("LINE_CONTINUATIONS",
			     "Avoid line continuations in quoted strings\n" . $herecurr);
		}

5556
# warn about #if 0
5557
		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
5558 5559 5560 5561 5562 5563 5564 5565
			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);
5566 5567
		}

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

5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611
# 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");

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

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

5630 5631 5632 5633 5634 5635
# 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);
		}

5636
# check for mask then right shift without a parentheses
5637
		if ($perl_version_ok &&
5638 5639 5640 5641 5642 5643
		    $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);
		}

5644
# check for pointer comparisons to NULL
5645
		if ($perl_version_ok) {
5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657
			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/;
				}
			}
		}

5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670
# 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) {
5671
					$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;
5672 5673 5674 5675
				}
			}
		}

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

5705 5706 5707 5708 5709 5710 5711 5712 5713 5714
# 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//;
			}
		}

5715 5716 5717 5718 5719 5720 5721 5722 5723
# 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) {
5724
				$fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
5725 5726 5727
			}
		}

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

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

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

5756 5757 5758 5759 5760 5761
# 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);
		}

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

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

5778 5779
		}

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

		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)|
5807 5808
			smp_(?:$barrier_stems)|
			virt_(?:$barrier_stems)
5809 5810 5811
		}x;

		if ($line =~ /\b(?:$all_barriers)\s*\(/) {
5812
			if (!ctx_has_comment($first_line, $linenr)) {
5813 5814
				WARN("MEMORY_BARRIER",
				     "memory barrier without comment\n" . $herecurr);
5815 5816
			}
		}
5817

5818 5819 5820 5821 5822 5823 5824 5825 5826 5827
		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);
		}

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

5836 5837 5838 5839 5840 5841
# 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);
		}

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

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

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

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

			}
5879 5880
		}

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

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

5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906
# 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)/;
			}
		}

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

			}
5916 5917
		}

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

5928
# Check for __attribute__ weak, or __weak declarations (may have link issues)
5929
		if ($perl_version_ok &&
5930 5931 5932 5933 5934 5935 5936
		    $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);
		}

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

5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975
# 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/;
			}
		}

5976 5977
# check for sizeof(&)
		if ($line =~ /\bsizeof\s*\(\s*\&/) {
5978 5979
			WARN("SIZEOF_ADDRESS",
			     "sizeof(& should be avoided\n" . $herecurr);
5980 5981
		}

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

5991 5992 5993 5994 5995 5996
# 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);
		}

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

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

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

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

6054 6055 6056
					WARN("VSPRINTF_POINTER_EXTENSION",
					     "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
				}
6057 6058 6059
			}
		}

6060
# Check for misused memsets
6061
		if ($perl_version_ok &&
6062
		    defined $stat &&
6063
		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
6064 6065

			my $ms_addr = $2;
6066 6067
			my $ms_val = $7;
			my $ms_size = $12;
6068 6069 6070

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

6078
# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
6079
#		if ($perl_version_ok &&
6080 6081 6082 6083 6084 6085 6086 6087
#		    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)/;
#			}
#		}
6088

6089
# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
6090
#		if ($perl_version_ok &&
6091 6092 6093 6094 6095
#		    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")
#		}
6096

6097 6098
# 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
6099
#		if ($perl_version_ok &&
6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118
#		    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)/;
#				}
#			}
#		}
6119

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

6132
				if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
6133 6134 6135 6136 6137 6138 6139 6140
					$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");
6141 6142 6143
			}
		}

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

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

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

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

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

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

			if ($paren_space =~ /\n/) {
6221 6222
				WARN("FUNCTION_ARGUMENTS",
				     "arguments for function declarations should follow identifier\n" . $herecurr);
6223
			}
6224 6225 6226 6227

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

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

6246
# check for function definitions
6247
		if ($perl_version_ok &&
6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268
		    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);
			}
		}

6269 6270 6271 6272 6273
# checks for new __setup's
		if ($rawline =~ /\b__setup\("([^"]*)"/) {
			my $name = $1;

			if (!grep(/$name/, @setup_docs)) {
6274
				CHK("UNDOCUMENTED_SETUP",
6275
				    "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
6276
			}
6277
		}
6278

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

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

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

6313
				if (WARN("ALLOC_WITH_MULTIPLY",
6314 6315
					 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
				    $cnt == 1 &&
6316
				    $fix) {
6317
					$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;
6318 6319 6320 6321
				}
			}
		}

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

6330 6331 6332 6333 6334 6335
# 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);
		}

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

6345 6346 6347
# 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*\)?/) {
6348 6349 6350 6351 6352 6353 6354 6355 6356
			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)/;
			}
		}

6357 6358 6359 6360 6361 6362 6363 6364 6365 6366
# 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)";
			}
		}

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

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

6399 6400
			WARN("DEFAULT_NO_BREAK",
			     "switch default: should use break\n" . $herectx);
6401 6402
		}

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

6412 6413 6414 6415 6416 6417
# 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 已提交
6418 6419 6420 6421 6422 6423
# 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);
		}

6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450
# 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);

			}
		}

6451 6452
# check for semaphores initialized locked
		if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
6453 6454
			WARN("CONSIDER_COMPLETION",
			     "consider using a completion\n" . $herecurr);
6455
		}
6456

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

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

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

6475 6476 6477 6478 6479 6480 6481 6482
# 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);
		}

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

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

6504 6505 6506 6507 6508 6509
# 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);
		}

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

6517 6518 6519 6520 6521 6522
# 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);
		}

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

6534 6535 6536 6537 6538 6539
# check for mutex_trylock_recursive usage
		if ($line =~ /mutex_trylock_recursive/) {
			ERROR("LOCKING",
			      "recursive locking is bad, do not use this ever.\n" . $herecurr);
		}

6540 6541 6542 6543 6544 6545
# 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@) {
6546 6547
				ERROR("LOCKDEP",
				      "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
6548 6549
			}
		}
6550

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

6557 6558 6559
# 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
6560
		if ($perl_version_ok &&
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 6609 6610 6611 6612 6613
		    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);
			}
		}

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

6627 6628
				my $lc = $stat =~ tr@\n@@;
				$lc = $lc + $linenr;
6629
				my $stat_real = get_stat_real($linenr, $lc);
6630

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

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

6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681
# 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);
			}
		}
6682 6683 6684 6685 6686 6687

# 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);
		}
6688 6689 6690 6691 6692 6693
	}

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

6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707
	# 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);
	}

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

6722
	print report_dump();
6723 6724
	if ($summary && !($clean == 1 && $quiet == 1)) {
		print "$filename " if ($summary_file);
6725 6726 6727
		print "total: $cnt_error errors, $cnt_warn warnings, " .
			(($check)? "$cnt_chk checks, " : "") .
			"$cnt_lines lines checked\n";
6728
	}
6729

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

NOTE: Whitespace errors detected.
      You may wish to use scripts/cleanpatch or scripts/cleanfile
EOM
6748 6749 6750
		}
	}

6751 6752 6753
	if ($clean == 0 && $fix &&
	    ("@rawlines" ne "@fixed" ||
	     $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
6754 6755
		my $newfile = $filename;
		$newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
6756 6757 6758
		my $linecount = 0;
		my $f;

6759 6760
		@fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);

6761 6762 6763 6764 6765 6766 6767
		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/^\+//;
6768
					print $f $fixed_line . "\n";
6769 6770 6771 6772 6773 6774 6775 6776 6777
				}
			} else {
				print $f $fixed_line . "\n";
			}
		}
		close($f);

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

6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789
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
		}
	}

6790 6791 6792 6793 6794 6795 6796
	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";
		}
6797 6798 6799
	}
	return $clean;
}