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

use strict;

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

A
Andy Whitcroft 已提交
13
my $V = '0.29';
14 15 16 17 18 19 20

use Getopt::Long qw(:config no_auto_abbrev);

my $quiet = 0;
my $tree = 1;
my $chk_signoff = 1;
my $chk_patch = 1;
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 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
my $help = 0;

sub help {
	my ($exitcode) = @_;

	print << "EOM";
Usage: $P [OPTION]... [FILE]...
Version: $V

Options:
  -q, --quiet                quiet
  --no-tree                  run without a kernel tree
  --no-signoff               do not check for 'Signed-off-by' line
  --patch                    treat FILE as patchfile (default)
  --emacs                    emacs compile window format
  --terse                    one line per report
  -f, --file                 treat FILE as regular source file
  --subjective, --strict     enable more subjective tests
  --root=PATH                PATH to the kernel tree root
  --no-summary               suppress the per-file summary
  --mailback                 only produce a report in case of warnings/errors
  --summary-file             include the filename in summary
  --debug KEY=[0|1]          turn on/off debugging of KEY, where KEY is one of
                             'values', 'possible', 'type', and 'attr' (default
                             is all off)
  --test-only=WORD           report only warnings/errors containing WORD
                             literally
  -h, --help, --version      display this help and exit

When FILE is - read standard input.
EOM

	exit($exitcode);
}

66
GetOptions(
67
	'q|quiet+'	=> \$quiet,
68 69 70
	'tree!'		=> \$tree,
	'signoff!'	=> \$chk_signoff,
	'patch!'	=> \$chk_patch,
71
	'emacs!'	=> \$emacs,
72
	'terse!'	=> \$terse,
73
	'f|file!'	=> \$file,
74 75 76
	'subjective!'	=> \$check,
	'strict!'	=> \$check,
	'root=s'	=> \$root,
77 78
	'summary!'	=> \$summary,
	'mailback!'	=> \$mailback,
79 80
	'summary-file!'	=> \$summary_file,

81
	'debug=s'	=> \%debug,
82
	'test-only=s'	=> \$tst_only,
83 84 85 86 87
	'h|help'	=> \$help,
	'version'	=> \$help
) or help(1);

help(0) if ($help);
88 89 90 91

my $exit = 0;

if ($#ARGV < 0) {
92
	print "$P: no input files\n";
93 94 95
	exit(1);
}

96 97
my $dbg_values = 0;
my $dbg_possible = 0;
98
my $dbg_type = 0;
99
my $dbg_attr = 0;
100
for my $key (keys %debug) {
101 102 103
	## no critic
	eval "\${dbg_$key} = '$debug{$key}';";
	die "$@" if ($@);
104 105
}

106 107 108 109 110
if ($terse) {
	$emacs = 1;
	$quiet++;
}

111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
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);
	}
129 130
}

131 132
my $emitted_corrupt = 0;

133 134 135 136
our $Ident	= qr{
			[A-Za-z_][A-Za-z\d_]*
			(?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
		}x;
137 138 139 140 141 142 143 144
our $Storage	= qr{extern|static|asmlinkage};
our $Sparse	= qr{
			__user|
			__kernel|
			__force|
			__iomem|
			__must_check|
			__init_refok|
145 146
			__kprobes|
			__ref
147 148 149 150 151
		}x;
our $Attribute	= qr{
			const|
			__read_mostly|
			__kprobes|
152 153 154
			__(?:mem|cpu|dev|)(?:initdata|init)|
			____cacheline_aligned|
			____cacheline_aligned_in_smp|
155 156
			____cacheline_internodealigned_in_smp|
			__weak
157
		  }x;
158
our $Modifier;
159 160 161 162 163 164
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{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
165
our $Compare    = qr{<=|>=|==|!=|<|>};
166 167 168
our $Operators	= qr{
			<=|>=|==|!=|
			=>|->|<<|>>|<|>|!|~|
169
			&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
170 171
		  }x;

172 173 174 175
our $NonptrType;
our $Type;
our $Declare;

176 177 178 179 180 181 182 183 184 185 186
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;

187
our $typeTypedefs = qr{(?x:
188
	(?:__)?(?:u|s|be|le)(?:8|16|32|64)|
189 190 191
	atomic_t
)};

192 193
our @typeList = (
	qr{void},
194 195 196 197 198 199 200
	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},
201 202 203 204 205 206 207 208 209 210 211
	qr{unsigned},
	qr{float},
	qr{double},
	qr{bool},
	qr{struct\s+$Ident},
	qr{union\s+$Ident},
	qr{enum\s+$Ident},
	qr{${Ident}_t},
	qr{${Ident}_handler},
	qr{${Ident}_handler_fn},
);
212 213 214
our @modifierList = (
	qr{fastcall},
);
215 216

sub build_types {
217 218
	my $mods = "(?x:  \n" . join("|\n  ", @modifierList) . "\n)";
	my $all = "(?x:  \n" . join("|\n  ", @typeList) . "\n)";
219
	$Modifier	= qr{(?:$Attribute|$Sparse|$mods)};
220
	$NonptrType	= qr{
221
			(?:$Modifier\s+|const\s+)*
222
			(?:
223
				(?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
224
				(?:$typeTypedefs\b)|
225
				(?:${all}\b)
226
			)
227
			(?:\s+$Modifier|\s+const)*
228 229
		  }x;
	$Type	= qr{
230
			$NonptrType
231
			(?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
232
			(?:\s+$Inline|\s+$Modifier)*
233 234 235 236
		  }x;
	$Declare	= qr{(?:$Storage\s+)?$Type};
}
build_types();
237 238 239

$chk_signoff = 0 if ($file);

240 241
my @dep_includes = ();
my @dep_functions = ();
242 243
my $removal = "Documentation/feature-removal-schedule.txt";
if ($tree && -f "$root/$removal") {
244
	open(my $REMOVE, '<', "$root/$removal") ||
245
				die "$P: $removal: open failed - $!\n";
246
	while (<$REMOVE>) {
247 248 249
		if (/^Check:\s+(.*\S)/) {
			for my $entry (split(/[, ]+/, $1)) {
				if ($entry =~ m@include/(.*)@) {
250 251
					push(@dep_includes, $1);

252 253 254
				} elsif ($entry !~ m@/@) {
					push(@dep_functions, $entry);
				}
255
			}
256 257
		}
	}
258
	close($REMOVE);
259 260
}

261
my @rawlines = ();
262 263
my @lines = ();
my $vname;
264
for my $filename (@ARGV) {
265
	my $FILE;
266
	if ($file) {
267
		open($FILE, '-|', "diff -u /dev/null $filename") ||
268
			die "$P: $filename: diff failed - $!\n";
269 270
	} elsif ($filename eq '-') {
		open($FILE, '<&STDIN');
271
	} else {
272
		open($FILE, '<', "$filename") ||
273
			die "$P: $filename: open failed - $!\n";
274
	}
275 276 277 278 279
	if ($filename eq '-') {
		$vname = 'Your patch';
	} else {
		$vname = $filename;
	}
280
	while (<$FILE>) {
281 282 283
		chomp;
		push(@rawlines, $_);
	}
284
	close($FILE);
285
	if (!process($filename)) {
286 287 288
		$exit = 1;
	}
	@rawlines = ();
289
	@lines = ();
290 291 292 293 294
}

exit($exit);

sub top_of_kernel_tree {
295 296 297 298 299 300 301 302 303 304 305 306
	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;
		}
307
	}
308
	return 1;
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
}

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;
}
331
sub copy_spacing {
332
	(my $res = shift) =~ tr/\t/ /c;
333 334
	return $res;
}
335

336 337 338 339 340 341 342 343 344 345 346 347 348
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));
}

349 350 351 352 353 354 355 356 357 358 359
my $sanitise_quote = '';

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

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
360 361 362 363 364 365
sub sanitise_line {
	my ($line) = @_;

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

366
	my $qlen = 0;
367 368
	my $off = 0;
	my $c;
369

370 371 372 373 374 375 376 377 378 379 380 381 382 383
	# 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;
384
		}
385
		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
