checkpatch.pl 63.6 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
		}x;
our $Attribute	= qr{
			const|
			__read_mostly|
			__kprobes|
116 117 118 119
			__(?:mem|cpu|dev|)(?:initdata|init)|
			____cacheline_aligned|
			____cacheline_aligned_in_smp|
			____cacheline_internodealigned_in_smp
120
		  }x;
121
our $Modifier;
122 123 124 125 126 127 128 129 130
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{
			<=|>=|==|!=|
			=>|->|<<|>>|<|>|!|~|
131
			&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
132 133
		  }x;

134 135 136 137
our $NonptrType;
our $Type;
our $Declare;

138 139 140 141 142 143 144 145 146 147 148
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;

149 150
our @typeList = (
	qr{void},
151 152 153 154 155 156 157
	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},
158 159 160 161 162 163 164 165 166 167 168 169
	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},
);
170 171 172
our @modifierList = (
	qr{fastcall},
);
173 174

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

$chk_signoff = 0 if ($file);

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

209 210 211
				} elsif ($entry !~ m@/@) {
					push(@dep_functions, $entry);
				}
212
			}
213 214 215 216
		}
	}
}

217
my @rawlines = ();
218 219
my @lines = ();
my $vname;
220 221 222 223 224 225 226
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";
227
	}
228 229 230 231 232
	if ($filename eq '-') {
		$vname = 'Your patch';
	} else {
		$vname = $filename;
	}
233 234 235 236 237
	while (<FILE>) {
		chomp;
		push(@rawlines, $_);
	}
	close(FILE);
238
	if (!process($filename)) {
239 240 241
		$exit = 1;
	}
	@rawlines = ();
242
	@lines = ();
243 244 245 246 247
}

exit($exit);

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

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

289 290 291 292 293 294 295 296 297 298 299 300 301
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));
}

302 303 304 305 306 307 308 309 310 311 312
my $sanitise_quote = '';

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

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
313 314 315 316 317 318
sub sanitise_line {
	my ($line) = @_;

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

319
	my $qlen = 0;
320 321
	my $off = 0;
	my $c;
322

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

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

357 358 359 360 361 362
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
363

364 365 366 367 368 369 370 371
		#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);
		}
372 373 374
	}

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

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

385 386 387
	return $res;
}

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

396 397
	my $loff = 0;

398 399
	my $type = '';
	my $level = 0;
400
	my $p;
401 402
	my $c;
	my $len = 0;
403 404

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

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

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

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

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

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

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

488
	#print "coff<$coff> soff<$off> loff<$loff>\n";
489 490 491 492 493

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

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 534 535 536
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;
	}
}

537 538 539 540 541 542
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

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

	return ($level, $linenr, @chunks);
564 565
}

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

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

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

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

596
		if (!$outer || $level <= 1) {
597
			push(@res, $rawlines[$line]);
598 599
		}

600
		last if ($level == 0);
601 602
	}

603
	return ($level, @res);
604 605 606 607
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

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

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

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

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

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
633 634 635 636 637

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

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

670
	##print "LINE: $rawlines[$end_line - 1 ]\n";
671 672 673 674 675
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

676 677 678
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
679

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

690
	return $res;
691 692
}

693
my $av_preprocessor = 0;
694
my $av_pending;
695
my @av_paren_type;
696
my $av_pend_colon;
697 698 699

sub annotate_reset {
	$av_preprocessor = 0;
700 701
	$av_pending = '_';
	@av_paren_type = ('E');
702
	$av_pend_colon = 'O';
703 704
}

705 706
sub annotate_values {
	my ($stream, $type) = @_;
707

708
	my $res;
709
	my $var = '_' x length($stream);
710 711
	my $cur = $stream;

712
	print "$stream\n" if ($dbg_values > 1);
713 714

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

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

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

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

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

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

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
753
			$type = 'E';
754

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

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

761
			$type = 'E';
762

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

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

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

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

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

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

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

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

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

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

824 825 826 827 828 829 830 831 832
		} 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';

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

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

841
		} elsif ($cur =~/^(;|{|})/) {
842
			print "END($1)\n" if ($dbg_values > 1);
843
			$type = 'E';
844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859
			$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';
860

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

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

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

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

893
	return ($res, $var);
894 895
}

896
sub possible {
897
	my ($possible, $line) = @_;
898

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

		} else {
			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
			push(@typeList, $possible);
		}
921 922 923 924
		build_types();
	}
}

925 926
my $prefix = '';

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

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

935
	push(our @report, $line);
936 937

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

