checkpatch.pl 75.5 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,2009, Andy Whitcroft <apw@canonical.com>
6 7 8 9 10
# Licensed under the terms of the GNU GPL License version 2

use strict;

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

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

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

my $quiet = 0;
my $tree = 1;
my $chk_signoff = 1;
my $chk_patch = 1;
21
my $tst_only;
22
my $emacs = 0;
23
my $terse = 0;
24 25
my $file = 0;
my $check = 0;
26 27
my $summary = 1;
my $mailback = 0;
28
my $summary_file = 0;
29
my $root;
30
my %debug;
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
my $help = 0;

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

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

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

When FILE is - read standard input.
EOM

	exit($exitcode);
}

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

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

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

my $exit = 0;

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

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

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

111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
if ($tree) {
	if (defined $root) {
		if (!top_of_kernel_tree($root)) {
			die "$P: $root: --root does not point at a valid tree\n";
		}
	} else {
		if (top_of_kernel_tree('.')) {
			$root = '.';
		} elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
						top_of_kernel_tree($1)) {
			$root = $1;
		}
	}

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

131 132
my $emitted_corrupt = 0;

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

# Notes to $Attribute:
# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
151 152 153 154
our $Attribute	= qr{
			const|
			__read_mostly|
			__kprobes|
155
			__(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
156 157
			____cacheline_aligned|
			____cacheline_aligned_in_smp|
158 159
			____cacheline_internodealigned_in_smp|
			__weak
160
		  }x;
161
our $Modifier;
162 163 164 165 166 167
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{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
168
our $Compare    = qr{<=|>=|==|!=|<|>};
169 170 171
our $Operators	= qr{
			<=|>=|==|!=|
			=>|->|<<|>>|<|>|!|~|
172
			&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
173 174
		  }x;

175 176 177 178
our $NonptrType;
our $Type;
our $Declare;

179 180 181 182 183 184 185 186 187 188 189
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;

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

195 196 197
our $logFunctions = qr{(?x:
	printk|
	pr_(debug|dbg|vdbg|devel|info|warning|err|notice|alert|crit|emerg|cont)|
198
	(dev|netdev|netif)_(printk|dbg|vdbg|info|warn|err|notice|alert|crit|emerg|WARN)|
199 200 201 202
	WARN|
	panic
)};

203 204
our @typeList = (
	qr{void},
205 206 207 208 209 210 211
	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},
212 213 214 215 216 217 218 219 220 221 222
	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},
);
223 224 225
our @modifierList = (
	qr{fastcall},
);
226

227 228 229 230 231 232
our $allowed_asm_includes = qr{(?x:
	irq|
	memory
)};
# memory.h: ARM has a custom one

233
sub build_types {
234 235
	my $mods = "(?x:  \n" . join("|\n  ", @modifierList) . "\n)";
	my $all = "(?x:  \n" . join("|\n  ", @typeList) . "\n)";
236
	$Modifier	= qr{(?:$Attribute|$Sparse|$mods)};
237
	$NonptrType	= qr{
238
			(?:$Modifier\s+|const\s+)*
239
			(?:
240
				(?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
241
				(?:$typeTypedefs\b)|
242
				(?:${all}\b)
243
			)
244
			(?:\s+$Modifier|\s+const)*
245 246
		  }x;
	$Type	= qr{
247
			$NonptrType
248
			(?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
249
			(?:\s+$Inline|\s+$Modifier)*
250 251 252 253
		  }x;
	$Declare	= qr{(?:$Storage\s+)?$Type};
}
build_types();
254 255 256

$chk_signoff = 0 if ($file);

257 258
my @dep_includes = ();
my @dep_functions = ();
259 260
my $removal = "Documentation/feature-removal-schedule.txt";
if ($tree && -f "$root/$removal") {
261
	open(my $REMOVE, '<', "$root/$removal") ||
262
				die "$P: $removal: open failed - $!\n";
263
	while (<$REMOVE>) {
264 265 266
		if (/^Check:\s+(.*\S)/) {
			for my $entry (split(/[, ]+/, $1)) {
				if ($entry =~ m@include/(.*)@) {
267 268
					push(@dep_includes, $1);

269 270 271
				} elsif ($entry !~ m@/@) {
					push(@dep_functions, $entry);
				}
272
			}
273 274
		}
	}
275
	close($REMOVE);
276 277
}

278
my @rawlines = ();
279 280
my @lines = ();
my $vname;
281
for my $filename (@ARGV) {
282
	my $FILE;
283
	if ($file) {
284
		open($FILE, '-|', "diff -u /dev/null $filename") ||
285
			die "$P: $filename: diff failed - $!\n";
286 287
	} elsif ($filename eq '-') {
		open($FILE, '<&STDIN');
288
	} else {
289
		open($FILE, '<', "$filename") ||
290
			die "$P: $filename: open failed - $!\n";
291
	}
292 293 294 295 296
	if ($filename eq '-') {
		$vname = 'Your patch';
	} else {
		$vname = $filename;
	}
297
	while (<$FILE>) {
298 299 300
		chomp;
		push(@rawlines, $_);
	}
301
	close($FILE);
302
	if (!process($filename)) {
303 304 305
		$exit = 1;
	}
	@rawlines = ();
306
	@lines = ();
307 308 309 310 311
}

exit($exit);

sub top_of_kernel_tree {
312 313 314 315 316 317 318 319 320 321 322 323
	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;
		}
324
	}
325
	return 1;
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
}

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;
}
348
sub copy_spacing {
349
	(my $res = shift) =~ tr/\t/ /c;
350 351
	return $res;
}
352

353 354 355 356 357 358 359 360 361 362 363 364 365
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));
}

366 367 368 369 370 371 372 373 374 375 376
my $sanitise_quote = '';

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

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
377 378 379 380 381 382
sub sanitise_line {
	my ($line) = @_;

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

383
	my $qlen = 0;
384 385
	my $off = 0;
	my $c;
386

387 388 389 390 391 392 393 394 395 396 397 398 399 400
	# 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;
401
		}
402
		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
403 404 405 406
			$sanitise_quote = '';
			substr($res, $off, 2, "$;$;");
			$off++;
			next;
407
		}
408 409 410 411 412 413 414
		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
			$sanitise_quote = '//';

			substr($res, $off, 2, $sanitise_quote);
			$off++;
			next;
		}
415 416 417 418 419 420 421

		# 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;
422
		}
423 424 425 426
		# Regular quotes.
		if ($c eq "'" || $c eq '"') {
			if ($sanitise_quote eq '') {
				$sanitise_quote = $c;
427

428 429 430 431 432 433
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
434

435
		#print "c<$c> SQ<$sanitise_quote>\n";
436 437
		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
			substr($res, $off, 1, $;);
438 439
		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
			substr($res, $off, 1, $;);
440 441 442 443 444
		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
			substr($res, $off, 1, 'X');
		} else {
			substr($res, $off, 1, $c);
		}
445 446
	}

447 448 449 450
	if ($sanitise_quote eq '//') {
		$sanitise_quote = '';
	}

451
	# The pathname on a #include may be surrounded by '<' and '>'.
452
	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
453 454 455 456
		my $clean = 'X' x length($1);
		$res =~ s@\<.*\>@<$clean>@;

	# The whole of a #error is a string.
457
	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
458
		my $clean = 'X' x length($1);
459
		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
460 461
	}

462 463 464
	return $res;
}

