checkpatch.pl 102.9 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 9 10
# Licensed under the terms of the GNU GPL License version 2

use strict;

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

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

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

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

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
54
  --ignore TYPE(,TYPE2...)   ignore various comma separated message types
55
  --max-line-length=n        set the maximum line length, if exceeded, warn
56
  --show-types               show the message "types" in the output
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
  --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
  -h, --help, --version      display this help and exit

When FILE is - read standard input.
EOM

	exit($exitcode);
}

74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
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;
}

100
GetOptions(
101
	'q|quiet+'	=> \$quiet,
102 103 104
	'tree!'		=> \$tree,
	'signoff!'	=> \$chk_signoff,
	'patch!'	=> \$chk_patch,
105
	'emacs!'	=> \$emacs,
106
	'terse!'	=> \$terse,
107
	'f|file!'	=> \$file,
108 109
	'subjective!'	=> \$check,
	'strict!'	=> \$check,
110 111
	'ignore=s'	=> \@ignore,
	'show-types!'	=> \$show_types,
112
	'max-line-length=i' => \$max_line_length,
113
	'root=s'	=> \$root,
114 115
	'summary!'	=> \$summary,
	'mailback!'	=> \$mailback,
116 117
	'summary-file!'	=> \$summary_file,

118
	'debug=s'	=> \%debug,
119
	'test-only=s'	=> \$tst_only,
120 121 122 123 124
	'h|help'	=> \$help,
	'version'	=> \$help
) or help(1);

help(0) if ($help);
125 126 127 128

my $exit = 0;

if ($#ARGV < 0) {
129
	print "$P: no input files\n";
130 131 132
	exit(1);
}

133 134 135 136 137 138 139 140 141 142 143 144 145
@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}++;
}

146 147
my $dbg_values = 0;
my $dbg_possible = 0;
148
my $dbg_type = 0;
149
my $dbg_attr = 0;
150
for my $key (keys %debug) {
151 152 153
	## no critic
	eval "\${dbg_$key} = '$debug{$key}';";
	die "$@" if ($@);
154 155
}

156 157
my $rpt_cleaners = 0;

158 159 160 161 162
if ($terse) {
	$emacs = 1;
	$quiet++;
}

163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
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);
	}
181 182
}

183 184
my $emitted_corrupt = 0;

185 186 187 188
our $Ident	= qr{
			[A-Za-z_][A-Za-z\d_]*
			(?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
		}x;
189 190 191 192 193 194 195 196
our $Storage	= qr{extern|static|asmlinkage};
our $Sparse	= qr{
			__user|
			__kernel|
			__force|
			__iomem|
			__must_check|
			__init_refok|
197
			__kprobes|
198 199
			__ref|
			__rcu
200
		}x;
201 202 203

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

233 234 235 236
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?};
237 238 239
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]?};
240
our $Float	= qr{$Float_hex|$Float_dec|$Float_int};
241
our $Constant	= qr{$Float|$Binary|$Hex|$Int};
242
our $Assignment	= qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
243
our $Compare    = qr{<=|>=|==|!=|<|>};
244 245 246
our $Operators	= qr{
			<=|>=|==|!=|
			=>|->|<<|>>|<|>|!|~|
247
			&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
248 249
		  }x;

250 251 252 253
our $NonptrType;
our $Type;
our $Declare;

254 255
our $NON_ASCII_UTF8	= qr{
	[\xC2-\xDF][\x80-\xBF]               # non-overlong 2-byte
256 257 258 259 260 261 262 263
	|  \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;

264 265 266 267 268
our $UTF8	= qr{
	[\x09\x0A\x0D\x20-\x7E]              # ASCII
	| $NON_ASCII_UTF8
}x;

269
our $typeTypedefs = qr{(?x:
270
	(?:__)?(?:u|s|be|le)(?:8|16|32|64)|
271 272 273
	atomic_t
)};

274
our $logFunctions = qr{(?x:
275 276 277
	printk(?:_ratelimited|_once|)|
	[a-z0-9]+_(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
	WARN(?:_RATELIMIT|_ONCE|)|
278 279
	panic|
	MODULE_[A-Z_]+
280 281
)};

282 283 284 285 286 287
our $signature_tags = qr{(?xi:
	Signed-off-by:|
	Acked-by:|
	Tested-by:|
	Reviewed-by:|
	Reported-by:|
288
	Suggested-by:|
289 290 291 292
	To:|
	Cc:
)};

293 294
our @typeList = (
	qr{void},
295 296 297 298 299 300 301
	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},
302 303 304 305 306 307 308 309 310 311 312
	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},
);
313 314 315
our @modifierList = (
	qr{fastcall},
);
316

317 318 319 320 321 322
our $allowed_asm_includes = qr{(?x:
	irq|
	memory
)};
# memory.h: ARM has a custom one

323
sub build_types {
324 325
	my $mods = "(?x:  \n" . join("|\n  ", @modifierList) . "\n)";
	my $all = "(?x:  \n" . join("|\n  ", @typeList) . "\n)";
326
	$Modifier	= qr{(?:$Attribute|$Sparse|$mods)};
327
	$NonptrType	= qr{
328
			(?:$Modifier\s+|const\s+)*
329
			(?:
330
				(?:typeof|__typeof__)\s*\([^\)]*\)|
331
				(?:$typeTypedefs\b)|
332
				(?:${all}\b)
333
			)
334
			(?:\s+$Modifier|\s+const)*
335 336
		  }x;
	$Type	= qr{
337
			$NonptrType
338
			(?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)?
339
			(?:\s+$Inline|\s+$Modifier)*
340 341 342 343
		  }x;
	$Declare	= qr{(?:$Storage\s+)?$Type};
}
build_types();
344

345 346

our $Typecast	= qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
347 348 349 350 351 352 353

# 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*};
354
our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
355 356 357 358 359 360 361 362 363 364

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

365 366
$chk_signoff = 0 if ($file);

367
my @rawlines = ();
368 369
my @lines = ();
my $vname;
370
for my $filename (@ARGV) {
371
	my $FILE;
372
	if ($file) {
373
		open($FILE, '-|', "diff -u /dev/null $filename") ||
374
			die "$P: $filename: diff failed - $!\n";
375 376
	} elsif ($filename eq '-') {
		open($FILE, '<&STDIN');
377
	} else {
378
		open($FILE, '<', "$filename") ||
379
			die "$P: $filename: open failed - $!\n";
380
	}
381 382 383 384 385
	if ($filename eq '-') {
		$vname = 'Your patch';
	} else {
		$vname = $filename;
	}
386
	while (<$FILE>) {
387 388 389
		chomp;
		push(@rawlines, $_);
	}
390
	close($FILE);
391
	if (!process($filename)) {
392 393 394
		$exit = 1;
	}
	@rawlines = ();
395
	@lines = ();
396 397 398 399 400
}

exit($exit);

sub top_of_kernel_tree {
401 402 403 404 405 406 407 408 409 410 411 412
	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;
		}
413
	}
414
	return 1;
415
}
416

417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
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;
		$name =~ s/^\s+|\s+$//g;
		$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 = "";
		}
	}

	$name =~ s/^\s+|\s+$//g;
	$name =~ s/^\"|\"$//g;
	$address =~ s/^\s+|\s+$//g;
	$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;

	$name =~ s/^\s+|\s+$//g;
	$name =~ s/^\"|\"$//g;
	$address =~ s/^\s+|\s+$//g;

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

487 488 489 490 491 492 493 494 495 496 497 498
sub which_conf {
	my ($conf) = @_;

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

	return "";
}

499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
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;
}
519
sub copy_spacing {
520
	(my $res = shift) =~ tr/\t/ /c;
521 522
	return $res;
}
523

524 525 526 527 528 529 530 531 532 533 534 535 536
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));
}

537 538 539 540 541 542 543 544 545 546 547
my $sanitise_quote = '';

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

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
548 549 550 551 552 553
sub sanitise_line {
	my ($line) = @_;

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

554
	my $qlen = 0;
555 556
	my $off = 0;
	my $c;
557

558 559 560 561 562 563 564 565 566 567 568 569 570 571
	# 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;
572
		}
573
		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
574 575 576 577
			$sanitise_quote = '';
			substr($res, $off, 2, "$;$;");
			$off++;
			next;
578
		}
579 580 581 582 583 584 585
		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
			$sanitise_quote = '//';

			substr($res, $off, 2, $sanitise_quote);
			$off++;
			next;
		}
586 587 588 589 590 591 592

		# 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;
593
		}
594 595 596 597
		# Regular quotes.
		if ($c eq "'" || $c eq '"') {
			if ($sanitise_quote eq '') {
				$sanitise_quote = $c;
598

599 600 601 602 603 604
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
605

606
		#print "c<$c> SQ<$sanitise_quote>\n";
607 608
		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
			substr($res, $off, 1, $;);
609 610
		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
			substr($res, $off, 1, $;);
611 612 613 614 615
		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
			substr($res, $off, 1, 'X');
		} else {
			substr($res, $off, 1, $c);
		}
616 617
	}

618 619 620 621
	if ($sanitise_quote eq '//') {
		$sanitise_quote = '';
	}

622
	# The pathname on a #include may be surrounded by '<' and '>'.
623
	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
624 625 626 627
		my $clean = 'X' x length($1);
		$res =~ s@\<.*\>@<$clean>@;

	# The whole of a #error is a string.
628
	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
629
		my $clean = 'X' x length($1);
630
		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
631 632
	}

633 634 635
	return $res;
}

636 637 638 639 640 641 642
sub get_quoted_string {
	my ($line, $rawline) = @_;

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

643 644 645 646 647 648
sub ctx_statement_block {
	my ($linenr, $remain, $off) = @_;
	my $line = $linenr - 1;
	my $blk = '';
	my $soff = $off;
	my $coff = $off - 1;
649
	my $coff_set = 0;
650

651 652
	my $loff = 0;

653 654
	my $type = '';
	my $level = 0;
655
	my @stack = ();
656
	my $p;
657 658
	my $c;
	my $len = 0;
659 660

	my $remainder;
661
	while (1) {
662 663
		@stack = (['', 0]) if ($#stack == -1);

664
		#warn "CSB: blk<$blk> remain<$remain>\n";
665 666 667 668
		# If we are about to drop off the end, pull in more
		# context.
		if ($off >= $len) {
			for (; $remain > 0; $line++) {
669
				last if (!defined $lines[$line]);
670
				next if ($lines[$line] =~ /^-/);
671
				$remain--;
672
				$loff = $len;
673
				$blk .= $lines[$line] . "\n";
674 675 676 677 678 679
				$len = length($blk);
				$line++;
				last;
			}
			# Bail if there is no further context.
			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
680
			if ($off >= $len) {
681 682
				last;
			}
683 684 685 686
			if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
				$level++;
				$type = '#';
			}
687
		}
688
		$p = $c;
689
		$c = substr($blk, $off, 1);
690
		$remainder = substr($blk, $off);
691

692
		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
693 694 695 696 697 698 699 700 701 702

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

703 704 705 706 707 708
		# Statement ends at the ';' or a close '}' at the
		# outermost level.
		if ($level == 0 && $c eq ';') {
			last;
		}

709
		# An else is really a conditional as long as its not else if
710 711 712 713 714 715 716 717
		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";
718 719
		}

720 721 722 723 724 725 726 727 728 729
		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;
730 731
				$coff_set = 1;
				#warn "CSB: mark coff<$coff>\n";
732 733 734 735 736 737 738 739 740 741 742
			}
		}
		if (($type eq '' || $type eq '{') && $c eq '{') {
			$level++;
			$type = '{';
		}
		if ($type eq '{' && $c eq '}') {
			$level--;
			$type = ($level != 0)? '{' : '';

			if ($level == 0) {
743 744 745
				if (substr($blk, $off + 1, 1) eq ';') {
					$off++;
				}
746 747 748
				last;
			}
		}
