checkpatch.pl 78.9 KB
Newer Older
1
#!/usr/bin/perl -w
2
# (c) 2001, Dave Jones. (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-2010 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.31';
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
my $rpt_cleaners = 0;

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

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

133 134
my $emitted_corrupt = 0;

135 136 137 138
our $Ident	= qr{
			[A-Za-z_][A-Za-z\d_]*
			(?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
		}x;
139 140 141 142 143 144 145 146
our $Storage	= qr{extern|static|asmlinkage};
our $Sparse	= qr{
			__user|
			__kernel|
			__force|
			__iomem|
			__must_check|
			__init_refok|
147 148
			__kprobes|
			__ref
149
		}x;
150 151 152

# Notes to $Attribute:
# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
153 154
our $Attribute	= qr{
			const|
155 156 157 158 159 160 161 162 163 164 165 166 167 168
			__percpu|
			__nocast|
			__safe|
			__bitwise__|
			__packed__|
			__packed2__|
			__naked|
			__maybe_unused|
			__always_unused|
			__noreturn|
			__used|
			__cold|
			__noclone|
			__deprecated|
169 170
			__read_mostly|
			__kprobes|
171
			__(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
172 173
			____cacheline_aligned|
			____cacheline_aligned_in_smp|
174 175
			____cacheline_internodealigned_in_smp|
			__weak
176
		  }x;
177
our $Modifier;
178 179 180 181 182 183
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{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
184
our $Compare    = qr{<=|>=|==|!=|<|>};
185 186 187
our $Operators	= qr{
			<=|>=|==|!=|
			=>|->|<<|>>|<|>|!|~|
188
			&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
189 190
		  }x;

191 192 193 194
our $NonptrType;
our $Type;
our $Declare;

195 196 197 198 199 200 201 202 203 204 205
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;

206
our $typeTypedefs = qr{(?x:
207
	(?:__)?(?:u|s|be|le)(?:8|16|32|64)|
208 209 210
	atomic_t
)};

211 212 213
our $logFunctions = qr{(?x:
	printk|
	pr_(debug|dbg|vdbg|devel|info|warning|err|notice|alert|crit|emerg|cont)|
214
	(dev|netdev|netif)_(printk|dbg|vdbg|info|warn|err|notice|alert|crit|emerg|WARN)|
215 216 217 218
	WARN|
	panic
)};

219 220
our @typeList = (
	qr{void},
221 222 223 224 225 226 227
	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},
228 229 230 231 232 233 234 235 236 237 238
	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},
);
239 240 241
our @modifierList = (
	qr{fastcall},
);
242

243 244 245 246 247 248
our $allowed_asm_includes = qr{(?x:
	irq|
	memory
)};
# memory.h: ARM has a custom one

249
sub build_types {
250 251
	my $mods = "(?x:  \n" . join("|\n  ", @modifierList) . "\n)";
	my $all = "(?x:  \n" . join("|\n  ", @typeList) . "\n)";
252
	$Modifier	= qr{(?:$Attribute|$Sparse|$mods)};
253
	$NonptrType	= qr{
254
			(?:$Modifier\s+|const\s+)*
255
			(?:
256
				(?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
257
				(?:$typeTypedefs\b)|
258
				(?:${all}\b)
259
			)
260
			(?:\s+$Modifier|\s+const)*
261 262
		  }x;
	$Type	= qr{
263
			$NonptrType
264
			(?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
265
			(?:\s+$Inline|\s+$Modifier)*
266 267 268 269
		  }x;
	$Declare	= qr{(?:$Storage\s+)?$Type};
}
build_types();
270 271 272

$chk_signoff = 0 if ($file);

273 274
my @dep_includes = ();
my @dep_functions = ();
275 276
my $removal = "Documentation/feature-removal-schedule.txt";
if ($tree && -f "$root/$removal") {
277
	open(my $REMOVE, '<', "$root/$removal") ||
278
				die "$P: $removal: open failed - $!\n";
279
	while (<$REMOVE>) {
280 281 282
		if (/^Check:\s+(.*\S)/) {
			for my $entry (split(/[, ]+/, $1)) {
				if ($entry =~ m@include/(.*)@) {
283 284
					push(@dep_includes, $1);

285 286 287
				} elsif ($entry !~ m@/@) {
					push(@dep_functions, $entry);
				}
288
			}
289 290
		}
	}
291
	close($REMOVE);
292 293
}

294
my @rawlines = ();
295 296
my @lines = ();
my $vname;
297
for my $filename (@ARGV) {
298
	my $FILE;
299
	if ($file) {
300
		open($FILE, '-|', "diff -u /dev/null $filename") ||
301
			die "$P: $filename: diff failed - $!\n";
302 303
	} elsif ($filename eq '-') {
		open($FILE, '<&STDIN');
304
	} else {
305
		open($FILE, '<', "$filename") ||
306
			die "$P: $filename: open failed - $!\n";
307
	}
308 309 310 311 312
	if ($filename eq '-') {
		$vname = 'Your patch';
	} else {
		$vname = $filename;
	}
313
	while (<$FILE>) {
314 315 316
		chomp;
		push(@rawlines, $_);
	}
317
	close($FILE);
318
	if (!process($filename)) {
319 320 321
		$exit = 1;
	}
	@rawlines = ();
322
	@lines = ();
323 324 325 326 327
}

exit($exit);

sub top_of_kernel_tree {
328 329 330 331 332 333 334 335 336 337 338 339
	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;
		}
340
	}
341
	return 1;
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
}

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;
}
364
sub copy_spacing {
365
	(my $res = shift) =~ tr/\t/ /c;
366 367
	return $res;
}
368

369 370 371 372 373 374 375 376 377 378 379 380 381
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));
}

382 383 384 385 386 387 388 389 390 391 392
my $sanitise_quote = '';

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

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
393 394 395 396 397 398
sub sanitise_line {
	my ($line) = @_;

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

399
	my $qlen = 0;
400 401
	my $off = 0;
	my $c;
402

403 404 405 406 407 408 409 410 411 412 413 414 415 416
	# 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;
417
		}
418
		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
419 420 421 422
			$sanitise_quote = '';
			substr($res, $off, 2, "$;$;");
			$off++;
			next;
423
		}
424 425 426 427 428 429 430
		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
			$sanitise_quote = '//';

			substr($res, $off, 2, $sanitise_quote);
			$off++;
			next;
		}
431 432 433 434 435 436 437

		# 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;
438
		}
439 440 441 442
		# Regular quotes.
		if ($c eq "'" || $c eq '"') {
			if ($sanitise_quote eq '') {
				$sanitise_quote = $c;
443

444 445 446 447 448 449
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
450

451
		#print "c<$c> SQ<$sanitise_quote>\n";
452 453
		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
			substr($res, $off, 1, $;);
454 455
		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
			substr($res, $off, 1, $;);
456 457 458 459 460
		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
			substr($res, $off, 1, 'X');
		} else {
			substr($res, $off, 1, $c);
		}
461 462
	}

463 464 465 466
	if ($sanitise_quote eq '//') {
		$sanitise_quote = '';
	}

467
	# The pathname on a #include may be surrounded by '<' and '>'.
468
	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
469 470 471 472
		my $clean = 'X' x length($1);
		$res =~ s@\<.*\>@<$clean>@;

	# The whole of a #error is a string.
473
	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
474
		my $clean = 'X' x length($1);
475
		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
476 477
	}

478 479 480
	return $res;
}

