checkpatch.pl 175.0 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
use Term::ANSIColor qw(:constants);
13 14

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

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

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

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

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
71
  --showfile                 emit diffed file position, not input file position
72 73
  -f, --file                 treat FILE as regular source file
  --subjective, --strict     enable more subjective tests
74
  --list-types               list the possible message types
75
  --types TYPE(,TYPE2...)    show only these comma separated message types
76
  --ignore TYPE(,TYPE2...)   ignore various comma separated message types
77
  --show-types               show the specific message type in the output
78
  --max-line-length=n        set the maximum line length, if exceeded, warn
79
  --min-conf-desc-length=n   set the min description length, if shorter, warn
80 81 82 83 84 85 86 87 88
  --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
89 90 91 92 93
  --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
94 95 96
  --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
97 98
  --ignore-perl-version      override checking of perl version.  expect
                             runtime errors.
99
  --codespell                Use the codespell dictionary for spelling/typos
100
                             (default:/usr/share/codespell/dictionary.txt)
101
  --codespellfile            Use this codespell dictionary
102
  --color                    Use colors when output is STDOUT (default: on)
103 104 105 106 107 108 109 110
  -h, --help, --version      display this help and exit

When FILE is - read standard input.
EOM

	exit($exitcode);
}

111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
sub uniq {
	my %seen;
	return grep { !$seen{$_}++ } @_;
}

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

	my $count = 0;

	local $/ = undef;

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

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

	my @types = ();
	for ($text =~ /\b(?:(?:CHK|WARN|ERROR)\s*\(\s*"([^"]+)")/g) {
		push (@types, $_);
	}
	@types = sort(uniq(@types));
	print("#\tMessage type\n\n");
	foreach my $type (@types) {
		print(++$count . "\t" . $type . "\n");
	}

	exit($exitcode);
}

142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
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;
}

168
GetOptions(
169
	'q|quiet+'	=> \$quiet,
170 171 172
	'tree!'		=> \$tree,
	'signoff!'	=> \$chk_signoff,
	'patch!'	=> \$chk_patch,
173
	'emacs!'	=> \$emacs,
174
	'terse!'	=> \$terse,
175
	'showfile!'	=> \$showfile,
176
	'f|file!'	=> \$file,
177 178
	'subjective!'	=> \$check,
	'strict!'	=> \$check,
179
	'ignore=s'	=> \@ignore,
180
	'types=s'	=> \@use,
181
	'show-types!'	=> \$show_types,
182
	'list-types!'	=> \$list_types,
183
	'max-line-length=i' => \$max_line_length,
184
	'min-conf-desc-length=i' => \$min_conf_desc_length,
185
	'root=s'	=> \$root,
186 187
	'summary!'	=> \$summary,
	'mailback!'	=> \$mailback,
188
	'summary-file!'	=> \$summary_file,
189
	'fix!'		=> \$fix,
190
	'fix-inplace!'	=> \$fix_inplace,
191
	'ignore-perl-version!' => \$ignore_perl_version,
192
	'debug=s'	=> \%debug,
193
	'test-only=s'	=> \$tst_only,
194 195
	'codespell!'	=> \$codespell,
	'codespellfile=s'	=> \$codespellfile,
196
	'color!'	=> \$color,
197 198 199 200 201
	'h|help'	=> \$help,
	'version'	=> \$help
) or help(1);

help(0) if ($help);
202

203 204
list_types(0) if ($list_types);

205
$fix = 1 if ($fix_inplace);
206
$check_orig = $check;
207

208 209
my $exit = 0;

210 211 212 213 214 215 216
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);
	}
}

217
if ($#ARGV < 0) {
218
	print "$P: no input files\n";
219 220 221
	exit(1);
}

222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
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}++;
	}
}
238

239 240
sub hash_show_words {
	my ($hashRef, $prefix) = @_;
241

242
	if (keys %$hashRef) {
243
		print "\nNOTE: $prefix message types:";
244
		foreach my $word (sort keys %$hashRef) {
245 246
			print " $word";
		}
247
		print "\n";
248
	}
249 250
}

251 252 253
hash_save_array_words(\%ignore_type, \@ignore);
hash_save_array_words(\%use_type, \@use);

254 255
my $dbg_values = 0;
my $dbg_possible = 0;
256
my $dbg_type = 0;
257
my $dbg_attr = 0;
258
for my $key (keys %debug) {
259 260 261
	## no critic
	eval "\${dbg_$key} = '$debug{$key}';";
	die "$@" if ($@);
262 263
}

264 265
my $rpt_cleaners = 0;

266 267 268 269 270
if ($terse) {
	$emacs = 1;
	$quiet++;
}

271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
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);
	}
289 290
}

291 292
my $emitted_corrupt = 0;

293 294 295 296
our $Ident	= qr{
			[A-Za-z_][A-Za-z\d_]*
			(?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
		}x;
297 298 299 300 301 302
our $Storage	= qr{extern|static|asmlinkage};
our $Sparse	= qr{
			__user|
			__kernel|
			__force|
			__iomem|
303
			__pmem|
304 305
			__must_check|
			__init_refok|
306
			__kprobes|
307
			__ref|
308 309
			__rcu|
			__private
310
		}x;
311 312 313 314 315
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};
316

317 318
# Notes to $Attribute:
# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
319 320
our $Attribute	= qr{
			const|
321 322 323 324 325 326 327 328 329 330 331 332
			__percpu|
			__nocast|
			__safe|
			__bitwise__|
			__packed__|
			__packed2__|
			__naked|
			__maybe_unused|
			__always_unused|
			__noreturn|
			__used|
			__cold|
333
			__pure|
334 335
			__noclone|
			__deprecated|
336 337
			__read_mostly|
			__kprobes|
338
			$InitAttribute|
339 340
			____cacheline_aligned|
			____cacheline_aligned_in_smp|
341 342
			____cacheline_internodealigned_in_smp|
			__weak
343
		  }x;
344
our $Modifier;
345
our $Inline	= qr{inline|__always_inline|noinline|__inline|__inline__};
346 347 348
our $Member	= qr{->$Ident|\.$Ident|\[[^]]*\]};
our $Lval	= qr{$Ident(?:$Member)*};

349 350 351 352
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?};
353
our $Octal	= qr{0[0-7]+$Int_type?};
354
our $String	= qr{"[X\t]*"};
355 356 357
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]?};
358
our $Float	= qr{$Float_hex|$Float_dec|$Float_int};
359
our $Constant	= qr{$Float|$Binary|$Octal|$Hex|$Int};
360
our $Assignment	= qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
361
our $Compare    = qr{<=|>=|==|!=|<|(?<!-)>};
362
our $Arithmetic = qr{\+|-|\*|\/|%};
363 364 365
our $Operators	= qr{
			<=|>=|==|!=|
			=>|->|<<|>>|<|>|!|~|
366
			&&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
367 368
		  }x;

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

371
our $BasicType;
372
our $NonptrType;
373
our $NonptrTypeMisordered;
374
our $NonptrTypeWithAttr;
375
our $Type;
376
our $TypeMisordered;
377
our $Declare;
378
our $DeclareMisordered;
379

380 381
our $NON_ASCII_UTF8	= qr{
	[\xC2-\xDF][\x80-\xBF]               # non-overlong 2-byte
382 383 384 385 386 387 388 389
	|  \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;

390 391 392 393 394
our $UTF8	= qr{
	[\x09\x0A\x0D\x20-\x7E]              # ASCII
	| $NON_ASCII_UTF8
}x;

395
our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
396 397 398 399
our $typeOtherOSTypedefs = qr{(?x:
	u_(?:char|short|int|long) |          # bsd
	u(?:nchar|short|int|long)            # sysv
)};
400
our $typeKernelTypedefs = qr{(?x:
401
	(?:__)?(?:u|s|be|le)(?:8|16|32|64)|
402 403
	atomic_t
)};
404 405 406 407 408
our $typeTypedefs = qr{(?x:
	$typeC99Typedefs\b|
	$typeOtherOSTypedefs\b|
	$typeKernelTypedefs\b
)};
409

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

412
our $logFunctions = qr{(?x:
413
	printk(?:_ratelimited|_once|)|
414
	(?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
415
	WARN(?:_RATELIMIT|_ONCE|)|
416
	panic|
J
Joe Perches 已提交
417 418
	MODULE_[A-Z_]+|
	seq_vprintf|seq_printf|seq_puts
419 420
)};

421 422 423 424 425 426
our $signature_tags = qr{(?xi:
	Signed-off-by:|
	Acked-by:|
	Tested-by:|
	Reviewed-by:|
	Reported-by:|
427
	Suggested-by:|
428 429 430 431
	To:|
	Cc:
)};

432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
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},
);

451 452
our @typeList = (
	qr{void},
453 454 455 456 457 458 459 460 461
	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},
462 463 464 465 466 467 468 469 470
	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},
471
	@typeListMisordered,
472
);
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494

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

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

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

495
our @typeListFile = ();
496 497 498 499 500 501
our @typeListWithAttr = (
	@typeList,
	qr{struct\s+$InitAttribute\s+$Ident},
	qr{union\s+$InitAttribute\s+$Ident},
);

502 503 504
our @modifierList = (
	qr{fastcall},
);
505
our @modifierListFile = ();
506

507 508 509 510 511 512 513 514 515
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],
);

516 517 518 519 520 521 522
#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];
}

523 524 525 526 527 528 529 530
our $mode_perms_world_writable = qr{
	S_IWUGO		|
	S_IWOTH		|
	S_IRWXUGO	|
	S_IALLUGO	|
	0[0-7][0-7][2367]
}x;

531 532
our $allowed_asm_includes = qr{(?x:
	irq|
533 534 535
	memory|
	time|
	reboot
536 537 538
)};
# memory.h: ARM has a custom one

539 540 541 542
# Load common spelling mistakes and build regular expression list.
my $misspellings;
my %spelling_fix;

543 544 545
if (open(my $spelling, '<', $spelling_file)) {
	while (<$spelling>) {
		my $line = $_;
546

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

550 551 552 553
		next if ($line =~ m/^\s*#/);
		next if ($line =~ m/^\s*$/);

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

555 556 557 558 559
		$spelling_fix{$suspect} = $fix;
	}
	close($spelling);
} else {
	warn "No typos will be found - file '$spelling_file': $!\n";
560 561
}

562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
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;

588
sub build_types {
589 590
	my $mods = "(?x:  \n" . join("|\n  ", (@modifierList, @modifierListFile)) . "\n)";
	my $all = "(?x:  \n" . join("|\n  ", (@typeList, @typeListFile)) . "\n)";
591
	my $Misordered = "(?x:  \n" . join("|\n  ", @typeListMisordered) . "\n)";
592
	my $allWithAttr = "(?x:  \n" . join("|\n  ", @typeListWithAttr) . "\n)";
593
	$Modifier	= qr{(?:$Attribute|$Sparse|$mods)};
594 595 596 597
	$BasicType	= qr{
				(?:$typeTypedefs\b)|
				(?:${all}\b)
		}x;
598
	$NonptrType	= qr{
599
			(?:$Modifier\s+|const\s+)*
600
			(?:
601
				(?:typeof|__typeof__)\s*\([^\)]*\)|
602
				(?:$typeTypedefs\b)|
603
				(?:${all}\b)
604
			)
605
			(?:\s+$Modifier|\s+const)*
606
		  }x;
607 608 609 610 611 612 613
	$NonptrTypeMisordered	= qr{
			(?:$Modifier\s+|const\s+)*
			(?:
				(?:${Misordered}\b)
			)
			(?:\s+$Modifier|\s+const)*
		  }x;
614 615 616 617 618 619 620 621 622
	$NonptrTypeWithAttr	= qr{
			(?:$Modifier\s+|const\s+)*
			(?:
				(?:typeof|__typeof__)\s*\([^\)]*\)|
				(?:$typeTypedefs\b)|
				(?:${allWithAttr}\b)
			)
			(?:\s+$Modifier|\s+const)*
		  }x;
623
	$Type	= qr{
624
			$NonptrType
625
			(?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
626
			(?:\s+$Inline|\s+$Modifier)*
627
		  }x;
628 629 630 631 632
	$TypeMisordered	= qr{
			$NonptrTypeMisordered
			(?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
			(?:\s+$Inline|\s+$Modifier)*
		  }x;
633
	$Declare	= qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
634
	$DeclareMisordered	= qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
635 636
}
build_types();
637

638
our $Typecast	= qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
639 640 641 642 643 644

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

648
our $declaration_macros = qr{(?x:
649
	(?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
650 651 652 653
	(?:$Storage\s+)?LIST_HEAD\s*\(|
	(?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
)};

654 655 656
sub deparenthesize {
	my ($string) = @_;
	return "" if (!defined($string));
657 658 659 660 661 662

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

663
	$string =~ s@\s+@ @g;
664

665 666 667
	return $string;
}

668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685
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;
686 687 688
		} 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*[;\{]/) {
689 690 691 692 693 694 695 696 697 698
			$camelcase{$1} = 1;
		}
	}
}

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

	my $files;
699 700 701 702
	my $camelcase_cache = "";
	my @include_files = ();

	$camelcase_seeded = 1;
703

704
	if (-e ".git") {
705 706
		my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
		chomp $git_last_include_commit;
707
		$camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
708
	} else {
709
		my $last_mod_date = 0;
710
		$files = `find $root/include -name "*.h"`;
711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729
		@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;
730
	}
731

732
	if (-e ".git") {
733 734 735 736
		$files = `git ls-files "include/*.h"`;
		@include_files = split('\n', $files);
	}

737 738 739
	foreach my $file (@include_files) {
		seed_camelcase_file($file);
	}
740

741
	if ($camelcase_cache ne "") {
742
		unlink glob ".checkpatch-camelcase.*";
743 744
		open(my $camelcase_file, '>', "$camelcase_cache")
		    or warn "$P: Can't write '$camelcase_cache' $!\n";
745 746 747 748 749
		foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
			print $camelcase_file ("$_\n");
		}
		close($camelcase_file);
	}
750 751
}

752 753 754 755 756 757 758 759 760
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);

761 762
	return ($id, $desc) if ($#lines < 0);

763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781
	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);
}

782 783
$chk_signoff = 0 if ($file);

784
my @rawlines = ();
785
my @lines = ();
786
my @fixed = ();
787 788
my @fixed_inserted = ();
my @fixed_deleted = ();
789 790
my $fixlinenr = -1;

791
my $vname;
792
for my $filename (@ARGV) {
793
	my $FILE;
794
	if ($file) {
795
		open($FILE, '-|', "diff -u /dev/null $filename") ||
796
			die "$P: $filename: diff failed - $!\n";
797 798
	} elsif ($filename eq '-') {
		open($FILE, '<&STDIN');
799
	} else {
800
		open($FILE, '<', "$filename") ||
801
			die "$P: $filename: open failed - $!\n";
802
	}
803 804 805 806 807
	if ($filename eq '-') {
		$vname = 'Your patch';
	} else {
		$vname = $filename;
	}
808
	while (<$FILE>) {
809 810 811
		chomp;
		push(@rawlines, $_);
	}
812
	close($FILE);
813 814 815 816 817 818 819

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

820
	if (!process($filename)) {
821 822 823
		$exit = 1;
	}
	@rawlines = ();
824
	@lines = ();
825
	@fixed = ();
826 827
	@fixed_inserted = ();
	@fixed_deleted = ();
828
	$fixlinenr = -1;
829 830 831
	@modifierListFile = ();
	@typeListFile = ();
	build_types();
832 833
}

834
if (!$quiet) {
835 836 837
	hash_show_words(\%use_type, "Used");
	hash_show_words(\%ignore_type, "Ignored");

838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
	if ($^V lt 5.10.0) {
		print << "EOM"

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

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

854 855 856
exit($exit);

sub top_of_kernel_tree {
857 858 859 860 861 862 863 864 865 866 867 868
	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;
		}
869
	}
870
	return 1;
871
}
872

873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891
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;
892
		$name = trim($name);
893 894 895 896 897 898 899 900 901 902 903 904 905 906
		$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 = "";
		}
	}

907
	$name = trim($name);
908
	$name =~ s/^\"|\"$//g;
909
	$address = trim($address);
910 911 912 913 914 915 916 917 918 919 920 921 922 923 924
	$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;

