checkpatch.pl 99.7 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

13
my $V = '0.32';
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 $show_types = 0;
30
my $root;
31
my %debug;
32 33
my %ignore_type = ();
my @ignore = ();
34
my $help = 0;
35
my $configuration_file = ".checkpatch.conf";
36
my $max_line_length = 80;
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53

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
54
  --ignore TYPE(,TYPE2...)   ignore various comma separated message types
55
  --max-line-length=n        set the maximum line length, if exceeded, warn
56
  --show-types               show the message "types" in the output
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
  --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);
}

74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
my $conf = which_conf($configuration_file);
if (-f $conf) {
	my @conf_args;
	open(my $conffile, '<', "$conf")
	    or warn "$P: Can't find a readable $configuration_file file $!\n";

	while (<$conffile>) {
		my $line = $_;

		$line =~ s/\s*\n?$//g;
		$line =~ s/^\s*//g;
		$line =~ s/\s+/ /g;

		next if ($line =~ m/^\s*#/);
		next if ($line =~ m/^\s*$/);

		my @words = split(" ", $line);
		foreach my $word (@words) {
			last if ($word =~ m/^#/);
			push (@conf_args, $word);
		}
	}
	close($conffile);
	unshift(@ARGV, @conf_args) if @conf_args;
}

100
GetOptions(
101
	'q|quiet+'	=> \$quiet,
102 103 104
	'tree!'		=> \$tree,
	'signoff!'	=> \$chk_signoff,
	'patch!'	=> \$chk_patch,
105
	'emacs!'	=> \$emacs,
106
	'terse!'	=> \$terse,
107
	'f|file!'	=> \$file,
108 109
	'subjective!'	=> \$check,
	'strict!'	=> \$check,
110 111
	'ignore=s'	=> \@ignore,
	'show-types!'	=> \$show_types,
112
	'max-line-length=i' => \$max_line_length,
113
	'root=s'	=> \$root,
114 115
	'summary!'	=> \$summary,
	'mailback!'	=> \$mailback,
116 117
	'summary-file!'	=> \$summary_file,

118
	'debug=s'	=> \%debug,
119
	'test-only=s'	=> \$tst_only,
120 121 122 123 124
	'h|help'	=> \$help,
	'version'	=> \$help
) or help(1);

help(0) if ($help);
125 126 127 128

my $exit = 0;

if ($#ARGV < 0) {
129
	print "$P: no input files\n";
130 131 132
	exit(1);
}

133 134 135 136 137 138 139 140 141 142 143 144 145
@ignore = split(/,/, join(',',@ignore));
foreach my $word (@ignore) {
	$word =~ s/\s*\n?$//g;
	$word =~ s/^\s*//g;
	$word =~ s/\s+/ /g;
	$word =~ tr/[a-z]/[A-Z]/;

	next if ($word =~ m/^\s*#/);
	next if ($word =~ m/^\s*$/);

	$ignore_type{$word}++;
}

146 147
my $dbg_values = 0;
my $dbg_possible = 0;
148
my $dbg_type = 0;
149
my $dbg_attr = 0;
150
for my $key (keys %debug) {
151 152 153
	## no critic
	eval "\${dbg_$key} = '$debug{$key}';";
	die "$@" if ($@);
154 155
}

156 157
my $rpt_cleaners = 0;

158 159 160 161 162
if ($terse) {
	$emacs = 1;
	$quiet++;
}

163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
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);
	}
181 182
}

183 184
my $emitted_corrupt = 0;

185 186 187 188
our $Ident	= qr{
			[A-Za-z_][A-Za-z\d_]*
			(?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
		}x;
189 190 191 192 193 194 195 196
our $Storage	= qr{extern|static|asmlinkage};
our $Sparse	= qr{
			__user|
			__kernel|
			__force|
			__iomem|
			__must_check|
			__init_refok|
197
			__kprobes|
198 199
			__ref|
			__rcu
200
		}x;
201 202 203

# Notes to $Attribute:
# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
204 205
our $Attribute	= qr{
			const|
206 207 208 209 210 211 212 213 214 215 216 217 218 219
			__percpu|
			__nocast|
			__safe|
			__bitwise__|
			__packed__|
			__packed2__|
			__naked|
			__maybe_unused|
			__always_unused|
			__noreturn|
			__used|
			__cold|
			__noclone|
			__deprecated|
220 221
			__read_mostly|
			__kprobes|
222
			__(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
223 224
			____cacheline_aligned|
			____cacheline_aligned_in_smp|
225 226
			____cacheline_internodealigned_in_smp|
			__weak
227
		  }x;
228
our $Modifier;
229 230 231 232
our $Inline	= qr{inline|__always_inline|noinline};
our $Member	= qr{->$Ident|\.$Ident|\[[^]]*\]};
our $Lval	= qr{$Ident(?:$Member)*};

233 234 235 236 237
our $Float_hex	= qr{(?i:0x[0-9a-f]+p-?[0-9]+[fl]?)};
our $Float_dec	= qr{(?i:((?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?))};
our $Float_int	= qr{(?i:[0-9]+e-?[0-9]+[fl]?)};
our $Float	= qr{$Float_hex|$Float_dec|$Float_int};
our $Constant	= qr{(?:$Float|(?i:(?:0x[0-9a-f]+|[0-9]+)[ul]*))};
238
our $Assignment	= qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
239
our $Compare    = qr{<=|>=|==|!=|<|>};
240 241 242
our $Operators	= qr{
			<=|>=|==|!=|
			=>|->|<<|>>|<|>|!|~|
243
			&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
244 245
		  }x;

246 247 248 249
our $NonptrType;
our $Type;
our $Declare;

250 251
our $NON_ASCII_UTF8	= qr{
	[\xC2-\xDF][\x80-\xBF]               # non-overlong 2-byte
252 253 254 255 256 257 258 259
	|  \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;

260 261 262 263 264
our $UTF8	= qr{
	[\x09\x0A\x0D\x20-\x7E]              # ASCII
	| $NON_ASCII_UTF8
}x;

265
our $typeTypedefs = qr{(?x:
266
	(?:__)?(?:u|s|be|le)(?:8|16|32|64)|
267 268 269
	atomic_t
)};

270
our $logFunctions = qr{(?x:
271 272 273
	printk(?:_ratelimited|_once|)|
	[a-z0-9]+_(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
	WARN(?:_RATELIMIT|_ONCE|)|
274 275
	panic|
	MODULE_[A-Z_]+
276 277
)};

278 279 280 281 282 283 284 285 286 287
our $signature_tags = qr{(?xi:
	Signed-off-by:|
	Acked-by:|
	Tested-by:|
	Reviewed-by:|
	Reported-by:|
	To:|
	Cc:
)};

288 289
our @typeList = (
	qr{void},
290 291 292 293 294 295 296
	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},
297 298 299 300 301 302 303 304 305 306 307
	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},
);
308 309 310
our @modifierList = (
	qr{fastcall},
);
311

312 313 314 315 316 317
our $allowed_asm_includes = qr{(?x:
	irq|
	memory
)};
# memory.h: ARM has a custom one

318
sub build_types {
319 320
	my $mods = "(?x:  \n" . join("|\n  ", @modifierList) . "\n)";
	my $all = "(?x:  \n" . join("|\n  ", @typeList) . "\n)";
321
	$Modifier	= qr{(?:$Attribute|$Sparse|$mods)};
322
	$NonptrType	= qr{
323
			(?:$Modifier\s+|const\s+)*
324
			(?:
325
				(?:typeof|__typeof__)\s*\([^\)]*\)|
326
				(?:$typeTypedefs\b)|
327
				(?:${all}\b)
328
			)
329
			(?:\s+$Modifier|\s+const)*
330 331
		  }x;
	$Type	= qr{
332
			$NonptrType
333
			(?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)?
334
			(?:\s+$Inline|\s+$Modifier)*
335 336 337 338
		  }x;
	$Declare	= qr{(?:$Storage\s+)?$Type};
}
build_types();
339

340 341

our $Typecast	= qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
342 343 344 345 346 347 348

# Using $balanced_parens, $LvalOrFunc, or $FuncArg
# requires at least perl version v5.10.0
# Any use must be runtime checked with $^V

our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
our $LvalOrFunc	= qr{($Lval)\s*($balanced_parens{0,1})\s*};
349
our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
350 351 352 353 354 355 356 357 358 359

sub deparenthesize {
	my ($string) = @_;
	return "" if (!defined($string));
	$string =~ s@^\s*\(\s*@@g;
	$string =~ s@\s*\)\s*$@@g;
	$string =~ s@\s+@ @g;
	return $string;
}

360 361
$chk_signoff = 0 if ($file);

362
my @rawlines = ();
363 364
my @lines = ();
my $vname;
365
for my $filename (@ARGV) {
366
	my $FILE;
367
	if ($file) {
368
		open($FILE, '-|', "diff -u /dev/null $filename") ||
369
			die "$P: $filename: diff failed - $!\n";
370 371
	} elsif ($filename eq '-') {
		open($FILE, '<&STDIN');
372
	} else {
373
		open($FILE, '<', "$filename") ||
374
			die "$P: $filename: open failed - $!\n";
375
	}
376 377 378 379 380
	if ($filename eq '-') {
		$vname = 'Your patch';
	} else {
		$vname = $filename;
	}
381
	while (<$FILE>) {
382 383 384
		chomp;
		push(@rawlines, $_);
	}
385
	close($FILE);
386
	if (!process($filename)) {
387 388 389
		$exit = 1;
	}
	@rawlines = ();
390
	@lines = ();
391 392 393 394 395
}

exit($exit);

sub top_of_kernel_tree {
396 397 398 399 400 401 402 403 404 405 406 407
	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;
		}
408
	}
409
	return 1;
410
}
411

412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
sub parse_email {
	my ($formatted_email) = @_;

	my $name = "";
	my $address = "";
	my $comment = "";

	if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
		$name = $1;
		$address = $2;
		$comment = $3 if defined $3;
	} elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
		$address = $1;
		$comment = $2 if defined $2;
	} elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
		$address = $1;
		$comment = $2 if defined $2;
		$formatted_email =~ s/$address.*$//;
		$name = $formatted_email;
		$name =~ s/^\s+|\s+$//g;
		$name =~ s/^\"|\"$//g;
		# If there's a name left after stripping spaces and
		# leading quotes, and the address doesn't have both
		# leading and trailing angle brackets, the address
		# is invalid. ie:
		#   "joe smith joe@smith.com" bad
		#   "joe smith <joe@smith.com" bad
		if ($name ne "" && $address !~ /^<[^>]+>$/) {
			$name = "";
			$address = "";
			$comment = "";
		}
	}

	$name =~ s/^\s+|\s+$//g;
	$name =~ s/^\"|\"$//g;
	$address =~ s/^\s+|\s+$//g;
	$address =~ s/^\<|\>$//g;

	if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
		$name =~ s/(?<!\\)"/\\"/g; ##escape quotes
		$name = "\"$name\"";
	}

	return ($name, $address, $comment);
}

sub format_email {
	my ($name, $address) = @_;

	my $formatted_email;

	$name =~ s/^\s+|\s+$//g;
	$name =~ s/^\"|\"$//g;
	$address =~ s/^\s+|\s+$//g;

	if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
		$name =~ s/(?<!\\)"/\\"/g; ##escape quotes
		$name = "\"$name\"";
	}

	if ("$name" eq "") {
		$formatted_email = "$address";
	} else {
		$formatted_email = "$name <$address>";
	}

	return $formatted_email;
}

482 483 484 485 486 487 488 489 490 491 492 493
sub which_conf {
	my ($conf) = @_;

	foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
		if (-e "$path/$conf") {
			return "$path/$conf";
		}
	}

	return "";
}

494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
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;
}
514
sub copy_spacing {
515
	(my $res = shift) =~ tr/\t/ /c;
516 517
	return $res;
}
518

519 520 521 522 523 524 525 526 527 528 529 530 531
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));
}

