checkpatch.pl 187.8 KB
Newer Older
1
#!/usr/bin/env perl
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 warnings;
10
use POSIX;
11 12
use File::Basename;
use Cwd 'abs_path';
13
use Term::ANSIColor qw(:constants);
14 15

my $P = $0;
16
my $D = dirname(abs_path($P));
17

18
my $V = '0.32';
19 20 21 22 23 24 25

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

my $quiet = 0;
my $tree = 1;
my $chk_signoff = 1;
my $chk_patch = 1;
26
my $tst_only;
27
my $emacs = 0;
28
my $terse = 0;
29
my $showfile = 0;
30
my $file = 0;
31
my $git = 0;
32
my %git_commits = ();
33
my $check = 0;
34
my $check_orig = 0;
35 36
my $summary = 1;
my $mailback = 0;
37
my $summary_file = 0;
38
my $show_types = 0;
39
my $list_types = 0;
40
my $fix = 0;
41
my $fix_inplace = 0;
42
my $root;
43
my %debug;
44
my %camelcase = ();
45 46 47
my %use_type = ();
my @use = ();
my %ignore_type = ();
48
my @ignore = ();
49
my $help = 0;
50
my $configuration_file = ".checkpatch.conf";
51
my $max_line_length = 80;
52 53
my $ignore_perl_version = 0;
my $minimum_perl_version = 5.10.0;
54
my $min_conf_desc_length = 4;
55
my $spelling_file = "$D/spelling.txt";
56
my $codespell = 0;
57
my $codespellfile = "/usr/share/codespell/dictionary.txt";
58
my $conststructsfile = "$D/const_structs.checkpatch";
59
my $typedefsfile = "";
60
my $color = "auto";
61
my $allow_c99_comments = 1;
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76

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
77
  --showfile                 emit diffed file position, not input file position
78 79 80 81 82 83 84 85 86 87
  -g, --git                  treat FILE as a single commit or git revision range
                             single git commit with:
                               <rev>
                               <rev>^
                               <rev>~n
                             multiple git commits with:
                               <rev1>..<rev2>
                               <rev1>...<rev2>
                               <rev>-<count>
                             git merges are ignored
88 89
  -f, --file                 treat FILE as regular source file
  --subjective, --strict     enable more subjective tests
90
  --list-types               list the possible message types
91
  --types TYPE(,TYPE2...)    show only these comma separated message types
92
  --ignore TYPE(,TYPE2...)   ignore various comma separated message types
93
  --show-types               show the specific message type in the output
94
  --max-line-length=n        set the maximum line length, if exceeded, warn
95
  --min-conf-desc-length=n   set the min description length, if shorter, warn
96 97 98 99 100 101 102 103 104
  --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
105 106 107 108 109
  --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
110 111 112
  --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
113 114
  --ignore-perl-version      override checking of perl version.  expect
                             runtime errors.
115
  --codespell                Use the codespell dictionary for spelling/typos
116
                             (default:/usr/share/codespell/dictionary.txt)
117
  --codespellfile            Use this codespell dictionary
118
  --typedefsfile             Read additional types from this file
119 120
  --color[=WHEN]             Use colors 'always', 'never', or only when output
                             is a terminal ('auto'). Default is 'auto'.
121 122 123 124 125 126 127 128
  -h, --help, --version      display this help and exit

When FILE is - read standard input.
EOM

	exit($exitcode);
}

129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
sub uniq {
	my %seen;
	return grep { !$seen{$_}++ } @_;
}

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

	my $count = 0;

	local $/ = undef;

	open(my $script, '<', abs_path($P)) or
	    die "$P: Can't read '$P' $!\n";

	my $text = <$script>;
	close($script);

	my @types = ();
148 149
	# Also catch when type or level is passed through a variable
	for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
150 151 152 153 154 155 156 157 158 159 160
		push (@types, $_);
	}
	@types = sort(uniq(@types));
	print("#\tMessage type\n\n");
	foreach my $type (@types) {
		print(++$count . "\t" . $type . "\n");
	}

	exit($exitcode);
}

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

187 188 189 190 191 192 193 194
# Perl's Getopt::Long allows options to take optional arguments after a space.
# Prevent --color by itself from consuming other arguments
foreach (@ARGV) {
	if ($_ eq "--color" || $_ eq "-color") {
		$_ = "--color=$color";
	}
}

195
GetOptions(
196
	'q|quiet+'	=> \$quiet,
197 198 199
	'tree!'		=> \$tree,
	'signoff!'	=> \$chk_signoff,
	'patch!'	=> \$chk_patch,
200
	'emacs!'	=> \$emacs,
201
	'terse!'	=> \$terse,
202
	'showfile!'	=> \$showfile,
203
	'f|file!'	=> \$file,
204
	'g|git!'	=> \$git,
205 206
	'subjective!'	=> \$check,
	'strict!'	=> \$check,
207
	'ignore=s'	=> \@ignore,
208
	'types=s'	=> \@use,
209
	'show-types!'	=> \$show_types,
210
	'list-types!'	=> \$list_types,
211
	'max-line-length=i' => \$max_line_length,
212
	'min-conf-desc-length=i' => \$min_conf_desc_length,
213
	'root=s'	=> \$root,
214 215
	'summary!'	=> \$summary,
	'mailback!'	=> \$mailback,
216
	'summary-file!'	=> \$summary_file,
217
	'fix!'		=> \$fix,
218
	'fix-inplace!'	=> \$fix_inplace,
219
	'ignore-perl-version!' => \$ignore_perl_version,
220
	'debug=s'	=> \%debug,
221
	'test-only=s'	=> \$tst_only,
222 223
	'codespell!'	=> \$codespell,
	'codespellfile=s'	=> \$codespellfile,
224
	'typedefsfile=s'	=> \$typedefsfile,
225 226 227
	'color=s'	=> \$color,
	'no-color'	=> \$color,	#keep old behaviors of -nocolor
	'nocolor'	=> \$color,	#keep old behaviors of -nocolor
228 229 230 231 232
	'h|help'	=> \$help,
	'version'	=> \$help
) or help(1);

help(0) if ($help);
233

234 235
list_types(0) if ($list_types);

236
$fix = 1 if ($fix_inplace);
237
$check_orig = $check;
238

239 240
my $exit = 0;

241 242 243 244 245 246 247
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);
	}
}

248
#if no filenames are given, push '-' to read patch from stdin
249
if ($#ARGV < 0) {
250
	push(@ARGV, '-');
251 252
}

253 254 255 256 257 258 259 260 261 262 263 264
if ($color =~ /^[01]$/) {
	$color = !$color;
} elsif ($color =~ /^always$/i) {
	$color = 1;
} elsif ($color =~ /^never$/i) {
	$color = 0;
} elsif ($color =~ /^auto$/i) {
	$color = (-t STDOUT);
} else {
	die "Invalid color mode: $color\n";
}

265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
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}++;
	}
}
281

282 283
sub hash_show_words {
	my ($hashRef, $prefix) = @_;
284

285
	if (keys %$hashRef) {
286
		print "\nNOTE: $prefix message types:";
287
		foreach my $word (sort keys %$hashRef) {
288 289
			print " $word";
		}
290
		print "\n";
291
	}
292 293
}

294 295 296
hash_save_array_words(\%ignore_type, \@ignore);
hash_save_array_words(\%use_type, \@use);

297 298
my $dbg_values = 0;
my $dbg_possible = 0;
299
my $dbg_type = 0;
300
my $dbg_attr = 0;
301
for my $key (keys %debug) {
302 303 304
	## no critic
	eval "\${dbg_$key} = '$debug{$key}';";
	die "$@" if ($@);
305 306
}

307 308
my $rpt_cleaners = 0;

309 310 311 312 313
if ($terse) {
	$emacs = 1;
	$quiet++;
}

314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
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);
	}
332 333
}

334 335
my $emitted_corrupt = 0;

336 337 338 339
our $Ident	= qr{
			[A-Za-z_][A-Za-z\d_]*
			(?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
		}x;
340 341 342 343 344 345 346 347
our $Storage	= qr{extern|static|asmlinkage};
our $Sparse	= qr{
			__user|
			__kernel|
			__force|
			__iomem|
			__must_check|
			__init_refok|
348
			__kprobes|
349
			__ref|
350 351
			__rcu|
			__private
352
		}x;
353 354 355 356 357
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};
358

359 360
# Notes to $Attribute:
# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
361 362
our $Attribute	= qr{
			const|
363 364 365
			__percpu|
			__nocast|
			__safe|
366
			__bitwise|
367 368 369 370 371 372 373 374
			__packed__|
			__packed2__|
			__naked|
			__maybe_unused|
			__always_unused|
			__noreturn|
			__used|
			__cold|
375
			__pure|
376 377
			__noclone|
			__deprecated|
378 379
			__read_mostly|
			__kprobes|
380
			$InitAttribute|
381 382
			____cacheline_aligned|
			____cacheline_aligned_in_smp|
383 384
			____cacheline_internodealigned_in_smp|
			__weak
385
		  }x;
386
our $Modifier;
387
our $Inline	= qr{inline|__always_inline|noinline|__inline|__inline__};
388 389 390
our $Member	= qr{->$Ident|\.$Ident|\[[^]]*\]};
our $Lval	= qr{$Ident(?:$Member)*};

391 392 393 394
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?};
395
our $Octal	= qr{0[0-7]+$Int_type?};
396
our $String	= qr{"[X\t]*"};
397 398 399
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]?};
400
our $Float	= qr{$Float_hex|$Float_dec|$Float_int};
401
our $Constant	= qr{$Float|$Binary|$Octal|$Hex|$Int};
402
our $Assignment	= qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
403
our $Compare    = qr{<=|>=|==|!=|<|(?<!-)>};
404
our $Arithmetic = qr{\+|-|\*|\/|%};
405 406 407
our $Operators	= qr{
			<=|>=|==|!=|
			=>|->|<<|>>|<|>|!|~|
408
			&&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
409 410
		  }x;

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

413
our $BasicType;
414
our $NonptrType;
415
our $NonptrTypeMisordered;
416
our $NonptrTypeWithAttr;
417
our $Type;
418
our $TypeMisordered;
419
our $Declare;
420
our $DeclareMisordered;
421

422 423
our $NON_ASCII_UTF8	= qr{
	[\xC2-\xDF][\x80-\xBF]               # non-overlong 2-byte
424 425 426 427 428 429 430 431
	|  \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;

432 433 434 435 436
our $UTF8	= qr{
	[\x09\x0A\x0D\x20-\x7E]              # ASCII
	| $NON_ASCII_UTF8
}x;

437
our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
438 439 440 441
our $typeOtherOSTypedefs = qr{(?x:
	u_(?:char|short|int|long) |          # bsd
	u(?:nchar|short|int|long)            # sysv
)};
442
our $typeKernelTypedefs = qr{(?x:
443
	(?:__)?(?:u|s|be|le)(?:8|16|32|64)|
444 445
	atomic_t
)};
446 447 448 449 450
our $typeTypedefs = qr{(?x:
	$typeC99Typedefs\b|
	$typeOtherOSTypedefs\b|
	$typeKernelTypedefs\b
)};
451

452 453
our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};

454
our $logFunctions = qr{(?x:
M
Miles Chen 已提交
455
	printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
456
	(?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
457
	WARN(?:_RATELIMIT|_ONCE|)|
458
	panic|
J
Joe Perches 已提交
459 460
	MODULE_[A-Z_]+|
	seq_vprintf|seq_printf|seq_puts
461 462
)};

463 464 465 466 467 468
our $signature_tags = qr{(?xi:
	Signed-off-by:|
	Acked-by:|
	Tested-by:|
	Reviewed-by:|
	Reported-by:|
469
	Suggested-by:|
470 471 472 473
	To:|
	Cc:
)};

474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
our @typeListMisordered = (
	qr{char\s+(?:un)?signed},
	qr{int\s+(?:(?:un)?signed\s+)?short\s},
	qr{int\s+short(?:\s+(?:un)?signed)},
	qr{short\s+int(?:\s+(?:un)?signed)},
	qr{(?:un)?signed\s+int\s+short},
	qr{short\s+(?:un)?signed},
	qr{long\s+int\s+(?:un)?signed},
	qr{int\s+long\s+(?:un)?signed},
	qr{long\s+(?:un)?signed\s+int},
	qr{int\s+(?:un)?signed\s+long},
	qr{int\s+(?:un)?signed},
	qr{int\s+long\s+long\s+(?:un)?signed},
	qr{long\s+long\s+int\s+(?:un)?signed},
	qr{long\s+long\s+(?:un)?signed\s+int},
	qr{long\s+long\s+(?:un)?signed},
	qr{long\s+(?:un)?signed},
);

493 494
our @typeList = (
	qr{void},
495 496 497 498 499 500 501 502 503
	qr{(?:(?:un)?signed\s+)?char},
	qr{(?:(?:un)?signed\s+)?short\s+int},
	qr{(?:(?:un)?signed\s+)?short},
	qr{(?:(?:un)?signed\s+)?int},
	qr{(?:(?:un)?signed\s+)?long\s+int},
	qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
	qr{(?:(?:un)?signed\s+)?long\s+long},
	qr{(?:(?:un)?signed\s+)?long},
	qr{(?:un)?signed},
504 505 506 507 508 509 510 511 512
	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},
513
	@typeListMisordered,
514
);
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536

our $C90_int_types = qr{(?x:
	long\s+long\s+int\s+(?:un)?signed|
	long\s+long\s+(?:un)?signed\s+int|
	long\s+long\s+(?:un)?signed|
	(?:(?:un)?signed\s+)?long\s+long\s+int|
	(?:(?:un)?signed\s+)?long\s+long|
	int\s+long\s+long\s+(?:un)?signed|
	int\s+(?:(?:un)?signed\s+)?long\s+long|

	long\s+int\s+(?:un)?signed|
	long\s+(?:un)?signed\s+int|
	long\s+(?:un)?signed|
	(?:(?:un)?signed\s+)?long\s+int|
	(?:(?:un)?signed\s+)?long|
	int\s+long\s+(?:un)?signed|
	int\s+(?:(?:un)?signed\s+)?long|

	int\s+(?:un)?signed|
	(?:(?:un)?signed\s+)?int
)};

537
our @typeListFile = ();
538 539 540 541 542 543
our @typeListWithAttr = (
	@typeList,
	qr{struct\s+$InitAttribute\s+$Ident},
	qr{union\s+$InitAttribute\s+$Ident},
);

544 545 546
our @modifierList = (
	qr{fastcall},
);
547
our @modifierListFile = ();
548

549 550 551 552 553 554
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],
555 556 557 558 559
	["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
	["IIO_DEV_ATTR_[A-Z_]+", 1],
	["SENSOR_(?:DEVICE_|)ATTR_2", 2],
	["SENSOR_TEMPLATE(?:_2|)", 3],
	["__ATTR", 2],
560 561
);

562 563 564 565 566 567 568
#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];
}

569 570 571 572 573 574 575 576
our $mode_perms_world_writable = qr{
	S_IWUGO		|
	S_IWOTH		|
	S_IRWXUGO	|
	S_IALLUGO	|
	0[0-7][0-7][2367]
}x;

577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602
our %mode_permission_string_types = (
	"S_IRWXU" => 0700,
	"S_IRUSR" => 0400,
	"S_IWUSR" => 0200,
	"S_IXUSR" => 0100,
	"S_IRWXG" => 0070,
	"S_IRGRP" => 0040,
	"S_IWGRP" => 0020,
	"S_IXGRP" => 0010,
	"S_IRWXO" => 0007,
	"S_IROTH" => 0004,
	"S_IWOTH" => 0002,
	"S_IXOTH" => 0001,
	"S_IRWXUGO" => 0777,
	"S_IRUGO" => 0444,
	"S_IWUGO" => 0222,
	"S_IXUGO" => 0111,
);

#Create a search pattern for all these strings to speed up a loop below
our $mode_perms_string_search = "";
foreach my $entry (keys %mode_permission_string_types) {
	$mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
	$mode_perms_string_search .= $entry;
}

603 604
our $allowed_asm_includes = qr{(?x:
	irq|
605 606 607
	memory|
	time|
	reboot
608 609 610
)};
# memory.h: ARM has a custom one

611 612 613 614
# Load common spelling mistakes and build regular expression list.
my $misspellings;
my %spelling_fix;

615 616 617
if (open(my $spelling, '<', $spelling_file)) {
	while (<$spelling>) {
		my $line = $_;
618

619 620
		$line =~ s/\s*\n?$//g;
		$line =~ s/^\s*//g;
621

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

		my ($suspect, $fix) = split(/\|\|/, $line);
626

627 628 629 630 631
		$spelling_fix{$suspect} = $fix;
	}
	close($spelling);
} else {
	warn "No typos will be found - file '$spelling_file': $!\n";
632 633
}

634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
if ($codespell) {
	if (open(my $spelling, '<', $codespellfile)) {
		while (<$spelling>) {
			my $line = $_;

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

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

			$line =~ s/,.*$//;

			my ($suspect, $fix) = split(/->/, $line);

			$spelling_fix{$suspect} = $fix;
		}
		close($spelling);
	} else {
		warn "No codespell typos will be found - file '$codespellfile': $!\n";
	}
}

$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;

660 661
sub read_words {
	my ($wordsRef, $file) = @_;
662

663 664 665
	if (open(my $words, '<', $file)) {
		while (<$words>) {
			my $line = $_;
666

667 668
			$line =~ s/\s*\n?$//g;
			$line =~ s/^\s*//g;
669

670 671 672 673 674 675 676 677 678 679 680 681
			next if ($line =~ m/^\s*#/);
			next if ($line =~ m/^\s*$/);
			if ($line =~ /\s/) {
				print("$file: '$line' invalid - ignored\n");
				next;
			}

			$$wordsRef .= '|' if ($$wordsRef ne "");
			$$wordsRef .= $line;
		}
		close($file);
		return 1;
682
	}
683 684 685 686 687 688 689 690 691 692 693 694

	return 0;
}

my $const_structs = "";
read_words(\$const_structs, $conststructsfile)
    or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";

my $typeOtherTypedefs = "";
if (length($typedefsfile)) {
	read_words(\$typeOtherTypedefs, $typedefsfile)
	    or warn "No additional types will be considered - file '$typedefsfile': $!\n";
695
}
696
$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne "");
697

698
sub build_types {
699 700
	my $mods = "(?x:  \n" . join("|\n  ", (@modifierList, @modifierListFile)) . "\n)";
	my $all = "(?x:  \n" . join("|\n  ", (@typeList, @typeListFile)) . "\n)";
701
	my $Misordered = "(?x:  \n" . join("|\n  ", @typeListMisordered) . "\n)";
702
	my $allWithAttr = "(?x:  \n" . join("|\n  ", @typeListWithAttr) . "\n)";
703
	$Modifier	= qr{(?:$Attribute|$Sparse|$mods)};
704 705 706 707
	$BasicType	= qr{
				(?:$typeTypedefs\b)|
				(?:${all}\b)
		}x;
708
	$NonptrType	= qr{
709
			(?:$Modifier\s+|const\s+)*
710
			(?:
711
				(?:typeof|__typeof__)\s*\([^\)]*\)|
712
				(?:$typeTypedefs\b)|
713
				(?:${all}\b)
714
			)
715
			(?:\s+$Modifier|\s+const)*
716
		  }x;
717 718 719 720 721 722 723
	$NonptrTypeMisordered	= qr{
			(?:$Modifier\s+|const\s+)*
			(?:
				(?:${Misordered}\b)
			)
			(?:\s+$Modifier|\s+const)*
		  }x;
724 725 726 727 728 729 730 731 732
	$NonptrTypeWithAttr	= qr{
			(?:$Modifier\s+|const\s+)*
			(?:
				(?:typeof|__typeof__)\s*\([^\)]*\)|
				(?:$typeTypedefs\b)|
				(?:${allWithAttr}\b)
			)
			(?:\s+$Modifier|\s+const)*
		  }x;
