checkpatch.pl 114.2 KB
Newer Older
1
#!/usr/bin/perl -w
2
# (c) 2001, Dave Jones. (the file handling bit)
3
# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
A
Andy Whitcroft 已提交
4
# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
5
# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
6 7 8
# Licensed under the terms of the GNU GPL License version 2

use strict;
9
use POSIX;
10 11

my $P = $0;
12
$P =~ s@.*/@@g;
13

14
my $V = '0.32';
15 16 17 18 19 20 21

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

my $quiet = 0;
my $tree = 1;
my $chk_signoff = 1;
my $chk_patch = 1;
22
my $tst_only;
23
my $emacs = 0;
24
my $terse = 0;
25 26
my $file = 0;
my $check = 0;
27 28
my $summary = 1;
my $mailback = 0;
29
my $summary_file = 0;
30
my $show_types = 0;
31
my $fix = 0;
32
my $root;
33
my %debug;
34
my %ignore_type = ();
35
my %camelcase = ();
36
my @ignore = ();
37
my $help = 0;
38
my $configuration_file = ".checkpatch.conf";
39
my $max_line_length = 80;
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56

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
  -f, --file                 treat FILE as regular source file
  --subjective, --strict     enable more subjective tests
57
  --ignore TYPE(,TYPE2...)   ignore various comma separated message types
58
  --max-line-length=n        set the maximum line length, if exceeded, warn
59
  --show-types               show the message "types" in the output
60 61 62 63 64 65 66 67 68
  --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
69 70 71 72 73
  --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
74 75 76 77 78 79 80 81
  -h, --help, --version      display this help and exit

When FILE is - read standard input.
EOM

	exit($exitcode);
}

82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
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;
}

108
GetOptions(
109
	'q|quiet+'	=> \$quiet,
110 111 112
	'tree!'		=> \$tree,
	'signoff!'	=> \$chk_signoff,
	'patch!'	=> \$chk_patch,
113
	'emacs!'	=> \$emacs,
114
	'terse!'	=> \$terse,
115
	'f|file!'	=> \$file,
116 117
	'subjective!'	=> \$check,
	'strict!'	=> \$check,
118 119
	'ignore=s'	=> \@ignore,
	'show-types!'	=> \$show_types,
120
	'max-line-length=i' => \$max_line_length,
121
	'root=s'	=> \$root,
122 123
	'summary!'	=> \$summary,
	'mailback!'	=> \$mailback,
124
	'summary-file!'	=> \$summary_file,
125
	'fix!'		=> \$fix,
126
	'debug=s'	=> \%debug,
127
	'test-only=s'	=> \$tst_only,
128 129 130 131 132
	'h|help'	=> \$help,
	'version'	=> \$help
) or help(1);

help(0) if ($help);
133 134 135 136

my $exit = 0;

if ($#ARGV < 0) {
137
	print "$P: no input files\n";
138 139 140
	exit(1);
}

141 142 143 144 145 146 147 148 149 150 151 152 153
@ignore = split(/,/, join(',',@ignore));
foreach my $word (@ignore) {
	$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*$/);

	$ignore_type{$word}++;
}

154 155
my $dbg_values = 0;
my $dbg_possible = 0;
156
my $dbg_type = 0;
157
my $dbg_attr = 0;
158
for my $key (keys %debug) {
159 160 161
	## no critic
	eval "\${dbg_$key} = '$debug{$key}';";
	die "$@" if ($@);
162 163
}

164 165
my $rpt_cleaners = 0;

166 167 168 169 170
if ($terse) {
	$emacs = 1;
	$quiet++;
}

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

191 192
my $emitted_corrupt = 0;

193 194 195 196
our $Ident	= qr{
			[A-Za-z_][A-Za-z\d_]*
			(?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
		}x;
197 198 199 200 201 202 203 204
our $Storage	= qr{extern|static|asmlinkage};
our $Sparse	= qr{
			__user|
			__kernel|
			__force|
			__iomem|
			__must_check|
			__init_refok|
205
			__kprobes|
206 207
			__ref|
			__rcu
208
		}x;
209 210 211

# Notes to $Attribute:
# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
212 213
our $Attribute	= qr{
			const|
214 215 216 217 218 219 220 221 222 223 224 225 226 227
			__percpu|
			__nocast|
			__safe|
			__bitwise__|
			__packed__|
			__packed2__|
			__naked|
			__maybe_unused|
			__always_unused|
			__noreturn|
			__used|
			__cold|
			__noclone|
			__deprecated|
228 229
			__read_mostly|
			__kprobes|
230
			__(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
231 232
			____cacheline_aligned|
			____cacheline_aligned_in_smp|
233 234
			____cacheline_internodealigned_in_smp|
			__weak
235
		  }x;
236
our $Modifier;
237 238 239 240
our $Inline	= qr{inline|__always_inline|noinline};
our $Member	= qr{->$Ident|\.$Ident|\[[^]]*\]};
our $Lval	= qr{$Ident(?:$Member)*};

241 242 243 244
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?};
245 246 247
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]?};
248
our $Float	= qr{$Float_hex|$Float_dec|$Float_int};
249
our $Constant	= qr{$Float|$Binary|$Hex|$Int};
250
our $Assignment	= qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
251
our $Compare    = qr{<=|>=|==|!=|<|>};
252
our $Arithmetic = qr{\+|-|\*|\/|%};
253 254 255
our $Operators	= qr{
			<=|>=|==|!=|
			=>|->|<<|>>|<|>|!|~|
256
			&&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
257 258
		  }x;

259 260 261 262
our $NonptrType;
our $Type;
our $Declare;

263 264
our $NON_ASCII_UTF8	= qr{
	[\xC2-\xDF][\x80-\xBF]               # non-overlong 2-byte
265 266 267 268 269 270 271 272
	|  \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;

273 274 275 276 277
our $UTF8	= qr{
	[\x09\x0A\x0D\x20-\x7E]              # ASCII
	| $NON_ASCII_UTF8
}x;

278
our $typeTypedefs = qr{(?x:
279
	(?:__)?(?:u|s|be|le)(?:8|16|32|64)|
280 281 282
	atomic_t
)};

283
our $logFunctions = qr{(?x:
284
	printk(?:_ratelimited|_once|)|
285
	(?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
286
	WARN(?:_RATELIMIT|_ONCE|)|
287 288
	panic|
	MODULE_[A-Z_]+
289 290
)};

291 292 293 294 295 296
our $signature_tags = qr{(?xi:
	Signed-off-by:|
	Acked-by:|
	Tested-by:|
	Reviewed-by:|
	Reported-by:|
297
	Suggested-by:|
298 299 300 301
	To:|
	Cc:
)};

302 303
our @typeList = (
	qr{void},
304 305 306 307 308 309 310
	qr{(?:unsigned\s+)?char},
	qr{(?:unsigned\s+)?short},
	qr{(?:unsigned\s+)?int},
	qr{(?:unsigned\s+)?long},
	qr{(?:unsigned\s+)?long\s+int},
	qr{(?:unsigned\s+)?long\s+long},
	qr{(?:unsigned\s+)?long\s+long\s+int},
311 312 313 314 315 316 317 318 319 320 321
	qr{unsigned},
	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},
);
322 323 324
our @modifierList = (
	qr{fastcall},
);
325

326 327 328 329 330 331
our $allowed_asm_includes = qr{(?x:
	irq|
	memory
)};
# memory.h: ARM has a custom one

332
sub build_types {
333 334
	my $mods = "(?x:  \n" . join("|\n  ", @modifierList) . "\n)";
	my $all = "(?x:  \n" . join("|\n  ", @typeList) . "\n)";
335
	$Modifier	= qr{(?:$Attribute|$Sparse|$mods)};
336
	$NonptrType	= qr{
337
			(?:$Modifier\s+|const\s+)*
338
			(?:
339
				(?:typeof|__typeof__)\s*\([^\)]*\)|
340
				(?:$typeTypedefs\b)|
341
				(?:${all}\b)
342
			)
343
			(?:\s+$Modifier|\s+const)*
344 345
		  }x;
	$Type	= qr{
346
			$NonptrType
347
			(?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)?
348
			(?:\s+$Inline|\s+$Modifier)*
349 350 351 352
		  }x;
	$Declare	= qr{(?:$Storage\s+)?$Type};
}
build_types();
353

354
our $Typecast	= qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
355 356 357 358 359 360 361

# 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))*\))/;
our $LvalOrFunc	= qr{($Lval)\s*($balanced_parens{0,1})\s*};
362
our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
363 364 365 366 367 368 369 370 371 372

sub deparenthesize {
	my ($string) = @_;
	return "" if (!defined($string));
	$string =~ s@^\s*\(\s*@@g;
	$string =~ s@\s*\)\s*$@@g;
	$string =~ s@\s+@ @g;
	return $string;
}

373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
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;
		}
	        elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*\(/) {
			$camelcase{$1} = 1;
		}
	}
}

my $camelcase_seeded = 0;
sub seed_camelcase_includes {
	return if ($camelcase_seeded);

	my $files;
403 404 405 406
	my $camelcase_cache = "";
	my @include_files = ();

	$camelcase_seeded = 1;
407

408
	if (-d ".git") {
409 410
		my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
		chomp $git_last_include_commit;
411
		$camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
412
	} else {
413
		my $last_mod_date = 0;
414
		$files = `find $root/include -name "*.h"`;
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
		@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;
434
	}
435 436 437 438 439 440

	if (-d ".git") {
		$files = `git ls-files "include/*.h"`;
		@include_files = split('\n', $files);
	}

441 442 443
	foreach my $file (@include_files) {
		seed_camelcase_file($file);
	}
444

445
	if ($camelcase_cache ne "") {
446
		unlink glob ".checkpatch-camelcase.*";
447 448
		open(my $camelcase_file, '>', "$camelcase_cache")
		    or warn "$P: Can't write '$camelcase_cache' $!\n";
449 450 451 452 453
		foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
			print $camelcase_file ("$_\n");
		}
		close($camelcase_file);
	}
454 455
}

456 457
$chk_signoff = 0 if ($file);

458
my @rawlines = ();
459
my @lines = ();
460
my @fixed = ();
461
my $vname;
462
for my $filename (@ARGV) {
463
	my $FILE;
464
	if ($file) {
465
		open($FILE, '-|', "diff -u /dev/null $filename") ||
466
			die "$P: $filename: diff failed - $!\n";
467 468
	} elsif ($filename eq '-') {
		open($FILE, '<&STDIN');
469
	} else {
470
		open($FILE, '<', "$filename") ||
471
			die "$P: $filename: open failed - $!\n";
472
	}
473 474 475 476 477
	if ($filename eq '-') {
		$vname = 'Your patch';
	} else {
		$vname = $filename;
	}
478
	while (<$FILE>) {
479 480 481
		chomp;
		push(@rawlines, $_);
	}
482
	close($FILE);
483
	if (!process($filename)) {
484 485 486
		$exit = 1;
	}
	@rawlines = ();
487
	@lines = ();
488
	@fixed = ();
489 490 491 492 493
}

exit($exit);

sub top_of_kernel_tree {
494 495 496 497 498 499 500 501 502 503 504 505
	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;
		}
506
	}
507
	return 1;
508
}
509

510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
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;
		$formatted_email =~ s/$address.*$//;
		$name = $formatted_email;
529
		$name = trim($name);
530 531 532 533 534 535 536 537 538 539 540 541 542 543
		$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 = "";
		}
	}

544
	$name = trim($name);
545
	$name =~ s/^\"|\"$//g;
546
	$address = trim($address);
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
	$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;

562
	$name = trim($name);
563
	$name =~ s/^\"|\"$//g;
564
	$address = trim($address);
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579

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

580 581 582 583 584 585 586 587 588 589 590 591
sub which_conf {
	my ($conf) = @_;

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

	return "";
}

592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
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;
}
612
sub copy_spacing {
613
	(my $res = shift) =~ tr/\t/ /c;
614 615
	return $res;
}
616

617 618 619 620 621 622 623 624 625 626 627 628 629
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));
}

630 631 632 633 634 635 636 637 638 639 640
my $sanitise_quote = '';

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

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
641 642 643 644 645 646
sub sanitise_line {
	my ($line) = @_;

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

647
	my $qlen = 0;
648 649
	my $off = 0;
	my $c;
650

651 652 653 654 655 656 657 658 659 660 661 662 663 664
	# Always copy over the diff marker.
	$res = substr($line, 0, 1);

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

		# Comments we are wacking completly including the begin
		# and end, all to $;.
		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
			$sanitise_quote = '*/';

			substr($res, $off, 2, "$;$;");
			$off++;
			next;
665
		}
666
		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
667 668 669 670
			$sanitise_quote = '';
			substr($res, $off, 2, "$;$;");
			$off++;
			next;
671
		}
672 673 674 675 676 677 678
		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
			$sanitise_quote = '//';

			substr($res, $off, 2, $sanitise_quote);
			$off++;
			next;
		}
679 680 681 682 683 684 685

		# 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;
