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 133 134 135 136 137 138 139 140 141
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|
142 143
			__kprobes|
			__ref
144 145 146 147 148
		}x;
our $Attribute	= qr{
			const|
			__read_mostly|
			__kprobes|
149 150 151
			__(?:mem|cpu|dev|)(?:initdata|init)|
			____cacheline_aligned|
			____cacheline_aligned_in_smp|
152 153
			____cacheline_internodealigned_in_smp|
			__weak
154
		  }x;
155
our $Modifier;
156 157 158 159 160 161
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{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
162
our $Compare    = qr{<=|>=|==|!=|<|>};
163 164 165
our $Operators	= qr{
			<=|>=|==|!=|
			=>|->|<<|>>|<|>|!|~|
166
			&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
167 168
		  }x;

169 170 171 172
our $NonptrType;
our $Type;
our $Declare;

173 174 175 176 177 178 179 180 181 182 183
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;

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

189 190
our @typeList = (
	qr{void},
191 192 193 194 195 196 197
	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},
198 199 200 201 202 203 204 205 206 207 208
	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},
);
209 210 211
our @modifierList = (
	qr{fastcall},
);
212 213

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

$chk_signoff = 0 if ($file);

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

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

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

exit($exit);

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

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

333 334 335 336 337 338 339 340 341 342 343 344 345
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));
}

346 347 348 349 350 351 352 353 354 355 356
my $sanitise_quote = '';

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

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
357 358 359 360 361 362
sub sanitise_line {
	my ($line) = @_;

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

363
	my $qlen = 0;
364 365
	my $off = 0;
	my $c;
366

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

			substr($res, $off, 2, $sanitise_quote);
			$off++;
			next;
		}
395 396 397 398 399 400 401

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

408 409 410 411 412 413
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
414

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

427 428 429 430
	if ($sanitise_quote eq '//') {
		$sanitise_quote = '';
	}

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

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

442 443 444
	return $res;
}

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

453 454
	my $loff = 0;

455 456
	my $type = '';
	my $level = 0;
457
	my @stack = ();
458
	my $p;
459 460
	my $c;
	my $len = 0;
461 462

	my $remainder;
463
	while (1) {
464 465
		@stack = (['', 0]) if ($#stack == -1);

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

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

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

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

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

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

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

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

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

559
	#print "coff<$coff> soff<$off> loff<$loff>\n";
560 561 562 563 564

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

565 566 567 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
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;
	}
}

608 609 610 611 612 613
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

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

	return ($level, $linenr, @chunks);
635 636
}

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

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

		$blk .= $rawlines[$line];
653 654 655 656 657 658 659 660 661 662

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

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

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

678
		if (!$outer || $level <= 1) {
679
			push(@res, $rawlines[$line]);
680 681
		}

682
		last if ($level == 0);
683 684
	}

685
	return ($level, @res);
686 687 688 689
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

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

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

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

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

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
715 716 717 718 719

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

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

752
	##print "LINE: $rawlines[$end_line - 1 ]\n";
753 754 755 756 757
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773
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;
}

774 775 776
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
777

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

788
	return $res;
789 790
}

791
my $av_preprocessor = 0;
792
my $av_pending;
793
my @av_paren_type;
794
my $av_pend_colon;
795 796 797

sub annotate_reset {
	$av_preprocessor = 0;
798 799
	$av_pending = '_';
	@av_paren_type = ('E');
800
	$av_pend_colon = 'O';
801 802
}

803 804
sub annotate_values {
	my ($stream, $type) = @_;
805

806
	my $res;
807
	my $var = '_' x length($stream);
808 809
	my $cur = $stream;

810
	print "$stream\n" if ($dbg_values > 1);
811 812

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

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

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

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

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

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

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
851
			$type = 'E';
852

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

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

859
			$type = 'E';
860

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

948 949 950 951 952 953 954 955 956 957 958 959 960 961
		} 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';
962

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

967
		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
968 969 970 971 972 973 974 975 976 977 978 979
			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';

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

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

995
	return ($res, $var);
996 997
}

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

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

1043 1044
my $prefix = '';

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

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

1053
	push(our @report, $line);
1054 1055

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

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

1106 1107 1108 1109 1110
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
1111
	my $prevrawline="";