386 387 388 389
			$sanitise_quote = '';
			substr($res, $off, 2, "$;$;");
			$off++;
			next;
390
		}
391 392 393 394 395 396 397
		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
			$sanitise_quote = '//';

			substr($res, $off, 2, $sanitise_quote);
			$off++;
			next;
		}
398 399 400 401 402 403 404

		# 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;
405
		}
406 407 408 409
		# Regular quotes.
		if ($c eq "'" || $c eq '"') {
			if ($sanitise_quote eq '') {
				$sanitise_quote = $c;
410

411 412 413 414 415 416
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
417

418
		#print "c<$c> SQ<$sanitise_quote>\n";
419 420
		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
			substr($res, $off, 1, $;);
421 422
		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
			substr($res, $off, 1, $;);
423 424 425 426 427
		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
			substr($res, $off, 1, 'X');
		} else {
			substr($res, $off, 1, $c);
		}
428 429
	}

430 431 432 433
	if ($sanitise_quote eq '//') {
		$sanitise_quote = '';
	}

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

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

445 446 447
	return $res;
}

448 449 450 451 452 453
sub ctx_statement_block {
	my ($linenr, $remain, $off) = @_;
	my $line = $linenr - 1;
	my $blk = '';
	my $soff = $off;
	my $coff = $off - 1;
454
	my $coff_set = 0;
455

456 457
	my $loff = 0;

458 459
	my $type = '';
	my $level = 0;
460
	my @stack = ();
461
	my $p;
462 463
	my $c;
	my $len = 0;
464 465

	my $remainder;
466
	while (1) {
467 468
		@stack = (['', 0]) if ($#stack == -1);

469
		#warn "CSB: blk<$blk> remain<$remain>\n";
470 471 472 473
		# If we are about to drop off the end, pull in more
		# context.
		if ($off >= $len) {
			for (; $remain > 0; $line++) {
474
				last if (!defined $lines[$line]);
475
				next if ($lines[$line] =~ /^-/);
476
				$remain--;
477
				$loff = $len;
478
				$blk .= $lines[$line] . "\n";
479 480 481 482 483 484
				$len = length($blk);
				$line++;
				last;
			}
			# Bail if there is no further context.
			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
485
			if ($off >= $len) {
486 487 488
				last;
			}
		}
489
		$p = $c;
490
		$c = substr($blk, $off, 1);
491
		$remainder = substr($blk, $off);
492

493
		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
494 495 496 497 498 499 500 501 502 503

		# Handle nested #if/#else.
		if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
			push(@stack, [ $type, $level ]);
		} elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
			($type, $level) = @{$stack[$#stack - 1]};
		} elsif ($remainder =~ /^#\s*endif\b/) {
			($type, $level) = @{pop(@stack)};
		}

504 505 506 507 508 509
		# Statement ends at the ';' or a close '}' at the
		# outermost level.
		if ($level == 0 && $c eq ';') {
			last;
		}

510
		# An else is really a conditional as long as its not else if
511 512 513 514 515 516 517 518
		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";
519 520
		}

521 522 523 524 525 526 527 528 529 530
		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;
531 532
				$coff_set = 1;
				#warn "CSB: mark coff<$coff>\n";
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
			}
		}
		if (($type eq '' || $type eq '{') && $c eq '{') {
			$level++;
			$type = '{';
		}
		if ($type eq '{' && $c eq '}') {
			$level--;
			$type = ($level != 0)? '{' : '';

			if ($level == 0) {
				last;
			}
		}
		$off++;
	}
549
	# We are truly at the end, so shuffle to the next line.
550
	if ($off == $len) {
551
		$loff = $len + 1;
552 553 554
		$line++;
		$remain--;
	}
555 556 557 558 559 560 561

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

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

562
	#print "coff<$coff> soff<$off> loff<$loff>\n";
563 564 565 566 567

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

568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
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;
	}
}

611 612 613 614 615 616
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

617
	# Grab the first conditional/block pair.
