checkpatch.pl 158.3 KB
Newer Older
1
#!/usr/bin/perl -w
2
# (c) 2001, Dave Jones. (the file handling bit)
3
# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
A
Andy Whitcroft 已提交
4
# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
5
# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
6 7 8
# Licensed under the terms of the GNU GPL License version 2

use strict;
9
use POSIX;
10 11
use File::Basename;
use Cwd 'abs_path';
12 13

my $P = $0;
14
my $D = dirname(abs_path($P));
15

16
my $V = '0.32';
17 18 19 20 21 22 23

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

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

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

	print << "EOM";
Usage: $P [OPTION]... [FILE]...
Version: $V

Options:
  -q, --quiet                quiet
  --no-tree                  run without a kernel tree
  --no-signoff               do not check for 'Signed-off-by' line
  --patch                    treat FILE as patchfile (default)
  --emacs                    emacs compile window format
  --terse                    one line per report
  -f, --file                 treat FILE as regular source file
  --subjective, --strict     enable more subjective tests
69
  --types TYPE(,TYPE2...)    show only these comma separated message types
70
  --ignore TYPE(,TYPE2...)   ignore various comma separated message types
71
  --max-line-length=n        set the maximum line length, if exceeded, warn
72
  --min-conf-desc-length=n   set the min description length, if shorter, warn
73
  --show-types               show the message "types" in the output
74 75 76 77 78 79 80 81 82
  --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
83 84 85 86 87
  --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
88 89 90
  --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
91 92
  --ignore-perl-version      override checking of perl version.  expect
                             runtime errors.
93 94 95
  --codespell                Use the codespell dictionary for spelling/typos
                             (default:/usr/local/share/codespell/dictionary.txt)
  --codespellfile            Use this codespell dictionary
96 97 98 99 100 101 102 103
  -h, --help, --version      display this help and exit

When FILE is - read standard input.
EOM

	exit($exitcode);
}

104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
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;
}

130
GetOptions(
131
	'q|quiet+'	=> \$quiet,
132 133 134
	'tree!'		=> \$tree,
	'signoff!'	=> \$chk_signoff,
	'patch!'	=> \$chk_patch,
135
	'emacs!'	=> \$emacs,
136
	'terse!'	=> \$terse,
137
	'f|file!'	=> \$file,
138 139
	'subjective!'	=> \$check,
	'strict!'	=> \$check,
140
	'ignore=s'	=> \@ignore,
141
	'types=s'	=> \@use,
142
	'show-types!'	=> \$show_types,
143
	'max-line-length=i' => \$max_line_length,
144
	'min-conf-desc-length=i' => \$min_conf_desc_length,
145
	'root=s'	=> \$root,
146 147
	'summary!'	=> \$summary,
	'mailback!'	=> \$mailback,
148
	'summary-file!'	=> \$summary_file,
149
	'fix!'		=> \$fix,
150
	'fix-inplace!'	=> \$fix_inplace,
151
	'ignore-perl-version!' => \$ignore_perl_version,
152
	'debug=s'	=> \%debug,
153
	'test-only=s'	=> \$tst_only,
154 155
	'codespell!'	=> \$codespell,
	'codespellfile=s'	=> \$codespellfile,
156 157 158 159 160
	'h|help'	=> \$help,
	'version'	=> \$help
) or help(1);

help(0) if ($help);
161

162
$fix = 1 if ($fix_inplace);
163
$check_orig = $check;
164

165 166
my $exit = 0;

167 168 169 170 171 172 173
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);
	}
}

174
if ($#ARGV < 0) {
175
	print "$P: no input files\n";
176 177 178
	exit(1);
}

179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
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}++;
	}
}
195

196 197
sub hash_show_words {
	my ($hashRef, $prefix) = @_;
198

199
	if ($quiet == 0 && keys %$hashRef) {
200
		print "NOTE: $prefix message types:";
201
		foreach my $word (sort keys %$hashRef) {
202 203 204 205
			print " $word";
		}
		print "\n\n";
	}
206 207
}

208 209 210
hash_save_array_words(\%ignore_type, \@ignore);
hash_save_array_words(\%use_type, \@use);

211 212
my $dbg_values = 0;
my $dbg_possible = 0;
213
my $dbg_type = 0;
214
my $dbg_attr = 0;
215
for my $key (keys %debug) {
216 217 218
	## no critic
	eval "\${dbg_$key} = '$debug{$key}';";
	die "$@" if ($@);
219 220
}

221 222
my $rpt_cleaners = 0;

223 224 225 226 227
if ($terse) {
	$emacs = 1;
	$quiet++;
}

228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
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);
	}
246 247
}

248 249
my $emitted_corrupt = 0;

250 251 252 253
our $Ident	= qr{
			[A-Za-z_][A-Za-z\d_]*
			(?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
		}x;
254 255 256 257 258 259 260 261
our $Storage	= qr{extern|static|asmlinkage};
our $Sparse	= qr{
			__user|
			__kernel|
			__force|
			__iomem|
			__must_check|
			__init_refok|
262
			__kprobes|
263 264
			__ref|
			__rcu
265
		}x;
266 267 268 269 270
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};
271

272 273
# Notes to $Attribute:
# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
274 275
our $Attribute	= qr{
			const|
276 277 278 279 280 281 282 283 284 285 286 287
			__percpu|
			__nocast|
			__safe|
			__bitwise__|
			__packed__|
			__packed2__|
			__naked|
			__maybe_unused|
			__always_unused|
			__noreturn|
			__used|
			__cold|
288
			__pure|
289 290
			__noclone|
			__deprecated|
291 292
			__read_mostly|
			__kprobes|
293
			$InitAttribute|
294 295
			____cacheline_aligned|
			____cacheline_aligned_in_smp|
296 297
			____cacheline_internodealigned_in_smp|
			__weak
298
		  }x;
299
our $Modifier;
300
our $Inline	= qr{inline|__always_inline|noinline|__inline|__inline__};
301 302 303
our $Member	= qr{->$Ident|\.$Ident|\[[^]]*\]};
our $Lval	= qr{$Ident(?:$Member)*};

304 305 306 307
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?};
308
our $Octal	= qr{0[0-7]+$Int_type?};
309
our $String	= qr{"[X\t]*"};
310 311 312
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]?};
313
our $Float	= qr{$Float_hex|$Float_dec|$Float_int};
314
our $Constant	= qr{$Float|$Binary|$Octal|$Hex|$Int};
315
our $Assignment	= qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
316
our $Compare    = qr{<=|>=|==|!=|<|(?<!-)>};
317
our $Arithmetic = qr{\+|-|\*|\/|%};
318 319 320
our $Operators	= qr{
			<=|>=|==|!=|
			=>|->|<<|>>|<|>|!|~|
321
			&&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
322 323
		  }x;

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

326
our $BasicType;
327
our $NonptrType;
328
our $NonptrTypeMisordered;
329
our $NonptrTypeWithAttr;
330
our $Type;
331
our $TypeMisordered;
332
our $Declare;
333
our $DeclareMisordered;
334

335 336
our $NON_ASCII_UTF8	= qr{
	[\xC2-\xDF][\x80-\xBF]               # non-overlong 2-byte
337 338 339 340 341 342 343 344
	|  \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;

345 346 347 348 349
our $UTF8	= qr{
	[\x09\x0A\x0D\x20-\x7E]              # ASCII
	| $NON_ASCII_UTF8
}x;

350 351 352 353 354
our $typeOtherOSTypedefs = qr{(?x:
	u_(?:char|short|int|long) |          # bsd
	u(?:nchar|short|int|long)            # sysv
)};

355
our $typeTypedefs = qr{(?x:
356
	(?:__)?(?:u|s|be|le)(?:8|16|32|64)|
357 358 359
	atomic_t
)};

360
our $logFunctions = qr{(?x:
361
	printk(?:_ratelimited|_once|)|
362
	(?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
363
	WARN(?:_RATELIMIT|_ONCE|)|
364
	panic|
J
Joe Perches 已提交
365 366
	MODULE_[A-Z_]+|
	seq_vprintf|seq_printf|seq_puts
367 368
)};

369 370 371 372 373 374
our $signature_tags = qr{(?xi:
	Signed-off-by:|
	Acked-by:|
	Tested-by:|
	Reviewed-by:|
	Reported-by:|
375
	Suggested-by:|
376 377 378 379
	To:|
	Cc:
)};

380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
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},
);

399 400
our @typeList = (
	qr{void},
401 402 403 404 405 406 407 408 409
	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},
410 411 412 413 414 415 416 417 418
	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},
419
	@typeListMisordered,
420
);
421 422 423 424 425 426
our @typeListWithAttr = (
	@typeList,
	qr{struct\s+$InitAttribute\s+$Ident},
	qr{union\s+$InitAttribute\s+$Ident},
);

427 428 429
our @modifierList = (
	qr{fastcall},
);
430

431 432 433 434 435 436 437 438 439
our @mode_permission_funcs = (
	["module_param", 3],
	["module_param_(?:array|named|string)", 4],
	["module_param_array_named", 5],
	["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
	["proc_create(?:_data|)", 2],
	["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
);

440 441 442 443 444 445 446
#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];
}

447 448 449 450 451 452 453 454
our $mode_perms_world_writable = qr{
	S_IWUGO		|
	S_IWOTH		|
	S_IRWXUGO	|
	S_IALLUGO	|
	0[0-7][0-7][2367]
}x;

455 456
our $allowed_asm_includes = qr{(?x:
	irq|
457 458 459
	memory|
	time|
	reboot
460 461 462
)};
# memory.h: ARM has a custom one

463 464 465 466
# Load common spelling mistakes and build regular expression list.
my $misspellings;
my %spelling_fix;

467 468 469
if (open(my $spelling, '<', $spelling_file)) {
	while (<$spelling>) {
		my $line = $_;
470

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

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

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

479 480 481 482 483
		$spelling_fix{$suspect} = $fix;
	}
	close($spelling);
} else {
	warn "No typos will be found - file '$spelling_file': $!\n";
484 485
}

486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
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;

512
sub build_types {
513 514
	my $mods = "(?x:  \n" . join("|\n  ", @modifierList) . "\n)";
	my $all = "(?x:  \n" . join("|\n  ", @typeList) . "\n)";
515
	my $Misordered = "(?x:  \n" . join("|\n  ", @typeListMisordered) . "\n)";
516
	my $allWithAttr = "(?x:  \n" . join("|\n  ", @typeListWithAttr) . "\n)";
517
	$Modifier	= qr{(?:$Attribute|$Sparse|$mods)};
518 519 520 521 522
	$BasicType	= qr{
				(?:$typeOtherOSTypedefs\b)|
				(?:$typeTypedefs\b)|
				(?:${all}\b)
		}x;
523
	$NonptrType	= qr{
524
			(?:$Modifier\s+|const\s+)*
525
			(?:
526
				(?:typeof|__typeof__)\s*\([^\)]*\)|
527
				(?:$typeOtherOSTypedefs\b)|
528
				(?:$typeTypedefs\b)|
529
				(?:${all}\b)
530
			)
531
			(?:\s+$Modifier|\s+const)*
532
		  }x;
533 534 535 536 537 538 539
	$NonptrTypeMisordered	= qr{
			(?:$Modifier\s+|const\s+)*
			(?:
				(?:${Misordered}\b)
			)
			(?:\s+$Modifier|\s+const)*
		  }x;
540 541 542 543 544
	$NonptrTypeWithAttr	= qr{
			(?:$Modifier\s+|const\s+)*
			(?:
				(?:typeof|__typeof__)\s*\([^\)]*\)|
				(?:$typeTypedefs\b)|
545
				(?:$typeOtherOSTypedefs\b)|
546 547 548 549
				(?:${allWithAttr}\b)
			)
			(?:\s+$Modifier|\s+const)*
		  }x;
550
	$Type	= qr{
551
			$NonptrType
552
			(?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
553
			(?:\s+$Inline|\s+$Modifier)*
554
		  }x;
555 556 557 558 559
	$TypeMisordered	= qr{
			$NonptrTypeMisordered
			(?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
			(?:\s+$Inline|\s+$Modifier)*
		  }x;
560
	$Declare	= qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
561
	$DeclareMisordered	= qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
562 563
}
build_types();
564

565
our $Typecast	= qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
566 567 568 569 570 571

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

575 576 577 578 579 580
our $declaration_macros = qr{(?x:
	(?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,2}\s*\(|
	(?:$Storage\s+)?LIST_HEAD\s*\(|
	(?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
)};

581 582 583
sub deparenthesize {
	my ($string) = @_;
	return "" if (!defined($string));
584 585 586 587 588 589

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

590
	$string =~ s@\s+@ @g;
591

592 593 594
	return $string;
}

595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
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;
613 614 615
		} 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*[;\{]/) {
616 617 618 619 620 621 622 623 624 625
			$camelcase{$1} = 1;
		}
	}
}

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

	my $files;
626 627 628 629
	my $camelcase_cache = "";
	my @include_files = ();

	$camelcase_seeded = 1;
630

631
	if (-e ".git") {
632 633
		my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
		chomp $git_last_include_commit;
634
		$camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
635
	} else {
636
		my $last_mod_date = 0;
637
		$files = `find $root/include -name "*.h"`;
638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
		@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;
657
	}
658

659
	if (-e ".git") {
660 661 662 663
		$files = `git ls-files "include/*.h"`;
		@include_files = split('\n', $files);
	}

664 665 666
	foreach my $file (@include_files) {
		seed_camelcase_file($file);
	}
667

668
	if ($camelcase_cache ne "") {
669
		unlink glob ".checkpatch-camelcase.*";
670 671
		open(my $camelcase_file, '>', "$camelcase_cache")
		    or warn "$P: Can't write '$camelcase_cache' $!\n";
672 673 674 675 676
		foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
			print $camelcase_file ("$_\n");
		}
		close($camelcase_file);
	}
677 678
}

679 680 681 682 683 684 685 686 687
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);

688 689
	return ($id, $desc) if ($#lines < 0);

690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
	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\./) {
	} else {
		$id = substr($lines[0], 0, 12);
		$desc = substr($lines[0], 41);
	}

	return ($id, $desc);
}

709 710
$chk_signoff = 0 if ($file);

711
my @rawlines = ();
712
my @lines = ();
713
my @fixed = ();
714 715
my @fixed_inserted = ();
my @fixed_deleted = ();
716 717
my $fixlinenr = -1;

718
my $vname;
719
for my $filename (@ARGV) {
720
	my $FILE;
721
	if ($file) {
722
		open($FILE, '-|', "diff -u /dev/null $filename") ||
723
			die "$P: $filename: diff failed - $!\n";
724 725
	} elsif ($filename eq '-') {
		open($FILE, '<&STDIN');
726
	} else {
727
		open($FILE, '<', "$filename") ||
728
			die "$P: $filename: open failed - $!\n";
729
	}
730 731 732 733 734
	if ($filename eq '-') {
		$vname = 'Your patch';
	} else {
		$vname = $filename;
	}
735
	while (<$FILE>) {
736 737 738
		chomp;
		push(@rawlines, $_);
	}
739
	close($FILE);
740
	if (!process($filename)) {
741 742 743
		$exit = 1;
	}
	@rawlines = ();
744
	@lines = ();
745
	@fixed = ();
746 747
	@fixed_inserted = ();
	@fixed_deleted = ();
748
	$fixlinenr = -1;
749 750 751 752 753
}

