checkpatch.pl 53.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

12
my $V = '0.16';
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_type = 0;
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 $root;
30
my %debug;
31
GetOptions(
32
	'q|quiet+'	=> \$quiet,
33 34 35
	'tree!'		=> \$tree,
	'signoff!'	=> \$chk_signoff,
	'patch!'	=> \$chk_patch,
36
	'emacs!'	=> \$emacs,
37
	'terse!'	=> \$terse,
38 39 40 41
	'file!'		=> \$file,
	'subjective!'	=> \$check,
	'strict!'	=> \$check,
	'root=s'	=> \$root,
42 43
	'summary!'	=> \$summary,
	'mailback!'	=> \$mailback,
44 45
	'summary-file!'	=> \$summary_file,

46
	'debug=s'	=> \%debug,
47
	'test-type!'	=> \$tst_type,
48
	'test-only=s'	=> \$tst_only,
49 50 51 52 53
) or exit;

my $exit = 0;

if ($#ARGV < 0) {
54
	print "usage: $P [options] patchfile\n";
55
	print "version: $V\n";
56 57 58 59 60 61 62 63 64
	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";
65 66 67
	exit(1);
}

68 69 70 71 72 73
my $dbg_values = 0;
my $dbg_possible = 0;
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 118 119 120 121 122 123 124 125 126
		}x;
our $Attribute	= qr{
			const|
			__read_mostly|
			__kprobes|
			__(?:mem|cpu|dev|)(?:initdata|init)
		  }x;
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{
			<=|>=|==|!=|
			=>|->|<<|>>|<|>|!|~|
127
			&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
128 129
		  }x;

130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
our $NonptrType;
our $Type;
our $Declare;

our @typeList = (
	qr{void},
	qr{char},
	qr{short},
	qr{int},
	qr{long},
	qr{unsigned},
	qr{float},
	qr{double},
	qr{bool},
	qr{long\s+int},
	qr{long\s+long},
	qr{long\s+long\s+int},
	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},
);

sub build_types {
	my $all = "(?:  \n" . join("|\n  ", @typeList) . "\n)";
	$NonptrType	= qr{
			\b
			(?:const\s+)?
			(?:unsigned\s+)?
162 163 164 165
			(?:
				$all|
				(?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)
			)
166 167 168 169 170 171
			(?:\s+$Sparse|\s+const)*
			\b
		  }x;
	$Type	= qr{
			\b$NonptrType\b
			(?:\s*\*+\s*const|\s*\*+|(?:\s*\[\s*\])+)?
172
			(?:\s+$Inline|\s+$Sparse|\s+$Attribute)*
173 174 175 176
		  }x;
	$Declare	= qr{(?:$Storage\s+)?$Type};
}
build_types();
177 178 179

$chk_signoff = 0 if ($file);

180 181
my @dep_includes = ();
my @dep_functions = ();
182 183 184 185
my $removal = "Documentation/feature-removal-schedule.txt";
if ($tree && -f "$root/$removal") {
	open(REMOVE, "<$root/$removal") ||
				die "$P: $removal: open failed - $!\n";
186
	while (<REMOVE>) {
187 188 189
		if (/^Check:\s+(.*\S)/) {
			for my $entry (split(/[, ]+/, $1)) {
				if ($entry =~ m@include/(.*)@) {
190 191
					push(@dep_includes, $1);

192 193 194
				} elsif ($entry !~ m@/@) {
					push(@dep_functions, $entry);
				}
195
			}
196 197 198 199
		}
	}
}

200
my @rawlines = ();
201 202
my @lines = ();
my $vname;
203 204 205 206 207 208 209
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";
210
	}
211 212 213 214 215
	if ($filename eq '-') {
		$vname = 'Your patch';
	} else {
		$vname = $filename;
	}
216 217 218 219 220
	while (<FILE>) {
		chomp;
		push(@rawlines, $_);
	}
	close(FILE);
221
	if (!process($filename)) {
222 223 224
		$exit = 1;
	}
	@rawlines = ();
225
	@lines = ();
226 227 228 229 230
}

exit($exit);

sub top_of_kernel_tree {
231 232 233 234 235 236 237 238 239 240 241 242
	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;
		}
243
	}
244
	return 1;
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
}

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;
}
267
sub copy_spacing {
268
	(my $res = shift) =~ tr/\t/ /c;
269 270
	return $res;
}
271

272 273 274 275 276 277 278 279 280 281 282 283 284
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));
}

285 286 287 288 289 290 291 292 293 294 295
my $sanitise_quote = '';

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

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
296 297 298 299 300 301
sub sanitise_line {
	my ($line) = @_;

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

302
	my $qlen = 0;
303 304
	my $off = 0;
	my $c;
305

306 307 308 309 310 311 312 313 314 315 316 317 318 319
	# 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;
320
		}
321 322 323 324 325
		if (substr($line, $off, 2) eq $sanitise_quote) {
			$sanitise_quote = '';
			substr($res, $off, 2, "$;$;");
			$off++;
			next;
326
		}
327 328 329 330 331 332 333

		# 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;
334
		}
335 336 337 338
		# Regular quotes.
		if ($c eq "'" || $c eq '"') {
			if ($sanitise_quote eq '') {
				$sanitise_quote = $c;
339

340 341 342 343 344 345
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
346

347 348 349 350 351 352 353 354
		#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);
		}
355 356 357 358 359 360 361 362 363 364 365 366 367
	}

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

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

368 369 370
	return $res;
}