749 750 751 752 753 754 755
		# Preprocessor commands end at the newline unless escaped.
		if ($type eq '#' && $c eq "\n" && $p ne "\\") {
			$level--;
			$type = '';
			$off++;
			last;
		}
756 757
		$off++;
	}
758
	# We are truly at the end, so shuffle to the next line.
759
	if ($off == $len) {
760
		$loff = $len + 1;
761 762 763
		$line++;
		$remain--;
	}
764 765 766 767 768 769 770

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

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

771
	#print "coff<$coff> soff<$off> loff<$loff>\n";
772 773 774 775 776

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

777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819
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;
	}
}

820 821 822 823 824 825
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

826
	# Grab the first conditional/block pair.
827 828
	($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
829
	#print "F: c<$condition> s<$statement> remain<$remain>\n";
830 831 832 833 834 835 836
	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.
837 838 839
	for (;;) {
		($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
840
		#print "C: c<$condition> s<$statement> remain<$remain>\n";
841
		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
842 843
		#print "C: push\n";
		push(@chunks, [ $condition, $statement ]);
844 845 846
	}

	return ($level, $linenr, @chunks);
847 848
}

849
sub ctx_block_get {
850
	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
851 852 853 854 855 856 857
	my $line;
	my $start = $linenr - 1;
	my $blk = '';
	my @o;
	my @c;
	my @res = ();

858
	my $level = 0;
859
	my @stack = ($level);
860 861 862 863 864
	for ($line = $start; $remain > 0; $line++) {
		next if ($rawlines[$line] =~ /^-/);
		$remain--;

		$blk .= $rawlines[$line];
865 866

		# Handle nested #if/#else.
867
		if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
868
			push(@stack, $level);
869
		} elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
870
			$level = $stack[$#stack - 1];
871
		} elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
872 873 874
			$level = pop(@stack);
		}

875
		foreach my $c (split(//, $lines[$line])) {
876 877 878 879 880
			##print "C<$c>L<$level><$open$close>O<$off>\n";
			if ($off > 0) {
				$off--;
				next;
			}
881

882 883 884 885 886 887 888
			if ($c eq $close && $level > 0) {
				$level--;
				last if ($level == 0);
			} elsif ($c eq $open) {
				$level++;
			}
		}
889

890
		if (!$outer || $level <= 1) {
891
			push(@res, $rawlines[$line]);
892 893
		}

894
		last if ($level == 0);
895 896
	}

897
	return ($level, @res);
898 899 900 901
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

902 903
	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
	return @r;
904 905 906 907
}
sub ctx_block {
	my ($linenr, $remain) = @_;

908 909
	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
	return @r;
910 911
}
sub ctx_statement {
912 913 914 915 916 917
	my ($linenr, $remain, $off) = @_;

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

920
	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
921
}
922 923 924 925 926
sub ctx_statement_level {
	my ($linenr, $remain, $off) = @_;

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
927 928 929 930 931

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

	# Catch a comment on the end of the line itself.
932
	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
933 934 935 936 937 938 939
	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++) {
940 941
		my $line = $rawlines[$linenr - 1];
		#warn "           $line\n";
942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963
		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);

964
	##print "LINE: $rawlines[$end_line - 1 ]\n";
965 966 967 968 969
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985
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;
}

986 987 988
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
989

990 991 992 993 994 995
	$res = '';
	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
		$res .= $1;
		if ($2 ne '') {
			$coded = sprintf("^%c", unpack('C', $2) + 64);
			$res .= $coded;
996 997
		}
	}
998
	$res =~ s/$/\$/;
999

1000
	return $res;
1001 1002
}

1003
my $av_preprocessor = 0;
1004
my $av_pending;
1005
my @av_paren_type;
1006
my $av_pend_colon;
1007 1008 1009

sub annotate_reset {
	$av_preprocessor = 0;
1010 1011
	$av_pending = '_';
	@av_paren_type = ('E');
1012
	$av_pend_colon = 'O';
1013 1014
}

1015 1016
sub annotate_values {
	my ($stream, $type) = @_;
1017

1018
	my $res;
1019
	my $var = '_' x length($stream);
1020 1021
	my $cur = $stream;

1022
	print "$stream\n" if ($dbg_values > 1);
1023 1024

	while (length($cur)) {
1025
		@av_paren_type = ('E') if ($#av_paren_type < 0);
1026
		print " <" . join('', @av_paren_type) .
1027
				"> <$type> <$av_pending>" if ($dbg_values > 1);
1028
		if ($cur =~ /^(\s+)/o) {
1029 1030
			print "WS($1)\n" if ($dbg_values > 1);
			if ($1 =~ /\n/ && $av_preprocessor) {
1031
				$type = pop(@av_paren_type);
1032
				$av_preprocessor = 0;
1033 1034
			}

1035
		} elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1036 1037
			print "CAST($1)\n" if ($dbg_values > 1);
			push(@av_paren_type, $type);
1038
			$type = 'c';
1039

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

1044 1045 1046 1047
		} elsif ($cur =~ /^($Modifier)\s*/) {
			print "MODIFIER($1)\n" if ($dbg_values > 1);
			$type = 'T';

1048
		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1049
			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1050
			$av_preprocessor = 1;
1051 1052 1053 1054 1055 1056
			push(@av_paren_type, $type);
			if ($2 ne '') {
				$av_pending = 'N';
			}
			$type = 'E';

1057
		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1058 1059 1060
			print "UNDEF($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;
			push(@av_paren_type, $type);
1061

1062
		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1063
			print "PRE_START($1)\n" if ($dbg_values > 1);
1064
			$av_preprocessor = 1;
1065 1066 1067

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
1068
			$type = 'E';
1069

1070
		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1071 1072 1073 1074 1075
			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;

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

1076
			$type = 'E';
1077

1078
		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1079 1080 1081 1082 1083 1084 1085 1086
			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);
1087
			$type = 'E';
1088 1089

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

1092 1093 1094 1095 1096
		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
			print "ATTR($1)\n" if ($dbg_values > 1);
			$av_pending = $type;
			$type = 'N';

1097
		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1098
			print "SIZEOF($1)\n" if ($dbg_values > 1);
1099
			if (defined $2) {
1100
				$av_pending = 'V';
1101 1102 1103
			}
			$type = 'N';

1104
		} elsif ($cur =~ /^(if|while|for)\b/o) {
1105
			print "COND($1)\n" if ($dbg_values > 1);
1106
			$av_pending = 'E';
1107 1108
			$type = 'N';

1109 1110 1111 1112 1113
		} elsif ($cur =~/^(case)/o) {
			print "CASE($1)\n" if ($dbg_values > 1);
			$av_pend_colon = 'C';
			$type = 'N';

1114
		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1115
			print "KEYWORD($1)\n" if ($dbg_values > 1);
1116 1117 1118
			$type = 'N';

		} elsif ($cur =~ /^(\()/o) {
1119
			print "PAREN('$1')\n" if ($dbg_values > 1);
1120 1121
			push(@av_paren_type, $av_pending);
			$av_pending = '_';
1122 1123 1124
			$type = 'N';

		} elsif ($cur =~ /^(\))/o) {
1125 1126 1127
			my $new_type = pop(@av_paren_type);
			if ($new_type ne '_') {
				$type = $new_type;
1128 1129
				print "PAREN('$1') -> $type\n"
							if ($dbg_values > 1);
1130
			} else {
1131
				print "PAREN('$1')\n" if ($dbg_values > 1);
1132 1133
			}

1134
		} elsif ($cur =~ /^($Ident)\s*\(/o) {
1135
			print "FUNC($1)\n" if ($dbg_values > 1);
1136
			$type = 'V';
1137
			$av_pending = 'V';
1138

1139 1140
		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
			if (defined $2 && $type eq 'C' || $type eq 'T') {
1141
				$av_pend_colon = 'B';
1142 1143
			} elsif ($type eq 'E') {
				$av_pend_colon = 'L';
1144 1145 1146 1147
			}
			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
			$type = 'V';

1148
		} elsif ($cur =~ /^($Ident|$Constant)/o) {
1149
			print "IDENT($1)\n" if ($dbg_values > 1);
1150 1151 1152
			$type = 'V';

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

1156
		} elsif ($cur =~/^(;|{|})/) {
1157
			print "END($1)\n" if ($dbg_values > 1);
1158
			$type = 'E';
1159 1160
			$av_pend_colon = 'O';

1161 1162 1163 1164
		} elsif ($cur =~/^(,)/) {
			print "COMMA($1)\n" if ($dbg_values > 1);
			$type = 'C';

1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178
		} 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';
1179

1180
		} elsif ($cur =~ /^(\[)/o) {
1181
			print "CLOSE($1)\n" if ($dbg_values > 1);
1182 1183
			$type = 'N';

1184
		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196
			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';

1197
		} elsif ($cur =~ /^($Operators)/o) {
1198
			print "OP($1)\n" if ($dbg_values > 1);
1199 1200 1201 1202 1203
			if ($1 ne '++' && $1 ne '--') {
				$type = 'N';
			}

		} elsif ($cur =~ /(^.)/o) {
1204
			print "C($1)\n" if ($dbg_values > 1);
1205 1206 1207 1208 1209
		}
		if (defined $1) {
			$cur = substr($cur, length($1));
			$res .= $type x length($1);
		}
1210
	}
1211

1212
	return ($res, $var);
1213 1214
}