925
	$name = trim($name);
926
	$name =~ s/^\"|\"$//g;
927
	$address = trim($address);
928 929 930 931 932 933 934 935 936 937 938 939 940 941 942

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

943
sub which {
944
	my ($bin) = @_;
945

946 947 948 949
	foreach my $path (split(/:/, $ENV{PATH})) {
		if (-e "$path/$bin") {
			return "$path/$bin";
		}
950 951
	}

952
	return "";
953 954
}

955 956 957 958 959 960 961 962 963 964 965 966
sub which_conf {
	my ($conf) = @_;

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

	return "";
}

967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986
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;
}
987
sub copy_spacing {
988
	(my $res = shift) =~ tr/\t/ /c;
989 990
	return $res;
}
991

992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
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));
}

1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
my $sanitise_quote = '';

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

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
1016 1017 1018 1019 1020 1021
sub sanitise_line {
	my ($line) = @_;

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

1022
	my $qlen = 0;
1023 1024
	my $off = 0;
	my $c;
1025

1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
	# 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;
1040
		}
1041
		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
1042 1043 1044 1045
			$sanitise_quote = '';
			substr($res, $off, 2, "$;$;");
			$off++;
			next;
1046
		}
1047 1048 1049 1050 1051 1052 1053
		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
			$sanitise_quote = '//';

			substr($res, $off, 2, $sanitise_quote);
			$off++;
			next;
		}
1054 1055 1056 1057 1058 1059 1060

		# 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;
1061
		}
1062 1063 1064 1065
		# Regular quotes.
		if ($c eq "'" || $c eq '"') {
			if ($sanitise_quote eq '') {
				$sanitise_quote = $c;
1066

1067 1068 1069 1070 1071 1072
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
1073

1074
		#print "c<$c> SQ<$sanitise_quote>\n";
1075 1076
		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
			substr($res, $off, 1, $;);
1077 1078
		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
			substr($res, $off, 1, $;);
1079 1080 1081 1082 1083
		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
			substr($res, $off, 1, 'X');
		} else {
			substr($res, $off, 1, $c);
		}
1084 1085
	}

1086 1087 1088 1089
	if ($sanitise_quote eq '//') {
		$sanitise_quote = '';
	}

1090
	# The pathname on a #include may be surrounded by '<' and '>'.
1091
	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
1092 1093 1094 1095
		my $clean = 'X' x length($1);
		$res =~ s@\<.*\>@<$clean>@;

	# The whole of a #error is a string.
1096
	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
1097
		my $clean = 'X' x length($1);
1098
		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
1099 1100
	}

1101 1102 1103
	return $res;
}

1104 1105 1106
sub get_quoted_string {
	my ($line, $rawline) = @_;

1107
	return "" if ($line !~ m/($String)/g);
1108 1109 1110
	return substr($rawline, $-[0], $+[0] - $-[0]);
}

1111 1112 1113 1114 1115 1116
sub ctx_statement_block {
	my ($linenr, $remain, $off) = @_;
	my $line = $linenr - 1;
	my $blk = '';
	my $soff = $off;
	my $coff = $off - 1;
1117
	my $coff_set = 0;
1118

1119 1120
	my $loff = 0;

1121 1122
	my $type = '';
	my $level = 0;
1123
	my @stack = ();
1124
	my $p;
1125 1126
	my $c;
	my $len = 0;
1127 1128

	my $remainder;
1129
	while (1) {
1130 1131
		@stack = (['', 0]) if ($#stack == -1);

1132
		#warn "CSB: blk<$blk> remain<$remain>\n";
1133 1134 1135 1136
		# If we are about to drop off the end, pull in more
		# context.
		if ($off >= $len) {
			for (; $remain > 0; $line++) {
1137
				last if (!defined $lines[$line]);
1138
				next if ($lines[$line] =~ /^-/);
1139
				$remain--;
1140
				$loff = $len;
1141
				$blk .= $lines[$line] . "\n";
1142 1143 1144 1145 1146 1147
				$len = length($blk);
				$line++;
				last;
			}
			# Bail if there is no further context.
			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
1148
			if ($off >= $len) {
1149 1150
				last;
			}
1151 1152 1153 1154
			if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
				$level++;
				$type = '#';
			}
1155
		}
1156
		$p = $c;
1157
		$c = substr($blk, $off, 1);
1158
		$remainder = substr($blk, $off);
1159

1160
		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1161 1162 1163 1164 1165 1166 1167 1168 1169 1170

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

1171 1172 1173 1174 1175 1176
		# Statement ends at the ';' or a close '}' at the
		# outermost level.
		if ($level == 0 && $c eq ';') {
			last;
		}

1177
		# An else is really a conditional as long as its not else if
1178 1179 1180 1181 1182 1183 1184 1185
		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";
1186 1187
		}

1188 1189 1190 1191 1192 1193 1194 1195 1196 1197
		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;
1198 1199
				$coff_set = 1;
				#warn "CSB: mark coff<$coff>\n";
1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210
			}
		}
		if (($type eq '' || $type eq '{') && $c eq '{') {
			$level++;
			$type = '{';
		}
		if ($type eq '{' && $c eq '}') {
			$level--;
			$type = ($level != 0)? '{' : '';

			if ($level == 0) {
1211 1212 1213
				if (substr($blk, $off + 1, 1) eq ';') {
					$off++;
				}
1214 1215 1216
				last;
			}
		}
1217 1218 1219 1220 1221 1222 1223
		# Preprocessor commands end at the newline unless escaped.
		if ($type eq '#' && $c eq "\n" && $p ne "\\") {
			$level--;
			$type = '';
			$off++;
			last;
		}
1224 1225
		$off++;
	}
1226
	# We are truly at the end, so shuffle to the next line.
1227
	if ($off == $len) {
1228
		$loff = $len + 1;
1229 1230 1231
		$line++;
		$remain--;
	}
1232 1233 1234 1235 1236 1237 1238

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

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

1239
	#print "coff<$coff> soff<$off> loff<$loff>\n";
1240 1241 1242 1243 1244

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

1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287
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;
	}
}

1288 1289 1290 1291 1292 1293
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

1294
	# Grab the first conditional/block pair.
1295 1296
	($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
1297
	#print "F: c<$condition> s<$statement> remain<$remain>\n";
1298 1299 1300 1301 1302 1303 1304
	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.
1305 1306 1307
	for (;;) {
		($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
1308
		#print "C: c<$condition> s<$statement> remain<$remain>\n";
1309
		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1310 1311
		#print "C: push\n";
		push(@chunks, [ $condition, $statement ]);
1312 1313 1314
	}

	return ($level, $linenr, @chunks);
1315 1316
}

1317
sub ctx_block_get {
1318
	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1319 1320 1321 1322 1323 1324 1325
	my $line;
	my $start = $linenr - 1;
	my $blk = '';
	my @o;
	my @c;
	my @res = ();

1326
	my $level = 0;
1327
	my @stack = ($level);
1328 1329 1330 1331 1332
	for ($line = $start; $remain > 0; $line++) {
		next if ($rawlines[$line] =~ /^-/);
		$remain--;

		$blk .= $rawlines[$line];
1333 1334

		# Handle nested #if/#else.
1335
		if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1336
			push(@stack, $level);
1337
		} elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1338
			$level = $stack[$#stack - 1];
1339
		} elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1340 1341 1342
			$level = pop(@stack);
		}

1343
		foreach my $c (split(//, $lines[$line])) {
1344 1345 1346 1347 1348
			##print "C<$c>L<$level><$open$close>O<$off>\n";
			if ($off > 0) {
				$off--;
				next;
			}
1349

1350 1351 1352 1353 1354 1355 1356
			if ($c eq $close && $level > 0) {
				$level--;
				last if ($level == 0);
			} elsif ($c eq $open) {
				$level++;
			}
		}
1357

1358
		if (!$outer || $level <= 1) {
1359
			push(@res, $rawlines[$line]);
1360 1361
		}

1362
		last if ($level == 0);
1363 1364
	}

1365
	return ($level, @res);
1366 1367 1368 1369
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

1370 1371
	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
	return @r;
1372 1373 1374 1375
}
sub ctx_block {
	my ($linenr, $remain) = @_;

1376 1377
	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
	return @r;
1378 1379
}
sub ctx_statement {
1380 1381 1382 1383 1384 1385
	my ($linenr, $remain, $off) = @_;

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

1388
	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1389
}
1390 1391 1392 1393 1394
sub ctx_statement_level {
	my ($linenr, $remain, $off) = @_;

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
1395 1396 1397 1398 1399

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

	# Catch a comment on the end of the line itself.
1400
	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1401 1402 1403 1404 1405 1406 1407
	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++) {
1408 1409
		my $line = $rawlines[$linenr - 1];
		#warn "           $line\n";
1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431
		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);

1432
	##print "LINE: $rawlines[$end_line - 1 ]\n";
1433 1434 1435 1436 1437
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453
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;
}

1454 1455 1456
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
1457

1458 1459 1460 1461 1462 1463
	$res = '';
	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
		$res .= $1;
		if ($2 ne '') {
			$coded = sprintf("^%c", unpack('C', $2) + 64);
			$res .= $coded;
1464 1465
		}
	}
1466
	$res =~ s/$/\$/;
1467

1468
	return $res;
1469 1470
}

1471
my $av_preprocessor = 0;
1472
my $av_pending;
1473
my @av_paren_type;
1474
my $av_pend_colon;
1475 1476 1477

sub annotate_reset {
	$av_preprocessor = 0;
1478 1479
	$av_pending = '_';
	@av_paren_type = ('E');
1480
	$av_pend_colon = 'O';
1481 1482
}

1483 1484
sub annotate_values {
	my ($stream, $type) = @_;
1485

1486
	my $res;
1487
	my $var = '_' x length($stream);
1488 1489
	my $cur = $stream;

1490
	print "$stream\n" if ($dbg_values > 1);
1491 1492

	while (length($cur)) {
1493
		@av_paren_type = ('E') if ($#av_paren_type < 0);
1494
		print " <" . join('', @av_paren_type) .
1495
				"> <$type> <$av_pending>" if ($dbg_values > 1);
1496
		if ($cur =~ /^(\s+)/o) {
1497 1498
			print "WS($1)\n" if ($dbg_values > 1);
			if ($1 =~ /\n/ && $av_preprocessor) {
1499
				$type = pop(@av_paren_type);
1500
				$av_preprocessor = 0;
1501 1502
			}

1503
		} elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1504 1505
			print "CAST($1)\n" if ($dbg_values > 1);
			push(@av_paren_type, $type);
1506
			$type = 'c';
1507

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

1512 1513 1514 1515
		} elsif ($cur =~ /^($Modifier)\s*/) {
			print "MODIFIER($1)\n" if ($dbg_values > 1);
			$type = 'T';

1516
		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1517
			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1518
			$av_preprocessor = 1;
1519 1520 1521 1522 1523 1524
			push(@av_paren_type, $type);
			if ($2 ne '') {
				$av_pending = 'N';
			}
			$type = 'E';

1525
		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1526 1527 1528
			print "UNDEF($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;
			push(@av_paren_type, $type);
1529

1530
		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1531
			print "PRE_START($1)\n" if ($dbg_values > 1);
1532
			$av_preprocessor = 1;
1533 1534 1535

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
1536
			$type = 'E';
1537

1538
		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1539 1540 1541 1542 1543
			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;

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

1544
			$type = 'E';
1545

1546
		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1547 1548 1549 1550 1551 1552 1553 1554
			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);
1555
			$type = 'E';
1556 1557

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

1560 1561 1562 1563 1564
		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
			print "ATTR($1)\n" if ($dbg_values > 1);
			$av_pending = $type;
			$type = 'N';

1565
		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1566
			print "SIZEOF($1)\n" if ($dbg_values > 1);
1567
			if (defined $2) {
1568
				$av_pending = 'V';
1569 1570 1571
			}
			$type = 'N';

1572
		} elsif ($cur =~ /^(if|while|for)\b/o) {
1573
			print "COND($1)\n" if ($dbg_values > 1);
1574
			$av_pending = 'E';
1575 1576
			$type = 'N';

1577 1578 1579 1580 1581
		} elsif ($cur =~/^(case)/o) {
			print "CASE($1)\n" if ($dbg_values > 1);
			$av_pend_colon = 'C';
			$type = 'N';

1582
		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1583
			print "KEYWORD($1)\n" if ($dbg_values > 1);
1584 1585 1586
			$type = 'N';

		} elsif ($cur =~ /^(\()/o) {
1587
			print "PAREN('$1')\n" if ($dbg_values > 1);
1588 1589
			push(@av_paren_type, $av_pending);
			$av_pending = '_';
1590 1591 1592
			$type = 'N';

		} elsif ($cur =~ /^(\))/o) {
1593 1594 1595
			my $new_type = pop(@av_paren_type);
			if ($new_type ne '_') {
				$type = $new_type;
1596 1597
				print "PAREN('$1') -> $type\n"
							if ($dbg_values > 1);
1598
			} else {
1599
				print "PAREN('$1')\n" if ($dbg_values > 1);
1600 1601
			}

1602
		} elsif ($cur =~ /^($Ident)\s*\(/o) {
1603
			print "FUNC($1)\n" if ($dbg_values > 1);
1604
			$type = 'V';
1605
			$av_pending = 'V';
1606

1607 1608
		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
			if (defined $2 && $type eq 'C' || $type eq 'T') {
1609
				$av_pend_colon = 'B';
1610 1611
			} elsif ($type eq 'E') {
				$av_pend_colon = 'L';
1612 1613 1614 1615
			}
			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
			$type = 'V';

1616
		} elsif ($cur =~ /^($Ident|$Constant)/o) {
1617
			print "IDENT($1)\n" if ($dbg_values > 1);
1618 1619 1620
			$type = 'V';

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

1624
		} elsif ($cur =~/^(;|{|})/) {
1625
			print "END($1)\n" if ($dbg_values > 1);
1626
			$type = 'E';
1627 1628
			$av_pend_colon = 'O';

1629 1630 1631 1632
		} elsif ($cur =~/^(,)/) {
			print "COMMA($1)\n" if ($dbg_values > 1);
			$type = 'C';

1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646
		} 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';
1647

1648
		} elsif ($cur =~ /^(\[)/o) {
1649
			print "CLOSE($1)\n" if ($dbg_values > 1);
1650 1651
			$type = 'N';

1652
		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664
			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';

1665
		} elsif ($cur =~ /^($Operators)/o) {
1666
			print "OP($1)\n" if ($dbg_values > 1);
1667 1668 1669 1670 1671
			if ($1 ne '++' && $1 ne '--') {
				$type = 'N';
			}

		} elsif ($cur =~ /(^.)/o) {
1672
			print "C($1)\n" if ($dbg_values > 1);
1673 1674 1675 1676 1677
		}
		if (defined $1) {
			$cur = substr($cur, length($1));
			$res .= $type x length($1);
		}
1678
	}
1679

1680
	return ($res, $var);
1681 1682
}

1683
sub possible {
1684
	my ($possible, $line) = @_;
1685
	my $notPermitted = qr{(?:
1686 1687 1688 1689
		^(?:
			$Modifier|
			$Storage|
			$Type|
1690 1691 1692
			DEFINE_\S+
		)$|
		^(?:
1693 1694 1695 1696 1697
			goto|
			return|
			case|
			else|
			asm|__asm__|
1698 1699 1700
			do|
			\#|
			\#\#|
1701
		)(?:\s|$)|
1702
		^(?:typedef|struct|enum)\b
1703 1704 1705
	    )}x;
	warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
	if ($possible !~ $notPermitted) {
1706 1707 1708 1709 1710 1711 1712
		# 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;
1713
			for my $modifier (split(' ', $possible)) {
1714 1715
				if ($modifier !~ $notPermitted) {
					warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1716
					push(@modifierListFile, $modifier);
1717
				}
1718
			}
1719 1720 1721

		} else {
			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1722
			push(@typeListFile, $possible);
1723
		}
1724
		build_types();
1725 1726
	} else {
		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1727 1728 1729
	}
}

1730 1731
my $prefix = '';

1732
sub show_type {
1733
	my ($type) = @_;
1734

1735 1736 1737
	return defined $use_type{$type} if (scalar keys %use_type > 0);

	return !defined $ignore_type{$type};
1738 1739
}

