checkpatch.pl 135.7 KB
Newer Older
1
#!/usr/bin/perl -w
2
# (c) 2001, Dave Jones. (the file handling bit)
3
# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
A
Andy Whitcroft 已提交
4
# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
5
# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
6 7 8
# 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
my $check_orig = 0;
28 29
my $summary = 1;
my $mailback = 0;
30
my $summary_file = 0;
31
my $show_types = 0;
32
my $fix = 0;
33
my $fix_inplace = 0;
34
my $root;
35
my %debug;
36
my %camelcase = ();
37 38 39
my %use_type = ();
my @use = ();
my %ignore_type = ();
40
my @ignore = ();
41
my $help = 0;
42
my $configuration_file = ".checkpatch.conf";
43
my $max_line_length = 80;
44 45
my $ignore_perl_version = 0;
my $minimum_perl_version = 5.10.0;
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62

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
63
  --types TYPE(,TYPE2...)    show only these comma separated message types
64
  --ignore TYPE(,TYPE2...)   ignore various comma separated message types
65
  --max-line-length=n        set the maximum line length, if exceeded, warn
66
  --show-types               show the message "types" in the output
67 68 69 70 71 72 73 74 75
  --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
76 77 78 79 80
  --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
81 82 83
  --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
84 85
  --ignore-perl-version      override checking of perl version.  expect
                             runtime errors.
86 87 88 89 90 91 92 93
  -h, --help, --version      display this help and exit

When FILE is - read standard input.
EOM

	exit($exitcode);
}

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

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

help(0) if ($help);
148

149
$fix = 1 if ($fix_inplace);
150
$check_orig = $check;
151

152 153
my $exit = 0;

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

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

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

183 184
sub hash_show_words {
	my ($hashRef, $prefix) = @_;
185

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

195 196 197
hash_save_array_words(\%ignore_type, \@ignore);
hash_save_array_words(\%use_type, \@use);

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

208 209
my $rpt_cleaners = 0;

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

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

235 236
my $emitted_corrupt = 0;

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

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

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

309 310
our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;

311
our $NonptrType;
312
our $NonptrTypeWithAttr;
313 314 315
our $Type;
our $Declare;

316 317
our $NON_ASCII_UTF8	= qr{
	[\xC2-\xDF][\x80-\xBF]               # non-overlong 2-byte
318 319 320 321 322 323 324 325
	|  \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;

326 327 328 329 330
our $UTF8	= qr{
	[\x09\x0A\x0D\x20-\x7E]              # ASCII
	| $NON_ASCII_UTF8
}x;

331
our $typeTypedefs = qr{(?x:
332
	(?:__)?(?:u|s|be|le)(?:8|16|32|64)|
333 334 335
	atomic_t
)};

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

345 346 347 348 349 350
our $signature_tags = qr{(?xi:
	Signed-off-by:|
	Acked-by:|
	Tested-by:|
	Reviewed-by:|
	Reported-by:|
351
	Suggested-by:|
352 353 354 355
	To:|
	Cc:
)};

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

382 383 384
our @modifierList = (
	qr{fastcall},
);
385

386 387 388 389 390 391 392 393 394
our @mode_permission_funcs = (
	["module_param", 3],
	["module_param_(?:array|named|string)", 4],
	["module_param_array_named", 5],
	["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
	["proc_create(?:_data|)", 2],
	["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
);

395 396 397 398 399 400 401
#Create a search pattern for all these functions to speed up a loop below
our $mode_perms_search = "";
foreach my $entry (@mode_permission_funcs) {
	$mode_perms_search .= '|' if ($mode_perms_search ne "");
	$mode_perms_search .= $entry->[0];
}

402 403 404 405 406
our $declaration_macros = qr{(?x:
	(?:$Storage\s+)?(?:DECLARE|DEFINE)_[A-Z]+\s*\(|
	(?:$Storage\s+)?LIST_HEAD\s*\(
)};

407 408 409 410 411 412
our $allowed_asm_includes = qr{(?x:
	irq|
	memory
)};
# memory.h: ARM has a custom one

413
sub build_types {
414 415
	my $mods = "(?x:  \n" . join("|\n  ", @modifierList) . "\n)";
	my $all = "(?x:  \n" . join("|\n  ", @typeList) . "\n)";
416
	my $allWithAttr = "(?x:  \n" . join("|\n  ", @typeListWithAttr) . "\n)";
417
	$Modifier	= qr{(?:$Attribute|$Sparse|$mods)};
418
	$NonptrType	= qr{
419
			(?:$Modifier\s+|const\s+)*
420
			(?:
421
				(?:typeof|__typeof__)\s*\([^\)]*\)|
422
				(?:$typeTypedefs\b)|
423
				(?:${all}\b)
424
			)
425
			(?:\s+$Modifier|\s+const)*
426
		  }x;
427 428 429 430 431 432 433 434 435
	$NonptrTypeWithAttr	= qr{
			(?:$Modifier\s+|const\s+)*
			(?:
				(?:typeof|__typeof__)\s*\([^\)]*\)|
				(?:$typeTypedefs\b)|
				(?:${allWithAttr}\b)
			)
			(?:\s+$Modifier|\s+const)*
		  }x;
436
	$Type	= qr{
437
			$NonptrType
438
			(?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)?
439
			(?:\s+$Inline|\s+$Modifier)*
440
		  }x;
441
	$Declare	= qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
442 443
}
build_types();
444

445
our $Typecast	= qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
446 447 448 449 450 451

# 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))*\))/;
452
our $LvalOrFunc	= qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
453
our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
454 455 456 457

sub deparenthesize {
	my ($string) = @_;
	return "" if (!defined($string));
458 459 460 461 462 463

	while ($string =~ /^\s*\(.*\)\s*$/) {
		$string =~ s@^\s*\(\s*@@;
		$string =~ s@\s*\)\s*$@@;
	}

464
	$string =~ s@\s+@ @g;
465

466 467 468
	return $string;
}

469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
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;
487 488 489
		} 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*[;\{]/) {
490 491 492 493 494 495 496 497 498 499
			$camelcase{$1} = 1;
		}
	}
}

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

	my $files;
500 501 502 503
	my $camelcase_cache = "";
	my @include_files = ();

	$camelcase_seeded = 1;
504

505
	if (-e ".git") {
506 507
		my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
		chomp $git_last_include_commit;
508
		$camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
509
	} else {
510
		my $last_mod_date = 0;
511
		$files = `find $root/include -name "*.h"`;
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
		@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;
531
	}
532

533
	if (-e ".git") {
534 535 536 537
		$files = `git ls-files "include/*.h"`;
		@include_files = split('\n', $files);
	}

538 539 540
	foreach my $file (@include_files) {
		seed_camelcase_file($file);
	}
541

542
	if ($camelcase_cache ne "") {
543
		unlink glob ".checkpatch-camelcase.*";
544 545
		open(my $camelcase_file, '>', "$camelcase_cache")
		    or warn "$P: Can't write '$camelcase_cache' $!\n";
546 547 548 549 550
		foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
			print $camelcase_file ("$_\n");
		}
		close($camelcase_file);
	}
551 552
}

553 554
$chk_signoff = 0 if ($file);

555
my @rawlines = ();
556
my @lines = ();
557
my @fixed = ();
558
my $vname;
559
for my $filename (@ARGV) {
560
	my $FILE;
561
	if ($file) {
562
		open($FILE, '-|', "diff -u /dev/null $filename") ||
563
			die "$P: $filename: diff failed - $!\n";
564 565
	} elsif ($filename eq '-') {
		open($FILE, '<&STDIN');
566
	} else {
567
		open($FILE, '<', "$filename") ||
568
			die "$P: $filename: open failed - $!\n";
569
	}
570 571 572 573 574
	if ($filename eq '-') {
		$vname = 'Your patch';
	} else {
		$vname = $filename;
	}
575
	while (<$FILE>) {
576 577 578
		chomp;
		push(@rawlines, $_);
	}
579
	close($FILE);
580
	if (!process($filename)) {
581 582 583
		$exit = 1;
	}
	@rawlines = ();
584
	@lines = ();
585
	@fixed = ();
586 587 588 589 590
}

exit($exit);

sub top_of_kernel_tree {
591 592 593 594 595 596 597 598 599 600 601 602
	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;
		}
603
	}
604
	return 1;
605
}
606

607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625
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;
626
		$name = trim($name);
627 628 629 630 631 632 633 634 635 636 637 638 639 640
		$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 = "";
		}
	}

641
	$name = trim($name);
642
	$name =~ s/^\"|\"$//g;
643
	$address = trim($address);
644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
	$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;

659
	$name = trim($name);
660
	$name =~ s/^\"|\"$//g;
661
	$address = trim($address);
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676

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

677 678 679 680 681 682 683 684 685 686 687 688
sub which_conf {
	my ($conf) = @_;

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

	return "";
}

689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
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;
}
709
sub copy_spacing {
710
	(my $res = shift) =~ tr/\t/ /c;
711 712
	return $res;
}
713

714 715 716 717 718 719 720 721 722 723 724 725 726
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));
}

727 728 729 730 731 732 733 734 735 736 737
my $sanitise_quote = '';

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

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
738 739 740 741 742 743
sub sanitise_line {
	my ($line) = @_;

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

744
	my $qlen = 0;
745 746
	my $off = 0;
	my $c;
747

748 749 750 751 752 753 754 755 756 757 758 759 760 761
	# 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;
762
		}
763
		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
764 765 766 767
			$sanitise_quote = '';
			substr($res, $off, 2, "$;$;");
			$off++;
			next;
768
		}
769 770 771 772 773 774 775
		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
			$sanitise_quote = '//';

			substr($res, $off, 2, $sanitise_quote);
			$off++;
			next;
		}
776 777 778 779 780 781 782

		# 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;
783
		}
784 785 786 787
		# Regular quotes.
		if ($c eq "'" || $c eq '"') {
			if ($sanitise_quote eq '') {
				$sanitise_quote = $c;
788

789 790 791 792 793 794
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
795

796
		#print "c<$c> SQ<$sanitise_quote>\n";
797 798
		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
			substr($res, $off, 1, $;);
799 800
		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
			substr($res, $off, 1, $;);
801 802 803 804 805
		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
			substr($res, $off, 1, 'X');
		} else {
			substr($res, $off, 1, $c);
		}
806 807
	}

808 809 810 811
	if ($sanitise_quote eq '//') {
		$sanitise_quote = '';
	}

812
	# The pathname on a #include may be surrounded by '<' and '>'.
813
	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
814 815 816 817
		my $clean = 'X' x length($1);
		$res =~ s@\<.*\>@<$clean>@;

	# The whole of a #error is a string.
818
	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
819
		my $clean = 'X' x length($1);
820
		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
821 822
	}

823 824 825
	return $res;
}

826 827 828 829 830 831 832
sub get_quoted_string {
	my ($line, $rawline) = @_;

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

833 834 835 836 837 838
sub ctx_statement_block {
	my ($linenr, $remain, $off) = @_;
	my $line = $linenr - 1;
	my $blk = '';
	my $soff = $off;
	my $coff = $off - 1;
839
	my $coff_set = 0;
840

841 842
	my $loff = 0;

843 844
	my $type = '';
	my $level = 0;
845
	my @stack = ();
846
	my $p;
847 848
	my $c;
	my $len = 0;
849 850

	my $remainder;
851
	while (1) {
852 853
		@stack = (['', 0]) if ($#stack == -1);

854
		#warn "CSB: blk<$blk> remain<$remain>\n";
855 856 857 858
		# If we are about to drop off the end, pull in more
		# context.
		if ($off >= $len) {
			for (; $remain > 0; $line++) {
859
				last if (!defined $lines[$line]);
860
				next if ($lines[$line] =~ /^-/);
861
				$remain--;
862
				$loff = $len;
863
				$blk .= $lines[$line] . "\n";
864 865 866 867 868 869
				$len = length($blk);
				$line++;
				last;
			}
			# Bail if there is no further context.
			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
870
			if ($off >= $len) {
871 872
				last;
			}
873 874 875 876
			if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
				$level++;
				$type = '#';
			}
877
		}
878
		$p = $c;
879
		$c = substr($blk, $off, 1);
880
		$remainder = substr($blk, $off);
881

882
		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
883 884 885 886 887 888 889 890 891 892

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

893 894 895 896 897 898
		# Statement ends at the ';' or a close '}' at the
		# outermost level.
		if ($level == 0 && $c eq ';') {
			last;
		}

899
		# An else is really a conditional as long as its not else if
900 901 902 903 904 905 906 907
		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";
908 909
		}

910 911 912 913 914 915 916 917 918 919
		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;
920 921
				$coff_set = 1;
				#warn "CSB: mark coff<$coff>\n";
922 923 924 925 926 927 928 929 930 931 932
			}
		}
		if (($type eq '' || $type eq '{') && $c eq '{') {
			$level++;
			$type = '{';
		}
		if ($type eq '{' && $c eq '}') {
			$level--;
			$type = ($level != 0)? '{' : '';

			if ($level == 0) {
933 934 935
				if (substr($blk, $off + 1, 1) eq ';') {
					$off++;
				}
936 937 938
				last;
			}
		}
