xref: /linux-6.15/scripts/checkpatch.pl (revision 76f381bb)
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;
2652178ce0SDwaipayan Raymy $verbose = 0;
2752178ce0SDwaipayan Raymy %verbose_messages = ();
2852178ce0SDwaipayan Raymy %verbose_emitted = ();
290a920b5bSAndy Whitcroftmy $tree = 1;
300a920b5bSAndy Whitcroftmy $chk_signoff = 1;
310a920b5bSAndy Whitcroftmy $chk_patch = 1;
32773647a0SAndy Whitcroftmy $tst_only;
336c72ffaaSAndy Whitcroftmy $emacs = 0;
348905a67cSAndy Whitcroftmy $terse = 0;
3534d8815fSJoe Perchesmy $showfile = 0;
366c72ffaaSAndy Whitcroftmy $file = 0;
374a593c34SDu, Changbinmy $git = 0;
380dea9f1eSJoe Perchesmy %git_commits = ();
396c72ffaaSAndy Whitcroftmy $check = 0;
402ac73b4fSJoe Perchesmy $check_orig = 0;
418905a67cSAndy Whitcroftmy $summary = 1;
428905a67cSAndy Whitcroftmy $mailback = 0;
4313214adfSAndy Whitcroftmy $summary_file = 0;
44000d1cc1SJoe Perchesmy $show_types = 0;
453beb42ecSJoe Perchesmy $list_types = 0;
463705ce5bSJoe Perchesmy $fix = 0;
479624b8d6SJoe Perchesmy $fix_inplace = 0;
486c72ffaaSAndy Whitcroftmy $root;
490f7f635bSJoe Perchesmy $gitroot = $ENV{'GIT_DIR'};
500f7f635bSJoe Perches$gitroot = ".git" if !defined($gitroot);
51c2fdda0dSAndy Whitcroftmy %debug;
523445686aSJoe Perchesmy %camelcase = ();
5391bfe484SJoe Perchesmy %use_type = ();
5491bfe484SJoe Perchesmy @use = ();
5591bfe484SJoe Perchesmy %ignore_type = ();
56000d1cc1SJoe Perchesmy @ignore = ();
5777f5b10aSHannes Edermy $help = 0;
58000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf";
59bdc48fa1SJoe Perchesmy $max_line_length = 100;
60d62a201fSDave Hansenmy $ignore_perl_version = 0;
61d62a201fSDave Hansenmy $minimum_perl_version = 5.10.0;
6256193274SVadim Bendeburymy $min_conf_desc_length = 4;
6366b47b4aSKees Cookmy $spelling_file = "$D/spelling.txt";
64ebfd7d62SJoe Perchesmy $codespell = 0;
65f1a63678SMaxim Uvarovmy $codespellfile = "/usr/share/codespell/dictionary.txt";
660ee3e7b8SPeter Ujfalusimy $user_codespellfile = "";
67bf1fa1daSJoe Perchesmy $conststructsfile = "$D/const_structs.checkpatch";
6852178ce0SDwaipayan Raymy $docsfile = "$D/../Documentation/dev-tools/checkpatch.rst";
69ced69da1SQuentin Monnetmy $typedefsfile;
70737c0767SJohn Brooksmy $color = "auto";
7198005e8cSVadim Bendeburymy $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE
72dbbf869dSJoe Perches# git output parsing needs US English output, so first set backtick child process LANGUAGE
73dbbf869dSJoe Perchesmy $git_command ='export LANGUAGE=en_US.UTF-8; git';
74713a09deSAntonio Borneomy $tabsize = 8;
753e89ad85SJerome Forissiermy ${CONFIG_} = "CONFIG_";
7677f5b10aSHannes Eder
7777f5b10aSHannes Edersub help {
7877f5b10aSHannes Eder	my ($exitcode) = @_;
7977f5b10aSHannes Eder
8077f5b10aSHannes Eder	print << "EOM";
8177f5b10aSHannes EderUsage: $P [OPTION]... [FILE]...
8277f5b10aSHannes EderVersion: $V
8377f5b10aSHannes Eder
8477f5b10aSHannes EderOptions:
8577f5b10aSHannes Eder  -q, --quiet                quiet
8652178ce0SDwaipayan Ray  -v, --verbose              verbose mode
8777f5b10aSHannes Eder  --no-tree                  run without a kernel tree
8877f5b10aSHannes Eder  --no-signoff               do not check for 'Signed-off-by' line
8977f5b10aSHannes Eder  --patch                    treat FILE as patchfile (default)
9077f5b10aSHannes Eder  --emacs                    emacs compile window format
9177f5b10aSHannes Eder  --terse                    one line per report
9234d8815fSJoe Perches  --showfile                 emit diffed file position, not input file position
934a593c34SDu, Changbin  -g, --git                  treat FILE as a single commit or git revision range
944a593c34SDu, Changbin                             single git commit with:
954a593c34SDu, Changbin                               <rev>
964a593c34SDu, Changbin                               <rev>^
974a593c34SDu, Changbin                               <rev>~n
984a593c34SDu, Changbin                             multiple git commits with:
994a593c34SDu, Changbin                               <rev1>..<rev2>
1004a593c34SDu, Changbin                               <rev1>...<rev2>
1014a593c34SDu, Changbin                               <rev>-<count>
1024a593c34SDu, Changbin                             git merges are ignored
10377f5b10aSHannes Eder  -f, --file                 treat FILE as regular source file
10477f5b10aSHannes Eder  --subjective, --strict     enable more subjective tests
1053beb42ecSJoe Perches  --list-types               list the possible message types
10691bfe484SJoe Perches  --types TYPE(,TYPE2...)    show only these comma separated message types
107000d1cc1SJoe Perches  --ignore TYPE(,TYPE2...)   ignore various comma separated message types
1083beb42ecSJoe Perches  --show-types               show the specific message type in the output
109bdc48fa1SJoe Perches  --max-line-length=n        set the maximum line length, (default $max_line_length)
110bdc48fa1SJoe Perches                             if exceeded, warn on patches
111bdc48fa1SJoe Perches                             requires --strict for use with --file
11256193274SVadim Bendebury  --min-conf-desc-length=n   set the min description length, if shorter, warn
113bdc48fa1SJoe Perches  --tab-size=n               set the number of spaces for tab (default $tabsize)
11477f5b10aSHannes Eder  --root=PATH                PATH to the kernel tree root
11577f5b10aSHannes Eder  --no-summary               suppress the per-file summary
11677f5b10aSHannes Eder  --mailback                 only produce a report in case of warnings/errors
11777f5b10aSHannes Eder  --summary-file             include the filename in summary
11877f5b10aSHannes Eder  --debug KEY=[0|1]          turn on/off debugging of KEY, where KEY is one of
11977f5b10aSHannes Eder                             'values', 'possible', 'type', and 'attr' (default
12077f5b10aSHannes Eder                             is all off)
12177f5b10aSHannes Eder  --test-only=WORD           report only warnings/errors containing WORD
12277f5b10aSHannes Eder                             literally
1233705ce5bSJoe Perches  --fix                      EXPERIMENTAL - may create horrible results
1243705ce5bSJoe Perches                             If correctable single-line errors exist, create
1253705ce5bSJoe Perches                             "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
1263705ce5bSJoe Perches                             with potential errors corrected to the preferred
1273705ce5bSJoe Perches                             checkpatch style
1289624b8d6SJoe Perches  --fix-inplace              EXPERIMENTAL - may create horrible results
1299624b8d6SJoe Perches                             Is the same as --fix, but overwrites the input
1309624b8d6SJoe Perches                             file.  It's your fault if there's no backup or git
131d62a201fSDave Hansen  --ignore-perl-version      override checking of perl version.  expect
132d62a201fSDave Hansen                             runtime errors.
133ebfd7d62SJoe Perches  --codespell                Use the codespell dictionary for spelling/typos
1340ee3e7b8SPeter Ujfalusi                             (default:$codespellfile)
135ebfd7d62SJoe Perches  --codespellfile            Use this codespell dictionary
13675ad8c57SJerome Forissier  --typedefsfile             Read additional types from this file
137737c0767SJohn Brooks  --color[=WHEN]             Use colors 'always', 'never', or only when output
138737c0767SJohn Brooks                             is a terminal ('auto'). Default is 'auto'.
1393e89ad85SJerome Forissier  --kconfig-prefix=WORD      use WORD as a prefix for Kconfig symbols (default
1403e89ad85SJerome Forissier                             ${CONFIG_})
14177f5b10aSHannes Eder  -h, --help, --version      display this help and exit
14277f5b10aSHannes Eder
14377f5b10aSHannes EderWhen FILE is - read standard input.
14477f5b10aSHannes EderEOM
14577f5b10aSHannes Eder
14677f5b10aSHannes Eder	exit($exitcode);
14777f5b10aSHannes Eder}
14877f5b10aSHannes Eder
1493beb42ecSJoe Perchessub uniq {
1503beb42ecSJoe Perches	my %seen;
1513beb42ecSJoe Perches	return grep { !$seen{$_}++ } @_;
1523beb42ecSJoe Perches}
1533beb42ecSJoe Perches
1543beb42ecSJoe Perchessub list_types {
1553beb42ecSJoe Perches	my ($exitcode) = @_;
1563beb42ecSJoe Perches
1573beb42ecSJoe Perches	my $count = 0;
1583beb42ecSJoe Perches
1593beb42ecSJoe Perches	local $/ = undef;
1603beb42ecSJoe Perches
1613beb42ecSJoe Perches	open(my $script, '<', abs_path($P)) or
1623beb42ecSJoe Perches	    die "$P: Can't read '$P' $!\n";
1633beb42ecSJoe Perches
1643beb42ecSJoe Perches	my $text = <$script>;
1653beb42ecSJoe Perches	close($script);
1663beb42ecSJoe Perches
16752178ce0SDwaipayan Ray	my %types = ();
1680547fa58SJean Delvare	# Also catch when type or level is passed through a variable
16952178ce0SDwaipayan Ray	while ($text =~ /(?:(\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
17052178ce0SDwaipayan Ray		if (defined($1)) {
17152178ce0SDwaipayan Ray			if (exists($types{$2})) {
17252178ce0SDwaipayan Ray				$types{$2} .= ",$1" if ($types{$2} ne $1);
17352178ce0SDwaipayan Ray			} else {
17452178ce0SDwaipayan Ray				$types{$2} = $1;
1753beb42ecSJoe Perches			}
17652178ce0SDwaipayan Ray		} else {
17752178ce0SDwaipayan Ray			$types{$2} = "UNDETERMINED";
17852178ce0SDwaipayan Ray		}
17952178ce0SDwaipayan Ray	}
18052178ce0SDwaipayan Ray
1813beb42ecSJoe Perches	print("#\tMessage type\n\n");
18252178ce0SDwaipayan Ray	if ($color) {
18352178ce0SDwaipayan Ray		print(" ( Color coding: ");
18452178ce0SDwaipayan Ray		print(RED . "ERROR" . RESET);
18552178ce0SDwaipayan Ray		print(" | ");
18652178ce0SDwaipayan Ray		print(YELLOW . "WARNING" . RESET);
18752178ce0SDwaipayan Ray		print(" | ");
18852178ce0SDwaipayan Ray		print(GREEN . "CHECK" . RESET);
18952178ce0SDwaipayan Ray		print(" | ");
19052178ce0SDwaipayan Ray		print("Multiple levels / Undetermined");
19152178ce0SDwaipayan Ray		print(" )\n\n");
19252178ce0SDwaipayan Ray	}
19352178ce0SDwaipayan Ray
19452178ce0SDwaipayan Ray	foreach my $type (sort keys %types) {
19552178ce0SDwaipayan Ray		my $orig_type = $type;
19652178ce0SDwaipayan Ray		if ($color) {
19752178ce0SDwaipayan Ray			my $level = $types{$type};
19852178ce0SDwaipayan Ray			if ($level eq "ERROR") {
19952178ce0SDwaipayan Ray				$type = RED . $type . RESET;
20052178ce0SDwaipayan Ray			} elsif ($level eq "WARN") {
20152178ce0SDwaipayan Ray				$type = YELLOW . $type . RESET;
20252178ce0SDwaipayan Ray			} elsif ($level eq "CHK") {
20352178ce0SDwaipayan Ray				$type = GREEN . $type . RESET;
20452178ce0SDwaipayan Ray			}
20552178ce0SDwaipayan Ray		}
2063beb42ecSJoe Perches		print(++$count . "\t" . $type . "\n");
20752178ce0SDwaipayan Ray		if ($verbose && exists($verbose_messages{$orig_type})) {
20852178ce0SDwaipayan Ray			my $message = $verbose_messages{$orig_type};
20952178ce0SDwaipayan Ray			$message =~ s/\n/\n\t/g;
21052178ce0SDwaipayan Ray			print("\t" . $message . "\n\n");
21152178ce0SDwaipayan Ray		}
2123beb42ecSJoe Perches	}
2133beb42ecSJoe Perches
2143beb42ecSJoe Perches	exit($exitcode);
2153beb42ecSJoe Perches}
2163beb42ecSJoe Perches
217000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file);
218000d1cc1SJoe Perchesif (-f $conf) {
219000d1cc1SJoe Perches	my @conf_args;
220000d1cc1SJoe Perches	open(my $conffile, '<', "$conf")
221000d1cc1SJoe Perches	    or warn "$P: Can't find a readable $configuration_file file $!\n";
222000d1cc1SJoe Perches
223000d1cc1SJoe Perches	while (<$conffile>) {
224000d1cc1SJoe Perches		my $line = $_;
225000d1cc1SJoe Perches
226000d1cc1SJoe Perches		$line =~ s/\s*\n?$//g;
227000d1cc1SJoe Perches		$line =~ s/^\s*//g;
228000d1cc1SJoe Perches		$line =~ s/\s+/ /g;
229000d1cc1SJoe Perches
230000d1cc1SJoe Perches		next if ($line =~ m/^\s*#/);
231000d1cc1SJoe Perches		next if ($line =~ m/^\s*$/);
232000d1cc1SJoe Perches
233000d1cc1SJoe Perches		my @words = split(" ", $line);
234000d1cc1SJoe Perches		foreach my $word (@words) {
235000d1cc1SJoe Perches			last if ($word =~ m/^#/);
236000d1cc1SJoe Perches			push (@conf_args, $word);
237000d1cc1SJoe Perches		}
238000d1cc1SJoe Perches	}
239000d1cc1SJoe Perches	close($conffile);
240000d1cc1SJoe Perches	unshift(@ARGV, @conf_args) if @conf_args;
241000d1cc1SJoe Perches}
242000d1cc1SJoe Perches
24352178ce0SDwaipayan Raysub load_docs {
24452178ce0SDwaipayan Ray	open(my $docs, '<', "$docsfile")
24552178ce0SDwaipayan Ray	    or warn "$P: Can't read the documentation file $docsfile $!\n";
24652178ce0SDwaipayan Ray
24752178ce0SDwaipayan Ray	my $type = '';
24852178ce0SDwaipayan Ray	my $desc = '';
24952178ce0SDwaipayan Ray	my $in_desc = 0;
25052178ce0SDwaipayan Ray
25152178ce0SDwaipayan Ray	while (<$docs>) {
25252178ce0SDwaipayan Ray		chomp;
25352178ce0SDwaipayan Ray		my $line = $_;
25452178ce0SDwaipayan Ray		$line =~ s/\s+$//;
25552178ce0SDwaipayan Ray
25652178ce0SDwaipayan Ray		if ($line =~ /^\s*\*\*(.+)\*\*$/) {
25752178ce0SDwaipayan Ray			if ($desc ne '') {
25852178ce0SDwaipayan Ray				$verbose_messages{$type} = trim($desc);
25952178ce0SDwaipayan Ray			}
26052178ce0SDwaipayan Ray			$type = $1;
26152178ce0SDwaipayan Ray			$desc = '';
26252178ce0SDwaipayan Ray			$in_desc = 1;
26352178ce0SDwaipayan Ray		} elsif ($in_desc) {
26452178ce0SDwaipayan Ray			if ($line =~ /^(?:\s{4,}|$)/) {
26552178ce0SDwaipayan Ray				$line =~ s/^\s{4}//;
26652178ce0SDwaipayan Ray				$desc .= $line;
26752178ce0SDwaipayan Ray				$desc .= "\n";
26852178ce0SDwaipayan Ray			} else {
26952178ce0SDwaipayan Ray				$verbose_messages{$type} = trim($desc);
27052178ce0SDwaipayan Ray				$type = '';
27152178ce0SDwaipayan Ray				$desc = '';
27252178ce0SDwaipayan Ray				$in_desc = 0;
27352178ce0SDwaipayan Ray			}
27452178ce0SDwaipayan Ray		}
27552178ce0SDwaipayan Ray	}
27652178ce0SDwaipayan Ray
27752178ce0SDwaipayan Ray	if ($desc ne '') {
27852178ce0SDwaipayan Ray		$verbose_messages{$type} = trim($desc);
27952178ce0SDwaipayan Ray	}
28052178ce0SDwaipayan Ray	close($docs);
28152178ce0SDwaipayan Ray}
28252178ce0SDwaipayan Ray
283737c0767SJohn Brooks# Perl's Getopt::Long allows options to take optional arguments after a space.
284737c0767SJohn Brooks# Prevent --color by itself from consuming other arguments
285737c0767SJohn Brooksforeach (@ARGV) {
286737c0767SJohn Brooks	if ($_ eq "--color" || $_ eq "-color") {
287737c0767SJohn Brooks		$_ = "--color=$color";
288737c0767SJohn Brooks	}
289737c0767SJohn Brooks}
290737c0767SJohn Brooks
2910a920b5bSAndy WhitcroftGetOptions(
2926c72ffaaSAndy Whitcroft	'q|quiet+'	=> \$quiet,
29352178ce0SDwaipayan Ray	'v|verbose!'	=> \$verbose,
2940a920b5bSAndy Whitcroft	'tree!'		=> \$tree,
2950a920b5bSAndy Whitcroft	'signoff!'	=> \$chk_signoff,
2960a920b5bSAndy Whitcroft	'patch!'	=> \$chk_patch,
2976c72ffaaSAndy Whitcroft	'emacs!'	=> \$emacs,
2988905a67cSAndy Whitcroft	'terse!'	=> \$terse,
29934d8815fSJoe Perches	'showfile!'	=> \$showfile,
30077f5b10aSHannes Eder	'f|file!'	=> \$file,
3014a593c34SDu, Changbin	'g|git!'	=> \$git,
3026c72ffaaSAndy Whitcroft	'subjective!'	=> \$check,
3036c72ffaaSAndy Whitcroft	'strict!'	=> \$check,
304000d1cc1SJoe Perches	'ignore=s'	=> \@ignore,
30591bfe484SJoe Perches	'types=s'	=> \@use,
306000d1cc1SJoe Perches	'show-types!'	=> \$show_types,
3073beb42ecSJoe Perches	'list-types!'	=> \$list_types,
3086cd7f386SJoe Perches	'max-line-length=i' => \$max_line_length,
30956193274SVadim Bendebury	'min-conf-desc-length=i' => \$min_conf_desc_length,
310713a09deSAntonio Borneo	'tab-size=i'	=> \$tabsize,
3116c72ffaaSAndy Whitcroft	'root=s'	=> \$root,
3128905a67cSAndy Whitcroft	'summary!'	=> \$summary,
3138905a67cSAndy Whitcroft	'mailback!'	=> \$mailback,
31413214adfSAndy Whitcroft	'summary-file!'	=> \$summary_file,
3153705ce5bSJoe Perches	'fix!'		=> \$fix,
3169624b8d6SJoe Perches	'fix-inplace!'	=> \$fix_inplace,
317d62a201fSDave Hansen	'ignore-perl-version!' => \$ignore_perl_version,
318c2fdda0dSAndy Whitcroft	'debug=s'	=> \%debug,
319773647a0SAndy Whitcroft	'test-only=s'	=> \$tst_only,
320ebfd7d62SJoe Perches	'codespell!'	=> \$codespell,
3210ee3e7b8SPeter Ujfalusi	'codespellfile=s'	=> \$user_codespellfile,
32275ad8c57SJerome Forissier	'typedefsfile=s'	=> \$typedefsfile,
323737c0767SJohn Brooks	'color=s'	=> \$color,
324737c0767SJohn Brooks	'no-color'	=> \$color,	#keep old behaviors of -nocolor
325737c0767SJohn Brooks	'nocolor'	=> \$color,	#keep old behaviors of -nocolor
3263e89ad85SJerome Forissier	'kconfig-prefix=s'	=> \${CONFIG_},
32777f5b10aSHannes Eder	'h|help'	=> \$help,
32877f5b10aSHannes Eder	'version'	=> \$help
3290ee3e7b8SPeter Ujfalusi) or $help = 2;
33077f5b10aSHannes Eder
3310ee3e7b8SPeter Ujfalusiif ($user_codespellfile) {
3320ee3e7b8SPeter Ujfalusi	# Use the user provided codespell file unconditionally
3330ee3e7b8SPeter Ujfalusi	$codespellfile = $user_codespellfile;
3340ee3e7b8SPeter Ujfalusi} elsif (!(-f $codespellfile)) {
3350ee3e7b8SPeter Ujfalusi	# If /usr/share/codespell/dictionary.txt is not present, try to find it
3360ee3e7b8SPeter Ujfalusi	# under codespell's install directory: <codespell_root>/data/dictionary.txt
337c882c6b1SSagar Patel	if (($codespell || $help) && which("python3") ne "") {
3380ee3e7b8SPeter Ujfalusi		my $python_codespell_dict = << "EOF";
3390ee3e7b8SPeter Ujfalusi
3400ee3e7b8SPeter Ujfalusiimport os.path as op
3410ee3e7b8SPeter Ujfalusiimport codespell_lib
3420ee3e7b8SPeter Ujfalusicodespell_dir = op.dirname(codespell_lib.__file__)
3430ee3e7b8SPeter Ujfalusicodespell_file = op.join(codespell_dir, 'data', 'dictionary.txt')
3440ee3e7b8SPeter Ujfalusiprint(codespell_file, end='')
3450ee3e7b8SPeter UjfalusiEOF
3460ee3e7b8SPeter Ujfalusi
347c882c6b1SSagar Patel		my $codespell_dict = `python3 -c "$python_codespell_dict" 2> /dev/null`;
3480ee3e7b8SPeter Ujfalusi		$codespellfile = $codespell_dict if (-f $codespell_dict);
3490ee3e7b8SPeter Ujfalusi	}
3500ee3e7b8SPeter Ujfalusi}
3510ee3e7b8SPeter Ujfalusi
3520ee3e7b8SPeter Ujfalusi# $help is 1 if either -h, --help or --version is passed as option - exitcode: 0
3530ee3e7b8SPeter Ujfalusi# $help is 2 if invalid option is passed - exitcode: 1
3540ee3e7b8SPeter Ujfalusihelp($help - 1) if ($help);
3550a920b5bSAndy Whitcroft
35652178ce0SDwaipayan Raydie "$P: --git cannot be used with --file or --fix\n" if ($git && ($file || $fix));
35752178ce0SDwaipayan Raydie "$P: --verbose cannot be used with --terse\n" if ($verbose && $terse);
35852178ce0SDwaipayan Ray
35952178ce0SDwaipayan Rayif ($color =~ /^[01]$/) {
36052178ce0SDwaipayan Ray	$color = !$color;
36152178ce0SDwaipayan Ray} elsif ($color =~ /^always$/i) {
36252178ce0SDwaipayan Ray	$color = 1;
36352178ce0SDwaipayan Ray} elsif ($color =~ /^never$/i) {
36452178ce0SDwaipayan Ray	$color = 0;
36552178ce0SDwaipayan Ray} elsif ($color =~ /^auto$/i) {
36652178ce0SDwaipayan Ray	$color = (-t STDOUT);
36752178ce0SDwaipayan Ray} else {
36852178ce0SDwaipayan Ray	die "$P: Invalid color mode: $color\n";
36952178ce0SDwaipayan Ray}
37052178ce0SDwaipayan Ray
37152178ce0SDwaipayan Rayload_docs() if ($verbose);
3723beb42ecSJoe Percheslist_types(0) if ($list_types);
3733beb42ecSJoe Perches
3749624b8d6SJoe Perches$fix = 1 if ($fix_inplace);
3752ac73b4fSJoe Perches$check_orig = $check;
3769624b8d6SJoe Perches
3770a920b5bSAndy Whitcroftmy $exit = 0;
3780a920b5bSAndy Whitcroft
3795b57980dSJoe Perchesmy $perl_version_ok = 1;
380d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) {
3815b57980dSJoe Perches	$perl_version_ok = 0;
382d62a201fSDave Hansen	printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
3835b57980dSJoe Perches	exit(1) if (!$ignore_perl_version);
384d62a201fSDave Hansen}
385d62a201fSDave Hansen
38645107ff6SAllen Hubbe#if no filenames are given, push '-' to read patch from stdin
3870a920b5bSAndy Whitcroftif ($#ARGV < 0) {
38845107ff6SAllen Hubbe	push(@ARGV, '-');
3890a920b5bSAndy Whitcroft}
3900a920b5bSAndy Whitcroft
391713a09deSAntonio Borneo# skip TAB size 1 to avoid additional checks on $tabsize - 1
39232f30ca9SJoe Perchesdie "$P: Invalid TAB size: $tabsize\n" if ($tabsize < 2);
393713a09deSAntonio Borneo
39491bfe484SJoe Perchessub hash_save_array_words {
39591bfe484SJoe Perches	my ($hashRef, $arrayRef) = @_;
39691bfe484SJoe Perches
39791bfe484SJoe Perches	my @array = split(/,/, join(',', @$arrayRef));
39891bfe484SJoe Perches	foreach my $word (@array) {
399000d1cc1SJoe Perches		$word =~ s/\s*\n?$//g;
400000d1cc1SJoe Perches		$word =~ s/^\s*//g;
401000d1cc1SJoe Perches		$word =~ s/\s+/ /g;
402000d1cc1SJoe Perches		$word =~ tr/[a-z]/[A-Z]/;
403000d1cc1SJoe Perches
404000d1cc1SJoe Perches		next if ($word =~ m/^\s*#/);
405000d1cc1SJoe Perches		next if ($word =~ m/^\s*$/);
406000d1cc1SJoe Perches
40791bfe484SJoe Perches		$hashRef->{$word}++;
408000d1cc1SJoe Perches	}
40991bfe484SJoe Perches}
41091bfe484SJoe Perches
41191bfe484SJoe Perchessub hash_show_words {
41291bfe484SJoe Perches	my ($hashRef, $prefix) = @_;
41391bfe484SJoe Perches
4143c816e49SJoe Perches	if (keys %$hashRef) {
415d8469f16SJoe Perches		print "\nNOTE: $prefix message types:";
41658cb3cf6SJoe Perches		foreach my $word (sort keys %$hashRef) {
41791bfe484SJoe Perches			print " $word";
41891bfe484SJoe Perches		}
419d8469f16SJoe Perches		print "\n";
42091bfe484SJoe Perches	}
42191bfe484SJoe Perches}
42291bfe484SJoe Perches
42391bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore);
42491bfe484SJoe Percheshash_save_array_words(\%use_type, \@use);
425000d1cc1SJoe Perches
426c2fdda0dSAndy Whitcroftmy $dbg_values = 0;
427c2fdda0dSAndy Whitcroftmy $dbg_possible = 0;
4287429c690SAndy Whitcroftmy $dbg_type = 0;
429a1ef277eSAndy Whitcroftmy $dbg_attr = 0;
430c2fdda0dSAndy Whitcroftfor my $key (keys %debug) {
43121caa13cSAndy Whitcroft	## no critic
43221caa13cSAndy Whitcroft	eval "\${dbg_$key} = '$debug{$key}';";
43321caa13cSAndy Whitcroft	die "$@" if ($@);
434c2fdda0dSAndy Whitcroft}
435c2fdda0dSAndy Whitcroft
436d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0;
437d2c0a235SAndy Whitcroft
4388905a67cSAndy Whitcroftif ($terse) {
4398905a67cSAndy Whitcroft	$emacs = 1;
4408905a67cSAndy Whitcroft	$quiet++;
4418905a67cSAndy Whitcroft}
4428905a67cSAndy Whitcroft
4436c72ffaaSAndy Whitcroftif ($tree) {
4446c72ffaaSAndy Whitcroft	if (defined $root) {
4456c72ffaaSAndy Whitcroft		if (!top_of_kernel_tree($root)) {
4466c72ffaaSAndy Whitcroft			die "$P: $root: --root does not point at a valid tree\n";
4476c72ffaaSAndy Whitcroft		}
4486c72ffaaSAndy Whitcroft	} else {
4496c72ffaaSAndy Whitcroft		if (top_of_kernel_tree('.')) {
4506c72ffaaSAndy Whitcroft			$root = '.';
4516c72ffaaSAndy Whitcroft		} elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
4526c72ffaaSAndy Whitcroft						top_of_kernel_tree($1)) {
4536c72ffaaSAndy Whitcroft			$root = $1;
4546c72ffaaSAndy Whitcroft		}
4556c72ffaaSAndy Whitcroft	}
4566c72ffaaSAndy Whitcroft
4576c72ffaaSAndy Whitcroft	if (!defined $root) {
4580a920b5bSAndy Whitcroft		print "Must be run from the top-level dir. of a kernel tree\n";
4590a920b5bSAndy Whitcroft		exit(2);
4600a920b5bSAndy Whitcroft	}
4616c72ffaaSAndy Whitcroft}
4626c72ffaaSAndy Whitcroft
4636c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0;
4646c72ffaaSAndy Whitcroft
4652ceb532bSAndy Whitcroftour $Ident	= qr{
4662ceb532bSAndy Whitcroft			[A-Za-z_][A-Za-z\d_]*
4672ceb532bSAndy Whitcroft			(?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
4682ceb532bSAndy Whitcroft		}x;
4696c72ffaaSAndy Whitcroftour $Storage	= qr{extern|static|asmlinkage};
4706c72ffaaSAndy Whitcroftour $Sparse	= qr{
4716c72ffaaSAndy Whitcroft			__user|
4726c72ffaaSAndy Whitcroft			__kernel|
4736c72ffaaSAndy Whitcroft			__force|
4746c72ffaaSAndy Whitcroft			__iomem|
4756c72ffaaSAndy Whitcroft			__must_check|
476417495edSAndy Whitcroft			__kprobes|
477165e72a6SSven Eckelmann			__ref|
47833aa4597SGeert Uytterhoeven			__refconst|
47933aa4597SGeert Uytterhoeven			__refdata|
480ad315455SBoqun Feng			__rcu|
481ad315455SBoqun Feng			__private
4826c72ffaaSAndy Whitcroft		}x;
483e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
484e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
485e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
486e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
487e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
4888716de38SJoe Perches
48952131292SWolfram Sang# Notes to $Attribute:
49052131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
4916c72ffaaSAndy Whitcroftour $Attribute	= qr{
4926c72ffaaSAndy Whitcroft			const|
493b5e8736aSJoe Perches			volatile|
49403f1df7dSJoe Perches			__percpu|
49503f1df7dSJoe Perches			__nocast|
49603f1df7dSJoe Perches			__safe|
49746d832f5SMichael S. Tsirkin			__bitwise|
49803f1df7dSJoe Perches			__packed__|
49903f1df7dSJoe Perches			__packed2__|
50003f1df7dSJoe Perches			__naked|
50103f1df7dSJoe Perches			__maybe_unused|
50203f1df7dSJoe Perches			__always_unused|
50303f1df7dSJoe Perches			__noreturn|
50403f1df7dSJoe Perches			__used|
50503f1df7dSJoe Perches			__cold|
506e23ef1f3SJoe Perches			__pure|
50703f1df7dSJoe Perches			__noclone|
50803f1df7dSJoe Perches			__deprecated|
5096c72ffaaSAndy Whitcroft			__read_mostly|
510c5967e98SJoe Perches			__ro_after_init|
5116c72ffaaSAndy Whitcroft			__kprobes|
5128716de38SJoe Perches			$InitAttribute|
51324e1d81aSAndy Whitcroft			____cacheline_aligned|
51424e1d81aSAndy Whitcroft			____cacheline_aligned_in_smp|
5155fe3af11SAndy Whitcroft			____cacheline_internodealigned_in_smp|
51686cffecdSKees Cook			__weak|
51786cffecdSKees Cook			__alloc_size\s*\(\s*\d+\s*(?:,\s*\d+\s*)?\)
5186c72ffaaSAndy Whitcroft		  }x;
519c45dcabdSAndy Whitcroftour $Modifier;
52091cb5195SJoe Perchesour $Inline	= qr{inline|__always_inline|noinline|__inline|__inline__};
5216c72ffaaSAndy Whitcroftour $Member	= qr{->$Ident|\.$Ident|\[[^]]*\]};
5226c72ffaaSAndy Whitcroftour $Lval	= qr{$Ident(?:$Member)*};
5236c72ffaaSAndy Whitcroft
52495e2c602SJoe Perchesour $Int_type	= qr{(?i)llu|ull|ll|lu|ul|l|u};
52595e2c602SJoe Perchesour $Binary	= qr{(?i)0b[01]+$Int_type?};
52695e2c602SJoe Perchesour $Hex	= qr{(?i)0x[0-9a-f]+$Int_type?};
52795e2c602SJoe Perchesour $Int	= qr{[0-9]+$Int_type?};
5282435880fSJoe Perchesour $Octal	= qr{0[0-7]+$Int_type?};
529d2af5aa6SJoe Perchesour $String	= qr{(?:\b[Lu])?"[X\t]*"};
530326b1ffcSJoe Perchesour $Float_hex	= qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
531326b1ffcSJoe Perchesour $Float_dec	= qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
532326b1ffcSJoe Perchesour $Float_int	= qr{(?i)[0-9]+e-?[0-9]+[fl]?};
53374349bccSJoe Perchesour $Float	= qr{$Float_hex|$Float_dec|$Float_int};
5342435880fSJoe Perchesour $Constant	= qr{$Float|$Binary|$Octal|$Hex|$Int};
535326b1ffcSJoe Perchesour $Assignment	= qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
536447432f3SJoe Perchesour $Compare    = qr{<=|>=|==|!=|<|(?<!-)>};
53723f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%};
5386c72ffaaSAndy Whitcroftour $Operators	= qr{
5396c72ffaaSAndy Whitcroft			<=|>=|==|!=|
5406c72ffaaSAndy Whitcroft			=>|->|<<|>>|<|>|!|~|
54123f780c9SJoe Perches			&&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
5426c72ffaaSAndy Whitcroft		  }x;
5436c72ffaaSAndy Whitcroft
54491cb5195SJoe Perchesour $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
54591cb5195SJoe Perches
546ab7e23f3SJoe Perchesour $BasicType;
5478905a67cSAndy Whitcroftour $NonptrType;
5481813087dSJoe Perchesour $NonptrTypeMisordered;
5498716de38SJoe Perchesour $NonptrTypeWithAttr;
5508905a67cSAndy Whitcroftour $Type;
5511813087dSJoe Perchesour $TypeMisordered;
5528905a67cSAndy Whitcroftour $Declare;
5531813087dSJoe Perchesour $DeclareMisordered;
5548905a67cSAndy Whitcroft
55515662b3eSJoe Perchesour $NON_ASCII_UTF8	= qr{
55615662b3eSJoe Perches	[\xC2-\xDF][\x80-\xBF]               # non-overlong 2-byte
557171ae1a4SAndy Whitcroft	|  \xE0[\xA0-\xBF][\x80-\xBF]        # excluding overlongs
558171ae1a4SAndy Whitcroft	| [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}  # straight 3-byte
559171ae1a4SAndy Whitcroft	|  \xED[\x80-\x9F][\x80-\xBF]        # excluding surrogates
560171ae1a4SAndy Whitcroft	|  \xF0[\x90-\xBF][\x80-\xBF]{2}     # planes 1-3
561171ae1a4SAndy Whitcroft	| [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
562171ae1a4SAndy Whitcroft	|  \xF4[\x80-\x8F][\x80-\xBF]{2}     # plane 16
563171ae1a4SAndy Whitcroft}x;
564171ae1a4SAndy Whitcroft
56515662b3eSJoe Perchesour $UTF8	= qr{
56615662b3eSJoe Perches	[\x09\x0A\x0D\x20-\x7E]              # ASCII
56715662b3eSJoe Perches	| $NON_ASCII_UTF8
56815662b3eSJoe Perches}x;
56915662b3eSJoe Perches
570e6176fa4SJoe Perchesour $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
571021158b4SJoe Perchesour $typeOtherOSTypedefs = qr{(?x:
572021158b4SJoe Perches	u_(?:char|short|int|long) |          # bsd
573021158b4SJoe Perches	u(?:nchar|short|int|long)            # sysv
574021158b4SJoe Perches)};
575e6176fa4SJoe Perchesour $typeKernelTypedefs = qr{(?x:
576fb9e9096SAndy Whitcroft	(?:__)?(?:u|s|be|le)(?:8|16|32|64)|
5778ed22cadSAndy Whitcroft	atomic_t
5788ed22cadSAndy Whitcroft)};
5798ea0114eSMickaël Salaünour $typeStdioTypedefs = qr{(?x:
5808ea0114eSMickaël Salaün	FILE
5818ea0114eSMickaël Salaün)};
582e6176fa4SJoe Perchesour $typeTypedefs = qr{(?x:
583e6176fa4SJoe Perches	$typeC99Typedefs\b|
584e6176fa4SJoe Perches	$typeOtherOSTypedefs\b|
5858ea0114eSMickaël Salaün	$typeKernelTypedefs\b|
5868ea0114eSMickaël Salaün	$typeStdioTypedefs\b
587e6176fa4SJoe Perches)};
5888ed22cadSAndy Whitcroft
5896d32f7a3SJoe Perchesour $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
5906d32f7a3SJoe Perches
591691e669bSJoe Perchesour $logFunctions = qr{(?x:
592758d7aadSMiles Chen	printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
5937d0b6594SJacob Keller	(?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
59487bd499aSJoe Perches	TP_printk|
5956e60c02eSJoe Perches	WARN(?:_RATELIMIT|_ONCE|)|
596b0531722SJoe Perches	panic|
59706668727SJoe Perches	MODULE_[A-Z_]+|
59806668727SJoe Perches	seq_vprintf|seq_printf|seq_puts
599691e669bSJoe Perches)};
600691e669bSJoe Perches
601e29a70f1SJoe Perchesour $allocFunctions = qr{(?x:
602e29a70f1SJoe Perches	(?:(?:devm_)?
60358f02267SJoe Perches		(?:kv|k|v)[czm]alloc(?:_array)?(?:_node)? |
604e29a70f1SJoe Perches		kstrdup(?:_const)? |
605e29a70f1SJoe Perches		kmemdup(?:_nul)?) |
606461e1565SChristophe JAILLET	(?:\w+)?alloc_skb(?:_ip_align)? |
607e29a70f1SJoe Perches				# dev_alloc_skb/netdev_alloc_skb, et al
608e29a70f1SJoe Perches	dma_alloc_coherent
609e29a70f1SJoe Perches)};
610e29a70f1SJoe Perches
61120112475SJoe Perchesour $signature_tags = qr{(?xi:
61220112475SJoe Perches	Signed-off-by:|
613d499480cSJorge Ramirez-Ortiz	Co-developed-by:|
61420112475SJoe Perches	Acked-by:|
61520112475SJoe Perches	Tested-by:|
61620112475SJoe Perches	Reviewed-by:|
61720112475SJoe Perches	Reported-by:|
6188543ae12SMugunthan V N	Suggested-by:|
61920112475SJoe Perches	To:|
62020112475SJoe Perches	Cc:
62120112475SJoe Perches)};
62220112475SJoe Perches
623adb2da82SJoe Perchesour $tracing_logging_tags = qr{(?xi:
624adb2da82SJoe Perches	[=-]*> |
625adb2da82SJoe Perches	<[=-]* |
626adb2da82SJoe Perches	\[ |
627adb2da82SJoe Perches	\] |
628adb2da82SJoe Perches	start |
629adb2da82SJoe Perches	called |
630adb2da82SJoe Perches	entered |
631adb2da82SJoe Perches	entry |
632adb2da82SJoe Perches	enter |
633adb2da82SJoe Perches	in |
634adb2da82SJoe Perches	inside |
635adb2da82SJoe Perches	here |
636adb2da82SJoe Perches	begin |
637adb2da82SJoe Perches	exit |
638adb2da82SJoe Perches	end |
639adb2da82SJoe Perches	done |
640adb2da82SJoe Perches	leave |
641adb2da82SJoe Perches	completed |
642adb2da82SJoe Perches	out |
643adb2da82SJoe Perches	return |
644adb2da82SJoe Perches	[\.\!:\s]*
645adb2da82SJoe Perches)};
646adb2da82SJoe Perches
647831242abSAditya Srivastavasub edit_distance_min {
648831242abSAditya Srivastava	my (@arr) = @_;
649831242abSAditya Srivastava	my $len = scalar @arr;
650831242abSAditya Srivastava	if ((scalar @arr) < 1) {
651831242abSAditya Srivastava		# if underflow, return
652831242abSAditya Srivastava		return;
653831242abSAditya Srivastava	}
654831242abSAditya Srivastava	my $min = $arr[0];
655831242abSAditya Srivastava	for my $i (0 .. ($len-1)) {
656831242abSAditya Srivastava		if ($arr[$i] < $min) {
657831242abSAditya Srivastava			$min = $arr[$i];
658831242abSAditya Srivastava		}
659831242abSAditya Srivastava	}
660831242abSAditya Srivastava	return $min;
661831242abSAditya Srivastava}
662831242abSAditya Srivastava
663831242abSAditya Srivastavasub get_edit_distance {
664831242abSAditya Srivastava	my ($str1, $str2) = @_;
665831242abSAditya Srivastava	$str1 = lc($str1);
666831242abSAditya Srivastava	$str2 = lc($str2);
667831242abSAditya Srivastava	$str1 =~ s/-//g;
668831242abSAditya Srivastava	$str2 =~ s/-//g;
669831242abSAditya Srivastava	my $len1 = length($str1);
670831242abSAditya Srivastava	my $len2 = length($str2);
671831242abSAditya Srivastava	# two dimensional array storing minimum edit distance
672831242abSAditya Srivastava	my @distance;
673831242abSAditya Srivastava	for my $i (0 .. $len1) {
674831242abSAditya Srivastava		for my $j (0 .. $len2) {
675831242abSAditya Srivastava			if ($i == 0) {
676831242abSAditya Srivastava				$distance[$i][$j] = $j;
677831242abSAditya Srivastava			} elsif ($j == 0) {
678831242abSAditya Srivastava				$distance[$i][$j] = $i;
679831242abSAditya Srivastava			} elsif (substr($str1, $i-1, 1) eq substr($str2, $j-1, 1)) {
680831242abSAditya Srivastava				$distance[$i][$j] = $distance[$i - 1][$j - 1];
681831242abSAditya Srivastava			} else {
682831242abSAditya Srivastava				my $dist1 = $distance[$i][$j - 1]; #insert distance
683831242abSAditya Srivastava				my $dist2 = $distance[$i - 1][$j]; # remove
684831242abSAditya Srivastava				my $dist3 = $distance[$i - 1][$j - 1]; #replace
685831242abSAditya Srivastava				$distance[$i][$j] = 1 + edit_distance_min($dist1, $dist2, $dist3);
686831242abSAditya Srivastava			}
687831242abSAditya Srivastava		}
688831242abSAditya Srivastava	}
689831242abSAditya Srivastava	return $distance[$len1][$len2];
690831242abSAditya Srivastava}
691831242abSAditya Srivastava
692831242abSAditya Srivastavasub find_standard_signature {
693831242abSAditya Srivastava	my ($sign_off) = @_;
694831242abSAditya Srivastava	my @standard_signature_tags = (
695831242abSAditya Srivastava		'Signed-off-by:', 'Co-developed-by:', 'Acked-by:', 'Tested-by:',
696831242abSAditya Srivastava		'Reviewed-by:', 'Reported-by:', 'Suggested-by:'
697831242abSAditya Srivastava	);
698831242abSAditya Srivastava	foreach my $signature (@standard_signature_tags) {
699831242abSAditya Srivastava		return $signature if (get_edit_distance($sign_off, $signature) <= 2);
700831242abSAditya Srivastava	}
701831242abSAditya Srivastava
702831242abSAditya Srivastava	return "";
703831242abSAditya Srivastava}
704831242abSAditya Srivastava
7059b71f79fSBjorn Helgaasour $obsolete_archives = qr{(?xi:
7069b71f79fSBjorn Helgaas	\Qfreedesktop.org/archives/dri-devel\E |
7079b71f79fSBjorn Helgaas	\Qlists.infradead.org\E |
7089b71f79fSBjorn Helgaas	\Qlkml.org\E |
7099b71f79fSBjorn Helgaas	\Qmail-archive.com\E |
7109b71f79fSBjorn Helgaas	\Qmailman.alsa-project.org/pipermail\E |
7119b71f79fSBjorn Helgaas	\Qmarc.info\E |
7129b71f79fSBjorn Helgaas	\Qozlabs.org/pipermail\E |
7139b71f79fSBjorn Helgaas	\Qspinics.net\E
7149b71f79fSBjorn Helgaas)};
7159b71f79fSBjorn Helgaas
7161813087dSJoe Perchesour @typeListMisordered = (
7171813087dSJoe Perches	qr{char\s+(?:un)?signed},
7181813087dSJoe Perches	qr{int\s+(?:(?:un)?signed\s+)?short\s},
7191813087dSJoe Perches	qr{int\s+short(?:\s+(?:un)?signed)},
7201813087dSJoe Perches	qr{short\s+int(?:\s+(?:un)?signed)},
7211813087dSJoe Perches	qr{(?:un)?signed\s+int\s+short},
7221813087dSJoe Perches	qr{short\s+(?:un)?signed},
7231813087dSJoe Perches	qr{long\s+int\s+(?:un)?signed},
7241813087dSJoe Perches	qr{int\s+long\s+(?:un)?signed},
7251813087dSJoe Perches	qr{long\s+(?:un)?signed\s+int},
7261813087dSJoe Perches	qr{int\s+(?:un)?signed\s+long},
7271813087dSJoe Perches	qr{int\s+(?:un)?signed},
7281813087dSJoe Perches	qr{int\s+long\s+long\s+(?:un)?signed},
7291813087dSJoe Perches	qr{long\s+long\s+int\s+(?:un)?signed},
7301813087dSJoe Perches	qr{long\s+long\s+(?:un)?signed\s+int},
7311813087dSJoe Perches	qr{long\s+long\s+(?:un)?signed},
7321813087dSJoe Perches	qr{long\s+(?:un)?signed},
7331813087dSJoe Perches);
7341813087dSJoe Perches
7358905a67cSAndy Whitcroftour @typeList = (
7368905a67cSAndy Whitcroft	qr{void},
7370c773d9dSJoe Perches	qr{(?:(?:un)?signed\s+)?char},
7380c773d9dSJoe Perches	qr{(?:(?:un)?signed\s+)?short\s+int},
7390c773d9dSJoe Perches	qr{(?:(?:un)?signed\s+)?short},
7400c773d9dSJoe Perches	qr{(?:(?:un)?signed\s+)?int},
7410c773d9dSJoe Perches	qr{(?:(?:un)?signed\s+)?long\s+int},
7420c773d9dSJoe Perches	qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
7430c773d9dSJoe Perches	qr{(?:(?:un)?signed\s+)?long\s+long},
7440c773d9dSJoe Perches	qr{(?:(?:un)?signed\s+)?long},
7450c773d9dSJoe Perches	qr{(?:un)?signed},
7468905a67cSAndy Whitcroft	qr{float},
7478905a67cSAndy Whitcroft	qr{double},
7488905a67cSAndy Whitcroft	qr{bool},
7498905a67cSAndy Whitcroft	qr{struct\s+$Ident},
7508905a67cSAndy Whitcroft	qr{union\s+$Ident},
7518905a67cSAndy Whitcroft	qr{enum\s+$Ident},
7528905a67cSAndy Whitcroft	qr{${Ident}_t},
7538905a67cSAndy Whitcroft	qr{${Ident}_handler},
7548905a67cSAndy Whitcroft	qr{${Ident}_handler_fn},
7551813087dSJoe Perches	@typeListMisordered,
7568905a67cSAndy Whitcroft);
757938224b5SJoe Perches
758938224b5SJoe Perchesour $C90_int_types = qr{(?x:
759938224b5SJoe Perches	long\s+long\s+int\s+(?:un)?signed|
760938224b5SJoe Perches	long\s+long\s+(?:un)?signed\s+int|
761938224b5SJoe Perches	long\s+long\s+(?:un)?signed|
762938224b5SJoe Perches	(?:(?:un)?signed\s+)?long\s+long\s+int|
763938224b5SJoe Perches	(?:(?:un)?signed\s+)?long\s+long|
764938224b5SJoe Perches	int\s+long\s+long\s+(?:un)?signed|
765938224b5SJoe Perches	int\s+(?:(?:un)?signed\s+)?long\s+long|
766938224b5SJoe Perches
767938224b5SJoe Perches	long\s+int\s+(?:un)?signed|
768938224b5SJoe Perches	long\s+(?:un)?signed\s+int|
769938224b5SJoe Perches	long\s+(?:un)?signed|
770938224b5SJoe Perches	(?:(?:un)?signed\s+)?long\s+int|
771938224b5SJoe Perches	(?:(?:un)?signed\s+)?long|
772938224b5SJoe Perches	int\s+long\s+(?:un)?signed|
773938224b5SJoe Perches	int\s+(?:(?:un)?signed\s+)?long|
774938224b5SJoe Perches
775938224b5SJoe Perches	int\s+(?:un)?signed|
776938224b5SJoe Perches	(?:(?:un)?signed\s+)?int
777938224b5SJoe Perches)};
778938224b5SJoe Perches
779485ff23eSAlex Dowadour @typeListFile = ();
7808716de38SJoe Perchesour @typeListWithAttr = (
7818716de38SJoe Perches	@typeList,
7828716de38SJoe Perches	qr{struct\s+$InitAttribute\s+$Ident},
7838716de38SJoe Perches	qr{union\s+$InitAttribute\s+$Ident},
7848716de38SJoe Perches);
7858716de38SJoe Perches
786c45dcabdSAndy Whitcroftour @modifierList = (
787c45dcabdSAndy Whitcroft	qr{fastcall},
788c45dcabdSAndy Whitcroft);
789485ff23eSAlex Dowadour @modifierListFile = ();
7908905a67cSAndy Whitcroft
7912435880fSJoe Perchesour @mode_permission_funcs = (
7922435880fSJoe Perches	["module_param", 3],
7932435880fSJoe Perches	["module_param_(?:array|named|string)", 4],
7942435880fSJoe Perches	["module_param_array_named", 5],
7952435880fSJoe Perches	["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
7962435880fSJoe Perches	["proc_create(?:_data|)", 2],
797459cf0aeSJoe Perches	["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
798459cf0aeSJoe Perches	["IIO_DEV_ATTR_[A-Z_]+", 1],
799459cf0aeSJoe Perches	["SENSOR_(?:DEVICE_|)ATTR_2", 2],
800459cf0aeSJoe Perches	["SENSOR_TEMPLATE(?:_2|)", 3],
801459cf0aeSJoe Perches	["__ATTR", 2],
8022435880fSJoe Perches);
8032435880fSJoe Perches
8041a3dcf2eSJoe Perchesmy $word_pattern = '\b[A-Z]?[a-z]{2,}\b';
8051a3dcf2eSJoe Perches
806515a235eSJoe Perches#Create a search pattern for all these functions to speed up a loop below
807515a235eSJoe Perchesour $mode_perms_search = "";
808515a235eSJoe Perchesforeach my $entry (@mode_permission_funcs) {
809515a235eSJoe Perches	$mode_perms_search .= '|' if ($mode_perms_search ne "");
810515a235eSJoe Perches	$mode_perms_search .= $entry->[0];
811515a235eSJoe Perches}
81200180468SJoe Perches$mode_perms_search = "(?:${mode_perms_search})";
813515a235eSJoe Perches
8149189c7e7SJoe Perchesour %deprecated_apis = (
8159189c7e7SJoe Perches	"synchronize_rcu_bh"			=> "synchronize_rcu",
8169189c7e7SJoe Perches	"synchronize_rcu_bh_expedited"		=> "synchronize_rcu_expedited",
8179189c7e7SJoe Perches	"call_rcu_bh"				=> "call_rcu",
8189189c7e7SJoe Perches	"rcu_barrier_bh"			=> "rcu_barrier",
8199189c7e7SJoe Perches	"synchronize_sched"			=> "synchronize_rcu",
8209189c7e7SJoe Perches	"synchronize_sched_expedited"		=> "synchronize_rcu_expedited",
8219189c7e7SJoe Perches	"call_rcu_sched"			=> "call_rcu",
8229189c7e7SJoe Perches	"rcu_barrier_sched"			=> "rcu_barrier",
8239189c7e7SJoe Perches	"get_state_synchronize_sched"		=> "get_state_synchronize_rcu",
8249189c7e7SJoe Perches	"cond_synchronize_sched"		=> "cond_synchronize_rcu",
825defdaff1SIra Weiny	"kmap"					=> "kmap_local_page",
826a3ea42ffSIra Weiny	"kunmap"				=> "kunmap_local",
827defdaff1SIra Weiny	"kmap_atomic"				=> "kmap_local_page",
828a3ea42ffSIra Weiny	"kunmap_atomic"				=> "kunmap_local",
8299189c7e7SJoe Perches);
8309189c7e7SJoe Perches
8319189c7e7SJoe Perches#Create a search pattern for all these strings to speed up a loop below
8329189c7e7SJoe Perchesour $deprecated_apis_search = "";
8339189c7e7SJoe Perchesforeach my $entry (keys %deprecated_apis) {
8349189c7e7SJoe Perches	$deprecated_apis_search .= '|' if ($deprecated_apis_search ne "");
8359189c7e7SJoe Perches	$deprecated_apis_search .= $entry;
8369189c7e7SJoe Perches}
8379189c7e7SJoe Perches$deprecated_apis_search = "(?:${deprecated_apis_search})";
8389189c7e7SJoe Perches
839b392c64fSJoe Perchesour $mode_perms_world_writable = qr{
840b392c64fSJoe Perches	S_IWUGO		|
841b392c64fSJoe Perches	S_IWOTH		|
842b392c64fSJoe Perches	S_IRWXUGO	|
843b392c64fSJoe Perches	S_IALLUGO	|
844b392c64fSJoe Perches	0[0-7][0-7][2367]
845b392c64fSJoe Perches}x;
846b392c64fSJoe Perches
847f90774e1SJoe Perchesour %mode_permission_string_types = (
848f90774e1SJoe Perches	"S_IRWXU" => 0700,
849f90774e1SJoe Perches	"S_IRUSR" => 0400,
850f90774e1SJoe Perches	"S_IWUSR" => 0200,
851f90774e1SJoe Perches	"S_IXUSR" => 0100,
852f90774e1SJoe Perches	"S_IRWXG" => 0070,
853f90774e1SJoe Perches	"S_IRGRP" => 0040,
854f90774e1SJoe Perches	"S_IWGRP" => 0020,
855f90774e1SJoe Perches	"S_IXGRP" => 0010,
856f90774e1SJoe Perches	"S_IRWXO" => 0007,
857f90774e1SJoe Perches	"S_IROTH" => 0004,
858f90774e1SJoe Perches	"S_IWOTH" => 0002,
859f90774e1SJoe Perches	"S_IXOTH" => 0001,
860f90774e1SJoe Perches	"S_IRWXUGO" => 0777,
861f90774e1SJoe Perches	"S_IRUGO" => 0444,
862f90774e1SJoe Perches	"S_IWUGO" => 0222,
863f90774e1SJoe Perches	"S_IXUGO" => 0111,
864f90774e1SJoe Perches);
865f90774e1SJoe Perches
866f90774e1SJoe Perches#Create a search pattern for all these strings to speed up a loop below
867f90774e1SJoe Perchesour $mode_perms_string_search = "";
868f90774e1SJoe Perchesforeach my $entry (keys %mode_permission_string_types) {
869f90774e1SJoe Perches	$mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
870f90774e1SJoe Perches	$mode_perms_string_search .= $entry;
871f90774e1SJoe Perches}
87200180468SJoe Perchesour $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
87300180468SJoe Perchesour $multi_mode_perms_string_search = qr{
87400180468SJoe Perches	${single_mode_perms_string_search}
87500180468SJoe Perches	(?:\s*\|\s*${single_mode_perms_string_search})*
87600180468SJoe Perches}x;
87700180468SJoe Perches
87800180468SJoe Perchessub perms_to_octal {
87900180468SJoe Perches	my ($string) = @_;
88000180468SJoe Perches
88100180468SJoe Perches	return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
88200180468SJoe Perches
88300180468SJoe Perches	my $val = "";
88400180468SJoe Perches	my $oval = "";
88500180468SJoe Perches	my $to = 0;
88600180468SJoe Perches	my $curpos = 0;
88700180468SJoe Perches	my $lastpos = 0;
88800180468SJoe Perches	while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
88900180468SJoe Perches		$curpos = pos($string);
89000180468SJoe Perches		my $match = $2;
89100180468SJoe Perches		my $omatch = $1;
89200180468SJoe Perches		last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
89300180468SJoe Perches		$lastpos = $curpos;
89400180468SJoe Perches		$to |= $mode_permission_string_types{$match};
89500180468SJoe Perches		$val .= '\s*\|\s*' if ($val ne "");
89600180468SJoe Perches		$val .= $match;
89700180468SJoe Perches		$oval .= $omatch;
89800180468SJoe Perches	}
89900180468SJoe Perches	$oval =~ s/^\s*\|\s*//;
90000180468SJoe Perches	$oval =~ s/\s*\|\s*$//;
90100180468SJoe Perches	return sprintf("%04o", $to);
90200180468SJoe Perches}
903f90774e1SJoe Perches
9047840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x:
9057840a94cSWolfram Sang	irq|
906cdcee686SSergey Ryazanov	memory|
907cdcee686SSergey Ryazanov	time|
908cdcee686SSergey Ryazanov	reboot
9097840a94cSWolfram Sang)};
9107840a94cSWolfram Sang# memory.h: ARM has a custom one
9117840a94cSWolfram Sang
91266b47b4aSKees Cook# Load common spelling mistakes and build regular expression list.
91366b47b4aSKees Cookmy $misspellings;
91466b47b4aSKees Cookmy %spelling_fix;
91536061e38SJoe Perches
91636061e38SJoe Perchesif (open(my $spelling, '<', $spelling_file)) {
91766b47b4aSKees Cook	while (<$spelling>) {
91866b47b4aSKees Cook		my $line = $_;
91966b47b4aSKees Cook
92066b47b4aSKees Cook		$line =~ s/\s*\n?$//g;
92166b47b4aSKees Cook		$line =~ s/^\s*//g;
92266b47b4aSKees Cook
92366b47b4aSKees Cook		next if ($line =~ m/^\s*#/);
92466b47b4aSKees Cook		next if ($line =~ m/^\s*$/);
92566b47b4aSKees Cook
92666b47b4aSKees Cook		my ($suspect, $fix) = split(/\|\|/, $line);
92766b47b4aSKees Cook
92866b47b4aSKees Cook		$spelling_fix{$suspect} = $fix;
92966b47b4aSKees Cook	}
93066b47b4aSKees Cook	close($spelling);
93136061e38SJoe Perches} else {
93236061e38SJoe Perches	warn "No typos will be found - file '$spelling_file': $!\n";
93336061e38SJoe Perches}
93466b47b4aSKees Cook
935ebfd7d62SJoe Perchesif ($codespell) {
936ebfd7d62SJoe Perches	if (open(my $spelling, '<', $codespellfile)) {
937ebfd7d62SJoe Perches		while (<$spelling>) {
938ebfd7d62SJoe Perches			my $line = $_;
939ebfd7d62SJoe Perches
940ebfd7d62SJoe Perches			$line =~ s/\s*\n?$//g;
941ebfd7d62SJoe Perches			$line =~ s/^\s*//g;
942ebfd7d62SJoe Perches
943ebfd7d62SJoe Perches			next if ($line =~ m/^\s*#/);
944ebfd7d62SJoe Perches			next if ($line =~ m/^\s*$/);
945ebfd7d62SJoe Perches			next if ($line =~ m/, disabled/i);
946ebfd7d62SJoe Perches
947ebfd7d62SJoe Perches			$line =~ s/,.*$//;
948ebfd7d62SJoe Perches
949ebfd7d62SJoe Perches			my ($suspect, $fix) = split(/->/, $line);
950ebfd7d62SJoe Perches
951ebfd7d62SJoe Perches			$spelling_fix{$suspect} = $fix;
952ebfd7d62SJoe Perches		}
953ebfd7d62SJoe Perches		close($spelling);
954ebfd7d62SJoe Perches	} else {
955ebfd7d62SJoe Perches		warn "No codespell typos will be found - file '$codespellfile': $!\n";
956ebfd7d62SJoe Perches	}
957ebfd7d62SJoe Perches}
958ebfd7d62SJoe Perches
959ebfd7d62SJoe Perches$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
960ebfd7d62SJoe Perches
96175ad8c57SJerome Forissiersub read_words {
96275ad8c57SJerome Forissier	my ($wordsRef, $file) = @_;
96375ad8c57SJerome Forissier
96475ad8c57SJerome Forissier	if (open(my $words, '<', $file)) {
96575ad8c57SJerome Forissier		while (<$words>) {
966bf1fa1daSJoe Perches			my $line = $_;
967bf1fa1daSJoe Perches
968bf1fa1daSJoe Perches			$line =~ s/\s*\n?$//g;
969bf1fa1daSJoe Perches			$line =~ s/^\s*//g;
970bf1fa1daSJoe Perches
971bf1fa1daSJoe Perches			next if ($line =~ m/^\s*#/);
972bf1fa1daSJoe Perches			next if ($line =~ m/^\s*$/);
973bf1fa1daSJoe Perches			if ($line =~ /\s/) {
97475ad8c57SJerome Forissier				print("$file: '$line' invalid - ignored\n");
975bf1fa1daSJoe Perches				next;
976bf1fa1daSJoe Perches			}
977bf1fa1daSJoe Perches
978ced69da1SQuentin Monnet			$$wordsRef .= '|' if (defined $$wordsRef);
97975ad8c57SJerome Forissier			$$wordsRef .= $line;
980bf1fa1daSJoe Perches		}
98175ad8c57SJerome Forissier		close($file);
98275ad8c57SJerome Forissier		return 1;
983bf1fa1daSJoe Perches	}
984bf1fa1daSJoe Perches
98575ad8c57SJerome Forissier	return 0;
98675ad8c57SJerome Forissier}
98775ad8c57SJerome Forissier
988ced69da1SQuentin Monnetmy $const_structs;
989ced69da1SQuentin Monnetif (show_type("CONST_STRUCT")) {
99075ad8c57SJerome Forissier	read_words(\$const_structs, $conststructsfile)
99175ad8c57SJerome Forissier	    or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
992ced69da1SQuentin Monnet}
99375ad8c57SJerome Forissier
994ced69da1SQuentin Monnetif (defined($typedefsfile)) {
995ced69da1SQuentin Monnet	my $typeOtherTypedefs;
99675ad8c57SJerome Forissier	read_words(\$typeOtherTypedefs, $typedefsfile)
99775ad8c57SJerome Forissier	    or warn "No additional types will be considered - file '$typedefsfile': $!\n";
998ced69da1SQuentin Monnet	$typeTypedefs .= '|' . $typeOtherTypedefs if (defined $typeOtherTypedefs);
99975ad8c57SJerome Forissier}
100075ad8c57SJerome Forissier
10018905a67cSAndy Whitcroftsub build_types {
1002485ff23eSAlex Dowad	my $mods = "(?x:  \n" . join("|\n  ", (@modifierList, @modifierListFile)) . "\n)";
1003485ff23eSAlex Dowad	my $all = "(?x:  \n" . join("|\n  ", (@typeList, @typeListFile)) . "\n)";
10041813087dSJoe Perches	my $Misordered = "(?x:  \n" . join("|\n  ", @typeListMisordered) . "\n)";
10058716de38SJoe Perches	my $allWithAttr = "(?x:  \n" . join("|\n  ", @typeListWithAttr) . "\n)";
1006c8cb2ca3SAndy Whitcroft	$Modifier	= qr{(?:$Attribute|$Sparse|$mods)};
1007ab7e23f3SJoe Perches	$BasicType	= qr{
1008ab7e23f3SJoe Perches				(?:$typeTypedefs\b)|
1009ab7e23f3SJoe Perches				(?:${all}\b)
1010ab7e23f3SJoe Perches		}x;
10118905a67cSAndy Whitcroft	$NonptrType	= qr{
1012d2172eb5SAndy Whitcroft			(?:$Modifier\s+|const\s+)*
1013cf655043SAndy Whitcroft			(?:
10146b48db24SAndy Whitcroft				(?:typeof|__typeof__)\s*\([^\)]*\)|
10158ed22cadSAndy Whitcroft				(?:$typeTypedefs\b)|
1016c45dcabdSAndy Whitcroft				(?:${all}\b)
1017cf655043SAndy Whitcroft			)
1018c8cb2ca3SAndy Whitcroft			(?:\s+$Modifier|\s+const)*
10198905a67cSAndy Whitcroft		  }x;
10201813087dSJoe Perches	$NonptrTypeMisordered	= qr{
10211813087dSJoe Perches			(?:$Modifier\s+|const\s+)*
10221813087dSJoe Perches			(?:
10231813087dSJoe Perches				(?:${Misordered}\b)
10241813087dSJoe Perches			)
10251813087dSJoe Perches			(?:\s+$Modifier|\s+const)*
10261813087dSJoe Perches		  }x;
10278716de38SJoe Perches	$NonptrTypeWithAttr	= qr{
10288716de38SJoe Perches			(?:$Modifier\s+|const\s+)*
10298716de38SJoe Perches			(?:
10308716de38SJoe Perches				(?:typeof|__typeof__)\s*\([^\)]*\)|
10318716de38SJoe Perches				(?:$typeTypedefs\b)|
10328716de38SJoe Perches				(?:${allWithAttr}\b)
10338716de38SJoe Perches			)
10348716de38SJoe Perches			(?:\s+$Modifier|\s+const)*
10358716de38SJoe Perches		  }x;
10368905a67cSAndy Whitcroft	$Type	= qr{
1037c45dcabdSAndy Whitcroft			$NonptrType
10387b18496cSAntonio Borneo			(?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
1039c8cb2ca3SAndy Whitcroft			(?:\s+$Inline|\s+$Modifier)*
10408905a67cSAndy Whitcroft		  }x;
10411813087dSJoe Perches	$TypeMisordered	= qr{
10421813087dSJoe Perches			$NonptrTypeMisordered
10437b18496cSAntonio Borneo			(?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
10441813087dSJoe Perches			(?:\s+$Inline|\s+$Modifier)*
10451813087dSJoe Perches		  }x;
104691cb5195SJoe Perches	$Declare	= qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
10471813087dSJoe Perches	$DeclareMisordered	= qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
10488905a67cSAndy Whitcroft}
10498905a67cSAndy Whitcroftbuild_types();
10506c72ffaaSAndy Whitcroft
10517d2367afSJoe Perchesour $Typecast	= qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
1052d1fe9c09SJoe Perches
1053d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg
1054d1fe9c09SJoe Perches# requires at least perl version v5.10.0
1055d1fe9c09SJoe Perches# Any use must be runtime checked with $^V
1056d1fe9c09SJoe Perches
1057d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
10582435880fSJoe Perchesour $LvalOrFunc	= qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
1059c0a5c898SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
10607d2367afSJoe Perches
1061f8422308SJoe Perchesour $declaration_macros = qr{(?x:
10623e838b6cSJoe Perches	(?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
1063fe658f94SSteffen Maier	(?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
1064dcea7964SJoe Perches	(?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(|
1065dcea7964SJoe Perches	(?:$Storage\s+)?(?:XA_STATE|XA_STATE_ORDER)\s*\(
1066f8422308SJoe Perches)};
1067f8422308SJoe Perches
10688d0325ccSAditya Srivastavaour %allow_repeated_words = (
10698d0325ccSAditya Srivastava	add => '',
10708d0325ccSAditya Srivastava	added => '',
10718d0325ccSAditya Srivastava	bad => '',
10728d0325ccSAditya Srivastava	be => '',
10738d0325ccSAditya Srivastava);
10748d0325ccSAditya Srivastava
10757d2367afSJoe Perchessub deparenthesize {
10767d2367afSJoe Perches	my ($string) = @_;
10777d2367afSJoe Perches	return "" if (!defined($string));
10785b9553abSJoe Perches
10795b9553abSJoe Perches	while ($string =~ /^\s*\(.*\)\s*$/) {
10805b9553abSJoe Perches		$string =~ s@^\s*\(\s*@@;
10815b9553abSJoe Perches		$string =~ s@\s*\)\s*$@@;
10825b9553abSJoe Perches	}
10835b9553abSJoe Perches
10847d2367afSJoe Perches	$string =~ s@\s+@ @g;
10855b9553abSJoe Perches
10867d2367afSJoe Perches	return $string;
10877d2367afSJoe Perches}
10887d2367afSJoe Perches
10893445686aSJoe Perchessub seed_camelcase_file {
10903445686aSJoe Perches	my ($file) = @_;
10913445686aSJoe Perches
10923445686aSJoe Perches	return if (!(-f $file));
10933445686aSJoe Perches
10943445686aSJoe Perches	local $/;
10953445686aSJoe Perches
10963445686aSJoe Perches	open(my $include_file, '<', "$file")
10973445686aSJoe Perches	    or warn "$P: Can't read '$file' $!\n";
10983445686aSJoe Perches	my $text = <$include_file>;
10993445686aSJoe Perches	close($include_file);
11003445686aSJoe Perches
11013445686aSJoe Perches	my @lines = split('\n', $text);
11023445686aSJoe Perches
11033445686aSJoe Perches	foreach my $line (@lines) {
11043445686aSJoe Perches		next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
11053445686aSJoe Perches		if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
11063445686aSJoe Perches			$camelcase{$1} = 1;
110711ea516aSJoe Perches		} elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
110811ea516aSJoe Perches			$camelcase{$1} = 1;
110911ea516aSJoe Perches		} elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
11103445686aSJoe Perches			$camelcase{$1} = 1;
11113445686aSJoe Perches		}
11123445686aSJoe Perches	}
11133445686aSJoe Perches}
11143445686aSJoe Perches
1115cd28b119SJoe Perchesour %maintained_status = ();
1116cd28b119SJoe Perches
111785b0ee18SJoe Perchessub is_maintained_obsolete {
111885b0ee18SJoe Perches	my ($filename) = @_;
111985b0ee18SJoe Perches
1120f2c19c2fSJerome Forissier	return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
112185b0ee18SJoe Perches
1122cd28b119SJoe Perches	if (!exists($maintained_status{$filename})) {
1123cd28b119SJoe Perches		$maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
1124cd28b119SJoe Perches	}
112585b0ee18SJoe Perches
1126cd28b119SJoe Perches	return $maintained_status{$filename} =~ /obsolete/i;
112785b0ee18SJoe Perches}
112885b0ee18SJoe Perches
11293b6e8ac9SJoe Perchessub is_SPDX_License_valid {
11303b6e8ac9SJoe Perches	my ($license) = @_;
11313b6e8ac9SJoe Perches
1132f9363b31SGuenter Roeck	return 1 if (!$tree || which("python3") eq "" || !(-x "$root/scripts/spdxcheck.py") || !(-e "$gitroot"));
11333b6e8ac9SJoe Perches
113456294112SJoe Perches	my $root_path = abs_path($root);
1135f9363b31SGuenter Roeck	my $status = `cd "$root_path"; echo "$license" | scripts/spdxcheck.py -`;
11363b6e8ac9SJoe Perches	return 0 if ($status ne "");
11373b6e8ac9SJoe Perches	return 1;
11383b6e8ac9SJoe Perches}
11393b6e8ac9SJoe Perches
11403445686aSJoe Perchesmy $camelcase_seeded = 0;
11413445686aSJoe Perchessub seed_camelcase_includes {
11423445686aSJoe Perches	return if ($camelcase_seeded);
11433445686aSJoe Perches
11443445686aSJoe Perches	my $files;
1145c707a81dSJoe Perches	my $camelcase_cache = "";
1146c707a81dSJoe Perches	my @include_files = ();
1147c707a81dSJoe Perches
1148c707a81dSJoe Perches	$camelcase_seeded = 1;
1149351b2a1fSJoe Perches
11500f7f635bSJoe Perches	if (-e "$gitroot") {
1151dbbf869dSJoe Perches		my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
1152351b2a1fSJoe Perches		chomp $git_last_include_commit;
1153c707a81dSJoe Perches		$camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
1154c707a81dSJoe Perches	} else {
1155c707a81dSJoe Perches		my $last_mod_date = 0;
1156c707a81dSJoe Perches		$files = `find $root/include -name "*.h"`;
1157c707a81dSJoe Perches		@include_files = split('\n', $files);
1158c707a81dSJoe Perches		foreach my $file (@include_files) {
1159c707a81dSJoe Perches			my $date = POSIX::strftime("%Y%m%d%H%M",
1160c707a81dSJoe Perches						   localtime((stat $file)[9]));
1161c707a81dSJoe Perches			$last_mod_date = $date if ($last_mod_date < $date);
1162c707a81dSJoe Perches		}
1163c707a81dSJoe Perches		$camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
1164c707a81dSJoe Perches	}
1165c707a81dSJoe Perches
1166c707a81dSJoe Perches	if ($camelcase_cache ne "" && -f $camelcase_cache) {
1167c707a81dSJoe Perches		open(my $camelcase_file, '<', "$camelcase_cache")
1168c707a81dSJoe Perches		    or warn "$P: Can't read '$camelcase_cache' $!\n";
1169351b2a1fSJoe Perches		while (<$camelcase_file>) {
1170351b2a1fSJoe Perches			chomp;
1171351b2a1fSJoe Perches			$camelcase{$_} = 1;
1172351b2a1fSJoe Perches		}
1173351b2a1fSJoe Perches		close($camelcase_file);
1174351b2a1fSJoe Perches
1175351b2a1fSJoe Perches		return;
1176351b2a1fSJoe Perches	}
1177c707a81dSJoe Perches
11780f7f635bSJoe Perches	if (-e "$gitroot") {
1179dbbf869dSJoe Perches		$files = `${git_command} ls-files "include/*.h"`;
1180c707a81dSJoe Perches		@include_files = split('\n', $files);
11813445686aSJoe Perches	}
1182c707a81dSJoe Perches
11833445686aSJoe Perches	foreach my $file (@include_files) {
11843445686aSJoe Perches		seed_camelcase_file($file);
11853445686aSJoe Perches	}
1186351b2a1fSJoe Perches
1187c707a81dSJoe Perches	if ($camelcase_cache ne "") {
1188351b2a1fSJoe Perches		unlink glob ".checkpatch-camelcase.*";
1189c707a81dSJoe Perches		open(my $camelcase_file, '>', "$camelcase_cache")
1190c707a81dSJoe Perches		    or warn "$P: Can't write '$camelcase_cache' $!\n";
1191351b2a1fSJoe Perches		foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
1192351b2a1fSJoe Perches			print $camelcase_file ("$_\n");
1193351b2a1fSJoe Perches		}
1194351b2a1fSJoe Perches		close($camelcase_file);
1195351b2a1fSJoe Perches	}
11963445686aSJoe Perches}
11973445686aSJoe Perches
1198f5f61325SJoe Perchessub git_is_single_file {
1199f5f61325SJoe Perches	my ($filename) = @_;
1200f5f61325SJoe Perches
1201f5f61325SJoe Perches	return 0 if ((which("git") eq "") || !(-e "$gitroot"));
1202f5f61325SJoe Perches
1203f5f61325SJoe Perches	my $output = `${git_command} ls-files -- $filename 2>/dev/null`;
1204f5f61325SJoe Perches	my $count = $output =~ tr/\n//;
1205f5f61325SJoe Perches	return $count eq 1 && $output =~ m{^${filename}$};
1206f5f61325SJoe Perches}
1207f5f61325SJoe Perches
1208d311cd44SJoe Perchessub git_commit_info {
1209d311cd44SJoe Perches	my ($commit, $id, $desc) = @_;
1210d311cd44SJoe Perches
12110f7f635bSJoe Perches	return ($id, $desc) if ((which("git") eq "") || !(-e "$gitroot"));
1212d311cd44SJoe Perches
1213dbbf869dSJoe Perches	my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`;
1214d311cd44SJoe Perches	$output =~ s/^\s*//gm;
1215d311cd44SJoe Perches	my @lines = split("\n", $output);
1216d311cd44SJoe Perches
12170d7835fcSJoe Perches	return ($id, $desc) if ($#lines < 0);
12180d7835fcSJoe Perches
12195a7f4455SSean Christopherson	if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) {
1220d311cd44SJoe Perches# Maybe one day convert this block of bash into something that returns
1221d311cd44SJoe Perches# all matching commit ids, but it's very slow...
1222d311cd44SJoe Perches#
1223d311cd44SJoe Perches#		echo "checking commits $1..."
1224d311cd44SJoe Perches#		git rev-list --remotes | grep -i "^$1" |
1225d311cd44SJoe Perches#		while read line ; do
1226d311cd44SJoe Perches#		    git log --format='%H %s' -1 $line |
1227d311cd44SJoe Perches#		    echo "commit $(cut -c 1-12,41-)"
1228d311cd44SJoe Perches#		done
12294ce9f970SJoe Perches	} elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./ ||
12304ce9f970SJoe Perches		 $lines[0] =~ /^fatal: bad object $commit/) {
1231948b133aSHeinrich Schuchardt		$id = undef;
1232d311cd44SJoe Perches	} else {
1233d311cd44SJoe Perches		$id = substr($lines[0], 0, 12);
1234d311cd44SJoe Perches		$desc = substr($lines[0], 41);
1235d311cd44SJoe Perches	}
1236d311cd44SJoe Perches
1237d311cd44SJoe Perches	return ($id, $desc);
1238d311cd44SJoe Perches}
1239d311cd44SJoe Perches
12406c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file);
12410a920b5bSAndy Whitcroft
124200df344fSAndy Whitcroftmy @rawlines = ();
1243c2fdda0dSAndy Whitcroftmy @lines = ();
12443705ce5bSJoe Perchesmy @fixed = ();
1245d752fcc8SJoe Perchesmy @fixed_inserted = ();
1246d752fcc8SJoe Perchesmy @fixed_deleted = ();
1247194f66fcSJoe Perchesmy $fixlinenr = -1;
1248194f66fcSJoe Perches
12494a593c34SDu, Changbin# If input is git commits, extract all commits from the commit expressions.
12504a593c34SDu, Changbin# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
12510f7f635bSJoe Perchesdie "$P: No git repository found\n" if ($git && !-e "$gitroot");
12524a593c34SDu, Changbin
12534a593c34SDu, Changbinif ($git) {
12544a593c34SDu, Changbin	my @commits = ();
12550dea9f1eSJoe Perches	foreach my $commit_expr (@ARGV) {
12564a593c34SDu, Changbin		my $git_range;
125728898fd1SJoe Perches		if ($commit_expr =~ m/^(.*)-(\d+)$/) {
125828898fd1SJoe Perches			$git_range = "-$2 $1";
12594a593c34SDu, Changbin		} elsif ($commit_expr =~ m/\.\./) {
12604a593c34SDu, Changbin			$git_range = "$commit_expr";
12614a593c34SDu, Changbin		} else {
12620dea9f1eSJoe Perches			$git_range = "-1 $commit_expr";
12630dea9f1eSJoe Perches		}
1264dbbf869dSJoe Perches		my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
12650dea9f1eSJoe Perches		foreach my $line (split(/\n/, $lines)) {
126628898fd1SJoe Perches			$line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
126728898fd1SJoe Perches			next if (!defined($1) || !defined($2));
12680dea9f1eSJoe Perches			my $sha1 = $1;
12690dea9f1eSJoe Perches			my $subject = $2;
12700dea9f1eSJoe Perches			unshift(@commits, $sha1);
12710dea9f1eSJoe Perches			$git_commits{$sha1} = $subject;
12724a593c34SDu, Changbin		}
12734a593c34SDu, Changbin	}
12744a593c34SDu, Changbin	die "$P: no git commits after extraction!\n" if (@commits == 0);
12754a593c34SDu, Changbin	@ARGV = @commits;
12764a593c34SDu, Changbin}
12774a593c34SDu, Changbin
1278c2fdda0dSAndy Whitcroftmy $vname;
127998005e8cSVadim Bendebury$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"};
12806c72ffaaSAndy Whitcroftfor my $filename (@ARGV) {
128121caa13cSAndy Whitcroft	my $FILE;
1282f5f61325SJoe Perches	my $is_git_file = git_is_single_file($filename);
1283f5f61325SJoe Perches	my $oldfile = $file;
1284f5f61325SJoe Perches	$file = 1 if ($is_git_file);
12854a593c34SDu, Changbin	if ($git) {
12864a593c34SDu, Changbin		open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
12874a593c34SDu, Changbin			die "$P: $filename: git format-patch failed - $!\n";
12884a593c34SDu, Changbin	} elsif ($file) {
128921caa13cSAndy Whitcroft		open($FILE, '-|', "diff -u /dev/null $filename") ||
12906c72ffaaSAndy Whitcroft			die "$P: $filename: diff failed - $!\n";
129121caa13cSAndy Whitcroft	} elsif ($filename eq '-') {
129221caa13cSAndy Whitcroft		open($FILE, '<&STDIN');
12936c72ffaaSAndy Whitcroft	} else {
129421caa13cSAndy Whitcroft		open($FILE, '<', "$filename") ||
12956c72ffaaSAndy Whitcroft			die "$P: $filename: open failed - $!\n";
12966c72ffaaSAndy Whitcroft	}
1297c2fdda0dSAndy Whitcroft	if ($filename eq '-') {
1298c2fdda0dSAndy Whitcroft		$vname = 'Your patch';
12994a593c34SDu, Changbin	} elsif ($git) {
13000dea9f1eSJoe Perches		$vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
1301c2fdda0dSAndy Whitcroft	} else {
1302c2fdda0dSAndy Whitcroft		$vname = $filename;
1303c2fdda0dSAndy Whitcroft	}
130421caa13cSAndy Whitcroft	while (<$FILE>) {
13050a920b5bSAndy Whitcroft		chomp;
130600df344fSAndy Whitcroft		push(@rawlines, $_);
1307c7f574d0SGeert Uytterhoeven		$vname = qq("$1") if ($filename eq '-' && $_ =~ m/^Subject:\s+(.+)/i);
13086c72ffaaSAndy Whitcroft	}
130921caa13cSAndy Whitcroft	close($FILE);
1310d8469f16SJoe Perches
1311d8469f16SJoe Perches	if ($#ARGV > 0 && $quiet == 0) {
1312d8469f16SJoe Perches		print '-' x length($vname) . "\n";
1313d8469f16SJoe Perches		print "$vname\n";
1314d8469f16SJoe Perches		print '-' x length($vname) . "\n";
1315d8469f16SJoe Perches	}
1316d8469f16SJoe Perches
1317c2fdda0dSAndy Whitcroft	if (!process($filename)) {
13180a920b5bSAndy Whitcroft		$exit = 1;
13190a920b5bSAndy Whitcroft	}
132000df344fSAndy Whitcroft	@rawlines = ();
132113214adfSAndy Whitcroft	@lines = ();
13223705ce5bSJoe Perches	@fixed = ();
1323d752fcc8SJoe Perches	@fixed_inserted = ();
1324d752fcc8SJoe Perches	@fixed_deleted = ();
1325194f66fcSJoe Perches	$fixlinenr = -1;
1326485ff23eSAlex Dowad	@modifierListFile = ();
1327485ff23eSAlex Dowad	@typeListFile = ();
1328485ff23eSAlex Dowad	build_types();
1329f5f61325SJoe Perches	$file = $oldfile if ($is_git_file);
13300a920b5bSAndy Whitcroft}
13310a920b5bSAndy Whitcroft
1332d8469f16SJoe Perchesif (!$quiet) {
13333c816e49SJoe Perches	hash_show_words(\%use_type, "Used");
13343c816e49SJoe Perches	hash_show_words(\%ignore_type, "Ignored");
13353c816e49SJoe Perches
13365b57980dSJoe Perches	if (!$perl_version_ok) {
1337d8469f16SJoe Perches		print << "EOM"
1338d8469f16SJoe Perches
1339d8469f16SJoe PerchesNOTE: perl $^V is not modern enough to detect all possible issues.
13405b57980dSJoe Perches      An upgrade to at least perl $minimum_perl_version is suggested.
1341d8469f16SJoe PerchesEOM
1342d8469f16SJoe Perches	}
1343d8469f16SJoe Perches	if ($exit) {
1344d8469f16SJoe Perches		print << "EOM"
1345d8469f16SJoe Perches
1346d8469f16SJoe PerchesNOTE: If any of the errors are false positives, please report
1347d8469f16SJoe Perches      them to the maintainer, see CHECKPATCH in MAINTAINERS.
1348d8469f16SJoe PerchesEOM
1349d8469f16SJoe Perches	}
1350d8469f16SJoe Perches}
1351d8469f16SJoe Perches
13520a920b5bSAndy Whitcroftexit($exit);
13530a920b5bSAndy Whitcroft
13540a920b5bSAndy Whitcroftsub top_of_kernel_tree {
13556c72ffaaSAndy Whitcroft	my ($root) = @_;
13566c72ffaaSAndy Whitcroft
13576c72ffaaSAndy Whitcroft	my @tree_check = (
13586c72ffaaSAndy Whitcroft		"COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
13596c72ffaaSAndy Whitcroft		"README", "Documentation", "arch", "include", "drivers",
13606c72ffaaSAndy Whitcroft		"fs", "init", "ipc", "kernel", "lib", "scripts",
13616c72ffaaSAndy Whitcroft	);
13626c72ffaaSAndy Whitcroft
13636c72ffaaSAndy Whitcroft	foreach my $check (@tree_check) {
13646c72ffaaSAndy Whitcroft		if (! -e $root . '/' . $check) {
13650a920b5bSAndy Whitcroft			return 0;
13660a920b5bSAndy Whitcroft		}
13676c72ffaaSAndy Whitcroft	}
13686c72ffaaSAndy Whitcroft	return 1;
13696c72ffaaSAndy Whitcroft}
13700a920b5bSAndy Whitcroft
137120112475SJoe Perchessub parse_email {
137220112475SJoe Perches	my ($formatted_email) = @_;
137320112475SJoe Perches
137420112475SJoe Perches	my $name = "";
1375fccaebf0SDwaipayan Ray	my $quoted = "";
1376dfa05c28SJoe Perches	my $name_comment = "";
137720112475SJoe Perches	my $address = "";
137820112475SJoe Perches	my $comment = "";
137920112475SJoe Perches
138020112475SJoe Perches	if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
138120112475SJoe Perches		$name = $1;
138220112475SJoe Perches		$address = $2;
138320112475SJoe Perches		$comment = $3 if defined $3;
138420112475SJoe Perches	} elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
138520112475SJoe Perches		$address = $1;
138620112475SJoe Perches		$comment = $2 if defined $2;
138720112475SJoe Perches	} elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
138820112475SJoe Perches		$address = $1;
138920112475SJoe Perches		$comment = $2 if defined $2;
139085e12066SJoe Perches		$formatted_email =~ s/\Q$address\E.*$//;
139120112475SJoe Perches		$name = $formatted_email;
13923705ce5bSJoe Perches		$name = trim($name);
139320112475SJoe Perches		$name =~ s/^\"|\"$//g;
139420112475SJoe Perches		# If there's a name left after stripping spaces and
139520112475SJoe Perches		# leading quotes, and the address doesn't have both
139620112475SJoe Perches		# leading and trailing angle brackets, the address
139720112475SJoe Perches		# is invalid. ie:
139820112475SJoe Perches		#   "joe smith [email protected]" bad
139920112475SJoe Perches		#   "joe smith <[email protected]" bad
140020112475SJoe Perches		if ($name ne "" && $address !~ /^<[^>]+>$/) {
140120112475SJoe Perches			$name = "";
140220112475SJoe Perches			$address = "";
140320112475SJoe Perches			$comment = "";
140420112475SJoe Perches		}
140520112475SJoe Perches	}
140620112475SJoe Perches
1407fccaebf0SDwaipayan Ray	# Extract comments from names excluding quoted parts
1408fccaebf0SDwaipayan Ray	# "John D. (Doe)" - Do not extract
1409fccaebf0SDwaipayan Ray	if ($name =~ s/\"(.+)\"//) {
1410fccaebf0SDwaipayan Ray		$quoted = $1;
1411dfa05c28SJoe Perches	}
1412fccaebf0SDwaipayan Ray	while ($name =~ s/\s*($balanced_parens)\s*/ /) {
1413fccaebf0SDwaipayan Ray		$name_comment .= trim($1);
1414fccaebf0SDwaipayan Ray	}
1415fccaebf0SDwaipayan Ray	$name =~ s/^[ \"]+|[ \"]+$//g;
1416fccaebf0SDwaipayan Ray	$name = trim("$quoted $name");
1417fccaebf0SDwaipayan Ray
14183705ce5bSJoe Perches	$address = trim($address);
141920112475SJoe Perches	$address =~ s/^\<|\>$//g;
1420fccaebf0SDwaipayan Ray	$comment = trim($comment);
142120112475SJoe Perches
142220112475SJoe Perches	if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
142320112475SJoe Perches		$name =~ s/(?<!\\)"/\\"/g; ##escape quotes
142420112475SJoe Perches		$name = "\"$name\"";
142520112475SJoe Perches	}
142620112475SJoe Perches
1427dfa05c28SJoe Perches	return ($name, $name_comment, $address, $comment);
142820112475SJoe Perches}
142920112475SJoe Perches
143020112475SJoe Perchessub format_email {
143148ca2d8aSDwaipayan Ray	my ($name, $name_comment, $address, $comment) = @_;
143220112475SJoe Perches
143320112475SJoe Perches	my $formatted_email;
143420112475SJoe Perches
1435fccaebf0SDwaipayan Ray	$name =~ s/^[ \"]+|[ \"]+$//g;
14363705ce5bSJoe Perches	$address = trim($address);
1437fccaebf0SDwaipayan Ray	$address =~ s/(?:\.|\,|\")+$//; ##trailing commas, dots or quotes
143820112475SJoe Perches
143920112475SJoe Perches	if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
144020112475SJoe Perches		$name =~ s/(?<!\\)"/\\"/g; ##escape quotes
144120112475SJoe Perches		$name = "\"$name\"";
144220112475SJoe Perches	}
144320112475SJoe Perches
1444fccaebf0SDwaipayan Ray	$name_comment = trim($name_comment);
1445fccaebf0SDwaipayan Ray	$name_comment = " $name_comment" if ($name_comment ne "");
1446fccaebf0SDwaipayan Ray	$comment = trim($comment);
1447fccaebf0SDwaipayan Ray	$comment = " $comment" if ($comment ne "");
1448fccaebf0SDwaipayan Ray
144920112475SJoe Perches	if ("$name" eq "") {
145020112475SJoe Perches		$formatted_email = "$address";
145120112475SJoe Perches	} else {
145248ca2d8aSDwaipayan Ray		$formatted_email = "$name$name_comment <$address>";
145320112475SJoe Perches	}
145448ca2d8aSDwaipayan Ray	$formatted_email .= "$comment";
145520112475SJoe Perches	return $formatted_email;
145620112475SJoe Perches}
145720112475SJoe Perches
1458dfa05c28SJoe Perchessub reformat_email {
1459dfa05c28SJoe Perches	my ($email) = @_;
1460dfa05c28SJoe Perches
1461dfa05c28SJoe Perches	my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
146248ca2d8aSDwaipayan Ray	return format_email($email_name, $name_comment, $email_address, $comment);
1463dfa05c28SJoe Perches}
1464dfa05c28SJoe Perches
1465dfa05c28SJoe Perchessub same_email_addresses {
1466fccaebf0SDwaipayan Ray	my ($email1, $email2) = @_;
1467dfa05c28SJoe Perches
1468dfa05c28SJoe Perches	my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1);
1469dfa05c28SJoe Perches	my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2);
1470dfa05c28SJoe Perches
147148ca2d8aSDwaipayan Ray	return $email1_name eq $email2_name &&
147248ca2d8aSDwaipayan Ray	       $email1_address eq $email2_address &&
147348ca2d8aSDwaipayan Ray	       $name1_comment eq $name2_comment &&
147448ca2d8aSDwaipayan Ray	       $comment1 eq $comment2;
147548ca2d8aSDwaipayan Ray}
1476dfa05c28SJoe Perches
1477d311cd44SJoe Perchessub which {
1478d311cd44SJoe Perches	my ($bin) = @_;
1479d311cd44SJoe Perches
1480d311cd44SJoe Perches	foreach my $path (split(/:/, $ENV{PATH})) {
1481d311cd44SJoe Perches		if (-e "$path/$bin") {
1482d311cd44SJoe Perches			return "$path/$bin";
1483d311cd44SJoe Perches		}
1484d311cd44SJoe Perches	}
1485d311cd44SJoe Perches
1486d311cd44SJoe Perches	return "";
1487d311cd44SJoe Perches}
1488d311cd44SJoe Perches
1489000d1cc1SJoe Perchessub which_conf {
1490000d1cc1SJoe Perches	my ($conf) = @_;
1491000d1cc1SJoe Perches
1492000d1cc1SJoe Perches	foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1493000d1cc1SJoe Perches		if (-e "$path/$conf") {
1494000d1cc1SJoe Perches			return "$path/$conf";
1495000d1cc1SJoe Perches		}
1496000d1cc1SJoe Perches	}
1497000d1cc1SJoe Perches
1498000d1cc1SJoe Perches	return "";
1499000d1cc1SJoe Perches}
1500000d1cc1SJoe Perches
15010a920b5bSAndy Whitcroftsub expand_tabs {
15020a920b5bSAndy Whitcroft	my ($str) = @_;
15030a920b5bSAndy Whitcroft
15040a920b5bSAndy Whitcroft	my $res = '';
15050a920b5bSAndy Whitcroft	my $n = 0;
15060a920b5bSAndy Whitcroft	for my $c (split(//, $str)) {
15070a920b5bSAndy Whitcroft		if ($c eq "\t") {
15080a920b5bSAndy Whitcroft			$res .= ' ';
15090a920b5bSAndy Whitcroft			$n++;
1510713a09deSAntonio Borneo			for (; ($n % $tabsize) != 0; $n++) {
15110a920b5bSAndy Whitcroft				$res .= ' ';
15120a920b5bSAndy Whitcroft			}
15130a920b5bSAndy Whitcroft			next;
15140a920b5bSAndy Whitcroft		}
15150a920b5bSAndy Whitcroft		$res .= $c;
15160a920b5bSAndy Whitcroft		$n++;
15170a920b5bSAndy Whitcroft	}
15180a920b5bSAndy Whitcroft
15190a920b5bSAndy Whitcroft	return $res;
15200a920b5bSAndy Whitcroft}
15216c72ffaaSAndy Whitcroftsub copy_spacing {
1522773647a0SAndy Whitcroft	(my $res = shift) =~ tr/\t/ /c;
15236c72ffaaSAndy Whitcroft	return $res;
15246c72ffaaSAndy Whitcroft}
15250a920b5bSAndy Whitcroft
15264a0df2efSAndy Whitcroftsub line_stats {
15274a0df2efSAndy Whitcroft	my ($line) = @_;
15284a0df2efSAndy Whitcroft
15294a0df2efSAndy Whitcroft	# Drop the diff line leader and expand tabs
15304a0df2efSAndy Whitcroft	$line =~ s/^.//;
15314a0df2efSAndy Whitcroft	$line = expand_tabs($line);
15324a0df2efSAndy Whitcroft
15334a0df2efSAndy Whitcroft	# Pick the indent from the front of the line.
15344a0df2efSAndy Whitcroft	my ($white) = ($line =~ /^(\s*)/);
15354a0df2efSAndy Whitcroft
15364a0df2efSAndy Whitcroft	return (length($line), length($white));
15374a0df2efSAndy Whitcroft}
15384a0df2efSAndy Whitcroft
1539773647a0SAndy Whitcroftmy $sanitise_quote = '';
1540773647a0SAndy Whitcroft
1541773647a0SAndy Whitcroftsub sanitise_line_reset {
1542773647a0SAndy Whitcroft	my ($in_comment) = @_;
1543773647a0SAndy Whitcroft
1544773647a0SAndy Whitcroft	if ($in_comment) {
1545773647a0SAndy Whitcroft		$sanitise_quote = '*/';
1546773647a0SAndy Whitcroft	} else {
1547773647a0SAndy Whitcroft		$sanitise_quote = '';
1548773647a0SAndy Whitcroft	}
1549773647a0SAndy Whitcroft}
155000df344fSAndy Whitcroftsub sanitise_line {
155100df344fSAndy Whitcroft	my ($line) = @_;
155200df344fSAndy Whitcroft
155300df344fSAndy Whitcroft	my $res = '';
155400df344fSAndy Whitcroft	my $l = '';
155500df344fSAndy Whitcroft
1556c2fdda0dSAndy Whitcroft	my $qlen = 0;
1557773647a0SAndy Whitcroft	my $off = 0;
1558773647a0SAndy Whitcroft	my $c;
155900df344fSAndy Whitcroft
1560773647a0SAndy Whitcroft	# Always copy over the diff marker.
1561773647a0SAndy Whitcroft	$res = substr($line, 0, 1);
1562773647a0SAndy Whitcroft
1563773647a0SAndy Whitcroft	for ($off = 1; $off < length($line); $off++) {
1564773647a0SAndy Whitcroft		$c = substr($line, $off, 1);
1565773647a0SAndy Whitcroft
15668d2e11b2SClaudio Fontana		# Comments we are whacking completely including the begin
1567773647a0SAndy Whitcroft		# and end, all to $;.
1568773647a0SAndy Whitcroft		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1569773647a0SAndy Whitcroft			$sanitise_quote = '*/';
1570773647a0SAndy Whitcroft
1571773647a0SAndy Whitcroft			substr($res, $off, 2, "$;$;");
1572773647a0SAndy Whitcroft			$off++;
157300df344fSAndy Whitcroft			next;
1574773647a0SAndy Whitcroft		}
157581bc0e02SAndy Whitcroft		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
1576773647a0SAndy Whitcroft			$sanitise_quote = '';
1577773647a0SAndy Whitcroft			substr($res, $off, 2, "$;$;");
1578773647a0SAndy Whitcroft			$off++;
1579773647a0SAndy Whitcroft			next;
1580773647a0SAndy Whitcroft		}
1581113f04a8SDaniel Walker		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1582113f04a8SDaniel Walker			$sanitise_quote = '//';
1583113f04a8SDaniel Walker
1584113f04a8SDaniel Walker			substr($res, $off, 2, $sanitise_quote);
1585113f04a8SDaniel Walker			$off++;
1586113f04a8SDaniel Walker			next;
1587113f04a8SDaniel Walker		}
1588773647a0SAndy Whitcroft
1589773647a0SAndy Whitcroft		# A \ in a string means ignore the next character.
1590773647a0SAndy Whitcroft		if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1591773647a0SAndy Whitcroft		    $c eq "\\") {
1592773647a0SAndy Whitcroft			substr($res, $off, 2, 'XX');
1593773647a0SAndy Whitcroft			$off++;
1594773647a0SAndy Whitcroft			next;
1595773647a0SAndy Whitcroft		}
1596773647a0SAndy Whitcroft		# Regular quotes.
1597773647a0SAndy Whitcroft		if ($c eq "'" || $c eq '"') {
1598773647a0SAndy Whitcroft			if ($sanitise_quote eq '') {
1599773647a0SAndy Whitcroft				$sanitise_quote = $c;
1600773647a0SAndy Whitcroft
1601773647a0SAndy Whitcroft				substr($res, $off, 1, $c);
1602773647a0SAndy Whitcroft				next;
1603773647a0SAndy Whitcroft			} elsif ($sanitise_quote eq $c) {
1604773647a0SAndy Whitcroft				$sanitise_quote = '';
160500df344fSAndy Whitcroft			}
160600df344fSAndy Whitcroft		}
1607773647a0SAndy Whitcroft
1608fae17daeSAndy Whitcroft		#print "c<$c> SQ<$sanitise_quote>\n";
1609773647a0SAndy Whitcroft		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1610773647a0SAndy Whitcroft			substr($res, $off, 1, $;);
1611113f04a8SDaniel Walker		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1612113f04a8SDaniel Walker			substr($res, $off, 1, $;);
1613773647a0SAndy Whitcroft		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1614773647a0SAndy Whitcroft			substr($res, $off, 1, 'X');
161500df344fSAndy Whitcroft		} else {
1616773647a0SAndy Whitcroft			substr($res, $off, 1, $c);
161700df344fSAndy Whitcroft		}
1618c2fdda0dSAndy Whitcroft	}
1619c2fdda0dSAndy Whitcroft
1620113f04a8SDaniel Walker	if ($sanitise_quote eq '//') {
1621113f04a8SDaniel Walker		$sanitise_quote = '';
1622113f04a8SDaniel Walker	}
1623113f04a8SDaniel Walker
1624c2fdda0dSAndy Whitcroft	# The pathname on a #include may be surrounded by '<' and '>'.
1625c45dcabdSAndy Whitcroft	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
1626c2fdda0dSAndy Whitcroft		my $clean = 'X' x length($1);
1627c2fdda0dSAndy Whitcroft		$res =~ s@\<.*\>@<$clean>@;
1628c2fdda0dSAndy Whitcroft
1629c2fdda0dSAndy Whitcroft	# The whole of a #error is a string.
1630c45dcabdSAndy Whitcroft	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
1631c2fdda0dSAndy Whitcroft		my $clean = 'X' x length($1);
1632c45dcabdSAndy Whitcroft		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
1633c2fdda0dSAndy Whitcroft	}
1634c2fdda0dSAndy Whitcroft
1635dadf680dSJoe Perches	if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1636dadf680dSJoe Perches		my $match = $1;
1637dadf680dSJoe Perches		$res =~ s/\Q$match\E/"$;" x length($match)/e;
1638dadf680dSJoe Perches	}
1639dadf680dSJoe Perches
164000df344fSAndy Whitcroft	return $res;
164100df344fSAndy Whitcroft}
164200df344fSAndy Whitcroft
1643a6962d72SJoe Perchessub get_quoted_string {
1644a6962d72SJoe Perches	my ($line, $rawline) = @_;
1645a6962d72SJoe Perches
1646478b1799SJoe Perches	return "" if (!defined($line) || !defined($rawline));
164733acb54aSJoe Perches	return "" if ($line !~ m/($String)/g);
1648a6962d72SJoe Perches	return substr($rawline, $-[0], $+[0] - $-[0]);
1649a6962d72SJoe Perches}
1650a6962d72SJoe Perches
16518905a67cSAndy Whitcroftsub ctx_statement_block {
16528905a67cSAndy Whitcroft	my ($linenr, $remain, $off) = @_;
16538905a67cSAndy Whitcroft	my $line = $linenr - 1;
16548905a67cSAndy Whitcroft	my $blk = '';
16558905a67cSAndy Whitcroft	my $soff = $off;
16568905a67cSAndy Whitcroft	my $coff = $off - 1;
1657773647a0SAndy Whitcroft	my $coff_set = 0;
16588905a67cSAndy Whitcroft
165913214adfSAndy Whitcroft	my $loff = 0;
166013214adfSAndy Whitcroft
16618905a67cSAndy Whitcroft	my $type = '';
16628905a67cSAndy Whitcroft	my $level = 0;
1663a2750645SAndy Whitcroft	my @stack = ();
1664cf655043SAndy Whitcroft	my $p;
16658905a67cSAndy Whitcroft	my $c;
16668905a67cSAndy Whitcroft	my $len = 0;
166713214adfSAndy Whitcroft
166813214adfSAndy Whitcroft	my $remainder;
16698905a67cSAndy Whitcroft	while (1) {
1670a2750645SAndy Whitcroft		@stack = (['', 0]) if ($#stack == -1);
1671a2750645SAndy Whitcroft
1672773647a0SAndy Whitcroft		#warn "CSB: blk<$blk> remain<$remain>\n";
16738905a67cSAndy Whitcroft		# If we are about to drop off the end, pull in more
16748905a67cSAndy Whitcroft		# context.
16758905a67cSAndy Whitcroft		if ($off >= $len) {
16768905a67cSAndy Whitcroft			for (; $remain > 0; $line++) {
1677dea33496SAndy Whitcroft				last if (!defined $lines[$line]);
1678c2fdda0dSAndy Whitcroft				next if ($lines[$line] =~ /^-/);
16798905a67cSAndy Whitcroft				$remain--;
168013214adfSAndy Whitcroft				$loff = $len;
1681c2fdda0dSAndy Whitcroft				$blk .= $lines[$line] . "\n";
16828905a67cSAndy Whitcroft				$len = length($blk);
16838905a67cSAndy Whitcroft				$line++;
16848905a67cSAndy Whitcroft				last;
16858905a67cSAndy Whitcroft			}
16868905a67cSAndy Whitcroft			# Bail if there is no further context.
16878905a67cSAndy Whitcroft			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
168813214adfSAndy Whitcroft			if ($off >= $len) {
16898905a67cSAndy Whitcroft				last;
16908905a67cSAndy Whitcroft			}
1691f74bd194SAndy Whitcroft			if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1692f74bd194SAndy Whitcroft				$level++;
1693f74bd194SAndy Whitcroft				$type = '#';
1694f74bd194SAndy Whitcroft			}
16958905a67cSAndy Whitcroft		}
1696cf655043SAndy Whitcroft		$p = $c;
16978905a67cSAndy Whitcroft		$c = substr($blk, $off, 1);
169813214adfSAndy Whitcroft		$remainder = substr($blk, $off);
16998905a67cSAndy Whitcroft
1700773647a0SAndy Whitcroft		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
17014635f4fbSAndy Whitcroft
17024635f4fbSAndy Whitcroft		# Handle nested #if/#else.
17034635f4fbSAndy Whitcroft		if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
17044635f4fbSAndy Whitcroft			push(@stack, [ $type, $level ]);
17054635f4fbSAndy Whitcroft		} elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
17064635f4fbSAndy Whitcroft			($type, $level) = @{$stack[$#stack - 1]};
17074635f4fbSAndy Whitcroft		} elsif ($remainder =~ /^#\s*endif\b/) {
17084635f4fbSAndy Whitcroft			($type, $level) = @{pop(@stack)};
17094635f4fbSAndy Whitcroft		}
17104635f4fbSAndy Whitcroft
17118905a67cSAndy Whitcroft		# Statement ends at the ';' or a close '}' at the
17128905a67cSAndy Whitcroft		# outermost level.
17138905a67cSAndy Whitcroft		if ($level == 0 && $c eq ';') {
17148905a67cSAndy Whitcroft			last;
17158905a67cSAndy Whitcroft		}
17168905a67cSAndy Whitcroft
171713214adfSAndy Whitcroft		# An else is really a conditional as long as its not else if
1718773647a0SAndy Whitcroft		if ($level == 0 && $coff_set == 0 &&
1719773647a0SAndy Whitcroft				(!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1720773647a0SAndy Whitcroft				$remainder =~ /^(else)(?:\s|{)/ &&
1721773647a0SAndy Whitcroft				$remainder !~ /^else\s+if\b/) {
1722773647a0SAndy Whitcroft			$coff = $off + length($1) - 1;
1723773647a0SAndy Whitcroft			$coff_set = 1;
1724773647a0SAndy Whitcroft			#warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1725773647a0SAndy Whitcroft			#warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
172613214adfSAndy Whitcroft		}
172713214adfSAndy Whitcroft
17288905a67cSAndy Whitcroft		if (($type eq '' || $type eq '(') && $c eq '(') {
17298905a67cSAndy Whitcroft			$level++;
17308905a67cSAndy Whitcroft			$type = '(';
17318905a67cSAndy Whitcroft		}
17328905a67cSAndy Whitcroft		if ($type eq '(' && $c eq ')') {
17338905a67cSAndy Whitcroft			$level--;
17348905a67cSAndy Whitcroft			$type = ($level != 0)? '(' : '';
17358905a67cSAndy Whitcroft
17368905a67cSAndy Whitcroft			if ($level == 0 && $coff < $soff) {
17378905a67cSAndy Whitcroft				$coff = $off;
1738773647a0SAndy Whitcroft				$coff_set = 1;
1739773647a0SAndy Whitcroft				#warn "CSB: mark coff<$coff>\n";
17408905a67cSAndy Whitcroft			}
17418905a67cSAndy Whitcroft		}
17428905a67cSAndy Whitcroft		if (($type eq '' || $type eq '{') && $c eq '{') {
17438905a67cSAndy Whitcroft			$level++;
17448905a67cSAndy Whitcroft			$type = '{';
17458905a67cSAndy Whitcroft		}
17468905a67cSAndy Whitcroft		if ($type eq '{' && $c eq '}') {
17478905a67cSAndy Whitcroft			$level--;
17488905a67cSAndy Whitcroft			$type = ($level != 0)? '{' : '';
17498905a67cSAndy Whitcroft
17508905a67cSAndy Whitcroft			if ($level == 0) {
1751b998e001SPatrick Pannuto				if (substr($blk, $off + 1, 1) eq ';') {
1752b998e001SPatrick Pannuto					$off++;
1753b998e001SPatrick Pannuto				}
17548905a67cSAndy Whitcroft				last;
17558905a67cSAndy Whitcroft			}
17568905a67cSAndy Whitcroft		}
1757f74bd194SAndy Whitcroft		# Preprocessor commands end at the newline unless escaped.
1758f74bd194SAndy Whitcroft		if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1759f74bd194SAndy Whitcroft			$level--;
1760f74bd194SAndy Whitcroft			$type = '';
1761f74bd194SAndy Whitcroft			$off++;
1762f74bd194SAndy Whitcroft			last;
1763f74bd194SAndy Whitcroft		}
17648905a67cSAndy Whitcroft		$off++;
17658905a67cSAndy Whitcroft	}
1766a3bb97a7SAndy Whitcroft	# We are truly at the end, so shuffle to the next line.
176713214adfSAndy Whitcroft	if ($off == $len) {
1768a3bb97a7SAndy Whitcroft		$loff = $len + 1;
176913214adfSAndy Whitcroft		$line++;
177013214adfSAndy Whitcroft		$remain--;
177113214adfSAndy Whitcroft	}
17728905a67cSAndy Whitcroft
17738905a67cSAndy Whitcroft	my $statement = substr($blk, $soff, $off - $soff + 1);
17748905a67cSAndy Whitcroft	my $condition = substr($blk, $soff, $coff - $soff + 1);
17758905a67cSAndy Whitcroft
17768905a67cSAndy Whitcroft	#warn "STATEMENT<$statement>\n";
17778905a67cSAndy Whitcroft	#warn "CONDITION<$condition>\n";
17788905a67cSAndy Whitcroft
1779773647a0SAndy Whitcroft	#print "coff<$coff> soff<$off> loff<$loff>\n";
178013214adfSAndy Whitcroft
178113214adfSAndy Whitcroft	return ($statement, $condition,
178213214adfSAndy Whitcroft			$line, $remain + 1, $off - $loff + 1, $level);
178313214adfSAndy Whitcroft}
178413214adfSAndy Whitcroft
1785cf655043SAndy Whitcroftsub statement_lines {
1786cf655043SAndy Whitcroft	my ($stmt) = @_;
1787cf655043SAndy Whitcroft
1788cf655043SAndy Whitcroft	# Strip the diff line prefixes and rip blank lines at start and end.
1789cf655043SAndy Whitcroft	$stmt =~ s/(^|\n)./$1/g;
1790cf655043SAndy Whitcroft	$stmt =~ s/^\s*//;
1791cf655043SAndy Whitcroft	$stmt =~ s/\s*$//;
1792cf655043SAndy Whitcroft
1793cf655043SAndy Whitcroft	my @stmt_lines = ($stmt =~ /\n/g);
1794cf655043SAndy Whitcroft
1795cf655043SAndy Whitcroft	return $#stmt_lines + 2;
1796cf655043SAndy Whitcroft}
1797cf655043SAndy Whitcroft
1798cf655043SAndy Whitcroftsub statement_rawlines {
1799cf655043SAndy Whitcroft	my ($stmt) = @_;
1800cf655043SAndy Whitcroft
1801cf655043SAndy Whitcroft	my @stmt_lines = ($stmt =~ /\n/g);
1802cf655043SAndy Whitcroft
1803cf655043SAndy Whitcroft	return $#stmt_lines + 2;
1804cf655043SAndy Whitcroft}
1805cf655043SAndy Whitcroft
1806cf655043SAndy Whitcroftsub statement_block_size {
1807cf655043SAndy Whitcroft	my ($stmt) = @_;
1808cf655043SAndy Whitcroft
1809cf655043SAndy Whitcroft	$stmt =~ s/(^|\n)./$1/g;
1810cf655043SAndy Whitcroft	$stmt =~ s/^\s*{//;
1811cf655043SAndy Whitcroft	$stmt =~ s/}\s*$//;
1812cf655043SAndy Whitcroft	$stmt =~ s/^\s*//;
1813cf655043SAndy Whitcroft	$stmt =~ s/\s*$//;
1814cf655043SAndy Whitcroft
1815cf655043SAndy Whitcroft	my @stmt_lines = ($stmt =~ /\n/g);
1816cf655043SAndy Whitcroft	my @stmt_statements = ($stmt =~ /;/g);
1817cf655043SAndy Whitcroft
1818cf655043SAndy Whitcroft	my $stmt_lines = $#stmt_lines + 2;
1819cf655043SAndy Whitcroft	my $stmt_statements = $#stmt_statements + 1;
1820cf655043SAndy Whitcroft
1821cf655043SAndy Whitcroft	if ($stmt_lines > $stmt_statements) {
1822cf655043SAndy Whitcroft		return $stmt_lines;
1823cf655043SAndy Whitcroft	} else {
1824cf655043SAndy Whitcroft		return $stmt_statements;
1825cf655043SAndy Whitcroft	}
1826cf655043SAndy Whitcroft}
1827cf655043SAndy Whitcroft
182813214adfSAndy Whitcroftsub ctx_statement_full {
182913214adfSAndy Whitcroft	my ($linenr, $remain, $off) = @_;
183013214adfSAndy Whitcroft	my ($statement, $condition, $level);
183113214adfSAndy Whitcroft
183213214adfSAndy Whitcroft	my (@chunks);
183313214adfSAndy Whitcroft
1834cf655043SAndy Whitcroft	# Grab the first conditional/block pair.
183513214adfSAndy Whitcroft	($statement, $condition, $linenr, $remain, $off, $level) =
183613214adfSAndy Whitcroft				ctx_statement_block($linenr, $remain, $off);
1837773647a0SAndy Whitcroft	#print "F: c<$condition> s<$statement> remain<$remain>\n";
183813214adfSAndy Whitcroft	push(@chunks, [ $condition, $statement ]);
1839cf655043SAndy Whitcroft	if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1840cf655043SAndy Whitcroft		return ($level, $linenr, @chunks);
1841cf655043SAndy Whitcroft	}
1842cf655043SAndy Whitcroft
1843cf655043SAndy Whitcroft	# Pull in the following conditional/block pairs and see if they
1844cf655043SAndy Whitcroft	# could continue the statement.
1845cf655043SAndy Whitcroft	for (;;) {
184613214adfSAndy Whitcroft		($statement, $condition, $linenr, $remain, $off, $level) =
184713214adfSAndy Whitcroft				ctx_statement_block($linenr, $remain, $off);
1848cf655043SAndy Whitcroft		#print "C: c<$condition> s<$statement> remain<$remain>\n";
1849773647a0SAndy Whitcroft		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1850cf655043SAndy Whitcroft		#print "C: push\n";
1851cf655043SAndy Whitcroft		push(@chunks, [ $condition, $statement ]);
185213214adfSAndy Whitcroft	}
185313214adfSAndy Whitcroft
185413214adfSAndy Whitcroft	return ($level, $linenr, @chunks);
18558905a67cSAndy Whitcroft}
18568905a67cSAndy Whitcroft
18574a0df2efSAndy Whitcroftsub ctx_block_get {
1858f0a594c1SAndy Whitcroft	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
18594a0df2efSAndy Whitcroft	my $line;
18604a0df2efSAndy Whitcroft	my $start = $linenr - 1;
18614a0df2efSAndy Whitcroft	my $blk = '';
18624a0df2efSAndy Whitcroft	my @o;
18634a0df2efSAndy Whitcroft	my @c;
18644a0df2efSAndy Whitcroft	my @res = ();
18654a0df2efSAndy Whitcroft
1866f0a594c1SAndy Whitcroft	my $level = 0;
18674635f4fbSAndy Whitcroft	my @stack = ($level);
186800df344fSAndy Whitcroft	for ($line = $start; $remain > 0; $line++) {
186900df344fSAndy Whitcroft		next if ($rawlines[$line] =~ /^-/);
187000df344fSAndy Whitcroft		$remain--;
187100df344fSAndy Whitcroft
187200df344fSAndy Whitcroft		$blk .= $rawlines[$line];
18734635f4fbSAndy Whitcroft
18744635f4fbSAndy Whitcroft		# Handle nested #if/#else.
187501464f30SAndy Whitcroft		if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
18764635f4fbSAndy Whitcroft			push(@stack, $level);
187701464f30SAndy Whitcroft		} elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
18784635f4fbSAndy Whitcroft			$level = $stack[$#stack - 1];
187901464f30SAndy Whitcroft		} elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
18804635f4fbSAndy Whitcroft			$level = pop(@stack);
18814635f4fbSAndy Whitcroft		}
18824635f4fbSAndy Whitcroft
188301464f30SAndy Whitcroft		foreach my $c (split(//, $lines[$line])) {
1884f0a594c1SAndy Whitcroft			##print "C<$c>L<$level><$open$close>O<$off>\n";
1885f0a594c1SAndy Whitcroft			if ($off > 0) {
1886f0a594c1SAndy Whitcroft				$off--;
1887f0a594c1SAndy Whitcroft				next;
1888f0a594c1SAndy Whitcroft			}
18894a0df2efSAndy Whitcroft
1890f0a594c1SAndy Whitcroft			if ($c eq $close && $level > 0) {
1891f0a594c1SAndy Whitcroft				$level--;
1892f0a594c1SAndy Whitcroft				last if ($level == 0);
1893f0a594c1SAndy Whitcroft			} elsif ($c eq $open) {
1894f0a594c1SAndy Whitcroft				$level++;
1895f0a594c1SAndy Whitcroft			}
1896f0a594c1SAndy Whitcroft		}
18974a0df2efSAndy Whitcroft
1898f0a594c1SAndy Whitcroft		if (!$outer || $level <= 1) {
189900df344fSAndy Whitcroft			push(@res, $rawlines[$line]);
19004a0df2efSAndy Whitcroft		}
19014a0df2efSAndy Whitcroft
1902f0a594c1SAndy Whitcroft		last if ($level == 0);
19034a0df2efSAndy Whitcroft	}
19044a0df2efSAndy Whitcroft
1905f0a594c1SAndy Whitcroft	return ($level, @res);
19064a0df2efSAndy Whitcroft}
19074a0df2efSAndy Whitcroftsub ctx_block_outer {
19084a0df2efSAndy Whitcroft	my ($linenr, $remain) = @_;
19094a0df2efSAndy Whitcroft
1910f0a594c1SAndy Whitcroft	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1911f0a594c1SAndy Whitcroft	return @r;
19124a0df2efSAndy Whitcroft}
19134a0df2efSAndy Whitcroftsub ctx_block {
19144a0df2efSAndy Whitcroft	my ($linenr, $remain) = @_;
19154a0df2efSAndy Whitcroft
1916f0a594c1SAndy Whitcroft	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1917f0a594c1SAndy Whitcroft	return @r;
1918653d4876SAndy Whitcroft}
1919653d4876SAndy Whitcroftsub ctx_statement {
1920f0a594c1SAndy Whitcroft	my ($linenr, $remain, $off) = @_;
1921f0a594c1SAndy Whitcroft
1922f0a594c1SAndy Whitcroft	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1923f0a594c1SAndy Whitcroft	return @r;
1924f0a594c1SAndy Whitcroft}
1925f0a594c1SAndy Whitcroftsub ctx_block_level {
1926653d4876SAndy Whitcroft	my ($linenr, $remain) = @_;
1927653d4876SAndy Whitcroft
1928f0a594c1SAndy Whitcroft	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
19294a0df2efSAndy Whitcroft}
19309c0ca6f9SAndy Whitcroftsub ctx_statement_level {
19319c0ca6f9SAndy Whitcroft	my ($linenr, $remain, $off) = @_;
19329c0ca6f9SAndy Whitcroft
19339c0ca6f9SAndy Whitcroft	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
19349c0ca6f9SAndy Whitcroft}
19354a0df2efSAndy Whitcroft
19364a0df2efSAndy Whitcroftsub ctx_locate_comment {
19374a0df2efSAndy Whitcroft	my ($first_line, $end_line) = @_;
19384a0df2efSAndy Whitcroft
1939a55ee0ccSJoe Perches	# If c99 comment on the current line, or the line before or after
1940a55ee0ccSJoe Perches	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@^\+.*(//.*$)@);
1941a55ee0ccSJoe Perches	return $current_comment if (defined $current_comment);
1942a55ee0ccSJoe Perches	($current_comment) = ($rawlines[$end_line - 2] =~ m@^[\+ ].*(//.*$)@);
1943a55ee0ccSJoe Perches	return $current_comment if (defined $current_comment);
1944a55ee0ccSJoe Perches	($current_comment) = ($rawlines[$end_line] =~ m@^[\+ ].*(//.*$)@);
1945a55ee0ccSJoe Perches	return $current_comment if (defined $current_comment);
1946a55ee0ccSJoe Perches
19474a0df2efSAndy Whitcroft	# Catch a comment on the end of the line itself.
1948a55ee0ccSJoe Perches	($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
19494a0df2efSAndy Whitcroft	return $current_comment if (defined $current_comment);
19504a0df2efSAndy Whitcroft
19514a0df2efSAndy Whitcroft	# Look through the context and try and figure out if there is a
19524a0df2efSAndy Whitcroft	# comment.
19534a0df2efSAndy Whitcroft	my $in_comment = 0;
19544a0df2efSAndy Whitcroft	$current_comment = '';
19554a0df2efSAndy Whitcroft	for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
195600df344fSAndy Whitcroft		my $line = $rawlines[$linenr - 1];
195700df344fSAndy Whitcroft		#warn "           $line\n";
19584a0df2efSAndy Whitcroft		if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
19594a0df2efSAndy Whitcroft			$in_comment = 1;
19604a0df2efSAndy Whitcroft		}
19614a0df2efSAndy Whitcroft		if ($line =~ m@/\*@) {
19624a0df2efSAndy Whitcroft			$in_comment = 1;
19634a0df2efSAndy Whitcroft		}
19644a0df2efSAndy Whitcroft		if (!$in_comment && $current_comment ne '') {
19654a0df2efSAndy Whitcroft			$current_comment = '';
19664a0df2efSAndy Whitcroft		}
19674a0df2efSAndy Whitcroft		$current_comment .= $line . "\n" if ($in_comment);
19684a0df2efSAndy Whitcroft		if ($line =~ m@\*/@) {
19694a0df2efSAndy Whitcroft			$in_comment = 0;
19704a0df2efSAndy Whitcroft		}
19714a0df2efSAndy Whitcroft	}
19724a0df2efSAndy Whitcroft
19734a0df2efSAndy Whitcroft	chomp($current_comment);
19744a0df2efSAndy Whitcroft	return($current_comment);
19754a0df2efSAndy Whitcroft}
19764a0df2efSAndy Whitcroftsub ctx_has_comment {
19774a0df2efSAndy Whitcroft	my ($first_line, $end_line) = @_;
19784a0df2efSAndy Whitcroft	my $cmt = ctx_locate_comment($first_line, $end_line);
19794a0df2efSAndy Whitcroft
198000df344fSAndy Whitcroft	##print "LINE: $rawlines[$end_line - 1 ]\n";
19814a0df2efSAndy Whitcroft	##print "CMMT: $cmt\n";
19824a0df2efSAndy Whitcroft
19834a0df2efSAndy Whitcroft	return ($cmt ne '');
19844a0df2efSAndy Whitcroft}
19854a0df2efSAndy Whitcroft
19864d001e4dSAndy Whitcroftsub raw_line {
19874d001e4dSAndy Whitcroft	my ($linenr, $cnt) = @_;
19884d001e4dSAndy Whitcroft
19894d001e4dSAndy Whitcroft	my $offset = $linenr - 1;
19904d001e4dSAndy Whitcroft	$cnt++;
19914d001e4dSAndy Whitcroft
19924d001e4dSAndy Whitcroft	my $line;
19934d001e4dSAndy Whitcroft	while ($cnt) {
19944d001e4dSAndy Whitcroft		$line = $rawlines[$offset++];
19954d001e4dSAndy Whitcroft		next if (defined($line) && $line =~ /^-/);
19964d001e4dSAndy Whitcroft		$cnt--;
19974d001e4dSAndy Whitcroft	}
19984d001e4dSAndy Whitcroft
19994d001e4dSAndy Whitcroft	return $line;
20004d001e4dSAndy Whitcroft}
20014d001e4dSAndy Whitcroft
20022a9f9d85STobin C. Hardingsub get_stat_real {
20032a9f9d85STobin C. Harding	my ($linenr, $lc) = @_;
20042a9f9d85STobin C. Harding
20052a9f9d85STobin C. Harding	my $stat_real = raw_line($linenr, 0);
20062a9f9d85STobin C. Harding	for (my $count = $linenr + 1; $count <= $lc; $count++) {
20072a9f9d85STobin C. Harding		$stat_real = $stat_real . "\n" . raw_line($count, 0);
20082a9f9d85STobin C. Harding	}
20092a9f9d85STobin C. Harding
20102a9f9d85STobin C. Harding	return $stat_real;
20112a9f9d85STobin C. Harding}
20122a9f9d85STobin C. Harding
2013e3d95a2aSTobin C. Hardingsub get_stat_here {
2014e3d95a2aSTobin C. Harding	my ($linenr, $cnt, $here) = @_;
2015e3d95a2aSTobin C. Harding
2016e3d95a2aSTobin C. Harding	my $herectx = $here . "\n";
2017e3d95a2aSTobin C. Harding	for (my $n = 0; $n < $cnt; $n++) {
2018e3d95a2aSTobin C. Harding		$herectx .= raw_line($linenr, $n) . "\n";
2019e3d95a2aSTobin C. Harding	}
2020e3d95a2aSTobin C. Harding
2021e3d95a2aSTobin C. Harding	return $herectx;
2022e3d95a2aSTobin C. Harding}
2023e3d95a2aSTobin C. Harding
20240a920b5bSAndy Whitcroftsub cat_vet {
20250a920b5bSAndy Whitcroft	my ($vet) = @_;
20269c0ca6f9SAndy Whitcroft	my ($res, $coded);
20270a920b5bSAndy Whitcroft
20289c0ca6f9SAndy Whitcroft	$res = '';
20296c72ffaaSAndy Whitcroft	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
20306c72ffaaSAndy Whitcroft		$res .= $1;
20316c72ffaaSAndy Whitcroft		if ($2 ne '') {
20329c0ca6f9SAndy Whitcroft			$coded = sprintf("^%c", unpack('C', $2) + 64);
20336c72ffaaSAndy Whitcroft			$res .= $coded;
20346c72ffaaSAndy Whitcroft		}
20359c0ca6f9SAndy Whitcroft	}
20369c0ca6f9SAndy Whitcroft	$res =~ s/$/\$/;
20370a920b5bSAndy Whitcroft
20389c0ca6f9SAndy Whitcroft	return $res;
20390a920b5bSAndy Whitcroft}
20400a920b5bSAndy Whitcroft
2041c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0;
2042cf655043SAndy Whitcroftmy $av_pending;
2043c2fdda0dSAndy Whitcroftmy @av_paren_type;
20441f65f947SAndy Whitcroftmy $av_pend_colon;
2045c2fdda0dSAndy Whitcroft
2046c2fdda0dSAndy Whitcroftsub annotate_reset {
2047c2fdda0dSAndy Whitcroft	$av_preprocessor = 0;
2048cf655043SAndy Whitcroft	$av_pending = '_';
2049cf655043SAndy Whitcroft	@av_paren_type = ('E');
20501f65f947SAndy Whitcroft	$av_pend_colon = 'O';
2051c2fdda0dSAndy Whitcroft}
2052c2fdda0dSAndy Whitcroft
20536c72ffaaSAndy Whitcroftsub annotate_values {
20546c72ffaaSAndy Whitcroft	my ($stream, $type) = @_;
20556c72ffaaSAndy Whitcroft
20566c72ffaaSAndy Whitcroft	my $res;
20571f65f947SAndy Whitcroft	my $var = '_' x length($stream);
20586c72ffaaSAndy Whitcroft	my $cur = $stream;
20596c72ffaaSAndy Whitcroft
2060c2fdda0dSAndy Whitcroft	print "$stream\n" if ($dbg_values > 1);
20616c72ffaaSAndy Whitcroft
20626c72ffaaSAndy Whitcroft	while (length($cur)) {
2063773647a0SAndy Whitcroft		@av_paren_type = ('E') if ($#av_paren_type < 0);
2064cf655043SAndy Whitcroft		print " <" . join('', @av_paren_type) .
2065171ae1a4SAndy Whitcroft				"> <$type> <$av_pending>" if ($dbg_values > 1);
20666c72ffaaSAndy Whitcroft		if ($cur =~ /^(\s+)/o) {
2067c2fdda0dSAndy Whitcroft			print "WS($1)\n" if ($dbg_values > 1);
2068c2fdda0dSAndy Whitcroft			if ($1 =~ /\n/ && $av_preprocessor) {
2069cf655043SAndy Whitcroft				$type = pop(@av_paren_type);
2070c2fdda0dSAndy Whitcroft				$av_preprocessor = 0;
20716c72ffaaSAndy Whitcroft			}
20726c72ffaaSAndy Whitcroft
2073c023e473SFlorian Mickler		} elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
20749446ef56SAndy Whitcroft			print "CAST($1)\n" if ($dbg_values > 1);
20759446ef56SAndy Whitcroft			push(@av_paren_type, $type);
2076addcdceaSAndy Whitcroft			$type = 'c';
20779446ef56SAndy Whitcroft
2078e91b6e26SAndy Whitcroft		} elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
2079c2fdda0dSAndy Whitcroft			print "DECLARE($1)\n" if ($dbg_values > 1);
20806c72ffaaSAndy Whitcroft			$type = 'T';
20816c72ffaaSAndy Whitcroft
2082389a2fe5SAndy Whitcroft		} elsif ($cur =~ /^($Modifier)\s*/) {
2083389a2fe5SAndy Whitcroft			print "MODIFIER($1)\n" if ($dbg_values > 1);
2084389a2fe5SAndy Whitcroft			$type = 'T';
2085389a2fe5SAndy Whitcroft
2086c45dcabdSAndy Whitcroft		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
2087171ae1a4SAndy Whitcroft			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
2088c2fdda0dSAndy Whitcroft			$av_preprocessor = 1;
2089171ae1a4SAndy Whitcroft			push(@av_paren_type, $type);
2090171ae1a4SAndy Whitcroft			if ($2 ne '') {
2091cf655043SAndy Whitcroft				$av_pending = 'N';
2092171ae1a4SAndy Whitcroft			}
2093171ae1a4SAndy Whitcroft			$type = 'E';
2094171ae1a4SAndy Whitcroft
2095c45dcabdSAndy Whitcroft		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
2096171ae1a4SAndy Whitcroft			print "UNDEF($1)\n" if ($dbg_values > 1);
2097171ae1a4SAndy Whitcroft			$av_preprocessor = 1;
2098171ae1a4SAndy Whitcroft			push(@av_paren_type, $type);
20996c72ffaaSAndy Whitcroft
2100c45dcabdSAndy Whitcroft		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
2101cf655043SAndy Whitcroft			print "PRE_START($1)\n" if ($dbg_values > 1);
2102c2fdda0dSAndy Whitcroft			$av_preprocessor = 1;
2103cf655043SAndy Whitcroft
2104cf655043SAndy Whitcroft			push(@av_paren_type, $type);
2105cf655043SAndy Whitcroft			push(@av_paren_type, $type);
2106171ae1a4SAndy Whitcroft			$type = 'E';
2107cf655043SAndy Whitcroft
2108c45dcabdSAndy Whitcroft		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
2109cf655043SAndy Whitcroft			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
2110cf655043SAndy Whitcroft			$av_preprocessor = 1;
2111cf655043SAndy Whitcroft
2112cf655043SAndy Whitcroft			push(@av_paren_type, $av_paren_type[$#av_paren_type]);
2113cf655043SAndy Whitcroft
2114171ae1a4SAndy Whitcroft			$type = 'E';
2115cf655043SAndy Whitcroft
2116c45dcabdSAndy Whitcroft		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
2117cf655043SAndy Whitcroft			print "PRE_END($1)\n" if ($dbg_values > 1);
2118cf655043SAndy Whitcroft
2119cf655043SAndy Whitcroft			$av_preprocessor = 1;
2120cf655043SAndy Whitcroft
2121cf655043SAndy Whitcroft			# Assume all arms of the conditional end as this
2122cf655043SAndy Whitcroft			# one does, and continue as if the #endif was not here.
2123cf655043SAndy Whitcroft			pop(@av_paren_type);
2124cf655043SAndy Whitcroft			push(@av_paren_type, $type);
2125171ae1a4SAndy Whitcroft			$type = 'E';
21266c72ffaaSAndy Whitcroft
21276c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^(\\\n)/o) {
2128c2fdda0dSAndy Whitcroft			print "PRECONT($1)\n" if ($dbg_values > 1);
21296c72ffaaSAndy Whitcroft
2130171ae1a4SAndy Whitcroft		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
2131171ae1a4SAndy Whitcroft			print "ATTR($1)\n" if ($dbg_values > 1);
2132171ae1a4SAndy Whitcroft			$av_pending = $type;
2133171ae1a4SAndy Whitcroft			$type = 'N';
2134171ae1a4SAndy Whitcroft
21356c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
2136c2fdda0dSAndy Whitcroft			print "SIZEOF($1)\n" if ($dbg_values > 1);
21376c72ffaaSAndy Whitcroft			if (defined $2) {
2138cf655043SAndy Whitcroft				$av_pending = 'V';
21396c72ffaaSAndy Whitcroft			}
21406c72ffaaSAndy Whitcroft			$type = 'N';
21416c72ffaaSAndy Whitcroft
214214b111c1SAndy Whitcroft		} elsif ($cur =~ /^(if|while|for)\b/o) {
2143c2fdda0dSAndy Whitcroft			print "COND($1)\n" if ($dbg_values > 1);
214414b111c1SAndy Whitcroft			$av_pending = 'E';
21456c72ffaaSAndy Whitcroft			$type = 'N';
21466c72ffaaSAndy Whitcroft
21471f65f947SAndy Whitcroft		} elsif ($cur =~/^(case)/o) {
21481f65f947SAndy Whitcroft			print "CASE($1)\n" if ($dbg_values > 1);
21491f65f947SAndy Whitcroft			$av_pend_colon = 'C';
21501f65f947SAndy Whitcroft			$type = 'N';
21511f65f947SAndy Whitcroft
215214b111c1SAndy Whitcroft		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
2153c2fdda0dSAndy Whitcroft			print "KEYWORD($1)\n" if ($dbg_values > 1);
21546c72ffaaSAndy Whitcroft			$type = 'N';
21556c72ffaaSAndy Whitcroft
21566c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^(\()/o) {
2157c2fdda0dSAndy Whitcroft			print "PAREN('$1')\n" if ($dbg_values > 1);
2158cf655043SAndy Whitcroft			push(@av_paren_type, $av_pending);
2159cf655043SAndy Whitcroft			$av_pending = '_';
21606c72ffaaSAndy Whitcroft			$type = 'N';
21616c72ffaaSAndy Whitcroft
21626c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^(\))/o) {
2163cf655043SAndy Whitcroft			my $new_type = pop(@av_paren_type);
2164cf655043SAndy Whitcroft			if ($new_type ne '_') {
2165cf655043SAndy Whitcroft				$type = $new_type;
2166c2fdda0dSAndy Whitcroft				print "PAREN('$1') -> $type\n"
2167c2fdda0dSAndy Whitcroft							if ($dbg_values > 1);
21686c72ffaaSAndy Whitcroft			} else {
2169c2fdda0dSAndy Whitcroft				print "PAREN('$1')\n" if ($dbg_values > 1);
21706c72ffaaSAndy Whitcroft			}
21716c72ffaaSAndy Whitcroft
2172c8cb2ca3SAndy Whitcroft		} elsif ($cur =~ /^($Ident)\s*\(/o) {
2173c2fdda0dSAndy Whitcroft			print "FUNC($1)\n" if ($dbg_values > 1);
2174c8cb2ca3SAndy Whitcroft			$type = 'V';
2175cf655043SAndy Whitcroft			$av_pending = 'V';
21766c72ffaaSAndy Whitcroft
21778e761b04SAndy Whitcroft		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
21788e761b04SAndy Whitcroft			if (defined $2 && $type eq 'C' || $type eq 'T') {
21791f65f947SAndy Whitcroft				$av_pend_colon = 'B';
21808e761b04SAndy Whitcroft			} elsif ($type eq 'E') {
21818e761b04SAndy Whitcroft				$av_pend_colon = 'L';
21821f65f947SAndy Whitcroft			}
21831f65f947SAndy Whitcroft			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
21841f65f947SAndy Whitcroft			$type = 'V';
21851f65f947SAndy Whitcroft
21866c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^($Ident|$Constant)/o) {
2187c2fdda0dSAndy Whitcroft			print "IDENT($1)\n" if ($dbg_values > 1);
21886c72ffaaSAndy Whitcroft			$type = 'V';
21896c72ffaaSAndy Whitcroft
21906c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^($Assignment)/o) {
2191c2fdda0dSAndy Whitcroft			print "ASSIGN($1)\n" if ($dbg_values > 1);
21926c72ffaaSAndy Whitcroft			$type = 'N';
21936c72ffaaSAndy Whitcroft
2194cf655043SAndy Whitcroft		} elsif ($cur =~/^(;|{|})/) {
2195c2fdda0dSAndy Whitcroft			print "END($1)\n" if ($dbg_values > 1);
219613214adfSAndy Whitcroft			$type = 'E';
21971f65f947SAndy Whitcroft			$av_pend_colon = 'O';
219813214adfSAndy Whitcroft
21998e761b04SAndy Whitcroft		} elsif ($cur =~/^(,)/) {
22008e761b04SAndy Whitcroft			print "COMMA($1)\n" if ($dbg_values > 1);
22018e761b04SAndy Whitcroft			$type = 'C';
22028e761b04SAndy Whitcroft
22031f65f947SAndy Whitcroft		} elsif ($cur =~ /^(\?)/o) {
22041f65f947SAndy Whitcroft			print "QUESTION($1)\n" if ($dbg_values > 1);
22051f65f947SAndy Whitcroft			$type = 'N';
22061f65f947SAndy Whitcroft
22071f65f947SAndy Whitcroft		} elsif ($cur =~ /^(:)/o) {
22081f65f947SAndy Whitcroft			print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
22091f65f947SAndy Whitcroft
22101f65f947SAndy Whitcroft			substr($var, length($res), 1, $av_pend_colon);
22111f65f947SAndy Whitcroft			if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
22121f65f947SAndy Whitcroft				$type = 'E';
22131f65f947SAndy Whitcroft			} else {
22141f65f947SAndy Whitcroft				$type = 'N';
22151f65f947SAndy Whitcroft			}
22161f65f947SAndy Whitcroft			$av_pend_colon = 'O';
22171f65f947SAndy Whitcroft
22188e761b04SAndy Whitcroft		} elsif ($cur =~ /^(\[)/o) {
221913214adfSAndy Whitcroft			print "CLOSE($1)\n" if ($dbg_values > 1);
22206c72ffaaSAndy Whitcroft			$type = 'N';
22216c72ffaaSAndy Whitcroft
22220d413866SAndy Whitcroft		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
222374048ed8SAndy Whitcroft			my $variant;
222474048ed8SAndy Whitcroft
222574048ed8SAndy Whitcroft			print "OPV($1)\n" if ($dbg_values > 1);
222674048ed8SAndy Whitcroft			if ($type eq 'V') {
222774048ed8SAndy Whitcroft				$variant = 'B';
222874048ed8SAndy Whitcroft			} else {
222974048ed8SAndy Whitcroft				$variant = 'U';
223074048ed8SAndy Whitcroft			}
223174048ed8SAndy Whitcroft
223274048ed8SAndy Whitcroft			substr($var, length($res), 1, $variant);
223374048ed8SAndy Whitcroft			$type = 'N';
223474048ed8SAndy Whitcroft
22356c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^($Operators)/o) {
2236c2fdda0dSAndy Whitcroft			print "OP($1)\n" if ($dbg_values > 1);
22376c72ffaaSAndy Whitcroft			if ($1 ne '++' && $1 ne '--') {
22386c72ffaaSAndy Whitcroft				$type = 'N';
22396c72ffaaSAndy Whitcroft			}
22406c72ffaaSAndy Whitcroft
22416c72ffaaSAndy Whitcroft		} elsif ($cur =~ /(^.)/o) {
2242c2fdda0dSAndy Whitcroft			print "C($1)\n" if ($dbg_values > 1);
22436c72ffaaSAndy Whitcroft		}
22446c72ffaaSAndy Whitcroft		if (defined $1) {
22456c72ffaaSAndy Whitcroft			$cur = substr($cur, length($1));
22466c72ffaaSAndy Whitcroft			$res .= $type x length($1);
22476c72ffaaSAndy Whitcroft		}
22486c72ffaaSAndy Whitcroft	}
22496c72ffaaSAndy Whitcroft
22501f65f947SAndy Whitcroft	return ($res, $var);
22516c72ffaaSAndy Whitcroft}
22526c72ffaaSAndy Whitcroft
22538905a67cSAndy Whitcroftsub possible {
225413214adfSAndy Whitcroft	my ($possible, $line) = @_;
22559a974fdbSAndy Whitcroft	my $notPermitted = qr{(?:
22560776e594SAndy Whitcroft		^(?:
22570776e594SAndy Whitcroft			$Modifier|
22580776e594SAndy Whitcroft			$Storage|
22590776e594SAndy Whitcroft			$Type|
22609a974fdbSAndy Whitcroft			DEFINE_\S+
22619a974fdbSAndy Whitcroft		)$|
22629a974fdbSAndy Whitcroft		^(?:
22630776e594SAndy Whitcroft			goto|
22640776e594SAndy Whitcroft			return|
22650776e594SAndy Whitcroft			case|
22660776e594SAndy Whitcroft			else|
22670776e594SAndy Whitcroft			asm|__asm__|
226889a88353SAndy Whitcroft			do|
226989a88353SAndy Whitcroft			\#|
227089a88353SAndy Whitcroft			\#\#|
22719a974fdbSAndy Whitcroft		)(?:\s|$)|
22720776e594SAndy Whitcroft		^(?:typedef|struct|enum)\b
22739a974fdbSAndy Whitcroft	    )}x;
22749a974fdbSAndy Whitcroft	warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
22759a974fdbSAndy Whitcroft	if ($possible !~ $notPermitted) {
2276c45dcabdSAndy Whitcroft		# Check for modifiers.
2277c45dcabdSAndy Whitcroft		$possible =~ s/\s*$Storage\s*//g;
2278c45dcabdSAndy Whitcroft		$possible =~ s/\s*$Sparse\s*//g;
2279c45dcabdSAndy Whitcroft		if ($possible =~ /^\s*$/) {
2280c45dcabdSAndy Whitcroft
2281c45dcabdSAndy Whitcroft		} elsif ($possible =~ /\s/) {
2282c45dcabdSAndy Whitcroft			$possible =~ s/\s*$Type\s*//g;
2283d2506586SAndy Whitcroft			for my $modifier (split(' ', $possible)) {
22849a974fdbSAndy Whitcroft				if ($modifier !~ $notPermitted) {
2285d2506586SAndy Whitcroft					warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
2286485ff23eSAlex Dowad					push(@modifierListFile, $modifier);
2287d2506586SAndy Whitcroft				}
22889a974fdbSAndy Whitcroft			}
2289c45dcabdSAndy Whitcroft
2290c45dcabdSAndy Whitcroft		} else {
229113214adfSAndy Whitcroft			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
2292485ff23eSAlex Dowad			push(@typeListFile, $possible);
2293c45dcabdSAndy Whitcroft		}
22948905a67cSAndy Whitcroft		build_types();
22950776e594SAndy Whitcroft	} else {
22960776e594SAndy Whitcroft		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
22978905a67cSAndy Whitcroft	}
22988905a67cSAndy Whitcroft}
22998905a67cSAndy Whitcroft
23006c72ffaaSAndy Whitcroftmy $prefix = '';
23016c72ffaaSAndy Whitcroft
2302000d1cc1SJoe Perchessub show_type {
2303cbec18afSJoe Perches	my ($type) = @_;
230491bfe484SJoe Perches
2305522b837cSAlexey Dobriyan	$type =~ tr/[a-z]/[A-Z]/;
2306522b837cSAlexey Dobriyan
2307cbec18afSJoe Perches	return defined $use_type{$type} if (scalar keys %use_type > 0);
2308cbec18afSJoe Perches
2309cbec18afSJoe Perches	return !defined $ignore_type{$type};
2310000d1cc1SJoe Perches}
2311000d1cc1SJoe Perches
2312f0a594c1SAndy Whitcroftsub report {
2313cbec18afSJoe Perches	my ($level, $type, $msg) = @_;
2314cbec18afSJoe Perches
2315cbec18afSJoe Perches	if (!show_type($type) ||
2316cbec18afSJoe Perches	    (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
2317773647a0SAndy Whitcroft		return 0;
2318773647a0SAndy Whitcroft	}
231957230297SJoe Perches	my $output = '';
2320737c0767SJohn Brooks	if ($color) {
232157230297SJoe Perches		if ($level eq 'ERROR') {
232257230297SJoe Perches			$output .= RED;
232357230297SJoe Perches		} elsif ($level eq 'WARNING') {
232457230297SJoe Perches			$output .= YELLOW;
2325000d1cc1SJoe Perches		} else {
232657230297SJoe Perches			$output .= GREEN;
2327000d1cc1SJoe Perches		}
232857230297SJoe Perches	}
232957230297SJoe Perches	$output .= $prefix . $level . ':';
233057230297SJoe Perches	if ($show_types) {
2331737c0767SJohn Brooks		$output .= BLUE if ($color);
233257230297SJoe Perches		$output .= "$type:";
233357230297SJoe Perches	}
2334737c0767SJohn Brooks	$output .= RESET if ($color);
233557230297SJoe Perches	$output .= ' ' . $msg . "\n";
233634d8815fSJoe Perches
233734d8815fSJoe Perches	if ($showfile) {
233834d8815fSJoe Perches		my @lines = split("\n", $output, -1);
233934d8815fSJoe Perches		splice(@lines, 1, 1);
234034d8815fSJoe Perches		$output = join("\n", @lines);
234134d8815fSJoe Perches	}
234252178ce0SDwaipayan Ray
234352178ce0SDwaipayan Ray	if ($terse) {
234452178ce0SDwaipayan Ray		$output = (split('\n', $output))[0] . "\n";
234552178ce0SDwaipayan Ray	}
234652178ce0SDwaipayan Ray
234752178ce0SDwaipayan Ray	if ($verbose && exists($verbose_messages{$type}) &&
234852178ce0SDwaipayan Ray	    !exists($verbose_emitted{$type})) {
234952178ce0SDwaipayan Ray		$output .= $verbose_messages{$type} . "\n\n";
235052178ce0SDwaipayan Ray		$verbose_emitted{$type} = 1;
235152178ce0SDwaipayan Ray	}
23528905a67cSAndy Whitcroft
235357230297SJoe Perches	push(our @report, $output);
2354773647a0SAndy Whitcroft
2355773647a0SAndy Whitcroft	return 1;
2356f0a594c1SAndy Whitcroft}
2357cbec18afSJoe Perches
2358f0a594c1SAndy Whitcroftsub report_dump {
235913214adfSAndy Whitcroft	our @report;
2360f0a594c1SAndy Whitcroft}
2361000d1cc1SJoe Perches
2362d752fcc8SJoe Perchessub fixup_current_range {
2363d752fcc8SJoe Perches	my ($lineRef, $offset, $length) = @_;
2364d752fcc8SJoe Perches
2365d752fcc8SJoe Perches	if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
2366d752fcc8SJoe Perches		my $o = $1;
2367d752fcc8SJoe Perches		my $l = $2;
2368d752fcc8SJoe Perches		my $no = $o + $offset;
2369d752fcc8SJoe Perches		my $nl = $l + $length;
2370d752fcc8SJoe Perches		$$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
2371d752fcc8SJoe Perches	}
2372d752fcc8SJoe Perches}
2373d752fcc8SJoe Perches
2374d752fcc8SJoe Perchessub fix_inserted_deleted_lines {
2375d752fcc8SJoe Perches	my ($linesRef, $insertedRef, $deletedRef) = @_;
2376d752fcc8SJoe Perches
2377d752fcc8SJoe Perches	my $range_last_linenr = 0;
2378d752fcc8SJoe Perches	my $delta_offset = 0;
2379d752fcc8SJoe Perches
2380d752fcc8SJoe Perches	my $old_linenr = 0;
2381d752fcc8SJoe Perches	my $new_linenr = 0;
2382d752fcc8SJoe Perches
2383d752fcc8SJoe Perches	my $next_insert = 0;
2384d752fcc8SJoe Perches	my $next_delete = 0;
2385d752fcc8SJoe Perches
2386d752fcc8SJoe Perches	my @lines = ();
2387d752fcc8SJoe Perches
2388d752fcc8SJoe Perches	my $inserted = @{$insertedRef}[$next_insert++];
2389d752fcc8SJoe Perches	my $deleted = @{$deletedRef}[$next_delete++];
2390d752fcc8SJoe Perches
2391d752fcc8SJoe Perches	foreach my $old_line (@{$linesRef}) {
2392d752fcc8SJoe Perches		my $save_line = 1;
2393d752fcc8SJoe Perches		my $line = $old_line;	#don't modify the array
2394323b267fSJoe Perches		if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) {	#new filename
2395d752fcc8SJoe Perches			$delta_offset = 0;
2396d752fcc8SJoe Perches		} elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) {	#new hunk
2397d752fcc8SJoe Perches			$range_last_linenr = $new_linenr;
2398d752fcc8SJoe Perches			fixup_current_range(\$line, $delta_offset, 0);
2399d752fcc8SJoe Perches		}
2400d752fcc8SJoe Perches
2401d752fcc8SJoe Perches		while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2402d752fcc8SJoe Perches			$deleted = @{$deletedRef}[$next_delete++];
2403d752fcc8SJoe Perches			$save_line = 0;
2404d752fcc8SJoe Perches			fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2405d752fcc8SJoe Perches		}
2406d752fcc8SJoe Perches
2407d752fcc8SJoe Perches		while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2408d752fcc8SJoe Perches			push(@lines, ${$inserted}{'LINE'});
2409d752fcc8SJoe Perches			$inserted = @{$insertedRef}[$next_insert++];
2410d752fcc8SJoe Perches			$new_linenr++;
2411d752fcc8SJoe Perches			fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2412d752fcc8SJoe Perches		}
2413d752fcc8SJoe Perches
2414d752fcc8SJoe Perches		if ($save_line) {
2415d752fcc8SJoe Perches			push(@lines, $line);
2416d752fcc8SJoe Perches			$new_linenr++;
2417d752fcc8SJoe Perches		}
2418d752fcc8SJoe Perches
2419d752fcc8SJoe Perches		$old_linenr++;
2420d752fcc8SJoe Perches	}
2421d752fcc8SJoe Perches
2422d752fcc8SJoe Perches	return @lines;
2423d752fcc8SJoe Perches}
2424d752fcc8SJoe Perches
2425f2d7e4d4SJoe Perchessub fix_insert_line {
2426f2d7e4d4SJoe Perches	my ($linenr, $line) = @_;
2427f2d7e4d4SJoe Perches
2428f2d7e4d4SJoe Perches	my $inserted = {
2429f2d7e4d4SJoe Perches		LINENR => $linenr,
2430f2d7e4d4SJoe Perches		LINE => $line,
2431f2d7e4d4SJoe Perches	};
2432f2d7e4d4SJoe Perches	push(@fixed_inserted, $inserted);
2433f2d7e4d4SJoe Perches}
2434f2d7e4d4SJoe Perches
2435f2d7e4d4SJoe Perchessub fix_delete_line {
2436f2d7e4d4SJoe Perches	my ($linenr, $line) = @_;
2437f2d7e4d4SJoe Perches
2438f2d7e4d4SJoe Perches	my $deleted = {
2439f2d7e4d4SJoe Perches		LINENR => $linenr,
2440f2d7e4d4SJoe Perches		LINE => $line,
2441f2d7e4d4SJoe Perches	};
2442f2d7e4d4SJoe Perches
2443f2d7e4d4SJoe Perches	push(@fixed_deleted, $deleted);
2444f2d7e4d4SJoe Perches}
2445f2d7e4d4SJoe Perches
2446de7d4f0eSAndy Whitcroftsub ERROR {
2447cbec18afSJoe Perches	my ($type, $msg) = @_;
2448cbec18afSJoe Perches
2449cbec18afSJoe Perches	if (report("ERROR", $type, $msg)) {
2450de7d4f0eSAndy Whitcroft		our $clean = 0;
24516c72ffaaSAndy Whitcroft		our $cnt_error++;
24523705ce5bSJoe Perches		return 1;
2453de7d4f0eSAndy Whitcroft	}
24543705ce5bSJoe Perches	return 0;
2455773647a0SAndy Whitcroft}
2456de7d4f0eSAndy Whitcroftsub WARN {
2457cbec18afSJoe Perches	my ($type, $msg) = @_;
2458cbec18afSJoe Perches
2459cbec18afSJoe Perches	if (report("WARNING", $type, $msg)) {
2460de7d4f0eSAndy Whitcroft		our $clean = 0;
24616c72ffaaSAndy Whitcroft		our $cnt_warn++;
24623705ce5bSJoe Perches		return 1;
2463de7d4f0eSAndy Whitcroft	}
24643705ce5bSJoe Perches	return 0;
2465773647a0SAndy Whitcroft}
2466de7d4f0eSAndy Whitcroftsub CHK {
2467cbec18afSJoe Perches	my ($type, $msg) = @_;
2468cbec18afSJoe Perches
2469cbec18afSJoe Perches	if ($check && report("CHECK", $type, $msg)) {
2470de7d4f0eSAndy Whitcroft		our $clean = 0;
24716c72ffaaSAndy Whitcroft		our $cnt_chk++;
24723705ce5bSJoe Perches		return 1;
24736c72ffaaSAndy Whitcroft	}
24743705ce5bSJoe Perches	return 0;
2475de7d4f0eSAndy Whitcroft}
2476de7d4f0eSAndy Whitcroft
24776ecd9674SAndy Whitcroftsub check_absolute_file {
24786ecd9674SAndy Whitcroft	my ($absolute, $herecurr) = @_;
24796ecd9674SAndy Whitcroft	my $file = $absolute;
24806ecd9674SAndy Whitcroft
24816ecd9674SAndy Whitcroft	##print "absolute<$absolute>\n";
24826ecd9674SAndy Whitcroft
24836ecd9674SAndy Whitcroft	# See if any suffix of this path is a path within the tree.
24846ecd9674SAndy Whitcroft	while ($file =~ s@^[^/]*/@@) {
24856ecd9674SAndy Whitcroft		if (-f "$root/$file") {
24866ecd9674SAndy Whitcroft			##print "file<$file>\n";
24876ecd9674SAndy Whitcroft			last;
24886ecd9674SAndy Whitcroft		}
24896ecd9674SAndy Whitcroft	}
24906ecd9674SAndy Whitcroft	if (! -f _)  {
24916ecd9674SAndy Whitcroft		return 0;
24926ecd9674SAndy Whitcroft	}
24936ecd9674SAndy Whitcroft
24946ecd9674SAndy Whitcroft	# It is, so see if the prefix is acceptable.
24956ecd9674SAndy Whitcroft	my $prefix = $absolute;
24966ecd9674SAndy Whitcroft	substr($prefix, -length($file)) = '';
24976ecd9674SAndy Whitcroft
24986ecd9674SAndy Whitcroft	##print "prefix<$prefix>\n";
24996ecd9674SAndy Whitcroft	if ($prefix ne ".../") {
2500000d1cc1SJoe Perches		WARN("USE_RELATIVE_PATH",
2501000d1cc1SJoe Perches		     "use relative pathname instead of absolute in changelog text\n" . $herecurr);
25026ecd9674SAndy Whitcroft	}
25036ecd9674SAndy Whitcroft}
25046ecd9674SAndy Whitcroft
25053705ce5bSJoe Perchessub trim {
25063705ce5bSJoe Perches	my ($string) = @_;
25073705ce5bSJoe Perches
2508b34c648bSJoe Perches	$string =~ s/^\s+|\s+$//g;
2509b34c648bSJoe Perches
2510b34c648bSJoe Perches	return $string;
2511b34c648bSJoe Perches}
2512b34c648bSJoe Perches
2513b34c648bSJoe Perchessub ltrim {
2514b34c648bSJoe Perches	my ($string) = @_;
2515b34c648bSJoe Perches
2516b34c648bSJoe Perches	$string =~ s/^\s+//;
2517b34c648bSJoe Perches
2518b34c648bSJoe Perches	return $string;
2519b34c648bSJoe Perches}
2520b34c648bSJoe Perches
2521b34c648bSJoe Perchessub rtrim {
2522b34c648bSJoe Perches	my ($string) = @_;
2523b34c648bSJoe Perches
2524b34c648bSJoe Perches	$string =~ s/\s+$//;
25253705ce5bSJoe Perches
25263705ce5bSJoe Perches	return $string;
25273705ce5bSJoe Perches}
25283705ce5bSJoe Perches
252952ea8506SJoe Perchessub string_find_replace {
253052ea8506SJoe Perches	my ($string, $find, $replace) = @_;
253152ea8506SJoe Perches
253252ea8506SJoe Perches	$string =~ s/$find/$replace/g;
253352ea8506SJoe Perches
253452ea8506SJoe Perches	return $string;
253552ea8506SJoe Perches}
253652ea8506SJoe Perches
25373705ce5bSJoe Perchessub tabify {
25383705ce5bSJoe Perches	my ($leading) = @_;
25393705ce5bSJoe Perches
2540713a09deSAntonio Borneo	my $source_indent = $tabsize;
25413705ce5bSJoe Perches	my $max_spaces_before_tab = $source_indent - 1;
25423705ce5bSJoe Perches	my $spaces_to_tab = " " x $source_indent;
25433705ce5bSJoe Perches
25443705ce5bSJoe Perches	#convert leading spaces to tabs
25453705ce5bSJoe Perches	1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
25463705ce5bSJoe Perches	#Remove spaces before a tab
25473705ce5bSJoe Perches	1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
25483705ce5bSJoe Perches
25493705ce5bSJoe Perches	return "$leading";
25503705ce5bSJoe Perches}
25513705ce5bSJoe Perches
2552d1fe9c09SJoe Perchessub pos_last_openparen {
2553d1fe9c09SJoe Perches	my ($line) = @_;
2554d1fe9c09SJoe Perches
2555d1fe9c09SJoe Perches	my $pos = 0;
2556d1fe9c09SJoe Perches
2557d1fe9c09SJoe Perches	my $opens = $line =~ tr/\(/\(/;
2558d1fe9c09SJoe Perches	my $closes = $line =~ tr/\)/\)/;
2559d1fe9c09SJoe Perches
2560d1fe9c09SJoe Perches	my $last_openparen = 0;
2561d1fe9c09SJoe Perches
2562d1fe9c09SJoe Perches	if (($opens == 0) || ($closes >= $opens)) {
2563d1fe9c09SJoe Perches		return -1;
2564d1fe9c09SJoe Perches	}
2565d1fe9c09SJoe Perches
2566d1fe9c09SJoe Perches	my $len = length($line);
2567d1fe9c09SJoe Perches
2568d1fe9c09SJoe Perches	for ($pos = 0; $pos < $len; $pos++) {
2569d1fe9c09SJoe Perches		my $string = substr($line, $pos);
2570d1fe9c09SJoe Perches		if ($string =~ /^($FuncArg|$balanced_parens)/) {
2571d1fe9c09SJoe Perches			$pos += length($1) - 1;
2572d1fe9c09SJoe Perches		} elsif (substr($line, $pos, 1) eq '(') {
2573d1fe9c09SJoe Perches			$last_openparen = $pos;
2574d1fe9c09SJoe Perches		} elsif (index($string, '(') == -1) {
2575d1fe9c09SJoe Perches			last;
2576d1fe9c09SJoe Perches		}
2577d1fe9c09SJoe Perches	}
2578d1fe9c09SJoe Perches
257991cb5195SJoe Perches	return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
2580d1fe9c09SJoe Perches}
2581d1fe9c09SJoe Perches
2582f36d3eb8SJoe Perchessub get_raw_comment {
2583f36d3eb8SJoe Perches	my ($line, $rawline) = @_;
2584f36d3eb8SJoe Perches	my $comment = '';
2585f36d3eb8SJoe Perches
2586f36d3eb8SJoe Perches	for my $i (0 .. (length($line) - 1)) {
2587f36d3eb8SJoe Perches		if (substr($line, $i, 1) eq "$;") {
2588f36d3eb8SJoe Perches			$comment .= substr($rawline, $i, 1);
2589f36d3eb8SJoe Perches		}
2590f36d3eb8SJoe Perches	}
2591f36d3eb8SJoe Perches
2592f36d3eb8SJoe Perches	return $comment;
2593f36d3eb8SJoe Perches}
2594f36d3eb8SJoe Perches
25955b8f82e1SSong Liusub exclude_global_initialisers {
25965b8f82e1SSong Liu	my ($realfile) = @_;
25975b8f82e1SSong Liu
25985b8f82e1SSong Liu	# Do not check for BPF programs (tools/testing/selftests/bpf/progs/*.c, samples/bpf/*_kern.c, *.bpf.c).
25995b8f82e1SSong Liu	return $realfile =~ m@^tools/testing/selftests/bpf/progs/.*\.c$@ ||
26005b8f82e1SSong Liu		$realfile =~ m@^samples/bpf/.*_kern\.c$@ ||
26015b8f82e1SSong Liu		$realfile =~ m@/bpf/.*\.bpf\.c$@;
26025b8f82e1SSong Liu}
26035b8f82e1SSong Liu
26040a920b5bSAndy Whitcroftsub process {
26050a920b5bSAndy Whitcroft	my $filename = shift;
26060a920b5bSAndy Whitcroft
26070a920b5bSAndy Whitcroft	my $linenr=0;
26080a920b5bSAndy Whitcroft	my $prevline="";
2609c2fdda0dSAndy Whitcroft	my $prevrawline="";
26100a920b5bSAndy Whitcroft	my $stashline="";
2611c2fdda0dSAndy Whitcroft	my $stashrawline="";
26120a920b5bSAndy Whitcroft
26134a0df2efSAndy Whitcroft	my $length;
26140a920b5bSAndy Whitcroft	my $indent;
26150a920b5bSAndy Whitcroft	my $previndent=0;
26160a920b5bSAndy Whitcroft	my $stashindent=0;
26170a920b5bSAndy Whitcroft
2618de7d4f0eSAndy Whitcroft	our $clean = 1;
26190a920b5bSAndy Whitcroft	my $signoff = 0;
2620cd261496SGeert Uytterhoeven	my $author = '';
2621cd261496SGeert Uytterhoeven	my $authorsignoff = 0;
262248ca2d8aSDwaipayan Ray	my $author_sob = '';
26230a920b5bSAndy Whitcroft	my $is_patch = 0;
2624133712a2SRob Herring	my $is_binding_patch = -1;
262529ee1b0cSJoe Perches	my $in_header_lines = $file ? 0 : 1;
262615662b3eSJoe Perches	my $in_commit_log = 0;		#Scanning lines before patch
262744d303ebSJoe Perches	my $has_patch_separator = 0;	#Found a --- line
2628ed43c4e5SAllen Hubbe	my $has_commit_log = 0;		#Encountered lines before patch
2629490b292cSJoe Perches	my $commit_log_lines = 0;	#Number of commit log lines
2630bf4daf12SJoe Perches	my $commit_log_possible_stack_dump = 0;
26312a076f40SJoe Perches	my $commit_log_long_line = 0;
2632e518e9a5SJoe Perches	my $commit_log_has_diff = 0;
263313f1937eSJoe Perches	my $reported_maintainer_file = 0;
2634fa64205dSPasi Savanainen	my $non_utf8_charset = 0;
2635fa64205dSPasi Savanainen
26364ce9f970SJoe Perches	my $last_git_commit_id_linenr = -1;
26374ce9f970SJoe Perches
2638365dd4eaSJoe Perches	my $last_blank_line = 0;
26395e4f6ba5SJoe Perches	my $last_coalesced_string_linenr = -1;
2640365dd4eaSJoe Perches
264113214adfSAndy Whitcroft	our @report = ();
26426c72ffaaSAndy Whitcroft	our $cnt_lines = 0;
26436c72ffaaSAndy Whitcroft	our $cnt_error = 0;
26446c72ffaaSAndy Whitcroft	our $cnt_warn = 0;
26456c72ffaaSAndy Whitcroft	our $cnt_chk = 0;
26466c72ffaaSAndy Whitcroft
26470a920b5bSAndy Whitcroft	# Trace the real file/line as we go.
26480a920b5bSAndy Whitcroft	my $realfile = '';
26490a920b5bSAndy Whitcroft	my $realline = 0;
26500a920b5bSAndy Whitcroft	my $realcnt = 0;
26510a920b5bSAndy Whitcroft	my $here = '';
265277cb8546SJoe Perches	my $context_function;		#undef'd unless there's a known function
26530a920b5bSAndy Whitcroft	my $in_comment = 0;
2654c2fdda0dSAndy Whitcroft	my $comment_edge = 0;
26550a920b5bSAndy Whitcroft	my $first_line = 0;
26561e855726SWolfram Sang	my $p1_prefix = '';
26570a920b5bSAndy Whitcroft
265813214adfSAndy Whitcroft	my $prev_values = 'E';
265913214adfSAndy Whitcroft
266013214adfSAndy Whitcroft	# suppression flags
2661773647a0SAndy Whitcroft	my %suppress_ifbraces;
2662170d3a22SAndy Whitcroft	my %suppress_whiletrailers;
26632b474a1aSAndy Whitcroft	my %suppress_export;
26643e469cdcSAndy Whitcroft	my $suppress_statement = 0;
2665653d4876SAndy Whitcroft
26667e51f197SJoe Perches	my %signatures = ();
2667323c1260SJoe Perches
2668c2fdda0dSAndy Whitcroft	# Pre-scan the patch sanitizing the lines.
2669de7d4f0eSAndy Whitcroft	# Pre-scan the patch looking for any __setup documentation.
2670c2fdda0dSAndy Whitcroft	#
2671de7d4f0eSAndy Whitcroft	my @setup_docs = ();
2672de7d4f0eSAndy Whitcroft	my $setup_docs = 0;
2673773647a0SAndy Whitcroft
2674d8b07710SJoe Perches	my $camelcase_file_seeded = 0;
2675d8b07710SJoe Perches
26769f3a8992SRob Herring	my $checklicenseline = 1;
26779f3a8992SRob Herring
2678773647a0SAndy Whitcroft	sanitise_line_reset();
2679c2fdda0dSAndy Whitcroft	my $line;
2680c2fdda0dSAndy Whitcroft	foreach my $rawline (@rawlines) {
2681773647a0SAndy Whitcroft		$linenr++;
2682773647a0SAndy Whitcroft		$line = $rawline;
2683c2fdda0dSAndy Whitcroft
26843705ce5bSJoe Perches		push(@fixed, $rawline) if ($fix);
26853705ce5bSJoe Perches
2686773647a0SAndy Whitcroft		if ($rawline=~/^\+\+\+\s+(\S+)/) {
2687de7d4f0eSAndy Whitcroft			$setup_docs = 0;
26882581ac7cSTim Froidcoeur			if ($1 =~ m@Documentation/admin-guide/kernel-parameters.txt$@) {
2689de7d4f0eSAndy Whitcroft				$setup_docs = 1;
2690de7d4f0eSAndy Whitcroft			}
2691773647a0SAndy Whitcroft			#next;
2692de7d4f0eSAndy Whitcroft		}
269374fd4f34SJoe Perches		if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2694773647a0SAndy Whitcroft			$realline=$1-1;
2695773647a0SAndy Whitcroft			if (defined $2) {
2696773647a0SAndy Whitcroft				$realcnt=$3+1;
2697773647a0SAndy Whitcroft			} else {
2698773647a0SAndy Whitcroft				$realcnt=1+1;
2699773647a0SAndy Whitcroft			}
2700c45dcabdSAndy Whitcroft			$in_comment = 0;
2701773647a0SAndy Whitcroft
2702773647a0SAndy Whitcroft			# Guestimate if this is a continuing comment.  Run
2703773647a0SAndy Whitcroft			# the context looking for a comment "edge".  If this
2704773647a0SAndy Whitcroft			# edge is a close comment then we must be in a comment
2705773647a0SAndy Whitcroft			# at context start.
2706773647a0SAndy Whitcroft			my $edge;
270701fa9147SAndy Whitcroft			my $cnt = $realcnt;
270801fa9147SAndy Whitcroft			for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
270901fa9147SAndy Whitcroft				next if (defined $rawlines[$ln - 1] &&
271001fa9147SAndy Whitcroft					 $rawlines[$ln - 1] =~ /^-/);
271101fa9147SAndy Whitcroft				$cnt--;
271201fa9147SAndy Whitcroft				#print "RAW<$rawlines[$ln - 1]>\n";
2713721c1cb6SAndy Whitcroft				last if (!defined $rawlines[$ln - 1]);
2714fae17daeSAndy Whitcroft				if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2715fae17daeSAndy Whitcroft				    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2716fae17daeSAndy Whitcroft					($edge) = $1;
2717fae17daeSAndy Whitcroft					last;
2718fae17daeSAndy Whitcroft				}
2719773647a0SAndy Whitcroft			}
2720773647a0SAndy Whitcroft			if (defined $edge && $edge eq '*/') {
2721773647a0SAndy Whitcroft				$in_comment = 1;
2722773647a0SAndy Whitcroft			}
2723773647a0SAndy Whitcroft
2724773647a0SAndy Whitcroft			# Guestimate if this is a continuing comment.  If this
2725773647a0SAndy Whitcroft			# is the start of a diff block and this line starts
2726773647a0SAndy Whitcroft			# ' *' then it is very likely a comment.
2727773647a0SAndy Whitcroft			if (!defined $edge &&
272883242e0cSAndy Whitcroft			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
2729773647a0SAndy Whitcroft			{
2730773647a0SAndy Whitcroft				$in_comment = 1;
2731773647a0SAndy Whitcroft			}
2732773647a0SAndy Whitcroft
2733773647a0SAndy Whitcroft			##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2734773647a0SAndy Whitcroft			sanitise_line_reset($in_comment);
2735773647a0SAndy Whitcroft
2736171ae1a4SAndy Whitcroft		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2737773647a0SAndy Whitcroft			# Standardise the strings and chars within the input to
2738171ae1a4SAndy Whitcroft			# simplify matching -- only bother with positive lines.
2739773647a0SAndy Whitcroft			$line = sanitise_line($rawline);
2740773647a0SAndy Whitcroft		}
2741773647a0SAndy Whitcroft		push(@lines, $line);
2742773647a0SAndy Whitcroft
2743773647a0SAndy Whitcroft		if ($realcnt > 1) {
2744773647a0SAndy Whitcroft			$realcnt-- if ($line =~ /^(?:\+| |$)/);
2745773647a0SAndy Whitcroft		} else {
2746773647a0SAndy Whitcroft			$realcnt = 0;
2747773647a0SAndy Whitcroft		}
2748773647a0SAndy Whitcroft
2749773647a0SAndy Whitcroft		#print "==>$rawline\n";
2750773647a0SAndy Whitcroft		#print "-->$line\n";
2751de7d4f0eSAndy Whitcroft
2752de7d4f0eSAndy Whitcroft		if ($setup_docs && $line =~ /^\+/) {
2753de7d4f0eSAndy Whitcroft			push(@setup_docs, $line);
2754de7d4f0eSAndy Whitcroft		}
2755de7d4f0eSAndy Whitcroft	}
2756de7d4f0eSAndy Whitcroft
27576c72ffaaSAndy Whitcroft	$prefix = '';
27586c72ffaaSAndy Whitcroft
2759773647a0SAndy Whitcroft	$realcnt = 0;
2760773647a0SAndy Whitcroft	$linenr = 0;
2761194f66fcSJoe Perches	$fixlinenr = -1;
27620a920b5bSAndy Whitcroft	foreach my $line (@lines) {
27630a920b5bSAndy Whitcroft		$linenr++;
2764194f66fcSJoe Perches		$fixlinenr++;
27651b5539b1SJoe Perches		my $sline = $line;	#copy of $line
27661b5539b1SJoe Perches		$sline =~ s/$;/ /g;	#with comments as spaces
27670a920b5bSAndy Whitcroft
2768c2fdda0dSAndy Whitcroft		my $rawline = $rawlines[$linenr - 1];
2769f36d3eb8SJoe Perches		my $raw_comment = get_raw_comment($line, $rawline);
27706c72ffaaSAndy Whitcroft
277112c253abSJoe Perches# check if it's a mode change, rename or start of a patch
277212c253abSJoe Perches		if (!$in_commit_log &&
277312c253abSJoe Perches		    ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ ||
277412c253abSJoe Perches		    ($line =~ /^rename (?:from|to) \S+\s*$/ ||
277512c253abSJoe Perches		     $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) {
277612c253abSJoe Perches			$is_patch = 1;
277712c253abSJoe Perches		}
277812c253abSJoe Perches
27790a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied
2780e518e9a5SJoe Perches		if (!$in_commit_log &&
278174fd4f34SJoe Perches		    $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
278274fd4f34SJoe Perches			my $context = $4;
27830a920b5bSAndy Whitcroft			$is_patch = 1;
27844a0df2efSAndy Whitcroft			$first_line = $linenr + 1;
27850a920b5bSAndy Whitcroft			$realline=$1-1;
27860a920b5bSAndy Whitcroft			if (defined $2) {
27870a920b5bSAndy Whitcroft				$realcnt=$3+1;
27880a920b5bSAndy Whitcroft			} else {
27890a920b5bSAndy Whitcroft				$realcnt=1+1;
27900a920b5bSAndy Whitcroft			}
2791c2fdda0dSAndy Whitcroft			annotate_reset();
279213214adfSAndy Whitcroft			$prev_values = 'E';
279313214adfSAndy Whitcroft
2794773647a0SAndy Whitcroft			%suppress_ifbraces = ();
2795170d3a22SAndy Whitcroft			%suppress_whiletrailers = ();
27962b474a1aSAndy Whitcroft			%suppress_export = ();
27973e469cdcSAndy Whitcroft			$suppress_statement = 0;
279874fd4f34SJoe Perches			if ($context =~ /\b(\w+)\s*\(/) {
279974fd4f34SJoe Perches				$context_function = $1;
280074fd4f34SJoe Perches			} else {
280174fd4f34SJoe Perches				undef $context_function;
280274fd4f34SJoe Perches			}
28030a920b5bSAndy Whitcroft			next;
28040a920b5bSAndy Whitcroft
28054a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that
28064a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely
28074a0df2efSAndy Whitcroft# blank context lines so we need to count that too.
2808773647a0SAndy Whitcroft		} elsif ($line =~ /^( |\+|$)/) {
28090a920b5bSAndy Whitcroft			$realline++;
2810d8aaf121SAndy Whitcroft			$realcnt-- if ($realcnt != 0);
28110a920b5bSAndy Whitcroft
28124a0df2efSAndy Whitcroft			# Measure the line length and indent.
2813c2fdda0dSAndy Whitcroft			($length, $indent) = line_stats($rawline);
28140a920b5bSAndy Whitcroft
28150a920b5bSAndy Whitcroft			# Track the previous line.
28160a920b5bSAndy Whitcroft			($prevline, $stashline) = ($stashline, $line);
28170a920b5bSAndy Whitcroft			($previndent, $stashindent) = ($stashindent, $indent);
2818c2fdda0dSAndy Whitcroft			($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2819c2fdda0dSAndy Whitcroft
2820773647a0SAndy Whitcroft			#warn "line<$line>\n";
28216c72ffaaSAndy Whitcroft
2822d8aaf121SAndy Whitcroft		} elsif ($realcnt == 1) {
2823d8aaf121SAndy Whitcroft			$realcnt--;
28240a920b5bSAndy Whitcroft		}
28250a920b5bSAndy Whitcroft
2826cc77cdcaSAndy Whitcroft		my $hunk_line = ($realcnt != 0);
2827cc77cdcaSAndy Whitcroft
28286c72ffaaSAndy Whitcroft		$here = "#$linenr: " if (!$file);
28296c72ffaaSAndy Whitcroft		$here = "#$realline: " if ($file);
2830773647a0SAndy Whitcroft
28312ac73b4fSJoe Perches		my $found_file = 0;
2832773647a0SAndy Whitcroft		# extract the filename as it passes
28333bf9a009SRabin Vincent		if ($line =~ /^diff --git.*?(\S+)$/) {
28343bf9a009SRabin Vincent			$realfile = $1;
28352b7ab453SJoe Perches			$realfile =~ s@^([^/]*)/@@ if (!$file);
2836270c49a0SJoe Perches			$in_commit_log = 0;
28372ac73b4fSJoe Perches			$found_file = 1;
28383bf9a009SRabin Vincent		} elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2839773647a0SAndy Whitcroft			$realfile = $1;
28402b7ab453SJoe Perches			$realfile =~ s@^([^/]*)/@@ if (!$file);
2841270c49a0SJoe Perches			$in_commit_log = 0;
28421e855726SWolfram Sang
28431e855726SWolfram Sang			$p1_prefix = $1;
2844e2f7aa4bSAndy Whitcroft			if (!$file && $tree && $p1_prefix ne '' &&
2845e2f7aa4bSAndy Whitcroft			    -e "$root/$p1_prefix") {
2846000d1cc1SJoe Perches				WARN("PATCH_PREFIX",
2847000d1cc1SJoe Perches				     "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
28481e855726SWolfram Sang			}
2849773647a0SAndy Whitcroft
2850c1ab3326SAndy Whitcroft			if ($realfile =~ m@^include/asm/@) {
2851000d1cc1SJoe Perches				ERROR("MODIFIED_INCLUDE_ASM",
2852000d1cc1SJoe Perches				      "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2853773647a0SAndy Whitcroft			}
28542ac73b4fSJoe Perches			$found_file = 1;
28552ac73b4fSJoe Perches		}
28562ac73b4fSJoe Perches
285734d8815fSJoe Perches#make up the handle for any error we report on this line
285834d8815fSJoe Perches		if ($showfile) {
285934d8815fSJoe Perches			$prefix = "$realfile:$realline: "
286034d8815fSJoe Perches		} elsif ($emacs) {
28617d3a9f67SJoe Perches			if ($file) {
28627d3a9f67SJoe Perches				$prefix = "$filename:$realline: ";
28637d3a9f67SJoe Perches			} else {
286434d8815fSJoe Perches				$prefix = "$filename:$linenr: ";
286534d8815fSJoe Perches			}
28667d3a9f67SJoe Perches		}
286734d8815fSJoe Perches
28682ac73b4fSJoe Perches		if ($found_file) {
286985b0ee18SJoe Perches			if (is_maintained_obsolete($realfile)) {
287085b0ee18SJoe Perches				WARN("OBSOLETE",
287185b0ee18SJoe Perches				     "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy.  No unnecessary modifications please.\n");
287285b0ee18SJoe Perches			}
28737bd7e483SJoe Perches			if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
28742ac73b4fSJoe Perches				$check = 1;
28752ac73b4fSJoe Perches			} else {
28762ac73b4fSJoe Perches				$check = $check_orig;
28772ac73b4fSJoe Perches			}
28789f3a8992SRob Herring			$checklicenseline = 1;
2879133712a2SRob Herring
2880133712a2SRob Herring			if ($realfile !~ /^MAINTAINERS/) {
2881133712a2SRob Herring				my $last_binding_patch = $is_binding_patch;
2882133712a2SRob Herring
2883133712a2SRob Herring				$is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@;
2884133712a2SRob Herring
2885133712a2SRob Herring				if (($last_binding_patch != -1) &&
2886133712a2SRob Herring				    ($last_binding_patch ^ $is_binding_patch)) {
2887133712a2SRob Herring					WARN("DT_SPLIT_BINDING_PATCH",
2888858e6845SMauro Carvalho Chehab					     "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n");
2889133712a2SRob Herring				}
2890133712a2SRob Herring			}
2891133712a2SRob Herring
2892773647a0SAndy Whitcroft			next;
2893773647a0SAndy Whitcroft		}
2894773647a0SAndy Whitcroft
2895389834b6SRandy Dunlap		$here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
28960a920b5bSAndy Whitcroft
2897c2fdda0dSAndy Whitcroft		my $hereline = "$here\n$rawline\n";
2898c2fdda0dSAndy Whitcroft		my $herecurr = "$here\n$rawline\n";
2899c2fdda0dSAndy Whitcroft		my $hereprev = "$here\n$prevrawline\n$rawline\n";
29000a920b5bSAndy Whitcroft
29016c72ffaaSAndy Whitcroft		$cnt_lines++ if ($realcnt != 0);
29026c72ffaaSAndy Whitcroft
2903490b292cSJoe Perches# Verify the existence of a commit log if appropriate
2904490b292cSJoe Perches# 2 is used because a $signature is counted in $commit_log_lines
2905490b292cSJoe Perches		if ($in_commit_log) {
2906490b292cSJoe Perches			if ($line !~ /^\s*$/) {
2907490b292cSJoe Perches				$commit_log_lines++;	#could be a $signature
2908490b292cSJoe Perches			}
2909490b292cSJoe Perches		} elsif ($has_commit_log && $commit_log_lines < 2) {
2910490b292cSJoe Perches			WARN("COMMIT_MESSAGE",
2911490b292cSJoe Perches			     "Missing commit description - Add an appropriate one\n");
2912490b292cSJoe Perches			$commit_log_lines = 2;	#warn only once
2913490b292cSJoe Perches		}
2914490b292cSJoe Perches
2915e518e9a5SJoe Perches# Check if the commit log has what seems like a diff which can confuse patch
2916e518e9a5SJoe Perches		if ($in_commit_log && !$commit_log_has_diff &&
291713e45417SMrinal Pandey		    (($line =~ m@^\s+diff\b.*a/([\w/]+)@ &&
291813e45417SMrinal Pandey		      $line =~ m@^\s+diff\b.*a/[\w/]+\s+b/$1\b@) ||
2919e518e9a5SJoe Perches		     $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2920e518e9a5SJoe Perches		     $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2921e518e9a5SJoe Perches			ERROR("DIFF_IN_COMMIT_MSG",
2922e518e9a5SJoe Perches			      "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2923e518e9a5SJoe Perches			$commit_log_has_diff = 1;
2924e518e9a5SJoe Perches		}
2925e518e9a5SJoe Perches
29263bf9a009SRabin Vincent# Check for incorrect file permissions
29273bf9a009SRabin Vincent		if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
29283bf9a009SRabin Vincent			my $permhere = $here . "FILE: $realfile\n";
292904db4d25SJoe Perches			if ($realfile !~ m@scripts/@ &&
293004db4d25SJoe Perches			    $realfile !~ /\.(py|pl|awk|sh)$/) {
2931000d1cc1SJoe Perches				ERROR("EXECUTE_PERMISSIONS",
2932000d1cc1SJoe Perches				      "do not set execute permissions for source files\n" . $permhere);
29333bf9a009SRabin Vincent			}
29343bf9a009SRabin Vincent		}
29353bf9a009SRabin Vincent
2936cd261496SGeert Uytterhoeven# Check the patch for a From:
2937cd261496SGeert Uytterhoeven		if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) {
2938cd261496SGeert Uytterhoeven			$author = $1;
2939e7f929f3SDwaipayan Ray			my $curline = $linenr;
2940e7f929f3SDwaipayan Ray			while(defined($rawlines[$curline]) && ($rawlines[$curline++] =~ /^[ \t]\s*(.*)/)) {
2941e7f929f3SDwaipayan Ray				$author .= $1;
2942e7f929f3SDwaipayan Ray			}
2943cd261496SGeert Uytterhoeven			$author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i);
2944cd261496SGeert Uytterhoeven			$author =~ s/"//g;
2945dfa05c28SJoe Perches			$author = reformat_email($author);
2946cd261496SGeert Uytterhoeven		}
2947cd261496SGeert Uytterhoeven
294820112475SJoe Perches# Check the patch for a signoff:
2949dfa05c28SJoe Perches		if ($line =~ /^\s*signed-off-by:\s*(.*)/i) {
29504a0df2efSAndy Whitcroft			$signoff++;
295115662b3eSJoe Perches			$in_commit_log = 0;
295248ca2d8aSDwaipayan Ray			if ($author ne ''  && $authorsignoff != 1) {
2953fccaebf0SDwaipayan Ray				if (same_email_addresses($1, $author)) {
2954cd261496SGeert Uytterhoeven					$authorsignoff = 1;
295548ca2d8aSDwaipayan Ray				} else {
295648ca2d8aSDwaipayan Ray					my $ctx = $1;
295748ca2d8aSDwaipayan Ray					my ($email_name, $email_comment, $email_address, $comment1) = parse_email($ctx);
295848ca2d8aSDwaipayan Ray					my ($author_name, $author_comment, $author_address, $comment2) = parse_email($author);
295948ca2d8aSDwaipayan Ray
2960046fc741SMimi Zohar					if (lc $email_address eq lc $author_address && $email_name eq $author_name) {
296148ca2d8aSDwaipayan Ray						$author_sob = $ctx;
296248ca2d8aSDwaipayan Ray						$authorsignoff = 2;
2963046fc741SMimi Zohar					} elsif (lc $email_address eq lc $author_address) {
296448ca2d8aSDwaipayan Ray						$author_sob = $ctx;
296548ca2d8aSDwaipayan Ray						$authorsignoff = 3;
296648ca2d8aSDwaipayan Ray					} elsif ($email_name eq $author_name) {
296748ca2d8aSDwaipayan Ray						$author_sob = $ctx;
296848ca2d8aSDwaipayan Ray						$authorsignoff = 4;
296948ca2d8aSDwaipayan Ray
297048ca2d8aSDwaipayan Ray						my $address1 = $email_address;
297148ca2d8aSDwaipayan Ray						my $address2 = $author_address;
297248ca2d8aSDwaipayan Ray
297348ca2d8aSDwaipayan Ray						if ($address1 =~ /(\S+)\+\S+(\@.*)/) {
297448ca2d8aSDwaipayan Ray							$address1 = "$1$2";
297548ca2d8aSDwaipayan Ray						}
297648ca2d8aSDwaipayan Ray						if ($address2 =~ /(\S+)\+\S+(\@.*)/) {
297748ca2d8aSDwaipayan Ray							$address2 = "$1$2";
297848ca2d8aSDwaipayan Ray						}
297948ca2d8aSDwaipayan Ray						if ($address1 eq $address2) {
298048ca2d8aSDwaipayan Ray							$authorsignoff = 5;
298148ca2d8aSDwaipayan Ray						}
298248ca2d8aSDwaipayan Ray					}
2983cd261496SGeert Uytterhoeven				}
2984cd261496SGeert Uytterhoeven			}
29850a920b5bSAndy Whitcroft		}
298620112475SJoe Perches
298744d303ebSJoe Perches# Check for patch separator
298844d303ebSJoe Perches		if ($line =~ /^---$/) {
298944d303ebSJoe Perches			$has_patch_separator = 1;
299044d303ebSJoe Perches			$in_commit_log = 0;
299144d303ebSJoe Perches		}
299244d303ebSJoe Perches
2993e0d975b1SJoe Perches# Check if MAINTAINERS is being updated.  If so, there's probably no need to
2994e0d975b1SJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2995e0d975b1SJoe Perches		if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2996e0d975b1SJoe Perches			$reported_maintainer_file = 1;
2997e0d975b1SJoe Perches		}
2998e0d975b1SJoe Perches
299920112475SJoe Perches# Check signature styles
3000270c49a0SJoe Perches		if (!$in_header_lines &&
3001ce0338dfSJoe Perches		    $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
300220112475SJoe Perches			my $space_before = $1;
300320112475SJoe Perches			my $sign_off = $2;
300420112475SJoe Perches			my $space_after = $3;
300520112475SJoe Perches			my $email = $4;
300620112475SJoe Perches			my $ucfirst_sign_off = ucfirst(lc($sign_off));
300720112475SJoe Perches
3008ce0338dfSJoe Perches			if ($sign_off !~ /$signature_tags/) {
3009831242abSAditya Srivastava				my $suggested_signature = find_standard_signature($sign_off);
3010831242abSAditya Srivastava				if ($suggested_signature eq "") {
3011ce0338dfSJoe Perches					WARN("BAD_SIGN_OFF",
3012ce0338dfSJoe Perches					     "Non-standard signature: $sign_off\n" . $herecurr);
3013831242abSAditya Srivastava				} else {
3014831242abSAditya Srivastava					if (WARN("BAD_SIGN_OFF",
3015831242abSAditya Srivastava						 "Non-standard signature: '$sign_off' - perhaps '$suggested_signature'?\n" . $herecurr) &&
3016831242abSAditya Srivastava					    $fix) {
3017831242abSAditya Srivastava						$fixed[$fixlinenr] =~ s/$sign_off/$suggested_signature/;
3018831242abSAditya Srivastava					}
3019831242abSAditya Srivastava				}
3020ce0338dfSJoe Perches			}
302120112475SJoe Perches			if (defined $space_before && $space_before ne "") {
30223705ce5bSJoe Perches				if (WARN("BAD_SIGN_OFF",
30233705ce5bSJoe Perches					 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
30243705ce5bSJoe Perches				    $fix) {
3025194f66fcSJoe Perches					$fixed[$fixlinenr] =
30263705ce5bSJoe Perches					    "$ucfirst_sign_off $email";
30273705ce5bSJoe Perches				}
302820112475SJoe Perches			}
302920112475SJoe Perches			if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
30303705ce5bSJoe Perches				if (WARN("BAD_SIGN_OFF",
30313705ce5bSJoe Perches					 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
30323705ce5bSJoe Perches				    $fix) {
3033194f66fcSJoe Perches					$fixed[$fixlinenr] =
30343705ce5bSJoe Perches					    "$ucfirst_sign_off $email";
30353705ce5bSJoe Perches				}
30363705ce5bSJoe Perches
303720112475SJoe Perches			}
303820112475SJoe Perches			if (!defined $space_after || $space_after ne " ") {
30393705ce5bSJoe Perches				if (WARN("BAD_SIGN_OFF",
30403705ce5bSJoe Perches					 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
30413705ce5bSJoe Perches				    $fix) {
3042194f66fcSJoe Perches					$fixed[$fixlinenr] =
30433705ce5bSJoe Perches					    "$ucfirst_sign_off $email";
30443705ce5bSJoe Perches				}
304520112475SJoe Perches			}
304620112475SJoe Perches
3047dfa05c28SJoe Perches			my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
304848ca2d8aSDwaipayan Ray			my $suggested_email = format_email(($email_name, $name_comment, $email_address, $comment));
304920112475SJoe Perches			if ($suggested_email eq "") {
3050000d1cc1SJoe Perches				ERROR("BAD_SIGN_OFF",
3051000d1cc1SJoe Perches				      "Unrecognized email address: '$email'\n" . $herecurr);
305220112475SJoe Perches			} else {
305320112475SJoe Perches				my $dequoted = $suggested_email;
305420112475SJoe Perches				$dequoted =~ s/^"//;
305520112475SJoe Perches				$dequoted =~ s/" </ </;
305620112475SJoe Perches				# Don't force email to have quotes
305720112475SJoe Perches				# Allow just an angle bracketed address
3058fccaebf0SDwaipayan Ray				if (!same_email_addresses($email, $suggested_email)) {
3059fccaebf0SDwaipayan Ray					if (WARN("BAD_SIGN_OFF",
3060fccaebf0SDwaipayan Ray						 "email address '$email' might be better as '$suggested_email'\n" . $herecurr) &&
3061fccaebf0SDwaipayan Ray					    $fix) {
3062fccaebf0SDwaipayan Ray						$fixed[$fixlinenr] =~ s/\Q$email\E/$suggested_email/;
3063fccaebf0SDwaipayan Ray					}
3064fccaebf0SDwaipayan Ray				}
3065fccaebf0SDwaipayan Ray
3066fccaebf0SDwaipayan Ray				# Address part shouldn't have comments
3067fccaebf0SDwaipayan Ray				my $stripped_address = $email_address;
3068fccaebf0SDwaipayan Ray				$stripped_address =~ s/\([^\(\)]*\)//g;
3069fccaebf0SDwaipayan Ray				if ($email_address ne $stripped_address) {
3070fccaebf0SDwaipayan Ray					if (WARN("BAD_SIGN_OFF",
3071fccaebf0SDwaipayan Ray						 "address part of email should not have comments: '$email_address'\n" . $herecurr) &&
3072fccaebf0SDwaipayan Ray					    $fix) {
3073fccaebf0SDwaipayan Ray						$fixed[$fixlinenr] =~ s/\Q$email_address\E/$stripped_address/;
3074fccaebf0SDwaipayan Ray					}
3075fccaebf0SDwaipayan Ray				}
3076fccaebf0SDwaipayan Ray
3077fccaebf0SDwaipayan Ray				# Only one name comment should be allowed
3078fccaebf0SDwaipayan Ray				my $comment_count = () = $name_comment =~ /\([^\)]+\)/g;
3079fccaebf0SDwaipayan Ray				if ($comment_count > 1) {
3080000d1cc1SJoe Perches					WARN("BAD_SIGN_OFF",
3081fccaebf0SDwaipayan Ray					     "Use a single name comment in email: '$email'\n" . $herecurr);
3082fccaebf0SDwaipayan Ray				}
3083fccaebf0SDwaipayan Ray
3084fccaebf0SDwaipayan Ray
3085fccaebf0SDwaipayan Ray				# [email protected] or [email protected] shouldn't
3086e73d2715SDwaipayan Ray				# have an email name. In addition comments should strictly
3087fccaebf0SDwaipayan Ray				# begin with a #
3088fccaebf0SDwaipayan Ray				if ($email =~ /^.*stable\@(?:vger\.)?kernel\.org/i) {
3089fccaebf0SDwaipayan Ray					if (($comment ne "" && $comment !~ /^#.+/) ||
3090fccaebf0SDwaipayan Ray					    ($email_name ne "")) {
3091fccaebf0SDwaipayan Ray						my $cur_name = $email_name;
3092fccaebf0SDwaipayan Ray						my $new_comment = $comment;
3093fccaebf0SDwaipayan Ray						$cur_name =~ s/[a-zA-Z\s\-\"]+//g;
3094fccaebf0SDwaipayan Ray
3095fccaebf0SDwaipayan Ray						# Remove brackets enclosing comment text
3096fccaebf0SDwaipayan Ray						# and # from start of comments to get comment text
3097fccaebf0SDwaipayan Ray						$new_comment =~ s/^\((.*)\)$/$1/;
3098fccaebf0SDwaipayan Ray						$new_comment =~ s/^\[(.*)\]$/$1/;
3099fccaebf0SDwaipayan Ray						$new_comment =~ s/^[\s\#]+|\s+$//g;
3100fccaebf0SDwaipayan Ray
3101fccaebf0SDwaipayan Ray						$new_comment = trim("$new_comment $cur_name") if ($cur_name ne $new_comment);
3102fccaebf0SDwaipayan Ray						$new_comment = " # $new_comment" if ($new_comment ne "");
3103fccaebf0SDwaipayan Ray						my $new_email = "$email_address$new_comment";
3104fccaebf0SDwaipayan Ray
3105fccaebf0SDwaipayan Ray						if (WARN("BAD_STABLE_ADDRESS_STYLE",
3106fccaebf0SDwaipayan Ray							 "Invalid email format for stable: '$email', prefer '$new_email'\n" . $herecurr) &&
3107fccaebf0SDwaipayan Ray						    $fix) {
3108fccaebf0SDwaipayan Ray							$fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/;
3109fccaebf0SDwaipayan Ray						}
3110fccaebf0SDwaipayan Ray					}
3111fccaebf0SDwaipayan Ray				} elsif ($comment ne "" && $comment !~ /^(?:#.+|\(.+\))$/) {
3112fccaebf0SDwaipayan Ray					my $new_comment = $comment;
3113fccaebf0SDwaipayan Ray
3114fccaebf0SDwaipayan Ray					# Extract comment text from within brackets or
3115fccaebf0SDwaipayan Ray					# c89 style /*...*/ comments
3116fccaebf0SDwaipayan Ray					$new_comment =~ s/^\[(.*)\]$/$1/;
3117fccaebf0SDwaipayan Ray					$new_comment =~ s/^\/\*(.*)\*\/$/$1/;
3118fccaebf0SDwaipayan Ray
3119fccaebf0SDwaipayan Ray					$new_comment = trim($new_comment);
3120fccaebf0SDwaipayan Ray					$new_comment =~ s/^[^\w]$//; # Single lettered comment with non word character is usually a typo
3121fccaebf0SDwaipayan Ray					$new_comment = "($new_comment)" if ($new_comment ne "");
3122fccaebf0SDwaipayan Ray					my $new_email = format_email($email_name, $name_comment, $email_address, $new_comment);
3123fccaebf0SDwaipayan Ray
3124fccaebf0SDwaipayan Ray					if (WARN("BAD_SIGN_OFF",
3125fccaebf0SDwaipayan Ray						 "Unexpected content after email: '$email', should be: '$new_email'\n" . $herecurr) &&
3126fccaebf0SDwaipayan Ray					    $fix) {
3127fccaebf0SDwaipayan Ray						$fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/;
3128fccaebf0SDwaipayan Ray					}
312920112475SJoe Perches				}
31300a920b5bSAndy Whitcroft			}
31317e51f197SJoe Perches
31327e51f197SJoe Perches# Check for duplicate signatures
31337e51f197SJoe Perches			my $sig_nospace = $line;
31347e51f197SJoe Perches			$sig_nospace =~ s/\s//g;
31357e51f197SJoe Perches			$sig_nospace = lc($sig_nospace);
31367e51f197SJoe Perches			if (defined $signatures{$sig_nospace}) {
31377e51f197SJoe Perches				WARN("BAD_SIGN_OFF",
31387e51f197SJoe Perches				     "Duplicate signature\n" . $herecurr);
31397e51f197SJoe Perches			} else {
31407e51f197SJoe Perches				$signatures{$sig_nospace} = 1;
31417e51f197SJoe Perches			}
31426c5d24eeSSean Christopherson
31436c5d24eeSSean Christopherson# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
31446c5d24eeSSean Christopherson			if ($sign_off =~ /^co-developed-by:$/i) {
31456c5d24eeSSean Christopherson				if ($email eq $author) {
31466c5d24eeSSean Christopherson					WARN("BAD_SIGN_OFF",
31476c5d24eeSSean Christopherson					      "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
31486c5d24eeSSean Christopherson				}
31496c5d24eeSSean Christopherson				if (!defined $lines[$linenr]) {
31506c5d24eeSSean Christopherson					WARN("BAD_SIGN_OFF",
31516c5d24eeSSean Christopherson					     "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline);
31526c5d24eeSSean Christopherson				} elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) {
31536c5d24eeSSean Christopherson					WARN("BAD_SIGN_OFF",
31546c5d24eeSSean Christopherson					     "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
31556c5d24eeSSean Christopherson				} elsif ($1 ne $email) {
31566c5d24eeSSean Christopherson					WARN("BAD_SIGN_OFF",
31576c5d24eeSSean Christopherson					     "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
31586c5d24eeSSean Christopherson				}
31596c5d24eeSSean Christopherson			}
31600a920b5bSAndy Whitcroft		}
31610a920b5bSAndy Whitcroft
3162bd17e036SNiklas Söderlund# Check Fixes: styles is correct
3163bd17e036SNiklas Söderlund		if (!$in_header_lines &&
3164bd17e036SNiklas Söderlund		    $line =~ /^\s*fixes:?\s*(?:commit\s*)?[0-9a-f]{5,}\b/i) {
3165bd17e036SNiklas Söderlund			my $orig_commit = "";
3166bd17e036SNiklas Söderlund			my $id = "0123456789ab";
3167bd17e036SNiklas Söderlund			my $title = "commit title";
3168bd17e036SNiklas Söderlund			my $tag_case = 1;
3169bd17e036SNiklas Söderlund			my $tag_space = 1;
3170bd17e036SNiklas Söderlund			my $id_length = 1;
3171bd17e036SNiklas Söderlund			my $id_case = 1;
3172bd17e036SNiklas Söderlund			my $title_has_quotes = 0;
3173bd17e036SNiklas Söderlund
3174bd17e036SNiklas Söderlund			if ($line =~ /(\s*fixes:?)\s+([0-9a-f]{5,})\s+($balanced_parens)/i) {
3175bd17e036SNiklas Söderlund				my $tag = $1;
3176bd17e036SNiklas Söderlund				$orig_commit = $2;
3177bd17e036SNiklas Söderlund				$title = $3;
3178bd17e036SNiklas Söderlund
3179bd17e036SNiklas Söderlund				$tag_case = 0 if $tag eq "Fixes:";
3180bd17e036SNiklas Söderlund				$tag_space = 0 if ($line =~ /^fixes:? [0-9a-f]{5,} ($balanced_parens)/i);
3181bd17e036SNiklas Söderlund
3182bd17e036SNiklas Söderlund				$id_length = 0 if ($orig_commit =~ /^[0-9a-f]{12}$/i);
3183bd17e036SNiklas Söderlund				$id_case = 0 if ($orig_commit !~ /[A-F]/);
3184bd17e036SNiklas Söderlund
3185bd17e036SNiklas Söderlund				# Always strip leading/trailing parens then double quotes if existing
3186bd17e036SNiklas Söderlund				$title = substr($title, 1, -1);
3187bd17e036SNiklas Söderlund				if ($title =~ /^".*"$/) {
3188bd17e036SNiklas Söderlund					$title = substr($title, 1, -1);
3189bd17e036SNiklas Söderlund					$title_has_quotes = 1;
3190bd17e036SNiklas Söderlund				}
3191bd17e036SNiklas Söderlund			}
3192bd17e036SNiklas Söderlund
3193bd17e036SNiklas Söderlund			my ($cid, $ctitle) = git_commit_info($orig_commit, $id,
3194bd17e036SNiklas Söderlund							     $title);
3195bd17e036SNiklas Söderlund
3196bd17e036SNiklas Söderlund			if ($ctitle ne $title || $tag_case || $tag_space ||
3197bd17e036SNiklas Söderlund			    $id_length || $id_case || !$title_has_quotes) {
3198bd17e036SNiklas Söderlund				if (WARN("BAD_FIXES_TAG",
3199bd17e036SNiklas Söderlund				     "Please use correct Fixes: style 'Fixes: <12 chars of sha1> (\"<title line>\")' - ie: 'Fixes: $cid (\"$ctitle\")'\n" . $herecurr) &&
3200bd17e036SNiklas Söderlund				    $fix) {
3201bd17e036SNiklas Söderlund					$fixed[$fixlinenr] = "Fixes: $cid (\"$ctitle\")";
3202bd17e036SNiklas Söderlund				}
3203bd17e036SNiklas Söderlund			}
3204bd17e036SNiklas Söderlund		}
3205bd17e036SNiklas Söderlund
3206a2fe16b9SJoe Perches# Check email subject for common tools that don't need to be mentioned
3207a2fe16b9SJoe Perches		if ($in_header_lines &&
3208a2fe16b9SJoe Perches		    $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
3209a2fe16b9SJoe Perches			WARN("EMAIL_SUBJECT",
3210a2fe16b9SJoe Perches			     "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
3211a2fe16b9SJoe Perches		}
3212a2fe16b9SJoe Perches
321344d303ebSJoe Perches# Check for Gerrit Change-Ids not in any patch context
321444d303ebSJoe Perches		if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) {
32157580c5b9SAditya Srivastava			if (ERROR("GERRIT_CHANGE_ID",
32167580c5b9SAditya Srivastava			          "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr) &&
32177580c5b9SAditya Srivastava			    $fix) {
32187580c5b9SAditya Srivastava				fix_delete_line($fixlinenr, $rawline);
32197580c5b9SAditya Srivastava			}
32207ebd05efSChristopher Covington		}
32217ebd05efSChristopher Covington
3222369c8dd3SJoe Perches# Check if the commit log is in a possible stack dump
3223369c8dd3SJoe Perches		if ($in_commit_log && !$commit_log_possible_stack_dump &&
3224369c8dd3SJoe Perches		    ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
3225369c8dd3SJoe Perches		     $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
3226369c8dd3SJoe Perches					# timestamp
3227634cffccSJoe Perches		     $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) ||
3228634cffccSJoe Perches		     $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ ||
3229634cffccSJoe Perches		     $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) {
3230634cffccSJoe Perches					# stack dump address styles
3231369c8dd3SJoe Perches			$commit_log_possible_stack_dump = 1;
3232369c8dd3SJoe Perches		}
3233369c8dd3SJoe Perches
32342a076f40SJoe Perches# Check for line lengths > 75 in commit log, warn once
32352a076f40SJoe Perches		if ($in_commit_log && !$commit_log_long_line &&
3236bf4daf12SJoe Perches		    length($line) > 75 &&
3237bf4daf12SJoe Perches		    !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
3238bf4daf12SJoe Perches					# file delta changes
323936f8b348SJerome Forissier		      $line =~ /^\s*(?:[\w\.\-\+]*\/)++[\w\.\-\+]+:/ ||
3240bf4daf12SJoe Perches					# filename then :
324127b379afSAditya Srivastava		      $line =~ /^\s*(?:Fixes:|Link:|$signature_tags)/i ||
324227b379afSAditya Srivastava					# A Fixes: or Link: line or signature tag line
3243bf4daf12SJoe Perches		      $commit_log_possible_stack_dump)) {
32442a076f40SJoe Perches			WARN("COMMIT_LOG_LONG_LINE",
32452a076f40SJoe Perches			     "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
32462a076f40SJoe Perches			$commit_log_long_line = 1;
32472a076f40SJoe Perches		}
32482a076f40SJoe Perches
3249bf4daf12SJoe Perches# Reset possible stack dump if a blank line is found
3250bf4daf12SJoe Perches		if ($in_commit_log && $commit_log_possible_stack_dump &&
3251bf4daf12SJoe Perches		    $line =~ /^\s*$/) {
3252bf4daf12SJoe Perches			$commit_log_possible_stack_dump = 0;
3253bf4daf12SJoe Perches		}
3254bf4daf12SJoe Perches
3255*76f381bbSKai Wasserbäch# Check for odd tags before a URI/URL
3256*76f381bbSKai Wasserbäch		if ($in_commit_log &&
3257*76f381bbSKai Wasserbäch		    $line =~ /^\s*(\w+):\s*http/ && $1 ne 'Link') {
3258*76f381bbSKai Wasserbäch			if ($1 =~ /^v(?:ersion)?\d+/i) {
3259*76f381bbSKai Wasserbäch				WARN("COMMIT_LOG_VERSIONING",
3260*76f381bbSKai Wasserbäch				     "Patch version information should be after the --- line\n" . $herecurr);
3261*76f381bbSKai Wasserbäch			} else {
3262*76f381bbSKai Wasserbäch				WARN("COMMIT_LOG_USE_LINK",
3263*76f381bbSKai Wasserbäch				     "Unknown link reference '$1:', use 'Link:' instead\n" . $herecurr);
3264*76f381bbSKai Wasserbäch			}
3265*76f381bbSKai Wasserbäch		}
3266*76f381bbSKai Wasserbäch
3267084a617aSDwaipayan Ray# Check for lines starting with a #
3268084a617aSDwaipayan Ray		if ($in_commit_log && $line =~ /^#/) {
3269084a617aSDwaipayan Ray			if (WARN("COMMIT_COMMENT_SYMBOL",
3270084a617aSDwaipayan Ray				 "Commit log lines starting with '#' are dropped by git as comments\n" . $herecurr) &&
3271084a617aSDwaipayan Ray			    $fix) {
3272084a617aSDwaipayan Ray				$fixed[$fixlinenr] =~ s/^/ /;
3273084a617aSDwaipayan Ray			}
3274084a617aSDwaipayan Ray		}
3275084a617aSDwaipayan Ray
32760d7835fcSJoe Perches# Check for git id commit length and improperly formed commit descriptions
32774ce9f970SJoe Perches# A correctly formed commit description is:
32784ce9f970SJoe Perches#    commit <SHA-1 hash length 12+ chars> ("Complete commit subject")
32794ce9f970SJoe Perches# with the commit subject '("' prefix and '")' suffix
32804ce9f970SJoe Perches# This is a fairly compilicated block as it tests for what appears to be
32814ce9f970SJoe Perches# bare SHA-1 hash with  minimum length of 5.  It also avoids several types of
32824ce9f970SJoe Perches# possible SHA-1 matches.
32834ce9f970SJoe Perches# A commit match can span multiple lines so this block attempts to find a
32844ce9f970SJoe Perches# complete typical commit on a maximum of 3 lines
32854ce9f970SJoe Perches		if ($perl_version_ok &&
32864ce9f970SJoe Perches		    $in_commit_log && !$commit_log_possible_stack_dump &&
3287a8972573SJohn Hubbard		    $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i &&
3288e882dbfcSWei Wang		    $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
32894ce9f970SJoe Perches		    (($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
32904ce9f970SJoe Perches		      ($line =~ /\bcommit\s*$/i && defined($rawlines[$linenr]) && $rawlines[$linenr] =~ /^\s*[0-9a-f]{5,}\b/i)) ||
3291aab38f51SJoe Perches		     ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
3292369c8dd3SJoe Perches		      $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
3293bf4daf12SJoe Perches		      $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
3294fe043ea1SJoe Perches			my $init_char = "c";
3295fe043ea1SJoe Perches			my $orig_commit = "";
32960d7835fcSJoe Perches			my $short = 1;
32970d7835fcSJoe Perches			my $long = 0;
32980d7835fcSJoe Perches			my $case = 1;
32990d7835fcSJoe Perches			my $space = 1;
33000d7835fcSJoe Perches			my $id = '0123456789ab';
33010d7835fcSJoe Perches			my $orig_desc = "commit description";
33020d7835fcSJoe Perches			my $description = "";
33034ce9f970SJoe Perches			my $herectx = $herecurr;
33044ce9f970SJoe Perches			my $has_parens = 0;
33054ce9f970SJoe Perches			my $has_quotes = 0;
33060d7835fcSJoe Perches
33074ce9f970SJoe Perches			my $input = $line;
33084ce9f970SJoe Perches			if ($line =~ /(?:\bcommit\s+[0-9a-f]{5,}|\bcommit\s*$)/i) {
33094ce9f970SJoe Perches				for (my $n = 0; $n < 2; $n++) {
33104ce9f970SJoe Perches					if ($input =~ /\bcommit\s+[0-9a-f]{5,}\s*($balanced_parens)/i) {
33114ce9f970SJoe Perches						$orig_desc = $1;
33124ce9f970SJoe Perches						$has_parens = 1;
33134ce9f970SJoe Perches						# Always strip leading/trailing parens then double quotes if existing
33144ce9f970SJoe Perches						$orig_desc = substr($orig_desc, 1, -1);
33154ce9f970SJoe Perches						if ($orig_desc =~ /^".*"$/) {
33164ce9f970SJoe Perches							$orig_desc = substr($orig_desc, 1, -1);
33174ce9f970SJoe Perches							$has_quotes = 1;
33184ce9f970SJoe Perches						}
33194ce9f970SJoe Perches						last;
33204ce9f970SJoe Perches					}
33214ce9f970SJoe Perches					last if ($#lines < $linenr + $n);
33224ce9f970SJoe Perches					$input .= " " . trim($rawlines[$linenr + $n]);
33234ce9f970SJoe Perches					$herectx .= "$rawlines[$linenr + $n]\n";
33244ce9f970SJoe Perches				}
33254ce9f970SJoe Perches				$herectx = $herecurr if (!$has_parens);
3326fe043ea1SJoe Perches			}
3327fe043ea1SJoe Perches
33284ce9f970SJoe Perches			if ($input =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
33294ce9f970SJoe Perches				$init_char = $1;
33304ce9f970SJoe Perches				$orig_commit = lc($2);
33314ce9f970SJoe Perches				$short = 0 if ($input =~ /\bcommit\s+[0-9a-f]{12,40}/i);
33324ce9f970SJoe Perches				$long = 1 if ($input =~ /\bcommit\s+[0-9a-f]{41,}/i);
33334ce9f970SJoe Perches				$space = 0 if ($input =~ /\bcommit [0-9a-f]/i);
33344ce9f970SJoe Perches				$case = 0 if ($input =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
33354ce9f970SJoe Perches			} elsif ($input =~ /\b([0-9a-f]{12,40})\b/i) {
33364ce9f970SJoe Perches				$orig_commit = lc($1);
33370d7835fcSJoe Perches			}
33380d7835fcSJoe Perches
33390d7835fcSJoe Perches			($id, $description) = git_commit_info($orig_commit,
33400d7835fcSJoe Perches							      $id, $orig_desc);
33410d7835fcSJoe Perches
3342948b133aSHeinrich Schuchardt			if (defined($id) &&
33434ce9f970SJoe Perches			    ($short || $long || $space || $case || ($orig_desc ne $description) || !$has_quotes) &&
33444ce9f970SJoe Perches			    $last_git_commit_id_linenr != $linenr - 1) {
3345d311cd44SJoe Perches				ERROR("GIT_COMMIT_ID",
33464ce9f970SJoe Perches				      "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herectx);
33470d7835fcSJoe Perches			}
33484ce9f970SJoe Perches			#don't report the next line if this line ends in commit and the sha1 hash is the next line
33494ce9f970SJoe Perches			$last_git_commit_id_linenr = $linenr if ($line =~ /\bcommit\s*$/i);
3350d311cd44SJoe Perches		}
3351d311cd44SJoe Perches
33529b71f79fSBjorn Helgaas# Check for mailing list archives other than lore.kernel.org
33539b71f79fSBjorn Helgaas		if ($rawline =~ m{http.*\b$obsolete_archives}) {
33549b71f79fSBjorn Helgaas			WARN("PREFER_LORE_ARCHIVE",
33559b71f79fSBjorn Helgaas			     "Use lore.kernel.org archive links when possible - see https://lore.kernel.org/lists.html\n" . $herecurr);
33569b71f79fSBjorn Helgaas		}
33579b71f79fSBjorn Helgaas
335813f1937eSJoe Perches# Check for added, moved or deleted files
335913f1937eSJoe Perches		if (!$reported_maintainer_file && !$in_commit_log &&
336013f1937eSJoe Perches		    ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
336113f1937eSJoe Perches		     $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
336213f1937eSJoe Perches		     ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
336313f1937eSJoe Perches		      (defined($1) || defined($2))))) {
3364a82603a8SAndrew Jeffery			$is_patch = 1;
336513f1937eSJoe Perches			$reported_maintainer_file = 1;
336613f1937eSJoe Perches			WARN("FILE_PATH_CHANGES",
336713f1937eSJoe Perches			     "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
336813f1937eSJoe Perches		}
336913f1937eSJoe Perches
3370e400edb1SRob Herring# Check for adding new DT bindings not in schema format
3371e400edb1SRob Herring		if (!$in_commit_log &&
3372e400edb1SRob Herring		    ($line =~ /^new file mode\s*\d+\s*$/) &&
3373e400edb1SRob Herring		    ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) {
3374e400edb1SRob Herring			WARN("DT_SCHEMA_BINDING_PATCH",
337556ddc4cdSMauro Carvalho Chehab			     "DT bindings should be in DT schema format. See: Documentation/devicetree/bindings/writing-schema.rst\n");
3376e400edb1SRob Herring		}
3377e400edb1SRob Herring
337800df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file
33798905a67cSAndy Whitcroft		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
3380000d1cc1SJoe Perches			ERROR("CORRUPTED_PATCH",
3381000d1cc1SJoe Perches			      "patch seems to be corrupt (line wrapped?)\n" .
33826c72ffaaSAndy Whitcroft				$herecurr) if (!$emitted_corrupt++);
3383de7d4f0eSAndy Whitcroft		}
3384de7d4f0eSAndy Whitcroft
3385de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
3386de7d4f0eSAndy Whitcroft		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
3387171ae1a4SAndy Whitcroft		    $rawline !~ m/^$UTF8*$/) {
3388171ae1a4SAndy Whitcroft			my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
3389171ae1a4SAndy Whitcroft
3390171ae1a4SAndy Whitcroft			my $blank = copy_spacing($rawline);
3391171ae1a4SAndy Whitcroft			my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
3392171ae1a4SAndy Whitcroft			my $hereptr = "$hereline$ptr\n";
3393171ae1a4SAndy Whitcroft
339434d99219SJoe Perches			CHK("INVALID_UTF8",
3395000d1cc1SJoe Perches			    "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
339600df344fSAndy Whitcroft		}
33970a920b5bSAndy Whitcroft
339815662b3eSJoe Perches# Check if it's the start of a commit log
339915662b3eSJoe Perches# (not a header line and we haven't seen the patch filename)
340015662b3eSJoe Perches		if ($in_header_lines && $realfile =~ /^$/ &&
3401eb3a58deSJoe Perches		    !($rawline =~ /^\s+(?:\S|$)/ ||
3402eb3a58deSJoe Perches		      $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
340315662b3eSJoe Perches			$in_header_lines = 0;
340415662b3eSJoe Perches			$in_commit_log = 1;
3405ed43c4e5SAllen Hubbe			$has_commit_log = 1;
340615662b3eSJoe Perches		}
340715662b3eSJoe Perches
3408fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly
3409fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing.
3410fa64205dSPasi Savanainen		if ($in_header_lines &&
3411fa64205dSPasi Savanainen		    $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
3412fa64205dSPasi Savanainen		    $1 !~ /utf-8/i) {
3413fa64205dSPasi Savanainen			$non_utf8_charset = 1;
3414fa64205dSPasi Savanainen		}
3415fa64205dSPasi Savanainen
3416fa64205dSPasi Savanainen		if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
341715662b3eSJoe Perches		    $rawline =~ /$NON_ASCII_UTF8/) {
3418fa64205dSPasi Savanainen			WARN("UTF8_BEFORE_PATCH",
341915662b3eSJoe Perches			    "8-bit UTF-8 used in possible commit log\n" . $herecurr);
342015662b3eSJoe Perches		}
342115662b3eSJoe Perches
3422d6430f71SJoe Perches# Check for absolute kernel paths in commit message
3423d6430f71SJoe Perches		if ($tree && $in_commit_log) {
3424d6430f71SJoe Perches			while ($line =~ m{(?:^|\s)(/\S*)}g) {
3425d6430f71SJoe Perches				my $file = $1;
3426d6430f71SJoe Perches
3427d6430f71SJoe Perches				if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
3428d6430f71SJoe Perches				    check_absolute_file($1, $herecurr)) {
3429d6430f71SJoe Perches					#
3430d6430f71SJoe Perches				} else {
3431d6430f71SJoe Perches					check_absolute_file($file, $herecurr);
3432d6430f71SJoe Perches				}
3433d6430f71SJoe Perches			}
3434d6430f71SJoe Perches		}
3435d6430f71SJoe Perches
343666b47b4aSKees Cook# Check for various typo / spelling mistakes
343766d7a382SJoe Perches		if (defined($misspellings) &&
343866d7a382SJoe Perches		    ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
34397da07c31SDwaipayan Ray			while ($rawline =~ /(?:^|[^\w\-'`])($misspellings)(?:[^\w\-'`]|$)/gi) {
344066b47b4aSKees Cook				my $typo = $1;
34417da07c31SDwaipayan Ray				my $blank = copy_spacing($rawline);
34427da07c31SDwaipayan Ray				my $ptr = substr($blank, 0, $-[1]) . "^" x length($typo);
34437da07c31SDwaipayan Ray				my $hereptr = "$hereline$ptr\n";
344466b47b4aSKees Cook				my $typo_fix = $spelling_fix{lc($typo)};
344566b47b4aSKees Cook				$typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
344666b47b4aSKees Cook				$typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
34470675a8fbSJean Delvare				my $msg_level = \&WARN;
34480675a8fbSJean Delvare				$msg_level = \&CHK if ($file);
34490675a8fbSJean Delvare				if (&{$msg_level}("TYPO_SPELLING",
34507da07c31SDwaipayan Ray						  "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $hereptr) &&
345166b47b4aSKees Cook				    $fix) {
345266b47b4aSKees Cook					$fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
345366b47b4aSKees Cook				}
345466b47b4aSKees Cook			}
345566b47b4aSKees Cook		}
345666b47b4aSKees Cook
3457a8dd86bfSMatteo Croce# check for invalid commit id
3458a8dd86bfSMatteo Croce		if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) {
3459a8dd86bfSMatteo Croce			my $id;
3460a8dd86bfSMatteo Croce			my $description;
3461a8dd86bfSMatteo Croce			($id, $description) = git_commit_info($2, undef, undef);
3462a8dd86bfSMatteo Croce			if (!defined($id)) {
3463a8dd86bfSMatteo Croce				WARN("UNKNOWN_COMMIT_ID",
3464a8dd86bfSMatteo Croce				     "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr);
3465a8dd86bfSMatteo Croce			}
3466a8dd86bfSMatteo Croce		}
3467a8dd86bfSMatteo Croce
3468310cd06bSJoe Perches# check for repeated words separated by a single space
34698d0325ccSAditya Srivastava# avoid false positive from list command eg, '-rw-r--r-- 1 root root'
34708d0325ccSAditya Srivastava		if (($rawline =~ /^\+/ || $in_commit_log) &&
34718d0325ccSAditya Srivastava		    $rawline !~ /[bcCdDlMnpPs\?-][rwxsStT-]{9}/) {
34721db81a68SDwaipayan Ray			pos($rawline) = 1 if (!$in_commit_log);
3473310cd06bSJoe Perches			while ($rawline =~ /\b($word_pattern) (?=($word_pattern))/g) {
3474310cd06bSJoe Perches
3475310cd06bSJoe Perches				my $first = $1;
3476310cd06bSJoe Perches				my $second = $2;
34771db81a68SDwaipayan Ray				my $start_pos = $-[1];
34781db81a68SDwaipayan Ray				my $end_pos = $+[2];
3479310cd06bSJoe Perches				if ($first =~ /(?:struct|union|enum)/) {
3480310cd06bSJoe Perches					pos($rawline) += length($first) + length($second) + 1;
3481310cd06bSJoe Perches					next;
3482310cd06bSJoe Perches				}
3483310cd06bSJoe Perches
34841db81a68SDwaipayan Ray				next if (lc($first) ne lc($second));
3485310cd06bSJoe Perches				next if ($first eq 'long');
3486310cd06bSJoe Perches
34871db81a68SDwaipayan Ray				# check for character before and after the word matches
34881db81a68SDwaipayan Ray				my $start_char = '';
34891db81a68SDwaipayan Ray				my $end_char = '';
34901db81a68SDwaipayan Ray				$start_char = substr($rawline, $start_pos - 1, 1) if ($start_pos > ($in_commit_log ? 0 : 1));
34911db81a68SDwaipayan Ray				$end_char = substr($rawline, $end_pos, 1) if ($end_pos < length($rawline));
34921db81a68SDwaipayan Ray
34931db81a68SDwaipayan Ray				next if ($start_char =~ /^\S$/);
34941db81a68SDwaipayan Ray				next if (index(" \t.,;?!", $end_char) == -1);
34951db81a68SDwaipayan Ray
34968d0325ccSAditya Srivastava				# avoid repeating hex occurrences like 'ff ff fe 09 ...'
34978d0325ccSAditya Srivastava				if ($first =~ /\b[0-9a-f]{2,}\b/i) {
34988d0325ccSAditya Srivastava					next if (!exists($allow_repeated_words{lc($first)}));
34998d0325ccSAditya Srivastava				}
35008d0325ccSAditya Srivastava
3501310cd06bSJoe Perches				if (WARN("REPEATED_WORD",
3502310cd06bSJoe Perches					 "Possible repeated word: '$first'\n" . $herecurr) &&
3503310cd06bSJoe Perches				    $fix) {
3504310cd06bSJoe Perches					$fixed[$fixlinenr] =~ s/\b$first $second\b/$first/;
3505310cd06bSJoe Perches				}
3506310cd06bSJoe Perches			}
3507310cd06bSJoe Perches
3508310cd06bSJoe Perches			# if it's a repeated word on consecutive lines in a comment block
3509310cd06bSJoe Perches			if ($prevline =~ /$;+\s*$/ &&
3510310cd06bSJoe Perches			    $prevrawline =~ /($word_pattern)\s*$/) {
3511310cd06bSJoe Perches				my $last_word = $1;
3512310cd06bSJoe Perches				if ($rawline =~ /^\+\s*\*\s*$last_word /) {
3513310cd06bSJoe Perches					if (WARN("REPEATED_WORD",
3514310cd06bSJoe Perches						 "Possible repeated word: '$last_word'\n" . $hereprev) &&
3515310cd06bSJoe Perches					    $fix) {
3516310cd06bSJoe Perches						$fixed[$fixlinenr] =~ s/(\+\s*\*\s*)$last_word /$1/;
3517310cd06bSJoe Perches					}
3518310cd06bSJoe Perches				}
3519310cd06bSJoe Perches			}
3520310cd06bSJoe Perches		}
3521310cd06bSJoe Perches
352230670854SAndy Whitcroft# ignore non-hunk lines and lines being removed
352330670854SAndy Whitcroft		next if (!$hunk_line || $line =~ /^-/);
352400df344fSAndy Whitcroft
35250a920b5bSAndy Whitcroft#trailing whitespace
35269c0ca6f9SAndy Whitcroft		if ($line =~ /^\+.*\015/) {
3527c2fdda0dSAndy Whitcroft			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3528d5e616fcSJoe Perches			if (ERROR("DOS_LINE_ENDINGS",
3529d5e616fcSJoe Perches				  "DOS line endings\n" . $herevet) &&
3530d5e616fcSJoe Perches			    $fix) {
3531194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/[\s\015]+$//;
3532d5e616fcSJoe Perches			}
3533c2fdda0dSAndy Whitcroft		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
3534c2fdda0dSAndy Whitcroft			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
35353705ce5bSJoe Perches			if (ERROR("TRAILING_WHITESPACE",
35363705ce5bSJoe Perches				  "trailing whitespace\n" . $herevet) &&
35373705ce5bSJoe Perches			    $fix) {
3538194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/\s+$//;
35393705ce5bSJoe Perches			}
35403705ce5bSJoe Perches
3541d2c0a235SAndy Whitcroft			$rpt_cleaners = 1;
35420a920b5bSAndy Whitcroft		}
35435368df20SAndy Whitcroft
35444783f894SJosh Triplett# Check for FSF mailing addresses.
3545109d8cb2SAlexander Duyck		if ($rawline =~ /\bwrite to the Free/i ||
35461bde561eSMatthew Wilcox		    $rawline =~ /\b675\s+Mass\s+Ave/i ||
35473e2232f2SJoe Perches		    $rawline =~ /\b59\s+Temple\s+Pl/i ||
35483e2232f2SJoe Perches		    $rawline =~ /\b51\s+Franklin\s+St/i) {
35494783f894SJosh Triplett			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
35500675a8fbSJean Delvare			my $msg_level = \&ERROR;
35510675a8fbSJean Delvare			$msg_level = \&CHK if ($file);
35520675a8fbSJean Delvare			&{$msg_level}("FSF_MAILING_ADDRESS",
35534783f894SJosh 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)
35544783f894SJosh Triplett		}
35554783f894SJosh Triplett
35563354957aSAndi Kleen# check for Kconfig help text having a real description
35579fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have
35589fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough.
35593354957aSAndi Kleen		if ($realfile =~ /Kconfig/ &&
3560678ae162SUlf Magnusson		    # 'choice' is usually the last thing on the line (though
3561678ae162SUlf Magnusson		    # Kconfig supports named choices), so use a word boundary
3562678ae162SUlf Magnusson		    # (\b) rather than a whitespace character (\s)
3563678ae162SUlf Magnusson		    $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
3564b8709bceSJoe Perches			my $ln = $linenr;
3565b8709bceSJoe Perches			my $needs_help = 0;
3566b8709bceSJoe Perches			my $has_help = 0;
3567b8709bceSJoe Perches			my $help_length = 0;
3568b8709bceSJoe Perches			while (defined $lines[$ln]) {
3569b8709bceSJoe Perches				my $f = $lines[$ln++];
35709fe287d7SAndy Whitcroft
35719fe287d7SAndy Whitcroft				next if ($f =~ /^-/);
3572b8709bceSJoe Perches				last if ($f !~ /^[\+ ]/);	# !patch context
3573a1385803SAndy Whitcroft
3574b8709bceSJoe Perches				if ($f =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
3575b8709bceSJoe Perches					$needs_help = 1;
3576b8709bceSJoe Perches					next;
3577b8709bceSJoe Perches				}
3578b8709bceSJoe Perches				if ($f =~ /^\+\s*help\s*$/) {
3579b8709bceSJoe Perches					$has_help = 1;
3580b8709bceSJoe Perches					next;
3581a1385803SAndy Whitcroft				}
3582a1385803SAndy Whitcroft
3583b8709bceSJoe Perches				$f =~ s/^.//;	# strip patch context [+ ]
3584b8709bceSJoe Perches				$f =~ s/#.*//;	# strip # directives
3585b8709bceSJoe Perches				$f =~ s/^\s+//;	# strip leading blanks
3586b8709bceSJoe Perches				next if ($f =~ /^$/);	# skip blank lines
3587678ae162SUlf Magnusson
3588b8709bceSJoe Perches				# At the end of this Kconfig block:
3589678ae162SUlf Magnusson				# This only checks context lines in the patch
3590678ae162SUlf Magnusson				# and so hopefully shouldn't trigger false
3591678ae162SUlf Magnusson				# positives, even though some of these are
3592678ae162SUlf Magnusson				# common words in help texts
3593b8709bceSJoe Perches				if ($f =~ /^(?:config|menuconfig|choice|endchoice|
3594678ae162SUlf Magnusson					       if|endif|menu|endmenu|source)\b/x) {
35959fe287d7SAndy Whitcroft					last;
35969fe287d7SAndy Whitcroft				}
3597b8709bceSJoe Perches				$help_length++ if ($has_help);
35983354957aSAndi Kleen			}
3599b8709bceSJoe Perches			if ($needs_help &&
3600b8709bceSJoe Perches			    $help_length < $min_conf_desc_length) {
3601b8709bceSJoe Perches				my $stat_real = get_stat_real($linenr, $ln - 1);
3602000d1cc1SJoe Perches				WARN("CONFIG_DESCRIPTION",
3603b8709bceSJoe Perches				     "please write a help paragraph that fully describes the config symbol\n" . "$here\n$stat_real\n");
360456193274SVadim Bendebury			}
36053354957aSAndi Kleen		}
36063354957aSAndi Kleen
36077ccf41a8SJoe Perches# check MAINTAINERS entries
36087ccf41a8SJoe Perches		if ($realfile =~ /^MAINTAINERS$/) {
36097ccf41a8SJoe Perches# check MAINTAINERS entries for the right form
36107ccf41a8SJoe Perches			if ($rawline =~ /^\+[A-Z]:/ &&
3611628f91a2SJoe Perches			    $rawline !~ /^\+[A-Z]:\t\S/) {
3612628f91a2SJoe Perches				if (WARN("MAINTAINERS_STYLE",
3613628f91a2SJoe Perches					 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
3614628f91a2SJoe Perches				    $fix) {
3615628f91a2SJoe Perches					$fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
3616628f91a2SJoe Perches				}
3617628f91a2SJoe Perches			}
36187ccf41a8SJoe Perches# check MAINTAINERS entries for the right ordering too
36197ccf41a8SJoe Perches			my $preferred_order = 'MRLSWQBCPTFXNK';
36207ccf41a8SJoe Perches			if ($rawline =~ /^\+[A-Z]:/ &&
36217ccf41a8SJoe Perches			    $prevrawline =~ /^[\+ ][A-Z]:/) {
36227ccf41a8SJoe Perches				$rawline =~ /^\+([A-Z]):\s*(.*)/;
36237ccf41a8SJoe Perches				my $cur = $1;
36247ccf41a8SJoe Perches				my $curval = $2;
36257ccf41a8SJoe Perches				$prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/;
36267ccf41a8SJoe Perches				my $prev = $1;
36277ccf41a8SJoe Perches				my $prevval = $2;
36287ccf41a8SJoe Perches				my $curindex = index($preferred_order, $cur);
36297ccf41a8SJoe Perches				my $previndex = index($preferred_order, $prev);
36307ccf41a8SJoe Perches				if ($curindex < 0) {
36317ccf41a8SJoe Perches					WARN("MAINTAINERS_STYLE",
36327ccf41a8SJoe Perches					     "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr);
36337ccf41a8SJoe Perches				} else {
36347ccf41a8SJoe Perches					if ($previndex >= 0 && $curindex < $previndex) {
36357ccf41a8SJoe Perches						WARN("MAINTAINERS_STYLE",
36367ccf41a8SJoe Perches						     "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev);
36377ccf41a8SJoe Perches					} elsif ((($prev eq 'F' && $cur eq 'F') ||
36387ccf41a8SJoe Perches						  ($prev eq 'X' && $cur eq 'X')) &&
36397ccf41a8SJoe Perches						 ($prevval cmp $curval) > 0) {
36407ccf41a8SJoe Perches						WARN("MAINTAINERS_STYLE",
36417ccf41a8SJoe Perches						     "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev);
36427ccf41a8SJoe Perches					}
36437ccf41a8SJoe Perches				}
36447ccf41a8SJoe Perches			}
36457ccf41a8SJoe Perches		}
3646628f91a2SJoe Perches
3647c68e5878SArnaud Lacombe		if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
3648c68e5878SArnaud Lacombe		    ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
3649c68e5878SArnaud Lacombe			my $flag = $1;
3650c68e5878SArnaud Lacombe			my $replacement = {
3651c68e5878SArnaud Lacombe				'EXTRA_AFLAGS' =>   'asflags-y',
3652c68e5878SArnaud Lacombe				'EXTRA_CFLAGS' =>   'ccflags-y',
3653c68e5878SArnaud Lacombe				'EXTRA_CPPFLAGS' => 'cppflags-y',
3654c68e5878SArnaud Lacombe				'EXTRA_LDFLAGS' =>  'ldflags-y',
3655c68e5878SArnaud Lacombe			};
3656c68e5878SArnaud Lacombe
3657c68e5878SArnaud Lacombe			WARN("DEPRECATED_VARIABLE",
3658c68e5878SArnaud Lacombe			     "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3659c68e5878SArnaud Lacombe		}
3660c68e5878SArnaud Lacombe
3661bff5da43SRob Herring# check for DT compatible documentation
36627dd05b38SFlorian Vaussard		if (defined $root &&
36637dd05b38SFlorian Vaussard			(($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
36647dd05b38SFlorian Vaussard			 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
36657dd05b38SFlorian Vaussard
3666bff5da43SRob Herring			my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
3667bff5da43SRob Herring
3668cc93319bSFlorian Vaussard			my $dt_path = $root . "/Documentation/devicetree/bindings/";
3669852d095dSRob Herring			my $vp_file = $dt_path . "vendor-prefixes.yaml";
3670cc93319bSFlorian Vaussard
3671bff5da43SRob Herring			foreach my $compat (@compats) {
3672bff5da43SRob Herring				my $compat2 = $compat;
3673185d566bSRob Herring				$compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
3674185d566bSRob Herring				my $compat3 = $compat;
3675185d566bSRob Herring				$compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
3676185d566bSRob Herring				`grep -Erq "$compat|$compat2|$compat3" $dt_path`;
3677bff5da43SRob Herring				if ( $? >> 8 ) {
3678bff5da43SRob Herring					WARN("UNDOCUMENTED_DT_STRING",
3679bff5da43SRob Herring					     "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
3680bff5da43SRob Herring				}
3681bff5da43SRob Herring
36824fbf32a6SFlorian Vaussard				next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
36834fbf32a6SFlorian Vaussard				my $vendor = $1;
3684852d095dSRob Herring				`grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`;
3685bff5da43SRob Herring				if ( $? >> 8 ) {
3686bff5da43SRob Herring					WARN("UNDOCUMENTED_DT_STRING",
3687cc93319bSFlorian Vaussard					     "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
3688bff5da43SRob Herring				}
3689bff5da43SRob Herring			}
3690bff5da43SRob Herring		}
3691bff5da43SRob Herring
36929f3a8992SRob Herring# check for using SPDX license tag at beginning of files
36939f3a8992SRob Herring		if ($realline == $checklicenseline) {
36949f3a8992SRob Herring			if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
36959f3a8992SRob Herring				$checklicenseline = 2;
36969f3a8992SRob Herring			} elsif ($rawline =~ /^\+/) {
36979f3a8992SRob Herring				my $comment = "";
36989f3a8992SRob Herring				if ($realfile =~ /\.(h|s|S)$/) {
36999f3a8992SRob Herring					$comment = '/*';
3700d1d84b5fSMiguel Ojeda				} elsif ($realfile =~ /\.(c|rs|dts|dtsi)$/) {
37019f3a8992SRob Herring					$comment = '//';
3702c8df0ab6SLubomir Rintel				} elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) {
37039f3a8992SRob Herring					$comment = '#';
37049f3a8992SRob Herring				} elsif ($realfile =~ /\.rst$/) {
37059f3a8992SRob Herring					$comment = '..';
37069f3a8992SRob Herring				}
37079f3a8992SRob Herring
3708fdf13693SJoe Perches# check SPDX comment style for .[chsS] files
3709fdf13693SJoe Perches				if ($realfile =~ /\.[chsS]$/ &&
3710fdf13693SJoe Perches				    $rawline =~ /SPDX-License-Identifier:/ &&
3711ffbce897SJoe Perches				    $rawline !~ m@^\+\s*\Q$comment\E\s*@) {
3712fdf13693SJoe Perches					WARN("SPDX_LICENSE_TAG",
3713fdf13693SJoe Perches					     "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr);
3714fdf13693SJoe Perches				}
3715fdf13693SJoe Perches
37169f3a8992SRob Herring				if ($comment !~ /^$/ &&
3717ffbce897SJoe Perches				    $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) {
37189f3a8992SRob Herring					WARN("SPDX_LICENSE_TAG",
37199f3a8992SRob Herring					     "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
37203b6e8ac9SJoe Perches				} elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) {
37213b6e8ac9SJoe Perches					my $spdx_license = $1;
37223b6e8ac9SJoe Perches					if (!is_SPDX_License_valid($spdx_license)) {
37233b6e8ac9SJoe Perches						WARN("SPDX_LICENSE_TAG",
37243b6e8ac9SJoe Perches						     "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr);
37253b6e8ac9SJoe Perches					}
372650c92900SLubomir Rintel					if ($realfile =~ m@^Documentation/devicetree/bindings/@ &&
372750c92900SLubomir Rintel					    not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) {
372850c92900SLubomir Rintel						my $msg_level = \&WARN;
372950c92900SLubomir Rintel						$msg_level = \&CHK if ($file);
373050c92900SLubomir Rintel						if (&{$msg_level}("SPDX_LICENSE_TAG",
373150c92900SLubomir Rintel
373250c92900SLubomir Rintel								  "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) &&
373350c92900SLubomir Rintel						    $fix) {
373450c92900SLubomir Rintel							$fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/;
373550c92900SLubomir Rintel						}
373650c92900SLubomir Rintel					}
37379f3a8992SRob Herring				}
37389f3a8992SRob Herring			}
37399f3a8992SRob Herring		}
37409f3a8992SRob Herring
3741a0154cdbSJoe Perches# check for embedded filenames
3742a0154cdbSJoe Perches		if ($rawline =~ /^\+.*\Q$realfile\E/) {
3743a0154cdbSJoe Perches			WARN("EMBEDDED_FILENAME",
3744a0154cdbSJoe Perches			     "It's generally not useful to have the filename in the file\n" . $herecurr);
3745a0154cdbSJoe Perches		}
3746a0154cdbSJoe Perches
37475368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk
3748d1d84b5fSMiguel Ojeda		next if ($realfile !~ /\.(h|c|rs|s|S|sh|dtsi|dts)$/);
37495368df20SAndy Whitcroft
3750a8da38a9SJoe Perches# check for using SPDX-License-Identifier on the wrong line number
3751a8da38a9SJoe Perches		if ($realline != $checklicenseline &&
3752a8da38a9SJoe Perches		    $rawline =~ /\bSPDX-License-Identifier:/ &&
3753a8da38a9SJoe Perches		    substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) {
3754a8da38a9SJoe Perches			WARN("SPDX_LICENSE_TAG",
3755a8da38a9SJoe Perches			     "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr);
3756a8da38a9SJoe Perches		}
3757a8da38a9SJoe Perches
375847e0c88bSJoe Perches# line length limit (with some exclusions)
375947e0c88bSJoe Perches#
376047e0c88bSJoe Perches# There are a few types of lines that may extend beyond $max_line_length:
376147e0c88bSJoe Perches#	logging functions like pr_info that end in a string
376247e0c88bSJoe Perches#	lines with a single string
376347e0c88bSJoe Perches#	#defines that are a single string
37642e4bbbc5SAndreas Brauchli#	lines with an RFC3986 like URL
376547e0c88bSJoe Perches#
376647e0c88bSJoe Perches# There are 3 different line length message types:
3767ab1ecabfSJean Delvare# LONG_LINE_COMMENT	a comment starts before but extends beyond $max_line_length
376847e0c88bSJoe Perches# LONG_LINE_STRING	a string starts before but extends beyond $max_line_length
376947e0c88bSJoe Perches# LONG_LINE		all other lines longer than $max_line_length
377047e0c88bSJoe Perches#
377147e0c88bSJoe Perches# if LONG_LINE is ignored, the other 2 types are also ignored
377247e0c88bSJoe Perches#
377347e0c88bSJoe Perches
3774b4749e96SJoe Perches		if ($line =~ /^\+/ && $length > $max_line_length) {
377547e0c88bSJoe Perches			my $msg_type = "LONG_LINE";
377647e0c88bSJoe Perches
377747e0c88bSJoe Perches			# Check the allowed long line types first
377847e0c88bSJoe Perches
377947e0c88bSJoe Perches			# logging functions that end in a string that starts
378047e0c88bSJoe Perches			# before $max_line_length
378147e0c88bSJoe Perches			if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
378247e0c88bSJoe Perches			    length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
378347e0c88bSJoe Perches				$msg_type = "";
378447e0c88bSJoe Perches
378547e0c88bSJoe Perches			# lines with only strings (w/ possible termination)
378647e0c88bSJoe Perches			# #defines with only strings
378747e0c88bSJoe Perches			} elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
378847e0c88bSJoe Perches				 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
378947e0c88bSJoe Perches				$msg_type = "";
379047e0c88bSJoe Perches
3791cc147506SJoe Perches			# More special cases
3792cc147506SJoe Perches			} elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3793cc147506SJoe Perches				 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
3794d560a5f8SJoe Perches				$msg_type = "";
3795d560a5f8SJoe Perches
37962e4bbbc5SAndreas Brauchli			# URL ($rawline is used in case the URL is in a comment)
37972e4bbbc5SAndreas Brauchli			} elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
37982e4bbbc5SAndreas Brauchli				$msg_type = "";
37992e4bbbc5SAndreas Brauchli
380047e0c88bSJoe Perches			# Otherwise set the alternate message types
380147e0c88bSJoe Perches
380247e0c88bSJoe Perches			# a comment starts before $max_line_length
380347e0c88bSJoe Perches			} elsif ($line =~ /($;[\s$;]*)$/ &&
380447e0c88bSJoe Perches				 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
380547e0c88bSJoe Perches				$msg_type = "LONG_LINE_COMMENT"
380647e0c88bSJoe Perches
380747e0c88bSJoe Perches			# a quoted string starts before $max_line_length
380847e0c88bSJoe Perches			} elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
380947e0c88bSJoe Perches				 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
381047e0c88bSJoe Perches				$msg_type = "LONG_LINE_STRING"
381147e0c88bSJoe Perches			}
381247e0c88bSJoe Perches
381347e0c88bSJoe Perches			if ($msg_type ne "" &&
381447e0c88bSJoe Perches			    (show_type("LONG_LINE") || show_type($msg_type))) {
3815bdc48fa1SJoe Perches				my $msg_level = \&WARN;
3816bdc48fa1SJoe Perches				$msg_level = \&CHK if ($file);
3817bdc48fa1SJoe Perches				&{$msg_level}($msg_type,
3818bdc48fa1SJoe Perches					      "line length of $length exceeds $max_line_length columns\n" . $herecurr);
38190a920b5bSAndy Whitcroft			}
382047e0c88bSJoe Perches		}
38210a920b5bSAndy Whitcroft
38228905a67cSAndy Whitcroft# check for adding lines without a newline.
38238905a67cSAndy Whitcroft		if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
382447ca69b8STom Rix			if (WARN("MISSING_EOF_NEWLINE",
382547ca69b8STom Rix			         "adding a line without newline at end of file\n" . $herecurr) &&
382647ca69b8STom Rix			    $fix) {
382747ca69b8STom Rix				fix_delete_line($fixlinenr+1, "No newline at end of file");
382847ca69b8STom Rix			}
38298905a67cSAndy Whitcroft		}
38308905a67cSAndy Whitcroft
3831de93245cSAditya Srivastava# check for .L prefix local symbols in .S files
3832de93245cSAditya Srivastava		if ($realfile =~ /\.S$/ &&
3833de93245cSAditya Srivastava		    $line =~ /^\+\s*(?:[A-Z]+_)?SYM_[A-Z]+_(?:START|END)(?:_[A-Z_]+)?\s*\(\s*\.L/) {
3834de93245cSAditya Srivastava			WARN("AVOID_L_PREFIX",
3835f4bf1cd4SJonathan Corbet			     "Avoid using '.L' prefixed local symbol names for denoting a range of code via 'SYM_*_START/END' annotations; see Documentation/core-api/asm-annotations.rst\n" . $herecurr);
3836de93245cSAditya Srivastava		}
3837de93245cSAditya Srivastava
3838b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk
3839de4c924cSGeert Uytterhoeven		next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
38400a920b5bSAndy Whitcroft
38410a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything
3842713a09deSAntonio Borneo# more than $tabsize must use tabs.
3843c2fdda0dSAndy Whitcroft		if ($rawline =~ /^\+\s* \t\s*\S/ ||
3844c2fdda0dSAndy Whitcroft		    $rawline =~ /^\+\s*        \s*/) {
3845c2fdda0dSAndy Whitcroft			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3846d2c0a235SAndy Whitcroft			$rpt_cleaners = 1;
38473705ce5bSJoe Perches			if (ERROR("CODE_INDENT",
38483705ce5bSJoe Perches				  "code indent should use tabs where possible\n" . $herevet) &&
38493705ce5bSJoe Perches			    $fix) {
3850194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
38513705ce5bSJoe Perches			}
38520a920b5bSAndy Whitcroft		}
38530a920b5bSAndy Whitcroft
385408e44365SAlberto Panizzo# check for space before tabs.
385508e44365SAlberto Panizzo		if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
385608e44365SAlberto Panizzo			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
38573705ce5bSJoe Perches			if (WARN("SPACE_BEFORE_TAB",
38583705ce5bSJoe Perches				"please, no space before tabs\n" . $herevet) &&
38593705ce5bSJoe Perches			    $fix) {
3860194f66fcSJoe Perches				while ($fixed[$fixlinenr] =~
3861713a09deSAntonio Borneo					   s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {}
3862194f66fcSJoe Perches				while ($fixed[$fixlinenr] =~
3863c76f4cb3SJoe Perches					   s/(^\+.*) +\t/$1\t/) {}
38643705ce5bSJoe Perches			}
386508e44365SAlberto Panizzo		}
386608e44365SAlberto Panizzo
38676a487211SJoe Perches# check for assignments on the start of a line
38686a487211SJoe Perches		if ($sline =~ /^\+\s+($Assignment)[^=]/) {
3869da7355abSAditya Srivastava			my $operator = $1;
3870da7355abSAditya Srivastava			if (CHK("ASSIGNMENT_CONTINUATIONS",
3871da7355abSAditya Srivastava				"Assignment operator '$1' should be on the previous line\n" . $hereprev) &&
3872da7355abSAditya Srivastava			    $fix && $prevrawline =~ /^\+/) {
3873da7355abSAditya Srivastava				# add assignment operator to the previous line, remove from current line
3874da7355abSAditya Srivastava				$fixed[$fixlinenr - 1] .= " $operator";
3875da7355abSAditya Srivastava				$fixed[$fixlinenr] =~ s/\Q$operator\E\s*//;
3876da7355abSAditya Srivastava			}
38776a487211SJoe Perches		}
38786a487211SJoe Perches
3879d1fe9c09SJoe Perches# check for && or || at the start of a line
3880d1fe9c09SJoe Perches		if ($rawline =~ /^\+\s*(&&|\|\|)/) {
38818e08f076SAditya Srivastava			my $operator = $1;
38828e08f076SAditya Srivastava			if (CHK("LOGICAL_CONTINUATIONS",
38838e08f076SAditya Srivastava				"Logical continuations should be on the previous line\n" . $hereprev) &&
38848e08f076SAditya Srivastava			    $fix && $prevrawline =~ /^\+/) {
38858e08f076SAditya Srivastava				# insert logical operator at last non-comment, non-whitepsace char on previous line
38868e08f076SAditya Srivastava				$prevline =~ /[\s$;]*$/;
38878e08f076SAditya Srivastava				my $line_end = substr($prevrawline, $-[0]);
38888e08f076SAditya Srivastava				$fixed[$fixlinenr - 1] =~ s/\Q$line_end\E$/ $operator$line_end/;
38898e08f076SAditya Srivastava				$fixed[$fixlinenr] =~ s/\Q$operator\E\s*//;
38908e08f076SAditya Srivastava			}
3891d1fe9c09SJoe Perches		}
3892d1fe9c09SJoe Perches
3893a91e8994SJoe Perches# check indentation starts on a tab stop
38945b57980dSJoe Perches		if ($perl_version_ok &&
3895bd49111fSJoe Perches		    $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3896a91e8994SJoe Perches			my $indent = length($1);
3897713a09deSAntonio Borneo			if ($indent % $tabsize) {
3898a91e8994SJoe Perches				if (WARN("TABSTOP",
3899a91e8994SJoe Perches					 "Statements should start on a tabstop\n" . $herecurr) &&
3900a91e8994SJoe Perches				    $fix) {
3901713a09deSAntonio Borneo					$fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e;
3902a91e8994SJoe Perches				}
3903a91e8994SJoe Perches			}
3904a91e8994SJoe Perches		}
3905a91e8994SJoe Perches
3906d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line
39075b57980dSJoe Perches		if ($perl_version_ok &&
3908fd71f632SJoe Perches		    $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3909d1fe9c09SJoe Perches			$prevline =~ /^\+(\t*)(.*)$/;
3910d1fe9c09SJoe Perches			my $oldindent = $1;
3911d1fe9c09SJoe Perches			my $rest = $2;
3912d1fe9c09SJoe Perches
3913d1fe9c09SJoe Perches			my $pos = pos_last_openparen($rest);
3914d1fe9c09SJoe Perches			if ($pos >= 0) {
3915b34a26f3SJoe Perches				$line =~ /^(\+| )([ \t]*)/;
3916b34a26f3SJoe Perches				my $newindent = $2;
3917d1fe9c09SJoe Perches
3918d1fe9c09SJoe Perches				my $goodtabindent = $oldindent .
3919713a09deSAntonio Borneo					"\t" x ($pos / $tabsize) .
3920713a09deSAntonio Borneo					" "  x ($pos % $tabsize);
3921d1fe9c09SJoe Perches				my $goodspaceindent = $oldindent . " "  x $pos;
3922d1fe9c09SJoe Perches
3923d1fe9c09SJoe Perches				if ($newindent ne $goodtabindent &&
3924d1fe9c09SJoe Perches				    $newindent ne $goodspaceindent) {
39253705ce5bSJoe Perches
39263705ce5bSJoe Perches					if (CHK("PARENTHESIS_ALIGNMENT",
39273705ce5bSJoe Perches						"Alignment should match open parenthesis\n" . $hereprev) &&
39283705ce5bSJoe Perches					    $fix && $line =~ /^\+/) {
3929194f66fcSJoe Perches						$fixed[$fixlinenr] =~
39303705ce5bSJoe Perches						    s/^\+[ \t]*/\+$goodtabindent/;
39313705ce5bSJoe Perches					}
3932d1fe9c09SJoe Perches				}
3933d1fe9c09SJoe Perches			}
3934d1fe9c09SJoe Perches		}
3935d1fe9c09SJoe Perches
39366ab3a970SJoe Perches# check for space after cast like "(int) foo" or "(struct foo) bar"
39376ab3a970SJoe Perches# avoid checking a few false positives:
39386ab3a970SJoe Perches#   "sizeof(<type>)" or "__alignof__(<type>)"
39396ab3a970SJoe Perches#   function pointer declarations like "(*foo)(int) = bar;"
39406ab3a970SJoe Perches#   structure definitions like "(struct foo) { 0 };"
39416ab3a970SJoe Perches#   multiline macros that define functions
39426ab3a970SJoe Perches#   known attributes or the __attribute__ keyword
39436ab3a970SJoe Perches		if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
39446ab3a970SJoe Perches		    (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
39453705ce5bSJoe Perches			if (CHK("SPACING",
3946f27c95dbSJoe Perches				"No space is necessary after a cast\n" . $herecurr) &&
39473705ce5bSJoe Perches			    $fix) {
3948194f66fcSJoe Perches				$fixed[$fixlinenr] =~
3949f27c95dbSJoe Perches				    s/(\(\s*$Type\s*\))[ \t]+/$1/;
39503705ce5bSJoe Perches			}
3951aad4f614SJoe Perches		}
3952aad4f614SJoe Perches
395386406b1cSJoe Perches# Block comment styles
395486406b1cSJoe Perches# Networking with an initial /*
395505880600SJoe Perches		if ($realfile =~ m@^(drivers/net/|net/)@ &&
3956fdb4bcd6SJoe Perches		    $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
395785ad978cSJoe Perches		    $rawline =~ /^\+[ \t]*\*/ &&
3958c70735c2SŁukasz Stelmach		    $realline > 3) { # Do not warn about the initial copyright comment block after SPDX-License-Identifier
395905880600SJoe Perches			WARN("NETWORKING_BLOCK_COMMENT_STYLE",
396005880600SJoe Perches			     "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
396105880600SJoe Perches		}
396205880600SJoe Perches
396386406b1cSJoe Perches# Block comments use * on subsequent lines
396486406b1cSJoe Perches		if ($prevline =~ /$;[ \t]*$/ &&			#ends in comment
396586406b1cSJoe Perches		    $prevrawline =~ /^\+.*?\/\*/ &&		#starting /*
3966a605e32eSJoe Perches		    $prevrawline !~ /\*\/[ \t]*$/ &&		#no trailing */
396761135e96SJoe Perches		    $rawline =~ /^\+/ &&			#line is new
3968a605e32eSJoe Perches		    $rawline !~ /^\+[ \t]*\*/) {		#no leading *
396986406b1cSJoe Perches			WARN("BLOCK_COMMENT_STYLE",
397086406b1cSJoe Perches			     "Block comments use * on subsequent lines\n" . $hereprev);
3971a605e32eSJoe Perches		}
3972a605e32eSJoe Perches
397386406b1cSJoe Perches# Block comments use */ on trailing lines
397486406b1cSJoe Perches		if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ &&	#trailing */
3975c24f9f19SJoe Perches		    $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ &&	#inline /*...*/
3976c24f9f19SJoe Perches		    $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ &&	#trailing **/
3977c24f9f19SJoe Perches		    $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) {	#non blank */
397886406b1cSJoe Perches			WARN("BLOCK_COMMENT_STYLE",
397986406b1cSJoe Perches			     "Block comments use a trailing */ on a separate line\n" . $herecurr);
398005880600SJoe Perches		}
398105880600SJoe Perches
398208eb9b80SJoe Perches# Block comment * alignment
398308eb9b80SJoe Perches		if ($prevline =~ /$;[ \t]*$/ &&			#ends in comment
3984af207524SJoe Perches		    $line =~ /^\+[ \t]*$;/ &&			#leading comment
3985af207524SJoe Perches		    $rawline =~ /^\+[ \t]*\*/ &&		#leading *
3986af207524SJoe Perches		    (($prevrawline =~ /^\+.*?\/\*/ &&		#leading /*
398708eb9b80SJoe Perches		      $prevrawline !~ /\*\/[ \t]*$/) ||		#no trailing */
3988af207524SJoe Perches		     $prevrawline =~ /^\+[ \t]*\*/)) {		#leading *
3989af207524SJoe Perches			my $oldindent;
399008eb9b80SJoe Perches			$prevrawline =~ m@^\+([ \t]*/?)\*@;
3991af207524SJoe Perches			if (defined($1)) {
3992af207524SJoe Perches				$oldindent = expand_tabs($1);
3993af207524SJoe Perches			} else {
3994af207524SJoe Perches				$prevrawline =~ m@^\+(.*/?)\*@;
3995af207524SJoe Perches				$oldindent = expand_tabs($1);
3996af207524SJoe Perches			}
399708eb9b80SJoe Perches			$rawline =~ m@^\+([ \t]*)\*@;
399808eb9b80SJoe Perches			my $newindent = $1;
399908eb9b80SJoe Perches			$newindent = expand_tabs($newindent);
4000af207524SJoe Perches			if (length($oldindent) ne length($newindent)) {
400108eb9b80SJoe Perches				WARN("BLOCK_COMMENT_STYLE",
400208eb9b80SJoe Perches				     "Block comments should align the * on each line\n" . $hereprev);
400308eb9b80SJoe Perches			}
400408eb9b80SJoe Perches		}
400508eb9b80SJoe Perches
40067f619191SJoe Perches# check for missing blank lines after struct/union declarations
40077f619191SJoe Perches# with exceptions for various attributes and macros
40087f619191SJoe Perches		if ($prevline =~ /^[\+ ]};?\s*$/ &&
40097f619191SJoe Perches		    $line =~ /^\+/ &&
40107f619191SJoe Perches		    !($line =~ /^\+\s*$/ ||
401105dc40e6SJoe Perches		      $line =~ /^\+\s*(?:EXPORT_SYMBOL|early_param)/ ||
40127f619191SJoe Perches		      $line =~ /^\+\s*MODULE_/i ||
40137f619191SJoe Perches		      $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
40147f619191SJoe Perches		      $line =~ /^\+[a-z_]*init/ ||
40157f619191SJoe Perches		      $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
40167f619191SJoe Perches		      $line =~ /^\+\s*DECLARE/ ||
40170bc989ffSMasahiro Yamada		      $line =~ /^\+\s*builtin_[\w_]*driver/ ||
40187f619191SJoe Perches		      $line =~ /^\+\s*__setup/)) {
4019d752fcc8SJoe Perches			if (CHK("LINE_SPACING",
4020d752fcc8SJoe Perches				"Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
4021d752fcc8SJoe Perches			    $fix) {
4022f2d7e4d4SJoe Perches				fix_insert_line($fixlinenr, "\+");
4023d752fcc8SJoe Perches			}
40247f619191SJoe Perches		}
40257f619191SJoe Perches
4026365dd4eaSJoe Perches# check for multiple consecutive blank lines
4027365dd4eaSJoe Perches		if ($prevline =~ /^[\+ ]\s*$/ &&
4028365dd4eaSJoe Perches		    $line =~ /^\+\s*$/ &&
4029365dd4eaSJoe Perches		    $last_blank_line != ($linenr - 1)) {
4030d752fcc8SJoe Perches			if (CHK("LINE_SPACING",
4031d752fcc8SJoe Perches				"Please don't use multiple blank lines\n" . $hereprev) &&
4032d752fcc8SJoe Perches			    $fix) {
4033f2d7e4d4SJoe Perches				fix_delete_line($fixlinenr, $rawline);
4034d752fcc8SJoe Perches			}
4035d752fcc8SJoe Perches
4036365dd4eaSJoe Perches			$last_blank_line = $linenr;
4037365dd4eaSJoe Perches		}
4038365dd4eaSJoe Perches
40393b617e3bSJoe Perches# check for missing blank lines after declarations
4040b5e8736aSJoe Perches# (declarations must have the same indentation and not be at the start of line)
4041b5e8736aSJoe Perches		if (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/) {
4042b5e8736aSJoe Perches			# use temporaries
4043b5e8736aSJoe Perches			my $sl = $sline;
4044b5e8736aSJoe Perches			my $pl = $prevline;
4045b5e8736aSJoe Perches			# remove $Attribute/$Sparse uses to simplify comparisons
4046b5e8736aSJoe Perches			$sl =~ s/\b(?:$Attribute|$Sparse)\b//g;
4047b5e8736aSJoe Perches			$pl =~ s/\b(?:$Attribute|$Sparse)\b//g;
4048b5e8736aSJoe Perches			if (($pl =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
40495a4e1fd3SJoe Perches			# function pointer declarations
4050b5e8736aSJoe Perches			     $pl =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
40513f7bac03SJoe Perches			# foo bar; where foo is some local typedef or #define
4052b5e8736aSJoe Perches			     $pl =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
40533f7bac03SJoe Perches			# known declaration macros
4054b5e8736aSJoe Perches			     $pl =~ /^\+\s+$declaration_macros/) &&
40553f7bac03SJoe Perches			# for "else if" which can look like "$Ident $Ident"
4056b5e8736aSJoe Perches			    !($pl =~ /^\+\s+$c90_Keywords\b/ ||
40573f7bac03SJoe Perches			# other possible extensions of declaration lines
4058b5e8736aSJoe Perches			      $pl =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
40593f7bac03SJoe Perches			# not starting a section or a macro "\" extended line
4060b5e8736aSJoe Perches			      $pl =~ /(?:\{\s*|\\)$/) &&
40613f7bac03SJoe Perches			# looks like a declaration
4062b5e8736aSJoe Perches			    !($sl =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
40635a4e1fd3SJoe Perches			# function pointer declarations
4064b5e8736aSJoe Perches			      $sl =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
40653f7bac03SJoe Perches			# foo bar; where foo is some local typedef or #define
4066b5e8736aSJoe Perches			      $sl =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
40673f7bac03SJoe Perches			# known declaration macros
4068b5e8736aSJoe Perches			      $sl =~ /^\+\s+$declaration_macros/ ||
40693f7bac03SJoe Perches			# start of struct or union or enum
4070b5e8736aSJoe Perches			      $sl =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ ||
40713f7bac03SJoe Perches			# start or end of block or continuation of declaration
4072b5e8736aSJoe Perches			      $sl =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
40733f7bac03SJoe Perches			# bitfield continuation
4074b5e8736aSJoe Perches			      $sl =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
40753f7bac03SJoe Perches			# other possible extensions of declaration lines
4076b5e8736aSJoe Perches			      $sl =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/)) {
4077d752fcc8SJoe Perches				if (WARN("LINE_SPACING",
4078d752fcc8SJoe Perches					 "Missing a blank line after declarations\n" . $hereprev) &&
4079d752fcc8SJoe Perches				    $fix) {
4080f2d7e4d4SJoe Perches					fix_insert_line($fixlinenr, "\+");
4081d752fcc8SJoe Perches				}
40823b617e3bSJoe Perches			}
4083b5e8736aSJoe Perches		}
40843b617e3bSJoe Perches
40855f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line.
40866b4c5bebSAndy Whitcroft# Exceptions:
40876b4c5bebSAndy Whitcroft#  1) within comments
40886b4c5bebSAndy Whitcroft#  2) indented preprocessor commands
40896b4c5bebSAndy Whitcroft#  3) hanging labels
40903705ce5bSJoe Perches		if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/)  {
40915f7ddae6SRaffaele Recalcati			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
40923705ce5bSJoe Perches			if (WARN("LEADING_SPACE",
40933705ce5bSJoe Perches				 "please, no spaces at the start of a line\n" . $herevet) &&
40943705ce5bSJoe Perches			    $fix) {
4095194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
40963705ce5bSJoe Perches			}
40975f7ddae6SRaffaele Recalcati		}
40985f7ddae6SRaffaele Recalcati
4099b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk
4100b9ea10d6SAndy Whitcroft		next if ($realfile !~ /\.(h|c)$/);
4101b9ea10d6SAndy Whitcroft
41025751a24eSJoe Perches# check for unusual line ending [ or (
41035751a24eSJoe Perches		if ($line =~ /^\+.*([\[\(])\s*$/) {
41045751a24eSJoe Perches			CHK("OPEN_ENDED_LINE",
41055751a24eSJoe Perches			    "Lines should not end with a '$1'\n" . $herecurr);
41065751a24eSJoe Perches		}
41075751a24eSJoe Perches
41084dbed76fSJoe Perches# check if this appears to be the start function declaration, save the name
41094dbed76fSJoe Perches		if ($sline =~ /^\+\{\s*$/ &&
41104dbed76fSJoe Perches		    $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
41114dbed76fSJoe Perches			$context_function = $1;
41124dbed76fSJoe Perches		}
41134dbed76fSJoe Perches
41144dbed76fSJoe Perches# check if this appears to be the end of function declaration
41154dbed76fSJoe Perches		if ($sline =~ /^\+\}\s*$/) {
41164dbed76fSJoe Perches			undef $context_function;
41174dbed76fSJoe Perches		}
41184dbed76fSJoe Perches
4119032a4c0fSJoe Perches# check indentation of any line with a bare else
4120840080a0SJoe Perches# (but not if it is a multiple line "if (foo) return bar; else return baz;")
4121032a4c0fSJoe Perches# if the previous line is a break or return and is indented 1 tab more...
4122032a4c0fSJoe Perches		if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
4123032a4c0fSJoe Perches			my $tabs = length($1) + 1;
4124840080a0SJoe Perches			if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
4125840080a0SJoe Perches			    ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
4126840080a0SJoe Perches			     defined $lines[$linenr] &&
4127840080a0SJoe Perches			     $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
4128032a4c0fSJoe Perches				WARN("UNNECESSARY_ELSE",
4129032a4c0fSJoe Perches				     "else is not generally useful after a break or return\n" . $hereprev);
4130032a4c0fSJoe Perches			}
4131032a4c0fSJoe Perches		}
4132032a4c0fSJoe Perches
4133c00df19aSJoe Perches# check indentation of a line with a break;
4134dc58bc55SJoe Perches# if the previous line is a goto, return or break
4135dc58bc55SJoe Perches# and is indented the same # of tabs
4136c00df19aSJoe Perches		if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
4137c00df19aSJoe Perches			my $tabs = $1;
4138dc58bc55SJoe Perches			if ($prevline =~ /^\+$tabs(goto|return|break)\b/) {
4139dc58bc55SJoe Perches				if (WARN("UNNECESSARY_BREAK",
4140dc58bc55SJoe Perches					 "break is not useful after a $1\n" . $hereprev) &&
4141dc58bc55SJoe Perches				    $fix) {
4142dc58bc55SJoe Perches					fix_delete_line($fixlinenr, $rawline);
4143dc58bc55SJoe Perches				}
4144c00df19aSJoe Perches			}
4145c00df19aSJoe Perches		}
4146c00df19aSJoe Perches
4147c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers
4148cf655043SAndy Whitcroft		if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
4149000d1cc1SJoe Perches			WARN("CVS_KEYWORD",
4150000d1cc1SJoe Perches			     "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
4151c2fdda0dSAndy Whitcroft		}
415222f2a2efSAndy Whitcroft
415356e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings
415456e77d70SJoe Perches		if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
415556e77d70SJoe Perches			WARN("HOTPLUG_SECTION",
415656e77d70SJoe Perches			     "Using $1 is unnecessary\n" . $herecurr);
415756e77d70SJoe Perches		}
415856e77d70SJoe Perches
41599c0ca6f9SAndy Whitcroft# Check for potential 'bare' types
41602b474a1aSAndy Whitcroft		my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
41612b474a1aSAndy Whitcroft		    $realline_next);
41623e469cdcSAndy Whitcroft#print "LINE<$line>\n";
4163ca819864SJoe Perches		if ($linenr > $suppress_statement &&
41641b5539b1SJoe Perches		    $realcnt && $sline =~ /.\s*\S/) {
4165170d3a22SAndy Whitcroft			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4166f5fe35ddSAndy Whitcroft				ctx_statement_block($linenr, $realcnt, 0);
4167171ae1a4SAndy Whitcroft			$stat =~ s/\n./\n /g;
4168171ae1a4SAndy Whitcroft			$cond =~ s/\n./\n /g;
4169171ae1a4SAndy Whitcroft
41703e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n";
41713e469cdcSAndy Whitcroft			# If this statement has no statement boundaries within
41723e469cdcSAndy Whitcroft			# it there is no point in retrying a statement scan
41733e469cdcSAndy Whitcroft			# until we hit end of it.
41743e469cdcSAndy Whitcroft			my $frag = $stat; $frag =~ s/;+\s*$//;
41753e469cdcSAndy Whitcroft			if ($frag !~ /(?:{|;)/) {
41763e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n";
41773e469cdcSAndy Whitcroft				$suppress_statement = $line_nr_next;
41783e469cdcSAndy Whitcroft			}
4179f74bd194SAndy Whitcroft
41802b474a1aSAndy Whitcroft			# Find the real next line.
41812b474a1aSAndy Whitcroft			$realline_next = $line_nr_next;
41822b474a1aSAndy Whitcroft			if (defined $realline_next &&
41832b474a1aSAndy Whitcroft			    (!defined $lines[$realline_next - 1] ||
41842b474a1aSAndy Whitcroft			     substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
41852b474a1aSAndy Whitcroft				$realline_next++;
41862b474a1aSAndy Whitcroft			}
41872b474a1aSAndy Whitcroft
4188171ae1a4SAndy Whitcroft			my $s = $stat;
4189171ae1a4SAndy Whitcroft			$s =~ s/{.*$//s;
4190cf655043SAndy Whitcroft
4191c2fdda0dSAndy Whitcroft			# Ignore goto labels.
4192171ae1a4SAndy Whitcroft			if ($s =~ /$Ident:\*$/s) {
4193c2fdda0dSAndy Whitcroft
4194c2fdda0dSAndy Whitcroft			# Ignore functions being called
4195171ae1a4SAndy Whitcroft			} elsif ($s =~ /^.\s*$Ident\s*\(/s) {
4196c2fdda0dSAndy Whitcroft
4197463f2864SAndy Whitcroft			} elsif ($s =~ /^.\s*else\b/s) {
4198463f2864SAndy Whitcroft
4199c45dcabdSAndy Whitcroft			# declarations always start with types
4200d2506586SAndy 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) {
4201c45dcabdSAndy Whitcroft				my $type = $1;
4202c45dcabdSAndy Whitcroft				$type =~ s/\s+/ /g;
4203c45dcabdSAndy Whitcroft				possible($type, "A:" . $s);
4204c45dcabdSAndy Whitcroft
42056c72ffaaSAndy Whitcroft			# definitions in global scope can only start with types
4206a6a84062SAndy Whitcroft			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
4207c45dcabdSAndy Whitcroft				possible($1, "B:" . $s);
4208c2fdda0dSAndy Whitcroft			}
42098905a67cSAndy Whitcroft
42106c72ffaaSAndy Whitcroft			# any (foo ... *) is a pointer cast, and foo is a type
421165863862SAndy Whitcroft			while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
4212c45dcabdSAndy Whitcroft				possible($1, "C:" . $s);
42139c0ca6f9SAndy Whitcroft			}
42148905a67cSAndy Whitcroft
42158905a67cSAndy Whitcroft			# Check for any sort of function declaration.
42168905a67cSAndy Whitcroft			# int foo(something bar, other baz);
42178905a67cSAndy Whitcroft			# void (*store_gdt)(x86_descr_ptr *);
4218171ae1a4SAndy Whitcroft			if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
42198905a67cSAndy Whitcroft				my ($name_len) = length($1);
42208905a67cSAndy Whitcroft
4221cf655043SAndy Whitcroft				my $ctx = $s;
4222773647a0SAndy Whitcroft				substr($ctx, 0, $name_len + 1, '');
42238905a67cSAndy Whitcroft				$ctx =~ s/\)[^\)]*$//;
4224cf655043SAndy Whitcroft
42258905a67cSAndy Whitcroft				for my $arg (split(/\s*,\s*/, $ctx)) {
4226c45dcabdSAndy Whitcroft					if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
42278905a67cSAndy Whitcroft
4228c45dcabdSAndy Whitcroft						possible($1, "D:" . $s);
42298905a67cSAndy Whitcroft					}
42308905a67cSAndy Whitcroft				}
42318905a67cSAndy Whitcroft			}
42328905a67cSAndy Whitcroft
42339c0ca6f9SAndy Whitcroft		}
42349c0ca6f9SAndy Whitcroft
423500df344fSAndy Whitcroft#
423600df344fSAndy Whitcroft# Checks which may be anchored in the context.
423700df344fSAndy Whitcroft#
423800df344fSAndy Whitcroft
423900df344fSAndy Whitcroft# Check for switch () and associated case and default
424000df344fSAndy Whitcroft# statements should be at the same indent.
424100df344fSAndy Whitcroft		if ($line=~/\bswitch\s*\(.*\)/) {
424200df344fSAndy Whitcroft			my $err = '';
424300df344fSAndy Whitcroft			my $sep = '';
424400df344fSAndy Whitcroft			my @ctx = ctx_block_outer($linenr, $realcnt);
424500df344fSAndy Whitcroft			shift(@ctx);
424600df344fSAndy Whitcroft			for my $ctx (@ctx) {
424700df344fSAndy Whitcroft				my ($clen, $cindent) = line_stats($ctx);
424800df344fSAndy Whitcroft				if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
424900df344fSAndy Whitcroft							$indent != $cindent) {
425000df344fSAndy Whitcroft					$err .= "$sep$ctx\n";
425100df344fSAndy Whitcroft					$sep = '';
425200df344fSAndy Whitcroft				} else {
425300df344fSAndy Whitcroft					$sep = "[...]\n";
425400df344fSAndy Whitcroft				}
425500df344fSAndy Whitcroft			}
425600df344fSAndy Whitcroft			if ($err ne '') {
4257000d1cc1SJoe Perches				ERROR("SWITCH_CASE_INDENT_LEVEL",
4258000d1cc1SJoe Perches				      "switch and case should be at the same indent\n$hereline$err");
4259de7d4f0eSAndy Whitcroft			}
4260de7d4f0eSAndy Whitcroft		}
4261de7d4f0eSAndy Whitcroft
4262de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop,
4263de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else
42640fe3dc2bSJoe Perches		if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
4265773647a0SAndy Whitcroft			my $pre_ctx = "$1$2";
4266773647a0SAndy Whitcroft
42679c0ca6f9SAndy Whitcroft			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
42688eef05ddSJoe Perches
42698eef05ddSJoe Perches			if ($line =~ /^\+\t{6,}/) {
42708eef05ddSJoe Perches				WARN("DEEP_INDENTATION",
42718eef05ddSJoe Perches				     "Too many leading tabs - consider code refactoring\n" . $herecurr);
42728eef05ddSJoe Perches			}
42738eef05ddSJoe Perches
4274de7d4f0eSAndy Whitcroft			my $ctx_cnt = $realcnt - $#ctx - 1;
4275de7d4f0eSAndy Whitcroft			my $ctx = join("\n", @ctx);
4276de7d4f0eSAndy Whitcroft
4277548596d5SAndy Whitcroft			my $ctx_ln = $linenr;
4278548596d5SAndy Whitcroft			my $ctx_skip = $realcnt;
4279de7d4f0eSAndy Whitcroft
4280548596d5SAndy Whitcroft			while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
4281548596d5SAndy Whitcroft					defined $lines[$ctx_ln - 1] &&
4282548596d5SAndy Whitcroft					$lines[$ctx_ln - 1] =~ /^-/)) {
4283548596d5SAndy Whitcroft				##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
4284548596d5SAndy Whitcroft				$ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
4285773647a0SAndy Whitcroft				$ctx_ln++;
4286773647a0SAndy Whitcroft			}
4287548596d5SAndy Whitcroft
428853210168SAndy Whitcroft			#print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
428953210168SAndy Whitcroft			#print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
4290773647a0SAndy Whitcroft
4291773647a0SAndy Whitcroft			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
4292000d1cc1SJoe Perches				ERROR("OPEN_BRACE",
4293000d1cc1SJoe Perches				      "that open brace { should be on the previous line\n" .
429401464f30SAndy Whitcroft					"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
429500df344fSAndy Whitcroft			}
4296773647a0SAndy Whitcroft			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
4297773647a0SAndy Whitcroft			    $ctx =~ /\)\s*\;\s*$/ &&
4298773647a0SAndy Whitcroft			    defined $lines[$ctx_ln - 1])
4299773647a0SAndy Whitcroft			{
43009c0ca6f9SAndy Whitcroft				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
43019c0ca6f9SAndy Whitcroft				if ($nindent > $indent) {
4302000d1cc1SJoe Perches					WARN("TRAILING_SEMICOLON",
4303000d1cc1SJoe Perches					     "trailing semicolon indicates no statements, indent implies otherwise\n" .
430401464f30SAndy Whitcroft						"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
43059c0ca6f9SAndy Whitcroft				}
43069c0ca6f9SAndy Whitcroft			}
430700df344fSAndy Whitcroft		}
430800df344fSAndy Whitcroft
43094d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks.
4310f6950a73SJoe Perches		if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
43113e469cdcSAndy Whitcroft			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
43123e469cdcSAndy Whitcroft				ctx_statement_block($linenr, $realcnt, 0)
43133e469cdcSAndy Whitcroft					if (!defined $stat);
43144d001e4dSAndy Whitcroft			my ($s, $c) = ($stat, $cond);
43154d001e4dSAndy Whitcroft
43164d001e4dSAndy Whitcroft			substr($s, 0, length($c), '');
43174d001e4dSAndy Whitcroft
43189f5af480SJoe Perches			# remove inline comments
43199f5af480SJoe Perches			$s =~ s/$;/ /g;
43209f5af480SJoe Perches			$c =~ s/$;/ /g;
43214d001e4dSAndy Whitcroft
43224d001e4dSAndy Whitcroft			# Find out how long the conditional actually is.
43236f779c18SAndy Whitcroft			my @newlines = ($c =~ /\n/gs);
43246f779c18SAndy Whitcroft			my $cond_lines = 1 + $#newlines;
43254d001e4dSAndy Whitcroft
43269f5af480SJoe Perches			# Make sure we remove the line prefixes as we have
43279f5af480SJoe Perches			# none on the first line, and are going to readd them
43289f5af480SJoe Perches			# where necessary.
43299f5af480SJoe Perches			$s =~ s/\n./\n/gs;
43309f5af480SJoe Perches			while ($s =~ /\n\s+\\\n/) {
43319f5af480SJoe Perches				$cond_lines += $s =~ s/\n\s+\\\n/\n/g;
43329f5af480SJoe Perches			}
43339f5af480SJoe Perches
43344d001e4dSAndy Whitcroft			# We want to check the first line inside the block
43354d001e4dSAndy Whitcroft			# starting at the end of the conditional, so remove:
43364d001e4dSAndy Whitcroft			#  1) any blank line termination
43374d001e4dSAndy Whitcroft			#  2) any opening brace { on end of the line
43384d001e4dSAndy Whitcroft			#  3) any do (...) {
43394d001e4dSAndy Whitcroft			my $continuation = 0;
43404d001e4dSAndy Whitcroft			my $check = 0;
43414d001e4dSAndy Whitcroft			$s =~ s/^.*\bdo\b//;
43424d001e4dSAndy Whitcroft			$s =~ s/^\s*{//;
43434d001e4dSAndy Whitcroft			if ($s =~ s/^\s*\\//) {
43444d001e4dSAndy Whitcroft				$continuation = 1;
43454d001e4dSAndy Whitcroft			}
43469bd49efeSAndy Whitcroft			if ($s =~ s/^\s*?\n//) {
43474d001e4dSAndy Whitcroft				$check = 1;
43484d001e4dSAndy Whitcroft				$cond_lines++;
43494d001e4dSAndy Whitcroft			}
43504d001e4dSAndy Whitcroft
43514d001e4dSAndy Whitcroft			# Also ignore a loop construct at the end of a
43524d001e4dSAndy Whitcroft			# preprocessor statement.
43534d001e4dSAndy Whitcroft			if (($prevline =~ /^.\s*#\s*define\s/ ||
43544d001e4dSAndy Whitcroft			    $prevline =~ /\\\s*$/) && $continuation == 0) {
43554d001e4dSAndy Whitcroft				$check = 0;
43564d001e4dSAndy Whitcroft			}
43574d001e4dSAndy Whitcroft
43589bd49efeSAndy Whitcroft			my $cond_ptr = -1;
4359740504c6SAndy Whitcroft			$continuation = 0;
43609bd49efeSAndy Whitcroft			while ($cond_ptr != $cond_lines) {
43619bd49efeSAndy Whitcroft				$cond_ptr = $cond_lines;
43624d001e4dSAndy Whitcroft
4363f16fa28fSAndy Whitcroft				# If we see an #else/#elif then the code
4364f16fa28fSAndy Whitcroft				# is not linear.
4365f16fa28fSAndy Whitcroft				if ($s =~ /^\s*\#\s*(?:else|elif)/) {
4366f16fa28fSAndy Whitcroft					$check = 0;
4367f16fa28fSAndy Whitcroft				}
4368f16fa28fSAndy Whitcroft
43699bd49efeSAndy Whitcroft				# Ignore:
43709bd49efeSAndy Whitcroft				#  1) blank lines, they should be at 0,
43719bd49efeSAndy Whitcroft				#  2) preprocessor lines, and
43729bd49efeSAndy Whitcroft				#  3) labels.
4373740504c6SAndy Whitcroft				if ($continuation ||
4374740504c6SAndy Whitcroft				    $s =~ /^\s*?\n/ ||
43759bd49efeSAndy Whitcroft				    $s =~ /^\s*#\s*?/ ||
43769bd49efeSAndy Whitcroft				    $s =~ /^\s*$Ident\s*:/) {
4377740504c6SAndy Whitcroft					$continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
437830dad6ebSAndy Whitcroft					if ($s =~ s/^.*?\n//) {
43799bd49efeSAndy Whitcroft						$cond_lines++;
43809bd49efeSAndy Whitcroft					}
43814d001e4dSAndy Whitcroft				}
438230dad6ebSAndy Whitcroft			}
43834d001e4dSAndy Whitcroft
43844d001e4dSAndy Whitcroft			my (undef, $sindent) = line_stats("+" . $s);
43854d001e4dSAndy Whitcroft			my $stat_real = raw_line($linenr, $cond_lines);
43864d001e4dSAndy Whitcroft
43874d001e4dSAndy Whitcroft			# Check if either of these lines are modified, else
43884d001e4dSAndy Whitcroft			# this is not this patch's fault.
43894d001e4dSAndy Whitcroft			if (!defined($stat_real) ||
43904d001e4dSAndy Whitcroft			    $stat !~ /^\+/ && $stat_real !~ /^\+/) {
43914d001e4dSAndy Whitcroft				$check = 0;
43924d001e4dSAndy Whitcroft			}
43934d001e4dSAndy Whitcroft			if (defined($stat_real) && $cond_lines > 1) {
43944d001e4dSAndy Whitcroft				$stat_real = "[...]\n$stat_real";
43954d001e4dSAndy Whitcroft			}
43964d001e4dSAndy Whitcroft
43979bd49efeSAndy 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";
43984d001e4dSAndy Whitcroft
43999f5af480SJoe Perches			if ($check && $s ne '' &&
4400713a09deSAntonio Borneo			    (($sindent % $tabsize) != 0 ||
44019f5af480SJoe Perches			     ($sindent < $indent) ||
4402f6950a73SJoe Perches			     ($sindent == $indent &&
4403f6950a73SJoe Perches			      ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
4404713a09deSAntonio Borneo			     ($sindent > $indent + $tabsize))) {
4405000d1cc1SJoe Perches				WARN("SUSPECT_CODE_INDENT",
4406000d1cc1SJoe Perches				     "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
44074d001e4dSAndy Whitcroft			}
44084d001e4dSAndy Whitcroft		}
44094d001e4dSAndy Whitcroft
44106c72ffaaSAndy Whitcroft		# Track the 'values' across context and added lines.
44116c72ffaaSAndy Whitcroft		my $opline = $line; $opline =~ s/^./ /;
44121f65f947SAndy Whitcroft		my ($curr_values, $curr_vars) =
44131f65f947SAndy Whitcroft				annotate_values($opline . "\n", $prev_values);
44146c72ffaaSAndy Whitcroft		$curr_values = $prev_values . $curr_values;
4415c2fdda0dSAndy Whitcroft		if ($dbg_values) {
4416c2fdda0dSAndy Whitcroft			my $outline = $opline; $outline =~ s/\t/ /g;
4417cf655043SAndy Whitcroft			print "$linenr > .$outline\n";
4418cf655043SAndy Whitcroft			print "$linenr > $curr_values\n";
44191f65f947SAndy Whitcroft			print "$linenr >  $curr_vars\n";
4420c2fdda0dSAndy Whitcroft		}
44216c72ffaaSAndy Whitcroft		$prev_values = substr($curr_values, -1);
44226c72ffaaSAndy Whitcroft
442300df344fSAndy Whitcroft#ignore lines not being added
44243705ce5bSJoe Perches		next if ($line =~ /^[^\+]/);
442500df344fSAndy Whitcroft
442699ca38c2SJoe Perches# check for self assignments used to avoid compiler warnings
442799ca38c2SJoe Perches# e.g.:	int foo = foo, *bar = NULL;
442899ca38c2SJoe Perches#	struct foo bar = *(&(bar));
442999ca38c2SJoe Perches		if ($line =~ /^\+\s*(?:$Declare)?([A-Za-z_][A-Za-z\d_]*)\s*=/) {
443099ca38c2SJoe Perches			my $var = $1;
443199ca38c2SJoe Perches			if ($line =~ /^\+\s*(?:$Declare)?$var\s*=\s*(?:$var|\*\s*\(?\s*&\s*\(?\s*$var\s*\)?\s*\)?)\s*[;,]/) {
443299ca38c2SJoe Perches				WARN("SELF_ASSIGNMENT",
443399ca38c2SJoe Perches				     "Do not use self-assignments to avoid compiler warnings\n" . $herecurr);
443499ca38c2SJoe Perches			}
443599ca38c2SJoe Perches		}
443699ca38c2SJoe Perches
443711ca40a0SJoe Perches# check for dereferences that span multiple lines
443811ca40a0SJoe Perches		if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
443911ca40a0SJoe Perches		    $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
444011ca40a0SJoe Perches			$prevline =~ /($Lval\s*(?:\.|->))\s*$/;
444111ca40a0SJoe Perches			my $ref = $1;
444211ca40a0SJoe Perches			$line =~ /^.\s*($Lval)/;
444311ca40a0SJoe Perches			$ref .= $1;
444411ca40a0SJoe Perches			$ref =~ s/\s//g;
444511ca40a0SJoe Perches			WARN("MULTILINE_DEREFERENCE",
444611ca40a0SJoe Perches			     "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
444711ca40a0SJoe Perches		}
444811ca40a0SJoe Perches
4449a1ce18e4SJoe Perches# check for declarations of signed or unsigned without int
4450c8447115SJoe Perches		while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
4451a1ce18e4SJoe Perches			my $type = $1;
4452a1ce18e4SJoe Perches			my $var = $2;
4453207a8e84SJoe Perches			$var = "" if (!defined $var);
4454207a8e84SJoe Perches			if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
4455a1ce18e4SJoe Perches				my $sign = $1;
4456a1ce18e4SJoe Perches				my $pointer = $2;
4457a1ce18e4SJoe Perches
4458a1ce18e4SJoe Perches				$pointer = "" if (!defined $pointer);
4459a1ce18e4SJoe Perches
4460a1ce18e4SJoe Perches				if (WARN("UNSPECIFIED_INT",
4461a1ce18e4SJoe Perches					 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
4462a1ce18e4SJoe Perches				    $fix) {
4463a1ce18e4SJoe Perches					my $decl = trim($sign) . " int ";
4464207a8e84SJoe Perches					my $comp_pointer = $pointer;
4465207a8e84SJoe Perches					$comp_pointer =~ s/\s//g;
4466207a8e84SJoe Perches					$decl .= $comp_pointer;
4467207a8e84SJoe Perches					$decl = rtrim($decl) if ($var eq "");
4468207a8e84SJoe Perches					$fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
4469a1ce18e4SJoe Perches				}
4470a1ce18e4SJoe Perches			}
4471a1ce18e4SJoe Perches		}
4472a1ce18e4SJoe Perches
4473653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher.
44747429c690SAndy Whitcroft		if ($dbg_type) {
44757429c690SAndy Whitcroft			if ($line =~ /^.\s*$Declare\s*$/) {
4476000d1cc1SJoe Perches				ERROR("TEST_TYPE",
4477000d1cc1SJoe Perches				      "TEST: is type\n" . $herecurr);
44787429c690SAndy Whitcroft			} elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
4479000d1cc1SJoe Perches				ERROR("TEST_NOT_TYPE",
4480000d1cc1SJoe Perches				      "TEST: is not type ($1 is)\n". $herecurr);
44817429c690SAndy Whitcroft			}
4482653d4876SAndy Whitcroft			next;
4483653d4876SAndy Whitcroft		}
4484a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher.
4485a1ef277eSAndy Whitcroft		if ($dbg_attr) {
44869360b0e5SAndy Whitcroft			if ($line =~ /^.\s*$Modifier\s*$/) {
4487000d1cc1SJoe Perches				ERROR("TEST_ATTR",
4488000d1cc1SJoe Perches				      "TEST: is attr\n" . $herecurr);
44899360b0e5SAndy Whitcroft			} elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
4490000d1cc1SJoe Perches				ERROR("TEST_NOT_ATTR",
4491000d1cc1SJoe Perches				      "TEST: is not attr ($1 is)\n". $herecurr);
4492a1ef277eSAndy Whitcroft			}
4493a1ef277eSAndy Whitcroft			next;
4494a1ef277eSAndy Whitcroft		}
4495653d4876SAndy Whitcroft
4496f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line
449799423c20SAndy Whitcroft		if ($line =~ /^.\s*{/ &&
449899423c20SAndy Whitcroft		    $prevline =~ /(?:^|[^=])=\s*$/) {
4499d752fcc8SJoe Perches			if (ERROR("OPEN_BRACE",
4500d752fcc8SJoe Perches				  "that open brace { should be on the previous line\n" . $hereprev) &&
4501f2d7e4d4SJoe Perches			    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4502f2d7e4d4SJoe Perches				fix_delete_line($fixlinenr - 1, $prevrawline);
4503f2d7e4d4SJoe Perches				fix_delete_line($fixlinenr, $rawline);
4504d752fcc8SJoe Perches				my $fixedline = $prevrawline;
4505d752fcc8SJoe Perches				$fixedline =~ s/\s*=\s*$/ = {/;
4506f2d7e4d4SJoe Perches				fix_insert_line($fixlinenr, $fixedline);
4507d752fcc8SJoe Perches				$fixedline = $line;
45088d81ae05SCyril Bur				$fixedline =~ s/^(.\s*)\{\s*/$1/;
4509f2d7e4d4SJoe Perches				fix_insert_line($fixlinenr, $fixedline);
4510d752fcc8SJoe Perches			}
4511f0a594c1SAndy Whitcroft		}
4512f0a594c1SAndy Whitcroft
451300df344fSAndy Whitcroft#
451400df344fSAndy Whitcroft# Checks which are anchored on the added line.
451500df344fSAndy Whitcroft#
451600df344fSAndy Whitcroft
4517653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line)
4518c45dcabdSAndy Whitcroft		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
4519653d4876SAndy Whitcroft			my $path = $1;
4520653d4876SAndy Whitcroft			if ($path =~ m{//}) {
4521000d1cc1SJoe Perches				ERROR("MALFORMED_INCLUDE",
4522495e9d84SJoe Perches				      "malformed #include filename\n" . $herecurr);
4523495e9d84SJoe Perches			}
4524495e9d84SJoe Perches			if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
4525495e9d84SJoe Perches				ERROR("UAPI_INCLUDE",
4526495e9d84SJoe Perches				      "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
4527653d4876SAndy Whitcroft			}
4528653d4876SAndy Whitcroft		}
4529653d4876SAndy Whitcroft
453000df344fSAndy Whitcroft# no C99 // comments
453100df344fSAndy Whitcroft		if ($line =~ m{//}) {
45323705ce5bSJoe Perches			if (ERROR("C99_COMMENTS",
45333705ce5bSJoe Perches				  "do not use C99 // comments\n" . $herecurr) &&
45343705ce5bSJoe Perches			    $fix) {
4535194f66fcSJoe Perches				my $line = $fixed[$fixlinenr];
45363705ce5bSJoe Perches				if ($line =~ /\/\/(.*)$/) {
45373705ce5bSJoe Perches					my $comment = trim($1);
4538194f66fcSJoe Perches					$fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
45393705ce5bSJoe Perches				}
45403705ce5bSJoe Perches			}
454100df344fSAndy Whitcroft		}
454200df344fSAndy Whitcroft		# Remove C99 comments.
45430a920b5bSAndy Whitcroft		$line =~ s@//.*@@;
45446c72ffaaSAndy Whitcroft		$opline =~ s@//.*@@;
45450a920b5bSAndy Whitcroft
45462b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
45472b474a1aSAndy Whitcroft# the whole statement.
45482b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n";
45492b474a1aSAndy Whitcroft		if (defined $realline_next &&
45502b474a1aSAndy Whitcroft		    exists $lines[$realline_next - 1] &&
45512b474a1aSAndy Whitcroft		    !defined $suppress_export{$realline_next} &&
455236794822SChristoph Hellwig		    ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/)) {
45533cbf62dfSAndy Whitcroft			# Handle definitions which produce identifiers with
45543cbf62dfSAndy Whitcroft			# a prefix:
45553cbf62dfSAndy Whitcroft			#   XXX(foo);
45563cbf62dfSAndy Whitcroft			#   EXPORT_SYMBOL(something_foo);
4557653d4876SAndy Whitcroft			my $name = $1;
455870a11659SJoe Perches			$name =~ s/^\s*($Ident).*/$1/;
455987a53877SAndy Whitcroft			if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
45603cbf62dfSAndy Whitcroft			    $name =~ /^${Ident}_$2/) {
45613cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n";
45623cbf62dfSAndy Whitcroft				$suppress_export{$realline_next} = 1;
45633cbf62dfSAndy Whitcroft
45643cbf62dfSAndy Whitcroft			} elsif ($stat !~ /(?:
45652b474a1aSAndy Whitcroft				\n.}\s*$|
456648012058SAndy Whitcroft				^.DEFINE_$Ident\(\Q$name\E\)|
456748012058SAndy Whitcroft				^.DECLARE_$Ident\(\Q$name\E\)|
456848012058SAndy Whitcroft				^.LIST_HEAD\(\Q$name\E\)|
45692b474a1aSAndy Whitcroft				^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
45702b474a1aSAndy Whitcroft				\b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
457148012058SAndy Whitcroft			    )/x) {
45722b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
45732b474a1aSAndy Whitcroft				$suppress_export{$realline_next} = 2;
45742b474a1aSAndy Whitcroft			} else {
45752b474a1aSAndy Whitcroft				$suppress_export{$realline_next} = 1;
45760a920b5bSAndy Whitcroft			}
45770a920b5bSAndy Whitcroft		}
45782b474a1aSAndy Whitcroft		if (!defined $suppress_export{$linenr} &&
45792b474a1aSAndy Whitcroft		    $prevline =~ /^.\s*$/ &&
458036794822SChristoph Hellwig		    ($line =~ /EXPORT_SYMBOL.*\((.*)\)/)) {
45812b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n";
45822b474a1aSAndy Whitcroft			$suppress_export{$linenr} = 2;
45832b474a1aSAndy Whitcroft		}
45842b474a1aSAndy Whitcroft		if (defined $suppress_export{$linenr} &&
45852b474a1aSAndy Whitcroft		    $suppress_export{$linenr} == 2) {
4586000d1cc1SJoe Perches			WARN("EXPORT_SYMBOL",
4587000d1cc1SJoe Perches			     "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
45882b474a1aSAndy Whitcroft		}
45890a920b5bSAndy Whitcroft
45905150bda4SJoe Eloff# check for global initialisers.
45915b8f82e1SSong Liu		if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/ &&
45925b8f82e1SSong Liu		    !exclude_global_initialisers($realfile)) {
4593d5e616fcSJoe Perches			if (ERROR("GLOBAL_INITIALISERS",
45946d32f7a3SJoe Perches				  "do not initialise globals to $1\n" . $herecurr) &&
4595d5e616fcSJoe Perches			    $fix) {
45966d32f7a3SJoe Perches				$fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
4597d5e616fcSJoe Perches			}
4598f0a594c1SAndy Whitcroft		}
45990a920b5bSAndy Whitcroft# check for static initialisers.
46006d32f7a3SJoe Perches		if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
4601d5e616fcSJoe Perches			if (ERROR("INITIALISED_STATIC",
46026d32f7a3SJoe Perches				  "do not initialise statics to $1\n" .
4603d5e616fcSJoe Perches				      $herecurr) &&
4604d5e616fcSJoe Perches			    $fix) {
46056d32f7a3SJoe Perches				$fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
4606d5e616fcSJoe Perches			}
46070a920b5bSAndy Whitcroft		}
46080a920b5bSAndy Whitcroft
46091813087dSJoe Perches# check for misordered declarations of char/short/int/long with signed/unsigned
46101813087dSJoe Perches		while ($sline =~ m{(\b$TypeMisordered\b)}g) {
46111813087dSJoe Perches			my $tmp = trim($1);
46121813087dSJoe Perches			WARN("MISORDERED_TYPE",
46131813087dSJoe Perches			     "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
46141813087dSJoe Perches		}
46151813087dSJoe Perches
4616809e082eSJoe Perches# check for unnecessary <signed> int declarations of short/long/long long
4617809e082eSJoe Perches		while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) {
4618809e082eSJoe Perches			my $type = trim($1);
4619809e082eSJoe Perches			next if ($type !~ /\bint\b/);
4620809e082eSJoe Perches			next if ($type !~ /\b(?:short|long\s+long|long)\b/);
4621809e082eSJoe Perches			my $new_type = $type;
4622809e082eSJoe Perches			$new_type =~ s/\b\s*int\s*\b/ /;
4623809e082eSJoe Perches			$new_type =~ s/\b\s*(?:un)?signed\b\s*/ /;
4624809e082eSJoe Perches			$new_type =~ s/^const\s+//;
4625809e082eSJoe Perches			$new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/);
4626809e082eSJoe Perches			$new_type = "const $new_type" if ($type =~ /^const\b/);
4627809e082eSJoe Perches			$new_type =~ s/\s+/ /g;
4628809e082eSJoe Perches			$new_type = trim($new_type);
4629809e082eSJoe Perches			if (WARN("UNNECESSARY_INT",
4630809e082eSJoe Perches				 "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) &&
4631809e082eSJoe Perches			    $fix) {
4632809e082eSJoe Perches				$fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/;
4633809e082eSJoe Perches			}
4634809e082eSJoe Perches		}
4635809e082eSJoe Perches
4636cb710ecaSJoe Perches# check for static const char * arrays.
4637cb710ecaSJoe Perches		if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
4638000d1cc1SJoe Perches			WARN("STATIC_CONST_CHAR_ARRAY",
4639000d1cc1SJoe Perches			     "static const char * array should probably be static const char * const\n" .
4640cb710ecaSJoe Perches				$herecurr);
4641cb710ecaSJoe Perches		}
4642cb710ecaSJoe Perches
464377b8c0a8SJoe Perches# check for initialized const char arrays that should be static const
464477b8c0a8SJoe Perches		if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
464577b8c0a8SJoe Perches			if (WARN("STATIC_CONST_CHAR_ARRAY",
464677b8c0a8SJoe Perches				 "const array should probably be static const\n" . $herecurr) &&
464777b8c0a8SJoe Perches			    $fix) {
464877b8c0a8SJoe Perches				$fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/;
464977b8c0a8SJoe Perches			}
465077b8c0a8SJoe Perches		}
465177b8c0a8SJoe Perches
4652cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations.
4653cb710ecaSJoe Perches		if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
4654000d1cc1SJoe Perches			WARN("STATIC_CONST_CHAR_ARRAY",
4655000d1cc1SJoe Perches			     "static char array declaration should probably be static const char\n" .
4656cb710ecaSJoe Perches				$herecurr);
4657cb710ecaSJoe Perches		}
4658cb710ecaSJoe Perches
4659ab7e23f3SJoe Perches# check for const <foo> const where <foo> is not a pointer or array type
4660ab7e23f3SJoe Perches		if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
4661ab7e23f3SJoe Perches			my $found = $1;
4662ab7e23f3SJoe Perches			if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
4663ab7e23f3SJoe Perches				WARN("CONST_CONST",
4664ab7e23f3SJoe Perches				     "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
4665ab7e23f3SJoe Perches			} elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
4666ab7e23f3SJoe Perches				WARN("CONST_CONST",
4667ab7e23f3SJoe Perches				     "'const $found const' should probably be 'const $found'\n" . $herecurr);
4668ab7e23f3SJoe Perches			}
4669ab7e23f3SJoe Perches		}
4670ab7e23f3SJoe Perches
467173169765SJoe Perches# check for const static or static <non ptr type> const declarations
467273169765SJoe Perches# prefer 'static const <foo>' over 'const static <foo>' and 'static <foo> const'
467373169765SJoe Perches		if ($sline =~ /^\+\s*const\s+static\s+($Type)\b/ ||
467473169765SJoe Perches		    $sline =~ /^\+\s*static\s+($BasicType)\s+const\b/) {
467573169765SJoe Perches			if (WARN("STATIC_CONST",
467673169765SJoe Perches				 "Move const after static - use 'static const $1'\n" . $herecurr) &&
467773169765SJoe Perches			    $fix) {
467873169765SJoe Perches				$fixed[$fixlinenr] =~ s/\bconst\s+static\b/static const/;
467973169765SJoe Perches				$fixed[$fixlinenr] =~ s/\bstatic\s+($BasicType)\s+const\b/static const $1/;
468073169765SJoe Perches			}
468173169765SJoe Perches		}
468273169765SJoe Perches
46839b0fa60dSJoe Perches# check for non-global char *foo[] = {"bar", ...} declarations.
46849b0fa60dSJoe Perches		if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
46859b0fa60dSJoe Perches			WARN("STATIC_CONST_CHAR_ARRAY",
46869b0fa60dSJoe Perches			     "char * array declaration might be better as static const\n" .
46879b0fa60dSJoe Perches				$herecurr);
46889b0fa60dSJoe Perches		}
46899b0fa60dSJoe Perches
4690b598b670SJoe Perches# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
4691b598b670SJoe Perches		if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
4692b598b670SJoe Perches			my $array = $1;
4693b598b670SJoe 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*\))@) {
4694b598b670SJoe Perches				my $array_div = $1;
4695b598b670SJoe Perches				if (WARN("ARRAY_SIZE",
4696b598b670SJoe Perches					 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
4697b598b670SJoe Perches				    $fix) {
4698b598b670SJoe Perches					$fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
4699b598b670SJoe Perches				}
4700b598b670SJoe Perches			}
4701b598b670SJoe Perches		}
4702b598b670SJoe Perches
4703b36190c5SJoe Perches# check for function declarations without arguments like "int foo()"
470416b7f3c8SJoe Perches		if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) {
4705b36190c5SJoe Perches			if (ERROR("FUNCTION_WITHOUT_ARGS",
4706b36190c5SJoe Perches				  "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
4707b36190c5SJoe Perches			    $fix) {
4708194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
4709b36190c5SJoe Perches			}
4710b36190c5SJoe Perches		}
4711b36190c5SJoe Perches
4712653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations
4713653d4876SAndy Whitcroft# make sense.
4714653d4876SAndy Whitcroft		if ($line =~ /\btypedef\s/ &&
47158054576dSAndy Whitcroft		    $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
4716c45dcabdSAndy Whitcroft		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
47178ed22cadSAndy Whitcroft		    $line !~ /\b$typeTypedefs\b/ &&
471846d832f5SMichael S. Tsirkin		    $line !~ /\b__bitwise\b/) {
4719000d1cc1SJoe Perches			WARN("NEW_TYPEDEFS",
4720000d1cc1SJoe Perches			     "do not add new typedefs\n" . $herecurr);
47210a920b5bSAndy Whitcroft		}
47220a920b5bSAndy Whitcroft
47230a920b5bSAndy Whitcroft# * goes on variable not on type
472465863862SAndy Whitcroft		# (char*[ const])
4725bfcb2cc7SAndy Whitcroft		while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
4726bfcb2cc7SAndy Whitcroft			#print "AA<$1>\n";
47273705ce5bSJoe Perches			my ($ident, $from, $to) = ($1, $2, $2);
4728d8aaf121SAndy Whitcroft
472965863862SAndy Whitcroft			# Should start with a space.
473065863862SAndy Whitcroft			$to =~ s/^(\S)/ $1/;
473165863862SAndy Whitcroft			# Should not end with a space.
473265863862SAndy Whitcroft			$to =~ s/\s+$//;
473365863862SAndy Whitcroft			# '*'s should not have spaces between.
4734f9a0b3d1SAndy Whitcroft			while ($to =~ s/\*\s+\*/\*\*/) {
473565863862SAndy Whitcroft			}
4736d8aaf121SAndy Whitcroft
47373705ce5bSJoe Perches##			print "1: from<$from> to<$to> ident<$ident>\n";
473865863862SAndy Whitcroft			if ($from ne $to) {
47393705ce5bSJoe Perches				if (ERROR("POINTER_LOCATION",
47403705ce5bSJoe Perches					  "\"(foo$from)\" should be \"(foo$to)\"\n" .  $herecurr) &&
47413705ce5bSJoe Perches				    $fix) {
47423705ce5bSJoe Perches					my $sub_from = $ident;
47433705ce5bSJoe Perches					my $sub_to = $ident;
47443705ce5bSJoe Perches					$sub_to =~ s/\Q$from\E/$to/;
4745194f66fcSJoe Perches					$fixed[$fixlinenr] =~
47463705ce5bSJoe Perches					    s@\Q$sub_from\E@$sub_to@;
47473705ce5bSJoe Perches				}
474865863862SAndy Whitcroft			}
4749bfcb2cc7SAndy Whitcroft		}
4750bfcb2cc7SAndy Whitcroft		while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
4751bfcb2cc7SAndy Whitcroft			#print "BB<$1>\n";
47523705ce5bSJoe Perches			my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
4753d8aaf121SAndy Whitcroft
475465863862SAndy Whitcroft			# Should start with a space.
475565863862SAndy Whitcroft			$to =~ s/^(\S)/ $1/;
475665863862SAndy Whitcroft			# Should not end with a space.
475765863862SAndy Whitcroft			$to =~ s/\s+$//;
475865863862SAndy Whitcroft			# '*'s should not have spaces between.
4759f9a0b3d1SAndy Whitcroft			while ($to =~ s/\*\s+\*/\*\*/) {
476065863862SAndy Whitcroft			}
476165863862SAndy Whitcroft			# Modifiers should have spaces.
476265863862SAndy Whitcroft			$to =~ s/(\b$Modifier$)/$1 /;
476365863862SAndy Whitcroft
47643705ce5bSJoe Perches##			print "2: from<$from> to<$to> ident<$ident>\n";
4765667026e7SAndy Whitcroft			if ($from ne $to && $ident !~ /^$Modifier$/) {
47663705ce5bSJoe Perches				if (ERROR("POINTER_LOCATION",
47673705ce5bSJoe Perches					  "\"foo${from}bar\" should be \"foo${to}bar\"\n" .  $herecurr) &&
47683705ce5bSJoe Perches				    $fix) {
47693705ce5bSJoe Perches
47703705ce5bSJoe Perches					my $sub_from = $match;
47713705ce5bSJoe Perches					my $sub_to = $match;
47723705ce5bSJoe Perches					$sub_to =~ s/\Q$from\E/$to/;
4773194f66fcSJoe Perches					$fixed[$fixlinenr] =~
47743705ce5bSJoe Perches					    s@\Q$sub_from\E@$sub_to@;
47753705ce5bSJoe Perches				}
477665863862SAndy Whitcroft			}
47770a920b5bSAndy Whitcroft		}
47780a920b5bSAndy Whitcroft
477969d517e6SDavid Hildenbrand# do not use BUG() or variants
478069d517e6SDavid Hildenbrand		if ($line =~ /\b(?!AA_|BUILD_|DCCP_|IDA_|KVM_|RWLOCK_|snd_|SPIN_)(?:[a-zA-Z_]*_)?BUG(?:_ON)?(?:_[A-Z_]+)?\s*\(/) {
47810675a8fbSJean Delvare			my $msg_level = \&WARN;
47820675a8fbSJean Delvare			$msg_level = \&CHK if ($file);
47830675a8fbSJean Delvare			&{$msg_level}("AVOID_BUG",
478469d517e6SDavid Hildenbrand				      "Do not crash the kernel unless it is absolutely unavoidable--use WARN_ON_ONCE() plus recovery code (if feasible) instead of BUG() or variants\n" . $herecurr);
47859d3e3c70SJoe Perches		}
47860a920b5bSAndy Whitcroft
47879d3e3c70SJoe Perches# avoid LINUX_VERSION_CODE
47888905a67cSAndy Whitcroft		if ($line =~ /\bLINUX_VERSION_CODE\b/) {
4789000d1cc1SJoe Perches			WARN("LINUX_VERSION_CODE",
4790000d1cc1SJoe Perches			     "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
47918905a67cSAndy Whitcroft		}
47928905a67cSAndy Whitcroft
479317441227SJoe Perches# check for uses of printk_ratelimit
479417441227SJoe Perches		if ($line =~ /\bprintk_ratelimit\s*\(/) {
4795000d1cc1SJoe Perches			WARN("PRINTK_RATELIMITED",
4796000d1cc1SJoe Perches			     "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
479717441227SJoe Perches		}
479817441227SJoe Perches
4799eeef5733SJoe Perches# printk should use KERN_* levels
4800eeef5733SJoe Perches		if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
4801000d1cc1SJoe Perches			WARN("PRINTK_WITHOUT_KERN_LEVEL",
4802eeef5733SJoe Perches			     "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
480300df344fSAndy Whitcroft		}
48040a920b5bSAndy Whitcroft
4805f5eea3b0SJoe Perches# prefer variants of (subsystem|netdev|dev|pr)_<level> to printk(KERN_<LEVEL>
4806f5eea3b0SJoe Perches		if ($line =~ /\b(printk(_once|_ratelimited)?)\s*\(\s*KERN_([A-Z]+)/) {
4807f5eea3b0SJoe Perches			my $printk = $1;
4808f5eea3b0SJoe Perches			my $modifier = $2;
4809f5eea3b0SJoe Perches			my $orig = $3;
4810f5eea3b0SJoe Perches			$modifier = "" if (!defined($modifier));
4811243f3803SJoe Perches			my $level = lc($orig);
4812243f3803SJoe Perches			$level = "warn" if ($level eq "warning");
48138f26b837SJoe Perches			my $level2 = $level;
48148f26b837SJoe Perches			$level2 = "dbg" if ($level eq "debug");
4815f5eea3b0SJoe Perches			$level .= $modifier;
4816f5eea3b0SJoe Perches			$level2 .= $modifier;
4817243f3803SJoe Perches			WARN("PREFER_PR_LEVEL",
4818f5eea3b0SJoe Perches			     "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(...  to $printk(KERN_$orig ...\n" . $herecurr);
4819243f3803SJoe Perches		}
4820243f3803SJoe Perches
4821f5eea3b0SJoe Perches# prefer dev_<level> to dev_printk(KERN_<LEVEL>
4822dc139313SJoe Perches		if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
4823dc139313SJoe Perches			my $orig = $1;
4824dc139313SJoe Perches			my $level = lc($orig);
4825dc139313SJoe Perches			$level = "warn" if ($level eq "warning");
4826dc139313SJoe Perches			$level = "dbg" if ($level eq "debug");
4827dc139313SJoe Perches			WARN("PREFER_DEV_LEVEL",
4828dc139313SJoe Perches			     "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
4829dc139313SJoe Perches		}
4830dc139313SJoe Perches
48318020b253SNicolas Boichat# trace_printk should not be used in production code.
48328020b253SNicolas Boichat		if ($line =~ /\b(trace_printk|trace_puts|ftrace_vprintk)\s*\(/) {
48338020b253SNicolas Boichat			WARN("TRACE_PRINTK",
48348020b253SNicolas Boichat			     "Do not use $1() in production code (this can be ignored if built only with a debug config option)\n" . $herecurr);
48358020b253SNicolas Boichat		}
48368020b253SNicolas Boichat
483791c9afafSAndy Lutomirski# ENOSYS means "bad syscall nr" and nothing else.  This will have a small
483891c9afafSAndy Lutomirski# number of false positives, but assembly files are not checked, so at
483991c9afafSAndy Lutomirski# least the arch entry code will not trigger this warning.
484091c9afafSAndy Lutomirski		if ($line =~ /\bENOSYS\b/) {
484191c9afafSAndy Lutomirski			WARN("ENOSYS",
484291c9afafSAndy Lutomirski			     "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
484391c9afafSAndy Lutomirski		}
484491c9afafSAndy Lutomirski
48456b9ea5ffSJakub Kicinski# ENOTSUPP is not a standard error code and should be avoided in new patches.
48466b9ea5ffSJakub Kicinski# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP.
48476b9ea5ffSJakub Kicinski# Similarly to ENOSYS warning a small number of false positives is expected.
48486b9ea5ffSJakub Kicinski		if (!$file && $line =~ /\bENOTSUPP\b/) {
48496b9ea5ffSJakub Kicinski			if (WARN("ENOTSUPP",
48506b9ea5ffSJakub Kicinski				 "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) &&
48516b9ea5ffSJakub Kicinski			    $fix) {
48526b9ea5ffSJakub Kicinski				$fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/;
48536b9ea5ffSJakub Kicinski			}
48546b9ea5ffSJakub Kicinski		}
48556b9ea5ffSJakub Kicinski
4856653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while,
4857653d4876SAndy Whitcroft# or if closed on same line
48585b57980dSJoe Perches		if ($perl_version_ok &&
48592d453e3bSJoe Perches		    $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
48602d453e3bSJoe Perches		    $sline !~ /\#\s*define\b.*do\s*\{/ &&
48612d453e3bSJoe Perches		    $sline !~ /}/) {
48628d182478SJoe Perches			if (ERROR("OPEN_BRACE",
48632d453e3bSJoe Perches				  "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
48648d182478SJoe Perches			    $fix) {
48658d182478SJoe Perches				fix_delete_line($fixlinenr, $rawline);
48668d182478SJoe Perches				my $fixed_line = $rawline;
486703f49351SDwaipayan Ray				$fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*)\{(.*)$/;
48688d182478SJoe Perches				my $line1 = $1;
48698d182478SJoe Perches				my $line2 = $2;
48708d182478SJoe Perches				fix_insert_line($fixlinenr, ltrim($line1));
48718d182478SJoe Perches				fix_insert_line($fixlinenr, "\+{");
48728d182478SJoe Perches				if ($line2 !~ /^\s*$/) {
48738d182478SJoe Perches					fix_insert_line($fixlinenr, "\+\t" . trim($line2));
48748d182478SJoe Perches				}
48758d182478SJoe Perches			}
48760a920b5bSAndy Whitcroft		}
4877653d4876SAndy Whitcroft
48788905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line.
48798905a67cSAndy Whitcroft		if ($line =~ /^.\s*{/ &&
48808905a67cSAndy Whitcroft		    $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
48818d182478SJoe Perches			if (ERROR("OPEN_BRACE",
48828d182478SJoe Perches				  "open brace '{' following $1 go on the same line\n" . $hereprev) &&
48838d182478SJoe Perches			    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
48848d182478SJoe Perches				fix_delete_line($fixlinenr - 1, $prevrawline);
48858d182478SJoe Perches				fix_delete_line($fixlinenr, $rawline);
48868d182478SJoe Perches				my $fixedline = rtrim($prevrawline) . " {";
48878d182478SJoe Perches				fix_insert_line($fixlinenr, $fixedline);
48888d182478SJoe Perches				$fixedline = $rawline;
48898d81ae05SCyril Bur				$fixedline =~ s/^(.\s*)\{\s*/$1\t/;
48908d182478SJoe Perches				if ($fixedline !~ /^\+\s*$/) {
48918d182478SJoe Perches					fix_insert_line($fixlinenr, $fixedline);
48928d182478SJoe Perches				}
48938d182478SJoe Perches			}
48948905a67cSAndy Whitcroft		}
48958905a67cSAndy Whitcroft
48960c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition
48973705ce5bSJoe Perches		if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
48983705ce5bSJoe Perches			if (WARN("SPACING",
48993705ce5bSJoe Perches				 "missing space after $1 definition\n" . $herecurr) &&
49003705ce5bSJoe Perches			    $fix) {
4901194f66fcSJoe Perches				$fixed[$fixlinenr] =~
49023705ce5bSJoe Perches				    s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
49033705ce5bSJoe Perches			}
49040c73b4ebSAndy Whitcroft		}
49050c73b4ebSAndy Whitcroft
490631070b5dSJoe Perches# Function pointer declarations
490731070b5dSJoe Perches# check spacing between type, funcptr, and args
490831070b5dSJoe Perches# canonical declaration is "type (*funcptr)(args...)"
490991f72e9cSJoe Perches		if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
491031070b5dSJoe Perches			my $declare = $1;
491131070b5dSJoe Perches			my $pre_pointer_space = $2;
491231070b5dSJoe Perches			my $post_pointer_space = $3;
491331070b5dSJoe Perches			my $funcname = $4;
491431070b5dSJoe Perches			my $post_funcname_space = $5;
491531070b5dSJoe Perches			my $pre_args_space = $6;
491631070b5dSJoe Perches
491791f72e9cSJoe Perches# the $Declare variable will capture all spaces after the type
491891f72e9cSJoe Perches# so check it for a missing trailing missing space but pointer return types
491991f72e9cSJoe Perches# don't need a space so don't warn for those.
492091f72e9cSJoe Perches			my $post_declare_space = "";
492191f72e9cSJoe Perches			if ($declare =~ /(\s+)$/) {
492291f72e9cSJoe Perches				$post_declare_space = $1;
492391f72e9cSJoe Perches				$declare = rtrim($declare);
492491f72e9cSJoe Perches			}
492591f72e9cSJoe Perches			if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
492631070b5dSJoe Perches				WARN("SPACING",
492731070b5dSJoe Perches				     "missing space after return type\n" . $herecurr);
492891f72e9cSJoe Perches				$post_declare_space = " ";
492931070b5dSJoe Perches			}
493031070b5dSJoe Perches
493131070b5dSJoe Perches# unnecessary space "type  (*funcptr)(args...)"
493291f72e9cSJoe Perches# This test is not currently implemented because these declarations are
493391f72e9cSJoe Perches# equivalent to
493491f72e9cSJoe Perches#	int  foo(int bar, ...)
493591f72e9cSJoe Perches# and this is form shouldn't/doesn't generate a checkpatch warning.
493691f72e9cSJoe Perches#
493791f72e9cSJoe Perches#			elsif ($declare =~ /\s{2,}$/) {
493891f72e9cSJoe Perches#				WARN("SPACING",
493991f72e9cSJoe Perches#				     "Multiple spaces after return type\n" . $herecurr);
494091f72e9cSJoe Perches#			}
494131070b5dSJoe Perches
494231070b5dSJoe Perches# unnecessary space "type ( *funcptr)(args...)"
494331070b5dSJoe Perches			if (defined $pre_pointer_space &&
494431070b5dSJoe Perches			    $pre_pointer_space =~ /^\s/) {
494531070b5dSJoe Perches				WARN("SPACING",
494631070b5dSJoe Perches				     "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
494731070b5dSJoe Perches			}
494831070b5dSJoe Perches
494931070b5dSJoe Perches# unnecessary space "type (* funcptr)(args...)"
495031070b5dSJoe Perches			if (defined $post_pointer_space &&
495131070b5dSJoe Perches			    $post_pointer_space =~ /^\s/) {
495231070b5dSJoe Perches				WARN("SPACING",
495331070b5dSJoe Perches				     "Unnecessary space before function pointer name\n" . $herecurr);
495431070b5dSJoe Perches			}
495531070b5dSJoe Perches
495631070b5dSJoe Perches# unnecessary space "type (*funcptr )(args...)"
495731070b5dSJoe Perches			if (defined $post_funcname_space &&
495831070b5dSJoe Perches			    $post_funcname_space =~ /^\s/) {
495931070b5dSJoe Perches				WARN("SPACING",
496031070b5dSJoe Perches				     "Unnecessary space after function pointer name\n" . $herecurr);
496131070b5dSJoe Perches			}
496231070b5dSJoe Perches
496331070b5dSJoe Perches# unnecessary space "type (*funcptr) (args...)"
496431070b5dSJoe Perches			if (defined $pre_args_space &&
496531070b5dSJoe Perches			    $pre_args_space =~ /^\s/) {
496631070b5dSJoe Perches				WARN("SPACING",
496731070b5dSJoe Perches				     "Unnecessary space before function pointer arguments\n" . $herecurr);
496831070b5dSJoe Perches			}
496931070b5dSJoe Perches
497031070b5dSJoe Perches			if (show_type("SPACING") && $fix) {
4971194f66fcSJoe Perches				$fixed[$fixlinenr] =~
497291f72e9cSJoe Perches				    s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
497331070b5dSJoe Perches			}
497431070b5dSJoe Perches		}
497531070b5dSJoe Perches
49768d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed:
49778d31cfceSAndy Whitcroft#  1. with a type on the left -- int [] a;
4978fe2a7dbcSAndy Whitcroft#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4979fe2a7dbcSAndy Whitcroft#  3. inside a curly brace -- = { [0...10] = 5 }
49808d31cfceSAndy Whitcroft		while ($line =~ /(.*?\s)\[/g) {
49818d31cfceSAndy Whitcroft			my ($where, $prefix) = ($-[1], $1);
49828d31cfceSAndy Whitcroft			if ($prefix !~ /$Type\s+$/ &&
4983fe2a7dbcSAndy Whitcroft			    ($where != 0 || $prefix !~ /^.\s+$/) &&
498438dca988SHeinrich Schuchardt			    $prefix !~ /[{,:]\s+$/) {
49853705ce5bSJoe Perches				if (ERROR("BRACKET_SPACE",
49863705ce5bSJoe Perches					  "space prohibited before open square bracket '['\n" . $herecurr) &&
49873705ce5bSJoe Perches				    $fix) {
4988194f66fcSJoe Perches				    $fixed[$fixlinenr] =~
49893705ce5bSJoe Perches					s/^(\+.*?)\s+\[/$1\[/;
49903705ce5bSJoe Perches				}
49918d31cfceSAndy Whitcroft			}
49928d31cfceSAndy Whitcroft		}
49938d31cfceSAndy Whitcroft
4994f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses.
49956c72ffaaSAndy Whitcroft		while ($line =~ /($Ident)\s+\(/g) {
4996c2fdda0dSAndy Whitcroft			my $name = $1;
4997773647a0SAndy Whitcroft			my $ctx_before = substr($line, 0, $-[1]);
4998773647a0SAndy Whitcroft			my $ctx = "$ctx_before$name";
4999c2fdda0dSAndy Whitcroft
5000c2fdda0dSAndy Whitcroft			# Ignore those directives where spaces _are_ permitted.
5001773647a0SAndy Whitcroft			if ($name =~ /^(?:
5002773647a0SAndy Whitcroft				if|for|while|switch|return|case|
5003773647a0SAndy Whitcroft				volatile|__volatile__|
5004773647a0SAndy Whitcroft				__attribute__|format|__extension__|
5005773647a0SAndy Whitcroft				asm|__asm__)$/x)
5006773647a0SAndy Whitcroft			{
5007c2fdda0dSAndy Whitcroft			# cpp #define statements have non-optional spaces, ie
5008c2fdda0dSAndy Whitcroft			# if there is a space between the name and the open
5009c2fdda0dSAndy Whitcroft			# parenthesis it is simply not a parameter group.
5010c45dcabdSAndy Whitcroft			} elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
5011773647a0SAndy Whitcroft
5012773647a0SAndy Whitcroft			# cpp #elif statement condition may start with a (
5013c45dcabdSAndy Whitcroft			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
5014c2fdda0dSAndy Whitcroft
5015c2fdda0dSAndy Whitcroft			# If this whole things ends with a type its most
5016c2fdda0dSAndy Whitcroft			# likely a typedef for a function.
5017773647a0SAndy Whitcroft			} elsif ($ctx =~ /$Type$/) {
5018c2fdda0dSAndy Whitcroft
5019c2fdda0dSAndy Whitcroft			} else {
50203705ce5bSJoe Perches				if (WARN("SPACING",
50213705ce5bSJoe Perches					 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
50223705ce5bSJoe Perches					     $fix) {
5023194f66fcSJoe Perches					$fixed[$fixlinenr] =~
50243705ce5bSJoe Perches					    s/\b$name\s+\(/$name\(/;
50253705ce5bSJoe Perches				}
5026f0a594c1SAndy Whitcroft			}
50276c72ffaaSAndy Whitcroft		}
50289a4cad4eSEric Nelson
5029653d4876SAndy Whitcroft# Check operator spacing.
50300a920b5bSAndy Whitcroft		if (!($line=~/\#\s*include/)) {
50313705ce5bSJoe Perches			my $fixed_line = "";
50323705ce5bSJoe Perches			my $line_fixed = 0;
50333705ce5bSJoe Perches
50349c0ca6f9SAndy Whitcroft			my $ops = qr{
50359c0ca6f9SAndy Whitcroft				<<=|>>=|<=|>=|==|!=|
50369c0ca6f9SAndy Whitcroft				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
50379c0ca6f9SAndy Whitcroft				=>|->|<<|>>|<|>|=|!|~|
50381f65f947SAndy Whitcroft				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
503984731623SJoe Perches				\?:|\?|:
50409c0ca6f9SAndy Whitcroft			}x;
5041cf655043SAndy Whitcroft			my @elements = split(/($ops|;)/, $opline);
50423705ce5bSJoe Perches
50433705ce5bSJoe Perches##			print("element count: <" . $#elements . ">\n");
50443705ce5bSJoe Perches##			foreach my $el (@elements) {
50453705ce5bSJoe Perches##				print("el: <$el>\n");
50463705ce5bSJoe Perches##			}
50473705ce5bSJoe Perches
50483705ce5bSJoe Perches			my @fix_elements = ();
504900df344fSAndy Whitcroft			my $off = 0;
50506c72ffaaSAndy Whitcroft
50513705ce5bSJoe Perches			foreach my $el (@elements) {
50523705ce5bSJoe Perches				push(@fix_elements, substr($rawline, $off, length($el)));
50533705ce5bSJoe Perches				$off += length($el);
50543705ce5bSJoe Perches			}
50553705ce5bSJoe Perches
50563705ce5bSJoe Perches			$off = 0;
50573705ce5bSJoe Perches
50586c72ffaaSAndy Whitcroft			my $blank = copy_spacing($opline);
5059b34c648bSJoe Perches			my $last_after = -1;
50606c72ffaaSAndy Whitcroft
50610a920b5bSAndy Whitcroft			for (my $n = 0; $n < $#elements; $n += 2) {
50623705ce5bSJoe Perches
50633705ce5bSJoe Perches				my $good = $fix_elements[$n] . $fix_elements[$n + 1];
50643705ce5bSJoe Perches
50653705ce5bSJoe Perches##				print("n: <$n> good: <$good>\n");
50663705ce5bSJoe Perches
50674a0df2efSAndy Whitcroft				$off += length($elements[$n]);
50684a0df2efSAndy Whitcroft
506925985edcSLucas De Marchi				# Pick up the preceding and succeeding characters.
5070773647a0SAndy Whitcroft				my $ca = substr($opline, 0, $off);
5071773647a0SAndy Whitcroft				my $cc = '';
5072773647a0SAndy Whitcroft				if (length($opline) >= ($off + length($elements[$n + 1]))) {
5073773647a0SAndy Whitcroft					$cc = substr($opline, $off + length($elements[$n + 1]));
5074773647a0SAndy Whitcroft				}
5075773647a0SAndy Whitcroft				my $cb = "$ca$;$cc";
5076773647a0SAndy Whitcroft
50774a0df2efSAndy Whitcroft				my $a = '';
50784a0df2efSAndy Whitcroft				$a = 'V' if ($elements[$n] ne '');
50794a0df2efSAndy Whitcroft				$a = 'W' if ($elements[$n] =~ /\s$/);
5080cf655043SAndy Whitcroft				$a = 'C' if ($elements[$n] =~ /$;$/);
50814a0df2efSAndy Whitcroft				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
50824a0df2efSAndy Whitcroft				$a = 'O' if ($elements[$n] eq '');
5083773647a0SAndy Whitcroft				$a = 'E' if ($ca =~ /^\s*$/);
50844a0df2efSAndy Whitcroft
50850a920b5bSAndy Whitcroft				my $op = $elements[$n + 1];
50864a0df2efSAndy Whitcroft
50874a0df2efSAndy Whitcroft				my $c = '';
50880a920b5bSAndy Whitcroft				if (defined $elements[$n + 2]) {
50894a0df2efSAndy Whitcroft					$c = 'V' if ($elements[$n + 2] ne '');
50904a0df2efSAndy Whitcroft					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
5091cf655043SAndy Whitcroft					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
50924a0df2efSAndy Whitcroft					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
50934a0df2efSAndy Whitcroft					$c = 'O' if ($elements[$n + 2] eq '');
50948b1b3378SAndy Whitcroft					$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
50954a0df2efSAndy Whitcroft				} else {
50964a0df2efSAndy Whitcroft					$c = 'E';
50970a920b5bSAndy Whitcroft				}
50980a920b5bSAndy Whitcroft
50994a0df2efSAndy Whitcroft				my $ctx = "${a}x${c}";
51004a0df2efSAndy Whitcroft
51014a0df2efSAndy Whitcroft				my $at = "(ctx:$ctx)";
51024a0df2efSAndy Whitcroft
51036c72ffaaSAndy Whitcroft				my $ptr = substr($blank, 0, $off) . "^";
5104de7d4f0eSAndy Whitcroft				my $hereptr = "$hereline$ptr\n";
51050a920b5bSAndy Whitcroft
510674048ed8SAndy Whitcroft				# Pull out the value of this operator.
51076c72ffaaSAndy Whitcroft				my $op_type = substr($curr_values, $off + 1, 1);
51080a920b5bSAndy Whitcroft
51091f65f947SAndy Whitcroft				# Get the full operator variant.
51101f65f947SAndy Whitcroft				my $opv = $op . substr($curr_vars, $off, 1);
51111f65f947SAndy Whitcroft
511213214adfSAndy Whitcroft				# Ignore operators passed as parameters.
511313214adfSAndy Whitcroft				if ($op_type ne 'V' &&
5114d7fe8065SSam Bobroff				    $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
511513214adfSAndy Whitcroft
5116cf655043SAndy Whitcroft#				# Ignore comments
5117cf655043SAndy Whitcroft#				} elsif ($op =~ /^$;+$/) {
511813214adfSAndy Whitcroft
5119d8aaf121SAndy Whitcroft				# ; should have either the end of line or a space or \ after it
512013214adfSAndy Whitcroft				} elsif ($op eq ';') {
5121cf655043SAndy Whitcroft					if ($ctx !~ /.x[WEBC]/ &&
5122cf655043SAndy Whitcroft					    $cc !~ /^\\/ && $cc !~ /^;/) {
51233705ce5bSJoe Perches						if (ERROR("SPACING",
51243705ce5bSJoe Perches							  "space required after that '$op' $at\n" . $hereptr)) {
5125b34c648bSJoe Perches							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
51263705ce5bSJoe Perches							$line_fixed = 1;
51273705ce5bSJoe Perches						}
5128d8aaf121SAndy Whitcroft					}
5129d8aaf121SAndy Whitcroft
5130d8aaf121SAndy Whitcroft				# // is a comment
5131d8aaf121SAndy Whitcroft				} elsif ($op eq '//') {
51320a920b5bSAndy Whitcroft
5133b00e4814SJoe Perches				#   :   when part of a bitfield
5134b00e4814SJoe Perches				} elsif ($opv eq ':B') {
5135b00e4814SJoe Perches					# skip the bitfield test for now
5136b00e4814SJoe Perches
51371f65f947SAndy Whitcroft				# No spaces for:
51381f65f947SAndy Whitcroft				#   ->
5139b00e4814SJoe Perches				} elsif ($op eq '->') {
51404a0df2efSAndy Whitcroft					if ($ctx =~ /Wx.|.xW/) {
51413705ce5bSJoe Perches						if (ERROR("SPACING",
51423705ce5bSJoe Perches							  "spaces prohibited around that '$op' $at\n" . $hereptr)) {
5143b34c648bSJoe Perches							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
51443705ce5bSJoe Perches							if (defined $fix_elements[$n + 2]) {
51453705ce5bSJoe Perches								$fix_elements[$n + 2] =~ s/^\s+//;
51463705ce5bSJoe Perches							}
5147b34c648bSJoe Perches							$line_fixed = 1;
51483705ce5bSJoe Perches						}
51490a920b5bSAndy Whitcroft					}
51500a920b5bSAndy Whitcroft
51512381097bSJoe Perches				# , must not have a space before and must have a space on the right.
51520a920b5bSAndy Whitcroft				} elsif ($op eq ',') {
51532381097bSJoe Perches					my $rtrim_before = 0;
51542381097bSJoe Perches					my $space_after = 0;
51552381097bSJoe Perches					if ($ctx =~ /Wx./) {
51562381097bSJoe Perches						if (ERROR("SPACING",
51572381097bSJoe Perches							  "space prohibited before that '$op' $at\n" . $hereptr)) {
51582381097bSJoe Perches							$line_fixed = 1;
51592381097bSJoe Perches							$rtrim_before = 1;
51602381097bSJoe Perches						}
51612381097bSJoe Perches					}
5162cf655043SAndy Whitcroft					if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
51633705ce5bSJoe Perches						if (ERROR("SPACING",
51643705ce5bSJoe Perches							  "space required after that '$op' $at\n" . $hereptr)) {
51653705ce5bSJoe Perches							$line_fixed = 1;
5166b34c648bSJoe Perches							$last_after = $n;
51672381097bSJoe Perches							$space_after = 1;
51682381097bSJoe Perches						}
51692381097bSJoe Perches					}
51702381097bSJoe Perches					if ($rtrim_before || $space_after) {
51712381097bSJoe Perches						if ($rtrim_before) {
51722381097bSJoe Perches							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
51732381097bSJoe Perches						} else {
51742381097bSJoe Perches							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
51752381097bSJoe Perches						}
51762381097bSJoe Perches						if ($space_after) {
51772381097bSJoe Perches							$good .= " ";
51783705ce5bSJoe Perches						}
51790a920b5bSAndy Whitcroft					}
51800a920b5bSAndy Whitcroft
51819c0ca6f9SAndy Whitcroft				# '*' as part of a type definition -- reported already.
518274048ed8SAndy Whitcroft				} elsif ($opv eq '*_') {
51839c0ca6f9SAndy Whitcroft					#warn "'*' is part of type\n";
51849c0ca6f9SAndy Whitcroft
51859c0ca6f9SAndy Whitcroft				# unary operators should have a space before and
51869c0ca6f9SAndy Whitcroft				# none after.  May be left adjacent to another
51879c0ca6f9SAndy Whitcroft				# unary operator, or a cast
51889c0ca6f9SAndy Whitcroft				} elsif ($op eq '!' || $op eq '~' ||
518974048ed8SAndy Whitcroft					 $opv eq '*U' || $opv eq '-U' ||
51900d413866SAndy Whitcroft					 $opv eq '&U' || $opv eq '&&U') {
5191cf655043SAndy Whitcroft					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
51923705ce5bSJoe Perches						if (ERROR("SPACING",
51933705ce5bSJoe Perches							  "space required before that '$op' $at\n" . $hereptr)) {
5194b34c648bSJoe Perches							if ($n != $last_after + 2) {
5195b34c648bSJoe Perches								$good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
51963705ce5bSJoe Perches								$line_fixed = 1;
51973705ce5bSJoe Perches							}
51980a920b5bSAndy Whitcroft						}
5199b34c648bSJoe Perches					}
5200a3340b35SAndy Whitcroft					if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
5201171ae1a4SAndy Whitcroft						# A unary '*' may be const
5202171ae1a4SAndy Whitcroft
5203171ae1a4SAndy Whitcroft					} elsif ($ctx =~ /.xW/) {
52043705ce5bSJoe Perches						if (ERROR("SPACING",
52053705ce5bSJoe Perches							  "space prohibited after that '$op' $at\n" . $hereptr)) {
5206b34c648bSJoe Perches							$good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
52073705ce5bSJoe Perches							if (defined $fix_elements[$n + 2]) {
52083705ce5bSJoe Perches								$fix_elements[$n + 2] =~ s/^\s+//;
52093705ce5bSJoe Perches							}
5210b34c648bSJoe Perches							$line_fixed = 1;
52113705ce5bSJoe Perches						}
52120a920b5bSAndy Whitcroft					}
52130a920b5bSAndy Whitcroft
52140a920b5bSAndy Whitcroft				# unary ++ and unary -- are allowed no space on one side.
52150a920b5bSAndy Whitcroft				} elsif ($op eq '++' or $op eq '--') {
5216773647a0SAndy Whitcroft					if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
52173705ce5bSJoe Perches						if (ERROR("SPACING",
52183705ce5bSJoe Perches							  "space required one side of that '$op' $at\n" . $hereptr)) {
5219b34c648bSJoe Perches							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
52203705ce5bSJoe Perches							$line_fixed = 1;
52213705ce5bSJoe Perches						}
52220a920b5bSAndy Whitcroft					}
5223773647a0SAndy Whitcroft					if ($ctx =~ /Wx[BE]/ ||
5224773647a0SAndy Whitcroft					    ($ctx =~ /Wx./ && $cc =~ /^;/)) {
52253705ce5bSJoe Perches						if (ERROR("SPACING",
52263705ce5bSJoe Perches							  "space prohibited before that '$op' $at\n" . $hereptr)) {
5227b34c648bSJoe Perches							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
52283705ce5bSJoe Perches							$line_fixed = 1;
52293705ce5bSJoe Perches						}
5230653d4876SAndy Whitcroft					}
5231773647a0SAndy Whitcroft					if ($ctx =~ /ExW/) {
52323705ce5bSJoe Perches						if (ERROR("SPACING",
52333705ce5bSJoe Perches							  "space prohibited after that '$op' $at\n" . $hereptr)) {
5234b34c648bSJoe Perches							$good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
52353705ce5bSJoe Perches							if (defined $fix_elements[$n + 2]) {
52363705ce5bSJoe Perches								$fix_elements[$n + 2] =~ s/^\s+//;
5237773647a0SAndy Whitcroft							}
5238b34c648bSJoe Perches							$line_fixed = 1;
52393705ce5bSJoe Perches						}
52403705ce5bSJoe Perches					}
52410a920b5bSAndy Whitcroft
52420a920b5bSAndy Whitcroft				# << and >> may either have or not have spaces both sides
52439c0ca6f9SAndy Whitcroft				} elsif ($op eq '<<' or $op eq '>>' or
52449c0ca6f9SAndy Whitcroft					 $op eq '&' or $op eq '^' or $op eq '|' or
52459c0ca6f9SAndy Whitcroft					 $op eq '+' or $op eq '-' or
5246c2fdda0dSAndy Whitcroft					 $op eq '*' or $op eq '/' or
5247c2fdda0dSAndy Whitcroft					 $op eq '%')
52480a920b5bSAndy Whitcroft				{
5249d2e025f3SJoe Perches					if ($check) {
5250d2e025f3SJoe Perches						if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
5251d2e025f3SJoe Perches							if (CHK("SPACING",
5252d2e025f3SJoe Perches								"spaces preferred around that '$op' $at\n" . $hereptr)) {
5253d2e025f3SJoe Perches								$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
5254d2e025f3SJoe Perches								$fix_elements[$n + 2] =~ s/^\s+//;
5255d2e025f3SJoe Perches								$line_fixed = 1;
5256d2e025f3SJoe Perches							}
5257d2e025f3SJoe Perches						} elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
5258d2e025f3SJoe Perches							if (CHK("SPACING",
5259d2e025f3SJoe Perches								"space preferred before that '$op' $at\n" . $hereptr)) {
5260d2e025f3SJoe Perches								$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
5261d2e025f3SJoe Perches								$line_fixed = 1;
5262d2e025f3SJoe Perches							}
5263d2e025f3SJoe Perches						}
5264d2e025f3SJoe Perches					} elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
52653705ce5bSJoe Perches						if (ERROR("SPACING",
52663705ce5bSJoe Perches							  "need consistent spacing around '$op' $at\n" . $hereptr)) {
5267b34c648bSJoe Perches							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
5268b34c648bSJoe Perches							if (defined $fix_elements[$n + 2]) {
5269b34c648bSJoe Perches								$fix_elements[$n + 2] =~ s/^\s+//;
5270b34c648bSJoe Perches							}
52713705ce5bSJoe Perches							$line_fixed = 1;
52723705ce5bSJoe Perches						}
52730a920b5bSAndy Whitcroft					}
52740a920b5bSAndy Whitcroft
52751f65f947SAndy Whitcroft				# A colon needs no spaces before when it is
52761f65f947SAndy Whitcroft				# terminating a case value or a label.
52771f65f947SAndy Whitcroft				} elsif ($opv eq ':C' || $opv eq ':L') {
5278263afd39SChris Down					if ($ctx =~ /Wx./ and $realfile !~ m@.*\.lds\.h$@) {
52793705ce5bSJoe Perches						if (ERROR("SPACING",
52803705ce5bSJoe Perches							  "space prohibited before that '$op' $at\n" . $hereptr)) {
5281b34c648bSJoe Perches							$good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
52823705ce5bSJoe Perches							$line_fixed = 1;
52833705ce5bSJoe Perches						}
52841f65f947SAndy Whitcroft					}
52851f65f947SAndy Whitcroft
52860a920b5bSAndy Whitcroft				# All the others need spaces both sides.
5287cf655043SAndy Whitcroft				} elsif ($ctx !~ /[EWC]x[CWE]/) {
52881f65f947SAndy Whitcroft					my $ok = 0;
52891f65f947SAndy Whitcroft
529022f2a2efSAndy Whitcroft					# Ignore email addresses <foo@bar>
52911f65f947SAndy Whitcroft					if (($op eq '<' &&
52921f65f947SAndy Whitcroft					     $cc =~ /^\S+\@\S+>/) ||
52931f65f947SAndy Whitcroft					    ($op eq '>' &&
52941f65f947SAndy Whitcroft					     $ca =~ /<\S+\@\S+$/))
52951f65f947SAndy Whitcroft					{
52961f65f947SAndy Whitcroft						$ok = 1;
52971f65f947SAndy Whitcroft					}
52981f65f947SAndy Whitcroft
5299e0df7e1fSJoe Perches					# for asm volatile statements
5300e0df7e1fSJoe Perches					# ignore a colon with another
5301e0df7e1fSJoe Perches					# colon immediately before or after
5302e0df7e1fSJoe Perches					if (($op eq ':') &&
5303e0df7e1fSJoe Perches					    ($ca =~ /:$/ || $cc =~ /^:/)) {
5304e0df7e1fSJoe Perches						$ok = 1;
5305e0df7e1fSJoe Perches					}
5306e0df7e1fSJoe Perches
530784731623SJoe Perches					# messages are ERROR, but ?: are CHK
53081f65f947SAndy Whitcroft					if ($ok == 0) {
53090675a8fbSJean Delvare						my $msg_level = \&ERROR;
53100675a8fbSJean Delvare						$msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
531184731623SJoe Perches
53120675a8fbSJean Delvare						if (&{$msg_level}("SPACING",
53133705ce5bSJoe Perches								  "spaces required around that '$op' $at\n" . $hereptr)) {
5314b34c648bSJoe Perches							$good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
5315b34c648bSJoe Perches							if (defined $fix_elements[$n + 2]) {
5316b34c648bSJoe Perches								$fix_elements[$n + 2] =~ s/^\s+//;
5317b34c648bSJoe Perches							}
53183705ce5bSJoe Perches							$line_fixed = 1;
53193705ce5bSJoe Perches						}
53200a920b5bSAndy Whitcroft					}
532122f2a2efSAndy Whitcroft				}
53224a0df2efSAndy Whitcroft				$off += length($elements[$n + 1]);
53233705ce5bSJoe Perches
53243705ce5bSJoe Perches##				print("n: <$n> GOOD: <$good>\n");
53253705ce5bSJoe Perches
53263705ce5bSJoe Perches				$fixed_line = $fixed_line . $good;
53270a920b5bSAndy Whitcroft			}
53283705ce5bSJoe Perches
53293705ce5bSJoe Perches			if (($#elements % 2) == 0) {
53303705ce5bSJoe Perches				$fixed_line = $fixed_line . $fix_elements[$#elements];
53313705ce5bSJoe Perches			}
53323705ce5bSJoe Perches
5333194f66fcSJoe Perches			if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
5334194f66fcSJoe Perches				$fixed[$fixlinenr] = $fixed_line;
53353705ce5bSJoe Perches			}
53363705ce5bSJoe Perches
53373705ce5bSJoe Perches
53380a920b5bSAndy Whitcroft		}
53390a920b5bSAndy Whitcroft
5340786b6326SJoe Perches# check for whitespace before a non-naked semicolon
5341d2e248e7SJoe Perches		if ($line =~ /^\+.*\S\s+;\s*$/) {
5342786b6326SJoe Perches			if (WARN("SPACING",
5343786b6326SJoe Perches				 "space prohibited before semicolon\n" . $herecurr) &&
5344786b6326SJoe Perches			    $fix) {
5345194f66fcSJoe Perches				1 while $fixed[$fixlinenr] =~
5346786b6326SJoe Perches				    s/^(\+.*\S)\s+;/$1;/;
5347786b6326SJoe Perches			}
5348786b6326SJoe Perches		}
5349786b6326SJoe Perches
5350f0a594c1SAndy Whitcroft# check for multiple assignments
5351f0a594c1SAndy Whitcroft		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
5352000d1cc1SJoe Perches			CHK("MULTIPLE_ASSIGNMENTS",
5353000d1cc1SJoe Perches			    "multiple assignments should be avoided\n" . $herecurr);
5354f0a594c1SAndy Whitcroft		}
5355f0a594c1SAndy Whitcroft
535622f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration
535722f2a2efSAndy Whitcroft## # continuation.
535822f2a2efSAndy Whitcroft## 		if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
535922f2a2efSAndy Whitcroft## 		    $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
536022f2a2efSAndy Whitcroft##
536122f2a2efSAndy Whitcroft## 			# Remove any bracketed sections to ensure we do not
5362e73d2715SDwaipayan Ray## 			# falsely report the parameters of functions.
536322f2a2efSAndy Whitcroft## 			my $ln = $line;
536422f2a2efSAndy Whitcroft## 			while ($ln =~ s/\([^\(\)]*\)//g) {
536522f2a2efSAndy Whitcroft## 			}
536622f2a2efSAndy Whitcroft## 			if ($ln =~ /,/) {
5367000d1cc1SJoe Perches## 				WARN("MULTIPLE_DECLARATION",
5368000d1cc1SJoe Perches##				     "declaring multiple variables together should be avoided\n" . $herecurr);
536922f2a2efSAndy Whitcroft## 			}
537022f2a2efSAndy Whitcroft## 		}
5371f0a594c1SAndy Whitcroft
53720a920b5bSAndy Whitcroft#need space before brace following if, while, etc
53736b8c69e4SGeyslan G. Bem		if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
53746ad724e2SMichal Zylowski		    $line =~ /\b(?:else|do)\{/) {
53753705ce5bSJoe Perches			if (ERROR("SPACING",
53763705ce5bSJoe Perches				  "space required before the open brace '{'\n" . $herecurr) &&
53773705ce5bSJoe Perches			    $fix) {
53786ad724e2SMichal Zylowski				$fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/;
53793705ce5bSJoe Perches			}
5380de7d4f0eSAndy Whitcroft		}
5381de7d4f0eSAndy Whitcroft
5382c4a62ef9SJoe Perches## # check for blank lines before declarations
5383c4a62ef9SJoe Perches##		if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
5384c4a62ef9SJoe Perches##		    $prevrawline =~ /^.\s*$/) {
5385c4a62ef9SJoe Perches##			WARN("SPACING",
5386c4a62ef9SJoe Perches##			     "No blank lines before declarations\n" . $hereprev);
5387c4a62ef9SJoe Perches##		}
5388c4a62ef9SJoe Perches##
5389c4a62ef9SJoe Perches
5390de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything
5391de7d4f0eSAndy Whitcroft# on the line
539294fb9845SJoe Perches		if ($line =~ /}(?!(?:,|;|\)|\}))\S/) {
5393d5e616fcSJoe Perches			if (ERROR("SPACING",
5394d5e616fcSJoe Perches				  "space required after that close brace '}'\n" . $herecurr) &&
5395d5e616fcSJoe Perches			    $fix) {
5396194f66fcSJoe Perches				$fixed[$fixlinenr] =~
5397d5e616fcSJoe Perches				    s/}((?!(?:,|;|\)))\S)/} $1/;
5398d5e616fcSJoe Perches			}
53990a920b5bSAndy Whitcroft		}
54000a920b5bSAndy Whitcroft
540122f2a2efSAndy Whitcroft# check spacing on square brackets
540222f2a2efSAndy Whitcroft		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
54033705ce5bSJoe Perches			if (ERROR("SPACING",
54043705ce5bSJoe Perches				  "space prohibited after that open square bracket '['\n" . $herecurr) &&
54053705ce5bSJoe Perches			    $fix) {
5406194f66fcSJoe Perches				$fixed[$fixlinenr] =~
54073705ce5bSJoe Perches				    s/\[\s+/\[/;
54083705ce5bSJoe Perches			}
540922f2a2efSAndy Whitcroft		}
541022f2a2efSAndy Whitcroft		if ($line =~ /\s\]/) {
54113705ce5bSJoe Perches			if (ERROR("SPACING",
54123705ce5bSJoe Perches				  "space prohibited before that close square bracket ']'\n" . $herecurr) &&
54133705ce5bSJoe Perches			    $fix) {
5414194f66fcSJoe Perches				$fixed[$fixlinenr] =~
54153705ce5bSJoe Perches				    s/\s+\]/\]/;
54163705ce5bSJoe Perches			}
541722f2a2efSAndy Whitcroft		}
541822f2a2efSAndy Whitcroft
5419c45dcabdSAndy Whitcroft# check spacing on parentheses
54209c0ca6f9SAndy Whitcroft		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
54219c0ca6f9SAndy Whitcroft		    $line !~ /for\s*\(\s+;/) {
54223705ce5bSJoe Perches			if (ERROR("SPACING",
54233705ce5bSJoe Perches				  "space prohibited after that open parenthesis '('\n" . $herecurr) &&
54243705ce5bSJoe Perches			    $fix) {
5425194f66fcSJoe Perches				$fixed[$fixlinenr] =~
54263705ce5bSJoe Perches				    s/\(\s+/\(/;
54273705ce5bSJoe Perches			}
542822f2a2efSAndy Whitcroft		}
542913214adfSAndy Whitcroft		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
5430c45dcabdSAndy Whitcroft		    $line !~ /for\s*\(.*;\s+\)/ &&
5431c45dcabdSAndy Whitcroft		    $line !~ /:\s+\)/) {
54323705ce5bSJoe Perches			if (ERROR("SPACING",
54333705ce5bSJoe Perches				  "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
54343705ce5bSJoe Perches			    $fix) {
5435194f66fcSJoe Perches				$fixed[$fixlinenr] =~
54363705ce5bSJoe Perches				    s/\s+\)/\)/;
54373705ce5bSJoe Perches			}
543822f2a2efSAndy Whitcroft		}
543922f2a2efSAndy Whitcroft
5440e2826fd0SJoe Perches# check unnecessary parentheses around addressof/dereference single $Lvals
5441e2826fd0SJoe Perches# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
5442e2826fd0SJoe Perches
5443e2826fd0SJoe Perches		while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
5444ea4acbb1SJoe Perches			my $var = $1;
5445ea4acbb1SJoe Perches			if (CHK("UNNECESSARY_PARENTHESES",
5446ea4acbb1SJoe Perches				"Unnecessary parentheses around $var\n" . $herecurr) &&
5447ea4acbb1SJoe Perches			    $fix) {
5448ea4acbb1SJoe Perches				$fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
5449ea4acbb1SJoe Perches			}
5450ea4acbb1SJoe Perches		}
5451ea4acbb1SJoe Perches
5452ea4acbb1SJoe Perches# check for unnecessary parentheses around function pointer uses
5453ea4acbb1SJoe Perches# ie: (foo->bar)(); should be foo->bar();
5454ea4acbb1SJoe Perches# but not "if (foo->bar) (" to avoid some false positives
5455ea4acbb1SJoe Perches		if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
5456ea4acbb1SJoe Perches			my $var = $2;
5457ea4acbb1SJoe Perches			if (CHK("UNNECESSARY_PARENTHESES",
5458ea4acbb1SJoe Perches				"Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
5459ea4acbb1SJoe Perches			    $fix) {
5460ea4acbb1SJoe Perches				my $var2 = deparenthesize($var);
5461ea4acbb1SJoe Perches				$var2 =~ s/\s//g;
5462ea4acbb1SJoe Perches				$fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
5463ea4acbb1SJoe Perches			}
5464e2826fd0SJoe Perches		}
5465e2826fd0SJoe Perches
546663b7c73eSJoe Perches# check for unnecessary parentheses around comparisons in if uses
5467a032aa4cSJoe Perches# when !drivers/staging or command-line uses --strict
5468a032aa4cSJoe Perches		if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
54695b57980dSJoe Perches		    $perl_version_ok && defined($stat) &&
547063b7c73eSJoe Perches		    $stat =~ /(^.\s*if\s*($balanced_parens))/) {
547163b7c73eSJoe Perches			my $if_stat = $1;
547263b7c73eSJoe Perches			my $test = substr($2, 1, -1);
547363b7c73eSJoe Perches			my $herectx;
547463b7c73eSJoe Perches			while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
547563b7c73eSJoe Perches				my $match = $1;
547663b7c73eSJoe Perches				# avoid parentheses around potential macro args
547763b7c73eSJoe Perches				next if ($match =~ /^\s*\w+\s*$/);
547863b7c73eSJoe Perches				if (!defined($herectx)) {
547963b7c73eSJoe Perches					$herectx = $here . "\n";
548063b7c73eSJoe Perches					my $cnt = statement_rawlines($if_stat);
548163b7c73eSJoe Perches					for (my $n = 0; $n < $cnt; $n++) {
548263b7c73eSJoe Perches						my $rl = raw_line($linenr, $n);
548363b7c73eSJoe Perches						$herectx .=  $rl . "\n";
548463b7c73eSJoe Perches						last if $rl =~ /^[ \+].*\{/;
548563b7c73eSJoe Perches					}
548663b7c73eSJoe Perches				}
548763b7c73eSJoe Perches				CHK("UNNECESSARY_PARENTHESES",
548863b7c73eSJoe Perches				    "Unnecessary parentheses around '$match'\n" . $herectx);
548963b7c73eSJoe Perches			}
549063b7c73eSJoe Perches		}
549163b7c73eSJoe Perches
549269078651SJoe Perches# check that goto labels aren't indented (allow a single space indentation)
549369078651SJoe Perches# and ignore bitfield definitions like foo:1
549469078651SJoe Perches# Strictly, labels can have whitespace after the identifier and before the :
549569078651SJoe Perches# but this is not allowed here as many ?: uses would appear to be labels
549669078651SJoe Perches		if ($sline =~ /^.\s+[A-Za-z_][A-Za-z\d_]*:(?!\s*\d+)/ &&
549769078651SJoe Perches		    $sline !~ /^. [A-Za-z\d_][A-Za-z\d_]*:/ &&
549869078651SJoe Perches		    $sline !~ /^.\s+default:/) {
54993705ce5bSJoe Perches			if (WARN("INDENTED_LABEL",
55003705ce5bSJoe Perches				 "labels should not be indented\n" . $herecurr) &&
55013705ce5bSJoe Perches			    $fix) {
5502194f66fcSJoe Perches				$fixed[$fixlinenr] =~
55033705ce5bSJoe Perches				    s/^(.)\s+/$1/;
55043705ce5bSJoe Perches			}
55050a920b5bSAndy Whitcroft		}
55060a920b5bSAndy Whitcroft
550740873abaSJoe Perches# check if a statement with a comma should be two statements like:
550840873abaSJoe Perches#	foo = bar(),	/* comma should be semicolon */
550940873abaSJoe Perches#	bar = baz();
551040873abaSJoe Perches		if (defined($stat) &&
551140873abaSJoe Perches		    $stat =~ /^\+\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*,\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*;\s*$/) {
551240873abaSJoe Perches			my $cnt = statement_rawlines($stat);
551340873abaSJoe Perches			my $herectx = get_stat_here($linenr, $cnt, $here);
551440873abaSJoe Perches			WARN("SUSPECT_COMMA_SEMICOLON",
551540873abaSJoe Perches			     "Possible comma where semicolon could be used\n" . $herectx);
551640873abaSJoe Perches		}
551740873abaSJoe Perches
55185b9553abSJoe Perches# return is not a function
5519507e5141SJoe Perches		if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
5520c45dcabdSAndy Whitcroft			my $spacing = $1;
55215b57980dSJoe Perches			if ($perl_version_ok &&
55225b9553abSJoe Perches			    $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
55235b9553abSJoe Perches				my $value = $1;
55245b9553abSJoe Perches				$value = deparenthesize($value);
55255b9553abSJoe Perches				if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
5526000d1cc1SJoe Perches					ERROR("RETURN_PARENTHESES",
5527000d1cc1SJoe Perches					      "return is not a function, parentheses are not required\n" . $herecurr);
55285b9553abSJoe Perches				}
5529c45dcabdSAndy Whitcroft			} elsif ($spacing !~ /\s+/) {
5530000d1cc1SJoe Perches				ERROR("SPACING",
5531000d1cc1SJoe Perches				      "space required before the open parenthesis '('\n" . $herecurr);
5532c45dcabdSAndy Whitcroft			}
5533c45dcabdSAndy Whitcroft		}
5534507e5141SJoe Perches
5535b43ae21bSJoe Perches# unnecessary return in a void function
5536b43ae21bSJoe Perches# at end-of-function, with the previous line a single leading tab, then return;
5537b43ae21bSJoe Perches# and the line before that not a goto label target like "out:"
5538b43ae21bSJoe Perches		if ($sline =~ /^[ \+]}\s*$/ &&
5539b43ae21bSJoe Perches		    $prevline =~ /^\+\treturn\s*;\s*$/ &&
5540b43ae21bSJoe Perches		    $linenr >= 3 &&
5541b43ae21bSJoe Perches		    $lines[$linenr - 3] =~ /^[ +]/ &&
5542b43ae21bSJoe Perches		    $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
55439819cf25SJoe Perches			WARN("RETURN_VOID",
5544b43ae21bSJoe Perches			     "void function return statements are not generally useful\n" . $hereprev);
55459819cf25SJoe Perches		}
55469819cf25SJoe Perches
5547189248d8SJoe Perches# if statements using unnecessary parentheses - ie: if ((foo == bar))
55485b57980dSJoe Perches		if ($perl_version_ok &&
5549189248d8SJoe Perches		    $line =~ /\bif\s*((?:\(\s*){2,})/) {
5550189248d8SJoe Perches			my $openparens = $1;
5551189248d8SJoe Perches			my $count = $openparens =~ tr@\(@\(@;
5552189248d8SJoe Perches			my $msg = "";
5553189248d8SJoe Perches			if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
5554189248d8SJoe Perches				my $comp = $4;	#Not $1 because of $LvalOrFunc
5555189248d8SJoe Perches				$msg = " - maybe == should be = ?" if ($comp eq "==");
5556189248d8SJoe Perches				WARN("UNNECESSARY_PARENTHESES",
5557189248d8SJoe Perches				     "Unnecessary parentheses$msg\n" . $herecurr);
5558189248d8SJoe Perches			}
5559189248d8SJoe Perches		}
5560189248d8SJoe Perches
5561c5595fa2SJoe Perches# comparisons with a constant or upper case identifier on the left
5562c5595fa2SJoe Perches#	avoid cases like "foo + BAR < baz"
5563c5595fa2SJoe Perches#	only fix matches surrounded by parentheses to avoid incorrect
5564c5595fa2SJoe Perches#	conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
55655b57980dSJoe Perches		if ($perl_version_ok &&
5566c5595fa2SJoe Perches		    $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
5567c5595fa2SJoe Perches			my $lead = $1;
5568c5595fa2SJoe Perches			my $const = $2;
5569c5595fa2SJoe Perches			my $comp = $3;
5570c5595fa2SJoe Perches			my $to = $4;
5571c5595fa2SJoe Perches			my $newcomp = $comp;
5572f39e1769SJoe Perches			if ($lead !~ /(?:$Operators|\.)\s*$/ &&
5573c5595fa2SJoe Perches			    $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
5574c5595fa2SJoe Perches			    WARN("CONSTANT_COMPARISON",
5575c5595fa2SJoe Perches				 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
5576c5595fa2SJoe Perches			    $fix) {
5577c5595fa2SJoe Perches				if ($comp eq "<") {
5578c5595fa2SJoe Perches					$newcomp = ">";
5579c5595fa2SJoe Perches				} elsif ($comp eq "<=") {
5580c5595fa2SJoe Perches					$newcomp = ">=";
5581c5595fa2SJoe Perches				} elsif ($comp eq ">") {
5582c5595fa2SJoe Perches					$newcomp = "<";
5583c5595fa2SJoe Perches				} elsif ($comp eq ">=") {
5584c5595fa2SJoe Perches					$newcomp = "<=";
5585c5595fa2SJoe Perches				}
5586c5595fa2SJoe Perches				$fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
5587c5595fa2SJoe Perches			}
5588c5595fa2SJoe Perches		}
5589c5595fa2SJoe Perches
5590f34e4a4fSJoe Perches# Return of what appears to be an errno should normally be negative
5591f34e4a4fSJoe Perches		if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
559253a3c448SAndy Whitcroft			my $name = $1;
559346b85bf9SGuenter Roeck			if ($name ne 'EOF' && $name ne 'ERROR' && $name !~ /^EPOLL/) {
5594000d1cc1SJoe Perches				WARN("USE_NEGATIVE_ERRNO",
5595f34e4a4fSJoe Perches				     "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
559653a3c448SAndy Whitcroft			}
559753a3c448SAndy Whitcroft		}
5598c45dcabdSAndy Whitcroft
55990a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc
56004a0df2efSAndy Whitcroft		if ($line =~ /\b(if|while|for|switch)\(/) {
56013705ce5bSJoe Perches			if (ERROR("SPACING",
56023705ce5bSJoe Perches				  "space required before the open parenthesis '('\n" . $herecurr) &&
56033705ce5bSJoe Perches			    $fix) {
5604194f66fcSJoe Perches				$fixed[$fixlinenr] =~
56053705ce5bSJoe Perches				    s/\b(if|while|for|switch)\(/$1 \(/;
56063705ce5bSJoe Perches			}
56070a920b5bSAndy Whitcroft		}
56080a920b5bSAndy Whitcroft
5609f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing
5610f5fe35ddSAndy Whitcroft# statements after the conditional.
5611170d3a22SAndy Whitcroft		if ($line =~ /do\s*(?!{)/) {
56123e469cdcSAndy Whitcroft			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
56133e469cdcSAndy Whitcroft				ctx_statement_block($linenr, $realcnt, 0)
56143e469cdcSAndy Whitcroft					if (!defined $stat);
5615170d3a22SAndy Whitcroft			my ($stat_next) = ctx_statement_block($line_nr_next,
5616170d3a22SAndy Whitcroft						$remain_next, $off_next);
5617170d3a22SAndy Whitcroft			$stat_next =~ s/\n./\n /g;
5618170d3a22SAndy Whitcroft			##print "stat<$stat> stat_next<$stat_next>\n";
5619170d3a22SAndy Whitcroft
5620170d3a22SAndy Whitcroft			if ($stat_next =~ /^\s*while\b/) {
5621170d3a22SAndy Whitcroft				# If the statement carries leading newlines,
5622170d3a22SAndy Whitcroft				# then count those as offsets.
5623170d3a22SAndy Whitcroft				my ($whitespace) =
5624170d3a22SAndy Whitcroft					($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
5625170d3a22SAndy Whitcroft				my $offset =
5626170d3a22SAndy Whitcroft					statement_rawlines($whitespace) - 1;
5627170d3a22SAndy Whitcroft
5628170d3a22SAndy Whitcroft				$suppress_whiletrailers{$line_nr_next +
5629170d3a22SAndy Whitcroft								$offset} = 1;
5630170d3a22SAndy Whitcroft			}
5631170d3a22SAndy Whitcroft		}
5632170d3a22SAndy Whitcroft		if (!defined $suppress_whiletrailers{$linenr} &&
5633c11230f4SJoe Perches		    defined($stat) && defined($cond) &&
5634170d3a22SAndy Whitcroft		    $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
5635171ae1a4SAndy Whitcroft			my ($s, $c) = ($stat, $cond);
5636481efd7bSJoe Perches			my $fixed_assign_in_if = 0;
56378905a67cSAndy Whitcroft
5638b53c8e10SAndy Whitcroft			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
563965b64b3bSJoe Perches				if (ERROR("ASSIGN_IN_IF",
564065b64b3bSJoe Perches					  "do not use assignment in if condition\n" . $herecurr) &&
564165b64b3bSJoe Perches				    $fix && $perl_version_ok) {
564265b64b3bSJoe Perches					if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) {
564365b64b3bSJoe Perches						my $space = $1;
564465b64b3bSJoe Perches						my $not = $2;
564565b64b3bSJoe Perches						my $statement = $3;
564665b64b3bSJoe Perches						my $assigned = $4;
564765b64b3bSJoe Perches						my $test = $8;
564865b64b3bSJoe Perches						my $against = $9;
564965b64b3bSJoe Perches						my $brace = $15;
565065b64b3bSJoe Perches						fix_delete_line($fixlinenr, $rawline);
565165b64b3bSJoe Perches						fix_insert_line($fixlinenr, "$space$statement;");
565265b64b3bSJoe Perches						my $newline = "${space}if (";
565365b64b3bSJoe Perches						$newline .= '!' if defined($not);
565465b64b3bSJoe Perches						$newline .= '(' if (defined $not && defined($test) && defined($against));
565565b64b3bSJoe Perches						$newline .= "$assigned";
565665b64b3bSJoe Perches						$newline .= " $test $against" if (defined($test) && defined($against));
565765b64b3bSJoe Perches						$newline .= ')' if (defined $not && defined($test) && defined($against));
565865b64b3bSJoe Perches						$newline .= ')';
565965b64b3bSJoe Perches						$newline .= " {" if (defined($brace));
566065b64b3bSJoe Perches						fix_insert_line($fixlinenr + 1, $newline);
5661481efd7bSJoe Perches						$fixed_assign_in_if = 1;
566265b64b3bSJoe Perches					}
566365b64b3bSJoe Perches				}
56648905a67cSAndy Whitcroft			}
56658905a67cSAndy Whitcroft
56668905a67cSAndy Whitcroft			# Find out what is on the end of the line after the
56678905a67cSAndy Whitcroft			# conditional.
5668773647a0SAndy Whitcroft			substr($s, 0, length($c), '');
56698905a67cSAndy Whitcroft			$s =~ s/\n.*//g;
567013214adfSAndy Whitcroft			$s =~ s/$;//g;	# Remove any comments
567153210168SAndy Whitcroft			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
567253210168SAndy Whitcroft			    $c !~ /}\s*while\s*/)
5673773647a0SAndy Whitcroft			{
5674bb44ad39SAndy Whitcroft				# Find out how long the conditional actually is.
5675bb44ad39SAndy Whitcroft				my @newlines = ($c =~ /\n/gs);
5676bb44ad39SAndy Whitcroft				my $cond_lines = 1 + $#newlines;
567742bdf74cSHidetoshi Seto				my $stat_real = '';
5678bb44ad39SAndy Whitcroft
567942bdf74cSHidetoshi Seto				$stat_real = raw_line($linenr, $cond_lines)
568042bdf74cSHidetoshi Seto							. "\n" if ($cond_lines);
5681bb44ad39SAndy Whitcroft				if (defined($stat_real) && $cond_lines > 1) {
5682bb44ad39SAndy Whitcroft					$stat_real = "[...]\n$stat_real";
5683bb44ad39SAndy Whitcroft				}
5684bb44ad39SAndy Whitcroft
5685481efd7bSJoe Perches				if (ERROR("TRAILING_STATEMENTS",
5686481efd7bSJoe Perches					  "trailing statements should be on next line\n" . $herecurr . $stat_real) &&
5687481efd7bSJoe Perches				    !$fixed_assign_in_if &&
5688481efd7bSJoe Perches				    $cond_lines == 0 &&
5689481efd7bSJoe Perches				    $fix && $perl_version_ok &&
5690481efd7bSJoe Perches				    $fixed[$fixlinenr] =~ /^\+(\s*)((?:if|while|for)\s*$balanced_parens)\s*(.*)$/) {
5691481efd7bSJoe Perches					my $indent = $1;
5692481efd7bSJoe Perches					my $test = $2;
5693481efd7bSJoe Perches					my $rest = rtrim($4);
5694481efd7bSJoe Perches					if ($rest =~ /;$/) {
5695481efd7bSJoe Perches						$fixed[$fixlinenr] = "\+$indent$test";
5696481efd7bSJoe Perches						fix_insert_line($fixlinenr + 1, "$indent\t$rest");
5697481efd7bSJoe Perches					}
5698481efd7bSJoe Perches				}
56998905a67cSAndy Whitcroft			}
57008905a67cSAndy Whitcroft		}
57018905a67cSAndy Whitcroft
570213214adfSAndy Whitcroft# Check for bitwise tests written as boolean
570313214adfSAndy Whitcroft		if ($line =~ /
570413214adfSAndy Whitcroft			(?:
570513214adfSAndy Whitcroft				(?:\[|\(|\&\&|\|\|)
570613214adfSAndy Whitcroft				\s*0[xX][0-9]+\s*
570713214adfSAndy Whitcroft				(?:\&\&|\|\|)
570813214adfSAndy Whitcroft			|
570913214adfSAndy Whitcroft				(?:\&\&|\|\|)
571013214adfSAndy Whitcroft				\s*0[xX][0-9]+\s*
571113214adfSAndy Whitcroft				(?:\&\&|\|\||\)|\])
571213214adfSAndy Whitcroft			)/x)
571313214adfSAndy Whitcroft		{
5714000d1cc1SJoe Perches			WARN("HEXADECIMAL_BOOLEAN_TEST",
5715000d1cc1SJoe Perches			     "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
571613214adfSAndy Whitcroft		}
571713214adfSAndy Whitcroft
57188905a67cSAndy Whitcroft# if and else should not have general statements after it
571913214adfSAndy Whitcroft		if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
572013214adfSAndy Whitcroft			my $s = $1;
572113214adfSAndy Whitcroft			$s =~ s/$;//g;	# Remove any comments
572213214adfSAndy Whitcroft			if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
5723000d1cc1SJoe Perches				ERROR("TRAILING_STATEMENTS",
5724000d1cc1SJoe Perches				      "trailing statements should be on next line\n" . $herecurr);
57250a920b5bSAndy Whitcroft			}
572613214adfSAndy Whitcroft		}
572739667782SAndy Whitcroft# if should not continue a brace
572839667782SAndy Whitcroft		if ($line =~ /}\s*if\b/) {
5729000d1cc1SJoe Perches			ERROR("TRAILING_STATEMENTS",
5730048b123fSRasmus Villemoes			      "trailing statements should be on next line (or did you mean 'else if'?)\n" .
573139667782SAndy Whitcroft				$herecurr);
573239667782SAndy Whitcroft		}
5733a1080bf8SAndy Whitcroft# case and default should not have general statements after them
5734a1080bf8SAndy Whitcroft		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
5735a1080bf8SAndy Whitcroft		    $line !~ /\G(?:
57363fef12d6SAndy Whitcroft			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
5737a1080bf8SAndy Whitcroft			\s*return\s+
5738a1080bf8SAndy Whitcroft		    )/xg)
5739a1080bf8SAndy Whitcroft		{
5740000d1cc1SJoe Perches			ERROR("TRAILING_STATEMENTS",
5741000d1cc1SJoe Perches			      "trailing statements should be on next line\n" . $herecurr);
5742a1080bf8SAndy Whitcroft		}
57430a920b5bSAndy Whitcroft
57440a920b5bSAndy Whitcroft		# Check for }<nl>else {, these must be at the same
57450a920b5bSAndy Whitcroft		# indent level to be relevant to each other.
57468b8856f4SJoe Perches		if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
57470a920b5bSAndy Whitcroft		    $previndent == $indent) {
57488b8856f4SJoe Perches			if (ERROR("ELSE_AFTER_BRACE",
57498b8856f4SJoe Perches				  "else should follow close brace '}'\n" . $hereprev) &&
57508b8856f4SJoe Perches			    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
57518b8856f4SJoe Perches				fix_delete_line($fixlinenr - 1, $prevrawline);
57528b8856f4SJoe Perches				fix_delete_line($fixlinenr, $rawline);
57538b8856f4SJoe Perches				my $fixedline = $prevrawline;
57548b8856f4SJoe Perches				$fixedline =~ s/}\s*$//;
57558b8856f4SJoe Perches				if ($fixedline !~ /^\+\s*$/) {
57568b8856f4SJoe Perches					fix_insert_line($fixlinenr, $fixedline);
57578b8856f4SJoe Perches				}
57588b8856f4SJoe Perches				$fixedline = $rawline;
57598b8856f4SJoe Perches				$fixedline =~ s/^(.\s*)else/$1} else/;
57608b8856f4SJoe Perches				fix_insert_line($fixlinenr, $fixedline);
57618b8856f4SJoe Perches			}
57620a920b5bSAndy Whitcroft		}
57630a920b5bSAndy Whitcroft
57648b8856f4SJoe Perches		if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
5765c2fdda0dSAndy Whitcroft		    $previndent == $indent) {
5766c2fdda0dSAndy Whitcroft			my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
5767c2fdda0dSAndy Whitcroft
5768c2fdda0dSAndy Whitcroft			# Find out what is on the end of the line after the
5769c2fdda0dSAndy Whitcroft			# conditional.
5770773647a0SAndy Whitcroft			substr($s, 0, length($c), '');
5771c2fdda0dSAndy Whitcroft			$s =~ s/\n.*//g;
5772c2fdda0dSAndy Whitcroft
5773c2fdda0dSAndy Whitcroft			if ($s =~ /^\s*;/) {
57748b8856f4SJoe Perches				if (ERROR("WHILE_AFTER_BRACE",
57758b8856f4SJoe Perches					  "while should follow close brace '}'\n" . $hereprev) &&
57768b8856f4SJoe Perches				    $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
57778b8856f4SJoe Perches					fix_delete_line($fixlinenr - 1, $prevrawline);
57788b8856f4SJoe Perches					fix_delete_line($fixlinenr, $rawline);
57798b8856f4SJoe Perches					my $fixedline = $prevrawline;
57808b8856f4SJoe Perches					my $trailing = $rawline;
57818b8856f4SJoe Perches					$trailing =~ s/^\+//;
57828b8856f4SJoe Perches					$trailing = trim($trailing);
57838b8856f4SJoe Perches					$fixedline =~ s/}\s*$/} $trailing/;
57848b8856f4SJoe Perches					fix_insert_line($fixlinenr, $fixedline);
57858b8856f4SJoe Perches				}
5786c2fdda0dSAndy Whitcroft			}
5787c2fdda0dSAndy Whitcroft		}
5788c2fdda0dSAndy Whitcroft
578995e2c602SJoe Perches#Specific variable tests
5790323c1260SJoe Perches		while ($line =~ m{($Constant|$Lval)}g) {
5791323c1260SJoe Perches			my $var = $1;
579295e2c602SJoe Perches
579395e2c602SJoe Perches#CamelCase
5794807bd26cSJoe Perches			if ($var !~ /^$Constant$/ &&
5795be79794bSJoe Perches			    $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
57964104a206SŁukasz Stelmach#Ignore some autogenerated defines and enum values
57974104a206SŁukasz Stelmach			    $var !~ /^(?:[A-Z]+_){1,5}[A-Z]{1,3}[a-z]/ &&
579822735ce8SJoe Perches#Ignore Page<foo> variants
5799807bd26cSJoe Perches			    $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
5800d439e6a5SJoe Perches#Ignore SI style variants like nS, mV and dB
5801d439e6a5SJoe Perches#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
5802d439e6a5SJoe Perches			    $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ &&
5803f5123576SJulius Werner#Ignore some three character SI units explicitly, like MiB and KHz
5804f5123576SJulius Werner			    $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
5805f858e23aSAntonio Borneo				while ($var =~ m{\b($Ident)}g) {
58067e781f67SJoe Perches					my $word = $1;
58077e781f67SJoe Perches					next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
5808d8b07710SJoe Perches					if ($check) {
5809d8b07710SJoe Perches						seed_camelcase_includes();
5810d8b07710SJoe Perches						if (!$file && !$camelcase_file_seeded) {
5811d8b07710SJoe Perches							seed_camelcase_file($realfile);
5812d8b07710SJoe Perches							$camelcase_file_seeded = 1;
5813d8b07710SJoe Perches						}
5814d8b07710SJoe Perches					}
58157e781f67SJoe Perches					if (!defined $camelcase{$word}) {
58167e781f67SJoe Perches						$camelcase{$word} = 1;
5817be79794bSJoe Perches						CHK("CAMELCASE",
58187e781f67SJoe Perches						    "Avoid CamelCase: <$word>\n" . $herecurr);
58197e781f67SJoe Perches					}
5820323c1260SJoe Perches				}
5821323c1260SJoe Perches			}
58223445686aSJoe Perches		}
58230a920b5bSAndy Whitcroft
58240a920b5bSAndy Whitcroft#no spaces allowed after \ in define
5825d5e616fcSJoe Perches		if ($line =~ /\#\s*define.*\\\s+$/) {
5826d5e616fcSJoe Perches			if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
5827d5e616fcSJoe Perches				 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
5828d5e616fcSJoe Perches			    $fix) {
5829194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/\s+$//;
5830d5e616fcSJoe Perches			}
58310a920b5bSAndy Whitcroft		}
58320a920b5bSAndy Whitcroft
58330e212e0aSFabian Frederick# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
58340e212e0aSFabian Frederick# itself <asm/foo.h> (uses RAW line)
5835c45dcabdSAndy Whitcroft		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
5836e09dec48SAndy Whitcroft			my $file = "$1.h";
5837e09dec48SAndy Whitcroft			my $checkfile = "include/linux/$file";
5838e09dec48SAndy Whitcroft			if (-f "$root/$checkfile" &&
5839e09dec48SAndy Whitcroft			    $realfile ne $checkfile &&
58407840a94cSWolfram Sang			    $1 !~ /$allowed_asm_includes/)
5841c45dcabdSAndy Whitcroft			{
58420e212e0aSFabian Frederick				my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
58430e212e0aSFabian Frederick				if ($asminclude > 0) {
5844e09dec48SAndy Whitcroft					if ($realfile =~ m{^arch/}) {
5845000d1cc1SJoe Perches						CHK("ARCH_INCLUDE_LINUX",
5846000d1cc1SJoe Perches						    "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5847e09dec48SAndy Whitcroft					} else {
5848000d1cc1SJoe Perches						WARN("INCLUDE_LINUX",
5849000d1cc1SJoe Perches						     "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5850e09dec48SAndy Whitcroft					}
58510a920b5bSAndy Whitcroft				}
58520a920b5bSAndy Whitcroft			}
58530e212e0aSFabian Frederick		}
58540a920b5bSAndy Whitcroft
5855653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the
5856653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed
5857cf655043SAndy Whitcroft# in a known good container
5858b8f96a31SAndy Whitcroft		if ($realfile !~ m@/vmlinux.lds.h$@ &&
5859b8f96a31SAndy Whitcroft		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
5860d8aaf121SAndy Whitcroft			my $ln = $linenr;
5861d8aaf121SAndy Whitcroft			my $cnt = $realcnt;
5862c45dcabdSAndy Whitcroft			my ($off, $dstat, $dcond, $rest);
5863c45dcabdSAndy Whitcroft			my $ctx = '';
586408a2843eSJoe Perches			my $has_flow_statement = 0;
586508a2843eSJoe Perches			my $has_arg_concat = 0;
5866c45dcabdSAndy Whitcroft			($dstat, $dcond, $ln, $cnt, $off) =
5867f74bd194SAndy Whitcroft				ctx_statement_block($linenr, $realcnt, 0);
5868f74bd194SAndy Whitcroft			$ctx = $dstat;
5869c45dcabdSAndy Whitcroft			#print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5870a3bb97a7SAndy Whitcroft			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5871c45dcabdSAndy Whitcroft
587208a2843eSJoe Perches			$has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
587362e15a6dSJoe Perches			$has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
587408a2843eSJoe Perches
5875f59b64bfSJoe Perches			$dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
5876f59b64bfSJoe Perches			my $define_args = $1;
5877f59b64bfSJoe Perches			my $define_stmt = $dstat;
5878f59b64bfSJoe Perches			my @def_args = ();
5879f59b64bfSJoe Perches
5880f59b64bfSJoe Perches			if (defined $define_args && $define_args ne "") {
5881f59b64bfSJoe Perches				$define_args = substr($define_args, 1, length($define_args) - 2);
5882f59b64bfSJoe Perches				$define_args =~ s/\s*//g;
58838c8c45cfSJoe Perches				$define_args =~ s/\\\+?//g;
5884f59b64bfSJoe Perches				@def_args = split(",", $define_args);
5885f59b64bfSJoe Perches			}
5886f59b64bfSJoe Perches
5887292f1a9bSAndy Whitcroft			$dstat =~ s/$;//g;
5888c45dcabdSAndy Whitcroft			$dstat =~ s/\\\n.//g;
5889c45dcabdSAndy Whitcroft			$dstat =~ s/^\s*//s;
5890c45dcabdSAndy Whitcroft			$dstat =~ s/\s*$//s;
5891c45dcabdSAndy Whitcroft
5892c45dcabdSAndy Whitcroft			# Flatten any parentheses and braces
58932e44e803SDwaipayan Ray			while ($dstat =~ s/\([^\(\)]*\)/1u/ ||
58942e44e803SDwaipayan Ray			       $dstat =~ s/\{[^\{\}]*\}/1u/ ||
58952e44e803SDwaipayan Ray			       $dstat =~ s/.\[[^\[\]]*\]/1u/)
5896bf30d6edSAndy Whitcroft			{
5897c45dcabdSAndy Whitcroft			}
5898c45dcabdSAndy Whitcroft
5899342d3d2fSAntonio Borneo			# Flatten any obvious string concatenation.
590033acb54aSJoe Perches			while ($dstat =~ s/($String)\s*$Ident/$1/ ||
590133acb54aSJoe Perches			       $dstat =~ s/$Ident\s*($String)/$1/)
5902e45bab8eSAndy Whitcroft			{
5903e45bab8eSAndy Whitcroft			}
5904e45bab8eSAndy Whitcroft
590542e15293SJoe Perches			# Make asm volatile uses seem like a generic function
590642e15293SJoe Perches			$dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
590742e15293SJoe Perches
5908c45dcabdSAndy Whitcroft			my $exceptions = qr{
5909c45dcabdSAndy Whitcroft				$Declare|
5910c45dcabdSAndy Whitcroft				module_param_named|
5911a0a0a7a9SKees Cook				MODULE_PARM_DESC|
5912c45dcabdSAndy Whitcroft				DECLARE_PER_CPU|
5913c45dcabdSAndy Whitcroft				DEFINE_PER_CPU|
5914383099fdSAndy Whitcroft				__typeof__\(|
591522fd2d3eSStefani Seibold				union|
591622fd2d3eSStefani Seibold				struct|
5917ea71a0a0SAndy Whitcroft				\.$Ident\s*=\s*|
59186b10df42SVladimir Zapolskiy				^\"|\"$|
59196b10df42SVladimir Zapolskiy				^\[
5920c45dcabdSAndy Whitcroft			}x;
59215eaa20b9SAndy Whitcroft			#print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5922f59b64bfSJoe Perches
5923f59b64bfSJoe Perches			$ctx =~ s/\n*$//;
5924f59b64bfSJoe Perches			my $stmt_cnt = statement_rawlines($ctx);
5925e3d95a2aSTobin C. Harding			my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
5926f59b64bfSJoe Perches
5927f74bd194SAndy Whitcroft			if ($dstat ne '' &&
5928f74bd194SAndy Whitcroft			    $dstat !~ /^(?:$Ident|-?$Constant),$/ &&			# 10, // foo(),
5929f74bd194SAndy Whitcroft			    $dstat !~ /^(?:$Ident|-?$Constant);$/ &&			# foo();
59303cc4b1c3SJoe Perches			    $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ &&		# 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5931356fd398SJoe Perches			    $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ &&			# character constants
5932f74bd194SAndy Whitcroft			    $dstat !~ /$exceptions/ &&
5933f74bd194SAndy Whitcroft			    $dstat !~ /^\.$Ident\s*=/ &&				# .foo =
5934e942e2c3SJoe Perches			    $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ &&		# stringification #foo
5935dc3f4deeSStanislaw Gruszka			    $dstat !~ /^case\b/ &&					# case ...
593672f115f9SAndy Whitcroft			    $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ &&	# do {...} while (...); // do {...} while (...)
59372e44e803SDwaipayan Ray			    $dstat !~ /^while\s*$Constant\s*$Constant\s*$/ &&		# while (...) {...}
5938f74bd194SAndy Whitcroft			    $dstat !~ /^for\s*$Constant$/ &&				# for (...)
5939f74bd194SAndy Whitcroft			    $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ &&	# for (...) bar()
5940f74bd194SAndy Whitcroft			    $dstat !~ /^do\s*{/ &&					# do {...
59414e5d56bdSEddie Kovsky			    $dstat !~ /^\(\{/ &&						# ({...
5942f95a7e6aSJoe Perches			    $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
5943c45dcabdSAndy Whitcroft			{
5944e795556aSJoe Perches				if ($dstat =~ /^\s*if\b/) {
5945e795556aSJoe Perches					ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5946e795556aSJoe Perches					      "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5947e795556aSJoe Perches				} elsif ($dstat =~ /;/) {
5948f74bd194SAndy Whitcroft					ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5949f74bd194SAndy Whitcroft					      "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5950f74bd194SAndy Whitcroft				} else {
5951000d1cc1SJoe Perches					ERROR("COMPLEX_MACRO",
5952388982b5SAndrew Morton					      "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
5953d8aaf121SAndy Whitcroft				}
5954f59b64bfSJoe Perches
5955f59b64bfSJoe Perches			}
59565207649bSJoe Perches
59575207649bSJoe Perches			# Make $define_stmt single line, comment-free, etc
59585207649bSJoe Perches			my @stmt_array = split('\n', $define_stmt);
59595207649bSJoe Perches			my $first = 1;
59605207649bSJoe Perches			$define_stmt = "";
59615207649bSJoe Perches			foreach my $l (@stmt_array) {
59625207649bSJoe Perches				$l =~ s/\\$//;
59635207649bSJoe Perches				if ($first) {
59645207649bSJoe Perches					$define_stmt = $l;
59655207649bSJoe Perches					$first = 0;
59665207649bSJoe Perches				} elsif ($l =~ /^[\+ ]/) {
59675207649bSJoe Perches					$define_stmt .= substr($l, 1);
59685207649bSJoe Perches				}
59695207649bSJoe Perches			}
59705207649bSJoe Perches			$define_stmt =~ s/$;//g;
59715207649bSJoe Perches			$define_stmt =~ s/\s+/ /g;
59725207649bSJoe Perches			$define_stmt = trim($define_stmt);
59735207649bSJoe Perches
5974f59b64bfSJoe Perches# check if any macro arguments are reused (ignore '...' and 'type')
5975f59b64bfSJoe Perches			foreach my $arg (@def_args) {
5976f59b64bfSJoe Perches			        next if ($arg =~ /\.\.\./);
59779192d41aSJoe Perches			        next if ($arg =~ /^type$/i);
59787fe528a2SJoe Perches				my $tmp_stmt = $define_stmt;
59797b844345SVincent Mailhol				$tmp_stmt =~ s/\b(__must_be_array|offsetof|sizeof|sizeof_field|__stringify|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
59807fe528a2SJoe Perches				$tmp_stmt =~ s/\#+\s*$arg\b//g;
59817fe528a2SJoe Perches				$tmp_stmt =~ s/\b$arg\s*\#\#//g;
5982d41362edSJoe Perches				my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
5983f59b64bfSJoe Perches				if ($use_cnt > 1) {
5984f59b64bfSJoe Perches					CHK("MACRO_ARG_REUSE",
5985f59b64bfSJoe Perches					    "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
5986f59b64bfSJoe Perches				    }
59879192d41aSJoe Perches# check if any macro arguments may have other precedence issues
59887fe528a2SJoe Perches				if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
59899192d41aSJoe Perches				    ((defined($1) && $1 ne ',') ||
59909192d41aSJoe Perches				     (defined($2) && $2 ne ','))) {
59919192d41aSJoe Perches					CHK("MACRO_ARG_PRECEDENCE",
59929192d41aSJoe Perches					    "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
59939192d41aSJoe Perches				}
59940a920b5bSAndy Whitcroft			}
59955023d347SJoe Perches
599608a2843eSJoe Perches# check for macros with flow control, but without ## concatenation
599708a2843eSJoe Perches# ## concatenation is commonly a macro that defines a function so ignore those
599808a2843eSJoe Perches			if ($has_flow_statement && !$has_arg_concat) {
599908a2843eSJoe Perches				my $cnt = statement_rawlines($ctx);
6000e3d95a2aSTobin C. Harding				my $herectx = get_stat_here($linenr, $cnt, $here);
600108a2843eSJoe Perches
600208a2843eSJoe Perches				WARN("MACRO_WITH_FLOW_CONTROL",
600308a2843eSJoe Perches				     "Macros with flow control statements should be avoided\n" . "$herectx");
600408a2843eSJoe Perches			}
600508a2843eSJoe Perches
6006481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm
60075023d347SJoe Perches
60085023d347SJoe Perches		} else {
60095023d347SJoe Perches			if ($prevline !~ /^..*\\$/ &&
6010481eb486SJoe Perches			    $line !~ /^\+\s*\#.*\\$/ &&		# preprocessor
6011481eb486SJoe Perches			    $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ &&	# asm
60125023d347SJoe Perches			    $line =~ /^\+.*\\$/) {
60135023d347SJoe Perches				WARN("LINE_CONTINUATIONS",
60145023d347SJoe Perches				     "Avoid unnecessary line continuations\n" . $herecurr);
60155023d347SJoe Perches			}
6016653d4876SAndy Whitcroft		}
60170a920b5bSAndy Whitcroft
6018b13edf7fSJoe Perches# do {} while (0) macro tests:
6019b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop,
6020b13edf7fSJoe Perches# macro should not end with a semicolon
60215b57980dSJoe Perches		if ($perl_version_ok &&
6022b13edf7fSJoe Perches		    $realfile !~ m@/vmlinux.lds.h$@ &&
6023b13edf7fSJoe Perches		    $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
6024b13edf7fSJoe Perches			my $ln = $linenr;
6025b13edf7fSJoe Perches			my $cnt = $realcnt;
6026b13edf7fSJoe Perches			my ($off, $dstat, $dcond, $rest);
6027b13edf7fSJoe Perches			my $ctx = '';
6028b13edf7fSJoe Perches			($dstat, $dcond, $ln, $cnt, $off) =
6029b13edf7fSJoe Perches				ctx_statement_block($linenr, $realcnt, 0);
6030b13edf7fSJoe Perches			$ctx = $dstat;
6031b13edf7fSJoe Perches
6032b13edf7fSJoe Perches			$dstat =~ s/\\\n.//g;
60331b36b201SJoe Perches			$dstat =~ s/$;/ /g;
6034b13edf7fSJoe Perches
6035b13edf7fSJoe Perches			if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
6036b13edf7fSJoe Perches				my $stmts = $2;
6037b13edf7fSJoe Perches				my $semis = $3;
6038b13edf7fSJoe Perches
6039b13edf7fSJoe Perches				$ctx =~ s/\n*$//;
6040b13edf7fSJoe Perches				my $cnt = statement_rawlines($ctx);
6041e3d95a2aSTobin C. Harding				my $herectx = get_stat_here($linenr, $cnt, $here);
6042b13edf7fSJoe Perches
6043ac8e97f8SJoe Perches				if (($stmts =~ tr/;/;/) == 1 &&
6044ac8e97f8SJoe Perches				    $stmts !~ /^\s*(if|while|for|switch)\b/) {
6045b13edf7fSJoe Perches					WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
6046b13edf7fSJoe Perches					     "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
6047b13edf7fSJoe Perches				}
6048b13edf7fSJoe Perches				if (defined $semis && $semis ne "") {
6049b13edf7fSJoe Perches					WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
6050b13edf7fSJoe Perches					     "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
6051b13edf7fSJoe Perches				}
6052f5ef95b1SJoe Perches			} elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
6053f5ef95b1SJoe Perches				$ctx =~ s/\n*$//;
6054f5ef95b1SJoe Perches				my $cnt = statement_rawlines($ctx);
6055e3d95a2aSTobin C. Harding				my $herectx = get_stat_here($linenr, $cnt, $here);
6056f5ef95b1SJoe Perches
6057f5ef95b1SJoe Perches				WARN("TRAILING_SEMICOLON",
6058f5ef95b1SJoe Perches				     "macros should not use a trailing semicolon\n" . "$herectx");
6059b13edf7fSJoe Perches			}
6060b13edf7fSJoe Perches		}
6061b13edf7fSJoe Perches
6062f0a594c1SAndy Whitcroft# check for redundant bracing round if etc
606313214adfSAndy Whitcroft		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
606413214adfSAndy Whitcroft			my ($level, $endln, @chunks) =
6065cf655043SAndy Whitcroft				ctx_statement_full($linenr, $realcnt, 1);
606613214adfSAndy Whitcroft			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
6067cf655043SAndy Whitcroft			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
6068cf655043SAndy Whitcroft			if ($#chunks > 0 && $level == 0) {
6069aad4f614SJoe Perches				my @allowed = ();
6070aad4f614SJoe Perches				my $allow = 0;
607113214adfSAndy Whitcroft				my $seen = 0;
6072773647a0SAndy Whitcroft				my $herectx = $here . "\n";
6073cf655043SAndy Whitcroft				my $ln = $linenr - 1;
607413214adfSAndy Whitcroft				for my $chunk (@chunks) {
607513214adfSAndy Whitcroft					my ($cond, $block) = @{$chunk};
607613214adfSAndy Whitcroft
6077773647a0SAndy Whitcroft					# If the condition carries leading newlines, then count those as offsets.
6078773647a0SAndy Whitcroft					my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
6079773647a0SAndy Whitcroft					my $offset = statement_rawlines($whitespace) - 1;
6080773647a0SAndy Whitcroft
6081aad4f614SJoe Perches					$allowed[$allow] = 0;
6082773647a0SAndy Whitcroft					#print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
6083773647a0SAndy Whitcroft
6084773647a0SAndy Whitcroft					# We have looked at and allowed this specific line.
6085773647a0SAndy Whitcroft					$suppress_ifbraces{$ln + $offset} = 1;
6086773647a0SAndy Whitcroft
6087773647a0SAndy Whitcroft					$herectx .= "$rawlines[$ln + $offset]\n[...]\n";
6088cf655043SAndy Whitcroft					$ln += statement_rawlines($block) - 1;
6089cf655043SAndy Whitcroft
6090773647a0SAndy Whitcroft					substr($block, 0, length($cond), '');
609113214adfSAndy Whitcroft
609213214adfSAndy Whitcroft					$seen++ if ($block =~ /^\s*{/);
609313214adfSAndy Whitcroft
6094aad4f614SJoe Perches					#print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
6095cf655043SAndy Whitcroft					if (statement_lines($cond) > 1) {
6096cf655043SAndy Whitcroft						#print "APW: ALLOWED: cond<$cond>\n";
6097aad4f614SJoe Perches						$allowed[$allow] = 1;
609813214adfSAndy Whitcroft					}
609913214adfSAndy Whitcroft					if ($block =~/\b(?:if|for|while)\b/) {
6100cf655043SAndy Whitcroft						#print "APW: ALLOWED: block<$block>\n";
6101aad4f614SJoe Perches						$allowed[$allow] = 1;
610213214adfSAndy Whitcroft					}
6103cf655043SAndy Whitcroft					if (statement_block_size($block) > 1) {
6104cf655043SAndy Whitcroft						#print "APW: ALLOWED: lines block<$block>\n";
6105aad4f614SJoe Perches						$allowed[$allow] = 1;
610613214adfSAndy Whitcroft					}
6107aad4f614SJoe Perches					$allow++;
610813214adfSAndy Whitcroft				}
6109aad4f614SJoe Perches				if ($seen) {
6110aad4f614SJoe Perches					my $sum_allowed = 0;
6111aad4f614SJoe Perches					foreach (@allowed) {
6112aad4f614SJoe Perches						$sum_allowed += $_;
6113aad4f614SJoe Perches					}
6114aad4f614SJoe Perches					if ($sum_allowed == 0) {
6115000d1cc1SJoe Perches						WARN("BRACES",
6116000d1cc1SJoe Perches						     "braces {} are not necessary for any arm of this statement\n" . $herectx);
6117aad4f614SJoe Perches					} elsif ($sum_allowed != $allow &&
6118aad4f614SJoe Perches						 $seen != $allow) {
6119aad4f614SJoe Perches						CHK("BRACES",
6120aad4f614SJoe Perches						    "braces {} should be used on all arms of this statement\n" . $herectx);
6121aad4f614SJoe Perches					}
612213214adfSAndy Whitcroft				}
612313214adfSAndy Whitcroft			}
612413214adfSAndy Whitcroft		}
6125773647a0SAndy Whitcroft		if (!defined $suppress_ifbraces{$linenr - 1} &&
612613214adfSAndy Whitcroft					$line =~ /\b(if|while|for|else)\b/) {
6127cf655043SAndy Whitcroft			my $allowed = 0;
6128f0a594c1SAndy Whitcroft
6129cf655043SAndy Whitcroft			# Check the pre-context.
6130cf655043SAndy Whitcroft			if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
6131cf655043SAndy Whitcroft				#print "APW: ALLOWED: pre<$1>\n";
6132cf655043SAndy Whitcroft				$allowed = 1;
6133f0a594c1SAndy Whitcroft			}
6134773647a0SAndy Whitcroft
6135773647a0SAndy Whitcroft			my ($level, $endln, @chunks) =
6136773647a0SAndy Whitcroft				ctx_statement_full($linenr, $realcnt, $-[0]);
6137773647a0SAndy Whitcroft
6138cf655043SAndy Whitcroft			# Check the condition.
6139cf655043SAndy Whitcroft			my ($cond, $block) = @{$chunks[0]};
6140773647a0SAndy Whitcroft			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
6141cf655043SAndy Whitcroft			if (defined $cond) {
6142773647a0SAndy Whitcroft				substr($block, 0, length($cond), '');
6143cf655043SAndy Whitcroft			}
6144cf655043SAndy Whitcroft			if (statement_lines($cond) > 1) {
6145cf655043SAndy Whitcroft				#print "APW: ALLOWED: cond<$cond>\n";
6146cf655043SAndy Whitcroft				$allowed = 1;
6147cf655043SAndy Whitcroft			}
6148cf655043SAndy Whitcroft			if ($block =~/\b(?:if|for|while)\b/) {
6149cf655043SAndy Whitcroft				#print "APW: ALLOWED: block<$block>\n";
6150cf655043SAndy Whitcroft				$allowed = 1;
6151cf655043SAndy Whitcroft			}
6152cf655043SAndy Whitcroft			if (statement_block_size($block) > 1) {
6153cf655043SAndy Whitcroft				#print "APW: ALLOWED: lines block<$block>\n";
6154cf655043SAndy Whitcroft				$allowed = 1;
6155cf655043SAndy Whitcroft			}
6156cf655043SAndy Whitcroft			# Check the post-context.
6157cf655043SAndy Whitcroft			if (defined $chunks[1]) {
6158cf655043SAndy Whitcroft				my ($cond, $block) = @{$chunks[1]};
6159cf655043SAndy Whitcroft				if (defined $cond) {
6160773647a0SAndy Whitcroft					substr($block, 0, length($cond), '');
6161cf655043SAndy Whitcroft				}
6162cf655043SAndy Whitcroft				if ($block =~ /^\s*\{/) {
6163cf655043SAndy Whitcroft					#print "APW: ALLOWED: chunk-1 block<$block>\n";
6164cf655043SAndy Whitcroft					$allowed = 1;
6165cf655043SAndy Whitcroft				}
6166cf655043SAndy Whitcroft			}
6167cf655043SAndy Whitcroft			if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
6168f055663cSAndy Whitcroft				my $cnt = statement_rawlines($block);
6169e3d95a2aSTobin C. Harding				my $herectx = get_stat_here($linenr, $cnt, $here);
6170cf655043SAndy Whitcroft
6171000d1cc1SJoe Perches				WARN("BRACES",
6172000d1cc1SJoe Perches				     "braces {} are not necessary for single statement blocks\n" . $herectx);
6173f0a594c1SAndy Whitcroft			}
6174f0a594c1SAndy Whitcroft		}
6175f0a594c1SAndy Whitcroft
6176e4c5babdSJoe Perches# check for single line unbalanced braces
617795330473SSven Eckelmann		if ($sline =~ /^.\s*\}\s*else\s*$/ ||
617895330473SSven Eckelmann		    $sline =~ /^.\s*else\s*\{\s*$/) {
6179e4c5babdSJoe Perches			CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
6180e4c5babdSJoe Perches		}
6181e4c5babdSJoe Perches
61820979ae66SJoe Perches# check for unnecessary blank lines around braces
618377b9a53aSJoe Perches		if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
6184f8e58219SJoe Perches			if (CHK("BRACES",
6185f8e58219SJoe Perches				"Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
6186f8e58219SJoe Perches			    $fix && $prevrawline =~ /^\+/) {
6187f8e58219SJoe Perches				fix_delete_line($fixlinenr - 1, $prevrawline);
6188f8e58219SJoe Perches			}
61890979ae66SJoe Perches		}
619077b9a53aSJoe Perches		if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
6191f8e58219SJoe Perches			if (CHK("BRACES",
6192f8e58219SJoe Perches				"Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
6193f8e58219SJoe Perches			    $fix) {
6194f8e58219SJoe Perches				fix_delete_line($fixlinenr, $rawline);
6195f8e58219SJoe Perches			}
61960979ae66SJoe Perches		}
61970979ae66SJoe Perches
61984a0df2efSAndy Whitcroft# no volatiles please
61996c72ffaaSAndy Whitcroft		my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
62006c72ffaaSAndy Whitcroft		if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
6201000d1cc1SJoe Perches			WARN("VOLATILE",
62028c27ceffSMauro Carvalho Chehab			     "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
62034a0df2efSAndy Whitcroft		}
62044a0df2efSAndy Whitcroft
62055e4f6ba5SJoe Perches# Check for user-visible strings broken across lines, which breaks the ability
62065e4f6ba5SJoe Perches# to grep for the string.  Make exceptions when the previous string ends in a
62075e4f6ba5SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
62085e4f6ba5SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
620933acb54aSJoe Perches		if ($line =~ /^\+\s*$String/ &&
62105e4f6ba5SJoe Perches		    $prevline =~ /"\s*$/ &&
62115e4f6ba5SJoe Perches		    $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
62125e4f6ba5SJoe Perches			if (WARN("SPLIT_STRING",
62135e4f6ba5SJoe Perches				 "quoted string split across lines\n" . $hereprev) &&
62145e4f6ba5SJoe Perches				     $fix &&
62155e4f6ba5SJoe Perches				     $prevrawline =~ /^\+.*"\s*$/ &&
62165e4f6ba5SJoe Perches				     $last_coalesced_string_linenr != $linenr - 1) {
62175e4f6ba5SJoe Perches				my $extracted_string = get_quoted_string($line, $rawline);
62185e4f6ba5SJoe Perches				my $comma_close = "";
62195e4f6ba5SJoe Perches				if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
62205e4f6ba5SJoe Perches					$comma_close = $1;
62215e4f6ba5SJoe Perches				}
62225e4f6ba5SJoe Perches
62235e4f6ba5SJoe Perches				fix_delete_line($fixlinenr - 1, $prevrawline);
62245e4f6ba5SJoe Perches				fix_delete_line($fixlinenr, $rawline);
62255e4f6ba5SJoe Perches				my $fixedline = $prevrawline;
62265e4f6ba5SJoe Perches				$fixedline =~ s/"\s*$//;
62275e4f6ba5SJoe Perches				$fixedline .= substr($extracted_string, 1) . trim($comma_close);
62285e4f6ba5SJoe Perches				fix_insert_line($fixlinenr - 1, $fixedline);
62295e4f6ba5SJoe Perches				$fixedline = $rawline;
62305e4f6ba5SJoe Perches				$fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
62315e4f6ba5SJoe Perches				if ($fixedline !~ /\+\s*$/) {
62325e4f6ba5SJoe Perches					fix_insert_line($fixlinenr, $fixedline);
62335e4f6ba5SJoe Perches				}
62345e4f6ba5SJoe Perches				$last_coalesced_string_linenr = $linenr;
62355e4f6ba5SJoe Perches			}
62365e4f6ba5SJoe Perches		}
62375e4f6ba5SJoe Perches
62385e4f6ba5SJoe Perches# check for missing a space in a string concatenation
62395e4f6ba5SJoe Perches		if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
62405e4f6ba5SJoe Perches			WARN('MISSING_SPACE',
62415e4f6ba5SJoe Perches			     "break quoted strings at a space character\n" . $hereprev);
62425e4f6ba5SJoe Perches		}
62435e4f6ba5SJoe Perches
624477cb8546SJoe Perches# check for an embedded function name in a string when the function is known
6245e4b7d309SJoe Perches# This does not work very well for -f --file checking as it depends on patch
6246e4b7d309SJoe Perches# context providing the function name or a single line form for in-file
6247e4b7d309SJoe Perches# function declarations
624877cb8546SJoe Perches		if ($line =~ /^\+.*$String/ &&
624977cb8546SJoe Perches		    defined($context_function) &&
6250e4b7d309SJoe Perches		    get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
6251e4b7d309SJoe Perches		    length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
625277cb8546SJoe Perches			WARN("EMBEDDED_FUNCTION_NAME",
6253e4b7d309SJoe Perches			     "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
625477cb8546SJoe Perches		}
625577cb8546SJoe Perches
6256adb2da82SJoe Perches# check for unnecessary function tracing like uses
6257adb2da82SJoe Perches# This does not use $logFunctions because there are many instances like
6258adb2da82SJoe Perches# 'dprintk(FOO, "%s()\n", __func__);' which do not match $logFunctions
6259adb2da82SJoe Perches		if ($rawline =~ /^\+.*\([^"]*"$tracing_logging_tags{0,3}%s(?:\s*\(\s*\)\s*)?$tracing_logging_tags{0,3}(?:\\n)?"\s*,\s*__func__\s*\)\s*;/) {
6260adb2da82SJoe Perches			if (WARN("TRACING_LOGGING",
6261adb2da82SJoe Perches				 "Unnecessary ftrace-like logging - prefer using ftrace\n" . $herecurr) &&
6262adb2da82SJoe Perches			    $fix) {
6263adb2da82SJoe Perches                                fix_delete_line($fixlinenr, $rawline);
6264adb2da82SJoe Perches			}
6265adb2da82SJoe Perches		}
6266adb2da82SJoe Perches
62675e4f6ba5SJoe Perches# check for spaces before a quoted newline
62685e4f6ba5SJoe Perches		if ($rawline =~ /^.*\".*\s\\n/) {
62695e4f6ba5SJoe Perches			if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
62705e4f6ba5SJoe Perches				 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
62715e4f6ba5SJoe Perches			    $fix) {
62725e4f6ba5SJoe Perches				$fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
62735e4f6ba5SJoe Perches			}
62745e4f6ba5SJoe Perches
62755e4f6ba5SJoe Perches		}
62765e4f6ba5SJoe Perches
6277f17dba4fSJoe Perches# concatenated string without spaces between elements
6278d2af5aa6SJoe Perches		if ($line =~ /$String[A-Z_]/ ||
6279d2af5aa6SJoe Perches		    ($line =~ /([A-Za-z0-9_]+)$String/ && $1 !~ /^[Lu]$/)) {
628079682c0cSJoe Perches			if (CHK("CONCATENATED_STRING",
628179682c0cSJoe Perches				"Concatenated strings should use spaces between elements\n" . $herecurr) &&
628279682c0cSJoe Perches			    $fix) {
628379682c0cSJoe Perches				while ($line =~ /($String)/g) {
628479682c0cSJoe Perches					my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
628579682c0cSJoe Perches					$fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/;
628679682c0cSJoe Perches					$fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/;
628779682c0cSJoe Perches				}
628879682c0cSJoe Perches			}
6289f17dba4fSJoe Perches		}
6290f17dba4fSJoe Perches
629190ad30e5SJoe Perches# uncoalesced string fragments
6292d2af5aa6SJoe Perches		if ($line =~ /$String\s*[Lu]?"/) {
629379682c0cSJoe Perches			if (WARN("STRING_FRAGMENTS",
629479682c0cSJoe Perches				 "Consecutive strings are generally better as a single string\n" . $herecurr) &&
629579682c0cSJoe Perches			    $fix) {
629679682c0cSJoe Perches				while ($line =~ /($String)(?=\s*")/g) {
629779682c0cSJoe Perches					my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
629879682c0cSJoe Perches					$fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e;
629979682c0cSJoe Perches				}
630079682c0cSJoe Perches			}
630190ad30e5SJoe Perches		}
630290ad30e5SJoe Perches
6303522b837cSAlexey Dobriyan# check for non-standard and hex prefixed decimal printf formats
6304522b837cSAlexey Dobriyan		my $show_L = 1;	#don't show the same defect twice
6305522b837cSAlexey Dobriyan		my $show_Z = 1;
63065e4f6ba5SJoe Perches		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
6307522b837cSAlexey Dobriyan			my $string = substr($rawline, $-[1], $+[1] - $-[1]);
63085e4f6ba5SJoe Perches			$string =~ s/%%/__/g;
6309522b837cSAlexey Dobriyan			# check for %L
6310522b837cSAlexey Dobriyan			if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
63115e4f6ba5SJoe Perches				WARN("PRINTF_L",
6312522b837cSAlexey Dobriyan				     "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
6313522b837cSAlexey Dobriyan				$show_L = 0;
63145e4f6ba5SJoe Perches			}
6315522b837cSAlexey Dobriyan			# check for %Z
6316522b837cSAlexey Dobriyan			if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
6317522b837cSAlexey Dobriyan				WARN("PRINTF_Z",
6318522b837cSAlexey Dobriyan				     "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
6319522b837cSAlexey Dobriyan				$show_Z = 0;
6320522b837cSAlexey Dobriyan			}
6321522b837cSAlexey Dobriyan			# check for 0x<decimal>
6322522b837cSAlexey Dobriyan			if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
6323522b837cSAlexey Dobriyan				ERROR("PRINTF_0XDECIMAL",
63246e300757SJoe Perches				      "Prefixing 0x with decimal output is defective\n" . $herecurr);
63256e300757SJoe Perches			}
63265e4f6ba5SJoe Perches		}
63275e4f6ba5SJoe Perches
63285e4f6ba5SJoe Perches# check for line continuations in quoted strings with odd counts of "
63293f7f335dSJoe Perches		if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
63305e4f6ba5SJoe Perches			WARN("LINE_CONTINUATIONS",
63315e4f6ba5SJoe Perches			     "Avoid line continuations in quoted strings\n" . $herecurr);
63325e4f6ba5SJoe Perches		}
63335e4f6ba5SJoe Perches
633400df344fSAndy Whitcroft# warn about #if 0
6335c45dcabdSAndy Whitcroft		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
633660f89010SPrakruthi Deepak Heragu			WARN("IF_0",
633760f89010SPrakruthi Deepak Heragu			     "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr);
633860f89010SPrakruthi Deepak Heragu		}
633960f89010SPrakruthi Deepak Heragu
634060f89010SPrakruthi Deepak Heragu# warn about #if 1
634160f89010SPrakruthi Deepak Heragu		if ($line =~ /^.\s*\#\s*if\s+1\b/) {
634260f89010SPrakruthi Deepak Heragu			WARN("IF_1",
634360f89010SPrakruthi Deepak Heragu			     "Consider removing the #if 1 and its #endif\n" . $herecurr);
63444a0df2efSAndy Whitcroft		}
63454a0df2efSAndy Whitcroft
634603df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses
634703df4b51SAndy Whitcroft		if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
6348100425deSJoe Perches			my $tested = quotemeta($1);
6349100425deSJoe Perches			my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
6350100425deSJoe Perches			if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
6351100425deSJoe Perches				my $func = $1;
6352100425deSJoe Perches				if (WARN('NEEDLESS_IF',
6353100425deSJoe Perches					 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
6354100425deSJoe Perches				    $fix) {
6355100425deSJoe Perches					my $do_fix = 1;
6356100425deSJoe Perches					my $leading_tabs = "";
6357100425deSJoe Perches					my $new_leading_tabs = "";
6358100425deSJoe Perches					if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
6359100425deSJoe Perches						$leading_tabs = $1;
6360100425deSJoe Perches					} else {
6361100425deSJoe Perches						$do_fix = 0;
6362100425deSJoe Perches					}
6363100425deSJoe Perches					if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
6364100425deSJoe Perches						$new_leading_tabs = $1;
6365100425deSJoe Perches						if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
6366100425deSJoe Perches							$do_fix = 0;
6367100425deSJoe Perches						}
6368100425deSJoe Perches					} else {
6369100425deSJoe Perches						$do_fix = 0;
6370100425deSJoe Perches					}
6371100425deSJoe Perches					if ($do_fix) {
6372100425deSJoe Perches						fix_delete_line($fixlinenr - 1, $prevrawline);
6373100425deSJoe Perches						$fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
6374100425deSJoe Perches					}
6375100425deSJoe Perches				}
63764c432a8fSGreg Kroah-Hartman			}
63774c432a8fSGreg Kroah-Hartman		}
6378f0a594c1SAndy Whitcroft
6379ebfdc409SJoe Perches# check for unnecessary "Out of Memory" messages
6380ebfdc409SJoe Perches		if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
6381ebfdc409SJoe Perches		    $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
6382ebfdc409SJoe Perches		    (defined $1 || defined $3) &&
6383ebfdc409SJoe Perches		    $linenr > 3) {
6384ebfdc409SJoe Perches			my $testval = $2;
6385ebfdc409SJoe Perches			my $testline = $lines[$linenr - 3];
6386ebfdc409SJoe Perches
6387ebfdc409SJoe Perches			my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
6388ebfdc409SJoe Perches#			print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
6389ebfdc409SJoe Perches
6390e29a70f1SJoe Perches			if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
6391e29a70f1SJoe Perches			    $s !~ /\b__GFP_NOWARN\b/ ) {
6392ebfdc409SJoe Perches				WARN("OOM_MESSAGE",
6393ebfdc409SJoe Perches				     "Possible unnecessary 'out of memory' message\n" . $hereprev);
6394ebfdc409SJoe Perches			}
6395ebfdc409SJoe Perches		}
6396ebfdc409SJoe Perches
6397f78d98f6SJoe Perches# check for logging functions with KERN_<LEVEL>
6398dcaf1123SPaolo Bonzini		if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
6399f78d98f6SJoe Perches		    $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
6400f78d98f6SJoe Perches			my $level = $1;
6401f78d98f6SJoe Perches			if (WARN("UNNECESSARY_KERN_LEVEL",
6402f78d98f6SJoe Perches				 "Possible unnecessary $level\n" . $herecurr) &&
6403f78d98f6SJoe Perches			    $fix) {
6404f78d98f6SJoe Perches				$fixed[$fixlinenr] =~ s/\s*$level\s*//;
6405f78d98f6SJoe Perches			}
6406f78d98f6SJoe Perches		}
6407f78d98f6SJoe Perches
640845c55e92SJoe Perches# check for logging continuations
640945c55e92SJoe Perches		if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
641045c55e92SJoe Perches			WARN("LOGGING_CONTINUATION",
641145c55e92SJoe Perches			     "Avoid logging continuation uses where feasible\n" . $herecurr);
641245c55e92SJoe Perches		}
641345c55e92SJoe Perches
641470eb2275SDwaipayan Ray# check for unnecessary use of %h[xudi] and %hh[xudi] in logging functions
641570eb2275SDwaipayan Ray		if (defined $stat &&
641670eb2275SDwaipayan Ray		    $line =~ /\b$logFunctions\s*\(/ &&
641770eb2275SDwaipayan Ray		    index($stat, '"') >= 0) {
641870eb2275SDwaipayan Ray			my $lc = $stat =~ tr@\n@@;
641970eb2275SDwaipayan Ray			$lc = $lc + $linenr;
642070eb2275SDwaipayan Ray			my $stat_real = get_stat_real($linenr, $lc);
642170eb2275SDwaipayan Ray			pos($stat_real) = index($stat_real, '"');
642270eb2275SDwaipayan Ray			while ($stat_real =~ /[^\"%]*(%[\#\d\.\*\-]*(h+)[idux])/g) {
642370eb2275SDwaipayan Ray				my $pspec = $1;
642470eb2275SDwaipayan Ray				my $h = $2;
642570eb2275SDwaipayan Ray				my $lineoff = substr($stat_real, 0, $-[1]) =~ tr@\n@@;
642670eb2275SDwaipayan Ray				if (WARN("UNNECESSARY_MODIFIER",
642770eb2275SDwaipayan Ray					 "Integer promotion: Using '$h' in '$pspec' is unnecessary\n" . "$here\n$stat_real\n") &&
642870eb2275SDwaipayan Ray				    $fix && $fixed[$fixlinenr + $lineoff] =~ /^\+/) {
642970eb2275SDwaipayan Ray					my $nspec = $pspec;
643070eb2275SDwaipayan Ray					$nspec =~ s/h//g;
643170eb2275SDwaipayan Ray					$fixed[$fixlinenr + $lineoff] =~ s/\Q$pspec\E/$nspec/;
643270eb2275SDwaipayan Ray				}
643370eb2275SDwaipayan Ray			}
643470eb2275SDwaipayan Ray		}
643570eb2275SDwaipayan Ray
6436abb08a53SJoe Perches# check for mask then right shift without a parentheses
64375b57980dSJoe Perches		if ($perl_version_ok &&
6438abb08a53SJoe Perches		    $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
6439abb08a53SJoe Perches		    $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
6440abb08a53SJoe Perches			WARN("MASK_THEN_SHIFT",
6441abb08a53SJoe Perches			     "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
6442abb08a53SJoe Perches		}
6443abb08a53SJoe Perches
6444b75ac618SJoe Perches# check for pointer comparisons to NULL
64455b57980dSJoe Perches		if ($perl_version_ok) {
6446b75ac618SJoe Perches			while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
6447b75ac618SJoe Perches				my $val = $1;
6448b75ac618SJoe Perches				my $equal = "!";
6449b75ac618SJoe Perches				$equal = "" if ($4 eq "!=");
6450b75ac618SJoe Perches				if (CHK("COMPARISON_TO_NULL",
6451b75ac618SJoe Perches					"Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
6452b75ac618SJoe Perches					    $fix) {
6453b75ac618SJoe Perches					$fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
6454b75ac618SJoe Perches				}
6455b75ac618SJoe Perches			}
6456b75ac618SJoe Perches		}
6457b75ac618SJoe Perches
64588716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata)
64598716de38SJoe Perches		if ($line =~ /(\b$InitAttribute\b)/) {
64608716de38SJoe Perches			my $attr = $1;
64618716de38SJoe Perches			if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
64628716de38SJoe Perches				my $ptr = $1;
64638716de38SJoe Perches				my $var = $2;
64648716de38SJoe Perches				if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
64658716de38SJoe Perches				      ERROR("MISPLACED_INIT",
64668716de38SJoe Perches					    "$attr should be placed after $var\n" . $herecurr)) ||
64678716de38SJoe Perches				     ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
64688716de38SJoe Perches				      WARN("MISPLACED_INIT",
64698716de38SJoe Perches					   "$attr should be placed after $var\n" . $herecurr))) &&
64708716de38SJoe Perches				    $fix) {
6471194f66fcSJoe 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;
64728716de38SJoe Perches				}
64738716de38SJoe Perches			}
64748716de38SJoe Perches		}
64758716de38SJoe Perches
6476e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const
6477e970b884SJoe Perches		if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
6478e970b884SJoe Perches			my $attr = $1;
6479e970b884SJoe Perches			$attr =~ /($InitAttributePrefix)(.*)/;
6480e970b884SJoe Perches			my $attr_prefix = $1;
6481e970b884SJoe Perches			my $attr_type = $2;
6482e970b884SJoe Perches			if (ERROR("INIT_ATTRIBUTE",
6483e970b884SJoe Perches				  "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
6484e970b884SJoe Perches			    $fix) {
6485194f66fcSJoe Perches				$fixed[$fixlinenr] =~
6486e970b884SJoe Perches				    s/$InitAttributeData/${attr_prefix}initconst/;
6487e970b884SJoe Perches			}
6488e970b884SJoe Perches		}
6489e970b884SJoe Perches
6490e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const
6491e970b884SJoe Perches		if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
6492e970b884SJoe Perches			my $attr = $1;
6493e970b884SJoe Perches			if (ERROR("INIT_ATTRIBUTE",
6494e970b884SJoe Perches				  "Use of $attr requires a separate use of const\n" . $herecurr) &&
6495e970b884SJoe Perches			    $fix) {
6496194f66fcSJoe Perches				my $lead = $fixed[$fixlinenr] =~
6497e970b884SJoe Perches				    /(^\+\s*(?:static\s+))/;
6498e970b884SJoe Perches				$lead = rtrim($1);
6499e970b884SJoe Perches				$lead = "$lead " if ($lead !~ /^\+$/);
6500e970b884SJoe Perches				$lead = "${lead}const ";
6501194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
6502e970b884SJoe Perches			}
6503e970b884SJoe Perches		}
6504e970b884SJoe Perches
6505c17893c7SJoe Perches# check for __read_mostly with const non-pointer (should just be const)
6506c17893c7SJoe Perches		if ($line =~ /\b__read_mostly\b/ &&
6507c17893c7SJoe Perches		    $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
6508c17893c7SJoe Perches			if (ERROR("CONST_READ_MOSTLY",
6509c17893c7SJoe Perches				  "Invalid use of __read_mostly with const type\n" . $herecurr) &&
6510c17893c7SJoe Perches			    $fix) {
6511c17893c7SJoe Perches				$fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
6512c17893c7SJoe Perches			}
6513c17893c7SJoe Perches		}
6514c17893c7SJoe Perches
6515fbdb8138SJoe Perches# don't use __constant_<foo> functions outside of include/uapi/
6516fbdb8138SJoe Perches		if ($realfile !~ m@^include/uapi/@ &&
6517fbdb8138SJoe Perches		    $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
6518fbdb8138SJoe Perches			my $constant_func = $1;
6519fbdb8138SJoe Perches			my $func = $constant_func;
6520fbdb8138SJoe Perches			$func =~ s/^__constant_//;
6521fbdb8138SJoe Perches			if (WARN("CONSTANT_CONVERSION",
6522fbdb8138SJoe Perches				 "$constant_func should be $func\n" . $herecurr) &&
6523fbdb8138SJoe Perches			    $fix) {
6524194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
6525fbdb8138SJoe Perches			}
6526fbdb8138SJoe Perches		}
6527fbdb8138SJoe Perches
65281a15a250SPatrick Pannuto# prefer usleep_range over udelay
652937581c28SBruce Allan		if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
653043c1d77cSJoe Perches			my $delay = $1;
65311a15a250SPatrick Pannuto			# ignore udelay's < 10, however
653243c1d77cSJoe Perches			if (! ($delay < 10) ) {
6533000d1cc1SJoe Perches				CHK("USLEEP_RANGE",
6534458f69efSMauro Carvalho Chehab				    "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
653543c1d77cSJoe Perches			}
653643c1d77cSJoe Perches			if ($delay > 2000) {
653743c1d77cSJoe Perches				WARN("LONG_UDELAY",
653843c1d77cSJoe Perches				     "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
65391a15a250SPatrick Pannuto			}
65401a15a250SPatrick Pannuto		}
65411a15a250SPatrick Pannuto
654209ef8725SPatrick Pannuto# warn about unexpectedly long msleep's
654309ef8725SPatrick Pannuto		if ($line =~ /\bmsleep\s*\((\d+)\);/) {
654409ef8725SPatrick Pannuto			if ($1 < 20) {
6545000d1cc1SJoe Perches				WARN("MSLEEP",
6546458f69efSMauro Carvalho Chehab				     "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
654709ef8725SPatrick Pannuto			}
654809ef8725SPatrick Pannuto		}
654909ef8725SPatrick Pannuto
655036ec1939SJoe Perches# check for comparisons of jiffies
655136ec1939SJoe Perches		if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
655236ec1939SJoe Perches			WARN("JIFFIES_COMPARISON",
655336ec1939SJoe Perches			     "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
655436ec1939SJoe Perches		}
655536ec1939SJoe Perches
65569d7a34a5SJoe Perches# check for comparisons of get_jiffies_64()
65579d7a34a5SJoe Perches		if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
65589d7a34a5SJoe Perches			WARN("JIFFIES_COMPARISON",
65599d7a34a5SJoe Perches			     "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
65609d7a34a5SJoe Perches		}
65619d7a34a5SJoe Perches
656200df344fSAndy Whitcroft# warn about #ifdefs in C files
6563c45dcabdSAndy Whitcroft#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
656400df344fSAndy Whitcroft#			print "#ifdef in C files should be avoided\n";
656500df344fSAndy Whitcroft#			print "$herecurr";
656600df344fSAndy Whitcroft#			$clean = 0;
656700df344fSAndy Whitcroft#		}
656800df344fSAndy Whitcroft
656922f2a2efSAndy Whitcroft# warn about spacing in #ifdefs
6570c45dcabdSAndy Whitcroft		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
65713705ce5bSJoe Perches			if (ERROR("SPACING",
65723705ce5bSJoe Perches				  "exactly one space required after that #$1\n" . $herecurr) &&
65733705ce5bSJoe Perches			    $fix) {
6574194f66fcSJoe Perches				$fixed[$fixlinenr] =~
65753705ce5bSJoe Perches				    s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
65763705ce5bSJoe Perches			}
65773705ce5bSJoe Perches
657822f2a2efSAndy Whitcroft		}
657922f2a2efSAndy Whitcroft
65804a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment.
6581171ae1a4SAndy Whitcroft		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
6582171ae1a4SAndy Whitcroft		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
65834a0df2efSAndy Whitcroft			my $which = $1;
65844a0df2efSAndy Whitcroft			if (!ctx_has_comment($first_line, $linenr)) {
6585000d1cc1SJoe Perches				CHK("UNCOMMENTED_DEFINITION",
6586000d1cc1SJoe Perches				    "$1 definition without comment\n" . $herecurr);
65874a0df2efSAndy Whitcroft			}
65884a0df2efSAndy Whitcroft		}
65894a0df2efSAndy Whitcroft# check for memory barriers without a comment.
6590402c2553SMichael S. Tsirkin
6591402c2553SMichael S. Tsirkin		my $barriers = qr{
6592402c2553SMichael S. Tsirkin			mb|
6593402c2553SMichael S. Tsirkin			rmb|
6594ad83ec6cSWill Deacon			wmb
6595402c2553SMichael S. Tsirkin		}x;
6596402c2553SMichael S. Tsirkin		my $barrier_stems = qr{
6597402c2553SMichael S. Tsirkin			mb__before_atomic|
6598402c2553SMichael S. Tsirkin			mb__after_atomic|
6599402c2553SMichael S. Tsirkin			store_release|
6600402c2553SMichael S. Tsirkin			load_acquire|
6601402c2553SMichael S. Tsirkin			store_mb|
6602402c2553SMichael S. Tsirkin			(?:$barriers)
6603402c2553SMichael S. Tsirkin		}x;
6604402c2553SMichael S. Tsirkin		my $all_barriers = qr{
6605402c2553SMichael S. Tsirkin			(?:$barriers)|
660643e361f2SMichael S. Tsirkin			smp_(?:$barrier_stems)|
660743e361f2SMichael S. Tsirkin			virt_(?:$barrier_stems)
6608402c2553SMichael S. Tsirkin		}x;
6609402c2553SMichael S. Tsirkin
6610402c2553SMichael S. Tsirkin		if ($line =~ /\b(?:$all_barriers)\s*\(/) {
66114a0df2efSAndy Whitcroft			if (!ctx_has_comment($first_line, $linenr)) {
6612c1fd7bb9SJoe Perches				WARN("MEMORY_BARRIER",
6613000d1cc1SJoe Perches				     "memory barrier without comment\n" . $herecurr);
66144a0df2efSAndy Whitcroft			}
66154a0df2efSAndy Whitcroft		}
66163ad81779SPaul E. McKenney
6617f4073b0fSMichael S. Tsirkin		my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
6618f4073b0fSMichael S. Tsirkin
6619f4073b0fSMichael S. Tsirkin		if ($realfile !~ m@^include/asm-generic/@ &&
6620f4073b0fSMichael S. Tsirkin		    $realfile !~ m@/barrier\.h$@ &&
6621f4073b0fSMichael S. Tsirkin		    $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
6622f4073b0fSMichael S. Tsirkin		    $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
6623f4073b0fSMichael S. Tsirkin			WARN("MEMORY_BARRIER",
6624f4073b0fSMichael S. Tsirkin			     "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
6625f4073b0fSMichael S. Tsirkin		}
6626f4073b0fSMichael S. Tsirkin
6627cb426e99SJoe Perches# check for waitqueue_active without a comment.
6628cb426e99SJoe Perches		if ($line =~ /\bwaitqueue_active\s*\(/) {
6629cb426e99SJoe Perches			if (!ctx_has_comment($first_line, $linenr)) {
6630cb426e99SJoe Perches				WARN("WAITQUEUE_ACTIVE",
6631cb426e99SJoe Perches				     "waitqueue_active without comment\n" . $herecurr);
6632cb426e99SJoe Perches			}
6633cb426e99SJoe Perches		}
66343ad81779SPaul E. McKenney
66355099a722SMarco Elver# check for data_race without a comment.
66365099a722SMarco Elver		if ($line =~ /\bdata_race\s*\(/) {
66375099a722SMarco Elver			if (!ctx_has_comment($first_line, $linenr)) {
66385099a722SMarco Elver				WARN("DATA_RACE",
66395099a722SMarco Elver				     "data_race without comment\n" . $herecurr);
66405099a722SMarco Elver			}
66415099a722SMarco Elver		}
66425099a722SMarco Elver
66434a0df2efSAndy Whitcroft# check of hardware specific defines
6644c45dcabdSAndy Whitcroft		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
6645000d1cc1SJoe Perches			CHK("ARCH_DEFINES",
6646000d1cc1SJoe Perches			    "architecture specific defines should be avoided\n" .  $herecurr);
66470a920b5bSAndy Whitcroft		}
6648653d4876SAndy Whitcroft
6649596ed45bSJoe Perches# check that the storage class is not after a type
6650596ed45bSJoe Perches		if ($line =~ /\b($Type)\s+($Storage)\b/) {
6651000d1cc1SJoe Perches			WARN("STORAGE_CLASS",
6652596ed45bSJoe Perches			     "storage class '$2' should be located before type '$1'\n" . $herecurr);
6653596ed45bSJoe Perches		}
6654596ed45bSJoe Perches# Check that the storage class is at the beginning of a declaration
6655596ed45bSJoe Perches		if ($line =~ /\b$Storage\b/ &&
6656596ed45bSJoe Perches		    $line !~ /^.\s*$Storage/ &&
6657596ed45bSJoe Perches		    $line =~ /^.\s*(.+?)\$Storage\s/ &&
6658596ed45bSJoe Perches		    $1 !~ /[\,\)]\s*$/) {
6659596ed45bSJoe Perches			WARN("STORAGE_CLASS",
6660596ed45bSJoe Perches			     "storage class should be at the beginning of the declaration\n" . $herecurr);
6661d4977c78STobias Klauser		}
6662d4977c78STobias Klauser
6663de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between
6664de7d4f0eSAndy Whitcroft# storage class and type.
66659c0ca6f9SAndy Whitcroft		if ($line =~ /\b$Type\s+$Inline\b/ ||
66669c0ca6f9SAndy Whitcroft		    $line =~ /\b$Inline\s+$Storage\b/) {
6667000d1cc1SJoe Perches			ERROR("INLINE_LOCATION",
6668000d1cc1SJoe Perches			      "inline keyword should sit between storage class and type\n" . $herecurr);
6669de7d4f0eSAndy Whitcroft		}
6670de7d4f0eSAndy Whitcroft
66718905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline
66722b7ab453SJoe Perches		if ($realfile !~ m@\binclude/uapi/@ &&
66732b7ab453SJoe Perches		    $line =~ /\b(__inline__|__inline)\b/) {
6674d5e616fcSJoe Perches			if (WARN("INLINE",
6675d5e616fcSJoe Perches				 "plain inline is preferred over $1\n" . $herecurr) &&
6676d5e616fcSJoe Perches			    $fix) {
6677194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
6678d5e616fcSJoe Perches
6679d5e616fcSJoe Perches			}
66808905a67cSAndy Whitcroft		}
66818905a67cSAndy Whitcroft
66827ebe1d17SDwaipayan Ray# Check for compiler attributes
66832b7ab453SJoe Perches		if ($realfile !~ m@\binclude/uapi/@ &&
66847ebe1d17SDwaipayan Ray		    $rawline =~ /\b__attribute__\s*\(\s*($balanced_parens)\s*\)/) {
66857ebe1d17SDwaipayan Ray			my $attr = $1;
66867ebe1d17SDwaipayan Ray			$attr =~ s/\s*\(\s*(.*)\)\s*/$1/;
66877ebe1d17SDwaipayan Ray
66887ebe1d17SDwaipayan Ray			my %attr_list = (
66890830aab0SJoe Perches				"alias"				=> "__alias",
66907ebe1d17SDwaipayan Ray				"aligned"			=> "__aligned",
66917ebe1d17SDwaipayan Ray				"always_inline"			=> "__always_inline",
66927ebe1d17SDwaipayan Ray				"assume_aligned"		=> "__assume_aligned",
66937ebe1d17SDwaipayan Ray				"cold"				=> "__cold",
66947ebe1d17SDwaipayan Ray				"const"				=> "__attribute_const__",
66957ebe1d17SDwaipayan Ray				"copy"				=> "__copy",
66967ebe1d17SDwaipayan Ray				"designated_init"		=> "__designated_init",
66977ebe1d17SDwaipayan Ray				"externally_visible"		=> "__visible",
66987ebe1d17SDwaipayan Ray				"format"			=> "printf|scanf",
66997ebe1d17SDwaipayan Ray				"gnu_inline"			=> "__gnu_inline",
67007ebe1d17SDwaipayan Ray				"malloc"			=> "__malloc",
67017ebe1d17SDwaipayan Ray				"mode"				=> "__mode",
67027ebe1d17SDwaipayan Ray				"no_caller_saved_registers"	=> "__no_caller_saved_registers",
67037ebe1d17SDwaipayan Ray				"noclone"			=> "__noclone",
67047ebe1d17SDwaipayan Ray				"noinline"			=> "noinline",
67057ebe1d17SDwaipayan Ray				"nonstring"			=> "__nonstring",
67067ebe1d17SDwaipayan Ray				"noreturn"			=> "__noreturn",
67077ebe1d17SDwaipayan Ray				"packed"			=> "__packed",
67087ebe1d17SDwaipayan Ray				"pure"				=> "__pure",
6709339f29d9SJoe Perches				"section"			=> "__section",
67100830aab0SJoe Perches				"used"				=> "__used",
67110830aab0SJoe Perches				"weak"				=> "__weak"
67127ebe1d17SDwaipayan Ray			);
67137ebe1d17SDwaipayan Ray
67147ebe1d17SDwaipayan Ray			while ($attr =~ /\s*(\w+)\s*(${balanced_parens})?/g) {
6715339f29d9SJoe Perches				my $orig_attr = $1;
67167ebe1d17SDwaipayan Ray				my $params = '';
67177ebe1d17SDwaipayan Ray				$params = $2 if defined($2);
6718339f29d9SJoe Perches				my $curr_attr = $orig_attr;
67197ebe1d17SDwaipayan Ray				$curr_attr =~ s/^[\s_]+|[\s_]+$//g;
67207ebe1d17SDwaipayan Ray				if (exists($attr_list{$curr_attr})) {
6721339f29d9SJoe Perches					my $new = $attr_list{$curr_attr};
67227ebe1d17SDwaipayan Ray					if ($curr_attr eq "format" && $params) {
67237ebe1d17SDwaipayan Ray						$params =~ /^\s*\(\s*(\w+)\s*,\s*(.*)/;
6724339f29d9SJoe Perches						$new = "__$1\($2";
67257ebe1d17SDwaipayan Ray					} else {
6726339f29d9SJoe Perches						$new = "$new$params";
67277ebe1d17SDwaipayan Ray					}
67287ebe1d17SDwaipayan Ray					if (WARN("PREFER_DEFINED_ATTRIBUTE_MACRO",
6729339f29d9SJoe Perches						 "Prefer $new over __attribute__(($orig_attr$params))\n" . $herecurr) &&
67307ebe1d17SDwaipayan Ray					    $fix) {
6731339f29d9SJoe Perches						my $remove = "\Q$orig_attr\E" . '\s*' . "\Q$params\E" . '(?:\s*,\s*)?';
6732339f29d9SJoe Perches						$fixed[$fixlinenr] =~ s/$remove//;
6733339f29d9SJoe Perches						$fixed[$fixlinenr] =~ s/\b__attribute__/$new __attribute__/;
6734339f29d9SJoe Perches						$fixed[$fixlinenr] =~ s/\}\Q$new\E/} $new/;
6735339f29d9SJoe Perches						$fixed[$fixlinenr] =~ s/ __attribute__\s*\(\s*\(\s*\)\s*\)//;
67367ebe1d17SDwaipayan Ray					}
673739b7e287SJoe Perches				}
6738462811d9SJoe Perches			}
6739462811d9SJoe Perches
67407ebe1d17SDwaipayan Ray			# Check for __attribute__ unused, prefer __always_unused or __maybe_unused
67417ebe1d17SDwaipayan Ray			if ($attr =~ /^_*unused/) {
67427ebe1d17SDwaipayan Ray				WARN("PREFER_DEFINED_ATTRIBUTE_MACRO",
67437ebe1d17SDwaipayan Ray				     "__always_unused or __maybe_unused is preferred over __attribute__((__unused__))\n" . $herecurr);
6744d5e616fcSJoe Perches			}
67456061d949SJoe Perches		}
67466061d949SJoe Perches
6747619a908aSJoe Perches# Check for __attribute__ weak, or __weak declarations (may have link issues)
67485b57980dSJoe Perches		if ($perl_version_ok &&
6749619a908aSJoe Perches		    $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
6750619a908aSJoe Perches		    ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
6751619a908aSJoe Perches		     $line =~ /\b__weak\b/)) {
6752619a908aSJoe Perches			ERROR("WEAK_DECLARATION",
6753619a908aSJoe Perches			      "Using weak declarations can have unintended link defects\n" . $herecurr);
6754619a908aSJoe Perches		}
6755619a908aSJoe Perches
6756fd39f904STomas Winkler# check for c99 types like uint8_t used outside of uapi/ and tools/
6757e6176fa4SJoe Perches		if ($realfile !~ m@\binclude/uapi/@ &&
6758fd39f904STomas Winkler		    $realfile !~ m@\btools/@ &&
6759e6176fa4SJoe Perches		    $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
6760e6176fa4SJoe Perches			my $type = $1;
6761e6176fa4SJoe Perches			if ($type =~ /\b($typeC99Typedefs)\b/) {
6762e6176fa4SJoe Perches				$type = $1;
6763e6176fa4SJoe Perches				my $kernel_type = 'u';
6764e6176fa4SJoe Perches				$kernel_type = 's' if ($type =~ /^_*[si]/);
6765e6176fa4SJoe Perches				$type =~ /(\d+)/;
6766e6176fa4SJoe Perches				$kernel_type .= $1;
6767e6176fa4SJoe Perches				if (CHK("PREFER_KERNEL_TYPES",
6768e6176fa4SJoe Perches					"Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
6769e6176fa4SJoe Perches				    $fix) {
6770e6176fa4SJoe Perches					$fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
6771e6176fa4SJoe Perches				}
6772e6176fa4SJoe Perches			}
6773e6176fa4SJoe Perches		}
6774e6176fa4SJoe Perches
6775938224b5SJoe Perches# check for cast of C90 native int or longer types constants
6776938224b5SJoe Perches		if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
6777938224b5SJoe Perches			my $cast = $1;
6778938224b5SJoe Perches			my $const = $2;
6779938224b5SJoe Perches			my $suffix = "";
6780938224b5SJoe Perches			my $newconst = $const;
6781938224b5SJoe Perches			$newconst =~ s/${Int_type}$//;
6782938224b5SJoe Perches			$suffix .= 'U' if ($cast =~ /\bunsigned\b/);
6783938224b5SJoe Perches			if ($cast =~ /\blong\s+long\b/) {
6784938224b5SJoe Perches			    $suffix .= 'LL';
6785938224b5SJoe Perches			} elsif ($cast =~ /\blong\b/) {
6786938224b5SJoe Perches			    $suffix .= 'L';
6787938224b5SJoe Perches			}
67880972b8bfSJoe Perches			if (WARN("TYPECAST_INT_CONSTANT",
67890972b8bfSJoe Perches				 "Unnecessary typecast of c90 int constant - '$cast$const' could be '$const$suffix'\n" . $herecurr) &&
67900972b8bfSJoe Perches			    $fix) {
6791938224b5SJoe Perches				$fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
6792938224b5SJoe Perches			}
6793938224b5SJoe Perches		}
6794938224b5SJoe Perches
67958f53a9b8SJoe Perches# check for sizeof(&)
67968f53a9b8SJoe Perches		if ($line =~ /\bsizeof\s*\(\s*\&/) {
6797000d1cc1SJoe Perches			WARN("SIZEOF_ADDRESS",
6798000d1cc1SJoe Perches			     "sizeof(& should be avoided\n" . $herecurr);
67998f53a9b8SJoe Perches		}
68008f53a9b8SJoe Perches
680166c80b60SJoe Perches# check for sizeof without parenthesis
680266c80b60SJoe Perches		if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
6803d5e616fcSJoe Perches			if (WARN("SIZEOF_PARENTHESIS",
6804d5e616fcSJoe Perches				 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
6805d5e616fcSJoe Perches			    $fix) {
6806194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
6807d5e616fcSJoe Perches			}
680866c80b60SJoe Perches		}
680966c80b60SJoe Perches
681088982feaSJoe Perches# check for struct spinlock declarations
681188982feaSJoe Perches		if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
681288982feaSJoe Perches			WARN("USE_SPINLOCK_T",
681388982feaSJoe Perches			     "struct spinlock should be spinlock_t\n" . $herecurr);
681488982feaSJoe Perches		}
681588982feaSJoe Perches
6816a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts
681706668727SJoe Perches		if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
6818a6962d72SJoe Perches			my $fmt = get_quoted_string($line, $rawline);
6819caac1d5fSHeba Aamer			$fmt =~ s/%%//g;
6820caac1d5fSHeba Aamer			if ($fmt !~ /%/) {
6821d5e616fcSJoe Perches				if (WARN("PREFER_SEQ_PUTS",
6822d5e616fcSJoe Perches					 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
6823d5e616fcSJoe Perches				    $fix) {
6824194f66fcSJoe Perches					$fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
6825d5e616fcSJoe Perches				}
6826a6962d72SJoe Perches			}
6827a6962d72SJoe Perches		}
6828a6962d72SJoe Perches
68290b523769SJoe Perches# check for vsprintf extension %p<foo> misuses
68305b57980dSJoe Perches		if ($perl_version_ok &&
68310b523769SJoe Perches		    defined $stat &&
68320b523769SJoe Perches		    $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
68330b523769SJoe Perches		    $1 !~ /^_*volatile_*$/) {
6834e3c6bc95STobin C. Harding			my $stat_real;
6835e3c6bc95STobin C. Harding
68360b523769SJoe Perches			my $lc = $stat =~ tr@\n@@;
68370b523769SJoe Perches			$lc = $lc + $linenr;
68380b523769SJoe Perches		        for (my $count = $linenr; $count <= $lc; $count++) {
6839ffe07513SJoe Perches				my $specifier;
6840ffe07513SJoe Perches				my $extension;
68413bd32d6aSSakari Ailus				my $qualifier;
6842ffe07513SJoe Perches				my $bad_specifier = "";
68430b523769SJoe Perches				my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
68440b523769SJoe Perches				$fmt =~ s/%%//g;
6845e3c6bc95STobin C. Harding
68463bd32d6aSSakari Ailus				while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) {
6847e3c6bc95STobin C. Harding					$specifier = $1;
6848e3c6bc95STobin C. Harding					$extension = $2;
68493bd32d6aSSakari Ailus					$qualifier = $3;
6850af612e43SSakari Ailus					if ($extension !~ /[4SsBKRraEehMmIiUDdgVCbGNOxtf]/ ||
68513bd32d6aSSakari Ailus					    ($extension eq "f" &&
6852af612e43SSakari Ailus					     defined $qualifier && $qualifier !~ /^w/) ||
6853af612e43SSakari Ailus					    ($extension eq "4" &&
6854af612e43SSakari Ailus					     defined $qualifier && $qualifier !~ /^cc/)) {
6855e3c6bc95STobin C. Harding						$bad_specifier = $specifier;
68560b523769SJoe Perches						last;
68570b523769SJoe Perches					}
6858e3c6bc95STobin C. Harding					if ($extension eq "x" && !defined($stat_real)) {
6859e3c6bc95STobin C. Harding						if (!defined($stat_real)) {
6860e3c6bc95STobin C. Harding							$stat_real = get_stat_real($linenr, $lc);
68610b523769SJoe Perches						}
6862e3c6bc95STobin C. Harding						WARN("VSPRINTF_SPECIFIER_PX",
6863e3c6bc95STobin 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");
6864e3c6bc95STobin C. Harding					}
6865e3c6bc95STobin C. Harding				}
6866e3c6bc95STobin C. Harding				if ($bad_specifier ne "") {
68672a9f9d85STobin C. Harding					my $stat_real = get_stat_real($linenr, $lc);
6868de48fa1aSMiguel Ojeda					my $msg_level = \&WARN;
68691df7338aSSergey Senozhatsky					my $ext_type = "Invalid";
68701df7338aSSergey Senozhatsky					my $use = "";
6871e3c6bc95STobin C. Harding					if ($bad_specifier =~ /p[Ff]/) {
68721df7338aSSergey Senozhatsky						$use = " - use %pS instead";
6873e3c6bc95STobin C. Harding						$use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
6874de48fa1aSMiguel Ojeda					} elsif ($bad_specifier =~ /pA/) {
6875de48fa1aSMiguel Ojeda						$use =  " - '%pA' is only intended to be used from Rust code";
6876de48fa1aSMiguel Ojeda						$msg_level = \&ERROR;
68771df7338aSSergey Senozhatsky					}
68782a9f9d85STobin C. Harding
6879de48fa1aSMiguel Ojeda					&{$msg_level}("VSPRINTF_POINTER_EXTENSION",
6880e3c6bc95STobin C. Harding						      "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
6881e3c6bc95STobin C. Harding				}
68820b523769SJoe Perches			}
68830b523769SJoe Perches		}
68840b523769SJoe Perches
6885554e165cSAndy Whitcroft# Check for misused memsets
68865b57980dSJoe Perches		if ($perl_version_ok &&
6887d1fe9c09SJoe Perches		    defined $stat &&
68889e20a853SMateusz Kulikowski		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
6889554e165cSAndy Whitcroft
6890d7c76ba7SJoe Perches			my $ms_addr = $2;
6891d1fe9c09SJoe Perches			my $ms_val = $7;
6892d1fe9c09SJoe Perches			my $ms_size = $12;
6893d7c76ba7SJoe Perches
6894554e165cSAndy Whitcroft			if ($ms_size =~ /^(0x|)0$/i) {
6895554e165cSAndy Whitcroft				ERROR("MEMSET",
6896d7c76ba7SJoe Perches				      "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
6897554e165cSAndy Whitcroft			} elsif ($ms_size =~ /^(0x|)1$/i) {
6898554e165cSAndy Whitcroft				WARN("MEMSET",
6899d7c76ba7SJoe Perches				     "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
6900d7c76ba7SJoe Perches			}
6901d7c76ba7SJoe Perches		}
6902d7c76ba7SJoe Perches
690398a9bba5SJoe Perches# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
69045b57980dSJoe Perches#		if ($perl_version_ok &&
6905f333195dSJoe Perches#		    defined $stat &&
6906f333195dSJoe Perches#		    $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6907f333195dSJoe Perches#			if (WARN("PREFER_ETHER_ADDR_COPY",
6908f333195dSJoe Perches#				 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6909f333195dSJoe Perches#			    $fix) {
6910f333195dSJoe Perches#				$fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6911f333195dSJoe Perches#			}
6912f333195dSJoe Perches#		}
691398a9bba5SJoe Perches
6914b6117d17SMateusz Kulikowski# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
69155b57980dSJoe Perches#		if ($perl_version_ok &&
6916f333195dSJoe Perches#		    defined $stat &&
6917f333195dSJoe Perches#		    $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6918f333195dSJoe Perches#			WARN("PREFER_ETHER_ADDR_EQUAL",
6919f333195dSJoe Perches#			     "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6920f333195dSJoe Perches#		}
6921b6117d17SMateusz Kulikowski
69228617cd09SMateusz Kulikowski# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
69238617cd09SMateusz Kulikowski# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
69245b57980dSJoe Perches#		if ($perl_version_ok &&
6925f333195dSJoe Perches#		    defined $stat &&
6926f333195dSJoe Perches#		    $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6927f333195dSJoe Perches#
6928f333195dSJoe Perches#			my $ms_val = $7;
6929f333195dSJoe Perches#
6930f333195dSJoe Perches#			if ($ms_val =~ /^(?:0x|)0+$/i) {
6931f333195dSJoe Perches#				if (WARN("PREFER_ETH_ZERO_ADDR",
6932f333195dSJoe Perches#					 "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6933f333195dSJoe Perches#				    $fix) {
6934f333195dSJoe Perches#					$fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6935f333195dSJoe Perches#				}
6936f333195dSJoe Perches#			} elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6937f333195dSJoe Perches#				if (WARN("PREFER_ETH_BROADCAST_ADDR",
6938f333195dSJoe Perches#					 "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6939f333195dSJoe Perches#				    $fix) {
6940f333195dSJoe Perches#					$fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6941f333195dSJoe Perches#				}
6942f333195dSJoe Perches#			}
6943f333195dSJoe Perches#		}
69448617cd09SMateusz Kulikowski
69455dbdb2d8SJoe Perches# strlcpy uses that should likely be strscpy
69465dbdb2d8SJoe Perches		if ($line =~ /\bstrlcpy\s*\(/) {
69475dbdb2d8SJoe Perches			WARN("STRLCPY",
69485dbdb2d8SJoe Perches			     "Prefer strscpy over strlcpy - see: https://lore.kernel.org/r/CAHk-=wgfRnXz0W3D37d01q3JFkr_i_uTL=V6A6G1oUZcprmknw\@mail.gmail.com/\n" . $herecurr);
69495dbdb2d8SJoe Perches		}
69505dbdb2d8SJoe Perches
6951d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t
69525b57980dSJoe Perches		if ($perl_version_ok &&
6953d1fe9c09SJoe Perches		    defined $stat &&
6954d7c76ba7SJoe Perches		    $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
6955d1fe9c09SJoe Perches			if (defined $2 || defined $7) {
6956d7c76ba7SJoe Perches				my $call = $1;
6957d7c76ba7SJoe Perches				my $cast1 = deparenthesize($2);
6958d7c76ba7SJoe Perches				my $arg1 = $3;
6959d1fe9c09SJoe Perches				my $cast2 = deparenthesize($7);
6960d1fe9c09SJoe Perches				my $arg2 = $8;
6961d7c76ba7SJoe Perches				my $cast;
6962d7c76ba7SJoe Perches
6963d1fe9c09SJoe Perches				if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
6964d7c76ba7SJoe Perches					$cast = "$cast1 or $cast2";
6965d7c76ba7SJoe Perches				} elsif ($cast1 ne "") {
6966d7c76ba7SJoe Perches					$cast = $cast1;
6967d7c76ba7SJoe Perches				} else {
6968d7c76ba7SJoe Perches					$cast = $cast2;
6969d7c76ba7SJoe Perches				}
6970d7c76ba7SJoe Perches				WARN("MINMAX",
6971d7c76ba7SJoe Perches				     "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
6972554e165cSAndy Whitcroft			}
6973554e165cSAndy Whitcroft		}
6974554e165cSAndy Whitcroft
69754a273195SJoe Perches# check usleep_range arguments
69765b57980dSJoe Perches		if ($perl_version_ok &&
69774a273195SJoe Perches		    defined $stat &&
69784a273195SJoe Perches		    $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
69794a273195SJoe Perches			my $min = $1;
69804a273195SJoe Perches			my $max = $7;
69814a273195SJoe Perches			if ($min eq $max) {
69824a273195SJoe Perches				WARN("USLEEP_RANGE",
6983458f69efSMauro Carvalho Chehab				     "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
69844a273195SJoe Perches			} elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
69854a273195SJoe Perches				 $min > $max) {
69864a273195SJoe Perches				WARN("USLEEP_RANGE",
6987458f69efSMauro Carvalho Chehab				     "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
69884a273195SJoe Perches			}
69894a273195SJoe Perches		}
69904a273195SJoe Perches
6991823b794cSJoe Perches# check for naked sscanf
69925b57980dSJoe Perches		if ($perl_version_ok &&
6993823b794cSJoe Perches		    defined $stat &&
69946c8bd707SJoe Perches		    $line =~ /\bsscanf\b/ &&
6995823b794cSJoe Perches		    ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
6996823b794cSJoe Perches		     $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
6997823b794cSJoe Perches		     $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
6998823b794cSJoe Perches			my $lc = $stat =~ tr@\n@@;
6999823b794cSJoe Perches			$lc = $lc + $linenr;
70002a9f9d85STobin C. Harding			my $stat_real = get_stat_real($linenr, $lc);
7001823b794cSJoe Perches			WARN("NAKED_SSCANF",
7002823b794cSJoe Perches			     "unchecked sscanf return value\n" . "$here\n$stat_real\n");
7003823b794cSJoe Perches		}
7004823b794cSJoe Perches
7005afc819abSJoe Perches# check for simple sscanf that should be kstrto<foo>
70065b57980dSJoe Perches		if ($perl_version_ok &&
7007afc819abSJoe Perches		    defined $stat &&
7008afc819abSJoe Perches		    $line =~ /\bsscanf\b/) {
7009afc819abSJoe Perches			my $lc = $stat =~ tr@\n@@;
7010afc819abSJoe Perches			$lc = $lc + $linenr;
70112a9f9d85STobin C. Harding			my $stat_real = get_stat_real($linenr, $lc);
7012afc819abSJoe Perches			if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
7013afc819abSJoe Perches				my $format = $6;
7014afc819abSJoe Perches				my $count = $format =~ tr@%@%@;
7015afc819abSJoe Perches				if ($count == 1 &&
7016afc819abSJoe Perches				    $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
7017afc819abSJoe Perches					WARN("SSCANF_TO_KSTRTO",
7018afc819abSJoe Perches					     "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
7019afc819abSJoe Perches				}
7020afc819abSJoe Perches			}
7021afc819abSJoe Perches		}
7022afc819abSJoe Perches
702370dc8a48SJoe Perches# check for new externs in .h files.
702470dc8a48SJoe Perches		if ($realfile =~ /\.h$/ &&
702570dc8a48SJoe Perches		    $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
7026d1d85780SJoe Perches			if (CHK("AVOID_EXTERNS",
702770dc8a48SJoe Perches				"extern prototypes should be avoided in .h files\n" . $herecurr) &&
702870dc8a48SJoe Perches			    $fix) {
7029194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
703070dc8a48SJoe Perches			}
703170dc8a48SJoe Perches		}
703270dc8a48SJoe Perches
7033de7d4f0eSAndy Whitcroft# check for new externs in .c files.
7034171ae1a4SAndy Whitcroft		if ($realfile =~ /\.c$/ && defined $stat &&
7035c45dcabdSAndy Whitcroft		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
7036171ae1a4SAndy Whitcroft		{
7037c45dcabdSAndy Whitcroft			my $function_name = $1;
7038c45dcabdSAndy Whitcroft			my $paren_space = $2;
7039171ae1a4SAndy Whitcroft
7040171ae1a4SAndy Whitcroft			my $s = $stat;
7041171ae1a4SAndy Whitcroft			if (defined $cond) {
7042171ae1a4SAndy Whitcroft				substr($s, 0, length($cond), '');
7043171ae1a4SAndy Whitcroft			}
7044d8b44b58SKees Cook			if ($s =~ /^\s*;/)
7045c45dcabdSAndy Whitcroft			{
7046000d1cc1SJoe Perches				WARN("AVOID_EXTERNS",
7047000d1cc1SJoe Perches				     "externs should be avoided in .c files\n" .  $herecurr);
7048de7d4f0eSAndy Whitcroft			}
7049de7d4f0eSAndy Whitcroft
7050171ae1a4SAndy Whitcroft			if ($paren_space =~ /\n/) {
7051000d1cc1SJoe Perches				WARN("FUNCTION_ARGUMENTS",
7052000d1cc1SJoe Perches				     "arguments for function declarations should follow identifier\n" . $herecurr);
7053171ae1a4SAndy Whitcroft			}
70549c9ba34eSAndy Whitcroft
70559c9ba34eSAndy Whitcroft		} elsif ($realfile =~ /\.c$/ && defined $stat &&
70569c9ba34eSAndy Whitcroft		    $stat =~ /^.\s*extern\s+/)
70579c9ba34eSAndy Whitcroft		{
7058000d1cc1SJoe Perches			WARN("AVOID_EXTERNS",
7059000d1cc1SJoe Perches			     "externs should be avoided in .c files\n" .  $herecurr);
7060171ae1a4SAndy Whitcroft		}
7061171ae1a4SAndy Whitcroft
7062a0ad7596SJoe Perches# check for function declarations that have arguments without identifier names
7063a0ad7596SJoe Perches		if (defined $stat &&
7064d8b44b58SKees Cook		    $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
7065d8b44b58SKees Cook		    $1 ne "void") {
7066d8b44b58SKees Cook			my $args = trim($1);
7067ca0d8929SJoe Perches			while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
7068ca0d8929SJoe Perches				my $arg = trim($1);
7069d8b44b58SKees Cook				if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
7070ca0d8929SJoe Perches					WARN("FUNCTION_ARGUMENTS",
7071ca0d8929SJoe Perches					     "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
7072ca0d8929SJoe Perches				}
7073ca0d8929SJoe Perches			}
7074ca0d8929SJoe Perches		}
7075ca0d8929SJoe Perches
7076a0ad7596SJoe Perches# check for function definitions
70775b57980dSJoe Perches		if ($perl_version_ok &&
7078a0ad7596SJoe Perches		    defined $stat &&
7079a0ad7596SJoe Perches		    $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
7080a0ad7596SJoe Perches			$context_function = $1;
7081a0ad7596SJoe Perches
7082a0ad7596SJoe Perches# check for multiline function definition with misplaced open brace
7083a0ad7596SJoe Perches			my $ok = 0;
7084a0ad7596SJoe Perches			my $cnt = statement_rawlines($stat);
7085a0ad7596SJoe Perches			my $herectx = $here . "\n";
7086a0ad7596SJoe Perches			for (my $n = 0; $n < $cnt; $n++) {
7087a0ad7596SJoe Perches				my $rl = raw_line($linenr, $n);
7088a0ad7596SJoe Perches				$herectx .=  $rl . "\n";
7089a0ad7596SJoe Perches				$ok = 1 if ($rl =~ /^[ \+]\{/);
7090a0ad7596SJoe Perches				$ok = 1 if ($rl =~ /\{/ && $n == 0);
7091a0ad7596SJoe Perches				last if $rl =~ /^[ \+].*\{/;
7092a0ad7596SJoe Perches			}
7093a0ad7596SJoe Perches			if (!$ok) {
7094a0ad7596SJoe Perches				ERROR("OPEN_BRACE",
7095a0ad7596SJoe Perches				      "open brace '{' following function definitions go on the next line\n" . $herectx);
7096a0ad7596SJoe Perches			}
7097a0ad7596SJoe Perches		}
7098a0ad7596SJoe Perches
7099de7d4f0eSAndy Whitcroft# checks for new __setup's
7100de7d4f0eSAndy Whitcroft		if ($rawline =~ /\b__setup\("([^"]*)"/) {
7101de7d4f0eSAndy Whitcroft			my $name = $1;
7102de7d4f0eSAndy Whitcroft
7103de7d4f0eSAndy Whitcroft			if (!grep(/$name/, @setup_docs)) {
7104000d1cc1SJoe Perches				CHK("UNDOCUMENTED_SETUP",
71052581ac7cSTim Froidcoeur				    "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr);
7106de7d4f0eSAndy Whitcroft			}
7107653d4876SAndy Whitcroft		}
71089c0ca6f9SAndy Whitcroft
7109e29a70f1SJoe Perches# check for pointless casting of alloc functions
7110e29a70f1SJoe Perches		if ($line =~ /\*\s*\)\s*$allocFunctions\b/) {
7111000d1cc1SJoe Perches			WARN("UNNECESSARY_CASTS",
7112000d1cc1SJoe Perches			     "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
71139c0ca6f9SAndy Whitcroft		}
711413214adfSAndy Whitcroft
7115a640d25cSJoe Perches# alloc style
7116a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
71175b57980dSJoe Perches		if ($perl_version_ok &&
7118e29a70f1SJoe Perches		    $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
7119a640d25cSJoe Perches			CHK("ALLOC_SIZEOF_STRUCT",
7120a640d25cSJoe Perches			    "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
7121a640d25cSJoe Perches		}
7122a640d25cSJoe Perches
712373f1d07eSGustavo A. R. Silva# check for (kv|k)[mz]alloc with multiplies that could be kmalloc_array/kvmalloc_array/kvcalloc/kcalloc
71245b57980dSJoe Perches		if ($perl_version_ok &&
71251b4a2ed4SJoe Perches		    defined $stat &&
712673f1d07eSGustavo A. R. Silva		    $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k)[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
712760a55369SJoe Perches			my $oldfunc = $3;
712860a55369SJoe Perches			my $a1 = $4;
712960a55369SJoe Perches			my $a2 = $10;
713060a55369SJoe Perches			my $newfunc = "kmalloc_array";
713173f1d07eSGustavo A. R. Silva			$newfunc = "kvmalloc_array" if ($oldfunc eq "kvmalloc");
713273f1d07eSGustavo A. R. Silva			$newfunc = "kvcalloc" if ($oldfunc eq "kvzalloc");
713360a55369SJoe Perches			$newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
713460a55369SJoe Perches			my $r1 = $a1;
713560a55369SJoe Perches			my $r2 = $a2;
713660a55369SJoe Perches			if ($a1 =~ /^sizeof\s*\S/) {
713760a55369SJoe Perches				$r1 = $a2;
713860a55369SJoe Perches				$r2 = $a1;
713960a55369SJoe Perches			}
7140e367455aSJoe Perches			if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
7141e367455aSJoe Perches			    !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
71421b4a2ed4SJoe Perches				my $cnt = statement_rawlines($stat);
7143e3d95a2aSTobin C. Harding				my $herectx = get_stat_here($linenr, $cnt, $here);
7144e3d95a2aSTobin C. Harding
7145e367455aSJoe Perches				if (WARN("ALLOC_WITH_MULTIPLY",
71461b4a2ed4SJoe Perches					 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
71471b4a2ed4SJoe Perches				    $cnt == 1 &&
7148e367455aSJoe Perches				    $fix) {
714973f1d07eSGustavo A. R. Silva					$fixed[$fixlinenr] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k)[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e;
715060a55369SJoe Perches				}
715160a55369SJoe Perches			}
715260a55369SJoe Perches		}
715360a55369SJoe Perches
7154972fdea2SJoe Perches# check for krealloc arg reuse
71555b57980dSJoe Perches		if ($perl_version_ok &&
71564cab63ceSJoe Perches		    $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ &&
71574cab63ceSJoe Perches		    $1 eq $3) {
7158972fdea2SJoe Perches			WARN("KREALLOC_ARG_REUSE",
7159972fdea2SJoe Perches			     "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
7160972fdea2SJoe Perches		}
7161972fdea2SJoe Perches
71625ce59ae0SJoe Perches# check for alloc argument mismatch
71633965292aSLiao Chang		if ($line =~ /\b((?:devm_)?((?:k|kv)?(calloc|malloc_array)(?:_node)?))\s*\(\s*sizeof\b/) {
71645ce59ae0SJoe Perches			WARN("ALLOC_ARRAY_ARGS",
71655ce59ae0SJoe Perches			     "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
71665ce59ae0SJoe Perches		}
71675ce59ae0SJoe Perches
7168caf2a54fSJoe Perches# check for multiple semicolons
7169caf2a54fSJoe Perches		if ($line =~ /;\s*;\s*$/) {
7170d5e616fcSJoe Perches			if (WARN("ONE_SEMICOLON",
7171d5e616fcSJoe Perches				 "Statements terminations use 1 semicolon\n" . $herecurr) &&
7172d5e616fcSJoe Perches			    $fix) {
7173194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
7174d5e616fcSJoe Perches			}
7175d1e2ad07SJoe Perches		}
7176d1e2ad07SJoe Perches
7177cec3aaa5STomas Winkler# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
7178cec3aaa5STomas Winkler		if ($realfile !~ m@^include/uapi/@ &&
7179cec3aaa5STomas Winkler		    $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
71800ab90191SJoe Perches			my $ull = "";
71810ab90191SJoe Perches			$ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
71820ab90191SJoe Perches			if (CHK("BIT_MACRO",
71830ab90191SJoe Perches				"Prefer using the BIT$ull macro\n" . $herecurr) &&
71840ab90191SJoe Perches			    $fix) {
71850ab90191SJoe Perches				$fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
71860ab90191SJoe Perches			}
71870ab90191SJoe Perches		}
71880ab90191SJoe Perches
718950161266SJoe Perches# check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too)
71903e89ad85SJerome Forissier		if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^${CONFIG_}/) {
719150161266SJoe Perches			WARN("IS_ENABLED_CONFIG",
71923e89ad85SJerome Forissier			     "IS_ENABLED($1) is normally used as IS_ENABLED(${CONFIG_}$1)\n" . $herecurr);
719350161266SJoe Perches		}
719450161266SJoe Perches
71952d632745SJoe Perches# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
71963e89ad85SJerome 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*$/) {
71972d632745SJoe Perches			my $config = $1;
71982d632745SJoe Perches			if (WARN("PREFER_IS_ENABLED",
71993e89ad85SJerome Forissier				 "Prefer IS_ENABLED(<FOO>) to ${CONFIG_}<FOO> || ${CONFIG_}<FOO>_MODULE\n" . $herecurr) &&
72002d632745SJoe Perches			    $fix) {
72012d632745SJoe Perches				$fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
72022d632745SJoe Perches			}
72032d632745SJoe Perches		}
72042d632745SJoe Perches
7205f36d3eb8SJoe Perches# check for /* fallthrough */ like comment, prefer fallthrough;
7206f36d3eb8SJoe Perches		my @fallthroughs = (
7207f36d3eb8SJoe Perches			'fallthrough',
7208f36d3eb8SJoe Perches			'@fallthrough@',
7209f36d3eb8SJoe Perches			'lint -fallthrough[ \t]*',
7210f36d3eb8SJoe Perches			'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)',
7211f36d3eb8SJoe Perches			'(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?',
7212f36d3eb8SJoe Perches			'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
7213f36d3eb8SJoe Perches			'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
7214f36d3eb8SJoe Perches		    );
7215f36d3eb8SJoe Perches		if ($raw_comment ne '') {
7216f36d3eb8SJoe Perches			foreach my $ft (@fallthroughs) {
7217f36d3eb8SJoe Perches				if ($raw_comment =~ /$ft/) {
7218f36d3eb8SJoe Perches					my $msg_level = \&WARN;
7219f36d3eb8SJoe Perches					$msg_level = \&CHK if ($file);
7220f36d3eb8SJoe Perches					&{$msg_level}("PREFER_FALLTHROUGH",
7221f36d3eb8SJoe Perches						      "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr);
7222f36d3eb8SJoe Perches					last;
7223f36d3eb8SJoe Perches				}
7224f36d3eb8SJoe Perches			}
7225f36d3eb8SJoe Perches		}
7226f36d3eb8SJoe Perches
7227d1e2ad07SJoe Perches# check for switch/default statements without a break;
72285b57980dSJoe Perches		if ($perl_version_ok &&
7229d1e2ad07SJoe Perches		    defined $stat &&
7230d1e2ad07SJoe Perches		    $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
7231d1e2ad07SJoe Perches			my $cnt = statement_rawlines($stat);
7232e3d95a2aSTobin C. Harding			my $herectx = get_stat_here($linenr, $cnt, $here);
7233e3d95a2aSTobin C. Harding
7234d1e2ad07SJoe Perches			WARN("DEFAULT_NO_BREAK",
7235d1e2ad07SJoe Perches			     "switch default: should use break\n" . $herectx);
7236caf2a54fSJoe Perches		}
7237caf2a54fSJoe Perches
723813214adfSAndy Whitcroft# check for gcc specific __FUNCTION__
7239d5e616fcSJoe Perches		if ($line =~ /\b__FUNCTION__\b/) {
7240d5e616fcSJoe Perches			if (WARN("USE_FUNC",
7241d5e616fcSJoe Perches				 "__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr) &&
7242d5e616fcSJoe Perches			    $fix) {
7243194f66fcSJoe Perches				$fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
7244d5e616fcSJoe Perches			}
724513214adfSAndy Whitcroft		}
7246773647a0SAndy Whitcroft
724762ec818fSJoe Perches# check for uses of __DATE__, __TIME__, __TIMESTAMP__
724862ec818fSJoe Perches		while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
724962ec818fSJoe Perches			ERROR("DATE_TIME",
725062ec818fSJoe Perches			      "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
725162ec818fSJoe Perches		}
725262ec818fSJoe Perches
72532c92488aSJoe Perches# check for use of yield()
72542c92488aSJoe Perches		if ($line =~ /\byield\s*\(\s*\)/) {
72552c92488aSJoe Perches			WARN("YIELD",
72562c92488aSJoe Perches			     "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n"  . $herecurr);
72572c92488aSJoe Perches		}
72582c92488aSJoe Perches
7259179f8f40SJoe Perches# check for comparisons against true and false
7260179f8f40SJoe Perches		if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
7261179f8f40SJoe Perches			my $lead = $1;
7262179f8f40SJoe Perches			my $arg = $2;
7263179f8f40SJoe Perches			my $test = $3;
7264179f8f40SJoe Perches			my $otype = $4;
7265179f8f40SJoe Perches			my $trail = $5;
7266179f8f40SJoe Perches			my $op = "!";
7267179f8f40SJoe Perches
7268179f8f40SJoe Perches			($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
7269179f8f40SJoe Perches
7270179f8f40SJoe Perches			my $type = lc($otype);
7271179f8f40SJoe Perches			if ($type =~ /^(?:true|false)$/) {
7272179f8f40SJoe Perches				if (("$test" eq "==" && "$type" eq "true") ||
7273179f8f40SJoe Perches				    ("$test" eq "!=" && "$type" eq "false")) {
7274179f8f40SJoe Perches					$op = "";
7275179f8f40SJoe Perches				}
7276179f8f40SJoe Perches
7277179f8f40SJoe Perches				CHK("BOOL_COMPARISON",
7278179f8f40SJoe Perches				    "Using comparison to $otype is error prone\n" . $herecurr);
7279179f8f40SJoe Perches
7280179f8f40SJoe Perches## maybe suggesting a correct construct would better
7281179f8f40SJoe Perches##				    "Using comparison to $otype is error prone.  Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
7282179f8f40SJoe Perches
7283179f8f40SJoe Perches			}
7284179f8f40SJoe Perches		}
7285179f8f40SJoe Perches
72864882720bSThomas Gleixner# check for semaphores initialized locked
72874882720bSThomas Gleixner		if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
7288000d1cc1SJoe Perches			WARN("CONSIDER_COMPLETION",
7289000d1cc1SJoe Perches			     "consider using a completion\n" . $herecurr);
7290773647a0SAndy Whitcroft		}
72916712d858SJoe Perches
729267d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto*
729367d0a075SJoe Perches		if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
7294000d1cc1SJoe Perches			WARN("CONSIDER_KSTRTO",
729567d0a075SJoe Perches			     "$1 is obsolete, use k$3 instead\n" . $herecurr);
7296773647a0SAndy Whitcroft		}
72976712d858SJoe Perches
7298ae3ccc46SFabian Frederick# check for __initcall(), use device_initcall() explicitly or more appropriate function please
7299f3db6639SMichael Ellerman		if ($line =~ /^.\s*__initcall\s*\(/) {
7300000d1cc1SJoe Perches			WARN("USE_DEVICE_INITCALL",
7301ae3ccc46SFabian Frederick			     "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
7302f3db6639SMichael Ellerman		}
73036712d858SJoe Perches
73043d709ab5SPaul E. McKenney# check for spin_is_locked(), suggest lockdep instead
73053d709ab5SPaul E. McKenney		if ($line =~ /\bspin_is_locked\(/) {
73063d709ab5SPaul E. McKenney			WARN("USE_LOCKDEP",
73073d709ab5SPaul E. McKenney			     "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
73083d709ab5SPaul E. McKenney		}
73093d709ab5SPaul E. McKenney
73109189c7e7SJoe Perches# check for deprecated apis
73119189c7e7SJoe Perches		if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) {
73129189c7e7SJoe Perches			my $deprecated_api = $1;
73139189c7e7SJoe Perches			my $new_api = $deprecated_apis{$deprecated_api};
73149189c7e7SJoe Perches			WARN("DEPRECATED_API",
73159189c7e7SJoe Perches			     "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr);
73169189c7e7SJoe Perches		}
73179189c7e7SJoe Perches
73180f3c5aabSJoe Perches# check for various structs that are normally const (ops, kgdb, device_tree)
7319d9190e4eSJoe Perches# and avoid what seem like struct definitions 'struct foo {'
7320ced69da1SQuentin Monnet		if (defined($const_structs) &&
7321ced69da1SQuentin Monnet		    $line !~ /\bconst\b/ &&
7322d9190e4eSJoe Perches		    $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
7323000d1cc1SJoe Perches			WARN("CONST_STRUCT",
7324d9190e4eSJoe Perches			     "struct $1 should normally be const\n" . $herecurr);
73252b6db5cbSAndy Whitcroft		}
7326773647a0SAndy Whitcroft
7327773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong
7328773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right
732935cdcbfcSPeng Wang# ignore designated initializers using NR_CPUS
7330773647a0SAndy Whitcroft		if ($line =~ /\bNR_CPUS\b/ &&
7331c45dcabdSAndy Whitcroft		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
7332c45dcabdSAndy Whitcroft		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
7333171ae1a4SAndy Whitcroft		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
7334171ae1a4SAndy Whitcroft		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
733535cdcbfcSPeng Wang		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/ &&
733635cdcbfcSPeng Wang		    $line !~ /^.\s*\.\w+\s*=\s*.*\bNR_CPUS\b/)
7337773647a0SAndy Whitcroft		{
7338000d1cc1SJoe Perches			WARN("NR_CPUS",
7339000d1cc1SJoe Perches			     "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
7340773647a0SAndy Whitcroft		}
73419c9ba34eSAndy Whitcroft
734252ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
734352ea8506SJoe Perches		if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
734452ea8506SJoe Perches			ERROR("DEFINE_ARCH_HAS",
734552ea8506SJoe Perches			      "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
734652ea8506SJoe Perches		}
734752ea8506SJoe Perches
7348acd9362cSJoe Perches# likely/unlikely comparisons similar to "(likely(foo) > 0)"
73495b57980dSJoe Perches		if ($perl_version_ok &&
7350acd9362cSJoe Perches		    $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
7351acd9362cSJoe Perches			WARN("LIKELY_MISUSE",
7352acd9362cSJoe Perches			     "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
7353acd9362cSJoe Perches		}
7354acd9362cSJoe Perches
7355fbe74541SJoe Perches# return sysfs_emit(foo, fmt, ...) fmt without newline
7356fbe74541SJoe Perches		if ($line =~ /\breturn\s+sysfs_emit\s*\(\s*$FuncArg\s*,\s*($String)/ &&
7357fbe74541SJoe Perches		    substr($rawline, $-[6], $+[6] - $-[6]) !~ /\\n"$/) {
7358fbe74541SJoe Perches			my $offset = $+[6] - 1;
7359fbe74541SJoe Perches			if (WARN("SYSFS_EMIT",
7360fbe74541SJoe Perches				 "return sysfs_emit(...) formats should include a terminating newline\n" . $herecurr) &&
7361fbe74541SJoe Perches			    $fix) {
7362fbe74541SJoe Perches				substr($fixed[$fixlinenr], $offset, 0) = '\\n';
7363fbe74541SJoe Perches			}
7364fbe74541SJoe Perches		}
7365fbe74541SJoe Perches
7366de3f186fSDenis Efremov# nested likely/unlikely calls
7367de3f186fSDenis Efremov		if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) {
7368de3f186fSDenis Efremov			WARN("LIKELY_MISUSE",
7369de3f186fSDenis Efremov			     "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr);
7370de3f186fSDenis Efremov		}
7371de3f186fSDenis Efremov
7372691d77b6SAndy Whitcroft# whine mightly about in_atomic
7373691d77b6SAndy Whitcroft		if ($line =~ /\bin_atomic\s*\(/) {
7374691d77b6SAndy Whitcroft			if ($realfile =~ m@^drivers/@) {
7375000d1cc1SJoe Perches				ERROR("IN_ATOMIC",
7376000d1cc1SJoe Perches				      "do not use in_atomic in drivers\n" . $herecurr);
7377f4a87736SAndy Whitcroft			} elsif ($realfile !~ m@^kernel/@) {
7378000d1cc1SJoe Perches				WARN("IN_ATOMIC",
7379000d1cc1SJoe Perches				     "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
7380691d77b6SAndy Whitcroft			}
7381691d77b6SAndy Whitcroft		}
73821704f47bSPeter Zijlstra
73831704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class
73841704f47bSPeter Zijlstra		if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
73851704f47bSPeter Zijlstra		    $line =~ /__lockdep_no_validate__\s*\)/ ) {
73861704f47bSPeter Zijlstra			if ($realfile !~ m@^kernel/lockdep@ &&
73871704f47bSPeter Zijlstra			    $realfile !~ m@^include/linux/lockdep@ &&
73881704f47bSPeter Zijlstra			    $realfile !~ m@^drivers/base/core@) {
7389000d1cc1SJoe Perches				ERROR("LOCKDEP",
7390000d1cc1SJoe Perches				      "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
73911704f47bSPeter Zijlstra			}
73921704f47bSPeter Zijlstra		}
739388f8831cSDave Jones
7394b392c64fSJoe Perches		if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
7395b392c64fSJoe Perches		    $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
7396000d1cc1SJoe Perches			WARN("EXPORTED_WORLD_WRITABLE",
7397000d1cc1SJoe Perches			     "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
739888f8831cSDave Jones		}
73992435880fSJoe Perches
740000180468SJoe Perches# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
740100180468SJoe Perches# and whether or not function naming is typical and if
740200180468SJoe Perches# DEVICE_ATTR permissions uses are unusual too
74035b57980dSJoe Perches		if ($perl_version_ok &&
740400180468SJoe Perches		    defined $stat &&
740500180468SJoe 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*\)/) {
740600180468SJoe Perches			my $var = $1;
740700180468SJoe Perches			my $perms = $2;
740800180468SJoe Perches			my $show = $3;
740900180468SJoe Perches			my $store = $4;
741000180468SJoe Perches			my $octal_perms = perms_to_octal($perms);
741100180468SJoe Perches			if ($show =~ /^${var}_show$/ &&
741200180468SJoe Perches			    $store =~ /^${var}_store$/ &&
741300180468SJoe Perches			    $octal_perms eq "0644") {
741400180468SJoe Perches				if (WARN("DEVICE_ATTR_RW",
741500180468SJoe Perches					 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
741600180468SJoe Perches				    $fix) {
741700180468SJoe 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})/;
741800180468SJoe Perches				}
741900180468SJoe Perches			} elsif ($show =~ /^${var}_show$/ &&
742000180468SJoe Perches				 $store =~ /^NULL$/ &&
742100180468SJoe Perches				 $octal_perms eq "0444") {
742200180468SJoe Perches				if (WARN("DEVICE_ATTR_RO",
742300180468SJoe Perches					 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
742400180468SJoe Perches				    $fix) {
742500180468SJoe 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})/;
742600180468SJoe Perches				}
742700180468SJoe Perches			} elsif ($show =~ /^NULL$/ &&
742800180468SJoe Perches				 $store =~ /^${var}_store$/ &&
742900180468SJoe Perches				 $octal_perms eq "0200") {
743000180468SJoe Perches				if (WARN("DEVICE_ATTR_WO",
743100180468SJoe Perches					 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
743200180468SJoe Perches				    $fix) {
743300180468SJoe 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})/;
743400180468SJoe Perches				}
743500180468SJoe Perches			} elsif ($octal_perms eq "0644" ||
743600180468SJoe Perches				 $octal_perms eq "0444" ||
743700180468SJoe Perches				 $octal_perms eq "0200") {
743800180468SJoe Perches				my $newshow = "$show";
743900180468SJoe Perches				$newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
744000180468SJoe Perches				my $newstore = $store;
744100180468SJoe Perches				$newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
744200180468SJoe Perches				my $rename = "";
744300180468SJoe Perches				if ($show ne $newshow) {
744400180468SJoe Perches					$rename .= " '$show' to '$newshow'";
744500180468SJoe Perches				}
744600180468SJoe Perches				if ($store ne $newstore) {
744700180468SJoe Perches					$rename .= " '$store' to '$newstore'";
744800180468SJoe Perches				}
744900180468SJoe Perches				WARN("DEVICE_ATTR_FUNCTIONS",
745000180468SJoe Perches				     "Consider renaming function(s)$rename\n" . $herecurr);
745100180468SJoe Perches			} else {
745200180468SJoe Perches				WARN("DEVICE_ATTR_PERMS",
745300180468SJoe Perches				     "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
745400180468SJoe Perches			}
745500180468SJoe Perches		}
745600180468SJoe Perches
7457515a235eSJoe Perches# Mode permission misuses where it seems decimal should be octal
7458515a235eSJoe Perches# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
745973121534SJoe Perches# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
746073121534SJoe Perches#   specific definition of not visible in sysfs.
746173121534SJoe Perches# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
746273121534SJoe Perches#   use the default permissions
74635b57980dSJoe Perches		if ($perl_version_ok &&
7464459cf0aeSJoe Perches		    defined $stat &&
7465515a235eSJoe Perches		    $line =~ /$mode_perms_search/) {
74662435880fSJoe Perches			foreach my $entry (@mode_permission_funcs) {
74672435880fSJoe Perches				my $func = $entry->[0];
74682435880fSJoe Perches				my $arg_pos = $entry->[1];
74692435880fSJoe Perches
7470459cf0aeSJoe Perches				my $lc = $stat =~ tr@\n@@;
7471459cf0aeSJoe Perches				$lc = $lc + $linenr;
74722a9f9d85STobin C. Harding				my $stat_real = get_stat_real($linenr, $lc);
7473459cf0aeSJoe Perches
74742435880fSJoe Perches				my $skip_args = "";
74752435880fSJoe Perches				if ($arg_pos > 1) {
74762435880fSJoe Perches					$arg_pos--;
74772435880fSJoe Perches					$skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
74782435880fSJoe Perches				}
7479f90774e1SJoe Perches				my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
7480459cf0aeSJoe Perches				if ($stat =~ /$test/) {
74812435880fSJoe Perches					my $val = $1;
74822435880fSJoe Perches					$val = $6 if ($skip_args ne "");
748373121534SJoe Perches					if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
748473121534SJoe Perches					    (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
748573121534SJoe Perches					     ($val =~ /^$Octal$/ && length($val) ne 4))) {
74862435880fSJoe Perches						ERROR("NON_OCTAL_PERMISSIONS",
7487459cf0aeSJoe Perches						      "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
7488f90774e1SJoe Perches					}
7489f90774e1SJoe Perches					if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
7490c0a5c898SJoe Perches						ERROR("EXPORTED_WORLD_WRITABLE",
7491459cf0aeSJoe Perches						      "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
74922435880fSJoe Perches					}
7493459cf0aeSJoe Perches				}
7494459cf0aeSJoe Perches			}
7495459cf0aeSJoe Perches		}
7496459cf0aeSJoe Perches
7497459cf0aeSJoe Perches# check for uses of S_<PERMS> that could be octal for readability
7498bc22d9a7SJoe Perches		while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
749900180468SJoe Perches			my $oval = $1;
750000180468SJoe Perches			my $octal = perms_to_octal($oval);
7501f90774e1SJoe Perches			if (WARN("SYMBOLIC_PERMS",
7502459cf0aeSJoe Perches				 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
7503f90774e1SJoe Perches			    $fix) {
750400180468SJoe Perches				$fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
75052435880fSJoe Perches			}
750613214adfSAndy Whitcroft		}
75075a6d20ceSBjorn Andersson
75085a6d20ceSBjorn Andersson# validate content of MODULE_LICENSE against list from include/linux/module.h
75095a6d20ceSBjorn Andersson		if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
75105a6d20ceSBjorn Andersson			my $extracted_string = get_quoted_string($line, $rawline);
75115a6d20ceSBjorn Andersson			my $valid_licenses = qr{
75125a6d20ceSBjorn Andersson						GPL|
75135a6d20ceSBjorn Andersson						GPL\ v2|
75145a6d20ceSBjorn Andersson						GPL\ and\ additional\ rights|
75155a6d20ceSBjorn Andersson						Dual\ BSD/GPL|
75165a6d20ceSBjorn Andersson						Dual\ MIT/GPL|
75175a6d20ceSBjorn Andersson						Dual\ MPL/GPL|
75185a6d20ceSBjorn Andersson						Proprietary
75195a6d20ceSBjorn Andersson					}x;
75205a6d20ceSBjorn Andersson			if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
75215a6d20ceSBjorn Andersson				WARN("MODULE_LICENSE",
75225a6d20ceSBjorn Andersson				     "unknown module license " . $extracted_string . "\n" . $herecurr);
75235a6d20ceSBjorn Andersson			}
75246e8f42dcSJoe Perches			if (!$file && $extracted_string eq '"GPL v2"') {
75256e8f42dcSJoe Perches				if (WARN("MODULE_LICENSE",
75266e8f42dcSJoe Perches				     "Prefer \"GPL\" over \"GPL v2\" - see commit bf7fbeeae6db (\"module: Cure the MODULE_LICENSE \"GPL\" vs. \"GPL v2\" bogosity\")\n" . $herecurr) &&
75276e8f42dcSJoe Perches				    $fix) {
75286e8f42dcSJoe Perches					$fixed[$fixlinenr] =~ s/\bMODULE_LICENSE\s*\(\s*"GPL v2"\s*\)/MODULE_LICENSE("GPL")/;
75296e8f42dcSJoe Perches				}
75306e8f42dcSJoe Perches			}
75315a6d20ceSBjorn Andersson		}
75326a8d76cbSMatteo Croce
75336a8d76cbSMatteo Croce# check for sysctl duplicate constants
75346a8d76cbSMatteo Croce		if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) {
75356a8d76cbSMatteo Croce			WARN("DUPLICATED_SYSCTL_CONST",
75366a8d76cbSMatteo Croce				"duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
75376a8d76cbSMatteo Croce		}
7538515a235eSJoe Perches	}
753913214adfSAndy Whitcroft
754013214adfSAndy Whitcroft	# If we have no input at all, then there is nothing to report on
754113214adfSAndy Whitcroft	# so just keep quiet.
754213214adfSAndy Whitcroft	if ($#rawlines == -1) {
754313214adfSAndy Whitcroft		exit(0);
75440a920b5bSAndy Whitcroft	}
75450a920b5bSAndy Whitcroft
75468905a67cSAndy Whitcroft	# In mailback mode only produce a report in the negative, for
75478905a67cSAndy Whitcroft	# things that appear to be patches.
75488905a67cSAndy Whitcroft	if ($mailback && ($clean == 1 || !$is_patch)) {
75498905a67cSAndy Whitcroft		exit(0);
75508905a67cSAndy Whitcroft	}
75518905a67cSAndy Whitcroft
7552e73d2715SDwaipayan Ray	# This is not a patch, and we are in 'no-patch' mode so
75538905a67cSAndy Whitcroft	# just keep quiet.
75548905a67cSAndy Whitcroft	if (!$chk_patch && !$is_patch) {
75558905a67cSAndy Whitcroft		exit(0);
75568905a67cSAndy Whitcroft	}
75578905a67cSAndy Whitcroft
7558a08ffbefSStafford Horne	if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
7559000d1cc1SJoe Perches		ERROR("NOT_UNIFIED_DIFF",
7560000d1cc1SJoe Perches		      "Does not appear to be a unified-diff format patch\n");
75610a920b5bSAndy Whitcroft	}
7562cd261496SGeert Uytterhoeven	if ($is_patch && $has_commit_log && $chk_signoff) {
7563cd261496SGeert Uytterhoeven		if ($signoff == 0) {
7564000d1cc1SJoe Perches			ERROR("MISSING_SIGN_OFF",
7565000d1cc1SJoe Perches			      "Missing Signed-off-by: line(s)\n");
756648ca2d8aSDwaipayan Ray		} elsif ($authorsignoff != 1) {
756748ca2d8aSDwaipayan Ray			# authorsignoff values:
756848ca2d8aSDwaipayan Ray			# 0 -> missing sign off
756948ca2d8aSDwaipayan Ray			# 1 -> sign off identical
757048ca2d8aSDwaipayan Ray			# 2 -> names and addresses match, comments mismatch
757148ca2d8aSDwaipayan Ray			# 3 -> addresses match, names different
757248ca2d8aSDwaipayan Ray			# 4 -> names match, addresses different
757348ca2d8aSDwaipayan Ray			# 5 -> names match, addresses excluding subaddress details (refer RFC 5233) match
757448ca2d8aSDwaipayan Ray
757548ca2d8aSDwaipayan Ray			my $sob_msg = "'From: $author' != 'Signed-off-by: $author_sob'";
757648ca2d8aSDwaipayan Ray
757748ca2d8aSDwaipayan Ray			if ($authorsignoff == 0) {
757848ca2d8aSDwaipayan Ray				ERROR("NO_AUTHOR_SIGN_OFF",
7579cd261496SGeert Uytterhoeven				      "Missing Signed-off-by: line by nominal patch author '$author'\n");
758048ca2d8aSDwaipayan Ray			} elsif ($authorsignoff == 2) {
758148ca2d8aSDwaipayan Ray				CHK("FROM_SIGN_OFF_MISMATCH",
758248ca2d8aSDwaipayan Ray				    "From:/Signed-off-by: email comments mismatch: $sob_msg\n");
758348ca2d8aSDwaipayan Ray			} elsif ($authorsignoff == 3) {
758448ca2d8aSDwaipayan Ray				WARN("FROM_SIGN_OFF_MISMATCH",
758548ca2d8aSDwaipayan Ray				     "From:/Signed-off-by: email name mismatch: $sob_msg\n");
758648ca2d8aSDwaipayan Ray			} elsif ($authorsignoff == 4) {
758748ca2d8aSDwaipayan Ray				WARN("FROM_SIGN_OFF_MISMATCH",
758848ca2d8aSDwaipayan Ray				     "From:/Signed-off-by: email address mismatch: $sob_msg\n");
758948ca2d8aSDwaipayan Ray			} elsif ($authorsignoff == 5) {
759048ca2d8aSDwaipayan Ray				WARN("FROM_SIGN_OFF_MISMATCH",
759148ca2d8aSDwaipayan Ray				     "From:/Signed-off-by: email subaddress mismatch: $sob_msg\n");
759248ca2d8aSDwaipayan Ray			}
7593cd261496SGeert Uytterhoeven		}
75940a920b5bSAndy Whitcroft	}
75950a920b5bSAndy Whitcroft
7596f0a594c1SAndy Whitcroft	print report_dump();
759713214adfSAndy Whitcroft	if ($summary && !($clean == 1 && $quiet == 1)) {
759813214adfSAndy Whitcroft		print "$filename " if ($summary_file);
75996c72ffaaSAndy Whitcroft		print "total: $cnt_error errors, $cnt_warn warnings, " .
76006c72ffaaSAndy Whitcroft			(($check)? "$cnt_chk checks, " : "") .
76016c72ffaaSAndy Whitcroft			"$cnt_lines lines checked\n";
76026c72ffaaSAndy Whitcroft	}
76038905a67cSAndy Whitcroft
7604d2c0a235SAndy Whitcroft	if ($quiet == 0) {
7605ef212196SJoe Perches		# If there were any defects found and not already fixing them
7606ef212196SJoe Perches		if (!$clean and !$fix) {
7607ef212196SJoe Perches			print << "EOM"
7608ef212196SJoe Perches
7609ef212196SJoe PerchesNOTE: For some of the reported defects, checkpatch may be able to
7610ef212196SJoe Perches      mechanically convert to the typical style using --fix or --fix-inplace.
7611ef212196SJoe PerchesEOM
7612ef212196SJoe Perches		}
7613d2c0a235SAndy Whitcroft		# If there were whitespace errors which cleanpatch can fix
7614d2c0a235SAndy Whitcroft		# then suggest that.
7615d2c0a235SAndy Whitcroft		if ($rpt_cleaners) {
7616b0781216SMike Frysinger			$rpt_cleaners = 0;
7617d8469f16SJoe Perches			print << "EOM"
7618d8469f16SJoe Perches
7619d8469f16SJoe PerchesNOTE: Whitespace errors detected.
7620d8469f16SJoe Perches      You may wish to use scripts/cleanpatch or scripts/cleanfile
7621d8469f16SJoe PerchesEOM
7622d2c0a235SAndy Whitcroft		}
7623d2c0a235SAndy Whitcroft	}
7624d2c0a235SAndy Whitcroft
7625d752fcc8SJoe Perches	if ($clean == 0 && $fix &&
7626d752fcc8SJoe Perches	    ("@rawlines" ne "@fixed" ||
7627d752fcc8SJoe Perches	     $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
76289624b8d6SJoe Perches		my $newfile = $filename;
76299624b8d6SJoe Perches		$newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
76303705ce5bSJoe Perches		my $linecount = 0;
76313705ce5bSJoe Perches		my $f;
76323705ce5bSJoe Perches
7633d752fcc8SJoe Perches		@fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
7634d752fcc8SJoe Perches
76353705ce5bSJoe Perches		open($f, '>', $newfile)
76363705ce5bSJoe Perches		    or die "$P: Can't open $newfile for write\n";
76373705ce5bSJoe Perches		foreach my $fixed_line (@fixed) {
76383705ce5bSJoe Perches			$linecount++;
76393705ce5bSJoe Perches			if ($file) {
76403705ce5bSJoe Perches				if ($linecount > 3) {
76413705ce5bSJoe Perches					$fixed_line =~ s/^\+//;
76423705ce5bSJoe Perches					print $f $fixed_line . "\n";
76433705ce5bSJoe Perches				}
76443705ce5bSJoe Perches			} else {
76453705ce5bSJoe Perches				print $f $fixed_line . "\n";
76463705ce5bSJoe Perches			}
76473705ce5bSJoe Perches		}
76483705ce5bSJoe Perches		close($f);
76493705ce5bSJoe Perches
76503705ce5bSJoe Perches		if (!$quiet) {
76513705ce5bSJoe Perches			print << "EOM";
7652d8469f16SJoe Perches
76533705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile'
76543705ce5bSJoe Perches
76553705ce5bSJoe PerchesDo _NOT_ trust the results written to this file.
76563705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness.
76573705ce5bSJoe Perches
76583705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches.
76593705ce5bSJoe PerchesNo warranties, expressed or implied...
76603705ce5bSJoe PerchesEOM
76613705ce5bSJoe Perches		}
76623705ce5bSJoe Perches	}
76633705ce5bSJoe Perches
7664d8469f16SJoe Perches	if ($quiet == 0) {
7665d8469f16SJoe Perches		print "\n";
7666d8469f16SJoe Perches		if ($clean == 1) {
7667d8469f16SJoe Perches			print "$vname has no obvious style problems and is ready for submission.\n";
7668d8469f16SJoe Perches		} else {
7669d8469f16SJoe Perches			print "$vname has style problems, please review.\n";
76700a920b5bSAndy Whitcroft		}
76710a920b5bSAndy Whitcroft	}
76720a920b5bSAndy Whitcroft	return $clean;
76730a920b5bSAndy Whitcroft}
7674