1215
sub possible {
1216
	my ($possible, $line) = @_;
1217
	my $notPermitted = qr{(?:
1218 1219 1220 1221
		^(?:
			$Modifier|
			$Storage|
			$Type|
1222 1223 1224
			DEFINE_\S+
		)$|
		^(?:
1225 1226 1227 1228 1229
			goto|
			return|
			case|
			else|
			asm|__asm__|
1230 1231 1232
			do|
			\#|
			\#\#|
1233
		)(?:\s|$)|
1234
		^(?:typedef|struct|enum)\b
1235 1236 1237
	    )}x;
	warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
	if ($possible !~ $notPermitted) {
1238 1239 1240 1241 1242 1243 1244
		# 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;
1245
			for my $modifier (split(' ', $possible)) {
1246 1247 1248 1249
				if ($modifier !~ $notPermitted) {
					warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
					push(@modifierList, $modifier);
				}
1250
			}
1251 1252 1253 1254 1255

		} else {
			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
			push(@typeList, $possible);
		}
1256
		build_types();
1257 1258
	} else {
		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1259 1260 1261
	}
}

1262 1263
my $prefix = '';

1264 1265 1266 1267
sub show_type {
       return !defined $ignore_type{$_[0]};
}

1268
sub report {
1269 1270
	if (!show_type($_[1]) ||
	    (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
1271 1272
		return 0;
	}
1273 1274 1275 1276 1277 1278
	my $line;
	if ($show_types) {
		$line = "$prefix$_[0]:$_[1]: $_[2]\n";
	} else {
		$line = "$prefix$_[0]: $_[2]\n";
	}
1279 1280
	$line = (split('\n', $line))[0] . "\n" if ($terse);

1281
	push(our @report, $line);
1282 1283

	return 1;
1284 1285
}
sub report_dump {
1286
	our @report;
1287
}
1288

1289
sub ERROR {
1290
	if (report("ERROR", $_[0], $_[1])) {
1291 1292 1293
		our $clean = 0;
		our $cnt_error++;
	}
1294 1295
}
sub WARN {
1296
	if (report("WARNING", $_[0], $_[1])) {
1297 1298 1299
		our $clean = 0;
		our $cnt_warn++;
	}
1300 1301
}
sub CHK {
1302
	if ($check && report("CHECK", $_[0], $_[1])) {
1303 1304 1305
		our $clean = 0;
		our $cnt_chk++;
	}
1306 1307
}

1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330
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 ".../") {
1331 1332
		WARN("USE_RELATIVE_PATH",
		     "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1333 1334 1335
	}
}

1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365
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;
}

1366 1367 1368 1369 1370
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
1371
	my $prevrawline="";
1372
	my $stashline="";
1373
	my $stashrawline="";
1374

1375
	my $length;
1376 1377 1378 1379
	my $indent;
	my $previndent=0;
	my $stashindent=0;

1380
	our $clean = 1;
1381 1382 1383
	my $signoff = 0;
	my $is_patch = 0;

1384 1385 1386
	my $in_header_lines = 1;
	my $in_commit_log = 0;		#Scanning lines before patch

1387 1388
	my $non_utf8_charset = 0;

1389
	our @report = ();
1390 1391 1392 1393 1394
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

1395 1396 1397 1398 1399 1400
	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
	my $in_comment = 0;
1401
	my $comment_edge = 0;
1402
	my $first_line = 0;
1403
	my $p1_prefix = '';
1404

1405 1406 1407
	my $prev_values = 'E';

	# suppression flags
1408
	my %suppress_ifbraces;
1409
	my %suppress_whiletrailers;
1410
	my %suppress_export;
1411
	my $suppress_statement = 0;
1412

1413 1414
	my %camelcase = ();

1415
	# Pre-scan the patch sanitizing the lines.
1416
	# Pre-scan the patch looking for any __setup documentation.
1417
	#
1418 1419
	my @setup_docs = ();
	my $setup_docs = 0;
1420 1421

	sanitise_line_reset();
1422 1423
	my $line;
	foreach my $rawline (@rawlines) {
1424 1425
		$linenr++;
		$line = $rawline;
1426

1427
		if ($rawline=~/^\+\+\+\s+(\S+)/) {
1428 1429 1430 1431
			$setup_docs = 0;
			if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
				$setup_docs = 1;
			}
1432 1433 1434 1435 1436 1437 1438 1439 1440
			#next;
		}
		if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1441
			$in_comment = 0;
1442 1443 1444 1445 1446 1447

			# 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;
1448 1449 1450 1451 1452 1453
			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";
1454
				last if (!defined $rawlines[$ln - 1]);
1455 1456 1457 1458 1459
				if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
				    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
					($edge) = $1;
					last;
				}
1460 1461 1462 1463 1464 1465 1466 1467 1468
			}
			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 &&
1469
			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1470 1471 1472 1473 1474 1475 1476
			{
				$in_comment = 1;
			}

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

1477
		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1478
			# Standardise the strings and chars within the input to
1479
			# simplify matching -- only bother with positive lines.
1480
			$line = sanitise_line($rawline);
1481
		}
1482 1483 1484 1485 1486 1487 1488 1489 1490 1491
		push(@lines, $line);

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

		#print "==>$rawline\n";
		#print "-->$line\n";
1492 1493 1494 1495 1496 1497

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

1498 1499
	$prefix = '';

1500 1501
	$realcnt = 0;
	$linenr = 0;
1502 1503 1504
	foreach my $line (@lines) {
		$linenr++;

1505
		my $rawline = $rawlines[$linenr - 1];
1506

1507
#extract the line range in the file after the patch is applied
1508
		if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1509
			$is_patch = 1;
1510
			$first_line = $linenr + 1;
1511 1512 1513 1514 1515 1516
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1517
			annotate_reset();
1518 1519
			$prev_values = 'E';

1520
			%suppress_ifbraces = ();
1521
			%suppress_whiletrailers = ();
1522
			%suppress_export = ();
1523
			$suppress_statement = 0;
1524 1525
			next;

1526 1527 1528
# 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.
1529
		} elsif ($line =~ /^( |\+|$)/) {
1530
			$realline++;
1531
			$realcnt-- if ($realcnt != 0);
1532

1533
			# Measure the line length and indent.
1534
			($length, $indent) = line_stats($rawline);
1535 1536 1537 1538

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

1541
			#warn "line<$line>\n";
1542

1543 1544
		} elsif ($realcnt == 1) {
			$realcnt--;
1545 1546
		}

1547 1548
		my $hunk_line = ($realcnt != 0);

1549
#make up the handle for any error we report on this line
1550 1551 1552
		$prefix = "$filename:$realline: " if ($emacs && $file);
		$prefix = "$filename:$linenr: " if ($emacs && !$file);

1553 1554
		$here = "#$linenr: " if (!$file);
		$here = "#$realline: " if ($file);
1555 1556

		# extract the filename as it passes
1557 1558 1559
		if ($line =~ /^diff --git.*?(\S+)$/) {
			$realfile = $1;
			$realfile =~ s@^([^/]*)/@@;
1560
			$in_commit_log = 0;
1561
		} elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1562
			$realfile = $1;
1563
			$realfile =~ s@^([^/]*)/@@;
1564
			$in_commit_log = 0;
1565 1566

			$p1_prefix = $1;
1567 1568
			if (!$file && $tree && $p1_prefix ne '' &&
			    -e "$root/$p1_prefix") {
1569 1570
				WARN("PATCH_PREFIX",
				     "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1571
			}
1572

1573
			if ($realfile =~ m@^include/asm/@) {
1574 1575
				ERROR("MODIFIED_INCLUDE_ASM",
				      "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1576 1577 1578 1579
			}
			next;
		}

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

1582 1583 1584
		my $hereline = "$here\n$rawline\n";
		my $herecurr = "$here\n$rawline\n";
		my $hereprev = "$here\n$prevrawline\n$rawline\n";
1585

1586 1587
		$cnt_lines++ if ($realcnt != 0);

1588 1589 1590
# Check for incorrect file permissions
		if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
			my $permhere = $here . "FILE: $realfile\n";
1591 1592
			if ($realfile !~ m@scripts/@ &&
			    $realfile !~ /\.(py|pl|awk|sh)$/) {
1593 1594
				ERROR("EXECUTE_PERMISSIONS",
				      "do not set execute permissions for source files\n" . $permhere);
1595 1596 1597
			}
		}

1598
# Check the patch for a signoff:
1599
		if ($line =~ /^\s*signed-off-by:/i) {
1600
			$signoff++;
1601
			$in_commit_log = 0;
1602 1603 1604
		}

# Check signature styles
1605
		if (!$in_header_lines &&
1606
		    $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
1607 1608 1609 1610 1611 1612
			my $space_before = $1;
			my $sign_off = $2;
			my $space_after = $3;
			my $email = $4;
			my $ucfirst_sign_off = ucfirst(lc($sign_off));

1613 1614 1615 1616
			if ($sign_off !~ /$signature_tags/) {
				WARN("BAD_SIGN_OFF",
				     "Non-standard signature: $sign_off\n" . $herecurr);
			}
1617
			if (defined $space_before && $space_before ne "") {
1618 1619
				WARN("BAD_SIGN_OFF",
				     "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr);
1620 1621
			}
			if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
1622 1623
				WARN("BAD_SIGN_OFF",
				     "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr);
1624 1625
			}
			if (!defined $space_after || $space_after ne " ") {
1626 1627
				WARN("BAD_SIGN_OFF",
				     "Use a single space after $ucfirst_sign_off\n" . $herecurr);
1628
			}
1629 1630 1631 1632

			my ($email_name, $email_address, $comment) = parse_email($email);
			my $suggested_email = format_email(($email_name, $email_address));
			if ($suggested_email eq "") {
1633 1634
				ERROR("BAD_SIGN_OFF",
				      "Unrecognized email address: '$email'\n" . $herecurr);
1635 1636 1637 1638 1639 1640 1641 1642 1643
			} 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) {
1644 1645
					WARN("BAD_SIGN_OFF",
					     "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
1646
				}
1647 1648 1649
			}
		}

1650
# Check for wrappage within a valid hunk of the file
1651
		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1652 1653
			ERROR("CORRUPTED_PATCH",
			      "patch seems to be corrupt (line wrapped?)\n" .
1654
				$herecurr) if (!$emitted_corrupt++);
1655 1656
		}

1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670
# 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);
				}
			}
		}

1671 1672
# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1673 1674 1675 1676 1677 1678 1679
		    $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";

1680 1681
			CHK("INVALID_UTF8",
			    "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1682 1683
		}

1684 1685 1686
# 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 =~ /^$/ &&
1687
		    $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
1688 1689 1690 1691
			$in_header_lines = 0;
			$in_commit_log = 1;
		}

1692 1693 1694 1695 1696 1697 1698 1699 1700
# 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 =~ /^$/ &&
1701
		    $rawline =~ /$NON_ASCII_UTF8/) {
1702
			WARN("UTF8_BEFORE_PATCH",
1703 1704 1705
			    "8-bit UTF-8 used in possible commit log\n" . $herecurr);
		}

1706 1707
# ignore non-hunk lines and lines being removed
		next if (!$hunk_line || $line =~ /^-/);
