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

use strict;

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

A
Andy Whitcroft 已提交
12
my $V = '0.21';
13 14 15 16 17 18 19

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

my $quiet = 0;
my $tree = 1;
my $chk_signoff = 1;
my $chk_patch = 1;
20
my $tst_only;
21
my $emacs = 0;
22
my $terse = 0;
23 24
my $file = 0;
my $check = 0;
25 26
my $summary = 1;
my $mailback = 0;
27
my $summary_file = 0;
28
my $root;
29
my %debug;
30
GetOptions(
31
	'q|quiet+'	=> \$quiet,
32 33 34
	'tree!'		=> \$tree,
	'signoff!'	=> \$chk_signoff,
	'patch!'	=> \$chk_patch,
35
	'emacs!'	=> \$emacs,
36
	'terse!'	=> \$terse,
37 38 39 40
	'file!'		=> \$file,
	'subjective!'	=> \$check,
	'strict!'	=> \$check,
	'root=s'	=> \$root,
41 42
	'summary!'	=> \$summary,
	'mailback!'	=> \$mailback,
43 44
	'summary-file!'	=> \$summary_file,

45
	'debug=s'	=> \%debug,
46
	'test-only=s'	=> \$tst_only,
47 48 49 50 51
) or exit;

my $exit = 0;

if ($#ARGV < 0) {
52
	print "usage: $P [options] patchfile\n";
53
	print "version: $V\n";
54 55 56 57 58 59 60 61 62
	print "options: -q               => quiet\n";
	print "         --no-tree        => run without a kernel tree\n";
	print "         --terse          => one line per report\n";
	print "         --emacs          => emacs compile window format\n";
	print "         --file           => check a source file\n";
	print "         --strict         => enable more subjective tests\n";
	print "         --root           => path to the kernel tree root\n";
	print "         --no-summary     => suppress the per-file summary\n";
	print "         --summary-file   => include the filename in summary\n";
63 64 65
	exit(1);
}

66 67
my $dbg_values = 0;
my $dbg_possible = 0;
68
my $dbg_type = 0;
69
my $dbg_attr = 0;
70 71 72 73
for my $key (keys %debug) {
	eval "\${dbg_$key} = '$debug{$key}';"
}

74 75 76 77 78
if ($terse) {
	$emacs = 1;
	$quiet++;
}

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

99 100 101 102 103 104 105 106 107 108 109
my $emitted_corrupt = 0;

our $Ident       = qr{[A-Za-z_][A-Za-z\d_]*};
our $Storage	= qr{extern|static|asmlinkage};
our $Sparse	= qr{
			__user|
			__kernel|
			__force|
			__iomem|
			__must_check|
			__init_refok|
110
			__kprobes
111 112 113 114 115 116 117
		}x;
our $Attribute	= qr{
			const|
			__read_mostly|
			__kprobes|
			__(?:mem|cpu|dev|)(?:initdata|init)
		  }x;
118
our $Modifier;
119 120 121 122 123 124 125 126 127
our $Inline	= qr{inline|__always_inline|noinline};
our $Member	= qr{->$Ident|\.$Ident|\[[^]]*\]};
our $Lval	= qr{$Ident(?:$Member)*};

our $Constant	= qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
our $Assignment	= qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
our $Operators	= qr{
			<=|>=|==|!=|
			=>|->|<<|>>|<|>|!|~|
128
			&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
129 130
		  }x;

131 132 133 134
our $NonptrType;
our $Type;
our $Declare;

135 136 137 138 139 140 141 142 143 144 145
our $UTF8	= qr {
	[\x09\x0A\x0D\x20-\x7E]              # ASCII
	| [\xC2-\xDF][\x80-\xBF]             # non-overlong 2-byte
	|  \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;

146 147
our @typeList = (
	qr{void},
148 149 150 151 152 153 154
	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},
155 156 157 158 159 160 161 162 163 164 165 166
	qr{unsigned},
	qr{float},
	qr{double},
	qr{bool},
	qr{(?:__)?(?:u|s|be|le)(?:8|16|32|64)},
	qr{struct\s+$Ident},
	qr{union\s+$Ident},
	qr{enum\s+$Ident},
	qr{${Ident}_t},
	qr{${Ident}_handler},
	qr{${Ident}_handler_fn},
);
167 168 169
our @modifierList = (
	qr{fastcall},
);
170 171

sub build_types {
172 173
	my $mods = "(?x:  \n" . join("|\n  ", @modifierList) . "\n)";
	my $all = "(?x:  \n" . join("|\n  ", @typeList) . "\n)";
174
	$Modifier	= qr{(?:$Attribute|$Sparse|$mods)};
175
	$NonptrType	= qr{
176
			(?:$Modifier\s+|const\s+)*
177
			(?:
178 179
				(?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
				(?:${all}\b)
180
			)
181
			(?:\s+$Modifier|\s+const)*
182 183
		  }x;
	$Type	= qr{
184
			$NonptrType
185
			(?:\s*\*+\s*const|\s*\*+|(?:\s*\[\s*\])+)?
186
			(?:\s+$Inline|\s+$Modifier)*
187 188 189 190
		  }x;
	$Declare	= qr{(?:$Storage\s+)?$Type};
}
build_types();
191 192 193

$chk_signoff = 0 if ($file);

194 195
my @dep_includes = ();
my @dep_functions = ();
196 197 198 199
my $removal = "Documentation/feature-removal-schedule.txt";
if ($tree && -f "$root/$removal") {
	open(REMOVE, "<$root/$removal") ||
				die "$P: $removal: open failed - $!\n";
200
	while (<REMOVE>) {
201 202 203
		if (/^Check:\s+(.*\S)/) {
			for my $entry (split(/[, ]+/, $1)) {
				if ($entry =~ m@include/(.*)@) {
204 205
					push(@dep_includes, $1);

206 207 208
				} elsif ($entry !~ m@/@) {
					push(@dep_functions, $entry);
				}
209
			}
210 211 212 213
		}
	}
}

214
my @rawlines = ();
215 216
my @lines = ();
my $vname;
217 218 219 220 221 222 223
for my $filename (@ARGV) {
	if ($file) {
		open(FILE, "diff -u /dev/null $filename|") ||
			die "$P: $filename: diff failed - $!\n";
	} else {
		open(FILE, "<$filename") ||
			die "$P: $filename: open failed - $!\n";
224
	}
225 226 227 228 229
	if ($filename eq '-') {
		$vname = 'Your patch';
	} else {
		$vname = $filename;
	}
230 231 232 233 234
	while (<FILE>) {
		chomp;
		push(@rawlines, $_);
	}
	close(FILE);
235
	if (!process($filename)) {
236 237 238
		$exit = 1;
	}
	@rawlines = ();
239
	@lines = ();
240 241 242 243 244
}

exit($exit);

sub top_of_kernel_tree {
245 246 247 248 249 250 251 252 253 254 255 256
	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;
		}
257
	}
258
	return 1;
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
}

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;
}
281
sub copy_spacing {
282
	(my $res = shift) =~ tr/\t/ /c;
283 284
	return $res;
}
285

286 287 288 289 290 291 292 293 294 295 296 297 298
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));
}

