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

use strict;

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

A
Andy Whitcroft 已提交
12
my $V = '0.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_type = 0;
21
my $tst_only;
22
my $emacs = 0;
23
my $terse = 0;
24 25
my $file = 0;
my $check = 0;
26 27
my $summary = 1;
my $mailback = 0;
28
my $summary_file = 0;
29
my $root;
30
my %debug;
31
GetOptions(
32
	'q|quiet+'	=> \$quiet,
33 34 35
	'tree!'		=> \$tree,
	'signoff!'	=> \$chk_signoff,
	'patch!'	=> \$chk_patch,
36
	'emacs!'	=> \$emacs,
37
	'terse!'	=> \$terse,
38 39 40 41
	'file!'		=> \$file,
	'subjective!'	=> \$check,
	'strict!'	=> \$check,
	'root=s'	=> \$root,
42 43
	'summary!'	=> \$summary,
	'mailback!'	=> \$mailback,
44 45
	'summary-file!'	=> \$summary_file,

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

my $exit = 0;

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

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

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

79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
if ($tree) {
	if (defined $root) {
		if (!top_of_kernel_tree($root)) {
			die "$P: $root: --root does not point at a valid tree\n";
		}
	} else {
		if (top_of_kernel_tree('.')) {
			$root = '.';
		} elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
						top_of_kernel_tree($1)) {
			$root = $1;
		}
	}

	if (!defined $root) {
		print "Must be run from the top-level dir. of a kernel tree\n";
		exit(2);
	}
97 98
}

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

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

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

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

135 136 137 138 139 140 141 142 143 144 145
our $UTF8	= qr {
	[\x09\x0A\x0D\x20-\x7E]              # ASCII
	| [\xC2-\xDF][\x80-\xBF]             # non-overlong 2-byte
	|  \xE0[\xA0-\xBF][\x80-\xBF]        # excluding overlongs
	| [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}  # straight 3-byte
	|  \xED[\x80-\x9F][\x80-\xBF]        # excluding surrogates
	|  \xF0[\x90-\xBF][\x80-\xBF]{2}     # planes 1-3
	| [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
	|  \xF4[\x80-\x8F][\x80-\xBF]{2}     # plane 16
}x;

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

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

$chk_signoff = 0 if ($file);

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

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

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

exit($exit);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

383 384 385
	return $res;
}

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

394 395
	my $loff = 0;

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

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

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

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

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

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

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

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

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

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

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

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

	my (@chunks);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	return ($cmt ne '');
}

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

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

688
	return $res;
689 690
}

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

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

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

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

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

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

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

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

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

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

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
744
			$type = 'E';
745

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

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

752
			$type = 'E';
753

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

841
	return $res;
842 843
}

844
sub possible {
845
	my ($possible, $line) = @_;
846

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

871 872
my $prefix = '';

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

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

881
	push(our @report, $line);
882 883

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

907 908 909 910 911
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
912
	my $prevrawline="";
913
	my $stashline="";
914
	my $stashrawline="";
915

916
	my $length;
917 918 919 920
	my $indent;
	my $previndent=0;
	my $stashindent=0;

921
	our $clean = 1;
922 923 924
	my $signoff = 0;
	my $is_patch = 0;

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

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

940 941 942
	my $prev_values = 'E';

	# suppression flags
943
	my %suppress_ifbraces;
944

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

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

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

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

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

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

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

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

1020 1021
	$prefix = '';

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

1027
		my $rawline = $rawlines[$linenr - 1];
1028

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

1042
			%suppress_ifbraces = ();
1043 1044
			next;

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

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

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

1060
			#warn "line<$line>\n";
1061

1062 1063
		} elsif ($realcnt == 1) {
			$realcnt--;
1064 1065 1066
		}

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

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

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

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

1086 1087 1088
		my $hereline = "$here\n$rawline\n";
		my $herecurr = "$here\n$rawline\n";
		my $hereprev = "$here\n$prevrawline\n$rawline\n";
1089

1090 1091
		$cnt_lines++ if ($realcnt != 0);

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

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

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

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

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

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