733
	$Type	= qr{
734
			$NonptrType
735
			(?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
736
			(?:\s+$Inline|\s+$Modifier)*
737
		  }x;
738 739 740 741 742
	$TypeMisordered	= qr{
			$NonptrTypeMisordered
			(?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
			(?:\s+$Inline|\s+$Modifier)*
		  }x;
743
	$Declare	= qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
744
	$DeclareMisordered	= qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
745 746
}
build_types();
747

748
our $Typecast	= qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
749 750 751 752 753 754

# 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))*\))/;
755
our $LvalOrFunc	= qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
756
our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
757

758
our $declaration_macros = qr{(?x:
759
	(?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
760
	(?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
761 762 763
	(?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
)};

764 765 766
sub deparenthesize {
	my ($string) = @_;
	return "" if (!defined($string));
767 768 769 770 771 772

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

773
	$string =~ s@\s+@ @g;
774

775 776 777
	return $string;
}

778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
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;
796 797 798
		} 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*[;\{]/) {
799 800 801 802 803
			$camelcase{$1} = 1;
		}
	}
}

804 805 806
sub is_maintained_obsolete {
	my ($filename) = @_;

807
	return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
808

809
	my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
810 811 812 813

	return $status =~ /obsolete/i;
}

814 815 816 817 818
my $camelcase_seeded = 0;
sub seed_camelcase_includes {
	return if ($camelcase_seeded);

	my $files;
819 820 821 822
	my $camelcase_cache = "";
	my @include_files = ();

	$camelcase_seeded = 1;
823

824
	if (-e ".git") {
825 826
		my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
		chomp $git_last_include_commit;
827
		$camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
828
	} else {
829
		my $last_mod_date = 0;
830
		$files = `find $root/include -name "*.h"`;
831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849
		@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;
850
	}
851

852
	if (-e ".git") {
853 854 855 856
		$files = `git ls-files "include/*.h"`;
		@include_files = split('\n', $files);
	}

857 858 859
	foreach my $file (@include_files) {
		seed_camelcase_file($file);
	}
860

861
	if ($camelcase_cache ne "") {
862
		unlink glob ".checkpatch-camelcase.*";
863 864
		open(my $camelcase_file, '>', "$camelcase_cache")
		    or warn "$P: Can't write '$camelcase_cache' $!\n";
865 866 867 868 869
		foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
			print $camelcase_file ("$_\n");
		}
		close($camelcase_file);
	}
870 871
}

872 873 874 875 876 877 878 879 880
sub git_commit_info {
	my ($commit, $id, $desc) = @_;

	return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));

	my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
	$output =~ s/^\s*//gm;
	my @lines = split("\n", $output);

881 882
	return ($id, $desc) if ($#lines < 0);

883 884 885 886 887 888 889 890 891 892 893
	if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
# Maybe one day convert this block of bash into something that returns
# all matching commit ids, but it's very slow...
#
#		echo "checking commits $1..."
#		git rev-list --remotes | grep -i "^$1" |
#		while read line ; do
#		    git log --format='%H %s' -1 $line |
#		    echo "commit $(cut -c 1-12,41-)"
#		done
	} elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
894
		$id = undef;
895 896 897 898 899 900 901 902
	} else {
		$id = substr($lines[0], 0, 12);
		$desc = substr($lines[0], 41);
	}

	return ($id, $desc);
}

903 904
$chk_signoff = 0 if ($file);

905
my @rawlines = ();
906
my @lines = ();
907
my @fixed = ();
908 909
my @fixed_inserted = ();
my @fixed_deleted = ();
910 911
my $fixlinenr = -1;

912 913 914 915 916 917
# If input is git commits, extract all commits from the commit expressions.
# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
die "$P: No git repository found\n" if ($git && !-e ".git");

if ($git) {
	my @commits = ();
918
	foreach my $commit_expr (@ARGV) {
919
		my $git_range;
920 921
		if ($commit_expr =~ m/^(.*)-(\d+)$/) {
			$git_range = "-$2 $1";
922 923 924
		} elsif ($commit_expr =~ m/\.\./) {
			$git_range = "$commit_expr";
		} else {
925 926 927 928
			$git_range = "-1 $commit_expr";
		}
		my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
		foreach my $line (split(/\n/, $lines)) {
929 930
			$line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
			next if (!defined($1) || !defined($2));
931 932 933 934
			my $sha1 = $1;
			my $subject = $2;
			unshift(@commits, $sha1);
			$git_commits{$sha1} = $subject;
935 936 937 938 939 940
		}
	}
	die "$P: no git commits after extraction!\n" if (@commits == 0);
	@ARGV = @commits;
}

941
my $vname;
942
for my $filename (@ARGV) {
943
	my $FILE;
944 945 946 947
	if ($git) {
		open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
			die "$P: $filename: git format-patch failed - $!\n";
	} elsif ($file) {
948
		open($FILE, '-|', "diff -u /dev/null $filename") ||
949
			die "$P: $filename: diff failed - $!\n";
950 951
	} elsif ($filename eq '-') {
		open($FILE, '<&STDIN');
952
	} else {
953
		open($FILE, '<', "$filename") ||
954
			die "$P: $filename: open failed - $!\n";
955
	}
956 957
	if ($filename eq '-') {
		$vname = 'Your patch';
958
	} elsif ($git) {
959
		$vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
960 961 962
	} else {
		$vname = $filename;
	}
963
	while (<$FILE>) {
964 965 966
		chomp;
		push(@rawlines, $_);
	}
967
	close($FILE);
968 969 970 971 972 973 974

	if ($#ARGV > 0 && $quiet == 0) {
		print '-' x length($vname) . "\n";
		print "$vname\n";
		print '-' x length($vname) . "\n";
	}

975
	if (!process($filename)) {
976 977 978
		$exit = 1;
	}
	@rawlines = ();
979
	@lines = ();
980
	@fixed = ();
981 982
	@fixed_inserted = ();
	@fixed_deleted = ();
983
	$fixlinenr = -1;
984 985 986
	@modifierListFile = ();
	@typeListFile = ();
	build_types();
987 988
}

989
if (!$quiet) {
990 991 992
	hash_show_words(\%use_type, "Used");
	hash_show_words(\%ignore_type, "Ignored");

993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
	if ($^V lt 5.10.0) {
		print << "EOM"

NOTE: perl $^V is not modern enough to detect all possible issues.
      An upgrade to at least perl v5.10.0 is suggested.
EOM
	}
	if ($exit) {
		print << "EOM"

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

1009 1010 1011
exit($exit);

sub top_of_kernel_tree {
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
	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;
		}
1024
	}
1025
	return 1;
1026
}
1027

1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
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;
1047
		$name = trim($name);
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061
		$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 = "";
		}
	}

1062
	$name = trim($name);
1063
	$name =~ s/^\"|\"$//g;
1064
	$address = trim($address);
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
	$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;

1080
	$name = trim($name);
1081
	$name =~ s/^\"|\"$//g;
1082
	$address = trim($address);
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097

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

1098
sub which {
1099
	my ($bin) = @_;
1100

1101 1102 1103 1104
	foreach my $path (split(/:/, $ENV{PATH})) {
		if (-e "$path/$bin") {
			return "$path/$bin";
		}
1105 1106
	}

1107
	return "";
1108 1109
}

1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
sub which_conf {
	my ($conf) = @_;

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

	return "";
}

1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141
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;
}
1142
sub copy_spacing {
1143
	(my $res = shift) =~ tr/\t/ /c;
1144 1145
	return $res;
}
1146

1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159
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));
}

1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170
my $sanitise_quote = '';

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

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
1171 1172 1173 1174 1175 1176
sub sanitise_line {
	my ($line) = @_;

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

1177
	my $qlen = 0;
1178 1179
	my $off = 0;
	my $c;
1180

1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194
	# 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;
1195
		}
1196
		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
1197 1198 1199 1200
			$sanitise_quote = '';
			substr($res, $off, 2, "$;$;");
			$off++;
			next;
1201
		}
1202 1203 1204 1205 1206 1207 1208
		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
			$sanitise_quote = '//';

			substr($res, $off, 2, $sanitise_quote);
			$off++;
			next;
		}
1209 1210 1211 1212 1213 1214 1215

		# 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;
1216
		}
1217 1218 1219 1220
		# Regular quotes.
		if ($c eq "'" || $c eq '"') {
			if ($sanitise_quote eq '') {
				$sanitise_quote = $c;
1221

1222 1223 1224 1225 1226 1227
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
1228

1229
		#print "c<$c> SQ<$sanitise_quote>\n";
1230 1231
		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
			substr($res, $off, 1, $;);
1232 1233
		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
			substr($res, $off, 1, $;);
1234 1235 1236 1237 1238
		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
			substr($res, $off, 1, 'X');
		} else {
			substr($res, $off, 1, $c);
		}
1239 1240
	}

1241 1242 1243 1244
	if ($sanitise_quote eq '//') {
		$sanitise_quote = '';
	}

1245
	# The pathname on a #include may be surrounded by '<' and '>'.
1246
	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
1247 1248 1249 1250
		my $clean = 'X' x length($1);
		$res =~ s@\<.*\>@<$clean>@;

	# The whole of a #error is a string.
1251
	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
1252
		my $clean = 'X' x length($1);
1253
		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
1254 1255
	}

1256 1257 1258 1259 1260
	if ($allow_c99_comments && $res =~ m@(//.*$)@) {
		my $match = $1;
		$res =~ s/\Q$match\E/"$;" x length($match)/e;
	}

1261 1262 1263
	return $res;
}

1264 1265 1266
sub get_quoted_string {
	my ($line, $rawline) = @_;

1267
	return "" if ($line !~ m/($String)/g);
1268 1269 1270
	return substr($rawline, $-[0], $+[0] - $-[0]);
}

1271 1272 1273 1274 1275 1276
sub ctx_statement_block {
	my ($linenr, $remain, $off) = @_;
	my $line = $linenr - 1;
	my $blk = '';
	my $soff = $off;
	my $coff = $off - 1;
1277
	my $coff_set = 0;
1278

1279 1280
	my $loff = 0;

1281 1282
	my $type = '';
	my $level = 0;
1283
	my @stack = ();
1284
	my $p;
1285 1286
	my $c;
	my $len = 0;
1287 1288

	my $remainder;
1289
	while (1) {
1290 1291
		@stack = (['', 0]) if ($#stack == -1);

1292
		#warn "CSB: blk<$blk> remain<$remain>\n";
1293 1294 1295 1296
		# If we are about to drop off the end, pull in more
		# context.
		if ($off >= $len) {
			for (; $remain > 0; $line++) {
1297
				last if (!defined $lines[$line]);
1298
				next if ($lines[$line] =~ /^-/);
1299
				$remain--;
1300
				$loff = $len;
1301
				$blk .= $lines[$line] . "\n";
1302 1303 1304 1305 1306 1307
				$len = length($blk);
				$line++;
				last;
			}
			# Bail if there is no further context.
			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
1308
			if ($off >= $len) {
1309 1310
				last;
			}
1311 1312 1313 1314
			if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
				$level++;
				$type = '#';
			}
1315
		}
1316
		$p = $c;
1317
		$c = substr($blk, $off, 1);
1318
		$remainder = substr($blk, $off);
1319

1320
		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1321 1322 1323 1324 1325 1326 1327 1328 1329 1330

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

1331 1332 1333 1334 1335 1336
		# Statement ends at the ';' or a close '}' at the
		# outermost level.
		if ($level == 0 && $c eq ';') {
			last;
		}

1337
		# An else is really a conditional as long as its not else if
1338 1339 1340 1341 1342 1343 1344 1345
		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";
1346 1347
		}

1348 1349 1350 1351 1352 1353 1354 1355 1356 1357
		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;
1358 1359
				$coff_set = 1;
				#warn "CSB: mark coff<$coff>\n";
1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370
			}
		}
		if (($type eq '' || $type eq '{') && $c eq '{') {
			$level++;
			$type = '{';
		}
		if ($type eq '{' && $c eq '}') {
			$level--;
			$type = ($level != 0)? '{' : '';

			if ($level == 0) {
1371 1372 1373
				if (substr($blk, $off + 1, 1) eq ';') {
					$off++;
				}
1374 1375 1376
				last;
			}
		}
1377 1378 1379 1380 1381 1382 1383
		# Preprocessor commands end at the newline unless escaped.
		if ($type eq '#' && $c eq "\n" && $p ne "\\") {
			$level--;
			$type = '';
			$off++;
			last;
		}
1384 1385
		$off++;
	}
1386
	# We are truly at the end, so shuffle to the next line.
1387
	if ($off == $len) {
1388
		$loff = $len + 1;
1389 1390 1391
		$line++;
		$remain--;
	}
1392 1393 1394 1395 1396 1397 1398

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

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

1399
	#print "coff<$coff> soff<$off> loff<$loff>\n";
1400 1401 1402 1403 1404

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

1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447
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;
	}
}

1448 1449 1450 1451 1452 1453
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

1454
	# Grab the first conditional/block pair.
1455 1456
	($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
1457
	#print "F: c<$condition> s<$statement> remain<$remain>\n";
1458 1459 1460 1461 1462 1463 1464
	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.
1465 1466 1467
	for (;;) {
		($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
1468
		#print "C: c<$condition> s<$statement> remain<$remain>\n";
1469
		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1470 1471
		#print "C: push\n";
		push(@chunks, [ $condition, $statement ]);
1472 1473 1474
	}

	return ($level, $linenr, @chunks);
1475 1476
}

1477
sub ctx_block_get {
1478
	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1479 1480 1481 1482 1483 1484 1485
	my $line;
	my $start = $linenr - 1;
	my $blk = '';
	my @o;
	my @c;
	my @res = ();

1486
	my $level = 0;
1487
	my @stack = ($level);
1488 1489 1490 1491 1492
	for ($line = $start; $remain > 0; $line++) {
		next if ($rawlines[$line] =~ /^-/);
		$remain--;

		$blk .= $rawlines[$line];
1493 1494

		# Handle nested #if/#else.
1495
		if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1496
			push(@stack, $level);
1497
		} elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1498
			$level = $stack[$#stack - 1];
1499
		} elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1500 1501 1502
			$level = pop(@stack);
		}

1503
		foreach my $c (split(//, $lines[$line])) {
1504 1505 1506 1507 1508
			##print "C<$c>L<$level><$open$close>O<$off>\n";
			if ($off > 0) {
				$off--;
				next;
			}
1509

1510 1511 1512 1513 1514 1515 1516
			if ($c eq $close && $level > 0) {
				$level--;
				last if ($level == 0);
			} elsif ($c eq $open) {
				$level++;
			}
		}
1517

1518
		if (!$outer || $level <= 1) {
1519
			push(@res, $rawlines[$line]);
1520 1521
		}

1522
		last if ($level == 0);
1523 1524
	}

1525
	return ($level, @res);
1526 1527 1528 1529
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

1530 1531
	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
	return @r;
1532 1533 1534 1535
}
sub ctx_block {
	my ($linenr, $remain) = @_;

1536 1537
	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
	return @r;
1538 1539
}
sub ctx_statement {
1540 1541 1542 1543 1544 1545
	my ($linenr, $remain, $off) = @_;

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

1548
	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1549
}
1550 1551 1552 1553 1554
sub ctx_statement_level {
	my ($linenr, $remain, $off) = @_;

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
1555 1556 1557 1558 1559

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

	# Catch a comment on the end of the line itself.
1560
	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1561 1562 1563 1564 1565 1566 1567
	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++) {
1568 1569
		my $line = $rawlines[$linenr - 1];
		#warn "           $line\n";
1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591
		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);

1592
	##print "LINE: $rawlines[$end_line - 1 ]\n";
1593 1594 1595 1596 1597
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613
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;
}

1614 1615 1616
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
1617

1618 1619 1620 1621 1622 1623
	$res = '';
	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
		$res .= $1;
		if ($2 ne '') {
			$coded = sprintf("^%c", unpack('C', $2) + 64);
			$res .= $coded;
1624 1625
		}
	}
1626
	$res =~ s/$/\$/;
1627

1628
	return $res;
1629 1630
}

1631
my $av_preprocessor = 0;
1632
my $av_pending;
1633
my @av_paren_type;
1634
my $av_pend_colon;
1635 1636 1637

sub annotate_reset {
	$av_preprocessor = 0;
1638 1639
	$av_pending = '_';
	@av_paren_type = ('E');
1640
	$av_pend_colon = 'O';
1641 1642
}

1643 1644
sub annotate_values {
	my ($stream, $type) = @_;
1645

1646
	my $res;
1647
	my $var = '_' x length($stream);
1648 1649
	my $cur = $stream;

1650
	print "$stream\n" if ($dbg_values > 1);
1651 1652

	while (length($cur)) {
1653
		@av_paren_type = ('E') if ($#av_paren_type < 0);
1654
		print " <" . join('', @av_paren_type) .
1655
				"> <$type> <$av_pending>" if ($dbg_values > 1);
1656
		if ($cur =~ /^(\s+)/o) {
1657 1658
			print "WS($1)\n" if ($dbg_values > 1);
			if ($1 =~ /\n/ && $av_preprocessor) {
1659
				$type = pop(@av_paren_type);
1660
				$av_preprocessor = 0;
1661 1662
			}

1663
		} elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1664 1665
			print "CAST($1)\n" if ($dbg_values > 1);
			push(@av_paren_type, $type);
1666
			$type = 'c';
1667

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

1672 1673 1674 1675
		} elsif ($cur =~ /^($Modifier)\s*/) {
			print "MODIFIER($1)\n" if ($dbg_values > 1);
			$type = 'T';

1676
		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1677
			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1678
			$av_preprocessor = 1;
1679 1680 1681 1682 1683 1684
			push(@av_paren_type, $type);
			if ($2 ne '') {
				$av_pending = 'N';
			}
			$type = 'E';

1685
		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1686 1687 1688
			print "UNDEF($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;
			push(@av_paren_type, $type);
1689

1690
		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1691
			print "PRE_START($1)\n" if ($dbg_values > 1);
1692
			$av_preprocessor = 1;
1693 1694 1695

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
1696
			$type = 'E';
1697

1698
		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1699 1700 1701 1702 1703
			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;

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

1704
			$type = 'E';
1705

1706
		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1707 1708 1709 1710 1711 1712 1713 1714
			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);
1715
			$type = 'E';
1716 1717

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

1720 1721 1722 1723 1724
		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
			print "ATTR($1)\n" if ($dbg_values > 1);
			$av_pending = $type;
			$type = 'N';

1725
		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1726
			print "SIZEOF($1)\n" if ($dbg_values > 1);
1727
			if (defined $2) {
1728
				$av_pending = 'V';
1729 1730 1731
			}
			$type = 'N';

1732
		} elsif ($cur =~ /^(if|while|for)\b/o) {
1733
			print "COND($1)\n" if ($dbg_values > 1);
1734
			$av_pending = 'E';
1735 1736
			$type = 'N';

1737 1738 1739 1740 1741
		} elsif ($cur =~/^(case)/o) {
			print "CASE($1)\n" if ($dbg_values > 1);
			$av_pend_colon = 'C';
			$type = 'N';

1742
		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1743
			print "KEYWORD($1)\n" if ($dbg_values > 1);
1744 1745 1746
			$type = 'N';

		} elsif ($cur =~ /^(\()/o) {
1747
			print "PAREN('$1')\n" if ($dbg_values > 1);
1748 1749
			push(@av_paren_type, $av_pending);
			$av_pending = '_';
1750 1751 1752
			$type = 'N';

		} elsif ($cur =~ /^(\))/o) {
1753 1754 1755
			my $new_type = pop(@av_paren_type);
			if ($new_type ne '_') {
				$type = $new_type;
1756 1757
				print "PAREN('$1') -> $type\n"
							if ($dbg_values > 1);
1758
			} else {
1759
				print "PAREN('$1')\n" if ($dbg_values > 1);
1760 1761
			}

1762
		} elsif ($cur =~ /^($Ident)\s*\(/o) {
1763
			print "FUNC($1)\n" if ($dbg_values > 1);
1764
			$type = 'V';
1765
			$av_pending = 'V';
1766

1767 1768
		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
			if (defined $2 && $type eq 'C' || $type eq 'T') {
1769
				$av_pend_colon = 'B';
1770 1771
			} elsif ($type eq 'E') {
				$av_pend_colon = 'L';
1772 1773 1774 1775
			}
			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
			$type = 'V';

1776
		} elsif ($cur =~ /^($Ident|$Constant)/o) {
1777
			print "IDENT($1)\n" if ($dbg_values > 1);
1778 1779 1780
			$type = 'V';

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

1784
		} elsif ($cur =~/^(;|{|})/) {
1785
			print "END($1)\n" if ($dbg_values > 1);
1786
			$type = 'E';
1787 1788
			$av_pend_colon = 'O';

1789 1790 1791 1792
		} elsif ($cur =~/^(,)/) {
			print "COMMA($1)\n" if ($dbg_values > 1);
			$type = 'C';

1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806
		} 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';
1807

1808
		} elsif ($cur =~ /^(\[)/o) {
1809
			print "CLOSE($1)\n" if ($dbg_values > 1);
1810 1811
			$type = 'N';

1812
		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824
			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';

1825
		} elsif ($cur =~ /^($Operators)/o) {
1826
			print "OP($1)\n" if ($dbg_values > 1);
1827 1828 1829 1830 1831
			if ($1 ne '++' && $1 ne '--') {
				$type = 'N';
			}

		} elsif ($cur =~ /(^.)/o) {
1832
			print "C($1)\n" if ($dbg_values > 1);
1833 1834 1835 1836 1837
		}
		if (defined $1) {
			$cur = substr($cur, length($1));
			$res .= $type x length($1);
		}
1838
	}
1839

1840
	return ($res, $var);
1841 1842
}