299 300 301 302 303 304 305 306 307 308 309
my $sanitise_quote = '';

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

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
310 311 312 313 314 315
sub sanitise_line {
	my ($line) = @_;

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

316
	my $qlen = 0;
317 318
	my $off = 0;
	my $c;
319

320 321 322 323 324 325 326 327 328 329 330 331 332 333
	# 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;
334
		}
335
		if (substr($line, $off, 2) eq '*/') {
336 337 338 339
			$sanitise_quote = '';
			substr($res, $off, 2, "$;$;");
			$off++;
			next;
340
		}
341 342 343 344 345 346 347

		# 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;
348
		}
349 350 351 352
		# Regular quotes.
		if ($c eq "'" || $c eq '"') {
			if ($sanitise_quote eq '') {
				$sanitise_quote = $c;
353

354 355 356 357 358 359
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
360

361 362 363 364 365 366 367 368
		#print "SQ:$sanitise_quote\n";
		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
			substr($res, $off, 1, $;);
		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
			substr($res, $off, 1, 'X');
		} else {
			substr($res, $off, 1, $c);
		}
369 370 371
	}

	# The pathname on a #include may be surrounded by '<' and '>'.
372
	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
373 374 375 376
		my $clean = 'X' x length($1);
		$res =~ s@\<.*\>@<$clean>@;

	# The whole of a #error is a string.
377
	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
378
		my $clean = 'X' x length($1);
379
		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
380 381
	}

382 383 384
	return $res;
}

385 386 387 388 389 390
sub ctx_statement_block {
	my ($linenr, $remain, $off) = @_;
	my $line = $linenr - 1;
	my $blk = '';
	my $soff = $off;
	my $coff = $off - 1;
391
	my $coff_set = 0;
392

393 394
	my $loff = 0;

395 396
	my $type = '';
	my $level = 0;
397
	my $p;
398 399
	my $c;
	my $len = 0;
400 401

	my $remainder;
402
	while (1) {
403
		#warn "CSB: blk<$blk> remain<$remain>\n";
404 405 406 407
		# If we are about to drop off the end, pull in more
		# context.
		if ($off >= $len) {
			for (; $remain > 0; $line++) {
408
				next if ($lines[$line] =~ /^-/);
409
				$remain--;
410
				$loff = $len;
411
				$blk .= $lines[$line] . "\n";
412 413 414 415 416 417
				$len = length($blk);
				$line++;
				last;
			}
			# Bail if there is no further context.
			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
418
			if ($off >= $len) {
419 420 421
				last;
			}
		}
422
		$p = $c;
423
		$c = substr($blk, $off, 1);
424
		$remainder = substr($blk, $off);
425

426
		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
427 428 429 430 431 432
		# Statement ends at the ';' or a close '}' at the
		# outermost level.
		if ($level == 0 && $c eq ';') {
			last;
		}

433
		# An else is really a conditional as long as its not else if
434 435 436 437 438 439 440 441
		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";
442 443
		}

444 445 446 447 448 449 450 451 452 453
		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;
454 455
				$coff_set = 1;
				#warn "CSB: mark coff<$coff>\n";
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
			}
		}
		if (($type eq '' || $type eq '{') && $c eq '{') {
			$level++;
			$type = '{';
		}
		if ($type eq '{' && $c eq '}') {
			$level--;
			$type = ($level != 0)? '{' : '';

			if ($level == 0) {
				last;
			}
		}
		$off++;
	}
472
	# We are truly at the end, so shuffle to the next line.
473
	if ($off == $len) {
474
		$loff = $len + 1;
475 476 477
		$line++;
		$remain--;
	}
478 479 480 481 482 483 484

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

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

485
	#print "coff<$coff> soff<$off> loff<$loff>\n";
486 487 488 489 490

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

491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
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;
	}
}

534 535 536 537 538 539
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

540
	# Grab the first conditional/block pair.
541 542
	($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
543
	#print "F: c<$condition> s<$statement> remain<$remain>\n";
544 545 546 547 548 549 550
	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.
551 552 553
	for (;;) {
		($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
554
		#print "C: c<$condition> s<$statement> remain<$remain>\n";
555
		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
556 557
		#print "C: push\n";
		push(@chunks, [ $condition, $statement ]);
558 559 560
	}

	return ($level, $linenr, @chunks);
561 562
}

563
sub ctx_block_get {
564
	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
565 566 567 568 569 570 571
	my $line;
	my $start = $linenr - 1;
	my $blk = '';
	my @o;
	my @c;
	my @res = ();

572
	my $level = 0;
573 574 575 576 577
	for ($line = $start; $remain > 0; $line++) {
		next if ($rawlines[$line] =~ /^-/);
		$remain--;

		$blk .= $rawlines[$line];
578 579 580 581 582 583
		foreach my $c (split(//, $rawlines[$line])) {
			##print "C<$c>L<$level><$open$close>O<$off>\n";
			if ($off > 0) {
				$off--;
				next;
			}
584

585 586 587 588 589 590 591
			if ($c eq $close && $level > 0) {
				$level--;
				last if ($level == 0);
			} elsif ($c eq $open) {
				$level++;
			}
		}
592

593
		if (!$outer || $level <= 1) {
594
			push(@res, $rawlines[$line]);
595 596
		}

597
		last if ($level == 0);
598 599
	}

600
	return ($level, @res);
601 602 603 604
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

605 606
	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
	return @r;
607 608 609 610
}
sub ctx_block {
	my ($linenr, $remain) = @_;

611 612
	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
	return @r;
613 614
}
sub ctx_statement {
615 616 617 618 619 620
	my ($linenr, $remain, $off) = @_;

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

623
	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
624
}
625 626 627 628 629
sub ctx_statement_level {
	my ($linenr, $remain, $off) = @_;

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
630 631 632 633 634

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

	# Catch a comment on the end of the line itself.
635
	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
636 637 638 639 640 641 642
	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++) {
643 644
		my $line = $rawlines[$linenr - 1];
		#warn "           $line\n";
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
		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);

667
	##print "LINE: $rawlines[$end_line - 1 ]\n";
668 669 670 671 672
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

673 674 675
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
676

677 678 679 680 681 682
	$res = '';
	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
		$res .= $1;
		if ($2 ne '') {
			$coded = sprintf("^%c", unpack('C', $2) + 64);
			$res .= $coded;
683 684
		}
	}
685
	$res =~ s/$/\$/;
686

687
	return $res;
688 689
}

690
my $av_preprocessor = 0;
691
my $av_pending;
692
my @av_paren_type;
693
my $av_pend_colon;
694 695 696

sub annotate_reset {
	$av_preprocessor = 0;
697 698
	$av_pending = '_';
	@av_paren_type = ('E');
699
	$av_pend_colon = 'O';
700 701
}