532 533 534 535 536 537 538 539 540 541 542
my $sanitise_quote = '';

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

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
543 544 545 546 547 548
sub sanitise_line {
	my ($line) = @_;

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

549
	my $qlen = 0;
550 551
	my $off = 0;
	my $c;
552

553 554 555 556 557 558 559 560 561 562 563 564 565 566
	# 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;
567
		}
568
		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
569 570 571 572
			$sanitise_quote = '';
			substr($res, $off, 2, "$;$;");
			$off++;
			next;
573
		}
574 575 576 577 578 579 580
		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
			$sanitise_quote = '//';

			substr($res, $off, 2, $sanitise_quote);
			$off++;
			next;
		}
581 582 583 584 585 586 587

		# 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;
588
		}
589 590 591 592
		# Regular quotes.
		if ($c eq "'" || $c eq '"') {
			if ($sanitise_quote eq '') {
				$sanitise_quote = $c;
593

594 595 596 597 598 599
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
600

601
		#print "c<$c> SQ<$sanitise_quote>\n";
602 603
		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
			substr($res, $off, 1, $;);
604 605
		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
			substr($res, $off, 1, $;);
606 607 608 609 610
		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
			substr($res, $off, 1, 'X');
		} else {
			substr($res, $off, 1, $c);
		}
611 612
	}

613 614 615 616
	if ($sanitise_quote eq '//') {
		$sanitise_quote = '';
	}

617
	# The pathname on a #include may be surrounded by '<' and '>'.
618
	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
619 620 621 622
		my $clean = 'X' x length($1);
		$res =~ s@\<.*\>@<$clean>@;

	# The whole of a #error is a string.
623
	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
624
		my $clean = 'X' x length($1);
625
		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
626 627
	}

628 629 630
	return $res;
}

631 632 633 634 635 636
sub ctx_statement_block {
	my ($linenr, $remain, $off) = @_;
	my $line = $linenr - 1;
	my $blk = '';
	my $soff = $off;
	my $coff = $off - 1;
637
	my $coff_set = 0;
638

639 640
	my $loff = 0;

641 642
	my $type = '';
	my $level = 0;
643
	my @stack = ();
644
	my $p;
645 646
	my $c;
	my $len = 0;
647 648

	my $remainder;
649
	while (1) {
650 651
		@stack = (['', 0]) if ($#stack == -1);

652
		#warn "CSB: blk<$blk> remain<$remain>\n";
653 654 655 656
		# If we are about to drop off the end, pull in more
		# context.
		if ($off >= $len) {
			for (; $remain > 0; $line++) {
657
				last if (!defined $lines[$line]);
658
				next if ($lines[$line] =~ /^-/);
659
				$remain--;
660
				$loff = $len;
661
				$blk .= $lines[$line] . "\n";
662 663 664 665 666 667
				$len = length($blk);
				$line++;
				last;
			}
			# Bail if there is no further context.
			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
668
			if ($off >= $len) {
669 670
				last;
			}
671 672 673 674
			if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
				$level++;
				$type = '#';
			}
675
		}
676
		$p = $c;
677
		$c = substr($blk, $off, 1);
678
		$remainder = substr($blk, $off);
679

680
		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
681 682 683 684 685 686 687 688 689 690

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

691 692 693 694 695 696
		# Statement ends at the ';' or a close '}' at the
		# outermost level.
		if ($level == 0 && $c eq ';') {
			last;
		}

697
		# An else is really a conditional as long as its not else if
698 699 700 701 702 703 704 705
		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";
706 707
		}

708 709 710 711 712 713 714 715 716 717
		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;
718 719
				$coff_set = 1;
				#warn "CSB: mark coff<$coff>\n";
720 721 722 723 724 725 726 727 728 729 730
			}
		}
		if (($type eq '' || $type eq '{') && $c eq '{') {
			$level++;
			$type = '{';
		}
		if ($type eq '{' && $c eq '}') {
			$level--;
			$type = ($level != 0)? '{' : '';

			if ($level == 0) {
731 732 733
				if (substr($blk, $off + 1, 1) eq ';') {
					$off++;
				}
734 735 736
				last;
			}
		}
737 738 739 740 741 742 743
		# Preprocessor commands end at the newline unless escaped.
		if ($type eq '#' && $c eq "\n" && $p ne "\\") {
			$level--;
			$type = '';
			$off++;
			last;
		}
744 745
		$off++;
	}
746
	# We are truly at the end, so shuffle to the next line.
747
	if ($off == $len) {
748
		$loff = $len + 1;
749 750 751
		$line++;
		$remain--;
	}
752 753 754 755 756 757 758

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

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

759
	#print "coff<$coff> soff<$off> loff<$loff>\n";
760 761 762 763 764

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

765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
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;
	}
}

808 809 810 811 812 813
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

814
	# Grab the first conditional/block pair.
815 816
	($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
817
	#print "F: c<$condition> s<$statement> remain<$remain>\n";
818 819 820 821 822 823 824
	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.
825 826 827
	for (;;) {
		($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
828
		#print "C: c<$condition> s<$statement> remain<$remain>\n";
829
		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
830 831
		#print "C: push\n";
		push(@chunks, [ $condition, $statement ]);
832 833 834
	}

	return ($level, $linenr, @chunks);
835 836
}

837
sub ctx_block_get {
838
	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
839 840 841 842 843 844 845
	my $line;
	my $start = $linenr - 1;
	my $blk = '';
	my @o;
	my @c;
	my @res = ();

846
	my $level = 0;
847
	my @stack = ($level);
848 849 850 851 852
	for ($line = $start; $remain > 0; $line++) {
		next if ($rawlines[$line] =~ /^-/);
		$remain--;

		$blk .= $rawlines[$line];
853 854

		# Handle nested #if/#else.
855
		if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
856
			push(@stack, $level);
857
		} elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
858
			$level = $stack[$#stack - 1];
859
		} elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
860 861 862
			$level = pop(@stack);
		}

863
		foreach my $c (split(//, $lines[$line])) {
864 865 866 867 868
			##print "C<$c>L<$level><$open$close>O<$off>\n";
			if ($off > 0) {
				$off--;
				next;
			}
869

870 871 872 873 874 875 876
			if ($c eq $close && $level > 0) {
				$level--;
				last if ($level == 0);
			} elsif ($c eq $open) {
				$level++;
			}
		}
877

878
		if (!$outer || $level <= 1) {
879
			push(@res, $rawlines[$line]);
880 881
		}

882
		last if ($level == 0);
883 884
	}

885
	return ($level, @res);
886 887 888 889
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

890 891
	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
	return @r;
892 893 894 895
}
sub ctx_block {
	my ($linenr, $remain) = @_;

896 897
	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
	return @r;
898 899
}
sub ctx_statement {
900 901 902 903 904 905
	my ($linenr, $remain, $off) = @_;

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

908
	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
909
}
910 911 912 913 914
sub ctx_statement_level {
	my ($linenr, $remain, $off) = @_;

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
915 916 917 918 919

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

	# Catch a comment on the end of the line itself.
920
	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
921 922 923 924 925 926 927
	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++) {
928 929
		my $line = $rawlines[$linenr - 1];
		#warn "           $line\n";
930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951
		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);

952
	##print "LINE: $rawlines[$end_line - 1 ]\n";
953 954 955 956 957
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973
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;
}

974 975 976
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
977

978 979 980 981 982 983
	$res = '';
	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
		$res .= $1;
		if ($2 ne '') {
			$coded = sprintf("^%c", unpack('C', $2) + 64);
			$res .= $coded;
984 985
		}
	}
986
	$res =~ s/$/\$/;
987

988
	return $res;
989 990
}

991
my $av_preprocessor = 0;
992
my $av_pending;
993
my @av_paren_type;
994
my $av_pend_colon;
995 996 997

sub annotate_reset {
	$av_preprocessor = 0;
998 999
	$av_pending = '_';
	@av_paren_type = ('E');
1000
	$av_pend_colon = 'O';
1001 1002
}

1003 1004
sub annotate_values {
	my ($stream, $type) = @_;
1005

1006
	my $res;
1007
	my $var = '_' x length($stream);
1008 1009
	my $cur = $stream;

1010
	print "$stream\n" if ($dbg_values > 1);
1011 1012

	while (length($cur)) {
1013
		@av_paren_type = ('E') if ($#av_paren_type < 0);
1014
		print " <" . join('', @av_paren_type) .
1015
				"> <$type> <$av_pending>" if ($dbg_values > 1);
1016
		if ($cur =~ /^(\s+)/o) {
1017 1018
			print "WS($1)\n" if ($dbg_values > 1);
			if ($1 =~ /\n/ && $av_preprocessor) {
1019
				$type = pop(@av_paren_type);
1020
				$av_preprocessor = 0;
1021 1022
			}

1023
		} elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1024 1025
			print "CAST($1)\n" if ($dbg_values > 1);
			push(@av_paren_type, $type);
1026
			$type = 'c';
1027

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

1032 1033 1034 1035
		} elsif ($cur =~ /^($Modifier)\s*/) {
			print "MODIFIER($1)\n" if ($dbg_values > 1);
			$type = 'T';

1036
		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1037
			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1038
			$av_preprocessor = 1;
1039 1040 1041 1042 1043 1044
			push(@av_paren_type, $type);
			if ($2 ne '') {
				$av_pending = 'N';
			}
			$type = 'E';

1045
		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1046 1047 1048
			print "UNDEF($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;
			push(@av_paren_type, $type);
1049

1050
		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1051
			print "PRE_START($1)\n" if ($dbg_values > 1);
1052
			$av_preprocessor = 1;
1053 1054 1055

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
1056
			$type = 'E';
1057

1058
		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1059 1060 1061 1062 1063
			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;

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

1064
			$type = 'E';
1065

1066
		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1067 1068 1069 1070 1071 1072 1073 1074
			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);
1075
			$type = 'E';
1076 1077

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

1080 1081 1082 1083 1084
		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
			print "ATTR($1)\n" if ($dbg_values > 1);
			$av_pending = $type;
			$type = 'N';

1085
		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1086
			print "SIZEOF($1)\n" if ($dbg_values > 1);
1087
			if (defined $2) {
1088
				$av_pending = 'V';
1089 1090 1091
			}
			$type = 'N';

1092
		} elsif ($cur =~ /^(if|while|for)\b/o) {
1093
			print "COND($1)\n" if ($dbg_values > 1);
1094
			$av_pending = 'E';
1095 1096
			$type = 'N';

1097 1098 1099 1100 1101
		} elsif ($cur =~/^(case)/o) {
			print "CASE($1)\n" if ($dbg_values > 1);
			$av_pend_colon = 'C';
			$type = 'N';

1102
		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1103
			print "KEYWORD($1)\n" if ($dbg_values > 1);
1104 1105 1106
			$type = 'N';

		} elsif ($cur =~ /^(\()/o) {
1107
			print "PAREN('$1')\n" if ($dbg_values > 1);
1108 1109
			push(@av_paren_type, $av_pending);
			$av_pending = '_';
1110 1111 1112
			$type = 'N';

		} elsif ($cur =~ /^(\))/o) {
1113 1114 1115
			my $new_type = pop(@av_paren_type);
			if ($new_type ne '_') {
				$type = $new_type;
1116 1117
				print "PAREN('$1') -> $type\n"
							if ($dbg_values > 1);
1118
			} else {
1119
				print "PAREN('$1')\n" if ($dbg_values > 1);
1120 1121
			}

1122
		} elsif ($cur =~ /^($Ident)\s*\(/o) {
1123
			print "FUNC($1)\n" if ($dbg_values > 1);
1124
			$type = 'V';
1125
			$av_pending = 'V';
1126

1127 1128
		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
			if (defined $2 && $type eq 'C' || $type eq 'T') {
1129
				$av_pend_colon = 'B';
1130 1131
			} elsif ($type eq 'E') {
				$av_pend_colon = 'L';
1132 1133 1134 1135
			}
			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
			$type = 'V';

1136
		} elsif ($cur =~ /^($Ident|$Constant)/o) {
1137
			print "IDENT($1)\n" if ($dbg_values > 1);
1138 1139 1140
			$type = 'V';

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

1144
		} elsif ($cur =~/^(;|{|})/) {
1145
			print "END($1)\n" if ($dbg_values > 1);
1146
			$type = 'E';
1147 1148
			$av_pend_colon = 'O';

1149 1150 1151 1152
		} elsif ($cur =~/^(,)/) {
			print "COMMA($1)\n" if ($dbg_values > 1);
			$type = 'C';

1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166
		} 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';
1167

1168
		} elsif ($cur =~ /^(\[)/o) {
1169
			print "CLOSE($1)\n" if ($dbg_values > 1);
1170 1171
			$type = 'N';

1172
		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184
			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';

1185
		} elsif ($cur =~ /^($Operators)/o) {
1186
			print "OP($1)\n" if ($dbg_values > 1);
1187 1188 1189 1190 1191
			if ($1 ne '++' && $1 ne '--') {
				$type = 'N';
			}

		} elsif ($cur =~ /(^.)/o) {
1192
			print "C($1)\n" if ($dbg_values > 1);
1193 1194 1195 1196 1197
		}
		if (defined $1) {
			$cur = substr($cur, length($1));
			$res .= $type x length($1);
		}
1198
	}
1199

1200
	return ($res, $var);
1201 1202
}

