checkpatch.pl 120.6 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
# Licensed under the terms of the GNU GPL License version 2

use strict;
9
use POSIX;
10 11

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

14
my $V = '0.32';
15 16 17 18 19 20 21

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

my $quiet = 0;
my $tree = 1;
my $chk_signoff = 1;
my $chk_patch = 1;
22
my $tst_only;
23
my $emacs = 0;
24
my $terse = 0;
25 26
my $file = 0;
my $check = 0;
27 28
my $summary = 1;
my $mailback = 0;
29
my $summary_file = 0;
30
my $show_types = 0;
31
my $fix = 0;
32
my $root;
33
my %debug;
34
my %camelcase = ();
35 36 37
my %use_type = ();
my @use = ();
my %ignore_type = ();
38
my @ignore = ();
39
my $help = 0;
40
my $configuration_file = ".checkpatch.conf";
41
my $max_line_length = 80;
42 43
my $ignore_perl_version = 0;
my $minimum_perl_version = 5.10.0;
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60

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
61
  --types TYPE(,TYPE2...)    show only these comma separated message types
62
  --ignore TYPE(,TYPE2...)   ignore various comma separated message types
63
  --max-line-length=n        set the maximum line length, if exceeded, warn
64
  --show-types               show the message "types" in the output
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
74 75 76 77 78
  --fix                      EXPERIMENTAL - may create horrible results
                             If correctable single-line errors exist, create
                             "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
                             with potential errors corrected to the preferred
                             checkpatch style
79 80
  --ignore-perl-version      override checking of perl version.  expect
                             runtime errors.
81 82 83 84 85 86 87 88
  -h, --help, --version      display this help and exit

When FILE is - read standard input.
EOM

	exit($exitcode);
}

89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
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;
}

115
GetOptions(
116
	'q|quiet+'	=> \$quiet,
117 118 119
	'tree!'		=> \$tree,
	'signoff!'	=> \$chk_signoff,
	'patch!'	=> \$chk_patch,
120
	'emacs!'	=> \$emacs,
121
	'terse!'	=> \$terse,
122
	'f|file!'	=> \$file,
123 124
	'subjective!'	=> \$check,
	'strict!'	=> \$check,
125
	'ignore=s'	=> \@ignore,
126
	'types=s'	=> \@use,
127
	'show-types!'	=> \$show_types,
128
	'max-line-length=i' => \$max_line_length,
129
	'root=s'	=> \$root,
130 131
	'summary!'	=> \$summary,
	'mailback!'	=> \$mailback,
132
	'summary-file!'	=> \$summary_file,
133
	'fix!'		=> \$fix,
134
	'ignore-perl-version!' => \$ignore_perl_version,
135
	'debug=s'	=> \%debug,
136
	'test-only=s'	=> \$tst_only,
137 138 139 140 141
	'h|help'	=> \$help,
	'version'	=> \$help
) or help(1);

help(0) if ($help);
142 143 144

my $exit = 0;

145 146 147 148 149 150 151
if ($^V && $^V lt $minimum_perl_version) {
	printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
	if (!$ignore_perl_version) {
		exit(1);
	}
}

152
if ($#ARGV < 0) {
153
	print "$P: no input files\n";
154 155 156
	exit(1);
}

157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
sub hash_save_array_words {
	my ($hashRef, $arrayRef) = @_;

	my @array = split(/,/, join(',', @$arrayRef));
	foreach my $word (@array) {
		$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*$/);

		$hashRef->{$word}++;
	}
}
173

174 175
sub hash_show_words {
	my ($hashRef, $prefix) = @_;
176

177
	if ($quiet == 0 && keys %$hashRef) {
178
		print "NOTE: $prefix message types:";
179
		foreach my $word (sort keys %$hashRef) {
180 181 182 183
			print " $word";
		}
		print "\n\n";
	}
184 185
}

186 187 188
hash_save_array_words(\%ignore_type, \@ignore);
hash_save_array_words(\%use_type, \@use);

189 190
my $dbg_values = 0;
my $dbg_possible = 0;
191
my $dbg_type = 0;
192
my $dbg_attr = 0;
193
for my $key (keys %debug) {
194 195 196
	## no critic
	eval "\${dbg_$key} = '$debug{$key}';";
	die "$@" if ($@);
197 198
}

199 200
my $rpt_cleaners = 0;

201 202 203 204 205
if ($terse) {
	$emacs = 1;
	$quiet++;
}

206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
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);
	}
224 225
}

226 227
my $emitted_corrupt = 0;

228 229 230 231
our $Ident	= qr{
			[A-Za-z_][A-Za-z\d_]*
			(?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
		}x;
232 233 234 235 236 237 238 239
our $Storage	= qr{extern|static|asmlinkage};
our $Sparse	= qr{
			__user|
			__kernel|
			__force|
			__iomem|
			__must_check|
			__init_refok|
240
			__kprobes|
241 242
			__ref|
			__rcu
243
		}x;
244 245 246 247 248
our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
249

250 251
# Notes to $Attribute:
# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
252 253
our $Attribute	= qr{
			const|
254 255 256 257 258 259 260 261 262 263 264 265 266 267
			__percpu|
			__nocast|
			__safe|
			__bitwise__|
			__packed__|
			__packed2__|
			__naked|
			__maybe_unused|
			__always_unused|
			__noreturn|
			__used|
			__cold|
			__noclone|
			__deprecated|
268 269
			__read_mostly|
			__kprobes|
270
			$InitAttribute|
271 272
			____cacheline_aligned|
			____cacheline_aligned_in_smp|
273 274
			____cacheline_internodealigned_in_smp|
			__weak
275
		  }x;
276
our $Modifier;
277 278 279 280
our $Inline	= qr{inline|__always_inline|noinline};
our $Member	= qr{->$Ident|\.$Ident|\[[^]]*\]};
our $Lval	= qr{$Ident(?:$Member)*};

281 282 283 284
our $Int_type	= qr{(?i)llu|ull|ll|lu|ul|l|u};
our $Binary	= qr{(?i)0b[01]+$Int_type?};
our $Hex	= qr{(?i)0x[0-9a-f]+$Int_type?};
our $Int	= qr{[0-9]+$Int_type?};
285 286 287
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]?};
288
our $Float	= qr{$Float_hex|$Float_dec|$Float_int};
289
our $Constant	= qr{$Float|$Binary|$Hex|$Int};
290
our $Assignment	= qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
291
our $Compare    = qr{<=|>=|==|!=|<|>};
292
our $Arithmetic = qr{\+|-|\*|\/|%};
293 294 295
our $Operators	= qr{
			<=|>=|==|!=|
			=>|->|<<|>>|<|>|!|~|
296
			&&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
297 298
		  }x;

299
our $NonptrType;
300
our $NonptrTypeWithAttr;
301 302 303
our $Type;
our $Declare;

304 305
our $NON_ASCII_UTF8	= qr{
	[\xC2-\xDF][\x80-\xBF]               # non-overlong 2-byte
306 307 308 309 310 311 312 313
	|  \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;

314 315 316 317 318
our $UTF8	= qr{
	[\x09\x0A\x0D\x20-\x7E]              # ASCII
	| $NON_ASCII_UTF8
}x;

319
our $typeTypedefs = qr{(?x:
320
	(?:__)?(?:u|s|be|le)(?:8|16|32|64)|
321 322 323
	atomic_t
)};

324
our $logFunctions = qr{(?x:
325
	printk(?:_ratelimited|_once|)|
326
	(?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
327
	WARN(?:_RATELIMIT|_ONCE|)|
328
	panic|
J
Joe Perches 已提交
329 330
	MODULE_[A-Z_]+|
	seq_vprintf|seq_printf|seq_puts
331 332
)};

333 334 335 336 337 338
our $signature_tags = qr{(?xi:
	Signed-off-by:|
	Acked-by:|
	Tested-by:|
	Reviewed-by:|
	Reported-by:|
339
	Suggested-by:|
340 341 342 343
	To:|
	Cc:
)};

344 345
our @typeList = (
	qr{void},
346 347 348 349 350 351 352
	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},
353 354 355 356 357 358 359 360 361 362 363
	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},
);
364 365 366 367 368 369
our @typeListWithAttr = (
	@typeList,
	qr{struct\s+$InitAttribute\s+$Ident},
	qr{union\s+$InitAttribute\s+$Ident},
);

370 371 372
our @modifierList = (
	qr{fastcall},
);
373

374 375 376 377 378 379
our $allowed_asm_includes = qr{(?x:
	irq|
	memory
)};
# memory.h: ARM has a custom one

380
sub build_types {
381 382
	my $mods = "(?x:  \n" . join("|\n  ", @modifierList) . "\n)";
	my $all = "(?x:  \n" . join("|\n  ", @typeList) . "\n)";
383
	my $allWithAttr = "(?x:  \n" . join("|\n  ", @typeListWithAttr) . "\n)";
384
	$Modifier	= qr{(?:$Attribute|$Sparse|$mods)};
385
	$NonptrType	= qr{
386
			(?:$Modifier\s+|const\s+)*
387
			(?:
388
				(?:typeof|__typeof__)\s*\([^\)]*\)|
389
				(?:$typeTypedefs\b)|
390
				(?:${all}\b)
391
			)
392
			(?:\s+$Modifier|\s+const)*
393
		  }x;
394 395 396 397 398 399 400 401 402
	$NonptrTypeWithAttr	= qr{
			(?:$Modifier\s+|const\s+)*
			(?:
				(?:typeof|__typeof__)\s*\([^\)]*\)|
				(?:$typeTypedefs\b)|
				(?:${allWithAttr}\b)
			)
			(?:\s+$Modifier|\s+const)*
		  }x;
403
	$Type	= qr{
404
			$NonptrType
405
			(?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)?
406
			(?:\s+$Inline|\s+$Modifier)*
407 408 409 410
		  }x;
	$Declare	= qr{(?:$Storage\s+)?$Type};
}
build_types();
411

412
our $Typecast	= qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
413 414 415 416 417 418 419

# 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*};
420
our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
421 422 423 424 425 426 427 428 429 430

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

431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
sub seed_camelcase_file {
	my ($file) = @_;

	return if (!(-f $file));

	local $/;

	open(my $include_file, '<', "$file")
	    or warn "$P: Can't read '$file' $!\n";
	my $text = <$include_file>;
	close($include_file);

	my @lines = split('\n', $text);

	foreach my $line (@lines) {
		next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
		if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
			$camelcase{$1} = 1;
449 450 451
		} elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
			$camelcase{$1} = 1;
		} elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
452 453 454 455 456 457 458 459 460 461
			$camelcase{$1} = 1;
		}
	}
}

my $camelcase_seeded = 0;
sub seed_camelcase_includes {
	return if ($camelcase_seeded);

	my $files;
462 463 464 465
	my $camelcase_cache = "";
	my @include_files = ();

	$camelcase_seeded = 1;
466

467
	if (-d ".git") {
468 469
		my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
		chomp $git_last_include_commit;
470
		$camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
471
	} else {
472
		my $last_mod_date = 0;
473
		$files = `find $root/include -name "*.h"`;
474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
		@include_files = split('\n', $files);
		foreach my $file (@include_files) {
			my $date = POSIX::strftime("%Y%m%d%H%M",
						   localtime((stat $file)[9]));
			$last_mod_date = $date if ($last_mod_date < $date);
		}
		$camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
	}

	if ($camelcase_cache ne "" && -f $camelcase_cache) {
		open(my $camelcase_file, '<', "$camelcase_cache")
		    or warn "$P: Can't read '$camelcase_cache' $!\n";
		while (<$camelcase_file>) {
			chomp;
			$camelcase{$_} = 1;
		}
		close($camelcase_file);

		return;
493
	}
494 495 496 497 498 499

	if (-d ".git") {
		$files = `git ls-files "include/*.h"`;
		@include_files = split('\n', $files);
	}

500 501 502
	foreach my $file (@include_files) {
		seed_camelcase_file($file);
	}
503

504
	if ($camelcase_cache ne "") {
505
		unlink glob ".checkpatch-camelcase.*";
506 507
		open(my $camelcase_file, '>', "$camelcase_cache")
		    or warn "$P: Can't write '$camelcase_cache' $!\n";
508 509 510 511 512
		foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
			print $camelcase_file ("$_\n");
		}
		close($camelcase_file);
	}
513 514
}

515 516
$chk_signoff = 0 if ($file);

517
my @rawlines = ();
518
my @lines = ();
519
my @fixed = ();
520
my $vname;
521
for my $filename (@ARGV) {
522
	my $FILE;
523
	if ($file) {
524
		open($FILE, '-|', "diff -u /dev/null $filename") ||
525
			die "$P: $filename: diff failed - $!\n";
526 527
	} elsif ($filename eq '-') {
		open($FILE, '<&STDIN');
528
	} else {
529
		open($FILE, '<', "$filename") ||
530
			die "$P: $filename: open failed - $!\n";
531
	}
532 533 534 535 536
	if ($filename eq '-') {
		$vname = 'Your patch';
	} else {
		$vname = $filename;
	}
537
	while (<$FILE>) {
538 539 540
		chomp;
		push(@rawlines, $_);
	}
541
	close($FILE);
542
	if (!process($filename)) {
543 544 545
		$exit = 1;
	}
	@rawlines = ();
546
	@lines = ();
547
	@fixed = ();
548 549 550 551 552
}

exit($exit);

