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

$chk_signoff = 0 if ($file);

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

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

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

exit($exit);

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

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

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

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

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

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

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

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

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

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

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

360 361 362 363 364 365 366 367
		#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);
		}
368 369 370
	}

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

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

381 382 383
	return $res;
}

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

392 393
	my $loff = 0;

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

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

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

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

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

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

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

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

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

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

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

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

	my (@chunks);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	return ($cmt ne '');
}

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

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

686
	return $res;
687 688
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

754
			$type = 'E';
755

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

843
	return $res;
844 845
}

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

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

873 874
my $prefix = '';

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

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

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

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

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

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

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

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

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

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

942 943 944
	my $prev_values = 'E';

	# suppression flags
945
	my %suppress_ifbraces;
946

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

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

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

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

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

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

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

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

1022 1023
	$prefix = '';

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

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

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

1044
			%suppress_ifbraces = ();
1045 1046
			next;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1188 1189 1190 1191 1192 1193
			# 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);

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

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

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

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

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

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

1222 1223
		}

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

1228 1229
# Check for switch () and associated case and default
# statements should be at the same indent.
1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245
		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 '') {
1246
				ERROR("switch and case should be at the same indent\n$hereline$err");
1247 1248
			}
		}
1249 1250 1251 1252
		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);
		}
1253 1254 1255

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454
# 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);
			}
		}

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

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

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

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

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

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

			my $blank = copy_spacing($opline);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1616

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1849
#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
1850 1851 1852 1853 1854
		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')
			{
1855
				WARN("Use #include <linux/$1.h> instead of <asm/$1.h>\n" .
1856
					$herecurr);
1857 1858 1859
			}
		}

1860 1861
# 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
1862
# in a known good container
1863 1864
		if ($realfile !~ m@/vmlinux.lds.h$@ &&
		    $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;
}