371 372 373 374 375 376
sub ctx_statement_block {
	my ($linenr, $remain, $off) = @_;
	my $line = $linenr - 1;
	my $blk = '';
	my $soff = $off;
	my $coff = $off - 1;
377
	my $coff_set = 0;
378

379 380
	my $loff = 0;

381 382
	my $type = '';
	my $level = 0;
383
	my $p;
384 385
	my $c;
	my $len = 0;
386 387

	my $remainder;
388
	while (1) {
389
		#warn "CSB: blk<$blk> remain<$remain>\n";
390 391 392 393
		# If we are about to drop off the end, pull in more
		# context.
		if ($off >= $len) {
			for (; $remain > 0; $line++) {
394
				next if ($lines[$line] =~ /^-/);
395
				$remain--;
396
				$loff = $len;
397
				$blk .= $lines[$line] . "\n";
398 399 400 401 402 403
				$len = length($blk);
				$line++;
				last;
			}
			# Bail if there is no further context.
			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
404
			if ($off >= $len) {
405 406 407
				last;
			}
		}
408
		$p = $c;
409
		$c = substr($blk, $off, 1);
410
		$remainder = substr($blk, $off);
411

412
		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
413 414 415 416 417 418
		# Statement ends at the ';' or a close '}' at the
		# outermost level.
		if ($level == 0 && $c eq ';') {
			last;
		}

419
		# An else is really a conditional as long as its not else if
420 421 422 423 424 425 426 427
		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";
428 429
		}

430 431 432 433 434 435 436 437 438 439
		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;
440 441
				$coff_set = 1;
				#warn "CSB: mark coff<$coff>\n";
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
			}
		}
		if (($type eq '' || $type eq '{') && $c eq '{') {
			$level++;
			$type = '{';
		}
		if ($type eq '{' && $c eq '}') {
			$level--;
			$type = ($level != 0)? '{' : '';

			if ($level == 0) {
				last;
			}
		}
		$off++;
	}
458 459 460 461
	if ($off == $len) {
		$line++;
		$remain--;
	}
462 463 464 465 466 467 468

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

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

469
	#print "coff<$coff> soff<$off> loff<$loff>\n";
470 471 472 473 474

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

475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 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
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;
	}
}

518 519 520 521 522 523
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

524
	# Grab the first conditional/block pair.
525 526
	($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
527
	#print "F: c<$condition> s<$statement> remain<$remain>\n";
528 529 530 531 532 533 534
	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.
535 536 537
	for (;;) {
		($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
538
		#print "C: c<$condition> s<$statement> remain<$remain>\n";
539
		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
540 541
		#print "C: push\n";
		push(@chunks, [ $condition, $statement ]);
542 543 544
	}

	return ($level, $linenr, @chunks);
545 546
}

547
sub ctx_block_get {
548
	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
549 550 551 552 553 554 555
	my $line;
	my $start = $linenr - 1;
	my $blk = '';
	my @o;
	my @c;
	my @res = ();

556
	my $level = 0;
557 558 559 560 561
	for ($line = $start; $remain > 0; $line++) {
		next if ($rawlines[$line] =~ /^-/);
		$remain--;

		$blk .= $rawlines[$line];
562 563 564 565 566 567
		foreach my $c (split(//, $rawlines[$line])) {
			##print "C<$c>L<$level><$open$close>O<$off>\n";
			if ($off > 0) {
				$off--;
				next;
			}
568

569 570 571 572 573 574 575
			if ($c eq $close && $level > 0) {
				$level--;
				last if ($level == 0);
			} elsif ($c eq $open) {
				$level++;
			}
		}
576

577
		if (!$outer || $level <= 1) {
578
			push(@res, $rawlines[$line]);
579 580
		}

581
		last if ($level == 0);
582 583
	}

584
	return ($level, @res);
585 586 587 588
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

589 590
	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
	return @r;
591 592 593 594
}
sub ctx_block {
	my ($linenr, $remain) = @_;

595 596
	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
	return @r;
597 598
}
sub ctx_statement {
599 600 601 602 603 604
	my ($linenr, $remain, $off) = @_;

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

607
	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
608
}
609 610 611 612 613
sub ctx_statement_level {
	my ($linenr, $remain, $off) = @_;

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
614 615 616 617 618

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

	# Catch a comment on the end of the line itself.
619
	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*$@);
620 621 622 623 624 625 626
	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++) {
627 628
		my $line = $rawlines[$linenr - 1];
		#warn "           $line\n";
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650
		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);

651
	##print "LINE: $rawlines[$end_line - 1 ]\n";
652 653 654 655 656
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

657 658 659
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
660

661 662 663 664 665 666
	$res = '';
	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
		$res .= $1;
		if ($2 ne '') {
			$coded = sprintf("^%c", unpack('C', $2) + 64);
			$res .= $coded;
667 668
		}
	}
669
	$res =~ s/$/\$/;
670

671
	return $res;
672 673
}

674
my $av_preprocessor = 0;
675
my $av_pending;
676 677 678 679
my @av_paren_type;

sub annotate_reset {
	$av_preprocessor = 0;
680 681
	$av_pending = '_';
	@av_paren_type = ('E');
682 683
}