sub top_of_kernel_tree {
553 554 555 556 557 558 559 560 561 562 563 564
	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;
		}
565
	}
566
	return 1;
567
}
568

569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
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;
588
		$name = trim($name);
589 590 591 592 593 594 595 596 597 598 599 600 601 602
		$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 = "";
		}
	}

603
	$name = trim($name);
604
	$name =~ s/^\"|\"$//g;
605
	$address = trim($address);
606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
	$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;

621
	$name = trim($name);
622
	$name =~ s/^\"|\"$//g;
623
	$address = trim($address);
624 625 626 627 628 629 630 631 632 633 634 635 636 637 638

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

639 640 641 642 643 644 645 646 647 648 649 650
sub which_conf {
	my ($conf) = @_;

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

	return "";
}

651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
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;
}
671
sub copy_spacing {
672
	(my $res = shift) =~ tr/\t/ /c;
673 674
	return $res;
}
675

676 677 678 679 680 681 682 683 684 685 686 687 688
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));
}

689 690 691 692 693 694 695 696 697 698 699
my $sanitise_quote = '';

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

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
700 701 702 703 704 705
sub sanitise_line {
	my ($line) = @_;

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

706
	my $qlen = 0;
707 708
	my $off = 0;
	my $c;
709

710 711 712 713 714 715 716 717 718 719 720 721 722 723
	# 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;
724
		}
725
		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
726 727 728 729
			$sanitise_quote = '';
			substr($res, $off, 2, "$;$;");
			$off++;
			next;
730
		}
731 732 733 734 735 736 737
		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
			$sanitise_quote = '//';

			substr($res, $off, 2, $sanitise_quote);
			$off++;
			next;
		}
738 739 740 741 742 743 744

		# 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;
745
		}
746 747 748 749
		# Regular quotes.
		if ($c eq "'" || $c eq '"') {
			if ($sanitise_quote eq '') {
				$sanitise_quote = $c;
750

751 752 753 754 755 756
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
757

758
		#print "c<$c> SQ<$sanitise_quote>\n";
759 760
		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
			substr($res, $off, 1, $;);
761 762
		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
			substr($res, $off, 1, $;);
763 764 765 766 767
		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
			substr($res, $off, 1, 'X');
		} else {
			substr($res, $off, 1, $c);
		}
768 769
	}

770 771 772 773
	if ($sanitise_quote eq '//') {
		$sanitise_quote = '';
	}

774
	# The pathname on a #include may be surrounded by '<' and '>'.
775
	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
776 777 778 779
		my $clean = 'X' x length($1);
		$res =~ s@\<.*\>@<$clean>@;

	# The whole of a #error is a string.
780
	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
781
		my $clean = 'X' x length($1);
782
		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
783 784
	}

785 786 787
	return $res;
}

788 789 790 791 792 793 794
sub get_quoted_string {
	my ($line, $rawline) = @_;

	return "" if ($line !~ m/(\"[X]+\")/g);
	return substr($rawline, $-[0], $+[0] - $-[0]);
}

795 796 797 798 799 800
sub ctx_statement_block {
	my ($linenr, $remain, $off) = @_;
	my $line = $linenr - 1;
	my $blk = '';
	my $soff = $off;
	my $coff = $off - 1;
801
	my $coff_set = 0;
802

803 804
	my $loff = 0;

805 806
	my $type = '';
	my $level = 0;
807
	my @stack = ();
808
	my $p;
809 810
	my $c;
	my $len = 0;
811 812

	my $remainder;
813
	while (1) {
814 815
		@stack = (['', 0]) if ($#stack == -1);

816
		#warn "CSB: blk<$blk> remain<$remain>\n";
817 818 819 820
		# If we are about to drop off the end, pull in more
		# context.
		if ($off >= $len) {
			for (; $remain > 0; $line++) {
821
				last if (!defined $lines[$line]);
822
				next if ($lines[$line] =~ /^-/);
823
				$remain--;
824
				$loff = $len;
825
				$blk .= $lines[$line] . "\n";
826 827 828 829 830 831
				$len = length($blk);
				$line++;
				last;
			}
			# Bail if there is no further context.
			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
832
			if ($off >= $len) {
833 834
				last;
			}
835 836 837 838
			if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
				$level++;
				$type = '#';
			}
839
		}
840
		$p = $c;
841
		$c = substr($blk, $off, 1);
842
		$remainder = substr($blk, $off);
843

844
		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
845 846 847 848 849 850 851 852 853 854

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

855 856 857 858 859 860
		# Statement ends at the ';' or a close '}' at the
		# outermost level.
		if ($level == 0 && $c eq ';') {
			last;
		}

861
		# An else is really a conditional as long as its not else if
862 863 864 865 866 867 868 869
		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";
870 871
		}

872 873 874 875 876 877 878 879 880 881
		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;
882 883
				$coff_set = 1;
				#warn "CSB: mark coff<$coff>\n";
884 885 886 887 888 889 890 891 892 893 894
			}
		}
		if (($type eq '' || $type eq '{') && $c eq '{') {
			$level++;
			$type = '{';
		}
		if ($type eq '{' && $c eq '}') {
			$level--;
			$type = ($level != 0)? '{' : '';

			if ($level == 0) {
895 896 897
				if (substr($blk, $off + 1, 1) eq ';') {
					$off++;
				}
898 899 900
				last;
			}
		}
901 902 903 904 905 906 907
		# Preprocessor commands end at the newline unless escaped.
		if ($type eq '#' && $c eq "\n" && $p ne "\\") {
			$level--;
			$type = '';
			$off++;
			last;
		}
908 909
		$off++;
	}
910
	# We are truly at the end, so shuffle to the next line.
911
	if ($off == $len) {
912
		$loff = $len + 1;
913 914 915
		$line++;
		$remain--;
	}
916 917 918 919 920 921 922

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

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

923
	#print "coff<$coff> soff<$off> loff<$loff>\n";
924 925 926 927 928

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

929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971
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;
	}
}

972 973 974 975 976 977
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

978
	# Grab the first conditional/block pair.
979 980
	($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
981
	#print "F: c<$condition> s<$statement> remain<$remain>\n";
982 983 984 985 986 987 988
	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.
989 990 991
	for (;;) {
		($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
992
		#print "C: c<$condition> s<$statement> remain<$remain>\n";
993
		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
994 995
		#print "C: push\n";
		push(@chunks, [ $condition, $statement ]);
996 997 998
	}

	return ($level, $linenr, @chunks);
999 1000
}

1001
sub ctx_block_get {
1002
	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1003 1004 1005 1006 1007 1008 1009
	my $line;
	my $start = $linenr - 1;
	my $blk = '';
	my @o;
	my @c;
	my @res = ();

1010
	my $level = 0;
1011
	my @stack = ($level);
1012 1013 1014 1015 1016
	for ($line = $start; $remain > 0; $line++) {
		next if ($rawlines[$line] =~ /^-/);
		$remain--;

		$blk .= $rawlines[$line];
1017 1018

		# Handle nested #if/#else.
1019
		if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1020
			push(@stack, $level);
1021
		} elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1022
			$level = $stack[$#stack - 1];
1023
		} elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1024 1025 1026
			$level = pop(@stack);
		}

1027
		foreach my $c (split(//, $lines[$line])) {
1028 1029 1030 1031 1032
			##print "C<$c>L<$level><$open$close>O<$off>\n";
			if ($off > 0) {
				$off--;
				next;
			}
1033

1034 1035 1036 1037 1038 1039 1040
			if ($c eq $close && $level > 0) {
				$level--;
				last if ($level == 0);
			} elsif ($c eq $open) {
				$level++;
			}
		}
1041

1042
		if (!$outer || $level <= 1) {
1043
			push(@res, $rawlines[$line]);
1044 1045
		}

1046
		last if ($level == 0);
1047 1048
	}

1049
	return ($level, @res);
1050 1051 1052 1053
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

1054 1055
	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
	return @r;
1056 1057 1058 1059
}
sub ctx_block {
	my ($linenr, $remain) = @_;

1060 1061
	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
	return @r;
1062 1063
}
sub ctx_statement {
1064 1065 1066 1067 1068 1069
	my ($linenr, $remain, $off) = @_;

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

1072
	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1073
}
1074 1075 1076 1077 1078
sub ctx_statement_level {
	my ($linenr, $remain, $off) = @_;

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
1079 1080 1081 1082 1083

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

	# Catch a comment on the end of the line itself.
1084
	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1085 1086 1087 1088 1089 1090 1091
	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++) {
1092 1093
		my $line = $rawlines[$linenr - 1];
		#warn "           $line\n";
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
		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);

1116
	##print "LINE: $rawlines[$end_line - 1 ]\n";
1117 1118 1119 1120 1121
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137
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;
}

1138 1139 1140
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
1141

1142 1143 1144 1145 1146 1147
	$res = '';
	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
		$res .= $1;
		if ($2 ne '') {
			$coded = sprintf("^%c", unpack('C', $2) + 64);
			$res .= $coded;
1148 1149
		}
	}
1150
	$res =~ s/$/\$/;
1151

1152
	return $res;
1153 1154
}

1155
my $av_preprocessor = 0;
1156
my $av_pending;
1157
my @av_paren_type;
1158
my $av_pend_colon;
1159 1160 1161

sub annotate_reset {
	$av_preprocessor = 0;
1162 1163
	$av_pending = '_';
	@av_paren_type = ('E');
1164
	$av_pend_colon = 'O';
1165 1166
}

1167 1168
sub annotate_values {
	my ($stream, $type) = @_;
1169

1170
	my $res;
1171
	my $var = '_' x length($stream);
1172 1173
	my $cur = $stream;

1174
	print "$stream\n" if ($dbg_values > 1);
1175 1176

	while (length($cur)) {
1177
		@av_paren_type = ('E') if ($#av_paren_type < 0);
1178
		print " <" . join('', @av_paren_type) .
1179
				"> <$type> <$av_pending>" if ($dbg_values > 1);
1180
		if ($cur =~ /^(\s+)/o) {
1181 1182
			print "WS($1)\n" if ($dbg_values > 1);
			if ($1 =~ /\n/ && $av_preprocessor) {
1183
				$type = pop(@av_paren_type);
1184
				$av_preprocessor = 0;
1185 1186
			}

1187
		} elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1188 1189
			print "CAST($1)\n" if ($dbg_values > 1);
			push(@av_paren_type, $type);
1190
			$type = 'c';
1191

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

1196 1197 1198 1199
		} elsif ($cur =~ /^($Modifier)\s*/) {
			print "MODIFIER($1)\n" if ($dbg_values > 1);
			$type = 'T';

1200
		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1201
			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1202
			$av_preprocessor = 1;
1203 1204 1205 1206 1207 1208
			push(@av_paren_type, $type);
			if ($2 ne '') {
				$av_pending = 'N';
			}
			$type = 'E';

1209
		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1210 1211 1212
			print "UNDEF($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;
			push(@av_paren_type, $type);
1213

1214
		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1215
			print "PRE_START($1)\n" if ($dbg_values > 1);
1216
			$av_preprocessor = 1;
1217 1218 1219

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
1220
			$type = 'E';
1221

1222
		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1223 1224 1225 1226 1227
			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;

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

1228
			$type = 'E';
1229

1230
		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1231 1232 1233 1234 1235 1236 1237 1238
			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);
1239
			$type = 'E';
1240 1241

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

1244 1245 1246 1247 1248
		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
			print "ATTR($1)\n" if ($dbg_values > 1);
			$av_pending = $type;
			$type = 'N';

1249
		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1250
			print "SIZEOF($1)\n" if ($dbg_values > 1);
1251
			if (defined $2) {
1252
				$av_pending = 'V';
1253 1254 1255
			}
			$type = 'N';

1256
		} elsif ($cur =~ /^(if|while|for)\b/o) {
1257
			print "COND($1)\n" if ($dbg_values > 1);
1258
			$av_pending = 'E';
1259 1260
			$type = 'N';

1261 1262 1263 1264 1265
		} elsif ($cur =~/^(case)/o) {
			print "CASE($1)\n" if ($dbg_values > 1);
			$av_pend_colon = 'C';
			$type = 'N';

1266
		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1267
			print "KEYWORD($1)\n" if ($dbg_values > 1);
1268 1269 1270
			$type = 'N';

		} elsif ($cur =~ /^(\()/o) {
1271
			print "PAREN('$1')\n" if ($dbg_values > 1);
1272 1273
			push(@av_paren_type, $av_pending);
			$av_pending = '_';
1274 1275 1276
			$type = 'N';

		} elsif ($cur =~ /^(\))/o) {
1277 1278 1279
			my $new_type = pop(@av_paren_type);
			if ($new_type ne '_') {
				$type = $new_type;
1280 1281
				print "PAREN('$1') -> $type\n"
							if ($dbg_values > 1);
1282
			} else {
1283
				print "PAREN('$1')\n" if ($dbg_values > 1);
1284 1285
			}

1286
		} elsif ($cur =~ /^($Ident)\s*\(/o) {
1287
			print "FUNC($1)\n" if ($dbg_values > 1);
1288
			$type = 'V';
1289
			$av_pending = 'V';
1290

1291 1292
		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
			if (defined $2 && $type eq 'C' || $type eq 'T') {
1293
				$av_pend_colon = 'B';
1294 1295
			} elsif ($type eq 'E') {
				$av_pend_colon = 'L';
1296 1297 1298 1299
			}
			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
			$type = 'V';

1300
		} elsif ($cur =~ /^($Ident|$Constant)/o) {
1301
			print "IDENT($1)\n" if ($dbg_values > 1);
1302 1303 1304
			$type = 'V';

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

1308
		} elsif ($cur =~/^(;|{|})/) {
1309
			print "END($1)\n" if ($dbg_values > 1);
1310
			$type = 'E';
1311 1312
			$av_pend_colon = 'O';

1313 1314 1315 1316
		} elsif ($cur =~/^(,)/) {
			print "COMMA($1)\n" if ($dbg_values > 1);
			$type = 'C';

1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330
		} 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';
1331

1332
		} elsif ($cur =~ /^(\[)/o) {
1333
			print "CLOSE($1)\n" if ($dbg_values > 1);
1334 1335
			$type = 'N';

1336
		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348
			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';

1349
		} elsif ($cur =~ /^($Operators)/o) {
1350
			print "OP($1)\n" if ($dbg_values > 1);
1351 1352 1353 1354 1355
			if ($1 ne '++' && $1 ne '--') {
				$type = 'N';
			}

		} elsif ($cur =~ /(^.)/o) {
1356
			print "C($1)\n" if ($dbg_values > 1);
1357 1358 1359 1360 1361
		}
		if (defined $1) {
			$cur = substr($cur, length($1));
			$res .= $type x length($1);
		}
1362
	}
1363

1364
	return ($res, $var);
1365 1366
}

