checkpatch.pl 60.4 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.20';
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 70 71 72
for my $key (keys %debug) {
	eval "\${dbg_$key} = '$debug{$key}';"
}

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

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

98 99 100 101 102 103 104 105 106 107 108
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|
109
			__kprobes
110 111 112 113 114 115 116
		}x;
our $Attribute	= qr{
			const|
			__read_mostly|
			__kprobes|
			__(?:mem|cpu|dev|)(?:initdata|init)
		  }x;
117
our $Modifier;
118 119 120 121 122 123 124 125 126
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
our $NonptrType;
our $Type;
our $Declare;

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

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

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

$chk_signoff = 0 if ($file);

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

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

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

exit($exit);

sub top_of_kernel_tree {
245 246 247 248 249 250 251 252 253 254 255 256
	my ($root) = @_;

	my @tree_check = (
		"COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
		"README", "Documentation", "arch", "include", "drivers",
		"fs", "init", "ipc", "kernel", "lib", "scripts",
	);

	foreach my $check (@tree_check) {
		if (! -e $root . '/' . $check) {
			return 0;
		}
257
	}
258
	return 1;
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
}

sub expand_tabs {
	my ($str) = @_;

	my $res = '';
	my $n = 0;
	for my $c (split(//, $str)) {
		if ($c eq "\t") {
			$res .= ' ';
			$n++;
			for (; ($n % 8) != 0; $n++) {
				$res .= ' ';
			}
			next;
		}
		$res .= $c;
		$n++;
	}

	return $res;
}
281
sub copy_spacing {
282
	(my $res = shift) =~ tr/\t/ /c;
283 284
	return $res;
}
285

286 287 288 289 290 291 292 293 294 295 296 297 298
sub line_stats {
	my ($line) = @_;

	# Drop the diff line leader and expand tabs
	$line =~ s/^.//;
	$line = expand_tabs($line);

	# Pick the indent from the front of the line.
	my ($white) = ($line =~ /^(\s*)/);

	return (length($line), length($white));
}

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

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

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

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

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

320 321 322 323 324 325 326 327 328 329 330 331 332 333
	# Always copy over the diff marker.
	$res = substr($line, 0, 1);

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

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

			substr($res, $off, 2, "$;$;");
			$off++;
			next;
334
		}
335
		if (substr($line, $off, 2) eq '*/') {
336 337 338 339
			$sanitise_quote = '';
			substr($res, $off, 2, "$;$;");
			$off++;
			next;
340
		}
341 342 343 344 345 346 347

		# A \ in a string means ignore the next character.
		if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
		    $c eq "\\") {
			substr($res, $off, 2, 'XX');
			$off++;
			next;
348
		}