1740
sub report {
1741 1742 1743 1744
	my ($level, $type, $msg) = @_;

	if (!show_type($type) ||
	    (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1745 1746
		return 0;
	}
1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757
	my $output = '';
	if (-t STDOUT && $color) {
		if ($level eq 'ERROR') {
			$output .= RED;
		} elsif ($level eq 'WARNING') {
			$output .= YELLOW;
		} else {
			$output .= GREEN;
		}
	}
	$output .= $prefix . $level . ':';
1758
	if ($show_types) {
1759 1760
		$output .= BLUE if (-t STDOUT && $color);
		$output .= "$type:";
1761
	}
1762 1763
	$output .= RESET if (-t STDOUT && $color);
	$output .= ' ' . $msg . "\n";
1764 1765 1766 1767 1768 1769

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

1772
	push(our @report, $output);
1773 1774

	return 1;
1775
}
1776

1777
sub report_dump {
1778
	our @report;
1779
}
1780

1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812
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
1813
		if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) {	#new filename
1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843
			$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;
}

1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864
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);
}

1865
sub ERROR {
1866 1867 1868
	my ($type, $msg) = @_;

	if (report("ERROR", $type, $msg)) {
1869 1870
		our $clean = 0;
		our $cnt_error++;
1871
		return 1;
1872
	}
1873
	return 0;
1874 1875
}
sub WARN {
1876 1877 1878
	my ($type, $msg) = @_;

	if (report("WARNING", $type, $msg)) {
1879 1880
		our $clean = 0;
		our $cnt_warn++;
1881
		return 1;
1882
	}
1883
	return 0;
1884 1885
}
sub CHK {
1886 1887 1888
	my ($type, $msg) = @_;

	if ($check && report("CHECK", $type, $msg)) {
1889 1890
		our $clean = 0;
		our $cnt_chk++;
1891
		return 1;
1892
	}
1893
	return 0;
1894 1895
}

1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918
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 ".../") {
1919 1920
		WARN("USE_RELATIVE_PATH",
		     "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1921 1922 1923
	}
}

1924 1925 1926
sub trim {
	my ($string) = @_;

1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943
	$string =~ s/^\s+|\s+$//g;

	return $string;
}

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

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

	return $string;
}

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

	$string =~ s/\s+$//;
1944 1945 1946 1947

	return $string;
}

1948 1949 1950 1951 1952 1953 1954 1955
sub string_find_replace {
	my ($string, $find, $replace) = @_;

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

	return $string;
}

1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970
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";
}

1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997
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;
		}
	}

1998
	return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
1999 2000
}

2001 2002 2003 2004 2005
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
2006
	my $prevrawline="";
2007
	my $stashline="";
2008
	my $stashrawline="";
2009

2010
	my $length;
2011 2012 2013 2014
	my $indent;
	my $previndent=0;
	my $stashindent=0;

2015
	our $clean = 1;
2016 2017
	my $signoff = 0;
	my $is_patch = 0;
2018
	my $in_header_lines = $file ? 0 : 1;
2019
	my $in_commit_log = 0;		#Scanning lines before patch
2020
       my $commit_log_possible_stack_dump = 0;
2021
	my $commit_log_long_line = 0;
2022
	my $commit_log_has_diff = 0;
2023
	my $reported_maintainer_file = 0;
2024 2025
	my $non_utf8_charset = 0;

2026
	my $last_blank_line = 0;
2027
	my $last_coalesced_string_linenr = -1;
2028

2029
	our @report = ();
2030 2031 2032 2033 2034
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

2035 2036 2037 2038 2039 2040
	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
	my $in_comment = 0;
2041
	my $comment_edge = 0;
2042
	my $first_line = 0;
2043
	my $p1_prefix = '';
2044

2045 2046 2047
	my $prev_values = 'E';

	# suppression flags
2048
	my %suppress_ifbraces;
2049
	my %suppress_whiletrailers;
2050
	my %suppress_export;
2051
	my $suppress_statement = 0;
2052

2053
	my %signatures = ();
2054

2055
	# Pre-scan the patch sanitizing the lines.
2056
	# Pre-scan the patch looking for any __setup documentation.
2057
	#
2058 2059
	my @setup_docs = ();
	my $setup_docs = 0;
2060

2061 2062
	my $camelcase_file_seeded = 0;

2063
	sanitise_line_reset();
2064 2065
	my $line;
	foreach my $rawline (@rawlines) {
2066 2067
		$linenr++;
		$line = $rawline;
2068

2069 2070
		push(@fixed, $rawline) if ($fix);

2071
		if ($rawline=~/^\+\+\+\s+(\S+)/) {
2072 2073 2074 2075
			$setup_docs = 0;
			if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
				$setup_docs = 1;
			}
2076 2077 2078 2079 2080 2081 2082 2083 2084
			#next;
		}
		if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
2085
			$in_comment = 0;
2086 2087 2088 2089 2090 2091

			# 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;
2092 2093 2094 2095 2096 2097
			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";
2098
				last if (!defined $rawlines[$ln - 1]);
2099 2100 2101 2102 2103
				if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
				    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
					($edge) = $1;
					last;
				}
2104 2105 2106 2107 2108 2109 2110 2111 2112
			}
			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 &&
2113
			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
2114 2115 2116 2117 2118 2119 2120
			{
				$in_comment = 1;
			}

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

2121
		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2122
			# Standardise the strings and chars within the input to
2123
			# simplify matching -- only bother with positive lines.
2124
			$line = sanitise_line($rawline);
2125
		}
2126 2127 2128 2129 2130 2131 2132 2133 2134 2135
		push(@lines, $line);

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

		#print "==>$rawline\n";
		#print "-->$line\n";
2136 2137 2138 2139 2140 2141

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

2142 2143
	$prefix = '';

2144 2145
	$realcnt = 0;
	$linenr = 0;
2146
	$fixlinenr = -1;
2147 2148
	foreach my $line (@lines) {
		$linenr++;
2149
		$fixlinenr++;
2150 2151
		my $sline = $line;	#copy of $line
		$sline =~ s/$;/ /g;	#with comments as spaces
2152

2153
		my $rawline = $rawlines[$linenr - 1];
2154

2155
#extract the line range in the file after the patch is applied
2156 2157
		if (!$in_commit_log &&
		    $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2158
			$is_patch = 1;
2159
			$first_line = $linenr + 1;
2160 2161 2162 2163 2164 2165
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
2166
			annotate_reset();
2167 2168
			$prev_values = 'E';

2169
			%suppress_ifbraces = ();
2170
			%suppress_whiletrailers = ();
2171
			%suppress_export = ();
2172
			$suppress_statement = 0;
2173 2174
			next;

2175 2176 2177
# 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.
2178
		} elsif ($line =~ /^( |\+|$)/) {
2179
			$realline++;
2180
			$realcnt-- if ($realcnt != 0);
2181

2182
			# Measure the line length and indent.
2183
			($length, $indent) = line_stats($rawline);
2184 2185 2186 2187

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

2190
			#warn "line<$line>\n";
2191

2192 2193
		} elsif ($realcnt == 1) {
			$realcnt--;
2194 2195
		}

2196 2197
		my $hunk_line = ($realcnt != 0);

2198 2199
		$here = "#$linenr: " if (!$file);
		$here = "#$realline: " if ($file);
2200

2201
		my $found_file = 0;
2202
		# extract the filename as it passes
2203 2204
		if ($line =~ /^diff --git.*?(\S+)$/) {
			$realfile = $1;
2205
			$realfile =~ s@^([^/]*)/@@ if (!$file);
2206
			$in_commit_log = 0;
2207
			$found_file = 1;
2208
		} elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2209
			$realfile = $1;
2210
			$realfile =~ s@^([^/]*)/@@ if (!$file);
2211
			$in_commit_log = 0;
2212 2213

			$p1_prefix = $1;
2214 2215
			if (!$file && $tree && $p1_prefix ne '' &&
			    -e "$root/$p1_prefix") {
2216 2217
				WARN("PATCH_PREFIX",
				     "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2218
			}
2219

2220
			if ($realfile =~ m@^include/asm/@) {
2221 2222
				ERROR("MODIFIED_INCLUDE_ASM",
				      "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2223
			}
2224 2225 2226
			$found_file = 1;
		}

2227 2228 2229 2230
#make up the handle for any error we report on this line
		if ($showfile) {
			$prefix = "$realfile:$realline: "
		} elsif ($emacs) {
2231 2232 2233 2234 2235
			if ($file) {
				$prefix = "$filename:$realline: ";
			} else {
				$prefix = "$filename:$linenr: ";
			}
2236 2237
		}

2238
		if ($found_file) {
2239
			if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
2240 2241 2242 2243
				$check = 1;
			} else {
				$check = $check_orig;
			}
2244 2245 2246
			next;
		}

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

2249 2250 2251
		my $hereline = "$here\n$rawline\n";
		my $herecurr = "$here\n$rawline\n";
		my $hereprev = "$here\n$prevrawline\n$rawline\n";
2252

2253 2254
		$cnt_lines++ if ($realcnt != 0);

2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265
# Check if the commit log has what seems like a diff which can confuse patch
		if ($in_commit_log && !$commit_log_has_diff &&
		    (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
		      $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
		     $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
		     $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
			ERROR("DIFF_IN_COMMIT_MSG",
			      "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
			$commit_log_has_diff = 1;
		}

2266 2267 2268
# Check for incorrect file permissions
		if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
			my $permhere = $here . "FILE: $realfile\n";
2269 2270
			if ($realfile !~ m@scripts/@ &&
			    $realfile !~ /\.(py|pl|awk|sh)$/) {
2271 2272
				ERROR("EXECUTE_PERMISSIONS",
				      "do not set execute permissions for source files\n" . $permhere);
2273 2274 2275
			}
		}

2276
# Check the patch for a signoff:
2277
		if ($line =~ /^\s*signed-off-by:/i) {
2278
			$signoff++;
2279
			$in_commit_log = 0;
2280 2281
		}

2282 2283 2284 2285 2286 2287
# 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;
		}

2288
# Check signature styles
2289
		if (!$in_header_lines &&
2290
		    $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2291 2292 2293 2294 2295 2296
			my $space_before = $1;
			my $sign_off = $2;
			my $space_after = $3;
			my $email = $4;
			my $ucfirst_sign_off = ucfirst(lc($sign_off));

2297 2298 2299 2300
			if ($sign_off !~ /$signature_tags/) {
				WARN("BAD_SIGN_OFF",
				     "Non-standard signature: $sign_off\n" . $herecurr);
			}
2301
			if (defined $space_before && $space_before ne "") {
2302 2303 2304
				if (WARN("BAD_SIGN_OFF",
					 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
				    $fix) {
2305
					$fixed[$fixlinenr] =
2306 2307
					    "$ucfirst_sign_off $email";
				}
2308 2309
			}
			if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2310 2311 2312
				if (WARN("BAD_SIGN_OFF",
					 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
				    $fix) {
2313
					$fixed[$fixlinenr] =
2314 2315 2316
					    "$ucfirst_sign_off $email";
				}

2317 2318
			}
			if (!defined $space_after || $space_after ne " ") {
2319 2320 2321
				if (WARN("BAD_SIGN_OFF",
					 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
				    $fix) {
2322
					$fixed[$fixlinenr] =
2323 2324
					    "$ucfirst_sign_off $email";
				}
2325
			}
2326 2327 2328 2329

			my ($email_name, $email_address, $comment) = parse_email($email);
			my $suggested_email = format_email(($email_name, $email_address));
			if ($suggested_email eq "") {
2330 2331
				ERROR("BAD_SIGN_OFF",
				      "Unrecognized email address: '$email'\n" . $herecurr);
2332 2333 2334 2335 2336 2337 2338 2339 2340
			} 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) {
2341 2342
					WARN("BAD_SIGN_OFF",
					     "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2343
				}
2344
			}
2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355

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

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

2365 2366 2367 2368 2369 2370
# 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);
		}

2371 2372 2373 2374 2375 2376
# 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);
		}

2377 2378 2379 2380 2381 2382 2383 2384 2385 2386
# Check if the commit log is in a possible stack dump
		if ($in_commit_log && !$commit_log_possible_stack_dump &&
		    ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
		     $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
					# timestamp
		     $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
					# stack dump address
			$commit_log_possible_stack_dump = 1;
		}

2387 2388
# Check for line lengths > 75 in commit log, warn once
		if ($in_commit_log && !$commit_log_long_line &&
2389 2390 2391 2392 2393 2394 2395 2396
		    length($line) > 75 &&
		    !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
					# file delta changes
		      $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
					# filename then :
		      $line =~ /^\s*(?:Fixes:|Link:)/i ||
					# A Fixes: or Link: line
		      $commit_log_possible_stack_dump)) {
2397 2398 2399 2400 2401
			WARN("COMMIT_LOG_LONG_LINE",
			     "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
			$commit_log_long_line = 1;
		}

2402
# Reset possible stack dump if a blank line is found
2403 2404 2405 2406
		if ($in_commit_log && $commit_log_possible_stack_dump &&
		    $line =~ /^\s*$/) {
			$commit_log_possible_stack_dump = 0;
		}
2407

2408
# Check for git id commit length and improperly formed commit descriptions
2409
		if ($in_commit_log && !$commit_log_possible_stack_dump &&
2410
		    ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
2411 2412 2413
		     ($line =~ /\b[0-9a-f]{12,40}\b/i &&
		      $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
		      $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
2414 2415
			my $init_char = "c";
			my $orig_commit = "";
2416 2417 2418 2419 2420
			my $short = 1;
			my $long = 0;
			my $case = 1;
			my $space = 1;
			my $hasdesc = 0;
2421
			my $hasparens = 0;
2422 2423 2424 2425
			my $id = '0123456789ab';
			my $orig_desc = "commit description";
			my $description = "";

2426 2427 2428 2429 2430 2431 2432
			if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
				$init_char = $1;
				$orig_commit = lc($2);
			} elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
				$orig_commit = lc($1);
			}

2433 2434 2435 2436 2437 2438
			$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;
2439
				$hasparens = 1;
2440 2441 2442 2443
			} elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
				 defined $rawlines[$linenr] &&
				 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
				$orig_desc = $1;
2444
				$hasparens = 1;
2445 2446 2447 2448 2449 2450 2451
			} 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;
2452
				$hasparens = 1;
2453 2454 2455 2456 2457
			}

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

2458
			if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
2459 2460 2461
				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);
			}
2462 2463
		}

2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474
# 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);
		}

2475
# Check for wrappage within a valid hunk of the file
2476
		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2477 2478
			ERROR("CORRUPTED_PATCH",
			      "patch seems to be corrupt (line wrapped?)\n" .
2479
				$herecurr) if (!$emitted_corrupt++);
2480 2481
		}

2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495
# 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);
				}
			}
		}

2496 2497
# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2498 2499 2500 2501 2502 2503 2504
		    $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";

2505 2506
			CHK("INVALID_UTF8",
			    "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2507 2508
		}

2509 2510 2511
# 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 =~ /^$/ &&
2512 2513
		    !($rawline =~ /^\s+\S/ ||
		      $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
2514 2515 2516 2517
			$in_header_lines = 0;
			$in_commit_log = 1;
		}

2518 2519 2520 2521 2522 2523 2524 2525 2526
# 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 =~ /^$/ &&
2527
		    $rawline =~ /$NON_ASCII_UTF8/) {
2528
			WARN("UTF8_BEFORE_PATCH",
2529 2530 2531
			    "8-bit UTF-8 used in possible commit log\n" . $herecurr);
		}

2532
# Check for various typo / spelling mistakes
2533 2534
		if (defined($misspellings) &&
		    ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
2535
			while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549
				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/;
				}
			}
		}

2550 2551
# ignore non-hunk lines and lines being removed
		next if (!$hunk_line || $line =~ /^-/);
2552 2553

#trailing whitespace
2554
		if ($line =~ /^\+.*\015/) {
2555
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2556 2557 2558
			if (ERROR("DOS_LINE_ENDINGS",
				  "DOS line endings\n" . $herevet) &&
			    $fix) {
2559
				$fixed[$fixlinenr] =~ s/[\s\015]+$//;
2560
			}
2561 2562
		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2563 2564 2565
			if (ERROR("TRAILING_WHITESPACE",
				  "trailing whitespace\n" . $herevet) &&
			    $fix) {
2566
				$fixed[$fixlinenr] =~ s/\s+$//;
2567 2568
			}

2569
			$rpt_cleaners = 1;
2570
		}