1112
	my $stashline="";
1113
	my $stashrawline="";
1114

1115
	my $length;
1116 1117 1118 1119
	my $indent;
	my $previndent=0;
	my $stashindent=0;

1120
	our $clean = 1;
1121 1122 1123
	my $signoff = 0;
	my $is_patch = 0;

1124
	our @report = ();
1125 1126 1127 1128 1129
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

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

1140 1141 1142
	my $prev_values = 'E';

	# suppression flags
1143
	my %suppress_ifbraces;
1144
	my %suppress_whiletrailers;
1145

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

	sanitise_line_reset();
1153 1154
	my $line;
	foreach my $rawline (@rawlines) {
1155 1156
		$linenr++;
		$line = $rawline;
1157

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

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

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

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

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

		#print "==>$rawline\n";
		#print "-->$line\n";
1223 1224 1225 1226 1227 1228

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

1229 1230
	$prefix = '';

1231 1232
	$realcnt = 0;
	$linenr = 0;
1233 1234 1235
	foreach my $line (@lines) {
		$linenr++;

1236
		my $rawline = $rawlines[$linenr - 1];
1237

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

1251
			%suppress_ifbraces = ();
1252
			%suppress_whiletrailers = ();
1253 1254
			next;

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

1262
			# Measure the line length and indent.
1263
			($length, $indent) = line_stats($rawline);
1264 1265 1266 1267

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

1270
			#warn "line<$line>\n";
1271

1272 1273
		} elsif ($realcnt == 1) {
			$realcnt--;
1274 1275
		}

1276 1277
		my $hunk_line = ($realcnt != 0);

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

1282 1283
		$here = "#$linenr: " if (!$file);
		$here = "#$realline: " if ($file);
1284 1285 1286 1287

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

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

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

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

1304 1305 1306
		my $hereline = "$here\n$rawline\n";
		my $herecurr = "$here\n$rawline\n";
		my $hereprev = "$here\n$prevrawline\n$rawline\n";
1307

1308 1309
		$cnt_lines++ if ($realcnt != 0);

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

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

1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343
# 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);
				}
			}
		}

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

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

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

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

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

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

1381 1382 1383 1384 1385
# 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);
		}

1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397
# 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);
			}
		}

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

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

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

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

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

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

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

1438
			# Ignore goto labels.
1439
			if ($s =~ /$Ident:\*$/s) {
1440 1441

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

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

1446
			# declarations always start with types
1447
			} 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) {
1448 1449 1450 1451
				my $type = $1;
				$type =~ s/\s+/ /g;
				possible($type, "A:" . $s);

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

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

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

1468
				my $ctx = $s;
1469
				substr($ctx, 0, $name_len + 1, '');
1470
				$ctx =~ s/\)[^\)]*$//;
1471

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

1475
						possible($1, "D:" . $s);
1476 1477
					}
				}
1478
			}
1479

1480 1481
		}

1482 1483 1484
#
# Checks which may be anchored in the context.
#
1485

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

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

1513
			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
1514 1515 1516
			my $ctx_cnt = $realcnt - $#ctx - 1;
			my $ctx = join("\n", @ctx);

1517 1518
			my $ctx_ln = $linenr;
			my $ctx_skip = $realcnt;
1519

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

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

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

1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558
# 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.
1559 1560
			my @newlines = ($c =~ /\n/gs);
			my $cond_lines = 1 + $#newlines;
1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573

			# 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;
			}
1574
			if ($s =~ s/^\s*?\n//) {
1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585
				$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;
			}

1586
			my $cond_ptr = -1;
1587
			$continuation = 0;
1588 1589 1590
			while ($cond_ptr != $cond_lines) {
				$cond_ptr = $cond_lines;

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

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

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

1625
			#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";
1626 1627 1628 1629 1630 1631 1632

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

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

1646 1647 1648
#ignore lines not being added
		if ($line=~/^[^\+]/) {next;}

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

1668 1669 1670
# check for initialisation to aggregates open brace on the next line
		if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
		    $line =~ /^.\s*{/) {
1671
			ERROR("that open brace { should be on the previous line\n" . $hereprev);
1672 1673
		}

1674 1675 1676 1677 1678
#
# Checks which are anchored on the added line.
#

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

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

#EXPORT_SYMBOL should immediately follow its function closing }.
1696 1697 1698
		if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
		    ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
			my $name = $1;
1699 1700 1701 1702 1703 1704 1705 1706
			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) {
1707
				WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
1708 1709 1710
			}
		}

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

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