349 350 351 352
		# Regular quotes.
		if ($c eq "'" || $c eq '"') {
			if ($sanitise_quote eq '') {
				$sanitise_quote = $c;
353

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

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

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

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

382 383 384
	return $res;
}

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

393 394
	my $loff = 0;

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

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

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

433
		# An else is really a conditional as long as its not else if
434 435 436 437 438 439 440 441
		if ($level == 0 && $coff_set == 0 &&
				(!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
				$remainder =~ /^(else)(?:\s|{)/ &&
				$remainder !~ /^else\s+if\b/) {
			$coff = $off + length($1) - 1;
			$coff_set = 1;
			#warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
			#warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
442 443
		}

444 445 446 447 448 449 450 451 452 453
		if (($type eq '' || $type eq '(') && $c eq '(') {
			$level++;
			$type = '(';
		}
		if ($type eq '(' && $c eq ')') {
			$level--;
			$type = ($level != 0)? '(' : '';

			if ($level == 0 && $coff < $soff) {
				$coff = $off;
454 455
				$coff_set = 1;
				#warn "CSB: mark coff<$coff>\n";
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
			}
		}
		if (($type eq '' || $type eq '{') && $c eq '{') {
			$level++;
			$type = '{';
		}
		if ($type eq '{' && $c eq '}') {
			$level--;
			$type = ($level != 0)? '{' : '';

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

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

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

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

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

491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
sub statement_lines {
	my ($stmt) = @_;

	# Strip the diff line prefixes and rip blank lines at start and end.
	$stmt =~ s/(^|\n)./$1/g;
	$stmt =~ s/^\s*//;
	$stmt =~ s/\s*$//;

	my @stmt_lines = ($stmt =~ /\n/g);

	return $#stmt_lines + 2;
}

sub statement_rawlines {
	my ($stmt) = @_;

	my @stmt_lines = ($stmt =~ /\n/g);

	return $#stmt_lines + 2;
}

sub statement_block_size {
	my ($stmt) = @_;

	$stmt =~ s/(^|\n)./$1/g;
	$stmt =~ s/^\s*{//;
	$stmt =~ s/}\s*$//;
	$stmt =~ s/^\s*//;
	$stmt =~ s/\s*$//;

	my @stmt_lines = ($stmt =~ /\n/g);
	my @stmt_statements = ($stmt =~ /;/g);

	my $stmt_lines = $#stmt_lines + 2;
	my $stmt_statements = $#stmt_statements + 1;

	if ($stmt_lines > $stmt_statements) {
		return $stmt_lines;
	} else {
		return $stmt_statements;
	}
}

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

	my (@chunks);

540
	# Grab the first conditional/block pair.
541 542
	($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
543
	#print "F: c<$condition> s<$statement> remain<$remain>\n";
544 545 546 547 548 549 550
	push(@chunks, [ $condition, $statement ]);
	if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
		return ($level, $linenr, @chunks);
	}

	# Pull in the following conditional/block pairs and see if they
	# could continue the statement.
551 552 553
	for (;;) {
		($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
554
		#print "C: c<$condition> s<$statement> remain<$remain>\n";
555
		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
556 557
		#print "C: push\n";
		push(@chunks, [ $condition, $statement ]);
558 559 560
	}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	# Catch a comment on the end of the line itself.
635
	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
636 637 638 639 640 641 642
	return $current_comment if (defined $current_comment);

	# Look through the context and try and figure out if there is a
	# comment.
	my $in_comment = 0;
	$current_comment = '';
	for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
643 644
		my $line = $rawlines[$linenr - 1];
		#warn "           $line\n";
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
		if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
			$in_comment = 1;
		}
		if ($line =~ m@/\*@) {
			$in_comment = 1;
		}
		if (!$in_comment && $current_comment ne '') {
			$current_comment = '';
		}
		$current_comment .= $line . "\n" if ($in_comment);
		if ($line =~ m@\*/@) {
			$in_comment = 0;
		}
	}

	chomp($current_comment);
	return($current_comment);
}
sub ctx_has_comment {
	my ($first_line, $end_line) = @_;
	my $cmt = ctx_locate_comment($first_line, $end_line);

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

	return ($cmt ne '');
}

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

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

687
	return $res;
688 689
}

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

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

700 701
sub annotate_values {
	my ($stream, $type) = @_;
702

703 704 705
	my $res;
	my $cur = $stream;

706
	print "$stream\n" if ($dbg_values > 1);
707 708

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

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

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

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

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

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

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
747
			$type = 'E';
748

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

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

755
			$type = 'E';
756

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

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

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

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

783
		} elsif ($cur =~ /^(if|while|typeof|__typeof__|for)\b/o) {
784
			print "COND($1)\n" if ($dbg_values > 1);
785
			$av_pending = 'N';
786 787
			$type = 'N';

788
		} elsif ($cur =~/^(return|case|else|goto)/o) {
789
			print "KEYWORD($1)\n" if ($dbg_values > 1);
790 791 792
			$type = 'N';

		} elsif ($cur =~ /^(\()/o) {
793
			print "PAREN('$1')\n" if ($dbg_values > 1);
794 795
			push(@av_paren_type, $av_pending);
			$av_pending = '_';
796 797 798
			$type = 'N';

		} elsif ($cur =~ /^(\))/o) {
799 800 801
			my $new_type = pop(@av_paren_type);
			if ($new_type ne '_') {
				$type = $new_type;
802 803
				print "PAREN('$1') -> $type\n"
							if ($dbg_values > 1);
804
			} else {
805
				print "PAREN('$1')\n" if ($dbg_values > 1);
806 807
			}

808
		} elsif ($cur =~ /^($Ident)\s*\(/o) {
809
			print "FUNC($1)\n" if ($dbg_values > 1);
810
			$type = 'V';
811
			$av_pending = 'V';
812 813

		} elsif ($cur =~ /^($Ident|$Constant)/o) {
814
			print "IDENT($1)\n" if ($dbg_values > 1);
815 816 817
			$type = 'V';

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

821
		} elsif ($cur =~/^(;|{|})/) {
822
			print "END($1)\n" if ($dbg_values > 1);
823 824
			$type = 'E';

825
		} elsif ($cur =~ /^(;|\?|:|\[)/o) {
826
			print "CLOSE($1)\n" if ($dbg_values > 1);
827 828 829
			$type = 'N';

		} elsif ($cur =~ /^($Operators)/o) {
830
			print "OP($1)\n" if ($dbg_values > 1);
831 832 833 834 835
			if ($1 ne '++' && $1 ne '--') {
				$type = 'N';
			}

		} elsif ($cur =~ /(^.)/o) {
836
			print "C($1)\n" if ($dbg_values > 1);
837 838 839 840 841
		}
		if (defined $1) {
			$cur = substr($cur, length($1));
			$res .= $type x length($1);
		}
842
	}
843

844
	return $res;
845 846
}

847
sub possible {
848
	my ($possible, $line) = @_;
849

850
	print "CHECK<$possible> ($line)\n" if ($dbg_possible > 1);
851 852 853
	if ($possible !~ /^(?:$Storage|$Type|DEFINE_\S+)$/ &&
	    $possible ne 'goto' && $possible ne 'return' &&
	    $possible ne 'case' && $possible ne 'else' &&
854
	    $possible ne 'asm' && $possible ne '__asm__' &&
855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
	    $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;
			warn "MODIFIER: $possible ($line)\n" if ($dbg_possible);
			push(@modifierList, $possible);

		} else {
			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
			push(@typeList, $possible);
		}
870 871 872 873
		build_types();
	}
}

874 875
my $prefix = '';

876
sub report {
877 878 879
	if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
		return 0;
	}