1367
sub possible {
1368
	my ($possible, $line) = @_;
1369
	my $notPermitted = qr{(?:
1370 1371 1372 1373
		^(?:
			$Modifier|
			$Storage|
			$Type|
1374 1375 1376
			DEFINE_\S+
		)$|
		^(?:
1377 1378 1379 1380 1381
			goto|
			return|
			case|
			else|
			asm|__asm__|
1382 1383 1384
			do|
			\#|
			\#\#|
1385
		)(?:\s|$)|
1386
		^(?:typedef|struct|enum)\b
1387 1388 1389
	    )}x;
	warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
	if ($possible !~ $notPermitted) {
1390 1391 1392 1393 1394 1395 1396
		# 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;
1397
			for my $modifier (split(' ', $possible)) {
1398 1399 1400 1401
				if ($modifier !~ $notPermitted) {
					warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
					push(@modifierList, $modifier);
				}
1402
			}
1403 1404 1405 1406 1407

		} else {
			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
			push(@typeList, $possible);
		}
1408
		build_types();
1409 1410
	} else {
		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1411 1412 1413
	}
}

1414 1415
my $prefix = '';

1416
sub show_type {
1417 1418 1419
	return defined $use_type{$_[0]} if (scalar keys %use_type > 0);

	return !defined $ignore_type{$_[0]};
1420 1421
}

1422
sub report {
1423 1424
	if (!show_type($_[1]) ||
	    (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
1425 1426
		return 0;
	}
1427 1428 1429 1430 1431 1432
	my $line;
	if ($show_types) {
		$line = "$prefix$_[0]:$_[1]: $_[2]\n";
	} else {
		$line = "$prefix$_[0]: $_[2]\n";
	}
1433 1434
	$line = (split('\n', $line))[0] . "\n" if ($terse);

1435
	push(our @report, $line);
1436 1437

	return 1;
1438 1439
}
sub report_dump {
1440
	our @report;
1441
}
1442

1443
sub ERROR {
1444
	if (report("ERROR", $_[0], $_[1])) {
1445 1446
		our $clean = 0;
		our $cnt_error++;
1447
		return 1;
1448
	}
1449
	return 0;
1450 1451
}
sub WARN {
1452
	if (report("WARNING", $_[0], $_[1])) {
1453 1454
		our $clean = 0;
		our $cnt_warn++;
1455
		return 1;
1456
	}
1457
	return 0;
1458 1459
}
sub CHK {
1460
	if ($check && report("CHECK", $_[0], $_[1])) {
1461 1462
		our $clean = 0;
		our $cnt_chk++;
1463
		return 1;
1464
	}
1465
	return 0;
1466 1467
}

1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490
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 ".../") {
1491 1492
		WARN("USE_RELATIVE_PATH",
		     "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1493 1494 1495
	}
}

1496 1497 1498
sub trim {
	my ($string) = @_;

1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515
	$string =~ s/^\s+|\s+$//g;

	return $string;
}

sub ltrim {
	my ($string) = @_;

	$string =~ s/^\s+//;

	return $string;
}

sub rtrim {
	my ($string) = @_;

	$string =~ s/\s+$//;
1516 1517 1518 1519

	return $string;
}

1520 1521 1522 1523 1524 1525 1526 1527
sub string_find_replace {
	my ($string, $find, $replace) = @_;

	$string =~ s/$find/$replace/g;

	return $string;
}

1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542
sub tabify {
	my ($leading) = @_;

	my $source_indent = 8;
	my $max_spaces_before_tab = $source_indent - 1;
	my $spaces_to_tab = " " x $source_indent;

	#convert leading spaces to tabs
	1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
	#Remove spaces before a tab
	1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;

	return "$leading";
}

1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572
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;
}

1573 1574 1575 1576 1577
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
1578
	my $prevrawline="";
1579
	my $stashline="";
1580
	my $stashrawline="";
1581

1582
	my $length;
1583 1584 1585 1586
	my $indent;
	my $previndent=0;
	my $stashindent=0;

1587
	our $clean = 1;
1588 1589 1590
	my $signoff = 0;
	my $is_patch = 0;

1591 1592 1593
	my $in_header_lines = 1;
	my $in_commit_log = 0;		#Scanning lines before patch

1594 1595
	my $non_utf8_charset = 0;

1596
	our @report = ();
1597 1598 1599 1600 1601
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

1602 1603 1604 1605 1606 1607
	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
	my $in_comment = 0;
1608
	my $comment_edge = 0;
1609
	my $first_line = 0;
1610
	my $p1_prefix = '';
1611

1612 1613 1614
	my $prev_values = 'E';

	# suppression flags
1615
	my %suppress_ifbraces;
1616
	my %suppress_whiletrailers;
1617
	my %suppress_export;
1618
	my $suppress_statement = 0;
1619

1620
	my %signatures = ();
1621

1622
	# Pre-scan the patch sanitizing the lines.
1623
	# Pre-scan the patch looking for any __setup documentation.
1624
	#
1625 1626
	my @setup_docs = ();
	my $setup_docs = 0;
1627

1628 1629
	my $camelcase_file_seeded = 0;

1630
	sanitise_line_reset();
1631 1632
	my $line;
	foreach my $rawline (@rawlines) {
1633 1634
		$linenr++;
		$line = $rawline;
1635

1636 1637
		push(@fixed, $rawline) if ($fix);

1638
		if ($rawline=~/^\+\+\+\s+(\S+)/) {
1639 1640 1641 1642
			$setup_docs = 0;
			if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
				$setup_docs = 1;
			}
1643 1644 1645 1646 1647 1648 1649 1650 1651
			#next;
		}
		if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1652
			$in_comment = 0;
1653 1654 1655 1656 1657 1658

			# 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;
1659 1660 1661 1662 1663 1664
			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";
1665
				last if (!defined $rawlines[$ln - 1]);
1666 1667 1668 1669 1670
				if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
				    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
					($edge) = $1;
					last;
				}
1671 1672 1673 1674 1675 1676 1677 1678 1679
			}
			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 &&
1680
			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1681 1682 1683 1684 1685 1686 1687
			{
				$in_comment = 1;
			}

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

1688
		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1689
			# Standardise the strings and chars within the input to
1690
			# simplify matching -- only bother with positive lines.
1691
			$line = sanitise_line($rawline);
1692
		}
1693 1694 1695 1696 1697 1698 1699 1700 1701 1702
		push(@lines, $line);

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

		#print "==>$rawline\n";
		#print "-->$line\n";
1703 1704 1705 1706 1707 1708

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

1709 1710
	$prefix = '';

1711 1712
	$realcnt = 0;
	$linenr = 0;
1713 1714
	foreach my $line (@lines) {
		$linenr++;
1715 1716
		my $sline = $line;	#copy of $line
		$sline =~ s/$;/ /g;	#with comments as spaces
1717

1718
		my $rawline = $rawlines[$linenr - 1];
1719

1720
#extract the line range in the file after the patch is applied
1721
		if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1722
			$is_patch = 1;
1723
			$first_line = $linenr + 1;
1724 1725 1726 1727 1728 1729
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1730
			annotate_reset();
1731 1732
			$prev_values = 'E';

1733
			%suppress_ifbraces = ();
1734
			%suppress_whiletrailers = ();
1735
			%suppress_export = ();
1736
			$suppress_statement = 0;
1737 1738
			next;

1739 1740 1741
# 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.
1742
		} elsif ($line =~ /^( |\+|$)/) {
1743
			$realline++;
1744
			$realcnt-- if ($realcnt != 0);
1745

1746
			# Measure the line length and indent.
1747
			($length, $indent) = line_stats($rawline);
1748 1749 1750 1751

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

1754
			#warn "line<$line>\n";
1755

1756 1757
		} elsif ($realcnt == 1) {
			$realcnt--;
1758 1759
		}

1760 1761
		my $hunk_line = ($realcnt != 0);

1762
#make up the handle for any error we report on this line
1763 1764 1765
		$prefix = "$filename:$realline: " if ($emacs && $file);
		$prefix = "$filename:$linenr: " if ($emacs && !$file);

1766 1767
		$here = "#$linenr: " if (!$file);
		$here = "#$realline: " if ($file);
1768 1769

		# extract the filename as it passes
1770 1771
		if ($line =~ /^diff --git.*?(\S+)$/) {
			$realfile = $1;
1772
			$realfile =~ s@^([^/]*)/@@ if (!$file);
1773
			$in_commit_log = 0;
1774
		} elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1775
			$realfile = $1;
1776
			$realfile =~ s@^([^/]*)/@@ if (!$file);
1777
			$in_commit_log = 0;
1778 1779

			$p1_prefix = $1;
1780 1781
			if (!$file && $tree && $p1_prefix ne '' &&
			    -e "$root/$p1_prefix") {
1782 1783
				WARN("PATCH_PREFIX",
				     "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1784
			}
1785

1786
			if ($realfile =~ m@^include/asm/@) {
1787 1788
				ERROR("MODIFIED_INCLUDE_ASM",
				      "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1789 1790 1791 1792
			}
			next;
		}

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

1795 1796 1797
		my $hereline = "$here\n$rawline\n";
		my $herecurr = "$here\n$rawline\n";
		my $hereprev = "$here\n$prevrawline\n$rawline\n";
1798

1799 1800
		$cnt_lines++ if ($realcnt != 0);

1801 1802 1803
# Check for incorrect file permissions
		if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
			my $permhere = $here . "FILE: $realfile\n";
1804 1805
			if ($realfile !~ m@scripts/@ &&
			    $realfile !~ /\.(py|pl|awk|sh)$/) {
1806 1807
				ERROR("EXECUTE_PERMISSIONS",
				      "do not set execute permissions for source files\n" . $permhere);
1808 1809 1810
			}
		}

1811
# Check the patch for a signoff:
1812
		if ($line =~ /^\s*signed-off-by:/i) {
1813
			$signoff++;
1814
			$in_commit_log = 0;
1815 1816 1817
		}

# Check signature styles
1818
		if (!$in_header_lines &&
1819
		    $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
1820 1821 1822 1823 1824 1825
			my $space_before = $1;
			my $sign_off = $2;
			my $space_after = $3;
			my $email = $4;
			my $ucfirst_sign_off = ucfirst(lc($sign_off));

1826 1827 1828 1829
			if ($sign_off !~ /$signature_tags/) {
				WARN("BAD_SIGN_OFF",
				     "Non-standard signature: $sign_off\n" . $herecurr);
			}
1830
			if (defined $space_before && $space_before ne "") {
1831 1832 1833 1834 1835 1836
				if (WARN("BAD_SIGN_OFF",
					 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
				    $fix) {
					$fixed[$linenr - 1] =
					    "$ucfirst_sign_off $email";
				}
1837 1838
			}
			if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
1839 1840 1841 1842 1843 1844 1845
				if (WARN("BAD_SIGN_OFF",
					 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
				    $fix) {
					$fixed[$linenr - 1] =
					    "$ucfirst_sign_off $email";
				}

1846 1847
			}
			if (!defined $space_after || $space_after ne " ") {
1848 1849 1850 1851 1852 1853
				if (WARN("BAD_SIGN_OFF",
					 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
				    $fix) {
					$fixed[$linenr - 1] =
					    "$ucfirst_sign_off $email";
				}
1854
			}
1855 1856 1857 1858

			my ($email_name, $email_address, $comment) = parse_email($email);
			my $suggested_email = format_email(($email_name, $email_address));
			if ($suggested_email eq "") {
1859 1860
				ERROR("BAD_SIGN_OFF",
				      "Unrecognized email address: '$email'\n" . $herecurr);
1861 1862 1863 1864 1865 1866 1867 1868 1869
			} 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) {
1870 1871
					WARN("BAD_SIGN_OFF",
					     "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
1872
				}
1873
			}
1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884

# Check for duplicate signatures
			my $sig_nospace = $line;
			$sig_nospace =~ s/\s//g;
			$sig_nospace = lc($sig_nospace);
			if (defined $signatures{$sig_nospace}) {
				WARN("BAD_SIGN_OFF",
				     "Duplicate signature\n" . $herecurr);
			} else {
				$signatures{$sig_nospace} = 1;
			}
1885 1886
		}

1887
# Check for wrappage within a valid hunk of the file
1888
		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1889 1890
			ERROR("CORRUPTED_PATCH",
			      "patch seems to be corrupt (line wrapped?)\n" .
1891
				$herecurr) if (!$emitted_corrupt++);
1892 1893
		}