702 703
sub annotate_values {
	my ($stream, $type) = @_;
704

705
	my $res;
706
	my $var = '_' x length($stream);
707 708
	my $cur = $stream;

709
	print "$stream\n" if ($dbg_values > 1);
710 711

	while (length($cur)) {
712
		@av_paren_type = ('E') if ($#av_paren_type < 0);
713
		print " <" . join('', @av_paren_type) .
714
				"> <$type> <$av_pending>" if ($dbg_values > 1);
715
		if ($cur =~ /^(\s+)/o) {
716 717
			print "WS($1)\n" if ($dbg_values > 1);
			if ($1 =~ /\n/ && $av_preprocessor) {
718
				$type = pop(@av_paren_type);
719
				$av_preprocessor = 0;
720 721
			}

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

726 727 728 729
		} elsif ($cur =~ /^($Modifier)\s*/) {
			print "MODIFIER($1)\n" if ($dbg_values > 1);
			$type = 'T';

730
		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
731
			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
732
			$av_preprocessor = 1;
733 734 735 736 737 738
			push(@av_paren_type, $type);
			if ($2 ne '') {
				$av_pending = 'N';
			}
			$type = 'E';

739
		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
740 741 742
			print "UNDEF($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;
			push(@av_paren_type, $type);
743

744
		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
745
			print "PRE_START($1)\n" if ($dbg_values > 1);
746
			$av_preprocessor = 1;
747 748 749

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
750
			$type = 'E';
751

752
		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
753 754 755 756 757
			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;

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

758
			$type = 'E';
759

760
		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
761 762 763 764 765 766 767 768
			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);
769
			$type = 'E';
770 771

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

774 775 776 777 778
		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
			print "ATTR($1)\n" if ($dbg_values > 1);
			$av_pending = $type;
			$type = 'N';

779
		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
780
			print "SIZEOF($1)\n" if ($dbg_values > 1);
781
			if (defined $2) {
782
				$av_pending = 'V';
783 784 785
			}
			$type = 'N';

786
		} elsif ($cur =~ /^(if|while|for)\b/o) {
787
			print "COND($1)\n" if ($dbg_values > 1);
788
			$av_pending = 'E';
789 790
			$type = 'N';

791 792 793 794 795
		} elsif ($cur =~/^(case)/o) {
			print "CASE($1)\n" if ($dbg_values > 1);
			$av_pend_colon = 'C';
			$type = 'N';

796
		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
797
			print "KEYWORD($1)\n" if ($dbg_values > 1);
798 799 800
			$type = 'N';

		} elsif ($cur =~ /^(\()/o) {
801
			print "PAREN('$1')\n" if ($dbg_values > 1);
802 803
			push(@av_paren_type, $av_pending);
			$av_pending = '_';
804 805 806
			$type = 'N';

		} elsif ($cur =~ /^(\))/o) {
807 808 809
			my $new_type = pop(@av_paren_type);
			if ($new_type ne '_') {
				$type = $new_type;
810 811
				print "PAREN('$1') -> $type\n"
							if ($dbg_values > 1);
812
			} else {
813
				print "PAREN('$1')\n" if ($dbg_values > 1);
814 815
			}

816
		} elsif ($cur =~ /^($Ident)\s*\(/o) {
817
			print "FUNC($1)\n" if ($dbg_values > 1);
818
			$type = 'V';
819
			$av_pending = 'V';
820

821 822 823 824 825 826 827 828 829
		} elsif ($cur =~ /^($Ident\s*):/) {
			if ($type eq 'E') {
				$av_pend_colon = 'L';
			} elsif ($type eq 'T') {
				$av_pend_colon = 'B';
			}
			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
			$type = 'V';

830
		} elsif ($cur =~ /^($Ident|$Constant)/o) {
831
			print "IDENT($1)\n" if ($dbg_values > 1);
832 833 834
			$type = 'V';

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

838
		} elsif ($cur =~/^(;|{|})/) {
839
			print "END($1)\n" if ($dbg_values > 1);
840
			$type = 'E';
841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856
			$av_pend_colon = 'O';

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

858
		} elsif ($cur =~ /^(;|\[)/o) {
859
			print "CLOSE($1)\n" if ($dbg_values > 1);
860 861
			$type = 'N';

862
		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
863 864 865 866 867 868 869 870 871 872 873 874
			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';

875
		} elsif ($cur =~ /^($Operators)/o) {
876
			print "OP($1)\n" if ($dbg_values > 1);
877 878 879 880 881
			if ($1 ne '++' && $1 ne '--') {
				$type = 'N';
			}

		} elsif ($cur =~ /(^.)/o) {
882
			print "C($1)\n" if ($dbg_values > 1);
883 884 885 886 887
		}
		if (defined $1) {
			$cur = substr($cur, length($1));
			$res .= $type x length($1);
		}
888
	}
889

890
	return ($res, $var);
891 892
}

893
sub possible {
894
	my ($possible, $line) = @_;
895

896
	print "CHECK<$possible> ($line)\n" if ($dbg_possible > 1);
897
	if ($possible !~ /^(?:$Modifier|$Storage|$Type|DEFINE_\S+)$/ &&
898 899
	    $possible ne 'goto' && $possible ne 'return' &&
	    $possible ne 'case' && $possible ne 'else' &&
900
	    $possible ne 'asm' && $possible ne '__asm__' &&
901 902 903 904 905 906 907 908
	    $possible !~ /^(typedef|struct|enum)\b/) {
		# 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;
909 910 911 912
			for my $modifier (split(' ', $possible)) {
				warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
				push(@modifierList, $modifier);
			}
913 914 915 916 917

		} else {
			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
			push(@typeList, $possible);
		}
918 919 920 921
		build_types();
	}
}

922 923
my $prefix = '';

924
sub report {
925 926 927
	if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
		return 0;
	}
928 929 930 931
	my $line = $prefix . $_[0];

	$line = (split('\n', $line))[0] . "\n" if ($terse);

932
	push(our @report, $line);
933 934

	return 1;
935 936
}
sub report_dump {
937
	our @report;
938
}
939
sub ERROR {
940 941 942 943
	if (report("ERROR: $_[0]\n")) {
		our $clean = 0;
		our $cnt_error++;
	}
944 945
}
sub WARN {
946 947 948 949
	if (report("WARNING: $_[0]\n")) {
		our $clean = 0;
		our $cnt_warn++;
	}
950 951
}
sub CHK {
952
	if ($check && report("CHECK: $_[0]\n")) {
953 954 955
		our $clean = 0;
		our $cnt_chk++;
	}
956 957
}

958 959 960 961 962
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
963
	my $prevrawline="";
964
	my $stashline="";
965
	my $stashrawline="";
966

967
	my $length;
968 969 970 971
	my $indent;
	my $previndent=0;
	my $stashindent=0;

972
	our $clean = 1;
973 974 975
	my $signoff = 0;
	my $is_patch = 0;

976
	our @report = ();
977 978 979 980 981
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

982 983 984 985 986 987
	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
	my $in_comment = 0;
988
	my $comment_edge = 0;
989 990
	my $first_line = 0;

991 992 993
	my $prev_values = 'E';

	# suppression flags
994
	my %suppress_ifbraces;
995

996
	# Pre-scan the patch sanitizing the lines.
997
	# Pre-scan the patch looking for any __setup documentation.
998
	#
999 1000
	my @setup_docs = ();
	my $setup_docs = 0;
1001 1002

	sanitise_line_reset();
1003 1004
	my $line;
	foreach my $rawline (@rawlines) {
1005 1006
		$linenr++;
		$line = $rawline;
1007

1008
		if ($rawline=~/^\+\+\+\s+(\S+)/) {
1009 1010 1011 1012
			$setup_docs = 0;
			if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
				$setup_docs = 1;
			}
1013 1014 1015 1016 1017 1018 1019 1020 1021
			#next;
		}
		if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1022
			$in_comment = 0;
1023 1024 1025 1026 1027 1028

			# 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;