465 466 467 468 469 470
sub ctx_statement_block {
	my ($linenr, $remain, $off) = @_;
	my $line = $linenr - 1;
	my $blk = '';
	my $soff = $off;
	my $coff = $off - 1;
471
	my $coff_set = 0;
472

473 474
	my $loff = 0;

475 476
	my $type = '';
	my $level = 0;
477
	my @stack = ();
478
	my $p;
479 480
	my $c;
	my $len = 0;
481 482

	my $remainder;
483
	while (1) {
484 485
		@stack = (['', 0]) if ($#stack == -1);

486
		#warn "CSB: blk<$blk> remain<$remain>\n";
487 488 489 490
		# If we are about to drop off the end, pull in more
		# context.
		if ($off >= $len) {
			for (; $remain > 0; $line++) {
491
				last if (!defined $lines[$line]);
492
				next if ($lines[$line] =~ /^-/);
493
				$remain--;
494
				$loff = $len;
495
				$blk .= $lines[$line] . "\n";
496 497 498 499 500 501
				$len = length($blk);
				$line++;
				last;
			}
			# Bail if there is no further context.
			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
502
			if ($off >= $len) {
503 504 505
				last;
			}
		}
506
		$p = $c;
507
		$c = substr($blk, $off, 1);
508
		$remainder = substr($blk, $off);
509

510
		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
511 512 513 514 515 516 517 518 519 520

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

521 522 523 524 525 526
		# Statement ends at the ';' or a close '}' at the
		# outermost level.
		if ($level == 0 && $c eq ';') {
			last;
		}

527
		# An else is really a conditional as long as its not else if
528 529 530 531 532 533 534 535
		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";
536 537
		}

538 539 540 541 542 543 544 545 546 547
		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;
548 549
				$coff_set = 1;
				#warn "CSB: mark coff<$coff>\n";
550 551 552 553 554 555 556 557 558 559 560
			}
		}
		if (($type eq '' || $type eq '{') && $c eq '{') {
			$level++;
			$type = '{';
		}
		if ($type eq '{' && $c eq '}') {
			$level--;
			$type = ($level != 0)? '{' : '';

			if ($level == 0) {
561 562 563
				if (substr($blk, $off + 1, 1) eq ';') {
					$off++;
				}
564 565 566 567 568
				last;
			}
		}
		$off++;
	}
569
	# We are truly at the end, so shuffle to the next line.
570
	if ($off == $len) {
571
		$loff = $len + 1;
572 573 574
		$line++;
		$remain--;
	}
575 576 577 578 579 580 581

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

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

582
	#print "coff<$coff> soff<$off> loff<$loff>\n";
583 584 585 586 587

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

588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 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
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;
	}
}

631 632 633 634 635 636
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

637
	# Grab the first conditional/block pair.
638 639
	($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
640
	#print "F: c<$condition> s<$statement> remain<$remain>\n";
641 642 643 644 645 646 647
	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.
648 649 650
	for (;;) {
		($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
651
		#print "C: c<$condition> s<$statement> remain<$remain>\n";
652
		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
653 654
		#print "C: push\n";
		push(@chunks, [ $condition, $statement ]);
655 656 657
	}

	return ($level, $linenr, @chunks);
658 659
}

660
sub ctx_block_get {
661
	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
662 663 664 665 666 667 668
	my $line;
	my $start = $linenr - 1;
	my $blk = '';
	my @o;
	my @c;
	my @res = ();

669
	my $level = 0;
670
	my @stack = ($level);
671 672 673 674 675
	for ($line = $start; $remain > 0; $line++) {
		next if ($rawlines[$line] =~ /^-/);
		$remain--;

		$blk .= $rawlines[$line];
676 677 678 679 680 681 682 683 684 685

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

686 687 688 689 690 691
		foreach my $c (split(//, $rawlines[$line])) {
			##print "C<$c>L<$level><$open$close>O<$off>\n";
			if ($off > 0) {
				$off--;
				next;
			}
692

693 694 695 696 697 698 699
			if ($c eq $close && $level > 0) {
				$level--;
				last if ($level == 0);
			} elsif ($c eq $open) {
				$level++;
			}
		}
700

701
		if (!$outer || $level <= 1) {
702
			push(@res, $rawlines[$line]);
703 704
		}

705
		last if ($level == 0);
706 707
	}

708
	return ($level, @res);
709 710 711 712
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

713 714
	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
	return @r;
715 716 717 718
}
sub ctx_block {
	my ($linenr, $remain) = @_;

719 720
	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
	return @r;
721 722
}
sub ctx_statement {
723 724 725 726 727 728
	my ($linenr, $remain, $off) = @_;

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

731
	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
732
}
733 734 735 736 737
sub ctx_statement_level {
	my ($linenr, $remain, $off) = @_;

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
738 739 740 741 742

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

	# Catch a comment on the end of the line itself.
743
	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
744 745 746 747 748 749 750
	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++) {
751 752
		my $line = $rawlines[$linenr - 1];
		#warn "           $line\n";
753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774
		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);

775
	##print "LINE: $rawlines[$end_line - 1 ]\n";
776 777 778 779 780
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
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;
}

797 798 799
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
800

801 802 803 804 805 806
	$res = '';
	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
		$res .= $1;
		if ($2 ne '') {
			$coded = sprintf("^%c", unpack('C', $2) + 64);
			$res .= $coded;
807 808
		}
	}
809
	$res =~ s/$/\$/;
810

811
	return $res;
812 813
}

814
my $av_preprocessor = 0;
815
my $av_pending;
816
my @av_paren_type;
817
my $av_pend_colon;
818 819 820

sub annotate_reset {
	$av_preprocessor = 0;
821 822
	$av_pending = '_';
	@av_paren_type = ('E');
823
	$av_pend_colon = 'O';
824 825
}