1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907
# 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);
				}
			}
		}

1908 1909
# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1910 1911 1912 1913 1914 1915 1916
		    $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";

1917 1918
			CHK("INVALID_UTF8",
			    "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1919 1920
		}

1921 1922 1923
# 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 =~ /^$/ &&
1924
		    $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
1925 1926 1927 1928
			$in_header_lines = 0;
			$in_commit_log = 1;
		}

1929 1930 1931 1932 1933 1934 1935 1936 1937
# 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 =~ /^$/ &&
1938
		    $rawline =~ /$NON_ASCII_UTF8/) {
1939
			WARN("UTF8_BEFORE_PATCH",
1940 1941 1942
			    "8-bit UTF-8 used in possible commit log\n" . $herecurr);
		}

1943 1944
# ignore non-hunk lines and lines being removed
		next if (!$hunk_line || $line =~ /^-/);
1945 1946

#trailing whitespace
1947
		if ($line =~ /^\+.*\015/) {
1948
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1949 1950 1951 1952 1953
			if (ERROR("DOS_LINE_ENDINGS",
				  "DOS line endings\n" . $herevet) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/[\s\015]+$//;
			}
1954 1955
		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1956 1957 1958
			if (ERROR("TRAILING_WHITESPACE",
				  "trailing whitespace\n" . $herevet) &&
			    $fix) {
1959
				$fixed[$linenr - 1] =~ s/\s+$//;
1960 1961
			}

1962
			$rpt_cleaners = 1;
1963
		}
1964

1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976
# Check for FSF mailing addresses.
		if ($rawline =~ /You should have received a copy/ ||
		    $rawline =~ /write to the Free Software/ ||
		    $rawline =~ /59 Temple Place/ ||
		    $rawline =~ /51 Franklin Street/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
			my $msg_type = \&ERROR;
			$msg_type = \&CHK if ($file);
			&{$msg_type}("FSF_MAILING_ADDRESS",
				"Do not include the paragraph about writing to the Free Software Foundation's mailing address from the sample GPL notice. The FSF has changed addresses in the past, and may do so again. Linux already includes a copy of the GPL.\n" . $herevet)
		}

1977
# check for Kconfig help text having a real description
1978 1979
# Only applies when adding the entry originally, after that we do not have
# sufficient context to determine whether it is indeed long enough.
1980
		if ($realfile =~ /Kconfig/ &&
1981
		    $line =~ /.\s*config\s+/) {
1982
			my $length = 0;
1983 1984 1985
			my $cnt = $realcnt;
			my $ln = $linenr + 1;
			my $f;
1986
			my $is_start = 0;
1987
			my $is_end = 0;
1988
			for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
1989 1990 1991 1992 1993
				$f = $lines[$ln - 1];
				$cnt-- if ($lines[$ln - 1] !~ /^-/);
				$is_end = $lines[$ln - 1] =~ /^\+/;

				next if ($f =~ /^-/);
1994 1995 1996 1997 1998 1999 2000

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

2001
				$f =~ s/^.//;
2002 2003 2004
				$f =~ s/#.*//;
				$f =~ s/^\s+//;
				next if ($f =~ /^$/);
2005 2006 2007 2008
				if ($f =~ /^\s*config\s/) {
					$is_end = 1;
					last;
				}
2009 2010
				$length++;
			}
2011
			WARN("CONFIG_DESCRIPTION",
2012 2013
			     "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";
2014 2015
		}

2016 2017 2018 2019 2020 2021 2022
# 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");
		}

2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036
		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});
		}

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

2040
#line length limit
2041
		if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
2042
		    $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
2043
		    !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
2044
		    $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
2045
		    $length > $max_line_length)
2046
		{
2047
			WARN("LONG_LINE",
2048
			     "line over $max_line_length characters\n" . $herecurr);
2049 2050
		}

2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065
# 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);
		}

2066 2067
# check for spaces before a quoted newline
		if ($rawline =~ /^.*\".*\s\\n/) {
2068 2069 2070 2071 2072 2073
			if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
				 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
			}

2074 2075
		}

2076 2077
# check for adding lines without a newline.
		if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2078 2079
			WARN("MISSING_EOF_NEWLINE",
			     "adding a line without newline at end of file\n" . $herecurr);
2080 2081
		}

2082 2083 2084 2085
# 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";
2086 2087
				ERROR("LO_MACRO",
				      "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2088 2089 2090
			}
			if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
				my $herevet = "$here\n" . cat_vet($line) . "\n";
2091 2092
				ERROR("HI_MACRO",
				      "use the HI() macro, not (... >> 16)\n" . $herevet);
2093 2094 2095
			}
		}

2096 2097
# check we are in a valid source file C or perl if not then ignore this hunk
		next if ($realfile !~ /\.(h|c|pl)$/);
2098 2099 2100

# at the beginning of a line any tabs must come first and anything
# more than 8 must use tabs.
2101 2102 2103
		if ($rawline =~ /^\+\s* \t\s*\S/ ||
		    $rawline =~ /^\+\s*        \s*/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2104
			$rpt_cleaners = 1;
2105 2106 2107 2108 2109
			if (ERROR("CODE_INDENT",
				  "code indent should use tabs where possible\n" . $herevet) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
			}
2110 2111
		}

2112 2113 2114
# check for space before tabs.
		if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2115 2116 2117 2118 2119 2120
			if (WARN("SPACE_BEFORE_TAB",
				"please, no space before tabs\n" . $herevet) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/(^\+.*) +\t/$1\t/;
			}
2121 2122
		}

2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137
# 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 已提交
2138 2139
				$line =~ /^(\+| )([ \t]*)/;
				my $newindent = $2;
2140 2141 2142 2143 2144 2145 2146 2147

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

				if ($newindent ne $goodtabindent &&
				    $newindent ne $goodspaceindent) {
2148 2149 2150 2151 2152 2153 2154

					if (CHK("PARENTHESIS_ALIGNMENT",
						"Alignment should match open parenthesis\n" . $hereprev) &&
					    $fix && $line =~ /^\+/) {
						$fixed[$linenr - 1] =~
						    s/^\+[ \t]*/\+$goodtabindent/;
					}
2155 2156 2157 2158
				}
			}
		}

2159
		if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
2160 2161 2162 2163 2164 2165
			if (CHK("SPACING",
				"No space is necessary after a cast\n" . $hereprev) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/^(\+.*\*[ \t]*\))[ \t]+/$1/;
			}
2166 2167
		}

2168
		if ($realfile =~ m@^(drivers/net/|net/)@ &&
2169 2170
		    $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
		    $rawline =~ /^\+[ \t]*\*/) {
2171 2172 2173 2174 2175
			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
			     "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
		}

		if ($realfile =~ m@^(drivers/net/|net/)@ &&
2176 2177
		    $prevrawline =~ /^\+[ \t]*\/\*/ &&		#starting /*
		    $prevrawline !~ /\*\/[ \t]*$/ &&		#no trailing */
2178
		    $rawline =~ /^\+/ &&			#line is new
2179 2180 2181 2182 2183 2184
		    $rawline !~ /^\+[ \t]*\*/) {		#no leading *
			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
			     "networking block comments start with * on subsequent lines\n" . $hereprev);
		}

		if ($realfile =~ m@^(drivers/net/|net/)@ &&
2185 2186 2187 2188
		    $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ &&	#trailing */
		    $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ &&	#inline /*...*/
		    $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ &&	#trailing **/
		    $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) {	#non blank */
2189 2190 2191 2192
			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
			     "networking block comments put the trailing */ on a separate line\n" . $herecurr);
		}

2193
# check for spaces at the beginning of a line.
2194 2195 2196 2197
# Exceptions:
#  1) within comments
#  2) indented preprocessor commands
#  3) hanging labels
2198
		if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/)  {
2199
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2200 2201 2202 2203 2204
			if (WARN("LEADING_SPACE",
				 "please, no spaces at the start of a line\n" . $herevet) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
			}
2205 2206
		}

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

2210 2211 2212 2213 2214 2215
# 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");
		}

2216
# check for RCS/CVS revision markers
2217
		if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
2218 2219
			WARN("CVS_KEYWORD",
			     "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
2220
		}
2221

2222 2223 2224
# Blackfin: don't use __builtin_bfin_[cs]sync
		if ($line =~ /__builtin_bfin_csync/) {
			my $herevet = "$here\n" . cat_vet($line) . "\n";
2225 2226
			ERROR("CSYNC",
			      "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
2227 2228 2229
		}
		if ($line =~ /__builtin_bfin_ssync/) {
			my $herevet = "$here\n" . cat_vet($line) . "\n";
2230 2231
			ERROR("SSYNC",
			      "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
2232 2233
		}

2234 2235 2236 2237 2238 2239
# check for old HOTPLUG __dev<foo> section markings
		if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
			WARN("HOTPLUG_SECTION",
			     "Using $1 is unnecessary\n" . $herecurr);
		}

2240
# Check for potential 'bare' types
2241 2242
		my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
		    $realline_next);
2243 2244
#print "LINE<$line>\n";
		if ($linenr >= $suppress_statement &&
2245
		    $realcnt && $sline =~ /.\s*\S/) {
2246
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2247
				ctx_statement_block($linenr, $realcnt, 0);
2248 2249 2250
			$stat =~ s/\n./\n /g;
			$cond =~ s/\n./\n /g;

2251 2252 2253 2254 2255 2256 2257 2258 2259
#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;
			}
2260

2261 2262 2263 2264 2265 2266 2267 2268
			# 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++;
			}

2269 2270
			my $s = $stat;
			$s =~ s/{.*$//s;
2271

2272
			# Ignore goto labels.
2273
			if ($s =~ /$Ident:\*$/s) {
2274 2275

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

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

2280
			# declarations always start with types
2281
			} 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) {
2282 2283 2284 2285
				my $type = $1;
				$type =~ s/\s+/ /g;
				possible($type, "A:" . $s);

2286
			# definitions in global scope can only start with types
2287
			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
2288
				possible($1, "B:" . $s);
2289
			}
2290 2291

			# any (foo ... *) is a pointer cast, and foo is a type
2292
			while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
2293
				possible($1, "C:" . $s);
2294 2295 2296 2297 2298
			}

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

2302
				my $ctx = $s;
2303
				substr($ctx, 0, $name_len + 1, '');
2304
				$ctx =~ s/\)[^\)]*$//;
2305

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

2309
						possible($1, "D:" . $s);
2310 2311
					}
				}
2312
			}
2313

2314 2315
		}

2316 2317 2318
#
# Checks which may be anchored in the context.
#
2319

2320 2321
# Check for switch () and associated case and default
# statements should be at the same indent.
2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337
		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 '') {
2338 2339
				ERROR("SWITCH_CASE_INDENT_LEVEL",
				      "switch and case should be at the same indent\n$hereline$err");
2340 2341 2342 2343 2344
			}
		}

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

2348
			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2349 2350 2351 2352 2353 2354

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

2355 2356 2357
			my $ctx_cnt = $realcnt - $#ctx - 1;
			my $ctx = join("\n", @ctx);

2358 2359
			my $ctx_ln = $linenr;
			my $ctx_skip = $realcnt;
2360

2361 2362 2363 2364 2365
			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] !~ /^-/);
2366 2367
				$ctx_ln++;
			}
2368

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

2372
			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2373 2374
				ERROR("OPEN_BRACE",
				      "that open brace { should be on the previous line\n" .
2375
					"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2376
			}
2377 2378 2379 2380
			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
			    $ctx =~ /\)\s*\;\s*$/ &&
			    defined $lines[$ctx_ln - 1])
			{
2381 2382
				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
				if ($nindent > $indent) {
2383 2384
					WARN("TRAILING_SEMICOLON",
					     "trailing semicolon indicates no statements, indent implies otherwise\n" .
2385
						"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2386 2387
				}
			}
2388 2389
		}

2390 2391
# Check relative indent for conditionals and blocks.
		if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2392 2393 2394
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
2395 2396 2397 2398 2399 2400 2401 2402 2403 2404
			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.
2405 2406
			my @newlines = ($c =~ /\n/gs);
			my $cond_lines = 1 + $#newlines;
2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419

			# 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;
			}
2420
			if ($s =~ s/^\s*?\n//) {
2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431
				$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;
			}

2432
			my $cond_ptr = -1;
2433
			$continuation = 0;
2434 2435 2436
			while ($cond_ptr != $cond_lines) {
				$cond_ptr = $cond_lines;

2437 2438 2439 2440 2441 2442
				# If we see an #else/#elif then the code
				# is not linear.
				if ($s =~ /^\s*\#\s*(?:else|elif)/) {
					$check = 0;
				}

2443 2444 2445 2446
				# Ignore:
				#  1) blank lines, they should be at 0,
				#  2) preprocessor lines, and
				#  3) labels.
2447 2448
				if ($continuation ||
				    $s =~ /^\s*?\n/ ||
2449 2450
				    $s =~ /^\s*#\s*?/ ||
				    $s =~ /^\s*$Ident\s*:/) {
2451
					$continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2452 2453 2454
					if ($s =~ s/^.*?\n//) {
						$cond_lines++;
					}
2455
				}
2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470
			}

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