# * goes on variable not on type
1733
		# (char*[ const])
1734
		if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
1735 1736 1737 1738 1739 1740 1741
			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.
1742
			while ($to =~ s/\*\s+\*/\*\*/) {
1743
			}
1744

1745 1746 1747 1748
			#print "from<$from> to<$to>\n";
			if ($from ne $to) {
				ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" .  $herecurr);
			}
1749
		} elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
1750 1751 1752 1753 1754 1755 1756
			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.
1757
			while ($to =~ s/\*\s+\*/\*\*/) {
1758 1759 1760
			}
			# Modifiers should have spaces.
			$to =~ s/(\b$Modifier$)/$1 /;
1761

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

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

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

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

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

1809 1810 1811 1812 1813 1814
# 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);
		}

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

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

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

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

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

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

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

			my $blank = copy_spacing($opline);

1872
			for (my $n = 0; $n < $#elements; $n += 2) {
1873 1874
				$off += length($elements[$n]);

1875 1876 1877 1878 1879 1880 1881 1882
				# 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";

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

1891
				my $op = $elements[$n + 1];
1892 1893

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

1905 1906 1907 1908
				my $ctx = "${a}x${c}";

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

1909
				my $ptr = substr($blank, 0, $off) . "^";
1910
				my $hereptr = "$hereline$ptr\n";
1911

1912
				# Pull out the value of this operator.
1913
				my $op_type = substr($curr_values, $off + 1, 1);
1914

1915 1916 1917
				# Get the full operator variant.
				my $opv = $op . substr($curr_vars, $off, 1);

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

1922 1923
#				# Ignore comments
#				} elsif ($op =~ /^$;+$/) {
1924

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

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

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

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

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

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

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

1982

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

1995 1996 1997 1998 1999 2000 2001
				# 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);
					}

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

2006
					# Ignore email addresses <foo@bar>
2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021
					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) {
2022
						ERROR("spaces required around that '$op' $at\n" . $hereptr);
2023
					}
2024
				}
2025
				$off += length($elements[$n + 1]);
2026 2027 2028
			}
		}

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

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

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

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

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

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

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

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

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

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

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

2113 2114
# Check for illegal assignment in if conditional -- and check for trailing
# statements after the conditional.
2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134
		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*#/) {
2135
			my ($s, $c) = ($stat, $cond);
2136

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

			# Find out what is on the end of the line after the
			# conditional.
2143
			substr($s, 0, length($c), '');
2144
			$s =~ s/\n.*//g;
2145
			$s =~ s/$;//g; 	# Remove any comments
2146 2147
			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
			    $c !~ /}\s*while\s*/)
2148
			{
2149 2150 2151 2152 2153 2154 2155 2156 2157 2158
				# 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);
2159 2160 2161
			}
		}

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

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

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

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

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

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

2233
#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2234
		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2235 2236 2237 2238
			my $file = "$1.h";
			my $checkfile = "include/linux/$file";
			if (-f "$root/$checkfile" &&
			    $realfile ne $checkfile &&
2239 2240
			    $1 ne 'irq')
			{
2241 2242 2243 2244 2245
				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);
				}
2246 2247 2248
			}
		}

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

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

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

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

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

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

2341 2342 2343 2344 2345 2346 2347 2348 2349
# 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);
		}

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

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

2376
					substr($block, 0, length($cond), '');
2377 2378 2379

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

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

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

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

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

2445 2446
				for (my $n = 0; $n < $cnt; $n++) {
					$herectx .= raw_line($linenr, $n) . "\n";;
2447
				}
2448 2449

				WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
2450 2451 2452
			}
		}

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

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

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

2473 2474 2475 2476 2477
# 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);
		}

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

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

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

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

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

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

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

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

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

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

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

# 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);
			}
2576
		}
2577 2578 2579 2580 2581

# 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);
		}
2582 2583 2584 2585 2586

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

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

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

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

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

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

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

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

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

2687 2688
	return $clean;
}