checkpatch.pl 124.4 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 $fix_inplace = 0;
33
my $root;
34
my %debug;
35
my %camelcase = ();
36 37 38
my %use_type = ();
my @use = ();
my %ignore_type = ();
39
my @ignore = ();
40
my $help = 0;
41
my $configuration_file = ".checkpatch.conf";
42
my $max_line_length = 80;
43 44
my $ignore_perl_version = 0;
my $minimum_perl_version = 5.10.0;
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61

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
62
  --types TYPE(,TYPE2...)    show only these comma separated message types
63
  --ignore TYPE(,TYPE2...)   ignore various comma separated message types
64
  --max-line-length=n        set the maximum line length, if exceeded, warn
65
  --show-types               show the message "types" in the output
66 67 68 69 70 71 72 73 74
  --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
75 76 77 78 79
  --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
80 81 82
  --fix-inplace              EXPERIMENTAL - may create horrible results
                             Is the same as --fix, but overwrites the input
                             file.  It's your fault if there's no backup or git
83 84
  --ignore-perl-version      override checking of perl version.  expect
                             runtime errors.
85 86 87 88 89 90 91 92
  -h, --help, --version      display this help and exit

When FILE is - read standard input.
EOM

	exit($exitcode);
}

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

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

help(0) if ($help);
147

148 149
$fix = 1 if ($fix_inplace);

150 151
my $exit = 0;

152 153 154 155 156 157 158
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);
	}
}

159
if ($#ARGV < 0) {
160
	print "$P: no input files\n";
161 162 163
	exit(1);
}

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

181 182
sub hash_show_words {
	my ($hashRef, $prefix) = @_;
183

184
	if ($quiet == 0 && keys %$hashRef) {
185
		print "NOTE: $prefix message types:";
186
		foreach my $word (sort keys %$hashRef) {
187 188 189 190
			print " $word";
		}
		print "\n\n";
	}
191 192
}

193 194 195
hash_save_array_words(\%ignore_type, \@ignore);
hash_save_array_words(\%use_type, \@use);

196 197
my $dbg_values = 0;
my $dbg_possible = 0;
198
my $dbg_type = 0;
199
my $dbg_attr = 0;
200
for my $key (keys %debug) {
201 202 203
	## no critic
	eval "\${dbg_$key} = '$debug{$key}';";
	die "$@" if ($@);
204 205
}

206 207
my $rpt_cleaners = 0;

208 209 210 211 212
if ($terse) {
	$emacs = 1;
	$quiet++;
}

213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
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);
	}
231 232
}

233 234
my $emitted_corrupt = 0;

235 236 237 238
our $Ident	= qr{
			[A-Za-z_][A-Za-z\d_]*
			(?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
		}x;
239 240 241 242 243 244 245 246
our $Storage	= qr{extern|static|asmlinkage};
our $Sparse	= qr{
			__user|
			__kernel|
			__force|
			__iomem|
			__must_check|
			__init_refok|
247
			__kprobes|
248 249
			__ref|
			__rcu
250
		}x;
251 252 253 254 255
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};
256

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

288 289 290 291
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?};
292 293 294
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]?};
295
our $Float	= qr{$Float_hex|$Float_dec|$Float_int};
296
our $Constant	= qr{$Float|$Binary|$Hex|$Int};
297
our $Assignment	= qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
298
our $Compare    = qr{<=|>=|==|!=|<|>};
299
our $Arithmetic = qr{\+|-|\*|\/|%};
300 301 302
our $Operators	= qr{
			<=|>=|==|!=|
			=>|->|<<|>>|<|>|!|~|
303
			&&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
304 305
		  }x;

306
our $NonptrType;
307
our $NonptrTypeWithAttr;
308 309 310
our $Type;
our $Declare;

311 312
our $NON_ASCII_UTF8	= qr{
	[\xC2-\xDF][\x80-\xBF]               # non-overlong 2-byte
313 314 315 316 317 318 319 320
	|  \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;

321 322 323 324 325
our $UTF8	= qr{
	[\x09\x0A\x0D\x20-\x7E]              # ASCII
	| $NON_ASCII_UTF8
}x;

326
our $typeTypedefs = qr{(?x:
327
	(?:__)?(?:u|s|be|le)(?:8|16|32|64)|
328 329 330
	atomic_t
)};

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

340 341 342 343 344 345
our $signature_tags = qr{(?xi:
	Signed-off-by:|
	Acked-by:|
	Tested-by:|
	Reviewed-by:|
	Reported-by:|
346
	Suggested-by:|
347 348 349 350
	To:|
	Cc:
)};

351 352
our @typeList = (
	qr{void},
353 354 355 356 357 358 359
	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},
360 361 362 363 364 365 366 367 368 369 370
	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},
);
371 372 373 374 375 376
our @typeListWithAttr = (
	@typeList,
	qr{struct\s+$InitAttribute\s+$Ident},
	qr{union\s+$InitAttribute\s+$Ident},
);

377 378 379
our @modifierList = (
	qr{fastcall},
);
380

381 382 383 384 385 386
our $allowed_asm_includes = qr{(?x:
	irq|
	memory
)};
# memory.h: ARM has a custom one

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

419
our $Typecast	= qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
420 421 422 423 424 425 426

# 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*};
427
our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
428 429 430 431 432 433 434 435 436 437

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

438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
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;
456 457 458
		} 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*[;\{]/) {
459 460 461 462 463 464 465 466 467 468
			$camelcase{$1} = 1;
		}
	}
}

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

	my $files;
469 470 471 472
	my $camelcase_cache = "";
	my @include_files = ();

	$camelcase_seeded = 1;
473

474
	if (-d ".git") {
475 476
		my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
		chomp $git_last_include_commit;
477
		$camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
478
	} else {
479
		my $last_mod_date = 0;
480
		$files = `find $root/include -name "*.h"`;
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
		@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;
500
	}
501 502 503 504 505 506

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

507 508 509
	foreach my $file (@include_files) {
		seed_camelcase_file($file);
	}
510

511
	if ($camelcase_cache ne "") {
512
		unlink glob ".checkpatch-camelcase.*";
513 514
		open(my $camelcase_file, '>', "$camelcase_cache")
		    or warn "$P: Can't write '$camelcase_cache' $!\n";
515 516 517 518 519
		foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
			print $camelcase_file ("$_\n");
		}
		close($camelcase_file);
	}
520 521
}

522 523
$chk_signoff = 0 if ($file);

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

exit($exit);

sub top_of_kernel_tree {
560 561 562 563 564 565 566 567 568 569 570 571
	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;
		}
572
	}
573
	return 1;
574
}
575

576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594
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;
595
		$name = trim($name);
596 597 598 599 600 601 602 603 604 605 606 607 608 609
		$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 = "";
		}
	}

610
	$name = trim($name);
611
	$name =~ s/^\"|\"$//g;
612
	$address = trim($address);
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627
	$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;

628
	$name = trim($name);
629
	$name =~ s/^\"|\"$//g;
630
	$address = trim($address);
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645

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

646 647 648 649 650 651 652 653 654 655 656 657
sub which_conf {
	my ($conf) = @_;

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

	return "";
}

658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677
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;
}
678
sub copy_spacing {
679
	(my $res = shift) =~ tr/\t/ /c;
680 681
	return $res;
}
682

683 684 685 686 687 688 689 690 691 692 693 694 695
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));
}

696 697 698 699 700 701 702 703 704 705 706
my $sanitise_quote = '';

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

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
707 708 709 710 711 712
sub sanitise_line {
	my ($line) = @_;

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

713
	my $qlen = 0;
714 715
	my $off = 0;
	my $c;
716

717 718 719 720 721 722 723 724 725 726 727 728 729 730
	# 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;
731
		}
732
		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
733 734 735 736
			$sanitise_quote = '';
			substr($res, $off, 2, "$;$;");
			$off++;
			next;
737
		}
738 739 740 741 742 743 744
		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
			$sanitise_quote = '//';

			substr($res, $off, 2, $sanitise_quote);
			$off++;
			next;
		}
745 746 747 748 749 750 751

		# 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;
752
		}
753 754 755 756
		# Regular quotes.
		if ($c eq "'" || $c eq '"') {
			if ($sanitise_quote eq '') {
				$sanitise_quote = $c;
757

758 759 760 761 762 763
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
764

765
		#print "c<$c> SQ<$sanitise_quote>\n";
766 767
		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
			substr($res, $off, 1, $;);
768 769
		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
			substr($res, $off, 1, $;);
770 771 772 773 774
		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
			substr($res, $off, 1, 'X');
		} else {
			substr($res, $off, 1, $c);
		}
775 776
	}

777 778 779 780
	if ($sanitise_quote eq '//') {
		$sanitise_quote = '';
	}

781
	# The pathname on a #include may be surrounded by '<' and '>'.
782
	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
783 784 785 786
		my $clean = 'X' x length($1);
		$res =~ s@\<.*\>@<$clean>@;

	# The whole of a #error is a string.
787
	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
788
		my $clean = 'X' x length($1);
789
		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
790 791
	}

792 793 794
	return $res;
}

795 796 797 798 799 800 801
sub get_quoted_string {
	my ($line, $rawline) = @_;

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

802 803 804 805 806 807
sub ctx_statement_block {
	my ($linenr, $remain, $off) = @_;
	my $line = $linenr - 1;
	my $blk = '';
	my $soff = $off;
	my $coff = $off - 1;
808
	my $coff_set = 0;
809

810 811
	my $loff = 0;

812 813
	my $type = '';
	my $level = 0;
814
	my @stack = ();
815
	my $p;
816 817
	my $c;
	my $len = 0;
818 819

	my $remainder;
820
	while (1) {
821 822
		@stack = (['', 0]) if ($#stack == -1);

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

851
		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
852 853 854 855 856 857 858 859 860 861

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

862 863 864 865 866 867
		# Statement ends at the ';' or a close '}' at the
		# outermost level.
		if ($level == 0 && $c eq ';') {
			last;
		}

868
		# An else is really a conditional as long as its not else if
869 870 871 872 873 874 875 876
		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";
877 878
		}

879 880 881 882 883 884 885 886 887 888
		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;
889 890
				$coff_set = 1;
				#warn "CSB: mark coff<$coff>\n";
891 892 893 894 895 896 897 898 899 900 901
			}
		}
		if (($type eq '' || $type eq '{') && $c eq '{') {
			$level++;
			$type = '{';
		}
		if ($type eq '{' && $c eq '}') {
			$level--;
			$type = ($level != 0)? '{' : '';

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

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

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

930
	#print "coff<$coff> soff<$off> loff<$loff>\n";
931 932 933 934 935

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

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 972 973 974 975 976 977 978
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;
	}
}