684 685
sub annotate_values {
	my ($stream, $type) = @_;
686

687 688 689
	my $res;
	my $cur = $stream;

690
	print "$stream\n" if ($dbg_values > 1);
691 692

	while (length($cur)) {
693
		@av_paren_type = ('E') if ($#av_paren_type < 0);
694 695
		print " <" . join('', @av_paren_type) .
					"> <$type> " if ($dbg_values > 1);
696
		if ($cur =~ /^(\s+)/o) {
697 698
			print "WS($1)\n" if ($dbg_values > 1);
			if ($1 =~ /\n/ && $av_preprocessor) {
699
				$type = pop(@av_paren_type);
700
				$av_preprocessor = 0;
701 702
			}

703
		} elsif ($cur =~ /^($Type)/) {
704
			print "DECLARE($1)\n" if ($dbg_values > 1);
705 706 707
			$type = 'T';

		} elsif ($cur =~ /^(#\s*define\s*$Ident)(\(?)/o) {
708 709
			print "DEFINE($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;
710
			$av_pending = 'N';
711

712 713
		} elsif ($cur =~ /^(#\s*(?:ifdef|ifndef|if))/o) {
			print "PRE_START($1)\n" if ($dbg_values > 1);
714
			$av_preprocessor = 1;
715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
			$type = 'N';

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

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

			$type = 'N';

		} elsif ($cur =~ /^(#\s*(?:endif))/o) {
			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);
737 738 739
			$type = 'N';

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

		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
743
			print "SIZEOF($1)\n" if ($dbg_values > 1);
744
			if (defined $2) {
745
				$av_pending = 'V';
746 747 748
			}
			$type = 'N';

749
		} elsif ($cur =~ /^(if|while|typeof|__typeof__|for)\b/o) {
750
			print "COND($1)\n" if ($dbg_values > 1);
751
			$av_pending = 'N';
752 753 754
			$type = 'N';

		} elsif ($cur =~/^(return|case|else)/o) {
755
			print "KEYWORD($1)\n" if ($dbg_values > 1);
756 757 758
			$type = 'N';

		} elsif ($cur =~ /^(\()/o) {
759
			print "PAREN('$1')\n" if ($dbg_values > 1);
760 761
			push(@av_paren_type, $av_pending);
			$av_pending = '_';
762 763 764
			$type = 'N';

		} elsif ($cur =~ /^(\))/o) {
765 766 767
			my $new_type = pop(@av_paren_type);
			if ($new_type ne '_') {
				$type = $new_type;
768 769
				print "PAREN('$1') -> $type\n"
							if ($dbg_values > 1);
770
			} else {
771
				print "PAREN('$1')\n" if ($dbg_values > 1);
772 773 774
			}

		} elsif ($cur =~ /^($Ident)\(/o) {
775
			print "FUNC($1)\n" if ($dbg_values > 1);
776
			$av_pending = 'V';
777 778

		} elsif ($cur =~ /^($Ident|$Constant)/o) {
779
			print "IDENT($1)\n" if ($dbg_values > 1);
780 781 782
			$type = 'V';

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

786
		} elsif ($cur =~/^(;|{|})/) {
787
			print "END($1)\n" if ($dbg_values > 1);
788 789
			$type = 'E';

790
		} elsif ($cur =~ /^(;|\?|:|\[)/o) {
791
			print "CLOSE($1)\n" if ($dbg_values > 1);
792 793 794
			$type = 'N';

		} elsif ($cur =~ /^($Operators)/o) {
795
			print "OP($1)\n" if ($dbg_values > 1);
796 797 798 799 800
			if ($1 ne '++' && $1 ne '--') {
				$type = 'N';
			}

		} elsif ($cur =~ /(^.)/o) {
801
			print "C($1)\n" if ($dbg_values > 1);
802 803 804 805 806
		}
		if (defined $1) {
			$cur = substr($cur, length($1));
			$res .= $type x length($1);
		}
807
	}
808

809
	return $res;
810 811
}

812
sub possible {
813
	my ($possible, $line) = @_;
814 815 816 817 818 819 820

	#print "CHECK<$possible>\n";
	if ($possible !~ /^(?:$Storage|$Type|DEFINE_\S+)$/ &&
	    $possible ne 'goto' && $possible ne 'return' &&
	    $possible ne 'struct' && $possible ne 'enum' &&
	    $possible ne 'case' && $possible ne 'else' &&
	    $possible ne 'typedef') {
821
		warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
822 823 824 825 826
		push(@typeList, $possible);
		build_types();
	}
}

827 828
my $prefix = '';

829
sub report {
830 831 832
	if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
		return 0;
	}
833 834 835 836
	my $line = $prefix . $_[0];

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

837
	push(our @report, $line);
838 839

	return 1;
840 841
}
sub report_dump {
842
	our @report;
843
}
844
sub ERROR {
845 846 847 848
	if (report("ERROR: $_[0]\n")) {
		our $clean = 0;
		our $cnt_error++;
	}
849 850
}
sub WARN {
851 852 853 854
	if (report("WARNING: $_[0]\n")) {
		our $clean = 0;
		our $cnt_warn++;
	}
855 856
}
sub CHK {
857
	if ($check && report("CHECK: $_[0]\n")) {
858 859 860
		our $clean = 0;
		our $cnt_chk++;
	}
861 862
}

863 864 865 866 867
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
868
	my $prevrawline="";
869
	my $stashline="";
870
	my $stashrawline="";
871

872
	my $length;
873 874 875 876
	my $indent;
	my $previndent=0;
	my $stashindent=0;

877
	our $clean = 1;
878 879 880
	my $signoff = 0;
	my $is_patch = 0;

881
	our @report = ();
882 883 884 885 886
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

887 888 889 890 891 892
	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
	my $in_comment = 0;
893
	my $comment_edge = 0;
894 895
	my $first_line = 0;

896 897 898
	my $prev_values = 'E';

	# suppression flags
899
	my %suppress_ifbraces;
900

901
	# Pre-scan the patch sanitizing the lines.
902
	# Pre-scan the patch looking for any __setup documentation.
903
	#
904 905
	my @setup_docs = ();
	my $setup_docs = 0;
906 907

	sanitise_line_reset();
908 909
	my $line;
	foreach my $rawline (@rawlines) {
910 911
		$linenr++;
		$line = $rawline;
912

913
		if ($rawline=~/^\+\+\+\s+(\S+)/) {
914 915 916 917
			$setup_docs = 0;
			if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
				$setup_docs = 1;
			}
918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957
			#next;
		}
		if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}

			# 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;
			for (my $ln = $linenr; $ln < ($linenr + $realcnt); $ln++) {
				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);

		} elsif ($realcnt) {
			# Standardise the strings and chars within the input to
			# simplify matching.
			$line = sanitise_line($rawline);
958
		}
959 960 961 962 963 964 965 966 967 968
		push(@lines, $line);

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

		#print "==>$rawline\n";
		#print "-->$line\n";
969 970 971 972 973 974

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

975 976
	$prefix = '';

977 978
	$realcnt = 0;
	$linenr = 0;
979 980 981
	foreach my $line (@lines) {
		$linenr++;

982
		my $rawline = $rawlines[$linenr - 1];
983

984
#extract the line range in the file after the patch is applied
985
		if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
986
			$is_patch = 1;
987
			$first_line = $linenr + 1;
988 989 990 991 992 993
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
994
			annotate_reset();
995 996
			$prev_values = 'E';

997
			%suppress_ifbraces = ();
998 999
			next;

1000 1001 1002
# 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.
1003
		} elsif ($line =~ /^( |\+|$)/) {
1004
			$realline++;
1005
			$realcnt-- if ($realcnt != 0);
1006

1007
			# Measure the line length and indent.
1008
			($length, $indent) = line_stats($rawline);
1009 1010 1011 1012

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

1015
			#warn "line<$line>\n";
1016

1017 1018
		} elsif ($realcnt == 1) {
			$realcnt--;
1019 1020 1021
		}

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

1025 1026
		$here = "#$linenr: " if (!$file);
		$here = "#$realline: " if ($file);
1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038

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

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

1041 1042 1043
		my $hereline = "$here\n$rawline\n";
		my $herecurr = "$here\n$rawline\n";
		my $hereprev = "$here\n$prevrawline\n$rawline\n";
1044

1045 1046
		$cnt_lines++ if ($realcnt != 0);

1047
#check the patch for a signoff:
1048
		if ($line =~ /^\s*signed-off-by:/i) {
1049 1050
			# This is a signoff, if ugly, so do not double report.
			$signoff++;
1051
			if (!($line =~ /^\s*Signed-off-by:/)) {
1052 1053
				WARN("Signed-off-by: is the preferred form\n" .
					$herecurr);
1054 1055
			}
			if ($line =~ /^\s*signed-off-by:\S/i) {
1056
				WARN("space required after Signed-off-by:\n" .
1057
					$herecurr);
1058 1059 1060
			}
		}

1061
# Check for wrappage within a valid hunk of the file
1062
		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1063
			ERROR("patch seems to be corrupt (line wrapped?)\n" .
1064
				$herecurr) if (!$emitted_corrupt++);
1065 1066 1067 1068
		}

# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1069
		     !($rawline =~ m/^(
1070 1071 1072 1073 1074 1075 1076 1077 1078
				[\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 )) {
1079
			ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $herecurr);
1080 1081 1082 1083
		}

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

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

#trailing whitespace
1089
		if ($line =~ /^\+.*\015/) {
1090
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1091 1092
			ERROR("DOS line endings\n" . $herevet);

1093 1094
		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1095
			ERROR("trailing whitespace\n" . $herevet);
1096 1097
		}
#80 column limit
1098
		if ($line =~ /^\+/ && !($prevrawline=~/\/\*\*/) && $length > 80) {
1099
			WARN("line over 80 characters\n" . $herecurr);
1100 1101
		}

1102 1103 1104 1105 1106
# 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);
		}