961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987
sub check_absolute_file {
	my ($absolute, $herecurr) = @_;
	my $file = $absolute;

	##print "absolute<$absolute>\n";

	# See if any suffix of this path is a path within the tree.
	while ($file =~ s@^[^/]*/@@) {
		if (-f "$root/$file") {
			##print "file<$file>\n";
			last;
		}
	}
	if (! -f _)  {
		return 0;
	}

	# It is, so see if the prefix is acceptable.
	my $prefix = $absolute;
	substr($prefix, -length($file)) = '';

	##print "prefix<$prefix>\n";
	if ($prefix ne ".../") {
		WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr);
	}
}

988 989 990 991 992
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
993
	my $prevrawline="";
994
	my $stashline="";
995
	my $stashrawline="";
996

997
	my $length;
998 999 1000 1001
	my $indent;
	my $previndent=0;
	my $stashindent=0;

1002
	our $clean = 1;
1003 1004 1005
	my $signoff = 0;
	my $is_patch = 0;

1006
	our @report = ();
1007 1008 1009 1010 1011
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

1012 1013 1014 1015 1016 1017
	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
	my $in_comment = 0;
1018
	my $comment_edge = 0;
1019 1020
	my $first_line = 0;

1021 1022 1023
	my $prev_values = 'E';

	# suppression flags
1024
	my %suppress_ifbraces;
1025

1026
	# Pre-scan the patch sanitizing the lines.
1027
	# Pre-scan the patch looking for any __setup documentation.
1028
	#
1029 1030
	my @setup_docs = ();
	my $setup_docs = 0;
1031 1032

	sanitise_line_reset();
1033 1034
	my $line;
	foreach my $rawline (@rawlines) {
1035 1036
		$linenr++;
		$line = $rawline;
1037

1038
		if ($rawline=~/^\+\+\+\s+(\S+)/) {
1039 1040 1041 1042
			$setup_docs = 0;
			if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
				$setup_docs = 1;
			}
1043 1044 1045 1046 1047 1048 1049 1050 1051
			#next;
		}
		if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1052
			$in_comment = 0;
1053 1054 1055 1056 1057 1058

			# 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;
1059 1060 1061 1062 1063 1064 1065 1066
			my $cnt = $realcnt;
			for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
				next if (defined $rawlines[$ln - 1] &&
					 $rawlines[$ln - 1] =~ /^-/);
				$cnt--;
				#print "RAW<$rawlines[$ln - 1]>\n";
				($edge) = (defined $rawlines[$ln - 1] &&
					$rawlines[$ln - 1] =~ m@(/\*|\*/)@);
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
				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);

1085
		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1086
			# Standardise the strings and chars within the input to
1087
			# simplify matching -- only bother with positive lines.
1088
			$line = sanitise_line($rawline);
1089
		}
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099
		push(@lines, $line);

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

		#print "==>$rawline\n";
		#print "-->$line\n";
1100 1101 1102 1103 1104 1105

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

1106 1107
	$prefix = '';

1108 1109
	$realcnt = 0;
	$linenr = 0;
1110 1111 1112
	foreach my $line (@lines) {
		$linenr++;

1113
		my $rawline = $rawlines[$linenr - 1];
1114

1115
#extract the line range in the file after the patch is applied
1116
		if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1117
			$is_patch = 1;
1118
			$first_line = $linenr + 1;
1119 1120 1121 1122 1123 1124
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1125
			annotate_reset();
1126 1127
			$prev_values = 'E';

1128
			%suppress_ifbraces = ();
1129 1130
			next;

1131 1132 1133
# 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.
1134
		} elsif ($line =~ /^( |\+|$)/) {
1135
			$realline++;
1136
			$realcnt-- if ($realcnt != 0);
1137

1138
			# Measure the line length and indent.
1139
			($length, $indent) = line_stats($rawline);
1140 1141 1142 1143

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

1146
			#warn "line<$line>\n";
1147

1148 1149
		} elsif ($realcnt == 1) {
			$realcnt--;
1150 1151 1152
		}

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

1156 1157
		$here = "#$linenr: " if (!$file);
		$here = "#$realline: " if ($file);
1158 1159 1160 1161 1162 1163

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

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

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

1172 1173 1174
		my $hereline = "$here\n$rawline\n";
		my $herecurr = "$here\n$rawline\n";
		my $hereprev = "$here\n$prevrawline\n$rawline\n";
1175

1176 1177
		$cnt_lines++ if ($realcnt != 0);

