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

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

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

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

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

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

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

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

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

When FILE is - read standard input.
EOM

	exit($exitcode);
}

99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
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;
}

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

help(0) if ($help);
154

155
$fix = 1 if ($fix_inplace);
156
$check_orig = $check;
157

158 159
my $exit = 0;

160 161 162 163 164 165 166
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);
	}
}

167
if ($#ARGV < 0) {
168
	print "$P: no input files\n";
169 170 171
	exit(1);
}

172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
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}++;
	}
}
188

189 190
sub hash_show_words {
	my ($hashRef, $prefix) = @_;
191

192
	if ($quiet == 0 && keys %$hashRef) {
193
		print "NOTE: $prefix message types:";
194
		foreach my $word (sort keys %$hashRef) {
195 196 197 198
			print " $word";
		}
		print "\n\n";
	}
199 200
}

201 202 203
hash_save_array_words(\%ignore_type, \@ignore);
hash_save_array_words(\%use_type, \@use);

204 205
my $dbg_values = 0;
my $dbg_possible = 0;
206
my $dbg_type = 0;
207
my $dbg_attr = 0;
208
for my $key (keys %debug) {
209 210 211
	## no critic
	eval "\${dbg_$key} = '$debug{$key}';";
	die "$@" if ($@);
212 213
}

214 215
my $rpt_cleaners = 0;

216 217 218 219 220
if ($terse) {
	$emacs = 1;
	$quiet++;
}

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

241 242
my $emitted_corrupt = 0;

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

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

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

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

319
our $NonptrType;
320
our $NonptrTypeMisordered;
321
our $NonptrTypeWithAttr;
322
our $Type;
323
our $TypeMisordered;
324
our $Declare;
325
our $DeclareMisordered;
326

327 328
our $NON_ASCII_UTF8	= qr{
	[\xC2-\xDF][\x80-\xBF]               # non-overlong 2-byte
329 330 331 332 333 334 335 336
	|  \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;

337 338 339 340 341
our $UTF8	= qr{
	[\x09\x0A\x0D\x20-\x7E]              # ASCII
	| $NON_ASCII_UTF8
}x;

342 343 344 345 346
our $typeOtherOSTypedefs = qr{(?x:
	u_(?:char|short|int|long) |          # bsd
	u(?:nchar|short|int|long)            # sysv
)};

347
our $typeTypedefs = qr{(?x:
348
	(?:__)?(?:u|s|be|le)(?:8|16|32|64)|
349 350 351
	atomic_t
)};

352
our $logFunctions = qr{(?x:
353
	printk(?:_ratelimited|_once|)|
354
	(?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
355
	WARN(?:_RATELIMIT|_ONCE|)|
356
	panic|
J
Joe Perches 已提交
357 358
	MODULE_[A-Z_]+|
	seq_vprintf|seq_printf|seq_puts
359 360
)};

361 362 363 364 365 366
our $signature_tags = qr{(?xi:
	Signed-off-by:|
	Acked-by:|
	Tested-by:|
	Reviewed-by:|
	Reported-by:|
367
	Suggested-by:|
368 369 370 371
	To:|
	Cc:
)};

372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390
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},
);

391 392
our @typeList = (
	qr{void},
393 394 395 396 397 398 399 400 401
	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},
402 403 404 405 406 407 408 409 410
	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},
411
	@typeListMisordered,
412
);
413 414 415 416 417 418
our @typeListWithAttr = (
	@typeList,
	qr{struct\s+$InitAttribute\s+$Ident},
	qr{union\s+$InitAttribute\s+$Ident},
);

419 420 421
our @modifierList = (
	qr{fastcall},
);
422

423 424 425 426 427 428 429 430 431
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],
);

432 433 434 435 436 437 438
#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];
}

439 440
our $allowed_asm_includes = qr{(?x:
	irq|
441 442 443
	memory|
	time|
	reboot
444 445 446
)};
# memory.h: ARM has a custom one

447 448 449 450
# Load common spelling mistakes and build regular expression list.
my $misspellings;
my %spelling_fix;

451 452 453 454
if (open(my $spelling, '<', $spelling_file)) {
	my @spelling_list;
	while (<$spelling>) {
		my $line = $_;
455

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

459 460 461 462
		next if ($line =~ m/^\s*#/);
		next if ($line =~ m/^\s*$/);

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

464 465 466 467 468 469 470
		push(@spelling_list, $suspect);
		$spelling_fix{$suspect} = $fix;
	}
	close($spelling);
	$misspellings = join("|", @spelling_list);
} else {
	warn "No typos will be found - file '$spelling_file': $!\n";
471 472
}

473
sub build_types {
474 475
	my $mods = "(?x:  \n" . join("|\n  ", @modifierList) . "\n)";
	my $all = "(?x:  \n" . join("|\n  ", @typeList) . "\n)";
476
	my $Misordered = "(?x:  \n" . join("|\n  ", @typeListMisordered) . "\n)";
477
	my $allWithAttr = "(?x:  \n" . join("|\n  ", @typeListWithAttr) . "\n)";
478
	$Modifier	= qr{(?:$Attribute|$Sparse|$mods)};
479
	$NonptrType	= qr{
480
			(?:$Modifier\s+|const\s+)*
481
			(?:
482
				(?:typeof|__typeof__)\s*\([^\)]*\)|
483
				(?:$typeOtherOSTypedefs\b)|
484
				(?:$typeTypedefs\b)|
485
				(?:${all}\b)
486
			)
487
			(?:\s+$Modifier|\s+const)*
488
		  }x;
489 490 491 492 493 494 495
	$NonptrTypeMisordered	= qr{
			(?:$Modifier\s+|const\s+)*
			(?:
				(?:${Misordered}\b)
			)
			(?:\s+$Modifier|\s+const)*
		  }x;
496 497 498 499 500
	$NonptrTypeWithAttr	= qr{
			(?:$Modifier\s+|const\s+)*
			(?:
				(?:typeof|__typeof__)\s*\([^\)]*\)|
				(?:$typeTypedefs\b)|
501
				(?:$typeOtherOSTypedefs\b)|
502 503 504 505
				(?:${allWithAttr}\b)
			)
			(?:\s+$Modifier|\s+const)*
		  }x;
506
	$Type	= qr{
507
			$NonptrType
508
			(?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
509
			(?:\s+$Inline|\s+$Modifier)*
510
		  }x;
511 512 513 514 515
	$TypeMisordered	= qr{
			$NonptrTypeMisordered
			(?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
			(?:\s+$Inline|\s+$Modifier)*
		  }x;
516
	$Declare	= qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
517
	$DeclareMisordered	= qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
518 519
}
build_types();
520

521
our $Typecast	= qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
522 523 524 525 526 527

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

531 532 533 534 535 536
our $declaration_macros = qr{(?x:
	(?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,2}\s*\(|
	(?:$Storage\s+)?LIST_HEAD\s*\(|
	(?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
)};

537 538 539
sub deparenthesize {
	my ($string) = @_;
	return "" if (!defined($string));
540 541 542 543 544 545

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

546
	$string =~ s@\s+@ @g;
547

548 549 550
	return $string;
}

551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
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;
569 570 571
		} 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*[;\{]/) {
572 573 574 575 576 577 578 579 580 581
			$camelcase{$1} = 1;
		}
	}
}

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

	my $files;
582 583 584 585
	my $camelcase_cache = "";
	my @include_files = ();

	$camelcase_seeded = 1;
586

587
	if (-e ".git") {
588 589
		my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
		chomp $git_last_include_commit;
590
		$camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
591
	} else {
592
		my $last_mod_date = 0;
593
		$files = `find $root/include -name "*.h"`;
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
		@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;
613
	}
614

615
	if (-e ".git") {
616 617 618 619
		$files = `git ls-files "include/*.h"`;
		@include_files = split('\n', $files);
	}

620 621 622
	foreach my $file (@include_files) {
		seed_camelcase_file($file);
	}
623

624
	if ($camelcase_cache ne "") {
625
		unlink glob ".checkpatch-camelcase.*";
626 627
		open(my $camelcase_file, '>', "$camelcase_cache")
		    or warn "$P: Can't write '$camelcase_cache' $!\n";
628 629 630 631 632
		foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
			print $camelcase_file ("$_\n");
		}
		close($camelcase_file);
	}
633 634
}

635 636 637 638 639 640 641 642 643
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);

644 645
	return ($id, $desc) if ($#lines < 0);

646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
	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);
}

665 666
$chk_signoff = 0 if ($file);

667
my @rawlines = ();
668
my @lines = ();
669
my @fixed = ();
670 671
my @fixed_inserted = ();
my @fixed_deleted = ();
672 673
my $fixlinenr = -1;

674
my $vname;
675
for my $filename (@ARGV) {
676
	my $FILE;
677
	if ($file) {
678
		open($FILE, '-|', "diff -u /dev/null $filename") ||
679
			die "$P: $filename: diff failed - $!\n";
680 681
	} elsif ($filename eq '-') {
		open($FILE, '<&STDIN');
682
	} else {
683
		open($FILE, '<', "$filename") ||
684
			die "$P: $filename: open failed - $!\n";
685
	}
686 687 688 689 690
	if ($filename eq '-') {
		$vname = 'Your patch';
	} else {
		$vname = $filename;
	}
691
	while (<$FILE>) {
692 693 694
		chomp;
		push(@rawlines, $_);
	}
695
	close($FILE);
696
	if (!process($filename)) {
697 698 699
		$exit = 1;
	}
	@rawlines = ();
700
	@lines = ();
701
	@fixed = ();
702 703
	@fixed_inserted = ();
	@fixed_deleted = ();
704
	$fixlinenr = -1;
705 706 707 708 709
}

exit($exit);

sub top_of_kernel_tree {
710 711 712 713 714 715 716 717 718 719 720 721
	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;
		}
722
	}
723
	return 1;
724
}
725

726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744
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;
745
		$name = trim($name);
746 747 748 749 750 751 752 753 754 755 756 757 758 759
		$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 = "";
		}
	}

760
	$name = trim($name);
761
	$name =~ s/^\"|\"$//g;
762
	$address = trim($address);
763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
	$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;

778
	$name = trim($name);
779
	$name =~ s/^\"|\"$//g;
780
	$address = trim($address);
781 782 783 784 785 786 787 788 789 790 791 792 793 794 795

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

796
sub which {
797
	my ($bin) = @_;
798

799 800 801 802
	foreach my $path (split(/:/, $ENV{PATH})) {
		if (-e "$path/$bin") {
			return "$path/$bin";
		}
803 804
	}

805
	return "";
806 807
}

808 809 810 811 812 813 814 815 816 817 818 819
sub which_conf {
	my ($conf) = @_;

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

	return "";
}

820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839
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;
}
840
sub copy_spacing {
841
	(my $res = shift) =~ tr/\t/ /c;
842 843
	return $res;
}
844

845 846 847 848 849 850 851 852 853 854 855 856 857
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));
}

858 859 860 861 862 863 864 865 866 867 868
my $sanitise_quote = '';

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

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
869 870 871 872 873 874
sub sanitise_line {
	my ($line) = @_;

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

875
	my $qlen = 0;
876 877
	my $off = 0;
	my $c;
878

879 880 881 882 883 884 885 886 887 888 889 890 891 892
	# 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;
893
		}
894
		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
895 896 897 898
			$sanitise_quote = '';
			substr($res, $off, 2, "$;$;");
			$off++;
			next;
899
		}
900 901 902 903 904 905 906
		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
			$sanitise_quote = '//';

			substr($res, $off, 2, $sanitise_quote);
			$off++;
			next;
		}
907 908 909 910 911 912 913

		# 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;
914
		}
915 916 917 918
		# Regular quotes.
		if ($c eq "'" || $c eq '"') {
			if ($sanitise_quote eq '') {
				$sanitise_quote = $c;
919

920 921 922 923 924 925
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
926

927
		#print "c<$c> SQ<$sanitise_quote>\n";
928 929
		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
			substr($res, $off, 1, $;);
930 931
		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
			substr($res, $off, 1, $;);
932 933 934 935 936
		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
			substr($res, $off, 1, 'X');
		} else {
			substr($res, $off, 1, $c);
		}
937 938
	}

939 940 941 942
	if ($sanitise_quote eq '//') {
		$sanitise_quote = '';
	}

943
	# The pathname on a #include may be surrounded by '<' and '>'.
944
	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
945 946 947 948
		my $clean = 'X' x length($1);
		$res =~ s@\<.*\>@<$clean>@;

	# The whole of a #error is a string.
949
	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
950
		my $clean = 'X' x length($1);
951
		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
952 953
	}

954 955 956
	return $res;
}

957 958 959
sub get_quoted_string {
	my ($line, $rawline) = @_;

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

964 965 966 967 968 969
sub ctx_statement_block {
	my ($linenr, $remain, $off) = @_;
	my $line = $linenr - 1;
	my $blk = '';
	my $soff = $off;
	my $coff = $off - 1;
970
	my $coff_set = 0;
971

972 973
	my $loff = 0;

974 975
	my $type = '';
	my $level = 0;
976
	my @stack = ();
977
	my $p;
978 979
	my $c;
	my $len = 0;
980 981

	my $remainder;
982
	while (1) {
983 984
		@stack = (['', 0]) if ($#stack == -1);

985
		#warn "CSB: blk<$blk> remain<$remain>\n";
986 987 988 989
		# If we are about to drop off the end, pull in more
		# context.
		if ($off >= $len) {
			for (; $remain > 0; $line++) {
990
				last if (!defined $lines[$line]);
991
				next if ($lines[$line] =~ /^-/);
992
				$remain--;
993
				$loff = $len;
994
				$blk .= $lines[$line] . "\n";
995 996 997 998 999 1000
				$len = length($blk);
				$line++;
				last;
			}
			# Bail if there is no further context.
			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
1001
			if ($off >= $len) {
1002 1003
				last;
			}
1004 1005 1006 1007
			if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
				$level++;
				$type = '#';
			}
1008
		}
1009
		$p = $c;
1010
		$c = substr($blk, $off, 1);
1011
		$remainder = substr($blk, $off);
1012

1013
		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1014 1015 1016 1017 1018 1019 1020 1021 1022 1023

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

1024 1025 1026 1027 1028 1029
		# Statement ends at the ';' or a close '}' at the
		# outermost level.
		if ($level == 0 && $c eq ';') {
			last;
		}

1030
		# An else is really a conditional as long as its not else if
1031 1032 1033 1034 1035 1036 1037 1038
		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";
1039 1040
		}

1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
		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;
1051 1052
				$coff_set = 1;
				#warn "CSB: mark coff<$coff>\n";
1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063
			}
		}
		if (($type eq '' || $type eq '{') && $c eq '{') {
			$level++;
			$type = '{';
		}
		if ($type eq '{' && $c eq '}') {
			$level--;
			$type = ($level != 0)? '{' : '';

			if ($level == 0) {
1064 1065 1066
				if (substr($blk, $off + 1, 1) eq ';') {
					$off++;
				}
1067 1068 1069
				last;
			}
		}