1843
sub possible {
1844
	my ($possible, $line) = @_;
1845
	my $notPermitted = qr{(?:
1846 1847 1848 1849
		^(?:
			$Modifier|
			$Storage|
			$Type|
1850 1851 1852
			DEFINE_\S+
		)$|
		^(?:
1853 1854 1855 1856 1857
			goto|
			return|
			case|
			else|
			asm|__asm__|
1858 1859 1860
			do|
			\#|
			\#\#|
1861
		)(?:\s|$)|
1862
		^(?:typedef|struct|enum)\b
1863 1864 1865
	    )}x;
	warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
	if ($possible !~ $notPermitted) {
1866 1867 1868 1869 1870 1871 1872
		# 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;
1873
			for my $modifier (split(' ', $possible)) {
1874 1875
				if ($modifier !~ $notPermitted) {
					warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1876
					push(@modifierListFile, $modifier);
1877
				}
1878
			}
1879 1880 1881

		} else {
			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1882
			push(@typeListFile, $possible);
1883
		}
1884
		build_types();
1885 1886
	} else {
		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1887 1888 1889
	}
}

1890 1891
my $prefix = '';

1892
sub show_type {
1893
	my ($type) = @_;
1894

1895 1896
	$type =~ tr/[a-z]/[A-Z]/;

1897 1898 1899
	return defined $use_type{$type} if (scalar keys %use_type > 0);

	return !defined $ignore_type{$type};
1900 1901
}

1902
sub report {
1903 1904 1905 1906
	my ($level, $type, $msg) = @_;

	if (!show_type($type) ||
	    (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1907 1908
		return 0;
	}
1909
	my $output = '';
1910
	if ($color) {
1911 1912 1913 1914 1915 1916 1917 1918 1919
		if ($level eq 'ERROR') {
			$output .= RED;
		} elsif ($level eq 'WARNING') {
			$output .= YELLOW;
		} else {
			$output .= GREEN;
		}
	}
	$output .= $prefix . $level . ':';
1920
	if ($show_types) {
1921
		$output .= BLUE if ($color);
1922
		$output .= "$type:";
1923
	}
1924
	$output .= RESET if ($color);
1925
	$output .= ' ' . $msg . "\n";
1926 1927 1928 1929 1930 1931

	if ($showfile) {
		my @lines = split("\n", $output, -1);
		splice(@lines, 1, 1);
		$output = join("\n", @lines);
	}
1932
	$output = (split('\n', $output))[0] . "\n" if ($terse);
1933

1934
	push(our @report, $output);
1935 1936

	return 1;
1937
}
1938

1939
sub report_dump {
1940
	our @report;
1941
}
1942

1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974
sub fixup_current_range {
	my ($lineRef, $offset, $length) = @_;

	if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
		my $o = $1;
		my $l = $2;
		my $no = $o + $offset;
		my $nl = $l + $length;
		$$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
	}
}

sub fix_inserted_deleted_lines {
	my ($linesRef, $insertedRef, $deletedRef) = @_;

	my $range_last_linenr = 0;
	my $delta_offset = 0;

	my $old_linenr = 0;
	my $new_linenr = 0;

	my $next_insert = 0;
	my $next_delete = 0;

	my @lines = ();

	my $inserted = @{$insertedRef}[$next_insert++];
	my $deleted = @{$deletedRef}[$next_delete++];

	foreach my $old_line (@{$linesRef}) {
		my $save_line = 1;
		my $line = $old_line;	#don't modify the array
1975
		if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) {	#new filename
1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005
			$delta_offset = 0;
		} elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) {	#new hunk
			$range_last_linenr = $new_linenr;
			fixup_current_range(\$line, $delta_offset, 0);
		}

		while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
			$deleted = @{$deletedRef}[$next_delete++];
			$save_line = 0;
			fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
		}

		while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
			push(@lines, ${$inserted}{'LINE'});
			$inserted = @{$insertedRef}[$next_insert++];
			$new_linenr++;
			fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
		}

		if ($save_line) {
			push(@lines, $line);
			$new_linenr++;
		}

		$old_linenr++;
	}

	return @lines;
}

2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026
sub fix_insert_line {
	my ($linenr, $line) = @_;

	my $inserted = {
		LINENR => $linenr,
		LINE => $line,
	};
	push(@fixed_inserted, $inserted);
}

sub fix_delete_line {
	my ($linenr, $line) = @_;

	my $deleted = {
		LINENR => $linenr,
		LINE => $line,
	};

	push(@fixed_deleted, $deleted);
}

2027
sub ERROR {
2028 2029 2030
	my ($type, $msg) = @_;

	if (report("ERROR", $type, $msg)) {
2031 2032
		our $clean = 0;
		our $cnt_error++;
2033
		return 1;
2034
	}
2035
	return 0;
2036 2037
}
sub WARN {
2038 2039 2040
	my ($type, $msg) = @_;

	if (report("WARNING", $type, $msg)) {
2041 2042
		our $clean = 0;
		our $cnt_warn++;
2043
		return 1;
2044
	}
2045
	return 0;
2046 2047
}
sub CHK {
2048 2049 2050
	my ($type, $msg) = @_;

	if ($check && report("CHECK", $type, $msg)) {
2051 2052
		our $clean = 0;
		our $cnt_chk++;
2053
		return 1;
2054
	}
2055
	return 0;
2056 2057
}

2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080
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 ".../") {
2081 2082
		WARN("USE_RELATIVE_PATH",
		     "use relative pathname instead of absolute in changelog text\n" . $herecurr);
2083 2084 2085
	}
}

2086 2087 2088
sub trim {
	my ($string) = @_;

2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105
	$string =~ s/^\s+|\s+$//g;

	return $string;
}

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

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

	return $string;
}

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

	$string =~ s/\s+$//;
2106 2107 2108 2109

	return $string;
}

2110 2111 2112 2113 2114 2115 2116 2117
sub string_find_replace {
	my ($string, $find, $replace) = @_;

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

	return $string;
}

2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132
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";
}

2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159
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;
		}
	}

2160
	return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
2161 2162
}

2163 2164 2165 2166 2167
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
2168
	my $prevrawline="";
2169
	my $stashline="";
2170
	my $stashrawline="";
2171

2172
	my $length;
2173 2174 2175 2176
	my $indent;
	my $previndent=0;
	my $stashindent=0;

2177
	our $clean = 1;
2178 2179
	my $signoff = 0;
	my $is_patch = 0;
2180
	my $in_header_lines = $file ? 0 : 1;
2181
	my $in_commit_log = 0;		#Scanning lines before patch
2182
	my $has_commit_log = 0;		#Encountered lines before patch
2183
	my $commit_log_possible_stack_dump = 0;
2184
	my $commit_log_long_line = 0;
2185
	my $commit_log_has_diff = 0;
2186
	my $reported_maintainer_file = 0;
2187 2188
	my $non_utf8_charset = 0;

2189
	my $last_blank_line = 0;
2190
	my $last_coalesced_string_linenr = -1;
2191

2192
	our @report = ();
2193 2194 2195 2196 2197
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

2198 2199 2200 2201 2202
	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
2203
	my $context_function;		#undef'd unless there's a known function
2204
	my $in_comment = 0;
2205
	my $comment_edge = 0;
2206
	my $first_line = 0;
2207
	my $p1_prefix = '';
2208

2209 2210 2211
	my $prev_values = 'E';

	# suppression flags
2212
	my %suppress_ifbraces;
2213
	my %suppress_whiletrailers;
2214
	my %suppress_export;
2215
	my $suppress_statement = 0;
2216

2217
	my %signatures = ();
2218

2219
	# Pre-scan the patch sanitizing the lines.
2220
	# Pre-scan the patch looking for any __setup documentation.
2221
	#
2222 2223
	my @setup_docs = ();
	my $setup_docs = 0;
2224

2225 2226
	my $camelcase_file_seeded = 0;

2227
	sanitise_line_reset();
2228 2229
	my $line;
	foreach my $rawline (@rawlines) {
2230 2231
		$linenr++;
		$line = $rawline;
2232

2233 2234
		push(@fixed, $rawline) if ($fix);

2235
		if ($rawline=~/^\+\+\+\s+(\S+)/) {
2236
			$setup_docs = 0;
2237
			if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
2238 2239
				$setup_docs = 1;
			}
2240 2241
			#next;
		}
2242
		if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2243 2244 2245 2246 2247 2248
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
2249
			$in_comment = 0;
2250 2251 2252 2253 2254 2255

			# 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;
2256 2257 2258 2259 2260 2261
			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";
2262
				last if (!defined $rawlines[$ln - 1]);
2263 2264 2265 2266 2267
				if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
				    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
					($edge) = $1;
					last;
				}
2268 2269 2270 2271 2272 2273 2274 2275 2276
			}
			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 &&
2277
			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
2278 2279 2280 2281 2282 2283 2284
			{
				$in_comment = 1;
			}

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

2285
		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2286
			# Standardise the strings and chars within the input to
2287
			# simplify matching -- only bother with positive lines.
2288
			$line = sanitise_line($rawline);
2289
		}
2290 2291 2292 2293 2294 2295 2296 2297 2298 2299
		push(@lines, $line);

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

		#print "==>$rawline\n";
		#print "-->$line\n";
2300 2301 2302 2303 2304 2305

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

2306 2307
	$prefix = '';

2308 2309
	$realcnt = 0;
	$linenr = 0;
2310
	$fixlinenr = -1;
2311 2312
	foreach my $line (@lines) {
		$linenr++;
2313
		$fixlinenr++;
2314 2315
		my $sline = $line;	#copy of $line
		$sline =~ s/$;/ /g;	#with comments as spaces
2316

2317
		my $rawline = $rawlines[$linenr - 1];
2318

2319
#extract the line range in the file after the patch is applied
2320
		if (!$in_commit_log &&
2321 2322
		    $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
			my $context = $4;
2323
			$is_patch = 1;
2324
			$first_line = $linenr + 1;
2325 2326 2327 2328 2329 2330
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
2331
			annotate_reset();
2332 2333
			$prev_values = 'E';

2334
			%suppress_ifbraces = ();
2335
			%suppress_whiletrailers = ();
2336
			%suppress_export = ();
2337
			$suppress_statement = 0;
2338 2339 2340 2341 2342
			if ($context =~ /\b(\w+)\s*\(/) {
				$context_function = $1;
			} else {
				undef $context_function;
			}
2343 2344
			next;

2345 2346 2347
# 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.
2348
		} elsif ($line =~ /^( |\+|$)/) {
2349
			$realline++;
2350
			$realcnt-- if ($realcnt != 0);
2351

2352
			# Measure the line length and indent.
2353
			($length, $indent) = line_stats($rawline);
2354 2355 2356 2357

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

2360
			#warn "line<$line>\n";
2361

2362 2363
		} elsif ($realcnt == 1) {
			$realcnt--;
2364 2365
		}

2366 2367
		my $hunk_line = ($realcnt != 0);

2368 2369
		$here = "#$linenr: " if (!$file);
		$here = "#$realline: " if ($file);
2370

2371
		my $found_file = 0;
2372
		# extract the filename as it passes
2373 2374
		if ($line =~ /^diff --git.*?(\S+)$/) {
			$realfile = $1;
2375
			$realfile =~ s@^([^/]*)/@@ if (!$file);
2376
			$in_commit_log = 0;
2377
			$found_file = 1;
2378
		} elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2379
			$realfile = $1;
2380
			$realfile =~ s@^([^/]*)/@@ if (!$file);
2381
			$in_commit_log = 0;
2382 2383

			$p1_prefix = $1;
2384 2385
			if (!$file && $tree && $p1_prefix ne '' &&
			    -e "$root/$p1_prefix") {
2386 2387
				WARN("PATCH_PREFIX",
				     "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2388
			}
2389

2390
			if ($realfile =~ m@^include/asm/@) {
2391 2392
				ERROR("MODIFIED_INCLUDE_ASM",
				      "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2393
			}
2394 2395 2396
			$found_file = 1;
		}

2397 2398 2399 2400
#make up the handle for any error we report on this line
		if ($showfile) {
			$prefix = "$realfile:$realline: "
		} elsif ($emacs) {
2401 2402 2403 2404 2405
			if ($file) {
				$prefix = "$filename:$realline: ";
			} else {
				$prefix = "$filename:$linenr: ";
			}
2406 2407
		}

2408
		if ($found_file) {
2409 2410 2411 2412
			if (is_maintained_obsolete($realfile)) {
				WARN("OBSOLETE",
				     "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy.  No unnecessary modifications please.\n");
			}
2413
			if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
2414 2415 2416 2417
				$check = 1;
			} else {
				$check = $check_orig;
			}
2418 2419 2420
			next;
		}

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

2423 2424 2425
		my $hereline = "$here\n$rawline\n";
		my $herecurr = "$here\n$rawline\n";
		my $hereprev = "$here\n$prevrawline\n$rawline\n";
2426

2427 2428
		$cnt_lines++ if ($realcnt != 0);

2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439
# Check if the commit log has what seems like a diff which can confuse patch
		if ($in_commit_log && !$commit_log_has_diff &&
		    (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
		      $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
		     $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
		     $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
			ERROR("DIFF_IN_COMMIT_MSG",
			      "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
			$commit_log_has_diff = 1;
		}

2440 2441 2442
# Check for incorrect file permissions
		if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
			my $permhere = $here . "FILE: $realfile\n";
2443 2444
			if ($realfile !~ m@scripts/@ &&
			    $realfile !~ /\.(py|pl|awk|sh)$/) {
2445 2446
				ERROR("EXECUTE_PERMISSIONS",
				      "do not set execute permissions for source files\n" . $permhere);
2447 2448 2449
			}
		}

2450
# Check the patch for a signoff:
2451
		if ($line =~ /^\s*signed-off-by:/i) {
2452
			$signoff++;
2453
			$in_commit_log = 0;
2454 2455
		}

2456 2457 2458 2459 2460 2461
# Check if MAINTAINERS is being updated.  If so, there's probably no need to
# emit the "does MAINTAINERS need updating?" message on file add/move/delete
		if ($line =~ /^\s*MAINTAINERS\s*\|/) {
			$reported_maintainer_file = 1;
		}

2462
# Check signature styles
2463
		if (!$in_header_lines &&
2464
		    $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2465 2466 2467 2468 2469 2470
			my $space_before = $1;
			my $sign_off = $2;
			my $space_after = $3;
			my $email = $4;
			my $ucfirst_sign_off = ucfirst(lc($sign_off));

2471 2472 2473 2474
			if ($sign_off !~ /$signature_tags/) {
				WARN("BAD_SIGN_OFF",
				     "Non-standard signature: $sign_off\n" . $herecurr);
			}
2475
			if (defined $space_before && $space_before ne "") {
2476 2477 2478
				if (WARN("BAD_SIGN_OFF",
					 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
				    $fix) {
2479
					$fixed[$fixlinenr] =
2480 2481
					    "$ucfirst_sign_off $email";
				}
2482 2483
			}
			if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2484 2485 2486
				if (WARN("BAD_SIGN_OFF",
					 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
				    $fix) {
2487
					$fixed[$fixlinenr] =
2488 2489 2490
					    "$ucfirst_sign_off $email";
				}

2491 2492
			}
			if (!defined $space_after || $space_after ne " ") {
2493 2494 2495
				if (WARN("BAD_SIGN_OFF",
					 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
				    $fix) {
2496
					$fixed[$fixlinenr] =
2497 2498
					    "$ucfirst_sign_off $email";
				}
2499
			}
2500 2501 2502 2503

			my ($email_name, $email_address, $comment) = parse_email($email);
			my $suggested_email = format_email(($email_name, $email_address));
			if ($suggested_email eq "") {
2504 2505
				ERROR("BAD_SIGN_OFF",
				      "Unrecognized email address: '$email'\n" . $herecurr);
2506 2507 2508 2509 2510 2511 2512 2513 2514
			} 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) {
2515 2516
					WARN("BAD_SIGN_OFF",
					     "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2517
				}
2518
			}
2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529

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

2532 2533 2534 2535 2536 2537 2538
# Check email subject for common tools that don't need to be mentioned
		if ($in_header_lines &&
		    $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
			WARN("EMAIL_SUBJECT",
			     "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
		}

2539 2540 2541 2542 2543 2544
# 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);
		}

2545 2546 2547 2548 2549 2550
# 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);
		}

2551 2552 2553 2554 2555 2556 2557 2558 2559 2560
# Check if the commit log is in a possible stack dump
		if ($in_commit_log && !$commit_log_possible_stack_dump &&
		    ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
		     $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
					# timestamp
		     $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
					# stack dump address
			$commit_log_possible_stack_dump = 1;
		}

2561 2562
# Check for line lengths > 75 in commit log, warn once
		if ($in_commit_log && !$commit_log_long_line &&
2563 2564 2565 2566 2567 2568 2569 2570
		    length($line) > 75 &&
		    !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
					# file delta changes
		      $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
					# filename then :
		      $line =~ /^\s*(?:Fixes:|Link:)/i ||
					# A Fixes: or Link: line
		      $commit_log_possible_stack_dump)) {
2571 2572 2573 2574 2575
			WARN("COMMIT_LOG_LONG_LINE",
			     "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
			$commit_log_long_line = 1;
		}

2576
# Reset possible stack dump if a blank line is found
2577 2578 2579 2580
		if ($in_commit_log && $commit_log_possible_stack_dump &&
		    $line =~ /^\s*$/) {
			$commit_log_possible_stack_dump = 0;
		}
2581

2582
# Check for git id commit length and improperly formed commit descriptions
2583
		if ($in_commit_log && !$commit_log_possible_stack_dump &&
2584
		    $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
2585
		    $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
2586
		    ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
2587
		     ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
2588 2589
		      $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
		      $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
2590 2591
			my $init_char = "c";
			my $orig_commit = "";
2592 2593 2594 2595 2596
			my $short = 1;
			my $long = 0;
			my $case = 1;
			my $space = 1;
			my $hasdesc = 0;
2597
			my $hasparens = 0;
2598 2599 2600 2601
			my $id = '0123456789ab';
			my $orig_desc = "commit description";
			my $description = "";

2602 2603 2604 2605 2606 2607 2608
			if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
				$init_char = $1;
				$orig_commit = lc($2);
			} elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
				$orig_commit = lc($1);
			}

2609 2610 2611 2612 2613 2614
			$short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
			$long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
			$space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
			$case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
			if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
				$orig_desc = $1;
2615
				$hasparens = 1;
2616 2617 2618 2619
			} elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
				 defined $rawlines[$linenr] &&
				 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
				$orig_desc = $1;
2620
				$hasparens = 1;
2621 2622 2623 2624 2625 2626 2627
			} elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
				 defined $rawlines[$linenr] &&
				 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
				$line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
				$orig_desc = $1;
				$rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
				$orig_desc .= " " . $1;
2628
				$hasparens = 1;
2629 2630 2631 2632 2633
			}

			($id, $description) = git_commit_info($orig_commit,
							      $id, $orig_desc);

2634 2635
			if (defined($id) &&
			   ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
2636 2637 2638
				ERROR("GIT_COMMIT_ID",
				      "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
			}
2639 2640
		}

2641 2642 2643 2644 2645 2646
# Check for added, moved or deleted files
		if (!$reported_maintainer_file && !$in_commit_log &&
		    ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
		     $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
		     ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
		      (defined($1) || defined($2))))) {
2647
			$is_patch = 1;
2648 2649 2650 2651 2652
			$reported_maintainer_file = 1;
			WARN("FILE_PATH_CHANGES",
			     "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
		}

2653
# Check for wrappage within a valid hunk of the file
2654
		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2655 2656
			ERROR("CORRUPTED_PATCH",
			      "patch seems to be corrupt (line wrapped?)\n" .
2657
				$herecurr) if (!$emitted_corrupt++);
2658 2659 2660 2661
		}

# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2662 2663 2664 2665 2666 2667 2668
		    $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";

2669 2670
			CHK("INVALID_UTF8",
			    "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2671 2672
		}

2673 2674 2675
# 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 =~ /^$/ &&
2676 2677
		    !($rawline =~ /^\s+(?:\S|$)/ ||
		      $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
2678 2679
			$in_header_lines = 0;
			$in_commit_log = 1;
2680
			$has_commit_log = 1;
2681 2682
		}

2683 2684 2685 2686 2687 2688 2689 2690 2691
# 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 =~ /^$/ &&
2692
		    $rawline =~ /$NON_ASCII_UTF8/) {
2693
			WARN("UTF8_BEFORE_PATCH",
2694 2695 2696
			    "8-bit UTF-8 used in possible commit log\n" . $herecurr);
		}

2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710
# Check for absolute kernel paths in commit message
		if ($tree && $in_commit_log) {
			while ($line =~ m{(?:^|\s)(/\S*)}g) {
				my $file = $1;

				if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
				    check_absolute_file($1, $herecurr)) {
					#
				} else {
					check_absolute_file($file, $herecurr);
				}
			}
		}