880 881 882 883
	my $line = $prefix . $_[0];

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

884
	push(our @report, $line);
885 886

	return 1;
887 888
}
sub report_dump {
889
	our @report;
890
}
891
sub ERROR {
892 893 894 895
	if (report("ERROR: $_[0]\n")) {
		our $clean = 0;
		our $cnt_error++;
	}
896 897
}
sub WARN {
898 899 900 901
	if (report("WARNING: $_[0]\n")) {
		our $clean = 0;
		our $cnt_warn++;
	}
902 903
}
sub CHK {
904
	if ($check && report("CHECK: $_[0]\n")) {
905 906 907
		our $clean = 0;
		our $cnt_chk++;
	}
908 909
}

910 911 912 913 914
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
915
	my $prevrawline="";
916
	my $stashline="";
917
	my $stashrawline="";
918

919
	my $length;
920 921 922 923
	my $indent;
	my $previndent=0;
	my $stashindent=0;

924
	our $clean = 1;
925 926 927
	my $signoff = 0;
	my $is_patch = 0;

928
	our @report = ();
929 930 931 932 933
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

934 935 936 937 938 939
	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
	my $in_comment = 0;
940
	my $comment_edge = 0;
941 942
	my $first_line = 0;

943 944 945
	my $prev_values = 'E';

	# suppression flags
946
	my %suppress_ifbraces;
947

948
	# Pre-scan the patch sanitizing the lines.
949
	# Pre-scan the patch looking for any __setup documentation.
950
	#
951 952
	my @setup_docs = ();
	my $setup_docs = 0;
953 954

	sanitise_line_reset();
955 956
	my $line;
	foreach my $rawline (@rawlines) {
957 958
		$linenr++;
		$line = $rawline;
959

960
		if ($rawline=~/^\+\+\+\s+(\S+)/) {
961 962 963 964
			$setup_docs = 0;
			if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
				$setup_docs = 1;
			}
965 966 967 968 969 970 971 972 973
			#next;
		}
		if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
974
			$in_comment = 0;
975 976 977 978 979 980

			# 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;
981
			for (my $ln = $linenr + 1; $ln < ($linenr + $realcnt); $ln++) {
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001
				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);

1002
		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1003
			# Standardise the strings and chars within the input to
1004
			# simplify matching -- only bother with positive lines.
1005
			$line = sanitise_line($rawline);
1006
		}
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
		push(@lines, $line);

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

		#print "==>$rawline\n";
		#print "-->$line\n";
1017 1018 1019 1020 1021 1022

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

1023 1024
	$prefix = '';

1025 1026
	$realcnt = 0;
	$linenr = 0;
1027 1028 1029
	foreach my $line (@lines) {
		$linenr++;

1030
		my $rawline = $rawlines[$linenr - 1];
1031

1032
#extract the line range in the file after the patch is applied
1033
		if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1034
			$is_patch = 1;
1035
			$first_line = $linenr + 1;
1036 1037 1038 1039 1040 1041
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1042
			annotate_reset();
1043 1044
			$prev_values = 'E';

1045
			%suppress_ifbraces = ();
1046 1047
			next;

1048 1049 1050
# 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.
1051
		} elsif ($line =~ /^( |\+|$)/) {
1052
			$realline++;
1053
			$realcnt-- if ($realcnt != 0);
1054

1055
			# Measure the line length and indent.
1056
			($length, $indent) = line_stats($rawline);
1057 1058 1059 1060

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

1063
			#warn "line<$line>\n";
1064

1065 1066
		} elsif ($realcnt == 1) {
			$realcnt--;
1067 1068 1069
		}

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

1073 1074
		$here = "#$linenr: " if (!$file);
		$here = "#$realline: " if ($file);
1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086

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

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

1089 1090 1091
		my $hereline = "$here\n$rawline\n";
		my $herecurr = "$here\n$rawline\n";
		my $hereprev = "$here\n$prevrawline\n$rawline\n";
1092

1093 1094
		$cnt_lines++ if ($realcnt != 0);

1095
#check the patch for a signoff:
1096
		if ($line =~ /^\s*signed-off-by:/i) {
1097 1098
			# This is a signoff, if ugly, so do not double report.
			$signoff++;
1099
			if (!($line =~ /^\s*Signed-off-by:/)) {
1100 1101
				WARN("Signed-off-by: is the preferred form\n" .
					$herecurr);
1102 1103
			}
			if ($line =~ /^\s*signed-off-by:\S/i) {
1104
				WARN("space required after Signed-off-by:\n" .
1105
					$herecurr);
1106 1107 1108
			}
		}

1109
# Check for wrappage within a valid hunk of the file
1110
		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1111
			ERROR("patch seems to be corrupt (line wrapped?)\n" .
1112
				$herecurr) if (!$emitted_corrupt++);
1113 1114 1115 1116
		}

# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1117 1118 1119 1120 1121 1122 1123 1124
		    $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);
1125 1126 1127 1128
		}

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

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

#trailing whitespace
1134
		if ($line =~ /^\+.*\015/) {
1135
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1136 1137
			ERROR("DOS line endings\n" . $herevet);

1138 1139
		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1140
			ERROR("trailing whitespace\n" . $herevet);
1141 1142
		}