1178
#check the patch for a signoff:
1179
		if ($line =~ /^\s*signed-off-by:/i) {
1180 1181
			# This is a signoff, if ugly, so do not double report.
			$signoff++;
1182
			if (!($line =~ /^\s*Signed-off-by:/)) {
1183 1184
				WARN("Signed-off-by: is the preferred form\n" .
					$herecurr);
1185 1186
			}
			if ($line =~ /^\s*signed-off-by:\S/i) {
1187
				WARN("space required after Signed-off-by:\n" .
1188
					$herecurr);
1189 1190 1191
			}
		}

1192
# Check for wrappage within a valid hunk of the file
1193
		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1194
			ERROR("patch seems to be corrupt (line wrapped?)\n" .
1195
				$herecurr) if (!$emitted_corrupt++);
1196 1197
		}

1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
# Check for absolute kernel paths.
		if ($tree) {
			while ($line =~ m{(?:^|\s)(/\S*)}g) {
				my $file = $1;

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

1212 1213
# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1214 1215 1216 1217 1218 1219 1220 1221
		    $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);
1222 1223 1224 1225
		}

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

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

#trailing whitespace
1231
		if ($line =~ /^\+.*\015/) {
1232
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1233 1234
			ERROR("DOS line endings\n" . $herevet);

1235 1236
		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1237
			ERROR("trailing whitespace\n" . $herevet);
1238 1239
		}
#80 column limit
1240
		if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1241 1242 1243
		    $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
		    $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
		    $length > 80)
1244
		{
1245
			WARN("line over 80 characters\n" . $herecurr);
1246 1247
		}

1248 1249 1250 1251 1252
# 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);
		}

1253 1254 1255 1256 1257
# 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.
1258 1259 1260
		if ($rawline =~ /^\+\s* \t\s*\S/ ||
		    $rawline =~ /^\+\s*        \s*/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1261
			ERROR("code indent should use tabs where possible\n" . $herevet);
1262 1263
		}

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

1269
# Check for potential 'bare' types
1270
		my ($stat, $cond, $line_nr_next, $remain_next);
1271
		if ($realcnt && $line =~ /.\s*\S/) {
1272 1273
			($stat, $cond, $line_nr_next, $remain_next) =
				ctx_statement_block($linenr, $realcnt, 0);
1274 1275 1276 1277 1278
			$stat =~ s/\n./\n /g;
			$cond =~ s/\n./\n /g;

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

1280
			# Ignore goto labels.
1281
			if ($s =~ /$Ident:\*$/s) {
1282 1283

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

1286
			# declarations always start with types
1287
			} 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) {
1288 1289 1290 1291
				my $type = $1;
				$type =~ s/\s+/ /g;
				possible($type, "A:" . $s);

1292
			# definitions in global scope can only start with types
1293
			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b/s) {
1294
				possible($1, "B:" . $s);
1295
			}
1296 1297

			# any (foo ... *) is a pointer cast, and foo is a type
1298
			while ($s =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/sg) {
1299
				possible($1, "C:" . $s);
1300 1301 1302 1303 1304
			}

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

1308
				my $ctx = $s;
1309
				substr($ctx, 0, $name_len + 1, '');
1310
				$ctx =~ s/\)[^\)]*$//;
1311

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

1315
						possible($1, "D:" . $s);
1316 1317
					}
				}
1318
			}
1319

1320 1321
		}

1322 1323 1324
#
# Checks which may be anchored in the context.
#
1325

1326 1327
# Check for switch () and associated case and default
# statements should be at the same indent.
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343
		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 '') {
1344
				ERROR("switch and case should be at the same indent\n$hereline$err");
1345 1346
			}
		}
1347
		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
1348 1349 1350 1351 1352
		    $line !~ /\G(?:
			(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
			\s*return\s+
		    )/xg)
		{
1353 1354
			ERROR("trailing statements should be on next line\n" . $herecurr);
		}
1355 1356 1357

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

1361
			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
1362 1363 1364
			my $ctx_cnt = $realcnt - $#ctx - 1;
			my $ctx = join("\n", @ctx);

1365 1366
			my $ctx_ln = $linenr;
			my $ctx_skip = $realcnt;
1367

1368 1369 1370 1371 1372
			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] !~ /^-/);
1373 1374
				$ctx_ln++;
			}
1375

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

1379 1380
			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
				ERROR("that open brace { should be on the previous line\n" .
1381
					"$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1382
			}
1383 1384 1385 1386
			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
			    $ctx =~ /\)\s*\;\s*$/ &&
			    defined $lines[$ctx_ln - 1])
			{
1387 1388
				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
				if ($nindent > $indent) {
1389
					WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
1390
						"$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1391 1392
				}
			}
1393 1394
		}

1395 1396
		# Track the 'values' across context and added lines.
		my $opline = $line; $opline =~ s/^./ /;