686
		}
687 688 689 690
		# Regular quotes.
		if ($c eq "'" || $c eq '"') {
			if ($sanitise_quote eq '') {
				$sanitise_quote = $c;
691

692 693 694 695 696 697
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
698

699
		#print "c<$c> SQ<$sanitise_quote>\n";
700 701
		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
			substr($res, $off, 1, $;);
702 703
		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
			substr($res, $off, 1, $;);
704 705 706 707 708
		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
			substr($res, $off, 1, 'X');
		} else {
			substr($res, $off, 1, $c);
		}
709 710
	}

711 712 713 714
	if ($sanitise_quote eq '//') {
		$sanitise_quote = '';
	}

715
	# The pathname on a #include may be surrounded by '<' and '>'.
716
	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
717 718 719 720
		my $clean = 'X' x length($1);
		$res =~ s@\<.*\>@<$clean>@;

	# The whole of a #error is a string.
721
	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
722
		my $clean = 'X' x length($1);
723
		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
724 725
	}

726 727 728
	return $res;
}

729 730 731 732 733 734 735
sub get_quoted_string {
	my ($line, $rawline) = @_;

	return "" if ($line !~ m/(\"[X]+\")/g);
	return substr($rawline, $-[0], $+[0] - $-[0]);
}

736 737 738 739 740 741
sub ctx_statement_block {
	my ($linenr, $remain, $off) = @_;
	my $line = $linenr - 1;
	my $blk = '';
	my $soff = $off;
	my $coff = $off - 1;
742
	my $coff_set = 0;
743

744 745
	my $loff = 0;

746 747
	my $type = '';
	my $level = 0;
748
	my @stack = ();
749
	my $p;
750 751
	my $c;
	my $len = 0;
752 753

	my $remainder;
754
	while (1) {
755 756
		@stack = (['', 0]) if ($#stack == -1);

757
		#warn "CSB: blk<$blk> remain<$remain>\n";
758 759 760 761
		# If we are about to drop off the end, pull in more
		# context.
		if ($off >= $len) {
			for (; $remain > 0; $line++) {
762
				last if (!defined $lines[$line]);
763
				next if ($lines[$line] =~ /^-/);
764
				$remain--;
765
				$loff = $len;
766
				$blk .= $lines[$line] . "\n";
767 768 769 770 771 772
				$len = length($blk);
				$line++;
				last;
			}
			# Bail if there is no further context.
			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
773
			if ($off >= $len) {
774 775
				last;
			}
776 777 778 779
			if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
				$level++;
				$type = '#';
			}
780
		}
781
		$p = $c;
782
		$c = substr($blk, $off, 1);
783
		$remainder = substr($blk, $off);
784

785
		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
786 787 788 789 790 791 792 793 794 795

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

796 797 798 799 800 801
		# Statement ends at the ';' or a close '}' at the
		# outermost level.
		if ($level == 0 && $c eq ';') {
			last;
		}

802
		# An else is really a conditional as long as its not else if
803 804 805 806 807 808 809 810
		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";
811 812
		}

813 814 815 816 817 818 819 820 821 822
		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;
823 824
				$coff_set = 1;
				#warn "CSB: mark coff<$coff>\n";
825 826 827 828 829 830 831 832 833 834 835
			}
		}
		if (($type eq '' || $type eq '{') && $c eq '{') {
			$level++;
			$type = '{';
		}
		if ($type eq '{' && $c eq '}') {
			$level--;
			$type = ($level != 0)? '{' : '';

			if ($level == 0) {
836 837 838
				if (substr($blk, $off + 1, 1) eq ';') {
					$off++;
				}
839 840 841
				last;
			}
		}
842 843 844 845 846 847 848
		# Preprocessor commands end at the newline unless escaped.
		if ($type eq '#' && $c eq "\n" && $p ne "\\") {
			$level--;
			$type = '';
			$off++;
			last;
		}
849 850
		$off++;
	}
851
	# We are truly at the end, so shuffle to the next line.
852
	if ($off == $len) {
853
		$loff = $len + 1;
854 855 856
		$line++;
		$remain--;
	}
857 858 859 860 861 862 863

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

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

864
	#print "coff<$coff> soff<$off> loff<$loff>\n";
865 866 867 868 869

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

870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912
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;
	}
}

913 914 915 916 917 918
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

919
	# Grab the first conditional/block pair.
920 921
	($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
922
	#print "F: c<$condition> s<$statement> remain<$remain>\n";
923 924 925 926 927 928 929
	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.
930 931 932
	for (;;) {
		($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
933
		#print "C: c<$condition> s<$statement> remain<$remain>\n";
934
		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
935 936
		#print "C: push\n";
		push(@chunks, [ $condition, $statement ]);
937 938 939
	}

	return ($level, $linenr, @chunks);
940 941
}

942
sub ctx_block_get {
943
	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
944 945 946 947 948 949 950
	my $line;
	my $start = $linenr - 1;
	my $blk = '';
	my @o;
	my @c;
	my @res = ();

951
	my $level = 0;
952
	my @stack = ($level);
953 954 955 956 957
	for ($line = $start; $remain > 0; $line++) {
		next if ($rawlines[$line] =~ /^-/);
		$remain--;

		$blk .= $rawlines[$line];
958 959

		# Handle nested #if/#else.
960
		if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
961
			push(@stack, $level);
962
		} elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
963
			$level = $stack[$#stack - 1];
964
		} elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
965 966 967
			$level = pop(@stack);
		}

968
		foreach my $c (split(//, $lines[$line])) {
969 970 971 972 973
			##print "C<$c>L<$level><$open$close>O<$off>\n";
			if ($off > 0) {
				$off--;
				next;
			}
974

975 976 977 978 979 980 981
			if ($c eq $close && $level > 0) {
				$level--;
				last if ($level == 0);
			} elsif ($c eq $open) {
				$level++;
			}
		}
982

983
		if (!$outer || $level <= 1) {
984
			push(@res, $rawlines[$line]);
985 986
		}

987
		last if ($level == 0);
988 989
	}

990
	return ($level, @res);
991 992 993 994
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

995 996
	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
	return @r;
997 998 999 1000
}
sub ctx_block {
	my ($linenr, $remain) = @_;

1001 1002
	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
	return @r;
1003 1004
}
sub ctx_statement {
1005 1006 1007 1008 1009 1010
	my ($linenr, $remain, $off) = @_;

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

1013
	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1014
}
1015 1016 1017 1018 1019
sub ctx_statement_level {
	my ($linenr, $remain, $off) = @_;

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
1020 1021 1022 1023 1024

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

	# Catch a comment on the end of the line itself.
1025
	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1026 1027 1028 1029 1030 1031 1032
	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++) {
1033 1034
		my $line = $rawlines[$linenr - 1];
		#warn "           $line\n";
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
		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);

1057
	##print "LINE: $rawlines[$end_line - 1 ]\n";
1058 1059 1060 1061 1062
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
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;
}

1079 1080 1081
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
1082

1083 1084 1085 1086 1087 1088
	$res = '';
	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
		$res .= $1;
		if ($2 ne '') {
			$coded = sprintf("^%c", unpack('C', $2) + 64);
			$res .= $coded;
1089 1090
		}
	}
1091
	$res =~ s/$/\$/;
1092

1093
	return $res;
1094 1095
}

1096
my $av_preprocessor = 0;
1097
my $av_pending;
1098
my @av_paren_type;
1099
my $av_pend_colon;
1100 1101 1102

sub annotate_reset {
	$av_preprocessor = 0;
1103 1104
	$av_pending = '_';
	@av_paren_type = ('E');
1105
	$av_pend_colon = 'O';
1106 1107
}

1108 1109
sub annotate_values {
	my ($stream, $type) = @_;
1110

1111
	my $res;
1112
	my $var = '_' x length($stream);
1113 1114
	my $cur = $stream;

1115
	print "$stream\n" if ($dbg_values > 1);
1116 1117

	while (length($cur)) {
1118
		@av_paren_type = ('E') if ($#av_paren_type < 0);
1119
		print " <" . join('', @av_paren_type) .
1120
				"> <$type> <$av_pending>" if ($dbg_values > 1);
1121
		if ($cur =~ /^(\s+)/o) {
1122 1123
			print "WS($1)\n" if ($dbg_values > 1);
			if ($1 =~ /\n/ && $av_preprocessor) {
1124
				$type = pop(@av_paren_type);
1125
				$av_preprocessor = 0;
1126 1127
			}

1128
		} elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1129 1130
			print "CAST($1)\n" if ($dbg_values > 1);
			push(@av_paren_type, $type);
1131
			$type = 'c';
1132

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

1137 1138 1139 1140
		} elsif ($cur =~ /^($Modifier)\s*/) {
			print "MODIFIER($1)\n" if ($dbg_values > 1);
			$type = 'T';

1141
		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1142
			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1143
			$av_preprocessor = 1;
1144 1145 1146 1147 1148 1149
			push(@av_paren_type, $type);
			if ($2 ne '') {
				$av_pending = 'N';
			}
			$type = 'E';

1150
		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1151 1152 1153
			print "UNDEF($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;
			push(@av_paren_type, $type);
1154

1155
		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1156
			print "PRE_START($1)\n" if ($dbg_values > 1);
1157
			$av_preprocessor = 1;
1158 1159 1160

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
1161
			$type = 'E';
1162

1163
		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1164 1165 1166 1167 1168
			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;

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

1169
			$type = 'E';
1170

1171
		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1172 1173 1174 1175 1176 1177 1178 1179
			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);
1180
			$type = 'E';
1181 1182

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

1185 1186 1187 1188 1189
		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
			print "ATTR($1)\n" if ($dbg_values > 1);
			$av_pending = $type;
			$type = 'N';

1190
		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1191
			print "SIZEOF($1)\n" if ($dbg_values > 1);
1192
			if (defined $2) {
1193
				$av_pending = 'V';
1194 1195 1196
			}
			$type = 'N';

1197
		} elsif ($cur =~ /^(if|while|for)\b/o) {
1198
			print "COND($1)\n" if ($dbg_values > 1);
1199
			$av_pending = 'E';
1200 1201
			$type = 'N';

1202 1203 1204 1205 1206
		} elsif ($cur =~/^(case)/o) {
			print "CASE($1)\n" if ($dbg_values > 1);
			$av_pend_colon = 'C';
			$type = 'N';

1207
		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1208
			print "KEYWORD($1)\n" if ($dbg_values > 1);
1209 1210 1211
			$type = 'N';

		} elsif ($cur =~ /^(\()/o) {
1212
			print "PAREN('$1')\n" if ($dbg_values > 1);
1213 1214
			push(@av_paren_type, $av_pending);
			$av_pending = '_';
1215 1216 1217
			$type = 'N';

		} elsif ($cur =~ /^(\))/o) {
1218 1219 1220
			my $new_type = pop(@av_paren_type);
			if ($new_type ne '_') {
				$type = $new_type;
1221 1222
				print "PAREN('$1') -> $type\n"
							if ($dbg_values > 1);
1223
			} else {
1224
				print "PAREN('$1')\n" if ($dbg_values > 1);
1225 1226
			}

1227
		} elsif ($cur =~ /^($Ident)\s*\(/o) {
1228
			print "FUNC($1)\n" if ($dbg_values > 1);
1229
			$type = 'V';
1230
			$av_pending = 'V';
1231

1232 1233
		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
			if (defined $2 && $type eq 'C' || $type eq 'T') {
1234
				$av_pend_colon = 'B';
1235 1236
			} elsif ($type eq 'E') {
				$av_pend_colon = 'L';
1237 1238 1239 1240
			}
			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
			$type = 'V';

1241
		} elsif ($cur =~ /^($Ident|$Constant)/o) {
1242
			print "IDENT($1)\n" if ($dbg_values > 1);
1243 1244 1245
			$type = 'V';

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

1249
		} elsif ($cur =~/^(;|{|})/) {
1250
			print "END($1)\n" if ($dbg_values > 1);
1251
			$type = 'E';
1252 1253
			$av_pend_colon = 'O';

1254 1255 1256 1257
		} elsif ($cur =~/^(,)/) {
			print "COMMA($1)\n" if ($dbg_values > 1);
			$type = 'C';

1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271
		} 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';
1272

1273
		} elsif ($cur =~ /^(\[)/o) {
1274
			print "CLOSE($1)\n" if ($dbg_values > 1);
1275 1276
			$type = 'N';

1277
		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289
			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';

1290
		} elsif ($cur =~ /^($Operators)/o) {
1291
			print "OP($1)\n" if ($dbg_values > 1);
1292 1293 1294 1295 1296
			if ($1 ne '++' && $1 ne '--') {
				$type = 'N';
			}

		} elsif ($cur =~ /(^.)/o) {
1297
			print "C($1)\n" if ($dbg_values > 1);
1298 1299 1300 1301 1302
		}
		if (defined $1) {
			$cur = substr($cur, length($1));
			$res .= $type x length($1);
		}
1303
	}
1304

1305
	return ($res, $var);
1306 1307
}