1135 1136
		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1137
			ERROR("trailing whitespace\n" . $herevet);
1138 1139
		}
#80 column limit
1140 1141 1142
		if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
		    $rawline !~ /^.\s*\*\s*\@$Ident\s/ && $length > 80)
		{
1143
			WARN("line over 80 characters\n" . $herecurr);
1144 1145
		}

1146 1147 1148 1149 1150
# 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);
		}

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

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

1167
# Check for potential 'bare' types
1168
		my ($stat, $cond);
1169
		if ($realcnt && $line =~ /.\s*\S/) {
1170 1171 1172 1173 1174 1175 1176
			($stat, $cond) = ctx_statement_block($linenr,
								$realcnt, 0);
			$stat =~ s/\n./\n /g;
			$cond =~ s/\n./\n /g;

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

1178
			# Ignore goto labels.
1179
			if ($s =~ /$Ident:\*$/s) {
1180 1181

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

1184 1185 1186 1187 1188 1189
			# 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);

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

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

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

1206
				my $ctx = $s;
1207
				substr($ctx, 0, $name_len + 1, '');
1208
				$ctx =~ s/\)[^\)]*$//;
1209

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

1213
						possible($1, "D:" . $s);
1214 1215
					}
				}
1216
			}
1217

1218 1219
		}

1220 1221 1222
#
# Checks which may be anchored in the context.
#
1223

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

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

1251
			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
1252 1253 1254 1255
			my $ctx_ln = $linenr + $#ctx + 1;
			my $ctx_cnt = $realcnt - $#ctx - 1;
			my $ctx = join("\n", @ctx);

1256 1257
			##warn "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";

1258
			# Skip over any removed lines in the context following statement.
1259
			while (defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^-/) {
1260 1261
				$ctx_ln++;
			}
1262
			##warn "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
1263

1264 1265
			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
				ERROR("that open brace { should be on the previous line\n" .
1266
					"$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1267
			}
1268 1269 1270 1271
			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
			    $ctx =~ /\)\s*\;\s*$/ &&
			    defined $lines[$ctx_ln - 1])
			{
1272 1273
				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
				if ($nindent > $indent) {
1274
					WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
1275
						"$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1276 1277
				}
			}
1278 1279
		}

1280 1281 1282 1283
		# 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;
1284 1285
		if ($dbg_values) {
			my $outline = $opline; $outline =~ s/\t/ /g;
1286 1287
			print "$linenr > .$outline\n";
			print "$linenr > $curr_values\n";
1288
		}
1289 1290
		$prev_values = substr($curr_values, -1);

1291 1292 1293
#ignore lines not being added
		if ($line=~/^[^\+]/) {next;}

1294 1295
# TEST: allow direct testing of the type matcher.
		if ($tst_type && $line =~ /^.$Declare$/) {
1296
			ERROR("TEST: is type $Declare\n" . $herecurr);
1297 1298 1299
			next;
		}

1300 1301 1302
# check for initialisation to aggregates open brace on the next line
		if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
		    $line =~ /^.\s*{/) {
1303
			ERROR("that open brace { should be on the previous line\n" . $hereprev);
1304 1305
		}

1306 1307 1308 1309 1310
#
# Checks which are anchored on the added line.
#

# check for malformed paths in #include statements (uses RAW line)
1311
		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
1312 1313
			my $path = $1;
			if ($path =~ m{//}) {
1314 1315
				ERROR("malformed #include filename\n" .
					$herecurr);
1316 1317
			}
		}
1318

1319
# no C99 // comments
1320
		if ($line =~ m{//}) {
1321
			ERROR("do not use C99 // comments\n" . $herecurr);
1322
		}
1323
		# Remove C99 comments.
1324
		$line =~ s@//.*@@;
1325
		$opline =~ s@//.*@@;
1326 1327

#EXPORT_SYMBOL should immediately follow its function closing }.
1328 1329 1330
		if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
		    ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
			my $name = $1;
1331 1332
			if (($prevline !~ /^}/) &&
			   ($prevline !~ /^\+}/) &&