1107 1108 1109 1110 1111
# 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.
1112 1113 1114
		if ($rawline =~ /^\+\s* \t\s*\S/ ||
		    $rawline =~ /^\+\s*        \s*/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1115
			ERROR("use tabs not spaces\n" . $herevet);
1116 1117
		}

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

1123
# Check for potential 'bare' types
1124
		if ($realcnt) {
1125 1126 1127 1128
			my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
			$s =~ s/\n./ /g;
			$s =~ s/{.*$//;

1129
			# Ignore goto labels.
1130
			if ($s =~ /$Ident:\*$/) {
1131 1132

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

1135
			# definitions in global scope can only start with types
1136 1137
			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b/) {
				possible($1, $s);
1138 1139

			# declarations always start with types
1140 1141
			} elsif ($prev_values eq 'E' && $s =~ /^.\s*(?:$Storage\s+)?(?:const\s+)?($Ident)\b(:?\s+$Sparse)?\s*\**\s*$Ident\s*(?:;|=|,)/) {
				possible($1, $s);
1142
			}
1143 1144

			# any (foo ... *) is a pointer cast, and foo is a type
1145 1146
			while ($s =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/g) {
				possible($1, $s);
1147 1148 1149 1150 1151
			}

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

1155
				my $ctx = $s;
1156
				substr($ctx, 0, $name_len + 1, '');
1157
				$ctx =~ s/\)[^\)]*$//;
1158

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

1162
						possible($1, $s);
1163 1164
					}
				}
1165
			}
1166

1167 1168
		}

1169 1170 1171
#
# Checks which may be anchored in the context.
#
1172

1173 1174
# Check for switch () and associated case and default
# statements should be at the same indent.
1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190
		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 '') {
1191
				ERROR("switch and case should be at the same indent\n$hereline$err");
1192 1193 1194 1195 1196
			}
		}

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

1200
			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
1201 1202 1203 1204
			my $ctx_ln = $linenr + $#ctx + 1;
			my $ctx_cnt = $realcnt - $#ctx - 1;
			my $ctx = join("\n", @ctx);

1205 1206
			##warn "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";