1070 1071 1072 1073 1074 1075 1076
		# Preprocessor commands end at the newline unless escaped.
		if ($type eq '#' && $c eq "\n" && $p ne "\\") {
			$level--;
			$type = '';
			$off++;
			last;
		}
1077 1078
		$off++;
	}
1079
	# We are truly at the end, so shuffle to the next line.
1080
	if ($off == $len) {
1081
		$loff = $len + 1;
1082 1083 1084
		$line++;
		$remain--;
	}
1085 1086 1087 1088 1089 1090 1091

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

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

1092
	#print "coff<$coff> soff<$off> loff<$loff>\n";
1093 1094 1095 1096 1097

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

1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
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;
	}
}

1141 1142 1143 1144 1145 1146
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

1147
	# Grab the first conditional/block pair.
1148 1149
	($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
1150
	#print "F: c<$condition> s<$statement> remain<$remain>\n";
1151 1152 1153 1154 1155 1156 1157
	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.
1158 1159 1160
	for (;;) {
		($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
1161
		#print "C: c<$condition> s<$statement> remain<$remain>\n";
1162
		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1163 1164
		#print "C: push\n";
		push(@chunks, [ $condition, $statement ]);
1165 1166 1167
	}

	return ($level, $linenr, @chunks);
1168 1169
}

1170
sub ctx_block_get {
1171
	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1172 1173 1174 1175 1176 1177 1178
	my $line;
	my $start = $linenr - 1;
	my $blk = '';
	my @o;
	my @c;
	my @res = ();

1179
	my $level = 0;
1180
	my @stack = ($level);
1181 1182 1183 1184 1185
	for ($line = $start; $remain > 0; $line++) {
		next if ($rawlines[$line] =~ /^-/);
		$remain--;

		$blk .= $rawlines[$line];
1186 1187

		# Handle nested #if/#else.
1188
		if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1189
			push(@stack, $level);
1190
		} elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1191
			$level = $stack[$#stack - 1];
1192
		} elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1193 1194 1195
			$level = pop(@stack);
		}

1196
		foreach my $c (split(//, $lines[$line])) {
1197 1198 1199 1200 1201
			##print "C<$c>L<$level><$open$close>O<$off>\n";
			if ($off > 0) {
				$off--;
				next;
			}
1202

1203 1204 1205 1206 1207 1208 1209
			if ($c eq $close && $level > 0) {
				$level--;
				last if ($level == 0);
			} elsif ($c eq $open) {
				$level++;
			}
		}
1210

1211
		if (!$outer || $level <= 1) {
1212
			push(@res, $rawlines[$line]);
1213 1214
		}

1215
		last if ($level == 0);
1216 1217
	}

1218
	return ($level, @res);
1219 1220 1221 1222
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

1223 1224
	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
	return @r;
1225 1226 1227 1228
}
sub ctx_block {
	my ($linenr, $remain) = @_;

1229 1230
	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
	return @r;
1231 1232
}
sub ctx_statement {
1233 1234 1235 1236 1237 1238
	my ($linenr, $remain, $off) = @_;

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

1241
	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1242
}
1243 1244 1245 1246 1247
sub ctx_statement_level {
	my ($linenr, $remain, $off) = @_;

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
1248 1249 1250 1251 1252

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

	# Catch a comment on the end of the line itself.
1253
	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1254 1255 1256 1257 1258 1259 1260
	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++) {
1261 1262
		my $line = $rawlines[$linenr - 1];
		#warn "           $line\n";
1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284
		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);

1285
	##print "LINE: $rawlines[$end_line - 1 ]\n";
1286 1287 1288 1289 1290
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306
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;
}

1307 1308 1309
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
1310

1311 1312 1313 1314 1315 1316
	$res = '';
	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
		$res .= $1;
		if ($2 ne '') {
			$coded = sprintf("^%c", unpack('C', $2) + 64);
			$res .= $coded;
1317 1318
		}
	}
1319
	$res =~ s/$/\$/;
1320

1321
	return $res;
1322 1323
}

1324
my $av_preprocessor = 0;
1325
my $av_pending;
1326
my @av_paren_type;
1327
my $av_pend_colon;
1328 1329 1330

sub annotate_reset {
	$av_preprocessor = 0;
1331 1332
	$av_pending = '_';
	@av_paren_type = ('E');
1333
	$av_pend_colon = 'O';
1334 1335
}

1336 1337
sub annotate_values {
	my ($stream, $type) = @_;
1338

1339
	my $res;
1340
	my $var = '_' x length($stream);
1341 1342
	my $cur = $stream;

1343
	print "$stream\n" if ($dbg_values > 1);
1344 1345

	while (length($cur)) {
1346
		@av_paren_type = ('E') if ($#av_paren_type < 0);
1347
		print " <" . join('', @av_paren_type) .
1348
				"> <$type> <$av_pending>" if ($dbg_values > 1);
1349
		if ($cur =~ /^(\s+)/o) {
1350 1351
			print "WS($1)\n" if ($dbg_values > 1);
			if ($1 =~ /\n/ && $av_preprocessor) {
1352
				$type = pop(@av_paren_type);
1353
				$av_preprocessor = 0;
1354 1355
			}

1356
		} elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1357 1358
			print "CAST($1)\n" if ($dbg_values > 1);
			push(@av_paren_type, $type);
1359
			$type = 'c';
1360

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

1365 1366 1367 1368
		} elsif ($cur =~ /^($Modifier)\s*/) {
			print "MODIFIER($1)\n" if ($dbg_values > 1);
			$type = 'T';

1369
		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1370
			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1371
			$av_preprocessor = 1;
1372 1373 1374 1375 1376 1377
			push(@av_paren_type, $type);
			if ($2 ne '') {
				$av_pending = 'N';
			}
			$type = 'E';

1378
		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1379 1380 1381
			print "UNDEF($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;
			push(@av_paren_type, $type);
1382

1383
		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1384
			print "PRE_START($1)\n" if ($dbg_values > 1);
1385
			$av_preprocessor = 1;
1386 1387 1388

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
1389
			$type = 'E';
1390

1391
		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1392 1393 1394 1395 1396
			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;

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

1397
			$type = 'E';
1398

1399
		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1400 1401 1402 1403 1404 1405 1406 1407
			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);
1408
			$type = 'E';
1409 1410

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

1413 1414 1415 1416 1417
		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
			print "ATTR($1)\n" if ($dbg_values > 1);
			$av_pending = $type;
			$type = 'N';

1418
		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1419
			print "SIZEOF($1)\n" if ($dbg_values > 1);
1420
			if (defined $2) {
1421
				$av_pending = 'V';
1422 1423 1424
			}
			$type = 'N';

1425
		} elsif ($cur =~ /^(if|while|for)\b/o) {
1426
			print "COND($1)\n" if ($dbg_values > 1);
1427
			$av_pending = 'E';
1428 1429
			$type = 'N';

1430 1431 1432 1433 1434
		} elsif ($cur =~/^(case)/o) {
			print "CASE($1)\n" if ($dbg_values > 1);
			$av_pend_colon = 'C';
			$type = 'N';

1435
		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1436
			print "KEYWORD($1)\n" if ($dbg_values > 1);
1437 1438 1439
			$type = 'N';

		} elsif ($cur =~ /^(\()/o) {
1440
			print "PAREN('$1')\n" if ($dbg_values > 1);
1441 1442
			push(@av_paren_type, $av_pending);
			$av_pending = '_';
1443 1444 1445
			$type = 'N';

		} elsif ($cur =~ /^(\))/o) {
1446 1447 1448
			my $new_type = pop(@av_paren_type);
			if ($new_type ne '_') {
				$type = $new_type;
1449 1450
				print "PAREN('$1') -> $type\n"
							if ($dbg_values > 1);
1451
			} else {
1452
				print "PAREN('$1')\n" if ($dbg_values > 1);
1453 1454
			}

1455
		} elsif ($cur =~ /^($Ident)\s*\(/o) {
1456
			print "FUNC($1)\n" if ($dbg_values > 1);
1457
			$type = 'V';
1458
			$av_pending = 'V';
1459

1460 1461
		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
			if (defined $2 && $type eq 'C' || $type eq 'T') {
1462
				$av_pend_colon = 'B';
1463 1464
			} elsif ($type eq 'E') {
				$av_pend_colon = 'L';
1465 1466 1467 1468
			}
			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
			$type = 'V';

1469
		} elsif ($cur =~ /^($Ident|$Constant)/o) {
1470
			print "IDENT($1)\n" if ($dbg_values > 1);
1471 1472 1473
			$type = 'V';

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

1477
		} elsif ($cur =~/^(;|{|})/) {
1478
			print "END($1)\n" if ($dbg_values > 1);
1479
			$type = 'E';
1480 1481
			$av_pend_colon = 'O';

1482 1483 1484 1485
		} elsif ($cur =~/^(,)/) {
			print "COMMA($1)\n" if ($dbg_values > 1);
			$type = 'C';

1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499
		} 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';
1500

1501
		} elsif ($cur =~ /^(\[)/o) {
1502
			print "CLOSE($1)\n" if ($dbg_values > 1);
1503 1504
			$type = 'N';

1505
		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517
			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';

1518
		} elsif ($cur =~ /^($Operators)/o) {
1519
			print "OP($1)\n" if ($dbg_values > 1);
1520 1521 1522 1523 1524
			if ($1 ne '++' && $1 ne '--') {
				$type = 'N';
			}

		} elsif ($cur =~ /(^.)/o) {
1525
			print "C($1)\n" if ($dbg_values > 1);
1526 1527 1528 1529 1530
		}
		if (defined $1) {
			$cur = substr($cur, length($1));
			$res .= $type x length($1);
		}
1531
	}
1532

1533
	return ($res, $var);
1534 1535
}

1536
sub possible {
1537
	my ($possible, $line) = @_;
1538
	my $notPermitted = qr{(?:
1539 1540 1541 1542
		^(?:
			$Modifier|
			$Storage|
			$Type|
1543 1544 1545
			DEFINE_\S+
		)$|
		^(?:
1546 1547 1548 1549 1550
			goto|
			return|
			case|
			else|
			asm|__asm__|
1551 1552 1553
			do|
			\#|
			\#\#|
1554
		)(?:\s|$)|
1555
		^(?:typedef|struct|enum)\b
1556 1557 1558
	    )}x;
	warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
	if ($possible !~ $notPermitted) {
1559 1560 1561 1562 1563 1564 1565
		# 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;
1566
			for my $modifier (split(' ', $possible)) {
1567 1568 1569 1570
				if ($modifier !~ $notPermitted) {
					warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
					push(@modifierList, $modifier);
				}
1571
			}
1572 1573 1574 1575 1576

		} else {
			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
			push(@typeList, $possible);
		}
1577
		build_types();
1578 1579
	} else {
		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1580 1581 1582
	}
}

1583 1584
my $prefix = '';

1585
sub show_type {
1586
	my ($type) = @_;
1587

1588 1589 1590
	return defined $use_type{$type} if (scalar keys %use_type > 0);

	return !defined $ignore_type{$type};
1591 1592
}

1593
sub report {
1594 1595 1596 1597
	my ($level, $type, $msg) = @_;

	if (!show_type($type) ||
	    (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1598 1599
		return 0;
	}
1600 1601
	my $line;
	if ($show_types) {
1602
		$line = "$prefix$level:$type: $msg\n";
1603
	} else {
1604
		$line = "$prefix$level: $msg\n";
1605
	}
1606 1607
	$line = (split('\n', $line))[0] . "\n" if ($terse);

1608
	push(our @report, $line);
1609 1610

	return 1;
1611
}
1612

1613
sub report_dump {
1614
	our @report;
1615
}
1616

1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679
sub fixup_current_range {
	my ($lineRef, $offset, $length) = @_;

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

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

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

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

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

	my @lines = ();

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

	foreach my $old_line (@{$linesRef}) {
		my $save_line = 1;
		my $line = $old_line;	#don't modify the array
		if ($line =~ /^(?:\+\+\+\|\-\-\-)\s+\S+/) {	#new filename
			$delta_offset = 0;
		} elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) {	#new hunk
			$range_last_linenr = $new_linenr;
			fixup_current_range(\$line, $delta_offset, 0);
		}

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

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

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

		$old_linenr++;
	}

	return @lines;
}

1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700
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);
}

1701
sub ERROR {
1702 1703 1704
	my ($type, $msg) = @_;

	if (report("ERROR", $type, $msg)) {
1705 1706
		our $clean = 0;
		our $cnt_error++;
1707
		return 1;
1708
	}
1709
	return 0;
1710 1711
}
sub WARN {
1712 1713 1714
	my ($type, $msg) = @_;

	if (report("WARNING", $type, $msg)) {
1715 1716
		our $clean = 0;
		our $cnt_warn++;
1717
		return 1;
1718
	}
1719
	return 0;
1720 1721
}
sub CHK {
1722 1723 1724
	my ($type, $msg) = @_;

	if ($check && report("CHECK", $type, $msg)) {
1725 1726
		our $clean = 0;
		our $cnt_chk++;
1727
		return 1;
1728
	}
1729
	return 0;
1730 1731
}

1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754
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 ".../") {
1755 1756
		WARN("USE_RELATIVE_PATH",
		     "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1757 1758 1759
	}
}