1203
sub possible {
1204
	my ($possible, $line) = @_;
1205
	my $notPermitted = qr{(?:
1206 1207 1208 1209
		^(?:
			$Modifier|
			$Storage|
			$Type|
1210 1211 1212
			DEFINE_\S+
		)$|
		^(?:
1213 1214 1215 1216 1217
			goto|
			return|
			case|
			else|
			asm|__asm__|
1218 1219 1220
			do|
			\#|
			\#\#|
1221
		)(?:\s|$)|
1222
		^(?:typedef|struct|enum)\b
1223 1224 1225
	    )}x;
	warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
	if ($possible !~ $notPermitted) {
1226 1227 1228 1229 1230 1231 1232
		# 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;
1233
			for my $modifier (split(' ', $possible)) {
1234 1235 1236 1237
				if ($modifier !~ $notPermitted) {
					warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
					push(@modifierList, $modifier);
				}
1238
			}
1239 1240 1241 1242 1243

		} else {
			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
			push(@typeList, $possible);
		}
1244
		build_types();
1245 1246
	} else {
		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1247 1248 1249
	}
}

1250 1251
my $prefix = '';

1252 1253 1254 1255
sub show_type {
       return !defined $ignore_type{$_[0]};
}

1256
sub report {
1257 1258
	if (!show_type($_[1]) ||
	    (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
1259 1260
		return 0;
	}
1261 1262 1263 1264 1265 1266
	my $line;
	if ($show_types) {
		$line = "$prefix$_[0]:$_[1]: $_[2]\n";
	} else {
		$line = "$prefix$_[0]: $_[2]\n";
	}
1267 1268
	$line = (split('\n', $line))[0] . "\n" if ($terse);

1269
	push(our @report, $line);
1270 1271

	return 1;
1272 1273
}
sub report_dump {
1274
	our @report;
1275
}
1276

1277
sub ERROR {
1278
	if (report("ERROR", $_[0], $_[1])) {
1279 1280 1281
		our $clean = 0;
		our $cnt_error++;
	}
1282 1283
}
sub WARN {
1284
	if (report("WARNING", $_[0], $_[1])) {
1285 1286 1287
		our $clean = 0;
		our $cnt_warn++;
	}
1288 1289
}
sub CHK {
1290
	if ($check && report("CHECK", $_[0], $_[1])) {
1291 1292 1293
		our $clean = 0;
		our $cnt_chk++;
	}
1294 1295
}

1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318
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 ".../") {
1319 1320
		WARN("USE_RELATIVE_PATH",
		     "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1321 1322 1323
	}
}

1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353
sub pos_last_openparen {
	my ($line) = @_;

	my $pos = 0;

	my $opens = $line =~ tr/\(/\(/;
	my $closes = $line =~ tr/\)/\)/;

	my $last_openparen = 0;

	if (($opens == 0) || ($closes >= $opens)) {
		return -1;
	}

	my $len = length($line);

	for ($pos = 0; $pos < $len; $pos++) {
		my $string = substr($line, $pos);
		if ($string =~ /^($FuncArg|$balanced_parens)/) {
			$pos += length($1) - 1;
		} elsif (substr($line, $pos, 1) eq '(') {
			$last_openparen = $pos;
		} elsif (index($string, '(') == -1) {
			last;
		}
	}

	return $last_openparen + 1;
}

1354 1355 1356 1357 1358
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
1359
	my $prevrawline="";
1360
	my $stashline="";
1361
	my $stashrawline="";
1362

1363
	my $length;
1364 1365 1366 1367
	my $indent;
	my $previndent=0;
	my $stashindent=0;

1368
	our $clean = 1;
1369 1370 1371
	my $signoff = 0;
	my $is_patch = 0;

1372 1373 1374
	my $in_header_lines = 1;
	my $in_commit_log = 0;		#Scanning lines before patch

1375 1376
	my $non_utf8_charset = 0;

1377
	our @report = ();
1378 1379 1380 1381 1382
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

1383 1384 1385 1386 1387 1388
	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
	my $in_comment = 0;
1389
	my $comment_edge = 0;
1390
	my $first_line = 0;
1391
	my $p1_prefix = '';
1392

1393 1394 1395
	my $prev_values = 'E';

	# suppression flags
1396
	my %suppress_ifbraces;
1397
	my %suppress_whiletrailers;
1398
	my %suppress_export;
1399
	my $suppress_statement = 0;
1400

1401 1402
	my %camelcase = ();

1403
	# Pre-scan the patch sanitizing the lines.
1404
	# Pre-scan the patch looking for any __setup documentation.
1405
	#
1406 1407
	my @setup_docs = ();
	my $setup_docs = 0;
1408 1409

	sanitise_line_reset();
1410 1411
	my $line;
	foreach my $rawline (@rawlines) {
1412 1413
		$linenr++;
		$line = $rawline;
1414

1415
		if ($rawline=~/^\+\+\+\s+(\S+)/) {
1416 1417 1418 1419
			$setup_docs = 0;
			if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
				$setup_docs = 1;
			}
1420 1421 1422 1423 1424 1425 1426 1427 1428
			#next;
		}
		if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1429
			$in_comment = 0;
1430 1431 1432 1433 1434 1435

			# 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;
1436 1437 1438 1439 1440 1441
			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";
1442
				last if (!defined $rawlines[$ln - 1]);
1443 1444 1445 1446 1447
				if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
				    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
					($edge) = $1;
					last;
				}
1448 1449 1450 1451 1452 1453 1454 1455 1456
			}
			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 &&
1457
			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1458 1459 1460 1461 1462 1463 1464
			{
				$in_comment = 1;
			}

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

1465
		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1466
			# Standardise the strings and chars within the input to
1467
			# simplify matching -- only bother with positive lines.
1468
			$line = sanitise_line($rawline);
1469
		}
1470 1471 1472 1473 1474 1475 1476 1477 1478 1479
		push(@lines, $line);

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

		#print "==>$rawline\n";
		#print "-->$line\n";
1480 1481 1482 1483 1484 1485

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

1486 1487
	$prefix = '';

1488 1489
	$realcnt = 0;
	$linenr = 0;
1490 1491 1492
	foreach my $line (@lines) {
		$linenr++;

1493
		my $rawline = $rawlines[$linenr - 1];
1494

1495
#extract the line range in the file after the patch is applied
1496
		if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1497
			$is_patch = 1;
1498
			$first_line = $linenr + 1;
1499 1500 1501 1502 1503 1504
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1505
			annotate_reset();
1506 1507
			$prev_values = 'E';

1508
			%suppress_ifbraces = ();
1509
			%suppress_whiletrailers = ();
1510
			%suppress_export = ();
1511
			$suppress_statement = 0;
1512 1513
			next;

1514 1515 1516
# 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.
1517
		} elsif ($line =~ /^( |\+|$)/) {
1518
			$realline++;
1519
			$realcnt-- if ($realcnt != 0);
1520

1521
			# Measure the line length and indent.
1522
			($length, $indent) = line_stats($rawline);
1523 1524 1525 1526

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

1529
			#warn "line<$line>\n";
1530

1531 1532
		} elsif ($realcnt == 1) {
			$realcnt--;
1533 1534
		}

1535 1536
		my $hunk_line = ($realcnt != 0);

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

1541 1542
		$here = "#$linenr: " if (!$file);
		$here = "#$realline: " if ($file);
1543 1544

		# extract the filename as it passes
1545 1546 1547
		if ($line =~ /^diff --git.*?(\S+)$/) {
			$realfile = $1;
			$realfile =~ s@^([^/]*)/@@;
1548
			$in_commit_log = 0;
1549
		} elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1550
			$realfile = $1;
1551
			$realfile =~ s@^([^/]*)/@@;
1552
			$in_commit_log = 0;
1553 1554

			$p1_prefix = $1;
1555 1556
			if (!$file && $tree && $p1_prefix ne '' &&
			    -e "$root/$p1_prefix") {
1557 1558
				WARN("PATCH_PREFIX",
				     "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1559
			}
1560

1561
			if ($realfile =~ m@^include/asm/@) {
1562 1563
				ERROR("MODIFIED_INCLUDE_ASM",
				      "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1564 1565 1566 1567
			}
			next;
		}

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

1570 1571 1572
		my $hereline = "$here\n$rawline\n";
		my $herecurr = "$here\n$rawline\n";
		my $hereprev = "$here\n$prevrawline\n$rawline\n";
1573

1574 1575
		$cnt_lines++ if ($realcnt != 0);

1576 1577 1578 1579
# 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)$/) {
1580 1581
				ERROR("EXECUTE_PERMISSIONS",
				      "do not set execute permissions for source files\n" . $permhere);
1582 1583 1584
			}
		}

1585
# Check the patch for a signoff:
1586
		if ($line =~ /^\s*signed-off-by:/i) {
1587
			$signoff++;
1588
			$in_commit_log = 0;
1589 1590 1591
		}

# Check signature styles
1592
		if (!$in_header_lines &&
1593
		    $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
1594 1595 1596 1597 1598 1599
			my $space_before = $1;
			my $sign_off = $2;
			my $space_after = $3;
			my $email = $4;
			my $ucfirst_sign_off = ucfirst(lc($sign_off));

1600 1601 1602 1603
			if ($sign_off !~ /$signature_tags/) {
				WARN("BAD_SIGN_OFF",
				     "Non-standard signature: $sign_off\n" . $herecurr);
			}
1604
			if (defined $space_before && $space_before ne "") {
1605 1606
				WARN("BAD_SIGN_OFF",
				     "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr);
1607 1608
			}
			if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
1609 1610
				WARN("BAD_SIGN_OFF",
				     "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr);
1611 1612
			}
			if (!defined $space_after || $space_after ne " ") {
1613 1614
				WARN("BAD_SIGN_OFF",
				     "Use a single space after $ucfirst_sign_off\n" . $herecurr);
1615
			}
1616 1617 1618 1619

			my ($email_name, $email_address, $comment) = parse_email($email);
			my $suggested_email = format_email(($email_name, $email_address));
			if ($suggested_email eq "") {
1620 1621
				ERROR("BAD_SIGN_OFF",
				      "Unrecognized email address: '$email'\n" . $herecurr);
1622 1623 1624 1625 1626 1627 1628 1629 1630
			} else {
				my $dequoted = $suggested_email;
				$dequoted =~ s/^"//;
				$dequoted =~ s/" </ </;
				# Don't force email to have quotes
				# Allow just an angle bracketed address
				if ("$dequoted$comment" ne $email &&
				    "<$email_address>$comment" ne $email &&
				    "$suggested_email$comment" ne $email) {
1631 1632
					WARN("BAD_SIGN_OFF",
					     "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
1633
				}
1634 1635 1636
			}
		}

1637
# Check for wrappage within a valid hunk of the file
1638
		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1639 1640
			ERROR("CORRUPTED_PATCH",
			      "patch seems to be corrupt (line wrapped?)\n" .
1641
				$herecurr) if (!$emitted_corrupt++);
1642 1643
		}

1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657
# 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);
				}
			}
		}