1207
			# Skip over any removed lines in the context following statement.
1208
			while (defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^-/) {
1209 1210
				$ctx_ln++;
			}
1211
			##warn "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
1212

1213 1214
			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
				ERROR("that open brace { should be on the previous line\n" .
1215
					"$here\n$ctx\n$lines[$ctx_ln - 1]");
1216
			}
1217 1218 1219 1220
			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
			    $ctx =~ /\)\s*\;\s*$/ &&
			    defined $lines[$ctx_ln - 1])
			{
1221 1222
				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
				if ($nindent > $indent) {
1223
					WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
1224 1225 1226
						"$here\n$ctx\n$lines[$ctx_ln - 1]");
				}
			}
1227 1228
		}

1229 1230 1231 1232
		# Track the 'values' across context and added lines.
		my $opline = $line; $opline =~ s/^./ /;
		my $curr_values = annotate_values($opline . "\n", $prev_values);
		$curr_values = $prev_values . $curr_values;
1233 1234
		if ($dbg_values) {
			my $outline = $opline; $outline =~ s/\t/ /g;
1235 1236
			print "$linenr > .$outline\n";
			print "$linenr > $curr_values\n";
1237
		}
1238 1239
		$prev_values = substr($curr_values, -1);

1240 1241 1242
#ignore lines not being added
		if ($line=~/^[^\+]/) {next;}

1243 1244
# TEST: allow direct testing of the type matcher.
		if ($tst_type && $line =~ /^.$Declare$/) {
1245
			ERROR("TEST: is type $Declare\n" . $herecurr);
1246 1247 1248
			next;
		}

1249 1250 1251
# check for initialisation to aggregates open brace on the next line
		if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
		    $line =~ /^.\s*{/) {
1252
			ERROR("that open brace { should be on the previous line\n" . $hereprev);
1253 1254
		}

1255 1256 1257 1258 1259 1260 1261 1262
#
# Checks which are anchored on the added line.
#

# check for malformed paths in #include statements (uses RAW line)
		if ($rawline =~ m{^.#\s*include\s+[<"](.*)[">]}) {
			my $path = $1;
			if ($path =~ m{//}) {
1263 1264
				ERROR("malformed #include filename\n" .
					$herecurr);
1265 1266
			}
		}
1267

1268
# no C99 // comments
1269
		if ($line =~ m{//}) {
1270
			ERROR("do not use C99 // comments\n" . $herecurr);
1271
		}
1272
		# Remove C99 comments.
1273
		$line =~ s@//.*@@;
1274
		$opline =~ s@//.*@@;
1275 1276

#EXPORT_SYMBOL should immediately follow its function closing }.
1277 1278 1279
		if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
		    ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
			my $name = $1;
1280 1281
			if (($prevline !~ /^}/) &&
			   ($prevline !~ /^\+}/) &&
1282
			   ($prevline !~ /^ }/) &&
1283 1284 1285
			   ($prevline !~ /^.DECLARE_$Ident\(\Q$name\E\)/) &&
			   ($prevline !~ /^.LIST_HEAD\(\Q$name\E\)/) &&
			   ($prevline !~ /\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)/)) {
1286
				WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
1287 1288 1289
			}
		}

1290 1291 1292 1293 1294
# check for external initialisers.
		if ($line =~ /^.$Type\s*$Ident\s*=\s*(0|NULL);/) {
			ERROR("do not initialise externals to 0 or NULL\n" .
				$herecurr);
		}
1295
# check for static initialisers.
1296
		if ($line =~ /\s*static\s.*=\s*(0|NULL);/) {
1297 1298
			ERROR("do not initialise statics to 0 or NULL\n" .
				$herecurr);
1299 1300
		}

1301 1302 1303
# check for new typedefs, only function parameters and sparse annotations
# make sense.
		if ($line =~ /\btypedef\s/ &&
1304
		    $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ &&
1305
		    $line !~ /\b__bitwise(?:__|)\b/) {
1306
			WARN("do not add new typedefs\n" . $herecurr);
1307 1308 1309
		}

# * goes on variable not on type
1310
		if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) {
1311 1312
			ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" .
				$herecurr);
1313 1314

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

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

1322
		} elsif ($line =~ m{$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) {
1323 1324
			ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" .
				$herecurr);
1325 1326 1327 1328 1329 1330 1331 1332 1333
		}

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

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

1338 1339 1340 1341 1342
# 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.
1343
		if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356
			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) {
1357
				WARN("printk() should include KERN_ facility level\n" . $herecurr);
1358
			}
1359 1360
		}

