xref: /linux-6.15/scripts/checkpatch.pl (revision 463f2864)
10a920b5bSAndy Whitcroft#!/usr/bin/perl -w
2f4432c5cSDave Jones# (c) 2001, Dave Jones. <[email protected]> (the file handling bit)
300df344fSAndy Whitcroft# (c) 2005, Joel Schopp <[email protected]> (the ugly bit)
42a5a2c25SAndy Whitcroft# (c) 2007,2008, Andy Whitcroft <[email protected]> (new conditions, test suite)
52a5a2c25SAndy Whitcroft# (c) 2008, Andy Whitcroft <[email protected]>
60a920b5bSAndy Whitcroft# Licensed under the terms of the GNU GPL License version 2
70a920b5bSAndy Whitcroft
80a920b5bSAndy Whitcroftuse strict;
90a920b5bSAndy Whitcroft
100a920b5bSAndy Whitcroftmy $P = $0;
1100df344fSAndy Whitcroft$P =~ s@.*/@@g;
120a920b5bSAndy Whitcroft
13bea5606dSAndy Whitcroftmy $V = '0.28';
140a920b5bSAndy Whitcroft
150a920b5bSAndy Whitcroftuse Getopt::Long qw(:config no_auto_abbrev);
160a920b5bSAndy Whitcroft
170a920b5bSAndy Whitcroftmy $quiet = 0;
180a920b5bSAndy Whitcroftmy $tree = 1;
190a920b5bSAndy Whitcroftmy $chk_signoff = 1;
200a920b5bSAndy Whitcroftmy $chk_patch = 1;
21773647a0SAndy Whitcroftmy $tst_only;
226c72ffaaSAndy Whitcroftmy $emacs = 0;
238905a67cSAndy Whitcroftmy $terse = 0;
246c72ffaaSAndy Whitcroftmy $file = 0;
256c72ffaaSAndy Whitcroftmy $check = 0;
268905a67cSAndy Whitcroftmy $summary = 1;
278905a67cSAndy Whitcroftmy $mailback = 0;
2813214adfSAndy Whitcroftmy $summary_file = 0;
296c72ffaaSAndy Whitcroftmy $root;
30c2fdda0dSAndy Whitcroftmy %debug;
310a920b5bSAndy WhitcroftGetOptions(
326c72ffaaSAndy Whitcroft	'q|quiet+'	=> \$quiet,
330a920b5bSAndy Whitcroft	'tree!'		=> \$tree,
340a920b5bSAndy Whitcroft	'signoff!'	=> \$chk_signoff,
350a920b5bSAndy Whitcroft	'patch!'	=> \$chk_patch,
366c72ffaaSAndy Whitcroft	'emacs!'	=> \$emacs,
378905a67cSAndy Whitcroft	'terse!'	=> \$terse,
386c72ffaaSAndy Whitcroft	'file!'		=> \$file,
396c72ffaaSAndy Whitcroft	'subjective!'	=> \$check,
406c72ffaaSAndy Whitcroft	'strict!'	=> \$check,
416c72ffaaSAndy Whitcroft	'root=s'	=> \$root,
428905a67cSAndy Whitcroft	'summary!'	=> \$summary,
438905a67cSAndy Whitcroft	'mailback!'	=> \$mailback,
4413214adfSAndy Whitcroft	'summary-file!'	=> \$summary_file,
4513214adfSAndy Whitcroft
46c2fdda0dSAndy Whitcroft	'debug=s'	=> \%debug,
47773647a0SAndy Whitcroft	'test-only=s'	=> \$tst_only,
480a920b5bSAndy Whitcroft) or exit;
490a920b5bSAndy Whitcroft
500a920b5bSAndy Whitcroftmy $exit = 0;
510a920b5bSAndy Whitcroft
520a920b5bSAndy Whitcroftif ($#ARGV < 0) {
5300df344fSAndy Whitcroft	print "usage: $P [options] patchfile\n";
540a920b5bSAndy Whitcroft	print "version: $V\n";
550a920b5bSAndy Whitcroft	print "options: -q               => quiet\n";
560a920b5bSAndy Whitcroft	print "         --no-tree        => run without a kernel tree\n";
578905a67cSAndy Whitcroft	print "         --terse          => one line per report\n";
586c72ffaaSAndy Whitcroft	print "         --emacs          => emacs compile window format\n";
596c72ffaaSAndy Whitcroft	print "         --file           => check a source file\n";
606c72ffaaSAndy Whitcroft	print "         --strict         => enable more subjective tests\n";
616c72ffaaSAndy Whitcroft	print "         --root           => path to the kernel tree root\n";
6213214adfSAndy Whitcroft	print "         --no-summary     => suppress the per-file summary\n";
6313214adfSAndy Whitcroft	print "         --summary-file   => include the filename in summary\n";
640a920b5bSAndy Whitcroft	exit(1);
650a920b5bSAndy Whitcroft}
660a920b5bSAndy Whitcroft
67c2fdda0dSAndy Whitcroftmy $dbg_values = 0;
68c2fdda0dSAndy Whitcroftmy $dbg_possible = 0;
697429c690SAndy Whitcroftmy $dbg_type = 0;
70a1ef277eSAndy Whitcroftmy $dbg_attr = 0;
71c2fdda0dSAndy Whitcroftfor my $key (keys %debug) {
7221caa13cSAndy Whitcroft	## no critic
7321caa13cSAndy Whitcroft	eval "\${dbg_$key} = '$debug{$key}';";
7421caa13cSAndy Whitcroft	die "$@" if ($@);
75c2fdda0dSAndy Whitcroft}
76c2fdda0dSAndy Whitcroft
778905a67cSAndy Whitcroftif ($terse) {
788905a67cSAndy Whitcroft	$emacs = 1;
798905a67cSAndy Whitcroft	$quiet++;
808905a67cSAndy Whitcroft}
818905a67cSAndy Whitcroft
826c72ffaaSAndy Whitcroftif ($tree) {
836c72ffaaSAndy Whitcroft	if (defined $root) {
846c72ffaaSAndy Whitcroft		if (!top_of_kernel_tree($root)) {
856c72ffaaSAndy Whitcroft			die "$P: $root: --root does not point at a valid tree\n";
866c72ffaaSAndy Whitcroft		}
876c72ffaaSAndy Whitcroft	} else {
886c72ffaaSAndy Whitcroft		if (top_of_kernel_tree('.')) {
896c72ffaaSAndy Whitcroft			$root = '.';
906c72ffaaSAndy Whitcroft		} elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
916c72ffaaSAndy Whitcroft						top_of_kernel_tree($1)) {
926c72ffaaSAndy Whitcroft			$root = $1;
936c72ffaaSAndy Whitcroft		}
946c72ffaaSAndy Whitcroft	}
956c72ffaaSAndy Whitcroft
966c72ffaaSAndy Whitcroft	if (!defined $root) {
970a920b5bSAndy Whitcroft		print "Must be run from the top-level dir. of a kernel tree\n";
980a920b5bSAndy Whitcroft		exit(2);
990a920b5bSAndy Whitcroft	}
1006c72ffaaSAndy Whitcroft}
1016c72ffaaSAndy Whitcroft
1026c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0;
1036c72ffaaSAndy Whitcroft
1046c72ffaaSAndy Whitcroftour $Ident       = qr{[A-Za-z_][A-Za-z\d_]*};
1056c72ffaaSAndy Whitcroftour $Storage	= qr{extern|static|asmlinkage};
1066c72ffaaSAndy Whitcroftour $Sparse	= qr{
1076c72ffaaSAndy Whitcroft			__user|
1086c72ffaaSAndy Whitcroft			__kernel|
1096c72ffaaSAndy Whitcroft			__force|
1106c72ffaaSAndy Whitcroft			__iomem|
1116c72ffaaSAndy Whitcroft			__must_check|
1126c72ffaaSAndy Whitcroft			__init_refok|
113417495edSAndy Whitcroft			__kprobes|
114417495edSAndy Whitcroft			__ref
1156c72ffaaSAndy Whitcroft		}x;
1166c72ffaaSAndy Whitcroftour $Attribute	= qr{
1176c72ffaaSAndy Whitcroft			const|
1186c72ffaaSAndy Whitcroft			__read_mostly|
1196c72ffaaSAndy Whitcroft			__kprobes|
12024e1d81aSAndy Whitcroft			__(?:mem|cpu|dev|)(?:initdata|init)|
12124e1d81aSAndy Whitcroft			____cacheline_aligned|
12224e1d81aSAndy Whitcroft			____cacheline_aligned_in_smp|
1235fe3af11SAndy Whitcroft			____cacheline_internodealigned_in_smp|
1245fe3af11SAndy Whitcroft			__weak
1256c72ffaaSAndy Whitcroft		  }x;
126c45dcabdSAndy Whitcroftour $Modifier;
1276c72ffaaSAndy Whitcroftour $Inline	= qr{inline|__always_inline|noinline};
1286c72ffaaSAndy Whitcroftour $Member	= qr{->$Ident|\.$Ident|\[[^]]*\]};
1296c72ffaaSAndy Whitcroftour $Lval	= qr{$Ident(?:$Member)*};
1306c72ffaaSAndy Whitcroft
1316c72ffaaSAndy Whitcroftour $Constant	= qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
1326c72ffaaSAndy Whitcroftour $Assignment	= qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
13386f9d059SAndy Whitcroftour $Compare    = qr{<=|>=|==|!=|<|>};
1346c72ffaaSAndy Whitcroftour $Operators	= qr{
1356c72ffaaSAndy Whitcroft			<=|>=|==|!=|
1366c72ffaaSAndy Whitcroft			=>|->|<<|>>|<|>|!|~|
137c2fdda0dSAndy Whitcroft			&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
1386c72ffaaSAndy Whitcroft		  }x;
1396c72ffaaSAndy Whitcroft
1408905a67cSAndy Whitcroftour $NonptrType;
1418905a67cSAndy Whitcroftour $Type;
1428905a67cSAndy Whitcroftour $Declare;
1438905a67cSAndy Whitcroft
144171ae1a4SAndy Whitcroftour $UTF8	= qr {
145171ae1a4SAndy Whitcroft	[\x09\x0A\x0D\x20-\x7E]              # ASCII
146171ae1a4SAndy Whitcroft	| [\xC2-\xDF][\x80-\xBF]             # non-overlong 2-byte
147171ae1a4SAndy Whitcroft	|  \xE0[\xA0-\xBF][\x80-\xBF]        # excluding overlongs
148171ae1a4SAndy Whitcroft	| [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}  # straight 3-byte
149171ae1a4SAndy Whitcroft	|  \xED[\x80-\x9F][\x80-\xBF]        # excluding surrogates
150171ae1a4SAndy Whitcroft	|  \xF0[\x90-\xBF][\x80-\xBF]{2}     # planes 1-3
151171ae1a4SAndy Whitcroft	| [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
152171ae1a4SAndy Whitcroft	|  \xF4[\x80-\x8F][\x80-\xBF]{2}     # plane 16
153171ae1a4SAndy Whitcroft}x;
154171ae1a4SAndy Whitcroft
1558ed22cadSAndy Whitcroftour $typeTypedefs = qr{(?x:
1568ed22cadSAndy Whitcroft	(?:__)?(?:u|s|be|le)(?:\d|\d\d)|
1578ed22cadSAndy Whitcroft	atomic_t
1588ed22cadSAndy Whitcroft)};
1598ed22cadSAndy Whitcroft
1608905a67cSAndy Whitcroftour @typeList = (
1618905a67cSAndy Whitcroft	qr{void},
162c45dcabdSAndy Whitcroft	qr{(?:unsigned\s+)?char},
163c45dcabdSAndy Whitcroft	qr{(?:unsigned\s+)?short},
164c45dcabdSAndy Whitcroft	qr{(?:unsigned\s+)?int},
165c45dcabdSAndy Whitcroft	qr{(?:unsigned\s+)?long},
166c45dcabdSAndy Whitcroft	qr{(?:unsigned\s+)?long\s+int},
167c45dcabdSAndy Whitcroft	qr{(?:unsigned\s+)?long\s+long},
168c45dcabdSAndy Whitcroft	qr{(?:unsigned\s+)?long\s+long\s+int},
1698905a67cSAndy Whitcroft	qr{unsigned},
1708905a67cSAndy Whitcroft	qr{float},
1718905a67cSAndy Whitcroft	qr{double},
1728905a67cSAndy Whitcroft	qr{bool},
1738905a67cSAndy Whitcroft	qr{struct\s+$Ident},
1748905a67cSAndy Whitcroft	qr{union\s+$Ident},
1758905a67cSAndy Whitcroft	qr{enum\s+$Ident},
1768905a67cSAndy Whitcroft	qr{${Ident}_t},
1778905a67cSAndy Whitcroft	qr{${Ident}_handler},
1788905a67cSAndy Whitcroft	qr{${Ident}_handler_fn},
1798905a67cSAndy Whitcroft);
180c45dcabdSAndy Whitcroftour @modifierList = (
181c45dcabdSAndy Whitcroft	qr{fastcall},
182c45dcabdSAndy Whitcroft);
1838905a67cSAndy Whitcroft
1848905a67cSAndy Whitcroftsub build_types {
185d2172eb5SAndy Whitcroft	my $mods = "(?x:  \n" . join("|\n  ", @modifierList) . "\n)";
186d2172eb5SAndy Whitcroft	my $all = "(?x:  \n" . join("|\n  ", @typeList) . "\n)";
187c8cb2ca3SAndy Whitcroft	$Modifier	= qr{(?:$Attribute|$Sparse|$mods)};
1888905a67cSAndy Whitcroft	$NonptrType	= qr{
189d2172eb5SAndy Whitcroft			(?:$Modifier\s+|const\s+)*
190cf655043SAndy Whitcroft			(?:
191c45dcabdSAndy Whitcroft				(?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
1928ed22cadSAndy Whitcroft				(?:$typeTypedefs\b)|
193c45dcabdSAndy Whitcroft				(?:${all}\b)
194cf655043SAndy Whitcroft			)
195c8cb2ca3SAndy Whitcroft			(?:\s+$Modifier|\s+const)*
1968905a67cSAndy Whitcroft		  }x;
1978905a67cSAndy Whitcroft	$Type	= qr{
198c45dcabdSAndy Whitcroft			$NonptrType
19965863862SAndy Whitcroft			(?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
200c8cb2ca3SAndy Whitcroft			(?:\s+$Inline|\s+$Modifier)*
2018905a67cSAndy Whitcroft		  }x;
2028905a67cSAndy Whitcroft	$Declare	= qr{(?:$Storage\s+)?$Type};
2038905a67cSAndy Whitcroft}
2048905a67cSAndy Whitcroftbuild_types();
2056c72ffaaSAndy Whitcroft
2066c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file);
2070a920b5bSAndy Whitcroft
2084a0df2efSAndy Whitcroftmy @dep_includes = ();
2094a0df2efSAndy Whitcroftmy @dep_functions = ();
2106c72ffaaSAndy Whitcroftmy $removal = "Documentation/feature-removal-schedule.txt";
2116c72ffaaSAndy Whitcroftif ($tree && -f "$root/$removal") {
21221caa13cSAndy Whitcroft	open(my $REMOVE, '<', "$root/$removal") ||
2136c72ffaaSAndy Whitcroft				die "$P: $removal: open failed - $!\n";
21421caa13cSAndy Whitcroft	while (<$REMOVE>) {
215f0a594c1SAndy Whitcroft		if (/^Check:\s+(.*\S)/) {
216f0a594c1SAndy Whitcroft			for my $entry (split(/[, ]+/, $1)) {
217f0a594c1SAndy Whitcroft				if ($entry =~ m@include/(.*)@) {
2184a0df2efSAndy Whitcroft					push(@dep_includes, $1);
2194a0df2efSAndy Whitcroft
220f0a594c1SAndy Whitcroft				} elsif ($entry !~ m@/@) {
221f0a594c1SAndy Whitcroft					push(@dep_functions, $entry);
222f0a594c1SAndy Whitcroft				}
2234a0df2efSAndy Whitcroft			}
2240a920b5bSAndy Whitcroft		}
2250a920b5bSAndy Whitcroft	}
22621caa13cSAndy Whitcroft	close($REMOVE);
2270a920b5bSAndy Whitcroft}
2280a920b5bSAndy Whitcroft
22900df344fSAndy Whitcroftmy @rawlines = ();
230c2fdda0dSAndy Whitcroftmy @lines = ();
231c2fdda0dSAndy Whitcroftmy $vname;
2326c72ffaaSAndy Whitcroftfor my $filename (@ARGV) {
23321caa13cSAndy Whitcroft	my $FILE;
2346c72ffaaSAndy Whitcroft	if ($file) {
23521caa13cSAndy Whitcroft		open($FILE, '-|', "diff -u /dev/null $filename") ||
2366c72ffaaSAndy Whitcroft			die "$P: $filename: diff failed - $!\n";
23721caa13cSAndy Whitcroft	} elsif ($filename eq '-') {
23821caa13cSAndy Whitcroft		open($FILE, '<&STDIN');
2396c72ffaaSAndy Whitcroft	} else {
24021caa13cSAndy Whitcroft		open($FILE, '<', "$filename") ||
2416c72ffaaSAndy Whitcroft			die "$P: $filename: open failed - $!\n";
2426c72ffaaSAndy Whitcroft	}
243c2fdda0dSAndy Whitcroft	if ($filename eq '-') {
244c2fdda0dSAndy Whitcroft		$vname = 'Your patch';
245c2fdda0dSAndy Whitcroft	} else {
246c2fdda0dSAndy Whitcroft		$vname = $filename;
247c2fdda0dSAndy Whitcroft	}
24821caa13cSAndy Whitcroft	while (<$FILE>) {
2490a920b5bSAndy Whitcroft		chomp;
25000df344fSAndy Whitcroft		push(@rawlines, $_);
2516c72ffaaSAndy Whitcroft	}
25221caa13cSAndy Whitcroft	close($FILE);
253c2fdda0dSAndy Whitcroft	if (!process($filename)) {
2540a920b5bSAndy Whitcroft		$exit = 1;
2550a920b5bSAndy Whitcroft	}
25600df344fSAndy Whitcroft	@rawlines = ();
25713214adfSAndy Whitcroft	@lines = ();
2580a920b5bSAndy Whitcroft}
2590a920b5bSAndy Whitcroft
2600a920b5bSAndy Whitcroftexit($exit);
2610a920b5bSAndy Whitcroft
2620a920b5bSAndy Whitcroftsub top_of_kernel_tree {
2636c72ffaaSAndy Whitcroft	my ($root) = @_;
2646c72ffaaSAndy Whitcroft
2656c72ffaaSAndy Whitcroft	my @tree_check = (
2666c72ffaaSAndy Whitcroft		"COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
2676c72ffaaSAndy Whitcroft		"README", "Documentation", "arch", "include", "drivers",
2686c72ffaaSAndy Whitcroft		"fs", "init", "ipc", "kernel", "lib", "scripts",
2696c72ffaaSAndy Whitcroft	);
2706c72ffaaSAndy Whitcroft
2716c72ffaaSAndy Whitcroft	foreach my $check (@tree_check) {
2726c72ffaaSAndy Whitcroft		if (! -e $root . '/' . $check) {
2730a920b5bSAndy Whitcroft			return 0;
2740a920b5bSAndy Whitcroft		}
2756c72ffaaSAndy Whitcroft	}
2766c72ffaaSAndy Whitcroft	return 1;
2776c72ffaaSAndy Whitcroft}
2780a920b5bSAndy Whitcroft
2790a920b5bSAndy Whitcroftsub expand_tabs {
2800a920b5bSAndy Whitcroft	my ($str) = @_;
2810a920b5bSAndy Whitcroft
2820a920b5bSAndy Whitcroft	my $res = '';
2830a920b5bSAndy Whitcroft	my $n = 0;
2840a920b5bSAndy Whitcroft	for my $c (split(//, $str)) {
2850a920b5bSAndy Whitcroft		if ($c eq "\t") {
2860a920b5bSAndy Whitcroft			$res .= ' ';
2870a920b5bSAndy Whitcroft			$n++;
2880a920b5bSAndy Whitcroft			for (; ($n % 8) != 0; $n++) {
2890a920b5bSAndy Whitcroft				$res .= ' ';
2900a920b5bSAndy Whitcroft			}
2910a920b5bSAndy Whitcroft			next;
2920a920b5bSAndy Whitcroft		}
2930a920b5bSAndy Whitcroft		$res .= $c;
2940a920b5bSAndy Whitcroft		$n++;
2950a920b5bSAndy Whitcroft	}
2960a920b5bSAndy Whitcroft
2970a920b5bSAndy Whitcroft	return $res;
2980a920b5bSAndy Whitcroft}
2996c72ffaaSAndy Whitcroftsub copy_spacing {
300773647a0SAndy Whitcroft	(my $res = shift) =~ tr/\t/ /c;
3016c72ffaaSAndy Whitcroft	return $res;
3026c72ffaaSAndy Whitcroft}
3030a920b5bSAndy Whitcroft
3044a0df2efSAndy Whitcroftsub line_stats {
3054a0df2efSAndy Whitcroft	my ($line) = @_;
3064a0df2efSAndy Whitcroft
3074a0df2efSAndy Whitcroft	# Drop the diff line leader and expand tabs
3084a0df2efSAndy Whitcroft	$line =~ s/^.//;
3094a0df2efSAndy Whitcroft	$line = expand_tabs($line);
3104a0df2efSAndy Whitcroft
3114a0df2efSAndy Whitcroft	# Pick the indent from the front of the line.
3124a0df2efSAndy Whitcroft	my ($white) = ($line =~ /^(\s*)/);
3134a0df2efSAndy Whitcroft
3144a0df2efSAndy Whitcroft	return (length($line), length($white));
3154a0df2efSAndy Whitcroft}
3164a0df2efSAndy Whitcroft
317773647a0SAndy Whitcroftmy $sanitise_quote = '';
318773647a0SAndy Whitcroft
319773647a0SAndy Whitcroftsub sanitise_line_reset {
320773647a0SAndy Whitcroft	my ($in_comment) = @_;
321773647a0SAndy Whitcroft
322773647a0SAndy Whitcroft	if ($in_comment) {
323773647a0SAndy Whitcroft		$sanitise_quote = '*/';
324773647a0SAndy Whitcroft	} else {
325773647a0SAndy Whitcroft		$sanitise_quote = '';
326773647a0SAndy Whitcroft	}
327773647a0SAndy Whitcroft}
32800df344fSAndy Whitcroftsub sanitise_line {
32900df344fSAndy Whitcroft	my ($line) = @_;
33000df344fSAndy Whitcroft
33100df344fSAndy Whitcroft	my $res = '';
33200df344fSAndy Whitcroft	my $l = '';
33300df344fSAndy Whitcroft
334c2fdda0dSAndy Whitcroft	my $qlen = 0;
335773647a0SAndy Whitcroft	my $off = 0;
336773647a0SAndy Whitcroft	my $c;
33700df344fSAndy Whitcroft
338773647a0SAndy Whitcroft	# Always copy over the diff marker.
339773647a0SAndy Whitcroft	$res = substr($line, 0, 1);
340773647a0SAndy Whitcroft
341773647a0SAndy Whitcroft	for ($off = 1; $off < length($line); $off++) {
342773647a0SAndy Whitcroft		$c = substr($line, $off, 1);
343773647a0SAndy Whitcroft
344773647a0SAndy Whitcroft		# Comments we are wacking completly including the begin
345773647a0SAndy Whitcroft		# and end, all to $;.
346773647a0SAndy Whitcroft		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
347773647a0SAndy Whitcroft			$sanitise_quote = '*/';
348773647a0SAndy Whitcroft
349773647a0SAndy Whitcroft			substr($res, $off, 2, "$;$;");
350773647a0SAndy Whitcroft			$off++;
35100df344fSAndy Whitcroft			next;
352773647a0SAndy Whitcroft		}
35381bc0e02SAndy Whitcroft		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
354773647a0SAndy Whitcroft			$sanitise_quote = '';
355773647a0SAndy Whitcroft			substr($res, $off, 2, "$;$;");
356773647a0SAndy Whitcroft			$off++;
357773647a0SAndy Whitcroft			next;
358773647a0SAndy Whitcroft		}
359773647a0SAndy Whitcroft
360773647a0SAndy Whitcroft		# A \ in a string means ignore the next character.
361773647a0SAndy Whitcroft		if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
362773647a0SAndy Whitcroft		    $c eq "\\") {
363773647a0SAndy Whitcroft			substr($res, $off, 2, 'XX');
364773647a0SAndy Whitcroft			$off++;
365773647a0SAndy Whitcroft			next;
366773647a0SAndy Whitcroft		}
367773647a0SAndy Whitcroft		# Regular quotes.
368773647a0SAndy Whitcroft		if ($c eq "'" || $c eq '"') {
369773647a0SAndy Whitcroft			if ($sanitise_quote eq '') {
370773647a0SAndy Whitcroft				$sanitise_quote = $c;
371773647a0SAndy Whitcroft
372773647a0SAndy Whitcroft				substr($res, $off, 1, $c);
373773647a0SAndy Whitcroft				next;
374773647a0SAndy Whitcroft			} elsif ($sanitise_quote eq $c) {
375773647a0SAndy Whitcroft				$sanitise_quote = '';
37600df344fSAndy Whitcroft			}
37700df344fSAndy Whitcroft		}
378773647a0SAndy Whitcroft
379fae17daeSAndy Whitcroft		#print "c<$c> SQ<$sanitise_quote>\n";
380773647a0SAndy Whitcroft		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
381773647a0SAndy Whitcroft			substr($res, $off, 1, $;);
382773647a0SAndy Whitcroft		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
383773647a0SAndy Whitcroft			substr($res, $off, 1, 'X');
38400df344fSAndy Whitcroft		} else {
385773647a0SAndy Whitcroft			substr($res, $off, 1, $c);
38600df344fSAndy Whitcroft		}
387c2fdda0dSAndy Whitcroft	}
388c2fdda0dSAndy Whitcroft
389c2fdda0dSAndy Whitcroft	# The pathname on a #include may be surrounded by '<' and '>'.
390c45dcabdSAndy Whitcroft	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
391c2fdda0dSAndy Whitcroft		my $clean = 'X' x length($1);
392c2fdda0dSAndy Whitcroft		$res =~ s@\<.*\>@<$clean>@;
393c2fdda0dSAndy Whitcroft
394c2fdda0dSAndy Whitcroft	# The whole of a #error is a string.
395c45dcabdSAndy Whitcroft	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
396c2fdda0dSAndy Whitcroft		my $clean = 'X' x length($1);
397c45dcabdSAndy Whitcroft		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
398c2fdda0dSAndy Whitcroft	}
399c2fdda0dSAndy Whitcroft
40000df344fSAndy Whitcroft	return $res;
40100df344fSAndy Whitcroft}
40200df344fSAndy Whitcroft
4038905a67cSAndy Whitcroftsub ctx_statement_block {
4048905a67cSAndy Whitcroft	my ($linenr, $remain, $off) = @_;
4058905a67cSAndy Whitcroft	my $line = $linenr - 1;
4068905a67cSAndy Whitcroft	my $blk = '';
4078905a67cSAndy Whitcroft	my $soff = $off;
4088905a67cSAndy Whitcroft	my $coff = $off - 1;
409773647a0SAndy Whitcroft	my $coff_set = 0;
4108905a67cSAndy Whitcroft
41113214adfSAndy Whitcroft	my $loff = 0;
41213214adfSAndy Whitcroft
4138905a67cSAndy Whitcroft	my $type = '';
4148905a67cSAndy Whitcroft	my $level = 0;
415a2750645SAndy Whitcroft	my @stack = ();
416cf655043SAndy Whitcroft	my $p;
4178905a67cSAndy Whitcroft	my $c;
4188905a67cSAndy Whitcroft	my $len = 0;
41913214adfSAndy Whitcroft
42013214adfSAndy Whitcroft	my $remainder;
4218905a67cSAndy Whitcroft	while (1) {
422a2750645SAndy Whitcroft		@stack = (['', 0]) if ($#stack == -1);
423a2750645SAndy Whitcroft
424773647a0SAndy Whitcroft		#warn "CSB: blk<$blk> remain<$remain>\n";
4258905a67cSAndy Whitcroft		# If we are about to drop off the end, pull in more
4268905a67cSAndy Whitcroft		# context.
4278905a67cSAndy Whitcroft		if ($off >= $len) {
4288905a67cSAndy Whitcroft			for (; $remain > 0; $line++) {
429dea33496SAndy Whitcroft				last if (!defined $lines[$line]);
430c2fdda0dSAndy Whitcroft				next if ($lines[$line] =~ /^-/);
4318905a67cSAndy Whitcroft				$remain--;
43213214adfSAndy Whitcroft				$loff = $len;
433c2fdda0dSAndy Whitcroft				$blk .= $lines[$line] . "\n";
4348905a67cSAndy Whitcroft				$len = length($blk);
4358905a67cSAndy Whitcroft				$line++;
4368905a67cSAndy Whitcroft				last;
4378905a67cSAndy Whitcroft			}
4388905a67cSAndy Whitcroft			# Bail if there is no further context.
4398905a67cSAndy Whitcroft			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
44013214adfSAndy Whitcroft			if ($off >= $len) {
4418905a67cSAndy Whitcroft				last;
4428905a67cSAndy Whitcroft			}
4438905a67cSAndy Whitcroft		}
444cf655043SAndy Whitcroft		$p = $c;
4458905a67cSAndy Whitcroft		$c = substr($blk, $off, 1);
44613214adfSAndy Whitcroft		$remainder = substr($blk, $off);
4478905a67cSAndy Whitcroft
448773647a0SAndy Whitcroft		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
4494635f4fbSAndy Whitcroft
4504635f4fbSAndy Whitcroft		# Handle nested #if/#else.
4514635f4fbSAndy Whitcroft		if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
4524635f4fbSAndy Whitcroft			push(@stack, [ $type, $level ]);
4534635f4fbSAndy Whitcroft		} elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
4544635f4fbSAndy Whitcroft			($type, $level) = @{$stack[$#stack - 1]};
4554635f4fbSAndy Whitcroft		} elsif ($remainder =~ /^#\s*endif\b/) {
4564635f4fbSAndy Whitcroft			($type, $level) = @{pop(@stack)};
4574635f4fbSAndy Whitcroft		}
4584635f4fbSAndy Whitcroft
4598905a67cSAndy Whitcroft		# Statement ends at the ';' or a close '}' at the
4608905a67cSAndy Whitcroft		# outermost level.
4618905a67cSAndy Whitcroft		if ($level == 0 && $c eq ';') {
4628905a67cSAndy Whitcroft			last;
4638905a67cSAndy Whitcroft		}
4648905a67cSAndy Whitcroft
46513214adfSAndy Whitcroft		# An else is really a conditional as long as its not else if
466773647a0SAndy Whitcroft		if ($level == 0 && $coff_set == 0 &&
467773647a0SAndy Whitcroft				(!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
468773647a0SAndy Whitcroft				$remainder =~ /^(else)(?:\s|{)/ &&
469773647a0SAndy Whitcroft				$remainder !~ /^else\s+if\b/) {
470773647a0SAndy Whitcroft			$coff = $off + length($1) - 1;
471773647a0SAndy Whitcroft			$coff_set = 1;
472773647a0SAndy Whitcroft			#warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
473773647a0SAndy Whitcroft			#warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
47413214adfSAndy Whitcroft		}
47513214adfSAndy Whitcroft
4768905a67cSAndy Whitcroft		if (($type eq '' || $type eq '(') && $c eq '(') {
4778905a67cSAndy Whitcroft			$level++;
4788905a67cSAndy Whitcroft			$type = '(';
4798905a67cSAndy Whitcroft		}
4808905a67cSAndy Whitcroft		if ($type eq '(' && $c eq ')') {
4818905a67cSAndy Whitcroft			$level--;
4828905a67cSAndy Whitcroft			$type = ($level != 0)? '(' : '';
4838905a67cSAndy Whitcroft
4848905a67cSAndy Whitcroft			if ($level == 0 && $coff < $soff) {
4858905a67cSAndy Whitcroft				$coff = $off;
486773647a0SAndy Whitcroft				$coff_set = 1;
487773647a0SAndy Whitcroft				#warn "CSB: mark coff<$coff>\n";
4888905a67cSAndy Whitcroft			}
4898905a67cSAndy Whitcroft		}
4908905a67cSAndy Whitcroft		if (($type eq '' || $type eq '{') && $c eq '{') {
4918905a67cSAndy Whitcroft			$level++;
4928905a67cSAndy Whitcroft			$type = '{';
4938905a67cSAndy Whitcroft		}
4948905a67cSAndy Whitcroft		if ($type eq '{' && $c eq '}') {
4958905a67cSAndy Whitcroft			$level--;
4968905a67cSAndy Whitcroft			$type = ($level != 0)? '{' : '';
4978905a67cSAndy Whitcroft
4988905a67cSAndy Whitcroft			if ($level == 0) {
4998905a67cSAndy Whitcroft				last;
5008905a67cSAndy Whitcroft			}
5018905a67cSAndy Whitcroft		}
5028905a67cSAndy Whitcroft		$off++;
5038905a67cSAndy Whitcroft	}
504a3bb97a7SAndy Whitcroft	# We are truly at the end, so shuffle to the next line.
50513214adfSAndy Whitcroft	if ($off == $len) {
506a3bb97a7SAndy Whitcroft		$loff = $len + 1;
50713214adfSAndy Whitcroft		$line++;
50813214adfSAndy Whitcroft		$remain--;
50913214adfSAndy Whitcroft	}
5108905a67cSAndy Whitcroft
5118905a67cSAndy Whitcroft	my $statement = substr($blk, $soff, $off - $soff + 1);
5128905a67cSAndy Whitcroft	my $condition = substr($blk, $soff, $coff - $soff + 1);
5138905a67cSAndy Whitcroft
5148905a67cSAndy Whitcroft	#warn "STATEMENT<$statement>\n";
5158905a67cSAndy Whitcroft	#warn "CONDITION<$condition>\n";
5168905a67cSAndy Whitcroft
517773647a0SAndy Whitcroft	#print "coff<$coff> soff<$off> loff<$loff>\n";
51813214adfSAndy Whitcroft
51913214adfSAndy Whitcroft	return ($statement, $condition,
52013214adfSAndy Whitcroft			$line, $remain + 1, $off - $loff + 1, $level);
52113214adfSAndy Whitcroft}
52213214adfSAndy Whitcroft
523cf655043SAndy Whitcroftsub statement_lines {
524cf655043SAndy Whitcroft	my ($stmt) = @_;
525cf655043SAndy Whitcroft
526cf655043SAndy Whitcroft	# Strip the diff line prefixes and rip blank lines at start and end.
527cf655043SAndy Whitcroft	$stmt =~ s/(^|\n)./$1/g;
528cf655043SAndy Whitcroft	$stmt =~ s/^\s*//;
529cf655043SAndy Whitcroft	$stmt =~ s/\s*$//;
530cf655043SAndy Whitcroft
531cf655043SAndy Whitcroft	my @stmt_lines = ($stmt =~ /\n/g);
532cf655043SAndy Whitcroft
533cf655043SAndy Whitcroft	return $#stmt_lines + 2;
534cf655043SAndy Whitcroft}
535cf655043SAndy Whitcroft
536cf655043SAndy Whitcroftsub statement_rawlines {
537cf655043SAndy Whitcroft	my ($stmt) = @_;
538cf655043SAndy Whitcroft
539cf655043SAndy Whitcroft	my @stmt_lines = ($stmt =~ /\n/g);
540cf655043SAndy Whitcroft
541cf655043SAndy Whitcroft	return $#stmt_lines + 2;
542cf655043SAndy Whitcroft}
543cf655043SAndy Whitcroft
544cf655043SAndy Whitcroftsub statement_block_size {
545cf655043SAndy Whitcroft	my ($stmt) = @_;
546cf655043SAndy Whitcroft
547cf655043SAndy Whitcroft	$stmt =~ s/(^|\n)./$1/g;
548cf655043SAndy Whitcroft	$stmt =~ s/^\s*{//;
549cf655043SAndy Whitcroft	$stmt =~ s/}\s*$//;
550cf655043SAndy Whitcroft	$stmt =~ s/^\s*//;
551cf655043SAndy Whitcroft	$stmt =~ s/\s*$//;
552cf655043SAndy Whitcroft
553cf655043SAndy Whitcroft	my @stmt_lines = ($stmt =~ /\n/g);
554cf655043SAndy Whitcroft	my @stmt_statements = ($stmt =~ /;/g);
555cf655043SAndy Whitcroft
556cf655043SAndy Whitcroft	my $stmt_lines = $#stmt_lines + 2;
557cf655043SAndy Whitcroft	my $stmt_statements = $#stmt_statements + 1;
558cf655043SAndy Whitcroft
559cf655043SAndy Whitcroft	if ($stmt_lines > $stmt_statements) {
560cf655043SAndy Whitcroft		return $stmt_lines;
561cf655043SAndy Whitcroft	} else {
562cf655043SAndy Whitcroft		return $stmt_statements;
563cf655043SAndy Whitcroft	}
564cf655043SAndy Whitcroft}
565cf655043SAndy Whitcroft
56613214adfSAndy Whitcroftsub ctx_statement_full {
56713214adfSAndy Whitcroft	my ($linenr, $remain, $off) = @_;
56813214adfSAndy Whitcroft	my ($statement, $condition, $level);
56913214adfSAndy Whitcroft
57013214adfSAndy Whitcroft	my (@chunks);
57113214adfSAndy Whitcroft
572cf655043SAndy Whitcroft	# Grab the first conditional/block pair.
57313214adfSAndy Whitcroft	($statement, $condition, $linenr, $remain, $off, $level) =
57413214adfSAndy Whitcroft				ctx_statement_block($linenr, $remain, $off);
575773647a0SAndy Whitcroft	#print "F: c<$condition> s<$statement> remain<$remain>\n";
57613214adfSAndy Whitcroft	push(@chunks, [ $condition, $statement ]);
577cf655043SAndy Whitcroft	if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
578cf655043SAndy Whitcroft		return ($level, $linenr, @chunks);
579cf655043SAndy Whitcroft	}
580cf655043SAndy Whitcroft
581cf655043SAndy Whitcroft	# Pull in the following conditional/block pairs and see if they
582cf655043SAndy Whitcroft	# could continue the statement.
583cf655043SAndy Whitcroft	for (;;) {
58413214adfSAndy Whitcroft		($statement, $condition, $linenr, $remain, $off, $level) =
58513214adfSAndy Whitcroft				ctx_statement_block($linenr, $remain, $off);
586cf655043SAndy Whitcroft		#print "C: c<$condition> s<$statement> remain<$remain>\n";
587773647a0SAndy Whitcroft		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
588cf655043SAndy Whitcroft		#print "C: push\n";
589cf655043SAndy Whitcroft		push(@chunks, [ $condition, $statement ]);
59013214adfSAndy Whitcroft	}
59113214adfSAndy Whitcroft
59213214adfSAndy Whitcroft	return ($level, $linenr, @chunks);
5938905a67cSAndy Whitcroft}
5948905a67cSAndy Whitcroft
5954a0df2efSAndy Whitcroftsub ctx_block_get {
596f0a594c1SAndy Whitcroft	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
5974a0df2efSAndy Whitcroft	my $line;
5984a0df2efSAndy Whitcroft	my $start = $linenr - 1;
5994a0df2efSAndy Whitcroft	my $blk = '';
6004a0df2efSAndy Whitcroft	my @o;
6014a0df2efSAndy Whitcroft	my @c;
6024a0df2efSAndy Whitcroft	my @res = ();
6034a0df2efSAndy Whitcroft
604f0a594c1SAndy Whitcroft	my $level = 0;
6054635f4fbSAndy Whitcroft	my @stack = ($level);
60600df344fSAndy Whitcroft	for ($line = $start; $remain > 0; $line++) {
60700df344fSAndy Whitcroft		next if ($rawlines[$line] =~ /^-/);
60800df344fSAndy Whitcroft		$remain--;
60900df344fSAndy Whitcroft
61000df344fSAndy Whitcroft		$blk .= $rawlines[$line];
6114635f4fbSAndy Whitcroft
6124635f4fbSAndy Whitcroft		# Handle nested #if/#else.
6134635f4fbSAndy Whitcroft		if ($rawlines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
6144635f4fbSAndy Whitcroft			push(@stack, $level);
6154635f4fbSAndy Whitcroft		} elsif ($rawlines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
6164635f4fbSAndy Whitcroft			$level = $stack[$#stack - 1];
6174635f4fbSAndy Whitcroft		} elsif ($rawlines[$line] =~ /^.\s*#\s*endif\b/) {
6184635f4fbSAndy Whitcroft			$level = pop(@stack);
6194635f4fbSAndy Whitcroft		}
6204635f4fbSAndy Whitcroft
621f0a594c1SAndy Whitcroft		foreach my $c (split(//, $rawlines[$line])) {
622f0a594c1SAndy Whitcroft			##print "C<$c>L<$level><$open$close>O<$off>\n";
623f0a594c1SAndy Whitcroft			if ($off > 0) {
624f0a594c1SAndy Whitcroft				$off--;
625f0a594c1SAndy Whitcroft				next;
626f0a594c1SAndy Whitcroft			}
6274a0df2efSAndy Whitcroft
628f0a594c1SAndy Whitcroft			if ($c eq $close && $level > 0) {
629f0a594c1SAndy Whitcroft				$level--;
630f0a594c1SAndy Whitcroft				last if ($level == 0);
631f0a594c1SAndy Whitcroft			} elsif ($c eq $open) {
632f0a594c1SAndy Whitcroft				$level++;
633f0a594c1SAndy Whitcroft			}
634f0a594c1SAndy Whitcroft		}
6354a0df2efSAndy Whitcroft
636f0a594c1SAndy Whitcroft		if (!$outer || $level <= 1) {
63700df344fSAndy Whitcroft			push(@res, $rawlines[$line]);
6384a0df2efSAndy Whitcroft		}
6394a0df2efSAndy Whitcroft
640f0a594c1SAndy Whitcroft		last if ($level == 0);
6414a0df2efSAndy Whitcroft	}
6424a0df2efSAndy Whitcroft
643f0a594c1SAndy Whitcroft	return ($level, @res);
6444a0df2efSAndy Whitcroft}
6454a0df2efSAndy Whitcroftsub ctx_block_outer {
6464a0df2efSAndy Whitcroft	my ($linenr, $remain) = @_;
6474a0df2efSAndy Whitcroft
648f0a594c1SAndy Whitcroft	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
649f0a594c1SAndy Whitcroft	return @r;
6504a0df2efSAndy Whitcroft}
6514a0df2efSAndy Whitcroftsub ctx_block {
6524a0df2efSAndy Whitcroft	my ($linenr, $remain) = @_;
6534a0df2efSAndy Whitcroft
654f0a594c1SAndy Whitcroft	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
655f0a594c1SAndy Whitcroft	return @r;
656653d4876SAndy Whitcroft}
657653d4876SAndy Whitcroftsub ctx_statement {
658f0a594c1SAndy Whitcroft	my ($linenr, $remain, $off) = @_;
659f0a594c1SAndy Whitcroft
660f0a594c1SAndy Whitcroft	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
661f0a594c1SAndy Whitcroft	return @r;
662f0a594c1SAndy Whitcroft}
663f0a594c1SAndy Whitcroftsub ctx_block_level {
664653d4876SAndy Whitcroft	my ($linenr, $remain) = @_;
665653d4876SAndy Whitcroft
666f0a594c1SAndy Whitcroft	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
6674a0df2efSAndy Whitcroft}
6689c0ca6f9SAndy Whitcroftsub ctx_statement_level {
6699c0ca6f9SAndy Whitcroft	my ($linenr, $remain, $off) = @_;
6709c0ca6f9SAndy Whitcroft
6719c0ca6f9SAndy Whitcroft	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
6729c0ca6f9SAndy Whitcroft}
6734a0df2efSAndy Whitcroft
6744a0df2efSAndy Whitcroftsub ctx_locate_comment {
6754a0df2efSAndy Whitcroft	my ($first_line, $end_line) = @_;
6764a0df2efSAndy Whitcroft
6774a0df2efSAndy Whitcroft	# Catch a comment on the end of the line itself.
678beae6332SAndy Whitcroft	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
6794a0df2efSAndy Whitcroft	return $current_comment if (defined $current_comment);
6804a0df2efSAndy Whitcroft
6814a0df2efSAndy Whitcroft	# Look through the context and try and figure out if there is a
6824a0df2efSAndy Whitcroft	# comment.
6834a0df2efSAndy Whitcroft	my $in_comment = 0;
6844a0df2efSAndy Whitcroft	$current_comment = '';
6854a0df2efSAndy Whitcroft	for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
68600df344fSAndy Whitcroft		my $line = $rawlines[$linenr - 1];
68700df344fSAndy Whitcroft		#warn "           $line\n";
6884a0df2efSAndy Whitcroft		if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
6894a0df2efSAndy Whitcroft			$in_comment = 1;
6904a0df2efSAndy Whitcroft		}
6914a0df2efSAndy Whitcroft		if ($line =~ m@/\*@) {
6924a0df2efSAndy Whitcroft			$in_comment = 1;
6934a0df2efSAndy Whitcroft		}
6944a0df2efSAndy Whitcroft		if (!$in_comment && $current_comment ne '') {
6954a0df2efSAndy Whitcroft			$current_comment = '';
6964a0df2efSAndy Whitcroft		}
6974a0df2efSAndy Whitcroft		$current_comment .= $line . "\n" if ($in_comment);
6984a0df2efSAndy Whitcroft		if ($line =~ m@\*/@) {
6994a0df2efSAndy Whitcroft			$in_comment = 0;
7004a0df2efSAndy Whitcroft		}
7014a0df2efSAndy Whitcroft	}
7024a0df2efSAndy Whitcroft
7034a0df2efSAndy Whitcroft	chomp($current_comment);
7044a0df2efSAndy Whitcroft	return($current_comment);
7054a0df2efSAndy Whitcroft}
7064a0df2efSAndy Whitcroftsub ctx_has_comment {
7074a0df2efSAndy Whitcroft	my ($first_line, $end_line) = @_;
7084a0df2efSAndy Whitcroft	my $cmt = ctx_locate_comment($first_line, $end_line);
7094a0df2efSAndy Whitcroft
71000df344fSAndy Whitcroft	##print "LINE: $rawlines[$end_line - 1 ]\n";
7114a0df2efSAndy Whitcroft	##print "CMMT: $cmt\n";
7124a0df2efSAndy Whitcroft
7134a0df2efSAndy Whitcroft	return ($cmt ne '');
7144a0df2efSAndy Whitcroft}
7154a0df2efSAndy Whitcroft
7164d001e4dSAndy Whitcroftsub raw_line {
7174d001e4dSAndy Whitcroft	my ($linenr, $cnt) = @_;
7184d001e4dSAndy Whitcroft
7194d001e4dSAndy Whitcroft	my $offset = $linenr - 1;
7204d001e4dSAndy Whitcroft	$cnt++;
7214d001e4dSAndy Whitcroft
7224d001e4dSAndy Whitcroft	my $line;
7234d001e4dSAndy Whitcroft	while ($cnt) {
7244d001e4dSAndy Whitcroft		$line = $rawlines[$offset++];
7254d001e4dSAndy Whitcroft		next if (defined($line) && $line =~ /^-/);
7264d001e4dSAndy Whitcroft		$cnt--;
7274d001e4dSAndy Whitcroft	}
7284d001e4dSAndy Whitcroft
7294d001e4dSAndy Whitcroft	return $line;
7304d001e4dSAndy Whitcroft}
7314d001e4dSAndy Whitcroft
7320a920b5bSAndy Whitcroftsub cat_vet {
7330a920b5bSAndy Whitcroft	my ($vet) = @_;
7349c0ca6f9SAndy Whitcroft	my ($res, $coded);
7350a920b5bSAndy Whitcroft
7369c0ca6f9SAndy Whitcroft	$res = '';
7376c72ffaaSAndy Whitcroft	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
7386c72ffaaSAndy Whitcroft		$res .= $1;
7396c72ffaaSAndy Whitcroft		if ($2 ne '') {
7409c0ca6f9SAndy Whitcroft			$coded = sprintf("^%c", unpack('C', $2) + 64);
7416c72ffaaSAndy Whitcroft			$res .= $coded;
7426c72ffaaSAndy Whitcroft		}
7439c0ca6f9SAndy Whitcroft	}
7449c0ca6f9SAndy Whitcroft	$res =~ s/$/\$/;
7450a920b5bSAndy Whitcroft
7469c0ca6f9SAndy Whitcroft	return $res;
7470a920b5bSAndy Whitcroft}
7480a920b5bSAndy Whitcroft
749c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0;
750cf655043SAndy Whitcroftmy $av_pending;
751c2fdda0dSAndy Whitcroftmy @av_paren_type;
7521f65f947SAndy Whitcroftmy $av_pend_colon;
753c2fdda0dSAndy Whitcroft
754c2fdda0dSAndy Whitcroftsub annotate_reset {
755c2fdda0dSAndy Whitcroft	$av_preprocessor = 0;
756cf655043SAndy Whitcroft	$av_pending = '_';
757cf655043SAndy Whitcroft	@av_paren_type = ('E');
7581f65f947SAndy Whitcroft	$av_pend_colon = 'O';
759c2fdda0dSAndy Whitcroft}
760c2fdda0dSAndy Whitcroft
7616c72ffaaSAndy Whitcroftsub annotate_values {
7626c72ffaaSAndy Whitcroft	my ($stream, $type) = @_;
7636c72ffaaSAndy Whitcroft
7646c72ffaaSAndy Whitcroft	my $res;
7651f65f947SAndy Whitcroft	my $var = '_' x length($stream);
7666c72ffaaSAndy Whitcroft	my $cur = $stream;
7676c72ffaaSAndy Whitcroft
768c2fdda0dSAndy Whitcroft	print "$stream\n" if ($dbg_values > 1);
7696c72ffaaSAndy Whitcroft
7706c72ffaaSAndy Whitcroft	while (length($cur)) {
771773647a0SAndy Whitcroft		@av_paren_type = ('E') if ($#av_paren_type < 0);
772cf655043SAndy Whitcroft		print " <" . join('', @av_paren_type) .
773171ae1a4SAndy Whitcroft				"> <$type> <$av_pending>" if ($dbg_values > 1);
7746c72ffaaSAndy Whitcroft		if ($cur =~ /^(\s+)/o) {
775c2fdda0dSAndy Whitcroft			print "WS($1)\n" if ($dbg_values > 1);
776c2fdda0dSAndy Whitcroft			if ($1 =~ /\n/ && $av_preprocessor) {
777cf655043SAndy Whitcroft				$type = pop(@av_paren_type);
778c2fdda0dSAndy Whitcroft				$av_preprocessor = 0;
7796c72ffaaSAndy Whitcroft			}
7806c72ffaaSAndy Whitcroft
7818ea3eb9aSAndy Whitcroft		} elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
782c2fdda0dSAndy Whitcroft			print "DECLARE($1)\n" if ($dbg_values > 1);
7836c72ffaaSAndy Whitcroft			$type = 'T';
7846c72ffaaSAndy Whitcroft
785389a2fe5SAndy Whitcroft		} elsif ($cur =~ /^($Modifier)\s*/) {
786389a2fe5SAndy Whitcroft			print "MODIFIER($1)\n" if ($dbg_values > 1);
787389a2fe5SAndy Whitcroft			$type = 'T';
788389a2fe5SAndy Whitcroft
789c45dcabdSAndy Whitcroft		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
790171ae1a4SAndy Whitcroft			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
791c2fdda0dSAndy Whitcroft			$av_preprocessor = 1;
792171ae1a4SAndy Whitcroft			push(@av_paren_type, $type);
793171ae1a4SAndy Whitcroft			if ($2 ne '') {
794cf655043SAndy Whitcroft				$av_pending = 'N';
795171ae1a4SAndy Whitcroft			}
796171ae1a4SAndy Whitcroft			$type = 'E';
797171ae1a4SAndy Whitcroft
798c45dcabdSAndy Whitcroft		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
799171ae1a4SAndy Whitcroft			print "UNDEF($1)\n" if ($dbg_values > 1);
800171ae1a4SAndy Whitcroft			$av_preprocessor = 1;
801171ae1a4SAndy Whitcroft			push(@av_paren_type, $type);
8026c72ffaaSAndy Whitcroft
803c45dcabdSAndy Whitcroft		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
804cf655043SAndy Whitcroft			print "PRE_START($1)\n" if ($dbg_values > 1);
805c2fdda0dSAndy Whitcroft			$av_preprocessor = 1;
806cf655043SAndy Whitcroft
807cf655043SAndy Whitcroft			push(@av_paren_type, $type);
808cf655043SAndy Whitcroft			push(@av_paren_type, $type);
809171ae1a4SAndy Whitcroft			$type = 'E';
810cf655043SAndy Whitcroft
811c45dcabdSAndy Whitcroft		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
812cf655043SAndy Whitcroft			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
813cf655043SAndy Whitcroft			$av_preprocessor = 1;
814cf655043SAndy Whitcroft
815cf655043SAndy Whitcroft			push(@av_paren_type, $av_paren_type[$#av_paren_type]);
816cf655043SAndy Whitcroft
817171ae1a4SAndy Whitcroft			$type = 'E';
818cf655043SAndy Whitcroft
819c45dcabdSAndy Whitcroft		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
820cf655043SAndy Whitcroft			print "PRE_END($1)\n" if ($dbg_values > 1);
821cf655043SAndy Whitcroft
822cf655043SAndy Whitcroft			$av_preprocessor = 1;
823cf655043SAndy Whitcroft
824cf655043SAndy Whitcroft			# Assume all arms of the conditional end as this
825cf655043SAndy Whitcroft			# one does, and continue as if the #endif was not here.
826cf655043SAndy Whitcroft			pop(@av_paren_type);
827cf655043SAndy Whitcroft			push(@av_paren_type, $type);
828171ae1a4SAndy Whitcroft			$type = 'E';
8296c72ffaaSAndy Whitcroft
8306c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^(\\\n)/o) {
831c2fdda0dSAndy Whitcroft			print "PRECONT($1)\n" if ($dbg_values > 1);
8326c72ffaaSAndy Whitcroft
833171ae1a4SAndy Whitcroft		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
834171ae1a4SAndy Whitcroft			print "ATTR($1)\n" if ($dbg_values > 1);
835171ae1a4SAndy Whitcroft			$av_pending = $type;
836171ae1a4SAndy Whitcroft			$type = 'N';
837171ae1a4SAndy Whitcroft
8386c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
839c2fdda0dSAndy Whitcroft			print "SIZEOF($1)\n" if ($dbg_values > 1);
8406c72ffaaSAndy Whitcroft			if (defined $2) {
841cf655043SAndy Whitcroft				$av_pending = 'V';
8426c72ffaaSAndy Whitcroft			}
8436c72ffaaSAndy Whitcroft			$type = 'N';
8446c72ffaaSAndy Whitcroft
84514b111c1SAndy Whitcroft		} elsif ($cur =~ /^(if|while|for)\b/o) {
846c2fdda0dSAndy Whitcroft			print "COND($1)\n" if ($dbg_values > 1);
84714b111c1SAndy Whitcroft			$av_pending = 'E';
8486c72ffaaSAndy Whitcroft			$type = 'N';
8496c72ffaaSAndy Whitcroft
8501f65f947SAndy Whitcroft		} elsif ($cur =~/^(case)/o) {
8511f65f947SAndy Whitcroft			print "CASE($1)\n" if ($dbg_values > 1);
8521f65f947SAndy Whitcroft			$av_pend_colon = 'C';
8531f65f947SAndy Whitcroft			$type = 'N';
8541f65f947SAndy Whitcroft
85514b111c1SAndy Whitcroft		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
856c2fdda0dSAndy Whitcroft			print "KEYWORD($1)\n" if ($dbg_values > 1);
8576c72ffaaSAndy Whitcroft			$type = 'N';
8586c72ffaaSAndy Whitcroft
8596c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^(\()/o) {
860c2fdda0dSAndy Whitcroft			print "PAREN('$1')\n" if ($dbg_values > 1);
861cf655043SAndy Whitcroft			push(@av_paren_type, $av_pending);
862cf655043SAndy Whitcroft			$av_pending = '_';
8636c72ffaaSAndy Whitcroft			$type = 'N';
8646c72ffaaSAndy Whitcroft
8656c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^(\))/o) {
866cf655043SAndy Whitcroft			my $new_type = pop(@av_paren_type);
867cf655043SAndy Whitcroft			if ($new_type ne '_') {
868cf655043SAndy Whitcroft				$type = $new_type;
869c2fdda0dSAndy Whitcroft				print "PAREN('$1') -> $type\n"
870c2fdda0dSAndy Whitcroft							if ($dbg_values > 1);
8716c72ffaaSAndy Whitcroft			} else {
872c2fdda0dSAndy Whitcroft				print "PAREN('$1')\n" if ($dbg_values > 1);
8736c72ffaaSAndy Whitcroft			}
8746c72ffaaSAndy Whitcroft
875c8cb2ca3SAndy Whitcroft		} elsif ($cur =~ /^($Ident)\s*\(/o) {
876c2fdda0dSAndy Whitcroft			print "FUNC($1)\n" if ($dbg_values > 1);
877c8cb2ca3SAndy Whitcroft			$type = 'V';
878cf655043SAndy Whitcroft			$av_pending = 'V';
8796c72ffaaSAndy Whitcroft
8808e761b04SAndy Whitcroft		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
8818e761b04SAndy Whitcroft			if (defined $2 && $type eq 'C' || $type eq 'T') {
8821f65f947SAndy Whitcroft				$av_pend_colon = 'B';
8838e761b04SAndy Whitcroft			} elsif ($type eq 'E') {
8848e761b04SAndy Whitcroft				$av_pend_colon = 'L';
8851f65f947SAndy Whitcroft			}
8861f65f947SAndy Whitcroft			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
8871f65f947SAndy Whitcroft			$type = 'V';
8881f65f947SAndy Whitcroft
8896c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^($Ident|$Constant)/o) {
890c2fdda0dSAndy Whitcroft			print "IDENT($1)\n" if ($dbg_values > 1);
8916c72ffaaSAndy Whitcroft			$type = 'V';
8926c72ffaaSAndy Whitcroft
8936c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^($Assignment)/o) {
894c2fdda0dSAndy Whitcroft			print "ASSIGN($1)\n" if ($dbg_values > 1);
8956c72ffaaSAndy Whitcroft			$type = 'N';
8966c72ffaaSAndy Whitcroft
897cf655043SAndy Whitcroft		} elsif ($cur =~/^(;|{|})/) {
898c2fdda0dSAndy Whitcroft			print "END($1)\n" if ($dbg_values > 1);
89913214adfSAndy Whitcroft			$type = 'E';
9001f65f947SAndy Whitcroft			$av_pend_colon = 'O';
90113214adfSAndy Whitcroft
9028e761b04SAndy Whitcroft		} elsif ($cur =~/^(,)/) {
9038e761b04SAndy Whitcroft			print "COMMA($1)\n" if ($dbg_values > 1);
9048e761b04SAndy Whitcroft			$type = 'C';
9058e761b04SAndy Whitcroft
9061f65f947SAndy Whitcroft		} elsif ($cur =~ /^(\?)/o) {
9071f65f947SAndy Whitcroft			print "QUESTION($1)\n" if ($dbg_values > 1);
9081f65f947SAndy Whitcroft			$type = 'N';
9091f65f947SAndy Whitcroft
9101f65f947SAndy Whitcroft		} elsif ($cur =~ /^(:)/o) {
9111f65f947SAndy Whitcroft			print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
9121f65f947SAndy Whitcroft
9131f65f947SAndy Whitcroft			substr($var, length($res), 1, $av_pend_colon);
9141f65f947SAndy Whitcroft			if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
9151f65f947SAndy Whitcroft				$type = 'E';
9161f65f947SAndy Whitcroft			} else {
9171f65f947SAndy Whitcroft				$type = 'N';
9181f65f947SAndy Whitcroft			}
9191f65f947SAndy Whitcroft			$av_pend_colon = 'O';
9201f65f947SAndy Whitcroft
9218e761b04SAndy Whitcroft		} elsif ($cur =~ /^(\[)/o) {
92213214adfSAndy Whitcroft			print "CLOSE($1)\n" if ($dbg_values > 1);
9236c72ffaaSAndy Whitcroft			$type = 'N';
9246c72ffaaSAndy Whitcroft
9250d413866SAndy Whitcroft		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
92674048ed8SAndy Whitcroft			my $variant;
92774048ed8SAndy Whitcroft
92874048ed8SAndy Whitcroft			print "OPV($1)\n" if ($dbg_values > 1);
92974048ed8SAndy Whitcroft			if ($type eq 'V') {
93074048ed8SAndy Whitcroft				$variant = 'B';
93174048ed8SAndy Whitcroft			} else {
93274048ed8SAndy Whitcroft				$variant = 'U';
93374048ed8SAndy Whitcroft			}
93474048ed8SAndy Whitcroft
93574048ed8SAndy Whitcroft			substr($var, length($res), 1, $variant);
93674048ed8SAndy Whitcroft			$type = 'N';
93774048ed8SAndy Whitcroft
9386c72ffaaSAndy Whitcroft		} elsif ($cur =~ /^($Operators)/o) {
939c2fdda0dSAndy Whitcroft			print "OP($1)\n" if ($dbg_values > 1);
9406c72ffaaSAndy Whitcroft			if ($1 ne '++' && $1 ne '--') {
9416c72ffaaSAndy Whitcroft				$type = 'N';
9426c72ffaaSAndy Whitcroft			}
9436c72ffaaSAndy Whitcroft
9446c72ffaaSAndy Whitcroft		} elsif ($cur =~ /(^.)/o) {
945c2fdda0dSAndy Whitcroft			print "C($1)\n" if ($dbg_values > 1);
9466c72ffaaSAndy Whitcroft		}
9476c72ffaaSAndy Whitcroft		if (defined $1) {
9486c72ffaaSAndy Whitcroft			$cur = substr($cur, length($1));
9496c72ffaaSAndy Whitcroft			$res .= $type x length($1);
9506c72ffaaSAndy Whitcroft		}
9516c72ffaaSAndy Whitcroft	}
9526c72ffaaSAndy Whitcroft
9531f65f947SAndy Whitcroft	return ($res, $var);
9546c72ffaaSAndy Whitcroft}
9556c72ffaaSAndy Whitcroft
9568905a67cSAndy Whitcroftsub possible {
95713214adfSAndy Whitcroft	my ($possible, $line) = @_;
9588905a67cSAndy Whitcroft
9590776e594SAndy Whitcroft	print "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
9600776e594SAndy Whitcroft	if ($possible !~ /(?:
9610776e594SAndy Whitcroft		^(?:
9620776e594SAndy Whitcroft			$Modifier|
9630776e594SAndy Whitcroft			$Storage|
9640776e594SAndy Whitcroft			$Type|
9650776e594SAndy Whitcroft			DEFINE_\S+|
9660776e594SAndy Whitcroft			goto|
9670776e594SAndy Whitcroft			return|
9680776e594SAndy Whitcroft			case|
9690776e594SAndy Whitcroft			else|
9700776e594SAndy Whitcroft			asm|__asm__|
9710776e594SAndy Whitcroft			do
9720776e594SAndy Whitcroft		)$|
9730776e594SAndy Whitcroft		^(?:typedef|struct|enum)\b
9740776e594SAndy Whitcroft	    )/x) {
975c45dcabdSAndy Whitcroft		# Check for modifiers.
976c45dcabdSAndy Whitcroft		$possible =~ s/\s*$Storage\s*//g;
977c45dcabdSAndy Whitcroft		$possible =~ s/\s*$Sparse\s*//g;
978c45dcabdSAndy Whitcroft		if ($possible =~ /^\s*$/) {
979c45dcabdSAndy Whitcroft
980c45dcabdSAndy Whitcroft		} elsif ($possible =~ /\s/) {
981c45dcabdSAndy Whitcroft			$possible =~ s/\s*$Type\s*//g;
982d2506586SAndy Whitcroft			for my $modifier (split(' ', $possible)) {
983d2506586SAndy Whitcroft				warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
984d2506586SAndy Whitcroft				push(@modifierList, $modifier);
985d2506586SAndy Whitcroft			}
986c45dcabdSAndy Whitcroft
987c45dcabdSAndy Whitcroft		} else {
98813214adfSAndy Whitcroft			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
9898905a67cSAndy Whitcroft			push(@typeList, $possible);
990c45dcabdSAndy Whitcroft		}
9918905a67cSAndy Whitcroft		build_types();
9920776e594SAndy Whitcroft	} else {
9930776e594SAndy Whitcroft		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
9948905a67cSAndy Whitcroft	}
9958905a67cSAndy Whitcroft}
9968905a67cSAndy Whitcroft
9976c72ffaaSAndy Whitcroftmy $prefix = '';
9986c72ffaaSAndy Whitcroft
999f0a594c1SAndy Whitcroftsub report {
1000773647a0SAndy Whitcroft	if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
1001773647a0SAndy Whitcroft		return 0;
1002773647a0SAndy Whitcroft	}
10038905a67cSAndy Whitcroft	my $line = $prefix . $_[0];
10048905a67cSAndy Whitcroft
10058905a67cSAndy Whitcroft	$line = (split('\n', $line))[0] . "\n" if ($terse);
10068905a67cSAndy Whitcroft
100713214adfSAndy Whitcroft	push(our @report, $line);
1008773647a0SAndy Whitcroft
1009773647a0SAndy Whitcroft	return 1;
1010f0a594c1SAndy Whitcroft}
1011f0a594c1SAndy Whitcroftsub report_dump {
101213214adfSAndy Whitcroft	our @report;
1013f0a594c1SAndy Whitcroft}
1014de7d4f0eSAndy Whitcroftsub ERROR {
1015773647a0SAndy Whitcroft	if (report("ERROR: $_[0]\n")) {
1016de7d4f0eSAndy Whitcroft		our $clean = 0;
10176c72ffaaSAndy Whitcroft		our $cnt_error++;
1018de7d4f0eSAndy Whitcroft	}
1019773647a0SAndy Whitcroft}
1020de7d4f0eSAndy Whitcroftsub WARN {
1021773647a0SAndy Whitcroft	if (report("WARNING: $_[0]\n")) {
1022de7d4f0eSAndy Whitcroft		our $clean = 0;
10236c72ffaaSAndy Whitcroft		our $cnt_warn++;
1024de7d4f0eSAndy Whitcroft	}
1025773647a0SAndy Whitcroft}
1026de7d4f0eSAndy Whitcroftsub CHK {
1027773647a0SAndy Whitcroft	if ($check && report("CHECK: $_[0]\n")) {
1028de7d4f0eSAndy Whitcroft		our $clean = 0;
10296c72ffaaSAndy Whitcroft		our $cnt_chk++;
10306c72ffaaSAndy Whitcroft	}
1031de7d4f0eSAndy Whitcroft}
1032de7d4f0eSAndy Whitcroft
10336ecd9674SAndy Whitcroftsub check_absolute_file {
10346ecd9674SAndy Whitcroft	my ($absolute, $herecurr) = @_;
10356ecd9674SAndy Whitcroft	my $file = $absolute;
10366ecd9674SAndy Whitcroft
10376ecd9674SAndy Whitcroft	##print "absolute<$absolute>\n";
10386ecd9674SAndy Whitcroft
10396ecd9674SAndy Whitcroft	# See if any suffix of this path is a path within the tree.
10406ecd9674SAndy Whitcroft	while ($file =~ s@^[^/]*/@@) {
10416ecd9674SAndy Whitcroft		if (-f "$root/$file") {
10426ecd9674SAndy Whitcroft			##print "file<$file>\n";
10436ecd9674SAndy Whitcroft			last;
10446ecd9674SAndy Whitcroft		}
10456ecd9674SAndy Whitcroft	}
10466ecd9674SAndy Whitcroft	if (! -f _)  {
10476ecd9674SAndy Whitcroft		return 0;
10486ecd9674SAndy Whitcroft	}
10496ecd9674SAndy Whitcroft
10506ecd9674SAndy Whitcroft	# It is, so see if the prefix is acceptable.
10516ecd9674SAndy Whitcroft	my $prefix = $absolute;
10526ecd9674SAndy Whitcroft	substr($prefix, -length($file)) = '';
10536ecd9674SAndy Whitcroft
10546ecd9674SAndy Whitcroft	##print "prefix<$prefix>\n";
10556ecd9674SAndy Whitcroft	if ($prefix ne ".../") {
10566ecd9674SAndy Whitcroft		WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr);
10576ecd9674SAndy Whitcroft	}
10586ecd9674SAndy Whitcroft}
10596ecd9674SAndy Whitcroft
10600a920b5bSAndy Whitcroftsub process {
10610a920b5bSAndy Whitcroft	my $filename = shift;
10620a920b5bSAndy Whitcroft
10630a920b5bSAndy Whitcroft	my $linenr=0;
10640a920b5bSAndy Whitcroft	my $prevline="";
1065c2fdda0dSAndy Whitcroft	my $prevrawline="";
10660a920b5bSAndy Whitcroft	my $stashline="";
1067c2fdda0dSAndy Whitcroft	my $stashrawline="";
10680a920b5bSAndy Whitcroft
10694a0df2efSAndy Whitcroft	my $length;
10700a920b5bSAndy Whitcroft	my $indent;
10710a920b5bSAndy Whitcroft	my $previndent=0;
10720a920b5bSAndy Whitcroft	my $stashindent=0;
10730a920b5bSAndy Whitcroft
1074de7d4f0eSAndy Whitcroft	our $clean = 1;
10750a920b5bSAndy Whitcroft	my $signoff = 0;
10760a920b5bSAndy Whitcroft	my $is_patch = 0;
10770a920b5bSAndy Whitcroft
107813214adfSAndy Whitcroft	our @report = ();
10796c72ffaaSAndy Whitcroft	our $cnt_lines = 0;
10806c72ffaaSAndy Whitcroft	our $cnt_error = 0;
10816c72ffaaSAndy Whitcroft	our $cnt_warn = 0;
10826c72ffaaSAndy Whitcroft	our $cnt_chk = 0;
10836c72ffaaSAndy Whitcroft
10840a920b5bSAndy Whitcroft	# Trace the real file/line as we go.
10850a920b5bSAndy Whitcroft	my $realfile = '';
10860a920b5bSAndy Whitcroft	my $realline = 0;
10870a920b5bSAndy Whitcroft	my $realcnt = 0;
10880a920b5bSAndy Whitcroft	my $here = '';
10890a920b5bSAndy Whitcroft	my $in_comment = 0;
1090c2fdda0dSAndy Whitcroft	my $comment_edge = 0;
10910a920b5bSAndy Whitcroft	my $first_line = 0;
10921e855726SWolfram Sang	my $p1_prefix = '';
10930a920b5bSAndy Whitcroft
109413214adfSAndy Whitcroft	my $prev_values = 'E';
109513214adfSAndy Whitcroft
109613214adfSAndy Whitcroft	# suppression flags
1097773647a0SAndy Whitcroft	my %suppress_ifbraces;
1098170d3a22SAndy Whitcroft	my %suppress_whiletrailers;
1099653d4876SAndy Whitcroft
1100c2fdda0dSAndy Whitcroft	# Pre-scan the patch sanitizing the lines.
1101de7d4f0eSAndy Whitcroft	# Pre-scan the patch looking for any __setup documentation.
1102c2fdda0dSAndy Whitcroft	#
1103de7d4f0eSAndy Whitcroft	my @setup_docs = ();
1104de7d4f0eSAndy Whitcroft	my $setup_docs = 0;
1105773647a0SAndy Whitcroft
1106773647a0SAndy Whitcroft	sanitise_line_reset();
1107c2fdda0dSAndy Whitcroft	my $line;
1108c2fdda0dSAndy Whitcroft	foreach my $rawline (@rawlines) {
1109773647a0SAndy Whitcroft		$linenr++;
1110773647a0SAndy Whitcroft		$line = $rawline;
1111c2fdda0dSAndy Whitcroft
1112773647a0SAndy Whitcroft		if ($rawline=~/^\+\+\+\s+(\S+)/) {
1113de7d4f0eSAndy Whitcroft			$setup_docs = 0;
1114de7d4f0eSAndy Whitcroft			if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1115de7d4f0eSAndy Whitcroft				$setup_docs = 1;
1116de7d4f0eSAndy Whitcroft			}
1117773647a0SAndy Whitcroft			#next;
1118de7d4f0eSAndy Whitcroft		}
1119773647a0SAndy Whitcroft		if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1120773647a0SAndy Whitcroft			$realline=$1-1;
1121773647a0SAndy Whitcroft			if (defined $2) {
1122773647a0SAndy Whitcroft				$realcnt=$3+1;
1123773647a0SAndy Whitcroft			} else {
1124773647a0SAndy Whitcroft				$realcnt=1+1;
1125773647a0SAndy Whitcroft			}
1126c45dcabdSAndy Whitcroft			$in_comment = 0;
1127773647a0SAndy Whitcroft
1128773647a0SAndy Whitcroft			# Guestimate if this is a continuing comment.  Run
1129773647a0SAndy Whitcroft			# the context looking for a comment "edge".  If this
1130773647a0SAndy Whitcroft			# edge is a close comment then we must be in a comment
1131773647a0SAndy Whitcroft			# at context start.
1132773647a0SAndy Whitcroft			my $edge;
113301fa9147SAndy Whitcroft			my $cnt = $realcnt;
113401fa9147SAndy Whitcroft			for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
113501fa9147SAndy Whitcroft				next if (defined $rawlines[$ln - 1] &&
113601fa9147SAndy Whitcroft					 $rawlines[$ln - 1] =~ /^-/);
113701fa9147SAndy Whitcroft				$cnt--;
113801fa9147SAndy Whitcroft				#print "RAW<$rawlines[$ln - 1]>\n";
1139721c1cb6SAndy Whitcroft				last if (!defined $rawlines[$ln - 1]);
1140fae17daeSAndy Whitcroft				if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1141fae17daeSAndy Whitcroft				    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1142fae17daeSAndy Whitcroft					($edge) = $1;
1143fae17daeSAndy Whitcroft					last;
1144fae17daeSAndy Whitcroft				}
1145773647a0SAndy Whitcroft			}
1146773647a0SAndy Whitcroft			if (defined $edge && $edge eq '*/') {
1147773647a0SAndy Whitcroft				$in_comment = 1;
1148773647a0SAndy Whitcroft			}
1149773647a0SAndy Whitcroft
1150773647a0SAndy Whitcroft			# Guestimate if this is a continuing comment.  If this
1151773647a0SAndy Whitcroft			# is the start of a diff block and this line starts
1152773647a0SAndy Whitcroft			# ' *' then it is very likely a comment.
1153773647a0SAndy Whitcroft			if (!defined $edge &&
115483242e0cSAndy Whitcroft			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1155773647a0SAndy Whitcroft			{
1156773647a0SAndy Whitcroft				$in_comment = 1;
1157773647a0SAndy Whitcroft			}
1158773647a0SAndy Whitcroft
1159773647a0SAndy Whitcroft			##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1160773647a0SAndy Whitcroft			sanitise_line_reset($in_comment);
1161773647a0SAndy Whitcroft
1162171ae1a4SAndy Whitcroft		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1163773647a0SAndy Whitcroft			# Standardise the strings and chars within the input to
1164171ae1a4SAndy Whitcroft			# simplify matching -- only bother with positive lines.
1165773647a0SAndy Whitcroft			$line = sanitise_line($rawline);
1166773647a0SAndy Whitcroft		}
1167773647a0SAndy Whitcroft		push(@lines, $line);
1168773647a0SAndy Whitcroft
1169773647a0SAndy Whitcroft		if ($realcnt > 1) {
1170773647a0SAndy Whitcroft			$realcnt-- if ($line =~ /^(?:\+| |$)/);
1171773647a0SAndy Whitcroft		} else {
1172773647a0SAndy Whitcroft			$realcnt = 0;
1173773647a0SAndy Whitcroft		}
1174773647a0SAndy Whitcroft
1175773647a0SAndy Whitcroft		#print "==>$rawline\n";
1176773647a0SAndy Whitcroft		#print "-->$line\n";
1177de7d4f0eSAndy Whitcroft
1178de7d4f0eSAndy Whitcroft		if ($setup_docs && $line =~ /^\+/) {
1179de7d4f0eSAndy Whitcroft			push(@setup_docs, $line);
1180de7d4f0eSAndy Whitcroft		}
1181de7d4f0eSAndy Whitcroft	}
1182de7d4f0eSAndy Whitcroft
11836c72ffaaSAndy Whitcroft	$prefix = '';
11846c72ffaaSAndy Whitcroft
1185773647a0SAndy Whitcroft	$realcnt = 0;
1186773647a0SAndy Whitcroft	$linenr = 0;
11870a920b5bSAndy Whitcroft	foreach my $line (@lines) {
11880a920b5bSAndy Whitcroft		$linenr++;
11890a920b5bSAndy Whitcroft
1190c2fdda0dSAndy Whitcroft		my $rawline = $rawlines[$linenr - 1];
119130670854SAndy Whitcroft		my $hunk_line = ($realcnt != 0);
11926c72ffaaSAndy Whitcroft
11930a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied
11946c72ffaaSAndy Whitcroft		if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
11950a920b5bSAndy Whitcroft			$is_patch = 1;
11964a0df2efSAndy Whitcroft			$first_line = $linenr + 1;
11970a920b5bSAndy Whitcroft			$realline=$1-1;
11980a920b5bSAndy Whitcroft			if (defined $2) {
11990a920b5bSAndy Whitcroft				$realcnt=$3+1;
12000a920b5bSAndy Whitcroft			} else {
12010a920b5bSAndy Whitcroft				$realcnt=1+1;
12020a920b5bSAndy Whitcroft			}
1203c2fdda0dSAndy Whitcroft			annotate_reset();
120413214adfSAndy Whitcroft			$prev_values = 'E';
120513214adfSAndy Whitcroft
1206773647a0SAndy Whitcroft			%suppress_ifbraces = ();
1207170d3a22SAndy Whitcroft			%suppress_whiletrailers = ();
12080a920b5bSAndy Whitcroft			next;
12090a920b5bSAndy Whitcroft
12104a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that
12114a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely
12124a0df2efSAndy Whitcroft# blank context lines so we need to count that too.
1213773647a0SAndy Whitcroft		} elsif ($line =~ /^( |\+|$)/) {
12140a920b5bSAndy Whitcroft			$realline++;
1215d8aaf121SAndy Whitcroft			$realcnt-- if ($realcnt != 0);
12160a920b5bSAndy Whitcroft
12174a0df2efSAndy Whitcroft			# Measure the line length and indent.
1218c2fdda0dSAndy Whitcroft			($length, $indent) = line_stats($rawline);
12190a920b5bSAndy Whitcroft
12200a920b5bSAndy Whitcroft			# Track the previous line.
12210a920b5bSAndy Whitcroft			($prevline, $stashline) = ($stashline, $line);
12220a920b5bSAndy Whitcroft			($previndent, $stashindent) = ($stashindent, $indent);
1223c2fdda0dSAndy Whitcroft			($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1224c2fdda0dSAndy Whitcroft
1225773647a0SAndy Whitcroft			#warn "line<$line>\n";
12266c72ffaaSAndy Whitcroft
1227d8aaf121SAndy Whitcroft		} elsif ($realcnt == 1) {
1228d8aaf121SAndy Whitcroft			$realcnt--;
12290a920b5bSAndy Whitcroft		}
12300a920b5bSAndy Whitcroft
12310a920b5bSAndy Whitcroft#make up the handle for any error we report on this line
1232773647a0SAndy Whitcroft		$prefix = "$filename:$realline: " if ($emacs && $file);
1233773647a0SAndy Whitcroft		$prefix = "$filename:$linenr: " if ($emacs && !$file);
1234773647a0SAndy Whitcroft
12356c72ffaaSAndy Whitcroft		$here = "#$linenr: " if (!$file);
12366c72ffaaSAndy Whitcroft		$here = "#$realline: " if ($file);
1237773647a0SAndy Whitcroft
1238773647a0SAndy Whitcroft		# extract the filename as it passes
1239773647a0SAndy Whitcroft		if ($line=~/^\+\+\+\s+(\S+)/) {
1240773647a0SAndy Whitcroft			$realfile = $1;
12411e855726SWolfram Sang			$realfile =~ s@^([^/]*)/@@;
12421e855726SWolfram Sang
12431e855726SWolfram Sang			$p1_prefix = $1;
1244e2f7aa4bSAndy Whitcroft			if (!$file && $tree && $p1_prefix ne '' &&
1245e2f7aa4bSAndy Whitcroft			    -e "$root/$p1_prefix") {
12461e855726SWolfram Sang				WARN("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
12471e855726SWolfram Sang			}
1248773647a0SAndy Whitcroft
1249c1ab3326SAndy Whitcroft			if ($realfile =~ m@^include/asm/@) {
1250773647a0SAndy Whitcroft				ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1251773647a0SAndy Whitcroft			}
1252773647a0SAndy Whitcroft			next;
1253773647a0SAndy Whitcroft		}
1254773647a0SAndy Whitcroft
1255389834b6SRandy Dunlap		$here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
12560a920b5bSAndy Whitcroft
1257c2fdda0dSAndy Whitcroft		my $hereline = "$here\n$rawline\n";
1258c2fdda0dSAndy Whitcroft		my $herecurr = "$here\n$rawline\n";
1259c2fdda0dSAndy Whitcroft		my $hereprev = "$here\n$prevrawline\n$rawline\n";
12600a920b5bSAndy Whitcroft
12616c72ffaaSAndy Whitcroft		$cnt_lines++ if ($realcnt != 0);
12626c72ffaaSAndy Whitcroft
12630a920b5bSAndy Whitcroft#check the patch for a signoff:
1264d8aaf121SAndy Whitcroft		if ($line =~ /^\s*signed-off-by:/i) {
12654a0df2efSAndy Whitcroft			# This is a signoff, if ugly, so do not double report.
12664a0df2efSAndy Whitcroft			$signoff++;
12670a920b5bSAndy Whitcroft			if (!($line =~ /^\s*Signed-off-by:/)) {
1268de7d4f0eSAndy Whitcroft				WARN("Signed-off-by: is the preferred form\n" .
1269de7d4f0eSAndy Whitcroft					$herecurr);
12700a920b5bSAndy Whitcroft			}
12710a920b5bSAndy Whitcroft			if ($line =~ /^\s*signed-off-by:\S/i) {
1272773647a0SAndy Whitcroft				WARN("space required after Signed-off-by:\n" .
1273de7d4f0eSAndy Whitcroft					$herecurr);
12740a920b5bSAndy Whitcroft			}
12750a920b5bSAndy Whitcroft		}
12760a920b5bSAndy Whitcroft
127700df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file
12788905a67cSAndy Whitcroft		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1279de7d4f0eSAndy Whitcroft			ERROR("patch seems to be corrupt (line wrapped?)\n" .
12806c72ffaaSAndy Whitcroft				$herecurr) if (!$emitted_corrupt++);
1281de7d4f0eSAndy Whitcroft		}
1282de7d4f0eSAndy Whitcroft
12836ecd9674SAndy Whitcroft# Check for absolute kernel paths.
12846ecd9674SAndy Whitcroft		if ($tree) {
12856ecd9674SAndy Whitcroft			while ($line =~ m{(?:^|\s)(/\S*)}g) {
12866ecd9674SAndy Whitcroft				my $file = $1;
12876ecd9674SAndy Whitcroft
12886ecd9674SAndy Whitcroft				if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
12896ecd9674SAndy Whitcroft				    check_absolute_file($1, $herecurr)) {
12906ecd9674SAndy Whitcroft					#
12916ecd9674SAndy Whitcroft				} else {
12926ecd9674SAndy Whitcroft					check_absolute_file($file, $herecurr);
12936ecd9674SAndy Whitcroft				}
12946ecd9674SAndy Whitcroft			}
12956ecd9674SAndy Whitcroft		}
12966ecd9674SAndy Whitcroft
1297de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1298de7d4f0eSAndy Whitcroft		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1299171ae1a4SAndy Whitcroft		    $rawline !~ m/^$UTF8*$/) {
1300171ae1a4SAndy Whitcroft			my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1301171ae1a4SAndy Whitcroft
1302171ae1a4SAndy Whitcroft			my $blank = copy_spacing($rawline);
1303171ae1a4SAndy Whitcroft			my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1304171ae1a4SAndy Whitcroft			my $hereptr = "$hereline$ptr\n";
1305171ae1a4SAndy Whitcroft
1306171ae1a4SAndy Whitcroft			ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
130700df344fSAndy Whitcroft		}
13080a920b5bSAndy Whitcroft
130930670854SAndy Whitcroft# ignore non-hunk lines and lines being removed
131030670854SAndy Whitcroft		next if (!$hunk_line || $line =~ /^-/);
131100df344fSAndy Whitcroft
13120a920b5bSAndy Whitcroft#trailing whitespace
13139c0ca6f9SAndy Whitcroft		if ($line =~ /^\+.*\015/) {
1314c2fdda0dSAndy Whitcroft			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
13159c0ca6f9SAndy Whitcroft			ERROR("DOS line endings\n" . $herevet);
13169c0ca6f9SAndy Whitcroft
1317c2fdda0dSAndy Whitcroft		} elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1318c2fdda0dSAndy Whitcroft			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1319de7d4f0eSAndy Whitcroft			ERROR("trailing whitespace\n" . $herevet);
13200a920b5bSAndy Whitcroft		}
13215368df20SAndy Whitcroft
13225368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk
13235368df20SAndy Whitcroft		next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
13245368df20SAndy Whitcroft
13250a920b5bSAndy Whitcroft#80 column limit
1326c45dcabdSAndy Whitcroft		if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1327f4c014c0SAndy Whitcroft		    $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1328f4c014c0SAndy Whitcroft		    $line !~ /^\+\s*printk\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
1329f4c014c0SAndy Whitcroft		    $length > 80)
1330c45dcabdSAndy Whitcroft		{
1331de7d4f0eSAndy Whitcroft			WARN("line over 80 characters\n" . $herecurr);
13320a920b5bSAndy Whitcroft		}
13330a920b5bSAndy Whitcroft
13348905a67cSAndy Whitcroft# check for adding lines without a newline.
13358905a67cSAndy Whitcroft		if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
13368905a67cSAndy Whitcroft			WARN("adding a line without newline at end of file\n" . $herecurr);
13378905a67cSAndy Whitcroft		}
13388905a67cSAndy Whitcroft
1339b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk
1340b9ea10d6SAndy Whitcroft		next if ($realfile !~ /\.(h|c|pl)$/);
13410a920b5bSAndy Whitcroft
13420a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything
13430a920b5bSAndy Whitcroft# more than 8 must use tabs.
1344c2fdda0dSAndy Whitcroft		if ($rawline =~ /^\+\s* \t\s*\S/ ||
1345c2fdda0dSAndy Whitcroft		    $rawline =~ /^\+\s*        \s*/) {
1346c2fdda0dSAndy Whitcroft			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1347171ae1a4SAndy Whitcroft			ERROR("code indent should use tabs where possible\n" . $herevet);
13480a920b5bSAndy Whitcroft		}
13490a920b5bSAndy Whitcroft
1350b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk
1351b9ea10d6SAndy Whitcroft		next if ($realfile !~ /\.(h|c)$/);
1352b9ea10d6SAndy Whitcroft
1353c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers
1354cf655043SAndy Whitcroft		if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1355c2fdda0dSAndy Whitcroft			WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1356c2fdda0dSAndy Whitcroft		}
135722f2a2efSAndy Whitcroft
13589c0ca6f9SAndy Whitcroft# Check for potential 'bare' types
1359170d3a22SAndy Whitcroft		my ($stat, $cond, $line_nr_next, $remain_next, $off_next);
13609c9ba34eSAndy Whitcroft		if ($realcnt && $line =~ /.\s*\S/) {
1361170d3a22SAndy Whitcroft			($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1362f5fe35ddSAndy Whitcroft				ctx_statement_block($linenr, $realcnt, 0);
1363171ae1a4SAndy Whitcroft			$stat =~ s/\n./\n /g;
1364171ae1a4SAndy Whitcroft			$cond =~ s/\n./\n /g;
1365171ae1a4SAndy Whitcroft
1366171ae1a4SAndy Whitcroft			my $s = $stat;
1367171ae1a4SAndy Whitcroft			$s =~ s/{.*$//s;
1368cf655043SAndy Whitcroft
1369c2fdda0dSAndy Whitcroft			# Ignore goto labels.
1370171ae1a4SAndy Whitcroft			if ($s =~ /$Ident:\*$/s) {
1371c2fdda0dSAndy Whitcroft
1372c2fdda0dSAndy Whitcroft			# Ignore functions being called
1373171ae1a4SAndy Whitcroft			} elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1374c2fdda0dSAndy Whitcroft
1375*463f2864SAndy Whitcroft			} elsif ($s =~ /^.\s*else\b/s) {
1376*463f2864SAndy Whitcroft
1377c45dcabdSAndy Whitcroft			# declarations always start with types
1378d2506586SAndy Whitcroft			} elsif ($prev_values eq 'E' && $s =~ /^.\s*(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?((?:\s*$Ident)+?)\b(?:\s+$Sparse)?\s*\**\s*(?:$Ident|\(\*[^\)]*\))(?:\s*$Modifier)?\s*(?:;|=|,|\()/s) {
1379c45dcabdSAndy Whitcroft				my $type = $1;
1380c45dcabdSAndy Whitcroft				$type =~ s/\s+/ /g;
1381c45dcabdSAndy Whitcroft				possible($type, "A:" . $s);
1382c45dcabdSAndy Whitcroft
13836c72ffaaSAndy Whitcroft			# definitions in global scope can only start with types
1384a6a84062SAndy Whitcroft			} elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
1385c45dcabdSAndy Whitcroft				possible($1, "B:" . $s);
1386c2fdda0dSAndy Whitcroft			}
13878905a67cSAndy Whitcroft
13886c72ffaaSAndy Whitcroft			# any (foo ... *) is a pointer cast, and foo is a type
138965863862SAndy Whitcroft			while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
1390c45dcabdSAndy Whitcroft				possible($1, "C:" . $s);
13919c0ca6f9SAndy Whitcroft			}
13928905a67cSAndy Whitcroft
13938905a67cSAndy Whitcroft			# Check for any sort of function declaration.
13948905a67cSAndy Whitcroft			# int foo(something bar, other baz);
13958905a67cSAndy Whitcroft			# void (*store_gdt)(x86_descr_ptr *);
1396171ae1a4SAndy Whitcroft			if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
13978905a67cSAndy Whitcroft				my ($name_len) = length($1);
13988905a67cSAndy Whitcroft
1399cf655043SAndy Whitcroft				my $ctx = $s;
1400773647a0SAndy Whitcroft				substr($ctx, 0, $name_len + 1, '');
14018905a67cSAndy Whitcroft				$ctx =~ s/\)[^\)]*$//;
1402cf655043SAndy Whitcroft
14038905a67cSAndy Whitcroft				for my $arg (split(/\s*,\s*/, $ctx)) {
1404c45dcabdSAndy Whitcroft					if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
14058905a67cSAndy Whitcroft
1406c45dcabdSAndy Whitcroft						possible($1, "D:" . $s);
14078905a67cSAndy Whitcroft					}
14088905a67cSAndy Whitcroft				}
14098905a67cSAndy Whitcroft			}
14108905a67cSAndy Whitcroft
14119c0ca6f9SAndy Whitcroft		}
14129c0ca6f9SAndy Whitcroft
141300df344fSAndy Whitcroft#
141400df344fSAndy Whitcroft# Checks which may be anchored in the context.
141500df344fSAndy Whitcroft#
141600df344fSAndy Whitcroft
141700df344fSAndy Whitcroft# Check for switch () and associated case and default
141800df344fSAndy Whitcroft# statements should be at the same indent.
141900df344fSAndy Whitcroft		if ($line=~/\bswitch\s*\(.*\)/) {
142000df344fSAndy Whitcroft			my $err = '';
142100df344fSAndy Whitcroft			my $sep = '';
142200df344fSAndy Whitcroft			my @ctx = ctx_block_outer($linenr, $realcnt);
142300df344fSAndy Whitcroft			shift(@ctx);
142400df344fSAndy Whitcroft			for my $ctx (@ctx) {
142500df344fSAndy Whitcroft				my ($clen, $cindent) = line_stats($ctx);
142600df344fSAndy Whitcroft				if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
142700df344fSAndy Whitcroft							$indent != $cindent) {
142800df344fSAndy Whitcroft					$err .= "$sep$ctx\n";
142900df344fSAndy Whitcroft					$sep = '';
143000df344fSAndy Whitcroft				} else {
143100df344fSAndy Whitcroft					$sep = "[...]\n";
143200df344fSAndy Whitcroft				}
143300df344fSAndy Whitcroft			}
143400df344fSAndy Whitcroft			if ($err ne '') {
14359c0ca6f9SAndy Whitcroft				ERROR("switch and case should be at the same indent\n$hereline$err");
1436de7d4f0eSAndy Whitcroft			}
1437de7d4f0eSAndy Whitcroft		}
1438de7d4f0eSAndy Whitcroft
1439de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop,
1440de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else
1441c45dcabdSAndy Whitcroft		if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
1442773647a0SAndy Whitcroft			my $pre_ctx = "$1$2";
1443773647a0SAndy Whitcroft
14449c0ca6f9SAndy Whitcroft			my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
1445de7d4f0eSAndy Whitcroft			my $ctx_cnt = $realcnt - $#ctx - 1;
1446de7d4f0eSAndy Whitcroft			my $ctx = join("\n", @ctx);
1447de7d4f0eSAndy Whitcroft
1448548596d5SAndy Whitcroft			my $ctx_ln = $linenr;
1449548596d5SAndy Whitcroft			my $ctx_skip = $realcnt;
1450de7d4f0eSAndy Whitcroft
1451548596d5SAndy Whitcroft			while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1452548596d5SAndy Whitcroft					defined $lines[$ctx_ln - 1] &&
1453548596d5SAndy Whitcroft					$lines[$ctx_ln - 1] =~ /^-/)) {
1454548596d5SAndy Whitcroft				##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1455548596d5SAndy Whitcroft				$ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
1456773647a0SAndy Whitcroft				$ctx_ln++;
1457773647a0SAndy Whitcroft			}
1458548596d5SAndy Whitcroft
145953210168SAndy Whitcroft			#print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
146053210168SAndy Whitcroft			#print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
1461773647a0SAndy Whitcroft
1462773647a0SAndy Whitcroft			if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1463773647a0SAndy Whitcroft				ERROR("that open brace { should be on the previous line\n" .
1464c45dcabdSAndy Whitcroft					"$here\n$ctx\n$lines[$ctx_ln - 1]\n");
146500df344fSAndy Whitcroft			}
1466773647a0SAndy Whitcroft			if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1467773647a0SAndy Whitcroft			    $ctx =~ /\)\s*\;\s*$/ &&
1468773647a0SAndy Whitcroft			    defined $lines[$ctx_ln - 1])
1469773647a0SAndy Whitcroft			{
14709c0ca6f9SAndy Whitcroft				my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
14719c0ca6f9SAndy Whitcroft				if ($nindent > $indent) {
1472773647a0SAndy Whitcroft					WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
1473c45dcabdSAndy Whitcroft						"$here\n$ctx\n$lines[$ctx_ln - 1]\n");
14749c0ca6f9SAndy Whitcroft				}
14759c0ca6f9SAndy Whitcroft			}
147600df344fSAndy Whitcroft		}
147700df344fSAndy Whitcroft
14784d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks.
14794d001e4dSAndy Whitcroft		if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
14804d001e4dSAndy Whitcroft			my ($s, $c) = ($stat, $cond);
14814d001e4dSAndy Whitcroft
14824d001e4dSAndy Whitcroft			substr($s, 0, length($c), '');
14834d001e4dSAndy Whitcroft
14844d001e4dSAndy Whitcroft			# Make sure we remove the line prefixes as we have
14854d001e4dSAndy Whitcroft			# none on the first line, and are going to readd them
14864d001e4dSAndy Whitcroft			# where necessary.
14874d001e4dSAndy Whitcroft			$s =~ s/\n./\n/gs;
14884d001e4dSAndy Whitcroft
14894d001e4dSAndy Whitcroft			# Find out how long the conditional actually is.
14906f779c18SAndy Whitcroft			my @newlines = ($c =~ /\n/gs);
14916f779c18SAndy Whitcroft			my $cond_lines = 1 + $#newlines;
14924d001e4dSAndy Whitcroft
14934d001e4dSAndy Whitcroft			# We want to check the first line inside the block
14944d001e4dSAndy Whitcroft			# starting at the end of the conditional, so remove:
14954d001e4dSAndy Whitcroft			#  1) any blank line termination
14964d001e4dSAndy Whitcroft			#  2) any opening brace { on end of the line
14974d001e4dSAndy Whitcroft			#  3) any do (...) {
14984d001e4dSAndy Whitcroft			my $continuation = 0;
14994d001e4dSAndy Whitcroft			my $check = 0;
15004d001e4dSAndy Whitcroft			$s =~ s/^.*\bdo\b//;
15014d001e4dSAndy Whitcroft			$s =~ s/^\s*{//;
15024d001e4dSAndy Whitcroft			if ($s =~ s/^\s*\\//) {
15034d001e4dSAndy Whitcroft				$continuation = 1;
15044d001e4dSAndy Whitcroft			}
15059bd49efeSAndy Whitcroft			if ($s =~ s/^\s*?\n//) {
15064d001e4dSAndy Whitcroft				$check = 1;
15074d001e4dSAndy Whitcroft				$cond_lines++;
15084d001e4dSAndy Whitcroft			}
15094d001e4dSAndy Whitcroft
15104d001e4dSAndy Whitcroft			# Also ignore a loop construct at the end of a
15114d001e4dSAndy Whitcroft			# preprocessor statement.
15124d001e4dSAndy Whitcroft			if (($prevline =~ /^.\s*#\s*define\s/ ||
15134d001e4dSAndy Whitcroft			    $prevline =~ /\\\s*$/) && $continuation == 0) {
15144d001e4dSAndy Whitcroft				$check = 0;
15154d001e4dSAndy Whitcroft			}
15164d001e4dSAndy Whitcroft
15179bd49efeSAndy Whitcroft			my $cond_ptr = -1;
1518740504c6SAndy Whitcroft			$continuation = 0;
15199bd49efeSAndy Whitcroft			while ($cond_ptr != $cond_lines) {
15209bd49efeSAndy Whitcroft				$cond_ptr = $cond_lines;
15214d001e4dSAndy Whitcroft
1522f16fa28fSAndy Whitcroft				# If we see an #else/#elif then the code
1523f16fa28fSAndy Whitcroft				# is not linear.
1524f16fa28fSAndy Whitcroft				if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1525f16fa28fSAndy Whitcroft					$check = 0;
1526f16fa28fSAndy Whitcroft				}
1527f16fa28fSAndy Whitcroft
15289bd49efeSAndy Whitcroft				# Ignore:
15299bd49efeSAndy Whitcroft				#  1) blank lines, they should be at 0,
15309bd49efeSAndy Whitcroft				#  2) preprocessor lines, and
15319bd49efeSAndy Whitcroft				#  3) labels.
1532740504c6SAndy Whitcroft				if ($continuation ||
1533740504c6SAndy Whitcroft				    $s =~ /^\s*?\n/ ||
15349bd49efeSAndy Whitcroft				    $s =~ /^\s*#\s*?/ ||
15359bd49efeSAndy Whitcroft				    $s =~ /^\s*$Ident\s*:/) {
1536740504c6SAndy Whitcroft					$continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
15379bd49efeSAndy Whitcroft					$s =~ s/^.*?\n//;
15389bd49efeSAndy Whitcroft					$cond_lines++;
15399bd49efeSAndy Whitcroft				}
15404d001e4dSAndy Whitcroft			}
15414d001e4dSAndy Whitcroft
15424d001e4dSAndy Whitcroft			my (undef, $sindent) = line_stats("+" . $s);
15434d001e4dSAndy Whitcroft			my $stat_real = raw_line($linenr, $cond_lines);
15444d001e4dSAndy Whitcroft
15454d001e4dSAndy Whitcroft			# Check if either of these lines are modified, else
15464d001e4dSAndy Whitcroft			# this is not this patch's fault.
15474d001e4dSAndy Whitcroft			if (!defined($stat_real) ||
15484d001e4dSAndy Whitcroft			    $stat !~ /^\+/ && $stat_real !~ /^\+/) {
15494d001e4dSAndy Whitcroft				$check = 0;
15504d001e4dSAndy Whitcroft			}
15514d001e4dSAndy Whitcroft			if (defined($stat_real) && $cond_lines > 1) {
15524d001e4dSAndy Whitcroft				$stat_real = "[...]\n$stat_real";
15534d001e4dSAndy Whitcroft			}
15544d001e4dSAndy Whitcroft
15559bd49efeSAndy Whitcroft			#print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s> cond_lines<$cond_lines> stat_real<$stat_real> stat<$stat>\n";
15564d001e4dSAndy Whitcroft
15574d001e4dSAndy Whitcroft			if ($check && (($sindent % 8) != 0 ||
15584d001e4dSAndy Whitcroft			    ($sindent <= $indent && $s ne ''))) {
15594d001e4dSAndy Whitcroft				WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
15604d001e4dSAndy Whitcroft			}
15614d001e4dSAndy Whitcroft		}
15624d001e4dSAndy Whitcroft
15636c72ffaaSAndy Whitcroft		# Track the 'values' across context and added lines.
15646c72ffaaSAndy Whitcroft		my $opline = $line; $opline =~ s/^./ /;
15651f65f947SAndy Whitcroft		my ($curr_values, $curr_vars) =
15661f65f947SAndy Whitcroft				annotate_values($opline . "\n", $prev_values);
15676c72ffaaSAndy Whitcroft		$curr_values = $prev_values . $curr_values;
1568c2fdda0dSAndy Whitcroft		if ($dbg_values) {
1569c2fdda0dSAndy Whitcroft			my $outline = $opline; $outline =~ s/\t/ /g;
1570cf655043SAndy Whitcroft			print "$linenr > .$outline\n";
1571cf655043SAndy Whitcroft			print "$linenr > $curr_values\n";
15721f65f947SAndy Whitcroft			print "$linenr >  $curr_vars\n";
1573c2fdda0dSAndy Whitcroft		}
15746c72ffaaSAndy Whitcroft		$prev_values = substr($curr_values, -1);
15756c72ffaaSAndy Whitcroft
157600df344fSAndy Whitcroft#ignore lines not being added
157700df344fSAndy Whitcroft		if ($line=~/^[^\+]/) {next;}
157800df344fSAndy Whitcroft
1579653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher.
15807429c690SAndy Whitcroft		if ($dbg_type) {
15817429c690SAndy Whitcroft			if ($line =~ /^.\s*$Declare\s*$/) {
15827429c690SAndy Whitcroft				ERROR("TEST: is type\n" . $herecurr);
15837429c690SAndy Whitcroft			} elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
15847429c690SAndy Whitcroft				ERROR("TEST: is not type ($1 is)\n". $herecurr);
15857429c690SAndy Whitcroft			}
1586653d4876SAndy Whitcroft			next;
1587653d4876SAndy Whitcroft		}
1588a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher.
1589a1ef277eSAndy Whitcroft		if ($dbg_attr) {
15909360b0e5SAndy Whitcroft			if ($line =~ /^.\s*$Modifier\s*$/) {
1591a1ef277eSAndy Whitcroft				ERROR("TEST: is attr\n" . $herecurr);
15929360b0e5SAndy Whitcroft			} elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
1593a1ef277eSAndy Whitcroft				ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1594a1ef277eSAndy Whitcroft			}
1595a1ef277eSAndy Whitcroft			next;
1596a1ef277eSAndy Whitcroft		}
1597653d4876SAndy Whitcroft
1598f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line
1599f0a594c1SAndy Whitcroft		if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
1600f0a594c1SAndy Whitcroft		    $line =~ /^.\s*{/) {
1601773647a0SAndy Whitcroft			ERROR("that open brace { should be on the previous line\n" . $hereprev);
1602f0a594c1SAndy Whitcroft		}
1603f0a594c1SAndy Whitcroft
160400df344fSAndy Whitcroft#
160500df344fSAndy Whitcroft# Checks which are anchored on the added line.
160600df344fSAndy Whitcroft#
160700df344fSAndy Whitcroft
1608653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line)
1609c45dcabdSAndy Whitcroft		if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
1610653d4876SAndy Whitcroft			my $path = $1;
1611653d4876SAndy Whitcroft			if ($path =~ m{//}) {
1612de7d4f0eSAndy Whitcroft				ERROR("malformed #include filename\n" .
1613de7d4f0eSAndy Whitcroft					$herecurr);
1614653d4876SAndy Whitcroft			}
1615653d4876SAndy Whitcroft		}
1616653d4876SAndy Whitcroft
161700df344fSAndy Whitcroft# no C99 // comments
161800df344fSAndy Whitcroft		if ($line =~ m{//}) {
1619de7d4f0eSAndy Whitcroft			ERROR("do not use C99 // comments\n" . $herecurr);
162000df344fSAndy Whitcroft		}
162100df344fSAndy Whitcroft		# Remove C99 comments.
16220a920b5bSAndy Whitcroft		$line =~ s@//.*@@;
16236c72ffaaSAndy Whitcroft		$opline =~ s@//.*@@;
16240a920b5bSAndy Whitcroft
16250a920b5bSAndy Whitcroft#EXPORT_SYMBOL should immediately follow its function closing }.
1626653d4876SAndy Whitcroft		if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
1627653d4876SAndy Whitcroft		    ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1628653d4876SAndy Whitcroft			my $name = $1;
162948012058SAndy Whitcroft			if ($prevline !~ /(?:
163048012058SAndy Whitcroft				^.}|
163148012058SAndy Whitcroft				^.DEFINE_$Ident\(\Q$name\E\)|
163248012058SAndy Whitcroft				^.DECLARE_$Ident\(\Q$name\E\)|
163348012058SAndy Whitcroft				^.LIST_HEAD\(\Q$name\E\)|
163448012058SAndy Whitcroft				^.$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
163548012058SAndy Whitcroft				\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=|\[)
163648012058SAndy Whitcroft			    )/x) {
1637de7d4f0eSAndy Whitcroft				WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
16380a920b5bSAndy Whitcroft			}
16390a920b5bSAndy Whitcroft		}
16400a920b5bSAndy Whitcroft
1641f0a594c1SAndy Whitcroft# check for external initialisers.
1642c45dcabdSAndy Whitcroft		if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
1643f0a594c1SAndy Whitcroft			ERROR("do not initialise externals to 0 or NULL\n" .
1644f0a594c1SAndy Whitcroft				$herecurr);
1645f0a594c1SAndy Whitcroft		}
16460a920b5bSAndy Whitcroft# check for static initialisers.
16472d1bafd7SAndy Whitcroft		if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
1648de7d4f0eSAndy Whitcroft			ERROR("do not initialise statics to 0 or NULL\n" .
1649de7d4f0eSAndy Whitcroft				$herecurr);
16500a920b5bSAndy Whitcroft		}
16510a920b5bSAndy Whitcroft
1652653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations
1653653d4876SAndy Whitcroft# make sense.
1654653d4876SAndy Whitcroft		if ($line =~ /\btypedef\s/ &&
16558054576dSAndy Whitcroft		    $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
1656c45dcabdSAndy Whitcroft		    $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
16578ed22cadSAndy Whitcroft		    $line !~ /\b$typeTypedefs\b/ &&
1658653d4876SAndy Whitcroft		    $line !~ /\b__bitwise(?:__|)\b/) {
1659de7d4f0eSAndy Whitcroft			WARN("do not add new typedefs\n" . $herecurr);
16600a920b5bSAndy Whitcroft		}
16610a920b5bSAndy Whitcroft
16620a920b5bSAndy Whitcroft# * goes on variable not on type
166365863862SAndy Whitcroft		# (char*[ const])
166400ef4eceSAndy Whitcroft		if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
166565863862SAndy Whitcroft			my ($from, $to) = ($1, $1);
1666d8aaf121SAndy Whitcroft
166765863862SAndy Whitcroft			# Should start with a space.
166865863862SAndy Whitcroft			$to =~ s/^(\S)/ $1/;
166965863862SAndy Whitcroft			# Should not end with a space.
167065863862SAndy Whitcroft			$to =~ s/\s+$//;
167165863862SAndy Whitcroft			# '*'s should not have spaces between.
1672f9a0b3d1SAndy Whitcroft			while ($to =~ s/\*\s+\*/\*\*/) {
167365863862SAndy Whitcroft			}
1674d8aaf121SAndy Whitcroft
167565863862SAndy Whitcroft			#print "from<$from> to<$to>\n";
167665863862SAndy Whitcroft			if ($from ne $to) {
167765863862SAndy Whitcroft				ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" .  $herecurr);
167865863862SAndy Whitcroft			}
167900ef4eceSAndy Whitcroft		} elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
168065863862SAndy Whitcroft			my ($from, $to, $ident) = ($1, $1, $2);
1681d8aaf121SAndy Whitcroft
168265863862SAndy Whitcroft			# Should start with a space.
168365863862SAndy Whitcroft			$to =~ s/^(\S)/ $1/;
168465863862SAndy Whitcroft			# Should not end with a space.
168565863862SAndy Whitcroft			$to =~ s/\s+$//;
168665863862SAndy Whitcroft			# '*'s should not have spaces between.
1687f9a0b3d1SAndy Whitcroft			while ($to =~ s/\*\s+\*/\*\*/) {
168865863862SAndy Whitcroft			}
168965863862SAndy Whitcroft			# Modifiers should have spaces.
169065863862SAndy Whitcroft			$to =~ s/(\b$Modifier$)/$1 /;
169165863862SAndy Whitcroft
1692667026e7SAndy Whitcroft			#print "from<$from> to<$to> ident<$ident>\n";
1693667026e7SAndy Whitcroft			if ($from ne $to && $ident !~ /^$Modifier$/) {
169465863862SAndy Whitcroft				ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" .  $herecurr);
169565863862SAndy Whitcroft			}
16960a920b5bSAndy Whitcroft		}
16970a920b5bSAndy Whitcroft
16980a920b5bSAndy Whitcroft# # no BUG() or BUG_ON()
16990a920b5bSAndy Whitcroft# 		if ($line =~ /\b(BUG|BUG_ON)\b/) {
17000a920b5bSAndy Whitcroft# 			print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
17010a920b5bSAndy Whitcroft# 			print "$herecurr";
17020a920b5bSAndy Whitcroft# 			$clean = 0;
17030a920b5bSAndy Whitcroft# 		}
17040a920b5bSAndy Whitcroft
17058905a67cSAndy Whitcroft		if ($line =~ /\bLINUX_VERSION_CODE\b/) {
1706c2fdda0dSAndy Whitcroft			WARN("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
17078905a67cSAndy Whitcroft		}
17088905a67cSAndy Whitcroft
170900df344fSAndy Whitcroft# printk should use KERN_* levels.  Note that follow on printk's on the
171000df344fSAndy Whitcroft# same line do not need a level, so we use the current block context
171100df344fSAndy Whitcroft# to try and find and validate the current printk.  In summary the current
171200df344fSAndy Whitcroft# printk includes all preceeding printk's which have no newline on the end.
171300df344fSAndy Whitcroft# we assume the first bad printk is the one to report.
1714f0a594c1SAndy Whitcroft		if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
171500df344fSAndy Whitcroft			my $ok = 0;
171600df344fSAndy Whitcroft			for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
171700df344fSAndy Whitcroft				#print "CHECK<$lines[$ln - 1]\n";
171800df344fSAndy Whitcroft				# we have a preceeding printk if it ends
171900df344fSAndy Whitcroft				# with "\n" ignore it, else it is to blame
172000df344fSAndy Whitcroft				if ($lines[$ln - 1] =~ m{\bprintk\(}) {
172100df344fSAndy Whitcroft					if ($rawlines[$ln - 1] !~ m{\\n"}) {
172200df344fSAndy Whitcroft						$ok = 1;
172300df344fSAndy Whitcroft					}
172400df344fSAndy Whitcroft					last;
172500df344fSAndy Whitcroft				}
172600df344fSAndy Whitcroft			}
172700df344fSAndy Whitcroft			if ($ok == 0) {
1728de7d4f0eSAndy Whitcroft				WARN("printk() should include KERN_ facility level\n" . $herecurr);
17290a920b5bSAndy Whitcroft			}
173000df344fSAndy Whitcroft		}
17310a920b5bSAndy Whitcroft
1732653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while,
1733653d4876SAndy Whitcroft# or if closed on same line
1734c45dcabdSAndy Whitcroft		if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1735c45dcabdSAndy Whitcroft		    !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
1736de7d4f0eSAndy Whitcroft			ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
17370a920b5bSAndy Whitcroft		}
1738653d4876SAndy Whitcroft
17398905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line.
17408905a67cSAndy Whitcroft		if ($line =~ /^.\s*{/ &&
17418905a67cSAndy Whitcroft		    $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
17428905a67cSAndy Whitcroft			ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
17438905a67cSAndy Whitcroft		}
17448905a67cSAndy Whitcroft
17458d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed:
17468d31cfceSAndy Whitcroft#  1. with a type on the left -- int [] a;
1747fe2a7dbcSAndy Whitcroft#  2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1748fe2a7dbcSAndy Whitcroft#  3. inside a curly brace -- = { [0...10] = 5 }
17498d31cfceSAndy Whitcroft		while ($line =~ /(.*?\s)\[/g) {
17508d31cfceSAndy Whitcroft			my ($where, $prefix) = ($-[1], $1);
17518d31cfceSAndy Whitcroft			if ($prefix !~ /$Type\s+$/ &&
1752fe2a7dbcSAndy Whitcroft			    ($where != 0 || $prefix !~ /^.\s+$/) &&
1753fe2a7dbcSAndy Whitcroft			    $prefix !~ /{\s+$/) {
17548d31cfceSAndy Whitcroft				ERROR("space prohibited before open square bracket '['\n" . $herecurr);
17558d31cfceSAndy Whitcroft			}
17568d31cfceSAndy Whitcroft		}
17578d31cfceSAndy Whitcroft
1758f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses.
17596c72ffaaSAndy Whitcroft		while ($line =~ /($Ident)\s+\(/g) {
1760c2fdda0dSAndy Whitcroft			my $name = $1;
1761773647a0SAndy Whitcroft			my $ctx_before = substr($line, 0, $-[1]);
1762773647a0SAndy Whitcroft			my $ctx = "$ctx_before$name";
1763c2fdda0dSAndy Whitcroft
1764c2fdda0dSAndy Whitcroft			# Ignore those directives where spaces _are_ permitted.
1765773647a0SAndy Whitcroft			if ($name =~ /^(?:
1766773647a0SAndy Whitcroft				if|for|while|switch|return|case|
1767773647a0SAndy Whitcroft				volatile|__volatile__|
1768773647a0SAndy Whitcroft				__attribute__|format|__extension__|
1769773647a0SAndy Whitcroft				asm|__asm__)$/x)
1770773647a0SAndy Whitcroft			{
1771c2fdda0dSAndy Whitcroft
1772c2fdda0dSAndy Whitcroft			# cpp #define statements have non-optional spaces, ie
1773c2fdda0dSAndy Whitcroft			# if there is a space between the name and the open
1774c2fdda0dSAndy Whitcroft			# parenthesis it is simply not a parameter group.
1775c45dcabdSAndy Whitcroft			} elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
1776773647a0SAndy Whitcroft
1777773647a0SAndy Whitcroft			# cpp #elif statement condition may start with a (
1778c45dcabdSAndy Whitcroft			} elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
1779c2fdda0dSAndy Whitcroft
1780c2fdda0dSAndy Whitcroft			# If this whole things ends with a type its most
1781c2fdda0dSAndy Whitcroft			# likely a typedef for a function.
1782773647a0SAndy Whitcroft			} elsif ($ctx =~ /$Type$/) {
1783c2fdda0dSAndy Whitcroft
1784c2fdda0dSAndy Whitcroft			} else {
1785773647a0SAndy Whitcroft				WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
1786f0a594c1SAndy Whitcroft			}
17876c72ffaaSAndy Whitcroft		}
1788653d4876SAndy Whitcroft# Check operator spacing.
17890a920b5bSAndy Whitcroft		if (!($line=~/\#\s*include/)) {
17909c0ca6f9SAndy Whitcroft			my $ops = qr{
17919c0ca6f9SAndy Whitcroft				<<=|>>=|<=|>=|==|!=|
17929c0ca6f9SAndy Whitcroft				\+=|-=|\*=|\/=|%=|\^=|\|=|&=|
17939c0ca6f9SAndy Whitcroft				=>|->|<<|>>|<|>|=|!|~|
17941f65f947SAndy Whitcroft				&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
17951f65f947SAndy Whitcroft				\?|:
17969c0ca6f9SAndy Whitcroft			}x;
1797cf655043SAndy Whitcroft			my @elements = split(/($ops|;)/, $opline);
179800df344fSAndy Whitcroft			my $off = 0;
17996c72ffaaSAndy Whitcroft
18006c72ffaaSAndy Whitcroft			my $blank = copy_spacing($opline);
18016c72ffaaSAndy Whitcroft
18020a920b5bSAndy Whitcroft			for (my $n = 0; $n < $#elements; $n += 2) {
18034a0df2efSAndy Whitcroft				$off += length($elements[$n]);
18044a0df2efSAndy Whitcroft
1805773647a0SAndy Whitcroft				# Pick up the preceeding and succeeding characters.
1806773647a0SAndy Whitcroft				my $ca = substr($opline, 0, $off);
1807773647a0SAndy Whitcroft				my $cc = '';
1808773647a0SAndy Whitcroft				if (length($opline) >= ($off + length($elements[$n + 1]))) {
1809773647a0SAndy Whitcroft					$cc = substr($opline, $off + length($elements[$n + 1]));
1810773647a0SAndy Whitcroft				}
1811773647a0SAndy Whitcroft				my $cb = "$ca$;$cc";
1812773647a0SAndy Whitcroft
18134a0df2efSAndy Whitcroft				my $a = '';
18144a0df2efSAndy Whitcroft				$a = 'V' if ($elements[$n] ne '');
18154a0df2efSAndy Whitcroft				$a = 'W' if ($elements[$n] =~ /\s$/);
1816cf655043SAndy Whitcroft				$a = 'C' if ($elements[$n] =~ /$;$/);
18174a0df2efSAndy Whitcroft				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
18184a0df2efSAndy Whitcroft				$a = 'O' if ($elements[$n] eq '');
1819773647a0SAndy Whitcroft				$a = 'E' if ($ca =~ /^\s*$/);
18204a0df2efSAndy Whitcroft
18210a920b5bSAndy Whitcroft				my $op = $elements[$n + 1];
18224a0df2efSAndy Whitcroft
18234a0df2efSAndy Whitcroft				my $c = '';
18240a920b5bSAndy Whitcroft				if (defined $elements[$n + 2]) {
18254a0df2efSAndy Whitcroft					$c = 'V' if ($elements[$n + 2] ne '');
18264a0df2efSAndy Whitcroft					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
1827cf655043SAndy Whitcroft					$c = 'C' if ($elements[$n + 2] =~ /^$;/);
18284a0df2efSAndy Whitcroft					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
18294a0df2efSAndy Whitcroft					$c = 'O' if ($elements[$n + 2] eq '');
18308b1b3378SAndy Whitcroft					$c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
18314a0df2efSAndy Whitcroft				} else {
18324a0df2efSAndy Whitcroft					$c = 'E';
18330a920b5bSAndy Whitcroft				}
18340a920b5bSAndy Whitcroft
18354a0df2efSAndy Whitcroft				my $ctx = "${a}x${c}";
18364a0df2efSAndy Whitcroft
18374a0df2efSAndy Whitcroft				my $at = "(ctx:$ctx)";
18384a0df2efSAndy Whitcroft
18396c72ffaaSAndy Whitcroft				my $ptr = substr($blank, 0, $off) . "^";
1840de7d4f0eSAndy Whitcroft				my $hereptr = "$hereline$ptr\n";
18410a920b5bSAndy Whitcroft
184274048ed8SAndy Whitcroft				# Pull out the value of this operator.
18436c72ffaaSAndy Whitcroft				my $op_type = substr($curr_values, $off + 1, 1);
18440a920b5bSAndy Whitcroft
18451f65f947SAndy Whitcroft				# Get the full operator variant.
18461f65f947SAndy Whitcroft				my $opv = $op . substr($curr_vars, $off, 1);
18471f65f947SAndy Whitcroft
184813214adfSAndy Whitcroft				# Ignore operators passed as parameters.
184913214adfSAndy Whitcroft				if ($op_type ne 'V' &&
185013214adfSAndy Whitcroft				    $ca =~ /\s$/ && $cc =~ /^\s*,/) {
185113214adfSAndy Whitcroft
1852cf655043SAndy Whitcroft#				# Ignore comments
1853cf655043SAndy Whitcroft#				} elsif ($op =~ /^$;+$/) {
185413214adfSAndy Whitcroft
1855d8aaf121SAndy Whitcroft				# ; should have either the end of line or a space or \ after it
185613214adfSAndy Whitcroft				} elsif ($op eq ';') {
1857cf655043SAndy Whitcroft					if ($ctx !~ /.x[WEBC]/ &&
1858cf655043SAndy Whitcroft					    $cc !~ /^\\/ && $cc !~ /^;/) {
1859773647a0SAndy Whitcroft						ERROR("space required after that '$op' $at\n" . $hereptr);
1860d8aaf121SAndy Whitcroft					}
1861d8aaf121SAndy Whitcroft
1862d8aaf121SAndy Whitcroft				# // is a comment
1863d8aaf121SAndy Whitcroft				} elsif ($op eq '//') {
18640a920b5bSAndy Whitcroft
18651f65f947SAndy Whitcroft				# No spaces for:
18661f65f947SAndy Whitcroft				#   ->
18671f65f947SAndy Whitcroft				#   :   when part of a bitfield
18681f65f947SAndy Whitcroft				} elsif ($op eq '->' || $opv eq ':B') {
18694a0df2efSAndy Whitcroft					if ($ctx =~ /Wx.|.xW/) {
1870773647a0SAndy Whitcroft						ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
18710a920b5bSAndy Whitcroft					}
18720a920b5bSAndy Whitcroft
18730a920b5bSAndy Whitcroft				# , must have a space on the right.
18740a920b5bSAndy Whitcroft				} elsif ($op eq ',') {
1875cf655043SAndy Whitcroft					if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
1876773647a0SAndy Whitcroft						ERROR("space required after that '$op' $at\n" . $hereptr);
18770a920b5bSAndy Whitcroft					}
18780a920b5bSAndy Whitcroft
18799c0ca6f9SAndy Whitcroft				# '*' as part of a type definition -- reported already.
188074048ed8SAndy Whitcroft				} elsif ($opv eq '*_') {
18819c0ca6f9SAndy Whitcroft					#warn "'*' is part of type\n";
18829c0ca6f9SAndy Whitcroft
18839c0ca6f9SAndy Whitcroft				# unary operators should have a space before and
18849c0ca6f9SAndy Whitcroft				# none after.  May be left adjacent to another
18859c0ca6f9SAndy Whitcroft				# unary operator, or a cast
18869c0ca6f9SAndy Whitcroft				} elsif ($op eq '!' || $op eq '~' ||
188774048ed8SAndy Whitcroft					 $opv eq '*U' || $opv eq '-U' ||
18880d413866SAndy Whitcroft					 $opv eq '&U' || $opv eq '&&U') {
1889cf655043SAndy Whitcroft					if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
1890773647a0SAndy Whitcroft						ERROR("space required before that '$op' $at\n" . $hereptr);
18910a920b5bSAndy Whitcroft					}
1892a3340b35SAndy Whitcroft					if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
1893171ae1a4SAndy Whitcroft						# A unary '*' may be const
1894171ae1a4SAndy Whitcroft
1895171ae1a4SAndy Whitcroft					} elsif ($ctx =~ /.xW/) {
1896a3340b35SAndy Whitcroft						ERROR("Aspace prohibited after that '$op' $at\n" . $hereptr);
18970a920b5bSAndy Whitcroft					}
18980a920b5bSAndy Whitcroft
18990a920b5bSAndy Whitcroft				# unary ++ and unary -- are allowed no space on one side.
19000a920b5bSAndy Whitcroft				} elsif ($op eq '++' or $op eq '--') {
1901773647a0SAndy Whitcroft					if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
1902773647a0SAndy Whitcroft						ERROR("space required one side of that '$op' $at\n" . $hereptr);
19030a920b5bSAndy Whitcroft					}
1904773647a0SAndy Whitcroft					if ($ctx =~ /Wx[BE]/ ||
1905773647a0SAndy Whitcroft					    ($ctx =~ /Wx./ && $cc =~ /^;/)) {
1906773647a0SAndy Whitcroft						ERROR("space prohibited before that '$op' $at\n" . $hereptr);
1907653d4876SAndy Whitcroft					}
1908773647a0SAndy Whitcroft					if ($ctx =~ /ExW/) {
1909773647a0SAndy Whitcroft						ERROR("space prohibited after that '$op' $at\n" . $hereptr);
1910773647a0SAndy Whitcroft					}
1911773647a0SAndy Whitcroft
19120a920b5bSAndy Whitcroft
19130a920b5bSAndy Whitcroft				# << and >> may either have or not have spaces both sides
19149c0ca6f9SAndy Whitcroft				} elsif ($op eq '<<' or $op eq '>>' or
19159c0ca6f9SAndy Whitcroft					 $op eq '&' or $op eq '^' or $op eq '|' or
19169c0ca6f9SAndy Whitcroft					 $op eq '+' or $op eq '-' or
1917c2fdda0dSAndy Whitcroft					 $op eq '*' or $op eq '/' or
1918c2fdda0dSAndy Whitcroft					 $op eq '%')
19190a920b5bSAndy Whitcroft				{
1920773647a0SAndy Whitcroft					if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
1921de7d4f0eSAndy Whitcroft						ERROR("need consistent spacing around '$op' $at\n" .
1922de7d4f0eSAndy Whitcroft							$hereptr);
19230a920b5bSAndy Whitcroft					}
19240a920b5bSAndy Whitcroft
19251f65f947SAndy Whitcroft				# A colon needs no spaces before when it is
19261f65f947SAndy Whitcroft				# terminating a case value or a label.
19271f65f947SAndy Whitcroft				} elsif ($opv eq ':C' || $opv eq ':L') {
19281f65f947SAndy Whitcroft					if ($ctx =~ /Wx./) {
19291f65f947SAndy Whitcroft						ERROR("space prohibited before that '$op' $at\n" . $hereptr);
19301f65f947SAndy Whitcroft					}
19311f65f947SAndy Whitcroft
19320a920b5bSAndy Whitcroft				# All the others need spaces both sides.
1933cf655043SAndy Whitcroft				} elsif ($ctx !~ /[EWC]x[CWE]/) {
19341f65f947SAndy Whitcroft					my $ok = 0;
19351f65f947SAndy Whitcroft
193622f2a2efSAndy Whitcroft					# Ignore email addresses <foo@bar>
19371f65f947SAndy Whitcroft					if (($op eq '<' &&
19381f65f947SAndy Whitcroft					     $cc =~ /^\S+\@\S+>/) ||
19391f65f947SAndy Whitcroft					    ($op eq '>' &&
19401f65f947SAndy Whitcroft					     $ca =~ /<\S+\@\S+$/))
19411f65f947SAndy Whitcroft					{
19421f65f947SAndy Whitcroft					    	$ok = 1;
19431f65f947SAndy Whitcroft					}
19441f65f947SAndy Whitcroft
19451f65f947SAndy Whitcroft					# Ignore ?:
19461f65f947SAndy Whitcroft					if (($opv eq ':O' && $ca =~ /\?$/) ||
19471f65f947SAndy Whitcroft					    ($op eq '?' && $cc =~ /^:/)) {
19481f65f947SAndy Whitcroft					    	$ok = 1;
19491f65f947SAndy Whitcroft					}
19501f65f947SAndy Whitcroft
19511f65f947SAndy Whitcroft					if ($ok == 0) {
1952773647a0SAndy Whitcroft						ERROR("spaces required around that '$op' $at\n" . $hereptr);
19530a920b5bSAndy Whitcroft					}
195422f2a2efSAndy Whitcroft				}
19554a0df2efSAndy Whitcroft				$off += length($elements[$n + 1]);
19560a920b5bSAndy Whitcroft			}
19570a920b5bSAndy Whitcroft		}
19580a920b5bSAndy Whitcroft
1959f0a594c1SAndy Whitcroft# check for multiple assignments
1960f0a594c1SAndy Whitcroft		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
19616c72ffaaSAndy Whitcroft			CHK("multiple assignments should be avoided\n" . $herecurr);
1962f0a594c1SAndy Whitcroft		}
1963f0a594c1SAndy Whitcroft
196422f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration
196522f2a2efSAndy Whitcroft## # continuation.
196622f2a2efSAndy Whitcroft## 		if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
196722f2a2efSAndy Whitcroft## 		    $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
196822f2a2efSAndy Whitcroft##
196922f2a2efSAndy Whitcroft## 			# Remove any bracketed sections to ensure we do not
197022f2a2efSAndy Whitcroft## 			# falsly report the parameters of functions.
197122f2a2efSAndy Whitcroft## 			my $ln = $line;
197222f2a2efSAndy Whitcroft## 			while ($ln =~ s/\([^\(\)]*\)//g) {
197322f2a2efSAndy Whitcroft## 			}
197422f2a2efSAndy Whitcroft## 			if ($ln =~ /,/) {
197522f2a2efSAndy Whitcroft## 				WARN("declaring multiple variables together should be avoided\n" . $herecurr);
197622f2a2efSAndy Whitcroft## 			}
197722f2a2efSAndy Whitcroft## 		}
1978f0a594c1SAndy Whitcroft
19790a920b5bSAndy Whitcroft#need space before brace following if, while, etc
198022f2a2efSAndy Whitcroft		if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
198122f2a2efSAndy Whitcroft		    $line =~ /do{/) {
1982773647a0SAndy Whitcroft			ERROR("space required before the open brace '{'\n" . $herecurr);
1983de7d4f0eSAndy Whitcroft		}
1984de7d4f0eSAndy Whitcroft
1985de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything
1986de7d4f0eSAndy Whitcroft# on the line
1987de7d4f0eSAndy Whitcroft		if ($line =~ /}(?!(?:,|;|\)))\S/) {
1988773647a0SAndy Whitcroft			ERROR("space required after that close brace '}'\n" . $herecurr);
19890a920b5bSAndy Whitcroft		}
19900a920b5bSAndy Whitcroft
199122f2a2efSAndy Whitcroft# check spacing on square brackets
199222f2a2efSAndy Whitcroft		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
1993773647a0SAndy Whitcroft			ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
199422f2a2efSAndy Whitcroft		}
199522f2a2efSAndy Whitcroft		if ($line =~ /\s\]/) {
1996773647a0SAndy Whitcroft			ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
199722f2a2efSAndy Whitcroft		}
199822f2a2efSAndy Whitcroft
1999c45dcabdSAndy Whitcroft# check spacing on parentheses
20009c0ca6f9SAndy Whitcroft		if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
20019c0ca6f9SAndy Whitcroft		    $line !~ /for\s*\(\s+;/) {
2002773647a0SAndy Whitcroft			ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
200322f2a2efSAndy Whitcroft		}
200413214adfSAndy Whitcroft		if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
2005c45dcabdSAndy Whitcroft		    $line !~ /for\s*\(.*;\s+\)/ &&
2006c45dcabdSAndy Whitcroft		    $line !~ /:\s+\)/) {
2007773647a0SAndy Whitcroft			ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
200822f2a2efSAndy Whitcroft		}
200922f2a2efSAndy Whitcroft
20100a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however
20114a0df2efSAndy Whitcroft		if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
20120a920b5bSAndy Whitcroft		   !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
2013de7d4f0eSAndy Whitcroft			WARN("labels should not be indented\n" . $herecurr);
20140a920b5bSAndy Whitcroft		}
20150a920b5bSAndy Whitcroft
2016c45dcabdSAndy Whitcroft# Return is not a function.
2017c45dcabdSAndy Whitcroft		if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2018c45dcabdSAndy Whitcroft			my $spacing = $1;
2019c45dcabdSAndy Whitcroft			my $value = $2;
2020c45dcabdSAndy Whitcroft
202186f9d059SAndy Whitcroft			# Flatten any parentheses
2022fee61c47SAndy Whitcroft			$value =~ s/\)\(/\) \(/g;
202363f17f89SAndy Whitcroft			while ($value =~ s/\[[^\{\}]*\]/1/ ||
202463f17f89SAndy Whitcroft			       $value !~ /(?:$Ident|-?$Constant)\s*
202563f17f89SAndy Whitcroft					     $Compare\s*
202663f17f89SAndy Whitcroft					     (?:$Ident|-?$Constant)/x &&
202763f17f89SAndy Whitcroft			       $value =~ s/\([^\(\)]*\)/1/) {
2028c45dcabdSAndy Whitcroft			}
2029c45dcabdSAndy Whitcroft
2030c45dcabdSAndy Whitcroft			if ($value =~ /^(?:$Ident|-?$Constant)$/) {
2031c45dcabdSAndy Whitcroft				ERROR("return is not a function, parentheses are not required\n" . $herecurr);
2032c45dcabdSAndy Whitcroft
2033c45dcabdSAndy Whitcroft			} elsif ($spacing !~ /\s+/) {
2034c45dcabdSAndy Whitcroft				ERROR("space required before the open parenthesis '('\n" . $herecurr);
2035c45dcabdSAndy Whitcroft			}
2036c45dcabdSAndy Whitcroft		}
2037c45dcabdSAndy Whitcroft
20380a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc
20394a0df2efSAndy Whitcroft		if ($line=~/\b(if|while|for|switch)\(/) {
2040773647a0SAndy Whitcroft			ERROR("space required before the open parenthesis '('\n" . $herecurr);
20410a920b5bSAndy Whitcroft		}
20420a920b5bSAndy Whitcroft
2043f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing
2044f5fe35ddSAndy Whitcroft# statements after the conditional.
2045170d3a22SAndy Whitcroft		if ($line =~ /do\s*(?!{)/) {
2046170d3a22SAndy Whitcroft			my ($stat_next) = ctx_statement_block($line_nr_next,
2047170d3a22SAndy Whitcroft						$remain_next, $off_next);
2048170d3a22SAndy Whitcroft			$stat_next =~ s/\n./\n /g;
2049170d3a22SAndy Whitcroft			##print "stat<$stat> stat_next<$stat_next>\n";
2050170d3a22SAndy Whitcroft
2051170d3a22SAndy Whitcroft			if ($stat_next =~ /^\s*while\b/) {
2052170d3a22SAndy Whitcroft				# If the statement carries leading newlines,
2053170d3a22SAndy Whitcroft				# then count those as offsets.
2054170d3a22SAndy Whitcroft				my ($whitespace) =
2055170d3a22SAndy Whitcroft					($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2056170d3a22SAndy Whitcroft				my $offset =
2057170d3a22SAndy Whitcroft					statement_rawlines($whitespace) - 1;
2058170d3a22SAndy Whitcroft
2059170d3a22SAndy Whitcroft				$suppress_whiletrailers{$line_nr_next +
2060170d3a22SAndy Whitcroft								$offset} = 1;
2061170d3a22SAndy Whitcroft			}
2062170d3a22SAndy Whitcroft		}
2063170d3a22SAndy Whitcroft		if (!defined $suppress_whiletrailers{$linenr} &&
2064170d3a22SAndy Whitcroft		    $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
2065171ae1a4SAndy Whitcroft			my ($s, $c) = ($stat, $cond);
20668905a67cSAndy Whitcroft
2067b53c8e10SAndy Whitcroft			if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2068c2fdda0dSAndy Whitcroft				ERROR("do not use assignment in if condition\n" . $herecurr);
20698905a67cSAndy Whitcroft			}
20708905a67cSAndy Whitcroft
20718905a67cSAndy Whitcroft			# Find out what is on the end of the line after the
20728905a67cSAndy Whitcroft			# conditional.
2073773647a0SAndy Whitcroft			substr($s, 0, length($c), '');
20748905a67cSAndy Whitcroft			$s =~ s/\n.*//g;
207513214adfSAndy Whitcroft			$s =~ s/$;//g; 	# Remove any comments
207653210168SAndy Whitcroft			if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
207753210168SAndy Whitcroft			    $c !~ /}\s*while\s*/)
2078773647a0SAndy Whitcroft			{
2079bb44ad39SAndy Whitcroft				# Find out how long the conditional actually is.
2080bb44ad39SAndy Whitcroft				my @newlines = ($c =~ /\n/gs);
2081bb44ad39SAndy Whitcroft				my $cond_lines = 1 + $#newlines;
2082bb44ad39SAndy Whitcroft
2083bb44ad39SAndy Whitcroft				my $stat_real = raw_line($linenr, $cond_lines);
2084bb44ad39SAndy Whitcroft				if (defined($stat_real) && $cond_lines > 1) {
2085bb44ad39SAndy Whitcroft					$stat_real = "[...]\n$stat_real";
2086bb44ad39SAndy Whitcroft				}
2087bb44ad39SAndy Whitcroft
2088bb44ad39SAndy Whitcroft				ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real);
20898905a67cSAndy Whitcroft			}
20908905a67cSAndy Whitcroft		}
20918905a67cSAndy Whitcroft
209213214adfSAndy Whitcroft# Check for bitwise tests written as boolean
209313214adfSAndy Whitcroft		if ($line =~ /
209413214adfSAndy Whitcroft			(?:
209513214adfSAndy Whitcroft				(?:\[|\(|\&\&|\|\|)
209613214adfSAndy Whitcroft				\s*0[xX][0-9]+\s*
209713214adfSAndy Whitcroft				(?:\&\&|\|\|)
209813214adfSAndy Whitcroft			|
209913214adfSAndy Whitcroft				(?:\&\&|\|\|)
210013214adfSAndy Whitcroft				\s*0[xX][0-9]+\s*
210113214adfSAndy Whitcroft				(?:\&\&|\|\||\)|\])
210213214adfSAndy Whitcroft			)/x)
210313214adfSAndy Whitcroft		{
210413214adfSAndy Whitcroft			WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
210513214adfSAndy Whitcroft		}
210613214adfSAndy Whitcroft
21078905a67cSAndy Whitcroft# if and else should not have general statements after it
210813214adfSAndy Whitcroft		if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
210913214adfSAndy Whitcroft			my $s = $1;
211013214adfSAndy Whitcroft			$s =~ s/$;//g; 	# Remove any comments
211113214adfSAndy Whitcroft			if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
21128905a67cSAndy Whitcroft				ERROR("trailing statements should be on next line\n" . $herecurr);
21130a920b5bSAndy Whitcroft			}
211413214adfSAndy Whitcroft		}
211539667782SAndy Whitcroft# if should not continue a brace
211639667782SAndy Whitcroft		if ($line =~ /}\s*if\b/) {
211739667782SAndy Whitcroft			ERROR("trailing statements should be on next line\n" .
211839667782SAndy Whitcroft				$herecurr);
211939667782SAndy Whitcroft		}
2120a1080bf8SAndy Whitcroft# case and default should not have general statements after them
2121a1080bf8SAndy Whitcroft		if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2122a1080bf8SAndy Whitcroft		    $line !~ /\G(?:
21233fef12d6SAndy Whitcroft			(?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
2124a1080bf8SAndy Whitcroft			\s*return\s+
2125a1080bf8SAndy Whitcroft		    )/xg)
2126a1080bf8SAndy Whitcroft		{
2127a1080bf8SAndy Whitcroft			ERROR("trailing statements should be on next line\n" . $herecurr);
2128a1080bf8SAndy Whitcroft		}
21290a920b5bSAndy Whitcroft
21300a920b5bSAndy Whitcroft		# Check for }<nl>else {, these must be at the same
21310a920b5bSAndy Whitcroft		# indent level to be relevant to each other.
21320a920b5bSAndy Whitcroft		if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
21330a920b5bSAndy Whitcroft						$previndent == $indent) {
2134de7d4f0eSAndy Whitcroft			ERROR("else should follow close brace '}'\n" . $hereprev);
21350a920b5bSAndy Whitcroft		}
21360a920b5bSAndy Whitcroft
2137c2fdda0dSAndy Whitcroft		if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2138c2fdda0dSAndy Whitcroft						$previndent == $indent) {
2139c2fdda0dSAndy Whitcroft			my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2140c2fdda0dSAndy Whitcroft
2141c2fdda0dSAndy Whitcroft			# Find out what is on the end of the line after the
2142c2fdda0dSAndy Whitcroft			# conditional.
2143773647a0SAndy Whitcroft			substr($s, 0, length($c), '');
2144c2fdda0dSAndy Whitcroft			$s =~ s/\n.*//g;
2145c2fdda0dSAndy Whitcroft
2146c2fdda0dSAndy Whitcroft			if ($s =~ /^\s*;/) {
2147c2fdda0dSAndy Whitcroft				ERROR("while should follow close brace '}'\n" . $hereprev);
2148c2fdda0dSAndy Whitcroft			}
2149c2fdda0dSAndy Whitcroft		}
2150c2fdda0dSAndy Whitcroft
21510a920b5bSAndy Whitcroft#studly caps, commented out until figure out how to distinguish between use of existing and adding new
21520a920b5bSAndy Whitcroft#		if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
21530a920b5bSAndy Whitcroft#		    print "No studly caps, use _\n";
21540a920b5bSAndy Whitcroft#		    print "$herecurr";
21550a920b5bSAndy Whitcroft#		    $clean = 0;
21560a920b5bSAndy Whitcroft#		}
21570a920b5bSAndy Whitcroft
21580a920b5bSAndy Whitcroft#no spaces allowed after \ in define
2159c45dcabdSAndy Whitcroft		if ($line=~/\#\s*define.*\\\s$/) {
2160de7d4f0eSAndy Whitcroft			WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
21610a920b5bSAndy Whitcroft		}
21620a920b5bSAndy Whitcroft
2163653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2164c45dcabdSAndy Whitcroft		if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2165e09dec48SAndy Whitcroft			my $file = "$1.h";
2166e09dec48SAndy Whitcroft			my $checkfile = "include/linux/$file";
2167e09dec48SAndy Whitcroft			if (-f "$root/$checkfile" &&
2168e09dec48SAndy Whitcroft			    $realfile ne $checkfile &&
2169c45dcabdSAndy Whitcroft			    $1 ne 'irq')
2170c45dcabdSAndy Whitcroft			{
2171e09dec48SAndy Whitcroft				if ($realfile =~ m{^arch/}) {
2172e09dec48SAndy Whitcroft					CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2173e09dec48SAndy Whitcroft				} else {
2174e09dec48SAndy Whitcroft					WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2175e09dec48SAndy Whitcroft				}
21760a920b5bSAndy Whitcroft			}
21770a920b5bSAndy Whitcroft		}
21780a920b5bSAndy Whitcroft
2179653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the
2180653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed
2181cf655043SAndy Whitcroft# in a known good container
2182b8f96a31SAndy Whitcroft		if ($realfile !~ m@/vmlinux.lds.h$@ &&
2183b8f96a31SAndy Whitcroft		    $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2184d8aaf121SAndy Whitcroft			my $ln = $linenr;
2185d8aaf121SAndy Whitcroft			my $cnt = $realcnt;
2186c45dcabdSAndy Whitcroft			my ($off, $dstat, $dcond, $rest);
2187c45dcabdSAndy Whitcroft			my $ctx = '';
2188653d4876SAndy Whitcroft
2189c45dcabdSAndy Whitcroft			my $args = defined($1);
2190de7d4f0eSAndy Whitcroft
2191c45dcabdSAndy Whitcroft			# Find the end of the macro and limit our statement
2192c45dcabdSAndy Whitcroft			# search to that.
2193c45dcabdSAndy Whitcroft			while ($cnt > 0 && defined $lines[$ln - 1] &&
2194c45dcabdSAndy Whitcroft				$lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2195c45dcabdSAndy Whitcroft			{
2196c45dcabdSAndy Whitcroft				$ctx .= $rawlines[$ln - 1] . "\n";
2197a3bb97a7SAndy Whitcroft				$cnt-- if ($lines[$ln - 1] !~ /^-/);
2198c45dcabdSAndy Whitcroft				$ln++;
2199de7d4f0eSAndy Whitcroft			}
2200c45dcabdSAndy Whitcroft			$ctx .= $rawlines[$ln - 1];
2201d8aaf121SAndy Whitcroft
2202c45dcabdSAndy Whitcroft			($dstat, $dcond, $ln, $cnt, $off) =
2203c45dcabdSAndy Whitcroft				ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2204c45dcabdSAndy Whitcroft			#print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
2205a3bb97a7SAndy Whitcroft			#print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2206c45dcabdSAndy Whitcroft
2207c45dcabdSAndy Whitcroft			# Extract the remainder of the define (if any) and
2208c45dcabdSAndy Whitcroft			# rip off surrounding spaces, and trailing \'s.
2209c45dcabdSAndy Whitcroft			$rest = '';
2210636d140aSAndy Whitcroft			while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2211636d140aSAndy Whitcroft				#print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
2212a3bb97a7SAndy Whitcroft				if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2213c45dcabdSAndy Whitcroft					$rest .= substr($lines[$ln - 1], $off) . "\n";
2214c45dcabdSAndy Whitcroft					$cnt--;
2215a3bb97a7SAndy Whitcroft				}
2216a3bb97a7SAndy Whitcroft				$ln++;
2217c45dcabdSAndy Whitcroft				$off = 0;
2218c45dcabdSAndy Whitcroft			}
2219c45dcabdSAndy Whitcroft			$rest =~ s/\\\n.//g;
2220c45dcabdSAndy Whitcroft			$rest =~ s/^\s*//s;
2221c45dcabdSAndy Whitcroft			$rest =~ s/\s*$//s;
2222c45dcabdSAndy Whitcroft
2223c45dcabdSAndy Whitcroft			# Clean up the original statement.
2224c45dcabdSAndy Whitcroft			if ($args) {
2225c45dcabdSAndy Whitcroft				substr($dstat, 0, length($dcond), '');
2226d8aaf121SAndy Whitcroft			} else {
2227c45dcabdSAndy Whitcroft				$dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2228c45dcabdSAndy Whitcroft			}
2229292f1a9bSAndy Whitcroft			$dstat =~ s/$;//g;
2230c45dcabdSAndy Whitcroft			$dstat =~ s/\\\n.//g;
2231c45dcabdSAndy Whitcroft			$dstat =~ s/^\s*//s;
2232c45dcabdSAndy Whitcroft			$dstat =~ s/\s*$//s;
2233c45dcabdSAndy Whitcroft
2234c45dcabdSAndy Whitcroft			# Flatten any parentheses and braces
2235bf30d6edSAndy Whitcroft			while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2236bf30d6edSAndy Whitcroft			       $dstat =~ s/\{[^\{\}]*\}/1/ ||
2237bf30d6edSAndy Whitcroft			       $dstat =~ s/\[[^\{\}]*\]/1/)
2238bf30d6edSAndy Whitcroft			{
2239c45dcabdSAndy Whitcroft			}
2240c45dcabdSAndy Whitcroft
2241c45dcabdSAndy Whitcroft			my $exceptions = qr{
2242c45dcabdSAndy Whitcroft				$Declare|
2243c45dcabdSAndy Whitcroft				module_param_named|
2244c45dcabdSAndy Whitcroft				MODULE_PARAM_DESC|
2245c45dcabdSAndy Whitcroft				DECLARE_PER_CPU|
2246c45dcabdSAndy Whitcroft				DEFINE_PER_CPU|
2247383099fdSAndy Whitcroft				__typeof__\(|
2248383099fdSAndy Whitcroft				\.$Ident\s*=\s*
2249c45dcabdSAndy Whitcroft			}x;
2250383099fdSAndy Whitcroft			#print "REST<$rest> dstat<$dstat>\n";
2251c45dcabdSAndy Whitcroft			if ($rest ne '') {
2252c45dcabdSAndy Whitcroft				if ($rest !~ /while\s*\(/ &&
2253c45dcabdSAndy Whitcroft				    $dstat !~ /$exceptions/)
2254c45dcabdSAndy Whitcroft				{
2255c45dcabdSAndy Whitcroft					ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
2256c45dcabdSAndy Whitcroft				}
2257c45dcabdSAndy Whitcroft
2258c45dcabdSAndy Whitcroft			} elsif ($ctx !~ /;/) {
2259c45dcabdSAndy Whitcroft				if ($dstat ne '' &&
2260c45dcabdSAndy Whitcroft				    $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2261c45dcabdSAndy Whitcroft				    $dstat !~ /$exceptions/ &&
2262b132e5d5SAndy Whitcroft				    $dstat !~ /^\.$Ident\s*=/ &&
2263c45dcabdSAndy Whitcroft				    $dstat =~ /$Operators/)
2264c45dcabdSAndy Whitcroft				{
2265de7d4f0eSAndy Whitcroft					ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
2266d8aaf121SAndy Whitcroft				}
22670a920b5bSAndy Whitcroft			}
2268653d4876SAndy Whitcroft		}
22690a920b5bSAndy Whitcroft
2270080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
2271080ba929SMike Frysinger# all assignments may have only one of the following with an assignment:
2272080ba929SMike Frysinger#	.
2273080ba929SMike Frysinger#	ALIGN(...)
2274080ba929SMike Frysinger#	VMLINUX_SYMBOL(...)
2275080ba929SMike Frysinger		if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
2276080ba929SMike Frysinger			WARN("vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
2277080ba929SMike Frysinger		}
2278080ba929SMike Frysinger
2279f0a594c1SAndy Whitcroft# check for redundant bracing round if etc
228013214adfSAndy Whitcroft		if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
228113214adfSAndy Whitcroft			my ($level, $endln, @chunks) =
2282cf655043SAndy Whitcroft				ctx_statement_full($linenr, $realcnt, 1);
228313214adfSAndy Whitcroft			#print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2284cf655043SAndy Whitcroft			#print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2285cf655043SAndy Whitcroft			if ($#chunks > 0 && $level == 0) {
228613214adfSAndy Whitcroft				my $allowed = 0;
228713214adfSAndy Whitcroft				my $seen = 0;
2288773647a0SAndy Whitcroft				my $herectx = $here . "\n";
2289cf655043SAndy Whitcroft				my $ln = $linenr - 1;
229013214adfSAndy Whitcroft				for my $chunk (@chunks) {
229113214adfSAndy Whitcroft					my ($cond, $block) = @{$chunk};
229213214adfSAndy Whitcroft
2293773647a0SAndy Whitcroft					# If the condition carries leading newlines, then count those as offsets.
2294773647a0SAndy Whitcroft					my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2295773647a0SAndy Whitcroft					my $offset = statement_rawlines($whitespace) - 1;
2296773647a0SAndy Whitcroft
2297773647a0SAndy Whitcroft					#print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2298773647a0SAndy Whitcroft
2299773647a0SAndy Whitcroft					# We have looked at and allowed this specific line.
2300773647a0SAndy Whitcroft					$suppress_ifbraces{$ln + $offset} = 1;
2301773647a0SAndy Whitcroft
2302773647a0SAndy Whitcroft					$herectx .= "$rawlines[$ln + $offset]\n[...]\n";
2303cf655043SAndy Whitcroft					$ln += statement_rawlines($block) - 1;
2304cf655043SAndy Whitcroft
2305773647a0SAndy Whitcroft					substr($block, 0, length($cond), '');
230613214adfSAndy Whitcroft
230713214adfSAndy Whitcroft					$seen++ if ($block =~ /^\s*{/);
230813214adfSAndy Whitcroft
2309cf655043SAndy Whitcroft					#print "cond<$cond> block<$block> allowed<$allowed>\n";
2310cf655043SAndy Whitcroft					if (statement_lines($cond) > 1) {
2311cf655043SAndy Whitcroft						#print "APW: ALLOWED: cond<$cond>\n";
231213214adfSAndy Whitcroft						$allowed = 1;
231313214adfSAndy Whitcroft					}
231413214adfSAndy Whitcroft					if ($block =~/\b(?:if|for|while)\b/) {
2315cf655043SAndy Whitcroft						#print "APW: ALLOWED: block<$block>\n";
231613214adfSAndy Whitcroft						$allowed = 1;
231713214adfSAndy Whitcroft					}
2318cf655043SAndy Whitcroft					if (statement_block_size($block) > 1) {
2319cf655043SAndy Whitcroft						#print "APW: ALLOWED: lines block<$block>\n";
232013214adfSAndy Whitcroft						$allowed = 1;
232113214adfSAndy Whitcroft					}
232213214adfSAndy Whitcroft				}
232313214adfSAndy Whitcroft				if ($seen && !$allowed) {
2324cf655043SAndy Whitcroft					WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
232513214adfSAndy Whitcroft				}
232613214adfSAndy Whitcroft			}
232713214adfSAndy Whitcroft		}
2328773647a0SAndy Whitcroft		if (!defined $suppress_ifbraces{$linenr - 1} &&
232913214adfSAndy Whitcroft					$line =~ /\b(if|while|for|else)\b/) {
2330cf655043SAndy Whitcroft			my $allowed = 0;
2331f0a594c1SAndy Whitcroft
2332cf655043SAndy Whitcroft			# Check the pre-context.
2333cf655043SAndy Whitcroft			if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2334cf655043SAndy Whitcroft				#print "APW: ALLOWED: pre<$1>\n";
2335cf655043SAndy Whitcroft				$allowed = 1;
2336f0a594c1SAndy Whitcroft			}
2337773647a0SAndy Whitcroft
2338773647a0SAndy Whitcroft			my ($level, $endln, @chunks) =
2339773647a0SAndy Whitcroft				ctx_statement_full($linenr, $realcnt, $-[0]);
2340773647a0SAndy Whitcroft
2341cf655043SAndy Whitcroft			# Check the condition.
2342cf655043SAndy Whitcroft			my ($cond, $block) = @{$chunks[0]};
2343773647a0SAndy Whitcroft			#print "CHECKING<$linenr> cond<$cond> block<$block>\n";
2344cf655043SAndy Whitcroft			if (defined $cond) {
2345773647a0SAndy Whitcroft				substr($block, 0, length($cond), '');
2346cf655043SAndy Whitcroft			}
2347cf655043SAndy Whitcroft			if (statement_lines($cond) > 1) {
2348cf655043SAndy Whitcroft				#print "APW: ALLOWED: cond<$cond>\n";
2349cf655043SAndy Whitcroft				$allowed = 1;
2350cf655043SAndy Whitcroft			}
2351cf655043SAndy Whitcroft			if ($block =~/\b(?:if|for|while)\b/) {
2352cf655043SAndy Whitcroft				#print "APW: ALLOWED: block<$block>\n";
2353cf655043SAndy Whitcroft				$allowed = 1;
2354cf655043SAndy Whitcroft			}
2355cf655043SAndy Whitcroft			if (statement_block_size($block) > 1) {
2356cf655043SAndy Whitcroft				#print "APW: ALLOWED: lines block<$block>\n";
2357cf655043SAndy Whitcroft				$allowed = 1;
2358cf655043SAndy Whitcroft			}
2359cf655043SAndy Whitcroft			# Check the post-context.
2360cf655043SAndy Whitcroft			if (defined $chunks[1]) {
2361cf655043SAndy Whitcroft				my ($cond, $block) = @{$chunks[1]};
2362cf655043SAndy Whitcroft				if (defined $cond) {
2363773647a0SAndy Whitcroft					substr($block, 0, length($cond), '');
2364cf655043SAndy Whitcroft				}
2365cf655043SAndy Whitcroft				if ($block =~ /^\s*\{/) {
2366cf655043SAndy Whitcroft					#print "APW: ALLOWED: chunk-1 block<$block>\n";
2367cf655043SAndy Whitcroft					$allowed = 1;
2368cf655043SAndy Whitcroft				}
2369cf655043SAndy Whitcroft			}
2370cf655043SAndy Whitcroft			if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2371cf655043SAndy Whitcroft				my $herectx = $here . "\n";;
2372f055663cSAndy Whitcroft				my $cnt = statement_rawlines($block);
2373cf655043SAndy Whitcroft
2374f055663cSAndy Whitcroft				for (my $n = 0; $n < $cnt; $n++) {
2375f055663cSAndy Whitcroft					$herectx .= raw_line($linenr, $n) . "\n";;
2376cf655043SAndy Whitcroft				}
2377cf655043SAndy Whitcroft
2378cf655043SAndy Whitcroft				WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
2379f0a594c1SAndy Whitcroft			}
2380f0a594c1SAndy Whitcroft		}
2381f0a594c1SAndy Whitcroft
2382653d4876SAndy Whitcroft# don't include deprecated include files (uses RAW line)
23834a0df2efSAndy Whitcroft		for my $inc (@dep_includes) {
2384c45dcabdSAndy Whitcroft			if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
2385de7d4f0eSAndy Whitcroft				ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
23860a920b5bSAndy Whitcroft			}
23870a920b5bSAndy Whitcroft		}
23880a920b5bSAndy Whitcroft
23894a0df2efSAndy Whitcroft# don't use deprecated functions
23904a0df2efSAndy Whitcroft		for my $func (@dep_functions) {
239100df344fSAndy Whitcroft			if ($line =~ /\b$func\b/) {
2392de7d4f0eSAndy Whitcroft				ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
23934a0df2efSAndy Whitcroft			}
23944a0df2efSAndy Whitcroft		}
23954a0df2efSAndy Whitcroft
23964a0df2efSAndy Whitcroft# no volatiles please
23976c72ffaaSAndy Whitcroft		my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
23986c72ffaaSAndy Whitcroft		if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
2399de7d4f0eSAndy Whitcroft			WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
24004a0df2efSAndy Whitcroft		}
24014a0df2efSAndy Whitcroft
24029c0ca6f9SAndy Whitcroft# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
24039c0ca6f9SAndy Whitcroft		if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
24049c0ca6f9SAndy Whitcroft			ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
24059c0ca6f9SAndy Whitcroft		}
24069c0ca6f9SAndy Whitcroft
240700df344fSAndy Whitcroft# warn about #if 0
2408c45dcabdSAndy Whitcroft		if ($line =~ /^.\s*\#\s*if\s+0\b/) {
2409de7d4f0eSAndy Whitcroft			CHK("if this code is redundant consider removing it\n" .
2410de7d4f0eSAndy Whitcroft				$herecurr);
24114a0df2efSAndy Whitcroft		}
24124a0df2efSAndy Whitcroft
2413f0a594c1SAndy Whitcroft# check for needless kfree() checks
2414f0a594c1SAndy Whitcroft		if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2415f0a594c1SAndy Whitcroft			my $expr = $1;
2416f0a594c1SAndy Whitcroft			if ($line =~ /\bkfree\(\Q$expr\E\);/) {
24173c232147SWolfram Sang				WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
2418f0a594c1SAndy Whitcroft			}
2419f0a594c1SAndy Whitcroft		}
24204c432a8fSGreg Kroah-Hartman# check for needless usb_free_urb() checks
24214c432a8fSGreg Kroah-Hartman		if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
24224c432a8fSGreg Kroah-Hartman			my $expr = $1;
24234c432a8fSGreg Kroah-Hartman			if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
24244c432a8fSGreg Kroah-Hartman				WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
24254c432a8fSGreg Kroah-Hartman			}
24264c432a8fSGreg Kroah-Hartman		}
2427f0a594c1SAndy Whitcroft
242800df344fSAndy Whitcroft# warn about #ifdefs in C files
2429c45dcabdSAndy Whitcroft#		if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
243000df344fSAndy Whitcroft#			print "#ifdef in C files should be avoided\n";
243100df344fSAndy Whitcroft#			print "$herecurr";
243200df344fSAndy Whitcroft#			$clean = 0;
243300df344fSAndy Whitcroft#		}
243400df344fSAndy Whitcroft
243522f2a2efSAndy Whitcroft# warn about spacing in #ifdefs
2436c45dcabdSAndy Whitcroft		if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
243722f2a2efSAndy Whitcroft			ERROR("exactly one space required after that #$1\n" . $herecurr);
243822f2a2efSAndy Whitcroft		}
243922f2a2efSAndy Whitcroft
24404a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment.
2441171ae1a4SAndy Whitcroft		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2442171ae1a4SAndy Whitcroft		    $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
24434a0df2efSAndy Whitcroft			my $which = $1;
24444a0df2efSAndy Whitcroft			if (!ctx_has_comment($first_line, $linenr)) {
2445de7d4f0eSAndy Whitcroft				CHK("$1 definition without comment\n" . $herecurr);
24464a0df2efSAndy Whitcroft			}
24474a0df2efSAndy Whitcroft		}
24484a0df2efSAndy Whitcroft# check for memory barriers without a comment.
24494a0df2efSAndy Whitcroft		if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
24504a0df2efSAndy Whitcroft			if (!ctx_has_comment($first_line, $linenr)) {
2451de7d4f0eSAndy Whitcroft				CHK("memory barrier without comment\n" . $herecurr);
24524a0df2efSAndy Whitcroft			}
24534a0df2efSAndy Whitcroft		}
24544a0df2efSAndy Whitcroft# check of hardware specific defines
2455c45dcabdSAndy Whitcroft		if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
2456de7d4f0eSAndy Whitcroft			CHK("architecture specific defines should be avoided\n" .  $herecurr);
24570a920b5bSAndy Whitcroft		}
2458653d4876SAndy Whitcroft
2459de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between
2460de7d4f0eSAndy Whitcroft# storage class and type.
24619c0ca6f9SAndy Whitcroft		if ($line =~ /\b$Type\s+$Inline\b/ ||
24629c0ca6f9SAndy Whitcroft		    $line =~ /\b$Inline\s+$Storage\b/) {
2463de7d4f0eSAndy Whitcroft			ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2464de7d4f0eSAndy Whitcroft		}
2465de7d4f0eSAndy Whitcroft
24668905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline
24678905a67cSAndy Whitcroft		if ($line =~ /\b(__inline__|__inline)\b/) {
24688905a67cSAndy Whitcroft			WARN("plain inline is preferred over $1\n" . $herecurr);
24698905a67cSAndy Whitcroft		}
24708905a67cSAndy Whitcroft
2471de7d4f0eSAndy Whitcroft# check for new externs in .c files.
2472171ae1a4SAndy Whitcroft		if ($realfile =~ /\.c$/ && defined $stat &&
2473c45dcabdSAndy Whitcroft		    $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
2474171ae1a4SAndy Whitcroft		{
2475c45dcabdSAndy Whitcroft			my $function_name = $1;
2476c45dcabdSAndy Whitcroft			my $paren_space = $2;
2477171ae1a4SAndy Whitcroft
2478171ae1a4SAndy Whitcroft			my $s = $stat;
2479171ae1a4SAndy Whitcroft			if (defined $cond) {
2480171ae1a4SAndy Whitcroft				substr($s, 0, length($cond), '');
2481171ae1a4SAndy Whitcroft			}
2482c45dcabdSAndy Whitcroft			if ($s =~ /^\s*;/ &&
2483c45dcabdSAndy Whitcroft			    $function_name ne 'uninitialized_var')
2484c45dcabdSAndy Whitcroft			{
2485de7d4f0eSAndy Whitcroft				WARN("externs should be avoided in .c files\n" .  $herecurr);
2486de7d4f0eSAndy Whitcroft			}
2487de7d4f0eSAndy Whitcroft
2488171ae1a4SAndy Whitcroft			if ($paren_space =~ /\n/) {
2489171ae1a4SAndy Whitcroft				WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2490171ae1a4SAndy Whitcroft			}
24919c9ba34eSAndy Whitcroft
24929c9ba34eSAndy Whitcroft		} elsif ($realfile =~ /\.c$/ && defined $stat &&
24939c9ba34eSAndy Whitcroft		    $stat =~ /^.\s*extern\s+/)
24949c9ba34eSAndy Whitcroft		{
24959c9ba34eSAndy Whitcroft			WARN("externs should be avoided in .c files\n" .  $herecurr);
2496171ae1a4SAndy Whitcroft		}
2497171ae1a4SAndy Whitcroft
2498de7d4f0eSAndy Whitcroft# checks for new __setup's
2499de7d4f0eSAndy Whitcroft		if ($rawline =~ /\b__setup\("([^"]*)"/) {
2500de7d4f0eSAndy Whitcroft			my $name = $1;
2501de7d4f0eSAndy Whitcroft
2502de7d4f0eSAndy Whitcroft			if (!grep(/$name/, @setup_docs)) {
2503de7d4f0eSAndy Whitcroft				CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2504de7d4f0eSAndy Whitcroft			}
2505653d4876SAndy Whitcroft		}
25069c0ca6f9SAndy Whitcroft
25079c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return
25089c0ca6f9SAndy Whitcroft		if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
25099c0ca6f9SAndy Whitcroft			WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
25109c0ca6f9SAndy Whitcroft		}
251113214adfSAndy Whitcroft
251213214adfSAndy Whitcroft# check for gcc specific __FUNCTION__
251313214adfSAndy Whitcroft		if ($line =~ /__FUNCTION__/) {
251413214adfSAndy Whitcroft			WARN("__func__ should be used instead of gcc specific __FUNCTION__\n"  . $herecurr);
251513214adfSAndy Whitcroft		}
2516773647a0SAndy Whitcroft
2517773647a0SAndy Whitcroft# check for semaphores used as mutexes
2518171ae1a4SAndy Whitcroft		if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
2519773647a0SAndy Whitcroft			WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2520773647a0SAndy Whitcroft		}
2521773647a0SAndy Whitcroft# check for semaphores used as mutexes
2522171ae1a4SAndy Whitcroft		if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
2523773647a0SAndy Whitcroft			WARN("consider using a completion\n" . $herecurr);
2524773647a0SAndy Whitcroft		}
2525773647a0SAndy Whitcroft# recommend strict_strto* over simple_strto*
2526773647a0SAndy Whitcroft		if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2527773647a0SAndy Whitcroft			WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2528773647a0SAndy Whitcroft		}
2529f3db6639SMichael Ellerman# check for __initcall(), use device_initcall() explicitly please
2530f3db6639SMichael Ellerman		if ($line =~ /^.\s*__initcall\s*\(/) {
2531f3db6639SMichael Ellerman			WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2532f3db6639SMichael Ellerman		}
25332b6db5cbSAndy Whitcroft# check for struct file_operations, ensure they are const.
25346903ffb2SAndy Whitcroft		if ($line !~ /\bconst\b/ &&
25356903ffb2SAndy Whitcroft		    $line =~ /\bstruct\s+(file_operations|seq_operations)\b/) {
25366903ffb2SAndy Whitcroft			WARN("struct $1 should normally be const\n" .
25376903ffb2SAndy Whitcroft				$herecurr);
25382b6db5cbSAndy Whitcroft		}
2539773647a0SAndy Whitcroft
2540773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong
2541773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right
2542773647a0SAndy Whitcroft		if ($line =~ /\bNR_CPUS\b/ &&
2543c45dcabdSAndy Whitcroft		    $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2544c45dcabdSAndy Whitcroft		    $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
2545171ae1a4SAndy Whitcroft		    $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2546171ae1a4SAndy Whitcroft		    $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2547171ae1a4SAndy Whitcroft		    $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
2548773647a0SAndy Whitcroft		{
2549773647a0SAndy Whitcroft			WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2550773647a0SAndy Whitcroft		}
25519c9ba34eSAndy Whitcroft
25529c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings
25539c9ba34eSAndy Whitcroft		my $string;
25549c9ba34eSAndy Whitcroft		while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
25559c9ba34eSAndy Whitcroft			$string = substr($rawline, $-[1], $+[1] - $-[1]);
25562a1bc5d5SAndy Whitcroft			$string =~ s/%%/__/g;
25579c9ba34eSAndy Whitcroft			if ($string =~ /(?<!%)%L[udi]/) {
25589c9ba34eSAndy Whitcroft				WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
25599c9ba34eSAndy Whitcroft				last;
25609c9ba34eSAndy Whitcroft			}
25619c9ba34eSAndy Whitcroft		}
2562691d77b6SAndy Whitcroft
2563691d77b6SAndy Whitcroft# whine mightly about in_atomic
2564691d77b6SAndy Whitcroft		if ($line =~ /\bin_atomic\s*\(/) {
2565691d77b6SAndy Whitcroft			if ($realfile =~ m@^drivers/@) {
2566691d77b6SAndy Whitcroft				ERROR("do not use in_atomic in drivers\n" . $herecurr);
2567f4a87736SAndy Whitcroft			} elsif ($realfile !~ m@^kernel/@) {
2568691d77b6SAndy Whitcroft				WARN("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
2569691d77b6SAndy Whitcroft			}
2570691d77b6SAndy Whitcroft		}
257113214adfSAndy Whitcroft	}
257213214adfSAndy Whitcroft
257313214adfSAndy Whitcroft	# If we have no input at all, then there is nothing to report on
257413214adfSAndy Whitcroft	# so just keep quiet.
257513214adfSAndy Whitcroft	if ($#rawlines == -1) {
257613214adfSAndy Whitcroft		exit(0);
25770a920b5bSAndy Whitcroft	}
25780a920b5bSAndy Whitcroft
25798905a67cSAndy Whitcroft	# In mailback mode only produce a report in the negative, for
25808905a67cSAndy Whitcroft	# things that appear to be patches.
25818905a67cSAndy Whitcroft	if ($mailback && ($clean == 1 || !$is_patch)) {
25828905a67cSAndy Whitcroft		exit(0);
25838905a67cSAndy Whitcroft	}
25848905a67cSAndy Whitcroft
25858905a67cSAndy Whitcroft	# This is not a patch, and we are are in 'no-patch' mode so
25868905a67cSAndy Whitcroft	# just keep quiet.
25878905a67cSAndy Whitcroft	if (!$chk_patch && !$is_patch) {
25888905a67cSAndy Whitcroft		exit(0);
25898905a67cSAndy Whitcroft	}
25908905a67cSAndy Whitcroft
25918905a67cSAndy Whitcroft	if (!$is_patch) {
2592de7d4f0eSAndy Whitcroft		ERROR("Does not appear to be a unified-diff format patch\n");
25930a920b5bSAndy Whitcroft	}
25940a920b5bSAndy Whitcroft	if ($is_patch && $chk_signoff && $signoff == 0) {
2595de7d4f0eSAndy Whitcroft		ERROR("Missing Signed-off-by: line(s)\n");
25960a920b5bSAndy Whitcroft	}
25970a920b5bSAndy Whitcroft
2598f0a594c1SAndy Whitcroft	print report_dump();
259913214adfSAndy Whitcroft	if ($summary && !($clean == 1 && $quiet == 1)) {
260013214adfSAndy Whitcroft		print "$filename " if ($summary_file);
26016c72ffaaSAndy Whitcroft		print "total: $cnt_error errors, $cnt_warn warnings, " .
26026c72ffaaSAndy Whitcroft			(($check)? "$cnt_chk checks, " : "") .
26036c72ffaaSAndy Whitcroft			"$cnt_lines lines checked\n";
26048905a67cSAndy Whitcroft		print "\n" if ($quiet == 0);
26056c72ffaaSAndy Whitcroft	}
26068905a67cSAndy Whitcroft
26070a920b5bSAndy Whitcroft	if ($clean == 1 && $quiet == 0) {
2608c2fdda0dSAndy Whitcroft		print "$vname has no obvious style problems and is ready for submission.\n"
26090a920b5bSAndy Whitcroft	}
26100a920b5bSAndy Whitcroft	if ($clean == 0 && $quiet == 0) {
2611c2fdda0dSAndy Whitcroft		print "$vname has style problems, please review.  If any of these errors\n";
26120a920b5bSAndy Whitcroft		print "are false positives report them to the maintainer, see\n";
26130a920b5bSAndy Whitcroft		print "CHECKPATCH in MAINTAINERS.\n";
26140a920b5bSAndy Whitcroft	}
261513214adfSAndy Whitcroft
26160a920b5bSAndy Whitcroft	return $clean;
26170a920b5bSAndy Whitcroft}
2618