826 827
sub annotate_values {
	my ($stream, $type) = @_;
828

829
	my $res;
830
	my $var = '_' x length($stream);
831 832
	my $cur = $stream;

833
	print "$stream\n" if ($dbg_values > 1);
834 835

	while (length($cur)) {
836
		@av_paren_type = ('E') if ($#av_paren_type < 0);
837
		print " <" . join('', @av_paren_type) .
838
				"> <$type> <$av_pending>" if ($dbg_values > 1);
839
		if ($cur =~ /^(\s+)/o) {
840 841
			print "WS($1)\n" if ($dbg_values > 1);
			if ($1 =~ /\n/ && $av_preprocessor) {
842
				$type = pop(@av_paren_type);
843
				$av_preprocessor = 0;
844 845
			}

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

850 851 852 853
		} elsif ($cur =~ /^($Modifier)\s*/) {
			print "MODIFIER($1)\n" if ($dbg_values > 1);
			$type = 'T';

854
		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
855
			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
856
			$av_preprocessor = 1;
857 858 859 860 861 862
			push(@av_paren_type, $type);
			if ($2 ne '') {
				$av_pending = 'N';
			}
			$type = 'E';

863
		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
864 865 866
			print "UNDEF($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;
			push(@av_paren_type, $type);
867

868
		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
869
			print "PRE_START($1)\n" if ($dbg_values > 1);
870
			$av_preprocessor = 1;
871 872 873

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
874
			$type = 'E';
875

876
		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
877 878 879 880 881
			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;

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

882
			$type = 'E';
883

884
		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
885 886 887 888 889 890 891 892
			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);
893
			$type = 'E';
894 895

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

898 899 900 901 902
		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
			print "ATTR($1)\n" if ($dbg_values > 1);
			$av_pending = $type;
			$type = 'N';

903
		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
904
			print "SIZEOF($1)\n" if ($dbg_values > 1);
905
			if (defined $2) {
906
				$av_pending = 'V';
907 908 909
			}
			$type = 'N';

910
		} elsif ($cur =~ /^(if|while|for)\b/o) {
911
			print "COND($1)\n" if ($dbg_values > 1);
912
			$av_pending = 'E';
913 914
			$type = 'N';

915 916 917 918 919
		} elsif ($cur =~/^(case)/o) {
			print "CASE($1)\n" if ($dbg_values > 1);
			$av_pend_colon = 'C';
			$type = 'N';

920
		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
921
			print "KEYWORD($1)\n" if ($dbg_values > 1);
922 923 924
			$type = 'N';

		} elsif ($cur =~ /^(\()/o) {
925
			print "PAREN('$1')\n" if ($dbg_values > 1);
926 927
			push(@av_paren_type, $av_pending);
			$av_pending = '_';
928 929 930
			$type = 'N';

		} elsif ($cur =~ /^(\))/o) {
931 932 933
			my $new_type = pop(@av_paren_type);
			if ($new_type ne '_') {
				$type = $new_type;
934 935
				print "PAREN('$1') -> $type\n"
							if ($dbg_values > 1);
936
			} else {
937
				print "PAREN('$1')\n" if ($dbg_values > 1);
938 939
			}

940
		} elsif ($cur =~ /^($Ident)\s*\(/o) {
941
			print "FUNC($1)\n" if ($dbg_values > 1);
942
			$type = 'V';
943
			$av_pending = 'V';
944

945 946
		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
			if (defined $2 && $type eq 'C' || $type eq 'T') {
947
				$av_pend_colon = 'B';
948 949
			} elsif ($type eq 'E') {
				$av_pend_colon = 'L';
950 951 952 953
			}
			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
			$type = 'V';

954
		} elsif ($cur =~ /^($Ident|$Constant)/o) {
955
			print "IDENT($1)\n" if ($dbg_values > 1);
956 957 958
			$type = 'V';

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

962
		} elsif ($cur =~/^(;|{|})/) {
963
			print "END($1)\n" if ($dbg_values > 1);
964
			$type = 'E';
965 966
			$av_pend_colon = 'O';

967 968 969 970
		} elsif ($cur =~/^(,)/) {
			print "COMMA($1)\n" if ($dbg_values > 1);
			$type = 'C';

971 972 973 974 975 976 977 978 979 980 981 982 983 984
		} 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';
985

986
		} elsif ($cur =~ /^(\[)/o) {
987
			print "CLOSE($1)\n" if ($dbg_values > 1);
988 989
			$type = 'N';

990
		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
991 992 993 994 995 996 997 998 999 1000 1001 1002
			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';

1003
		} elsif ($cur =~ /^($Operators)/o) {
1004
			print "OP($1)\n" if ($dbg_values > 1);
1005 1006 1007 1008 1009
			if ($1 ne '++' && $1 ne '--') {
				$type = 'N';
			}

		} elsif ($cur =~ /(^.)/o) {
1010
			print "C($1)\n" if ($dbg_values > 1);
1011 1012 1013 1014 1015
		}
		if (defined $1) {
			$cur = substr($cur, length($1));
			$res .= $type x length($1);
		}
1016
	}
1017

1018
	return ($res, $var);
1019 1020
}

1021
sub possible {
1022
	my ($possible, $line) = @_;
1023
	my $notPermitted = qr{(?:
1024 1025 1026 1027
		^(?:
			$Modifier|
			$Storage|
			$Type|
1028 1029 1030
			DEFINE_\S+
		)$|
		^(?:
1031 1032 1033 1034 1035 1036
			goto|
			return|
			case|
			else|
			asm|__asm__|
			do
1037
		)(?:\s|$)|
1038
		^(?:typedef|struct|enum)\b
1039 1040 1041
	    )}x;
	warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
	if ($possible !~ $notPermitted) {
1042 1043 1044 1045 1046 1047 1048
		# 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;
1049
			for my $modifier (split(' ', $possible)) {
1050 1051 1052 1053
				if ($modifier !~ $notPermitted) {
					warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
					push(@modifierList, $modifier);
				}
1054
			}
1055 1056 1057 1058 1059

		} else {
			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
			push(@typeList, $possible);
		}
1060
		build_types();
1061 1062
	} else {
		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1063 1064 1065
	}
}

1066 1067
my $prefix = '';

1068
sub report {
1069 1070 1071
	if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
		return 0;
	}
1072 1073 1074 1075
	my $line = $prefix . $_[0];

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

1076
	push(our @report, $line);
1077 1078

	return 1;
1079 1080
}
sub report_dump {
1081
	our @report;
1082
}
1083
sub ERROR {
1084 1085 1086 1087
	if (report("ERROR: $_[0]\n")) {
		our $clean = 0;
		our $cnt_error++;
	}
1088 1089
}
sub WARN {
1090 1091 1092 1093
	if (report("WARNING: $_[0]\n")) {
		our $clean = 0;
		our $cnt_warn++;
	}
1094 1095
}
sub CHK {
1096
	if ($check && report("CHECK: $_[0]\n")) {
1097 1098 1099
		our $clean = 0;
		our $cnt_chk++;
	}
1100 1101
}

1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128
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);
	}
}

1129 1130 1131 1132 1133
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
1134
	my $prevrawline="";
1135
	my $stashline="";
1136
	my $stashrawline="";
1137

1138
	my $length;
1139 1140 1141 1142
	my $indent;
	my $previndent=0;
	my $stashindent=0;

1143
	our $clean = 1;
1144 1145 1146
	my $signoff = 0;
	my $is_patch = 0;

1147
	our @report = ();
1148 1149 1150 1151 1152
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

1153 1154 1155 1156 1157 1158
	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
	my $in_comment = 0;
1159
	my $comment_edge = 0;
1160
	my $first_line = 0;
1161
	my $p1_prefix = '';
1162

1163 1164 1165
	my $prev_values = 'E';

	# suppression flags
1166
	my %suppress_ifbraces;
1167
	my %suppress_whiletrailers;
1168
	my %suppress_export;
1169

1170
	# Pre-scan the patch sanitizing the lines.
1171
	# Pre-scan the patch looking for any __setup documentation.
1172
	#
1173 1174
	my @setup_docs = ();
	my $setup_docs = 0;
1175 1176

	sanitise_line_reset();
1177 1178
	my $line;
	foreach my $rawline (@rawlines) {
1179 1180
		$linenr++;
		$line = $rawline;
1181

1182
		if ($rawline=~/^\+\+\+\s+(\S+)/) {
1183 1184 1185 1186
			$setup_docs = 0;
			if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
				$setup_docs = 1;
			}
1187 1188 1189 1190 1191 1192 1193 1194 1195
			#next;
		}
		if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1196
			$in_comment = 0;
1197 1198 1199 1200 1201 1202

			# 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;
1203 1204 1205 1206 1207 1208
			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";
1209
				last if (!defined $rawlines[$ln - 1]);
1210 1211 1212 1213 1214
				if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
				    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
					($edge) = $1;
					last;
				}
1215 1216 1217 1218 1219 1220 1221 1222 1223
			}
			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 &&
1224
			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1225 1226 1227 1228 1229 1230 1231
			{
				$in_comment = 1;
			}

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