1361 1362
# function brace can't be on same line, except for #defines of do while,
# or if closed on same line
1363
		if (($line=~/$Type\s*[A-Za-z\d_]+\(.*\).*\s{/) and
1364
		    !($line=~/\#define.*do\s{/) and !($line=~/}/)) {
1365
			ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
1366
		}
1367

1368 1369 1370 1371 1372 1373
# 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);
		}

1374
# check for spaces between functions and their parentheses.
1375
		while ($line =~ /($Ident)\s+\(/g) {
1376
			my $name = $1;
1377 1378
			my $ctx_before = substr($line, 0, $-[1]);
			my $ctx = "$ctx_before$name";
1379 1380

			# Ignore those directives where spaces _are_ permitted.
1381 1382 1383 1384 1385 1386
			if ($name =~ /^(?:
				if|for|while|switch|return|case|
				volatile|__volatile__|
				__attribute__|format|__extension__|
				asm|__asm__)$/x)
			{
1387 1388 1389 1390

			# 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.
1391 1392 1393 1394
			} elsif ($ctx_before =~ /^.\#\s*define\s*$/) {

			# cpp #elif statement condition may start with a (
			} elsif ($ctx =~ /^.\#\s*elif\s*$/) {
1395 1396 1397

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

			} else {
1401
				WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
1402
			}
1403
		}
1404
# Check operator spacing.
1405
		if (!($line=~/\#\s*include/)) {
1406 1407 1408 1409
			my $ops = qr{
				<<=|>>=|<=|>=|==|!=|
				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
				=>|->|<<|>>|<|>|=|!|~|
1410
				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
1411
			}x;
1412
			my @elements = split(/($ops|;)/, $opline);
1413
			my $off = 0;
1414 1415 1416

			my $blank = copy_spacing($opline);

1417
			for (my $n = 0; $n < $#elements; $n += 2) {
1418 1419
				$off += length($elements[$n]);

1420 1421 1422 1423 1424 1425 1426 1427
				# 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";

1428 1429 1430
				my $a = '';
				$a = 'V' if ($elements[$n] ne '');
				$a = 'W' if ($elements[$n] =~ /\s$/);
1431
				$a = 'C' if ($elements[$n] =~ /$;$/);
1432 1433
				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
				$a = 'O' if ($elements[$n] eq '');
1434
				$a = 'E' if ($ca =~ /^\s*$/);
1435

1436
				my $op = $elements[$n + 1];
1437 1438

				my $c = '';
1439
				if (defined $elements[$n + 2]) {
1440 1441
					$c = 'V' if ($elements[$n + 2] ne '');
					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
1442
					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
1443 1444
					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
					$c = 'O' if ($elements[$n + 2] eq '');
1445
					$c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
1446 1447
				} else {
					$c = 'E';
1448 1449
				}

1450 1451 1452 1453
				my $ctx = "${a}x${c}";

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

1454
				my $ptr = substr($blank, 0, $off) . "^";
1455
				my $hereptr = "$hereline$ptr\n";
1456

1457 1458 1459
				# Classify operators into binary, unary, or
				# definitions (* only) where they have more
				# than one mode.
1460 1461 1462 1463 1464 1465 1466 1467 1468
				my $op_type = substr($curr_values, $off + 1, 1);
				my $op_left = substr($curr_values, $off, 1);
				my $is_unary;
				if ($op_type eq 'T') {
					$is_unary = 2;
				} elsif ($op_left eq 'V') {
					$is_unary = 0;
				} else {
					$is_unary = 1;
1469 1470
				}
				#if ($op eq '-' || $op eq '&' || $op eq '*') {
1471
				#	print "UNARY: <$op_left$op_type $is_unary $a:$op:$c> <$ca:$op:$cc> <$unary_ctx>\n";
1472
				#}
1473

1474 1475 1476 1477
				# Ignore operators passed as parameters.
				if ($op_type ne 'V' &&
				    $ca =~ /\s$/ && $cc =~ /^\s*,/) {

1478 1479
#				# Ignore comments
#				} elsif ($op =~ /^$;+$/) {
1480

1481
				# ; should have either the end of line or a space or \ after it
1482
				} elsif ($op eq ';') {
1483 1484
					if ($ctx !~ /.x[WEBC]/ &&
					    $cc !~ /^\\/ && $cc !~ /^;/) {
1485
						ERROR("space required after that '$op' $at\n" . $hereptr);
1486 1487 1488 1489
					}

				# // is a comment
				} elsif ($op eq '//') {
1490 1491 1492

				# -> should have no spaces
				} elsif ($op eq '->') {
1493
					if ($ctx =~ /Wx.|.xW/) {
1494
						ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
1495 1496 1497 1498
					}

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

1503 1504 1505 1506 1507 1508 1509 1510 1511
				# '*' as part of a type definition -- reported already.
				} elsif ($op eq '*' && $is_unary == 2) {
					#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 '~' ||
				         ($is_unary && ($op eq '*' || $op eq '-' || $op eq '&'))) {
1512
					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
1513
						ERROR("space required before that '$op' $at\n" . $hereptr);
1514
					}
1515
					if ($ctx =~ /.xW/) {
1516
						ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1517 1518 1519 1520
					}

				# unary ++ and unary -- are allowed no space on one side.
				} elsif ($op eq '++' or $op eq '--') {
1521 1522 1523 1524 1525 1526
					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);
1527
					}
1528 1529
					if ($ctx =~ /ExW/) {
						ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1530
					}
1531

1532

1533
				# << and >> may either have or not have spaces both sides
1534 1535 1536
				} elsif ($op eq '<<' or $op eq '>>' or
					 $op eq '&' or $op eq '^' or $op eq '|' or
					 $op eq '+' or $op eq '-' or
1537 1538
					 $op eq '*' or $op eq '/' or
					 $op eq '%')
1539
				{
1540
					if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
1541 1542
						ERROR("need consistent spacing around '$op' $at\n" .
							$hereptr);
1543 1544 1545
					}

				# All the others need spaces both sides.
1546
				} elsif ($ctx !~ /[EWC]x[CWE]/) {
1547 1548 1549
					# Ignore email addresses <foo@bar>
					if (!($op eq '<' && $cb =~ /$;\S+\@\S+>/) &&
					    !($op eq '>' && $cb =~ /<\S+\@\S+$;/)) {
1550
						ERROR("spaces required around that '$op' $at\n" . $hereptr);
1551
					}
1552
				}
1553
				$off += length($elements[$n + 1]);
1554 1555 1556
			}
		}

1557 1558
# check for multiple assignments
		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
1559
			CHK("multiple assignments should be avoided\n" . $herecurr);
1560 1561
		}

1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575
## # 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);
## 			}
## 		}
1576

1577
#need space before brace following if, while, etc
1578 1579
		if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
		    $line =~ /do{/) {
1580
			ERROR("space required before the open brace '{'\n" . $herecurr);
1581 1582 1583 1584 1585
		}

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