2571

2572
# Check for FSF mailing addresses.
2573
		if ($rawline =~ /\bwrite to the Free/i ||
2574 2575
		    $rawline =~ /\b59\s+Temple\s+Pl/i ||
		    $rawline =~ /\b51\s+Franklin\s+St/i) {
2576 2577 2578 2579
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
			my $msg_type = \&ERROR;
			$msg_type = \&CHK if ($file);
			&{$msg_type}("FSF_MAILING_ADDRESS",
2580
				     "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)
2581 2582
		}

2583
# check for Kconfig help text having a real description
2584 2585
# Only applies when adding the entry originally, after that we do not have
# sufficient context to determine whether it is indeed long enough.
2586
		if ($realfile =~ /Kconfig/ &&
2587
		    $line =~ /^\+\s*config\s+/) {
2588
			my $length = 0;
2589 2590 2591
			my $cnt = $realcnt;
			my $ln = $linenr + 1;
			my $f;
2592
			my $is_start = 0;
2593
			my $is_end = 0;
2594
			for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2595 2596 2597 2598 2599
				$f = $lines[$ln - 1];
				$cnt-- if ($lines[$ln - 1] !~ /^-/);
				$is_end = $lines[$ln - 1] =~ /^\+/;

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

2602
				if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
2603
					$is_start = 1;
2604
				} elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
2605 2606 2607
					$length = -1;
				}

2608
				$f =~ s/^.//;
2609 2610 2611
				$f =~ s/#.*//;
				$f =~ s/^\s+//;
				next if ($f =~ /^$/);
2612 2613 2614 2615
				if ($f =~ /^\s*config\s/) {
					$is_end = 1;
					last;
				}
2616 2617
				$length++;
			}
2618 2619 2620 2621
			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);
			}
2622
			#print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2623 2624
		}

2625 2626 2627 2628 2629 2630 2631
# 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");
		}

2632 2633 2634 2635 2636 2637 2638
# 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);
		}

2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652
		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});
		}

2653
# check for DT compatible documentation
2654 2655 2656 2657
		if (defined $root &&
			(($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
			 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {

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

2660 2661 2662
			my $dt_path = $root . "/Documentation/devicetree/bindings/";
			my $vp_file = $dt_path . "vendor-prefixes.txt";

2663 2664
			foreach my $compat (@compats) {
				my $compat2 = $compat;
2665 2666 2667 2668
				$compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
				my $compat3 = $compat;
				$compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
				`grep -Erq "$compat|$compat2|$compat3" $dt_path`;
2669 2670 2671 2672 2673
				if ( $? >> 8 ) {
					WARN("UNDOCUMENTED_DT_STRING",
					     "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
				}

2674 2675
				next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
				my $vendor = $1;
2676
				`grep -Eq "^$vendor\\b" $vp_file`;
2677 2678
				if ( $? >> 8 ) {
					WARN("UNDOCUMENTED_DT_STRING",
2679
					     "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2680 2681 2682 2683
				}
			}
		}

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

2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701
# line length limit (with some exclusions)
#
# There are a few types of lines that may extend beyond $max_line_length:
#	logging functions like pr_info that end in a string
#	lines with a single string
#	#defines that are a single string
#
# There are 3 different line length message types:
# LONG_LINE_COMMENT	a comment starts before but extends beyond $max_linelength
# LONG_LINE_STRING	a string starts before but extends beyond $max_line_length
# LONG_LINE		all other lines longer than $max_line_length
#
# if LONG_LINE is ignored, the other 2 types are also ignored
#

2702
		if ($line =~ /^\+/ && $length > $max_line_length) {
2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736
			my $msg_type = "LONG_LINE";

			# Check the allowed long line types first

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

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

			# Otherwise set the alternate message types

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

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

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

2739 2740
# check for adding lines without a newline.
		if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2741 2742
			WARN("MISSING_EOF_NEWLINE",
			     "adding a line without newline at end of file\n" . $herecurr);
2743 2744
		}

2745 2746 2747 2748
# 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";
2749 2750
				ERROR("LO_MACRO",
				      "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2751 2752 2753
			}
			if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
				my $herevet = "$here\n" . cat_vet($line) . "\n";
2754 2755
				ERROR("HI_MACRO",
				      "use the HI() macro, not (... >> 16)\n" . $herevet);
2756 2757 2758
			}
		}

2759
# check we are in a valid source file C or perl if not then ignore this hunk
2760
		next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
2761 2762 2763

# at the beginning of a line any tabs must come first and anything
# more than 8 must use tabs.
2764 2765 2766
		if ($rawline =~ /^\+\s* \t\s*\S/ ||
		    $rawline =~ /^\+\s*        \s*/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2767
			$rpt_cleaners = 1;
2768 2769 2770
			if (ERROR("CODE_INDENT",
				  "code indent should use tabs where possible\n" . $herevet) &&
			    $fix) {
2771
				$fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2772
			}
2773 2774
		}

2775 2776 2777
# check for space before tabs.
		if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2778 2779 2780
			if (WARN("SPACE_BEFORE_TAB",
				"please, no space before tabs\n" . $herevet) &&
			    $fix) {
2781
				while ($fixed[$fixlinenr] =~
2782
					   s/(^\+.*) {8,8}\t/$1\t\t/) {}
2783
				while ($fixed[$fixlinenr] =~
2784
					   s/(^\+.*) +\t/$1\t/) {}
2785
			}
2786 2787
		}

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

2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806
# check indentation starts on a tab stop
		if ($^V && $^V ge 5.10.0 &&
		    $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) {
			my $indent = length($1);
			if ($indent % 8) {
				if (WARN("TABSTOP",
					 "Statements should start on a tabstop\n" . $herecurr) &&
				    $fix) {
					$fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
				}
			}
		}

2807 2808
# check multi-line statement indentation matches previous line
		if ($^V && $^V ge 5.10.0 &&
2809
		    $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2810 2811 2812 2813 2814 2815
			$prevline =~ /^\+(\t*)(.*)$/;
			my $oldindent = $1;
			my $rest = $2;

			my $pos = pos_last_openparen($rest);
			if ($pos >= 0) {
J
Joe Perches 已提交
2816 2817
				$line =~ /^(\+| )([ \t]*)/;
				my $newindent = $2;
2818 2819 2820 2821 2822 2823 2824 2825

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

				if ($newindent ne $goodtabindent &&
				    $newindent ne $goodspaceindent) {
2826 2827 2828 2829

					if (CHK("PARENTHESIS_ALIGNMENT",
						"Alignment should match open parenthesis\n" . $hereprev) &&
					    $fix && $line =~ /^\+/) {
2830
						$fixed[$fixlinenr] =~
2831 2832
						    s/^\+[ \t]*/\+$goodtabindent/;
					}
2833 2834 2835 2836
				}
			}
		}

2837 2838 2839 2840 2841 2842 2843 2844 2845
# 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*$/)) {
2846
			if (CHK("SPACING",
2847
				"No space is necessary after a cast\n" . $herecurr) &&
2848
			    $fix) {
2849
				$fixed[$fixlinenr] =~
2850
				    s/(\(\s*$Type\s*\))[ \t]+/$1/;
2851
			}
2852 2853
		}

2854 2855
# Block comment styles
# Networking with an initial /*
2856
		if ($realfile =~ m@^(drivers/net/|net/)@ &&
2857
		    $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2858 2859
		    $rawline =~ /^\+[ \t]*\*/ &&
		    $realline > 2) {
2860 2861 2862 2863
			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
			     "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
		}

2864 2865 2866
# Block comments use * on subsequent lines
		if ($prevline =~ /$;[ \t]*$/ &&			#ends in comment
		    $prevrawline =~ /^\+.*?\/\*/ &&		#starting /*
2867
		    $prevrawline !~ /\*\/[ \t]*$/ &&		#no trailing */
2868
		    $rawline =~ /^\+/ &&			#line is new
2869
		    $rawline !~ /^\+[ \t]*\*/) {		#no leading *
2870 2871
			WARN("BLOCK_COMMENT_STYLE",
			     "Block comments use * on subsequent lines\n" . $hereprev);
2872 2873
		}

2874 2875
# Block comments use */ on trailing lines
		if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ &&	#trailing */
2876 2877 2878
		    $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ &&	#inline /*...*/
		    $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ &&	#trailing **/
		    $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) {	#non blank */
2879 2880
			WARN("BLOCK_COMMENT_STYLE",
			     "Block comments use a trailing */ on a separate line\n" . $herecurr);
2881 2882
		}

2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894
# 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/)) {
2895 2896 2897
			if (CHK("LINE_SPACING",
				"Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
			    $fix) {
2898
				fix_insert_line($fixlinenr, "\+");
2899
			}
2900 2901
		}

2902 2903 2904 2905
# check for multiple consecutive blank lines
		if ($prevline =~ /^[\+ ]\s*$/ &&
		    $line =~ /^\+\s*$/ &&
		    $last_blank_line != ($linenr - 1)) {
2906 2907 2908
			if (CHK("LINE_SPACING",
				"Please don't use multiple blank lines\n" . $hereprev) &&
			    $fix) {
2909
				fix_delete_line($fixlinenr, $rawline);
2910 2911
			}

2912 2913 2914
			$last_blank_line = $linenr;
		}

2915
# check for missing blank lines after declarations
2916 2917 2918
		if ($sline =~ /^\+\s+\S/ &&			#Not at char 1
			# actual declarations
		    ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2919 2920
			# function pointer declarations
		     $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932
			# 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*[=,;:\[]/ ||
2933 2934
			# function pointer declarations
		      $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2935 2936 2937 2938 2939
			# 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
2940
		      $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
2941 2942 2943 2944 2945 2946 2947 2948
			# 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/)) {
2949 2950 2951
			if (WARN("LINE_SPACING",
				 "Missing a blank line after declarations\n" . $hereprev) &&
			    $fix) {
2952
				fix_insert_line($fixlinenr, "\+");
2953
			}
2954 2955
		}

2956
# check for spaces at the beginning of a line.
2957 2958 2959 2960
# Exceptions:
#  1) within comments
#  2) indented preprocessor commands
#  3) hanging labels
2961
		if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/)  {
2962
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2963 2964 2965
			if (WARN("LEADING_SPACE",
				 "please, no spaces at the start of a line\n" . $herevet) &&
			    $fix) {
2966
				$fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2967
			}
2968 2969
		}

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

2973
# check indentation of any line with a bare else
2974
# (but not if it is a multiple line "if (foo) return bar; else return baz;")
2975 2976 2977
# 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;
2978 2979 2980 2981
			if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
			    ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
			     defined $lines[$linenr] &&
			     $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
2982 2983 2984 2985 2986
				WARN("UNNECESSARY_ELSE",
				     "else is not generally useful after a break or return\n" . $hereprev);
			}
		}

2987 2988 2989 2990 2991 2992 2993 2994 2995 2996
# 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);
			}
		}

2997 2998 2999 3000 3001 3002
# 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");
		}

3003
# check for RCS/CVS revision markers
3004
		if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
3005 3006
			WARN("CVS_KEYWORD",
			     "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
3007
		}
3008

3009 3010 3011
# Blackfin: don't use __builtin_bfin_[cs]sync
		if ($line =~ /__builtin_bfin_csync/) {
			my $herevet = "$here\n" . cat_vet($line) . "\n";
3012 3013
			ERROR("CSYNC",
			      "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
3014 3015 3016
		}
		if ($line =~ /__builtin_bfin_ssync/) {
			my $herevet = "$here\n" . cat_vet($line) . "\n";
3017 3018
			ERROR("SSYNC",
			      "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
3019 3020
		}

3021 3022 3023 3024 3025 3026
# 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);
		}

3027
# Check for potential 'bare' types
3028 3029
		my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
		    $realline_next);
3030 3031
#print "LINE<$line>\n";
		if ($linenr >= $suppress_statement &&
3032
		    $realcnt && $sline =~ /.\s*\S/) {
3033
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3034
				ctx_statement_block($linenr, $realcnt, 0);
3035 3036 3037
			$stat =~ s/\n./\n /g;
			$cond =~ s/\n./\n /g;

3038 3039 3040 3041 3042 3043 3044 3045 3046
#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;
			}
3047

3048 3049 3050 3051 3052 3053 3054 3055
			# 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++;
			}

3056 3057
			my $s = $stat;
			$s =~ s/{.*$//s;
3058

3059
			# Ignore goto labels.
3060
			if ($s =~ /$Ident:\*$/s) {
3061 3062

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

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

3067
			# declarations always start with types
3068
			} 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) {
3069 3070 3071 3072
				my $type = $1;
				$type =~ s/\s+/ /g;
				possible($type, "A:" . $s);

3073
			# definitions in global scope can only start with types
3074
			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
3075
				possible($1, "B:" . $s);
3076
			}
3077 3078

			# any (foo ... *) is a pointer cast, and foo is a type
3079
			while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
3080
				possible($1, "C:" . $s);
3081 3082 3083 3084 3085
			}

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

3089
				my $ctx = $s;
3090
				substr($ctx, 0, $name_len + 1, '');
3091
				$ctx =~ s/\)[^\)]*$//;
3092

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

3096
						possible($1, "D:" . $s);
3097 3098
					}
				}
3099
			}
3100

3101 3102
		}

3103 3104 3105
#
# Checks which may be anchored in the context.
#
3106

3107 3108
# Check for switch () and associated case and default
# statements should be at the same indent.
3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124
		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 '') {
3125 3126
				ERROR("SWITCH_CASE_INDENT_LEVEL",
				      "switch and case should be at the same indent\n$hereline$err");
3127 3128 3129 3130 3131
			}
		}

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

3135
			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
3136 3137 3138 3139 3140 3141

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

3142 3143 3144
			my $ctx_cnt = $realcnt - $#ctx - 1;
			my $ctx = join("\n", @ctx);

3145 3146
			my $ctx_ln = $linenr;
			my $ctx_skip = $realcnt;
3147

3148 3149 3150 3151 3152
			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] !~ /^-/);
3153 3154
				$ctx_ln++;
			}
3155

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

3159
			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
3160 3161
				ERROR("OPEN_BRACE",
				      "that open brace { should be on the previous line\n" .
3162
					"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3163
			}
3164 3165 3166 3167
			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
			    $ctx =~ /\)\s*\;\s*$/ &&
			    defined $lines[$ctx_ln - 1])
			{
3168 3169
				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
				if ($nindent > $indent) {
3170 3171
					WARN("TRAILING_SEMICOLON",
					     "trailing semicolon indicates no statements, indent implies otherwise\n" .
3172
						"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3173 3174
				}
			}
3175 3176
		}

3177
# Check relative indent for conditionals and blocks.
3178
		if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3179 3180 3181
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
3182 3183 3184 3185
			my ($s, $c) = ($stat, $cond);

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

3186 3187 3188
			# remove inline comments
			$s =~ s/$;/ /g;
			$c =~ s/$;/ /g;
3189 3190

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

3194 3195 3196 3197 3198 3199 3200 3201
			# Make sure we remove the line prefixes as we have
			# none on the first line, and are going to readd them
			# where necessary.
			$s =~ s/\n./\n/gs;
			while ($s =~ /\n\s+\\\n/) {
				$cond_lines += $s =~ s/\n\s+\\\n/\n/g;
			}

3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213
			# 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;
			}
3214
			if ($s =~ s/^\s*?\n//) {
3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225
				$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;
			}

3226
			my $cond_ptr = -1;
3227
			$continuation = 0;
3228 3229 3230
			while ($cond_ptr != $cond_lines) {
				$cond_ptr = $cond_lines;

3231 3232 3233 3234 3235 3236
				# If we see an #else/#elif then the code
				# is not linear.
				if ($s =~ /^\s*\#\s*(?:else|elif)/) {
					$check = 0;
				}

3237 3238 3239 3240
				# Ignore:
				#  1) blank lines, they should be at 0,
				#  2) preprocessor lines, and
				#  3) labels.
3241 3242
				if ($continuation ||
				    $s =~ /^\s*?\n/ ||
3243 3244
				    $s =~ /^\s*#\s*?/ ||
				    $s =~ /^\s*$Ident\s*:/) {
3245
					$continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
3246 3247 3248
					if ($s =~ s/^.*?\n//) {
						$cond_lines++;
					}
3249
				}
3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264
			}

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