1308
sub possible {
1309
	my ($possible, $line) = @_;
1310
	my $notPermitted = qr{(?:
1311 1312 1313 1314
		^(?:
			$Modifier|
			$Storage|
			$Type|
1315 1316 1317
			DEFINE_\S+
		)$|
		^(?:
1318 1319 1320 1321 1322
			goto|
			return|
			case|
			else|
			asm|__asm__|
1323 1324 1325
			do|
			\#|
			\#\#|
1326
		)(?:\s|$)|
1327
		^(?:typedef|struct|enum)\b
1328 1329 1330
	    )}x;
	warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
	if ($possible !~ $notPermitted) {
1331 1332 1333 1334 1335 1336 1337
		# 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;
1338
			for my $modifier (split(' ', $possible)) {
1339 1340 1341 1342
				if ($modifier !~ $notPermitted) {
					warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
					push(@modifierList, $modifier);
				}
1343
			}
1344 1345 1346 1347 1348

		} else {
			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
			push(@typeList, $possible);
		}
1349
		build_types();
1350 1351
	} else {
		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1352 1353 1354
	}
}

1355 1356
my $prefix = '';

1357 1358 1359 1360
sub show_type {
       return !defined $ignore_type{$_[0]};
}

1361
sub report {
1362 1363
	if (!show_type($_[1]) ||
	    (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
1364 1365
		return 0;
	}
1366 1367 1368 1369 1370 1371
	my $line;
	if ($show_types) {
		$line = "$prefix$_[0]:$_[1]: $_[2]\n";
	} else {
		$line = "$prefix$_[0]: $_[2]\n";
	}
1372 1373
	$line = (split('\n', $line))[0] . "\n" if ($terse);

1374
	push(our @report, $line);
1375 1376

	return 1;
1377 1378
}
sub report_dump {
1379
	our @report;
1380
}
1381

1382
sub ERROR {
1383
	if (report("ERROR", $_[0], $_[1])) {
1384 1385
		our $clean = 0;
		our $cnt_error++;
1386
		return 1;
1387
	}
1388
	return 0;
1389 1390
}
sub WARN {
1391
	if (report("WARNING", $_[0], $_[1])) {
1392 1393
		our $clean = 0;
		our $cnt_warn++;
1394
		return 1;
1395
	}
1396
	return 0;
1397 1398
}
sub CHK {
1399
	if ($check && report("CHECK", $_[0], $_[1])) {
1400 1401
		our $clean = 0;
		our $cnt_chk++;
1402
		return 1;
1403
	}
1404
	return 0;
1405 1406
}

1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429
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 ".../") {
1430 1431
		WARN("USE_RELATIVE_PATH",
		     "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1432 1433 1434
	}
}

1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457
sub trim {
	my ($string) = @_;

	$string =~ s/(^\s+|\s+$)//g;

	return $string;
}

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

1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487
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;
		}
	}

	return $last_openparen + 1;
}

1488 1489 1490 1491 1492
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
1493
	my $prevrawline="";
1494
	my $stashline="";
1495
	my $stashrawline="";
1496

1497
	my $length;
1498 1499 1500 1501
	my $indent;
	my $previndent=0;
	my $stashindent=0;

1502
	our $clean = 1;
1503 1504 1505
	my $signoff = 0;
	my $is_patch = 0;

1506 1507 1508
	my $in_header_lines = 1;
	my $in_commit_log = 0;		#Scanning lines before patch

1509 1510
	my $non_utf8_charset = 0;

1511
	our @report = ();
1512 1513 1514 1515 1516
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

1517 1518 1519 1520 1521 1522
	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
	my $in_comment = 0;
1523
	my $comment_edge = 0;
1524
	my $first_line = 0;
1525
	my $p1_prefix = '';
1526

1527 1528 1529
	my $prev_values = 'E';

	# suppression flags
1530
	my %suppress_ifbraces;
1531
	my %suppress_whiletrailers;
1532
	my %suppress_export;
1533
	my $suppress_statement = 0;
1534

1535

1536
	# Pre-scan the patch sanitizing the lines.
1537
	# Pre-scan the patch looking for any __setup documentation.
1538
	#
1539 1540
	my @setup_docs = ();
	my $setup_docs = 0;
1541 1542

	sanitise_line_reset();
1543 1544
	my $line;
	foreach my $rawline (@rawlines) {
1545 1546
		$linenr++;
		$line = $rawline;
1547

1548 1549
		push(@fixed, $rawline) if ($fix);

1550
		if ($rawline=~/^\+\+\+\s+(\S+)/) {
1551 1552 1553 1554
			$setup_docs = 0;
			if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
				$setup_docs = 1;
			}
1555 1556 1557 1558 1559 1560 1561 1562 1563
			#next;
		}
		if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1564
			$in_comment = 0;
1565 1566 1567 1568 1569 1570

			# 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;
1571 1572 1573 1574 1575 1576
			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";
1577
				last if (!defined $rawlines[$ln - 1]);
1578 1579 1580 1581 1582
				if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
				    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
					($edge) = $1;
					last;
				}
1583 1584 1585 1586 1587 1588 1589 1590 1591
			}
			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 &&
1592
			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1593 1594 1595 1596 1597 1598 1599
			{
				$in_comment = 1;
			}

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

1600
		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1601
			# Standardise the strings and chars within the input to
1602
			# simplify matching -- only bother with positive lines.
1603
			$line = sanitise_line($rawline);
1604
		}
1605 1606 1607 1608 1609 1610 1611 1612 1613 1614
		push(@lines, $line);

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

		#print "==>$rawline\n";
		#print "-->$line\n";
1615 1616 1617 1618 1619 1620

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

1621 1622
	$prefix = '';

1623 1624
	$realcnt = 0;
	$linenr = 0;
1625 1626 1627
	foreach my $line (@lines) {
		$linenr++;

1628
		my $rawline = $rawlines[$linenr - 1];
1629

1630
#extract the line range in the file after the patch is applied
1631
		if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1632
			$is_patch = 1;
1633
			$first_line = $linenr + 1;
1634 1635 1636 1637 1638 1639
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1640
			annotate_reset();
1641 1642
			$prev_values = 'E';

1643
			%suppress_ifbraces = ();
1644
			%suppress_whiletrailers = ();
1645
			%suppress_export = ();
1646
			$suppress_statement = 0;
1647 1648
			next;

1649 1650 1651
# 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.
1652
		} elsif ($line =~ /^( |\+|$)/) {
1653
			$realline++;
1654
			$realcnt-- if ($realcnt != 0);
1655

1656
			# Measure the line length and indent.
1657
			($length, $indent) = line_stats($rawline);
1658 1659 1660 1661

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

1664
			#warn "line<$line>\n";
1665

1666 1667
		} elsif ($realcnt == 1) {
			$realcnt--;
1668 1669
		}

1670 1671
		my $hunk_line = ($realcnt != 0);

1672
#make up the handle for any error we report on this line
1673 1674 1675
		$prefix = "$filename:$realline: " if ($emacs && $file);
		$prefix = "$filename:$linenr: " if ($emacs && !$file);

1676 1677
		$here = "#$linenr: " if (!$file);
		$here = "#$realline: " if ($file);
1678 1679

		# extract the filename as it passes
1680 1681 1682
		if ($line =~ /^diff --git.*?(\S+)$/) {
			$realfile = $1;
			$realfile =~ s@^([^/]*)/@@;
1683
			$in_commit_log = 0;
1684
		} elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1685
			$realfile = $1;
1686
			$realfile =~ s@^([^/]*)/@@;
1687
			$in_commit_log = 0;
1688 1689

			$p1_prefix = $1;
1690 1691
			if (!$file && $tree && $p1_prefix ne '' &&
			    -e "$root/$p1_prefix") {
1692 1693
				WARN("PATCH_PREFIX",
				     "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1694
			}
1695

1696
			if ($realfile =~ m@^include/asm/@) {
1697 1698
				ERROR("MODIFIED_INCLUDE_ASM",
				      "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1699 1700 1701 1702
			}
			next;
		}

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

1705 1706 1707
		my $hereline = "$here\n$rawline\n";
		my $herecurr = "$here\n$rawline\n";
		my $hereprev = "$here\n$prevrawline\n$rawline\n";
1708

1709 1710
		$cnt_lines++ if ($realcnt != 0);

1711 1712 1713
# Check for incorrect file permissions
		if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
			my $permhere = $here . "FILE: $realfile\n";
1714 1715
			if ($realfile !~ m@scripts/@ &&
			    $realfile !~ /\.(py|pl|awk|sh)$/) {
1716 1717
				ERROR("EXECUTE_PERMISSIONS",
				      "do not set execute permissions for source files\n" . $permhere);
1718 1719 1720
			}
		}

1721
# Check the patch for a signoff:
1722
		if ($line =~ /^\s*signed-off-by:/i) {
1723
			$signoff++;
1724
			$in_commit_log = 0;
1725 1726 1727
		}

# Check signature styles
1728
		if (!$in_header_lines &&
1729
		    $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
1730 1731 1732 1733 1734 1735
			my $space_before = $1;
			my $sign_off = $2;
			my $space_after = $3;
			my $email = $4;
			my $ucfirst_sign_off = ucfirst(lc($sign_off));

1736 1737 1738 1739
			if ($sign_off !~ /$signature_tags/) {
				WARN("BAD_SIGN_OFF",
				     "Non-standard signature: $sign_off\n" . $herecurr);
			}
1740
			if (defined $space_before && $space_before ne "") {
1741 1742 1743 1744 1745 1746
				if (WARN("BAD_SIGN_OFF",
					 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
				    $fix) {
					$fixed[$linenr - 1] =
					    "$ucfirst_sign_off $email";
				}
1747 1748
			}
			if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
1749 1750 1751 1752 1753 1754 1755
				if (WARN("BAD_SIGN_OFF",
					 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
				    $fix) {
					$fixed[$linenr - 1] =
					    "$ucfirst_sign_off $email";
				}

1756 1757
			}
			if (!defined $space_after || $space_after ne " ") {
1758 1759 1760 1761 1762 1763
				if (WARN("BAD_SIGN_OFF",
					 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
				    $fix) {
					$fixed[$linenr - 1] =
					    "$ucfirst_sign_off $email";
				}
1764
			}
1765 1766 1767 1768

			my ($email_name, $email_address, $comment) = parse_email($email);
			my $suggested_email = format_email(($email_name, $email_address));
			if ($suggested_email eq "") {
1769 1770
				ERROR("BAD_SIGN_OFF",
				      "Unrecognized email address: '$email'\n" . $herecurr);
1771 1772 1773 1774 1775 1776 1777 1778 1779
			} 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) {
1780 1781
					WARN("BAD_SIGN_OFF",
					     "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
1782
				}
1783 1784 1785
			}
		}

1786
# Check for wrappage within a valid hunk of the file
1787
		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1788 1789
			ERROR("CORRUPTED_PATCH",
			      "patch seems to be corrupt (line wrapped?)\n" .
1790
				$herecurr) if (!$emitted_corrupt++);
1791 1792
		}

1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806
# Check for absolute kernel paths.
		if ($tree) {
			while ($line =~ m{(?:^|\s)(/\S*)}g) {
				my $file = $1;

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

1807 1808
# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1809 1810 1811 1812 1813 1814 1815
		    $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";

1816 1817
			CHK("INVALID_UTF8",
			    "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1818 1819
		}

1820 1821 1822
# 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 =~ /^$/ &&
1823
		    $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
1824 1825 1826 1827
			$in_header_lines = 0;
			$in_commit_log = 1;
		}

1828 1829 1830 1831 1832 1833 1834 1835 1836
# 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 =~ /^$/ &&
1837
		    $rawline =~ /$NON_ASCII_UTF8/) {
1838
			WARN("UTF8_BEFORE_PATCH",
1839 1840 1841
			    "8-bit UTF-8 used in possible commit log\n" . $herecurr);
		}

1842 1843
# ignore non-hunk lines and lines being removed
		next if (!$hunk_line || $line =~ /^-/);
1844 1845

#trailing whitespace
1846
		if ($line =~ /^\+.*\015/) {
1847
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1848 1849 1850 1851 1852
			if (ERROR("DOS_LINE_ENDINGS",
				  "DOS line endings\n" . $herevet) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/[\s\015]+$//;
			}
1853 1854
		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1855 1856 1857
			if (ERROR("TRAILING_WHITESPACE",
				  "trailing whitespace\n" . $herevet) &&
			    $fix) {
1858
				$fixed[$linenr - 1] =~ s/\s+$//;
1859 1860
			}

1861
			$rpt_cleaners = 1;
1862
		}
1863