1232
		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1233
			# Standardise the strings and chars within the input to
1234
			# simplify matching -- only bother with positive lines.
1235
			$line = sanitise_line($rawline);
1236
		}
1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
		push(@lines, $line);

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

		#print "==>$rawline\n";
		#print "-->$line\n";
1247 1248 1249 1250 1251 1252

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

1253 1254
	$prefix = '';

1255 1256
	$realcnt = 0;
	$linenr = 0;
1257 1258 1259
	foreach my $line (@lines) {
		$linenr++;

1260
		my $rawline = $rawlines[$linenr - 1];
1261

1262
#extract the line range in the file after the patch is applied
1263
		if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1264
			$is_patch = 1;
1265
			$first_line = $linenr + 1;
1266 1267 1268 1269 1270 1271
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1272
			annotate_reset();
1273 1274
			$prev_values = 'E';

1275
			%suppress_ifbraces = ();
1276
			%suppress_whiletrailers = ();
1277
			%suppress_export = ();
1278 1279
			next;

1280 1281 1282
# 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.
1283
		} elsif ($line =~ /^( |\+|$)/) {
1284
			$realline++;
1285
			$realcnt-- if ($realcnt != 0);
1286

1287
			# Measure the line length and indent.
1288
			($length, $indent) = line_stats($rawline);
1289 1290 1291 1292

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

1295
			#warn "line<$line>\n";
1296

1297 1298
		} elsif ($realcnt == 1) {
			$realcnt--;
1299 1300
		}

1301 1302
		my $hunk_line = ($realcnt != 0);

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

1307 1308
		$here = "#$linenr: " if (!$file);
		$here = "#$realline: " if ($file);
1309 1310 1311 1312

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

			$p1_prefix = $1;
1316 1317
			if (!$file && $tree && $p1_prefix ne '' &&
			    -e "$root/$p1_prefix") {
1318 1319
				WARN("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
			}
1320

1321
			if ($realfile =~ m@^include/asm/@) {
1322 1323 1324 1325 1326
				ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
			}
			next;
		}

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

1329 1330 1331
		my $hereline = "$here\n$rawline\n";
		my $herecurr = "$here\n$rawline\n";
		my $hereprev = "$here\n$prevrawline\n$rawline\n";
1332

1333 1334
		$cnt_lines++ if ($realcnt != 0);

1335
#check the patch for a signoff:
1336
		if ($line =~ /^\s*signed-off-by:/i) {
1337 1338
			# This is a signoff, if ugly, so do not double report.
			$signoff++;
1339
			if (!($line =~ /^\s*Signed-off-by:/)) {
1340 1341
				WARN("Signed-off-by: is the preferred form\n" .
					$herecurr);
1342 1343
			}
			if ($line =~ /^\s*signed-off-by:\S/i) {
1344
				WARN("space required after Signed-off-by:\n" .
1345
					$herecurr);
1346 1347 1348
			}
		}

1349
# Check for wrappage within a valid hunk of the file
1350
		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1351
			ERROR("patch seems to be corrupt (line wrapped?)\n" .
1352
				$herecurr) if (!$emitted_corrupt++);
1353 1354
		}

1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368
# 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);
				}
			}
		}

1369 1370
# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1371 1372 1373 1374 1375 1376 1377 1378
		    $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);
1379 1380
		}

1381 1382
# ignore non-hunk lines and lines being removed
		next if (!$hunk_line || $line =~ /^-/);
1383 1384

#trailing whitespace
1385
		if ($line =~ /^\+.*\015/) {
1386
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1387 1388
			ERROR("DOS line endings\n" . $herevet);

1389 1390
		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1391
			ERROR("trailing whitespace\n" . $herevet);
1392
		}
1393

1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408
# check for Kconfig help text having a real description
		if ($realfile =~ /Kconfig/ &&
		    $line =~ /\+?\s*(---)?help(---)?$/) {
			my $length = 0;
			for (my $l = $linenr; defined($lines[$l]); $l++) {
				my $f = $lines[$l];
				$f =~ s/#.*//;
				$f =~ s/^\s+//;
				next if ($f =~ /^$/);
				last if ($f =~ /^\s*config\s/);
				$length++;
			}
			WARN("please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($length < 4);
		}

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

1412
#80 column limit
1413
		if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1414
		    $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1415 1416
		    !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ ||
		    $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
1417
		    $length > 80)
1418
		{
1419
			WARN("line over 80 characters\n" . $herecurr);
1420 1421
		}

1422 1423 1424 1425 1426
# check for spaces before a quoted newline
		if ($rawline =~ /^.*\".*\s\\n/) {
			WARN("unnecessary whitespace before a quoted newline\n" . $herecurr);
		}

1427 1428 1429 1430 1431
# 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);
		}

1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443
# 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);
			}
		}

1444 1445
# check we are in a valid source file C or perl if not then ignore this hunk
		next if ($realfile !~ /\.(h|c|pl)$/);
1446 1447 1448

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

1455 1456 1457 1458 1459 1460
# 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);
		}

1461 1462 1463 1464 1465 1466 1467
# check for spaces at the beginning of a line.
		if ($rawline =~ /^\+ / && $rawline !~ /\+ +\*/)  {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
			WARN("please, no space for starting a line, \
				excluding comments\n" . $herevet);
		}

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

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

1476 1477 1478 1479 1480 1481 1482 1483 1484 1485
# 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);
		}

1486
# Check for potential 'bare' types
1487 1488
		my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
		    $realline_next);
1489
		if ($realcnt && $line =~ /.\s*\S/) {
1490
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1491
				ctx_statement_block($linenr, $realcnt, 0);
1492 1493 1494
			$stat =~ s/\n./\n /g;
			$cond =~ s/\n./\n /g;

1495 1496 1497 1498 1499 1500 1501 1502
			# 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++;
			}

1503 1504
			my $s = $stat;
			$s =~ s/{.*$//s;
1505

1506
			# Ignore goto labels.
1507
			if ($s =~ /$Ident:\*$/s) {
1508 1509

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

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

1514
			# declarations always start with types
1515
			} 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) {
1516 1517 1518 1519
				my $type = $1;
				$type =~ s/\s+/ /g;
				possible($type, "A:" . $s);

1520
			# definitions in global scope can only start with types
1521
			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
1522
				possible($1, "B:" . $s);
1523
			}
1524 1525

			# any (foo ... *) is a pointer cast, and foo is a type
1526
			while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
1527
				possible($1, "C:" . $s);
1528 1529 1530 1531 1532
			}

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

1536
				my $ctx = $s;
1537
				substr($ctx, 0, $name_len + 1, '');
1538
				$ctx =~ s/\)[^\)]*$//;
1539

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

1543
						possible($1, "D:" . $s);
1544 1545
					}
				}
1546
			}
1547

1548 1549
		}

1550 1551 1552
#
# Checks which may be anchored in the context.
#
1553

1554 1555
# Check for switch () and associated case and default
# statements should be at the same indent.
1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571
		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 '') {
1572
				ERROR("switch and case should be at the same indent\n$hereline$err");
1573 1574 1575 1576 1577
			}
		}

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

1581
			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
1582 1583 1584
			my $ctx_cnt = $realcnt - $#ctx - 1;
			my $ctx = join("\n", @ctx);

1585 1586
			my $ctx_ln = $linenr;
			my $ctx_skip = $realcnt;
1587

1588 1589 1590 1591 1592
			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] !~ /^-/);