618 619
	($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
620
	#print "F: c<$condition> s<$statement> remain<$remain>\n";
621 622 623 624 625 626 627
	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.
628 629 630
	for (;;) {
		($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
631
		#print "C: c<$condition> s<$statement> remain<$remain>\n";
632
		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
633 634
		#print "C: push\n";
		push(@chunks, [ $condition, $statement ]);
635 636 637
	}

	return ($level, $linenr, @chunks);
638 639
}

640
sub ctx_block_get {
641
	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
642 643 644 645 646 647 648
	my $line;
	my $start = $linenr - 1;
	my $blk = '';
	my @o;
	my @c;
	my @res = ();

649
	my $level = 0;
650
	my @stack = ($level);
651 652 653 654 655
	for ($line = $start; $remain > 0; $line++) {
		next if ($rawlines[$line] =~ /^-/);
		$remain--;

		$blk .= $rawlines[$line];
656 657 658 659 660 661 662 663 664 665

		# Handle nested #if/#else.
		if ($rawlines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
			push(@stack, $level);
		} elsif ($rawlines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
			$level = $stack[$#stack - 1];
		} elsif ($rawlines[$line] =~ /^.\s*#\s*endif\b/) {
			$level = pop(@stack);
		}

666 667 668 669 670 671
		foreach my $c (split(//, $rawlines[$line])) {
			##print "C<$c>L<$level><$open$close>O<$off>\n";
			if ($off > 0) {
				$off--;
				next;
			}
672

673 674 675 676 677 678 679
			if ($c eq $close && $level > 0) {
				$level--;
				last if ($level == 0);
			} elsif ($c eq $open) {
				$level++;
			}
		}
680

681
		if (!$outer || $level <= 1) {
682
			push(@res, $rawlines[$line]);
683 684
		}

685
		last if ($level == 0);
686 687
	}

688
	return ($level, @res);
689 690 691 692
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

693 694
	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
	return @r;
695 696 697 698
}
sub ctx_block {
	my ($linenr, $remain) = @_;

699 700
	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
	return @r;
701 702
}
sub ctx_statement {
703 704 705 706 707 708
	my ($linenr, $remain, $off) = @_;

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

711
	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
712
}
713 714 715 716 717
sub ctx_statement_level {
	my ($linenr, $remain, $off) = @_;

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
718 719 720 721 722

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

	# Catch a comment on the end of the line itself.
723
	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
724 725 726 727 728 729 730
	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++) {
731 732
		my $line = $rawlines[$linenr - 1];
		#warn "           $line\n";
733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754
		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);

755
	##print "LINE: $rawlines[$end_line - 1 ]\n";
756 757 758 759 760
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776
sub raw_line {
	my ($linenr, $cnt) = @_;

	my $offset = $linenr - 1;
	$cnt++;

	my $line;
	while ($cnt) {
		$line = $rawlines[$offset++];
		next if (defined($line) && $line =~ /^-/);
		$cnt--;
	}

	return $line;
}

777 778 779
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
780

781 782 783 784 785 786
	$res = '';
	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
		$res .= $1;
		if ($2 ne '') {
			$coded = sprintf("^%c", unpack('C', $2) + 64);
			$res .= $coded;
787 788
		}
	}
789
	$res =~ s/$/\$/;
790

791
	return $res;
792 793
}

794
my $av_preprocessor = 0;
795
my $av_pending;
796
my @av_paren_type;
797
my $av_pend_colon;
798 799 800

sub annotate_reset {
	$av_preprocessor = 0;
801 802
	$av_pending = '_';
	@av_paren_type = ('E');
803
	$av_pend_colon = 'O';
804 805
}

806 807
sub annotate_values {
	my ($stream, $type) = @_;
808

809
	my $res;
810
	my $var = '_' x length($stream);
811 812
	my $cur = $stream;

813
	print "$stream\n" if ($dbg_values > 1);
814 815

	while (length($cur)) {
816
		@av_paren_type = ('E') if ($#av_paren_type < 0);
817
		print " <" . join('', @av_paren_type) .
818
				"> <$type> <$av_pending>" if ($dbg_values > 1);
819
		if ($cur =~ /^(\s+)/o) {
820 821
			print "WS($1)\n" if ($dbg_values > 1);
			if ($1 =~ /\n/ && $av_preprocessor) {
822
				$type = pop(@av_paren_type);
823
				$av_preprocessor = 0;
824 825
			}

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

830 831 832 833
		} elsif ($cur =~ /^($Modifier)\s*/) {
			print "MODIFIER($1)\n" if ($dbg_values > 1);
			$type = 'T';

834
		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
835
			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
836
			$av_preprocessor = 1;
837 838 839 840 841 842
			push(@av_paren_type, $type);
			if ($2 ne '') {
				$av_pending = 'N';
			}
			$type = 'E';

843
		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
844 845 846
			print "UNDEF($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;
			push(@av_paren_type, $type);
847

848
		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
849
			print "PRE_START($1)\n" if ($dbg_values > 1);
850
			$av_preprocessor = 1;
851 852 853

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
854
			$type = 'E';
855

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

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

862
			$type = 'E';
863

864
		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
865 866 867 868 869 870 871 872
			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);
873
			$type = 'E';
874 875

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

878 879 880 881 882
		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
			print "ATTR($1)\n" if ($dbg_values > 1);
			$av_pending = $type;
			$type = 'N';

883
		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
884
			print "SIZEOF($1)\n" if ($dbg_values > 1);
885
			if (defined $2) {
886
				$av_pending = 'V';
887 888 889
			}
			$type = 'N';

890
		} elsif ($cur =~ /^(if|while|for)\b/o) {
891
			print "COND($1)\n" if ($dbg_values > 1);
892
			$av_pending = 'E';
893 894
			$type = 'N';

895 896 897 898 899
		} elsif ($cur =~/^(case)/o) {
			print "CASE($1)\n" if ($dbg_values > 1);
			$av_pend_colon = 'C';
			$type = 'N';

900
		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
901
			print "KEYWORD($1)\n" if ($dbg_values > 1);
902 903 904
			$type = 'N';

		} elsif ($cur =~ /^(\()/o) {
905
			print "PAREN('$1')\n" if ($dbg_values > 1);
906 907
			push(@av_paren_type, $av_pending);
			$av_pending = '_';
908 909 910
			$type = 'N';

		} elsif ($cur =~ /^(\))/o) {
911 912 913
			my $new_type = pop(@av_paren_type);
			if ($new_type ne '_') {
				$type = $new_type;
914 915
				print "PAREN('$1') -> $type\n"
							if ($dbg_values > 1);
916
			} else {
917
				print "PAREN('$1')\n" if ($dbg_values > 1);
918 919
			}

920
		} elsif ($cur =~ /^($Ident)\s*\(/o) {
921
			print "FUNC($1)\n" if ($dbg_values > 1);
922
			$type = 'V';
923
			$av_pending = 'V';
924

925 926
		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
			if (defined $2 && $type eq 'C' || $type eq 'T') {
927
				$av_pend_colon = 'B';
928 929
			} elsif ($type eq 'E') {
				$av_pend_colon = 'L';
930 931 932 933
			}
			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
			$type = 'V';

934
		} elsif ($cur =~ /^($Ident|$Constant)/o) {
935
			print "IDENT($1)\n" if ($dbg_values > 1);
936 937 938
			$type = 'V';

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

942
		} elsif ($cur =~/^(;|{|})/) {
943
			print "END($1)\n" if ($dbg_values > 1);
944
			$type = 'E';
945 946
			$av_pend_colon = 'O';

947 948 949 950
		} elsif ($cur =~/^(,)/) {
			print "COMMA($1)\n" if ($dbg_values > 1);
			$type = 'C';

951 952 953 954 955 956 957 958 959 960 961 962 963 964
		} elsif ($cur =~ /^(\?)/o) {
			print "QUESTION($1)\n" if ($dbg_values > 1);
			$type = 'N';

		} elsif ($cur =~ /^(:)/o) {
			print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);

			substr($var, length($res), 1, $av_pend_colon);
			if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
				$type = 'E';
			} else {
				$type = 'N';
			}
			$av_pend_colon = 'O';
965

966
		} elsif ($cur =~ /^(\[)/o) {
967
			print "CLOSE($1)\n" if ($dbg_values > 1);
968 969
			$type = 'N';

970
		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
971 972 973 974 975 976 977 978 979 980 981 982
			my $variant;

			print "OPV($1)\n" if ($dbg_values > 1);
			if ($type eq 'V') {
				$variant = 'B';
			} else {
				$variant = 'U';
			}

			substr($var, length($res), 1, $variant);
			$type = 'N';

983
		} elsif ($cur =~ /^($Operators)/o) {
984
			print "OP($1)\n" if ($dbg_values > 1);
985 986 987 988 989
			if ($1 ne '++' && $1 ne '--') {
				$type = 'N';
			}

		} elsif ($cur =~ /(^.)/o) {
990
			print "C($1)\n" if ($dbg_values > 1);
991 992 993 994 995
		}
		if (defined $1) {
			$cur = substr($cur, length($1));
			$res .= $type x length($1);
		}
996
	}
997

998
	return ($res, $var);
999 1000
}

1001
sub possible {
1002
	my ($possible, $line) = @_;
1003
	my $notPermitted = qr{(?:
1004 1005 1006 1007
		^(?:
			$Modifier|
			$Storage|
			$Type|
1008 1009 1010
			DEFINE_\S+
		)$|
		^(?:
1011 1012 1013 1014 1015 1016
			goto|
			return|
			case|
			else|
			asm|__asm__|
			do
1017
		)(?:\s|$)|
1018
		^(?:typedef|struct|enum)\b
1019 1020 1021
	    )}x;
	warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
	if ($possible !~ $notPermitted) {
1022 1023 1024 1025 1026 1027 1028
		# 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;
1029
			for my $modifier (split(' ', $possible)) {
1030 1031 1032 1033
				if ($modifier !~ $notPermitted) {
					warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
					push(@modifierList, $modifier);
				}
1034
			}
1035 1036 1037 1038 1039

		} else {
			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
			push(@typeList, $possible);
		}
1040
		build_types();
1041 1042
	} else {
		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1043 1044 1045
	}
}

1046 1047
my $prefix = '';

1048
sub report {
1049 1050 1051
	if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
		return 0;
	}
1052 1053 1054 1055
	my $line = $prefix . $_[0];

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

1056
	push(our @report, $line);
1057 1058

	return 1;
1059 1060
}
sub report_dump {
1061
	our @report;
1062
}
1063
sub ERROR {
1064 1065 1066 1067
	if (report("ERROR: $_[0]\n")) {
		our $clean = 0;
		our $cnt_error++;
	}
1068 1069
}
sub WARN {
1070 1071 1072 1073
	if (report("WARNING: $_[0]\n")) {
		our $clean = 0;
		our $cnt_warn++;
	}
1074 1075
}
sub CHK {
1076
	if ($check && report("CHECK: $_[0]\n")) {
1077 1078 1079
		our $clean = 0;
		our $cnt_chk++;
	}
1080 1081
}

1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
sub check_absolute_file {
	my ($absolute, $herecurr) = @_;
	my $file = $absolute;

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

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

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

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

1109 1110 1111 1112 1113
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
1114
	my $prevrawline="";
1115
	my $stashline="";
1116
	my $stashrawline="";
1117

1118
	my $length;
1119 1120 1121 1122
	my $indent;
	my $previndent=0;
	my $stashindent=0;

1123
	our $clean = 1;
1124 1125 1126
	my $signoff = 0;
	my $is_patch = 0;

1127
	our @report = ();
1128 1129 1130 1131 1132
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

1133 1134 1135 1136 1137 1138
	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
	my $in_comment = 0;
1139
	my $comment_edge = 0;
1140
	my $first_line = 0;
1141
	my $p1_prefix = '';
1142

1143 1144 1145
	my $prev_values = 'E';

	# suppression flags
1146
	my %suppress_ifbraces;
1147
	my %suppress_whiletrailers;
1148

1149
	# Pre-scan the patch sanitizing the lines.
1150
	# Pre-scan the patch looking for any __setup documentation.
1151
	#
1152 1153
	my @setup_docs = ();
	my $setup_docs = 0;
1154 1155

	sanitise_line_reset();
1156 1157
	my $line;
	foreach my $rawline (@rawlines) {
1158 1159
		$linenr++;
		$line = $rawline;
1160

1161
		if ($rawline=~/^\+\+\+\s+(\S+)/) {
1162 1163 1164 1165
			$setup_docs = 0;
			if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
				$setup_docs = 1;
			}
1166 1167 1168 1169 1170 1171 1172 1173 1174
			#next;
		}
		if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1175
			$in_comment = 0;
1176 1177 1178 1179 1180 1181

			# 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;
1182 1183 1184 1185 1186 1187
			my $cnt = $realcnt;
			for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
				next if (defined $rawlines[$ln - 1] &&
					 $rawlines[$ln - 1] =~ /^-/);
				$cnt--;
				#print "RAW<$rawlines[$ln - 1]>\n";
1188
				last if (!defined $rawlines[$ln - 1]);
1189 1190 1191 1192 1193
				if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
				    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
					($edge) = $1;
					last;
				}