3265
			#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";
3266

3267 3268 3269 3270
			if ($check && $s ne '' &&
			    (($sindent % 8) != 0 ||
			     ($sindent < $indent) ||
			     ($sindent > $indent + 8))) {
3271 3272
				WARN("SUSPECT_CODE_INDENT",
				     "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3273 3274 3275
			}
		}

3276 3277
		# Track the 'values' across context and added lines.
		my $opline = $line; $opline =~ s/^./ /;
3278 3279
		my ($curr_values, $curr_vars) =
				annotate_values($opline . "\n", $prev_values);
3280
		$curr_values = $prev_values . $curr_values;
3281 3282
		if ($dbg_values) {
			my $outline = $opline; $outline =~ s/\t/ /g;
3283 3284
			print "$linenr > .$outline\n";
			print "$linenr > $curr_values\n";
3285
			print "$linenr >  $curr_vars\n";
3286
		}
3287 3288
		$prev_values = substr($curr_values, -1);

3289
#ignore lines not being added
3290
		next if ($line =~ /^[^\+]/);
3291

3292
# check for declarations of signed or unsigned without int
3293
		while ($line =~ m{($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3294 3295
			my $type = $1;
			my $var = $2;
3296 3297
			$var = "" if (!defined $var);
			if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
3298 3299 3300 3301 3302 3303 3304 3305 3306
				my $sign = $1;
				my $pointer = $2;

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

				if (WARN("UNSPECIFIED_INT",
					 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
				    $fix) {
					my $decl = trim($sign) . " int ";
3307 3308 3309 3310 3311
					my $comp_pointer = $pointer;
					$comp_pointer =~ s/\s//g;
					$decl .= $comp_pointer;
					$decl = rtrim($decl) if ($var eq "");
					$fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
3312 3313 3314 3315
				}
			}
		}

3316
# TEST: allow direct testing of the type matcher.
3317 3318
		if ($dbg_type) {
			if ($line =~ /^.\s*$Declare\s*$/) {
3319 3320
				ERROR("TEST_TYPE",
				      "TEST: is type\n" . $herecurr);
3321
			} elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3322 3323
				ERROR("TEST_NOT_TYPE",
				      "TEST: is not type ($1 is)\n". $herecurr);
3324
			}
3325 3326
			next;
		}
3327 3328
# TEST: allow direct testing of the attribute matcher.
		if ($dbg_attr) {
3329
			if ($line =~ /^.\s*$Modifier\s*$/) {
3330 3331
				ERROR("TEST_ATTR",
				      "TEST: is attr\n" . $herecurr);
3332
			} elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3333 3334
				ERROR("TEST_NOT_ATTR",
				      "TEST: is not attr ($1 is)\n". $herecurr);
3335 3336 3337
			}
			next;
		}
3338

3339
# check for initialisation to aggregates open brace on the next line
3340 3341
		if ($line =~ /^.\s*{/ &&
		    $prevline =~ /(?:^|[^=])=\s*$/) {
3342 3343
			if (ERROR("OPEN_BRACE",
				  "that open brace { should be on the previous line\n" . $hereprev) &&
3344 3345 3346
			    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
				fix_delete_line($fixlinenr - 1, $prevrawline);
				fix_delete_line($fixlinenr, $rawline);
3347 3348
				my $fixedline = $prevrawline;
				$fixedline =~ s/\s*=\s*$/ = {/;
3349
				fix_insert_line($fixlinenr, $fixedline);
3350 3351
				$fixedline = $line;
				$fixedline =~ s/^(.\s*){\s*/$1/;
3352
				fix_insert_line($fixlinenr, $fixedline);
3353
			}
3354 3355
		}

3356 3357 3358 3359 3360
#
# Checks which are anchored on the added line.
#

# check for malformed paths in #include statements (uses RAW line)
3361
		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3362 3363
			my $path = $1;
			if ($path =~ m{//}) {
3364
				ERROR("MALFORMED_INCLUDE",
3365 3366 3367 3368 3369
				      "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);
3370 3371
			}
		}
3372

3373
# no C99 // comments
3374
		if ($line =~ m{//}) {
3375 3376 3377
			if (ERROR("C99_COMMENTS",
				  "do not use C99 // comments\n" . $herecurr) &&
			    $fix) {
3378
				my $line = $fixed[$fixlinenr];
3379 3380
				if ($line =~ /\/\/(.*)$/) {
					my $comment = trim($1);
3381
					$fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3382 3383
				}
			}
3384
		}
3385
		# Remove C99 comments.
3386
		$line =~ s@//.*@@;
3387
		$opline =~ s@//.*@@;
3388

3389 3390 3391 3392 3393 3394 3395 3396
# 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.*\((.*)\)/)) {
3397 3398 3399 3400
			# Handle definitions which produce identifiers with
			# a prefix:
			#   XXX(foo);
			#   EXPORT_SYMBOL(something_foo);
3401
			my $name = $1;
3402
			if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3403 3404 3405 3406 3407
			    $name =~ /^${Ident}_$2/) {
#print "FOO C name<$name>\n";
				$suppress_export{$realline_next} = 1;

			} elsif ($stat !~ /(?:
3408
				\n.}\s*$|
3409 3410 3411
				^.DEFINE_$Ident\(\Q$name\E\)|
				^.DECLARE_$Ident\(\Q$name\E\)|
				^.LIST_HEAD\(\Q$name\E\)|
3412 3413
				^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
				\b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
3414
			    )/x) {
3415 3416 3417 3418
#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
				$suppress_export{$realline_next} = 2;
			} else {
				$suppress_export{$realline_next} = 1;
3419 3420
			}
		}
3421 3422 3423 3424 3425 3426 3427 3428 3429
		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) {
3430 3431
			WARN("EXPORT_SYMBOL",
			     "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3432
		}
3433

3434
# check for global initialisers.
3435
		if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
3436
			if (ERROR("GLOBAL_INITIALISERS",
3437
				  "do not initialise globals to $1\n" . $herecurr) &&
3438
			    $fix) {
3439
				$fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
3440
			}
3441
		}
3442
# check for static initialisers.
3443
		if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
3444
			if (ERROR("INITIALISED_STATIC",
3445
				  "do not initialise statics to $1\n" .
3446 3447
				      $herecurr) &&
			    $fix) {
3448
				$fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
3449
			}
3450 3451
		}

3452 3453 3454 3455 3456 3457 3458
# 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);
		}

3459 3460
# check for static const char * arrays.
		if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3461 3462
			WARN("STATIC_CONST_CHAR_ARRAY",
			     "static const char * array should probably be static const char * const\n" .
3463 3464 3465 3466 3467
				$herecurr);
               }

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

3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484
# 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);
			}
		}

3485 3486 3487 3488 3489 3490 3491
# 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);
               }

3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504
# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
		if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
			my $array = $1;
			if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
				my $array_div = $1;
				if (WARN("ARRAY_SIZE",
					 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
				    $fix) {
					$fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
				}
			}
		}

3505 3506 3507 3508 3509
# 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) {
3510
				$fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
3511 3512 3513
			}
		}

3514 3515 3516 3517 3518
# 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) {
3519
				$fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
3520
			}
3521 3522
		}

3523 3524 3525
# check for new typedefs, only function parameters and sparse annotations
# make sense.
		if ($line =~ /\btypedef\s/ &&
3526
		    $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
3527
		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
3528
		    $line !~ /\b$typeTypedefs\b/ &&
3529
		    $line !~ /\b__bitwise(?:__|)\b/) {
3530 3531
			WARN("NEW_TYPEDEFS",
			     "do not add new typedefs\n" . $herecurr);
3532 3533 3534
		}

# * goes on variable not on type
3535
		# (char*[ const])
3536 3537
		while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
			#print "AA<$1>\n";
3538
			my ($ident, $from, $to) = ($1, $2, $2);
3539 3540 3541 3542 3543 3544

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

3548
##			print "1: from<$from> to<$to> ident<$ident>\n";
3549
			if ($from ne $to) {
3550 3551 3552 3553 3554 3555
				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/;
3556
					$fixed[$fixlinenr] =~
3557 3558
					    s@\Q$sub_from\E@$sub_to@;
				}
3559
			}
3560 3561 3562
		}
		while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
			#print "BB<$1>\n";
3563
			my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
3564 3565 3566 3567 3568 3569

			# Should start with a space.
			$to =~ s/^(\S)/ $1/;
			# Should not end with a space.
			$to =~ s/\s+$//;
			# '*'s should not have spaces between.
3570
			while ($to =~ s/\*\s+\*/\*\*/) {
3571 3572 3573
			}
			# Modifiers should have spaces.
			$to =~ s/(\b$Modifier$)/$1 /;
3574

3575
##			print "2: from<$from> to<$to> ident<$ident>\n";
3576
			if ($from ne $to && $ident !~ /^$Modifier$/) {
3577 3578 3579 3580 3581 3582 3583
				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/;
3584
					$fixed[$fixlinenr] =~
3585 3586
					    s@\Q$sub_from\E@$sub_to@;
				}
3587
			}
3588 3589
		}

3590 3591 3592 3593 3594 3595 3596
# avoid BUG() or BUG_ON()
		if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
			my $msg_type = \&WARN;
			$msg_type = \&CHK if ($file);
			&{$msg_type}("AVOID_BUG",
				     "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
		}
3597

3598
# avoid LINUX_VERSION_CODE
3599
		if ($line =~ /\bLINUX_VERSION_CODE\b/) {
3600 3601
			WARN("LINUX_VERSION_CODE",
			     "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3602 3603
		}

3604 3605
# check for uses of printk_ratelimit
		if ($line =~ /\bprintk_ratelimit\s*\(/) {
3606
			WARN("PRINTK_RATELIMITED",
3607
			     "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
3608 3609
		}

3610 3611 3612
# 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 已提交
3613
# printk includes all preceding printk's which have no newline on the end.
3614
# we assume the first bad printk is the one to report.
3615
		if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
3616 3617 3618
			my $ok = 0;
			for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
				#print "CHECK<$lines[$ln - 1]\n";
L
Lucas De Marchi 已提交
3619
				# we have a preceding printk if it ends
3620 3621 3622 3623 3624 3625 3626 3627 3628
				# 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) {
3629 3630
				WARN("PRINTK_WITHOUT_KERN_LEVEL",
				     "printk() should include KERN_ facility level\n" . $herecurr);
3631
			}
3632 3633
		}

3634 3635 3636 3637
		if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
			my $orig = $1;
			my $level = lc($orig);
			$level = "warn" if ($level eq "warning");
3638 3639
			my $level2 = $level;
			$level2 = "dbg" if ($level eq "debug");
3640
			WARN("PREFER_PR_LEVEL",
3641
			     "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(...  to printk(KERN_$orig ...\n" . $herecurr);
3642 3643 3644
		}

		if ($line =~ /\bpr_warning\s*\(/) {
3645 3646 3647
			if (WARN("PREFER_PR_LEVEL",
				 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
			    $fix) {
3648
				$fixed[$fixlinenr] =~
3649 3650
				    s/\bpr_warning\b/pr_warn/;
			}
3651 3652
		}

3653 3654 3655 3656 3657 3658 3659 3660 3661
		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);
		}

3662 3663 3664 3665 3666 3667 3668 3669
# ENOSYS means "bad syscall nr" and nothing else.  This will have a small
# number of false positives, but assembly files are not checked, so at
# least the arch entry code will not trigger this warning.
		if ($line =~ /\bENOSYS\b/) {
			WARN("ENOSYS",
			     "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
		}

3670 3671
# function brace can't be on same line, except for #defines of do while,
# or if closed on same line
3672
		if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
3673
		    !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687
			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));
				}
			}
3688
		}
3689

3690 3691 3692
# 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*$/) {
3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705
			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);
				}
			}
3706 3707
		}

3708
# missing space after union, struct or enum definition
3709 3710 3711 3712
		if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
			if (WARN("SPACING",
				 "missing space after $1 definition\n" . $herecurr) &&
			    $fix) {
3713
				$fixed[$fixlinenr] =~
3714 3715
				    s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
			}
3716 3717
		}

3718 3719 3720
# Function pointer declarations
# check spacing between type, funcptr, and args
# canonical declaration is "type (*funcptr)(args...)"
3721
		if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
3722 3723 3724 3725 3726 3727 3728
			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;

3729 3730 3731 3732 3733 3734 3735 3736 3737
# 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 =~ /^$/) {
3738 3739
				WARN("SPACING",
				     "missing space after return type\n" . $herecurr);
3740
				$post_declare_space = " ";
3741 3742 3743
			}

# unnecessary space "type  (*funcptr)(args...)"
3744 3745 3746 3747 3748 3749 3750 3751 3752
# 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);
#			}
3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782

# 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) {
3783
				$fixed[$fixlinenr] =~
3784
				    s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3785 3786 3787
			}
		}