2471
			#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";
2472 2473 2474

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

2480 2481
		# Track the 'values' across context and added lines.
		my $opline = $line; $opline =~ s/^./ /;
2482 2483
		my ($curr_values, $curr_vars) =
				annotate_values($opline . "\n", $prev_values);
2484
		$curr_values = $prev_values . $curr_values;
2485 2486
		if ($dbg_values) {
			my $outline = $opline; $outline =~ s/\t/ /g;
2487 2488
			print "$linenr > .$outline\n";
			print "$linenr > $curr_values\n";
2489
			print "$linenr >  $curr_vars\n";
2490
		}
2491 2492
		$prev_values = substr($curr_values, -1);

2493
#ignore lines not being added
2494
		next if ($line =~ /^[^\+]/);
2495

2496
# TEST: allow direct testing of the type matcher.
2497 2498
		if ($dbg_type) {
			if ($line =~ /^.\s*$Declare\s*$/) {
2499 2500
				ERROR("TEST_TYPE",
				      "TEST: is type\n" . $herecurr);
2501
			} elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2502 2503
				ERROR("TEST_NOT_TYPE",
				      "TEST: is not type ($1 is)\n". $herecurr);
2504
			}
2505 2506
			next;
		}
2507 2508
# TEST: allow direct testing of the attribute matcher.
		if ($dbg_attr) {
2509
			if ($line =~ /^.\s*$Modifier\s*$/) {
2510 2511
				ERROR("TEST_ATTR",
				      "TEST: is attr\n" . $herecurr);
2512
			} elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2513 2514
				ERROR("TEST_NOT_ATTR",
				      "TEST: is not attr ($1 is)\n". $herecurr);
2515 2516 2517
			}
			next;
		}
2518

2519
# check for initialisation to aggregates open brace on the next line
2520 2521
		if ($line =~ /^.\s*{/ &&
		    $prevline =~ /(?:^|[^=])=\s*$/) {
2522 2523
			ERROR("OPEN_BRACE",
			      "that open brace { should be on the previous line\n" . $hereprev);
2524 2525
		}

2526 2527 2528 2529 2530
#
# Checks which are anchored on the added line.
#

# check for malformed paths in #include statements (uses RAW line)
2531
		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2532 2533
			my $path = $1;
			if ($path =~ m{//}) {
2534
				ERROR("MALFORMED_INCLUDE",
2535 2536 2537 2538 2539
				      "malformed #include filename\n" . $herecurr);
			}
			if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
				ERROR("UAPI_INCLUDE",
				      "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
2540 2541
			}
		}
2542

2543
# no C99 // comments
2544
		if ($line =~ m{//}) {
2545 2546 2547 2548 2549 2550 2551 2552 2553
			if (ERROR("C99_COMMENTS",
				  "do not use C99 // comments\n" . $herecurr) &&
			    $fix) {
				my $line = $fixed[$linenr - 1];
				if ($line =~ /\/\/(.*)$/) {
					my $comment = trim($1);
					$fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@;
				}
			}
2554
		}
2555
		# Remove C99 comments.
2556
		$line =~ s@//.*@@;
2557
		$opline =~ s@//.*@@;
2558

2559 2560 2561 2562 2563 2564 2565 2566
# 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.*\((.*)\)/)) {
2567 2568 2569 2570
			# Handle definitions which produce identifiers with
			# a prefix:
			#   XXX(foo);
			#   EXPORT_SYMBOL(something_foo);
2571
			my $name = $1;
2572
			if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
2573 2574 2575 2576 2577
			    $name =~ /^${Ident}_$2/) {
#print "FOO C name<$name>\n";
				$suppress_export{$realline_next} = 1;

			} elsif ($stat !~ /(?:
2578
				\n.}\s*$|
2579 2580 2581
				^.DEFINE_$Ident\(\Q$name\E\)|
				^.DECLARE_$Ident\(\Q$name\E\)|
				^.LIST_HEAD\(\Q$name\E\)|
2582 2583
				^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
				\b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
2584
			    )/x) {
2585 2586 2587 2588
#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
				$suppress_export{$realline_next} = 2;
			} else {
				$suppress_export{$realline_next} = 1;
2589 2590
			}
		}
2591 2592 2593 2594 2595 2596 2597 2598 2599
		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) {
2600 2601
			WARN("EXPORT_SYMBOL",
			     "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2602
		}
2603

2604
# check for global initialisers.
2605 2606 2607 2608 2609 2610 2611
		if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
			if (ERROR("GLOBAL_INITIALISERS",
				  "do not initialise globals to 0 or NULL\n" .
				      $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
			}
2612
		}
2613
# check for static initialisers.
2614 2615 2616 2617 2618 2619 2620
		if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
			if (ERROR("INITIALISED_STATIC",
				  "do not initialise statics to 0 or NULL\n" .
				      $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
			}
2621 2622
		}

2623 2624
# check for static const char * arrays.
		if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
2625 2626
			WARN("STATIC_CONST_CHAR_ARRAY",
			     "static const char * array should probably be static const char * const\n" .
2627 2628 2629 2630 2631
				$herecurr);
               }

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

2637 2638
# check for declarations of struct pci_device_id
		if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
2639 2640
			WARN("DEFINE_PCI_DEVICE_TABLE",
			     "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
2641 2642
		}

2643 2644 2645
# check for new typedefs, only function parameters and sparse annotations
# make sense.
		if ($line =~ /\btypedef\s/ &&
2646
		    $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
2647
		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
2648
		    $line !~ /\b$typeTypedefs\b/ &&
2649
		    $line !~ /\b__bitwise(?:__|)\b/) {
2650 2651
			WARN("NEW_TYPEDEFS",
			     "do not add new typedefs\n" . $herecurr);
2652 2653 2654
		}

# * goes on variable not on type
2655
		# (char*[ const])
2656 2657
		while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
			#print "AA<$1>\n";
2658
			my ($ident, $from, $to) = ($1, $2, $2);
2659 2660 2661 2662 2663 2664

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

2668
##			print "1: from<$from> to<$to> ident<$ident>\n";
2669
			if ($from ne $to) {
2670 2671 2672 2673 2674 2675 2676 2677 2678
				if (ERROR("POINTER_LOCATION",
					  "\"(foo$from)\" should be \"(foo$to)\"\n" .  $herecurr) &&
				    $fix) {
					my $sub_from = $ident;
					my $sub_to = $ident;
					$sub_to =~ s/\Q$from\E/$to/;
					$fixed[$linenr - 1] =~
					    s@\Q$sub_from\E@$sub_to@;
				}
2679
			}
2680 2681 2682
		}
		while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
			#print "BB<$1>\n";
2683
			my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
2684 2685 2686 2687 2688 2689

			# Should start with a space.
			$to =~ s/^(\S)/ $1/;
			# Should not end with a space.
			$to =~ s/\s+$//;
			# '*'s should not have spaces between.
2690
			while ($to =~ s/\*\s+\*/\*\*/) {
2691 2692 2693
			}
			# Modifiers should have spaces.
			$to =~ s/(\b$Modifier$)/$1 /;
2694

2695
##			print "2: from<$from> to<$to> ident<$ident>\n";
2696
			if ($from ne $to && $ident !~ /^$Modifier$/) {
2697 2698 2699 2700 2701 2702 2703 2704 2705 2706
				if (ERROR("POINTER_LOCATION",
					  "\"foo${from}bar\" should be \"foo${to}bar\"\n" .  $herecurr) &&
				    $fix) {

					my $sub_from = $match;
					my $sub_to = $match;
					$sub_to =~ s/\Q$from\E/$to/;
					$fixed[$linenr - 1] =~
					    s@\Q$sub_from\E@$sub_to@;
				}
2707
			}
2708 2709 2710 2711 2712 2713 2714 2715 2716
		}

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

2717
		if ($line =~ /\bLINUX_VERSION_CODE\b/) {
2718 2719
			WARN("LINUX_VERSION_CODE",
			     "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
2720 2721
		}

2722 2723
# check for uses of printk_ratelimit
		if ($line =~ /\bprintk_ratelimit\s*\(/) {
2724 2725
			WARN("PRINTK_RATELIMITED",
"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
2726 2727
		}

2728 2729 2730
# 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 已提交
2731
# printk includes all preceding printk's which have no newline on the end.
2732
# we assume the first bad printk is the one to report.
2733
		if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
2734 2735 2736
			my $ok = 0;
			for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
				#print "CHECK<$lines[$ln - 1]\n";
L
Lucas De Marchi 已提交
2737
				# we have a preceding printk if it ends
2738 2739 2740 2741 2742 2743 2744 2745 2746
				# 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) {
2747 2748
				WARN("PRINTK_WITHOUT_KERN_LEVEL",
				     "printk() should include KERN_ facility level\n" . $herecurr);
2749
			}
2750 2751
		}

2752 2753 2754 2755
		if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
			my $orig = $1;
			my $level = lc($orig);
			$level = "warn" if ($level eq "warning");
2756 2757
			my $level2 = $level;
			$level2 = "dbg" if ($level eq "debug");
2758
			WARN("PREFER_PR_LEVEL",
2759
			     "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(...  to printk(KERN_$orig ...\n" . $herecurr);
2760 2761 2762
		}

		if ($line =~ /\bpr_warning\s*\(/) {
2763 2764 2765 2766 2767 2768
			if (WARN("PREFER_PR_LEVEL",
				 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/\bpr_warning\b/pr_warn/;
			}
2769 2770
		}

2771 2772 2773 2774 2775 2776 2777 2778 2779
		if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
			my $orig = $1;
			my $level = lc($orig);
			$level = "warn" if ($level eq "warning");
			$level = "dbg" if ($level eq "debug");
			WARN("PREFER_DEV_LEVEL",
			     "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
		}

2780 2781
# function brace can't be on same line, except for #defines of do while,
# or if closed on same line
2782 2783
		if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
		    !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
2784 2785
			ERROR("OPEN_BRACE",
			      "open brace '{' following function declarations go on the next line\n" . $herecurr);
2786
		}
2787

2788 2789 2790
# 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*$/) {
2791 2792
			ERROR("OPEN_BRACE",
			      "open brace '{' following $1 go on the same line\n" . $hereprev);
2793 2794
		}

2795
# missing space after union, struct or enum definition
2796 2797 2798 2799 2800 2801 2802
		if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
			if (WARN("SPACING",
				 "missing space after $1 definition\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
			}
2803 2804
		}