939 940 941 942 943 944 945
		# Preprocessor commands end at the newline unless escaped.
		if ($type eq '#' && $c eq "\n" && $p ne "\\") {
			$level--;
			$type = '';
			$off++;
			last;
		}
946 947
		$off++;
	}
948
	# We are truly at the end, so shuffle to the next line.
949
	if ($off == $len) {
950
		$loff = $len + 1;
951 952 953
		$line++;
		$remain--;
	}
954 955 956 957 958 959 960

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

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

961
	#print "coff<$coff> soff<$off> loff<$loff>\n";
962 963 964 965 966

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

967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
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;
	}
}

1010 1011 1012 1013 1014 1015
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

1016
	# Grab the first conditional/block pair.
1017 1018
	($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
1019
	#print "F: c<$condition> s<$statement> remain<$remain>\n";
1020 1021 1022 1023 1024 1025 1026
	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.
1027 1028 1029
	for (;;) {
		($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
1030
		#print "C: c<$condition> s<$statement> remain<$remain>\n";
1031
		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1032 1033
		#print "C: push\n";
		push(@chunks, [ $condition, $statement ]);
1034 1035 1036
	}

	return ($level, $linenr, @chunks);
1037 1038
}

1039
sub ctx_block_get {
1040
	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1041 1042 1043 1044 1045 1046 1047
	my $line;
	my $start = $linenr - 1;
	my $blk = '';
	my @o;
	my @c;
	my @res = ();

1048
	my $level = 0;
1049
	my @stack = ($level);
1050 1051 1052 1053 1054
	for ($line = $start; $remain > 0; $line++) {
		next if ($rawlines[$line] =~ /^-/);
		$remain--;

		$blk .= $rawlines[$line];
1055 1056

		# Handle nested #if/#else.
1057
		if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1058
			push(@stack, $level);
1059
		} elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1060
			$level = $stack[$#stack - 1];
1061
		} elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1062 1063 1064
			$level = pop(@stack);
		}

1065
		foreach my $c (split(//, $lines[$line])) {
1066 1067 1068 1069 1070
			##print "C<$c>L<$level><$open$close>O<$off>\n";
			if ($off > 0) {
				$off--;
				next;
			}
1071

1072 1073 1074 1075 1076 1077 1078
			if ($c eq $close && $level > 0) {
				$level--;
				last if ($level == 0);
			} elsif ($c eq $open) {
				$level++;
			}
		}
1079

1080
		if (!$outer || $level <= 1) {
1081
			push(@res, $rawlines[$line]);
1082 1083
		}

1084
		last if ($level == 0);
1085 1086
	}

1087
	return ($level, @res);
1088 1089 1090 1091
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

1092 1093
	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
	return @r;
1094 1095 1096 1097
}
sub ctx_block {
	my ($linenr, $remain) = @_;

1098 1099
	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
	return @r;
1100 1101
}
sub ctx_statement {
1102 1103 1104 1105 1106 1107
	my ($linenr, $remain, $off) = @_;

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

1110
	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1111
}
1112 1113 1114 1115 1116
sub ctx_statement_level {
	my ($linenr, $remain, $off) = @_;

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
1117 1118 1119 1120 1121

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

	# Catch a comment on the end of the line itself.
1122
	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1123 1124 1125 1126 1127 1128 1129
	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++) {
1130 1131
		my $line = $rawlines[$linenr - 1];
		#warn "           $line\n";
1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
		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);

1154
	##print "LINE: $rawlines[$end_line - 1 ]\n";
1155 1156 1157 1158 1159
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175
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;
}

1176 1177 1178
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
1179

1180 1181 1182 1183 1184 1185
	$res = '';
	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
		$res .= $1;
		if ($2 ne '') {
			$coded = sprintf("^%c", unpack('C', $2) + 64);
			$res .= $coded;
1186 1187
		}
	}
1188
	$res =~ s/$/\$/;
1189

1190
	return $res;
1191 1192
}

1193
my $av_preprocessor = 0;
1194
my $av_pending;
1195
my @av_paren_type;
1196
my $av_pend_colon;
1197 1198 1199

sub annotate_reset {
	$av_preprocessor = 0;
1200 1201
	$av_pending = '_';
	@av_paren_type = ('E');
1202
	$av_pend_colon = 'O';
1203 1204
}

1205 1206
sub annotate_values {
	my ($stream, $type) = @_;
1207

1208
	my $res;
1209
	my $var = '_' x length($stream);
1210 1211
	my $cur = $stream;

1212
	print "$stream\n" if ($dbg_values > 1);
1213 1214

	while (length($cur)) {
1215
		@av_paren_type = ('E') if ($#av_paren_type < 0);
1216
		print " <" . join('', @av_paren_type) .
1217
				"> <$type> <$av_pending>" if ($dbg_values > 1);
1218
		if ($cur =~ /^(\s+)/o) {
1219 1220
			print "WS($1)\n" if ($dbg_values > 1);
			if ($1 =~ /\n/ && $av_preprocessor) {
1221
				$type = pop(@av_paren_type);
1222
				$av_preprocessor = 0;
1223 1224
			}

1225
		} elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1226 1227
			print "CAST($1)\n" if ($dbg_values > 1);
			push(@av_paren_type, $type);
1228
			$type = 'c';
1229

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

1234 1235 1236 1237
		} elsif ($cur =~ /^($Modifier)\s*/) {
			print "MODIFIER($1)\n" if ($dbg_values > 1);
			$type = 'T';

1238
		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1239
			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1240
			$av_preprocessor = 1;
1241 1242 1243 1244 1245 1246
			push(@av_paren_type, $type);
			if ($2 ne '') {
				$av_pending = 'N';
			}
			$type = 'E';

1247
		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1248 1249 1250
			print "UNDEF($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;
			push(@av_paren_type, $type);
1251

1252
		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1253
			print "PRE_START($1)\n" if ($dbg_values > 1);
1254
			$av_preprocessor = 1;
1255 1256 1257

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
1258
			$type = 'E';
1259

1260
		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1261 1262 1263 1264 1265
			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;

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

1266
			$type = 'E';
1267

1268
		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1269 1270 1271 1272 1273 1274 1275 1276
			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);
1277
			$type = 'E';
1278 1279

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

1282 1283 1284 1285 1286
		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
			print "ATTR($1)\n" if ($dbg_values > 1);
			$av_pending = $type;
			$type = 'N';

1287
		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1288
			print "SIZEOF($1)\n" if ($dbg_values > 1);
1289
			if (defined $2) {
1290
				$av_pending = 'V';
1291 1292 1293
			}
			$type = 'N';

1294
		} elsif ($cur =~ /^(if|while|for)\b/o) {
1295
			print "COND($1)\n" if ($dbg_values > 1);
1296
			$av_pending = 'E';
1297 1298
			$type = 'N';

1299 1300 1301 1302 1303
		} elsif ($cur =~/^(case)/o) {
			print "CASE($1)\n" if ($dbg_values > 1);
			$av_pend_colon = 'C';
			$type = 'N';

1304
		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1305
			print "KEYWORD($1)\n" if ($dbg_values > 1);
1306 1307 1308
			$type = 'N';

		} elsif ($cur =~ /^(\()/o) {
1309
			print "PAREN('$1')\n" if ($dbg_values > 1);
1310 1311
			push(@av_paren_type, $av_pending);
			$av_pending = '_';
1312 1313 1314
			$type = 'N';

		} elsif ($cur =~ /^(\))/o) {
1315 1316 1317
			my $new_type = pop(@av_paren_type);
			if ($new_type ne '_') {
				$type = $new_type;
1318 1319
				print "PAREN('$1') -> $type\n"
							if ($dbg_values > 1);
1320
			} else {
1321
				print "PAREN('$1')\n" if ($dbg_values > 1);
1322 1323
			}

1324
		} elsif ($cur =~ /^($Ident)\s*\(/o) {
1325
			print "FUNC($1)\n" if ($dbg_values > 1);
1326
			$type = 'V';
1327
			$av_pending = 'V';
1328

1329 1330
		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
			if (defined $2 && $type eq 'C' || $type eq 'T') {
1331
				$av_pend_colon = 'B';
1332 1333
			} elsif ($type eq 'E') {
				$av_pend_colon = 'L';
1334 1335 1336 1337
			}
			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
			$type = 'V';

1338
		} elsif ($cur =~ /^($Ident|$Constant)/o) {
1339
			print "IDENT($1)\n" if ($dbg_values > 1);
1340 1341 1342
			$type = 'V';

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

1346
		} elsif ($cur =~/^(;|{|})/) {
1347
			print "END($1)\n" if ($dbg_values > 1);
1348
			$type = 'E';
1349 1350
			$av_pend_colon = 'O';

1351 1352 1353 1354
		} elsif ($cur =~/^(,)/) {
			print "COMMA($1)\n" if ($dbg_values > 1);
			$type = 'C';

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

1370
		} elsif ($cur =~ /^(\[)/o) {
1371
			print "CLOSE($1)\n" if ($dbg_values > 1);
1372 1373
			$type = 'N';

1374
		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386
			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';

1387
		} elsif ($cur =~ /^($Operators)/o) {
1388
			print "OP($1)\n" if ($dbg_values > 1);
1389 1390 1391 1392 1393
			if ($1 ne '++' && $1 ne '--') {
				$type = 'N';
			}

		} elsif ($cur =~ /(^.)/o) {
1394
			print "C($1)\n" if ($dbg_values > 1);
1395 1396 1397 1398 1399
		}
		if (defined $1) {
			$cur = substr($cur, length($1));
			$res .= $type x length($1);
		}
1400
	}
1401

1402
	return ($res, $var);
1403 1404
}

1405
sub possible {
1406
	my ($possible, $line) = @_;
1407
	my $notPermitted = qr{(?:
1408 1409 1410 1411
		^(?:
			$Modifier|
			$Storage|
			$Type|
1412 1413 1414
			DEFINE_\S+
		)$|
		^(?:
1415 1416 1417 1418 1419
			goto|
			return|
			case|
			else|
			asm|__asm__|
1420 1421 1422
			do|
			\#|
			\#\#|
1423
		)(?:\s|$)|
1424
		^(?:typedef|struct|enum)\b
1425 1426 1427
	    )}x;
	warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
	if ($possible !~ $notPermitted) {
1428 1429 1430 1431 1432 1433 1434
		# 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;
1435
			for my $modifier (split(' ', $possible)) {
1436 1437 1438 1439
				if ($modifier !~ $notPermitted) {
					warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
					push(@modifierList, $modifier);
				}
1440
			}
1441 1442 1443 1444 1445

		} else {
			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
			push(@typeList, $possible);
		}
1446
		build_types();
1447 1448
	} else {
		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1449 1450 1451
	}
}

1452 1453
my $prefix = '';

1454
sub show_type {
1455
	my ($type) = @_;
1456

1457 1458 1459
	return defined $use_type{$type} if (scalar keys %use_type > 0);

	return !defined $ignore_type{$type};
1460 1461
}

1462
sub report {
1463 1464 1465 1466
	my ($level, $type, $msg) = @_;

	if (!show_type($type) ||
	    (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1467 1468
		return 0;
	}
1469 1470
	my $line;
	if ($show_types) {
1471
		$line = "$prefix$level:$type: $msg\n";
1472
	} else {
1473
		$line = "$prefix$level: $msg\n";
1474
	}
1475 1476
	$line = (split('\n', $line))[0] . "\n" if ($terse);

1477
	push(our @report, $line);
1478 1479

	return 1;
1480
}
1481

1482
sub report_dump {
1483
	our @report;
1484
}
1485

1486
sub ERROR {
1487 1488 1489
	my ($type, $msg) = @_;

	if (report("ERROR", $type, $msg)) {
1490 1491
		our $clean = 0;
		our $cnt_error++;
1492
		return 1;
1493
	}
1494
	return 0;
1495 1496
}
sub WARN {
1497 1498 1499
	my ($type, $msg) = @_;

	if (report("WARNING", $type, $msg)) {
1500 1501
		our $clean = 0;
		our $cnt_warn++;
1502
		return 1;
1503
	}
1504
	return 0;
1505 1506
}
sub CHK {
1507 1508 1509
	my ($type, $msg) = @_;

	if ($check && report("CHECK", $type, $msg)) {
1510 1511
		our $clean = 0;
		our $cnt_chk++;
1512
		return 1;
1513
	}
1514
	return 0;
1515 1516
}

1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539
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 ".../") {
1540 1541
		WARN("USE_RELATIVE_PATH",
		     "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1542 1543 1544
	}
}

1545 1546 1547
sub trim {
	my ($string) = @_;

1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564
	$string =~ s/^\s+|\s+$//g;

	return $string;
}

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

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

	return $string;
}

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

	$string =~ s/\s+$//;