481 482 483 484 485 486
sub ctx_statement_block {
	my ($linenr, $remain, $off) = @_;
	my $line = $linenr - 1;
	my $blk = '';
	my $soff = $off;
	my $coff = $off - 1;
487
	my $coff_set = 0;
488

489 490
	my $loff = 0;

491 492
	my $type = '';
	my $level = 0;
493
	my @stack = ();
494
	my $p;
495 496
	my $c;
	my $len = 0;
497 498

	my $remainder;
499
	while (1) {
500 501
		@stack = (['', 0]) if ($#stack == -1);

502
		#warn "CSB: blk<$blk> remain<$remain>\n";
503 504 505 506
		# If we are about to drop off the end, pull in more
		# context.
		if ($off >= $len) {
			for (; $remain > 0; $line++) {
507
				last if (!defined $lines[$line]);
508
				next if ($lines[$line] =~ /^-/);
509
				$remain--;
510
				$loff = $len;
511
				$blk .= $lines[$line] . "\n";
512 513 514 515 516 517
				$len = length($blk);
				$line++;
				last;
			}
			# Bail if there is no further context.
			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
518
			if ($off >= $len) {
519 520 521
				last;
			}
		}
522
		$p = $c;
523
		$c = substr($blk, $off, 1);
524
		$remainder = substr($blk, $off);
525

526
		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
527 528 529 530 531 532 533 534 535 536

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

537 538 539 540 541 542
		# Statement ends at the ';' or a close '}' at the
		# outermost level.
		if ($level == 0 && $c eq ';') {
			last;
		}

543
		# An else is really a conditional as long as its not else if
544 545 546 547 548 549 550 551
		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";
552 553
		}

554 555 556 557 558 559 560 561 562 563
		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;
564 565
				$coff_set = 1;
				#warn "CSB: mark coff<$coff>\n";
566 567 568 569 570 571 572 573 574 575 576
			}
		}
		if (($type eq '' || $type eq '{') && $c eq '{') {
			$level++;
			$type = '{';
		}
		if ($type eq '{' && $c eq '}') {
			$level--;
			$type = ($level != 0)? '{' : '';

			if ($level == 0) {
577 578 579
				if (substr($blk, $off + 1, 1) eq ';') {
					$off++;
				}
580 581 582 583 584
				last;
			}
		}
		$off++;
	}
585
	# We are truly at the end, so shuffle to the next line.
586
	if ($off == $len) {
587
		$loff = $len + 1;
588 589 590
		$line++;
		$remain--;
	}
591 592 593 594 595 596 597

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

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

598
	#print "coff<$coff> soff<$off> loff<$loff>\n";
599 600 601 602 603

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

604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
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;
	}
}

647 648 649 650 651 652
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

653
	# Grab the first conditional/block pair.
654 655
	($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
656
	#print "F: c<$condition> s<$statement> remain<$remain>\n";
657 658 659 660 661 662 663
	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.
664 665 666
	for (;;) {
		($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
667
		#print "C: c<$condition> s<$statement> remain<$remain>\n";
668
		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
669 670
		#print "C: push\n";
		push(@chunks, [ $condition, $statement ]);
671 672 673
	}

	return ($level, $linenr, @chunks);
674 675
}

676
sub ctx_block_get {
677
	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
678 679 680 681 682 683 684
	my $line;
	my $start = $linenr - 1;
	my $blk = '';
	my @o;
	my @c;
	my @res = ();

685
	my $level = 0;
686
	my @stack = ($level);
687 688 689 690 691
	for ($line = $start; $remain > 0; $line++) {
		next if ($rawlines[$line] =~ /^-/);
		$remain--;

		$blk .= $rawlines[$line];
692 693

		# Handle nested #if/#else.
694
		if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
695
			push(@stack, $level);
696
		} elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
697
			$level = $stack[$#stack - 1];
698
		} elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
699 700 701
			$level = pop(@stack);
		}

702
		foreach my $c (split(//, $lines[$line])) {
703 704 705 706 707
			##print "C<$c>L<$level><$open$close>O<$off>\n";
			if ($off > 0) {
				$off--;
				next;
			}
708

709 710 711 712 713 714 715
			if ($c eq $close && $level > 0) {
				$level--;
				last if ($level == 0);
			} elsif ($c eq $open) {
				$level++;
			}
		}
716

717
		if (!$outer || $level <= 1) {
718
			push(@res, $rawlines[$line]);
719 720
		}

721
		last if ($level == 0);
722 723
	}

724
	return ($level, @res);
725 726 727 728
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

729 730
	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
	return @r;
731 732 733 734
}
sub ctx_block {
	my ($linenr, $remain) = @_;

735 736
	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
	return @r;
737 738
}
sub ctx_statement {
739 740 741 742 743 744
	my ($linenr, $remain, $off) = @_;

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

747
	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
748
}
749 750 751 752 753
sub ctx_statement_level {
	my ($linenr, $remain, $off) = @_;

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
754 755 756 757 758

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

	# Catch a comment on the end of the line itself.
759
	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
760 761 762 763 764 765 766
	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++) {
767 768
		my $line = $rawlines[$linenr - 1];
		#warn "           $line\n";
769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790
		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);

791
	##print "LINE: $rawlines[$end_line - 1 ]\n";
792 793 794 795 796
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812
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;
}

813 814 815
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
816

817 818 819 820 821 822
	$res = '';
	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
		$res .= $1;
		if ($2 ne '') {
			$coded = sprintf("^%c", unpack('C', $2) + 64);
			$res .= $coded;
823 824
		}
	}
825
	$res =~ s/$/\$/;
826

827
	return $res;
828 829
}

830
my $av_preprocessor = 0;
831
my $av_pending;
832
my @av_paren_type;
833
my $av_pend_colon;
834 835 836

sub annotate_reset {
	$av_preprocessor = 0;
837 838
	$av_pending = '_';
	@av_paren_type = ('E');
839
	$av_pend_colon = 'O';
840 841
}

842 843
sub annotate_values {
	my ($stream, $type) = @_;
844

845
	my $res;
846
	my $var = '_' x length($stream);
847 848
	my $cur = $stream;

849
	print "$stream\n" if ($dbg_values > 1);
850 851

	while (length($cur)) {
852
		@av_paren_type = ('E') if ($#av_paren_type < 0);
853
		print " <" . join('', @av_paren_type) .
854
				"> <$type> <$av_pending>" if ($dbg_values > 1);
855
		if ($cur =~ /^(\s+)/o) {
856 857
			print "WS($1)\n" if ($dbg_values > 1);
			if ($1 =~ /\n/ && $av_preprocessor) {
858
				$type = pop(@av_paren_type);
859
				$av_preprocessor = 0;
860 861
			}

862
		} elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
863 864 865 866
			print "CAST($1)\n" if ($dbg_values > 1);
			push(@av_paren_type, $type);
			$type = 'C';

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

871 872 873 874
		} elsif ($cur =~ /^($Modifier)\s*/) {
			print "MODIFIER($1)\n" if ($dbg_values > 1);
			$type = 'T';

875
		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
876
			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
877
			$av_preprocessor = 1;
878 879 880 881 882 883
			push(@av_paren_type, $type);
			if ($2 ne '') {
				$av_pending = 'N';
			}
			$type = 'E';

884
		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
885 886 887
			print "UNDEF($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;
			push(@av_paren_type, $type);
888

889
		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
890
			print "PRE_START($1)\n" if ($dbg_values > 1);
891
			$av_preprocessor = 1;
892 893 894

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
895
			$type = 'E';
896

897
		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
898 899 900 901 902
			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;

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

903
			$type = 'E';
904

905
		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
906 907 908 909 910 911 912 913
			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);
914
			$type = 'E';
915 916

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

919 920 921 922 923
		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
			print "ATTR($1)\n" if ($dbg_values > 1);
			$av_pending = $type;
			$type = 'N';

924
		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
925
			print "SIZEOF($1)\n" if ($dbg_values > 1);
926
			if (defined $2) {
927
				$av_pending = 'V';
928 929 930
			}
			$type = 'N';

931
		} elsif ($cur =~ /^(if|while|for)\b/o) {
932
			print "COND($1)\n" if ($dbg_values > 1);
933
			$av_pending = 'E';
934 935
			$type = 'N';

936 937 938 939 940
		} elsif ($cur =~/^(case)/o) {
			print "CASE($1)\n" if ($dbg_values > 1);
			$av_pend_colon = 'C';
			$type = 'N';

941
		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
942
			print "KEYWORD($1)\n" if ($dbg_values > 1);
943 944 945
			$type = 'N';

		} elsif ($cur =~ /^(\()/o) {
946
			print "PAREN('$1')\n" if ($dbg_values > 1);
947 948
			push(@av_paren_type, $av_pending);
			$av_pending = '_';
949 950 951
			$type = 'N';

		} elsif ($cur =~ /^(\))/o) {
952 953 954
			my $new_type = pop(@av_paren_type);
			if ($new_type ne '_') {
				$type = $new_type;
955 956
				print "PAREN('$1') -> $type\n"
							if ($dbg_values > 1);
957
			} else {
958
				print "PAREN('$1')\n" if ($dbg_values > 1);
959 960
			}

961
		} elsif ($cur =~ /^($Ident)\s*\(/o) {
962
			print "FUNC($1)\n" if ($dbg_values > 1);
963
			$type = 'V';
964
			$av_pending = 'V';
965

966 967
		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
			if (defined $2 && $type eq 'C' || $type eq 'T') {
968
				$av_pend_colon = 'B';
969 970
			} elsif ($type eq 'E') {
				$av_pend_colon = 'L';
971 972 973 974
			}
			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
			$type = 'V';

975
		} elsif ($cur =~ /^($Ident|$Constant)/o) {
976
			print "IDENT($1)\n" if ($dbg_values > 1);
977 978 979
			$type = 'V';

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

983
		} elsif ($cur =~/^(;|{|})/) {
984
			print "END($1)\n" if ($dbg_values > 1);
985
			$type = 'E';
986 987
			$av_pend_colon = 'O';

988 989 990 991
		} elsif ($cur =~/^(,)/) {
			print "COMMA($1)\n" if ($dbg_values > 1);
			$type = 'C';

992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005
		} 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';
1006

1007
		} elsif ($cur =~ /^(\[)/o) {
1008
			print "CLOSE($1)\n" if ($dbg_values > 1);
1009 1010
			$type = 'N';

1011
		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
			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';

1024
		} elsif ($cur =~ /^($Operators)/o) {
1025
			print "OP($1)\n" if ($dbg_values > 1);
1026 1027 1028 1029 1030
			if ($1 ne '++' && $1 ne '--') {
				$type = 'N';
			}

		} elsif ($cur =~ /(^.)/o) {
1031
			print "C($1)\n" if ($dbg_values > 1);
1032 1033 1034 1035 1036
		}
		if (defined $1) {
			$cur = substr($cur, length($1));
			$res .= $type x length($1);
		}
1037
	}
1038

1039
	return ($res, $var);
1040 1041
}