1658 1659
# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1660 1661 1662 1663 1664 1665 1666
		    $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";

1667 1668
			CHK("INVALID_UTF8",
			    "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1669 1670
		}

1671 1672 1673
# Check if it's the start of a commit log
# (not a header line and we haven't seen the patch filename)
		if ($in_header_lines && $realfile =~ /^$/ &&
1674
		    $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
1675 1676 1677 1678
			$in_header_lines = 0;
			$in_commit_log = 1;
		}

1679 1680 1681 1682 1683 1684 1685 1686 1687
# Check if there is UTF-8 in a commit log when a mail header has explicitly
# declined it, i.e defined some charset where it is missing.
		if ($in_header_lines &&
		    $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
		    $1 !~ /utf-8/i) {
			$non_utf8_charset = 1;
		}

		if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
1688
		    $rawline =~ /$NON_ASCII_UTF8/) {
1689
			WARN("UTF8_BEFORE_PATCH",
1690 1691 1692
			    "8-bit UTF-8 used in possible commit log\n" . $herecurr);
		}

1693 1694
# ignore non-hunk lines and lines being removed
		next if (!$hunk_line || $line =~ /^-/);
1695 1696

#trailing whitespace
1697
		if ($line =~ /^\+.*\015/) {
1698
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1699 1700
			ERROR("DOS_LINE_ENDINGS",
			      "DOS line endings\n" . $herevet);
1701

1702 1703
		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1704 1705
			ERROR("TRAILING_WHITESPACE",
			      "trailing whitespace\n" . $herevet);
1706
			$rpt_cleaners = 1;
1707
		}
1708

1709
# check for Kconfig help text having a real description
1710 1711
# Only applies when adding the entry originally, after that we do not have
# sufficient context to determine whether it is indeed long enough.
1712
		if ($realfile =~ /Kconfig/ &&
1713
		    $line =~ /.\s*config\s+/) {
1714
			my $length = 0;
1715 1716 1717
			my $cnt = $realcnt;
			my $ln = $linenr + 1;
			my $f;
1718
			my $is_start = 0;
1719
			my $is_end = 0;
1720
			for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
1721 1722 1723 1724 1725
				$f = $lines[$ln - 1];
				$cnt-- if ($lines[$ln - 1] !~ /^-/);
				$is_end = $lines[$ln - 1] =~ /^\+/;

				next if ($f =~ /^-/);
1726 1727 1728 1729 1730 1731 1732

				if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
					$is_start = 1;
				} elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
					$length = -1;
				}

1733
				$f =~ s/^.//;
1734 1735 1736
				$f =~ s/#.*//;
				$f =~ s/^\s+//;
				next if ($f =~ /^$/);
1737 1738 1739 1740
				if ($f =~ /^\s*config\s/) {
					$is_end = 1;
					last;
				}
1741 1742
				$length++;
			}
1743
			WARN("CONFIG_DESCRIPTION",
1744 1745
			     "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
			#print "is_start<$is_start> is_end<$is_end> length<$length>\n";
1746 1747
		}

1748 1749 1750 1751 1752 1753 1754
# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
		if ($realfile =~ /Kconfig/ &&
		    $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
			WARN("CONFIG_EXPERIMENTAL",
			     "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
		}

1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768
		if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
		    ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
			my $flag = $1;
			my $replacement = {
				'EXTRA_AFLAGS' =>   'asflags-y',
				'EXTRA_CFLAGS' =>   'ccflags-y',
				'EXTRA_CPPFLAGS' => 'cppflags-y',
				'EXTRA_LDFLAGS' =>  'ldflags-y',
			};

			WARN("DEPRECATED_VARIABLE",
			     "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
		}

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

1772
#line length limit
1773
		if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1774
		    $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1775
		    !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
1776
		    $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
1777
		    $length > $max_line_length)
1778
		{
1779
			WARN("LONG_LINE",
1780
			     "line over $max_line_length characters\n" . $herecurr);
1781 1782
		}

1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797
# Check for user-visible strings broken across lines, which breaks the ability
# to grep for the string.  Limited to strings used as parameters (those
# following an open parenthesis), which almost completely eliminates false
# positives, as well as warning only once per parameter rather than once per
# line of the string.  Make an exception when the previous string ends in a
# newline (multiple lines in one string constant) or \n\t (common in inline
# assembly to indent the instruction on the following line).
		if ($line =~ /^\+\s*"/ &&
		    $prevline =~ /"\s*$/ &&
		    $prevline =~ /\(/ &&
		    $prevrawline !~ /\\n(?:\\t)*"\s*$/) {
			WARN("SPLIT_STRING",
			     "quoted string split across lines\n" . $hereprev);
		}

1798 1799
# check for spaces before a quoted newline
		if ($rawline =~ /^.*\".*\s\\n/) {
1800 1801
			WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
			     "unnecessary whitespace before a quoted newline\n" . $herecurr);
1802 1803
		}

1804 1805
# check for adding lines without a newline.
		if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1806 1807
			WARN("MISSING_EOF_NEWLINE",
			     "adding a line without newline at end of file\n" . $herecurr);
1808 1809
		}

1810 1811 1812 1813
# 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";
1814 1815
				ERROR("LO_MACRO",
				      "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
1816 1817 1818
			}
			if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
				my $herevet = "$here\n" . cat_vet($line) . "\n";
1819 1820
				ERROR("HI_MACRO",
				      "use the HI() macro, not (... >> 16)\n" . $herevet);
1821 1822 1823
			}
		}

1824 1825
# check we are in a valid source file C or perl if not then ignore this hunk
		next if ($realfile !~ /\.(h|c|pl)$/);
1826 1827 1828

# at the beginning of a line any tabs must come first and anything
# more than 8 must use tabs.
1829 1830 1831
		if ($rawline =~ /^\+\s* \t\s*\S/ ||
		    $rawline =~ /^\+\s*        \s*/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1832 1833
			ERROR("CODE_INDENT",
			      "code indent should use tabs where possible\n" . $herevet);
1834
			$rpt_cleaners = 1;
1835 1836
		}

1837 1838 1839
# check for space before tabs.
		if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1840 1841
			WARN("SPACE_BEFORE_TAB",
			     "please, no space before tabs\n" . $herevet);
1842 1843
		}

1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858
# check for && or || at the start of a line
		if ($rawline =~ /^\+\s*(&&|\|\|)/) {
			CHK("LOGICAL_CONTINUATIONS",
			    "Logical continuations should be on the previous line\n" . $hereprev);
		}

# check multi-line statement indentation matches previous line
		if ($^V && $^V ge 5.10.0 &&
		    $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) {
			$prevline =~ /^\+(\t*)(.*)$/;
			my $oldindent = $1;
			my $rest = $2;

			my $pos = pos_last_openparen($rest);
			if ($pos >= 0) {
J
Joe Perches 已提交
1859 1860
				$line =~ /^(\+| )([ \t]*)/;
				my $newindent = $2;
1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874

				my $goodtabindent = $oldindent .
					"\t" x ($pos / 8) .
					" "  x ($pos % 8);
				my $goodspaceindent = $oldindent . " "  x $pos;

				if ($newindent ne $goodtabindent &&
				    $newindent ne $goodspaceindent) {
					CHK("PARENTHESIS_ALIGNMENT",
					    "Alignment should match open parenthesis\n" . $hereprev);
				}
			}
		}

1875 1876 1877 1878 1879
		if ($line =~ /^\+.*\*[ \t]*\)[ \t]+/) {
			CHK("SPACING",
			    "No space is necessary after a cast\n" . $hereprev);
		}

1880 1881 1882 1883 1884 1885 1886 1887
		if ($realfile =~ m@^(drivers/net/|net/)@ &&
		    $rawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
		    $prevrawline =~ /^\+[ \t]*$/) {
			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
			     "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
		}

		if ($realfile =~ m@^(drivers/net/|net/)@ &&
1888 1889 1890 1891
		    $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ &&	#trailing */
		    $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ &&	#inline /*...*/
		    $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ &&	#trailing **/
		    $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) {	#non blank */
1892 1893 1894 1895
			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
			     "networking block comments put the trailing */ on a separate line\n" . $herecurr);
		}

1896
# check for spaces at the beginning of a line.
1897 1898 1899 1900 1901
# Exceptions:
#  1) within comments
#  2) indented preprocessor commands
#  3) hanging labels
		if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/)  {
1902
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1903 1904
			WARN("LEADING_SPACE",
			     "please, no spaces at the start of a line\n" . $herevet);
1905 1906
		}

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

1910 1911 1912 1913 1914 1915
# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
		if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
			WARN("CONFIG_EXPERIMENTAL",
			     "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
		}

1916
# check for RCS/CVS revision markers
1917
		if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1918 1919
			WARN("CVS_KEYWORD",
			     "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1920
		}
1921

1922 1923 1924
# Blackfin: don't use __builtin_bfin_[cs]sync
		if ($line =~ /__builtin_bfin_csync/) {
			my $herevet = "$here\n" . cat_vet($line) . "\n";
1925 1926
			ERROR("CSYNC",
			      "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
1927 1928 1929
		}
		if ($line =~ /__builtin_bfin_ssync/) {
			my $herevet = "$here\n" . cat_vet($line) . "\n";
1930 1931
			ERROR("SSYNC",
			      "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
1932 1933
		}

1934
# Check for potential 'bare' types
1935 1936
		my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
		    $realline_next);
1937 1938 1939
#print "LINE<$line>\n";
		if ($linenr >= $suppress_statement &&
		    $realcnt && $line =~ /.\s*\S/) {
1940
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1941
				ctx_statement_block($linenr, $realcnt, 0);
1942 1943 1944
			$stat =~ s/\n./\n /g;
			$cond =~ s/\n./\n /g;

1945 1946 1947 1948 1949 1950 1951 1952 1953
#print "linenr<$linenr> <$stat>\n";
			# If this statement has no statement boundaries within
			# it there is no point in retrying a statement scan
			# until we hit end of it.
			my $frag = $stat; $frag =~ s/;+\s*$//;
			if ($frag !~ /(?:{|;)/) {
#print "skip<$line_nr_next>\n";
				$suppress_statement = $line_nr_next;
			}
1954

1955 1956 1957 1958 1959 1960 1961 1962
			# 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++;
			}

1963 1964
			my $s = $stat;
			$s =~ s/{.*$//s;
1965

1966
			# Ignore goto labels.
1967
			if ($s =~ /$Ident:\*$/s) {
1968 1969

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

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

1974
			# declarations always start with types
1975
			} 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) {
1976 1977 1978 1979
				my $type = $1;
				$type =~ s/\s+/ /g;
				possible($type, "A:" . $s);

1980
			# definitions in global scope can only start with types
1981
			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
1982
				possible($1, "B:" . $s);
1983
			}
1984 1985

			# any (foo ... *) is a pointer cast, and foo is a type
1986
			while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
1987
				possible($1, "C:" . $s);
1988 1989 1990 1991 1992
			}

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

1996
				my $ctx = $s;
1997
				substr($ctx, 0, $name_len + 1, '');
1998
				$ctx =~ s/\)[^\)]*$//;
1999

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

2003
						possible($1, "D:" . $s);
2004 2005
					}
				}
2006
			}
2007

2008 2009
		}

2010 2011 2012
#
# Checks which may be anchored in the context.
#
2013

2014 2015
# Check for switch () and associated case and default
# statements should be at the same indent.
2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031
		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 '') {
2032 2033
				ERROR("SWITCH_CASE_INDENT_LEVEL",
				      "switch and case should be at the same indent\n$hereline$err");
2034 2035 2036 2037 2038
			}
		}

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