1864
# check for Kconfig help text having a real description
1865 1866
# Only applies when adding the entry originally, after that we do not have
# sufficient context to determine whether it is indeed long enough.
1867
		if ($realfile =~ /Kconfig/ &&
1868
		    $line =~ /.\s*config\s+/) {
1869
			my $length = 0;
1870 1871 1872
			my $cnt = $realcnt;
			my $ln = $linenr + 1;
			my $f;
1873
			my $is_start = 0;
1874
			my $is_end = 0;
1875
			for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
1876 1877 1878 1879 1880
				$f = $lines[$ln - 1];
				$cnt-- if ($lines[$ln - 1] !~ /^-/);
				$is_end = $lines[$ln - 1] =~ /^\+/;

				next if ($f =~ /^-/);
1881 1882 1883 1884 1885 1886 1887

				if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
					$is_start = 1;
				} elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
					$length = -1;
				}

1888
				$f =~ s/^.//;
1889 1890 1891
				$f =~ s/#.*//;
				$f =~ s/^\s+//;
				next if ($f =~ /^$/);
1892 1893 1894 1895
				if ($f =~ /^\s*config\s/) {
					$is_end = 1;
					last;
				}
1896 1897
				$length++;
			}
1898
			WARN("CONFIG_DESCRIPTION",
1899 1900
			     "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
			#print "is_start<$is_start> is_end<$is_end> length<$length>\n";
1901 1902
		}

1903 1904 1905 1906 1907 1908 1909
# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
		if ($realfile =~ /Kconfig/ &&
		    $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
			WARN("CONFIG_EXPERIMENTAL",
			     "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
		}

1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923
		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});
		}

1924 1925 1926
# check we are in a valid source file if not then ignore this hunk
		next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);

1927
#line length limit
1928
		if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1929
		    $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1930
		    !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
1931
		    $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
1932
		    $length > $max_line_length)
1933
		{
1934
			WARN("LONG_LINE",
1935
			     "line over $max_line_length characters\n" . $herecurr);
1936 1937
		}

1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952
# Check for user-visible strings broken across lines, which breaks the ability
# to grep for the string.  Limited to strings used as parameters (those
# following an open parenthesis), which almost completely eliminates false
# positives, as well as warning only once per parameter rather than once per
# line of the string.  Make an exception when the previous string ends in a
# newline (multiple lines in one string constant) or \n\t (common in inline
# assembly to indent the instruction on the following line).
		if ($line =~ /^\+\s*"/ &&
		    $prevline =~ /"\s*$/ &&
		    $prevline =~ /\(/ &&
		    $prevrawline !~ /\\n(?:\\t)*"\s*$/) {
			WARN("SPLIT_STRING",
			     "quoted string split across lines\n" . $hereprev);
		}

1953 1954
# check for spaces before a quoted newline
		if ($rawline =~ /^.*\".*\s\\n/) {
1955 1956 1957 1958 1959 1960
			if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
				 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
			}

1961 1962
		}

1963 1964
# check for adding lines without a newline.
		if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1965 1966
			WARN("MISSING_EOF_NEWLINE",
			     "adding a line without newline at end of file\n" . $herecurr);
1967 1968
		}

1969 1970 1971 1972
# Blackfin: use hi/lo macros
		if ($realfile =~ m@arch/blackfin/.*\.S$@) {
			if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
				my $herevet = "$here\n" . cat_vet($line) . "\n";
1973 1974
				ERROR("LO_MACRO",
				      "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
1975 1976 1977
			}
			if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
				my $herevet = "$here\n" . cat_vet($line) . "\n";
1978 1979
				ERROR("HI_MACRO",
				      "use the HI() macro, not (... >> 16)\n" . $herevet);
1980 1981 1982
			}
		}

1983 1984
# check we are in a valid source file C or perl if not then ignore this hunk
		next if ($realfile !~ /\.(h|c|pl)$/);
1985 1986 1987

# at the beginning of a line any tabs must come first and anything
# more than 8 must use tabs.
1988 1989 1990
		if ($rawline =~ /^\+\s* \t\s*\S/ ||
		    $rawline =~ /^\+\s*        \s*/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1991
			$rpt_cleaners = 1;
1992 1993 1994 1995 1996
			if (ERROR("CODE_INDENT",
				  "code indent should use tabs where possible\n" . $herevet) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
			}
1997 1998
		}

1999 2000 2001
# check for space before tabs.
		if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2002 2003 2004 2005 2006 2007
			if (WARN("SPACE_BEFORE_TAB",
				"please, no space before tabs\n" . $herevet) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/(^\+.*) +\t/$1\t/;
			}
2008 2009
		}

2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024
# 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);
		}

# check multi-line statement indentation matches previous line
		if ($^V && $^V ge 5.10.0 &&
		    $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) {
			$prevline =~ /^\+(\t*)(.*)$/;
			my $oldindent = $1;
			my $rest = $2;

			my $pos = pos_last_openparen($rest);
			if ($pos >= 0) {
J
Joe Perches 已提交
2025 2026
				$line =~ /^(\+| )([ \t]*)/;
				my $newindent = $2;
2027 2028 2029 2030 2031 2032 2033 2034

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

				if ($newindent ne $goodtabindent &&
				    $newindent ne $goodspaceindent) {
2035 2036 2037 2038 2039 2040 2041

					if (CHK("PARENTHESIS_ALIGNMENT",
						"Alignment should match open parenthesis\n" . $hereprev) &&
					    $fix && $line =~ /^\+/) {
						$fixed[$linenr - 1] =~
						    s/^\+[ \t]*/\+$goodtabindent/;
					}
2042 2043 2044 2045
				}
			}
		}

2046
		if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
2047 2048 2049 2050 2051 2052
			if (CHK("SPACING",
				"No space is necessary after a cast\n" . $hereprev) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/^(\+.*\*[ \t]*\))[ \t]+/$1/;
			}
2053 2054
		}

2055
		if ($realfile =~ m@^(drivers/net/|net/)@ &&
2056 2057
		    $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
		    $rawline =~ /^\+[ \t]*\*/) {
2058 2059 2060 2061 2062
			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
			     "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
		}

		if ($realfile =~ m@^(drivers/net/|net/)@ &&
2063 2064 2065 2066 2067 2068 2069 2070
		    $prevrawline =~ /^\+[ \t]*\/\*/ &&		#starting /*
		    $prevrawline !~ /\*\/[ \t]*$/ &&		#no trailing */
		    $rawline !~ /^\+[ \t]*\*/) {		#no leading *
			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
			     "networking block comments start with * on subsequent lines\n" . $hereprev);
		}

		if ($realfile =~ m@^(drivers/net/|net/)@ &&
2071 2072 2073 2074
		    $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ &&	#trailing */
		    $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ &&	#inline /*...*/
		    $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ &&	#trailing **/
		    $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) {	#non blank */
2075 2076 2077 2078
			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
			     "networking block comments put the trailing */ on a separate line\n" . $herecurr);
		}

2079
# check for spaces at the beginning of a line.
2080 2081 2082 2083
# Exceptions:
#  1) within comments
#  2) indented preprocessor commands
#  3) hanging labels
2084
		if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/)  {
2085
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2086 2087 2088 2089 2090
			if (WARN("LEADING_SPACE",
				 "please, no spaces at the start of a line\n" . $herevet) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
			}
2091 2092
		}

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

2096 2097 2098 2099 2100 2101
# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
		if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
			WARN("CONFIG_EXPERIMENTAL",
			     "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
		}

2102
# check for RCS/CVS revision markers
2103
		if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
2104 2105
			WARN("CVS_KEYWORD",
			     "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
2106
		}
2107

2108 2109 2110
# Blackfin: don't use __builtin_bfin_[cs]sync
		if ($line =~ /__builtin_bfin_csync/) {
			my $herevet = "$here\n" . cat_vet($line) . "\n";
2111 2112
			ERROR("CSYNC",
			      "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
2113 2114 2115
		}
		if ($line =~ /__builtin_bfin_ssync/) {
			my $herevet = "$here\n" . cat_vet($line) . "\n";
2116 2117
			ERROR("SSYNC",
			      "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
2118 2119
		}

2120 2121 2122 2123 2124 2125
# 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);
		}

2126
# Check for potential 'bare' types
2127 2128
		my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
		    $realline_next);
2129 2130 2131
#print "LINE<$line>\n";
		if ($linenr >= $suppress_statement &&
		    $realcnt && $line =~ /.\s*\S/) {
2132
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2133
				ctx_statement_block($linenr, $realcnt, 0);
2134 2135 2136
			$stat =~ s/\n./\n /g;
			$cond =~ s/\n./\n /g;

2137 2138 2139 2140 2141 2142 2143 2144 2145
#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;
			}
2146

2147 2148 2149 2150 2151 2152 2153 2154
			# 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++;
			}

2155 2156
			my $s = $stat;
			$s =~ s/{.*$//s;
2157

2158
			# Ignore goto labels.
2159
			if ($s =~ /$Ident:\*$/s) {
2160 2161

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

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

2166
			# declarations always start with types
2167
			} 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) {
2168 2169 2170 2171
				my $type = $1;
				$type =~ s/\s+/ /g;
				possible($type, "A:" . $s);

2172
			# definitions in global scope can only start with types
2173
			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
2174
				possible($1, "B:" . $s);
2175
			}
2176 2177

			# any (foo ... *) is a pointer cast, and foo is a type
2178
			while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
2179
				possible($1, "C:" . $s);
2180 2181 2182 2183 2184
			}

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

2188
				my $ctx = $s;
2189
				substr($ctx, 0, $name_len + 1, '');
2190
				$ctx =~ s/\)[^\)]*$//;
2191

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

2195
						possible($1, "D:" . $s);
2196 2197
					}
				}
2198
			}
2199

2200 2201
		}

2202 2203 2204
#
# Checks which may be anchored in the context.
#
2205

2206 2207
# Check for switch () and associated case and default
# statements should be at the same indent.
2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223
		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 '') {
2224 2225
				ERROR("SWITCH_CASE_INDENT_LEVEL",
				      "switch and case should be at the same indent\n$hereline$err");
2226 2227 2228 2229 2230
			}
		}

# 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
2231
		if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2232 2233
			my $pre_ctx = "$1$2";

2234
			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2235 2236 2237 2238 2239 2240

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

2241 2242 2243
			my $ctx_cnt = $realcnt - $#ctx - 1;
			my $ctx = join("\n", @ctx);

2244 2245
			my $ctx_ln = $linenr;
			my $ctx_skip = $realcnt;
2246

2247 2248 2249 2250 2251
			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] !~ /^-/);
2252 2253
				$ctx_ln++;
			}
2254

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

2258
			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2259 2260
				ERROR("OPEN_BRACE",
				      "that open brace { should be on the previous line\n" .
2261
					"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2262
			}
2263 2264 2265 2266
			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
			    $ctx =~ /\)\s*\;\s*$/ &&
			    defined $lines[$ctx_ln - 1])
			{
2267 2268
				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
				if ($nindent > $indent) {
2269 2270
					WARN("TRAILING_SEMICOLON",
					     "trailing semicolon indicates no statements, indent implies otherwise\n" .
2271
						"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2272 2273
				}
			}
2274 2275
		}

2276 2277
# Check relative indent for conditionals and blocks.
		if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2278 2279 2280
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
2281 2282 2283 2284 2285 2286 2287 2288 2289 2290
			my ($s, $c) = ($stat, $cond);

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

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

			# Find out how long the conditional actually is.
2291 2292
			my @newlines = ($c =~ /\n/gs);
			my $cond_lines = 1 + $#newlines;
2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305

			# 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;
			}
2306
			if ($s =~ s/^\s*?\n//) {
2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317
				$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;
			}

2318
			my $cond_ptr = -1;
2319
			$continuation = 0;
2320 2321 2322
			while ($cond_ptr != $cond_lines) {
				$cond_ptr = $cond_lines;

2323 2324 2325 2326 2327 2328
				# If we see an #else/#elif then the code
				# is not linear.
				if ($s =~ /^\s*\#\s*(?:else|elif)/) {
					$check = 0;
				}

2329 2330 2331 2332
				# Ignore:
				#  1) blank lines, they should be at 0,
				#  2) preprocessor lines, and
				#  3) labels.
2333 2334
				if ($continuation ||
				    $s =~ /^\s*?\n/ ||
2335 2336
				    $s =~ /^\s*#\s*?/ ||
				    $s =~ /^\s*$Ident\s*:/) {
2337
					$continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2338 2339 2340
					if ($s =~ s/^.*?\n//) {
						$cond_lines++;
					}
2341
				}
2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356
			}

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

2357
			#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";
2358 2359 2360

			if ($check && (($sindent % 8) != 0 ||
			    ($sindent <= $indent && $s ne ''))) {
2361 2362
				WARN("SUSPECT_CODE_INDENT",
				     "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2363 2364 2365
			}
		}

2366 2367
		# Track the 'values' across context and added lines.
		my $opline = $line; $opline =~ s/^./ /;
2368 2369
		my ($curr_values, $curr_vars) =
				annotate_values($opline . "\n", $prev_values);
2370
		$curr_values = $prev_values . $curr_values;