3788 3789
# check for spacing round square brackets; allowed:
#  1. with a type on the left -- int [] a;
3790 3791
#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
#  3. inside a curly brace -- = { [0...10] = 5 }
3792 3793 3794
		while ($line =~ /(.*?\s)\[/g) {
			my ($where, $prefix) = ($-[1], $1);
			if ($prefix !~ /$Type\s+$/ &&
3795
			    ($where != 0 || $prefix !~ /^.\s+$/) &&
3796
			    $prefix !~ /[{,]\s+$/) {
3797 3798 3799
				if (ERROR("BRACKET_SPACE",
					  "space prohibited before open square bracket '['\n" . $herecurr) &&
				    $fix) {
3800
				    $fixed[$fixlinenr] =~
3801 3802
					s/^(\+.*?)\s+\[/$1\[/;
				}
3803 3804 3805
			}
		}

3806
# check for spaces between functions and their parentheses.
3807
		while ($line =~ /($Ident)\s+\(/g) {
3808
			my $name = $1;
3809 3810
			my $ctx_before = substr($line, 0, $-[1]);
			my $ctx = "$ctx_before$name";
3811 3812

			# Ignore those directives where spaces _are_ permitted.
3813 3814 3815 3816 3817 3818
			if ($name =~ /^(?:
				if|for|while|switch|return|case|
				volatile|__volatile__|
				__attribute__|format|__extension__|
				asm|__asm__)$/x)
			{
3819 3820 3821
			# 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.
3822
			} elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
3823 3824

			# cpp #elif statement condition may start with a (
3825
			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
3826 3827 3828

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

			} else {
3832 3833 3834
				if (WARN("SPACING",
					 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
					     $fix) {
3835
					$fixed[$fixlinenr] =~
3836 3837
					    s/\b$name\s+\(/$name\(/;
				}
3838
			}
3839
		}
3840

3841
# Check operator spacing.
3842
		if (!($line=~/\#\s*include/)) {
3843 3844 3845
			my $fixed_line = "";
			my $line_fixed = 0;

3846 3847 3848 3849
			my $ops = qr{
				<<=|>>=|<=|>=|==|!=|
				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
				=>|->|<<|>>|<|>|=|!|~|
3850
				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
3851
				\?:|\?|:
3852
			}x;
3853
			my @elements = split(/($ops|;)/, $opline);
3854 3855 3856 3857 3858 3859 3860

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

			my @fix_elements = ();
3861
			my $off = 0;
3862

3863 3864 3865 3866 3867 3868 3869
			foreach my $el (@elements) {
				push(@fix_elements, substr($rawline, $off, length($el)));
				$off += length($el);
			}

			$off = 0;

3870
			my $blank = copy_spacing($opline);
3871
			my $last_after = -1;
3872

3873
			for (my $n = 0; $n < $#elements; $n += 2) {
3874 3875 3876 3877 3878

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

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

3879 3880
				$off += length($elements[$n]);

L
Lucas De Marchi 已提交
3881
				# Pick up the preceding and succeeding characters.
3882 3883 3884 3885 3886 3887 3888
				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";

3889 3890 3891
				my $a = '';
				$a = 'V' if ($elements[$n] ne '');
				$a = 'W' if ($elements[$n] =~ /\s$/);
3892
				$a = 'C' if ($elements[$n] =~ /$;$/);
3893 3894
				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
				$a = 'O' if ($elements[$n] eq '');
3895
				$a = 'E' if ($ca =~ /^\s*$/);
3896

3897
				my $op = $elements[$n + 1];
3898 3899

				my $c = '';
3900
				if (defined $elements[$n + 2]) {
3901 3902
					$c = 'V' if ($elements[$n + 2] ne '');
					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
3903
					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
3904 3905
					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
					$c = 'O' if ($elements[$n + 2] eq '');
3906
					$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
3907 3908
				} else {
					$c = 'E';
3909 3910
				}

3911 3912 3913 3914
				my $ctx = "${a}x${c}";

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

3915
				my $ptr = substr($blank, 0, $off) . "^";
3916
				my $hereptr = "$hereline$ptr\n";
3917

3918
				# Pull out the value of this operator.
3919
				my $op_type = substr($curr_values, $off + 1, 1);
3920

3921 3922 3923
				# Get the full operator variant.
				my $opv = $op . substr($curr_vars, $off, 1);

3924 3925
				# Ignore operators passed as parameters.
				if ($op_type ne 'V' &&
3926
				    $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
3927

3928 3929
#				# Ignore comments
#				} elsif ($op =~ /^$;+$/) {
3930

3931
				# ; should have either the end of line or a space or \ after it
3932
				} elsif ($op eq ';') {
3933 3934
					if ($ctx !~ /.x[WEBC]/ &&
					    $cc !~ /^\\/ && $cc !~ /^;/) {
3935 3936
						if (ERROR("SPACING",
							  "space required after that '$op' $at\n" . $hereptr)) {
3937
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3938 3939
							$line_fixed = 1;
						}
3940 3941 3942 3943
					}

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

3945 3946 3947 3948
				#   :   when part of a bitfield
				} elsif ($opv eq ':B') {
					# skip the bitfield test for now

3949 3950
				# No spaces for:
				#   ->
3951
				} elsif ($op eq '->') {
3952
					if ($ctx =~ /Wx.|.xW/) {
3953 3954
						if (ERROR("SPACING",
							  "spaces prohibited around that '$op' $at\n" . $hereptr)) {
3955
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3956 3957 3958
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3959
							$line_fixed = 1;
3960
						}
3961 3962
					}

3963
				# , must not have a space before and must have a space on the right.
3964
				} elsif ($op eq ',') {
3965 3966 3967 3968 3969 3970 3971 3972 3973
					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;
						}
					}
3974
					if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
3975 3976 3977
						if (ERROR("SPACING",
							  "space required after that '$op' $at\n" . $hereptr)) {
							$line_fixed = 1;
3978
							$last_after = $n;
3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989
							$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 .= " ";
3990
						}
3991 3992
					}

3993
				# '*' as part of a type definition -- reported already.
3994
				} elsif ($opv eq '*_') {
3995 3996 3997 3998 3999 4000
					#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 '~' ||
4001
					 $opv eq '*U' || $opv eq '-U' ||
4002
					 $opv eq '&U' || $opv eq '&&U') {
4003
					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
4004 4005
						if (ERROR("SPACING",
							  "space required before that '$op' $at\n" . $hereptr)) {
4006 4007 4008 4009
							if ($n != $last_after + 2) {
								$good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
								$line_fixed = 1;
							}
4010
						}
4011
					}
4012
					if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
4013 4014 4015
						# A unary '*' may be const

					} elsif ($ctx =~ /.xW/) {
4016 4017
						if (ERROR("SPACING",
							  "space prohibited after that '$op' $at\n" . $hereptr)) {
4018
							$good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
4019 4020 4021
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
4022
							$line_fixed = 1;
4023
						}
4024 4025 4026 4027
					}

				# unary ++ and unary -- are allowed no space on one side.
				} elsif ($op eq '++' or $op eq '--') {
4028
					if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
4029 4030
						if (ERROR("SPACING",
							  "space required one side of that '$op' $at\n" . $hereptr)) {
4031
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4032 4033
							$line_fixed = 1;
						}
4034 4035 4036
					}
					if ($ctx =~ /Wx[BE]/ ||
					    ($ctx =~ /Wx./ && $cc =~ /^;/)) {
4037 4038
						if (ERROR("SPACING",
							  "space prohibited before that '$op' $at\n" . $hereptr)) {
4039
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4040 4041
							$line_fixed = 1;
						}
4042
					}
4043
					if ($ctx =~ /ExW/) {
4044 4045
						if (ERROR("SPACING",
							  "space prohibited after that '$op' $at\n" . $hereptr)) {
4046
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4047 4048 4049
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
4050
							$line_fixed = 1;
4051
						}
4052
					}
4053 4054

				# << and >> may either have or not have spaces both sides
4055 4056 4057
				} elsif ($op eq '<<' or $op eq '>>' or
					 $op eq '&' or $op eq '^' or $op eq '|' or
					 $op eq '+' or $op eq '-' or
4058 4059
					 $op eq '*' or $op eq '/' or
					 $op eq '%')
4060
				{
4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076
					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/) {
4077 4078
						if (ERROR("SPACING",
							  "need consistent spacing around '$op' $at\n" . $hereptr)) {
4079 4080 4081 4082
							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
4083 4084
							$line_fixed = 1;
						}
4085 4086
					}

4087 4088 4089 4090
				# 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./) {
4091 4092
						if (ERROR("SPACING",
							  "space prohibited before that '$op' $at\n" . $hereptr)) {
4093
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4094 4095
							$line_fixed = 1;
						}
4096 4097
					}

4098
				# All the others need spaces both sides.
4099
				} elsif ($ctx !~ /[EWC]x[CWE]/) {
4100 4101
					my $ok = 0;

4102
					# Ignore email addresses <foo@bar>
4103 4104 4105 4106 4107 4108 4109 4110
					if (($op eq '<' &&
					     $cc =~ /^\S+\@\S+>/) ||
					    ($op eq '>' &&
					     $ca =~ /<\S+\@\S+$/))
					{
					    	$ok = 1;
					}

4111 4112 4113 4114 4115 4116 4117 4118
					# for asm volatile statements
					# ignore a colon with another
					# colon immediately before or after
					if (($op eq ':') &&
					    ($ca =~ /:$/ || $cc =~ /^:/)) {
						$ok = 1;
					}

4119
					# messages are ERROR, but ?: are CHK
4120
					if ($ok == 0) {
4121 4122 4123 4124 4125
						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)) {
4126 4127 4128 4129
							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
4130 4131
							$line_fixed = 1;
						}
4132
					}
4133
				}
4134
				$off += length($elements[$n + 1]);
4135 4136 4137 4138 4139 4140 4141 4142

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

				$fixed_line = $fixed_line . $good;
			}

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

4145 4146
			if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
				$fixed[$fixlinenr] = $fixed_line;
4147 4148 4149
			}


4150 4151
		}

4152
# check for whitespace before a non-naked semicolon
4153
		if ($line =~ /^\+.*\S\s+;\s*$/) {
4154 4155 4156
			if (WARN("SPACING",
				 "space prohibited before semicolon\n" . $herecurr) &&
			    $fix) {
4157
				1 while $fixed[$fixlinenr] =~
4158 4159 4160 4161
				    s/^(\+.*\S)\s+;/$1;/;
			}
		}

4162 4163
# check for multiple assignments
		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
4164 4165
			CHK("MULTIPLE_ASSIGNMENTS",
			    "multiple assignments should be avoided\n" . $herecurr);
4166 4167
		}

4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178
## # 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 =~ /,/) {
4179 4180
## 				WARN("MULTIPLE_DECLARATION",
##				     "declaring multiple variables together should be avoided\n" . $herecurr);
4181 4182
## 			}
## 		}
4183

4184
#need space before brace following if, while, etc
4185
		if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
4186
		    $line =~ /do\{/) {
4187 4188 4189
			if (ERROR("SPACING",
				  "space required before the open brace '{'\n" . $herecurr) &&
			    $fix) {
4190
				$fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
4191
			}
4192 4193
		}

4194 4195 4196 4197 4198 4199 4200 4201
## # check for blank lines before declarations
##		if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
##		    $prevrawline =~ /^.\s*$/) {
##			WARN("SPACING",
##			     "No blank lines before declarations\n" . $hereprev);
##		}
##

4202 4203 4204
# closing brace should have a space following it when it has anything
# on the line
		if ($line =~ /}(?!(?:,|;|\)))\S/) {
4205 4206 4207
			if (ERROR("SPACING",
				  "space required after that close brace '}'\n" . $herecurr) &&
			    $fix) {
4208
				$fixed[$fixlinenr] =~
4209 4210
				    s/}((?!(?:,|;|\)))\S)/} $1/;
			}
4211 4212
		}

4213 4214
# check spacing on square brackets
		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
4215 4216 4217
			if (ERROR("SPACING",
				  "space prohibited after that open square bracket '['\n" . $herecurr) &&
			    $fix) {
4218
				$fixed[$fixlinenr] =~
4219 4220
				    s/\[\s+/\[/;
			}
4221 4222
		}
		if ($line =~ /\s\]/) {
4223 4224 4225
			if (ERROR("SPACING",
				  "space prohibited before that close square bracket ']'\n" . $herecurr) &&
			    $fix) {
4226
				$fixed[$fixlinenr] =~
4227 4228
				    s/\s+\]/\]/;
			}
4229 4230
		}

4231
# check spacing on parentheses
4232 4233
		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
		    $line !~ /for\s*\(\s+;/) {
4234 4235 4236
			if (ERROR("SPACING",
				  "space prohibited after that open parenthesis '('\n" . $herecurr) &&
			    $fix) {
4237
				$fixed[$fixlinenr] =~
4238 4239
				    s/\(\s+/\(/;
			}
4240
		}
4241
		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
4242 4243
		    $line !~ /for\s*\(.*;\s+\)/ &&
		    $line !~ /:\s+\)/) {
4244 4245 4246
			if (ERROR("SPACING",
				  "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
			    $fix) {
4247
				$fixed[$fixlinenr] =~
4248 4249
				    s/\s+\)/\)/;
			}
4250 4251
		}

4252 4253 4254 4255
# 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) {
4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276
			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/;
			}
		}
4277

4278
#goto labels aren't indented, allow a single space however
4279
		if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
4280
		   !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
4281 4282 4283
			if (WARN("INDENTED_LABEL",
				 "labels should not be indented\n" . $herecurr) &&
			    $fix) {
4284
				$fixed[$fixlinenr] =~
4285 4286
				    s/^(.)\s+/$1/;
			}
4287 4288
		}

4289
# return is not a function
4290
		if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
4291
			my $spacing = $1;
4292
			if ($^V && $^V ge 5.10.0 &&
4293 4294 4295 4296 4297 4298 4299
			    $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);
				}
4300
			} elsif ($spacing !~ /\s+/) {
4301 4302
				ERROR("SPACING",
				      "space required before the open parenthesis '('\n" . $herecurr);
4303 4304
			}
		}
4305

4306 4307 4308 4309 4310 4311 4312 4313
# 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*:/) {
4314
			WARN("RETURN_VOID",
4315 4316
			     "void function return statements are not generally useful\n" . $hereprev);
               }
4317

4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331
# 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);
			}
		}

4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342
# comparisons with a constant or upper case identifier on the left
#	avoid cases like "foo + BAR < baz"
#	only fix matches surrounded by parentheses to avoid incorrect
#	conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
		if ($^V && $^V ge 5.10.0 &&
		    $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
			my $lead = $1;
			my $const = $2;
			my $comp = $3;
			my $to = $4;
			my $newcomp = $comp;
4343
			if ($lead !~ /(?:$Operators|\.)\s*$/ &&
4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360
			    $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
			    WARN("CONSTANT_COMPARISON",
				 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
			    $fix) {
				if ($comp eq "<") {
					$newcomp = ">";
				} elsif ($comp eq "<=") {
					$newcomp = ">=";
				} elsif ($comp eq ">") {
					$newcomp = "<";
				} elsif ($comp eq ">=") {
					$newcomp = "<=";
				}
				$fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
			}
		}

4361 4362
# Return of what appears to be an errno should normally be negative
		if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
4363 4364
			my $name = $1;
			if ($name ne 'EOF' && $name ne 'ERROR') {
4365
				WARN("USE_NEGATIVE_ERRNO",
4366
				     "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
4367 4368
			}
		}
4369

4370
# Need a space before open parenthesis after if, while etc
4371 4372 4373 4374
		if ($line =~ /\b(if|while|for|switch)\(/) {
			if (ERROR("SPACING",
				  "space required before the open parenthesis '('\n" . $herecurr) &&
			    $fix) {
4375
				$fixed[$fixlinenr] =~
4376 4377
				    s/\b(if|while|for|switch)\(/$1 \(/;
			}
4378 4379
		}

4380 4381
# Check for illegal assignment in if conditional -- and check for trailing
# statements after the conditional.
4382
		if ($line =~ /do\s*(?!{)/) {
4383 4384 4385
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403
			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} &&
4404
		    defined($stat) && defined($cond) &&
4405
		    $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
4406
			my ($s, $c) = ($stat, $cond);
4407

4408
			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
4409 4410
				ERROR("ASSIGN_IN_IF",
				      "do not use assignment in if condition\n" . $herecurr);
4411 4412 4413 4414
			}

			# Find out what is on the end of the line after the
			# conditional.
4415
			substr($s, 0, length($c), '');
4416
			$s =~ s/\n.*//g;
4417
			$s =~ s/$;//g; 	# Remove any comments
4418 4419
			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
			    $c !~ /}\s*while\s*/)
4420
			{
4421 4422 4423
				# Find out how long the conditional actually is.
				my @newlines = ($c =~ /\n/gs);
				my $cond_lines = 1 + $#newlines;
4424
				my $stat_real = '';
4425

4426 4427
				$stat_real = raw_line($linenr, $cond_lines)
							. "\n" if ($cond_lines);
4428 4429 4430 4431
				if (defined($stat_real) && $cond_lines > 1) {
					$stat_real = "[...]\n$stat_real";
				}

4432 4433
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr . $stat_real);
4434 4435 4436
			}
		}

4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448
# Check for bitwise tests written as boolean
		if ($line =~ /
			(?:
				(?:\[|\(|\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\|)
			|
				(?:\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\||\)|\])
			)/x)
		{
4449 4450
			WARN("HEXADECIMAL_BOOLEAN_TEST",
			     "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
4451 4452
		}

4453
# if and else should not have general statements after it
4454 4455 4456 4457
		if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
			my $s = $1;
			$s =~ s/$;//g; 	# Remove any comments
			if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
4458 4459
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr);
4460
			}
4461
		}
4462 4463
# if should not continue a brace
		if ($line =~ /}\s*if\b/) {
4464
			ERROR("TRAILING_STATEMENTS",
4465
			      "trailing statements should be on next line (or did you mean 'else if'?)\n" .
4466 4467
				$herecurr);
		}
4468 4469 4470
# case and default should not have general statements after them
		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
		    $line !~ /\G(?:
4471
			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
4472 4473 4474
			\s*return\s+
		    )/xg)
		{
4475 4476
			ERROR("TRAILING_STATEMENTS",
			      "trailing statements should be on next line\n" . $herecurr);
4477
		}
4478 4479 4480

		# Check for }<nl>else {, these must be at the same
		# indent level to be relevant to each other.
4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496
		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);
			}
4497 4498
		}

4499 4500
		if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
		    $previndent == $indent) {
4501 4502 4503 4504
			my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);

			# Find out what is on the end of the line after the
			# conditional.
4505
			substr($s, 0, length($c), '');
4506 4507 4508
			$s =~ s/\n.*//g;

			if ($s =~ /^\s*;/) {
4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520
				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);
				}
4521 4522 4523
			}
		}