1042
sub possible {
1043
	my ($possible, $line) = @_;
1044
	my $notPermitted = qr{(?:
1045 1046 1047 1048
		^(?:
			$Modifier|
			$Storage|
			$Type|
1049 1050 1051
			DEFINE_\S+
		)$|
		^(?:
1052 1053 1054 1055 1056 1057
			goto|
			return|
			case|
			else|
			asm|__asm__|
			do
1058
		)(?:\s|$)|
1059
		^(?:typedef|struct|enum)\b
1060 1061 1062
	    )}x;
	warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
	if ($possible !~ $notPermitted) {
1063 1064 1065 1066 1067 1068 1069
		# 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;
1070
			for my $modifier (split(' ', $possible)) {
1071 1072 1073 1074
				if ($modifier !~ $notPermitted) {
					warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
					push(@modifierList, $modifier);
				}
1075
			}
1076 1077 1078 1079 1080

		} else {
			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
			push(@typeList, $possible);
		}
1081
		build_types();
1082 1083
	} else {
		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1084 1085 1086
	}
}

1087 1088
my $prefix = '';

1089
sub report {
1090 1091 1092
	if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
		return 0;
	}
1093 1094 1095 1096
	my $line = $prefix . $_[0];

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

1097
	push(our @report, $line);
1098 1099

	return 1;
1100 1101
}
sub report_dump {
1102
	our @report;
1103
}
1104
sub ERROR {
1105 1106 1107 1108
	if (report("ERROR: $_[0]\n")) {
		our $clean = 0;
		our $cnt_error++;
	}
1109 1110
}
sub WARN {
1111 1112 1113 1114
	if (report("WARNING: $_[0]\n")) {
		our $clean = 0;
		our $cnt_warn++;
	}
1115 1116
}
sub CHK {
1117
	if ($check && report("CHECK: $_[0]\n")) {
1118 1119 1120
		our $clean = 0;
		our $cnt_chk++;
	}
1121 1122
}

1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
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);
	}
}

1150 1151 1152 1153 1154
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
1155
	my $prevrawline="";
1156
	my $stashline="";
1157
	my $stashrawline="";
1158

1159
	my $length;
1160 1161 1162 1163
	my $indent;
	my $previndent=0;
	my $stashindent=0;

1164
	our $clean = 1;
1165 1166 1167
	my $signoff = 0;
	my $is_patch = 0;

1168
	our @report = ();
1169 1170 1171 1172 1173
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

1174 1175 1176 1177 1178 1179
	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
	my $in_comment = 0;
1180
	my $comment_edge = 0;
1181
	my $first_line = 0;
1182
	my $p1_prefix = '';
1183

1184 1185 1186
	my $prev_values = 'E';

	# suppression flags
1187
	my %suppress_ifbraces;
1188
	my %suppress_whiletrailers;
1189
	my %suppress_export;
1190

1191
	# Pre-scan the patch sanitizing the lines.
1192
	# Pre-scan the patch looking for any __setup documentation.
1193
	#
1194 1195
	my @setup_docs = ();
	my $setup_docs = 0;
1196 1197

	sanitise_line_reset();
1198 1199
	my $line;
	foreach my $rawline (@rawlines) {
1200 1201
		$linenr++;
		$line = $rawline;
1202

1203
		if ($rawline=~/^\+\+\+\s+(\S+)/) {
1204 1205 1206 1207
			$setup_docs = 0;
			if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
				$setup_docs = 1;
			}
1208 1209 1210 1211 1212 1213 1214 1215 1216
			#next;
		}
		if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1217
			$in_comment = 0;
1218 1219 1220 1221 1222 1223

			# 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;
1224 1225 1226 1227 1228 1229
			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";
1230
				last if (!defined $rawlines[$ln - 1]);
1231 1232 1233 1234 1235
				if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
				    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
					($edge) = $1;
					last;
				}
1236 1237 1238 1239 1240 1241 1242 1243 1244
			}
			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 &&
1245
			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1246 1247 1248 1249 1250 1251 1252
			{
				$in_comment = 1;
			}

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

1253
		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1254
			# Standardise the strings and chars within the input to
1255
			# simplify matching -- only bother with positive lines.
1256
			$line = sanitise_line($rawline);
1257
		}
1258 1259 1260 1261 1262 1263 1264 1265 1266 1267
		push(@lines, $line);

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

		#print "==>$rawline\n";
		#print "-->$line\n";
1268 1269 1270 1271 1272 1273

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

1274 1275
	$prefix = '';

1276 1277
	$realcnt = 0;
	$linenr = 0;
1278 1279 1280
	foreach my $line (@lines) {
		$linenr++;

1281
		my $rawline = $rawlines[$linenr - 1];
1282

1283
#extract the line range in the file after the patch is applied
1284
		if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1285
			$is_patch = 1;
1286
			$first_line = $linenr + 1;
1287 1288 1289 1290 1291 1292
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1293
			annotate_reset();
1294 1295
			$prev_values = 'E';

1296
			%suppress_ifbraces = ();
1297
			%suppress_whiletrailers = ();
1298
			%suppress_export = ();
1299 1300
			next;

1301 1302 1303
# 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.
1304
		} elsif ($line =~ /^( |\+|$)/) {
1305
			$realline++;
1306
			$realcnt-- if ($realcnt != 0);
1307

1308
			# Measure the line length and indent.
1309
			($length, $indent) = line_stats($rawline);
1310 1311 1312 1313

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

1316
			#warn "line<$line>\n";
1317

1318 1319
		} elsif ($realcnt == 1) {
			$realcnt--;
1320 1321
		}

1322 1323
		my $hunk_line = ($realcnt != 0);

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

1328 1329
		$here = "#$linenr: " if (!$file);
		$here = "#$realline: " if ($file);
1330 1331

		# extract the filename as it passes
1332 1333 1334 1335 1336
		if ($line =~ /^diff --git.*?(\S+)$/) {
			$realfile = $1;
			$realfile =~ s@^([^/]*)/@@;

		} elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1337
			$realfile = $1;
1338 1339 1340
			$realfile =~ s@^([^/]*)/@@;

			$p1_prefix = $1;
1341 1342
			if (!$file && $tree && $p1_prefix ne '' &&
			    -e "$root/$p1_prefix") {
1343 1344
				WARN("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
			}
1345

1346
			if ($realfile =~ m@^include/asm/@) {
1347 1348 1349 1350 1351
				ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
			}
			next;
		}

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

