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

use strict;
9
use POSIX;
10 11
use File::Basename;
use Cwd 'abs_path';
12 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 281 282
			__percpu|
			__nocast|
			__safe|
			__bitwise__|
			__packed__|
			__packed2__|
			__naked|
			__maybe_unused|
			__always_unused|
			__noreturn|
			__used|
			__cold|
			__noclone|
			__deprecated|
283 284
			__read_mostly|
			__kprobes|
285
			$InitAttribute|
286 287
			____cacheline_aligned|
			____cacheline_aligned_in_smp|
288 289
			____cacheline_internodealigned_in_smp|
			__weak
290
		  }x;
291
our $Modifier;
292
our $Inline	= qr{inline|__always_inline|noinline|__inline|__inline__};
293 294 295
our $Member	= qr{->$Ident|\.$Ident|\[[^]]*\]};
our $Lval	= qr{$Ident(?:$Member)*};

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

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

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

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

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

341
our $typeTypedefs = qr{(?x:
342
	(?:__)?(?:u|s|be|le)(?:8|16|32|64)|
343 344 345
	atomic_t
)};

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

355 356 357 358 359 360
our $signature_tags = qr{(?xi:
	Signed-off-by:|
	Acked-by:|
	Tested-by:|
	Reviewed-by:|
	Reported-by:|
361
	Suggested-by:|
362 363 364 365
	To:|
	Cc:
)};

366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
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},
);

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

413 414 415
our @modifierList = (
	qr{fastcall},
);
416

417 418 419 420 421 422 423 424 425
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],
);

426 427 428 429 430 431 432
#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];
}

433 434
our $allowed_asm_includes = qr{(?x:
	irq|
435 436 437
	memory|
	time|
	reboot
438 439 440
)};
# memory.h: ARM has a custom one

441 442 443 444
# Load common spelling mistakes and build regular expression list.
my $misspellings;
my %spelling_fix;

445 446 447 448
if (open(my $spelling, '<', $spelling_file)) {
	my @spelling_list;
	while (<$spelling>) {
		my $line = $_;
449

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

453 454 455 456
		next if ($line =~ m/^\s*#/);
		next if ($line =~ m/^\s*$/);

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

458 459 460 461 462 463 464
		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";
465 466
}

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

513
our $Typecast	= qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
514 515 516 517 518 519

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

523 524 525 526 527 528
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*\(
)};

529 530 531
sub deparenthesize {
	my ($string) = @_;
	return "" if (!defined($string));
532 533 534 535 536 537

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

538
	$string =~ s@\s+@ @g;
539

540 541 542
	return $string;
}

543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560
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;
561 562 563
		} 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*[;\{]/) {
564 565 566 567 568 569 570 571 572 573
			$camelcase{$1} = 1;
		}
	}
}

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

	my $files;
574 575 576 577
	my $camelcase_cache = "";
	my @include_files = ();

	$camelcase_seeded = 1;
578

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

607
	if (-e ".git") {
608 609 610 611
		$files = `git ls-files "include/*.h"`;
		@include_files = split('\n', $files);
	}

612 613 614
	foreach my $file (@include_files) {
		seed_camelcase_file($file);
	}
615

616
	if ($camelcase_cache ne "") {
617
		unlink glob ".checkpatch-camelcase.*";
618 619
		open(my $camelcase_file, '>', "$camelcase_cache")
		    or warn "$P: Can't write '$camelcase_cache' $!\n";
620 621 622 623 624
		foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
			print $camelcase_file ("$_\n");
		}
		close($camelcase_file);
	}
625 626
}

627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654
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);

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

655 656
$chk_signoff = 0 if ($file);

657
my @rawlines = ();
658
my @lines = ();
659
my @fixed = ();
660 661
my @fixed_inserted = ();
my @fixed_deleted = ();
662 663
my $fixlinenr = -1;

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

exit($exit);

sub top_of_kernel_tree {
700 701 702 703 704 705 706 707 708 709 710 711
	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;
		}
712
	}
713
	return 1;
714
}
715

716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734
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;
735
		$name = trim($name);
736 737 738 739 740 741 742 743 744 745 746 747 748 749
		$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 = "";
		}
	}

750
	$name = trim($name);
751
	$name =~ s/^\"|\"$//g;
752
	$address = trim($address);
753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
	$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;

768
	$name = trim($name);
769
	$name =~ s/^\"|\"$//g;
770
	$address = trim($address);
771 772 773 774 775 776 777 778 779 780 781 782 783 784 785

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

786
sub which {
787
	my ($bin) = @_;
788

789 790 791 792
	foreach my $path (split(/:/, $ENV{PATH})) {
		if (-e "$path/$bin") {
			return "$path/$bin";
		}
793 794
	}

795
	return "";
796 797
}

798 799 800 801 802 803 804 805 806 807 808 809
sub which_conf {
	my ($conf) = @_;

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

	return "";
}

810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829
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;
}
830
sub copy_spacing {
831
	(my $res = shift) =~ tr/\t/ /c;
832 833
	return $res;
}
834

835 836 837 838 839 840 841 842 843 844 845 846 847
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));
}

848 849 850 851 852 853 854 855 856 857 858
my $sanitise_quote = '';

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

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
859 860 861 862 863 864
sub sanitise_line {
	my ($line) = @_;

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

865
	my $qlen = 0;
866 867
	my $off = 0;
	my $c;
868

869 870 871 872 873 874 875 876 877 878 879 880 881 882
	# 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;
883
		}
884
		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
885 886 887 888
			$sanitise_quote = '';
			substr($res, $off, 2, "$;$;");
			$off++;
			next;
889
		}
890 891 892 893 894 895 896
		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
			$sanitise_quote = '//';

			substr($res, $off, 2, $sanitise_quote);
			$off++;
			next;
		}
897 898 899 900 901 902 903

		# 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;
904
		}
905 906 907 908
		# Regular quotes.
		if ($c eq "'" || $c eq '"') {
			if ($sanitise_quote eq '') {
				$sanitise_quote = $c;
909

910 911 912 913 914 915
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
916

917
		#print "c<$c> SQ<$sanitise_quote>\n";
918 919
		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
			substr($res, $off, 1, $;);
920 921
		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
			substr($res, $off, 1, $;);
922 923 924 925 926
		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
			substr($res, $off, 1, 'X');
		} else {
			substr($res, $off, 1, $c);
		}
927 928
	}

929 930 931 932
	if ($sanitise_quote eq '//') {
		$sanitise_quote = '';
	}

933
	# The pathname on a #include may be surrounded by '<' and '>'.
934
	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
935 936 937 938
		my $clean = 'X' x length($1);
		$res =~ s@\<.*\>@<$clean>@;

	# The whole of a #error is a string.
939
	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
940
		my $clean = 'X' x length($1);
941
		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
942 943
	}

944 945 946
	return $res;
}

947 948 949
sub get_quoted_string {
	my ($line, $rawline) = @_;

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

954 955 956 957 958 959
sub ctx_statement_block {
	my ($linenr, $remain, $off) = @_;
	my $line = $linenr - 1;
	my $blk = '';
	my $soff = $off;
	my $coff = $off - 1;
960
	my $coff_set = 0;
961

962 963
	my $loff = 0;

964 965
	my $type = '';
	my $level = 0;
966
	my @stack = ();
967
	my $p;
968 969
	my $c;
	my $len = 0;
970 971

	my $remainder;
972
	while (1) {
973 974
		@stack = (['', 0]) if ($#stack == -1);

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

1003
		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013

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

1014 1015 1016 1017 1018 1019
		# Statement ends at the ';' or a close '}' at the
		# outermost level.
		if ($level == 0 && $c eq ';') {
			last;
		}

1020
		# An else is really a conditional as long as its not else if
1021 1022 1023 1024 1025 1026 1027 1028
		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";
1029 1030
		}

1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
		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;
1041 1042
				$coff_set = 1;
				#warn "CSB: mark coff<$coff>\n";
1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
			}
		}
		if (($type eq '' || $type eq '{') && $c eq '{') {
			$level++;
			$type = '{';
		}
		if ($type eq '{' && $c eq '}') {
			$level--;
			$type = ($level != 0)? '{' : '';

			if ($level == 0) {
1054 1055 1056
				if (substr($blk, $off + 1, 1) eq ';') {
					$off++;
				}
1057 1058 1059
				last;
			}
		}
1060 1061 1062 1063 1064 1065 1066
		# Preprocessor commands end at the newline unless escaped.
		if ($type eq '#' && $c eq "\n" && $p ne "\\") {
			$level--;
			$type = '';
			$off++;
			last;
		}
1067 1068
		$off++;
	}
1069
	# We are truly at the end, so shuffle to the next line.
1070
	if ($off == $len) {
1071
		$loff = $len + 1;
1072 1073 1074
		$line++;
		$remain--;
	}
1075 1076 1077 1078 1079 1080 1081

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

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

1082
	#print "coff<$coff> soff<$off> loff<$loff>\n";
1083 1084 1085 1086 1087

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

1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 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
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;
	}
}

1131 1132 1133 1134 1135 1136
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

1137
	# Grab the first conditional/block pair.
1138 1139
	($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
1140
	#print "F: c<$condition> s<$statement> remain<$remain>\n";
1141 1142 1143 1144 1145 1146 1147
	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.
1148 1149 1150
	for (;;) {
		($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
1151
		#print "C: c<$condition> s<$statement> remain<$remain>\n";
1152
		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1153 1154
		#print "C: push\n";
		push(@chunks, [ $condition, $statement ]);
1155 1156 1157
	}

	return ($level, $linenr, @chunks);
1158 1159
}

1160
sub ctx_block_get {
1161
	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1162 1163 1164 1165 1166 1167 1168
	my $line;
	my $start = $linenr - 1;
	my $blk = '';
	my @o;
	my @c;
	my @res = ();

1169
	my $level = 0;
1170
	my @stack = ($level);
1171 1172 1173 1174 1175
	for ($line = $start; $remain > 0; $line++) {
		next if ($rawlines[$line] =~ /^-/);
		$remain--;

		$blk .= $rawlines[$line];
1176 1177

		# Handle nested #if/#else.
1178
		if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1179
			push(@stack, $level);
1180
		} elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1181
			$level = $stack[$#stack - 1];
1182
		} elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1183 1184 1185
			$level = pop(@stack);
		}

1186
		foreach my $c (split(//, $lines[$line])) {
1187 1188 1189 1190 1191
			##print "C<$c>L<$level><$open$close>O<$off>\n";
			if ($off > 0) {
				$off--;
				next;
			}
1192

1193 1194 1195 1196 1197 1198 1199
			if ($c eq $close && $level > 0) {
				$level--;
				last if ($level == 0);
			} elsif ($c eq $open) {
				$level++;
			}
		}
1200

1201
		if (!$outer || $level <= 1) {
1202
			push(@res, $rawlines[$line]);
1203 1204
		}

1205
		last if ($level == 0);
1206 1207
	}

1208
	return ($level, @res);
1209 1210 1211 1212
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

1213 1214
	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
	return @r;
1215 1216 1217 1218
}
sub ctx_block {
	my ($linenr, $remain) = @_;

1219 1220
	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
	return @r;
1221 1222
}
sub ctx_statement {
1223 1224 1225 1226 1227 1228
	my ($linenr, $remain, $off) = @_;

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

1231
	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1232
}
1233 1234 1235 1236 1237
sub ctx_statement_level {
	my ($linenr, $remain, $off) = @_;

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
1238 1239 1240 1241 1242

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

	# Catch a comment on the end of the line itself.
1243
	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1244 1245 1246 1247 1248 1249 1250
	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++) {
1251 1252
		my $line = $rawlines[$linenr - 1];
		#warn "           $line\n";
1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274
		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);

1275
	##print "LINE: $rawlines[$end_line - 1 ]\n";
1276 1277 1278 1279 1280
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296
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;
}

1297 1298 1299
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
1300

1301 1302 1303 1304 1305 1306
	$res = '';
	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
		$res .= $1;
		if ($2 ne '') {
			$coded = sprintf("^%c", unpack('C', $2) + 64);
			$res .= $coded;
1307 1308
		}
	}
1309
	$res =~ s/$/\$/;
1310

1311
	return $res;
1312 1313
}

1314
my $av_preprocessor = 0;
1315
my $av_pending;
1316
my @av_paren_type;
1317
my $av_pend_colon;
1318 1319 1320

sub annotate_reset {
	$av_preprocessor = 0;
1321 1322
	$av_pending = '_';
	@av_paren_type = ('E');
1323
	$av_pend_colon = 'O';
1324 1325
}