#80 column limit
1143
		if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1144 1145 1146
		    $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
		    $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
		    $length > 80)
1147
		{
1148
			WARN("line over 80 characters\n" . $herecurr);
1149 1150
		}

1151 1152 1153 1154 1155
# 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);
		}

1156 1157 1158 1159 1160
# 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.
1161 1162 1163
		if ($rawline =~ /^\+\s* \t\s*\S/ ||
		    $rawline =~ /^\+\s*        \s*/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1164
			ERROR("code indent should use tabs where possible\n" . $herevet);
1165 1166
		}

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

1172
# Check for potential 'bare' types
1173
		my ($stat, $cond, $line_nr_next, $remain_next);
1174
		if ($realcnt && $line =~ /.\s*\S/) {
1175 1176
			($stat, $cond, $line_nr_next, $remain_next) =
				ctx_statement_block($linenr, $realcnt, 0);
1177 1178 1179 1180 1181
			$stat =~ s/\n./\n /g;
			$cond =~ s/\n./\n /g;

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

1183
			# Ignore goto labels.
1184
			if ($s =~ /$Ident:\*$/s) {
1185 1186

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

1189 1190 1191 1192 1193 1194
			# declarations always start with types
			} elsif ($prev_values eq 'E' && $s =~ /^.\s*(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?((?:\s*$Ident)+)\b(?:\s+$Sparse)?\s*\**\s*(?:$Ident|\(\*[^\)]*\))\s*(?:;|=|,|\()/s) {
				my $type = $1;
				$type =~ s/\s+/ /g;
				possible($type, "A:" . $s);

1195
			# definitions in global scope can only start with types
1196
			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b/s) {
1197
				possible($1, "B:" . $s);
1198
			}
1199 1200

			# any (foo ... *) is a pointer cast, and foo is a type
1201
			while ($s =~ /\(($Ident)(?:\s+$Sparse)*\s*\*+\s*\)/sg) {
1202
				possible($1, "C:" . $s);
1203 1204 1205 1206 1207
			}

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

1211
				my $ctx = $s;
1212
				substr($ctx, 0, $name_len + 1, '');
1213
				$ctx =~ s/\)[^\)]*$//;
1214

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

1218
						possible($1, "D:" . $s);
1219 1220
					}
				}
1221
			}
1222

1223 1224
		}

1225 1226 1227
#
# Checks which may be anchored in the context.
#
1228

1229 1230
# Check for switch () and associated case and default
# statements should be at the same indent.
1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
		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 '') {
1247
				ERROR("switch and case should be at the same indent\n$hereline$err");
1248 1249
			}
		}
1250 1251 1252 1253
		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
		    $line !~ /\G(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$/g) {
			ERROR("trailing statements should be on next line\n" . $herecurr);
		}
1254 1255 1256

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

1260
			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
1261 1262 1263
			my $ctx_cnt = $realcnt - $#ctx - 1;
			my $ctx = join("\n", @ctx);

1264 1265
			my $ctx_ln = $linenr;
			my $ctx_skip = $realcnt;
1266

1267 1268 1269 1270 1271
			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] !~ /^-/);
1272 1273
				$ctx_ln++;
			}
1274

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

1278 1279
			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
				ERROR("that open brace { should be on the previous line\n" .
1280
					"$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1281
			}
1282 1283 1284 1285
			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
			    $ctx =~ /\)\s*\;\s*$/ &&
			    defined $lines[$ctx_ln - 1])
			{
1286 1287
				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
				if ($nindent > $indent) {
1288
					WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
1289
						"$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1290 1291
				}
			}
1292 1293
		}

1294 1295 1296 1297
		# 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;
1298 1299
		if ($dbg_values) {
			my $outline = $opline; $outline =~ s/\t/ /g;
1300 1301
			print "$linenr > .$outline\n";
			print "$linenr > $curr_values\n";
1302
		}
1303 1304
		$prev_values = substr($curr_values, -1);

1305 1306 1307
#ignore lines not being added
		if ($line=~/^[^\+]/) {next;}

1308
# TEST: allow direct testing of the type matcher.
1309 1310 1311 1312 1313 1314
		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);
			}
1315 1316 1317
			next;
		}

1318 1319 1320
# check for initialisation to aggregates open brace on the next line
		if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
		    $line =~ /^.\s*{/) {
1321
			ERROR("that open brace { should be on the previous line\n" . $hereprev);
1322 1323
		}

1324 1325 1326 1327 1328
#
# Checks which are anchored on the added line.
#

# check for malformed paths in #include statements (uses RAW line)
1329
		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
1330 1331
			my $path = $1;
			if ($path =~ m{//}) {
1332 1333
				ERROR("malformed #include filename\n" .
					$herecurr);
1334 1335
			}
		}
1336

1337
# no C99 // comments
1338
		if ($line =~ m{//}) {
1339
			ERROR("do not use C99 // comments\n" . $herecurr);
1340
		}
1341
		# Remove C99 comments.
1342
		$line =~ s@//.*@@;
1343
		$opline =~ s@//.*@@;
1344 1345

#EXPORT_SYMBOL should immediately follow its function closing }.
1346 1347 1348
		if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
		    ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
			my $name = $1;
1349 1350
			if (($prevline !~ /^}/) &&
			   ($prevline !~ /^\+}/) &&