2371 2372
		if ($dbg_values) {
			my $outline = $opline; $outline =~ s/\t/ /g;
2373 2374
			print "$linenr > .$outline\n";
			print "$linenr > $curr_values\n";
2375
			print "$linenr >  $curr_vars\n";
2376
		}
2377 2378
		$prev_values = substr($curr_values, -1);

2379
#ignore lines not being added
2380
		next if ($line =~ /^[^\+]/);
2381

2382
# TEST: allow direct testing of the type matcher.
2383 2384
		if ($dbg_type) {
			if ($line =~ /^.\s*$Declare\s*$/) {
2385 2386
				ERROR("TEST_TYPE",
				      "TEST: is type\n" . $herecurr);
2387
			} elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2388 2389
				ERROR("TEST_NOT_TYPE",
				      "TEST: is not type ($1 is)\n". $herecurr);
2390
			}
2391 2392
			next;
		}
2393 2394
# TEST: allow direct testing of the attribute matcher.
		if ($dbg_attr) {
2395
			if ($line =~ /^.\s*$Modifier\s*$/) {
2396 2397
				ERROR("TEST_ATTR",
				      "TEST: is attr\n" . $herecurr);
2398
			} elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2399 2400
				ERROR("TEST_NOT_ATTR",
				      "TEST: is not attr ($1 is)\n". $herecurr);
2401 2402 2403
			}
			next;
		}
2404

2405
# check for initialisation to aggregates open brace on the next line
2406 2407
		if ($line =~ /^.\s*{/ &&
		    $prevline =~ /(?:^|[^=])=\s*$/) {
2408 2409
			ERROR("OPEN_BRACE",
			      "that open brace { should be on the previous line\n" . $hereprev);
2410 2411
		}

2412 2413 2414 2415 2416
#
# Checks which are anchored on the added line.
#

# check for malformed paths in #include statements (uses RAW line)
2417
		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2418 2419
			my $path = $1;
			if ($path =~ m{//}) {
2420
				ERROR("MALFORMED_INCLUDE",
2421 2422 2423 2424 2425
				      "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);
2426 2427
			}
		}
2428

2429
# no C99 // comments
2430
		if ($line =~ m{//}) {
2431 2432 2433 2434 2435 2436 2437 2438 2439
			if (ERROR("C99_COMMENTS",
				  "do not use C99 // comments\n" . $herecurr) &&
			    $fix) {
				my $line = $fixed[$linenr - 1];
				if ($line =~ /\/\/(.*)$/) {
					my $comment = trim($1);
					$fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@;
				}
			}
2440
		}
2441
		# Remove C99 comments.
2442
		$line =~ s@//.*@@;
2443
		$opline =~ s@//.*@@;
2444

2445 2446 2447 2448 2449 2450 2451 2452
# 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.*\((.*)\)/)) {
2453 2454 2455 2456
			# Handle definitions which produce identifiers with
			# a prefix:
			#   XXX(foo);
			#   EXPORT_SYMBOL(something_foo);
2457
			my $name = $1;
2458
			if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
2459 2460 2461 2462 2463
			    $name =~ /^${Ident}_$2/) {
#print "FOO C name<$name>\n";
				$suppress_export{$realline_next} = 1;

			} elsif ($stat !~ /(?:
2464
				\n.}\s*$|
2465 2466 2467
				^.DEFINE_$Ident\(\Q$name\E\)|
				^.DECLARE_$Ident\(\Q$name\E\)|
				^.LIST_HEAD\(\Q$name\E\)|
2468 2469
				^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
				\b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
2470
			    )/x) {
2471 2472 2473 2474
#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
				$suppress_export{$realline_next} = 2;
			} else {
				$suppress_export{$realline_next} = 1;
2475 2476
			}
		}
2477 2478 2479 2480 2481 2482 2483 2484 2485
		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) {
2486 2487
			WARN("EXPORT_SYMBOL",
			     "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2488
		}
2489

2490
# check for global initialisers.
2491 2492 2493 2494 2495 2496 2497
		if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
			if (ERROR("GLOBAL_INITIALISERS",
				  "do not initialise globals to 0 or NULL\n" .
				      $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
			}
2498
		}
2499
# check for static initialisers.
2500 2501 2502 2503 2504 2505 2506
		if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
			if (ERROR("INITIALISED_STATIC",
				  "do not initialise statics to 0 or NULL\n" .
				      $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
			}
2507 2508
		}

2509 2510
# check for static const char * arrays.
		if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
2511 2512
			WARN("STATIC_CONST_CHAR_ARRAY",
			     "static const char * array should probably be static const char * const\n" .
2513 2514 2515 2516 2517
				$herecurr);
               }

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

2523 2524
# check for declarations of struct pci_device_id
		if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
2525 2526
			WARN("DEFINE_PCI_DEVICE_TABLE",
			     "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
2527 2528
		}

2529 2530 2531
# check for new typedefs, only function parameters and sparse annotations
# make sense.
		if ($line =~ /\btypedef\s/ &&
2532
		    $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
2533
		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
2534
		    $line !~ /\b$typeTypedefs\b/ &&
2535
		    $line !~ /\b__bitwise(?:__|)\b/) {
2536 2537
			WARN("NEW_TYPEDEFS",
			     "do not add new typedefs\n" . $herecurr);
2538 2539 2540
		}

# * goes on variable not on type
2541
		# (char*[ const])
2542 2543
		while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
			#print "AA<$1>\n";
2544
			my ($ident, $from, $to) = ($1, $2, $2);
2545 2546 2547 2548 2549 2550

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

2554
##			print "1: from<$from> to<$to> ident<$ident>\n";
2555
			if ($from ne $to) {
2556 2557 2558 2559 2560 2561 2562 2563 2564
				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/;
					$fixed[$linenr - 1] =~
					    s@\Q$sub_from\E@$sub_to@;
				}
2565
			}
2566 2567 2568
		}
		while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
			#print "BB<$1>\n";
2569
			my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
2570 2571 2572 2573 2574 2575

			# Should start with a space.
			$to =~ s/^(\S)/ $1/;
			# Should not end with a space.
			$to =~ s/\s+$//;
			# '*'s should not have spaces between.
2576
			while ($to =~ s/\*\s+\*/\*\*/) {
2577 2578 2579
			}
			# Modifiers should have spaces.
			$to =~ s/(\b$Modifier$)/$1 /;
2580

2581
##			print "2: from<$from> to<$to> ident<$ident>\n";
2582
			if ($from ne $to && $ident !~ /^$Modifier$/) {
2583 2584 2585 2586 2587 2588 2589 2590 2591 2592
				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/;
					$fixed[$linenr - 1] =~
					    s@\Q$sub_from\E@$sub_to@;
				}
2593
			}
2594 2595 2596 2597 2598 2599 2600 2601 2602
		}

# # no BUG() or BUG_ON()
# 		if ($line =~ /\b(BUG|BUG_ON)\b/) {
# 			print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
# 			print "$herecurr";
# 			$clean = 0;
# 		}

2603
		if ($line =~ /\bLINUX_VERSION_CODE\b/) {
2604 2605
			WARN("LINUX_VERSION_CODE",
			     "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
2606 2607
		}

2608 2609
# check for uses of printk_ratelimit
		if ($line =~ /\bprintk_ratelimit\s*\(/) {
2610 2611
			WARN("PRINTK_RATELIMITED",
"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
2612 2613
		}

2614 2615 2616
# printk should use KERN_* levels.  Note that follow on printk's on the
# same line do not need a level, so we use the current block context
# to try and find and validate the current printk.  In summary the current
L
Lucas De Marchi 已提交
2617
# printk includes all preceding printk's which have no newline on the end.
2618
# we assume the first bad printk is the one to report.
2619
		if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
2620 2621 2622
			my $ok = 0;
			for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
				#print "CHECK<$lines[$ln - 1]\n";
L
Lucas De Marchi 已提交
2623
				# we have a preceding printk if it ends
2624 2625 2626 2627 2628 2629 2630 2631 2632
				# with "\n" ignore it, else it is to blame
				if ($lines[$ln - 1] =~ m{\bprintk\(}) {
					if ($rawlines[$ln - 1] !~ m{\\n"}) {
						$ok = 1;
					}
					last;
				}
			}
			if ($ok == 0) {
2633 2634
				WARN("PRINTK_WITHOUT_KERN_LEVEL",
				     "printk() should include KERN_ facility level\n" . $herecurr);
2635
			}
2636 2637
		}

2638 2639 2640 2641
		if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
			my $orig = $1;
			my $level = lc($orig);
			$level = "warn" if ($level eq "warning");
2642 2643
			my $level2 = $level;
			$level2 = "dbg" if ($level eq "debug");
2644
			WARN("PREFER_PR_LEVEL",
2645
			     "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(...  to printk(KERN_$orig ...\n" . $herecurr);
2646 2647 2648
		}

		if ($line =~ /\bpr_warning\s*\(/) {
2649 2650 2651 2652 2653 2654
			if (WARN("PREFER_PR_LEVEL",
				 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/\bpr_warning\b/pr_warn/;
			}
2655 2656
		}

2657 2658 2659 2660 2661 2662 2663 2664 2665
		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);
		}

2666 2667
# function brace can't be on same line, except for #defines of do while,
# or if closed on same line
2668 2669
		if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
		    !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
2670 2671
			ERROR("OPEN_BRACE",
			      "open brace '{' following function declarations go on the next line\n" . $herecurr);
2672
		}
2673

2674 2675 2676
# 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*$/) {
2677 2678
			ERROR("OPEN_BRACE",
			      "open brace '{' following $1 go on the same line\n" . $hereprev);
2679 2680
		}

2681
# missing space after union, struct or enum definition
2682 2683 2684 2685 2686 2687 2688
		if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
			if (WARN("SPACING",
				 "missing space after $1 definition\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
			}
2689 2690
		}