1333
			   ($prevline !~ /^ }/) &&
1334 1335
			   ($prevline !~ /^.DECLARE_$Ident\(\Q$name\E\)/) &&
			   ($prevline !~ /^.LIST_HEAD\(\Q$name\E\)/) &&
1336
			   ($prevline !~ /^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(/) &&
1337
			   ($prevline !~ /\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)/)) {
1338
				WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
1339 1340 1341
			}
		}

1342
# check for external initialisers.
1343
		if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
1344 1345 1346
			ERROR("do not initialise externals to 0 or NULL\n" .
				$herecurr);
		}
1347
# check for static initialisers.
1348
		if ($line =~ /\s*static\s.*=\s*(0|NULL|false)\s*;/) {
1349 1350
			ERROR("do not initialise statics to 0 or NULL\n" .
				$herecurr);
1351 1352
		}

1353 1354 1355
# check for new typedefs, only function parameters and sparse annotations
# make sense.
		if ($line =~ /\btypedef\s/ &&
1356
		    $line !~ /\btypedef\s+$Type\s+\(\s*\*?$Ident\s*\)\s*\(/ &&
1357
		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
1358
		    $line !~ /\b__bitwise(?:__|)\b/) {
1359
			WARN("do not add new typedefs\n" . $herecurr);
1360 1361 1362
		}

# * goes on variable not on type
1363
		if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) {
1364 1365
			ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" .
				$herecurr);
1366 1367

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

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

1375
		} elsif ($line =~ m{$NonptrType\s+(\*+)(?!\s+(?:$Attribute|$Sparse))\s+[A-Za-z\d_]+}) {
1376 1377
			ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" .
				$herecurr);
1378 1379 1380 1381 1382 1383 1384 1385 1386
		}

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

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

1391 1392 1393 1394 1395
# 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.
1396
		if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409
			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) {
1410
				WARN("printk() should include KERN_ facility level\n" . $herecurr);
1411
			}
1412 1413
		}

1414 1415
# function brace can't be on same line, except for #defines of do while,
# or if closed on same line
1416 1417
		if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
		    !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
1418
			ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
1419
		}
1420

1421 1422 1423 1424 1425 1426
# 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);
		}