1351
			   ($prevline !~ /^ }/) &&
1352 1353
			   ($prevline !~ /^.DECLARE_$Ident\(\Q$name\E\)/) &&
			   ($prevline !~ /^.LIST_HEAD\(\Q$name\E\)/) &&
1354
			   ($prevline !~ /^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(/) &&
1355
			   ($prevline !~ /\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)/)) {
1356
				WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
1357 1358 1359
			}
		}

1360
# check for external initialisers.
1361
		if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
1362 1363 1364
			ERROR("do not initialise externals to 0 or NULL\n" .
				$herecurr);
		}
1365
# check for static initialisers.
1366
		if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) {
1367 1368
			ERROR("do not initialise statics to 0 or NULL\n" .
				$herecurr);
1369 1370
		}

1371 1372 1373
# check for new typedefs, only function parameters and sparse annotations
# make sense.
		if ($line =~ /\btypedef\s/ &&
1374
		    $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ &&
1375
		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
1376
		    $line !~ /\b__bitwise(?:__|)\b/) {
1377
			WARN("do not add new typedefs\n" . $herecurr);
1378 1379 1380
		}

# * goes on variable not on type
1381
		if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) {
1382 1383
			ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" .
				$herecurr);
1384 1385

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

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

1393
		} elsif ($line =~ m{$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) {
1394 1395
			ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" .
				$herecurr);
1396 1397 1398 1399 1400 1401 1402 1403 1404
		}

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

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

1409 1410 1411 1412 1413
# 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.
1414
		if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427
			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) {
1428
				WARN("printk() should include KERN_ facility level\n" . $herecurr);
1429
			}
1430 1431
		}

1432 1433
# function brace can't be on same line, except for #defines of do while,
# or if closed on same line
1434 1435
		if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
		    !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
1436
			ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
1437
		}
1438

1439 1440 1441 1442 1443 1444
# 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);
		}

1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455
# check for spacing round square brackets; allowed:
#  1. with a type on the left -- int [] a;
#  2. at the beginning of a line for slice initialisers -- [0..10] = 5,
		while ($line =~ /(.*?\s)\[/g) {
			my ($where, $prefix) = ($-[1], $1);
			if ($prefix !~ /$Type\s+$/ &&
			    ($where != 0 || $prefix !~ /^.\s+$/)) {
				ERROR("space prohibited before open square bracket '['\n" . $herecurr);
			}
		}

1456
# check for spaces between functions and their parentheses.
1457
		while ($line =~ /($Ident)\s+\(/g) {
1458
			my $name = $1;
1459 1460
			my $ctx_before = substr($line, 0, $-[1]);
			my $ctx = "$ctx_before$name";
1461 1462

			# Ignore those directives where spaces _are_ permitted.
1463 1464 1465 1466 1467 1468
			if ($name =~ /^(?:
				if|for|while|switch|return|case|
				volatile|__volatile__|
				__attribute__|format|__extension__|
				asm|__asm__)$/x)
			{
1469 1470 1471 1472

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

			# cpp #elif statement condition may start with a (
1476
			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
1477 1478 1479

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

			} else {
1483
				WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
1484
			}
1485
		}
1486
# Check operator spacing.
1487
		if (!($line=~/\#\s*include/)) {
1488 1489 1490 1491
			my $ops = qr{
				<<=|>>=|<=|>=|==|!=|
				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
				=>|->|<<|>>|<|>|=|!|~|
1492
				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
1493
			}x;
1494
			my @elements = split(/($ops|;)/, $opline);
1495
			my $off = 0;
1496 1497 1498

			my $blank = copy_spacing($opline);

1499
			for (my $n = 0; $n < $#elements; $n += 2) {
1500 1501
				$off += length($elements[$n]);

1502 1503 1504 1505 1506 1507 1508 1509
				# 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";

1510 1511 1512
				my $a = '';
				$a = 'V' if ($elements[$n] ne '');
				$a = 'W' if ($elements[$n] =~ /\s$/);
1513
				$a = 'C' if ($elements[$n] =~ /$;$/);
1514 1515
				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
				$a = 'O' if ($elements[$n] eq '');
1516
				$a = 'E' if ($ca =~ /^\s*$/);
1517

1518
				my $op = $elements[$n + 1];
1519 1520

				my $c = '';
1521
				if (defined $elements[$n + 2]) {
1522 1523
					$c = 'V' if ($elements[$n + 2] ne '');
					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
1524
					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
1525 1526
					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
					$c = 'O' if ($elements[$n + 2] eq '');
1527
					$c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
1528 1529
				} else {
					$c = 'E';
1530 1531
				}

1532 1533 1534 1535
				my $ctx = "${a}x${c}";

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

1536
				my $ptr = substr($blank, 0, $off) . "^";
1537
				my $hereptr = "$hereline$ptr\n";
1538

1539 1540 1541
				# Classify operators into binary, unary, or
				# definitions (* only) where they have more
				# than one mode.
1542 1543 1544 1545 1546 1547 1548 1549 1550
				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;
1551 1552
				}
				#if ($op eq '-' || $op eq '&' || $op eq '*') {
1553
				#	print "UNARY: <$op_left$op_type $is_unary $a:$op:$c> <$ca:$op:$cc> <$unary_ctx>\n";
1554
				#}
1555

1556 1557 1558 1559
				# Ignore operators passed as parameters.
				if ($op_type ne 'V' &&
				    $ca =~ /\s$/ && $cc =~ /^\s*,/) {

1560 1561
#				# Ignore comments
#				} elsif ($op =~ /^$;+$/) {
1562

1563
				# ; should have either the end of line or a space or \ after it
1564
				} elsif ($op eq ';') {
1565 1566
					if ($ctx !~ /.x[WEBC]/ &&
					    $cc !~ /^\\/ && $cc !~ /^;/) {
1567
						ERROR("space required after that '$op' $at\n" . $hereptr);
1568 1569 1570 1571
					}

				# // is a comment
				} elsif ($op eq '//') {
1572 1573 1574

				# -> should have no spaces
				} elsif ($op eq '->') {
1575
					if ($ctx =~ /Wx.|.xW/) {
1576
						ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
1577 1578 1579 1580
					}

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

1585 1586 1587 1588 1589 1590 1591 1592 1593
				# '*' 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 '&'))) {
1594
					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
1595
						ERROR("space required before that '$op' $at\n" . $hereptr);
1596
					}
1597 1598 1599 1600
					if ($op  eq '*' && $cc =~/\s*const\b/) {
						# A unary '*' may be const

					} elsif ($ctx =~ /.xW/) {
1601
						ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1602 1603 1604 1605
					}

				# unary ++ and unary -- are allowed no space on one side.
				} elsif ($op eq '++' or $op eq '--') {
1606 1607 1608 1609 1610 1611
					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);
1612
					}
1613 1614
					if ($ctx =~ /ExW/) {
						ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1615
					}
1616

1617

1618
				# << and >> may either have or not have spaces both sides
1619 1620 1621
				} elsif ($op eq '<<' or $op eq '>>' or
					 $op eq '&' or $op eq '^' or $op eq '|' or
					 $op eq '+' or $op eq '-' or
1622 1623
					 $op eq '*' or $op eq '/' or
					 $op eq '%')
1624
				{
1625
					if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
1626 1627
						ERROR("need consistent spacing around '$op' $at\n" .
							$hereptr);
1628 1629 1630
					}

				# All the others need spaces both sides.
1631
				} elsif ($ctx !~ /[EWC]x[CWE]/) {
1632 1633 1634
					# Ignore email addresses <foo@bar>
					if (!($op eq '<' && $cb =~ /$;\S+\@\S+>/) &&
					    !($op eq '>' && $cb =~ /<\S+\@\S+$;/)) {
1635
						ERROR("spaces required around that '$op' $at\n" . $hereptr);
1636
					}
1637
				}