2691 2692
# check for spacing round square brackets; allowed:
#  1. with a type on the left -- int [] a;
2693 2694
#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
#  3. inside a curly brace -- = { [0...10] = 5 }
2695 2696 2697
		while ($line =~ /(.*?\s)\[/g) {
			my ($where, $prefix) = ($-[1], $1);
			if ($prefix !~ /$Type\s+$/ &&
2698
			    ($where != 0 || $prefix !~ /^.\s+$/) &&
2699
			    $prefix !~ /[{,]\s+$/) {
2700 2701 2702 2703 2704 2705
				if (ERROR("BRACKET_SPACE",
					  "space prohibited before open square bracket '['\n" . $herecurr) &&
				    $fix) {
				    $fixed[$linenr - 1] =~
					s/^(\+.*?)\s+\[/$1\[/;
				}
2706 2707 2708
			}
		}

2709
# check for spaces between functions and their parentheses.
2710
		while ($line =~ /($Ident)\s+\(/g) {
2711
			my $name = $1;
2712 2713
			my $ctx_before = substr($line, 0, $-[1]);
			my $ctx = "$ctx_before$name";
2714 2715

			# Ignore those directives where spaces _are_ permitted.
2716 2717 2718 2719 2720 2721
			if ($name =~ /^(?:
				if|for|while|switch|return|case|
				volatile|__volatile__|
				__attribute__|format|__extension__|
				asm|__asm__)$/x)
			{
2722 2723 2724
			# 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.
2725
			} elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
2726 2727

			# cpp #elif statement condition may start with a (
2728
			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
2729 2730 2731

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

			} else {
2735 2736 2737 2738 2739 2740
				if (WARN("SPACING",
					 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
					     $fix) {
					$fixed[$linenr - 1] =~
					    s/\b$name\s+\(/$name\(/;
				}
2741
			}
2742
		}
2743

2744
# Check operator spacing.
2745
		if (!($line=~/\#\s*include/)) {
2746 2747 2748
			my $fixed_line = "";
			my $line_fixed = 0;

2749 2750 2751 2752
			my $ops = qr{
				<<=|>>=|<=|>=|==|!=|
				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
				=>|->|<<|>>|<|>|=|!|~|
2753 2754
				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
				\?|:
2755
			}x;
2756
			my @elements = split(/($ops|;)/, $opline);
2757 2758 2759 2760 2761 2762 2763

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

			my @fix_elements = ();
2764
			my $off = 0;
2765

2766 2767 2768 2769 2770 2771 2772
			foreach my $el (@elements) {
				push(@fix_elements, substr($rawline, $off, length($el)));
				$off += length($el);
			}

			$off = 0;

2773 2774
			my $blank = copy_spacing($opline);

2775
			for (my $n = 0; $n < $#elements; $n += 2) {
2776 2777 2778 2779 2780

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

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

2781 2782
				$off += length($elements[$n]);

L
Lucas De Marchi 已提交
2783
				# Pick up the preceding and succeeding characters.
2784 2785 2786 2787 2788 2789 2790
				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";

2791 2792 2793
				my $a = '';
				$a = 'V' if ($elements[$n] ne '');
				$a = 'W' if ($elements[$n] =~ /\s$/);
2794
				$a = 'C' if ($elements[$n] =~ /$;$/);
2795 2796
				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
				$a = 'O' if ($elements[$n] eq '');
2797
				$a = 'E' if ($ca =~ /^\s*$/);
2798

2799
				my $op = $elements[$n + 1];
2800 2801

				my $c = '';
2802
				if (defined $elements[$n + 2]) {
2803 2804
					$c = 'V' if ($elements[$n + 2] ne '');
					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
2805
					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
2806 2807
					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
					$c = 'O' if ($elements[$n + 2] eq '');
2808
					$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
2809 2810
				} else {
					$c = 'E';
2811 2812
				}

2813 2814 2815 2816
				my $ctx = "${a}x${c}";

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

2817
				my $ptr = substr($blank, 0, $off) . "^";
2818
				my $hereptr = "$hereline$ptr\n";
2819

2820
				# Pull out the value of this operator.
2821
				my $op_type = substr($curr_values, $off + 1, 1);
2822

2823 2824 2825
				# Get the full operator variant.
				my $opv = $op . substr($curr_vars, $off, 1);

2826 2827 2828 2829
				# Ignore operators passed as parameters.
				if ($op_type ne 'V' &&
				    $ca =~ /\s$/ && $cc =~ /^\s*,/) {

2830 2831
#				# Ignore comments
#				} elsif ($op =~ /^$;+$/) {
2832

2833
				# ; should have either the end of line or a space or \ after it
2834
				} elsif ($op eq ';') {
2835 2836
					if ($ctx !~ /.x[WEBC]/ &&
					    $cc !~ /^\\/ && $cc !~ /^;/) {
2837 2838 2839 2840 2841
						if (ERROR("SPACING",
							  "space required after that '$op' $at\n" . $hereptr)) {
							$good = trim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
							$line_fixed = 1;
						}
2842 2843 2844 2845
					}

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

2847 2848 2849 2850
				# No spaces for:
				#   ->
				#   :   when part of a bitfield
				} elsif ($op eq '->' || $opv eq ':B') {
2851
					if ($ctx =~ /Wx.|.xW/) {
2852 2853 2854 2855 2856 2857 2858 2859
						if (ERROR("SPACING",
							  "spaces prohibited around that '$op' $at\n" . $hereptr)) {
							$good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
							$line_fixed = 1;
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
						}
2860 2861 2862 2863
					}

				# , must have a space on the right.
				} elsif ($op eq ',') {
2864
					if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
2865 2866 2867 2868 2869
						if (ERROR("SPACING",
							  "space required after that '$op' $at\n" . $hereptr)) {
							$good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]) . " ";
							$line_fixed = 1;
						}
2870 2871
					}

2872
				# '*' as part of a type definition -- reported already.
2873
				} elsif ($opv eq '*_') {
2874 2875 2876 2877 2878 2879
					#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 '~' ||
2880
					 $opv eq '*U' || $opv eq '-U' ||
2881
					 $opv eq '&U' || $opv eq '&&U') {
2882
					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
2883 2884 2885 2886 2887
						if (ERROR("SPACING",
							  "space required before that '$op' $at\n" . $hereptr)) {
							$good = trim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
							$line_fixed = 1;
						}
2888
					}
2889
					if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
2890 2891 2892
						# A unary '*' may be const

					} elsif ($ctx =~ /.xW/) {
2893 2894 2895 2896 2897 2898 2899 2900 2901
						if (ERROR("SPACING",
							  "space prohibited after that '$op' $at\n" . $hereptr)) {
							$fixed_line =~ s/\s+$//;
							$good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
							$line_fixed = 1;
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
						}
2902 2903 2904 2905
					}

				# unary ++ and unary -- are allowed no space on one side.
				} elsif ($op eq '++' or $op eq '--') {
2906
					if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2907 2908 2909 2910 2911 2912
						if (ERROR("SPACING",
							  "space required one side of that '$op' $at\n" . $hereptr)) {
							$fixed_line =~ s/\s+$//;
							$good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]) . " ";
							$line_fixed = 1;
						}
2913 2914 2915
					}
					if ($ctx =~ /Wx[BE]/ ||
					    ($ctx =~ /Wx./ && $cc =~ /^;/)) {
2916 2917 2918 2919 2920 2921
						if (ERROR("SPACING",
							  "space prohibited before that '$op' $at\n" . $hereptr)) {
							$fixed_line =~ s/\s+$//;
							$good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
							$line_fixed = 1;
						}
2922
					}
2923
					if ($ctx =~ /ExW/) {
2924 2925 2926 2927 2928 2929 2930 2931 2932
						if (ERROR("SPACING",
							  "space prohibited after that '$op' $at\n" . $hereptr)) {
							$fixed_line =~ s/\s+$//;
							$good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
							$line_fixed = 1;
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
						}
2933
					}
2934 2935

				# << and >> may either have or not have spaces both sides
2936 2937 2938
				} elsif ($op eq '<<' or $op eq '>>' or
					 $op eq '&' or $op eq '^' or $op eq '|' or
					 $op eq '+' or $op eq '-' or
2939 2940
					 $op eq '*' or $op eq '/' or
					 $op eq '%')
2941
				{
2942
					if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
2943 2944 2945 2946 2947 2948
						if (ERROR("SPACING",
							  "need consistent spacing around '$op' $at\n" . $hereptr)) {
							$fixed_line =~ s/\s+$//;
							$good = trim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
							$line_fixed = 1;
						}
2949 2950
					}

2951 2952 2953 2954
				# 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./) {
2955 2956 2957 2958 2959
						if (ERROR("SPACING",
							  "space prohibited before that '$op' $at\n" . $hereptr)) {
							$good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
							$line_fixed = 1;
						}
2960 2961
					}

2962
				# All the others need spaces both sides.
2963
				} elsif ($ctx !~ /[EWC]x[CWE]/) {
2964 2965
					my $ok = 0;

2966
					# Ignore email addresses <foo@bar>
2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981
					if (($op eq '<' &&
					     $cc =~ /^\S+\@\S+>/) ||
					    ($op eq '>' &&
					     $ca =~ /<\S+\@\S+$/))
					{
					    	$ok = 1;
					}

					# Ignore ?:
					if (($opv eq ':O' && $ca =~ /\?$/) ||
					    ($op eq '?' && $cc =~ /^:/)) {
					    	$ok = 1;
					}

					if ($ok == 0) {
2982 2983 2984 2985 2986 2987
						if (ERROR("SPACING",
							  "spaces required around that '$op' $at\n" . $hereptr)) {
							$good = trim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
							$good = $fix_elements[$n] . " " . trim($fix_elements[$n + 1]) . " ";
							$line_fixed = 1;
						}
2988
					}
2989
				}
2990
				$off += length($elements[$n + 1]);
2991 2992 2993 2994 2995 2996 2997 2998

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

				$fixed_line = $fixed_line . $good;
			}

			if (($#elements % 2) == 0) {
				$fixed_line = $fixed_line . $fix_elements[$#elements];
2999
			}
3000 3001 3002 3003 3004 3005

			if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) {
				$fixed[$linenr - 1] = $fixed_line;
			}


3006 3007
		}

3008 3009 3010 3011 3012 3013 3014 3015 3016 3017
# check for whitespace before a non-naked semicolon
		if ($line =~ /^\+.*\S\s+;/) {
			if (WARN("SPACING",
				 "space prohibited before semicolon\n" . $herecurr) &&
			    $fix) {
				1 while $fixed[$linenr - 1] =~
				    s/^(\+.*\S)\s+;/$1;/;
			}
		}

3018 3019
# check for multiple assignments
		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
3020 3021
			CHK("MULTIPLE_ASSIGNMENTS",
			    "multiple assignments should be avoided\n" . $herecurr);
3022 3023
		}

3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034
## # 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 =~ /,/) {
3035 3036
## 				WARN("MULTIPLE_DECLARATION",
##				     "declaring multiple variables together should be avoided\n" . $herecurr);
3037 3038
## 			}
## 		}
3039

3040
#need space before brace following if, while, etc
3041 3042
		if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
		    $line =~ /do{/) {
3043 3044 3045
			if (ERROR("SPACING",
				  "space required before the open brace '{'\n" . $herecurr) &&
			    $fix) {
3046
				$fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/;
3047
			}
3048 3049
		}

3050 3051 3052 3053 3054 3055 3056 3057
## # check for blank lines before declarations
##		if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
##		    $prevrawline =~ /^.\s*$/) {
##			WARN("SPACING",
##			     "No blank lines before declarations\n" . $hereprev);
##		}
##

3058 3059 3060
# closing brace should have a space following it when it has anything
# on the line
		if ($line =~ /}(?!(?:,|;|\)))\S/) {
3061 3062 3063 3064 3065 3066
			if (ERROR("SPACING",
				  "space required after that close brace '}'\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/}((?!(?:,|;|\)))\S)/} $1/;
			}
3067 3068
		}

3069 3070
# check spacing on square brackets
		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
3071 3072 3073 3074 3075 3076
			if (ERROR("SPACING",
				  "space prohibited after that open square bracket '['\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/\[\s+/\[/;
			}
3077 3078
		}
		if ($line =~ /\s\]/) {
3079 3080 3081 3082 3083 3084
			if (ERROR("SPACING",
				  "space prohibited before that close square bracket ']'\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/\s+\]/\]/;
			}
3085 3086
		}

3087
# check spacing on parentheses
3088 3089
		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
		    $line !~ /for\s*\(\s+;/) {
3090 3091 3092 3093 3094 3095
			if (ERROR("SPACING",
				  "space prohibited after that open parenthesis '('\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/\(\s+/\(/;
			}
3096
		}
3097
		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
3098 3099
		    $line !~ /for\s*\(.*;\s+\)/ &&
		    $line !~ /:\s+\)/) {
3100 3101 3102 3103 3104 3105
			if (ERROR("SPACING",
				  "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/\s+\)/\)/;
			}
3106 3107
		}

3108
#goto labels aren't indented, allow a single space however
3109
		if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
3110
		   !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
3111 3112 3113 3114 3115 3116
			if (WARN("INDENTED_LABEL",
				 "labels should not be indented\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/^(.)\s+/$1/;
			}
3117 3118
		}

3119 3120 3121 3122 3123
# Return is not a function.
		if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
			my $spacing = $1;
			my $value = $2;

3124
			# Flatten any parentheses
3125 3126
			$value =~ s/\(/ \(/g;
			$value =~ s/\)/\) /g;
3127
			while ($value =~ s/\[[^\[\]]*\]/1/ ||
3128 3129 3130 3131
			       $value !~ /(?:$Ident|-?$Constant)\s*
					     $Compare\s*
					     (?:$Ident|-?$Constant)/x &&
			       $value =~ s/\([^\(\)]*\)/1/) {
3132
			}
3133 3134
#print "value<$value>\n";
			if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
3135 3136
				ERROR("RETURN_PARENTHESES",
				      "return is not a function, parentheses are not required\n" . $herecurr);
3137 3138

			} elsif ($spacing !~ /\s+/) {
3139 3140
				ERROR("SPACING",
				      "space required before the open parenthesis '('\n" . $herecurr);
3141 3142
			}
		}
3143 3144 3145 3146
# Return of what appears to be an errno should normally be -'ve
		if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
			my $name = $1;
			if ($name ne 'EOF' && $name ne 'ERROR') {
3147 3148
				WARN("USE_NEGATIVE_ERRNO",
				     "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
3149 3150
			}
		}
3151

3152
# Need a space before open parenthesis after if, while etc
3153 3154 3155 3156 3157 3158 3159
		if ($line =~ /\b(if|while|for|switch)\(/) {
			if (ERROR("SPACING",
				  "space required before the open parenthesis '('\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/\b(if|while|for|switch)\(/$1 \(/;
			}
3160 3161
		}

3162 3163
# Check for illegal assignment in if conditional -- and check for trailing
# statements after the conditional.
3164
		if ($line =~ /do\s*(?!{)/) {
3165 3166 3167
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186
			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} &&
		    $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
3187
			my ($s, $c) = ($stat, $cond);
3188

3189
			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
3190 3191
				ERROR("ASSIGN_IN_IF",
				      "do not use assignment in if condition\n" . $herecurr);
3192 3193 3194 3195
			}

			# Find out what is on the end of the line after the
			# conditional.
3196
			substr($s, 0, length($c), '');
3197
			$s =~ s/\n.*//g;
3198
			$s =~ s/$;//g; 	# Remove any comments
3199 3200
			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
			    $c !~ /}\s*while\s*/)
3201
			{
3202 3203 3204
				# Find out how long the conditional actually is.
				my @newlines = ($c =~ /\n/gs);
				my $cond_lines = 1 + $#newlines;
3205
				my $stat_real = '';
3206

3207 3208
				$stat_real = raw_line($linenr, $cond_lines)
							. "\n" if ($cond_lines);
3209 3210 3211 3212
				if (defined($stat_real) && $cond_lines > 1) {
					$stat_real = "[...]\n$stat_real";
				}

3213 3214
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr . $stat_real);
3215 3216 3217
			}
		}