2042
			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2043 2044 2045 2046 2047 2048

			if ($line =~ /^\+\t{6,}/) {
				WARN("DEEP_INDENTATION",
				     "Too many leading tabs - consider code refactoring\n" . $herecurr);
			}

2049 2050 2051
			my $ctx_cnt = $realcnt - $#ctx - 1;
			my $ctx = join("\n", @ctx);

2052 2053
			my $ctx_ln = $linenr;
			my $ctx_skip = $realcnt;
2054

2055 2056 2057 2058 2059
			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] !~ /^-/);
2060 2061
				$ctx_ln++;
			}
2062

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

2066
			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2067 2068
				ERROR("OPEN_BRACE",
				      "that open brace { should be on the previous line\n" .
2069
					"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2070
			}
2071 2072 2073 2074
			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
			    $ctx =~ /\)\s*\;\s*$/ &&
			    defined $lines[$ctx_ln - 1])
			{
2075 2076
				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
				if ($nindent > $indent) {
2077 2078
					WARN("TRAILING_SEMICOLON",
					     "trailing semicolon indicates no statements, indent implies otherwise\n" .
2079
						"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2080 2081
				}
			}
2082 2083
		}

2084 2085
# Check relative indent for conditionals and blocks.
		if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2086 2087 2088
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
2089 2090 2091 2092 2093 2094 2095 2096 2097 2098
			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.
2099 2100
			my @newlines = ($c =~ /\n/gs);
			my $cond_lines = 1 + $#newlines;
2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113

			# 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;
			}
2114
			if ($s =~ s/^\s*?\n//) {
2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125
				$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;
			}

2126
			my $cond_ptr = -1;
2127
			$continuation = 0;
2128 2129 2130
			while ($cond_ptr != $cond_lines) {
				$cond_ptr = $cond_lines;

2131 2132 2133 2134 2135 2136
				# If we see an #else/#elif then the code
				# is not linear.
				if ($s =~ /^\s*\#\s*(?:else|elif)/) {
					$check = 0;
				}

2137 2138 2139 2140
				# Ignore:
				#  1) blank lines, they should be at 0,
				#  2) preprocessor lines, and
				#  3) labels.
2141 2142
				if ($continuation ||
				    $s =~ /^\s*?\n/ ||
2143 2144
				    $s =~ /^\s*#\s*?/ ||
				    $s =~ /^\s*$Ident\s*:/) {
2145
					$continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2146 2147 2148
					if ($s =~ s/^.*?\n//) {
						$cond_lines++;
					}
2149
				}
2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164
			}

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

2165
			#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";
2166 2167 2168

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

2174 2175
		# Track the 'values' across context and added lines.
		my $opline = $line; $opline =~ s/^./ /;
2176 2177
		my ($curr_values, $curr_vars) =
				annotate_values($opline . "\n", $prev_values);
2178
		$curr_values = $prev_values . $curr_values;
2179 2180
		if ($dbg_values) {
			my $outline = $opline; $outline =~ s/\t/ /g;
2181 2182
			print "$linenr > .$outline\n";
			print "$linenr > $curr_values\n";
2183
			print "$linenr >  $curr_vars\n";
2184
		}
2185 2186
		$prev_values = substr($curr_values, -1);

2187 2188 2189
#ignore lines not being added
		if ($line=~/^[^\+]/) {next;}

2190
# TEST: allow direct testing of the type matcher.
2191 2192
		if ($dbg_type) {
			if ($line =~ /^.\s*$Declare\s*$/) {
2193 2194
				ERROR("TEST_TYPE",
				      "TEST: is type\n" . $herecurr);
2195
			} elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2196 2197
				ERROR("TEST_NOT_TYPE",
				      "TEST: is not type ($1 is)\n". $herecurr);
2198
			}
2199 2200
			next;
		}
2201 2202
# TEST: allow direct testing of the attribute matcher.
		if ($dbg_attr) {
2203
			if ($line =~ /^.\s*$Modifier\s*$/) {
2204 2205
				ERROR("TEST_ATTR",
				      "TEST: is attr\n" . $herecurr);
2206
			} elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2207 2208
				ERROR("TEST_NOT_ATTR",
				      "TEST: is not attr ($1 is)\n". $herecurr);
2209 2210 2211
			}
			next;
		}
2212

2213
# check for initialisation to aggregates open brace on the next line
2214 2215
		if ($line =~ /^.\s*{/ &&
		    $prevline =~ /(?:^|[^=])=\s*$/) {
2216 2217
			ERROR("OPEN_BRACE",
			      "that open brace { should be on the previous line\n" . $hereprev);
2218 2219
		}

2220 2221 2222 2223 2224
#
# Checks which are anchored on the added line.
#

# check for malformed paths in #include statements (uses RAW line)
2225
		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2226 2227
			my $path = $1;
			if ($path =~ m{//}) {
2228 2229
				ERROR("MALFORMED_INCLUDE",
				      "malformed #include filename\n" .
2230
					$herecurr);
2231 2232
			}
		}
2233

2234
# no C99 // comments
2235
		if ($line =~ m{//}) {
2236 2237
			ERROR("C99_COMMENTS",
			      "do not use C99 // comments\n" . $herecurr);
2238
		}
2239
		# Remove C99 comments.
2240
		$line =~ s@//.*@@;
2241
		$opline =~ s@//.*@@;
2242

2243 2244 2245 2246 2247 2248 2249 2250
# 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.*\((.*)\)/)) {
2251 2252 2253 2254
			# Handle definitions which produce identifiers with
			# a prefix:
			#   XXX(foo);
			#   EXPORT_SYMBOL(something_foo);
2255
			my $name = $1;
2256
			if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
2257 2258 2259 2260 2261
			    $name =~ /^${Ident}_$2/) {
#print "FOO C name<$name>\n";
				$suppress_export{$realline_next} = 1;

			} elsif ($stat !~ /(?:
2262
				\n.}\s*$|
2263 2264 2265
				^.DEFINE_$Ident\(\Q$name\E\)|
				^.DECLARE_$Ident\(\Q$name\E\)|
				^.LIST_HEAD\(\Q$name\E\)|
2266 2267
				^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
				\b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
2268
			    )/x) {
2269 2270 2271 2272
#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
				$suppress_export{$realline_next} = 2;
			} else {
				$suppress_export{$realline_next} = 1;
2273 2274
			}
		}
2275 2276 2277 2278 2279 2280 2281 2282 2283
		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) {
2284 2285
			WARN("EXPORT_SYMBOL",
			     "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2286
		}
2287

2288
# check for global initialisers.
2289
		if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
2290 2291
			ERROR("GLOBAL_INITIALISERS",
			      "do not initialise globals to 0 or NULL\n" .
2292 2293
				$herecurr);
		}
2294
# check for static initialisers.
2295
		if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2296 2297
			ERROR("INITIALISED_STATIC",
			      "do not initialise statics to 0 or NULL\n" .
2298
				$herecurr);
2299 2300
		}

2301 2302
# check for static const char * arrays.
		if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
2303 2304
			WARN("STATIC_CONST_CHAR_ARRAY",
			     "static const char * array should probably be static const char * const\n" .
2305 2306 2307 2308 2309
				$herecurr);
               }

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

2315 2316
# check for declarations of struct pci_device_id
		if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
2317 2318
			WARN("DEFINE_PCI_DEVICE_TABLE",
			     "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
2319 2320
		}

2321 2322 2323
# check for new typedefs, only function parameters and sparse annotations
# make sense.
		if ($line =~ /\btypedef\s/ &&
2324
		    $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
2325
		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
2326
		    $line !~ /\b$typeTypedefs\b/ &&
2327
		    $line !~ /\b__bitwise(?:__|)\b/) {
2328 2329
			WARN("NEW_TYPEDEFS",
			     "do not add new typedefs\n" . $herecurr);
2330 2331 2332
		}

# * goes on variable not on type
2333
		# (char*[ const])
2334 2335 2336
		while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
			#print "AA<$1>\n";
			my ($from, $to) = ($2, $2);
2337 2338 2339 2340 2341 2342

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

2346 2347
			#print "from<$from> to<$to>\n";
			if ($from ne $to) {
2348 2349
				ERROR("POINTER_LOCATION",
				      "\"(foo$from)\" should be \"(foo$to)\"\n" .  $herecurr);
2350
			}
2351 2352 2353 2354
		}
		while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
			#print "BB<$1>\n";
			my ($from, $to, $ident) = ($2, $2, $3);
2355 2356 2357 2358 2359 2360

			# Should start with a space.
			$to =~ s/^(\S)/ $1/;
			# Should not end with a space.
			$to =~ s/\s+$//;
			# '*'s should not have spaces between.
2361
			while ($to =~ s/\*\s+\*/\*\*/) {
2362 2363 2364
			}
			# Modifiers should have spaces.
			$to =~ s/(\b$Modifier$)/$1 /;
2365

2366 2367
			#print "from<$from> to<$to> ident<$ident>\n";
			if ($from ne $to && $ident !~ /^$Modifier$/) {
2368 2369
				ERROR("POINTER_LOCATION",
				      "\"foo${from}bar\" should be \"foo${to}bar\"\n" .  $herecurr);
2370
			}
2371 2372 2373 2374 2375 2376 2377 2378 2379
		}

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

2380
		if ($line =~ /\bLINUX_VERSION_CODE\b/) {
2381 2382
			WARN("LINUX_VERSION_CODE",
			     "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
2383 2384
		}

2385 2386
# check for uses of printk_ratelimit
		if ($line =~ /\bprintk_ratelimit\s*\(/) {
2387 2388
			WARN("PRINTK_RATELIMITED",
"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
2389 2390
		}

2391 2392 2393
# 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
L
Lucas De Marchi 已提交
2394
# printk includes all preceding printk's which have no newline on the end.
2395
# we assume the first bad printk is the one to report.
2396
		if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
2397 2398 2399
			my $ok = 0;
			for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
				#print "CHECK<$lines[$ln - 1]\n";
L
Lucas De Marchi 已提交
2400
				# we have a preceding printk if it ends
2401 2402 2403 2404 2405 2406 2407 2408 2409
				# 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) {
2410 2411
				WARN("PRINTK_WITHOUT_KERN_LEVEL",
				     "printk() should include KERN_ facility level\n" . $herecurr);
2412
			}
2413 2414
		}

2415 2416 2417 2418
		if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
			my $orig = $1;
			my $level = lc($orig);
			$level = "warn" if ($level eq "warning");
2419 2420
			my $level2 = $level;
			$level2 = "dbg" if ($level eq "debug");
2421
			WARN("PREFER_PR_LEVEL",
2422
			     "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(...  to printk(KERN_$orig ...\n" . $herecurr);
2423 2424 2425 2426 2427 2428 2429
		}

		if ($line =~ /\bpr_warning\s*\(/) {
			WARN("PREFER_PR_LEVEL",
			     "Prefer pr_warn(... to pr_warning(...\n" . $herecurr);
		}

2430 2431
# function brace can't be on same line, except for #defines of do while,
# or if closed on same line
2432 2433
		if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
		    !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
2434 2435
			ERROR("OPEN_BRACE",
			      "open brace '{' following function declarations go on the next line\n" . $herecurr);
2436
		}
2437

2438 2439 2440
# 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*$/) {
2441 2442
			ERROR("OPEN_BRACE",
			      "open brace '{' following $1 go on the same line\n" . $hereprev);
2443 2444
		}

2445 2446
# missing space after union, struct or enum definition
		if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
2447 2448
		    WARN("SPACING",
			 "missing space after $1 definition\n" . $herecurr);
2449 2450
		}