1760 1761 1762
sub trim {
	my ($string) = @_;

1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779
	$string =~ s/^\s+|\s+$//g;

	return $string;
}

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

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

	return $string;
}

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

	$string =~ s/\s+$//;
1780 1781 1782 1783

	return $string;
}

1784 1785 1786 1787 1788 1789 1790 1791
sub string_find_replace {
	my ($string, $find, $replace) = @_;

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

	return $string;
}

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

1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833
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;
		}
	}

1834
	return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
1835 1836
}

1837 1838 1839 1840 1841
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
1842
	my $prevrawline="";
1843
	my $stashline="";
1844
	my $stashrawline="";
1845

1846
	my $length;
1847 1848 1849 1850
	my $indent;
	my $previndent=0;
	my $stashindent=0;

1851
	our $clean = 1;
1852 1853 1854
	my $signoff = 0;
	my $is_patch = 0;

1855
	my $in_header_lines = $file ? 0 : 1;
1856
	my $in_commit_log = 0;		#Scanning lines before patch
1857
	my $reported_maintainer_file = 0;
1858 1859
	my $non_utf8_charset = 0;

1860
	my $last_blank_line = 0;
1861
	my $last_coalesced_string_linenr = -1;
1862

1863
	our @report = ();
1864 1865 1866 1867 1868
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

1869 1870 1871 1872 1873 1874
	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
	my $in_comment = 0;
1875
	my $comment_edge = 0;
1876
	my $first_line = 0;
1877
	my $p1_prefix = '';
1878

1879 1880 1881
	my $prev_values = 'E';

	# suppression flags
1882
	my %suppress_ifbraces;
1883
	my %suppress_whiletrailers;
1884
	my %suppress_export;
1885
	my $suppress_statement = 0;
1886

1887
	my %signatures = ();
1888

1889
	# Pre-scan the patch sanitizing the lines.
1890
	# Pre-scan the patch looking for any __setup documentation.
1891
	#
1892 1893
	my @setup_docs = ();
	my $setup_docs = 0;
1894

1895 1896
	my $camelcase_file_seeded = 0;

1897
	sanitise_line_reset();
1898 1899
	my $line;
	foreach my $rawline (@rawlines) {
1900 1901
		$linenr++;
		$line = $rawline;
1902

1903 1904
		push(@fixed, $rawline) if ($fix);

1905
		if ($rawline=~/^\+\+\+\s+(\S+)/) {
1906 1907 1908 1909
			$setup_docs = 0;
			if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
				$setup_docs = 1;
			}
1910 1911 1912 1913 1914 1915 1916 1917 1918
			#next;
		}
		if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1919
			$in_comment = 0;
1920 1921 1922 1923 1924 1925

			# 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;
1926 1927 1928 1929 1930 1931
			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";
1932
				last if (!defined $rawlines[$ln - 1]);
1933 1934 1935 1936 1937
				if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
				    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
					($edge) = $1;
					last;
				}
1938 1939 1940 1941 1942 1943 1944 1945 1946
			}
			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 &&
1947
			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1948 1949 1950 1951 1952 1953 1954
			{
				$in_comment = 1;
			}

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

1955
		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1956
			# Standardise the strings and chars within the input to
1957
			# simplify matching -- only bother with positive lines.
1958
			$line = sanitise_line($rawline);
1959
		}
1960 1961 1962 1963 1964 1965 1966 1967 1968 1969
		push(@lines, $line);

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

		#print "==>$rawline\n";
		#print "-->$line\n";
1970 1971 1972 1973 1974 1975

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

1976 1977
	$prefix = '';

1978 1979
	$realcnt = 0;
	$linenr = 0;
1980
	$fixlinenr = -1;
1981 1982
	foreach my $line (@lines) {
		$linenr++;
1983
		$fixlinenr++;
1984 1985
		my $sline = $line;	#copy of $line
		$sline =~ s/$;/ /g;	#with comments as spaces
1986

1987
		my $rawline = $rawlines[$linenr - 1];
1988

1989
#extract the line range in the file after the patch is applied
1990
		if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1991
			$is_patch = 1;
1992
			$first_line = $linenr + 1;
1993 1994 1995 1996 1997 1998
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1999
			annotate_reset();
2000 2001
			$prev_values = 'E';

2002
			%suppress_ifbraces = ();
2003
			%suppress_whiletrailers = ();
2004
			%suppress_export = ();
2005
			$suppress_statement = 0;
2006 2007
			next;

2008 2009 2010
# 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.
2011
		} elsif ($line =~ /^( |\+|$)/) {
2012
			$realline++;
2013
			$realcnt-- if ($realcnt != 0);
2014

2015
			# Measure the line length and indent.
2016
			($length, $indent) = line_stats($rawline);
2017 2018 2019 2020

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

2023
			#warn "line<$line>\n";
2024

2025 2026
		} elsif ($realcnt == 1) {
			$realcnt--;
2027 2028
		}

2029 2030
		my $hunk_line = ($realcnt != 0);

2031
#make up the handle for any error we report on this line
2032 2033 2034
		$prefix = "$filename:$realline: " if ($emacs && $file);
		$prefix = "$filename:$linenr: " if ($emacs && !$file);

2035 2036
		$here = "#$linenr: " if (!$file);
		$here = "#$realline: " if ($file);
2037

2038
		my $found_file = 0;
2039
		# extract the filename as it passes
2040 2041
		if ($line =~ /^diff --git.*?(\S+)$/) {
			$realfile = $1;
2042
			$realfile =~ s@^([^/]*)/@@ if (!$file);
2043
			$in_commit_log = 0;
2044
			$found_file = 1;
2045
		} elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2046
			$realfile = $1;
2047
			$realfile =~ s@^([^/]*)/@@ if (!$file);
2048
			$in_commit_log = 0;
2049 2050

			$p1_prefix = $1;
2051 2052
			if (!$file && $tree && $p1_prefix ne '' &&
			    -e "$root/$p1_prefix") {
2053 2054
				WARN("PATCH_PREFIX",
				     "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2055
			}
2056

2057
			if ($realfile =~ m@^include/asm/@) {
2058 2059
				ERROR("MODIFIED_INCLUDE_ASM",
				      "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2060
			}
2061 2062 2063 2064 2065 2066 2067 2068 2069
			$found_file = 1;
		}

		if ($found_file) {
			if ($realfile =~ m@^(drivers/net/|net/)@) {
				$check = 1;
			} else {
				$check = $check_orig;
			}
2070 2071 2072
			next;
		}

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

2075 2076 2077
		my $hereline = "$here\n$rawline\n";
		my $herecurr = "$here\n$rawline\n";
		my $hereprev = "$here\n$prevrawline\n$rawline\n";
2078

2079 2080
		$cnt_lines++ if ($realcnt != 0);

2081 2082 2083
# Check for incorrect file permissions
		if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
			my $permhere = $here . "FILE: $realfile\n";
2084 2085
			if ($realfile !~ m@scripts/@ &&
			    $realfile !~ /\.(py|pl|awk|sh)$/) {
2086 2087
				ERROR("EXECUTE_PERMISSIONS",
				      "do not set execute permissions for source files\n" . $permhere);
2088 2089 2090
			}
		}

2091
# Check the patch for a signoff:
2092
		if ($line =~ /^\s*signed-off-by:/i) {
2093
			$signoff++;
2094
			$in_commit_log = 0;
2095 2096
		}

2097 2098 2099 2100 2101 2102
# 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;
		}

2103
# Check signature styles
2104
		if (!$in_header_lines &&
2105
		    $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2106 2107 2108 2109 2110 2111
			my $space_before = $1;
			my $sign_off = $2;
			my $space_after = $3;
			my $email = $4;
			my $ucfirst_sign_off = ucfirst(lc($sign_off));

2112 2113 2114 2115
			if ($sign_off !~ /$signature_tags/) {
				WARN("BAD_SIGN_OFF",
				     "Non-standard signature: $sign_off\n" . $herecurr);
			}
2116
			if (defined $space_before && $space_before ne "") {
2117 2118 2119
				if (WARN("BAD_SIGN_OFF",
					 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
				    $fix) {
2120
					$fixed[$fixlinenr] =
2121 2122
					    "$ucfirst_sign_off $email";
				}
2123 2124
			}
			if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2125 2126 2127
				if (WARN("BAD_SIGN_OFF",
					 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
				    $fix) {
2128
					$fixed[$fixlinenr] =
2129 2130 2131
					    "$ucfirst_sign_off $email";
				}

2132 2133
			}
			if (!defined $space_after || $space_after ne " ") {
2134 2135 2136
				if (WARN("BAD_SIGN_OFF",
					 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
				    $fix) {
2137
					$fixed[$fixlinenr] =
2138 2139
					    "$ucfirst_sign_off $email";
				}
2140
			}
2141 2142 2143 2144

			my ($email_name, $email_address, $comment) = parse_email($email);
			my $suggested_email = format_email(($email_name, $email_address));
			if ($suggested_email eq "") {
2145 2146
				ERROR("BAD_SIGN_OFF",
				      "Unrecognized email address: '$email'\n" . $herecurr);
2147 2148 2149 2150 2151 2152 2153 2154 2155
			} 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) {
2156 2157
					WARN("BAD_SIGN_OFF",
					     "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2158
				}
2159
			}
2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170

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

2173 2174 2175 2176 2177 2178 2179
# 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);
		}

2180 2181 2182 2183 2184 2185
# 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);
		}

2186 2187 2188 2189 2190 2191
# 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);
		}

2192 2193
# Check for git id commit length and improperly formed commit descriptions
		if ($in_commit_log && $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i) {
2194 2195
			my $init_char = $1;
			my $orig_commit = lc($2);
2196 2197 2198 2199 2200
			my $short = 1;
			my $long = 0;
			my $case = 1;
			my $space = 1;
			my $hasdesc = 0;
2201
			my $hasparens = 0;
2202 2203 2204 2205 2206 2207 2208 2209 2210 2211
			my $id = '0123456789ab';
			my $orig_desc = "commit description";
			my $description = "";

			$short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
			$long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
			$space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
			$case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
			if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
				$orig_desc = $1;
2212
				$hasparens = 1;
2213 2214 2215 2216
			} elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
				 defined $rawlines[$linenr] &&
				 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
				$orig_desc = $1;
2217
				$hasparens = 1;
2218 2219 2220 2221 2222 2223 2224
			} 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;
2225
				$hasparens = 1;
2226 2227 2228 2229 2230
			}

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

2231
			if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
2232 2233 2234
				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);
			}
2235 2236
		}

2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247
# 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);
		}

2248
# Check for wrappage within a valid hunk of the file
2249
		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2250 2251
			ERROR("CORRUPTED_PATCH",
			      "patch seems to be corrupt (line wrapped?)\n" .
2252
				$herecurr) if (!$emitted_corrupt++);
2253 2254
		}

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

2269 2270
# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2271 2272 2273 2274 2275 2276 2277
		    $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";

2278 2279
			CHK("INVALID_UTF8",
			    "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2280 2281
		}

2282 2283 2284
# 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 =~ /^$/ &&
2285 2286
		    !($rawline =~ /^\s+\S/ ||
		      $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
2287 2288 2289 2290
			$in_header_lines = 0;
			$in_commit_log = 1;
		}

2291 2292 2293 2294 2295 2296 2297 2298 2299
# 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 =~ /^$/ &&
2300
		    $rawline =~ /$NON_ASCII_UTF8/) {
2301
			WARN("UTF8_BEFORE_PATCH",
2302 2303 2304
			    "8-bit UTF-8 used in possible commit log\n" . $herecurr);
		}

2305
# Check for various typo / spelling mistakes
2306 2307
		if (defined($misspellings) &&
		    ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322
			while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:$|[^a-z@])/gi) {
				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/;
				}
			}
		}

2323 2324
# ignore non-hunk lines and lines being removed
		next if (!$hunk_line || $line =~ /^-/);
2325 2326

#trailing whitespace
2327
		if ($line =~ /^\+.*\015/) {
2328
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2329 2330 2331
			if (ERROR("DOS_LINE_ENDINGS",
				  "DOS line endings\n" . $herevet) &&
			    $fix) {
2332
				$fixed[$fixlinenr] =~ s/[\s\015]+$//;
2333
			}
2334 2335
		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2336 2337 2338
			if (ERROR("TRAILING_WHITESPACE",
				  "trailing whitespace\n" . $herevet) &&
			    $fix) {
2339
				$fixed[$fixlinenr] =~ s/\s+$//;
2340 2341
			}

2342
			$rpt_cleaners = 1;
2343
		}
2344

2345
# Check for FSF mailing addresses.
2346
		if ($rawline =~ /\bwrite to the Free/i ||
2347 2348
		    $rawline =~ /\b59\s+Temple\s+Pl/i ||
		    $rawline =~ /\b51\s+Franklin\s+St/i) {
2349 2350 2351 2352
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
			my $msg_type = \&ERROR;
			$msg_type = \&CHK if ($file);
			&{$msg_type}("FSF_MAILING_ADDRESS",
2353
				     "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)
2354 2355
		}

2356
# check for Kconfig help text having a real description
2357 2358
# Only applies when adding the entry originally, after that we do not have
# sufficient context to determine whether it is indeed long enough.
2359
		if ($realfile =~ /Kconfig/ &&
2360
		    $line =~ /^\+\s*config\s+/) {
2361
			my $length = 0;
2362 2363 2364
			my $cnt = $realcnt;
			my $ln = $linenr + 1;
			my $f;
2365
			my $is_start = 0;
2366
			my $is_end = 0;
2367
			for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2368 2369 2370 2371 2372
				$f = $lines[$ln - 1];
				$cnt-- if ($lines[$ln - 1] !~ /^-/);
				$is_end = $lines[$ln - 1] =~ /^\+/;

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

2375
				if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
2376
					$is_start = 1;
2377
				} elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
2378 2379 2380
					$length = -1;
				}

2381
				$f =~ s/^.//;
2382 2383 2384
				$f =~ s/#.*//;
				$f =~ s/^\s+//;
				next if ($f =~ /^$/);
2385 2386 2387 2388
				if ($f =~ /^\s*config\s/) {
					$is_end = 1;
					last;
				}