4524
#Specific variable tests
4525 4526
		while ($line =~ m{($Constant|$Lval)}g) {
			my $var = $1;
4527 4528 4529

#gcc binary extension
			if ($var =~ /^$Binary$/) {
4530 4531 4532 4533
				if (WARN("GCC_BINARY_CONSTANT",
					 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
				    $fix) {
					my $hexval = sprintf("0x%x", oct($var));
4534
					$fixed[$fixlinenr] =~
4535 4536
					    s/\b$var\b/$hexval/;
				}
4537 4538 4539
			}

#CamelCase
4540
			if ($var !~ /^$Constant$/ &&
4541
			    $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
4542
#Ignore Page<foo> variants
4543
			    $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
4544
#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4545 4546 4547
			    $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_]+)?$/) {
4548 4549 4550
				while ($var =~ m{($Ident)}g) {
					my $word = $1;
					next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
4551 4552 4553 4554 4555 4556 4557
					if ($check) {
						seed_camelcase_includes();
						if (!$file && !$camelcase_file_seeded) {
							seed_camelcase_file($realfile);
							$camelcase_file_seeded = 1;
						}
					}
4558 4559 4560 4561 4562
					if (!defined $camelcase{$word}) {
						$camelcase{$word} = 1;
						CHK("CAMELCASE",
						    "Avoid CamelCase: <$word>\n" . $herecurr);
					}
4563
				}
4564 4565
			}
		}
4566 4567

#no spaces allowed after \ in define
4568 4569 4570 4571
		if ($line =~ /\#\s*define.*\\\s+$/) {
			if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
				 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
			    $fix) {
4572
				$fixed[$fixlinenr] =~ s/\s+$//;
4573
			}
4574 4575
		}

4576 4577
# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
# itself <asm/foo.h> (uses RAW line)
4578
		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
4579 4580 4581 4582
			my $file = "$1.h";
			my $checkfile = "include/linux/$file";
			if (-f "$root/$checkfile" &&
			    $realfile ne $checkfile &&
4583
			    $1 !~ /$allowed_asm_includes/)
4584
			{
4585 4586 4587 4588 4589 4590 4591 4592 4593
				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);
					}
4594
				}
4595 4596 4597
			}
		}

4598 4599
# 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
4600
# in a known good container
4601 4602
		if ($realfile !~ m@/vmlinux.lds.h$@ &&
		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
4603 4604
			my $ln = $linenr;
			my $cnt = $realcnt;
4605 4606
			my ($off, $dstat, $dcond, $rest);
			my $ctx = '';
4607 4608
			my $has_flow_statement = 0;
			my $has_arg_concat = 0;
4609
			($dstat, $dcond, $ln, $cnt, $off) =
4610 4611
				ctx_statement_block($linenr, $realcnt, 0);
			$ctx = $dstat;
4612
			#print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4613
			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4614

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

4618
			$dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
4619
			$dstat =~ s/$;//g;
4620 4621 4622
			$dstat =~ s/\\\n.//g;
			$dstat =~ s/^\s*//s;
			$dstat =~ s/\s*$//s;
4623

4624
			# Flatten any parentheses and braces
4625 4626
			while ($dstat =~ s/\([^\(\)]*\)/1/ ||
			       $dstat =~ s/\{[^\{\}]*\}/1/ ||
4627
			       $dstat =~ s/.\[[^\[\]]*\]/1/)
4628
			{
4629
			}
4630

4631
			# Flatten any obvious string concatentation.
4632 4633
			while ($dstat =~ s/($String)\s*$Ident/$1/ ||
			       $dstat =~ s/$Ident\s*($String)/$1/)
4634 4635 4636
			{
			}

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

4640 4641 4642
			my $exceptions = qr{
				$Declare|
				module_param_named|
4643
				MODULE_PARM_DESC|
4644 4645
				DECLARE_PER_CPU|
				DEFINE_PER_CPU|
4646
				__typeof__\(|
4647 4648
				union|
				struct|
4649
				\.$Ident\s*=\s*|
4650 4651
				^\"|\"$|
				^\[
4652
			}x;
4653
			#print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4654 4655 4656
			if ($dstat ne '' &&
			    $dstat !~ /^(?:$Ident|-?$Constant),$/ &&			# 10, // foo(),
			    $dstat !~ /^(?:$Ident|-?$Constant);$/ &&			# foo();
4657
			    $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ &&		# 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4658
			    $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ &&			# character constants
4659 4660
			    $dstat !~ /$exceptions/ &&
			    $dstat !~ /^\.$Ident\s*=/ &&				# .foo =
4661
			    $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ &&		# stringification #foo
4662
			    $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ &&	# do {...} while (...); // do {...} while (...)
4663 4664 4665
			    $dstat !~ /^for\s*$Constant$/ &&				# for (...)
			    $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ &&	# for (...) bar()
			    $dstat !~ /^do\s*{/ &&					# do {...
4666
			    $dstat !~ /^\(\{/ &&						# ({...
4667
			    $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
4668 4669 4670 4671 4672 4673 4674
			{
				$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";
4675 4676
				}

4677 4678 4679 4680
				if ($dstat =~ /;/) {
					ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
					      "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
				} else {
4681
					ERROR("COMPLEX_MACRO",
A
Andrew Morton 已提交
4682
					      "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
4683
				}
4684
			}
4685

4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698
# 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");
			}

4699
# check for line continuations outside of #defines, preprocessor #, and asm
4700 4701 4702

		} else {
			if ($prevline !~ /^..*\\$/ &&
4703 4704
			    $line !~ /^\+\s*\#.*\\$/ &&		# preprocessor
			    $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ &&	# asm
4705 4706 4707 4708
			    $line =~ /^\+.*\\$/) {
				WARN("LINE_CONTINUATIONS",
				     "Avoid unnecessary line continuations\n" . $herecurr);
			}
4709 4710
		}

4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725
# 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;
4726
			$dstat =~ s/$;/ /g;
4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739

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

4740 4741
				if (($stmts =~ tr/;/;/) == 1 &&
				    $stmts !~ /^\s*(if|while|for|switch)\b/) {
4742 4743 4744 4745 4746 4747 4748
					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");
				}
4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759
			} 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");
4760 4761 4762
			}
		}

4763 4764 4765 4766 4767 4768
# 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|$))/) {
4769 4770
			WARN("MISSING_VMLINUX_SYMBOL",
			     "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
4771 4772
		}

4773
# check for redundant bracing round if etc
4774 4775
		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
			my ($level, $endln, @chunks) =
4776
				ctx_statement_full($linenr, $realcnt, 1);
4777
			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4778 4779
			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
			if ($#chunks > 0 && $level == 0) {
4780 4781
				my @allowed = ();
				my $allow = 0;
4782
				my $seen = 0;
4783
				my $herectx = $here . "\n";
4784
				my $ln = $linenr - 1;
4785 4786 4787
				for my $chunk (@chunks) {
					my ($cond, $block) = @{$chunk};

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

4792
					$allowed[$allow] = 0;
4793 4794 4795 4796 4797 4798
					#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";
4799 4800
					$ln += statement_rawlines($block) - 1;

4801
					substr($block, 0, length($cond), '');
4802 4803 4804

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

4805
					#print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4806 4807
					if (statement_lines($cond) > 1) {
						#print "APW: ALLOWED: cond<$cond>\n";
4808
						$allowed[$allow] = 1;
4809 4810
					}
					if ($block =~/\b(?:if|for|while)\b/) {
4811
						#print "APW: ALLOWED: block<$block>\n";
4812
						$allowed[$allow] = 1;
4813
					}
4814 4815
					if (statement_block_size($block) > 1) {
						#print "APW: ALLOWED: lines block<$block>\n";
4816
						$allowed[$allow] = 1;
4817
					}
4818
					$allow++;
4819
				}
4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832
				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);
					}
4833 4834 4835
				}
			}
		}
4836
		if (!defined $suppress_ifbraces{$linenr - 1} &&
4837
					$line =~ /\b(if|while|for|else)\b/) {
4838 4839 4840 4841 4842 4843 4844
			my $allowed = 0;

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

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

4849 4850
			# Check the condition.
			my ($cond, $block) = @{$chunks[0]};
4851
			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4852
			if (defined $cond) {
4853
				substr($block, 0, length($cond), '');
4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870
			}
			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) {
4871
					substr($block, 0, length($cond), '');
4872 4873 4874 4875 4876 4877 4878
				}
				if ($block =~ /^\s*\{/) {
					#print "APW: ALLOWED: chunk-1 block<$block>\n";
					$allowed = 1;
				}
			}
			if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
4879
				my $herectx = $here . "\n";
4880
				my $cnt = statement_rawlines($block);
4881

4882
				for (my $n = 0; $n < $cnt; $n++) {
4883
					$herectx .= raw_line($linenr, $n) . "\n";
4884
				}
4885

4886 4887
				WARN("BRACES",
				     "braces {} are not necessary for single statement blocks\n" . $herectx);
4888 4889 4890
			}
		}

4891
# check for unnecessary blank lines around braces
4892
		if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
4893 4894 4895 4896 4897
			if (CHK("BRACES",
				"Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
			    $fix && $prevrawline =~ /^\+/) {
				fix_delete_line($fixlinenr - 1, $prevrawline);
			}
4898
		}
4899
		if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
4900 4901 4902 4903 4904
			if (CHK("BRACES",
				"Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
			    $fix) {
				fix_delete_line($fixlinenr, $rawline);
			}
4905 4906
		}

4907
# no volatiles please
4908 4909
		my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
		if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
4910 4911
			WARN("VOLATILE",
			     "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4912 4913
		}

4914 4915 4916 4917
# 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
4918
		if ($line =~ /^\+\s*$String/ &&
4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962
		    $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/;
			}

		}

4963
# concatenated string without spaces between elements
4964
		if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
4965 4966 4967 4968
			CHK("CONCATENATED_STRING",
			    "Concatenated strings should use spaces between elements\n" . $herecurr);
		}

4969
# uncoalesced string fragments
4970
		if ($line =~ /$String\s*"/) {
4971 4972 4973 4974
			WARN("STRING_FRAGMENTS",
			     "Consecutive strings are generally better as a single string\n" . $herecurr);
		}

4975
# check for %L{u,d,i} and 0x%[udi] in strings
4976 4977 4978 4979
		my $string;
		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
			$string = substr($rawline, $-[1], $+[1] - $-[1]);
			$string =~ s/%%/__/g;
4980
			if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) {
4981 4982 4983 4984
				WARN("PRINTF_L",
				     "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
				last;
			}
4985 4986 4987 4988
			if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) {
				ERROR("PRINTF_0xDECIMAL",
				      "Prefixing 0x with decimal output is defective\n" . $herecurr);
			}
4989 4990 4991 4992 4993 4994 4995 4996
		}

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

4997
# warn about #if 0
4998
		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
4999 5000
			CHK("REDUNDANT_CODE",
			    "if this code is redundant consider removing it\n" .
5001
				$herecurr);
5002 5003
		}

5004 5005
# check for needless "if (<foo>) fn(<foo>)" uses
		if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033
			my $tested = quotemeta($1);
			my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
			if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
				my $func = $1;
				if (WARN('NEEDLESS_IF',
					 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
				    $fix) {
					my $do_fix = 1;
					my $leading_tabs = "";
					my $new_leading_tabs = "";
					if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
						$leading_tabs = $1;
					} else {
						$do_fix = 0;
					}
					if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
						$new_leading_tabs = $1;
						if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
							$do_fix = 0;
						}
					} else {
						$do_fix = 0;
					}
					if ($do_fix) {
						fix_delete_line($fixlinenr - 1, $prevrawline);
						$fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
					}
				}
5034 5035
			}
		}
5036

5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053
# 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);
			}
		}

5054
# check for logging functions with KERN_<LEVEL>
5055
		if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
5056 5057 5058 5059 5060 5061 5062 5063 5064
		    $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*//;
			}
		}

5065 5066 5067 5068 5069 5070 5071 5072
# 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);
		}

5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086
# 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/;
				}
			}
		}

5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099
# 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) {
5100
					$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;
5101 5102 5103 5104
				}
			}
		}

5105 5106 5107 5108 5109 5110 5111 5112 5113
# 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) {
5114
				$fixed[$fixlinenr] =~
5115 5116 5117 5118 5119 5120 5121 5122 5123 5124
				    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) {
5125
				my $lead = $fixed[$fixlinenr] =~
5126 5127 5128 5129
				    /(^\+\s*(?:static\s+))/;
				$lead = rtrim($1);
				$lead = "$lead " if ($lead !~ /^\+$/);
				$lead = "${lead}const ";
5130
				$fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
5131 5132 5133
			}
		}

5134 5135 5136 5137 5138 5139 5140 5141 5142 5143
# check for __read_mostly with const non-pointer (should just be const)
		if ($line =~ /\b__read_mostly\b/ &&
		    $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
			if (ERROR("CONST_READ_MOSTLY",
				  "Invalid use of __read_mostly with const type\n" . $herecurr) &&
			    $fix) {
				$fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
			}
		}

5144 5145 5146 5147 5148 5149 5150 5151 5152
# 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) {
5153
				$fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
5154 5155 5156
			}
		}

5157
# prefer usleep_range over udelay
B
Bruce Allan 已提交
5158
		if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
5159
			my $delay = $1;
5160
			# ignore udelay's < 10, however
5161
			if (! ($delay < 10) ) {
5162
				CHK("USLEEP_RANGE",
5163 5164 5165 5166 5167
				    "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);
5168 5169 5170
			}
		}

5171 5172 5173
# warn about unexpectedly long msleep's
		if ($line =~ /\bmsleep\s*\((\d+)\);/) {
			if ($1 < 20) {
5174
				WARN("MSLEEP",
5175
				     "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5176 5177 5178
			}
		}

5179 5180 5181 5182 5183 5184
# 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);
		}

5185 5186 5187 5188 5189 5190
# 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);
		}

5191
# warn about #ifdefs in C files
5192
#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5193 5194 5195 5196 5197
#			print "#ifdef in C files should be avoided\n";
#			print "$herecurr";
#			$clean = 0;
#		}

5198
# warn about spacing in #ifdefs
5199
		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
5200 5201 5202
			if (ERROR("SPACING",
				  "exactly one space required after that #$1\n" . $herecurr) &&
			    $fix) {
5203
				$fixed[$fixlinenr] =~
5204 5205 5206
				    s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
			}

5207 5208
		}

5209
# check for spinlock_t definitions without a comment.
5210 5211
		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
5212 5213
			my $which = $1;
			if (!ctx_has_comment($first_line, $linenr)) {
5214 5215
				CHK("UNCOMMENTED_DEFINITION",
				    "$1 definition without comment\n" . $herecurr);
5216 5217 5218
			}
		}
# check for memory barriers without a comment.
5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235

		my $barriers = qr{
			mb|
			rmb|
			wmb|
			read_barrier_depends
		}x;
		my $barrier_stems = qr{
			mb__before_atomic|
			mb__after_atomic|
			store_release|
			load_acquire|
			store_mb|
			(?:$barriers)
		}x;
		my $all_barriers = qr{
			(?:$barriers)|
5236 5237
			smp_(?:$barrier_stems)|
			virt_(?:$barrier_stems)
5238 5239 5240
		}x;

		if ($line =~ /\b(?:$all_barriers)\s*\(/) {
5241
			if (!ctx_has_comment($first_line, $linenr)) {
5242 5243
				WARN("MEMORY_BARRIER",
				     "memory barrier without comment\n" . $herecurr);
5244 5245
			}
		}
5246

5247 5248 5249 5250 5251 5252 5253 5254 5255 5256
		my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;

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

5257 5258 5259 5260 5261 5262 5263
# check for waitqueue_active without a comment.
		if ($line =~ /\bwaitqueue_active\s*\(/) {
			if (!ctx_has_comment($first_line, $linenr)) {
				WARN("WAITQUEUE_ACTIVE",
				     "waitqueue_active without comment\n" . $herecurr);
			}
		}
5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281

# Check for expedited grace periods that interrupt non-idle non-nohz
# online CPUs.  These expedited can therefore degrade real-time response
# if used carelessly, and should be avoided where not absolutely
# needed.  It is always OK to use synchronize_rcu_expedited() and
# synchronize_sched_expedited() at boot time (before real-time applications
# start) and in error situations where real-time response is compromised in
# any case.  Note that synchronize_srcu_expedited() does -not- interrupt
# other CPUs, so don't warn on uses of synchronize_srcu_expedited().
# Of course, nothing comes for free, and srcu_read_lock() and
# srcu_read_unlock() do contain full memory barriers in payment for
# synchronize_srcu_expedited() non-interruption properties.
		if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) {
			WARN("EXPEDITED_RCU_GRACE_PERIOD",
			     "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);

		}

5282
# check of hardware specific defines
5283
		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5284 5285
			CHK("ARCH_DEFINES",
			    "architecture specific defines should be avoided\n" .  $herecurr);
5286
		}
5287

5288 5289
# Check that the storage class is at the beginning of a declaration
		if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
5290 5291
			WARN("STORAGE_CLASS",
			     "storage class should be at the beginning of the declaration\n" . $herecurr)
5292 5293
		}