1029
			for (my $ln = $linenr + 1; $ln < ($linenr + $realcnt); $ln++) {
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049
				next if ($line =~ /^-/);
				($edge) = ($rawlines[$ln - 1] =~ m@(/\*|\*/)@);
				last if (defined $edge);
			}
			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 &&
			    $rawlines[$linenr] =~ m@^.\s* \*(?:\s|$)@)
			{
				$in_comment = 1;
			}

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

1050
		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1051
			# Standardise the strings and chars within the input to
1052
			# simplify matching -- only bother with positive lines.
1053
			$line = sanitise_line($rawline);
1054
		}
1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
		push(@lines, $line);

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

		#print "==>$rawline\n";
		#print "-->$line\n";
1065 1066 1067 1068 1069 1070

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

1071 1072
	$prefix = '';

1073 1074
	$realcnt = 0;
	$linenr = 0;
1075 1076 1077
	foreach my $line (@lines) {
		$linenr++;

1078
		my $rawline = $rawlines[$linenr - 1];
1079

1080
#extract the line range in the file after the patch is applied
1081
		if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1082
			$is_patch = 1;
1083
			$first_line = $linenr + 1;
1084 1085 1086 1087 1088 1089
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1090
			annotate_reset();
1091 1092
			$prev_values = 'E';

1093
			%suppress_ifbraces = ();
1094 1095
			next;

1096 1097 1098
# 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.
1099
		} elsif ($line =~ /^( |\+|$)/) {
1100
			$realline++;
1101
			$realcnt-- if ($realcnt != 0);
1102

1103
			# Measure the line length and indent.
1104
			($length, $indent) = line_stats($rawline);
1105 1106 1107 1108

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

1111
			#warn "line<$line>\n";
1112

1113 1114
		} elsif ($realcnt == 1) {
			$realcnt--;
1115 1116 1117
		}

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

1121 1122
		$here = "#$linenr: " if (!$file);
		$here = "#$realline: " if ($file);
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134

		# extract the filename as it passes
		if ($line=~/^\+\+\+\s+(\S+)/) {
			$realfile = $1;
			$realfile =~ s@^[^/]*/@@;

			if ($realfile =~ m@include/asm/@) {
				ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
			}
			next;
		}

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

1137 1138 1139
		my $hereline = "$here\n$rawline\n";
		my $herecurr = "$here\n$rawline\n";
		my $hereprev = "$here\n$prevrawline\n$rawline\n";
1140

1141 1142
		$cnt_lines++ if ($realcnt != 0);

1143
#check the patch for a signoff:
1144
		if ($line =~ /^\s*signed-off-by:/i) {
1145 1146
			# This is a signoff, if ugly, so do not double report.
			$signoff++;
1147
			if (!($line =~ /^\s*Signed-off-by:/)) {
1148 1149
				WARN("Signed-off-by: is the preferred form\n" .
					$herecurr);
1150 1151
			}
			if ($line =~ /^\s*signed-off-by:\S/i) {
1152
				WARN("space required after Signed-off-by:\n" .
1153
					$herecurr);
1154 1155 1156
			}
		}

1157
# Check for wrappage within a valid hunk of the file
1158
		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1159
			ERROR("patch seems to be corrupt (line wrapped?)\n" .
1160
				$herecurr) if (!$emitted_corrupt++);
1161 1162 1163 1164
		}

# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1165 1166 1167 1168 1169 1170 1171 1172
		    $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";

			ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1173 1174 1175 1176
		}

#ignore lines being removed
		if ($line=~/^-/) {next;}
1177

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

#trailing whitespace
1182
		if ($line =~ /^\+.*\015/) {
1183
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1184 1185
			ERROR("DOS line endings\n" . $herevet);

1186 1187
		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1188
			ERROR("trailing whitespace\n" . $herevet);
1189 1190
		}
#80 column limit
1191
		if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1192 1193 1194
		    $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
		    $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
		    $length > 80)
1195
		{
1196
			WARN("line over 80 characters\n" . $herecurr);
1197 1198
		}

1199 1200 1201 1202 1203
# check for adding lines without a newline.
		if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
			WARN("adding a line without newline at end of file\n" . $herecurr);
		}

1204 1205 1206 1207 1208
# check we are in a valid source file *.[hc] if not then ignore this hunk
		next if ($realfile !~ /\.[hc]$/);

# at the beginning of a line any tabs must come first and anything
# more than 8 must use tabs.
1209 1210 1211
		if ($rawline =~ /^\+\s* \t\s*\S/ ||
		    $rawline =~ /^\+\s*        \s*/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1212
			ERROR("code indent should use tabs where possible\n" . $herevet);
1213 1214
		}

1215
# check for RCS/CVS revision markers
1216
		if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1217 1218
			WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
		}
1219

1220
# Check for potential 'bare' types
1221
		my ($stat, $cond, $line_nr_next, $remain_next);
1222
		if ($realcnt && $line =~ /.\s*\S/) {
1223 1224
			($stat, $cond, $line_nr_next, $remain_next) =
				ctx_statement_block($linenr, $realcnt, 0);
1225 1226 1227 1228 1229
			$stat =~ s/\n./\n /g;
			$cond =~ s/\n./\n /g;

			my $s = $stat;
			$s =~ s/{.*$//s;
1230

1231
			# Ignore goto labels.
1232
			if ($s =~ /$Ident:\*$/s) {
1233 1234

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

1237
			# declarations always start with types
1238
			} 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) {
1239 1240 1241 1242
				my $type = $1;
				$type =~ s/\s+/ /g;
				possible($type, "A:" . $s);

1243
			# definitions in global scope can only start with types
1244
			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b/s) {
1245
				possible($1, "B:" . $s);
1246
			}
1247 1248

			# any (foo ... *) is a pointer cast, and foo is a type
1249
			while ($s =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/sg) {
1250
				possible($1, "C:" . $s);
1251 1252 1253 1254 1255
			}

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

1259
				my $ctx = $s;
1260
				substr($ctx, 0, $name_len + 1, '');
1261
				$ctx =~ s/\)[^\)]*$//;
1262

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

1266
						possible($1, "D:" . $s);
1267 1268
					}
				}
1269
			}
1270

1271 1272
		}

1273 1274 1275
#
# Checks which may be anchored in the context.
#
1276

1277 1278
# Check for switch () and associated case and default
# statements should be at the same indent.
1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294
		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 '') {
1295
				ERROR("switch and case should be at the same indent\n$hereline$err");
1296 1297
			}
		}
1298
		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
1299 1300 1301 1302 1303
		    $line !~ /\G(?:
			(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
			\s*return\s+
		    )/xg)
		{
1304 1305
			ERROR("trailing statements should be on next line\n" . $herecurr);
		}
1306 1307 1308

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

1312
			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
1313 1314 1315
			my $ctx_cnt = $realcnt - $#ctx - 1;
			my $ctx = join("\n", @ctx);

1316 1317
			my $ctx_ln = $linenr;
			my $ctx_skip = $realcnt;
1318

1319 1320 1321 1322 1323
			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] !~ /^-/);
1324 1325
				$ctx_ln++;
			}
1326

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

1330 1331
			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
				ERROR("that open brace { should be on the previous line\n" .
1332
					"$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1333
			}
1334 1335 1336 1337
			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
			    $ctx =~ /\)\s*\;\s*$/ &&
			    defined $lines[$ctx_ln - 1])
			{
1338 1339
				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
				if ($nindent > $indent) {
1340
					WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
1341
						"$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1342 1343
				}
			}