1593 1594
				$ctx_ln++;
			}
1595

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

1599 1600
			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
				ERROR("that open brace { should be on the previous line\n" .
1601
					"$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1602
			}
1603 1604 1605 1606
			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
			    $ctx =~ /\)\s*\;\s*$/ &&
			    defined $lines[$ctx_ln - 1])
			{
1607 1608
				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
				if ($nindent > $indent) {
1609
					WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
1610
						"$here\n$ctx\n$lines[$ctx_ln - 1]\n");
1611 1612
				}
			}
1613 1614
		}

1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626
# 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.
1627 1628
			my @newlines = ($c =~ /\n/gs);
			my $cond_lines = 1 + $#newlines;
1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641

			# 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;
			}
1642
			if ($s =~ s/^\s*?\n//) {
1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653
				$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;
			}

1654
			my $cond_ptr = -1;
1655
			$continuation = 0;
1656 1657 1658
			while ($cond_ptr != $cond_lines) {
				$cond_ptr = $cond_lines;

1659 1660 1661 1662 1663 1664
				# If we see an #else/#elif then the code
				# is not linear.
				if ($s =~ /^\s*\#\s*(?:else|elif)/) {
					$check = 0;
				}

1665 1666 1667 1668
				# Ignore:
				#  1) blank lines, they should be at 0,
				#  2) preprocessor lines, and
				#  3) labels.
1669 1670
				if ($continuation ||
				    $s =~ /^\s*?\n/ ||
1671 1672
				    $s =~ /^\s*#\s*?/ ||
				    $s =~ /^\s*$Ident\s*:/) {
1673
					$continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
1674 1675 1676
					if ($s =~ s/^.*?\n//) {
						$cond_lines++;
					}
1677
				}
1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692
			}

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

1693
			#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";
1694 1695 1696 1697 1698 1699 1700

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

1701 1702
		# Track the 'values' across context and added lines.
		my $opline = $line; $opline =~ s/^./ /;
1703 1704
		my ($curr_values, $curr_vars) =
				annotate_values($opline . "\n", $prev_values);
1705
		$curr_values = $prev_values . $curr_values;
1706 1707
		if ($dbg_values) {
			my $outline = $opline; $outline =~ s/\t/ /g;
1708 1709
			print "$linenr > .$outline\n";
			print "$linenr > $curr_values\n";
1710
			print "$linenr >  $curr_vars\n";
1711
		}
1712 1713
		$prev_values = substr($curr_values, -1);

1714 1715 1716
#ignore lines not being added
		if ($line=~/^[^\+]/) {next;}

1717
# TEST: allow direct testing of the type matcher.
1718 1719 1720 1721 1722 1723
		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);
			}
1724 1725
			next;
		}
1726 1727
# TEST: allow direct testing of the attribute matcher.
		if ($dbg_attr) {
1728
			if ($line =~ /^.\s*$Modifier\s*$/) {
1729
				ERROR("TEST: is attr\n" . $herecurr);
1730
			} elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
1731 1732 1733 1734
				ERROR("TEST: is not attr ($1 is)\n". $herecurr);
			}
			next;
		}
1735

1736
# check for initialisation to aggregates open brace on the next line
1737 1738
		if ($line =~ /^.\s*{/ &&
		    $prevline =~ /(?:^|[^=])=\s*$/) {
1739
			ERROR("that open brace { should be on the previous line\n" . $hereprev);
1740 1741
		}

1742 1743 1744 1745 1746
#
# Checks which are anchored on the added line.
#

# check for malformed paths in #include statements (uses RAW line)
1747
		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
1748 1749
			my $path = $1;
			if ($path =~ m{//}) {
1750 1751
				ERROR("malformed #include filename\n" .
					$herecurr);
1752 1753
			}
		}
1754

1755
# no C99 // comments
1756
		if ($line =~ m{//}) {
1757
			ERROR("do not use C99 // comments\n" . $herecurr);
1758
		}
1759
		# Remove C99 comments.
1760
		$line =~ s@//.*@@;
1761
		$opline =~ s@//.*@@;
1762

1763 1764 1765 1766 1767 1768 1769 1770
# 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.*\((.*)\)/)) {
1771
			my $name = $1;
1772 1773
			if ($stat !~ /(?:
				\n.}\s*$|
1774 1775 1776
				^.DEFINE_$Ident\(\Q$name\E\)|
				^.DECLARE_$Ident\(\Q$name\E\)|
				^.LIST_HEAD\(\Q$name\E\)|
1777 1778
				^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
				\b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
1779
			    )/x) {
1780 1781 1782 1783
#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
				$suppress_export{$realline_next} = 2;
			} else {
				$suppress_export{$realline_next} = 1;
1784 1785
			}
		}
1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796
		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);
		}
1797

1798
# check for global initialisers.
1799
		if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
1800
			ERROR("do not initialise globals to 0 or NULL\n" .
1801 1802
				$herecurr);
		}
1803
# check for static initialisers.
1804
		if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
1805 1806
			ERROR("do not initialise statics to 0 or NULL\n" .
				$herecurr);
1807 1808
		}

1809 1810 1811
# check for new typedefs, only function parameters and sparse annotations
# make sense.
		if ($line =~ /\btypedef\s/ &&
1812
		    $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
1813
		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
1814
		    $line !~ /\b$typeTypedefs\b/ &&
1815
		    $line !~ /\b__bitwise(?:__|)\b/) {
1816
			WARN("do not add new typedefs\n" . $herecurr);
1817 1818 1819
		}

# * goes on variable not on type
1820
		# (char*[ const])
1821
		if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
1822 1823 1824 1825 1826 1827 1828
			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.
1829
			while ($to =~ s/\*\s+\*/\*\*/) {
1830
			}
1831

1832 1833 1834 1835
			#print "from<$from> to<$to>\n";
			if ($from ne $to) {
				ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" .  $herecurr);
			}
1836
		} elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
1837 1838 1839 1840 1841 1842 1843
			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.
1844
			while ($to =~ s/\*\s+\*/\*\*/) {
1845 1846 1847
			}
			# Modifiers should have spaces.
			$to =~ s/(\b$Modifier$)/$1 /;
1848

1849 1850
			#print "from<$from> to<$to> ident<$ident>\n";
			if ($from ne $to && $ident !~ /^$Modifier$/) {
1851 1852
				ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" .  $herecurr);
			}
1853 1854 1855 1856 1857 1858 1859 1860 1861
		}

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

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

1866 1867 1868 1869 1870
# 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.
1871
		if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884
			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) {
1885
				WARN("printk() should include KERN_ facility level\n" . $herecurr);
1886
			}
1887 1888
		}

1889 1890
# function brace can't be on same line, except for #defines of do while,
# or if closed on same line
1891 1892
		if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
		    !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
1893
			ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
1894
		}
1895

1896 1897 1898 1899 1900 1901
# 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);
		}