1708 1709

#trailing whitespace
1710
		if ($line =~ /^\+.*\015/) {
1711
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1712 1713
			ERROR("DOS_LINE_ENDINGS",
			      "DOS line endings\n" . $herevet);
1714

1715 1716
		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1717 1718
			ERROR("TRAILING_WHITESPACE",
			      "trailing whitespace\n" . $herevet);
1719
			$rpt_cleaners = 1;
1720
		}
1721

1722
# check for Kconfig help text having a real description
1723 1724
# Only applies when adding the entry originally, after that we do not have
# sufficient context to determine whether it is indeed long enough.
1725
		if ($realfile =~ /Kconfig/ &&
1726
		    $line =~ /.\s*config\s+/) {
1727
			my $length = 0;
1728 1729 1730
			my $cnt = $realcnt;
			my $ln = $linenr + 1;
			my $f;
1731
			my $is_start = 0;
1732
			my $is_end = 0;
1733
			for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
1734 1735 1736 1737 1738
				$f = $lines[$ln - 1];
				$cnt-- if ($lines[$ln - 1] !~ /^-/);
				$is_end = $lines[$ln - 1] =~ /^\+/;

				next if ($f =~ /^-/);
1739 1740 1741 1742 1743 1744 1745

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

1746
				$f =~ s/^.//;
1747 1748 1749
				$f =~ s/#.*//;
				$f =~ s/^\s+//;
				next if ($f =~ /^$/);
1750 1751 1752 1753
				if ($f =~ /^\s*config\s/) {
					$is_end = 1;
					last;
				}
1754 1755
				$length++;
			}
1756
			WARN("CONFIG_DESCRIPTION",
1757 1758
			     "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";
1759 1760
		}

1761 1762 1763 1764 1765 1766 1767
# 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");
		}

1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781
		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});
		}

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

1785
#line length limit
1786
		if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1787
		    $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1788
		    !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
1789
		    $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
1790
		    $length > $max_line_length)
1791
		{
1792
			WARN("LONG_LINE",
1793
			     "line over $max_line_length characters\n" . $herecurr);
1794 1795
		}

1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810
# 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);
		}

1811 1812
# check for spaces before a quoted newline
		if ($rawline =~ /^.*\".*\s\\n/) {
1813 1814
			WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
			     "unnecessary whitespace before a quoted newline\n" . $herecurr);
1815 1816
		}

1817 1818
# check for adding lines without a newline.
		if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1819 1820
			WARN("MISSING_EOF_NEWLINE",
			     "adding a line without newline at end of file\n" . $herecurr);
1821 1822
		}

1823 1824 1825 1826
# 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";
1827 1828
				ERROR("LO_MACRO",
				      "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
1829 1830 1831
			}
			if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
				my $herevet = "$here\n" . cat_vet($line) . "\n";
1832 1833
				ERROR("HI_MACRO",
				      "use the HI() macro, not (... >> 16)\n" . $herevet);
1834 1835 1836
			}
		}

1837 1838
# check we are in a valid source file C or perl if not then ignore this hunk
		next if ($realfile !~ /\.(h|c|pl)$/);
1839 1840 1841

# at the beginning of a line any tabs must come first and anything
# more than 8 must use tabs.
1842 1843 1844
		if ($rawline =~ /^\+\s* \t\s*\S/ ||
		    $rawline =~ /^\+\s*        \s*/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1845 1846
			ERROR("CODE_INDENT",
			      "code indent should use tabs where possible\n" . $herevet);
1847
			$rpt_cleaners = 1;
1848 1849
		}

1850 1851 1852
# check for space before tabs.
		if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1853 1854
			WARN("SPACE_BEFORE_TAB",
			     "please, no space before tabs\n" . $herevet);
1855 1856
		}

1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871
# 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 已提交
1872 1873
				$line =~ /^(\+| )([ \t]*)/;
				my $newindent = $2;
1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887

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

				if ($newindent ne $goodtabindent &&
				    $newindent ne $goodspaceindent) {
					CHK("PARENTHESIS_ALIGNMENT",
					    "Alignment should match open parenthesis\n" . $hereprev);
				}
			}
		}

1888 1889 1890 1891 1892
		if ($line =~ /^\+.*\*[ \t]*\)[ \t]+/) {
			CHK("SPACING",
			    "No space is necessary after a cast\n" . $hereprev);
		}

1893
		if ($realfile =~ m@^(drivers/net/|net/)@ &&
1894 1895
		    $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
		    $rawline =~ /^\+[ \t]*\*/) {
1896 1897 1898 1899 1900
			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
			     "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
		}

		if ($realfile =~ m@^(drivers/net/|net/)@ &&
1901 1902 1903 1904 1905 1906 1907 1908
		    $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/)@ &&
1909 1910 1911 1912
		    $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ &&	#trailing */
		    $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ &&	#inline /*...*/
		    $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ &&	#trailing **/
		    $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) {	#non blank */
1913 1914 1915 1916
			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
			     "networking block comments put the trailing */ on a separate line\n" . $herecurr);
		}

1917
# check for spaces at the beginning of a line.
1918 1919 1920 1921 1922
# Exceptions:
#  1) within comments
#  2) indented preprocessor commands
#  3) hanging labels
		if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/)  {
1923
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1924 1925
			WARN("LEADING_SPACE",
			     "please, no spaces at the start of a line\n" . $herevet);
1926 1927
		}

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

1931 1932 1933 1934 1935 1936
# 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");
		}

1937
# check for RCS/CVS revision markers
1938
		if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1939 1940
			WARN("CVS_KEYWORD",
			     "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1941
		}
1942

1943 1944 1945
# Blackfin: don't use __builtin_bfin_[cs]sync
		if ($line =~ /__builtin_bfin_csync/) {
			my $herevet = "$here\n" . cat_vet($line) . "\n";
1946 1947
			ERROR("CSYNC",
			      "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
1948 1949 1950
		}
		if ($line =~ /__builtin_bfin_ssync/) {
			my $herevet = "$here\n" . cat_vet($line) . "\n";
1951 1952
			ERROR("SSYNC",
			      "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
1953 1954
		}

1955 1956 1957 1958 1959 1960
# 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);
		}

1961
# Check for potential 'bare' types
1962 1963
		my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
		    $realline_next);
1964 1965 1966
#print "LINE<$line>\n";
		if ($linenr >= $suppress_statement &&
		    $realcnt && $line =~ /.\s*\S/) {
1967
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1968
				ctx_statement_block($linenr, $realcnt, 0);
1969 1970 1971
			$stat =~ s/\n./\n /g;
			$cond =~ s/\n./\n /g;

1972 1973 1974 1975 1976 1977 1978 1979 1980
#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;
			}
1981

1982 1983 1984 1985 1986 1987 1988 1989
			# 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++;
			}

1990 1991
			my $s = $stat;
			$s =~ s/{.*$//s;
1992

1993
			# Ignore goto labels.
1994
			if ($s =~ /$Ident:\*$/s) {
1995 1996

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

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

2001
			# declarations always start with types
2002
			} 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) {
2003 2004 2005 2006
				my $type = $1;
				$type =~ s/\s+/ /g;
				possible($type, "A:" . $s);

2007
			# definitions in global scope can only start with types
2008
			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
2009
				possible($1, "B:" . $s);
2010
			}
2011 2012

			# any (foo ... *) is a pointer cast, and foo is a type
2013
			while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
2014
				possible($1, "C:" . $s);
2015 2016 2017 2018 2019
			}

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

2023
				my $ctx = $s;
2024
				substr($ctx, 0, $name_len + 1, '');
2025
				$ctx =~ s/\)[^\)]*$//;
2026

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

2030
						possible($1, "D:" . $s);
2031 2032
					}
				}
2033
			}
2034

2035 2036
		}

2037 2038 2039
#
# Checks which may be anchored in the context.
#
2040

2041 2042
# Check for switch () and associated case and default
# statements should be at the same indent.
2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058
		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 '') {
2059 2060
				ERROR("SWITCH_CASE_INDENT_LEVEL",
				      "switch and case should be at the same indent\n$hereline$err");
2061 2062 2063 2064 2065
			}
		}

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

2069
			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2070 2071 2072 2073 2074 2075

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

2076 2077 2078
			my $ctx_cnt = $realcnt - $#ctx - 1;
			my $ctx = join("\n", @ctx);

2079 2080
			my $ctx_ln = $linenr;
			my $ctx_skip = $realcnt;
2081

2082 2083 2084 2085 2086
			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] !~ /^-/);
2087 2088
				$ctx_ln++;
			}
2089

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

2093
			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2094 2095
				ERROR("OPEN_BRACE",
				      "that open brace { should be on the previous line\n" .
2096
					"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2097
			}
2098 2099 2100 2101
			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
			    $ctx =~ /\)\s*\;\s*$/ &&
			    defined $lines[$ctx_ln - 1])
			{
2102 2103
				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
				if ($nindent > $indent) {
2104 2105
					WARN("TRAILING_SEMICOLON",
					     "trailing semicolon indicates no statements, indent implies otherwise\n" .
2106
						"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2107 2108
				}
			}
2109 2110
		}

2111 2112
# Check relative indent for conditionals and blocks.
		if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2113 2114 2115
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
2116 2117 2118 2119 2120 2121 2122 2123 2124 2125
			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.
2126 2127
			my @newlines = ($c =~ /\n/gs);
			my $cond_lines = 1 + $#newlines;
2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140

			# 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;
			}
2141
			if ($s =~ s/^\s*?\n//) {
2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152
				$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;
			}

2153
			my $cond_ptr = -1;
2154
			$continuation = 0;
2155 2156 2157
			while ($cond_ptr != $cond_lines) {
				$cond_ptr = $cond_lines;

2158 2159 2160 2161 2162 2163
				# If we see an #else/#elif then the code
				# is not linear.
				if ($s =~ /^\s*\#\s*(?:else|elif)/) {
					$check = 0;
				}

2164 2165 2166 2167
				# Ignore:
				#  1) blank lines, they should be at 0,
				#  2) preprocessor lines, and
				#  3) labels.
2168 2169
				if ($continuation ||
				    $s =~ /^\s*?\n/ ||
2170 2171
				    $s =~ /^\s*#\s*?/ ||
				    $s =~ /^\s*$Ident\s*:/) {
2172
					$continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2173 2174 2175
					if ($s =~ s/^.*?\n//) {
						$cond_lines++;
					}
2176
				}
2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191
			}

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

2192
			#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";
2193 2194 2195

			if ($check && (($sindent % 8) != 0 ||
			    ($sindent <= $indent && $s ne ''))) {
2196 2197
				WARN("SUSPECT_CODE_INDENT",
				     "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2198 2199 2200
			}
		}

2201 2202
		# Track the 'values' across context and added lines.
		my $opline = $line; $opline =~ s/^./ /;