1397 1398
		my ($curr_values, $curr_vars) =
				annotate_values($opline . "\n", $prev_values);
1399
		$curr_values = $prev_values . $curr_values;
1400 1401
		if ($dbg_values) {
			my $outline = $opline; $outline =~ s/\t/ /g;
1402 1403
			print "$linenr > .$outline\n";
			print "$linenr > $curr_values\n";
1404
			print "$linenr >  $curr_vars\n";
1405
		}
1406 1407
		$prev_values = substr($curr_values, -1);

1408 1409 1410
#ignore lines not being added
		if ($line=~/^[^\+]/) {next;}

1411
# TEST: allow direct testing of the type matcher.
1412 1413 1414 1415 1416 1417
		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);
			}
1418 1419
			next;
		}
1420 1421 1422 1423 1424 1425 1426 1427 1428
# 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;
		}
1429

1430 1431 1432
# check for initialisation to aggregates open brace on the next line
		if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
		    $line =~ /^.\s*{/) {
1433
			ERROR("that open brace { should be on the previous line\n" . $hereprev);
1434 1435
		}

1436 1437 1438 1439 1440
#
# Checks which are anchored on the added line.
#

# check for malformed paths in #include statements (uses RAW line)
1441
		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
1442 1443
			my $path = $1;
			if ($path =~ m{//}) {
1444 1445
				ERROR("malformed #include filename\n" .
					$herecurr);
1446 1447
			}
		}
1448

1449
# no C99 // comments
1450
		if ($line =~ m{//}) {
1451
			ERROR("do not use C99 // comments\n" . $herecurr);
1452
		}
1453
		# Remove C99 comments.
1454
		$line =~ s@//.*@@;
1455
		$opline =~ s@//.*@@;
1456 1457

#EXPORT_SYMBOL should immediately follow its function closing }.
1458 1459 1460
		if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
		    ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
			my $name = $1;
1461 1462
			if (($prevline !~ /^}/) &&
			   ($prevline !~ /^\+}/) &&
1463
			   ($prevline !~ /^ }/) &&
1464 1465
			   ($prevline !~ /^.DECLARE_$Ident\(\Q$name\E\)/) &&
			   ($prevline !~ /^.LIST_HEAD\(\Q$name\E\)/) &&
1466
			   ($prevline !~ /^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(/) &&
1467
			   ($prevline !~ /\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)/)) {
1468
				WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
1469 1470 1471
			}
		}

1472
# check for external initialisers.
1473
		if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
1474 1475 1476
			ERROR("do not initialise externals to 0 or NULL\n" .
				$herecurr);
		}
1477
# check for static initialisers.
1478
		if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) {
1479 1480
			ERROR("do not initialise statics to 0 or NULL\n" .
				$herecurr);
1481 1482
		}

1483 1484 1485
# check for new typedefs, only function parameters and sparse annotations
# make sense.
		if ($line =~ /\btypedef\s/ &&
1486
		    $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ &&
1487
		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
1488
		    $line !~ /\b__bitwise(?:__|)\b/) {
1489
			WARN("do not add new typedefs\n" . $herecurr);
1490 1491 1492
		}

# * goes on variable not on type
1493
		if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) {
1494 1495
			ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" .
				$herecurr);
1496 1497

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

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

1505
		} elsif ($line =~ m{\b$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) {
1506 1507
			ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" .
				$herecurr);
1508 1509 1510 1511 1512 1513 1514 1515 1516
		}

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

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

1521 1522 1523 1524 1525
# 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.
1526
		if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539
			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) {
1540
				WARN("printk() should include KERN_ facility level\n" . $herecurr);
1541
			}
1542 1543
		}

1544 1545
# function brace can't be on same line, except for #defines of do while,
# or if closed on same line
1546 1547
		if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
		    !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
1548
			ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
1549
		}
1550

1551 1552 1553 1554 1555 1556
# 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);
		}