1326 1327
sub annotate_values {
	my ($stream, $type) = @_;
1328

1329
	my $res;
1330
	my $var = '_' x length($stream);
1331 1332
	my $cur = $stream;

1333
	print "$stream\n" if ($dbg_values > 1);
1334 1335

	while (length($cur)) {
1336
		@av_paren_type = ('E') if ($#av_paren_type < 0);
1337
		print " <" . join('', @av_paren_type) .
1338
				"> <$type> <$av_pending>" if ($dbg_values > 1);
1339
		if ($cur =~ /^(\s+)/o) {
1340 1341
			print "WS($1)\n" if ($dbg_values > 1);
			if ($1 =~ /\n/ && $av_preprocessor) {
1342
				$type = pop(@av_paren_type);
1343
				$av_preprocessor = 0;
1344 1345
			}

1346
		} elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1347 1348
			print "CAST($1)\n" if ($dbg_values > 1);
			push(@av_paren_type, $type);
1349
			$type = 'c';
1350

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

1355 1356 1357 1358
		} elsif ($cur =~ /^($Modifier)\s*/) {
			print "MODIFIER($1)\n" if ($dbg_values > 1);
			$type = 'T';

1359
		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1360
			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1361
			$av_preprocessor = 1;
1362 1363 1364 1365 1366 1367
			push(@av_paren_type, $type);
			if ($2 ne '') {
				$av_pending = 'N';
			}
			$type = 'E';

1368
		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1369 1370 1371
			print "UNDEF($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;
			push(@av_paren_type, $type);
1372

1373
		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1374
			print "PRE_START($1)\n" if ($dbg_values > 1);
1375
			$av_preprocessor = 1;
1376 1377 1378

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
1379
			$type = 'E';
1380

1381
		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1382 1383 1384 1385 1386
			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;

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

1387
			$type = 'E';
1388

1389
		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1390 1391 1392 1393 1394 1395 1396 1397
			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);
1398
			$type = 'E';
1399 1400

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

1403 1404 1405 1406 1407
		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
			print "ATTR($1)\n" if ($dbg_values > 1);
			$av_pending = $type;
			$type = 'N';

1408
		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1409
			print "SIZEOF($1)\n" if ($dbg_values > 1);
1410
			if (defined $2) {
1411
				$av_pending = 'V';
1412 1413 1414
			}
			$type = 'N';

1415
		} elsif ($cur =~ /^(if|while|for)\b/o) {
1416
			print "COND($1)\n" if ($dbg_values > 1);
1417
			$av_pending = 'E';
1418 1419
			$type = 'N';

1420 1421 1422 1423 1424
		} elsif ($cur =~/^(case)/o) {
			print "CASE($1)\n" if ($dbg_values > 1);
			$av_pend_colon = 'C';
			$type = 'N';

1425
		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1426
			print "KEYWORD($1)\n" if ($dbg_values > 1);
1427 1428 1429
			$type = 'N';

		} elsif ($cur =~ /^(\()/o) {
1430
			print "PAREN('$1')\n" if ($dbg_values > 1);
1431 1432
			push(@av_paren_type, $av_pending);
			$av_pending = '_';
1433 1434 1435
			$type = 'N';

		} elsif ($cur =~ /^(\))/o) {
1436 1437 1438
			my $new_type = pop(@av_paren_type);
			if ($new_type ne '_') {
				$type = $new_type;
1439 1440
				print "PAREN('$1') -> $type\n"
							if ($dbg_values > 1);
1441
			} else {
1442
				print "PAREN('$1')\n" if ($dbg_values > 1);
1443 1444
			}

1445
		} elsif ($cur =~ /^($Ident)\s*\(/o) {
1446
			print "FUNC($1)\n" if ($dbg_values > 1);
1447
			$type = 'V';
1448
			$av_pending = 'V';
1449

1450 1451
		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
			if (defined $2 && $type eq 'C' || $type eq 'T') {
1452
				$av_pend_colon = 'B';
1453 1454
			} elsif ($type eq 'E') {
				$av_pend_colon = 'L';
1455 1456 1457 1458
			}
			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
			$type = 'V';

1459
		} elsif ($cur =~ /^($Ident|$Constant)/o) {
1460
			print "IDENT($1)\n" if ($dbg_values > 1);
1461 1462 1463
			$type = 'V';

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

1467
		} elsif ($cur =~/^(;|{|})/) {
1468
			print "END($1)\n" if ($dbg_values > 1);
1469
			$type = 'E';
1470 1471
			$av_pend_colon = 'O';

1472 1473 1474 1475
		} elsif ($cur =~/^(,)/) {
			print "COMMA($1)\n" if ($dbg_values > 1);
			$type = 'C';

1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489
		} 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';
1490

1491
		} elsif ($cur =~ /^(\[)/o) {
1492
			print "CLOSE($1)\n" if ($dbg_values > 1);
1493 1494
			$type = 'N';

1495
		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507
			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';

1508
		} elsif ($cur =~ /^($Operators)/o) {
1509
			print "OP($1)\n" if ($dbg_values > 1);
1510 1511 1512 1513 1514
			if ($1 ne '++' && $1 ne '--') {
				$type = 'N';
			}

		} elsif ($cur =~ /(^.)/o) {
1515
			print "C($1)\n" if ($dbg_values > 1);
1516 1517 1518 1519 1520
		}
		if (defined $1) {
			$cur = substr($cur, length($1));
			$res .= $type x length($1);
		}
1521
	}
1522

1523
	return ($res, $var);
1524 1525
}

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

		} else {
			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
			push(@typeList, $possible);
		}
1567
		build_types();
1568 1569
	} else {
		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1570 1571 1572
	}
}

1573 1574
my $prefix = '';

1575
sub show_type {
1576
	my ($type) = @_;
1577

1578 1579 1580
	return defined $use_type{$type} if (scalar keys %use_type > 0);

	return !defined $ignore_type{$type};
1581 1582
}

1583
sub report {
1584 1585 1586 1587
	my ($level, $type, $msg) = @_;

	if (!show_type($type) ||
	    (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1588 1589
		return 0;
	}
1590 1591
	my $line;
	if ($show_types) {
1592
		$line = "$prefix$level:$type: $msg\n";
1593
	} else {
1594
		$line = "$prefix$level: $msg\n";
1595
	}
1596 1597
	$line = (split('\n', $line))[0] . "\n" if ($terse);

1598
	push(our @report, $line);
1599 1600

	return 1;
1601
}
1602

1603
sub report_dump {
1604
	our @report;
1605
}
1606

1607 1608 1609 1610 1611 1612 1613 1614 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
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;
}

1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690
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);
}

1691
sub ERROR {
1692 1693 1694
	my ($type, $msg) = @_;

	if (report("ERROR", $type, $msg)) {
1695 1696
		our $clean = 0;
		our $cnt_error++;
1697
		return 1;
1698
	}
1699
	return 0;
1700 1701
}
sub WARN {
1702 1703 1704
	my ($type, $msg) = @_;

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

	if ($check && report("CHECK", $type, $msg)) {
1715 1716
		our $clean = 0;
		our $cnt_chk++;
1717
		return 1;
1718
	}
1719
	return 0;
1720 1721
}

1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744
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 ".../") {
1745 1746
		WARN("USE_RELATIVE_PATH",
		     "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1747 1748 1749
	}
}

1750 1751 1752
sub trim {
	my ($string) = @_;

1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769
	$string =~ s/^\s+|\s+$//g;

	return $string;
}

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

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

	return $string;
}

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

	$string =~ s/\s+$//;
1770 1771 1772 1773

	return $string;
}

1774 1775 1776 1777 1778 1779 1780 1781
sub string_find_replace {
	my ($string, $find, $replace) = @_;

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

	return $string;
}

1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796
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";
}

1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823
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;
		}
	}

1824
	return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
1825 1826
}

1827 1828 1829 1830 1831
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
1832
	my $prevrawline="";
1833
	my $stashline="";
1834
	my $stashrawline="";
1835

1836
	my $length;
1837 1838 1839 1840
	my $indent;
	my $previndent=0;
	my $stashindent=0;

1841
	our $clean = 1;
1842 1843 1844
	my $signoff = 0;
	my $is_patch = 0;

1845
	my $in_header_lines = $file ? 0 : 1;
1846
	my $in_commit_log = 0;		#Scanning lines before patch
1847
	my $reported_maintainer_file = 0;
1848 1849
	my $non_utf8_charset = 0;

1850
	my $last_blank_line = 0;
1851
	my $last_coalesced_string_linenr = -1;
1852

1853
	our @report = ();
1854 1855 1856 1857 1858
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

1859 1860 1861 1862 1863 1864
	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
	my $in_comment = 0;
1865
	my $comment_edge = 0;
1866
	my $first_line = 0;
1867
	my $p1_prefix = '';
1868

1869 1870 1871
	my $prev_values = 'E';

	# suppression flags
1872
	my %suppress_ifbraces;
1873
	my %suppress_whiletrailers;
1874
	my %suppress_export;
1875
	my $suppress_statement = 0;
1876

1877
	my %signatures = ();
1878

1879
	# Pre-scan the patch sanitizing the lines.
1880
	# Pre-scan the patch looking for any __setup documentation.
1881
	#
1882 1883
	my @setup_docs = ();
	my $setup_docs = 0;
1884

1885 1886
	my $camelcase_file_seeded = 0;

1887
	sanitise_line_reset();
1888 1889
	my $line;
	foreach my $rawline (@rawlines) {
1890 1891
		$linenr++;
		$line = $rawline;
1892

1893 1894
		push(@fixed, $rawline) if ($fix);

1895
		if ($rawline=~/^\+\+\+\s+(\S+)/) {
1896 1897 1898 1899
			$setup_docs = 0;
			if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
				$setup_docs = 1;
			}
1900 1901 1902 1903 1904 1905 1906 1907 1908
			#next;
		}
		if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1909
			$in_comment = 0;
1910 1911 1912 1913 1914 1915

			# 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;
1916 1917 1918 1919 1920 1921
			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";
1922
				last if (!defined $rawlines[$ln - 1]);
1923 1924 1925 1926 1927
				if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
				    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
					($edge) = $1;
					last;
				}
1928 1929 1930 1931 1932 1933 1934 1935 1936
			}
			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 &&
1937
			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1938 1939 1940 1941 1942 1943 1944
			{
				$in_comment = 1;
			}

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

1945
		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1946
			# Standardise the strings and chars within the input to
1947
			# simplify matching -- only bother with positive lines.
1948
			$line = sanitise_line($rawline);
1949
		}
1950 1951 1952 1953 1954 1955 1956 1957 1958 1959
		push(@lines, $line);

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

		#print "==>$rawline\n";
		#print "-->$line\n";
1960 1961 1962 1963 1964 1965

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

1966 1967
	$prefix = '';

1968 1969
	$realcnt = 0;
	$linenr = 0;
1970
	$fixlinenr = -1;
1971 1972
	foreach my $line (@lines) {
		$linenr++;
1973
		$fixlinenr++;
1974 1975
		my $sline = $line;	#copy of $line
		$sline =~ s/$;/ /g;	#with comments as spaces
1976

1977
		my $rawline = $rawlines[$linenr - 1];
1978

1979
#extract the line range in the file after the patch is applied
1980
		if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1981
			$is_patch = 1;
1982
			$first_line = $linenr + 1;
1983 1984 1985 1986 1987 1988
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1989
			annotate_reset();
1990 1991
			$prev_values = 'E';

1992
			%suppress_ifbraces = ();
1993
			%suppress_whiletrailers = ();
1994
			%suppress_export = ();
1995
			$suppress_statement = 0;
1996 1997
			next;

1998 1999 2000
# 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.
2001
		} elsif ($line =~ /^( |\+|$)/) {
2002
			$realline++;
2003
			$realcnt-- if ($realcnt != 0);
2004

2005
			# Measure the line length and indent.
2006
			($length, $indent) = line_stats($rawline);
2007 2008 2009 2010

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

2013
			#warn "line<$line>\n";
2014

2015 2016
		} elsif ($realcnt == 1) {
			$realcnt--;
2017 2018
		}

2019 2020
		my $hunk_line = ($realcnt != 0);

2021
#make up the handle for any error we report on this line
2022 2023 2024
		$prefix = "$filename:$realline: " if ($emacs && $file);
		$prefix = "$filename:$linenr: " if ($emacs && !$file);

2025 2026
		$here = "#$linenr: " if (!$file);
		$here = "#$realline: " if ($file);
2027

2028
		my $found_file = 0;
2029
		# extract the filename as it passes
2030 2031
		if ($line =~ /^diff --git.*?(\S+)$/) {
			$realfile = $1;
2032
			$realfile =~ s@^([^/]*)/@@ if (!$file);
2033
			$in_commit_log = 0;
2034
			$found_file = 1;
2035
		} elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2036
			$realfile = $1;
2037
			$realfile =~ s@^([^/]*)/@@ if (!$file);
2038
			$in_commit_log = 0;
2039 2040

			$p1_prefix = $1;