1194 1195 1196 1197 1198 1199 1200 1201 1202
			}
			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 &&
1203
			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1204 1205 1206 1207 1208 1209 1210
			{
				$in_comment = 1;
			}

			##print "COMMENT:$in_comment edge<$edge> $rawline\n";
			sanitise_line_reset($in_comment);

1211
		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1212
			# Standardise the strings and chars within the input to
1213
			# simplify matching -- only bother with positive lines.
1214
			$line = sanitise_line($rawline);
1215
		}
1216 1217 1218 1219 1220 1221 1222 1223 1224 1225
		push(@lines, $line);

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

		#print "==>$rawline\n";
		#print "-->$line\n";
1226 1227 1228 1229 1230 1231

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

1232 1233
	$prefix = '';

1234 1235
	$realcnt = 0;
	$linenr = 0;
1236 1237 1238
	foreach my $line (@lines) {
		$linenr++;

1239
		my $rawline = $rawlines[$linenr - 1];
1240

1241
#extract the line range in the file after the patch is applied
1242
		if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1243
			$is_patch = 1;
1244
			$first_line = $linenr + 1;
1245 1246 1247 1248 1249 1250
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1251
			annotate_reset();
1252 1253
			$prev_values = 'E';

1254
			%suppress_ifbraces = ();
1255
			%suppress_whiletrailers = ();
1256 1257
			next;

1258 1259 1260
# 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.
1261
		} elsif ($line =~ /^( |\+|$)/) {
1262
			$realline++;
1263
			$realcnt-- if ($realcnt != 0);
1264

1265
			# Measure the line length and indent.
1266
			($length, $indent) = line_stats($rawline);
1267 1268 1269 1270

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

1273
			#warn "line<$line>\n";
1274

1275 1276
		} elsif ($realcnt == 1) {
			$realcnt--;
1277 1278
		}

1279 1280
		my $hunk_line = ($realcnt != 0);

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

1285 1286
		$here = "#$linenr: " if (!$file);
		$here = "#$realline: " if ($file);
1287 1288 1289 1290

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

			$p1_prefix = $1;
1294 1295
			if (!$file && $tree && $p1_prefix ne '' &&
			    -e "$root/$p1_prefix") {
1296 1297
				WARN("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
			}
1298

1299
			if ($realfile =~ m@^include/asm/@) {
1300 1301 1302 1303 1304
				ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
			}
			next;
		}

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

1307 1308 1309
		my $hereline = "$here\n$rawline\n";
		my $herecurr = "$here\n$rawline\n";
		my $hereprev = "$here\n$prevrawline\n$rawline\n";
1310

1311 1312
		$cnt_lines++ if ($realcnt != 0);

1313
#check the patch for a signoff:
1314
		if ($line =~ /^\s*signed-off-by:/i) {
1315 1316
			# This is a signoff, if ugly, so do not double report.
			$signoff++;
1317
			if (!($line =~ /^\s*Signed-off-by:/)) {
1318 1319
				WARN("Signed-off-by: is the preferred form\n" .
					$herecurr);
1320 1321
			}
			if ($line =~ /^\s*signed-off-by:\S/i) {
1322
				WARN("space required after Signed-off-by:\n" .
1323
					$herecurr);
1324 1325 1326
			}
		}

1327
# Check for wrappage within a valid hunk of the file
1328
		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1329
			ERROR("patch seems to be corrupt (line wrapped?)\n" .
1330
				$herecurr) if (!$emitted_corrupt++);
1331 1332
		}

1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346
# Check for absolute kernel paths.
		if ($tree) {
			while ($line =~ m{(?:^|\s)(/\S*)}g) {
				my $file = $1;

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

1347 1348
# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1349 1350 1351 1352 1353 1354 1355 1356
		    $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);
1357 1358
		}

1359 1360
# ignore non-hunk lines and lines being removed
		next if (!$hunk_line || $line =~ /^-/);
1361 1362

#trailing whitespace
1363
		if ($line =~ /^\+.*\015/) {
1364
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1365 1366
			ERROR("DOS line endings\n" . $herevet);

1367 1368
		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1369
			ERROR("trailing whitespace\n" . $herevet);
1370
		}
1371 1372 1373 1374

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

1375
#80 column limit
1376
		if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1377 1378 1379
		    $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
		    $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
		    $length > 80)
1380
		{
1381
			WARN("line over 80 characters\n" . $herecurr);
1382 1383
		}

1384 1385 1386 1387 1388
# 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);
		}

1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400
# Blackfin: use hi/lo macros
		if ($realfile =~ m@arch/blackfin/.*\.S$@) {
			if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
				my $herevet = "$here\n" . cat_vet($line) . "\n";
				ERROR("use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
			}
			if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
				my $herevet = "$here\n" . cat_vet($line) . "\n";
				ERROR("use the HI() macro, not (... >> 16)\n" . $herevet);
			}
		}

1401 1402
# check we are in a valid source file C or perl if not then ignore this hunk
		next if ($realfile !~ /\.(h|c|pl)$/);
1403 1404 1405

# at the beginning of a line any tabs must come first and anything
# more than 8 must use tabs.
1406 1407 1408
		if ($rawline =~ /^\+\s* \t\s*\S/ ||
		    $rawline =~ /^\+\s*        \s*/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1409
			ERROR("code indent should use tabs where possible\n" . $herevet);
1410 1411
		}

1412 1413 1414
# check we are in a valid C source file if not then ignore this hunk
		next if ($realfile !~ /\.(h|c)$/);

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

1420 1421 1422 1423 1424 1425 1426 1427 1428 1429
# Blackfin: don't use __builtin_bfin_[cs]sync
		if ($line =~ /__builtin_bfin_csync/) {
			my $herevet = "$here\n" . cat_vet($line) . "\n";
			ERROR("use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
		}
		if ($line =~ /__builtin_bfin_ssync/) {
			my $herevet = "$here\n" . cat_vet($line) . "\n";
			ERROR("use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
		}

1430
# Check for potential 'bare' types
1431
		my ($stat, $cond, $line_nr_next, $remain_next, $off_next);
1432
		if ($realcnt && $line =~ /.\s*\S/) {
1433
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1434
				ctx_statement_block($linenr, $realcnt, 0);
1435 1436 1437 1438 1439
			$stat =~ s/\n./\n /g;
			$cond =~ s/\n./\n /g;

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

1441
			# Ignore goto labels.
1442
			if ($s =~ /$Ident:\*$/s) {
1443 1444

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

1447 1448
			} elsif ($s =~ /^.\s*else\b/s) {

1449
			# declarations always start with types
1450
			} elsif ($prev_values eq 'E' && $s =~ /^.\s*(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?((?:\s*$Ident)+?)\b(?:\s+$Sparse)?\s*\**\s*(?:$Ident|\(\*[^\)]*\))(?:\s*$Modifier)?\s*(?:;|=|,|\()/s) {
1451 1452 1453 1454
				my $type = $1;
				$type =~ s/\s+/ /g;
				possible($type, "A:" . $s);

1455
			# definitions in global scope can only start with types
1456
			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
1457
				possible($1, "B:" . $s);
1458
			}
1459 1460

			# any (foo ... *) is a pointer cast, and foo is a type
1461
			while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
1462
				possible($1, "C:" . $s);
1463 1464 1465 1466 1467
			}

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

1471
				my $ctx = $s;
1472
				substr($ctx, 0, $name_len + 1, '');
1473
				$ctx =~ s/\)[^\)]*$//;
1474

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

1478
						possible($1, "D:" . $s);
1479 1480
					}
				}