1557 1558
# check for spacing round square brackets; allowed:
#  1. with a type on the left -- int [] a;
1559 1560
#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
#  3. inside a curly brace -- = { [0...10] = 5 }
1561 1562 1563
		while ($line =~ /(.*?\s)\[/g) {
			my ($where, $prefix) = ($-[1], $1);
			if ($prefix !~ /$Type\s+$/ &&
1564 1565
			    ($where != 0 || $prefix !~ /^.\s+$/) &&
			    $prefix !~ /{\s+$/) {
1566 1567 1568 1569
				ERROR("space prohibited before open square bracket '['\n" . $herecurr);
			}
		}

1570
# check for spaces between functions and their parentheses.
1571
		while ($line =~ /($Ident)\s+\(/g) {
1572
			my $name = $1;
1573 1574
			my $ctx_before = substr($line, 0, $-[1]);
			my $ctx = "$ctx_before$name";
1575 1576

			# Ignore those directives where spaces _are_ permitted.
1577 1578 1579 1580 1581 1582
			if ($name =~ /^(?:
				if|for|while|switch|return|case|
				volatile|__volatile__|
				__attribute__|format|__extension__|
				asm|__asm__)$/x)
			{
1583 1584 1585 1586

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

			# cpp #elif statement condition may start with a (
1590
			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
1591 1592 1593

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

			} else {
1597
				WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
1598
			}
1599
		}
1600
# Check operator spacing.
1601
		if (!($line=~/\#\s*include/)) {
1602 1603 1604 1605
			my $ops = qr{
				<<=|>>=|<=|>=|==|!=|
				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
				=>|->|<<|>>|<|>|=|!|~|
1606 1607
				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
				\?|:
1608
			}x;
1609
			my @elements = split(/($ops|;)/, $opline);
1610
			my $off = 0;
1611 1612 1613

			my $blank = copy_spacing($opline);

1614
			for (my $n = 0; $n < $#elements; $n += 2) {
1615 1616
				$off += length($elements[$n]);

1617 1618 1619 1620 1621 1622 1623 1624
				# 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";

1625 1626 1627
				my $a = '';
				$a = 'V' if ($elements[$n] ne '');
				$a = 'W' if ($elements[$n] =~ /\s$/);
1628
				$a = 'C' if ($elements[$n] =~ /$;$/);
1629 1630
				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
				$a = 'O' if ($elements[$n] eq '');
1631
				$a = 'E' if ($ca =~ /^\s*$/);
1632

1633
				my $op = $elements[$n + 1];
1634 1635

				my $c = '';
1636
				if (defined $elements[$n + 2]) {
1637 1638
					$c = 'V' if ($elements[$n + 2] ne '');
					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
1639
					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
1640 1641
					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
					$c = 'O' if ($elements[$n + 2] eq '');
1642
					$c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
1643 1644
				} else {
					$c = 'E';
1645 1646
				}

1647 1648 1649 1650
				my $ctx = "${a}x${c}";

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

1651
				my $ptr = substr($blank, 0, $off) . "^";
1652
				my $hereptr = "$hereline$ptr\n";
1653

1654
				# Pull out the value of this operator.
1655
				my $op_type = substr($curr_values, $off + 1, 1);
1656

1657 1658 1659
				# Get the full operator variant.
				my $opv = $op . substr($curr_vars, $off, 1);

1660 1661 1662 1663
				# Ignore operators passed as parameters.
				if ($op_type ne 'V' &&
				    $ca =~ /\s$/ && $cc =~ /^\s*,/) {

1664 1665
#				# Ignore comments
#				} elsif ($op =~ /^$;+$/) {
1666

1667
				# ; should have either the end of line or a space or \ after it
1668
				} elsif ($op eq ';') {
1669 1670
					if ($ctx !~ /.x[WEBC]/ &&
					    $cc !~ /^\\/ && $cc !~ /^;/) {
1671
						ERROR("space required after that '$op' $at\n" . $hereptr);
1672 1673 1674 1675
					}

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

1677 1678 1679 1680
				# No spaces for:
				#   ->
				#   :   when part of a bitfield
				} elsif ($op eq '->' || $opv eq ':B') {
1681
					if ($ctx =~ /Wx.|.xW/) {
1682
						ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
1683 1684 1685 1686
					}

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

1691
				# '*' as part of a type definition -- reported already.
1692
				} elsif ($opv eq '*_') {
1693 1694 1695 1696 1697 1698
					#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 '~' ||
1699
					 $opv eq '*U' || $opv eq '-U' ||
1700
					 $opv eq '&U' || $opv eq '&&U') {
1701
					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
1702
						ERROR("space required before that '$op' $at\n" . $hereptr);
1703
					}
1704
					if ($op eq '*' && $cc =~/\s*const\b/) {
1705 1706 1707
						# A unary '*' may be const

					} elsif ($ctx =~ /.xW/) {
1708
						ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1709 1710 1711 1712
					}

				# unary ++ and unary -- are allowed no space on one side.
				} elsif ($op eq '++' or $op eq '--') {
1713 1714 1715 1716 1717 1718
					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);
1719
					}
1720 1721
					if ($ctx =~ /ExW/) {
						ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1722
					}
1723

1724

1725
				# << and >> may either have or not have spaces both sides
1726 1727 1728
				} elsif ($op eq '<<' or $op eq '>>' or
					 $op eq '&' or $op eq '^' or $op eq '|' or
					 $op eq '+' or $op eq '-' or
1729 1730
					 $op eq '*' or $op eq '/' or
					 $op eq '%')
1731
				{
1732
					if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
1733 1734
						ERROR("need consistent spacing around '$op' $at\n" .
							$hereptr);
1735 1736
					}

1737 1738 1739 1740 1741 1742 1743
				# 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);
					}

1744
				# All the others need spaces both sides.
1745
				} elsif ($ctx !~ /[EWC]x[CWE]/) {
1746 1747
					my $ok = 0;

1748
					# Ignore email addresses <foo@bar>
1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763
					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) {
1764
						ERROR("spaces required around that '$op' $at\n" . $hereptr);
1765
					}
1766
				}