2041 2042
			if (!$file && $tree && $p1_prefix ne '' &&
			    -e "$root/$p1_prefix") {
2043 2044
				WARN("PATCH_PREFIX",
				     "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2045
			}
2046

2047
			if ($realfile =~ m@^include/asm/@) {
2048 2049
				ERROR("MODIFIED_INCLUDE_ASM",
				      "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2050
			}
2051 2052 2053 2054 2055 2056 2057 2058 2059
			$found_file = 1;
		}

		if ($found_file) {
			if ($realfile =~ m@^(drivers/net/|net/)@) {
				$check = 1;
			} else {
				$check = $check_orig;
			}
2060 2061 2062
			next;
		}

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

2065 2066 2067
		my $hereline = "$here\n$rawline\n";
		my $herecurr = "$here\n$rawline\n";
		my $hereprev = "$here\n$prevrawline\n$rawline\n";
2068

2069 2070
		$cnt_lines++ if ($realcnt != 0);

2071 2072 2073
# Check for incorrect file permissions
		if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
			my $permhere = $here . "FILE: $realfile\n";
2074 2075
			if ($realfile !~ m@scripts/@ &&
			    $realfile !~ /\.(py|pl|awk|sh)$/) {
2076 2077
				ERROR("EXECUTE_PERMISSIONS",
				      "do not set execute permissions for source files\n" . $permhere);
2078 2079 2080
			}
		}

2081
# Check the patch for a signoff:
2082
		if ($line =~ /^\s*signed-off-by:/i) {
2083
			$signoff++;
2084
			$in_commit_log = 0;
2085 2086
		}

2087 2088 2089 2090 2091 2092
# 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;
		}

2093
# Check signature styles
2094
		if (!$in_header_lines &&
2095
		    $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2096 2097 2098 2099 2100 2101
			my $space_before = $1;
			my $sign_off = $2;
			my $space_after = $3;
			my $email = $4;
			my $ucfirst_sign_off = ucfirst(lc($sign_off));

2102 2103 2104 2105
			if ($sign_off !~ /$signature_tags/) {
				WARN("BAD_SIGN_OFF",
				     "Non-standard signature: $sign_off\n" . $herecurr);
			}
2106
			if (defined $space_before && $space_before ne "") {
2107 2108 2109
				if (WARN("BAD_SIGN_OFF",
					 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
				    $fix) {
2110
					$fixed[$fixlinenr] =
2111 2112
					    "$ucfirst_sign_off $email";
				}
2113 2114
			}
			if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2115 2116 2117
				if (WARN("BAD_SIGN_OFF",
					 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
				    $fix) {
2118
					$fixed[$fixlinenr] =
2119 2120 2121
					    "$ucfirst_sign_off $email";
				}

2122 2123
			}
			if (!defined $space_after || $space_after ne " ") {
2124 2125 2126
				if (WARN("BAD_SIGN_OFF",
					 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
				    $fix) {
2127
					$fixed[$fixlinenr] =
2128 2129
					    "$ucfirst_sign_off $email";
				}
2130
			}
2131 2132 2133 2134

			my ($email_name, $email_address, $comment) = parse_email($email);
			my $suggested_email = format_email(($email_name, $email_address));
			if ($suggested_email eq "") {
2135 2136
				ERROR("BAD_SIGN_OFF",
				      "Unrecognized email address: '$email'\n" . $herecurr);
2137 2138 2139 2140 2141 2142 2143 2144 2145
			} 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) {
2146 2147
					WARN("BAD_SIGN_OFF",
					     "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2148
				}
2149
			}
2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160

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

2163 2164 2165 2166 2167 2168
# 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);
		}

2169 2170 2171 2172 2173 2174
# 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);
		}

2175 2176 2177
# Check for improperly formed commit descriptions
		if ($in_commit_log &&
		    $line =~ /\bcommit\s+[0-9a-f]{5,}/i &&
2178 2179 2180 2181
		    !($line =~ /\b[Cc]ommit [0-9a-f]{12,40} \("/ ||
		      ($line =~ /\b[Cc]ommit [0-9a-f]{12,40}\s*$/ &&
		       defined $rawlines[$linenr] &&
		       $rawlines[$linenr] =~ /^\s*\("/))) {
2182 2183 2184 2185 2186 2187 2188
			$line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i;
			my $init_char = $1;
			my $orig_commit = lc($2);
			my $id = '01234567890ab';
			my $desc = 'commit description';
		        ($id, $desc) = git_commit_info($orig_commit, $id, $desc);
			ERROR("GIT_COMMIT_ID",
2189
			      "Please use 12 or more chars for the git commit ID like: '${init_char}ommit $id (\"$desc\")'\n" . $herecurr);
2190 2191
		}

2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202
# 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);
		}

2203
# Check for wrappage within a valid hunk of the file
2204
		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2205 2206
			ERROR("CORRUPTED_PATCH",
			      "patch seems to be corrupt (line wrapped?)\n" .
2207
				$herecurr) if (!$emitted_corrupt++);
2208 2209
		}

2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223
# 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);
				}
			}
		}

2224 2225
# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2226 2227 2228 2229 2230 2231 2232
		    $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";

2233 2234
			CHK("INVALID_UTF8",
			    "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2235 2236
		}

2237 2238 2239
# 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 =~ /^$/ &&
2240 2241
		    !($rawline =~ /^\s+\S/ ||
		      $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
2242 2243 2244 2245
			$in_header_lines = 0;
			$in_commit_log = 1;
		}

2246 2247 2248 2249 2250 2251 2252 2253 2254
# 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 =~ /^$/ &&
2255
		    $rawline =~ /$NON_ASCII_UTF8/) {
2256
			WARN("UTF8_BEFORE_PATCH",
2257 2258 2259
			    "8-bit UTF-8 used in possible commit log\n" . $herecurr);
		}

2260
# Check for various typo / spelling mistakes
2261
		if (defined($misspellings) && ($in_commit_log || $line =~ /^\+/)) {
2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276
			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/;
				}
			}
		}

2277 2278
# ignore non-hunk lines and lines being removed
		next if (!$hunk_line || $line =~ /^-/);
2279 2280

#trailing whitespace
2281
		if ($line =~ /^\+.*\015/) {
2282
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2283 2284 2285
			if (ERROR("DOS_LINE_ENDINGS",
				  "DOS line endings\n" . $herevet) &&
			    $fix) {
2286
				$fixed[$fixlinenr] =~ s/[\s\015]+$//;
2287
			}
2288 2289
		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2290 2291 2292
			if (ERROR("TRAILING_WHITESPACE",
				  "trailing whitespace\n" . $herevet) &&
			    $fix) {
2293
				$fixed[$fixlinenr] =~ s/\s+$//;
2294 2295
			}

2296
			$rpt_cleaners = 1;
2297
		}
2298

2299
# Check for FSF mailing addresses.
2300
		if ($rawline =~ /\bwrite to the Free/i ||
2301 2302
		    $rawline =~ /\b59\s+Temple\s+Pl/i ||
		    $rawline =~ /\b51\s+Franklin\s+St/i) {
2303 2304 2305 2306
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
			my $msg_type = \&ERROR;
			$msg_type = \&CHK if ($file);
			&{$msg_type}("FSF_MAILING_ADDRESS",
2307
				     "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)
2308 2309
		}

2310
# check for Kconfig help text having a real description
2311 2312
# Only applies when adding the entry originally, after that we do not have
# sufficient context to determine whether it is indeed long enough.
2313
		if ($realfile =~ /Kconfig/ &&
2314
		    $line =~ /^\+\s*config\s+/) {
2315
			my $length = 0;
2316 2317 2318
			my $cnt = $realcnt;
			my $ln = $linenr + 1;
			my $f;
2319
			my $is_start = 0;
2320
			my $is_end = 0;
2321
			for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2322 2323 2324 2325 2326
				$f = $lines[$ln - 1];
				$cnt-- if ($lines[$ln - 1] !~ /^-/);
				$is_end = $lines[$ln - 1] =~ /^\+/;

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

2329
				if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
2330
					$is_start = 1;
2331
				} elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
2332 2333 2334
					$length = -1;
				}

2335
				$f =~ s/^.//;
2336 2337 2338
				$f =~ s/#.*//;
				$f =~ s/^\s+//;
				next if ($f =~ /^$/);
2339 2340 2341 2342
				if ($f =~ /^\s*config\s/) {
					$is_end = 1;
					last;
				}
2343 2344
				$length++;
			}
2345 2346 2347 2348
			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);
			}
2349
			#print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2350 2351
		}

2352 2353 2354 2355 2356 2357 2358
# 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");
		}

2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372
		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});
		}

2373
# check for DT compatible documentation
2374 2375 2376 2377
		if (defined $root &&
			(($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
			 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {

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

2380 2381 2382
			my $dt_path = $root . "/Documentation/devicetree/bindings/";
			my $vp_file = $dt_path . "vendor-prefixes.txt";

2383 2384
			foreach my $compat (@compats) {
				my $compat2 = $compat;
2385 2386 2387 2388
				$compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
				my $compat3 = $compat;
				$compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
				`grep -Erq "$compat|$compat2|$compat3" $dt_path`;
2389 2390 2391 2392 2393
				if ( $? >> 8 ) {
					WARN("UNDOCUMENTED_DT_STRING",
					     "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
				}

2394 2395
				next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
				my $vendor = $1;
2396
				`grep -Eq "^$vendor\\b" $vp_file`;
2397 2398
				if ( $? >> 8 ) {
					WARN("UNDOCUMENTED_DT_STRING",
2399
					     "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2400 2401 2402 2403
				}
			}
		}

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

2407
#line length limit
2408
		if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
2409
		    $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
2410
		    !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
2411
		    $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
2412
		    $length > $max_line_length)
2413
		{
2414
			WARN("LONG_LINE",
2415
			     "line over $max_line_length characters\n" . $herecurr);
2416 2417
		}

2418 2419
# check for adding lines without a newline.
		if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2420 2421
			WARN("MISSING_EOF_NEWLINE",
			     "adding a line without newline at end of file\n" . $herecurr);
2422 2423
		}

2424 2425 2426 2427
# 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";
2428 2429
				ERROR("LO_MACRO",
				      "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2430 2431 2432
			}
			if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
				my $herevet = "$here\n" . cat_vet($line) . "\n";
2433 2434
				ERROR("HI_MACRO",
				      "use the HI() macro, not (... >> 16)\n" . $herevet);
2435 2436 2437
			}
		}

2438
# check we are in a valid source file C or perl if not then ignore this hunk
2439
		next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
2440 2441 2442

# at the beginning of a line any tabs must come first and anything
# more than 8 must use tabs.
2443 2444 2445
		if ($rawline =~ /^\+\s* \t\s*\S/ ||
		    $rawline =~ /^\+\s*        \s*/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2446
			$rpt_cleaners = 1;
2447 2448 2449
			if (ERROR("CODE_INDENT",
				  "code indent should use tabs where possible\n" . $herevet) &&
			    $fix) {
2450
				$fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2451
			}
2452 2453
		}

2454 2455 2456
# check for space before tabs.
		if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2457 2458 2459
			if (WARN("SPACE_BEFORE_TAB",
				"please, no space before tabs\n" . $herevet) &&
			    $fix) {
2460
				while ($fixed[$fixlinenr] =~
2461
					   s/(^\+.*) {8,8}\t/$1\t\t/) {}
2462
				while ($fixed[$fixlinenr] =~
2463
					   s/(^\+.*) +\t/$1\t/) {}
2464
			}
2465 2466
		}

2467 2468 2469 2470 2471 2472 2473 2474
# 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 &&
2475
		    $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2476 2477 2478 2479 2480 2481
			$prevline =~ /^\+(\t*)(.*)$/;
			my $oldindent = $1;
			my $rest = $2;

			my $pos = pos_last_openparen($rest);
			if ($pos >= 0) {
J
Joe Perches 已提交
2482 2483
				$line =~ /^(\+| )([ \t]*)/;
				my $newindent = $2;
2484 2485 2486 2487 2488 2489 2490 2491

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

				if ($newindent ne $goodtabindent &&
				    $newindent ne $goodspaceindent) {
2492 2493 2494 2495

					if (CHK("PARENTHESIS_ALIGNMENT",
						"Alignment should match open parenthesis\n" . $hereprev) &&
					    $fix && $line =~ /^\+/) {
2496
						$fixed[$fixlinenr] =~
2497 2498
						    s/^\+[ \t]*/\+$goodtabindent/;
					}
2499 2500 2501 2502
				}
			}
		}