2389 2390
				$length++;
			}
2391 2392 2393 2394
			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);
			}
2395
			#print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2396 2397
		}

2398 2399 2400 2401 2402 2403 2404
# 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");
		}

2405 2406 2407 2408 2409 2410 2411
# 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);
		}

2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425
		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});
		}

2426
# check for DT compatible documentation
2427 2428 2429 2430
		if (defined $root &&
			(($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
			 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {

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

2433 2434 2435
			my $dt_path = $root . "/Documentation/devicetree/bindings/";
			my $vp_file = $dt_path . "vendor-prefixes.txt";

2436 2437
			foreach my $compat (@compats) {
				my $compat2 = $compat;
2438 2439 2440 2441
				$compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
				my $compat3 = $compat;
				$compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
				`grep -Erq "$compat|$compat2|$compat3" $dt_path`;
2442 2443 2444 2445 2446
				if ( $? >> 8 ) {
					WARN("UNDOCUMENTED_DT_STRING",
					     "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
				}

2447 2448
				next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
				my $vendor = $1;
2449
				`grep -Eq "^$vendor\\b" $vp_file`;
2450 2451
				if ( $? >> 8 ) {
					WARN("UNDOCUMENTED_DT_STRING",
2452
					     "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2453 2454 2455 2456
				}
			}
		}

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

2460
#line length limit
2461
		if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
2462
		    $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
2463
		    !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
2464
		    $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
2465
		    $length > $max_line_length)
2466
		{
2467
			WARN("LONG_LINE",
2468
			     "line over $max_line_length characters\n" . $herecurr);
2469 2470
		}

2471 2472
# check for adding lines without a newline.
		if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2473 2474
			WARN("MISSING_EOF_NEWLINE",
			     "adding a line without newline at end of file\n" . $herecurr);
2475 2476
		}

2477 2478 2479 2480
# 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";
2481 2482
				ERROR("LO_MACRO",
				      "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2483 2484 2485
			}
			if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
				my $herevet = "$here\n" . cat_vet($line) . "\n";
2486 2487
				ERROR("HI_MACRO",
				      "use the HI() macro, not (... >> 16)\n" . $herevet);
2488 2489 2490
			}
		}

2491
# check we are in a valid source file C or perl if not then ignore this hunk
2492
		next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
2493 2494 2495

# at the beginning of a line any tabs must come first and anything
# more than 8 must use tabs.
2496 2497 2498
		if ($rawline =~ /^\+\s* \t\s*\S/ ||
		    $rawline =~ /^\+\s*        \s*/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2499
			$rpt_cleaners = 1;
2500 2501 2502
			if (ERROR("CODE_INDENT",
				  "code indent should use tabs where possible\n" . $herevet) &&
			    $fix) {
2503
				$fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2504
			}
2505 2506
		}

2507 2508 2509
# check for space before tabs.
		if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2510 2511 2512
			if (WARN("SPACE_BEFORE_TAB",
				"please, no space before tabs\n" . $herevet) &&
			    $fix) {
2513
				while ($fixed[$fixlinenr] =~
2514
					   s/(^\+.*) {8,8}\t/$1\t\t/) {}
2515
				while ($fixed[$fixlinenr] =~
2516
					   s/(^\+.*) +\t/$1\t/) {}
2517
			}
2518 2519
		}

2520 2521 2522 2523 2524 2525 2526 2527
# check for && or || at the start of a line
		if ($rawline =~ /^\+\s*(&&|\|\|)/) {
			CHK("LOGICAL_CONTINUATIONS",
			    "Logical continuations should be on the previous line\n" . $hereprev);
		}

# check multi-line statement indentation matches previous line
		if ($^V && $^V ge 5.10.0 &&
2528
		    $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2529 2530 2531 2532 2533 2534
			$prevline =~ /^\+(\t*)(.*)$/;
			my $oldindent = $1;
			my $rest = $2;

			my $pos = pos_last_openparen($rest);
			if ($pos >= 0) {
J
Joe Perches 已提交
2535 2536
				$line =~ /^(\+| )([ \t]*)/;
				my $newindent = $2;
2537 2538 2539 2540 2541 2542 2543 2544

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

				if ($newindent ne $goodtabindent &&
				    $newindent ne $goodspaceindent) {
2545 2546 2547 2548

					if (CHK("PARENTHESIS_ALIGNMENT",
						"Alignment should match open parenthesis\n" . $hereprev) &&
					    $fix && $line =~ /^\+/) {
2549
						$fixed[$fixlinenr] =~
2550 2551
						    s/^\+[ \t]*/\+$goodtabindent/;
					}
2552 2553 2554 2555
				}
			}
		}

2556 2557 2558 2559 2560 2561 2562 2563 2564
# 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*$/)) {
2565
			if (CHK("SPACING",
2566
				"No space is necessary after a cast\n" . $herecurr) &&
2567
			    $fix) {
2568
				$fixed[$fixlinenr] =~
2569
				    s/(\(\s*$Type\s*\))[ \t]+/$1/;
2570
			}
2571 2572
		}

2573
		if ($realfile =~ m@^(drivers/net/|net/)@ &&
2574
		    $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2575 2576
		    $rawline =~ /^\+[ \t]*\*/ &&
		    $realline > 2) {
2577 2578 2579 2580 2581
			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
			     "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
		}

		if ($realfile =~ m@^(drivers/net/|net/)@ &&
2582 2583
		    $prevrawline =~ /^\+[ \t]*\/\*/ &&		#starting /*
		    $prevrawline !~ /\*\/[ \t]*$/ &&		#no trailing */
2584
		    $rawline =~ /^\+/ &&			#line is new
2585 2586 2587 2588 2589 2590
		    $rawline !~ /^\+[ \t]*\*/) {		#no leading *
			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
			     "networking block comments start with * on subsequent lines\n" . $hereprev);
		}

		if ($realfile =~ m@^(drivers/net/|net/)@ &&
2591 2592 2593 2594
		    $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ &&	#trailing */
		    $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ &&	#inline /*...*/
		    $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ &&	#trailing **/
		    $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) {	#non blank */
2595 2596 2597 2598
			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
			     "networking block comments put the trailing */ on a separate line\n" . $herecurr);
		}

2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610
# 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/)) {
2611 2612 2613
			if (CHK("LINE_SPACING",
				"Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
			    $fix) {
2614
				fix_insert_line($fixlinenr, "\+");
2615
			}
2616 2617
		}

2618 2619 2620 2621
# check for multiple consecutive blank lines
		if ($prevline =~ /^[\+ ]\s*$/ &&
		    $line =~ /^\+\s*$/ &&
		    $last_blank_line != ($linenr - 1)) {
2622 2623 2624
			if (CHK("LINE_SPACING",
				"Please don't use multiple blank lines\n" . $hereprev) &&
			    $fix) {
2625
				fix_delete_line($fixlinenr, $rawline);
2626 2627
			}

2628 2629 2630
			$last_blank_line = $linenr;
		}

2631
# check for missing blank lines after declarations
2632 2633 2634
		if ($sline =~ /^\+\s+\S/ &&			#Not at char 1
			# actual declarations
		    ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2635 2636
			# function pointer declarations
		     $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648
			# 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*[=,;:\[]/ ||
2649 2650
			# function pointer declarations
		      $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2651 2652 2653 2654 2655
			# 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
2656
		      $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
2657 2658 2659 2660 2661 2662 2663 2664
			# 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/)) {
2665 2666 2667
			if (WARN("LINE_SPACING",
				 "Missing a blank line after declarations\n" . $hereprev) &&
			    $fix) {
2668
				fix_insert_line($fixlinenr, "\+");
2669
			}
2670 2671
		}

2672
# check for spaces at the beginning of a line.
2673 2674 2675 2676
# Exceptions:
#  1) within comments
#  2) indented preprocessor commands
#  3) hanging labels
2677
		if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/)  {
2678
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2679 2680 2681
			if (WARN("LEADING_SPACE",
				 "please, no spaces at the start of a line\n" . $herevet) &&
			    $fix) {
2682
				$fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2683
			}
2684 2685
		}

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

2689
# check indentation of any line with a bare else
2690
# (but not if it is a multiple line "if (foo) return bar; else return baz;")
2691 2692 2693
# 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;
2694 2695 2696 2697
			if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
			    ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
			     defined $lines[$linenr] &&
			     $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
2698 2699 2700 2701 2702
				WARN("UNNECESSARY_ELSE",
				     "else is not generally useful after a break or return\n" . $hereprev);
			}
		}

2703 2704 2705 2706 2707 2708 2709 2710 2711 2712
# 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);
			}
		}

2713 2714 2715 2716 2717 2718
# 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");
		}

2719
# check for RCS/CVS revision markers
2720
		if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
2721 2722
			WARN("CVS_KEYWORD",
			     "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
2723
		}
2724

2725 2726 2727
# Blackfin: don't use __builtin_bfin_[cs]sync
		if ($line =~ /__builtin_bfin_csync/) {
			my $herevet = "$here\n" . cat_vet($line) . "\n";
2728 2729
			ERROR("CSYNC",
			      "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
2730 2731 2732
		}
		if ($line =~ /__builtin_bfin_ssync/) {
			my $herevet = "$here\n" . cat_vet($line) . "\n";
2733 2734
			ERROR("SSYNC",
			      "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
2735 2736
		}

2737 2738 2739 2740 2741 2742
# 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);
		}

2743
# Check for potential 'bare' types
2744 2745
		my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
		    $realline_next);
2746 2747
#print "LINE<$line>\n";
		if ($linenr >= $suppress_statement &&
2748
		    $realcnt && $sline =~ /.\s*\S/) {
2749
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2750
				ctx_statement_block($linenr, $realcnt, 0);
2751 2752 2753
			$stat =~ s/\n./\n /g;
			$cond =~ s/\n./\n /g;

2754 2755 2756 2757 2758 2759 2760 2761 2762
#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;
			}
2763

2764 2765 2766 2767 2768 2769 2770 2771
			# 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++;
			}

2772 2773
			my $s = $stat;
			$s =~ s/{.*$//s;
2774

2775
			# Ignore goto labels.
2776
			if ($s =~ /$Ident:\*$/s) {
2777 2778

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

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

2783
			# declarations always start with types
2784
			} 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) {
2785 2786 2787 2788
				my $type = $1;
				$type =~ s/\s+/ /g;
				possible($type, "A:" . $s);

2789
			# definitions in global scope can only start with types
2790
			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
2791
				possible($1, "B:" . $s);
2792
			}
2793 2794

			# any (foo ... *) is a pointer cast, and foo is a type
2795
			while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
2796
				possible($1, "C:" . $s);
2797 2798 2799 2800 2801
			}

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

2805
				my $ctx = $s;
2806
				substr($ctx, 0, $name_len + 1, '');
2807
				$ctx =~ s/\)[^\)]*$//;
2808

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

2812
						possible($1, "D:" . $s);
2813 2814
					}
				}
2815
			}
2816

2817 2818
		}

2819 2820 2821
#
# Checks which may be anchored in the context.
#
2822

2823 2824
# Check for switch () and associated case and default
# statements should be at the same indent.
2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840
		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 '') {
2841 2842
				ERROR("SWITCH_CASE_INDENT_LEVEL",
				      "switch and case should be at the same indent\n$hereline$err");
2843 2844 2845 2846 2847
			}
		}

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

2851
			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2852 2853 2854 2855 2856 2857

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

2858 2859 2860
			my $ctx_cnt = $realcnt - $#ctx - 1;
			my $ctx = join("\n", @ctx);

2861 2862
			my $ctx_ln = $linenr;
			my $ctx_skip = $realcnt;
2863

2864 2865 2866 2867 2868
			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] !~ /^-/);
2869 2870
				$ctx_ln++;
			}
2871

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

2875
			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2876 2877
				ERROR("OPEN_BRACE",
				      "that open brace { should be on the previous line\n" .
2878
					"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2879
			}
2880 2881 2882 2883
			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
			    $ctx =~ /\)\s*\;\s*$/ &&
			    defined $lines[$ctx_ln - 1])
			{
2884 2885
				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
				if ($nindent > $indent) {
2886 2887
					WARN("TRAILING_SEMICOLON",
					     "trailing semicolon indicates no statements, indent implies otherwise\n" .
2888
						"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2889 2890
				}
			}
2891 2892
		}

2893
# Check relative indent for conditionals and blocks.
2894
		if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2895 2896 2897
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
2898 2899 2900 2901 2902 2903 2904 2905 2906 2907
			my ($s, $c) = ($stat, $cond);

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

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

			# Find out how long the conditional actually is.
2908 2909
			my @newlines = ($c =~ /\n/gs);
			my $cond_lines = 1 + $#newlines;
2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922

			# 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;
			}
2923
			if ($s =~ s/^\s*?\n//) {
2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934
				$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;
			}

2935
			my $cond_ptr = -1;
2936
			$continuation = 0;
2937 2938 2939
			while ($cond_ptr != $cond_lines) {
				$cond_ptr = $cond_lines;

2940 2941 2942 2943 2944 2945
				# If we see an #else/#elif then the code
				# is not linear.
				if ($s =~ /^\s*\#\s*(?:else|elif)/) {
					$check = 0;
				}

2946 2947 2948 2949
				# Ignore:
				#  1) blank lines, they should be at 0,
				#  2) preprocessor lines, and
				#  3) labels.
2950 2951
				if ($continuation ||
				    $s =~ /^\s*?\n/ ||
2952 2953
				    $s =~ /^\s*#\s*?/ ||
				    $s =~ /^\s*$Ident\s*:/) {
2954
					$continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2955 2956 2957
					if ($s =~ s/^.*?\n//) {
						$cond_lines++;
					}
2958
				}
2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973
			}

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

2974
			#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";
2975 2976 2977

			if ($check && (($sindent % 8) != 0 ||
			    ($sindent <= $indent && $s ne ''))) {
2978 2979
				WARN("SUSPECT_CODE_INDENT",
				     "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2980 2981 2982
			}
		}

2983 2984
		# Track the 'values' across context and added lines.
		my $opline = $line; $opline =~ s/^./ /;
2985 2986
		my ($curr_values, $curr_vars) =
				annotate_values($opline . "\n", $prev_values);