5294 5295
# check the location of the inline attribute, that it is between
# storage class and type.
5296 5297
		if ($line =~ /\b$Type\s+$Inline\b/ ||
		    $line =~ /\b$Inline\s+$Storage\b/) {
5298 5299
			ERROR("INLINE_LOCATION",
			      "inline keyword should sit between storage class and type\n" . $herecurr);
5300 5301
		}

5302
# Check for __inline__ and __inline, prefer inline
5303 5304
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b(__inline__|__inline)\b/) {
5305 5306 5307
			if (WARN("INLINE",
				 "plain inline is preferred over $1\n" . $herecurr) &&
			    $fix) {
5308
				$fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
5309 5310

			}
5311 5312
		}

5313
# Check for __attribute__ packed, prefer __packed
5314 5315
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
5316 5317
			WARN("PREFER_PACKED",
			     "__packed is preferred over __attribute__((packed))\n" . $herecurr);
5318 5319
		}

5320
# Check for __attribute__ aligned, prefer __aligned
5321 5322
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
5323 5324
			WARN("PREFER_ALIGNED",
			     "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
5325 5326
		}

5327
# Check for __attribute__ format(printf, prefer __printf
5328 5329
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
5330 5331 5332
			if (WARN("PREFER_PRINTF",
				 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
			    $fix) {
5333
				$fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5334 5335

			}
5336 5337
		}

5338
# Check for __attribute__ format(scanf, prefer __scanf
5339 5340
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
5341 5342 5343
			if (WARN("PREFER_SCANF",
				 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
			    $fix) {
5344
				$fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5345
			}
5346 5347
		}

5348 5349 5350 5351 5352 5353 5354 5355 5356
# 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);
		}

5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374
# check for c99 types like uint8_t used outside of uapi/
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
			my $type = $1;
			if ($type =~ /\b($typeC99Typedefs)\b/) {
				$type = $1;
				my $kernel_type = 'u';
				$kernel_type = 's' if ($type =~ /^_*[si]/);
				$type =~ /(\d+)/;
				$kernel_type .= $1;
				if (CHK("PREFER_KERNEL_TYPES",
					"Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
				    $fix) {
					$fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
				}
			}
		}

5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394
# check for cast of C90 native int or longer types constants
		if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
			my $cast = $1;
			my $const = $2;
			if (WARN("TYPECAST_INT_CONSTANT",
				 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
			    $fix) {
				my $suffix = "";
				my $newconst = $const;
				$newconst =~ s/${Int_type}$//;
				$suffix .= 'U' if ($cast =~ /\bunsigned\b/);
				if ($cast =~ /\blong\s+long\b/) {
					$suffix .= 'LL';
				} elsif ($cast =~ /\blong\b/) {
					$suffix .= 'L';
				}
				$fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
			}
		}

5395 5396
# check for sizeof(&)
		if ($line =~ /\bsizeof\s*\(\s*\&/) {
5397 5398
			WARN("SIZEOF_ADDRESS",
			     "sizeof(& should be avoided\n" . $herecurr);
5399 5400
		}

5401 5402
# check for sizeof without parenthesis
		if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
5403 5404 5405
			if (WARN("SIZEOF_PARENTHESIS",
				 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
			    $fix) {
5406
				$fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5407
			}
5408 5409
		}

5410 5411 5412 5413 5414 5415
# 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);
		}

5416
# check for seq_printf uses that could be seq_puts
J
Joe Perches 已提交
5417
		if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
5418
			my $fmt = get_quoted_string($line, $rawline);
5419 5420
			$fmt =~ s/%%//g;
			if ($fmt !~ /%/) {
5421 5422 5423
				if (WARN("PREFER_SEQ_PUTS",
					 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
				    $fix) {
5424
					$fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
5425
				}
5426 5427 5428
			}
		}

5429
# Check for misused memsets
5430 5431
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
5432
		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
5433 5434

			my $ms_addr = $2;
5435 5436
			my $ms_val = $7;
			my $ms_size = $12;
5437 5438 5439

			if ($ms_size =~ /^(0x|)0$/i) {
				ERROR("MEMSET",
5440
				      "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
5441 5442
			} elsif ($ms_size =~ /^(0x|)1$/i) {
				WARN("MEMSET",
5443 5444 5445 5446
				     "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
			}
		}

5447 5448
# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
		if ($^V && $^V ge 5.10.0 &&
5449 5450
		    defined $stat &&
		    $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5451
			if (WARN("PREFER_ETHER_ADDR_COPY",
5452
				 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5453
			    $fix) {
5454
				$fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5455 5456 5457
			}
		}

5458 5459 5460 5461 5462 5463 5464 5465
# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
		    $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
			WARN("PREFER_ETHER_ADDR_EQUAL",
			     "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
		}

5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488
# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {

			my $ms_val = $7;

			if ($ms_val =~ /^(?:0x|)0+$/i) {
				if (WARN("PREFER_ETH_ZERO_ADDR",
					 "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
				    $fix) {
					$fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
				}
			} elsif ($ms_val =~ /^(?:0xff|255)$/i) {
				if (WARN("PREFER_ETH_BROADCAST_ADDR",
					 "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
				    $fix) {
					$fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
				}
			}
		}

5489
# typecasts on min/max could be min_t/max_t
5490 5491
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
5492
		    $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
5493
			if (defined $2 || defined $7) {
5494 5495 5496
				my $call = $1;
				my $cast1 = deparenthesize($2);
				my $arg1 = $3;
5497 5498
				my $cast2 = deparenthesize($7);
				my $arg2 = $8;
5499 5500
				my $cast;

5501
				if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
5502 5503 5504 5505 5506 5507 5508 5509
					$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");
5510 5511 5512
			}
		}

5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528
# 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");
			}
		}

5529 5530 5531
# check for naked sscanf
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
5532
		    $line =~ /\bsscanf\b/ &&
5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545
		    ($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");
		}

5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566
# 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");
				}
			}
		}

5567 5568 5569
# check for new externs in .h files.
		if ($realfile =~ /\.h$/ &&
		    $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
5570 5571
			if (CHK("AVOID_EXTERNS",
				"extern prototypes should be avoided in .h files\n" . $herecurr) &&
5572
			    $fix) {
5573
				$fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
5574 5575 5576
			}
		}

5577
# check for new externs in .c files.
5578
		if ($realfile =~ /\.c$/ && defined $stat &&
5579
		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
5580
		{
5581 5582
			my $function_name = $1;
			my $paren_space = $2;
5583 5584 5585 5586 5587

			my $s = $stat;
			if (defined $cond) {
				substr($s, 0, length($cond), '');
			}
5588 5589 5590
			if ($s =~ /^\s*;/ &&
			    $function_name ne 'uninitialized_var')
			{
5591 5592
				WARN("AVOID_EXTERNS",
				     "externs should be avoided in .c files\n" .  $herecurr);
5593 5594 5595
			}

			if ($paren_space =~ /\n/) {
5596 5597
				WARN("FUNCTION_ARGUMENTS",
				     "arguments for function declarations should follow identifier\n" . $herecurr);
5598
			}
5599 5600 5601 5602

		} elsif ($realfile =~ /\.c$/ && defined $stat &&
		    $stat =~ /^.\s*extern\s+/)
		{
5603 5604
			WARN("AVOID_EXTERNS",
			     "externs should be avoided in .c files\n" .  $herecurr);
5605 5606 5607 5608 5609 5610 5611
		}

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

			if (!grep(/$name/, @setup_docs)) {
5612 5613
				CHK("UNDOCUMENTED_SETUP",
				    "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
5614
			}
5615
		}
5616 5617

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

5623 5624 5625 5626 5627 5628 5629 5630
# 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);
		}

5631 5632
# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
		if ($^V && $^V ge 5.10.0 &&
5633
		    $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
5634 5635 5636 5637 5638
			my $oldfunc = $3;
			my $a1 = $4;
			my $a2 = $10;
			my $newfunc = "kmalloc_array";
			$newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
5639 5640 5641 5642 5643 5644 5645 5646
			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_]*$/)) {
5647 5648 5649
				if (WARN("ALLOC_WITH_MULTIPLY",
					 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
				    $fix) {
5650
					$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;
5651 5652 5653 5654 5655

				}
			}
		}

5656 5657 5658 5659 5660 5661 5662
# 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);
		}

5663 5664 5665 5666 5667 5668
# 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);
		}

5669 5670
# check for multiple semicolons
		if ($line =~ /;\s*;\s*$/) {
5671 5672 5673
			if (WARN("ONE_SEMICOLON",
				 "Statements terminations use 1 semicolon\n" . $herecurr) &&
			    $fix) {
5674
				$fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
5675
			}
5676 5677
		}

5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688
# 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)/;
			}
		}

5689 5690 5691 5692 5693 5694 5695 5696 5697 5698
# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
		if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
			my $config = $1;
			if (WARN("PREFER_IS_ENABLED",
				 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
			    $fix) {
				$fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
			}
		}

5699
# check for case / default statements not preceded by break/fallthrough/switch
5700 5701 5702 5703 5704
		if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
			my $has_break = 0;
			my $has_statement = 0;
			my $count = 0;
			my $prevline = $linenr;
5705
			while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723
				$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);
			}
		}

5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735
# 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);
5736 5737
		}

5738
# check for gcc specific __FUNCTION__
5739 5740 5741 5742
		if ($line =~ /\b__FUNCTION__\b/) {
			if (WARN("USE_FUNC",
				 "__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr) &&
			    $fix) {
5743
				$fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
5744
			}
5745
		}
5746

5747 5748 5749 5750 5751 5752
# 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 已提交
5753 5754 5755 5756 5757 5758
# 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);
		}

5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785
# 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);

			}
		}

5786 5787
# check for semaphores initialized locked
		if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
5788 5789
			WARN("CONSIDER_COMPLETION",
			     "consider using a completion\n" . $herecurr);
5790
		}
5791

5792 5793
# recommend kstrto* over simple_strto* and strict_strto*
		if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
5794
			WARN("CONSIDER_KSTRTO",
5795
			     "$1 is obsolete, use k$3 instead\n" . $herecurr);
5796
		}
5797

5798
# check for __initcall(), use device_initcall() explicitly or more appropriate function please
5799
		if ($line =~ /^.\s*__initcall\s*\(/) {
5800
			WARN("USE_DEVICE_INITCALL",
5801
			     "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
5802
		}
5803

5804 5805 5806
# check for various structs that are normally const (ops, kgdb, device_tree)
		my $const_structs = qr{
				acpi_dock_ops|
5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828
				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|
5829
				of_device_id|
5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841
				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|
5842
				uart_ops|
5843 5844
				usb_mon_operations|
				wd_ops}x;
5845
		if ($line !~ /\bconst\b/ &&
5846
		    $line =~ /\bstruct\s+($const_structs)\b/) {
5847 5848
			WARN("CONST_STRUCT",
			     "struct $1 should normally be const\n" .
5849
				$herecurr);
5850
		}
5851 5852 5853 5854

# 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/ &&
5855 5856
		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
5857 5858 5859
		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
5860
		{
5861 5862
			WARN("NR_CPUS",
			     "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
5863
		}
5864

5865 5866 5867 5868 5869 5870
# 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);
		}

5871 5872 5873 5874 5875 5876 5877
# 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);
		}

5878 5879 5880
# whine mightly about in_atomic
		if ($line =~ /\bin_atomic\s*\(/) {
			if ($realfile =~ m@^drivers/@) {
5881 5882
				ERROR("IN_ATOMIC",
				      "do not use in_atomic in drivers\n" . $herecurr);
5883
			} elsif ($realfile !~ m@^kernel/@) {
5884 5885
				WARN("IN_ATOMIC",
				     "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
5886 5887
			}
		}
5888

5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910
# whine about ACCESS_ONCE
		if ($^V && $^V ge 5.10.0 &&
		    $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) {
			my $par = $1;
			my $eq = $2;
			my $fun = $3;
			$par =~ s/^\(\s*(.*)\s*\)$/$1/;
			if (defined($eq)) {
				if (WARN("PREFER_WRITE_ONCE",
					 "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) &&
				    $fix) {
					$fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
				}
			} else {
				if (WARN("PREFER_READ_ONCE",
					 "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) &&
				    $fix) {
					$fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/;
				}
			}
		}

5911 5912 5913 5914 5915 5916
# 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@) {
5917 5918
				ERROR("LOCKDEP",
				      "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
5919 5920
			}
		}
5921

5922 5923
		if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
		    $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
5924 5925
			WARN("EXPORTED_WORLD_WRITABLE",
			     "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5926
		}
5927

5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950
# 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);
5951 5952 5953
					} elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
						ERROR("EXPORTED_WORLD_WRITABLE",
						      "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5954
					}
5955 5956 5957
				}
			}
		}
5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975

# validate content of MODULE_LICENSE against list from include/linux/module.h
		if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
			my $extracted_string = get_quoted_string($line, $rawline);
			my $valid_licenses = qr{
						GPL|
						GPL\ v2|
						GPL\ and\ additional\ rights|
						Dual\ BSD/GPL|
						Dual\ MIT/GPL|
						Dual\ MPL/GPL|
						Proprietary
					}x;
			if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
				WARN("MODULE_LICENSE",
				     "unknown module license " . $extracted_string . "\n" . $herecurr);
			}
		}
5976 5977 5978 5979 5980 5981
	}

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

5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995
	# 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);
	}

5996
	if (!$is_patch && $file !~ /cover-letter\.patch$/) {
5997 5998
		ERROR("NOT_UNIFIED_DIFF",
		      "Does not appear to be a unified-diff format patch\n");
5999
	}
6000
	if ($is_patch && $filename ne '-' && $chk_signoff && $signoff == 0) {
6001 6002
		ERROR("MISSING_SIGN_OFF",
		      "Missing Signed-off-by: line(s)\n");
6003 6004
	}

6005
	print report_dump();
6006 6007
	if ($summary && !($clean == 1 && $quiet == 1)) {
		print "$filename " if ($summary_file);
6008 6009 6010
		print "total: $cnt_error errors, $cnt_warn warnings, " .
			(($check)? "$cnt_chk checks, " : "") .
			"$cnt_lines lines checked\n";
6011
	}
6012

6013
	if ($quiet == 0) {
6014 6015 6016 6017 6018 6019 6020 6021
		# If there were any defects found and not already fixing them
		if (!$clean and !$fix) {
			print << "EOM"

NOTE: For some of the reported defects, checkpatch may be able to
      mechanically convert to the typical style using --fix or --fix-inplace.
EOM
		}
6022 6023 6024
		# If there were whitespace errors which cleanpatch can fix
		# then suggest that.
		if ($rpt_cleaners) {
6025
			$rpt_cleaners = 0;
6026 6027 6028 6029 6030
			print << "EOM"

NOTE: Whitespace errors detected.
      You may wish to use scripts/cleanpatch or scripts/cleanfile
EOM
6031 6032 6033
		}
	}

6034 6035 6036
	if ($clean == 0 && $fix &&
	    ("@rawlines" ne "@fixed" ||
	     $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
6037 6038
		my $newfile = $filename;
		$newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
6039 6040 6041
		my $linecount = 0;
		my $f;

6042 6043
		@fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);

6044 6045 6046 6047 6048 6049 6050
		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/^\+//;
6051
					print $f $fixed_line . "\n";
6052 6053 6054 6055 6056 6057 6058 6059 6060
				}
			} else {
				print $f $fixed_line . "\n";
			}
		}
		close($f);

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

6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072
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
		}
	}

6073 6074 6075 6076 6077 6078 6079
	if ($quiet == 0) {
		print "\n";
		if ($clean == 1) {
			print "$vname has no obvious style problems and is ready for submission.\n";
		} else {
			print "$vname has style problems, please review.\n";
		}
6080 6081 6082
	}
	return $clean;
}