2503 2504
		if ($line =~ /^\+.*(\w+\s*)?\(\s*$Type\s*\)[ \t]+(?!$Assignment|$Arithmetic|[,;\({\[\<\>])/ &&
		    (!defined($1) || $1 !~ /sizeof\s*/)) {
2505
			if (CHK("SPACING",
2506
				"No space is necessary after a cast\n" . $herecurr) &&
2507
			    $fix) {
2508
				$fixed[$fixlinenr] =~
2509
				    s/(\(\s*$Type\s*\))[ \t]+/$1/;
2510
			}
2511 2512
		}

2513
		if ($realfile =~ m@^(drivers/net/|net/)@ &&
2514
		    $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2515 2516
		    $rawline =~ /^\+[ \t]*\*/ &&
		    $realline > 2) {
2517 2518 2519 2520 2521
			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
			     "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
		}

		if ($realfile =~ m@^(drivers/net/|net/)@ &&
2522 2523
		    $prevrawline =~ /^\+[ \t]*\/\*/ &&		#starting /*
		    $prevrawline !~ /\*\/[ \t]*$/ &&		#no trailing */
2524
		    $rawline =~ /^\+/ &&			#line is new
2525 2526 2527 2528 2529 2530
		    $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/)@ &&
2531 2532 2533 2534
		    $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ &&	#trailing */
		    $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ &&	#inline /*...*/
		    $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ &&	#trailing **/
		    $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) {	#non blank */
2535 2536 2537 2538
			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
			     "networking block comments put the trailing */ on a separate line\n" . $herecurr);
		}

2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550
# 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/)) {
2551 2552 2553
			if (CHK("LINE_SPACING",
				"Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
			    $fix) {
2554
				fix_insert_line($fixlinenr, "\+");
2555
			}
2556 2557
		}

2558 2559 2560 2561
# check for multiple consecutive blank lines
		if ($prevline =~ /^[\+ ]\s*$/ &&
		    $line =~ /^\+\s*$/ &&
		    $last_blank_line != ($linenr - 1)) {
2562 2563 2564
			if (CHK("LINE_SPACING",
				"Please don't use multiple blank lines\n" . $hereprev) &&
			    $fix) {
2565
				fix_delete_line($fixlinenr, $rawline);
2566 2567
			}

2568 2569 2570
			$last_blank_line = $linenr;
		}

2571
# check for missing blank lines after declarations
2572 2573 2574
		if ($sline =~ /^\+\s+\S/ &&			#Not at char 1
			# actual declarations
		    ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2575 2576
			# function pointer declarations
		     $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588
			# 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*[=,;:\[]/ ||
2589 2590
			# function pointer declarations
		      $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2591 2592 2593 2594 2595
			# 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
2596
		      $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
2597 2598 2599 2600 2601 2602 2603 2604
			# 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/)) {
2605 2606 2607
			if (WARN("LINE_SPACING",
				 "Missing a blank line after declarations\n" . $hereprev) &&
			    $fix) {
2608
				fix_insert_line($fixlinenr, "\+");
2609
			}
2610 2611
		}

2612
# check for spaces at the beginning of a line.
2613 2614 2615 2616
# Exceptions:
#  1) within comments
#  2) indented preprocessor commands
#  3) hanging labels
2617
		if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/)  {
2618
			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2619 2620 2621
			if (WARN("LEADING_SPACE",
				 "please, no spaces at the start of a line\n" . $herevet) &&
			    $fix) {
2622
				$fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2623
			}
2624 2625
		}

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

2629
# check indentation of any line with a bare else
2630
# (but not if it is a multiple line "if (foo) return bar; else return baz;")
2631 2632 2633
# 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;
2634 2635 2636 2637
			if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
			    ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
			     defined $lines[$linenr] &&
			     $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
2638 2639 2640 2641 2642
				WARN("UNNECESSARY_ELSE",
				     "else is not generally useful after a break or return\n" . $hereprev);
			}
		}

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

2653 2654 2655 2656 2657 2658
# 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");
		}

2659
# check for RCS/CVS revision markers
2660
		if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
2661 2662
			WARN("CVS_KEYWORD",
			     "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
2663
		}
2664

2665 2666 2667
# Blackfin: don't use __builtin_bfin_[cs]sync
		if ($line =~ /__builtin_bfin_csync/) {
			my $herevet = "$here\n" . cat_vet($line) . "\n";
2668 2669
			ERROR("CSYNC",
			      "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
2670 2671 2672
		}
		if ($line =~ /__builtin_bfin_ssync/) {
			my $herevet = "$here\n" . cat_vet($line) . "\n";
2673 2674
			ERROR("SSYNC",
			      "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
2675 2676
		}

2677 2678 2679 2680 2681 2682
# 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);
		}

2683
# Check for potential 'bare' types
2684 2685
		my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
		    $realline_next);
2686 2687
#print "LINE<$line>\n";
		if ($linenr >= $suppress_statement &&
2688
		    $realcnt && $sline =~ /.\s*\S/) {
2689
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2690
				ctx_statement_block($linenr, $realcnt, 0);
2691 2692 2693
			$stat =~ s/\n./\n /g;
			$cond =~ s/\n./\n /g;

2694 2695 2696 2697 2698 2699 2700 2701 2702
#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;
			}
2703

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

2712 2713
			my $s = $stat;
			$s =~ s/{.*$//s;
2714

2715
			# Ignore goto labels.
2716
			if ($s =~ /$Ident:\*$/s) {
2717 2718

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

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

2723
			# declarations always start with types
2724
			} 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) {
2725 2726 2727 2728
				my $type = $1;
				$type =~ s/\s+/ /g;
				possible($type, "A:" . $s);

2729
			# definitions in global scope can only start with types
2730
			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
2731
				possible($1, "B:" . $s);
2732
			}
2733 2734

			# any (foo ... *) is a pointer cast, and foo is a type
2735
			while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
2736
				possible($1, "C:" . $s);
2737 2738 2739 2740 2741
			}

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

2745
				my $ctx = $s;
2746
				substr($ctx, 0, $name_len + 1, '');
2747
				$ctx =~ s/\)[^\)]*$//;
2748

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

2752
						possible($1, "D:" . $s);
2753 2754
					}
				}
2755
			}
2756

2757 2758
		}

2759 2760 2761
#
# Checks which may be anchored in the context.
#
2762

2763 2764
# Check for switch () and associated case and default
# statements should be at the same indent.
2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780
		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 '') {
2781 2782
				ERROR("SWITCH_CASE_INDENT_LEVEL",
				      "switch and case should be at the same indent\n$hereline$err");
2783 2784 2785 2786 2787
			}
		}

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

2791
			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2792 2793 2794 2795 2796 2797

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

2798 2799 2800
			my $ctx_cnt = $realcnt - $#ctx - 1;
			my $ctx = join("\n", @ctx);

2801 2802
			my $ctx_ln = $linenr;
			my $ctx_skip = $realcnt;
2803

2804 2805 2806 2807 2808
			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] !~ /^-/);
2809 2810
				$ctx_ln++;
			}
2811

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

2815
			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2816 2817
				ERROR("OPEN_BRACE",
				      "that open brace { should be on the previous line\n" .
2818
					"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2819
			}
2820 2821 2822 2823
			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
			    $ctx =~ /\)\s*\;\s*$/ &&
			    defined $lines[$ctx_ln - 1])
			{
2824 2825
				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
				if ($nindent > $indent) {
2826 2827
					WARN("TRAILING_SEMICOLON",
					     "trailing semicolon indicates no statements, indent implies otherwise\n" .
2828
						"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2829 2830
				}
			}
2831 2832
		}

2833
# Check relative indent for conditionals and blocks.
2834
		if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2835 2836 2837
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
2838 2839 2840 2841 2842 2843 2844 2845 2846 2847
			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.
2848 2849
			my @newlines = ($c =~ /\n/gs);
			my $cond_lines = 1 + $#newlines;
2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862

			# 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;
			}
2863
			if ($s =~ s/^\s*?\n//) {
2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874
				$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;
			}

2875
			my $cond_ptr = -1;
2876
			$continuation = 0;
2877 2878 2879
			while ($cond_ptr != $cond_lines) {
				$cond_ptr = $cond_lines;

2880 2881 2882 2883 2884 2885
				# If we see an #else/#elif then the code
				# is not linear.
				if ($s =~ /^\s*\#\s*(?:else|elif)/) {
					$check = 0;
				}

2886 2887 2888 2889
				# Ignore:
				#  1) blank lines, they should be at 0,
				#  2) preprocessor lines, and
				#  3) labels.
2890 2891
				if ($continuation ||
				    $s =~ /^\s*?\n/ ||
2892 2893
				    $s =~ /^\s*#\s*?/ ||
				    $s =~ /^\s*$Ident\s*:/) {
2894
					$continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2895 2896 2897
					if ($s =~ s/^.*?\n//) {
						$cond_lines++;
					}
2898
				}
2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913
			}

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

2914
			#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";
2915 2916 2917

			if ($check && (($sindent % 8) != 0 ||
			    ($sindent <= $indent && $s ne ''))) {
2918 2919
				WARN("SUSPECT_CODE_INDENT",
				     "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2920 2921 2922
			}
		}

2923 2924
		# Track the 'values' across context and added lines.
		my $opline = $line; $opline =~ s/^./ /;
2925 2926
		my ($curr_values, $curr_vars) =
				annotate_values($opline . "\n", $prev_values);
2927
		$curr_values = $prev_values . $curr_values;
2928 2929
		if ($dbg_values) {
			my $outline = $opline; $outline =~ s/\t/ /g;
2930 2931
			print "$linenr > .$outline\n";
			print "$linenr > $curr_values\n";
2932
			print "$linenr >  $curr_vars\n";
2933
		}
2934 2935
		$prev_values = substr($curr_values, -1);

2936
#ignore lines not being added
2937
		next if ($line =~ /^[^\+]/);
2938

2939
# TEST: allow direct testing of the type matcher.
2940 2941
		if ($dbg_type) {
			if ($line =~ /^.\s*$Declare\s*$/) {
2942 2943
				ERROR("TEST_TYPE",
				      "TEST: is type\n" . $herecurr);
2944
			} elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2945 2946
				ERROR("TEST_NOT_TYPE",
				      "TEST: is not type ($1 is)\n". $herecurr);
2947
			}
2948 2949
			next;
		}
2950 2951
# TEST: allow direct testing of the attribute matcher.
		if ($dbg_attr) {
2952
			if ($line =~ /^.\s*$Modifier\s*$/) {
2953 2954
				ERROR("TEST_ATTR",
				      "TEST: is attr\n" . $herecurr);
2955
			} elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2956 2957
				ERROR("TEST_NOT_ATTR",
				      "TEST: is not attr ($1 is)\n". $herecurr);
2958 2959 2960
			}
			next;
		}
2961

2962
# check for initialisation to aggregates open brace on the next line
2963 2964
		if ($line =~ /^.\s*{/ &&
		    $prevline =~ /(?:^|[^=])=\s*$/) {
2965 2966
			if (ERROR("OPEN_BRACE",
				  "that open brace { should be on the previous line\n" . $hereprev) &&
2967 2968 2969
			    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
				fix_delete_line($fixlinenr - 1, $prevrawline);
				fix_delete_line($fixlinenr, $rawline);
2970 2971
				my $fixedline = $prevrawline;
				$fixedline =~ s/\s*=\s*$/ = {/;
2972
				fix_insert_line($fixlinenr, $fixedline);
2973 2974
				$fixedline = $line;
				$fixedline =~ s/^(.\s*){\s*/$1/;
2975
				fix_insert_line($fixlinenr, $fixedline);
2976
			}
2977 2978
		}

2979 2980 2981 2982 2983
#
# Checks which are anchored on the added line.
#

# check for malformed paths in #include statements (uses RAW line)
2984
		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2985 2986
			my $path = $1;
			if ($path =~ m{//}) {
2987
				ERROR("MALFORMED_INCLUDE",
2988 2989 2990 2991 2992
				      "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);
2993 2994
			}
		}
2995

2996
# no C99 // comments
2997
		if ($line =~ m{//}) {
2998 2999 3000
			if (ERROR("C99_COMMENTS",
				  "do not use C99 // comments\n" . $herecurr) &&
			    $fix) {
3001
				my $line = $fixed[$fixlinenr];
3002 3003
				if ($line =~ /\/\/(.*)$/) {
					my $comment = trim($1);
3004
					$fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3005 3006
				}
			}
3007
		}
3008
		# Remove C99 comments.
3009
		$line =~ s@//.*@@;
3010
		$opline =~ s@//.*@@;
3011

3012 3013 3014 3015 3016 3017 3018 3019
# 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.*\((.*)\)/)) {
3020 3021 3022 3023
			# Handle definitions which produce identifiers with
			# a prefix:
			#   XXX(foo);
			#   EXPORT_SYMBOL(something_foo);
3024
			my $name = $1;
3025
			if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3026 3027 3028 3029 3030
			    $name =~ /^${Ident}_$2/) {
#print "FOO C name<$name>\n";
				$suppress_export{$realline_next} = 1;

			} elsif ($stat !~ /(?:
3031
				\n.}\s*$|
3032 3033 3034
				^.DEFINE_$Ident\(\Q$name\E\)|
				^.DECLARE_$Ident\(\Q$name\E\)|
				^.LIST_HEAD\(\Q$name\E\)|
3035 3036
				^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
				\b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
3037
			    )/x) {
3038 3039 3040 3041
#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
				$suppress_export{$realline_next} = 2;
			} else {
				$suppress_export{$realline_next} = 1;
3042 3043
			}
		}
3044 3045 3046 3047 3048 3049 3050 3051 3052
		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) {
3053 3054
			WARN("EXPORT_SYMBOL",
			     "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3055
		}
3056

3057
# check for global initialisers.
3058 3059 3060 3061 3062
		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) {
3063
				$fixed[$fixlinenr] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
3064
			}
3065
		}