2987
		$curr_values = $prev_values . $curr_values;
2988 2989
		if ($dbg_values) {
			my $outline = $opline; $outline =~ s/\t/ /g;
2990 2991
			print "$linenr > .$outline\n";
			print "$linenr > $curr_values\n";
2992
			print "$linenr >  $curr_vars\n";
2993
		}
2994 2995
		$prev_values = substr($curr_values, -1);

2996
#ignore lines not being added
2997
		next if ($line =~ /^[^\+]/);
2998

2999
# TEST: allow direct testing of the type matcher.
3000 3001
		if ($dbg_type) {
			if ($line =~ /^.\s*$Declare\s*$/) {
3002 3003
				ERROR("TEST_TYPE",
				      "TEST: is type\n" . $herecurr);
3004
			} elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3005 3006
				ERROR("TEST_NOT_TYPE",
				      "TEST: is not type ($1 is)\n". $herecurr);
3007
			}
3008 3009
			next;
		}
3010 3011
# TEST: allow direct testing of the attribute matcher.
		if ($dbg_attr) {
3012
			if ($line =~ /^.\s*$Modifier\s*$/) {
3013 3014
				ERROR("TEST_ATTR",
				      "TEST: is attr\n" . $herecurr);
3015
			} elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3016 3017
				ERROR("TEST_NOT_ATTR",
				      "TEST: is not attr ($1 is)\n". $herecurr);
3018 3019 3020
			}
			next;
		}
3021

3022
# check for initialisation to aggregates open brace on the next line
3023 3024
		if ($line =~ /^.\s*{/ &&
		    $prevline =~ /(?:^|[^=])=\s*$/) {
3025 3026
			if (ERROR("OPEN_BRACE",
				  "that open brace { should be on the previous line\n" . $hereprev) &&
3027 3028 3029
			    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
				fix_delete_line($fixlinenr - 1, $prevrawline);
				fix_delete_line($fixlinenr, $rawline);
3030 3031
				my $fixedline = $prevrawline;
				$fixedline =~ s/\s*=\s*$/ = {/;
3032
				fix_insert_line($fixlinenr, $fixedline);
3033 3034
				$fixedline = $line;
				$fixedline =~ s/^(.\s*){\s*/$1/;
3035
				fix_insert_line($fixlinenr, $fixedline);
3036
			}
3037 3038
		}

3039 3040 3041 3042 3043
#
# Checks which are anchored on the added line.
#

# check for malformed paths in #include statements (uses RAW line)
3044
		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3045 3046
			my $path = $1;
			if ($path =~ m{//}) {
3047
				ERROR("MALFORMED_INCLUDE",
3048 3049 3050 3051 3052
				      "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);
3053 3054
			}
		}
3055

3056
# no C99 // comments
3057
		if ($line =~ m{//}) {
3058 3059 3060
			if (ERROR("C99_COMMENTS",
				  "do not use C99 // comments\n" . $herecurr) &&
			    $fix) {
3061
				my $line = $fixed[$fixlinenr];
3062 3063
				if ($line =~ /\/\/(.*)$/) {
					my $comment = trim($1);
3064
					$fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3065 3066
				}
			}
3067
		}
3068
		# Remove C99 comments.
3069
		$line =~ s@//.*@@;
3070
		$opline =~ s@//.*@@;
3071

3072 3073 3074 3075 3076 3077 3078 3079
# 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.*\((.*)\)/)) {
3080 3081 3082 3083
			# Handle definitions which produce identifiers with
			# a prefix:
			#   XXX(foo);
			#   EXPORT_SYMBOL(something_foo);
3084
			my $name = $1;
3085
			if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3086 3087 3088 3089 3090
			    $name =~ /^${Ident}_$2/) {
#print "FOO C name<$name>\n";
				$suppress_export{$realline_next} = 1;

			} elsif ($stat !~ /(?:
3091
				\n.}\s*$|
3092 3093 3094
				^.DEFINE_$Ident\(\Q$name\E\)|
				^.DECLARE_$Ident\(\Q$name\E\)|
				^.LIST_HEAD\(\Q$name\E\)|
3095 3096
				^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
				\b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
3097
			    )/x) {
3098 3099 3100 3101
#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
				$suppress_export{$realline_next} = 2;
			} else {
				$suppress_export{$realline_next} = 1;
3102 3103
			}
		}
3104 3105 3106 3107 3108 3109 3110 3111 3112
		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) {
3113 3114
			WARN("EXPORT_SYMBOL",
			     "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3115
		}
3116

3117
# check for global initialisers.
3118 3119 3120 3121 3122
		if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
			if (ERROR("GLOBAL_INITIALISERS",
				  "do not initialise globals to 0 or NULL\n" .
				      $herecurr) &&
			    $fix) {
3123
				$fixed[$fixlinenr] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
3124
			}
3125
		}
3126
# check for static initialisers.
3127 3128 3129 3130 3131
		if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
			if (ERROR("INITIALISED_STATIC",
				  "do not initialise statics to 0 or NULL\n" .
				      $herecurr) &&
			    $fix) {
3132
				$fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
3133
			}
3134 3135
		}

3136 3137 3138 3139 3140 3141 3142
# 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);
		}

3143 3144
# check for static const char * arrays.
		if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3145 3146
			WARN("STATIC_CONST_CHAR_ARRAY",
			     "static const char * array should probably be static const char * const\n" .
3147 3148 3149 3150 3151
				$herecurr);
               }

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

3157 3158 3159 3160 3161 3162 3163
# 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);
               }

3164 3165 3166 3167 3168
# 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) {
3169
				$fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
3170 3171 3172
			}
		}

3173 3174 3175 3176 3177
# 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) {
3178
				$fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
3179
			}
3180 3181
		}

3182 3183 3184
# check for new typedefs, only function parameters and sparse annotations
# make sense.
		if ($line =~ /\btypedef\s/ &&
3185
		    $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
3186
		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
3187
		    $line !~ /\b$typeTypedefs\b/ &&
3188
		    $line !~ /\b$typeOtherOSTypedefs\b/ &&
3189
		    $line !~ /\b__bitwise(?:__|)\b/) {
3190 3191
			WARN("NEW_TYPEDEFS",
			     "do not add new typedefs\n" . $herecurr);
3192 3193 3194
		}

# * goes on variable not on type
3195
		# (char*[ const])
3196 3197
		while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
			#print "AA<$1>\n";
3198
			my ($ident, $from, $to) = ($1, $2, $2);
3199 3200 3201 3202 3203 3204

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

3208
##			print "1: from<$from> to<$to> ident<$ident>\n";
3209
			if ($from ne $to) {
3210 3211 3212 3213 3214 3215
				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/;
3216
					$fixed[$fixlinenr] =~
3217 3218
					    s@\Q$sub_from\E@$sub_to@;
				}
3219
			}
3220 3221 3222
		}
		while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
			#print "BB<$1>\n";
3223
			my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
3224 3225 3226 3227 3228 3229

			# Should start with a space.
			$to =~ s/^(\S)/ $1/;
			# Should not end with a space.
			$to =~ s/\s+$//;
			# '*'s should not have spaces between.
3230
			while ($to =~ s/\*\s+\*/\*\*/) {
3231 3232 3233
			}
			# Modifiers should have spaces.
			$to =~ s/(\b$Modifier$)/$1 /;
3234

3235
##			print "2: from<$from> to<$to> ident<$ident>\n";
3236
			if ($from ne $to && $ident !~ /^$Modifier$/) {
3237 3238 3239 3240 3241 3242 3243
				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/;
3244
					$fixed[$fixlinenr] =~
3245 3246
					    s@\Q$sub_from\E@$sub_to@;
				}
3247
			}
3248 3249 3250 3251 3252 3253 3254 3255 3256
		}

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

3257
		if ($line =~ /\bLINUX_VERSION_CODE\b/) {
3258 3259
			WARN("LINUX_VERSION_CODE",
			     "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3260 3261
		}

3262 3263
# check for uses of printk_ratelimit
		if ($line =~ /\bprintk_ratelimit\s*\(/) {
3264
			WARN("PRINTK_RATELIMITED",
3265
			     "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
3266 3267
		}

3268 3269 3270
# 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 已提交
3271
# printk includes all preceding printk's which have no newline on the end.
3272
# we assume the first bad printk is the one to report.
3273
		if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
3274 3275 3276
			my $ok = 0;
			for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
				#print "CHECK<$lines[$ln - 1]\n";
L
Lucas De Marchi 已提交
3277
				# we have a preceding printk if it ends
3278 3279 3280 3281 3282 3283 3284 3285 3286
				# 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) {
3287 3288
				WARN("PRINTK_WITHOUT_KERN_LEVEL",
				     "printk() should include KERN_ facility level\n" . $herecurr);
3289
			}
3290 3291
		}

3292 3293 3294 3295
		if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
			my $orig = $1;
			my $level = lc($orig);
			$level = "warn" if ($level eq "warning");
3296 3297
			my $level2 = $level;
			$level2 = "dbg" if ($level eq "debug");
3298
			WARN("PREFER_PR_LEVEL",
3299
			     "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(...  to printk(KERN_$orig ...\n" . $herecurr);
3300 3301 3302
		}

		if ($line =~ /\bpr_warning\s*\(/) {
3303 3304 3305
			if (WARN("PREFER_PR_LEVEL",
				 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
			    $fix) {
3306
				$fixed[$fixlinenr] =~
3307 3308
				    s/\bpr_warning\b/pr_warn/;
			}
3309 3310
		}

3311 3312 3313 3314 3315 3316 3317 3318 3319
		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);
		}

3320 3321
# function brace can't be on same line, except for #defines of do while,
# or if closed on same line
3322
		if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
3323
		    !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337
			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));
				}
			}
3338
		}
3339

3340 3341 3342
# 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*$/) {
3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355
			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);
				}
			}
3356 3357
		}

3358
# missing space after union, struct or enum definition
3359 3360 3361 3362
		if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
			if (WARN("SPACING",
				 "missing space after $1 definition\n" . $herecurr) &&
			    $fix) {
3363
				$fixed[$fixlinenr] =~
3364 3365
				    s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
			}
3366 3367
		}

3368 3369 3370
# Function pointer declarations
# check spacing between type, funcptr, and args
# canonical declaration is "type (*funcptr)(args...)"
3371
		if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
3372 3373 3374 3375 3376 3377 3378
			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;

3379 3380 3381 3382 3383 3384 3385 3386 3387
# 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 =~ /^$/) {
3388 3389
				WARN("SPACING",
				     "missing space after return type\n" . $herecurr);
3390
				$post_declare_space = " ";
3391 3392 3393
			}

# unnecessary space "type  (*funcptr)(args...)"
3394 3395 3396 3397 3398 3399 3400 3401 3402
# 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);
#			}
3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432

# 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) {
3433
				$fixed[$fixlinenr] =~
3434
				    s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3435 3436 3437
			}
		}