1589 1590
# check spacing on square brackets
		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
1591
			ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
1592 1593
		}
		if ($line =~ /\s\]/) {
1594
			ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
1595 1596 1597
		}

# check spacing on paretheses
1598 1599
		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
		    $line !~ /for\s*\(\s+;/) {
1600
			ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
1601
		}
1602
		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
1603
		    $line !~ /for\s*\(.*;\s+\)/) {
1604
			ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
1605 1606
		}

1607
#goto labels aren't indented, allow a single space however
1608
		if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
1609
		   !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
1610
			WARN("labels should not be indented\n" . $herecurr);
1611 1612 1613
		}

# Need a space before open parenthesis after if, while etc
1614
		if ($line=~/\b(if|while|for|switch)\(/) {
1615
			ERROR("space required before the open parenthesis '('\n" . $herecurr);
1616 1617 1618
		}

# Check for illegal assignment in if conditional.
1619 1620 1621 1622
		if ($line =~ /\bif\s*\(/) {
			my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);

			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
1623
				ERROR("do not use assignment in if condition\n" . $herecurr);
1624 1625 1626 1627
			}

			# Find out what is on the end of the line after the
			# conditional.
1628
			substr($s, 0, length($c), '');
1629
			$s =~ s/\n.*//g;
1630
			$s =~ s/$;//g; 	# Remove any comments
1631 1632 1633
			if (length($c) && $s !~ /^\s*({|;|)\s*\\*\s*$/ &&
			    $c !~ /^.\#\s*if/)
			{
1634 1635 1636 1637
				ERROR("trailing statements should be on next line\n" . $herecurr);
			}
		}

1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652
# 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);
		}

1653
# if and else should not have general statements after it
1654 1655 1656 1657 1658 1659
		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);
			}
1660 1661 1662 1663 1664 1665
		}

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

1669 1670 1671 1672 1673 1674
		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.
1675
			substr($s, 0, length($c), '');
1676 1677 1678 1679 1680 1681 1682
			$s =~ s/\n.*//g;

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

1683 1684 1685 1686 1687 1688 1689 1690 1691
#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
		if ($line=~/\#define.*\\\s$/) {
1692
			WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
1693 1694
		}

1695 1696
#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
		if ($tree && $rawline =~ m{^.\#\s*include\s*\<asm\/(.*)\.h\>}) {
1697 1698
			my $checkfile = "$root/include/linux/$1.h";
			if (-f $checkfile && $1 ne 'irq.h') {
1699
				WARN("Use #include <linux/$1.h> instead of <asm/$1.h>\n" .
1700
					$herecurr);
1701 1702 1703
			}
		}

1704 1705
# 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
1706
# in a known good container
1707 1708 1709 1710
		if ($prevline =~ /\#define.*\\/ &&
		   $prevline !~/(?:do\s+{|\(\{|\{)/ &&
		   $line !~ /(?:do\s+{|\(\{|\{)/ &&
		   $line !~ /^.\s*$Declare\s/) {
1711 1712 1713
			# Grab the first statement, if that is the entire macro
			# its ok.  This may start either on the #define line
			# or the one below.
1714 1715
			my $ln = $linenr;
			my $cnt = $realcnt;
1716
			my $off = 0;
1717

1718 1719 1720 1721
			# If the macro starts on the define line start
			# grabbing the statement after the identifier
			$prevline =~ m{^(.#\s*define\s*$Ident(?:\([^\)]*\))?\s*)(.*)\\\s*$};
			##print "1<$1> 2<$2>\n";
1722
			if (defined $2 && $2 ne '') {
1723
				$off = length($1);
1724 1725
				$ln--;
				$cnt++;
1726 1727 1728 1729
				while ($lines[$ln - 1] =~ /^-/) {
					$ln--;
					$cnt++;
				}
1730
			}
1731
			my @ctx = ctx_statement($ln, $cnt, $off);
1732 1733 1734 1735 1736 1737 1738 1739 1740
			my $ctx_ln = $ln + $#ctx + 1;
			my $ctx = join("\n", @ctx);

			# Pull in any empty extension lines.
			while ($ctx =~ /\\$/ &&
			       $lines[$ctx_ln - 1] =~ /^.\s*(?:\\)?$/) {
				$ctx .= $lines[$ctx_ln - 1];
				$ctx_ln++;
			}
1741 1742 1743

			if ($ctx =~ /\\$/) {
				if ($ctx =~ /;/) {
1744
					ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
1745
				} else {
1746
					ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
1747
				}
1748
			}
1749 1750
		}

1751
# check for redundant bracing round if etc
1752 1753
		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
			my ($level, $endln, @chunks) =
1754
				ctx_statement_full($linenr, $realcnt, 1);
1755
			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
1756 1757
			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
			if ($#chunks > 0 && $level == 0) {
1758 1759
				my $allowed = 0;
				my $seen = 0;
1760
				my $herectx = $here . "\n";
1761
				my $ln = $linenr - 1;
1762 1763 1764
				for my $chunk (@chunks) {
					my ($cond, $block) = @{$chunk};

1765 1766 1767 1768 1769 1770 1771 1772 1773 1774
					# 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";
1775 1776
					$ln += statement_rawlines($block) - 1;

1777
					substr($block, 0, length($cond), '');
1778 1779 1780

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

1781 1782 1783
					#print "cond<$cond> block<$block> allowed<$allowed>\n";
					if (statement_lines($cond) > 1) {
						#print "APW: ALLOWED: cond<$cond>\n";
1784 1785 1786
						$allowed = 1;
					}
					if ($block =~/\b(?:if|for|while)\b/) {
1787
						#print "APW: ALLOWED: block<$block>\n";
1788 1789
						$allowed = 1;
					}
1790 1791
					if (statement_block_size($block) > 1) {
						#print "APW: ALLOWED: lines block<$block>\n";
1792 1793 1794 1795
						$allowed = 1;
					}
				}
				if ($seen && !$allowed) {
1796
					WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
1797 1798 1799
				}
			}
		}
1800
		if (!defined $suppress_ifbraces{$linenr - 1} &&
1801
					$line =~ /\b(if|while|for|else)\b/) {
1802 1803 1804 1805 1806 1807 1808
			my $allowed = 0;

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

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

1813 1814
			# Check the condition.
			my ($cond, $block) = @{$chunks[0]};
1815
			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
1816
			if (defined $cond) {
1817
				substr($block, 0, length($cond), '');
1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834
			}
			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) {
1835
					substr($block, 0, length($cond), '');
1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847
				}
				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";;
1848
				}
1849 1850

				WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
1851 1852 1853
			}
		}

1854
# don't include deprecated include files (uses RAW line)
1855
		for my $inc (@dep_includes) {
1856
			if ($rawline =~ m@\#\s*include\s*\<$inc>@) {
1857
				ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
1858 1859 1860
			}
		}

1861 1862
# don't use deprecated functions
		for my $func (@dep_functions) {
1863
			if ($line =~ /\b$func\b/) {
1864
				ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
1865 1866 1867 1868
			}
		}

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

1874 1875 1876 1877 1878
# 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);
		}

1879 1880
# warn about #if 0
		if ($line =~ /^.#\s*if\s+0\b/) {
1881 1882
			CHK("if this code is redundant consider removing it\n" .
				$herecurr);
1883 1884
		}

1885 1886 1887 1888 1889 1890 1891
# check for needless kfree() checks
		if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
			my $expr = $1;
			if ($line =~ /\bkfree\(\Q$expr\E\);/) {
				WARN("kfree(NULL) is safe this check is probabally not required\n" . $hereprev);
			}
		}
1892 1893 1894 1895 1896 1897 1898
# 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 probabally not required\n" . $hereprev);
			}
		}
1899

1900 1901 1902 1903 1904 1905 1906
# warn about #ifdefs in C files
#		if ($line =~ /^.#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
#			print "#ifdef in C files should be avoided\n";
#			print "$herecurr";
#			$clean = 0;
#		}

1907 1908 1909 1910 1911
# warn about spacing in #ifdefs
		if ($line =~ /^.#\s*(ifdef|ifndef|elif)\s\s+/) {
			ERROR("exactly one space required after that #$1\n" . $herecurr);
		}

1912 1913 1914 1915
# check for spinlock_t definitions without a comment.
		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/) {
			my $which = $1;
			if (!ctx_has_comment($first_line, $linenr)) {
1916
				CHK("$1 definition without comment\n" . $herecurr);
1917 1918 1919 1920 1921
			}
		}
# 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)) {
1922
				CHK("memory barrier without comment\n" . $herecurr);
1923 1924 1925
			}
		}