1638
				$off += length($elements[$n + 1]);
1639 1640 1641
			}
		}

1642 1643
# check for multiple assignments
		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
1644
			CHK("multiple assignments should be avoided\n" . $herecurr);
1645 1646
		}

1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660
## # 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);
## 			}
## 		}
1661

1662
#need space before brace following if, while, etc
1663 1664
		if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
		    $line =~ /do{/) {
1665
			ERROR("space required before the open brace '{'\n" . $herecurr);
1666 1667 1668 1669 1670
		}

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

1674 1675
# check spacing on square brackets
		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
1676
			ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
1677 1678
		}
		if ($line =~ /\s\]/) {
1679
			ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
1680 1681
		}

1682
# check spacing on parentheses
1683 1684
		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
		    $line !~ /for\s*\(\s+;/) {
1685
			ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
1686
		}
1687
		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
1688 1689
		    $line !~ /for\s*\(.*;\s+\)/ &&
		    $line !~ /:\s+\)/) {
1690
			ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
1691 1692
		}

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

1699 1700 1701 1702 1703 1704
# Return is not a function.
		if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
			my $spacing = $1;
			my $value = $2;

			# Flatten any parentheses and braces
1705
			$value =~ s/\)\(/\) \(/g;
1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716
			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);
			}
		}

1717
# Need a space before open parenthesis after if, while etc
1718
		if ($line=~/\b(if|while|for|switch)\(/) {
1719
			ERROR("space required before the open parenthesis '('\n" . $herecurr);
1720 1721
		}

1722 1723
# Check for illegal assignment in if conditional -- and check for trailing
# statements after the conditional.
1724
		if ($line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
1725
			my ($s, $c) = ($stat, $cond);
1726 1727

			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
1728
				ERROR("do not use assignment in if condition\n" . $herecurr);
1729 1730 1731 1732
			}

			# Find out what is on the end of the line after the
			# conditional.
1733
			substr($s, 0, length($c), '');
1734
			$s =~ s/\n.*//g;
1735
			$s =~ s/$;//g; 	# Remove any comments
1736 1737
			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
			    $c !~ /}\s*while\s*/)
1738
			{
1739 1740 1741 1742
				ERROR("trailing statements should be on next line\n" . $herecurr);
			}
		}

1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792
# 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;
			}

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

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