979 980 981 982 983 984
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

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

	return ($level, $linenr, @chunks);
1006 1007
}

1008
sub ctx_block_get {
1009
	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1010 1011 1012 1013 1014 1015 1016
	my $line;
	my $start = $linenr - 1;
	my $blk = '';
	my @o;
	my @c;
	my @res = ();

1017
	my $level = 0;
1018
	my @stack = ($level);
1019 1020 1021 1022 1023
	for ($line = $start; $remain > 0; $line++) {
		next if ($rawlines[$line] =~ /^-/);
		$remain--;

		$blk .= $rawlines[$line];
1024 1025

		# Handle nested #if/#else.
1026
		if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1027
			push(@stack, $level);
1028
		} elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1029
			$level = $stack[$#stack - 1];
1030
		} elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1031 1032 1033
			$level = pop(@stack);
		}

1034
		foreach my $c (split(//, $lines[$line])) {
1035 1036 1037 1038 1039
			##print "C<$c>L<$level><$open$close>O<$off>\n";
			if ($off > 0) {
				$off--;
				next;
			}
1040

1041 1042 1043 1044 1045 1046 1047
			if ($c eq $close && $level > 0) {
				$level--;
				last if ($level == 0);
			} elsif ($c eq $open) {
				$level++;
			}
		}
1048

1049
		if (!$outer || $level <= 1) {
1050
			push(@res, $rawlines[$line]);
1051 1052
		}

1053
		last if ($level == 0);
1054 1055
	}

1056
	return ($level, @res);
1057 1058 1059 1060
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

1061 1062
	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
	return @r;
1063 1064 1065 1066
}
sub ctx_block {
	my ($linenr, $remain) = @_;

1067 1068
	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
	return @r;
1069 1070
}
sub ctx_statement {
1071 1072 1073 1074 1075 1076
	my ($linenr, $remain, $off) = @_;

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

1079
	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1080
}
1081 1082 1083 1084 1085
sub ctx_statement_level {
	my ($linenr, $remain, $off) = @_;

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
1086 1087 1088 1089 1090

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

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

1123
	##print "LINE: $rawlines[$end_line - 1 ]\n";
1124 1125 1126 1127 1128
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
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;
}

1145 1146 1147
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
1148

1149 1150 1151 1152 1153 1154
	$res = '';
	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
		$res .= $1;
		if ($2 ne '') {
			$coded = sprintf("^%c", unpack('C', $2) + 64);
			$res .= $coded;
1155 1156
		}
	}
1157
	$res =~ s/$/\$/;
1158

1159
	return $res;
1160 1161
}

1162
my $av_preprocessor = 0;
1163
my $av_pending;
1164
my @av_paren_type;
1165
my $av_pend_colon;
1166 1167 1168

sub annotate_reset {
	$av_preprocessor = 0;
1169 1170
	$av_pending = '_';
	@av_paren_type = ('E');
1171
	$av_pend_colon = 'O';
1172 1173
}

1174 1175
sub annotate_values {
	my ($stream, $type) = @_;
1176

1177
	my $res;
1178
	my $var = '_' x length($stream);
1179 1180
	my $cur = $stream;

1181
	print "$stream\n" if ($dbg_values > 1);
1182 1183

	while (length($cur)) {
1184
		@av_paren_type = ('E') if ($#av_paren_type < 0);
1185
		print " <" . join('', @av_paren_type) .
1186
				"> <$type> <$av_pending>" if ($dbg_values > 1);
1187
		if ($cur =~ /^(\s+)/o) {
1188 1189
			print "WS($1)\n" if ($dbg_values > 1);
			if ($1 =~ /\n/ && $av_preprocessor) {
1190
				$type = pop(@av_paren_type);
1191
				$av_preprocessor = 0;
1192 1193
			}

1194
		} elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1195 1196
			print "CAST($1)\n" if ($dbg_values > 1);
			push(@av_paren_type, $type);
1197
			$type = 'c';
1198

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

1203 1204 1205 1206
		} elsif ($cur =~ /^($Modifier)\s*/) {
			print "MODIFIER($1)\n" if ($dbg_values > 1);
			$type = 'T';

1207
		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1208
			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1209
			$av_preprocessor = 1;
1210 1211 1212 1213 1214 1215
			push(@av_paren_type, $type);
			if ($2 ne '') {
				$av_pending = 'N';
			}
			$type = 'E';

1216
		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1217 1218 1219
			print "UNDEF($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;
			push(@av_paren_type, $type);
1220

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

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
1227
			$type = 'E';
1228

1229
		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1230 1231 1232 1233 1234
			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;

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

1235
			$type = 'E';
1236

1237
		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1238 1239 1240 1241 1242 1243 1244 1245
			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);
1246
			$type = 'E';
1247 1248

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

1251 1252 1253 1254 1255
		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
			print "ATTR($1)\n" if ($dbg_values > 1);
			$av_pending = $type;
			$type = 'N';

1256
		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1257
			print "SIZEOF($1)\n" if ($dbg_values > 1);
1258
			if (defined $2) {
1259
				$av_pending = 'V';
1260 1261 1262
			}
			$type = 'N';

1263
		} elsif ($cur =~ /^(if|while|for)\b/o) {
1264
			print "COND($1)\n" if ($dbg_values > 1);
1265
			$av_pending = 'E';
1266 1267
			$type = 'N';

1268 1269 1270 1271 1272
		} elsif ($cur =~/^(case)/o) {
			print "CASE($1)\n" if ($dbg_values > 1);
			$av_pend_colon = 'C';
			$type = 'N';

1273
		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1274
			print "KEYWORD($1)\n" if ($dbg_values > 1);
1275 1276 1277
			$type = 'N';

		} elsif ($cur =~ /^(\()/o) {
1278
			print "PAREN('$1')\n" if ($dbg_values > 1);
1279 1280
			push(@av_paren_type, $av_pending);
			$av_pending = '_';
1281 1282 1283
			$type = 'N';

		} elsif ($cur =~ /^(\))/o) {
1284 1285 1286
			my $new_type = pop(@av_paren_type);
			if ($new_type ne '_') {
				$type = $new_type;
1287 1288
				print "PAREN('$1') -> $type\n"
							if ($dbg_values > 1);
1289
			} else {
1290
				print "PAREN('$1')\n" if ($dbg_values > 1);
1291 1292
			}

1293
		} elsif ($cur =~ /^($Ident)\s*\(/o) {
1294
			print "FUNC($1)\n" if ($dbg_values > 1);
1295
			$type = 'V';
1296
			$av_pending = 'V';
1297

1298 1299
		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
			if (defined $2 && $type eq 'C' || $type eq 'T') {
1300
				$av_pend_colon = 'B';
1301 1302
			} elsif ($type eq 'E') {
				$av_pend_colon = 'L';
1303 1304 1305 1306
			}
			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
			$type = 'V';

1307
		} elsif ($cur =~ /^($Ident|$Constant)/o) {
1308
			print "IDENT($1)\n" if ($dbg_values > 1);
1309 1310 1311
			$type = 'V';

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

1315
		} elsif ($cur =~/^(;|{|})/) {
1316
			print "END($1)\n" if ($dbg_values > 1);
1317
			$type = 'E';
1318 1319
			$av_pend_colon = 'O';

1320 1321 1322 1323
		} elsif ($cur =~/^(,)/) {
			print "COMMA($1)\n" if ($dbg_values > 1);
			$type = 'C';

1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337
		} 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';
1338

1339
		} elsif ($cur =~ /^(\[)/o) {
1340
			print "CLOSE($1)\n" if ($dbg_values > 1);
1341 1342
			$type = 'N';

1343
		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355
			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';

1356
		} elsif ($cur =~ /^($Operators)/o) {
1357
			print "OP($1)\n" if ($dbg_values > 1);
1358 1359 1360 1361 1362
			if ($1 ne '++' && $1 ne '--') {
				$type = 'N';
			}

		} elsif ($cur =~ /(^.)/o) {
1363
			print "C($1)\n" if ($dbg_values > 1);
1364 1365 1366 1367 1368
		}
		if (defined $1) {
			$cur = substr($cur, length($1));
			$res .= $type x length($1);
		}
1369
	}
1370

1371
	return ($res, $var);
1372 1373
}

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

		} else {
			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
			push(@typeList, $possible);
		}
1415
		build_types();
1416 1417
	} else {
		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1418 1419 1420
	}
}

1421 1422
my $prefix = '';

1423
sub show_type {
1424 1425 1426
	return defined $use_type{$_[0]} if (scalar keys %use_type > 0);

	return !defined $ignore_type{$_[0]};
1427 1428
}