exit($exit);

sub top_of_kernel_tree {
754 755 756 757 758 759 760 761 762 763 764 765
	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;
		}
766
	}
767
	return 1;
768
}
769

770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788
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;
789
		$name = trim($name);
790 791 792 793 794 795 796 797 798 799 800 801 802 803
		$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 = "";
		}
	}

804
	$name = trim($name);
805
	$name =~ s/^\"|\"$//g;
806
	$address = trim($address);
807 808 809 810 811 812 813 814 815 816 817 818 819 820 821
	$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;

822
	$name = trim($name);
823
	$name =~ s/^\"|\"$//g;
824
	$address = trim($address);
825 826 827 828 829 830 831 832 833 834 835 836 837 838 839

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

840
sub which {
841
	my ($bin) = @_;
842

843 844 845 846
	foreach my $path (split(/:/, $ENV{PATH})) {
		if (-e "$path/$bin") {
			return "$path/$bin";
		}
847 848
	}

849
	return "";
850 851
}

852 853 854 855 856 857 858 859 860 861 862 863
sub which_conf {
	my ($conf) = @_;

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

	return "";
}

864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883
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;
}
884
sub copy_spacing {
885
	(my $res = shift) =~ tr/\t/ /c;
886 887
	return $res;
}
888

889 890 891 892 893 894 895 896 897 898 899 900 901
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));
}

902 903 904 905 906 907 908 909 910 911 912
my $sanitise_quote = '';

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

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
913 914 915 916 917 918
sub sanitise_line {
	my ($line) = @_;

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

919
	my $qlen = 0;
920 921
	my $off = 0;
	my $c;
922

923 924 925 926 927 928 929 930 931 932 933 934 935 936
	# 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;
937
		}
938
		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
939 940 941 942
			$sanitise_quote = '';
			substr($res, $off, 2, "$;$;");
			$off++;
			next;
943
		}
944 945 946 947 948 949 950
		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
			$sanitise_quote = '//';

			substr($res, $off, 2, $sanitise_quote);
			$off++;
			next;
		}
951 952 953 954 955 956 957

		# 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;
958
		}
959 960 961 962
		# Regular quotes.
		if ($c eq "'" || $c eq '"') {
			if ($sanitise_quote eq '') {
				$sanitise_quote = $c;
963

964 965 966 967 968 969
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
970

971
		#print "c<$c> SQ<$sanitise_quote>\n";
972 973
		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
			substr($res, $off, 1, $;);
974 975
		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
			substr($res, $off, 1, $;);
976 977 978 979 980
		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
			substr($res, $off, 1, 'X');
		} else {
			substr($res, $off, 1, $c);
		}
981 982
	}

983 984 985 986
	if ($sanitise_quote eq '//') {
		$sanitise_quote = '';
	}

987
	# The pathname on a #include may be surrounded by '<' and '>'.
988
	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
989 990 991 992
		my $clean = 'X' x length($1);
		$res =~ s@\<.*\>@<$clean>@;

	# The whole of a #error is a string.
993
	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
994
		my $clean = 'X' x length($1);
995
		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
996 997
	}

998 999 1000
	return $res;
}

1001 1002 1003
sub get_quoted_string {
	my ($line, $rawline) = @_;

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

1008 1009 1010 1011 1012 1013
sub ctx_statement_block {
	my ($linenr, $remain, $off) = @_;
	my $line = $linenr - 1;
	my $blk = '';
	my $soff = $off;
	my $coff = $off - 1;
1014
	my $coff_set = 0;
1015

1016 1017
	my $loff = 0;

1018 1019
	my $type = '';
	my $level = 0;
1020
	my @stack = ();
1021
	my $p;
1022 1023
	my $c;
	my $len = 0;
1024 1025

	my $remainder;
1026
	while (1) {
1027 1028
		@stack = (['', 0]) if ($#stack == -1);

1029
		#warn "CSB: blk<$blk> remain<$remain>\n";
1030 1031 1032 1033
		# If we are about to drop off the end, pull in more
		# context.
		if ($off >= $len) {
			for (; $remain > 0; $line++) {
1034
				last if (!defined $lines[$line]);
1035
				next if ($lines[$line] =~ /^-/);
1036
				$remain--;
1037
				$loff = $len;
1038
				$blk .= $lines[$line] . "\n";
1039 1040 1041 1042 1043 1044
				$len = length($blk);
				$line++;
				last;
			}
			# Bail if there is no further context.
			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
1045
			if ($off >= $len) {
1046 1047
				last;
			}
1048 1049 1050 1051
			if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
				$level++;
				$type = '#';
			}
1052
		}
1053
		$p = $c;
1054
		$c = substr($blk, $off, 1);
1055
		$remainder = substr($blk, $off);
1056

1057
		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067

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

1068 1069 1070 1071 1072 1073
		# Statement ends at the ';' or a close '}' at the
		# outermost level.
		if ($level == 0 && $c eq ';') {
			last;
		}

1074
		# An else is really a conditional as long as its not else if
1075 1076 1077 1078 1079 1080 1081 1082
		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";
1083 1084
		}

1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
		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;
1095 1096
				$coff_set = 1;
				#warn "CSB: mark coff<$coff>\n";
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107
			}
		}
		if (($type eq '' || $type eq '{') && $c eq '{') {
			$level++;
			$type = '{';
		}
		if ($type eq '{' && $c eq '}') {
			$level--;
			$type = ($level != 0)? '{' : '';

			if ($level == 0) {
1108 1109 1110
				if (substr($blk, $off + 1, 1) eq ';') {
					$off++;
				}
1111 1112 1113
				last;
			}
		}
1114 1115 1116 1117 1118 1119 1120
		# Preprocessor commands end at the newline unless escaped.
		if ($type eq '#' && $c eq "\n" && $p ne "\\") {
			$level--;
			$type = '';
			$off++;
			last;
		}
1121 1122
		$off++;
	}
1123
	# We are truly at the end, so shuffle to the next line.
1124
	if ($off == $len) {
1125
		$loff = $len + 1;
1126 1127 1128
		$line++;
		$remain--;
	}
1129 1130 1131 1132 1133 1134 1135

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

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

1136
	#print "coff<$coff> soff<$off> loff<$loff>\n";
1137 1138 1139 1140 1141

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

1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184
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;
	}
}

1185 1186 1187 1188 1189 1190
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

1191
	# Grab the first conditional/block pair.
1192 1193
	($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
1194
	#print "F: c<$condition> s<$statement> remain<$remain>\n";
1195 1196 1197 1198 1199 1200 1201
	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.
1202 1203 1204
	for (;;) {
		($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
1205
		#print "C: c<$condition> s<$statement> remain<$remain>\n";
1206
		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1207 1208
		#print "C: push\n";
		push(@chunks, [ $condition, $statement ]);
1209 1210 1211
	}

	return ($level, $linenr, @chunks);
1212 1213
}

1214
sub ctx_block_get {
1215
	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1216 1217 1218 1219 1220 1221 1222
	my $line;
	my $start = $linenr - 1;
	my $blk = '';
	my @o;
	my @c;
	my @res = ();

1223
	my $level = 0;
1224
	my @stack = ($level);
1225 1226 1227 1228 1229
	for ($line = $start; $remain > 0; $line++) {
		next if ($rawlines[$line] =~ /^-/);
		$remain--;

		$blk .= $rawlines[$line];
1230 1231

		# Handle nested #if/#else.
1232
		if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1233
			push(@stack, $level);
1234
		} elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1235
			$level = $stack[$#stack - 1];
1236
		} elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1237 1238 1239
			$level = pop(@stack);
		}

1240
		foreach my $c (split(//, $lines[$line])) {
1241 1242 1243 1244 1245
			##print "C<$c>L<$level><$open$close>O<$off>\n";
			if ($off > 0) {
				$off--;
				next;
			}
1246

1247 1248 1249 1250 1251 1252 1253
			if ($c eq $close && $level > 0) {
				$level--;
				last if ($level == 0);
			} elsif ($c eq $open) {
				$level++;
			}
		}
1254

1255
		if (!$outer || $level <= 1) {
1256
			push(@res, $rawlines[$line]);
1257 1258
		}

1259
		last if ($level == 0);
1260 1261
	}

1262
	return ($level, @res);
1263 1264 1265 1266
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

1267 1268
	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
	return @r;
1269 1270 1271 1272
}
sub ctx_block {
	my ($linenr, $remain) = @_;

1273 1274
	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
	return @r;
1275 1276
}
sub ctx_statement {
1277 1278 1279 1280 1281 1282
	my ($linenr, $remain, $off) = @_;

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

1285
	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1286
}
1287 1288 1289 1290 1291
sub ctx_statement_level {
	my ($linenr, $remain, $off) = @_;

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
1292 1293 1294 1295 1296

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

	# Catch a comment on the end of the line itself.
1297
	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1298 1299 1300 1301 1302 1303 1304
	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++) {
1305 1306
		my $line = $rawlines[$linenr - 1];
		#warn "           $line\n";
1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328
		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);

1329
	##print "LINE: $rawlines[$end_line - 1 ]\n";
1330 1331 1332 1333 1334
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350
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;
}

1351 1352 1353
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
1354

1355 1356 1357 1358 1359 1360
	$res = '';
	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
		$res .= $1;
		if ($2 ne '') {
			$coded = sprintf("^%c", unpack('C', $2) + 64);
			$res .= $coded;
1361 1362
		}
	}
1363
	$res =~ s/$/\$/;
1364

1365
	return $res;
1366 1367
}

1368
my $av_preprocessor = 0;
1369
my $av_pending;
1370
my @av_paren_type;
1371
my $av_pend_colon;
1372 1373 1374

sub annotate_reset {
	$av_preprocessor = 0;
1375 1376
	$av_pending = '_';
	@av_paren_type = ('E');
1377
	$av_pend_colon = 'O';
1378 1379
}

1380 1381
sub annotate_values {
	my ($stream, $type) = @_;
1382

1383
	my $res;
1384
	my $var = '_' x length($stream);
1385 1386
	my $cur = $stream;

1387
	print "$stream\n" if ($dbg_values > 1);
1388 1389

	while (length($cur)) {
1390
		@av_paren_type = ('E') if ($#av_paren_type < 0);
1391
		print " <" . join('', @av_paren_type) .
1392
				"> <$type> <$av_pending>" if ($dbg_values > 1);
1393
		if ($cur =~ /^(\s+)/o) {
1394 1395
			print "WS($1)\n" if ($dbg_values > 1);
			if ($1 =~ /\n/ && $av_preprocessor) {
1396
				$type = pop(@av_paren_type);
1397
				$av_preprocessor = 0;
1398 1399
			}

1400
		} elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1401 1402
			print "CAST($1)\n" if ($dbg_values > 1);
			push(@av_paren_type, $type);
1403
			$type = 'c';
1404

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

1409 1410 1411 1412
		} elsif ($cur =~ /^($Modifier)\s*/) {
			print "MODIFIER($1)\n" if ($dbg_values > 1);
			$type = 'T';

1413
		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1414
			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1415
			$av_preprocessor = 1;
1416 1417 1418 1419 1420 1421
			push(@av_paren_type, $type);
			if ($2 ne '') {
				$av_pending = 'N';
			}
			$type = 'E';

1422
		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1423 1424 1425
			print "UNDEF($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;
			push(@av_paren_type, $type);
1426

1427
		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1428
			print "PRE_START($1)\n" if ($dbg_values > 1);
1429
			$av_preprocessor = 1;
1430 1431 1432

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
1433
			$type = 'E';
1434

1435
		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1436 1437 1438 1439 1440
			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;

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

1441
			$type = 'E';
1442

1443
		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1444 1445 1446 1447 1448 1449 1450 1451
			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);
1452
			$type = 'E';
1453 1454

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

1457 1458 1459 1460 1461
		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
			print "ATTR($1)\n" if ($dbg_values > 1);
			$av_pending = $type;
			$type = 'N';

1462
		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1463
			print "SIZEOF($1)\n" if ($dbg_values > 1);
1464
			if (defined $2) {
1465
				$av_pending = 'V';
1466 1467 1468
			}
			$type = 'N';

1469
		} elsif ($cur =~ /^(if|while|for)\b/o) {
1470
			print "COND($1)\n" if ($dbg_values > 1);
1471
			$av_pending = 'E';
1472 1473
			$type = 'N';

1474 1475 1476 1477 1478
		} elsif ($cur =~/^(case)/o) {
			print "CASE($1)\n" if ($dbg_values > 1);
			$av_pend_colon = 'C';
			$type = 'N';

1479
		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1480
			print "KEYWORD($1)\n" if ($dbg_values > 1);
1481 1482 1483
			$type = 'N';

		} elsif ($cur =~ /^(\()/o) {
1484
			print "PAREN('$1')\n" if ($dbg_values > 1);
1485 1486
			push(@av_paren_type, $av_pending);
			$av_pending = '_';
1487 1488 1489
			$type = 'N';

		} elsif ($cur =~ /^(\))/o) {
1490 1491 1492
			my $new_type = pop(@av_paren_type);
			if ($new_type ne '_') {
				$type = $new_type;
1493 1494
				print "PAREN('$1') -> $type\n"
							if ($dbg_values > 1);
1495
			} else {
1496
				print "PAREN('$1')\n" if ($dbg_values > 1);
1497 1498
			}

1499
		} elsif ($cur =~ /^($Ident)\s*\(/o) {
1500
			print "FUNC($1)\n" if ($dbg_values > 1);
1501
			$type = 'V';
1502
			$av_pending = 'V';
1503

1504 1505
		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
			if (defined $2 && $type eq 'C' || $type eq 'T') {
1506
				$av_pend_colon = 'B';
1507 1508
			} elsif ($type eq 'E') {
				$av_pend_colon = 'L';
1509 1510 1511 1512
			}
			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
			$type = 'V';

1513
		} elsif ($cur =~ /^($Ident|$Constant)/o) {
1514
			print "IDENT($1)\n" if ($dbg_values > 1);
1515 1516 1517
			$type = 'V';

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

1521
		} elsif ($cur =~/^(;|{|})/) {
1522
			print "END($1)\n" if ($dbg_values > 1);
1523
			$type = 'E';
1524 1525
			$av_pend_colon = 'O';

1526 1527 1528 1529
		} elsif ($cur =~/^(,)/) {
			print "COMMA($1)\n" if ($dbg_values > 1);
			$type = 'C';

1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543
		} 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';
1544

1545
		} elsif ($cur =~ /^(\[)/o) {
1546
			print "CLOSE($1)\n" if ($dbg_values > 1);
1547 1548
			$type = 'N';

1549
		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561
			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';

1562
		} elsif ($cur =~ /^($Operators)/o) {
1563
			print "OP($1)\n" if ($dbg_values > 1);
1564 1565 1566 1567 1568
			if ($1 ne '++' && $1 ne '--') {
				$type = 'N';
			}

		} elsif ($cur =~ /(^.)/o) {
1569
			print "C($1)\n" if ($dbg_values > 1);
1570 1571 1572 1573 1574
		}
		if (defined $1) {
			$cur = substr($cur, length($1));
			$res .= $type x length($1);
		}
1575
	}
1576

1577
	return ($res, $var);
1578 1579
}