1902 1903
# check for spacing round square brackets; allowed:
#  1. with a type on the left -- int [] a;
1904 1905
#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
#  3. inside a curly brace -- = { [0...10] = 5 }
1906 1907 1908
		while ($line =~ /(.*?\s)\[/g) {
			my ($where, $prefix) = ($-[1], $1);
			if ($prefix !~ /$Type\s+$/ &&
1909 1910
			    ($where != 0 || $prefix !~ /^.\s+$/) &&
			    $prefix !~ /{\s+$/) {
1911 1912 1913 1914
				ERROR("space prohibited before open square bracket '['\n" . $herecurr);
			}
		}

1915
# check for spaces between functions and their parentheses.
1916
		while ($line =~ /($Ident)\s+\(/g) {
1917
			my $name = $1;
1918 1919
			my $ctx_before = substr($line, 0, $-[1]);
			my $ctx = "$ctx_before$name";
1920 1921

			# Ignore those directives where spaces _are_ permitted.
1922 1923 1924 1925 1926 1927
			if ($name =~ /^(?:
				if|for|while|switch|return|case|
				volatile|__volatile__|
				__attribute__|format|__extension__|
				asm|__asm__)$/x)
			{
1928 1929 1930 1931

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

			# cpp #elif statement condition may start with a (
1935
			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
1936 1937 1938

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

			} else {
1942
				WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
1943
			}
1944
		}
1945
# Check operator spacing.
1946
		if (!($line=~/\#\s*include/)) {
1947 1948 1949 1950
			my $ops = qr{
				<<=|>>=|<=|>=|==|!=|
				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
				=>|->|<<|>>|<|>|=|!|~|
1951 1952
				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
				\?|:
1953
			}x;
1954
			my @elements = split(/($ops|;)/, $opline);
1955
			my $off = 0;
1956 1957 1958

			my $blank = copy_spacing($opline);

1959
			for (my $n = 0; $n < $#elements; $n += 2) {
1960 1961
				$off += length($elements[$n]);

1962 1963 1964 1965 1966 1967 1968 1969
				# 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";

1970 1971 1972
				my $a = '';
				$a = 'V' if ($elements[$n] ne '');
				$a = 'W' if ($elements[$n] =~ /\s$/);
1973
				$a = 'C' if ($elements[$n] =~ /$;$/);
1974 1975
				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
				$a = 'O' if ($elements[$n] eq '');
1976
				$a = 'E' if ($ca =~ /^\s*$/);
1977

1978
				my $op = $elements[$n + 1];
1979 1980

				my $c = '';
1981
				if (defined $elements[$n + 2]) {
1982 1983
					$c = 'V' if ($elements[$n + 2] ne '');
					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
1984
					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
1985 1986
					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
					$c = 'O' if ($elements[$n + 2] eq '');
1987
					$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
1988 1989
				} else {
					$c = 'E';
1990 1991
				}

1992 1993 1994 1995
				my $ctx = "${a}x${c}";

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

1996
				my $ptr = substr($blank, 0, $off) . "^";
1997
				my $hereptr = "$hereline$ptr\n";
1998

1999
				# Pull out the value of this operator.
2000
				my $op_type = substr($curr_values, $off + 1, 1);
2001

2002 2003 2004
				# Get the full operator variant.
				my $opv = $op . substr($curr_vars, $off, 1);

2005 2006 2007 2008
				# Ignore operators passed as parameters.
				if ($op_type ne 'V' &&
				    $ca =~ /\s$/ && $cc =~ /^\s*,/) {

2009 2010
#				# Ignore comments
#				} elsif ($op =~ /^$;+$/) {
2011

2012
				# ; should have either the end of line or a space or \ after it
2013
				} elsif ($op eq ';') {
2014 2015
					if ($ctx !~ /.x[WEBC]/ &&
					    $cc !~ /^\\/ && $cc !~ /^;/) {
2016
						ERROR("space required after that '$op' $at\n" . $hereptr);
2017 2018 2019 2020
					}

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

2022 2023 2024 2025
				# No spaces for:
				#   ->
				#   :   when part of a bitfield
				} elsif ($op eq '->' || $opv eq ':B') {
2026
					if ($ctx =~ /Wx.|.xW/) {
2027
						ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
2028 2029 2030 2031
					}

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

2036
				# '*' as part of a type definition -- reported already.
2037
				} elsif ($opv eq '*_') {
2038 2039 2040 2041 2042 2043
					#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 '~' ||
2044
					 $opv eq '*U' || $opv eq '-U' ||
2045
					 $opv eq '&U' || $opv eq '&&U') {
2046
					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
2047
						ERROR("space required before that '$op' $at\n" . $hereptr);
2048
					}
2049
					if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
2050 2051 2052
						# A unary '*' may be const

					} elsif ($ctx =~ /.xW/) {
2053
						ERROR("space prohibited after that '$op' $at\n" . $hereptr);
2054 2055 2056 2057
					}

				# unary ++ and unary -- are allowed no space on one side.
				} elsif ($op eq '++' or $op eq '--') {
2058 2059 2060 2061 2062 2063
					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);
2064
					}
2065 2066
					if ($ctx =~ /ExW/) {
						ERROR("space prohibited after that '$op' $at\n" . $hereptr);
2067
					}
2068

2069

2070
				# << and >> may either have or not have spaces both sides
2071 2072 2073
				} elsif ($op eq '<<' or $op eq '>>' or
					 $op eq '&' or $op eq '^' or $op eq '|' or
					 $op eq '+' or $op eq '-' or
2074 2075
					 $op eq '*' or $op eq '/' or
					 $op eq '%')
2076
				{
2077
					if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
2078 2079
						ERROR("need consistent spacing around '$op' $at\n" .
							$hereptr);
2080 2081
					}

2082 2083 2084 2085 2086 2087 2088
				# 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);
					}

2089
				# All the others need spaces both sides.
2090
				} elsif ($ctx !~ /[EWC]x[CWE]/) {
2091 2092
					my $ok = 0;

2093
					# Ignore email addresses <foo@bar>
2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108
					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) {
2109
						ERROR("spaces required around that '$op' $at\n" . $hereptr);
2110
					}
2111
				}
2112
				$off += length($elements[$n + 1]);
2113 2114 2115
			}
		}

2116 2117
# check for multiple assignments
		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
2118
			CHK("multiple assignments should be avoided\n" . $herecurr);
2119 2120
		}

2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134
## # 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);
## 			}
## 		}
2135

2136
#need space before brace following if, while, etc
2137 2138
		if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
		    $line =~ /do{/) {
2139
			ERROR("space required before the open brace '{'\n" . $herecurr);
2140 2141 2142 2143 2144
		}

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

2148 2149
# check spacing on square brackets
		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
2150
			ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
2151 2152
		}
		if ($line =~ /\s\]/) {
2153
			ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
2154 2155
		}

2156
# check spacing on parentheses
2157 2158
		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
		    $line !~ /for\s*\(\s+;/) {
2159
			ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
2160
		}
2161
		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
2162 2163
		    $line !~ /for\s*\(.*;\s+\)/ &&
		    $line !~ /:\s+\)/) {
2164
			ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
2165 2166
		}

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

2173 2174 2175 2176 2177
# Return is not a function.
		if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
			my $spacing = $1;
			my $value = $2;

2178
			# Flatten any parentheses
2179
			$value =~ s/\)\(/\) \(/g;
2180 2181 2182 2183 2184
			while ($value =~ s/\[[^\{\}]*\]/1/ ||
			       $value !~ /(?:$Ident|-?$Constant)\s*
					     $Compare\s*
					     (?:$Ident|-?$Constant)/x &&
			       $value =~ s/\([^\(\)]*\)/1/) {
2185 2186 2187 2188 2189 2190 2191 2192 2193 2194
			}

			if ($value =~ /^(?:$Ident|-?$Constant)$/) {
				ERROR("return is not a function, parentheses are not required\n" . $herecurr);

			} elsif ($spacing !~ /\s+/) {
				ERROR("space required before the open parenthesis '('\n" . $herecurr);
			}
		}