2711
# Check for various typo / spelling mistakes
2712 2713
		if (defined($misspellings) &&
		    ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
2714
			while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
2715 2716 2717 2718
				my $typo = $1;
				my $typo_fix = $spelling_fix{lc($typo)};
				$typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
				$typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2719 2720 2721 2722
				my $msg_level = \&WARN;
				$msg_level = \&CHK if ($file);
				if (&{$msg_level}("TYPO_SPELLING",
						  "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2723 2724 2725 2726 2727 2728
				    $fix) {
					$fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
				}
			}
		}

2729 2730
# ignore non-hunk lines and lines being removed
		next if (!$hunk_line || $line =~ /^-/);
2731 2732

#trailing whitespace
2733
		if ($line =~ /^\+.*\015/) {
2734
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2735 2736 2737
			if (ERROR("DOS_LINE_ENDINGS",
				  "DOS line endings\n" . $herevet) &&
			    $fix) {
2738
				$fixed[$fixlinenr] =~ s/[\s\015]+$//;
2739
			}
2740 2741
		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2742 2743 2744
			if (ERROR("TRAILING_WHITESPACE",
				  "trailing whitespace\n" . $herevet) &&
			    $fix) {
2745
				$fixed[$fixlinenr] =~ s/\s+$//;
2746 2747
			}

2748
			$rpt_cleaners = 1;
2749
		}
2750

2751
# Check for FSF mailing addresses.
2752
		if ($rawline =~ /\bwrite to the Free/i ||
2753
		    $rawline =~ /\b675\s+Mass\s+Ave/i ||
2754 2755
		    $rawline =~ /\b59\s+Temple\s+Pl/i ||
		    $rawline =~ /\b51\s+Franklin\s+St/i) {
2756
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2757 2758 2759 2760
			my $msg_level = \&ERROR;
			$msg_level = \&CHK if ($file);
			&{$msg_level}("FSF_MAILING_ADDRESS",
				      "Do not include the paragraph about writing to the Free Software Foundation's mailing address from the sample GPL notice. The FSF has changed addresses in the past, and may do so again. Linux already includes a copy of the GPL.\n" . $herevet)
2761 2762
		}

2763
# check for Kconfig help text having a real description
2764 2765
# Only applies when adding the entry originally, after that we do not have
# sufficient context to determine whether it is indeed long enough.
2766
		if ($realfile =~ /Kconfig/ &&
2767
		    $line =~ /^\+\s*config\s+/) {
2768
			my $length = 0;
2769 2770 2771
			my $cnt = $realcnt;
			my $ln = $linenr + 1;
			my $f;
2772
			my $is_start = 0;
2773
			my $is_end = 0;
2774
			for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2775 2776 2777 2778 2779
				$f = $lines[$ln - 1];
				$cnt-- if ($lines[$ln - 1] !~ /^-/);
				$is_end = $lines[$ln - 1] =~ /^\+/;

				next if ($f =~ /^-/);
2780
				last if (!$file && $f =~ /^\@\@/);
2781

2782
				if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
2783
					$is_start = 1;
2784
				} elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
2785 2786 2787
					$length = -1;
				}

2788
				$f =~ s/^.//;
2789 2790 2791
				$f =~ s/#.*//;
				$f =~ s/^\s+//;
				next if ($f =~ /^$/);
2792 2793 2794 2795
				if ($f =~ /^\s*config\s/) {
					$is_end = 1;
					last;
				}
2796 2797
				$length++;
			}
2798 2799 2800 2801
			if ($is_start && $is_end && $length < $min_conf_desc_length) {
				WARN("CONFIG_DESCRIPTION",
				     "please write a paragraph that describes the config symbol fully\n" . $herecurr);
			}
2802
			#print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2803 2804
		}

2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815
# check for MAINTAINERS entries that don't have the right form
		if ($realfile =~ /^MAINTAINERS$/ &&
		    $rawline =~ /^\+[A-Z]:/ &&
		    $rawline !~ /^\+[A-Z]:\t\S/) {
			if (WARN("MAINTAINERS_STYLE",
				 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
			    $fix) {
				$fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
			}
		}

2816 2817 2818 2819 2820 2821 2822
# discourage the use of boolean for type definition attributes of Kconfig options
		if ($realfile =~ /Kconfig/ &&
		    $line =~ /^\+\s*\bboolean\b/) {
			WARN("CONFIG_TYPE_BOOLEAN",
			     "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
		}

2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836
		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});
		}

2837
# check for DT compatible documentation
2838 2839 2840 2841
		if (defined $root &&
			(($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
			 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {

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

2844 2845 2846
			my $dt_path = $root . "/Documentation/devicetree/bindings/";
			my $vp_file = $dt_path . "vendor-prefixes.txt";

2847 2848
			foreach my $compat (@compats) {
				my $compat2 = $compat;
2849 2850 2851 2852
				$compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
				my $compat3 = $compat;
				$compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
				`grep -Erq "$compat|$compat2|$compat3" $dt_path`;
2853 2854 2855 2856 2857
				if ( $? >> 8 ) {
					WARN("UNDOCUMENTED_DT_STRING",
					     "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
				}

2858 2859
				next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
				my $vendor = $1;
2860
				`grep -Eq "^$vendor\\b" $vp_file`;
2861 2862
				if ( $? >> 8 ) {
					WARN("UNDOCUMENTED_DT_STRING",
2863
					     "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2864 2865 2866 2867
				}
			}
		}

2868
# check we are in a valid source file if not then ignore this hunk
2869
		next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
2870

2871 2872 2873 2874 2875 2876 2877 2878
# line length limit (with some exclusions)
#
# There are a few types of lines that may extend beyond $max_line_length:
#	logging functions like pr_info that end in a string
#	lines with a single string
#	#defines that are a single string
#
# There are 3 different line length message types:
J
Jean Delvare 已提交
2879
# LONG_LINE_COMMENT	a comment starts before but extends beyond $max_line_length
2880 2881 2882 2883 2884 2885
# LONG_LINE_STRING	a string starts before but extends beyond $max_line_length
# LONG_LINE		all other lines longer than $max_line_length
#
# if LONG_LINE is ignored, the other 2 types are also ignored
#

2886
		if ($line =~ /^\+/ && $length > $max_line_length) {
2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902
			my $msg_type = "LONG_LINE";

			# Check the allowed long line types first

			# logging functions that end in a string that starts
			# before $max_line_length
			if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
			    length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
				$msg_type = "";

			# lines with only strings (w/ possible termination)
			# #defines with only strings
			} elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
				 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
				$msg_type = "";

2903 2904 2905 2906
			# EFI_GUID is another special case
			} elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/) {
				$msg_type = "";

2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924
			# Otherwise set the alternate message types

			# a comment starts before $max_line_length
			} elsif ($line =~ /($;[\s$;]*)$/ &&
				 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
				$msg_type = "LONG_LINE_COMMENT"

			# a quoted string starts before $max_line_length
			} elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
				 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
				$msg_type = "LONG_LINE_STRING"
			}

			if ($msg_type ne "" &&
			    (show_type("LONG_LINE") || show_type($msg_type))) {
				WARN($msg_type,
				     "line over $max_line_length characters\n" . $herecurr);
			}
2925 2926
		}

2927 2928
# check for adding lines without a newline.
		if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2929 2930
			WARN("MISSING_EOF_NEWLINE",
			     "adding a line without newline at end of file\n" . $herecurr);
2931 2932
		}

2933 2934 2935 2936
# 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";
2937 2938
				ERROR("LO_MACRO",
				      "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2939 2940 2941
			}
			if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
				my $herevet = "$here\n" . cat_vet($line) . "\n";
2942 2943
				ERROR("HI_MACRO",
				      "use the HI() macro, not (... >> 16)\n" . $herevet);
2944 2945 2946
			}
		}

2947
# check we are in a valid source file C or perl if not then ignore this hunk
2948
		next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
2949 2950 2951

# at the beginning of a line any tabs must come first and anything
# more than 8 must use tabs.
2952 2953 2954
		if ($rawline =~ /^\+\s* \t\s*\S/ ||
		    $rawline =~ /^\+\s*        \s*/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2955
			$rpt_cleaners = 1;
2956 2957 2958
			if (ERROR("CODE_INDENT",
				  "code indent should use tabs where possible\n" . $herevet) &&
			    $fix) {
2959
				$fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2960
			}
2961 2962
		}

2963 2964 2965
# check for space before tabs.
		if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2966 2967 2968
			if (WARN("SPACE_BEFORE_TAB",
				"please, no space before tabs\n" . $herevet) &&
			    $fix) {
2969
				while ($fixed[$fixlinenr] =~
2970
					   s/(^\+.*) {8,8}\t/$1\t\t/) {}
2971
				while ($fixed[$fixlinenr] =~
2972
					   s/(^\+.*) +\t/$1\t/) {}
2973
			}
2974 2975
		}

2976 2977 2978 2979 2980 2981
# 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);
		}

2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994
# check indentation starts on a tab stop
		if ($^V && $^V ge 5.10.0 &&
		    $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) {
			my $indent = length($1);
			if ($indent % 8) {
				if (WARN("TABSTOP",
					 "Statements should start on a tabstop\n" . $herecurr) &&
				    $fix) {
					$fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
				}
			}
		}

2995 2996
# check multi-line statement indentation matches previous line
		if ($^V && $^V ge 5.10.0 &&
2997
		    $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2998 2999 3000 3001 3002 3003
			$prevline =~ /^\+(\t*)(.*)$/;
			my $oldindent = $1;
			my $rest = $2;

			my $pos = pos_last_openparen($rest);
			if ($pos >= 0) {
J
Joe Perches 已提交
3004 3005
				$line =~ /^(\+| )([ \t]*)/;
				my $newindent = $2;
3006 3007 3008 3009 3010 3011 3012 3013

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

				if ($newindent ne $goodtabindent &&
				    $newindent ne $goodspaceindent) {
3014 3015 3016 3017

					if (CHK("PARENTHESIS_ALIGNMENT",
						"Alignment should match open parenthesis\n" . $hereprev) &&
					    $fix && $line =~ /^\+/) {
3018
						$fixed[$fixlinenr] =~
3019 3020
						    s/^\+[ \t]*/\+$goodtabindent/;
					}
3021 3022 3023 3024
				}
			}
		}

3025 3026 3027 3028 3029 3030 3031 3032 3033
# check for space after cast like "(int) foo" or "(struct foo) bar"
# avoid checking a few false positives:
#   "sizeof(<type>)" or "__alignof__(<type>)"
#   function pointer declarations like "(*foo)(int) = bar;"
#   structure definitions like "(struct foo) { 0 };"
#   multiline macros that define functions
#   known attributes or the __attribute__ keyword
		if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
		    (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
3034
			if (CHK("SPACING",
3035
				"No space is necessary after a cast\n" . $herecurr) &&
3036
			    $fix) {
3037
				$fixed[$fixlinenr] =~
3038
				    s/(\(\s*$Type\s*\))[ \t]+/$1/;
3039
			}
3040 3041
		}

3042 3043
# Block comment styles
# Networking with an initial /*
3044
		if ($realfile =~ m@^(drivers/net/|net/)@ &&
3045
		    $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
3046 3047
		    $rawline =~ /^\+[ \t]*\*/ &&
		    $realline > 2) {
3048 3049 3050 3051
			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
			     "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
		}

3052 3053 3054
# Block comments use * on subsequent lines
		if ($prevline =~ /$;[ \t]*$/ &&			#ends in comment
		    $prevrawline =~ /^\+.*?\/\*/ &&		#starting /*
3055
		    $prevrawline !~ /\*\/[ \t]*$/ &&		#no trailing */
3056
		    $rawline =~ /^\+/ &&			#line is new
3057
		    $rawline !~ /^\+[ \t]*\*/) {		#no leading *
3058 3059
			WARN("BLOCK_COMMENT_STYLE",
			     "Block comments use * on subsequent lines\n" . $hereprev);
3060 3061
		}

3062 3063
# Block comments use */ on trailing lines
		if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ &&	#trailing */
3064 3065 3066
		    $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ &&	#inline /*...*/
		    $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ &&	#trailing **/
		    $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) {	#non blank */
3067 3068
			WARN("BLOCK_COMMENT_STYLE",
			     "Block comments use a trailing */ on a separate line\n" . $herecurr);
3069 3070
		}

3071 3072
# Block comment * alignment
		if ($prevline =~ /$;[ \t]*$/ &&			#ends in comment
3073 3074 3075
		    $line =~ /^\+[ \t]*$;/ &&			#leading comment
		    $rawline =~ /^\+[ \t]*\*/ &&		#leading *
		    (($prevrawline =~ /^\+.*?\/\*/ &&		#leading /*
3076
		      $prevrawline !~ /\*\/[ \t]*$/) ||		#no trailing */
3077 3078
		     $prevrawline =~ /^\+[ \t]*\*/)) {		#leading *
			my $oldindent;
3079
			$prevrawline =~ m@^\+([ \t]*/?)\*@;
3080 3081 3082 3083 3084 3085
			if (defined($1)) {
				$oldindent = expand_tabs($1);
			} else {
				$prevrawline =~ m@^\+(.*/?)\*@;
				$oldindent = expand_tabs($1);
			}
3086 3087 3088
			$rawline =~ m@^\+([ \t]*)\*@;
			my $newindent = $1;
			$newindent = expand_tabs($newindent);
3089
			if (length($oldindent) ne length($newindent)) {
3090 3091 3092 3093 3094
				WARN("BLOCK_COMMENT_STYLE",
				     "Block comments should align the * on each line\n" . $hereprev);
			}
		}

3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106
# check for missing blank lines after struct/union declarations
# with exceptions for various attributes and macros
		if ($prevline =~ /^[\+ ]};?\s*$/ &&
		    $line =~ /^\+/ &&
		    !($line =~ /^\+\s*$/ ||
		      $line =~ /^\+\s*EXPORT_SYMBOL/ ||
		      $line =~ /^\+\s*MODULE_/i ||
		      $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
		      $line =~ /^\+[a-z_]*init/ ||
		      $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
		      $line =~ /^\+\s*DECLARE/ ||
		      $line =~ /^\+\s*__setup/)) {
3107 3108 3109
			if (CHK("LINE_SPACING",
				"Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
			    $fix) {
3110
				fix_insert_line($fixlinenr, "\+");
3111
			}
3112 3113
		}

3114 3115 3116 3117
# check for multiple consecutive blank lines
		if ($prevline =~ /^[\+ ]\s*$/ &&
		    $line =~ /^\+\s*$/ &&
		    $last_blank_line != ($linenr - 1)) {
3118 3119 3120
			if (CHK("LINE_SPACING",
				"Please don't use multiple blank lines\n" . $hereprev) &&
			    $fix) {
3121
				fix_delete_line($fixlinenr, $rawline);
3122 3123
			}

3124 3125 3126
			$last_blank_line = $linenr;
		}

3127
# check for missing blank lines after declarations
3128 3129 3130
		if ($sline =~ /^\+\s+\S/ &&			#Not at char 1
			# actual declarations
		    ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3131 3132
			# function pointer declarations
		     $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144
			# 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*[=,;:\[]/ ||
3145 3146
			# function pointer declarations
		      $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3147 3148 3149 3150 3151
			# 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
3152
		      $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
3153 3154 3155 3156 3157 3158 3159 3160
			# 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/)) {
3161 3162 3163
			if (WARN("LINE_SPACING",
				 "Missing a blank line after declarations\n" . $hereprev) &&
			    $fix) {
3164
				fix_insert_line($fixlinenr, "\+");
3165
			}
3166 3167
		}

3168
# check for spaces at the beginning of a line.
3169 3170 3171 3172
# Exceptions:
#  1) within comments
#  2) indented preprocessor commands
#  3) hanging labels
3173
		if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/)  {
3174
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3175 3176 3177
			if (WARN("LEADING_SPACE",
				 "please, no spaces at the start of a line\n" . $herevet) &&
			    $fix) {
3178
				$fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3179
			}
3180 3181
		}

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

3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195
# check if this appears to be the start function declaration, save the name
		if ($sline =~ /^\+\{\s*$/ &&
		    $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
			$context_function = $1;
		}

# check if this appears to be the end of function declaration
		if ($sline =~ /^\+\}\s*$/) {
			undef $context_function;
		}

3196
# check indentation of any line with a bare else
3197
# (but not if it is a multiple line "if (foo) return bar; else return baz;")
3198 3199 3200
# 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;
3201 3202 3203 3204
			if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
			    ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
			     defined $lines[$linenr] &&
			     $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
3205 3206 3207 3208 3209
				WARN("UNNECESSARY_ELSE",
				     "else is not generally useful after a break or return\n" . $hereprev);
			}
		}

3210 3211 3212 3213 3214 3215 3216 3217 3218 3219
# check indentation of a line with a break;
# if the previous line is a goto or return and is indented the same # of tabs
		if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
			my $tabs = $1;
			if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
				WARN("UNNECESSARY_BREAK",
				     "break is not useful after a goto or return\n" . $hereprev);
			}
		}

3220
# check for RCS/CVS revision markers
3221
		if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
3222 3223
			WARN("CVS_KEYWORD",
			     "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
3224
		}
3225

3226 3227 3228
# Blackfin: don't use __builtin_bfin_[cs]sync
		if ($line =~ /__builtin_bfin_csync/) {
			my $herevet = "$here\n" . cat_vet($line) . "\n";
3229 3230
			ERROR("CSYNC",
			      "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
3231 3232 3233
		}
		if ($line =~ /__builtin_bfin_ssync/) {
			my $herevet = "$here\n" . cat_vet($line) . "\n";
3234 3235
			ERROR("SSYNC",
			      "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
3236 3237
		}

3238 3239 3240 3241 3242 3243
# 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);
		}

3244
# Check for potential 'bare' types
3245 3246
		my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
		    $realline_next);
3247
#print "LINE<$line>\n";
3248
		if ($linenr > $suppress_statement &&
3249
		    $realcnt && $sline =~ /.\s*\S/) {
3250
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3251
				ctx_statement_block($linenr, $realcnt, 0);
3252 3253 3254
			$stat =~ s/\n./\n /g;
			$cond =~ s/\n./\n /g;

3255 3256 3257 3258 3259 3260 3261 3262 3263
#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;
			}
3264

3265 3266 3267 3268 3269 3270 3271 3272
			# 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++;
			}

3273 3274
			my $s = $stat;
			$s =~ s/{.*$//s;
3275

3276
			# Ignore goto labels.
3277
			if ($s =~ /$Ident:\*$/s) {
3278 3279

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

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

3284
			# declarations always start with types
3285
			} 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) {
3286 3287 3288 3289
				my $type = $1;
				$type =~ s/\s+/ /g;
				possible($type, "A:" . $s);

3290
			# definitions in global scope can only start with types
3291
			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
3292
				possible($1, "B:" . $s);
3293
			}
3294 3295

			# any (foo ... *) is a pointer cast, and foo is a type
3296
			while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
3297
				possible($1, "C:" . $s);
3298 3299 3300 3301 3302
			}

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

3306
				my $ctx = $s;
3307
				substr($ctx, 0, $name_len + 1, '');
3308
				$ctx =~ s/\)[^\)]*$//;
3309

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

3313
						possible($1, "D:" . $s);
3314 3315
					}
				}
3316
			}
3317

3318 3319
		}

3320 3321 3322
#
# Checks which may be anchored in the context.
#
3323

3324 3325
# Check for switch () and associated case and default
# statements should be at the same indent.
3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341
		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 '') {
3342 3343
				ERROR("SWITCH_CASE_INDENT_LEVEL",
				      "switch and case should be at the same indent\n$hereline$err");
3344 3345 3346 3347 3348
			}
		}

# 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
3349
		if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3350 3351
			my $pre_ctx = "$1$2";

3352
			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
3353 3354 3355 3356 3357 3358

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

3359 3360 3361
			my $ctx_cnt = $realcnt - $#ctx - 1;
			my $ctx = join("\n", @ctx);

3362 3363
			my $ctx_ln = $linenr;
			my $ctx_skip = $realcnt;
3364

3365 3366 3367 3368 3369
			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] !~ /^-/);
3370 3371
				$ctx_ln++;
			}
3372

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

3376
			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
3377 3378
				ERROR("OPEN_BRACE",
				      "that open brace { should be on the previous line\n" .
3379
					"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3380
			}
3381 3382 3383 3384
			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
			    $ctx =~ /\)\s*\;\s*$/ &&
			    defined $lines[$ctx_ln - 1])
			{
3385 3386
				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
				if ($nindent > $indent) {
3387 3388
					WARN("TRAILING_SEMICOLON",
					     "trailing semicolon indicates no statements, indent implies otherwise\n" .
3389
						"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3390 3391
				}
			}
3392 3393
		}