2451 2452
# check for spacing round square brackets; allowed:
#  1. with a type on the left -- int [] a;
2453 2454
#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
#  3. inside a curly brace -- = { [0...10] = 5 }
2455 2456 2457
		while ($line =~ /(.*?\s)\[/g) {
			my ($where, $prefix) = ($-[1], $1);
			if ($prefix !~ /$Type\s+$/ &&
2458
			    ($where != 0 || $prefix !~ /^.\s+$/) &&
2459
			    $prefix !~ /[{,]\s+$/) {
2460 2461
				ERROR("BRACKET_SPACE",
				      "space prohibited before open square bracket '['\n" . $herecurr);
2462 2463 2464
			}
		}

2465
# check for spaces between functions and their parentheses.
2466
		while ($line =~ /($Ident)\s+\(/g) {
2467
			my $name = $1;
2468 2469
			my $ctx_before = substr($line, 0, $-[1]);
			my $ctx = "$ctx_before$name";
2470 2471

			# Ignore those directives where spaces _are_ permitted.
2472 2473 2474 2475 2476 2477
			if ($name =~ /^(?:
				if|for|while|switch|return|case|
				volatile|__volatile__|
				__attribute__|format|__extension__|
				asm|__asm__)$/x)
			{
2478 2479 2480 2481

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

			# cpp #elif statement condition may start with a (
2485
			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
2486 2487 2488

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

			} else {
2492 2493
				WARN("SPACING",
				     "space prohibited between function name and open parenthesis '('\n" . $herecurr);
2494
			}
2495
		}
2496 2497 2498 2499 2500 2501 2502

# check for whitespace before a non-naked semicolon
		if ($line =~ /^\+.*\S\s+;/) {
			CHK("SPACING",
			    "space prohibited before semicolon\n" . $herecurr);
		}

2503
# Check operator spacing.
2504
		if (!($line=~/\#\s*include/)) {
2505 2506 2507 2508
			my $ops = qr{
				<<=|>>=|<=|>=|==|!=|
				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
				=>|->|<<|>>|<|>|=|!|~|
2509 2510
				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
				\?|:
2511
			}x;
2512
			my @elements = split(/($ops|;)/, $opline);
2513
			my $off = 0;
2514 2515 2516

			my $blank = copy_spacing($opline);

2517
			for (my $n = 0; $n < $#elements; $n += 2) {
2518 2519
				$off += length($elements[$n]);

L
Lucas De Marchi 已提交
2520
				# Pick up the preceding and succeeding characters.
2521 2522 2523 2524 2525 2526 2527
				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";

2528 2529 2530
				my $a = '';
				$a = 'V' if ($elements[$n] ne '');
				$a = 'W' if ($elements[$n] =~ /\s$/);
2531
				$a = 'C' if ($elements[$n] =~ /$;$/);
2532 2533
				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
				$a = 'O' if ($elements[$n] eq '');
2534
				$a = 'E' if ($ca =~ /^\s*$/);
2535

2536
				my $op = $elements[$n + 1];
2537 2538

				my $c = '';
2539
				if (defined $elements[$n + 2]) {
2540 2541
					$c = 'V' if ($elements[$n + 2] ne '');
					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
2542
					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
2543 2544
					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
					$c = 'O' if ($elements[$n + 2] eq '');
2545
					$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
2546 2547
				} else {
					$c = 'E';
2548 2549
				}

2550 2551 2552 2553
				my $ctx = "${a}x${c}";

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

2554
				my $ptr = substr($blank, 0, $off) . "^";
2555
				my $hereptr = "$hereline$ptr\n";
2556

2557
				# Pull out the value of this operator.
2558
				my $op_type = substr($curr_values, $off + 1, 1);
2559

2560 2561 2562
				# Get the full operator variant.
				my $opv = $op . substr($curr_vars, $off, 1);

2563 2564 2565 2566
				# Ignore operators passed as parameters.
				if ($op_type ne 'V' &&
				    $ca =~ /\s$/ && $cc =~ /^\s*,/) {

2567 2568
#				# Ignore comments
#				} elsif ($op =~ /^$;+$/) {
2569

2570
				# ; should have either the end of line or a space or \ after it
2571
				} elsif ($op eq ';') {
2572 2573
					if ($ctx !~ /.x[WEBC]/ &&
					    $cc !~ /^\\/ && $cc !~ /^;/) {
2574 2575
						ERROR("SPACING",
						      "space required after that '$op' $at\n" . $hereptr);
2576 2577 2578 2579
					}

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

2581 2582 2583 2584
				# No spaces for:
				#   ->
				#   :   when part of a bitfield
				} elsif ($op eq '->' || $opv eq ':B') {
2585
					if ($ctx =~ /Wx.|.xW/) {
2586 2587
						ERROR("SPACING",
						      "spaces prohibited around that '$op' $at\n" . $hereptr);
2588 2589 2590 2591
					}

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

2597
				# '*' as part of a type definition -- reported already.
2598
				} elsif ($opv eq '*_') {
2599 2600 2601 2602 2603 2604
					#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 '~' ||
2605
					 $opv eq '*U' || $opv eq '-U' ||
2606
					 $opv eq '&U' || $opv eq '&&U') {
2607
					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
2608 2609
						ERROR("SPACING",
						      "space required before that '$op' $at\n" . $hereptr);
2610
					}
2611
					if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
2612 2613 2614
						# A unary '*' may be const

					} elsif ($ctx =~ /.xW/) {
2615 2616
						ERROR("SPACING",
						      "space prohibited after that '$op' $at\n" . $hereptr);
2617 2618 2619 2620
					}

				# unary ++ and unary -- are allowed no space on one side.
				} elsif ($op eq '++' or $op eq '--') {
2621
					if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2622 2623
						ERROR("SPACING",
						      "space required one side of that '$op' $at\n" . $hereptr);
2624 2625 2626
					}
					if ($ctx =~ /Wx[BE]/ ||
					    ($ctx =~ /Wx./ && $cc =~ /^;/)) {
2627 2628
						ERROR("SPACING",
						      "space prohibited before that '$op' $at\n" . $hereptr);
2629
					}
2630
					if ($ctx =~ /ExW/) {
2631 2632
						ERROR("SPACING",
						      "space prohibited after that '$op' $at\n" . $hereptr);
2633
					}
2634

2635

2636
				# << and >> may either have or not have spaces both sides
2637 2638 2639
				} elsif ($op eq '<<' or $op eq '>>' or
					 $op eq '&' or $op eq '^' or $op eq '|' or
					 $op eq '+' or $op eq '-' or
2640 2641
					 $op eq '*' or $op eq '/' or
					 $op eq '%')
2642
				{
2643
					if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
2644 2645
						ERROR("SPACING",
						      "need consistent spacing around '$op' $at\n" .
2646
							$hereptr);
2647 2648
					}

2649 2650 2651 2652
				# 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./) {
2653 2654
						ERROR("SPACING",
						      "space prohibited before that '$op' $at\n" . $hereptr);
2655 2656
					}

2657
				# All the others need spaces both sides.
2658
				} elsif ($ctx !~ /[EWC]x[CWE]/) {
2659 2660
					my $ok = 0;

2661
					# Ignore email addresses <foo@bar>
2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676
					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) {
2677 2678
						ERROR("SPACING",
						      "spaces required around that '$op' $at\n" . $hereptr);
2679
					}
2680
				}
2681
				$off += length($elements[$n + 1]);
2682 2683 2684
			}
		}

2685 2686
# check for multiple assignments
		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
2687 2688
			CHK("MULTIPLE_ASSIGNMENTS",
			    "multiple assignments should be avoided\n" . $herecurr);
2689 2690
		}

2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701
## # 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 =~ /,/) {
2702 2703
## 				WARN("MULTIPLE_DECLARATION",
##				     "declaring multiple variables together should be avoided\n" . $herecurr);
2704 2705
## 			}
## 		}
2706

2707
#need space before brace following if, while, etc
2708 2709
		if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
		    $line =~ /do{/) {
2710 2711
			ERROR("SPACING",
			      "space required before the open brace '{'\n" . $herecurr);
2712 2713 2714 2715 2716
		}

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

2721 2722
# check spacing on square brackets
		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
2723 2724
			ERROR("SPACING",
			      "space prohibited after that open square bracket '['\n" . $herecurr);
2725 2726
		}
		if ($line =~ /\s\]/) {
2727 2728
			ERROR("SPACING",
			      "space prohibited before that close square bracket ']'\n" . $herecurr);
2729 2730
		}

2731
# check spacing on parentheses
2732 2733
		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
		    $line !~ /for\s*\(\s+;/) {
2734 2735
			ERROR("SPACING",
			      "space prohibited after that open parenthesis '('\n" . $herecurr);
2736
		}
2737
		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
2738 2739
		    $line !~ /for\s*\(.*;\s+\)/ &&
		    $line !~ /:\s+\)/) {
2740 2741
			ERROR("SPACING",
			      "space prohibited before that close parenthesis ')'\n" . $herecurr);
2742 2743
		}

2744
#goto labels aren't indented, allow a single space however
2745
		if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
2746
		   !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
2747 2748
			WARN("INDENTED_LABEL",
			     "labels should not be indented\n" . $herecurr);
2749 2750
		}

2751 2752 2753 2754 2755
# Return is not a function.
		if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
			my $spacing = $1;
			my $value = $2;

2756
			# Flatten any parentheses
2757 2758
			$value =~ s/\(/ \(/g;
			$value =~ s/\)/\) /g;
2759
			while ($value =~ s/\[[^\[\]]*\]/1/ ||
2760 2761 2762 2763
			       $value !~ /(?:$Ident|-?$Constant)\s*
					     $Compare\s*
					     (?:$Ident|-?$Constant)/x &&
			       $value =~ s/\([^\(\)]*\)/1/) {
2764
			}
2765 2766
#print "value<$value>\n";
			if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
2767 2768
				ERROR("RETURN_PARENTHESES",
				      "return is not a function, parentheses are not required\n" . $herecurr);
2769 2770

			} elsif ($spacing !~ /\s+/) {
2771 2772
				ERROR("SPACING",
				      "space required before the open parenthesis '('\n" . $herecurr);
2773 2774
			}
		}
2775 2776 2777 2778
# 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') {
2779 2780
				WARN("USE_NEGATIVE_ERRNO",
				     "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
2781 2782
			}
		}
2783

2784
# Need a space before open parenthesis after if, while etc
2785
		if ($line=~/\b(if|while|for|switch)\(/) {
2786
			ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr);
2787 2788
		}

2789 2790
# Check for illegal assignment in if conditional -- and check for trailing
# statements after the conditional.
2791
		if ($line =~ /do\s*(?!{)/) {
2792 2793 2794
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813
			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*#/) {
2814
			my ($s, $c) = ($stat, $cond);
2815

2816
			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2817 2818
				ERROR("ASSIGN_IN_IF",
				      "do not use assignment in if condition\n" . $herecurr);
2819 2820 2821 2822
			}

			# Find out what is on the end of the line after the
			# conditional.
2823
			substr($s, 0, length($c), '');
2824
			$s =~ s/\n.*//g;
2825
			$s =~ s/$;//g; 	# Remove any comments
2826 2827
			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
			    $c !~ /}\s*while\s*/)
2828
			{
2829 2830 2831
				# Find out how long the conditional actually is.
				my @newlines = ($c =~ /\n/gs);
				my $cond_lines = 1 + $#newlines;
2832
				my $stat_real = '';
2833

2834 2835
				$stat_real = raw_line($linenr, $cond_lines)
							. "\n" if ($cond_lines);
2836 2837 2838 2839
				if (defined($stat_real) && $cond_lines > 1) {
					$stat_real = "[...]\n$stat_real";
				}

2840 2841
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr . $stat_real);
2842 2843 2844
			}
		}

2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856
# Check for bitwise tests written as boolean
		if ($line =~ /
			(?:
				(?:\[|\(|\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\|)
			|
				(?:\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\||\)|\])
			)/x)
		{
2857 2858
			WARN("HEXADECIMAL_BOOLEAN_TEST",
			     "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2859 2860
		}

2861
# if and else should not have general statements after it
2862 2863 2864 2865
		if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
			my $s = $1;
			$s =~ s/$;//g; 	# Remove any comments
			if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2866 2867
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr);
2868
			}