1565 1566 1567 1568

	return $string;
}

1569 1570 1571 1572 1573 1574 1575 1576
sub string_find_replace {
	my ($string, $find, $replace) = @_;

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

	return $string;
}

1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591
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";
}

1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618
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;
		}
	}

1619
	return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
1620 1621
}

1622 1623 1624 1625 1626
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
1627
	my $prevrawline="";
1628
	my $stashline="";
1629
	my $stashrawline="";
1630

1631
	my $length;
1632 1633 1634 1635
	my $indent;
	my $previndent=0;
	my $stashindent=0;

1636
	our $clean = 1;
1637 1638 1639
	my $signoff = 0;
	my $is_patch = 0;

1640
	my $in_header_lines = $file ? 0 : 1;
1641 1642
	my $in_commit_log = 0;		#Scanning lines before patch

1643 1644
	my $non_utf8_charset = 0;

1645
	our @report = ();
1646 1647 1648 1649 1650
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

1651 1652 1653 1654 1655 1656
	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
	my $in_comment = 0;
1657
	my $comment_edge = 0;
1658
	my $first_line = 0;
1659
	my $p1_prefix = '';
1660

1661 1662 1663
	my $prev_values = 'E';

	# suppression flags
1664
	my %suppress_ifbraces;
1665
	my %suppress_whiletrailers;
1666
	my %suppress_export;
1667
	my $suppress_statement = 0;
1668

1669
	my %signatures = ();
1670

1671
	# Pre-scan the patch sanitizing the lines.
1672
	# Pre-scan the patch looking for any __setup documentation.
1673
	#
1674 1675
	my @setup_docs = ();
	my $setup_docs = 0;
1676

1677 1678
	my $camelcase_file_seeded = 0;

1679
	sanitise_line_reset();
1680 1681
	my $line;
	foreach my $rawline (@rawlines) {
1682 1683
		$linenr++;
		$line = $rawline;
1684

1685 1686
		push(@fixed, $rawline) if ($fix);

1687
		if ($rawline=~/^\+\+\+\s+(\S+)/) {
1688 1689 1690 1691
			$setup_docs = 0;
			if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
				$setup_docs = 1;
			}
1692 1693 1694 1695 1696 1697 1698 1699 1700
			#next;
		}
		if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1701
			$in_comment = 0;
1702 1703 1704 1705 1706 1707

			# 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;
1708 1709 1710 1711 1712 1713
			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";
1714
				last if (!defined $rawlines[$ln - 1]);
1715 1716 1717 1718 1719
				if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
				    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
					($edge) = $1;
					last;
				}
1720 1721 1722 1723 1724 1725 1726 1727 1728
			}
			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 &&
1729
			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1730 1731 1732 1733 1734 1735 1736
			{
				$in_comment = 1;
			}

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

1737
		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1738
			# Standardise the strings and chars within the input to
1739
			# simplify matching -- only bother with positive lines.
1740
			$line = sanitise_line($rawline);
1741
		}
1742 1743 1744 1745 1746 1747 1748 1749 1750 1751
		push(@lines, $line);

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

		#print "==>$rawline\n";
		#print "-->$line\n";
1752 1753 1754 1755 1756 1757

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

1758 1759
	$prefix = '';

1760 1761
	$realcnt = 0;
	$linenr = 0;
1762 1763
	foreach my $line (@lines) {
		$linenr++;
1764 1765
		my $sline = $line;	#copy of $line
		$sline =~ s/$;/ /g;	#with comments as spaces
1766

1767
		my $rawline = $rawlines[$linenr - 1];
1768

1769
#extract the line range in the file after the patch is applied
1770
		if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1771
			$is_patch = 1;
1772
			$first_line = $linenr + 1;
1773 1774 1775 1776 1777 1778
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1779
			annotate_reset();
1780 1781
			$prev_values = 'E';

1782
			%suppress_ifbraces = ();
1783
			%suppress_whiletrailers = ();
1784
			%suppress_export = ();
1785
			$suppress_statement = 0;
1786 1787
			next;

1788 1789 1790
# 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.
1791
		} elsif ($line =~ /^( |\+|$)/) {
1792
			$realline++;
1793
			$realcnt-- if ($realcnt != 0);
1794

1795
			# Measure the line length and indent.
1796
			($length, $indent) = line_stats($rawline);
1797 1798 1799 1800

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

1803
			#warn "line<$line>\n";
1804

1805 1806
		} elsif ($realcnt == 1) {
			$realcnt--;
1807 1808
		}

1809 1810
		my $hunk_line = ($realcnt != 0);

1811
#make up the handle for any error we report on this line
1812 1813 1814
		$prefix = "$filename:$realline: " if ($emacs && $file);
		$prefix = "$filename:$linenr: " if ($emacs && !$file);

1815 1816
		$here = "#$linenr: " if (!$file);
		$here = "#$realline: " if ($file);
1817

1818
		my $found_file = 0;
1819
		# extract the filename as it passes
1820 1821
		if ($line =~ /^diff --git.*?(\S+)$/) {
			$realfile = $1;
1822
			$realfile =~ s@^([^/]*)/@@ if (!$file);
1823
			$in_commit_log = 0;
1824
			$found_file = 1;
1825
		} elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1826
			$realfile = $1;
1827
			$realfile =~ s@^([^/]*)/@@ if (!$file);
1828
			$in_commit_log = 0;
1829 1830

			$p1_prefix = $1;
1831 1832
			if (!$file && $tree && $p1_prefix ne '' &&
			    -e "$root/$p1_prefix") {
1833 1834
				WARN("PATCH_PREFIX",
				     "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1835
			}
1836

1837
			if ($realfile =~ m@^include/asm/@) {
1838 1839
				ERROR("MODIFIED_INCLUDE_ASM",
				      "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1840
			}
1841 1842 1843 1844 1845 1846 1847 1848 1849
			$found_file = 1;
		}

		if ($found_file) {
			if ($realfile =~ m@^(drivers/net/|net/)@) {
				$check = 1;
			} else {
				$check = $check_orig;
			}
1850 1851 1852
			next;
		}

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

1855 1856 1857
		my $hereline = "$here\n$rawline\n";
		my $herecurr = "$here\n$rawline\n";
		my $hereprev = "$here\n$prevrawline\n$rawline\n";
1858

1859 1860
		$cnt_lines++ if ($realcnt != 0);

1861 1862 1863
# Check for incorrect file permissions
		if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
			my $permhere = $here . "FILE: $realfile\n";
1864 1865
			if ($realfile !~ m@scripts/@ &&
			    $realfile !~ /\.(py|pl|awk|sh)$/) {
1866 1867
				ERROR("EXECUTE_PERMISSIONS",
				      "do not set execute permissions for source files\n" . $permhere);
1868 1869 1870
			}
		}

1871
# Check the patch for a signoff:
1872
		if ($line =~ /^\s*signed-off-by:/i) {
1873
			$signoff++;
1874
			$in_commit_log = 0;
1875 1876 1877
		}

# Check signature styles
1878
		if (!$in_header_lines &&
1879
		    $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
1880 1881 1882 1883 1884 1885
			my $space_before = $1;
			my $sign_off = $2;
			my $space_after = $3;
			my $email = $4;
			my $ucfirst_sign_off = ucfirst(lc($sign_off));

1886 1887 1888 1889
			if ($sign_off !~ /$signature_tags/) {
				WARN("BAD_SIGN_OFF",
				     "Non-standard signature: $sign_off\n" . $herecurr);
			}
1890
			if (defined $space_before && $space_before ne "") {
1891 1892 1893 1894 1895 1896
				if (WARN("BAD_SIGN_OFF",
					 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
				    $fix) {
					$fixed[$linenr - 1] =
					    "$ucfirst_sign_off $email";
				}
1897 1898
			}
			if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
1899 1900 1901 1902 1903 1904 1905
				if (WARN("BAD_SIGN_OFF",
					 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
				    $fix) {
					$fixed[$linenr - 1] =
					    "$ucfirst_sign_off $email";
				}

1906 1907
			}
			if (!defined $space_after || $space_after ne " ") {
1908 1909 1910 1911 1912 1913
				if (WARN("BAD_SIGN_OFF",
					 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
				    $fix) {
					$fixed[$linenr - 1] =
					    "$ucfirst_sign_off $email";
				}
1914
			}
1915 1916 1917 1918

			my ($email_name, $email_address, $comment) = parse_email($email);
			my $suggested_email = format_email(($email_name, $email_address));
			if ($suggested_email eq "") {
1919 1920
				ERROR("BAD_SIGN_OFF",
				      "Unrecognized email address: '$email'\n" . $herecurr);
1921 1922 1923 1924 1925 1926 1927 1928 1929
			} 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) {
1930 1931
					WARN("BAD_SIGN_OFF",
					     "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
1932
				}
1933
			}
1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944

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

1947 1948 1949 1950 1951 1952
# Check for old stable address
		if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
			ERROR("STABLE_ADDRESS",
			      "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
		}

1953 1954 1955 1956 1957 1958
# Check for unwanted Gerrit info
		if ($in_commit_log && $line =~ /^\s*change-id:/i) {
			ERROR("GERRIT_CHANGE_ID",
			      "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
		}

1959
# Check for wrappage within a valid hunk of the file
1960
		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1961 1962
			ERROR("CORRUPTED_PATCH",
			      "patch seems to be corrupt (line wrapped?)\n" .
1963
				$herecurr) if (!$emitted_corrupt++);
1964 1965
		}

1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979
# 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);
				}
			}
		}

1980 1981
# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1982 1983 1984 1985 1986 1987 1988
		    $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";

1989 1990
			CHK("INVALID_UTF8",
			    "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1991 1992
		}

1993 1994 1995
# 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 =~ /^$/ &&
1996 1997
		    !($rawline =~ /^\s+\S/ ||
		      $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
1998 1999 2000 2001
			$in_header_lines = 0;
			$in_commit_log = 1;
		}

2002 2003 2004 2005 2006 2007 2008 2009 2010
# 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 =~ /^$/ &&
2011
		    $rawline =~ /$NON_ASCII_UTF8/) {
2012
			WARN("UTF8_BEFORE_PATCH",
2013 2014 2015
			    "8-bit UTF-8 used in possible commit log\n" . $herecurr);
		}

2016 2017
# ignore non-hunk lines and lines being removed
		next if (!$hunk_line || $line =~ /^-/);
2018 2019

#trailing whitespace
2020
		if ($line =~ /^\+.*\015/) {
2021
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2022 2023 2024 2025 2026
			if (ERROR("DOS_LINE_ENDINGS",
				  "DOS line endings\n" . $herevet) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/[\s\015]+$//;
			}
2027 2028
		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2029 2030 2031
			if (ERROR("TRAILING_WHITESPACE",
				  "trailing whitespace\n" . $herevet) &&
			    $fix) {
2032
				$fixed[$linenr - 1] =~ s/\s+$//;
2033 2034
			}

2035
			$rpt_cleaners = 1;
2036
		}
2037

2038
# Check for FSF mailing addresses.
2039
		if ($rawline =~ /\bwrite to the Free/i ||
2040 2041
		    $rawline =~ /\b59\s+Temple\s+Pl/i ||
		    $rawline =~ /\b51\s+Franklin\s+St/i) {
2042 2043 2044 2045
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
			my $msg_type = \&ERROR;
			$msg_type = \&CHK if ($file);
			&{$msg_type}("FSF_MAILING_ADDRESS",
2046
				     "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)
2047 2048
		}

2049
# check for Kconfig help text having a real description
2050 2051
# Only applies when adding the entry originally, after that we do not have
# sufficient context to determine whether it is indeed long enough.
2052
		if ($realfile =~ /Kconfig/ &&
2053
		    $line =~ /.\s*config\s+/) {
2054
			my $length = 0;
2055 2056 2057
			my $cnt = $realcnt;
			my $ln = $linenr + 1;
			my $f;
2058
			my $is_start = 0;
2059
			my $is_end = 0;
2060
			for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2061 2062 2063 2064 2065
				$f = $lines[$ln - 1];
				$cnt-- if ($lines[$ln - 1] !~ /^-/);
				$is_end = $lines[$ln - 1] =~ /^\+/;

				next if ($f =~ /^-/);
2066 2067 2068 2069 2070 2071 2072

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

2073
				$f =~ s/^.//;
2074 2075 2076
				$f =~ s/#.*//;
				$f =~ s/^\s+//;
				next if ($f =~ /^$/);
2077 2078 2079 2080
				if ($f =~ /^\s*config\s/) {
					$is_end = 1;
					last;
				}
2081 2082
				$length++;
			}
2083
			WARN("CONFIG_DESCRIPTION",
2084 2085
			     "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";
2086 2087
		}

2088 2089 2090 2091 2092 2093 2094
# 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");
		}

2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108
		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});
		}