1354 1355 1356
		my $hereline = "$here\n$rawline\n";
		my $herecurr = "$here\n$rawline\n";
		my $hereprev = "$here\n$prevrawline\n$rawline\n";
1357

1358 1359
		$cnt_lines++ if ($realcnt != 0);

1360 1361 1362 1363 1364 1365 1366 1367
# Check for incorrect file permissions
		if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
			my $permhere = $here . "FILE: $realfile\n";
			if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) {
				ERROR("do not set execute permissions for source files\n" . $permhere);
			}
		}

1368
#check the patch for a signoff:
1369
		if ($line =~ /^\s*signed-off-by:/i) {
1370 1371
			# This is a signoff, if ugly, so do not double report.
			$signoff++;
1372
			if (!($line =~ /^\s*Signed-off-by:/)) {
1373 1374
				WARN("Signed-off-by: is the preferred form\n" .
					$herecurr);
1375 1376
			}
			if ($line =~ /^\s*signed-off-by:\S/i) {
1377
				WARN("space required after Signed-off-by:\n" .
1378
					$herecurr);
1379 1380 1381
			}
		}

1382
# Check for wrappage within a valid hunk of the file
1383
		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1384
			ERROR("patch seems to be corrupt (line wrapped?)\n" .
1385
				$herecurr) if (!$emitted_corrupt++);
1386 1387
		}

1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401
# 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);
				}
			}
		}

1402 1403
# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1404 1405 1406 1407 1408 1409 1410 1411
		    $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);
1412 1413
		}

1414 1415
# ignore non-hunk lines and lines being removed
		next if (!$hunk_line || $line =~ /^-/);
1416 1417

#trailing whitespace
1418
		if ($line =~ /^\+.*\015/) {
1419
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1420 1421
			ERROR("DOS line endings\n" . $herevet);

1422 1423
		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1424
			ERROR("trailing whitespace\n" . $herevet);
1425
			$rpt_cleaners = 1;
1426
		}
1427

1428
# check for Kconfig help text having a real description
1429 1430
# Only applies when adding the entry originally, after that we do not have
# sufficient context to determine whether it is indeed long enough.
1431
		if ($realfile =~ /Kconfig/ &&
1432
		    $line =~ /\+\s*(?:---)?help(?:---)?$/) {
1433
			my $length = 0;
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445
			my $cnt = $realcnt;
			my $ln = $linenr + 1;
			my $f;
			my $is_end = 0;
			while ($cnt > 0 && defined $lines[$ln - 1]) {
				$f = $lines[$ln - 1];
				$cnt-- if ($lines[$ln - 1] !~ /^-/);
				$is_end = $lines[$ln - 1] =~ /^\+/;
				$ln++;

				next if ($f =~ /^-/);
				$f =~ s/^.//;
1446 1447 1448
				$f =~ s/#.*//;
				$f =~ s/^\s+//;
				next if ($f =~ /^$/);
1449 1450 1451 1452
				if ($f =~ /^\s*config\s/) {
					$is_end = 1;
					last;
				}
1453 1454
				$length++;
			}
1455 1456
			WARN("please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_end && $length < 4);
			#print "is_end<$is_end> length<$length>\n";
1457 1458
		}

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

1462
#80 column limit
1463
		if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1464
		    $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1465 1466
		    !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ ||
		    $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
1467
		    $length > 80)
1468
		{
1469
			WARN("line over 80 characters\n" . $herecurr);
1470 1471
		}

1472 1473 1474 1475 1476
# check for spaces before a quoted newline
		if ($rawline =~ /^.*\".*\s\\n/) {
			WARN("unnecessary whitespace before a quoted newline\n" . $herecurr);
		}

1477 1478 1479 1480 1481
# 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);
		}

1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493
# 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);
			}
		}

1494 1495
# check we are in a valid source file C or perl if not then ignore this hunk
		next if ($realfile !~ /\.(h|c|pl)$/);
1496 1497 1498

# at the beginning of a line any tabs must come first and anything
# more than 8 must use tabs.
1499 1500 1501
		if ($rawline =~ /^\+\s* \t\s*\S/ ||
		    $rawline =~ /^\+\s*        \s*/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1502
			ERROR("code indent should use tabs where possible\n" . $herevet);
1503
			$rpt_cleaners = 1;
1504 1505
		}

1506 1507 1508 1509 1510 1511
# check for space before tabs.
		if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
			WARN("please, no space before tabs\n" . $herevet);
		}

1512
# check for spaces at the beginning of a line.
1513 1514 1515 1516 1517
# Exceptions:
#  1) within comments
#  2) indented preprocessor commands
#  3) hanging labels
		if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/)  {
1518
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1519
			WARN("please, no spaces at the start of a line\n" . $herevet);
1520 1521
		}

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

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

1530 1531 1532 1533 1534 1535 1536 1537 1538 1539
# 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);
		}

1540
# Check for potential 'bare' types
1541 1542
		my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
		    $realline_next);
1543
		if ($realcnt && $line =~ /.\s*\S/) {
1544
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1545
				ctx_statement_block($linenr, $realcnt, 0);
1546 1547 1548
			$stat =~ s/\n./\n /g;
			$cond =~ s/\n./\n /g;

1549 1550 1551 1552 1553 1554 1555 1556
			# Find the real next line.
			$realline_next = $line_nr_next;
			if (defined $realline_next &&
			    (!defined $lines[$realline_next - 1] ||
			     substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
				$realline_next++;
			}

1557 1558
			my $s = $stat;
			$s =~ s/{.*$//s;
1559

1560
			# Ignore goto labels.
1561
			if ($s =~ /$Ident:\*$/s) {
1562 1563

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

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

1568
			# declarations always start with types
1569
			} 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) {
1570 1571 1572 1573
				my $type = $1;
				$type =~ s/\s+/ /g;
				possible($type, "A:" . $s);

1574
			# definitions in global scope can only start with types
1575
			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
1576
				possible($1, "B:" . $s);
1577
			}
1578 1579

			# any (foo ... *) is a pointer cast, and foo is a type
1580
			while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
1581
				possible($1, "C:" . $s);
1582 1583 1584 1585 1586
			}

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

1590
				my $ctx = $s;
1591
				substr($ctx, 0, $name_len + 1, '');
1592
				$ctx =~ s/\)[^\)]*$//;
1593

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

1597
						possible($1, "D:" . $s);
1598 1599
					}
				}
1600
			}
1601

1602 1603
		}

1604 1605 1606
#
# Checks which may be anchored in the context.
#
1607

1608 1609
# Check for switch () and associated case and default
# statements should be at the same indent.
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625
		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 '') {
1626
				ERROR("switch and case should be at the same indent\n$hereline$err");
1627 1628 1629 1630 1631
			}
		}

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

1635
			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
1636 1637 1638
			my $ctx_cnt = $realcnt - $#ctx - 1;
			my $ctx = join("\n", @ctx);

1639 1640
			my $ctx_ln = $linenr;
			my $ctx_skip = $realcnt;
1641

1642 1643 1644 1645 1646
			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] !~ /^-/);
1647 1648
				$ctx_ln++;
			}
1649

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

1653 1654
			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
				ERROR("that open brace { should be on the previous line\n" .
1655
					"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
1656
			}
1657 1658 1659 1660
			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
			    $ctx =~ /\)\s*\;\s*$/ &&
			    defined $lines[$ctx_ln - 1])
			{
1661 1662
				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
				if ($nindent > $indent) {
1663
					WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
1664
						"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
1665 1666
				}
			}
1667 1668
		}

1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680
# 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.
1681 1682
			my @newlines = ($c =~ /\n/gs);
			my $cond_lines = 1 + $#newlines;
1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695

			# 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;
			}
1696
			if ($s =~ s/^\s*?\n//) {
1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707
				$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;
			}

1708
			my $cond_ptr = -1;
1709
			$continuation = 0;