1429
sub report {
1430 1431
	if (!show_type($_[1]) ||
	    (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
1432 1433
		return 0;
	}
1434 1435 1436 1437 1438 1439
	my $line;
	if ($show_types) {
		$line = "$prefix$_[0]:$_[1]: $_[2]\n";
	} else {
		$line = "$prefix$_[0]: $_[2]\n";
	}
1440 1441
	$line = (split('\n', $line))[0] . "\n" if ($terse);

1442
	push(our @report, $line);
1443 1444

	return 1;
1445 1446
}
sub report_dump {
1447
	our @report;
1448
}
1449

1450
sub ERROR {
1451
	if (report("ERROR", $_[0], $_[1])) {
1452 1453
		our $clean = 0;
		our $cnt_error++;
1454
		return 1;
1455
	}
1456
	return 0;
1457 1458
}
sub WARN {
1459
	if (report("WARNING", $_[0], $_[1])) {
1460 1461
		our $clean = 0;
		our $cnt_warn++;
1462
		return 1;
1463
	}
1464
	return 0;
1465 1466
}
sub CHK {
1467
	if ($check && report("CHECK", $_[0], $_[1])) {
1468 1469
		our $clean = 0;
		our $cnt_chk++;
1470
		return 1;
1471
	}
1472
	return 0;
1473 1474
}

1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497
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 ".../") {
1498 1499
		WARN("USE_RELATIVE_PATH",
		     "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1500 1501 1502
	}
}

1503 1504 1505
sub trim {
	my ($string) = @_;

1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522
	$string =~ s/^\s+|\s+$//g;

	return $string;
}

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

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

	return $string;
}

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

	$string =~ s/\s+$//;
1523 1524 1525 1526

	return $string;
}

1527 1528 1529 1530 1531 1532 1533 1534
sub string_find_replace {
	my ($string, $find, $replace) = @_;

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

	return $string;
}

1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549
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";
}

1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579
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;
}

1580 1581 1582 1583 1584
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
1585
	my $prevrawline="";
1586
	my $stashline="";
1587
	my $stashrawline="";
1588

1589
	my $length;
1590 1591 1592 1593
	my $indent;
	my $previndent=0;
	my $stashindent=0;

1594
	our $clean = 1;
1595 1596 1597
	my $signoff = 0;
	my $is_patch = 0;

1598 1599 1600
	my $in_header_lines = 1;
	my $in_commit_log = 0;		#Scanning lines before patch

1601 1602
	my $non_utf8_charset = 0;

1603
	our @report = ();
1604 1605 1606 1607 1608
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

1609 1610 1611 1612 1613 1614
	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
	my $in_comment = 0;
1615
	my $comment_edge = 0;
1616
	my $first_line = 0;
1617
	my $p1_prefix = '';
1618

1619 1620 1621
	my $prev_values = 'E';

	# suppression flags
1622
	my %suppress_ifbraces;
1623
	my %suppress_whiletrailers;
1624
	my %suppress_export;
1625
	my $suppress_statement = 0;
1626

1627
	my %signatures = ();
1628

1629
	# Pre-scan the patch sanitizing the lines.
1630
	# Pre-scan the patch looking for any __setup documentation.
1631
	#
1632 1633
	my @setup_docs = ();
	my $setup_docs = 0;
1634

1635 1636
	my $camelcase_file_seeded = 0;

1637
	sanitise_line_reset();
1638 1639
	my $line;
	foreach my $rawline (@rawlines) {
1640 1641
		$linenr++;
		$line = $rawline;
1642

1643 1644
		push(@fixed, $rawline) if ($fix);

1645
		if ($rawline=~/^\+\+\+\s+(\S+)/) {
1646 1647 1648 1649
			$setup_docs = 0;
			if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
				$setup_docs = 1;
			}
1650 1651 1652 1653 1654 1655 1656 1657 1658
			#next;
		}
		if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1659
			$in_comment = 0;
1660 1661 1662 1663 1664 1665

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

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

1695
		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1696
			# Standardise the strings and chars within the input to
1697
			# simplify matching -- only bother with positive lines.
1698
			$line = sanitise_line($rawline);
1699
		}
1700 1701 1702 1703 1704 1705 1706 1707 1708 1709
		push(@lines, $line);

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

		#print "==>$rawline\n";
		#print "-->$line\n";
1710 1711 1712 1713 1714 1715

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

1716 1717
	$prefix = '';

1718 1719
	$realcnt = 0;
	$linenr = 0;
1720 1721
	foreach my $line (@lines) {
		$linenr++;
1722 1723
		my $sline = $line;	#copy of $line
		$sline =~ s/$;/ /g;	#with comments as spaces
1724

1725
		my $rawline = $rawlines[$linenr - 1];
1726

1727
#extract the line range in the file after the patch is applied
1728
		if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1729
			$is_patch = 1;
1730
			$first_line = $linenr + 1;
1731 1732 1733 1734 1735 1736
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1737
			annotate_reset();
1738 1739
			$prev_values = 'E';

1740
			%suppress_ifbraces = ();
1741
			%suppress_whiletrailers = ();
1742
			%suppress_export = ();
1743
			$suppress_statement = 0;
1744 1745
			next;

1746 1747 1748
# 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.
1749
		} elsif ($line =~ /^( |\+|$)/) {
1750
			$realline++;
1751
			$realcnt-- if ($realcnt != 0);
1752

1753
			# Measure the line length and indent.
1754
			($length, $indent) = line_stats($rawline);
1755 1756 1757 1758

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

1761
			#warn "line<$line>\n";
1762

1763 1764
		} elsif ($realcnt == 1) {
			$realcnt--;
1765 1766
		}

1767 1768
		my $hunk_line = ($realcnt != 0);

1769
#make up the handle for any error we report on this line
1770 1771 1772
		$prefix = "$filename:$realline: " if ($emacs && $file);
		$prefix = "$filename:$linenr: " if ($emacs && !$file);

1773 1774
		$here = "#$linenr: " if (!$file);
		$here = "#$realline: " if ($file);
1775 1776

		# extract the filename as it passes
1777 1778
		if ($line =~ /^diff --git.*?(\S+)$/) {
			$realfile = $1;
1779
			$realfile =~ s@^([^/]*)/@@ if (!$file);
1780
			$in_commit_log = 0;
1781
		} elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1782
			$realfile = $1;
1783
			$realfile =~ s@^([^/]*)/@@ if (!$file);
1784
			$in_commit_log = 0;
1785 1786

			$p1_prefix = $1;
1787 1788
			if (!$file && $tree && $p1_prefix ne '' &&
			    -e "$root/$p1_prefix") {
1789 1790
				WARN("PATCH_PREFIX",
				     "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1791
			}
1792

1793
			if ($realfile =~ m@^include/asm/@) {
1794 1795
				ERROR("MODIFIED_INCLUDE_ASM",
				      "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1796 1797 1798 1799
			}
			next;
		}

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

1802 1803 1804
		my $hereline = "$here\n$rawline\n";
		my $herecurr = "$here\n$rawline\n";
		my $hereprev = "$here\n$prevrawline\n$rawline\n";
1805

1806 1807
		$cnt_lines++ if ($realcnt != 0);

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

1818
# Check the patch for a signoff:
1819
		if ($line =~ /^\s*signed-off-by:/i) {
1820
			$signoff++;
1821
			$in_commit_log = 0;
1822 1823 1824
		}

# Check signature styles
1825
		if (!$in_header_lines &&
1826
		    $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
1827 1828 1829 1830 1831 1832
			my $space_before = $1;
			my $sign_off = $2;
			my $space_after = $3;
			my $email = $4;
			my $ucfirst_sign_off = ucfirst(lc($sign_off));

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

1853 1854
			}
			if (!defined $space_after || $space_after ne " ") {
1855 1856 1857 1858 1859 1860
				if (WARN("BAD_SIGN_OFF",
					 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
				    $fix) {
					$fixed[$linenr - 1] =
					    "$ucfirst_sign_off $email";
				}
1861
			}
1862 1863 1864 1865

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

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

1894
# Check for wrappage within a valid hunk of the file
1895
		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1896 1897
			ERROR("CORRUPTED_PATCH",
			      "patch seems to be corrupt (line wrapped?)\n" .
1898
				$herecurr) if (!$emitted_corrupt++);
1899 1900
		}

1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914
# 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);
				}
			}
		}

1915 1916
# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1917 1918 1919 1920 1921 1922 1923
		    $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";

1924 1925
			CHK("INVALID_UTF8",
			    "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1926 1927
		}

1928 1929 1930
# 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 =~ /^$/ &&
1931
		    $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
1932 1933 1934 1935
			$in_header_lines = 0;
			$in_commit_log = 1;
		}

1936 1937 1938 1939 1940 1941 1942 1943 1944
# 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 =~ /^$/ &&
1945
		    $rawline =~ /$NON_ASCII_UTF8/) {
1946
			WARN("UTF8_BEFORE_PATCH",
1947 1948 1949
			    "8-bit UTF-8 used in possible commit log\n" . $herecurr);
		}

1950 1951
# ignore non-hunk lines and lines being removed
		next if (!$hunk_line || $line =~ /^-/);
1952 1953

#trailing whitespace
1954
		if ($line =~ /^\+.*\015/) {
1955
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1956 1957 1958 1959 1960
			if (ERROR("DOS_LINE_ENDINGS",
				  "DOS line endings\n" . $herevet) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/[\s\015]+$//;
			}
1961 1962
		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1963 1964 1965
			if (ERROR("TRAILING_WHITESPACE",
				  "trailing whitespace\n" . $herevet) &&
			    $fix) {
1966
				$fixed[$linenr - 1] =~ s/\s+$//;
1967 1968
			}

1969
			$rpt_cleaners = 1;
1970
		}
1971

1972
# Check for FSF mailing addresses.
1973
		if ($rawline =~ /\bwrite to the Free/i ||
1974 1975
		    $rawline =~ /\b59\s+Temple\s+Pl/i ||
		    $rawline =~ /\b51\s+Franklin\s+St/i) {
1976 1977 1978 1979
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
			my $msg_type = \&ERROR;
			$msg_type = \&CHK if ($file);
			&{$msg_type}("FSF_MAILING_ADDRESS",
1980
				     "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)
1981 1982
		}

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

				next if ($f =~ /^-/);
2000 2001 2002 2003 2004 2005 2006

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

2007
				$f =~ s/^.//;
2008 2009 2010
				$f =~ s/#.*//;
				$f =~ s/^\s+//;
				next if ($f =~ /^$/);
2011 2012 2013 2014
				if ($f =~ /^\s*config\s/) {
					$is_end = 1;
					last;
				}
2015 2016
				$length++;
			}