1580
sub possible {
1581
	my ($possible, $line) = @_;
1582
	my $notPermitted = qr{(?:
1583 1584 1585 1586
		^(?:
			$Modifier|
			$Storage|
			$Type|
1587 1588 1589
			DEFINE_\S+
		)$|
		^(?:
1590 1591 1592 1593 1594
			goto|
			return|
			case|
			else|
			asm|__asm__|
1595 1596 1597
			do|
			\#|
			\#\#|
1598
		)(?:\s|$)|
1599
		^(?:typedef|struct|enum)\b
1600 1601 1602
	    )}x;
	warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
	if ($possible !~ $notPermitted) {
1603 1604 1605 1606 1607 1608 1609
		# 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;
1610
			for my $modifier (split(' ', $possible)) {
1611 1612 1613 1614
				if ($modifier !~ $notPermitted) {
					warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
					push(@modifierList, $modifier);
				}
1615
			}
1616 1617 1618 1619 1620

		} else {
			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
			push(@typeList, $possible);
		}
1621
		build_types();
1622 1623
	} else {
		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1624 1625 1626
	}
}

1627 1628
my $prefix = '';

1629
sub show_type {
1630
	my ($type) = @_;
1631

1632 1633 1634
	return defined $use_type{$type} if (scalar keys %use_type > 0);

	return !defined $ignore_type{$type};
1635 1636
}

1637
sub report {
1638 1639 1640 1641
	my ($level, $type, $msg) = @_;

	if (!show_type($type) ||
	    (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1642 1643
		return 0;
	}
1644 1645
	my $line;
	if ($show_types) {
1646
		$line = "$prefix$level:$type: $msg\n";
1647
	} else {
1648
		$line = "$prefix$level: $msg\n";
1649
	}
1650 1651
	$line = (split('\n', $line))[0] . "\n" if ($terse);

1652
	push(our @report, $line);
1653 1654

	return 1;
1655
}
1656

1657
sub report_dump {
1658
	our @report;
1659
}
1660

1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723
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
		if ($line =~ /^(?:\+\+\+\|\-\-\-)\s+\S+/) {	#new filename
			$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;
}

1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744
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);
}

1745
sub ERROR {
1746 1747 1748
	my ($type, $msg) = @_;

	if (report("ERROR", $type, $msg)) {
1749 1750
		our $clean = 0;
		our $cnt_error++;
1751
		return 1;
1752
	}
1753
	return 0;
1754 1755
}
sub WARN {
1756 1757 1758
	my ($type, $msg) = @_;

	if (report("WARNING", $type, $msg)) {
1759 1760
		our $clean = 0;
		our $cnt_warn++;
1761
		return 1;
1762
	}
1763
	return 0;
1764 1765
}
sub CHK {
1766 1767 1768
	my ($type, $msg) = @_;

	if ($check && report("CHECK", $type, $msg)) {
1769 1770
		our $clean = 0;
		our $cnt_chk++;
1771
		return 1;
1772
	}
1773
	return 0;
1774 1775
}

1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798
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 ".../") {
1799 1800
		WARN("USE_RELATIVE_PATH",
		     "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1801 1802 1803
	}
}

1804 1805 1806
sub trim {
	my ($string) = @_;

1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823
	$string =~ s/^\s+|\s+$//g;

	return $string;
}

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

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

	return $string;
}

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

	$string =~ s/\s+$//;
1824 1825 1826 1827

	return $string;
}

1828 1829 1830 1831 1832 1833 1834 1835
sub string_find_replace {
	my ($string, $find, $replace) = @_;

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

	return $string;
}

1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850
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";
}

1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877
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;
		}
	}

1878
	return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
1879 1880
}

1881 1882 1883 1884 1885
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
1886
	my $prevrawline="";
1887
	my $stashline="";
1888
	my $stashrawline="";
1889

1890
	my $length;
1891 1892 1893 1894
	my $indent;
	my $previndent=0;
	my $stashindent=0;

1895
	our $clean = 1;
1896 1897 1898
	my $signoff = 0;
	my $is_patch = 0;

1899
	my $in_header_lines = $file ? 0 : 1;
1900
	my $in_commit_log = 0;		#Scanning lines before patch
1901
	my $commit_log_long_line = 0;
1902
	my $reported_maintainer_file = 0;
1903 1904
	my $non_utf8_charset = 0;

1905
	my $last_blank_line = 0;
1906
	my $last_coalesced_string_linenr = -1;
1907

1908
	our @report = ();
1909 1910 1911 1912 1913
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

1914 1915 1916 1917 1918 1919
	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
	my $in_comment = 0;
1920
	my $comment_edge = 0;
1921
	my $first_line = 0;
1922
	my $p1_prefix = '';
1923

1924 1925 1926
	my $prev_values = 'E';

	# suppression flags
1927
	my %suppress_ifbraces;
1928
	my %suppress_whiletrailers;
1929
	my %suppress_export;
1930
	my $suppress_statement = 0;
1931

1932
	my %signatures = ();
1933

1934
	# Pre-scan the patch sanitizing the lines.
1935
	# Pre-scan the patch looking for any __setup documentation.
1936
	#
1937 1938
	my @setup_docs = ();
	my $setup_docs = 0;
1939

1940 1941
	my $camelcase_file_seeded = 0;

1942
	sanitise_line_reset();
1943 1944
	my $line;
	foreach my $rawline (@rawlines) {
1945 1946
		$linenr++;
		$line = $rawline;
1947

1948 1949
		push(@fixed, $rawline) if ($fix);

1950
		if ($rawline=~/^\+\+\+\s+(\S+)/) {
1951 1952 1953 1954
			$setup_docs = 0;
			if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
				$setup_docs = 1;
			}
1955 1956 1957 1958 1959 1960 1961 1962 1963
			#next;
		}
		if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1964
			$in_comment = 0;
1965 1966 1967 1968 1969 1970

			# 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;
1971 1972 1973 1974 1975 1976
			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";
1977
				last if (!defined $rawlines[$ln - 1]);
1978 1979 1980 1981 1982
				if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
				    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
					($edge) = $1;
					last;
				}
1983 1984 1985 1986 1987 1988 1989 1990 1991
			}
			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 &&
1992
			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1993 1994 1995 1996 1997 1998 1999
			{
				$in_comment = 1;
			}

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

2000
		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2001
			# Standardise the strings and chars within the input to
2002
			# simplify matching -- only bother with positive lines.
2003
			$line = sanitise_line($rawline);
2004
		}
2005 2006 2007 2008 2009 2010 2011 2012 2013 2014
		push(@lines, $line);

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

		#print "==>$rawline\n";
		#print "-->$line\n";
2015 2016 2017 2018 2019 2020

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

2021 2022
	$prefix = '';

2023 2024
	$realcnt = 0;
	$linenr = 0;
2025
	$fixlinenr = -1;
2026 2027
	foreach my $line (@lines) {
		$linenr++;
2028
		$fixlinenr++;
2029 2030
		my $sline = $line;	#copy of $line
		$sline =~ s/$;/ /g;	#with comments as spaces
2031

2032
		my $rawline = $rawlines[$linenr - 1];
2033

2034
#extract the line range in the file after the patch is applied
2035
		if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2036
			$is_patch = 1;
2037
			$first_line = $linenr + 1;
2038 2039 2040 2041 2042 2043
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
2044
			annotate_reset();
2045 2046
			$prev_values = 'E';

2047
			%suppress_ifbraces = ();
2048
			%suppress_whiletrailers = ();
2049
			%suppress_export = ();
2050
			$suppress_statement = 0;
2051 2052
			next;

2053 2054 2055
# 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.
2056
		} elsif ($line =~ /^( |\+|$)/) {
2057
			$realline++;
2058
			$realcnt-- if ($realcnt != 0);
2059

2060
			# Measure the line length and indent.
2061
			($length, $indent) = line_stats($rawline);
2062 2063 2064 2065

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

2068
			#warn "line<$line>\n";
2069

2070 2071
		} elsif ($realcnt == 1) {
			$realcnt--;
2072 2073
		}

2074 2075
		my $hunk_line = ($realcnt != 0);

2076
#make up the handle for any error we report on this line
2077 2078 2079
		$prefix = "$filename:$realline: " if ($emacs && $file);
		$prefix = "$filename:$linenr: " if ($emacs && !$file);

2080 2081
		$here = "#$linenr: " if (!$file);
		$here = "#$realline: " if ($file);
2082

2083
		my $found_file = 0;
2084
		# extract the filename as it passes
2085 2086
		if ($line =~ /^diff --git.*?(\S+)$/) {
			$realfile = $1;
2087
			$realfile =~ s@^([^/]*)/@@ if (!$file);
2088
			$in_commit_log = 0;
2089
			$found_file = 1;
2090
		} elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2091
			$realfile = $1;
2092
			$realfile =~ s@^([^/]*)/@@ if (!$file);
2093
			$in_commit_log = 0;
2094 2095

			$p1_prefix = $1;
2096 2097
			if (!$file && $tree && $p1_prefix ne '' &&
			    -e "$root/$p1_prefix") {
2098 2099
				WARN("PATCH_PREFIX",
				     "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2100
			}
2101

2102
			if ($realfile =~ m@^include/asm/@) {
2103 2104
				ERROR("MODIFIED_INCLUDE_ASM",
				      "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2105
			}
2106 2107 2108 2109 2110 2111 2112 2113 2114
			$found_file = 1;
		}

		if ($found_file) {
			if ($realfile =~ m@^(drivers/net/|net/)@) {
				$check = 1;
			} else {
				$check = $check_orig;
			}
2115 2116 2117
			next;
		}

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

2120 2121 2122
		my $hereline = "$here\n$rawline\n";
		my $herecurr = "$here\n$rawline\n";
		my $hereprev = "$here\n$prevrawline\n$rawline\n";
2123

2124 2125
		$cnt_lines++ if ($realcnt != 0);

2126 2127 2128
# Check for incorrect file permissions
		if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
			my $permhere = $here . "FILE: $realfile\n";
2129 2130
			if ($realfile !~ m@scripts/@ &&
			    $realfile !~ /\.(py|pl|awk|sh)$/) {
2131 2132
				ERROR("EXECUTE_PERMISSIONS",
				      "do not set execute permissions for source files\n" . $permhere);
2133 2134 2135
			}
		}

2136
# Check the patch for a signoff:
2137
		if ($line =~ /^\s*signed-off-by:/i) {
2138
			$signoff++;
2139
			$in_commit_log = 0;
2140 2141
		}

2142 2143 2144 2145 2146 2147
# 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;
		}

2148
# Check signature styles
2149
		if (!$in_header_lines &&
2150
		    $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2151 2152 2153 2154 2155 2156
			my $space_before = $1;
			my $sign_off = $2;
			my $space_after = $3;
			my $email = $4;
			my $ucfirst_sign_off = ucfirst(lc($sign_off));

2157 2158 2159 2160
			if ($sign_off !~ /$signature_tags/) {
				WARN("BAD_SIGN_OFF",
				     "Non-standard signature: $sign_off\n" . $herecurr);
			}
2161
			if (defined $space_before && $space_before ne "") {
2162 2163 2164
				if (WARN("BAD_SIGN_OFF",
					 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
				    $fix) {
2165
					$fixed[$fixlinenr] =
2166 2167
					    "$ucfirst_sign_off $email";
				}
2168 2169
			}
			if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2170 2171 2172
				if (WARN("BAD_SIGN_OFF",
					 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
				    $fix) {
2173
					$fixed[$fixlinenr] =
2174 2175 2176
					    "$ucfirst_sign_off $email";
				}

2177 2178
			}
			if (!defined $space_after || $space_after ne " ") {
2179 2180 2181
				if (WARN("BAD_SIGN_OFF",
					 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
				    $fix) {
2182
					$fixed[$fixlinenr] =
2183 2184
					    "$ucfirst_sign_off $email";
				}
2185
			}
2186 2187 2188 2189

			my ($email_name, $email_address, $comment) = parse_email($email);
			my $suggested_email = format_email(($email_name, $email_address));
			if ($suggested_email eq "") {
2190 2191
				ERROR("BAD_SIGN_OFF",
				      "Unrecognized email address: '$email'\n" . $herecurr);
2192 2193 2194 2195 2196 2197 2198 2199 2200
			} 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) {
2201 2202
					WARN("BAD_SIGN_OFF",
					     "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2203
				}
2204
			}
2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215

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

2218 2219 2220 2221 2222 2223 2224
# 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);
		}

2225 2226 2227 2228 2229 2230
# 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);
		}

2231 2232 2233 2234 2235 2236
# 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);
		}

2237 2238 2239 2240 2241 2242 2243 2244
# Check for line lengths > 75 in commit log, warn once
		if ($in_commit_log && !$commit_log_long_line &&
		    length($line) > 75) {
			WARN("COMMIT_LOG_LONG_LINE",
			     "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
			$commit_log_long_line = 1;
		}

2245 2246
# Check for git id commit length and improperly formed commit descriptions
		if ($in_commit_log && $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i) {
2247 2248
			my $init_char = $1;
			my $orig_commit = lc($2);
2249 2250 2251 2252 2253
			my $short = 1;
			my $long = 0;
			my $case = 1;
			my $space = 1;
			my $hasdesc = 0;
2254
			my $hasparens = 0;
2255 2256 2257 2258 2259 2260 2261 2262 2263 2264
			my $id = '0123456789ab';
			my $orig_desc = "commit description";
			my $description = "";

			$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;
2265
				$hasparens = 1;
2266 2267 2268 2269
			} elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
				 defined $rawlines[$linenr] &&
				 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
				$orig_desc = $1;
2270
				$hasparens = 1;
2271 2272 2273 2274 2275 2276 2277
			} 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;
2278
				$hasparens = 1;
2279 2280 2281 2282 2283
			}

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

2284
			if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
2285 2286 2287
				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);
			}
2288 2289
		}

2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300
# 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))))) {
			$reported_maintainer_file = 1;
			WARN("FILE_PATH_CHANGES",
			     "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
		}

2301
# Check for wrappage within a valid hunk of the file
2302
		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2303 2304
			ERROR("CORRUPTED_PATCH",
			      "patch seems to be corrupt (line wrapped?)\n" .
2305
				$herecurr) if (!$emitted_corrupt++);
2306 2307
		}

2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321
# Check for absolute kernel paths.
		if ($tree) {
			while ($line =~ m{(?:^|\s)(/\S*)}g) {
				my $file = $1;

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

2322 2323
# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2324 2325 2326 2327 2328 2329 2330
		    $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";

2331 2332
			CHK("INVALID_UTF8",
			    "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2333 2334
		}

2335 2336 2337
# 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 =~ /^$/ &&
2338 2339
		    !($rawline =~ /^\s+\S/ ||
		      $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
2340 2341 2342 2343
			$in_header_lines = 0;
			$in_commit_log = 1;
		}

2344 2345 2346 2347 2348 2349 2350 2351 2352
# 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 =~ /^$/ &&
2353
		    $rawline =~ /$NON_ASCII_UTF8/) {
2354
			WARN("UTF8_BEFORE_PATCH",
2355 2356 2357
			    "8-bit UTF-8 used in possible commit log\n" . $herecurr);
		}

2358
# Check for various typo / spelling mistakes
2359 2360
		if (defined($misspellings) &&
		    ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
2361
			while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375
				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]+$/);
				my $msg_type = \&WARN;
				$msg_type = \&CHK if ($file);
				if (&{$msg_type}("TYPO_SPELLING",
						 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
				    $fix) {
					$fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
				}
			}
		}