1808
# if and else should not have general statements after it
1809 1810 1811 1812 1813 1814
		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);
			}
1815 1816 1817 1818 1819 1820
		}

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

1824 1825 1826 1827 1828 1829
		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.
1830
			substr($s, 0, length($c), '');
1831 1832 1833 1834 1835 1836 1837
			$s =~ s/\n.*//g;

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

1838 1839 1840 1841 1842 1843 1844 1845
#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
1846
		if ($line=~/\#\s*define.*\\\s$/) {
1847
			WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
1848 1849
		}

1850
#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
1851 1852 1853 1854 1855
		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
			my $checkfile = "include/linux/$1.h";
			if (-f "$root/$checkfile" && $realfile ne $checkfile &&
			    $1 ne 'irq')
			{
1856
				WARN("Use #include <linux/$1.h> instead of <asm/$1.h>\n" .
1857
					$herecurr);
1858 1859 1860
			}
		}

1861 1862
# 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
1863
# in a known good container
1864
		if ($line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
1865 1866
			my $ln = $linenr;
			my $cnt = $realcnt;
1867 1868
			my ($off, $dstat, $dcond, $rest);
			my $ctx = '';
1869

1870 1871 1872 1873 1874 1875 1876 1877
			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";
1878
				$cnt-- if ($lines[$ln - 1] !~ /^-/);
1879 1880 1881 1882 1883 1884 1885
				$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";
1886
			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
1887 1888 1889 1890

			# Extract the remainder of the define (if any) and
			# rip off surrounding spaces, and trailing \'s.
			$rest = '';
1891 1892 1893 1894 1895 1896
			while ($off != 0 || ($cnt > 0 && $rest =~ /(?:^|\\)\s*$/)) {
				#print "ADDING $off <" . substr($lines[$ln - 1], $off) . ">\n";
				if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
					$rest .= substr($lines[$ln - 1], $off) . "\n";
					$cnt--;
				}
1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908
				$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*//;
1909
			}
1910 1911 1912
			$dstat =~ s/\\\n.//g;
			$dstat =~ s/^\s*//s;
			$dstat =~ s/\s*$//s;
1913

1914 1915 1916 1917
			# Flatten any parentheses and braces
			while ($dstat =~ s/\([^\(\)]*\)/1/) {
			}
			while ($dstat =~ s/\{[^\{\}]*\}/1/) {
1918
			}
1919

1920 1921 1922 1923 1924 1925 1926 1927
			my $exceptions = qr{
				$Declare|
				module_param_named|
				MODULE_PARAM_DESC|
				DECLARE_PER_CPU|
				DEFINE_PER_CPU|
				__typeof__\(
			}x;
1928
			#print "REST<$rest>\n";
1929 1930 1931 1932
			if ($rest ne '') {
				if ($rest !~ /while\s*\(/ &&
				    $dstat !~ /$exceptions/)
				{
1933
					ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
1934 1935 1936 1937 1938 1939 1940 1941
				}

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

1947
# check for redundant bracing round if etc
1948 1949
		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
			my ($level, $endln, @chunks) =
1950
				ctx_statement_full($linenr, $realcnt, 1);
1951
			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
1952 1953
			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
			if ($#chunks > 0 && $level == 0) {
1954 1955
				my $allowed = 0;
				my $seen = 0;
1956
				my $herectx = $here . "\n";
1957
				my $ln = $linenr - 1;
1958 1959 1960
				for my $chunk (@chunks) {
					my ($cond, $block) = @{$chunk};

1961 1962 1963 1964 1965 1966 1967 1968 1969 1970
					# 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";
1971 1972
					$ln += statement_rawlines($block) - 1;

1973
					substr($block, 0, length($cond), '');
1974 1975 1976

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

1977 1978 1979
					#print "cond<$cond> block<$block> allowed<$allowed>\n";
					if (statement_lines($cond) > 1) {
						#print "APW: ALLOWED: cond<$cond>\n";
1980 1981 1982
						$allowed = 1;
					}
					if ($block =~/\b(?:if|for|while)\b/) {
1983
						#print "APW: ALLOWED: block<$block>\n";
1984 1985
						$allowed = 1;
					}
1986 1987
					if (statement_block_size($block) > 1) {
						#print "APW: ALLOWED: lines block<$block>\n";
1988 1989 1990 1991
						$allowed = 1;
					}
				}
				if ($seen && !$allowed) {
1992
					WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
1993 1994 1995
				}
			}
		}
1996
		if (!defined $suppress_ifbraces{$linenr - 1} &&
1997
					$line =~ /\b(if|while|for|else)\b/) {
1998 1999 2000 2001 2002 2003 2004
			my $allowed = 0;

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

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

2009 2010
			# Check the condition.
			my ($cond, $block) = @{$chunks[0]};
2011
			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
2012
			if (defined $cond) {
2013
				substr($block, 0, length($cond), '');
2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030
			}
			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) {
2031
					substr($block, 0, length($cond), '');
2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043
				}
				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";;
2044
				}
2045 2046

				WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
2047 2048 2049
			}
		}

2050
# don't include deprecated include files (uses RAW line)
2051
		for my $inc (@dep_includes) {
2052
			if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
2053
				ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2054 2055 2056
			}
		}