2017
			WARN("CONFIG_DESCRIPTION",
2018 2019
			     "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";
2020 2021
		}

2022 2023 2024 2025 2026 2027 2028
# 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");
		}

2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042
		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});
		}

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

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

2057
# Check for user-visible strings broken across lines, which breaks the ability
2058 2059 2060
# to grep for the string.  Make exceptions when the previous string ends in a
# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
2061 2062
		if ($line =~ /^\+\s*"/ &&
		    $prevline =~ /"\s*$/ &&
2063
		    $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
2064 2065 2066 2067
			WARN("SPLIT_STRING",
			     "quoted string split across lines\n" . $hereprev);
		}

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

2076 2077
		}

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

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

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

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

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

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

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

				if ($newindent ne $goodtabindent &&
				    $newindent ne $goodspaceindent) {
2152 2153 2154 2155 2156 2157 2158

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

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

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

		if ($realfile =~ m@^(drivers/net/|net/)@ &&
2180 2181
		    $prevrawline =~ /^\+[ \t]*\/\*/ &&		#starting /*
		    $prevrawline !~ /\*\/[ \t]*$/ &&		#no trailing */
2182
		    $rawline =~ /^\+/ &&			#line is new
2183 2184 2185 2186 2187 2188
		    $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/)@ &&
2189 2190 2191 2192
		    $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ &&	#trailing */
		    $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ &&	#inline /*...*/
		    $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ &&	#trailing **/
		    $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) {	#non blank */
2193 2194 2195 2196
			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
			     "networking block comments put the trailing */ on a separate line\n" . $herecurr);
		}

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

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

2214 2215 2216 2217 2218 2219
# 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");
		}

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

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

2238 2239 2240 2241 2242 2243
# 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);
		}

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

2255 2256 2257 2258 2259 2260 2261 2262 2263
#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;
			}
2264

2265 2266 2267 2268 2269 2270 2271 2272
			# 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++;
			}

2273 2274
			my $s = $stat;
			$s =~ s/{.*$//s;
2275

2276
			# Ignore goto labels.
2277
			if ($s =~ /$Ident:\*$/s) {
2278 2279

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

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

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

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

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

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

2306
				my $ctx = $s;
2307
				substr($ctx, 0, $name_len + 1, '');
2308
				$ctx =~ s/\)[^\)]*$//;
2309

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

2313
						possible($1, "D:" . $s);
2314 2315
					}
				}
2316
			}
2317

2318 2319
		}

2320 2321 2322
#
# Checks which may be anchored in the context.
#
2323

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

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

2352
			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2353 2354 2355 2356 2357 2358

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

2359 2360 2361
			my $ctx_cnt = $realcnt - $#ctx - 1;
			my $ctx = join("\n", @ctx);

2362 2363
			my $ctx_ln = $linenr;
			my $ctx_skip = $realcnt;
2364

2365 2366 2367 2368 2369
			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] !~ /^-/);
2370 2371
				$ctx_ln++;
			}
2372

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

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

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

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

2436
			my $cond_ptr = -1;
2437
			$continuation = 0;
2438 2439 2440
			while ($cond_ptr != $cond_lines) {
				$cond_ptr = $cond_lines;

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

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

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

2475
			#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";
2476 2477 2478

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

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

2497
#ignore lines not being added
2498
		next if ($line =~ /^[^\+]/);
2499

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

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

2530 2531 2532 2533 2534
#
# Checks which are anchored on the added line.
#

# check for malformed paths in #include statements (uses RAW line)
2535
		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2536 2537
			my $path = $1;
			if ($path =~ m{//}) {
2538
				ERROR("MALFORMED_INCLUDE",
2539 2540 2541 2542 2543
				      "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);
2544 2545
			}
		}
2546

2547
# no C99 // comments
2548
		if ($line =~ m{//}) {
2549 2550 2551 2552 2553 2554 2555 2556 2557
			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 \*/@;
				}
			}
2558
		}
2559
		# Remove C99 comments.
2560
		$line =~ s@//.*@@;
2561
		$opline =~ s@//.*@@;
2562

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

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

2608
# check for global initialisers.
2609 2610 2611 2612 2613 2614 2615
		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;/;
			}
2616
		}
2617
# check for static initialisers.
2618 2619 2620 2621 2622 2623 2624
		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;/;
			}
2625 2626
		}

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

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

2641 2642 2643 2644 2645 2646 2647
# check for uses of DEFINE_PCI_DEVICE_TABLE
		if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
			if (WARN("DEFINE_PCI_DEVICE_TABLE",
				 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
			}
2648 2649
		}

2650 2651 2652
# check for new typedefs, only function parameters and sparse annotations
# make sense.
		if ($line =~ /\btypedef\s/ &&
2653
		    $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
2654
		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
2655
		    $line !~ /\b$typeTypedefs\b/ &&
2656
		    $line !~ /\b__bitwise(?:__|)\b/) {
2657 2658
			WARN("NEW_TYPEDEFS",
			     "do not add new typedefs\n" . $herecurr);
2659 2660 2661
		}

# * goes on variable not on type
2662
		# (char*[ const])
2663 2664
		while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
			#print "AA<$1>\n";
2665
			my ($ident, $from, $to) = ($1, $2, $2);
2666 2667 2668 2669 2670 2671

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

2675
##			print "1: from<$from> to<$to> ident<$ident>\n";
2676
			if ($from ne $to) {
2677 2678 2679 2680 2681 2682 2683 2684 2685
				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@;
				}
2686
			}
2687 2688 2689
		}
		while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
			#print "BB<$1>\n";
2690
			my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
2691 2692 2693 2694 2695 2696

			# Should start with a space.
			$to =~ s/^(\S)/ $1/;
			# Should not end with a space.
			$to =~ s/\s+$//;
			# '*'s should not have spaces between.
2697
			while ($to =~ s/\*\s+\*/\*\*/) {
2698 2699 2700
			}
			# Modifiers should have spaces.
			$to =~ s/(\b$Modifier$)/$1 /;
2701

2702
##			print "2: from<$from> to<$to> ident<$ident>\n";
2703
			if ($from ne $to && $ident !~ /^$Modifier$/) {
2704 2705 2706 2707 2708 2709 2710 2711 2712 2713
				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@;
				}
2714
			}
2715 2716 2717 2718 2719 2720 2721 2722 2723
		}

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

2724
		if ($line =~ /\bLINUX_VERSION_CODE\b/) {
2725 2726
			WARN("LINUX_VERSION_CODE",
			     "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
2727 2728
		}

2729 2730
# check for uses of printk_ratelimit
		if ($line =~ /\bprintk_ratelimit\s*\(/) {
2731 2732
			WARN("PRINTK_RATELIMITED",
"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
2733 2734
		}

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

2759 2760 2761 2762
		if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
			my $orig = $1;
			my $level = lc($orig);
			$level = "warn" if ($level eq "warning");
2763 2764
			my $level2 = $level;
			$level2 = "dbg" if ($level eq "debug");
2765
			WARN("PREFER_PR_LEVEL",
2766
			     "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(...  to printk(KERN_$orig ...\n" . $herecurr);
2767 2768 2769
		}

		if ($line =~ /\bpr_warning\s*\(/) {
2770 2771 2772 2773 2774 2775
			if (WARN("PREFER_PR_LEVEL",
				 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/\bpr_warning\b/pr_warn/;
			}
2776 2777
		}

2778 2779 2780 2781 2782 2783 2784 2785 2786
		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);
		}

2787 2788
# function brace can't be on same line, except for #defines of do while,
# or if closed on same line
2789 2790
		if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
		    !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
2791 2792
			ERROR("OPEN_BRACE",
			      "open brace '{' following function declarations go on the next line\n" . $herecurr);
2793
		}
2794

2795 2796 2797
# 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*$/) {
2798 2799
			ERROR("OPEN_BRACE",
			      "open brace '{' following $1 go on the same line\n" . $hereprev);
2800 2801
		}

2802
# missing space after union, struct or enum definition
2803 2804 2805 2806 2807 2808 2809
		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/;
			}
2810 2811
		}