2376 2377
# ignore non-hunk lines and lines being removed
		next if (!$hunk_line || $line =~ /^-/);
2378 2379

#trailing whitespace
2380
		if ($line =~ /^\+.*\015/) {
2381
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2382 2383 2384
			if (ERROR("DOS_LINE_ENDINGS",
				  "DOS line endings\n" . $herevet) &&
			    $fix) {
2385
				$fixed[$fixlinenr] =~ s/[\s\015]+$//;
2386
			}
2387 2388
		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2389 2390 2391
			if (ERROR("TRAILING_WHITESPACE",
				  "trailing whitespace\n" . $herevet) &&
			    $fix) {
2392
				$fixed[$fixlinenr] =~ s/\s+$//;
2393 2394
			}

2395
			$rpt_cleaners = 1;
2396
		}
2397

2398
# Check for FSF mailing addresses.
2399
		if ($rawline =~ /\bwrite to the Free/i ||
2400 2401
		    $rawline =~ /\b59\s+Temple\s+Pl/i ||
		    $rawline =~ /\b51\s+Franklin\s+St/i) {
2402 2403 2404 2405
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
			my $msg_type = \&ERROR;
			$msg_type = \&CHK if ($file);
			&{$msg_type}("FSF_MAILING_ADDRESS",
2406
				     "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)
2407 2408
		}

2409
# check for Kconfig help text having a real description
2410 2411
# Only applies when adding the entry originally, after that we do not have
# sufficient context to determine whether it is indeed long enough.
2412
		if ($realfile =~ /Kconfig/ &&
2413
		    $line =~ /^\+\s*config\s+/) {
2414
			my $length = 0;
2415 2416 2417
			my $cnt = $realcnt;
			my $ln = $linenr + 1;
			my $f;
2418
			my $is_start = 0;
2419
			my $is_end = 0;
2420
			for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2421 2422 2423 2424 2425
				$f = $lines[$ln - 1];
				$cnt-- if ($lines[$ln - 1] !~ /^-/);
				$is_end = $lines[$ln - 1] =~ /^\+/;

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

2428
				if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
2429
					$is_start = 1;
2430
				} elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
2431 2432 2433
					$length = -1;
				}

2434
				$f =~ s/^.//;
2435 2436 2437
				$f =~ s/#.*//;
				$f =~ s/^\s+//;
				next if ($f =~ /^$/);
2438 2439 2440 2441
				if ($f =~ /^\s*config\s/) {
					$is_end = 1;
					last;
				}
2442 2443
				$length++;
			}
2444 2445 2446 2447
			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);
			}
2448
			#print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2449 2450
		}

2451 2452 2453 2454 2455 2456 2457
# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
		if ($realfile =~ /Kconfig/ &&
		    $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
			WARN("CONFIG_EXPERIMENTAL",
			     "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
		}

2458 2459 2460 2461 2462 2463 2464
# 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);
		}

2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478
		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});
		}

2479
# check for DT compatible documentation
2480 2481 2482 2483
		if (defined $root &&
			(($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
			 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {

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

2486 2487 2488
			my $dt_path = $root . "/Documentation/devicetree/bindings/";
			my $vp_file = $dt_path . "vendor-prefixes.txt";

2489 2490
			foreach my $compat (@compats) {
				my $compat2 = $compat;
2491 2492 2493 2494
				$compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
				my $compat3 = $compat;
				$compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
				`grep -Erq "$compat|$compat2|$compat3" $dt_path`;
2495 2496 2497 2498 2499
				if ( $? >> 8 ) {
					WARN("UNDOCUMENTED_DT_STRING",
					     "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
				}

2500 2501
				next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
				my $vendor = $1;
2502
				`grep -Eq "^$vendor\\b" $vp_file`;
2503 2504
				if ( $? >> 8 ) {
					WARN("UNDOCUMENTED_DT_STRING",
2505
					     "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2506 2507 2508 2509
				}
			}
		}

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

2513
#line length limit
2514
		if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
2515
		    $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
2516
		    !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
2517
		    $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
2518
		    $length > $max_line_length)
2519
		{
2520
			WARN("LONG_LINE",
2521
			     "line over $max_line_length characters\n" . $herecurr);
2522 2523
		}

2524 2525
# check for adding lines without a newline.
		if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2526 2527
			WARN("MISSING_EOF_NEWLINE",
			     "adding a line without newline at end of file\n" . $herecurr);
2528 2529
		}

2530 2531 2532 2533
# 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";
2534 2535
				ERROR("LO_MACRO",
				      "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2536 2537 2538
			}
			if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
				my $herevet = "$here\n" . cat_vet($line) . "\n";
2539 2540
				ERROR("HI_MACRO",
				      "use the HI() macro, not (... >> 16)\n" . $herevet);
2541 2542 2543
			}
		}

2544
# check we are in a valid source file C or perl if not then ignore this hunk
2545
		next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
2546 2547 2548

# at the beginning of a line any tabs must come first and anything
# more than 8 must use tabs.
2549 2550 2551
		if ($rawline =~ /^\+\s* \t\s*\S/ ||
		    $rawline =~ /^\+\s*        \s*/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2552
			$rpt_cleaners = 1;
2553 2554 2555
			if (ERROR("CODE_INDENT",
				  "code indent should use tabs where possible\n" . $herevet) &&
			    $fix) {
2556
				$fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2557
			}
2558 2559
		}

2560 2561 2562
# check for space before tabs.
		if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2563 2564 2565
			if (WARN("SPACE_BEFORE_TAB",
				"please, no space before tabs\n" . $herevet) &&
			    $fix) {
2566
				while ($fixed[$fixlinenr] =~
2567
					   s/(^\+.*) {8,8}\t/$1\t\t/) {}
2568
				while ($fixed[$fixlinenr] =~
2569
					   s/(^\+.*) +\t/$1\t/) {}
2570
			}
2571 2572
		}

2573 2574 2575 2576 2577 2578 2579 2580
# check for && or || at the start of a line
		if ($rawline =~ /^\+\s*(&&|\|\|)/) {
			CHK("LOGICAL_CONTINUATIONS",
			    "Logical continuations should be on the previous line\n" . $hereprev);
		}

# check multi-line statement indentation matches previous line
		if ($^V && $^V ge 5.10.0 &&
2581
		    $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2582 2583 2584 2585 2586 2587
			$prevline =~ /^\+(\t*)(.*)$/;
			my $oldindent = $1;
			my $rest = $2;

			my $pos = pos_last_openparen($rest);
			if ($pos >= 0) {
J
Joe Perches 已提交
2588 2589
				$line =~ /^(\+| )([ \t]*)/;
				my $newindent = $2;
2590 2591 2592 2593 2594 2595 2596 2597

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

				if ($newindent ne $goodtabindent &&
				    $newindent ne $goodspaceindent) {
2598 2599 2600 2601

					if (CHK("PARENTHESIS_ALIGNMENT",
						"Alignment should match open parenthesis\n" . $hereprev) &&
					    $fix && $line =~ /^\+/) {
2602
						$fixed[$fixlinenr] =~
2603 2604
						    s/^\+[ \t]*/\+$goodtabindent/;
					}
2605 2606 2607 2608
				}
			}
		}

2609 2610 2611 2612 2613 2614 2615 2616 2617
# 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*$/)) {
2618
			if (CHK("SPACING",
2619
				"No space is necessary after a cast\n" . $herecurr) &&
2620
			    $fix) {
2621
				$fixed[$fixlinenr] =~
2622
				    s/(\(\s*$Type\s*\))[ \t]+/$1/;
2623
			}
2624 2625
		}

2626
		if ($realfile =~ m@^(drivers/net/|net/)@ &&
2627
		    $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2628 2629
		    $rawline =~ /^\+[ \t]*\*/ &&
		    $realline > 2) {
2630 2631 2632 2633 2634
			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
			     "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
		}

		if ($realfile =~ m@^(drivers/net/|net/)@ &&
2635 2636
		    $prevrawline =~ /^\+[ \t]*\/\*/ &&		#starting /*
		    $prevrawline !~ /\*\/[ \t]*$/ &&		#no trailing */
2637
		    $rawline =~ /^\+/ &&			#line is new
2638 2639 2640 2641 2642 2643
		    $rawline !~ /^\+[ \t]*\*/) {		#no leading *
			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
			     "networking block comments start with * on subsequent lines\n" . $hereprev);
		}

		if ($realfile =~ m@^(drivers/net/|net/)@ &&
2644 2645 2646 2647
		    $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ &&	#trailing */
		    $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ &&	#inline /*...*/
		    $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ &&	#trailing **/
		    $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) {	#non blank */
2648 2649 2650 2651
			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
			     "networking block comments put the trailing */ on a separate line\n" . $herecurr);
		}

2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663
# 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/)) {
2664 2665 2666
			if (CHK("LINE_SPACING",
				"Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
			    $fix) {
2667
				fix_insert_line($fixlinenr, "\+");
2668
			}
2669 2670
		}

2671 2672 2673 2674
# check for multiple consecutive blank lines
		if ($prevline =~ /^[\+ ]\s*$/ &&
		    $line =~ /^\+\s*$/ &&
		    $last_blank_line != ($linenr - 1)) {
2675 2676 2677
			if (CHK("LINE_SPACING",
				"Please don't use multiple blank lines\n" . $hereprev) &&
			    $fix) {
2678
				fix_delete_line($fixlinenr, $rawline);
2679 2680
			}

2681 2682 2683
			$last_blank_line = $linenr;
		}

2684
# check for missing blank lines after declarations
2685 2686 2687
		if ($sline =~ /^\+\s+\S/ &&			#Not at char 1
			# actual declarations
		    ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2688 2689
			# function pointer declarations
		     $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701
			# 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*[=,;:\[]/ ||
2702 2703
			# function pointer declarations
		      $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2704 2705 2706 2707 2708
			# 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
2709
		      $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
2710 2711 2712 2713 2714 2715 2716 2717
			# 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/)) {
2718 2719 2720
			if (WARN("LINE_SPACING",
				 "Missing a blank line after declarations\n" . $hereprev) &&
			    $fix) {
2721
				fix_insert_line($fixlinenr, "\+");
2722
			}
2723 2724
		}

2725
# check for spaces at the beginning of a line.
2726 2727 2728 2729
# Exceptions:
#  1) within comments
#  2) indented preprocessor commands
#  3) hanging labels
2730
		if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/)  {
2731
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2732 2733 2734
			if (WARN("LEADING_SPACE",
				 "please, no spaces at the start of a line\n" . $herevet) &&
			    $fix) {
2735
				$fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2736
			}
2737 2738
		}

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

2742
# check indentation of any line with a bare else
2743
# (but not if it is a multiple line "if (foo) return bar; else return baz;")
2744 2745 2746
# 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;
2747 2748 2749 2750
			if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
			    ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
			     defined $lines[$linenr] &&
			     $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
2751 2752 2753 2754 2755
				WARN("UNNECESSARY_ELSE",
				     "else is not generally useful after a break or return\n" . $hereprev);
			}
		}

2756 2757 2758 2759 2760 2761 2762 2763 2764 2765
# 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);
			}
		}

2766 2767 2768 2769 2770 2771
# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
		if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
			WARN("CONFIG_EXPERIMENTAL",
			     "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
		}

2772
# check for RCS/CVS revision markers
2773
		if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
2774 2775
			WARN("CVS_KEYWORD",
			     "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
2776
		}
2777

2778 2779 2780
# Blackfin: don't use __builtin_bfin_[cs]sync
		if ($line =~ /__builtin_bfin_csync/) {
			my $herevet = "$here\n" . cat_vet($line) . "\n";
2781 2782
			ERROR("CSYNC",
			      "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
2783 2784 2785
		}
		if ($line =~ /__builtin_bfin_ssync/) {
			my $herevet = "$here\n" . cat_vet($line) . "\n";
2786 2787
			ERROR("SSYNC",
			      "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
2788 2789
		}

2790 2791 2792 2793 2794 2795
# 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);
		}

2796
# Check for potential 'bare' types
2797 2798
		my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
		    $realline_next);
2799 2800
#print "LINE<$line>\n";
		if ($linenr >= $suppress_statement &&
2801
		    $realcnt && $sline =~ /.\s*\S/) {
2802
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2803
				ctx_statement_block($linenr, $realcnt, 0);
2804 2805 2806
			$stat =~ s/\n./\n /g;
			$cond =~ s/\n./\n /g;

2807 2808 2809 2810 2811 2812 2813 2814 2815
#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;
			}
2816

2817 2818 2819 2820 2821 2822 2823 2824
			# 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++;
			}

2825 2826
			my $s = $stat;
			$s =~ s/{.*$//s;
2827

2828
			# Ignore goto labels.
2829
			if ($s =~ /$Ident:\*$/s) {
2830 2831

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

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

2836
			# declarations always start with types
2837
			} 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) {
2838 2839 2840 2841
				my $type = $1;
				$type =~ s/\s+/ /g;
				possible($type, "A:" . $s);

2842
			# definitions in global scope can only start with types
2843
			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
2844
				possible($1, "B:" . $s);
2845
			}
2846 2847

			# any (foo ... *) is a pointer cast, and foo is a type
2848
			while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
2849
				possible($1, "C:" . $s);
2850 2851 2852 2853 2854
			}

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

2858
				my $ctx = $s;
2859
				substr($ctx, 0, $name_len + 1, '');
2860
				$ctx =~ s/\)[^\)]*$//;
2861

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

2865
						possible($1, "D:" . $s);
2866 2867
					}
				}
2868
			}
2869

2870 2871
		}

2872 2873 2874
#
# Checks which may be anchored in the context.
#
2875

2876 2877
# Check for switch () and associated case and default
# statements should be at the same indent.
2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893
		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 '') {
2894 2895
				ERROR("SWITCH_CASE_INDENT_LEVEL",
				      "switch and case should be at the same indent\n$hereline$err");
2896 2897 2898 2899 2900
			}
		}

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

2904
			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2905 2906 2907 2908 2909 2910

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

2911 2912 2913
			my $ctx_cnt = $realcnt - $#ctx - 1;
			my $ctx = join("\n", @ctx);

2914 2915
			my $ctx_ln = $linenr;
			my $ctx_skip = $realcnt;
2916

2917 2918 2919 2920 2921
			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] !~ /^-/);
2922 2923
				$ctx_ln++;
			}
2924

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

2928
			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2929 2930
				ERROR("OPEN_BRACE",
				      "that open brace { should be on the previous line\n" .
2931
					"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2932
			}
2933 2934 2935 2936
			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
			    $ctx =~ /\)\s*\;\s*$/ &&
			    defined $lines[$ctx_ln - 1])
			{
2937 2938
				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
				if ($nindent > $indent) {
2939 2940
					WARN("TRAILING_SEMICOLON",
					     "trailing semicolon indicates no statements, indent implies otherwise\n" .
2941
						"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2942 2943
				}
			}
2944 2945
		}