2869
		}
2870 2871
# if should not continue a brace
		if ($line =~ /}\s*if\b/) {
2872 2873
			ERROR("TRAILING_STATEMENTS",
			      "trailing statements should be on next line\n" .
2874 2875
				$herecurr);
		}
2876 2877 2878
# case and default should not have general statements after them
		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
		    $line !~ /\G(?:
2879
			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
2880 2881 2882
			\s*return\s+
		    )/xg)
		{
2883 2884
			ERROR("TRAILING_STATEMENTS",
			      "trailing statements should be on next line\n" . $herecurr);
2885
		}
2886 2887 2888 2889 2890

		# 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) {
2891 2892
			ERROR("ELSE_AFTER_BRACE",
			      "else should follow close brace '}'\n" . $hereprev);
2893 2894
		}

2895 2896 2897 2898 2899 2900
		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.
2901
			substr($s, 0, length($c), '');
2902 2903 2904
			$s =~ s/\n.*//g;

			if ($s =~ /^\s*;/) {
2905 2906
				ERROR("WHILE_AFTER_BRACE",
				      "while should follow close brace '}'\n" . $hereprev);
2907 2908 2909
			}
		}

2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920
#CamelCase
		while ($line =~ m{($Constant|$Lval)}g) {
			my $var = $1;
			if ($var !~ /$Constant/ &&
			    $var =~ /[A-Z]\w*[a-z]|[a-z]\w*[A-Z]/ &&
			    !defined $camelcase{$var}) {
				$camelcase{$var} = 1;
				WARN("CAMELCASE",
				     "Avoid CamelCase: <$var>\n" . $herecurr);
			}
		}
2921 2922

#no spaces allowed after \ in define
2923
		if ($line=~/\#\s*define.*\\\s$/) {
2924 2925
			WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
			     "Whitepspace after \\ makes next lines useless\n" . $herecurr);
2926 2927
		}

2928
#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2929
		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2930 2931 2932 2933
			my $file = "$1.h";
			my $checkfile = "include/linux/$file";
			if (-f "$root/$checkfile" &&
			    $realfile ne $checkfile &&
2934
			    $1 !~ /$allowed_asm_includes/)
2935
			{
2936
				if ($realfile =~ m{^arch/}) {
2937 2938
					CHK("ARCH_INCLUDE_LINUX",
					    "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2939
				} else {
2940 2941
					WARN("INCLUDE_LINUX",
					     "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2942
				}
2943 2944 2945
			}
		}

2946 2947
# 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
2948
# in a known good container
2949 2950
		if ($realfile !~ m@/vmlinux.lds.h$@ &&
		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2951 2952
			my $ln = $linenr;
			my $cnt = $realcnt;
2953 2954 2955
			my ($off, $dstat, $dcond, $rest);
			my $ctx = '';
			($dstat, $dcond, $ln, $cnt, $off) =
2956 2957
				ctx_statement_block($linenr, $realcnt, 0);
			$ctx = $dstat;
2958
			#print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
2959
			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2960

2961
			$dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
2962
			$dstat =~ s/$;//g;
2963 2964 2965
			$dstat =~ s/\\\n.//g;
			$dstat =~ s/^\s*//s;
			$dstat =~ s/\s*$//s;
2966

2967
			# Flatten any parentheses and braces
2968 2969
			while ($dstat =~ s/\([^\(\)]*\)/1/ ||
			       $dstat =~ s/\{[^\{\}]*\}/1/ ||
2970
			       $dstat =~ s/\[[^\[\]]*\]/1/)
2971
			{
2972
			}
2973

2974 2975 2976 2977 2978 2979
			# Flatten any obvious string concatentation.
			while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
			       $dstat =~ s/$Ident\s*("X*")/$1/)
			{
			}

2980 2981 2982
			my $exceptions = qr{
				$Declare|
				module_param_named|
2983
				MODULE_PARM_DESC|
2984 2985
				DECLARE_PER_CPU|
				DEFINE_PER_CPU|
2986
				__typeof__\(|
2987 2988
				union|
				struct|
2989 2990
				\.$Ident\s*=\s*|
				^\"|\"$
2991
			}x;
2992
			#print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
2993 2994 2995
			if ($dstat ne '' &&
			    $dstat !~ /^(?:$Ident|-?$Constant),$/ &&			# 10, // foo(),
			    $dstat !~ /^(?:$Ident|-?$Constant);$/ &&			# foo();
2996
			    $dstat !~ /^[!~-]?(?:$Ident|$Constant)$/ &&		# 10 // foo() // !foo // ~foo // -foo
2997
			    $dstat !~ /^'X'$/ &&					# character constants
2998 2999
			    $dstat !~ /$exceptions/ &&
			    $dstat !~ /^\.$Ident\s*=/ &&				# .foo =
3000
			    $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ &&	# do {...} while (...); // do {...} while (...)
3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011
			    $dstat !~ /^for\s*$Constant$/ &&				# for (...)
			    $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ &&	# for (...) bar()
			    $dstat !~ /^do\s*{/ &&					# do {...
			    $dstat !~ /^\({/)						# ({...
			{
				$ctx =~ s/\n*$//;
				my $herectx = $here . "\n";
				my $cnt = statement_rawlines($ctx);

				for (my $n = 0; $n < $cnt; $n++) {
					$herectx .= raw_line($linenr, $n) . "\n";
3012 3013
				}

3014 3015 3016 3017
				if ($dstat =~ /;/) {
					ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
					      "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
				} else {
3018
					ERROR("COMPLEX_MACRO",
3019
					      "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
3020
				}
3021
			}
3022

3023
# check for line continuations outside of #defines, preprocessor #, and asm
3024 3025 3026

		} else {
			if ($prevline !~ /^..*\\$/ &&
3027 3028
			    $line !~ /^\+\s*\#.*\\$/ &&		# preprocessor
			    $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ &&	# asm
3029 3030 3031 3032
			    $line =~ /^\+.*\\$/) {
				WARN("LINE_CONTINUATIONS",
				     "Avoid unnecessary line continuations\n" . $herecurr);
			}
3033 3034
		}

3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062
# do {} while (0) macro tests:
# single-statement macros do not need to be enclosed in do while (0) loop,
# macro should not end with a semicolon
		if ($^V && $^V ge 5.10.0 &&
		    $realfile !~ m@/vmlinux.lds.h$@ &&
		    $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
			my $ln = $linenr;
			my $cnt = $realcnt;
			my ($off, $dstat, $dcond, $rest);
			my $ctx = '';
			($dstat, $dcond, $ln, $cnt, $off) =
				ctx_statement_block($linenr, $realcnt, 0);
			$ctx = $dstat;

			$dstat =~ s/\\\n.//g;

			if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
				my $stmts = $2;
				my $semis = $3;

				$ctx =~ s/\n*$//;
				my $cnt = statement_rawlines($ctx);
				my $herectx = $here . "\n";

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

3063 3064
				if (($stmts =~ tr/;/;/) == 1 &&
				    $stmts !~ /^\s*(if|while|for|switch)\b/) {
3065 3066 3067 3068 3069 3070 3071 3072 3073 3074
					WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
					     "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
				}
				if (defined $semis && $semis ne "") {
					WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
					     "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
				}
			}
		}

3075 3076 3077 3078 3079 3080
# 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|$))/) {
3081 3082
			WARN("MISSING_VMLINUX_SYMBOL",
			     "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
3083 3084
		}

3085
# check for redundant bracing round if etc
3086 3087
		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
			my ($level, $endln, @chunks) =
3088
				ctx_statement_full($linenr, $realcnt, 1);
3089
			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
3090 3091
			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
			if ($#chunks > 0 && $level == 0) {
3092 3093
				my @allowed = ();
				my $allow = 0;
3094
				my $seen = 0;
3095
				my $herectx = $here . "\n";
3096
				my $ln = $linenr - 1;
3097 3098 3099
				for my $chunk (@chunks) {
					my ($cond, $block) = @{$chunk};

3100 3101 3102 3103
					# If the condition carries leading newlines, then count those as offsets.
					my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
					my $offset = statement_rawlines($whitespace) - 1;

3104
					$allowed[$allow] = 0;
3105 3106 3107 3108 3109 3110
					#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";
3111 3112
					$ln += statement_rawlines($block) - 1;

3113
					substr($block, 0, length($cond), '');
3114 3115 3116

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

3117
					#print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
3118 3119
					if (statement_lines($cond) > 1) {
						#print "APW: ALLOWED: cond<$cond>\n";
3120
						$allowed[$allow] = 1;
3121 3122
					}
					if ($block =~/\b(?:if|for|while)\b/) {
3123
						#print "APW: ALLOWED: block<$block>\n";
3124
						$allowed[$allow] = 1;
3125
					}
3126 3127
					if (statement_block_size($block) > 1) {
						#print "APW: ALLOWED: lines block<$block>\n";
3128
						$allowed[$allow] = 1;
3129
					}
3130
					$allow++;
3131
				}
3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144
				if ($seen) {
					my $sum_allowed = 0;
					foreach (@allowed) {
						$sum_allowed += $_;
					}
					if ($sum_allowed == 0) {
						WARN("BRACES",
						     "braces {} are not necessary for any arm of this statement\n" . $herectx);
					} elsif ($sum_allowed != $allow &&
						 $seen != $allow) {
						CHK("BRACES",
						    "braces {} should be used on all arms of this statement\n" . $herectx);
					}
3145 3146 3147
				}
			}
		}
3148
		if (!defined $suppress_ifbraces{$linenr - 1} &&
3149
					$line =~ /\b(if|while|for|else)\b/) {
3150 3151 3152 3153 3154 3155 3156
			my $allowed = 0;

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

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

3161 3162
			# Check the condition.
			my ($cond, $block) = @{$chunks[0]};
3163
			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
3164
			if (defined $cond) {
3165
				substr($block, 0, length($cond), '');
3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182
			}
			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) {
3183
					substr($block, 0, length($cond), '');
3184 3185 3186 3187 3188 3189 3190
				}
				if ($block =~ /^\s*\{/) {
					#print "APW: ALLOWED: chunk-1 block<$block>\n";
					$allowed = 1;
				}
			}
			if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
3191
				my $herectx = $here . "\n";
3192
				my $cnt = statement_rawlines($block);
3193

3194
				for (my $n = 0; $n < $cnt; $n++) {
3195
					$herectx .= raw_line($linenr, $n) . "\n";
3196
				}
3197

3198 3199
				WARN("BRACES",
				     "braces {} are not necessary for single statement blocks\n" . $herectx);
3200 3201 3202
			}
		}

3203 3204 3205 3206 3207 3208 3209 3210 3211 3212
# check for unnecessary blank lines around braces
		if (($line =~ /^..*}\s*$/ && $prevline =~ /^.\s*$/)) {
			CHK("BRACES",
			    "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
		}
		if (($line =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
			CHK("BRACES",
			    "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
		}

3213
# no volatiles please
3214 3215
		my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
		if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
3216 3217
			WARN("VOLATILE",
			     "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
3218 3219
		}

3220
# warn about #if 0
3221
		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
3222 3223
			CHK("REDUNDANT_CODE",
			    "if this code is redundant consider removing it\n" .
3224
				$herecurr);
3225 3226
		}

3227 3228 3229 3230 3231 3232
# check for needless "if (<foo>) fn(<foo>)" uses
		if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
			my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
			if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
				WARN('NEEDLESS_IF',
				     "$1(NULL) is safe this check is probably not required\n" . $hereprev);
3233 3234
			}
		}
3235

3236 3237 3238 3239
# prefer usleep_range over udelay
		if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) {
			# ignore udelay's < 10, however
			if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) {
3240 3241
				CHK("USLEEP_RANGE",
				    "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
3242 3243 3244
			}
		}