2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870
# Function pointer declarations
# check spacing between type, funcptr, and args
# canonical declaration is "type (*funcptr)(args...)"
#
# the $Declare variable will capture all spaces after the type
# so check it for trailing missing spaces or multiple spaces
		if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)$Ident(\s*)\)(\s*)\(/) {
			my $declare = $1;
			my $pre_pointer_space = $2;
			my $post_pointer_space = $3;
			my $funcname = $4;
			my $post_funcname_space = $5;
			my $pre_args_space = $6;

			if ($declare !~ /\s$/) {
				WARN("SPACING",
				     "missing space after return type\n" . $herecurr);
			}

# unnecessary space "type  (*funcptr)(args...)"
			elsif ($declare =~ /\s{2,}$/) {
				WARN("SPACING",
				     "Multiple spaces after return type\n" . $herecurr);
			}

# unnecessary space "type ( *funcptr)(args...)"
			if (defined $pre_pointer_space &&
			    $pre_pointer_space =~ /^\s/) {
				WARN("SPACING",
				     "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
			}

# unnecessary space "type (* funcptr)(args...)"
			if (defined $post_pointer_space &&
			    $post_pointer_space =~ /^\s/) {
				WARN("SPACING",
				     "Unnecessary space before function pointer name\n" . $herecurr);
			}

# unnecessary space "type (*funcptr )(args...)"
			if (defined $post_funcname_space &&
			    $post_funcname_space =~ /^\s/) {
				WARN("SPACING",
				     "Unnecessary space after function pointer name\n" . $herecurr);
			}

# unnecessary space "type (*funcptr) (args...)"
			if (defined $pre_args_space &&
			    $pre_args_space =~ /^\s/) {
				WARN("SPACING",
				     "Unnecessary space before function pointer arguments\n" . $herecurr);
			}

			if (show_type("SPACING") && $fix) {
				$fixed[$linenr - 1] =~
				    s/^(.\s*$Declare)\(\s*\*\s*($Ident)\s*\)\s*\(/rtrim($1) . " " . "\(\*$2\)\("/ex;
			}
		}

2871 2872
# check for spacing round square brackets; allowed:
#  1. with a type on the left -- int [] a;
2873 2874
#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
#  3. inside a curly brace -- = { [0...10] = 5 }
2875 2876 2877
		while ($line =~ /(.*?\s)\[/g) {
			my ($where, $prefix) = ($-[1], $1);
			if ($prefix !~ /$Type\s+$/ &&
2878
			    ($where != 0 || $prefix !~ /^.\s+$/) &&
2879
			    $prefix !~ /[{,]\s+$/) {
2880 2881 2882 2883 2884 2885
				if (ERROR("BRACKET_SPACE",
					  "space prohibited before open square bracket '['\n" . $herecurr) &&
				    $fix) {
				    $fixed[$linenr - 1] =~
					s/^(\+.*?)\s+\[/$1\[/;
				}
2886 2887 2888
			}
		}

2889
# check for spaces between functions and their parentheses.
2890
		while ($line =~ /($Ident)\s+\(/g) {
2891
			my $name = $1;
2892 2893
			my $ctx_before = substr($line, 0, $-[1]);
			my $ctx = "$ctx_before$name";
2894 2895

			# Ignore those directives where spaces _are_ permitted.
2896 2897 2898 2899 2900 2901
			if ($name =~ /^(?:
				if|for|while|switch|return|case|
				volatile|__volatile__|
				__attribute__|format|__extension__|
				asm|__asm__)$/x)
			{
2902 2903 2904
			# 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.
2905
			} elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
2906 2907

			# cpp #elif statement condition may start with a (
2908
			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
2909 2910 2911

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

			} else {
2915 2916 2917 2918 2919 2920
				if (WARN("SPACING",
					 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
					     $fix) {
					$fixed[$linenr - 1] =~
					    s/\b$name\s+\(/$name\(/;
				}
2921
			}
2922
		}
2923

2924
# Check operator spacing.
2925
		if (!($line=~/\#\s*include/)) {
2926 2927 2928
			my $fixed_line = "";
			my $line_fixed = 0;

2929 2930 2931 2932
			my $ops = qr{
				<<=|>>=|<=|>=|==|!=|
				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
				=>|->|<<|>>|<|>|=|!|~|
2933
				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2934
				\?:|\?|:
2935
			}x;
2936
			my @elements = split(/($ops|;)/, $opline);
2937 2938 2939 2940 2941 2942 2943

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

			my @fix_elements = ();
2944
			my $off = 0;
2945

2946 2947 2948 2949 2950 2951 2952
			foreach my $el (@elements) {
				push(@fix_elements, substr($rawline, $off, length($el)));
				$off += length($el);
			}

			$off = 0;

2953
			my $blank = copy_spacing($opline);
2954
			my $last_after = -1;
2955

2956
			for (my $n = 0; $n < $#elements; $n += 2) {
2957 2958 2959 2960 2961

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

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

2962 2963
				$off += length($elements[$n]);

L
Lucas De Marchi 已提交
2964
				# Pick up the preceding and succeeding characters.
2965 2966 2967 2968 2969 2970 2971
				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";

2972 2973 2974
				my $a = '';
				$a = 'V' if ($elements[$n] ne '');
				$a = 'W' if ($elements[$n] =~ /\s$/);
2975
				$a = 'C' if ($elements[$n] =~ /$;$/);
2976 2977
				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
				$a = 'O' if ($elements[$n] eq '');
2978
				$a = 'E' if ($ca =~ /^\s*$/);
2979

2980
				my $op = $elements[$n + 1];
2981 2982

				my $c = '';
2983
				if (defined $elements[$n + 2]) {
2984 2985
					$c = 'V' if ($elements[$n + 2] ne '');
					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
2986
					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
2987 2988
					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
					$c = 'O' if ($elements[$n + 2] eq '');
2989
					$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
2990 2991
				} else {
					$c = 'E';
2992 2993
				}

2994 2995 2996 2997
				my $ctx = "${a}x${c}";

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

2998
				my $ptr = substr($blank, 0, $off) . "^";
2999
				my $hereptr = "$hereline$ptr\n";
3000

3001
				# Pull out the value of this operator.
3002
				my $op_type = substr($curr_values, $off + 1, 1);
3003

3004 3005 3006
				# Get the full operator variant.
				my $opv = $op . substr($curr_vars, $off, 1);

3007 3008 3009 3010
				# Ignore operators passed as parameters.
				if ($op_type ne 'V' &&
				    $ca =~ /\s$/ && $cc =~ /^\s*,/) {

3011 3012
#				# Ignore comments
#				} elsif ($op =~ /^$;+$/) {
3013

3014
				# ; should have either the end of line or a space or \ after it
3015
				} elsif ($op eq ';') {
3016 3017
					if ($ctx !~ /.x[WEBC]/ &&
					    $cc !~ /^\\/ && $cc !~ /^;/) {
3018 3019
						if (ERROR("SPACING",
							  "space required after that '$op' $at\n" . $hereptr)) {
3020
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3021 3022
							$line_fixed = 1;
						}
3023 3024 3025 3026
					}

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

3028 3029 3030 3031
				# No spaces for:
				#   ->
				#   :   when part of a bitfield
				} elsif ($op eq '->' || $opv eq ':B') {
3032
					if ($ctx =~ /Wx.|.xW/) {
3033 3034
						if (ERROR("SPACING",
							  "spaces prohibited around that '$op' $at\n" . $hereptr)) {
3035
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3036 3037 3038
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3039
							$line_fixed = 1;
3040
						}
3041 3042 3043 3044
					}

				# , must have a space on the right.
				} elsif ($op eq ',') {
3045
					if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
3046 3047
						if (ERROR("SPACING",
							  "space required after that '$op' $at\n" . $hereptr)) {
3048
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3049
							$line_fixed = 1;
3050
							$last_after = $n;
3051
						}
3052 3053
					}

3054
				# '*' as part of a type definition -- reported already.
3055
				} elsif ($opv eq '*_') {
3056 3057 3058 3059 3060 3061
					#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 '~' ||
3062
					 $opv eq '*U' || $opv eq '-U' ||
3063
					 $opv eq '&U' || $opv eq '&&U') {
3064
					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
3065 3066
						if (ERROR("SPACING",
							  "space required before that '$op' $at\n" . $hereptr)) {
3067 3068 3069 3070
							if ($n != $last_after + 2) {
								$good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
								$line_fixed = 1;
							}
3071
						}
3072
					}
3073
					if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
3074 3075 3076
						# A unary '*' may be const

					} elsif ($ctx =~ /.xW/) {
3077 3078
						if (ERROR("SPACING",
							  "space prohibited after that '$op' $at\n" . $hereptr)) {
3079
							$good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
3080 3081 3082
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3083
							$line_fixed = 1;
3084
						}
3085 3086 3087 3088
					}

				# unary ++ and unary -- are allowed no space on one side.
				} elsif ($op eq '++' or $op eq '--') {
3089
					if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
3090 3091
						if (ERROR("SPACING",
							  "space required one side of that '$op' $at\n" . $hereptr)) {
3092
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3093 3094
							$line_fixed = 1;
						}
3095 3096 3097
					}
					if ($ctx =~ /Wx[BE]/ ||
					    ($ctx =~ /Wx./ && $cc =~ /^;/)) {
3098 3099
						if (ERROR("SPACING",
							  "space prohibited before that '$op' $at\n" . $hereptr)) {
3100
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3101 3102
							$line_fixed = 1;
						}
3103
					}
3104
					if ($ctx =~ /ExW/) {
3105 3106
						if (ERROR("SPACING",
							  "space prohibited after that '$op' $at\n" . $hereptr)) {
3107
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3108 3109 3110
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3111
							$line_fixed = 1;
3112
						}
3113
					}
3114 3115

				# << and >> may either have or not have spaces both sides
3116 3117 3118
				} elsif ($op eq '<<' or $op eq '>>' or
					 $op eq '&' or $op eq '^' or $op eq '|' or
					 $op eq '+' or $op eq '-' or
3119 3120
					 $op eq '*' or $op eq '/' or
					 $op eq '%')
3121
				{
3122
					if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
3123 3124
						if (ERROR("SPACING",
							  "need consistent spacing around '$op' $at\n" . $hereptr)) {
3125 3126 3127 3128
							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3129 3130
							$line_fixed = 1;
						}
3131 3132
					}

3133 3134 3135 3136
				# 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./) {
3137 3138
						if (ERROR("SPACING",
							  "space prohibited before that '$op' $at\n" . $hereptr)) {
3139
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3140 3141
							$line_fixed = 1;
						}
3142 3143
					}

3144
				# All the others need spaces both sides.
3145
				} elsif ($ctx !~ /[EWC]x[CWE]/) {
3146 3147
					my $ok = 0;

3148
					# Ignore email addresses <foo@bar>
3149 3150 3151 3152 3153 3154 3155 3156
					if (($op eq '<' &&
					     $cc =~ /^\S+\@\S+>/) ||
					    ($op eq '>' &&
					     $ca =~ /<\S+\@\S+$/))
					{
					    	$ok = 1;
					}

3157
					# messages are ERROR, but ?: are CHK
3158
					if ($ok == 0) {
3159 3160 3161 3162 3163
						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)) {
3164 3165 3166 3167
							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3168 3169
							$line_fixed = 1;
						}
3170
					}
3171
				}
3172
				$off += length($elements[$n + 1]);
3173 3174 3175 3176 3177 3178 3179 3180

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

				$fixed_line = $fixed_line . $good;
			}

			if (($#elements % 2) == 0) {
				$fixed_line = $fixed_line . $fix_elements[$#elements];
3181
			}
3182 3183 3184 3185 3186 3187

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


3188 3189
		}

3190
# check for whitespace before a non-naked semicolon
3191
		if ($line =~ /^\+.*\S\s+;\s*$/) {
3192 3193 3194 3195 3196 3197 3198 3199
			if (WARN("SPACING",
				 "space prohibited before semicolon\n" . $herecurr) &&
			    $fix) {
				1 while $fixed[$linenr - 1] =~
				    s/^(\+.*\S)\s+;/$1;/;
			}
		}

3200 3201
# check for multiple assignments
		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
3202 3203
			CHK("MULTIPLE_ASSIGNMENTS",
			    "multiple assignments should be avoided\n" . $herecurr);
3204 3205
		}

3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216
## # 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 =~ /,/) {
3217 3218
## 				WARN("MULTIPLE_DECLARATION",
##				     "declaring multiple variables together should be avoided\n" . $herecurr);
3219 3220
## 			}
## 		}
3221

3222
#need space before brace following if, while, etc
3223 3224
		if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
		    $line =~ /do{/) {
3225 3226 3227
			if (ERROR("SPACING",
				  "space required before the open brace '{'\n" . $herecurr) &&
			    $fix) {
3228
				$fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/;
3229
			}
3230 3231
		}

3232 3233 3234 3235 3236 3237 3238 3239
## # check for blank lines before declarations
##		if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
##		    $prevrawline =~ /^.\s*$/) {
##			WARN("SPACING",
##			     "No blank lines before declarations\n" . $hereprev);
##		}
##

3240 3241 3242
# closing brace should have a space following it when it has anything
# on the line
		if ($line =~ /}(?!(?:,|;|\)))\S/) {
3243 3244 3245 3246 3247 3248
			if (ERROR("SPACING",
				  "space required after that close brace '}'\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/}((?!(?:,|;|\)))\S)/} $1/;
			}
3249 3250
		}

3251 3252
# check spacing on square brackets
		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
3253 3254 3255 3256 3257 3258
			if (ERROR("SPACING",
				  "space prohibited after that open square bracket '['\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/\[\s+/\[/;
			}
3259 3260
		}
		if ($line =~ /\s\]/) {
3261 3262 3263 3264 3265 3266
			if (ERROR("SPACING",
				  "space prohibited before that close square bracket ']'\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/\s+\]/\]/;
			}
3267 3268
		}

3269
# check spacing on parentheses
3270 3271
		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
		    $line !~ /for\s*\(\s+;/) {
3272 3273 3274 3275 3276 3277
			if (ERROR("SPACING",
				  "space prohibited after that open parenthesis '('\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/\(\s+/\(/;
			}
3278
		}
3279
		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
3280 3281
		    $line !~ /for\s*\(.*;\s+\)/ &&
		    $line !~ /:\s+\)/) {
3282 3283 3284 3285 3286 3287
			if (ERROR("SPACING",
				  "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/\s+\)/\)/;
			}
3288 3289
		}

3290
#goto labels aren't indented, allow a single space however
3291
		if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
3292
		   !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
3293 3294 3295 3296 3297 3298
			if (WARN("INDENTED_LABEL",
				 "labels should not be indented\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/^(.)\s+/$1/;
			}
3299 3300
		}

3301
# Return is not a function.
3302
		if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
3303
			my $spacing = $1;
3304 3305
			if ($^V && $^V ge 5.10.0 &&
			    $stat =~ /^.\s*return\s*$balanced_parens\s*;\s*$/) {
3306 3307
				ERROR("RETURN_PARENTHESES",
				      "return is not a function, parentheses are not required\n" . $herecurr);
3308 3309

			} elsif ($spacing !~ /\s+/) {
3310 3311
				ERROR("SPACING",
				      "space required before the open parenthesis '('\n" . $herecurr);
3312 3313
			}
		}
3314

3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328
# if statements using unnecessary parentheses - ie: if ((foo == bar))
		if ($^V && $^V ge 5.10.0 &&
		    $line =~ /\bif\s*((?:\(\s*){2,})/) {
			my $openparens = $1;
			my $count = $openparens =~ tr@\(@\(@;
			my $msg = "";
			if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
				my $comp = $4;	#Not $1 because of $LvalOrFunc
				$msg = " - maybe == should be = ?" if ($comp eq "==");
				WARN("UNNECESSARY_PARENTHESES",
				     "Unnecessary parentheses$msg\n" . $herecurr);
			}
		}

3329 3330 3331 3332
# 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') {
3333 3334
				WARN("USE_NEGATIVE_ERRNO",
				     "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
3335 3336
			}
		}
3337

3338
# Need a space before open parenthesis after if, while etc
3339 3340 3341 3342 3343 3344 3345
		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 \(/;
			}
3346 3347
		}

3348 3349
# Check for illegal assignment in if conditional -- and check for trailing
# statements after the conditional.
3350
		if ($line =~ /do\s*(?!{)/) {
3351 3352 3353
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371
			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} &&
3372
		    defined($stat) && defined($cond) &&
3373
		    $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
3374
			my ($s, $c) = ($stat, $cond);
3375

3376
			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
3377 3378
				ERROR("ASSIGN_IN_IF",
				      "do not use assignment in if condition\n" . $herecurr);
3379 3380 3381 3382
			}

			# Find out what is on the end of the line after the
			# conditional.
3383
			substr($s, 0, length($c), '');
3384
			$s =~ s/\n.*//g;
3385
			$s =~ s/$;//g; 	# Remove any comments
3386 3387
			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
			    $c !~ /}\s*while\s*/)