2946
# Check relative indent for conditionals and blocks.
2947
		if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2948 2949 2950
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
2951 2952 2953 2954 2955 2956 2957 2958 2959 2960
			my ($s, $c) = ($stat, $cond);

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

			# Make sure we remove the line prefixes as we have
			# none on the first line, and are going to readd them
			# where necessary.
			$s =~ s/\n./\n/gs;

			# Find out how long the conditional actually is.
2961 2962
			my @newlines = ($c =~ /\n/gs);
			my $cond_lines = 1 + $#newlines;
2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975

			# 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;
			}
2976
			if ($s =~ s/^\s*?\n//) {
2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987
				$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;
			}

2988
			my $cond_ptr = -1;
2989
			$continuation = 0;
2990 2991 2992
			while ($cond_ptr != $cond_lines) {
				$cond_ptr = $cond_lines;

2993 2994 2995 2996 2997 2998
				# If we see an #else/#elif then the code
				# is not linear.
				if ($s =~ /^\s*\#\s*(?:else|elif)/) {
					$check = 0;
				}

2999 3000 3001 3002
				# Ignore:
				#  1) blank lines, they should be at 0,
				#  2) preprocessor lines, and
				#  3) labels.
3003 3004
				if ($continuation ||
				    $s =~ /^\s*?\n/ ||
3005 3006
				    $s =~ /^\s*#\s*?/ ||
				    $s =~ /^\s*$Ident\s*:/) {
3007
					$continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
3008 3009 3010
					if ($s =~ s/^.*?\n//) {
						$cond_lines++;
					}
3011
				}
3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026
			}

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

3027
			#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";
3028 3029 3030

			if ($check && (($sindent % 8) != 0 ||
			    ($sindent <= $indent && $s ne ''))) {
3031 3032
				WARN("SUSPECT_CODE_INDENT",
				     "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3033 3034 3035
			}
		}

3036 3037
		# Track the 'values' across context and added lines.
		my $opline = $line; $opline =~ s/^./ /;
3038 3039
		my ($curr_values, $curr_vars) =
				annotate_values($opline . "\n", $prev_values);
3040
		$curr_values = $prev_values . $curr_values;
3041 3042
		if ($dbg_values) {
			my $outline = $opline; $outline =~ s/\t/ /g;
3043 3044
			print "$linenr > .$outline\n";
			print "$linenr > $curr_values\n";
3045
			print "$linenr >  $curr_vars\n";
3046
		}
3047 3048
		$prev_values = substr($curr_values, -1);

3049
#ignore lines not being added
3050
		next if ($line =~ /^[^\+]/);
3051

3052
# TEST: allow direct testing of the type matcher.
3053 3054
		if ($dbg_type) {
			if ($line =~ /^.\s*$Declare\s*$/) {
3055 3056
				ERROR("TEST_TYPE",
				      "TEST: is type\n" . $herecurr);
3057
			} elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3058 3059
				ERROR("TEST_NOT_TYPE",
				      "TEST: is not type ($1 is)\n". $herecurr);
3060
			}
3061 3062
			next;
		}
3063 3064
# TEST: allow direct testing of the attribute matcher.
		if ($dbg_attr) {
3065
			if ($line =~ /^.\s*$Modifier\s*$/) {
3066 3067
				ERROR("TEST_ATTR",
				      "TEST: is attr\n" . $herecurr);
3068
			} elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3069 3070
				ERROR("TEST_NOT_ATTR",
				      "TEST: is not attr ($1 is)\n". $herecurr);
3071 3072 3073
			}
			next;
		}
3074

3075
# check for initialisation to aggregates open brace on the next line
3076 3077
		if ($line =~ /^.\s*{/ &&
		    $prevline =~ /(?:^|[^=])=\s*$/) {
3078 3079
			if (ERROR("OPEN_BRACE",
				  "that open brace { should be on the previous line\n" . $hereprev) &&
3080 3081 3082
			    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
				fix_delete_line($fixlinenr - 1, $prevrawline);
				fix_delete_line($fixlinenr, $rawline);
3083 3084
				my $fixedline = $prevrawline;
				$fixedline =~ s/\s*=\s*$/ = {/;
3085
				fix_insert_line($fixlinenr, $fixedline);
3086 3087
				$fixedline = $line;
				$fixedline =~ s/^(.\s*){\s*/$1/;
3088
				fix_insert_line($fixlinenr, $fixedline);
3089
			}
3090 3091
		}

3092 3093 3094 3095 3096
#
# Checks which are anchored on the added line.
#

# check for malformed paths in #include statements (uses RAW line)
3097
		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3098 3099
			my $path = $1;
			if ($path =~ m{//}) {
3100
				ERROR("MALFORMED_INCLUDE",
3101 3102 3103 3104 3105
				      "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);
3106 3107
			}
		}
3108

3109
# no C99 // comments
3110
		if ($line =~ m{//}) {
3111 3112 3113
			if (ERROR("C99_COMMENTS",
				  "do not use C99 // comments\n" . $herecurr) &&
			    $fix) {
3114
				my $line = $fixed[$fixlinenr];
3115 3116
				if ($line =~ /\/\/(.*)$/) {
					my $comment = trim($1);
3117
					$fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3118 3119
				}
			}
3120
		}
3121
		# Remove C99 comments.
3122
		$line =~ s@//.*@@;
3123
		$opline =~ s@//.*@@;
3124

3125 3126 3127 3128 3129 3130 3131 3132
# 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.*\((.*)\)/)) {
3133 3134 3135 3136
			# Handle definitions which produce identifiers with
			# a prefix:
			#   XXX(foo);
			#   EXPORT_SYMBOL(something_foo);
3137
			my $name = $1;
3138
			if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3139 3140 3141 3142 3143
			    $name =~ /^${Ident}_$2/) {
#print "FOO C name<$name>\n";
				$suppress_export{$realline_next} = 1;

			} elsif ($stat !~ /(?:
3144
				\n.}\s*$|
3145 3146 3147
				^.DEFINE_$Ident\(\Q$name\E\)|
				^.DECLARE_$Ident\(\Q$name\E\)|
				^.LIST_HEAD\(\Q$name\E\)|
3148 3149
				^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
				\b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
3150
			    )/x) {
3151 3152 3153 3154
#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
				$suppress_export{$realline_next} = 2;
			} else {
				$suppress_export{$realline_next} = 1;
3155 3156
			}
		}
3157 3158 3159 3160 3161 3162 3163 3164 3165
		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) {
3166 3167
			WARN("EXPORT_SYMBOL",
			     "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3168
		}
3169

3170
# check for global initialisers.
3171 3172 3173 3174 3175
		if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
			if (ERROR("GLOBAL_INITIALISERS",
				  "do not initialise globals to 0 or NULL\n" .
				      $herecurr) &&
			    $fix) {
3176
				$fixed[$fixlinenr] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
3177
			}
3178
		}
3179
# check for static initialisers.
3180 3181 3182 3183 3184
		if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
			if (ERROR("INITIALISED_STATIC",
				  "do not initialise statics to 0 or NULL\n" .
				      $herecurr) &&
			    $fix) {
3185
				$fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
3186
			}
3187 3188
		}

3189 3190 3191 3192 3193 3194 3195
# 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);
		}

3196 3197
# check for static const char * arrays.
		if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3198 3199
			WARN("STATIC_CONST_CHAR_ARRAY",
			     "static const char * array should probably be static const char * const\n" .
3200 3201 3202 3203 3204
				$herecurr);
               }

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

3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221
# 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);
			}
		}

3222 3223 3224 3225 3226 3227 3228
# 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);
               }

3229 3230 3231 3232 3233
# 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) {
3234
				$fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
3235 3236 3237
			}
		}

3238 3239 3240 3241 3242
# check for uses of DEFINE_PCI_DEVICE_TABLE
		if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
			if (WARN("DEFINE_PCI_DEVICE_TABLE",
				 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
			    $fix) {
3243
				$fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
3244
			}
3245 3246
		}

3247 3248 3249
# check for new typedefs, only function parameters and sparse annotations
# make sense.
		if ($line =~ /\btypedef\s/ &&
3250
		    $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
3251
		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
3252
		    $line !~ /\b$typeTypedefs\b/ &&
3253
		    $line !~ /\b$typeOtherOSTypedefs\b/ &&
3254
		    $line !~ /\b__bitwise(?:__|)\b/) {
3255 3256
			WARN("NEW_TYPEDEFS",
			     "do not add new typedefs\n" . $herecurr);
3257 3258 3259
		}

# * goes on variable not on type
3260
		# (char*[ const])
3261 3262
		while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
			#print "AA<$1>\n";
3263
			my ($ident, $from, $to) = ($1, $2, $2);
3264 3265 3266 3267 3268 3269

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

3273
##			print "1: from<$from> to<$to> ident<$ident>\n";
3274
			if ($from ne $to) {
3275 3276 3277 3278 3279 3280
				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/;
3281
					$fixed[$fixlinenr] =~
3282 3283
					    s@\Q$sub_from\E@$sub_to@;
				}
3284
			}
3285 3286 3287
		}
		while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
			#print "BB<$1>\n";
3288
			my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
3289 3290 3291 3292 3293 3294

			# Should start with a space.
			$to =~ s/^(\S)/ $1/;
			# Should not end with a space.
			$to =~ s/\s+$//;
			# '*'s should not have spaces between.
3295
			while ($to =~ s/\*\s+\*/\*\*/) {
3296 3297 3298
			}
			# Modifiers should have spaces.
			$to =~ s/(\b$Modifier$)/$1 /;
3299

3300
##			print "2: from<$from> to<$to> ident<$ident>\n";
3301
			if ($from ne $to && $ident !~ /^$Modifier$/) {
3302 3303 3304 3305 3306 3307 3308
				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/;
3309
					$fixed[$fixlinenr] =~
3310 3311
					    s@\Q$sub_from\E@$sub_to@;
				}
3312
			}
3313 3314 3315 3316 3317 3318 3319 3320 3321
		}

# # no BUG() or BUG_ON()
# 		if ($line =~ /\b(BUG|BUG_ON)\b/) {
# 			print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
# 			print "$herecurr";
# 			$clean = 0;
# 		}

3322
		if ($line =~ /\bLINUX_VERSION_CODE\b/) {
3323 3324
			WARN("LINUX_VERSION_CODE",
			     "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3325 3326
		}

3327 3328
# check for uses of printk_ratelimit
		if ($line =~ /\bprintk_ratelimit\s*\(/) {
3329
			WARN("PRINTK_RATELIMITED",
3330
			     "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
3331 3332
		}

3333 3334 3335
# 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 已提交
3336
# printk includes all preceding printk's which have no newline on the end.
3337
# we assume the first bad printk is the one to report.
3338
		if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
3339 3340 3341
			my $ok = 0;
			for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
				#print "CHECK<$lines[$ln - 1]\n";
L
Lucas De Marchi 已提交
3342
				# we have a preceding printk if it ends
3343 3344 3345 3346 3347 3348 3349 3350 3351
				# 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) {
3352 3353
				WARN("PRINTK_WITHOUT_KERN_LEVEL",
				     "printk() should include KERN_ facility level\n" . $herecurr);
3354
			}
3355 3356
		}

3357 3358 3359 3360
		if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
			my $orig = $1;
			my $level = lc($orig);
			$level = "warn" if ($level eq "warning");
3361 3362
			my $level2 = $level;
			$level2 = "dbg" if ($level eq "debug");
3363
			WARN("PREFER_PR_LEVEL",
3364
			     "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(...  to printk(KERN_$orig ...\n" . $herecurr);
3365 3366 3367
		}

		if ($line =~ /\bpr_warning\s*\(/) {
3368 3369 3370
			if (WARN("PREFER_PR_LEVEL",
				 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
			    $fix) {
3371
				$fixed[$fixlinenr] =~
3372 3373
				    s/\bpr_warning\b/pr_warn/;
			}
3374 3375
		}

3376 3377 3378 3379 3380 3381 3382 3383 3384
		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);
		}

3385 3386
# function brace can't be on same line, except for #defines of do while,
# or if closed on same line
3387
		if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
3388
		    !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402
			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));
				}
			}
3403
		}
3404

3405 3406 3407
# 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*$/) {
3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420
			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;
				$fixedline =~ s/^(.\s*){\s*/$1\t/;
				if ($fixedline !~ /^\+\s*$/) {
					fix_insert_line($fixlinenr, $fixedline);
				}
			}
3421 3422
		}

3423
# missing space after union, struct or enum definition
3424 3425 3426 3427
		if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
			if (WARN("SPACING",
				 "missing space after $1 definition\n" . $herecurr) &&
			    $fix) {
3428
				$fixed[$fixlinenr] =~
3429 3430
				    s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
			}
3431 3432
		}

3433 3434 3435
# Function pointer declarations
# check spacing between type, funcptr, and args
# canonical declaration is "type (*funcptr)(args...)"
3436
		if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
3437 3438 3439 3440 3441 3442 3443
			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;

3444 3445 3446 3447 3448 3449 3450 3451 3452
# 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 =~ /^$/) {
3453 3454
				WARN("SPACING",
				     "missing space after return type\n" . $herecurr);
3455
				$post_declare_space = " ";
3456 3457 3458
			}

# unnecessary space "type  (*funcptr)(args...)"
3459 3460 3461 3462 3463 3464 3465 3466 3467
# 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);
#			}
3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497

# 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) {
3498
				$fixed[$fixlinenr] =~
3499
				    s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3500 3501 3502
			}
		}