1481
			}
1482

1483 1484
		}

1485 1486 1487
#
# Checks which may be anchored in the context.
#
1488

1489 1490
# Check for switch () and associated case and default
# statements should be at the same indent.
1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506
		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 '') {
1507
				ERROR("switch and case should be at the same indent\n$hereline$err");
1508 1509 1510 1511 1512
			}
		}

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

1516
			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
1517 1518 1519
			my $ctx_cnt = $realcnt - $#ctx - 1;
			my $ctx = join("\n", @ctx);

1520 1521
			my $ctx_ln = $linenr;
			my $ctx_skip = $realcnt;
1522

1523 1524 1525 1526 1527
			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] !~ /^-/);
1528 1529
				$ctx_ln++;
			}
1530

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

1534 1535
			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
				ERROR("that open brace { should be on the previous line\n" .
1536
					"$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1537
			}
1538 1539 1540 1541
			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
			    $ctx =~ /\)\s*\;\s*$/ &&
			    defined $lines[$ctx_ln - 1])
			{
1542 1543
				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
				if ($nindent > $indent) {
1544
					WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
1545
						"$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1546 1547
				}
			}
1548 1549
		}

1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561
# 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;

			# Find out how long the conditional actually is.
1562 1563
			my @newlines = ($c =~ /\n/gs);
			my $cond_lines = 1 + $#newlines;
1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576

			# 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;
			}
1577
			if ($s =~ s/^\s*?\n//) {
1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588
				$check = 1;
				$cond_lines++;
			}

			# Also ignore a loop construct at the end of a
			# preprocessor statement.
			if (($prevline =~ /^.\s*#\s*define\s/ ||
			    $prevline =~ /\\\s*$/) && $continuation == 0) {
				$check = 0;
			}

1589
			my $cond_ptr = -1;
1590
			$continuation = 0;
1591 1592 1593
			while ($cond_ptr != $cond_lines) {
				$cond_ptr = $cond_lines;

1594 1595 1596 1597 1598 1599
				# If we see an #else/#elif then the code
				# is not linear.
				if ($s =~ /^\s*\#\s*(?:else|elif)/) {
					$check = 0;
				}

1600 1601 1602 1603
				# Ignore:
				#  1) blank lines, they should be at 0,
				#  2) preprocessor lines, and
				#  3) labels.
1604 1605
				if ($continuation ||
				    $s =~ /^\s*?\n/ ||
1606 1607
				    $s =~ /^\s*#\s*?/ ||
				    $s =~ /^\s*$Ident\s*:/) {
1608
					$continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
1609 1610 1611
					if ($s =~ s/^.*?\n//) {
						$cond_lines++;
					}
1612
				}
1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627
			}

			my (undef, $sindent) = line_stats("+" . $s);
			my $stat_real = raw_line($linenr, $cond_lines);

			# Check if either of these lines are modified, else
			# this is not this patch's fault.
			if (!defined($stat_real) ||
			    $stat !~ /^\+/ && $stat_real !~ /^\+/) {
				$check = 0;
			}
			if (defined($stat_real) && $cond_lines > 1) {
				$stat_real = "[...]\n$stat_real";
			}

1628
			#print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s> cond_lines<$cond_lines> stat_real<$stat_real> stat<$stat>\n";
1629 1630 1631 1632 1633 1634 1635

			if ($check && (($sindent % 8) != 0 ||
			    ($sindent <= $indent && $s ne ''))) {
				WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
			}
		}

1636 1637
		# Track the 'values' across context and added lines.
		my $opline = $line; $opline =~ s/^./ /;
1638 1639
		my ($curr_values, $curr_vars) =
				annotate_values($opline . "\n", $prev_values);
1640
		$curr_values = $prev_values . $curr_values;
1641 1642
		if ($dbg_values) {
			my $outline = $opline; $outline =~ s/\t/ /g;
1643 1644
			print "$linenr > .$outline\n";
			print "$linenr > $curr_values\n";
1645
			print "$linenr >  $curr_vars\n";
1646
		}
1647 1648
		$prev_values = substr($curr_values, -1);

1649 1650 1651
#ignore lines not being added
		if ($line=~/^[^\+]/) {next;}

1652
# TEST: allow direct testing of the type matcher.
1653 1654 1655 1656 1657 1658
		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);
			}
1659 1660
			next;
		}
1661 1662
# TEST: allow direct testing of the attribute matcher.
		if ($dbg_attr) {
1663
			if ($line =~ /^.\s*$Modifier\s*$/) {
1664
				ERROR("TEST: is attr\n" . $herecurr);
1665
			} elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
1666 1667 1668 1669
				ERROR("TEST: is not attr ($1 is)\n". $herecurr);
			}
			next;
		}
1670

1671
# check for initialisation to aggregates open brace on the next line
1672 1673
		if ($line =~ /^.\s*{/ &&
		    $prevline =~ /(?:^|[^=])=\s*$/) {
1674
			ERROR("that open brace { should be on the previous line\n" . $hereprev);
1675 1676
		}

1677 1678 1679 1680 1681
#
# Checks which are anchored on the added line.
#

# check for malformed paths in #include statements (uses RAW line)
1682
		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
1683 1684
			my $path = $1;
			if ($path =~ m{//}) {
1685 1686
				ERROR("malformed #include filename\n" .
					$herecurr);
1687 1688
			}
		}
1689

1690
# no C99 // comments
1691
		if ($line =~ m{//}) {
1692
			ERROR("do not use C99 // comments\n" . $herecurr);
1693
		}
1694
		# Remove C99 comments.
1695
		$line =~ s@//.*@@;
1696
		$opline =~ s@//.*@@;
1697 1698

#EXPORT_SYMBOL should immediately follow its function closing }.
1699 1700 1701
		if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
		    ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
			my $name = $1;
1702 1703 1704 1705 1706 1707 1708 1709
			if ($prevline !~ /(?:
				^.}|
				^.DEFINE_$Ident\(\Q$name\E\)|
				^.DECLARE_$Ident\(\Q$name\E\)|
				^.LIST_HEAD\(\Q$name\E\)|
				^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
				\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)
			    )/x) {
1710
				WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
1711 1712 1713
			}
		}

1714
# check for external initialisers.
1715
		if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
1716 1717 1718
			ERROR("do not initialise externals to 0 or NULL\n" .
				$herecurr);
		}
1719
# check for static initialisers.
1720
		if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
1721 1722
			ERROR("do not initialise statics to 0 or NULL\n" .
				$herecurr);
1723 1724
		}

1725 1726 1727
# check for new typedefs, only function parameters and sparse annotations
# make sense.
		if ($line =~ /\btypedef\s/ &&
1728
		    $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
1729
		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
1730
		    $line !~ /\b$typeTypedefs\b/ &&
1731
		    $line !~ /\b__bitwise(?:__|)\b/) {
1732
			WARN("do not add new typedefs\n" . $herecurr);
1733 1734 1735
		}

# * goes on variable not on type
1736
		# (char*[ const])
1737
		if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
1738 1739 1740 1741 1742 1743 1744
			my ($from, $to) = ($1, $1);

			# Should start with a space.
			$to =~ s/^(\S)/ $1/;
			# Should not end with a space.
			$to =~ s/\s+$//;
			# '*'s should not have spaces between.
1745
			while ($to =~ s/\*\s+\*/\*\*/) {
1746
			}
1747

1748 1749 1750 1751
			#print "from<$from> to<$to>\n";
			if ($from ne $to) {
				ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" .  $herecurr);
			}
1752
		} elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