3438 3439
# check for spacing round square brackets; allowed:
#  1. with a type on the left -- int [] a;
3440 3441
#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
#  3. inside a curly brace -- = { [0...10] = 5 }
3442 3443 3444
		while ($line =~ /(.*?\s)\[/g) {
			my ($where, $prefix) = ($-[1], $1);
			if ($prefix !~ /$Type\s+$/ &&
3445
			    ($where != 0 || $prefix !~ /^.\s+$/) &&
3446
			    $prefix !~ /[{,]\s+$/) {
3447 3448 3449
				if (ERROR("BRACKET_SPACE",
					  "space prohibited before open square bracket '['\n" . $herecurr) &&
				    $fix) {
3450
				    $fixed[$fixlinenr] =~
3451 3452
					s/^(\+.*?)\s+\[/$1\[/;
				}
3453 3454 3455
			}
		}

3456
# check for spaces between functions and their parentheses.
3457
		while ($line =~ /($Ident)\s+\(/g) {
3458
			my $name = $1;
3459 3460
			my $ctx_before = substr($line, 0, $-[1]);
			my $ctx = "$ctx_before$name";
3461 3462

			# Ignore those directives where spaces _are_ permitted.
3463 3464 3465 3466 3467 3468
			if ($name =~ /^(?:
				if|for|while|switch|return|case|
				volatile|__volatile__|
				__attribute__|format|__extension__|
				asm|__asm__)$/x)
			{
3469 3470 3471
			# 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.
3472
			} elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
3473 3474

			# cpp #elif statement condition may start with a (
3475
			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
3476 3477 3478

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

			} else {
3482 3483 3484
				if (WARN("SPACING",
					 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
					     $fix) {
3485
					$fixed[$fixlinenr] =~
3486 3487
					    s/\b$name\s+\(/$name\(/;
				}
3488
			}
3489
		}
3490

3491
# Check operator spacing.
3492
		if (!($line=~/\#\s*include/)) {
3493 3494 3495
			my $fixed_line = "";
			my $line_fixed = 0;

3496 3497 3498 3499
			my $ops = qr{
				<<=|>>=|<=|>=|==|!=|
				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
				=>|->|<<|>>|<|>|=|!|~|
3500
				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
3501
				\?:|\?|:
3502
			}x;
3503
			my @elements = split(/($ops|;)/, $opline);
3504 3505 3506 3507 3508 3509 3510

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

			my @fix_elements = ();
3511
			my $off = 0;
3512

3513 3514 3515 3516 3517 3518 3519
			foreach my $el (@elements) {
				push(@fix_elements, substr($rawline, $off, length($el)));
				$off += length($el);
			}

			$off = 0;

3520
			my $blank = copy_spacing($opline);
3521
			my $last_after = -1;
3522

3523
			for (my $n = 0; $n < $#elements; $n += 2) {
3524 3525 3526 3527 3528

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

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

3529 3530
				$off += length($elements[$n]);

L
Lucas De Marchi 已提交
3531
				# Pick up the preceding and succeeding characters.
3532 3533 3534 3535 3536 3537 3538
				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";

3539 3540 3541
				my $a = '';
				$a = 'V' if ($elements[$n] ne '');
				$a = 'W' if ($elements[$n] =~ /\s$/);
3542
				$a = 'C' if ($elements[$n] =~ /$;$/);
3543 3544
				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
				$a = 'O' if ($elements[$n] eq '');
3545
				$a = 'E' if ($ca =~ /^\s*$/);
3546

3547
				my $op = $elements[$n + 1];
3548 3549

				my $c = '';
3550
				if (defined $elements[$n + 2]) {
3551 3552
					$c = 'V' if ($elements[$n + 2] ne '');
					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
3553
					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
3554 3555
					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
					$c = 'O' if ($elements[$n + 2] eq '');
3556
					$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
3557 3558
				} else {
					$c = 'E';
3559 3560
				}

3561 3562 3563 3564
				my $ctx = "${a}x${c}";

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

3565
				my $ptr = substr($blank, 0, $off) . "^";
3566
				my $hereptr = "$hereline$ptr\n";
3567

3568
				# Pull out the value of this operator.
3569
				my $op_type = substr($curr_values, $off + 1, 1);
3570

3571 3572 3573
				# Get the full operator variant.
				my $opv = $op . substr($curr_vars, $off, 1);

3574 3575 3576 3577
				# Ignore operators passed as parameters.
				if ($op_type ne 'V' &&
				    $ca =~ /\s$/ && $cc =~ /^\s*,/) {

3578 3579
#				# Ignore comments
#				} elsif ($op =~ /^$;+$/) {
3580

3581
				# ; should have either the end of line or a space or \ after it
3582
				} elsif ($op eq ';') {
3583 3584
					if ($ctx !~ /.x[WEBC]/ &&
					    $cc !~ /^\\/ && $cc !~ /^;/) {
3585 3586
						if (ERROR("SPACING",
							  "space required after that '$op' $at\n" . $hereptr)) {
3587
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3588 3589
							$line_fixed = 1;
						}
3590 3591 3592 3593
					}

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

3595 3596 3597 3598
				#   :   when part of a bitfield
				} elsif ($opv eq ':B') {
					# skip the bitfield test for now

3599 3600
				# No spaces for:
				#   ->
3601
				} elsif ($op eq '->') {
3602
					if ($ctx =~ /Wx.|.xW/) {
3603 3604
						if (ERROR("SPACING",
							  "spaces prohibited around that '$op' $at\n" . $hereptr)) {
3605
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3606 3607 3608
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3609
							$line_fixed = 1;
3610
						}
3611 3612
					}

3613
				# , must not have a space before and must have a space on the right.
3614
				} elsif ($op eq ',') {
3615 3616 3617 3618 3619 3620 3621 3622 3623
					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;
						}
					}
3624
					if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
3625 3626 3627
						if (ERROR("SPACING",
							  "space required after that '$op' $at\n" . $hereptr)) {
							$line_fixed = 1;
3628
							$last_after = $n;
3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639
							$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 .= " ";
3640
						}
3641 3642
					}

3643
				# '*' as part of a type definition -- reported already.
3644
				} elsif ($opv eq '*_') {
3645 3646 3647 3648 3649 3650
					#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 '~' ||
3651
					 $opv eq '*U' || $opv eq '-U' ||
3652
					 $opv eq '&U' || $opv eq '&&U') {
3653
					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
3654 3655
						if (ERROR("SPACING",
							  "space required before that '$op' $at\n" . $hereptr)) {
3656 3657 3658 3659
							if ($n != $last_after + 2) {
								$good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
								$line_fixed = 1;
							}
3660
						}
3661
					}
3662
					if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
3663 3664 3665
						# A unary '*' may be const

					} elsif ($ctx =~ /.xW/) {
3666 3667
						if (ERROR("SPACING",
							  "space prohibited after that '$op' $at\n" . $hereptr)) {
3668
							$good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
3669 3670 3671
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3672
							$line_fixed = 1;
3673
						}
3674 3675 3676 3677
					}

				# unary ++ and unary -- are allowed no space on one side.
				} elsif ($op eq '++' or $op eq '--') {
3678
					if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
3679 3680
						if (ERROR("SPACING",
							  "space required one side of that '$op' $at\n" . $hereptr)) {
3681
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3682 3683
							$line_fixed = 1;
						}
3684 3685 3686
					}
					if ($ctx =~ /Wx[BE]/ ||
					    ($ctx =~ /Wx./ && $cc =~ /^;/)) {
3687 3688
						if (ERROR("SPACING",
							  "space prohibited before that '$op' $at\n" . $hereptr)) {
3689
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3690 3691
							$line_fixed = 1;
						}
3692
					}
3693
					if ($ctx =~ /ExW/) {
3694 3695
						if (ERROR("SPACING",
							  "space prohibited after that '$op' $at\n" . $hereptr)) {
3696
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3697 3698 3699
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3700
							$line_fixed = 1;
3701
						}
3702
					}
3703 3704

				# << and >> may either have or not have spaces both sides
3705 3706 3707
				} elsif ($op eq '<<' or $op eq '>>' or
					 $op eq '&' or $op eq '^' or $op eq '|' or
					 $op eq '+' or $op eq '-' or
3708 3709
					 $op eq '*' or $op eq '/' or
					 $op eq '%')
3710
				{
3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726
					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/) {
3727 3728
						if (ERROR("SPACING",
							  "need consistent spacing around '$op' $at\n" . $hereptr)) {
3729 3730 3731 3732
							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3733 3734
							$line_fixed = 1;
						}
3735 3736
					}

3737 3738 3739 3740
				# 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./) {
3741 3742
						if (ERROR("SPACING",
							  "space prohibited before that '$op' $at\n" . $hereptr)) {
3743
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3744 3745
							$line_fixed = 1;
						}
3746 3747
					}

3748
				# All the others need spaces both sides.
3749
				} elsif ($ctx !~ /[EWC]x[CWE]/) {
3750 3751
					my $ok = 0;

3752
					# Ignore email addresses <foo@bar>
3753 3754 3755 3756 3757 3758 3759 3760
					if (($op eq '<' &&
					     $cc =~ /^\S+\@\S+>/) ||
					    ($op eq '>' &&
					     $ca =~ /<\S+\@\S+$/))
					{
					    	$ok = 1;
					}

3761
					# messages are ERROR, but ?: are CHK
3762
					if ($ok == 0) {
3763 3764 3765 3766 3767
						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)) {
3768 3769 3770 3771
							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3772 3773
							$line_fixed = 1;
						}
3774
					}
3775
				}
3776
				$off += length($elements[$n + 1]);
3777 3778 3779 3780 3781 3782 3783 3784

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

				$fixed_line = $fixed_line . $good;
			}

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

3787 3788
			if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
				$fixed[$fixlinenr] = $fixed_line;
3789 3790 3791
			}


3792 3793
		}

3794
# check for whitespace before a non-naked semicolon
3795
		if ($line =~ /^\+.*\S\s+;\s*$/) {
3796 3797 3798
			if (WARN("SPACING",
				 "space prohibited before semicolon\n" . $herecurr) &&
			    $fix) {
3799
				1 while $fixed[$fixlinenr] =~
3800 3801 3802 3803
				    s/^(\+.*\S)\s+;/$1;/;
			}
		}

3804 3805
# check for multiple assignments
		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
3806 3807
			CHK("MULTIPLE_ASSIGNMENTS",
			    "multiple assignments should be avoided\n" . $herecurr);
3808 3809
		}

3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820
## # 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 =~ /,/) {
3821 3822
## 				WARN("MULTIPLE_DECLARATION",
##				     "declaring multiple variables together should be avoided\n" . $herecurr);
3823 3824
## 			}
## 		}
3825

3826
#need space before brace following if, while, etc
3827 3828
		if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
		    $line =~ /do{/) {
3829 3830 3831
			if (ERROR("SPACING",
				  "space required before the open brace '{'\n" . $herecurr) &&
			    $fix) {
3832
				$fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
3833
			}
3834 3835
		}

3836 3837 3838 3839 3840 3841 3842 3843
## # check for blank lines before declarations
##		if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
##		    $prevrawline =~ /^.\s*$/) {
##			WARN("SPACING",
##			     "No blank lines before declarations\n" . $hereprev);
##		}
##

3844 3845 3846
# closing brace should have a space following it when it has anything
# on the line
		if ($line =~ /}(?!(?:,|;|\)))\S/) {
3847 3848 3849
			if (ERROR("SPACING",
				  "space required after that close brace '}'\n" . $herecurr) &&
			    $fix) {
3850
				$fixed[$fixlinenr] =~
3851 3852
				    s/}((?!(?:,|;|\)))\S)/} $1/;
			}
3853 3854
		}

3855 3856
# check spacing on square brackets
		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
3857 3858 3859
			if (ERROR("SPACING",
				  "space prohibited after that open square bracket '['\n" . $herecurr) &&
			    $fix) {
3860
				$fixed[$fixlinenr] =~
3861 3862
				    s/\[\s+/\[/;
			}
3863 3864
		}
		if ($line =~ /\s\]/) {
3865 3866 3867
			if (ERROR("SPACING",
				  "space prohibited before that close square bracket ']'\n" . $herecurr) &&
			    $fix) {
3868
				$fixed[$fixlinenr] =~
3869 3870
				    s/\s+\]/\]/;
			}
3871 3872
		}

3873
# check spacing on parentheses
3874 3875
		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
		    $line !~ /for\s*\(\s+;/) {
3876 3877 3878
			if (ERROR("SPACING",
				  "space prohibited after that open parenthesis '('\n" . $herecurr) &&
			    $fix) {
3879
				$fixed[$fixlinenr] =~
3880 3881
				    s/\(\s+/\(/;
			}
3882
		}
3883
		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
3884 3885
		    $line !~ /for\s*\(.*;\s+\)/ &&
		    $line !~ /:\s+\)/) {
3886 3887 3888
			if (ERROR("SPACING",
				  "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
			    $fix) {
3889
				$fixed[$fixlinenr] =~
3890 3891
				    s/\s+\)/\)/;
			}
3892 3893
		}

3894 3895 3896 3897
# 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) {
3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918
			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/;
			}
		}
3919

3920
#goto labels aren't indented, allow a single space however
3921
		if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
3922
		   !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
3923 3924 3925
			if (WARN("INDENTED_LABEL",
				 "labels should not be indented\n" . $herecurr) &&
			    $fix) {
3926
				$fixed[$fixlinenr] =~
3927 3928
				    s/^(.)\s+/$1/;
			}
3929 3930
		}

3931
# return is not a function
3932
		if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
3933
			my $spacing = $1;
3934
			if ($^V && $^V ge 5.10.0 &&
3935 3936 3937 3938 3939 3940 3941
			    $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);
				}
3942
			} elsif ($spacing !~ /\s+/) {
3943 3944
				ERROR("SPACING",
				      "space required before the open parenthesis '('\n" . $herecurr);
3945 3946
			}
		}
3947

3948 3949 3950 3951 3952 3953 3954 3955
# 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*:/) {
3956
			WARN("RETURN_VOID",
3957 3958
			     "void function return statements are not generally useful\n" . $hereprev);
               }
3959

3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973
# 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);
			}
		}

3974 3975 3976 3977
# Return of what appears to be an errno should normally be -'ve
		if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
			my $name = $1;
			if ($name ne 'EOF' && $name ne 'ERROR') {
3978 3979
				WARN("USE_NEGATIVE_ERRNO",
				     "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
3980 3981
			}
		}
3982

3983
# Need a space before open parenthesis after if, while etc
3984 3985 3986 3987
		if ($line =~ /\b(if|while|for|switch)\(/) {
			if (ERROR("SPACING",
				  "space required before the open parenthesis '('\n" . $herecurr) &&
			    $fix) {
3988
				$fixed[$fixlinenr] =~
3989 3990
				    s/\b(if|while|for|switch)\(/$1 \(/;
			}
3991 3992
		}

3993 3994
# Check for illegal assignment in if conditional -- and check for trailing
# statements after the conditional.
3995
		if ($line =~ /do\s*(?!{)/) {
3996 3997 3998
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016
			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} &&
4017
		    defined($stat) && defined($cond) &&
4018
		    $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
4019
			my ($s, $c) = ($stat, $cond);
4020

4021
			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
4022 4023
				ERROR("ASSIGN_IN_IF",
				      "do not use assignment in if condition\n" . $herecurr);
4024 4025 4026 4027
			}

			# Find out what is on the end of the line after the
			# conditional.
4028
			substr($s, 0, length($c), '');
4029
			$s =~ s/\n.*//g;
4030
			$s =~ s/$;//g; 	# Remove any comments
4031 4032
			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
			    $c !~ /}\s*while\s*/)
4033
			{
4034 4035 4036
				# Find out how long the conditional actually is.
				my @newlines = ($c =~ /\n/gs);
				my $cond_lines = 1 + $#newlines;
4037
				my $stat_real = '';
4038

4039 4040
				$stat_real = raw_line($linenr, $cond_lines)
							. "\n" if ($cond_lines);
4041 4042 4043 4044
				if (defined($stat_real) && $cond_lines > 1) {
					$stat_real = "[...]\n$stat_real";
				}

4045 4046
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr . $stat_real);
4047 4048 4049
			}
		}

4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061
# Check for bitwise tests written as boolean
		if ($line =~ /
			(?:
				(?:\[|\(|\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\|)
			|
				(?:\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\||\)|\])
			)/x)
		{
4062 4063
			WARN("HEXADECIMAL_BOOLEAN_TEST",
			     "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
4064 4065
		}

4066
# if and else should not have general statements after it
4067 4068 4069 4070
		if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
			my $s = $1;
			$s =~ s/$;//g; 	# Remove any comments
			if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
4071 4072
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr);
4073
			}
4074
		}
4075 4076
# if should not continue a brace
		if ($line =~ /}\s*if\b/) {
4077
			ERROR("TRAILING_STATEMENTS",
4078
			      "trailing statements should be on next line (or did you mean 'else if'?)\n" .
4079 4080
				$herecurr);
		}
4081 4082 4083
# case and default should not have general statements after them
		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
		    $line !~ /\G(?:
4084
			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
4085 4086 4087
			\s*return\s+
		    )/xg)
		{
4088 4089
			ERROR("TRAILING_STATEMENTS",
			      "trailing statements should be on next line\n" . $herecurr);
4090
		}