3503 3504
# check for spacing round square brackets; allowed:
#  1. with a type on the left -- int [] a;
3505 3506
#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
#  3. inside a curly brace -- = { [0...10] = 5 }
3507 3508 3509
		while ($line =~ /(.*?\s)\[/g) {
			my ($where, $prefix) = ($-[1], $1);
			if ($prefix !~ /$Type\s+$/ &&
3510
			    ($where != 0 || $prefix !~ /^.\s+$/) &&
3511
			    $prefix !~ /[{,]\s+$/) {
3512 3513 3514
				if (ERROR("BRACKET_SPACE",
					  "space prohibited before open square bracket '['\n" . $herecurr) &&
				    $fix) {
3515
				    $fixed[$fixlinenr] =~
3516 3517
					s/^(\+.*?)\s+\[/$1\[/;
				}
3518 3519 3520
			}
		}

3521
# check for spaces between functions and their parentheses.
3522
		while ($line =~ /($Ident)\s+\(/g) {
3523
			my $name = $1;
3524 3525
			my $ctx_before = substr($line, 0, $-[1]);
			my $ctx = "$ctx_before$name";
3526 3527

			# Ignore those directives where spaces _are_ permitted.
3528 3529 3530 3531 3532 3533
			if ($name =~ /^(?:
				if|for|while|switch|return|case|
				volatile|__volatile__|
				__attribute__|format|__extension__|
				asm|__asm__)$/x)
			{
3534 3535 3536
			# 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.
3537
			} elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
3538 3539

			# cpp #elif statement condition may start with a (
3540
			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
3541 3542 3543

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

			} else {
3547 3548 3549
				if (WARN("SPACING",
					 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
					     $fix) {
3550
					$fixed[$fixlinenr] =~
3551 3552
					    s/\b$name\s+\(/$name\(/;
				}
3553
			}
3554
		}
3555

3556
# Check operator spacing.
3557
		if (!($line=~/\#\s*include/)) {
3558 3559 3560
			my $fixed_line = "";
			my $line_fixed = 0;

3561 3562 3563 3564
			my $ops = qr{
				<<=|>>=|<=|>=|==|!=|
				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
				=>|->|<<|>>|<|>|=|!|~|
3565
				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
3566
				\?:|\?|:
3567
			}x;
3568
			my @elements = split(/($ops|;)/, $opline);
3569 3570 3571 3572 3573 3574 3575

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

			my @fix_elements = ();
3576
			my $off = 0;
3577

3578 3579 3580 3581 3582 3583 3584
			foreach my $el (@elements) {
				push(@fix_elements, substr($rawline, $off, length($el)));
				$off += length($el);
			}

			$off = 0;

3585
			my $blank = copy_spacing($opline);
3586
			my $last_after = -1;
3587

3588
			for (my $n = 0; $n < $#elements; $n += 2) {
3589 3590 3591 3592 3593

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

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

3594 3595
				$off += length($elements[$n]);

L
Lucas De Marchi 已提交
3596
				# Pick up the preceding and succeeding characters.
3597 3598 3599 3600 3601 3602 3603
				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";

3604 3605 3606
				my $a = '';
				$a = 'V' if ($elements[$n] ne '');
				$a = 'W' if ($elements[$n] =~ /\s$/);
3607
				$a = 'C' if ($elements[$n] =~ /$;$/);
3608 3609
				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
				$a = 'O' if ($elements[$n] eq '');
3610
				$a = 'E' if ($ca =~ /^\s*$/);
3611

3612
				my $op = $elements[$n + 1];
3613 3614

				my $c = '';
3615
				if (defined $elements[$n + 2]) {
3616 3617
					$c = 'V' if ($elements[$n + 2] ne '');
					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
3618
					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
3619 3620
					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
					$c = 'O' if ($elements[$n + 2] eq '');
3621
					$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
3622 3623
				} else {
					$c = 'E';
3624 3625
				}

3626 3627 3628 3629
				my $ctx = "${a}x${c}";

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

3630
				my $ptr = substr($blank, 0, $off) . "^";
3631
				my $hereptr = "$hereline$ptr\n";
3632

3633
				# Pull out the value of this operator.
3634
				my $op_type = substr($curr_values, $off + 1, 1);
3635

3636 3637 3638
				# Get the full operator variant.
				my $opv = $op . substr($curr_vars, $off, 1);

3639 3640 3641 3642
				# Ignore operators passed as parameters.
				if ($op_type ne 'V' &&
				    $ca =~ /\s$/ && $cc =~ /^\s*,/) {

3643 3644
#				# Ignore comments
#				} elsif ($op =~ /^$;+$/) {
3645

3646
				# ; should have either the end of line or a space or \ after it
3647
				} elsif ($op eq ';') {
3648 3649
					if ($ctx !~ /.x[WEBC]/ &&
					    $cc !~ /^\\/ && $cc !~ /^;/) {
3650 3651
						if (ERROR("SPACING",
							  "space required after that '$op' $at\n" . $hereptr)) {
3652
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3653 3654
							$line_fixed = 1;
						}
3655 3656 3657 3658
					}

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

3660 3661 3662 3663
				#   :   when part of a bitfield
				} elsif ($opv eq ':B') {
					# skip the bitfield test for now

3664 3665
				# No spaces for:
				#   ->
3666
				} elsif ($op eq '->') {
3667
					if ($ctx =~ /Wx.|.xW/) {
3668 3669
						if (ERROR("SPACING",
							  "spaces prohibited around that '$op' $at\n" . $hereptr)) {
3670
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3671 3672 3673
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3674
							$line_fixed = 1;
3675
						}
3676 3677
					}

3678
				# , must not have a space before and must have a space on the right.
3679
				} elsif ($op eq ',') {
3680 3681 3682 3683 3684 3685 3686 3687 3688
					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;
						}
					}
3689
					if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
3690 3691 3692
						if (ERROR("SPACING",
							  "space required after that '$op' $at\n" . $hereptr)) {
							$line_fixed = 1;
3693
							$last_after = $n;
3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704
							$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 .= " ";
3705
						}
3706 3707
					}

3708
				# '*' as part of a type definition -- reported already.
3709
				} elsif ($opv eq '*_') {
3710 3711 3712 3713 3714 3715
					#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 '~' ||
3716
					 $opv eq '*U' || $opv eq '-U' ||
3717
					 $opv eq '&U' || $opv eq '&&U') {
3718
					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
3719 3720
						if (ERROR("SPACING",
							  "space required before that '$op' $at\n" . $hereptr)) {
3721 3722 3723 3724
							if ($n != $last_after + 2) {
								$good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
								$line_fixed = 1;
							}
3725
						}
3726
					}
3727
					if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
3728 3729 3730
						# A unary '*' may be const

					} elsif ($ctx =~ /.xW/) {
3731 3732
						if (ERROR("SPACING",
							  "space prohibited after that '$op' $at\n" . $hereptr)) {
3733
							$good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
3734 3735 3736
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3737
							$line_fixed = 1;
3738
						}
3739 3740 3741 3742
					}

				# unary ++ and unary -- are allowed no space on one side.
				} elsif ($op eq '++' or $op eq '--') {
3743
					if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
3744 3745
						if (ERROR("SPACING",
							  "space required one side of that '$op' $at\n" . $hereptr)) {
3746
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3747 3748
							$line_fixed = 1;
						}
3749 3750 3751
					}
					if ($ctx =~ /Wx[BE]/ ||
					    ($ctx =~ /Wx./ && $cc =~ /^;/)) {
3752 3753
						if (ERROR("SPACING",
							  "space prohibited before that '$op' $at\n" . $hereptr)) {
3754
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3755 3756
							$line_fixed = 1;
						}
3757
					}
3758
					if ($ctx =~ /ExW/) {
3759 3760
						if (ERROR("SPACING",
							  "space prohibited after that '$op' $at\n" . $hereptr)) {
3761
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3762 3763 3764
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3765
							$line_fixed = 1;
3766
						}
3767
					}
3768 3769

				# << and >> may either have or not have spaces both sides
3770 3771 3772
				} elsif ($op eq '<<' or $op eq '>>' or
					 $op eq '&' or $op eq '^' or $op eq '|' or
					 $op eq '+' or $op eq '-' or
3773 3774
					 $op eq '*' or $op eq '/' or
					 $op eq '%')
3775
				{
3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791
					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/) {
3792 3793
						if (ERROR("SPACING",
							  "need consistent spacing around '$op' $at\n" . $hereptr)) {
3794 3795 3796 3797
							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3798 3799
							$line_fixed = 1;
						}
3800 3801
					}

3802 3803 3804 3805
				# 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./) {
3806 3807
						if (ERROR("SPACING",
							  "space prohibited before that '$op' $at\n" . $hereptr)) {
3808
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3809 3810
							$line_fixed = 1;
						}
3811 3812
					}

3813
				# All the others need spaces both sides.
3814
				} elsif ($ctx !~ /[EWC]x[CWE]/) {
3815 3816
					my $ok = 0;

3817
					# Ignore email addresses <foo@bar>
3818 3819 3820 3821 3822 3823 3824 3825
					if (($op eq '<' &&
					     $cc =~ /^\S+\@\S+>/) ||
					    ($op eq '>' &&
					     $ca =~ /<\S+\@\S+$/))
					{
					    	$ok = 1;
					}

3826
					# messages are ERROR, but ?: are CHK
3827
					if ($ok == 0) {
3828 3829 3830 3831 3832
						my $msg_type = \&ERROR;
						$msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);

						if (&{$msg_type}("SPACING",
								 "spaces required around that '$op' $at\n" . $hereptr)) {
3833 3834 3835 3836
							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3837 3838
							$line_fixed = 1;
						}
3839
					}
3840
				}
3841
				$off += length($elements[$n + 1]);
3842 3843 3844 3845 3846 3847 3848 3849

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

				$fixed_line = $fixed_line . $good;
			}

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

3852 3853
			if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
				$fixed[$fixlinenr] = $fixed_line;
3854 3855 3856
			}


3857 3858
		}

3859
# check for whitespace before a non-naked semicolon
3860
		if ($line =~ /^\+.*\S\s+;\s*$/) {
3861 3862 3863
			if (WARN("SPACING",
				 "space prohibited before semicolon\n" . $herecurr) &&
			    $fix) {
3864
				1 while $fixed[$fixlinenr] =~
3865 3866 3867 3868
				    s/^(\+.*\S)\s+;/$1;/;
			}
		}

3869 3870
# check for multiple assignments
		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
3871 3872
			CHK("MULTIPLE_ASSIGNMENTS",
			    "multiple assignments should be avoided\n" . $herecurr);
3873 3874
		}

3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885
## # 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 =~ /,/) {
3886 3887
## 				WARN("MULTIPLE_DECLARATION",
##				     "declaring multiple variables together should be avoided\n" . $herecurr);
3888 3889
## 			}
## 		}
3890

3891
#need space before brace following if, while, etc
3892 3893
		if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
		    $line =~ /do{/) {
3894 3895 3896
			if (ERROR("SPACING",
				  "space required before the open brace '{'\n" . $herecurr) &&
			    $fix) {
3897
				$fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
3898
			}
3899 3900
		}

3901 3902 3903 3904 3905 3906 3907 3908
## # check for blank lines before declarations
##		if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
##		    $prevrawline =~ /^.\s*$/) {
##			WARN("SPACING",
##			     "No blank lines before declarations\n" . $hereprev);
##		}
##

3909 3910 3911
# closing brace should have a space following it when it has anything
# on the line
		if ($line =~ /}(?!(?:,|;|\)))\S/) {
3912 3913 3914
			if (ERROR("SPACING",
				  "space required after that close brace '}'\n" . $herecurr) &&
			    $fix) {
3915
				$fixed[$fixlinenr] =~
3916 3917
				    s/}((?!(?:,|;|\)))\S)/} $1/;
			}
3918 3919
		}

3920 3921
# check spacing on square brackets
		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
3922 3923 3924
			if (ERROR("SPACING",
				  "space prohibited after that open square bracket '['\n" . $herecurr) &&
			    $fix) {
3925
				$fixed[$fixlinenr] =~
3926 3927
				    s/\[\s+/\[/;
			}
3928 3929
		}
		if ($line =~ /\s\]/) {
3930 3931 3932
			if (ERROR("SPACING",
				  "space prohibited before that close square bracket ']'\n" . $herecurr) &&
			    $fix) {
3933
				$fixed[$fixlinenr] =~
3934 3935
				    s/\s+\]/\]/;
			}
3936 3937
		}

3938
# check spacing on parentheses
3939 3940
		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
		    $line !~ /for\s*\(\s+;/) {
3941 3942 3943
			if (ERROR("SPACING",
				  "space prohibited after that open parenthesis '('\n" . $herecurr) &&
			    $fix) {
3944
				$fixed[$fixlinenr] =~
3945 3946
				    s/\(\s+/\(/;
			}
3947
		}
3948
		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
3949 3950
		    $line !~ /for\s*\(.*;\s+\)/ &&
		    $line !~ /:\s+\)/) {
3951 3952 3953
			if (ERROR("SPACING",
				  "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
			    $fix) {
3954
				$fixed[$fixlinenr] =~
3955 3956
				    s/\s+\)/\)/;
			}
3957 3958
		}

3959 3960 3961 3962
# 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) {
3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983
			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/;
			}
		}
3984

3985
#goto labels aren't indented, allow a single space however
3986
		if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
3987
		   !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
3988 3989 3990
			if (WARN("INDENTED_LABEL",
				 "labels should not be indented\n" . $herecurr) &&
			    $fix) {
3991
				$fixed[$fixlinenr] =~
3992 3993
				    s/^(.)\s+/$1/;
			}
3994 3995
		}

3996
# return is not a function
3997
		if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
3998
			my $spacing = $1;
3999
			if ($^V && $^V ge 5.10.0 &&
4000 4001 4002 4003 4004 4005 4006
			    $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);
				}
4007
			} elsif ($spacing !~ /\s+/) {
4008 4009
				ERROR("SPACING",
				      "space required before the open parenthesis '('\n" . $herecurr);
4010 4011
			}
		}
4012

4013 4014 4015 4016 4017 4018 4019 4020
# 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*:/) {
4021
			WARN("RETURN_VOID",
4022 4023
			     "void function return statements are not generally useful\n" . $hereprev);
               }
4024

4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038
# 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);
			}
		}

4039 4040
# Return of what appears to be an errno should normally be negative
		if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
4041 4042
			my $name = $1;
			if ($name ne 'EOF' && $name ne 'ERROR') {
4043
				WARN("USE_NEGATIVE_ERRNO",
4044
				     "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
4045 4046
			}
		}
4047

4048
# Need a space before open parenthesis after if, while etc
4049 4050 4051 4052
		if ($line =~ /\b(if|while|for|switch)\(/) {
			if (ERROR("SPACING",
				  "space required before the open parenthesis '('\n" . $herecurr) &&
			    $fix) {
4053
				$fixed[$fixlinenr] =~
4054 4055
				    s/\b(if|while|for|switch)\(/$1 \(/;
			}
4056 4057
		}

4058 4059
# Check for illegal assignment in if conditional -- and check for trailing
# statements after the conditional.
4060
		if ($line =~ /do\s*(?!{)/) {
4061 4062 4063
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081
			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} &&
4082
		    defined($stat) && defined($cond) &&
4083
		    $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
4084
			my ($s, $c) = ($stat, $cond);
4085

4086
			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
4087 4088
				ERROR("ASSIGN_IN_IF",
				      "do not use assignment in if condition\n" . $herecurr);
4089 4090 4091 4092
			}

			# Find out what is on the end of the line after the
			# conditional.
4093
			substr($s, 0, length($c), '');
4094
			$s =~ s/\n.*//g;
4095
			$s =~ s/$;//g; 	# Remove any comments
4096 4097
			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
			    $c !~ /}\s*while\s*/)
4098
			{
4099 4100 4101
				# Find out how long the conditional actually is.
				my @newlines = ($c =~ /\n/gs);
				my $cond_lines = 1 + $#newlines;
4102
				my $stat_real = '';
4103

4104 4105
				$stat_real = raw_line($linenr, $cond_lines)
							. "\n" if ($cond_lines);
4106 4107 4108 4109
				if (defined($stat_real) && $cond_lines > 1) {
					$stat_real = "[...]\n$stat_real";
				}

4110 4111
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr . $stat_real);
4112 4113 4114
			}
		}

4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126
# Check for bitwise tests written as boolean
		if ($line =~ /
			(?:
				(?:\[|\(|\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\|)
			|
				(?:\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\||\)|\])
			)/x)
		{
4127 4128
			WARN("HEXADECIMAL_BOOLEAN_TEST",
			     "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
4129 4130
		}

4131
# if and else should not have general statements after it
4132 4133 4134 4135
		if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
			my $s = $1;
			$s =~ s/$;//g; 	# Remove any comments
			if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
4136 4137
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr);
4138
			}