2203 2204
		my ($curr_values, $curr_vars) =
				annotate_values($opline . "\n", $prev_values);
2205
		$curr_values = $prev_values . $curr_values;
2206 2207
		if ($dbg_values) {
			my $outline = $opline; $outline =~ s/\t/ /g;
2208 2209
			print "$linenr > .$outline\n";
			print "$linenr > $curr_values\n";
2210
			print "$linenr >  $curr_vars\n";
2211
		}
2212 2213
		$prev_values = substr($curr_values, -1);

2214 2215 2216
#ignore lines not being added
		if ($line=~/^[^\+]/) {next;}

2217
# TEST: allow direct testing of the type matcher.
2218 2219
		if ($dbg_type) {
			if ($line =~ /^.\s*$Declare\s*$/) {
2220 2221
				ERROR("TEST_TYPE",
				      "TEST: is type\n" . $herecurr);
2222
			} elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2223 2224
				ERROR("TEST_NOT_TYPE",
				      "TEST: is not type ($1 is)\n". $herecurr);
2225
			}
2226 2227
			next;
		}
2228 2229
# TEST: allow direct testing of the attribute matcher.
		if ($dbg_attr) {
2230
			if ($line =~ /^.\s*$Modifier\s*$/) {
2231 2232
				ERROR("TEST_ATTR",
				      "TEST: is attr\n" . $herecurr);
2233
			} elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2234 2235
				ERROR("TEST_NOT_ATTR",
				      "TEST: is not attr ($1 is)\n". $herecurr);
2236 2237 2238
			}
			next;
		}
2239

2240
# check for initialisation to aggregates open brace on the next line
2241 2242
		if ($line =~ /^.\s*{/ &&
		    $prevline =~ /(?:^|[^=])=\s*$/) {
2243 2244
			ERROR("OPEN_BRACE",
			      "that open brace { should be on the previous line\n" . $hereprev);
2245 2246
		}

2247 2248 2249 2250 2251
#
# Checks which are anchored on the added line.
#

# check for malformed paths in #include statements (uses RAW line)
2252
		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2253 2254
			my $path = $1;
			if ($path =~ m{//}) {
2255
				ERROR("MALFORMED_INCLUDE",
2256 2257 2258 2259 2260
				      "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);
2261 2262
			}
		}
2263

2264
# no C99 // comments
2265
		if ($line =~ m{//}) {
2266 2267
			ERROR("C99_COMMENTS",
			      "do not use C99 // comments\n" . $herecurr);
2268
		}
2269
		# Remove C99 comments.
2270
		$line =~ s@//.*@@;
2271
		$opline =~ s@//.*@@;
2272

2273 2274 2275 2276 2277 2278 2279 2280
# 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.*\((.*)\)/)) {
2281 2282 2283 2284
			# Handle definitions which produce identifiers with
			# a prefix:
			#   XXX(foo);
			#   EXPORT_SYMBOL(something_foo);
2285
			my $name = $1;
2286
			if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
2287 2288 2289 2290 2291
			    $name =~ /^${Ident}_$2/) {
#print "FOO C name<$name>\n";
				$suppress_export{$realline_next} = 1;

			} elsif ($stat !~ /(?:
2292
				\n.}\s*$|
2293 2294 2295
				^.DEFINE_$Ident\(\Q$name\E\)|
				^.DECLARE_$Ident\(\Q$name\E\)|
				^.LIST_HEAD\(\Q$name\E\)|
2296 2297
				^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
				\b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
2298
			    )/x) {
2299 2300 2301 2302
#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
				$suppress_export{$realline_next} = 2;
			} else {
				$suppress_export{$realline_next} = 1;
2303 2304
			}
		}
2305 2306 2307 2308 2309 2310 2311 2312 2313
		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) {
2314 2315
			WARN("EXPORT_SYMBOL",
			     "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2316
		}
2317

2318
# check for global initialisers.
2319
		if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
2320 2321
			ERROR("GLOBAL_INITIALISERS",
			      "do not initialise globals to 0 or NULL\n" .
2322 2323
				$herecurr);
		}
2324
# check for static initialisers.
2325
		if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2326 2327
			ERROR("INITIALISED_STATIC",
			      "do not initialise statics to 0 or NULL\n" .
2328
				$herecurr);
2329 2330
		}

2331 2332
# check for static const char * arrays.
		if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
2333 2334
			WARN("STATIC_CONST_CHAR_ARRAY",
			     "static const char * array should probably be static const char * const\n" .
2335 2336 2337 2338 2339
				$herecurr);
               }

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

2345 2346
# check for declarations of struct pci_device_id
		if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
2347 2348
			WARN("DEFINE_PCI_DEVICE_TABLE",
			     "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
2349 2350
		}

2351 2352 2353
# check for new typedefs, only function parameters and sparse annotations
# make sense.
		if ($line =~ /\btypedef\s/ &&
2354
		    $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
2355
		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
2356
		    $line !~ /\b$typeTypedefs\b/ &&
2357
		    $line !~ /\b__bitwise(?:__|)\b/) {
2358 2359
			WARN("NEW_TYPEDEFS",
			     "do not add new typedefs\n" . $herecurr);
2360 2361 2362
		}

# * goes on variable not on type
2363
		# (char*[ const])
2364 2365 2366
		while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
			#print "AA<$1>\n";
			my ($from, $to) = ($2, $2);
2367 2368 2369 2370 2371 2372

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

2376 2377
			#print "from<$from> to<$to>\n";
			if ($from ne $to) {
2378 2379
				ERROR("POINTER_LOCATION",
				      "\"(foo$from)\" should be \"(foo$to)\"\n" .  $herecurr);
2380
			}
2381 2382 2383 2384
		}
		while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
			#print "BB<$1>\n";
			my ($from, $to, $ident) = ($2, $2, $3);
2385 2386 2387 2388 2389 2390

			# Should start with a space.
			$to =~ s/^(\S)/ $1/;
			# Should not end with a space.
			$to =~ s/\s+$//;
			# '*'s should not have spaces between.
2391
			while ($to =~ s/\*\s+\*/\*\*/) {
2392 2393 2394
			}
			# Modifiers should have spaces.
			$to =~ s/(\b$Modifier$)/$1 /;
2395

2396 2397
			#print "from<$from> to<$to> ident<$ident>\n";
			if ($from ne $to && $ident !~ /^$Modifier$/) {
2398 2399
				ERROR("POINTER_LOCATION",
				      "\"foo${from}bar\" should be \"foo${to}bar\"\n" .  $herecurr);
2400
			}
2401 2402 2403 2404 2405 2406 2407 2408 2409
		}

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

2410
		if ($line =~ /\bLINUX_VERSION_CODE\b/) {
2411 2412
			WARN("LINUX_VERSION_CODE",
			     "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
2413 2414
		}

2415 2416
# check for uses of printk_ratelimit
		if ($line =~ /\bprintk_ratelimit\s*\(/) {
2417 2418
			WARN("PRINTK_RATELIMITED",
"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
2419 2420
		}

2421 2422 2423
# 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 已提交
2424
# printk includes all preceding printk's which have no newline on the end.
2425
# we assume the first bad printk is the one to report.
2426
		if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
2427 2428 2429
			my $ok = 0;
			for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
				#print "CHECK<$lines[$ln - 1]\n";
L
Lucas De Marchi 已提交
2430
				# we have a preceding printk if it ends
2431 2432 2433 2434 2435 2436 2437 2438 2439
				# 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) {
2440 2441
				WARN("PRINTK_WITHOUT_KERN_LEVEL",
				     "printk() should include KERN_ facility level\n" . $herecurr);
2442
			}
2443 2444
		}

2445 2446 2447 2448
		if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
			my $orig = $1;
			my $level = lc($orig);
			$level = "warn" if ($level eq "warning");
2449 2450
			my $level2 = $level;
			$level2 = "dbg" if ($level eq "debug");
2451
			WARN("PREFER_PR_LEVEL",
2452
			     "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(...  to printk(KERN_$orig ...\n" . $herecurr);
2453 2454 2455 2456 2457 2458 2459
		}

		if ($line =~ /\bpr_warning\s*\(/) {
			WARN("PREFER_PR_LEVEL",
			     "Prefer pr_warn(... to pr_warning(...\n" . $herecurr);
		}

2460 2461 2462 2463 2464 2465 2466 2467 2468
		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);
		}

2469 2470
# function brace can't be on same line, except for #defines of do while,
# or if closed on same line
2471 2472
		if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
		    !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
2473 2474
			ERROR("OPEN_BRACE",
			      "open brace '{' following function declarations go on the next line\n" . $herecurr);
2475
		}
2476

2477 2478 2479
# 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*$/) {
2480 2481
			ERROR("OPEN_BRACE",
			      "open brace '{' following $1 go on the same line\n" . $hereprev);
2482 2483
		}

2484 2485
# missing space after union, struct or enum definition
		if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
2486 2487
		    WARN("SPACING",
			 "missing space after $1 definition\n" . $herecurr);
2488 2489
		}