1767
				$off += length($elements[$n + 1]);
1768 1769 1770
			}
		}

1771 1772
# check for multiple assignments
		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
1773
			CHK("multiple assignments should be avoided\n" . $herecurr);
1774 1775
		}

1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789
## # 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);
## 			}
## 		}
1790

1791
#need space before brace following if, while, etc
1792 1793
		if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
		    $line =~ /do{/) {
1794
			ERROR("space required before the open brace '{'\n" . $herecurr);
1795 1796 1797 1798 1799
		}

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

1803 1804
# check spacing on square brackets
		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
1805
			ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
1806 1807
		}
		if ($line =~ /\s\]/) {
1808
			ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
1809 1810
		}

1811
# check spacing on parentheses
1812 1813
		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
		    $line !~ /for\s*\(\s+;/) {
1814
			ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
1815
		}
1816
		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
1817 1818
		    $line !~ /for\s*\(.*;\s+\)/ &&
		    $line !~ /:\s+\)/) {
1819
			ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
1820 1821
		}

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

1828 1829 1830 1831 1832 1833
# Return is not a function.
		if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
			my $spacing = $1;
			my $value = $2;

			# Flatten any parentheses and braces
1834
			$value =~ s/\)\(/\) \(/g;
1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845
			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);
			}
		}

1846
# Need a space before open parenthesis after if, while etc
1847
		if ($line=~/\b(if|while|for|switch)\(/) {
1848
			ERROR("space required before the open parenthesis '('\n" . $herecurr);
1849 1850
		}

1851 1852
# Check for illegal assignment in if conditional -- and check for trailing
# statements after the conditional.
1853
		if ($line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
1854
			my ($s, $c) = ($stat, $cond);
1855 1856

			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
1857
				ERROR("do not use assignment in if condition\n" . $herecurr);
1858 1859 1860 1861
			}

			# Find out what is on the end of the line after the
			# conditional.
1862
			substr($s, 0, length($c), '');
1863
			$s =~ s/\n.*//g;
1864
			$s =~ s/$;//g; 	# Remove any comments
1865 1866
			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
			    $c !~ /}\s*while\s*/)
1867
			{
1868 1869 1870 1871
				ERROR("trailing statements should be on next line\n" . $herecurr);
			}
		}

1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911
# 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;
			}

1912 1913 1914 1915 1916
			# Ignore the current line if it is label.
			if ($s =~ /^\s*$Ident\s*:/) {
				$check = 0;
			}

1917 1918 1919 1920 1921 1922 1923 1924 1925 1926
			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);
			}
		}

1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941
# 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);
		}

1942
# if and else should not have general statements after it
1943 1944 1945 1946 1947 1948
		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);
			}
1949 1950 1951 1952 1953 1954
		}

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

1958 1959 1960 1961 1962 1963
		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.
1964
			substr($s, 0, length($c), '');
1965 1966 1967 1968 1969 1970 1971
			$s =~ s/\n.*//g;

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

1972 1973 1974 1975 1976 1977 1978 1979
#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
1980
		if ($line=~/\#\s*define.*\\\s$/) {
1981
			WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
1982 1983
		}

1984
#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
1985
		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
1986 1987 1988 1989
			my $file = "$1.h";
			my $checkfile = "include/linux/$file";
			if (-f "$root/$checkfile" &&
			    $realfile ne $checkfile &&
1990 1991
			    $1 ne 'irq')
			{
1992 1993 1994 1995 1996
				if ($realfile =~ m{^arch/}) {
					CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
				} else {
					WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
				}
1997 1998 1999
			}
		}