1710 1711 1712
			while ($cond_ptr != $cond_lines) {
				$cond_ptr = $cond_lines;

1713 1714 1715 1716 1717 1718
				# If we see an #else/#elif then the code
				# is not linear.
				if ($s =~ /^\s*\#\s*(?:else|elif)/) {
					$check = 0;
				}

1719 1720 1721 1722
				# Ignore:
				#  1) blank lines, they should be at 0,
				#  2) preprocessor lines, and
				#  3) labels.
1723 1724
				if ($continuation ||
				    $s =~ /^\s*?\n/ ||
1725 1726
				    $s =~ /^\s*#\s*?/ ||
				    $s =~ /^\s*$Ident\s*:/) {
1727
					$continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
1728 1729 1730
					if ($s =~ s/^.*?\n//) {
						$cond_lines++;
					}
1731
				}
1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746
			}

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

1747
			#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";
1748 1749 1750 1751 1752 1753 1754

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

1755 1756
		# Track the 'values' across context and added lines.
		my $opline = $line; $opline =~ s/^./ /;
1757 1758
		my ($curr_values, $curr_vars) =
				annotate_values($opline . "\n", $prev_values);
1759
		$curr_values = $prev_values . $curr_values;
1760 1761
		if ($dbg_values) {
			my $outline = $opline; $outline =~ s/\t/ /g;
1762 1763
			print "$linenr > .$outline\n";
			print "$linenr > $curr_values\n";
1764
			print "$linenr >  $curr_vars\n";
1765
		}
1766 1767
		$prev_values = substr($curr_values, -1);

1768 1769 1770
#ignore lines not being added
		if ($line=~/^[^\+]/) {next;}

1771
# TEST: allow direct testing of the type matcher.
1772 1773 1774 1775 1776 1777
		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);
			}
1778 1779
			next;
		}
1780 1781
# TEST: allow direct testing of the attribute matcher.
		if ($dbg_attr) {
1782
			if ($line =~ /^.\s*$Modifier\s*$/) {
1783
				ERROR("TEST: is attr\n" . $herecurr);
1784
			} elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
1785 1786 1787 1788
				ERROR("TEST: is not attr ($1 is)\n". $herecurr);
			}
			next;
		}
1789

1790
# check for initialisation to aggregates open brace on the next line
1791 1792
		if ($line =~ /^.\s*{/ &&
		    $prevline =~ /(?:^|[^=])=\s*$/) {
1793
			ERROR("that open brace { should be on the previous line\n" . $hereprev);
1794 1795
		}

1796 1797 1798 1799 1800
#
# Checks which are anchored on the added line.
#

# check for malformed paths in #include statements (uses RAW line)
1801
		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
1802 1803
			my $path = $1;
			if ($path =~ m{//}) {
1804 1805
				ERROR("malformed #include filename\n" .
					$herecurr);
1806 1807
			}
		}
1808

1809
# no C99 // comments
1810
		if ($line =~ m{//}) {
1811
			ERROR("do not use C99 // comments\n" . $herecurr);
1812
		}
1813
		# Remove C99 comments.
1814
		$line =~ s@//.*@@;
1815
		$opline =~ s@//.*@@;
1816

1817 1818 1819 1820 1821 1822 1823 1824
# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
# the whole statement.
#print "APW <$lines[$realline_next - 1]>\n";
		if (defined $realline_next &&
		    exists $lines[$realline_next - 1] &&
		    !defined $suppress_export{$realline_next} &&
		    ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
		     $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1825 1826 1827 1828
			# Handle definitions which produce identifiers with
			# a prefix:
			#   XXX(foo);
			#   EXPORT_SYMBOL(something_foo);
1829
			my $name = $1;
1830 1831 1832 1833 1834 1835
			if ($stat =~ /^.([A-Z_]+)\s*\(\s*($Ident)/ &&
			    $name =~ /^${Ident}_$2/) {
#print "FOO C name<$name>\n";
				$suppress_export{$realline_next} = 1;

			} elsif ($stat !~ /(?:
1836
				\n.}\s*$|
1837 1838 1839
				^.DEFINE_$Ident\(\Q$name\E\)|
				^.DECLARE_$Ident\(\Q$name\E\)|
				^.LIST_HEAD\(\Q$name\E\)|
1840 1841
				^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
				\b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
1842
			    )/x) {
1843 1844 1845 1846
#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
				$suppress_export{$realline_next} = 2;
			} else {
				$suppress_export{$realline_next} = 1;
1847 1848
			}
		}
1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859
		if (!defined $suppress_export{$linenr} &&
		    $prevline =~ /^.\s*$/ &&
		    ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
		     $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
#print "FOO B <$lines[$linenr - 1]>\n";
			$suppress_export{$linenr} = 2;
		}
		if (defined $suppress_export{$linenr} &&
		    $suppress_export{$linenr} == 2) {
			WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
		}
1860

1861
# check for global initialisers.
1862
		if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
1863
			ERROR("do not initialise globals to 0 or NULL\n" .
1864 1865
				$herecurr);
		}
1866
# check for static initialisers.
1867
		if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
1868 1869
			ERROR("do not initialise statics to 0 or NULL\n" .
				$herecurr);
1870 1871
		}

1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883
# check for static const char * arrays.
		if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
			WARN("static const char * array should probably be static const char * const\n" .
				$herecurr);
               }

# check for static char foo[] = "bar" declarations.
		if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
			WARN("static char array declaration should probably be static const char\n" .
				$herecurr);
               }

1884 1885 1886 1887 1888
# check for declarations of struct pci_device_id
		if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
			WARN("Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
		}

1889 1890 1891
# check for new typedefs, only function parameters and sparse annotations
# make sense.
		if ($line =~ /\btypedef\s/ &&
1892
		    $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
1893
		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
1894
		    $line !~ /\b$typeTypedefs\b/ &&
1895
		    $line !~ /\b__bitwise(?:__|)\b/) {
1896
			WARN("do not add new typedefs\n" . $herecurr);
1897 1898 1899
		}

# * goes on variable not on type
1900
		# (char*[ const])
1901
		if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
1902 1903 1904 1905 1906 1907 1908
			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.
1909
			while ($to =~ s/\*\s+\*/\*\*/) {
1910
			}
1911

1912 1913 1914 1915
			#print "from<$from> to<$to>\n";
			if ($from ne $to) {
				ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" .  $herecurr);
			}
1916
		} elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
1917 1918 1919 1920 1921 1922 1923
			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.
1924
			while ($to =~ s/\*\s+\*/\*\*/) {
1925 1926 1927
			}
			# Modifiers should have spaces.
			$to =~ s/(\b$Modifier$)/$1 /;
1928

1929 1930
			#print "from<$from> to<$to> ident<$ident>\n";
			if ($from ne $to && $ident !~ /^$Modifier$/) {
1931 1932
				ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" .  $herecurr);
			}
1933 1934 1935 1936 1937 1938 1939 1940 1941
		}

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

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

1946 1947 1948 1949 1950
# 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.
1951
		if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964
			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) {
1965
				WARN("printk() should include KERN_ facility level\n" . $herecurr);
1966
			}
1967 1968
		}

1969 1970
# function brace can't be on same line, except for #defines of do while,
# or if closed on same line
1971 1972
		if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
		    !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
1973
			ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
1974
		}
1975

1976 1977 1978 1979 1980 1981
# 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);
		}

1982 1983 1984 1985 1986
# missing space after union, struct or enum definition
		if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
		    WARN("missing space after $1 definition\n" . $herecurr);
		}