2195
# Need a space before open parenthesis after if, while etc
2196
		if ($line=~/\b(if|while|for|switch)\(/) {
2197
			ERROR("space required before the open parenthesis '('\n" . $herecurr);
2198 2199
		}

2200 2201
# Check for illegal assignment in if conditional -- and check for trailing
# statements after the conditional.
2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221
		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*#/) {
2222
			my ($s, $c) = ($stat, $cond);
2223

2224
			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2225
				ERROR("do not use assignment in if condition\n" . $herecurr);
2226 2227 2228 2229
			}

			# Find out what is on the end of the line after the
			# conditional.
2230
			substr($s, 0, length($c), '');
2231
			$s =~ s/\n.*//g;
2232
			$s =~ s/$;//g; 	# Remove any comments
2233 2234
			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
			    $c !~ /}\s*while\s*/)
2235
			{
2236 2237 2238
				# Find out how long the conditional actually is.
				my @newlines = ($c =~ /\n/gs);
				my $cond_lines = 1 + $#newlines;
2239
				my $stat_real = '';
2240

2241 2242
				$stat_real = raw_line($linenr, $cond_lines)
							. "\n" if ($cond_lines);
2243 2244 2245 2246 2247
				if (defined($stat_real) && $cond_lines > 1) {
					$stat_real = "[...]\n$stat_real";
				}

				ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real);
2248 2249 2250
			}
		}

2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265
# 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);
		}

2266
# if and else should not have general statements after it
2267 2268 2269 2270 2271 2272
		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);
			}
2273
		}
2274 2275 2276 2277 2278
# if should not continue a brace
		if ($line =~ /}\s*if\b/) {
			ERROR("trailing statements should be on next line\n" .
				$herecurr);
		}
2279 2280 2281
# case and default should not have general statements after them
		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
		    $line !~ /\G(?:
2282
			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
2283 2284 2285 2286 2287
			\s*return\s+
		    )/xg)
		{
			ERROR("trailing statements should be on next line\n" . $herecurr);
		}
2288 2289 2290 2291 2292

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

2296 2297 2298 2299 2300 2301
		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.
2302
			substr($s, 0, length($c), '');
2303 2304 2305 2306 2307 2308 2309
			$s =~ s/\n.*//g;

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

2310 2311 2312 2313 2314 2315 2316 2317
#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
2318
		if ($line=~/\#\s*define.*\\\s$/) {
2319
			WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
2320 2321
		}

2322
#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2323
		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2324 2325 2326 2327
			my $file = "$1.h";
			my $checkfile = "include/linux/$file";
			if (-f "$root/$checkfile" &&
			    $realfile ne $checkfile &&
2328
			    $1 !~ /$allowed_asm_includes/)
2329
			{
2330 2331 2332 2333 2334
				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);
				}
2335 2336 2337
			}
		}

2338 2339
# 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
2340
# in a known good container
2341 2342
		if ($realfile !~ m@/vmlinux.lds.h$@ &&
		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2343 2344
			my $ln = $linenr;
			my $cnt = $realcnt;
2345 2346
			my ($off, $dstat, $dcond, $rest);
			my $ctx = '';
2347

2348 2349 2350 2351 2352 2353 2354 2355
			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";
2356
				$cnt-- if ($lines[$ln - 1] !~ /^-/);
2357 2358 2359 2360 2361 2362 2363
				$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";
2364
			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2365 2366 2367 2368

			# Extract the remainder of the define (if any) and
			# rip off surrounding spaces, and trailing \'s.
			$rest = '';
2369 2370
			while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
				#print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
2371 2372 2373 2374
				if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
					$rest .= substr($lines[$ln - 1], $off) . "\n";
					$cnt--;
				}
2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386
				$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*//;
2387
			}
2388
			$dstat =~ s/$;//g;
2389 2390 2391
			$dstat =~ s/\\\n.//g;
			$dstat =~ s/^\s*//s;
			$dstat =~ s/\s*$//s;
2392

2393
			# Flatten any parentheses and braces
2394 2395 2396 2397
			while ($dstat =~ s/\([^\(\)]*\)/1/ ||
			       $dstat =~ s/\{[^\{\}]*\}/1/ ||
			       $dstat =~ s/\[[^\{\}]*\]/1/)
			{
2398
			}
2399

2400 2401 2402 2403 2404 2405
			my $exceptions = qr{
				$Declare|
				module_param_named|
				MODULE_PARAM_DESC|
				DECLARE_PER_CPU|
				DEFINE_PER_CPU|
2406
				__typeof__\(|
2407 2408
				union|
				struct|
2409 2410
				\.$Ident\s*=\s*|
				^\"|\"$
2411
			}x;
2412
			#print "REST<$rest> dstat<$dstat>\n";
2413 2414 2415 2416
			if ($rest ne '') {
				if ($rest !~ /while\s*\(/ &&
				    $dstat !~ /$exceptions/)
				{
2417
					ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
2418 2419 2420 2421 2422 2423
				}

			} elsif ($ctx !~ /;/) {
				if ($dstat ne '' &&
				    $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
				    $dstat !~ /$exceptions/ &&
2424
				    $dstat !~ /^\.$Ident\s*=/ &&
2425 2426
				    $dstat =~ /$Operators/)
				{
2427
					ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
2428
				}
2429
			}
2430 2431
		}

2432 2433 2434 2435 2436 2437 2438 2439 2440
# 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);
		}

2441
# check for redundant bracing round if etc
2442 2443
		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
			my ($level, $endln, @chunks) =
2444
				ctx_statement_full($linenr, $realcnt, 1);
2445
			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2446 2447
			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
			if ($#chunks > 0 && $level == 0) {
2448 2449
				my $allowed = 0;
				my $seen = 0;
2450
				my $herectx = $here . "\n";
2451
				my $ln = $linenr - 1;
2452 2453 2454
				for my $chunk (@chunks) {
					my ($cond, $block) = @{$chunk};

2455 2456 2457 2458 2459 2460 2461 2462 2463 2464
					# 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";
2465 2466
					$ln += statement_rawlines($block) - 1;

2467
					substr($block, 0, length($cond), '');
2468 2469 2470

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

2471 2472 2473
					#print "cond<$cond> block<$block> allowed<$allowed>\n";
					if (statement_lines($cond) > 1) {
						#print "APW: ALLOWED: cond<$cond>\n";
2474 2475 2476
						$allowed = 1;
					}
					if ($block =~/\b(?:if|for|while)\b/) {
2477
						#print "APW: ALLOWED: block<$block>\n";
2478 2479
						$allowed = 1;
					}
2480 2481
					if (statement_block_size($block) > 1) {
						#print "APW: ALLOWED: lines block<$block>\n";
2482 2483 2484 2485
						$allowed = 1;
					}
				}
				if ($seen && !$allowed) {
2486
					WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
2487 2488 2489
				}
			}
		}
2490
		if (!defined $suppress_ifbraces{$linenr - 1} &&
2491
					$line =~ /\b(if|while|for|else)\b/) {
2492 2493 2494 2495 2496 2497 2498
			my $allowed = 0;

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

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

2503 2504
			# Check the condition.
			my ($cond, $block) = @{$chunks[0]};
2505
			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
2506
			if (defined $cond) {
2507
				substr($block, 0, length($cond), '');
2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524
			}
			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) {
2525
					substr($block, 0, length($cond), '');
2526 2527 2528 2529 2530 2531 2532 2533
				}
				if ($block =~ /^\s*\{/) {
					#print "APW: ALLOWED: chunk-1 block<$block>\n";
					$allowed = 1;
				}
			}
			if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
				my $herectx = $here . "\n";;