2000 2001
# 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
2002
# in a known good container
2003 2004
		if ($realfile !~ m@/vmlinux.lds.h$@ &&
		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2005 2006
			my $ln = $linenr;
			my $cnt = $realcnt;
2007 2008
			my ($off, $dstat, $dcond, $rest);
			my $ctx = '';
2009

2010 2011 2012 2013 2014 2015 2016 2017
			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";
2018
				$cnt-- if ($lines[$ln - 1] !~ /^-/);
2019 2020 2021 2022 2023 2024 2025
				$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";
2026
			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2027 2028 2029 2030

			# Extract the remainder of the define (if any) and
			# rip off surrounding spaces, and trailing \'s.
			$rest = '';
2031 2032
			while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
				#print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
2033 2034 2035 2036
				if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
					$rest .= substr($lines[$ln - 1], $off) . "\n";
					$cnt--;
				}
2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048
				$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*//;
2049
			}
2050
			$dstat =~ s/$;//g;
2051 2052 2053
			$dstat =~ s/\\\n.//g;
			$dstat =~ s/^\s*//s;
			$dstat =~ s/\s*$//s;
2054

2055 2056 2057 2058
			# Flatten any parentheses and braces
			while ($dstat =~ s/\([^\(\)]*\)/1/) {
			}
			while ($dstat =~ s/\{[^\{\}]*\}/1/) {
2059
			}
2060

2061 2062 2063 2064 2065 2066 2067 2068
			my $exceptions = qr{
				$Declare|
				module_param_named|
				MODULE_PARAM_DESC|
				DECLARE_PER_CPU|
				DEFINE_PER_CPU|
				__typeof__\(
			}x;
2069
			#print "REST<$rest>\n";
2070 2071 2072 2073
			if ($rest ne '') {
				if ($rest !~ /while\s*\(/ &&
				    $dstat !~ /$exceptions/)
				{
2074
					ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
2075 2076 2077 2078 2079 2080 2081 2082
				}

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

2088
# check for redundant bracing round if etc
2089 2090
		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
			my ($level, $endln, @chunks) =
2091
				ctx_statement_full($linenr, $realcnt, 1);
2092
			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2093 2094
			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
			if ($#chunks > 0 && $level == 0) {
2095 2096
				my $allowed = 0;
				my $seen = 0;
2097
				my $herectx = $here . "\n";
2098
				my $ln = $linenr - 1;
2099 2100 2101
				for my $chunk (@chunks) {
					my ($cond, $block) = @{$chunk};

2102 2103 2104 2105 2106 2107 2108 2109 2110 2111
					# 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";
2112 2113
					$ln += statement_rawlines($block) - 1;

2114
					substr($block, 0, length($cond), '');
2115 2116 2117

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

2118 2119 2120
					#print "cond<$cond> block<$block> allowed<$allowed>\n";
					if (statement_lines($cond) > 1) {
						#print "APW: ALLOWED: cond<$cond>\n";
2121 2122 2123
						$allowed = 1;
					}
					if ($block =~/\b(?:if|for|while)\b/) {
2124
						#print "APW: ALLOWED: block<$block>\n";
2125 2126
						$allowed = 1;
					}
2127 2128
					if (statement_block_size($block) > 1) {
						#print "APW: ALLOWED: lines block<$block>\n";
2129 2130 2131 2132
						$allowed = 1;
					}
				}
				if ($seen && !$allowed) {
2133
					WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
2134 2135 2136
				}
			}
		}
2137
		if (!defined $suppress_ifbraces{$linenr - 1} &&
2138
					$line =~ /\b(if|while|for|else)\b/) {
2139 2140 2141 2142 2143 2144 2145
			my $allowed = 0;

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

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

2150 2151
			# Check the condition.
			my ($cond, $block) = @{$chunks[0]};
2152
			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
2153
			if (defined $cond) {
2154
				substr($block, 0, length($cond), '');
2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171
			}
			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) {
2172
					substr($block, 0, length($cond), '');
2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184
				}
				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";;
2185
				}
2186 2187

				WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
2188 2189 2190
			}
		}

2191
# don't include deprecated include files (uses RAW line)
2192
		for my $inc (@dep_includes) {
2193
			if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
2194
				ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2195 2196 2197
			}
		}

2198 2199
# don't use deprecated functions
		for my $func (@dep_functions) {
2200
			if ($line =~ /\b$func\b/) {
2201
				ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2202 2203 2204 2205
			}
		}

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

2211 2212 2213 2214 2215
# 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);
		}

2216
# warn about #if 0
2217
		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
2218 2219
			CHK("if this code is redundant consider removing it\n" .
				$herecurr);
2220 2221
		}

2222 2223 2224 2225
# check for needless kfree() checks
		if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
			my $expr = $1;
			if ($line =~ /\bkfree\(\Q$expr\E\);/) {
2226
				WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
2227 2228
			}
		}