3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229
# Check for bitwise tests written as boolean
		if ($line =~ /
			(?:
				(?:\[|\(|\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\|)
			|
				(?:\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\||\)|\])
			)/x)
		{
3230 3231
			WARN("HEXADECIMAL_BOOLEAN_TEST",
			     "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
3232 3233
		}

3234
# if and else should not have general statements after it
3235 3236 3237 3238
		if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
			my $s = $1;
			$s =~ s/$;//g; 	# Remove any comments
			if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
3239 3240
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr);
3241
			}
3242
		}
3243 3244
# if should not continue a brace
		if ($line =~ /}\s*if\b/) {
3245 3246
			ERROR("TRAILING_STATEMENTS",
			      "trailing statements should be on next line\n" .
3247 3248
				$herecurr);
		}
3249 3250 3251
# case and default should not have general statements after them
		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
		    $line !~ /\G(?:
3252
			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
3253 3254 3255
			\s*return\s+
		    )/xg)
		{
3256 3257
			ERROR("TRAILING_STATEMENTS",
			      "trailing statements should be on next line\n" . $herecurr);
3258
		}
3259 3260 3261 3262 3263

		# Check for }<nl>else {, these must be at the same
		# indent level to be relevant to each other.
		if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
						$previndent == $indent) {
3264 3265
			ERROR("ELSE_AFTER_BRACE",
			      "else should follow close brace '}'\n" . $hereprev);
3266 3267
		}

3268 3269 3270 3271 3272 3273
		if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
						$previndent == $indent) {
			my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);

			# Find out what is on the end of the line after the
			# conditional.
3274
			substr($s, 0, length($c), '');
3275 3276 3277
			$s =~ s/\n.*//g;

			if ($s =~ /^\s*;/) {
3278 3279
				ERROR("WHILE_AFTER_BRACE",
				      "while should follow close brace '}'\n" . $hereprev);
3280 3281 3282
			}
		}

3283
#Specific variable tests
3284 3285
		while ($line =~ m{($Constant|$Lval)}g) {
			my $var = $1;
3286 3287 3288

#gcc binary extension
			if ($var =~ /^$Binary$/) {
3289 3290 3291 3292 3293 3294 3295
				if (WARN("GCC_BINARY_CONSTANT",
					 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
				    $fix) {
					my $hexval = sprintf("0x%x", oct($var));
					$fixed[$linenr - 1] =~
					    s/\b$var\b/$hexval/;
				}
3296 3297 3298
			}

#CamelCase
3299
			if ($var !~ /^$Constant$/ &&
3300
			    $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
3301
#Ignore Page<foo> variants
3302
			    $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
3303
#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
3304
			    $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
3305 3306 3307 3308 3309 3310 3311 3312 3313
				while ($var =~ m{($Ident)}g) {
					my $word = $1;
					next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
					seed_camelcase_includes() if ($check);
					if (!defined $camelcase{$word}) {
						$camelcase{$word} = 1;
						CHK("CAMELCASE",
						    "Avoid CamelCase: <$word>\n" . $herecurr);
					}
3314
				}
3315 3316
			}
		}
3317 3318

#no spaces allowed after \ in define
3319 3320 3321 3322 3323 3324
		if ($line =~ /\#\s*define.*\\\s+$/) {
			if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
				 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/\s+$//;
			}
3325 3326
		}

3327
#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
3328
		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
3329 3330 3331 3332
			my $file = "$1.h";
			my $checkfile = "include/linux/$file";
			if (-f "$root/$checkfile" &&
			    $realfile ne $checkfile &&
3333
			    $1 !~ /$allowed_asm_includes/)
3334
			{
3335
				if ($realfile =~ m{^arch/}) {
3336 3337
					CHK("ARCH_INCLUDE_LINUX",
					    "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
3338
				} else {
3339 3340
					WARN("INCLUDE_LINUX",
					     "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
3341
				}
3342 3343 3344
			}
		}

3345 3346
# 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
3347
# in a known good container
3348 3349
		if ($realfile !~ m@/vmlinux.lds.h$@ &&
		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
3350 3351
			my $ln = $linenr;
			my $cnt = $realcnt;
3352 3353 3354
			my ($off, $dstat, $dcond, $rest);
			my $ctx = '';
			($dstat, $dcond, $ln, $cnt, $off) =
3355 3356
				ctx_statement_block($linenr, $realcnt, 0);
			$ctx = $dstat;
3357
			#print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
3358
			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
3359

3360
			$dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
3361
			$dstat =~ s/$;//g;
3362 3363 3364
			$dstat =~ s/\\\n.//g;
			$dstat =~ s/^\s*//s;
			$dstat =~ s/\s*$//s;
3365

3366
			# Flatten any parentheses and braces
3367 3368
			while ($dstat =~ s/\([^\(\)]*\)/1/ ||
			       $dstat =~ s/\{[^\{\}]*\}/1/ ||
3369
			       $dstat =~ s/\[[^\[\]]*\]/1/)
3370
			{
3371
			}
3372

3373 3374 3375 3376 3377 3378
			# Flatten any obvious string concatentation.
			while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
			       $dstat =~ s/$Ident\s*("X*")/$1/)
			{
			}

3379 3380 3381
			my $exceptions = qr{
				$Declare|
				module_param_named|
3382
				MODULE_PARM_DESC|
3383 3384
				DECLARE_PER_CPU|
				DEFINE_PER_CPU|
3385
				__typeof__\(|
3386 3387
				union|
				struct|
3388 3389
				\.$Ident\s*=\s*|
				^\"|\"$
3390
			}x;
3391
			#print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
3392 3393 3394
			if ($dstat ne '' &&
			    $dstat !~ /^(?:$Ident|-?$Constant),$/ &&			# 10, // foo(),
			    $dstat !~ /^(?:$Ident|-?$Constant);$/ &&			# foo();
3395
			    $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ &&		# 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
3396
			    $dstat !~ /^'X'$/ &&					# character constants
3397 3398
			    $dstat !~ /$exceptions/ &&
			    $dstat !~ /^\.$Ident\s*=/ &&				# .foo =
3399
			    $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ &&		# stringification #foo
3400
			    $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ &&	# do {...} while (...); // do {...} while (...)
3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411
			    $dstat !~ /^for\s*$Constant$/ &&				# for (...)
			    $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ &&	# for (...) bar()
			    $dstat !~ /^do\s*{/ &&					# do {...
			    $dstat !~ /^\({/)						# ({...
			{
				$ctx =~ s/\n*$//;
				my $herectx = $here . "\n";
				my $cnt = statement_rawlines($ctx);

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

3414 3415 3416 3417
				if ($dstat =~ /;/) {
					ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
					      "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
				} else {
3418
					ERROR("COMPLEX_MACRO",
3419
					      "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
3420
				}
3421
			}
3422

3423
# check for line continuations outside of #defines, preprocessor #, and asm
3424 3425 3426

		} else {
			if ($prevline !~ /^..*\\$/ &&
3427 3428
			    $line !~ /^\+\s*\#.*\\$/ &&		# preprocessor
			    $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ &&	# asm
3429 3430 3431 3432
			    $line =~ /^\+.*\\$/) {
				WARN("LINE_CONTINUATIONS",
				     "Avoid unnecessary line continuations\n" . $herecurr);
			}
3433 3434
		}

3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462
# 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
		if ($^V && $^V ge 5.10.0 &&
		    $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;

			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);
				my $herectx = $here . "\n";

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

3463 3464
				if (($stmts =~ tr/;/;/) == 1 &&
				    $stmts !~ /^\s*(if|while|for|switch)\b/) {
3465 3466 3467 3468 3469 3470 3471 3472 3473 3474
					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");
				}
			}
		}

3475 3476 3477 3478 3479 3480
# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
# all assignments may have only one of the following with an assignment:
#	.
#	ALIGN(...)
#	VMLINUX_SYMBOL(...)
		if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
3481 3482
			WARN("MISSING_VMLINUX_SYMBOL",
			     "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
3483 3484
		}

3485
# check for redundant bracing round if etc
3486 3487
		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
			my ($level, $endln, @chunks) =
3488
				ctx_statement_full($linenr, $realcnt, 1);
3489
			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
3490 3491
			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
			if ($#chunks > 0 && $level == 0) {
3492 3493
				my @allowed = ();
				my $allow = 0;
3494
				my $seen = 0;
3495
				my $herectx = $here . "\n";
3496
				my $ln = $linenr - 1;
3497 3498 3499
				for my $chunk (@chunks) {
					my ($cond, $block) = @{$chunk};

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

3504
					$allowed[$allow] = 0;
3505 3506 3507 3508 3509 3510
					#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";
3511 3512
					$ln += statement_rawlines($block) - 1;

3513
					substr($block, 0, length($cond), '');
3514 3515 3516

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

3517
					#print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
3518 3519
					if (statement_lines($cond) > 1) {
						#print "APW: ALLOWED: cond<$cond>\n";
3520
						$allowed[$allow] = 1;
3521 3522
					}
					if ($block =~/\b(?:if|for|while)\b/) {
3523
						#print "APW: ALLOWED: block<$block>\n";
3524
						$allowed[$allow] = 1;
3525
					}
3526 3527
					if (statement_block_size($block) > 1) {
						#print "APW: ALLOWED: lines block<$block>\n";
3528
						$allowed[$allow] = 1;
3529
					}
3530
					$allow++;
3531
				}
3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544
				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);
					}
3545 3546 3547
				}
			}
		}
3548
		if (!defined $suppress_ifbraces{$linenr - 1} &&
3549
					$line =~ /\b(if|while|for|else)\b/) {
3550 3551 3552 3553 3554 3555 3556
			my $allowed = 0;

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

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

3561 3562
			# Check the condition.
			my ($cond, $block) = @{$chunks[0]};
3563
			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
3564
			if (defined $cond) {
3565
				substr($block, 0, length($cond), '');
3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582
			}
			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) {
3583
					substr($block, 0, length($cond), '');
3584 3585 3586 3587 3588 3589 3590
				}
				if ($block =~ /^\s*\{/) {
					#print "APW: ALLOWED: chunk-1 block<$block>\n";
					$allowed = 1;
				}
			}
			if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
3591
				my $herectx = $here . "\n";
3592
				my $cnt = statement_rawlines($block);
3593

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

3598 3599
				WARN("BRACES",
				     "braces {} are not necessary for single statement blocks\n" . $herectx);
3600 3601 3602
			}
		}

3603
# check for unnecessary blank lines around braces
3604
		if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
3605 3606 3607
			CHK("BRACES",
			    "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
		}
3608
		if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
3609 3610 3611 3612
			CHK("BRACES",
			    "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
		}

3613
# no volatiles please
3614 3615
		my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
		if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
3616 3617
			WARN("VOLATILE",
			     "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
3618 3619
		}

3620
# warn about #if 0
3621
		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
3622 3623
			CHK("REDUNDANT_CODE",
			    "if this code is redundant consider removing it\n" .
3624
				$herecurr);
3625 3626
		}

3627 3628 3629 3630 3631 3632
# check for needless "if (<foo>) fn(<foo>)" uses
		if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
			my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
			if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
				WARN('NEEDLESS_IF',
				     "$1(NULL) is safe this check is probably not required\n" . $hereprev);
3633 3634
			}
		}
3635

3636
# prefer usleep_range over udelay
B
Bruce Allan 已提交
3637
		if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
3638
			# ignore udelay's < 10, however
B
Bruce Allan 已提交
3639
			if (! ($1 < 10) ) {
3640 3641
				CHK("USLEEP_RANGE",
				    "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
3642 3643 3644
			}
		}

3645 3646 3647
# warn about unexpectedly long msleep's
		if ($line =~ /\bmsleep\s*\((\d+)\);/) {
			if ($1 < 20) {
3648 3649
				WARN("MSLEEP",
				     "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
3650 3651 3652
			}
		}

3653 3654 3655 3656 3657 3658
# 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);
		}

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

3665
# warn about #ifdefs in C files
3666
#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
3667 3668 3669 3670 3671
#			print "#ifdef in C files should be avoided\n";
#			print "$herecurr";
#			$clean = 0;
#		}

3672
# warn about spacing in #ifdefs
3673
		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
3674 3675 3676 3677 3678 3679 3680
			if (ERROR("SPACING",
				  "exactly one space required after that #$1\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
			}

3681 3682
		}

3683
# check for spinlock_t definitions without a comment.
3684 3685
		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
3686 3687
			my $which = $1;
			if (!ctx_has_comment($first_line, $linenr)) {
3688 3689
				CHK("UNCOMMENTED_DEFINITION",
				    "$1 definition without comment\n" . $herecurr);
3690 3691 3692 3693 3694
			}
		}
# check for memory barriers without a comment.
		if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
			if (!ctx_has_comment($first_line, $linenr)) {
3695 3696
				CHK("MEMORY_BARRIER",
				    "memory barrier without comment\n" . $herecurr);
3697 3698 3699
			}
		}
# check of hardware specific defines
3700
		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