3394
# Check relative indent for conditionals and blocks.
3395
		if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3396 3397 3398
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
3399 3400 3401 3402
			my ($s, $c) = ($stat, $cond);

			substr($s, 0, length($c), '');

3403 3404 3405
			# remove inline comments
			$s =~ s/$;/ /g;
			$c =~ s/$;/ /g;
3406 3407

			# Find out how long the conditional actually is.
3408 3409
			my @newlines = ($c =~ /\n/gs);
			my $cond_lines = 1 + $#newlines;
3410

3411 3412 3413 3414 3415 3416 3417 3418
			# 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;
			while ($s =~ /\n\s+\\\n/) {
				$cond_lines += $s =~ s/\n\s+\\\n/\n/g;
			}

3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430
			# 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;
			}
3431
			if ($s =~ s/^\s*?\n//) {
3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442
				$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;
			}

3443
			my $cond_ptr = -1;
3444
			$continuation = 0;
3445 3446 3447
			while ($cond_ptr != $cond_lines) {
				$cond_ptr = $cond_lines;

3448 3449 3450 3451 3452 3453
				# If we see an #else/#elif then the code
				# is not linear.
				if ($s =~ /^\s*\#\s*(?:else|elif)/) {
					$check = 0;
				}

3454 3455 3456 3457
				# Ignore:
				#  1) blank lines, they should be at 0,
				#  2) preprocessor lines, and
				#  3) labels.
3458 3459
				if ($continuation ||
				    $s =~ /^\s*?\n/ ||
3460 3461
				    $s =~ /^\s*#\s*?/ ||
				    $s =~ /^\s*$Ident\s*:/) {
3462
					$continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
3463 3464 3465
					if ($s =~ s/^.*?\n//) {
						$cond_lines++;
					}
3466
				}
3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481
			}

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

3482
			#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";
3483

3484 3485 3486
			if ($check && $s ne '' &&
			    (($sindent % 8) != 0 ||
			     ($sindent < $indent) ||
3487 3488
			     ($sindent == $indent &&
			      ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
3489
			     ($sindent > $indent + 8))) {
3490 3491
				WARN("SUSPECT_CODE_INDENT",
				     "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3492 3493 3494
			}
		}

3495 3496
		# Track the 'values' across context and added lines.
		my $opline = $line; $opline =~ s/^./ /;
3497 3498
		my ($curr_values, $curr_vars) =
				annotate_values($opline . "\n", $prev_values);
3499
		$curr_values = $prev_values . $curr_values;
3500 3501
		if ($dbg_values) {
			my $outline = $opline; $outline =~ s/\t/ /g;
3502 3503
			print "$linenr > .$outline\n";
			print "$linenr > $curr_values\n";
3504
			print "$linenr >  $curr_vars\n";
3505
		}
3506 3507
		$prev_values = substr($curr_values, -1);

3508
#ignore lines not being added
3509
		next if ($line =~ /^[^\+]/);
3510

3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522
# check for dereferences that span multiple lines
		if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
		    $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
			$prevline =~ /($Lval\s*(?:\.|->))\s*$/;
			my $ref = $1;
			$line =~ /^.\s*($Lval)/;
			$ref .= $1;
			$ref =~ s/\s//g;
			WARN("MULTILINE_DEREFERENCE",
			     "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
		}

3523
# check for declarations of signed or unsigned without int
3524
		while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3525 3526
			my $type = $1;
			my $var = $2;
3527 3528
			$var = "" if (!defined $var);
			if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
3529 3530 3531 3532 3533 3534 3535 3536 3537
				my $sign = $1;
				my $pointer = $2;

				$pointer = "" if (!defined $pointer);

				if (WARN("UNSPECIFIED_INT",
					 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
				    $fix) {
					my $decl = trim($sign) . " int ";
3538 3539 3540 3541 3542
					my $comp_pointer = $pointer;
					$comp_pointer =~ s/\s//g;
					$decl .= $comp_pointer;
					$decl = rtrim($decl) if ($var eq "");
					$fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
3543 3544 3545 3546
				}
			}
		}

3547
# TEST: allow direct testing of the type matcher.
3548 3549
		if ($dbg_type) {
			if ($line =~ /^.\s*$Declare\s*$/) {
3550 3551
				ERROR("TEST_TYPE",
				      "TEST: is type\n" . $herecurr);
3552
			} elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3553 3554
				ERROR("TEST_NOT_TYPE",
				      "TEST: is not type ($1 is)\n". $herecurr);
3555
			}
3556 3557
			next;
		}
3558 3559
# TEST: allow direct testing of the attribute matcher.
		if ($dbg_attr) {
3560
			if ($line =~ /^.\s*$Modifier\s*$/) {
3561 3562
				ERROR("TEST_ATTR",
				      "TEST: is attr\n" . $herecurr);
3563
			} elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3564 3565
				ERROR("TEST_NOT_ATTR",
				      "TEST: is not attr ($1 is)\n". $herecurr);
3566 3567 3568
			}
			next;
		}
3569

3570
# check for initialisation to aggregates open brace on the next line
3571 3572
		if ($line =~ /^.\s*{/ &&
		    $prevline =~ /(?:^|[^=])=\s*$/) {
3573 3574
			if (ERROR("OPEN_BRACE",
				  "that open brace { should be on the previous line\n" . $hereprev) &&
3575 3576 3577
			    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
				fix_delete_line($fixlinenr - 1, $prevrawline);
				fix_delete_line($fixlinenr, $rawline);
3578 3579
				my $fixedline = $prevrawline;
				$fixedline =~ s/\s*=\s*$/ = {/;
3580
				fix_insert_line($fixlinenr, $fixedline);
3581
				$fixedline = $line;
3582
				$fixedline =~ s/^(.\s*)\{\s*/$1/;
3583
				fix_insert_line($fixlinenr, $fixedline);
3584
			}
3585 3586
		}

3587 3588 3589 3590 3591
#
# Checks which are anchored on the added line.
#

# check for malformed paths in #include statements (uses RAW line)
3592
		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3593 3594
			my $path = $1;
			if ($path =~ m{//}) {
3595
				ERROR("MALFORMED_INCLUDE",
3596 3597 3598 3599 3600
				      "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);
3601 3602
			}
		}
3603

3604
# no C99 // comments
3605
		if ($line =~ m{//}) {
3606 3607 3608
			if (ERROR("C99_COMMENTS",
				  "do not use C99 // comments\n" . $herecurr) &&
			    $fix) {
3609
				my $line = $fixed[$fixlinenr];
3610 3611
				if ($line =~ /\/\/(.*)$/) {
					my $comment = trim($1);
3612
					$fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3613 3614
				}
			}
3615
		}
3616
		# Remove C99 comments.
3617
		$line =~ s@//.*@@;
3618
		$opline =~ s@//.*@@;
3619

3620 3621 3622 3623 3624 3625 3626 3627
# 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.*\((.*)\)/)) {
3628 3629 3630 3631
			# Handle definitions which produce identifiers with
			# a prefix:
			#   XXX(foo);
			#   EXPORT_SYMBOL(something_foo);
3632
			my $name = $1;
3633
			if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3634 3635 3636 3637 3638
			    $name =~ /^${Ident}_$2/) {
#print "FOO C name<$name>\n";
				$suppress_export{$realline_next} = 1;

			} elsif ($stat !~ /(?:
3639
				\n.}\s*$|
3640 3641 3642
				^.DEFINE_$Ident\(\Q$name\E\)|
				^.DECLARE_$Ident\(\Q$name\E\)|
				^.LIST_HEAD\(\Q$name\E\)|
3643 3644
				^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
				\b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
3645
			    )/x) {
3646 3647 3648 3649
#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
				$suppress_export{$realline_next} = 2;
			} else {
				$suppress_export{$realline_next} = 1;
3650 3651
			}
		}
3652 3653 3654 3655 3656 3657 3658 3659 3660
		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) {
3661 3662
			WARN("EXPORT_SYMBOL",
			     "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3663
		}
3664

3665
# check for global initialisers.
3666
		if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
3667
			if (ERROR("GLOBAL_INITIALISERS",
3668
				  "do not initialise globals to $1\n" . $herecurr) &&
3669
			    $fix) {
3670
				$fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
3671
			}
3672
		}
3673
# check for static initialisers.
3674
		if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
3675
			if (ERROR("INITIALISED_STATIC",
3676
				  "do not initialise statics to $1\n" .
3677 3678
				      $herecurr) &&
			    $fix) {
3679
				$fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
3680
			}
3681 3682
		}

3683 3684 3685 3686 3687 3688 3689
# check for misordered declarations of char/short/int/long with signed/unsigned
		while ($sline =~ m{(\b$TypeMisordered\b)}g) {
			my $tmp = trim($1);
			WARN("MISORDERED_TYPE",
			     "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
		}

3690 3691
# check for static const char * arrays.
		if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3692 3693
			WARN("STATIC_CONST_CHAR_ARRAY",
			     "static const char * array should probably be static const char * const\n" .
3694 3695 3696 3697 3698
				$herecurr);
               }

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

3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715
# check for const <foo> const where <foo> is not a pointer or array type
		if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
			my $found = $1;
			if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
				WARN("CONST_CONST",
				     "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
			} elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
				WARN("CONST_CONST",
				     "'const $found const' should probably be 'const $found'\n" . $herecurr);
			}
		}

3716 3717 3718 3719 3720 3721 3722
# 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);
               }

3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735
# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
		if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
			my $array = $1;
			if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
				my $array_div = $1;
				if (WARN("ARRAY_SIZE",
					 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
				    $fix) {
					$fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
				}
			}
		}

3736 3737 3738 3739 3740
# 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) {
3741
				$fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
3742 3743 3744
			}
		}

3745 3746 3747
# check for new typedefs, only function parameters and sparse annotations
# make sense.
		if ($line =~ /\btypedef\s/ &&
3748
		    $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
3749
		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
3750
		    $line !~ /\b$typeTypedefs\b/ &&
3751
		    $line !~ /\b__bitwise\b/) {
3752 3753
			WARN("NEW_TYPEDEFS",
			     "do not add new typedefs\n" . $herecurr);
3754 3755 3756
		}

# * goes on variable not on type
3757
		# (char*[ const])
3758 3759
		while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
			#print "AA<$1>\n";
3760
			my ($ident, $from, $to) = ($1, $2, $2);
3761 3762 3763 3764 3765 3766

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

3770
##			print "1: from<$from> to<$to> ident<$ident>\n";
3771
			if ($from ne $to) {
3772 3773 3774 3775 3776 3777
				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/;
3778
					$fixed[$fixlinenr] =~
3779 3780
					    s@\Q$sub_from\E@$sub_to@;
				}
3781
			}
3782 3783 3784
		}
		while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
			#print "BB<$1>\n";
3785
			my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
3786 3787 3788 3789 3790 3791

			# Should start with a space.
			$to =~ s/^(\S)/ $1/;
			# Should not end with a space.
			$to =~ s/\s+$//;
			# '*'s should not have spaces between.
3792
			while ($to =~ s/\*\s+\*/\*\*/) {
3793 3794 3795
			}
			# Modifiers should have spaces.
			$to =~ s/(\b$Modifier$)/$1 /;
3796

3797
##			print "2: from<$from> to<$to> ident<$ident>\n";
3798
			if ($from ne $to && $ident !~ /^$Modifier$/) {
3799 3800 3801 3802 3803 3804 3805
				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/;
3806
					$fixed[$fixlinenr] =~
3807 3808
					    s@\Q$sub_from\E@$sub_to@;
				}
3809
			}
3810 3811
		}

3812 3813
# avoid BUG() or BUG_ON()
		if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3814 3815 3816 3817
			my $msg_level = \&WARN;
			$msg_level = \&CHK if ($file);
			&{$msg_level}("AVOID_BUG",
				      "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3818
		}
3819

3820
# avoid LINUX_VERSION_CODE
3821
		if ($line =~ /\bLINUX_VERSION_CODE\b/) {
3822 3823
			WARN("LINUX_VERSION_CODE",
			     "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3824 3825
		}

3826 3827
# check for uses of printk_ratelimit
		if ($line =~ /\bprintk_ratelimit\s*\(/) {
3828
			WARN("PRINTK_RATELIMITED",
3829
			     "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
3830 3831
		}

3832 3833 3834
# 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 已提交
3835
# printk includes all preceding printk's which have no newline on the end.
3836
# we assume the first bad printk is the one to report.
3837
		if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
3838 3839 3840
			my $ok = 0;
			for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
				#print "CHECK<$lines[$ln - 1]\n";
L
Lucas De Marchi 已提交
3841
				# we have a preceding printk if it ends
3842 3843 3844 3845 3846 3847 3848 3849 3850
				# 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) {
3851 3852
				WARN("PRINTK_WITHOUT_KERN_LEVEL",
				     "printk() should include KERN_ facility level\n" . $herecurr);
3853
			}
3854 3855
		}

3856 3857 3858 3859
		if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
			my $orig = $1;
			my $level = lc($orig);
			$level = "warn" if ($level eq "warning");
3860 3861
			my $level2 = $level;
			$level2 = "dbg" if ($level eq "debug");
3862
			WARN("PREFER_PR_LEVEL",
3863
			     "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(...  to printk(KERN_$orig ...\n" . $herecurr);
3864 3865 3866
		}

		if ($line =~ /\bpr_warning\s*\(/) {
3867 3868 3869
			if (WARN("PREFER_PR_LEVEL",
				 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
			    $fix) {
3870
				$fixed[$fixlinenr] =~
3871 3872
				    s/\bpr_warning\b/pr_warn/;
			}
3873 3874
		}

3875 3876 3877 3878 3879 3880 3881 3882 3883
		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);
		}

3884 3885 3886 3887 3888 3889 3890 3891
# ENOSYS means "bad syscall nr" and nothing else.  This will have a small
# number of false positives, but assembly files are not checked, so at
# least the arch entry code will not trigger this warning.
		if ($line =~ /\bENOSYS\b/) {
			WARN("ENOSYS",
			     "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
		}

3892 3893
# function brace can't be on same line, except for #defines of do while,
# or if closed on same line
3894
		if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
3895
		    !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909
			if (ERROR("OPEN_BRACE",
				  "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
			    $fix) {
				fix_delete_line($fixlinenr, $rawline);
				my $fixed_line = $rawline;
				$fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
				my $line1 = $1;
				my $line2 = $2;
				fix_insert_line($fixlinenr, ltrim($line1));
				fix_insert_line($fixlinenr, "\+{");
				if ($line2 !~ /^\s*$/) {
					fix_insert_line($fixlinenr, "\+\t" . trim($line2));
				}
			}
3910
		}
3911

3912 3913 3914
# 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*$/) {
3915 3916 3917 3918 3919 3920 3921 3922
			if (ERROR("OPEN_BRACE",
				  "open brace '{' following $1 go on the same line\n" . $hereprev) &&
			    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
				fix_delete_line($fixlinenr - 1, $prevrawline);
				fix_delete_line($fixlinenr, $rawline);
				my $fixedline = rtrim($prevrawline) . " {";
				fix_insert_line($fixlinenr, $fixedline);
				$fixedline = $rawline;
3923
				$fixedline =~ s/^(.\s*)\{\s*/$1\t/;
3924 3925 3926 3927
				if ($fixedline !~ /^\+\s*$/) {
					fix_insert_line($fixlinenr, $fixedline);
				}
			}
3928 3929
		}

3930
# missing space after union, struct or enum definition
3931 3932 3933 3934
		if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
			if (WARN("SPACING",
				 "missing space after $1 definition\n" . $herecurr) &&
			    $fix) {
3935
				$fixed[$fixlinenr] =~
3936 3937
				    s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
			}
3938 3939
		}

3940 3941 3942
# Function pointer declarations
# check spacing between type, funcptr, and args
# canonical declaration is "type (*funcptr)(args...)"
3943
		if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
3944 3945 3946 3947 3948 3949 3950
			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;

3951 3952 3953 3954 3955 3956 3957 3958 3959
# 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 =~ /^$/) {
3960 3961
				WARN("SPACING",
				     "missing space after return type\n" . $herecurr);
3962
				$post_declare_space = " ";
3963 3964 3965
			}

# unnecessary space "type  (*funcptr)(args...)"
3966 3967 3968 3969 3970 3971 3972 3973 3974
# 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);
#			}
3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004

# 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) {
4005
				$fixed[$fixlinenr] =~
4006
				    s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4007 4008 4009
			}
		}