4091 4092 4093

		# Check for }<nl>else {, these must be at the same
		# indent level to be relevant to each other.
4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109
		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);
			}
4110 4111
		}

4112 4113
		if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
		    $previndent == $indent) {
4114 4115 4116 4117
			my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);

			# Find out what is on the end of the line after the
			# conditional.
4118
			substr($s, 0, length($c), '');
4119 4120 4121
			$s =~ s/\n.*//g;

			if ($s =~ /^\s*;/) {
4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133
				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);
				}
4134 4135 4136
			}
		}

4137
#Specific variable tests
4138 4139
		while ($line =~ m{($Constant|$Lval)}g) {
			my $var = $1;
4140 4141 4142

#gcc binary extension
			if ($var =~ /^$Binary$/) {
4143 4144 4145 4146
				if (WARN("GCC_BINARY_CONSTANT",
					 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
				    $fix) {
					my $hexval = sprintf("0x%x", oct($var));
4147
					$fixed[$fixlinenr] =~
4148 4149
					    s/\b$var\b/$hexval/;
				}
4150 4151 4152
			}

#CamelCase
4153
			if ($var !~ /^$Constant$/ &&
4154
			    $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
4155
#Ignore Page<foo> variants
4156
			    $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
4157
#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4158 4159 4160
			    $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_]+)?$/) {
4161 4162 4163
				while ($var =~ m{($Ident)}g) {
					my $word = $1;
					next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
4164 4165 4166 4167 4168 4169 4170
					if ($check) {
						seed_camelcase_includes();
						if (!$file && !$camelcase_file_seeded) {
							seed_camelcase_file($realfile);
							$camelcase_file_seeded = 1;
						}
					}
4171 4172 4173 4174 4175
					if (!defined $camelcase{$word}) {
						$camelcase{$word} = 1;
						CHK("CAMELCASE",
						    "Avoid CamelCase: <$word>\n" . $herecurr);
					}
4176
				}
4177 4178
			}
		}
4179 4180

#no spaces allowed after \ in define
4181 4182 4183 4184
		if ($line =~ /\#\s*define.*\\\s+$/) {
			if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
				 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
			    $fix) {
4185
				$fixed[$fixlinenr] =~ s/\s+$//;
4186
			}
4187 4188
		}

4189
#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
4190
		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
4191 4192 4193 4194
			my $file = "$1.h";
			my $checkfile = "include/linux/$file";
			if (-f "$root/$checkfile" &&
			    $realfile ne $checkfile &&
4195
			    $1 !~ /$allowed_asm_includes/)
4196
			{
4197
				if ($realfile =~ m{^arch/}) {
4198 4199
					CHK("ARCH_INCLUDE_LINUX",
					    "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4200
				} else {
4201 4202
					WARN("INCLUDE_LINUX",
					     "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4203
				}
4204 4205 4206
			}
		}

4207 4208
# 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
4209
# in a known good container
4210 4211
		if ($realfile !~ m@/vmlinux.lds.h$@ &&
		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
4212 4213
			my $ln = $linenr;
			my $cnt = $realcnt;
4214 4215
			my ($off, $dstat, $dcond, $rest);
			my $ctx = '';
4216 4217
			my $has_flow_statement = 0;
			my $has_arg_concat = 0;
4218
			($dstat, $dcond, $ln, $cnt, $off) =
4219 4220
				ctx_statement_block($linenr, $realcnt, 0);
			$ctx = $dstat;
4221
			#print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4222
			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4223

4224 4225 4226
			$has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
			$has_arg_concat = 1 if ($ctx =~ /\#\#/);

4227
			$dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
4228
			$dstat =~ s/$;//g;
4229 4230 4231
			$dstat =~ s/\\\n.//g;
			$dstat =~ s/^\s*//s;
			$dstat =~ s/\s*$//s;
4232

4233
			# Flatten any parentheses and braces
4234 4235
			while ($dstat =~ s/\([^\(\)]*\)/1/ ||
			       $dstat =~ s/\{[^\{\}]*\}/1/ ||
4236
			       $dstat =~ s/\[[^\[\]]*\]/1/)
4237
			{
4238
			}
4239

4240 4241 4242 4243 4244 4245
			# Flatten any obvious string concatentation.
			while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
			       $dstat =~ s/$Ident\s*("X*")/$1/)
			{
			}

4246 4247 4248
			my $exceptions = qr{
				$Declare|
				module_param_named|
4249
				MODULE_PARM_DESC|
4250 4251
				DECLARE_PER_CPU|
				DEFINE_PER_CPU|
4252
				__typeof__\(|
4253 4254
				union|
				struct|
4255 4256
				\.$Ident\s*=\s*|
				^\"|\"$
4257
			}x;
4258
			#print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4259 4260 4261
			if ($dstat ne '' &&
			    $dstat !~ /^(?:$Ident|-?$Constant),$/ &&			# 10, // foo(),
			    $dstat !~ /^(?:$Ident|-?$Constant);$/ &&			# foo();
4262
			    $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ &&		# 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4263
			    $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ &&			# character constants
4264 4265
			    $dstat !~ /$exceptions/ &&
			    $dstat !~ /^\.$Ident\s*=/ &&				# .foo =
4266
			    $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ &&		# stringification #foo
4267
			    $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ &&	# do {...} while (...); // do {...} while (...)
4268 4269 4270
			    $dstat !~ /^for\s*$Constant$/ &&				# for (...)
			    $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ &&	# for (...) bar()
			    $dstat !~ /^do\s*{/ &&					# do {...
4271 4272
			    $dstat !~ /^\({/ &&						# ({...
			    $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
4273 4274 4275 4276 4277 4278 4279
			{
				$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";
4280 4281
				}

4282 4283 4284 4285
				if ($dstat =~ /;/) {
					ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
					      "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
				} else {
4286
					ERROR("COMPLEX_MACRO",
A
Andrew Morton 已提交
4287
					      "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
4288
				}
4289
			}
4290

4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303
# 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");
			}

4304
# check for line continuations outside of #defines, preprocessor #, and asm
4305 4306 4307

		} else {
			if ($prevline !~ /^..*\\$/ &&
4308 4309
			    $line !~ /^\+\s*\#.*\\$/ &&		# preprocessor
			    $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ &&	# asm
4310 4311 4312 4313
			    $line =~ /^\+.*\\$/) {
				WARN("LINE_CONTINUATIONS",
				     "Avoid unnecessary line continuations\n" . $herecurr);
			}
4314 4315
		}

4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330
# 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;
4331
			$dstat =~ s/$;/ /g;
4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344

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

4345 4346
				if (($stmts =~ tr/;/;/) == 1 &&
				    $stmts !~ /^\s*(if|while|for|switch)\b/) {
4347 4348 4349 4350 4351 4352 4353
					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");
				}
4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364
			} 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");
4365 4366 4367
			}
		}

4368 4369 4370 4371 4372 4373
# 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|$))/) {
4374 4375
			WARN("MISSING_VMLINUX_SYMBOL",
			     "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
4376 4377
		}

4378
# check for redundant bracing round if etc
4379 4380
		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
			my ($level, $endln, @chunks) =
4381
				ctx_statement_full($linenr, $realcnt, 1);
4382
			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4383 4384
			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
			if ($#chunks > 0 && $level == 0) {
4385 4386
				my @allowed = ();
				my $allow = 0;
4387
				my $seen = 0;
4388
				my $herectx = $here . "\n";
4389
				my $ln = $linenr - 1;
4390 4391 4392
				for my $chunk (@chunks) {
					my ($cond, $block) = @{$chunk};

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

4397
					$allowed[$allow] = 0;
4398 4399 4400 4401 4402 4403
					#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";
4404 4405
					$ln += statement_rawlines($block) - 1;

4406
					substr($block, 0, length($cond), '');
4407 4408 4409

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

4410
					#print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4411 4412
					if (statement_lines($cond) > 1) {
						#print "APW: ALLOWED: cond<$cond>\n";
4413
						$allowed[$allow] = 1;
4414 4415
					}
					if ($block =~/\b(?:if|for|while)\b/) {
4416
						#print "APW: ALLOWED: block<$block>\n";
4417
						$allowed[$allow] = 1;
4418
					}
4419 4420
					if (statement_block_size($block) > 1) {
						#print "APW: ALLOWED: lines block<$block>\n";
4421
						$allowed[$allow] = 1;
4422
					}
4423
					$allow++;
4424
				}
4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437
				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);
					}
4438 4439 4440
				}
			}
		}
4441
		if (!defined $suppress_ifbraces{$linenr - 1} &&
4442
					$line =~ /\b(if|while|for|else)\b/) {
4443 4444 4445 4446 4447 4448 4449
			my $allowed = 0;

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

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

4454 4455
			# Check the condition.
			my ($cond, $block) = @{$chunks[0]};
4456
			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4457
			if (defined $cond) {
4458
				substr($block, 0, length($cond), '');
4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475
			}
			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) {
4476
					substr($block, 0, length($cond), '');
4477 4478 4479 4480 4481 4482 4483
				}
				if ($block =~ /^\s*\{/) {
					#print "APW: ALLOWED: chunk-1 block<$block>\n";
					$allowed = 1;
				}
			}
			if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
4484
				my $herectx = $here . "\n";
4485
				my $cnt = statement_rawlines($block);
4486

4487
				for (my $n = 0; $n < $cnt; $n++) {
4488
					$herectx .= raw_line($linenr, $n) . "\n";
4489
				}
4490

4491 4492
				WARN("BRACES",
				     "braces {} are not necessary for single statement blocks\n" . $herectx);
4493 4494 4495
			}
		}

4496
# check for unnecessary blank lines around braces
4497
		if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
4498 4499 4500 4501 4502
			if (CHK("BRACES",
				"Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
			    $fix && $prevrawline =~ /^\+/) {
				fix_delete_line($fixlinenr - 1, $prevrawline);
			}
4503
		}
4504
		if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
4505 4506 4507 4508 4509
			if (CHK("BRACES",
				"Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
			    $fix) {
				fix_delete_line($fixlinenr, $rawline);
			}
4510 4511
		}

4512
# no volatiles please
4513 4514
		my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
		if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
4515 4516
			WARN("VOLATILE",
			     "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4517 4518
		}

4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567
# Check for user-visible strings broken across lines, which breaks the ability
# to grep for the string.  Make exceptions when the previous string ends in a
# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
		if ($line =~ /^\+\s*"[X\t]*"/ &&
		    $prevline =~ /"\s*$/ &&
		    $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
			if (WARN("SPLIT_STRING",
				 "quoted string split across lines\n" . $hereprev) &&
				     $fix &&
				     $prevrawline =~ /^\+.*"\s*$/ &&
				     $last_coalesced_string_linenr != $linenr - 1) {
				my $extracted_string = get_quoted_string($line, $rawline);
				my $comma_close = "";
				if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
					$comma_close = $1;
				}

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

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

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

		}

4568 4569 4570 4571 4572 4573
# concatenated string without spaces between elements
		if ($line =~ /"X+"[A-Z_]+/ || $line =~ /[A-Z_]+"X+"/) {
			CHK("CONCATENATED_STRING",
			    "Concatenated strings should use spaces between elements\n" . $herecurr);
		}

4574 4575 4576 4577 4578 4579
# uncoalesced string fragments
		if ($line =~ /"X*"\s*"/) {
			WARN("STRING_FRAGMENTS",
			     "Consecutive strings are generally better as a single string\n" . $herecurr);
		}

4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597
# check for %L{u,d,i} in strings
		my $string;
		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
			$string = substr($rawline, $-[1], $+[1] - $-[1]);
			$string =~ s/%%/__/g;
			if ($string =~ /(?<!%)%L[udi]/) {
				WARN("PRINTF_L",
				     "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
				last;
			}
		}

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

4598
# warn about #if 0
4599
		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
4600 4601
			CHK("REDUNDANT_CODE",
			    "if this code is redundant consider removing it\n" .
4602
				$herecurr);
4603 4604
		}

4605 4606 4607 4608 4609
# check for needless "if (<foo>) fn(<foo>)" uses
		if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
			my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
			if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
				WARN('NEEDLESS_IF',
4610
				     "$1(NULL) is safe and this check is probably not required\n" . $hereprev);
4611 4612
			}
		}
4613

4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630
# 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);
			}
		}

4631
# check for logging functions with KERN_<LEVEL>
4632
		if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
4633 4634 4635 4636 4637 4638 4639 4640 4641
		    $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*//;
			}
		}

4642 4643 4644 4645 4646 4647 4648 4649
# 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);
		}

4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663
# 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/;
				}
			}
		}

4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676
# 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) {
4677
					$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;
4678 4679 4680 4681
				}
			}
		}

4682 4683 4684 4685 4686 4687 4688 4689 4690
# 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) {
4691
				$fixed[$fixlinenr] =~
4692 4693 4694 4695 4696 4697 4698 4699 4700 4701
				    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) {
4702
				my $lead = $fixed[$fixlinenr] =~
4703 4704 4705 4706
				    /(^\+\s*(?:static\s+))/;
				$lead = rtrim($1);
				$lead = "$lead " if ($lead !~ /^\+$/);
				$lead = "${lead}const ";
4707
				$fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
4708 4709 4710
			}
		}

4711 4712 4713 4714 4715 4716 4717 4718 4719
# 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) {
4720
				$fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
4721 4722 4723
			}
		}

4724
# prefer usleep_range over udelay
B
Bruce Allan 已提交
4725
		if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
4726
			my $delay = $1;
4727
			# ignore udelay's < 10, however
4728
			if (! ($delay < 10) ) {
4729
				CHK("USLEEP_RANGE",
4730 4731 4732 4733 4734
				    "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);
4735 4736 4737
			}
		}

4738 4739 4740
# warn about unexpectedly long msleep's
		if ($line =~ /\bmsleep\s*\((\d+)\);/) {
			if ($1 < 20) {
4741
				WARN("MSLEEP",
4742
				     "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4743 4744 4745
			}
		}

4746 4747 4748 4749 4750 4751
# 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);
		}

4752 4753 4754 4755 4756 4757
# 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);
		}

4758
# warn about #ifdefs in C files
4759
#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
4760 4761 4762 4763 4764
#			print "#ifdef in C files should be avoided\n";
#			print "$herecurr";
#			$clean = 0;
#		}