3066
# check for static initialisers.
3067 3068 3069 3070 3071
		if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
			if (ERROR("INITIALISED_STATIC",
				  "do not initialise statics to 0 or NULL\n" .
				      $herecurr) &&
			    $fix) {
3072
				$fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
3073
			}
3074 3075
		}

3076 3077 3078 3079 3080 3081 3082
# 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);
		}

3083 3084
# check for static const char * arrays.
		if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3085 3086
			WARN("STATIC_CONST_CHAR_ARRAY",
			     "static const char * array should probably be static const char * const\n" .
3087 3088 3089 3090 3091
				$herecurr);
               }

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

3097 3098 3099 3100 3101 3102 3103
# 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);
               }

3104 3105 3106 3107 3108
# 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) {
3109
				$fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
3110 3111 3112
			}
		}

3113 3114 3115 3116 3117
# 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) {
3118
				$fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
3119
			}
3120 3121
		}

3122 3123 3124
# check for new typedefs, only function parameters and sparse annotations
# make sense.
		if ($line =~ /\btypedef\s/ &&
3125
		    $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
3126
		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
3127
		    $line !~ /\b$typeTypedefs\b/ &&
3128
		    $line !~ /\b__bitwise(?:__|)\b/) {
3129 3130
			WARN("NEW_TYPEDEFS",
			     "do not add new typedefs\n" . $herecurr);
3131 3132 3133
		}

# * goes on variable not on type
3134
		# (char*[ const])
3135 3136
		while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
			#print "AA<$1>\n";
3137
			my ($ident, $from, $to) = ($1, $2, $2);
3138 3139 3140 3141 3142 3143

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

3147
##			print "1: from<$from> to<$to> ident<$ident>\n";
3148
			if ($from ne $to) {
3149 3150 3151 3152 3153 3154
				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/;
3155
					$fixed[$fixlinenr] =~
3156 3157
					    s@\Q$sub_from\E@$sub_to@;
				}
3158
			}
3159 3160 3161
		}
		while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
			#print "BB<$1>\n";
3162
			my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
3163 3164 3165 3166 3167 3168

			# Should start with a space.
			$to =~ s/^(\S)/ $1/;
			# Should not end with a space.
			$to =~ s/\s+$//;
			# '*'s should not have spaces between.
3169
			while ($to =~ s/\*\s+\*/\*\*/) {
3170 3171 3172
			}
			# Modifiers should have spaces.
			$to =~ s/(\b$Modifier$)/$1 /;
3173

3174
##			print "2: from<$from> to<$to> ident<$ident>\n";
3175
			if ($from ne $to && $ident !~ /^$Modifier$/) {
3176 3177 3178 3179 3180 3181 3182
				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/;
3183
					$fixed[$fixlinenr] =~
3184 3185
					    s@\Q$sub_from\E@$sub_to@;
				}
3186
			}
3187 3188 3189 3190 3191 3192 3193 3194 3195
		}

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

3196
		if ($line =~ /\bLINUX_VERSION_CODE\b/) {
3197 3198
			WARN("LINUX_VERSION_CODE",
			     "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3199 3200
		}

3201 3202
# check for uses of printk_ratelimit
		if ($line =~ /\bprintk_ratelimit\s*\(/) {
3203 3204
			WARN("PRINTK_RATELIMITED",
"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
3205 3206
		}

3207 3208 3209
# 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 已提交
3210
# printk includes all preceding printk's which have no newline on the end.
3211
# we assume the first bad printk is the one to report.
3212
		if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
3213 3214 3215
			my $ok = 0;
			for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
				#print "CHECK<$lines[$ln - 1]\n";
L
Lucas De Marchi 已提交
3216
				# we have a preceding printk if it ends
3217 3218 3219 3220 3221 3222 3223 3224 3225
				# 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) {
3226 3227
				WARN("PRINTK_WITHOUT_KERN_LEVEL",
				     "printk() should include KERN_ facility level\n" . $herecurr);
3228
			}
3229 3230
		}

3231 3232 3233 3234
		if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
			my $orig = $1;
			my $level = lc($orig);
			$level = "warn" if ($level eq "warning");
3235 3236
			my $level2 = $level;
			$level2 = "dbg" if ($level eq "debug");
3237
			WARN("PREFER_PR_LEVEL",
3238
			     "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(...  to printk(KERN_$orig ...\n" . $herecurr);
3239 3240 3241
		}

		if ($line =~ /\bpr_warning\s*\(/) {
3242 3243 3244
			if (WARN("PREFER_PR_LEVEL",
				 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
			    $fix) {
3245
				$fixed[$fixlinenr] =~
3246 3247
				    s/\bpr_warning\b/pr_warn/;
			}
3248 3249
		}

3250 3251 3252 3253 3254 3255 3256 3257 3258
		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);
		}

3259 3260
# function brace can't be on same line, except for #defines of do while,
# or if closed on same line
3261
		if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
3262
		    !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276
			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));
				}
			}
3277
		}
3278

3279 3280 3281
# 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*$/) {
3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294
			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);
				}
			}
3295 3296
		}

3297
# missing space after union, struct or enum definition
3298 3299 3300 3301
		if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
			if (WARN("SPACING",
				 "missing space after $1 definition\n" . $herecurr) &&
			    $fix) {
3302
				$fixed[$fixlinenr] =~
3303 3304
				    s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
			}
3305 3306
		}

3307 3308 3309
# Function pointer declarations
# check spacing between type, funcptr, and args
# canonical declaration is "type (*funcptr)(args...)"
3310
		if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
3311 3312 3313 3314 3315 3316 3317
			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;

3318 3319 3320 3321 3322 3323 3324 3325 3326
# 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 =~ /^$/) {
3327 3328
				WARN("SPACING",
				     "missing space after return type\n" . $herecurr);
3329
				$post_declare_space = " ";
3330 3331 3332
			}

# unnecessary space "type  (*funcptr)(args...)"
3333 3334 3335 3336 3337 3338 3339 3340 3341
# 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);
#			}
3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371

# 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) {
3372
				$fixed[$fixlinenr] =~
3373
				    s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3374 3375 3376
			}
		}

3377 3378
# check for spacing round square brackets; allowed:
#  1. with a type on the left -- int [] a;
3379 3380
#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
#  3. inside a curly brace -- = { [0...10] = 5 }
3381 3382 3383
		while ($line =~ /(.*?\s)\[/g) {
			my ($where, $prefix) = ($-[1], $1);
			if ($prefix !~ /$Type\s+$/ &&
3384
			    ($where != 0 || $prefix !~ /^.\s+$/) &&
3385
			    $prefix !~ /[{,]\s+$/) {
3386 3387 3388
				if (ERROR("BRACKET_SPACE",
					  "space prohibited before open square bracket '['\n" . $herecurr) &&
				    $fix) {
3389
				    $fixed[$fixlinenr] =~
3390 3391
					s/^(\+.*?)\s+\[/$1\[/;
				}
3392 3393 3394
			}
		}

3395
# check for spaces between functions and their parentheses.
3396
		while ($line =~ /($Ident)\s+\(/g) {
3397
			my $name = $1;
3398 3399
			my $ctx_before = substr($line, 0, $-[1]);
			my $ctx = "$ctx_before$name";
3400 3401

			# Ignore those directives where spaces _are_ permitted.
3402 3403 3404 3405 3406 3407
			if ($name =~ /^(?:
				if|for|while|switch|return|case|
				volatile|__volatile__|
				__attribute__|format|__extension__|
				asm|__asm__)$/x)
			{
3408 3409 3410
			# 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.
3411
			} elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
3412 3413

			# cpp #elif statement condition may start with a (
3414
			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
3415 3416 3417

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

			} else {
3421 3422 3423
				if (WARN("SPACING",
					 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
					     $fix) {
3424
					$fixed[$fixlinenr] =~
3425 3426
					    s/\b$name\s+\(/$name\(/;
				}
3427
			}
3428
		}
3429

3430
# Check operator spacing.
3431
		if (!($line=~/\#\s*include/)) {
3432 3433 3434
			my $fixed_line = "";
			my $line_fixed = 0;

3435 3436 3437 3438
			my $ops = qr{
				<<=|>>=|<=|>=|==|!=|
				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
				=>|->|<<|>>|<|>|=|!|~|
3439
				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
3440
				\?:|\?|:
3441
			}x;
3442
			my @elements = split(/($ops|;)/, $opline);
3443 3444 3445 3446 3447 3448 3449

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

			my @fix_elements = ();
3450
			my $off = 0;
3451

3452 3453 3454 3455 3456 3457 3458
			foreach my $el (@elements) {
				push(@fix_elements, substr($rawline, $off, length($el)));
				$off += length($el);
			}

			$off = 0;

3459
			my $blank = copy_spacing($opline);
3460
			my $last_after = -1;
3461

3462
			for (my $n = 0; $n < $#elements; $n += 2) {
3463 3464 3465 3466 3467

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

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

3468 3469
				$off += length($elements[$n]);

L
Lucas De Marchi 已提交
3470
				# Pick up the preceding and succeeding characters.
3471 3472 3473 3474 3475 3476 3477
				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";

3478 3479 3480
				my $a = '';
				$a = 'V' if ($elements[$n] ne '');
				$a = 'W' if ($elements[$n] =~ /\s$/);
3481
				$a = 'C' if ($elements[$n] =~ /$;$/);
3482 3483
				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
				$a = 'O' if ($elements[$n] eq '');
3484
				$a = 'E' if ($ca =~ /^\s*$/);
3485

3486
				my $op = $elements[$n + 1];
3487 3488

				my $c = '';
3489
				if (defined $elements[$n + 2]) {
3490 3491
					$c = 'V' if ($elements[$n + 2] ne '');
					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
3492
					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
3493 3494
					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
					$c = 'O' if ($elements[$n + 2] eq '');
3495
					$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
3496 3497
				} else {
					$c = 'E';
3498 3499
				}

3500 3501 3502 3503
				my $ctx = "${a}x${c}";

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

3504
				my $ptr = substr($blank, 0, $off) . "^";
3505
				my $hereptr = "$hereline$ptr\n";
3506

3507
				# Pull out the value of this operator.
3508
				my $op_type = substr($curr_values, $off + 1, 1);
3509

3510 3511 3512
				# Get the full operator variant.
				my $opv = $op . substr($curr_vars, $off, 1);

3513 3514 3515 3516
				# Ignore operators passed as parameters.
				if ($op_type ne 'V' &&
				    $ca =~ /\s$/ && $cc =~ /^\s*,/) {

3517 3518
#				# Ignore comments
#				} elsif ($op =~ /^$;+$/) {
3519

3520
				# ; should have either the end of line or a space or \ after it
3521
				} elsif ($op eq ';') {
3522 3523
					if ($ctx !~ /.x[WEBC]/ &&
					    $cc !~ /^\\/ && $cc !~ /^;/) {
3524 3525
						if (ERROR("SPACING",
							  "space required after that '$op' $at\n" . $hereptr)) {
3526
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3527 3528
							$line_fixed = 1;
						}
3529 3530 3531 3532
					}

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

3534 3535 3536 3537
				#   :   when part of a bitfield
				} elsif ($opv eq ':B') {
					# skip the bitfield test for now

3538 3539
				# No spaces for:
				#   ->
3540
				} elsif ($op eq '->') {
3541
					if ($ctx =~ /Wx.|.xW/) {
3542 3543
						if (ERROR("SPACING",
							  "spaces prohibited around that '$op' $at\n" . $hereptr)) {
3544
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3545 3546 3547
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3548
							$line_fixed = 1;
3549
						}
3550 3551
					}

3552
				# , must not have a space before and must have a space on the right.
3553
				} elsif ($op eq ',') {
3554 3555 3556 3557 3558 3559 3560 3561 3562
					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;
						}
					}
3563
					if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
3564 3565 3566
						if (ERROR("SPACING",
							  "space required after that '$op' $at\n" . $hereptr)) {
							$line_fixed = 1;
3567
							$last_after = $n;
3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578
							$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 .= " ";
3579
						}
3580 3581
					}

3582
				# '*' as part of a type definition -- reported already.
3583
				} elsif ($opv eq '*_') {
3584 3585 3586 3587 3588 3589
					#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 '~' ||
3590
					 $opv eq '*U' || $opv eq '-U' ||
3591
					 $opv eq '&U' || $opv eq '&&U') {
3592
					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
3593 3594
						if (ERROR("SPACING",
							  "space required before that '$op' $at\n" . $hereptr)) {
3595 3596 3597 3598
							if ($n != $last_after + 2) {
								$good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
								$line_fixed = 1;
							}
3599
						}
3600
					}
3601
					if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
3602 3603 3604
						# A unary '*' may be const

					} elsif ($ctx =~ /.xW/) {
3605 3606
						if (ERROR("SPACING",
							  "space prohibited after that '$op' $at\n" . $hereptr)) {
3607
							$good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
3608 3609 3610
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3611
							$line_fixed = 1;
3612
						}
3613 3614 3615 3616
					}

				# unary ++ and unary -- are allowed no space on one side.
				} elsif ($op eq '++' or $op eq '--') {
3617
					if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
3618 3619
						if (ERROR("SPACING",
							  "space required one side of that '$op' $at\n" . $hereptr)) {
3620
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3621 3622
							$line_fixed = 1;
						}
3623 3624 3625
					}
					if ($ctx =~ /Wx[BE]/ ||
					    ($ctx =~ /Wx./ && $cc =~ /^;/)) {
3626 3627
						if (ERROR("SPACING",
							  "space prohibited before that '$op' $at\n" . $hereptr)) {
3628
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3629 3630
							$line_fixed = 1;
						}
3631
					}
3632
					if ($ctx =~ /ExW/) {
3633 3634
						if (ERROR("SPACING",
							  "space prohibited after that '$op' $at\n" . $hereptr)) {
3635
							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3636 3637 3638
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3639
							$line_fixed = 1;
3640
						}
3641
					}
3642 3643

				# << and >> may either have or not have spaces both sides
3644 3645 3646
				} elsif ($op eq '<<' or $op eq '>>' or
					 $op eq '&' or $op eq '^' or $op eq '|' or
					 $op eq '+' or $op eq '-' or
3647 3648
					 $op eq '*' or $op eq '/' or
					 $op eq '%')
3649
				{
3650
					if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
3651 3652
						if (ERROR("SPACING",
							  "need consistent spacing around '$op' $at\n" . $hereptr)) {
3653 3654 3655 3656
							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3657 3658
							$line_fixed = 1;
						}
3659 3660
					}

3661 3662 3663 3664
				# 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./) {
3665 3666
						if (ERROR("SPACING",
							  "space prohibited before that '$op' $at\n" . $hereptr)) {
3667
							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3668 3669
							$line_fixed = 1;
						}
3670 3671
					}

3672
				# All the others need spaces both sides.
3673
				} elsif ($ctx !~ /[EWC]x[CWE]/) {
3674 3675
					my $ok = 0;

3676
					# Ignore email addresses <foo@bar>
3677 3678 3679 3680 3681 3682 3683 3684
					if (($op eq '<' &&
					     $cc =~ /^\S+\@\S+>/) ||
					    ($op eq '>' &&
					     $ca =~ /<\S+\@\S+$/))
					{
					    	$ok = 1;
					}

3685
					# messages are ERROR, but ?: are CHK
3686
					if ($ok == 0) {
3687 3688 3689 3690 3691
						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)) {
3692 3693 3694 3695
							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
							if (defined $fix_elements[$n + 2]) {
								$fix_elements[$n + 2] =~ s/^\s+//;
							}
3696 3697
							$line_fixed = 1;
						}
3698
					}
3699
				}