2805 2806
# check for spacing round square brackets; allowed:
#  1. with a type on the left -- int [] a;
2807 2808
#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
#  3. inside a curly brace -- = { [0...10] = 5 }
2809 2810 2811
		while ($line =~ /(.*?\s)\[/g) {
			my ($where, $prefix) = ($-[1], $1);
			if ($prefix !~ /$Type\s+$/ &&
2812
			    ($where != 0 || $prefix !~ /^.\s+$/) &&
2813
			    $prefix !~ /[{,]\s+$/) {
2814 2815 2816 2817 2818 2819
				if (ERROR("BRACKET_SPACE",
					  "space prohibited before open square bracket '['\n" . $herecurr) &&
				    $fix) {
				    $fixed[$linenr - 1] =~
					s/^(\+.*?)\s+\[/$1\[/;
				}
2820 2821 2822
			}
		}

2823
# check for spaces between functions and their parentheses.
2824
		while ($line =~ /($Ident)\s+\(/g) {
2825
			my $name = $1;
2826 2827
			my $ctx_before = substr($line, 0, $-[1]);
			my $ctx = "$ctx_before$name";
2828 2829

			# Ignore those directives where spaces _are_ permitted.
2830 2831 2832 2833 2834 2835
			if ($name =~ /^(?:
				if|for|while|switch|return|case|
				volatile|__volatile__|
				__attribute__|format|__extension__|
				asm|__asm__)$/x)
			{
2836 2837 2838
			# 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.
2839
			} elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
2840 2841

			# cpp #elif statement condition may start with a (
2842
			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
2843 2844 2845

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

			} else {
2849 2850 2851 2852 2853 2854
				if (WARN("SPACING",
					 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
					     $fix) {
					$fixed[$linenr - 1] =~
					    s/\b$name\s+\(/$name\(/;
				}
2855
			}
2856
		}
2857

2858
# Check operator spacing.
2859
		if (!($line=~/\#\s*include/)) {
2860 2861 2862
			my $fixed_line = "";
			my $line_fixed = 0;

2863 2864 2865 2866
			my $ops = qr{
				<<=|>>=|<=|>=|==|!=|
				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
				=>|->|<<|>>|<|>|=|!|~|
2867
				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2868
				\?:|\?|:
2869
			}x;
2870
			my @elements = split(/($ops|;)/, $opline);
2871 2872 2873 2874 2875 2876 2877

##			print("element count: <" . $#elements . ">\n");
##			foreach my $el (@elements) {
##				print("el: <$el>\n");
##			}

			my @fix_elements = ();
2878
			my $off = 0;
2879

2880 2881 2882 2883 2884 2885 2886
			foreach my $el (@elements) {
				push(@fix_elements, substr($rawline, $off, length($el)));
				$off += length($el);
			}

			$off = 0;

2887
			my $blank = copy_spacing($opline);
2888
			my $last_after = -1;
2889

2890
			for (my $n = 0; $n < $#elements; $n += 2) {
2891 2892 2893 2894 2895

				my $good = $fix_elements[$n] . $fix_elements[$n + 1];

##				print("n: <$n> good: <$good>\n");

2896 2897
				$off += length($elements[$n]);

L
Lucas De Marchi 已提交
2898
				# Pick up the preceding and succeeding characters.
2899 2900 2901 2902 2903 2904 2905
				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";

2906 2907 2908
				my $a = '';
				$a = 'V' if ($elements[$n] ne '');
				$a = 'W' if ($elements[$n] =~ /\s$/);
2909
				$a = 'C' if ($elements[$n] =~ /$;$/);
2910 2911
				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
				$a = 'O' if ($elements[$n] eq '');
2912
				$a = 'E' if ($ca =~ /^\s*$/);
2913

2914
				my $op = $elements[$n + 1];
2915 2916

				my $c = '';
2917
				if (defined $elements[$n + 2]) {
2918 2919
					$c = 'V' if ($elements[$n + 2] ne '');
					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
2920
					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
2921 2922
					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
					$c = 'O' if ($elements[$n + 2] eq '');
2923
					$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
2924 2925
				} else {
					$c = 'E';
2926 2927
				}

2928 2929 2930 2931
				my $ctx = "${a}x${c}";

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

2932
				my $ptr = substr($blank, 0, $off) . "^";
2933
				my $hereptr = "$hereline$ptr\n";
2934

2935
				# Pull out the value of this operator.
2936
				my $op_type = substr($curr_values, $off + 1, 1);
2937

2938 2939 2940
				# Get the full operator variant.
				my $opv = $op . substr($curr_vars, $off, 1);

2941 2942 2943 2944
				# Ignore operators passed as parameters.
				if ($op_type ne 'V' &&
				    $ca =~ /\s$/ && $cc =~ /^\s*,/) {

2945 2946
#				# Ignore comments
#				} elsif ($op =~ /^$;+$/) {
2947

2948
				# ; should have either the end of line or a space or \ after it
2949
				} elsif ($op eq ';') {
2950 2951
					if ($ctx !~ /.x[WEBC]/ &&
					    $cc !~ /^\\/ && $cc !~ /^;/) {
2952 2953
						if (ERROR("SPACING",
							  "space required after that '$op' $at\n" . $hereptr)) {
2954
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
2955 2956
							$line_fixed = 1;
						}
2957 2958 2959 2960
					}

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

2962 2963 2964 2965
				# No spaces for:
				#   ->
				#   :   when part of a bitfield
				} elsif ($op eq '->' || $opv eq ':B') {
2966
					if ($ctx =~ /Wx.|.xW/) {
2967 2968
						if (ERROR("SPACING",
							  "spaces prohibited around that '$op' $at\n" . $hereptr)) {
2969
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
2970 2971 2972
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
2973
							$line_fixed = 1;
2974
						}
2975 2976 2977 2978
					}

				# , must have a space on the right.
				} elsif ($op eq ',') {
2979
					if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
2980 2981
						if (ERROR("SPACING",
							  "space required after that '$op' $at\n" . $hereptr)) {
2982
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
2983
							$line_fixed = 1;
2984
							$last_after = $n;
2985
						}
2986 2987
					}

2988
				# '*' as part of a type definition -- reported already.
2989
				} elsif ($opv eq '*_') {
2990 2991 2992 2993 2994 2995
					#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 '~' ||
2996
					 $opv eq '*U' || $opv eq '-U' ||
2997
					 $opv eq '&U' || $opv eq '&&U') {
2998
					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
2999 3000
						if (ERROR("SPACING",
							  "space required before that '$op' $at\n" . $hereptr)) {
3001 3002 3003 3004
							if ($n != $last_after + 2) {
								$good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
								$line_fixed = 1;
							}
3005
						}
3006
					}
3007
					if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
3008 3009 3010
						# A unary '*' may be const

					} elsif ($ctx =~ /.xW/) {
3011 3012
						if (ERROR("SPACING",
							  "space prohibited after that '$op' $at\n" . $hereptr)) {
3013
							$good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
3014 3015 3016
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3017
							$line_fixed = 1;
3018
						}
3019 3020 3021 3022
					}

				# unary ++ and unary -- are allowed no space on one side.
				} elsif ($op eq '++' or $op eq '--') {
3023
					if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
3024 3025
						if (ERROR("SPACING",
							  "space required one side of that '$op' $at\n" . $hereptr)) {
3026
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3027 3028
							$line_fixed = 1;
						}
3029 3030 3031
					}
					if ($ctx =~ /Wx[BE]/ ||
					    ($ctx =~ /Wx./ && $cc =~ /^;/)) {
3032 3033
						if (ERROR("SPACING",
							  "space prohibited before that '$op' $at\n" . $hereptr)) {
3034
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3035 3036
							$line_fixed = 1;
						}
3037
					}
3038
					if ($ctx =~ /ExW/) {
3039 3040
						if (ERROR("SPACING",
							  "space prohibited after that '$op' $at\n" . $hereptr)) {
3041
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3042 3043 3044
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3045
							$line_fixed = 1;
3046
						}
3047
					}
3048 3049

				# << and >> may either have or not have spaces both sides
3050 3051 3052
				} elsif ($op eq '<<' or $op eq '>>' or
					 $op eq '&' or $op eq '^' or $op eq '|' or
					 $op eq '+' or $op eq '-' or
3053 3054
					 $op eq '*' or $op eq '/' or
					 $op eq '%')
3055
				{
3056
					if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
3057 3058
						if (ERROR("SPACING",
							  "need consistent spacing around '$op' $at\n" . $hereptr)) {
3059 3060 3061 3062
							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3063 3064
							$line_fixed = 1;
						}
3065 3066
					}

3067 3068 3069 3070
				# 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./) {
3071 3072
						if (ERROR("SPACING",
							  "space prohibited before that '$op' $at\n" . $hereptr)) {
3073
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3074 3075
							$line_fixed = 1;
						}
3076 3077
					}

3078
				# All the others need spaces both sides.
3079
				} elsif ($ctx !~ /[EWC]x[CWE]/) {
3080 3081
					my $ok = 0;

3082
					# Ignore email addresses <foo@bar>
3083 3084 3085 3086 3087 3088 3089 3090
					if (($op eq '<' &&
					     $cc =~ /^\S+\@\S+>/) ||
					    ($op eq '>' &&
					     $ca =~ /<\S+\@\S+$/))
					{
					    	$ok = 1;
					}

3091
					# messages are ERROR, but ?: are CHK
3092
					if ($ok == 0) {
3093 3094 3095 3096 3097
						my $msg_type = \&ERROR;
						$msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);

						if (&{$msg_type}("SPACING",
								 "spaces required around that '$op' $at\n" . $hereptr)) {
3098 3099 3100 3101
							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3102 3103
							$line_fixed = 1;
						}
3104
					}
3105
				}
3106
				$off += length($elements[$n + 1]);
3107 3108 3109 3110 3111 3112 3113 3114

##				print("n: <$n> GOOD: <$good>\n");

				$fixed_line = $fixed_line . $good;
			}

			if (($#elements % 2) == 0) {
				$fixed_line = $fixed_line . $fix_elements[$#elements];
3115
			}
3116 3117 3118 3119 3120 3121

			if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) {
				$fixed[$linenr - 1] = $fixed_line;
			}


3122 3123
		}

3124 3125 3126 3127 3128 3129 3130 3131 3132 3133
# check for whitespace before a non-naked semicolon
		if ($line =~ /^\+.*\S\s+;/) {
			if (WARN("SPACING",
				 "space prohibited before semicolon\n" . $herecurr) &&
			    $fix) {
				1 while $fixed[$linenr - 1] =~
				    s/^(\+.*\S)\s+;/$1;/;
			}
		}

3134 3135
# check for multiple assignments
		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
3136 3137
			CHK("MULTIPLE_ASSIGNMENTS",
			    "multiple assignments should be avoided\n" . $herecurr);
3138 3139
		}

3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150
## # 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 =~ /,/) {
3151 3152
## 				WARN("MULTIPLE_DECLARATION",
##				     "declaring multiple variables together should be avoided\n" . $herecurr);
3153 3154
## 			}
## 		}
3155

3156
#need space before brace following if, while, etc
3157 3158
		if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
		    $line =~ /do{/) {
3159 3160 3161
			if (ERROR("SPACING",
				  "space required before the open brace '{'\n" . $herecurr) &&
			    $fix) {
3162
				$fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/;
3163
			}
3164 3165
		}

3166 3167 3168 3169 3170 3171 3172 3173
## # check for blank lines before declarations
##		if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
##		    $prevrawline =~ /^.\s*$/) {
##			WARN("SPACING",
##			     "No blank lines before declarations\n" . $hereprev);
##		}
##

3174 3175 3176
# closing brace should have a space following it when it has anything
# on the line
		if ($line =~ /}(?!(?:,|;|\)))\S/) {
3177 3178 3179 3180 3181 3182
			if (ERROR("SPACING",
				  "space required after that close brace '}'\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/}((?!(?:,|;|\)))\S)/} $1/;
			}
3183 3184
		}

3185 3186
# check spacing on square brackets
		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
3187 3188 3189 3190 3191 3192
			if (ERROR("SPACING",
				  "space prohibited after that open square bracket '['\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/\[\s+/\[/;
			}
3193 3194
		}
		if ($line =~ /\s\]/) {
3195 3196 3197 3198 3199 3200
			if (ERROR("SPACING",
				  "space prohibited before that close square bracket ']'\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/\s+\]/\]/;
			}
3201 3202
		}

3203
# check spacing on parentheses
3204 3205
		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
		    $line !~ /for\s*\(\s+;/) {
3206 3207 3208 3209 3210 3211
			if (ERROR("SPACING",
				  "space prohibited after that open parenthesis '('\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/\(\s+/\(/;
			}
3212
		}
3213
		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
3214 3215
		    $line !~ /for\s*\(.*;\s+\)/ &&
		    $line !~ /:\s+\)/) {
3216 3217 3218 3219 3220 3221
			if (ERROR("SPACING",
				  "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/\s+\)/\)/;
			}
3222 3223
		}

3224
#goto labels aren't indented, allow a single space however
3225
		if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
3226
		   !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
3227 3228 3229 3230 3231 3232
			if (WARN("INDENTED_LABEL",
				 "labels should not be indented\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/^(.)\s+/$1/;
			}
3233 3234
		}

3235
# Return is not a function.
3236
		if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
3237
			my $spacing = $1;
3238 3239
			if ($^V && $^V ge 5.10.0 &&
			    $stat =~ /^.\s*return\s*$balanced_parens\s*;\s*$/) {
3240 3241
				ERROR("RETURN_PARENTHESES",
				      "return is not a function, parentheses are not required\n" . $herecurr);
3242 3243

			} elsif ($spacing !~ /\s+/) {
3244 3245
				ERROR("SPACING",
				      "space required before the open parenthesis '('\n" . $herecurr);
3246 3247
			}
		}
3248

3249 3250 3251 3252
# 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') {
3253 3254
				WARN("USE_NEGATIVE_ERRNO",
				     "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
3255 3256
			}
		}
3257

3258
# Need a space before open parenthesis after if, while etc
3259 3260 3261 3262 3263 3264 3265
		if ($line =~ /\b(if|while|for|switch)\(/) {
			if (ERROR("SPACING",
				  "space required before the open parenthesis '('\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/\b(if|while|for|switch)\(/$1 \(/;
			}
3266 3267
		}

3268 3269
# Check for illegal assignment in if conditional -- and check for trailing
# statements after the conditional.
3270
		if ($line =~ /do\s*(?!{)/) {
3271 3272 3273
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291
			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} &&
3292
		    defined($stat) && defined($cond) &&
3293
		    $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
3294
			my ($s, $c) = ($stat, $cond);
3295

3296
			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
3297 3298
				ERROR("ASSIGN_IN_IF",
				      "do not use assignment in if condition\n" . $herecurr);
3299 3300 3301 3302
			}

			# Find out what is on the end of the line after the
			# conditional.
3303
			substr($s, 0, length($c), '');
3304
			$s =~ s/\n.*//g;
3305
			$s =~ s/$;//g; 	# Remove any comments
3306 3307
			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
			    $c !~ /}\s*while\s*/)
3308
			{
3309 3310 3311
				# Find out how long the conditional actually is.
				my @newlines = ($c =~ /\n/gs);
				my $cond_lines = 1 + $#newlines;
3312
				my $stat_real = '';
3313

3314 3315
				$stat_real = raw_line($linenr, $cond_lines)
							. "\n" if ($cond_lines);
3316 3317 3318 3319
				if (defined($stat_real) && $cond_lines > 1) {
					$stat_real = "[...]\n$stat_real";
				}

3320 3321
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr . $stat_real);
3322 3323 3324
			}
		}

3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336
# Check for bitwise tests written as boolean
		if ($line =~ /
			(?:
				(?:\[|\(|\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\|)
			|
				(?:\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\||\)|\])
			)/x)
		{
3337 3338
			WARN("HEXADECIMAL_BOOLEAN_TEST",
			     "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
3339 3340
		}

3341
# if and else should not have general statements after it
3342 3343 3344 3345
		if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
			my $s = $1;
			$s =~ s/$;//g; 	# Remove any comments
			if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
3346 3347
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr);
3348
			}
3349
		}
3350 3351
# if should not continue a brace
		if ($line =~ /}\s*if\b/) {
3352 3353
			ERROR("TRAILING_STATEMENTS",
			      "trailing statements should be on next line\n" .
3354 3355
				$herecurr);
		}