4765
# warn about spacing in #ifdefs
4766
		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
4767 4768 4769
			if (ERROR("SPACING",
				  "exactly one space required after that #$1\n" . $herecurr) &&
			    $fix) {
4770
				$fixed[$fixlinenr] =~
4771 4772 4773
				    s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
			}

4774 4775
		}

4776
# check for spinlock_t definitions without a comment.
4777 4778
		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
4779 4780
			my $which = $1;
			if (!ctx_has_comment($first_line, $linenr)) {
4781 4782
				CHK("UNCOMMENTED_DEFINITION",
				    "$1 definition without comment\n" . $herecurr);
4783 4784 4785 4786 4787
			}
		}
# check for memory barriers without a comment.
		if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
			if (!ctx_has_comment($first_line, $linenr)) {
4788 4789
				WARN("MEMORY_BARRIER",
				     "memory barrier without comment\n" . $herecurr);
4790 4791 4792
			}
		}
# check of hardware specific defines
4793
		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
4794 4795
			CHK("ARCH_DEFINES",
			    "architecture specific defines should be avoided\n" .  $herecurr);
4796
		}
4797

4798 4799
# Check that the storage class is at the beginning of a declaration
		if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
4800 4801
			WARN("STORAGE_CLASS",
			     "storage class should be at the beginning of the declaration\n" . $herecurr)
4802 4803
		}

4804 4805
# check the location of the inline attribute, that it is between
# storage class and type.
4806 4807
		if ($line =~ /\b$Type\s+$Inline\b/ ||
		    $line =~ /\b$Inline\s+$Storage\b/) {
4808 4809
			ERROR("INLINE_LOCATION",
			      "inline keyword should sit between storage class and type\n" . $herecurr);
4810 4811
		}

4812
# Check for __inline__ and __inline, prefer inline
4813 4814
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b(__inline__|__inline)\b/) {
4815 4816 4817
			if (WARN("INLINE",
				 "plain inline is preferred over $1\n" . $herecurr) &&
			    $fix) {
4818
				$fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
4819 4820

			}
4821 4822
		}

4823
# Check for __attribute__ packed, prefer __packed
4824 4825
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
4826 4827
			WARN("PREFER_PACKED",
			     "__packed is preferred over __attribute__((packed))\n" . $herecurr);
4828 4829
		}

4830
# Check for __attribute__ aligned, prefer __aligned
4831 4832
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
4833 4834
			WARN("PREFER_ALIGNED",
			     "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
4835 4836
		}

4837
# Check for __attribute__ format(printf, prefer __printf
4838 4839
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
4840 4841 4842
			if (WARN("PREFER_PRINTF",
				 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
			    $fix) {
4843
				$fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4844 4845

			}
4846 4847
		}

4848
# Check for __attribute__ format(scanf, prefer __scanf
4849 4850
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
4851 4852 4853
			if (WARN("PREFER_SCANF",
				 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
			    $fix) {
4854
				$fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4855
			}
4856 4857
		}

4858 4859 4860 4861 4862 4863 4864 4865 4866
# 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);
		}

4867 4868
# check for sizeof(&)
		if ($line =~ /\bsizeof\s*\(\s*\&/) {
4869 4870
			WARN("SIZEOF_ADDRESS",
			     "sizeof(& should be avoided\n" . $herecurr);
4871 4872
		}

4873 4874
# check for sizeof without parenthesis
		if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
4875 4876 4877
			if (WARN("SIZEOF_PARENTHESIS",
				 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
			    $fix) {
4878
				$fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4879
			}
4880 4881
		}

4882 4883 4884 4885 4886 4887
# 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);
		}

4888
# check for seq_printf uses that could be seq_puts
J
Joe Perches 已提交
4889
		if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
4890
			my $fmt = get_quoted_string($line, $rawline);
4891 4892
			$fmt =~ s/%%//g;
			if ($fmt !~ /%/) {
4893 4894 4895
				if (WARN("PREFER_SEQ_PUTS",
					 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
				    $fix) {
4896
					$fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
4897
				}
4898 4899 4900
			}
		}

4901
# Check for misused memsets
4902 4903
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
4904 4905 4906
		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {

			my $ms_addr = $2;
4907 4908
			my $ms_val = $7;
			my $ms_size = $12;
4909 4910 4911

			if ($ms_size =~ /^(0x|)0$/i) {
				ERROR("MEMSET",
4912
				      "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
4913 4914
			} elsif ($ms_size =~ /^(0x|)1$/i) {
				WARN("MEMSET",
4915 4916 4917 4918
				     "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
			}
		}

4919 4920 4921 4922 4923 4924
# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
		if ($^V && $^V ge 5.10.0 &&
		    $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
			if (WARN("PREFER_ETHER_ADDR_COPY",
				 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
			    $fix) {
4925
				$fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4926 4927 4928
			}
		}

4929
# typecasts on min/max could be min_t/max_t
4930 4931
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
4932
		    $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
4933
			if (defined $2 || defined $7) {
4934 4935 4936
				my $call = $1;
				my $cast1 = deparenthesize($2);
				my $arg1 = $3;
4937 4938
				my $cast2 = deparenthesize($7);
				my $arg2 = $8;
4939 4940
				my $cast;

4941
				if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
4942 4943 4944 4945 4946 4947 4948 4949
					$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");
4950 4951 4952
			}
		}

4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968
# 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");
			}
		}

4969 4970 4971
# check for naked sscanf
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
4972
		    $line =~ /\bsscanf\b/ &&
4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985
		    ($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");
		}

4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006
# 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");
				}
			}
		}

5007 5008 5009
# check for new externs in .h files.
		if ($realfile =~ /\.h$/ &&
		    $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
5010 5011
			if (CHK("AVOID_EXTERNS",
				"extern prototypes should be avoided in .h files\n" . $herecurr) &&
5012
			    $fix) {
5013
				$fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
5014 5015 5016
			}
		}

5017
# check for new externs in .c files.
5018
		if ($realfile =~ /\.c$/ && defined $stat &&
5019
		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
5020
		{
5021 5022
			my $function_name = $1;
			my $paren_space = $2;
5023 5024 5025 5026 5027

			my $s = $stat;
			if (defined $cond) {
				substr($s, 0, length($cond), '');
			}
5028 5029 5030
			if ($s =~ /^\s*;/ &&
			    $function_name ne 'uninitialized_var')
			{
5031 5032
				WARN("AVOID_EXTERNS",
				     "externs should be avoided in .c files\n" .  $herecurr);
5033 5034 5035
			}

			if ($paren_space =~ /\n/) {
5036 5037
				WARN("FUNCTION_ARGUMENTS",
				     "arguments for function declarations should follow identifier\n" . $herecurr);
5038
			}
5039 5040 5041 5042

		} elsif ($realfile =~ /\.c$/ && defined $stat &&
		    $stat =~ /^.\s*extern\s+/)
		{
5043 5044
			WARN("AVOID_EXTERNS",
			     "externs should be avoided in .c files\n" .  $herecurr);
5045 5046 5047 5048 5049 5050 5051
		}

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

			if (!grep(/$name/, @setup_docs)) {
5052 5053
				CHK("UNDOCUMENTED_SETUP",
				    "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
5054
			}
5055
		}
5056 5057

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

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

5071 5072
# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
		if ($^V && $^V ge 5.10.0 &&
5073
		    $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
5074 5075 5076 5077 5078
			my $oldfunc = $3;
			my $a1 = $4;
			my $a2 = $10;
			my $newfunc = "kmalloc_array";
			$newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
5079 5080 5081 5082 5083 5084 5085 5086
			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_]*$/)) {
5087 5088 5089
				if (WARN("ALLOC_WITH_MULTIPLY",
					 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
				    $fix) {
5090
					$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;
5091 5092 5093 5094 5095

				}
			}
		}

5096 5097 5098 5099 5100 5101 5102
# 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);
		}

5103 5104 5105 5106 5107 5108
# 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);
		}

5109 5110
# check for multiple semicolons
		if ($line =~ /;\s*;\s*$/) {
5111 5112 5113
			if (WARN("ONE_SEMICOLON",
				 "Statements terminations use 1 semicolon\n" . $herecurr) &&
			    $fix) {
5114
				$fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
5115
			}
5116 5117
		}

5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128
# 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)/;
			}
		}

5129
# check for case / default statements not preceded by break/fallthrough/switch
5130 5131 5132 5133 5134
		if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
			my $has_break = 0;
			my $has_statement = 0;
			my $count = 0;
			my $prevline = $linenr;
5135
			while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153
				$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);
			}
		}

5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165
# 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);
5166 5167
		}

5168
# check for gcc specific __FUNCTION__
5169 5170 5171 5172
		if ($line =~ /\b__FUNCTION__\b/) {
			if (WARN("USE_FUNC",
				 "__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr) &&
			    $fix) {
5173
				$fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
5174
			}
5175
		}
5176

5177 5178 5179 5180 5181 5182
# 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 已提交
5183 5184 5185 5186 5187 5188
# 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);
		}

5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215
# 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);

			}
		}

5216 5217
# check for semaphores initialized locked
		if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
5218 5219
			WARN("CONSIDER_COMPLETION",
			     "consider using a completion\n" . $herecurr);
5220
		}
5221

5222 5223
# recommend kstrto* over simple_strto* and strict_strto*
		if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
5224
			WARN("CONSIDER_KSTRTO",
5225
			     "$1 is obsolete, use k$3 instead\n" . $herecurr);
5226
		}
5227

5228
# check for __initcall(), use device_initcall() explicitly or more appropriate function please
5229
		if ($line =~ /^.\s*__initcall\s*\(/) {
5230
			WARN("USE_DEVICE_INITCALL",
5231
			     "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
5232
		}
5233

5234 5235 5236
# check for various structs that are normally const (ops, kgdb, device_tree)
		my $const_structs = qr{
				acpi_dock_ops|
5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258
				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|
5259
				of_device_id|
5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273
				pci_raw_ops|
				pipe_buf_operations|
				platform_hibernation_ops|
				platform_suspend_ops|
				proto_ops|
				rpc_pipe_ops|
				seq_operations|
				snd_ac97_build_ops|
				soc_pcmcia_socket_ops|
				stacktrace_ops|
				sysfs_ops|
				tty_operations|
				usb_mon_operations|
				wd_ops}x;
5274
		if ($line !~ /\bconst\b/ &&
5275
		    $line =~ /\bstruct\s+($const_structs)\b/) {
5276 5277
			WARN("CONST_STRUCT",
			     "struct $1 should normally be const\n" .
5278
				$herecurr);
5279
		}
5280 5281 5282 5283

# 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/ &&
5284 5285
		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
5286 5287 5288
		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
5289
		{
5290 5291
			WARN("NR_CPUS",
			     "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
5292
		}
5293

5294 5295 5296 5297 5298 5299
# 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);
		}

5300 5301 5302 5303 5304 5305 5306
# 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);
		}

5307 5308 5309
# whine mightly about in_atomic
		if ($line =~ /\bin_atomic\s*\(/) {
			if ($realfile =~ m@^drivers/@) {
5310 5311
				ERROR("IN_ATOMIC",
				      "do not use in_atomic in drivers\n" . $herecurr);
5312
			} elsif ($realfile !~ m@^kernel/@) {
5313 5314
				WARN("IN_ATOMIC",
				     "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
5315 5316
			}
		}
5317 5318 5319 5320 5321 5322 5323

# 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@) {
5324 5325
				ERROR("LOCKDEP",
				      "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
5326 5327
			}
		}
5328 5329 5330

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

5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357
# 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);
5358 5359 5360
					} elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
						ERROR("EXPORTED_WORLD_WRITABLE",
						      "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5361
					}
5362 5363 5364
				}
			}
		}
5365 5366 5367 5368 5369 5370
	}

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

5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385
	# In mailback mode only produce a report in the negative, for
	# things that appear to be patches.
	if ($mailback && ($clean == 1 || !$is_patch)) {
		exit(0);
	}

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

	if (!$is_patch) {
5386 5387
		ERROR("NOT_UNIFIED_DIFF",
		      "Does not appear to be a unified-diff format patch\n");
5388 5389
	}
	if ($is_patch && $chk_signoff && $signoff == 0) {
5390 5391
		ERROR("MISSING_SIGN_OFF",
		      "Missing Signed-off-by: line(s)\n");
5392 5393
	}

5394
	print report_dump();
5395 5396
	if ($summary && !($clean == 1 && $quiet == 1)) {
		print "$filename " if ($summary_file);
5397 5398 5399 5400
		print "total: $cnt_error errors, $cnt_warn warnings, " .
			(($check)? "$cnt_chk checks, " : "") .
			"$cnt_lines lines checked\n";
		print "\n" if ($quiet == 0);
5401
	}
5402

5403
	if ($quiet == 0) {
5404 5405 5406 5407 5408 5409

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

5410 5411 5412 5413 5414
		# If there were whitespace errors which cleanpatch can fix
		# then suggest that.
		if ($rpt_cleaners) {
			print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
			print "      scripts/cleanfile\n\n";
5415
			$rpt_cleaners = 0;
5416 5417 5418
		}
	}

5419 5420
	hash_show_words(\%use_type, "Used");
	hash_show_words(\%ignore_type, "Ignored");
5421

5422 5423 5424
	if ($clean == 0 && $fix &&
	    ("@rawlines" ne "@fixed" ||
	     $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
5425 5426
		my $newfile = $filename;
		$newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
5427 5428 5429
		my $linecount = 0;
		my $f;

5430 5431
		@fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);

5432 5433 5434 5435 5436 5437 5438
		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/^\+//;
5439
					print $f $fixed_line . "\n";
5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460
				}
			} else {
				print $f $fixed_line . "\n";
			}
		}
		close($f);

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

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

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

EOM
		}
	}

5461
	if ($clean == 1 && $quiet == 0) {
5462
		print "$vname has no obvious style problems and is ready for submission.\n"
5463 5464
	}
	if ($clean == 0 && $quiet == 0) {
5465 5466 5467 5468 5469 5470
		print << "EOM";
$vname has style problems, please review.

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

5473 5474
	return $clean;
}