3700
				$off += length($elements[$n + 1]);
3701 3702 3703 3704 3705 3706 3707 3708

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

				$fixed_line = $fixed_line . $good;
			}

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

3711 3712
			if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
				$fixed[$fixlinenr] = $fixed_line;
3713 3714 3715
			}


3716 3717
		}

3718
# check for whitespace before a non-naked semicolon
3719
		if ($line =~ /^\+.*\S\s+;\s*$/) {
3720 3721 3722
			if (WARN("SPACING",
				 "space prohibited before semicolon\n" . $herecurr) &&
			    $fix) {
3723
				1 while $fixed[$fixlinenr] =~
3724 3725 3726 3727
				    s/^(\+.*\S)\s+;/$1;/;
			}
		}

3728 3729
# check for multiple assignments
		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
3730 3731
			CHK("MULTIPLE_ASSIGNMENTS",
			    "multiple assignments should be avoided\n" . $herecurr);
3732 3733
		}

3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744
## # 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 =~ /,/) {
3745 3746
## 				WARN("MULTIPLE_DECLARATION",
##				     "declaring multiple variables together should be avoided\n" . $herecurr);
3747 3748
## 			}
## 		}
3749

3750
#need space before brace following if, while, etc
3751 3752
		if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
		    $line =~ /do{/) {
3753 3754 3755
			if (ERROR("SPACING",
				  "space required before the open brace '{'\n" . $herecurr) &&
			    $fix) {
3756
				$fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
3757
			}
3758 3759
		}

3760 3761 3762 3763 3764 3765 3766 3767
## # check for blank lines before declarations
##		if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
##		    $prevrawline =~ /^.\s*$/) {
##			WARN("SPACING",
##			     "No blank lines before declarations\n" . $hereprev);
##		}
##

3768 3769 3770
# closing brace should have a space following it when it has anything
# on the line
		if ($line =~ /}(?!(?:,|;|\)))\S/) {
3771 3772 3773
			if (ERROR("SPACING",
				  "space required after that close brace '}'\n" . $herecurr) &&
			    $fix) {
3774
				$fixed[$fixlinenr] =~
3775 3776
				    s/}((?!(?:,|;|\)))\S)/} $1/;
			}
3777 3778
		}

3779 3780
# check spacing on square brackets
		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
3781 3782 3783
			if (ERROR("SPACING",
				  "space prohibited after that open square bracket '['\n" . $herecurr) &&
			    $fix) {
3784
				$fixed[$fixlinenr] =~
3785 3786
				    s/\[\s+/\[/;
			}
3787 3788
		}
		if ($line =~ /\s\]/) {
3789 3790 3791
			if (ERROR("SPACING",
				  "space prohibited before that close square bracket ']'\n" . $herecurr) &&
			    $fix) {
3792
				$fixed[$fixlinenr] =~
3793 3794
				    s/\s+\]/\]/;
			}
3795 3796
		}

3797
# check spacing on parentheses
3798 3799
		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
		    $line !~ /for\s*\(\s+;/) {
3800 3801 3802
			if (ERROR("SPACING",
				  "space prohibited after that open parenthesis '('\n" . $herecurr) &&
			    $fix) {
3803
				$fixed[$fixlinenr] =~
3804 3805
				    s/\(\s+/\(/;
			}
3806
		}
3807
		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
3808 3809
		    $line !~ /for\s*\(.*;\s+\)/ &&
		    $line !~ /:\s+\)/) {
3810 3811 3812
			if (ERROR("SPACING",
				  "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
			    $fix) {
3813
				$fixed[$fixlinenr] =~
3814 3815
				    s/\s+\)/\)/;
			}
3816 3817
		}

3818 3819 3820 3821
# 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) {
3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842
			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/;
			}
		}
3843

3844
#goto labels aren't indented, allow a single space however
3845
		if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
3846
		   !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
3847 3848 3849
			if (WARN("INDENTED_LABEL",
				 "labels should not be indented\n" . $herecurr) &&
			    $fix) {
3850
				$fixed[$fixlinenr] =~
3851 3852
				    s/^(.)\s+/$1/;
			}
3853 3854
		}

3855
# return is not a function
3856
		if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
3857
			my $spacing = $1;
3858
			if ($^V && $^V ge 5.10.0 &&
3859 3860 3861 3862 3863 3864 3865
			    $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);
				}
3866
			} elsif ($spacing !~ /\s+/) {
3867 3868
				ERROR("SPACING",
				      "space required before the open parenthesis '('\n" . $herecurr);
3869 3870
			}
		}
3871

3872 3873 3874 3875 3876 3877 3878 3879
# 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*:/) {
3880
			WARN("RETURN_VOID",
3881 3882
			     "void function return statements are not generally useful\n" . $hereprev);
               }
3883

3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897
# 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);
			}
		}

3898 3899 3900 3901
# 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') {
3902 3903
				WARN("USE_NEGATIVE_ERRNO",
				     "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
3904 3905
			}
		}
3906

3907
# Need a space before open parenthesis after if, while etc
3908 3909 3910 3911
		if ($line =~ /\b(if|while|for|switch)\(/) {
			if (ERROR("SPACING",
				  "space required before the open parenthesis '('\n" . $herecurr) &&
			    $fix) {
3912
				$fixed[$fixlinenr] =~
3913 3914
				    s/\b(if|while|for|switch)\(/$1 \(/;
			}
3915 3916
		}

3917 3918
# Check for illegal assignment in if conditional -- and check for trailing
# statements after the conditional.
3919
		if ($line =~ /do\s*(?!{)/) {
3920 3921 3922
			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
				ctx_statement_block($linenr, $realcnt, 0)
					if (!defined $stat);
3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940
			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} &&
3941
		    defined($stat) && defined($cond) &&
3942
		    $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
3943
			my ($s, $c) = ($stat, $cond);
3944

3945
			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
3946 3947
				ERROR("ASSIGN_IN_IF",
				      "do not use assignment in if condition\n" . $herecurr);
3948 3949 3950 3951
			}

			# Find out what is on the end of the line after the
			# conditional.
3952
			substr($s, 0, length($c), '');
3953
			$s =~ s/\n.*//g;
3954
			$s =~ s/$;//g; 	# Remove any comments
3955 3956
			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
			    $c !~ /}\s*while\s*/)
3957
			{
3958 3959 3960
				# Find out how long the conditional actually is.
				my @newlines = ($c =~ /\n/gs);
				my $cond_lines = 1 + $#newlines;
3961
				my $stat_real = '';
3962

3963 3964
				$stat_real = raw_line($linenr, $cond_lines)
							. "\n" if ($cond_lines);
3965 3966 3967 3968
				if (defined($stat_real) && $cond_lines > 1) {
					$stat_real = "[...]\n$stat_real";
				}

3969 3970
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr . $stat_real);
3971 3972 3973
			}
		}

3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985
# Check for bitwise tests written as boolean
		if ($line =~ /
			(?:
				(?:\[|\(|\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\|)
			|
				(?:\&\&|\|\|)
				\s*0[xX][0-9]+\s*
				(?:\&\&|\|\||\)|\])
			)/x)
		{
3986 3987
			WARN("HEXADECIMAL_BOOLEAN_TEST",
			     "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
3988 3989
		}

3990
# if and else should not have general statements after it
3991 3992 3993 3994
		if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
			my $s = $1;
			$s =~ s/$;//g; 	# Remove any comments
			if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
3995 3996
				ERROR("TRAILING_STATEMENTS",
				      "trailing statements should be on next line\n" . $herecurr);
3997
			}
3998
		}
3999 4000
# if should not continue a brace
		if ($line =~ /}\s*if\b/) {
4001
			ERROR("TRAILING_STATEMENTS",
4002
			      "trailing statements should be on next line (or did you mean 'else if'?)\n" .
4003 4004
				$herecurr);
		}
4005 4006 4007
# case and default should not have general statements after them
		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
		    $line !~ /\G(?:
4008
			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
4009 4010 4011
			\s*return\s+
		    )/xg)
		{
4012 4013
			ERROR("TRAILING_STATEMENTS",
			      "trailing statements should be on next line\n" . $herecurr);
4014
		}
4015 4016 4017

		# Check for }<nl>else {, these must be at the same
		# indent level to be relevant to each other.
4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033
		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);
			}
4034 4035
		}

4036 4037
		if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
		    $previndent == $indent) {
4038 4039 4040 4041
			my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);

			# Find out what is on the end of the line after the
			# conditional.
4042
			substr($s, 0, length($c), '');
4043 4044 4045
			$s =~ s/\n.*//g;

			if ($s =~ /^\s*;/) {
4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057
				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);
				}
4058 4059 4060
			}
		}

4061
#Specific variable tests
4062 4063
		while ($line =~ m{($Constant|$Lval)}g) {
			my $var = $1;
4064 4065 4066

#gcc binary extension
			if ($var =~ /^$Binary$/) {
4067 4068 4069 4070
				if (WARN("GCC_BINARY_CONSTANT",
					 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
				    $fix) {
					my $hexval = sprintf("0x%x", oct($var));
4071
					$fixed[$fixlinenr] =~
4072 4073
					    s/\b$var\b/$hexval/;
				}
4074 4075 4076
			}

#CamelCase
4077
			if ($var !~ /^$Constant$/ &&
4078
			    $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
4079
#Ignore Page<foo> variants
4080
			    $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
4081
#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4082 4083 4084
			    $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_]+)?$/) {
4085 4086 4087
				while ($var =~ m{($Ident)}g) {
					my $word = $1;
					next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
4088 4089 4090 4091 4092 4093 4094
					if ($check) {
						seed_camelcase_includes();
						if (!$file && !$camelcase_file_seeded) {
							seed_camelcase_file($realfile);
							$camelcase_file_seeded = 1;
						}
					}
4095 4096 4097 4098 4099
					if (!defined $camelcase{$word}) {
						$camelcase{$word} = 1;
						CHK("CAMELCASE",
						    "Avoid CamelCase: <$word>\n" . $herecurr);
					}
4100
				}
4101 4102
			}
		}