3356 3357 3358
# case and default should not have general statements after them
		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
		    $line !~ /\G(?:
3359
			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
3360 3361 3362
			\s*return\s+
		    )/xg)
		{
3363 3364
			ERROR("TRAILING_STATEMENTS",
			      "trailing statements should be on next line\n" . $herecurr);
3365
		}
3366 3367 3368 3369 3370

		# 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) {
3371 3372
			ERROR("ELSE_AFTER_BRACE",
			      "else should follow close brace '}'\n" . $hereprev);
3373 3374
		}

3375 3376 3377 3378 3379 3380
		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.
3381
			substr($s, 0, length($c), '');
3382 3383 3384
			$s =~ s/\n.*//g;

			if ($s =~ /^\s*;/) {
3385 3386
				ERROR("WHILE_AFTER_BRACE",
				      "while should follow close brace '}'\n" . $hereprev);
3387 3388 3389
			}
		}

3390
#Specific variable tests
3391 3392
		while ($line =~ m{($Constant|$Lval)}g) {
			my $var = $1;
3393 3394 3395

#gcc binary extension
			if ($var =~ /^$Binary$/) {
3396 3397 3398 3399 3400 3401 3402
				if (WARN("GCC_BINARY_CONSTANT",
					 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
				    $fix) {
					my $hexval = sprintf("0x%x", oct($var));
					$fixed[$linenr - 1] =~
					    s/\b$var\b/$hexval/;
				}
3403 3404 3405
			}

#CamelCase
3406
			if ($var !~ /^$Constant$/ &&
3407
			    $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
3408
#Ignore Page<foo> variants
3409
			    $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
3410
#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
3411
			    $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
3412 3413 3414
				while ($var =~ m{($Ident)}g) {
					my $word = $1;
					next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
3415 3416 3417 3418 3419 3420 3421
					if ($check) {
						seed_camelcase_includes();
						if (!$file && !$camelcase_file_seeded) {
							seed_camelcase_file($realfile);
							$camelcase_file_seeded = 1;
						}
					}
3422 3423 3424 3425 3426
					if (!defined $camelcase{$word}) {
						$camelcase{$word} = 1;
						CHK("CAMELCASE",
						    "Avoid CamelCase: <$word>\n" . $herecurr);
					}
3427
				}
3428 3429
			}
		}
3430 3431

#no spaces allowed after \ in define
3432 3433 3434 3435 3436 3437
		if ($line =~ /\#\s*define.*\\\s+$/) {
			if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
				 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/\s+$//;
			}
3438 3439
		}

3440
#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
3441
		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
3442 3443 3444 3445
			my $file = "$1.h";
			my $checkfile = "include/linux/$file";
			if (-f "$root/$checkfile" &&
			    $realfile ne $checkfile &&
3446
			    $1 !~ /$allowed_asm_includes/)
3447
			{
3448
				if ($realfile =~ m{^arch/}) {
3449 3450
					CHK("ARCH_INCLUDE_LINUX",
					    "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
3451
				} else {
3452 3453
					WARN("INCLUDE_LINUX",
					     "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
3454
				}
3455 3456 3457
			}
		}

3458 3459
# 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
3460
# in a known good container
3461 3462
		if ($realfile !~ m@/vmlinux.lds.h$@ &&
		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
3463 3464
			my $ln = $linenr;
			my $cnt = $realcnt;
3465 3466 3467
			my ($off, $dstat, $dcond, $rest);
			my $ctx = '';
			($dstat, $dcond, $ln, $cnt, $off) =
3468 3469
				ctx_statement_block($linenr, $realcnt, 0);
			$ctx = $dstat;
3470
			#print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
3471
			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
3472

3473
			$dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
3474
			$dstat =~ s/$;//g;
3475 3476 3477
			$dstat =~ s/\\\n.//g;
			$dstat =~ s/^\s*//s;
			$dstat =~ s/\s*$//s;
3478

3479
			# Flatten any parentheses and braces
3480 3481
			while ($dstat =~ s/\([^\(\)]*\)/1/ ||
			       $dstat =~ s/\{[^\{\}]*\}/1/ ||
3482
			       $dstat =~ s/\[[^\[\]]*\]/1/)
3483
			{
3484
			}
3485

3486 3487 3488 3489 3490 3491
			# Flatten any obvious string concatentation.
			while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
			       $dstat =~ s/$Ident\s*("X*")/$1/)
			{
			}

3492 3493 3494
			my $exceptions = qr{
				$Declare|
				module_param_named|
3495
				MODULE_PARM_DESC|
3496 3497
				DECLARE_PER_CPU|
				DEFINE_PER_CPU|
3498
				__typeof__\(|
3499 3500
				union|
				struct|
3501 3502
				\.$Ident\s*=\s*|
				^\"|\"$
3503
			}x;
3504
			#print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
3505 3506 3507
			if ($dstat ne '' &&
			    $dstat !~ /^(?:$Ident|-?$Constant),$/ &&			# 10, // foo(),
			    $dstat !~ /^(?:$Ident|-?$Constant);$/ &&			# foo();
3508
			    $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ &&		# 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
3509
			    $dstat !~ /^'X'$/ &&					# character constants
3510 3511
			    $dstat !~ /$exceptions/ &&
			    $dstat !~ /^\.$Ident\s*=/ &&				# .foo =
3512
			    $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ &&		# stringification #foo
3513
			    $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ &&	# do {...} while (...); // do {...} while (...)
3514 3515 3516
			    $dstat !~ /^for\s*$Constant$/ &&				# for (...)
			    $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ &&	# for (...) bar()
			    $dstat !~ /^do\s*{/ &&					# do {...
3517 3518
			    $dstat !~ /^\({/ &&						# ({...
			    $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
3519 3520 3521 3522 3523 3524 3525
			{
				$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";
3526 3527
				}

3528 3529 3530 3531
				if ($dstat =~ /;/) {
					ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
					      "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
				} else {
3532
					ERROR("COMPLEX_MACRO",
3533
					      "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
3534
				}
3535
			}
3536

3537
# check for line continuations outside of #defines, preprocessor #, and asm
3538 3539 3540

		} else {
			if ($prevline !~ /^..*\\$/ &&
3541 3542
			    $line !~ /^\+\s*\#.*\\$/ &&		# preprocessor
			    $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ &&	# asm
3543 3544 3545 3546
			    $line =~ /^\+.*\\$/) {
				WARN("LINE_CONTINUATIONS",
				     "Avoid unnecessary line continuations\n" . $herecurr);
			}
3547 3548
		}

3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576
# 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";
				}

3577 3578
				if (($stmts =~ tr/;/;/) == 1 &&
				    $stmts !~ /^\s*(if|while|for|switch)\b/) {
3579 3580 3581 3582 3583 3584 3585 3586 3587 3588
					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");
				}
			}
		}

3589 3590 3591 3592 3593 3594
# 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|$))/) {
3595 3596
			WARN("MISSING_VMLINUX_SYMBOL",
			     "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
3597 3598
		}

3599
# check for redundant bracing round if etc
3600 3601
		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
			my ($level, $endln, @chunks) =
3602
				ctx_statement_full($linenr, $realcnt, 1);
3603
			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
3604 3605
			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
			if ($#chunks > 0 && $level == 0) {
3606 3607
				my @allowed = ();
				my $allow = 0;
3608
				my $seen = 0;
3609
				my $herectx = $here . "\n";
3610
				my $ln = $linenr - 1;
3611 3612 3613
				for my $chunk (@chunks) {
					my ($cond, $block) = @{$chunk};

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

3618
					$allowed[$allow] = 0;
3619 3620 3621 3622 3623 3624
					#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";
3625 3626
					$ln += statement_rawlines($block) - 1;

3627
					substr($block, 0, length($cond), '');
3628 3629 3630

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

3631
					#print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
3632 3633
					if (statement_lines($cond) > 1) {
						#print "APW: ALLOWED: cond<$cond>\n";
3634
						$allowed[$allow] = 1;
3635 3636
					}
					if ($block =~/\b(?:if|for|while)\b/) {
3637
						#print "APW: ALLOWED: block<$block>\n";
3638
						$allowed[$allow] = 1;
3639
					}
3640 3641
					if (statement_block_size($block) > 1) {
						#print "APW: ALLOWED: lines block<$block>\n";
3642
						$allowed[$allow] = 1;
3643
					}
3644
					$allow++;
3645
				}
3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658
				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);
					}
3659 3660 3661
				}
			}
		}
3662
		if (!defined $suppress_ifbraces{$linenr - 1} &&
3663
					$line =~ /\b(if|while|for|else)\b/) {
3664 3665 3666 3667 3668 3669 3670
			my $allowed = 0;

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

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

3675 3676
			# Check the condition.
			my ($cond, $block) = @{$chunks[0]};
3677
			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
3678
			if (defined $cond) {
3679
				substr($block, 0, length($cond), '');
3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696
			}
			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) {
3697
					substr($block, 0, length($cond), '');
3698 3699 3700 3701 3702 3703 3704
				}
				if ($block =~ /^\s*\{/) {
					#print "APW: ALLOWED: chunk-1 block<$block>\n";
					$allowed = 1;
				}
			}
			if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
3705
				my $herectx = $here . "\n";
3706
				my $cnt = statement_rawlines($block);
3707

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

3712 3713
				WARN("BRACES",
				     "braces {} are not necessary for single statement blocks\n" . $herectx);
3714 3715 3716
			}
		}

3717
# check for unnecessary blank lines around braces
3718
		if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
3719 3720 3721
			CHK("BRACES",
			    "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
		}
3722
		if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
3723 3724 3725 3726
			CHK("BRACES",
			    "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
		}

3727
# no volatiles please
3728 3729
		my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
		if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
3730 3731
			WARN("VOLATILE",
			     "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
3732 3733
		}

3734
# warn about #if 0
3735
		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
3736 3737
			CHK("REDUNDANT_CODE",
			    "if this code is redundant consider removing it\n" .
3738
				$herecurr);
3739 3740
		}

3741 3742 3743 3744 3745 3746
# 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);
3747 3748
			}
		}
3749

3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767
# check for bad placement of section $InitAttribute (e.g.: __initdata)
		if ($line =~ /(\b$InitAttribute\b)/) {
			my $attr = $1;
			if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
				my $ptr = $1;
				my $var = $2;
				if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
				      ERROR("MISPLACED_INIT",
					    "$attr should be placed after $var\n" . $herecurr)) ||
				     ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
				      WARN("MISPLACED_INIT",
					   "$attr should be placed after $var\n" . $herecurr))) &&
				    $fix) {
					$fixed[$linenr - 1] =~ s/(\bstatic\s+(?:const\s+)?)(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*([=;])\s*/"$1" . trim(string_find_replace($2, "\\s*$attr\\s*", " ")) . " " . trim(string_find_replace($3, "\\s*$attr\\s*", "")) . " $attr" . ("$4" eq ";" ? ";" : " = ")/e;
				}
			}
		}

3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796
# check for $InitAttributeData (ie: __initdata) with const
		if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
			my $attr = $1;
			$attr =~ /($InitAttributePrefix)(.*)/;
			my $attr_prefix = $1;
			my $attr_type = $2;
			if (ERROR("INIT_ATTRIBUTE",
				  "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/$InitAttributeData/${attr_prefix}initconst/;
			}
		}

# check for $InitAttributeConst (ie: __initconst) without const
		if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
			my $attr = $1;
			if (ERROR("INIT_ATTRIBUTE",
				  "Use of $attr requires a separate use of const\n" . $herecurr) &&
			    $fix) {
				my $lead = $fixed[$linenr - 1] =~
				    /(^\+\s*(?:static\s+))/;
				$lead = rtrim($1);
				$lead = "$lead " if ($lead !~ /^\+$/);
				$lead = "${lead}const ";
				$fixed[$linenr - 1] =~ s/(^\+\s*(?:static\s+))/$lead/;
			}
		}

3797
# prefer usleep_range over udelay
B
Bruce Allan 已提交
3798
		if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
3799
			# ignore udelay's < 10, however
B
Bruce Allan 已提交
3800
			if (! ($1 < 10) ) {
3801 3802
				CHK("USLEEP_RANGE",
				    "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
3803 3804 3805
			}
		}

3806 3807 3808
# warn about unexpectedly long msleep's
		if ($line =~ /\bmsleep\s*\((\d+)\);/) {
			if ($1 < 20) {
3809 3810
				WARN("MSLEEP",
				     "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
3811 3812 3813
			}
		}

3814 3815 3816 3817 3818 3819
# check for comparisons of jiffies
		if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
			WARN("JIFFIES_COMPARISON",
			     "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
		}

3820 3821 3822 3823 3824 3825
# check for comparisons of get_jiffies_64()
		if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
			WARN("JIFFIES_COMPARISON",
			     "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
		}

3826
# warn about #ifdefs in C files
3827
#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
3828 3829 3830 3831 3832
#			print "#ifdef in C files should be avoided\n";
#			print "$herecurr";
#			$clean = 0;
#		}

3833
# warn about spacing in #ifdefs
3834
		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
3835 3836 3837 3838 3839 3840 3841
			if (ERROR("SPACING",
				  "exactly one space required after that #$1\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
			}

3842 3843
		}

3844
# check for spinlock_t definitions without a comment.
3845 3846
		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
3847 3848
			my $which = $1;
			if (!ctx_has_comment($first_line, $linenr)) {
3849 3850
				CHK("UNCOMMENTED_DEFINITION",
				    "$1 definition without comment\n" . $herecurr);
3851 3852 3853 3854 3855
			}
		}
