xref: /linux-6.15/scripts/checkpatch.pl (revision 8020b253)
1cb77f0d6SKamil Rytarowski#!/usr/bin/env perl
2882ea1d6SJoe Perches# SPDX-License-Identifier: GPL-2.0
3882ea1d6SJoe Perches#
4dbf004d7SDave Jones# (c) 2001, Dave Jones. (the file handling bit)
500df344fSAndy Whitcroft# (c) 2005, Joel Schopp <[email protected]> (the ugly bit)
62a5a2c25SAndy Whitcroft# (c) 2007,2008, Andy Whitcroft <[email protected]> (new conditions, test suite)
7015830beSAndy Whitcroft# (c) 2008-2010 Andy Whitcroft <[email protected]>
8882ea1d6SJoe Perches# (c) 2010-2018 Joe Perches <[email protected]>
90a920b5bSAndy Whitcroft
100a920b5bSAndy Whitcroftuse strict;
11cb77f0d6SKamil Rytarowskiuse warnings;
12c707a81dSJoe Perchesuse POSIX;
1336061e38SJoe Perchesuse File::Basename;
1436061e38SJoe Perchesuse Cwd 'abs_path';
1557230297SJoe Perchesuse Term::ANSIColor qw(:constants);
16cd261496SGeert Uytterhoevenuse Encode qw(decode encode);
170a920b5bSAndy Whitcroft
180a920b5bSAndy Whitcroftmy $P = $0;
1936061e38SJoe Perchesmy $D = dirname(abs_path($P));
200a920b5bSAndy Whitcroft
21000d1cc1SJoe Perchesmy $V = '0.32';
220a920b5bSAndy Whitcroft
230a920b5bSAndy Whitcroftuse Getopt::Long qw(:config no_auto_abbrev);
240a920b5bSAndy Whitcroft
250a920b5bSAndy Whitcroftmy $quiet = 0;
260a920b5bSAndy Whitcroftmy $tree = 1;
270a920b5bSAndy Whitcroftmy $chk_signoff = 1;
280a920b5bSAndy Whitcroftmy $chk_patch = 1;
29773647a0SAndy Whitcroftmy $tst_only;
306c72ffaaSAndy Whitcroftmy $emacs = 0;
318905a67cSAndy Whitcroftmy $terse = 0;
3234d8815fSJoe Perchesmy $showfile = 0;
336c72ffaaSAndy Whitcroftmy $file = 0;
344a593c34SDu, Changbinmy $git = 0;
350dea9f1eSJoe Perchesmy %git_commits = ();
366c72ffaaSAndy Whitcroftmy $check = 0;
372ac73b4fSJoe Perchesmy $check_orig = 0;
388905a67cSAndy Whitcroftmy $summary = 1;
398905a67cSAndy Whitcroftmy $mailback = 0;
4013214adfSAndy Whitcroftmy $summary_file = 0;
41000d1cc1SJoe Perchesmy $show_types = 0;
423beb42ecSJoe Perchesmy $list_types = 0;
433705ce5bSJoe Perchesmy $fix = 0;
449624b8d6SJoe Perchesmy $fix_inplace = 0;
456c72ffaaSAndy Whitcroftmy $root;
46c2fdda0dSAndy Whitcroftmy %debug;
473445686aSJoe Perchesmy %camelcase = ();
4891bfe484SJoe Perchesmy %use_type = ();
4991bfe484SJoe Perchesmy @use = ();
5091bfe484SJoe Perchesmy %ignore_type = ();
51000d1cc1SJoe Perchesmy @ignore = ();
5277f5b10aSHannes Edermy $help = 0;
53000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf";
54bdc48fa1SJoe Perchesmy $max_line_length = 100;
55d62a201fSDave Hansenmy $ignore_perl_version = 0;
56d62a201fSDave Hansenmy $minimum_perl_version = 5.10.0;
5756193274SVadim Bendeburymy $min_conf_desc_length = 4;
5866b47b4aSKees Cookmy $spelling_file = "$D/spelling.txt";
59ebfd7d62SJoe Perchesmy $codespell = 0;
60f1a63678SMaxim Uvarovmy $codespellfile = "/usr/share/codespell/dictionary.txt";
61bf1fa1daSJoe Perchesmy $conststructsfile = "$D/const_structs.checkpatch";
62ced69da1SQuentin Monnetmy $typedefsfile;
63737c0767SJohn Brooksmy $color = "auto";
6498005e8cSVadim Bendeburymy $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE
65dbbf869dSJoe Perches# git output parsing needs US English output, so first set backtick child process LANGUAGE
66dbbf869dSJoe Perchesmy $git_command ='export LANGUAGE=en_US.UTF-8; git';
67713a09deSAntonio Borneomy $tabsize = 8;
683e89ad85SJerome Forissiermy ${CONFIG_} = "CONFIG_";
6977f5b10aSHannes Eder
7077f5b10aSHannes Edersub help {
7177f5b10aSHannes Eder	my ($exitcode) = @_;
7277f5b10aSHannes Eder
7377f5b10aSHannes Eder	print << "EOM";
7477f5b10aSHannes EderUsage: $P [OPTION]... [FILE]...
7577f5b10aSHannes EderVersion: $V
7677f5b10aSHannes Eder
7777f5b10aSHannes EderOptions:
7877f5b10aSHannes Eder  -q, --quiet                quiet
7977f5b10aSHannes Eder  --no-tree                  run without a kernel tree
8077f5b10aSHannes Eder  --no-signoff               do not check for 'Signed-off-by' line
8177f5b10aSHannes Eder  --patch                    treat FILE as patchfile (default)
8277f5b10aSHannes Eder  --emacs                    emacs compile window format
8377f5b10aSHannes Eder  --terse                    one line per report
8434d8815fSJoe Perches  --showfile                 emit diffed file position, not input file position
854a593c34SDu, Changbin  -g, --git                  treat FILE as a single commit or git revision range
864a593c34SDu, Changbin                             single git commit with:
874a593c34SDu, Changbin                               <rev>
884a593c34SDu, Changbin                               <rev>^
894a593c34SDu, Changbin                               <rev>~n
904a593c34SDu, Changbin                             multiple git commits with:
914a593c34SDu, Changbin                               <rev1>..<rev2>
924a593c34SDu, Changbin                               <rev1>...<rev2>
934a593c34SDu, Changbin                               <rev>-<count>
944a593c34SDu, Changbin                             git merges are ignored
9577f5b10aSHannes Eder  -f, --file                 treat FILE as regular source file
9677f5b10aSHannes Eder  --subjective, --strict     enable more subjective tests
973beb42ecSJoe Perches  --list-types               list the possible message types
9891bfe484SJoe Perches  --types TYPE(,TYPE2...)    show only these comma separated message types
99000d1cc1SJoe Perches  --ignore TYPE(,TYPE2...)   ignore various comma separated message types
1003beb42ecSJoe Perches  --show-types               show the specific message type in the output
101bdc48fa1SJoe Perches  --max-line-length=n        set the maximum line length, (default $max_line_length)
102bdc48fa1SJoe Perches                             if exceeded, warn on patches
103bdc48fa1SJoe Perches                             requires --strict for use with --file
10456193274SVadim Bendebury  --min-conf-desc-length=n   set the min description length, if shorter, warn
105bdc48fa1SJoe Perches  --tab-size=n               set the number of spaces for tab (default $tabsize)
10677f5b10aSHannes Eder  --root=PATH                PATH to the kernel tree root
10777f5b10aSHannes Eder  --no-summary               suppress the per-file summary
10877f5b10aSHannes Eder  --mailback                 only produce a report in case of warnings/errors
10977f5b10aSHannes Eder  --summary-file             include the filename in summary
11077f5b10aSHannes Eder  --debug KEY=[0|1]          turn on/off debugging of KEY, where KEY is one of
11177f5b10aSHannes Eder                             'values', 'possible', 'type', and 'attr' (default
11277f5b10aSHannes Eder                             is all off)
11377f5b10aSHannes Eder  --test-only=WORD           report only warnings/errors containing WORD
11477f5b10aSHannes Eder                             literally
1153705ce5bSJoe Perches  --fix                      EXPERIMENTAL - may create horrible results
1163705ce5bSJoe Perches                             If correctable single-line errors exist, create
1173705ce5bSJoe Perches                             "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
1183705ce5bSJoe Perches                             with potential errors corrected to the preferred
1193705ce5bSJoe Perches                             checkpatch style
1209624b8d6SJoe Perches  --fix-inplace              EXPERIMENTAL - may create horrible results
1219624b8d6SJoe Perches                             Is the same as --fix, but overwrites the input
1229624b8d6SJoe Perches                             file.  It's your fault if there's no backup or git
123d62a201fSDave Hansen  --ignore-perl-version      override checking of perl version.  expect
124d62a201fSDave Hansen                             runtime errors.
125ebfd7d62SJoe Perches  --codespell                Use the codespell dictionary for spelling/typos
126f1a63678SMaxim Uvarov                             (default:/usr/share/codespell/dictionary.txt)
127ebfd7d62SJoe Perches  --codespellfile            Use this codespell dictionary
12875ad8c57SJerome Forissier  --typedefsfile             Read additional types from this file
129737c0767SJohn Brooks  --color[=WHEN]             Use colors 'always', 'never', or only when output
130737c0767SJohn Brooks                             is a terminal ('auto'). Default is 'auto'.
1313e89ad85SJerome Forissier  --kconfig-prefix=WORD      use WORD as a prefix for Kconfig symbols (default
1323e89ad85SJerome Forissier                             ${CONFIG_})
13377f5b10aSHannes Eder  -h, --help, --version      display this help and exit
13477f5b10aSHannes Eder
13577f5b10aSHannes EderWhen FILE is - read standard input.
13677f5b10aSHannes EderEOM
13777f5b10aSHannes Eder
13877f5b10aSHannes Eder	exit($exitcode);
13977f5b10aSHannes Eder}
14077f5b10aSHannes Eder
1413beb42ecSJoe Perchessub uniq {
1423beb42ecSJoe Perches	my %seen;
1433beb42ecSJoe Perches	return grep { !$seen{$_}++ } @_;
1443beb42ecSJoe Perches}
1453beb42ecSJoe Perches
1463beb42ecSJoe Perchessub list_types {
1473beb42ecSJoe Perches	my ($exitcode) = @_;
1483beb42ecSJoe Perches
1493beb42ecSJoe Perches	my $count = 0;
1503beb42ecSJoe Perches
1513beb42ecSJoe Perches	local $/ = undef;
1523beb42ecSJoe Perches
1533beb42ecSJoe Perches	open(my $script, '<', abs_path($P)) or
1543beb42ecSJoe Perches	    die "$P: Can't read '$P' $!\n";
1553beb42ecSJoe Perches
1563beb42ecSJoe Perches	my $text = <$script>;
1573beb42ecSJoe Perches	close($script);
1583beb42ecSJoe Perches
1593beb42ecSJoe Perches	my @types = ();
1600547fa58SJean Delvare	# Also catch when type or level is passed through a variable
1610547fa58SJean Delvare	for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
1623beb42ecSJoe Perches		push (@types, $_);
1633beb42ecSJoe Perches	}
1643beb42ecSJoe Perches	@types = sort(uniq(@types));
1653beb42ecSJoe Perches	print("#\tMessage type\n\n");
1663beb42ecSJoe Perches	foreach my $type (@types) {
1673beb42ecSJoe Perches		print(++$count . "\t" . $type . "\n");
1683beb42ecSJoe Perches	}
1693beb42ecSJoe Perches
1703beb42ecSJoe Perches	exit($exitcode);
1713beb42ecSJoe Perches}
1723beb42ecSJoe Perches
173000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file);
174000d1cc1SJoe Perchesif (-f $conf) {
175000d1cc1SJoe Perches	my @conf_args;
176000d1cc1SJoe Perches	open(my $conffile, '<', "$conf")
177000d1cc1SJoe Perches	    or warn "$P: Can't find a readable $configuration_file file $!\n";
178000d1cc1SJoe Perches
179000d1cc1SJoe Perches	while (<$conffile>) {
180000d1cc1SJoe Perches		my $line = $_;
181000d1cc1SJoe Perches
182000d1cc1SJoe Perches		$line =~ s/\s*\n?$//g;
183000d1cc1SJoe Perches		$line =~ s/^\s*//g;
184000d1cc1SJoe Perches		$line =~ s/\s+/ /g;
185000d1cc1SJoe Perches
186000d1cc1SJoe Perches		next if ($line =~ m/^\s*#/);
187000d1cc1SJoe Perches		next if ($line =~ m/^\s*$/);
188000d1cc1SJoe Perches
189000d1cc1SJoe Perches		my @words = split(" ", $line);
190000d1cc1SJoe Perches		foreach my $word (@words) {
191000d1cc1SJoe Perches			last if ($word =~ m/^#/);
192000d1cc1SJoe Perches			push (@conf_args, $word);
193000d1cc1SJoe Perches		}
194000d1cc1SJoe Perches	}
195000d1cc1SJoe Perches	close($conffile);
196000d1cc1SJoe Perches	unshift(@ARGV, @conf_args) if @conf_args;
197000d1cc1SJoe Perches}
198000d1cc1SJoe Perches
199737c0767SJohn Brooks# Perl's Getopt::Long allows options to take optional arguments after a space.
200737c0767SJohn Brooks# Prevent --color by itself from consuming other arguments
201737c0767SJohn Brooksforeach (@ARGV) {
202737c0767SJohn Brooks	if ($_ eq "--color" || $_ eq "-color") {
203737c0767SJohn Brooks		$_ = "--color=$color";
204737c0767SJohn Brooks	}
205737c0767SJohn Brooks}
206737c0767SJohn Brooks
2070a920b5bSAndy WhitcroftGetOptions(
2086c72ffaaSAndy Whitcroft	'q|quiet+'	=> \$quiet,
2090a920b5bSAndy Whitcroft	'tree!'		=> \$tree,
2100a920b5bSAndy Whitcroft	'signoff!'	=> \$chk_signoff,
2110a920b5bSAndy Whitcroft	'patch!'	=> \$chk_patch,
2126c72ffaaSAndy Whitcroft	'emacs!'	=> \$emacs,
2138905a67cSAndy Whitcroft	'terse!'	=> \$terse,
21434d8815fSJoe Perches	'showfile!'	=> \$showfile,
21577f5b10aSHannes Eder	'f|file!'	=> \$file,
2164a593c34SDu, Changbin	'g|git!'	=> \$git,
2176c72ffaaSAndy Whitcroft	'subjective!'	=> \$check,
2186c72ffaaSAndy Whitcroft	'strict!'	=> \$check,
219000d1cc1SJoe Perches	'ignore=s'	=> \@ignore,
22091bfe484SJoe Perches	'types=s'	=> \@use,
221000d1cc1SJoe Perches	'show-types!'	=> \$show_types,
2223beb42ecSJoe Perches	'list-types!'	=> \$list_types,
2236cd7f386SJoe Perches	'max-line-length=i' => \$max_line_length,
22456193274SVadim Bendebury	'min-conf-desc-length=i' => \$min_conf_desc_length,
225713a09deSAntonio Borneo	'tab-size=i'	=> \$tabsize,
2266c72ffaaSAndy Whitcroft	'root=s'	=> \$root,
2278905a67cSAndy Whitcroft	'summary!'	=> \$summary,
2288905a67cSAndy Whitcroft	'mailback!'	=> \$mailback,
22913214adfSAndy Whitcroft	'summary-file!'	=> \$summary_file,
2303705ce5bSJoe Perches	'fix!'		=> \$fix,
2319624b8d6SJoe Perches	'fix-inplace!'	=> \$fix_inplace,
232d62a201fSDave Hansen	'ignore-perl-version!' => \$ignore_perl_version,
233c2fdda0dSAndy Whitcroft	'debug=s'	=> \%debug,
234773647a0SAndy Whitcroft	'test-only=s'	=> \$tst_only,
235ebfd7d62SJoe Perches	'codespell!'	=> \$codespell,
236ebfd7d62SJoe Perches	'codespellfile=s'	=> \$codespellfile,
23775ad8c57SJerome Forissier	'typedefsfile=s'	=> \$typedefsfile,
238737c0767SJohn Brooks	'color=s'	=> \$color,
239737c0767SJohn Brooks	'no-color'	=> \$color,	#keep old behaviors of -nocolor
240737c0767SJohn Brooks	'nocolor'	=> \$color,	#keep old behaviors of -nocolor
2413e89ad85SJerome Forissier	'kconfig-prefix=s'	=> \${CONFIG_},
24277f5b10aSHannes Eder	'h|help'	=> \$help,
24377f5b10aSHannes Eder	'version'	=> \$help
24477f5b10aSHannes Eder) or help(1);
24577f5b10aSHannes Eder
24677f5b10aSHannes Ederhelp(0) if ($help);
2470a920b5bSAndy Whitcroft
2483beb42ecSJoe Percheslist_types(0) if ($list_types);
2493beb42ecSJoe Perches
2509624b8d6SJoe Perches$fix = 1 if ($fix_inplace);
2512ac73b4fSJoe Perches$check_orig = $check;
2529624b8d6SJoe Perches
25332f30ca9SJoe Perchesdie "$P: --git cannot be used with --file or --fix\n" if ($git && ($file || $fix));
25432f30ca9SJoe Perches
2550a920b5bSAndy Whitcroftmy $exit = 0;
2560a920b5bSAndy Whitcroft
2575b57980dSJoe Perchesmy $perl_version_ok = 1;
258d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) {
2595b57980dSJoe Perches	$perl_version_ok = 0;
260d62a201fSDave Hansen	printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
2615b57980dSJoe Perches	exit(1) if (!$ignore_perl_version);
262d62a201fSDave Hansen}
263d62a201fSDave Hansen
26445107ff6SAllen Hubbe#if no filenames are given, push '-' to read patch from stdin
2650a920b5bSAndy Whitcroftif ($#ARGV < 0) {
26645107ff6SAllen Hubbe	push(@ARGV, '-');
2670a920b5bSAndy Whitcroft}
2680a920b5bSAndy Whitcroft
269737c0767SJohn Brooksif ($color =~ /^[01]$/) {
270737c0767SJohn Brooks	$color = !$color;
271737c0767SJohn Brooks} elsif ($color =~ /^always$/i) {
272737c0767SJohn Brooks	$color = 1;
273737c0767SJohn Brooks} elsif ($color =~ /^never$/i) {
274737c0767SJohn Brooks	$color = 0;
275737c0767SJohn Brooks} elsif ($color =~ /^auto$/i) {
276737c0767SJohn Brooks	$color = (-t STDOUT);
277737c0767SJohn Brooks} else {
27832f30ca9SJoe Perches	die "$P: Invalid color mode: $color\n";
279737c0767SJohn Brooks}
280737c0767SJohn Brooks
281713a09deSAntonio Borneo# skip TAB size 1 to avoid additional checks on $tabsize - 1
28232f30ca9SJoe Perchesdie "$P: Invalid TAB size: $tabsize\n" if ($tabsize < 2);
283713a09deSAntonio Borneo
28491bfe484SJoe Perchessub hash_save_array_words {
28591bfe484SJoe Perches	my ($hashRef, $arrayRef) = @_;
28691bfe484SJoe Perches
28791bfe484SJoe Perches	my @array = split(/,/, join(',', @$arrayRef));
28891bfe484SJoe Perches	foreach my $word (@array) {
289000d1cc1SJoe Perches		$word =~ s/\s*\n?$//g;
290000d1cc1SJoe Perches		$word =~ s/^\s*//g;
291000d1cc1SJoe Perches		$word =~ s/\s+/ /g;
292000d1cc1SJoe Perches		$word =~ tr/[a-z]/[A-Z]/;
293000d1cc1SJoe Perches
294000d1cc1SJoe Perches		next if ($word =~ m/^\s*#/);
295000d1cc1SJoe Perches		next if ($word =~ m/^\s*$/);
296000d1cc1SJoe Perches
29791bfe484SJoe Perches		$hashRef->{$word}++;
298000d1cc1SJoe Perches	}
29991bfe484SJoe Perches}
30091bfe484SJoe Perches
30191bfe484SJoe Perchessub hash_show_words {
30291bfe484SJoe Perches	my ($hashRef, $prefix) = @_;
30391bfe484SJoe Perches
3043c816e49SJoe Perches	if (keys %$hashRef) {
305d8469f16SJoe Perches		print "\nNOTE: $prefix message types:";
30658cb3cf6SJoe Perches		foreach my $word (sort keys %$hashRef) {
30791bfe484SJoe Perches			print " $word";
30891bfe484SJoe Perches		}
309d8469f16SJoe Perches		print "\n";
31091bfe484SJoe Perches	}
31191bfe484SJoe Perches}
31291bfe484SJoe Perches
31391bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore);
31491bfe484SJoe Percheshash_save_array_words(\%use_type, \@use);
315000d1cc1SJoe Perches
316c2fdda0dSAndy Whitcroftmy $dbg_values = 0;
317c2fdda0dSAndy Whitcroftmy $dbg_possible = 0;
3187429c690SAndy Whitcroftmy $dbg_type = 0;
319a1ef277eSAndy Whitcroftmy $dbg_attr = 0;
320c2fdda0dSAndy Whitcroftfor my $key (keys %debug) {
32121caa13cSAndy Whitcroft	## no critic
32221caa13cSAndy Whitcroft	eval "\${dbg_$key} = '$debug{$key}';";
32321caa13cSAndy Whitcroft	die "$@" if ($@);
324c2fdda0dSAndy Whitcroft}
325c2fdda0dSAndy Whitcroft
326d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0;
327d2c0a235SAndy Whitcroft
3288905a67cSAndy Whitcroftif ($terse) {
3298905a67cSAndy Whitcroft	$emacs = 1;
3308905a67cSAndy Whitcroft	$quiet++;
3318905a67cSAndy Whitcroft}
3328905a67cSAndy Whitcroft
3336c72ffaaSAndy Whitcroftif ($tree) {
3346c72ffaaSAndy Whitcroft	if (defined $root) {
3356c72ffaaSAndy Whitcroft		if (!top_of_kernel_tree($root)) {
3366c72ffaaSAndy Whitcroft			die "$P: $root: --root does not point at a valid tree\n";
3376c72ffaaSAndy Whitcroft		}
3386c72ffaaSAndy Whitcroft	} else {
3396c72ffaaSAndy Whitcroft		if (top_of_kernel_tree('.')) {
3406c72ffaaSAndy Whitcroft			$root = '.';
3416c72ffaaSAndy Whitcroft		} elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
3426c72ffaaSAndy Whitcroft						top_of_kernel_tree($1)) {
3436c72ffaaSAndy Whitcroft			$root = $1;
3446c72ffaaSAndy Whitcroft		}
3456c72ffaaSAndy Whitcroft	}
3466c72ffaaSAndy Whitcroft
3476c72ffaaSAndy Whitcroft	if (!defined $root) {
3480a920b5bSAndy Whitcroft		print "Must be run from the top-level dir. of a kernel tree\n";
3490a920b5bSAndy Whitcroft		exit(2);
3500a920b5bSAndy Whitcroft	}
3516c72ffaaSAndy Whitcroft}
3526c72ffaaSAndy Whitcroft
3536c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0;
3546c72ffaaSAndy Whitcroft
3552ceb532bSAndy Whitcroftour $Ident	= qr{
3562ceb532bSAndy Whitcroft			[A-Za-z_][A-Za-z\d_]*
3572ceb532bSAndy Whitcroft			(?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
3582ceb532bSAndy Whitcroft		}x;
3596c72ffaaSAndy Whitcroftour $Storage	= qr{extern|static|asmlinkage};
3606c72ffaaSAndy Whitcroftour $Sparse	= qr{
3616c72ffaaSAndy Whitcroft			__user|
3626c72ffaaSAndy Whitcroft			__kernel|
3636c72ffaaSAndy Whitcroft			__force|
3646c72ffaaSAndy Whitcroft			__iomem|
3656c72ffaaSAndy Whitcroft			__must_check|
366417495edSAndy Whitcroft			__kprobes|
367165e72a6SSven Eckelmann			__ref|
36833aa4597SGeert Uytterhoeven			__refconst|
36933aa4597SGeert Uytterhoeven			__refdata|
370ad315455SBoqun Feng			__rcu|
371ad315455SBoqun Feng			__private
3726c72ffaaSAndy Whitcroft		}x;
373e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
374e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
375e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
376e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
377e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
3788716de38SJoe Perches
37952131292SWolfram Sang# Notes to $Attribute:
38052131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
3816c72ffaaSAndy Whitcroftour $Attribute	= qr{
3826c72ffaaSAndy Whitcroft			const|
38303f1df7dSJoe Perches			__percpu|
38403f1df7dSJoe Perches			__nocast|
38503f1df7dSJoe Perches			__safe|
38646d832f5SMichael S. Tsirkin			__bitwise|
38703f1df7dSJoe Perches			__packed__|
38803f1df7dSJoe Perches			__packed2__|
38903f1df7dSJoe Perches			__naked|
39003f1df7dSJoe Perches			__maybe_unused|
39103f1df7dSJoe Perches			__always_unused|
39203f1df7dSJoe Perches			__noreturn|
39303f1df7dSJoe Perches			__used|
39403f1df7dSJoe Perches			__cold|
395e23ef1f3SJoe Perches			__pure|
39603f1df7dSJoe Perches			__noclone|
39703f1df7dSJoe Perches			__deprecated|
3986c72ffaaSAndy Whitcroft			__read_mostly|
399c5967e98SJoe Perches			__ro_after_init|
4006c72ffaaSAndy Whitcroft			__kprobes|
4018716de38SJoe Perches			$InitAttribute|
40224e1d81aSAndy Whitcroft			____cacheline_aligned|
40324e1d81aSAndy Whitcroft			____cacheline_aligned_in_smp|
4045fe3af11SAndy Whitcroft			____cacheline_internodealigned_in_smp|
4055fe3af11SAndy Whitcroft			__weak
4066c72ffaaSAndy Whitcroft		  }x;
407c45dcabdSAndy Whitcroftour $Modifier;
40891cb5195SJoe Perchesour $Inline	= qr{inline|__always_inline|noinline|__inline|__inline__};
4096c72ffaaSAndy Whitcroftour $Member	= qr{->$Ident|\.$Ident|\[[^]]*\]};
4106c72ffaaSAndy Whitcroftour $Lval	= qr{$Ident(?:$Member)*};
4116c72ffaaSAndy Whitcroft
41295e2c602SJoe Perchesour $Int_type	= qr{(?i)llu|ull|ll|lu|ul|l|u};
41395e2c602SJoe Perchesour $Binary	= qr{(?i)0b[01]+$Int_type?};
41495e2c602SJoe Perchesour $Hex	= qr{(?i)0x[0-9a-f]+$Int_type?};
41595e2c602SJoe Perchesour $Int	= qr{[0-9]+$Int_type?};
4162435880fSJoe Perchesour $Octal	= qr{0[0-7]+$Int_type?};
417c0a5c898SJoe Perchesour $String	= qr{"[X\t]*"};
418326b1ffcSJoe Perchesour $Float_hex	= qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
419326b1ffcSJoe Perchesour $Float_dec	= qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
420326b1ffcSJoe Perchesour $Float_int	= qr{(?i)[0-9]+e-?[0-9]+[fl]?};
42174349bccSJoe Perchesour $Float	= qr{$Float_hex|$Float_dec|$Float_int};
4222435880fSJoe Perchesour $Constant	= qr{$Float|$Binary|$Octal|$Hex|$Int};
423326b1ffcSJoe Perchesour $Assignment	= qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
424447432f3SJoe Perchesour $Compare    = qr{<=|>=|==|!=|<|(?<!-)>};
42523f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%};
4266c72ffaaSAndy Whitcroftour $Operators	= qr{
4276c72ffaaSAndy Whitcroft			<=|>=|==|!=|
4286c72ffaaSAndy Whitcroft			=>|->|<<|>>|<|>|!|~|
42923f780c9SJoe Perches			&&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
4306c72ffaaSAndy Whitcroft		  }x;
4316c72ffaaSAndy Whitcroft
43291cb5195SJoe Perchesour $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
43391cb5195SJoe Perches
434ab7e23f3SJoe Perchesour $BasicType;
4358905a67cSAndy Whitcroftour $NonptrType;
4361813087dSJoe Perchesour $NonptrTypeMisordered;
4378716de38SJoe Perchesour $NonptrTypeWithAttr;
4388905a67cSAndy Whitcroftour $Type;
4391813087dSJoe Perchesour $TypeMisordered;
4408905a67cSAndy Whitcroftour $Declare;
4411813087dSJoe Perchesour $DeclareMisordered;
4428905a67cSAndy Whitcroft
44315662b3eSJoe Perchesour $NON_ASCII_UTF8	= qr{
44415662b3eSJoe Perches	[\xC2-\xDF][\x80-\xBF]               # non-overlong 2-byte
445171ae1a4SAndy Whitcroft	|  \xE0[\xA0-\xBF][\x80-\xBF]        # excluding overlongs
446171ae1a4SAndy Whitcroft	| [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}  # straight 3-byte
447171ae1a4SAndy Whitcroft	|  \xED[\x80-\x9F][\x80-\xBF]        # excluding surrogates
448171ae1a4SAndy Whitcroft	|  \xF0[\x90-\xBF][\x80-\xBF]{2}     # planes 1-3
449171ae1a4SAndy Whitcroft	| [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
450171ae1a4SAndy Whitcroft	|  \xF4[\x80-\x8F][\x80-\xBF]{2}     # plane 16
451171ae1a4SAndy Whitcroft}x;
452171ae1a4SAndy Whitcroft
45315662b3eSJoe Perchesour $UTF8	= qr{
45415662b3eSJoe Perches	[\x09\x0A\x0D\x20-\x7E]              # ASCII
45515662b3eSJoe Perches	| $NON_ASCII_UTF8
45615662b3eSJoe Perches}x;
45715662b3eSJoe Perches
458e6176fa4SJoe Perchesour $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
459021158b4SJoe Perchesour $typeOtherOSTypedefs = qr{(?x:
460021158b4SJoe Perches	u_(?:char|short|int|long) |          # bsd
461021158b4SJoe Perches	u(?:nchar|short|int|long)            # sysv
462021158b4SJoe Perches)};
463e6176fa4SJoe Perchesour $typeKernelTypedefs = qr{(?x:
464fb9e9096SAndy Whitcroft	(?:__)?(?:u|s|be|le)(?:8|16|32|64)|
4658ed22cadSAndy Whitcroft	atomic_t
4668ed22cadSAndy Whitcroft)};
467e6176fa4SJoe Perchesour $typeTypedefs = qr{(?x:
468e6176fa4SJoe Perches	$typeC99Typedefs\b|
469e6176fa4SJoe Perches	$typeOtherOSTypedefs\b|
470e6176fa4SJoe Perches	$typeKernelTypedefs\b
471e6176fa4SJoe Perches)};
4728ed22cadSAndy Whitcroft
4736d32f7a3SJoe Perchesour $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
4746d32f7a3SJoe Perches
475691e669bSJoe Perchesour $logFunctions = qr{(?x:
476758d7aadSMiles Chen	printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
4777d0b6594SJacob Keller	(?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
47887bd499aSJoe Perches	TP_printk|
4796e60c02eSJoe Perches	WARN(?:_RATELIMIT|_ONCE|)|
480b0531722SJoe Perches	panic|
48106668727SJoe Perches	MODULE_[A-Z_]+|
48206668727SJoe Perches	seq_vprintf|seq_printf|seq_puts
483691e669bSJoe Perches)};
484691e669bSJoe Perches
485e29a70f1SJoe Perchesour $allocFunctions = qr{(?x:
486e29a70f1SJoe Perches	(?:(?:devm_)?
487e29a70f1SJoe Perches		(?:kv|k|v)[czm]alloc(?:_node|_array)? |
488e29a70f1SJoe Perches		kstrdup(?:_const)? |
489e29a70f1SJoe Perches		kmemdup(?:_nul)?) |
490461e1565SChristophe JAILLET	(?:\w+)?alloc_skb(?:_ip_align)? |
491e29a70f1SJoe Perches				# dev_alloc_skb/netdev_alloc_skb, et al
492e29a70f1SJoe Perches	dma_alloc_coherent
493e29a70f1SJoe Perches)};
494e29a70f1SJoe Perches
49520112475SJoe Perchesour $signature_tags = qr{(?xi:
49620112475SJoe Perches	Signed-off-by:|
497d499480cSJorge Ramirez-Ortiz	Co-developed-by:|
49820112475SJoe Perches	Acked-by:|
49920112475SJoe Perches	Tested-by:|
50020112475SJoe Perches	Reviewed-by:|
50120112475SJoe Perches	Reported-by:|
5028543ae12SMugunthan V N	Suggested-by:|
50320112475SJoe Perches	To:|
50420112475SJoe Perches	Cc:
50520112475SJoe Perches)};
50620112475SJoe Perches
5071813087dSJoe Perchesour @typeListMisordered = (
5081813087dSJoe Perches	qr{char\s+(?:un)?signed},
5091813087dSJoe Perches	qr{int\s+(?:(?:un)?signed\s+)?short\s},
5101813087dSJoe Perches	qr{int\s+short(?:\s+(?:un)?signed)},
5111813087dSJoe Perches	qr{short\s+int(?:\s+(?:un)?signed)},
5121813087dSJoe Perches	qr{(?:un)?signed\s+int\s+short},
5131813087dSJoe Perches	qr{short\s+(?:un)?signed},
5141813087dSJoe Perches	qr{long\s+int\s+(?:un)?signed},
5151813087dSJoe Perches	qr{int\s+long\s+(?:un)?signed},
5161813087dSJoe Perches	qr{long\s+(?:un)?signed\s+int},
5171813087dSJoe Perches	qr{int\s+(?:un)?signed\s+long},
5181813087dSJoe Perches	qr{int\s+(?:un)?signed},
5191813087dSJoe Perches	qr{int\s+long\s+long\s+(?:un)?signed},
5201813087dSJoe Perches	qr{long\s+long\s+int\s+(?:un)?signed},
5211813087dSJoe Perches	qr{long\s+long\s+(?:un)?signed\s+int},
5221813087dSJoe Perches	qr{long\s+long\s+(?:un)?signed},
5231813087dSJoe Perches	qr{long\s+(?:un)?signed},
5241813087dSJoe Perches);
5251813087dSJoe Perches
5268905a67cSAndy Whitcroftour @typeList = (
5278905a67cSAndy Whitcroft	qr{void},
5280c773d9dSJoe Perches	qr{(?:(?:un)?signed\s+)?char},
5290c773d9dSJoe Perches	qr{(?:(?:un)?signed\s+)?short\s+int},
5300c773d9dSJoe Perches	qr{(?:(?:un)?signed\s+)?short},
5310c773d9dSJoe Perches	qr{(?:(?:un)?signed\s+)?int},
5320c773d9dSJoe Perches	qr{(?:(?:un)?signed\s+)?long\s+int},
5330c773d9dSJoe Perches	qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
5340c773d9dSJoe Perches	qr{(?:(?:un)?signed\s+)?long\s+long},
5350c773d9dSJoe Perches	qr{(?:(?:un)?signed\s+)?long},
5360c773d9dSJoe Perches	qr{(?:un)?signed},
5378905a67cSAndy Whitcroft	qr{float},
5388905a67cSAndy Whitcroft	qr{double},
5398905a67cSAndy Whitcroft	qr{bool},
5408905a67cSAndy Whitcroft	qr{struct\s+$Ident},
5418905a67cSAndy Whitcroft	qr{union\s+$Ident},
5428905a67cSAndy Whitcroft	qr{enum\s+$Ident},
5438905a67cSAndy Whitcroft	qr{${Ident}_t},
5448905a67cSAndy Whitcroft	qr{${Ident}_handler},
5458905a67cSAndy Whitcroft	qr{${Ident}_handler_fn},
5461813087dSJoe Perches	@typeListMisordered,
5478905a67cSAndy Whitcroft);
548938224b5SJoe Perches
549938224b5SJoe Perchesour $C90_int_types = qr{(?x:
550938224b5SJoe Perches	long\s+long\s+int\s+(?:un)?signed|
551938224b5SJoe Perches	long\s+long\s+(?:un)?signed\s+int|
552938224b5SJoe Perches	long\s+long\s+(?:un)?signed|
553938224b5SJoe Perches	(?:(?:un)?signed\s+)?long\s+long\s+int|
554938224b5SJoe Perches	(?:(?:un)?signed\s+)?long\s+long|
555938224b5SJoe Perches	int\s+long\s+long\s+(?:un)?signed|
556938224b5SJoe Perches	int\s+(?:(?:un)?signed\s+)?long\s+long|
557938224b5SJoe Perches
558938224b5SJoe Perches	long\s+int\s+(?:un)?signed|
559938224b5SJoe Perches	long\s+(?:un)?signed\s+int|
560938224b5SJoe Perches	long\s+(?:un)?signed|
561938224b5SJoe Perches	(?:(?:un)?signed\s+)?long\s+int|
562938224b5SJoe Perches	(?:(?:un)?signed\s+)?long|
563938224b5SJoe Perches	int\s+long\s+(?:un)?signed|
564938224b5SJoe Perches	int\s+(?:(?:un)?signed\s+)?long|
565938224b5SJoe Perches
566938224b5SJoe Perches	int\s+(?:un)?signed|
567938224b5SJoe Perches	(?:(?:un)?signed\s+)?int
568938224b5SJoe Perches)};
569938224b5SJoe Perches
570485ff23eSAlex Dowadour @typeListFile = ();
5718716de38SJoe Perchesour @typeListWithAttr = (
5728716de38SJoe Perches	@typeList,
5738716de38SJoe Perches	qr{struct\s+$InitAttribute\s+$Ident},
5748716de38SJoe Perches	qr{union\s+$InitAttribute\s+$Ident},
5758716de38SJoe Perches);
5768716de38SJoe Perches
577c45dcabdSAndy Whitcroftour @modifierList = (
578c45dcabdSAndy Whitcroft	qr{fastcall},
579c45dcabdSAndy Whitcroft);
580485ff23eSAlex Dowadour @modifierListFile = ();
5818905a67cSAndy Whitcroft
5822435880fSJoe Perchesour @mode_permission_funcs = (
5832435880fSJoe Perches	["module_param", 3],
5842435880fSJoe Perches	["module_param_(?:array|named|string)", 4],
5852435880fSJoe Perches	["module_param_array_named", 5],
5862435880fSJoe Perches	["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
5872435880fSJoe Perches	["proc_create(?:_data|)", 2],
588459cf0aeSJoe Perches	["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
589459cf0aeSJoe Perches	["IIO_DEV_ATTR_[A-Z_]+", 1],
590459cf0aeSJoe Perches	["SENSOR_(?:DEVICE_|)ATTR_2", 2],
591459cf0aeSJoe Perches	["SENSOR_TEMPLATE(?:_2|)", 3],
592459cf0aeSJoe Perches	["__ATTR", 2],
5932435880fSJoe Perches);
5942435880fSJoe Perches
5951a3dcf2eSJoe Perchesmy $word_pattern = '\b[A-Z]?[a-z]{2,}\b';
5961a3dcf2eSJoe Perches
597515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below
598515a235eSJoe Perchesour $mode_perms_search = "";
599515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) {
600515a235eSJoe Perches	$mode_perms_search .= '|' if ($mode_perms_search ne "");
601515a235eSJoe Perches	$mode_perms_search .= $entry->[0];
602515a235eSJoe Perches}
60300180468SJoe Perches$mode_perms_search = "(?:${mode_perms_search})";
604515a235eSJoe Perches
6059189c7e7SJoe Perchesour %deprecated_apis = (
6069189c7e7SJoe Perches	"synchronize_rcu_bh"			=> "synchronize_rcu",
6079189c7e7SJoe Perches	"synchronize_rcu_bh_expedited"		=> "synchronize_rcu_expedited",
6089189c7e7SJoe Perches	"call_rcu_bh"				=> "call_rcu",
6099189c7e7SJoe Perches	"rcu_barrier_bh"			=> "rcu_barrier",
6109189c7e7SJoe Perches	"synchronize_sched"			=> "synchronize_rcu",
6119189c7e7SJoe Perches	"synchronize_sched_expedited"		=> "synchronize_rcu_expedited",
6129189c7e7SJoe Perches	"call_rcu_sched"			=> "call_rcu",
6139189c7e7SJoe Perches	"rcu_barrier_sched"			=> "rcu_barrier",
6149189c7e7SJoe Perches	"get_state_synchronize_sched"		=> "get_state_synchronize_rcu",
6159189c7e7SJoe Perches	"cond_synchronize_sched"		=> "cond_synchronize_rcu",
6169189c7e7SJoe Perches);
6179189c7e7SJoe Perches
6189189c7e7SJoe Perches#Create a search pattern for all these strings to speed up a loop below
6199189c7e7SJoe Perchesour $deprecated_apis_search = "";
6209189c7e7SJoe Perchesforeach my $entry (keys %deprecated_apis) {
6219189c7e7SJoe Perches	$deprecated_apis_search .= '|' if ($deprecated_apis_search ne "");
6229189c7e7SJoe Perches	$deprecated_apis_search .= $entry;
6239189c7e7SJoe Perches}
6249189c7e7SJoe Perches$deprecated_apis_search = "(?:${deprecated_apis_search})";
6259189c7e7SJoe Perches
626b392c64fSJoe Perchesour $mode_perms_world_writable = qr{
627b392c64fSJoe Perches	S_IWUGO		|
628b392c64fSJoe Perches	S_IWOTH		|
629b392c64fSJoe Perches	S_IRWXUGO	|
630b392c64fSJoe Perches	S_IALLUGO	|
631b392c64fSJoe Perches	0[0-7][0-7][2367]
632b392c64fSJoe Perches}x;
633b392c64fSJoe Perches
634f90774e1SJoe Perchesour %mode_permission_string_types = (
635f90774e1SJoe Perches	"S_IRWXU" => 0700,
636f90774e1SJoe Perches	"S_IRUSR" => 0400,
637f90774e1SJoe Perches	"S_IWUSR" => 0200,
638f90774e1SJoe Perches	"S_IXUSR" => 0100,
639f90774e1SJoe Perches	"S_IRWXG" => 0070,
640f90774e1SJoe Perches	"S_IRGRP" => 0040,
641f90774e1SJoe Perches	"S_IWGRP" => 0020,
642f90774e1SJoe Perches	"S_IXGRP" => 0010,
643f90774e1SJoe Perches	"S_IRWXO" => 0007,
644f90774e1SJoe Perches	"S_IROTH" => 0004,
645f90774e1SJoe Perches	"S_IWOTH" => 0002,
646f90774e1SJoe Perches	"S_IXOTH" => 0001,
647f90774e1SJoe Perches	"S_IRWXUGO" => 0777,
648f90774e1SJoe Perches	"S_IRUGO" => 0444,
649f90774e1SJoe Perches	"S_IWUGO" => 0222,
650f90774e1SJoe Perches	"S_IXUGO" => 0111,
651f90774e1SJoe Perches);
652f90774e1SJoe Perches
653f90774e1SJoe Perches#Create a search pattern for all these strings to speed up a loop below
654f90774e1SJoe Perchesour $mode_perms_string_search = "";
655f90774e1SJoe Perchesforeach my $entry (keys %mode_permission_string_types) {
656f90774e1SJoe Perches	$mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
657f90774e1SJoe Perches	$mode_perms_string_search .= $entry;
658f90774e1SJoe Perches}
65900180468SJoe Perchesour $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
66000180468SJoe Perchesour $multi_mode_perms_string_search = qr{
66100180468SJoe Perches	${single_mode_perms_string_search}
66200180468SJoe Perches	(?:\s*\|\s*${single_mode_perms_string_search})*
66300180468SJoe Perches}x;
66400180468SJoe Perches
66500180468SJoe Perchessub perms_to_octal {
66600180468SJoe Perches	my ($string) = @_;
66700180468SJoe Perches
66800180468SJoe Perches	return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
66900180468SJoe Perches
67000180468SJoe Perches	my $val = "";
67100180468SJoe Perches	my $oval = "";
67200180468SJoe Perches	my $to = 0;
67300180468SJoe Perches	my $curpos = 0;
67400180468SJoe Perches	my $lastpos = 0;
67500180468SJoe Perches	while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
67600180468SJoe Perches		$curpos = pos($string);
67700180468SJoe Perches		my $match = $2;
67800180468SJoe Perches		my $omatch = $1;
67900180468SJoe Perches		last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
68000180468SJoe Perches		$lastpos = $curpos;
68100180468SJoe Perches		$to |= $mode_permission_string_types{$match};
68200180468SJoe Perches		$val .= '\s*\|\s*' if ($val ne "");
68300180468SJoe Perches		$val .= $match;
68400180468SJoe Perches		$oval .= $omatch;
68500180468SJoe Perches	}
68600180468SJoe Perches	$oval =~ s/^\s*\|\s*//;
68700180468SJoe Perches	$oval =~ s/\s*\|\s*$//;
68800180468SJoe Perches	return sprintf("%04o", $to);
68900180468SJoe Perches}
690f90774e1SJoe Perches
6917840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x:
6927840a94cSWolfram Sang	irq|
693cdcee686SSergey Ryazanov	memory|
694cdcee686SSergey Ryazanov	time|
695cdcee686SSergey Ryazanov	reboot
6967840a94cSWolfram Sang)};
6977840a94cSWolfram Sang# memory.h: ARM has a custom one
6987840a94cSWolfram Sang
69966b47b4aSKees Cook# Load common spelling mistakes and build regular expression list.
70066b47b4aSKees Cookmy $misspellings;
70166b47b4aSKees Cookmy %spelling_fix;
70236061e38SJoe Perches
70336061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) {
70466b47b4aSKees Cook	while (<$spelling>) {
70566b47b4aSKees Cook		my $line = $_;
70666b47b4aSKees Cook
70766b47b4aSKees Cook		$line =~ s/\s*\n?$//g;
70866b47b4aSKees Cook		$line =~ s/^\s*//g;
70966b47b4aSKees Cook
71066b47b4aSKees Cook		next if ($line =~ m/^\s*#/);
71166b47b4aSKees Cook		next if ($line =~ m/^\s*$/);
71266b47b4aSKees Cook
71366b47b4aSKees Cook		my ($suspect, $fix) = split(/\|\|/, $line);
71466b47b4aSKees Cook
71566b47b4aSKees Cook		$spelling_fix{$suspect} = $fix;
71666b47b4aSKees Cook	}
71766b47b4aSKees Cook	close($spelling);
71836061e38SJoe Perches} else {
71936061e38SJoe Perches	warn "No typos will be found - file '$spelling_file': $!\n";
72036061e38SJoe Perches}
72166b47b4aSKees Cook
722ebfd7d62SJoe Perchesif ($codespell) {
723ebfd7d62SJoe Perches	if (open(my $spelling, '<', $codespellfile)) {
724ebfd7d62SJoe Perches		while (<$spelling>) {
725ebfd7d62SJoe Perches			my $line = $_;
726ebfd7d62SJoe Perches
727ebfd7d62SJoe Perches			$line =~ s/\s*\n?$//g;
728ebfd7d62SJoe Perches			$line =~ s/^\s*//g;
729ebfd7d62SJoe Perches
730ebfd7d62SJoe Perches			next if ($line =~ m/^\s*#/);
731ebfd7d62SJoe Perches			next if ($line =~ m/^\s*$/);
732ebfd7d62SJoe Perches			next if ($line =~ m/, disabled/i);
733ebfd7d62SJoe Perches
734ebfd7d62SJoe Perches			$line =~ s/,.*$//;
735ebfd7d62SJoe Perches
736ebfd7d62SJoe Perches			my ($suspect, $fix) = split(/->/, $line);
737ebfd7d62SJoe Perches
738ebfd7d62SJoe Perches			$spelling_fix{$suspect} = $fix;
739ebfd7d62SJoe Perches		}
740ebfd7d62SJoe Perches		close($spelling);
741ebfd7d62SJoe Perches	} else {
742ebfd7d62SJoe Perches		warn "No codespell typos will be found - file '$codespellfile': $!\n";
743ebfd7d62SJoe Perches	}
744ebfd7d62SJoe Perches}
745ebfd7d62SJoe Perches
746ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
747ebfd7d62SJoe Perches
74875ad8c57SJerome Forissiersub read_words {
74975ad8c57SJerome Forissier	my ($wordsRef, $file) = @_;
75075ad8c57SJerome Forissier
75175ad8c57SJerome Forissier	if (open(my $words, '<', $file)) {
75275ad8c57SJerome Forissier		while (<$words>) {
753bf1fa1daSJoe Perches			my $line = $_;
754bf1fa1daSJoe Perches
755bf1fa1daSJoe Perches			$line =~ s/\s*\n?$//g;
756bf1fa1daSJoe Perches			$line =~ s/^\s*//g;
757bf1fa1daSJoe Perches
758bf1fa1daSJoe Perches			next if ($line =~ m/^\s*#/);
759bf1fa1daSJoe Perches			next if ($line =~ m/^\s*$/);
760bf1fa1daSJoe Perches			if ($line =~ /\s/) {
76175ad8c57SJerome Forissier				print("$file: '$line' invalid - ignored\n");
762bf1fa1daSJoe Perches				next;
763bf1fa1daSJoe Perches			}
764bf1fa1daSJoe Perches
765ced69da1SQuentin Monnet			$$wordsRef .= '|' if (defined $$wordsRef);
76675ad8c57SJerome Forissier			$$wordsRef .= $line;
767bf1fa1daSJoe Perches		}
76875ad8c57SJerome Forissier		close($file);
76975ad8c57SJerome Forissier		return 1;
770bf1fa1daSJoe Perches	}
771bf1fa1daSJoe Perches
77275ad8c57SJerome Forissier	return 0;
77375ad8c57SJerome Forissier}
77475ad8c57SJerome Forissier
775ced69da1SQuentin Monnetmy $const_structs;
776ced69da1SQuentin Monnetif (show_type("CONST_STRUCT")) {
77775ad8c57SJerome Forissier	read_words(\$const_structs, $conststructsfile)
77875ad8c57SJerome Forissier	    or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
779ced69da1SQuentin Monnet}
78075ad8c57SJerome Forissier
781ced69da1SQuentin Monnetif (defined($typedefsfile)) {
782ced69da1SQuentin Monnet	my $typeOtherTypedefs;
78375ad8c57SJerome Forissier	read_words(\$typeOtherTypedefs, $typedefsfile)
78475ad8c57SJerome Forissier	    or warn "No additional types will be considered - file '$typedefsfile': $!\n";
785ced69da1SQuentin Monnet	$typeTypedefs .= '|' . $typeOtherTypedefs if (defined $typeOtherTypedefs);
78675ad8c57SJerome Forissier}
78775ad8c57SJerome Forissier
7888905a67cSAndy Whitcroftsub build_types {
789485ff23eSAlex Dowad	my $mods = "(?x:  \n" . join("|\n  ", (@modifierList, @modifierListFile)) . "\n)";
790485ff23eSAlex Dowad	my $all = "(?x:  \n" . join("|\n  ", (@typeList, @typeListFile)) . "\n)";
7911813087dSJoe Perches	my $Misordered = "(?x:  \n" . join("|\n  ", @typeListMisordered) . "\n)";
7928716de38SJoe Perches	my $allWithAttr = "(?x:  \n" . join("|\n  ", @typeListWithAttr) . "\n)";
793c8cb2ca3SAndy Whitcroft	$Modifier	= qr{(?:$Attribute|$Sparse|$mods)};
794ab7e23f3SJoe Perches	$BasicType	= qr{
795ab7e23f3SJoe Perches				(?:$typeTypedefs\b)|
796ab7e23f3SJoe Perches				(?:${all}\b)
797ab7e23f3SJoe Perches		}x;
7988905a67cSAndy Whitcroft	$NonptrType	= qr{
799d2172eb5SAndy Whitcroft			(?:$Modifier\s+|const\s+)*
800cf655043SAndy Whitcroft			(?:
8016b48db24SAndy Whitcroft				(?:typeof|__typeof__)\s*\([^\)]*\)|
8028ed22cadSAndy Whitcroft				(?:$typeTypedefs\b)|
803c45dcabdSAndy Whitcroft				(?:${all}\b)
804cf655043SAndy Whitcroft			)
805c8cb2ca3SAndy Whitcroft			(?:\s+$Modifier|\s+const)*
8068905a67cSAndy Whitcroft		  }x;
8071813087dSJoe Perches	$NonptrTypeMisordered	= qr{
8081813087dSJoe Perches			(?:$Modifier\s+|const\s+)*
8091813087dSJoe Perches			(?:
8101813087dSJoe Perches				(?:${Misordered}\b)
8111813087dSJoe Perches			)
8121813087dSJoe Perches			(?:\s+$Modifier|\s+const)*
8131813087dSJoe Perches		  }x;
8148716de38SJoe Perches	$NonptrTypeWithAttr	= qr{
8158716de38SJoe Perches			(?:$Modifier\s+|const\s+)*
8168716de38SJoe Perches			(?:
8178716de38SJoe Perches				(?:typeof|__typeof__)\s*\([^\)]*\)|
8188716de38SJoe Perches				(?:$typeTypedefs\b)|
8198716de38SJoe Perches				(?:${allWithAttr}\b)
8208716de38SJoe Perches			)
8218716de38SJoe Perches			(?:\s+$Modifier|\s+const)*
8228716de38SJoe Perches		  }x;
8238905a67cSAndy Whitcroft	$Type	= qr{
824c45dcabdSAndy Whitcroft			$NonptrType
8257b18496cSAntonio Borneo			(?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
826c8cb2ca3SAndy Whitcroft			(?:\s+$Inline|\s+$Modifier)*
8278905a67cSAndy Whitcroft		  }x;
8281813087dSJoe Perches	$TypeMisordered	= qr{
8291813087dSJoe Perches			$NonptrTypeMisordered
8307b18496cSAntonio Borneo			(?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
8311813087dSJoe Perches			(?:\s+$Inline|\s+$Modifier)*
8321813087dSJoe Perches		  }x;
83391cb5195SJoe Perches	$Declare	= qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
8341813087dSJoe Perches	$DeclareMisordered	= qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
8358905a67cSAndy Whitcroft}
8368905a67cSAndy Whitcroftbuild_types();
8376c72ffaaSAndy Whitcroft
8387d2367afSJoe Perchesour $Typecast	= qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
839d1fe9c09SJoe Perches
840d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg
841d1fe9c09SJoe Perches# requires at least perl version v5.10.0
842d1fe9c09SJoe Perches# Any use must be runtime checked with $^V
843d1fe9c09SJoe Perches
844d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
8452435880fSJoe Perchesour $LvalOrFunc	= qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
846c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
8477d2367afSJoe Perches
848f8422308SJoe Perchesour $declaration_macros = qr{(?x:
8493e838b6cSJoe Perches	(?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
850fe658f94SSteffen Maier	(?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
8513d102fc0SGilad Ben-Yossef	(?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(
852f8422308SJoe Perches)};
853f8422308SJoe Perches
8547d2367afSJoe Perchessub deparenthesize {
8557d2367afSJoe Perches	my ($string) = @_;
8567d2367afSJoe Perches	return "" if (!defined($string));
8575b9553abSJoe Perches
8585b9553abSJoe Perches	while ($string =~ /^\s*\(.*\)\s*$/) {
8595b9553abSJoe Perches		$string =~ s@^\s*\(\s*@@;
8605b9553abSJoe Perches		$string =~ s@\s*\)\s*$@@;
8615b9553abSJoe Perches	}
8625b9553abSJoe Perches
8637d2367afSJoe Perches	$string =~ s@\s+@ @g;
8645b9553abSJoe Perches
8657d2367afSJoe Perches	return $string;
8667d2367afSJoe Perches}
8677d2367afSJoe Perches
8683445686aSJoe Perchessub seed_camelcase_file {
8693445686aSJoe Perches	my ($file) = @_;
8703445686aSJoe Perches
8713445686aSJoe Perches	return if (!(-f $file));
8723445686aSJoe Perches
8733445686aSJoe Perches	local $/;
8743445686aSJoe Perches
8753445686aSJoe Perches	open(my $include_file, '<', "$file")
8763445686aSJoe Perches	    or warn "$P: Can't read '$file' $!\n";
8773445686aSJoe Perches	my $text = <$include_file>;
8783445686aSJoe Perches	close($include_file);
8793445686aSJoe Perches
8803445686aSJoe Perches	my @lines = split('\n', $text);
8813445686aSJoe Perches
8823445686aSJoe Perches	foreach my $line (@lines) {
8833445686aSJoe Perches		next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
8843445686aSJoe Perches		if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
8853445686aSJoe Perches			$camelcase{$1} = 1;
88611ea516aSJoe Perches		} elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
88711ea516aSJoe Perches			$camelcase{$1} = 1;
88811ea516aSJoe Perches		} elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
8893445686aSJoe Perches			$camelcase{$1} = 1;
8903445686aSJoe Perches		}
8913445686aSJoe Perches	}
8923445686aSJoe Perches}
8933445686aSJoe Perches
894cd28b119SJoe Perchesour %maintained_status = ();
895cd28b119SJoe Perches
89685b0ee18SJoe Perchessub is_maintained_obsolete {
89785b0ee18SJoe Perches	my ($filename) = @_;
89885b0ee18SJoe Perches
899f2c19c2fSJerome Forissier	return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
90085b0ee18SJoe Perches
901cd28b119SJoe Perches	if (!exists($maintained_status{$filename})) {
902cd28b119SJoe Perches		$maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
903cd28b119SJoe Perches	}
90485b0ee18SJoe Perches
905cd28b119SJoe Perches	return $maintained_status{$filename} =~ /obsolete/i;
90685b0ee18SJoe Perches}
90785b0ee18SJoe Perches
9083b6e8ac9SJoe Perchessub is_SPDX_License_valid {
9093b6e8ac9SJoe Perches	my ($license) = @_;
9103b6e8ac9SJoe Perches
91156294112SJoe Perches	return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git"));
9123b6e8ac9SJoe Perches
91356294112SJoe Perches	my $root_path = abs_path($root);
91456294112SJoe Perches	my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`;
9153b6e8ac9SJoe Perches	return 0 if ($status ne "");
9163b6e8ac9SJoe Perches	return 1;
9173b6e8ac9SJoe Perches}
9183b6e8ac9SJoe Perches
9193445686aSJoe Perchesmy $camelcase_seeded = 0;
9203445686aSJoe Perchessub seed_camelcase_includes {
9213445686aSJoe Perches	return if ($camelcase_seeded);
9223445686aSJoe Perches
9233445686aSJoe Perches	my $files;
924c707a81dSJoe Perches	my $camelcase_cache = "";
925c707a81dSJoe Perches	my @include_files = ();
926c707a81dSJoe Perches
927c707a81dSJoe Perches	$camelcase_seeded = 1;
928351b2a1fSJoe Perches
9293645e328SRichard Genoud	if (-e ".git") {
930dbbf869dSJoe Perches		my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
931351b2a1fSJoe Perches		chomp $git_last_include_commit;
932c707a81dSJoe Perches		$camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
933c707a81dSJoe Perches	} else {
934c707a81dSJoe Perches		my $last_mod_date = 0;
935c707a81dSJoe Perches		$files = `find $root/include -name "*.h"`;
936c707a81dSJoe Perches		@include_files = split('\n', $files);
937c707a81dSJoe Perches		foreach my $file (@include_files) {
938c707a81dSJoe Perches			my $date = POSIX::strftime("%Y%m%d%H%M",
939c707a81dSJoe Perches						   localtime((stat $file)[9]));
940c707a81dSJoe Perches			$last_mod_date = $date if ($last_mod_date < $date);
941c707a81dSJoe Perches		}
942c707a81dSJoe Perches		$camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
943c707a81dSJoe Perches	}
944c707a81dSJoe Perches
945c707a81dSJoe Perches	if ($camelcase_cache ne "" && -f $camelcase_cache) {
946c707a81dSJoe Perches		open(my $camelcase_file, '<', "$camelcase_cache")
947c707a81dSJoe Perches		    or warn "$P: Can't read '$camelcase_cache' $!\n";
948351b2a1fSJoe Perches		while (<$camelcase_file>) {
949351b2a1fSJoe Perches			chomp;
950351b2a1fSJoe Perches			$camelcase{$_} = 1;
951351b2a1fSJoe Perches		}
952351b2a1fSJoe Perches		close($camelcase_file);
953351b2a1fSJoe Perches
954351b2a1fSJoe Perches		return;
955351b2a1fSJoe Perches	}
956c707a81dSJoe Perches
9573645e328SRichard Genoud	if (-e ".git") {
958dbbf869dSJoe Perches		$files = `${git_command} ls-files "include/*.h"`;
959c707a81dSJoe Perches		@include_files = split('\n', $files);
9603445686aSJoe Perches	}
961c707a81dSJoe Perches
9623445686aSJoe Perches	foreach my $file (@include_files) {
9633445686aSJoe Perches		seed_camelcase_file($file);
9643445686aSJoe Perches	}
965351b2a1fSJoe Perches
966c707a81dSJoe Perches	if ($camelcase_cache ne "") {
967351b2a1fSJoe Perches		unlink glob ".checkpatch-camelcase.*";
968c707a81dSJoe Perches		open(my $camelcase_file, '>', "$camelcase_cache")
969c707a81dSJoe Perches		    or warn "$P: Can't write '$camelcase_cache' $!\n";
970351b2a1fSJoe Perches		foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
971351b2a1fSJoe Perches			print $camelcase_file ("$_\n");
972351b2a1fSJoe Perches		}
973351b2a1fSJoe Perches		close($camelcase_file);
974351b2a1fSJoe Perches	}
9753445686aSJoe Perches}
9763445686aSJoe Perches
977d311cd44SJoe Perchessub git_commit_info {
978d311cd44SJoe Perches	my ($commit, $id, $desc) = @_;
979d311cd44SJoe Perches
980d311cd44SJoe Perches	return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
981d311cd44SJoe Perches
982dbbf869dSJoe Perches	my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`;
983d311cd44SJoe Perches	$output =~ s/^\s*//gm;
984d311cd44SJoe Perches	my @lines = split("\n", $output);
985d311cd44SJoe Perches
9860d7835fcSJoe Perches	return ($id, $desc) if ($#lines < 0);
9870d7835fcSJoe Perches
9885a7f4455SSean Christopherson	if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) {
989d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns
990d311cd44SJoe Perches# all matching commit ids, but it's very slow...
991d311cd44SJoe Perches#
992d311cd44SJoe Perches#		echo "checking commits $1..."
993d311cd44SJoe Perches#		git rev-list --remotes | grep -i "^$1" |
994d311cd44SJoe Perches#		while read line ; do
995d311cd44SJoe Perches#		    git log --format='%H %s' -1 $line |
996d311cd44SJoe Perches#		    echo "commit $(cut -c 1-12,41-)"
997d311cd44SJoe Perches#		done
998d311cd44SJoe Perches	} elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
999948b133aSHeinrich Schuchardt		$id = undef;
1000d311cd44SJoe Perches	} else {
1001d311cd44SJoe Perches		$id = substr($lines[0], 0, 12);
1002d311cd44SJoe Perches		$desc = substr($lines[0], 41);
1003d311cd44SJoe Perches	}
1004d311cd44SJoe Perches
1005d311cd44SJoe Perches	return ($id, $desc);
1006d311cd44SJoe Perches}
1007d311cd44SJoe Perches
10086c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file);
10090a920b5bSAndy Whitcroft
101000df344fSAndy Whitcroftmy @rawlines = ();
1011c2fdda0dSAndy Whitcroftmy @lines = ();
10123705ce5bSJoe Perchesmy @fixed = ();
1013d752fcc8SJoe Perchesmy @fixed_inserted = ();
1014d752fcc8SJoe Perchesmy @fixed_deleted = ();
1015194f66fcSJoe Perchesmy $fixlinenr = -1;
1016194f66fcSJoe Perches
10174a593c34SDu, Changbin# If input is git commits, extract all commits from the commit expressions.
10184a593c34SDu, Changbin# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
10194a593c34SDu, Changbindie "$P: No git repository found\n" if ($git && !-e ".git");
10204a593c34SDu, Changbin
10214a593c34SDu, Changbinif ($git) {
10224a593c34SDu, Changbin	my @commits = ();
10230dea9f1eSJoe Perches	foreach my $commit_expr (@ARGV) {
10244a593c34SDu, Changbin		my $git_range;
102528898fd1SJoe Perches		if ($commit_expr =~ m/^(.*)-(\d+)$/) {
102628898fd1SJoe Perches			$git_range = "-$2 $1";
10274a593c34SDu, Changbin		} elsif ($commit_expr =~ m/\.\./) {
10284a593c34SDu, Changbin			$git_range = "$commit_expr";
10294a593c34SDu, Changbin		} else {
10300dea9f1eSJoe Perches			$git_range = "-1 $commit_expr";
10310dea9f1eSJoe Perches		}
1032dbbf869dSJoe Perches		my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
10330dea9f1eSJoe Perches		foreach my $line (split(/\n/, $lines)) {
103428898fd1SJoe Perches			$line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
103528898fd1SJoe Perches			next if (!defined($1) || !defined($2));
10360dea9f1eSJoe Perches			my $sha1 = $1;
10370dea9f1eSJoe Perches			my $subject = $2;
10380dea9f1eSJoe Perches			unshift(@commits, $sha1);
10390dea9f1eSJoe Perches			$git_commits{$sha1} = $subject;
10404a593c34SDu, Changbin		}
10414a593c34SDu, Changbin	}
10424a593c34SDu, Changbin	die "$P: no git commits after extraction!\n" if (@commits == 0);
10434a593c34SDu, Changbin	@ARGV = @commits;
10444a593c34SDu, Changbin}
10454a593c34SDu, Changbin
1046c2fdda0dSAndy Whitcroftmy $vname;
104798005e8cSVadim Bendebury$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"};
10486c72ffaaSAndy Whitcroftfor my $filename (@ARGV) {
104921caa13cSAndy Whitcroft	my $FILE;
10504a593c34SDu, Changbin	if ($git) {
10514a593c34SDu, Changbin		open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
10524a593c34SDu, Changbin			die "$P: $filename: git format-patch failed - $!\n";
10534a593c34SDu, Changbin	} elsif ($file) {
105421caa13cSAndy Whitcroft		open($FILE, '-|', "diff -u /dev/null $filename") ||
10556c72ffaaSAndy Whitcroft			die "$P: $filename: diff failed - $!\n";
105621caa13cSAndy Whitcroft	} elsif ($filename eq '-') {
105721caa13cSAndy Whitcroft		open($FILE, '<&STDIN');
10586c72ffaaSAndy Whitcroft	} else {
105921caa13cSAndy Whitcroft		open($FILE, '<', "$filename") ||
10606c72ffaaSAndy Whitcroft			die "$P: $filename: open failed - $!\n";
10616c72ffaaSAndy Whitcroft	}
1062c2fdda0dSAndy Whitcroft	if ($filename eq '-') {
1063c2fdda0dSAndy Whitcroft		$vname = 'Your patch';
10644a593c34SDu, Changbin	} elsif ($git) {
10650dea9f1eSJoe Perches		$vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
1066c2fdda0dSAndy Whitcroft	} else {
1067c2fdda0dSAndy Whitcroft		$vname = $filename;
1068c2fdda0dSAndy Whitcroft	}
106921caa13cSAndy Whitcroft	while (<$FILE>) {
10700a920b5bSAndy Whitcroft		chomp;
107100df344fSAndy Whitcroft		push(@rawlines, $_);
1072c7f574d0SGeert Uytterhoeven		$vname = qq("$1") if ($filename eq '-' && $_ =~ m/^Subject:\s+(.+)/i);
10736c72ffaaSAndy Whitcroft	}
107421caa13cSAndy Whitcroft	close($FILE);
1075d8469f16SJoe Perches
1076d8469f16SJoe Perches	if ($#ARGV > 0 && $quiet == 0) {
1077d8469f16SJoe Perches		print '-' x length($vname) . "\n";
1078d8469f16SJoe Perches		print "$vname\n";
1079d8469f16SJoe Perches		print '-' x length($vname) . "\n";
1080d8469f16SJoe Perches	}
1081d8469f16SJoe Perches
1082c2fdda0dSAndy Whitcroft	if (!process($filename)) {
10830a920b5bSAndy Whitcroft		$exit = 1;
10840a920b5bSAndy Whitcroft	}
108500df344fSAndy Whitcroft	@rawlines = ();
108613214adfSAndy Whitcroft	@lines = ();
10873705ce5bSJoe Perches	@fixed = ();
1088d752fcc8SJoe Perches	@fixed_inserted = ();
1089d752fcc8SJoe Perches	@fixed_deleted = ();
1090194f66fcSJoe Perches	$fixlinenr = -1;
1091485ff23eSAlex Dowad	@modifierListFile = ();
1092485ff23eSAlex Dowad	@typeListFile = ();
1093485ff23eSAlex Dowad	build_types();
10940a920b5bSAndy Whitcroft}
10950a920b5bSAndy Whitcroft
1096d8469f16SJoe Perchesif (!$quiet) {
10973c816e49SJoe Perches	hash_show_words(\%use_type, "Used");
10983c816e49SJoe Perches	hash_show_words(\%ignore_type, "Ignored");
10993c816e49SJoe Perches
11005b57980dSJoe Perches	if (!$perl_version_ok) {
1101d8469f16SJoe Perches		print << "EOM"
1102d8469f16SJoe Perches
1103d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues.
11045b57980dSJoe Perches      An upgrade to at least perl $minimum_perl_version is suggested.
1105d8469f16SJoe PerchesEOM
1106d8469f16SJoe Perches	}
1107d8469f16SJoe Perches	if ($exit) {
1108d8469f16SJoe Perches		print << "EOM"
1109d8469f16SJoe Perches
1110d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report
1111d8469f16SJoe Perches      them to the maintainer, see CHECKPATCH in MAINTAINERS.
1112d8469f16SJoe PerchesEOM
1113d8469f16SJoe Perches	}
1114d8469f16SJoe Perches}
1115d8469f16SJoe Perches
11160a920b5bSAndy Whitcroftexit($exit);
11170a920b5bSAndy Whitcroft
11180a920b5bSAndy Whitcroftsub top_of_kernel_tree {
11196c72ffaaSAndy Whitcroft	my ($root) = @_;
11206c72ffaaSAndy Whitcroft
11216c72ffaaSAndy Whitcroft	my @tree_check = (
11226c72ffaaSAndy Whitcroft		"COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
11236c72ffaaSAndy Whitcroft		"README", "Documentation", "arch", "include", "drivers",
11246c72ffaaSAndy Whitcroft		"fs", "init", "ipc", "kernel", "lib", "scripts",
11256c72ffaaSAndy Whitcroft	);
11266c72ffaaSAndy Whitcroft
11276c72ffaaSAndy Whitcroft	foreach my $check (@tree_check) {
11286c72ffaaSAndy Whitcroft		if (! -e $root . '/' . $check) {
11290a920b5bSAndy Whitcroft			return 0;
11300a920b5bSAndy Whitcroft		}
11316c72ffaaSAndy Whitcroft	}
11326c72ffaaSAndy Whitcroft	return 1;
11336c72ffaaSAndy Whitcroft}
11340a920b5bSAndy Whitcroft
113520112475SJoe Perchessub parse_email {
113620112475SJoe Perches	my ($formatted_email) = @_;
113720112475SJoe Perches
113820112475SJoe Perches	my $name = "";
1139dfa05c28SJoe Perches	my $name_comment = "";
114020112475SJoe Perches	my $address = "";
114120112475SJoe Perches	my $comment = "";
114220112475SJoe Perches
114320112475SJoe Perches	if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
114420112475SJoe Perches		$name = $1;
114520112475SJoe Perches		$address = $2;
114620112475SJoe Perches		$comment = $3 if defined $3;
114720112475SJoe Perches	} elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
114820112475SJoe Perches		$address = $1;
114920112475SJoe Perches		$comment = $2 if defined $2;
115020112475SJoe Perches	} elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
115120112475SJoe Perches		$address = $1;
115220112475SJoe Perches		$comment = $2 if defined $2;
115385e12066SJoe Perches		$formatted_email =~ s/\Q$address\E.*$//;
115420112475SJoe Perches		$name = $formatted_email;
11553705ce5bSJoe Perches		$name = trim($name);
115620112475SJoe Perches		$name =~ s/^\"|\"$//g;
115720112475SJoe Perches		# If there's a name left after stripping spaces and
115820112475SJoe Perches		# leading quotes, and the address doesn't have both
115920112475SJoe Perches		# leading and trailing angle brackets, the address
116020112475SJoe Perches		# is invalid. ie:
116120112475SJoe Perches		#   "joe smith [email protected]" bad
116220112475SJoe Perches		#   "joe smith <[email protected]" bad
116320112475SJoe Perches		if ($name ne "" && $address !~ /^<[^>]+>$/) {
116420112475SJoe Perches			$name = "";
116520112475SJoe Perches			$address = "";
116620112475SJoe Perches			$comment = "";
116720112475SJoe Perches		}
116820112475SJoe Perches	}
116920112475SJoe Perches
11703705ce5bSJoe Perches	$name = trim($name);
117120112475SJoe Perches	$name =~ s/^\"|\"$//g;
1172dfa05c28SJoe Perches	$name =~ s/(\s*\([^\)]+\))\s*//;
1173dfa05c28SJoe Perches	if (defined($1)) {
1174dfa05c28SJoe Perches		$name_comment = trim($1);
1175dfa05c28SJoe Perches	}
11763705ce5bSJoe Perches	$address = trim($address);
117720112475SJoe Perches	$address =~ s/^\<|\>$//g;
117820112475SJoe Perches
117920112475SJoe Perches	if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
118020112475SJoe Perches		$name =~ s/(?<!\\)"/\\"/g; ##escape quotes
118120112475SJoe Perches		$name = "\"$name\"";
118220112475SJoe Perches	}
118320112475SJoe Perches
1184dfa05c28SJoe Perches	return ($name, $name_comment, $address, $comment);
118520112475SJoe Perches}
118620112475SJoe Perches
118720112475SJoe Perchessub format_email {
118820112475SJoe Perches	my ($name, $address) = @_;
118920112475SJoe Perches
119020112475SJoe Perches	my $formatted_email;
119120112475SJoe Perches
11923705ce5bSJoe Perches	$name = trim($name);
119320112475SJoe Perches	$name =~ s/^\"|\"$//g;
11943705ce5bSJoe Perches	$address = trim($address);
119520112475SJoe Perches
119620112475SJoe Perches	if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
119720112475SJoe Perches		$name =~ s/(?<!\\)"/\\"/g; ##escape quotes
119820112475SJoe Perches		$name = "\"$name\"";
119920112475SJoe Perches	}
120020112475SJoe Perches
120120112475SJoe Perches	if ("$name" eq "") {
120220112475SJoe Perches		$formatted_email = "$address";
120320112475SJoe Perches	} else {
120420112475SJoe Perches		$formatted_email = "$name <$address>";
120520112475SJoe Perches	}
120620112475SJoe Perches
120720112475SJoe Perches	return $formatted_email;
120820112475SJoe Perches}
120920112475SJoe Perches
1210dfa05c28SJoe Perchessub reformat_email {
1211dfa05c28SJoe Perches	my ($email) = @_;
1212dfa05c28SJoe Perches
1213dfa05c28SJoe Perches	my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
1214dfa05c28SJoe Perches	return format_email($email_name, $email_address);
1215dfa05c28SJoe Perches}
1216dfa05c28SJoe Perches
1217dfa05c28SJoe Perchessub same_email_addresses {
1218dfa05c28SJoe Perches	my ($email1, $email2) = @_;
1219dfa05c28SJoe Perches
1220dfa05c28SJoe Perches	my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1);
1221dfa05c28SJoe Perches	my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2);
1222dfa05c28SJoe Perches
1223dfa05c28SJoe Perches	return $email1_name eq $email2_name &&
1224dfa05c28SJoe Perches	       $email1_address eq $email2_address;
1225dfa05c28SJoe Perches}
1226dfa05c28SJoe Perches
1227d311cd44SJoe Perchessub which {
1228d311cd44SJoe Perches	my ($bin) = @_;
1229d311cd44SJoe Perches
1230d311cd44SJoe Perches	foreach my $path (split(/:/, $ENV{PATH})) {
1231d311cd44SJoe Perches		if (-e "$path/$bin") {
1232d311cd44SJoe Perches			return "$path/$bin";
1233d311cd44SJoe Perches		}
1234d311cd44SJoe Perches	}
1235d311cd44SJoe Perches
1236d311cd44SJoe Perches	return "";
1237d311cd44SJoe Perches}
1238d311cd44SJoe Perches
1239000d1cc1SJoe Perchessub which_conf {
1240000d1cc1SJoe Perches	my ($conf) = @_;
1241000d1cc1SJoe Perches
1242000d1cc1SJoe Perches	foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1243000d1cc1SJoe Perches		if (-e "$path/$conf") {
1244000d1cc1SJoe Perches			return "$path/$conf";
1245000d1cc1SJoe Perches		}
1246000d1cc1SJoe Perches	}
1247000d1cc1SJoe Perches
1248000d1cc1SJoe Perches	return "";
1249000d1cc1SJoe Perches}
1250000d1cc1SJoe Perches
12510a920b5bSAndy Whitcroftsub expand_tabs {
12520a920b5bSAndy Whitcroft	my ($str) = @_;
12530a920b5bSAndy Whitcroft
12540a920b5bSAndy Whitcroft	my $res = '';
12550a920b5bSAndy Whitcroft	my $n = 0;
12560a920b5bSAndy Whitcroft	for my $c (split(//, $str)) {
12570a920b5bSAndy Whitcroft		if ($c eq "\t") {
12580a920b5bSAndy Whitcroft			$res .= ' ';
12590a920b5bSAndy Whitcroft			$n++;
1260713a09deSAntonio Borneo			for (; ($n % $tabsize) != 0; $n++) {
12610a920b5bSAndy Whitcroft				$res .= ' ';
12620a920b5bSAndy Whitcroft			}
12630a920b5bSAndy Whitcroft			next;
12640a920b5bSAndy Whitcroft		}
12650a920b5bSAndy Whitcroft		$res .= $c;
12660a920b5bSAndy Whitcroft		$n++;
12670a920b5bSAndy Whitcroft	}
12680a920b5bSAndy Whitcroft
12690a920b5bSAndy Whitcroft	return $res;
12700a920b5bSAndy Whitcroft}
12716c72ffaaSAndy Whitcroftsub copy_spacing {
1272773647a0SAndy Whitcroft	(my $res = shift) =~ tr/\t/ /c;
12736c72ffaaSAndy Whitcroft	return $res;
12746c72ffaaSAndy Whitcroft}
12750a920b5bSAndy Whitcroft
12764a0df2efSAndy Whitcroftsub line_stats {
12774a0df2efSAndy Whitcroft	my ($line) = @_;
12784a0df2efSAndy Whitcroft
12794a0df2efSAndy Whitcroft	# Drop the diff line leader and expand tabs
12804a0df2efSAndy Whitcroft	$line =~ s/^.//;
12814a0df2efSAndy Whitcroft	$line = expand_tabs($line);
12824a0df2efSAndy Whitcroft
12834a0df2efSAndy Whitcroft	# Pick the indent from the front of the line.
12844a0df2efSAndy Whitcroft	my ($white) = ($line =~ /^(\s*)/);
12854a0df2efSAndy Whitcroft
12864a0df2efSAndy Whitcroft	return (length($line), length($white));
12874a0df2efSAndy Whitcroft}
12884a0df2efSAndy Whitcroft
1289773647a0SAndy Whitcroftmy $sanitise_quote = '';
1290773647a0SAndy Whitcroft
1291773647a0SAndy Whitcroftsub sanitise_line_reset {
1292773647a0SAndy Whitcroft	my ($in_comment) = @_;
1293773647a0SAndy Whitcroft
1294773647a0SAndy Whitcroft	if ($in_comment) {
1295773647a0SAndy Whitcroft		$sanitise_quote = '*/';
1296773647a0SAndy Whitcroft	} else {
1297773647a0SAndy Whitcroft		$sanitise_quote = '';
1298773647a0SAndy Whitcroft	}
1299773647a0SAndy Whitcroft}
130000df344fSAndy Whitcroftsub sanitise_line {
130100df344fSAndy Whitcroft	my ($line) = @_;
130200df344fSAndy Whitcroft
130300df344fSAndy Whitcroft	my $res = '';
130400df344fSAndy Whitcroft	my $l = '';
130500df344fSAndy Whitcroft
1306c2fdda0dSAndy Whitcroft	my $qlen = 0;
1307773647a0SAndy Whitcroft	my $off = 0;
1308773647a0SAndy Whitcroft	my $c;
130900df344fSAndy Whitcroft
1310773647a0SAndy Whitcroft	# Always copy over the diff marker.
1311773647a0SAndy Whitcroft	$res = substr($line, 0, 1);
1312773647a0SAndy Whitcroft
1313773647a0SAndy Whitcroft	for ($off = 1; $off < length($line); $off++) {
1314773647a0SAndy Whitcroft		$c = substr($line, $off, 1);
1315773647a0SAndy Whitcroft
13168d2e11b2SClaudio Fontana		# Comments we are whacking completely including the begin
1317773647a0SAndy Whitcroft		# and end, all to $;.
1318773647a0SAndy Whitcroft		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1319773647a0SAndy Whitcroft			$sanitise_quote = '*/';
1320773647a0SAndy Whitcroft
1321773647a0SAndy Whitcroft			substr($res, $off, 2, "$;$;");
1322773647a0SAndy Whitcroft			$off++;
132300df344fSAndy Whitcroft			next;
1324773647a0SAndy Whitcroft		}
132581bc0e02SAndy Whitcroft		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
1326773647a0SAndy Whitcroft			$sanitise_quote = '';
1327773647a0SAndy Whitcroft			substr($res, $off, 2, "$;$;");
1328773647a0SAndy Whitcroft			$off++;
1329773647a0SAndy Whitcroft			next;
1330773647a0SAndy Whitcroft		}
1331113f04a8SDaniel Walker		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1332113f04a8SDaniel Walker			$sanitise_quote = '//';
1333113f04a8SDaniel Walker
1334113f04a8SDaniel Walker			substr($res, $off, 2, $sanitise_quote);
1335113f04a8SDaniel Walker			$off++;
1336113f04a8SDaniel Walker			next;
1337113f04a8SDaniel Walker		}
1338773647a0SAndy Whitcroft
1339773647a0SAndy Whitcroft		# A \ in a string means ignore the next character.
1340773647a0SAndy Whitcroft		if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1341773647a0SAndy Whitcroft		    $c eq "\\") {
1342773647a0SAndy Whitcroft			substr($res, $off, 2, 'XX');
1343773647a0SAndy Whitcroft			$off++;
1344773647a0SAndy Whitcroft			next;
1345773647a0SAndy Whitcroft		}
1346773647a0SAndy Whitcroft		# Regular quotes.
1347773647a0SAndy Whitcroft		if ($c eq "'" || $c eq '"') {
1348773647a0SAndy Whitcroft			if ($sanitise_quote eq '') {
1349773647a0SAndy Whitcroft				$sanitise_quote = $c;
1350773647a0SAndy Whitcroft
1351773647a0SAndy Whitcroft				substr($res, $off, 1, $c);
1352773647a0SAndy Whitcroft				next;
1353773647a0SAndy Whitcroft			} elsif ($sanitise_quote eq $c) {
1354773647a0SAndy Whitcroft				$sanitise_quote = '';
135500df344fSAndy Whitcroft			}
135600df344fSAndy Whitcroft		}
1357773647a0SAndy Whitcroft
1358fae17daeSAndy Whitcroft		#print "c<$c> SQ<$sanitise_quote>\n";
1359773647a0SAndy Whitcroft		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1360773647a0SAndy Whitcroft			substr($res, $off, 1, $;);
1361113f04a8SDaniel Walker		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1362113f04a8SDaniel Walker			substr($res, $off, 1, $;);
1363773647a0SAndy Whitcroft		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1364773647a0SAndy Whitcroft			substr($res, $off, 1, 'X');
136500df344fSAndy Whitcroft		} else {
1366773647a0SAndy Whitcroft			substr($res, $off, 1, $c);
136700df344fSAndy Whitcroft		}
1368c2fdda0dSAndy Whitcroft	}
1369c2fdda0dSAndy Whitcroft
1370113f04a8SDaniel Walker	if ($sanitise_quote eq '//') {
1371113f04a8SDaniel Walker		$sanitise_quote = '';
1372113f04a8SDaniel Walker	}
1373113f04a8SDaniel Walker
1374c2fdda0dSAndy Whitcroft	# The pathname on a #include may be surrounded by '<' and '>'.
1375c45dcabdSAndy Whitcroft	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
1376c2fdda0dSAndy Whitcroft		my $clean = 'X' x length($1);
1377c2fdda0dSAndy Whitcroft		$res =~ s@\<.*\>@<$clean>@;
1378c2fdda0dSAndy Whitcroft
1379c2fdda0dSAndy Whitcroft	# The whole of a #error is a string.
1380c45dcabdSAndy Whitcroft	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
1381c2fdda0dSAndy Whitcroft		my $clean = 'X' x length($1);
1382c45dcabdSAndy Whitcroft		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
1383c2fdda0dSAndy Whitcroft	}
1384c2fdda0dSAndy Whitcroft
1385dadf680dSJoe Perches	if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1386dadf680dSJoe Perches		my $match = $1;
1387dadf680dSJoe Perches		$res =~ s/\Q$match\E/"$;" x length($match)/e;
1388dadf680dSJoe Perches	}
1389dadf680dSJoe Perches
139000df344fSAndy Whitcroft	return $res;
139100df344fSAndy Whitcroft}
139200df344fSAndy Whitcroft
1393a6962d72SJoe Perchessub get_quoted_string {
1394a6962d72SJoe Perches	my ($line, $rawline) = @_;
1395a6962d72SJoe Perches
1396478b1799SJoe Perches	return "" if (!defined($line) || !defined($rawline));
139733acb54aSJoe Perches	return "" if ($line !~ m/($String)/g);
1398a6962d72SJoe Perches	return substr($rawline, $-[0], $+[0] - $-[0]);
1399a6962d72SJoe Perches}
1400a6962d72SJoe Perches
14018905a67cSAndy Whitcroftsub ctx_statement_block {
14028905a67cSAndy Whitcroft	my ($linenr, $remain, $off) = @_;
14038905a67cSAndy Whitcroft	my $line = $linenr - 1;
14048905a67cSAndy Whitcroft	my $blk = '';
14058905a67cSAndy Whitcroft	my $soff = $off;
14068905a67cSAndy Whitcroft	my $coff = $off - 1;
1407773647a0SAndy Whitcroft	my $coff_set = 0;
14088905a67cSAndy Whitcroft
140913214adfSAndy Whitcroft	my $loff = 0;
141013214adfSAndy Whitcroft
14118905a67cSAndy Whitcroft	my $type = '';
14128905a67cSAndy Whitcroft	my $level = 0;
1413a2750645SAndy Whitcroft	my @stack = ();
1414cf655043SAndy Whitcroft	my $p;
14158905a67cSAndy Whitcroft	my $c;
14168905a67cSAndy Whitcroft	my $len = 0;
141713214adfSAndy Whitcroft
141813214adfSAndy Whitcroft	my $remainder;
14198905a67cSAndy Whitcroft	while (1) {
1420a2750645SAndy Whitcroft		@stack = (['', 0]) if ($#stack == -1);
1421a2750645SAndy Whitcroft
1422773647a0SAndy Whitcroft		#warn "CSB: blk<$blk> remain<$remain>\n";
14238905a67cSAndy Whitcroft		# If we are about to drop off the end, pull in more
14248905a67cSAndy Whitcroft		# context.
14258905a67cSAndy Whitcroft		if ($off >= $len) {
14268905a67cSAndy Whitcroft			for (; $remain > 0; $line++) {
1427dea33496SAndy Whitcroft				last if (!defined $lines[$line]);
1428c2fdda0dSAndy Whitcroft				next if ($lines[$line] =~ /^-/);
14298905a67cSAndy Whitcroft				$remain--;
143013214adfSAndy Whitcroft				$loff = $len;
1431c2fdda0dSAndy Whitcroft				$blk .= $lines[$line] . "\n";
14328905a67cSAndy Whitcroft				$len = length($blk);
14338905a67cSAndy Whitcroft				$line++;
14348905a67cSAndy Whitcroft				last;
14358905a67cSAndy Whitcroft			}
14368905a67cSAndy Whitcroft			# Bail if there is no further context.
14378905a67cSAndy Whitcroft			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
143813214adfSAndy Whitcroft			if ($off >= $len) {
14398905a67cSAndy Whitcroft				last;
14408905a67cSAndy Whitcroft			}
1441f74bd194SAndy Whitcroft			if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1442f74bd194SAndy Whitcroft				$level++;
1443f74bd194SAndy Whitcroft				$type = '#';
1444f74bd194SAndy Whitcroft			}
14458905a67cSAndy Whitcroft		}
1446cf655043SAndy Whitcroft		$p = $c;
14478905a67cSAndy Whitcroft		$c = substr($blk, $off, 1);
144813214adfSAndy Whitcroft		$remainder = substr($blk, $off);
14498905a67cSAndy Whitcroft
1450773647a0SAndy Whitcroft		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
14514635f4fbSAndy Whitcroft
14524635f4fbSAndy Whitcroft		# Handle nested #if/#else.
14534635f4fbSAndy Whitcroft		if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
14544635f4fbSAndy Whitcroft			push(@stack, [ $type, $level ]);
14554635f4fbSAndy Whitcroft		} elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
14564635f4fbSAndy Whitcroft			($type, $level) = @{$stack[$#stack - 1]};
14574635f4fbSAndy Whitcroft		} elsif ($remainder =~ /^#\s*endif\b/) {
14584635f4fbSAndy Whitcroft			($type, $level) = @{pop(@stack)};
14594635f4fbSAndy Whitcroft		}
14604635f4fbSAndy Whitcroft
14618905a67cSAndy Whitcroft		# Statement ends at the ';' or a close '}' at the
14628905a67cSAndy Whitcroft		# outermost level.
14638905a67cSAndy Whitcroft		if ($level == 0 && $c eq ';') {
14648905a67cSAndy Whitcroft			last;
14658905a67cSAndy Whitcroft		}
14668905a67cSAndy Whitcroft
146713214adfSAndy Whitcroft		# An else is really a conditional as long as its not else if
1468773647a0SAndy Whitcroft		if ($level == 0 && $coff_set == 0 &&
1469773647a0SAndy Whitcroft				(!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1470773647a0SAndy Whitcroft				$remainder =~ /^(else)(?:\s|{)/ &&
1471773647a0SAndy Whitcroft				$remainder !~ /^else\s+if\b/) {
1472773647a0SAndy Whitcroft			$coff = $off + length($1) - 1;
1473773647a0SAndy Whitcroft			$coff_set = 1;
1474773647a0SAndy Whitcroft			#warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1475773647a0SAndy Whitcroft			#warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
147613214adfSAndy Whitcroft		}
147713214adfSAndy Whitcroft
14788905a67cSAndy Whitcroft		if (($type eq '' || $type eq '(') && $c eq '(') {
14798905a67cSAndy Whitcroft			$level++;
14808905a67cSAndy Whitcroft			$type = '(';
14818905a67cSAndy Whitcroft		}
14828905a67cSAndy Whitcroft		if ($type eq '(' && $c eq ')') {
14838905a67cSAndy Whitcroft			$level--;
14848905a67cSAndy Whitcroft			$type = ($level != 0)? '(' : '';
14858905a67cSAndy Whitcroft
14868905a67cSAndy Whitcroft			if ($level == 0 && $coff < $soff) {
14878905a67cSAndy Whitcroft				$coff = $off;
1488773647a0SAndy Whitcroft				$coff_set = 1;
1489773647a0SAndy Whitcroft				#warn "CSB: mark coff<$coff>\n";
14908905a67cSAndy Whitcroft			}
14918905a67cSAndy Whitcroft		}
14928905a67cSAndy Whitcroft		if (($type eq '' || $type eq '{') && $c eq '{') {
14938905a67cSAndy Whitcroft			$level++;
14948905a67cSAndy Whitcroft			$type = '{';
14958905a67cSAndy Whitcroft		}
14968905a67cSAndy Whitcroft		if ($type eq '{' && $c eq '}') {
14978905a67cSAndy Whitcroft			$level--;
14988905a67cSAndy Whitcroft			$type = ($level != 0)? '{' : '';
14998905a67cSAndy Whitcroft
15008905a67cSAndy Whitcroft			if ($level == 0) {
1501b998e001SPatrick Pannuto				if (substr($blk, $off + 1, 1) eq ';') {
1502b998e001SPatrick Pannuto					$off++;
1503b998e001SPatrick Pannuto				}
15048905a67cSAndy Whitcroft				last;
15058905a67cSAndy Whitcroft			}
15068905a67cSAndy Whitcroft		}
1507f74bd194SAndy Whitcroft		# Preprocessor commands end at the newline unless escaped.
1508f74bd194SAndy Whitcroft		if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1509f74bd194SAndy Whitcroft			$level--;
1510f74bd194SAndy Whitcroft			$type = '';
1511f74bd194SAndy Whitcroft			$off++;
1512f74bd194SAndy Whitcroft			last;
1513f74bd194SAndy Whitcroft		}
15148905a67cSAndy Whitcroft		$off++;
15158905a67cSAndy Whitcroft	}
1516a3bb97a7SAndy Whitcroft	# We are truly at the end, so shuffle to the next line.
151713214adfSAndy Whitcroft	if ($off == $len) {
1518a3bb97a7SAndy Whitcroft		$loff = $len + 1;
151913214adfSAndy Whitcroft		$line++;
152013214adfSAndy Whitcroft		$remain--;
152113214adfSAndy Whitcroft	}
15228905a67cSAndy Whitcroft
15238905a67cSAndy Whitcroft	my $statement = substr($blk, $soff, $off - $soff + 1);
15248905a67cSAndy Whitcroft	my $condition = substr($blk, $soff, $coff - $soff + 1);
15258905a67cSAndy Whitcroft
15268905a67cSAndy Whitcroft	#warn "STATEMENT<$statement>\n";
15278905a67cSAndy Whitcroft	#warn "CONDITION<$condition>\n";
15288905a67cSAndy Whitcroft
1529773647a0SAndy Whitcroft	#print "coff<$coff> soff<$off> loff<$loff>\n";
153013214adfSAndy Whitcroft
153113214adfSAndy Whitcroft	return ($statement, $condition,
153213214adfSAndy Whitcroft			$line, $remain + 1, $off - $loff + 1, $level);
153313214adfSAndy Whitcroft}
153413214adfSAndy Whitcroft
1535cf655043SAndy Whitcroftsub statement_lines {
1536cf655043SAndy Whitcroft	my ($stmt) = @_;
1537cf655043SAndy Whitcroft
1538cf655043SAndy Whitcroft	# Strip the diff line prefixes and rip blank lines at start and end.
1539cf655043SAndy Whitcroft	$stmt =~ s/(^|\n)./$1/g;
1540cf655043SAndy Whitcroft	$stmt =~ s/^\s*//;
1541cf655043SAndy Whitcroft	$stmt =~ s/\s*$//;
1542cf655043SAndy Whitcroft
1543cf655043SAndy Whitcroft	my @stmt_lines = ($stmt =~ /\n/g);
1544cf655043SAndy Whitcroft
1545cf655043SAndy Whitcroft	return $#stmt_lines + 2;
1546cf655043SAndy Whitcroft}
1547cf655043SAndy Whitcroft
1548cf655043SAndy Whitcroftsub statement_rawlines {
1549cf655043SAndy Whitcroft	my ($stmt) = @_;
1550cf655043SAndy Whitcroft
1551cf655043SAndy Whitcroft	my @stmt_lines = ($stmt =~ /\n/g);
1552cf655043SAndy Whitcroft
1553cf655043SAndy Whitcroft	return $#stmt_lines + 2;
1554cf655043SAndy Whitcroft}
1555cf655043SAndy Whitcroft
1556cf655043SAndy Whitcroftsub statement_block_size {
1557cf655043SAndy Whitcroft	my ($stmt) = @_;
1558cf655043SAndy Whitcroft
1559cf655043SAndy Whitcroft	$stmt =~ s/(^|\n)./$1/g;
1560cf655043SAndy Whitcroft	$stmt =~ s/^\s*{//;
1561cf655043SAndy Whitcroft	$stmt =~ s/}\s*$//;
1562cf655043SAndy Whitcroft	$stmt =~ s/^\s*//;
1563cf655043SAndy Whitcroft	$stmt =~ s/\s*$//;
1564cf655043SAndy Whitcroft
1565cf655043SAndy Whitcroft	my @stmt_lines = ($stmt =~ /\n/g);
1566cf655043SAndy Whitcroft	my @stmt_statements = ($stmt =~ /;/g);
1567cf655043SAndy Whitcroft
1568cf655043SAndy Whitcroft	my $stmt_lines = $#stmt_lines + 2;
1569cf655043SAndy Whitcroft	my $stmt_statements = $#stmt_statements + 1;
1570cf655043SAndy Whitcroft
1571cf655043SAndy Whitcroft	if ($stmt_lines > $stmt_statements) {
1572cf655043SAndy Whitcroft		return $stmt_lines;
1573cf655043SAndy Whitcroft	} else {
1574cf655043SAndy Whitcroft		return $stmt_statements;
1575cf655043SAndy Whitcroft	}
1576cf655043SAndy Whitcroft}
1577cf655043SAndy Whitcroft
157813214adfSAndy Whitcroftsub ctx_statement_full {
157913214adfSAndy Whitcroft	my ($linenr, $remain, $off) = @_;
158013214adfSAndy Whitcroft	my ($statement, $condition, $level);
158113214adfSAndy Whitcroft
158213214adfSAndy Whitcroft	my (@chunks);
158313214adfSAndy Whitcroft
1584cf655043SAndy Whitcroft	# Grab the first conditional/block pair.
158513214adfSAndy Whitcroft	($statement, $condition, $linenr, $remain, $off, $level) =
158613214adfSAndy Whitcroft				ctx_statement_block($linenr, $remain, $off);
1587773647a0SAndy Whitcroft	#print "F: c<$condition> s<$statement> remain<$remain>\n";
158813214adfSAndy Whitcroft	push(@chunks, [ $condition, $statement ]);
1589cf655043SAndy Whitcroft	if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1590cf655043SAndy Whitcroft		return ($level, $linenr, @chunks);
1591cf655043SAndy Whitcroft	}
1592cf655043SAndy Whitcroft
1593cf655043SAndy Whitcroft	# Pull in the following conditional/block pairs and see if they
1594cf655043SAndy Whitcroft	# could continue the statement.
1595cf655043SAndy Whitcroft	for (;;) {
159613214adfSAndy Whitcroft		($statement, $condition, $linenr, $remain, $off, $level) =
159713214adfSAndy Whitcroft				ctx_statement_block($linenr, $remain, $off);
1598cf655043SAndy Whitcroft		#print "C: c<$condition> s<$statement> remain<$remain>\n";
1599773647a0SAndy Whitcroft		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1600cf655043SAndy Whitcroft		#print "C: push\n";
1601cf655043SAndy Whitcroft		push(@chunks, [ $condition, $statement ]);
160213214adfSAndy Whitcroft	}
160313214adfSAndy Whitcroft
160413214adfSAndy Whitcroft	return ($level, $linenr, @chunks);
16058905a67cSAndy Whitcroft}
16068905a67cSAndy Whitcroft
16074a0df2efSAndy Whitcroftsub ctx_block_get {
1608f0a594c1SAndy Whitcroft	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
16094a0df2efSAndy Whitcroft	my $line;
16104a0df2efSAndy Whitcroft	my $start = $linenr - 1;
16114a0df2efSAndy Whitcroft	my $blk = '';
16124a0df2efSAndy Whitcroft	my @o;
16134a0df2efSAndy Whitcroft	my @c;
16144a0df2efSAndy Whitcroft	my @res = ();
16154a0df2efSAndy Whitcroft
1616f0a594c1SAndy Whitcroft	my $level = 0;
16174635f4fbSAndy Whitcroft	my @stack = ($level);
161800df344fSAndy Whitcroft	for ($line = $start; $remain > 0; $line++) {
161900df344fSAndy Whitcroft		next if ($rawlines[$line] =~ /^-/);
162000df344fSAndy Whitcroft		$remain--;
162100df344fSAndy Whitcroft
162200df344fSAndy Whitcroft		$blk .= $rawlines[$line];
16234635f4fbSAndy Whitcroft
16244635f4fbSAndy Whitcroft		# Handle nested #if/#else.
162501464f30SAndy Whitcroft		if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
16264635f4fbSAndy Whitcroft			push(@stack, $level);
162701464f30SAndy Whitcroft		} elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
16284635f4fbSAndy Whitcroft			$level = $stack[$#stack - 1];
162901464f30SAndy Whitcroft		} elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
16304635f4fbSAndy Whitcroft			$level = pop(@stack);
16314635f4fbSAndy Whitcroft		}
16324635f4fbSAndy Whitcroft
163301464f30SAndy Whitcroft		foreach my $c (split(//, $lines[$line])) {
1634f0a594c1SAndy Whitcroft			##print "C<$c>L<$level><$open$close>O<$off>\n";
1635f0a594c1SAndy Whitcroft			if ($off > 0) {
1636f0a594c1SAndy Whitcroft				$off--;
1637f0a594c1SAndy Whitcroft				next;
1638f0a594c1SAndy Whitcroft			}
16394a0df2efSAndy Whitcroft
1640f0a594c1SAndy Whitcroft			if ($c eq $close && $level > 0) {
1641f0a594c1SAndy Whitcroft				$level--;
1642f0a594c1SAndy Whitcroft				last if ($level == 0);
1643f0a594c1SAndy Whitcroft			} elsif ($c eq $open) {
1644f0a594c1SAndy Whitcroft				$level++;
1645f0a594c1SAndy Whitcroft			}
1646f0a594c1SAndy Whitcroft		}
16474a0df2efSAndy Whitcroft
1648f0a594c1SAndy Whitcroft		if (!$outer || $level <= 1) {
164900df344fSAndy Whitcroft			push(@res, $rawlines[$line]);
16504a0df2efSAndy Whitcroft		}
16514a0df2efSAndy Whitcroft
1652f0a594c1SAndy Whitcroft		last if ($level == 0);
16534a0df2efSAndy Whitcroft	}
16544a0df2efSAndy Whitcroft
1655f0a594c1SAndy Whitcroft	return ($level, @res);
16564a0df2efSAndy Whitcroft}
16574a0df2efSAndy Whitcroftsub ctx_block_outer {
16584a0df2efSAndy Whitcroft	my ($linenr, $remain) = @_;
16594a0df2efSAndy Whitcroft
1660f0a594c1SAndy Whitcroft	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1661f0a594c1SAndy Whitcroft	return @r;
16624a0df2efSAndy Whitcroft}
16634a0df2efSAndy Whitcroftsub ctx_block {
16644a0df2efSAndy Whitcroft	my ($linenr, $remain) = @_;
16654a0df2efSAndy Whitcroft
1666f0a594c1SAndy Whitcroft	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1667f0a594c1SAndy Whitcroft	return @r;
1668653d4876SAndy Whitcroft}
1669653d4876SAndy Whitcroftsub ctx_statement {
1670f0a594c1SAndy Whitcroft	my ($linenr, $remain, $off) = @_;
1671f0a594c1SAndy Whitcroft
1672f0a594c1SAndy Whitcroft	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1673f0a594c1SAndy Whitcroft	return @r;
1674f0a594c1SAndy Whitcroft}
1675f0a594c1SAndy Whitcroftsub ctx_block_level {
1676653d4876SAndy Whitcroft	my ($linenr, $remain) = @_;
1677653d4876SAndy Whitcroft
1678f0a594c1SAndy Whitcroft	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
16794a0df2efSAndy Whitcroft}
16809c0ca6f9SAndy Whitcroftsub ctx_statement_level {
16819c0ca6f9SAndy Whitcroft	my ($linenr, $remain, $off) = @_;
16829c0ca6f9SAndy Whitcroft
16839c0ca6f9SAndy Whitcroft	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
16849c0ca6f9SAndy Whitcroft}
16854a0df2efSAndy Whitcroft
16864a0df2efSAndy Whitcroftsub ctx_locate_comment {
16874a0df2efSAndy Whitcroft	my ($first_line, $end_line) = @_;
16884a0df2efSAndy Whitcroft
1689a55ee0ccSJoe Perches	# If c99 comment on the current line, or the line before or after
1690a55ee0ccSJoe Perches	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@^\+.*(//.*$)@);
1691a55ee0ccSJoe Perches	return $current_comment if (defined $current_comment);
1692a55ee0ccSJoe Perches	($current_comment) = ($rawlines[$end_line - 2] =~ m@^[\+ ].*(//.*$)@);
1693a55ee0ccSJoe Perches	return $current_comment if (defined $current_comment);
1694a55ee0ccSJoe Perches	($current_comment) = ($rawlines[$end_line] =~ m@^[\+ ].*(//.*$)@);
1695a55ee0ccSJoe Perches	return $current_comment if (defined $current_comment);
1696a55ee0ccSJoe Perches
16974a0df2efSAndy Whitcroft	# Catch a comment on the end of the line itself.
1698a55ee0ccSJoe Perches	($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
16994a0df2efSAndy Whitcroft	return $current_comment if (defined $current_comment);
17004a0df2efSAndy Whitcroft
17014a0df2efSAndy Whitcroft	# Look through the context and try and figure out if there is a
17024a0df2efSAndy Whitcroft	# comment.
17034a0df2efSAndy Whitcroft	my $in_comment = 0;
17044a0df2efSAndy Whitcroft	$current_comment = '';
17054a0df2efSAndy Whitcroft	for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
170600df344fSAndy Whitcroft		my $line = $rawlines[$linenr - 1];
170700df344fSAndy Whitcroft		#warn "           $line\n";
17084a0df2efSAndy Whitcroft		if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
17094a0df2efSAndy Whitcroft			$in_comment = 1;
17104a0df2efSAndy Whitcroft		}
17114a0df2efSAndy Whitcroft		if ($line =~ m@/\*@) {
17124a0df2efSAndy Whitcroft			$in_comment = 1;
17134a0df2efSAndy Whitcroft		}
17144a0df2efSAndy Whitcroft		if (!$in_comment && $current_comment ne '') {
17154a0df2efSAndy Whitcroft			$current_comment = '';
17164a0df2efSAndy Whitcroft		}
17174a0df2efSAndy Whitcroft		$current_comment .= $line . "\n" if ($in_comment);
17184a0df2efSAndy Whitcroft		if ($line =~ m@\*/@) {
17194a0df2efSAndy Whitcroft			$in_comment = 0;
17204a0df2efSAndy Whitcroft		}
17214a0df2efSAndy Whitcroft	}
17224a0df2efSAndy Whitcroft
17234a0df2efSAndy Whitcroft	chomp($current_comment);
17244a0df2efSAndy Whitcroft	return($current_comment);
17254a0df2efSAndy Whitcroft}
17264a0df2efSAndy Whitcroftsub ctx_has_comment {
17274a0df2efSAndy Whitcroft	my ($first_line, $end_line) = @_;
17284a0df2efSAndy Whitcroft	my $cmt = ctx_locate_comment($first_line, $end_line);
17294a0df2efSAndy Whitcroft
173000df344fSAndy Whitcroft	##print "LINE: $rawlines[$end_line - 1 ]\n";
17314a0df2efSAndy Whitcroft	##print "CMMT: $cmt\n";
17324a0df2efSAndy Whitcroft
17334a0df2efSAndy Whitcroft	return ($cmt ne '');
17344a0df2efSAndy Whitcroft}
17354a0df2efSAndy Whitcroft
17364d001e4dSAndy Whitcroftsub raw_line {
17374d001e4dSAndy Whitcroft	my ($linenr, $cnt) = @_;
17384d001e4dSAndy Whitcroft
17394d001e4dSAndy Whitcroft	my $offset = $linenr - 1;
17404d001e4dSAndy Whitcroft	$cnt++;
17414d001e4dSAndy Whitcroft
17424d001e4dSAndy Whitcroft	my $line;
17434d001e4dSAndy Whitcroft	while ($cnt) {
17444d001e4dSAndy Whitcroft		$line = $rawlines[$offset++];
17454d001e4dSAndy Whitcroft		next if (defined($line) && $line =~ /^-/);
17464d001e4dSAndy Whitcroft		$cnt--;
17474d001e4dSAndy Whitcroft	}
17484d001e4dSAndy Whitcroft
17494d001e4dSAndy Whitcroft	return $line;
17504d001e4dSAndy Whitcroft}
17514d001e4dSAndy Whitcroft
17522a9f9d85STobin C. Hardingsub get_stat_real {
17532a9f9d85STobin C. Harding	my ($linenr, $lc) = @_;
17542a9f9d85STobin C. Harding
17552a9f9d85STobin C. Harding	my $stat_real = raw_line($linenr, 0);
17562a9f9d85STobin C. Harding	for (my $count = $linenr + 1; $count <= $lc; $count++) {
17572a9f9d85STobin C. Harding		$stat_real = $stat_real . "\n" . raw_line($count, 0);
17582a9f9d85STobin C. Harding	}
17592a9f9d85STobin C. Harding
17602a9f9d85STobin C. Harding	return $stat_real;
17612a9f9d85STobin C. Harding}
17622a9f9d85STobin C. Harding
1763e3d95a2aSTobin C. Hardingsub get_stat_here {
1764e3d95a2aSTobin C. Harding	my ($linenr, $cnt, $here) = @_;
1765e3d95a2aSTobin C. Harding
1766e3d95a2aSTobin C. Harding	my $herectx = $here . "\n";
1767e3d95a2aSTobin C. Harding	for (my $n = 0; $n < $cnt; $n++) {
1768e3d95a2aSTobin C. Harding		$herectx .= raw_line($linenr, $n) . "\n";
1769e3d95a2aSTobin C. Harding	}
1770e3d95a2aSTobin C. Harding
1771e3d95a2aSTobin C. Harding	return $herectx;
1772e3d95a2aSTobin C. Harding}
1773e3d95a2aSTobin C. Harding
17740a920b5bSAndy Whitcroftsub cat_vet {
17750a920b5bSAndy Whitcroft	my ($vet) = @_;
17769c0ca6f9SAndy Whitcroft	my ($res, $coded);
17770a920b5bSAndy Whitcroft
17789c0ca6f9SAndy Whitcroft	$res = '';
17796c72ffaaSAndy Whitcroft	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
17806c72ffaaSAndy Whitcroft		$res .= $1;
17816c72ffaaSAndy Whitcroft		if ($2 ne '') {
17829c0ca6f9SAndy Whitcroft			$coded = sprintf("^%c", unpack('C', $2) + 64);
17836c72ffaaSAndy Whitcroft			$res .= $coded;
17846c72ffaaSAndy Whitcroft		}
17859c0ca6f9SAndy Whitcroft	}
17869c0ca6f9SAndy Whitcroft	$res =~ s/$/\$/;
17870a920b5bSAndy Whitcroft
17889c0ca6f9SAndy Whitcroft	return $res;
17890a920b5bSAndy Whitcroft}
17900a920b5bSAndy Whitcroft
1791c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0;
1792cf655043SAndy Whitcroftmy $av_pending;
1793c2fdda0dSAndy Whitcroftmy @av_paren_type;
17941f65f947SAndy Whitcroftmy $av_pend_colon;
1795c2fdda0dSAndy Whitcroft
1796c2fdda0dSAndy Whitcroftsub annotate_reset {
1797c2fdda0dSAndy Whitcroft	$av_preprocessor = 0;
1798cf655043SAndy Whitcroft	$av_pending = '_';
1799cf655043SAndy Whitcroft	@av_paren_type = ('E');
18001f65f947SAndy Whitcroft	$av_pend_colon = 'O';
1801c2fdda0dSAndy Whitcroft}
1802c2fdda0dSAndy Whitcroft
18036c72ffaaSAndy Whitcroftsub annotate_values {
18046c72ffaaSAndy Whitcroft	my ($stream, $type) = @_;
18056c72ffaaSAndy Whitcroft
18066c72ffaaSAndy Whitcroft	my $res;
18071f65f947SAndy Whitcroft	my $var = '_' x length($stream);
18086c72ffaaSAndy Whitcroft	my $cur = $stream;
18096c72ffaaSAndy Whitcroft
1810c2fdda0dSAndy Whitcroft	print "$stream\n" if ($dbg_values > 1);
18116c72ffaaSAndy Whitcroft
18126c72ffaaSAndy Whitcroft	while (length($cur)) {
1813773647a0SAndy Whitcroft		@av_paren_type = ('E') if ($#av_paren_type < 0);
1814cf655043SAndy Whitcroft		print " <" . join('', @av_paren_type) .
1815171ae1a4SAndy Whitcroft				"> <$type> <$av_pending>" if ($dbg_values > 1);
18166c72ffaaSAndy Whitcroft		if ($cur =~ /^(\s+)/o) {
1817c2fdda0dSAndy Whitcroft			print "WS($1)\n" if ($dbg_values > 1);
1818c2fdda0dSAndy Whitcroft			if ($1 =~ /\n/ && $av_preprocessor) {
1819cf655043SAndy Whitcroft				$type = pop(@av_paren_type);
1820c2fdda0dSAndy Whitcroft				$av_preprocessor = 0;
18216c72ffaaSAndy Whitcroft			}
18226c72ffaaSAndy Whitcroft
1823c023e473SFlorian Mickler		} elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
18249446ef56SAndy Whitcroft			print "CAST($1)\n" if ($dbg_values > 1);
18259446ef56SAndy Whitcroft			push(@av_paren_type, $type);
1826addcdceaSAndy Whitcroft			$type = 'c';
18279446ef56SAndy Whitcroft
1828e91b6e26SAndy Whitcroft		} elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1829c2fdda0dSAndy Whitcroft			print "DECLARE($1)\n" if ($dbg_values > 1);
18306c72ffaaSAndy Whitcroft			$type = 'T';
18316c72ffaaSAndy Whitcroft
1832389a2fe5SAndy Whitcroft		} elsif ($cur =~ /^($Modifier)\s*/) {
1833389a2fe5SAndy Whitcroft			print "MODIFIER($1)\n" if ($dbg_values > 1);
1834389a2fe5SAndy Whitcroft			$type = 'T';
1835389a2fe5SAndy Whitcroft
1836c45dcabdSAndy Whitcroft		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1837171ae1a4SAndy Whitcroft			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1838c2fdda0dSAndy Whitcroft			$av_preprocessor = 1;
1839171ae1a4SAndy Whitcroft			push(@av_paren_type, $type);
1840171ae1a4SAndy Whitcroft			if ($2 ne '') {
1841cf655043SAndy Whitcroft				$av_pending = 'N';
1842171ae1a4SAndy Whitcroft			}
1843171ae1a4SAndy Whitcroft			$type = 'E';
1844171ae1a4SAndy Whitcroft
1845c45dcabdSAndy Whitcroft		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1846171ae1a4SAndy Whitcroft			print "UNDEF($1)\n" if ($dbg_values > 1);
1847171ae1a4SAndy Whitcroft			$av_preprocessor = 1;
1848171ae1a4SAndy Whitcroft			push(@av_paren_type, $type);
18496c72ffaaSAndy Whitcroft
1850c45dcabdSAndy Whitcroft		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1851cf655043SAndy Whitcroft			print "PRE_START($1)\n" if ($dbg_values > 1);
1852c2fdda0dSAndy Whitcroft			$av_preprocessor = 1;
1853cf655043SAndy Whitcroft
1854cf655043SAndy Whitcroft			push(@av_paren_type, $type);
1855cf655043SAndy Whitcroft			push(@av_paren_type, $type);
1856171ae1a4SAndy Whitcroft			$type = 'E';
1857cf655043SAndy Whitcroft
1858c45dcabdSAndy Whitcroft		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1859cf655043SAndy Whitcroft			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1860cf655043SAndy Whitcroft			$av_preprocessor = 1;
1861cf655043SAndy Whitcroft
1862cf655043SAndy Whitcroft			push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1863cf655043SAndy Whitcroft
1864171ae1a4SAndy Whitcroft			$type = 'E';
1865cf655043SAndy Whitcroft
1866c45dcabdSAndy Whitcroft		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1867cf655043SAndy Whitcroft			print "PRE_END($1)\n" if ($dbg_values > 1);
1868cf655043SAndy Whitcroft
1869cf655043SAndy Whitcroft			$av_preprocessor = 1;
1870cf655043SAndy Whitcroft
1871cf655043SAndy Whitcroft			# Assume all arms of the conditional end as this
1872cf655043SAndy Whitcroft			# one does, and continue as if the #endif was not here.
1873cf655043SAndy Whitcroft			pop(@av_paren_type);
1874cf655043SAndy Whitcroft			push(@av_paren_type, $type);
1875171ae1a4SAndy Whitcroft			$type = 'E';
18766c72ffaaSAndy Whitcroft
18776c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^(\\\n)/o) {
1878c2fdda0dSAndy Whitcroft			print "PRECONT($1)\n" if ($dbg_values > 1);
18796c72ffaaSAndy Whitcroft
1880171ae1a4SAndy Whitcroft		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1881171ae1a4SAndy Whitcroft			print "ATTR($1)\n" if ($dbg_values > 1);
1882171ae1a4SAndy Whitcroft			$av_pending = $type;
1883171ae1a4SAndy Whitcroft			$type = 'N';
1884171ae1a4SAndy Whitcroft
18856c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1886c2fdda0dSAndy Whitcroft			print "SIZEOF($1)\n" if ($dbg_values > 1);
18876c72ffaaSAndy Whitcroft			if (defined $2) {
1888cf655043SAndy Whitcroft				$av_pending = 'V';
18896c72ffaaSAndy Whitcroft			}
18906c72ffaaSAndy Whitcroft			$type = 'N';
18916c72ffaaSAndy Whitcroft
189214b111c1SAndy Whitcroft		} elsif ($cur =~ /^(if|while|for)\b/o) {
1893c2fdda0dSAndy Whitcroft			print "COND($1)\n" if ($dbg_values > 1);
189414b111c1SAndy Whitcroft			$av_pending = 'E';
18956c72ffaaSAndy Whitcroft			$type = 'N';
18966c72ffaaSAndy Whitcroft
18971f65f947SAndy Whitcroft		} elsif ($cur =~/^(case)/o) {
18981f65f947SAndy Whitcroft			print "CASE($1)\n" if ($dbg_values > 1);
18991f65f947SAndy Whitcroft			$av_pend_colon = 'C';
19001f65f947SAndy Whitcroft			$type = 'N';
19011f65f947SAndy Whitcroft
190214b111c1SAndy Whitcroft		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1903c2fdda0dSAndy Whitcroft			print "KEYWORD($1)\n" if ($dbg_values > 1);
19046c72ffaaSAndy Whitcroft			$type = 'N';
19056c72ffaaSAndy Whitcroft
19066c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^(\()/o) {
1907c2fdda0dSAndy Whitcroft			print "PAREN('$1')\n" if ($dbg_values > 1);
1908cf655043SAndy Whitcroft			push(@av_paren_type, $av_pending);
1909cf655043SAndy Whitcroft			$av_pending = '_';
19106c72ffaaSAndy Whitcroft			$type = 'N';
19116c72ffaaSAndy Whitcroft
19126c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^(\))/o) {
1913cf655043SAndy Whitcroft			my $new_type = pop(@av_paren_type);
1914cf655043SAndy Whitcroft			if ($new_type ne '_') {
1915cf655043SAndy Whitcroft				$type = $new_type;
1916c2fdda0dSAndy Whitcroft				print "PAREN('$1') -> $type\n"
1917c2fdda0dSAndy Whitcroft							if ($dbg_values > 1);
19186c72ffaaSAndy Whitcroft			} else {
1919c2fdda0dSAndy Whitcroft				print "PAREN('$1')\n" if ($dbg_values > 1);
19206c72ffaaSAndy Whitcroft			}
19216c72ffaaSAndy Whitcroft
1922c8cb2ca3SAndy Whitcroft		} elsif ($cur =~ /^($Ident)\s*\(/o) {
1923c2fdda0dSAndy Whitcroft			print "FUNC($1)\n" if ($dbg_values > 1);
1924c8cb2ca3SAndy Whitcroft			$type = 'V';
1925cf655043SAndy Whitcroft			$av_pending = 'V';
19266c72ffaaSAndy Whitcroft
19278e761b04SAndy Whitcroft		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
19288e761b04SAndy Whitcroft			if (defined $2 && $type eq 'C' || $type eq 'T') {
19291f65f947SAndy Whitcroft				$av_pend_colon = 'B';
19308e761b04SAndy Whitcroft			} elsif ($type eq 'E') {
19318e761b04SAndy Whitcroft				$av_pend_colon = 'L';
19321f65f947SAndy Whitcroft			}
19331f65f947SAndy Whitcroft			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
19341f65f947SAndy Whitcroft			$type = 'V';
19351f65f947SAndy Whitcroft
19366c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^($Ident|$Constant)/o) {
1937c2fdda0dSAndy Whitcroft			print "IDENT($1)\n" if ($dbg_values > 1);
19386c72ffaaSAndy Whitcroft			$type = 'V';
19396c72ffaaSAndy Whitcroft
19406c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^($Assignment)/o) {
1941c2fdda0dSAndy Whitcroft			print "ASSIGN($1)\n" if ($dbg_values > 1);
19426c72ffaaSAndy Whitcroft			$type = 'N';
19436c72ffaaSAndy Whitcroft
1944cf655043SAndy Whitcroft		} elsif ($cur =~/^(;|{|})/) {
1945c2fdda0dSAndy Whitcroft			print "END($1)\n" if ($dbg_values > 1);
194613214adfSAndy Whitcroft			$type = 'E';
19471f65f947SAndy Whitcroft			$av_pend_colon = 'O';
194813214adfSAndy Whitcroft
19498e761b04SAndy Whitcroft		} elsif ($cur =~/^(,)/) {
19508e761b04SAndy Whitcroft			print "COMMA($1)\n" if ($dbg_values > 1);
19518e761b04SAndy Whitcroft			$type = 'C';
19528e761b04SAndy Whitcroft
19531f65f947SAndy Whitcroft		} elsif ($cur =~ /^(\?)/o) {
19541f65f947SAndy Whitcroft			print "QUESTION($1)\n" if ($dbg_values > 1);
19551f65f947SAndy Whitcroft			$type = 'N';
19561f65f947SAndy Whitcroft
19571f65f947SAndy Whitcroft		} elsif ($cur =~ /^(:)/o) {
19581f65f947SAndy Whitcroft			print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
19591f65f947SAndy Whitcroft
19601f65f947SAndy Whitcroft			substr($var, length($res), 1, $av_pend_colon);
19611f65f947SAndy Whitcroft			if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
19621f65f947SAndy Whitcroft				$type = 'E';
19631f65f947SAndy Whitcroft			} else {
19641f65f947SAndy Whitcroft				$type = 'N';
19651f65f947SAndy Whitcroft			}
19661f65f947SAndy Whitcroft			$av_pend_colon = 'O';
19671f65f947SAndy Whitcroft
19688e761b04SAndy Whitcroft		} elsif ($cur =~ /^(\[)/o) {
196913214adfSAndy Whitcroft			print "CLOSE($1)\n" if ($dbg_values > 1);
19706c72ffaaSAndy Whitcroft			$type = 'N';
19716c72ffaaSAndy Whitcroft
19720d413866SAndy Whitcroft		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
197374048ed8SAndy Whitcroft			my $variant;
197474048ed8SAndy Whitcroft
197574048ed8SAndy Whitcroft			print "OPV($1)\n" if ($dbg_values > 1);
197674048ed8SAndy Whitcroft			if ($type eq 'V') {
197774048ed8SAndy Whitcroft				$variant = 'B';
197874048ed8SAndy Whitcroft			} else {
197974048ed8SAndy Whitcroft				$variant = 'U';
198074048ed8SAndy Whitcroft			}
198174048ed8SAndy Whitcroft
198274048ed8SAndy Whitcroft			substr($var, length($res), 1, $variant);
198374048ed8SAndy Whitcroft			$type = 'N';
198474048ed8SAndy Whitcroft
19856c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^($Operators)/o) {
1986c2fdda0dSAndy Whitcroft			print "OP($1)\n" if ($dbg_values > 1);
19876c72ffaaSAndy Whitcroft			if ($1 ne '++' && $1 ne '--') {
19886c72ffaaSAndy Whitcroft				$type = 'N';
19896c72ffaaSAndy Whitcroft			}
19906c72ffaaSAndy Whitcroft
19916c72ffaaSAndy Whitcroft		} elsif ($cur =~ /(^.)/o) {
1992c2fdda0dSAndy Whitcroft			print "C($1)\n" if ($dbg_values > 1);
19936c72ffaaSAndy Whitcroft		}
19946c72ffaaSAndy Whitcroft		if (defined $1) {
19956c72ffaaSAndy Whitcroft			$cur = substr($cur, length($1));
19966c72ffaaSAndy Whitcroft			$res .= $type x length($1);
19976c72ffaaSAndy Whitcroft		}
19986c72ffaaSAndy Whitcroft	}
19996c72ffaaSAndy Whitcroft
20001f65f947SAndy Whitcroft	return ($res, $var);
20016c72ffaaSAndy Whitcroft}
20026c72ffaaSAndy Whitcroft
20038905a67cSAndy Whitcroftsub possible {
200413214adfSAndy Whitcroft	my ($possible, $line) = @_;
20059a974fdbSAndy Whitcroft	my $notPermitted = qr{(?:
20060776e594SAndy Whitcroft		^(?:
20070776e594SAndy Whitcroft			$Modifier|
20080776e594SAndy Whitcroft			$Storage|
20090776e594SAndy Whitcroft			$Type|
20109a974fdbSAndy Whitcroft			DEFINE_\S+
20119a974fdbSAndy Whitcroft		)$|
20129a974fdbSAndy Whitcroft		^(?:
20130776e594SAndy Whitcroft			goto|
20140776e594SAndy Whitcroft			return|
20150776e594SAndy Whitcroft			case|
20160776e594SAndy Whitcroft			else|
20170776e594SAndy Whitcroft			asm|__asm__|
201889a88353SAndy Whitcroft			do|
201989a88353SAndy Whitcroft			\#|
202089a88353SAndy Whitcroft			\#\#|
20219a974fdbSAndy Whitcroft		)(?:\s|$)|
20220776e594SAndy Whitcroft		^(?:typedef|struct|enum)\b
20239a974fdbSAndy Whitcroft	    )}x;
20249a974fdbSAndy Whitcroft	warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
20259a974fdbSAndy Whitcroft	if ($possible !~ $notPermitted) {
2026c45dcabdSAndy Whitcroft		# Check for modifiers.
2027c45dcabdSAndy Whitcroft		$possible =~ s/\s*$Storage\s*//g;
2028c45dcabdSAndy Whitcroft		$possible =~ s/\s*$Sparse\s*//g;
2029c45dcabdSAndy Whitcroft		if ($possible =~ /^\s*$/) {
2030c45dcabdSAndy Whitcroft
2031c45dcabdSAndy Whitcroft		} elsif ($possible =~ /\s/) {
2032c45dcabdSAndy Whitcroft			$possible =~ s/\s*$Type\s*//g;
2033d2506586SAndy Whitcroft			for my $modifier (split(' ', $possible)) {
20349a974fdbSAndy Whitcroft				if ($modifier !~ $notPermitted) {
2035d2506586SAndy Whitcroft					warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
2036485ff23eSAlex Dowad					push(@modifierListFile, $modifier);
2037d2506586SAndy Whitcroft				}
20389a974fdbSAndy Whitcroft			}
2039c45dcabdSAndy Whitcroft
2040c45dcabdSAndy Whitcroft		} else {
204113214adfSAndy Whitcroft			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
2042485ff23eSAlex Dowad			push(@typeListFile, $possible);
2043c45dcabdSAndy Whitcroft		}
20448905a67cSAndy Whitcroft		build_types();
20450776e594SAndy Whitcroft	} else {
20460776e594SAndy Whitcroft		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
20478905a67cSAndy Whitcroft	}
20488905a67cSAndy Whitcroft}
20498905a67cSAndy Whitcroft
20506c72ffaaSAndy Whitcroftmy $prefix = '';
20516c72ffaaSAndy Whitcroft
2052000d1cc1SJoe Perchessub show_type {
2053cbec18afSJoe Perches	my ($type) = @_;
205491bfe484SJoe Perches
2055522b837cSAlexey Dobriyan	$type =~ tr/[a-z]/[A-Z]/;
2056522b837cSAlexey Dobriyan
2057cbec18afSJoe Perches	return defined $use_type{$type} if (scalar keys %use_type > 0);
2058cbec18afSJoe Perches
2059cbec18afSJoe Perches	return !defined $ignore_type{$type};
2060000d1cc1SJoe Perches}
2061000d1cc1SJoe Perches
2062f0a594c1SAndy Whitcroftsub report {
2063cbec18afSJoe Perches	my ($level, $type, $msg) = @_;
2064cbec18afSJoe Perches
2065cbec18afSJoe Perches	if (!show_type($type) ||
2066cbec18afSJoe Perches	    (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
2067773647a0SAndy Whitcroft		return 0;
2068773647a0SAndy Whitcroft	}
206957230297SJoe Perches	my $output = '';
2070737c0767SJohn Brooks	if ($color) {
207157230297SJoe Perches		if ($level eq 'ERROR') {
207257230297SJoe Perches			$output .= RED;
207357230297SJoe Perches		} elsif ($level eq 'WARNING') {
207457230297SJoe Perches			$output .= YELLOW;
2075000d1cc1SJoe Perches		} else {
207657230297SJoe Perches			$output .= GREEN;
2077000d1cc1SJoe Perches		}
207857230297SJoe Perches	}
207957230297SJoe Perches	$output .= $prefix . $level . ':';
208057230297SJoe Perches	if ($show_types) {
2081737c0767SJohn Brooks		$output .= BLUE if ($color);
208257230297SJoe Perches		$output .= "$type:";
208357230297SJoe Perches	}
2084737c0767SJohn Brooks	$output .= RESET if ($color);
208557230297SJoe Perches	$output .= ' ' . $msg . "\n";
208634d8815fSJoe Perches
208734d8815fSJoe Perches	if ($showfile) {
208834d8815fSJoe Perches		my @lines = split("\n", $output, -1);
208934d8815fSJoe Perches		splice(@lines, 1, 1);
209034d8815fSJoe Perches		$output = join("\n", @lines);
209134d8815fSJoe Perches	}
209257230297SJoe Perches	$output = (split('\n', $output))[0] . "\n" if ($terse);
20938905a67cSAndy Whitcroft
209457230297SJoe Perches	push(our @report, $output);
2095773647a0SAndy Whitcroft
2096773647a0SAndy Whitcroft	return 1;
2097f0a594c1SAndy Whitcroft}
2098cbec18afSJoe Perches
2099f0a594c1SAndy Whitcroftsub report_dump {
210013214adfSAndy Whitcroft	our @report;
2101f0a594c1SAndy Whitcroft}
2102000d1cc1SJoe Perches
2103d752fcc8SJoe Perchessub fixup_current_range {
2104d752fcc8SJoe Perches	my ($lineRef, $offset, $length) = @_;
2105d752fcc8SJoe Perches
2106d752fcc8SJoe Perches	if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
2107d752fcc8SJoe Perches		my $o = $1;
2108d752fcc8SJoe Perches		my $l = $2;
2109d752fcc8SJoe Perches		my $no = $o + $offset;
2110d752fcc8SJoe Perches		my $nl = $l + $length;
2111d752fcc8SJoe Perches		$$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
2112d752fcc8SJoe Perches	}
2113d752fcc8SJoe Perches}
2114d752fcc8SJoe Perches
2115d752fcc8SJoe Perchessub fix_inserted_deleted_lines {
2116d752fcc8SJoe Perches	my ($linesRef, $insertedRef, $deletedRef) = @_;
2117d752fcc8SJoe Perches
2118d752fcc8SJoe Perches	my $range_last_linenr = 0;
2119d752fcc8SJoe Perches	my $delta_offset = 0;
2120d752fcc8SJoe Perches
2121d752fcc8SJoe Perches	my $old_linenr = 0;
2122d752fcc8SJoe Perches	my $new_linenr = 0;
2123d752fcc8SJoe Perches
2124d752fcc8SJoe Perches	my $next_insert = 0;
2125d752fcc8SJoe Perches	my $next_delete = 0;
2126d752fcc8SJoe Perches
2127d752fcc8SJoe Perches	my @lines = ();
2128d752fcc8SJoe Perches
2129d752fcc8SJoe Perches	my $inserted = @{$insertedRef}[$next_insert++];
2130d752fcc8SJoe Perches	my $deleted = @{$deletedRef}[$next_delete++];
2131d752fcc8SJoe Perches
2132d752fcc8SJoe Perches	foreach my $old_line (@{$linesRef}) {
2133d752fcc8SJoe Perches		my $save_line = 1;
2134d752fcc8SJoe Perches		my $line = $old_line;	#don't modify the array
2135323b267fSJoe Perches		if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) {	#new filename
2136d752fcc8SJoe Perches			$delta_offset = 0;
2137d752fcc8SJoe Perches		} elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) {	#new hunk
2138d752fcc8SJoe Perches			$range_last_linenr = $new_linenr;
2139d752fcc8SJoe Perches			fixup_current_range(\$line, $delta_offset, 0);
2140d752fcc8SJoe Perches		}
2141d752fcc8SJoe Perches
2142d752fcc8SJoe Perches		while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2143d752fcc8SJoe Perches			$deleted = @{$deletedRef}[$next_delete++];
2144d752fcc8SJoe Perches			$save_line = 0;
2145d752fcc8SJoe Perches			fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2146d752fcc8SJoe Perches		}
2147d752fcc8SJoe Perches
2148d752fcc8SJoe Perches		while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2149d752fcc8SJoe Perches			push(@lines, ${$inserted}{'LINE'});
2150d752fcc8SJoe Perches			$inserted = @{$insertedRef}[$next_insert++];
2151d752fcc8SJoe Perches			$new_linenr++;
2152d752fcc8SJoe Perches			fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2153d752fcc8SJoe Perches		}
2154d752fcc8SJoe Perches
2155d752fcc8SJoe Perches		if ($save_line) {
2156d752fcc8SJoe Perches			push(@lines, $line);
2157d752fcc8SJoe Perches			$new_linenr++;
2158d752fcc8SJoe Perches		}
2159d752fcc8SJoe Perches
2160d752fcc8SJoe Perches		$old_linenr++;
2161d752fcc8SJoe Perches	}
2162d752fcc8SJoe Perches
2163d752fcc8SJoe Perches	return @lines;
2164d752fcc8SJoe Perches}
2165d752fcc8SJoe Perches
2166f2d7e4d4SJoe Perchessub fix_insert_line {
2167f2d7e4d4SJoe Perches	my ($linenr, $line) = @_;
2168f2d7e4d4SJoe Perches
2169f2d7e4d4SJoe Perches	my $inserted = {
2170f2d7e4d4SJoe Perches		LINENR => $linenr,
2171f2d7e4d4SJoe Perches		LINE => $line,
2172f2d7e4d4SJoe Perches	};
2173f2d7e4d4SJoe Perches	push(@fixed_inserted, $inserted);
2174f2d7e4d4SJoe Perches}
2175f2d7e4d4SJoe Perches
2176f2d7e4d4SJoe Perchessub fix_delete_line {
2177f2d7e4d4SJoe Perches	my ($linenr, $line) = @_;
2178f2d7e4d4SJoe Perches
2179f2d7e4d4SJoe Perches	my $deleted = {
2180f2d7e4d4SJoe Perches		LINENR => $linenr,
2181f2d7e4d4SJoe Perches		LINE => $line,
2182f2d7e4d4SJoe Perches	};
2183f2d7e4d4SJoe Perches
2184f2d7e4d4SJoe Perches	push(@fixed_deleted, $deleted);
2185f2d7e4d4SJoe Perches}
2186f2d7e4d4SJoe Perches
2187de7d4f0eSAndy Whitcroftsub ERROR {
2188cbec18afSJoe Perches	my ($type, $msg) = @_;
2189cbec18afSJoe Perches
2190cbec18afSJoe Perches	if (report("ERROR", $type, $msg)) {
2191de7d4f0eSAndy Whitcroft		our $clean = 0;
21926c72ffaaSAndy Whitcroft		our $cnt_error++;
21933705ce5bSJoe Perches		return 1;
2194de7d4f0eSAndy Whitcroft	}
21953705ce5bSJoe Perches	return 0;
2196773647a0SAndy Whitcroft}
2197de7d4f0eSAndy Whitcroftsub WARN {
2198cbec18afSJoe Perches	my ($type, $msg) = @_;
2199cbec18afSJoe Perches
2200cbec18afSJoe Perches	if (report("WARNING", $type, $msg)) {
2201de7d4f0eSAndy Whitcroft		our $clean = 0;
22026c72ffaaSAndy Whitcroft		our $cnt_warn++;
22033705ce5bSJoe Perches		return 1;
2204de7d4f0eSAndy Whitcroft	}
22053705ce5bSJoe Perches	return 0;
2206773647a0SAndy Whitcroft}
2207de7d4f0eSAndy Whitcroftsub CHK {
2208cbec18afSJoe Perches	my ($type, $msg) = @_;
2209cbec18afSJoe Perches
2210cbec18afSJoe Perches	if ($check && report("CHECK", $type, $msg)) {
2211de7d4f0eSAndy Whitcroft		our $clean = 0;
22126c72ffaaSAndy Whitcroft		our $cnt_chk++;
22133705ce5bSJoe Perches		return 1;
22146c72ffaaSAndy Whitcroft	}
22153705ce5bSJoe Perches	return 0;
2216de7d4f0eSAndy Whitcroft}
2217de7d4f0eSAndy Whitcroft
22186ecd9674SAndy Whitcroftsub check_absolute_file {
22196ecd9674SAndy Whitcroft	my ($absolute, $herecurr) = @_;
22206ecd9674SAndy Whitcroft	my $file = $absolute;
22216ecd9674SAndy Whitcroft
22226ecd9674SAndy Whitcroft	##print "absolute<$absolute>\n";
22236ecd9674SAndy Whitcroft
22246ecd9674SAndy Whitcroft	# See if any suffix of this path is a path within the tree.
22256ecd9674SAndy Whitcroft	while ($file =~ s@^[^/]*/@@) {
22266ecd9674SAndy Whitcroft		if (-f "$root/$file") {
22276ecd9674SAndy Whitcroft			##print "file<$file>\n";
22286ecd9674SAndy Whitcroft			last;
22296ecd9674SAndy Whitcroft		}
22306ecd9674SAndy Whitcroft	}
22316ecd9674SAndy Whitcroft	if (! -f _)  {
22326ecd9674SAndy Whitcroft		return 0;
22336ecd9674SAndy Whitcroft	}
22346ecd9674SAndy Whitcroft
22356ecd9674SAndy Whitcroft	# It is, so see if the prefix is acceptable.
22366ecd9674SAndy Whitcroft	my $prefix = $absolute;
22376ecd9674SAndy Whitcroft	substr($prefix, -length($file)) = '';
22386ecd9674SAndy Whitcroft
22396ecd9674SAndy Whitcroft	##print "prefix<$prefix>\n";
22406ecd9674SAndy Whitcroft	if ($prefix ne ".../") {
2241000d1cc1SJoe Perches		WARN("USE_RELATIVE_PATH",
2242000d1cc1SJoe Perches		     "use relative pathname instead of absolute in changelog text\n" . $herecurr);
22436ecd9674SAndy Whitcroft	}
22446ecd9674SAndy Whitcroft}
22456ecd9674SAndy Whitcroft
22463705ce5bSJoe Perchessub trim {
22473705ce5bSJoe Perches	my ($string) = @_;
22483705ce5bSJoe Perches
2249b34c648bSJoe Perches	$string =~ s/^\s+|\s+$//g;
2250b34c648bSJoe Perches
2251b34c648bSJoe Perches	return $string;
2252b34c648bSJoe Perches}
2253b34c648bSJoe Perches
2254b34c648bSJoe Perchessub ltrim {
2255b34c648bSJoe Perches	my ($string) = @_;
2256b34c648bSJoe Perches
2257b34c648bSJoe Perches	$string =~ s/^\s+//;
2258b34c648bSJoe Perches
2259b34c648bSJoe Perches	return $string;
2260b34c648bSJoe Perches}
2261b34c648bSJoe Perches
2262b34c648bSJoe Perchessub rtrim {
2263b34c648bSJoe Perches	my ($string) = @_;
2264b34c648bSJoe Perches
2265b34c648bSJoe Perches	$string =~ s/\s+$//;
22663705ce5bSJoe Perches
22673705ce5bSJoe Perches	return $string;
22683705ce5bSJoe Perches}
22693705ce5bSJoe Perches
227052ea8506SJoe Perchessub string_find_replace {
227152ea8506SJoe Perches	my ($string, $find, $replace) = @_;
227252ea8506SJoe Perches
227352ea8506SJoe Perches	$string =~ s/$find/$replace/g;
227452ea8506SJoe Perches
227552ea8506SJoe Perches	return $string;
227652ea8506SJoe Perches}
227752ea8506SJoe Perches
22783705ce5bSJoe Perchessub tabify {
22793705ce5bSJoe Perches	my ($leading) = @_;
22803705ce5bSJoe Perches
2281713a09deSAntonio Borneo	my $source_indent = $tabsize;
22823705ce5bSJoe Perches	my $max_spaces_before_tab = $source_indent - 1;
22833705ce5bSJoe Perches	my $spaces_to_tab = " " x $source_indent;
22843705ce5bSJoe Perches
22853705ce5bSJoe Perches	#convert leading spaces to tabs
22863705ce5bSJoe Perches	1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
22873705ce5bSJoe Perches	#Remove spaces before a tab
22883705ce5bSJoe Perches	1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
22893705ce5bSJoe Perches
22903705ce5bSJoe Perches	return "$leading";
22913705ce5bSJoe Perches}
22923705ce5bSJoe Perches
2293d1fe9c09SJoe Perchessub pos_last_openparen {
2294d1fe9c09SJoe Perches	my ($line) = @_;
2295d1fe9c09SJoe Perches
2296d1fe9c09SJoe Perches	my $pos = 0;
2297d1fe9c09SJoe Perches
2298d1fe9c09SJoe Perches	my $opens = $line =~ tr/\(/\(/;
2299d1fe9c09SJoe Perches	my $closes = $line =~ tr/\)/\)/;
2300d1fe9c09SJoe Perches
2301d1fe9c09SJoe Perches	my $last_openparen = 0;
2302d1fe9c09SJoe Perches
2303d1fe9c09SJoe Perches	if (($opens == 0) || ($closes >= $opens)) {
2304d1fe9c09SJoe Perches		return -1;
2305d1fe9c09SJoe Perches	}
2306d1fe9c09SJoe Perches
2307d1fe9c09SJoe Perches	my $len = length($line);
2308d1fe9c09SJoe Perches
2309d1fe9c09SJoe Perches	for ($pos = 0; $pos < $len; $pos++) {
2310d1fe9c09SJoe Perches		my $string = substr($line, $pos);
2311d1fe9c09SJoe Perches		if ($string =~ /^($FuncArg|$balanced_parens)/) {
2312d1fe9c09SJoe Perches			$pos += length($1) - 1;
2313d1fe9c09SJoe Perches		} elsif (substr($line, $pos, 1) eq '(') {
2314d1fe9c09SJoe Perches			$last_openparen = $pos;
2315d1fe9c09SJoe Perches		} elsif (index($string, '(') == -1) {
2316d1fe9c09SJoe Perches			last;
2317d1fe9c09SJoe Perches		}
2318d1fe9c09SJoe Perches	}
2319d1fe9c09SJoe Perches
232091cb5195SJoe Perches	return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
2321d1fe9c09SJoe Perches}
2322d1fe9c09SJoe Perches
2323f36d3eb8SJoe Perchessub get_raw_comment {
2324f36d3eb8SJoe Perches	my ($line, $rawline) = @_;
2325f36d3eb8SJoe Perches	my $comment = '';
2326f36d3eb8SJoe Perches
2327f36d3eb8SJoe Perches	for my $i (0 .. (length($line) - 1)) {
2328f36d3eb8SJoe Perches		if (substr($line, $i, 1) eq "$;") {
2329f36d3eb8SJoe Perches			$comment .= substr($rawline, $i, 1);
2330f36d3eb8SJoe Perches		}
2331f36d3eb8SJoe Perches	}
2332f36d3eb8SJoe Perches
2333f36d3eb8SJoe Perches	return $comment;
2334f36d3eb8SJoe Perches}
2335f36d3eb8SJoe Perches
23360a920b5bSAndy Whitcroftsub process {
23370a920b5bSAndy Whitcroft	my $filename = shift;
23380a920b5bSAndy Whitcroft
23390a920b5bSAndy Whitcroft	my $linenr=0;
23400a920b5bSAndy Whitcroft	my $prevline="";
2341c2fdda0dSAndy Whitcroft	my $prevrawline="";
23420a920b5bSAndy Whitcroft	my $stashline="";
2343c2fdda0dSAndy Whitcroft	my $stashrawline="";
23440a920b5bSAndy Whitcroft
23454a0df2efSAndy Whitcroft	my $length;
23460a920b5bSAndy Whitcroft	my $indent;
23470a920b5bSAndy Whitcroft	my $previndent=0;
23480a920b5bSAndy Whitcroft	my $stashindent=0;
23490a920b5bSAndy Whitcroft
2350de7d4f0eSAndy Whitcroft	our $clean = 1;
23510a920b5bSAndy Whitcroft	my $signoff = 0;
2352cd261496SGeert Uytterhoeven	my $author = '';
2353cd261496SGeert Uytterhoeven	my $authorsignoff = 0;
23540a920b5bSAndy Whitcroft	my $is_patch = 0;
2355133712a2SRob Herring	my $is_binding_patch = -1;
235629ee1b0cSJoe Perches	my $in_header_lines = $file ? 0 : 1;
235715662b3eSJoe Perches	my $in_commit_log = 0;		#Scanning lines before patch
235844d303ebSJoe Perches	my $has_patch_separator = 0;	#Found a --- line
2359ed43c4e5SAllen Hubbe	my $has_commit_log = 0;		#Encountered lines before patch
2360490b292cSJoe Perches	my $commit_log_lines = 0;	#Number of commit log lines
2361bf4daf12SJoe Perches	my $commit_log_possible_stack_dump = 0;
23622a076f40SJoe Perches	my $commit_log_long_line = 0;
2363e518e9a5SJoe Perches	my $commit_log_has_diff = 0;
236413f1937eSJoe Perches	my $reported_maintainer_file = 0;
2365fa64205dSPasi Savanainen	my $non_utf8_charset = 0;
2366fa64205dSPasi Savanainen
2367365dd4eaSJoe Perches	my $last_blank_line = 0;
23685e4f6ba5SJoe Perches	my $last_coalesced_string_linenr = -1;
2369365dd4eaSJoe Perches
237013214adfSAndy Whitcroft	our @report = ();
23716c72ffaaSAndy Whitcroft	our $cnt_lines = 0;
23726c72ffaaSAndy Whitcroft	our $cnt_error = 0;
23736c72ffaaSAndy Whitcroft	our $cnt_warn = 0;
23746c72ffaaSAndy Whitcroft	our $cnt_chk = 0;
23756c72ffaaSAndy Whitcroft
23760a920b5bSAndy Whitcroft	# Trace the real file/line as we go.
23770a920b5bSAndy Whitcroft	my $realfile = '';
23780a920b5bSAndy Whitcroft	my $realline = 0;
23790a920b5bSAndy Whitcroft	my $realcnt = 0;
23800a920b5bSAndy Whitcroft	my $here = '';
238177cb8546SJoe Perches	my $context_function;		#undef'd unless there's a known function
23820a920b5bSAndy Whitcroft	my $in_comment = 0;
2383c2fdda0dSAndy Whitcroft	my $comment_edge = 0;
23840a920b5bSAndy Whitcroft	my $first_line = 0;
23851e855726SWolfram Sang	my $p1_prefix = '';
23860a920b5bSAndy Whitcroft
238713214adfSAndy Whitcroft	my $prev_values = 'E';
238813214adfSAndy Whitcroft
238913214adfSAndy Whitcroft	# suppression flags
2390773647a0SAndy Whitcroft	my %suppress_ifbraces;
2391170d3a22SAndy Whitcroft	my %suppress_whiletrailers;
23922b474a1aSAndy Whitcroft	my %suppress_export;
23933e469cdcSAndy Whitcroft	my $suppress_statement = 0;
2394653d4876SAndy Whitcroft
23957e51f197SJoe Perches	my %signatures = ();
2396323c1260SJoe Perches
2397c2fdda0dSAndy Whitcroft	# Pre-scan the patch sanitizing the lines.
2398de7d4f0eSAndy Whitcroft	# Pre-scan the patch looking for any __setup documentation.
2399c2fdda0dSAndy Whitcroft	#
2400de7d4f0eSAndy Whitcroft	my @setup_docs = ();
2401de7d4f0eSAndy Whitcroft	my $setup_docs = 0;
2402773647a0SAndy Whitcroft
2403d8b07710SJoe Perches	my $camelcase_file_seeded = 0;
2404d8b07710SJoe Perches
24059f3a8992SRob Herring	my $checklicenseline = 1;
24069f3a8992SRob Herring
2407773647a0SAndy Whitcroft	sanitise_line_reset();
2408c2fdda0dSAndy Whitcroft	my $line;
2409c2fdda0dSAndy Whitcroft	foreach my $rawline (@rawlines) {
2410773647a0SAndy Whitcroft		$linenr++;
2411773647a0SAndy Whitcroft		$line = $rawline;
2412c2fdda0dSAndy Whitcroft
24133705ce5bSJoe Perches		push(@fixed, $rawline) if ($fix);
24143705ce5bSJoe Perches
2415773647a0SAndy Whitcroft		if ($rawline=~/^\+\+\+\s+(\S+)/) {
2416de7d4f0eSAndy Whitcroft			$setup_docs = 0;
24172581ac7cSTim Froidcoeur			if ($1 =~ m@Documentation/admin-guide/kernel-parameters.txt$@) {
2418de7d4f0eSAndy Whitcroft				$setup_docs = 1;
2419de7d4f0eSAndy Whitcroft			}
2420773647a0SAndy Whitcroft			#next;
2421de7d4f0eSAndy Whitcroft		}
242274fd4f34SJoe Perches		if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2423773647a0SAndy Whitcroft			$realline=$1-1;
2424773647a0SAndy Whitcroft			if (defined $2) {
2425773647a0SAndy Whitcroft				$realcnt=$3+1;
2426773647a0SAndy Whitcroft			} else {
2427773647a0SAndy Whitcroft				$realcnt=1+1;
2428773647a0SAndy Whitcroft			}
2429c45dcabdSAndy Whitcroft			$in_comment = 0;
2430773647a0SAndy Whitcroft
2431773647a0SAndy Whitcroft			# Guestimate if this is a continuing comment.  Run
2432773647a0SAndy Whitcroft			# the context looking for a comment "edge".  If this
2433773647a0SAndy Whitcroft			# edge is a close comment then we must be in a comment
2434773647a0SAndy Whitcroft			# at context start.
2435773647a0SAndy Whitcroft			my $edge;
243601fa9147SAndy Whitcroft			my $cnt = $realcnt;
243701fa9147SAndy Whitcroft			for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
243801fa9147SAndy Whitcroft				next if (defined $rawlines[$ln - 1] &&
243901fa9147SAndy Whitcroft					 $rawlines[$ln - 1] =~ /^-/);
244001fa9147SAndy Whitcroft				$cnt--;
244101fa9147SAndy Whitcroft				#print "RAW<$rawlines[$ln - 1]>\n";
2442721c1cb6SAndy Whitcroft				last if (!defined $rawlines[$ln - 1]);
2443fae17daeSAndy Whitcroft				if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2444fae17daeSAndy Whitcroft				    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2445fae17daeSAndy Whitcroft					($edge) = $1;
2446fae17daeSAndy Whitcroft					last;
2447fae17daeSAndy Whitcroft				}
2448773647a0SAndy Whitcroft			}
2449773647a0SAndy Whitcroft			if (defined $edge && $edge eq '*/') {
2450773647a0SAndy Whitcroft				$in_comment = 1;
2451773647a0SAndy Whitcroft			}
2452773647a0SAndy Whitcroft
2453773647a0SAndy Whitcroft			# Guestimate if this is a continuing comment.  If this
2454773647a0SAndy Whitcroft			# is the start of a diff block and this line starts
2455773647a0SAndy Whitcroft			# ' *' then it is very likely a comment.
2456773647a0SAndy Whitcroft			if (!defined $edge &&
245783242e0cSAndy Whitcroft			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
2458773647a0SAndy Whitcroft			{
2459773647a0SAndy Whitcroft				$in_comment = 1;
2460773647a0SAndy Whitcroft			}
2461773647a0SAndy Whitcroft
2462773647a0SAndy Whitcroft			##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2463773647a0SAndy Whitcroft			sanitise_line_reset($in_comment);
2464773647a0SAndy Whitcroft
2465171ae1a4SAndy Whitcroft		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2466773647a0SAndy Whitcroft			# Standardise the strings and chars within the input to
2467171ae1a4SAndy Whitcroft			# simplify matching -- only bother with positive lines.
2468773647a0SAndy Whitcroft			$line = sanitise_line($rawline);
2469773647a0SAndy Whitcroft		}
2470773647a0SAndy Whitcroft		push(@lines, $line);
2471773647a0SAndy Whitcroft
2472773647a0SAndy Whitcroft		if ($realcnt > 1) {
2473773647a0SAndy Whitcroft			$realcnt-- if ($line =~ /^(?:\+| |$)/);
2474773647a0SAndy Whitcroft		} else {
2475773647a0SAndy Whitcroft			$realcnt = 0;
2476773647a0SAndy Whitcroft		}
2477773647a0SAndy Whitcroft
2478773647a0SAndy Whitcroft		#print "==>$rawline\n";
2479773647a0SAndy Whitcroft		#print "-->$line\n";
2480de7d4f0eSAndy Whitcroft
2481de7d4f0eSAndy Whitcroft		if ($setup_docs && $line =~ /^\+/) {
2482de7d4f0eSAndy Whitcroft			push(@setup_docs, $line);
2483de7d4f0eSAndy Whitcroft		}
2484de7d4f0eSAndy Whitcroft	}
2485de7d4f0eSAndy Whitcroft
24866c72ffaaSAndy Whitcroft	$prefix = '';
24876c72ffaaSAndy Whitcroft
2488773647a0SAndy Whitcroft	$realcnt = 0;
2489773647a0SAndy Whitcroft	$linenr = 0;
2490194f66fcSJoe Perches	$fixlinenr = -1;
24910a920b5bSAndy Whitcroft	foreach my $line (@lines) {
24920a920b5bSAndy Whitcroft		$linenr++;
2493194f66fcSJoe Perches		$fixlinenr++;
24941b5539b1SJoe Perches		my $sline = $line;	#copy of $line
24951b5539b1SJoe Perches		$sline =~ s/$;/ /g;	#with comments as spaces
24960a920b5bSAndy Whitcroft
2497c2fdda0dSAndy Whitcroft		my $rawline = $rawlines[$linenr - 1];
2498f36d3eb8SJoe Perches		my $raw_comment = get_raw_comment($line, $rawline);
24996c72ffaaSAndy Whitcroft
250012c253abSJoe Perches# check if it's a mode change, rename or start of a patch
250112c253abSJoe Perches		if (!$in_commit_log &&
250212c253abSJoe Perches		    ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ ||
250312c253abSJoe Perches		    ($line =~ /^rename (?:from|to) \S+\s*$/ ||
250412c253abSJoe Perches		     $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) {
250512c253abSJoe Perches			$is_patch = 1;
250612c253abSJoe Perches		}
250712c253abSJoe Perches
25080a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied
2509e518e9a5SJoe Perches		if (!$in_commit_log &&
251074fd4f34SJoe Perches		    $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
251174fd4f34SJoe Perches			my $context = $4;
25120a920b5bSAndy Whitcroft			$is_patch = 1;
25134a0df2efSAndy Whitcroft			$first_line = $linenr + 1;
25140a920b5bSAndy Whitcroft			$realline=$1-1;
25150a920b5bSAndy Whitcroft			if (defined $2) {
25160a920b5bSAndy Whitcroft				$realcnt=$3+1;
25170a920b5bSAndy Whitcroft			} else {
25180a920b5bSAndy Whitcroft				$realcnt=1+1;
25190a920b5bSAndy Whitcroft			}
2520c2fdda0dSAndy Whitcroft			annotate_reset();
252113214adfSAndy Whitcroft			$prev_values = 'E';
252213214adfSAndy Whitcroft
2523773647a0SAndy Whitcroft			%suppress_ifbraces = ();
2524170d3a22SAndy Whitcroft			%suppress_whiletrailers = ();
25252b474a1aSAndy Whitcroft			%suppress_export = ();
25263e469cdcSAndy Whitcroft			$suppress_statement = 0;
252774fd4f34SJoe Perches			if ($context =~ /\b(\w+)\s*\(/) {
252874fd4f34SJoe Perches				$context_function = $1;
252974fd4f34SJoe Perches			} else {
253074fd4f34SJoe Perches				undef $context_function;
253174fd4f34SJoe Perches			}
25320a920b5bSAndy Whitcroft			next;
25330a920b5bSAndy Whitcroft
25344a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that
25354a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely
25364a0df2efSAndy Whitcroft# blank context lines so we need to count that too.
2537773647a0SAndy Whitcroft		} elsif ($line =~ /^( |\+|$)/) {
25380a920b5bSAndy Whitcroft			$realline++;
2539d8aaf121SAndy Whitcroft			$realcnt-- if ($realcnt != 0);
25400a920b5bSAndy Whitcroft
25414a0df2efSAndy Whitcroft			# Measure the line length and indent.
2542c2fdda0dSAndy Whitcroft			($length, $indent) = line_stats($rawline);
25430a920b5bSAndy Whitcroft
25440a920b5bSAndy Whitcroft			# Track the previous line.
25450a920b5bSAndy Whitcroft			($prevline, $stashline) = ($stashline, $line);
25460a920b5bSAndy Whitcroft			($previndent, $stashindent) = ($stashindent, $indent);
2547c2fdda0dSAndy Whitcroft			($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2548c2fdda0dSAndy Whitcroft
2549773647a0SAndy Whitcroft			#warn "line<$line>\n";
25506c72ffaaSAndy Whitcroft
2551d8aaf121SAndy Whitcroft		} elsif ($realcnt == 1) {
2552d8aaf121SAndy Whitcroft			$realcnt--;
25530a920b5bSAndy Whitcroft		}
25540a920b5bSAndy Whitcroft
2555cc77cdcaSAndy Whitcroft		my $hunk_line = ($realcnt != 0);
2556cc77cdcaSAndy Whitcroft
25576c72ffaaSAndy Whitcroft		$here = "#$linenr: " if (!$file);
25586c72ffaaSAndy Whitcroft		$here = "#$realline: " if ($file);
2559773647a0SAndy Whitcroft
25602ac73b4fSJoe Perches		my $found_file = 0;
2561773647a0SAndy Whitcroft		# extract the filename as it passes
25623bf9a009SRabin Vincent		if ($line =~ /^diff --git.*?(\S+)$/) {
25633bf9a009SRabin Vincent			$realfile = $1;
25642b7ab453SJoe Perches			$realfile =~ s@^([^/]*)/@@ if (!$file);
2565270c49a0SJoe Perches			$in_commit_log = 0;
25662ac73b4fSJoe Perches			$found_file = 1;
25673bf9a009SRabin Vincent		} elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2568773647a0SAndy Whitcroft			$realfile = $1;
25692b7ab453SJoe Perches			$realfile =~ s@^([^/]*)/@@ if (!$file);
2570270c49a0SJoe Perches			$in_commit_log = 0;
25711e855726SWolfram Sang
25721e855726SWolfram Sang			$p1_prefix = $1;
2573e2f7aa4bSAndy Whitcroft			if (!$file && $tree && $p1_prefix ne '' &&
2574e2f7aa4bSAndy Whitcroft			    -e "$root/$p1_prefix") {
2575000d1cc1SJoe Perches				WARN("PATCH_PREFIX",
2576000d1cc1SJoe Perches				     "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
25771e855726SWolfram Sang			}
2578773647a0SAndy Whitcroft
2579c1ab3326SAndy Whitcroft			if ($realfile =~ m@^include/asm/@) {
2580000d1cc1SJoe Perches				ERROR("MODIFIED_INCLUDE_ASM",
2581000d1cc1SJoe Perches				      "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2582773647a0SAndy Whitcroft			}
25832ac73b4fSJoe Perches			$found_file = 1;
25842ac73b4fSJoe Perches		}
25852ac73b4fSJoe Perches
258634d8815fSJoe Perches#make up the handle for any error we report on this line
258734d8815fSJoe Perches		if ($showfile) {
258834d8815fSJoe Perches			$prefix = "$realfile:$realline: "
258934d8815fSJoe Perches		} elsif ($emacs) {
25907d3a9f67SJoe Perches			if ($file) {
25917d3a9f67SJoe Perches				$prefix = "$filename:$realline: ";
25927d3a9f67SJoe Perches			} else {
259334d8815fSJoe Perches				$prefix = "$filename:$linenr: ";
259434d8815fSJoe Perches			}
25957d3a9f67SJoe Perches		}
259634d8815fSJoe Perches
25972ac73b4fSJoe Perches		if ($found_file) {
259885b0ee18SJoe Perches			if (is_maintained_obsolete($realfile)) {
259985b0ee18SJoe Perches				WARN("OBSOLETE",
260085b0ee18SJoe Perches				     "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy.  No unnecessary modifications please.\n");
260185b0ee18SJoe Perches			}
26027bd7e483SJoe Perches			if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
26032ac73b4fSJoe Perches				$check = 1;
26042ac73b4fSJoe Perches			} else {
26052ac73b4fSJoe Perches				$check = $check_orig;
26062ac73b4fSJoe Perches			}
26079f3a8992SRob Herring			$checklicenseline = 1;
2608133712a2SRob Herring
2609133712a2SRob Herring			if ($realfile !~ /^MAINTAINERS/) {
2610133712a2SRob Herring				my $last_binding_patch = $is_binding_patch;
2611133712a2SRob Herring
2612133712a2SRob Herring				$is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@;
2613133712a2SRob Herring
2614133712a2SRob Herring				if (($last_binding_patch != -1) &&
2615133712a2SRob Herring				    ($last_binding_patch ^ $is_binding_patch)) {
2616133712a2SRob Herring					WARN("DT_SPLIT_BINDING_PATCH",
2617858e6845SMauro Carvalho Chehab					     "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n");
2618133712a2SRob Herring				}
2619133712a2SRob Herring			}
2620133712a2SRob Herring
2621773647a0SAndy Whitcroft			next;
2622773647a0SAndy Whitcroft		}
2623773647a0SAndy Whitcroft
2624389834b6SRandy Dunlap		$here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
26250a920b5bSAndy Whitcroft
2626c2fdda0dSAndy Whitcroft		my $hereline = "$here\n$rawline\n";
2627c2fdda0dSAndy Whitcroft		my $herecurr = "$here\n$rawline\n";
2628c2fdda0dSAndy Whitcroft		my $hereprev = "$here\n$prevrawline\n$rawline\n";
26290a920b5bSAndy Whitcroft
26306c72ffaaSAndy Whitcroft		$cnt_lines++ if ($realcnt != 0);
26316c72ffaaSAndy Whitcroft
2632490b292cSJoe Perches# Verify the existence of a commit log if appropriate
2633490b292cSJoe Perches# 2 is used because a $signature is counted in $commit_log_lines
2634490b292cSJoe Perches		if ($in_commit_log) {
2635490b292cSJoe Perches			if ($line !~ /^\s*$/) {
2636490b292cSJoe Perches				$commit_log_lines++;	#could be a $signature
2637490b292cSJoe Perches			}
2638490b292cSJoe Perches		} elsif ($has_commit_log && $commit_log_lines < 2) {
2639490b292cSJoe Perches			WARN("COMMIT_MESSAGE",
2640490b292cSJoe Perches			     "Missing commit description - Add an appropriate one\n");
2641490b292cSJoe Perches			$commit_log_lines = 2;	#warn only once
2642490b292cSJoe Perches		}
2643490b292cSJoe Perches
2644e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch
2645e518e9a5SJoe Perches		if ($in_commit_log && !$commit_log_has_diff &&
264613e45417SMrinal Pandey		    (($line =~ m@^\s+diff\b.*a/([\w/]+)@ &&
264713e45417SMrinal Pandey		      $line =~ m@^\s+diff\b.*a/[\w/]+\s+b/$1\b@) ||
2648e518e9a5SJoe Perches		     $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2649e518e9a5SJoe Perches		     $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2650e518e9a5SJoe Perches			ERROR("DIFF_IN_COMMIT_MSG",
2651e518e9a5SJoe Perches			      "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2652e518e9a5SJoe Perches			$commit_log_has_diff = 1;
2653e518e9a5SJoe Perches		}
2654e518e9a5SJoe Perches
26553bf9a009SRabin Vincent# Check for incorrect file permissions
26563bf9a009SRabin Vincent		if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
26573bf9a009SRabin Vincent			my $permhere = $here . "FILE: $realfile\n";
265804db4d25SJoe Perches			if ($realfile !~ m@scripts/@ &&
265904db4d25SJoe Perches			    $realfile !~ /\.(py|pl|awk|sh)$/) {
2660000d1cc1SJoe Perches				ERROR("EXECUTE_PERMISSIONS",
2661000d1cc1SJoe Perches				      "do not set execute permissions for source files\n" . $permhere);
26623bf9a009SRabin Vincent			}
26633bf9a009SRabin Vincent		}
26643bf9a009SRabin Vincent
2665cd261496SGeert Uytterhoeven# Check the patch for a From:
2666cd261496SGeert Uytterhoeven		if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) {
2667cd261496SGeert Uytterhoeven			$author = $1;
2668cd261496SGeert Uytterhoeven			$author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i);
2669cd261496SGeert Uytterhoeven			$author =~ s/"//g;
2670dfa05c28SJoe Perches			$author = reformat_email($author);
2671cd261496SGeert Uytterhoeven		}
2672cd261496SGeert Uytterhoeven
267320112475SJoe Perches# Check the patch for a signoff:
2674dfa05c28SJoe Perches		if ($line =~ /^\s*signed-off-by:\s*(.*)/i) {
26754a0df2efSAndy Whitcroft			$signoff++;
267615662b3eSJoe Perches			$in_commit_log = 0;
2677cd261496SGeert Uytterhoeven			if ($author ne '') {
2678dfa05c28SJoe Perches				if (same_email_addresses($1, $author)) {
2679cd261496SGeert Uytterhoeven					$authorsignoff = 1;
2680cd261496SGeert Uytterhoeven				}
2681cd261496SGeert Uytterhoeven			}
26820a920b5bSAndy Whitcroft		}
268320112475SJoe Perches
268444d303ebSJoe Perches# Check for patch separator
268544d303ebSJoe Perches		if ($line =~ /^---$/) {
268644d303ebSJoe Perches			$has_patch_separator = 1;
268744d303ebSJoe Perches			$in_commit_log = 0;
268844d303ebSJoe Perches		}
268944d303ebSJoe Perches
2690e0d975b1SJoe Perches# Check if MAINTAINERS is being updated.  If so, there's probably no need to
2691e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2692e0d975b1SJoe Perches		if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2693e0d975b1SJoe Perches			$reported_maintainer_file = 1;
2694e0d975b1SJoe Perches		}
2695e0d975b1SJoe Perches
269620112475SJoe Perches# Check signature styles
2697270c49a0SJoe Perches		if (!$in_header_lines &&
2698ce0338dfSJoe Perches		    $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
269920112475SJoe Perches			my $space_before = $1;
270020112475SJoe Perches			my $sign_off = $2;
270120112475SJoe Perches			my $space_after = $3;
270220112475SJoe Perches			my $email = $4;
270320112475SJoe Perches			my $ucfirst_sign_off = ucfirst(lc($sign_off));
270420112475SJoe Perches
2705ce0338dfSJoe Perches			if ($sign_off !~ /$signature_tags/) {
2706ce0338dfSJoe Perches				WARN("BAD_SIGN_OFF",
2707ce0338dfSJoe Perches				     "Non-standard signature: $sign_off\n" . $herecurr);
2708ce0338dfSJoe Perches			}
270920112475SJoe Perches			if (defined $space_before && $space_before ne "") {
27103705ce5bSJoe Perches				if (WARN("BAD_SIGN_OFF",
27113705ce5bSJoe Perches					 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
27123705ce5bSJoe Perches				    $fix) {
2713194f66fcSJoe Perches					$fixed[$fixlinenr] =
27143705ce5bSJoe Perches					    "$ucfirst_sign_off $email";
27153705ce5bSJoe Perches				}
271620112475SJoe Perches			}
271720112475SJoe Perches			if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
27183705ce5bSJoe Perches				if (WARN("BAD_SIGN_OFF",
27193705ce5bSJoe Perches					 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
27203705ce5bSJoe Perches				    $fix) {
2721194f66fcSJoe Perches					$fixed[$fixlinenr] =
27223705ce5bSJoe Perches					    "$ucfirst_sign_off $email";
27233705ce5bSJoe Perches				}
27243705ce5bSJoe Perches
272520112475SJoe Perches			}
272620112475SJoe Perches			if (!defined $space_after || $space_after ne " ") {
27273705ce5bSJoe Perches				if (WARN("BAD_SIGN_OFF",
27283705ce5bSJoe Perches					 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
27293705ce5bSJoe Perches				    $fix) {
2730194f66fcSJoe Perches					$fixed[$fixlinenr] =
27313705ce5bSJoe Perches					    "$ucfirst_sign_off $email";
27323705ce5bSJoe Perches				}
273320112475SJoe Perches			}
273420112475SJoe Perches
2735dfa05c28SJoe Perches			my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
273620112475SJoe Perches			my $suggested_email = format_email(($email_name, $email_address));
273720112475SJoe Perches			if ($suggested_email eq "") {
2738000d1cc1SJoe Perches				ERROR("BAD_SIGN_OFF",
2739000d1cc1SJoe Perches				      "Unrecognized email address: '$email'\n" . $herecurr);
274020112475SJoe Perches			} else {
274120112475SJoe Perches				my $dequoted = $suggested_email;
274220112475SJoe Perches				$dequoted =~ s/^"//;
274320112475SJoe Perches				$dequoted =~ s/" </ </;
274420112475SJoe Perches				# Don't force email to have quotes
274520112475SJoe Perches				# Allow just an angle bracketed address
2746dfa05c28SJoe Perches				if (!same_email_addresses($email, $suggested_email)) {
2747000d1cc1SJoe Perches					WARN("BAD_SIGN_OFF",
2748000d1cc1SJoe Perches					     "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
274920112475SJoe Perches				}
27500a920b5bSAndy Whitcroft			}
27517e51f197SJoe Perches
27527e51f197SJoe Perches# Check for duplicate signatures
27537e51f197SJoe Perches			my $sig_nospace = $line;
27547e51f197SJoe Perches			$sig_nospace =~ s/\s//g;
27557e51f197SJoe Perches			$sig_nospace = lc($sig_nospace);
27567e51f197SJoe Perches			if (defined $signatures{$sig_nospace}) {
27577e51f197SJoe Perches				WARN("BAD_SIGN_OFF",
27587e51f197SJoe Perches				     "Duplicate signature\n" . $herecurr);
27597e51f197SJoe Perches			} else {
27607e51f197SJoe Perches				$signatures{$sig_nospace} = 1;
27617e51f197SJoe Perches			}
27626c5d24eeSSean Christopherson
27636c5d24eeSSean Christopherson# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
27646c5d24eeSSean Christopherson			if ($sign_off =~ /^co-developed-by:$/i) {
27656c5d24eeSSean Christopherson				if ($email eq $author) {
27666c5d24eeSSean Christopherson					WARN("BAD_SIGN_OFF",
27676c5d24eeSSean Christopherson					      "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
27686c5d24eeSSean Christopherson				}
27696c5d24eeSSean Christopherson				if (!defined $lines[$linenr]) {
27706c5d24eeSSean Christopherson					WARN("BAD_SIGN_OFF",
27716c5d24eeSSean Christopherson                                             "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline);
27726c5d24eeSSean Christopherson				} elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) {
27736c5d24eeSSean Christopherson					WARN("BAD_SIGN_OFF",
27746c5d24eeSSean Christopherson					     "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
27756c5d24eeSSean Christopherson				} elsif ($1 ne $email) {
27766c5d24eeSSean Christopherson					WARN("BAD_SIGN_OFF",
27776c5d24eeSSean Christopherson					     "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
27786c5d24eeSSean Christopherson				}
27796c5d24eeSSean Christopherson			}
27800a920b5bSAndy Whitcroft		}
27810a920b5bSAndy Whitcroft
2782a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned
2783a2fe16b9SJoe Perches		if ($in_header_lines &&
2784a2fe16b9SJoe Perches		    $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2785a2fe16b9SJoe Perches			WARN("EMAIL_SUBJECT",
2786a2fe16b9SJoe Perches			     "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2787a2fe16b9SJoe Perches		}
2788a2fe16b9SJoe Perches
278944d303ebSJoe Perches# Check for Gerrit Change-Ids not in any patch context
279044d303ebSJoe Perches		if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) {
27917ebd05efSChristopher Covington			ERROR("GERRIT_CHANGE_ID",
279244d303ebSJoe Perches			      "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr);
27937ebd05efSChristopher Covington		}
27947ebd05efSChristopher Covington
2795369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump
2796369c8dd3SJoe Perches		if ($in_commit_log && !$commit_log_possible_stack_dump &&
2797369c8dd3SJoe Perches		    ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2798369c8dd3SJoe Perches		     $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2799369c8dd3SJoe Perches					# timestamp
2800634cffccSJoe Perches		     $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) ||
2801634cffccSJoe Perches		     $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ ||
2802634cffccSJoe Perches		     $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) {
2803634cffccSJoe Perches					# stack dump address styles
2804369c8dd3SJoe Perches			$commit_log_possible_stack_dump = 1;
2805369c8dd3SJoe Perches		}
2806369c8dd3SJoe Perches
28072a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once
28082a076f40SJoe Perches		if ($in_commit_log && !$commit_log_long_line &&
2809bf4daf12SJoe Perches		    length($line) > 75 &&
2810bf4daf12SJoe Perches		    !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2811bf4daf12SJoe Perches					# file delta changes
2812bf4daf12SJoe Perches		      $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2813bf4daf12SJoe Perches					# filename then :
2814bf4daf12SJoe Perches		      $line =~ /^\s*(?:Fixes:|Link:)/i ||
2815bf4daf12SJoe Perches					# A Fixes: or Link: line
2816bf4daf12SJoe Perches		      $commit_log_possible_stack_dump)) {
28172a076f40SJoe Perches			WARN("COMMIT_LOG_LONG_LINE",
28182a076f40SJoe Perches			     "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
28192a076f40SJoe Perches			$commit_log_long_line = 1;
28202a076f40SJoe Perches		}
28212a076f40SJoe Perches
2822bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found
2823bf4daf12SJoe Perches		if ($in_commit_log && $commit_log_possible_stack_dump &&
2824bf4daf12SJoe Perches		    $line =~ /^\s*$/) {
2825bf4daf12SJoe Perches			$commit_log_possible_stack_dump = 0;
2826bf4daf12SJoe Perches		}
2827bf4daf12SJoe Perches
28280d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions
2829369c8dd3SJoe Perches		if ($in_commit_log && !$commit_log_possible_stack_dump &&
2830a8972573SJohn Hubbard		    $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i &&
2831e882dbfcSWei Wang		    $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
2832fe043ea1SJoe Perches		    ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
2833aab38f51SJoe Perches		     ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
2834369c8dd3SJoe Perches		      $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2835bf4daf12SJoe Perches		      $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
2836fe043ea1SJoe Perches			my $init_char = "c";
2837fe043ea1SJoe Perches			my $orig_commit = "";
28380d7835fcSJoe Perches			my $short = 1;
28390d7835fcSJoe Perches			my $long = 0;
28400d7835fcSJoe Perches			my $case = 1;
28410d7835fcSJoe Perches			my $space = 1;
28420d7835fcSJoe Perches			my $hasdesc = 0;
284319c146a6SJoe Perches			my $hasparens = 0;
28440d7835fcSJoe Perches			my $id = '0123456789ab';
28450d7835fcSJoe Perches			my $orig_desc = "commit description";
28460d7835fcSJoe Perches			my $description = "";
28470d7835fcSJoe Perches
2848fe043ea1SJoe Perches			if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2849fe043ea1SJoe Perches				$init_char = $1;
2850fe043ea1SJoe Perches				$orig_commit = lc($2);
2851fe043ea1SJoe Perches			} elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2852fe043ea1SJoe Perches				$orig_commit = lc($1);
2853fe043ea1SJoe Perches			}
2854fe043ea1SJoe Perches
28550d7835fcSJoe Perches			$short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
28560d7835fcSJoe Perches			$long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
28570d7835fcSJoe Perches			$space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
28580d7835fcSJoe Perches			$case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
28590d7835fcSJoe Perches			if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
28600d7835fcSJoe Perches				$orig_desc = $1;
286119c146a6SJoe Perches				$hasparens = 1;
28620d7835fcSJoe Perches			} elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
28630d7835fcSJoe Perches				 defined $rawlines[$linenr] &&
28640d7835fcSJoe Perches				 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
28650d7835fcSJoe Perches				$orig_desc = $1;
286619c146a6SJoe Perches				$hasparens = 1;
2867b671fde0SJoe Perches			} elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2868b671fde0SJoe Perches				 defined $rawlines[$linenr] &&
2869b671fde0SJoe Perches				 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2870b671fde0SJoe Perches				$line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2871b671fde0SJoe Perches				$orig_desc = $1;
2872b671fde0SJoe Perches				$rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2873b671fde0SJoe Perches				$orig_desc .= " " . $1;
287419c146a6SJoe Perches				$hasparens = 1;
28750d7835fcSJoe Perches			}
28760d7835fcSJoe Perches
28770d7835fcSJoe Perches			($id, $description) = git_commit_info($orig_commit,
28780d7835fcSJoe Perches							      $id, $orig_desc);
28790d7835fcSJoe Perches
2880948b133aSHeinrich Schuchardt			if (defined($id) &&
2881948b133aSHeinrich Schuchardt			   ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
2882d311cd44SJoe Perches				ERROR("GIT_COMMIT_ID",
28830d7835fcSJoe Perches				      "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
28840d7835fcSJoe Perches			}
2885d311cd44SJoe Perches		}
2886d311cd44SJoe Perches
288713f1937eSJoe Perches# Check for added, moved or deleted files
288813f1937eSJoe Perches		if (!$reported_maintainer_file && !$in_commit_log &&
288913f1937eSJoe Perches		    ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
289013f1937eSJoe Perches		     $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
289113f1937eSJoe Perches		     ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
289213f1937eSJoe Perches		      (defined($1) || defined($2))))) {
2893a82603a8SAndrew Jeffery			$is_patch = 1;
289413f1937eSJoe Perches			$reported_maintainer_file = 1;
289513f1937eSJoe Perches			WARN("FILE_PATH_CHANGES",
289613f1937eSJoe Perches			     "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
289713f1937eSJoe Perches		}
289813f1937eSJoe Perches
2899e400edb1SRob Herring# Check for adding new DT bindings not in schema format
2900e400edb1SRob Herring		if (!$in_commit_log &&
2901e400edb1SRob Herring		    ($line =~ /^new file mode\s*\d+\s*$/) &&
2902e400edb1SRob Herring		    ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) {
2903e400edb1SRob Herring			WARN("DT_SCHEMA_BINDING_PATCH",
2904e400edb1SRob Herring			     "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n");
2905e400edb1SRob Herring		}
2906e400edb1SRob Herring
290700df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file
29088905a67cSAndy Whitcroft		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2909000d1cc1SJoe Perches			ERROR("CORRUPTED_PATCH",
2910000d1cc1SJoe Perches			      "patch seems to be corrupt (line wrapped?)\n" .
29116c72ffaaSAndy Whitcroft				$herecurr) if (!$emitted_corrupt++);
2912de7d4f0eSAndy Whitcroft		}
2913de7d4f0eSAndy Whitcroft
2914de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2915de7d4f0eSAndy Whitcroft		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2916171ae1a4SAndy Whitcroft		    $rawline !~ m/^$UTF8*$/) {
2917171ae1a4SAndy Whitcroft			my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2918171ae1a4SAndy Whitcroft
2919171ae1a4SAndy Whitcroft			my $blank = copy_spacing($rawline);
2920171ae1a4SAndy Whitcroft			my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2921171ae1a4SAndy Whitcroft			my $hereptr = "$hereline$ptr\n";
2922171ae1a4SAndy Whitcroft
292334d99219SJoe Perches			CHK("INVALID_UTF8",
2924000d1cc1SJoe Perches			    "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
292500df344fSAndy Whitcroft		}
29260a920b5bSAndy Whitcroft
292715662b3eSJoe Perches# Check if it's the start of a commit log
292815662b3eSJoe Perches# (not a header line and we haven't seen the patch filename)
292915662b3eSJoe Perches		if ($in_header_lines && $realfile =~ /^$/ &&
2930eb3a58deSJoe Perches		    !($rawline =~ /^\s+(?:\S|$)/ ||
2931eb3a58deSJoe Perches		      $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
293215662b3eSJoe Perches			$in_header_lines = 0;
293315662b3eSJoe Perches			$in_commit_log = 1;
2934ed43c4e5SAllen Hubbe			$has_commit_log = 1;
293515662b3eSJoe Perches		}
293615662b3eSJoe Perches
2937fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly
2938fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing.
2939fa64205dSPasi Savanainen		if ($in_header_lines &&
2940fa64205dSPasi Savanainen		    $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2941fa64205dSPasi Savanainen		    $1 !~ /utf-8/i) {
2942fa64205dSPasi Savanainen			$non_utf8_charset = 1;
2943fa64205dSPasi Savanainen		}
2944fa64205dSPasi Savanainen
2945fa64205dSPasi Savanainen		if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
294615662b3eSJoe Perches		    $rawline =~ /$NON_ASCII_UTF8/) {
2947fa64205dSPasi Savanainen			WARN("UTF8_BEFORE_PATCH",
294815662b3eSJoe Perches			    "8-bit UTF-8 used in possible commit log\n" . $herecurr);
294915662b3eSJoe Perches		}
295015662b3eSJoe Perches
2951d6430f71SJoe Perches# Check for absolute kernel paths in commit message
2952d6430f71SJoe Perches		if ($tree && $in_commit_log) {
2953d6430f71SJoe Perches			while ($line =~ m{(?:^|\s)(/\S*)}g) {
2954d6430f71SJoe Perches				my $file = $1;
2955d6430f71SJoe Perches
2956d6430f71SJoe Perches				if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2957d6430f71SJoe Perches				    check_absolute_file($1, $herecurr)) {
2958d6430f71SJoe Perches					#
2959d6430f71SJoe Perches				} else {
2960d6430f71SJoe Perches					check_absolute_file($file, $herecurr);
2961d6430f71SJoe Perches				}
2962d6430f71SJoe Perches			}
2963d6430f71SJoe Perches		}
2964d6430f71SJoe Perches
296566b47b4aSKees Cook# Check for various typo / spelling mistakes
296666d7a382SJoe Perches		if (defined($misspellings) &&
296766d7a382SJoe Perches		    ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
2968ebfd7d62SJoe Perches			while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
296966b47b4aSKees Cook				my $typo = $1;
297066b47b4aSKees Cook				my $typo_fix = $spelling_fix{lc($typo)};
297166b47b4aSKees Cook				$typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
297266b47b4aSKees Cook				$typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
29730675a8fbSJean Delvare				my $msg_level = \&WARN;
29740675a8fbSJean Delvare				$msg_level = \&CHK if ($file);
29750675a8fbSJean Delvare				if (&{$msg_level}("TYPO_SPELLING",
297666b47b4aSKees Cook						  "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
297766b47b4aSKees Cook				    $fix) {
297866b47b4aSKees Cook					$fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
297966b47b4aSKees Cook				}
298066b47b4aSKees Cook			}
298166b47b4aSKees Cook		}
298266b47b4aSKees Cook
2983a8dd86bfSMatteo Croce# check for invalid commit id
2984a8dd86bfSMatteo Croce		if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) {
2985a8dd86bfSMatteo Croce			my $id;
2986a8dd86bfSMatteo Croce			my $description;
2987a8dd86bfSMatteo Croce			($id, $description) = git_commit_info($2, undef, undef);
2988a8dd86bfSMatteo Croce			if (!defined($id)) {
2989a8dd86bfSMatteo Croce				WARN("UNKNOWN_COMMIT_ID",
2990a8dd86bfSMatteo Croce				     "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr);
2991a8dd86bfSMatteo Croce			}
2992a8dd86bfSMatteo Croce		}
2993a8dd86bfSMatteo Croce
2994310cd06bSJoe Perches# check for repeated words separated by a single space
2995310cd06bSJoe Perches		if ($rawline =~ /^\+/ || $in_commit_log) {
2996310cd06bSJoe Perches			while ($rawline =~ /\b($word_pattern) (?=($word_pattern))/g) {
2997310cd06bSJoe Perches
2998310cd06bSJoe Perches				my $first = $1;
2999310cd06bSJoe Perches				my $second = $2;
3000310cd06bSJoe Perches
3001310cd06bSJoe Perches				if ($first =~ /(?:struct|union|enum)/) {
3002310cd06bSJoe Perches					pos($rawline) += length($first) + length($second) + 1;
3003310cd06bSJoe Perches					next;
3004310cd06bSJoe Perches				}
3005310cd06bSJoe Perches
3006310cd06bSJoe Perches				next if ($first ne $second);
3007310cd06bSJoe Perches				next if ($first eq 'long');
3008310cd06bSJoe Perches
3009310cd06bSJoe Perches				if (WARN("REPEATED_WORD",
3010310cd06bSJoe Perches					 "Possible repeated word: '$first'\n" . $herecurr) &&
3011310cd06bSJoe Perches				    $fix) {
3012310cd06bSJoe Perches					$fixed[$fixlinenr] =~ s/\b$first $second\b/$first/;
3013310cd06bSJoe Perches				}
3014310cd06bSJoe Perches			}
3015310cd06bSJoe Perches
3016310cd06bSJoe Perches			# if it's a repeated word on consecutive lines in a comment block
3017310cd06bSJoe Perches			if ($prevline =~ /$;+\s*$/ &&
3018310cd06bSJoe Perches			    $prevrawline =~ /($word_pattern)\s*$/) {
3019310cd06bSJoe Perches				my $last_word = $1;
3020310cd06bSJoe Perches				if ($rawline =~ /^\+\s*\*\s*$last_word /) {
3021310cd06bSJoe Perches					if (WARN("REPEATED_WORD",
3022310cd06bSJoe Perches						 "Possible repeated word: '$last_word'\n" . $hereprev) &&
3023310cd06bSJoe Perches					    $fix) {
3024310cd06bSJoe Perches						$fixed[$fixlinenr] =~ s/(\+\s*\*\s*)$last_word /$1/;
3025310cd06bSJoe Perches					}
3026310cd06bSJoe Perches				}
3027310cd06bSJoe Perches			}
3028310cd06bSJoe Perches		}
3029310cd06bSJoe Perches
303030670854SAndy Whitcroft# ignore non-hunk lines and lines being removed
303130670854SAndy Whitcroft		next if (!$hunk_line || $line =~ /^-/);
303200df344fSAndy Whitcroft
30330a920b5bSAndy Whitcroft#trailing whitespace
30349c0ca6f9SAndy Whitcroft		if ($line =~ /^\+.*\015/) {
3035c2fdda0dSAndy Whitcroft			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3036d5e616fcSJoe Perches			if (ERROR("DOS_LINE_ENDINGS",
3037d5e616fcSJoe Perches				  "DOS line endings\n" . $herevet) &&
3038d5e616fcSJoe Perches			    $fix) {
3039194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/[\s\015]+$//;
3040d5e616fcSJoe Perches			}
3041c2fdda0dSAndy Whitcroft		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
3042c2fdda0dSAndy Whitcroft			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
30433705ce5bSJoe Perches			if (ERROR("TRAILING_WHITESPACE",
30443705ce5bSJoe Perches				  "trailing whitespace\n" . $herevet) &&
30453705ce5bSJoe Perches			    $fix) {
3046194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/\s+$//;
30473705ce5bSJoe Perches			}
30483705ce5bSJoe Perches
3049d2c0a235SAndy Whitcroft			$rpt_cleaners = 1;
30500a920b5bSAndy Whitcroft		}
30515368df20SAndy Whitcroft
30524783f894SJosh Triplett# Check for FSF mailing addresses.
3053109d8cb2SAlexander Duyck		if ($rawline =~ /\bwrite to the Free/i ||
30541bde561eSMatthew Wilcox		    $rawline =~ /\b675\s+Mass\s+Ave/i ||
30553e2232f2SJoe Perches		    $rawline =~ /\b59\s+Temple\s+Pl/i ||
30563e2232f2SJoe Perches		    $rawline =~ /\b51\s+Franklin\s+St/i) {
30574783f894SJosh Triplett			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
30580675a8fbSJean Delvare			my $msg_level = \&ERROR;
30590675a8fbSJean Delvare			$msg_level = \&CHK if ($file);
30600675a8fbSJean Delvare			&{$msg_level}("FSF_MAILING_ADDRESS",
30614783f894SJosh Triplett				      "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)
30624783f894SJosh Triplett		}
30634783f894SJosh Triplett
30643354957aSAndi Kleen# check for Kconfig help text having a real description
30659fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have
30669fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough.
30673354957aSAndi Kleen		if ($realfile =~ /Kconfig/ &&
3068678ae162SUlf Magnusson		    # 'choice' is usually the last thing on the line (though
3069678ae162SUlf Magnusson		    # Kconfig supports named choices), so use a word boundary
3070678ae162SUlf Magnusson		    # (\b) rather than a whitespace character (\s)
3071678ae162SUlf Magnusson		    $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
30723354957aSAndi Kleen			my $length = 0;
30739fe287d7SAndy Whitcroft			my $cnt = $realcnt;
30749fe287d7SAndy Whitcroft			my $ln = $linenr + 1;
30759fe287d7SAndy Whitcroft			my $f;
3076a1385803SAndy Whitcroft			my $is_start = 0;
30779fe287d7SAndy Whitcroft			my $is_end = 0;
3078a1385803SAndy Whitcroft			for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
30799fe287d7SAndy Whitcroft				$f = $lines[$ln - 1];
30809fe287d7SAndy Whitcroft				$cnt-- if ($lines[$ln - 1] !~ /^-/);
30819fe287d7SAndy Whitcroft				$is_end = $lines[$ln - 1] =~ /^\+/;
30829fe287d7SAndy Whitcroft
30839fe287d7SAndy Whitcroft				next if ($f =~ /^-/);
30848d73e0e7SJoe Perches				last if (!$file && $f =~ /^\@\@/);
3085a1385803SAndy Whitcroft
308686adf1a0SUlf Magnusson				if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
3087a1385803SAndy Whitcroft					$is_start = 1;
308822a4ac02SMasahiro Yamada				} elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
3089a1385803SAndy Whitcroft					$length = -1;
3090a1385803SAndy Whitcroft				}
3091a1385803SAndy Whitcroft
30929fe287d7SAndy Whitcroft				$f =~ s/^.//;
30933354957aSAndi Kleen				$f =~ s/#.*//;
30943354957aSAndi Kleen				$f =~ s/^\s+//;
30953354957aSAndi Kleen				next if ($f =~ /^$/);
3096678ae162SUlf Magnusson
3097678ae162SUlf Magnusson				# This only checks context lines in the patch
3098678ae162SUlf Magnusson				# and so hopefully shouldn't trigger false
3099678ae162SUlf Magnusson				# positives, even though some of these are
3100678ae162SUlf Magnusson				# common words in help texts
3101678ae162SUlf Magnusson				if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
3102678ae162SUlf Magnusson						  if|endif|menu|endmenu|source)\b/x) {
31039fe287d7SAndy Whitcroft					$is_end = 1;
31049fe287d7SAndy Whitcroft					last;
31059fe287d7SAndy Whitcroft				}
31063354957aSAndi Kleen				$length++;
31073354957aSAndi Kleen			}
310856193274SVadim Bendebury			if ($is_start && $is_end && $length < $min_conf_desc_length) {
3109000d1cc1SJoe Perches				WARN("CONFIG_DESCRIPTION",
311056193274SVadim Bendebury				     "please write a paragraph that describes the config symbol fully\n" . $herecurr);
311156193274SVadim Bendebury			}
3112a1385803SAndy Whitcroft			#print "is_start<$is_start> is_end<$is_end> length<$length>\n";
31133354957aSAndi Kleen		}
31143354957aSAndi Kleen
31157ccf41a8SJoe Perches# check MAINTAINERS entries
31167ccf41a8SJoe Perches		if ($realfile =~ /^MAINTAINERS$/) {
31177ccf41a8SJoe Perches# check MAINTAINERS entries for the right form
31187ccf41a8SJoe Perches			if ($rawline =~ /^\+[A-Z]:/ &&
3119628f91a2SJoe Perches			    $rawline !~ /^\+[A-Z]:\t\S/) {
3120628f91a2SJoe Perches				if (WARN("MAINTAINERS_STYLE",
3121628f91a2SJoe Perches					 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
3122628f91a2SJoe Perches				    $fix) {
3123628f91a2SJoe Perches					$fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
3124628f91a2SJoe Perches				}
3125628f91a2SJoe Perches			}
31267ccf41a8SJoe Perches# check MAINTAINERS entries for the right ordering too
31277ccf41a8SJoe Perches			my $preferred_order = 'MRLSWQBCPTFXNK';
31287ccf41a8SJoe Perches			if ($rawline =~ /^\+[A-Z]:/ &&
31297ccf41a8SJoe Perches			    $prevrawline =~ /^[\+ ][A-Z]:/) {
31307ccf41a8SJoe Perches				$rawline =~ /^\+([A-Z]):\s*(.*)/;
31317ccf41a8SJoe Perches				my $cur = $1;
31327ccf41a8SJoe Perches				my $curval = $2;
31337ccf41a8SJoe Perches				$prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/;
31347ccf41a8SJoe Perches				my $prev = $1;
31357ccf41a8SJoe Perches				my $prevval = $2;
31367ccf41a8SJoe Perches				my $curindex = index($preferred_order, $cur);
31377ccf41a8SJoe Perches				my $previndex = index($preferred_order, $prev);
31387ccf41a8SJoe Perches				if ($curindex < 0) {
31397ccf41a8SJoe Perches					WARN("MAINTAINERS_STYLE",
31407ccf41a8SJoe Perches					     "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr);
31417ccf41a8SJoe Perches				} else {
31427ccf41a8SJoe Perches					if ($previndex >= 0 && $curindex < $previndex) {
31437ccf41a8SJoe Perches						WARN("MAINTAINERS_STYLE",
31447ccf41a8SJoe Perches						     "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev);
31457ccf41a8SJoe Perches					} elsif ((($prev eq 'F' && $cur eq 'F') ||
31467ccf41a8SJoe Perches						  ($prev eq 'X' && $cur eq 'X')) &&
31477ccf41a8SJoe Perches						 ($prevval cmp $curval) > 0) {
31487ccf41a8SJoe Perches						WARN("MAINTAINERS_STYLE",
31497ccf41a8SJoe Perches						     "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev);
31507ccf41a8SJoe Perches					}
31517ccf41a8SJoe Perches				}
31527ccf41a8SJoe Perches			}
31537ccf41a8SJoe Perches		}
3154628f91a2SJoe Perches
3155327953e9SChristoph Jaeger# discourage the use of boolean for type definition attributes of Kconfig options
3156327953e9SChristoph Jaeger		if ($realfile =~ /Kconfig/ &&
3157327953e9SChristoph Jaeger		    $line =~ /^\+\s*\bboolean\b/) {
3158327953e9SChristoph Jaeger			WARN("CONFIG_TYPE_BOOLEAN",
3159327953e9SChristoph Jaeger			     "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
3160327953e9SChristoph Jaeger		}
3161327953e9SChristoph Jaeger
3162c68e5878SArnaud Lacombe		if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
3163c68e5878SArnaud Lacombe		    ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
3164c68e5878SArnaud Lacombe			my $flag = $1;
3165c68e5878SArnaud Lacombe			my $replacement = {
3166c68e5878SArnaud Lacombe				'EXTRA_AFLAGS' =>   'asflags-y',
3167c68e5878SArnaud Lacombe				'EXTRA_CFLAGS' =>   'ccflags-y',
3168c68e5878SArnaud Lacombe				'EXTRA_CPPFLAGS' => 'cppflags-y',
3169c68e5878SArnaud Lacombe				'EXTRA_LDFLAGS' =>  'ldflags-y',
3170c68e5878SArnaud Lacombe			};
3171c68e5878SArnaud Lacombe
3172c68e5878SArnaud Lacombe			WARN("DEPRECATED_VARIABLE",
3173c68e5878SArnaud Lacombe			     "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3174c68e5878SArnaud Lacombe		}
3175c68e5878SArnaud Lacombe
3176bff5da43SRob Herring# check for DT compatible documentation
31777dd05b38SFlorian Vaussard		if (defined $root &&
31787dd05b38SFlorian Vaussard			(($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
31797dd05b38SFlorian Vaussard			 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
31807dd05b38SFlorian Vaussard
3181bff5da43SRob Herring			my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
3182bff5da43SRob Herring
3183cc93319bSFlorian Vaussard			my $dt_path = $root . "/Documentation/devicetree/bindings/";
3184852d095dSRob Herring			my $vp_file = $dt_path . "vendor-prefixes.yaml";
3185cc93319bSFlorian Vaussard
3186bff5da43SRob Herring			foreach my $compat (@compats) {
3187bff5da43SRob Herring				my $compat2 = $compat;
3188185d566bSRob Herring				$compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
3189185d566bSRob Herring				my $compat3 = $compat;
3190185d566bSRob Herring				$compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
3191185d566bSRob Herring				`grep -Erq "$compat|$compat2|$compat3" $dt_path`;
3192bff5da43SRob Herring				if ( $? >> 8 ) {
3193bff5da43SRob Herring					WARN("UNDOCUMENTED_DT_STRING",
3194bff5da43SRob Herring					     "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
3195bff5da43SRob Herring				}
3196bff5da43SRob Herring
31974fbf32a6SFlorian Vaussard				next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
31984fbf32a6SFlorian Vaussard				my $vendor = $1;
3199852d095dSRob Herring				`grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`;
3200bff5da43SRob Herring				if ( $? >> 8 ) {
3201bff5da43SRob Herring					WARN("UNDOCUMENTED_DT_STRING",
3202cc93319bSFlorian Vaussard					     "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
3203bff5da43SRob Herring				}
3204bff5da43SRob Herring			}
3205bff5da43SRob Herring		}
3206bff5da43SRob Herring
32079f3a8992SRob Herring# check for using SPDX license tag at beginning of files
32089f3a8992SRob Herring		if ($realline == $checklicenseline) {
32099f3a8992SRob Herring			if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
32109f3a8992SRob Herring				$checklicenseline = 2;
32119f3a8992SRob Herring			} elsif ($rawline =~ /^\+/) {
32129f3a8992SRob Herring				my $comment = "";
32139f3a8992SRob Herring				if ($realfile =~ /\.(h|s|S)$/) {
32149f3a8992SRob Herring					$comment = '/*';
32159f3a8992SRob Herring				} elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
32169f3a8992SRob Herring					$comment = '//';
3217c8df0ab6SLubomir Rintel				} elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) {
32189f3a8992SRob Herring					$comment = '#';
32199f3a8992SRob Herring				} elsif ($realfile =~ /\.rst$/) {
32209f3a8992SRob Herring					$comment = '..';
32219f3a8992SRob Herring				}
32229f3a8992SRob Herring
3223fdf13693SJoe Perches# check SPDX comment style for .[chsS] files
3224fdf13693SJoe Perches				if ($realfile =~ /\.[chsS]$/ &&
3225fdf13693SJoe Perches				    $rawline =~ /SPDX-License-Identifier:/ &&
3226ffbce897SJoe Perches				    $rawline !~ m@^\+\s*\Q$comment\E\s*@) {
3227fdf13693SJoe Perches					WARN("SPDX_LICENSE_TAG",
3228fdf13693SJoe Perches					     "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr);
3229fdf13693SJoe Perches				}
3230fdf13693SJoe Perches
32319f3a8992SRob Herring				if ($comment !~ /^$/ &&
3232ffbce897SJoe Perches				    $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) {
32339f3a8992SRob Herring					WARN("SPDX_LICENSE_TAG",
32349f3a8992SRob Herring					     "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
32353b6e8ac9SJoe Perches				} elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) {
32363b6e8ac9SJoe Perches					my $spdx_license = $1;
32373b6e8ac9SJoe Perches					if (!is_SPDX_License_valid($spdx_license)) {
32383b6e8ac9SJoe Perches						WARN("SPDX_LICENSE_TAG",
32393b6e8ac9SJoe Perches						     "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr);
32403b6e8ac9SJoe Perches					}
324150c92900SLubomir Rintel					if ($realfile =~ m@^Documentation/devicetree/bindings/@ &&
324250c92900SLubomir Rintel					    not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) {
324350c92900SLubomir Rintel						my $msg_level = \&WARN;
324450c92900SLubomir Rintel						$msg_level = \&CHK if ($file);
324550c92900SLubomir Rintel						if (&{$msg_level}("SPDX_LICENSE_TAG",
324650c92900SLubomir Rintel
324750c92900SLubomir Rintel								  "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) &&
324850c92900SLubomir Rintel						    $fix) {
324950c92900SLubomir Rintel							$fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/;
325050c92900SLubomir Rintel						}
325150c92900SLubomir Rintel					}
32529f3a8992SRob Herring				}
32539f3a8992SRob Herring			}
32549f3a8992SRob Herring		}
32559f3a8992SRob Herring
32565368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk
3257d6430f71SJoe Perches		next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
32585368df20SAndy Whitcroft
3259a8da38a9SJoe Perches# check for using SPDX-License-Identifier on the wrong line number
3260a8da38a9SJoe Perches		if ($realline != $checklicenseline &&
3261a8da38a9SJoe Perches		    $rawline =~ /\bSPDX-License-Identifier:/ &&
3262a8da38a9SJoe Perches		    substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) {
3263a8da38a9SJoe Perches			WARN("SPDX_LICENSE_TAG",
3264a8da38a9SJoe Perches			     "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr);
3265a8da38a9SJoe Perches		}
3266a8da38a9SJoe Perches
326747e0c88bSJoe Perches# line length limit (with some exclusions)
326847e0c88bSJoe Perches#
326947e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length:
327047e0c88bSJoe Perches#	logging functions like pr_info that end in a string
327147e0c88bSJoe Perches#	lines with a single string
327247e0c88bSJoe Perches#	#defines that are a single string
32732e4bbbc5SAndreas Brauchli#	lines with an RFC3986 like URL
327447e0c88bSJoe Perches#
327547e0c88bSJoe Perches# There are 3 different line length message types:
3276ab1ecabfSJean Delvare# LONG_LINE_COMMENT	a comment starts before but extends beyond $max_line_length
327747e0c88bSJoe Perches# LONG_LINE_STRING	a string starts before but extends beyond $max_line_length
327847e0c88bSJoe Perches# LONG_LINE		all other lines longer than $max_line_length
327947e0c88bSJoe Perches#
328047e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored
328147e0c88bSJoe Perches#
328247e0c88bSJoe Perches
3283b4749e96SJoe Perches		if ($line =~ /^\+/ && $length > $max_line_length) {
328447e0c88bSJoe Perches			my $msg_type = "LONG_LINE";
328547e0c88bSJoe Perches
328647e0c88bSJoe Perches			# Check the allowed long line types first
328747e0c88bSJoe Perches
328847e0c88bSJoe Perches			# logging functions that end in a string that starts
328947e0c88bSJoe Perches			# before $max_line_length
329047e0c88bSJoe Perches			if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
329147e0c88bSJoe Perches			    length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
329247e0c88bSJoe Perches				$msg_type = "";
329347e0c88bSJoe Perches
329447e0c88bSJoe Perches			# lines with only strings (w/ possible termination)
329547e0c88bSJoe Perches			# #defines with only strings
329647e0c88bSJoe Perches			} elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
329747e0c88bSJoe Perches				 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
329847e0c88bSJoe Perches				$msg_type = "";
329947e0c88bSJoe Perches
3300cc147506SJoe Perches			# More special cases
3301cc147506SJoe Perches			} elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3302cc147506SJoe Perches				 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
3303d560a5f8SJoe Perches				$msg_type = "";
3304d560a5f8SJoe Perches
33052e4bbbc5SAndreas Brauchli			# URL ($rawline is used in case the URL is in a comment)
33062e4bbbc5SAndreas Brauchli			} elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
33072e4bbbc5SAndreas Brauchli				$msg_type = "";
33082e4bbbc5SAndreas Brauchli
330947e0c88bSJoe Perches			# Otherwise set the alternate message types
331047e0c88bSJoe Perches
331147e0c88bSJoe Perches			# a comment starts before $max_line_length
331247e0c88bSJoe Perches			} elsif ($line =~ /($;[\s$;]*)$/ &&
331347e0c88bSJoe Perches				 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
331447e0c88bSJoe Perches				$msg_type = "LONG_LINE_COMMENT"
331547e0c88bSJoe Perches
331647e0c88bSJoe Perches			# a quoted string starts before $max_line_length
331747e0c88bSJoe Perches			} elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
331847e0c88bSJoe Perches				 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
331947e0c88bSJoe Perches				$msg_type = "LONG_LINE_STRING"
332047e0c88bSJoe Perches			}
332147e0c88bSJoe Perches
332247e0c88bSJoe Perches			if ($msg_type ne "" &&
332347e0c88bSJoe Perches			    (show_type("LONG_LINE") || show_type($msg_type))) {
3324bdc48fa1SJoe Perches				my $msg_level = \&WARN;
3325bdc48fa1SJoe Perches				$msg_level = \&CHK if ($file);
3326bdc48fa1SJoe Perches				&{$msg_level}($msg_type,
3327bdc48fa1SJoe Perches					      "line length of $length exceeds $max_line_length columns\n" . $herecurr);
33280a920b5bSAndy Whitcroft			}
332947e0c88bSJoe Perches		}
33300a920b5bSAndy Whitcroft
33318905a67cSAndy Whitcroft# check for adding lines without a newline.
33328905a67cSAndy Whitcroft		if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3333000d1cc1SJoe Perches			WARN("MISSING_EOF_NEWLINE",
3334000d1cc1SJoe Perches			     "adding a line without newline at end of file\n" . $herecurr);
33358905a67cSAndy Whitcroft		}
33368905a67cSAndy Whitcroft
3337b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk
3338de4c924cSGeert Uytterhoeven		next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
33390a920b5bSAndy Whitcroft
33400a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything
3341713a09deSAntonio Borneo# more than $tabsize must use tabs.
3342c2fdda0dSAndy Whitcroft		if ($rawline =~ /^\+\s* \t\s*\S/ ||
3343c2fdda0dSAndy Whitcroft		    $rawline =~ /^\+\s*        \s*/) {
3344c2fdda0dSAndy Whitcroft			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3345d2c0a235SAndy Whitcroft			$rpt_cleaners = 1;
33463705ce5bSJoe Perches			if (ERROR("CODE_INDENT",
33473705ce5bSJoe Perches				  "code indent should use tabs where possible\n" . $herevet) &&
33483705ce5bSJoe Perches			    $fix) {
3349194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
33503705ce5bSJoe Perches			}
33510a920b5bSAndy Whitcroft		}
33520a920b5bSAndy Whitcroft
335308e44365SAlberto Panizzo# check for space before tabs.
335408e44365SAlberto Panizzo		if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
335508e44365SAlberto Panizzo			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
33563705ce5bSJoe Perches			if (WARN("SPACE_BEFORE_TAB",
33573705ce5bSJoe Perches				"please, no space before tabs\n" . $herevet) &&
33583705ce5bSJoe Perches			    $fix) {
3359194f66fcSJoe Perches				while ($fixed[$fixlinenr] =~
3360713a09deSAntonio Borneo					   s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {}
3361194f66fcSJoe Perches				while ($fixed[$fixlinenr] =~
3362c76f4cb3SJoe Perches					   s/(^\+.*) +\t/$1\t/) {}
33633705ce5bSJoe Perches			}
336408e44365SAlberto Panizzo		}
336508e44365SAlberto Panizzo
33666a487211SJoe Perches# check for assignments on the start of a line
33676a487211SJoe Perches		if ($sline =~ /^\+\s+($Assignment)[^=]/) {
33686a487211SJoe Perches			CHK("ASSIGNMENT_CONTINUATIONS",
33696a487211SJoe Perches			    "Assignment operator '$1' should be on the previous line\n" . $hereprev);
33706a487211SJoe Perches		}
33716a487211SJoe Perches
3372d1fe9c09SJoe Perches# check for && or || at the start of a line
3373d1fe9c09SJoe Perches		if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3374d1fe9c09SJoe Perches			CHK("LOGICAL_CONTINUATIONS",
3375d1fe9c09SJoe Perches			    "Logical continuations should be on the previous line\n" . $hereprev);
3376d1fe9c09SJoe Perches		}
3377d1fe9c09SJoe Perches
3378a91e8994SJoe Perches# check indentation starts on a tab stop
33795b57980dSJoe Perches		if ($perl_version_ok &&
3380bd49111fSJoe Perches		    $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3381a91e8994SJoe Perches			my $indent = length($1);
3382713a09deSAntonio Borneo			if ($indent % $tabsize) {
3383a91e8994SJoe Perches				if (WARN("TABSTOP",
3384a91e8994SJoe Perches					 "Statements should start on a tabstop\n" . $herecurr) &&
3385a91e8994SJoe Perches				    $fix) {
3386713a09deSAntonio Borneo					$fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e;
3387a91e8994SJoe Perches				}
3388a91e8994SJoe Perches			}
3389a91e8994SJoe Perches		}
3390a91e8994SJoe Perches
3391d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line
33925b57980dSJoe Perches		if ($perl_version_ok &&
3393fd71f632SJoe Perches		    $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3394d1fe9c09SJoe Perches			$prevline =~ /^\+(\t*)(.*)$/;
3395d1fe9c09SJoe Perches			my $oldindent = $1;
3396d1fe9c09SJoe Perches			my $rest = $2;
3397d1fe9c09SJoe Perches
3398d1fe9c09SJoe Perches			my $pos = pos_last_openparen($rest);
3399d1fe9c09SJoe Perches			if ($pos >= 0) {
3400b34a26f3SJoe Perches				$line =~ /^(\+| )([ \t]*)/;
3401b34a26f3SJoe Perches				my $newindent = $2;
3402d1fe9c09SJoe Perches
3403d1fe9c09SJoe Perches				my $goodtabindent = $oldindent .
3404713a09deSAntonio Borneo					"\t" x ($pos / $tabsize) .
3405713a09deSAntonio Borneo					" "  x ($pos % $tabsize);
3406d1fe9c09SJoe Perches				my $goodspaceindent = $oldindent . " "  x $pos;
3407d1fe9c09SJoe Perches
3408d1fe9c09SJoe Perches				if ($newindent ne $goodtabindent &&
3409d1fe9c09SJoe Perches				    $newindent ne $goodspaceindent) {
34103705ce5bSJoe Perches
34113705ce5bSJoe Perches					if (CHK("PARENTHESIS_ALIGNMENT",
34123705ce5bSJoe Perches						"Alignment should match open parenthesis\n" . $hereprev) &&
34133705ce5bSJoe Perches					    $fix && $line =~ /^\+/) {
3414194f66fcSJoe Perches						$fixed[$fixlinenr] =~
34153705ce5bSJoe Perches						    s/^\+[ \t]*/\+$goodtabindent/;
34163705ce5bSJoe Perches					}
3417d1fe9c09SJoe Perches				}
3418d1fe9c09SJoe Perches			}
3419d1fe9c09SJoe Perches		}
3420d1fe9c09SJoe Perches
34216ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar"
34226ab3a970SJoe Perches# avoid checking a few false positives:
34236ab3a970SJoe Perches#   "sizeof(<type>)" or "__alignof__(<type>)"
34246ab3a970SJoe Perches#   function pointer declarations like "(*foo)(int) = bar;"
34256ab3a970SJoe Perches#   structure definitions like "(struct foo) { 0 };"
34266ab3a970SJoe Perches#   multiline macros that define functions
34276ab3a970SJoe Perches#   known attributes or the __attribute__ keyword
34286ab3a970SJoe Perches		if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
34296ab3a970SJoe Perches		    (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
34303705ce5bSJoe Perches			if (CHK("SPACING",
3431f27c95dbSJoe Perches				"No space is necessary after a cast\n" . $herecurr) &&
34323705ce5bSJoe Perches			    $fix) {
3433194f66fcSJoe Perches				$fixed[$fixlinenr] =~
3434f27c95dbSJoe Perches				    s/(\(\s*$Type\s*\))[ \t]+/$1/;
34353705ce5bSJoe Perches			}
3436aad4f614SJoe Perches		}
3437aad4f614SJoe Perches
343886406b1cSJoe Perches# Block comment styles
343986406b1cSJoe Perches# Networking with an initial /*
344005880600SJoe Perches		if ($realfile =~ m@^(drivers/net/|net/)@ &&
3441fdb4bcd6SJoe Perches		    $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
344285ad978cSJoe Perches		    $rawline =~ /^\+[ \t]*\*/ &&
344385ad978cSJoe Perches		    $realline > 2) {
344405880600SJoe Perches			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
344505880600SJoe Perches			     "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
344605880600SJoe Perches		}
344705880600SJoe Perches
344886406b1cSJoe Perches# Block comments use * on subsequent lines
344986406b1cSJoe Perches		if ($prevline =~ /$;[ \t]*$/ &&			#ends in comment
345086406b1cSJoe Perches		    $prevrawline =~ /^\+.*?\/\*/ &&		#starting /*
3451a605e32eSJoe Perches		    $prevrawline !~ /\*\/[ \t]*$/ &&		#no trailing */
345261135e96SJoe Perches		    $rawline =~ /^\+/ &&			#line is new
3453a605e32eSJoe Perches		    $rawline !~ /^\+[ \t]*\*/) {		#no leading *
345486406b1cSJoe Perches			WARN("BLOCK_COMMENT_STYLE",
345586406b1cSJoe Perches			     "Block comments use * on subsequent lines\n" . $hereprev);
3456a605e32eSJoe Perches		}
3457a605e32eSJoe Perches
345886406b1cSJoe Perches# Block comments use */ on trailing lines
345986406b1cSJoe Perches		if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ &&	#trailing */
3460c24f9f19SJoe Perches		    $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ &&	#inline /*...*/
3461c24f9f19SJoe Perches		    $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ &&	#trailing **/
3462c24f9f19SJoe Perches		    $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) {	#non blank */
346386406b1cSJoe Perches			WARN("BLOCK_COMMENT_STYLE",
346486406b1cSJoe Perches			     "Block comments use a trailing */ on a separate line\n" . $herecurr);
346505880600SJoe Perches		}
346605880600SJoe Perches
346708eb9b80SJoe Perches# Block comment * alignment
346808eb9b80SJoe Perches		if ($prevline =~ /$;[ \t]*$/ &&			#ends in comment
3469af207524SJoe Perches		    $line =~ /^\+[ \t]*$;/ &&			#leading comment
3470af207524SJoe Perches		    $rawline =~ /^\+[ \t]*\*/ &&		#leading *
3471af207524SJoe Perches		    (($prevrawline =~ /^\+.*?\/\*/ &&		#leading /*
347208eb9b80SJoe Perches		      $prevrawline !~ /\*\/[ \t]*$/) ||		#no trailing */
3473af207524SJoe Perches		     $prevrawline =~ /^\+[ \t]*\*/)) {		#leading *
3474af207524SJoe Perches			my $oldindent;
347508eb9b80SJoe Perches			$prevrawline =~ m@^\+([ \t]*/?)\*@;
3476af207524SJoe Perches			if (defined($1)) {
3477af207524SJoe Perches				$oldindent = expand_tabs($1);
3478af207524SJoe Perches			} else {
3479af207524SJoe Perches				$prevrawline =~ m@^\+(.*/?)\*@;
3480af207524SJoe Perches				$oldindent = expand_tabs($1);
3481af207524SJoe Perches			}
348208eb9b80SJoe Perches			$rawline =~ m@^\+([ \t]*)\*@;
348308eb9b80SJoe Perches			my $newindent = $1;
348408eb9b80SJoe Perches			$newindent = expand_tabs($newindent);
3485af207524SJoe Perches			if (length($oldindent) ne length($newindent)) {
348608eb9b80SJoe Perches				WARN("BLOCK_COMMENT_STYLE",
348708eb9b80SJoe Perches				     "Block comments should align the * on each line\n" . $hereprev);
348808eb9b80SJoe Perches			}
348908eb9b80SJoe Perches		}
349008eb9b80SJoe Perches
34917f619191SJoe Perches# check for missing blank lines after struct/union declarations
34927f619191SJoe Perches# with exceptions for various attributes and macros
34937f619191SJoe Perches		if ($prevline =~ /^[\+ ]};?\s*$/ &&
34947f619191SJoe Perches		    $line =~ /^\+/ &&
34957f619191SJoe Perches		    !($line =~ /^\+\s*$/ ||
34967f619191SJoe Perches		      $line =~ /^\+\s*EXPORT_SYMBOL/ ||
34977f619191SJoe Perches		      $line =~ /^\+\s*MODULE_/i ||
34987f619191SJoe Perches		      $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
34997f619191SJoe Perches		      $line =~ /^\+[a-z_]*init/ ||
35007f619191SJoe Perches		      $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
35017f619191SJoe Perches		      $line =~ /^\+\s*DECLARE/ ||
35020bc989ffSMasahiro Yamada		      $line =~ /^\+\s*builtin_[\w_]*driver/ ||
35037f619191SJoe Perches		      $line =~ /^\+\s*__setup/)) {
3504d752fcc8SJoe Perches			if (CHK("LINE_SPACING",
3505d752fcc8SJoe Perches				"Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3506d752fcc8SJoe Perches			    $fix) {
3507f2d7e4d4SJoe Perches				fix_insert_line($fixlinenr, "\+");
3508d752fcc8SJoe Perches			}
35097f619191SJoe Perches		}
35107f619191SJoe Perches
3511365dd4eaSJoe Perches# check for multiple consecutive blank lines
3512365dd4eaSJoe Perches		if ($prevline =~ /^[\+ ]\s*$/ &&
3513365dd4eaSJoe Perches		    $line =~ /^\+\s*$/ &&
3514365dd4eaSJoe Perches		    $last_blank_line != ($linenr - 1)) {
3515d752fcc8SJoe Perches			if (CHK("LINE_SPACING",
3516d752fcc8SJoe Perches				"Please don't use multiple blank lines\n" . $hereprev) &&
3517d752fcc8SJoe Perches			    $fix) {
3518f2d7e4d4SJoe Perches				fix_delete_line($fixlinenr, $rawline);
3519d752fcc8SJoe Perches			}
3520d752fcc8SJoe Perches
3521365dd4eaSJoe Perches			$last_blank_line = $linenr;
3522365dd4eaSJoe Perches		}
3523365dd4eaSJoe Perches
35243b617e3bSJoe Perches# check for missing blank lines after declarations
35253f7bac03SJoe Perches		if ($sline =~ /^\+\s+\S/ &&			#Not at char 1
35263f7bac03SJoe Perches			# actual declarations
35273f7bac03SJoe Perches		    ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
35285a4e1fd3SJoe Perches			# function pointer declarations
35295a4e1fd3SJoe Perches		     $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
35303f7bac03SJoe Perches			# foo bar; where foo is some local typedef or #define
35313f7bac03SJoe Perches		     $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
35323f7bac03SJoe Perches			# known declaration macros
35333f7bac03SJoe Perches		     $prevline =~ /^\+\s+$declaration_macros/) &&
35343f7bac03SJoe Perches			# for "else if" which can look like "$Ident $Ident"
35353f7bac03SJoe Perches		    !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
35363f7bac03SJoe Perches			# other possible extensions of declaration lines
35373f7bac03SJoe Perches		      $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
35383f7bac03SJoe Perches			# not starting a section or a macro "\" extended line
35393f7bac03SJoe Perches		      $prevline =~ /(?:\{\s*|\\)$/) &&
35403f7bac03SJoe Perches			# looks like a declaration
35413f7bac03SJoe Perches		    !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
35425a4e1fd3SJoe Perches			# function pointer declarations
35435a4e1fd3SJoe Perches		      $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
35443f7bac03SJoe Perches			# foo bar; where foo is some local typedef or #define
35453f7bac03SJoe Perches		      $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
35463f7bac03SJoe Perches			# known declaration macros
35473f7bac03SJoe Perches		      $sline =~ /^\+\s+$declaration_macros/ ||
35483f7bac03SJoe Perches			# start of struct or union or enum
3549328b5f41SJoe Perches		      $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ ||
35503f7bac03SJoe Perches			# start or end of block or continuation of declaration
35513f7bac03SJoe Perches		      $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
35523f7bac03SJoe Perches			# bitfield continuation
35533f7bac03SJoe Perches		      $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
35543f7bac03SJoe Perches			# other possible extensions of declaration lines
35553f7bac03SJoe Perches		      $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
35563f7bac03SJoe Perches			# indentation of previous and current line are the same
35573f7bac03SJoe Perches		    (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
3558d752fcc8SJoe Perches			if (WARN("LINE_SPACING",
3559d752fcc8SJoe Perches				 "Missing a blank line after declarations\n" . $hereprev) &&
3560d752fcc8SJoe Perches			    $fix) {
3561f2d7e4d4SJoe Perches				fix_insert_line($fixlinenr, "\+");
3562d752fcc8SJoe Perches			}
35633b617e3bSJoe Perches		}
35643b617e3bSJoe Perches
35655f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line.
35666b4c5bebSAndy Whitcroft# Exceptions:
35676b4c5bebSAndy Whitcroft#  1) within comments
35686b4c5bebSAndy Whitcroft#  2) indented preprocessor commands
35696b4c5bebSAndy Whitcroft#  3) hanging labels
35703705ce5bSJoe Perches		if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/)  {
35715f7ddae6SRaffaele Recalcati			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
35723705ce5bSJoe Perches			if (WARN("LEADING_SPACE",
35733705ce5bSJoe Perches				 "please, no spaces at the start of a line\n" . $herevet) &&
35743705ce5bSJoe Perches			    $fix) {
3575194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
35763705ce5bSJoe Perches			}
35775f7ddae6SRaffaele Recalcati		}
35785f7ddae6SRaffaele Recalcati
3579b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk
3580b9ea10d6SAndy Whitcroft		next if ($realfile !~ /\.(h|c)$/);
3581b9ea10d6SAndy Whitcroft
35825751a24eSJoe Perches# check for unusual line ending [ or (
35835751a24eSJoe Perches		if ($line =~ /^\+.*([\[\(])\s*$/) {
35845751a24eSJoe Perches			CHK("OPEN_ENDED_LINE",
35855751a24eSJoe Perches			    "Lines should not end with a '$1'\n" . $herecurr);
35865751a24eSJoe Perches		}
35875751a24eSJoe Perches
35884dbed76fSJoe Perches# check if this appears to be the start function declaration, save the name
35894dbed76fSJoe Perches		if ($sline =~ /^\+\{\s*$/ &&
35904dbed76fSJoe Perches		    $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
35914dbed76fSJoe Perches			$context_function = $1;
35924dbed76fSJoe Perches		}
35934dbed76fSJoe Perches
35944dbed76fSJoe Perches# check if this appears to be the end of function declaration
35954dbed76fSJoe Perches		if ($sline =~ /^\+\}\s*$/) {
35964dbed76fSJoe Perches			undef $context_function;
35974dbed76fSJoe Perches		}
35984dbed76fSJoe Perches
3599032a4c0fSJoe Perches# check indentation of any line with a bare else
3600840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;")
3601032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more...
3602032a4c0fSJoe Perches		if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3603032a4c0fSJoe Perches			my $tabs = length($1) + 1;
3604840080a0SJoe Perches			if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3605840080a0SJoe Perches			    ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3606840080a0SJoe Perches			     defined $lines[$linenr] &&
3607840080a0SJoe Perches			     $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
3608032a4c0fSJoe Perches				WARN("UNNECESSARY_ELSE",
3609032a4c0fSJoe Perches				     "else is not generally useful after a break or return\n" . $hereprev);
3610032a4c0fSJoe Perches			}
3611032a4c0fSJoe Perches		}
3612032a4c0fSJoe Perches
3613c00df19aSJoe Perches# check indentation of a line with a break;
3614c00df19aSJoe Perches# if the previous line is a goto or return and is indented the same # of tabs
3615c00df19aSJoe Perches		if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3616c00df19aSJoe Perches			my $tabs = $1;
3617c00df19aSJoe Perches			if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3618c00df19aSJoe Perches				WARN("UNNECESSARY_BREAK",
3619c00df19aSJoe Perches				     "break is not useful after a goto or return\n" . $hereprev);
3620c00df19aSJoe Perches			}
3621c00df19aSJoe Perches		}
3622c00df19aSJoe Perches
3623c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers
3624cf655043SAndy Whitcroft		if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
3625000d1cc1SJoe Perches			WARN("CVS_KEYWORD",
3626000d1cc1SJoe Perches			     "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
3627c2fdda0dSAndy Whitcroft		}
362822f2a2efSAndy Whitcroft
362956e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings
363056e77d70SJoe Perches		if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
363156e77d70SJoe Perches			WARN("HOTPLUG_SECTION",
363256e77d70SJoe Perches			     "Using $1 is unnecessary\n" . $herecurr);
363356e77d70SJoe Perches		}
363456e77d70SJoe Perches
36359c0ca6f9SAndy Whitcroft# Check for potential 'bare' types
36362b474a1aSAndy Whitcroft		my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
36372b474a1aSAndy Whitcroft		    $realline_next);
36383e469cdcSAndy Whitcroft#print "LINE<$line>\n";
3639ca819864SJoe Perches		if ($linenr > $suppress_statement &&
36401b5539b1SJoe Perches		    $realcnt && $sline =~ /.\s*\S/) {
3641170d3a22SAndy Whitcroft			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3642f5fe35ddSAndy Whitcroft				ctx_statement_block($linenr, $realcnt, 0);
3643171ae1a4SAndy Whitcroft			$stat =~ s/\n./\n /g;
3644171ae1a4SAndy Whitcroft			$cond =~ s/\n./\n /g;
3645171ae1a4SAndy Whitcroft
36463e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n";
36473e469cdcSAndy Whitcroft			# If this statement has no statement boundaries within
36483e469cdcSAndy Whitcroft			# it there is no point in retrying a statement scan
36493e469cdcSAndy Whitcroft			# until we hit end of it.
36503e469cdcSAndy Whitcroft			my $frag = $stat; $frag =~ s/;+\s*$//;
36513e469cdcSAndy Whitcroft			if ($frag !~ /(?:{|;)/) {
36523e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n";
36533e469cdcSAndy Whitcroft				$suppress_statement = $line_nr_next;
36543e469cdcSAndy Whitcroft			}
3655f74bd194SAndy Whitcroft
36562b474a1aSAndy Whitcroft			# Find the real next line.
36572b474a1aSAndy Whitcroft			$realline_next = $line_nr_next;
36582b474a1aSAndy Whitcroft			if (defined $realline_next &&
36592b474a1aSAndy Whitcroft			    (!defined $lines[$realline_next - 1] ||
36602b474a1aSAndy Whitcroft			     substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
36612b474a1aSAndy Whitcroft				$realline_next++;
36622b474a1aSAndy Whitcroft			}
36632b474a1aSAndy Whitcroft
3664171ae1a4SAndy Whitcroft			my $s = $stat;
3665171ae1a4SAndy Whitcroft			$s =~ s/{.*$//s;
3666cf655043SAndy Whitcroft
3667c2fdda0dSAndy Whitcroft			# Ignore goto labels.
3668171ae1a4SAndy Whitcroft			if ($s =~ /$Ident:\*$/s) {
3669c2fdda0dSAndy Whitcroft
3670c2fdda0dSAndy Whitcroft			# Ignore functions being called
3671171ae1a4SAndy Whitcroft			} elsif ($s =~ /^.\s*$Ident\s*\(/s) {
3672c2fdda0dSAndy Whitcroft
3673463f2864SAndy Whitcroft			} elsif ($s =~ /^.\s*else\b/s) {
3674463f2864SAndy Whitcroft
3675c45dcabdSAndy Whitcroft			# declarations always start with types
3676d2506586SAndy Whitcroft			} 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) {
3677c45dcabdSAndy Whitcroft				my $type = $1;
3678c45dcabdSAndy Whitcroft				$type =~ s/\s+/ /g;
3679c45dcabdSAndy Whitcroft				possible($type, "A:" . $s);
3680c45dcabdSAndy Whitcroft
36816c72ffaaSAndy Whitcroft			# definitions in global scope can only start with types
3682a6a84062SAndy Whitcroft			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
3683c45dcabdSAndy Whitcroft				possible($1, "B:" . $s);
3684c2fdda0dSAndy Whitcroft			}
36858905a67cSAndy Whitcroft
36866c72ffaaSAndy Whitcroft			# any (foo ... *) is a pointer cast, and foo is a type
368765863862SAndy Whitcroft			while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
3688c45dcabdSAndy Whitcroft				possible($1, "C:" . $s);
36899c0ca6f9SAndy Whitcroft			}
36908905a67cSAndy Whitcroft
36918905a67cSAndy Whitcroft			# Check for any sort of function declaration.
36928905a67cSAndy Whitcroft			# int foo(something bar, other baz);
36938905a67cSAndy Whitcroft			# void (*store_gdt)(x86_descr_ptr *);
3694171ae1a4SAndy Whitcroft			if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
36958905a67cSAndy Whitcroft				my ($name_len) = length($1);
36968905a67cSAndy Whitcroft
3697cf655043SAndy Whitcroft				my $ctx = $s;
3698773647a0SAndy Whitcroft				substr($ctx, 0, $name_len + 1, '');
36998905a67cSAndy Whitcroft				$ctx =~ s/\)[^\)]*$//;
3700cf655043SAndy Whitcroft
37018905a67cSAndy Whitcroft				for my $arg (split(/\s*,\s*/, $ctx)) {
3702c45dcabdSAndy Whitcroft					if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
37038905a67cSAndy Whitcroft
3704c45dcabdSAndy Whitcroft						possible($1, "D:" . $s);
37058905a67cSAndy Whitcroft					}
37068905a67cSAndy Whitcroft				}
37078905a67cSAndy Whitcroft			}
37088905a67cSAndy Whitcroft
37099c0ca6f9SAndy Whitcroft		}
37109c0ca6f9SAndy Whitcroft
371100df344fSAndy Whitcroft#
371200df344fSAndy Whitcroft# Checks which may be anchored in the context.
371300df344fSAndy Whitcroft#
371400df344fSAndy Whitcroft
371500df344fSAndy Whitcroft# Check for switch () and associated case and default
371600df344fSAndy Whitcroft# statements should be at the same indent.
371700df344fSAndy Whitcroft		if ($line=~/\bswitch\s*\(.*\)/) {
371800df344fSAndy Whitcroft			my $err = '';
371900df344fSAndy Whitcroft			my $sep = '';
372000df344fSAndy Whitcroft			my @ctx = ctx_block_outer($linenr, $realcnt);
372100df344fSAndy Whitcroft			shift(@ctx);
372200df344fSAndy Whitcroft			for my $ctx (@ctx) {
372300df344fSAndy Whitcroft				my ($clen, $cindent) = line_stats($ctx);
372400df344fSAndy Whitcroft				if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
372500df344fSAndy Whitcroft							$indent != $cindent) {
372600df344fSAndy Whitcroft					$err .= "$sep$ctx\n";
372700df344fSAndy Whitcroft					$sep = '';
372800df344fSAndy Whitcroft				} else {
372900df344fSAndy Whitcroft					$sep = "[...]\n";
373000df344fSAndy Whitcroft				}
373100df344fSAndy Whitcroft			}
373200df344fSAndy Whitcroft			if ($err ne '') {
3733000d1cc1SJoe Perches				ERROR("SWITCH_CASE_INDENT_LEVEL",
3734000d1cc1SJoe Perches				      "switch and case should be at the same indent\n$hereline$err");
3735de7d4f0eSAndy Whitcroft			}
3736de7d4f0eSAndy Whitcroft		}
3737de7d4f0eSAndy Whitcroft
3738de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop,
3739de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else
37400fe3dc2bSJoe Perches		if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3741773647a0SAndy Whitcroft			my $pre_ctx = "$1$2";
3742773647a0SAndy Whitcroft
37439c0ca6f9SAndy Whitcroft			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
37448eef05ddSJoe Perches
37458eef05ddSJoe Perches			if ($line =~ /^\+\t{6,}/) {
37468eef05ddSJoe Perches				WARN("DEEP_INDENTATION",
37478eef05ddSJoe Perches				     "Too many leading tabs - consider code refactoring\n" . $herecurr);
37488eef05ddSJoe Perches			}
37498eef05ddSJoe Perches
3750de7d4f0eSAndy Whitcroft			my $ctx_cnt = $realcnt - $#ctx - 1;
3751de7d4f0eSAndy Whitcroft			my $ctx = join("\n", @ctx);
3752de7d4f0eSAndy Whitcroft
3753548596d5SAndy Whitcroft			my $ctx_ln = $linenr;
3754548596d5SAndy Whitcroft			my $ctx_skip = $realcnt;
3755de7d4f0eSAndy Whitcroft
3756548596d5SAndy Whitcroft			while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3757548596d5SAndy Whitcroft					defined $lines[$ctx_ln - 1] &&
3758548596d5SAndy Whitcroft					$lines[$ctx_ln - 1] =~ /^-/)) {
3759548596d5SAndy Whitcroft				##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3760548596d5SAndy Whitcroft				$ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
3761773647a0SAndy Whitcroft				$ctx_ln++;
3762773647a0SAndy Whitcroft			}
3763548596d5SAndy Whitcroft
376453210168SAndy Whitcroft			#print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
376553210168SAndy Whitcroft			#print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3766773647a0SAndy Whitcroft
3767773647a0SAndy Whitcroft			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
3768000d1cc1SJoe Perches				ERROR("OPEN_BRACE",
3769000d1cc1SJoe Perches				      "that open brace { should be on the previous line\n" .
377001464f30SAndy Whitcroft					"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
377100df344fSAndy Whitcroft			}
3772773647a0SAndy Whitcroft			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3773773647a0SAndy Whitcroft			    $ctx =~ /\)\s*\;\s*$/ &&
3774773647a0SAndy Whitcroft			    defined $lines[$ctx_ln - 1])
3775773647a0SAndy Whitcroft			{
37769c0ca6f9SAndy Whitcroft				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
37779c0ca6f9SAndy Whitcroft				if ($nindent > $indent) {
3778000d1cc1SJoe Perches					WARN("TRAILING_SEMICOLON",
3779000d1cc1SJoe Perches					     "trailing semicolon indicates no statements, indent implies otherwise\n" .
378001464f30SAndy Whitcroft						"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
37819c0ca6f9SAndy Whitcroft				}
37829c0ca6f9SAndy Whitcroft			}
378300df344fSAndy Whitcroft		}
378400df344fSAndy Whitcroft
37854d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks.
3786f6950a73SJoe Perches		if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
37873e469cdcSAndy Whitcroft			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
37883e469cdcSAndy Whitcroft				ctx_statement_block($linenr, $realcnt, 0)
37893e469cdcSAndy Whitcroft					if (!defined $stat);
37904d001e4dSAndy Whitcroft			my ($s, $c) = ($stat, $cond);
37914d001e4dSAndy Whitcroft
37924d001e4dSAndy Whitcroft			substr($s, 0, length($c), '');
37934d001e4dSAndy Whitcroft
37949f5af480SJoe Perches			# remove inline comments
37959f5af480SJoe Perches			$s =~ s/$;/ /g;
37969f5af480SJoe Perches			$c =~ s/$;/ /g;
37974d001e4dSAndy Whitcroft
37984d001e4dSAndy Whitcroft			# Find out how long the conditional actually is.
37996f779c18SAndy Whitcroft			my @newlines = ($c =~ /\n/gs);
38006f779c18SAndy Whitcroft			my $cond_lines = 1 + $#newlines;
38014d001e4dSAndy Whitcroft
38029f5af480SJoe Perches			# Make sure we remove the line prefixes as we have
38039f5af480SJoe Perches			# none on the first line, and are going to readd them
38049f5af480SJoe Perches			# where necessary.
38059f5af480SJoe Perches			$s =~ s/\n./\n/gs;
38069f5af480SJoe Perches			while ($s =~ /\n\s+\\\n/) {
38079f5af480SJoe Perches				$cond_lines += $s =~ s/\n\s+\\\n/\n/g;
38089f5af480SJoe Perches			}
38099f5af480SJoe Perches
38104d001e4dSAndy Whitcroft			# We want to check the first line inside the block
38114d001e4dSAndy Whitcroft			# starting at the end of the conditional, so remove:
38124d001e4dSAndy Whitcroft			#  1) any blank line termination
38134d001e4dSAndy Whitcroft			#  2) any opening brace { on end of the line
38144d001e4dSAndy Whitcroft			#  3) any do (...) {
38154d001e4dSAndy Whitcroft			my $continuation = 0;
38164d001e4dSAndy Whitcroft			my $check = 0;
38174d001e4dSAndy Whitcroft			$s =~ s/^.*\bdo\b//;
38184d001e4dSAndy Whitcroft			$s =~ s/^\s*{//;
38194d001e4dSAndy Whitcroft			if ($s =~ s/^\s*\\//) {
38204d001e4dSAndy Whitcroft				$continuation = 1;
38214d001e4dSAndy Whitcroft			}
38229bd49efeSAndy Whitcroft			if ($s =~ s/^\s*?\n//) {
38234d001e4dSAndy Whitcroft				$check = 1;
38244d001e4dSAndy Whitcroft				$cond_lines++;
38254d001e4dSAndy Whitcroft			}
38264d001e4dSAndy Whitcroft
38274d001e4dSAndy Whitcroft			# Also ignore a loop construct at the end of a
38284d001e4dSAndy Whitcroft			# preprocessor statement.
38294d001e4dSAndy Whitcroft			if (($prevline =~ /^.\s*#\s*define\s/ ||
38304d001e4dSAndy Whitcroft			    $prevline =~ /\\\s*$/) && $continuation == 0) {
38314d001e4dSAndy Whitcroft				$check = 0;
38324d001e4dSAndy Whitcroft			}
38334d001e4dSAndy Whitcroft
38349bd49efeSAndy Whitcroft			my $cond_ptr = -1;
3835740504c6SAndy Whitcroft			$continuation = 0;
38369bd49efeSAndy Whitcroft			while ($cond_ptr != $cond_lines) {
38379bd49efeSAndy Whitcroft				$cond_ptr = $cond_lines;
38384d001e4dSAndy Whitcroft
3839f16fa28fSAndy Whitcroft				# If we see an #else/#elif then the code
3840f16fa28fSAndy Whitcroft				# is not linear.
3841f16fa28fSAndy Whitcroft				if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3842f16fa28fSAndy Whitcroft					$check = 0;
3843f16fa28fSAndy Whitcroft				}
3844f16fa28fSAndy Whitcroft
38459bd49efeSAndy Whitcroft				# Ignore:
38469bd49efeSAndy Whitcroft				#  1) blank lines, they should be at 0,
38479bd49efeSAndy Whitcroft				#  2) preprocessor lines, and
38489bd49efeSAndy Whitcroft				#  3) labels.
3849740504c6SAndy Whitcroft				if ($continuation ||
3850740504c6SAndy Whitcroft				    $s =~ /^\s*?\n/ ||
38519bd49efeSAndy Whitcroft				    $s =~ /^\s*#\s*?/ ||
38529bd49efeSAndy Whitcroft				    $s =~ /^\s*$Ident\s*:/) {
3853740504c6SAndy Whitcroft					$continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
385430dad6ebSAndy Whitcroft					if ($s =~ s/^.*?\n//) {
38559bd49efeSAndy Whitcroft						$cond_lines++;
38569bd49efeSAndy Whitcroft					}
38574d001e4dSAndy Whitcroft				}
385830dad6ebSAndy Whitcroft			}
38594d001e4dSAndy Whitcroft
38604d001e4dSAndy Whitcroft			my (undef, $sindent) = line_stats("+" . $s);
38614d001e4dSAndy Whitcroft			my $stat_real = raw_line($linenr, $cond_lines);
38624d001e4dSAndy Whitcroft
38634d001e4dSAndy Whitcroft			# Check if either of these lines are modified, else
38644d001e4dSAndy Whitcroft			# this is not this patch's fault.
38654d001e4dSAndy Whitcroft			if (!defined($stat_real) ||
38664d001e4dSAndy Whitcroft			    $stat !~ /^\+/ && $stat_real !~ /^\+/) {
38674d001e4dSAndy Whitcroft				$check = 0;
38684d001e4dSAndy Whitcroft			}
38694d001e4dSAndy Whitcroft			if (defined($stat_real) && $cond_lines > 1) {
38704d001e4dSAndy Whitcroft				$stat_real = "[...]\n$stat_real";
38714d001e4dSAndy Whitcroft			}
38724d001e4dSAndy Whitcroft
38739bd49efeSAndy Whitcroft			#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";
38744d001e4dSAndy Whitcroft
38759f5af480SJoe Perches			if ($check && $s ne '' &&
3876713a09deSAntonio Borneo			    (($sindent % $tabsize) != 0 ||
38779f5af480SJoe Perches			     ($sindent < $indent) ||
3878f6950a73SJoe Perches			     ($sindent == $indent &&
3879f6950a73SJoe Perches			      ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
3880713a09deSAntonio Borneo			     ($sindent > $indent + $tabsize))) {
3881000d1cc1SJoe Perches				WARN("SUSPECT_CODE_INDENT",
3882000d1cc1SJoe Perches				     "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
38834d001e4dSAndy Whitcroft			}
38844d001e4dSAndy Whitcroft		}
38854d001e4dSAndy Whitcroft
38866c72ffaaSAndy Whitcroft		# Track the 'values' across context and added lines.
38876c72ffaaSAndy Whitcroft		my $opline = $line; $opline =~ s/^./ /;
38881f65f947SAndy Whitcroft		my ($curr_values, $curr_vars) =
38891f65f947SAndy Whitcroft				annotate_values($opline . "\n", $prev_values);
38906c72ffaaSAndy Whitcroft		$curr_values = $prev_values . $curr_values;
3891c2fdda0dSAndy Whitcroft		if ($dbg_values) {
3892c2fdda0dSAndy Whitcroft			my $outline = $opline; $outline =~ s/\t/ /g;
3893cf655043SAndy Whitcroft			print "$linenr > .$outline\n";
3894cf655043SAndy Whitcroft			print "$linenr > $curr_values\n";
38951f65f947SAndy Whitcroft			print "$linenr >  $curr_vars\n";
3896c2fdda0dSAndy Whitcroft		}
38976c72ffaaSAndy Whitcroft		$prev_values = substr($curr_values, -1);
38986c72ffaaSAndy Whitcroft
389900df344fSAndy Whitcroft#ignore lines not being added
39003705ce5bSJoe Perches		next if ($line =~ /^[^\+]/);
390100df344fSAndy Whitcroft
390211ca40a0SJoe Perches# check for dereferences that span multiple lines
390311ca40a0SJoe Perches		if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
390411ca40a0SJoe Perches		    $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
390511ca40a0SJoe Perches			$prevline =~ /($Lval\s*(?:\.|->))\s*$/;
390611ca40a0SJoe Perches			my $ref = $1;
390711ca40a0SJoe Perches			$line =~ /^.\s*($Lval)/;
390811ca40a0SJoe Perches			$ref .= $1;
390911ca40a0SJoe Perches			$ref =~ s/\s//g;
391011ca40a0SJoe Perches			WARN("MULTILINE_DEREFERENCE",
391111ca40a0SJoe Perches			     "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
391211ca40a0SJoe Perches		}
391311ca40a0SJoe Perches
3914a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int
3915c8447115SJoe Perches		while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3916a1ce18e4SJoe Perches			my $type = $1;
3917a1ce18e4SJoe Perches			my $var = $2;
3918207a8e84SJoe Perches			$var = "" if (!defined $var);
3919207a8e84SJoe Perches			if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
3920a1ce18e4SJoe Perches				my $sign = $1;
3921a1ce18e4SJoe Perches				my $pointer = $2;
3922a1ce18e4SJoe Perches
3923a1ce18e4SJoe Perches				$pointer = "" if (!defined $pointer);
3924a1ce18e4SJoe Perches
3925a1ce18e4SJoe Perches				if (WARN("UNSPECIFIED_INT",
3926a1ce18e4SJoe Perches					 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3927a1ce18e4SJoe Perches				    $fix) {
3928a1ce18e4SJoe Perches					my $decl = trim($sign) . " int ";
3929207a8e84SJoe Perches					my $comp_pointer = $pointer;
3930207a8e84SJoe Perches					$comp_pointer =~ s/\s//g;
3931207a8e84SJoe Perches					$decl .= $comp_pointer;
3932207a8e84SJoe Perches					$decl = rtrim($decl) if ($var eq "");
3933207a8e84SJoe Perches					$fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
3934a1ce18e4SJoe Perches				}
3935a1ce18e4SJoe Perches			}
3936a1ce18e4SJoe Perches		}
3937a1ce18e4SJoe Perches
3938653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher.
39397429c690SAndy Whitcroft		if ($dbg_type) {
39407429c690SAndy Whitcroft			if ($line =~ /^.\s*$Declare\s*$/) {
3941000d1cc1SJoe Perches				ERROR("TEST_TYPE",
3942000d1cc1SJoe Perches				      "TEST: is type\n" . $herecurr);
39437429c690SAndy Whitcroft			} elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3944000d1cc1SJoe Perches				ERROR("TEST_NOT_TYPE",
3945000d1cc1SJoe Perches				      "TEST: is not type ($1 is)\n". $herecurr);
39467429c690SAndy Whitcroft			}
3947653d4876SAndy Whitcroft			next;
3948653d4876SAndy Whitcroft		}
3949a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher.
3950a1ef277eSAndy Whitcroft		if ($dbg_attr) {
39519360b0e5SAndy Whitcroft			if ($line =~ /^.\s*$Modifier\s*$/) {
3952000d1cc1SJoe Perches				ERROR("TEST_ATTR",
3953000d1cc1SJoe Perches				      "TEST: is attr\n" . $herecurr);
39549360b0e5SAndy Whitcroft			} elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3955000d1cc1SJoe Perches				ERROR("TEST_NOT_ATTR",
3956000d1cc1SJoe Perches				      "TEST: is not attr ($1 is)\n". $herecurr);
3957a1ef277eSAndy Whitcroft			}
3958a1ef277eSAndy Whitcroft			next;
3959a1ef277eSAndy Whitcroft		}
3960653d4876SAndy Whitcroft
3961f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line
396299423c20SAndy Whitcroft		if ($line =~ /^.\s*{/ &&
396399423c20SAndy Whitcroft		    $prevline =~ /(?:^|[^=])=\s*$/) {
3964d752fcc8SJoe Perches			if (ERROR("OPEN_BRACE",
3965d752fcc8SJoe Perches				  "that open brace { should be on the previous line\n" . $hereprev) &&
3966f2d7e4d4SJoe Perches			    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3967f2d7e4d4SJoe Perches				fix_delete_line($fixlinenr - 1, $prevrawline);
3968f2d7e4d4SJoe Perches				fix_delete_line($fixlinenr, $rawline);
3969d752fcc8SJoe Perches				my $fixedline = $prevrawline;
3970d752fcc8SJoe Perches				$fixedline =~ s/\s*=\s*$/ = {/;
3971f2d7e4d4SJoe Perches				fix_insert_line($fixlinenr, $fixedline);
3972d752fcc8SJoe Perches				$fixedline = $line;
39738d81ae05SCyril Bur				$fixedline =~ s/^(.\s*)\{\s*/$1/;
3974f2d7e4d4SJoe Perches				fix_insert_line($fixlinenr, $fixedline);
3975d752fcc8SJoe Perches			}
3976f0a594c1SAndy Whitcroft		}
3977f0a594c1SAndy Whitcroft
397800df344fSAndy Whitcroft#
397900df344fSAndy Whitcroft# Checks which are anchored on the added line.
398000df344fSAndy Whitcroft#
398100df344fSAndy Whitcroft
3982653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line)
3983c45dcabdSAndy Whitcroft		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3984653d4876SAndy Whitcroft			my $path = $1;
3985653d4876SAndy Whitcroft			if ($path =~ m{//}) {
3986000d1cc1SJoe Perches				ERROR("MALFORMED_INCLUDE",
3987495e9d84SJoe Perches				      "malformed #include filename\n" . $herecurr);
3988495e9d84SJoe Perches			}
3989495e9d84SJoe Perches			if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3990495e9d84SJoe Perches				ERROR("UAPI_INCLUDE",
3991495e9d84SJoe Perches				      "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
3992653d4876SAndy Whitcroft			}
3993653d4876SAndy Whitcroft		}
3994653d4876SAndy Whitcroft
399500df344fSAndy Whitcroft# no C99 // comments
399600df344fSAndy Whitcroft		if ($line =~ m{//}) {
39973705ce5bSJoe Perches			if (ERROR("C99_COMMENTS",
39983705ce5bSJoe Perches				  "do not use C99 // comments\n" . $herecurr) &&
39993705ce5bSJoe Perches			    $fix) {
4000194f66fcSJoe Perches				my $line = $fixed[$fixlinenr];
40013705ce5bSJoe Perches				if ($line =~ /\/\/(.*)$/) {
40023705ce5bSJoe Perches					my $comment = trim($1);
4003194f66fcSJoe Perches					$fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
40043705ce5bSJoe Perches				}
40053705ce5bSJoe Perches			}
400600df344fSAndy Whitcroft		}
400700df344fSAndy Whitcroft		# Remove C99 comments.
40080a920b5bSAndy Whitcroft		$line =~ s@//.*@@;
40096c72ffaaSAndy Whitcroft		$opline =~ s@//.*@@;
40100a920b5bSAndy Whitcroft
40112b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
40122b474a1aSAndy Whitcroft# the whole statement.
40132b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n";
40142b474a1aSAndy Whitcroft		if (defined $realline_next &&
40152b474a1aSAndy Whitcroft		    exists $lines[$realline_next - 1] &&
40162b474a1aSAndy Whitcroft		    !defined $suppress_export{$realline_next} &&
40172b474a1aSAndy Whitcroft		    ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
40182b474a1aSAndy Whitcroft		     $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
40193cbf62dfSAndy Whitcroft			# Handle definitions which produce identifiers with
40203cbf62dfSAndy Whitcroft			# a prefix:
40213cbf62dfSAndy Whitcroft			#   XXX(foo);
40223cbf62dfSAndy Whitcroft			#   EXPORT_SYMBOL(something_foo);
4023653d4876SAndy Whitcroft			my $name = $1;
402487a53877SAndy Whitcroft			if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
40253cbf62dfSAndy Whitcroft			    $name =~ /^${Ident}_$2/) {
40263cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n";
40273cbf62dfSAndy Whitcroft				$suppress_export{$realline_next} = 1;
40283cbf62dfSAndy Whitcroft
40293cbf62dfSAndy Whitcroft			} elsif ($stat !~ /(?:
40302b474a1aSAndy Whitcroft				\n.}\s*$|
403148012058SAndy Whitcroft				^.DEFINE_$Ident\(\Q$name\E\)|
403248012058SAndy Whitcroft				^.DECLARE_$Ident\(\Q$name\E\)|
403348012058SAndy Whitcroft				^.LIST_HEAD\(\Q$name\E\)|
40342b474a1aSAndy Whitcroft				^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
40352b474a1aSAndy Whitcroft				\b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
403648012058SAndy Whitcroft			    )/x) {
40372b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
40382b474a1aSAndy Whitcroft				$suppress_export{$realline_next} = 2;
40392b474a1aSAndy Whitcroft			} else {
40402b474a1aSAndy Whitcroft				$suppress_export{$realline_next} = 1;
40410a920b5bSAndy Whitcroft			}
40420a920b5bSAndy Whitcroft		}
40432b474a1aSAndy Whitcroft		if (!defined $suppress_export{$linenr} &&
40442b474a1aSAndy Whitcroft		    $prevline =~ /^.\s*$/ &&
40452b474a1aSAndy Whitcroft		    ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
40462b474a1aSAndy Whitcroft		     $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
40472b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n";
40482b474a1aSAndy Whitcroft			$suppress_export{$linenr} = 2;
40492b474a1aSAndy Whitcroft		}
40502b474a1aSAndy Whitcroft		if (defined $suppress_export{$linenr} &&
40512b474a1aSAndy Whitcroft		    $suppress_export{$linenr} == 2) {
4052000d1cc1SJoe Perches			WARN("EXPORT_SYMBOL",
4053000d1cc1SJoe Perches			     "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
40542b474a1aSAndy Whitcroft		}
40550a920b5bSAndy Whitcroft
40565150bda4SJoe Eloff# check for global initialisers.
40576d32f7a3SJoe Perches		if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
4058d5e616fcSJoe Perches			if (ERROR("GLOBAL_INITIALISERS",
40596d32f7a3SJoe Perches				  "do not initialise globals to $1\n" . $herecurr) &&
4060d5e616fcSJoe Perches			    $fix) {
40616d32f7a3SJoe Perches				$fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
4062d5e616fcSJoe Perches			}
4063f0a594c1SAndy Whitcroft		}
40640a920b5bSAndy Whitcroft# check for static initialisers.
40656d32f7a3SJoe Perches		if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
4066d5e616fcSJoe Perches			if (ERROR("INITIALISED_STATIC",
40676d32f7a3SJoe Perches				  "do not initialise statics to $1\n" .
4068d5e616fcSJoe Perches				      $herecurr) &&
4069d5e616fcSJoe Perches			    $fix) {
40706d32f7a3SJoe Perches				$fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
4071d5e616fcSJoe Perches			}
40720a920b5bSAndy Whitcroft		}
40730a920b5bSAndy Whitcroft
40741813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned
40751813087dSJoe Perches		while ($sline =~ m{(\b$TypeMisordered\b)}g) {
40761813087dSJoe Perches			my $tmp = trim($1);
40771813087dSJoe Perches			WARN("MISORDERED_TYPE",
40781813087dSJoe Perches			     "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
40791813087dSJoe Perches		}
40801813087dSJoe Perches
4081809e082eSJoe Perches# check for unnecessary <signed> int declarations of short/long/long long
4082809e082eSJoe Perches		while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) {
4083809e082eSJoe Perches			my $type = trim($1);
4084809e082eSJoe Perches			next if ($type !~ /\bint\b/);
4085809e082eSJoe Perches			next if ($type !~ /\b(?:short|long\s+long|long)\b/);
4086809e082eSJoe Perches			my $new_type = $type;
4087809e082eSJoe Perches			$new_type =~ s/\b\s*int\s*\b/ /;
4088809e082eSJoe Perches			$new_type =~ s/\b\s*(?:un)?signed\b\s*/ /;
4089809e082eSJoe Perches			$new_type =~ s/^const\s+//;
4090809e082eSJoe Perches			$new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/);
4091809e082eSJoe Perches			$new_type = "const $new_type" if ($type =~ /^const\b/);
4092809e082eSJoe Perches			$new_type =~ s/\s+/ /g;
4093809e082eSJoe Perches			$new_type = trim($new_type);
4094809e082eSJoe Perches			if (WARN("UNNECESSARY_INT",
4095809e082eSJoe Perches				 "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) &&
4096809e082eSJoe Perches			    $fix) {
4097809e082eSJoe Perches				$fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/;
4098809e082eSJoe Perches			}
4099809e082eSJoe Perches		}
4100809e082eSJoe Perches
4101cb710ecaSJoe Perches# check for static const char * arrays.
4102cb710ecaSJoe Perches		if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
4103000d1cc1SJoe Perches			WARN("STATIC_CONST_CHAR_ARRAY",
4104000d1cc1SJoe Perches			     "static const char * array should probably be static const char * const\n" .
4105cb710ecaSJoe Perches				$herecurr);
4106cb710ecaSJoe Perches		}
4107cb710ecaSJoe Perches
410877b8c0a8SJoe Perches# check for initialized const char arrays that should be static const
410977b8c0a8SJoe Perches		if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
411077b8c0a8SJoe Perches			if (WARN("STATIC_CONST_CHAR_ARRAY",
411177b8c0a8SJoe Perches				 "const array should probably be static const\n" . $herecurr) &&
411277b8c0a8SJoe Perches			    $fix) {
411377b8c0a8SJoe Perches				$fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/;
411477b8c0a8SJoe Perches			}
411577b8c0a8SJoe Perches		}
411677b8c0a8SJoe Perches
4117cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations.
4118cb710ecaSJoe Perches		if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
4119000d1cc1SJoe Perches			WARN("STATIC_CONST_CHAR_ARRAY",
4120000d1cc1SJoe Perches			     "static char array declaration should probably be static const char\n" .
4121cb710ecaSJoe Perches				$herecurr);
4122cb710ecaSJoe Perches		}
4123cb710ecaSJoe Perches
4124ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type
4125ab7e23f3SJoe Perches		if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
4126ab7e23f3SJoe Perches			my $found = $1;
4127ab7e23f3SJoe Perches			if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
4128ab7e23f3SJoe Perches				WARN("CONST_CONST",
4129ab7e23f3SJoe Perches				     "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
4130ab7e23f3SJoe Perches			} elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
4131ab7e23f3SJoe Perches				WARN("CONST_CONST",
4132ab7e23f3SJoe Perches				     "'const $found const' should probably be 'const $found'\n" . $herecurr);
4133ab7e23f3SJoe Perches			}
4134ab7e23f3SJoe Perches		}
4135ab7e23f3SJoe Perches
41369b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations.
41379b0fa60dSJoe Perches		if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
41389b0fa60dSJoe Perches			WARN("STATIC_CONST_CHAR_ARRAY",
41399b0fa60dSJoe Perches			     "char * array declaration might be better as static const\n" .
41409b0fa60dSJoe Perches				$herecurr);
41419b0fa60dSJoe Perches               }
41429b0fa60dSJoe Perches
4143b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
4144b598b670SJoe Perches		if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
4145b598b670SJoe Perches			my $array = $1;
4146b598b670SJoe Perches			if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
4147b598b670SJoe Perches				my $array_div = $1;
4148b598b670SJoe Perches				if (WARN("ARRAY_SIZE",
4149b598b670SJoe Perches					 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
4150b598b670SJoe Perches				    $fix) {
4151b598b670SJoe Perches					$fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
4152b598b670SJoe Perches				}
4153b598b670SJoe Perches			}
4154b598b670SJoe Perches		}
4155b598b670SJoe Perches
4156b36190c5SJoe Perches# check for function declarations without arguments like "int foo()"
415716b7f3c8SJoe Perches		if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) {
4158b36190c5SJoe Perches			if (ERROR("FUNCTION_WITHOUT_ARGS",
4159b36190c5SJoe Perches				  "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
4160b36190c5SJoe Perches			    $fix) {
4161194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
4162b36190c5SJoe Perches			}
4163b36190c5SJoe Perches		}
4164b36190c5SJoe Perches
4165653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations
4166653d4876SAndy Whitcroft# make sense.
4167653d4876SAndy Whitcroft		if ($line =~ /\btypedef\s/ &&
41688054576dSAndy Whitcroft		    $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
4169c45dcabdSAndy Whitcroft		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
41708ed22cadSAndy Whitcroft		    $line !~ /\b$typeTypedefs\b/ &&
417146d832f5SMichael S. Tsirkin		    $line !~ /\b__bitwise\b/) {
4172000d1cc1SJoe Perches			WARN("NEW_TYPEDEFS",
4173000d1cc1SJoe Perches			     "do not add new typedefs\n" . $herecurr);
41740a920b5bSAndy Whitcroft		}
41750a920b5bSAndy Whitcroft
41760a920b5bSAndy Whitcroft# * goes on variable not on type
417765863862SAndy Whitcroft		# (char*[ const])
4178bfcb2cc7SAndy Whitcroft		while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
4179bfcb2cc7SAndy Whitcroft			#print "AA<$1>\n";
41803705ce5bSJoe Perches			my ($ident, $from, $to) = ($1, $2, $2);
4181d8aaf121SAndy Whitcroft
418265863862SAndy Whitcroft			# Should start with a space.
418365863862SAndy Whitcroft			$to =~ s/^(\S)/ $1/;
418465863862SAndy Whitcroft			# Should not end with a space.
418565863862SAndy Whitcroft			$to =~ s/\s+$//;
418665863862SAndy Whitcroft			# '*'s should not have spaces between.
4187f9a0b3d1SAndy Whitcroft			while ($to =~ s/\*\s+\*/\*\*/) {
418865863862SAndy Whitcroft			}
4189d8aaf121SAndy Whitcroft
41903705ce5bSJoe Perches##			print "1: from<$from> to<$to> ident<$ident>\n";
419165863862SAndy Whitcroft			if ($from ne $to) {
41923705ce5bSJoe Perches				if (ERROR("POINTER_LOCATION",
41933705ce5bSJoe Perches					  "\"(foo$from)\" should be \"(foo$to)\"\n" .  $herecurr) &&
41943705ce5bSJoe Perches				    $fix) {
41953705ce5bSJoe Perches					my $sub_from = $ident;
41963705ce5bSJoe Perches					my $sub_to = $ident;
41973705ce5bSJoe Perches					$sub_to =~ s/\Q$from\E/$to/;
4198194f66fcSJoe Perches					$fixed[$fixlinenr] =~
41993705ce5bSJoe Perches					    s@\Q$sub_from\E@$sub_to@;
42003705ce5bSJoe Perches				}
420165863862SAndy Whitcroft			}
4202bfcb2cc7SAndy Whitcroft		}
4203bfcb2cc7SAndy Whitcroft		while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
4204bfcb2cc7SAndy Whitcroft			#print "BB<$1>\n";
42053705ce5bSJoe Perches			my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
4206d8aaf121SAndy Whitcroft
420765863862SAndy Whitcroft			# Should start with a space.
420865863862SAndy Whitcroft			$to =~ s/^(\S)/ $1/;
420965863862SAndy Whitcroft			# Should not end with a space.
421065863862SAndy Whitcroft			$to =~ s/\s+$//;
421165863862SAndy Whitcroft			# '*'s should not have spaces between.
4212f9a0b3d1SAndy Whitcroft			while ($to =~ s/\*\s+\*/\*\*/) {
421365863862SAndy Whitcroft			}
421465863862SAndy Whitcroft			# Modifiers should have spaces.
421565863862SAndy Whitcroft			$to =~ s/(\b$Modifier$)/$1 /;
421665863862SAndy Whitcroft
42173705ce5bSJoe Perches##			print "2: from<$from> to<$to> ident<$ident>\n";
4218667026e7SAndy Whitcroft			if ($from ne $to && $ident !~ /^$Modifier$/) {
42193705ce5bSJoe Perches				if (ERROR("POINTER_LOCATION",
42203705ce5bSJoe Perches					  "\"foo${from}bar\" should be \"foo${to}bar\"\n" .  $herecurr) &&
42213705ce5bSJoe Perches				    $fix) {
42223705ce5bSJoe Perches
42233705ce5bSJoe Perches					my $sub_from = $match;
42243705ce5bSJoe Perches					my $sub_to = $match;
42253705ce5bSJoe Perches					$sub_to =~ s/\Q$from\E/$to/;
4226194f66fcSJoe Perches					$fixed[$fixlinenr] =~
42273705ce5bSJoe Perches					    s@\Q$sub_from\E@$sub_to@;
42283705ce5bSJoe Perches				}
422965863862SAndy Whitcroft			}
42300a920b5bSAndy Whitcroft		}
42310a920b5bSAndy Whitcroft
42329d3e3c70SJoe Perches# avoid BUG() or BUG_ON()
42339d3e3c70SJoe Perches		if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
42340675a8fbSJean Delvare			my $msg_level = \&WARN;
42350675a8fbSJean Delvare			$msg_level = \&CHK if ($file);
42360675a8fbSJean Delvare			&{$msg_level}("AVOID_BUG",
42379d3e3c70SJoe Perches				      "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
42389d3e3c70SJoe Perches		}
42390a920b5bSAndy Whitcroft
42409d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE
42418905a67cSAndy Whitcroft		if ($line =~ /\bLINUX_VERSION_CODE\b/) {
4242000d1cc1SJoe Perches			WARN("LINUX_VERSION_CODE",
4243000d1cc1SJoe Perches			     "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
42448905a67cSAndy Whitcroft		}
42458905a67cSAndy Whitcroft
424617441227SJoe Perches# check for uses of printk_ratelimit
424717441227SJoe Perches		if ($line =~ /\bprintk_ratelimit\s*\(/) {
4248000d1cc1SJoe Perches			WARN("PRINTK_RATELIMITED",
4249000d1cc1SJoe Perches			     "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
425017441227SJoe Perches		}
425117441227SJoe Perches
4252eeef5733SJoe Perches# printk should use KERN_* levels
4253eeef5733SJoe Perches		if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
4254000d1cc1SJoe Perches			WARN("PRINTK_WITHOUT_KERN_LEVEL",
4255eeef5733SJoe Perches			     "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
425600df344fSAndy Whitcroft		}
42570a920b5bSAndy Whitcroft
4258243f3803SJoe Perches		if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
4259243f3803SJoe Perches			my $orig = $1;
4260243f3803SJoe Perches			my $level = lc($orig);
4261243f3803SJoe Perches			$level = "warn" if ($level eq "warning");
42628f26b837SJoe Perches			my $level2 = $level;
42638f26b837SJoe Perches			$level2 = "dbg" if ($level eq "debug");
4264243f3803SJoe Perches			WARN("PREFER_PR_LEVEL",
4265daa8b059SYogesh Chaudhari			     "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(...  to printk(KERN_$orig ...\n" . $herecurr);
4266243f3803SJoe Perches		}
4267243f3803SJoe Perches
4268dc139313SJoe Perches		if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
4269dc139313SJoe Perches			my $orig = $1;
4270dc139313SJoe Perches			my $level = lc($orig);
4271dc139313SJoe Perches			$level = "warn" if ($level eq "warning");
4272dc139313SJoe Perches			$level = "dbg" if ($level eq "debug");
4273dc139313SJoe Perches			WARN("PREFER_DEV_LEVEL",
4274dc139313SJoe Perches			     "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
4275dc139313SJoe Perches		}
4276dc139313SJoe Perches
4277*8020b253SNicolas Boichat# trace_printk should not be used in production code.
4278*8020b253SNicolas Boichat		if ($line =~ /\b(trace_printk|trace_puts|ftrace_vprintk)\s*\(/) {
4279*8020b253SNicolas Boichat			WARN("TRACE_PRINTK",
4280*8020b253SNicolas Boichat			     "Do not use $1() in production code (this can be ignored if built only with a debug config option)\n" . $herecurr);
4281*8020b253SNicolas Boichat		}
4282*8020b253SNicolas Boichat
428391c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else.  This will have a small
428491c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at
428591c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning.
428691c9afafSAndy Lutomirski		if ($line =~ /\bENOSYS\b/) {
428791c9afafSAndy Lutomirski			WARN("ENOSYS",
428891c9afafSAndy Lutomirski			     "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
428991c9afafSAndy Lutomirski		}
429091c9afafSAndy Lutomirski
42916b9ea5ffSJakub Kicinski# ENOTSUPP is not a standard error code and should be avoided in new patches.
42926b9ea5ffSJakub Kicinski# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP.
42936b9ea5ffSJakub Kicinski# Similarly to ENOSYS warning a small number of false positives is expected.
42946b9ea5ffSJakub Kicinski		if (!$file && $line =~ /\bENOTSUPP\b/) {
42956b9ea5ffSJakub Kicinski			if (WARN("ENOTSUPP",
42966b9ea5ffSJakub Kicinski				 "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) &&
42976b9ea5ffSJakub Kicinski			    $fix) {
42986b9ea5ffSJakub Kicinski				$fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/;
42996b9ea5ffSJakub Kicinski			}
43006b9ea5ffSJakub Kicinski		}
43016b9ea5ffSJakub Kicinski
4302653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while,
4303653d4876SAndy Whitcroft# or if closed on same line
43045b57980dSJoe Perches		if ($perl_version_ok &&
43052d453e3bSJoe Perches		    $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
43062d453e3bSJoe Perches		    $sline !~ /\#\s*define\b.*do\s*\{/ &&
43072d453e3bSJoe Perches		    $sline !~ /}/) {
43088d182478SJoe Perches			if (ERROR("OPEN_BRACE",
43092d453e3bSJoe Perches				  "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
43108d182478SJoe Perches			    $fix) {
43118d182478SJoe Perches				fix_delete_line($fixlinenr, $rawline);
43128d182478SJoe Perches				my $fixed_line = $rawline;
43138d182478SJoe Perches				$fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
43148d182478SJoe Perches				my $line1 = $1;
43158d182478SJoe Perches				my $line2 = $2;
43168d182478SJoe Perches				fix_insert_line($fixlinenr, ltrim($line1));
43178d182478SJoe Perches				fix_insert_line($fixlinenr, "\+{");
43188d182478SJoe Perches				if ($line2 !~ /^\s*$/) {
43198d182478SJoe Perches					fix_insert_line($fixlinenr, "\+\t" . trim($line2));
43208d182478SJoe Perches				}
43218d182478SJoe Perches			}
43220a920b5bSAndy Whitcroft		}
4323653d4876SAndy Whitcroft
43248905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line.
43258905a67cSAndy Whitcroft		if ($line =~ /^.\s*{/ &&
43268905a67cSAndy Whitcroft		    $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
43278d182478SJoe Perches			if (ERROR("OPEN_BRACE",
43288d182478SJoe Perches				  "open brace '{' following $1 go on the same line\n" . $hereprev) &&
43298d182478SJoe Perches			    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
43308d182478SJoe Perches				fix_delete_line($fixlinenr - 1, $prevrawline);
43318d182478SJoe Perches				fix_delete_line($fixlinenr, $rawline);
43328d182478SJoe Perches				my $fixedline = rtrim($prevrawline) . " {";
43338d182478SJoe Perches				fix_insert_line($fixlinenr, $fixedline);
43348d182478SJoe Perches				$fixedline = $rawline;
43358d81ae05SCyril Bur				$fixedline =~ s/^(.\s*)\{\s*/$1\t/;
43368d182478SJoe Perches				if ($fixedline !~ /^\+\s*$/) {
43378d182478SJoe Perches					fix_insert_line($fixlinenr, $fixedline);
43388d182478SJoe Perches				}
43398d182478SJoe Perches			}
43408905a67cSAndy Whitcroft		}
43418905a67cSAndy Whitcroft
43420c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition
43433705ce5bSJoe Perches		if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
43443705ce5bSJoe Perches			if (WARN("SPACING",
43453705ce5bSJoe Perches				 "missing space after $1 definition\n" . $herecurr) &&
43463705ce5bSJoe Perches			    $fix) {
4347194f66fcSJoe Perches				$fixed[$fixlinenr] =~
43483705ce5bSJoe Perches				    s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
43493705ce5bSJoe Perches			}
43500c73b4ebSAndy Whitcroft		}
43510c73b4ebSAndy Whitcroft
435231070b5dSJoe Perches# Function pointer declarations
435331070b5dSJoe Perches# check spacing between type, funcptr, and args
435431070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)"
435591f72e9cSJoe Perches		if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
435631070b5dSJoe Perches			my $declare = $1;
435731070b5dSJoe Perches			my $pre_pointer_space = $2;
435831070b5dSJoe Perches			my $post_pointer_space = $3;
435931070b5dSJoe Perches			my $funcname = $4;
436031070b5dSJoe Perches			my $post_funcname_space = $5;
436131070b5dSJoe Perches			my $pre_args_space = $6;
436231070b5dSJoe Perches
436391f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type
436491f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types
436591f72e9cSJoe Perches# don't need a space so don't warn for those.
436691f72e9cSJoe Perches			my $post_declare_space = "";
436791f72e9cSJoe Perches			if ($declare =~ /(\s+)$/) {
436891f72e9cSJoe Perches				$post_declare_space = $1;
436991f72e9cSJoe Perches				$declare = rtrim($declare);
437091f72e9cSJoe Perches			}
437191f72e9cSJoe Perches			if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
437231070b5dSJoe Perches				WARN("SPACING",
437331070b5dSJoe Perches				     "missing space after return type\n" . $herecurr);
437491f72e9cSJoe Perches				$post_declare_space = " ";
437531070b5dSJoe Perches			}
437631070b5dSJoe Perches
437731070b5dSJoe Perches# unnecessary space "type  (*funcptr)(args...)"
437891f72e9cSJoe Perches# This test is not currently implemented because these declarations are
437991f72e9cSJoe Perches# equivalent to
438091f72e9cSJoe Perches#	int  foo(int bar, ...)
438191f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning.
438291f72e9cSJoe Perches#
438391f72e9cSJoe Perches#			elsif ($declare =~ /\s{2,}$/) {
438491f72e9cSJoe Perches#				WARN("SPACING",
438591f72e9cSJoe Perches#				     "Multiple spaces after return type\n" . $herecurr);
438691f72e9cSJoe Perches#			}
438731070b5dSJoe Perches
438831070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)"
438931070b5dSJoe Perches			if (defined $pre_pointer_space &&
439031070b5dSJoe Perches			    $pre_pointer_space =~ /^\s/) {
439131070b5dSJoe Perches				WARN("SPACING",
439231070b5dSJoe Perches				     "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
439331070b5dSJoe Perches			}
439431070b5dSJoe Perches
439531070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)"
439631070b5dSJoe Perches			if (defined $post_pointer_space &&
439731070b5dSJoe Perches			    $post_pointer_space =~ /^\s/) {
439831070b5dSJoe Perches				WARN("SPACING",
439931070b5dSJoe Perches				     "Unnecessary space before function pointer name\n" . $herecurr);
440031070b5dSJoe Perches			}
440131070b5dSJoe Perches
440231070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)"
440331070b5dSJoe Perches			if (defined $post_funcname_space &&
440431070b5dSJoe Perches			    $post_funcname_space =~ /^\s/) {
440531070b5dSJoe Perches				WARN("SPACING",
440631070b5dSJoe Perches				     "Unnecessary space after function pointer name\n" . $herecurr);
440731070b5dSJoe Perches			}
440831070b5dSJoe Perches
440931070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)"
441031070b5dSJoe Perches			if (defined $pre_args_space &&
441131070b5dSJoe Perches			    $pre_args_space =~ /^\s/) {
441231070b5dSJoe Perches				WARN("SPACING",
441331070b5dSJoe Perches				     "Unnecessary space before function pointer arguments\n" . $herecurr);
441431070b5dSJoe Perches			}
441531070b5dSJoe Perches
441631070b5dSJoe Perches			if (show_type("SPACING") && $fix) {
4417194f66fcSJoe Perches				$fixed[$fixlinenr] =~
441891f72e9cSJoe Perches				    s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
441931070b5dSJoe Perches			}
442031070b5dSJoe Perches		}
442131070b5dSJoe Perches
44228d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed:
44238d31cfceSAndy Whitcroft#  1. with a type on the left -- int [] a;
4424fe2a7dbcSAndy Whitcroft#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4425fe2a7dbcSAndy Whitcroft#  3. inside a curly brace -- = { [0...10] = 5 }
44268d31cfceSAndy Whitcroft		while ($line =~ /(.*?\s)\[/g) {
44278d31cfceSAndy Whitcroft			my ($where, $prefix) = ($-[1], $1);
44288d31cfceSAndy Whitcroft			if ($prefix !~ /$Type\s+$/ &&
4429fe2a7dbcSAndy Whitcroft			    ($where != 0 || $prefix !~ /^.\s+$/) &&
443038dca988SHeinrich Schuchardt			    $prefix !~ /[{,:]\s+$/) {
44313705ce5bSJoe Perches				if (ERROR("BRACKET_SPACE",
44323705ce5bSJoe Perches					  "space prohibited before open square bracket '['\n" . $herecurr) &&
44333705ce5bSJoe Perches				    $fix) {
4434194f66fcSJoe Perches				    $fixed[$fixlinenr] =~
44353705ce5bSJoe Perches					s/^(\+.*?)\s+\[/$1\[/;
44363705ce5bSJoe Perches				}
44378d31cfceSAndy Whitcroft			}
44388d31cfceSAndy Whitcroft		}
44398d31cfceSAndy Whitcroft
4440f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses.
44416c72ffaaSAndy Whitcroft		while ($line =~ /($Ident)\s+\(/g) {
4442c2fdda0dSAndy Whitcroft			my $name = $1;
4443773647a0SAndy Whitcroft			my $ctx_before = substr($line, 0, $-[1]);
4444773647a0SAndy Whitcroft			my $ctx = "$ctx_before$name";
4445c2fdda0dSAndy Whitcroft
4446c2fdda0dSAndy Whitcroft			# Ignore those directives where spaces _are_ permitted.
4447773647a0SAndy Whitcroft			if ($name =~ /^(?:
4448773647a0SAndy Whitcroft				if|for|while|switch|return|case|
4449773647a0SAndy Whitcroft				volatile|__volatile__|
4450773647a0SAndy Whitcroft				__attribute__|format|__extension__|
4451773647a0SAndy Whitcroft				asm|__asm__)$/x)
4452773647a0SAndy Whitcroft			{
4453c2fdda0dSAndy Whitcroft			# cpp #define statements have non-optional spaces, ie
4454c2fdda0dSAndy Whitcroft			# if there is a space between the name and the open
4455c2fdda0dSAndy Whitcroft			# parenthesis it is simply not a parameter group.
4456c45dcabdSAndy Whitcroft			} elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
4457773647a0SAndy Whitcroft
4458773647a0SAndy Whitcroft			# cpp #elif statement condition may start with a (
4459c45dcabdSAndy Whitcroft			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
4460c2fdda0dSAndy Whitcroft
4461c2fdda0dSAndy Whitcroft			# If this whole things ends with a type its most
4462c2fdda0dSAndy Whitcroft			# likely a typedef for a function.
4463773647a0SAndy Whitcroft			} elsif ($ctx =~ /$Type$/) {
4464c2fdda0dSAndy Whitcroft
4465c2fdda0dSAndy Whitcroft			} else {
44663705ce5bSJoe Perches				if (WARN("SPACING",
44673705ce5bSJoe Perches					 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
44683705ce5bSJoe Perches					     $fix) {
4469194f66fcSJoe Perches					$fixed[$fixlinenr] =~
44703705ce5bSJoe Perches					    s/\b$name\s+\(/$name\(/;
44713705ce5bSJoe Perches				}
4472f0a594c1SAndy Whitcroft			}
44736c72ffaaSAndy Whitcroft		}
44749a4cad4eSEric Nelson
4475653d4876SAndy Whitcroft# Check operator spacing.
44760a920b5bSAndy Whitcroft		if (!($line=~/\#\s*include/)) {
44773705ce5bSJoe Perches			my $fixed_line = "";
44783705ce5bSJoe Perches			my $line_fixed = 0;
44793705ce5bSJoe Perches
44809c0ca6f9SAndy Whitcroft			my $ops = qr{
44819c0ca6f9SAndy Whitcroft				<<=|>>=|<=|>=|==|!=|
44829c0ca6f9SAndy Whitcroft				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
44839c0ca6f9SAndy Whitcroft				=>|->|<<|>>|<|>|=|!|~|
44841f65f947SAndy Whitcroft				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
448584731623SJoe Perches				\?:|\?|:
44869c0ca6f9SAndy Whitcroft			}x;
4487cf655043SAndy Whitcroft			my @elements = split(/($ops|;)/, $opline);
44883705ce5bSJoe Perches
44893705ce5bSJoe Perches##			print("element count: <" . $#elements . ">\n");
44903705ce5bSJoe Perches##			foreach my $el (@elements) {
44913705ce5bSJoe Perches##				print("el: <$el>\n");
44923705ce5bSJoe Perches##			}
44933705ce5bSJoe Perches
44943705ce5bSJoe Perches			my @fix_elements = ();
449500df344fSAndy Whitcroft			my $off = 0;
44966c72ffaaSAndy Whitcroft
44973705ce5bSJoe Perches			foreach my $el (@elements) {
44983705ce5bSJoe Perches				push(@fix_elements, substr($rawline, $off, length($el)));
44993705ce5bSJoe Perches				$off += length($el);
45003705ce5bSJoe Perches			}
45013705ce5bSJoe Perches
45023705ce5bSJoe Perches			$off = 0;
45033705ce5bSJoe Perches
45046c72ffaaSAndy Whitcroft			my $blank = copy_spacing($opline);
4505b34c648bSJoe Perches			my $last_after = -1;
45066c72ffaaSAndy Whitcroft
45070a920b5bSAndy Whitcroft			for (my $n = 0; $n < $#elements; $n += 2) {
45083705ce5bSJoe Perches
45093705ce5bSJoe Perches				my $good = $fix_elements[$n] . $fix_elements[$n + 1];
45103705ce5bSJoe Perches
45113705ce5bSJoe Perches##				print("n: <$n> good: <$good>\n");
45123705ce5bSJoe Perches
45134a0df2efSAndy Whitcroft				$off += length($elements[$n]);
45144a0df2efSAndy Whitcroft
451525985edcSLucas De Marchi				# Pick up the preceding and succeeding characters.
4516773647a0SAndy Whitcroft				my $ca = substr($opline, 0, $off);
4517773647a0SAndy Whitcroft				my $cc = '';
4518773647a0SAndy Whitcroft				if (length($opline) >= ($off + length($elements[$n + 1]))) {
4519773647a0SAndy Whitcroft					$cc = substr($opline, $off + length($elements[$n + 1]));
4520773647a0SAndy Whitcroft				}
4521773647a0SAndy Whitcroft				my $cb = "$ca$;$cc";
4522773647a0SAndy Whitcroft
45234a0df2efSAndy Whitcroft				my $a = '';
45244a0df2efSAndy Whitcroft				$a = 'V' if ($elements[$n] ne '');
45254a0df2efSAndy Whitcroft				$a = 'W' if ($elements[$n] =~ /\s$/);
4526cf655043SAndy Whitcroft				$a = 'C' if ($elements[$n] =~ /$;$/);
45274a0df2efSAndy Whitcroft				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
45284a0df2efSAndy Whitcroft				$a = 'O' if ($elements[$n] eq '');
4529773647a0SAndy Whitcroft				$a = 'E' if ($ca =~ /^\s*$/);
45304a0df2efSAndy Whitcroft
45310a920b5bSAndy Whitcroft				my $op = $elements[$n + 1];
45324a0df2efSAndy Whitcroft
45334a0df2efSAndy Whitcroft				my $c = '';
45340a920b5bSAndy Whitcroft				if (defined $elements[$n + 2]) {
45354a0df2efSAndy Whitcroft					$c = 'V' if ($elements[$n + 2] ne '');
45364a0df2efSAndy Whitcroft					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
4537cf655043SAndy Whitcroft					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
45384a0df2efSAndy Whitcroft					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
45394a0df2efSAndy Whitcroft					$c = 'O' if ($elements[$n + 2] eq '');
45408b1b3378SAndy Whitcroft					$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
45414a0df2efSAndy Whitcroft				} else {
45424a0df2efSAndy Whitcroft					$c = 'E';
45430a920b5bSAndy Whitcroft				}
45440a920b5bSAndy Whitcroft
45454a0df2efSAndy Whitcroft				my $ctx = "${a}x${c}";
45464a0df2efSAndy Whitcroft
45474a0df2efSAndy Whitcroft				my $at = "(ctx:$ctx)";
45484a0df2efSAndy Whitcroft
45496c72ffaaSAndy Whitcroft				my $ptr = substr($blank, 0, $off) . "^";
4550de7d4f0eSAndy Whitcroft				my $hereptr = "$hereline$ptr\n";
45510a920b5bSAndy Whitcroft
455274048ed8SAndy Whitcroft				# Pull out the value of this operator.
45536c72ffaaSAndy Whitcroft				my $op_type = substr($curr_values, $off + 1, 1);
45540a920b5bSAndy Whitcroft
45551f65f947SAndy Whitcroft				# Get the full operator variant.
45561f65f947SAndy Whitcroft				my $opv = $op . substr($curr_vars, $off, 1);
45571f65f947SAndy Whitcroft
455813214adfSAndy Whitcroft				# Ignore operators passed as parameters.
455913214adfSAndy Whitcroft				if ($op_type ne 'V' &&
4560d7fe8065SSam Bobroff				    $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
456113214adfSAndy Whitcroft
4562cf655043SAndy Whitcroft#				# Ignore comments
4563cf655043SAndy Whitcroft#				} elsif ($op =~ /^$;+$/) {
456413214adfSAndy Whitcroft
4565d8aaf121SAndy Whitcroft				# ; should have either the end of line or a space or \ after it
456613214adfSAndy Whitcroft				} elsif ($op eq ';') {
4567cf655043SAndy Whitcroft					if ($ctx !~ /.x[WEBC]/ &&
4568cf655043SAndy Whitcroft					    $cc !~ /^\\/ && $cc !~ /^;/) {
45693705ce5bSJoe Perches						if (ERROR("SPACING",
45703705ce5bSJoe Perches							  "space required after that '$op' $at\n" . $hereptr)) {
4571b34c648bSJoe Perches							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
45723705ce5bSJoe Perches							$line_fixed = 1;
45733705ce5bSJoe Perches						}
4574d8aaf121SAndy Whitcroft					}
4575d8aaf121SAndy Whitcroft
4576d8aaf121SAndy Whitcroft				# // is a comment
4577d8aaf121SAndy Whitcroft				} elsif ($op eq '//') {
45780a920b5bSAndy Whitcroft
4579b00e4814SJoe Perches				#   :   when part of a bitfield
4580b00e4814SJoe Perches				} elsif ($opv eq ':B') {
4581b00e4814SJoe Perches					# skip the bitfield test for now
4582b00e4814SJoe Perches
45831f65f947SAndy Whitcroft				# No spaces for:
45841f65f947SAndy Whitcroft				#   ->
4585b00e4814SJoe Perches				} elsif ($op eq '->') {
45864a0df2efSAndy Whitcroft					if ($ctx =~ /Wx.|.xW/) {
45873705ce5bSJoe Perches						if (ERROR("SPACING",
45883705ce5bSJoe Perches							  "spaces prohibited around that '$op' $at\n" . $hereptr)) {
4589b34c648bSJoe Perches							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
45903705ce5bSJoe Perches							if (defined $fix_elements[$n + 2]) {
45913705ce5bSJoe Perches								$fix_elements[$n + 2] =~ s/^\s+//;
45923705ce5bSJoe Perches							}
4593b34c648bSJoe Perches							$line_fixed = 1;
45943705ce5bSJoe Perches						}
45950a920b5bSAndy Whitcroft					}
45960a920b5bSAndy Whitcroft
45972381097bSJoe Perches				# , must not have a space before and must have a space on the right.
45980a920b5bSAndy Whitcroft				} elsif ($op eq ',') {
45992381097bSJoe Perches					my $rtrim_before = 0;
46002381097bSJoe Perches					my $space_after = 0;
46012381097bSJoe Perches					if ($ctx =~ /Wx./) {
46022381097bSJoe Perches						if (ERROR("SPACING",
46032381097bSJoe Perches							  "space prohibited before that '$op' $at\n" . $hereptr)) {
46042381097bSJoe Perches							$line_fixed = 1;
46052381097bSJoe Perches							$rtrim_before = 1;
46062381097bSJoe Perches						}
46072381097bSJoe Perches					}
4608cf655043SAndy Whitcroft					if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
46093705ce5bSJoe Perches						if (ERROR("SPACING",
46103705ce5bSJoe Perches							  "space required after that '$op' $at\n" . $hereptr)) {
46113705ce5bSJoe Perches							$line_fixed = 1;
4612b34c648bSJoe Perches							$last_after = $n;
46132381097bSJoe Perches							$space_after = 1;
46142381097bSJoe Perches						}
46152381097bSJoe Perches					}
46162381097bSJoe Perches					if ($rtrim_before || $space_after) {
46172381097bSJoe Perches						if ($rtrim_before) {
46182381097bSJoe Perches							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
46192381097bSJoe Perches						} else {
46202381097bSJoe Perches							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
46212381097bSJoe Perches						}
46222381097bSJoe Perches						if ($space_after) {
46232381097bSJoe Perches							$good .= " ";
46243705ce5bSJoe Perches						}
46250a920b5bSAndy Whitcroft					}
46260a920b5bSAndy Whitcroft
46279c0ca6f9SAndy Whitcroft				# '*' as part of a type definition -- reported already.
462874048ed8SAndy Whitcroft				} elsif ($opv eq '*_') {
46299c0ca6f9SAndy Whitcroft					#warn "'*' is part of type\n";
46309c0ca6f9SAndy Whitcroft
46319c0ca6f9SAndy Whitcroft				# unary operators should have a space before and
46329c0ca6f9SAndy Whitcroft				# none after.  May be left adjacent to another
46339c0ca6f9SAndy Whitcroft				# unary operator, or a cast
46349c0ca6f9SAndy Whitcroft				} elsif ($op eq '!' || $op eq '~' ||
463574048ed8SAndy Whitcroft					 $opv eq '*U' || $opv eq '-U' ||
46360d413866SAndy Whitcroft					 $opv eq '&U' || $opv eq '&&U') {
4637cf655043SAndy Whitcroft					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
46383705ce5bSJoe Perches						if (ERROR("SPACING",
46393705ce5bSJoe Perches							  "space required before that '$op' $at\n" . $hereptr)) {
4640b34c648bSJoe Perches							if ($n != $last_after + 2) {
4641b34c648bSJoe Perches								$good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
46423705ce5bSJoe Perches								$line_fixed = 1;
46433705ce5bSJoe Perches							}
46440a920b5bSAndy Whitcroft						}
4645b34c648bSJoe Perches					}
4646a3340b35SAndy Whitcroft					if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
4647171ae1a4SAndy Whitcroft						# A unary '*' may be const
4648171ae1a4SAndy Whitcroft
4649171ae1a4SAndy Whitcroft					} elsif ($ctx =~ /.xW/) {
46503705ce5bSJoe Perches						if (ERROR("SPACING",
46513705ce5bSJoe Perches							  "space prohibited after that '$op' $at\n" . $hereptr)) {
4652b34c648bSJoe Perches							$good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
46533705ce5bSJoe Perches							if (defined $fix_elements[$n + 2]) {
46543705ce5bSJoe Perches								$fix_elements[$n + 2] =~ s/^\s+//;
46553705ce5bSJoe Perches							}
4656b34c648bSJoe Perches							$line_fixed = 1;
46573705ce5bSJoe Perches						}
46580a920b5bSAndy Whitcroft					}
46590a920b5bSAndy Whitcroft
46600a920b5bSAndy Whitcroft				# unary ++ and unary -- are allowed no space on one side.
46610a920b5bSAndy Whitcroft				} elsif ($op eq '++' or $op eq '--') {
4662773647a0SAndy Whitcroft					if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
46633705ce5bSJoe Perches						if (ERROR("SPACING",
46643705ce5bSJoe Perches							  "space required one side of that '$op' $at\n" . $hereptr)) {
4665b34c648bSJoe Perches							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
46663705ce5bSJoe Perches							$line_fixed = 1;
46673705ce5bSJoe Perches						}
46680a920b5bSAndy Whitcroft					}
4669773647a0SAndy Whitcroft					if ($ctx =~ /Wx[BE]/ ||
4670773647a0SAndy Whitcroft					    ($ctx =~ /Wx./ && $cc =~ /^;/)) {
46713705ce5bSJoe Perches						if (ERROR("SPACING",
46723705ce5bSJoe Perches							  "space prohibited before that '$op' $at\n" . $hereptr)) {
4673b34c648bSJoe Perches							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
46743705ce5bSJoe Perches							$line_fixed = 1;
46753705ce5bSJoe Perches						}
4676653d4876SAndy Whitcroft					}
4677773647a0SAndy Whitcroft					if ($ctx =~ /ExW/) {
46783705ce5bSJoe Perches						if (ERROR("SPACING",
46793705ce5bSJoe Perches							  "space prohibited after that '$op' $at\n" . $hereptr)) {
4680b34c648bSJoe Perches							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
46813705ce5bSJoe Perches							if (defined $fix_elements[$n + 2]) {
46823705ce5bSJoe Perches								$fix_elements[$n + 2] =~ s/^\s+//;
4683773647a0SAndy Whitcroft							}
4684b34c648bSJoe Perches							$line_fixed = 1;
46853705ce5bSJoe Perches						}
46863705ce5bSJoe Perches					}
46870a920b5bSAndy Whitcroft
46880a920b5bSAndy Whitcroft				# << and >> may either have or not have spaces both sides
46899c0ca6f9SAndy Whitcroft				} elsif ($op eq '<<' or $op eq '>>' or
46909c0ca6f9SAndy Whitcroft					 $op eq '&' or $op eq '^' or $op eq '|' or
46919c0ca6f9SAndy Whitcroft					 $op eq '+' or $op eq '-' or
4692c2fdda0dSAndy Whitcroft					 $op eq '*' or $op eq '/' or
4693c2fdda0dSAndy Whitcroft					 $op eq '%')
46940a920b5bSAndy Whitcroft				{
4695d2e025f3SJoe Perches					if ($check) {
4696d2e025f3SJoe Perches						if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4697d2e025f3SJoe Perches							if (CHK("SPACING",
4698d2e025f3SJoe Perches								"spaces preferred around that '$op' $at\n" . $hereptr)) {
4699d2e025f3SJoe Perches								$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4700d2e025f3SJoe Perches								$fix_elements[$n + 2] =~ s/^\s+//;
4701d2e025f3SJoe Perches								$line_fixed = 1;
4702d2e025f3SJoe Perches							}
4703d2e025f3SJoe Perches						} elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4704d2e025f3SJoe Perches							if (CHK("SPACING",
4705d2e025f3SJoe Perches								"space preferred before that '$op' $at\n" . $hereptr)) {
4706d2e025f3SJoe Perches								$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4707d2e025f3SJoe Perches								$line_fixed = 1;
4708d2e025f3SJoe Perches							}
4709d2e025f3SJoe Perches						}
4710d2e025f3SJoe Perches					} elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
47113705ce5bSJoe Perches						if (ERROR("SPACING",
47123705ce5bSJoe Perches							  "need consistent spacing around '$op' $at\n" . $hereptr)) {
4713b34c648bSJoe Perches							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4714b34c648bSJoe Perches							if (defined $fix_elements[$n + 2]) {
4715b34c648bSJoe Perches								$fix_elements[$n + 2] =~ s/^\s+//;
4716b34c648bSJoe Perches							}
47173705ce5bSJoe Perches							$line_fixed = 1;
47183705ce5bSJoe Perches						}
47190a920b5bSAndy Whitcroft					}
47200a920b5bSAndy Whitcroft
47211f65f947SAndy Whitcroft				# A colon needs no spaces before when it is
47221f65f947SAndy Whitcroft				# terminating a case value or a label.
47231f65f947SAndy Whitcroft				} elsif ($opv eq ':C' || $opv eq ':L') {
47241f65f947SAndy Whitcroft					if ($ctx =~ /Wx./) {
47253705ce5bSJoe Perches						if (ERROR("SPACING",
47263705ce5bSJoe Perches							  "space prohibited before that '$op' $at\n" . $hereptr)) {
4727b34c648bSJoe Perches							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
47283705ce5bSJoe Perches							$line_fixed = 1;
47293705ce5bSJoe Perches						}
47301f65f947SAndy Whitcroft					}
47311f65f947SAndy Whitcroft
47320a920b5bSAndy Whitcroft				# All the others need spaces both sides.
4733cf655043SAndy Whitcroft				} elsif ($ctx !~ /[EWC]x[CWE]/) {
47341f65f947SAndy Whitcroft					my $ok = 0;
47351f65f947SAndy Whitcroft
473622f2a2efSAndy Whitcroft					# Ignore email addresses <foo@bar>
47371f65f947SAndy Whitcroft					if (($op eq '<' &&
47381f65f947SAndy Whitcroft					     $cc =~ /^\S+\@\S+>/) ||
47391f65f947SAndy Whitcroft					    ($op eq '>' &&
47401f65f947SAndy Whitcroft					     $ca =~ /<\S+\@\S+$/))
47411f65f947SAndy Whitcroft					{
47421f65f947SAndy Whitcroft						$ok = 1;
47431f65f947SAndy Whitcroft					}
47441f65f947SAndy Whitcroft
4745e0df7e1fSJoe Perches					# for asm volatile statements
4746e0df7e1fSJoe Perches					# ignore a colon with another
4747e0df7e1fSJoe Perches					# colon immediately before or after
4748e0df7e1fSJoe Perches					if (($op eq ':') &&
4749e0df7e1fSJoe Perches					    ($ca =~ /:$/ || $cc =~ /^:/)) {
4750e0df7e1fSJoe Perches						$ok = 1;
4751e0df7e1fSJoe Perches					}
4752e0df7e1fSJoe Perches
475384731623SJoe Perches					# messages are ERROR, but ?: are CHK
47541f65f947SAndy Whitcroft					if ($ok == 0) {
47550675a8fbSJean Delvare						my $msg_level = \&ERROR;
47560675a8fbSJean Delvare						$msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
475784731623SJoe Perches
47580675a8fbSJean Delvare						if (&{$msg_level}("SPACING",
47593705ce5bSJoe Perches								  "spaces required around that '$op' $at\n" . $hereptr)) {
4760b34c648bSJoe Perches							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4761b34c648bSJoe Perches							if (defined $fix_elements[$n + 2]) {
4762b34c648bSJoe Perches								$fix_elements[$n + 2] =~ s/^\s+//;
4763b34c648bSJoe Perches							}
47643705ce5bSJoe Perches							$line_fixed = 1;
47653705ce5bSJoe Perches						}
47660a920b5bSAndy Whitcroft					}
476722f2a2efSAndy Whitcroft				}
47684a0df2efSAndy Whitcroft				$off += length($elements[$n + 1]);
47693705ce5bSJoe Perches
47703705ce5bSJoe Perches##				print("n: <$n> GOOD: <$good>\n");
47713705ce5bSJoe Perches
47723705ce5bSJoe Perches				$fixed_line = $fixed_line . $good;
47730a920b5bSAndy Whitcroft			}
47743705ce5bSJoe Perches
47753705ce5bSJoe Perches			if (($#elements % 2) == 0) {
47763705ce5bSJoe Perches				$fixed_line = $fixed_line . $fix_elements[$#elements];
47773705ce5bSJoe Perches			}
47783705ce5bSJoe Perches
4779194f66fcSJoe Perches			if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4780194f66fcSJoe Perches				$fixed[$fixlinenr] = $fixed_line;
47813705ce5bSJoe Perches			}
47823705ce5bSJoe Perches
47833705ce5bSJoe Perches
47840a920b5bSAndy Whitcroft		}
47850a920b5bSAndy Whitcroft
4786786b6326SJoe Perches# check for whitespace before a non-naked semicolon
4787d2e248e7SJoe Perches		if ($line =~ /^\+.*\S\s+;\s*$/) {
4788786b6326SJoe Perches			if (WARN("SPACING",
4789786b6326SJoe Perches				 "space prohibited before semicolon\n" . $herecurr) &&
4790786b6326SJoe Perches			    $fix) {
4791194f66fcSJoe Perches				1 while $fixed[$fixlinenr] =~
4792786b6326SJoe Perches				    s/^(\+.*\S)\s+;/$1;/;
4793786b6326SJoe Perches			}
4794786b6326SJoe Perches		}
4795786b6326SJoe Perches
4796f0a594c1SAndy Whitcroft# check for multiple assignments
4797f0a594c1SAndy Whitcroft		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
4798000d1cc1SJoe Perches			CHK("MULTIPLE_ASSIGNMENTS",
4799000d1cc1SJoe Perches			    "multiple assignments should be avoided\n" . $herecurr);
4800f0a594c1SAndy Whitcroft		}
4801f0a594c1SAndy Whitcroft
480222f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration
480322f2a2efSAndy Whitcroft## # continuation.
480422f2a2efSAndy Whitcroft## 		if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
480522f2a2efSAndy Whitcroft## 		    $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
480622f2a2efSAndy Whitcroft##
480722f2a2efSAndy Whitcroft## 			# Remove any bracketed sections to ensure we do not
480822f2a2efSAndy Whitcroft## 			# falsly report the parameters of functions.
480922f2a2efSAndy Whitcroft## 			my $ln = $line;
481022f2a2efSAndy Whitcroft## 			while ($ln =~ s/\([^\(\)]*\)//g) {
481122f2a2efSAndy Whitcroft## 			}
481222f2a2efSAndy Whitcroft## 			if ($ln =~ /,/) {
4813000d1cc1SJoe Perches## 				WARN("MULTIPLE_DECLARATION",
4814000d1cc1SJoe Perches##				     "declaring multiple variables together should be avoided\n" . $herecurr);
481522f2a2efSAndy Whitcroft## 			}
481622f2a2efSAndy Whitcroft## 		}
4817f0a594c1SAndy Whitcroft
48180a920b5bSAndy Whitcroft#need space before brace following if, while, etc
48196b8c69e4SGeyslan G. Bem		if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
48206ad724e2SMichal Zylowski		    $line =~ /\b(?:else|do)\{/) {
48213705ce5bSJoe Perches			if (ERROR("SPACING",
48223705ce5bSJoe Perches				  "space required before the open brace '{'\n" . $herecurr) &&
48233705ce5bSJoe Perches			    $fix) {
48246ad724e2SMichal Zylowski				$fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/;
48253705ce5bSJoe Perches			}
4826de7d4f0eSAndy Whitcroft		}
4827de7d4f0eSAndy Whitcroft
4828c4a62ef9SJoe Perches## # check for blank lines before declarations
4829c4a62ef9SJoe Perches##		if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4830c4a62ef9SJoe Perches##		    $prevrawline =~ /^.\s*$/) {
4831c4a62ef9SJoe Perches##			WARN("SPACING",
4832c4a62ef9SJoe Perches##			     "No blank lines before declarations\n" . $hereprev);
4833c4a62ef9SJoe Perches##		}
4834c4a62ef9SJoe Perches##
4835c4a62ef9SJoe Perches
4836de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything
4837de7d4f0eSAndy Whitcroft# on the line
483894fb9845SJoe Perches		if ($line =~ /}(?!(?:,|;|\)|\}))\S/) {
4839d5e616fcSJoe Perches			if (ERROR("SPACING",
4840d5e616fcSJoe Perches				  "space required after that close brace '}'\n" . $herecurr) &&
4841d5e616fcSJoe Perches			    $fix) {
4842194f66fcSJoe Perches				$fixed[$fixlinenr] =~
4843d5e616fcSJoe Perches				    s/}((?!(?:,|;|\)))\S)/} $1/;
4844d5e616fcSJoe Perches			}
48450a920b5bSAndy Whitcroft		}
48460a920b5bSAndy Whitcroft
484722f2a2efSAndy Whitcroft# check spacing on square brackets
484822f2a2efSAndy Whitcroft		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
48493705ce5bSJoe Perches			if (ERROR("SPACING",
48503705ce5bSJoe Perches				  "space prohibited after that open square bracket '['\n" . $herecurr) &&
48513705ce5bSJoe Perches			    $fix) {
4852194f66fcSJoe Perches				$fixed[$fixlinenr] =~
48533705ce5bSJoe Perches				    s/\[\s+/\[/;
48543705ce5bSJoe Perches			}
485522f2a2efSAndy Whitcroft		}
485622f2a2efSAndy Whitcroft		if ($line =~ /\s\]/) {
48573705ce5bSJoe Perches			if (ERROR("SPACING",
48583705ce5bSJoe Perches				  "space prohibited before that close square bracket ']'\n" . $herecurr) &&
48593705ce5bSJoe Perches			    $fix) {
4860194f66fcSJoe Perches				$fixed[$fixlinenr] =~
48613705ce5bSJoe Perches				    s/\s+\]/\]/;
48623705ce5bSJoe Perches			}
486322f2a2efSAndy Whitcroft		}
486422f2a2efSAndy Whitcroft
4865c45dcabdSAndy Whitcroft# check spacing on parentheses
48669c0ca6f9SAndy Whitcroft		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
48679c0ca6f9SAndy Whitcroft		    $line !~ /for\s*\(\s+;/) {
48683705ce5bSJoe Perches			if (ERROR("SPACING",
48693705ce5bSJoe Perches				  "space prohibited after that open parenthesis '('\n" . $herecurr) &&
48703705ce5bSJoe Perches			    $fix) {
4871194f66fcSJoe Perches				$fixed[$fixlinenr] =~
48723705ce5bSJoe Perches				    s/\(\s+/\(/;
48733705ce5bSJoe Perches			}
487422f2a2efSAndy Whitcroft		}
487513214adfSAndy Whitcroft		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
4876c45dcabdSAndy Whitcroft		    $line !~ /for\s*\(.*;\s+\)/ &&
4877c45dcabdSAndy Whitcroft		    $line !~ /:\s+\)/) {
48783705ce5bSJoe Perches			if (ERROR("SPACING",
48793705ce5bSJoe Perches				  "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
48803705ce5bSJoe Perches			    $fix) {
4881194f66fcSJoe Perches				$fixed[$fixlinenr] =~
48823705ce5bSJoe Perches				    s/\s+\)/\)/;
48833705ce5bSJoe Perches			}
488422f2a2efSAndy Whitcroft		}
488522f2a2efSAndy Whitcroft
4886e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals
4887e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4888e2826fd0SJoe Perches
4889e2826fd0SJoe Perches		while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
4890ea4acbb1SJoe Perches			my $var = $1;
4891ea4acbb1SJoe Perches			if (CHK("UNNECESSARY_PARENTHESES",
4892ea4acbb1SJoe Perches				"Unnecessary parentheses around $var\n" . $herecurr) &&
4893ea4acbb1SJoe Perches			    $fix) {
4894ea4acbb1SJoe Perches				$fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4895ea4acbb1SJoe Perches			}
4896ea4acbb1SJoe Perches		}
4897ea4acbb1SJoe Perches
4898ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses
4899ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar();
4900ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives
4901ea4acbb1SJoe Perches		if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4902ea4acbb1SJoe Perches			my $var = $2;
4903ea4acbb1SJoe Perches			if (CHK("UNNECESSARY_PARENTHESES",
4904ea4acbb1SJoe Perches				"Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4905ea4acbb1SJoe Perches			    $fix) {
4906ea4acbb1SJoe Perches				my $var2 = deparenthesize($var);
4907ea4acbb1SJoe Perches				$var2 =~ s/\s//g;
4908ea4acbb1SJoe Perches				$fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4909ea4acbb1SJoe Perches			}
4910e2826fd0SJoe Perches		}
4911e2826fd0SJoe Perches
491263b7c73eSJoe Perches# check for unnecessary parentheses around comparisons in if uses
4913a032aa4cSJoe Perches# when !drivers/staging or command-line uses --strict
4914a032aa4cSJoe Perches		if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
49155b57980dSJoe Perches		    $perl_version_ok && defined($stat) &&
491663b7c73eSJoe Perches		    $stat =~ /(^.\s*if\s*($balanced_parens))/) {
491763b7c73eSJoe Perches			my $if_stat = $1;
491863b7c73eSJoe Perches			my $test = substr($2, 1, -1);
491963b7c73eSJoe Perches			my $herectx;
492063b7c73eSJoe Perches			while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
492163b7c73eSJoe Perches				my $match = $1;
492263b7c73eSJoe Perches				# avoid parentheses around potential macro args
492363b7c73eSJoe Perches				next if ($match =~ /^\s*\w+\s*$/);
492463b7c73eSJoe Perches				if (!defined($herectx)) {
492563b7c73eSJoe Perches					$herectx = $here . "\n";
492663b7c73eSJoe Perches					my $cnt = statement_rawlines($if_stat);
492763b7c73eSJoe Perches					for (my $n = 0; $n < $cnt; $n++) {
492863b7c73eSJoe Perches						my $rl = raw_line($linenr, $n);
492963b7c73eSJoe Perches						$herectx .=  $rl . "\n";
493063b7c73eSJoe Perches						last if $rl =~ /^[ \+].*\{/;
493163b7c73eSJoe Perches					}
493263b7c73eSJoe Perches				}
493363b7c73eSJoe Perches				CHK("UNNECESSARY_PARENTHESES",
493463b7c73eSJoe Perches				    "Unnecessary parentheses around '$match'\n" . $herectx);
493563b7c73eSJoe Perches			}
493663b7c73eSJoe Perches		}
493763b7c73eSJoe Perches
49380a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however
49394a0df2efSAndy Whitcroft		if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
49400a920b5bSAndy Whitcroft		   !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
49413705ce5bSJoe Perches			if (WARN("INDENTED_LABEL",
49423705ce5bSJoe Perches				 "labels should not be indented\n" . $herecurr) &&
49433705ce5bSJoe Perches			    $fix) {
4944194f66fcSJoe Perches				$fixed[$fixlinenr] =~
49453705ce5bSJoe Perches				    s/^(.)\s+/$1/;
49463705ce5bSJoe Perches			}
49470a920b5bSAndy Whitcroft		}
49480a920b5bSAndy Whitcroft
494940873abaSJoe Perches# check if a statement with a comma should be two statements like:
495040873abaSJoe Perches#	foo = bar(),	/* comma should be semicolon */
495140873abaSJoe Perches#	bar = baz();
495240873abaSJoe Perches		if (defined($stat) &&
495340873abaSJoe Perches		    $stat =~ /^\+\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*,\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*;\s*$/) {
495440873abaSJoe Perches			my $cnt = statement_rawlines($stat);
495540873abaSJoe Perches			my $herectx = get_stat_here($linenr, $cnt, $here);
495640873abaSJoe Perches			WARN("SUSPECT_COMMA_SEMICOLON",
495740873abaSJoe Perches			     "Possible comma where semicolon could be used\n" . $herectx);
495840873abaSJoe Perches		}
495940873abaSJoe Perches
49605b9553abSJoe Perches# return is not a function
4961507e5141SJoe Perches		if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
4962c45dcabdSAndy Whitcroft			my $spacing = $1;
49635b57980dSJoe Perches			if ($perl_version_ok &&
49645b9553abSJoe Perches			    $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
49655b9553abSJoe Perches				my $value = $1;
49665b9553abSJoe Perches				$value = deparenthesize($value);
49675b9553abSJoe Perches				if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4968000d1cc1SJoe Perches					ERROR("RETURN_PARENTHESES",
4969000d1cc1SJoe Perches					      "return is not a function, parentheses are not required\n" . $herecurr);
49705b9553abSJoe Perches				}
4971c45dcabdSAndy Whitcroft			} elsif ($spacing !~ /\s+/) {
4972000d1cc1SJoe Perches				ERROR("SPACING",
4973000d1cc1SJoe Perches				      "space required before the open parenthesis '('\n" . $herecurr);
4974c45dcabdSAndy Whitcroft			}
4975c45dcabdSAndy Whitcroft		}
4976507e5141SJoe Perches
4977b43ae21bSJoe Perches# unnecessary return in a void function
4978b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return;
4979b43ae21bSJoe Perches# and the line before that not a goto label target like "out:"
4980b43ae21bSJoe Perches		if ($sline =~ /^[ \+]}\s*$/ &&
4981b43ae21bSJoe Perches		    $prevline =~ /^\+\treturn\s*;\s*$/ &&
4982b43ae21bSJoe Perches		    $linenr >= 3 &&
4983b43ae21bSJoe Perches		    $lines[$linenr - 3] =~ /^[ +]/ &&
4984b43ae21bSJoe Perches		    $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
49859819cf25SJoe Perches			WARN("RETURN_VOID",
4986b43ae21bSJoe Perches			     "void function return statements are not generally useful\n" . $hereprev);
49879819cf25SJoe Perches               }
49889819cf25SJoe Perches
4989189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar))
49905b57980dSJoe Perches		if ($perl_version_ok &&
4991189248d8SJoe Perches		    $line =~ /\bif\s*((?:\(\s*){2,})/) {
4992189248d8SJoe Perches			my $openparens = $1;
4993189248d8SJoe Perches			my $count = $openparens =~ tr@\(@\(@;
4994189248d8SJoe Perches			my $msg = "";
4995189248d8SJoe Perches			if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4996189248d8SJoe Perches				my $comp = $4;	#Not $1 because of $LvalOrFunc
4997189248d8SJoe Perches				$msg = " - maybe == should be = ?" if ($comp eq "==");
4998189248d8SJoe Perches				WARN("UNNECESSARY_PARENTHESES",
4999189248d8SJoe Perches				     "Unnecessary parentheses$msg\n" . $herecurr);
5000189248d8SJoe Perches			}
5001189248d8SJoe Perches		}
5002189248d8SJoe Perches
5003c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left
5004c5595fa2SJoe Perches#	avoid cases like "foo + BAR < baz"
5005c5595fa2SJoe Perches#	only fix matches surrounded by parentheses to avoid incorrect
5006c5595fa2SJoe Perches#	conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
50075b57980dSJoe Perches		if ($perl_version_ok &&
5008c5595fa2SJoe Perches		    $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
5009c5595fa2SJoe Perches			my $lead = $1;
5010c5595fa2SJoe Perches			my $const = $2;
5011c5595fa2SJoe Perches			my $comp = $3;
5012c5595fa2SJoe Perches			my $to = $4;
5013c5595fa2SJoe Perches			my $newcomp = $comp;
5014f39e1769SJoe Perches			if ($lead !~ /(?:$Operators|\.)\s*$/ &&
5015c5595fa2SJoe Perches			    $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
5016c5595fa2SJoe Perches			    WARN("CONSTANT_COMPARISON",
5017c5595fa2SJoe Perches				 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
5018c5595fa2SJoe Perches			    $fix) {
5019c5595fa2SJoe Perches				if ($comp eq "<") {
5020c5595fa2SJoe Perches					$newcomp = ">";
5021c5595fa2SJoe Perches				} elsif ($comp eq "<=") {
5022c5595fa2SJoe Perches					$newcomp = ">=";
5023c5595fa2SJoe Perches				} elsif ($comp eq ">") {
5024c5595fa2SJoe Perches					$newcomp = "<";
5025c5595fa2SJoe Perches				} elsif ($comp eq ">=") {
5026c5595fa2SJoe Perches					$newcomp = "<=";
5027c5595fa2SJoe Perches				}
5028c5595fa2SJoe Perches				$fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
5029c5595fa2SJoe Perches			}
5030c5595fa2SJoe Perches		}
5031c5595fa2SJoe Perches
5032f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative
5033f34e4a4fSJoe Perches		if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
503453a3c448SAndy Whitcroft			my $name = $1;
503553a3c448SAndy Whitcroft			if ($name ne 'EOF' && $name ne 'ERROR') {
5036000d1cc1SJoe Perches				WARN("USE_NEGATIVE_ERRNO",
5037f34e4a4fSJoe Perches				     "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
503853a3c448SAndy Whitcroft			}
503953a3c448SAndy Whitcroft		}
5040c45dcabdSAndy Whitcroft
50410a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc
50424a0df2efSAndy Whitcroft		if ($line =~ /\b(if|while|for|switch)\(/) {
50433705ce5bSJoe Perches			if (ERROR("SPACING",
50443705ce5bSJoe Perches				  "space required before the open parenthesis '('\n" . $herecurr) &&
50453705ce5bSJoe Perches			    $fix) {
5046194f66fcSJoe Perches				$fixed[$fixlinenr] =~
50473705ce5bSJoe Perches				    s/\b(if|while|for|switch)\(/$1 \(/;
50483705ce5bSJoe Perches			}
50490a920b5bSAndy Whitcroft		}
50500a920b5bSAndy Whitcroft
5051f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing
5052f5fe35ddSAndy Whitcroft# statements after the conditional.
5053170d3a22SAndy Whitcroft		if ($line =~ /do\s*(?!{)/) {
50543e469cdcSAndy Whitcroft			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
50553e469cdcSAndy Whitcroft				ctx_statement_block($linenr, $realcnt, 0)
50563e469cdcSAndy Whitcroft					if (!defined $stat);
5057170d3a22SAndy Whitcroft			my ($stat_next) = ctx_statement_block($line_nr_next,
5058170d3a22SAndy Whitcroft						$remain_next, $off_next);
5059170d3a22SAndy Whitcroft			$stat_next =~ s/\n./\n /g;
5060170d3a22SAndy Whitcroft			##print "stat<$stat> stat_next<$stat_next>\n";
5061170d3a22SAndy Whitcroft
5062170d3a22SAndy Whitcroft			if ($stat_next =~ /^\s*while\b/) {
5063170d3a22SAndy Whitcroft				# If the statement carries leading newlines,
5064170d3a22SAndy Whitcroft				# then count those as offsets.
5065170d3a22SAndy Whitcroft				my ($whitespace) =
5066170d3a22SAndy Whitcroft					($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
5067170d3a22SAndy Whitcroft				my $offset =
5068170d3a22SAndy Whitcroft					statement_rawlines($whitespace) - 1;
5069170d3a22SAndy Whitcroft
5070170d3a22SAndy Whitcroft				$suppress_whiletrailers{$line_nr_next +
5071170d3a22SAndy Whitcroft								$offset} = 1;
5072170d3a22SAndy Whitcroft			}
5073170d3a22SAndy Whitcroft		}
5074170d3a22SAndy Whitcroft		if (!defined $suppress_whiletrailers{$linenr} &&
5075c11230f4SJoe Perches		    defined($stat) && defined($cond) &&
5076170d3a22SAndy Whitcroft		    $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
5077171ae1a4SAndy Whitcroft			my ($s, $c) = ($stat, $cond);
50788905a67cSAndy Whitcroft
5079b53c8e10SAndy Whitcroft			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
508065b64b3bSJoe Perches				if (ERROR("ASSIGN_IN_IF",
508165b64b3bSJoe Perches					  "do not use assignment in if condition\n" . $herecurr) &&
508265b64b3bSJoe Perches				    $fix && $perl_version_ok) {
508365b64b3bSJoe Perches					if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) {
508465b64b3bSJoe Perches						my $space = $1;
508565b64b3bSJoe Perches						my $not = $2;
508665b64b3bSJoe Perches						my $statement = $3;
508765b64b3bSJoe Perches						my $assigned = $4;
508865b64b3bSJoe Perches						my $test = $8;
508965b64b3bSJoe Perches						my $against = $9;
509065b64b3bSJoe Perches						my $brace = $15;
509165b64b3bSJoe Perches						fix_delete_line($fixlinenr, $rawline);
509265b64b3bSJoe Perches						fix_insert_line($fixlinenr, "$space$statement;");
509365b64b3bSJoe Perches						my $newline = "${space}if (";
509465b64b3bSJoe Perches						$newline .= '!' if defined($not);
509565b64b3bSJoe Perches						$newline .= '(' if (defined $not && defined($test) && defined($against));
509665b64b3bSJoe Perches						$newline .= "$assigned";
509765b64b3bSJoe Perches						$newline .= " $test $against" if (defined($test) && defined($against));
509865b64b3bSJoe Perches						$newline .= ')' if (defined $not && defined($test) && defined($against));
509965b64b3bSJoe Perches						$newline .= ')';
510065b64b3bSJoe Perches						$newline .= " {" if (defined($brace));
510165b64b3bSJoe Perches						fix_insert_line($fixlinenr + 1, $newline);
510265b64b3bSJoe Perches					}
510365b64b3bSJoe Perches				}
51048905a67cSAndy Whitcroft			}
51058905a67cSAndy Whitcroft
51068905a67cSAndy Whitcroft			# Find out what is on the end of the line after the
51078905a67cSAndy Whitcroft			# conditional.
5108773647a0SAndy Whitcroft			substr($s, 0, length($c), '');
51098905a67cSAndy Whitcroft			$s =~ s/\n.*//g;
511013214adfSAndy Whitcroft			$s =~ s/$;//g;	# Remove any comments
511153210168SAndy Whitcroft			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
511253210168SAndy Whitcroft			    $c !~ /}\s*while\s*/)
5113773647a0SAndy Whitcroft			{
5114bb44ad39SAndy Whitcroft				# Find out how long the conditional actually is.
5115bb44ad39SAndy Whitcroft				my @newlines = ($c =~ /\n/gs);
5116bb44ad39SAndy Whitcroft				my $cond_lines = 1 + $#newlines;
511742bdf74cSHidetoshi Seto				my $stat_real = '';
5118bb44ad39SAndy Whitcroft
511942bdf74cSHidetoshi Seto				$stat_real = raw_line($linenr, $cond_lines)
512042bdf74cSHidetoshi Seto							. "\n" if ($cond_lines);
5121bb44ad39SAndy Whitcroft				if (defined($stat_real) && $cond_lines > 1) {
5122bb44ad39SAndy Whitcroft					$stat_real = "[...]\n$stat_real";
5123bb44ad39SAndy Whitcroft				}
5124bb44ad39SAndy Whitcroft
5125000d1cc1SJoe Perches				ERROR("TRAILING_STATEMENTS",
5126000d1cc1SJoe Perches				      "trailing statements should be on next line\n" . $herecurr . $stat_real);
51278905a67cSAndy Whitcroft			}
51288905a67cSAndy Whitcroft		}
51298905a67cSAndy Whitcroft
513013214adfSAndy Whitcroft# Check for bitwise tests written as boolean
513113214adfSAndy Whitcroft		if ($line =~ /
513213214adfSAndy Whitcroft			(?:
513313214adfSAndy Whitcroft				(?:\[|\(|\&\&|\|\|)
513413214adfSAndy Whitcroft				\s*0[xX][0-9]+\s*
513513214adfSAndy Whitcroft				(?:\&\&|\|\|)
513613214adfSAndy Whitcroft			|
513713214adfSAndy Whitcroft				(?:\&\&|\|\|)
513813214adfSAndy Whitcroft				\s*0[xX][0-9]+\s*
513913214adfSAndy Whitcroft				(?:\&\&|\|\||\)|\])
514013214adfSAndy Whitcroft			)/x)
514113214adfSAndy Whitcroft		{
5142000d1cc1SJoe Perches			WARN("HEXADECIMAL_BOOLEAN_TEST",
5143000d1cc1SJoe Perches			     "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
514413214adfSAndy Whitcroft		}
514513214adfSAndy Whitcroft
51468905a67cSAndy Whitcroft# if and else should not have general statements after it
514713214adfSAndy Whitcroft		if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
514813214adfSAndy Whitcroft			my $s = $1;
514913214adfSAndy Whitcroft			$s =~ s/$;//g;	# Remove any comments
515013214adfSAndy Whitcroft			if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
5151000d1cc1SJoe Perches				ERROR("TRAILING_STATEMENTS",
5152000d1cc1SJoe Perches				      "trailing statements should be on next line\n" . $herecurr);
51530a920b5bSAndy Whitcroft			}
515413214adfSAndy Whitcroft		}
515539667782SAndy Whitcroft# if should not continue a brace
515639667782SAndy Whitcroft		if ($line =~ /}\s*if\b/) {
5157000d1cc1SJoe Perches			ERROR("TRAILING_STATEMENTS",
5158048b123fSRasmus Villemoes			      "trailing statements should be on next line (or did you mean 'else if'?)\n" .
515939667782SAndy Whitcroft				$herecurr);
516039667782SAndy Whitcroft		}
5161a1080bf8SAndy Whitcroft# case and default should not have general statements after them
5162a1080bf8SAndy Whitcroft		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
5163a1080bf8SAndy Whitcroft		    $line !~ /\G(?:
51643fef12d6SAndy Whitcroft			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
5165a1080bf8SAndy Whitcroft			\s*return\s+
5166a1080bf8SAndy Whitcroft		    )/xg)
5167a1080bf8SAndy Whitcroft		{
5168000d1cc1SJoe Perches			ERROR("TRAILING_STATEMENTS",
5169000d1cc1SJoe Perches			      "trailing statements should be on next line\n" . $herecurr);
5170a1080bf8SAndy Whitcroft		}
51710a920b5bSAndy Whitcroft
51720a920b5bSAndy Whitcroft		# Check for }<nl>else {, these must be at the same
51730a920b5bSAndy Whitcroft		# indent level to be relevant to each other.
51748b8856f4SJoe Perches		if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
51750a920b5bSAndy Whitcroft		    $previndent == $indent) {
51768b8856f4SJoe Perches			if (ERROR("ELSE_AFTER_BRACE",
51778b8856f4SJoe Perches				  "else should follow close brace '}'\n" . $hereprev) &&
51788b8856f4SJoe Perches			    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
51798b8856f4SJoe Perches				fix_delete_line($fixlinenr - 1, $prevrawline);
51808b8856f4SJoe Perches				fix_delete_line($fixlinenr, $rawline);
51818b8856f4SJoe Perches				my $fixedline = $prevrawline;
51828b8856f4SJoe Perches				$fixedline =~ s/}\s*$//;
51838b8856f4SJoe Perches				if ($fixedline !~ /^\+\s*$/) {
51848b8856f4SJoe Perches					fix_insert_line($fixlinenr, $fixedline);
51858b8856f4SJoe Perches				}
51868b8856f4SJoe Perches				$fixedline = $rawline;
51878b8856f4SJoe Perches				$fixedline =~ s/^(.\s*)else/$1} else/;
51888b8856f4SJoe Perches				fix_insert_line($fixlinenr, $fixedline);
51898b8856f4SJoe Perches			}
51900a920b5bSAndy Whitcroft		}
51910a920b5bSAndy Whitcroft
51928b8856f4SJoe Perches		if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
5193c2fdda0dSAndy Whitcroft		    $previndent == $indent) {
5194c2fdda0dSAndy Whitcroft			my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
5195c2fdda0dSAndy Whitcroft
5196c2fdda0dSAndy Whitcroft			# Find out what is on the end of the line after the
5197c2fdda0dSAndy Whitcroft			# conditional.
5198773647a0SAndy Whitcroft			substr($s, 0, length($c), '');
5199c2fdda0dSAndy Whitcroft			$s =~ s/\n.*//g;
5200c2fdda0dSAndy Whitcroft
5201c2fdda0dSAndy Whitcroft			if ($s =~ /^\s*;/) {
52028b8856f4SJoe Perches				if (ERROR("WHILE_AFTER_BRACE",
52038b8856f4SJoe Perches					  "while should follow close brace '}'\n" . $hereprev) &&
52048b8856f4SJoe Perches				    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
52058b8856f4SJoe Perches					fix_delete_line($fixlinenr - 1, $prevrawline);
52068b8856f4SJoe Perches					fix_delete_line($fixlinenr, $rawline);
52078b8856f4SJoe Perches					my $fixedline = $prevrawline;
52088b8856f4SJoe Perches					my $trailing = $rawline;
52098b8856f4SJoe Perches					$trailing =~ s/^\+//;
52108b8856f4SJoe Perches					$trailing = trim($trailing);
52118b8856f4SJoe Perches					$fixedline =~ s/}\s*$/} $trailing/;
52128b8856f4SJoe Perches					fix_insert_line($fixlinenr, $fixedline);
52138b8856f4SJoe Perches				}
5214c2fdda0dSAndy Whitcroft			}
5215c2fdda0dSAndy Whitcroft		}
5216c2fdda0dSAndy Whitcroft
521795e2c602SJoe Perches#Specific variable tests
5218323c1260SJoe Perches		while ($line =~ m{($Constant|$Lval)}g) {
5219323c1260SJoe Perches			my $var = $1;
522095e2c602SJoe Perches
522195e2c602SJoe Perches#CamelCase
5222807bd26cSJoe Perches			if ($var !~ /^$Constant$/ &&
5223be79794bSJoe Perches			    $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
522422735ce8SJoe Perches#Ignore Page<foo> variants
5225807bd26cSJoe Perches			    $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
5226d439e6a5SJoe Perches#Ignore SI style variants like nS, mV and dB
5227d439e6a5SJoe Perches#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
5228d439e6a5SJoe Perches			    $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ &&
5229f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz
5230f5123576SJulius Werner			    $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
52317e781f67SJoe Perches				while ($var =~ m{($Ident)}g) {
52327e781f67SJoe Perches					my $word = $1;
52337e781f67SJoe Perches					next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
5234d8b07710SJoe Perches					if ($check) {
5235d8b07710SJoe Perches						seed_camelcase_includes();
5236d8b07710SJoe Perches						if (!$file && !$camelcase_file_seeded) {
5237d8b07710SJoe Perches							seed_camelcase_file($realfile);
5238d8b07710SJoe Perches							$camelcase_file_seeded = 1;
5239d8b07710SJoe Perches						}
5240d8b07710SJoe Perches					}
52417e781f67SJoe Perches					if (!defined $camelcase{$word}) {
52427e781f67SJoe Perches						$camelcase{$word} = 1;
5243be79794bSJoe Perches						CHK("CAMELCASE",
52447e781f67SJoe Perches						    "Avoid CamelCase: <$word>\n" . $herecurr);
52457e781f67SJoe Perches					}
5246323c1260SJoe Perches				}
5247323c1260SJoe Perches			}
52483445686aSJoe Perches		}
52490a920b5bSAndy Whitcroft
52500a920b5bSAndy Whitcroft#no spaces allowed after \ in define
5251d5e616fcSJoe Perches		if ($line =~ /\#\s*define.*\\\s+$/) {
5252d5e616fcSJoe Perches			if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
5253d5e616fcSJoe Perches				 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
5254d5e616fcSJoe Perches			    $fix) {
5255194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/\s+$//;
5256d5e616fcSJoe Perches			}
52570a920b5bSAndy Whitcroft		}
52580a920b5bSAndy Whitcroft
52590e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
52600e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line)
5261c45dcabdSAndy Whitcroft		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
5262e09dec48SAndy Whitcroft			my $file = "$1.h";
5263e09dec48SAndy Whitcroft			my $checkfile = "include/linux/$file";
5264e09dec48SAndy Whitcroft			if (-f "$root/$checkfile" &&
5265e09dec48SAndy Whitcroft			    $realfile ne $checkfile &&
52667840a94cSWolfram Sang			    $1 !~ /$allowed_asm_includes/)
5267c45dcabdSAndy Whitcroft			{
52680e212e0aSFabian Frederick				my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
52690e212e0aSFabian Frederick				if ($asminclude > 0) {
5270e09dec48SAndy Whitcroft					if ($realfile =~ m{^arch/}) {
5271000d1cc1SJoe Perches						CHK("ARCH_INCLUDE_LINUX",
5272000d1cc1SJoe Perches						    "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5273e09dec48SAndy Whitcroft					} else {
5274000d1cc1SJoe Perches						WARN("INCLUDE_LINUX",
5275000d1cc1SJoe Perches						     "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5276e09dec48SAndy Whitcroft					}
52770a920b5bSAndy Whitcroft				}
52780a920b5bSAndy Whitcroft			}
52790e212e0aSFabian Frederick		}
52800a920b5bSAndy Whitcroft
5281653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the
5282653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed
5283cf655043SAndy Whitcroft# in a known good container
5284b8f96a31SAndy Whitcroft		if ($realfile !~ m@/vmlinux.lds.h$@ &&
5285b8f96a31SAndy Whitcroft		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
5286d8aaf121SAndy Whitcroft			my $ln = $linenr;
5287d8aaf121SAndy Whitcroft			my $cnt = $realcnt;
5288c45dcabdSAndy Whitcroft			my ($off, $dstat, $dcond, $rest);
5289c45dcabdSAndy Whitcroft			my $ctx = '';
529008a2843eSJoe Perches			my $has_flow_statement = 0;
529108a2843eSJoe Perches			my $has_arg_concat = 0;
5292c45dcabdSAndy Whitcroft			($dstat, $dcond, $ln, $cnt, $off) =
5293f74bd194SAndy Whitcroft				ctx_statement_block($linenr, $realcnt, 0);
5294f74bd194SAndy Whitcroft			$ctx = $dstat;
5295c45dcabdSAndy Whitcroft			#print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5296a3bb97a7SAndy Whitcroft			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5297c45dcabdSAndy Whitcroft
529808a2843eSJoe Perches			$has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
529962e15a6dSJoe Perches			$has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
530008a2843eSJoe Perches
5301f59b64bfSJoe Perches			$dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
5302f59b64bfSJoe Perches			my $define_args = $1;
5303f59b64bfSJoe Perches			my $define_stmt = $dstat;
5304f59b64bfSJoe Perches			my @def_args = ();
5305f59b64bfSJoe Perches
5306f59b64bfSJoe Perches			if (defined $define_args && $define_args ne "") {
5307f59b64bfSJoe Perches				$define_args = substr($define_args, 1, length($define_args) - 2);
5308f59b64bfSJoe Perches				$define_args =~ s/\s*//g;
53098c8c45cfSJoe Perches				$define_args =~ s/\\\+?//g;
5310f59b64bfSJoe Perches				@def_args = split(",", $define_args);
5311f59b64bfSJoe Perches			}
5312f59b64bfSJoe Perches
5313292f1a9bSAndy Whitcroft			$dstat =~ s/$;//g;
5314c45dcabdSAndy Whitcroft			$dstat =~ s/\\\n.//g;
5315c45dcabdSAndy Whitcroft			$dstat =~ s/^\s*//s;
5316c45dcabdSAndy Whitcroft			$dstat =~ s/\s*$//s;
5317c45dcabdSAndy Whitcroft
5318c45dcabdSAndy Whitcroft			# Flatten any parentheses and braces
5319bf30d6edSAndy Whitcroft			while ($dstat =~ s/\([^\(\)]*\)/1/ ||
5320bf30d6edSAndy Whitcroft			       $dstat =~ s/\{[^\{\}]*\}/1/ ||
53216b10df42SVladimir Zapolskiy			       $dstat =~ s/.\[[^\[\]]*\]/1/)
5322bf30d6edSAndy Whitcroft			{
5323c45dcabdSAndy Whitcroft			}
5324c45dcabdSAndy Whitcroft
5325342d3d2fSAntonio Borneo			# Flatten any obvious string concatenation.
532633acb54aSJoe Perches			while ($dstat =~ s/($String)\s*$Ident/$1/ ||
532733acb54aSJoe Perches			       $dstat =~ s/$Ident\s*($String)/$1/)
5328e45bab8eSAndy Whitcroft			{
5329e45bab8eSAndy Whitcroft			}
5330e45bab8eSAndy Whitcroft
533142e15293SJoe Perches			# Make asm volatile uses seem like a generic function
533242e15293SJoe Perches			$dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
533342e15293SJoe Perches
5334c45dcabdSAndy Whitcroft			my $exceptions = qr{
5335c45dcabdSAndy Whitcroft				$Declare|
5336c45dcabdSAndy Whitcroft				module_param_named|
5337a0a0a7a9SKees Cook				MODULE_PARM_DESC|
5338c45dcabdSAndy Whitcroft				DECLARE_PER_CPU|
5339c45dcabdSAndy Whitcroft				DEFINE_PER_CPU|
5340383099fdSAndy Whitcroft				__typeof__\(|
534122fd2d3eSStefani Seibold				union|
534222fd2d3eSStefani Seibold				struct|
5343ea71a0a0SAndy Whitcroft				\.$Ident\s*=\s*|
53446b10df42SVladimir Zapolskiy				^\"|\"$|
53456b10df42SVladimir Zapolskiy				^\[
5346c45dcabdSAndy Whitcroft			}x;
53475eaa20b9SAndy Whitcroft			#print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5348f59b64bfSJoe Perches
5349f59b64bfSJoe Perches			$ctx =~ s/\n*$//;
5350f59b64bfSJoe Perches			my $stmt_cnt = statement_rawlines($ctx);
5351e3d95a2aSTobin C. Harding			my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
5352f59b64bfSJoe Perches
5353f74bd194SAndy Whitcroft			if ($dstat ne '' &&
5354f74bd194SAndy Whitcroft			    $dstat !~ /^(?:$Ident|-?$Constant),$/ &&			# 10, // foo(),
5355f74bd194SAndy Whitcroft			    $dstat !~ /^(?:$Ident|-?$Constant);$/ &&			# foo();
53563cc4b1c3SJoe Perches			    $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ &&		# 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5357356fd398SJoe Perches			    $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ &&			# character constants
5358f74bd194SAndy Whitcroft			    $dstat !~ /$exceptions/ &&
5359f74bd194SAndy Whitcroft			    $dstat !~ /^\.$Ident\s*=/ &&				# .foo =
5360e942e2c3SJoe Perches			    $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ &&		# stringification #foo
536172f115f9SAndy Whitcroft			    $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ &&	# do {...} while (...); // do {...} while (...)
5362f74bd194SAndy Whitcroft			    $dstat !~ /^for\s*$Constant$/ &&				# for (...)
5363f74bd194SAndy Whitcroft			    $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ &&	# for (...) bar()
5364f74bd194SAndy Whitcroft			    $dstat !~ /^do\s*{/ &&					# do {...
53654e5d56bdSEddie Kovsky			    $dstat !~ /^\(\{/ &&						# ({...
5366f95a7e6aSJoe Perches			    $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
5367c45dcabdSAndy Whitcroft			{
5368e795556aSJoe Perches				if ($dstat =~ /^\s*if\b/) {
5369e795556aSJoe Perches					ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5370e795556aSJoe Perches					      "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5371e795556aSJoe Perches				} elsif ($dstat =~ /;/) {
5372f74bd194SAndy Whitcroft					ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5373f74bd194SAndy Whitcroft					      "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5374f74bd194SAndy Whitcroft				} else {
5375000d1cc1SJoe Perches					ERROR("COMPLEX_MACRO",
5376388982b5SAndrew Morton					      "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
5377d8aaf121SAndy Whitcroft				}
5378f59b64bfSJoe Perches
5379f59b64bfSJoe Perches			}
53805207649bSJoe Perches
53815207649bSJoe Perches			# Make $define_stmt single line, comment-free, etc
53825207649bSJoe Perches			my @stmt_array = split('\n', $define_stmt);
53835207649bSJoe Perches			my $first = 1;
53845207649bSJoe Perches			$define_stmt = "";
53855207649bSJoe Perches			foreach my $l (@stmt_array) {
53865207649bSJoe Perches				$l =~ s/\\$//;
53875207649bSJoe Perches				if ($first) {
53885207649bSJoe Perches					$define_stmt = $l;
53895207649bSJoe Perches					$first = 0;
53905207649bSJoe Perches				} elsif ($l =~ /^[\+ ]/) {
53915207649bSJoe Perches					$define_stmt .= substr($l, 1);
53925207649bSJoe Perches				}
53935207649bSJoe Perches			}
53945207649bSJoe Perches			$define_stmt =~ s/$;//g;
53955207649bSJoe Perches			$define_stmt =~ s/\s+/ /g;
53965207649bSJoe Perches			$define_stmt = trim($define_stmt);
53975207649bSJoe Perches
5398f59b64bfSJoe Perches# check if any macro arguments are reused (ignore '...' and 'type')
5399f59b64bfSJoe Perches			foreach my $arg (@def_args) {
5400f59b64bfSJoe Perches			        next if ($arg =~ /\.\.\./);
54019192d41aSJoe Perches			        next if ($arg =~ /^type$/i);
54027fe528a2SJoe Perches				my $tmp_stmt = $define_stmt;
54036dba824eSBrendan Jackman				$tmp_stmt =~ s/\b(sizeof|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
54047fe528a2SJoe Perches				$tmp_stmt =~ s/\#+\s*$arg\b//g;
54057fe528a2SJoe Perches				$tmp_stmt =~ s/\b$arg\s*\#\#//g;
5406d41362edSJoe Perches				my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
5407f59b64bfSJoe Perches				if ($use_cnt > 1) {
5408f59b64bfSJoe Perches					CHK("MACRO_ARG_REUSE",
5409f59b64bfSJoe Perches					    "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
5410f59b64bfSJoe Perches				    }
54119192d41aSJoe Perches# check if any macro arguments may have other precedence issues
54127fe528a2SJoe Perches				if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
54139192d41aSJoe Perches				    ((defined($1) && $1 ne ',') ||
54149192d41aSJoe Perches				     (defined($2) && $2 ne ','))) {
54159192d41aSJoe Perches					CHK("MACRO_ARG_PRECEDENCE",
54169192d41aSJoe Perches					    "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
54179192d41aSJoe Perches				}
54180a920b5bSAndy Whitcroft			}
54195023d347SJoe Perches
542008a2843eSJoe Perches# check for macros with flow control, but without ## concatenation
542108a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those
542208a2843eSJoe Perches			if ($has_flow_statement && !$has_arg_concat) {
542308a2843eSJoe Perches				my $cnt = statement_rawlines($ctx);
5424e3d95a2aSTobin C. Harding				my $herectx = get_stat_here($linenr, $cnt, $here);
542508a2843eSJoe Perches
542608a2843eSJoe Perches				WARN("MACRO_WITH_FLOW_CONTROL",
542708a2843eSJoe Perches				     "Macros with flow control statements should be avoided\n" . "$herectx");
542808a2843eSJoe Perches			}
542908a2843eSJoe Perches
5430481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm
54315023d347SJoe Perches
54325023d347SJoe Perches		} else {
54335023d347SJoe Perches			if ($prevline !~ /^..*\\$/ &&
5434481eb486SJoe Perches			    $line !~ /^\+\s*\#.*\\$/ &&		# preprocessor
5435481eb486SJoe Perches			    $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ &&	# asm
54365023d347SJoe Perches			    $line =~ /^\+.*\\$/) {
54375023d347SJoe Perches				WARN("LINE_CONTINUATIONS",
54385023d347SJoe Perches				     "Avoid unnecessary line continuations\n" . $herecurr);
54395023d347SJoe Perches			}
5440653d4876SAndy Whitcroft		}
54410a920b5bSAndy Whitcroft
5442b13edf7fSJoe Perches# do {} while (0) macro tests:
5443b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop,
5444b13edf7fSJoe Perches# macro should not end with a semicolon
54455b57980dSJoe Perches		if ($perl_version_ok &&
5446b13edf7fSJoe Perches		    $realfile !~ m@/vmlinux.lds.h$@ &&
5447b13edf7fSJoe Perches		    $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5448b13edf7fSJoe Perches			my $ln = $linenr;
5449b13edf7fSJoe Perches			my $cnt = $realcnt;
5450b13edf7fSJoe Perches			my ($off, $dstat, $dcond, $rest);
5451b13edf7fSJoe Perches			my $ctx = '';
5452b13edf7fSJoe Perches			($dstat, $dcond, $ln, $cnt, $off) =
5453b13edf7fSJoe Perches				ctx_statement_block($linenr, $realcnt, 0);
5454b13edf7fSJoe Perches			$ctx = $dstat;
5455b13edf7fSJoe Perches
5456b13edf7fSJoe Perches			$dstat =~ s/\\\n.//g;
54571b36b201SJoe Perches			$dstat =~ s/$;/ /g;
5458b13edf7fSJoe Perches
5459b13edf7fSJoe Perches			if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5460b13edf7fSJoe Perches				my $stmts = $2;
5461b13edf7fSJoe Perches				my $semis = $3;
5462b13edf7fSJoe Perches
5463b13edf7fSJoe Perches				$ctx =~ s/\n*$//;
5464b13edf7fSJoe Perches				my $cnt = statement_rawlines($ctx);
5465e3d95a2aSTobin C. Harding				my $herectx = get_stat_here($linenr, $cnt, $here);
5466b13edf7fSJoe Perches
5467ac8e97f8SJoe Perches				if (($stmts =~ tr/;/;/) == 1 &&
5468ac8e97f8SJoe Perches				    $stmts !~ /^\s*(if|while|for|switch)\b/) {
5469b13edf7fSJoe Perches					WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5470b13edf7fSJoe Perches					     "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5471b13edf7fSJoe Perches				}
5472b13edf7fSJoe Perches				if (defined $semis && $semis ne "") {
5473b13edf7fSJoe Perches					WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5474b13edf7fSJoe Perches					     "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5475b13edf7fSJoe Perches				}
5476f5ef95b1SJoe Perches			} elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5477f5ef95b1SJoe Perches				$ctx =~ s/\n*$//;
5478f5ef95b1SJoe Perches				my $cnt = statement_rawlines($ctx);
5479e3d95a2aSTobin C. Harding				my $herectx = get_stat_here($linenr, $cnt, $here);
5480f5ef95b1SJoe Perches
5481f5ef95b1SJoe Perches				WARN("TRAILING_SEMICOLON",
5482f5ef95b1SJoe Perches				     "macros should not use a trailing semicolon\n" . "$herectx");
5483b13edf7fSJoe Perches			}
5484b13edf7fSJoe Perches		}
5485b13edf7fSJoe Perches
5486f0a594c1SAndy Whitcroft# check for redundant bracing round if etc
548713214adfSAndy Whitcroft		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
548813214adfSAndy Whitcroft			my ($level, $endln, @chunks) =
5489cf655043SAndy Whitcroft				ctx_statement_full($linenr, $realcnt, 1);
549013214adfSAndy Whitcroft			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5491cf655043SAndy Whitcroft			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5492cf655043SAndy Whitcroft			if ($#chunks > 0 && $level == 0) {
5493aad4f614SJoe Perches				my @allowed = ();
5494aad4f614SJoe Perches				my $allow = 0;
549513214adfSAndy Whitcroft				my $seen = 0;
5496773647a0SAndy Whitcroft				my $herectx = $here . "\n";
5497cf655043SAndy Whitcroft				my $ln = $linenr - 1;
549813214adfSAndy Whitcroft				for my $chunk (@chunks) {
549913214adfSAndy Whitcroft					my ($cond, $block) = @{$chunk};
550013214adfSAndy Whitcroft
5501773647a0SAndy Whitcroft					# If the condition carries leading newlines, then count those as offsets.
5502773647a0SAndy Whitcroft					my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5503773647a0SAndy Whitcroft					my $offset = statement_rawlines($whitespace) - 1;
5504773647a0SAndy Whitcroft
5505aad4f614SJoe Perches					$allowed[$allow] = 0;
5506773647a0SAndy Whitcroft					#print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5507773647a0SAndy Whitcroft
5508773647a0SAndy Whitcroft					# We have looked at and allowed this specific line.
5509773647a0SAndy Whitcroft					$suppress_ifbraces{$ln + $offset} = 1;
5510773647a0SAndy Whitcroft
5511773647a0SAndy Whitcroft					$herectx .= "$rawlines[$ln + $offset]\n[...]\n";
5512cf655043SAndy Whitcroft					$ln += statement_rawlines($block) - 1;
5513cf655043SAndy Whitcroft
5514773647a0SAndy Whitcroft					substr($block, 0, length($cond), '');
551513214adfSAndy Whitcroft
551613214adfSAndy Whitcroft					$seen++ if ($block =~ /^\s*{/);
551713214adfSAndy Whitcroft
5518aad4f614SJoe Perches					#print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5519cf655043SAndy Whitcroft					if (statement_lines($cond) > 1) {
5520cf655043SAndy Whitcroft						#print "APW: ALLOWED: cond<$cond>\n";
5521aad4f614SJoe Perches						$allowed[$allow] = 1;
552213214adfSAndy Whitcroft					}
552313214adfSAndy Whitcroft					if ($block =~/\b(?:if|for|while)\b/) {
5524cf655043SAndy Whitcroft						#print "APW: ALLOWED: block<$block>\n";
5525aad4f614SJoe Perches						$allowed[$allow] = 1;
552613214adfSAndy Whitcroft					}
5527cf655043SAndy Whitcroft					if (statement_block_size($block) > 1) {
5528cf655043SAndy Whitcroft						#print "APW: ALLOWED: lines block<$block>\n";
5529aad4f614SJoe Perches						$allowed[$allow] = 1;
553013214adfSAndy Whitcroft					}
5531aad4f614SJoe Perches					$allow++;
553213214adfSAndy Whitcroft				}
5533aad4f614SJoe Perches				if ($seen) {
5534aad4f614SJoe Perches					my $sum_allowed = 0;
5535aad4f614SJoe Perches					foreach (@allowed) {
5536aad4f614SJoe Perches						$sum_allowed += $_;
5537aad4f614SJoe Perches					}
5538aad4f614SJoe Perches					if ($sum_allowed == 0) {
5539000d1cc1SJoe Perches						WARN("BRACES",
5540000d1cc1SJoe Perches						     "braces {} are not necessary for any arm of this statement\n" . $herectx);
5541aad4f614SJoe Perches					} elsif ($sum_allowed != $allow &&
5542aad4f614SJoe Perches						 $seen != $allow) {
5543aad4f614SJoe Perches						CHK("BRACES",
5544aad4f614SJoe Perches						    "braces {} should be used on all arms of this statement\n" . $herectx);
5545aad4f614SJoe Perches					}
554613214adfSAndy Whitcroft				}
554713214adfSAndy Whitcroft			}
554813214adfSAndy Whitcroft		}
5549773647a0SAndy Whitcroft		if (!defined $suppress_ifbraces{$linenr - 1} &&
555013214adfSAndy Whitcroft					$line =~ /\b(if|while|for|else)\b/) {
5551cf655043SAndy Whitcroft			my $allowed = 0;
5552f0a594c1SAndy Whitcroft
5553cf655043SAndy Whitcroft			# Check the pre-context.
5554cf655043SAndy Whitcroft			if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5555cf655043SAndy Whitcroft				#print "APW: ALLOWED: pre<$1>\n";
5556cf655043SAndy Whitcroft				$allowed = 1;
5557f0a594c1SAndy Whitcroft			}
5558773647a0SAndy Whitcroft
5559773647a0SAndy Whitcroft			my ($level, $endln, @chunks) =
5560773647a0SAndy Whitcroft				ctx_statement_full($linenr, $realcnt, $-[0]);
5561773647a0SAndy Whitcroft
5562cf655043SAndy Whitcroft			# Check the condition.
5563cf655043SAndy Whitcroft			my ($cond, $block) = @{$chunks[0]};
5564773647a0SAndy Whitcroft			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5565cf655043SAndy Whitcroft			if (defined $cond) {
5566773647a0SAndy Whitcroft				substr($block, 0, length($cond), '');
5567cf655043SAndy Whitcroft			}
5568cf655043SAndy Whitcroft			if (statement_lines($cond) > 1) {
5569cf655043SAndy Whitcroft				#print "APW: ALLOWED: cond<$cond>\n";
5570cf655043SAndy Whitcroft				$allowed = 1;
5571cf655043SAndy Whitcroft			}
5572cf655043SAndy Whitcroft			if ($block =~/\b(?:if|for|while)\b/) {
5573cf655043SAndy Whitcroft				#print "APW: ALLOWED: block<$block>\n";
5574cf655043SAndy Whitcroft				$allowed = 1;
5575cf655043SAndy Whitcroft			}
5576cf655043SAndy Whitcroft			if (statement_block_size($block) > 1) {
5577cf655043SAndy Whitcroft				#print "APW: ALLOWED: lines block<$block>\n";
5578cf655043SAndy Whitcroft				$allowed = 1;
5579cf655043SAndy Whitcroft			}
5580cf655043SAndy Whitcroft			# Check the post-context.
5581cf655043SAndy Whitcroft			if (defined $chunks[1]) {
5582cf655043SAndy Whitcroft				my ($cond, $block) = @{$chunks[1]};
5583cf655043SAndy Whitcroft				if (defined $cond) {
5584773647a0SAndy Whitcroft					substr($block, 0, length($cond), '');
5585cf655043SAndy Whitcroft				}
5586cf655043SAndy Whitcroft				if ($block =~ /^\s*\{/) {
5587cf655043SAndy Whitcroft					#print "APW: ALLOWED: chunk-1 block<$block>\n";
5588cf655043SAndy Whitcroft					$allowed = 1;
5589cf655043SAndy Whitcroft				}
5590cf655043SAndy Whitcroft			}
5591cf655043SAndy Whitcroft			if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
5592f055663cSAndy Whitcroft				my $cnt = statement_rawlines($block);
5593e3d95a2aSTobin C. Harding				my $herectx = get_stat_here($linenr, $cnt, $here);
5594cf655043SAndy Whitcroft
5595000d1cc1SJoe Perches				WARN("BRACES",
5596000d1cc1SJoe Perches				     "braces {} are not necessary for single statement blocks\n" . $herectx);
5597f0a594c1SAndy Whitcroft			}
5598f0a594c1SAndy Whitcroft		}
5599f0a594c1SAndy Whitcroft
5600e4c5babdSJoe Perches# check for single line unbalanced braces
560195330473SSven Eckelmann		if ($sline =~ /^.\s*\}\s*else\s*$/ ||
560295330473SSven Eckelmann		    $sline =~ /^.\s*else\s*\{\s*$/) {
5603e4c5babdSJoe Perches			CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5604e4c5babdSJoe Perches		}
5605e4c5babdSJoe Perches
56060979ae66SJoe Perches# check for unnecessary blank lines around braces
560777b9a53aSJoe Perches		if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
5608f8e58219SJoe Perches			if (CHK("BRACES",
5609f8e58219SJoe Perches				"Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5610f8e58219SJoe Perches			    $fix && $prevrawline =~ /^\+/) {
5611f8e58219SJoe Perches				fix_delete_line($fixlinenr - 1, $prevrawline);
5612f8e58219SJoe Perches			}
56130979ae66SJoe Perches		}
561477b9a53aSJoe Perches		if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
5615f8e58219SJoe Perches			if (CHK("BRACES",
5616f8e58219SJoe Perches				"Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5617f8e58219SJoe Perches			    $fix) {
5618f8e58219SJoe Perches				fix_delete_line($fixlinenr, $rawline);
5619f8e58219SJoe Perches			}
56200979ae66SJoe Perches		}
56210979ae66SJoe Perches
56224a0df2efSAndy Whitcroft# no volatiles please
56236c72ffaaSAndy Whitcroft		my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
56246c72ffaaSAndy Whitcroft		if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
5625000d1cc1SJoe Perches			WARN("VOLATILE",
56268c27ceffSMauro Carvalho Chehab			     "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
56274a0df2efSAndy Whitcroft		}
56284a0df2efSAndy Whitcroft
56295e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability
56305e4f6ba5SJoe Perches# to grep for the string.  Make exceptions when the previous string ends in a
56315e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
56325e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
563333acb54aSJoe Perches		if ($line =~ /^\+\s*$String/ &&
56345e4f6ba5SJoe Perches		    $prevline =~ /"\s*$/ &&
56355e4f6ba5SJoe Perches		    $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
56365e4f6ba5SJoe Perches			if (WARN("SPLIT_STRING",
56375e4f6ba5SJoe Perches				 "quoted string split across lines\n" . $hereprev) &&
56385e4f6ba5SJoe Perches				     $fix &&
56395e4f6ba5SJoe Perches				     $prevrawline =~ /^\+.*"\s*$/ &&
56405e4f6ba5SJoe Perches				     $last_coalesced_string_linenr != $linenr - 1) {
56415e4f6ba5SJoe Perches				my $extracted_string = get_quoted_string($line, $rawline);
56425e4f6ba5SJoe Perches				my $comma_close = "";
56435e4f6ba5SJoe Perches				if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
56445e4f6ba5SJoe Perches					$comma_close = $1;
56455e4f6ba5SJoe Perches				}
56465e4f6ba5SJoe Perches
56475e4f6ba5SJoe Perches				fix_delete_line($fixlinenr - 1, $prevrawline);
56485e4f6ba5SJoe Perches				fix_delete_line($fixlinenr, $rawline);
56495e4f6ba5SJoe Perches				my $fixedline = $prevrawline;
56505e4f6ba5SJoe Perches				$fixedline =~ s/"\s*$//;
56515e4f6ba5SJoe Perches				$fixedline .= substr($extracted_string, 1) . trim($comma_close);
56525e4f6ba5SJoe Perches				fix_insert_line($fixlinenr - 1, $fixedline);
56535e4f6ba5SJoe Perches				$fixedline = $rawline;
56545e4f6ba5SJoe Perches				$fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
56555e4f6ba5SJoe Perches				if ($fixedline !~ /\+\s*$/) {
56565e4f6ba5SJoe Perches					fix_insert_line($fixlinenr, $fixedline);
56575e4f6ba5SJoe Perches				}
56585e4f6ba5SJoe Perches				$last_coalesced_string_linenr = $linenr;
56595e4f6ba5SJoe Perches			}
56605e4f6ba5SJoe Perches		}
56615e4f6ba5SJoe Perches
56625e4f6ba5SJoe Perches# check for missing a space in a string concatenation
56635e4f6ba5SJoe Perches		if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
56645e4f6ba5SJoe Perches			WARN('MISSING_SPACE',
56655e4f6ba5SJoe Perches			     "break quoted strings at a space character\n" . $hereprev);
56665e4f6ba5SJoe Perches		}
56675e4f6ba5SJoe Perches
566877cb8546SJoe Perches# check for an embedded function name in a string when the function is known
5669e4b7d309SJoe Perches# This does not work very well for -f --file checking as it depends on patch
5670e4b7d309SJoe Perches# context providing the function name or a single line form for in-file
5671e4b7d309SJoe Perches# function declarations
567277cb8546SJoe Perches		if ($line =~ /^\+.*$String/ &&
567377cb8546SJoe Perches		    defined($context_function) &&
5674e4b7d309SJoe Perches		    get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5675e4b7d309SJoe Perches		    length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
567677cb8546SJoe Perches			WARN("EMBEDDED_FUNCTION_NAME",
5677e4b7d309SJoe Perches			     "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
567877cb8546SJoe Perches		}
567977cb8546SJoe Perches
56805e4f6ba5SJoe Perches# check for spaces before a quoted newline
56815e4f6ba5SJoe Perches		if ($rawline =~ /^.*\".*\s\\n/) {
56825e4f6ba5SJoe Perches			if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
56835e4f6ba5SJoe Perches				 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
56845e4f6ba5SJoe Perches			    $fix) {
56855e4f6ba5SJoe Perches				$fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
56865e4f6ba5SJoe Perches			}
56875e4f6ba5SJoe Perches
56885e4f6ba5SJoe Perches		}
56895e4f6ba5SJoe Perches
5690f17dba4fSJoe Perches# concatenated string without spaces between elements
569179682c0cSJoe Perches		if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) {
569279682c0cSJoe Perches			if (CHK("CONCATENATED_STRING",
569379682c0cSJoe Perches				"Concatenated strings should use spaces between elements\n" . $herecurr) &&
569479682c0cSJoe Perches			    $fix) {
569579682c0cSJoe Perches				while ($line =~ /($String)/g) {
569679682c0cSJoe Perches					my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
569779682c0cSJoe Perches					$fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/;
569879682c0cSJoe Perches					$fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/;
569979682c0cSJoe Perches				}
570079682c0cSJoe Perches			}
5701f17dba4fSJoe Perches		}
5702f17dba4fSJoe Perches
570390ad30e5SJoe Perches# uncoalesced string fragments
570433acb54aSJoe Perches		if ($line =~ /$String\s*"/) {
570579682c0cSJoe Perches			if (WARN("STRING_FRAGMENTS",
570679682c0cSJoe Perches				 "Consecutive strings are generally better as a single string\n" . $herecurr) &&
570779682c0cSJoe Perches			    $fix) {
570879682c0cSJoe Perches				while ($line =~ /($String)(?=\s*")/g) {
570979682c0cSJoe Perches					my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
571079682c0cSJoe Perches					$fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e;
571179682c0cSJoe Perches				}
571279682c0cSJoe Perches			}
571390ad30e5SJoe Perches		}
571490ad30e5SJoe Perches
5715522b837cSAlexey Dobriyan# check for non-standard and hex prefixed decimal printf formats
5716522b837cSAlexey Dobriyan		my $show_L = 1;	#don't show the same defect twice
5717522b837cSAlexey Dobriyan		my $show_Z = 1;
57185e4f6ba5SJoe Perches		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5719522b837cSAlexey Dobriyan			my $string = substr($rawline, $-[1], $+[1] - $-[1]);
57205e4f6ba5SJoe Perches			$string =~ s/%%/__/g;
5721522b837cSAlexey Dobriyan			# check for %L
5722522b837cSAlexey Dobriyan			if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
57235e4f6ba5SJoe Perches				WARN("PRINTF_L",
5724522b837cSAlexey Dobriyan				     "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5725522b837cSAlexey Dobriyan				$show_L = 0;
57265e4f6ba5SJoe Perches			}
5727522b837cSAlexey Dobriyan			# check for %Z
5728522b837cSAlexey Dobriyan			if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5729522b837cSAlexey Dobriyan				WARN("PRINTF_Z",
5730522b837cSAlexey Dobriyan				     "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5731522b837cSAlexey Dobriyan				$show_Z = 0;
5732522b837cSAlexey Dobriyan			}
5733522b837cSAlexey Dobriyan			# check for 0x<decimal>
5734522b837cSAlexey Dobriyan			if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5735522b837cSAlexey Dobriyan				ERROR("PRINTF_0XDECIMAL",
57366e300757SJoe Perches				      "Prefixing 0x with decimal output is defective\n" . $herecurr);
57376e300757SJoe Perches			}
57385e4f6ba5SJoe Perches		}
57395e4f6ba5SJoe Perches
57405e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of "
57413f7f335dSJoe Perches		if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
57425e4f6ba5SJoe Perches			WARN("LINE_CONTINUATIONS",
57435e4f6ba5SJoe Perches			     "Avoid line continuations in quoted strings\n" . $herecurr);
57445e4f6ba5SJoe Perches		}
57455e4f6ba5SJoe Perches
574600df344fSAndy Whitcroft# warn about #if 0
5747c45dcabdSAndy Whitcroft		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
574860f89010SPrakruthi Deepak Heragu			WARN("IF_0",
574960f89010SPrakruthi Deepak Heragu			     "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr);
575060f89010SPrakruthi Deepak Heragu		}
575160f89010SPrakruthi Deepak Heragu
575260f89010SPrakruthi Deepak Heragu# warn about #if 1
575360f89010SPrakruthi Deepak Heragu		if ($line =~ /^.\s*\#\s*if\s+1\b/) {
575460f89010SPrakruthi Deepak Heragu			WARN("IF_1",
575560f89010SPrakruthi Deepak Heragu			     "Consider removing the #if 1 and its #endif\n" . $herecurr);
57564a0df2efSAndy Whitcroft		}
57574a0df2efSAndy Whitcroft
575803df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses
575903df4b51SAndy Whitcroft		if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
5760100425deSJoe Perches			my $tested = quotemeta($1);
5761100425deSJoe Perches			my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5762100425deSJoe Perches			if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5763100425deSJoe Perches				my $func = $1;
5764100425deSJoe Perches				if (WARN('NEEDLESS_IF',
5765100425deSJoe Perches					 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5766100425deSJoe Perches				    $fix) {
5767100425deSJoe Perches					my $do_fix = 1;
5768100425deSJoe Perches					my $leading_tabs = "";
5769100425deSJoe Perches					my $new_leading_tabs = "";
5770100425deSJoe Perches					if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5771100425deSJoe Perches						$leading_tabs = $1;
5772100425deSJoe Perches					} else {
5773100425deSJoe Perches						$do_fix = 0;
5774100425deSJoe Perches					}
5775100425deSJoe Perches					if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5776100425deSJoe Perches						$new_leading_tabs = $1;
5777100425deSJoe Perches						if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5778100425deSJoe Perches							$do_fix = 0;
5779100425deSJoe Perches						}
5780100425deSJoe Perches					} else {
5781100425deSJoe Perches						$do_fix = 0;
5782100425deSJoe Perches					}
5783100425deSJoe Perches					if ($do_fix) {
5784100425deSJoe Perches						fix_delete_line($fixlinenr - 1, $prevrawline);
5785100425deSJoe Perches						$fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5786100425deSJoe Perches					}
5787100425deSJoe Perches				}
57884c432a8fSGreg Kroah-Hartman			}
57894c432a8fSGreg Kroah-Hartman		}
5790f0a594c1SAndy Whitcroft
5791ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages
5792ebfdc409SJoe Perches		if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5793ebfdc409SJoe Perches		    $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5794ebfdc409SJoe Perches		    (defined $1 || defined $3) &&
5795ebfdc409SJoe Perches		    $linenr > 3) {
5796ebfdc409SJoe Perches			my $testval = $2;
5797ebfdc409SJoe Perches			my $testline = $lines[$linenr - 3];
5798ebfdc409SJoe Perches
5799ebfdc409SJoe Perches			my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5800ebfdc409SJoe Perches#			print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5801ebfdc409SJoe Perches
5802e29a70f1SJoe Perches			if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
5803e29a70f1SJoe Perches			    $s !~ /\b__GFP_NOWARN\b/ ) {
5804ebfdc409SJoe Perches				WARN("OOM_MESSAGE",
5805ebfdc409SJoe Perches				     "Possible unnecessary 'out of memory' message\n" . $hereprev);
5806ebfdc409SJoe Perches			}
5807ebfdc409SJoe Perches		}
5808ebfdc409SJoe Perches
5809f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL>
5810dcaf1123SPaolo Bonzini		if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
5811f78d98f6SJoe Perches		    $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5812f78d98f6SJoe Perches			my $level = $1;
5813f78d98f6SJoe Perches			if (WARN("UNNECESSARY_KERN_LEVEL",
5814f78d98f6SJoe Perches				 "Possible unnecessary $level\n" . $herecurr) &&
5815f78d98f6SJoe Perches			    $fix) {
5816f78d98f6SJoe Perches				$fixed[$fixlinenr] =~ s/\s*$level\s*//;
5817f78d98f6SJoe Perches			}
5818f78d98f6SJoe Perches		}
5819f78d98f6SJoe Perches
582045c55e92SJoe Perches# check for logging continuations
582145c55e92SJoe Perches		if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
582245c55e92SJoe Perches			WARN("LOGGING_CONTINUATION",
582345c55e92SJoe Perches			     "Avoid logging continuation uses where feasible\n" . $herecurr);
582445c55e92SJoe Perches		}
582545c55e92SJoe Perches
5826abb08a53SJoe Perches# check for mask then right shift without a parentheses
58275b57980dSJoe Perches		if ($perl_version_ok &&
5828abb08a53SJoe Perches		    $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5829abb08a53SJoe Perches		    $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5830abb08a53SJoe Perches			WARN("MASK_THEN_SHIFT",
5831abb08a53SJoe Perches			     "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5832abb08a53SJoe Perches		}
5833abb08a53SJoe Perches
5834b75ac618SJoe Perches# check for pointer comparisons to NULL
58355b57980dSJoe Perches		if ($perl_version_ok) {
5836b75ac618SJoe Perches			while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5837b75ac618SJoe Perches				my $val = $1;
5838b75ac618SJoe Perches				my $equal = "!";
5839b75ac618SJoe Perches				$equal = "" if ($4 eq "!=");
5840b75ac618SJoe Perches				if (CHK("COMPARISON_TO_NULL",
5841b75ac618SJoe Perches					"Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5842b75ac618SJoe Perches					    $fix) {
5843b75ac618SJoe Perches					$fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5844b75ac618SJoe Perches				}
5845b75ac618SJoe Perches			}
5846b75ac618SJoe Perches		}
5847b75ac618SJoe Perches
58488716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata)
58498716de38SJoe Perches		if ($line =~ /(\b$InitAttribute\b)/) {
58508716de38SJoe Perches			my $attr = $1;
58518716de38SJoe Perches			if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
58528716de38SJoe Perches				my $ptr = $1;
58538716de38SJoe Perches				my $var = $2;
58548716de38SJoe Perches				if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
58558716de38SJoe Perches				      ERROR("MISPLACED_INIT",
58568716de38SJoe Perches					    "$attr should be placed after $var\n" . $herecurr)) ||
58578716de38SJoe Perches				     ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
58588716de38SJoe Perches				      WARN("MISPLACED_INIT",
58598716de38SJoe Perches					   "$attr should be placed after $var\n" . $herecurr))) &&
58608716de38SJoe Perches				    $fix) {
5861194f66fcSJoe Perches					$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;
58628716de38SJoe Perches				}
58638716de38SJoe Perches			}
58648716de38SJoe Perches		}
58658716de38SJoe Perches
5866e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const
5867e970b884SJoe Perches		if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5868e970b884SJoe Perches			my $attr = $1;
5869e970b884SJoe Perches			$attr =~ /($InitAttributePrefix)(.*)/;
5870e970b884SJoe Perches			my $attr_prefix = $1;
5871e970b884SJoe Perches			my $attr_type = $2;
5872e970b884SJoe Perches			if (ERROR("INIT_ATTRIBUTE",
5873e970b884SJoe Perches				  "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5874e970b884SJoe Perches			    $fix) {
5875194f66fcSJoe Perches				$fixed[$fixlinenr] =~
5876e970b884SJoe Perches				    s/$InitAttributeData/${attr_prefix}initconst/;
5877e970b884SJoe Perches			}
5878e970b884SJoe Perches		}
5879e970b884SJoe Perches
5880e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const
5881e970b884SJoe Perches		if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5882e970b884SJoe Perches			my $attr = $1;
5883e970b884SJoe Perches			if (ERROR("INIT_ATTRIBUTE",
5884e970b884SJoe Perches				  "Use of $attr requires a separate use of const\n" . $herecurr) &&
5885e970b884SJoe Perches			    $fix) {
5886194f66fcSJoe Perches				my $lead = $fixed[$fixlinenr] =~
5887e970b884SJoe Perches				    /(^\+\s*(?:static\s+))/;
5888e970b884SJoe Perches				$lead = rtrim($1);
5889e970b884SJoe Perches				$lead = "$lead " if ($lead !~ /^\+$/);
5890e970b884SJoe Perches				$lead = "${lead}const ";
5891194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
5892e970b884SJoe Perches			}
5893e970b884SJoe Perches		}
5894e970b884SJoe Perches
5895c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const)
5896c17893c7SJoe Perches		if ($line =~ /\b__read_mostly\b/ &&
5897c17893c7SJoe Perches		    $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5898c17893c7SJoe Perches			if (ERROR("CONST_READ_MOSTLY",
5899c17893c7SJoe Perches				  "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5900c17893c7SJoe Perches			    $fix) {
5901c17893c7SJoe Perches				$fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5902c17893c7SJoe Perches			}
5903c17893c7SJoe Perches		}
5904c17893c7SJoe Perches
5905fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/
5906fbdb8138SJoe Perches		if ($realfile !~ m@^include/uapi/@ &&
5907fbdb8138SJoe Perches		    $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5908fbdb8138SJoe Perches			my $constant_func = $1;
5909fbdb8138SJoe Perches			my $func = $constant_func;
5910fbdb8138SJoe Perches			$func =~ s/^__constant_//;
5911fbdb8138SJoe Perches			if (WARN("CONSTANT_CONVERSION",
5912fbdb8138SJoe Perches				 "$constant_func should be $func\n" . $herecurr) &&
5913fbdb8138SJoe Perches			    $fix) {
5914194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
5915fbdb8138SJoe Perches			}
5916fbdb8138SJoe Perches		}
5917fbdb8138SJoe Perches
59181a15a250SPatrick Pannuto# prefer usleep_range over udelay
591937581c28SBruce Allan		if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
592043c1d77cSJoe Perches			my $delay = $1;
59211a15a250SPatrick Pannuto			# ignore udelay's < 10, however
592243c1d77cSJoe Perches			if (! ($delay < 10) ) {
5923000d1cc1SJoe Perches				CHK("USLEEP_RANGE",
5924458f69efSMauro Carvalho Chehab				    "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
592543c1d77cSJoe Perches			}
592643c1d77cSJoe Perches			if ($delay > 2000) {
592743c1d77cSJoe Perches				WARN("LONG_UDELAY",
592843c1d77cSJoe Perches				     "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
59291a15a250SPatrick Pannuto			}
59301a15a250SPatrick Pannuto		}
59311a15a250SPatrick Pannuto
593209ef8725SPatrick Pannuto# warn about unexpectedly long msleep's
593309ef8725SPatrick Pannuto		if ($line =~ /\bmsleep\s*\((\d+)\);/) {
593409ef8725SPatrick Pannuto			if ($1 < 20) {
5935000d1cc1SJoe Perches				WARN("MSLEEP",
5936458f69efSMauro Carvalho Chehab				     "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
593709ef8725SPatrick Pannuto			}
593809ef8725SPatrick Pannuto		}
593909ef8725SPatrick Pannuto
594036ec1939SJoe Perches# check for comparisons of jiffies
594136ec1939SJoe Perches		if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
594236ec1939SJoe Perches			WARN("JIFFIES_COMPARISON",
594336ec1939SJoe Perches			     "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
594436ec1939SJoe Perches		}
594536ec1939SJoe Perches
59469d7a34a5SJoe Perches# check for comparisons of get_jiffies_64()
59479d7a34a5SJoe Perches		if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
59489d7a34a5SJoe Perches			WARN("JIFFIES_COMPARISON",
59499d7a34a5SJoe Perches			     "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
59509d7a34a5SJoe Perches		}
59519d7a34a5SJoe Perches
595200df344fSAndy Whitcroft# warn about #ifdefs in C files
5953c45dcabdSAndy Whitcroft#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
595400df344fSAndy Whitcroft#			print "#ifdef in C files should be avoided\n";
595500df344fSAndy Whitcroft#			print "$herecurr";
595600df344fSAndy Whitcroft#			$clean = 0;
595700df344fSAndy Whitcroft#		}
595800df344fSAndy Whitcroft
595922f2a2efSAndy Whitcroft# warn about spacing in #ifdefs
5960c45dcabdSAndy Whitcroft		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
59613705ce5bSJoe Perches			if (ERROR("SPACING",
59623705ce5bSJoe Perches				  "exactly one space required after that #$1\n" . $herecurr) &&
59633705ce5bSJoe Perches			    $fix) {
5964194f66fcSJoe Perches				$fixed[$fixlinenr] =~
59653705ce5bSJoe Perches				    s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
59663705ce5bSJoe Perches			}
59673705ce5bSJoe Perches
596822f2a2efSAndy Whitcroft		}
596922f2a2efSAndy Whitcroft
59704a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment.
5971171ae1a4SAndy Whitcroft		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5972171ae1a4SAndy Whitcroft		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
59734a0df2efSAndy Whitcroft			my $which = $1;
59744a0df2efSAndy Whitcroft			if (!ctx_has_comment($first_line, $linenr)) {
5975000d1cc1SJoe Perches				CHK("UNCOMMENTED_DEFINITION",
5976000d1cc1SJoe Perches				    "$1 definition without comment\n" . $herecurr);
59774a0df2efSAndy Whitcroft			}
59784a0df2efSAndy Whitcroft		}
59794a0df2efSAndy Whitcroft# check for memory barriers without a comment.
5980402c2553SMichael S. Tsirkin
5981402c2553SMichael S. Tsirkin		my $barriers = qr{
5982402c2553SMichael S. Tsirkin			mb|
5983402c2553SMichael S. Tsirkin			rmb|
5984ad83ec6cSWill Deacon			wmb
5985402c2553SMichael S. Tsirkin		}x;
5986402c2553SMichael S. Tsirkin		my $barrier_stems = qr{
5987402c2553SMichael S. Tsirkin			mb__before_atomic|
5988402c2553SMichael S. Tsirkin			mb__after_atomic|
5989402c2553SMichael S. Tsirkin			store_release|
5990402c2553SMichael S. Tsirkin			load_acquire|
5991402c2553SMichael S. Tsirkin			store_mb|
5992402c2553SMichael S. Tsirkin			(?:$barriers)
5993402c2553SMichael S. Tsirkin		}x;
5994402c2553SMichael S. Tsirkin		my $all_barriers = qr{
5995402c2553SMichael S. Tsirkin			(?:$barriers)|
599643e361f2SMichael S. Tsirkin			smp_(?:$barrier_stems)|
599743e361f2SMichael S. Tsirkin			virt_(?:$barrier_stems)
5998402c2553SMichael S. Tsirkin		}x;
5999402c2553SMichael S. Tsirkin
6000402c2553SMichael S. Tsirkin		if ($line =~ /\b(?:$all_barriers)\s*\(/) {
60014a0df2efSAndy Whitcroft			if (!ctx_has_comment($first_line, $linenr)) {
6002c1fd7bb9SJoe Perches				WARN("MEMORY_BARRIER",
6003000d1cc1SJoe Perches				     "memory barrier without comment\n" . $herecurr);
60044a0df2efSAndy Whitcroft			}
60054a0df2efSAndy Whitcroft		}
60063ad81779SPaul E. McKenney
6007f4073b0fSMichael S. Tsirkin		my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
6008f4073b0fSMichael S. Tsirkin
6009f4073b0fSMichael S. Tsirkin		if ($realfile !~ m@^include/asm-generic/@ &&
6010f4073b0fSMichael S. Tsirkin		    $realfile !~ m@/barrier\.h$@ &&
6011f4073b0fSMichael S. Tsirkin		    $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
6012f4073b0fSMichael S. Tsirkin		    $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
6013f4073b0fSMichael S. Tsirkin			WARN("MEMORY_BARRIER",
6014f4073b0fSMichael S. Tsirkin			     "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
6015f4073b0fSMichael S. Tsirkin		}
6016f4073b0fSMichael S. Tsirkin
6017cb426e99SJoe Perches# check for waitqueue_active without a comment.
6018cb426e99SJoe Perches		if ($line =~ /\bwaitqueue_active\s*\(/) {
6019cb426e99SJoe Perches			if (!ctx_has_comment($first_line, $linenr)) {
6020cb426e99SJoe Perches				WARN("WAITQUEUE_ACTIVE",
6021cb426e99SJoe Perches				     "waitqueue_active without comment\n" . $herecurr);
6022cb426e99SJoe Perches			}
6023cb426e99SJoe Perches		}
60243ad81779SPaul E. McKenney
60255099a722SMarco Elver# check for data_race without a comment.
60265099a722SMarco Elver		if ($line =~ /\bdata_race\s*\(/) {
60275099a722SMarco Elver			if (!ctx_has_comment($first_line, $linenr)) {
60285099a722SMarco Elver				WARN("DATA_RACE",
60295099a722SMarco Elver				     "data_race without comment\n" . $herecurr);
60305099a722SMarco Elver			}
60315099a722SMarco Elver		}
60325099a722SMarco Elver
60334a0df2efSAndy Whitcroft# check of hardware specific defines
6034c45dcabdSAndy Whitcroft		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
6035000d1cc1SJoe Perches			CHK("ARCH_DEFINES",
6036000d1cc1SJoe Perches			    "architecture specific defines should be avoided\n" .  $herecurr);
60370a920b5bSAndy Whitcroft		}
6038653d4876SAndy Whitcroft
6039596ed45bSJoe Perches# check that the storage class is not after a type
6040596ed45bSJoe Perches		if ($line =~ /\b($Type)\s+($Storage)\b/) {
6041000d1cc1SJoe Perches			WARN("STORAGE_CLASS",
6042596ed45bSJoe Perches			     "storage class '$2' should be located before type '$1'\n" . $herecurr);
6043596ed45bSJoe Perches		}
6044596ed45bSJoe Perches# Check that the storage class is at the beginning of a declaration
6045596ed45bSJoe Perches		if ($line =~ /\b$Storage\b/ &&
6046596ed45bSJoe Perches		    $line !~ /^.\s*$Storage/ &&
6047596ed45bSJoe Perches		    $line =~ /^.\s*(.+?)\$Storage\s/ &&
6048596ed45bSJoe Perches		    $1 !~ /[\,\)]\s*$/) {
6049596ed45bSJoe Perches			WARN("STORAGE_CLASS",
6050596ed45bSJoe Perches			     "storage class should be at the beginning of the declaration\n" . $herecurr);
6051d4977c78STobias Klauser		}
6052d4977c78STobias Klauser
6053de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between
6054de7d4f0eSAndy Whitcroft# storage class and type.
60559c0ca6f9SAndy Whitcroft		if ($line =~ /\b$Type\s+$Inline\b/ ||
60569c0ca6f9SAndy Whitcroft		    $line =~ /\b$Inline\s+$Storage\b/) {
6057000d1cc1SJoe Perches			ERROR("INLINE_LOCATION",
6058000d1cc1SJoe Perches			      "inline keyword should sit between storage class and type\n" . $herecurr);
6059de7d4f0eSAndy Whitcroft		}
6060de7d4f0eSAndy Whitcroft
60618905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline
60622b7ab453SJoe Perches		if ($realfile !~ m@\binclude/uapi/@ &&
60632b7ab453SJoe Perches		    $line =~ /\b(__inline__|__inline)\b/) {
6064d5e616fcSJoe Perches			if (WARN("INLINE",
6065d5e616fcSJoe Perches				 "plain inline is preferred over $1\n" . $herecurr) &&
6066d5e616fcSJoe Perches			    $fix) {
6067194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
6068d5e616fcSJoe Perches
6069d5e616fcSJoe Perches			}
60708905a67cSAndy Whitcroft		}
60718905a67cSAndy Whitcroft
60723d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed
60732b7ab453SJoe Perches		if ($realfile !~ m@\binclude/uapi/@ &&
60742b7ab453SJoe Perches		    $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
6075000d1cc1SJoe Perches			WARN("PREFER_PACKED",
6076000d1cc1SJoe Perches			     "__packed is preferred over __attribute__((packed))\n" . $herecurr);
60773d130fd0SJoe Perches		}
60783d130fd0SJoe Perches
607939b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned
60802b7ab453SJoe Perches		if ($realfile !~ m@\binclude/uapi/@ &&
60812b7ab453SJoe Perches		    $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
6082000d1cc1SJoe Perches			WARN("PREFER_ALIGNED",
6083000d1cc1SJoe Perches			     "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
608439b7e287SJoe Perches		}
608539b7e287SJoe Perches
6086462811d9SJoe Perches# Check for __attribute__ section, prefer __section
6087462811d9SJoe Perches		if ($realfile !~ m@\binclude/uapi/@ &&
6088462811d9SJoe Perches		    $line =~ /\b__attribute__\s*\(\s*\(.*_*section_*\s*\(\s*("[^"]*")/) {
6089462811d9SJoe Perches			my $old = substr($rawline, $-[1], $+[1] - $-[1]);
6090462811d9SJoe Perches			my $new = substr($old, 1, -1);
6091462811d9SJoe Perches			if (WARN("PREFER_SECTION",
6092462811d9SJoe Perches				 "__section($new) is preferred over __attribute__((section($old)))\n" . $herecurr) &&
6093462811d9SJoe Perches			    $fix) {
6094462811d9SJoe Perches				$fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/;
6095462811d9SJoe Perches			}
6096462811d9SJoe Perches		}
6097462811d9SJoe Perches
60985f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf
60992b7ab453SJoe Perches		if ($realfile !~ m@\binclude/uapi/@ &&
61002b7ab453SJoe Perches		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
6101d5e616fcSJoe Perches			if (WARN("PREFER_PRINTF",
6102d5e616fcSJoe Perches				 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
6103d5e616fcSJoe Perches			    $fix) {
6104194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
6105d5e616fcSJoe Perches
6106d5e616fcSJoe Perches			}
61075f14d3bdSJoe Perches		}
61085f14d3bdSJoe Perches
61096061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf
61102b7ab453SJoe Perches		if ($realfile !~ m@\binclude/uapi/@ &&
61112b7ab453SJoe Perches		    $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
6112d5e616fcSJoe Perches			if (WARN("PREFER_SCANF",
6113d5e616fcSJoe Perches				 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
6114d5e616fcSJoe Perches			    $fix) {
6115194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
6116d5e616fcSJoe Perches			}
61176061d949SJoe Perches		}
61186061d949SJoe Perches
6119619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues)
61205b57980dSJoe Perches		if ($perl_version_ok &&
6121619a908aSJoe Perches		    $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
6122619a908aSJoe Perches		    ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
6123619a908aSJoe Perches		     $line =~ /\b__weak\b/)) {
6124619a908aSJoe Perches			ERROR("WEAK_DECLARATION",
6125619a908aSJoe Perches			      "Using weak declarations can have unintended link defects\n" . $herecurr);
6126619a908aSJoe Perches		}
6127619a908aSJoe Perches
6128fd39f904STomas Winkler# check for c99 types like uint8_t used outside of uapi/ and tools/
6129e6176fa4SJoe Perches		if ($realfile !~ m@\binclude/uapi/@ &&
6130fd39f904STomas Winkler		    $realfile !~ m@\btools/@ &&
6131e6176fa4SJoe Perches		    $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
6132e6176fa4SJoe Perches			my $type = $1;
6133e6176fa4SJoe Perches			if ($type =~ /\b($typeC99Typedefs)\b/) {
6134e6176fa4SJoe Perches				$type = $1;
6135e6176fa4SJoe Perches				my $kernel_type = 'u';
6136e6176fa4SJoe Perches				$kernel_type = 's' if ($type =~ /^_*[si]/);
6137e6176fa4SJoe Perches				$type =~ /(\d+)/;
6138e6176fa4SJoe Perches				$kernel_type .= $1;
6139e6176fa4SJoe Perches				if (CHK("PREFER_KERNEL_TYPES",
6140e6176fa4SJoe Perches					"Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
6141e6176fa4SJoe Perches				    $fix) {
6142e6176fa4SJoe Perches					$fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
6143e6176fa4SJoe Perches				}
6144e6176fa4SJoe Perches			}
6145e6176fa4SJoe Perches		}
6146e6176fa4SJoe Perches
6147938224b5SJoe Perches# check for cast of C90 native int or longer types constants
6148938224b5SJoe Perches		if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
6149938224b5SJoe Perches			my $cast = $1;
6150938224b5SJoe Perches			my $const = $2;
6151938224b5SJoe Perches			if (WARN("TYPECAST_INT_CONSTANT",
6152938224b5SJoe Perches				 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
6153938224b5SJoe Perches			    $fix) {
6154938224b5SJoe Perches				my $suffix = "";
6155938224b5SJoe Perches				my $newconst = $const;
6156938224b5SJoe Perches				$newconst =~ s/${Int_type}$//;
6157938224b5SJoe Perches				$suffix .= 'U' if ($cast =~ /\bunsigned\b/);
6158938224b5SJoe Perches				if ($cast =~ /\blong\s+long\b/) {
6159938224b5SJoe Perches					$suffix .= 'LL';
6160938224b5SJoe Perches				} elsif ($cast =~ /\blong\b/) {
6161938224b5SJoe Perches					$suffix .= 'L';
6162938224b5SJoe Perches				}
6163938224b5SJoe Perches				$fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
6164938224b5SJoe Perches			}
6165938224b5SJoe Perches		}
6166938224b5SJoe Perches
61678f53a9b8SJoe Perches# check for sizeof(&)
61688f53a9b8SJoe Perches		if ($line =~ /\bsizeof\s*\(\s*\&/) {
6169000d1cc1SJoe Perches			WARN("SIZEOF_ADDRESS",
6170000d1cc1SJoe Perches			     "sizeof(& should be avoided\n" . $herecurr);
61718f53a9b8SJoe Perches		}
61728f53a9b8SJoe Perches
617366c80b60SJoe Perches# check for sizeof without parenthesis
617466c80b60SJoe Perches		if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
6175d5e616fcSJoe Perches			if (WARN("SIZEOF_PARENTHESIS",
6176d5e616fcSJoe Perches				 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
6177d5e616fcSJoe Perches			    $fix) {
6178194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
6179d5e616fcSJoe Perches			}
618066c80b60SJoe Perches		}
618166c80b60SJoe Perches
618288982feaSJoe Perches# check for struct spinlock declarations
618388982feaSJoe Perches		if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
618488982feaSJoe Perches			WARN("USE_SPINLOCK_T",
618588982feaSJoe Perches			     "struct spinlock should be spinlock_t\n" . $herecurr);
618688982feaSJoe Perches		}
618788982feaSJoe Perches
6188a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts
618906668727SJoe Perches		if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
6190a6962d72SJoe Perches			my $fmt = get_quoted_string($line, $rawline);
6191caac1d5fSHeba Aamer			$fmt =~ s/%%//g;
6192caac1d5fSHeba Aamer			if ($fmt !~ /%/) {
6193d5e616fcSJoe Perches				if (WARN("PREFER_SEQ_PUTS",
6194d5e616fcSJoe Perches					 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
6195d5e616fcSJoe Perches				    $fix) {
6196194f66fcSJoe Perches					$fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
6197d5e616fcSJoe Perches				}
6198a6962d72SJoe Perches			}
6199a6962d72SJoe Perches		}
6200a6962d72SJoe Perches
62010b523769SJoe Perches# check for vsprintf extension %p<foo> misuses
62025b57980dSJoe Perches		if ($perl_version_ok &&
62030b523769SJoe Perches		    defined $stat &&
62040b523769SJoe Perches		    $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
62050b523769SJoe Perches		    $1 !~ /^_*volatile_*$/) {
6206e3c6bc95STobin C. Harding			my $stat_real;
6207e3c6bc95STobin C. Harding
62080b523769SJoe Perches			my $lc = $stat =~ tr@\n@@;
62090b523769SJoe Perches			$lc = $lc + $linenr;
62100b523769SJoe Perches		        for (my $count = $linenr; $count <= $lc; $count++) {
6211ffe07513SJoe Perches				my $specifier;
6212ffe07513SJoe Perches				my $extension;
62133bd32d6aSSakari Ailus				my $qualifier;
6214ffe07513SJoe Perches				my $bad_specifier = "";
62150b523769SJoe Perches				my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
62160b523769SJoe Perches				$fmt =~ s/%%//g;
6217e3c6bc95STobin C. Harding
62183bd32d6aSSakari Ailus				while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) {
6219e3c6bc95STobin C. Harding					$specifier = $1;
6220e3c6bc95STobin C. Harding					$extension = $2;
62213bd32d6aSSakari Ailus					$qualifier = $3;
6222361b0d28SLinus Torvalds					if ($extension !~ /[SsBKRraEehMmIiUDdgVCbGNOxtf]/ ||
62233bd32d6aSSakari Ailus					    ($extension eq "f" &&
62243bd32d6aSSakari Ailus					     defined $qualifier && $qualifier !~ /^w/)) {
6225e3c6bc95STobin C. Harding						$bad_specifier = $specifier;
62260b523769SJoe Perches						last;
62270b523769SJoe Perches					}
6228e3c6bc95STobin C. Harding					if ($extension eq "x" && !defined($stat_real)) {
6229e3c6bc95STobin C. Harding						if (!defined($stat_real)) {
6230e3c6bc95STobin C. Harding							$stat_real = get_stat_real($linenr, $lc);
62310b523769SJoe Perches						}
6232e3c6bc95STobin C. Harding						WARN("VSPRINTF_SPECIFIER_PX",
6233e3c6bc95STobin C. Harding						     "Using vsprintf specifier '\%px' potentially exposes the kernel memory layout, if you don't really need the address please consider using '\%p'.\n" . "$here\n$stat_real\n");
6234e3c6bc95STobin C. Harding					}
6235e3c6bc95STobin C. Harding				}
6236e3c6bc95STobin C. Harding				if ($bad_specifier ne "") {
62372a9f9d85STobin C. Harding					my $stat_real = get_stat_real($linenr, $lc);
62381df7338aSSergey Senozhatsky					my $ext_type = "Invalid";
62391df7338aSSergey Senozhatsky					my $use = "";
6240e3c6bc95STobin C. Harding					if ($bad_specifier =~ /p[Ff]/) {
62411df7338aSSergey Senozhatsky						$use = " - use %pS instead";
6242e3c6bc95STobin C. Harding						$use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
62431df7338aSSergey Senozhatsky					}
62442a9f9d85STobin C. Harding
62450b523769SJoe Perches					WARN("VSPRINTF_POINTER_EXTENSION",
6246e3c6bc95STobin C. Harding					     "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
6247e3c6bc95STobin C. Harding				}
62480b523769SJoe Perches			}
62490b523769SJoe Perches		}
62500b523769SJoe Perches
6251554e165cSAndy Whitcroft# Check for misused memsets
62525b57980dSJoe Perches		if ($perl_version_ok &&
6253d1fe9c09SJoe Perches		    defined $stat &&
62549e20a853SMateusz Kulikowski		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
6255554e165cSAndy Whitcroft
6256d7c76ba7SJoe Perches			my $ms_addr = $2;
6257d1fe9c09SJoe Perches			my $ms_val = $7;
6258d1fe9c09SJoe Perches			my $ms_size = $12;
6259d7c76ba7SJoe Perches
6260554e165cSAndy Whitcroft			if ($ms_size =~ /^(0x|)0$/i) {
6261554e165cSAndy Whitcroft				ERROR("MEMSET",
6262d7c76ba7SJoe Perches				      "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
6263554e165cSAndy Whitcroft			} elsif ($ms_size =~ /^(0x|)1$/i) {
6264554e165cSAndy Whitcroft				WARN("MEMSET",
6265d7c76ba7SJoe Perches				     "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
6266d7c76ba7SJoe Perches			}
6267d7c76ba7SJoe Perches		}
6268d7c76ba7SJoe Perches
626998a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
62705b57980dSJoe Perches#		if ($perl_version_ok &&
6271f333195dSJoe Perches#		    defined $stat &&
6272f333195dSJoe Perches#		    $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6273f333195dSJoe Perches#			if (WARN("PREFER_ETHER_ADDR_COPY",
6274f333195dSJoe Perches#				 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6275f333195dSJoe Perches#			    $fix) {
6276f333195dSJoe Perches#				$fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6277f333195dSJoe Perches#			}
6278f333195dSJoe Perches#		}
627998a9bba5SJoe Perches
6280b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
62815b57980dSJoe Perches#		if ($perl_version_ok &&
6282f333195dSJoe Perches#		    defined $stat &&
6283f333195dSJoe Perches#		    $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6284f333195dSJoe Perches#			WARN("PREFER_ETHER_ADDR_EQUAL",
6285f333195dSJoe Perches#			     "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6286f333195dSJoe Perches#		}
6287b6117d17SMateusz Kulikowski
62888617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
62898617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
62905b57980dSJoe Perches#		if ($perl_version_ok &&
6291f333195dSJoe Perches#		    defined $stat &&
6292f333195dSJoe Perches#		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6293f333195dSJoe Perches#
6294f333195dSJoe Perches#			my $ms_val = $7;
6295f333195dSJoe Perches#
6296f333195dSJoe Perches#			if ($ms_val =~ /^(?:0x|)0+$/i) {
6297f333195dSJoe Perches#				if (WARN("PREFER_ETH_ZERO_ADDR",
6298f333195dSJoe Perches#					 "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6299f333195dSJoe Perches#				    $fix) {
6300f333195dSJoe Perches#					$fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6301f333195dSJoe Perches#				}
6302f333195dSJoe Perches#			} elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6303f333195dSJoe Perches#				if (WARN("PREFER_ETH_BROADCAST_ADDR",
6304f333195dSJoe Perches#					 "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6305f333195dSJoe Perches#				    $fix) {
6306f333195dSJoe Perches#					$fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6307f333195dSJoe Perches#				}
6308f333195dSJoe Perches#			}
6309f333195dSJoe Perches#		}
63108617cd09SMateusz Kulikowski
6311d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t
63125b57980dSJoe Perches		if ($perl_version_ok &&
6313d1fe9c09SJoe Perches		    defined $stat &&
6314d7c76ba7SJoe Perches		    $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
6315d1fe9c09SJoe Perches			if (defined $2 || defined $7) {
6316d7c76ba7SJoe Perches				my $call = $1;
6317d7c76ba7SJoe Perches				my $cast1 = deparenthesize($2);
6318d7c76ba7SJoe Perches				my $arg1 = $3;
6319d1fe9c09SJoe Perches				my $cast2 = deparenthesize($7);
6320d1fe9c09SJoe Perches				my $arg2 = $8;
6321d7c76ba7SJoe Perches				my $cast;
6322d7c76ba7SJoe Perches
6323d1fe9c09SJoe Perches				if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
6324d7c76ba7SJoe Perches					$cast = "$cast1 or $cast2";
6325d7c76ba7SJoe Perches				} elsif ($cast1 ne "") {
6326d7c76ba7SJoe Perches					$cast = $cast1;
6327d7c76ba7SJoe Perches				} else {
6328d7c76ba7SJoe Perches					$cast = $cast2;
6329d7c76ba7SJoe Perches				}
6330d7c76ba7SJoe Perches				WARN("MINMAX",
6331d7c76ba7SJoe Perches				     "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
6332554e165cSAndy Whitcroft			}
6333554e165cSAndy Whitcroft		}
6334554e165cSAndy Whitcroft
63354a273195SJoe Perches# check usleep_range arguments
63365b57980dSJoe Perches		if ($perl_version_ok &&
63374a273195SJoe Perches		    defined $stat &&
63384a273195SJoe Perches		    $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
63394a273195SJoe Perches			my $min = $1;
63404a273195SJoe Perches			my $max = $7;
63414a273195SJoe Perches			if ($min eq $max) {
63424a273195SJoe Perches				WARN("USLEEP_RANGE",
6343458f69efSMauro Carvalho Chehab				     "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
63444a273195SJoe Perches			} elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
63454a273195SJoe Perches				 $min > $max) {
63464a273195SJoe Perches				WARN("USLEEP_RANGE",
6347458f69efSMauro Carvalho Chehab				     "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
63484a273195SJoe Perches			}
63494a273195SJoe Perches		}
63504a273195SJoe Perches
6351823b794cSJoe Perches# check for naked sscanf
63525b57980dSJoe Perches		if ($perl_version_ok &&
6353823b794cSJoe Perches		    defined $stat &&
63546c8bd707SJoe Perches		    $line =~ /\bsscanf\b/ &&
6355823b794cSJoe Perches		    ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
6356823b794cSJoe Perches		     $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
6357823b794cSJoe Perches		     $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
6358823b794cSJoe Perches			my $lc = $stat =~ tr@\n@@;
6359823b794cSJoe Perches			$lc = $lc + $linenr;
63602a9f9d85STobin C. Harding			my $stat_real = get_stat_real($linenr, $lc);
6361823b794cSJoe Perches			WARN("NAKED_SSCANF",
6362823b794cSJoe Perches			     "unchecked sscanf return value\n" . "$here\n$stat_real\n");
6363823b794cSJoe Perches		}
6364823b794cSJoe Perches
6365afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo>
63665b57980dSJoe Perches		if ($perl_version_ok &&
6367afc819abSJoe Perches		    defined $stat &&
6368afc819abSJoe Perches		    $line =~ /\bsscanf\b/) {
6369afc819abSJoe Perches			my $lc = $stat =~ tr@\n@@;
6370afc819abSJoe Perches			$lc = $lc + $linenr;
63712a9f9d85STobin C. Harding			my $stat_real = get_stat_real($linenr, $lc);
6372afc819abSJoe Perches			if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
6373afc819abSJoe Perches				my $format = $6;
6374afc819abSJoe Perches				my $count = $format =~ tr@%@%@;
6375afc819abSJoe Perches				if ($count == 1 &&
6376afc819abSJoe Perches				    $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
6377afc819abSJoe Perches					WARN("SSCANF_TO_KSTRTO",
6378afc819abSJoe Perches					     "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
6379afc819abSJoe Perches				}
6380afc819abSJoe Perches			}
6381afc819abSJoe Perches		}
6382afc819abSJoe Perches
638370dc8a48SJoe Perches# check for new externs in .h files.
638470dc8a48SJoe Perches		if ($realfile =~ /\.h$/ &&
638570dc8a48SJoe Perches		    $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
6386d1d85780SJoe Perches			if (CHK("AVOID_EXTERNS",
638770dc8a48SJoe Perches				"extern prototypes should be avoided in .h files\n" . $herecurr) &&
638870dc8a48SJoe Perches			    $fix) {
6389194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
639070dc8a48SJoe Perches			}
639170dc8a48SJoe Perches		}
639270dc8a48SJoe Perches
6393de7d4f0eSAndy Whitcroft# check for new externs in .c files.
6394171ae1a4SAndy Whitcroft		if ($realfile =~ /\.c$/ && defined $stat &&
6395c45dcabdSAndy Whitcroft		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
6396171ae1a4SAndy Whitcroft		{
6397c45dcabdSAndy Whitcroft			my $function_name = $1;
6398c45dcabdSAndy Whitcroft			my $paren_space = $2;
6399171ae1a4SAndy Whitcroft
6400171ae1a4SAndy Whitcroft			my $s = $stat;
6401171ae1a4SAndy Whitcroft			if (defined $cond) {
6402171ae1a4SAndy Whitcroft				substr($s, 0, length($cond), '');
6403171ae1a4SAndy Whitcroft			}
6404d8b44b58SKees Cook			if ($s =~ /^\s*;/)
6405c45dcabdSAndy Whitcroft			{
6406000d1cc1SJoe Perches				WARN("AVOID_EXTERNS",
6407000d1cc1SJoe Perches				     "externs should be avoided in .c files\n" .  $herecurr);
6408de7d4f0eSAndy Whitcroft			}
6409de7d4f0eSAndy Whitcroft
6410171ae1a4SAndy Whitcroft			if ($paren_space =~ /\n/) {
6411000d1cc1SJoe Perches				WARN("FUNCTION_ARGUMENTS",
6412000d1cc1SJoe Perches				     "arguments for function declarations should follow identifier\n" . $herecurr);
6413171ae1a4SAndy Whitcroft			}
64149c9ba34eSAndy Whitcroft
64159c9ba34eSAndy Whitcroft		} elsif ($realfile =~ /\.c$/ && defined $stat &&
64169c9ba34eSAndy Whitcroft		    $stat =~ /^.\s*extern\s+/)
64179c9ba34eSAndy Whitcroft		{
6418000d1cc1SJoe Perches			WARN("AVOID_EXTERNS",
6419000d1cc1SJoe Perches			     "externs should be avoided in .c files\n" .  $herecurr);
6420171ae1a4SAndy Whitcroft		}
6421171ae1a4SAndy Whitcroft
6422a0ad7596SJoe Perches# check for function declarations that have arguments without identifier names
6423a0ad7596SJoe Perches		if (defined $stat &&
6424d8b44b58SKees Cook		    $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6425d8b44b58SKees Cook		    $1 ne "void") {
6426d8b44b58SKees Cook			my $args = trim($1);
6427ca0d8929SJoe Perches			while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6428ca0d8929SJoe Perches				my $arg = trim($1);
6429d8b44b58SKees Cook				if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
6430ca0d8929SJoe Perches					WARN("FUNCTION_ARGUMENTS",
6431ca0d8929SJoe Perches					     "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6432ca0d8929SJoe Perches				}
6433ca0d8929SJoe Perches			}
6434ca0d8929SJoe Perches		}
6435ca0d8929SJoe Perches
6436a0ad7596SJoe Perches# check for function definitions
64375b57980dSJoe Perches		if ($perl_version_ok &&
6438a0ad7596SJoe Perches		    defined $stat &&
6439a0ad7596SJoe Perches		    $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6440a0ad7596SJoe Perches			$context_function = $1;
6441a0ad7596SJoe Perches
6442a0ad7596SJoe Perches# check for multiline function definition with misplaced open brace
6443a0ad7596SJoe Perches			my $ok = 0;
6444a0ad7596SJoe Perches			my $cnt = statement_rawlines($stat);
6445a0ad7596SJoe Perches			my $herectx = $here . "\n";
6446a0ad7596SJoe Perches			for (my $n = 0; $n < $cnt; $n++) {
6447a0ad7596SJoe Perches				my $rl = raw_line($linenr, $n);
6448a0ad7596SJoe Perches				$herectx .=  $rl . "\n";
6449a0ad7596SJoe Perches				$ok = 1 if ($rl =~ /^[ \+]\{/);
6450a0ad7596SJoe Perches				$ok = 1 if ($rl =~ /\{/ && $n == 0);
6451a0ad7596SJoe Perches				last if $rl =~ /^[ \+].*\{/;
6452a0ad7596SJoe Perches			}
6453a0ad7596SJoe Perches			if (!$ok) {
6454a0ad7596SJoe Perches				ERROR("OPEN_BRACE",
6455a0ad7596SJoe Perches				      "open brace '{' following function definitions go on the next line\n" . $herectx);
6456a0ad7596SJoe Perches			}
6457a0ad7596SJoe Perches		}
6458a0ad7596SJoe Perches
6459de7d4f0eSAndy Whitcroft# checks for new __setup's
6460de7d4f0eSAndy Whitcroft		if ($rawline =~ /\b__setup\("([^"]*)"/) {
6461de7d4f0eSAndy Whitcroft			my $name = $1;
6462de7d4f0eSAndy Whitcroft
6463de7d4f0eSAndy Whitcroft			if (!grep(/$name/, @setup_docs)) {
6464000d1cc1SJoe Perches				CHK("UNDOCUMENTED_SETUP",
64652581ac7cSTim Froidcoeur				    "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr);
6466de7d4f0eSAndy Whitcroft			}
6467653d4876SAndy Whitcroft		}
64689c0ca6f9SAndy Whitcroft
6469e29a70f1SJoe Perches# check for pointless casting of alloc functions
6470e29a70f1SJoe Perches		if ($line =~ /\*\s*\)\s*$allocFunctions\b/) {
6471000d1cc1SJoe Perches			WARN("UNNECESSARY_CASTS",
6472000d1cc1SJoe Perches			     "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
64739c0ca6f9SAndy Whitcroft		}
647413214adfSAndy Whitcroft
6475a640d25cSJoe Perches# alloc style
6476a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
64775b57980dSJoe Perches		if ($perl_version_ok &&
6478e29a70f1SJoe Perches		    $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6479a640d25cSJoe Perches			CHK("ALLOC_SIZEOF_STRUCT",
6480a640d25cSJoe Perches			    "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6481a640d25cSJoe Perches		}
6482a640d25cSJoe Perches
648360a55369SJoe Perches# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
64845b57980dSJoe Perches		if ($perl_version_ok &&
64851b4a2ed4SJoe Perches		    defined $stat &&
64861b4a2ed4SJoe Perches		    $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
648760a55369SJoe Perches			my $oldfunc = $3;
648860a55369SJoe Perches			my $a1 = $4;
648960a55369SJoe Perches			my $a2 = $10;
649060a55369SJoe Perches			my $newfunc = "kmalloc_array";
649160a55369SJoe Perches			$newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
649260a55369SJoe Perches			my $r1 = $a1;
649360a55369SJoe Perches			my $r2 = $a2;
649460a55369SJoe Perches			if ($a1 =~ /^sizeof\s*\S/) {
649560a55369SJoe Perches				$r1 = $a2;
649660a55369SJoe Perches				$r2 = $a1;
649760a55369SJoe Perches			}
6498e367455aSJoe Perches			if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6499e367455aSJoe Perches			    !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
65001b4a2ed4SJoe Perches				my $cnt = statement_rawlines($stat);
6501e3d95a2aSTobin C. Harding				my $herectx = get_stat_here($linenr, $cnt, $here);
6502e3d95a2aSTobin C. Harding
6503e367455aSJoe Perches				if (WARN("ALLOC_WITH_MULTIPLY",
65041b4a2ed4SJoe Perches					 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
65051b4a2ed4SJoe Perches				    $cnt == 1 &&
6506e367455aSJoe Perches				    $fix) {
6507194f66fcSJoe Perches					$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;
650860a55369SJoe Perches				}
650960a55369SJoe Perches			}
651060a55369SJoe Perches		}
651160a55369SJoe Perches
6512972fdea2SJoe Perches# check for krealloc arg reuse
65135b57980dSJoe Perches		if ($perl_version_ok &&
65144cab63ceSJoe Perches		    $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ &&
65154cab63ceSJoe Perches		    $1 eq $3) {
6516972fdea2SJoe Perches			WARN("KREALLOC_ARG_REUSE",
6517972fdea2SJoe Perches			     "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6518972fdea2SJoe Perches		}
6519972fdea2SJoe Perches
65205ce59ae0SJoe Perches# check for alloc argument mismatch
65215ce59ae0SJoe Perches		if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
65225ce59ae0SJoe Perches			WARN("ALLOC_ARRAY_ARGS",
65235ce59ae0SJoe Perches			     "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
65245ce59ae0SJoe Perches		}
65255ce59ae0SJoe Perches
6526caf2a54fSJoe Perches# check for multiple semicolons
6527caf2a54fSJoe Perches		if ($line =~ /;\s*;\s*$/) {
6528d5e616fcSJoe Perches			if (WARN("ONE_SEMICOLON",
6529d5e616fcSJoe Perches				 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6530d5e616fcSJoe Perches			    $fix) {
6531194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
6532d5e616fcSJoe Perches			}
6533d1e2ad07SJoe Perches		}
6534d1e2ad07SJoe Perches
6535cec3aaa5STomas Winkler# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6536cec3aaa5STomas Winkler		if ($realfile !~ m@^include/uapi/@ &&
6537cec3aaa5STomas Winkler		    $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
65380ab90191SJoe Perches			my $ull = "";
65390ab90191SJoe Perches			$ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
65400ab90191SJoe Perches			if (CHK("BIT_MACRO",
65410ab90191SJoe Perches				"Prefer using the BIT$ull macro\n" . $herecurr) &&
65420ab90191SJoe Perches			    $fix) {
65430ab90191SJoe Perches				$fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
65440ab90191SJoe Perches			}
65450ab90191SJoe Perches		}
65460ab90191SJoe Perches
654750161266SJoe Perches# check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too)
65483e89ad85SJerome Forissier		if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^${CONFIG_}/) {
654950161266SJoe Perches			WARN("IS_ENABLED_CONFIG",
65503e89ad85SJerome Forissier			     "IS_ENABLED($1) is normally used as IS_ENABLED(${CONFIG_}$1)\n" . $herecurr);
655150161266SJoe Perches		}
655250161266SJoe Perches
65532d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
65543e89ad85SJerome Forissier		if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(${CONFIG_}[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
65552d632745SJoe Perches			my $config = $1;
65562d632745SJoe Perches			if (WARN("PREFER_IS_ENABLED",
65573e89ad85SJerome Forissier				 "Prefer IS_ENABLED(<FOO>) to ${CONFIG_}<FOO> || ${CONFIG_}<FOO>_MODULE\n" . $herecurr) &&
65582d632745SJoe Perches			    $fix) {
65592d632745SJoe Perches				$fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
65602d632745SJoe Perches			}
65612d632745SJoe Perches		}
65622d632745SJoe Perches
6563f36d3eb8SJoe Perches# check for /* fallthrough */ like comment, prefer fallthrough;
6564f36d3eb8SJoe Perches		my @fallthroughs = (
6565f36d3eb8SJoe Perches			'fallthrough',
6566f36d3eb8SJoe Perches			'@fallthrough@',
6567f36d3eb8SJoe Perches			'lint -fallthrough[ \t]*',
6568f36d3eb8SJoe Perches			'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)',
6569f36d3eb8SJoe Perches			'(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?',
6570f36d3eb8SJoe Perches			'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
6571f36d3eb8SJoe Perches			'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
6572f36d3eb8SJoe Perches		    );
6573f36d3eb8SJoe Perches		if ($raw_comment ne '') {
6574f36d3eb8SJoe Perches			foreach my $ft (@fallthroughs) {
6575f36d3eb8SJoe Perches				if ($raw_comment =~ /$ft/) {
6576f36d3eb8SJoe Perches					my $msg_level = \&WARN;
6577f36d3eb8SJoe Perches					$msg_level = \&CHK if ($file);
6578f36d3eb8SJoe Perches					&{$msg_level}("PREFER_FALLTHROUGH",
6579f36d3eb8SJoe Perches						      "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr);
6580f36d3eb8SJoe Perches					last;
6581f36d3eb8SJoe Perches				}
6582f36d3eb8SJoe Perches			}
6583f36d3eb8SJoe Perches		}
6584f36d3eb8SJoe Perches
6585d1e2ad07SJoe Perches# check for switch/default statements without a break;
65865b57980dSJoe Perches		if ($perl_version_ok &&
6587d1e2ad07SJoe Perches		    defined $stat &&
6588d1e2ad07SJoe Perches		    $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
6589d1e2ad07SJoe Perches			my $cnt = statement_rawlines($stat);
6590e3d95a2aSTobin C. Harding			my $herectx = get_stat_here($linenr, $cnt, $here);
6591e3d95a2aSTobin C. Harding
6592d1e2ad07SJoe Perches			WARN("DEFAULT_NO_BREAK",
6593d1e2ad07SJoe Perches			     "switch default: should use break\n" . $herectx);
6594caf2a54fSJoe Perches		}
6595caf2a54fSJoe Perches
659613214adfSAndy Whitcroft# check for gcc specific __FUNCTION__
6597d5e616fcSJoe Perches		if ($line =~ /\b__FUNCTION__\b/) {
6598d5e616fcSJoe Perches			if (WARN("USE_FUNC",
6599d5e616fcSJoe Perches				 "__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr) &&
6600d5e616fcSJoe Perches			    $fix) {
6601194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
6602d5e616fcSJoe Perches			}
660313214adfSAndy Whitcroft		}
6604773647a0SAndy Whitcroft
660562ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__
660662ec818fSJoe Perches		while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
660762ec818fSJoe Perches			ERROR("DATE_TIME",
660862ec818fSJoe Perches			      "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
660962ec818fSJoe Perches		}
661062ec818fSJoe Perches
66112c92488aSJoe Perches# check for use of yield()
66122c92488aSJoe Perches		if ($line =~ /\byield\s*\(\s*\)/) {
66132c92488aSJoe Perches			WARN("YIELD",
66142c92488aSJoe Perches			     "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n"  . $herecurr);
66152c92488aSJoe Perches		}
66162c92488aSJoe Perches
6617179f8f40SJoe Perches# check for comparisons against true and false
6618179f8f40SJoe Perches		if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6619179f8f40SJoe Perches			my $lead = $1;
6620179f8f40SJoe Perches			my $arg = $2;
6621179f8f40SJoe Perches			my $test = $3;
6622179f8f40SJoe Perches			my $otype = $4;
6623179f8f40SJoe Perches			my $trail = $5;
6624179f8f40SJoe Perches			my $op = "!";
6625179f8f40SJoe Perches
6626179f8f40SJoe Perches			($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6627179f8f40SJoe Perches
6628179f8f40SJoe Perches			my $type = lc($otype);
6629179f8f40SJoe Perches			if ($type =~ /^(?:true|false)$/) {
6630179f8f40SJoe Perches				if (("$test" eq "==" && "$type" eq "true") ||
6631179f8f40SJoe Perches				    ("$test" eq "!=" && "$type" eq "false")) {
6632179f8f40SJoe Perches					$op = "";
6633179f8f40SJoe Perches				}
6634179f8f40SJoe Perches
6635179f8f40SJoe Perches				CHK("BOOL_COMPARISON",
6636179f8f40SJoe Perches				    "Using comparison to $otype is error prone\n" . $herecurr);
6637179f8f40SJoe Perches
6638179f8f40SJoe Perches## maybe suggesting a correct construct would better
6639179f8f40SJoe Perches##				    "Using comparison to $otype is error prone.  Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6640179f8f40SJoe Perches
6641179f8f40SJoe Perches			}
6642179f8f40SJoe Perches		}
6643179f8f40SJoe Perches
66444882720bSThomas Gleixner# check for semaphores initialized locked
66454882720bSThomas Gleixner		if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
6646000d1cc1SJoe Perches			WARN("CONSIDER_COMPLETION",
6647000d1cc1SJoe Perches			     "consider using a completion\n" . $herecurr);
6648773647a0SAndy Whitcroft		}
66496712d858SJoe Perches
665067d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto*
665167d0a075SJoe Perches		if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
6652000d1cc1SJoe Perches			WARN("CONSIDER_KSTRTO",
665367d0a075SJoe Perches			     "$1 is obsolete, use k$3 instead\n" . $herecurr);
6654773647a0SAndy Whitcroft		}
66556712d858SJoe Perches
6656ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please
6657f3db6639SMichael Ellerman		if ($line =~ /^.\s*__initcall\s*\(/) {
6658000d1cc1SJoe Perches			WARN("USE_DEVICE_INITCALL",
6659ae3ccc46SFabian Frederick			     "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6660f3db6639SMichael Ellerman		}
66616712d858SJoe Perches
66623d709ab5SPaul E. McKenney# check for spin_is_locked(), suggest lockdep instead
66633d709ab5SPaul E. McKenney		if ($line =~ /\bspin_is_locked\(/) {
66643d709ab5SPaul E. McKenney			WARN("USE_LOCKDEP",
66653d709ab5SPaul E. McKenney			     "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
66663d709ab5SPaul E. McKenney		}
66673d709ab5SPaul E. McKenney
66689189c7e7SJoe Perches# check for deprecated apis
66699189c7e7SJoe Perches		if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) {
66709189c7e7SJoe Perches			my $deprecated_api = $1;
66719189c7e7SJoe Perches			my $new_api = $deprecated_apis{$deprecated_api};
66729189c7e7SJoe Perches			WARN("DEPRECATED_API",
66739189c7e7SJoe Perches			     "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr);
66749189c7e7SJoe Perches		}
66759189c7e7SJoe Perches
66760f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree)
6677d9190e4eSJoe Perches# and avoid what seem like struct definitions 'struct foo {'
6678ced69da1SQuentin Monnet		if (defined($const_structs) &&
6679ced69da1SQuentin Monnet		    $line !~ /\bconst\b/ &&
6680d9190e4eSJoe Perches		    $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
6681000d1cc1SJoe Perches			WARN("CONST_STRUCT",
6682d9190e4eSJoe Perches			     "struct $1 should normally be const\n" . $herecurr);
66832b6db5cbSAndy Whitcroft		}
6684773647a0SAndy Whitcroft
6685773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong
6686773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right
6687773647a0SAndy Whitcroft		if ($line =~ /\bNR_CPUS\b/ &&
6688c45dcabdSAndy Whitcroft		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6689c45dcabdSAndy Whitcroft		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
6690171ae1a4SAndy Whitcroft		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6691171ae1a4SAndy Whitcroft		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6692171ae1a4SAndy Whitcroft		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
6693773647a0SAndy Whitcroft		{
6694000d1cc1SJoe Perches			WARN("NR_CPUS",
6695000d1cc1SJoe Perches			     "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6696773647a0SAndy Whitcroft		}
66979c9ba34eSAndy Whitcroft
669852ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
669952ea8506SJoe Perches		if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
670052ea8506SJoe Perches			ERROR("DEFINE_ARCH_HAS",
670152ea8506SJoe Perches			      "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
670252ea8506SJoe Perches		}
670352ea8506SJoe Perches
6704acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)"
67055b57980dSJoe Perches		if ($perl_version_ok &&
6706acd9362cSJoe Perches		    $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6707acd9362cSJoe Perches			WARN("LIKELY_MISUSE",
6708acd9362cSJoe Perches			     "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6709acd9362cSJoe Perches		}
6710acd9362cSJoe Perches
6711de3f186fSDenis Efremov# nested likely/unlikely calls
6712de3f186fSDenis Efremov		if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) {
6713de3f186fSDenis Efremov			WARN("LIKELY_MISUSE",
6714de3f186fSDenis Efremov			     "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr);
6715de3f186fSDenis Efremov		}
6716de3f186fSDenis Efremov
6717691d77b6SAndy Whitcroft# whine mightly about in_atomic
6718691d77b6SAndy Whitcroft		if ($line =~ /\bin_atomic\s*\(/) {
6719691d77b6SAndy Whitcroft			if ($realfile =~ m@^drivers/@) {
6720000d1cc1SJoe Perches				ERROR("IN_ATOMIC",
6721000d1cc1SJoe Perches				      "do not use in_atomic in drivers\n" . $herecurr);
6722f4a87736SAndy Whitcroft			} elsif ($realfile !~ m@^kernel/@) {
6723000d1cc1SJoe Perches				WARN("IN_ATOMIC",
6724000d1cc1SJoe Perches				     "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
6725691d77b6SAndy Whitcroft			}
6726691d77b6SAndy Whitcroft		}
67271704f47bSPeter Zijlstra
67280f5225b0SPeter Zijlstra# check for mutex_trylock_recursive usage
67290f5225b0SPeter Zijlstra		if ($line =~ /mutex_trylock_recursive/) {
67300f5225b0SPeter Zijlstra			ERROR("LOCKING",
67310f5225b0SPeter Zijlstra			      "recursive locking is bad, do not use this ever.\n" . $herecurr);
67320f5225b0SPeter Zijlstra		}
67330f5225b0SPeter Zijlstra
67341704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class
67351704f47bSPeter Zijlstra		if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
67361704f47bSPeter Zijlstra		    $line =~ /__lockdep_no_validate__\s*\)/ ) {
67371704f47bSPeter Zijlstra			if ($realfile !~ m@^kernel/lockdep@ &&
67381704f47bSPeter Zijlstra			    $realfile !~ m@^include/linux/lockdep@ &&
67391704f47bSPeter Zijlstra			    $realfile !~ m@^drivers/base/core@) {
6740000d1cc1SJoe Perches				ERROR("LOCKDEP",
6741000d1cc1SJoe Perches				      "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
67421704f47bSPeter Zijlstra			}
67431704f47bSPeter Zijlstra		}
674488f8831cSDave Jones
6745b392c64fSJoe Perches		if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6746b392c64fSJoe Perches		    $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
6747000d1cc1SJoe Perches			WARN("EXPORTED_WORLD_WRITABLE",
6748000d1cc1SJoe Perches			     "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
674988f8831cSDave Jones		}
67502435880fSJoe Perches
675100180468SJoe Perches# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
675200180468SJoe Perches# and whether or not function naming is typical and if
675300180468SJoe Perches# DEVICE_ATTR permissions uses are unusual too
67545b57980dSJoe Perches		if ($perl_version_ok &&
675500180468SJoe Perches		    defined $stat &&
675600180468SJoe Perches		    $stat =~ /\bDEVICE_ATTR\s*\(\s*(\w+)\s*,\s*\(?\s*(\s*(?:${multi_mode_perms_string_search}|0[0-7]{3,3})\s*)\s*\)?\s*,\s*(\w+)\s*,\s*(\w+)\s*\)/) {
675700180468SJoe Perches			my $var = $1;
675800180468SJoe Perches			my $perms = $2;
675900180468SJoe Perches			my $show = $3;
676000180468SJoe Perches			my $store = $4;
676100180468SJoe Perches			my $octal_perms = perms_to_octal($perms);
676200180468SJoe Perches			if ($show =~ /^${var}_show$/ &&
676300180468SJoe Perches			    $store =~ /^${var}_store$/ &&
676400180468SJoe Perches			    $octal_perms eq "0644") {
676500180468SJoe Perches				if (WARN("DEVICE_ATTR_RW",
676600180468SJoe Perches					 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
676700180468SJoe Perches				    $fix) {
676800180468SJoe Perches					$fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
676900180468SJoe Perches				}
677000180468SJoe Perches			} elsif ($show =~ /^${var}_show$/ &&
677100180468SJoe Perches				 $store =~ /^NULL$/ &&
677200180468SJoe Perches				 $octal_perms eq "0444") {
677300180468SJoe Perches				if (WARN("DEVICE_ATTR_RO",
677400180468SJoe Perches					 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
677500180468SJoe Perches				    $fix) {
677600180468SJoe Perches					$fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
677700180468SJoe Perches				}
677800180468SJoe Perches			} elsif ($show =~ /^NULL$/ &&
677900180468SJoe Perches				 $store =~ /^${var}_store$/ &&
678000180468SJoe Perches				 $octal_perms eq "0200") {
678100180468SJoe Perches				if (WARN("DEVICE_ATTR_WO",
678200180468SJoe Perches					 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
678300180468SJoe Perches				    $fix) {
678400180468SJoe Perches					$fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
678500180468SJoe Perches				}
678600180468SJoe Perches			} elsif ($octal_perms eq "0644" ||
678700180468SJoe Perches				 $octal_perms eq "0444" ||
678800180468SJoe Perches				 $octal_perms eq "0200") {
678900180468SJoe Perches				my $newshow = "$show";
679000180468SJoe Perches				$newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
679100180468SJoe Perches				my $newstore = $store;
679200180468SJoe Perches				$newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
679300180468SJoe Perches				my $rename = "";
679400180468SJoe Perches				if ($show ne $newshow) {
679500180468SJoe Perches					$rename .= " '$show' to '$newshow'";
679600180468SJoe Perches				}
679700180468SJoe Perches				if ($store ne $newstore) {
679800180468SJoe Perches					$rename .= " '$store' to '$newstore'";
679900180468SJoe Perches				}
680000180468SJoe Perches				WARN("DEVICE_ATTR_FUNCTIONS",
680100180468SJoe Perches				     "Consider renaming function(s)$rename\n" . $herecurr);
680200180468SJoe Perches			} else {
680300180468SJoe Perches				WARN("DEVICE_ATTR_PERMS",
680400180468SJoe Perches				     "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
680500180468SJoe Perches			}
680600180468SJoe Perches		}
680700180468SJoe Perches
6808515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal
6809515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
681073121534SJoe Perches# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
681173121534SJoe Perches#   specific definition of not visible in sysfs.
681273121534SJoe Perches# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
681373121534SJoe Perches#   use the default permissions
68145b57980dSJoe Perches		if ($perl_version_ok &&
6815459cf0aeSJoe Perches		    defined $stat &&
6816515a235eSJoe Perches		    $line =~ /$mode_perms_search/) {
68172435880fSJoe Perches			foreach my $entry (@mode_permission_funcs) {
68182435880fSJoe Perches				my $func = $entry->[0];
68192435880fSJoe Perches				my $arg_pos = $entry->[1];
68202435880fSJoe Perches
6821459cf0aeSJoe Perches				my $lc = $stat =~ tr@\n@@;
6822459cf0aeSJoe Perches				$lc = $lc + $linenr;
68232a9f9d85STobin C. Harding				my $stat_real = get_stat_real($linenr, $lc);
6824459cf0aeSJoe Perches
68252435880fSJoe Perches				my $skip_args = "";
68262435880fSJoe Perches				if ($arg_pos > 1) {
68272435880fSJoe Perches					$arg_pos--;
68282435880fSJoe Perches					$skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
68292435880fSJoe Perches				}
6830f90774e1SJoe Perches				my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
6831459cf0aeSJoe Perches				if ($stat =~ /$test/) {
68322435880fSJoe Perches					my $val = $1;
68332435880fSJoe Perches					$val = $6 if ($skip_args ne "");
683473121534SJoe Perches					if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
683573121534SJoe Perches					    (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
683673121534SJoe Perches					     ($val =~ /^$Octal$/ && length($val) ne 4))) {
68372435880fSJoe Perches						ERROR("NON_OCTAL_PERMISSIONS",
6838459cf0aeSJoe Perches						      "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
6839f90774e1SJoe Perches					}
6840f90774e1SJoe Perches					if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
6841c0a5c898SJoe Perches						ERROR("EXPORTED_WORLD_WRITABLE",
6842459cf0aeSJoe Perches						      "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
68432435880fSJoe Perches					}
6844459cf0aeSJoe Perches				}
6845459cf0aeSJoe Perches			}
6846459cf0aeSJoe Perches		}
6847459cf0aeSJoe Perches
6848459cf0aeSJoe Perches# check for uses of S_<PERMS> that could be octal for readability
6849bc22d9a7SJoe Perches		while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
685000180468SJoe Perches			my $oval = $1;
685100180468SJoe Perches			my $octal = perms_to_octal($oval);
6852f90774e1SJoe Perches			if (WARN("SYMBOLIC_PERMS",
6853459cf0aeSJoe Perches				 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6854f90774e1SJoe Perches			    $fix) {
685500180468SJoe Perches				$fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
68562435880fSJoe Perches			}
685713214adfSAndy Whitcroft		}
68585a6d20ceSBjorn Andersson
68595a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h
68605a6d20ceSBjorn Andersson		if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
68615a6d20ceSBjorn Andersson			my $extracted_string = get_quoted_string($line, $rawline);
68625a6d20ceSBjorn Andersson			my $valid_licenses = qr{
68635a6d20ceSBjorn Andersson						GPL|
68645a6d20ceSBjorn Andersson						GPL\ v2|
68655a6d20ceSBjorn Andersson						GPL\ and\ additional\ rights|
68665a6d20ceSBjorn Andersson						Dual\ BSD/GPL|
68675a6d20ceSBjorn Andersson						Dual\ MIT/GPL|
68685a6d20ceSBjorn Andersson						Dual\ MPL/GPL|
68695a6d20ceSBjorn Andersson						Proprietary
68705a6d20ceSBjorn Andersson					}x;
68715a6d20ceSBjorn Andersson			if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
68725a6d20ceSBjorn Andersson				WARN("MODULE_LICENSE",
68735a6d20ceSBjorn Andersson				     "unknown module license " . $extracted_string . "\n" . $herecurr);
68745a6d20ceSBjorn Andersson			}
68755a6d20ceSBjorn Andersson		}
68766a8d76cbSMatteo Croce
68776a8d76cbSMatteo Croce# check for sysctl duplicate constants
68786a8d76cbSMatteo Croce		if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) {
68796a8d76cbSMatteo Croce			WARN("DUPLICATED_SYSCTL_CONST",
68806a8d76cbSMatteo Croce				"duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
68816a8d76cbSMatteo Croce		}
6882515a235eSJoe Perches	}
688313214adfSAndy Whitcroft
688413214adfSAndy Whitcroft	# If we have no input at all, then there is nothing to report on
688513214adfSAndy Whitcroft	# so just keep quiet.
688613214adfSAndy Whitcroft	if ($#rawlines == -1) {
688713214adfSAndy Whitcroft		exit(0);
68880a920b5bSAndy Whitcroft	}
68890a920b5bSAndy Whitcroft
68908905a67cSAndy Whitcroft	# In mailback mode only produce a report in the negative, for
68918905a67cSAndy Whitcroft	# things that appear to be patches.
68928905a67cSAndy Whitcroft	if ($mailback && ($clean == 1 || !$is_patch)) {
68938905a67cSAndy Whitcroft		exit(0);
68948905a67cSAndy Whitcroft	}
68958905a67cSAndy Whitcroft
68968905a67cSAndy Whitcroft	# This is not a patch, and we are are in 'no-patch' mode so
68978905a67cSAndy Whitcroft	# just keep quiet.
68988905a67cSAndy Whitcroft	if (!$chk_patch && !$is_patch) {
68998905a67cSAndy Whitcroft		exit(0);
69008905a67cSAndy Whitcroft	}
69018905a67cSAndy Whitcroft
6902a08ffbefSStafford Horne	if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
6903000d1cc1SJoe Perches		ERROR("NOT_UNIFIED_DIFF",
6904000d1cc1SJoe Perches		      "Does not appear to be a unified-diff format patch\n");
69050a920b5bSAndy Whitcroft	}
6906cd261496SGeert Uytterhoeven	if ($is_patch && $has_commit_log && $chk_signoff) {
6907cd261496SGeert Uytterhoeven		if ($signoff == 0) {
6908000d1cc1SJoe Perches			ERROR("MISSING_SIGN_OFF",
6909000d1cc1SJoe Perches			      "Missing Signed-off-by: line(s)\n");
6910cd261496SGeert Uytterhoeven		} elsif (!$authorsignoff) {
6911cd261496SGeert Uytterhoeven			WARN("NO_AUTHOR_SIGN_OFF",
6912cd261496SGeert Uytterhoeven			     "Missing Signed-off-by: line by nominal patch author '$author'\n");
6913cd261496SGeert Uytterhoeven		}
69140a920b5bSAndy Whitcroft	}
69150a920b5bSAndy Whitcroft
6916f0a594c1SAndy Whitcroft	print report_dump();
691713214adfSAndy Whitcroft	if ($summary && !($clean == 1 && $quiet == 1)) {
691813214adfSAndy Whitcroft		print "$filename " if ($summary_file);
69196c72ffaaSAndy Whitcroft		print "total: $cnt_error errors, $cnt_warn warnings, " .
69206c72ffaaSAndy Whitcroft			(($check)? "$cnt_chk checks, " : "") .
69216c72ffaaSAndy Whitcroft			"$cnt_lines lines checked\n";
69226c72ffaaSAndy Whitcroft	}
69238905a67cSAndy Whitcroft
6924d2c0a235SAndy Whitcroft	if ($quiet == 0) {
6925ef212196SJoe Perches		# If there were any defects found and not already fixing them
6926ef212196SJoe Perches		if (!$clean and !$fix) {
6927ef212196SJoe Perches			print << "EOM"
6928ef212196SJoe Perches
6929ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to
6930ef212196SJoe Perches      mechanically convert to the typical style using --fix or --fix-inplace.
6931ef212196SJoe PerchesEOM
6932ef212196SJoe Perches		}
6933d2c0a235SAndy Whitcroft		# If there were whitespace errors which cleanpatch can fix
6934d2c0a235SAndy Whitcroft		# then suggest that.
6935d2c0a235SAndy Whitcroft		if ($rpt_cleaners) {
6936b0781216SMike Frysinger			$rpt_cleaners = 0;
6937d8469f16SJoe Perches			print << "EOM"
6938d8469f16SJoe Perches
6939d8469f16SJoe PerchesNOTE: Whitespace errors detected.
6940d8469f16SJoe Perches      You may wish to use scripts/cleanpatch or scripts/cleanfile
6941d8469f16SJoe PerchesEOM
6942d2c0a235SAndy Whitcroft		}
6943d2c0a235SAndy Whitcroft	}
6944d2c0a235SAndy Whitcroft
6945d752fcc8SJoe Perches	if ($clean == 0 && $fix &&
6946d752fcc8SJoe Perches	    ("@rawlines" ne "@fixed" ||
6947d752fcc8SJoe Perches	     $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
69489624b8d6SJoe Perches		my $newfile = $filename;
69499624b8d6SJoe Perches		$newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
69503705ce5bSJoe Perches		my $linecount = 0;
69513705ce5bSJoe Perches		my $f;
69523705ce5bSJoe Perches
6953d752fcc8SJoe Perches		@fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6954d752fcc8SJoe Perches
69553705ce5bSJoe Perches		open($f, '>', $newfile)
69563705ce5bSJoe Perches		    or die "$P: Can't open $newfile for write\n";
69573705ce5bSJoe Perches		foreach my $fixed_line (@fixed) {
69583705ce5bSJoe Perches			$linecount++;
69593705ce5bSJoe Perches			if ($file) {
69603705ce5bSJoe Perches				if ($linecount > 3) {
69613705ce5bSJoe Perches					$fixed_line =~ s/^\+//;
69623705ce5bSJoe Perches					print $f $fixed_line . "\n";
69633705ce5bSJoe Perches				}
69643705ce5bSJoe Perches			} else {
69653705ce5bSJoe Perches				print $f $fixed_line . "\n";
69663705ce5bSJoe Perches			}
69673705ce5bSJoe Perches		}
69683705ce5bSJoe Perches		close($f);
69693705ce5bSJoe Perches
69703705ce5bSJoe Perches		if (!$quiet) {
69713705ce5bSJoe Perches			print << "EOM";
6972d8469f16SJoe Perches
69733705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile'
69743705ce5bSJoe Perches
69753705ce5bSJoe PerchesDo _NOT_ trust the results written to this file.
69763705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness.
69773705ce5bSJoe Perches
69783705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches.
69793705ce5bSJoe PerchesNo warranties, expressed or implied...
69803705ce5bSJoe PerchesEOM
69813705ce5bSJoe Perches		}
69823705ce5bSJoe Perches	}
69833705ce5bSJoe Perches
6984d8469f16SJoe Perches	if ($quiet == 0) {
6985d8469f16SJoe Perches		print "\n";
6986d8469f16SJoe Perches		if ($clean == 1) {
6987d8469f16SJoe Perches			print "$vname has no obvious style problems and is ready for submission.\n";
6988d8469f16SJoe Perches		} else {
6989d8469f16SJoe Perches			print "$vname has style problems, please review.\n";
69900a920b5bSAndy Whitcroft		}
69910a920b5bSAndy Whitcroft	}
69920a920b5bSAndy Whitcroft	return $clean;
69930a920b5bSAndy Whitcroft}
6994