2109
# check for DT compatible documentation
2110 2111 2112 2113
		if (defined $root &&
			(($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
			 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {

2114 2115
			my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;

2116 2117 2118
			my $dt_path = $root . "/Documentation/devicetree/bindings/";
			my $vp_file = $dt_path . "vendor-prefixes.txt";

2119 2120
			foreach my $compat (@compats) {
				my $compat2 = $compat;
2121 2122 2123 2124
				$compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
				my $compat3 = $compat;
				$compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
				`grep -Erq "$compat|$compat2|$compat3" $dt_path`;
2125 2126 2127 2128 2129
				if ( $? >> 8 ) {
					WARN("UNDOCUMENTED_DT_STRING",
					     "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
				}

2130 2131
				next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
				my $vendor = $1;
2132
				`grep -Eq "^$vendor\\b" $vp_file`;
2133 2134
				if ( $? >> 8 ) {
					WARN("UNDOCUMENTED_DT_STRING",
2135
					     "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2136 2137 2138 2139
				}
			}
		}

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

2143
#line length limit
2144
		if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
2145
		    $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
2146
		    !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
2147
		    $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
2148
		    $length > $max_line_length)
2149
		{
2150
			WARN("LONG_LINE",
2151
			     "line over $max_line_length characters\n" . $herecurr);
2152 2153
		}

2154
# Check for user-visible strings broken across lines, which breaks the ability
2155 2156 2157
# 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
2158 2159
		if ($line =~ /^\+\s*"/ &&
		    $prevline =~ /"\s*$/ &&
2160
		    $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
2161 2162 2163 2164
			WARN("SPLIT_STRING",
			     "quoted string split across lines\n" . $hereprev);
		}

2165 2166
# check for spaces before a quoted newline
		if ($rawline =~ /^.*\".*\s\\n/) {
2167 2168 2169 2170 2171 2172
			if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
				 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
			}

2173 2174
		}

2175 2176
# check for adding lines without a newline.
		if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2177 2178
			WARN("MISSING_EOF_NEWLINE",
			     "adding a line without newline at end of file\n" . $herecurr);
2179 2180
		}

2181 2182 2183 2184
# 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";
2185 2186
				ERROR("LO_MACRO",
				      "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2187 2188 2189
			}
			if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
				my $herevet = "$here\n" . cat_vet($line) . "\n";
2190 2191
				ERROR("HI_MACRO",
				      "use the HI() macro, not (... >> 16)\n" . $herevet);
2192 2193 2194
			}
		}

2195 2196
# check we are in a valid source file C or perl if not then ignore this hunk
		next if ($realfile !~ /\.(h|c|pl)$/);
2197 2198 2199

# at the beginning of a line any tabs must come first and anything
# more than 8 must use tabs.
2200 2201 2202
		if ($rawline =~ /^\+\s* \t\s*\S/ ||
		    $rawline =~ /^\+\s*        \s*/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2203
			$rpt_cleaners = 1;
2204 2205 2206 2207 2208
			if (ERROR("CODE_INDENT",
				  "code indent should use tabs where possible\n" . $herevet) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
			}
2209 2210
		}

2211 2212 2213
# check for space before tabs.
		if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2214 2215 2216
			if (WARN("SPACE_BEFORE_TAB",
				"please, no space before tabs\n" . $herevet) &&
			    $fix) {
2217 2218 2219 2220
				while ($fixed[$linenr - 1] =~
					   s/(^\+.*) {8,8}+\t/$1\t\t/) {}
				while ($fixed[$linenr - 1] =~
					   s/(^\+.*) +\t/$1\t/) {}
2221
			}
2222 2223
		}

2224 2225 2226 2227 2228 2229 2230 2231
# 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 &&
2232
		    $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2233 2234 2235 2236 2237 2238
			$prevline =~ /^\+(\t*)(.*)$/;
			my $oldindent = $1;
			my $rest = $2;

			my $pos = pos_last_openparen($rest);
			if ($pos >= 0) {
J
Joe Perches 已提交
2239 2240
				$line =~ /^(\+| )([ \t]*)/;
				my $newindent = $2;
2241 2242 2243 2244 2245 2246 2247 2248

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

				if ($newindent ne $goodtabindent &&
				    $newindent ne $goodspaceindent) {
2249 2250 2251 2252 2253 2254 2255

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

2260
		if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
2261 2262 2263 2264 2265 2266
			if (CHK("SPACING",
				"No space is necessary after a cast\n" . $hereprev) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/^(\+.*\*[ \t]*\))[ \t]+/$1/;
			}
2267 2268
		}

2269
		if ($realfile =~ m@^(drivers/net/|net/)@ &&
2270
		    $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2271 2272
		    $rawline =~ /^\+[ \t]*\*/ &&
		    $realline > 2) {
2273 2274 2275 2276 2277
			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
			     "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
		}

		if ($realfile =~ m@^(drivers/net/|net/)@ &&
2278 2279
		    $prevrawline =~ /^\+[ \t]*\/\*/ &&		#starting /*
		    $prevrawline !~ /\*\/[ \t]*$/ &&		#no trailing */
2280
		    $rawline =~ /^\+/ &&			#line is new
2281 2282 2283 2284 2285 2286
		    $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/)@ &&
2287 2288 2289 2290
		    $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ &&	#trailing */
		    $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ &&	#inline /*...*/
		    $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ &&	#trailing **/
		    $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) {	#non blank */
2291 2292 2293 2294
			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
			     "networking block comments put the trailing */ on a separate line\n" . $herecurr);
		}

2295
# check for missing blank lines after declarations
2296 2297 2298
		if ($sline =~ /^\+\s+\S/ &&			#Not at char 1
			# actual declarations
		    ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2299 2300
			# function pointer declarations
		     $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312
			# foo bar; where foo is some local typedef or #define
		     $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
			# known declaration macros
		     $prevline =~ /^\+\s+$declaration_macros/) &&
			# for "else if" which can look like "$Ident $Ident"
		    !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
			# other possible extensions of declaration lines
		      $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
			# not starting a section or a macro "\" extended line
		      $prevline =~ /(?:\{\s*|\\)$/) &&
			# looks like a declaration
		    !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2313 2314
			# function pointer declarations
		      $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2315 2316 2317 2318 2319
			# foo bar; where foo is some local typedef or #define
		      $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
			# known declaration macros
		      $sline =~ /^\+\s+$declaration_macros/ ||
			# start of struct or union or enum
2320
		      $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
2321 2322 2323 2324 2325 2326 2327 2328
			# start or end of block or continuation of declaration
		      $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
			# bitfield continuation
		      $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
			# other possible extensions of declaration lines
		      $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
			# indentation of previous and current line are the same
		    (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
2329
			WARN("SPACING",
2330
			     "Missing a blank line after declarations\n" . $hereprev);
2331 2332
		}

2333
# check for spaces at the beginning of a line.
2334 2335 2336 2337
# Exceptions:
#  1) within comments
#  2) indented preprocessor commands
#  3) hanging labels
2338
		if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/)  {
2339
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2340 2341 2342 2343 2344
			if (WARN("LEADING_SPACE",
				 "please, no spaces at the start of a line\n" . $herevet) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
			}
2345 2346
		}

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

2350 2351 2352 2353 2354 2355 2356 2357 2358 2359
# check indentation of any line with a bare else
# if the previous line is a break or return and is indented 1 tab more...
		if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
			my $tabs = length($1) + 1;
			if ($prevline =~ /^\+\t{$tabs,$tabs}(?:break|return)\b/) {
				WARN("UNNECESSARY_ELSE",
				     "else is not generally useful after a break or return\n" . $hereprev);
			}
		}

2360 2361 2362 2363 2364 2365
# 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");
		}

2366
# check for RCS/CVS revision markers
2367
		if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
2368 2369
			WARN("CVS_KEYWORD",
			     "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
2370
		}
2371

2372 2373 2374
# Blackfin: don't use __builtin_bfin_[cs]sync
		if ($line =~ /__builtin_bfin_csync/) {
			my $herevet = "$here\n" . cat_vet($line) . "\n";
2375 2376
			ERROR("CSYNC",
			      "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
2377 2378 2379
		}
		if ($line =~ /__builtin_bfin_ssync/) {
			my $herevet = "$here\n" . cat_vet($line) . "\n";
2380 2381
			ERROR("SSYNC",
			      "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
2382 2383
		}

2384 2385 2386 2387 2388 2389
# 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);
		}

2390
# Check for potential 'bare' types
2391 2392
		my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
		    $realline_next);
2393 2394
#print "LINE<$line>\n";
		if ($linenr >= $suppress_statement &&
2395
		    $realcnt && $sline =~ /.\s*\S/) {
2396
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2397
				ctx_statement_block($linenr, $realcnt, 0);
2398 2399 2400
			$stat =~ s/\n./\n /g;
			$cond =~ s/\n./\n /g;

2401 2402 2403 2404 2405 2406 2407 2408 2409
#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;
			}
2410

2411 2412 2413 2414 2415 2416 2417 2418
			# 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++;
			}

2419 2420
			my $s = $stat;
			$s =~ s/{.*$//s;
2421

2422
			# Ignore goto labels.
2423
			if ($s =~ /$Ident:\*$/s) {
2424 2425

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

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

2430
			# declarations always start with types
2431
			} 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) {
2432 2433 2434 2435
				my $type = $1;
				$type =~ s/\s+/ /g;
				possible($type, "A:" . $s);

2436
			# definitions in global scope can only start with types
2437
			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
2438
				possible($1, "B:" . $s);
2439
			}
2440 2441

			# any (foo ... *) is a pointer cast, and foo is a type
2442
			while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
2443
				possible($1, "C:" . $s);
2444 2445 2446 2447 2448
			}

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

2452
				my $ctx = $s;
2453
				substr($ctx, 0, $name_len + 1, '');
2454
				$ctx =~ s/\)[^\)]*$//;
2455

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

2459
						possible($1, "D:" . $s);
2460 2461
					}
				}
2462
			}
2463

2464 2465
		}

2466 2467 2468
#
# Checks which may be anchored in the context.
#
2469

2470 2471
# Check for switch () and associated case and default
# statements should be at the same indent.
2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487
		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 '') {
2488 2489
				ERROR("SWITCH_CASE_INDENT_LEVEL",
				      "switch and case should be at the same indent\n$hereline$err");
2490 2491 2492 2493 2494
			}
		}

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

2498
			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2499 2500 2501 2502 2503 2504

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

2505 2506 2507
			my $ctx_cnt = $realcnt - $#ctx - 1;
			my $ctx = join("\n", @ctx);

2508 2509
			my $ctx_ln = $linenr;
			my $ctx_skip = $realcnt;
2510

2511 2512 2513 2514 2515
			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] !~ /^-/);
2516 2517
				$ctx_ln++;
			}
2518

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

2522
			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2523 2524
				ERROR("OPEN_BRACE",
				      "that open brace { should be on the previous line\n" .
2525
					"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2526
			}
2527 2528 2529 2530
			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
			    $ctx =~ /\)\s*\;\s*$/ &&
			    defined $lines[$ctx_ln - 1])
			{
2531 2532
				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
				if ($nindent > $indent) {
2533 2534
					WARN("TRAILING_SEMICOLON",
					     "trailing semicolon indicates no statements, indent implies otherwise\n" .
2535
						"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2536 2537
				}
			}
2538 2539
		}

2540 2541
# Check relative indent for conditionals and blocks.
		if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2542 2543 2544
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
2545 2546 2547 2548 2549 2550 2551 2552 2553 2554
			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.
2555 2556
			my @newlines = ($c =~ /\n/gs);
			my $cond_lines = 1 + $#newlines;
2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569

			# 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;
			}
2570
			if ($s =~ s/^\s*?\n//) {
2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581
				$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;
			}

2582
			my $cond_ptr = -1;
2583
			$continuation = 0;
2584 2585 2586
			while ($cond_ptr != $cond_lines) {
				$cond_ptr = $cond_lines;

2587 2588 2589 2590 2591 2592
				# If we see an #else/#elif then the code
				# is not linear.
				if ($s =~ /^\s*\#\s*(?:else|elif)/) {
					$check = 0;
				}

2593 2594 2595 2596
				# Ignore:
				#  1) blank lines, they should be at 0,
				#  2) preprocessor lines, and
				#  3) labels.
2597 2598
				if ($continuation ||
				    $s =~ /^\s*?\n/ ||
2599 2600
				    $s =~ /^\s*#\s*?/ ||
				    $s =~ /^\s*$Ident\s*:/) {
2601
					$continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2602 2603 2604
					if ($s =~ s/^.*?\n//) {
						$cond_lines++;
					}
2605
				}
2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620
			}

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

2621
			#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";
2622 2623 2624

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

2630 2631
		# Track the 'values' across context and added lines.
		my $opline = $line; $opline =~ s/^./ /;
2632 2633
		my ($curr_values, $curr_vars) =
				annotate_values($opline . "\n", $prev_values);
2634
		$curr_values = $prev_values . $curr_values;