1344 1345
		}

1346 1347
		# Track the 'values' across context and added lines.
		my $opline = $line; $opline =~ s/^./ /;
1348 1349
		my ($curr_values, $curr_vars) =
				annotate_values($opline . "\n", $prev_values);
1350
		$curr_values = $prev_values . $curr_values;
1351 1352
		if ($dbg_values) {
			my $outline = $opline; $outline =~ s/\t/ /g;
1353 1354
			print "$linenr > .$outline\n";
			print "$linenr > $curr_values\n";
1355
			print "$linenr >  $curr_vars\n";
1356
		}
1357 1358
		$prev_values = substr($curr_values, -1);

1359 1360 1361
#ignore lines not being added
		if ($line=~/^[^\+]/) {next;}

1362
# TEST: allow direct testing of the type matcher.
1363 1364 1365 1366 1367 1368
		if ($dbg_type) {
			if ($line =~ /^.\s*$Declare\s*$/) {
				ERROR("TEST: is type\n" . $herecurr);
			} elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
				ERROR("TEST: is not type ($1 is)\n". $herecurr);
			}
1369 1370
			next;
		}
1371 1372 1373 1374 1375 1376 1377 1378 1379
# TEST: allow direct testing of the attribute matcher.
		if ($dbg_attr) {
			if ($line =~ /^.\s*$Attribute\s*$/) {
				ERROR("TEST: is attr\n" . $herecurr);
			} elsif ($dbg_attr > 1 && $line =~ /^.+($Attribute)/) {
				ERROR("TEST: is not attr ($1 is)\n". $herecurr);
			}
			next;
		}
1380

1381 1382 1383
# check for initialisation to aggregates open brace on the next line
		if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
		    $line =~ /^.\s*{/) {
1384
			ERROR("that open brace { should be on the previous line\n" . $hereprev);
1385 1386
		}

1387 1388 1389 1390 1391
#
# Checks which are anchored on the added line.
#

# check for malformed paths in #include statements (uses RAW line)
1392
		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
1393 1394
			my $path = $1;
			if ($path =~ m{//}) {
1395 1396
				ERROR("malformed #include filename\n" .
					$herecurr);
1397 1398
			}
		}
1399

1400
# no C99 // comments
1401
		if ($line =~ m{//}) {
1402
			ERROR("do not use C99 // comments\n" . $herecurr);
1403
		}
1404
		# Remove C99 comments.
1405
		$line =~ s@//.*@@;
1406
		$opline =~ s@//.*@@;
1407 1408

#EXPORT_SYMBOL should immediately follow its function closing }.
1409 1410 1411
		if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
		    ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
			my $name = $1;
1412 1413
			if (($prevline !~ /^}/) &&
			   ($prevline !~ /^\+}/) &&
1414
			   ($prevline !~ /^ }/) &&
1415 1416
			   ($prevline !~ /^.DECLARE_$Ident\(\Q$name\E\)/) &&
			   ($prevline !~ /^.LIST_HEAD\(\Q$name\E\)/) &&
1417
			   ($prevline !~ /^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(/) &&
1418
			   ($prevline !~ /\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)/)) {
1419
				WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
1420 1421 1422
			}
		}

1423
# check for external initialisers.
1424
		if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
1425 1426 1427
			ERROR("do not initialise externals to 0 or NULL\n" .
				$herecurr);
		}
1428
# check for static initialisers.
1429
		if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) {
1430 1431
			ERROR("do not initialise statics to 0 or NULL\n" .
				$herecurr);
1432 1433
		}

1434 1435 1436
# check for new typedefs, only function parameters and sparse annotations
# make sense.
		if ($line =~ /\btypedef\s/ &&
1437
		    $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ &&
1438
		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
1439
		    $line !~ /\b__bitwise(?:__|)\b/) {
1440
			WARN("do not add new typedefs\n" . $herecurr);
1441 1442 1443
		}

# * goes on variable not on type
1444
		if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) {
1445 1446
			ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" .
				$herecurr);
1447 1448

		} elsif ($line =~ m{\($NonptrType\s+(\*+)(?!\s+const)\s+\)}) {
1449 1450
			ERROR("\"(foo $1 )\" should be \"(foo $1)\"\n" .
				$herecurr);
1451

1452
		} elsif ($line =~ m{\b$NonptrType(\*+)(?:\s+(?:$Attribute|$Sparse))?\s+[A-Za-z\d_]+}) {
1453 1454
			ERROR("\"foo$1 bar\" should be \"foo $1bar\"\n" .
				$herecurr);
1455

1456
		} elsif ($line =~ m{\b$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) {
1457 1458
			ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" .
				$herecurr);
1459 1460 1461 1462 1463 1464 1465 1466 1467
		}

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

1468
		if ($line =~ /\bLINUX_VERSION_CODE\b/) {
1469
			WARN("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
1470 1471
		}

1472 1473 1474 1475 1476
# 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
# printk includes all preceeding printk's which have no newline on the end.
# we assume the first bad printk is the one to report.
1477
		if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490
			my $ok = 0;
			for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
				#print "CHECK<$lines[$ln - 1]\n";
				# we have a preceeding printk if it ends
				# 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) {
1491
				WARN("printk() should include KERN_ facility level\n" . $herecurr);
1492
			}
1493 1494
		}

1495 1496
# function brace can't be on same line, except for #defines of do while,
# or if closed on same line
1497 1498
		if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
		    !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
1499
			ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
1500
		}
1501

1502 1503 1504 1505 1506 1507
# 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*$/) {
			ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
		}