4010 4011
# check for spacing round square brackets; allowed:
#  1. with a type on the left -- int [] a;
4012 4013
#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
#  3. inside a curly brace -- = { [0...10] = 5 }
4014 4015 4016
		while ($line =~ /(.*?\s)\[/g) {
			my ($where, $prefix) = ($-[1], $1);
			if ($prefix !~ /$Type\s+$/ &&
4017
			    ($where != 0 || $prefix !~ /^.\s+$/) &&
4018
			    $prefix !~ /[{,]\s+$/) {
4019 4020 4021
				if (ERROR("BRACKET_SPACE",
					  "space prohibited before open square bracket '['\n" . $herecurr) &&
				    $fix) {
4022
				    $fixed[$fixlinenr] =~
4023 4024
					s/^(\+.*?)\s+\[/$1\[/;
				}
4025 4026 4027
			}
		}

4028
# check for spaces between functions and their parentheses.
4029
		while ($line =~ /($Ident)\s+\(/g) {
4030
			my $name = $1;
4031 4032
			my $ctx_before = substr($line, 0, $-[1]);
			my $ctx = "$ctx_before$name";
4033 4034

			# Ignore those directives where spaces _are_ permitted.
4035 4036 4037 4038 4039 4040
			if ($name =~ /^(?:
				if|for|while|switch|return|case|
				volatile|__volatile__|
				__attribute__|format|__extension__|
				asm|__asm__)$/x)
			{
4041 4042 4043
			# 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.
4044
			} elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
4045 4046

			# cpp #elif statement condition may start with a (
4047
			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
4048 4049 4050

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

			} else {
4054 4055 4056
				if (WARN("SPACING",
					 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
					     $fix) {
4057
					$fixed[$fixlinenr] =~
4058 4059
					    s/\b$name\s+\(/$name\(/;
				}
4060
			}
4061
		}
4062

4063
# Check operator spacing.
4064
		if (!($line=~/\#\s*include/)) {
4065 4066 4067
			my $fixed_line = "";
			my $line_fixed = 0;

4068 4069 4070 4071
			my $ops = qr{
				<<=|>>=|<=|>=|==|!=|
				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
				=>|->|<<|>>|<|>|=|!|~|
4072
				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
4073
				\?:|\?|:
4074
			}x;
4075
			my @elements = split(/($ops|;)/, $opline);
4076 4077 4078 4079 4080 4081 4082

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

			my @fix_elements = ();
4083
			my $off = 0;
4084

4085 4086 4087 4088 4089 4090 4091
			foreach my $el (@elements) {
				push(@fix_elements, substr($rawline, $off, length($el)));
				$off += length($el);
			}

			$off = 0;

4092
			my $blank = copy_spacing($opline);
4093
			my $last_after = -1;
4094

4095
			for (my $n = 0; $n < $#elements; $n += 2) {
4096 4097 4098 4099 4100

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

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

4101 4102
				$off += length($elements[$n]);

L
Lucas De Marchi 已提交
4103
				# Pick up the preceding and succeeding characters.
4104 4105 4106 4107 4108 4109 4110
				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";

4111 4112 4113
				my $a = '';
				$a = 'V' if ($elements[$n] ne '');
				$a = 'W' if ($elements[$n] =~ /\s$/);
4114
				$a = 'C' if ($elements[$n] =~ /$;$/);
4115 4116
				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
				$a = 'O' if ($elements[$n] eq '');
4117
				$a = 'E' if ($ca =~ /^\s*$/);
4118

4119
				my $op = $elements[$n + 1];
4120 4121

				my $c = '';
4122
				if (defined $elements[$n + 2]) {
4123 4124
					$c = 'V' if ($elements[$n + 2] ne '');
					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
4125
					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
4126 4127
					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
					$c = 'O' if ($elements[$n + 2] eq '');
4128
					$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
4129 4130
				} else {
					$c = 'E';
4131 4132
				}

4133 4134 4135 4136
				my $ctx = "${a}x${c}";

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

4137
				my $ptr = substr($blank, 0, $off) . "^";
4138
				my $hereptr = "$hereline$ptr\n";
4139

4140
				# Pull out the value of this operator.
4141
				my $op_type = substr($curr_values, $off + 1, 1);
4142

4143 4144 4145
				# Get the full operator variant.
				my $opv = $op . substr($curr_vars, $off, 1);

4146 4147
				# Ignore operators passed as parameters.
				if ($op_type ne 'V' &&
4148
				    $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
4149

4150 4151
#				# Ignore comments
#				} elsif ($op =~ /^$;+$/) {
4152

4153
				# ; should have either the end of line or a space or \ after it
4154
				} elsif ($op eq ';') {
4155 4156
					if ($ctx !~ /.x[WEBC]/ &&
					    $cc !~ /^\\/ && $cc !~ /^;/) {
4157 4158
						if (ERROR("SPACING",
							  "space required after that '$op' $at\n" . $hereptr)) {
4159
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4160 4161
							$line_fixed = 1;
						}
4162 4163 4164 4165
					}

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

4167 4168 4169 4170
				#   :   when part of a bitfield
				} elsif ($opv eq ':B') {
					# skip the bitfield test for now

4171 4172
				# No spaces for:
				#   ->
4173
				} elsif ($op eq '->') {
4174
					if ($ctx =~ /Wx.|.xW/) {
4175 4176
						if (ERROR("SPACING",
							  "spaces prohibited around that '$op' $at\n" . $hereptr)) {
4177
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4178 4179 4180
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
4181
							$line_fixed = 1;
4182
						}
4183 4184
					}

4185
				# , must not have a space before and must have a space on the right.
4186
				} elsif ($op eq ',') {
4187 4188 4189 4190 4191 4192 4193 4194 4195
					my $rtrim_before = 0;
					my $space_after = 0;
					if ($ctx =~ /Wx./) {
						if (ERROR("SPACING",
							  "space prohibited before that '$op' $at\n" . $hereptr)) {
							$line_fixed = 1;
							$rtrim_before = 1;
						}
					}
4196
					if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
4197 4198 4199
						if (ERROR("SPACING",
							  "space required after that '$op' $at\n" . $hereptr)) {
							$line_fixed = 1;
4200
							$last_after = $n;
4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211
							$space_after = 1;
						}
					}
					if ($rtrim_before || $space_after) {
						if ($rtrim_before) {
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
						} else {
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
						}
						if ($space_after) {
							$good .= " ";
4212
						}
4213 4214
					}

4215
				# '*' as part of a type definition -- reported already.
4216
				} elsif ($opv eq '*_') {
4217 4218 4219 4220 4221 4222
					#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 '~' ||
4223
					 $opv eq '*U' || $opv eq '-U' ||
4224
					 $opv eq '&U' || $opv eq '&&U') {
4225
					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
4226 4227
						if (ERROR("SPACING",
							  "space required before that '$op' $at\n" . $hereptr)) {
4228 4229 4230 4231
							if ($n != $last_after + 2) {
								$good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
								$line_fixed = 1;
							}
4232
						}
4233
					}
4234
					if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
4235 4236 4237
						# A unary '*' may be const

					} elsif ($ctx =~ /.xW/) {
4238 4239
						if (ERROR("SPACING",
							  "space prohibited after that '$op' $at\n" . $hereptr)) {
4240
							$good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
4241 4242 4243
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
4244
							$line_fixed = 1;
4245
						}
4246 4247 4248 4249
					}

				# unary ++ and unary -- are allowed no space on one side.
				} elsif ($op eq '++' or $op eq '--') {
4250
					if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
4251 4252
						if (ERROR("SPACING",
							  "space required one side of that '$op' $at\n" . $hereptr)) {
4253
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4254 4255
							$line_fixed = 1;
						}
4256 4257 4258
					}
					if ($ctx =~ /Wx[BE]/ ||
					    ($ctx =~ /Wx./ && $cc =~ /^;/)) {
4259 4260
						if (ERROR("SPACING",
							  "space prohibited before that '$op' $at\n" . $hereptr)) {
4261
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4262 4263
							$line_fixed = 1;
						}
4264
					}
4265
					if ($ctx =~ /ExW/) {
4266 4267
						if (ERROR("SPACING",
							  "space prohibited after that '$op' $at\n" . $hereptr)) {
4268
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4269 4270 4271
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
4272
							$line_fixed = 1;
4273
						}
4274
					}
4275 4276

				# << and >> may either have or not have spaces both sides
4277 4278 4279
				} elsif ($op eq '<<' or $op eq '>>' or
					 $op eq '&' or $op eq '^' or $op eq '|' or
					 $op eq '+' or $op eq '-' or
4280 4281
					 $op eq '*' or $op eq '/' or
					 $op eq '%')
4282
				{
4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298
					if ($check) {
						if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
							if (CHK("SPACING",
								"spaces preferred around that '$op' $at\n" . $hereptr)) {
								$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
								$fix_elements[$n + 2] =~ s/^\s+//;
								$line_fixed = 1;
							}
						} elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
							if (CHK("SPACING",
								"space preferred before that '$op' $at\n" . $hereptr)) {
								$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
								$line_fixed = 1;
							}
						}
					} elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
4299 4300
						if (ERROR("SPACING",
							  "need consistent spacing around '$op' $at\n" . $hereptr)) {
4301 4302 4303 4304
							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
4305 4306
							$line_fixed = 1;
						}
4307 4308
					}

4309 4310 4311 4312
				# 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./) {
4313 4314
						if (ERROR("SPACING",
							  "space prohibited before that '$op' $at\n" . $hereptr)) {
4315
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4316 4317
							$line_fixed = 1;
						}
4318 4319
					}

4320
				# All the others need spaces both sides.
4321
				} elsif ($ctx !~ /[EWC]x[CWE]/) {
4322 4323
					my $ok = 0;

4324
					# Ignore email addresses <foo@bar>
4325 4326 4327 4328 4329 4330 4331 4332
					if (($op eq '<' &&
					     $cc =~ /^\S+\@\S+>/) ||
					    ($op eq '>' &&
					     $ca =~ /<\S+\@\S+$/))
					{
					    	$ok = 1;
					}

4333 4334 4335 4336 4337 4338 4339 4340
					# for asm volatile statements
					# ignore a colon with another
					# colon immediately before or after
					if (($op eq ':') &&
					    ($ca =~ /:$/ || $cc =~ /^:/)) {
						$ok = 1;
					}

4341
					# messages are ERROR, but ?: are CHK
4342
					if ($ok == 0) {
4343 4344
						my $msg_level = \&ERROR;
						$msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4345

4346 4347
						if (&{$msg_level}("SPACING",
								  "spaces required around that '$op' $at\n" . $hereptr)) {
4348 4349 4350 4351
							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
4352 4353
							$line_fixed = 1;
						}
4354
					}
4355
				}
4356
				$off += length($elements[$n + 1]);
4357 4358 4359 4360 4361 4362 4363 4364

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

				$fixed_line = $fixed_line . $good;
			}

			if (($#elements % 2) == 0) {
				$fixed_line = $fixed_line . $fix_elements[$#elements];
4365
			}
4366

4367 4368
			if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
				$fixed[$fixlinenr] = $fixed_line;
4369 4370 4371
			}


4372 4373
		}

4374
# check for whitespace before a non-naked semicolon
4375
		if ($line =~ /^\+.*\S\s+;\s*$/) {
4376 4377 4378
			if (WARN("SPACING",
				 "space prohibited before semicolon\n" . $herecurr) &&
			    $fix) {
4379
				1 while $fixed[$fixlinenr] =~
4380 4381 4382 4383
				    s/^(\+.*\S)\s+;/$1;/;
			}
		}

4384 4385
# check for multiple assignments
		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
4386 4387
			CHK("MULTIPLE_ASSIGNMENTS",
			    "multiple assignments should be avoided\n" . $herecurr);
4388 4389
		}

4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400
## # 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 =~ /,/) {
4401 4402
## 				WARN("MULTIPLE_DECLARATION",
##				     "declaring multiple variables together should be avoided\n" . $herecurr);
4403 4404
## 			}
## 		}
4405

4406
#need space before brace following if, while, etc
4407
		if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
4408
		    $line =~ /do\{/) {
4409 4410 4411
			if (ERROR("SPACING",
				  "space required before the open brace '{'\n" . $herecurr) &&
			    $fix) {
4412
				$fixed[$fixlinenr] =~ s/^(\+.*(?:do|\)))\{/$1 {/;
4413
			}
4414 4415
		}

4416 4417 4418 4419 4420 4421 4422 4423
## # check for blank lines before declarations
##		if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
##		    $prevrawline =~ /^.\s*$/) {
##			WARN("SPACING",
##			     "No blank lines before declarations\n" . $hereprev);
##		}
##

4424 4425 4426
# closing brace should have a space following it when it has anything
# on the line
		if ($line =~ /}(?!(?:,|;|\)))\S/) {
4427 4428 4429
			if (ERROR("SPACING",
				  "space required after that close brace '}'\n" . $herecurr) &&
			    $fix) {
4430
				$fixed[$fixlinenr] =~
4431 4432
				    s/}((?!(?:,|;|\)))\S)/} $1/;
			}
4433 4434
		}

4435 4436
# check spacing on square brackets
		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
4437 4438 4439
			if (ERROR("SPACING",
				  "space prohibited after that open square bracket '['\n" . $herecurr) &&
			    $fix) {
4440
				$fixed[$fixlinenr] =~
4441 4442
				    s/\[\s+/\[/;
			}
4443 4444
		}
		if ($line =~ /\s\]/) {
4445 4446 4447
			if (ERROR("SPACING",
				  "space prohibited before that close square bracket ']'\n" . $herecurr) &&
			    $fix) {
4448
				$fixed[$fixlinenr] =~
4449 4450
				    s/\s+\]/\]/;
			}
4451 4452
		}

4453
# check spacing on parentheses
4454 4455
		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
		    $line !~ /for\s*\(\s+;/) {
4456 4457 4458
			if (ERROR("SPACING",
				  "space prohibited after that open parenthesis '('\n" . $herecurr) &&
			    $fix) {
4459
				$fixed[$fixlinenr] =~
4460 4461
				    s/\(\s+/\(/;
			}
4462
		}
4463
		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
4464 4465
		    $line !~ /for\s*\(.*;\s+\)/ &&
		    $line !~ /:\s+\)/) {
4466 4467 4468
			if (ERROR("SPACING",
				  "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
			    $fix) {
4469
				$fixed[$fixlinenr] =~
4470 4471
				    s/\s+\)/\)/;
			}
4472 4473
		}

4474 4475 4476 4477
# check unnecessary parentheses around addressof/dereference single $Lvals
# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar

		while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498
			my $var = $1;
			if (CHK("UNNECESSARY_PARENTHESES",
				"Unnecessary parentheses around $var\n" . $herecurr) &&
			    $fix) {
				$fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
			}
		}

# check for unnecessary parentheses around function pointer uses
# ie: (foo->bar)(); should be foo->bar();
# but not "if (foo->bar) (" to avoid some false positives
		if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
			my $var = $2;
			if (CHK("UNNECESSARY_PARENTHESES",
				"Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
			    $fix) {
				my $var2 = deparenthesize($var);
				$var2 =~ s/\s//g;
				$fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
			}
		}
4499

4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523
# check for unnecessary parentheses around comparisons in if uses
		if ($^V && $^V ge 5.10.0 && defined($stat) &&
		    $stat =~ /(^.\s*if\s*($balanced_parens))/) {
			my $if_stat = $1;
			my $test = substr($2, 1, -1);
			my $herectx;
			while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
				my $match = $1;
				# avoid parentheses around potential macro args
				next if ($match =~ /^\s*\w+\s*$/);
				if (!defined($herectx)) {
					$herectx = $here . "\n";
					my $cnt = statement_rawlines($if_stat);
					for (my $n = 0; $n < $cnt; $n++) {
						my $rl = raw_line($linenr, $n);
						$herectx .=  $rl . "\n";
						last if $rl =~ /^[ \+].*\{/;
					}
				}
				CHK("UNNECESSARY_PARENTHESES",
				    "Unnecessary parentheses around '$match'\n" . $herectx);
			}
		}

4524
#goto labels aren't indented, allow a single space however
4525
		if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
4526
		   !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
4527 4528 4529
			if (WARN("INDENTED_LABEL",
				 "labels should not be indented\n" . $herecurr) &&
			    $fix) {
4530
				$fixed[$fixlinenr] =~
4531 4532
				    s/^(.)\s+/$1/;
			}
4533 4534
		}

4535
# return is not a function
4536
		if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
4537
			my $spacing = $1;
4538
			if ($^V && $^V ge 5.10.0 &&
4539 4540 4541 4542 4543 4544 4545
			    $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);
				}
4546
			} elsif ($spacing !~ /\s+/) {
4547 4548
				ERROR("SPACING",
				      "space required before the open parenthesis '('\n" . $herecurr);
4549 4550
			}
		}
4551

4552 4553 4554 4555 4556 4557 4558 4559
# 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*:/) {
4560
			WARN("RETURN_VOID",
4561 4562
			     "void function return statements are not generally useful\n" . $hereprev);
               }
4563

4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577
# 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);
			}
		}

4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588
# comparisons with a constant or upper case identifier on the left
#	avoid cases like "foo + BAR < baz"
#	only fix matches surrounded by parentheses to avoid incorrect
#	conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
		if ($^V && $^V ge 5.10.0 &&
		    $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
			my $lead = $1;
			my $const = $2;
			my $comp = $3;
			my $to = $4;
			my $newcomp = $comp;
4589
			if ($lead !~ /(?:$Operators|\.)\s*$/ &&
4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606
			    $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
			    WARN("CONSTANT_COMPARISON",
				 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
			    $fix) {
				if ($comp eq "<") {
					$newcomp = ">";
				} elsif ($comp eq "<=") {
					$newcomp = ">=";
				} elsif ($comp eq ">") {
					$newcomp = "<";
				} elsif ($comp eq ">=") {
					$newcomp = "<=";
				}
				$fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
			}
		}

4607 4608
# Return of what appears to be an errno should normally be negative
		if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
4609 4610
			my $name = $1;
			if ($name ne 'EOF' && $name ne 'ERROR') {
4611
				WARN("USE_NEGATIVE_ERRNO",
4612
				     "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
4613 4614
			}
		}
4615

4616
# Need a space before open parenthesis after if, while etc
4617 4618 4619 4620
		if ($line =~ /\b(if|while|for|switch)\(/) {
			if (ERROR("SPACING",
				  "space required before the open parenthesis '('\n" . $herecurr) &&
			    $fix) {
4621
				$fixed[$fixlinenr] =~
4622 4623
				    s/\b(if|while|for|switch)\(/$1 \(/;
			}
4624 4625
		}

4626 4627
# Check for illegal assignment in if conditional -- and check for trailing
# statements after the conditional.
4628
		if ($line =~ /do\s*(?!{)/) {
4629 4630 4631
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649
			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} &&
4650
		    defined($stat) && defined($cond) &&
4651
		    $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
4652
			my ($s, $c) = ($stat, $cond);
4653

4654
			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
4655 4656
				ERROR("ASSIGN_IN_IF",
				      "do not use assignment in if condition\n" . $herecurr);
4657 4658 4659 4660
			}

			# Find out what is on the end of the line after the
			# conditional.
4661
			substr($s, 0, length($c), '');
4662
			$s =~ s/\n.*//g;
4663
			$s =~ s/$;//g; 	# Remove any comments
4664 4665
			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
			    $c !~ /}\s*while\s*/)
4666
			{
4667 4668 4669
				# Find out how long the conditional actually is.
				my @newlines = ($c =~ /\n/gs);
				my $cond_lines = 1 + $#newlines;
4670
				my $stat_real = '';
4671

4672 4673
				$stat_real = raw_line($linenr, $cond_lines)
							. "\n" if ($cond_lines);
4674 4675 4676 4677
				if (defined($stat_real) && $cond_lines > 1) {
					$stat_real = "[...]\n$stat_real";
				}

4678 4679
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr . $stat_real);
4680 4681 4682
			}
		}

4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694
# Check for bitwise tests written as boolean
		if ($line =~ /
			(?:
				(?:\[|\(|\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\|)
			|
				(?:\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\||\)|\])
			)/x)
		{
4695 4696
			WARN("HEXADECIMAL_BOOLEAN_TEST",
			     "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
4697 4698
		}

4699
# if and else should not have general statements after it
4700 4701 4702 4703
		if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
			my $s = $1;
			$s =~ s/$;//g; 	# Remove any comments
			if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
4704 4705
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr);
4706
			}
4707
		}
4708 4709
# if should not continue a brace
		if ($line =~ /}\s*if\b/) {
4710
			ERROR("TRAILING_STATEMENTS",
4711
			      "trailing statements should be on next line (or did you mean 'else if'?)\n" .
4712 4713
				$herecurr);
		}
4714 4715 4716
# case and default should not have general statements after them
		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
		    $line !~ /\G(?:
4717
			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
4718 4719 4720
			\s*return\s+
		    )/xg)
		{
4721 4722
			ERROR("TRAILING_STATEMENTS",
			      "trailing statements should be on next line\n" . $herecurr);
4723
		}
4724 4725 4726

		# Check for }<nl>else {, these must be at the same
		# indent level to be relevant to each other.
4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742
		if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
		    $previndent == $indent) {
			if (ERROR("ELSE_AFTER_BRACE",
				  "else should follow close brace '}'\n" . $hereprev) &&
			    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
				fix_delete_line($fixlinenr - 1, $prevrawline);
				fix_delete_line($fixlinenr, $rawline);
				my $fixedline = $prevrawline;
				$fixedline =~ s/}\s*$//;
				if ($fixedline !~ /^\+\s*$/) {
					fix_insert_line($fixlinenr, $fixedline);
				}
				$fixedline = $rawline;
				$fixedline =~ s/^(.\s*)else/$1} else/;
				fix_insert_line($fixlinenr, $fixedline);
			}
4743 4744
		}

4745 4746
		if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
		    $previndent == $indent) {
4747 4748 4749 4750
			my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);

			# Find out what is on the end of the line after the
			# conditional.
4751
			substr($s, 0, length($c), '');
4752 4753 4754
			$s =~ s/\n.*//g;

			if ($s =~ /^\s*;/) {
4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766
				if (ERROR("WHILE_AFTER_BRACE",
					  "while should follow close brace '}'\n" . $hereprev) &&
				    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
					fix_delete_line($fixlinenr - 1, $prevrawline);
					fix_delete_line($fixlinenr, $rawline);
					my $fixedline = $prevrawline;
					my $trailing = $rawline;
					$trailing =~ s/^\+//;
					$trailing = trim($trailing);
					$fixedline =~ s/}\s*$/} $trailing/;
					fix_insert_line($fixlinenr, $fixedline);
				}
4767 4768 4769
			}
		}

4770
#Specific variable tests
4771 4772
		while ($line =~ m{($Constant|$Lval)}g) {
			my $var = $1;
4773 4774 4775

#gcc binary extension
			if ($var =~ /^$Binary$/) {
4776 4777 4778 4779
				if (WARN("GCC_BINARY_CONSTANT",
					 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
				    $fix) {
					my $hexval = sprintf("0x%x", oct($var));
4780
					$fixed[$fixlinenr] =~
4781 4782
					    s/\b$var\b/$hexval/;
				}
4783 4784 4785
			}

#CamelCase
4786
			if ($var !~ /^$Constant$/ &&
4787
			    $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
4788
#Ignore Page<foo> variants
4789
			    $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
4790
#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4791 4792 4793
			    $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
#Ignore some three character SI units explicitly, like MiB and KHz
			    $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
4794 4795 4796
				while ($var =~ m{($Ident)}g) {
					my $word = $1;
					next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
4797 4798 4799 4800 4801 4802 4803
					if ($check) {
						seed_camelcase_includes();
						if (!$file && !$camelcase_file_seeded) {
							seed_camelcase_file($realfile);
							$camelcase_file_seeded = 1;
						}
					}
4804 4805 4806 4807 4808
					if (!defined $camelcase{$word}) {
						$camelcase{$word} = 1;
						CHK("CAMELCASE",
						    "Avoid CamelCase: <$word>\n" . $herecurr);
					}
4809
				}
4810 4811
			}
		}
4812 4813

#no spaces allowed after \ in define
4814 4815 4816 4817
		if ($line =~ /\#\s*define.*\\\s+$/) {
			if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
				 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
			    $fix) {
4818
				$fixed[$fixlinenr] =~ s/\s+$//;
4819
			}
4820 4821
		}

4822 4823
# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
# itself <asm/foo.h> (uses RAW line)
4824
		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
4825 4826 4827 4828
			my $file = "$1.h";
			my $checkfile = "include/linux/$file";
			if (-f "$root/$checkfile" &&
			    $realfile ne $checkfile &&
4829
			    $1 !~ /$allowed_asm_includes/)