1987 1988
# check for spacing round square brackets; allowed:
#  1. with a type on the left -- int [] a;
1989 1990
#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
#  3. inside a curly brace -- = { [0...10] = 5 }
1991 1992 1993
		while ($line =~ /(.*?\s)\[/g) {
			my ($where, $prefix) = ($-[1], $1);
			if ($prefix !~ /$Type\s+$/ &&
1994 1995
			    ($where != 0 || $prefix !~ /^.\s+$/) &&
			    $prefix !~ /{\s+$/) {
1996 1997 1998 1999
				ERROR("space prohibited before open square bracket '['\n" . $herecurr);
			}
		}

2000
# check for spaces between functions and their parentheses.
2001
		while ($line =~ /($Ident)\s+\(/g) {
2002
			my $name = $1;
2003 2004
			my $ctx_before = substr($line, 0, $-[1]);
			my $ctx = "$ctx_before$name";
2005 2006

			# Ignore those directives where spaces _are_ permitted.
2007 2008 2009 2010 2011 2012
			if ($name =~ /^(?:
				if|for|while|switch|return|case|
				volatile|__volatile__|
				__attribute__|format|__extension__|
				asm|__asm__)$/x)
			{
2013 2014 2015 2016

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

			# cpp #elif statement condition may start with a (
2020
			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
2021 2022 2023

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

			} else {
2027
				WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
2028
			}
2029
		}
2030
# Check operator spacing.
2031
		if (!($line=~/\#\s*include/)) {
2032 2033 2034 2035
			my $ops = qr{
				<<=|>>=|<=|>=|==|!=|
				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
				=>|->|<<|>>|<|>|=|!|~|
2036 2037
				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
				\?|:
2038
			}x;
2039
			my @elements = split(/($ops|;)/, $opline);
2040
			my $off = 0;
2041 2042 2043

			my $blank = copy_spacing($opline);

2044
			for (my $n = 0; $n < $#elements; $n += 2) {
2045 2046
				$off += length($elements[$n]);

2047 2048 2049 2050 2051 2052 2053 2054
				# 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";

2055 2056 2057
				my $a = '';
				$a = 'V' if ($elements[$n] ne '');
				$a = 'W' if ($elements[$n] =~ /\s$/);
2058
				$a = 'C' if ($elements[$n] =~ /$;$/);
2059 2060
				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
				$a = 'O' if ($elements[$n] eq '');
2061
				$a = 'E' if ($ca =~ /^\s*$/);
2062

2063
				my $op = $elements[$n + 1];
2064 2065

				my $c = '';
2066
				if (defined $elements[$n + 2]) {
2067 2068
					$c = 'V' if ($elements[$n + 2] ne '');
					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
2069
					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
2070 2071
					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
					$c = 'O' if ($elements[$n + 2] eq '');
2072
					$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
2073 2074
				} else {
					$c = 'E';
2075 2076
				}

2077 2078 2079 2080
				my $ctx = "${a}x${c}";

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

2081
				my $ptr = substr($blank, 0, $off) . "^";
2082
				my $hereptr = "$hereline$ptr\n";
2083

2084
				# Pull out the value of this operator.
2085
				my $op_type = substr($curr_values, $off + 1, 1);
2086

2087 2088 2089
				# Get the full operator variant.
				my $opv = $op . substr($curr_vars, $off, 1);

2090 2091 2092 2093
				# Ignore operators passed as parameters.
				if ($op_type ne 'V' &&
				    $ca =~ /\s$/ && $cc =~ /^\s*,/) {

2094 2095
#				# Ignore comments
#				} elsif ($op =~ /^$;+$/) {
2096

2097
				# ; should have either the end of line or a space or \ after it
2098
				} elsif ($op eq ';') {
2099 2100
					if ($ctx !~ /.x[WEBC]/ &&
					    $cc !~ /^\\/ && $cc !~ /^;/) {
2101
						ERROR("space required after that '$op' $at\n" . $hereptr);
2102 2103 2104 2105
					}

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

2107 2108 2109 2110
				# No spaces for:
				#   ->
				#   :   when part of a bitfield
				} elsif ($op eq '->' || $opv eq ':B') {
2111
					if ($ctx =~ /Wx.|.xW/) {
2112
						ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
2113 2114 2115 2116
					}

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

2121
				# '*' as part of a type definition -- reported already.
2122
				} elsif ($opv eq '*_') {
2123 2124 2125 2126 2127 2128
					#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 '~' ||
2129
					 $opv eq '*U' || $opv eq '-U' ||
2130
					 $opv eq '&U' || $opv eq '&&U') {
2131
					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
2132
						ERROR("space required before that '$op' $at\n" . $hereptr);
2133
					}
2134
					if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
2135 2136 2137
						# A unary '*' may be const

					} elsif ($ctx =~ /.xW/) {
2138
						ERROR("space prohibited after that '$op' $at\n" . $hereptr);
2139 2140 2141 2142
					}

				# unary ++ and unary -- are allowed no space on one side.
				} elsif ($op eq '++' or $op eq '--') {
2143 2144 2145 2146 2147 2148
					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);
2149
					}
2150 2151
					if ($ctx =~ /ExW/) {
						ERROR("space prohibited after that '$op' $at\n" . $hereptr);
2152
					}
2153

2154

2155
				# << and >> may either have or not have spaces both sides
2156 2157 2158
				} elsif ($op eq '<<' or $op eq '>>' or
					 $op eq '&' or $op eq '^' or $op eq '|' or
					 $op eq '+' or $op eq '-' or
2159 2160
					 $op eq '*' or $op eq '/' or
					 $op eq '%')
2161
				{
2162
					if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
2163 2164
						ERROR("need consistent spacing around '$op' $at\n" .
							$hereptr);
2165 2166
					}

2167 2168 2169 2170 2171 2172 2173
				# 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);
					}

2174
				# All the others need spaces both sides.
2175
				} elsif ($ctx !~ /[EWC]x[CWE]/) {
2176 2177
					my $ok = 0;

2178
					# Ignore email addresses <foo@bar>
2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193
					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) {
2194
						ERROR("spaces required around that '$op' $at\n" . $hereptr);
2195
					}
2196
				}
2197
				$off += length($elements[$n + 1]);
2198 2199 2200
			}
		}

2201 2202
# check for multiple assignments
		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
2203
			CHK("multiple assignments should be avoided\n" . $herecurr);
2204 2205
		}

2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219
## # 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);
## 			}
## 		}
2220

2221
#need space before brace following if, while, etc
2222 2223
		if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
		    $line =~ /do{/) {
2224
			ERROR("space required before the open brace '{'\n" . $herecurr);
2225 2226 2227 2228 2229
		}

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

2233 2234
# check spacing on square brackets
		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
2235
			ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
2236 2237
		}
		if ($line =~ /\s\]/) {
2238
			ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
2239 2240
		}

2241
# check spacing on parentheses
2242 2243
		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
		    $line !~ /for\s*\(\s+;/) {
2244
			ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
2245
		}
2246
		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
2247 2248
		    $line !~ /for\s*\(.*;\s+\)/ &&
		    $line !~ /:\s+\)/) {
2249
			ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
2250 2251
		}

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

2258 2259 2260 2261 2262
# Return is not a function.
		if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
			my $spacing = $1;
			my $value = $2;

2263
			# Flatten any parentheses
2264 2265
			$value =~ s/\(/ \(/g;
			$value =~ s/\)/\) /g;
2266 2267 2268 2269 2270
			while ($value =~ s/\[[^\{\}]*\]/1/ ||
			       $value !~ /(?:$Ident|-?$Constant)\s*
					     $Compare\s*
					     (?:$Ident|-?$Constant)/x &&
			       $value =~ s/\([^\(\)]*\)/1/) {
2271
			}
2272 2273
#print "value<$value>\n";
			if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
2274 2275 2276 2277 2278 2279
				ERROR("return is not a function, parentheses are not required\n" . $herecurr);

			} elsif ($spacing !~ /\s+/) {
				ERROR("space required before the open parenthesis '('\n" . $herecurr);
			}
		}
2280 2281 2282 2283 2284 2285 2286
# Return of what appears to be an errno should normally be -'ve
		if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
			my $name = $1;
			if ($name ne 'EOF' && $name ne 'ERROR') {
				WARN("return of an errno should typically be -ve (return -$1)\n" . $herecurr);
			}
		}
2287

2288
# Need a space before open parenthesis after if, while etc
2289
		if ($line=~/\b(if|while|for|switch)\(/) {
2290
			ERROR("space required before the open parenthesis '('\n" . $herecurr);
2291 2292
		}

2293 2294
# Check for illegal assignment in if conditional -- and check for trailing
# statements after the conditional.
2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314
		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*#/) {
2315
			my ($s, $c) = ($stat, $cond);
2316

2317
			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2318
				ERROR("do not use assignment in if condition\n" . $herecurr);
2319 2320 2321 2322
			}

			# Find out what is on the end of the line after the
			# conditional.
2323
			substr($s, 0, length($c), '');
2324
			$s =~ s/\n.*//g;
2325
			$s =~ s/$;//g; 	# Remove any comments
2326 2327
			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
			    $c !~ /}\s*while\s*/)