4139
		}
4140 4141
# if should not continue a brace
		if ($line =~ /}\s*if\b/) {
4142
			ERROR("TRAILING_STATEMENTS",
4143
			      "trailing statements should be on next line (or did you mean 'else if'?)\n" .
4144 4145
				$herecurr);
		}
4146 4147 4148
# case and default should not have general statements after them
		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
		    $line !~ /\G(?:
4149
			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
4150 4151 4152
			\s*return\s+
		    )/xg)
		{
4153 4154
			ERROR("TRAILING_STATEMENTS",
			      "trailing statements should be on next line\n" . $herecurr);
4155
		}
4156 4157 4158

		# Check for }<nl>else {, these must be at the same
		# indent level to be relevant to each other.
4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174
		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);
			}
4175 4176
		}

4177 4178
		if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
		    $previndent == $indent) {
4179 4180 4181 4182
			my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);

			# Find out what is on the end of the line after the
			# conditional.
4183
			substr($s, 0, length($c), '');
4184 4185 4186
			$s =~ s/\n.*//g;

			if ($s =~ /^\s*;/) {
4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198
				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);
				}
4199 4200 4201
			}
		}

4202
#Specific variable tests
4203 4204
		while ($line =~ m{($Constant|$Lval)}g) {
			my $var = $1;
4205 4206 4207

#gcc binary extension
			if ($var =~ /^$Binary$/) {
4208 4209 4210 4211
				if (WARN("GCC_BINARY_CONSTANT",
					 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
				    $fix) {
					my $hexval = sprintf("0x%x", oct($var));
4212
					$fixed[$fixlinenr] =~
4213 4214
					    s/\b$var\b/$hexval/;
				}
4215 4216 4217
			}

#CamelCase
4218
			if ($var !~ /^$Constant$/ &&
4219
			    $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
4220
#Ignore Page<foo> variants
4221
			    $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
4222
#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4223 4224 4225
			    $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_]+)?$/) {
4226 4227 4228
				while ($var =~ m{($Ident)}g) {
					my $word = $1;
					next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
4229 4230 4231 4232 4233 4234 4235
					if ($check) {
						seed_camelcase_includes();
						if (!$file && !$camelcase_file_seeded) {
							seed_camelcase_file($realfile);
							$camelcase_file_seeded = 1;
						}
					}
4236 4237 4238 4239 4240
					if (!defined $camelcase{$word}) {
						$camelcase{$word} = 1;
						CHK("CAMELCASE",
						    "Avoid CamelCase: <$word>\n" . $herecurr);
					}
4241
				}
4242 4243
			}
		}
4244 4245

#no spaces allowed after \ in define
4246 4247 4248 4249
		if ($line =~ /\#\s*define.*\\\s+$/) {
			if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
				 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
			    $fix) {
4250
				$fixed[$fixlinenr] =~ s/\s+$//;
4251
			}
4252 4253
		}

4254 4255
# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
# itself <asm/foo.h> (uses RAW line)
4256
		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
4257 4258 4259 4260
			my $file = "$1.h";
			my $checkfile = "include/linux/$file";
			if (-f "$root/$checkfile" &&
			    $realfile ne $checkfile &&
4261
			    $1 !~ /$allowed_asm_includes/)
4262
			{
4263 4264 4265 4266 4267 4268 4269 4270 4271
				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);
					}
4272
				}
4273 4274 4275
			}
		}

4276 4277
# 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
4278
# in a known good container
4279 4280
		if ($realfile !~ m@/vmlinux.lds.h$@ &&
		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
4281 4282
			my $ln = $linenr;
			my $cnt = $realcnt;
4283 4284
			my ($off, $dstat, $dcond, $rest);
			my $ctx = '';
4285 4286
			my $has_flow_statement = 0;
			my $has_arg_concat = 0;
4287
			($dstat, $dcond, $ln, $cnt, $off) =
4288 4289
				ctx_statement_block($linenr, $realcnt, 0);
			$ctx = $dstat;
4290
			#print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4291
			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4292

4293 4294 4295
			$has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
			$has_arg_concat = 1 if ($ctx =~ /\#\#/);

4296
			$dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
4297
			$dstat =~ s/$;//g;
4298 4299 4300
			$dstat =~ s/\\\n.//g;
			$dstat =~ s/^\s*//s;
			$dstat =~ s/\s*$//s;
4301

4302
			# Flatten any parentheses and braces
4303 4304
			while ($dstat =~ s/\([^\(\)]*\)/1/ ||
			       $dstat =~ s/\{[^\{\}]*\}/1/ ||
4305
			       $dstat =~ s/\[[^\[\]]*\]/1/)
4306
			{
4307
			}
4308

4309 4310 4311 4312 4313 4314
			# Flatten any obvious string concatentation.
			while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
			       $dstat =~ s/$Ident\s*("X*")/$1/)
			{
			}

4315 4316 4317
			my $exceptions = qr{
				$Declare|
				module_param_named|
4318
				MODULE_PARM_DESC|
4319 4320
				DECLARE_PER_CPU|
				DEFINE_PER_CPU|
4321
				__typeof__\(|
4322 4323
				union|
				struct|
4324 4325
				\.$Ident\s*=\s*|
				^\"|\"$
4326
			}x;
4327
			#print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4328 4329 4330
			if ($dstat ne '' &&
			    $dstat !~ /^(?:$Ident|-?$Constant),$/ &&			# 10, // foo(),
			    $dstat !~ /^(?:$Ident|-?$Constant);$/ &&			# foo();
4331
			    $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ &&		# 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4332
			    $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ &&			# character constants
4333 4334
			    $dstat !~ /$exceptions/ &&
			    $dstat !~ /^\.$Ident\s*=/ &&				# .foo =
4335
			    $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ &&		# stringification #foo
4336
			    $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ &&	# do {...} while (...); // do {...} while (...)
4337 4338 4339
			    $dstat !~ /^for\s*$Constant$/ &&				# for (...)
			    $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ &&	# for (...) bar()
			    $dstat !~ /^do\s*{/ &&					# do {...
4340 4341
			    $dstat !~ /^\({/ &&						# ({...
			    $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
4342 4343 4344 4345 4346 4347 4348
			{
				$ctx =~ s/\n*$//;
				my $herectx = $here . "\n";
				my $cnt = statement_rawlines($ctx);

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

4351 4352 4353 4354
				if ($dstat =~ /;/) {
					ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
					      "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
				} else {
4355
					ERROR("COMPLEX_MACRO",
A
Andrew Morton 已提交
4356
					      "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
4357
				}
4358
			}
4359

4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372
# 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");
			}

4373
# check for line continuations outside of #defines, preprocessor #, and asm
4374 4375 4376

		} else {
			if ($prevline !~ /^..*\\$/ &&
4377 4378
			    $line !~ /^\+\s*\#.*\\$/ &&		# preprocessor
			    $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ &&	# asm
4379 4380 4381 4382
			    $line =~ /^\+.*\\$/) {
				WARN("LINE_CONTINUATIONS",
				     "Avoid unnecessary line continuations\n" . $herecurr);
			}
4383 4384
		}

4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399
# 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;
4400
			$dstat =~ s/$;/ /g;
4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413

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

4414 4415
				if (($stmts =~ tr/;/;/) == 1 &&
				    $stmts !~ /^\s*(if|while|for|switch)\b/) {
4416 4417 4418 4419 4420 4421 4422
					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");
				}
4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433
			} 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");
4434 4435 4436
			}
		}

4437 4438 4439 4440 4441 4442
# 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|$))/) {
4443 4444
			WARN("MISSING_VMLINUX_SYMBOL",
			     "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
4445 4446
		}

4447
# check for redundant bracing round if etc
4448 4449
		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
			my ($level, $endln, @chunks) =
4450
				ctx_statement_full($linenr, $realcnt, 1);
4451
			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4452 4453
			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
			if ($#chunks > 0 && $level == 0) {
4454 4455
				my @allowed = ();
				my $allow = 0;
4456
				my $seen = 0;
4457
				my $herectx = $here . "\n";
4458
				my $ln = $linenr - 1;
4459 4460 4461
				for my $chunk (@chunks) {
					my ($cond, $block) = @{$chunk};

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

4466
					$allowed[$allow] = 0;
4467 4468 4469 4470 4471 4472
					#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";
4473 4474
					$ln += statement_rawlines($block) - 1;

4475
					substr($block, 0, length($cond), '');
4476 4477 4478

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

4479
					#print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4480 4481
					if (statement_lines($cond) > 1) {
						#print "APW: ALLOWED: cond<$cond>\n";
4482
						$allowed[$allow] = 1;
4483 4484
					}
					if ($block =~/\b(?:if|for|while)\b/) {
4485
						#print "APW: ALLOWED: block<$block>\n";
4486
						$allowed[$allow] = 1;
4487
					}
4488 4489
					if (statement_block_size($block) > 1) {
						#print "APW: ALLOWED: lines block<$block>\n";
4490
						$allowed[$allow] = 1;
4491
					}
4492
					$allow++;
4493
				}
4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506
				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);
					}
4507 4508 4509
				}
			}
		}
4510
		if (!defined $suppress_ifbraces{$linenr - 1} &&
4511
					$line =~ /\b(if|while|for|else)\b/) {
4512 4513 4514 4515 4516 4517 4518
			my $allowed = 0;

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

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

4523 4524
			# Check the condition.
			my ($cond, $block) = @{$chunks[0]};
4525
			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4526
			if (defined $cond) {
4527
				substr($block, 0, length($cond), '');
4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544
			}
			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) {
4545
					substr($block, 0, length($cond), '');
4546 4547 4548 4549 4550 4551 4552
				}
				if ($block =~ /^\s*\{/) {
					#print "APW: ALLOWED: chunk-1 block<$block>\n";
					$allowed = 1;
				}
			}
			if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
4553
				my $herectx = $here . "\n";
4554
				my $cnt = statement_rawlines($block);
4555

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

4560 4561
				WARN("BRACES",
				     "braces {} are not necessary for single statement blocks\n" . $herectx);
4562 4563 4564
			}
		}

4565
# check for unnecessary blank lines around braces
4566
		if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
4567 4568 4569 4570 4571
			if (CHK("BRACES",
				"Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
			    $fix && $prevrawline =~ /^\+/) {
				fix_delete_line($fixlinenr - 1, $prevrawline);
			}
4572
		}
4573
		if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
4574 4575 4576 4577 4578
			if (CHK("BRACES",
				"Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
			    $fix) {
				fix_delete_line($fixlinenr, $rawline);
			}
4579 4580
		}

4581
# no volatiles please
4582 4583
		my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
		if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
4584 4585
			WARN("VOLATILE",
			     "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4586 4587
		}

4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636
# 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
		if ($line =~ /^\+\s*"[X\t]*"/ &&
		    $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);
		}

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

		}

4637 4638 4639 4640 4641 4642
# concatenated string without spaces between elements
		if ($line =~ /"X+"[A-Z_]+/ || $line =~ /[A-Z_]+"X+"/) {
			CHK("CONCATENATED_STRING",
			    "Concatenated strings should use spaces between elements\n" . $herecurr);
		}

4643 4644 4645 4646 4647 4648
# uncoalesced string fragments
		if ($line =~ /"X*"\s*"/) {
			WARN("STRING_FRAGMENTS",
			     "Consecutive strings are generally better as a single string\n" . $herecurr);
		}

4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666
# check for %L{u,d,i} in strings
		my $string;
		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
			$string = substr($rawline, $-[1], $+[1] - $-[1]);
			$string =~ s/%%/__/g;
			if ($string =~ /(?<!%)%L[udi]/) {
				WARN("PRINTF_L",
				     "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
				last;
			}
		}

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

4667
# warn about #if 0
4668
		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
4669 4670
			CHK("REDUNDANT_CODE",
			    "if this code is redundant consider removing it\n" .
4671
				$herecurr);
4672 4673
		}

4674 4675 4676 4677 4678
# check for needless "if (<foo>) fn(<foo>)" uses
		if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
			my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
			if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
				WARN('NEEDLESS_IF',
4679
				     "$1(NULL) is safe and this check is probably not required\n" . $hereprev);
4680 4681
			}
		}
4682

4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699
# check for unnecessary "Out of Memory" messages
		if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
		    $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
		    (defined $1 || defined $3) &&
		    $linenr > 3) {
			my $testval = $2;
			my $testline = $lines[$linenr - 3];

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

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

4700
# check for logging functions with KERN_<LEVEL>
4701
		if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
4702 4703 4704 4705 4706 4707 4708 4709 4710
		    $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*//;
			}
		}

4711 4712 4713 4714 4715 4716 4717 4718
# 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);
		}

4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732
# 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/;
				}
			}
		}

4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745
# 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) {
4746
					$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;
4747 4748 4749 4750
				}
			}
		}

4751 4752 4753 4754 4755 4756 4757 4758 4759
# 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) {
4760
				$fixed[$fixlinenr] =~
4761 4762 4763 4764 4765 4766 4767 4768 4769 4770
				    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) {
4771
				my $lead = $fixed[$fixlinenr] =~
4772 4773 4774 4775
				    /(^\+\s*(?:static\s+))/;
				$lead = rtrim($1);
				$lead = "$lead " if ($lead !~ /^\+$/);
				$lead = "${lead}const ";
4776
				$fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
4777 4778 4779
			}
		}

4780 4781 4782 4783 4784 4785 4786 4787 4788
# 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) {
4789
				$fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
4790 4791 4792
			}
		}

4793
# prefer usleep_range over udelay
B
Bruce Allan 已提交
4794
		if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
4795
			my $delay = $1;
4796
			# ignore udelay's < 10, however
4797
			if (! ($delay < 10) ) {
4798
				CHK("USLEEP_RANGE",
4799 4800 4801 4802 4803
				    "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);
4804 4805 4806
			}
		}

4807 4808 4809
# warn about unexpectedly long msleep's
		if ($line =~ /\bmsleep\s*\((\d+)\);/) {
			if ($1 < 20) {
4810
				WARN("MSLEEP",
4811
				     "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4812 4813 4814
			}
		}

4815 4816 4817 4818 4819 4820
# 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);
		}

4821 4822 4823 4824 4825 4826
# 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);
		}

4827
# warn about #ifdefs in C files
4828
#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
4829 4830 4831 4832 4833
#			print "#ifdef in C files should be avoided\n";
#			print "$herecurr";
#			$clean = 0;
#		}

4834
# warn about spacing in #ifdefs
4835
		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
4836 4837 4838
			if (ERROR("SPACING",
				  "exactly one space required after that #$1\n" . $herecurr) &&
			    $fix) {
4839
				$fixed[$fixlinenr] =~
4840 4841 4842
				    s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
			}

4843 4844
		}

4845
# check for spinlock_t definitions without a comment.
4846 4847
		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
4848 4849
			my $which = $1;
			if (!ctx_has_comment($first_line, $linenr)) {
4850 4851
				CHK("UNCOMMENTED_DEFINITION",
				    "$1 definition without comment\n" . $herecurr);
4852 4853 4854 4855 4856
			}
		}