1427
# check for spaces between functions and their parentheses.
1428
		while ($line =~ /($Ident)\s+\(/g) {
1429
			my $name = $1;
1430 1431
			my $ctx_before = substr($line, 0, $-[1]);
			my $ctx = "$ctx_before$name";
1432 1433

			# Ignore those directives where spaces _are_ permitted.
1434 1435 1436 1437 1438 1439
			if ($name =~ /^(?:
				if|for|while|switch|return|case|
				volatile|__volatile__|
				__attribute__|format|__extension__|
				asm|__asm__)$/x)
			{
1440 1441 1442 1443

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

			# cpp #elif statement condition may start with a (
1447
			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
1448 1449 1450

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

			} else {
1454
				WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
1455
			}
1456
		}
1457
# Check operator spacing.
1458
		if (!($line=~/\#\s*include/)) {
1459 1460 1461 1462
			my $ops = qr{
				<<=|>>=|<=|>=|==|!=|
				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
				=>|->|<<|>>|<|>|=|!|~|
1463
				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
1464
			}x;
1465
			my @elements = split(/($ops|;)/, $opline);
1466
			my $off = 0;
1467 1468 1469

			my $blank = copy_spacing($opline);

1470
			for (my $n = 0; $n < $#elements; $n += 2) {
1471 1472
				$off += length($elements[$n]);

1473 1474 1475 1476 1477 1478 1479 1480
				# 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";

1481 1482 1483
				my $a = '';
				$a = 'V' if ($elements[$n] ne '');
				$a = 'W' if ($elements[$n] =~ /\s$/);
1484
				$a = 'C' if ($elements[$n] =~ /$;$/);
1485 1486
				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
				$a = 'O' if ($elements[$n] eq '');
1487
				$a = 'E' if ($ca =~ /^\s*$/);
1488

1489
				my $op = $elements[$n + 1];
1490 1491

				my $c = '';
1492
				if (defined $elements[$n + 2]) {
1493 1494
					$c = 'V' if ($elements[$n + 2] ne '');
					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
1495
					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
1496 1497
					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
					$c = 'O' if ($elements[$n + 2] eq '');
1498
					$c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
1499 1500
				} else {
					$c = 'E';
1501 1502
				}

1503 1504 1505 1506
				my $ctx = "${a}x${c}";

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

1507
				my $ptr = substr($blank, 0, $off) . "^";
1508
				my $hereptr = "$hereline$ptr\n";
1509

1510 1511 1512
				# Classify operators into binary, unary, or
				# definitions (* only) where they have more
				# than one mode.
1513 1514 1515 1516 1517 1518 1519 1520 1521
				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;
1522 1523
				}
				#if ($op eq '-' || $op eq '&' || $op eq '*') {
1524
				#	print "UNARY: <$op_left$op_type $is_unary $a:$op:$c> <$ca:$op:$cc> <$unary_ctx>\n";
1525
				#}
1526

1527 1528 1529 1530
				# Ignore operators passed as parameters.
				if ($op_type ne 'V' &&
				    $ca =~ /\s$/ && $cc =~ /^\s*,/) {

1531 1532
#				# Ignore comments
#				} elsif ($op =~ /^$;+$/) {
1533

1534
				# ; should have either the end of line or a space or \ after it
1535
				} elsif ($op eq ';') {
1536 1537
					if ($ctx !~ /.x[WEBC]/ &&
					    $cc !~ /^\\/ && $cc !~ /^;/) {
1538
						ERROR("space required after that '$op' $at\n" . $hereptr);
1539 1540 1541 1542
					}

				# // is a comment
				} elsif ($op eq '//') {
1543 1544 1545

				# -> should have no spaces
				} elsif ($op eq '->') {
1546
					if ($ctx =~ /Wx.|.xW/) {
1547
						ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
1548 1549 1550 1551
					}

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

1556 1557 1558 1559 1560 1561 1562 1563 1564
				# '*' 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 '&'))) {
1565
					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
1566
						ERROR("space required before that '$op' $at\n" . $hereptr);
1567
					}
1568 1569 1570 1571
					if ($op  eq '*' && $cc =~/\s*const\b/) {
						# A unary '*' may be const

					} elsif ($ctx =~ /.xW/) {
1572
						ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1573 1574 1575 1576
					}

				# unary ++ and unary -- are allowed no space on one side.
				} elsif ($op eq '++' or $op eq '--') {
1577 1578 1579 1580 1581 1582
					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);
1583
					}
1584 1585
					if ($ctx =~ /ExW/) {
						ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1586
					}
1587

1588

1589
				# << and >> may either have or not have spaces both sides
1590 1591 1592
				} elsif ($op eq '<<' or $op eq '>>' or
					 $op eq '&' or $op eq '^' or $op eq '|' or
					 $op eq '+' or $op eq '-' or
1593 1594
					 $op eq '*' or $op eq '/' or
					 $op eq '%')
1595
				{
1596
					if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
1597 1598
						ERROR("need consistent spacing around '$op' $at\n" .
							$hereptr);
1599 1600 1601
					}

				# All the others need spaces both sides.
1602
				} elsif ($ctx !~ /[EWC]x[CWE]/) {
1603 1604 1605
					# Ignore email addresses <foo@bar>
					if (!($op eq '<' && $cb =~ /$;\S+\@\S+>/) &&
					    !($op eq '>' && $cb =~ /<\S+\@\S+$;/)) {
1606
						ERROR("spaces required around that '$op' $at\n" . $hereptr);
1607
					}
1608
				}
1609
				$off += length($elements[$n + 1]);
1610 1611 1612
			}
		}

1613 1614
# check for multiple assignments
		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
1615
			CHK("multiple assignments should be avoided\n" . $herecurr);
1616 1617
		}

1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631
## # 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);
## 			}
## 		}
1632