4830
			{
4831 4832 4833 4834 4835 4836 4837 4838 4839
				my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
				if ($asminclude > 0) {
					if ($realfile =~ m{^arch/}) {
						CHK("ARCH_INCLUDE_LINUX",
						    "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
					} else {
						WARN("INCLUDE_LINUX",
						     "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
					}
4840
				}
4841 4842 4843
			}
		}

4844 4845
# 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
4846
# in a known good container
4847 4848
		if ($realfile !~ m@/vmlinux.lds.h$@ &&
		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
4849 4850
			my $ln = $linenr;
			my $cnt = $realcnt;
4851 4852
			my ($off, $dstat, $dcond, $rest);
			my $ctx = '';
4853 4854
			my $has_flow_statement = 0;
			my $has_arg_concat = 0;
4855
			($dstat, $dcond, $ln, $cnt, $off) =
4856 4857
				ctx_statement_block($linenr, $realcnt, 0);
			$ctx = $dstat;
4858
			#print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4859
			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4860

4861
			$has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
4862
			$has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
4863

4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874
			$dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
			my $define_args = $1;
			my $define_stmt = $dstat;
			my @def_args = ();

			if (defined $define_args && $define_args ne "") {
				$define_args = substr($define_args, 1, length($define_args) - 2);
				$define_args =~ s/\s*//g;
				@def_args = split(",", $define_args);
			}

4875
			$dstat =~ s/$;//g;
4876 4877 4878
			$dstat =~ s/\\\n.//g;
			$dstat =~ s/^\s*//s;
			$dstat =~ s/\s*$//s;
4879

4880
			# Flatten any parentheses and braces
4881 4882
			while ($dstat =~ s/\([^\(\)]*\)/1/ ||
			       $dstat =~ s/\{[^\{\}]*\}/1/ ||
4883
			       $dstat =~ s/.\[[^\[\]]*\]/1/)
4884
			{
4885
			}
4886

4887
			# Flatten any obvious string concatentation.
4888 4889
			while ($dstat =~ s/($String)\s*$Ident/$1/ ||
			       $dstat =~ s/$Ident\s*($String)/$1/)
4890 4891 4892
			{
			}

4893 4894 4895
			# Make asm volatile uses seem like a generic function
			$dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;

4896 4897 4898
			my $exceptions = qr{
				$Declare|
				module_param_named|
4899
				MODULE_PARM_DESC|
4900 4901
				DECLARE_PER_CPU|
				DEFINE_PER_CPU|
4902
				__typeof__\(|
4903 4904
				union|
				struct|
4905
				\.$Ident\s*=\s*|
4906 4907
				^\"|\"$|
				^\[
4908
			}x;
4909
			#print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4910 4911 4912 4913 4914 4915 4916 4917 4918

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

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

4919 4920 4921
			if ($dstat ne '' &&
			    $dstat !~ /^(?:$Ident|-?$Constant),$/ &&			# 10, // foo(),
			    $dstat !~ /^(?:$Ident|-?$Constant);$/ &&			# foo();
4922
			    $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ &&		# 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4923
			    $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ &&			# character constants
4924 4925
			    $dstat !~ /$exceptions/ &&
			    $dstat !~ /^\.$Ident\s*=/ &&				# .foo =
4926
			    $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ &&		# stringification #foo
4927
			    $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ &&	# do {...} while (...); // do {...} while (...)
4928 4929 4930
			    $dstat !~ /^for\s*$Constant$/ &&				# for (...)
			    $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ &&	# for (...) bar()
			    $dstat !~ /^do\s*{/ &&					# do {...
4931
			    $dstat !~ /^\(\{/ &&						# ({...
4932
			    $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
4933
			{
4934 4935 4936 4937
				if ($dstat =~ /^\s*if\b/) {
					ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
					      "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
				} elsif ($dstat =~ /;/) {
4938 4939 4940
					ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
					      "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
				} else {
4941
					ERROR("COMPLEX_MACRO",
A
Andrew Morton 已提交
4942
					      "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
4943
				}
4944 4945

			}
4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963

			# Make $define_stmt single line, comment-free, etc
			my @stmt_array = split('\n', $define_stmt);
			my $first = 1;
			$define_stmt = "";
			foreach my $l (@stmt_array) {
				$l =~ s/\\$//;
				if ($first) {
					$define_stmt = $l;
					$first = 0;
				} elsif ($l =~ /^[\+ ]/) {
					$define_stmt .= substr($l, 1);
				}
			}
			$define_stmt =~ s/$;//g;
			$define_stmt =~ s/\s+/ /g;
			$define_stmt = trim($define_stmt);

4964 4965 4966
# check if any macro arguments are reused (ignore '...' and 'type')
			foreach my $arg (@def_args) {
			        next if ($arg =~ /\.\.\./);
4967
			        next if ($arg =~ /^type$/i);
4968 4969 4970 4971 4972
				my $tmp_stmt = $define_stmt;
				$tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
				$tmp_stmt =~ s/\#+\s*$arg\b//g;
				$tmp_stmt =~ s/\b$arg\s*\#\#//g;
				my $use_cnt = $tmp_stmt =~ s/\b$arg\b//g;
4973 4974 4975
				if ($use_cnt > 1) {
					CHK("MACRO_ARG_REUSE",
					    "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
4976 4977
				    }
# check if any macro arguments may have other precedence issues
4978
				if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
4979 4980 4981 4982
				    ((defined($1) && $1 ne ',') ||
				     (defined($2) && $2 ne ','))) {
					CHK("MACRO_ARG_PRECEDENCE",
					    "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
4983
				}
4984
			}
4985

4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998
# check for macros with flow control, but without ## concatenation
# ## concatenation is commonly a macro that defines a function so ignore those
			if ($has_flow_statement && !$has_arg_concat) {
				my $herectx = $here . "\n";
				my $cnt = statement_rawlines($ctx);

				for (my $n = 0; $n < $cnt; $n++) {
					$herectx .= raw_line($linenr, $n) . "\n";
				}
				WARN("MACRO_WITH_FLOW_CONTROL",
				     "Macros with flow control statements should be avoided\n" . "$herectx");
			}

4999
# check for line continuations outside of #defines, preprocessor #, and asm
5000 5001 5002

		} else {
			if ($prevline !~ /^..*\\$/ &&
5003 5004
			    $line !~ /^\+\s*\#.*\\$/ &&		# preprocessor
			    $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ &&	# asm
5005 5006 5007 5008
			    $line =~ /^\+.*\\$/) {
				WARN("LINE_CONTINUATIONS",
				     "Avoid unnecessary line continuations\n" . $herecurr);
			}
5009 5010
		}

5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025
# 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;
5026
			$dstat =~ s/$;/ /g;
5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039

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

5040 5041
				if (($stmts =~ tr/;/;/) == 1 &&
				    $stmts !~ /^\s*(if|while|for|switch)\b/) {
5042 5043 5044 5045 5046 5047 5048
					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");
				}
5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059
			} 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");
5060 5061 5062
			}
		}

5063 5064 5065 5066 5067 5068
# 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|$))/) {
5069 5070
			WARN("MISSING_VMLINUX_SYMBOL",
			     "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
5071 5072
		}

5073
# check for redundant bracing round if etc
5074 5075
		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
			my ($level, $endln, @chunks) =
5076
				ctx_statement_full($linenr, $realcnt, 1);
5077
			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5078 5079
			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
			if ($#chunks > 0 && $level == 0) {
5080 5081
				my @allowed = ();
				my $allow = 0;
5082
				my $seen = 0;
5083
				my $herectx = $here . "\n";
5084
				my $ln = $linenr - 1;
5085 5086 5087
				for my $chunk (@chunks) {
					my ($cond, $block) = @{$chunk};

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

5092
					$allowed[$allow] = 0;
5093 5094 5095 5096 5097 5098
					#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";
5099 5100
					$ln += statement_rawlines($block) - 1;

5101
					substr($block, 0, length($cond), '');
5102 5103 5104

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

5105
					#print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5106 5107
					if (statement_lines($cond) > 1) {
						#print "APW: ALLOWED: cond<$cond>\n";
5108
						$allowed[$allow] = 1;
5109 5110
					}
					if ($block =~/\b(?:if|for|while)\b/) {
5111
						#print "APW: ALLOWED: block<$block>\n";
5112
						$allowed[$allow] = 1;
5113
					}
5114 5115
					if (statement_block_size($block) > 1) {
						#print "APW: ALLOWED: lines block<$block>\n";
5116
						$allowed[$allow] = 1;
5117
					}
5118
					$allow++;
5119
				}
5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132
				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);
					}
5133 5134 5135
				}
			}
		}
5136
		if (!defined $suppress_ifbraces{$linenr - 1} &&
5137
					$line =~ /\b(if|while|for|else)\b/) {
5138 5139 5140 5141 5142 5143 5144
			my $allowed = 0;

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

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

5149 5150
			# Check the condition.
			my ($cond, $block) = @{$chunks[0]};
5151
			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5152
			if (defined $cond) {
5153
				substr($block, 0, length($cond), '');
5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170
			}
			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) {
5171
					substr($block, 0, length($cond), '');
5172 5173 5174 5175 5176 5177 5178
				}
				if ($block =~ /^\s*\{/) {
					#print "APW: ALLOWED: chunk-1 block<$block>\n";
					$allowed = 1;
				}
			}
			if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
5179
				my $herectx = $here . "\n";
5180
				my $cnt = statement_rawlines($block);
5181

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

5186 5187
				WARN("BRACES",
				     "braces {} are not necessary for single statement blocks\n" . $herectx);
5188 5189 5190
			}
		}

5191
# check for single line unbalanced braces
5192 5193
		if ($sline =~ /^.\s*\}\s*else\s*$/ ||
		    $sline =~ /^.\s*else\s*\{\s*$/) {
5194 5195 5196
			CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
		}

5197
# check for unnecessary blank lines around braces
5198
		if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
5199 5200 5201 5202 5203
			if (CHK("BRACES",
				"Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
			    $fix && $prevrawline =~ /^\+/) {
				fix_delete_line($fixlinenr - 1, $prevrawline);
			}
5204
		}
5205
		if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
5206 5207 5208 5209 5210
			if (CHK("BRACES",
				"Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
			    $fix) {
				fix_delete_line($fixlinenr, $rawline);
			}
5211 5212
		}

5213
# no volatiles please
5214 5215
		my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
		if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
5216
			WARN("VOLATILE",
5217
			     "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5218 5219
		}

5220 5221 5222 5223
# Check for user-visible strings broken across lines, which breaks the ability
# 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
5224
		if ($line =~ /^\+\s*$String/ &&
5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258
		    $prevline =~ /"\s*$/ &&
		    $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
			if (WARN("SPLIT_STRING",
				 "quoted string split across lines\n" . $hereprev) &&
				     $fix &&
				     $prevrawline =~ /^\+.*"\s*$/ &&
				     $last_coalesced_string_linenr != $linenr - 1) {
				my $extracted_string = get_quoted_string($line, $rawline);
				my $comma_close = "";
				if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
					$comma_close = $1;
				}

				fix_delete_line($fixlinenr - 1, $prevrawline);
				fix_delete_line($fixlinenr, $rawline);
				my $fixedline = $prevrawline;
				$fixedline =~ s/"\s*$//;
				$fixedline .= substr($extracted_string, 1) . trim($comma_close);
				fix_insert_line($fixlinenr - 1, $fixedline);
				$fixedline = $rawline;
				$fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
				if ($fixedline !~ /\+\s*$/) {
					fix_insert_line($fixlinenr, $fixedline);
				}
				$last_coalesced_string_linenr = $linenr;
			}
		}

# check for missing a space in a string concatenation
		if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
			WARN('MISSING_SPACE',
			     "break quoted strings at a space character\n" . $hereprev);
		}

5259 5260 5261 5262
# check for an embedded function name in a string when the function is known
# This does not work very well for -f --file checking as it depends on patch
# context providing the function name or a single line form for in-file
# function declarations
5263 5264
		if ($line =~ /^\+.*$String/ &&
		    defined($context_function) &&
5265 5266
		    get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
		    length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
5267
			WARN("EMBEDDED_FUNCTION_NAME",
5268
			     "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5269 5270
		}

5271 5272 5273 5274 5275 5276 5277 5278 5279 5280
# check for spaces before a quoted newline
		if ($rawline =~ /^.*\".*\s\\n/) {
			if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
				 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
			    $fix) {
				$fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
			}

		}

5281
# concatenated string without spaces between elements
5282
		if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
5283 5284 5285 5286
			CHK("CONCATENATED_STRING",
			    "Concatenated strings should use spaces between elements\n" . $herecurr);
		}

5287
# uncoalesced string fragments
5288
		if ($line =~ /$String\s*"/) {
5289 5290 5291 5292
			WARN("STRING_FRAGMENTS",
			     "Consecutive strings are generally better as a single string\n" . $herecurr);
		}

5293 5294 5295
# check for non-standard and hex prefixed decimal printf formats
		my $show_L = 1;	#don't show the same defect twice
		my $show_Z = 1;
5296
		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5297
			my $string = substr($rawline, $-[1], $+[1] - $-[1]);
5298
			$string =~ s/%%/__/g;
5299 5300
			# check for %L
			if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
5301
				WARN("PRINTF_L",
5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313
				     "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
				$show_L = 0;
			}
			# check for %Z
			if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
				WARN("PRINTF_Z",
				     "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
				$show_Z = 0;
			}
			# check for 0x<decimal>
			if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
				ERROR("PRINTF_0XDECIMAL",
5314 5315
				      "Prefixing 0x with decimal output is defective\n" . $herecurr);
			}
5316 5317 5318 5319 5320 5321 5322 5323
		}

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

5324
# warn about #if 0
5325
		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
5326 5327
			CHK("REDUNDANT_CODE",
			    "if this code is redundant consider removing it\n" .
5328
				$herecurr);
5329 5330
		}

5331 5332
# check for needless "if (<foo>) fn(<foo>)" uses
		if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360
			my $tested = quotemeta($1);
			my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
			if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
				my $func = $1;
				if (WARN('NEEDLESS_IF',
					 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
				    $fix) {
					my $do_fix = 1;
					my $leading_tabs = "";
					my $new_leading_tabs = "";
					if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
						$leading_tabs = $1;
					} else {
						$do_fix = 0;
					}
					if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
						$new_leading_tabs = $1;
						if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
							$do_fix = 0;
						}
					} else {
						$do_fix = 0;
					}
					if ($do_fix) {
						fix_delete_line($fixlinenr - 1, $prevrawline);
						$fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
					}
				}
5361 5362
			}
		}
5363

5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374
# 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");

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

5381
# check for logging functions with KERN_<LEVEL>
5382
		if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
5383 5384 5385 5386 5387 5388 5389 5390 5391
		    $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
			my $level = $1;
			if (WARN("UNNECESSARY_KERN_LEVEL",
				 "Possible unnecessary $level\n" . $herecurr) &&
			    $fix) {
				$fixed[$fixlinenr] =~ s/\s*$level\s*//;
			}
		}

5392 5393 5394 5395 5396 5397
# check for logging continuations
		if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
			WARN("LOGGING_CONTINUATION",
			     "Avoid logging continuation uses where feasible\n" . $herecurr);
		}

5398 5399 5400 5401 5402 5403 5404 5405
# check for mask then right shift without a parentheses
		if ($^V && $^V ge 5.10.0 &&
		    $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
		    $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
			WARN("MASK_THEN_SHIFT",
			     "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
		}

5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419
# check for pointer comparisons to NULL
		if ($^V && $^V ge 5.10.0) {
			while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
				my $val = $1;
				my $equal = "!";
				$equal = "" if ($4 eq "!=");
				if (CHK("COMPARISON_TO_NULL",
					"Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
					    $fix) {
					$fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
				}
			}
		}

5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432
# 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) {
5433
					$fixed[$fixlinenr] =~ 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;
5434 5435 5436 5437
				}
			}
		}

5438 5439 5440 5441 5442 5443 5444 5445 5446
# 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) {
5447
				$fixed[$fixlinenr] =~
5448 5449 5450 5451 5452 5453 5454 5455 5456 5457
				    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) {
5458
				my $lead = $fixed[$fixlinenr] =~
5459 5460 5461 5462
				    /(^\+\s*(?:static\s+))/;
				$lead = rtrim($1);
				$lead = "$lead " if ($lead !~ /^\+$/);
				$lead = "${lead}const ";
5463
				$fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
5464 5465 5466
			}
		}

5467 5468 5469 5470 5471 5472 5473 5474 5475 5476
# check for __read_mostly with const non-pointer (should just be const)
		if ($line =~ /\b__read_mostly\b/ &&
		    $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
			if (ERROR("CONST_READ_MOSTLY",
				  "Invalid use of __read_mostly with const type\n" . $herecurr) &&
			    $fix) {
				$fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
			}
		}

5477 5478 5479 5480 5481 5482 5483 5484 5485
# 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) {
5486
				$fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
5487 5488 5489
			}
		}

5490
# prefer usleep_range over udelay
B
Bruce Allan 已提交
5491
		if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
5492
			my $delay = $1;
5493
			# ignore udelay's < 10, however
5494
			if (! ($delay < 10) ) {
5495
				CHK("USLEEP_RANGE",
5496 5497 5498 5499 5500
				    "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);
5501 5502 5503
			}
		}

5504 5505 5506
# warn about unexpectedly long msleep's
		if ($line =~ /\bmsleep\s*\((\d+)\);/) {
			if ($1 < 20) {
5507
				WARN("MSLEEP",
5508
				     "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5509 5510 5511
			}
		}

5512 5513 5514 5515 5516 5517
# 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);
		}

5518 5519 5520 5521 5522 5523
# 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);
		}

5524
# warn about #ifdefs in C files
5525
#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5526 5527 5528 5529 5530
#			print "#ifdef in C files should be avoided\n";
#			print "$herecurr";
#			$clean = 0;
#		}

5531
# warn about spacing in #ifdefs
5532
		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
5533 5534 5535
			if (ERROR("SPACING",
				  "exactly one space required after that #$1\n" . $herecurr) &&
			    $fix) {
5536
				$fixed[$fixlinenr] =~
5537 5538 5539
				    s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
			}

5540 5541
		}

5542
# check for spinlock_t definitions without a comment.
5543 5544
		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
5545 5546
			my $which = $1;
			if (!ctx_has_comment($first_line, $linenr)) {
5547 5548
				CHK("UNCOMMENTED_DEFINITION",
				    "$1 definition without comment\n" . $herecurr);
5549 5550 5551
			}
		}
# check for memory barriers without a comment.
5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568

		my $barriers = qr{
			mb|
			rmb|
			wmb|
			read_barrier_depends
		}x;
		my $barrier_stems = qr{
			mb__before_atomic|
			mb__after_atomic|
			store_release|
			load_acquire|
			store_mb|
			(?:$barriers)
		}x;
		my $all_barriers = qr{
			(?:$barriers)|
5569 5570
			smp_(?:$barrier_stems)|
			virt_(?:$barrier_stems)
5571 5572 5573
		}x;

		if ($line =~ /\b(?:$all_barriers)\s*\(/) {
5574
			if (!ctx_has_comment($first_line, $linenr)) {
5575 5576
				WARN("MEMORY_BARRIER",
				     "memory barrier without comment\n" . $herecurr);
5577 5578
			}
		}
5579

5580 5581 5582 5583 5584 5585 5586 5587 5588 5589
		my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;

		if ($realfile !~ m@^include/asm-generic/@ &&
		    $realfile !~ m@/barrier\.h$@ &&
		    $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
		    $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
			WARN("MEMORY_BARRIER",
			     "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
		}

5590 5591 5592 5593 5594 5595 5596
# check for waitqueue_active without a comment.
		if ($line =~ /\bwaitqueue_active\s*\(/) {
			if (!ctx_has_comment($first_line, $linenr)) {
				WARN("WAITQUEUE_ACTIVE",
				     "waitqueue_active without comment\n" . $herecurr);
			}
		}
5597

5598
# check of hardware specific defines
5599
		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5600 5601
			CHK("ARCH_DEFINES",
			    "architecture specific defines should be avoided\n" .  $herecurr);
5602
		}
5603

5604 5605 5606 5607 5608
# check that the storage class is not after a type
		if ($line =~ /\b($Type)\s+($Storage)\b/) {
			WARN("STORAGE_CLASS",
			     "storage class '$2' should be located before type '$1'\n" . $herecurr);
		}
5609
# Check that the storage class is at the beginning of a declaration
5610 5611 5612 5613
		if ($line =~ /\b$Storage\b/ &&
		    $line !~ /^.\s*$Storage/ &&
		    $line =~ /^.\s*(.+?)\$Storage\s/ &&
		    $1 !~ /[\,\)]\s*$/) {
5614
			WARN("STORAGE_CLASS",
5615
			     "storage class should be at the beginning of the declaration\n" . $herecurr);
5616 5617
		}

5618 5619
# check the location of the inline attribute, that it is between
# storage class and type.
5620 5621
		if ($line =~ /\b$Type\s+$Inline\b/ ||
		    $line =~ /\b$Inline\s+$Storage\b/) {
5622 5623
			ERROR("INLINE_LOCATION",
			      "inline keyword should sit between storage class and type\n" . $herecurr);
5624 5625
		}

5626
# Check for __inline__ and __inline, prefer inline
5627 5628
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b(__inline__|__inline)\b/) {
5629 5630 5631
			if (WARN("INLINE",
				 "plain inline is preferred over $1\n" . $herecurr) &&
			    $fix) {
5632
				$fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
5633 5634

			}
5635 5636
		}