2635 2636
		if ($dbg_values) {
			my $outline = $opline; $outline =~ s/\t/ /g;
2637 2638
			print "$linenr > .$outline\n";
			print "$linenr > $curr_values\n";
2639
			print "$linenr >  $curr_vars\n";
2640
		}
2641 2642
		$prev_values = substr($curr_values, -1);

2643
#ignore lines not being added
2644
		next if ($line =~ /^[^\+]/);
2645

2646
# TEST: allow direct testing of the type matcher.
2647 2648
		if ($dbg_type) {
			if ($line =~ /^.\s*$Declare\s*$/) {
2649 2650
				ERROR("TEST_TYPE",
				      "TEST: is type\n" . $herecurr);
2651
			} elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2652 2653
				ERROR("TEST_NOT_TYPE",
				      "TEST: is not type ($1 is)\n". $herecurr);
2654
			}
2655 2656
			next;
		}
2657 2658
# TEST: allow direct testing of the attribute matcher.
		if ($dbg_attr) {
2659
			if ($line =~ /^.\s*$Modifier\s*$/) {
2660 2661
				ERROR("TEST_ATTR",
				      "TEST: is attr\n" . $herecurr);
2662
			} elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2663 2664
				ERROR("TEST_NOT_ATTR",
				      "TEST: is not attr ($1 is)\n". $herecurr);
2665 2666 2667
			}
			next;
		}
2668

2669
# check for initialisation to aggregates open brace on the next line
2670 2671
		if ($line =~ /^.\s*{/ &&
		    $prevline =~ /(?:^|[^=])=\s*$/) {
2672 2673
			ERROR("OPEN_BRACE",
			      "that open brace { should be on the previous line\n" . $hereprev);
2674 2675
		}

2676 2677 2678 2679 2680
#
# Checks which are anchored on the added line.
#

# check for malformed paths in #include statements (uses RAW line)
2681
		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2682 2683
			my $path = $1;
			if ($path =~ m{//}) {
2684
				ERROR("MALFORMED_INCLUDE",
2685 2686 2687 2688 2689
				      "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);
2690 2691
			}
		}
2692

2693
# no C99 // comments
2694
		if ($line =~ m{//}) {
2695 2696 2697 2698 2699 2700 2701 2702 2703
			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 \*/@;
				}
			}
2704
		}
2705
		# Remove C99 comments.
2706
		$line =~ s@//.*@@;
2707
		$opline =~ s@//.*@@;
2708

2709 2710 2711 2712 2713 2714 2715 2716
# 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.*\((.*)\)/)) {
2717 2718 2719 2720
			# Handle definitions which produce identifiers with
			# a prefix:
			#   XXX(foo);
			#   EXPORT_SYMBOL(something_foo);
2721
			my $name = $1;
2722
			if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
2723 2724 2725 2726 2727
			    $name =~ /^${Ident}_$2/) {
#print "FOO C name<$name>\n";
				$suppress_export{$realline_next} = 1;

			} elsif ($stat !~ /(?:
2728
				\n.}\s*$|
2729 2730 2731
				^.DEFINE_$Ident\(\Q$name\E\)|
				^.DECLARE_$Ident\(\Q$name\E\)|
				^.LIST_HEAD\(\Q$name\E\)|
2732 2733
				^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
				\b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
2734
			    )/x) {
2735 2736 2737 2738
#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
				$suppress_export{$realline_next} = 2;
			} else {
				$suppress_export{$realline_next} = 1;
2739 2740
			}
		}
2741 2742 2743 2744 2745 2746 2747 2748 2749
		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) {
2750 2751
			WARN("EXPORT_SYMBOL",
			     "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2752
		}
2753

2754
# check for global initialisers.
2755 2756 2757 2758 2759 2760 2761
		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;/;
			}
2762
		}
2763
# check for static initialisers.
2764 2765 2766 2767 2768 2769 2770
		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;/;
			}
2771 2772
		}

2773 2774
# check for static const char * arrays.
		if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
2775 2776
			WARN("STATIC_CONST_CHAR_ARRAY",
			     "static const char * array should probably be static const char * const\n" .
2777 2778 2779 2780 2781
				$herecurr);
               }

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

2787 2788 2789 2790 2791 2792 2793
# check for non-global char *foo[] = {"bar", ...} declarations.
		if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
			WARN("STATIC_CONST_CHAR_ARRAY",
			     "char * array declaration might be better as static const\n" .
				$herecurr);
               }

2794 2795 2796 2797 2798 2799 2800 2801 2802
# check for function declarations without arguments like "int foo()"
		if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
			if (ERROR("FUNCTION_WITHOUT_ARGS",
				  "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
			}
		}

2803 2804 2805 2806 2807 2808 2809
# 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\[\] = /;
			}
2810 2811
		}

2812 2813 2814
# check for new typedefs, only function parameters and sparse annotations
# make sense.
		if ($line =~ /\btypedef\s/ &&
2815
		    $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
2816
		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
2817
		    $line !~ /\b$typeTypedefs\b/ &&
2818
		    $line !~ /\b__bitwise(?:__|)\b/) {
2819 2820
			WARN("NEW_TYPEDEFS",
			     "do not add new typedefs\n" . $herecurr);
2821 2822 2823
		}

# * goes on variable not on type
2824
		# (char*[ const])
2825 2826
		while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
			#print "AA<$1>\n";
2827
			my ($ident, $from, $to) = ($1, $2, $2);
2828 2829 2830 2831 2832 2833

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

2837
##			print "1: from<$from> to<$to> ident<$ident>\n";
2838
			if ($from ne $to) {
2839 2840 2841 2842 2843 2844 2845 2846 2847
				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@;
				}
2848
			}
2849 2850 2851
		}
		while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
			#print "BB<$1>\n";
2852
			my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
2853 2854 2855 2856 2857 2858

			# Should start with a space.
			$to =~ s/^(\S)/ $1/;
			# Should not end with a space.
			$to =~ s/\s+$//;
			# '*'s should not have spaces between.
2859
			while ($to =~ s/\*\s+\*/\*\*/) {
2860 2861 2862
			}
			# Modifiers should have spaces.
			$to =~ s/(\b$Modifier$)/$1 /;
2863

2864
##			print "2: from<$from> to<$to> ident<$ident>\n";
2865
			if ($from ne $to && $ident !~ /^$Modifier$/) {
2866 2867 2868 2869 2870 2871 2872 2873 2874 2875
				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@;
				}
2876
			}
2877 2878 2879 2880 2881 2882 2883 2884 2885
		}

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

2886
		if ($line =~ /\bLINUX_VERSION_CODE\b/) {
2887 2888
			WARN("LINUX_VERSION_CODE",
			     "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
2889 2890
		}

2891 2892
# check for uses of printk_ratelimit
		if ($line =~ /\bprintk_ratelimit\s*\(/) {
2893 2894
			WARN("PRINTK_RATELIMITED",
"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
2895 2896
		}

2897 2898 2899
# 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 已提交
2900
# printk includes all preceding printk's which have no newline on the end.
2901
# we assume the first bad printk is the one to report.
2902
		if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
2903 2904 2905
			my $ok = 0;
			for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
				#print "CHECK<$lines[$ln - 1]\n";
L
Lucas De Marchi 已提交
2906
				# we have a preceding printk if it ends
2907 2908 2909 2910 2911 2912 2913 2914 2915
				# 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) {
2916 2917
				WARN("PRINTK_WITHOUT_KERN_LEVEL",
				     "printk() should include KERN_ facility level\n" . $herecurr);
2918
			}
2919 2920
		}

2921 2922 2923 2924
		if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
			my $orig = $1;
			my $level = lc($orig);
			$level = "warn" if ($level eq "warning");
2925 2926
			my $level2 = $level;
			$level2 = "dbg" if ($level eq "debug");
2927
			WARN("PREFER_PR_LEVEL",
2928
			     "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(...  to printk(KERN_$orig ...\n" . $herecurr);
2929 2930 2931
		}

		if ($line =~ /\bpr_warning\s*\(/) {
2932 2933 2934 2935 2936 2937
			if (WARN("PREFER_PR_LEVEL",
				 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/\bpr_warning\b/pr_warn/;
			}
2938 2939
		}

2940 2941 2942 2943 2944 2945 2946 2947 2948
		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);
		}

2949 2950
# function brace can't be on same line, except for #defines of do while,
# or if closed on same line
2951 2952
		if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
		    !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
2953 2954
			ERROR("OPEN_BRACE",
			      "open brace '{' following function declarations go on the next line\n" . $herecurr);
2955
		}
2956

2957 2958 2959
# 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*$/) {
2960 2961
			ERROR("OPEN_BRACE",
			      "open brace '{' following $1 go on the same line\n" . $hereprev);
2962 2963
		}

2964
# missing space after union, struct or enum definition
2965 2966 2967 2968 2969 2970 2971
		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/;
			}
2972 2973
		}

2974 2975 2976
# Function pointer declarations
# check spacing between type, funcptr, and args
# canonical declaration is "type (*funcptr)(args...)"
2977
		if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
2978 2979 2980 2981 2982 2983 2984
			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;

2985 2986 2987 2988 2989 2990 2991 2992 2993
# the $Declare variable will capture all spaces after the type
# so check it for a missing trailing missing space but pointer return types
# don't need a space so don't warn for those.
			my $post_declare_space = "";
			if ($declare =~ /(\s+)$/) {
				$post_declare_space = $1;
				$declare = rtrim($declare);
			}
			if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
2994 2995
				WARN("SPACING",
				     "missing space after return type\n" . $herecurr);
2996
				$post_declare_space = " ";
2997 2998 2999
			}

# unnecessary space "type  (*funcptr)(args...)"
3000 3001 3002 3003 3004 3005 3006 3007 3008
# This test is not currently implemented because these declarations are
# equivalent to
#	int  foo(int bar, ...)
# and this is form shouldn't/doesn't generate a checkpatch warning.
#
#			elsif ($declare =~ /\s{2,}$/) {
#				WARN("SPACING",
#				     "Multiple spaces after return type\n" . $herecurr);
#			}
3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039

# 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] =~
3040
				    s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3041 3042 3043
			}
		}