1753 1754 1755 1756 1757 1758 1759
			my ($from, $to, $ident) = ($1, $1, $2);

			# Should start with a space.
			$to =~ s/^(\S)/ $1/;
			# Should not end with a space.
			$to =~ s/\s+$//;
			# '*'s should not have spaces between.
1760
			while ($to =~ s/\*\s+\*/\*\*/) {
1761 1762 1763
			}
			# Modifiers should have spaces.
			$to =~ s/(\b$Modifier$)/$1 /;
1764

1765 1766
			#print "from<$from> to<$to> ident<$ident>\n";
			if ($from ne $to && $ident !~ /^$Modifier$/) {
1767 1768
				ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" .  $herecurr);
			}
1769 1770 1771 1772 1773 1774 1775 1776 1777
		}

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

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

1782 1783 1784 1785 1786
# 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.
1787
		if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800
			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) {
1801
				WARN("printk() should include KERN_ facility level\n" . $herecurr);
1802
			}
1803 1804
		}

1805 1806
# function brace can't be on same line, except for #defines of do while,
# or if closed on same line
1807 1808
		if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
		    !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
1809
			ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
1810
		}
1811

1812 1813 1814 1815 1816 1817
# 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);
		}

1818 1819
# check for spacing round square brackets; allowed:
#  1. with a type on the left -- int [] a;
1820 1821
#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
#  3. inside a curly brace -- = { [0...10] = 5 }
1822 1823 1824
		while ($line =~ /(.*?\s)\[/g) {
			my ($where, $prefix) = ($-[1], $1);
			if ($prefix !~ /$Type\s+$/ &&
1825 1826
			    ($where != 0 || $prefix !~ /^.\s+$/) &&
			    $prefix !~ /{\s+$/) {
1827 1828 1829 1830
				ERROR("space prohibited before open square bracket '['\n" . $herecurr);
			}
		}

1831
# check for spaces between functions and their parentheses.
1832
		while ($line =~ /($Ident)\s+\(/g) {
1833
			my $name = $1;
1834 1835
			my $ctx_before = substr($line, 0, $-[1]);
			my $ctx = "$ctx_before$name";
1836 1837

			# Ignore those directives where spaces _are_ permitted.
1838 1839 1840 1841 1842 1843
			if ($name =~ /^(?:
				if|for|while|switch|return|case|
				volatile|__volatile__|
				__attribute__|format|__extension__|
				asm|__asm__)$/x)
			{
1844 1845 1846 1847

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

			# cpp #elif statement condition may start with a (
1851
			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
1852 1853 1854

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

			} else {
1858
				WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
1859
			}
1860
		}
1861
# Check operator spacing.
1862
		if (!($line=~/\#\s*include/)) {
1863 1864 1865 1866
			my $ops = qr{
				<<=|>>=|<=|>=|==|!=|
				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
				=>|->|<<|>>|<|>|=|!|~|
1867 1868
				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
				\?|:
1869
			}x;
1870
			my @elements = split(/($ops|;)/, $opline);
1871
			my $off = 0;
1872 1873 1874

			my $blank = copy_spacing($opline);

1875
			for (my $n = 0; $n < $#elements; $n += 2) {
1876 1877
				$off += length($elements[$n]);

1878 1879 1880 1881 1882 1883 1884 1885
				# 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";

1886 1887 1888
				my $a = '';
				$a = 'V' if ($elements[$n] ne '');
				$a = 'W' if ($elements[$n] =~ /\s$/);
1889
				$a = 'C' if ($elements[$n] =~ /$;$/);
1890 1891
				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
				$a = 'O' if ($elements[$n] eq '');
1892
				$a = 'E' if ($ca =~ /^\s*$/);
1893

1894
				my $op = $elements[$n + 1];
1895 1896

				my $c = '';
1897
				if (defined $elements[$n + 2]) {
1898 1899
					$c = 'V' if ($elements[$n + 2] ne '');
					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
1900
					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
1901 1902
					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
					$c = 'O' if ($elements[$n + 2] eq '');
1903
					$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
1904 1905
				} else {
					$c = 'E';
1906 1907
				}

1908 1909 1910 1911
				my $ctx = "${a}x${c}";

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

1912
				my $ptr = substr($blank, 0, $off) . "^";
1913
				my $hereptr = "$hereline$ptr\n";
1914

1915
				# Pull out the value of this operator.
1916
				my $op_type = substr($curr_values, $off + 1, 1);
1917

1918 1919 1920
				# Get the full operator variant.
				my $opv = $op . substr($curr_vars, $off, 1);

1921 1922 1923 1924
				# Ignore operators passed as parameters.
				if ($op_type ne 'V' &&
				    $ca =~ /\s$/ && $cc =~ /^\s*,/) {

1925 1926
#				# Ignore comments
#				} elsif ($op =~ /^$;+$/) {
1927

1928
				# ; should have either the end of line or a space or \ after it
1929
				} elsif ($op eq ';') {
1930 1931
					if ($ctx !~ /.x[WEBC]/ &&
					    $cc !~ /^\\/ && $cc !~ /^;/) {
1932
						ERROR("space required after that '$op' $at\n" . $hereptr);
1933 1934 1935 1936
					}

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

1938 1939 1940 1941
				# No spaces for:
				#   ->
				#   :   when part of a bitfield
				} elsif ($op eq '->' || $opv eq ':B') {
1942
					if ($ctx =~ /Wx.|.xW/) {
1943
						ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
1944 1945 1946 1947
					}

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

1952
				# '*' as part of a type definition -- reported already.
1953
				} elsif ($opv eq '*_') {
1954 1955 1956 1957 1958 1959
					#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 '~' ||
1960
					 $opv eq '*U' || $opv eq '-U' ||
1961
					 $opv eq '&U' || $opv eq '&&U') {
1962
					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
1963
						ERROR("space required before that '$op' $at\n" . $hereptr);
1964
					}
1965
					if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
1966 1967 1968
						# A unary '*' may be const

					} elsif ($ctx =~ /.xW/) {
1969
						ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1970 1971 1972 1973
					}

				# unary ++ and unary -- are allowed no space on one side.
				} elsif ($op eq '++' or $op eq '--') {
1974 1975 1976 1977 1978 1979
					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);
1980
					}
1981 1982
					if ($ctx =~ /ExW/) {
						ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1983
					}
1984

1985

1986
				# << and >> may either have or not have spaces both sides
1987 1988 1989
				} elsif ($op eq '<<' or $op eq '>>' or
					 $op eq '&' or $op eq '^' or $op eq '|' or
					 $op eq '+' or $op eq '-' or
1990 1991
					 $op eq '*' or $op eq '/' or
					 $op eq '%')
1992
				{
1993
					if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
1994 1995
						ERROR("need consistent spacing around '$op' $at\n" .
							$hereptr);
1996 1997
					}

1998 1999 2000 2001 2002 2003 2004
				# A colon needs no spaces before when it is
				# terminating a case value or a label.
				} elsif ($opv eq ':C' || $opv eq ':L') {
					if ($ctx =~ /Wx./) {
						ERROR("space prohibited before that '$op' $at\n" . $hereptr);
					}

2005
				# All the others need spaces both sides.
2006
				} elsif ($ctx !~ /[EWC]x[CWE]/) {
2007 2008
					my $ok = 0;

2009
					# Ignore email addresses <foo@bar>
2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024
					if (($op eq '<' &&
					     $cc =~ /^\S+\@\S+>/) ||
					    ($op eq '>' &&
					     $ca =~ /<\S+\@\S+$/))
					{
					    	$ok = 1;
					}

					# Ignore ?:
					if (($opv eq ':O' && $ca =~ /\?$/) ||
					    ($op eq '?' && $cc =~ /^:/)) {
					    	$ok = 1;
					}

					if ($ok == 0) {
2025
						ERROR("spaces required around that '$op' $at\n" . $hereptr);
2026
					}
2027
				}
2028
				$off += length($elements[$n + 1]);
2029 2030 2031
			}
		}

2032 2033
# check for multiple assignments
		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
2034
			CHK("multiple assignments should be avoided\n" . $herecurr);
2035 2036
		}

2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050
## # 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);
## 			}
## 		}
2051