5637
# Check for __attribute__ packed, prefer __packed
5638 5639
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
5640 5641
			WARN("PREFER_PACKED",
			     "__packed is preferred over __attribute__((packed))\n" . $herecurr);
5642 5643
		}

5644
# Check for __attribute__ aligned, prefer __aligned
5645 5646
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
5647 5648
			WARN("PREFER_ALIGNED",
			     "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
5649 5650
		}

5651
# Check for __attribute__ format(printf, prefer __printf
5652 5653
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
5654 5655 5656
			if (WARN("PREFER_PRINTF",
				 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
			    $fix) {
5657
				$fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5658 5659

			}
5660 5661
		}

5662
# Check for __attribute__ format(scanf, prefer __scanf
5663 5664
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
5665 5666 5667
			if (WARN("PREFER_SCANF",
				 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
			    $fix) {
5668
				$fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5669
			}
5670 5671
		}

5672 5673 5674 5675 5676 5677 5678 5679 5680
# Check for __attribute__ weak, or __weak declarations (may have link issues)
		if ($^V && $^V ge 5.10.0 &&
		    $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
		    ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
		     $line =~ /\b__weak\b/)) {
			ERROR("WEAK_DECLARATION",
			      "Using weak declarations can have unintended link defects\n" . $herecurr);
		}

5681
# check for c99 types like uint8_t used outside of uapi/ and tools/
5682
		if ($realfile !~ m@\binclude/uapi/@ &&
5683
		    $realfile !~ m@\btools/@ &&
5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699
		    $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
			my $type = $1;
			if ($type =~ /\b($typeC99Typedefs)\b/) {
				$type = $1;
				my $kernel_type = 'u';
				$kernel_type = 's' if ($type =~ /^_*[si]/);
				$type =~ /(\d+)/;
				$kernel_type .= $1;
				if (CHK("PREFER_KERNEL_TYPES",
					"Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
				    $fix) {
					$fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
				}
			}
		}

5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719
# check for cast of C90 native int or longer types constants
		if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
			my $cast = $1;
			my $const = $2;
			if (WARN("TYPECAST_INT_CONSTANT",
				 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
			    $fix) {
				my $suffix = "";
				my $newconst = $const;
				$newconst =~ s/${Int_type}$//;
				$suffix .= 'U' if ($cast =~ /\bunsigned\b/);
				if ($cast =~ /\blong\s+long\b/) {
					$suffix .= 'LL';
				} elsif ($cast =~ /\blong\b/) {
					$suffix .= 'L';
				}
				$fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
			}
		}

5720 5721
# check for sizeof(&)
		if ($line =~ /\bsizeof\s*\(\s*\&/) {
5722 5723
			WARN("SIZEOF_ADDRESS",
			     "sizeof(& should be avoided\n" . $herecurr);
5724 5725
		}

5726 5727
# check for sizeof without parenthesis
		if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
5728 5729 5730
			if (WARN("SIZEOF_PARENTHESIS",
				 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
			    $fix) {
5731
				$fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5732
			}
5733 5734
		}

5735 5736 5737 5738 5739 5740
# 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);
		}

5741
# check for seq_printf uses that could be seq_puts
J
Joe Perches 已提交
5742
		if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
5743
			my $fmt = get_quoted_string($line, $rawline);
5744 5745
			$fmt =~ s/%%//g;
			if ($fmt !~ /%/) {
5746 5747 5748
				if (WARN("PREFER_SEQ_PUTS",
					 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
				    $fix) {
5749
					$fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
5750
				}
5751 5752 5753
			}
		}

5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764
		# check for vsprintf extension %p<foo> misuses
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
		    $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
		    $1 !~ /^_*volatile_*$/) {
			my $bad_extension = "";
			my $lc = $stat =~ tr@\n@@;
			$lc = $lc + $linenr;
		        for (my $count = $linenr; $count <= $lc; $count++) {
				my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
				$fmt =~ s/%%//g;
5765
				if ($fmt =~ /(\%[\*\d\.]*p(?![\WFfSsBKRraEhMmIiUDdgVCbGNO]).)/) {
5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779
					$bad_extension = $1;
					last;
				}
			}
			if ($bad_extension ne "") {
				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("VSPRINTF_POINTER_EXTENSION",
				     "Invalid vsprintf pointer extension '$bad_extension'\n" . "$here\n$stat_real\n");
			}
		}

5780
# Check for misused memsets
5781 5782
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
5783
		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
5784 5785

			my $ms_addr = $2;
5786 5787
			my $ms_val = $7;
			my $ms_size = $12;
5788 5789 5790

			if ($ms_size =~ /^(0x|)0$/i) {
				ERROR("MEMSET",
5791
				      "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
5792 5793
			} elsif ($ms_size =~ /^(0x|)1$/i) {
				WARN("MEMSET",
5794 5795 5796 5797
				     "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
			}
		}

5798
# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5799 5800 5801 5802 5803 5804 5805 5806 5807
#		if ($^V && $^V ge 5.10.0 &&
#		    defined $stat &&
#		    $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
#			if (WARN("PREFER_ETHER_ADDR_COPY",
#				 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
#			    $fix) {
#				$fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
#			}
#		}
5808

5809
# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5810 5811 5812 5813 5814 5815
#		if ($^V && $^V ge 5.10.0 &&
#		    defined $stat &&
#		    $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
#			WARN("PREFER_ETHER_ADDR_EQUAL",
#			     "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
#		}
5816

5817 5818
# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838
#		if ($^V && $^V ge 5.10.0 &&
#		    defined $stat &&
#		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
#
#			my $ms_val = $7;
#
#			if ($ms_val =~ /^(?:0x|)0+$/i) {
#				if (WARN("PREFER_ETH_ZERO_ADDR",
#					 "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
#				    $fix) {
#					$fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
#				}
#			} elsif ($ms_val =~ /^(?:0xff|255)$/i) {
#				if (WARN("PREFER_ETH_BROADCAST_ADDR",
#					 "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
#				    $fix) {
#					$fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
#				}
#			}
#		}
5839

5840
# typecasts on min/max could be min_t/max_t
5841 5842
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
5843
		    $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
5844
			if (defined $2 || defined $7) {
5845 5846 5847
				my $call = $1;
				my $cast1 = deparenthesize($2);
				my $arg1 = $3;
5848 5849
				my $cast2 = deparenthesize($7);
				my $arg2 = $8;
5850 5851
				my $cast;

5852
				if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
5853 5854 5855 5856 5857 5858 5859 5860
					$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");
5861 5862 5863
			}
		}

5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879
# 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");
			}
		}

5880 5881 5882
# check for naked sscanf
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
5883
		    $line =~ /\bsscanf\b/ &&
5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896
		    ($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");
		}

5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917
# 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");
				}
			}
		}

5918 5919 5920
# check for new externs in .h files.
		if ($realfile =~ /\.h$/ &&
		    $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
5921 5922
			if (CHK("AVOID_EXTERNS",
				"extern prototypes should be avoided in .h files\n" . $herecurr) &&
5923
			    $fix) {
5924
				$fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
5925 5926 5927
			}
		}

5928
# check for new externs in .c files.
5929
		if ($realfile =~ /\.c$/ && defined $stat &&
5930
		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
5931
		{
5932 5933
			my $function_name = $1;
			my $paren_space = $2;
5934 5935 5936 5937 5938

			my $s = $stat;
			if (defined $cond) {
				substr($s, 0, length($cond), '');
			}
5939 5940 5941
			if ($s =~ /^\s*;/ &&
			    $function_name ne 'uninitialized_var')
			{
5942 5943
				WARN("AVOID_EXTERNS",
				     "externs should be avoided in .c files\n" .  $herecurr);
5944 5945 5946
			}

			if ($paren_space =~ /\n/) {
5947 5948
				WARN("FUNCTION_ARGUMENTS",
				     "arguments for function declarations should follow identifier\n" . $herecurr);
5949
			}
5950 5951 5952 5953

		} elsif ($realfile =~ /\.c$/ && defined $stat &&
		    $stat =~ /^.\s*extern\s+/)
		{
5954 5955
			WARN("AVOID_EXTERNS",
			     "externs should be avoided in .c files\n" .  $herecurr);
5956 5957
		}

5958 5959
# check for function declarations that have arguments without identifier names
		if (defined $stat &&
5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971
		    $stat =~ /^.\s*(?:extern\s+)?$Type\s*$Ident\s*\(\s*([^{]+)\s*\)\s*;/s &&
		    $1 ne "void") {
			my $args = trim($1);
			while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
				my $arg = trim($1);
				if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
					WARN("FUNCTION_ARGUMENTS",
					     "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
				}
			}
		}

5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994
# check for function definitions
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
		    $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
			$context_function = $1;

# check for multiline function definition with misplaced open brace
			my $ok = 0;
			my $cnt = statement_rawlines($stat);
			my $herectx = $here . "\n";
			for (my $n = 0; $n < $cnt; $n++) {
				my $rl = raw_line($linenr, $n);
				$herectx .=  $rl . "\n";
				$ok = 1 if ($rl =~ /^[ \+]\{/);
				$ok = 1 if ($rl =~ /\{/ && $n == 0);
				last if $rl =~ /^[ \+].*\{/;
			}
			if (!$ok) {
				ERROR("OPEN_BRACE",
				      "open brace '{' following function definitions go on the next line\n" . $herectx);
			}
		}

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

			if (!grep(/$name/, @setup_docs)) {
6000
				CHK("UNDOCUMENTED_SETUP",
6001
				    "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
6002
			}
6003
		}
6004 6005

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

6011 6012 6013 6014 6015 6016 6017 6018
# 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);
		}

6019 6020
# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
		if ($^V && $^V ge 5.10.0 &&
6021 6022
		    defined $stat &&
		    $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6023 6024 6025 6026 6027
			my $oldfunc = $3;
			my $a1 = $4;
			my $a2 = $10;
			my $newfunc = "kmalloc_array";
			$newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
6028 6029 6030 6031 6032 6033 6034 6035
			my $r1 = $a1;
			my $r2 = $a2;
			if ($a1 =~ /^sizeof\s*\S/) {
				$r1 = $a2;
				$r2 = $a1;
			}
			if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
			    !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
6036 6037 6038 6039 6040 6041
				my $ctx = '';
				my $herectx = $here . "\n";
				my $cnt = statement_rawlines($stat);
				for (my $n = 0; $n < $cnt; $n++) {
					$herectx .= raw_line($linenr, $n) . "\n";
				}
6042
				if (WARN("ALLOC_WITH_MULTIPLY",
6043 6044
					 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
				    $cnt == 1 &&
6045
				    $fix) {
6046
					$fixed[$fixlinenr] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e;
6047 6048 6049 6050
				}
			}
		}

6051 6052 6053 6054 6055 6056 6057
# 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);
		}

6058 6059 6060 6061 6062 6063
# 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);
		}

6064 6065
# check for multiple semicolons
		if ($line =~ /;\s*;\s*$/) {
6066 6067 6068
			if (WARN("ONE_SEMICOLON",
				 "Statements terminations use 1 semicolon\n" . $herecurr) &&
			    $fix) {
6069
				$fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
6070
			}
6071 6072
		}

6073 6074 6075
# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
		if ($realfile !~ m@^include/uapi/@ &&
		    $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
6076 6077 6078 6079 6080 6081 6082 6083 6084
			my $ull = "";
			$ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
			if (CHK("BIT_MACRO",
				"Prefer using the BIT$ull macro\n" . $herecurr) &&
			    $fix) {
				$fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
			}
		}

6085 6086 6087 6088 6089 6090 6091 6092 6093 6094
# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
		if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
			my $config = $1;
			if (WARN("PREFER_IS_ENABLED",
				 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
			    $fix) {
				$fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
			}
		}

6095
# check for case / default statements not preceded by break/fallthrough/switch
6096 6097 6098 6099 6100
		if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
			my $has_break = 0;
			my $has_statement = 0;
			my $count = 0;
			my $prevline = $linenr;
6101
			while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115
				$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",
6116
				     "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
6117 6118 6119
			}
		}

6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131
# 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);
6132 6133
		}

6134
# check for gcc specific __FUNCTION__
6135 6136 6137 6138
		if ($line =~ /\b__FUNCTION__\b/) {
			if (WARN("USE_FUNC",
				 "__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr) &&
			    $fix) {
6139
				$fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
6140
			}
6141
		}
6142

6143 6144 6145 6146 6147 6148
# check for uses of __DATE__, __TIME__, __TIMESTAMP__
		while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
			ERROR("DATE_TIME",
			      "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
		}

J
Joe Perches 已提交
6149 6150 6151 6152 6153 6154
# 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);
		}

6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181
# 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);

			}
		}

6182 6183
# check for semaphores initialized locked
		if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
6184 6185
			WARN("CONSIDER_COMPLETION",
			     "consider using a completion\n" . $herecurr);
6186
		}
6187

6188 6189
# recommend kstrto* over simple_strto* and strict_strto*
		if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
6190
			WARN("CONSIDER_KSTRTO",
6191
			     "$1 is obsolete, use k$3 instead\n" . $herecurr);
6192
		}
6193

6194
# check for __initcall(), use device_initcall() explicitly or more appropriate function please
6195
		if ($line =~ /^.\s*__initcall\s*\(/) {
6196
			WARN("USE_DEVICE_INITCALL",
6197
			     "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6198
		}
6199

6200
# check for various structs that are normally const (ops, kgdb, device_tree)
6201
# and avoid what seem like struct definitions 'struct foo {'
6202
		if ($line !~ /\bconst\b/ &&
6203
		    $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
6204
			WARN("CONST_STRUCT",
6205
			     "struct $1 should normally be const\n" . $herecurr);
6206
		}
6207 6208 6209 6210

# 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/ &&
6211 6212
		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
6213 6214 6215
		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
6216
		{
6217 6218
			WARN("NR_CPUS",
			     "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6219
		}
6220

6221 6222 6223 6224 6225 6226
# 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);
		}

6227 6228 6229 6230 6231 6232 6233
# likely/unlikely comparisons similar to "(likely(foo) > 0)"
		if ($^V && $^V ge 5.10.0 &&
		    $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
			WARN("LIKELY_MISUSE",
			     "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
		}

6234 6235 6236
# whine mightly about in_atomic
		if ($line =~ /\bin_atomic\s*\(/) {
			if ($realfile =~ m@^drivers/@) {
6237 6238
				ERROR("IN_ATOMIC",
				      "do not use in_atomic in drivers\n" . $herecurr);
6239
			} elsif ($realfile !~ m@^kernel/@) {
6240 6241
				WARN("IN_ATOMIC",
				     "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
6242 6243
			}
		}
6244

6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266
# whine about ACCESS_ONCE
		if ($^V && $^V ge 5.10.0 &&
		    $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) {
			my $par = $1;
			my $eq = $2;
			my $fun = $3;
			$par =~ s/^\(\s*(.*)\s*\)$/$1/;
			if (defined($eq)) {
				if (WARN("PREFER_WRITE_ONCE",
					 "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) &&
				    $fix) {
					$fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
				}
			} else {
				if (WARN("PREFER_READ_ONCE",
					 "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) &&
				    $fix) {
					$fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/;
				}
			}
		}

6267 6268 6269 6270 6271 6272
# check for mutex_trylock_recursive usage
		if ($line =~ /mutex_trylock_recursive/) {
			ERROR("LOCKING",
			      "recursive locking is bad, do not use this ever.\n" . $herecurr);
		}

6273 6274 6275 6276 6277 6278
# 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@) {
6279 6280
				ERROR("LOCKDEP",
				      "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
6281 6282
			}
		}
6283

6284 6285
		if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
		    $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
6286 6287
			WARN("EXPORTED_WORLD_WRITABLE",
			     "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6288
		}
6289

6290 6291 6292
# 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 &&
6293
		    defined $stat &&
6294 6295 6296 6297 6298
		    $line =~ /$mode_perms_search/) {
			foreach my $entry (@mode_permission_funcs) {
				my $func = $entry->[0];
				my $arg_pos = $entry->[1];

6299 6300 6301 6302 6303 6304 6305
				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);
				}

6306 6307 6308 6309 6310
				my $skip_args = "";
				if ($arg_pos > 1) {
					$arg_pos--;
					$skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
				}
6311
				my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
6312
				if ($stat =~ /$test/) {
6313 6314
					my $val = $1;
					$val = $6 if ($skip_args ne "");
6315 6316
					if (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
					    ($val =~ /^$Octal$/ && length($val) ne 4)) {
6317
						ERROR("NON_OCTAL_PERMISSIONS",
6318
						      "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
6319 6320
					}
					if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
6321
						ERROR("EXPORTED_WORLD_WRITABLE",
6322
						      "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6323
					}
6324 6325 6326
				}
			}
		}
6327

6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355
# check for uses of S_<PERMS> that could be octal for readability
		if ($line =~ /\b$mode_perms_string_search\b/) {
			my $val = "";
			my $oval = "";
			my $to = 0;
			my $curpos = 0;
			my $lastpos = 0;
			while ($line =~ /\b(($mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
				$curpos = pos($line);
				my $match = $2;
				my $omatch = $1;
				last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
				$lastpos = $curpos;
				$to |= $mode_permission_string_types{$match};
				$val .= '\s*\|\s*' if ($val ne "");
				$val .= $match;
				$oval .= $omatch;
			}
			$oval =~ s/^\s*\|\s*//;
			$oval =~ s/\s*\|\s*$//;
			my $octal = sprintf("%04o", $to);
			if (WARN("SYMBOLIC_PERMS",
				 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
			    $fix) {
				$fixed[$fixlinenr] =~ s/$val/$octal/;
			}
		}

6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372
# validate content of MODULE_LICENSE against list from include/linux/module.h
		if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
			my $extracted_string = get_quoted_string($line, $rawline);
			my $valid_licenses = qr{
						GPL|
						GPL\ v2|
						GPL\ and\ additional\ rights|
						Dual\ BSD/GPL|
						Dual\ MIT/GPL|
						Dual\ MPL/GPL|
						Proprietary
					}x;
			if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
				WARN("MODULE_LICENSE",
				     "unknown module license " . $extracted_string . "\n" . $herecurr);
			}
		}
6373 6374 6375 6376 6377 6378
	}

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

6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392
	# 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);
	}

6393
	if (!$is_patch && $file !~ /cover-letter\.patch$/) {
6394 6395
		ERROR("NOT_UNIFIED_DIFF",
		      "Does not appear to be a unified-diff format patch\n");
6396
	}
6397
	if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
6398 6399
		ERROR("MISSING_SIGN_OFF",
		      "Missing Signed-off-by: line(s)\n");
6400 6401
	}

6402
	print report_dump();
6403 6404
	if ($summary && !($clean == 1 && $quiet == 1)) {
		print "$filename " if ($summary_file);
6405 6406 6407
		print "total: $cnt_error errors, $cnt_warn warnings, " .
			(($check)? "$cnt_chk checks, " : "") .
			"$cnt_lines lines checked\n";
6408
	}
6409

6410
	if ($quiet == 0) {
6411 6412 6413 6414 6415 6416 6417 6418
		# If there were any defects found and not already fixing them
		if (!$clean and !$fix) {
			print << "EOM"

NOTE: For some of the reported defects, checkpatch may be able to
      mechanically convert to the typical style using --fix or --fix-inplace.
EOM
		}
6419 6420 6421
		# If there were whitespace errors which cleanpatch can fix
		# then suggest that.
		if ($rpt_cleaners) {
6422
			$rpt_cleaners = 0;
6423 6424 6425 6426 6427
			print << "EOM"

NOTE: Whitespace errors detected.
      You may wish to use scripts/cleanpatch or scripts/cleanfile
EOM
6428 6429 6430
		}
	}

6431 6432 6433
	if ($clean == 0 && $fix &&
	    ("@rawlines" ne "@fixed" ||
	     $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
6434 6435
		my $newfile = $filename;
		$newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
6436 6437 6438
		my $linecount = 0;
		my $f;

6439 6440
		@fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);

6441 6442 6443 6444 6445 6446 6447
		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/^\+//;
6448
					print $f $fixed_line . "\n";
6449 6450 6451 6452 6453 6454 6455 6456 6457
				}
			} else {
				print $f $fixed_line . "\n";
			}
		}
		close($f);

		if (!$quiet) {
			print << "EOM";
6458

6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469
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
		}
	}

6470 6471 6472 6473 6474 6475 6476
	if ($quiet == 0) {
		print "\n";
		if ($clean == 1) {
			print "$vname has no obvious style problems and is ready for submission.\n";
		} else {
			print "$vname has style problems, please review.\n";
		}
6477 6478 6479
	}
	return $clean;
}