3044 3045
# check for spacing round square brackets; allowed:
#  1. with a type on the left -- int [] a;
3046 3047
#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
#  3. inside a curly brace -- = { [0...10] = 5 }
3048 3049 3050
		while ($line =~ /(.*?\s)\[/g) {
			my ($where, $prefix) = ($-[1], $1);
			if ($prefix !~ /$Type\s+$/ &&
3051
			    ($where != 0 || $prefix !~ /^.\s+$/) &&
3052
			    $prefix !~ /[{,]\s+$/) {
3053 3054 3055 3056 3057 3058
				if (ERROR("BRACKET_SPACE",
					  "space prohibited before open square bracket '['\n" . $herecurr) &&
				    $fix) {
				    $fixed[$linenr - 1] =~
					s/^(\+.*?)\s+\[/$1\[/;
				}
3059 3060 3061
			}
		}

3062
# check for spaces between functions and their parentheses.
3063
		while ($line =~ /($Ident)\s+\(/g) {
3064
			my $name = $1;
3065 3066
			my $ctx_before = substr($line, 0, $-[1]);
			my $ctx = "$ctx_before$name";
3067 3068

			# Ignore those directives where spaces _are_ permitted.
3069 3070 3071 3072 3073 3074
			if ($name =~ /^(?:
				if|for|while|switch|return|case|
				volatile|__volatile__|
				__attribute__|format|__extension__|
				asm|__asm__)$/x)
			{
3075 3076 3077
			# 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.
3078
			} elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
3079 3080

			# cpp #elif statement condition may start with a (
3081
			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
3082 3083 3084

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

			} else {
3088 3089 3090 3091 3092 3093
				if (WARN("SPACING",
					 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
					     $fix) {
					$fixed[$linenr - 1] =~
					    s/\b$name\s+\(/$name\(/;
				}
3094
			}
3095
		}
3096

3097
# Check operator spacing.
3098
		if (!($line=~/\#\s*include/)) {
3099 3100 3101
			my $fixed_line = "";
			my $line_fixed = 0;

3102 3103 3104 3105
			my $ops = qr{
				<<=|>>=|<=|>=|==|!=|
				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
				=>|->|<<|>>|<|>|=|!|~|
3106
				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
3107
				\?:|\?|:
3108
			}x;
3109
			my @elements = split(/($ops|;)/, $opline);
3110 3111 3112 3113 3114 3115 3116

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

			my @fix_elements = ();
3117
			my $off = 0;
3118

3119 3120 3121 3122 3123 3124 3125
			foreach my $el (@elements) {
				push(@fix_elements, substr($rawline, $off, length($el)));
				$off += length($el);
			}

			$off = 0;

3126
			my $blank = copy_spacing($opline);
3127
			my $last_after = -1;
3128

3129
			for (my $n = 0; $n < $#elements; $n += 2) {
3130 3131 3132 3133 3134

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

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

3135 3136
				$off += length($elements[$n]);

L
Lucas De Marchi 已提交
3137
				# Pick up the preceding and succeeding characters.
3138 3139 3140 3141 3142 3143 3144
				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";

3145 3146 3147
				my $a = '';
				$a = 'V' if ($elements[$n] ne '');
				$a = 'W' if ($elements[$n] =~ /\s$/);
3148
				$a = 'C' if ($elements[$n] =~ /$;$/);
3149 3150
				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
				$a = 'O' if ($elements[$n] eq '');
3151
				$a = 'E' if ($ca =~ /^\s*$/);
3152

3153
				my $op = $elements[$n + 1];
3154 3155

				my $c = '';
3156
				if (defined $elements[$n + 2]) {
3157 3158
					$c = 'V' if ($elements[$n + 2] ne '');
					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
3159
					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
3160 3161
					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
					$c = 'O' if ($elements[$n + 2] eq '');
3162
					$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
3163 3164
				} else {
					$c = 'E';
3165 3166
				}

3167 3168 3169 3170
				my $ctx = "${a}x${c}";

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

3171
				my $ptr = substr($blank, 0, $off) . "^";
3172
				my $hereptr = "$hereline$ptr\n";
3173

3174
				# Pull out the value of this operator.
3175
				my $op_type = substr($curr_values, $off + 1, 1);
3176

3177 3178 3179
				# Get the full operator variant.
				my $opv = $op . substr($curr_vars, $off, 1);

3180 3181 3182 3183
				# Ignore operators passed as parameters.
				if ($op_type ne 'V' &&
				    $ca =~ /\s$/ && $cc =~ /^\s*,/) {

3184 3185
#				# Ignore comments
#				} elsif ($op =~ /^$;+$/) {
3186

3187
				# ; should have either the end of line or a space or \ after it
3188
				} elsif ($op eq ';') {
3189 3190
					if ($ctx !~ /.x[WEBC]/ &&
					    $cc !~ /^\\/ && $cc !~ /^;/) {
3191 3192
						if (ERROR("SPACING",
							  "space required after that '$op' $at\n" . $hereptr)) {
3193
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3194 3195
							$line_fixed = 1;
						}
3196 3197 3198 3199
					}

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

3201 3202 3203 3204
				#   :   when part of a bitfield
				} elsif ($opv eq ':B') {
					# skip the bitfield test for now

3205 3206
				# No spaces for:
				#   ->
3207
				} elsif ($op eq '->') {
3208
					if ($ctx =~ /Wx.|.xW/) {
3209 3210
						if (ERROR("SPACING",
							  "spaces prohibited around that '$op' $at\n" . $hereptr)) {
3211
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3212 3213 3214
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3215
							$line_fixed = 1;
3216
						}
3217 3218 3219 3220
					}

				# , must have a space on the right.
				} elsif ($op eq ',') {
3221
					if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
3222 3223
						if (ERROR("SPACING",
							  "space required after that '$op' $at\n" . $hereptr)) {
3224
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3225
							$line_fixed = 1;
3226
							$last_after = $n;
3227
						}
3228 3229
					}

3230
				# '*' as part of a type definition -- reported already.
3231
				} elsif ($opv eq '*_') {
3232 3233 3234 3235 3236 3237
					#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 '~' ||
3238
					 $opv eq '*U' || $opv eq '-U' ||
3239
					 $opv eq '&U' || $opv eq '&&U') {
3240
					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
3241 3242
						if (ERROR("SPACING",
							  "space required before that '$op' $at\n" . $hereptr)) {
3243 3244 3245 3246
							if ($n != $last_after + 2) {
								$good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
								$line_fixed = 1;
							}
3247
						}
3248
					}
3249
					if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
3250 3251 3252
						# A unary '*' may be const

					} elsif ($ctx =~ /.xW/) {
3253 3254
						if (ERROR("SPACING",
							  "space prohibited after that '$op' $at\n" . $hereptr)) {
3255
							$good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
3256 3257 3258
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3259
							$line_fixed = 1;
3260
						}
3261 3262 3263 3264
					}

				# unary ++ and unary -- are allowed no space on one side.
				} elsif ($op eq '++' or $op eq '--') {
3265
					if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
3266 3267
						if (ERROR("SPACING",
							  "space required one side of that '$op' $at\n" . $hereptr)) {
3268
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3269 3270
							$line_fixed = 1;
						}
3271 3272 3273
					}
					if ($ctx =~ /Wx[BE]/ ||
					    ($ctx =~ /Wx./ && $cc =~ /^;/)) {
3274 3275
						if (ERROR("SPACING",
							  "space prohibited before that '$op' $at\n" . $hereptr)) {
3276
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3277 3278
							$line_fixed = 1;
						}
3279
					}
3280
					if ($ctx =~ /ExW/) {
3281 3282
						if (ERROR("SPACING",
							  "space prohibited after that '$op' $at\n" . $hereptr)) {
3283
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3284 3285 3286
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3287
							$line_fixed = 1;
3288
						}
3289
					}
3290 3291

				# << and >> may either have or not have spaces both sides
3292 3293 3294
				} elsif ($op eq '<<' or $op eq '>>' or
					 $op eq '&' or $op eq '^' or $op eq '|' or
					 $op eq '+' or $op eq '-' or
3295 3296
					 $op eq '*' or $op eq '/' or
					 $op eq '%')
3297
				{
3298
					if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
3299 3300
						if (ERROR("SPACING",
							  "need consistent spacing around '$op' $at\n" . $hereptr)) {
3301 3302 3303 3304
							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3305 3306
							$line_fixed = 1;
						}
3307 3308
					}

3309 3310 3311 3312
				# 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./) {
3313 3314
						if (ERROR("SPACING",
							  "space prohibited before that '$op' $at\n" . $hereptr)) {
3315
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3316 3317
							$line_fixed = 1;
						}
3318 3319
					}

3320
				# All the others need spaces both sides.
3321
				} elsif ($ctx !~ /[EWC]x[CWE]/) {
3322 3323
					my $ok = 0;

3324
					# Ignore email addresses <foo@bar>
3325 3326 3327 3328 3329 3330 3331 3332
					if (($op eq '<' &&
					     $cc =~ /^\S+\@\S+>/) ||
					    ($op eq '>' &&
					     $ca =~ /<\S+\@\S+$/))
					{
					    	$ok = 1;
					}

3333
					# messages are ERROR, but ?: are CHK
3334
					if ($ok == 0) {
3335 3336 3337 3338 3339
						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)) {
3340 3341 3342 3343
							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3344 3345
							$line_fixed = 1;
						}
3346
					}
3347
				}
3348
				$off += length($elements[$n + 1]);
3349 3350 3351 3352 3353 3354 3355 3356

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

				$fixed_line = $fixed_line . $good;
			}

			if (($#elements % 2) == 0) {
				$fixed_line = $fixed_line . $fix_elements[$#elements];
3357
			}
3358 3359 3360 3361 3362 3363

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


3364 3365
		}

3366
# check for whitespace before a non-naked semicolon
3367
		if ($line =~ /^\+.*\S\s+;\s*$/) {
3368 3369 3370 3371 3372 3373 3374 3375
			if (WARN("SPACING",
				 "space prohibited before semicolon\n" . $herecurr) &&
			    $fix) {
				1 while $fixed[$linenr - 1] =~
				    s/^(\+.*\S)\s+;/$1;/;
			}
		}

3376 3377
# check for multiple assignments
		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
3378 3379
			CHK("MULTIPLE_ASSIGNMENTS",
			    "multiple assignments should be avoided\n" . $herecurr);
3380 3381
		}

3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392
## # 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 =~ /,/) {
3393 3394
## 				WARN("MULTIPLE_DECLARATION",
##				     "declaring multiple variables together should be avoided\n" . $herecurr);
3395 3396
## 			}
## 		}
3397

3398
#need space before brace following if, while, etc
3399 3400
		if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
		    $line =~ /do{/) {
3401 3402 3403
			if (ERROR("SPACING",
				  "space required before the open brace '{'\n" . $herecurr) &&
			    $fix) {
3404
				$fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/;
3405
			}
3406 3407
		}

3408 3409 3410 3411 3412 3413 3414 3415
## # check for blank lines before declarations
##		if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
##		    $prevrawline =~ /^.\s*$/) {
##			WARN("SPACING",
##			     "No blank lines before declarations\n" . $hereprev);
##		}
##

3416 3417 3418
# closing brace should have a space following it when it has anything
# on the line
		if ($line =~ /}(?!(?:,|;|\)))\S/) {
3419 3420 3421 3422 3423 3424
			if (ERROR("SPACING",
				  "space required after that close brace '}'\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/}((?!(?:,|;|\)))\S)/} $1/;
			}
3425 3426
		}

3427 3428
# check spacing on square brackets
		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
3429 3430 3431 3432 3433 3434
			if (ERROR("SPACING",
				  "space prohibited after that open square bracket '['\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/\[\s+/\[/;
			}
3435 3436
		}
		if ($line =~ /\s\]/) {
3437 3438 3439 3440 3441 3442
			if (ERROR("SPACING",
				  "space prohibited before that close square bracket ']'\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/\s+\]/\]/;
			}
3443 3444
		}

3445
# check spacing on parentheses
3446 3447
		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
		    $line !~ /for\s*\(\s+;/) {
3448 3449 3450 3451 3452 3453
			if (ERROR("SPACING",
				  "space prohibited after that open parenthesis '('\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/\(\s+/\(/;
			}
3454
		}
3455
		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
3456 3457
		    $line !~ /for\s*\(.*;\s+\)/ &&
		    $line !~ /:\s+\)/) {
3458 3459 3460 3461 3462 3463
			if (ERROR("SPACING",
				  "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/\s+\)/\)/;
			}
3464 3465
		}

3466
#goto labels aren't indented, allow a single space however
3467
		if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
3468
		   !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
3469 3470 3471 3472 3473 3474
			if (WARN("INDENTED_LABEL",
				 "labels should not be indented\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~
				    s/^(.)\s+/$1/;
			}
3475 3476
		}

3477
# return is not a function
3478
		if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
3479
			my $spacing = $1;
3480
			if ($^V && $^V ge 5.10.0 &&
3481 3482 3483 3484 3485 3486 3487
			    $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
				my $value = $1;
				$value = deparenthesize($value);
				if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
					ERROR("RETURN_PARENTHESES",
					      "return is not a function, parentheses are not required\n" . $herecurr);
				}
3488
			} elsif ($spacing !~ /\s+/) {
3489 3490
				ERROR("SPACING",
				      "space required before the open parenthesis '('\n" . $herecurr);
3491 3492
			}
		}
3493

3494 3495 3496 3497 3498 3499 3500 3501
# unnecessary return in a void function
# at end-of-function, with the previous line a single leading tab, then return;
# and the line before that not a goto label target like "out:"
		if ($sline =~ /^[ \+]}\s*$/ &&
		    $prevline =~ /^\+\treturn\s*;\s*$/ &&
		    $linenr >= 3 &&
		    $lines[$linenr - 3] =~ /^[ +]/ &&
		    $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
3502
			WARN("RETURN_VOID",
3503 3504
			     "void function return statements are not generally useful\n" . $hereprev);
               }
3505

3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519
# 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);
			}
		}

3520 3521 3522 3523
# 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') {
3524 3525
				WARN("USE_NEGATIVE_ERRNO",
				     "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
3526 3527
			}
		}
3528

3529
# Need a space before open parenthesis after if, while etc
3530 3531 3532 3533 3534 3535 3536
		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 \(/;
			}
3537 3538
		}

3539 3540
# Check for illegal assignment in if conditional -- and check for trailing
# statements after the conditional.
3541
		if ($line =~ /do\s*(?!{)/) {
3542 3543 3544
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562
			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} &&
3563
		    defined($stat) && defined($cond) &&
3564
		    $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
3565
			my ($s, $c) = ($stat, $cond);
3566

3567
			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
3568 3569
				ERROR("ASSIGN_IN_IF",
				      "do not use assignment in if condition\n" . $herecurr);
3570 3571 3572 3573
			}

			# Find out what is on the end of the line after the
			# conditional.
3574
			substr($s, 0, length($c), '');
3575
			$s =~ s/\n.*//g;
3576
			$s =~ s/$;//g; 	# Remove any comments
3577 3578
			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
			    $c !~ /}\s*while\s*/)
3579
			{
3580 3581 3582
				# Find out how long the conditional actually is.
				my @newlines = ($c =~ /\n/gs);
				my $cond_lines = 1 + $#newlines;
3583
				my $stat_real = '';
3584

3585 3586
				$stat_real = raw_line($linenr, $cond_lines)
							. "\n" if ($cond_lines);
3587 3588 3589 3590
				if (defined($stat_real) && $cond_lines > 1) {
					$stat_real = "[...]\n$stat_real";
				}

3591 3592
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr . $stat_real);
3593 3594 3595
			}
		}