2052
#need space before brace following if, while, etc
2053 2054
		if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
		    $line =~ /do{/) {
2055
			ERROR("space required before the open brace '{'\n" . $herecurr);
2056 2057 2058 2059 2060
		}

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

2064 2065
# check spacing on square brackets
		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
2066
			ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
2067 2068
		}
		if ($line =~ /\s\]/) {
2069
			ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
2070 2071
		}

2072
# check spacing on parentheses
2073 2074
		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
		    $line !~ /for\s*\(\s+;/) {
2075
			ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
2076
		}
2077
		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
2078 2079
		    $line !~ /for\s*\(.*;\s+\)/ &&
		    $line !~ /:\s+\)/) {
2080
			ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
2081 2082
		}

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

2089 2090 2091 2092 2093
# Return is not a function.
		if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
			my $spacing = $1;
			my $value = $2;

2094
			# Flatten any parentheses
2095
			$value =~ s/\)\(/\) \(/g;
2096 2097 2098 2099 2100
			while ($value =~ s/\[[^\{\}]*\]/1/ ||
			       $value !~ /(?:$Ident|-?$Constant)\s*
					     $Compare\s*
					     (?:$Ident|-?$Constant)/x &&
			       $value =~ s/\([^\(\)]*\)/1/) {
2101 2102 2103 2104 2105 2106 2107 2108 2109 2110
			}

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

2111
# Need a space before open parenthesis after if, while etc
2112
		if ($line=~/\b(if|while|for|switch)\(/) {
2113
			ERROR("space required before the open parenthesis '('\n" . $herecurr);
2114 2115
		}

2116 2117
# Check for illegal assignment in if conditional -- and check for trailing
# statements after the conditional.
2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137
		if ($line =~ /do\s*(?!{)/) {
			my ($stat_next) = ctx_statement_block($line_nr_next,
						$remain_next, $off_next);
			$stat_next =~ s/\n./\n /g;
			##print "stat<$stat> stat_next<$stat_next>\n";

			if ($stat_next =~ /^\s*while\b/) {
				# If the statement carries leading newlines,
				# then count those as offsets.
				my ($whitespace) =
					($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
				my $offset =
					statement_rawlines($whitespace) - 1;

				$suppress_whiletrailers{$line_nr_next +
								$offset} = 1;
			}
		}
		if (!defined $suppress_whiletrailers{$linenr} &&
		    $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
2138
			my ($s, $c) = ($stat, $cond);
2139

2140
			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2141
				ERROR("do not use assignment in if condition\n" . $herecurr);
2142 2143 2144 2145
			}

			# Find out what is on the end of the line after the
			# conditional.
2146
			substr($s, 0, length($c), '');
2147
			$s =~ s/\n.*//g;
2148
			$s =~ s/$;//g; 	# Remove any comments
2149 2150
			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
			    $c !~ /}\s*while\s*/)
2151
			{
2152 2153 2154 2155 2156 2157 2158 2159 2160 2161
				# Find out how long the conditional actually is.
				my @newlines = ($c =~ /\n/gs);
				my $cond_lines = 1 + $#newlines;

				my $stat_real = raw_line($linenr, $cond_lines);
				if (defined($stat_real) && $cond_lines > 1) {
					$stat_real = "[...]\n$stat_real";
				}

				ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real);
2162 2163 2164
			}
		}

2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179
# 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);
		}

2180
# if and else should not have general statements after it
2181 2182 2183 2184 2185 2186
		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);
			}
2187
		}
2188 2189 2190 2191 2192
# if should not continue a brace
		if ($line =~ /}\s*if\b/) {
			ERROR("trailing statements should be on next line\n" .
				$herecurr);
		}
2193 2194 2195
# case and default should not have general statements after them
		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
		    $line !~ /\G(?:
2196
			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
2197 2198 2199 2200 2201
			\s*return\s+
		    )/xg)
		{
			ERROR("trailing statements should be on next line\n" . $herecurr);
		}
2202 2203 2204 2205 2206

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

2210 2211 2212 2213 2214 2215
		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.
2216
			substr($s, 0, length($c), '');
2217 2218 2219 2220 2221 2222 2223
			$s =~ s/\n.*//g;

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

2224 2225 2226 2227 2228 2229 2230 2231
#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
2232
		if ($line=~/\#\s*define.*\\\s$/) {
2233
			WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
2234 2235
		}

2236
#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2237
		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2238 2239 2240 2241
			my $file = "$1.h";
			my $checkfile = "include/linux/$file";
			if (-f "$root/$checkfile" &&
			    $realfile ne $checkfile &&
2242 2243
			    $1 ne 'irq')
			{
2244 2245 2246 2247 2248
				if ($realfile =~ m{^arch/}) {
					CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
				} else {
					WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
				}
2249 2250 2251
			}
		}

2252 2253
# 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
2254
# in a known good container
2255 2256
		if ($realfile !~ m@/vmlinux.lds.h$@ &&
		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2257 2258
			my $ln = $linenr;
			my $cnt = $realcnt;
2259 2260
			my ($off, $dstat, $dcond, $rest);
			my $ctx = '';
2261

2262 2263 2264 2265 2266 2267 2268 2269
			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";
2270
				$cnt-- if ($lines[$ln - 1] !~ /^-/);
2271 2272 2273 2274 2275 2276 2277
				$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";
2278
			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2279 2280 2281 2282

			# Extract the remainder of the define (if any) and
			# rip off surrounding spaces, and trailing \'s.
			$rest = '';
2283 2284
			while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
				#print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
2285 2286 2287 2288
				if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
					$rest .= substr($lines[$ln - 1], $off) . "\n";
					$cnt--;
				}
2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300
				$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*//;
2301
			}
2302
			$dstat =~ s/$;//g;
2303 2304 2305
			$dstat =~ s/\\\n.//g;
			$dstat =~ s/^\s*//s;
			$dstat =~ s/\s*$//s;
2306

2307
			# Flatten any parentheses and braces
2308 2309 2310 2311
			while ($dstat =~ s/\([^\(\)]*\)/1/ ||
			       $dstat =~ s/\{[^\{\}]*\}/1/ ||
			       $dstat =~ s/\[[^\{\}]*\]/1/)
			{
2312
			}
2313

2314 2315 2316 2317 2318 2319
			my $exceptions = qr{
				$Declare|
				module_param_named|
				MODULE_PARAM_DESC|
				DECLARE_PER_CPU|
				DEFINE_PER_CPU|
2320
				__typeof__\(|
2321 2322
				\.$Ident\s*=\s*|
				^\"|\"$
2323
			}x;
2324
			#print "REST<$rest> dstat<$dstat>\n";
2325 2326 2327 2328
			if ($rest ne '') {
				if ($rest !~ /while\s*\(/ &&
				    $dstat !~ /$exceptions/)
				{
2329
					ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
2330 2331 2332 2333 2334 2335
				}

			} elsif ($ctx !~ /;/) {
				if ($dstat ne '' &&
				    $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
				    $dstat !~ /$exceptions/ &&
2336
				    $dstat !~ /^\.$Ident\s*=/ &&
2337 2338
				    $dstat =~ /$Operators/)
				{
2339
					ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
2340
				}
2341
			}
2342 2343
		}

2344 2345 2346 2347 2348 2349 2350 2351 2352
# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
# all assignments may have only one of the following with an assignment:
#	.
#	ALIGN(...)
#	VMLINUX_SYMBOL(...)
		if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
			WARN("vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
		}

2353
# check for redundant bracing round if etc
2354 2355
		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
			my ($level, $endln, @chunks) =
2356
				ctx_statement_full($linenr, $realcnt, 1);
2357
			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2358 2359
			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
			if ($#chunks > 0 && $level == 0) {
2360 2361
				my $allowed = 0;
				my $seen = 0;
2362
				my $herectx = $here . "\n";
2363
				my $ln = $linenr - 1;
2364 2365 2366
				for my $chunk (@chunks) {
					my ($cond, $block) = @{$chunk};

2367 2368 2369 2370 2371 2372 2373 2374 2375 2376
					# 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";
2377 2378
					$ln += statement_rawlines($block) - 1;

2379
					substr($block, 0, length($cond), '');
2380 2381 2382

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

2383 2384 2385
					#print "cond<$cond> block<$block> allowed<$allowed>\n";
					if (statement_lines($cond) > 1) {
						#print "APW: ALLOWED: cond<$cond>\n";
2386 2387 2388
						$allowed = 1;
					}
					if ($block =~/\b(?:if|for|while)\b/) {
2389
						#print "APW: ALLOWED: block<$block>\n";
2390 2391
						$allowed = 1;
					}
2392 2393
					if (statement_block_size($block) > 1) {
						#print "APW: ALLOWED: lines block<$block>\n";
2394 2395 2396 2397
						$allowed = 1;
					}
				}
				if ($seen && !$allowed) {
2398
					WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
2399 2400 2401
				}
			}
		}