2328
			{
2329 2330 2331
				# Find out how long the conditional actually is.
				my @newlines = ($c =~ /\n/gs);
				my $cond_lines = 1 + $#newlines;
2332
				my $stat_real = '';
2333

2334 2335
				$stat_real = raw_line($linenr, $cond_lines)
							. "\n" if ($cond_lines);
2336 2337 2338 2339 2340
				if (defined($stat_real) && $cond_lines > 1) {
					$stat_real = "[...]\n$stat_real";
				}

				ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real);
2341 2342 2343
			}
		}

2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358
# 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);
		}

2359
# if and else should not have general statements after it
2360 2361 2362 2363 2364 2365
		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);
			}
2366
		}
2367 2368 2369 2370 2371
# if should not continue a brace
		if ($line =~ /}\s*if\b/) {
			ERROR("trailing statements should be on next line\n" .
				$herecurr);
		}
2372 2373 2374
# case and default should not have general statements after them
		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
		    $line !~ /\G(?:
2375
			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
2376 2377 2378 2379 2380
			\s*return\s+
		    )/xg)
		{
			ERROR("trailing statements should be on next line\n" . $herecurr);
		}
2381 2382 2383 2384 2385

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

2389 2390 2391 2392 2393 2394
		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.
2395
			substr($s, 0, length($c), '');
2396 2397 2398 2399 2400 2401 2402
			$s =~ s/\n.*//g;

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

2403 2404 2405 2406 2407 2408 2409 2410
#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
2411
		if ($line=~/\#\s*define.*\\\s$/) {
2412
			WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
2413 2414
		}

2415
#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2416
		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2417 2418 2419 2420
			my $file = "$1.h";
			my $checkfile = "include/linux/$file";
			if (-f "$root/$checkfile" &&
			    $realfile ne $checkfile &&
2421
			    $1 !~ /$allowed_asm_includes/)
2422
			{
2423 2424 2425 2426 2427
				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);
				}
2428 2429 2430
			}
		}

2431 2432
# 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
2433
# in a known good container
2434 2435
		if ($realfile !~ m@/vmlinux.lds.h$@ &&
		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2436 2437
			my $ln = $linenr;
			my $cnt = $realcnt;
2438 2439
			my ($off, $dstat, $dcond, $rest);
			my $ctx = '';
2440

2441 2442 2443 2444 2445 2446 2447 2448
			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";
2449
				$cnt-- if ($lines[$ln - 1] !~ /^-/);
2450 2451 2452 2453 2454 2455 2456
				$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";
2457
			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2458 2459 2460 2461

			# Extract the remainder of the define (if any) and
			# rip off surrounding spaces, and trailing \'s.
			$rest = '';
2462 2463
			while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
				#print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
2464 2465 2466 2467
				if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
					$rest .= substr($lines[$ln - 1], $off) . "\n";
					$cnt--;
				}
2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479
				$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*//;
2480
			}
2481
			$dstat =~ s/$;//g;
2482 2483 2484
			$dstat =~ s/\\\n.//g;
			$dstat =~ s/^\s*//s;
			$dstat =~ s/\s*$//s;
2485

2486
			# Flatten any parentheses and braces
2487 2488 2489 2490
			while ($dstat =~ s/\([^\(\)]*\)/1/ ||
			       $dstat =~ s/\{[^\{\}]*\}/1/ ||
			       $dstat =~ s/\[[^\{\}]*\]/1/)
			{
2491
			}
2492

2493 2494 2495 2496 2497 2498
			my $exceptions = qr{
				$Declare|
				module_param_named|
				MODULE_PARAM_DESC|
				DECLARE_PER_CPU|
				DEFINE_PER_CPU|
2499
				__typeof__\(|
2500 2501
				union|
				struct|
2502 2503
				\.$Ident\s*=\s*|
				^\"|\"$
2504
			}x;
2505 2506
			#print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
			if ($rest ne '' && $rest ne ',') {
2507 2508 2509
				if ($rest !~ /while\s*\(/ &&
				    $dstat !~ /$exceptions/)
				{
2510
					ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
2511 2512 2513 2514 2515 2516
				}

			} elsif ($ctx !~ /;/) {
				if ($dstat ne '' &&
				    $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
				    $dstat !~ /$exceptions/ &&
2517
				    $dstat !~ /^\.$Ident\s*=/ &&
2518 2519
				    $dstat =~ /$Operators/)
				{
2520
					ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
2521
				}
2522
			}
2523 2524
		}

2525 2526 2527 2528 2529 2530 2531 2532 2533
# 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);
		}

2534
# check for redundant bracing round if etc
2535 2536
		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
			my ($level, $endln, @chunks) =
2537
				ctx_statement_full($linenr, $realcnt, 1);
2538
			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2539 2540
			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
			if ($#chunks > 0 && $level == 0) {
2541 2542
				my $allowed = 0;
				my $seen = 0;
2543
				my $herectx = $here . "\n";
2544
				my $ln = $linenr - 1;
2545 2546 2547
				for my $chunk (@chunks) {
					my ($cond, $block) = @{$chunk};

2548 2549 2550 2551 2552 2553 2554 2555 2556 2557
					# 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";
2558 2559
					$ln += statement_rawlines($block) - 1;

2560
					substr($block, 0, length($cond), '');
2561 2562 2563

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

2564 2565 2566
					#print "cond<$cond> block<$block> allowed<$allowed>\n";
					if (statement_lines($cond) > 1) {
						#print "APW: ALLOWED: cond<$cond>\n";
2567 2568 2569
						$allowed = 1;
					}
					if ($block =~/\b(?:if|for|while)\b/) {
2570
						#print "APW: ALLOWED: block<$block>\n";
2571 2572
						$allowed = 1;
					}
2573 2574
					if (statement_block_size($block) > 1) {
						#print "APW: ALLOWED: lines block<$block>\n";
2575 2576 2577 2578
						$allowed = 1;
					}
				}
				if ($seen && !$allowed) {
2579
					WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
2580 2581 2582
				}
			}
		}
2583
		if (!defined $suppress_ifbraces{$linenr - 1} &&
2584
					$line =~ /\b(if|while|for|else)\b/) {
2585 2586 2587 2588 2589 2590 2591
			my $allowed = 0;

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

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

2596 2597
			# Check the condition.
			my ($cond, $block) = @{$chunks[0]};
2598
			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
2599
			if (defined $cond) {
2600
				substr($block, 0, length($cond), '');
2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617
			}
			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) {
2618
					substr($block, 0, length($cond), '');
2619 2620 2621 2622 2623 2624 2625 2626
				}
				if ($block =~ /^\s*\{/) {
					#print "APW: ALLOWED: chunk-1 block<$block>\n";
					$allowed = 1;
				}
			}
			if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
				my $herectx = $here . "\n";;
2627
				my $cnt = statement_rawlines($block);
2628

2629 2630
				for (my $n = 0; $n < $cnt; $n++) {
					$herectx .= raw_line($linenr, $n) . "\n";;
2631
				}
2632 2633

				WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
2634 2635 2636
			}
		}

2637
# don't include deprecated include files (uses RAW line)
2638
		for my $inc (@dep_includes) {
2639
			if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
2640
				ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2641 2642 2643
			}
		}

2644 2645
# don't use deprecated functions
		for my $func (@dep_functions) {
2646
			if ($line =~ /\b$func\b/) {
2647
				ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2648 2649 2650 2651
			}
		}

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

2657
# warn about #if 0
2658
		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
2659 2660
			CHK("if this code is redundant consider removing it\n" .
				$herecurr);
2661 2662
		}

2663 2664 2665 2666
# check for needless kfree() checks
		if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
			my $expr = $1;
			if ($line =~ /\bkfree\(\Q$expr\E\);/) {
2667
				WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
2668 2669
			}
		}
2670 2671 2672 2673 2674 2675 2676
# 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);
			}
		}
2677

2678 2679 2680 2681 2682 2683 2684 2685
# prefer usleep_range over udelay
		if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) {
			# ignore udelay's < 10, however
			if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) {
				CHK("usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
			}
		}