1508 1509
# check for spacing round square brackets; allowed:
#  1. with a type on the left -- int [] a;
1510 1511
#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
#  3. inside a curly brace -- = { [0...10] = 5 }
1512 1513 1514
		while ($line =~ /(.*?\s)\[/g) {
			my ($where, $prefix) = ($-[1], $1);
			if ($prefix !~ /$Type\s+$/ &&
1515 1516
			    ($where != 0 || $prefix !~ /^.\s+$/) &&
			    $prefix !~ /{\s+$/) {
1517 1518 1519 1520
				ERROR("space prohibited before open square bracket '['\n" . $herecurr);
			}
		}

1521
# check for spaces between functions and their parentheses.
1522
		while ($line =~ /($Ident)\s+\(/g) {
1523
			my $name = $1;
1524 1525
			my $ctx_before = substr($line, 0, $-[1]);
			my $ctx = "$ctx_before$name";
1526 1527

			# Ignore those directives where spaces _are_ permitted.
1528 1529 1530 1531 1532 1533
			if ($name =~ /^(?:
				if|for|while|switch|return|case|
				volatile|__volatile__|
				__attribute__|format|__extension__|
				asm|__asm__)$/x)
			{
1534 1535 1536 1537

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

			# cpp #elif statement condition may start with a (
1541
			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
1542 1543 1544

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

			} else {
1548
				WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
1549
			}
1550
		}
1551
# Check operator spacing.
1552
		if (!($line=~/\#\s*include/)) {
1553 1554 1555 1556
			my $ops = qr{
				<<=|>>=|<=|>=|==|!=|
				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
				=>|->|<<|>>|<|>|=|!|~|
1557 1558
				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
				\?|:
1559
			}x;
1560
			my @elements = split(/($ops|;)/, $opline);
1561
			my $off = 0;
1562 1563 1564

			my $blank = copy_spacing($opline);

1565
			for (my $n = 0; $n < $#elements; $n += 2) {
1566 1567
				$off += length($elements[$n]);

1568 1569 1570 1571 1572 1573 1574 1575
				# Pick up the preceeding and succeeding characters.
				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";

1576 1577 1578
				my $a = '';
				$a = 'V' if ($elements[$n] ne '');
				$a = 'W' if ($elements[$n] =~ /\s$/);
1579
				$a = 'C' if ($elements[$n] =~ /$;$/);
1580 1581
				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
				$a = 'O' if ($elements[$n] eq '');
1582
				$a = 'E' if ($ca =~ /^\s*$/);
1583

1584
				my $op = $elements[$n + 1];
1585 1586

				my $c = '';
1587
				if (defined $elements[$n + 2]) {
1588 1589
					$c = 'V' if ($elements[$n + 2] ne '');
					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
1590
					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
1591 1592
					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
					$c = 'O' if ($elements[$n + 2] eq '');
1593
					$c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
1594 1595
				} else {
					$c = 'E';
1596 1597
				}

1598 1599 1600 1601
				my $ctx = "${a}x${c}";

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

1602
				my $ptr = substr($blank, 0, $off) . "^";
1603
				my $hereptr = "$hereline$ptr\n";
1604

1605
				# Pull out the value of this operator.
1606
				my $op_type = substr($curr_values, $off + 1, 1);
1607

1608 1609 1610
				# Get the full operator variant.
				my $opv = $op . substr($curr_vars, $off, 1);

1611 1612 1613 1614
				# Ignore operators passed as parameters.
				if ($op_type ne 'V' &&
				    $ca =~ /\s$/ && $cc =~ /^\s*,/) {

1615 1616
#				# Ignore comments
#				} elsif ($op =~ /^$;+$/) {
1617

1618
				# ; should have either the end of line or a space or \ after it
1619
				} elsif ($op eq ';') {
1620 1621
					if ($ctx !~ /.x[WEBC]/ &&
					    $cc !~ /^\\/ && $cc !~ /^;/) {
1622
						ERROR("space required after that '$op' $at\n" . $hereptr);
1623 1624 1625 1626
					}

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

1628 1629 1630 1631
				# No spaces for:
				#   ->
				#   :   when part of a bitfield
				} elsif ($op eq '->' || $opv eq ':B') {
1632
					if ($ctx =~ /Wx.|.xW/) {
1633
						ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
1634 1635 1636 1637
					}

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

1642
				# '*' as part of a type definition -- reported already.
1643
				} elsif ($opv eq '*_') {
1644 1645 1646 1647 1648 1649
					#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 '~' ||
1650
					 $opv eq '*U' || $opv eq '-U' ||
1651
					 $opv eq '&U' || $opv eq '&&U') {
1652
					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
1653
						ERROR("space required before that '$op' $at\n" . $hereptr);
1654
					}
1655
					if ($op eq '*' && $cc =~/\s*const\b/) {
1656 1657 1658
						# A unary '*' may be const

					} elsif ($ctx =~ /.xW/) {
1659
						ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1660 1661 1662 1663
					}

				# unary ++ and unary -- are allowed no space on one side.
				} elsif ($op eq '++' or $op eq '--') {
1664 1665 1666 1667 1668 1669
					if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
						ERROR("space required one side of that '$op' $at\n" . $hereptr);
					}
					if ($ctx =~ /Wx[BE]/ ||
					    ($ctx =~ /Wx./ && $cc =~ /^;/)) {
						ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1670
					}
1671 1672
					if ($ctx =~ /ExW/) {
						ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1673
					}
1674

1675

1676
				# << and >> may either have or not have spaces both sides
1677 1678 1679
				} elsif ($op eq '<<' or $op eq '>>' or
					 $op eq '&' or $op eq '^' or $op eq '|' or
					 $op eq '+' or $op eq '-' or
1680 1681
					 $op eq '*' or $op eq '/' or
					 $op eq '%')
1682
				{
1683
					if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
1684 1685
						ERROR("need consistent spacing around '$op' $at\n" .
							$hereptr);
1686 1687
					}

1688 1689 1690 1691 1692 1693 1694
				# 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./) {
						ERROR("space prohibited before that '$op' $at\n" . $hereptr);
					}

1695
				# All the others need spaces both sides.
1696
				} elsif ($ctx !~ /[EWC]x[CWE]/) {
1697 1698
					my $ok = 0;

1699
					# Ignore email addresses <foo@bar>
1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714
					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) {
1715
						ERROR("spaces required around that '$op' $at\n" . $hereptr);
1716
					}
1717
				}
1718
				$off += length($elements[$n + 1]);
1719 1720 1721
			}
		}

1722 1723
# check for multiple assignments
		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
1724
			CHK("multiple assignments should be avoided\n" . $herecurr);
1725 1726
		}

1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740
## # 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 =~ /,/) {
## 				WARN("declaring multiple variables together should be avoided\n" . $herecurr);
## 			}
## 		}
1741

1742
#need space before brace following if, while, etc
1743 1744
		if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
		    $line =~ /do{/) {
1745
			ERROR("space required before the open brace '{'\n" . $herecurr);
1746 1747 1748 1749 1750
		}

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

1754 1755
# check spacing on square brackets
		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
1756
			ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
1757 1758
		}
		if ($line =~ /\s\]/) {
1759
			ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
1760 1761
		}

1762
# check spacing on parentheses
1763 1764
		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
		    $line !~ /for\s*\(\s+;/) {
1765
			ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
1766
		}
1767
		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
1768 1769
		    $line !~ /for\s*\(.*;\s+\)/ &&
		    $line !~ /:\s+\)/) {
1770
			ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
1771 1772
		}

1773
#goto labels aren't indented, allow a single space however
1774
		if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
1775
		   !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
1776
			WARN("labels should not be indented\n" . $herecurr);
1777 1778
		}

1779 1780 1781 1782 1783 1784
# Return is not a function.
		if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
			my $spacing = $1;
			my $value = $2;

			# Flatten any parentheses and braces
1785
			$value =~ s/\)\(/\) \(/g;
1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796
			while ($value =~ s/\([^\(\)]*\)/1/) {
			}

			if ($value =~ /^(?:$Ident|-?$Constant)$/) {
				ERROR("return is not a function, parentheses are not required\n" . $herecurr);

			} elsif ($spacing !~ /\s+/) {
				ERROR("space required before the open parenthesis '('\n" . $herecurr);
			}
		}

1797
# Need a space before open parenthesis after if, while etc
1798
		if ($line=~/\b(if|while|for|switch)\(/) {
1799
			ERROR("space required before the open parenthesis '('\n" . $herecurr);
1800 1801
		}

1802 1803
# Check for illegal assignment in if conditional -- and check for trailing
# statements after the conditional.
1804
		if ($line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
1805
			my ($s, $c) = ($stat, $cond);
1806 1807

			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
1808
				ERROR("do not use assignment in if condition\n" . $herecurr);
1809 1810 1811 1812
			}

			# Find out what is on the end of the line after the
			# conditional.
1813
			substr($s, 0, length($c), '');
1814
			$s =~ s/\n.*//g;
1815
			$s =~ s/$;//g; 	# Remove any comments
1816 1817
			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
			    $c !~ /}\s*while\s*/)