2490 2491
# check for spacing round square brackets; allowed:
#  1. with a type on the left -- int [] a;
2492 2493
#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
#  3. inside a curly brace -- = { [0...10] = 5 }
2494 2495 2496
		while ($line =~ /(.*?\s)\[/g) {
			my ($where, $prefix) = ($-[1], $1);
			if ($prefix !~ /$Type\s+$/ &&
2497
			    ($where != 0 || $prefix !~ /^.\s+$/) &&
2498
			    $prefix !~ /[{,]\s+$/) {
2499 2500
				ERROR("BRACKET_SPACE",
				      "space prohibited before open square bracket '['\n" . $herecurr);
2501 2502 2503
			}
		}

2504
# check for spaces between functions and their parentheses.
2505
		while ($line =~ /($Ident)\s+\(/g) {
2506
			my $name = $1;
2507 2508
			my $ctx_before = substr($line, 0, $-[1]);
			my $ctx = "$ctx_before$name";
2509 2510

			# Ignore those directives where spaces _are_ permitted.
2511 2512 2513 2514 2515 2516
			if ($name =~ /^(?:
				if|for|while|switch|return|case|
				volatile|__volatile__|
				__attribute__|format|__extension__|
				asm|__asm__)$/x)
			{
2517 2518 2519 2520

			# 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.
2521
			} elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
2522 2523

			# cpp #elif statement condition may start with a (
2524
			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
2525 2526 2527

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

			} else {
2531 2532
				WARN("SPACING",
				     "space prohibited between function name and open parenthesis '('\n" . $herecurr);
2533
			}
2534
		}
2535 2536 2537

# check for whitespace before a non-naked semicolon
		if ($line =~ /^\+.*\S\s+;/) {
2538 2539
			WARN("SPACING",
			     "space prohibited before semicolon\n" . $herecurr);
2540 2541
		}

2542
# Check operator spacing.
2543
		if (!($line=~/\#\s*include/)) {
2544 2545 2546 2547
			my $ops = qr{
				<<=|>>=|<=|>=|==|!=|
				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
				=>|->|<<|>>|<|>|=|!|~|
2548 2549
				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
				\?|:
2550
			}x;
2551
			my @elements = split(/($ops|;)/, $opline);
2552
			my $off = 0;
2553 2554 2555

			my $blank = copy_spacing($opline);

2556
			for (my $n = 0; $n < $#elements; $n += 2) {
2557 2558
				$off += length($elements[$n]);

L
Lucas De Marchi 已提交
2559
				# Pick up the preceding and succeeding characters.
2560 2561 2562 2563 2564 2565 2566
				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";

2567 2568 2569
				my $a = '';
				$a = 'V' if ($elements[$n] ne '');
				$a = 'W' if ($elements[$n] =~ /\s$/);
2570
				$a = 'C' if ($elements[$n] =~ /$;$/);
2571 2572
				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
				$a = 'O' if ($elements[$n] eq '');
2573
				$a = 'E' if ($ca =~ /^\s*$/);
2574

2575
				my $op = $elements[$n + 1];
2576 2577

				my $c = '';
2578
				if (defined $elements[$n + 2]) {
2579 2580
					$c = 'V' if ($elements[$n + 2] ne '');
					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
2581
					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
2582 2583
					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
					$c = 'O' if ($elements[$n + 2] eq '');
2584
					$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
2585 2586
				} else {
					$c = 'E';
2587 2588
				}

2589 2590 2591 2592
				my $ctx = "${a}x${c}";

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

2593
				my $ptr = substr($blank, 0, $off) . "^";
2594
				my $hereptr = "$hereline$ptr\n";
2595

2596
				# Pull out the value of this operator.
2597
				my $op_type = substr($curr_values, $off + 1, 1);
2598

2599 2600 2601
				# Get the full operator variant.
				my $opv = $op . substr($curr_vars, $off, 1);

2602 2603 2604 2605
				# Ignore operators passed as parameters.
				if ($op_type ne 'V' &&
				    $ca =~ /\s$/ && $cc =~ /^\s*,/) {

2606 2607
#				# Ignore comments
#				} elsif ($op =~ /^$;+$/) {
2608

2609
				# ; should have either the end of line or a space or \ after it
2610
				} elsif ($op eq ';') {
2611 2612
					if ($ctx !~ /.x[WEBC]/ &&
					    $cc !~ /^\\/ && $cc !~ /^;/) {
2613 2614
						ERROR("SPACING",
						      "space required after that '$op' $at\n" . $hereptr);
2615 2616 2617 2618
					}

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

2620 2621 2622 2623
				# No spaces for:
				#   ->
				#   :   when part of a bitfield
				} elsif ($op eq '->' || $opv eq ':B') {
2624
					if ($ctx =~ /Wx.|.xW/) {
2625 2626
						ERROR("SPACING",
						      "spaces prohibited around that '$op' $at\n" . $hereptr);
2627 2628 2629 2630
					}

				# , must have a space on the right.
				} elsif ($op eq ',') {
2631
					if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
2632 2633
						ERROR("SPACING",
						      "space required after that '$op' $at\n" . $hereptr);
2634 2635
					}

2636
				# '*' as part of a type definition -- reported already.
2637
				} elsif ($opv eq '*_') {
2638 2639 2640 2641 2642 2643
					#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 '~' ||
2644
					 $opv eq '*U' || $opv eq '-U' ||
2645
					 $opv eq '&U' || $opv eq '&&U') {
2646
					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
2647 2648
						ERROR("SPACING",
						      "space required before that '$op' $at\n" . $hereptr);
2649
					}
2650
					if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
2651 2652 2653
						# A unary '*' may be const

					} elsif ($ctx =~ /.xW/) {
2654 2655
						ERROR("SPACING",
						      "space prohibited after that '$op' $at\n" . $hereptr);
2656 2657 2658 2659
					}

				# unary ++ and unary -- are allowed no space on one side.
				} elsif ($op eq '++' or $op eq '--') {
2660
					if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2661 2662
						ERROR("SPACING",
						      "space required one side of that '$op' $at\n" . $hereptr);
2663 2664 2665
					}
					if ($ctx =~ /Wx[BE]/ ||
					    ($ctx =~ /Wx./ && $cc =~ /^;/)) {
2666 2667
						ERROR("SPACING",
						      "space prohibited before that '$op' $at\n" . $hereptr);
2668
					}
2669
					if ($ctx =~ /ExW/) {
2670 2671
						ERROR("SPACING",
						      "space prohibited after that '$op' $at\n" . $hereptr);
2672
					}
2673

2674

2675
				# << and >> may either have or not have spaces both sides
2676 2677 2678
				} elsif ($op eq '<<' or $op eq '>>' or
					 $op eq '&' or $op eq '^' or $op eq '|' or
					 $op eq '+' or $op eq '-' or
2679 2680
					 $op eq '*' or $op eq '/' or
					 $op eq '%')
2681
				{
2682
					if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
2683 2684
						ERROR("SPACING",
						      "need consistent spacing around '$op' $at\n" .
2685
							$hereptr);
2686 2687
					}

2688 2689 2690 2691
				# 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./) {
2692 2693
						ERROR("SPACING",
						      "space prohibited before that '$op' $at\n" . $hereptr);
2694 2695
					}

2696
				# All the others need spaces both sides.
2697
				} elsif ($ctx !~ /[EWC]x[CWE]/) {
2698 2699
					my $ok = 0;

2700
					# Ignore email addresses <foo@bar>
2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715
					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) {
2716 2717
						ERROR("SPACING",
						      "spaces required around that '$op' $at\n" . $hereptr);
2718
					}
2719
				}
2720
				$off += length($elements[$n + 1]);
2721 2722 2723
			}
		}

2724 2725
# check for multiple assignments
		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
2726 2727
			CHK("MULTIPLE_ASSIGNMENTS",
			    "multiple assignments should be avoided\n" . $herecurr);
2728 2729
		}

2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740
## # 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 =~ /,/) {
2741 2742
## 				WARN("MULTIPLE_DECLARATION",
##				     "declaring multiple variables together should be avoided\n" . $herecurr);
2743 2744
## 			}
## 		}
2745

2746
#need space before brace following if, while, etc
2747 2748
		if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
		    $line =~ /do{/) {
2749 2750
			ERROR("SPACING",
			      "space required before the open brace '{'\n" . $herecurr);
2751 2752 2753 2754 2755
		}

# closing brace should have a space following it when it has anything
# on the line
		if ($line =~ /}(?!(?:,|;|\)))\S/) {
2756 2757
			ERROR("SPACING",
			      "space required after that close brace '}'\n" . $herecurr);
2758 2759
		}

2760 2761
# check spacing on square brackets
		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
2762 2763
			ERROR("SPACING",
			      "space prohibited after that open square bracket '['\n" . $herecurr);
2764 2765
		}
		if ($line =~ /\s\]/) {
2766 2767
			ERROR("SPACING",
			      "space prohibited before that close square bracket ']'\n" . $herecurr);
2768 2769
		}

2770
# check spacing on parentheses
2771 2772
		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
		    $line !~ /for\s*\(\s+;/) {
2773 2774
			ERROR("SPACING",
			      "space prohibited after that open parenthesis '('\n" . $herecurr);
2775
		}
2776
		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
2777 2778
		    $line !~ /for\s*\(.*;\s+\)/ &&
		    $line !~ /:\s+\)/) {
2779 2780
			ERROR("SPACING",
			      "space prohibited before that close parenthesis ')'\n" . $herecurr);
2781 2782
		}

2783
#goto labels aren't indented, allow a single space however
2784
		if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
2785
		   !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
2786 2787
			WARN("INDENTED_LABEL",
			     "labels should not be indented\n" . $herecurr);
2788 2789
		}

2790 2791 2792 2793 2794
# Return is not a function.
		if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
			my $spacing = $1;
			my $value = $2;

2795
			# Flatten any parentheses
2796 2797
			$value =~ s/\(/ \(/g;
			$value =~ s/\)/\) /g;
2798
			while ($value =~ s/\[[^\[\]]*\]/1/ ||
2799 2800 2801 2802
			       $value !~ /(?:$Ident|-?$Constant)\s*
					     $Compare\s*
					     (?:$Ident|-?$Constant)/x &&
			       $value =~ s/\([^\(\)]*\)/1/) {
2803
			}
2804 2805
#print "value<$value>\n";
			if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
2806 2807
				ERROR("RETURN_PARENTHESES",
				      "return is not a function, parentheses are not required\n" . $herecurr);
2808 2809

			} elsif ($spacing !~ /\s+/) {
2810 2811
				ERROR("SPACING",
				      "space required before the open parenthesis '('\n" . $herecurr);
2812 2813
			}
		}
2814 2815 2816 2817
# 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') {
2818 2819
				WARN("USE_NEGATIVE_ERRNO",
				     "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
2820 2821
			}
		}
2822

2823
# Need a space before open parenthesis after if, while etc
2824
		if ($line=~/\b(if|while|for|switch)\(/) {
2825
			ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr);
2826 2827
		}

2828 2829
# Check for illegal assignment in if conditional -- and check for trailing
# statements after the conditional.
2830
		if ($line =~ /do\s*(?!{)/) {
2831 2832 2833
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852
			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*#/) {
2853
			my ($s, $c) = ($stat, $cond);
2854

2855
			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2856 2857
				ERROR("ASSIGN_IN_IF",
				      "do not use assignment in if condition\n" . $herecurr);
2858 2859 2860 2861
			}

			# Find out what is on the end of the line after the
			# conditional.
2862
			substr($s, 0, length($c), '');
2863
			$s =~ s/\n.*//g;
2864
			$s =~ s/$;//g; 	# Remove any comments
2865 2866
			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
			    $c !~ /}\s*while\s*/)
2867
			{
2868 2869 2870
				# Find out how long the conditional actually is.
				my @newlines = ($c =~ /\n/gs);
				my $cond_lines = 1 + $#newlines;
2871
				my $stat_real = '';
2872

2873 2874
				$stat_real = raw_line($linenr, $cond_lines)
							. "\n" if ($cond_lines);
2875 2876 2877 2878
				if (defined($stat_real) && $cond_lines > 1) {
					$stat_real = "[...]\n$stat_real";
				}

2879 2880
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr . $stat_real);
2881 2882 2883
			}
		}

2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895
# Check for bitwise tests written as boolean
		if ($line =~ /
			(?:
				(?:\[|\(|\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\|)
			|
				(?:\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\||\)|\])
			)/x)
		{
2896 2897
			WARN("HEXADECIMAL_BOOLEAN_TEST",
			     "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2898 2899
		}

2900
# if and else should not have general statements after it
2901 2902 2903 2904
		if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
			my $s = $1;
			$s =~ s/$;//g; 	# Remove any comments
			if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2905 2906
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr);
2907
			}