3388
			{
3389 3390 3391
				# Find out how long the conditional actually is.
				my @newlines = ($c =~ /\n/gs);
				my $cond_lines = 1 + $#newlines;
3392
				my $stat_real = '';
3393

3394 3395
				$stat_real = raw_line($linenr, $cond_lines)
							. "\n" if ($cond_lines);
3396 3397 3398 3399
				if (defined($stat_real) && $cond_lines > 1) {
					$stat_real = "[...]\n$stat_real";
				}

3400 3401
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr . $stat_real);
3402 3403 3404
			}
		}

3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416
# Check for bitwise tests written as boolean
		if ($line =~ /
			(?:
				(?:\[|\(|\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\|)
			|
				(?:\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\||\)|\])
			)/x)
		{
3417 3418
			WARN("HEXADECIMAL_BOOLEAN_TEST",
			     "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
3419 3420
		}

3421
# if and else should not have general statements after it
3422 3423 3424 3425
		if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
			my $s = $1;
			$s =~ s/$;//g; 	# Remove any comments
			if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
3426 3427
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr);
3428
			}
3429
		}
3430 3431
# if should not continue a brace
		if ($line =~ /}\s*if\b/) {
3432 3433
			ERROR("TRAILING_STATEMENTS",
			      "trailing statements should be on next line\n" .
3434 3435
				$herecurr);
		}
3436 3437 3438
# case and default should not have general statements after them
		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
		    $line !~ /\G(?:
3439
			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
3440 3441 3442
			\s*return\s+
		    )/xg)
		{
3443 3444
			ERROR("TRAILING_STATEMENTS",
			      "trailing statements should be on next line\n" . $herecurr);
3445
		}
3446 3447 3448 3449 3450

		# 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) {
3451 3452
			ERROR("ELSE_AFTER_BRACE",
			      "else should follow close brace '}'\n" . $hereprev);
3453 3454
		}

3455 3456 3457 3458 3459 3460
		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.
3461
			substr($s, 0, length($c), '');
3462 3463 3464
			$s =~ s/\n.*//g;

			if ($s =~ /^\s*;/) {
3465 3466
				ERROR("WHILE_AFTER_BRACE",
				      "while should follow close brace '}'\n" . $hereprev);
3467 3468 3469
			}
		}

3470
#Specific variable tests
3471 3472
		while ($line =~ m{($Constant|$Lval)}g) {
			my $var = $1;
3473 3474 3475

#gcc binary extension
			if ($var =~ /^$Binary$/) {
3476 3477 3478 3479 3480 3481 3482
				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/;
				}
3483 3484 3485
			}

#CamelCase
3486
			if ($var !~ /^$Constant$/ &&
3487
			    $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
3488
#Ignore Page<foo> variants
3489
			    $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
3490
#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
3491
			    $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
3492 3493 3494
				while ($var =~ m{($Ident)}g) {
					my $word = $1;
					next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
3495 3496 3497 3498 3499 3500 3501
					if ($check) {
						seed_camelcase_includes();
						if (!$file && !$camelcase_file_seeded) {
							seed_camelcase_file($realfile);
							$camelcase_file_seeded = 1;
						}
					}
3502 3503 3504 3505 3506
					if (!defined $camelcase{$word}) {
						$camelcase{$word} = 1;
						CHK("CAMELCASE",
						    "Avoid CamelCase: <$word>\n" . $herecurr);
					}
3507
				}
3508 3509
			}
		}
3510 3511

#no spaces allowed after \ in define
3512 3513 3514 3515 3516 3517
		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+$//;
			}
3518 3519
		}

3520
#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
3521
		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
3522 3523 3524 3525
			my $file = "$1.h";
			my $checkfile = "include/linux/$file";
			if (-f "$root/$checkfile" &&
			    $realfile ne $checkfile &&
3526
			    $1 !~ /$allowed_asm_includes/)