1818
			{
1819 1820 1821 1822
				ERROR("trailing statements should be on next line\n" . $herecurr);
			}
		}

1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862
# Check relative indent for conditionals and blocks.
		if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
			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;

			# 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;
			}
			if ($s =~ s/^\s*\n//) {
				$check = 1;
			}

			# Also ignore a loop construct at the end of a
			# preprocessor statement.
			if (($prevline =~ /^.\s*#\s*define\s/ ||
			    $prevline =~ /\\\s*$/) && $continuation == 0) {
				$check = 0;
			}

			# Ignore the current line if its is a preprocessor
			# line.
			if ($s =~ /^\s*#\s*/) {
				$check = 0;
			}

1863 1864 1865 1866 1867
			# Ignore the current line if it is label.
			if ($s =~ /^\s*$Ident\s*:/) {
				$check = 0;
			}

1868 1869 1870 1871 1872 1873 1874 1875 1876 1877
			my (undef, $sindent) = line_stats("+" . $s);

			##print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s>\n";

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

1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892
# Check for bitwise tests written as boolean
		if ($line =~ /
			(?:
				(?:\[|\(|\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\|)
			|
				(?:\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\||\)|\])
			)/x)
		{
			WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
		}

1893
# if and else should not have general statements after it
1894 1895 1896 1897 1898 1899
		if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
			my $s = $1;
			$s =~ s/$;//g; 	# Remove any comments
			if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
				ERROR("trailing statements should be on next line\n" . $herecurr);
			}
1900 1901 1902 1903 1904 1905
		}

		# 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) {
1906
			ERROR("else should follow close brace '}'\n" . $hereprev);
1907 1908
		}

1909 1910 1911 1912 1913 1914
		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.
1915
			substr($s, 0, length($c), '');
1916 1917 1918 1919 1920 1921 1922
			$s =~ s/\n.*//g;

			if ($s =~ /^\s*;/) {
				ERROR("while should follow close brace '}'\n" . $hereprev);
			}
		}

1923 1924 1925 1926 1927 1928 1929 1930
#studly caps, commented out until figure out how to distinguish between use of existing and adding new
#		if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
#		    print "No studly caps, use _\n";
#		    print "$herecurr";
#		    $clean = 0;
#		}

#no spaces allowed after \ in define
1931
		if ($line=~/\#\s*define.*\\\s$/) {
1932
			WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
1933 1934
		}

1935
#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
1936 1937 1938 1939 1940
		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
			my $checkfile = "include/linux/$1.h";
			if (-f "$root/$checkfile" && $realfile ne $checkfile &&
			    $1 ne 'irq')
			{
1941
				WARN("Use #include <linux/$1.h> instead of <asm/$1.h>\n" .
1942
					$herecurr);
1943 1944 1945
			}
		}

1946 1947
# 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
1948
# in a known good container
1949 1950
		if ($realfile !~ m@/vmlinux.lds.h$@ &&
		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
1951 1952
			my $ln = $linenr;
			my $cnt = $realcnt;
1953 1954
			my ($off, $dstat, $dcond, $rest);
			my $ctx = '';
1955

1956 1957 1958 1959 1960 1961 1962 1963
			my $args = defined($1);

			# Find the end of the macro and limit our statement
			# search to that.
			while ($cnt > 0 && defined $lines[$ln - 1] &&
				$lines[$ln - 1] =~ /^(?:-|..*\\$)/)
			{
				$ctx .= $rawlines[$ln - 1] . "\n";
1964
				$cnt-- if ($lines[$ln - 1] !~ /^-/);
1965 1966 1967 1968 1969 1970 1971
				$ln++;
			}
			$ctx .= $rawlines[$ln - 1];

			($dstat, $dcond, $ln, $cnt, $off) =
				ctx_statement_block($linenr, $ln - $linenr + 1, 0);
			#print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
1972
			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
1973 1974 1975 1976

			# Extract the remainder of the define (if any) and
			# rip off surrounding spaces, and trailing \'s.
			$rest = '';
1977 1978 1979 1980 1981 1982
			while ($off != 0 || ($cnt > 0 && $rest =~ /(?:^|\\)\s*$/)) {
				#print "ADDING $off <" . substr($lines[$ln - 1], $off) . ">\n";
				if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
					$rest .= substr($lines[$ln - 1], $off) . "\n";
					$cnt--;
				}
1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994
				$ln++;
				$off = 0;
			}
			$rest =~ s/\\\n.//g;
			$rest =~ s/^\s*//s;
			$rest =~ s/\s*$//s;

			# Clean up the original statement.
			if ($args) {
				substr($dstat, 0, length($dcond), '');
			} else {
				$dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
1995
			}
1996
			$dstat =~ s/$;//g;
1997 1998 1999
			$dstat =~ s/\\\n.//g;
			$dstat =~ s/^\s*//s;
			$dstat =~ s/\s*$//s;
2000

2001 2002 2003 2004
			# Flatten any parentheses and braces
			while ($dstat =~ s/\([^\(\)]*\)/1/) {
			}
			while ($dstat =~ s/\{[^\{\}]*\}/1/) {
2005
			}
2006

2007 2008 2009 2010 2011 2012 2013 2014
			my $exceptions = qr{
				$Declare|
				module_param_named|
				MODULE_PARAM_DESC|
				DECLARE_PER_CPU|
				DEFINE_PER_CPU|
				__typeof__\(
			}x;
2015
			#print "REST<$rest>\n";
2016 2017 2018 2019
			if ($rest ne '') {
				if ($rest !~ /while\s*\(/ &&
				    $dstat !~ /$exceptions/)
				{
2020
					ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
2021 2022 2023 2024 2025 2026 2027 2028
				}

			} elsif ($ctx !~ /;/) {
				if ($dstat ne '' &&
				    $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
				    $dstat !~ /$exceptions/ &&
				    $dstat =~ /$Operators/)
				{
2029
					ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
2030
				}
2031
			}
2032 2033
		}

2034
# check for redundant bracing round if etc
2035 2036
		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
			my ($level, $endln, @chunks) =
2037
				ctx_statement_full($linenr, $realcnt, 1);
2038
			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2039 2040
			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
			if ($#chunks > 0 && $level == 0) {
2041 2042
				my $allowed = 0;
				my $seen = 0;
2043
				my $herectx = $here . "\n";
2044
				my $ln = $linenr - 1;
2045 2046 2047
				for my $chunk (@chunks) {
					my ($cond, $block) = @{$chunk};

2048 2049 2050 2051 2052 2053 2054 2055 2056 2057
					# If the condition carries leading newlines, then count those as offsets.
					my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
					my $offset = statement_rawlines($whitespace) - 1;

					#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";
2058 2059
					$ln += statement_rawlines($block) - 1;

2060
					substr($block, 0, length($cond), '');
2061 2062 2063

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

2064 2065 2066
					#print "cond<$cond> block<$block> allowed<$allowed>\n";
					if (statement_lines($cond) > 1) {
						#print "APW: ALLOWED: cond<$cond>\n";
2067 2068 2069
						$allowed = 1;
					}
					if ($block =~/\b(?:if|for|while)\b/) {
2070
						#print "APW: ALLOWED: block<$block>\n";
2071 2072
						$allowed = 1;
					}
2073 2074
					if (statement_block_size($block) > 1) {
						#print "APW: ALLOWED: lines block<$block>\n";
2075 2076 2077 2078
						$allowed = 1;
					}
				}
				if ($seen && !$allowed) {
2079
					WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
2080 2081 2082
				}
			}
		}