2908
		}
2909 2910
# if should not continue a brace
		if ($line =~ /}\s*if\b/) {
2911 2912
			ERROR("TRAILING_STATEMENTS",
			      "trailing statements should be on next line\n" .
2913 2914
				$herecurr);
		}
2915 2916 2917
# case and default should not have general statements after them
		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
		    $line !~ /\G(?:
2918
			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
2919 2920 2921
			\s*return\s+
		    )/xg)
		{
2922 2923
			ERROR("TRAILING_STATEMENTS",
			      "trailing statements should be on next line\n" . $herecurr);
2924
		}
2925 2926 2927 2928 2929

		# 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) {
2930 2931
			ERROR("ELSE_AFTER_BRACE",
			      "else should follow close brace '}'\n" . $hereprev);
2932 2933
		}

2934 2935 2936 2937 2938 2939
		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.
2940
			substr($s, 0, length($c), '');
2941 2942 2943
			$s =~ s/\n.*//g;

			if ($s =~ /^\s*;/) {
2944 2945
				ERROR("WHILE_AFTER_BRACE",
				      "while should follow close brace '}'\n" . $hereprev);
2946 2947 2948
			}
		}

2949
#Specific variable tests
2950 2951
		while ($line =~ m{($Constant|$Lval)}g) {
			my $var = $1;
2952 2953 2954 2955 2956 2957 2958 2959

#gcc binary extension
			if ($var =~ /^$Binary$/) {
				WARN("GCC_BINARY_CONSTANT",
				     "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr);
			}

#CamelCase
2960
			if ($var !~ /^$Constant$/ &&
2961
			    $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
2962
			    $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
2963 2964
			    !defined $camelcase{$var}) {
				$camelcase{$var} = 1;
2965 2966
				CHK("CAMELCASE",
				    "Avoid CamelCase: <$var>\n" . $herecurr);
2967 2968
			}
		}
2969 2970

#no spaces allowed after \ in define
2971
		if ($line=~/\#\s*define.*\\\s$/) {
2972 2973
			WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
			     "Whitepspace after \\ makes next lines useless\n" . $herecurr);
2974 2975
		}

2976
#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2977
		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2978 2979 2980 2981
			my $file = "$1.h";
			my $checkfile = "include/linux/$file";
			if (-f "$root/$checkfile" &&
			    $realfile ne $checkfile &&
2982
			    $1 !~ /$allowed_asm_includes/)
2983
			{
2984
				if ($realfile =~ m{^arch/}) {
2985 2986
					CHK("ARCH_INCLUDE_LINUX",
					    "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2987
				} else {
2988 2989
					WARN("INCLUDE_LINUX",
					     "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2990
				}
2991 2992 2993
			}
		}

2994 2995
# 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
2996
# in a known good container
2997 2998
		if ($realfile !~ m@/vmlinux.lds.h$@ &&
		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2999 3000
			my $ln = $linenr;
			my $cnt = $realcnt;
3001 3002 3003
			my ($off, $dstat, $dcond, $rest);
			my $ctx = '';
			($dstat, $dcond, $ln, $cnt, $off) =
3004 3005
				ctx_statement_block($linenr, $realcnt, 0);
			$ctx = $dstat;
3006
			#print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
3007
			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
3008

3009
			$dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
3010
			$dstat =~ s/$;//g;
3011 3012 3013
			$dstat =~ s/\\\n.//g;
			$dstat =~ s/^\s*//s;
			$dstat =~ s/\s*$//s;
3014

3015
			# Flatten any parentheses and braces
3016 3017
			while ($dstat =~ s/\([^\(\)]*\)/1/ ||
			       $dstat =~ s/\{[^\{\}]*\}/1/ ||
3018
			       $dstat =~ s/\[[^\[\]]*\]/1/)
3019
			{
3020
			}
3021

3022 3023 3024 3025 3026 3027
			# Flatten any obvious string concatentation.
			while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
			       $dstat =~ s/$Ident\s*("X*")/$1/)
			{
			}

3028 3029 3030
			my $exceptions = qr{
				$Declare|
				module_param_named|
3031
				MODULE_PARM_DESC|
3032 3033
				DECLARE_PER_CPU|
				DEFINE_PER_CPU|
3034
				__typeof__\(|
3035 3036
				union|
				struct|
3037 3038
				\.$Ident\s*=\s*|
				^\"|\"$
3039
			}x;
3040
			#print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
3041 3042 3043
			if ($dstat ne '' &&
			    $dstat !~ /^(?:$Ident|-?$Constant),$/ &&			# 10, // foo(),
			    $dstat !~ /^(?:$Ident|-?$Constant);$/ &&			# foo();
3044
			    $dstat !~ /^[!~-]?(?:$Ident|$Constant)$/ &&		# 10 // foo() // !foo // ~foo // -foo
3045
			    $dstat !~ /^'X'$/ &&					# character constants
3046 3047
			    $dstat !~ /$exceptions/ &&
			    $dstat !~ /^\.$Ident\s*=/ &&				# .foo =
3048
			    $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ &&		# stringification #foo
3049
			    $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ &&	# do {...} while (...); // do {...} while (...)
3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060
			    $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";
3061 3062
				}

3063 3064 3065 3066
				if ($dstat =~ /;/) {
					ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
					      "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
				} else {
3067
					ERROR("COMPLEX_MACRO",
3068
					      "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
3069
				}
3070
			}
3071

3072
# check for line continuations outside of #defines, preprocessor #, and asm
3073 3074 3075

		} else {
			if ($prevline !~ /^..*\\$/ &&
3076 3077
			    $line !~ /^\+\s*\#.*\\$/ &&		# preprocessor
			    $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ &&	# asm
3078 3079 3080 3081
			    $line =~ /^\+.*\\$/) {
				WARN("LINE_CONTINUATIONS",
				     "Avoid unnecessary line continuations\n" . $herecurr);
			}
3082 3083
		}

3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111
# 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";
				}

3112 3113
				if (($stmts =~ tr/;/;/) == 1 &&
				    $stmts !~ /^\s*(if|while|for|switch)\b/) {
3114 3115 3116 3117 3118 3119 3120 3121 3122 3123
					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");
				}
			}
		}

3124 3125 3126 3127 3128 3129
# 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|$))/) {
3130 3131
			WARN("MISSING_VMLINUX_SYMBOL",
			     "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
3132 3133
		}

3134
# check for redundant bracing round if etc
3135 3136
		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
			my ($level, $endln, @chunks) =
3137
				ctx_statement_full($linenr, $realcnt, 1);
3138
			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
3139 3140
			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
			if ($#chunks > 0 && $level == 0) {
3141 3142
				my @allowed = ();
				my $allow = 0;
3143
				my $seen = 0;
3144
				my $herectx = $here . "\n";
3145
				my $ln = $linenr - 1;
3146 3147 3148
				for my $chunk (@chunks) {
					my ($cond, $block) = @{$chunk};

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

3153
					$allowed[$allow] = 0;
3154 3155 3156 3157 3158 3159
					#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";
3160 3161
					$ln += statement_rawlines($block) - 1;

3162
					substr($block, 0, length($cond), '');
3163 3164 3165

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

3166
					#print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
3167 3168
					if (statement_lines($cond) > 1) {
						#print "APW: ALLOWED: cond<$cond>\n";
3169
						$allowed[$allow] = 1;
3170 3171
					}
					if ($block =~/\b(?:if|for|while)\b/) {
3172
						#print "APW: ALLOWED: block<$block>\n";
3173
						$allowed[$allow] = 1;
3174
					}
3175 3176
					if (statement_block_size($block) > 1) {
						#print "APW: ALLOWED: lines block<$block>\n";
3177
						$allowed[$allow] = 1;
3178
					}
3179
					$allow++;
3180
				}
3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193
				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);
					}
3194 3195 3196
				}
			}
		}
3197
		if (!defined $suppress_ifbraces{$linenr - 1} &&
3198
					$line =~ /\b(if|while|for|else)\b/) {
3199 3200 3201 3202 3203 3204 3205
			my $allowed = 0;

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

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

3210 3211
			# Check the condition.
			my ($cond, $block) = @{$chunks[0]};
3212
			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
3213
			if (defined $cond) {
3214
				substr($block, 0, length($cond), '');
3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231
			}
			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) {
3232
					substr($block, 0, length($cond), '');
3233 3234 3235 3236 3237 3238 3239
				}
				if ($block =~ /^\s*\{/) {
					#print "APW: ALLOWED: chunk-1 block<$block>\n";
					$allowed = 1;
				}
			}
			if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
3240
				my $herectx = $here . "\n";
3241
				my $cnt = statement_rawlines($block);
3242

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

3247 3248
				WARN("BRACES",
				     "braces {} are not necessary for single statement blocks\n" . $herectx);
3249 3250 3251
			}
		}

3252
# check for unnecessary blank lines around braces
3253
		if (($line =~ /^.\s*}\s*$/ && $prevline =~ /^.\s*$/)) {
3254 3255 3256 3257 3258 3259 3260 3261
			CHK("BRACES",
			    "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
		}
		if (($line =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
			CHK("BRACES",
			    "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
		}

3262
# no volatiles please
3263 3264
		my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
		if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
3265 3266
			WARN("VOLATILE",
			     "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
3267 3268
		}

3269
# warn about #if 0
3270
		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
3271 3272
			CHK("REDUNDANT_CODE",
			    "if this code is redundant consider removing it\n" .
3273
				$herecurr);
3274 3275
		}

3276 3277 3278 3279 3280 3281
# 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);
3282 3283
			}
		}
3284

3285
# prefer usleep_range over udelay
B
Bruce Allan 已提交
3286
		if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
3287
			# ignore udelay's < 10, however
B
Bruce Allan 已提交
3288
			if (! ($1 < 10) ) {
3289 3290
				CHK("USLEEP_RANGE",
				    "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
3291 3292 3293
			}
		}

3294 3295 3296
# warn about unexpectedly long msleep's
		if ($line =~ /\bmsleep\s*\((\d+)\);/) {
			if ($1 < 20) {
3297 3298
				WARN("MSLEEP",
				     "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
3299 3300 3301
			}
		}

3302 3303 3304 3305 3306 3307
# 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);
		}

3308 3309 3310 3311 3312 3313
# 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);
		}

3314
# warn about #ifdefs in C files
3315
#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
3316 3317 3318 3319 3320
#			print "#ifdef in C files should be avoided\n";
#			print "$herecurr";
#			$clean = 0;
#		}

3321
# warn about spacing in #ifdefs
3322
		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
3323 3324
			ERROR("SPACING",
			      "exactly one space required after that #$1\n" . $herecurr);