2686 2687 2688 2689 2690 2691 2692
# warn about unexpectedly long msleep's
		if ($line =~ /\bmsleep\s*\((\d+)\);/) {
			if ($1 < 20) {
				WARN("msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
			}
		}

2693
# warn about #ifdefs in C files
2694
#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
2695 2696 2697 2698 2699
#			print "#ifdef in C files should be avoided\n";
#			print "$herecurr";
#			$clean = 0;
#		}

2700
# warn about spacing in #ifdefs
2701
		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
2702 2703 2704
			ERROR("exactly one space required after that #$1\n" . $herecurr);
		}

2705
# check for spinlock_t definitions without a comment.
2706 2707
		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
2708 2709
			my $which = $1;
			if (!ctx_has_comment($first_line, $linenr)) {
2710
				CHK("$1 definition without comment\n" . $herecurr);
2711 2712 2713 2714 2715
			}
		}
# 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)) {
2716
				CHK("memory barrier without comment\n" . $herecurr);
2717 2718 2719
			}
		}
# check of hardware specific defines
2720
		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
2721
			CHK("architecture specific defines should be avoided\n" .  $herecurr);
2722
		}
2723

2724 2725 2726 2727 2728
# Check that the storage class is at the beginning of a declaration
		if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
			WARN("storage class should be at the beginning of the declaration\n" . $herecurr)
		}

2729 2730
# check the location of the inline attribute, that it is between
# storage class and type.
2731 2732
		if ($line =~ /\b$Type\s+$Inline\b/ ||
		    $line =~ /\b$Inline\s+$Storage\b/) {
2733 2734 2735
			ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
		}

2736 2737 2738 2739 2740
# Check for __inline__ and __inline, prefer inline
		if ($line =~ /\b(__inline__|__inline)\b/) {
			WARN("plain inline is preferred over $1\n" . $herecurr);
		}

2741 2742 2743 2744 2745
# Check for __attribute__ packed, prefer __packed
		if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
			WARN("__packed is preferred over __attribute__((packed))\n" . $herecurr);
		}

2746 2747 2748 2749 2750
# check for sizeof(&)
		if ($line =~ /\bsizeof\s*\(\s*\&/) {
			WARN("sizeof(& should be avoided\n" . $herecurr);
		}

2751
# check for new externs in .c files.
2752
		if ($realfile =~ /\.c$/ && defined $stat &&
2753
		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
2754
		{
2755 2756
			my $function_name = $1;
			my $paren_space = $2;
2757 2758 2759 2760 2761

			my $s = $stat;
			if (defined $cond) {
				substr($s, 0, length($cond), '');
			}
2762 2763 2764
			if ($s =~ /^\s*;/ &&
			    $function_name ne 'uninitialized_var')
			{
2765 2766 2767 2768 2769 2770
				WARN("externs should be avoided in .c files\n" .  $herecurr);
			}

			if ($paren_space =~ /\n/) {
				WARN("arguments for function declarations should follow identifier\n" . $herecurr);
			}
2771 2772 2773 2774 2775

		} elsif ($realfile =~ /\.c$/ && defined $stat &&
		    $stat =~ /^.\s*extern\s+/)
		{
			WARN("externs should be avoided in .c files\n" .  $herecurr);
2776 2777 2778 2779 2780 2781 2782 2783 2784
		}

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

# check for pointless casting of kmalloc return
2788
		if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
2789 2790
			WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
		}
2791

2792 2793 2794 2795 2796
# check for multiple semicolons
		if ($line =~ /;\s*;\s*$/) {
		    WARN("Statements terminations use 1 semicolon\n" . $herecurr);
		}

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

2802 2803
# check for semaphores initialized locked
		if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
2804
			WARN("consider using a completion\n" . $herecurr);
2805

2806
		}
2807
# recommend kstrto* over simple_strto*
2808
		if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2809
			WARN("consider using kstrto* in preference to simple_$1\n" . $herecurr);
2810
		}
2811 2812 2813 2814
# check for __initcall(), use device_initcall() explicitly please
		if ($line =~ /^.\s*__initcall\s*\(/) {
			WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
		}
2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852
# check for various ops structs, ensure they are const.
		my $struct_ops = qr{acpi_dock_ops|
				address_space_operations|
				backlight_ops|
				block_device_operations|
				dentry_operations|
				dev_pm_ops|
				dma_map_ops|
				extent_io_ops|
				file_lock_operations|
				file_operations|
				hv_ops|
				ide_dma_ops|
				intel_dvo_dev_ops|
				item_operations|
				iwl_ops|
				kgdb_arch|
				kgdb_io|
				kset_uevent_ops|
				lock_manager_operations|
				microcode_ops|
				mtrr_ops|
				neigh_ops|
				nlmsvc_binding|
				pci_raw_ops|
				pipe_buf_operations|
				platform_hibernation_ops|
				platform_suspend_ops|
				proto_ops|
				rpc_pipe_ops|
				seq_operations|
				snd_ac97_build_ops|
				soc_pcmcia_socket_ops|
				stacktrace_ops|
				sysfs_ops|
				tty_operations|
				usb_mon_operations|
				wd_ops}x;
2853
		if ($line !~ /\bconst\b/ &&
2854
		    $line =~ /\bstruct\s+($struct_ops)\b/) {
2855 2856
			WARN("struct $1 should normally be const\n" .
				$herecurr);
2857
		}
2858 2859 2860 2861

# 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/ &&
2862 2863
		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
2864 2865 2866
		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
2867 2868 2869
		{
			WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
		}
2870 2871 2872 2873 2874

# check for %L{u,d,i} in strings
		my $string;
		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
			$string = substr($rawline, $-[1], $+[1] - $-[1]);
2875
			$string =~ s/%%/__/g;
2876 2877 2878 2879 2880
			if ($string =~ /(?<!%)%L[udi]/) {
				WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
				last;
			}
		}
2881 2882 2883 2884 2885

# whine mightly about in_atomic
		if ($line =~ /\bin_atomic\s*\(/) {
			if ($realfile =~ m@^drivers/@) {
				ERROR("do not use in_atomic in drivers\n" . $herecurr);
2886
			} elsif ($realfile !~ m@^kernel/@) {
2887 2888 2889
				WARN("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
			}
		}
2890 2891 2892 2893 2894 2895 2896 2897 2898 2899

# check for lockdep_set_novalidate_class
		if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
		    $line =~ /__lockdep_no_validate__\s*\)/ ) {
			if ($realfile !~ m@^kernel/lockdep@ &&
			    $realfile !~ m@^include/linux/lockdep@ &&
			    $realfile !~ m@^drivers/base/core@) {
				ERROR("lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
			}
		}
2900 2901 2902 2903 2904

		if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
		    $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
			WARN("Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
		}
2905 2906 2907 2908 2909

		# Check for memset with swapped arguments
		if ($line =~ /memset.*\,(\ |)(0x|)0(\ |0|)\);/) {
			ERROR("memset size is 3rd argument, not the second.\n" . $herecurr);
		}
2910 2911 2912 2913 2914 2915
	}

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

2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930
	# 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) {
2931
		ERROR("Does not appear to be a unified-diff format patch\n");
2932 2933
	}
	if ($is_patch && $chk_signoff && $signoff == 0) {
2934
		ERROR("Missing Signed-off-by: line(s)\n");
2935 2936
	}

2937
	print report_dump();
2938 2939
	if ($summary && !($clean == 1 && $quiet == 1)) {
		print "$filename " if ($summary_file);
2940 2941 2942 2943
		print "total: $cnt_error errors, $cnt_warn warnings, " .
			(($check)? "$cnt_chk checks, " : "") .
			"$cnt_lines lines checked\n";
		print "\n" if ($quiet == 0);
2944
	}
2945

2946 2947 2948 2949 2950 2951
	if ($quiet == 0) {
		# If there were whitespace errors which cleanpatch can fix
		# then suggest that.
		if ($rpt_cleaners) {
			print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
			print "      scripts/cleanfile\n\n";
2952
			$rpt_cleaners = 0;
2953 2954 2955
		}
	}

2956
	if ($clean == 1 && $quiet == 0) {
2957
		print "$vname has no obvious style problems and is ready for submission.\n"
2958 2959
	}
	if ($clean == 0 && $quiet == 0) {
2960
		print "$vname has style problems, please review.  If any of these errors\n";
2961 2962 2963
		print "are false positives report them to the maintainer, see\n";
		print "CHECKPATCH in MAINTAINERS.\n";
	}
2964

2965 2966
	return $clean;
}