2229 2230 2231 2232 2233 2234 2235
# 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);
			}
		}
2236

2237
# warn about #ifdefs in C files
2238
#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
2239 2240 2241 2242 2243
#			print "#ifdef in C files should be avoided\n";
#			print "$herecurr";
#			$clean = 0;
#		}

2244
# warn about spacing in #ifdefs
2245
		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
2246 2247 2248
			ERROR("exactly one space required after that #$1\n" . $herecurr);
		}

2249
# check for spinlock_t definitions without a comment.
2250 2251
		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
2252 2253
			my $which = $1;
			if (!ctx_has_comment($first_line, $linenr)) {
2254
				CHK("$1 definition without comment\n" . $herecurr);
2255 2256 2257 2258 2259
			}
		}
# 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)) {
2260
				CHK("memory barrier without comment\n" . $herecurr);
2261 2262 2263
			}
		}
# check of hardware specific defines
2264
		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
2265
			CHK("architecture specific defines should be avoided\n" .  $herecurr);
2266
		}
2267

2268 2269
# check the location of the inline attribute, that it is between
# storage class and type.
2270 2271
		if ($line =~ /\b$Type\s+$Inline\b/ ||
		    $line =~ /\b$Inline\s+$Storage\b/) {
2272 2273 2274
			ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
		}

2275 2276 2277 2278 2279
# Check for __inline__ and __inline, prefer inline
		if ($line =~ /\b(__inline__|__inline)\b/) {
			WARN("plain inline is preferred over $1\n" . $herecurr);
		}

2280
# check for new externs in .c files.
2281
		if ($realfile =~ /\.c$/ && defined $stat &&
2282
		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
2283
		{
2284 2285
			my $function_name = $1;
			my $paren_space = $2;
2286 2287 2288 2289 2290

			my $s = $stat;
			if (defined $cond) {
				substr($s, 0, length($cond), '');
			}
2291 2292 2293
			if ($s =~ /^\s*;/ &&
			    $function_name ne 'uninitialized_var')
			{
2294 2295 2296 2297 2298 2299
				WARN("externs should be avoided in .c files\n" .  $herecurr);
			}

			if ($paren_space =~ /\n/) {
				WARN("arguments for function declarations should follow identifier\n" . $herecurr);
			}
2300 2301 2302 2303 2304

		} elsif ($realfile =~ /\.c$/ && defined $stat &&
		    $stat =~ /^.\s*extern\s+/)
		{
			WARN("externs should be avoided in .c files\n" .  $herecurr);
2305 2306 2307 2308 2309 2310 2311 2312 2313
		}

# 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);
			}
2314
		}
2315 2316 2317 2318 2319

# 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);
		}
2320 2321 2322 2323 2324

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

# check for semaphores used as mutexes
2327
		if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
2328 2329 2330
			WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
		}
# check for semaphores used as mutexes
2331
		if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
2332 2333 2334 2335 2336 2337
			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);
		}
2338 2339 2340 2341
# check for __initcall(), use device_initcall() explicitly please
		if ($line =~ /^.\s*__initcall\s*\(/) {
			WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
		}
2342 2343 2344 2345

# 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/ &&
2346 2347
		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
2348 2349 2350
		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
2351 2352 2353
		{
			WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
		}
2354 2355 2356 2357 2358 2359 2360 2361 2362 2363

# 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;
			}
		}
2364 2365 2366 2367 2368 2369
	}

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

2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384
	# 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) {
2385
		ERROR("Does not appear to be a unified-diff format patch\n");
2386 2387
	}
	if ($is_patch && $chk_signoff && $signoff == 0) {
2388
		ERROR("Missing Signed-off-by: line(s)\n");
2389 2390
	}

2391
	print report_dump();
2392 2393
	if ($summary && !($clean == 1 && $quiet == 1)) {
		print "$filename " if ($summary_file);
2394 2395 2396 2397
		print "total: $cnt_error errors, $cnt_warn warnings, " .
			(($check)? "$cnt_chk checks, " : "") .
			"$cnt_lines lines checked\n";
		print "\n" if ($quiet == 0);
2398
	}
2399

2400
	if ($clean == 1 && $quiet == 0) {
2401
		print "$vname has no obvious style problems and is ready for submission.\n"
2402 2403
	}
	if ($clean == 0 && $quiet == 0) {
2404
		print "$vname has style problems, please review.  If any of these errors\n";
2405 2406 2407
		print "are false positives report them to the maintainer, see\n";
		print "CHECKPATCH in MAINTAINERS.\n";
	}
2408

2409 2410
	return $clean;
}