1633
#need space before brace following if, while, etc
1634 1635
		if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
		    $line =~ /do{/) {
1636
			ERROR("space required before the open brace '{'\n" . $herecurr);
1637 1638 1639 1640 1641
		}

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

1645 1646
# check spacing on square brackets
		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
1647
			ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
1648 1649
		}
		if ($line =~ /\s\]/) {
1650
			ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
1651 1652
		}

1653
# check spacing on parentheses
1654 1655
		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
		    $line !~ /for\s*\(\s+;/) {
1656
			ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
1657
		}
1658
		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
1659 1660
		    $line !~ /for\s*\(.*;\s+\)/ &&
		    $line !~ /:\s+\)/) {
1661
			ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
1662 1663
		}

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

1670 1671 1672 1673 1674 1675
# Return is not a function.
		if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
			my $spacing = $1;
			my $value = $2;

			# Flatten any parentheses and braces
1676
			$value =~ s/\)\(/\) \(/g;
1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687
			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);
			}
		}

1688
# Need a space before open parenthesis after if, while etc
1689
		if ($line=~/\b(if|while|for|switch)\(/) {
1690
			ERROR("space required before the open parenthesis '('\n" . $herecurr);
1691 1692 1693
		}

# Check for illegal assignment in if conditional.
1694
		if ($line =~ /\bif\s*\(/) {
1695
			my ($s, $c) = ($stat, $cond);
1696 1697

			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/) {
1698
				ERROR("do not use assignment in if condition\n" . $herecurr);
1699 1700 1701 1702
			}

			# Find out what is on the end of the line after the
			# conditional.
1703
			substr($s, 0, length($c), '');
1704
			$s =~ s/\n.*//g;
1705
			$s =~ s/$;//g; 	# Remove any comments
1706
			if (length($c) && $s !~ /^\s*({|;|)\s*\\*\s*$/ &&
1707
			    $c !~ /^.\s*\#\s*if/)
1708
			{
1709 1710 1711 1712
				ERROR("trailing statements should be on next line\n" . $herecurr);
			}
		}

1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727
# 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);
		}

1728
# if and else should not have general statements after it
1729 1730 1731 1732 1733 1734
		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);
			}
1735 1736 1737 1738 1739 1740
		}

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

1744 1745 1746 1747 1748 1749
		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.
1750
			substr($s, 0, length($c), '');
1751 1752 1753 1754 1755 1756 1757
			$s =~ s/\n.*//g;

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

1758 1759 1760 1761 1762 1763 1764 1765
#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
1766
		if ($line=~/\#\s*define.*\\\s$/) {
1767
			WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
1768 1769
		}

1770
#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
1771 1772 1773 1774 1775
		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')
			{
1776
				WARN("Use #include <linux/$1.h> instead of <asm/$1.h>\n" .
1777
					$herecurr);
1778 1779 1780
			}
		}

1781 1782
# 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
1783
# in a known good container
1784
		if ($line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
1785 1786
			my $ln = $linenr;
			my $cnt = $realcnt;
1787 1788
			my ($off, $dstat, $dcond, $rest);
			my $ctx = '';
1789

1790 1791 1792 1793 1794 1795 1796 1797
			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";
1798
				$cnt-- if ($lines[$ln - 1] !~ /^-/);
1799 1800 1801 1802 1803 1804 1805
				$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";
1806
			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
1807 1808 1809 1810

			# Extract the remainder of the define (if any) and
			# rip off surrounding spaces, and trailing \'s.
			$rest = '';
1811 1812 1813 1814 1815 1816
			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--;
				}
1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828
				$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*//;
1829
			}
1830 1831 1832
			$dstat =~ s/\\\n.//g;
			$dstat =~ s/^\s*//s;
			$dstat =~ s/\s*$//s;
1833

1834 1835 1836 1837
			# Flatten any parentheses and braces
			while ($dstat =~ s/\([^\(\)]*\)/1/) {
			}
			while ($dstat =~ s/\{[^\{\}]*\}/1/) {
1838
			}
1839