4103 4104

#no spaces allowed after \ in define
4105 4106 4107 4108
		if ($line =~ /\#\s*define.*\\\s+$/) {
			if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
				 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
			    $fix) {
4109
				$fixed[$fixlinenr] =~ s/\s+$//;
4110
			}
4111 4112
		}

4113
#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
4114
		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
4115 4116 4117 4118
			my $file = "$1.h";
			my $checkfile = "include/linux/$file";
			if (-f "$root/$checkfile" &&
			    $realfile ne $checkfile &&
4119
			    $1 !~ /$allowed_asm_includes/)
4120
			{
4121
				if ($realfile =~ m{^arch/}) {
4122 4123
					CHK("ARCH_INCLUDE_LINUX",
					    "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4124
				} else {
4125 4126
					WARN("INCLUDE_LINUX",
					     "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4127
				}
4128 4129 4130
			}
		}

4131 4132
# 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
4133
# in a known good container
4134 4135
		if ($realfile !~ m@/vmlinux.lds.h$@ &&
		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
4136 4137
			my $ln = $linenr;
			my $cnt = $realcnt;
4138 4139
			my ($off, $dstat, $dcond, $rest);
			my $ctx = '';
4140 4141
			my $has_flow_statement = 0;
			my $has_arg_concat = 0;
4142
			($dstat, $dcond, $ln, $cnt, $off) =
4143 4144
				ctx_statement_block($linenr, $realcnt, 0);
			$ctx = $dstat;
4145
			#print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4146
			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4147

4148 4149 4150
			$has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
			$has_arg_concat = 1 if ($ctx =~ /\#\#/);

4151
			$dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
4152
			$dstat =~ s/$;//g;
4153 4154 4155
			$dstat =~ s/\\\n.//g;
			$dstat =~ s/^\s*//s;
			$dstat =~ s/\s*$//s;
4156

4157
			# Flatten any parentheses and braces
4158 4159
			while ($dstat =~ s/\([^\(\)]*\)/1/ ||
			       $dstat =~ s/\{[^\{\}]*\}/1/ ||
4160
			       $dstat =~ s/\[[^\[\]]*\]/1/)
4161
			{
4162
			}
4163

4164 4165 4166 4167 4168 4169
			# Flatten any obvious string concatentation.
			while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
			       $dstat =~ s/$Ident\s*("X*")/$1/)
			{
			}

4170 4171 4172
			my $exceptions = qr{
				$Declare|
				module_param_named|
4173
				MODULE_PARM_DESC|
4174 4175
				DECLARE_PER_CPU|
				DEFINE_PER_CPU|
4176
				__typeof__\(|
4177 4178
				union|
				struct|
4179 4180
				\.$Ident\s*=\s*|
				^\"|\"$
4181
			}x;
4182
			#print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4183 4184 4185
			if ($dstat ne '' &&
			    $dstat !~ /^(?:$Ident|-?$Constant),$/ &&			# 10, // foo(),
			    $dstat !~ /^(?:$Ident|-?$Constant);$/ &&			# foo();
4186
			    $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ &&		# 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4187
			    $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ &&			# character constants
4188 4189
			    $dstat !~ /$exceptions/ &&
			    $dstat !~ /^\.$Ident\s*=/ &&				# .foo =
4190
			    $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ &&		# stringification #foo
4191
			    $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ &&	# do {...} while (...); // do {...} while (...)
4192 4193 4194
			    $dstat !~ /^for\s*$Constant$/ &&				# for (...)
			    $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ &&	# for (...) bar()
			    $dstat !~ /^do\s*{/ &&					# do {...
4195 4196
			    $dstat !~ /^\({/ &&						# ({...
			    $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
4197 4198 4199 4200 4201 4202 4203
			{
				$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";
4204 4205
				}

4206 4207 4208 4209
				if ($dstat =~ /;/) {
					ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
					      "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
				} else {
4210
					ERROR("COMPLEX_MACRO",
A
Andrew Morton 已提交
4211
					      "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
4212
				}
4213
			}
4214

4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227
# 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");
			}

4228
# check for line continuations outside of #defines, preprocessor #, and asm
4229 4230 4231

		} else {
			if ($prevline !~ /^..*\\$/ &&
4232 4233
			    $line !~ /^\+\s*\#.*\\$/ &&		# preprocessor
			    $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ &&	# asm
4234 4235 4236 4237
			    $line =~ /^\+.*\\$/) {
				WARN("LINE_CONTINUATIONS",
				     "Avoid unnecessary line continuations\n" . $herecurr);
			}
4238 4239
		}

4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267
# do {} while (0) macro tests:
# single-statement macros do not need to be enclosed in do while (0) loop,
# macro should not end with a semicolon
		if ($^V && $^V ge 5.10.0 &&
		    $realfile !~ m@/vmlinux.lds.h$@ &&
		    $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
			my $ln = $linenr;
			my $cnt = $realcnt;
			my ($off, $dstat, $dcond, $rest);
			my $ctx = '';
			($dstat, $dcond, $ln, $cnt, $off) =
				ctx_statement_block($linenr, $realcnt, 0);
			$ctx = $dstat;

			$dstat =~ s/\\\n.//g;

			if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
				my $stmts = $2;
				my $semis = $3;

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

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

4268 4269
				if (($stmts =~ tr/;/;/) == 1 &&
				    $stmts !~ /^\s*(if|while|for|switch)\b/) {
4270 4271 4272 4273 4274 4275 4276
					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");
				}
4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287
			} 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");
4288 4289 4290
			}
		}

4291 4292 4293 4294 4295 4296
# 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|$))/) {
4297 4298
			WARN("MISSING_VMLINUX_SYMBOL",
			     "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
4299 4300
		}

4301
# check for redundant bracing round if etc
4302 4303
		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
			my ($level, $endln, @chunks) =
4304
				ctx_statement_full($linenr, $realcnt, 1);
4305
			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4306 4307
			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
			if ($#chunks > 0 && $level == 0) {
4308 4309
				my @allowed = ();
				my $allow = 0;
4310
				my $seen = 0;
4311
				my $herectx = $here . "\n";
4312
				my $ln = $linenr - 1;
4313 4314 4315
				for my $chunk (@chunks) {
					my ($cond, $block) = @{$chunk};

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

4320
					$allowed[$allow] = 0;
4321 4322 4323 4324 4325 4326
					#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";
4327 4328
					$ln += statement_rawlines($block) - 1;

4329
					substr($block, 0, length($cond), '');
4330 4331 4332

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

4333
					#print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4334 4335
					if (statement_lines($cond) > 1) {
						#print "APW: ALLOWED: cond<$cond>\n";
4336
						$allowed[$allow] = 1;
4337 4338
					}
					if ($block =~/\b(?:if|for|while)\b/) {
4339
						#print "APW: ALLOWED: block<$block>\n";
4340
						$allowed[$allow] = 1;
4341
					}
4342 4343
					if (statement_block_size($block) > 1) {
						#print "APW: ALLOWED: lines block<$block>\n";
4344
						$allowed[$allow] = 1;
4345
					}
4346
					$allow++;
4347
				}
4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360
				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);
					}
4361 4362 4363
				}
			}
		}
4364
		if (!defined $suppress_ifbraces{$linenr - 1} &&
4365
					$line =~ /\b(if|while|for|else)\b/) {
4366 4367 4368 4369 4370 4371 4372
			my $allowed = 0;

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

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

4377 4378
			# Check the condition.
			my ($cond, $block) = @{$chunks[0]};
4379
			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4380
			if (defined $cond) {
4381
				substr($block, 0, length($cond), '');
4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398
			}
			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) {
4399
					substr($block, 0, length($cond), '');
4400 4401 4402 4403 4404 4405 4406
				}
				if ($block =~ /^\s*\{/) {
					#print "APW: ALLOWED: chunk-1 block<$block>\n";
					$allowed = 1;
				}
			}
			if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
4407
				my $herectx = $here . "\n";
4408
				my $cnt = statement_rawlines($block);
4409

4410
				for (my $n = 0; $n < $cnt; $n++) {
4411
					$herectx .= raw_line($linenr, $n) . "\n";
4412
				}
4413

4414 4415
				WARN("BRACES",
				     "braces {} are not necessary for single statement blocks\n" . $herectx);
4416 4417 4418
			}
		}

4419
# check for unnecessary blank lines around braces
4420
		if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
4421 4422 4423
			CHK("BRACES",
			    "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
		}
4424
		if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
4425 4426 4427 4428
			CHK("BRACES",
			    "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
		}

4429
# no volatiles please
4430 4431
		my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
		if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
4432 4433
			WARN("VOLATILE",
			     "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4434 4435
		}

4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484
# 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/;
			}

		}

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

4491 4492 4493 4494 4495 4496
# uncoalesced string fragments
		if ($line =~ /"X*"\s*"/) {
			WARN("STRING_FRAGMENTS",
			     "Consecutive strings are generally better as a single string\n" . $herecurr);
		}

4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514
# 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);
		}

4515
# warn about #if 0
4516
		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
4517 4518
			CHK("REDUNDANT_CODE",
			    "if this code is redundant consider removing it\n" .
4519
				$herecurr);
4520 4521
		}

4522 4523 4524 4525 4526
# 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',
4527
				     "$1(NULL) is safe and this check is probably not required\n" . $hereprev);
4528 4529
			}
		}
4530

4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547
# 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);
			}
		}

4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558
# check for logging functions with KERN_<LEVEL>
		if ($line !~ /printk\s*\(/ &&
		    $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*//;
			}
		}

4559 4560 4561 4562 4563 4564 4565 4566
# 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);
		}

4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580
# 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/;
				}
			}
		}

4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593
# 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) {
4594
					$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;
4595 4596 4597 4598
				}
			}
		}

4599 4600 4601 4602 4603 4604 4605 4606 4607
# 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) {
4608
				$fixed[$fixlinenr] =~
4609 4610 4611 4612 4613 4614 4615 4616 4617 4618
				    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) {
4619
				my $lead = $fixed[$fixlinenr] =~
4620 4621 4622 4623
				    /(^\+\s*(?:static\s+))/;
				$lead = rtrim($1);
				$lead = "$lead " if ($lead !~ /^\+$/);
				$lead = "${lead}const ";
4624
				$fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
4625 4626 4627
			}
		}

4628 4629 4630 4631 4632 4633 4634 4635 4636
# 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) {
4637
				$fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
4638 4639 4640
			}
		}

4641
# prefer usleep_range over udelay
B
Bruce Allan 已提交
4642
		if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
4643
			my $delay = $1;
4644
			# ignore udelay's < 10, however
4645
			if (! ($delay < 10) ) {
4646
				CHK("USLEEP_RANGE",
4647 4648 4649 4650 4651
				    "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);
4652 4653 4654
			}
		}

4655 4656 4657
# warn about unexpectedly long msleep's
		if ($line =~ /\bmsleep\s*\((\d+)\);/) {
			if ($1 < 20) {
4658
				WARN("MSLEEP",
4659
				     "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4660 4661 4662
			}
		}

4663 4664 4665 4666 4667 4668
# 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);
		}

4669 4670 4671 4672 4673 4674
# 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);
		}

4675
# warn about #ifdefs in C files
4676
#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
4677 4678 4679 4680 4681
#			print "#ifdef in C files should be avoided\n";
#			print "$herecurr";
#			$clean = 0;
#		}

4682
# warn about spacing in #ifdefs
4683
		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
4684 4685 4686
			if (ERROR("SPACING",
				  "exactly one space required after that #$1\n" . $herecurr) &&
			    $fix) {
4687
				$fixed[$fixlinenr] =~
4688 4689 4690
				    s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
			}

4691 4692
		}

4693
# check for spinlock_t definitions without a comment.
4694 4695
		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
4696 4697
			my $which = $1;
			if (!ctx_has_comment($first_line, $linenr)) {
4698 4699
				CHK("UNCOMMENTED_DEFINITION",
				    "$1 definition without comment\n" . $herecurr);
4700 4701 4702 4703 4704
			}
		}
# 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)) {
4705 4706
				WARN("MEMORY_BARRIER",
				     "memory barrier without comment\n" . $herecurr);
4707 4708 4709
			}
		}
# check of hardware specific defines
4710
		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
4711 4712
			CHK("ARCH_DEFINES",
			    "architecture specific defines should be avoided\n" .  $herecurr);
4713
		}
4714

4715 4716
# Check that the storage class is at the beginning of a declaration
		if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