2534
				my $cnt = statement_rawlines($block);
2535

2536 2537
				for (my $n = 0; $n < $cnt; $n++) {
					$herectx .= raw_line($linenr, $n) . "\n";;
2538
				}
2539 2540

				WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
2541 2542 2543
			}
		}

2544
# don't include deprecated include files (uses RAW line)
2545
		for my $inc (@dep_includes) {
2546
			if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
2547
				ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2548 2549 2550
			}
		}

2551 2552
# don't use deprecated functions
		for my $func (@dep_functions) {
2553
			if ($line =~ /\b$func\b/) {
2554
				ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
2555 2556 2557 2558
			}
		}

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

2564 2565 2566 2567 2568
# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
		if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
			ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
		}

2569
# warn about #if 0
2570
		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
2571 2572
			CHK("if this code is redundant consider removing it\n" .
				$herecurr);
2573 2574
		}

2575 2576 2577 2578
# check for needless kfree() checks
		if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
			my $expr = $1;
			if ($line =~ /\bkfree\(\Q$expr\E\);/) {
2579
				WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
2580 2581
			}
		}
2582 2583 2584 2585 2586 2587 2588
# 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);
			}
		}
2589

2590 2591 2592 2593 2594 2595 2596 2597
# 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);
			}
		}

2598 2599 2600 2601 2602 2603 2604
# 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);
			}
		}

2605
# warn about #ifdefs in C files
2606
#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
2607 2608 2609 2610 2611
#			print "#ifdef in C files should be avoided\n";
#			print "$herecurr";
#			$clean = 0;
#		}

2612
# warn about spacing in #ifdefs
2613
		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
2614 2615 2616
			ERROR("exactly one space required after that #$1\n" . $herecurr);
		}

2617
# check for spinlock_t definitions without a comment.
2618 2619
		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
2620 2621
			my $which = $1;
			if (!ctx_has_comment($first_line, $linenr)) {
2622
				CHK("$1 definition without comment\n" . $herecurr);
2623 2624 2625 2626 2627
			}
		}
# 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)) {
2628
				CHK("memory barrier without comment\n" . $herecurr);
2629 2630 2631
			}
		}
# check of hardware specific defines
2632
		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
2633
			CHK("architecture specific defines should be avoided\n" .  $herecurr);
2634
		}
2635

2636 2637 2638 2639 2640
# 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)
		}

2641 2642
# check the location of the inline attribute, that it is between
# storage class and type.
2643 2644
		if ($line =~ /\b$Type\s+$Inline\b/ ||
		    $line =~ /\b$Inline\s+$Storage\b/) {
2645 2646 2647
			ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
		}

2648 2649 2650 2651 2652
# Check for __inline__ and __inline, prefer inline
		if ($line =~ /\b(__inline__|__inline)\b/) {
			WARN("plain inline is preferred over $1\n" . $herecurr);
		}

2653 2654 2655 2656 2657
# check for sizeof(&)
		if ($line =~ /\bsizeof\s*\(\s*\&/) {
			WARN("sizeof(& should be avoided\n" . $herecurr);
		}

2658
# check for new externs in .c files.
2659
		if ($realfile =~ /\.c$/ && defined $stat &&
2660
		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
2661
		{
2662 2663
			my $function_name = $1;
			my $paren_space = $2;
2664 2665 2666 2667 2668

			my $s = $stat;
			if (defined $cond) {
				substr($s, 0, length($cond), '');
			}
2669 2670 2671
			if ($s =~ /^\s*;/ &&
			    $function_name ne 'uninitialized_var')
			{
2672 2673 2674 2675 2676 2677
				WARN("externs should be avoided in .c files\n" .  $herecurr);
			}

			if ($paren_space =~ /\n/) {
				WARN("arguments for function declarations should follow identifier\n" . $herecurr);
			}
2678 2679 2680 2681 2682

		} elsif ($realfile =~ /\.c$/ && defined $stat &&
		    $stat =~ /^.\s*extern\s+/)
		{
			WARN("externs should be avoided in .c files\n" .  $herecurr);
2683 2684 2685 2686 2687 2688 2689 2690 2691
		}

# 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);
			}
2692
		}
2693 2694 2695 2696 2697

# check for pointless casting of kmalloc return
		if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
			WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
		}
2698 2699 2700 2701 2702

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

# check for semaphores used as mutexes
2705
		if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
2706 2707 2708
			WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
		}
# check for semaphores used as mutexes
2709
		if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
2710
			WARN("consider using a completion\n" . $herecurr);
2711

2712 2713 2714 2715 2716
		}
# recommend strict_strto* over simple_strto*
		if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
			WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
		}
2717 2718 2719 2720
# check for __initcall(), use device_initcall() explicitly please
		if ($line =~ /^.\s*__initcall\s*\(/) {
			WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
		}
2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758
# 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;
2759
		if ($line !~ /\bconst\b/ &&
2760
		    $line =~ /\bstruct\s+($struct_ops)\b/) {
2761 2762
			WARN("struct $1 should normally be const\n" .
				$herecurr);
2763
		}
2764 2765 2766 2767

# 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/ &&
2768 2769
		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
2770 2771 2772
		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
2773 2774 2775
		{
			WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
		}
2776 2777 2778 2779 2780

# check for %L{u,d,i} in strings
		my $string;
		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
			$string = substr($rawline, $-[1], $+[1] - $-[1]);
2781
			$string =~ s/%%/__/g;
2782 2783 2784 2785 2786
			if ($string =~ /(?<!%)%L[udi]/) {
				WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
				last;
			}
		}
2787 2788 2789 2790 2791

# whine mightly about in_atomic
		if ($line =~ /\bin_atomic\s*\(/) {
			if ($realfile =~ m@^drivers/@) {
				ERROR("do not use in_atomic in drivers\n" . $herecurr);
2792
			} elsif ($realfile !~ m@^kernel/@) {
2793 2794 2795
				WARN("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
			}
		}
2796 2797 2798 2799 2800 2801 2802 2803 2804 2805

# 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);
			}
		}
2806 2807 2808 2809 2810 2811
	}

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

2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826
	# 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) {
2827
		ERROR("Does not appear to be a unified-diff format patch\n");
2828 2829
	}
	if ($is_patch && $chk_signoff && $signoff == 0) {
2830
		ERROR("Missing Signed-off-by: line(s)\n");
2831 2832
	}

2833
	print report_dump();
2834 2835
	if ($summary && !($clean == 1 && $quiet == 1)) {
		print "$filename " if ($summary_file);
2836 2837 2838 2839
		print "total: $cnt_error errors, $cnt_warn warnings, " .
			(($check)? "$cnt_chk checks, " : "") .
			"$cnt_lines lines checked\n";
		print "\n" if ($quiet == 0);
2840
	}
2841

2842
	if ($clean == 1 && $quiet == 0) {
2843
		print "$vname has no obvious style problems and is ready for submission.\n"
2844 2845
	}
	if ($clean == 0 && $quiet == 0) {
2846
		print "$vname has style problems, please review.  If any of these errors\n";
2847 2848 2849
		print "are false positives report them to the maintainer, see\n";
		print "CHECKPATCH in MAINTAINERS.\n";
	}
2850

2851 2852
	return $clean;
}