3527
			{
3528
				if ($realfile =~ m{^arch/}) {
3529 3530
					CHK("ARCH_INCLUDE_LINUX",
					    "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
3531
				} else {
3532 3533
					WARN("INCLUDE_LINUX",
					     "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
3534
				}
3535 3536 3537
			}
		}

3538 3539
# 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
3540
# in a known good container
3541 3542
		if ($realfile !~ m@/vmlinux.lds.h$@ &&
		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
3543 3544
			my $ln = $linenr;
			my $cnt = $realcnt;
3545 3546 3547
			my ($off, $dstat, $dcond, $rest);
			my $ctx = '';
			($dstat, $dcond, $ln, $cnt, $off) =
3548 3549
				ctx_statement_block($linenr, $realcnt, 0);
			$ctx = $dstat;
3550
			#print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
3551
			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
3552

3553
			$dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
3554
			$dstat =~ s/$;//g;
3555 3556 3557
			$dstat =~ s/\\\n.//g;
			$dstat =~ s/^\s*//s;
			$dstat =~ s/\s*$//s;
3558

3559
			# Flatten any parentheses and braces
3560 3561
			while ($dstat =~ s/\([^\(\)]*\)/1/ ||
			       $dstat =~ s/\{[^\{\}]*\}/1/ ||
3562
			       $dstat =~ s/\[[^\[\]]*\]/1/)
3563
			{
3564
			}
3565

3566 3567 3568 3569 3570 3571
			# Flatten any obvious string concatentation.
			while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
			       $dstat =~ s/$Ident\s*("X*")/$1/)
			{
			}

3572 3573 3574
			my $exceptions = qr{
				$Declare|
				module_param_named|
3575
				MODULE_PARM_DESC|
3576 3577
				DECLARE_PER_CPU|
				DEFINE_PER_CPU|
3578
				__typeof__\(|
3579 3580
				union|
				struct|
3581 3582
				\.$Ident\s*=\s*|
				^\"|\"$
3583
			}x;
3584
			#print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
3585 3586 3587
			if ($dstat ne '' &&
			    $dstat !~ /^(?:$Ident|-?$Constant),$/ &&			# 10, // foo(),
			    $dstat !~ /^(?:$Ident|-?$Constant);$/ &&			# foo();
3588
			    $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ &&		# 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
3589
			    $dstat !~ /^'X'$/ &&					# character constants
3590 3591
			    $dstat !~ /$exceptions/ &&
			    $dstat !~ /^\.$Ident\s*=/ &&				# .foo =
3592
			    $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ &&		# stringification #foo
3593
			    $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ &&	# do {...} while (...); // do {...} while (...)
3594 3595 3596
			    $dstat !~ /^for\s*$Constant$/ &&				# for (...)
			    $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ &&	# for (...) bar()
			    $dstat !~ /^do\s*{/ &&					# do {...
3597 3598
			    $dstat !~ /^\({/ &&						# ({...
			    $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
3599 3600 3601 3602 3603 3604 3605
			{
				$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";
3606 3607
				}

3608 3609 3610 3611
				if ($dstat =~ /;/) {
					ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
					      "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
				} else {
3612
					ERROR("COMPLEX_MACRO",
3613
					      "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
3614
				}
3615
			}
3616

3617
# check for line continuations outside of #defines, preprocessor #, and asm
3618 3619 3620

		} else {
			if ($prevline !~ /^..*\\$/ &&
3621 3622
			    $line !~ /^\+\s*\#.*\\$/ &&		# preprocessor
			    $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ &&	# asm
3623 3624 3625 3626
			    $line =~ /^\+.*\\$/) {
				WARN("LINE_CONTINUATIONS",
				     "Avoid unnecessary line continuations\n" . $herecurr);
			}
3627 3628
		}

3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656
# 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";
				}

3657 3658
				if (($stmts =~ tr/;/;/) == 1 &&
				    $stmts !~ /^\s*(if|while|for|switch)\b/) {
3659 3660 3661 3662 3663 3664 3665 3666 3667 3668
					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");
				}
			}
		}

3669 3670 3671 3672 3673 3674
# 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|$))/) {
3675 3676
			WARN("MISSING_VMLINUX_SYMBOL",
			     "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
3677 3678
		}

3679
# check for redundant bracing round if etc
3680 3681
		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
			my ($level, $endln, @chunks) =
3682
				ctx_statement_full($linenr, $realcnt, 1);
3683
			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
3684 3685
			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
			if ($#chunks > 0 && $level == 0) {
3686 3687
				my @allowed = ();
				my $allow = 0;
3688
				my $seen = 0;
3689
				my $herectx = $here . "\n";
3690
				my $ln = $linenr - 1;
3691 3692 3693
				for my $chunk (@chunks) {
					my ($cond, $block) = @{$chunk};

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

3698
					$allowed[$allow] = 0;
3699 3700 3701 3702 3703 3704
					#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";
3705 3706
					$ln += statement_rawlines($block) - 1;

3707
					substr($block, 0, length($cond), '');
3708 3709 3710

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

3711
					#print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
3712 3713
					if (statement_lines($cond) > 1) {
						#print "APW: ALLOWED: cond<$cond>\n";
3714
						$allowed[$allow] = 1;
3715 3716
					}
					if ($block =~/\b(?:if|for|while)\b/) {
3717
						#print "APW: ALLOWED: block<$block>\n";
3718
						$allowed[$allow] = 1;
3719
					}
3720 3721
					if (statement_block_size($block) > 1) {
						#print "APW: ALLOWED: lines block<$block>\n";
3722
						$allowed[$allow] = 1;
3723
					}
3724
					$allow++;
3725
				}
3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738
				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);
					}
3739 3740 3741
				}
			}
		}
3742
		if (!defined $suppress_ifbraces{$linenr - 1} &&
3743
					$line =~ /\b(if|while|for|else)\b/) {
3744 3745 3746 3747 3748 3749 3750
			my $allowed = 0;

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

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

3755 3756
			# Check the condition.
			my ($cond, $block) = @{$chunks[0]};
3757
			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
3758
			if (defined $cond) {
3759
				substr($block, 0, length($cond), '');
3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776
			}
			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) {
3777
					substr($block, 0, length($cond), '');
3778 3779 3780 3781 3782 3783 3784
				}
				if ($block =~ /^\s*\{/) {
					#print "APW: ALLOWED: chunk-1 block<$block>\n";
					$allowed = 1;
				}
			}
			if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
3785
				my $herectx = $here . "\n";
3786
				my $cnt = statement_rawlines($block);
3787

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

3792 3793
				WARN("BRACES",
				     "braces {} are not necessary for single statement blocks\n" . $herectx);
3794 3795 3796
			}
		}

3797
# check for unnecessary blank lines around braces
3798
		if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
3799 3800 3801
			CHK("BRACES",
			    "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
		}
3802
		if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
3803 3804 3805 3806
			CHK("BRACES",
			    "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
		}

3807
# no volatiles please
3808 3809
		my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
		if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
3810 3811
			WARN("VOLATILE",
			     "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
3812 3813
		}

3814
# warn about #if 0
3815
		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
3816 3817
			CHK("REDUNDANT_CODE",
			    "if this code is redundant consider removing it\n" .
3818
				$herecurr);
3819 3820
		}

3821 3822 3823 3824 3825 3826
# 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);
3827 3828
			}
		}
3829

3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847
# 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;
				}
			}
		}

3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876
# 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/;
			}
		}

3877
# prefer usleep_range over udelay
B
Bruce Allan 已提交
3878
		if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
3879
			# ignore udelay's < 10, however
B
Bruce Allan 已提交
3880
			if (! ($1 < 10) ) {
3881 3882
				CHK("USLEEP_RANGE",
				    "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
3883 3884 3885
			}
		}

3886 3887 3888
# warn about unexpectedly long msleep's
		if ($line =~ /\bmsleep\s*\((\d+)\);/) {
			if ($1 < 20) {
3889 3890
				WARN("MSLEEP",
				     "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
3891 3892 3893
			}
		}

3894 3895 3896 3897 3898 3899
# 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);
		}

3900 3901 3902 3903 3904 3905
# 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);
		}

3906
# warn about #ifdefs in C files
3907
#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
3908 3909 3910 3911 3912
#			print "#ifdef in C files should be avoided\n";
#			print "$herecurr";
#			$clean = 0;
#		}

3913
# warn about spacing in #ifdefs
3914
		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
3915 3916 3917 3918 3919 3920 3921
			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 /;
			}

3922 3923
		}

3924
# check for spinlock_t definitions without a comment.
3925 3926
		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
3927 3928
			my $which = $1;
			if (!ctx_has_comment($first_line, $linenr)) {
3929 3930
				CHK("UNCOMMENTED_DEFINITION",
				    "$1 definition without comment\n" . $herecurr);
3931 3932 3933 3934 3935
			}
		}
# 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)) {
3936 3937
				WARN("MEMORY_BARRIER",
				     "memory barrier without comment\n" . $herecurr);
3938 3939 3940
			}
		}
# check of hardware specific defines
3941
		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
3942 3943
			CHK("ARCH_DEFINES",
			    "architecture specific defines should be avoided\n" .  $herecurr);
3944
		}
3945

3946 3947
# Check that the storage class is at the beginning of a declaration
		if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
3948 3949
			WARN("STORAGE_CLASS",
			     "storage class should be at the beginning of the declaration\n" . $herecurr)
3950 3951
		}

3952 3953
# check the location of the inline attribute, that it is between
# storage class and type.
3954 3955
		if ($line =~ /\b$Type\s+$Inline\b/ ||
		    $line =~ /\b$Inline\s+$Storage\b/) {
3956 3957
			ERROR("INLINE_LOCATION",
			      "inline keyword should sit between storage class and type\n" . $herecurr);
3958 3959
		}

3960
# Check for __inline__ and __inline, prefer inline
3961 3962
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b(__inline__|__inline)\b/) {
3963 3964 3965 3966 3967 3968
			if (WARN("INLINE",
				 "plain inline is preferred over $1\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/;

			}
3969 3970
		}

3971
# Check for __attribute__ packed, prefer __packed
3972 3973
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
3974 3975
			WARN("PREFER_PACKED",
			     "__packed is preferred over __attribute__((packed))\n" . $herecurr);
3976 3977
		}

3978
# Check for __attribute__ aligned, prefer __aligned
3979 3980
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
3981 3982
			WARN("PREFER_ALIGNED",
			     "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
3983 3984
		}

3985
# Check for __attribute__ format(printf, prefer __printf
3986 3987
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
3988 3989 3990 3991 3992 3993
			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;

			}