3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607
# Check for bitwise tests written as boolean
		if ($line =~ /
			(?:
				(?:\[|\(|\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\|)
			|
				(?:\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\||\)|\])
			)/x)
		{
3608 3609
			WARN("HEXADECIMAL_BOOLEAN_TEST",
			     "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
3610 3611
		}

3612
# if and else should not have general statements after it
3613 3614 3615 3616
		if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
			my $s = $1;
			$s =~ s/$;//g; 	# Remove any comments
			if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
3617 3618
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr);
3619
			}
3620
		}
3621 3622
# if should not continue a brace
		if ($line =~ /}\s*if\b/) {
3623
			ERROR("TRAILING_STATEMENTS",
3624
			      "trailing statements should be on next line (or did you mean 'else if'?)\n" .
3625 3626
				$herecurr);
		}
3627 3628 3629
# case and default should not have general statements after them
		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
		    $line !~ /\G(?:
3630
			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
3631 3632 3633
			\s*return\s+
		    )/xg)
		{
3634 3635
			ERROR("TRAILING_STATEMENTS",
			      "trailing statements should be on next line\n" . $herecurr);
3636
		}
3637 3638 3639 3640 3641

		# 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) {
3642 3643
			ERROR("ELSE_AFTER_BRACE",
			      "else should follow close brace '}'\n" . $hereprev);
3644 3645
		}

3646 3647 3648 3649 3650 3651
		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.
3652
			substr($s, 0, length($c), '');
3653 3654 3655
			$s =~ s/\n.*//g;

			if ($s =~ /^\s*;/) {
3656 3657
				ERROR("WHILE_AFTER_BRACE",
				      "while should follow close brace '}'\n" . $hereprev);
3658 3659 3660
			}
		}

3661
#Specific variable tests
3662 3663
		while ($line =~ m{($Constant|$Lval)}g) {
			my $var = $1;
3664 3665 3666

#gcc binary extension
			if ($var =~ /^$Binary$/) {
3667 3668 3669 3670 3671 3672 3673
				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/;
				}
3674 3675 3676
			}

#CamelCase
3677
			if ($var !~ /^$Constant$/ &&
3678
			    $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
3679
#Ignore Page<foo> variants
3680
			    $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
3681
#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
3682
			    $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
3683 3684 3685
				while ($var =~ m{($Ident)}g) {
					my $word = $1;
					next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
3686 3687 3688 3689 3690 3691 3692
					if ($check) {
						seed_camelcase_includes();
						if (!$file && !$camelcase_file_seeded) {
							seed_camelcase_file($realfile);
							$camelcase_file_seeded = 1;
						}
					}
3693 3694 3695 3696 3697
					if (!defined $camelcase{$word}) {
						$camelcase{$word} = 1;
						CHK("CAMELCASE",
						    "Avoid CamelCase: <$word>\n" . $herecurr);
					}
3698
				}
3699 3700
			}
		}
3701 3702

#no spaces allowed after \ in define
3703 3704 3705 3706 3707 3708
		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+$//;
			}
3709 3710
		}

3711
#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
3712
		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
3713 3714 3715 3716
			my $file = "$1.h";
			my $checkfile = "include/linux/$file";
			if (-f "$root/$checkfile" &&
			    $realfile ne $checkfile &&
3717
			    $1 !~ /$allowed_asm_includes/)
3718
			{
3719
				if ($realfile =~ m{^arch/}) {
3720 3721
					CHK("ARCH_INCLUDE_LINUX",
					    "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
3722
				} else {
3723 3724
					WARN("INCLUDE_LINUX",
					     "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
3725
				}
3726 3727 3728
			}
		}

3729 3730
# 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
3731
# in a known good container
3732 3733
		if ($realfile !~ m@/vmlinux.lds.h$@ &&
		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
3734 3735
			my $ln = $linenr;
			my $cnt = $realcnt;
3736 3737 3738
			my ($off, $dstat, $dcond, $rest);
			my $ctx = '';
			($dstat, $dcond, $ln, $cnt, $off) =
3739 3740
				ctx_statement_block($linenr, $realcnt, 0);
			$ctx = $dstat;
3741
			#print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
3742
			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
3743

3744
			$dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
3745
			$dstat =~ s/$;//g;
3746 3747 3748
			$dstat =~ s/\\\n.//g;
			$dstat =~ s/^\s*//s;
			$dstat =~ s/\s*$//s;
3749

3750
			# Flatten any parentheses and braces
3751 3752
			while ($dstat =~ s/\([^\(\)]*\)/1/ ||
			       $dstat =~ s/\{[^\{\}]*\}/1/ ||
3753
			       $dstat =~ s/\[[^\[\]]*\]/1/)
3754
			{
3755
			}
3756

3757 3758 3759 3760 3761 3762
			# Flatten any obvious string concatentation.
			while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
			       $dstat =~ s/$Ident\s*("X*")/$1/)
			{
			}

3763 3764 3765
			my $exceptions = qr{
				$Declare|
				module_param_named|
3766
				MODULE_PARM_DESC|
3767 3768
				DECLARE_PER_CPU|
				DEFINE_PER_CPU|
3769
				__typeof__\(|
3770 3771
				union|
				struct|
3772 3773
				\.$Ident\s*=\s*|
				^\"|\"$
3774
			}x;
3775
			#print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
3776 3777 3778
			if ($dstat ne '' &&
			    $dstat !~ /^(?:$Ident|-?$Constant),$/ &&			# 10, // foo(),
			    $dstat !~ /^(?:$Ident|-?$Constant);$/ &&			# foo();
3779
			    $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ &&		# 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
3780
			    $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ &&			# character constants
3781 3782
			    $dstat !~ /$exceptions/ &&
			    $dstat !~ /^\.$Ident\s*=/ &&				# .foo =
3783
			    $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ &&		# stringification #foo
3784
			    $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ &&	# do {...} while (...); // do {...} while (...)
3785 3786 3787
			    $dstat !~ /^for\s*$Constant$/ &&				# for (...)
			    $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ &&	# for (...) bar()
			    $dstat !~ /^do\s*{/ &&					# do {...
3788 3789
			    $dstat !~ /^\({/ &&						# ({...
			    $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
3790 3791 3792 3793 3794 3795 3796
			{
				$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";
3797 3798
				}

3799 3800 3801 3802
				if ($dstat =~ /;/) {
					ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
					      "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
				} else {
3803
					ERROR("COMPLEX_MACRO",
3804
					      "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
3805
				}
3806
			}
3807

3808
# check for line continuations outside of #defines, preprocessor #, and asm
3809 3810 3811

		} else {
			if ($prevline !~ /^..*\\$/ &&
3812 3813
			    $line !~ /^\+\s*\#.*\\$/ &&		# preprocessor
			    $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ &&	# asm
3814 3815 3816 3817
			    $line =~ /^\+.*\\$/) {
				WARN("LINE_CONTINUATIONS",
				     "Avoid unnecessary line continuations\n" . $herecurr);
			}
3818 3819
		}

3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847
# 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";
				}

3848 3849
				if (($stmts =~ tr/;/;/) == 1 &&
				    $stmts !~ /^\s*(if|while|for|switch)\b/) {
3850 3851 3852 3853 3854 3855 3856
					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");
				}
3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867
			} elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
				$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";
				}

				WARN("TRAILING_SEMICOLON",
				     "macros should not use a trailing semicolon\n" . "$herectx");
3868 3869 3870
			}
		}

3871 3872 3873 3874 3875 3876
# 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|$))/) {
3877 3878
			WARN("MISSING_VMLINUX_SYMBOL",
			     "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
3879 3880
		}

3881
# check for redundant bracing round if etc
3882 3883
		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
			my ($level, $endln, @chunks) =
3884
				ctx_statement_full($linenr, $realcnt, 1);
3885
			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
3886 3887
			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
			if ($#chunks > 0 && $level == 0) {
3888 3889
				my @allowed = ();
				my $allow = 0;
3890
				my $seen = 0;
3891
				my $herectx = $here . "\n";
3892
				my $ln = $linenr - 1;
3893 3894 3895
				for my $chunk (@chunks) {
					my ($cond, $block) = @{$chunk};

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

3900
					$allowed[$allow] = 0;
3901 3902 3903 3904 3905 3906
					#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";
3907 3908
					$ln += statement_rawlines($block) - 1;

3909
					substr($block, 0, length($cond), '');
3910 3911 3912

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

3913
					#print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
3914 3915
					if (statement_lines($cond) > 1) {
						#print "APW: ALLOWED: cond<$cond>\n";
3916
						$allowed[$allow] = 1;
3917 3918
					}
					if ($block =~/\b(?:if|for|while)\b/) {
3919
						#print "APW: ALLOWED: block<$block>\n";
3920
						$allowed[$allow] = 1;
3921
					}
3922 3923
					if (statement_block_size($block) > 1) {
						#print "APW: ALLOWED: lines block<$block>\n";
3924
						$allowed[$allow] = 1;
3925
					}
3926
					$allow++;
3927
				}
3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940
				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);
					}
3941 3942 3943
				}
			}
		}
3944
		if (!defined $suppress_ifbraces{$linenr - 1} &&
3945
					$line =~ /\b(if|while|for|else)\b/) {
3946 3947 3948 3949 3950 3951 3952
			my $allowed = 0;

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

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

3957 3958
			# Check the condition.
			my ($cond, $block) = @{$chunks[0]};
3959
			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
3960
			if (defined $cond) {
3961
				substr($block, 0, length($cond), '');
3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978
			}
			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) {
3979
					substr($block, 0, length($cond), '');
3980 3981 3982 3983 3984 3985 3986
				}
				if ($block =~ /^\s*\{/) {
					#print "APW: ALLOWED: chunk-1 block<$block>\n";
					$allowed = 1;
				}
			}
			if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
3987
				my $herectx = $here . "\n";
3988
				my $cnt = statement_rawlines($block);
3989

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

3994 3995
				WARN("BRACES",
				     "braces {} are not necessary for single statement blocks\n" . $herectx);
3996 3997 3998
			}
		}

3999
# check for unnecessary blank lines around braces
4000
		if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
4001 4002 4003
			CHK("BRACES",
			    "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
		}
4004
		if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
4005 4006 4007 4008
			CHK("BRACES",
			    "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
		}

4009
# no volatiles please
4010 4011
		my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
		if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
4012 4013
			WARN("VOLATILE",
			     "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4014 4015
		}

4016
# warn about #if 0
4017
		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
4018 4019
			CHK("REDUNDANT_CODE",
			    "if this code is redundant consider removing it\n" .
4020
				$herecurr);
4021 4022
		}

4023 4024 4025 4026 4027 4028
# 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);
4029 4030
			}
		}
4031

4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048
# check for unnecessary "Out of Memory" messages
		if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
		    $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
		    (defined $1 || defined $3) &&
		    $linenr > 3) {
			my $testval = $2;
			my $testline = $lines[$linenr - 3];

			my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
#			print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");

			if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
				WARN("OOM_MESSAGE",
				     "Possible unnecessary 'out of memory' message\n" . $hereprev);
			}
		}

4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066
# 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;
				}
			}
		}

4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095
# 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/;
			}
		}

4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108
# don't use __constant_<foo> functions outside of include/uapi/
		if ($realfile !~ m@^include/uapi/@ &&
		    $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
			my $constant_func = $1;
			my $func = $constant_func;
			$func =~ s/^__constant_//;
			if (WARN("CONSTANT_CONVERSION",
				 "$constant_func should be $func\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/\b$constant_func\b/$func/g;
			}
		}

4109
# prefer usleep_range over udelay
B
Bruce Allan 已提交
4110
		if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
4111
			my $delay = $1;
4112
			# ignore udelay's < 10, however
4113
			if (! ($delay < 10) ) {
4114
				CHK("USLEEP_RANGE",
4115 4116 4117 4118 4119
				    "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
			}
			if ($delay > 2000) {
				WARN("LONG_UDELAY",
				     "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
4120 4121 4122
			}
		}

4123 4124 4125
# warn about unexpectedly long msleep's
		if ($line =~ /\bmsleep\s*\((\d+)\);/) {
			if ($1 < 20) {
4126
				WARN("MSLEEP",
4127
				     "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4128 4129 4130
			}
		}

4131 4132 4133 4134 4135 4136
# 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);
		}

4137 4138 4139 4140 4141 4142
# 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);
		}

4143
# warn about #ifdefs in C files
4144
#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
4145 4146 4147 4148 4149
#			print "#ifdef in C files should be avoided\n";
#			print "$herecurr";
#			$clean = 0;
#		}

4150
# warn about spacing in #ifdefs
4151
		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
4152 4153 4154 4155 4156 4157 4158
			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 /;
			}

4159 4160
		}

4161
# check for spinlock_t definitions without a comment.
4162 4163
		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
4164 4165
			my $which = $1;
			if (!ctx_has_comment($first_line, $linenr)) {
4166 4167
				CHK("UNCOMMENTED_DEFINITION",
				    "$1 definition without comment\n" . $herecurr);
4168 4169 4170 4171 4172
			}
		}