1840 1841 1842 1843 1844 1845 1846 1847
			my $exceptions = qr{
				$Declare|
				module_param_named|
				MODULE_PARAM_DESC|
				DECLARE_PER_CPU|
				DEFINE_PER_CPU|
				__typeof__\(
			}x;
1848
			#print "REST<$rest>\n";
1849 1850 1851 1852
			if ($rest ne '') {
				if ($rest !~ /while\s*\(/ &&
				    $dstat !~ /$exceptions/)
				{
1853
					ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
1854 1855 1856 1857 1858 1859 1860 1861
				}

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

1867
# check for redundant bracing round if etc
1868 1869
		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
			my ($level, $endln, @chunks) =
1870
				ctx_statement_full($linenr, $realcnt, 1);
1871
			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
1872 1873
			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
			if ($#chunks > 0 && $level == 0) {
1874 1875
				my $allowed = 0;
				my $seen = 0;
1876
				my $herectx = $here . "\n";
1877
				my $ln = $linenr - 1;
1878 1879 1880
				for my $chunk (@chunks) {
					my ($cond, $block) = @{$chunk};

1881 1882 1883 1884 1885 1886 1887 1888 1889 1890
					# 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";
1891 1892
					$ln += statement_rawlines($block) - 1;

1893
					substr($block, 0, length($cond), '');
1894 1895 1896

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

1897 1898 1899
					#print "cond<$cond> block<$block> allowed<$allowed>\n";
					if (statement_lines($cond) > 1) {
						#print "APW: ALLOWED: cond<$cond>\n";
1900 1901 1902
						$allowed = 1;
					}
					if ($block =~/\b(?:if|for|while)\b/) {
1903
						#print "APW: ALLOWED: block<$block>\n";
1904 1905
						$allowed = 1;
					}
1906 1907
					if (statement_block_size($block) > 1) {
						#print "APW: ALLOWED: lines block<$block>\n";
1908 1909 1910 1911
						$allowed = 1;
					}
				}
				if ($seen && !$allowed) {
1912
					WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
1913 1914 1915
				}
			}
		}
1916
		if (!defined $suppress_ifbraces{$linenr - 1} &&
1917
					$line =~ /\b(if|while|for|else)\b/) {
1918 1919 1920 1921 1922 1923 1924
			my $allowed = 0;

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

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

1929 1930
			# Check the condition.
			my ($cond, $block) = @{$chunks[0]};
1931
			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
1932
			if (defined $cond) {
1933
				substr($block, 0, length($cond), '');
1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950
			}
			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) {
1951
					substr($block, 0, length($cond), '');
1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963
				}
				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";;
1964
				}
1965 1966

				WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
1967 1968 1969
			}
		}

1970
# don't include deprecated include files (uses RAW line)
1971
		for my $inc (@dep_includes) {
1972
			if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
1973
				ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
1974 1975 1976
			}
		}

1977 1978
# don't use deprecated functions
		for my $func (@dep_functions) {
1979
			if ($line =~ /\b$func\b/) {
1980
				ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
1981 1982 1983 1984
			}
		}

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

1990 1991 1992 1993 1994
# 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);
		}

1995
# warn about #if 0
1996
		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
1997 1998
			CHK("if this code is redundant consider removing it\n" .
				$herecurr);
1999 2000
		}

2001 2002 2003 2004 2005 2006 2007 2008
# check for needless kfree() checks
		if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
			my $expr = $1;
			if ($line =~ /\bkfree\(\Q$expr\E\);/) {
				WARN("kfree(NULL) is safe this check is probabally not required\n" . $hereprev);
			}
		}

2009
# warn about #ifdefs in C files
2010
#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
2011 2012 2013 2014 2015
#			print "#ifdef in C files should be avoided\n";
#			print "$herecurr";
#			$clean = 0;
#		}

2016
# warn about spacing in #ifdefs
2017
		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
2018 2019 2020
			ERROR("exactly one space required after that #$1\n" . $herecurr);
		}

2021
# check for spinlock_t definitions without a comment.
2022 2023
		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