3701 3702
			CHK("ARCH_DEFINES",
			    "architecture specific defines should be avoided\n" .  $herecurr);
3703
		}
3704

3705 3706
# Check that the storage class is at the beginning of a declaration
		if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
3707 3708
			WARN("STORAGE_CLASS",
			     "storage class should be at the beginning of the declaration\n" . $herecurr)
3709 3710
		}

3711 3712
# check the location of the inline attribute, that it is between
# storage class and type.
3713 3714
		if ($line =~ /\b$Type\s+$Inline\b/ ||
		    $line =~ /\b$Inline\s+$Storage\b/) {
3715 3716
			ERROR("INLINE_LOCATION",
			      "inline keyword should sit between storage class and type\n" . $herecurr);
3717 3718
		}

3719 3720
# Check for __inline__ and __inline, prefer inline
		if ($line =~ /\b(__inline__|__inline)\b/) {
3721 3722 3723 3724 3725 3726
			if (WARN("INLINE",
				 "plain inline is preferred over $1\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/;

			}
3727 3728
		}

3729 3730
# Check for __attribute__ packed, prefer __packed
		if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
3731 3732
			WARN("PREFER_PACKED",
			     "__packed is preferred over __attribute__((packed))\n" . $herecurr);
3733 3734
		}

3735 3736
# Check for __attribute__ aligned, prefer __aligned
		if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
3737 3738
			WARN("PREFER_ALIGNED",
			     "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
3739 3740
		}

3741 3742
# Check for __attribute__ format(printf, prefer __printf
		if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
3743 3744 3745 3746 3747 3748
			if (WARN("PREFER_PRINTF",
				 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;

			}
3749 3750
		}

3751 3752
# Check for __attribute__ format(scanf, prefer __scanf
		if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
3753 3754 3755 3756 3757
			if (WARN("PREFER_SCANF",
				 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
			}
3758 3759
		}

3760 3761
# check for sizeof(&)
		if ($line =~ /\bsizeof\s*\(\s*\&/) {
3762 3763
			WARN("SIZEOF_ADDRESS",
			     "sizeof(& should be avoided\n" . $herecurr);
3764 3765
		}

3766 3767
# check for sizeof without parenthesis
		if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
3768 3769 3770 3771 3772
			if (WARN("SIZEOF_PARENTHESIS",
				 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
			}
3773 3774
		}

3775 3776
# check for line continuations in quoted strings with odd counts of "
		if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
3777 3778
			WARN("LINE_CONTINUATIONS",
			     "Avoid line continuations in quoted strings\n" . $herecurr);
3779 3780
		}

3781 3782 3783 3784 3785 3786
# 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);
		}

3787 3788 3789 3790
# check for seq_printf uses that could be seq_puts
		if ($line =~ /\bseq_printf\s*\(/) {
			my $fmt = get_quoted_string($line, $rawline);
			if ($fmt !~ /[^\\]\%/) {
3791 3792 3793 3794 3795
				if (WARN("PREFER_SEQ_PUTS",
					 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
				    $fix) {
					$fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/;
				}
3796 3797 3798
			}
		}

3799
# Check for misused memsets
3800 3801
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
3802 3803 3804
		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {

			my $ms_addr = $2;
3805 3806
			my $ms_val = $7;
			my $ms_size = $12;
3807 3808 3809

			if ($ms_size =~ /^(0x|)0$/i) {
				ERROR("MEMSET",
3810
				      "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
3811 3812
			} elsif ($ms_size =~ /^(0x|)1$/i) {
				WARN("MEMSET",
3813 3814 3815 3816 3817
				     "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
			}
		}

# typecasts on min/max could be min_t/max_t
3818 3819
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
3820
		    $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
3821
			if (defined $2 || defined $7) {
3822 3823 3824
				my $call = $1;
				my $cast1 = deparenthesize($2);
				my $arg1 = $3;
3825 3826
				my $cast2 = deparenthesize($7);
				my $arg2 = $8;
3827 3828
				my $cast;

3829
				if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
3830 3831 3832 3833 3834 3835 3836 3837
					$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");
3838 3839 3840
			}
		}

3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856
# check usleep_range arguments
		if ($^V && $^V ge 5.10.0 &&
		    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",
				     "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
			} elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
				 $min > $max) {
				WARN("USLEEP_RANGE",
				     "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
			}
		}

3857
# check for new externs in .c files.
3858
		if ($realfile =~ /\.c$/ && defined $stat &&
3859
		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
3860
		{
3861 3862
			my $function_name = $1;
			my $paren_space = $2;
3863 3864 3865 3866 3867

			my $s = $stat;
			if (defined $cond) {
				substr($s, 0, length($cond), '');
			}
3868 3869 3870
			if ($s =~ /^\s*;/ &&
			    $function_name ne 'uninitialized_var')
			{
3871 3872
				WARN("AVOID_EXTERNS",
				     "externs should be avoided in .c files\n" .  $herecurr);
3873 3874 3875
			}

			if ($paren_space =~ /\n/) {
3876 3877
				WARN("FUNCTION_ARGUMENTS",
				     "arguments for function declarations should follow identifier\n" . $herecurr);
3878
			}
3879 3880 3881 3882

		} elsif ($realfile =~ /\.c$/ && defined $stat &&
		    $stat =~ /^.\s*extern\s+/)
		{
3883 3884
			WARN("AVOID_EXTERNS",
			     "externs should be avoided in .c files\n" .  $herecurr);
3885 3886 3887 3888 3889 3890 3891
		}

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

			if (!grep(/$name/, @setup_docs)) {
3892 3893
				CHK("UNDOCUMENTED_SETUP",
				    "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
3894
			}
3895
		}
3896 3897

# check for pointless casting of kmalloc return
3898
		if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
3899 3900
			WARN("UNNECESSARY_CASTS",
			     "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
3901
		}
3902

3903 3904 3905 3906 3907 3908 3909 3910
# alloc style
# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
		if ($^V && $^V ge 5.10.0 &&
		    $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
			CHK("ALLOC_SIZEOF_STRUCT",
			    "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
		}

3911 3912 3913 3914 3915 3916 3917
# check for krealloc arg reuse
		if ($^V && $^V ge 5.10.0 &&
		    $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
			WARN("KREALLOC_ARG_REUSE",
			     "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
		}

3918 3919 3920 3921 3922 3923
# 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);
		}

3924 3925
# check for multiple semicolons
		if ($line =~ /;\s*;\s*$/) {
3926 3927 3928 3929 3930
			if (WARN("ONE_SEMICOLON",
				 "Statements terminations use 1 semicolon\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g;
			}
3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944
		}

# check for switch/default statements without a break;
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
		    $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
			my $ctx = '';
			my $herectx = $here . "\n";
			my $cnt = statement_rawlines($stat);
			for (my $n = 0; $n < $cnt; $n++) {
				$herectx .= raw_line($linenr, $n) . "\n";
			}
			WARN("DEFAULT_NO_BREAK",
			     "switch default: should use break\n" . $herectx);
3945 3946
		}

3947
# check for gcc specific __FUNCTION__
3948 3949 3950 3951 3952 3953
		if ($line =~ /\b__FUNCTION__\b/) {
			if (WARN("USE_FUNC",
				 "__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g;
			}
3954
		}
3955

J
Joe Perches 已提交
3956 3957 3958 3959 3960 3961
# 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);
		}

3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988
# 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);

			}
		}

3989 3990
# check for semaphores initialized locked
		if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
3991 3992
			WARN("CONSIDER_COMPLETION",
			     "consider using a completion\n" . $herecurr);
3993
		}
3994

3995 3996
# recommend kstrto* over simple_strto* and strict_strto*
		if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
3997
			WARN("CONSIDER_KSTRTO",
3998
			     "$1 is obsolete, use k$3 instead\n" . $herecurr);
3999
		}
4000

4001 4002
# check for __initcall(), use device_initcall() explicitly please
		if ($line =~ /^.\s*__initcall\s*\(/) {
4003 4004
			WARN("USE_DEVICE_INITCALL",
			     "please use device_initcall() instead of __initcall()\n" . $herecurr);
4005
		}
4006

4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044
# check for various ops structs, ensure they are const.
		my $struct_ops = qr{acpi_dock_ops|
				address_space_operations|
				backlight_ops|
				block_device_operations|
				dentry_operations|
				dev_pm_ops|
				dma_map_ops|
				extent_io_ops|
				file_lock_operations|
				file_operations|
				hv_ops|
				ide_dma_ops|
				intel_dvo_dev_ops|
				item_operations|
				iwl_ops|
				kgdb_arch|
				kgdb_io|
				kset_uevent_ops|
				lock_manager_operations|
				microcode_ops|
				mtrr_ops|
				neigh_ops|
				nlmsvc_binding|
				pci_raw_ops|
				pipe_buf_operations|
				platform_hibernation_ops|
				platform_suspend_ops|
				proto_ops|
				rpc_pipe_ops|
				seq_operations|
				snd_ac97_build_ops|
				soc_pcmcia_socket_ops|
				stacktrace_ops|
				sysfs_ops|
				tty_operations|
				usb_mon_operations|
				wd_ops}x;
4045
		if ($line !~ /\bconst\b/ &&
4046
		    $line =~ /\bstruct\s+($struct_ops)\b/) {
4047 4048
			WARN("CONST_STRUCT",
			     "struct $1 should normally be const\n" .
4049
				$herecurr);
4050
		}
4051 4052 4053 4054

# 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/ &&
4055 4056
		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
4057 4058 4059
		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
4060
		{
4061 4062
			WARN("NR_CPUS",
			     "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
4063
		}
4064 4065 4066 4067 4068

# check for %L{u,d,i} in strings
		my $string;
		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
			$string = substr($rawline, $-[1], $+[1] - $-[1]);
4069
			$string =~ s/%%/__/g;
4070
			if ($string =~ /(?<!%)%L[udi]/) {
4071 4072
				WARN("PRINTF_L",
				     "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
4073 4074 4075
				last;
			}
		}
4076 4077 4078 4079

# whine mightly about in_atomic
		if ($line =~ /\bin_atomic\s*\(/) {
			if ($realfile =~ m@^drivers/@) {
4080 4081
				ERROR("IN_ATOMIC",
				      "do not use in_atomic in drivers\n" . $herecurr);
4082
			} elsif ($realfile !~ m@^kernel/@) {
4083 4084
				WARN("IN_ATOMIC",
				     "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
4085 4086
			}
		}
4087 4088 4089 4090 4091 4092 4093

# 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@) {
4094 4095
				ERROR("LOCKDEP",
				      "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
4096 4097
			}
		}
4098 4099 4100

		if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
		    $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
4101 4102
			WARN("EXPORTED_WORLD_WRITABLE",
			     "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
4103
		}
4104 4105 4106 4107 4108 4109
	}

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

4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124
	# 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);
	}

	if (!$is_patch) {
4125 4126
		ERROR("NOT_UNIFIED_DIFF",
		      "Does not appear to be a unified-diff format patch\n");
4127 4128
	}
	if ($is_patch && $chk_signoff && $signoff == 0) {
4129 4130
		ERROR("MISSING_SIGN_OFF",
		      "Missing Signed-off-by: line(s)\n");
4131 4132
	}

4133
	print report_dump();
4134 4135
	if ($summary && !($clean == 1 && $quiet == 1)) {
		print "$filename " if ($summary_file);
4136 4137 4138 4139
		print "total: $cnt_error errors, $cnt_warn warnings, " .
			(($check)? "$cnt_chk checks, " : "") .
			"$cnt_lines lines checked\n";
		print "\n" if ($quiet == 0);
4140
	}
4141

4142
	if ($quiet == 0) {
4143 4144 4145 4146 4147 4148

		if ($^V lt 5.10.0) {
			print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
			print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
		}

4149 4150 4151 4152 4153
		# If there were whitespace errors which cleanpatch can fix
		# then suggest that.
		if ($rpt_cleaners) {
			print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
			print "      scripts/cleanfile\n\n";
4154
			$rpt_cleaners = 0;
4155 4156 4157
		}
	}

4158
	if ($quiet == 0 && keys %ignore_type) {
4159 4160 4161 4162
	    print "NOTE: Ignored message types:";
	    foreach my $ignore (sort keys %ignore_type) {
		print " $ignore";
	    }
4163
	    print "\n\n";
4164 4165
	}

4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199
	if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
		my $newfile = $filename . ".EXPERIMENTAL-checkpatch-fixes";
		my $linecount = 0;
		my $f;

		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/^\+//;
					print $f $fixed_line. "\n";
				}
			} else {
				print $f $fixed_line . "\n";
			}
		}
		close($f);

		if (!$quiet) {
			print << "EOM";
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
		}
	}

4200
	if ($clean == 1 && $quiet == 0) {
4201
		print "$vname has no obvious style problems and is ready for submission.\n"
4202 4203
	}
	if ($clean == 0 && $quiet == 0) {
4204 4205 4206 4207 4208 4209
		print << "EOM";
$vname has style problems, please review.

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

4212 4213
	return $clean;
}