# 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)) {
3856 3857
				WARN("MEMORY_BARRIER",
				     "memory barrier without comment\n" . $herecurr);
3858 3859 3860
			}
		}
# check of hardware specific defines
3861
		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
3862 3863
			CHK("ARCH_DEFINES",
			    "architecture specific defines should be avoided\n" .  $herecurr);
3864
		}
3865

3866 3867
# Check that the storage class is at the beginning of a declaration
		if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
3868 3869
			WARN("STORAGE_CLASS",
			     "storage class should be at the beginning of the declaration\n" . $herecurr)
3870 3871
		}

3872 3873
# check the location of the inline attribute, that it is between
# storage class and type.
3874 3875
		if ($line =~ /\b$Type\s+$Inline\b/ ||
		    $line =~ /\b$Inline\s+$Storage\b/) {
3876 3877
			ERROR("INLINE_LOCATION",
			      "inline keyword should sit between storage class and type\n" . $herecurr);
3878 3879
		}

3880
# Check for __inline__ and __inline, prefer inline
3881 3882
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b(__inline__|__inline)\b/) {
3883 3884 3885 3886 3887 3888
			if (WARN("INLINE",
				 "plain inline is preferred over $1\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/;

			}
3889 3890
		}

3891
# Check for __attribute__ packed, prefer __packed
3892 3893
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
3894 3895
			WARN("PREFER_PACKED",
			     "__packed is preferred over __attribute__((packed))\n" . $herecurr);
3896 3897
		}

3898
# Check for __attribute__ aligned, prefer __aligned
3899 3900
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
3901 3902
			WARN("PREFER_ALIGNED",
			     "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
3903 3904
		}

3905
# Check for __attribute__ format(printf, prefer __printf
3906 3907
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
3908 3909 3910 3911 3912 3913
			if (WARN("PREFER_PRINTF",
				 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;

			}
3914 3915
		}

3916
# Check for __attribute__ format(scanf, prefer __scanf
3917 3918
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
3919 3920 3921 3922 3923
			if (WARN("PREFER_SCANF",
				 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
			}
3924 3925
		}

3926 3927
# check for sizeof(&)
		if ($line =~ /\bsizeof\s*\(\s*\&/) {
3928 3929
			WARN("SIZEOF_ADDRESS",
			     "sizeof(& should be avoided\n" . $herecurr);
3930 3931
		}

3932 3933
# check for sizeof without parenthesis
		if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
3934 3935 3936 3937 3938
			if (WARN("SIZEOF_PARENTHESIS",
				 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
			}
3939 3940
		}

3941 3942
# check for line continuations in quoted strings with odd counts of "
		if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
3943 3944
			WARN("LINE_CONTINUATIONS",
			     "Avoid line continuations in quoted strings\n" . $herecurr);
3945 3946
		}

3947 3948 3949 3950 3951 3952
# 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);
		}

3953
# check for seq_printf uses that could be seq_puts
J
Joe Perches 已提交
3954
		if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
3955
			my $fmt = get_quoted_string($line, $rawline);
J
Joe Perches 已提交
3956
			if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
3957 3958 3959 3960 3961
				if (WARN("PREFER_SEQ_PUTS",
					 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
				    $fix) {
					$fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/;
				}
3962 3963 3964
			}
		}

3965
# Check for misused memsets
3966 3967
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
3968 3969 3970
		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {

			my $ms_addr = $2;
3971 3972
			my $ms_val = $7;
			my $ms_size = $12;
3973 3974 3975

			if ($ms_size =~ /^(0x|)0$/i) {
				ERROR("MEMSET",
3976
				      "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
3977 3978
			} elsif ($ms_size =~ /^(0x|)1$/i) {
				WARN("MEMSET",
3979 3980 3981 3982 3983
				     "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
			}
		}

# typecasts on min/max could be min_t/max_t
3984 3985
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
3986
		    $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
3987
			if (defined $2 || defined $7) {
3988 3989 3990
				my $call = $1;
				my $cast1 = deparenthesize($2);
				my $arg1 = $3;
3991 3992
				my $cast2 = deparenthesize($7);
				my $arg2 = $8;
3993 3994
				my $cast;

3995
				if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
3996 3997 3998 3999 4000 4001 4002 4003
					$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");
4004 4005 4006
			}
		}

4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022
# 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");
			}
		}

4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039
# check for naked sscanf
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
		    $stat =~ /\bsscanf\b/ &&
		    ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
		     $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
		     $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
			my $lc = $stat =~ tr@\n@@;
			$lc = $lc + $linenr;
			my $stat_real = raw_line($linenr, 0);
		        for (my $count = $linenr + 1; $count <= $lc; $count++) {
				$stat_real = $stat_real . "\n" . raw_line($count, 0);
			}
			WARN("NAKED_SSCANF",
			     "unchecked sscanf return value\n" . "$here\n$stat_real\n");
		}

4040 4041 4042
# check for new externs in .h files.
		if ($realfile =~ /\.h$/ &&
		    $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
4043 4044
			if (CHK("AVOID_EXTERNS",
				"extern prototypes should be avoided in .h files\n" . $herecurr) &&
4045 4046 4047 4048 4049
			    $fix) {
				$fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
			}
		}

4050
# check for new externs in .c files.
4051
		if ($realfile =~ /\.c$/ && defined $stat &&
4052
		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
4053
		{
4054 4055
			my $function_name = $1;
			my $paren_space = $2;
4056 4057 4058 4059 4060

			my $s = $stat;
			if (defined $cond) {
				substr($s, 0, length($cond), '');
			}
4061 4062 4063
			if ($s =~ /^\s*;/ &&
			    $function_name ne 'uninitialized_var')
			{
4064 4065
				WARN("AVOID_EXTERNS",
				     "externs should be avoided in .c files\n" .  $herecurr);
4066 4067 4068
			}

			if ($paren_space =~ /\n/) {
4069 4070
				WARN("FUNCTION_ARGUMENTS",
				     "arguments for function declarations should follow identifier\n" . $herecurr);
4071
			}
4072 4073 4074 4075

		} elsif ($realfile =~ /\.c$/ && defined $stat &&
		    $stat =~ /^.\s*extern\s+/)
		{
4076 4077
			WARN("AVOID_EXTERNS",
			     "externs should be avoided in .c files\n" .  $herecurr);
4078 4079 4080 4081 4082 4083 4084
		}

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

			if (!grep(/$name/, @setup_docs)) {
4085 4086
				CHK("UNDOCUMENTED_SETUP",
				    "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
4087
			}
4088
		}
4089 4090

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

4096 4097 4098 4099 4100 4101 4102 4103
# alloc style
# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
		if ($^V && $^V ge 5.10.0 &&
		    $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
			CHK("ALLOC_SIZEOF_STRUCT",
			    "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
		}

4104 4105 4106 4107 4108 4109 4110
# check for krealloc arg reuse
		if ($^V && $^V ge 5.10.0 &&
		    $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
			WARN("KREALLOC_ARG_REUSE",
			     "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
		}

4111 4112 4113 4114 4115 4116
# check for alloc argument mismatch
		if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
			WARN("ALLOC_ARRAY_ARGS",
			     "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
		}

4117 4118
# check for multiple semicolons
		if ($line =~ /;\s*;\s*$/) {
4119 4120 4121 4122 4123
			if (WARN("ONE_SEMICOLON",
				 "Statements terminations use 1 semicolon\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g;
			}
4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137
		}

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

4140
# check for gcc specific __FUNCTION__
4141 4142 4143 4144 4145 4146
		if ($line =~ /\b__FUNCTION__\b/) {
			if (WARN("USE_FUNC",
				 "__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g;
			}
4147
		}
4148

J
Joe Perches 已提交
4149 4150 4151 4152 4153 4154
# 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);
		}

4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181
# check for comparisons against true and false
		if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
			my $lead = $1;
			my $arg = $2;
			my $test = $3;
			my $otype = $4;
			my $trail = $5;
			my $op = "!";

			($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);

			my $type = lc($otype);
			if ($type =~ /^(?:true|false)$/) {
				if (("$test" eq "==" && "$type" eq "true") ||
				    ("$test" eq "!=" && "$type" eq "false")) {
					$op = "";
				}

				CHK("BOOL_COMPARISON",
				    "Using comparison to $otype is error prone\n" . $herecurr);

## maybe suggesting a correct construct would better
##				    "Using comparison to $otype is error prone.  Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);

			}
		}

4182 4183
# check for semaphores initialized locked
		if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
4184 4185
			WARN("CONSIDER_COMPLETION",
			     "consider using a completion\n" . $herecurr);
4186
		}
4187

4188 4189
# recommend kstrto* over simple_strto* and strict_strto*
		if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
4190
			WARN("CONSIDER_KSTRTO",
4191
			     "$1 is obsolete, use k$3 instead\n" . $herecurr);
4192
		}
4193

4194 4195
# check for __initcall(), use device_initcall() explicitly please
		if ($line =~ /^.\s*__initcall\s*\(/) {
4196 4197
			WARN("USE_DEVICE_INITCALL",
			     "please use device_initcall() instead of __initcall()\n" . $herecurr);
4198
		}
4199

4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237
# 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;
4238
		if ($line !~ /\bconst\b/ &&
4239
		    $line =~ /\bstruct\s+($struct_ops)\b/) {
4240 4241
			WARN("CONST_STRUCT",
			     "struct $1 should normally be const\n" .
4242
				$herecurr);
4243
		}
4244 4245 4246 4247

# 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/ &&
4248 4249
		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
4250 4251 4252
		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
4253
		{
4254 4255
			WARN("NR_CPUS",
			     "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
4256
		}
4257

4258 4259 4260 4261 4262 4263
# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
		if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
			ERROR("DEFINE_ARCH_HAS",
			      "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
		}

4264 4265 4266 4267
# check for %L{u,d,i} in strings
		my $string;
		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
			$string = substr($rawline, $-[1], $+[1] - $-[1]);
4268
			$string =~ s/%%/__/g;
4269
			if ($string =~ /(?<!%)%L[udi]/) {
4270 4271
				WARN("PRINTF_L",
				     "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
4272 4273 4274
				last;
			}
		}
4275 4276 4277 4278

# whine mightly about in_atomic
		if ($line =~ /\bin_atomic\s*\(/) {
			if ($realfile =~ m@^drivers/@) {
4279 4280
				ERROR("IN_ATOMIC",
				      "do not use in_atomic in drivers\n" . $herecurr);
4281
			} elsif ($realfile !~ m@^kernel/@) {
4282 4283
				WARN("IN_ATOMIC",
				     "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
4284 4285
			}
		}
4286 4287 4288 4289 4290 4291 4292

# 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@) {
4293 4294
				ERROR("LOCKDEP",
				      "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
4295 4296
			}
		}
4297 4298 4299

		if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
		    $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
4300 4301
			WARN("EXPORTED_WORLD_WRITABLE",
			     "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
4302
		}
4303 4304 4305 4306 4307 4308
	}

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

4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323
	# 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) {
4324 4325
		ERROR("NOT_UNIFIED_DIFF",
		      "Does not appear to be a unified-diff format patch\n");
4326 4327
	}
	if ($is_patch && $chk_signoff && $signoff == 0) {
4328 4329
		ERROR("MISSING_SIGN_OFF",
		      "Missing Signed-off-by: line(s)\n");
4330 4331
	}

4332
	print report_dump();
4333 4334
	if ($summary && !($clean == 1 && $quiet == 1)) {
		print "$filename " if ($summary_file);
4335 4336 4337 4338
		print "total: $cnt_error errors, $cnt_warn warnings, " .
			(($check)? "$cnt_chk checks, " : "") .
			"$cnt_lines lines checked\n";
		print "\n" if ($quiet == 0);
4339
	}
4340

4341
	if ($quiet == 0) {
4342 4343 4344 4345 4346 4347

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

4348 4349 4350 4351 4352
		# 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";
4353
			$rpt_cleaners = 0;
4354 4355 4356
		}
	}

4357 4358
	hash_show_words(\%use_type, "Used");
	hash_show_words(\%ignore_type, "Ignored");
4359

4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393
	if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
		my $newfile = $filename . ".EXPERIMENTAL-checkpatch-fixes";
		my $linecount = 0;
		my $f;

		open($f, '>', $newfile)
		    or die "$P: Can't open $newfile for write\n";
		foreach my $fixed_line (@fixed) {
			$linecount++;
			if ($file) {
				if ($linecount > 3) {
					$fixed_line =~ s/^\+//;
					print $f $fixed_line. "\n";
				}
			} else {
				print $f $fixed_line . "\n";
			}
		}
		close($f);

		if (!$quiet) {
			print << "EOM";
Wrote EXPERIMENTAL --fix correction(s) to '$newfile'

Do _NOT_ trust the results written to this file.
Do _NOT_ submit these changes without inspecting them for correctness.

This EXPERIMENTAL file is simply a convenience to help rewrite patches.
No warranties, expressed or implied...

EOM
		}
	}

4394
	if ($clean == 1 && $quiet == 0) {
4395
		print "$vname has no obvious style problems and is ready for submission.\n"
4396 4397
	}
	if ($clean == 0 && $quiet == 0) {
4398 4399 4400 4401 4402 4403
		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
4404
	}
4405

4406 4407
	return $clean;
}