2402
		if (!defined $suppress_ifbraces{$linenr - 1} &&
2403
					$line =~ /\b(if|while|for|else)\b/) {
2404 2405 2406 2407 2408 2409 2410
			my $allowed = 0;

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

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

2415 2416
			# Check the condition.
			my ($cond, $block) = @{$chunks[0]};
2417
			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
2418
			if (defined $cond) {
2419
				substr($block, 0, length($cond), '');
2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436
			}
			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) {
2437
					substr($block, 0, length($cond), '');
2438 2439 2440 2441 2442 2443 2444 2445
				}
				if ($block =~ /^\s*\{/) {
					#print "APW: ALLOWED: chunk-1 block<$block>\n";
					$allowed = 1;
				}
			}
			if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
				my $herectx = $here . "\n";;
2446
				my $cnt = statement_rawlines($block);
2447

2448 2449
				for (my $n = 0; $n < $cnt; $n++) {
					$herectx .= raw_line($linenr, $n) . "\n";;
2450
				}
2451 2452

				WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
2453 2454 2455
			}
		}

2456
# don't include deprecated include files (uses RAW line)
2457
		for my $inc (@dep_includes) {
2458
			if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
2459
				ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2460 2461 2462
			}
		}

2463 2464
# don't use deprecated functions
		for my $func (@dep_functions) {
2465
			if ($line =~ /\b$func\b/) {
2466
				ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2467 2468 2469 2470
			}
		}

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

2476 2477 2478 2479 2480
# 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);
		}

2481
# warn about #if 0
2482
		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
2483 2484
			CHK("if this code is redundant consider removing it\n" .
				$herecurr);
2485 2486
		}

2487 2488 2489 2490
# check for needless kfree() checks
		if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
			my $expr = $1;
			if ($line =~ /\bkfree\(\Q$expr\E\);/) {
2491
				WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
2492 2493
			}
		}
2494 2495 2496 2497 2498 2499 2500
# 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);
			}
		}
2501

2502
# warn about #ifdefs in C files
2503
#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
2504 2505 2506 2507 2508
#			print "#ifdef in C files should be avoided\n";
#			print "$herecurr";
#			$clean = 0;
#		}

2509
# warn about spacing in #ifdefs
2510
		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
2511 2512 2513
			ERROR("exactly one space required after that #$1\n" . $herecurr);
		}

2514
# check for spinlock_t definitions without a comment.
2515 2516
		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
2517 2518
			my $which = $1;
			if (!ctx_has_comment($first_line, $linenr)) {
2519
				CHK("$1 definition without comment\n" . $herecurr);
2520 2521 2522 2523 2524
			}
		}
# 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)) {
2525
				CHK("memory barrier without comment\n" . $herecurr);
2526 2527 2528
			}
		}
# check of hardware specific defines
2529
		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
2530
			CHK("architecture specific defines should be avoided\n" .  $herecurr);
2531
		}
2532

2533 2534
# check the location of the inline attribute, that it is between
# storage class and type.
2535 2536
		if ($line =~ /\b$Type\s+$Inline\b/ ||
		    $line =~ /\b$Inline\s+$Storage\b/) {
2537 2538 2539
			ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
		}

2540 2541 2542 2543 2544
# Check for __inline__ and __inline, prefer inline
		if ($line =~ /\b(__inline__|__inline)\b/) {
			WARN("plain inline is preferred over $1\n" . $herecurr);
		}

2545
# check for new externs in .c files.
2546
		if ($realfile =~ /\.c$/ && defined $stat &&
2547
		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
2548
		{
2549 2550
			my $function_name = $1;
			my $paren_space = $2;
2551 2552 2553 2554 2555

			my $s = $stat;
			if (defined $cond) {
				substr($s, 0, length($cond), '');
			}
2556 2557 2558
			if ($s =~ /^\s*;/ &&
			    $function_name ne 'uninitialized_var')
			{
2559 2560 2561 2562 2563 2564
				WARN("externs should be avoided in .c files\n" .  $herecurr);
			}

			if ($paren_space =~ /\n/) {
				WARN("arguments for function declarations should follow identifier\n" . $herecurr);
			}
2565 2566 2567 2568 2569

		} elsif ($realfile =~ /\.c$/ && defined $stat &&
		    $stat =~ /^.\s*extern\s+/)
		{
			WARN("externs should be avoided in .c files\n" .  $herecurr);
2570 2571 2572 2573 2574 2575 2576 2577 2578
		}

# 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);
			}
2579
		}
2580 2581 2582 2583 2584

# 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);
		}
2585 2586 2587 2588 2589

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

# check for semaphores used as mutexes
2592
		if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
2593 2594 2595
			WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
		}
# check for semaphores used as mutexes
2596
		if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
2597 2598 2599 2600 2601 2602
			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);
		}
2603 2604 2605 2606
# check for __initcall(), use device_initcall() explicitly please
		if ($line =~ /^.\s*__initcall\s*\(/) {
			WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
		}
2607
# check for struct file_operations, ensure they are const.
2608 2609 2610 2611
		if ($line !~ /\bconst\b/ &&
		    $line =~ /\bstruct\s+(file_operations|seq_operations)\b/) {
			WARN("struct $1 should normally be const\n" .
				$herecurr);
2612
		}
2613 2614 2615 2616

# 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/ &&
2617 2618
		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
2619 2620 2621
		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
2622 2623 2624
		{
			WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
		}
2625 2626 2627 2628 2629

# check for %L{u,d,i} in strings
		my $string;
		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
			$string = substr($rawline, $-[1], $+[1] - $-[1]);
2630
			$string =~ s/%%/__/g;
2631 2632 2633 2634 2635
			if ($string =~ /(?<!%)%L[udi]/) {
				WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
				last;
			}
		}
2636 2637 2638 2639 2640

# whine mightly about in_atomic
		if ($line =~ /\bin_atomic\s*\(/) {
			if ($realfile =~ m@^drivers/@) {
				ERROR("do not use in_atomic in drivers\n" . $herecurr);
2641
			} elsif ($realfile !~ m@^kernel/@) {
2642 2643 2644
				WARN("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
			}
		}
2645 2646 2647 2648 2649 2650
	}

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

2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665
	# 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) {
2666
		ERROR("Does not appear to be a unified-diff format patch\n");
2667 2668
	}
	if ($is_patch && $chk_signoff && $signoff == 0) {
2669
		ERROR("Missing Signed-off-by: line(s)\n");
2670 2671
	}

2672
	print report_dump();
2673 2674
	if ($summary && !($clean == 1 && $quiet == 1)) {
		print "$filename " if ($summary_file);
2675 2676 2677 2678
		print "total: $cnt_error errors, $cnt_warn warnings, " .
			(($check)? "$cnt_chk checks, " : "") .
			"$cnt_lines lines checked\n";
		print "\n" if ($quiet == 0);
2679
	}
2680

2681
	if ($clean == 1 && $quiet == 0) {
2682
		print "$vname has no obvious style problems and is ready for submission.\n"
2683 2684
	}
	if ($clean == 0 && $quiet == 0) {
2685
		print "$vname has style problems, please review.  If any of these errors\n";
2686 2687 2688
		print "are false positives report them to the maintainer, see\n";
		print "CHECKPATCH in MAINTAINERS.\n";
	}
2689

2690 2691
	return $clean;
}