# 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)) {
4173 4174
				WARN("MEMORY_BARRIER",
				     "memory barrier without comment\n" . $herecurr);
4175 4176 4177
			}
		}
# check of hardware specific defines
4178
		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
4179 4180
			CHK("ARCH_DEFINES",
			    "architecture specific defines should be avoided\n" .  $herecurr);
4181
		}
4182

4183 4184
# Check that the storage class is at the beginning of a declaration
		if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
4185 4186
			WARN("STORAGE_CLASS",
			     "storage class should be at the beginning of the declaration\n" . $herecurr)
4187 4188
		}

4189 4190
# check the location of the inline attribute, that it is between
# storage class and type.
4191 4192
		if ($line =~ /\b$Type\s+$Inline\b/ ||
		    $line =~ /\b$Inline\s+$Storage\b/) {
4193 4194
			ERROR("INLINE_LOCATION",
			      "inline keyword should sit between storage class and type\n" . $herecurr);
4195 4196
		}

4197
# Check for __inline__ and __inline, prefer inline
4198 4199
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b(__inline__|__inline)\b/) {
4200 4201 4202 4203 4204 4205
			if (WARN("INLINE",
				 "plain inline is preferred over $1\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/;

			}
4206 4207
		}

4208
# Check for __attribute__ packed, prefer __packed
4209 4210
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
4211 4212
			WARN("PREFER_PACKED",
			     "__packed is preferred over __attribute__((packed))\n" . $herecurr);
4213 4214
		}

4215
# Check for __attribute__ aligned, prefer __aligned
4216 4217
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
4218 4219
			WARN("PREFER_ALIGNED",
			     "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
4220 4221
		}

4222
# Check for __attribute__ format(printf, prefer __printf
4223 4224
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
4225 4226 4227 4228 4229 4230
			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;

			}
4231 4232
		}

4233
# Check for __attribute__ format(scanf, prefer __scanf
4234 4235
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
4236 4237 4238 4239 4240
			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;
			}
4241 4242
		}

4243 4244
# check for sizeof(&)
		if ($line =~ /\bsizeof\s*\(\s*\&/) {
4245 4246
			WARN("SIZEOF_ADDRESS",
			     "sizeof(& should be avoided\n" . $herecurr);
4247 4248
		}

4249 4250
# check for sizeof without parenthesis
		if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
4251 4252 4253 4254 4255
			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;
			}
4256 4257
		}

4258 4259
# check for line continuations in quoted strings with odd counts of "
		if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
4260 4261
			WARN("LINE_CONTINUATIONS",
			     "Avoid line continuations in quoted strings\n" . $herecurr);
4262 4263
		}

4264 4265 4266 4267 4268 4269
# 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);
		}

4270
# check for seq_printf uses that could be seq_puts
J
Joe Perches 已提交
4271
		if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
4272
			my $fmt = get_quoted_string($line, $rawline);
J
Joe Perches 已提交
4273
			if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
4274 4275 4276 4277 4278
				if (WARN("PREFER_SEQ_PUTS",
					 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
				    $fix) {
					$fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/;
				}
4279 4280 4281
			}
		}

4282
# Check for misused memsets
4283 4284
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
4285 4286 4287
		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {

			my $ms_addr = $2;
4288 4289
			my $ms_val = $7;
			my $ms_size = $12;
4290 4291 4292

			if ($ms_size =~ /^(0x|)0$/i) {
				ERROR("MEMSET",
4293
				      "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
4294 4295
			} elsif ($ms_size =~ /^(0x|)1$/i) {
				WARN("MEMSET",
4296 4297 4298 4299
				     "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
			}
		}

4300 4301 4302 4303 4304 4305 4306 4307 4308 4309
# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
		if ($^V && $^V ge 5.10.0 &&
		    $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
			if (WARN("PREFER_ETHER_ADDR_COPY",
				 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
			}
		}

4310
# typecasts on min/max could be min_t/max_t
4311 4312
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
4313
		    $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
4314
			if (defined $2 || defined $7) {
4315 4316 4317
				my $call = $1;
				my $cast1 = deparenthesize($2);
				my $arg1 = $3;
4318 4319
				my $cast2 = deparenthesize($7);
				my $arg2 = $8;
4320 4321
				my $cast;

4322
				if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
4323 4324 4325 4326 4327 4328 4329 4330
					$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");
4331 4332 4333
			}
		}

4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349
# 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");
			}
		}

4350 4351 4352
# check for naked sscanf
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
4353
		    $line =~ /\bsscanf\b/ &&
4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366
		    ($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");
		}

4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387
# check for simple sscanf that should be kstrto<foo>
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
		    $line =~ /\bsscanf\b/) {
			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);
			}
			if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
				my $format = $6;
				my $count = $format =~ tr@%@%@;
				if ($count == 1 &&
				    $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
					WARN("SSCANF_TO_KSTRTO",
					     "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
				}
			}
		}

4388 4389 4390
# check for new externs in .h files.
		if ($realfile =~ /\.h$/ &&
		    $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
4391 4392
			if (CHK("AVOID_EXTERNS",
				"extern prototypes should be avoided in .h files\n" . $herecurr) &&
4393 4394 4395 4396 4397
			    $fix) {
				$fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
			}
		}

4398
# check for new externs in .c files.
4399
		if ($realfile =~ /\.c$/ && defined $stat &&
4400
		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
4401
		{
4402 4403
			my $function_name = $1;
			my $paren_space = $2;
4404 4405 4406 4407 4408

			my $s = $stat;
			if (defined $cond) {
				substr($s, 0, length($cond), '');
			}
4409 4410 4411
			if ($s =~ /^\s*;/ &&
			    $function_name ne 'uninitialized_var')
			{
4412 4413
				WARN("AVOID_EXTERNS",
				     "externs should be avoided in .c files\n" .  $herecurr);
4414 4415 4416
			}

			if ($paren_space =~ /\n/) {
4417 4418
				WARN("FUNCTION_ARGUMENTS",
				     "arguments for function declarations should follow identifier\n" . $herecurr);
4419
			}
4420 4421 4422 4423

		} elsif ($realfile =~ /\.c$/ && defined $stat &&
		    $stat =~ /^.\s*extern\s+/)
		{
4424 4425
			WARN("AVOID_EXTERNS",
			     "externs should be avoided in .c files\n" .  $herecurr);
4426 4427 4428 4429 4430 4431 4432
		}

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

			if (!grep(/$name/, @setup_docs)) {
4433 4434
				CHK("UNDOCUMENTED_SETUP",
				    "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
4435
			}
4436
		}
4437 4438

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

4444 4445 4446 4447 4448 4449 4450 4451
# 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);
		}

4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475
# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
		if ($^V && $^V ge 5.10.0 &&
		    $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/) {
			my $oldfunc = $3;
			my $a1 = $4;
			my $a2 = $10;
			my $newfunc = "kmalloc_array";
			$newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
			if ($a1 =~ /^sizeof\s*\S/ || $a2 =~ /^sizeof\s*\S/) {
				if (WARN("ALLOC_WITH_MULTIPLY",
					 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
				    $fix) {
					my $r1 = $a1;
					my $r2 = $a2;
					if ($a1 =~ /^sizeof\s*\S/) {
						$r1 = $a2;
						$r2 = $a1;
					}
					$fixed[$linenr - 1] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e;

				}
			}
		}

4476 4477 4478 4479 4480 4481 4482
# 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);
		}

4483 4484 4485 4486 4487 4488
# 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);
		}

4489 4490
# check for multiple semicolons
		if ($line =~ /;\s*;\s*$/) {
4491 4492 4493 4494 4495
			if (WARN("ONE_SEMICOLON",
				 "Statements terminations use 1 semicolon\n" . $herecurr) &&
			    $fix) {
				$fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g;
			}
4496 4497
		}

4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522
# 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);
			}
		}

4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534
# 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);
4535 4536
		}

4537
# check for gcc specific __FUNCTION__
4538 4539 4540 4541 4542 4543
		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;
			}
4544
		}
4545

J
Joe Perches 已提交
4546 4547 4548 4549 4550 4551
# 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);
		}

4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578
# 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);

			}
		}

4579 4580
# check for semaphores initialized locked
		if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
4581 4582
			WARN("CONSIDER_COMPLETION",
			     "consider using a completion\n" . $herecurr);
4583
		}
4584

4585 4586
# recommend kstrto* over simple_strto* and strict_strto*
		if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
4587
			WARN("CONSIDER_KSTRTO",
4588
			     "$1 is obsolete, use k$3 instead\n" . $herecurr);
4589
		}
4590

4591
# check for __initcall(), use device_initcall() explicitly or more appropriate function please
4592
		if ($line =~ /^.\s*__initcall\s*\(/) {
4593
			WARN("USE_DEVICE_INITCALL",
4594
			     "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
4595
		}
4596

4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634
# 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;
4635
		if ($line !~ /\bconst\b/ &&
4636
		    $line =~ /\bstruct\s+($struct_ops)\b/) {
4637 4638
			WARN("CONST_STRUCT",
			     "struct $1 should normally be const\n" .
4639
				$herecurr);
4640
		}
4641 4642 4643 4644

# 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/ &&
4645 4646
		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
4647 4648 4649
		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
4650
		{
4651 4652
			WARN("NR_CPUS",
			     "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
4653
		}
4654

4655 4656 4657 4658 4659 4660
# 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);
		}

4661 4662 4663 4664
# check for %L{u,d,i} in strings
		my $string;
		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
			$string = substr($rawline, $-[1], $+[1] - $-[1]);
4665
			$string =~ s/%%/__/g;
4666
			if ($string =~ /(?<!%)%L[udi]/) {
4667 4668
				WARN("PRINTF_L",
				     "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
4669 4670 4671
				last;
			}
		}
4672 4673 4674 4675

# whine mightly about in_atomic
		if ($line =~ /\bin_atomic\s*\(/) {
			if ($realfile =~ m@^drivers/@) {
4676 4677
				ERROR("IN_ATOMIC",
				      "do not use in_atomic in drivers\n" . $herecurr);
4678
			} elsif ($realfile !~ m@^kernel/@) {
4679 4680
				WARN("IN_ATOMIC",
				     "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
4681 4682
			}
		}
4683 4684 4685 4686 4687 4688 4689

# 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@) {
4690 4691
				ERROR("LOCKDEP",
				      "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
4692 4693
			}
		}
4694 4695 4696

		if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
		    $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
4697 4698
			WARN("EXPORTED_WORLD_WRITABLE",
			     "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
4699
		}
4700

4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724
# Mode permission misuses where it seems decimal should be octal
# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
		if ($^V && $^V ge 5.10.0 &&
		    $line =~ /$mode_perms_search/) {
			foreach my $entry (@mode_permission_funcs) {
				my $func = $entry->[0];
				my $arg_pos = $entry->[1];

				my $skip_args = "";
				if ($arg_pos > 1) {
					$arg_pos--;
					$skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
				}
				my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
				if ($line =~ /$test/) {
					my $val = $1;
					$val = $6 if ($skip_args ne "");

					if ($val !~ /^0$/ &&
					    (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
					     length($val) ne 4)) {
						ERROR("NON_OCTAL_PERMISSIONS",
						      "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
					}
4725 4726 4727
				}
			}
		}
4728 4729 4730 4731 4732 4733
	}

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

4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748
	# 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) {
4749 4750
		ERROR("NOT_UNIFIED_DIFF",
		      "Does not appear to be a unified-diff format patch\n");
4751 4752
	}
	if ($is_patch && $chk_signoff && $signoff == 0) {
4753 4754
		ERROR("MISSING_SIGN_OFF",
		      "Missing Signed-off-by: line(s)\n");
4755 4756
	}

4757
	print report_dump();
4758 4759
	if ($summary && !($clean == 1 && $quiet == 1)) {
		print "$filename " if ($summary_file);
4760 4761 4762 4763
		print "total: $cnt_error errors, $cnt_warn warnings, " .
			(($check)? "$cnt_chk checks, " : "") .
			"$cnt_lines lines checked\n";
		print "\n" if ($quiet == 0);
4764
	}
4765

4766
	if ($quiet == 0) {
4767 4768 4769 4770 4771 4772

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

4773 4774 4775 4776 4777
		# 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";
4778
			$rpt_cleaners = 0;
4779 4780 4781
		}
	}

4782 4783
	hash_show_words(\%use_type, "Used");
	hash_show_words(\%ignore_type, "Ignored");
4784

4785
	if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
4786 4787
		my $newfile = $filename;
		$newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819
		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
		}
	}

4820
	if ($clean == 1 && $quiet == 0) {
4821
		print "$vname has no obvious style problems and is ready for submission.\n"
4822 4823
	}
	if ($clean == 0 && $quiet == 0) {
4824 4825 4826 4827 4828 4829
		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
4830
	}
4831

4832 4833
	return $clean;
}