2057 2058
# don't use deprecated functions
		for my $func (@dep_functions) {
2059
			if ($line =~ /\b$func\b/) {
2060
				ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2061 2062 2063 2064
			}
		}

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

2070 2071 2072 2073 2074
# 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);
		}

2075
# warn about #if 0
2076
		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
2077 2078
			CHK("if this code is redundant consider removing it\n" .
				$herecurr);
2079 2080
		}

2081 2082 2083 2084
# check for needless kfree() checks
		if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
			my $expr = $1;
			if ($line =~ /\bkfree\(\Q$expr\E\);/) {
2085
				WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
2086 2087
			}
		}
2088 2089 2090 2091 2092 2093 2094
# 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);
			}
		}
2095

2096
# warn about #ifdefs in C files
2097
#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
2098 2099 2100 2101 2102
#			print "#ifdef in C files should be avoided\n";
#			print "$herecurr";
#			$clean = 0;
#		}

2103
# warn about spacing in #ifdefs
2104
		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
2105 2106 2107
			ERROR("exactly one space required after that #$1\n" . $herecurr);
		}

2108
# check for spinlock_t definitions without a comment.
2109 2110
		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
2111 2112
			my $which = $1;
			if (!ctx_has_comment($first_line, $linenr)) {
2113
				CHK("$1 definition without comment\n" . $herecurr);
2114 2115 2116 2117 2118
			}
		}
# 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)) {
2119
				CHK("memory barrier without comment\n" . $herecurr);
2120 2121 2122
			}
		}
# check of hardware specific defines
2123
		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
2124
			CHK("architecture specific defines should be avoided\n" .  $herecurr);
2125
		}
2126

2127 2128
# check the location of the inline attribute, that it is between
# storage class and type.
2129 2130
		if ($line =~ /\b$Type\s+$Inline\b/ ||
		    $line =~ /\b$Inline\s+$Storage\b/) {
2131 2132 2133
			ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
		}

2134 2135 2136 2137 2138
# Check for __inline__ and __inline, prefer inline
		if ($line =~ /\b(__inline__|__inline)\b/) {
			WARN("plain inline is preferred over $1\n" . $herecurr);
		}

2139
# check for new externs in .c files.
2140
		if ($realfile =~ /\.c$/ && defined $stat &&
2141
		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
2142
		{
2143 2144
			my $function_name = $1;
			my $paren_space = $2;
2145 2146 2147 2148 2149

			my $s = $stat;
			if (defined $cond) {
				substr($s, 0, length($cond), '');
			}
2150 2151 2152
			if ($s =~ /^\s*;/ &&
			    $function_name ne 'uninitialized_var')
			{
2153 2154 2155 2156 2157 2158
				WARN("externs should be avoided in .c files\n" .  $herecurr);
			}

			if ($paren_space =~ /\n/) {
				WARN("arguments for function declarations should follow identifier\n" . $herecurr);
			}
2159 2160 2161 2162 2163

		} elsif ($realfile =~ /\.c$/ && defined $stat &&
		    $stat =~ /^.\s*extern\s+/)
		{
			WARN("externs should be avoided in .c files\n" .  $herecurr);
2164 2165 2166 2167 2168 2169 2170 2171 2172
		}

# 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);
			}
2173
		}
2174 2175 2176 2177 2178

# 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);
		}
2179 2180 2181 2182 2183

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

# check for semaphores used as mutexes
2186
		if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
2187 2188 2189
			WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
		}
# check for semaphores used as mutexes
2190
		if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
2191 2192 2193 2194 2195 2196
			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);
		}
2197 2198 2199 2200
# check for __initcall(), use device_initcall() explicitly please
		if ($line =~ /^.\s*__initcall\s*\(/) {
			WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
		}
2201 2202 2203 2204

# 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/ &&
2205 2206
		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
2207 2208 2209
		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
2210 2211 2212
		{
			WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
		}
2213 2214 2215 2216 2217 2218 2219 2220 2221 2222

# 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;
			}
		}
2223 2224 2225 2226 2227 2228
	}

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

2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243
	# 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) {
2244
		ERROR("Does not appear to be a unified-diff format patch\n");
2245 2246
	}
	if ($is_patch && $chk_signoff && $signoff == 0) {
2247
		ERROR("Missing Signed-off-by: line(s)\n");
2248 2249
	}

2250
	print report_dump();
2251 2252
	if ($summary && !($clean == 1 && $quiet == 1)) {
		print "$filename " if ($summary_file);
2253 2254 2255 2256
		print "total: $cnt_error errors, $cnt_warn warnings, " .
			(($check)? "$cnt_chk checks, " : "") .
			"$cnt_lines lines checked\n";
		print "\n" if ($quiet == 0);
2257
	}
2258

2259
	if ($clean == 1 && $quiet == 0) {
2260
		print "$vname has no obvious style problems and is ready for submission.\n"
2261 2262
	}
	if ($clean == 0 && $quiet == 0) {
2263
		print "$vname has style problems, please review.  If any of these errors\n";
2264 2265 2266
		print "are false positives report them to the maintainer, see\n";
		print "CHECKPATCH in MAINTAINERS.\n";
	}
2267

2268 2269
	return $clean;
}