3325 3326
		}

3327
# check for spinlock_t definitions without a comment.
3328 3329
		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
3330 3331
			my $which = $1;
			if (!ctx_has_comment($first_line, $linenr)) {
3332 3333
				CHK("UNCOMMENTED_DEFINITION",
				    "$1 definition without comment\n" . $herecurr);
3334 3335 3336 3337 3338
			}
		}
# 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)) {
3339 3340
				CHK("MEMORY_BARRIER",
				    "memory barrier without comment\n" . $herecurr);
3341 3342 3343
			}
		}
# check of hardware specific defines
3344
		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
3345 3346
			CHK("ARCH_DEFINES",
			    "architecture specific defines should be avoided\n" .  $herecurr);
3347
		}
3348

3349 3350
# Check that the storage class is at the beginning of a declaration
		if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
3351 3352
			WARN("STORAGE_CLASS",
			     "storage class should be at the beginning of the declaration\n" . $herecurr)
3353 3354
		}

3355 3356
# check the location of the inline attribute, that it is between
# storage class and type.
3357 3358
		if ($line =~ /\b$Type\s+$Inline\b/ ||
		    $line =~ /\b$Inline\s+$Storage\b/) {
3359 3360
			ERROR("INLINE_LOCATION",
			      "inline keyword should sit between storage class and type\n" . $herecurr);
3361 3362
		}

3363 3364
# Check for __inline__ and __inline, prefer inline
		if ($line =~ /\b(__inline__|__inline)\b/) {
3365 3366
			WARN("INLINE",
			     "plain inline is preferred over $1\n" . $herecurr);
3367 3368
		}

3369 3370
# Check for __attribute__ packed, prefer __packed
		if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
3371 3372
			WARN("PREFER_PACKED",
			     "__packed is preferred over __attribute__((packed))\n" . $herecurr);
3373 3374
		}

3375 3376
# Check for __attribute__ aligned, prefer __aligned
		if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
3377 3378
			WARN("PREFER_ALIGNED",
			     "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
3379 3380
		}

3381 3382 3383 3384 3385 3386
# Check for __attribute__ format(printf, prefer __printf
		if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
			WARN("PREFER_PRINTF",
			     "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr);
		}

3387 3388 3389 3390 3391 3392
# Check for __attribute__ format(scanf, prefer __scanf
		if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
			WARN("PREFER_SCANF",
			     "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr);
		}

3393 3394
# check for sizeof(&)
		if ($line =~ /\bsizeof\s*\(\s*\&/) {
3395 3396
			WARN("SIZEOF_ADDRESS",
			     "sizeof(& should be avoided\n" . $herecurr);
3397 3398
		}

3399 3400 3401 3402 3403 3404
# check for sizeof without parenthesis
		if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
			WARN("SIZEOF_PARENTHESIS",
			     "sizeof $1 should be sizeof($1)\n" . $herecurr);
		}

3405 3406
# check for line continuations in quoted strings with odd counts of "
		if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
3407 3408
			WARN("LINE_CONTINUATIONS",
			     "Avoid line continuations in quoted strings\n" . $herecurr);
3409 3410
		}

3411 3412 3413 3414 3415 3416
# 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);
		}

3417 3418 3419 3420 3421 3422 3423 3424 3425
# check for seq_printf uses that could be seq_puts
		if ($line =~ /\bseq_printf\s*\(/) {
			my $fmt = get_quoted_string($line, $rawline);
			if ($fmt !~ /[^\\]\%/) {
				WARN("PREFER_SEQ_PUTS",
				     "Prefer seq_puts to seq_printf\n" . $herecurr);
			}
		}

3426
# Check for misused memsets
3427 3428
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
3429 3430 3431
		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {

			my $ms_addr = $2;
3432 3433
			my $ms_val = $7;
			my $ms_size = $12;
3434 3435 3436

			if ($ms_size =~ /^(0x|)0$/i) {
				ERROR("MEMSET",
3437
				      "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
3438 3439
			} elsif ($ms_size =~ /^(0x|)1$/i) {
				WARN("MEMSET",
3440 3441 3442 3443 3444
				     "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
			}
		}

# typecasts on min/max could be min_t/max_t
3445 3446
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
3447
		    $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
3448
			if (defined $2 || defined $7) {
3449 3450 3451
				my $call = $1;
				my $cast1 = deparenthesize($2);
				my $arg1 = $3;
3452 3453
				my $cast2 = deparenthesize($7);
				my $arg2 = $8;
3454 3455
				my $cast;

3456
				if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
3457 3458 3459 3460 3461 3462 3463 3464
					$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");
3465 3466 3467
			}
		}

3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483
# 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");
			}
		}

3484
# check for new externs in .c files.
3485
		if ($realfile =~ /\.c$/ && defined $stat &&
3486
		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
3487
		{
3488 3489
			my $function_name = $1;
			my $paren_space = $2;
3490 3491 3492 3493 3494

			my $s = $stat;
			if (defined $cond) {
				substr($s, 0, length($cond), '');
			}
3495 3496 3497
			if ($s =~ /^\s*;/ &&
			    $function_name ne 'uninitialized_var')
			{
3498 3499
				WARN("AVOID_EXTERNS",
				     "externs should be avoided in .c files\n" .  $herecurr);
3500 3501 3502
			}

			if ($paren_space =~ /\n/) {
3503 3504
				WARN("FUNCTION_ARGUMENTS",
				     "arguments for function declarations should follow identifier\n" . $herecurr);
3505
			}
3506 3507 3508 3509

		} elsif ($realfile =~ /\.c$/ && defined $stat &&
		    $stat =~ /^.\s*extern\s+/)
		{
3510 3511
			WARN("AVOID_EXTERNS",
			     "externs should be avoided in .c files\n" .  $herecurr);
3512 3513 3514 3515 3516 3517 3518
		}

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

			if (!grep(/$name/, @setup_docs)) {
3519 3520
				CHK("UNDOCUMENTED_SETUP",
				    "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
3521
			}
3522
		}
3523 3524

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

3530 3531 3532 3533 3534 3535 3536 3537
# 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);
		}

3538 3539 3540 3541 3542 3543 3544
# 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);
		}

3545 3546 3547 3548 3549 3550
# 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);
		}

3551 3552
# check for multiple semicolons
		if ($line =~ /;\s*;\s*$/) {
3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568
			WARN("ONE_SEMICOLON",
			     "Statements terminations use 1 semicolon\n" . $herecurr);
		}

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

3571 3572
# check for gcc specific __FUNCTION__
		if ($line =~ /__FUNCTION__/) {
3573 3574
			WARN("USE_FUNC",
			     "__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr);
3575
		}
3576

J
Joe Perches 已提交
3577 3578 3579 3580 3581 3582
# 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);
		}

3583 3584
# check for semaphores initialized locked
		if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
3585 3586
			WARN("CONSIDER_COMPLETION",
			     "consider using a completion\n" . $herecurr);
3587
		}
3588

3589 3590
# recommend kstrto* over simple_strto* and strict_strto*
		if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
3591
			WARN("CONSIDER_KSTRTO",
3592
			     "$1 is obsolete, use k$3 instead\n" . $herecurr);
3593
		}
3594

3595 3596
# check for __initcall(), use device_initcall() explicitly please
		if ($line =~ /^.\s*__initcall\s*\(/) {
3597 3598
			WARN("USE_DEVICE_INITCALL",
			     "please use device_initcall() instead of __initcall()\n" . $herecurr);
3599
		}
3600

3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638
# 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;
3639
		if ($line !~ /\bconst\b/ &&
3640
		    $line =~ /\bstruct\s+($struct_ops)\b/) {
3641 3642
			WARN("CONST_STRUCT",
			     "struct $1 should normally be const\n" .
3643
				$herecurr);
3644
		}
3645 3646 3647 3648

# 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/ &&
3649 3650
		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
3651 3652 3653
		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
3654
		{
3655 3656
			WARN("NR_CPUS",
			     "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
3657
		}
3658 3659 3660 3661 3662

# check for %L{u,d,i} in strings
		my $string;
		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
			$string = substr($rawline, $-[1], $+[1] - $-[1]);
3663
			$string =~ s/%%/__/g;
3664
			if ($string =~ /(?<!%)%L[udi]/) {
3665 3666
				WARN("PRINTF_L",
				     "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
3667 3668 3669
				last;
			}
		}
3670 3671 3672 3673

# whine mightly about in_atomic
		if ($line =~ /\bin_atomic\s*\(/) {
			if ($realfile =~ m@^drivers/@) {
3674 3675
				ERROR("IN_ATOMIC",
				      "do not use in_atomic in drivers\n" . $herecurr);
3676
			} elsif ($realfile !~ m@^kernel/@) {
3677 3678
				WARN("IN_ATOMIC",
				     "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
3679 3680
			}
		}
3681 3682 3683 3684 3685 3686 3687

# 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@) {
3688 3689
				ERROR("LOCKDEP",
				      "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
3690 3691
			}
		}
3692 3693 3694

		if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
		    $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
3695 3696
			WARN("EXPORTED_WORLD_WRITABLE",
			     "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
3697
		}
3698 3699 3700 3701 3702 3703
	}

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

3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718
	# 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) {
3719 3720
		ERROR("NOT_UNIFIED_DIFF",
		      "Does not appear to be a unified-diff format patch\n");
3721 3722
	}
	if ($is_patch && $chk_signoff && $signoff == 0) {
3723 3724
		ERROR("MISSING_SIGN_OFF",
		      "Missing Signed-off-by: line(s)\n");
3725 3726
	}

3727
	print report_dump();
3728 3729
	if ($summary && !($clean == 1 && $quiet == 1)) {
		print "$filename " if ($summary_file);
3730 3731 3732 3733
		print "total: $cnt_error errors, $cnt_warn warnings, " .
			(($check)? "$cnt_chk checks, " : "") .
			"$cnt_lines lines checked\n";
		print "\n" if ($quiet == 0);
3734
	}
3735

3736
	if ($quiet == 0) {
3737 3738 3739 3740 3741 3742

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

3743 3744 3745 3746 3747
		# 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";
3748
			$rpt_cleaners = 0;
3749 3750 3751
		}
	}

3752
	if ($quiet == 0 && keys %ignore_type) {
3753 3754 3755 3756
	    print "NOTE: Ignored message types:";
	    foreach my $ignore (sort keys %ignore_type) {
		print " $ignore";
	    }
3757
	    print "\n\n";
3758 3759
	}

3760
	if ($clean == 1 && $quiet == 0) {
3761
		print "$vname has no obvious style problems and is ready for submission.\n"
3762 3763
	}
	if ($clean == 0 && $quiet == 0) {
3764 3765 3766 3767 3768 3769
		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
3770
	}
3771

3772 3773
	return $clean;
}