2024 2025
			my $which = $1;
			if (!ctx_has_comment($first_line, $linenr)) {
2026
				CHK("$1 definition without comment\n" . $herecurr);
2027 2028 2029 2030 2031
			}
		}
# 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)) {
2032
				CHK("memory barrier without comment\n" . $herecurr);
2033 2034 2035
			}
		}
# check of hardware specific defines
2036
		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
2037
			CHK("architecture specific defines should be avoided\n" .  $herecurr);
2038
		}
2039

2040 2041
# check the location of the inline attribute, that it is between
# storage class and type.
2042 2043
		if ($line =~ /\b$Type\s+$Inline\b/ ||
		    $line =~ /\b$Inline\s+$Storage\b/) {
2044 2045 2046
			ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
		}

2047 2048 2049 2050 2051
# Check for __inline__ and __inline, prefer inline
		if ($line =~ /\b(__inline__|__inline)\b/) {
			WARN("plain inline is preferred over $1\n" . $herecurr);
		}

2052
# check for new externs in .c files.
2053
		if ($realfile =~ /\.c$/ && defined $stat &&
2054
		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
2055
		{
2056 2057
			my $function_name = $1;
			my $paren_space = $2;
2058 2059 2060 2061 2062

			my $s = $stat;
			if (defined $cond) {
				substr($s, 0, length($cond), '');
			}
2063 2064 2065
			if ($s =~ /^\s*;/ &&
			    $function_name ne 'uninitialized_var')
			{
2066 2067 2068 2069 2070 2071
				WARN("externs should be avoided in .c files\n" .  $herecurr);
			}

			if ($paren_space =~ /\n/) {
				WARN("arguments for function declarations should follow identifier\n" . $herecurr);
			}
2072 2073 2074 2075 2076

		} elsif ($realfile =~ /\.c$/ && defined $stat &&
		    $stat =~ /^.\s*extern\s+/)
		{
			WARN("externs should be avoided in .c files\n" .  $herecurr);
2077 2078 2079 2080 2081 2082 2083 2084 2085
		}

# 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);
			}
2086
		}
2087 2088 2089 2090 2091

# 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);
		}
2092 2093 2094 2095 2096

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

# check for semaphores used as mutexes
2099
		if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
2100 2101 2102
			WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
		}
# check for semaphores used as mutexes
2103
		if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
2104 2105 2106 2107 2108 2109
			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);
		}
2110 2111 2112 2113
# check for __initcall(), use device_initcall() explicitly please
		if ($line =~ /^.\s*__initcall\s*\(/) {
			WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
		}
2114 2115 2116 2117

# 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/ &&
2118 2119
		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
2120 2121 2122
		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
2123 2124 2125
		{
			WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
		}
2126 2127 2128 2129 2130 2131 2132 2133 2134 2135

# 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;
			}
		}
2136 2137 2138 2139 2140 2141
	}

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

2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156
	# 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) {
2157
		ERROR("Does not appear to be a unified-diff format patch\n");
2158 2159
	}
	if ($is_patch && $chk_signoff && $signoff == 0) {
2160
		ERROR("Missing Signed-off-by: line(s)\n");
2161 2162
	}

2163
	print report_dump();
2164 2165
	if ($summary && !($clean == 1 && $quiet == 1)) {
		print "$filename " if ($summary_file);
2166 2167 2168 2169
		print "total: $cnt_error errors, $cnt_warn warnings, " .
			(($check)? "$cnt_chk checks, " : "") .
			"$cnt_lines lines checked\n";
		print "\n" if ($quiet == 0);
2170
	}
2171

2172
	if ($clean == 1 && $quiet == 0) {
2173
		print "$vname has no obvious style problems and is ready for submission.\n"
2174 2175
	}
	if ($clean == 0 && $quiet == 0) {
2176
		print "$vname has style problems, please review.  If any of these errors\n";
2177 2178 2179
		print "are false positives report them to the maintainer, see\n";
		print "CHECKPATCH in MAINTAINERS.\n";
	}
2180

2181 2182
	return $clean;
}