2083
		if (!defined $suppress_ifbraces{$linenr - 1} &&
2084
					$line =~ /\b(if|while|for|else)\b/) {
2085 2086 2087 2088 2089 2090 2091
			my $allowed = 0;

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

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

2096 2097
			# Check the condition.
			my ($cond, $block) = @{$chunks[0]};
2098
			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
2099
			if (defined $cond) {
2100
				substr($block, 0, length($cond), '');
2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117
			}
			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) {
2118
					substr($block, 0, length($cond), '');
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130
				}
				if ($block =~ /^\s*\{/) {
					#print "APW: ALLOWED: chunk-1 block<$block>\n";
					$allowed = 1;
				}
			}
			if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
				my $herectx = $here . "\n";;
				my $end = $linenr + statement_rawlines($block) - 1;

				for (my $ln = $linenr - 1; $ln < $end; $ln++) {
					$herectx .= $rawlines[$ln] . "\n";;
2131
				}
2132 2133

				WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
2134 2135 2136
			}
		}

2137
# don't include deprecated include files (uses RAW line)
2138
		for my $inc (@dep_includes) {
2139
			if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
2140
				ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2141 2142 2143
			}
		}

2144 2145
# don't use deprecated functions
		for my $func (@dep_functions) {
2146
			if ($line =~ /\b$func\b/) {
2147
				ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2148 2149 2150 2151
			}
		}

# no volatiles please
2152 2153
		my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
		if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
2154
			WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
2155 2156
		}

2157 2158 2159 2160 2161
# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
		if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
			ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
		}

2162
# warn about #if 0
2163
		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
2164 2165
			CHK("if this code is redundant consider removing it\n" .
				$herecurr);
2166 2167
		}

2168 2169 2170 2171
# check for needless kfree() checks
		if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
			my $expr = $1;
			if ($line =~ /\bkfree\(\Q$expr\E\);/) {
2172
				WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
2173 2174
			}
		}
2175 2176 2177 2178 2179 2180 2181
# check for needless usb_free_urb() checks
		if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
			my $expr = $1;
			if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
				WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
			}
		}
2182

2183
# warn about #ifdefs in C files
2184
#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
2185 2186 2187 2188 2189
#			print "#ifdef in C files should be avoided\n";
#			print "$herecurr";
#			$clean = 0;
#		}

2190
# warn about spacing in #ifdefs
2191
		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
2192 2193 2194
			ERROR("exactly one space required after that #$1\n" . $herecurr);
		}

2195
# check for spinlock_t definitions without a comment.
2196 2197
		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
2198 2199
			my $which = $1;
			if (!ctx_has_comment($first_line, $linenr)) {
2200
				CHK("$1 definition without comment\n" . $herecurr);
2201 2202 2203 2204 2205
			}
		}
# 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)) {
2206
				CHK("memory barrier without comment\n" . $herecurr);
2207 2208 2209
			}
		}
# check of hardware specific defines
2210
		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
2211
			CHK("architecture specific defines should be avoided\n" .  $herecurr);
2212
		}
2213

2214 2215
# check the location of the inline attribute, that it is between
# storage class and type.
2216 2217
		if ($line =~ /\b$Type\s+$Inline\b/ ||
		    $line =~ /\b$Inline\s+$Storage\b/) {
2218 2219 2220
			ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
		}

2221 2222 2223 2224 2225
# Check for __inline__ and __inline, prefer inline
		if ($line =~ /\b(__inline__|__inline)\b/) {
			WARN("plain inline is preferred over $1\n" . $herecurr);
		}

2226
# check for new externs in .c files.
2227
		if ($realfile =~ /\.c$/ && defined $stat &&
2228
		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
2229
		{
2230 2231
			my $function_name = $1;
			my $paren_space = $2;
2232 2233 2234 2235 2236

			my $s = $stat;
			if (defined $cond) {
				substr($s, 0, length($cond), '');
			}
2237 2238 2239
			if ($s =~ /^\s*;/ &&
			    $function_name ne 'uninitialized_var')
			{
2240 2241 2242 2243 2244 2245
				WARN("externs should be avoided in .c files\n" .  $herecurr);
			}

			if ($paren_space =~ /\n/) {
				WARN("arguments for function declarations should follow identifier\n" . $herecurr);
			}
2246 2247 2248 2249 2250

		} elsif ($realfile =~ /\.c$/ && defined $stat &&
		    $stat =~ /^.\s*extern\s+/)
		{
			WARN("externs should be avoided in .c files\n" .  $herecurr);
2251 2252 2253 2254 2255 2256 2257 2258 2259
		}

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

			if (!grep(/$name/, @setup_docs)) {
				CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
			}
2260
		}
2261 2262 2263 2264 2265

# check for pointless casting of kmalloc return
		if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
			WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
		}
2266 2267 2268 2269 2270

# check for gcc specific __FUNCTION__
		if ($line =~ /__FUNCTION__/) {
			WARN("__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr);
		}
2271 2272

# check for semaphores used as mutexes
2273
		if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
2274 2275 2276
			WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
		}
# check for semaphores used as mutexes
2277
		if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
2278 2279 2280 2281 2282 2283
			WARN("consider using a completion\n" . $herecurr);
		}
# recommend strict_strto* over simple_strto*
		if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
			WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
		}
2284 2285 2286 2287
# check for __initcall(), use device_initcall() explicitly please
		if ($line =~ /^.\s*__initcall\s*\(/) {
			WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
		}
2288 2289 2290 2291

# 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/ &&
2292 2293
		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
2294 2295 2296
		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
2297 2298 2299
		{
			WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
		}
2300 2301 2302 2303 2304 2305 2306 2307 2308 2309

# check for %L{u,d,i} in strings
		my $string;
		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
			$string = substr($rawline, $-[1], $+[1] - $-[1]);
			if ($string =~ /(?<!%)%L[udi]/) {
				WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
				last;
			}
		}
2310 2311 2312 2313 2314 2315
	}

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

2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330
	# 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) {
2331
		ERROR("Does not appear to be a unified-diff format patch\n");
2332 2333
	}
	if ($is_patch && $chk_signoff && $signoff == 0) {
2334
		ERROR("Missing Signed-off-by: line(s)\n");
2335 2336
	}

2337
	print report_dump();
2338 2339
	if ($summary && !($clean == 1 && $quiet == 1)) {
		print "$filename " if ($summary_file);
2340 2341 2342 2343
		print "total: $cnt_error errors, $cnt_warn warnings, " .
			(($check)? "$cnt_chk checks, " : "") .
			"$cnt_lines lines checked\n";
		print "\n" if ($quiet == 0);
2344
	}
2345

2346
	if ($clean == 1 && $quiet == 0) {
2347
		print "$vname has no obvious style problems and is ready for submission.\n"
2348 2349
	}
	if ($clean == 0 && $quiet == 0) {
2350
		print "$vname has style problems, please review.  If any of these errors\n";
2351 2352 2353
		print "are false positives report them to the maintainer, see\n";
		print "CHECKPATCH in MAINTAINERS.\n";
	}
2354

2355 2356
	return $clean;
}