# check for memory barriers without a comment.
		if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
			if (!ctx_has_comment($first_line, $linenr)) {
4857 4858
				WARN("MEMORY_BARRIER",
				     "memory barrier without comment\n" . $herecurr);
4859 4860 4861
			}
		}
# check of hardware specific defines
4862
		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
4863 4864
			CHK("ARCH_DEFINES",
			    "architecture specific defines should be avoided\n" .  $herecurr);
4865
		}
4866

4867 4868
# Check that the storage class is at the beginning of a declaration
		if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
4869 4870
			WARN("STORAGE_CLASS",
			     "storage class should be at the beginning of the declaration\n" . $herecurr)
4871 4872
		}

4873 4874
# check the location of the inline attribute, that it is between
# storage class and type.
4875 4876
		if ($line =~ /\b$Type\s+$Inline\b/ ||
		    $line =~ /\b$Inline\s+$Storage\b/) {
4877 4878
			ERROR("INLINE_LOCATION",
			      "inline keyword should sit between storage class and type\n" . $herecurr);
4879 4880
		}

4881
# Check for __inline__ and __inline, prefer inline
4882 4883
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b(__inline__|__inline)\b/) {
4884 4885 4886
			if (WARN("INLINE",
				 "plain inline is preferred over $1\n" . $herecurr) &&
			    $fix) {
4887
				$fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
4888 4889

			}
4890 4891
		}

4892
# Check for __attribute__ packed, prefer __packed
4893 4894
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
4895 4896
			WARN("PREFER_PACKED",
			     "__packed is preferred over __attribute__((packed))\n" . $herecurr);
4897 4898
		}

4899
# Check for __attribute__ aligned, prefer __aligned
4900 4901
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
4902 4903
			WARN("PREFER_ALIGNED",
			     "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
4904 4905
		}

4906
# Check for __attribute__ format(printf, prefer __printf
4907 4908
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
4909 4910 4911
			if (WARN("PREFER_PRINTF",
				 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
			    $fix) {
4912
				$fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4913 4914

			}
4915 4916
		}

4917
# Check for __attribute__ format(scanf, prefer __scanf
4918 4919
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
4920 4921 4922
			if (WARN("PREFER_SCANF",
				 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
			    $fix) {
4923
				$fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4924
			}
4925 4926
		}

4927 4928 4929 4930 4931 4932 4933 4934 4935
# 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);
		}

4936 4937
# check for sizeof(&)
		if ($line =~ /\bsizeof\s*\(\s*\&/) {
4938 4939
			WARN("SIZEOF_ADDRESS",
			     "sizeof(& should be avoided\n" . $herecurr);
4940 4941
		}

4942 4943
# check for sizeof without parenthesis
		if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
4944 4945 4946
			if (WARN("SIZEOF_PARENTHESIS",
				 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
			    $fix) {
4947
				$fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4948
			}
4949 4950
		}

4951 4952 4953 4954 4955 4956
# 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);
		}

4957
# check for seq_printf uses that could be seq_puts
J
Joe Perches 已提交
4958
		if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
4959
			my $fmt = get_quoted_string($line, $rawline);
4960 4961
			$fmt =~ s/%%//g;
			if ($fmt !~ /%/) {
4962 4963 4964
				if (WARN("PREFER_SEQ_PUTS",
					 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
				    $fix) {
4965
					$fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
4966
				}
4967 4968 4969
			}
		}

4970
# Check for misused memsets
4971 4972
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
4973 4974 4975
		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {

			my $ms_addr = $2;
4976 4977
			my $ms_val = $7;
			my $ms_size = $12;
4978 4979 4980

			if ($ms_size =~ /^(0x|)0$/i) {
				ERROR("MEMSET",
4981
				      "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
4982 4983
			} elsif ($ms_size =~ /^(0x|)1$/i) {
				WARN("MEMSET",
4984 4985 4986 4987
				     "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
			}
		}

4988 4989 4990 4991 4992 4993
# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
		if ($^V && $^V ge 5.10.0 &&
		    $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
			if (WARN("PREFER_ETHER_ADDR_COPY",
				 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
			    $fix) {
4994
				$fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4995 4996 4997
			}
		}

4998
# typecasts on min/max could be min_t/max_t
4999 5000
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
5001
		    $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
5002
			if (defined $2 || defined $7) {
5003 5004 5005
				my $call = $1;
				my $cast1 = deparenthesize($2);
				my $arg1 = $3;
5006 5007
				my $cast2 = deparenthesize($7);
				my $arg2 = $8;
5008 5009
				my $cast;

5010
				if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
5011 5012 5013 5014 5015 5016 5017 5018
					$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");
5019 5020 5021
			}
		}

5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037
# 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");
			}
		}

5038 5039 5040
# check for naked sscanf
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
5041
		    $line =~ /\bsscanf\b/ &&
5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054
		    ($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");
		}

5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075
# 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");
				}
			}
		}

5076 5077 5078
# check for new externs in .h files.
		if ($realfile =~ /\.h$/ &&
		    $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
5079 5080
			if (CHK("AVOID_EXTERNS",
				"extern prototypes should be avoided in .h files\n" . $herecurr) &&
5081
			    $fix) {
5082
				$fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
5083 5084 5085
			}
		}

5086
# check for new externs in .c files.
5087
		if ($realfile =~ /\.c$/ && defined $stat &&
5088
		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
5089
		{
5090 5091
			my $function_name = $1;
			my $paren_space = $2;
5092 5093 5094 5095 5096

			my $s = $stat;
			if (defined $cond) {
				substr($s, 0, length($cond), '');
			}
5097 5098 5099
			if ($s =~ /^\s*;/ &&
			    $function_name ne 'uninitialized_var')
			{
5100 5101
				WARN("AVOID_EXTERNS",
				     "externs should be avoided in .c files\n" .  $herecurr);
5102 5103 5104
			}

			if ($paren_space =~ /\n/) {
5105 5106
				WARN("FUNCTION_ARGUMENTS",
				     "arguments for function declarations should follow identifier\n" . $herecurr);
5107
			}
5108 5109 5110 5111

		} elsif ($realfile =~ /\.c$/ && defined $stat &&
		    $stat =~ /^.\s*extern\s+/)
		{
5112 5113
			WARN("AVOID_EXTERNS",
			     "externs should be avoided in .c files\n" .  $herecurr);
5114 5115 5116 5117 5118 5119 5120
		}

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

			if (!grep(/$name/, @setup_docs)) {
5121 5122
				CHK("UNDOCUMENTED_SETUP",
				    "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
5123
			}
5124
		}
5125 5126

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

5132 5133 5134 5135 5136 5137 5138 5139
# 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);
		}

5140 5141
# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
		if ($^V && $^V ge 5.10.0 &&
5142
		    $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
5143 5144 5145 5146 5147
			my $oldfunc = $3;
			my $a1 = $4;
			my $a2 = $10;
			my $newfunc = "kmalloc_array";
			$newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
5148 5149 5150 5151 5152 5153 5154 5155
			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_]*$/)) {
5156 5157 5158
				if (WARN("ALLOC_WITH_MULTIPLY",
					 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
				    $fix) {
5159
					$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;
5160 5161 5162 5163 5164

				}
			}
		}

5165 5166 5167 5168 5169 5170 5171
# 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);
		}

5172 5173 5174 5175 5176 5177
# 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);
		}

5178 5179
# check for multiple semicolons
		if ($line =~ /;\s*;\s*$/) {
5180 5181 5182
			if (WARN("ONE_SEMICOLON",
				 "Statements terminations use 1 semicolon\n" . $herecurr) &&
			    $fix) {
5183
				$fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
5184
			}
5185 5186
		}

5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197
# check for #defines like: 1 << <digit> that could be BIT(digit)
		if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
			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)/;
			}
		}

5198
# check for case / default statements not preceded by break/fallthrough/switch
5199 5200 5201 5202 5203
		if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
			my $has_break = 0;
			my $has_statement = 0;
			my $count = 0;
			my $prevline = $linenr;
5204
			while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222
				$prevline--;
				my $rline = $rawlines[$prevline - 1];
				my $fline = $lines[$prevline - 1];
				last if ($fline =~ /^\@\@/);
				next if ($fline =~ /^\-/);
				next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
				$has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
				next if ($fline =~ /^.[\s$;]*$/);
				$has_statement = 1;
				$count++;
				$has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
			}
			if (!$has_break && $has_statement) {
				WARN("MISSING_BREAK",
				     "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
			}
		}

5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234
# 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);
5235 5236
		}

5237
# check for gcc specific __FUNCTION__
5238 5239 5240 5241
		if ($line =~ /\b__FUNCTION__\b/) {
			if (WARN("USE_FUNC",
				 "__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr) &&
			    $fix) {
5242
				$fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
5243
			}
5244
		}
5245

5246 5247 5248 5249 5250 5251
# 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 已提交
5252 5253 5254 5255 5256 5257
# 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);
		}

5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284
# 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);

			}
		}

5285 5286
# check for semaphores initialized locked
		if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
5287 5288
			WARN("CONSIDER_COMPLETION",
			     "consider using a completion\n" . $herecurr);
5289
		}
5290

5291 5292
# recommend kstrto* over simple_strto* and strict_strto*
		if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
5293
			WARN("CONSIDER_KSTRTO",
5294
			     "$1 is obsolete, use k$3 instead\n" . $herecurr);
5295
		}
5296

5297
# check for __initcall(), use device_initcall() explicitly or more appropriate function please
5298
		if ($line =~ /^.\s*__initcall\s*\(/) {
5299
			WARN("USE_DEVICE_INITCALL",
5300
			     "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
5301
		}
5302

5303 5304 5305
# check for various structs that are normally const (ops, kgdb, device_tree)
		my $const_structs = qr{
				acpi_dock_ops|
5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327
				address_space_operations|
				backlight_ops|
				block_device_operations|
				dentry_operations|
				dev_pm_ops|
				dma_map_ops|
				extent_io_ops|
				file_lock_operations|
				file_operations|
				hv_ops|
				ide_dma_ops|
				intel_dvo_dev_ops|
				item_operations|
				iwl_ops|
				kgdb_arch|
				kgdb_io|
				kset_uevent_ops|
				lock_manager_operations|
				microcode_ops|
				mtrr_ops|
				neigh_ops|
				nlmsvc_binding|
5328
				of_device_id|
5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342
				pci_raw_ops|
				pipe_buf_operations|
				platform_hibernation_ops|
				platform_suspend_ops|
				proto_ops|
				rpc_pipe_ops|
				seq_operations|
				snd_ac97_build_ops|
				soc_pcmcia_socket_ops|
				stacktrace_ops|
				sysfs_ops|
				tty_operations|
				usb_mon_operations|
				wd_ops}x;
5343
		if ($line !~ /\bconst\b/ &&
5344
		    $line =~ /\bstruct\s+($const_structs)\b/) {
5345 5346
			WARN("CONST_STRUCT",
			     "struct $1 should normally be const\n" .
5347
				$herecurr);
5348
		}
5349 5350 5351 5352

# 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/ &&
5353 5354
		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
5355 5356 5357
		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
5358
		{
5359 5360
			WARN("NR_CPUS",
			     "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
5361
		}
5362

5363 5364 5365 5366 5367 5368
# 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);
		}

5369 5370 5371 5372 5373 5374 5375
# 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);
		}

5376 5377 5378
# whine mightly about in_atomic
		if ($line =~ /\bin_atomic\s*\(/) {
			if ($realfile =~ m@^drivers/@) {
5379 5380
				ERROR("IN_ATOMIC",
				      "do not use in_atomic in drivers\n" . $herecurr);
5381
			} elsif ($realfile !~ m@^kernel/@) {
5382 5383
				WARN("IN_ATOMIC",
				     "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
5384 5385
			}
		}
5386 5387 5388 5389 5390 5391 5392

# 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@) {
5393 5394
				ERROR("LOCKDEP",
				      "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
5395 5396
			}
		}
5397

5398 5399
		if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
		    $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
5400 5401
			WARN("EXPORTED_WORLD_WRITABLE",
			     "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5402
		}
5403

5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426
# Mode permission misuses where it seems decimal should be octal
# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
		if ($^V && $^V ge 5.10.0 &&
		    $line =~ /$mode_perms_search/) {
			foreach my $entry (@mode_permission_funcs) {
				my $func = $entry->[0];
				my $arg_pos = $entry->[1];

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

					if ($val !~ /^0$/ &&
					    (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
					     length($val) ne 4)) {
						ERROR("NON_OCTAL_PERMISSIONS",
						      "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
5427 5428 5429
					} elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
						ERROR("EXPORTED_WORLD_WRITABLE",
						      "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5430
					}
5431 5432 5433
				}
			}
		}
5434 5435 5436 5437 5438 5439
	}

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

5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454
	# In mailback mode only produce a report in the negative, for
	# things that appear to be patches.
	if ($mailback && ($clean == 1 || !$is_patch)) {
		exit(0);
	}

	# This is not a patch, and we are are in 'no-patch' mode so
	# just keep quiet.
	if (!$chk_patch && !$is_patch) {
		exit(0);
	}

	if (!$is_patch) {
5455 5456
		ERROR("NOT_UNIFIED_DIFF",
		      "Does not appear to be a unified-diff format patch\n");
5457 5458
	}
	if ($is_patch && $chk_signoff && $signoff == 0) {
5459 5460
		ERROR("MISSING_SIGN_OFF",
		      "Missing Signed-off-by: line(s)\n");
5461 5462
	}

5463
	print report_dump();
5464 5465
	if ($summary && !($clean == 1 && $quiet == 1)) {
		print "$filename " if ($summary_file);
5466 5467 5468 5469
		print "total: $cnt_error errors, $cnt_warn warnings, " .
			(($check)? "$cnt_chk checks, " : "") .
			"$cnt_lines lines checked\n";
		print "\n" if ($quiet == 0);
5470
	}
5471

5472
	if ($quiet == 0) {
5473 5474 5475 5476 5477 5478

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

5479 5480 5481 5482 5483
		# If there were whitespace errors which cleanpatch can fix
		# then suggest that.
		if ($rpt_cleaners) {
			print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
			print "      scripts/cleanfile\n\n";
5484
			$rpt_cleaners = 0;
5485 5486 5487
		}
	}

5488 5489
	hash_show_words(\%use_type, "Used");
	hash_show_words(\%ignore_type, "Ignored");
5490

5491 5492 5493
	if ($clean == 0 && $fix &&
	    ("@rawlines" ne "@fixed" ||
	     $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
5494 5495
		my $newfile = $filename;
		$newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
5496 5497 5498
		my $linecount = 0;
		my $f;

5499 5500
		@fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);

5501 5502 5503 5504 5505 5506 5507
		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/^\+//;
5508
					print $f $fixed_line . "\n";
5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529
				}
			} else {
				print $f $fixed_line . "\n";
			}
		}
		close($f);

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

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

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

EOM
		}
	}

5530
	if ($clean == 1 && $quiet == 0) {
5531
		print "$vname has no obvious style problems and is ready for submission.\n"
5532 5533
	}
	if ($clean == 0 && $quiet == 0) {
5534 5535 5536 5537 5538 5539
		print << "EOM";
$vname has style problems, please review.

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

5542 5543
	return $clean;
}