3994 3995
		}

3996
# Check for __attribute__ format(scanf, prefer __scanf
3997 3998
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
3999 4000 4001 4002 4003
			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;
			}
4004 4005
		}

4006 4007
# check for sizeof(&)
		if ($line =~ /\bsizeof\s*\(\s*\&/) {
4008 4009
			WARN("SIZEOF_ADDRESS",
			     "sizeof(& should be avoided\n" . $herecurr);
4010 4011
		}

4012 4013
# check for sizeof without parenthesis
		if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
4014 4015 4016 4017 4018
			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;
			}
4019 4020
		}

4021 4022
# check for line continuations in quoted strings with odd counts of "
		if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
4023 4024
			WARN("LINE_CONTINUATIONS",
			     "Avoid line continuations in quoted strings\n" . $herecurr);
4025 4026
		}

4027 4028 4029 4030 4031 4032
# 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);
		}

4033
# check for seq_printf uses that could be seq_puts
J
Joe Perches 已提交
4034
		if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
4035
			my $fmt = get_quoted_string($line, $rawline);
J
Joe Perches 已提交
4036
			if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
4037 4038 4039 4040 4041
				if (WARN("PREFER_SEQ_PUTS",
					 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
				    $fix) {
					$fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/;
				}
4042 4043 4044
			}
		}

4045
# Check for misused memsets
4046 4047
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
4048 4049 4050
		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {

			my $ms_addr = $2;
4051 4052
			my $ms_val = $7;
			my $ms_size = $12;
4053 4054 4055

			if ($ms_size =~ /^(0x|)0$/i) {
				ERROR("MEMSET",
4056
				      "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
4057 4058
			} elsif ($ms_size =~ /^(0x|)1$/i) {
				WARN("MEMSET",
4059 4060 4061 4062 4063
				     "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
			}
		}

# typecasts on min/max could be min_t/max_t
4064 4065
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
4066
		    $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
4067
			if (defined $2 || defined $7) {
4068 4069 4070
				my $call = $1;
				my $cast1 = deparenthesize($2);
				my $arg1 = $3;
4071 4072
				my $cast2 = deparenthesize($7);
				my $arg2 = $8;
4073 4074
				my $cast;

4075
				if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
4076 4077 4078 4079 4080 4081 4082 4083
					$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");
4084 4085 4086
			}
		}

4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102
# 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");
			}
		}

4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119
# 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");
		}

4120 4121 4122
# check for new externs in .h files.
		if ($realfile =~ /\.h$/ &&
		    $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
4123 4124
			if (CHK("AVOID_EXTERNS",
				"extern prototypes should be avoided in .h files\n" . $herecurr) &&
4125 4126 4127 4128 4129
			    $fix) {
				$fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
			}
		}

4130
# check for new externs in .c files.
4131
		if ($realfile =~ /\.c$/ && defined $stat &&
4132
		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
4133
		{
4134 4135
			my $function_name = $1;
			my $paren_space = $2;
4136 4137 4138 4139 4140

			my $s = $stat;
			if (defined $cond) {
				substr($s, 0, length($cond), '');
			}
4141 4142 4143
			if ($s =~ /^\s*;/ &&
			    $function_name ne 'uninitialized_var')
			{
4144 4145
				WARN("AVOID_EXTERNS",
				     "externs should be avoided in .c files\n" .  $herecurr);
4146 4147 4148
			}

			if ($paren_space =~ /\n/) {
4149 4150
				WARN("FUNCTION_ARGUMENTS",
				     "arguments for function declarations should follow identifier\n" . $herecurr);
4151
			}
4152 4153 4154 4155

		} elsif ($realfile =~ /\.c$/ && defined $stat &&
		    $stat =~ /^.\s*extern\s+/)
		{
4156 4157
			WARN("AVOID_EXTERNS",
			     "externs should be avoided in .c files\n" .  $herecurr);
4158 4159 4160 4161 4162 4163 4164
		}

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

			if (!grep(/$name/, @setup_docs)) {
4165 4166
				CHK("UNDOCUMENTED_SETUP",
				    "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
4167
			}
4168
		}
4169 4170

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

4176 4177 4178 4179 4180 4181 4182 4183
# 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);
		}

4184 4185 4186 4187 4188 4189 4190
# 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);
		}

4191 4192 4193 4194 4195 4196
# 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);
		}

4197 4198 4199 4200 4201 4202
# check for GFP_NOWAIT use
		if ($line =~ /\b__GFP_NOFAIL\b/) {
			WARN("__GFP_NOFAIL",
			     "Use of __GFP_NOFAIL is deprecated, no new users should be added\n" . $herecurr);
		}

4203 4204
# check for multiple semicolons
		if ($line =~ /;\s*;\s*$/) {
4205 4206 4207 4208 4209
			if (WARN("ONE_SEMICOLON",
				 "Statements terminations use 1 semicolon\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g;
			}
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
# check for case / default statements not preceeded by break/fallthrough/switch
		if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
			my $has_break = 0;
			my $has_statement = 0;
			my $count = 0;
			my $prevline = $linenr;
			while ($prevline > 1 && $count < 3 && !$has_break) {
				$prevline--;
				my $rline = $rawlines[$prevline - 1];
				my $fline = $lines[$prevline - 1];
				last if ($fline =~ /^\@\@/);
				next if ($fline =~ /^\-/);
				next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
				$has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
				next if ($fline =~ /^.[\s$;]*$/);
				$has_statement = 1;
				$count++;
				$has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
			}
			if (!$has_break && $has_statement) {
				WARN("MISSING_BREAK",
				     "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
			}
		}

4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248
# 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);
4249 4250
		}

4251
# check for gcc specific __FUNCTION__
4252 4253 4254 4255 4256 4257
		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;
			}
4258
		}
4259

J
Joe Perches 已提交
4260 4261 4262 4263 4264 4265
# 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);
		}

4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292
# 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);

			}
		}

4293 4294
# check for semaphores initialized locked
		if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
4295 4296
			WARN("CONSIDER_COMPLETION",
			     "consider using a completion\n" . $herecurr);
4297
		}
4298

4299 4300
# recommend kstrto* over simple_strto* and strict_strto*
		if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
4301
			WARN("CONSIDER_KSTRTO",
4302
			     "$1 is obsolete, use k$3 instead\n" . $herecurr);
4303
		}
4304

4305 4306
# check for __initcall(), use device_initcall() explicitly please
		if ($line =~ /^.\s*__initcall\s*\(/) {
4307 4308
			WARN("USE_DEVICE_INITCALL",
			     "please use device_initcall() instead of __initcall()\n" . $herecurr);
4309
		}
4310

4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348
# 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;
4349
		if ($line !~ /\bconst\b/ &&
4350
		    $line =~ /\bstruct\s+($struct_ops)\b/) {
4351 4352
			WARN("CONST_STRUCT",
			     "struct $1 should normally be const\n" .
4353
				$herecurr);
4354
		}
4355 4356 4357 4358

# 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/ &&
4359 4360
		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
4361 4362 4363
		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
4364
		{
4365 4366
			WARN("NR_CPUS",
			     "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
4367
		}
4368

4369 4370 4371 4372 4373 4374
# 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);
		}

4375 4376 4377 4378
# check for %L{u,d,i} in strings
		my $string;
		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
			$string = substr($rawline, $-[1], $+[1] - $-[1]);
4379
			$string =~ s/%%/__/g;
4380
			if ($string =~ /(?<!%)%L[udi]/) {
4381 4382
				WARN("PRINTF_L",
				     "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
4383 4384 4385
				last;
			}
		}
4386 4387 4388 4389

# whine mightly about in_atomic
		if ($line =~ /\bin_atomic\s*\(/) {
			if ($realfile =~ m@^drivers/@) {
4390 4391
				ERROR("IN_ATOMIC",
				      "do not use in_atomic in drivers\n" . $herecurr);
4392
			} elsif ($realfile !~ m@^kernel/@) {
4393 4394
				WARN("IN_ATOMIC",
				     "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
4395 4396
			}
		}
4397 4398 4399 4400 4401 4402 4403

# 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@) {
4404 4405
				ERROR("LOCKDEP",
				      "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
4406 4407
			}
		}
4408 4409 4410

		if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
		    $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
4411 4412
			WARN("EXPORTED_WORLD_WRITABLE",
			     "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
4413
		}
4414 4415 4416 4417 4418 4419
	}

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

4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434
	# 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) {
4435 4436
		ERROR("NOT_UNIFIED_DIFF",
		      "Does not appear to be a unified-diff format patch\n");
4437 4438
	}
	if ($is_patch && $chk_signoff && $signoff == 0) {
4439 4440
		ERROR("MISSING_SIGN_OFF",
		      "Missing Signed-off-by: line(s)\n");
4441 4442
	}

4443
	print report_dump();
4444 4445
	if ($summary && !($clean == 1 && $quiet == 1)) {
		print "$filename " if ($summary_file);
4446 4447 4448 4449
		print "total: $cnt_error errors, $cnt_warn warnings, " .
			(($check)? "$cnt_chk checks, " : "") .
			"$cnt_lines lines checked\n";
		print "\n" if ($quiet == 0);
4450
	}
4451

4452
	if ($quiet == 0) {
4453 4454 4455 4456 4457 4458

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

4459 4460 4461 4462 4463
		# 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";
4464
			$rpt_cleaners = 0;
4465 4466 4467
		}
	}

4468 4469
	hash_show_words(\%use_type, "Used");
	hash_show_words(\%ignore_type, "Ignored");
4470

4471
	if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
4472 4473
		my $newfile = $filename;
		$newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505
		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
		}
	}

4506
	if ($clean == 1 && $quiet == 0) {
4507
		print "$vname has no obvious style problems and is ready for submission.\n"
4508 4509
	}
	if ($clean == 0 && $quiet == 0) {
4510 4511 4512 4513 4514 4515
		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
4516
	}
4517

4518 4519
	return $clean;
}