xref: /qemu/scripts/checkpatch.pl (revision 1a6fad0c)
1b7d5a9c2SKamil Rytarowski#!/usr/bin/env perl
21ec3f6f9SBlue Swirl# (c) 2001, Dave Jones. (the file handling bit)
31ec3f6f9SBlue Swirl# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
41ec3f6f9SBlue Swirl# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
51ec3f6f9SBlue Swirl# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
61ec3f6f9SBlue Swirl# Licensed under the terms of the GNU GPL License version 2
71ec3f6f9SBlue Swirl
81ec3f6f9SBlue Swirluse strict;
9b7d5a9c2SKamil Rytarowskiuse warnings;
101ec3f6f9SBlue Swirl
111ec3f6f9SBlue Swirlmy $P = $0;
121ec3f6f9SBlue Swirl$P =~ s@.*/@@g;
131ec3f6f9SBlue Swirl
14777d05baSPaolo Bonziniour $SrcFile    = qr{\.(?:h|c|cpp|s|S|pl|py|sh)$};
15777d05baSPaolo Bonzini
161ec3f6f9SBlue Swirlmy $V = '0.31';
171ec3f6f9SBlue Swirl
181ec3f6f9SBlue Swirluse Getopt::Long qw(:config no_auto_abbrev);
191ec3f6f9SBlue Swirl
201ec3f6f9SBlue Swirlmy $quiet = 0;
211ec3f6f9SBlue Swirlmy $tree = 1;
221ec3f6f9SBlue Swirlmy $chk_signoff = 1;
238e1fe175SDaniel P. Berrangemy $chk_patch = undef;
248e1fe175SDaniel P. Berrangemy $chk_branch = undef;
251ec3f6f9SBlue Swirlmy $tst_only;
261ec3f6f9SBlue Swirlmy $emacs = 0;
271ec3f6f9SBlue Swirlmy $terse = 0;
288e1fe175SDaniel P. Berrangemy $file = undef;
29141de886SPaolo Bonzinimy $no_warnings = 0;
301ec3f6f9SBlue Swirlmy $summary = 1;
311ec3f6f9SBlue Swirlmy $mailback = 0;
321ec3f6f9SBlue Swirlmy $summary_file = 0;
331ec3f6f9SBlue Swirlmy $root;
341ec3f6f9SBlue Swirlmy %debug;
351ec3f6f9SBlue Swirlmy $help = 0;
361ec3f6f9SBlue Swirl
371ec3f6f9SBlue Swirlsub help {
381ec3f6f9SBlue Swirl	my ($exitcode) = @_;
391ec3f6f9SBlue Swirl
401ec3f6f9SBlue Swirl	print << "EOM";
418e1fe175SDaniel P. BerrangeUsage:
428e1fe175SDaniel P. Berrange
438e1fe175SDaniel P. Berrange    $P [OPTION]... [FILE]...
448e1fe175SDaniel P. Berrange    $P [OPTION]... [GIT-REV-LIST]
458e1fe175SDaniel P. Berrange
461ec3f6f9SBlue SwirlVersion: $V
471ec3f6f9SBlue Swirl
481ec3f6f9SBlue SwirlOptions:
491ec3f6f9SBlue Swirl  -q, --quiet                quiet
501ec3f6f9SBlue Swirl  --no-tree                  run without a kernel tree
511ec3f6f9SBlue Swirl  --no-signoff               do not check for 'Signed-off-by' line
528e1fe175SDaniel P. Berrange  --patch                    treat FILE as patchfile
538e1fe175SDaniel P. Berrange  --branch                   treat args as GIT revision list
541ec3f6f9SBlue Swirl  --emacs                    emacs compile window format
551ec3f6f9SBlue Swirl  --terse                    one line per report
561ec3f6f9SBlue Swirl  -f, --file                 treat FILE as regular source file
57141de886SPaolo Bonzini  --strict                   fail if only warnings are found
581ec3f6f9SBlue Swirl  --root=PATH                PATH to the kernel tree root
591ec3f6f9SBlue Swirl  --no-summary               suppress the per-file summary
601ec3f6f9SBlue Swirl  --mailback                 only produce a report in case of warnings/errors
611ec3f6f9SBlue Swirl  --summary-file             include the filename in summary
621ec3f6f9SBlue Swirl  --debug KEY=[0|1]          turn on/off debugging of KEY, where KEY is one of
631ec3f6f9SBlue Swirl                             'values', 'possible', 'type', and 'attr' (default
641ec3f6f9SBlue Swirl                             is all off)
651ec3f6f9SBlue Swirl  --test-only=WORD           report only warnings/errors containing WORD
661ec3f6f9SBlue Swirl                             literally
671ec3f6f9SBlue Swirl  -h, --help, --version      display this help and exit
681ec3f6f9SBlue Swirl
691ec3f6f9SBlue SwirlWhen FILE is - read standard input.
701ec3f6f9SBlue SwirlEOM
711ec3f6f9SBlue Swirl
721ec3f6f9SBlue Swirl	exit($exitcode);
731ec3f6f9SBlue Swirl}
741ec3f6f9SBlue Swirl
751ec3f6f9SBlue SwirlGetOptions(
761ec3f6f9SBlue Swirl	'q|quiet+'	=> \$quiet,
771ec3f6f9SBlue Swirl	'tree!'		=> \$tree,
781ec3f6f9SBlue Swirl	'signoff!'	=> \$chk_signoff,
791ec3f6f9SBlue Swirl	'patch!'	=> \$chk_patch,
808e1fe175SDaniel P. Berrange	'branch!'	=> \$chk_branch,
811ec3f6f9SBlue Swirl	'emacs!'	=> \$emacs,
821ec3f6f9SBlue Swirl	'terse!'	=> \$terse,
831ec3f6f9SBlue Swirl	'f|file!'	=> \$file,
84141de886SPaolo Bonzini	'strict!'	=> \$no_warnings,
851ec3f6f9SBlue Swirl	'root=s'	=> \$root,
861ec3f6f9SBlue Swirl	'summary!'	=> \$summary,
871ec3f6f9SBlue Swirl	'mailback!'	=> \$mailback,
881ec3f6f9SBlue Swirl	'summary-file!'	=> \$summary_file,
891ec3f6f9SBlue Swirl
901ec3f6f9SBlue Swirl	'debug=s'	=> \%debug,
911ec3f6f9SBlue Swirl	'test-only=s'	=> \$tst_only,
921ec3f6f9SBlue Swirl	'h|help'	=> \$help,
931ec3f6f9SBlue Swirl	'version'	=> \$help
941ec3f6f9SBlue Swirl) or help(1);
951ec3f6f9SBlue Swirl
961ec3f6f9SBlue Swirlhelp(0) if ($help);
971ec3f6f9SBlue Swirl
981ec3f6f9SBlue Swirlmy $exit = 0;
991ec3f6f9SBlue Swirl
1001ec3f6f9SBlue Swirlif ($#ARGV < 0) {
1011ec3f6f9SBlue Swirl	print "$P: no input files\n";
1021ec3f6f9SBlue Swirl	exit(1);
1031ec3f6f9SBlue Swirl}
1041ec3f6f9SBlue Swirl
1058e1fe175SDaniel P. Berrangeif (!defined $chk_branch && !defined $chk_patch && !defined $file) {
106777d05baSPaolo Bonzini	$chk_branch = $ARGV[0] =~ /.\.\./ ? 1 : 0;
107777d05baSPaolo Bonzini	$file = $ARGV[0] =~ /$SrcFile/ ? 1 : 0;
108777d05baSPaolo Bonzini	$chk_patch = $chk_branch || $file ? 0 : 1;
1098e1fe175SDaniel P. Berrange} elsif (!defined $chk_branch && !defined $chk_patch) {
1108e1fe175SDaniel P. Berrange	if ($file) {
1118e1fe175SDaniel P. Berrange		$chk_branch = $chk_patch = 0;
1128e1fe175SDaniel P. Berrange	} else {
113777d05baSPaolo Bonzini		$chk_branch = $ARGV[0] =~ /.\.\./ ? 1 : 0;
1148e1fe175SDaniel P. Berrange		$chk_patch = $chk_branch ? 0 : 1;
1158e1fe175SDaniel P. Berrange	}
1168e1fe175SDaniel P. Berrange} elsif (!defined $chk_branch && !defined $file) {
1178e1fe175SDaniel P. Berrange	if ($chk_patch) {
1188e1fe175SDaniel P. Berrange		$chk_branch = $file = 0;
1198e1fe175SDaniel P. Berrange	} else {
120777d05baSPaolo Bonzini		$chk_branch = $ARGV[0] =~ /.\.\./ ? 1 : 0;
1218e1fe175SDaniel P. Berrange		$file = $chk_branch ? 0 : 1;
1228e1fe175SDaniel P. Berrange	}
1238e1fe175SDaniel P. Berrange} elsif (!defined $chk_patch && !defined $file) {
1248e1fe175SDaniel P. Berrange	if ($chk_branch) {
1258e1fe175SDaniel P. Berrange		$chk_patch = $file = 0;
1268e1fe175SDaniel P. Berrange	} else {
127777d05baSPaolo Bonzini		$file = $ARGV[0] =~ /$SrcFile/ ? 1 : 0;
128777d05baSPaolo Bonzini		$chk_patch = $file ? 0 : 1;
1298e1fe175SDaniel P. Berrange	}
1308e1fe175SDaniel P. Berrange} elsif (!defined $chk_branch) {
1318e1fe175SDaniel P. Berrange	$chk_branch = $chk_patch || $file ? 0 : 1;
1328e1fe175SDaniel P. Berrange} elsif (!defined $chk_patch) {
1338e1fe175SDaniel P. Berrange	$chk_patch = $chk_branch || $file ? 0 : 1;
1348e1fe175SDaniel P. Berrange} elsif (!defined $file) {
1358e1fe175SDaniel P. Berrange	$file = $chk_patch || $chk_branch ? 0 : 1;
1368e1fe175SDaniel P. Berrange}
1378e1fe175SDaniel P. Berrange
1388e1fe175SDaniel P. Berrangeif (($chk_patch && $chk_branch) ||
1398e1fe175SDaniel P. Berrange    ($chk_patch && $file) ||
1408e1fe175SDaniel P. Berrange    ($chk_branch && $file)) {
1418e1fe175SDaniel P. Berrange	die "Only one of --file, --branch, --patch is permitted\n";
1428e1fe175SDaniel P. Berrange}
1438e1fe175SDaniel P. Berrangeif (!$chk_patch && !$chk_branch && !$file) {
1448e1fe175SDaniel P. Berrange	die "One of --file, --branch, --patch is required\n";
1458e1fe175SDaniel P. Berrange}
1468e1fe175SDaniel P. Berrange
1471ec3f6f9SBlue Swirlmy $dbg_values = 0;
1481ec3f6f9SBlue Swirlmy $dbg_possible = 0;
1491ec3f6f9SBlue Swirlmy $dbg_type = 0;
1501ec3f6f9SBlue Swirlmy $dbg_attr = 0;
151a99ac041SDon Slutzmy $dbg_adv_dcs = 0;
1525424302eSDon Slutzmy $dbg_adv_checking = 0;
15369402a69SDon Slutzmy $dbg_adv_apw = 0;
1541ec3f6f9SBlue Swirlfor my $key (keys %debug) {
1551ec3f6f9SBlue Swirl	## no critic
1561ec3f6f9SBlue Swirl	eval "\${dbg_$key} = '$debug{$key}';";
1571ec3f6f9SBlue Swirl	die "$@" if ($@);
1581ec3f6f9SBlue Swirl}
1591ec3f6f9SBlue Swirl
1601ec3f6f9SBlue Swirlmy $rpt_cleaners = 0;
1611ec3f6f9SBlue Swirl
1621ec3f6f9SBlue Swirlif ($terse) {
1631ec3f6f9SBlue Swirl	$emacs = 1;
1641ec3f6f9SBlue Swirl	$quiet++;
1651ec3f6f9SBlue Swirl}
1661ec3f6f9SBlue Swirl
1671ec3f6f9SBlue Swirlif ($tree) {
1681ec3f6f9SBlue Swirl	if (defined $root) {
1691ec3f6f9SBlue Swirl		if (!top_of_kernel_tree($root)) {
1701ec3f6f9SBlue Swirl			die "$P: $root: --root does not point at a valid tree\n";
1711ec3f6f9SBlue Swirl		}
1721ec3f6f9SBlue Swirl	} else {
1731ec3f6f9SBlue Swirl		if (top_of_kernel_tree('.')) {
1741ec3f6f9SBlue Swirl			$root = '.';
1751ec3f6f9SBlue Swirl		} elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
1761ec3f6f9SBlue Swirl						top_of_kernel_tree($1)) {
1771ec3f6f9SBlue Swirl			$root = $1;
1781ec3f6f9SBlue Swirl		}
1791ec3f6f9SBlue Swirl	}
1801ec3f6f9SBlue Swirl
1811ec3f6f9SBlue Swirl	if (!defined $root) {
1821ec3f6f9SBlue Swirl		print "Must be run from the top-level dir. of a kernel tree\n";
1831ec3f6f9SBlue Swirl		exit(2);
1841ec3f6f9SBlue Swirl	}
1851ec3f6f9SBlue Swirl}
1861ec3f6f9SBlue Swirl
1871ec3f6f9SBlue Swirlmy $emitted_corrupt = 0;
1881ec3f6f9SBlue Swirl
1891ec3f6f9SBlue Swirlour $Ident	= qr{
1901ec3f6f9SBlue Swirl			[A-Za-z_][A-Za-z\d_]*
1911ec3f6f9SBlue Swirl			(?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
1921ec3f6f9SBlue Swirl		}x;
1931ec3f6f9SBlue Swirlour $Storage	= qr{extern|static|asmlinkage};
1941ec3f6f9SBlue Swirlour $Sparse	= qr{
195f1e155bbSPaolo Bonzini			__force
1961ec3f6f9SBlue Swirl		}x;
1971ec3f6f9SBlue Swirl
1981ec3f6f9SBlue Swirl# Notes to $Attribute:
1991ec3f6f9SBlue Swirlour $Attribute	= qr{
2001ec3f6f9SBlue Swirl			const|
20171c47b01SPaolo Bonzini			volatile|
20271c47b01SPaolo Bonzini			QEMU_NORETURN|
20371c47b01SPaolo Bonzini			QEMU_WARN_UNUSED_RESULT|
20471c47b01SPaolo Bonzini			QEMU_SENTINEL|
20571c47b01SPaolo Bonzini			QEMU_ARTIFICIAL|
20671c47b01SPaolo Bonzini			QEMU_PACKED|
20771c47b01SPaolo Bonzini			GCC_FMT_ATTR
2081ec3f6f9SBlue Swirl		  }x;
2091ec3f6f9SBlue Swirlour $Modifier;
21071c47b01SPaolo Bonziniour $Inline	= qr{inline};
2111ec3f6f9SBlue Swirlour $Member	= qr{->$Ident|\.$Ident|\[[^]]*\]};
2121ec3f6f9SBlue Swirlour $Lval	= qr{$Ident(?:$Member)*};
2131ec3f6f9SBlue Swirl
2141ec3f6f9SBlue Swirlour $Constant	= qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
2151ec3f6f9SBlue Swirlour $Assignment	= qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
2161ec3f6f9SBlue Swirlour $Compare    = qr{<=|>=|==|!=|<|>};
2171ec3f6f9SBlue Swirlour $Operators	= qr{
2181ec3f6f9SBlue Swirl			<=|>=|==|!=|
2191ec3f6f9SBlue Swirl			=>|->|<<|>>|<|>|!|~|
2201ec3f6f9SBlue Swirl			&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
2211ec3f6f9SBlue Swirl		  }x;
2221ec3f6f9SBlue Swirl
2231ec3f6f9SBlue Swirlour $NonptrType;
2241ec3f6f9SBlue Swirlour $Type;
2251ec3f6f9SBlue Swirlour $Declare;
2261ec3f6f9SBlue Swirl
227b37c4aacSJoe Perchesour $NON_ASCII_UTF8	= qr{
228b37c4aacSJoe Perches	[\xC2-\xDF][\x80-\xBF]               # non-overlong 2-byte
2291ec3f6f9SBlue Swirl	|  \xE0[\xA0-\xBF][\x80-\xBF]        # excluding overlongs
2301ec3f6f9SBlue Swirl	| [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}  # straight 3-byte
2311ec3f6f9SBlue Swirl	|  \xED[\x80-\x9F][\x80-\xBF]        # excluding surrogates
2321ec3f6f9SBlue Swirl	|  \xF0[\x90-\xBF][\x80-\xBF]{2}     # planes 1-3
2331ec3f6f9SBlue Swirl	| [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
2341ec3f6f9SBlue Swirl	|  \xF4[\x80-\x8F][\x80-\xBF]{2}     # plane 16
2351ec3f6f9SBlue Swirl}x;
2361ec3f6f9SBlue Swirl
237b37c4aacSJoe Perchesour $UTF8	= qr{
238b37c4aacSJoe Perches	[\x09\x0A\x0D\x20-\x7E]              # ASCII
239b37c4aacSJoe Perches	| $NON_ASCII_UTF8
240b37c4aacSJoe Perches}x;
241b37c4aacSJoe Perches
242a6859debSPaolo Bonzini# There are still some false positives, but this catches most
243a6859debSPaolo Bonzini# common cases.
2441ec3f6f9SBlue Swirlour $typeTypedefs = qr{(?x:
245a6859debSPaolo Bonzini        [A-Z][A-Z\d_]*[a-z][A-Za-z\d_]*     # camelcase
246a6859debSPaolo Bonzini        | [A-Z][A-Z\d_]*AIOCB               # all uppercase
247a6859debSPaolo Bonzini        | [A-Z][A-Z\d_]*CPU                 # all uppercase
248a6859debSPaolo Bonzini        | QEMUBH                            # all uppercase
2491ec3f6f9SBlue Swirl)};
2501ec3f6f9SBlue Swirl
2511ec3f6f9SBlue Swirlour @typeList = (
2521ec3f6f9SBlue Swirl	qr{void},
2531ec3f6f9SBlue Swirl	qr{(?:unsigned\s+)?char},
2541ec3f6f9SBlue Swirl	qr{(?:unsigned\s+)?short},
2551ec3f6f9SBlue Swirl	qr{(?:unsigned\s+)?int},
2561ec3f6f9SBlue Swirl	qr{(?:unsigned\s+)?long},
2571ec3f6f9SBlue Swirl	qr{(?:unsigned\s+)?long\s+int},
2581ec3f6f9SBlue Swirl	qr{(?:unsigned\s+)?long\s+long},
2591ec3f6f9SBlue Swirl	qr{(?:unsigned\s+)?long\s+long\s+int},
2601ec3f6f9SBlue Swirl	qr{unsigned},
2611ec3f6f9SBlue Swirl	qr{float},
2621ec3f6f9SBlue Swirl	qr{double},
2631ec3f6f9SBlue Swirl	qr{bool},
2641ec3f6f9SBlue Swirl	qr{struct\s+$Ident},
2651ec3f6f9SBlue Swirl	qr{union\s+$Ident},
2661ec3f6f9SBlue Swirl	qr{enum\s+$Ident},
2671ec3f6f9SBlue Swirl	qr{${Ident}_t},
2681ec3f6f9SBlue Swirl	qr{${Ident}_handler},
2691ec3f6f9SBlue Swirl	qr{${Ident}_handler_fn},
270f0707d2eSCédric Le Goater	qr{target_(?:u)?long},
271825bfa00SGreg Kurz	qr{hwaddr},
272ed279a06SKlim Kireev	qr{xml${Ident}},
2735ac067a2SIan Jackson	qr{xendevicemodel_handle},
2741ec3f6f9SBlue Swirl);
275f1e155bbSPaolo Bonzini
276f1e155bbSPaolo Bonzini# This can be modified by sub possible.  Since it can be empty, be careful
277f1e155bbSPaolo Bonzini# about regexes that always match, because they can cause infinite loops.
2781ec3f6f9SBlue Swirlour @modifierList = (
2791ec3f6f9SBlue Swirl);
2801ec3f6f9SBlue Swirl
2811ec3f6f9SBlue Swirlsub build_types {
2821ec3f6f9SBlue Swirl	my $all = "(?x:  \n" . join("|\n  ", @typeList) . "\n)";
283f1e155bbSPaolo Bonzini	if (@modifierList > 0) {
284f1e155bbSPaolo Bonzini		my $mods = "(?x:  \n" . join("|\n  ", @modifierList) . "\n)";
2851ec3f6f9SBlue Swirl		$Modifier = qr{(?:$Attribute|$Sparse|$mods)};
286f1e155bbSPaolo Bonzini	} else {
287f1e155bbSPaolo Bonzini		$Modifier = qr{(?:$Attribute|$Sparse)};
288f1e155bbSPaolo Bonzini	}
2891ec3f6f9SBlue Swirl	$NonptrType	= qr{
2901ec3f6f9SBlue Swirl			(?:$Modifier\s+|const\s+)*
2911ec3f6f9SBlue Swirl			(?:
2921ec3f6f9SBlue Swirl				(?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
2931ec3f6f9SBlue Swirl				(?:$typeTypedefs\b)|
2941ec3f6f9SBlue Swirl				(?:${all}\b)
2951ec3f6f9SBlue Swirl			)
2961ec3f6f9SBlue Swirl			(?:\s+$Modifier|\s+const)*
2971ec3f6f9SBlue Swirl		  }x;
2981ec3f6f9SBlue Swirl	$Type	= qr{
2991ec3f6f9SBlue Swirl			$NonptrType
3001ec3f6f9SBlue Swirl			(?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
3011ec3f6f9SBlue Swirl			(?:\s+$Inline|\s+$Modifier)*
3021ec3f6f9SBlue Swirl		  }x;
3031ec3f6f9SBlue Swirl	$Declare	= qr{(?:$Storage\s+)?$Type};
3041ec3f6f9SBlue Swirl}
3051ec3f6f9SBlue Swirlbuild_types();
3061ec3f6f9SBlue Swirl
3071ec3f6f9SBlue Swirl$chk_signoff = 0 if ($file);
3081ec3f6f9SBlue Swirl
3091ec3f6f9SBlue Swirlmy @rawlines = ();
3101ec3f6f9SBlue Swirlmy @lines = ();
3111ec3f6f9SBlue Swirlmy $vname;
3128e1fe175SDaniel P. Berrangeif ($chk_branch) {
3138e1fe175SDaniel P. Berrange	my @patches;
3148e1fe175SDaniel P. Berrange	my $HASH;
3158e1fe175SDaniel P. Berrange	open($HASH, "-|", "git", "log", "--format=%H", $ARGV[0]) ||
3168e1fe175SDaniel P. Berrange		die "$P: git log --format=%H $ARGV[0] failed - $!\n";
3178e1fe175SDaniel P. Berrange
3188e1fe175SDaniel P. Berrange	while (<$HASH>) {
3198e1fe175SDaniel P. Berrange		chomp;
3208e1fe175SDaniel P. Berrange		push @patches, $_;
3218e1fe175SDaniel P. Berrange	}
3228e1fe175SDaniel P. Berrange
3238e1fe175SDaniel P. Berrange	close $HASH;
3248e1fe175SDaniel P. Berrange
3258e1fe175SDaniel P. Berrange	die "$P: no revisions returned for revlist '$chk_branch'\n"
3268e1fe175SDaniel P. Berrange	    unless @patches;
3278e1fe175SDaniel P. Berrange
3288e1fe175SDaniel P. Berrange	for my $hash (@patches) {
3298e1fe175SDaniel P. Berrange		my $FILE;
3308e1fe175SDaniel P. Berrange		open($FILE, '-|', "git", "show", $hash) ||
3318e1fe175SDaniel P. Berrange			die "$P: git show $hash - $!\n";
3328e1fe175SDaniel P. Berrange		$vname = $hash;
3338e1fe175SDaniel P. Berrange		while (<$FILE>) {
3348e1fe175SDaniel P. Berrange			chomp;
3358e1fe175SDaniel P. Berrange			push(@rawlines, $_);
3368e1fe175SDaniel P. Berrange		}
3378e1fe175SDaniel P. Berrange		close($FILE);
3388e1fe175SDaniel P. Berrange		if (!process($hash)) {
3398e1fe175SDaniel P. Berrange			$exit = 1;
3408e1fe175SDaniel P. Berrange		}
3418e1fe175SDaniel P. Berrange		@rawlines = ();
3428e1fe175SDaniel P. Berrange		@lines = ();
3438e1fe175SDaniel P. Berrange	}
3448e1fe175SDaniel P. Berrange} else {
3451ec3f6f9SBlue Swirl	for my $filename (@ARGV) {
3461ec3f6f9SBlue Swirl		my $FILE;
3471ec3f6f9SBlue Swirl		if ($file) {
3481ec3f6f9SBlue Swirl			open($FILE, '-|', "diff -u /dev/null $filename") ||
3491ec3f6f9SBlue Swirl				die "$P: $filename: diff failed - $!\n";
3501ec3f6f9SBlue Swirl		} elsif ($filename eq '-') {
3511ec3f6f9SBlue Swirl			open($FILE, '<&STDIN');
3521ec3f6f9SBlue Swirl		} else {
3531ec3f6f9SBlue Swirl			open($FILE, '<', "$filename") ||
3541ec3f6f9SBlue Swirl				die "$P: $filename: open failed - $!\n";
3551ec3f6f9SBlue Swirl		}
3561ec3f6f9SBlue Swirl		if ($filename eq '-') {
3571ec3f6f9SBlue Swirl			$vname = 'Your patch';
3581ec3f6f9SBlue Swirl		} else {
3591ec3f6f9SBlue Swirl			$vname = $filename;
3601ec3f6f9SBlue Swirl		}
3611ec3f6f9SBlue Swirl		while (<$FILE>) {
3621ec3f6f9SBlue Swirl			chomp;
3631ec3f6f9SBlue Swirl			push(@rawlines, $_);
3641ec3f6f9SBlue Swirl		}
3651ec3f6f9SBlue Swirl		close($FILE);
3661ec3f6f9SBlue Swirl		if (!process($filename)) {
3671ec3f6f9SBlue Swirl			$exit = 1;
3681ec3f6f9SBlue Swirl		}
3691ec3f6f9SBlue Swirl		@rawlines = ();
3701ec3f6f9SBlue Swirl		@lines = ();
3711ec3f6f9SBlue Swirl	}
3728e1fe175SDaniel P. Berrange}
3731ec3f6f9SBlue Swirl
3741ec3f6f9SBlue Swirlexit($exit);
3751ec3f6f9SBlue Swirl
3761ec3f6f9SBlue Swirlsub top_of_kernel_tree {
3771ec3f6f9SBlue Swirl	my ($root) = @_;
3781ec3f6f9SBlue Swirl
3791ec3f6f9SBlue Swirl	my @tree_check = (
380b6469683SBlue Swirl		"COPYING", "MAINTAINERS", "Makefile",
381b6469683SBlue Swirl		"README", "docs", "VERSION",
382b6469683SBlue Swirl		"vl.c"
3831ec3f6f9SBlue Swirl	);
3841ec3f6f9SBlue Swirl
3851ec3f6f9SBlue Swirl	foreach my $check (@tree_check) {
3861ec3f6f9SBlue Swirl		if (! -e $root . '/' . $check) {
3871ec3f6f9SBlue Swirl			return 0;
3881ec3f6f9SBlue Swirl		}
3891ec3f6f9SBlue Swirl	}
3901ec3f6f9SBlue Swirl	return 1;
3911ec3f6f9SBlue Swirl}
3921ec3f6f9SBlue Swirl
3931ec3f6f9SBlue Swirlsub expand_tabs {
3941ec3f6f9SBlue Swirl	my ($str) = @_;
3951ec3f6f9SBlue Swirl
3961ec3f6f9SBlue Swirl	my $res = '';
3971ec3f6f9SBlue Swirl	my $n = 0;
3981ec3f6f9SBlue Swirl	for my $c (split(//, $str)) {
3991ec3f6f9SBlue Swirl		if ($c eq "\t") {
4001ec3f6f9SBlue Swirl			$res .= ' ';
4011ec3f6f9SBlue Swirl			$n++;
4021ec3f6f9SBlue Swirl			for (; ($n % 8) != 0; $n++) {
4031ec3f6f9SBlue Swirl				$res .= ' ';
4041ec3f6f9SBlue Swirl			}
4051ec3f6f9SBlue Swirl			next;
4061ec3f6f9SBlue Swirl		}
4071ec3f6f9SBlue Swirl		$res .= $c;
4081ec3f6f9SBlue Swirl		$n++;
4091ec3f6f9SBlue Swirl	}
4101ec3f6f9SBlue Swirl
4111ec3f6f9SBlue Swirl	return $res;
4121ec3f6f9SBlue Swirl}
4131ec3f6f9SBlue Swirlsub copy_spacing {
4141ec3f6f9SBlue Swirl	(my $res = shift) =~ tr/\t/ /c;
4151ec3f6f9SBlue Swirl	return $res;
4161ec3f6f9SBlue Swirl}
4171ec3f6f9SBlue Swirl
4181ec3f6f9SBlue Swirlsub line_stats {
4191ec3f6f9SBlue Swirl	my ($line) = @_;
4201ec3f6f9SBlue Swirl
4211ec3f6f9SBlue Swirl	# Drop the diff line leader and expand tabs
4221ec3f6f9SBlue Swirl	$line =~ s/^.//;
4231ec3f6f9SBlue Swirl	$line = expand_tabs($line);
4241ec3f6f9SBlue Swirl
4251ec3f6f9SBlue Swirl	# Pick the indent from the front of the line.
4261ec3f6f9SBlue Swirl	my ($white) = ($line =~ /^(\s*)/);
4271ec3f6f9SBlue Swirl
4281ec3f6f9SBlue Swirl	return (length($line), length($white));
4291ec3f6f9SBlue Swirl}
4301ec3f6f9SBlue Swirl
4311ec3f6f9SBlue Swirlmy $sanitise_quote = '';
4321ec3f6f9SBlue Swirl
4331ec3f6f9SBlue Swirlsub sanitise_line_reset {
4341ec3f6f9SBlue Swirl	my ($in_comment) = @_;
4351ec3f6f9SBlue Swirl
4361ec3f6f9SBlue Swirl	if ($in_comment) {
4371ec3f6f9SBlue Swirl		$sanitise_quote = '*/';
4381ec3f6f9SBlue Swirl	} else {
4391ec3f6f9SBlue Swirl		$sanitise_quote = '';
4401ec3f6f9SBlue Swirl	}
4411ec3f6f9SBlue Swirl}
4421ec3f6f9SBlue Swirlsub sanitise_line {
4431ec3f6f9SBlue Swirl	my ($line) = @_;
4441ec3f6f9SBlue Swirl
4451ec3f6f9SBlue Swirl	my $res = '';
4461ec3f6f9SBlue Swirl	my $l = '';
4471ec3f6f9SBlue Swirl
4481ec3f6f9SBlue Swirl	my $qlen = 0;
4491ec3f6f9SBlue Swirl	my $off = 0;
4501ec3f6f9SBlue Swirl	my $c;
4511ec3f6f9SBlue Swirl
4521ec3f6f9SBlue Swirl	# Always copy over the diff marker.
4531ec3f6f9SBlue Swirl	$res = substr($line, 0, 1);
4541ec3f6f9SBlue Swirl
4551ec3f6f9SBlue Swirl	for ($off = 1; $off < length($line); $off++) {
4561ec3f6f9SBlue Swirl		$c = substr($line, $off, 1);
4571ec3f6f9SBlue Swirl
458cb8d4c8fSStefan Weil		# Comments we are wacking completely including the begin
4591ec3f6f9SBlue Swirl		# and end, all to $;.
4601ec3f6f9SBlue Swirl		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
4611ec3f6f9SBlue Swirl			$sanitise_quote = '*/';
4621ec3f6f9SBlue Swirl
4631ec3f6f9SBlue Swirl			substr($res, $off, 2, "$;$;");
4641ec3f6f9SBlue Swirl			$off++;
4651ec3f6f9SBlue Swirl			next;
4661ec3f6f9SBlue Swirl		}
4671ec3f6f9SBlue Swirl		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
4681ec3f6f9SBlue Swirl			$sanitise_quote = '';
4691ec3f6f9SBlue Swirl			substr($res, $off, 2, "$;$;");
4701ec3f6f9SBlue Swirl			$off++;
4711ec3f6f9SBlue Swirl			next;
4721ec3f6f9SBlue Swirl		}
4731ec3f6f9SBlue Swirl		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
4741ec3f6f9SBlue Swirl			$sanitise_quote = '//';
4751ec3f6f9SBlue Swirl
4761ec3f6f9SBlue Swirl			substr($res, $off, 2, $sanitise_quote);
4771ec3f6f9SBlue Swirl			$off++;
4781ec3f6f9SBlue Swirl			next;
4791ec3f6f9SBlue Swirl		}
4801ec3f6f9SBlue Swirl
4811ec3f6f9SBlue Swirl		# A \ in a string means ignore the next character.
4821ec3f6f9SBlue Swirl		if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
4831ec3f6f9SBlue Swirl		    $c eq "\\") {
4841ec3f6f9SBlue Swirl			substr($res, $off, 2, 'XX');
4851ec3f6f9SBlue Swirl			$off++;
4861ec3f6f9SBlue Swirl			next;
4871ec3f6f9SBlue Swirl		}
4881ec3f6f9SBlue Swirl		# Regular quotes.
4891ec3f6f9SBlue Swirl		if ($c eq "'" || $c eq '"') {
4901ec3f6f9SBlue Swirl			if ($sanitise_quote eq '') {
4911ec3f6f9SBlue Swirl				$sanitise_quote = $c;
4921ec3f6f9SBlue Swirl
4931ec3f6f9SBlue Swirl				substr($res, $off, 1, $c);
4941ec3f6f9SBlue Swirl				next;
4951ec3f6f9SBlue Swirl			} elsif ($sanitise_quote eq $c) {
4961ec3f6f9SBlue Swirl				$sanitise_quote = '';
4971ec3f6f9SBlue Swirl			}
4981ec3f6f9SBlue Swirl		}
4991ec3f6f9SBlue Swirl
5001ec3f6f9SBlue Swirl		#print "c<$c> SQ<$sanitise_quote>\n";
5011ec3f6f9SBlue Swirl		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
5021ec3f6f9SBlue Swirl			substr($res, $off, 1, $;);
5031ec3f6f9SBlue Swirl		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
5041ec3f6f9SBlue Swirl			substr($res, $off, 1, $;);
5051ec3f6f9SBlue Swirl		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
5061ec3f6f9SBlue Swirl			substr($res, $off, 1, 'X');
5071ec3f6f9SBlue Swirl		} else {
5081ec3f6f9SBlue Swirl			substr($res, $off, 1, $c);
5091ec3f6f9SBlue Swirl		}
5101ec3f6f9SBlue Swirl	}
5111ec3f6f9SBlue Swirl
5121ec3f6f9SBlue Swirl	if ($sanitise_quote eq '//') {
5131ec3f6f9SBlue Swirl		$sanitise_quote = '';
5141ec3f6f9SBlue Swirl	}
5151ec3f6f9SBlue Swirl
5161ec3f6f9SBlue Swirl	# The pathname on a #include may be surrounded by '<' and '>'.
5171ec3f6f9SBlue Swirl	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
5181ec3f6f9SBlue Swirl		my $clean = 'X' x length($1);
5191ec3f6f9SBlue Swirl		$res =~ s@\<.*\>@<$clean>@;
5201ec3f6f9SBlue Swirl
5211ec3f6f9SBlue Swirl	# The whole of a #error is a string.
5221ec3f6f9SBlue Swirl	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
5231ec3f6f9SBlue Swirl		my $clean = 'X' x length($1);
5241ec3f6f9SBlue Swirl		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
5251ec3f6f9SBlue Swirl	}
5261ec3f6f9SBlue Swirl
5271ec3f6f9SBlue Swirl	return $res;
5281ec3f6f9SBlue Swirl}
5291ec3f6f9SBlue Swirl
5301ec3f6f9SBlue Swirlsub ctx_statement_block {
5311ec3f6f9SBlue Swirl	my ($linenr, $remain, $off) = @_;
5321ec3f6f9SBlue Swirl	my $line = $linenr - 1;
5331ec3f6f9SBlue Swirl	my $blk = '';
5341ec3f6f9SBlue Swirl	my $soff = $off;
5351ec3f6f9SBlue Swirl	my $coff = $off - 1;
5361ec3f6f9SBlue Swirl	my $coff_set = 0;
5371ec3f6f9SBlue Swirl
5381ec3f6f9SBlue Swirl	my $loff = 0;
5391ec3f6f9SBlue Swirl
5401ec3f6f9SBlue Swirl	my $type = '';
5411ec3f6f9SBlue Swirl	my $level = 0;
5421ec3f6f9SBlue Swirl	my @stack = ();
5431ec3f6f9SBlue Swirl	my $p;
5441ec3f6f9SBlue Swirl	my $c;
5451ec3f6f9SBlue Swirl	my $len = 0;
5461ec3f6f9SBlue Swirl
5471ec3f6f9SBlue Swirl	my $remainder;
5481ec3f6f9SBlue Swirl	while (1) {
5491ec3f6f9SBlue Swirl		@stack = (['', 0]) if ($#stack == -1);
5501ec3f6f9SBlue Swirl
5511ec3f6f9SBlue Swirl		#warn "CSB: blk<$blk> remain<$remain>\n";
5521ec3f6f9SBlue Swirl		# If we are about to drop off the end, pull in more
5531ec3f6f9SBlue Swirl		# context.
5541ec3f6f9SBlue Swirl		if ($off >= $len) {
5551ec3f6f9SBlue Swirl			for (; $remain > 0; $line++) {
5561ec3f6f9SBlue Swirl				last if (!defined $lines[$line]);
5571ec3f6f9SBlue Swirl				next if ($lines[$line] =~ /^-/);
5581ec3f6f9SBlue Swirl				$remain--;
5591ec3f6f9SBlue Swirl				$loff = $len;
5601ec3f6f9SBlue Swirl				$blk .= $lines[$line] . "\n";
5611ec3f6f9SBlue Swirl				$len = length($blk);
5621ec3f6f9SBlue Swirl				$line++;
5631ec3f6f9SBlue Swirl				last;
5641ec3f6f9SBlue Swirl			}
5651ec3f6f9SBlue Swirl			# Bail if there is no further context.
5661ec3f6f9SBlue Swirl			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
5671ec3f6f9SBlue Swirl			if ($off >= $len) {
5681ec3f6f9SBlue Swirl				last;
5691ec3f6f9SBlue Swirl			}
5701ec3f6f9SBlue Swirl		}
5711ec3f6f9SBlue Swirl		$p = $c;
5721ec3f6f9SBlue Swirl		$c = substr($blk, $off, 1);
5731ec3f6f9SBlue Swirl		$remainder = substr($blk, $off);
5741ec3f6f9SBlue Swirl
5751ec3f6f9SBlue Swirl		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
5761ec3f6f9SBlue Swirl
5771ec3f6f9SBlue Swirl		# Handle nested #if/#else.
5781ec3f6f9SBlue Swirl		if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
5791ec3f6f9SBlue Swirl			push(@stack, [ $type, $level ]);
5801ec3f6f9SBlue Swirl		} elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
5811ec3f6f9SBlue Swirl			($type, $level) = @{$stack[$#stack - 1]};
5821ec3f6f9SBlue Swirl		} elsif ($remainder =~ /^#\s*endif\b/) {
5831ec3f6f9SBlue Swirl			($type, $level) = @{pop(@stack)};
5841ec3f6f9SBlue Swirl		}
5851ec3f6f9SBlue Swirl
5861ec3f6f9SBlue Swirl		# Statement ends at the ';' or a close '}' at the
5871ec3f6f9SBlue Swirl		# outermost level.
5881ec3f6f9SBlue Swirl		if ($level == 0 && $c eq ';') {
5891ec3f6f9SBlue Swirl			last;
5901ec3f6f9SBlue Swirl		}
5911ec3f6f9SBlue Swirl
5921ec3f6f9SBlue Swirl		# An else is really a conditional as long as its not else if
5931ec3f6f9SBlue Swirl		if ($level == 0 && $coff_set == 0 &&
5941ec3f6f9SBlue Swirl				(!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
5951ec3f6f9SBlue Swirl				$remainder =~ /^(else)(?:\s|{)/ &&
5961ec3f6f9SBlue Swirl				$remainder !~ /^else\s+if\b/) {
5971ec3f6f9SBlue Swirl			$coff = $off + length($1) - 1;
5981ec3f6f9SBlue Swirl			$coff_set = 1;
5991ec3f6f9SBlue Swirl			#warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
6001ec3f6f9SBlue Swirl			#warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
6011ec3f6f9SBlue Swirl		}
6021ec3f6f9SBlue Swirl
6031ec3f6f9SBlue Swirl		if (($type eq '' || $type eq '(') && $c eq '(') {
6041ec3f6f9SBlue Swirl			$level++;
6051ec3f6f9SBlue Swirl			$type = '(';
6061ec3f6f9SBlue Swirl		}
6071ec3f6f9SBlue Swirl		if ($type eq '(' && $c eq ')') {
6081ec3f6f9SBlue Swirl			$level--;
6091ec3f6f9SBlue Swirl			$type = ($level != 0)? '(' : '';
6101ec3f6f9SBlue Swirl
6111ec3f6f9SBlue Swirl			if ($level == 0 && $coff < $soff) {
6121ec3f6f9SBlue Swirl				$coff = $off;
6131ec3f6f9SBlue Swirl				$coff_set = 1;
6141ec3f6f9SBlue Swirl				#warn "CSB: mark coff<$coff>\n";
6151ec3f6f9SBlue Swirl			}
6161ec3f6f9SBlue Swirl		}
6171ec3f6f9SBlue Swirl		if (($type eq '' || $type eq '{') && $c eq '{') {
6181ec3f6f9SBlue Swirl			$level++;
6191ec3f6f9SBlue Swirl			$type = '{';
6201ec3f6f9SBlue Swirl		}
6211ec3f6f9SBlue Swirl		if ($type eq '{' && $c eq '}') {
6221ec3f6f9SBlue Swirl			$level--;
6231ec3f6f9SBlue Swirl			$type = ($level != 0)? '{' : '';
6241ec3f6f9SBlue Swirl
6251ec3f6f9SBlue Swirl			if ($level == 0) {
6261ec3f6f9SBlue Swirl				if (substr($blk, $off + 1, 1) eq ';') {
6271ec3f6f9SBlue Swirl					$off++;
6281ec3f6f9SBlue Swirl				}
6291ec3f6f9SBlue Swirl				last;
6301ec3f6f9SBlue Swirl			}
6311ec3f6f9SBlue Swirl		}
6321ec3f6f9SBlue Swirl		$off++;
6331ec3f6f9SBlue Swirl	}
6341ec3f6f9SBlue Swirl	# We are truly at the end, so shuffle to the next line.
6351ec3f6f9SBlue Swirl	if ($off == $len) {
6361ec3f6f9SBlue Swirl		$loff = $len + 1;
6371ec3f6f9SBlue Swirl		$line++;
6381ec3f6f9SBlue Swirl		$remain--;
6391ec3f6f9SBlue Swirl	}
6401ec3f6f9SBlue Swirl
6411ec3f6f9SBlue Swirl	my $statement = substr($blk, $soff, $off - $soff + 1);
6421ec3f6f9SBlue Swirl	my $condition = substr($blk, $soff, $coff - $soff + 1);
6431ec3f6f9SBlue Swirl
6441ec3f6f9SBlue Swirl	#warn "STATEMENT<$statement>\n";
6451ec3f6f9SBlue Swirl	#warn "CONDITION<$condition>\n";
6461ec3f6f9SBlue Swirl
6471ec3f6f9SBlue Swirl	#print "coff<$coff> soff<$off> loff<$loff>\n";
6481ec3f6f9SBlue Swirl
6491ec3f6f9SBlue Swirl	return ($statement, $condition,
6501ec3f6f9SBlue Swirl			$line, $remain + 1, $off - $loff + 1, $level);
6511ec3f6f9SBlue Swirl}
6521ec3f6f9SBlue Swirl
6531ec3f6f9SBlue Swirlsub statement_lines {
6541ec3f6f9SBlue Swirl	my ($stmt) = @_;
6551ec3f6f9SBlue Swirl
6561ec3f6f9SBlue Swirl	# Strip the diff line prefixes and rip blank lines at start and end.
6571ec3f6f9SBlue Swirl	$stmt =~ s/(^|\n)./$1/g;
6581ec3f6f9SBlue Swirl	$stmt =~ s/^\s*//;
6591ec3f6f9SBlue Swirl	$stmt =~ s/\s*$//;
6601ec3f6f9SBlue Swirl
6611ec3f6f9SBlue Swirl	my @stmt_lines = ($stmt =~ /\n/g);
6621ec3f6f9SBlue Swirl
6631ec3f6f9SBlue Swirl	return $#stmt_lines + 2;
6641ec3f6f9SBlue Swirl}
6651ec3f6f9SBlue Swirl
6661ec3f6f9SBlue Swirlsub statement_rawlines {
6671ec3f6f9SBlue Swirl	my ($stmt) = @_;
6681ec3f6f9SBlue Swirl
6691ec3f6f9SBlue Swirl	my @stmt_lines = ($stmt =~ /\n/g);
6701ec3f6f9SBlue Swirl
6711ec3f6f9SBlue Swirl	return $#stmt_lines + 2;
6721ec3f6f9SBlue Swirl}
6731ec3f6f9SBlue Swirl
6741ec3f6f9SBlue Swirlsub statement_block_size {
6751ec3f6f9SBlue Swirl	my ($stmt) = @_;
6761ec3f6f9SBlue Swirl
6771ec3f6f9SBlue Swirl	$stmt =~ s/(^|\n)./$1/g;
67804f2562fSFam Zheng	$stmt =~ s/^\s*\{//;
6791ec3f6f9SBlue Swirl	$stmt =~ s/}\s*$//;
6801ec3f6f9SBlue Swirl	$stmt =~ s/^\s*//;
6811ec3f6f9SBlue Swirl	$stmt =~ s/\s*$//;
6821ec3f6f9SBlue Swirl
6831ec3f6f9SBlue Swirl	my @stmt_lines = ($stmt =~ /\n/g);
6841ec3f6f9SBlue Swirl	my @stmt_statements = ($stmt =~ /;/g);
6851ec3f6f9SBlue Swirl
6861ec3f6f9SBlue Swirl	my $stmt_lines = $#stmt_lines + 2;
6871ec3f6f9SBlue Swirl	my $stmt_statements = $#stmt_statements + 1;
6881ec3f6f9SBlue Swirl
6891ec3f6f9SBlue Swirl	if ($stmt_lines > $stmt_statements) {
6901ec3f6f9SBlue Swirl		return $stmt_lines;
6911ec3f6f9SBlue Swirl	} else {
6921ec3f6f9SBlue Swirl		return $stmt_statements;
6931ec3f6f9SBlue Swirl	}
6941ec3f6f9SBlue Swirl}
6951ec3f6f9SBlue Swirl
6961ec3f6f9SBlue Swirlsub ctx_statement_full {
6971ec3f6f9SBlue Swirl	my ($linenr, $remain, $off) = @_;
6981ec3f6f9SBlue Swirl	my ($statement, $condition, $level);
6991ec3f6f9SBlue Swirl
7001ec3f6f9SBlue Swirl	my (@chunks);
7011ec3f6f9SBlue Swirl
7021ec3f6f9SBlue Swirl	# Grab the first conditional/block pair.
7031ec3f6f9SBlue Swirl	($statement, $condition, $linenr, $remain, $off, $level) =
7041ec3f6f9SBlue Swirl				ctx_statement_block($linenr, $remain, $off);
7051ec3f6f9SBlue Swirl	#print "F: c<$condition> s<$statement> remain<$remain>\n";
7061ec3f6f9SBlue Swirl	push(@chunks, [ $condition, $statement ]);
7071ec3f6f9SBlue Swirl	if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
7081ec3f6f9SBlue Swirl		return ($level, $linenr, @chunks);
7091ec3f6f9SBlue Swirl	}
7101ec3f6f9SBlue Swirl
7111ec3f6f9SBlue Swirl	# Pull in the following conditional/block pairs and see if they
7121ec3f6f9SBlue Swirl	# could continue the statement.
7131ec3f6f9SBlue Swirl	for (;;) {
7141ec3f6f9SBlue Swirl		($statement, $condition, $linenr, $remain, $off, $level) =
7151ec3f6f9SBlue Swirl				ctx_statement_block($linenr, $remain, $off);
7161ec3f6f9SBlue Swirl		#print "C: c<$condition> s<$statement> remain<$remain>\n";
7171ec3f6f9SBlue Swirl		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
7181ec3f6f9SBlue Swirl		#print "C: push\n";
7191ec3f6f9SBlue Swirl		push(@chunks, [ $condition, $statement ]);
7201ec3f6f9SBlue Swirl	}
7211ec3f6f9SBlue Swirl
7221ec3f6f9SBlue Swirl	return ($level, $linenr, @chunks);
7231ec3f6f9SBlue Swirl}
7241ec3f6f9SBlue Swirl
7251ec3f6f9SBlue Swirlsub ctx_block_get {
7261ec3f6f9SBlue Swirl	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
7271ec3f6f9SBlue Swirl	my $line;
7281ec3f6f9SBlue Swirl	my $start = $linenr - 1;
7291ec3f6f9SBlue Swirl	my $blk = '';
7301ec3f6f9SBlue Swirl	my @o;
7311ec3f6f9SBlue Swirl	my @c;
7321ec3f6f9SBlue Swirl	my @res = ();
7331ec3f6f9SBlue Swirl
7341ec3f6f9SBlue Swirl	my $level = 0;
7351ec3f6f9SBlue Swirl	my @stack = ($level);
7361ec3f6f9SBlue Swirl	for ($line = $start; $remain > 0; $line++) {
7371ec3f6f9SBlue Swirl		next if ($rawlines[$line] =~ /^-/);
7381ec3f6f9SBlue Swirl		$remain--;
7391ec3f6f9SBlue Swirl
7401ec3f6f9SBlue Swirl		$blk .= $rawlines[$line];
7411ec3f6f9SBlue Swirl
7421ec3f6f9SBlue Swirl		# Handle nested #if/#else.
7431ec3f6f9SBlue Swirl		if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
7441ec3f6f9SBlue Swirl			push(@stack, $level);
7451ec3f6f9SBlue Swirl		} elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
7461ec3f6f9SBlue Swirl			$level = $stack[$#stack - 1];
7471ec3f6f9SBlue Swirl		} elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
7481ec3f6f9SBlue Swirl			$level = pop(@stack);
7491ec3f6f9SBlue Swirl		}
7501ec3f6f9SBlue Swirl
7511ec3f6f9SBlue Swirl		foreach my $c (split(//, $lines[$line])) {
7521ec3f6f9SBlue Swirl			##print "C<$c>L<$level><$open$close>O<$off>\n";
7531ec3f6f9SBlue Swirl			if ($off > 0) {
7541ec3f6f9SBlue Swirl				$off--;
7551ec3f6f9SBlue Swirl				next;
7561ec3f6f9SBlue Swirl			}
7571ec3f6f9SBlue Swirl
7581ec3f6f9SBlue Swirl			if ($c eq $close && $level > 0) {
7591ec3f6f9SBlue Swirl				$level--;
7601ec3f6f9SBlue Swirl				last if ($level == 0);
7611ec3f6f9SBlue Swirl			} elsif ($c eq $open) {
7621ec3f6f9SBlue Swirl				$level++;
7631ec3f6f9SBlue Swirl			}
7641ec3f6f9SBlue Swirl		}
7651ec3f6f9SBlue Swirl
7661ec3f6f9SBlue Swirl		if (!$outer || $level <= 1) {
7671ec3f6f9SBlue Swirl			push(@res, $rawlines[$line]);
7681ec3f6f9SBlue Swirl		}
7691ec3f6f9SBlue Swirl
7701ec3f6f9SBlue Swirl		last if ($level == 0);
7711ec3f6f9SBlue Swirl	}
7721ec3f6f9SBlue Swirl
7731ec3f6f9SBlue Swirl	return ($level, @res);
7741ec3f6f9SBlue Swirl}
7751ec3f6f9SBlue Swirlsub ctx_block_outer {
7761ec3f6f9SBlue Swirl	my ($linenr, $remain) = @_;
7771ec3f6f9SBlue Swirl
7781ec3f6f9SBlue Swirl	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
7791ec3f6f9SBlue Swirl	return @r;
7801ec3f6f9SBlue Swirl}
7811ec3f6f9SBlue Swirlsub ctx_block {
7821ec3f6f9SBlue Swirl	my ($linenr, $remain) = @_;
7831ec3f6f9SBlue Swirl
7841ec3f6f9SBlue Swirl	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
7851ec3f6f9SBlue Swirl	return @r;
7861ec3f6f9SBlue Swirl}
7871ec3f6f9SBlue Swirlsub ctx_statement {
7881ec3f6f9SBlue Swirl	my ($linenr, $remain, $off) = @_;
7891ec3f6f9SBlue Swirl
7901ec3f6f9SBlue Swirl	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
7911ec3f6f9SBlue Swirl	return @r;
7921ec3f6f9SBlue Swirl}
7931ec3f6f9SBlue Swirlsub ctx_block_level {
7941ec3f6f9SBlue Swirl	my ($linenr, $remain) = @_;
7951ec3f6f9SBlue Swirl
7961ec3f6f9SBlue Swirl	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
7971ec3f6f9SBlue Swirl}
7981ec3f6f9SBlue Swirlsub ctx_statement_level {
7991ec3f6f9SBlue Swirl	my ($linenr, $remain, $off) = @_;
8001ec3f6f9SBlue Swirl
8011ec3f6f9SBlue Swirl	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
8021ec3f6f9SBlue Swirl}
8031ec3f6f9SBlue Swirl
8041ec3f6f9SBlue Swirlsub ctx_locate_comment {
8051ec3f6f9SBlue Swirl	my ($first_line, $end_line) = @_;
8061ec3f6f9SBlue Swirl
8071ec3f6f9SBlue Swirl	# Catch a comment on the end of the line itself.
8081ec3f6f9SBlue Swirl	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
8091ec3f6f9SBlue Swirl	return $current_comment if (defined $current_comment);
8101ec3f6f9SBlue Swirl
8111ec3f6f9SBlue Swirl	# Look through the context and try and figure out if there is a
8121ec3f6f9SBlue Swirl	# comment.
8131ec3f6f9SBlue Swirl	my $in_comment = 0;
8141ec3f6f9SBlue Swirl	$current_comment = '';
8151ec3f6f9SBlue Swirl	for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
8161ec3f6f9SBlue Swirl		my $line = $rawlines[$linenr - 1];
8171ec3f6f9SBlue Swirl		#warn "           $line\n";
8181ec3f6f9SBlue Swirl		if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
8191ec3f6f9SBlue Swirl			$in_comment = 1;
8201ec3f6f9SBlue Swirl		}
8211ec3f6f9SBlue Swirl		if ($line =~ m@/\*@) {
8221ec3f6f9SBlue Swirl			$in_comment = 1;
8231ec3f6f9SBlue Swirl		}
8241ec3f6f9SBlue Swirl		if (!$in_comment && $current_comment ne '') {
8251ec3f6f9SBlue Swirl			$current_comment = '';
8261ec3f6f9SBlue Swirl		}
8271ec3f6f9SBlue Swirl		$current_comment .= $line . "\n" if ($in_comment);
8281ec3f6f9SBlue Swirl		if ($line =~ m@\*/@) {
8291ec3f6f9SBlue Swirl			$in_comment = 0;
8301ec3f6f9SBlue Swirl		}
8311ec3f6f9SBlue Swirl	}
8321ec3f6f9SBlue Swirl
8331ec3f6f9SBlue Swirl	chomp($current_comment);
8341ec3f6f9SBlue Swirl	return($current_comment);
8351ec3f6f9SBlue Swirl}
8361ec3f6f9SBlue Swirlsub ctx_has_comment {
8371ec3f6f9SBlue Swirl	my ($first_line, $end_line) = @_;
8381ec3f6f9SBlue Swirl	my $cmt = ctx_locate_comment($first_line, $end_line);
8391ec3f6f9SBlue Swirl
8401ec3f6f9SBlue Swirl	##print "LINE: $rawlines[$end_line - 1 ]\n";
8411ec3f6f9SBlue Swirl	##print "CMMT: $cmt\n";
8421ec3f6f9SBlue Swirl
8431ec3f6f9SBlue Swirl	return ($cmt ne '');
8441ec3f6f9SBlue Swirl}
8451ec3f6f9SBlue Swirl
8461ec3f6f9SBlue Swirlsub raw_line {
8471ec3f6f9SBlue Swirl	my ($linenr, $cnt) = @_;
8481ec3f6f9SBlue Swirl
8491ec3f6f9SBlue Swirl	my $offset = $linenr - 1;
8501ec3f6f9SBlue Swirl	$cnt++;
8511ec3f6f9SBlue Swirl
8521ec3f6f9SBlue Swirl	my $line;
8531ec3f6f9SBlue Swirl	while ($cnt) {
8541ec3f6f9SBlue Swirl		$line = $rawlines[$offset++];
8551ec3f6f9SBlue Swirl		next if (defined($line) && $line =~ /^-/);
8561ec3f6f9SBlue Swirl		$cnt--;
8571ec3f6f9SBlue Swirl	}
8581ec3f6f9SBlue Swirl
8591ec3f6f9SBlue Swirl	return $line;
8601ec3f6f9SBlue Swirl}
8611ec3f6f9SBlue Swirl
8621ec3f6f9SBlue Swirlsub cat_vet {
8631ec3f6f9SBlue Swirl	my ($vet) = @_;
8641ec3f6f9SBlue Swirl	my ($res, $coded);
8651ec3f6f9SBlue Swirl
8661ec3f6f9SBlue Swirl	$res = '';
8671ec3f6f9SBlue Swirl	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
8681ec3f6f9SBlue Swirl		$res .= $1;
8691ec3f6f9SBlue Swirl		if ($2 ne '') {
8701ec3f6f9SBlue Swirl			$coded = sprintf("^%c", unpack('C', $2) + 64);
8711ec3f6f9SBlue Swirl			$res .= $coded;
8721ec3f6f9SBlue Swirl		}
8731ec3f6f9SBlue Swirl	}
8741ec3f6f9SBlue Swirl	$res =~ s/$/\$/;
8751ec3f6f9SBlue Swirl
8761ec3f6f9SBlue Swirl	return $res;
8771ec3f6f9SBlue Swirl}
8781ec3f6f9SBlue Swirl
8791ec3f6f9SBlue Swirlmy $av_preprocessor = 0;
8801ec3f6f9SBlue Swirlmy $av_pending;
8811ec3f6f9SBlue Swirlmy @av_paren_type;
8821ec3f6f9SBlue Swirlmy $av_pend_colon;
8831ec3f6f9SBlue Swirl
8841ec3f6f9SBlue Swirlsub annotate_reset {
8851ec3f6f9SBlue Swirl	$av_preprocessor = 0;
8861ec3f6f9SBlue Swirl	$av_pending = '_';
8871ec3f6f9SBlue Swirl	@av_paren_type = ('E');
8881ec3f6f9SBlue Swirl	$av_pend_colon = 'O';
8891ec3f6f9SBlue Swirl}
8901ec3f6f9SBlue Swirl
8911ec3f6f9SBlue Swirlsub annotate_values {
8921ec3f6f9SBlue Swirl	my ($stream, $type) = @_;
8931ec3f6f9SBlue Swirl
8941ec3f6f9SBlue Swirl	my $res;
8951ec3f6f9SBlue Swirl	my $var = '_' x length($stream);
8961ec3f6f9SBlue Swirl	my $cur = $stream;
8971ec3f6f9SBlue Swirl
8981ec3f6f9SBlue Swirl	print "$stream\n" if ($dbg_values > 1);
8991ec3f6f9SBlue Swirl
9001ec3f6f9SBlue Swirl	while (length($cur)) {
9011ec3f6f9SBlue Swirl		@av_paren_type = ('E') if ($#av_paren_type < 0);
9021ec3f6f9SBlue Swirl		print " <" . join('', @av_paren_type) .
9031ec3f6f9SBlue Swirl				"> <$type> <$av_pending>" if ($dbg_values > 1);
9041ec3f6f9SBlue Swirl		if ($cur =~ /^(\s+)/o) {
9051ec3f6f9SBlue Swirl			print "WS($1)\n" if ($dbg_values > 1);
9061ec3f6f9SBlue Swirl			if ($1 =~ /\n/ && $av_preprocessor) {
9071ec3f6f9SBlue Swirl				$type = pop(@av_paren_type);
9081ec3f6f9SBlue Swirl				$av_preprocessor = 0;
9091ec3f6f9SBlue Swirl			}
9101ec3f6f9SBlue Swirl
91161669f9aSFlorian Mickler		} elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
9121ec3f6f9SBlue Swirl			print "CAST($1)\n" if ($dbg_values > 1);
9131ec3f6f9SBlue Swirl			push(@av_paren_type, $type);
9141ec3f6f9SBlue Swirl			$type = 'C';
9151ec3f6f9SBlue Swirl
9161ec3f6f9SBlue Swirl		} elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
9171ec3f6f9SBlue Swirl			print "DECLARE($1)\n" if ($dbg_values > 1);
9181ec3f6f9SBlue Swirl			$type = 'T';
9191ec3f6f9SBlue Swirl
9201ec3f6f9SBlue Swirl		} elsif ($cur =~ /^($Modifier)\s*/) {
9211ec3f6f9SBlue Swirl			print "MODIFIER($1)\n" if ($dbg_values > 1);
9221ec3f6f9SBlue Swirl			$type = 'T';
9231ec3f6f9SBlue Swirl
9241ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
9251ec3f6f9SBlue Swirl			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
9261ec3f6f9SBlue Swirl			$av_preprocessor = 1;
9271ec3f6f9SBlue Swirl			push(@av_paren_type, $type);
9281ec3f6f9SBlue Swirl			if ($2 ne '') {
9291ec3f6f9SBlue Swirl				$av_pending = 'N';
9301ec3f6f9SBlue Swirl			}
9311ec3f6f9SBlue Swirl			$type = 'E';
9321ec3f6f9SBlue Swirl
9331ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
9341ec3f6f9SBlue Swirl			print "UNDEF($1)\n" if ($dbg_values > 1);
9351ec3f6f9SBlue Swirl			$av_preprocessor = 1;
9361ec3f6f9SBlue Swirl			push(@av_paren_type, $type);
9371ec3f6f9SBlue Swirl
9381ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
9391ec3f6f9SBlue Swirl			print "PRE_START($1)\n" if ($dbg_values > 1);
9401ec3f6f9SBlue Swirl			$av_preprocessor = 1;
9411ec3f6f9SBlue Swirl
9421ec3f6f9SBlue Swirl			push(@av_paren_type, $type);
9431ec3f6f9SBlue Swirl			push(@av_paren_type, $type);
9441ec3f6f9SBlue Swirl			$type = 'E';
9451ec3f6f9SBlue Swirl
9461ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
9471ec3f6f9SBlue Swirl			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
9481ec3f6f9SBlue Swirl			$av_preprocessor = 1;
9491ec3f6f9SBlue Swirl
9501ec3f6f9SBlue Swirl			push(@av_paren_type, $av_paren_type[$#av_paren_type]);
9511ec3f6f9SBlue Swirl
9521ec3f6f9SBlue Swirl			$type = 'E';
9531ec3f6f9SBlue Swirl
9541ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
9551ec3f6f9SBlue Swirl			print "PRE_END($1)\n" if ($dbg_values > 1);
9561ec3f6f9SBlue Swirl
9571ec3f6f9SBlue Swirl			$av_preprocessor = 1;
9581ec3f6f9SBlue Swirl
9591ec3f6f9SBlue Swirl			# Assume all arms of the conditional end as this
9601ec3f6f9SBlue Swirl			# one does, and continue as if the #endif was not here.
9611ec3f6f9SBlue Swirl			pop(@av_paren_type);
9621ec3f6f9SBlue Swirl			push(@av_paren_type, $type);
9631ec3f6f9SBlue Swirl			$type = 'E';
9641ec3f6f9SBlue Swirl
9651ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(\\\n)/o) {
9661ec3f6f9SBlue Swirl			print "PRECONT($1)\n" if ($dbg_values > 1);
9671ec3f6f9SBlue Swirl
9681ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
9691ec3f6f9SBlue Swirl			print "ATTR($1)\n" if ($dbg_values > 1);
9701ec3f6f9SBlue Swirl			$av_pending = $type;
9711ec3f6f9SBlue Swirl			$type = 'N';
9721ec3f6f9SBlue Swirl
9731ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
9741ec3f6f9SBlue Swirl			print "SIZEOF($1)\n" if ($dbg_values > 1);
9751ec3f6f9SBlue Swirl			if (defined $2) {
9761ec3f6f9SBlue Swirl				$av_pending = 'V';
9771ec3f6f9SBlue Swirl			}
9781ec3f6f9SBlue Swirl			$type = 'N';
9791ec3f6f9SBlue Swirl
9801ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(if|while|for)\b/o) {
9811ec3f6f9SBlue Swirl			print "COND($1)\n" if ($dbg_values > 1);
9821ec3f6f9SBlue Swirl			$av_pending = 'E';
9831ec3f6f9SBlue Swirl			$type = 'N';
9841ec3f6f9SBlue Swirl
9851ec3f6f9SBlue Swirl		} elsif ($cur =~/^(case)/o) {
9861ec3f6f9SBlue Swirl			print "CASE($1)\n" if ($dbg_values > 1);
9871ec3f6f9SBlue Swirl			$av_pend_colon = 'C';
9881ec3f6f9SBlue Swirl			$type = 'N';
9891ec3f6f9SBlue Swirl
9901ec3f6f9SBlue Swirl		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
9911ec3f6f9SBlue Swirl			print "KEYWORD($1)\n" if ($dbg_values > 1);
9921ec3f6f9SBlue Swirl			$type = 'N';
9931ec3f6f9SBlue Swirl
9941ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(\()/o) {
9951ec3f6f9SBlue Swirl			print "PAREN('$1')\n" if ($dbg_values > 1);
9961ec3f6f9SBlue Swirl			push(@av_paren_type, $av_pending);
9971ec3f6f9SBlue Swirl			$av_pending = '_';
9981ec3f6f9SBlue Swirl			$type = 'N';
9991ec3f6f9SBlue Swirl
10001ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(\))/o) {
10011ec3f6f9SBlue Swirl			my $new_type = pop(@av_paren_type);
10021ec3f6f9SBlue Swirl			if ($new_type ne '_') {
10031ec3f6f9SBlue Swirl				$type = $new_type;
10041ec3f6f9SBlue Swirl				print "PAREN('$1') -> $type\n"
10051ec3f6f9SBlue Swirl							if ($dbg_values > 1);
10061ec3f6f9SBlue Swirl			} else {
10071ec3f6f9SBlue Swirl				print "PAREN('$1')\n" if ($dbg_values > 1);
10081ec3f6f9SBlue Swirl			}
10091ec3f6f9SBlue Swirl
10101ec3f6f9SBlue Swirl		} elsif ($cur =~ /^($Ident)\s*\(/o) {
10111ec3f6f9SBlue Swirl			print "FUNC($1)\n" if ($dbg_values > 1);
10121ec3f6f9SBlue Swirl			$type = 'V';
10131ec3f6f9SBlue Swirl			$av_pending = 'V';
10141ec3f6f9SBlue Swirl
10151ec3f6f9SBlue Swirl		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
10161ec3f6f9SBlue Swirl			if (defined $2 && $type eq 'C' || $type eq 'T') {
10171ec3f6f9SBlue Swirl				$av_pend_colon = 'B';
10181ec3f6f9SBlue Swirl			} elsif ($type eq 'E') {
10191ec3f6f9SBlue Swirl				$av_pend_colon = 'L';
10201ec3f6f9SBlue Swirl			}
10211ec3f6f9SBlue Swirl			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
10221ec3f6f9SBlue Swirl			$type = 'V';
10231ec3f6f9SBlue Swirl
10241ec3f6f9SBlue Swirl		} elsif ($cur =~ /^($Ident|$Constant)/o) {
10251ec3f6f9SBlue Swirl			print "IDENT($1)\n" if ($dbg_values > 1);
10261ec3f6f9SBlue Swirl			$type = 'V';
10271ec3f6f9SBlue Swirl
10281ec3f6f9SBlue Swirl		} elsif ($cur =~ /^($Assignment)/o) {
10291ec3f6f9SBlue Swirl			print "ASSIGN($1)\n" if ($dbg_values > 1);
10301ec3f6f9SBlue Swirl			$type = 'N';
10311ec3f6f9SBlue Swirl
10321ec3f6f9SBlue Swirl		} elsif ($cur =~/^(;|{|})/) {
10331ec3f6f9SBlue Swirl			print "END($1)\n" if ($dbg_values > 1);
10341ec3f6f9SBlue Swirl			$type = 'E';
10351ec3f6f9SBlue Swirl			$av_pend_colon = 'O';
10361ec3f6f9SBlue Swirl
10371ec3f6f9SBlue Swirl		} elsif ($cur =~/^(,)/) {
10381ec3f6f9SBlue Swirl			print "COMMA($1)\n" if ($dbg_values > 1);
10391ec3f6f9SBlue Swirl			$type = 'C';
10401ec3f6f9SBlue Swirl
10411ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(\?)/o) {
10421ec3f6f9SBlue Swirl			print "QUESTION($1)\n" if ($dbg_values > 1);
10431ec3f6f9SBlue Swirl			$type = 'N';
10441ec3f6f9SBlue Swirl
10451ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(:)/o) {
10461ec3f6f9SBlue Swirl			print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
10471ec3f6f9SBlue Swirl
10481ec3f6f9SBlue Swirl			substr($var, length($res), 1, $av_pend_colon);
10491ec3f6f9SBlue Swirl			if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
10501ec3f6f9SBlue Swirl				$type = 'E';
10511ec3f6f9SBlue Swirl			} else {
10521ec3f6f9SBlue Swirl				$type = 'N';
10531ec3f6f9SBlue Swirl			}
10541ec3f6f9SBlue Swirl			$av_pend_colon = 'O';
10551ec3f6f9SBlue Swirl
10561ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(\[)/o) {
10571ec3f6f9SBlue Swirl			print "CLOSE($1)\n" if ($dbg_values > 1);
10581ec3f6f9SBlue Swirl			$type = 'N';
10591ec3f6f9SBlue Swirl
10601ec3f6f9SBlue Swirl		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
10611ec3f6f9SBlue Swirl			my $variant;
10621ec3f6f9SBlue Swirl
10631ec3f6f9SBlue Swirl			print "OPV($1)\n" if ($dbg_values > 1);
10641ec3f6f9SBlue Swirl			if ($type eq 'V') {
10651ec3f6f9SBlue Swirl				$variant = 'B';
10661ec3f6f9SBlue Swirl			} else {
10671ec3f6f9SBlue Swirl				$variant = 'U';
10681ec3f6f9SBlue Swirl			}
10691ec3f6f9SBlue Swirl
10701ec3f6f9SBlue Swirl			substr($var, length($res), 1, $variant);
10711ec3f6f9SBlue Swirl			$type = 'N';
10721ec3f6f9SBlue Swirl
10731ec3f6f9SBlue Swirl		} elsif ($cur =~ /^($Operators)/o) {
10741ec3f6f9SBlue Swirl			print "OP($1)\n" if ($dbg_values > 1);
10751ec3f6f9SBlue Swirl			if ($1 ne '++' && $1 ne '--') {
10761ec3f6f9SBlue Swirl				$type = 'N';
10771ec3f6f9SBlue Swirl			}
10781ec3f6f9SBlue Swirl
10791ec3f6f9SBlue Swirl		} elsif ($cur =~ /(^.)/o) {
10801ec3f6f9SBlue Swirl			print "C($1)\n" if ($dbg_values > 1);
10811ec3f6f9SBlue Swirl		}
10821ec3f6f9SBlue Swirl		if (defined $1) {
10831ec3f6f9SBlue Swirl			$cur = substr($cur, length($1));
10841ec3f6f9SBlue Swirl			$res .= $type x length($1);
10851ec3f6f9SBlue Swirl		}
10861ec3f6f9SBlue Swirl	}
10871ec3f6f9SBlue Swirl
10881ec3f6f9SBlue Swirl	return ($res, $var);
10891ec3f6f9SBlue Swirl}
10901ec3f6f9SBlue Swirl
10911ec3f6f9SBlue Swirlsub possible {
10921ec3f6f9SBlue Swirl	my ($possible, $line) = @_;
10931ec3f6f9SBlue Swirl	my $notPermitted = qr{(?:
10941ec3f6f9SBlue Swirl		^(?:
10951ec3f6f9SBlue Swirl			$Modifier|
10961ec3f6f9SBlue Swirl			$Storage|
10971ec3f6f9SBlue Swirl			$Type|
10981ec3f6f9SBlue Swirl			DEFINE_\S+
10991ec3f6f9SBlue Swirl		)$|
11001ec3f6f9SBlue Swirl		^(?:
11011ec3f6f9SBlue Swirl			goto|
11021ec3f6f9SBlue Swirl			return|
11031ec3f6f9SBlue Swirl			case|
11041ec3f6f9SBlue Swirl			else|
11051ec3f6f9SBlue Swirl			asm|__asm__|
11063e5385fcSAndy Whitcroft			do|
11073e5385fcSAndy Whitcroft			\#|
11083e5385fcSAndy Whitcroft			\#\#
11091ec3f6f9SBlue Swirl		)(?:\s|$)|
11101ec3f6f9SBlue Swirl		^(?:typedef|struct|enum)\b
11111ec3f6f9SBlue Swirl	    )}x;
11121ec3f6f9SBlue Swirl	warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
11131ec3f6f9SBlue Swirl	if ($possible !~ $notPermitted) {
11141ec3f6f9SBlue Swirl		# Check for modifiers.
11151ec3f6f9SBlue Swirl		$possible =~ s/\s*$Storage\s*//g;
11161ec3f6f9SBlue Swirl		$possible =~ s/\s*$Sparse\s*//g;
11171ec3f6f9SBlue Swirl		if ($possible =~ /^\s*$/) {
11181ec3f6f9SBlue Swirl
11191ec3f6f9SBlue Swirl		} elsif ($possible =~ /\s/) {
11201ec3f6f9SBlue Swirl			$possible =~ s/\s*$Type\s*//g;
11211ec3f6f9SBlue Swirl			for my $modifier (split(' ', $possible)) {
11221ec3f6f9SBlue Swirl				if ($modifier !~ $notPermitted) {
11231ec3f6f9SBlue Swirl					warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
11241ec3f6f9SBlue Swirl					push(@modifierList, $modifier);
11251ec3f6f9SBlue Swirl				}
11261ec3f6f9SBlue Swirl			}
11271ec3f6f9SBlue Swirl
11281ec3f6f9SBlue Swirl		} else {
11291ec3f6f9SBlue Swirl			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
11301ec3f6f9SBlue Swirl			push(@typeList, $possible);
11311ec3f6f9SBlue Swirl		}
11321ec3f6f9SBlue Swirl		build_types();
11331ec3f6f9SBlue Swirl	} else {
11341ec3f6f9SBlue Swirl		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
11351ec3f6f9SBlue Swirl	}
11361ec3f6f9SBlue Swirl}
11371ec3f6f9SBlue Swirl
11381ec3f6f9SBlue Swirlmy $prefix = '';
11391ec3f6f9SBlue Swirl
11401ec3f6f9SBlue Swirlsub report {
11411ec3f6f9SBlue Swirl	if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
11421ec3f6f9SBlue Swirl		return 0;
11431ec3f6f9SBlue Swirl	}
11441ec3f6f9SBlue Swirl	my $line = $prefix . $_[0];
11451ec3f6f9SBlue Swirl
11461ec3f6f9SBlue Swirl	$line = (split('\n', $line))[0] . "\n" if ($terse);
11471ec3f6f9SBlue Swirl
11481ec3f6f9SBlue Swirl	push(our @report, $line);
11491ec3f6f9SBlue Swirl
11501ec3f6f9SBlue Swirl	return 1;
11511ec3f6f9SBlue Swirl}
11521ec3f6f9SBlue Swirlsub report_dump {
11531ec3f6f9SBlue Swirl	our @report;
11541ec3f6f9SBlue Swirl}
11551ec3f6f9SBlue Swirlsub ERROR {
11561ec3f6f9SBlue Swirl	if (report("ERROR: $_[0]\n")) {
11571ec3f6f9SBlue Swirl		our $clean = 0;
11581ec3f6f9SBlue Swirl		our $cnt_error++;
11591ec3f6f9SBlue Swirl	}
11601ec3f6f9SBlue Swirl}
11611ec3f6f9SBlue Swirlsub WARN {
11621ec3f6f9SBlue Swirl	if (report("WARNING: $_[0]\n")) {
11631ec3f6f9SBlue Swirl		our $clean = 0;
11641ec3f6f9SBlue Swirl		our $cnt_warn++;
11651ec3f6f9SBlue Swirl	}
11661ec3f6f9SBlue Swirl}
11671ec3f6f9SBlue Swirl
11681ec3f6f9SBlue Swirlsub process {
11691ec3f6f9SBlue Swirl	my $filename = shift;
11701ec3f6f9SBlue Swirl
11711ec3f6f9SBlue Swirl	my $linenr=0;
11721ec3f6f9SBlue Swirl	my $prevline="";
11731ec3f6f9SBlue Swirl	my $prevrawline="";
11741ec3f6f9SBlue Swirl	my $stashline="";
11751ec3f6f9SBlue Swirl	my $stashrawline="";
11761ec3f6f9SBlue Swirl
11771ec3f6f9SBlue Swirl	my $length;
11781ec3f6f9SBlue Swirl	my $indent;
11791ec3f6f9SBlue Swirl	my $previndent=0;
11801ec3f6f9SBlue Swirl	my $stashindent=0;
11811ec3f6f9SBlue Swirl
11821ec3f6f9SBlue Swirl	our $clean = 1;
11831ec3f6f9SBlue Swirl	my $signoff = 0;
11841ec3f6f9SBlue Swirl	my $is_patch = 0;
11851ec3f6f9SBlue Swirl
11865fc7e404SJoe Perches	my $in_header_lines = $file ? 0 : 1;
1187b37c4aacSJoe Perches	my $in_commit_log = 0;		#Scanning lines before patch
11884be6131eSJoe Perches	my $reported_maintainer_file = 0;
1189bf139a06SPasi Savanainen	my $non_utf8_charset = 0;
1190bf139a06SPasi Savanainen
11911ec3f6f9SBlue Swirl	our @report = ();
11921ec3f6f9SBlue Swirl	our $cnt_lines = 0;
11931ec3f6f9SBlue Swirl	our $cnt_error = 0;
11941ec3f6f9SBlue Swirl	our $cnt_warn = 0;
11951ec3f6f9SBlue Swirl	our $cnt_chk = 0;
11961ec3f6f9SBlue Swirl
11971ec3f6f9SBlue Swirl	# Trace the real file/line as we go.
11981ec3f6f9SBlue Swirl	my $realfile = '';
11991ec3f6f9SBlue Swirl	my $realline = 0;
12001ec3f6f9SBlue Swirl	my $realcnt = 0;
12011ec3f6f9SBlue Swirl	my $here = '';
12021ec3f6f9SBlue Swirl	my $in_comment = 0;
12031ec3f6f9SBlue Swirl	my $comment_edge = 0;
12041ec3f6f9SBlue Swirl	my $first_line = 0;
12051ec3f6f9SBlue Swirl	my $p1_prefix = '';
12061ec3f6f9SBlue Swirl
12071ec3f6f9SBlue Swirl	my $prev_values = 'E';
12081ec3f6f9SBlue Swirl
12091ec3f6f9SBlue Swirl	# suppression flags
12101ec3f6f9SBlue Swirl	my %suppress_ifbraces;
12111ec3f6f9SBlue Swirl	my %suppress_whiletrailers;
12121ec3f6f9SBlue Swirl	my %suppress_export;
12131ec3f6f9SBlue Swirl
12141ec3f6f9SBlue Swirl	# Pre-scan the patch sanitizing the lines.
12151ec3f6f9SBlue Swirl
12161ec3f6f9SBlue Swirl	sanitise_line_reset();
12171ec3f6f9SBlue Swirl	my $line;
12181ec3f6f9SBlue Swirl	foreach my $rawline (@rawlines) {
12191ec3f6f9SBlue Swirl		$linenr++;
12201ec3f6f9SBlue Swirl		$line = $rawline;
12211ec3f6f9SBlue Swirl
12221ec3f6f9SBlue Swirl		if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
12231ec3f6f9SBlue Swirl			$realline=$1-1;
12241ec3f6f9SBlue Swirl			if (defined $2) {
12251ec3f6f9SBlue Swirl				$realcnt=$3+1;
12261ec3f6f9SBlue Swirl			} else {
12271ec3f6f9SBlue Swirl				$realcnt=1+1;
12281ec3f6f9SBlue Swirl			}
12291ec3f6f9SBlue Swirl			$in_comment = 0;
12301ec3f6f9SBlue Swirl
12311ec3f6f9SBlue Swirl			# Guestimate if this is a continuing comment.  Run
12321ec3f6f9SBlue Swirl			# the context looking for a comment "edge".  If this
12331ec3f6f9SBlue Swirl			# edge is a close comment then we must be in a comment
12341ec3f6f9SBlue Swirl			# at context start.
12351ec3f6f9SBlue Swirl			my $edge;
12361ec3f6f9SBlue Swirl			my $cnt = $realcnt;
12371ec3f6f9SBlue Swirl			for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
12381ec3f6f9SBlue Swirl				next if (defined $rawlines[$ln - 1] &&
12391ec3f6f9SBlue Swirl					 $rawlines[$ln - 1] =~ /^-/);
12401ec3f6f9SBlue Swirl				$cnt--;
12411ec3f6f9SBlue Swirl				#print "RAW<$rawlines[$ln - 1]>\n";
12421ec3f6f9SBlue Swirl				last if (!defined $rawlines[$ln - 1]);
12431ec3f6f9SBlue Swirl				if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
12441ec3f6f9SBlue Swirl				    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
12451ec3f6f9SBlue Swirl					($edge) = $1;
12461ec3f6f9SBlue Swirl					last;
12471ec3f6f9SBlue Swirl				}
12481ec3f6f9SBlue Swirl			}
12491ec3f6f9SBlue Swirl			if (defined $edge && $edge eq '*/') {
12501ec3f6f9SBlue Swirl				$in_comment = 1;
12511ec3f6f9SBlue Swirl			}
12521ec3f6f9SBlue Swirl
12531ec3f6f9SBlue Swirl			# Guestimate if this is a continuing comment.  If this
12541ec3f6f9SBlue Swirl			# is the start of a diff block and this line starts
12551ec3f6f9SBlue Swirl			# ' *' then it is very likely a comment.
12561ec3f6f9SBlue Swirl			if (!defined $edge &&
12571ec3f6f9SBlue Swirl			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
12581ec3f6f9SBlue Swirl			{
12591ec3f6f9SBlue Swirl				$in_comment = 1;
12601ec3f6f9SBlue Swirl			}
12611ec3f6f9SBlue Swirl
12621ec3f6f9SBlue Swirl			##print "COMMENT:$in_comment edge<$edge> $rawline\n";
12631ec3f6f9SBlue Swirl			sanitise_line_reset($in_comment);
12641ec3f6f9SBlue Swirl
12651ec3f6f9SBlue Swirl		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
12661ec3f6f9SBlue Swirl			# Standardise the strings and chars within the input to
12671ec3f6f9SBlue Swirl			# simplify matching -- only bother with positive lines.
12681ec3f6f9SBlue Swirl			$line = sanitise_line($rawline);
12691ec3f6f9SBlue Swirl		}
12701ec3f6f9SBlue Swirl		push(@lines, $line);
12711ec3f6f9SBlue Swirl
12721ec3f6f9SBlue Swirl		if ($realcnt > 1) {
12731ec3f6f9SBlue Swirl			$realcnt-- if ($line =~ /^(?:\+| |$)/);
12741ec3f6f9SBlue Swirl		} else {
12751ec3f6f9SBlue Swirl			$realcnt = 0;
12761ec3f6f9SBlue Swirl		}
12771ec3f6f9SBlue Swirl
12781ec3f6f9SBlue Swirl		#print "==>$rawline\n";
12791ec3f6f9SBlue Swirl		#print "-->$line\n";
12801ec3f6f9SBlue Swirl	}
12811ec3f6f9SBlue Swirl
12821ec3f6f9SBlue Swirl	$prefix = '';
12831ec3f6f9SBlue Swirl
12841ec3f6f9SBlue Swirl	$realcnt = 0;
12851ec3f6f9SBlue Swirl	$linenr = 0;
12861ec3f6f9SBlue Swirl	foreach my $line (@lines) {
12871ec3f6f9SBlue Swirl		$linenr++;
12881ec3f6f9SBlue Swirl
12891ec3f6f9SBlue Swirl		my $rawline = $rawlines[$linenr - 1];
12901ec3f6f9SBlue Swirl
12911ec3f6f9SBlue Swirl#extract the line range in the file after the patch is applied
12921ec3f6f9SBlue Swirl		if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
12931ec3f6f9SBlue Swirl			$is_patch = 1;
12941ec3f6f9SBlue Swirl			$first_line = $linenr + 1;
12951ec3f6f9SBlue Swirl			$realline=$1-1;
12961ec3f6f9SBlue Swirl			if (defined $2) {
12971ec3f6f9SBlue Swirl				$realcnt=$3+1;
12981ec3f6f9SBlue Swirl			} else {
12991ec3f6f9SBlue Swirl				$realcnt=1+1;
13001ec3f6f9SBlue Swirl			}
13011ec3f6f9SBlue Swirl			annotate_reset();
13021ec3f6f9SBlue Swirl			$prev_values = 'E';
13031ec3f6f9SBlue Swirl
13041ec3f6f9SBlue Swirl			%suppress_ifbraces = ();
13051ec3f6f9SBlue Swirl			%suppress_whiletrailers = ();
13061ec3f6f9SBlue Swirl			%suppress_export = ();
13071ec3f6f9SBlue Swirl			next;
13081ec3f6f9SBlue Swirl
13091ec3f6f9SBlue Swirl# track the line number as we move through the hunk, note that
13101ec3f6f9SBlue Swirl# new versions of GNU diff omit the leading space on completely
13111ec3f6f9SBlue Swirl# blank context lines so we need to count that too.
13121ec3f6f9SBlue Swirl		} elsif ($line =~ /^( |\+|$)/) {
13131ec3f6f9SBlue Swirl			$realline++;
13141ec3f6f9SBlue Swirl			$realcnt-- if ($realcnt != 0);
13151ec3f6f9SBlue Swirl
13161ec3f6f9SBlue Swirl			# Measure the line length and indent.
13171ec3f6f9SBlue Swirl			($length, $indent) = line_stats($rawline);
13181ec3f6f9SBlue Swirl
13191ec3f6f9SBlue Swirl			# Track the previous line.
13201ec3f6f9SBlue Swirl			($prevline, $stashline) = ($stashline, $line);
13211ec3f6f9SBlue Swirl			($previndent, $stashindent) = ($stashindent, $indent);
13221ec3f6f9SBlue Swirl			($prevrawline, $stashrawline) = ($stashrawline, $rawline);
13231ec3f6f9SBlue Swirl
13241ec3f6f9SBlue Swirl			#warn "line<$line>\n";
13251ec3f6f9SBlue Swirl
13261ec3f6f9SBlue Swirl		} elsif ($realcnt == 1) {
13271ec3f6f9SBlue Swirl			$realcnt--;
13281ec3f6f9SBlue Swirl		}
13291ec3f6f9SBlue Swirl
13301ec3f6f9SBlue Swirl		my $hunk_line = ($realcnt != 0);
13311ec3f6f9SBlue Swirl
13321ec3f6f9SBlue Swirl#make up the handle for any error we report on this line
13331ec3f6f9SBlue Swirl		$prefix = "$filename:$realline: " if ($emacs && $file);
13341ec3f6f9SBlue Swirl		$prefix = "$filename:$linenr: " if ($emacs && !$file);
13351ec3f6f9SBlue Swirl
13361ec3f6f9SBlue Swirl		$here = "#$linenr: " if (!$file);
13371ec3f6f9SBlue Swirl		$here = "#$realline: " if ($file);
13381ec3f6f9SBlue Swirl
13391ec3f6f9SBlue Swirl		# extract the filename as it passes
13401ec3f6f9SBlue Swirl		if ($line =~ /^diff --git.*?(\S+)$/) {
13411ec3f6f9SBlue Swirl			$realfile = $1;
13421ec3f6f9SBlue Swirl			$realfile =~ s@^([^/]*)/@@;
13431ec3f6f9SBlue Swirl		} elsif ($line =~ /^\+\+\+\s+(\S+)/) {
13441ec3f6f9SBlue Swirl			$realfile = $1;
13451ec3f6f9SBlue Swirl			$realfile =~ s@^([^/]*)/@@;
13461ec3f6f9SBlue Swirl
13471ec3f6f9SBlue Swirl			$p1_prefix = $1;
13481ec3f6f9SBlue Swirl			if (!$file && $tree && $p1_prefix ne '' &&
13491ec3f6f9SBlue Swirl			    -e "$root/$p1_prefix") {
13501ec3f6f9SBlue Swirl				WARN("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
13511ec3f6f9SBlue Swirl			}
13521ec3f6f9SBlue Swirl
13531ec3f6f9SBlue Swirl			next;
13541ec3f6f9SBlue Swirl		}
13551ec3f6f9SBlue Swirl
13561ec3f6f9SBlue Swirl		$here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
13571ec3f6f9SBlue Swirl
13581ec3f6f9SBlue Swirl		my $hereline = "$here\n$rawline\n";
13591ec3f6f9SBlue Swirl		my $herecurr = "$here\n$rawline\n";
13601ec3f6f9SBlue Swirl		my $hereprev = "$here\n$prevrawline\n$rawline\n";
13611ec3f6f9SBlue Swirl
13621ec3f6f9SBlue Swirl		$cnt_lines++ if ($realcnt != 0);
13631ec3f6f9SBlue Swirl
13641ec3f6f9SBlue Swirl# Check for incorrect file permissions
13651ec3f6f9SBlue Swirl		if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
13661ec3f6f9SBlue Swirl			my $permhere = $here . "FILE: $realfile\n";
136771c47b01SPaolo Bonzini			if ($realfile =~ /(\bMakefile(?:\.objs)?|\.c|\.cc|\.cpp|\.h|\.mak|\.[sS])$/) {
13681ec3f6f9SBlue Swirl				ERROR("do not set execute permissions for source files\n" . $permhere);
13691ec3f6f9SBlue Swirl			}
13701ec3f6f9SBlue Swirl		}
13711ec3f6f9SBlue Swirl
1372f8dccbb6SStefan Hajnoczi# Accept git diff extended headers as valid patches
1373f8dccbb6SStefan Hajnoczi		if ($line =~ /^(?:rename|copy) (?:from|to) [\w\/\.\-]+\s*$/) {
1374f8dccbb6SStefan Hajnoczi			$is_patch = 1;
1375f8dccbb6SStefan Hajnoczi		}
1376f8dccbb6SStefan Hajnoczi
13771ec3f6f9SBlue Swirl#check the patch for a signoff:
13781ec3f6f9SBlue Swirl		if ($line =~ /^\s*signed-off-by:/i) {
13791ec3f6f9SBlue Swirl			# This is a signoff, if ugly, so do not double report.
13801ec3f6f9SBlue Swirl			$signoff++;
1381b37c4aacSJoe Perches			$in_commit_log = 0;
1382b37c4aacSJoe Perches
13831ec3f6f9SBlue Swirl			if (!($line =~ /^\s*Signed-off-by:/)) {
1384c2df8783SPaolo Bonzini				ERROR("The correct form is \"Signed-off-by\"\n" .
13851ec3f6f9SBlue Swirl					$herecurr);
13861ec3f6f9SBlue Swirl			}
13871ec3f6f9SBlue Swirl			if ($line =~ /^\s*signed-off-by:\S/i) {
1388c2df8783SPaolo Bonzini				ERROR("space required after Signed-off-by:\n" .
13891ec3f6f9SBlue Swirl					$herecurr);
13901ec3f6f9SBlue Swirl			}
13911ec3f6f9SBlue Swirl		}
13921ec3f6f9SBlue Swirl
1393*1a6fad0cSJoe Perches# Check if MAINTAINERS is being updated.  If so, there's probably no need to
1394*1a6fad0cSJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete
1395*1a6fad0cSJoe Perches		if ($line =~ /^\s*MAINTAINERS\s*\|/) {
1396*1a6fad0cSJoe Perches			$reported_maintainer_file = 1;
1397*1a6fad0cSJoe Perches		}
1398*1a6fad0cSJoe Perches
13994be6131eSJoe Perches# Check for added, moved or deleted files
14004be6131eSJoe Perches		if (!$reported_maintainer_file && !$in_commit_log &&
14014be6131eSJoe Perches		    ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
14024be6131eSJoe Perches		     $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
14034be6131eSJoe Perches		     ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
14044be6131eSJoe Perches		      (defined($1) || defined($2))))) {
14054be6131eSJoe Perches			$reported_maintainer_file = 1;
14064be6131eSJoe Perches			WARN("added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
14074be6131eSJoe Perches		}
14084be6131eSJoe Perches
14091ec3f6f9SBlue Swirl# Check for wrappage within a valid hunk of the file
14101ec3f6f9SBlue Swirl		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
14111ec3f6f9SBlue Swirl			ERROR("patch seems to be corrupt (line wrapped?)\n" .
14121ec3f6f9SBlue Swirl				$herecurr) if (!$emitted_corrupt++);
14131ec3f6f9SBlue Swirl		}
14141ec3f6f9SBlue Swirl
14151ec3f6f9SBlue Swirl# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
14161ec3f6f9SBlue Swirl		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
14171ec3f6f9SBlue Swirl		    $rawline !~ m/^$UTF8*$/) {
14181ec3f6f9SBlue Swirl			my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
14191ec3f6f9SBlue Swirl
14201ec3f6f9SBlue Swirl			my $blank = copy_spacing($rawline);
14211ec3f6f9SBlue Swirl			my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
14221ec3f6f9SBlue Swirl			my $hereptr = "$hereline$ptr\n";
14231ec3f6f9SBlue Swirl
14241ec3f6f9SBlue Swirl			ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
14251ec3f6f9SBlue Swirl		}
14261ec3f6f9SBlue Swirl
1427b37c4aacSJoe Perches# Check if it's the start of a commit log
1428b37c4aacSJoe Perches# (not a header line and we haven't seen the patch filename)
1429b37c4aacSJoe Perches		if ($in_header_lines && $realfile =~ /^$/ &&
14305fc7e404SJoe Perches		    !($rawline =~ /^\s+\S/ ||
14315fc7e404SJoe Perches		      $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
1432b37c4aacSJoe Perches			$in_header_lines = 0;
1433b37c4aacSJoe Perches			$in_commit_log = 1;
1434b37c4aacSJoe Perches		}
1435b37c4aacSJoe Perches
1436bf139a06SPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly
1437bf139a06SPasi Savanainen# declined it, i.e defined some charset where it is missing.
1438bf139a06SPasi Savanainen		if ($in_header_lines &&
1439bf139a06SPasi Savanainen		    $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1440bf139a06SPasi Savanainen		    $1 !~ /utf-8/i) {
1441bf139a06SPasi Savanainen			$non_utf8_charset = 1;
1442bf139a06SPasi Savanainen		}
1443bf139a06SPasi Savanainen
1444bf139a06SPasi Savanainen		if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
1445b37c4aacSJoe Perches		    $rawline =~ /$NON_ASCII_UTF8/) {
1446b37c4aacSJoe Perches			WARN("8-bit UTF-8 used in possible commit log\n" . $herecurr);
1447b37c4aacSJoe Perches		}
1448b37c4aacSJoe Perches
14491ec3f6f9SBlue Swirl# ignore non-hunk lines and lines being removed
14501ec3f6f9SBlue Swirl		next if (!$hunk_line || $line =~ /^-/);
14511ec3f6f9SBlue Swirl
145293bf13c6SRadim Krčmář# ignore files that are being periodically imported from Linux
145393bf13c6SRadim Krčmář		next if ($realfile =~ /^(linux-headers|include\/standard-headers)\//);
145493bf13c6SRadim Krčmář
14551ec3f6f9SBlue Swirl#trailing whitespace
14561ec3f6f9SBlue Swirl		if ($line =~ /^\+.*\015/) {
14571ec3f6f9SBlue Swirl			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
14581ec3f6f9SBlue Swirl			ERROR("DOS line endings\n" . $herevet);
14591ec3f6f9SBlue Swirl
14600cebabd5SLluís Vilanova		} elsif ($realfile =~ /^docs\/.+\.txt/ ||
14610cebabd5SLluís Vilanova			 $realfile =~ /^docs\/.+\.md/) {
14620cebabd5SLluís Vilanova		    if ($rawline =~ /^\+\s+$/ && $rawline !~ /^\+ {4}$/) {
14630cebabd5SLluís Vilanova			# TODO: properly check we're in a code block
14640cebabd5SLluís Vilanova			#       (surrounding text is 4-column aligned)
14650cebabd5SLluís Vilanova			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
14660cebabd5SLluís Vilanova			ERROR("code blocks in documentation should have " .
14670cebabd5SLluís Vilanova			      "empty lines with exactly 4 columns of " .
14680cebabd5SLluís Vilanova			      "whitespace\n" . $herevet);
14690cebabd5SLluís Vilanova		    }
14701ec3f6f9SBlue Swirl		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
14711ec3f6f9SBlue Swirl			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
14721ec3f6f9SBlue Swirl			ERROR("trailing whitespace\n" . $herevet);
14731ec3f6f9SBlue Swirl			$rpt_cleaners = 1;
14741ec3f6f9SBlue Swirl		}
14751ec3f6f9SBlue Swirl
1476c3e5875aSVladimir Sementsov-Ogievskiy# checks for trace-events files
1477c3e5875aSVladimir Sementsov-Ogievskiy		if ($realfile =~ /trace-events$/ && $line =~ /^\+/) {
1478c3e5875aSVladimir Sementsov-Ogievskiy			if ($rawline =~ /%[-+ 0]*#/) {
1479c3e5875aSVladimir Sementsov-Ogievskiy				ERROR("Don't use '#' flag of printf format ('%#') in " .
1480c3e5875aSVladimir Sementsov-Ogievskiy				      "trace-events, use '0x' prefix instead\n" . $herecurr);
1481c3e5875aSVladimir Sementsov-Ogievskiy			} else {
1482c3e5875aSVladimir Sementsov-Ogievskiy				my $hex =
1483c3e5875aSVladimir Sementsov-Ogievskiy					qr/%[-+ *.0-9]*([hljztL]|ll|hh)?(x|X|"\s*PRI[xX][^"]*"?)/;
1484c3e5875aSVladimir Sementsov-Ogievskiy
1485c3e5875aSVladimir Sementsov-Ogievskiy				# don't consider groups splitted by [.:/ ], like 2A.20:12ab
148645042732SVladimir Sementsov-Ogievskiy				my $tmpline = $rawline;
148745042732SVladimir Sementsov-Ogievskiy				$tmpline =~ s/($hex[.:\/ ])+$hex//g;
1488c3e5875aSVladimir Sementsov-Ogievskiy
1489c3e5875aSVladimir Sementsov-Ogievskiy				if ($tmpline =~ /(?<!0x)$hex/) {
1490c3e5875aSVladimir Sementsov-Ogievskiy					ERROR("Hex numbers must be prefixed with '0x'\n" .
1491c3e5875aSVladimir Sementsov-Ogievskiy					      $herecurr);
1492c3e5875aSVladimir Sementsov-Ogievskiy				}
1493c3e5875aSVladimir Sementsov-Ogievskiy			}
1494c3e5875aSVladimir Sementsov-Ogievskiy		}
1495c3e5875aSVladimir Sementsov-Ogievskiy
14961ec3f6f9SBlue Swirl# check we are in a valid source file if not then ignore this hunk
1497777d05baSPaolo Bonzini		next if ($realfile !~ /$SrcFile/);
14981ec3f6f9SBlue Swirl
1499205f31a8SEric Blake#90 column limit; exempt URLs, if no other words on line
1500f1e155bbSPaolo Bonzini		if ($line =~ /^\+/ &&
1501f1e155bbSPaolo Bonzini		    !($line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
1502205f31a8SEric Blake		    !($rawline =~ /^[^[:alnum:]]*https?:\S*$/) &&
15031ec3f6f9SBlue Swirl		    $length > 80)
15041ec3f6f9SBlue Swirl		{
15058fbe3d1fSPaolo Bonzini			if ($length > 90) {
15068fbe3d1fSPaolo Bonzini				ERROR("line over 90 characters\n" . $herecurr);
15078fbe3d1fSPaolo Bonzini			} else {
15081ec3f6f9SBlue Swirl				WARN("line over 80 characters\n" . $herecurr);
15091ec3f6f9SBlue Swirl			}
15108fbe3d1fSPaolo Bonzini		}
15111ec3f6f9SBlue Swirl
15121ec3f6f9SBlue Swirl# check for spaces before a quoted newline
15131ec3f6f9SBlue Swirl		if ($rawline =~ /^.*\".*\s\\n/) {
1514c2df8783SPaolo Bonzini			ERROR("unnecessary whitespace before a quoted newline\n" . $herecurr);
15151ec3f6f9SBlue Swirl		}
15161ec3f6f9SBlue Swirl
15171ec3f6f9SBlue Swirl# check for adding lines without a newline.
15181ec3f6f9SBlue Swirl		if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1519c2df8783SPaolo Bonzini			ERROR("adding a line without newline at end of file\n" . $herecurr);
15201ec3f6f9SBlue Swirl		}
15211ec3f6f9SBlue Swirl
152293eb8e31SPaolo Bonzini# check for RCS/CVS revision markers
152393eb8e31SPaolo Bonzini		if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|\b)/) {
1524c2df8783SPaolo Bonzini			ERROR("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
152593eb8e31SPaolo Bonzini		}
152693eb8e31SPaolo Bonzini
1527906fb135SPaolo Bonzini# tabs are only allowed in assembly source code, and in
1528906fb135SPaolo Bonzini# some scripts we imported from other projects.
1529906fb135SPaolo Bonzini		next if ($realfile =~ /\.(s|S)$/);
1530906fb135SPaolo Bonzini		next if ($realfile =~ /(checkpatch|get_maintainer|texi2pod)\.pl$/);
15311ec3f6f9SBlue Swirl
1532ad36ce8bSBlue Swirl		if ($rawline =~ /^\+.*\t/) {
15331ec3f6f9SBlue Swirl			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1534b6469683SBlue Swirl			ERROR("code indent should never use tabs\n" . $herevet);
15351ec3f6f9SBlue Swirl			$rpt_cleaners = 1;
15361ec3f6f9SBlue Swirl		}
15371ec3f6f9SBlue Swirl
15381ec3f6f9SBlue Swirl# check we are in a valid C source file if not then ignore this hunk
153969d5d21fSTomoki Sekiyama		next if ($realfile !~ /\.(h|c|cpp)$/);
15401ec3f6f9SBlue Swirl
15411ec3f6f9SBlue Swirl# Check for potential 'bare' types
15421ec3f6f9SBlue Swirl		my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
15431ec3f6f9SBlue Swirl		    $realline_next);
15441ec3f6f9SBlue Swirl		if ($realcnt && $line =~ /.\s*\S/) {
15451ec3f6f9SBlue Swirl			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
15461ec3f6f9SBlue Swirl				ctx_statement_block($linenr, $realcnt, 0);
15471ec3f6f9SBlue Swirl			$stat =~ s/\n./\n /g;
15481ec3f6f9SBlue Swirl			$cond =~ s/\n./\n /g;
15491ec3f6f9SBlue Swirl
15501ec3f6f9SBlue Swirl			# Find the real next line.
15511ec3f6f9SBlue Swirl			$realline_next = $line_nr_next;
15521ec3f6f9SBlue Swirl			if (defined $realline_next &&
15531ec3f6f9SBlue Swirl			    (!defined $lines[$realline_next - 1] ||
15541ec3f6f9SBlue Swirl			     substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
15551ec3f6f9SBlue Swirl				$realline_next++;
15561ec3f6f9SBlue Swirl			}
15571ec3f6f9SBlue Swirl
15581ec3f6f9SBlue Swirl			my $s = $stat;
15591ec3f6f9SBlue Swirl			$s =~ s/{.*$//s;
15601ec3f6f9SBlue Swirl
15611ec3f6f9SBlue Swirl			# Ignore goto labels.
15621ec3f6f9SBlue Swirl			if ($s =~ /$Ident:\*$/s) {
15631ec3f6f9SBlue Swirl
15641ec3f6f9SBlue Swirl			# Ignore functions being called
15651ec3f6f9SBlue Swirl			} elsif ($s =~ /^.\s*$Ident\s*\(/s) {
15661ec3f6f9SBlue Swirl
15671ec3f6f9SBlue Swirl			} elsif ($s =~ /^.\s*else\b/s) {
15681ec3f6f9SBlue Swirl
15691ec3f6f9SBlue Swirl			# declarations always start with types
15701ec3f6f9SBlue Swirl			} 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) {
15711ec3f6f9SBlue Swirl				my $type = $1;
15721ec3f6f9SBlue Swirl				$type =~ s/\s+/ /g;
15731ec3f6f9SBlue Swirl				possible($type, "A:" . $s);
15741ec3f6f9SBlue Swirl
15751ec3f6f9SBlue Swirl			# definitions in global scope can only start with types
15761ec3f6f9SBlue Swirl			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
15771ec3f6f9SBlue Swirl				possible($1, "B:" . $s);
15781ec3f6f9SBlue Swirl			}
15791ec3f6f9SBlue Swirl
15801ec3f6f9SBlue Swirl			# any (foo ... *) is a pointer cast, and foo is a type
15811ec3f6f9SBlue Swirl			while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
15821ec3f6f9SBlue Swirl				possible($1, "C:" . $s);
15831ec3f6f9SBlue Swirl			}
15841ec3f6f9SBlue Swirl
15851ec3f6f9SBlue Swirl			# Check for any sort of function declaration.
15861ec3f6f9SBlue Swirl			# int foo(something bar, other baz);
15871ec3f6f9SBlue Swirl			# void (*store_gdt)(x86_descr_ptr *);
15881ec3f6f9SBlue Swirl			if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
15891ec3f6f9SBlue Swirl				my ($name_len) = length($1);
15901ec3f6f9SBlue Swirl
15911ec3f6f9SBlue Swirl				my $ctx = $s;
15921ec3f6f9SBlue Swirl				substr($ctx, 0, $name_len + 1, '');
15931ec3f6f9SBlue Swirl				$ctx =~ s/\)[^\)]*$//;
15941ec3f6f9SBlue Swirl
15951ec3f6f9SBlue Swirl				for my $arg (split(/\s*,\s*/, $ctx)) {
15961ec3f6f9SBlue Swirl					if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
15971ec3f6f9SBlue Swirl
15981ec3f6f9SBlue Swirl						possible($1, "D:" . $s);
15991ec3f6f9SBlue Swirl					}
16001ec3f6f9SBlue Swirl				}
16011ec3f6f9SBlue Swirl			}
16021ec3f6f9SBlue Swirl
16031ec3f6f9SBlue Swirl		}
16041ec3f6f9SBlue Swirl
16051ec3f6f9SBlue Swirl#
16061ec3f6f9SBlue Swirl# Checks which may be anchored in the context.
16071ec3f6f9SBlue Swirl#
16081ec3f6f9SBlue Swirl
16091ec3f6f9SBlue Swirl# Check for switch () and associated case and default
16101ec3f6f9SBlue Swirl# statements should be at the same indent.
16111ec3f6f9SBlue Swirl		if ($line=~/\bswitch\s*\(.*\)/) {
16121ec3f6f9SBlue Swirl			my $err = '';
16131ec3f6f9SBlue Swirl			my $sep = '';
16141ec3f6f9SBlue Swirl			my @ctx = ctx_block_outer($linenr, $realcnt);
16151ec3f6f9SBlue Swirl			shift(@ctx);
16161ec3f6f9SBlue Swirl			for my $ctx (@ctx) {
16171ec3f6f9SBlue Swirl				my ($clen, $cindent) = line_stats($ctx);
16181ec3f6f9SBlue Swirl				if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
16191ec3f6f9SBlue Swirl							$indent != $cindent) {
16201ec3f6f9SBlue Swirl					$err .= "$sep$ctx\n";
16211ec3f6f9SBlue Swirl					$sep = '';
16221ec3f6f9SBlue Swirl				} else {
16231ec3f6f9SBlue Swirl					$sep = "[...]\n";
16241ec3f6f9SBlue Swirl				}
16251ec3f6f9SBlue Swirl			}
16261ec3f6f9SBlue Swirl			if ($err ne '') {
16271ec3f6f9SBlue Swirl				ERROR("switch and case should be at the same indent\n$hereline$err");
16281ec3f6f9SBlue Swirl			}
16291ec3f6f9SBlue Swirl		}
16301ec3f6f9SBlue Swirl
16311ec3f6f9SBlue Swirl# if/while/etc brace do not go on next line, unless defining a do while loop,
16321ec3f6f9SBlue Swirl# or if that brace on the next line is for something else
16331ec3f6f9SBlue Swirl		if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
16341ec3f6f9SBlue Swirl			my $pre_ctx = "$1$2";
16351ec3f6f9SBlue Swirl
16361ec3f6f9SBlue Swirl			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
16371ec3f6f9SBlue Swirl			my $ctx_cnt = $realcnt - $#ctx - 1;
16381ec3f6f9SBlue Swirl			my $ctx = join("\n", @ctx);
16391ec3f6f9SBlue Swirl
16401ec3f6f9SBlue Swirl			my $ctx_ln = $linenr;
16411ec3f6f9SBlue Swirl			my $ctx_skip = $realcnt;
16421ec3f6f9SBlue Swirl
16431ec3f6f9SBlue Swirl			while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
16441ec3f6f9SBlue Swirl					defined $lines[$ctx_ln - 1] &&
16451ec3f6f9SBlue Swirl					$lines[$ctx_ln - 1] =~ /^-/)) {
16461ec3f6f9SBlue Swirl				##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
16471ec3f6f9SBlue Swirl				$ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
16481ec3f6f9SBlue Swirl				$ctx_ln++;
16491ec3f6f9SBlue Swirl			}
16501ec3f6f9SBlue Swirl
16511ec3f6f9SBlue Swirl			#print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
16521ec3f6f9SBlue Swirl			#print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
16531ec3f6f9SBlue Swirl
1654a97ceca5SMax Reitz			# The length of the "previous line" is checked against 80 because it
1655a97ceca5SMax Reitz			# includes the + at the beginning of the line (if the actual line has
1656a97ceca5SMax Reitz			# 79 or 80 characters, it is no longer possible to add a space and an
1657a97ceca5SMax Reitz			# opening brace there)
1658a97ceca5SMax Reitz			if ($#ctx == 0 && $ctx !~ /{\s*/ &&
165904f2562fSFam Zheng			    defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*\{/ &&
1660a97ceca5SMax Reitz			    defined($lines[$ctx_ln - 2]) && length($lines[$ctx_ln - 2]) < 80) {
16611ec3f6f9SBlue Swirl				ERROR("that open brace { should be on the previous line\n" .
16621ec3f6f9SBlue Swirl					"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
16631ec3f6f9SBlue Swirl			}
16641ec3f6f9SBlue Swirl			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
16651ec3f6f9SBlue Swirl			    $ctx =~ /\)\s*\;\s*$/ &&
16661ec3f6f9SBlue Swirl			    defined $lines[$ctx_ln - 1])
16671ec3f6f9SBlue Swirl			{
16681ec3f6f9SBlue Swirl				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
16691ec3f6f9SBlue Swirl				if ($nindent > $indent) {
1670c2df8783SPaolo Bonzini					ERROR("trailing semicolon indicates no statements, indent implies otherwise\n" .
16711ec3f6f9SBlue Swirl						"$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
16721ec3f6f9SBlue Swirl				}
16731ec3f6f9SBlue Swirl			}
16741ec3f6f9SBlue Swirl		}
16751ec3f6f9SBlue Swirl
1676f4bdc13eSEric Blake# 'do ... while (0/false)' only makes sense in macros, without trailing ';'
1677f4bdc13eSEric Blake		if ($line =~ /while\s*\((0|false)\);/) {
1678f4bdc13eSEric Blake			ERROR("suspicious ; after while (0)\n" . $herecurr);
1679f4bdc13eSEric Blake		}
1680f4bdc13eSEric Blake
16811ec3f6f9SBlue Swirl# Check relative indent for conditionals and blocks.
16821ec3f6f9SBlue Swirl		if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
16831ec3f6f9SBlue Swirl			my ($s, $c) = ($stat, $cond);
16841ec3f6f9SBlue Swirl
16851ec3f6f9SBlue Swirl			substr($s, 0, length($c), '');
16861ec3f6f9SBlue Swirl
16871ec3f6f9SBlue Swirl			# Make sure we remove the line prefixes as we have
16881ec3f6f9SBlue Swirl			# none on the first line, and are going to readd them
16891ec3f6f9SBlue Swirl			# where necessary.
16901ec3f6f9SBlue Swirl			$s =~ s/\n./\n/gs;
16911ec3f6f9SBlue Swirl
16921ec3f6f9SBlue Swirl			# Find out how long the conditional actually is.
16931ec3f6f9SBlue Swirl			my @newlines = ($c =~ /\n/gs);
16941ec3f6f9SBlue Swirl			my $cond_lines = 1 + $#newlines;
16951ec3f6f9SBlue Swirl
16961ec3f6f9SBlue Swirl			# We want to check the first line inside the block
16971ec3f6f9SBlue Swirl			# starting at the end of the conditional, so remove:
16981ec3f6f9SBlue Swirl			#  1) any blank line termination
16991ec3f6f9SBlue Swirl			#  2) any opening brace { on end of the line
17001ec3f6f9SBlue Swirl			#  3) any do (...) {
17011ec3f6f9SBlue Swirl			my $continuation = 0;
17021ec3f6f9SBlue Swirl			my $check = 0;
17031ec3f6f9SBlue Swirl			$s =~ s/^.*\bdo\b//;
170404f2562fSFam Zheng			$s =~ s/^\s*\{//;
17051ec3f6f9SBlue Swirl			if ($s =~ s/^\s*\\//) {
17061ec3f6f9SBlue Swirl				$continuation = 1;
17071ec3f6f9SBlue Swirl			}
17081ec3f6f9SBlue Swirl			if ($s =~ s/^\s*?\n//) {
17091ec3f6f9SBlue Swirl				$check = 1;
17101ec3f6f9SBlue Swirl				$cond_lines++;
17111ec3f6f9SBlue Swirl			}
17121ec3f6f9SBlue Swirl
17131ec3f6f9SBlue Swirl			# Also ignore a loop construct at the end of a
17141ec3f6f9SBlue Swirl			# preprocessor statement.
17151ec3f6f9SBlue Swirl			if (($prevline =~ /^.\s*#\s*define\s/ ||
17161ec3f6f9SBlue Swirl			    $prevline =~ /\\\s*$/) && $continuation == 0) {
17171ec3f6f9SBlue Swirl				$check = 0;
17181ec3f6f9SBlue Swirl			}
17191ec3f6f9SBlue Swirl
17201ec3f6f9SBlue Swirl			my $cond_ptr = -1;
17211ec3f6f9SBlue Swirl			$continuation = 0;
17221ec3f6f9SBlue Swirl			while ($cond_ptr != $cond_lines) {
17231ec3f6f9SBlue Swirl				$cond_ptr = $cond_lines;
17241ec3f6f9SBlue Swirl
17251ec3f6f9SBlue Swirl				# If we see an #else/#elif then the code
17261ec3f6f9SBlue Swirl				# is not linear.
17271ec3f6f9SBlue Swirl				if ($s =~ /^\s*\#\s*(?:else|elif)/) {
17281ec3f6f9SBlue Swirl					$check = 0;
17291ec3f6f9SBlue Swirl				}
17301ec3f6f9SBlue Swirl
17311ec3f6f9SBlue Swirl				# Ignore:
17321ec3f6f9SBlue Swirl				#  1) blank lines, they should be at 0,
17331ec3f6f9SBlue Swirl				#  2) preprocessor lines, and
17341ec3f6f9SBlue Swirl				#  3) labels.
17351ec3f6f9SBlue Swirl				if ($continuation ||
17361ec3f6f9SBlue Swirl				    $s =~ /^\s*?\n/ ||
17371ec3f6f9SBlue Swirl				    $s =~ /^\s*#\s*?/ ||
17381ec3f6f9SBlue Swirl				    $s =~ /^\s*$Ident\s*:/) {
17391ec3f6f9SBlue Swirl					$continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
17401ec3f6f9SBlue Swirl					if ($s =~ s/^.*?\n//) {
17411ec3f6f9SBlue Swirl						$cond_lines++;
17421ec3f6f9SBlue Swirl					}
17431ec3f6f9SBlue Swirl				}
17441ec3f6f9SBlue Swirl			}
17451ec3f6f9SBlue Swirl
17461ec3f6f9SBlue Swirl			my (undef, $sindent) = line_stats("+" . $s);
17471ec3f6f9SBlue Swirl			my $stat_real = raw_line($linenr, $cond_lines);
17481ec3f6f9SBlue Swirl
17491ec3f6f9SBlue Swirl			# Check if either of these lines are modified, else
17501ec3f6f9SBlue Swirl			# this is not this patch's fault.
17511ec3f6f9SBlue Swirl			if (!defined($stat_real) ||
17521ec3f6f9SBlue Swirl			    $stat !~ /^\+/ && $stat_real !~ /^\+/) {
17531ec3f6f9SBlue Swirl				$check = 0;
17541ec3f6f9SBlue Swirl			}
17551ec3f6f9SBlue Swirl			if (defined($stat_real) && $cond_lines > 1) {
17561ec3f6f9SBlue Swirl				$stat_real = "[...]\n$stat_real";
17571ec3f6f9SBlue Swirl			}
17581ec3f6f9SBlue Swirl
17591ec3f6f9SBlue Swirl			#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";
17601ec3f6f9SBlue Swirl
1761b6469683SBlue Swirl			if ($check && (($sindent % 4) != 0 ||
17621ec3f6f9SBlue Swirl			    ($sindent <= $indent && $s ne ''))) {
1763c2df8783SPaolo Bonzini				ERROR("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
17641ec3f6f9SBlue Swirl			}
17651ec3f6f9SBlue Swirl		}
17661ec3f6f9SBlue Swirl
17671ec3f6f9SBlue Swirl		# Track the 'values' across context and added lines.
17681ec3f6f9SBlue Swirl		my $opline = $line; $opline =~ s/^./ /;
17691ec3f6f9SBlue Swirl		my ($curr_values, $curr_vars) =
17701ec3f6f9SBlue Swirl				annotate_values($opline . "\n", $prev_values);
17711ec3f6f9SBlue Swirl		$curr_values = $prev_values . $curr_values;
17721ec3f6f9SBlue Swirl		if ($dbg_values) {
17731ec3f6f9SBlue Swirl			my $outline = $opline; $outline =~ s/\t/ /g;
17741ec3f6f9SBlue Swirl			print "$linenr > .$outline\n";
17751ec3f6f9SBlue Swirl			print "$linenr > $curr_values\n";
17761ec3f6f9SBlue Swirl			print "$linenr >  $curr_vars\n";
17771ec3f6f9SBlue Swirl		}
17781ec3f6f9SBlue Swirl		$prev_values = substr($curr_values, -1);
17791ec3f6f9SBlue Swirl
17801ec3f6f9SBlue Swirl#ignore lines not being added
17811ec3f6f9SBlue Swirl		if ($line=~/^[^\+]/) {next;}
17821ec3f6f9SBlue Swirl
17831ec3f6f9SBlue Swirl# TEST: allow direct testing of the type matcher.
17841ec3f6f9SBlue Swirl		if ($dbg_type) {
17851ec3f6f9SBlue Swirl			if ($line =~ /^.\s*$Declare\s*$/) {
17861ec3f6f9SBlue Swirl				ERROR("TEST: is type\n" . $herecurr);
17871ec3f6f9SBlue Swirl			} elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
17881ec3f6f9SBlue Swirl				ERROR("TEST: is not type ($1 is)\n". $herecurr);
17891ec3f6f9SBlue Swirl			}
17901ec3f6f9SBlue Swirl			next;
17911ec3f6f9SBlue Swirl		}
17921ec3f6f9SBlue Swirl# TEST: allow direct testing of the attribute matcher.
17931ec3f6f9SBlue Swirl		if ($dbg_attr) {
17941ec3f6f9SBlue Swirl			if ($line =~ /^.\s*$Modifier\s*$/) {
17951ec3f6f9SBlue Swirl				ERROR("TEST: is attr\n" . $herecurr);
17961ec3f6f9SBlue Swirl			} elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
17971ec3f6f9SBlue Swirl				ERROR("TEST: is not attr ($1 is)\n". $herecurr);
17981ec3f6f9SBlue Swirl			}
17991ec3f6f9SBlue Swirl			next;
18001ec3f6f9SBlue Swirl		}
18011ec3f6f9SBlue Swirl
18021ec3f6f9SBlue Swirl# check for initialisation to aggregates open brace on the next line
180304f2562fSFam Zheng		if ($line =~ /^.\s*\{/ &&
18041ec3f6f9SBlue Swirl		    $prevline =~ /(?:^|[^=])=\s*$/) {
18051ec3f6f9SBlue Swirl			ERROR("that open brace { should be on the previous line\n" . $hereprev);
18061ec3f6f9SBlue Swirl		}
18071ec3f6f9SBlue Swirl
18081ec3f6f9SBlue Swirl#
18091ec3f6f9SBlue Swirl# Checks which are anchored on the added line.
18101ec3f6f9SBlue Swirl#
18111ec3f6f9SBlue Swirl
18121ec3f6f9SBlue Swirl# check for malformed paths in #include statements (uses RAW line)
18131ec3f6f9SBlue Swirl		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
18141ec3f6f9SBlue Swirl			my $path = $1;
18151ec3f6f9SBlue Swirl			if ($path =~ m{//}) {
18161ec3f6f9SBlue Swirl				ERROR("malformed #include filename\n" .
18171ec3f6f9SBlue Swirl					$herecurr);
18181ec3f6f9SBlue Swirl			}
18191ec3f6f9SBlue Swirl		}
18201ec3f6f9SBlue Swirl
18211ec3f6f9SBlue Swirl# no C99 // comments
18221ec3f6f9SBlue Swirl		if ($line =~ m{//}) {
18231ec3f6f9SBlue Swirl			ERROR("do not use C99 // comments\n" . $herecurr);
18241ec3f6f9SBlue Swirl		}
18251ec3f6f9SBlue Swirl		# Remove C99 comments.
18261ec3f6f9SBlue Swirl		$line =~ s@//.*@@;
18271ec3f6f9SBlue Swirl		$opline =~ s@//.*@@;
18281ec3f6f9SBlue Swirl
18291ec3f6f9SBlue Swirl# check for global initialisers.
18301ec3f6f9SBlue Swirl		if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
18311ec3f6f9SBlue Swirl			ERROR("do not initialise globals to 0 or NULL\n" .
18321ec3f6f9SBlue Swirl				$herecurr);
18331ec3f6f9SBlue Swirl		}
18341ec3f6f9SBlue Swirl# check for static initialisers.
18351ec3f6f9SBlue Swirl		if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
18361ec3f6f9SBlue Swirl			ERROR("do not initialise statics to 0 or NULL\n" .
18371ec3f6f9SBlue Swirl				$herecurr);
18381ec3f6f9SBlue Swirl		}
18391ec3f6f9SBlue Swirl
18401ec3f6f9SBlue Swirl# * goes on variable not on type
18411ec3f6f9SBlue Swirl		# (char*[ const])
18421ec3f6f9SBlue Swirl		if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
18431ec3f6f9SBlue Swirl			my ($from, $to) = ($1, $1);
18441ec3f6f9SBlue Swirl
18451ec3f6f9SBlue Swirl			# Should start with a space.
18461ec3f6f9SBlue Swirl			$to =~ s/^(\S)/ $1/;
18471ec3f6f9SBlue Swirl			# Should not end with a space.
18481ec3f6f9SBlue Swirl			$to =~ s/\s+$//;
18491ec3f6f9SBlue Swirl			# '*'s should not have spaces between.
18501ec3f6f9SBlue Swirl			while ($to =~ s/\*\s+\*/\*\*/) {
18511ec3f6f9SBlue Swirl			}
18521ec3f6f9SBlue Swirl
18531ec3f6f9SBlue Swirl			#print "from<$from> to<$to>\n";
18541ec3f6f9SBlue Swirl			if ($from ne $to) {
18551ec3f6f9SBlue Swirl				ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" .  $herecurr);
18561ec3f6f9SBlue Swirl			}
18571ec3f6f9SBlue Swirl		} elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
18581ec3f6f9SBlue Swirl			my ($from, $to, $ident) = ($1, $1, $2);
18591ec3f6f9SBlue Swirl
18601ec3f6f9SBlue Swirl			# Should start with a space.
18611ec3f6f9SBlue Swirl			$to =~ s/^(\S)/ $1/;
18621ec3f6f9SBlue Swirl			# Should not end with a space.
18631ec3f6f9SBlue Swirl			$to =~ s/\s+$//;
18641ec3f6f9SBlue Swirl			# '*'s should not have spaces between.
18651ec3f6f9SBlue Swirl			while ($to =~ s/\*\s+\*/\*\*/) {
18661ec3f6f9SBlue Swirl			}
18671ec3f6f9SBlue Swirl			# Modifiers should have spaces.
18681ec3f6f9SBlue Swirl			$to =~ s/(\b$Modifier$)/$1 /;
18691ec3f6f9SBlue Swirl
18701ec3f6f9SBlue Swirl			#print "from<$from> to<$to> ident<$ident>\n";
18711ec3f6f9SBlue Swirl			if ($from ne $to && $ident !~ /^$Modifier$/) {
18721ec3f6f9SBlue Swirl				ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" .  $herecurr);
18731ec3f6f9SBlue Swirl			}
18741ec3f6f9SBlue Swirl		}
18751ec3f6f9SBlue Swirl
18761ec3f6f9SBlue Swirl# function brace can't be on same line, except for #defines of do while,
18771ec3f6f9SBlue Swirl# or if closed on same line
187804f2562fSFam Zheng		if (($line=~/$Type\s*$Ident\(.*\).*\s\{/) and
187904f2562fSFam Zheng		    !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
18801ec3f6f9SBlue Swirl			ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
18811ec3f6f9SBlue Swirl		}
18821ec3f6f9SBlue Swirl
18831ec3f6f9SBlue Swirl# open braces for enum, union and struct go on the same line.
188404f2562fSFam Zheng		if ($line =~ /^.\s*\{/ &&
18851ec3f6f9SBlue Swirl		    $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
18861ec3f6f9SBlue Swirl			ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
18871ec3f6f9SBlue Swirl		}
18881ec3f6f9SBlue Swirl
18891ec3f6f9SBlue Swirl# missing space after union, struct or enum definition
18901ec3f6f9SBlue Swirl		if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
189171c47b01SPaolo Bonzini		    ERROR("missing space after $1 definition\n" . $herecurr);
18921ec3f6f9SBlue Swirl		}
18931ec3f6f9SBlue Swirl
18941ec3f6f9SBlue Swirl# check for spacing round square brackets; allowed:
18951ec3f6f9SBlue Swirl#  1. with a type on the left -- int [] a;
18961ec3f6f9SBlue Swirl#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
18971ec3f6f9SBlue Swirl#  3. inside a curly brace -- = { [0...10] = 5 }
1898409db6ebSLeonid Bloch#  4. after a comma -- [1] = 5, [2] = 6
18998800cf0aSLeonid Bloch#  5. in a macro definition -- #define abc(x) [x] = y
19001ec3f6f9SBlue Swirl		while ($line =~ /(.*?\s)\[/g) {
19011ec3f6f9SBlue Swirl			my ($where, $prefix) = ($-[1], $1);
19021ec3f6f9SBlue Swirl			if ($prefix !~ /$Type\s+$/ &&
19031ec3f6f9SBlue Swirl			    ($where != 0 || $prefix !~ /^.\s+$/) &&
1904409db6ebSLeonid Bloch			    $prefix !~ /{\s+$/ &&
19058800cf0aSLeonid Bloch			    $prefix !~ /\#\s*define[^(]*\([^)]*\)\s+$/ &&
1906409db6ebSLeonid Bloch			    $prefix !~ /,\s+$/) {
19071ec3f6f9SBlue Swirl				ERROR("space prohibited before open square bracket '['\n" . $herecurr);
19081ec3f6f9SBlue Swirl			}
19091ec3f6f9SBlue Swirl		}
19101ec3f6f9SBlue Swirl
19111ec3f6f9SBlue Swirl# check for spaces between functions and their parentheses.
19121ec3f6f9SBlue Swirl		while ($line =~ /($Ident)\s+\(/g) {
19131ec3f6f9SBlue Swirl			my $name = $1;
19141ec3f6f9SBlue Swirl			my $ctx_before = substr($line, 0, $-[1]);
19151ec3f6f9SBlue Swirl			my $ctx = "$ctx_before$name";
19161ec3f6f9SBlue Swirl
19171ec3f6f9SBlue Swirl			# Ignore those directives where spaces _are_ permitted.
19181ec3f6f9SBlue Swirl			if ($name =~ /^(?:
19191ec3f6f9SBlue Swirl				if|for|while|switch|return|case|
1920000980cbSJeff Cody				volatile|__volatile__|coroutine_fn|
19211ec3f6f9SBlue Swirl				__attribute__|format|__extension__|
19221ec3f6f9SBlue Swirl				asm|__asm__)$/x)
19231ec3f6f9SBlue Swirl			{
19241ec3f6f9SBlue Swirl
192569d5d21fSTomoki Sekiyama			# Ignore 'catch (...)' in C++
192669d5d21fSTomoki Sekiyama			} elsif ($name =~ /^catch$/ && $realfile =~ /(\.cpp|\.h)$/) {
192769d5d21fSTomoki Sekiyama
19281ec3f6f9SBlue Swirl			# cpp #define statements have non-optional spaces, ie
19291ec3f6f9SBlue Swirl			# if there is a space between the name and the open
19301ec3f6f9SBlue Swirl			# parenthesis it is simply not a parameter group.
19311ec3f6f9SBlue Swirl			} elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
19321ec3f6f9SBlue Swirl
19331ec3f6f9SBlue Swirl			# cpp #elif statement condition may start with a (
19341ec3f6f9SBlue Swirl			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
19351ec3f6f9SBlue Swirl
19361ec3f6f9SBlue Swirl			# If this whole things ends with a type its most
19371ec3f6f9SBlue Swirl			# likely a typedef for a function.
19381ec3f6f9SBlue Swirl			} elsif ($ctx =~ /$Type$/) {
19391ec3f6f9SBlue Swirl
19401ec3f6f9SBlue Swirl			} else {
1941c2df8783SPaolo Bonzini				ERROR("space prohibited between function name and open parenthesis '('\n" . $herecurr);
19421ec3f6f9SBlue Swirl			}
19431ec3f6f9SBlue Swirl		}
19441ec3f6f9SBlue Swirl# Check operator spacing.
19451ec3f6f9SBlue Swirl		if (!($line=~/\#\s*include/)) {
19461ec3f6f9SBlue Swirl			my $ops = qr{
19471ec3f6f9SBlue Swirl				<<=|>>=|<=|>=|==|!=|
19481ec3f6f9SBlue Swirl				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
19491ec3f6f9SBlue Swirl				=>|->|<<|>>|<|>|=|!|~|
19501ec3f6f9SBlue Swirl				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
195169d5d21fSTomoki Sekiyama				\?|::|:
19521ec3f6f9SBlue Swirl			}x;
19531ec3f6f9SBlue Swirl			my @elements = split(/($ops|;)/, $opline);
19541ec3f6f9SBlue Swirl			my $off = 0;
19551ec3f6f9SBlue Swirl
19561ec3f6f9SBlue Swirl			my $blank = copy_spacing($opline);
19571ec3f6f9SBlue Swirl
19581ec3f6f9SBlue Swirl			for (my $n = 0; $n < $#elements; $n += 2) {
19591ec3f6f9SBlue Swirl				$off += length($elements[$n]);
19601ec3f6f9SBlue Swirl
1961e7d81004SStefan Weil				# Pick up the preceding and succeeding characters.
19621ec3f6f9SBlue Swirl				my $ca = substr($opline, 0, $off);
19631ec3f6f9SBlue Swirl				my $cc = '';
19641ec3f6f9SBlue Swirl				if (length($opline) >= ($off + length($elements[$n + 1]))) {
19651ec3f6f9SBlue Swirl					$cc = substr($opline, $off + length($elements[$n + 1]));
19661ec3f6f9SBlue Swirl				}
19671ec3f6f9SBlue Swirl				my $cb = "$ca$;$cc";
19681ec3f6f9SBlue Swirl
19691ec3f6f9SBlue Swirl				my $a = '';
19701ec3f6f9SBlue Swirl				$a = 'V' if ($elements[$n] ne '');
19711ec3f6f9SBlue Swirl				$a = 'W' if ($elements[$n] =~ /\s$/);
19721ec3f6f9SBlue Swirl				$a = 'C' if ($elements[$n] =~ /$;$/);
19731ec3f6f9SBlue Swirl				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
19741ec3f6f9SBlue Swirl				$a = 'O' if ($elements[$n] eq '');
19751ec3f6f9SBlue Swirl				$a = 'E' if ($ca =~ /^\s*$/);
19761ec3f6f9SBlue Swirl
19771ec3f6f9SBlue Swirl				my $op = $elements[$n + 1];
19781ec3f6f9SBlue Swirl
19791ec3f6f9SBlue Swirl				my $c = '';
19801ec3f6f9SBlue Swirl				if (defined $elements[$n + 2]) {
19811ec3f6f9SBlue Swirl					$c = 'V' if ($elements[$n + 2] ne '');
19821ec3f6f9SBlue Swirl					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
19831ec3f6f9SBlue Swirl					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
19841ec3f6f9SBlue Swirl					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
19851ec3f6f9SBlue Swirl					$c = 'O' if ($elements[$n + 2] eq '');
19861ec3f6f9SBlue Swirl					$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
19871ec3f6f9SBlue Swirl				} else {
19881ec3f6f9SBlue Swirl					$c = 'E';
19891ec3f6f9SBlue Swirl				}
19901ec3f6f9SBlue Swirl
19911ec3f6f9SBlue Swirl				my $ctx = "${a}x${c}";
19921ec3f6f9SBlue Swirl
19931ec3f6f9SBlue Swirl				my $at = "(ctx:$ctx)";
19941ec3f6f9SBlue Swirl
19951ec3f6f9SBlue Swirl				my $ptr = substr($blank, 0, $off) . "^";
19961ec3f6f9SBlue Swirl				my $hereptr = "$hereline$ptr\n";
19971ec3f6f9SBlue Swirl
19981ec3f6f9SBlue Swirl				# Pull out the value of this operator.
19991ec3f6f9SBlue Swirl				my $op_type = substr($curr_values, $off + 1, 1);
20001ec3f6f9SBlue Swirl
20011ec3f6f9SBlue Swirl				# Get the full operator variant.
20021ec3f6f9SBlue Swirl				my $opv = $op . substr($curr_vars, $off, 1);
20031ec3f6f9SBlue Swirl
20041ec3f6f9SBlue Swirl				# Ignore operators passed as parameters.
20051ec3f6f9SBlue Swirl				if ($op_type ne 'V' &&
20061ec3f6f9SBlue Swirl				    $ca =~ /\s$/ && $cc =~ /^\s*,/) {
20071ec3f6f9SBlue Swirl
20081ec3f6f9SBlue Swirl#				# Ignore comments
20091ec3f6f9SBlue Swirl#				} elsif ($op =~ /^$;+$/) {
20101ec3f6f9SBlue Swirl
20111ec3f6f9SBlue Swirl				# ; should have either the end of line or a space or \ after it
20121ec3f6f9SBlue Swirl				} elsif ($op eq ';') {
20131ec3f6f9SBlue Swirl					if ($ctx !~ /.x[WEBC]/ &&
20141ec3f6f9SBlue Swirl					    $cc !~ /^\\/ && $cc !~ /^;/) {
20151ec3f6f9SBlue Swirl						ERROR("space required after that '$op' $at\n" . $hereptr);
20161ec3f6f9SBlue Swirl					}
20171ec3f6f9SBlue Swirl
20181ec3f6f9SBlue Swirl				# // is a comment
20191ec3f6f9SBlue Swirl				} elsif ($op eq '//') {
20201ec3f6f9SBlue Swirl
202169d5d21fSTomoki Sekiyama				# Ignore : used in class declaration in C++
202269d5d21fSTomoki Sekiyama				} elsif ($opv eq ':B' && $ctx =~ /Wx[WE]/ &&
202369d5d21fSTomoki Sekiyama						 $line =~ /class/ && $realfile =~ /(\.cpp|\.h)$/) {
202469d5d21fSTomoki Sekiyama
20251ec3f6f9SBlue Swirl				# No spaces for:
20261ec3f6f9SBlue Swirl				#   ->
20271ec3f6f9SBlue Swirl				#   :   when part of a bitfield
20281ec3f6f9SBlue Swirl				} elsif ($op eq '->' || $opv eq ':B') {
20291ec3f6f9SBlue Swirl					if ($ctx =~ /Wx.|.xW/) {
20301ec3f6f9SBlue Swirl						ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
20311ec3f6f9SBlue Swirl					}
20321ec3f6f9SBlue Swirl
20331ec3f6f9SBlue Swirl				# , must have a space on the right.
20349fbe4784SAlexander Graf                                # not required when having a single },{ on one line
20351ec3f6f9SBlue Swirl				} elsif ($op eq ',') {
20369fbe4784SAlexander Graf					if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/ &&
203704f2562fSFam Zheng                                            ($elements[$n] . $elements[$n + 2]) !~ " *}\\{") {
20381ec3f6f9SBlue Swirl						ERROR("space required after that '$op' $at\n" . $hereptr);
20391ec3f6f9SBlue Swirl					}
20401ec3f6f9SBlue Swirl
20411ec3f6f9SBlue Swirl				# '*' as part of a type definition -- reported already.
20421ec3f6f9SBlue Swirl				} elsif ($opv eq '*_') {
20431ec3f6f9SBlue Swirl					#warn "'*' is part of type\n";
20441ec3f6f9SBlue Swirl
20451ec3f6f9SBlue Swirl				# unary operators should have a space before and
20461ec3f6f9SBlue Swirl				# none after.  May be left adjacent to another
20471ec3f6f9SBlue Swirl				# unary operator, or a cast
20481ec3f6f9SBlue Swirl				} elsif ($op eq '!' || $op eq '~' ||
20491ec3f6f9SBlue Swirl					 $opv eq '*U' || $opv eq '-U' ||
20501ec3f6f9SBlue Swirl					 $opv eq '&U' || $opv eq '&&U') {
205169d5d21fSTomoki Sekiyama					if ($op eq '~' && $ca =~ /::$/ && $realfile =~ /(\.cpp|\.h)$/) {
205269d5d21fSTomoki Sekiyama						# '~' used as a name of Destructor
205369d5d21fSTomoki Sekiyama
205469d5d21fSTomoki Sekiyama					} elsif ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
20551ec3f6f9SBlue Swirl						ERROR("space required before that '$op' $at\n" . $hereptr);
20561ec3f6f9SBlue Swirl					}
20571ec3f6f9SBlue Swirl					if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
20581ec3f6f9SBlue Swirl						# A unary '*' may be const
20591ec3f6f9SBlue Swirl
20601ec3f6f9SBlue Swirl					} elsif ($ctx =~ /.xW/) {
20611ec3f6f9SBlue Swirl						ERROR("space prohibited after that '$op' $at\n" . $hereptr);
20621ec3f6f9SBlue Swirl					}
20631ec3f6f9SBlue Swirl
20641ec3f6f9SBlue Swirl				# unary ++ and unary -- are allowed no space on one side.
20651ec3f6f9SBlue Swirl				} elsif ($op eq '++' or $op eq '--') {
20661ec3f6f9SBlue Swirl					if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
20671ec3f6f9SBlue Swirl						ERROR("space required one side of that '$op' $at\n" . $hereptr);
20681ec3f6f9SBlue Swirl					}
20691ec3f6f9SBlue Swirl					if ($ctx =~ /Wx[BE]/ ||
20701ec3f6f9SBlue Swirl					    ($ctx =~ /Wx./ && $cc =~ /^;/)) {
20711ec3f6f9SBlue Swirl						ERROR("space prohibited before that '$op' $at\n" . $hereptr);
20721ec3f6f9SBlue Swirl					}
20731ec3f6f9SBlue Swirl					if ($ctx =~ /ExW/) {
20741ec3f6f9SBlue Swirl						ERROR("space prohibited after that '$op' $at\n" . $hereptr);
20751ec3f6f9SBlue Swirl					}
20761ec3f6f9SBlue Swirl
20771ec3f6f9SBlue Swirl				# A colon needs no spaces before when it is
20781ec3f6f9SBlue Swirl				# terminating a case value or a label.
20791ec3f6f9SBlue Swirl				} elsif ($opv eq ':C' || $opv eq ':L') {
20801ec3f6f9SBlue Swirl					if ($ctx =~ /Wx./) {
20811ec3f6f9SBlue Swirl						ERROR("space prohibited before that '$op' $at\n" . $hereptr);
20821ec3f6f9SBlue Swirl					}
20831ec3f6f9SBlue Swirl
20841ec3f6f9SBlue Swirl				# All the others need spaces both sides.
20851ec3f6f9SBlue Swirl				} elsif ($ctx !~ /[EWC]x[CWE]/) {
20861ec3f6f9SBlue Swirl					my $ok = 0;
20871ec3f6f9SBlue Swirl
208869d5d21fSTomoki Sekiyama					if ($realfile =~ /\.cpp|\.h$/) {
208969d5d21fSTomoki Sekiyama						# Ignore template arguments <...> in C++
209069d5d21fSTomoki Sekiyama						if (($op eq '<' || $op eq '>') && $line =~ /<.*>/) {
209169d5d21fSTomoki Sekiyama							$ok = 1;
209269d5d21fSTomoki Sekiyama						}
209369d5d21fSTomoki Sekiyama
209469d5d21fSTomoki Sekiyama						# Ignore :: in C++
209569d5d21fSTomoki Sekiyama						if ($op eq '::') {
209669d5d21fSTomoki Sekiyama							$ok = 1;
209769d5d21fSTomoki Sekiyama						}
209869d5d21fSTomoki Sekiyama					}
209969d5d21fSTomoki Sekiyama
21001ec3f6f9SBlue Swirl					# Ignore email addresses <foo@bar>
21011ec3f6f9SBlue Swirl					if (($op eq '<' &&
21021ec3f6f9SBlue Swirl					     $cc =~ /^\S+\@\S+>/) ||
21031ec3f6f9SBlue Swirl					    ($op eq '>' &&
21041ec3f6f9SBlue Swirl					     $ca =~ /<\S+\@\S+$/))
21051ec3f6f9SBlue Swirl					{
21061ec3f6f9SBlue Swirl						$ok = 1;
21071ec3f6f9SBlue Swirl					}
21081ec3f6f9SBlue Swirl
21091ec3f6f9SBlue Swirl					# Ignore ?:
21101ec3f6f9SBlue Swirl					if (($opv eq ':O' && $ca =~ /\?$/) ||
21111ec3f6f9SBlue Swirl					    ($op eq '?' && $cc =~ /^:/)) {
21121ec3f6f9SBlue Swirl						$ok = 1;
21131ec3f6f9SBlue Swirl					}
21141ec3f6f9SBlue Swirl
21151ec3f6f9SBlue Swirl					if ($ok == 0) {
21161ec3f6f9SBlue Swirl						ERROR("spaces required around that '$op' $at\n" . $hereptr);
21171ec3f6f9SBlue Swirl					}
21181ec3f6f9SBlue Swirl				}
21191ec3f6f9SBlue Swirl				$off += length($elements[$n + 1]);
21201ec3f6f9SBlue Swirl			}
21211ec3f6f9SBlue Swirl		}
21221ec3f6f9SBlue Swirl
21231ec3f6f9SBlue Swirl#need space before brace following if, while, etc
212404f2562fSFam Zheng		if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
212504f2562fSFam Zheng		    $line =~ /do\{/) {
21261ec3f6f9SBlue Swirl			ERROR("space required before the open brace '{'\n" . $herecurr);
21271ec3f6f9SBlue Swirl		}
21281ec3f6f9SBlue Swirl
21291ec3f6f9SBlue Swirl# closing brace should have a space following it when it has anything
21301ec3f6f9SBlue Swirl# on the line
21311ec3f6f9SBlue Swirl		if ($line =~ /}(?!(?:,|;|\)))\S/) {
21321ec3f6f9SBlue Swirl			ERROR("space required after that close brace '}'\n" . $herecurr);
21331ec3f6f9SBlue Swirl		}
21341ec3f6f9SBlue Swirl
21351ec3f6f9SBlue Swirl# check spacing on square brackets
21361ec3f6f9SBlue Swirl		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
21371ec3f6f9SBlue Swirl			ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
21381ec3f6f9SBlue Swirl		}
21391ec3f6f9SBlue Swirl		if ($line =~ /\s\]/) {
21401ec3f6f9SBlue Swirl			ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
21411ec3f6f9SBlue Swirl		}
21421ec3f6f9SBlue Swirl
21431ec3f6f9SBlue Swirl# check spacing on parentheses
21441ec3f6f9SBlue Swirl		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
21451ec3f6f9SBlue Swirl		    $line !~ /for\s*\(\s+;/) {
21461ec3f6f9SBlue Swirl			ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
21471ec3f6f9SBlue Swirl		}
21481ec3f6f9SBlue Swirl		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
21491ec3f6f9SBlue Swirl		    $line !~ /for\s*\(.*;\s+\)/ &&
21501ec3f6f9SBlue Swirl		    $line !~ /:\s+\)/) {
21511ec3f6f9SBlue Swirl			ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
21521ec3f6f9SBlue Swirl		}
21531ec3f6f9SBlue Swirl
21541ec3f6f9SBlue Swirl# Return is not a function.
21551ec3f6f9SBlue Swirl		if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
21561ec3f6f9SBlue Swirl			my $spacing = $1;
21571ec3f6f9SBlue Swirl			my $value = $2;
21581ec3f6f9SBlue Swirl
21591ec3f6f9SBlue Swirl			# Flatten any parentheses
21601ec3f6f9SBlue Swirl			$value =~ s/\(/ \(/g;
21611ec3f6f9SBlue Swirl			$value =~ s/\)/\) /g;
21621ec3f6f9SBlue Swirl			while ($value =~ s/\[[^\{\}]*\]/1/ ||
21631ec3f6f9SBlue Swirl			       $value !~ /(?:$Ident|-?$Constant)\s*
21641ec3f6f9SBlue Swirl					     $Compare\s*
21651ec3f6f9SBlue Swirl					     (?:$Ident|-?$Constant)/x &&
21661ec3f6f9SBlue Swirl			       $value =~ s/\([^\(\)]*\)/1/) {
21671ec3f6f9SBlue Swirl			}
21681ec3f6f9SBlue Swirl#print "value<$value>\n";
21691ec3f6f9SBlue Swirl			if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
21701ec3f6f9SBlue Swirl				ERROR("return is not a function, parentheses are not required\n" . $herecurr);
21711ec3f6f9SBlue Swirl
21721ec3f6f9SBlue Swirl			} elsif ($spacing !~ /\s+/) {
21731ec3f6f9SBlue Swirl				ERROR("space required before the open parenthesis '('\n" . $herecurr);
21741ec3f6f9SBlue Swirl			}
21751ec3f6f9SBlue Swirl		}
21761ec3f6f9SBlue Swirl# Return of what appears to be an errno should normally be -'ve
21771ec3f6f9SBlue Swirl		if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
21781ec3f6f9SBlue Swirl			my $name = $1;
21791ec3f6f9SBlue Swirl			if ($name ne 'EOF' && $name ne 'ERROR') {
2180c2df8783SPaolo Bonzini				ERROR("return of an errno should typically be -ve (return -$1)\n" . $herecurr);
21811ec3f6f9SBlue Swirl			}
21821ec3f6f9SBlue Swirl		}
21831ec3f6f9SBlue Swirl
21841ec3f6f9SBlue Swirl# Need a space before open parenthesis after if, while etc
21851ec3f6f9SBlue Swirl		if ($line=~/\b(if|while|for|switch)\(/) {
21861ec3f6f9SBlue Swirl			ERROR("space required before the open parenthesis '('\n" . $herecurr);
21871ec3f6f9SBlue Swirl		}
21881ec3f6f9SBlue Swirl
21891ec3f6f9SBlue Swirl# Check for illegal assignment in if conditional -- and check for trailing
21901ec3f6f9SBlue Swirl# statements after the conditional.
21911ec3f6f9SBlue Swirl		if ($line =~ /do\s*(?!{)/) {
21921ec3f6f9SBlue Swirl			my ($stat_next) = ctx_statement_block($line_nr_next,
21931ec3f6f9SBlue Swirl						$remain_next, $off_next);
21941ec3f6f9SBlue Swirl			$stat_next =~ s/\n./\n /g;
21951ec3f6f9SBlue Swirl			##print "stat<$stat> stat_next<$stat_next>\n";
21961ec3f6f9SBlue Swirl
21971ec3f6f9SBlue Swirl			if ($stat_next =~ /^\s*while\b/) {
21981ec3f6f9SBlue Swirl				# If the statement carries leading newlines,
21991ec3f6f9SBlue Swirl				# then count those as offsets.
22001ec3f6f9SBlue Swirl				my ($whitespace) =
22011ec3f6f9SBlue Swirl					($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
22021ec3f6f9SBlue Swirl				my $offset =
22031ec3f6f9SBlue Swirl					statement_rawlines($whitespace) - 1;
22041ec3f6f9SBlue Swirl
22051ec3f6f9SBlue Swirl				$suppress_whiletrailers{$line_nr_next +
22061ec3f6f9SBlue Swirl								$offset} = 1;
22071ec3f6f9SBlue Swirl			}
22081ec3f6f9SBlue Swirl		}
22091ec3f6f9SBlue Swirl		if (!defined $suppress_whiletrailers{$linenr} &&
22101ec3f6f9SBlue Swirl		    $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
22111ec3f6f9SBlue Swirl			my ($s, $c) = ($stat, $cond);
22121ec3f6f9SBlue Swirl
22131ec3f6f9SBlue Swirl			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
22141ec3f6f9SBlue Swirl				ERROR("do not use assignment in if condition\n" . $herecurr);
22151ec3f6f9SBlue Swirl			}
22161ec3f6f9SBlue Swirl
22171ec3f6f9SBlue Swirl			# Find out what is on the end of the line after the
22181ec3f6f9SBlue Swirl			# conditional.
22191ec3f6f9SBlue Swirl			substr($s, 0, length($c), '');
22201ec3f6f9SBlue Swirl			$s =~ s/\n.*//g;
22211ec3f6f9SBlue Swirl			$s =~ s/$;//g; 	# Remove any comments
22221ec3f6f9SBlue Swirl			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
22231ec3f6f9SBlue Swirl			    $c !~ /}\s*while\s*/)
22241ec3f6f9SBlue Swirl			{
22251ec3f6f9SBlue Swirl				# Find out how long the conditional actually is.
22261ec3f6f9SBlue Swirl				my @newlines = ($c =~ /\n/gs);
22271ec3f6f9SBlue Swirl				my $cond_lines = 1 + $#newlines;
22281ec3f6f9SBlue Swirl				my $stat_real = '';
22291ec3f6f9SBlue Swirl
22301ec3f6f9SBlue Swirl				$stat_real = raw_line($linenr, $cond_lines)
22311ec3f6f9SBlue Swirl							. "\n" if ($cond_lines);
22321ec3f6f9SBlue Swirl				if (defined($stat_real) && $cond_lines > 1) {
22331ec3f6f9SBlue Swirl					$stat_real = "[...]\n$stat_real";
22341ec3f6f9SBlue Swirl				}
22351ec3f6f9SBlue Swirl
22361ec3f6f9SBlue Swirl				ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real);
22371ec3f6f9SBlue Swirl			}
22381ec3f6f9SBlue Swirl		}
22391ec3f6f9SBlue Swirl
22401ec3f6f9SBlue Swirl# Check for bitwise tests written as boolean
22411ec3f6f9SBlue Swirl		if ($line =~ /
22421ec3f6f9SBlue Swirl			(?:
22431ec3f6f9SBlue Swirl				(?:\[|\(|\&\&|\|\|)
22441ec3f6f9SBlue Swirl				\s*0[xX][0-9]+\s*
22451ec3f6f9SBlue Swirl				(?:\&\&|\|\|)
22461ec3f6f9SBlue Swirl			|
22471ec3f6f9SBlue Swirl				(?:\&\&|\|\|)
22481ec3f6f9SBlue Swirl				\s*0[xX][0-9]+\s*
22491ec3f6f9SBlue Swirl				(?:\&\&|\|\||\)|\])
22501ec3f6f9SBlue Swirl			)/x)
22511ec3f6f9SBlue Swirl		{
2252c2df8783SPaolo Bonzini			ERROR("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
22531ec3f6f9SBlue Swirl		}
22541ec3f6f9SBlue Swirl
22551ec3f6f9SBlue Swirl# if and else should not have general statements after it
22561ec3f6f9SBlue Swirl		if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
22571ec3f6f9SBlue Swirl			my $s = $1;
22581ec3f6f9SBlue Swirl			$s =~ s/$;//g; 	# Remove any comments
22591ec3f6f9SBlue Swirl			if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
22601ec3f6f9SBlue Swirl				ERROR("trailing statements should be on next line\n" . $herecurr);
22611ec3f6f9SBlue Swirl			}
22621ec3f6f9SBlue Swirl		}
22631ec3f6f9SBlue Swirl# if should not continue a brace
22641ec3f6f9SBlue Swirl		if ($line =~ /}\s*if\b/) {
22651ec3f6f9SBlue Swirl			ERROR("trailing statements should be on next line\n" .
22661ec3f6f9SBlue Swirl				$herecurr);
22671ec3f6f9SBlue Swirl		}
22681ec3f6f9SBlue Swirl# case and default should not have general statements after them
22691ec3f6f9SBlue Swirl		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
22701ec3f6f9SBlue Swirl		    $line !~ /\G(?:
22711ec3f6f9SBlue Swirl			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
22721ec3f6f9SBlue Swirl			\s*return\s+
22731ec3f6f9SBlue Swirl		    )/xg)
22741ec3f6f9SBlue Swirl		{
22751ec3f6f9SBlue Swirl			ERROR("trailing statements should be on next line\n" . $herecurr);
22761ec3f6f9SBlue Swirl		}
22771ec3f6f9SBlue Swirl
22781ec3f6f9SBlue Swirl		# Check for }<nl>else {, these must be at the same
22791ec3f6f9SBlue Swirl		# indent level to be relevant to each other.
22801ec3f6f9SBlue Swirl		if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
22811ec3f6f9SBlue Swirl						$previndent == $indent) {
22821ec3f6f9SBlue Swirl			ERROR("else should follow close brace '}'\n" . $hereprev);
22831ec3f6f9SBlue Swirl		}
22841ec3f6f9SBlue Swirl
22851ec3f6f9SBlue Swirl		if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
22861ec3f6f9SBlue Swirl						$previndent == $indent) {
22871ec3f6f9SBlue Swirl			my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
22881ec3f6f9SBlue Swirl
22891ec3f6f9SBlue Swirl			# Find out what is on the end of the line after the
22901ec3f6f9SBlue Swirl			# conditional.
22911ec3f6f9SBlue Swirl			substr($s, 0, length($c), '');
22921ec3f6f9SBlue Swirl			$s =~ s/\n.*//g;
22931ec3f6f9SBlue Swirl
22941ec3f6f9SBlue Swirl			if ($s =~ /^\s*;/) {
22951ec3f6f9SBlue Swirl				ERROR("while should follow close brace '}'\n" . $hereprev);
22961ec3f6f9SBlue Swirl			}
22971ec3f6f9SBlue Swirl		}
22981ec3f6f9SBlue Swirl
22991ec3f6f9SBlue Swirl#studly caps, commented out until figure out how to distinguish between use of existing and adding new
23001ec3f6f9SBlue Swirl#		if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
23011ec3f6f9SBlue Swirl#		    print "No studly caps, use _\n";
23021ec3f6f9SBlue Swirl#		    print "$herecurr";
23031ec3f6f9SBlue Swirl#		    $clean = 0;
23041ec3f6f9SBlue Swirl#		}
23051ec3f6f9SBlue Swirl
23061ec3f6f9SBlue Swirl#no spaces allowed after \ in define
23071ec3f6f9SBlue Swirl		if ($line=~/\#\s*define.*\\\s$/) {
2308c2df8783SPaolo Bonzini			ERROR("Whitespace after \\ makes next lines useless\n" . $herecurr);
23091ec3f6f9SBlue Swirl		}
23101ec3f6f9SBlue Swirl
23111ec3f6f9SBlue Swirl# multi-statement macros should be enclosed in a do while loop, grab the
23121ec3f6f9SBlue Swirl# first statement and ensure its the whole macro if its not enclosed
23131ec3f6f9SBlue Swirl# in a known good container
23141ec3f6f9SBlue Swirl		if ($realfile !~ m@/vmlinux.lds.h$@ &&
23151ec3f6f9SBlue Swirl		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
23161ec3f6f9SBlue Swirl			my $ln = $linenr;
23171ec3f6f9SBlue Swirl			my $cnt = $realcnt;
23181ec3f6f9SBlue Swirl			my ($off, $dstat, $dcond, $rest);
23191ec3f6f9SBlue Swirl			my $ctx = '';
23201ec3f6f9SBlue Swirl
23211ec3f6f9SBlue Swirl			my $args = defined($1);
23221ec3f6f9SBlue Swirl
23231ec3f6f9SBlue Swirl			# Find the end of the macro and limit our statement
23241ec3f6f9SBlue Swirl			# search to that.
23251ec3f6f9SBlue Swirl			while ($cnt > 0 && defined $lines[$ln - 1] &&
23261ec3f6f9SBlue Swirl				$lines[$ln - 1] =~ /^(?:-|..*\\$)/)
23271ec3f6f9SBlue Swirl			{
23281ec3f6f9SBlue Swirl				$ctx .= $rawlines[$ln - 1] . "\n";
23291ec3f6f9SBlue Swirl				$cnt-- if ($lines[$ln - 1] !~ /^-/);
23301ec3f6f9SBlue Swirl				$ln++;
23311ec3f6f9SBlue Swirl			}
23321ec3f6f9SBlue Swirl			$ctx .= $rawlines[$ln - 1];
23331ec3f6f9SBlue Swirl
23341ec3f6f9SBlue Swirl			($dstat, $dcond, $ln, $cnt, $off) =
23351ec3f6f9SBlue Swirl				ctx_statement_block($linenr, $ln - $linenr + 1, 0);
23361ec3f6f9SBlue Swirl			#print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
23371ec3f6f9SBlue Swirl			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
23381ec3f6f9SBlue Swirl
23391ec3f6f9SBlue Swirl			# Extract the remainder of the define (if any) and
23401ec3f6f9SBlue Swirl			# rip off surrounding spaces, and trailing \'s.
23411ec3f6f9SBlue Swirl			$rest = '';
23421ec3f6f9SBlue Swirl			while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
23431ec3f6f9SBlue Swirl				#print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
23441ec3f6f9SBlue Swirl				if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
23451ec3f6f9SBlue Swirl					$rest .= substr($lines[$ln - 1], $off) . "\n";
23461ec3f6f9SBlue Swirl					$cnt--;
23471ec3f6f9SBlue Swirl				}
23481ec3f6f9SBlue Swirl				$ln++;
23491ec3f6f9SBlue Swirl				$off = 0;
23501ec3f6f9SBlue Swirl			}
23511ec3f6f9SBlue Swirl			$rest =~ s/\\\n.//g;
23521ec3f6f9SBlue Swirl			$rest =~ s/^\s*//s;
23531ec3f6f9SBlue Swirl			$rest =~ s/\s*$//s;
23541ec3f6f9SBlue Swirl
23551ec3f6f9SBlue Swirl			# Clean up the original statement.
23561ec3f6f9SBlue Swirl			if ($args) {
23571ec3f6f9SBlue Swirl				substr($dstat, 0, length($dcond), '');
23581ec3f6f9SBlue Swirl			} else {
23591ec3f6f9SBlue Swirl				$dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
23601ec3f6f9SBlue Swirl			}
23611ec3f6f9SBlue Swirl			$dstat =~ s/$;//g;
23621ec3f6f9SBlue Swirl			$dstat =~ s/\\\n.//g;
23631ec3f6f9SBlue Swirl			$dstat =~ s/^\s*//s;
23641ec3f6f9SBlue Swirl			$dstat =~ s/\s*$//s;
23651ec3f6f9SBlue Swirl
23661ec3f6f9SBlue Swirl			# Flatten any parentheses and braces
23671ec3f6f9SBlue Swirl			while ($dstat =~ s/\([^\(\)]*\)/1/ ||
23681ec3f6f9SBlue Swirl			       $dstat =~ s/\{[^\{\}]*\}/1/ ||
23691ec3f6f9SBlue Swirl			       $dstat =~ s/\[[^\{\}]*\]/1/)
23701ec3f6f9SBlue Swirl			{
23711ec3f6f9SBlue Swirl			}
23721ec3f6f9SBlue Swirl
23731ec3f6f9SBlue Swirl			my $exceptions = qr{
23741ec3f6f9SBlue Swirl				$Declare|
23751ec3f6f9SBlue Swirl				module_param_named|
23761ec3f6f9SBlue Swirl				MODULE_PARAM_DESC|
23771ec3f6f9SBlue Swirl				DECLARE_PER_CPU|
23781ec3f6f9SBlue Swirl				DEFINE_PER_CPU|
23791ec3f6f9SBlue Swirl				__typeof__\(|
23801ec3f6f9SBlue Swirl				union|
23811ec3f6f9SBlue Swirl				struct|
23821ec3f6f9SBlue Swirl				\.$Ident\s*=\s*|
23831ec3f6f9SBlue Swirl				^\"|\"$
23841ec3f6f9SBlue Swirl			}x;
23851ec3f6f9SBlue Swirl			#print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
23861ec3f6f9SBlue Swirl			if ($rest ne '' && $rest ne ',') {
23871ec3f6f9SBlue Swirl				if ($rest !~ /while\s*\(/ &&
23881ec3f6f9SBlue Swirl				    $dstat !~ /$exceptions/)
23891ec3f6f9SBlue Swirl				{
23901ec3f6f9SBlue Swirl					ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
23911ec3f6f9SBlue Swirl				}
23921ec3f6f9SBlue Swirl
23931ec3f6f9SBlue Swirl			} elsif ($ctx !~ /;/) {
23941ec3f6f9SBlue Swirl				if ($dstat ne '' &&
23951ec3f6f9SBlue Swirl				    $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
23961ec3f6f9SBlue Swirl				    $dstat !~ /$exceptions/ &&
23971ec3f6f9SBlue Swirl				    $dstat !~ /^\.$Ident\s*=/ &&
23981ec3f6f9SBlue Swirl				    $dstat =~ /$Operators/)
23991ec3f6f9SBlue Swirl				{
24001ec3f6f9SBlue Swirl					ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
24011ec3f6f9SBlue Swirl				}
24021ec3f6f9SBlue Swirl			}
24031ec3f6f9SBlue Swirl		}
24041ec3f6f9SBlue Swirl
24052b9aef6fSSu Hang# check for missing bracing around if etc
24062b9aef6fSSu Hang		if ($line =~ /(^.*)\b(?:if|while|for)\b/ &&
24072b9aef6fSSu Hang			$line !~ /\#\s*if/) {
2408053e45d2SSu Hang			my $allowed = 0;
2409053e45d2SSu Hang
2410053e45d2SSu Hang			# Check the pre-context.
2411053e45d2SSu Hang			if ($line =~ /(\}.*?)$/) {
2412053e45d2SSu Hang				my $pre = $1;
2413053e45d2SSu Hang
2414053e45d2SSu Hang				if ($line !~ /else/) {
2415053e45d2SSu Hang					print "APW: ALLOWED: pre<$pre> line<$line>\n"
2416053e45d2SSu Hang						if $dbg_adv_apw;
2417053e45d2SSu Hang					$allowed = 1;
2418053e45d2SSu Hang				}
2419053e45d2SSu Hang			}
24201ec3f6f9SBlue Swirl			my ($level, $endln, @chunks) =
24211ec3f6f9SBlue Swirl				ctx_statement_full($linenr, $realcnt, 1);
242269402a69SDon Slutz                        if ($dbg_adv_apw) {
242369402a69SDon Slutz                            print "APW: chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
242469402a69SDon Slutz                            print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"
242569402a69SDon Slutz                                if $#chunks >= 1;
242669402a69SDon Slutz                        }
2427b6469683SBlue Swirl			if ($#chunks >= 0 && $level == 0) {
24281ec3f6f9SBlue Swirl				my $seen = 0;
24291ec3f6f9SBlue Swirl				my $herectx = $here . "\n";
24301ec3f6f9SBlue Swirl				my $ln = $linenr - 1;
24311ec3f6f9SBlue Swirl				for my $chunk (@chunks) {
24321ec3f6f9SBlue Swirl					my ($cond, $block) = @{$chunk};
24331ec3f6f9SBlue Swirl
24341ec3f6f9SBlue Swirl					# If the condition carries leading newlines, then count those as offsets.
24351ec3f6f9SBlue Swirl					my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
24361ec3f6f9SBlue Swirl					my $offset = statement_rawlines($whitespace) - 1;
24371ec3f6f9SBlue Swirl
24381ec3f6f9SBlue Swirl					#print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
24391ec3f6f9SBlue Swirl
24401ec3f6f9SBlue Swirl					# We have looked at and allowed this specific line.
24411ec3f6f9SBlue Swirl					$suppress_ifbraces{$ln + $offset} = 1;
24421ec3f6f9SBlue Swirl
24431ec3f6f9SBlue Swirl					$herectx .= "$rawlines[$ln + $offset]\n[...]\n";
24441ec3f6f9SBlue Swirl					$ln += statement_rawlines($block) - 1;
24451ec3f6f9SBlue Swirl
24461ec3f6f9SBlue Swirl					substr($block, 0, length($cond), '');
24471ec3f6f9SBlue Swirl
2448a97ceca5SMax Reitz					my $spaced_block = $block;
2449a97ceca5SMax Reitz					$spaced_block =~ s/\n\+/ /g;
2450a97ceca5SMax Reitz
245104f2562fSFam Zheng					$seen++ if ($spaced_block =~ /^\s*\{/);
24521ec3f6f9SBlue Swirl
245369402a69SDon Slutz                                        print "APW: cond<$cond> block<$block> allowed<$allowed>\n"
245469402a69SDon Slutz                                            if $dbg_adv_apw;
24551ec3f6f9SBlue Swirl					if (statement_lines($cond) > 1) {
245669402a69SDon Slutz                                            print "APW: ALLOWED: cond<$cond>\n"
245769402a69SDon Slutz                                                if $dbg_adv_apw;
24581ec3f6f9SBlue Swirl                                            $allowed = 1;
24591ec3f6f9SBlue Swirl					}
24601ec3f6f9SBlue Swirl					if ($block =~/\b(?:if|for|while)\b/) {
246169402a69SDon Slutz                                            print "APW: ALLOWED: block<$block>\n"
246269402a69SDon Slutz                                                if $dbg_adv_apw;
24631ec3f6f9SBlue Swirl                                            $allowed = 1;
24641ec3f6f9SBlue Swirl					}
24651ec3f6f9SBlue Swirl					if (statement_block_size($block) > 1) {
246669402a69SDon Slutz                                            print "APW: ALLOWED: lines block<$block>\n"
246769402a69SDon Slutz                                                if $dbg_adv_apw;
24681ec3f6f9SBlue Swirl                                            $allowed = 1;
24691ec3f6f9SBlue Swirl					}
24701ec3f6f9SBlue Swirl				}
2471053e45d2SSu Hang				if ($seen != ($#chunks + 1) && !$allowed) {
2472c2df8783SPaolo Bonzini					ERROR("braces {} are necessary for all arms of this statement\n" . $herectx);
24731ec3f6f9SBlue Swirl				}
24741ec3f6f9SBlue Swirl			}
24751ec3f6f9SBlue Swirl		}
24761ec3f6f9SBlue Swirl		if (!defined $suppress_ifbraces{$linenr - 1} &&
2477789f88d0SJan Kiszka					$line =~ /\b(if|while|for|else)\b/ &&
2478d0510af2SBlue Swirl					$line !~ /\#\s*if/ &&
2479789f88d0SJan Kiszka					$line !~ /\#\s*else/) {
24801ec3f6f9SBlue Swirl			my $allowed = 0;
24811ec3f6f9SBlue Swirl
24821ec3f6f9SBlue Swirl                        # Check the pre-context.
24831ec3f6f9SBlue Swirl                        if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2484dfe7053aSDon Slutz                            my $pre = $1;
2485dfe7053aSDon Slutz
2486dfe7053aSDon Slutz                            if ($line !~ /else/) {
248769402a69SDon Slutz                                print "APW: ALLOWED: pre<$pre> line<$line>\n"
248869402a69SDon Slutz                                    if $dbg_adv_apw;
24891ec3f6f9SBlue Swirl                                $allowed = 1;
24901ec3f6f9SBlue Swirl                            }
2491dfe7053aSDon Slutz                        }
24921ec3f6f9SBlue Swirl
24931ec3f6f9SBlue Swirl			my ($level, $endln, @chunks) =
24941ec3f6f9SBlue Swirl				ctx_statement_full($linenr, $realcnt, $-[0]);
24951ec3f6f9SBlue Swirl
24961ec3f6f9SBlue Swirl			# Check the condition.
24971ec3f6f9SBlue Swirl			my ($cond, $block) = @{$chunks[0]};
24985424302eSDon Slutz                        print "CHECKING<$linenr> cond<$cond> block<$block>\n"
24995424302eSDon Slutz                            if $dbg_adv_checking;
25001ec3f6f9SBlue Swirl			if (defined $cond) {
25011ec3f6f9SBlue Swirl				substr($block, 0, length($cond), '');
25021ec3f6f9SBlue Swirl			}
25031ec3f6f9SBlue Swirl			if (statement_lines($cond) > 1) {
250469402a69SDon Slutz                            print "APW: ALLOWED: cond<$cond>\n"
250569402a69SDon Slutz                                if $dbg_adv_apw;
25061ec3f6f9SBlue Swirl                            $allowed = 1;
25071ec3f6f9SBlue Swirl			}
25081ec3f6f9SBlue Swirl			if ($block =~/\b(?:if|for|while)\b/) {
250969402a69SDon Slutz                            print "APW: ALLOWED: block<$block>\n"
251069402a69SDon Slutz                                if $dbg_adv_apw;
25111ec3f6f9SBlue Swirl                            $allowed = 1;
25121ec3f6f9SBlue Swirl			}
25131ec3f6f9SBlue Swirl			if (statement_block_size($block) > 1) {
251469402a69SDon Slutz                            print "APW: ALLOWED: lines block<$block>\n"
251569402a69SDon Slutz                                if $dbg_adv_apw;
25161ec3f6f9SBlue Swirl                            $allowed = 1;
25171ec3f6f9SBlue Swirl			}
25181ec3f6f9SBlue Swirl			# Check the post-context.
25191ec3f6f9SBlue Swirl			if (defined $chunks[1]) {
25201ec3f6f9SBlue Swirl				my ($cond, $block) = @{$chunks[1]};
25211ec3f6f9SBlue Swirl				if (defined $cond) {
25221ec3f6f9SBlue Swirl					substr($block, 0, length($cond), '');
25231ec3f6f9SBlue Swirl				}
25241ec3f6f9SBlue Swirl				if ($block =~ /^\s*\{/) {
252569402a69SDon Slutz                                    print "APW: ALLOWED: chunk-1 block<$block>\n"
252669402a69SDon Slutz                                        if $dbg_adv_apw;
25271ec3f6f9SBlue Swirl                                    $allowed = 1;
25281ec3f6f9SBlue Swirl				}
25291ec3f6f9SBlue Swirl			}
2530a99ac041SDon Slutz                        print "DCS: level=$level block<$block> allowed=$allowed\n"
2531a99ac041SDon Slutz                            if $dbg_adv_dcs;
2532b6469683SBlue Swirl			if ($level == 0 && $block !~ /^\s*\{/ && !$allowed) {
25331ec3f6f9SBlue Swirl				my $herectx = $here . "\n";;
25341ec3f6f9SBlue Swirl				my $cnt = statement_rawlines($block);
25351ec3f6f9SBlue Swirl
25361ec3f6f9SBlue Swirl				for (my $n = 0; $n < $cnt; $n++) {
25371ec3f6f9SBlue Swirl					$herectx .= raw_line($linenr, $n) . "\n";;
25381ec3f6f9SBlue Swirl				}
25391ec3f6f9SBlue Swirl
2540c2df8783SPaolo Bonzini				ERROR("braces {} are necessary even for single statement blocks\n" . $herectx);
25411ec3f6f9SBlue Swirl			}
25421ec3f6f9SBlue Swirl		}
25431ec3f6f9SBlue Swirl
25441ec3f6f9SBlue Swirl# no volatiles please
25451ec3f6f9SBlue Swirl		my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
25466b012d23SMarc-André Lureau		if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/ &&
25476b012d23SMarc-André Lureau                    $line !~ /sig_atomic_t/ &&
25486b012d23SMarc-André Lureau                    !ctx_has_comment($first_line, $linenr)) {
25496b012d23SMarc-André Lureau			my $msg = "Use of volatile is usually wrong, please add a comment\n" . $herecurr;
25506b012d23SMarc-André Lureau                        ERROR($msg);
25511ec3f6f9SBlue Swirl		}
25521ec3f6f9SBlue Swirl
25531ec3f6f9SBlue Swirl# warn about #if 0
25541ec3f6f9SBlue Swirl		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
2555c2df8783SPaolo Bonzini			ERROR("if this code is redundant consider removing it\n" .
25561ec3f6f9SBlue Swirl				$herecurr);
25571ec3f6f9SBlue Swirl		}
25581ec3f6f9SBlue Swirl
255971c47b01SPaolo Bonzini# check for needless g_free() checks
25601ec3f6f9SBlue Swirl		if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
25611ec3f6f9SBlue Swirl			my $expr = $1;
256271c47b01SPaolo Bonzini			if ($line =~ /\bg_free\(\Q$expr\E\);/) {
2563c2df8783SPaolo Bonzini				ERROR("g_free(NULL) is safe this check is probably not required\n" . $hereprev);
25641ec3f6f9SBlue Swirl			}
25651ec3f6f9SBlue Swirl		}
25661ec3f6f9SBlue Swirl
25671ec3f6f9SBlue Swirl# warn about #ifdefs in C files
25681ec3f6f9SBlue Swirl#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
25691ec3f6f9SBlue Swirl#			print "#ifdef in C files should be avoided\n";
25701ec3f6f9SBlue Swirl#			print "$herecurr";
25711ec3f6f9SBlue Swirl#			$clean = 0;
25721ec3f6f9SBlue Swirl#		}
25731ec3f6f9SBlue Swirl
25741ec3f6f9SBlue Swirl# warn about spacing in #ifdefs
25751ec3f6f9SBlue Swirl		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
25761ec3f6f9SBlue Swirl			ERROR("exactly one space required after that #$1\n" . $herecurr);
25771ec3f6f9SBlue Swirl		}
25781ec3f6f9SBlue Swirl# check for memory barriers without a comment.
257971c47b01SPaolo Bonzini		if ($line =~ /\b(smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
25801ec3f6f9SBlue Swirl			if (!ctx_has_comment($first_line, $linenr)) {
2581c2df8783SPaolo Bonzini				ERROR("memory barrier without comment\n" . $herecurr);
25821ec3f6f9SBlue Swirl			}
25831ec3f6f9SBlue Swirl		}
25841ec3f6f9SBlue Swirl# check of hardware specific defines
258571c47b01SPaolo Bonzini# we have e.g. CONFIG_LINUX and CONFIG_WIN32 for common cases
258671c47b01SPaolo Bonzini# where they might be necessary.
258771c47b01SPaolo Bonzini		if ($line =~ m@^.\s*\#\s*if.*\b__@) {
258863ae8b94SPaolo Bonzini			WARN("architecture specific defines should be avoided\n" .  $herecurr);
25891ec3f6f9SBlue Swirl		}
25901ec3f6f9SBlue Swirl
25911ec3f6f9SBlue Swirl# Check that the storage class is at the beginning of a declaration
25921ec3f6f9SBlue Swirl		if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
2593c2df8783SPaolo Bonzini			ERROR("storage class should be at the beginning of the declaration\n" . $herecurr)
25941ec3f6f9SBlue Swirl		}
25951ec3f6f9SBlue Swirl
25961ec3f6f9SBlue Swirl# check the location of the inline attribute, that it is between
25971ec3f6f9SBlue Swirl# storage class and type.
25981ec3f6f9SBlue Swirl		if ($line =~ /\b$Type\s+$Inline\b/ ||
25991ec3f6f9SBlue Swirl		    $line =~ /\b$Inline\s+$Storage\b/) {
26001ec3f6f9SBlue Swirl			ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
26011ec3f6f9SBlue Swirl		}
26021ec3f6f9SBlue Swirl
26031ec3f6f9SBlue Swirl# check for sizeof(&)
26041ec3f6f9SBlue Swirl		if ($line =~ /\bsizeof\s*\(\s*\&/) {
2605c2df8783SPaolo Bonzini			ERROR("sizeof(& should be avoided\n" . $herecurr);
26061ec3f6f9SBlue Swirl		}
26071ec3f6f9SBlue Swirl
26081ec3f6f9SBlue Swirl# check for new externs in .c files.
26091ec3f6f9SBlue Swirl		if ($realfile =~ /\.c$/ && defined $stat &&
26101ec3f6f9SBlue Swirl		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
26111ec3f6f9SBlue Swirl		{
26121ec3f6f9SBlue Swirl			my $function_name = $1;
26131ec3f6f9SBlue Swirl			my $paren_space = $2;
26141ec3f6f9SBlue Swirl
26151ec3f6f9SBlue Swirl			my $s = $stat;
26161ec3f6f9SBlue Swirl			if (defined $cond) {
26171ec3f6f9SBlue Swirl				substr($s, 0, length($cond), '');
26181ec3f6f9SBlue Swirl			}
26191ec3f6f9SBlue Swirl			if ($s =~ /^\s*;/ &&
26201ec3f6f9SBlue Swirl			    $function_name ne 'uninitialized_var')
26211ec3f6f9SBlue Swirl			{
2622c2df8783SPaolo Bonzini				ERROR("externs should be avoided in .c files\n" .  $herecurr);
26231ec3f6f9SBlue Swirl			}
26241ec3f6f9SBlue Swirl
26251ec3f6f9SBlue Swirl			if ($paren_space =~ /\n/) {
2626c2df8783SPaolo Bonzini				ERROR("arguments for function declarations should follow identifier\n" . $herecurr);
26271ec3f6f9SBlue Swirl			}
26281ec3f6f9SBlue Swirl
26291ec3f6f9SBlue Swirl		} elsif ($realfile =~ /\.c$/ && defined $stat &&
26301ec3f6f9SBlue Swirl		    $stat =~ /^.\s*extern\s+/)
26311ec3f6f9SBlue Swirl		{
2632c2df8783SPaolo Bonzini			ERROR("externs should be avoided in .c files\n" .  $herecurr);
26331ec3f6f9SBlue Swirl		}
26341ec3f6f9SBlue Swirl
263571c47b01SPaolo Bonzini# check for pointless casting of g_malloc return
263671c47b01SPaolo Bonzini		if ($line =~ /\*\s*\)\s*g_(try)?(m|re)alloc(0?)(_n)?\b/) {
263771c47b01SPaolo Bonzini			if ($2 == 'm') {
2638c2df8783SPaolo Bonzini				ERROR("unnecessary cast may hide bugs, use g_$1new$3 instead\n" . $herecurr);
263971c47b01SPaolo Bonzini			} else {
2640c2df8783SPaolo Bonzini				ERROR("unnecessary cast may hide bugs, use g_$1renew$3 instead\n" . $herecurr);
264171c47b01SPaolo Bonzini			}
26421ec3f6f9SBlue Swirl		}
26431ec3f6f9SBlue Swirl
26441ec3f6f9SBlue Swirl# check for gcc specific __FUNCTION__
26451ec3f6f9SBlue Swirl		if ($line =~ /__FUNCTION__/) {
2646c2df8783SPaolo Bonzini			ERROR("__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr);
26471ec3f6f9SBlue Swirl		}
26481ec3f6f9SBlue Swirl
2649fb8446d9SJulia Suvorova# recommend g_path_get_* over g_strdup(basename/dirname(...))
2650fb8446d9SJulia Suvorova		if ($line =~ /\bg_strdup\s*\(\s*(basename|dirname)\s*\(/) {
2651fb8446d9SJulia Suvorova			WARN("consider using g_path_get_$1() in preference to g_strdup($1())\n" . $herecurr);
2652fb8446d9SJulia Suvorova		}
2653fb8446d9SJulia Suvorova
26545e43efb2SPaolo Bonzini# recommend qemu_strto* over strto* for numeric conversions
265501fb8e19SEric Blake		if ($line =~ /\b(strto[^kd].*?)\s*\(/) {
2656c2df8783SPaolo Bonzini			ERROR("consider using qemu_$1 in preference to $1\n" . $herecurr);
26571ec3f6f9SBlue Swirl		}
2658e8c2091dSPaolo Bonzini# recommend sigaction over signal for portability, when establishing a handler
2659e8c2091dSPaolo Bonzini		if ($line =~ /\bsignal\s*\(/ && !($line =~ /SIG_(?:IGN|DFL)/)) {
2660e8c2091dSPaolo Bonzini			ERROR("use sigaction to establish signal handlers; signal is not portable\n" . $herecurr);
2661e8c2091dSPaolo Bonzini		}
266271c47b01SPaolo Bonzini# check for module_init(), use category-specific init macros explicitly please
266371c47b01SPaolo Bonzini		if ($line =~ /^module_init\s*\(/) {
2664c2df8783SPaolo Bonzini			ERROR("please use block_init(), type_init() etc. instead of module_init()\n" . $herecurr);
26651ec3f6f9SBlue Swirl		}
26661ec3f6f9SBlue Swirl# check for various ops structs, ensure they are const.
266771c47b01SPaolo Bonzini		my $struct_ops = qr{AIOCBInfo|
266871c47b01SPaolo Bonzini				BdrvActionOps|
266971c47b01SPaolo Bonzini				BlockDevOps|
267071c47b01SPaolo Bonzini				BlockJobDriver|
267171c47b01SPaolo Bonzini				DisplayChangeListenerOps|
267271c47b01SPaolo Bonzini				GraphicHwOps|
267371c47b01SPaolo Bonzini				IDEDMAOps|
267471c47b01SPaolo Bonzini				KVMCapabilityInfo|
267571c47b01SPaolo Bonzini				MemoryRegionIOMMUOps|
267671c47b01SPaolo Bonzini				MemoryRegionOps|
267771c47b01SPaolo Bonzini				MemoryRegionPortio|
267871c47b01SPaolo Bonzini				QEMUFileOps|
267971c47b01SPaolo Bonzini				SCSIBusInfo|
268071c47b01SPaolo Bonzini				SCSIReqOps|
268171c47b01SPaolo Bonzini				Spice[A-Z][a-zA-Z0-9]*Interface|
268271c47b01SPaolo Bonzini				USBDesc[A-Z][a-zA-Z0-9]*|
268371c47b01SPaolo Bonzini				VhostOps|
268471c47b01SPaolo Bonzini				VMStateDescription|
268571c47b01SPaolo Bonzini				VMStateInfo}x;
26861ec3f6f9SBlue Swirl		if ($line !~ /\bconst\b/ &&
2687e20e718cSPaolo Bonzini		    $line =~ /\b($struct_ops)\b.*=/) {
2688e20e718cSPaolo Bonzini			ERROR("initializer for struct $1 should normally be const\n" .
26891ec3f6f9SBlue Swirl				$herecurr);
26901ec3f6f9SBlue Swirl		}
26911ec3f6f9SBlue Swirl
26921ec3f6f9SBlue Swirl# check for %L{u,d,i} in strings
26931ec3f6f9SBlue Swirl		my $string;
26941ec3f6f9SBlue Swirl		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
26951ec3f6f9SBlue Swirl			$string = substr($rawline, $-[1], $+[1] - $-[1]);
26961ec3f6f9SBlue Swirl			$string =~ s/%%/__/g;
26971ec3f6f9SBlue Swirl			if ($string =~ /(?<!%)%L[udi]/) {
2698c2df8783SPaolo Bonzini				ERROR("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
26991ec3f6f9SBlue Swirl				last;
27001ec3f6f9SBlue Swirl			}
27011ec3f6f9SBlue Swirl		}
27021ec3f6f9SBlue Swirl
27039964d8f9SStefan Weil# QEMU specific tests
27049964d8f9SStefan Weil		if ($rawline =~ /\b(?:Qemu|QEmu)\b/) {
2705c2df8783SPaolo Bonzini			ERROR("use QEMU instead of Qemu or QEmu\n" . $herecurr);
27069964d8f9SStefan Weil		}
27078b6ee9aeSStefan Hajnoczi
27085d596c24SJason J. Herne# Qemu error function tests
27095d596c24SJason J. Herne
27105d596c24SJason J. Herne	# Find newlines in error messages
27115d596c24SJason J. Herne	my $qemu_error_funcs = qr{error_setg|
27125d596c24SJason J. Herne				error_setg_errno|
27135d596c24SJason J. Herne				error_setg_win32|
2714a47eb010SMarkus Armbruster				error_setg_file_open|
27155d596c24SJason J. Herne				error_set|
2716a47eb010SMarkus Armbruster				error_prepend|
2717e43ead1dSAlistair Francis				warn_reportf_err|
2718a47eb010SMarkus Armbruster				error_reportf_err|
27195d596c24SJason J. Herne				error_vreport|
272097f40301SAlistair Francis				warn_vreport|
272197f40301SAlistair Francis				info_vreport|
272297f40301SAlistair Francis				error_report|
272397f40301SAlistair Francis				warn_report|
272497f40301SAlistair Francis				info_report}x;
27255d596c24SJason J. Herne
2726a47eb010SMarkus Armbruster	if ($rawline =~ /\b(?:$qemu_error_funcs)\s*\(.*\".*\\n/) {
2727c2df8783SPaolo Bonzini		ERROR("Error messages should not contain newlines\n" . $herecurr);
27285d596c24SJason J. Herne	}
27295d596c24SJason J. Herne
27305d596c24SJason J. Herne	# Continue checking for error messages that contains newlines. This
27315d596c24SJason J. Herne	# check handles cases where string literals are spread over multiple lines.
27325d596c24SJason J. Herne	# Example:
27335d596c24SJason J. Herne	# error_report("Error msg line #1"
27345d596c24SJason J. Herne	#              "Error msg line #2\n");
27355d596c24SJason J. Herne	my $quoted_newline_regex = qr{\+\s*\".*\\n.*\"};
27365d596c24SJason J. Herne	my $continued_str_literal = qr{\+\s*\".*\"};
27375d596c24SJason J. Herne
27385d596c24SJason J. Herne	if ($rawline =~ /$quoted_newline_regex/) {
27395d596c24SJason J. Herne		# Backtrack to first line that does not contain only a quoted literal
27405d596c24SJason J. Herne		# and assume that it is the start of the statement.
27415d596c24SJason J. Herne		my $i = $linenr - 2;
27425d596c24SJason J. Herne
27435d596c24SJason J. Herne		while (($i >= 0) & $rawlines[$i] =~ /$continued_str_literal/) {
27445d596c24SJason J. Herne			$i--;
27455d596c24SJason J. Herne		}
27465d596c24SJason J. Herne
27475d596c24SJason J. Herne		if ($rawlines[$i] =~ /\b(?:$qemu_error_funcs)\s*\(/) {
2748c2df8783SPaolo Bonzini			ERROR("Error messages should not contain newlines\n" . $herecurr);
27495d596c24SJason J. Herne		}
27505d596c24SJason J. Herne	}
27515d596c24SJason J. Herne
27523f822cffSPaolo Bonzini# check for non-portable libc calls that have portable alternatives in QEMU
27538b6ee9aeSStefan Hajnoczi		if ($line =~ /\bffs\(/) {
27548b6ee9aeSStefan Hajnoczi			ERROR("use ctz32() instead of ffs()\n" . $herecurr);
27558b6ee9aeSStefan Hajnoczi		}
27568b6ee9aeSStefan Hajnoczi		if ($line =~ /\bffsl\(/) {
27578b6ee9aeSStefan Hajnoczi			ERROR("use ctz32() or ctz64() instead of ffsl()\n" . $herecurr);
27588b6ee9aeSStefan Hajnoczi		}
27598b6ee9aeSStefan Hajnoczi		if ($line =~ /\bffsll\(/) {
27608b6ee9aeSStefan Hajnoczi			ERROR("use ctz64() instead of ffsll()\n" . $herecurr);
27618b6ee9aeSStefan Hajnoczi		}
27623f822cffSPaolo Bonzini		if ($line =~ /\bbzero\(/) {
27633f822cffSPaolo Bonzini			ERROR("use memset() instead of bzero()\n" . $herecurr);
27643f822cffSPaolo Bonzini		}
27656e938956SDr. David Alan Gilbert		my $non_exit_glib_asserts = qr{g_assert_cmpstr|
27666e938956SDr. David Alan Gilbert						g_assert_cmpint|
27676e938956SDr. David Alan Gilbert						g_assert_cmpuint|
27686e938956SDr. David Alan Gilbert						g_assert_cmphex|
27696e938956SDr. David Alan Gilbert						g_assert_cmpfloat|
27706e938956SDr. David Alan Gilbert						g_assert_true|
27716e938956SDr. David Alan Gilbert						g_assert_false|
27726e938956SDr. David Alan Gilbert						g_assert_nonnull|
27736e938956SDr. David Alan Gilbert						g_assert_null|
27746e938956SDr. David Alan Gilbert						g_assert_no_error|
27756e938956SDr. David Alan Gilbert						g_assert_error|
27766e938956SDr. David Alan Gilbert						g_test_assert_expected_messages|
27776e938956SDr. David Alan Gilbert						g_test_trap_assert_passed|
27786e938956SDr. David Alan Gilbert						g_test_trap_assert_stdout|
27796e938956SDr. David Alan Gilbert						g_test_trap_assert_stdout_unmatched|
27806e938956SDr. David Alan Gilbert						g_test_trap_assert_stderr|
27816e938956SDr. David Alan Gilbert						g_test_trap_assert_stderr_unmatched}x;
27826e938956SDr. David Alan Gilbert		if ($realfile !~ /^tests\// &&
27836e938956SDr. David Alan Gilbert			$line =~ /\b(?:$non_exit_glib_asserts)\(/) {
27846e938956SDr. David Alan Gilbert			ERROR("Use g_assert or g_assert_not_reached\n". $herecurr);
27856e938956SDr. David Alan Gilbert		}
27861ec3f6f9SBlue Swirl	}
27871ec3f6f9SBlue Swirl
27881ec3f6f9SBlue Swirl	# If we have no input at all, then there is nothing to report on
27891ec3f6f9SBlue Swirl	# so just keep quiet.
27901ec3f6f9SBlue Swirl	if ($#rawlines == -1) {
27911ec3f6f9SBlue Swirl		exit(0);
27921ec3f6f9SBlue Swirl	}
27931ec3f6f9SBlue Swirl
27941ec3f6f9SBlue Swirl	# In mailback mode only produce a report in the negative, for
27951ec3f6f9SBlue Swirl	# things that appear to be patches.
27961ec3f6f9SBlue Swirl	if ($mailback && ($clean == 1 || !$is_patch)) {
27971ec3f6f9SBlue Swirl		exit(0);
27981ec3f6f9SBlue Swirl	}
27991ec3f6f9SBlue Swirl
28001ec3f6f9SBlue Swirl	# This is not a patch, and we are are in 'no-patch' mode so
28011ec3f6f9SBlue Swirl	# just keep quiet.
28021ec3f6f9SBlue Swirl	if (!$chk_patch && !$is_patch) {
28031ec3f6f9SBlue Swirl		exit(0);
28041ec3f6f9SBlue Swirl	}
28051ec3f6f9SBlue Swirl
28061ec3f6f9SBlue Swirl	if (!$is_patch) {
28071ec3f6f9SBlue Swirl		ERROR("Does not appear to be a unified-diff format patch\n");
28081ec3f6f9SBlue Swirl	}
28091ec3f6f9SBlue Swirl	if ($is_patch && $chk_signoff && $signoff == 0) {
28101ec3f6f9SBlue Swirl		ERROR("Missing Signed-off-by: line(s)\n");
28111ec3f6f9SBlue Swirl	}
28121ec3f6f9SBlue Swirl
28131ec3f6f9SBlue Swirl	print report_dump();
28141ec3f6f9SBlue Swirl	if ($summary && !($clean == 1 && $quiet == 1)) {
28151ec3f6f9SBlue Swirl		print "$filename " if ($summary_file);
28161ec3f6f9SBlue Swirl		print "total: $cnt_error errors, $cnt_warn warnings, " .
28171ec3f6f9SBlue Swirl			"$cnt_lines lines checked\n";
28181ec3f6f9SBlue Swirl		print "\n" if ($quiet == 0);
28191ec3f6f9SBlue Swirl	}
28201ec3f6f9SBlue Swirl
28211ec3f6f9SBlue Swirl	if ($quiet == 0) {
28221ec3f6f9SBlue Swirl		# If there were whitespace errors which cleanpatch can fix
28231ec3f6f9SBlue Swirl		# then suggest that.
2824b6469683SBlue Swirl#		if ($rpt_cleaners) {
2825b6469683SBlue Swirl#			print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
2826b6469683SBlue Swirl#			print "      scripts/cleanfile\n\n";
2827b6469683SBlue Swirl#		}
28281ec3f6f9SBlue Swirl	}
28291ec3f6f9SBlue Swirl
28301ec3f6f9SBlue Swirl	if ($clean == 1 && $quiet == 0) {
28311ec3f6f9SBlue Swirl		print "$vname has no obvious style problems and is ready for submission.\n"
28321ec3f6f9SBlue Swirl	}
28331ec3f6f9SBlue Swirl	if ($clean == 0 && $quiet == 0) {
28341ec3f6f9SBlue Swirl		print "$vname has style problems, please review.  If any of these errors\n";
28351ec3f6f9SBlue Swirl		print "are false positives report them to the maintainer, see\n";
28361ec3f6f9SBlue Swirl		print "CHECKPATCH in MAINTAINERS.\n";
28371ec3f6f9SBlue Swirl	}
28381ec3f6f9SBlue Swirl
2839141de886SPaolo Bonzini	return ($no_warnings ? $clean : $cnt_error == 0);
28401ec3f6f9SBlue Swirl}
2841