# check of hardware specific defines
1926
		if ($line =~ m@^.#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
1927
			CHK("architecture specific defines should be avoided\n" .  $herecurr);
1928
		}
1929

1930 1931
# check the location of the inline attribute, that it is between
# storage class and type.
1932 1933
		if ($line =~ /\b$Type\s+$Inline\b/ ||
		    $line =~ /\b$Inline\s+$Storage\b/) {
1934 1935 1936
			ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
		}

1937 1938 1939 1940 1941
# Check for __inline__ and __inline, prefer inline
		if ($line =~ /\b(__inline__|__inline)\b/) {
			WARN("plain inline is preferred over $1\n" . $herecurr);
		}

1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953
# check for new externs in .c files.
		if ($line =~ /^.\s*extern\s/ && ($realfile =~ /\.c$/)) {
			WARN("externs should be avoided in .c files\n" .  $herecurr);
		}

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

# 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);
		}
1960 1961 1962 1963 1964

# check for gcc specific __FUNCTION__
		if ($line =~ /__FUNCTION__/) {
			WARN("__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr);
		}
1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986

# check for semaphores used as mutexes
		if ($line =~ /\b(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
			WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
		}
# check for semaphores used as mutexes
		if ($line =~ /\binit_MUTEX_LOCKED\s*\(/) {
			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);
		}

# 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/ &&
		    $line !~ /^.#\s*define\s+NR_CPUS\s+/ &&
		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/)
		{
			WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
		}
1987 1988 1989 1990 1991 1992
	}

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

1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007
	# 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) {
2008
		ERROR("Does not appear to be a unified-diff format patch\n");
2009 2010
	}
	if ($is_patch && $chk_signoff && $signoff == 0) {
2011
		ERROR("Missing Signed-off-by: line(s)\n");
2012 2013
	}

2014
	print report_dump();
2015 2016
	if ($summary && !($clean == 1 && $quiet == 1)) {
		print "$filename " if ($summary_file);
2017 2018 2019 2020
		print "total: $cnt_error errors, $cnt_warn warnings, " .
			(($check)? "$cnt_chk checks, " : "") .
			"$cnt_lines lines checked\n";
		print "\n" if ($quiet == 0);
2021
	}
2022

2023
	if ($clean == 1 && $quiet == 0) {
2024
		print "$vname has no obvious style problems and is ready for submission.\n"
2025 2026
	}
	if ($clean == 0 && $quiet == 0) {
2027
		print "$vname has style problems, please review.  If any of these errors\n";
2028 2029 2030
		print "are false positives report them to the maintainer, see\n";
		print "CHECKPATCH in MAINTAINERS.\n";
	}
2031

2032 2033
	return $clean;
}