4717 4718
			WARN("STORAGE_CLASS",
			     "storage class should be at the beginning of the declaration\n" . $herecurr)
4719 4720
		}

4721 4722
# check the location of the inline attribute, that it is between
# storage class and type.
4723 4724
		if ($line =~ /\b$Type\s+$Inline\b/ ||
		    $line =~ /\b$Inline\s+$Storage\b/) {
4725 4726
			ERROR("INLINE_LOCATION",
			      "inline keyword should sit between storage class and type\n" . $herecurr);
4727 4728
		}

4729
# Check for __inline__ and __inline, prefer inline
4730 4731
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b(__inline__|__inline)\b/) {
4732 4733 4734
			if (WARN("INLINE",
				 "plain inline is preferred over $1\n" . $herecurr) &&
			    $fix) {
4735
				$fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
4736 4737

			}
4738 4739
		}

4740
# Check for __attribute__ packed, prefer __packed
4741 4742
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
4743 4744
			WARN("PREFER_PACKED",
			     "__packed is preferred over __attribute__((packed))\n" . $herecurr);
4745 4746
		}

4747
# Check for __attribute__ aligned, prefer __aligned
4748 4749
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
4750 4751
			WARN("PREFER_ALIGNED",
			     "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
4752 4753
		}

4754
# Check for __attribute__ format(printf, prefer __printf
4755 4756
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
4757 4758 4759
			if (WARN("PREFER_PRINTF",
				 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
			    $fix) {
4760
				$fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4761 4762

			}
4763 4764
		}

4765
# Check for __attribute__ format(scanf, prefer __scanf
4766 4767
		if ($realfile !~ m@\binclude/uapi/@ &&
		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
4768 4769 4770
			if (WARN("PREFER_SCANF",
				 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
			    $fix) {
4771
				$fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4772
			}
4773 4774
		}

4775 4776 4777 4778 4779 4780 4781 4782 4783
# 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);
		}

4784 4785
# check for sizeof(&)
		if ($line =~ /\bsizeof\s*\(\s*\&/) {
4786 4787
			WARN("SIZEOF_ADDRESS",
			     "sizeof(& should be avoided\n" . $herecurr);
4788 4789
		}

4790 4791
# check for sizeof without parenthesis
		if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
4792 4793 4794
			if (WARN("SIZEOF_PARENTHESIS",
				 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
			    $fix) {
4795
				$fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4796
			}
4797 4798
		}

4799 4800 4801 4802 4803 4804
# 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);
		}

4805
# check for seq_printf uses that could be seq_puts
J
Joe Perches 已提交
4806
		if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
4807
			my $fmt = get_quoted_string($line, $rawline);
J
Joe Perches 已提交
4808
			if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
4809 4810 4811
				if (WARN("PREFER_SEQ_PUTS",
					 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
				    $fix) {
4812
					$fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
4813
				}
4814 4815 4816
			}
		}

4817
# Check for misused memsets
4818 4819
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
4820 4821 4822
		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {

			my $ms_addr = $2;
4823 4824
			my $ms_val = $7;
			my $ms_size = $12;
4825 4826 4827

			if ($ms_size =~ /^(0x|)0$/i) {
				ERROR("MEMSET",
4828
				      "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
4829 4830
			} elsif ($ms_size =~ /^(0x|)1$/i) {
				WARN("MEMSET",
4831 4832 4833 4834
				     "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
			}
		}

4835 4836 4837 4838 4839 4840
# 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) {
4841
				$fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4842 4843 4844
			}
		}

4845
# typecasts on min/max could be min_t/max_t
4846 4847
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
4848
		    $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
4849
			if (defined $2 || defined $7) {
4850 4851 4852
				my $call = $1;
				my $cast1 = deparenthesize($2);
				my $arg1 = $3;
4853 4854
				my $cast2 = deparenthesize($7);
				my $arg2 = $8;
4855 4856
				my $cast;

4857
				if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
4858 4859 4860 4861 4862 4863 4864 4865
					$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");
4866 4867 4868
			}
		}

4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884
# 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");
			}
		}

4885 4886 4887
# check for naked sscanf
		if ($^V && $^V ge 5.10.0 &&
		    defined $stat &&
4888
		    $line =~ /\bsscanf\b/ &&
4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901
		    ($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");
		}

4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922
# 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");
				}
			}
		}

4923 4924 4925
# check for new externs in .h files.
		if ($realfile =~ /\.h$/ &&
		    $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
4926 4927
			if (CHK("AVOID_EXTERNS",
				"extern prototypes should be avoided in .h files\n" . $herecurr) &&
4928
			    $fix) {
4929
				$fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
4930 4931 4932
			}
		}

4933
# check for new externs in .c files.
4934
		if ($realfile =~ /\.c$/ && defined $stat &&
4935
		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
4936
		{
4937 4938
			my $function_name = $1;
			my $paren_space = $2;
4939 4940 4941 4942 4943

			my $s = $stat;
			if (defined $cond) {
				substr($s, 0, length($cond), '');
			}
4944 4945 4946
			if ($s =~ /^\s*;/ &&
			    $function_name ne 'uninitialized_var')
			{
4947 4948
				WARN("AVOID_EXTERNS",
				     "externs should be avoided in .c files\n" .  $herecurr);
4949 4950 4951
			}

			if ($paren_space =~ /\n/) {
4952 4953
				WARN("FUNCTION_ARGUMENTS",
				     "arguments for function declarations should follow identifier\n" . $herecurr);
4954
			}
4955 4956 4957 4958

		} elsif ($realfile =~ /\.c$/ && defined $stat &&
		    $stat =~ /^.\s*extern\s+/)
		{
4959 4960
			WARN("AVOID_EXTERNS",
			     "externs should be avoided in .c files\n" .  $herecurr);
4961 4962 4963 4964 4965 4966 4967
		}

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

			if (!grep(/$name/, @setup_docs)) {
4968 4969
				CHK("UNDOCUMENTED_SETUP",
				    "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
4970
			}
4971
		}
4972 4973

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

4979 4980 4981 4982 4983 4984 4985 4986
# 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);
		}

4987 4988
# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
		if ($^V && $^V ge 5.10.0 &&
4989
		    $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
4990 4991 4992 4993 4994
			my $oldfunc = $3;
			my $a1 = $4;
			my $a2 = $10;
			my $newfunc = "kmalloc_array";
			$newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
4995 4996 4997 4998 4999 5000 5001 5002
			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_]*$/)) {
5003 5004 5005
				if (WARN("ALLOC_WITH_MULTIPLY",
					 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
				    $fix) {
5006
					$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;
5007 5008 5009 5010 5011

				}
			}
		}

5012 5013 5014 5015 5016 5017 5018
# 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);
		}

5019 5020 5021 5022 5023 5024
# 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);
		}

5025 5026
# check for multiple semicolons
		if ($line =~ /;\s*;\s*$/) {
5027 5028 5029
			if (WARN("ONE_SEMICOLON",
				 "Statements terminations use 1 semicolon\n" . $herecurr) &&
			    $fix) {
5030
				$fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
5031
			}
5032 5033
		}

5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044
# 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)/;
			}
		}

5045
# check for case / default statements not preceded by break/fallthrough/switch
5046 5047 5048 5049 5050
		if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
			my $has_break = 0;
			my $has_statement = 0;
			my $count = 0;
			my $prevline = $linenr;
5051
			while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069
				$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);
			}
		}

5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081
# 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);
5082 5083
		}

5084
# check for gcc specific __FUNCTION__
5085 5086 5087 5088
		if ($line =~ /\b__FUNCTION__\b/) {
			if (WARN("USE_FUNC",
				 "__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr) &&
			    $fix) {
5089
				$fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
5090
			}
5091
		}
5092

5093 5094 5095 5096 5097 5098
# 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 已提交
5099 5100 5101 5102 5103 5104
# 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);
		}

5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131
# 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);

			}
		}

5132 5133
# check for semaphores initialized locked
		if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
5134 5135
			WARN("CONSIDER_COMPLETION",
			     "consider using a completion\n" . $herecurr);
5136
		}
5137

5138 5139
# recommend kstrto* over simple_strto* and strict_strto*
		if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
5140
			WARN("CONSIDER_KSTRTO",
5141
			     "$1 is obsolete, use k$3 instead\n" . $herecurr);
5142
		}
5143

5144
# check for __initcall(), use device_initcall() explicitly or more appropriate function please
5145
		if ($line =~ /^.\s*__initcall\s*\(/) {
5146
			WARN("USE_DEVICE_INITCALL",
5147
			     "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
5148
		}
5149

5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187
# check for various ops structs, ensure they are const.
		my $struct_ops = qr{acpi_dock_ops|
				address_space_operations|
				backlight_ops|
				block_device_operations|
				dentry_operations|
				dev_pm_ops|
				dma_map_ops|
				extent_io_ops|
				file_lock_operations|
				file_operations|
				hv_ops|
				ide_dma_ops|
				intel_dvo_dev_ops|
				item_operations|
				iwl_ops|
				kgdb_arch|
				kgdb_io|
				kset_uevent_ops|
				lock_manager_operations|
				microcode_ops|
				mtrr_ops|
				neigh_ops|
				nlmsvc_binding|
				pci_raw_ops|
				pipe_buf_operations|
				platform_hibernation_ops|
				platform_suspend_ops|
				proto_ops|
				rpc_pipe_ops|
				seq_operations|
				snd_ac97_build_ops|
				soc_pcmcia_socket_ops|
				stacktrace_ops|
				sysfs_ops|
				tty_operations|
				usb_mon_operations|
				wd_ops}x;
5188
		if ($line !~ /\bconst\b/ &&
5189
		    $line =~ /\bstruct\s+($struct_ops)\b/) {
5190 5191
			WARN("CONST_STRUCT",
			     "struct $1 should normally be const\n" .
5192
				$herecurr);
5193
		}
5194 5195 5196 5197

# 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/ &&
5198 5199
		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
5200 5201 5202
		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
5203
		{
5204 5205
			WARN("NR_CPUS",
			     "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
5206
		}
5207

5208 5209 5210 5211 5212 5213
# 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);
		}

5214 5215 5216
# whine mightly about in_atomic
		if ($line =~ /\bin_atomic\s*\(/) {
			if ($realfile =~ m@^drivers/@) {
5217 5218
				ERROR("IN_ATOMIC",
				      "do not use in_atomic in drivers\n" . $herecurr);
5219
			} elsif ($realfile !~ m@^kernel/@) {
5220 5221
				WARN("IN_ATOMIC",
				     "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
5222 5223
			}
		}
5224 5225 5226 5227 5228 5229 5230

# 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@) {
5231 5232
				ERROR("LOCKDEP",
				      "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
5233 5234
			}
		}
5235 5236 5237

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

5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264
# 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);
5265 5266 5267
					} elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
						ERROR("EXPORTED_WORLD_WRITABLE",
						      "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5268
					}
5269 5270 5271
				}
			}
		}
5272 5273 5274 5275 5276 5277
	}

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

5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292
	# 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) {
5293 5294
		ERROR("NOT_UNIFIED_DIFF",
		      "Does not appear to be a unified-diff format patch\n");
5295 5296
	}
	if ($is_patch && $chk_signoff && $signoff == 0) {
5297 5298
		ERROR("MISSING_SIGN_OFF",
		      "Missing Signed-off-by: line(s)\n");
5299 5300
	}

5301
	print report_dump();
5302 5303
	if ($summary && !($clean == 1 && $quiet == 1)) {
		print "$filename " if ($summary_file);
5304 5305 5306 5307
		print "total: $cnt_error errors, $cnt_warn warnings, " .
			(($check)? "$cnt_chk checks, " : "") .
			"$cnt_lines lines checked\n";
		print "\n" if ($quiet == 0);
5308
	}
5309

5310
	if ($quiet == 0) {
5311 5312 5313 5314 5315 5316

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

5317 5318 5319 5320 5321
		# 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";
5322
			$rpt_cleaners = 0;
5323 5324 5325
		}
	}

5326 5327
	hash_show_words(\%use_type, "Used");
	hash_show_words(\%ignore_type, "Ignored");
5328

5329 5330 5331
	if ($clean == 0 && $fix &&
	    ("@rawlines" ne "@fixed" ||
	     $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
5332 5333
		my $newfile = $filename;
		$newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
5334 5335 5336
		my $linecount = 0;
		my $f;

5337 5338
		@fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);

5339 5340 5341 5342 5343 5344 5345
		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/^\+//;
5346
					print $f $fixed_line . "\n";
5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367
				}
			} 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
		}
	}

5368
	if ($clean == 1 && $quiet == 0) {
5369
		print "$vname has no obvious style problems and is ready for submission.\n"
5370 5371
	}
	if ($clean == 0 && $quiet == 0) {
5372 5373 5374 5375 5376 5377
		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
5378
	}
5379

5380 5381
	return $clean;
}