3245 3246 3247
# warn about unexpectedly long msleep's
		if ($line =~ /\bmsleep\s*\((\d+)\);/) {
			if ($1 < 20) {
3248 3249
				WARN("MSLEEP",
				     "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
3250 3251 3252
			}
		}

3253
# warn about #ifdefs in C files
3254
#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
3255 3256 3257 3258 3259
#			print "#ifdef in C files should be avoided\n";
#			print "$herecurr";
#			$clean = 0;
#		}

3260
# warn about spacing in #ifdefs
3261
		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
3262 3263
			ERROR("SPACING",
			      "exactly one space required after that #$1\n" . $herecurr);
3264 3265
		}

3266
# check for spinlock_t definitions without a comment.
3267 3268
		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
3269 3270
			my $which = $1;
			if (!ctx_has_comment($first_line, $linenr)) {
3271 3272
				CHK("UNCOMMENTED_DEFINITION",
				    "$1 definition without comment\n" . $herecurr);
3273 3274 3275 3276 3277
			}
		}
# 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)) {
3278 3279
				CHK("MEMORY_BARRIER",
				    "memory barrier without comment\n" . $herecurr);
3280 3281 3282
			}
		}
# check of hardware specific defines
3283
		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
3284 3285
			CHK("ARCH_DEFINES",
			    "architecture specific defines should be avoided\n" .  $herecurr);
3286
		}
3287

3288 3289
# Check that the storage class is at the beginning of a declaration
		if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
3290 3291
			WARN("STORAGE_CLASS",
			     "storage class should be at the beginning of the declaration\n" . $herecurr)
3292 3293
		}

3294 3295
# check the location of the inline attribute, that it is between
# storage class and type.
3296 3297
		if ($line =~ /\b$Type\s+$Inline\b/ ||
		    $line =~ /\b$Inline\s+$Storage\b/) {
3298 3299
			ERROR("INLINE_LOCATION",
			      "inline keyword should sit between storage class and type\n" . $herecurr);
3300 3301
		}

3302 3303
# Check for __inline__ and __inline, prefer inline
		if ($line =~ /\b(__inline__|__inline)\b/) {
3304 3305
			WARN("INLINE",
			     "plain inline is preferred over $1\n" . $herecurr);
3306 3307
		}

3308 3309
# Check for __attribute__ packed, prefer __packed
		if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
3310 3311
			WARN("PREFER_PACKED",
			     "__packed is preferred over __attribute__((packed))\n" . $herecurr);
3312 3313
		}

3314 3315
# Check for __attribute__ aligned, prefer __aligned
		if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
3316 3317
			WARN("PREFER_ALIGNED",
			     "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
3318 3319
		}

3320 3321 3322 3323 3324 3325
# Check for __attribute__ format(printf, prefer __printf
		if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
			WARN("PREFER_PRINTF",
			     "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr);
		}

3326 3327 3328 3329 3330 3331
# Check for __attribute__ format(scanf, prefer __scanf
		if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
			WARN("PREFER_SCANF",
			     "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr);
		}

3332 3333
# check for sizeof(&)
		if ($line =~ /\bsizeof\s*\(\s*\&/) {
3334 3335
			WARN("SIZEOF_ADDRESS",
			     "sizeof(& should be avoided\n" . $herecurr);
3336 3337
		}

3338 3339 3340 3341 3342 3343
# check for sizeof without parenthesis
		if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
			WARN("SIZEOF_PARENTHESIS",
			     "sizeof $1 should be sizeof($1)\n" . $herecurr);
		}

3344 3345
# check for line continuations in quoted strings with odd counts of "
		if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
3346 3347
			WARN("LINE_CONTINUATIONS",
			     "Avoid line continuations in quoted strings\n" . $herecurr);
3348 3349
		}

3350 3351 3352 3353 3354 3355
# check for struct spinlock declarations
		if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
			WARN("USE_SPINLOCK_T",
			     "struct spinlock should be spinlock_t\n" . $herecurr);
		}

3356
# Check for misused memsets
3357 3358
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
3359 3360 3361
		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {

			my $ms_addr = $2;
3362 3363
			my $ms_val = $7;
			my $ms_size = $12;
3364 3365 3366

			if ($ms_size =~ /^(0x|)0$/i) {
				ERROR("MEMSET",
3367
				      "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
3368 3369
			} elsif ($ms_size =~ /^(0x|)1$/i) {
				WARN("MEMSET",
3370 3371 3372 3373 3374
				     "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
			}
		}

# typecasts on min/max could be min_t/max_t
3375 3376
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
3377
		    $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
3378
			if (defined $2 || defined $7) {
3379 3380 3381
				my $call = $1;
				my $cast1 = deparenthesize($2);
				my $arg1 = $3;
3382 3383
				my $cast2 = deparenthesize($7);
				my $arg2 = $8;
3384 3385
				my $cast;

3386
				if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
3387 3388 3389 3390 3391 3392 3393 3394
					$cast = "$cast1 or $cast2";
				} elsif ($cast1 ne "") {
					$cast = $cast1;
				} else {
					$cast = $cast2;
				}
				WARN("MINMAX",
				     "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
3395 3396 3397
			}
		}

3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413
# check usleep_range arguments
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
		    $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
			my $min = $1;
			my $max = $7;
			if ($min eq $max) {
				WARN("USLEEP_RANGE",
				     "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
			} elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
				 $min > $max) {
				WARN("USLEEP_RANGE",
				     "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
			}
		}

3414
# check for new externs in .c files.
3415
		if ($realfile =~ /\.c$/ && defined $stat &&
3416
		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
3417
		{
3418 3419
			my $function_name = $1;
			my $paren_space = $2;
3420 3421 3422 3423 3424

			my $s = $stat;
			if (defined $cond) {
				substr($s, 0, length($cond), '');
			}
3425 3426 3427
			if ($s =~ /^\s*;/ &&
			    $function_name ne 'uninitialized_var')
			{
3428 3429
				WARN("AVOID_EXTERNS",
				     "externs should be avoided in .c files\n" .  $herecurr);
3430 3431 3432
			}

			if ($paren_space =~ /\n/) {
3433 3434
				WARN("FUNCTION_ARGUMENTS",
				     "arguments for function declarations should follow identifier\n" . $herecurr);
3435
			}
3436 3437 3438 3439

		} elsif ($realfile =~ /\.c$/ && defined $stat &&
		    $stat =~ /^.\s*extern\s+/)
		{
3440 3441
			WARN("AVOID_EXTERNS",
			     "externs should be avoided in .c files\n" .  $herecurr);
3442 3443 3444 3445 3446 3447 3448
		}

# checks for new __setup's
		if ($rawline =~ /\b__setup\("([^"]*)"/) {
			my $name = $1;

			if (!grep(/$name/, @setup_docs)) {
3449 3450
				CHK("UNDOCUMENTED_SETUP",
				    "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
3451
			}
3452
		}
3453 3454

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

3460 3461
# check for multiple semicolons
		if ($line =~ /;\s*;\s*$/) {
3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477
			WARN("ONE_SEMICOLON",
			     "Statements terminations use 1 semicolon\n" . $herecurr);
		}

# check for switch/default statements without a break;
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
		    $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
			my $ctx = '';
			my $herectx = $here . "\n";
			my $cnt = statement_rawlines($stat);
			for (my $n = 0; $n < $cnt; $n++) {
				$herectx .= raw_line($linenr, $n) . "\n";
			}
			WARN("DEFAULT_NO_BREAK",
			     "switch default: should use break\n" . $herectx);
3478 3479
		}

3480 3481
# check for gcc specific __FUNCTION__
		if ($line =~ /__FUNCTION__/) {
3482 3483
			WARN("USE_FUNC",
			     "__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr);
3484
		}
3485

J
Joe Perches 已提交
3486 3487 3488 3489 3490 3491
# check for use of yield()
		if ($line =~ /\byield\s*\(\s*\)/) {
			WARN("YIELD",
			     "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n"  . $herecurr);
		}

3492 3493
# check for semaphores initialized locked
		if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
3494 3495
			WARN("CONSIDER_COMPLETION",
			     "consider using a completion\n" . $herecurr);
3496
		}
3497

3498 3499
# recommend kstrto* over simple_strto* and strict_strto*
		if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
3500
			WARN("CONSIDER_KSTRTO",
3501
			     "$1 is obsolete, use k$3 instead\n" . $herecurr);
3502
		}
3503

3504 3505
# check for __initcall(), use device_initcall() explicitly please
		if ($line =~ /^.\s*__initcall\s*\(/) {
3506 3507
			WARN("USE_DEVICE_INITCALL",
			     "please use device_initcall() instead of __initcall()\n" . $herecurr);
3508
		}
3509

3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547
# 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;
3548
		if ($line !~ /\bconst\b/ &&
3549
		    $line =~ /\bstruct\s+($struct_ops)\b/) {
3550 3551
			WARN("CONST_STRUCT",
			     "struct $1 should normally be const\n" .
3552
				$herecurr);
3553
		}
3554 3555 3556 3557

# 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/ &&
3558 3559
		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
3560 3561 3562
		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
3563
		{
3564 3565
			WARN("NR_CPUS",
			     "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
3566
		}
3567 3568 3569 3570 3571

# check for %L{u,d,i} in strings
		my $string;
		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
			$string = substr($rawline, $-[1], $+[1] - $-[1]);
3572
			$string =~ s/%%/__/g;
3573
			if ($string =~ /(?<!%)%L[udi]/) {
3574 3575
				WARN("PRINTF_L",
				     "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
3576 3577 3578
				last;
			}
		}
3579 3580 3581 3582

# whine mightly about in_atomic
		if ($line =~ /\bin_atomic\s*\(/) {
			if ($realfile =~ m@^drivers/@) {
3583 3584
				ERROR("IN_ATOMIC",
				      "do not use in_atomic in drivers\n" . $herecurr);
3585
			} elsif ($realfile !~ m@^kernel/@) {
3586 3587
				WARN("IN_ATOMIC",
				     "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
3588 3589
			}
		}
3590 3591 3592 3593 3594 3595 3596

# 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@) {
3597 3598
				ERROR("LOCKDEP",
				      "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
3599 3600
			}
		}
3601 3602 3603

		if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
		    $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
3604 3605
			WARN("EXPORTED_WORLD_WRITABLE",
			     "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
3606
		}
3607 3608 3609 3610 3611 3612
	}

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

3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627
	# 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) {
3628 3629
		ERROR("NOT_UNIFIED_DIFF",
		      "Does not appear to be a unified-diff format patch\n");
3630 3631
	}
	if ($is_patch && $chk_signoff && $signoff == 0) {
3632 3633
		ERROR("MISSING_SIGN_OFF",
		      "Missing Signed-off-by: line(s)\n");
3634 3635
	}

3636
	print report_dump();
3637 3638
	if ($summary && !($clean == 1 && $quiet == 1)) {
		print "$filename " if ($summary_file);
3639 3640 3641 3642
		print "total: $cnt_error errors, $cnt_warn warnings, " .
			(($check)? "$cnt_chk checks, " : "") .
			"$cnt_lines lines checked\n";
		print "\n" if ($quiet == 0);
3643
	}
3644

3645
	if ($quiet == 0) {
3646 3647 3648 3649 3650 3651

		if ($^V lt 5.10.0) {
			print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
			print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
		}

3652 3653 3654 3655 3656
		# 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";
3657
			$rpt_cleaners = 0;
3658 3659 3660
		}
	}

3661
	if ($quiet == 0 && keys %ignore_type) {
3662 3663 3664 3665
	    print "NOTE: Ignored message types:";
	    foreach my $ignore (sort keys %ignore_type) {
		print " $ignore";
	    }
3666
	    print "\n\n";
3667 3668
	}

3669
	if ($clean == 1 && $quiet == 0) {
3670
		print "$vname has no obvious style problems and is ready for submission.\n"
3671 3672
	}
	if ($clean == 0 && $quiet == 0) {
3673 3674 3675 3676 3677 3678
		print << "EOM";
$vname has style problems, please review.

If any of these errors are false positives, please report
them to the maintainer, see CHECKPATCH in MAINTAINERS.
EOM
3679
	}
3680

3681 3682
	return $clean;
}